X-Git-Url: https://wimlib.net/git/?p=wimlib;a=blobdiff_plain;f=doc%2Fimagex-info.1.in;h=1840df6b6ffb1d06d4e90c79a9b58ef387b556a1;hp=153221859988704fc3f4dc12ee1413917a56fe0f;hb=199fd93eb6f74d81b304d310c8b1b1bb9b55db82;hpb=a6c413a13da72aac44b0a522c2650d5e54e16a72 diff --git a/doc/imagex-info.1.in b/doc/imagex-info.1.in index 15322185..1840df6b 100644 --- a/doc/imagex-info.1.in +++ b/doc/imagex-info.1.in @@ -1,41 +1,30 @@ -.TH IMAGEX "1" "November 2012" "imagex (wimlib) wimlib @VERSION@" "User Commands" +.TH WIMLIB-IMAGEX "1" "August 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 other 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, the printed -information is restricted to that concerning the specified image. - +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. +.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_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. - -\fBimagex info\fR does not support modifying a split WIM, although you may +\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. - -.SH NOTES - -Aborting an \fBimagex info\fR command that modifies \fIWIMFILE\fR is unlikely to -result in corruption of \fIWIMFILE\fR. If \fBimagex info\fR is aborted while -the integrity table is being calculated (with --check), the WIM should be in a -consistent state with any previous changes to the bootable index, new, or -description of the specified index committed. - .SH OPTIONS .TP 6 \fB--boot\fR @@ -44,14 +33,20 @@ archive. .TP \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 +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 recreated, 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 +\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 should be encoded using UTF-16LE, and it should begin with a +Note: the XML data will be encoded using UTF-16LE, and it will begin with a byte-order mark. .TP \fB--header\fR @@ -61,12 +56,13 @@ Shows detailed information from the WIM header. 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, -for the specified image. This only works on standalone WIMs or on the first -part of a split WIM. +Prints the metadata, including the security data and the directory entry tree +but not the XML data, for the specified image. If no image is specified, the +metadata for all images is printed. This only works on standalone WIMs or on +the first part of a split WIM. .TP \fB--xml\fR -Prints the XML data for the 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)