configure.ac: generate version number from git commit and tags
[wimlib] / doc / man1 / mkwinpeimg.1
1 .TH MKWINPEIMG "1" "April 2021" "wimlib 1.13.4" "User Commands"
2 .SH NAME
3 mkwinpeimg \- Make a customized bootable image of Windows PE
4 .SH SYNOPSIS
5 .B mkwinpeimg
6 [\fIOPTIONS\fR] \fIIMAGE\fR
7 .SH DESCRIPTION
8 \fBmkwinpeimg\fR is able to make a bootable image of Windows PE by taking files
9 from a mounted Windows installation ISO image (Vista or later) or the mounted
10 ISO image for the Windows Automated Installation Kit (WAIK) or the WAIK
11 supplement.  The \fB--windows-dir\fR and \fB--waik-dir\fR options are used to
12 specify the locations of these mounted ISOs.  You only need one or the other.
13 The files that \fBmkwinpeimg\fR will retrieve are \fIboot.wim\fR, \fIbootmgr\fR,
14 \fIboot.sdi\fR, and \fIbcd\fR.  If making an ISO image, the file
15 \fIetfsboot.com\fR is also retrieved.  Microsoft owns the rights to these files
16 and they are not distributed with wimlib.
17 .PP
18 \fBmkwinpeimg\fR can make two types of bootable images.  The default is to make
19 a bootable disk image.  The image is not partitioned and is formatted into a FAT
20 filesystem.  \fBsyslinux\fR(1) is required to make this type of image, as it is
21 used to chainload \fIbootmgr\fR. Also, \fBmtools\fR(1) is required so that the
22 FAT filesystem can be created without root privileges.
23 .PP
24 The other type of bootable image that \fBmkwinpeimg\fR can make is a bootable
25 ISO image.  To make this type of image, give the \fB--iso\fR option.
26 \fBmkisofs\fR(1) is required to make this type of image.  In \fB--iso\fR mode,
27 you can specify \fIIMAGE\fR as "-" to write the ISO image to standard output.
28 .PP
29 If you make a disk image, you could put it on a USB drive, and if you make an
30 ISO image, you could put it on a CD.  In addition, both types of images can be
31 loaded by the SYSLINUX or PXELINUX bootloaders using the MEMDISK module.
32 .PP
33 Windows PE itself is contained in the \fIboot.wim\fR file.  \fBmkwinpeimg\fR can
34 modify this file before embedding it in a bootable image.  The most useful
35 modification is to specify an executable or batch file for Windows PE to execute
36 as soon as it starts up.  Use the \fB--start-script\fR \fIFILE\fR option to
37 specify such a file.  You may also add arbitrary files to \fIboot.wim\fR by
38 putting them in a directory, then specifying the \fB--overlay\fR \fIDIR\fR
39 option.  However, for more extensive modifications, consider modifying the
40 \fIboot.wim\fR file separately using \fBwimmountrw\fR(1) or \fBwimupdate\fR(1),
41 then providing it to \fBmkwinpeimg\fR using the \fB--wim\fR option.
42 .PP
43 \fBmkwinpeimg\fR can also make only a modified \fIboot.wim\fR, rather than a
44 bootable ISO or disk image, if the \fB--only-wim\fR option is given.
45 .SH OPTIONS
46 .TP 6
47 \fB\-i\fR, \fB\-\-iso\fR
48 Make an ISO image instead of a disk image.
49 .TP
50 \fB\-o\fR, \fB\-\-only-wim\fR
51 Make neither a disk image nor an ISO image; instead, only make a modified
52 \fIboot.wim\fR file.
53 .TP
54 \fB\-W\fR, \fB\-\-windows\-dir\fR=\fIDIR\fR
55 Use DIR as the location of the mounted Windows installation ISO image.  If
56 neither \fB\-\-windows\-dir\fR nor \fB\-\-waik\-dir\fR is specified, then
57 the script looks for the mounted ISO in the following default locations:
58 /mnt/windows, /mnt/windows7, /mnt/windows8, and /mnt/windows10.
59 .TP
60 \fB\-A\fR, \fB\-\-waik\-dir\fR=\fIDIR\fR
61 Get the boot files and boot.wim from the ISO of the Windows Automated
62 Installation Kit mounted on DIR instead of from a Windows installation ISO.
63 This also works if the mounted ISO is for the WAIK supplement rather than the
64 WAIK itself.
65 .TP
66 \fB\-s\fR, \fB\-\-start\-script\fR=\fIFILE\fR
67 Add FILE to the root directory of Windows PE image and adjust
68 \eWindows\eSystem32\ewinpeshl.ini to execute FILE when Windows PE starts up.
69 .TP
70 \fB\-w\fR, \fB\-\-wim\fR=\fIWIM\fR
71 Use WIM as the "boot.wim" file.  This defaults to the appropriate WIM file from
72 the Windows ISO, WAIK, or WAIK supplement.
73 .TP
74 \fB\-O\fR, \fB\-\-overlay\fR=\fIDIR\fR
75 Adds all the files in DIR to the Windows PE image.
76 .TP
77 \fB\-t\fR, \fB\-\-tmp\-dir\fR=\fIDIR\fR
78 Use DIR for temporary files.  Defaults to a directory made using "mktemp -d".
79 .TP
80 \fB\-a\fR, \fB\-\-arch\fR=\fIARCH\fR
81 Use the Windows PE version from the Windows Automated Installation Kit (or the
82 WAIK supplement) that has the CPU architecture \fIARCH\fR.  Only valid with
83 \fB\-\-waik\-dir\fR.  Possible values: "x86" or "amd64".  Default is "x86".
84 Note: the WAIK also contains a Windows PE image for the ia64 (Itanium)
85 architecture; however, this is not supported by this script.
86 .TP
87 \fB\-h\fR, \fB\-\-help\fR
88 Display help.
89 .TP
90 \fB\-v\fR, \fB\-\-version\fR
91 Show version information.
92 .SH EXAMPLES
93 Create a bootable disk image of Windows PE from the Windows (Vista or later)
94 installation media mounted on /media/windows:
95 .RS
96 .PP
97 mkwinpeimg --windows-dir=/media/windows winpe.img
98 .RE
99 .PP
100 Create a bootable ISO of Windows PE from the WAIK (or WAIK supplement) mounted
101 on /media/waik, and add all the files in "winpe_overlay" to Windows PE's
102 filesystem:
103 .RS
104 .PP
105 mkwinpeimg --iso --waik-dir=/media/waik --overlay=winpe_overlay winpe.iso
106 .RE
107 .PP
108 Create a bootable image of Windows PE from the Windows installation media
109 mounted on /media/windows, add and make it execute "install.cmd" when it starts
110 up.  In this example the image is created in the root directory of the TFTP
111 server for network booting.
112 .RS
113 .PP
114 mkwinpeimg --start-script=install.cmd --windows-dir=/media/windows /var/tftpboot/winpe.img
115 .RE
116 .PP
117 .SH NOTES
118 Microsoft's licenses may limit the things that Windows PE can be used for, and
119 they may limit your rights to redistribute customized versions of Windows PE.
120 .SH REPORTING BUGS
121 Report bugs to \fIhttps://wimlib.net/forums/\fR.
122 .SH SEE ALSO
123 .BR wimlib-imagex (1)