Man page updates
authorEric Biggers <ebiggers3@gmail.com>
Thu, 30 Aug 2012 02:30:01 +0000 (21:30 -0500)
committerEric Biggers <ebiggers3@gmail.com>
Thu, 30 Aug 2012 02:30:01 +0000 (21:30 -0500)
doc/imagex-apply.1.in
doc/imagex-delete.1.in
doc/imagex-dir.1.in
doc/imagex-export.1.in
doc/imagex-info.1.in
doc/imagex-mount.1.in

index 0c8ceec..0c81915 100644 (file)
@@ -11,7 +11,7 @@ imagex apply \- Extract one image, or all images, from a WIM archive
 \fBimagex apply\fR extracts an image, or all images, from the Windows Imaging
 (WIM) file \fIWIMFILE\fR.
 
-\fIIMAGE\fR specifies the image to extract.  It may be a 1-based index of an
+\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 \fBimagex info\fR (1)
 command to show what images a WIM file contains.
@@ -172,6 +172,10 @@ instead.  This option is not available in the NTFS extraction mode.
 Print the path to of each file or directory within the WIM image as it is
 extracted, and some additional informational messages.
 
+.SH NOTES
+
+\fBimagex apply\fR does not yet support split WIMs.
+
 .SH EXAMPLES
 .SS Normal extraction mode
 Extract the first image from the Windows PE image from the Windows Vista/7/8
index ef8b3f6..4631714 100644 (file)
@@ -3,25 +3,30 @@
 imagex delete \- Delete an image from a WIM archive
 
 .SH SYNOPSIS
-\fBimagex delete\fR \fIWIMFILE\fR (\fIIMAGE_NUM\fR | \fIIMAGE_NAME\fR | all ) [--check]
+\fBimagex delete\fR \fIWIMFILE\fR \fIIMAGE\fR [--check]
 
 .SH DESCRIPTION
 .PP
 
-\fBimagex delete\fR deletes the specified image from \fIWIMFILE\fR.
+\fBimagex delete\fR deletes the specified image from the Windows Imaging (WIM)
+file \fIWIMFILE\fR.
 
-The image to delete may be specified by \fIIMAGE_NUM\fR, which must be an
-integer that is an index of an image in the WIM file, starting at 1.
-Alternatively, it may be the name of an image in the WIM file, or the keyword
-"all", which specifies that all images are to be deleted.
+\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 \fBimagex info\fR (1)
+command to show what images a WIM file contains.
 
-The WIM file is recreated with all unnecessary file resources removed.  This is
-different from imagex.exe, which only will delete the metadata and XML entries
-for this operation.
+.SH NOTES
+
+The WIM file is rebuild with all unnecessary file data removed.  This is
+different from imagex.exe, which only will delete the directory tree metadata
+and XML data for this operation.
 
 Also, unlike 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.
 
+\fBimagex delete\fR does not yet support split WIMs.
+
 .SH OPTIONS
 .TP 6
 \fB--check\fR
@@ -31,10 +36,12 @@ deleted, write an integrity table.  If this option is not specified, no integrit
 table is included in the new WIM file, even if there was one before.
 
 .SH EXAMPLES
-.IP 
+Delete the first image from 'boot.wim':
+.RS
+.PP
 image delete boot.wim 1
-.LP 
-Delete the first image from 'boot.wim'.
+.RE
+.PP
 
 .SH SEE ALSO
 .BR imagex (1)
index 34dbe54..266ca18 100644 (file)
@@ -3,23 +3,30 @@
 imagex dir \- Show the files contained in a WIM archive
 
 .SH SYNOPSIS
-\fBimagex dir\fR \fIWIMFILE\fR (\fIIMAGE_NUM\fR | \fIIMAGE_NAME\fR | all),
+\fBimagex dir\fR \fIWIMFILE\fR \fIIMAGE\fR
 
 .SH DESCRIPTION
 .PP
-Lists all the files and directories contained in the specified image of
-\fIWIMFILE\fR.
+Lists all the files and directories contained in the specified image of the
+Windows Imaging (WIM) file \fIWIMFILE\fR.
 
-The image may be specified by \fIIMAGE_NUM\fR, which must be an integer that is
-an index of an image in the WIM file, starting at 1.  Alternatively, it may be
-the name of an image in the WIM file.  It also may be the keyword "all", which
-specifies all images.
+\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 \fBimagex
+info\fR (1) command to show what images a WIM file contains.
+
+.SH NOTES
+
+\fBimagex dir\fR supports split WIMs, but it will only work on the first part of
+the split WIM.
 
 .SH EXAMPLES
