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 929abd05bac31d23e81bf23c71336cc0561e26ca..713b92b31d182c24985fdffc9b9c3f9f64f31fee 100644 (file)
--- a/doc/man1/wimlib-imagex-optimize.1
+++ b/doc/man1/wimlib-imagex-optimize.1
@@ -1,4 +1,4 @@
-.TH WIMLIB-IMAGEX "1" "November 2014" "wimlib 1.7.3" "User Commands"
+.TH WIMLIB-IMAGEX "1" "August 2015" "wimlib 1.8.2" "User Commands"
 .SH NAME
 wimlib-imagex-optimize \- Optimize a WIM archive
 .SH SYNOPSIS
@@ -53,12 +53,12 @@ compatibility.  See the documentation for this option to \fBwimlib-imagex
 capture\fR (1) for more details.
 .TP
 \fB--solid-chunk-size\fR=\fISIZE\fR
-Like \fB--chunk-size\fR, but set the chunk size used in solid blocks.  See the
+Like \fB--chunk-size\fR, but set the chunk size used in solid resources.  See the
 documentation for this option to \fBwimlib-imagex capture\fR (1) for more
 details.
 .TP
 \fB--solid-compress\fR=\fITYPE\fR[:\fILEVEL\fR]
-Like \fB--compress\fR, but set the compression type used in solid blocks.  See
+Like \fB--compress\fR, but set the compression type used in solid resources.  See
 the documentation for this option to \fBwimlib-imagex capture\fR (1) for
 more details.
 .TP
@@ -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