Merge experimental LZX compressor

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

diff --git a/doc/imagex-optimize.1.in b/doc/imagex-optimize.1.in
index b4ec85fb9f2e7cc6501120822e5f8a7adc6ca406..8ccbaa7dcb5c2a7c5957f20fb976dc28eace2457 100644 (file)
--- a/doc/imagex-optimize.1.in
+++ b/doc/imagex-optimize.1.in
@@ -1,4 +1,4 @@
-.TH IMAGEX "1" "August 2013" "@IMAGEX_PROGNAME@ @VERSION@" "User Commands"
+.TH WIMLIB-IMAGEX "1" "October 2013" "@IMAGEX_PROGNAME@ @VERSION@" "User Commands"
 .SH NAME
 @IMAGEX_PROGNAME@-optimize \- Optimize a WIM archive
 .SH SYNOPSIS
@@ -11,15 +11,15 @@ of appending images, so the new WIM may be slightly smaller than the old WIM.
 In addition, some errors in the original WIM may be fixed by re-writing it
 (although most cannot).
 This command is also available as simply \fBwimoptimize\fR if the appropriate
-hard link is installed.
+hard link or batch file has been installed.
 .SH OPTIONS
 .TP 6
 \fB--check\fR
 When reading \fIWIMFILE\fR, verify its integrity if an integrity table is
 present.  In addition, include an integrity table in the optimized WIM.  If this
 option is not specified, by default the integrity table (if present) is not
-checked, but an integrity table is included in the new WIM if there was one in
-the old WIM.
+checked, and an integrity table is included in the rebuilt WIM if and only if
+one was present in the original WIM.
 .TP
 \fB--nocheck\fR
 Neither verify the integrity of \fIWIMFILE\fR using the integrity table, nor
@@ -39,13 +39,22 @@ a slightly worse LZX compression ratio than Microsoft's software.  So, you may
 not want to specify \fB--recompress\fR when optimizing a LZX-compressed WIM
 created on Windows with Microsoft's ImageX.
 .TP
+\fB--compress-slow\fR
+With \fB--recompress\fR: Spend even more time compressing the data in order to
+achieve a higher compression ratio.  Currently, this only has an effect with LZX
+("maximum") compression.  Depending on the data, compressing with this option
+will take around 10 to 15 times longer and produce a LZX-compressed WIM about 1%
+to 5% smaller than one produced with the default LZX compressor.  Depending on
+the data, the resulting WIM may be approximately the same size (typically no
+more than 0.4% different) as a LZX-compressed WIM produced by WIMGAPI.
+.TP
 \fB--threads\fR=\fINUM_THREADS\fR
 Number of threads to use for compressing data.  Default: autodetect (number of
 processors).  This parameter is only meaningful when \fB--recompress\fR is also
 specified.
 .TP
 \fB--pipable\fR
-Rebuild the WIM that it can be applied fully sequentially, including from a
+Rebuild the WIM so that it can be applied fully sequentially, including from a
 pipe.  See \fB@IMAGEX_PROGNAME@ capture\fR(1) for more details about creating
 pipable WIMs.  By default, when neither \fB--pipable\fR or \fB--not-pipable\fR
 is specified, the rebuilt WIM will be pipable if and only if it was already