imagex-update.1.in: Explain --command quoting

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

diff --git a/doc/imagex-update.1.in b/doc/imagex-update.1.in
index ceca0fcdc990196c7df3b715a0d2d6d9e941e6a3..f4f9f8463d20d9f6618f8cd93d7f8d101c14fd9a 100644 (file)
--- a/doc/imagex-update.1.in
+++ b/doc/imagex-update.1.in
@@ -130,7 +130,18 @@ otherwise be left as a hole in the WIM.  Also see
 Instead of reading update commands from standard input, read a single update
 command directly from the string \fISTRING\fR specified on the command line.
 This option cannot be provided more than one time and cannot be used to specify
-more than one update command.
+more than one update command.  Note that the \fISTRING\fR, as well as any
+paths containing spaces within the \fISTRING\fR must be appropriately quoted.
+If running from cmd.exe on Windows, you should use double quotes for the outer
+quotes and single quotes for the inner quotes.  Example:
+.RS
+.RS
+.PP
+.nf
+@IMAGEX_PROGNAME@ update boot.wim 1 --command="add 'C:\\My Dir' '\\My Dir'"
+.RE
+.RE
+.fi
 .SH NOTES
 \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
@@ -146,8 +157,8 @@ subdirectory named "Public" in this directory must be specified as
 .PP
 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.  On Windows, the paths are
-treated case-insensitively, while on UNIX, the paths are treated
+both forward slashes and backslashes are accepted.  In addition, on Windows, the
+paths are treated case-insensitively, while on UNIX, the paths are treated
 case-sensitively.
 .PP
 The command file (\fICMDFILE\fR) is parsed by \fB@IMAGEX_PROGNAME@ update\fR