doc/imagex-capture.1.in: update --delta-from docs
authorEric Biggers <ebiggers3@gmail.com>
Tue, 20 Aug 2013 23:23:40 +0000 (18:23 -0500)
committerEric Biggers <ebiggers3@gmail.com>
Tue, 20 Aug 2013 23:23:47 +0000 (18:23 -0500)
doc/imagex-capture.1.in
doc/imagex.1.in

index 0aa4a2a..6b047f4 100644 (file)
@@ -425,7 +425,7 @@ 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.
 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 ""
 delete, files and images to the base WIM following the capture of a delta from
 it.
 .IP ""
@@ -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.
 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
 .SH NOTES
 \fB@IMAGEX_PROGNAME@ append\fR does not support appending an image to a split WIM.
 .PP
index 7d4c9af..3c14e64 100644 (file)
@@ -155,6 +155,9 @@ output or from standard input, respectively; this can be used to pipe images to
 or from a server over the network to implement fast filesystem imaging and
 restore.
 .IP \[bu]
 or from a server over the network to implement fast filesystem imaging and
 restore.
 .IP \[bu]
+\fB@IMAGEX_PROGNAME@ capture\fR and \fB@IMAGEX_PROGNAME@ append\fR support
+options to optimize incremental backups and to create "delta" WIM files.
+.IP \[bu]
 wimlib (and \fB@IMAGEX_PROGNAME@\fR via \fB@IMAGEX_PROGNAME@ capture\fR)
 supports combining multiple separate directories and files together in a
 configurable way to create a WIM image.
 wimlib (and \fB@IMAGEX_PROGNAME@\fR via \fB@IMAGEX_PROGNAME@ capture\fR)
 supports combining multiple separate directories and files together in a
 configurable way to create a WIM image.