X-Git-Url: https://wimlib.net/git/?p=wimlib;a=blobdiff_plain;f=doc%2Fimagex-info.1.in;h=59c12afe3079f112ee4da06ec70eac647a92d3eb;hp=970828126aca1710a781c8cf5d83dae85700085a;hb=1a8b4a9f6e24d3ebbd75a86f73955e0f3f5e1785;hpb=7b5a88bcb70a3bdb24f3df414e8c71fdb95ee602 diff --git a/doc/imagex-info.1.in b/doc/imagex-info.1.in index 97082812..59c12afe 100644 --- a/doc/imagex-info.1.in +++ b/doc/imagex-info.1.in @@ -1,38 +1,28 @@ -.TH IMAGEX "1" "November 2012" "imagex (wimlib) wimlib @VERSION@" "User Commands" +.TH IMAGEX "1" "June 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. - +.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. - -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. - -\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 OPTIONS .TP 6 \fB--boot\fR @@ -41,14 +31,14 @@ 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 +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 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 @@ -58,12 +48,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)