wimoptimize: Add --recompress-slow, imply --recompress

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

diff --git a/doc/imagex-optimize.1.in b/doc/imagex-optimize.1.in
index aa3b947d92c06c8564da3be8a2e555ef973657ea..9f3856af5a41928271fef7e6599881eec661c1b3 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" "December 2013" "@IMAGEX_PROGNAME@ @VERSION@" "User Commands"
 .SH NAME
 @IMAGEX_PROGNAME@-optimize \- Optimize a WIM archive
 .SH SYNOPSIS
@@ -10,14 +10,16 @@ it's ready.  This action will remove any holes that have been left as a result
 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 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
@@ -31,11 +33,14 @@ better job than the program that wrote the original file.  A side effect of this
 is that every stream in the original WIM will be checksummed, so this can help
 verify that the WIM is intact (equivalent to applying all the images from it).
 .IP ""
-Note: as mentioned in the README, wimlib generally provides a slightly better
-XPRESS compression ratio than Microsoft's software, while it generally provides
-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.
+Note: as of wimlib v1.5.3, wimlib's LZX compressor usually achieves the same or
+better compression than Microsoft's, but is slightly slower.
+.TP
+\fB--recompress-slow\fR, \fB--compress-slow\fR
+Spend even more time compressing the data in order to achieve a more optimal
+compression ratio.  This only affects LZX-compressed WIM files.  Compared to the
+default \fB--recompress\fR, this will make compression about twice as slow and
+will increase the compression ratio by maybe 1%, depending on the data.
 .TP
 \fB--threads\fR=\fINUM_THREADS\fR
 Number of threads to use for compressing data.  Default: autodetect (number of
@@ -43,7 +48,7 @@ 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