doc/imagex-capture.1.in: update --delta-from docs

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

diff --git a/doc/imagex-capture.1.in b/doc/imagex-capture.1.in
index 42719119865368f42d8ddfe15a1daab584468c24..6b047f4b26a6fd441f27505d13bd616b6add0ab1 100644 (file)
--- a/doc/imagex-capture.1.in
+++ b/doc/imagex-capture.1.in
@@ -394,7 +394,7 @@ default for \fB@IMAGEX_PROGNAME@ capture\fR, except when writing to standard
 output (\fIWIMFILE\fR specified as "-"), and also for \fB@IMAGEX_PROGNAME@
 append\fR, except when appending to a WIM that is already pipable.
 .TP
-\fB--as-update-of\fR=[\fIWIMFILE\fR]:\fIIMAGE\fR
+\fB--update-of\fR=[\fIWIMFILE\fR]:\fIIMAGE\fR
 Declares that the image being captured from \fISOURCE\fR is mostly the same as
 the existing image \fIIMAGE\fR in \fIWIMFILE\fR, but captured at a later point
 in time, possibly with some modifications in the intervening time.  This is
@@ -410,12 +410,12 @@ appear not to have been modified since they were archived in the existing
 performance and does not change the resulting WIM file.
 .IP ""
 As shown, the full syntax for the argument to this option is to specify the WIM
-file, a colon, and the image; for example, "--as-update-of mywim.wim:1".
+file, a colon, and the image; for example, "--update-of mywim.wim:1".
 However, the WIM file may be omitted, in which case it will default to the WIM
 file being appended to for append operations, or the WIM file from which a delta
-is being taken (with \fB--as-delta-from\fR, if specified) for capture operations.
+is being taken (with \fB--delta-from\fR, if specified) for capture operations.
 .TP
-\fB--as-delta-from\fR=\fIWIMFILE\fR
+\fB--delta-from\fR=\fIWIMFILE\fR
 For \fB@IMAGEX_PROGNAME@ capture\fR only: capture the new WIM as a "delta" from
 \fIWIMFILE\fR.  Any streams that would ordinarily need to be archived in the new
 WIM are omitted if they are already present in the \fIWIMFILE\fR on which the
@@ -425,11 +425,11 @@ metadata, but this is typically only a small fraction of a WIM's total size.
 To operate on the resulting delta WIM using other commands such as
 \fB@IMAGEX_PROGNAME@ apply\fR, you must specify the delta WIM as the WIM file to
 operate on, but also reference the base WIM using the \fB--ref\fR option.
-Beware to retain the proper functioning of the delta WIM, you can only add, not
+Beware: to retain the proper functioning of the delta WIM, you can only add, not
 delete, files and images to the base WIM following the capture of a delta from
 it.
 .IP ""
-\fB--as-delta-from\fR may be combined with \fB--as-update-of\fR to increase the
+\fB--delta-from\fR may be combined with \fB--update-of\fR to increase the
 speed of capturing a delta WIM.
 .IP ""
 As an example, consider the following backup and restore sequence:
@@ -443,7 +443,7 @@ $ wimcapture /some/directory bkup-base.wim
 (some days later, create second backup as delta from first)
 
 $ wimcapture /some/directory bkup-2013-08-20.dwm \\
-       --as-update-of=winbkup.wim:-1 --as-delta-from=winbkup.wim
+       --update-of=winbkup.wim:-1 --delta-from=winbkup.wim
 
 (restoring the second backup)
 
@@ -457,6 +457,17 @@ WIM, the second backup could have simply been appended to the WIM as new image
 using \fB@IMAGEX_PROGNAME@ append\fR.  Delta WIMs should be used only if it's
 desired to base the backups or images on a separate, large file that is rarely
 modified.
+.IP ""
+Note: unlike "pipable" WIMs (created with the \fB--pipable\fR option), "delta"
+WIMs (created with the \fB--delta-from\fR option) are compatible with
+Microsoft's software.  You can use the /ref option of imagex.exe to reference
+the base WIM, similar to above.
+.IP ""
+Additional note:  \fB@IMAGEX_PROGNAME@\fR is generalized enough that you can in
+fact combine \fB--pipable\fR and \fB--delta-from\fR to create pipable delta
+WIMs.  In such cases, the base WIM must be captured as pipable as well as the
+delta WIM, and when applying an image, the base WIM must be sent over the pipe
+after the delta WIM.
 .SH NOTES
 \fB@IMAGEX_PROGNAME@ append\fR does not support appending an image to a split WIM.
 .PP