]> wimlib.net Git - wimlib/blobdiff - doc/mkwinpeimg.1.in
Man page cleanups
[wimlib] / doc / mkwinpeimg.1.in
index d3e357939efd6c329211ea296061a84d1b4ee2e3..ee47350eb5dbdb83171220008a5d934c23dbc579 100644 (file)
@@ -4,9 +4,7 @@ mkwinpeimg \- Make a customized bootable image of Windows PE
 .SH SYNOPSIS
 .B mkwinpeimg
 [\fIOPTIONS\fR] \fIIMAGE\fR
-
 .SH DESCRIPTION
-
 \fBmkwinpeimg\fR is able to make a bootable image of Windows PE by taking files
 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
@@ -16,21 +14,21 @@ 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.
-
+.PP
 \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
 into a FAT filesystem.  \fBsyslinux\fR(1) is required to make this type of
 image, as it is used to chainload \fIbootmgr\fR. Also, \fBmtools\fR(1) is
 required so that the FAT filesystem can be created without root privileges.
-
+.PP
 The other type of bootable image that \fBmkwinpeimg\fR can make is a bootable
 ISO image.  To make this type of image, give the \fB--iso\fR option.
 \fBmkisofs\fR(1) is required to make this type of image.
-
+.PP
 If you make a disk image, you could put it on a USB drive, and if you make an
 ISO image, you could put it on a CD.  In addition, both types of images can be
 loaded by the SYSLINUX or PXELINUX bootloaders using the MEMDISK module.
-
+.PP
 Windows PE itself is contained in the \fIboot.wim\fR file.  \fBmkwinpeimg\fR can
 modify this file before embedding it in a bootable image.  The most useful
 modification is to specify an executable or batch file for Windows PE to execute
@@ -38,17 +36,15 @@ as soon as it starts up.  Use the \fB--start-script\fR \fIFILE\fR option to
 specify such a file.  You may also add arbitrary files to \fIboot.wim\fR by
 putting them in a directory, then specifying the \fB--overlay\fR \fIDIR\fR
 option.
-
+.PP
 \fBmkwinpeimg\fR can also make only a modified \fIboot.wim\fR, rather than a
 bootable ISO or disk image, if the \fB--only-wim\fR option is given.
-
+.PP
 The Windows PE WIMs provided in Windows 7, Windows 8, and the WAIK are not the
 same, but are all similar.  The best one to use is likely the one from the WAIK,
 as that one is the smallest.
-
 .SH OPTIONS
-
-.TP
+.TP 6
 \fB\-i\fR, \fB\-\-iso\fR
 Make an ISO image instead of a disk image.
 .TP
@@ -91,45 +87,33 @@ Display help.
 \fB\-v\fR, \fB\-\-version\fR
 Show version information.
 .SH EXAMPLES
-
 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
 .RE
 .PP
-
 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:
-
 .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.
-
 .RS
 .PP
 mkwinpeimg --start-script=install.cmd --windows-dir=/media/windows /var/tftpboot/winpe.img
 .RE
 .PP
-
-
 .SH NOTES
-
 Microsoft's licenses may limit the things that Windows PE can be used for, and
 they may limit your rights to redistribute customized versions of Windows PE.
-
 .SH REPORTING BUGS
-
 Report bugs to ebiggers3@gmail.com.
-
 .SH SEE ALSO
 .BR @IMAGEX_PROGNAME@ (1)