X-Git-Url: https://wimlib.net/git/?p=wimlib;a=blobdiff_plain;f=doc%2Fimagex-info.1.in;h=2354d311d43cf56e8524be93bec75d5a6fcf46d8;hp=547de7af1f120ef90bd213091090a9284122bce2;hb=45c3ad86e44a05a169bfb1fa8ff318861bbf9fbf;hpb=370533dcb819ad11d6424e7e0284915eb501812b diff --git a/doc/imagex-info.1.in b/doc/imagex-info.1.in index 547de7af..2354d311 100644 --- a/doc/imagex-info.1.in +++ b/doc/imagex-info.1.in @@ -1,6 +1,6 @@ -.TH IMAGEX "1" "May 2012" "imagex (wimlib) wimlib @VERSION@" "User Commands" +.TH IMAGEX "1" "October 2012" "imagex (wimlib) wimlib @VERSION@" "User Commands" .SH NAME -imagex info \- Display information about a WIM file, or change information about +imagex-info \- Display information about a WIM file, or change information about an image .SH SYNOPSIS @@ -25,10 +25,13 @@ 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. + +\fBimagex info\fR does not support modifying a split WIM, although you may +display information about one. .SH OPTIONS .TP 6 @@ -39,21 +42,25 @@ 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. +Note: the XML data should be encoded using UTF-16LE, and it should begin with a +byte-order mark. .TP \fB--header\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 for the directory tree for the specified image. +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. .TP \fB--xml\fR Prints the XML data for the WIM.