More wimlib-imagex man pages updates

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

diff --git a/doc/imagex-update.1.in b/doc/imagex-update.1.in
index 287ea6f773bc26f4383b2e596262c0c74f0da90f..4c52ea0bbf1338506b5e8801e04eb8a47ac75ac0 100644 (file)
--- a/doc/imagex-update.1.in
+++ b/doc/imagex-update.1.in
@@ -28,12 +28,14 @@ This section documents the commands that may appear in the \fICMDFILE\fR
 described above.
 
 .SS \fBadd\fR [\fIOPTION\fR...] \fISOURCE\fR \fIDESTINATION\fR
-Adds a file or directory tree to the WIM image.  \fISOURCE\fR must specify the
+Add a file or directory tree to the WIM image.  \fISOURCE\fR must specify the
 path to a file or directory on your filesystem.  \fIDESTINATION\fR must specify
 the path inside the WIM image at which to add the file or directory tree.  If
-\fIDESTINATION\fR already exists in the WIM image, then an overlay is attempted;
-this can be used to add multiple files to an existing directory in the WIM image
-in one command.
+\fIDESTINATION\fR already exists in the WIM image, then an overlay is attempted
+if it is a directory; this feature can be used to add multiple files to an
+existing directory in the WIM image in one command.  If \fIDESTINATION\fR does
+not exist in the WIM image, then any prerequisite directories are created as
+needed to add the \fISOURCE\fR at that location.
 
 The available options for the \fBadd\fR command are:
 
@@ -66,7 +68,7 @@ provide this option, although the Administrator should have permission to read
 everything anyway.
 
 .SS \fBdelete\fR [\fIOPTION\fR...] \fIPATH\fR
-Deletes a file or directory tree from a WIM image.  \fIPATH\fR must specify the
+Deletes a file or directory tree from the WIM image.  \fIPATH\fR must specify the
 path inside the WIM image of the file or directory tree to delete.
 
 The available options for the \fBdelete\fR command are:
@@ -80,7 +82,7 @@ Delete the file or directory tree recursively; if not specified, an error is
 issued if the path to delete is a directory.
 
 .SS \fBrename\fR \fIOLD_PATH\fR \fINEW_PATH\fR
-Renames a file or directory tree inside a WIM image.  \fIOLD_PATH\fR must
+Renames a file or directory tree inside the WIM image.  \fIOLD_PATH\fR must
 specify the old path of the file or directory tree inside the WIM image, and
 \fINEW_PATH\fR must specify the new path for the file or directory tree.  This
 command follows the semantics of the POSIX \fBrename\fR (3) function; in
@@ -92,6 +94,9 @@ There are no options available for the \fBrename\fR command.
 
 .SH OPTIONS
 
+The following options are accepted on the command line by \fB@IMAGEX_PROGNAME@
+update\fR itself:
+
 .TP 6
 \fB--verbose\fR
 Use \fB--verbose\fR for all \fBadd\fR commands.
@@ -139,7 +144,7 @@ otherwise be left as a hole in the WIM.  Also see
 \fB@IMAGEX_PROGNAME@ update\fR is partly redundant with \fB@IMAGEX_PROGNAME@
 mountrw\fR, since if a WIM image can be mounted read-write, then there
 theoretically is no need for \fB@IMAGEX_PROGNAME@ update\fR.  The main advantage
-of \fB@IMAGEX_PROGNAME@ update\fR is that is works on both UNIX and Windows,
+of \fB@IMAGEX_PROGNAME@ update\fR is that it works on both UNIX and Windows,
 whereas \fB@IMAGEX_PROGNAME@ mountrw\fR only works on UNIX.
 
 Symbolic links inside a WIM image are not dereferenced when being interpreted.
@@ -148,6 +153,10 @@ So, for example, if you have a WIM image that contains a symbolic link
 subdirectory named "Public" in this directory must be specified as
 "/Users/Public" rather than "/Documents and Settings/Public".
 
+All paths to files or directories within the WIM image must be specified
+relative to the root of the image.  However, the leading slash is optional, and
+both forward slashes and backslashes are accepted.
+
 The command file (\fICMDFILE\fR) is parsed by \fB@IMAGEX_PROGNAME@ update\fR
 itself and not by the system shell.  Therefore, its syntax is limited.  However,
 comment lines beginning with '#' are allowed, and it is also possible to quote
@@ -160,10 +169,14 @@ capture\fR supports capturing a full image this way.
 It is safe to abort an \fB@IMAGEX_PROGNAME@ update\fR command partway through;
 however, after doing this, it is recommended to run \fB@IMAGEX_PROGNAME@
 optimize\fR to remove any data that was appended to the physical WIM file but
-not yet incorporated into the structure of the WIM.
+not yet incorporated into the structure of the WIM, unless \fB--rebuild\fR was
+specified, in which case you should delete the temporary file left over.
 
 .SH EXAMPLES
 
+All the examples below show the update command file to be created as well as the
+\fB@IMAGEX_PROGNAME@ update\fR command to run to perform the updates.
+
 Delete two files from a WIM image:
 
 .RS
@@ -181,9 +194,10 @@ delete /sources/setup.exe
 $ @IMAGEX_PROGNAME@ update boot.wim 2 < update_commands.txt
 .RE
 
-Add some files and directories to a WIM image; note that the first paths specify
-the files to add, while the second paths specify the locations at which to to
-add them \fIinside the WIM image\fR:
+Add some files and directories to a WIM image.  Note that the first path of each
+\fBadd\fR command specifies the files to add, while the second path of each
+\fBadd\fR command specify the locations at which to to add them inside the WIM
+image:
 
 .RS
 \fIupdate_commands.txt\fR:
@@ -225,7 +239,7 @@ including an integrity table in the updated WIM:
 .PP
 .nf
 #
-# This file specifies some changes to make to my WIM image.
+# This file specifies some changes to make to a WIM image.
 #
 
 # Add a new directory containing files I want in the image.