Briefly describe --unsafe-compact for each command

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

diff --git a/doc/man1/wimlib-imagex-update.1 b/doc/man1/wimlib-imagex-update.1
index 73f520273600f37b3223da3fefd85979c0ccbe88..bb8054906c5e0a2d67c4b22f639e4b714380dce4 100644 (file)
--- a/doc/man1/wimlib-imagex-update.1
+++ b/doc/man1/wimlib-imagex-update.1
@@ -1,4 +1,4 @@
-.TH WIMLIB-IMAGEX "1" "August 2015" "wimlib 1.8.2" "User Commands"
+.TH WIMLIB-IMAGEX "1" "January 2016" "wimlib 1.9.0" "User Commands"
 .SH NAME
 wimlib-imagex-update \- Update a WIM image
 .SH SYNOPSIS
@@ -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
@@ -198,11 +201,12 @@ On UNIX-like systems, you cannot use \fBwimlib-imagex update\fR to add files
 to an image directly from an NTFS volume using libntfs-3g, even though
 \fBwimlib-imagex capture\fR supports capturing a full image this way.
 .PP
-It is safe to abort an \fBwimlib-imagex update\fR command partway through;
-however, after doing this, it is recommended to run \fBwimlib-imagex
-optimize\fR to remove any data that was appended to the physical WIM file but
-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.
+Except when using \fB--unsafe-compact\fR, it is safe to abort a \fBwimlib-imagex
+update\fR command partway through; however, after doing this, it is recommended
+to run \fBwimlib-imagex optimize\fR to remove any data that was appended to the
+physical WIM file but 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
 \fBwimlib-imagex update\fR command to run to perform the updates.