X-Git-Url: https://wimlib.net/git/?p=wimlib;a=blobdiff_plain;f=doc%2Fmkwinpeimg.1.in;h=cd4a0c5e9da1913c2b4f604e7034351c10512565;hp=0db9d6e0f6ac9df6f1c8eb17e7f0526c71dc23d4;hb=232c381f9f3ab814258aa8e2380f537498a50905;hpb=fec65d853bbcfdb4639d8446db8d3c681c7ae00d diff --git a/doc/mkwinpeimg.1.in b/doc/mkwinpeimg.1.in index 0db9d6e0..cd4a0c5e 100644 --- a/doc/mkwinpeimg.1.in +++ b/doc/mkwinpeimg.1.in @@ -1,4 +1,4 @@ -.TH MKWINPEIMG "1" "September 2012" "mkwinpeimg (wimlib @VERSION@)" "User Commands" +.TH MKWINPEIMG "1" "March 2013" "mkwinpeimg (wimlib @VERSION@)" "User Commands" .SH NAME mkwinpeimg \- Make a customized bootable image of Windows PE .SH SYNOPSIS @@ -8,13 +8,14 @@ mkwinpeimg \- Make a customized bootable image of Windows PE .SH DESCRIPTION \fBmkwinpeimg\fR is able to make a bootable image of Windows PE by taking files -from a mounted Windows DVD (Windows 7 or Windows 8) or the mounted ISO image for -the Windows Automated Installation Kit (WAIK). The \fB--windows-dir\fR and -\fB--waik-dir\fR options are used to specify the locations of these mounted -ISOs. You only need one or the other. The files that \fBmkwinpeimg\fR will -retrieve are \fIboot.wim\fR, \fIbootmgr\fR, \fIboot.sdi\fR, and \fIbcd\fR. If -making an ISO image, the file \fIetfsboot.com\fR is also retrieved. Microsoft -owns the rights to these files and they are not distributed with WIMLIB. +from a mounted Windows DVD (Windows Vista, Windows 7 or Windows 8) or the +mounted ISO image for the Windows Automated Installation Kit (WAIK). The +\fB--windows-dir\fR and \fB--waik-dir\fR options are used to specify the +locations of these mounted ISOs. You only need one or the other. The files +that \fBmkwinpeimg\fR will retrieve are \fIboot.wim\fR, \fIbootmgr\fR, +\fIboot.sdi\fR, and \fIbcd\fR. If making an ISO image, the file +\fIetfsboot.com\fR is also retrieved. Microsoft owns the rights to these files +and they are not distributed with wimlib. \fBmkwinpeimg\fR can currently make two types of bootable images. The default is to make a bootable disk image. The image is not partitioned and is formatted @@ -75,8 +76,14 @@ directory, or F1_WINPE.WIM from the WAIK if \fB\-\-waik\-dir\fR is specified. Adds all the files in DIR to the Windows PE image. .TP \fB\-t\fR, \fB\-\-tmp\-dir\fR=\fIDIR\fR -Use DIR for temporary files. Defaults to a directory made using \e"mktemp -\fB\-d\fR\e". +Use DIR for temporary files. Defaults to a directory made using "mktemp -d". +.TP +\fB\-a\fR, \fB\-\-arch\fR=\fIARCH\fR +Use the Windows PE version from the Windows Automated Installation Kit that has +the CPU architecture \fIARCH\fR. Only valid with \fB\-\-waik\-dir\fR. Possible +values: "x86" or "amd64". Default is "x86". Note: the WAIK also contains a +Windows PE image for the ia64 (Itanium) architecture; however, this is not +supported by this script. .TP \fB\-h\fR, \fB\-\-help\fR Display help. @@ -85,26 +92,35 @@ Display help. Show version information. .SH EXAMPLES -.IP +Create a bootable disk image of Windows PE from the Windows Vista, 7, or 8 +installation media mounted on /media/windows: + +.RS +.PP mkwinpeimg --windows-dir=/media/windows winpe.img -.LP -Create a bootable disk image of Windows PE from the Windows DVD mounted on -/media/windows. +.RE +.PP -.IP -mkwinpeimg --iso --waik-dir=/media/waik --overlay=winpe_overlay winpe.iso -.LP Create a bootable ISO of Windows PE from the WAIK mounted on /media/waik, and -add all the files in "winpe_overlay" to Windows PE's filesystem. +add all the files in "winpe_overlay" to Windows PE's filesystem: + +.RS +.PP +mkwinpeimg --iso --waik-dir=/media/waik --overlay=winpe_overlay winpe.iso +.RE +.PP + +Create a bootable image of Windows PE from the Windows installation media +mounted on /media/windows, add and make it execute "install.cmd" when it starts +up. In this example the image is created in the root directory of the TFTP +server for network booting. -.IP +.RS +.PP mkwinpeimg --start-script=install.cmd --windows-dir=/media/windows /var/tftpboot/winpe.img -.LP +.RE +.PP -Create a bootable image of Windows PE from the Windows DVD mounted on -/media/windows, add and make it execute "install.cmd" when it starts up. In -this example the image is created in the root directory of the TFTP server for -network booting. .SH NOTES @@ -116,4 +132,4 @@ they may limit your rights to redistribute customized versions of Windows PE. Report bugs to ebiggers3@gmail.com. .SH SEE ALSO -.BR imagex (1) +.BR @IMAGEX_PROGNAME@ (1)