Implement user-specified staging directory

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

diff --git a/doc/imagex-info.1.in b/doc/imagex-info.1.in
index efbeb7c6ad216cf6a93a6791a116618bd69f9321..153221859988704fc3f4dc12ee1413917a56fe0f 100644 (file)
--- a/doc/imagex-info.1.in
+++ b/doc/imagex-info.1.in
@@ -1,6 +1,6 @@
-.TH IMAGEX "1" "September 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 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 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
@@ -45,6 +51,8 @@ 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.
@@ -54,7 +62,8 @@ 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.