wimlib-imagex: add options to enable unsafe compaction

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

diff --git a/doc/man1/wimlib-imagex-optimize.1 b/doc/man1/wimlib-imagex-optimize.1
index 98dd666aef9c7cfe77d1cb023824c2408e1aa22c..713b92b31d182c24985fdffc9b9c3f9f64f31fee 100644 (file)
--- a/doc/man1/wimlib-imagex-optimize.1
+++ b/doc/man1/wimlib-imagex-optimize.1
@@ -77,6 +77,16 @@ pipable.
 \fB--not-pipable\fR
 Rebuild the WIM in the non-pipable format.  (This is the default if
 \fIWIMFILE\fR is not pipable.)
+.TP
+\fB--unsafe-compact\fR
+Compact the WIM file in-place, without using a temporary file.  Existing
+resources are shifted down to fill holes and new resources are appended as
+needed.  The WIM file is truncated to its final size, which may shrink the
+on-disk file.  THIS OPERATION CANNOT BE SAFELY INTERRUPTED!  If the operation is
+interrupted, then the WIM file will be corrupted, and it may be impossible (or
+at least very difficult) to recover any data from it.  Users of this option are
+expected to know what they are doing and assume responsibility for any data
+corruption that may result.
 .SH NOTES
 \fBwimlib-imagex optimize\fR does not support split WIMs.
 .PP