]> wimlib.net Git - wimlib/blobdiff - doc/imagex-info.1.in
Only access struct stat.mtim if available
[wimlib] / doc / imagex-info.1.in
index 132ec4e7708df8f34e8f26cae6ed8c5bd2ec6e69..153221859988704fc3f4dc12ee1413917a56fe0f 100644 (file)
@@ -1,6 +1,6 @@
-.TH IMAGEX "1" "May 2012" "imagex (wimlib) wimlib @VERSION@" "User Commands"
+.TH IMAGEX "1" "November 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,16 @@ 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.
+\fBimagex 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
@@ -39,22 +45,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, including the security data and the directory entry tree,
-for the specified image.
+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.