Update wimlib-imagex documentation

[wimlib] / doc / imagex-info.1.in

diff --git a/doc/imagex-info.1.in b/doc/imagex-info.1.in
index 561afe6f8e8e93ca21b6895d1995d39ba2eac960..8255c0e3e23b8bc9b6890c794f25275c7f2ed686 100644 (file)
--- a/doc/imagex-info.1.in
+++ b/doc/imagex-info.1.in
@@ -1,34 +1,30 @@
-.TH IMAGEX "1" "May 2013" "@IMAGEX_PROGNAME@ @VERSION@" "User Commands"
+.TH WIMLIB-IMAGEX "1" "December 2013" "@IMAGEX_PROGNAME@ @VERSION@" "User Commands"

 .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.

-
+This command is also available as simply \fBwiminfo\fR if the appropriate hard
+link or batch file has been installed.
+.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


@@ -39,8 +35,14 @@ archive.
 When reading \fIWIMFILE\fR, verify its integrity if the integrity table is
 present; additionally if an action that requires modifying the WIM archive is
 specified, include an integrity table in the modified WIM.  If this option is
 When reading \fIWIMFILE\fR, verify its integrity if the integrity table is
 present; additionally if an action that requires modifying the WIM archive is
 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.
+not specified and \fIWIMFILE\fR is modified, an integrity table will be included
+in the modified WIM if and only if there was one before.
+.TP
+\fB--nocheck\fR
+If an action that requires modifying the WIM archive is specified, do not
+include an integrity table in the modified WIM.  If this option is not specified
+and \fIWIMFILE\fR is modified, an integrity table will be included in the
+modified WIM if and only 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.
 .TP
 \fB--extract-xml\fR=\fIFILE\fR
 Extracts the raw data from the XML resource in the WIM file to \fIFILE\fR.


@@ -64,4 +66,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)

-