Man page cleanups

diff --git a/doc/imagex-apply.1.in b/doc/imagex-apply.1.in
index d9684c62b161b4faafb260b043e9c3554e655b8d..94ca6f5d76d326897633234f83a432bb596cc277 100644 (file)
--- a/doc/imagex-apply.1.in
+++ b/doc/imagex-apply.1.in
@@ -1,43 +1,37 @@
 .TH IMAGEX "1" "May 2013" "@IMAGEX_PROGNAME@ @VERSION@" "User Commands"
 .SH NAME
 @IMAGEX_PROGNAME@-apply \- Extract one image, or all images, from a WIM archive
 .TH IMAGEX "1" "May 2013" "@IMAGEX_PROGNAME@ @VERSION@" "User Commands"
 .SH NAME
 @IMAGEX_PROGNAME@-apply \- Extract one image, or all images, from a WIM archive

-

 .SH SYNOPSIS
 \fB@IMAGEX_PROGNAME@ apply\fR \fIWIMFILE\fR [\fIIMAGE\fR] \fITARGET\fR [\fIOPTION\fR...]
 .SH SYNOPSIS
 \fB@IMAGEX_PROGNAME@ apply\fR \fIWIMFILE\fR [\fIIMAGE\fR] \fITARGET\fR [\fIOPTION\fR...]

-

 .SH DESCRIPTION
 .SH DESCRIPTION

-.PP
-

 \fB@IMAGEX_PROGNAME@ apply\fR extracts an image, or all images, from the Windows
 Imaging (WIM) file \fIWIMFILE\fR.
 \fB@IMAGEX_PROGNAME@ apply\fR extracts an image, or all images, from the Windows
 Imaging (WIM) file \fIWIMFILE\fR.

-
+.PP

 This command is designed to extract, or "apply", one or more full WIM images.
 If you instead want to extract only certain files or directories contained in a
 WIM image, consider using \fB@IMAGEX_PROGNAME@ extract\fR or
 \fB@IMAGEX_PROGNAME@ mount\fR instead.
 This command is designed to extract, or "apply", one or more full WIM images.
 If you instead want to extract only certain files or directories contained in a
 WIM image, consider using \fB@IMAGEX_PROGNAME@ extract\fR or
 \fB@IMAGEX_PROGNAME@ mount\fR instead.

-
+.PP

 \fIIMAGE\fR specifies the WIM image to extract.  It may be a 1-based index of an
 image in the WIM, the name of an image in the WIM, or the keyword "all" to
 indicate that all images are to be extracted.  Use the \fB@IMAGEX_PROGNAME@
 info\fR (1) command to show what images a WIM file contains.  \fIIMAGE\fR may be
 omitted if \fIWIMFILE\fR contains only one image.
 \fIIMAGE\fR specifies the WIM image to extract.  It may be a 1-based index of an
 image in the WIM, the name of an image in the WIM, or the keyword "all" to
 indicate that all images are to be extracted.  Use the \fB@IMAGEX_PROGNAME@
 info\fR (1) command to show what images a WIM file contains.  \fIIMAGE\fR may be
 omitted if \fIWIMFILE\fR contains only one image.

-
+.PP

 \fITARGET\fR specifies where to extract the WIM image(s) to.  If \fITARGET\fR
 specifies a directory, the WIM image(s) are extracted to that directory.  If
 \fITARGET\fR specifies a non-existent file, a directory is created in that
 location and the WIM image(s) are extracted to that directory.  Alternatively,
 on UNIX only, if \fITARGET\fR specifies a regular file or block device, it is
 interpreted as an NTFS volume to which the WIM image is to be extracted.
 \fITARGET\fR specifies where to extract the WIM image(s) to.  If \fITARGET\fR
 specifies a directory, the WIM image(s) are extracted to that directory.  If
 \fITARGET\fR specifies a non-existent file, a directory is created in that
 location and the WIM image(s) are extracted to that directory.  Alternatively,
 on UNIX only, if \fITARGET\fR specifies a regular file or block device, it is
 interpreted as an NTFS volume to which the WIM image is to be extracted.

-
+.PP

 \fB@IMAGEX_PROGNAME@ apply\fR supports applying images from stand-alone WIMs as
 well as split WIMs.  See \fBSPLIT WIMS\fR.
 \fB@IMAGEX_PROGNAME@ apply\fR supports applying images from stand-alone WIMs as
 well as split WIMs.  See \fBSPLIT WIMS\fR.

-

 .SH NORMAL MODE (UNIX)
 .SH NORMAL MODE (UNIX)

-

 This section documents how files are extracted on UNIX from the WIM image to a
 directory.  See \fBWINDOWS VERSION\fR for the corresponding documentation for
 the Windows version.
 This section documents how files are extracted on UNIX from the WIM image to a
 directory.  See \fBWINDOWS VERSION\fR for the corresponding documentation for
 the Windows version.

-
+.PP

 On UNIX, the "normal" extraction mode is entered when \fITARGET\fR is a
 directory or non-existent file.  If a single WIM image is being extracted, it is
 extracted with the root directory of the image corresponding to the directory
 On UNIX, the "normal" extraction mode is entered when \fITARGET\fR is a
 directory or non-existent file.  If a single WIM image is being extracted, it is
 extracted with the root directory of the image corresponding to the directory


@@ -45,10 +39,9 @@ named by \fITARGET\fR; or, if the keyword \fBall\fR is given, the images are
 extracted into subdirectories of \fITARGET\fR that are be named after the image
 names, falling back to the image index for an image with no name.  \fITARGET\fR
 can specify a directory on any type of filesystem.
 extracted into subdirectories of \fITARGET\fR that are be named after the image
 names, falling back to the image index for an image with no name.  \fITARGET\fR
 can specify a directory on any type of filesystem.

-
+.PP

 In the "normal" mode of extraction on UNIX, the following information is
 extracted from the WIM image(s):
 In the "normal" mode of extraction on UNIX, the following information is
 extracted from the WIM image(s):

-

 .IP \[bu] 4
 The default (unnamed) data stream of each file
 .IP \[bu]
 .IP \[bu] 4
 The default (unnamed) data stream of each file
 .IP \[bu]


@@ -61,11 +54,9 @@ and C library
 Symbolic links and junction points.  Drive letters will be stripped.
 (Note: see \fB--rpfix\fR and \fB--norpfix\fR for documentation on how absolute
 symbolic links and junctions are applied.)
 Symbolic links and junction points.  Drive letters will be stripped.
 (Note: see \fB--rpfix\fR and \fB--norpfix\fR for documentation on how absolute
 symbolic links and junctions are applied.)

-

 .PP
 However, in the "normal" mode of extraction on UNIX, the following information
 will \fInot\fR be extracted from the WIM image(s):
 .PP
 However, in the "normal" mode of extraction on UNIX, the following information
 will \fInot\fR be extracted from the WIM image(s):

-

 .IP \[bu] 4
 Security descriptors (file permissions) except through the extensions available
 through the \fB--unix-data\fR option
 .IP \[bu] 4
 Security descriptors (file permissions) except through the extensions available
 through the \fB--unix-data\fR option


@@ -77,35 +68,32 @@ Reparse points other than symbolic links and junction points
 Certain file attributes such as compression, encryption, and sparseness.
 .IP \[bu]
 Short (DOS) names for files
 Certain file attributes such as compression, encryption, and sparseness.
 .IP \[bu]
 Short (DOS) names for files

-

 .SH NTFS MODE (UNIX)
 .SH NTFS MODE (UNIX)

-

 This section documents how files are extracted directly to an NTFS volume image
 on UNIX.  See \fBWINDOWS VERSION\fR for the corresponding documentation for the
 Windows version.
 This section documents how files are extracted directly to an NTFS volume image
 on UNIX.  See \fBWINDOWS VERSION\fR for the corresponding documentation for the
 Windows version.

-
+.PP

 On UNIX, a special extraction mode is entered when \fITARGET\fR is a regular
 file or block device.  If this is the case, \fITARGET\fR is interpreted as an
 NTFS volume and opened using libntfs-3g.  If successful, the WIM image is
 extracted to the root of the NTFS volume in a special mode that preserves all
 information contained in the WIM image.  \fIIMAGE\fR may not be "all" for this
 action.
 On UNIX, a special extraction mode is entered when \fITARGET\fR is a regular
 file or block device.  If this is the case, \fITARGET\fR is interpreted as an
 NTFS volume and opened using libntfs-3g.  If successful, the WIM image is
 extracted to the root of the NTFS volume in a special mode that preserves all
 information contained in the WIM image.  \fIIMAGE\fR may not be "all" for this
 action.

-
+.PP

 The NTFS volume does not need to be empty, although it's expected that it be
 empty for the intended use cases.  A new NTFS filesystem can be created using
 the \fBmkntfs\fR (8) command.
 The NTFS volume does not need to be empty, although it's expected that it be
 empty for the intended use cases.  A new NTFS filesystem can be created using
 the \fBmkntfs\fR (8) command.

-
+.PP

 The NTFS extraction mode is not available if wimlib was compiled using the
 \fB--without-ntfs-3g\fR option.
 The NTFS extraction mode is not available if wimlib was compiled using the
 \fB--without-ntfs-3g\fR option.

-
+.PP

 Please note that the NTFS extraction mode is \fInot\fR entered if \fITARGET\fR
 is a directory, even if an NTFS filesystem is mounted on \fITARGET\fR.  You must
 specify the NTFS volume itself (and it must be unmounted, and you must have
 permission to write to it).
 Please note that the NTFS extraction mode is \fInot\fR entered if \fITARGET\fR
 is a directory, even if an NTFS filesystem is mounted on \fITARGET\fR.  You must
 specify the NTFS volume itself (and it must be unmounted, and you must have
 permission to write to it).

-
+.PP

 In the NTFS extraction mode on UNIX, the following information will be extracted
 from the WIM image:
 In the NTFS extraction mode on UNIX, the following information will be extracted
 from the WIM image:

-

 .IP \[bu] 4
 The data streams of all files, including the un-named data stream as well as all
 named data streams.
 .IP \[bu] 4
 The data streams of all files, including the un-named data stream as well as all
 named data streams.


@@ -126,7 +114,6 @@ File attribute flags are applied.
 Short (DOS) names for files are extracted.  The corresponding long name for each
 DOS name is made to be a Win32 name.  Any additional names for the file in the
 same directory are made to be names in the POSIX namespace.
 Short (DOS) names for files are extracted.  The corresponding long name for each
 DOS name is made to be a Win32 name.  Any additional names for the file in the
 same directory are made to be names in the POSIX namespace.

-

 .PP
 However, the extraction of encrypted files is not supported in this mode.
 .PP
 .PP
 However, the extraction of encrypted files is not supported in this mode.
 .PP


@@ -140,7 +127,6 @@ media for Windows Vista, Windows 7, and Windows 8 in the "sources" directory.
 But in order to actually boot Windows from an applied image, you must understand
 the boot process of Windows versions Vista and later.  Basically, it is the
 following:
 But in order to actually boot Windows from an applied image, you must understand
 the boot process of Windows versions Vista and later.  Basically, it is the
 following:

-

 .nr step 1 1
 .IP \n[step]. 3
 The Master Boot Record loads the Volume Boot Record (also called the Boot
 .nr step 1 1
 .IP \n[step]. 3
 The Master Boot Record loads the Volume Boot Record (also called the Boot


@@ -155,15 +141,13 @@ partition".
 Based on the information contained in the Boot Configuration Data, a loader for
 the Windows kernel is executed from the "Boot" partition, which is where Windows
 is installed.
 Based on the information contained in the Boot Configuration Data, a loader for
 the Windows kernel is executed from the "Boot" partition, which is where Windows
 is installed.

-

 .PP
 .PP

-

 So let's say you applied an image from an existing "install.wim" as in the
 example, or you've applied a custom Windows image that you've created using the
 \fB@IMAGEX_PROGNAME@ capture\fR (1) command.  You've just applied the "Boot" partition, or
 the main Windows partition, but there is no "System" partition yet (i.e.  no
 \\BOOTMGR and no \\Boot\\BCD).
 So let's say you applied an image from an existing "install.wim" as in the
 example, or you've applied a custom Windows image that you've created using the
 \fB@IMAGEX_PROGNAME@ capture\fR (1) command.  You've just applied the "Boot" partition, or
 the main Windows partition, but there is no "System" partition yet (i.e.  no
 \\BOOTMGR and no \\Boot\\BCD).

-
+.PP

 A "System" partition can be created created by running the "bcdboot.exe" program
 from within Windows or Windows PE.  Alternatively, you can capture a separate
 WIM image containing the "System" partition.  Or, the "System" partition may the
 A "System" partition can be created created by running the "bcdboot.exe" program
 from within Windows or Windows PE.  Alternatively, you can capture a separate
 WIM image containing the "System" partition.  Or, the "System" partition may the


@@ -172,54 +156,19 @@ image.  However, as the \\Boot\\BCD file contains the Windows bootloader
 configuration, a WIM containing it can only be used on systems where you are
 setting up the same bootloader configuration, including the same partition
 layout.
 configuration, a WIM containing it can only be used on systems where you are
 setting up the same bootloader configuration, including the same partition
 layout.

-
+.PP

 Besides setting up the files on the "System" partition, don't forget to set the
 bootable flag on it, and have a master boot record that loads the bootable
 partition (Windows' MBR does, and SYSLINUX provides an equivalent MBR).
 Besides setting up the files on the "System" partition, don't forget to set the
 bootable flag on it, and have a master boot record that loads the bootable
 partition (Windows' MBR does, and SYSLINUX provides an equivalent MBR).

-
-.SH SPLIT WIMS
-
-You may use \fB@IMAGEX_PROGNAME@ apply\fR to apply images from a split WIM.  The
-\fIWIMFILE\fR argument is used to specify the first part of the split WIM, and
-the \fB--refs\fR="\fIGLOB\fR" option is used to provide a shell-style file glob
-that specifies the additional parts of the split WIM.  \fIGLOB\fR is expected to
-be a single string on the command line, so \fIGLOB\fR must be quoted so that it
-is protected against shell expansion.  \fIGLOB\fR must expand to all parts of
-the split WIM, except optionally the first part which may either omitted or
-included in the glob (but the first part MUST be specified as \fIWIMFILE\fR as
-well).
-
-Here's an example.  The names for the split WIMs usually go something like:
-
-.RS
-.PP
-.nf
-mywim.swm
-mywim2.swm
-mywim3.swm
-mywim4.swm
-mywim5.swm
-.RE
-.nf
-
-To apply the first image of this split WIM to the directory "dir", run:
-.PP
-.RS
-@IMAGEX_PROGNAME@ apply mywim.swm 1 dir --ref="mywim*.swm"
-.RE
-.PP
-

 .SH WINDOWS VERSION
 .SH WINDOWS VERSION

-

 The Windows version of \fB@IMAGEX_PROGNAME@ apply\fR acts similarly to the
 corresponding command of Microsoft's ImageX.  For best results, the target
 directory should be on an NTFS volume and you should be running with
 Administrator privileges; however, non-NTFS filesystems and running without
 Administrator privileges are also supported.
 The Windows version of \fB@IMAGEX_PROGNAME@ apply\fR acts similarly to the
 corresponding command of Microsoft's ImageX.  For best results, the target
 directory should be on an NTFS volume and you should be running with
 Administrator privileges; however, non-NTFS filesystems and running without
 Administrator privileges are also supported.

-
+.PP

 On Windows, \fB@IMAGEX_PROGNAME@ apply\fR tries to extract as much data as
 possible.  This includes:
 On Windows, \fB@IMAGEX_PROGNAME@ apply\fR tries to extract as much data as
 possible.  This includes:

-

 .IP \[bu] 4
 All data streams of all files.  This includes the default file contents, as well
 as named data streams if supported by the filesystem.
 .IP \[bu] 4
 All data streams of all files.  This includes the default file contents, as well
 as named data streams if supported by the filesystem.


@@ -243,13 +192,40 @@ DOS names (8.3) names of files; however, the failure to set them is not
 considered an error condition.
 .IP \[bu]
 Hard links, if supported by the filesystem.
 considered an error condition.
 .IP \[bu]
 Hard links, if supported by the filesystem.

-

 .PP
 Note: encrypted files will be extracted as raw encrypted data if the filesystem
 does not support encryption.  Compressed files and directories (with the
 compression attribute set) will be extracted as uncompressed if the filesystem
 does not support transparent compression.
 .PP
 Note: encrypted files will be extracted as raw encrypted data if the filesystem
 does not support encryption.  Compressed files and directories (with the
 compression attribute set) will be extracted as uncompressed if the filesystem
 does not support transparent compression.

-
+.SH SPLIT WIMS
+You may use \fB@IMAGEX_PROGNAME@ apply\fR to apply images from a split WIM.  The
+\fIWIMFILE\fR argument is used to specify the first part of the split WIM, and
+the \fB--refs\fR="\fIGLOB\fR" option is used to provide a shell-style file glob
+that specifies the additional parts of the split WIM.  \fIGLOB\fR is expected to
+be a single string on the command line, so \fIGLOB\fR must be quoted so that it
+is protected against shell expansion.  \fIGLOB\fR must expand to all parts of
+the split WIM, except optionally the first part which may either omitted or
+included in the glob (but the first part MUST be specified as \fIWIMFILE\fR as
+well).
+.PP
+Here's an example.  The names for the split WIMs usually go something like:
+.RS
+.PP
+.nf
+mywim.swm
+mywim2.swm
+mywim3.swm
+mywim4.swm
+mywim5.swm
+.RE
+.nf
+.PP
+To apply the first image of this split WIM to the directory "dir", run:
+.PP
+.RS
+@IMAGEX_PROGNAME@ apply mywim.swm 1 dir --ref="mywim*.swm"
+.RE
+.PP

 .SH OPTIONS
 .TP 6
 \fB--check\fR
 .SH OPTIONS
 .TP 6
 \fB--check\fR


@@ -268,10 +244,10 @@ absolute targets relative to the image root, and therefore have the actual root
 of extraction prepended to their targets.  The intention is that you can apply
 an image containing absolute symbolic links and still have them be valid after
 it has been applied to any location.
 of extraction prepended to their targets.  The intention is that you can apply
 an image containing absolute symbolic links and still have them be valid after
 it has been applied to any location.

-
+.IP "" 6

 The default behavior is \fB--rpfix\fR if any images in \fIWIMFILE\fR have been
 captured with reparse-point fixups done.  Otherwise, it is \fB--norpfix\fR.
 The default behavior is \fB--rpfix\fR if any images in \fIWIMFILE\fR have been
 captured with reparse-point fixups done.  Otherwise, it is \fB--norpfix\fR.

-
+.IP "" 6

 Reparse point fixups are never done in the NTFS extraction mode on UNIX.
 .TP
 \fB--verbose\fR
 Reparse point fixups are never done in the NTFS extraction mode on UNIX.
 .TP
 \fB--verbose\fR


@@ -313,9 +289,7 @@ with the SACL omitted, then only the default inherited security descriptor, if
 we do not have permission to set the desired one.  On UNIX: with
 \fB--unix-data\fR, fail immediately if the UNIX owner, group, or file mode on an
 extracted file cannot be set for any reason.
 we do not have permission to set the desired one.  On UNIX: with
 \fB--unix-data\fR, fail immediately if the UNIX owner, group, or file mode on an
 extracted file cannot be set for any reason.

-

 .SH NOTES
 .SH NOTES

-

 \fB@IMAGEX_PROGNAME@ apply\fR calculates the SHA1 message digest of every file stream it
 extracts and verifies that it is the same as the SHA1 message digest provided in
 the WIM file.  It is an error if the message digests don't match.  It's also
 \fB@IMAGEX_PROGNAME@ apply\fR calculates the SHA1 message digest of every file stream it
 extracts and verifies that it is the same as the SHA1 message digest provided in
 the WIM file.  It is an error if the message digests don't match.  It's also


@@ -326,10 +300,9 @@ Microsoft's ImageX does.  Please note that this is separate from the integrity
 table of the WIM, which provides SHA1 message digests over raw chunks of the
 entire WIM file and is checked separately if the \fB--check\fR option is
 specified.
 table of the WIM, which provides SHA1 message digests over raw chunks of the
 entire WIM file and is checked separately if the \fB--check\fR option is
 specified.

-
+.PP

 You cannot use \fB@IMAGEX_PROGNAME@ apply\fR to apply a WIM from a pipe (such as standard
 input) because the WIM file format is not designed for this.
 You cannot use \fB@IMAGEX_PROGNAME@ apply\fR to apply a WIM from a pipe (such as standard
 input) because the WIM file format is not designed for this.

-

 .SH EXAMPLES
 .SS Applying a WIM image to a directory (both UNIX and Windows)
 Extract the first image from the Windows PE image from the Windows Vista/7/8
 .SH EXAMPLES
 .SS Applying a WIM image to a directory (both UNIX and Windows)
 Extract the first image from the Windows PE image from the Windows Vista/7/8


@@ -360,8 +333,6 @@ if you want to erase everything on that partition.)
 .PP
 mkntfs /dev/sda2 && @IMAGEX_PROGNAME@ apply /media/windows/sources/install.wim 1 /dev/sda2
 .RE
 .PP
 mkntfs /dev/sda2 && @IMAGEX_PROGNAME@ apply /media/windows/sources/install.wim 1 /dev/sda2
 .RE

-.PP
-

 .SH SEE ALSO
 .BR @IMAGEX_PROGNAME@ (1)
 .BR @IMAGEX_PROGNAME@-extract (1)
 .SH SEE ALSO
 .BR @IMAGEX_PROGNAME@ (1)
 .BR @IMAGEX_PROGNAME@-extract (1)

diff --git a/doc/imagex-capture.1.in b/doc/imagex-capture.1.in
index f4a1acde7a5cf77b7c645458d47001d65694e9f9..c04f2bc6fe1265961e1a3f4fcce317d4bcebd099 100644 (file)
--- a/doc/imagex-capture.1.in
+++ b/doc/imagex-capture.1.in
@@ -1,27 +1,23 @@
 .TH IMAGEX "1" "May 2013" "@IMAGEX_PROGNAME@ @VERSION@" "User Commands"
 .SH NAME
 @IMAGEX_PROGNAME@-capture, @IMAGEX_PROGNAME@-append \- Create or append a WIM image
 .TH IMAGEX "1" "May 2013" "@IMAGEX_PROGNAME@ @VERSION@" "User Commands"
 .SH NAME
 @IMAGEX_PROGNAME@-capture, @IMAGEX_PROGNAME@-append \- Create or append a WIM image

-

 .SH SYNOPSIS
 \fB@IMAGEX_PROGNAME@ capture\fR \fISOURCE\fR \fIWIMFILE\fR [\fIIMAGE_NAME\fR] \
 [\fIIMAGE_DESCRIPTION\fR] [\fIOPTION\fR...]
 .br
 \fB@IMAGEX_PROGNAME@ append\fR \fISOURCE\fR \fIWIMFILE\fR [\fIIMAGE_NAME\fR \
 [\fIIMAGE_DESCRIPTION\fR]] [\fIOPTION\fR...]
 .SH SYNOPSIS
 \fB@IMAGEX_PROGNAME@ capture\fR \fISOURCE\fR \fIWIMFILE\fR [\fIIMAGE_NAME\fR] \
 [\fIIMAGE_DESCRIPTION\fR] [\fIOPTION\fR...]
 .br
 \fB@IMAGEX_PROGNAME@ append\fR \fISOURCE\fR \fIWIMFILE\fR [\fIIMAGE_NAME\fR \
 [\fIIMAGE_DESCRIPTION\fR]] [\fIOPTION\fR...]

-

 .SH DESCRIPTION
 .SH DESCRIPTION

-.PP
-

 The \fB@IMAGEX_PROGNAME@ capture\fR and \fB@IMAGEX_PROGNAME@ append\fR commands
 create a Windows Imaging (WIM) image from a directory tree.  The
 \fB@IMAGEX_PROGNAME@ capture\fR command creates a new WIM file containing the
 captured image, while the \fB@IMAGEX_PROGNAME@ append\fR command appends the
 captured image to an existing WIM file.
 The \fB@IMAGEX_PROGNAME@ capture\fR and \fB@IMAGEX_PROGNAME@ append\fR commands
 create a Windows Imaging (WIM) image from a directory tree.  The
 \fB@IMAGEX_PROGNAME@ capture\fR command creates a new WIM file containing the
 captured image, while the \fB@IMAGEX_PROGNAME@ append\fR command appends the
 captured image to an existing WIM file.

-
+.PP

 A WIM image is an independent directory tree in the WIM file.  A WIM file may
 contain any number of separate images.  However, files are stored only one time
 in the entire WIM, regardless of how many images the file appears in.
 A WIM image is an independent directory tree in the WIM file.  A WIM file may
 contain any number of separate images.  However, files are stored only one time
 in the entire WIM, regardless of how many images the file appears in.

-
+.PP

 \fISOURCE\fR specifies the location of the files to create the new WIM image
 from.  If \fISOURCE\fR is a directory, the WIM image is captured from that
 directory.   Alternatively, if the \fB--source-list\fR option is given,
 \fISOURCE\fR specifies the location of the files to create the new WIM image
 from.  If \fISOURCE\fR is a directory, the WIM image is captured from that
 directory.   Alternatively, if the \fB--source-list\fR option is given,


@@ -30,24 +26,21 @@ files and directories to include in the new WIM image.  Still
 alternatively, only on UNIX builds of wimlib  if \fISOURCE\fR is a
 regular file or block device, it is interpreted as an NTFS volume from
 which a WIM image is to be captured. 
 alternatively, only on UNIX builds of wimlib  if \fISOURCE\fR is a
 regular file or block device, it is interpreted as an NTFS volume from
 which a WIM image is to be captured. 

-
+.PP

 \fIIMAGE_NAME\fR and \fIIMAGE_DESCRIPTION\fR specify the name and description of
 the new image.  If \fIIMAGE_NAME\fR is not given, it is taken to be the same as
 the base name of \fISOURCE\fR.  If \fIIMAGE_DESCRIPTION\fR is not given, no
 description is given to the new image.
 \fIIMAGE_NAME\fR and \fIIMAGE_DESCRIPTION\fR specify the name and description of
 the new image.  If \fIIMAGE_NAME\fR is not given, it is taken to be the same as
 the base name of \fISOURCE\fR.  If \fIIMAGE_DESCRIPTION\fR is not given, no
 description is given to the new image.

-

 .SH NORMAL MODE (UNIX)
 .SH NORMAL MODE (UNIX)

-

 This section documents how files are captured from a directory on UNIX.  See
 \fBWINDOWS VERSION\fR for the corresponding documentation for the Windows
 version.
 This section documents how files are captured from a directory on UNIX.  See
 \fBWINDOWS VERSION\fR for the corresponding documentation for the Windows
 version.

-
+.PP

 On UNIX, the "normal" image capture mode is entered when \fISOURCE\fR specifies
 a directory.  The WIM image will be captured from the directory tree rooted at
 this directory.  The directory may be on any type of filesystem.
 On UNIX, the "normal" image capture mode is entered when \fISOURCE\fR specifies
 a directory.  The WIM image will be captured from the directory tree rooted at
 this directory.  The directory may be on any type of filesystem.

-
+.PP

 In this mode, the following information is captured from the directory tree:
 In this mode, the following information is captured from the directory tree:

-

 .IP \[bu] 4
 The "normal" name and contents of each file and directory
 .IP \[bu]
 .IP \[bu] 4
 The "normal" name and contents of each file and directory
 .IP \[bu]


@@ -55,38 +48,32 @@ File and directory creation, access, and modification timestamps to the nearest
 100 nanoseconds, if supported by the underlying filesystem
 .IP \[bu]
 Hard links and symbolic links
 100 nanoseconds, if supported by the underlying filesystem
 .IP \[bu]
 Hard links and symbolic links

-

 .PP
 .PP

-

 However, in this mode, the following information is \fInot\fR captured from the
 directory tree:
 However, in this mode, the following information is \fInot\fR captured from the
 directory tree:

-

 .IP \[bu] 4
 UNIX file owners, groups, and modes.  The resulting WIM image will contain no
 security information (file permissions).  (Exception: see the \fB--unix-data\fR
 option.)
 .IP \[bu]
 Extended attributes.
 .IP \[bu] 4
 UNIX file owners, groups, and modes.  The resulting WIM image will contain no
 security information (file permissions).  (Exception: see the \fB--unix-data\fR
 option.)
 .IP \[bu]
 Extended attributes.

-

 .SH NTFS MODE (UNIX)
 .SH NTFS MODE (UNIX)

-

 This section documents how files are captured from an NTFS volume image on UNIX.
 See \fBWINDOWS VERSION\fR for the corresponding documentation for the Windows
 version.
 This section documents how files are captured from an NTFS volume image on UNIX.
 See \fBWINDOWS VERSION\fR for the corresponding documentation for the Windows
 version.

-
+.PP

 On UNIX, a special image capture mode is entered when \fISOURCE\fR is a regular
 file or block device.  \fISOURCE\fR is interpreted as an NTFS volume and opened
 using libntfs-3g.  If successful, a WIM image is captured containing the
 contents of the NTFS volume, including NTFS-specific data.
 On UNIX, a special image capture mode is entered when \fISOURCE\fR is a regular
 file or block device.  \fISOURCE\fR is interpreted as an NTFS volume and opened
 using libntfs-3g.  If successful, a WIM image is captured containing the
 contents of the NTFS volume, including NTFS-specific data.

-
+.PP

 Please note that the NTFS image capture mode is \fInot\fR entered if
 \fISOURCE\fR is a directory, even if an NTFS filesystem is mounted on
 \fISOURCE\fR.  You must specify the NTFS volume itself (and it must be
 unmounted, and you must have permission to read from it).
 Please note that the NTFS image capture mode is \fInot\fR entered if
 \fISOURCE\fR is a directory, even if an NTFS filesystem is mounted on
 \fISOURCE\fR.  You must specify the NTFS volume itself (and it must be
 unmounted, and you must have permission to read from it).

-
+.PP

 More specifically, in this mode, the following types of information are captured
 from the NTFS volume:
 More specifically, in this mode, the following types of information are captured
 from the NTFS volume:

-

 .IP \[bu] 4
 All data streams of all files, including the un-named data stream as well as all
 named data streams.
 .IP \[bu] 4
 All data streams of all files, including the un-named data stream as well as all
 named data streams.


@@ -103,18 +90,15 @@ File attribute flags.
 .IP \[bu]
 All names of all files, including names in the Win32 namespace, DOS namespace,
 Win32+DOS namespace, and POSIX namespace.  This includes hard links.
 .IP \[bu]
 All names of all files, including names in the Win32 namespace, DOS namespace,
 Win32+DOS namespace, and POSIX namespace.  This includes hard links.

-

 .SH WINDOWS VERSION
 .SH WINDOWS VERSION

-

 The Windows versions of \fB@IMAGEX_PROGNAME@ capture\fR and \fB@IMAGEX_PROGNAME@
 append\fR act similarly to the corresponding commands of Microsoft's ImageX.
 For best results, the directory being captured should be on an NTFS volume and
 you should be running with Administrator privileges; however, non-NTFS
 filesystems and running without Administrator privileges are also supported.
 The Windows versions of \fB@IMAGEX_PROGNAME@ capture\fR and \fB@IMAGEX_PROGNAME@
 append\fR act similarly to the corresponding commands of Microsoft's ImageX.
 For best results, the directory being captured should be on an NTFS volume and
 you should be running with Administrator privileges; however, non-NTFS
 filesystems and running without Administrator privileges are also supported.

-
+.PP

 On Windows, \fB@IMAGEX_PROGNAME@ capture\fR and \fB@IMAGEX_PROGNAME@ append\fR
 try to archive as much data as possible.  This includes:
 On Windows, \fB@IMAGEX_PROGNAME@ capture\fR and \fB@IMAGEX_PROGNAME@ append\fR
 try to archive as much data as possible.  This includes:

-

 .IP \[bu] 4
 All data streams of all files.  This includes the default file contents, as well
 as named data streams if supported by the filesystem and if the version of
 .IP \[bu] 4
 All data streams of all files.  This includes the default file contents, as well
 as named data streams if supported by the filesystem and if the version of


@@ -141,7 +125,6 @@ considered an error condition.
 .IP \[bu]
 Hard links, excluding directory hard links (which aren't supposed to exist
 anyway).
 .IP \[bu]
 Hard links, excluding directory hard links (which aren't supposed to exist
 anyway).

-

 .SH OPTIONS
 .TP 6
 \fB--boot\fR
 .SH OPTIONS
 .TP 6
 \fB--boot\fR


@@ -157,7 +140,7 @@ Specifies the compression type for the new WIM file.  This flag is only valid
 for \fB@IMAGEX_PROGNAME@ capture\fR, since the compression mode for
 \fB@IMAGEX_PROGNAME@ append\fR must be the same as that of the existing WIM.
 \fITYPE\fR may be "none", "maximum", or "fast".  By default, it is "fast".
 for \fB@IMAGEX_PROGNAME@ capture\fR, since the compression mode for
 \fB@IMAGEX_PROGNAME@ append\fR must be the same as that of the existing WIM.
 \fITYPE\fR may be "none", "maximum", or "fast".  By default, it is "fast".

-
+.IP ""

 You may also specify the actual names of the compression algorithms, "XPRESS"
 and "LZX", instead of "fast" and "maximum", respectively.
 .TP
 You may also specify the actual names of the compression algorithms, "XPRESS"
 and "LZX", instead of "fast" and "maximum", respectively.
 .TP


@@ -187,7 +170,7 @@ than archiving the links themselves.
 \fB--config\fR=\fIFILE\fR
 Specifies a configuration file for capturing the new image.  The configuration
 file specifies files that are to be treated specially during the image capture.
 \fB--config\fR=\fIFILE\fR
 Specifies a configuration file for capturing the new image.  The configuration
 file specifies files that are to be treated specially during the image capture.

-
+.IP ""

 The format of the configuration file is a number of sections containing path
 globs one per line, where each section begins with the tag [ExclusionList],
 [ExclusionException], [CompressionExclusionList], or [AlignmentList].
 The format of the configuration file is a number of sections containing path
 globs one per line, where each section begins with the tag [ExclusionList],
 [ExclusionException], [CompressionExclusionList], or [AlignmentList].


@@ -196,7 +179,7 @@ implemented.  The [ExclusionList] section specifies a list of path globs to
 exclude from capture, while the [ExclusionException] section specifies a list of
 path globs to include in the capture even if the matched file or directory name
 also appears in the [ExclusionList].
 exclude from capture, while the [ExclusionException] section specifies a list of
 path globs to include in the capture even if the matched file or directory name
 also appears in the [ExclusionList].

-
+.IP ""

 Relative globs with only one path component (e.g. *.mp3) match against a filename in any
 directory.  Relative globs with multiple path components (e.g. dir/file),
 as well as absolute globs (e.g. /dir/file), are treated as paths starting at the
 Relative globs with only one path component (e.g. *.mp3) match against a filename in any
 directory.  Relative globs with multiple path components (e.g. dir/file),
 as well as absolute globs (e.g. /dir/file), are treated as paths starting at the


@@ -205,19 +188,19 @@ If a directory is matched by a glob in the [ExclusionList], the entire directory
 tree rooted at that directory is excluded from the capture, unless
 \fB--dereference\fR is specified and there is another path into that directory
 through a symbolic link.
 tree rooted at that directory is excluded from the capture, unless
 \fB--dereference\fR is specified and there is another path into that directory
 through a symbolic link.

-
+.IP ""

 For compatibility with Windows, the path separators in the globs may be either
 forward slashes or backslashes, and the line separators may be either UNIX-style
 or DOS-style.  Globs with spaces in them must be quoted, and leading and
 trailing whitespace is not significant.  Empty lines and lines beginning with
 '#' or whitespace followed by '#' are ignored.
 For compatibility with Windows, the path separators in the globs may be either
 forward slashes or backslashes, and the line separators may be either UNIX-style
 or DOS-style.  Globs with spaces in them must be quoted, and leading and
 trailing whitespace is not significant.  Empty lines and lines beginning with
 '#' or whitespace followed by '#' are ignored.

-
+.IP ""

 Paths may not have drive letters in them, as they are all relative to the root
 of capture and not absolute external paths.
 Paths may not have drive letters in them, as they are all relative to the root
 of capture and not absolute external paths.

-
+.IP ""

 If this option is not specified the following default configuration file is
 used:
 If this option is not specified the following default configuration file is
 used:

-
+.IP ""

 .RS
 .RS
 .nf
 .RS
 .RS
 .nf


@@ -231,7 +214,6 @@ used:
 .RE
 .RE
 .fi
 .RE
 .RE
 .fi

-

 .TP
 \fB--unix-data\fR
 (UNIX only) Store the UNIX owner, group, and mode of all captured files.  This
 .TP
 \fB--unix-data\fR
 (UNIX only) Store the UNIX owner, group, and mode of all captured files.  This


@@ -262,12 +244,12 @@ relative to the root of the directory tree being captured.  In addition,
 absolute symbolic links that point outside the directory tree being captured
 will be ignored and not be captured at all.  When disabled (\fB--norpfix\fR),
 absolute symbolic links will be captured exactly as is.
 absolute symbolic links that point outside the directory tree being captured
 will be ignored and not be captured at all.  When disabled (\fB--norpfix\fR),
 absolute symbolic links will be captured exactly as is.

-
+.IP ""

 The default behavior for \fBimagex capture\fR is equivalent to \fB--rpfix\fR.
 The default behavior for \fBimagex append\fR will be \fB--rpfix\fR if reparse
 point fixups have previously been done on \fIWIMFILE\fR, otherwise
 \fB--norpfix\fR.
 The default behavior for \fBimagex capture\fR is equivalent to \fB--rpfix\fR.
 The default behavior for \fBimagex append\fR will be \fB--rpfix\fR if reparse
 point fixups have previously been done on \fIWIMFILE\fR, otherwise
 \fB--norpfix\fR.

-
+.IP ""

 In the case of a multi-source capture, (\fB--source-list\fR specified), passing
 \fB--norpfix\fR is recommended.  Otherwise, reparse point fixups will be
 disabled on all capture sources destined for non-root locations in the WIM
 In the case of a multi-source capture, (\fB--source-list\fR specified), passing
 \fB--norpfix\fR is recommended.  Otherwise, reparse point fixups will be
 disabled on all capture sources destined for non-root locations in the WIM


@@ -286,10 +268,9 @@ target and specifies the path  in the WIM image that this file or directory will
 be saved as.  Leading and trailing slashes are ignored.  "/" indicates that the
 directory is to become the root of the WIM image.  If not specified, the target
 string defaults to the same as the source string.
 be saved as.  Leading and trailing slashes are ignored.  "/" indicates that the
 directory is to become the root of the WIM image.  If not specified, the target
 string defaults to the same as the source string.

-
+.IP ""

 An example source list file is as follows:
 An example source list file is as follows:

-
-.RS
+.IP ""

 .RS
 .nf
 # Make the WIM image from the 'winpe' directory
 .RS
 .nf
 # Make the WIM image from the 'winpe' directory


@@ -303,48 +284,45 @@ overlay   /overlay
 /data/stuff    /
 .RE
 .fi
 /data/stuff    /
 .RE
 .fi

-
+.IP ""

 Subdirectories in the WIM are created as needed.  Multiple source directories
 may share the same target, which implies an overlay; however, an error is issued
 if the same file appears in different overlays to the same directory.
 Subdirectories in the WIM are created as needed.  Multiple source directories
 may share the same target, which implies an overlay; however, an error is issued
 if the same file appears in different overlays to the same directory.

-
+.IP ""

 File paths containing whitespace may be quoted with either single quotes or
 double quotes.  Quotes may not be escaped.
 File paths containing whitespace may be quoted with either single quotes or
 double quotes.  Quotes may not be escaped.

-
+.IP ""

 Lines consisting only of whitespace and lines beginning with '#' preceded by
 optional whitespace are ignored.
 Lines consisting only of whitespace and lines beginning with '#' preceded by
 optional whitespace are ignored.

-
+.IP ""

 As a special case, if \fISOURCE\fR is "-", the source list is read from standard
 input rather than an external file.
 As a special case, if \fISOURCE\fR is "-", the source list is read from standard
 input rather than an external file.

-
+.IP ""

 The NTFS capture mode cannot be used with \fB--source-list\fR, as only capturing
 a full NTFS volume is supported.
 The NTFS capture mode cannot be used with \fB--source-list\fR, as only capturing
 a full NTFS volume is supported.

-

 .SH NOTES
 .SH NOTES

-

 \fBimage append\fR does not support appending an image to a split WIM.
 \fBimage append\fR does not support appending an image to a split WIM.

-
+.PP

 The different capture modes only specify the data that is captured and don't
 specify a special WIM format.  A WIM file can contain images captured using
 different modes.  However, all images in a WIM must have the same compression
 type, and \fB@IMAGEX_PROGNAME@\fR always enforces this.
 The different capture modes only specify the data that is captured and don't
 specify a special WIM format.  A WIM file can contain images captured using
 different modes.  However, all images in a WIM must have the same compression
 type, and \fB@IMAGEX_PROGNAME@\fR always enforces this.

-
+.PP

 \fB@IMAGEX_PROGNAME@\fR writes WIMs having the version number 0x10d00 and a compressed
 stream chunk size of 32768.  The only WIMs I've seen that are different from
 this are some pre-Vista WIMs that had a different version number.
 \fB@IMAGEX_PROGNAME@\fR writes WIMs having the version number 0x10d00 and a compressed
 stream chunk size of 32768.  The only WIMs I've seen that are different from
 this are some pre-Vista WIMs that had a different version number.

-
+.PP

 It is safe to abort an \fB@IMAGEX_PROGNAME@ append\fR command partway through;
 however, after doing this, it is recommended to run \fB@IMAGEX_PROGNAME@
 optimize\fR to remove any data that was appended to the physical WIM file but
 not yet incorporated into the structure of the WIM, unless \fB--rebuild\fR was
 specified, in which case you should delete the temporary file left over.
 It is safe to abort an \fB@IMAGEX_PROGNAME@ append\fR command partway through;
 however, after doing this, it is recommended to run \fB@IMAGEX_PROGNAME@
 optimize\fR to remove any data that was appended to the physical WIM file but
 not yet incorporated into the structure of the WIM, unless \fB--rebuild\fR was
 specified, in which case you should delete the temporary file left over.

-
+.PP

 \fISOURCE\fR may be a symbolic link to a directory rather than a directory
 itself.  However, additional symbolic links in subdirectories, or in additional
 source directories not destined for the WIM image root (with
 \fB--source-list\fR), are not dereferenced unless \fB--dereference\fR is
 specified.
 \fISOURCE\fR may be a symbolic link to a directory rather than a directory
 itself.  However, additional symbolic links in subdirectories, or in additional
 source directories not destined for the WIM image root (with
 \fB--source-list\fR), are not dereferenced unless \fB--dereference\fR is
 specified.

-

 .SH EXAMPLES
 Create a new WIM 'mywim.wim' from the directory 'somedir', using LZX compression and
 including an integrity table:
 .SH EXAMPLES
 Create a new WIM 'mywim.wim' from the directory 'somedir', using LZX compression and
 including an integrity table:


@@ -363,6 +341,5 @@ integrity table to be discarded.
 @IMAGEX_PROGNAME@ append /dev/sda2 mywim.wim --check "Windows 7"
 .RE
 .PP
 @IMAGEX_PROGNAME@ append /dev/sda2 mywim.wim --check "Windows 7"
 .RE
 .PP

-

 .SH SEE ALSO
 .BR @IMAGEX_PROGNAME@ (1)
 .SH SEE ALSO
 .BR @IMAGEX_PROGNAME@ (1)

diff --git a/doc/imagex-delete.1.in b/doc/imagex-delete.1.in
index 41a10bc7bf389dbb376992da54958d25b4ef8a4f..166eaffd71b690716e8d83c0bd07f552cf0c1db5 100644 (file)
--- a/doc/imagex-delete.1.in
+++ b/doc/imagex-delete.1.in
@@ -1,33 +1,26 @@
 .TH IMAGEX "1" "May 2013" "@IMAGEX_PROGNAME@ @VERSION@" "User Commands"
 .SH NAME
 @IMAGEX_PROGNAME@-delete \- Delete an image from a WIM archive
 .TH IMAGEX "1" "May 2013" "@IMAGEX_PROGNAME@ @VERSION@" "User Commands"
 .SH NAME
 @IMAGEX_PROGNAME@-delete \- Delete an image from a WIM archive

-

 .SH SYNOPSIS
 \fB@IMAGEX_PROGNAME@ delete\fR \fIWIMFILE\fR \fIIMAGE\fR [--check]
 .SH SYNOPSIS
 \fB@IMAGEX_PROGNAME@ delete\fR \fIWIMFILE\fR \fIIMAGE\fR [--check]

-

 .SH DESCRIPTION
 .SH DESCRIPTION

-.PP
-

 \fB@IMAGEX_PROGNAME@ delete\fR deletes the specified image from the Windows Imaging (WIM)
 file \fIWIMFILE\fR.
 \fB@IMAGEX_PROGNAME@ delete\fR deletes the specified image from the Windows Imaging (WIM)
 file \fIWIMFILE\fR.

-
+.PP

 \fIIMAGE\fR specifies the WIM image to deleted.  It may be a 1-based index of an
 image in the WIM, the name of an image in the WIM, or the keyword "all" to
 indicate that all images are to be deleted.  Use the \fB@IMAGEX_PROGNAME@ info\fR (1)
 command to show what images a WIM file contains.
 \fIIMAGE\fR specifies the WIM image to deleted.  It may be a 1-based index of an
 image in the WIM, the name of an image in the WIM, or the keyword "all" to
 indicate that all images are to be deleted.  Use the \fB@IMAGEX_PROGNAME@ info\fR (1)
 command to show what images a WIM file contains.

-

 .SH NOTES
 .SH NOTES

-

 By default, the WIM file is rebuilt with all unnecessary file data removed.
 This is different from Microsoft's imagex.exe, which only will delete the
 directory tree metadata and XML data for this operation.  (See the \fB--soft\fR
 option for the other kind of delete).
 By default, the WIM file is rebuilt with all unnecessary file data removed.
 This is different from Microsoft's imagex.exe, which only will delete the
 directory tree metadata and XML data for this operation.  (See the \fB--soft\fR
 option for the other kind of delete).

-
+.PP

 Also, unlike Microsoft's imagex.exe, it is legal to delete all the images from a
 WIM and have a WIM with 0 images, although such a file wouldn't be very useful.
 Also, unlike Microsoft's imagex.exe, it is legal to delete all the images from a
 WIM and have a WIM with 0 images, although such a file wouldn't be very useful.

-
+.PP

 \fB@IMAGEX_PROGNAME@ delete\fR does not support split WIMs.
 \fB@IMAGEX_PROGNAME@ delete\fR does not support split WIMs.

-

 .SH OPTIONS
 .TP 6
 \fB--check\fR
 .SH OPTIONS
 .TP 6
 \fB--check\fR


@@ -43,10 +36,9 @@ changes to correctly remove the image from the WIM will be taken.  In
 particular, all streams will be left alone, even if they are no longer
 referenced.  This is probably not what you want, because almost no space will be
 saved by deleting an image in this way.
 particular, all streams will be left alone, even if they are no longer
 referenced.  This is probably not what you want, because almost no space will be
 saved by deleting an image in this way.

-
+.IP ""

 You may use \fB@IMAGEX_PROGNAME@ optimize\fR to delete unreferenced streams from a WIM that
 has had images soft-deleted from it.
 You may use \fB@IMAGEX_PROGNAME@ optimize\fR to delete unreferenced streams from a WIM that
 has had images soft-deleted from it.

-

 .SH EXAMPLES
 Delete the first image from 'boot.wim':
 .RS
 .SH EXAMPLES
 Delete the first image from 'boot.wim':
 .RS


@@ -54,9 +46,7 @@ Delete the first image from 'boot.wim':
 @IMAGEX_PROGNAME@ delete boot.wim 1
 .RE
 .PP
 @IMAGEX_PROGNAME@ delete boot.wim 1
 .RE
 .PP

-

 .SH SEE ALSO
 .BR @IMAGEX_PROGNAME@ (1)
 .BR @IMAGEX_PROGNAME@-info (1)
 .BR @IMAGEX_PROGNAME@-optimize (1)
 .SH SEE ALSO
 .BR @IMAGEX_PROGNAME@ (1)
 .BR @IMAGEX_PROGNAME@-info (1)
 .BR @IMAGEX_PROGNAME@-optimize (1)

-

diff --git a/doc/imagex-dir.1.in b/doc/imagex-dir.1.in
index a529cc5955194457e79ac39f091ec3ae6fe673d0..3f2409d54f10bfd9550588be0fd98b064193c9e4 100644 (file)
--- a/doc/imagex-dir.1.in
+++ b/doc/imagex-dir.1.in
@@ -1,30 +1,24 @@
 .TH IMAGEX "1" "May 2013" "@IMAGEX_PROGNAME@ @VERSION@" "User Commands"
 .SH NAME
 @IMAGEX_PROGNAME@-dir \- Show the files contained in a WIM archive
 .TH IMAGEX "1" "May 2013" "@IMAGEX_PROGNAME@ @VERSION@" "User Commands"
 .SH NAME
 @IMAGEX_PROGNAME@-dir \- Show the files contained in a WIM archive

-

 .SH SYNOPSIS
 \fB@IMAGEX_PROGNAME@ dir\fR \fIWIMFILE\fR \fIIMAGE\fR
 .SH SYNOPSIS
 \fB@IMAGEX_PROGNAME@ dir\fR \fIWIMFILE\fR \fIIMAGE\fR

-

 .SH DESCRIPTION
 .SH DESCRIPTION

-.PP

 Lists all the files and directories contained in the specified image of the
 Windows Imaging (WIM) file \fIWIMFILE\fR.
 Lists all the files and directories contained in the specified image of the
 Windows Imaging (WIM) file \fIWIMFILE\fR.

-
+.PP

 \fIIMAGE\fR specifies the WIM image to show the files of.  It may be a 1-based
 index of an image in the WIM, the name of an image in the WIM, or the keyword
 "all" to indicate that files from all images are to be shown.  Use the
 \fB@IMAGEX_PROGNAME@ info\fR (1) command to show what images a WIM file
 contains.
 \fIIMAGE\fR specifies the WIM image to show the files of.  It may be a 1-based
 index of an image in the WIM, the name of an image in the WIM, or the keyword
 "all" to indicate that files from all images are to be shown.  Use the
 \fB@IMAGEX_PROGNAME@ info\fR (1) command to show what images a WIM file
 contains.

-

 .SH NOTES
 .SH NOTES

-

 \fB@IMAGEX_PROGNAME@ dir\fR supports split WIMs, but it will only work on the
 first part of the split WIM.
 \fB@IMAGEX_PROGNAME@ dir\fR supports split WIMs, but it will only work on the
 first part of the split WIM.

-
+.PP

 The DOS names of files are not displayed.
 The DOS names of files are not displayed.

-
+.PP

 Alternate data streams are not displayed.
 Alternate data streams are not displayed.

-

 .SH EXAMPLES
 List all files in the first image of 'boot.wim':
 .RS
 .SH EXAMPLES
 List all files in the first image of 'boot.wim':
 .RS


@@ -32,7 +26,6 @@ List all files in the first image of 'boot.wim':
 @IMAGEX_PROGNAME@ dir boot.wim 1
 .RE
 .PP
 @IMAGEX_PROGNAME@ dir boot.wim 1
 .RE
 .PP

-

 .SH SEE ALSO
 .BR @IMAGEX_PROGNAME@ (1)
 .BR @IMAGEX_PROGNAME@-info (1)
 .SH SEE ALSO
 .BR @IMAGEX_PROGNAME@ (1)
 .BR @IMAGEX_PROGNAME@-info (1)

diff --git a/doc/imagex-export.1.in b/doc/imagex-export.1.in
index c6e012e7153b8afe0fa943ed15bdb52a7cc8f9a5..402302def037a77dda9b69b2f4941cf364366773 100644 (file)
--- a/doc/imagex-export.1.in
+++ b/doc/imagex-export.1.in
@@ -1,44 +1,40 @@
 .TH IMAGEX "1" "May 2013" "@IMAGEX_PROGNAME@ @VERSION@" "User Commands"
 .SH NAME
 @IMAGEX_PROGNAME@-export \- Exports an image from a WIM archive to an existing or new WIM archive
 .TH IMAGEX "1" "May 2013" "@IMAGEX_PROGNAME@ @VERSION@" "User Commands"
 .SH NAME
 @IMAGEX_PROGNAME@-export \- Exports an image from a WIM archive to an existing or new WIM archive

-

 .SH SYNOPSIS
 \fB@IMAGEX_PROGNAME@ export\fR \fISRC_WIMFILE\fR \fISRC_IMAGE\fR
 \fIDEST_WIMFILE\fR [\fIDEST_IMAGE_NAME\fR\] [\fIDEST_IMAGE_DESCRIPTION\fR]
 [\fIOPTION\fR...]
 .SH SYNOPSIS
 \fB@IMAGEX_PROGNAME@ export\fR \fISRC_WIMFILE\fR \fISRC_IMAGE\fR
 \fIDEST_WIMFILE\fR [\fIDEST_IMAGE_NAME\fR\] [\fIDEST_IMAGE_DESCRIPTION\fR]
 [\fIOPTION\fR...]

-

 .SH DESCRIPTION
 .SH DESCRIPTION

-.PP
-

 Copies the specified image in \fISRC_WIMFILE\fR to \fIDEST_WIMFILE\fR,
 optionally changing its name and/or description and/or compression type.
 If \fIDEST_WIMFILE\fR exists, it is taken be be a WIM archive to which the image
 will be appended.  Otherwise, it is created as a new WIM archive containing only
 the exported image.
 Copies the specified image in \fISRC_WIMFILE\fR to \fIDEST_WIMFILE\fR,
 optionally changing its name and/or description and/or compression type.
 If \fIDEST_WIMFILE\fR exists, it is taken be be a WIM archive to which the image
 will be appended.  Otherwise, it is created as a new WIM archive containing only
 the exported image.

-
+.PP

 \fISRC_IMAGE\fR specifies the image in \fISRC_WIMFILE\fR to export.  It may be a
 1-based index of an image in the WIM, the name of an image in the WIM, or the
 keyword "all" to indicate that all images are to be exported.  Use the
 \fB@IMAGEX_PROGNAME@ info\fR (1) command to list the images a WIM file contains.
 \fISRC_IMAGE\fR specifies the image in \fISRC_WIMFILE\fR to export.  It may be a
 1-based index of an image in the WIM, the name of an image in the WIM, or the
 keyword "all" to indicate that all images are to be exported.  Use the
 \fB@IMAGEX_PROGNAME@ info\fR (1) command to list the images a WIM file contains.

-
+.PP

 If given, \fIDEST_IMAGE_NAME\fR specifies the name to give the image being
 exported to \fIDEST_WIMFILE\fR.  The default is its name in \fISRC_WIMFILE\fR.
 \fIDEST_IMAGE_NAME\fR cannot be specified if multiple images are being exported.
 If given, \fIDEST_IMAGE_NAME\fR specifies the name to give the image being
 exported to \fIDEST_WIMFILE\fR.  The default is its name in \fISRC_WIMFILE\fR.
 \fIDEST_IMAGE_NAME\fR cannot be specified if multiple images are being exported.

-
+.PP

 If given, \fIDEST_IMAGE_DESCRIPTION\fR specifies the description to give the
 image being exported to \fIDEST_WIMFILE\fR.  The default is its description in
 \fISRC_WIMFILE\fR.
 If given, \fIDEST_IMAGE_DESCRIPTION\fR specifies the description to give the
 image being exported to \fIDEST_WIMFILE\fR.  The default is its description in
 \fISRC_WIMFILE\fR.

-
+.PP

 \fB@IMAGEX_PROGNAME@ export\fR supports exporting images from stand-alone WIMs as well as
 from split WIMs.  However, you cannot export an image to a split WIM.  See
 \fBSPLIT WIMS\fR.
 \fB@IMAGEX_PROGNAME@ export\fR supports exporting images from stand-alone WIMs as well as
 from split WIMs.  However, you cannot export an image to a split WIM.  See
 \fBSPLIT WIMS\fR.

-
+.PP

 .SH OPTIONS
 .TP 6
 \fB--boot\fR
 Specifies that the exported image is to be the bootable image of the destination
 WIM archive.
 .SH OPTIONS
 .TP 6
 \fB--boot\fR
 Specifies that the exported image is to be the bootable image of the destination
 WIM archive.

-
+.IP ""

 If multiple images are being exported, this flag indicates that the image in the
 \fISRC_WIMFILE\fR that is currently marked as bootable is to be made bootable in
 \fIDEST_WIMFILE\fR.  If no image in \fISRC_WIMFILE\fR is bootable, it is an
 If multiple images are being exported, this flag indicates that the image in the
 \fISRC_WIMFILE\fR that is currently marked as bootable is to be made bootable in
 \fIDEST_WIMFILE\fR.  If no image in \fISRC_WIMFILE\fR is bootable, it is an


@@ -55,10 +51,10 @@ even if there was one before.
 Specifies the compression type for \fIDEST_WIMFILE\fR.  This is only valid if
 \fIDEST_WIMFILE\fR does not yet exist, since if \fIDEST_WIMFILE\fR exists, the
 compression type must be the same as that of \fIDEST_WIMFILE\fR.
 Specifies the compression type for \fIDEST_WIMFILE\fR.  This is only valid if
 \fIDEST_WIMFILE\fR does not yet exist, since if \fIDEST_WIMFILE\fR exists, the
 compression type must be the same as that of \fIDEST_WIMFILE\fR.

-
+.IP ""

 \fITYPE\fR may be "none", "maximum", or "fast".  By default, it is the same as
 that of the input WIM file.
 \fITYPE\fR may be "none", "maximum", or "fast".  By default, it is the same as
 that of the input WIM file.

-
+.IP ""

 You may also specify the actual names of the compression algorithms, "XPRESS"
 and "LZX", instead of "fast" and "maximum", respectively.
 .TP
 You may also specify the actual names of the compression algorithms, "XPRESS"
 and "LZX", instead of "fast" and "maximum", respectively.
 .TP


@@ -78,9 +74,7 @@ little bit of space that would otherwise be left as a hole in the WIM.  Also see
 \fB--ref\fR="\fIGLOB\fR"
 File glob of additional split WIM parts that are part of the split WIM being
 exported.  See \fBSPLIT_WIMS\fR.
 \fB--ref\fR="\fIGLOB\fR"
 File glob of additional split WIM parts that are part of the split WIM being
 exported.  See \fBSPLIT_WIMS\fR.

-

 .SH SPLIT WIMS
 .SH SPLIT WIMS

-

 You may use \fB@IMAGEX_PROGNAME@ export\fR to export images from a split WIM.  The
 \fISRC_WIMFILE\fR argument is used to specify the first part of the split WIM, and
 the \fB--refs\fR="\fIGLOB\fR" option is used to provide a shell-style file glob
 You may use \fB@IMAGEX_PROGNAME@ export\fR to export images from a split WIM.  The
 \fISRC_WIMFILE\fR argument is used to specify the first part of the split WIM, and
 the \fB--refs\fR="\fIGLOB\fR" option is used to provide a shell-style file glob


@@ -90,11 +84,10 @@ is protected against shell expansion.  \fIGLOB\fR must expand to all parts of
 the split WIM, except optionally the first part which may either omitted or
 included in the glob (but the first part MUST be specified as \fISRC_WIMFILE\fR as
 well).
 the split WIM, except optionally the first part which may either omitted or
 included in the glob (but the first part MUST be specified as \fISRC_WIMFILE\fR as
 well).

-
+.PP

 Here's an example.  The names for the split WIMs usually go something like:
 Here's an example.  The names for the split WIMs usually go something like:

-
-.RS

 .PP
 .PP

+.RS

 .nf
 mywim.swm
 mywim2.swm
 .nf
 mywim.swm
 mywim2.swm


@@ -102,23 +95,19 @@ mywim3.swm
 mywim4.swm
 mywim5.swm
 .RE
 mywim4.swm
 mywim5.swm
 .RE

-
+.PP

 To export the first image of this split WIM to a new or existing WIM file
 "other.wim", run:
 .PP
 .RS
 @IMAGEX_PROGNAME@ export mywim.swm 1 other.wim --ref="mywim*.swm"
 .RE
 To export the first image of this split WIM to a new or existing WIM file
 "other.wim", run:
 .PP
 .RS
 @IMAGEX_PROGNAME@ export mywim.swm 1 other.wim --ref="mywim*.swm"
 .RE

-.PP
-

 .SH NOTES
 .SH NOTES

-

 It is safe to abort an \fB@IMAGEX_PROGNAME@ export\fR command partway through;
 however, after doing this, it is recommended to run \fB@IMAGEX_PROGNAME@
 optimize\fR to remove any data that was appended to the physical WIM file but
 not yet incorporated into the structure of the WIM, unless \fB--rebuild\fR was
 specified, in which case you should delete the temporary file left over.
 It is safe to abort an \fB@IMAGEX_PROGNAME@ export\fR command partway through;
 however, after doing this, it is recommended to run \fB@IMAGEX_PROGNAME@
 optimize\fR to remove any data that was appended to the physical WIM file but
 not yet incorporated into the structure of the WIM, unless \fB--rebuild\fR was
 specified, in which case you should delete the temporary file left over.

-

 .SH EXAMPLES
 Export the second image of 'boot.wim' to the new WIM file 'new.wim', and
 change the compression type to maximum, if it wasn't maximum already:
 .SH EXAMPLES
 Export the second image of 'boot.wim' to the new WIM file 'new.wim', and
 change the compression type to maximum, if it wasn't maximum already:


@@ -127,7 +116,6 @@ change the compression type to maximum, if it wasn't maximum already:
 @IMAGEX_PROGNAME@ export boot.wim 2 new.wim --compress=maximum
 .RE
 .PP
 @IMAGEX_PROGNAME@ export boot.wim 2 new.wim --compress=maximum
 .RE
 .PP

-

 .SH SEE ALSO
 .BR @IMAGEX_PROGNAME@ (1)
 .BR @IMAGEX_PROGNAME@-info (1)
 .SH SEE ALSO
 .BR @IMAGEX_PROGNAME@ (1)
 .BR @IMAGEX_PROGNAME@-info (1)

diff --git a/doc/imagex-extract.1.in b/doc/imagex-extract.1.in
index fceb86f732b7d27bca492a21fa8ed1344e44bf25..98e609c69b2b4a83e355a2fd742a1a3734a520bd 100644 (file)
--- a/doc/imagex-extract.1.in
+++ b/doc/imagex-extract.1.in
@@ -1,59 +1,50 @@
 .TH IMAGEX "1" "May 2013" "@IMAGEX_PROGNAME@ @VERSION@" "User Commands"
 .SH NAME
 @IMAGEX_PROGNAME@-extract \- Extract files or directories from a WIM image
 .TH IMAGEX "1" "May 2013" "@IMAGEX_PROGNAME@ @VERSION@" "User Commands"
 .SH NAME
 @IMAGEX_PROGNAME@-extract \- Extract files or directories from a WIM image

-

 .SH SYNOPSIS
 \fB@IMAGEX_PROGNAME@ extract\fR \fIWIMFILE\fR \fIIMAGE\fR [\fIPATH\fR...]  [\fIOPTION\fR...]
 .SH SYNOPSIS
 \fB@IMAGEX_PROGNAME@ extract\fR \fIWIMFILE\fR \fIIMAGE\fR [\fIPATH\fR...]  [\fIOPTION\fR...]

-

 .SH DESCRIPTION
 .SH DESCRIPTION

-.PP
-

 \fB@IMAGEX_PROGNAME@ extract\fR extracts one or more files or directory trees
 from the specified \fIIMAGE\fR contained in the Windows Imaging (WIM) file
 \fIWIMFILE\fR.
 \fB@IMAGEX_PROGNAME@ extract\fR extracts one or more files or directory trees
 from the specified \fIIMAGE\fR contained in the Windows Imaging (WIM) file
 \fIWIMFILE\fR.

-
+.PP

 \fB@IMAGEX_PROGNAME@ extract\fR is intended for extracting only a subset of a
 WIM image.  If you want to extract or "apply" a full WIM image to a directory or
 NTFS volume, use \fB@IMAGEX_PROGNAME@ apply\fR (1) instead.
 \fB@IMAGEX_PROGNAME@ extract\fR is intended for extracting only a subset of a
 WIM image.  If you want to extract or "apply" a full WIM image to a directory or
 NTFS volume, use \fB@IMAGEX_PROGNAME@ apply\fR (1) instead.

-
+.PP

 \fIIMAGE\fR specifies the image in \fIWIMFILE\fR that contains the files or
 directory trees to extract.  It may be a 1-based index of an image in the WIM or
 the name of an image in the WIM.  Use the \fB@IMAGEX_PROGNAME@ info\fR (1)
 command to show what images a WIM file contains.
 \fIIMAGE\fR specifies the image in \fIWIMFILE\fR that contains the files or
 directory trees to extract.  It may be a 1-based index of an image in the WIM or
 the name of an image in the WIM.  Use the \fB@IMAGEX_PROGNAME@ info\fR (1)
 command to show what images a WIM file contains.

-
+.PP

 Each \fIPATH\fR specifies a file or directory tree within the WIM image to
 extract.  See \fBPATH_SPECIFICATIONS\fR.
 Each \fIPATH\fR specifies a file or directory tree within the WIM image to
 extract.  See \fBPATH_SPECIFICATIONS\fR.

-
+.PP

 By default, files and directories are extracted to the current directory.  Use
 \fB--dest-dir\fR to choose an alternate target directory.  Alternatively, use
 \fB--to-stdout\fR to extract a file to standard output to pipe into another
 program.
 By default, files and directories are extracted to the current directory.  Use
 \fB--dest-dir\fR to choose an alternate target directory.  Alternatively, use
 \fB--to-stdout\fR to extract a file to standard output to pipe into another
 program.

-
+.PP

 \fB@IMAGEX_PROGNAME@ extract\fR supports extracting files and directory trees
 from stand-alone WIMs as well as split WIMs.  See \fBSPLIT WIMS\fR.
 \fB@IMAGEX_PROGNAME@ extract\fR supports extracting files and directory trees
 from stand-alone WIMs as well as split WIMs.  See \fBSPLIT WIMS\fR.

-

 .SH PATH SPECIFICATIONS
 .SH PATH SPECIFICATIONS

-

 Each \fIPATH\fR specifies a file or directory tree within the WIM image to
 extract.  Each path must be specified as an absolute path starting from the root
 of the WIM image, like those output by the \fB@IMAGEX_PROGNAME@ dir\fR (1)
 command.  Path separators may be forward slashes on UNIX, or either forward
 slashes or backward slashes on Windows.  The leading slash is optional.
 Each \fIPATH\fR specifies a file or directory tree within the WIM image to
 extract.  Each path must be specified as an absolute path starting from the root
 of the WIM image, like those output by the \fB@IMAGEX_PROGNAME@ dir\fR (1)
 command.  Path separators may be forward slashes on UNIX, or either forward
 slashes or backward slashes on Windows.  The leading slash is optional.

-
+.PP

 If no \fIPATH\fRs are provided, the default behavior is to extract the full
 image, as if the path "/" had been provided.
 If no \fIPATH\fRs are provided, the default behavior is to extract the full
 image, as if the path "/" had been provided.

-

 .SH SPLIT WIMS
 .SH SPLIT WIMS

-

 You may use \fB@IMAGEX_PROGNAME@ extract\fR to extract files or directory trees
 from a split WIM.  This uses the \fB--refs\fR="\fIGLOB\fR" option in the same
 way as in other commands such as \fB@IMAGEX_PROGNAME@ apply\fR.  See
 \fB@IMAGEX_PROGNAME@ apply\fR (1) for more details.
 You may use \fB@IMAGEX_PROGNAME@ extract\fR to extract files or directory trees
 from a split WIM.  This uses the \fB--refs\fR="\fIGLOB\fR" option in the same
 way as in other commands such as \fB@IMAGEX_PROGNAME@ apply\fR.  See
 \fB@IMAGEX_PROGNAME@ apply\fR (1) for more details.

-

 .SH OPTIONS
 .TP 6
 \fB--check\fR
 .SH OPTIONS
 .TP 6
 \fB--check\fR

-When reading \fIWIMFILE\fR, verify its integrity if the integrity table is
+When reading \fIWIMFILE\fR, verify its integrity if an integrity table is

 present.
 .TP
 \fB--ref\fR="\fIGLOB\fR"
 present.
 .TP
 \fB--ref\fR="\fIGLOB\fR"


@@ -61,7 +52,7 @@ File glob of additional split WIM parts that are part of the split WIM.  See
 \fBSPLIT_WIMS\fR.
 .TP
 \fB--verbose\fR
 \fBSPLIT_WIMS\fR.
 .TP
 \fB--verbose\fR

-Print the path to of each file or directory within the WIM image as it is
+Print the path of each file or directory within the WIM image as it is

 extracted.
 .TP
 \fB--unix-data\fR
 extracted.
 .TP
 \fB--unix-data\fR


@@ -82,23 +73,20 @@ extracted.
 \fB--dest-dir\fR=\fIDIR\fR
 Extract the files and directories to the directory \fIDIR\fR instead of to the
 current working directory.
 \fB--dest-dir\fR=\fIDIR\fR
 Extract the files and directories to the directory \fIDIR\fR instead of to the
 current working directory.

-

 .SH NOTES
 .SH NOTES

-

 See the documentation \fB@IMAGEX_PROGNAME@ apply\fR (1) for documentation about
 what data and metadata are extracted on UNIX versus on Windows.
 See the documentation \fB@IMAGEX_PROGNAME@ apply\fR (1) for documentation about
 what data and metadata are extracted on UNIX versus on Windows.

-
+.PP

 On UNIX, one can alternatively mount the WIM image with \fB@IMAGEX_PROGNAME@
 mount\fR and then extract the desired files or directories using any standard
 command-line or graphical program.
 On UNIX, one can alternatively mount the WIM image with \fB@IMAGEX_PROGNAME@
 mount\fR and then extract the desired files or directories using any standard
 command-line or graphical program.

-
+.PP

 Reparse-point fixups (a.k.a. changing absolute symbolic links and junctions to
 point within the extraction location) are never done by \fB@IMAGEX_PROGNAME@
 extract\fR.  Use \fB@IMAGEX_PROGNAME@ apply\fR if you want this behavior.
 Reparse-point fixups (a.k.a. changing absolute symbolic links and junctions to
 point within the extraction location) are never done by \fB@IMAGEX_PROGNAME@
 extract\fR.  Use \fB@IMAGEX_PROGNAME@ apply\fR if you want this behavior.

-
+.PP

 Unlike \fB@IMAGEX_PROGNAME@ apply\fR, \fB@IMAGEX_PROGNAME@ extract\fR does not
 support extracting files directly to a NTFS volume using libntfs-3g.
 Unlike \fB@IMAGEX_PROGNAME@ apply\fR, \fB@IMAGEX_PROGNAME@ extract\fR does not
 support extracting files directly to a NTFS volume using libntfs-3g.

-

 .SH EXAMPLES
 Extract a file from the first image in "boot.wim" to the current directory:
 .RS
 .SH EXAMPLES
 Extract a file from the first image in "boot.wim" to the current directory:
 .RS


@@ -131,7 +119,6 @@ Extract multiple files and directories in one command:
 @IMAGEX_PROGNAME@ extract boot.wim 1 /Windows/Fonts /sources /Windows/System32/cmd.exe
 .RE
 .PP
 @IMAGEX_PROGNAME@ extract boot.wim 1 /Windows/Fonts /sources /Windows/System32/cmd.exe
 .RE
 .PP

-

 .SH SEE ALSO
 .BR @IMAGEX_PROGNAME@ (1)
 .BR @IMAGEX_PROGNAME@-apply (1)
 .SH SEE ALSO
 .BR @IMAGEX_PROGNAME@ (1)
 .BR @IMAGEX_PROGNAME@-apply (1)

diff --git a/doc/imagex-info.1.in b/doc/imagex-info.1.in
index 561afe6f8e8e93ca21b6895d1995d39ba2eac960..fa3e9ccae7ae7fe3a630a2ec33631b3a81e71d02 100644 (file)
--- a/doc/imagex-info.1.in
+++ b/doc/imagex-info.1.in
@@ -2,33 +2,27 @@
 .SH NAME
 @IMAGEX_PROGNAME@-info \- Display information about a WIM file, or change information about
 an image
 .SH NAME
 @IMAGEX_PROGNAME@-info \- Display information about a WIM file, or change information about
 an image

-

 .SH SYNOPSIS
 \fB@IMAGEX_PROGNAME@ info\fR \fIWIMFILE\fR [\fIIMAGE\fR [\fINEW_NAME\fR
 [\fINEW_DESC\fR]]] [\fIOPTION\fR...]
 .SH SYNOPSIS
 \fB@IMAGEX_PROGNAME@ info\fR \fIWIMFILE\fR [\fIIMAGE\fR [\fINEW_NAME\fR
 [\fINEW_DESC\fR]]] [\fIOPTION\fR...]

-
-

 .SH DESCRIPTION
 .SH DESCRIPTION

-.PP
-

 \fB@IMAGEX_PROGNAME@ info\fR displays information about \fIWIMFILE\fR, and optionally
 changes which image is bootable, or what the name and description of an image
 are.
 \fB@IMAGEX_PROGNAME@ info\fR displays information about \fIWIMFILE\fR, and optionally
 changes which image is bootable, or what the name and description of an image
 are.

-
+.PP

 If neither an image nor any flags other than \fB--check\fR are specified, some
 basic information about the WIM archive as well as information about the images
 contained in it will be printed.  If an image is specified by \fIIMAGE\fR (as a
 1-based image index or an image name), the printed information is restricted to
 that concerning the specified image.
 If neither an image nor any flags other than \fB--check\fR are specified, some
 basic information about the WIM archive as well as information about the images
 contained in it will be printed.  If an image is specified by \fIIMAGE\fR (as a
 1-based image index or an image name), the printed information is restricted to
 that concerning the specified image.

-
+.PP

 Changes to the WIM are made if \fINEW_NAME\fR and/or \fB--boot\fR are specified.
 \fINEW_NAME\fR is taken to be the new name of the image specified by \fIIMAGE\fR
 while \fINEW_DESC\fR is taken to be its new description.  If \fINEW_DESC\fR is
 not specified, the image's description is unchanged.
 Changes to the WIM are made if \fINEW_NAME\fR and/or \fB--boot\fR are specified.
 \fINEW_NAME\fR is taken to be the new name of the image specified by \fIIMAGE\fR
 while \fINEW_DESC\fR is taken to be its new description.  If \fINEW_DESC\fR is
 not specified, the image's description is unchanged.

-
+.PP

 \fB@IMAGEX_PROGNAME@ info\fR does not support modifying a split WIM, although you may
 display information about one.
 \fB@IMAGEX_PROGNAME@ info\fR does not support modifying a split WIM, although you may
 display information about one.

-

 .SH OPTIONS
 .TP 6
 \fB--boot\fR
 .SH OPTIONS
 .TP 6
 \fB--boot\fR


@@ -64,4 +58,3 @@ Prints the raw XML data from the WIM.  Note: the XML data will be encoded using
 UTF-16LE, and it will begin with a byte-order mark.
 .SH SEE ALSO
 .BR @IMAGEX_PROGNAME@ (1)
 UTF-16LE, and it will begin with a byte-order mark.
 .SH SEE ALSO
 .BR @IMAGEX_PROGNAME@ (1)

-

diff --git a/doc/imagex-join.1.in b/doc/imagex-join.1.in
index 5d92cdd1add8b772679032a492bca7c54eda7252..ba90812cb9e73397ddfed442b424dfa33e1c5399 100644 (file)
--- a/doc/imagex-join.1.in
+++ b/doc/imagex-join.1.in
@@ -1,17 +1,13 @@
 .TH IMAGEX "1" "May 2013" "@IMAGEX_PROGNAME@ @VERSION@" "User Commands"
 .SH NAME
 @IMAGEX_PROGNAME@-join \- Join split WIMs into a standalone one-part WIM
 .TH IMAGEX "1" "May 2013" "@IMAGEX_PROGNAME@ @VERSION@" "User Commands"
 .SH NAME
 @IMAGEX_PROGNAME@-join \- Join split WIMs into a standalone one-part WIM

-

 .SH SYNOPSIS
 \fB@IMAGEX_PROGNAME@ join\fR [\fIOPTION\fR...] \fIOUT_WIMFILE\fR \fISPLIT_WIM\fR...
 .SH SYNOPSIS
 \fB@IMAGEX_PROGNAME@ join\fR [\fIOPTION\fR...] \fIOUT_WIMFILE\fR \fISPLIT_WIM\fR...

-

 .SH DESCRIPTION
 .SH DESCRIPTION

-.PP

 Joins the \fISPLIT_WIMs\fR into a standalone one-part WIM \fIOUT_WIMFILE\fR.
 Joins the \fISPLIT_WIMs\fR into a standalone one-part WIM \fIOUT_WIMFILE\fR.

-
+.PP

 All parts of the split WIM  must be specified.  You probably want to do so using
 a shell wildcard.
 All parts of the split WIM  must be specified.  You probably want to do so using
 a shell wildcard.

-

 .SH OPTIONS
 .TP 6
 \fB--check\fR
 .SH OPTIONS
 .TP 6
 \fB--check\fR


@@ -19,7 +15,6 @@ When reading each \fISPLIT_WIM\fR, verify its integrity if the integrity table i
 present; additionally, when writing \fIOUT_WIMFILE\fR,
 write an integrity table.  If this option is not specified, no integrity table
 is included in the new WIM file, even if there was one before.
 present; additionally, when writing \fIOUT_WIMFILE\fR,
 write an integrity table.  If this option is not specified, no integrity table
 is included in the new WIM file, even if there was one before.

-

 .SH EXAMPLES
 Join a split WIM, with the parts named `windows*.swm' where the * is anything
 (usually the number of the part, except for the first part which may have no
 .SH EXAMPLES
 Join a split WIM, with the parts named `windows*.swm' where the * is anything
 (usually the number of the part, except for the first part which may have no


@@ -28,16 +23,12 @@ number), and write the joined WIM to the file `windows.wim'.
 .PP
 @IMAGEX_PROGNAME@ join windows.wim windows*.swm
 .RE
 .PP
 @IMAGEX_PROGNAME@ join windows.wim windows*.swm
 .RE

-

 .SH NOTES
 \fB@IMAGEX_PROGNAME@ join\fR is roughly equivalent to:
 .RS
 .PP
 \fB@IMAGEX_PROGNAME@ export\fR \fISWM_PART_1\fR --ref="\fISWM_GLOB\fR" [--check] all \fIOUT_WIMFILE\fR
 .RE
 .SH NOTES
 \fB@IMAGEX_PROGNAME@ join\fR is roughly equivalent to:
 .RS
 .PP
 \fB@IMAGEX_PROGNAME@ export\fR \fISWM_PART_1\fR --ref="\fISWM_GLOB\fR" [--check] all \fIOUT_WIMFILE\fR
 .RE

-.PP
-
-

 .SH SEE ALSO
 .BR @IMAGEX_PROGNAME@ (1)
 .BR @IMAGEX_PROGNAME@-export (1)
 .SH SEE ALSO
 .BR @IMAGEX_PROGNAME@ (1)
 .BR @IMAGEX_PROGNAME@-export (1)

diff --git a/doc/imagex-mount.1.in b/doc/imagex-mount.1.in
index 9a60c650bf11e0ef01e71cde8b729a9e66e4ded8..da3e97fbfeb45dd0d71f163ba531b860e279432e 100644 (file)
--- a/doc/imagex-mount.1.in
+++ b/doc/imagex-mount.1.in
@@ -1,37 +1,31 @@
 .TH IMAGEX "1" "May 2013" "@IMAGEX_PROGNAME@ @VERSION@" "User Commands"
 .SH NAME
 @IMAGEX_PROGNAME@-mount, @IMAGEX_PROGNAME@-mountrw, @IMAGEX_PROGNAME@-unmount \- Mount and unmount an image from a WIM archive
 .TH IMAGEX "1" "May 2013" "@IMAGEX_PROGNAME@ @VERSION@" "User Commands"
 .SH NAME
 @IMAGEX_PROGNAME@-mount, @IMAGEX_PROGNAME@-mountrw, @IMAGEX_PROGNAME@-unmount \- Mount and unmount an image from a WIM archive

-

 .SH SYNOPSIS
 \fB@IMAGEX_PROGNAME@ mount\fR \fIWIMFILE\fR [\fIIMAGE\fR] \fIDIRECTORY\fR [\fIOPTION\fR...]
 .br
 \fB@IMAGEX_PROGNAME@ mountrw\fR \fIWIMFILE\fR [\fIIMAGE\fR] \fIDIRECTORY\fR [\fIOPTION\fR...]
 .br
 \fB@IMAGEX_PROGNAME@ unmount\fR \fIDIRECTORY\fR [--commit] [--check] [--rebuild]
 .SH SYNOPSIS
 \fB@IMAGEX_PROGNAME@ mount\fR \fIWIMFILE\fR [\fIIMAGE\fR] \fIDIRECTORY\fR [\fIOPTION\fR...]
 .br
 \fB@IMAGEX_PROGNAME@ mountrw\fR \fIWIMFILE\fR [\fIIMAGE\fR] \fIDIRECTORY\fR [\fIOPTION\fR...]
 .br
 \fB@IMAGEX_PROGNAME@ unmount\fR \fIDIRECTORY\fR [--commit] [--check] [--rebuild]

-

 .SH DESCRIPTION
 .SH DESCRIPTION

+The \fB@IMAGEX_PROGNAME@ mount\fR and \fB@IMAGEX_PROGNAME@ mountrw\fR commands
+will mount the image in the Windows Imaging (WIM) file \fIWIMFILE\fR specified
+by \fIIMAGE\fR on the directory \fIDIRECTORY\fR using FUSE (Filesystem in
+Userspace).  \fB@IMAGEX_PROGNAME@ mount\fR will mount the image read-only, while
+\fB@IMAGEX_PROGNAME@ mountrw\fR will mount the image read-write.

 .PP
 .PP

-The \fB@IMAGEX_PROGNAME@ mount\fR and \fB@IMAGEX_PROGNAME@ mountrw\fR commands will mount the image in
-the Windows Imaging (WIM) file \fIWIMFILE\fR specified by \fIIMAGE\fR on the
-directory \fIDIRECTORY\fR using FUSE (Filesystem in Userspace).  \fB@IMAGEX_PROGNAME@
-mount\fR will mount the image read-only, while \fB@IMAGEX_PROGNAME@ mountrw\fR will mount
-the image read-write.
-

 \fIIMAGE\fR may be a 1-based index of the image in the WIM to mount, or it may
 be the name of an image in the WIM.  Use the \fB@IMAGEX_PROGNAME@ info\fR (1)
 command to see the available images in the WIM.  \fIIMAGE\fR may be omitted if
 \fIWIMFILE\fR contains only one image.
 \fIIMAGE\fR may be a 1-based index of the image in the WIM to mount, or it may
 be the name of an image in the WIM.  Use the \fB@IMAGEX_PROGNAME@ info\fR (1)
 command to see the available images in the WIM.  \fIIMAGE\fR may be omitted if
 \fIWIMFILE\fR contains only one image.

-
-
+.PP

 The WIM image can be unmounted using the \fB@IMAGEX_PROGNAME@ unmount\fR command.  Changes
 made to a WIM mounted read-write will be discarded unless the \fB--commit\fR
 flag is provided to \fB@IMAGEX_PROGNAME@ unmount\fR.
 The WIM image can be unmounted using the \fB@IMAGEX_PROGNAME@ unmount\fR command.  Changes
 made to a WIM mounted read-write will be discarded unless the \fB--commit\fR
 flag is provided to \fB@IMAGEX_PROGNAME@ unmount\fR.

-

 .SH SPLIT WIMS
 .SH SPLIT WIMS

-

 You may use \fB@IMAGEX_PROGNAME@ mount\fR to mount an image from a split WIM read-only.
 However, you may not mount an image from a split WIM read-write.
 You may use \fB@IMAGEX_PROGNAME@ mount\fR to mount an image from a split WIM read-only.
 However, you may not mount an image from a split WIM read-write.

-
+.PP

 The \fIWIMFILE\fR argument is used to specify the first part of the split WIM, and
 the \fB--refs\fR="\fIGLOB\fR" option is used to provide a shell-style file glob
 that specifies the additional parts of the split WIM.  \fIGLOB\fR is expected to
 The \fIWIMFILE\fR argument is used to specify the first part of the split WIM, and
 the \fB--refs\fR="\fIGLOB\fR" option is used to provide a shell-style file glob
 that specifies the additional parts of the split WIM.  \fIGLOB\fR is expected to


@@ -40,9 +34,8 @@ is protected against shell expansion.  \fIGLOB\fR must expand to all parts of
 the split WIM, except optionally the first part which may either omitted or
 included in the glob (but the first part MUST be specified as \fIWIMFILE\fR as
 well).
 the split WIM, except optionally the first part which may either omitted or
 included in the glob (but the first part MUST be specified as \fIWIMFILE\fR as
 well).

-
+.PP

 Here's an example.  The names for the split WIMs usually go something like:
 Here's an example.  The names for the split WIMs usually go something like:

-

 .RS
 .PP
 .nf
 .RS
 .PP
 .nf


@@ -52,23 +45,22 @@ mywim3.swm
 mywim4.swm
 mywim5.swm
 .RE
 mywim4.swm
 mywim5.swm
 .RE

-
+.PP

 To mount the first image of this split WIM to the directory "dir", we would do:
 .PP
 .RS
 @IMAGEX_PROGNAME@ mount mywim.swm 1 dir --ref="mywim*.swm"
 .RE
 .PP
 To mount the first image of this split WIM to the directory "dir", we would do:
 .PP
 .RS
 @IMAGEX_PROGNAME@ mount mywim.swm 1 dir --ref="mywim*.swm"
 .RE
 .PP

-

 .SH NOTES
 .SH NOTES

-
-If wimlib was configured using the \fB--without-fuse\fR flag, then the \fB@IMAGEX_PROGNAME@
-mount\fR, \fB@IMAGEX_PROGNAME@ mountrw\fR, and \fB@IMAGEX_PROGNAME@ unmount\fR commands will not work.
-Also, these commands are not available in the Windows builds of wimlib.
-
+If wimlib was configured using the \fB--without-fuse\fR flag, then the
+\fB@IMAGEX_PROGNAME@ mount\fR, \fB@IMAGEX_PROGNAME@ mountrw\fR, and
+\fB@IMAGEX_PROGNAME@ unmount\fR commands will not work.  Also, these commands
+are not available in the Windows builds of wimlib.
+.PP

 You can mount multiple images from a WIM file read-only at the same time, but
 you can only mount one image at a time from a WIM read-write.
 You can mount multiple images from a WIM file read-only at the same time, but
 you can only mount one image at a time from a WIM read-write.

-
+.PP

 All files in the mounted WIM will be accessible regardless of whether there is a
 security descriptor in the WIM associated with the file or not.  New files or
 directories created in a read-write mounted WIM will be created with no security
 All files in the mounted WIM will be accessible regardless of whether there is a
 security descriptor in the WIM associated with the file or not.  New files or
 directories created in a read-write mounted WIM will be created with no security


@@ -76,17 +68,15 @@ descriptor.  Although there is support for accessing named data streams (see the
 \fB--streams-interface\fR option), it is currently not possible
 to set or get DOS names, file attributes, or security
 descriptors in a mounted WIM.
 \fB--streams-interface\fR option), it is currently not possible
 to set or get DOS names, file attributes, or security
 descriptors in a mounted WIM.

-
+.PP

 By default, changes to a read-write WIM are made in-place by appending to the
 WIM.  This is nice for big WIM files, since the entire file doesn't have to be
 rebuilt to make a small change.  But, if you are making many changes to a
 read-write mounted WIM, especially deleting large files, it is suggested to
 provide the \fB--rebuild\fR option to \fB@IMAGEX_PROGNAME@ unmount\fR to force the WIM to
 be rebuilt, or else run \fB@IMAGEX_PROGNAME@ optimize\fR on the WIM afterwards.
 By default, changes to a read-write WIM are made in-place by appending to the
 WIM.  This is nice for big WIM files, since the entire file doesn't have to be
 rebuilt to make a small change.  But, if you are making many changes to a
 read-write mounted WIM, especially deleting large files, it is suggested to
 provide the \fB--rebuild\fR option to \fB@IMAGEX_PROGNAME@ unmount\fR to force the WIM to
 be rebuilt, or else run \fB@IMAGEX_PROGNAME@ optimize\fR on the WIM afterwards.

-

 .SH MOUNT OPTIONS
 .SH MOUNT OPTIONS

-
-.TP
+.TP 6

 \fB--check\fR
 When reading the WIM, verify its integrity if it contains an integrity table.
 .TP
 \fB--check\fR
 When reading the WIM, verify its integrity if it contains an integrity table.
 .TP


@@ -94,19 +84,19 @@ When reading the WIM, verify its integrity if it contains an integrity table.
 This option is inspired by the ntfs-3g filesystem driver (see \fBntfs-3g\fR
 (8)).  It controls how alternate data streams, or named data streams, in WIM
 files are made available.
 This option is inspired by the ntfs-3g filesystem driver (see \fBntfs-3g\fR
 (8)).  It controls how alternate data streams, or named data streams, in WIM
 files are made available.

-
+.IP ""

 If "none", it will be impossible to read or write the named data streams.
 If "none", it will be impossible to read or write the named data streams.

-
+.IP ""

 If "xattr" (default), named data streams will be accessible through extended
 file attributes, unless this support was disabled when compiling wimlib.  The
 named data streams may be accessed through extended attributes named "user.*",
 where the * is the name of the named data stream.  See \fBsetfattr\fR (1) and
 \fBgetfattr\fR (1).
 If "xattr" (default), named data streams will be accessible through extended
 file attributes, unless this support was disabled when compiling wimlib.  The
 named data streams may be accessed through extended attributes named "user.*",
 where the * is the name of the named data stream.  See \fBsetfattr\fR (1) and
 \fBgetfattr\fR (1).

-
+.IP ""

 If "windows", the named data streams will be accessible by specifying the
 filename, then a colon, then the name of the named data stream; for example,
 "myfile:mystream".
 If "windows", the named data streams will be accessible by specifying the
 filename, then a colon, then the name of the named data stream; for example,
 "myfile:mystream".

-
+.IP ""

 Please note that named data streams are a somewhat obscure NTFS feature that
 aren't actually used much, even though they complicate the WIM file format
 considerably.  Normally, all you care about is the default or "unnamed" data
 Please note that named data streams are a somewhat obscure NTFS feature that
 aren't actually used much, even though they complicate the WIM file format
 considerably.  Normally, all you care about is the default or "unnamed" data


@@ -142,9 +132,7 @@ tools and functions.
 Pass the \fBallow_other\fR option to the FUSE mount.  See \fBmount.fuse\fR (8).
 Note: to do this is a non-root user, \fBuser_allow_other\fR needs to be
 specified in /etc/fuse.conf (with the FUSE implementation on Linux, at least).
 Pass the \fBallow_other\fR option to the FUSE mount.  See \fBmount.fuse\fR (8).
 Note: to do this is a non-root user, \fBuser_allow_other\fR needs to be
 specified in /etc/fuse.conf (with the FUSE implementation on Linux, at least).

-

 .SH UNMOUNT OPTIONS
 .SH UNMOUNT OPTIONS

-

 .TP
 \fB--commit\fR
 Update the WIM file with the changes that have been made.  Has no effect if the
 .TP
 \fB--commit\fR
 Update the WIM file with the changes that have been made.  Has no effect if the


@@ -161,9 +149,7 @@ otherwise be left as a hole in the WIM.  Even more space will be saved if the
 read-write mount resulted in streams being deleted from the WIM.  Also see
 \fB@IMAGEX_PROGNAME@ optimize\fR.  Has no effect if the mount is read-only or if
 \fB--commit\fR was not specified.
 read-write mount resulted in streams being deleted from the WIM.  Also see
 \fB@IMAGEX_PROGNAME@ optimize\fR.  Has no effect if the mount is read-only or if
 \fB--commit\fR was not specified.

-

 .SH IMPLEMENTATION DETAILS
 .SH IMPLEMENTATION DETAILS

-

 Since a WIM is an archive and not a filesystem, \fB@IMAGEX_PROGNAME@ mountrw\fR creates a
 temporary staging directory to contain files that are created or modified.  This
 directory is located in the same directory as \fIWIMFILE\fR by default, but the
 Since a WIM is an archive and not a filesystem, \fB@IMAGEX_PROGNAME@ mountrw\fR creates a
 temporary staging directory to contain files that are created or modified.  This
 directory is located in the same directory as \fIWIMFILE\fR by default, but the


@@ -171,14 +157,12 @@ location can be set using the \fB--staging-dir\fR option.  When the filesystem
 is unmounted with \fB--commit\fR, the WIM is modified in-place (or rebuild
 completely with \fB--rebuild\fR), merging in the staging files as needed.  Then,
 the temporary staging directory is deleted.
 is unmounted with \fB--commit\fR, the WIM is modified in-place (or rebuild
 completely with \fB--rebuild\fR), merging in the staging files as needed.  Then,
 the temporary staging directory is deleted.

-
+.PP

 \fB@IMAGEX_PROGNAME@ unmount\fR runs in a separate process from the process that previously
 ran \fB@IMAGEX_PROGNAME@ mount\fR, and these two processes communicate using POSIX message
 queues.  See \fIsrc/mount_image.c\fR in the sources for details.  Note: As of
 wimlib v1.2.1, \fB@IMAGEX_PROGNAME@ unmount\fR correctly fails with an error within a
 reasonable amount of time (1 second) if the filesystem daemon is abnormally
 terminated.
 \fB@IMAGEX_PROGNAME@ unmount\fR runs in a separate process from the process that previously
 ran \fB@IMAGEX_PROGNAME@ mount\fR, and these two processes communicate using POSIX message
 queues.  See \fIsrc/mount_image.c\fR in the sources for details.  Note: As of
 wimlib v1.2.1, \fB@IMAGEX_PROGNAME@ unmount\fR correctly fails with an error within a
 reasonable amount of time (1 second) if the filesystem daemon is abnormally
 terminated.

-

 .SH SEE ALSO
 .BR @IMAGEX_PROGNAME@ (1)
 .SH SEE ALSO
 .BR @IMAGEX_PROGNAME@ (1)

-

diff --git a/doc/imagex-optimize.1.in b/doc/imagex-optimize.1.in
index 1d0875e7f696dfd21e613ff49342a36610d68baa..6033dfcc4d62e7394e8437a24e3306d34b3a8f6d 100644 (file)
--- a/doc/imagex-optimize.1.in
+++ b/doc/imagex-optimize.1.in
@@ -1,19 +1,15 @@
 .TH IMAGEX "1" "May 2013" "@IMAGEX_PROGNAME@ @VERSION@" "User Commands"
 .SH NAME
 @IMAGEX_PROGNAME@-optimize \- Optimize a WIM archive
 .TH IMAGEX "1" "May 2013" "@IMAGEX_PROGNAME@ @VERSION@" "User Commands"
 .SH NAME
 @IMAGEX_PROGNAME@-optimize \- Optimize a WIM archive

-

 .SH SYNOPSIS
 \fB@IMAGEX_PROGNAME@ optimize\fR \fIWIMFILE\fR [--check] [--recompress]
 .SH SYNOPSIS
 \fB@IMAGEX_PROGNAME@ optimize\fR \fIWIMFILE\fR [--check] [--recompress]

-

 .SH DESCRIPTION
 .SH DESCRIPTION

-.PP

 \fB@IMAGEX_PROGNAME@ optimize\fR will rebuild the stand-alone WIM \fIWIMFILE\fR.  The new
 WIM is written to a temporary file, and it is renamed to the original file when
 it's ready.  This action will remove any holes that have been left as a result
 of appending images, so the new WIM may be slightly smaller than the old WIM.
 In addition, some errors in the original WIM may be fixed by re-writing it
 (although most cannot).
 \fB@IMAGEX_PROGNAME@ optimize\fR will rebuild the stand-alone WIM \fIWIMFILE\fR.  The new
 WIM is written to a temporary file, and it is renamed to the original file when
 it's ready.  This action will remove any holes that have been left as a result
 of appending images, so the new WIM may be slightly smaller than the old WIM.
 In addition, some errors in the original WIM may be fixed by re-writing it
 (although most cannot).

-

 .SH OPTIONS
 .TP 6
 \fB--check\fR
 .SH OPTIONS
 .TP 6
 \fB--check\fR


@@ -29,7 +25,7 @@ uncompressed, but it may result in a better compression ratio if wimlib can do a
 better job than the program that wrote the original file.  A side effect of this
 is that every stream in the original WIM will be checksummed, so this can help
 verify that the WIM is intact (equivalent to applying all the images from it).
 better job than the program that wrote the original file.  A side effect of this
 is that every stream in the original WIM will be checksummed, so this can help
 verify that the WIM is intact (equivalent to applying all the images from it).

-
+.IP ""

 Note: as mentioned in the README, wimlib generally provides a slightly better
 XPRESS compression ratio than Microsoft's software, while it generally provides
 a slightly worse LZX compression ratio than Microsoft's software.  So, you may
 Note: as mentioned in the README, wimlib generally provides a slightly better
 XPRESS compression ratio than Microsoft's software, while it generally provides
 a slightly worse LZX compression ratio than Microsoft's software.  So, you may


@@ -40,19 +36,15 @@ created on Windows with Microsoft's ImageX.
 Number of threads to use for compressing data.  Default: autodetect (number of
 processors).  This parameter is only meaningful when \fB--recompress\fR is also
 specified.
 Number of threads to use for compressing data.  Default: autodetect (number of
 processors).  This parameter is only meaningful when \fB--recompress\fR is also
 specified.

-

 .SH NOTES
 .SH NOTES

-

 \fB@IMAGEX_PROGNAME@ optimize\fR does not support split WIMs.
 \fB@IMAGEX_PROGNAME@ optimize\fR does not support split WIMs.

-
+.PP

 \fB@IMAGEX_PROGNAME@ optimize\fR is roughly equivalent to:
 .RS
 .PP
 \fB@IMAGEX_PROGNAME@ export\fR \fIWIMFILE\fR all tmp.wim [--check] && mv tmp.wim \fIWIMFILE\fR
 .RE
 .PP
 \fB@IMAGEX_PROGNAME@ optimize\fR is roughly equivalent to:
 .RS
 .PP
 \fB@IMAGEX_PROGNAME@ export\fR \fIWIMFILE\fR all tmp.wim [--check] && mv tmp.wim \fIWIMFILE\fR
 .RE
 .PP

-

 .SH SEE ALSO
 .BR @IMAGEX_PROGNAME@ (1)
 .BR @IMAGEX_PROGNAME@-export (1)
 .SH SEE ALSO
 .BR @IMAGEX_PROGNAME@ (1)
 .BR @IMAGEX_PROGNAME@-export (1)

-

diff --git a/doc/imagex-split.1.in b/doc/imagex-split.1.in
index 6da46bbbbeb9538ee2082b851dc9448d6d213307..6baa6f4f5ce4a5b3d3efef02a5d60aa63aa7a210 100644 (file)
--- a/doc/imagex-split.1.in
+++ b/doc/imagex-split.1.in
@@ -1,17 +1,12 @@
 .TH IMAGEX "1" "May 2013" "@IMAGEX_PROGNAME@ @VERSION@" "User Commands"
 .SH NAME
 @IMAGEX_PROGNAME@-split \- Split a WIM into multiple parts
 .TH IMAGEX "1" "May 2013" "@IMAGEX_PROGNAME@ @VERSION@" "User Commands"
 .SH NAME
 @IMAGEX_PROGNAME@-split \- Split a WIM into multiple parts

-

 .SH SYNOPSIS
 \fB@IMAGEX_PROGNAME@ split\fR \fIWIMFILE\fR \fISPLIT_WIMFILE\fR \fIPART_SIZE\fR [\fIOPTION...\fR]
 .SH SYNOPSIS
 \fB@IMAGEX_PROGNAME@ split\fR \fIWIMFILE\fR \fISPLIT_WIMFILE\fR \fIPART_SIZE\fR [\fIOPTION...\fR]

-

 .SH DESCRIPTION
 .SH DESCRIPTION

-.PP
-

 Splits \fIWIMFILE\fR into parts with size at most \fIPART_SIZE\fR mebibytes,
 with the first part having the name \fISPLIT_WIMFILE\fR and the other parts
 having names numbered in order of the parts.
 Splits \fIWIMFILE\fR into parts with size at most \fIPART_SIZE\fR mebibytes,
 with the first part having the name \fISPLIT_WIMFILE\fR and the other parts
 having names numbered in order of the parts.

-

 .SH OPTIONS
 .TP 6
 \fB--check\fR
 .SH OPTIONS
 .TP 6
 \fB--check\fR


@@ -19,7 +14,6 @@ When reading \fIWIMFILE\fR, verify its integrity if the integrity table is
 present; additionally, when writing each \fISPLIT_WIMFILE\fR, write an integrity
 table.  If this option is not specified, no integrity tables are included in the
 split WIM files, even if there was one in the original WIM.
 present; additionally, when writing each \fISPLIT_WIMFILE\fR, write an integrity
 table.  If this option is not specified, no integrity tables are included in the
 split WIM files, even if there was one in the original WIM.

-

 .SH EXAMPLES
 Splits the WIM 'windows.wim' into 'windows.swm', 'windows2.swm', 'windows3.swm',
 etc. where each part is at most 100 MiB:
 .SH EXAMPLES
 Splits the WIM 'windows.wim' into 'windows.swm', 'windows2.swm', 'windows3.swm',
 etc. where each part is at most 100 MiB:


@@ -27,9 +21,7 @@ etc. where each part is at most 100 MiB:
 .PP
 @IMAGEX_PROGNAME@ split windows.wim windows.swm 100
 .RE
 .PP
 @IMAGEX_PROGNAME@ split windows.wim windows.swm 100
 .RE

-

 .SH LIMITATIONS
 .SH LIMITATIONS

-

 It it possible for the size of the parts to exceed the \fIPART_SIZE\fR given.
 This is impossible to avoid and Microsoft's program has this problem as well
 because the WIM file format provides no way to divide a single file resource in
 It it possible for the size of the parts to exceed the \fIPART_SIZE\fR given.
 This is impossible to avoid and Microsoft's program has this problem as well
 because the WIM file format provides no way to divide a single file resource in


@@ -37,6 +29,5 @@ the WIM among multiple split WIM parts.  So if you, for example, have a file
 inside the WIM that is 100 MiB, then an uncompressed split WIM will have at
 least one part that is 100 MiB in size to contain that file.  However, if the
 WIM resources are compressed then less space would be needed.
 inside the WIM that is 100 MiB, then an uncompressed split WIM will have at
 least one part that is 100 MiB in size to contain that file.  However, if the
 WIM resources are compressed then less space would be needed.

-

 .SH SEE ALSO
 .BR @IMAGEX_PROGNAME@ (1)
 .SH SEE ALSO
 .BR @IMAGEX_PROGNAME@ (1)

diff --git a/doc/imagex-update.1.in b/doc/imagex-update.1.in
index 6bb8382a2e7fe12219a74b1b9b71435dbe7fb655..bd67670d8fab3bd9bd2050676a16c4bbdaa9f901 100644 (file)
--- a/doc/imagex-update.1.in
+++ b/doc/imagex-update.1.in
@@ -1,32 +1,25 @@
 .TH IMAGEX "1" "May 2013" "@IMAGEX_PROGNAME@ @VERSION@" "User Commands"
 .SH NAME
 @IMAGEX_PROGNAME@-update \- Update a WIM image
 .TH IMAGEX "1" "May 2013" "@IMAGEX_PROGNAME@ @VERSION@" "User Commands"
 .SH NAME
 @IMAGEX_PROGNAME@-update \- Update a WIM image

-

 .SH SYNOPSIS
 \fB@IMAGEX_PROGNAME@ update\fR \fIWIMFILE\fR [\fIIMAGE\fR] [\fIOPTION\fR...] < \fICMDFILE\fR
 .SH SYNOPSIS
 \fB@IMAGEX_PROGNAME@ update\fR \fIWIMFILE\fR [\fIIMAGE\fR] [\fIOPTION\fR...] < \fICMDFILE\fR

-

 .SH DESCRIPTION
 .SH DESCRIPTION

-.PP
-

 \fB@IMAGEX_PROGNAME@ update\fR modifies the specified \fIIMAGE\fR in the Windows
 Imaging (WIM) file \fIWIMFILE\fR by adding, deleting, or renaming files or
 directories in it.
 \fB@IMAGEX_PROGNAME@ update\fR modifies the specified \fIIMAGE\fR in the Windows
 Imaging (WIM) file \fIWIMFILE\fR by adding, deleting, or renaming files or
 directories in it.

-
+.PP

 \fIIMAGE\fR specifies the image in \fIWIMFILE\fR to update.  It may be a 1-based
 index of an image in the WIM or the name of an image in the WIM.  Use the
 \fB@IMAGEX_PROGNAME@ info\fR (1) command to list the images a WIM file contains.
 \fIIMAGE\fR may be omitted if \fIWIMFILE\fR contains only one image.
 \fIIMAGE\fR specifies the image in \fIWIMFILE\fR to update.  It may be a 1-based
 index of an image in the WIM or the name of an image in the WIM.  Use the
 \fB@IMAGEX_PROGNAME@ info\fR (1) command to list the images a WIM file contains.
 \fIIMAGE\fR may be omitted if \fIWIMFILE\fR contains only one image.

-
+.PP

 The modifications to perform on the WIM image are specified as a sequence of
 commands, one per line, read in a text file from standard input.  It is
 recommended that standard input be redirected from a file (\fICMDFILE\fR), as
 shown above, rather than typing in commands interactively.
 The modifications to perform on the WIM image are specified as a sequence of
 commands, one per line, read in a text file from standard input.  It is
 recommended that standard input be redirected from a file (\fICMDFILE\fR), as
 shown above, rather than typing in commands interactively.

-

 .SH AVAILABLE COMMANDS
 .SH AVAILABLE COMMANDS

-

 This section documents the commands that may appear in the \fICMDFILE\fR
 described above.
 This section documents the commands that may appear in the \fICMDFILE\fR
 described above.

-

 .SS \fBadd\fR [\fIOPTION\fR...] \fISOURCE\fR \fIDESTINATION\fR
 Add a file or directory tree to the WIM image.  \fISOURCE\fR must specify the
 path to a file or directory on your filesystem.  \fIDESTINATION\fR must specify
 .SS \fBadd\fR [\fIOPTION\fR...] \fISOURCE\fR \fIDESTINATION\fR
 Add a file or directory tree to the WIM image.  \fISOURCE\fR must specify the
 path to a file or directory on your filesystem.  \fIDESTINATION\fR must specify


@@ -36,9 +29,8 @@ if it is a directory; this feature can be used to add multiple files to an
 existing directory in the WIM image in one command.  If \fIDESTINATION\fR does
 not exist in the WIM image, then any prerequisite directories are created as
 needed to add the \fISOURCE\fR at that location.
 existing directory in the WIM image in one command.  If \fIDESTINATION\fR does
 not exist in the WIM image, then any prerequisite directories are created as
 needed to add the \fISOURCE\fR at that location.

-
+.PP

 The available options for the \fBadd\fR command are:
 The available options for the \fBadd\fR command are:

-

 .TP 6
 \fB--verbose\fR
 Print the names of files as they are captured.
 .TP 6
 \fB--verbose\fR
 Print the names of files as they are captured.


@@ -66,13 +58,11 @@ possible without always requiring Administrator privileges.  However, if you
 desire that all security descriptors be captured exactly, you may wish to
 provide this option, although the Administrator should have permission to read
 everything anyway.
 desire that all security descriptors be captured exactly, you may wish to
 provide this option, although the Administrator should have permission to read
 everything anyway.

-

 .SS \fBdelete\fR [\fIOPTION\fR...] \fIPATH\fR
 Deletes a file or directory tree from the WIM image.  \fIPATH\fR must specify the
 path inside the WIM image of the file or directory tree to delete.
 .SS \fBdelete\fR [\fIOPTION\fR...] \fIPATH\fR
 Deletes a file or directory tree from the WIM image.  \fIPATH\fR must specify the
 path inside the WIM image of the file or directory tree to delete.

-
+.PP

 The available options for the \fBdelete\fR command are:
 The available options for the \fBdelete\fR command are:

-

 .TP 6
 \fB--force\fR
 Do not issue an error if the path to delete does not exist.
 .TP 6
 \fB--force\fR
 Do not issue an error if the path to delete does not exist.


@@ -80,7 +70,6 @@ Do not issue an error if the path to delete does not exist.
 \fB--recursive\fR
 Delete the file or directory tree recursively; if not specified, an error is
 issued if the path to delete is a directory.
 \fB--recursive\fR
 Delete the file or directory tree recursively; if not specified, an error is
 issued if the path to delete is a directory.

-

 .SS \fBrename\fR \fIOLD_PATH\fR \fINEW_PATH\fR
 Renames a file or directory tree inside the WIM image.  \fIOLD_PATH\fR must
 specify the old path of the file or directory tree inside the WIM image, and
 .SS \fBrename\fR \fIOLD_PATH\fR \fINEW_PATH\fR
 Renames a file or directory tree inside the WIM image.  \fIOLD_PATH\fR must
 specify the old path of the file or directory tree inside the WIM image, and


@@ -89,14 +78,11 @@ command follows the semantics of the POSIX \fBrename\fR (3) function; in
 particular, a pre-existing file at \fINEW_PATH\fR will be deleted if present,
 except in certain cases such as attempting to rename a directory to a
 non-directory, which is not allowed.
 particular, a pre-existing file at \fINEW_PATH\fR will be deleted if present,
 except in certain cases such as attempting to rename a directory to a
 non-directory, which is not allowed.

-
+.PP

 There are no options available for the \fBrename\fR command.
 There are no options available for the \fBrename\fR command.

-

 .SH OPTIONS
 .SH OPTIONS

-

 The following options are accepted on the command line by \fB@IMAGEX_PROGNAME@
 update\fR itself:
 The following options are accepted on the command line by \fB@IMAGEX_PROGNAME@
 update\fR itself:

-

 .TP 6
 \fB--verbose\fR
 Use \fB--verbose\fR for all \fBadd\fR commands.
 .TP 6
 \fB--verbose\fR
 Use \fB--verbose\fR for all \fBadd\fR commands.


@@ -138,47 +124,43 @@ Rebuild the entire WIM rather than appending the updated data to the end of it.
 Rebuilding the WIM is slower, but will save a little bit of space that would
 otherwise be left as a hole in the WIM.  Also see
 \fB@IMAGEX_PROGNAME@-optimize\fR (1).
 Rebuilding the WIM is slower, but will save a little bit of space that would
 otherwise be left as a hole in the WIM.  Also see
 \fB@IMAGEX_PROGNAME@-optimize\fR (1).

-

 .SH NOTES
 .SH NOTES

-

 \fB@IMAGEX_PROGNAME@ update\fR is partly redundant with \fB@IMAGEX_PROGNAME@
 mountrw\fR, since if a WIM image can be mounted read-write, then there
 theoretically is no need for \fB@IMAGEX_PROGNAME@ update\fR.  The main advantage
 of \fB@IMAGEX_PROGNAME@ update\fR is that it works on both UNIX and Windows,
 whereas \fB@IMAGEX_PROGNAME@ mountrw\fR only works on UNIX.
 \fB@IMAGEX_PROGNAME@ update\fR is partly redundant with \fB@IMAGEX_PROGNAME@
 mountrw\fR, since if a WIM image can be mounted read-write, then there
 theoretically is no need for \fB@IMAGEX_PROGNAME@ update\fR.  The main advantage
 of \fB@IMAGEX_PROGNAME@ update\fR is that it works on both UNIX and Windows,
 whereas \fB@IMAGEX_PROGNAME@ mountrw\fR only works on UNIX.

-
+.PP

 Symbolic links inside a WIM image are not dereferenced when being interpreted.
 So, for example, if you have a WIM image that contains a symbolic link
 "/Documents and Settings" -> "/Users" where "/Users" is a directory, then a
 subdirectory named "Public" in this directory must be specified as
 "/Users/Public" rather than "/Documents and Settings/Public".
 Symbolic links inside a WIM image are not dereferenced when being interpreted.
 So, for example, if you have a WIM image that contains a symbolic link
 "/Documents and Settings" -> "/Users" where "/Users" is a directory, then a
 subdirectory named "Public" in this directory must be specified as
 "/Users/Public" rather than "/Documents and Settings/Public".

-
+.PP

 All paths to files or directories within the WIM image must be specified
 relative to the root of the image.  However, the leading slash is optional, and
 both forward slashes and backslashes are accepted.
 All paths to files or directories within the WIM image must be specified
 relative to the root of the image.  However, the leading slash is optional, and
 both forward slashes and backslashes are accepted.

-
+.PP

 The command file (\fICMDFILE\fR) is parsed by \fB@IMAGEX_PROGNAME@ update\fR
 itself and not by the system shell.  Therefore, its syntax is limited.  However,
 comment lines beginning with '#' are allowed, and it is also possible to quote
 arguments with whitespace inside them.
 The command file (\fICMDFILE\fR) is parsed by \fB@IMAGEX_PROGNAME@ update\fR
 itself and not by the system shell.  Therefore, its syntax is limited.  However,
 comment lines beginning with '#' are allowed, and it is also possible to quote
 arguments with whitespace inside them.

-
+.PP

 On UNIX, you cannot use \fB@IMAGEX_PROGNAME@ update\fR to add files to an image
 directly from a NTFS volume using libntfs-3g, even though \fB@IMAGEX_PROGNAME@
 capture\fR supports capturing a full image this way.
 On UNIX, you cannot use \fB@IMAGEX_PROGNAME@ update\fR to add files to an image
 directly from a NTFS volume using libntfs-3g, even though \fB@IMAGEX_PROGNAME@
 capture\fR supports capturing a full image this way.

-
+.PP

 It is safe to abort an \fB@IMAGEX_PROGNAME@ update\fR command partway through;
 however, after doing this, it is recommended to run \fB@IMAGEX_PROGNAME@
 optimize\fR to remove any data that was appended to the physical WIM file but
 not yet incorporated into the structure of the WIM, unless \fB--rebuild\fR was
 specified, in which case you should delete the temporary file left over.
 It is safe to abort an \fB@IMAGEX_PROGNAME@ update\fR command partway through;
 however, after doing this, it is recommended to run \fB@IMAGEX_PROGNAME@
 optimize\fR to remove any data that was appended to the physical WIM file but
 not yet incorporated into the structure of the WIM, unless \fB--rebuild\fR was
 specified, in which case you should delete the temporary file left over.

-

 .SH EXAMPLES
 .SH EXAMPLES

-

 All the examples below show the update command file to be created as well as the
 \fB@IMAGEX_PROGNAME@ update\fR command to run to perform the updates.
 All the examples below show the update command file to be created as well as the
 \fB@IMAGEX_PROGNAME@ update\fR command to run to perform the updates.

-
+.PP

 Delete two files from a WIM image:
 Delete two files from a WIM image:

-
+.PP

 .RS
 \fIupdate_commands.txt\fR:
 .RS
 .RS
 \fIupdate_commands.txt\fR:
 .RS


@@ -189,16 +171,16 @@ delete /sources/setup.exe
 .fi
 .RE
 .RE
 .fi
 .RE
 .RE

-
+.PP

 .RS
 $ @IMAGEX_PROGNAME@ update boot.wim 2 < update_commands.txt
 .RE
 .RS
 $ @IMAGEX_PROGNAME@ update boot.wim 2 < update_commands.txt
 .RE

-
+.PP

 Add some files and directories to a WIM image.  Note that the first path of each
 \fBadd\fR command specifies the files to add, while the second path of each
 \fBadd\fR command specify the locations at which to to add them inside the WIM
 image:
 Add some files and directories to a WIM image.  Note that the first path of each
 \fBadd\fR command specifies the files to add, while the second path of each
 \fBadd\fR command specify the locations at which to to add them inside the WIM
 image:

-
+.PP

 .RS
 \fIupdate_commands.txt\fR:
 .RS
 .RS
 \fIupdate_commands.txt\fR:
 .RS


@@ -209,13 +191,13 @@ add somefile    /dir/file
 .fi
 .RE
 .RE
 .fi
 .RE
 .RE

-
+.PP

 .RS
 $ @IMAGEX_PROGNAME@ update boot.wim 2 < update_commands.txt
 .RE
 .RS
 $ @IMAGEX_PROGNAME@ update boot.wim 2 < update_commands.txt
 .RE

-
+.PP

 Rename a file inside a WIM image.
 Rename a file inside a WIM image.

-
+.PP

 .RS
 \fIupdate_commands.txt\fR:
 .RS
 .RS
 \fIupdate_commands.txt\fR:
 .RS


@@ -225,14 +207,14 @@ rename /dir_in_wim/oldfile.txt /dir_in_wim/newfile.txt
 .fi
 .RE
 .RE
 .fi
 .RE
 .RE

-
+.PP

 .RS
 $ @IMAGEX_PROGNAME@ update boot.wim 2 < update_commands.txt
 .RE
 .RS
 $ @IMAGEX_PROGNAME@ update boot.wim 2 < update_commands.txt
 .RE

-
+.PP

 Using additional features, such as comments, options, and overlays, and
 including an integrity table in the updated WIM:
 Using additional features, such as comments, options, and overlays, and
 including an integrity table in the updated WIM:

-
+.PP

 .RS
 \fIupdate_commands.txt\fR:
 .RS
 .RS
 \fIupdate_commands.txt\fR:
 .RS


@@ -261,11 +243,11 @@ delete --recursive /Users/Me/Documents/Junk
 .fi
 .RE
 .RE
 .fi
 .RE
 .RE

-
+.PP

 .RS
 $ @IMAGEX_PROGNAME@ update boot.wim 2 --check < update_commands.txt
 .RE
 .RS
 $ @IMAGEX_PROGNAME@ update boot.wim 2 --check < update_commands.txt
 .RE

-
+.PP

 .SH SEE ALSO
 .BR @IMAGEX_PROGNAME@ (1)
 .BR @IMAGEX_PROGNAME@-capture (1)
 .SH SEE ALSO
 .BR @IMAGEX_PROGNAME@ (1)
 .BR @IMAGEX_PROGNAME@-capture (1)

diff --git a/doc/imagex.1.in b/doc/imagex.1.in
index 2fa5013a701b6b61c09d0dedeecb21676984336b..6d0053ce6b9f427d9f8aacce162295696943a425 100644 (file)
--- a/doc/imagex.1.in
+++ b/doc/imagex.1.in
@@ -31,26 +31,21 @@
 \fB@IMAGEX_PROGNAME@ unmount\fR \fIarguments...\fR
 .br
 \fB@IMAGEX_PROGNAME@ update\fR \fIarguments...\fR
 \fB@IMAGEX_PROGNAME@ unmount\fR \fIarguments...\fR
 .br
 \fB@IMAGEX_PROGNAME@ update\fR \fIarguments...\fR

-

 .SH DESCRIPTION
 .SH DESCRIPTION

-\fB@IMAGEX_PROGNAME@\fR is able to deal with archives in the Windows Imaging Format (.wim
-files). Its interface is meant to be similar to Microsoft's imagex.exe program.
-
+\fB@IMAGEX_PROGNAME@\fR is able to deal with archives in the Windows Imaging
+Format (.wim files). Its interface is meant to be similar to Microsoft's
+imagex.exe program.
+.PP

 To do its work, \fB@IMAGEX_PROGNAME@\fR uses \fBwimlib\fR, a library which
 provides interfaces for manipulating WIM archives.  You could wimlib in your own
 programs if you wanted to.  wimlib's public interface is documented.
 To do its work, \fB@IMAGEX_PROGNAME@\fR uses \fBwimlib\fR, a library which
 provides interfaces for manipulating WIM archives.  You could wimlib in your own
 programs if you wanted to.  wimlib's public interface is documented.

-

 .SH COMMANDS
 .SH COMMANDS

-

 There is a separate manual page for each \fB@IMAGEX_PROGNAME@\fR command.
 There is a separate manual page for each \fB@IMAGEX_PROGNAME@\fR command.

-

 .SH SUPPORTED FEATURES
 .SH SUPPORTED FEATURES

-

 The following general features are currently supported (note: this is not a
 complete list; also, certain features, such as mounting, are supported on UNIX
 but not Windows):
 The following general features are currently supported (note: this is not a
 complete list; also, certain features, such as mounting, are supported on UNIX
 but not Windows):

-
-.IP \[bu] 3
+.IP \[bu] 4

 Create a stand-alone WIM from a directory or NTFS volume (\fB@IMAGEX_PROGNAME@ capture\fR)
 .IP \[bu]
 Append a directory or NTFS volume onto a stand-alone WIM as a new image (\fB@IMAGEX_PROGNAME@
 Create a stand-alone WIM from a directory or NTFS volume (\fB@IMAGEX_PROGNAME@ capture\fR)
 .IP \[bu]
 Append a directory or NTFS volume onto a stand-alone WIM as a new image (\fB@IMAGEX_PROGNAME@


@@ -88,104 +83,82 @@ XPRESS, and none)
 WIM integrity table is supported (\fB--check\fR option to many commands)
 .IP \[bu]
 WIM XML data (parsed and written using \fBlibxml\fR(3))
 WIM integrity table is supported (\fB--check\fR option to many commands)
 .IP \[bu]
 WIM XML data (parsed and written using \fBlibxml\fR(3))

-

 .SH DIFFERENCES FROM MICROSOFT IMAGEX
 .SH DIFFERENCES FROM MICROSOFT IMAGEX

-

 While similar to Microsoft's "imagex.exe" program, this program is designed for
 UNIX-based systems and by the nature of the platform cannot be exactly the same
 as Microsoft's version.  In addition, I have added additional useful features
 when appropriate.
 While similar to Microsoft's "imagex.exe" program, this program is designed for
 UNIX-based systems and by the nature of the platform cannot be exactly the same
 as Microsoft's version.  In addition, I have added additional useful features
 when appropriate.

-

 .IP \[bu] 4
 Because Microsoft designed the WIM file format to accomodate Windows-specific
 and NTFS-specific features, wimlib must have two separate image capture and
 application modes (although the \fB@IMAGEX_PROGNAME@\fR subcommands for the modes are the
 same): one for general image capture and application, and one for the capture or
 application of an image specifically from/to an NTFS volume.
 .IP \[bu] 4
 Because Microsoft designed the WIM file format to accomodate Windows-specific
 and NTFS-specific features, wimlib must have two separate image capture and
 application modes (although the \fB@IMAGEX_PROGNAME@\fR subcommands for the modes are the
 same): one for general image capture and application, and one for the capture or
 application of an image specifically from/to an NTFS volume.

-
+.IP ""

 Note: the above applies to UNIX builds.  On the Windows builds of wimlib, there
 is only one image capture and application mode, similar to Microsoft's ImageX.
 Note: the above applies to UNIX builds.  On the Windows builds of wimlib, there
 is only one image capture and application mode, similar to Microsoft's ImageX.

-

 .IP \[bu]
 Microsoft's version has some weird limitations, like it won't let you extract a
 WIM on a shared folder, and it requires some commands to be run only from
 Windows PE and not from regular Windows.  This version does not have these
 unusual limitations.
 .IP \[bu]
 Microsoft's version has some weird limitations, like it won't let you extract a
 WIM on a shared folder, and it requires some commands to be run only from
 Windows PE and not from regular Windows.  This version does not have these
 unusual limitations.

-

 .IP \[bu]
 There are bugs in Microsoft's WIM library and I obviously have not included the
 same bugs in wimlib, although in some cases I have had to work around bugs for
 compatibility purposes.
 .IP \[bu]
 There are bugs in Microsoft's WIM library and I obviously have not included the
 same bugs in wimlib, although in some cases I have had to work around bugs for
 compatibility purposes.

-

 .IP \[bu]
 \fB@IMAGEX_PROGNAME@\fR offers the extra command \fB@IMAGEX_PROGNAME@ optimize\fR,
 which lets you easily remove wasted space in a WIM (which can arise after
 a WIM image is appended or mounted read-write).
 .IP \[bu]
 \fB@IMAGEX_PROGNAME@\fR offers the extra command \fB@IMAGEX_PROGNAME@ optimize\fR,
 which lets you easily remove wasted space in a WIM (which can arise after
 a WIM image is appended or mounted read-write).

-

 .IP \[bu]
 \fB@IMAGEX_PROGNAME@\fR also offers the command \fB@IMAGEX_PROGNAME@ join\fR, which lets you
 easily join the parts of a split WIM.
 .IP \[bu]
 \fB@IMAGEX_PROGNAME@\fR also offers the command \fB@IMAGEX_PROGNAME@ join\fR, which lets you
 easily join the parts of a split WIM.

-

 .IP \[bu]
 \fB@IMAGEX_PROGNAME@\fR offers the extra commands \fB@IMAGEX_PROGNAME@
 extract\fR and \fB@IMAGEX_PROGNAME@ update\fR, which let you quickly extract
 files from or make changes to a WIM image without mounting it.
 .IP \[bu]
 \fB@IMAGEX_PROGNAME@\fR offers the extra commands \fB@IMAGEX_PROGNAME@
 extract\fR and \fB@IMAGEX_PROGNAME@ update\fR, which let you quickly extract
 files from or make changes to a WIM image without mounting it.

-

 .IP \[bu]
 \fB@IMAGEX_PROGNAME@ apply\fR supports keeping files hard-linked or symlinked
 across WIM images when extracted from a WIM.  So you can, for example, extract
 different versions of Windows from an install.wim without using much extra
 space.  (Note: this functionality is only available in UNIX builds of wimlib.)
 .IP \[bu]
 \fB@IMAGEX_PROGNAME@ apply\fR supports keeping files hard-linked or symlinked
 across WIM images when extracted from a WIM.  So you can, for example, extract
 different versions of Windows from an install.wim without using much extra
 space.  (Note: this functionality is only available in UNIX builds of wimlib.)

-

 .IP \[bu]
 \fB@IMAGEX_PROGNAME@ capture\fR supports combining multiple separate directories
 and files together in a configurable way to create a WIM image.
 .IP \[bu]
 \fB@IMAGEX_PROGNAME@ capture\fR supports combining multiple separate directories
 and files together in a configurable way to create a WIM image.

-

 .IP \[bu]
 wimlib's XPRESS compressor is better than Microsoft's.
 .IP \[bu]
 wimlib's XPRESS compressor is better than Microsoft's.

-

 .IP \[bu]
 wimlib supports multithreaded compression, which can make it much faster to
 create compressed WIM files.
 .IP \[bu]
 wimlib supports multithreaded compression, which can make it much faster to
 create compressed WIM files.

-

 .IP \[bu]
 \fB@IMAGEX_PROGNAME@ capture\fR supports a special mode where UNIX file modes,
 owners, and groups are stored.  (Note: this functionality is only available in
 UNIX builds.)
 .IP \[bu]
 \fB@IMAGEX_PROGNAME@ capture\fR supports a special mode where UNIX file modes,
 owners, and groups are stored.  (Note: this functionality is only available in
 UNIX builds.)

-

 .IP \[bu]
 \fB@IMAGEX_PROGNAME@ mount\fR and \fB@IMAGEX_PROGNAME@ mountrw\fR are much faster than
 Microsoft's versions for some reason.  I don't know what they have their program
 do that takes so long to simply set up a mountpoint.  (Note: this functionality
 is only available in UNIX builds.)
 .IP \[bu]
 \fB@IMAGEX_PROGNAME@ mount\fR and \fB@IMAGEX_PROGNAME@ mountrw\fR are much faster than
 Microsoft's versions for some reason.  I don't know what they have their program
 do that takes so long to simply set up a mountpoint.  (Note: this functionality
 is only available in UNIX builds.)

-

 .IP \[bu]
 \fB@IMAGEX_PROGNAME@ mount\fR supports mounting an image from a split WIM, but
 Microsoft's software does not.  (Note: this functionality is only available in
 UNIX builds.)
 .IP \[bu]
 \fB@IMAGEX_PROGNAME@ mount\fR supports mounting an image from a split WIM, but
 Microsoft's software does not.  (Note: this functionality is only available in
 UNIX builds.)

-

 .SH LOCALES AND CHARACTER ENCODINGS
 .SH LOCALES AND CHARACTER ENCODINGS

-

 On Windows, wimlib 1.3.2 and later works in UTF-16LE, and there should be no
 problems with character encodings.
 On Windows, wimlib 1.3.2 and later works in UTF-16LE, and there should be no
 problems with character encodings.

-
+.PP

 On UNIX, wimlib works primarily in the locale-dependent multibyte encoding,
 which you are strongly recommended to set to UTF-8 to avoid any problems.
 On UNIX, wimlib works primarily in the locale-dependent multibyte encoding,
 which you are strongly recommended to set to UTF-8 to avoid any problems.

-

 .SH WARNING
 .SH WARNING

-

 Note: \fBwimlib\fR and \fB@IMAGEX_PROGNAME@\fR are experimental.  Use Microsoft's
 imagex.exe if you have to make sure your WIM files are made "correctly".  Feel
 free to submit a bug report if you find a bug.
 Note: \fBwimlib\fR and \fB@IMAGEX_PROGNAME@\fR are experimental.  Use Microsoft's
 imagex.exe if you have to make sure your WIM files are made "correctly".  Feel
 free to submit a bug report if you find a bug.

-
+.PP

 Some parts of the WIM file format are poorly documented or even completely
 undocumented, so I've just had to do the best I can to read and write WIMs in a
 way that appears to be compatible with Microsoft's software.
 Some parts of the WIM file format are poorly documented or even completely
 undocumented, so I've just had to do the best I can to read and write WIMs in a
 way that appears to be compatible with Microsoft's software.

-

 .SH REPORTING BUGS
 .SH REPORTING BUGS

-

 Report bugs to ebiggers3@gmail.com.
 Report bugs to ebiggers3@gmail.com.

-

 .SH SEE ALSO
 .BR @IMAGEX_PROGNAME@-append (1),
 .BR @IMAGEX_PROGNAME@-apply (1),
 .SH SEE ALSO
 .BR @IMAGEX_PROGNAME@-append (1),
 .BR @IMAGEX_PROGNAME@-apply (1),

diff --git a/doc/mkwinpeimg.1.in b/doc/mkwinpeimg.1.in
index d3e357939efd6c329211ea296061a84d1b4ee2e3..ee47350eb5dbdb83171220008a5d934c23dbc579 100644 (file)
--- a/doc/mkwinpeimg.1.in
+++ b/doc/mkwinpeimg.1.in
@@ -4,9 +4,7 @@ mkwinpeimg \- Make a customized bootable image of Windows PE
 .SH SYNOPSIS
 .B mkwinpeimg
 [\fIOPTIONS\fR] \fIIMAGE\fR
 .SH SYNOPSIS
 .B mkwinpeimg
 [\fIOPTIONS\fR] \fIIMAGE\fR

-

 .SH DESCRIPTION
 .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
 \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.
 \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.
 \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.
 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.
 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
 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.
 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.
 \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.
 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
 .SH OPTIONS

-
-.TP
+.TP 6

 \fB\-i\fR, \fB\-\-iso\fR
 Make an ISO image instead of a disk image.
 .TP
 \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
 \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:
 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
 .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:
 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
 .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.
 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
 .RS
 .PP
 mkwinpeimg --start-script=install.cmd --windows-dir=/media/windows /var/tftpboot/winpe.img
 .RE
 .PP

-
-

 .SH NOTES
 .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.
 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
 .SH REPORTING BUGS

-

 Report bugs to ebiggers3@gmail.com.
 Report bugs to ebiggers3@gmail.com.

-

 .SH SEE ALSO
 .BR @IMAGEX_PROGNAME@ (1)
 .SH SEE ALSO
 .BR @IMAGEX_PROGNAME@ (1)