]> wimlib.net Git - wimlib/blobdiff - doc/imagex-info.1.in
Update version number to 1.4.0; update NEWS
[wimlib] / doc / imagex-info.1.in
index fc2b64b9b2ed5e6e6920b359e6278e41ad9eb23a..561afe6f8e8e93ca21b6895d1995d39ba2eac960 100644 (file)
@@ -1,48 +1,34 @@
-.TH IMAGEX "1" "February 2013" "imagex (wimlib) wimlib @VERSION@" "User Commands"
+.TH IMAGEX "1" "May 2013" "@IMAGEX_PROGNAME@ @VERSION@" "User Commands"
 .SH NAME
-imagex-info \- Display information about a WIM file, or change information about
+@IMAGEX_PROGNAME@-info \- Display information about a WIM file, or change information about
 an image
 
 .SH SYNOPSIS
-\fBimagex info\fR \fIWIMFILE\fR [\fIIMAGE_NUM\fR | \fIIMAGE_NAME\fR]  \
-[\fINEW_NAME\fR] [\fINEW_DESC\fR] [\fIOPTION\fR]...
+\fB@IMAGEX_PROGNAME@ info\fR \fIWIMFILE\fR [\fIIMAGE\fR [\fINEW_NAME\fR
+[\fINEW_DESC\fR]]] [\fIOPTION\fR...]
 
 
 .SH DESCRIPTION
 .PP
 
-\fBimagex info\fR displays information about \fIWIMFILE\fR, and optionally
+\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.
 
 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 (as a 1-based image
-index or an image name), the printed information is restricted to that
-concerning the specified image.
+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.
 
 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_NUM\fR or \fIIMAGE_NAME\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.
+\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.
 
-\fBimagex info\fR does not support modifying a split WIM, although you may
+\fB@IMAGEX_PROGNAME@ info\fR does not support modifying a split WIM, although you may
 display information about one.
 
-.SH NOTES
-
-The possible modifications to \fIWIMFILE\fR by \fBimagex info\fR are made
-quickly without re-building the entire WIM.  \fBimagex info\fR will only take a
-significant amount of time to complete if \fB--check\fR is specified when the
-WIM previously had no integrity table.
-
-Aborting an \fBimagex info\fR command that modifies \fIWIMFILE\fR is unlikely to
-result in corruption of \fIWIMFILE\fR.  Even if \fBimagex info\fR is aborted
-while the integrity table is being calculated (with \fB--check\fR), the WIM
-should be in a consistent state with any changes to the bootable index,
-name, or description of the specified image committed.
-
 .SH OPTIONS
 .TP 6
 \fB--boot\fR
@@ -56,7 +42,7 @@ specified, include an integrity table in the modified WIM.  If this option is
 not specified and \fIWIMFILE\fR is modified, no integrity table is included in
 the modified WIM, even if there was one before.
 .TP
-\fB--extract-xml\fR \fIFILE\fR
+\fB--extract-xml\fR=\fIFILE\fR
 Extracts the raw data from the XML resource in the WIM file to \fIFILE\fR.
 Note: the XML data will be encoded using UTF-16LE, and it will begin with a
 byte-order mark.
@@ -77,5 +63,5 @@ the first part of a split WIM.
 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 (1)
+.BR @IMAGEX_PROGNAME@ (1)