Briefly describe --unsafe-compact for each command
authorEric Biggers <ebiggers3@gmail.com>
Thu, 25 Feb 2016 01:41:30 +0000 (19:41 -0600)
committerEric Biggers <ebiggers3@gmail.com>
Thu, 25 Feb 2016 01:42:42 +0000 (19:42 -0600)
doc/man1/wimlib-imagex-capture.1
doc/man1/wimlib-imagex-delete.1
doc/man1/wimlib-imagex-export.1
doc/man1/wimlib-imagex-update.1

index c8fae94..6e35a31 100644 (file)
@@ -579,7 +579,11 @@ default, set the configuration file to
 however, this may still be overridden through the \fB--config\fR parameter.
 .TP
 \fB--unsafe-compact\fR
-See the documentation for this option in \fBwimlib-imagex-optimize\fR (1).
+For \fBwimlib-imagex append\fR: compact the WIM archive in-place and append any
+new data, eliminating "holes".  In general, this option should \fInot\fR be used
+because a failed or interrupted compaction will corrupt the WIM archive.  For
+more information, see the documentation for this option in
+\fBwimlib-imagex-optimize\fR (1).
 .TP
 \fB--snapshot\fR
 Create a temporary filesystem snapshot of the source directory and capture the
index 4d063e3..d72d9be 100644 (file)
@@ -46,7 +46,10 @@ You may use \fBwimlib-imagex optimize\fR to delete unreferenced streams from a W
 has had images soft-deleted from it.
 .TP
 \fB--unsafe-compact\fR
-See the documentation for this option in \fBwimlib-imagex-optimize\fR (1).
+Compact the WIM archive in-place, eliminating "holes".  In general, this option
+should \fInot\fR be used because a failed or interrupted compaction will corrupt
+the WIM archive.  For more information, see the documentation for this option in
+\fBwimlib-imagex-optimize\fR (1).
 .SH EXAMPLES
 Delete the first image from 'boot.wim':
 .RS
index 67dcc2d..198b504 100644 (file)
@@ -134,7 +134,10 @@ archive, set the compression type to that recommended for WIMBoot (currently,
 XPRESS with 4096 byte chunks).
 .TP
 \fB--unsafe-compact\fR
-See the documentation for this option in \fBwimlib-imagex-optimize\fR (1).
+Compact the WIM archive in-place and append any new data, eliminating "holes".
+In general, this option should \fInot\fR be used because a failed or interrupted
+compaction will corrupt the WIM archive.  For more information, see the
+documentation for this option in \fBwimlib-imagex-optimize\fR (1).
 .SH SPLIT WIMS
 You may use \fBwimlib-imagex export\fR to export images from a split WIM.
 The \fISRC_WIMFILE\fR argument must specify the first part of the split WIM,
index cc6dab9..bb80549 100644 (file)
@@ -165,7 +165,10 @@ boot process).  See the documentation for the \fB--wimboot\fR option of
 \fBwimlib-imagex apply\fR (1) for more information.
 .TP
 \fB--unsafe-compact\fR
-See the documentation for this option in \fBwimlib-imagex-optimize\fR (1).
+Compact the WIM archive in-place and append any new data, eliminating "holes".
+In general, this option should \fInot\fR be used because a failed or interrupted
+compaction will corrupt the WIM archive.  For more information, see the
+documentation for this option in \fBwimlib-imagex-optimize\fR (1).
 .SH NOTES
 \fBwimlib-imagex update\fR is partly redundant with \fBwimlib-imagex
 mountrw\fR, since if a WIM image can be mounted read-write, then there