-.IP 
+Show all files in the first image of 'boot.wim':
+.RS
+.PP
 image dir boot.wim 1
-.LP 
-Show all files in the first image of 'boot.wim'
+.RE
+.PP
 
 .SH SEE ALSO
 .BR imagex (1)
index 4bedcb9..63ed09d 100644 (file)
@@ -32,7 +32,8 @@ image being exported to \fIDEST_WIMFILE\fR.  The default is its description in
 .SH OPTIONS
 .TP 6
 \fB--boot\fR
-Specifies that the exported image is to be the bootable image of the WIM archive.
+Specifies that the exported image is to be the bootable image of the destination
+WIM archive.
 
 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
@@ -45,26 +46,28 @@ present; additionally, when writing \fIDEST_WIMFILE\fR with the new image added,
 write an integrity table.  If this option is not specified, no integrity table
 is included in \fIDEST_WIMFILE\fR, even if there was one before.
 .TP
-\fB--compress\fR[=\fITYPE\fR]
+\fB--compress\fR=\fITYPE\fR
 Specifies the compression type for \fIDEST_WIMFILE\fR.  This is only valid if
-\fIDEST_WIMFILE\fR does not yet exist.
+\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.
 
-\fITYPE\fR may be "none",
-"maximum", or "fast".  By default, the compression type is "none".  If \fB--compress\fR
-is specified but \fITYPE\fR is not, the compression type is taken to be
-"maximum", which is LZX compression.  "fast" compression is XPRESS compression.
+\fITYPE\fR may be "none", "maximum", or "fast".  By default, it is "fast".
+
+You may also specify the actual names of the compression algorithms, "XPRESS"
+and "LZX", instead of "fast" and "maximum", respectively.
 
 .SH NOTES
 
-\fBimagex export\fR does not support split WIMs.
+\fBimagex export\fR does not yet support split WIMs.
 
 .SH EXAMPLES
-.IP 
-image export boot.wim 2 image2.wim --compress=maximum
-.LP 
 Export the second image of 'boot.wim' to the new WIM file 'image2.wim', and
-change the compression type to maximum, if it wasn't maximum already.
-
+change the compression type to maximum, if it wasn't maximum already:
+.RS
+.PP
+image export boot.wim 2 image2.wim --compress=maximum
+.RE
+.PP
 
 .SH SEE ALSO
 .BR imagex (1)
index 132ec4e..19b9cff 100644 (file)
@@ -25,10 +25,10 @@ Changes to the WIM are made if \fINEW_NAME\fR and/or \fB--boot\fR are specified.
 \fIIMAGE_NUM\fR or \fIIMAGE_NAME\fR, while \fINEW_DESC\fR is taken to be its new
 description. \fINEW_DESC\fR defaults to the old description if it is not given.
 
-Since none of these changes require changing the file resources, the metadata
-resources, or the lookup table, they can be done very quickly by only re-writing
-the header and XML data.  It will only take significant time if \fB--check\fR is
-specified for a WIM that had no integrity checks before.
+Since none of these changes require changing the WIM's file resources, metadata
+resources, or stream lookup table, they can be done very quickly by only
+re-writing the header and XML data.  It will only take significant time if
+\fB--check\fR is specified for a WIM that had no integrity checks before.
 
 .SH OPTIONS
 .TP 6
@@ -39,9 +39,9 @@ archive.
 \fB--check\fR
 When reading \fIWIMFILE\fR, verify its integrity if the integrity table is
 present; additionally if an action that requires changing the WIM archive is
-specified, write an integrity table.  If this option is not specified and
-\fIWIMFILE\fR is recreated, no integrity table is included in the new WIM file,
-even if there was one before.
+specified, include an integrity table in the modified WIM.  If this option is
+not specified and \fIWIMFILE\fR is recreated, no integrity table is included in
+the modified WIM, even if there was one before.
 .TP
 \fB--extract-xml\fR \fIFILE\fR
 Extracts the raw data from the XML resource in the WIM file to \fIFILE\fR.
@@ -50,7 +50,7 @@ Extracts the raw data from the XML resource in the WIM file to \fIFILE\fR.
 Shows detailed information from the WIM header.
 .TP
 \fB--lookup-table\fR
-Prints all the entries in the lookup table of the WIM.
+Prints all the entries in the stream lookup table of the WIM.
 .TP
 \fB--metadata\fR
 Prints the metadata, including the security data and the directory entry tree,
index 386e177..b9786c9 100644 (file)
@@ -38,6 +38,8 @@ 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
 descriptor.
 
+Mounting split WIMs is not yet supported.
+
 .SH MOUNT OPTIONS
 .TP
 \fB--check\fR