wimlib-imagex: Add --solid as alias for --pack-streams

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

diff --git a/doc/imagex-optimize.1.in b/doc/imagex-optimize.1.in
index f0ecc549fa129d79371cfadf83d23f04551c5843..37eb71bb6a9dbcc53e64673b9c514a94e892854c 100644 (file)
--- a/doc/imagex-optimize.1.in
+++ b/doc/imagex-optimize.1.in
@@ -1,4 +1,4 @@
-.TH WIMLIB-IMAGEX "1" "November 2013" "@IMAGEX_PROGNAME@ @VERSION@" "User Commands"
+.TH WIMLIB-IMAGEX "1" "January 2014" "@IMAGEX_PROGNAME@ @VERSION@" "User Commands"
 .SH NAME
 @IMAGEX_PROGNAME@-optimize \- Optimize a WIM archive
 .SH SYNOPSIS
@@ -33,20 +33,38 @@ 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--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.
+\fB--recompress-slow\fR, \fB--compress-slow\fR
+Spend even more time compressing the data in order to achieve a more optimal
+compression ratio.  For LZX ("maximum") compression, compared to the default
+\fB--recompress\fR this will make compression about twice as slow and may
+improve the compression ratio by maybe 1%, depending on the data.  For LZMS
+("recovery") compression this option also has an effect.  For XPRESS ("fast")
+compression this option has no effect; however you may use \fB--compress\fR=LZX
+\fB--recompress-slow\fR to change the compression type to LZX and recompress
+slowly, as per this option.  In any case, this option implies
+\fB--recompress\fR.
+.TP
+\fB--compress\fR=\fITYPE\fR
+Recompress the WIM file using the specified compression type.  \fITYPE\fR may be
+"none", "fast" (or "XPRESS"), or "maximum" (or "LZX").  This implies
+\fB--recompress\fR.
+.IP ""
+\fITYPE\fR may also be "recovery" (or "LZMS"); however, this will result in
+reduced compatibility.  See the documentation for this option to
+\fB@IMAGEX_PROGNAME@ capture\fR (1) for more details.
+.TP
+\fB--chunk-size\fR=\fISIZE\fR
+Set the WIM compression chunk size to \fISIZE\fR.  See the documentation for
+this option to \fB@IMAGEX_PROGNAME@ capture\fR (1) for more details.
+.TP
+\fB--pack-streams\fR, \fB--solid\fR
+Create a "solid" archive that compresses multiple files together.  This can
+result in a higher compression ratio, but has disadvantages such as reduced
+compatibility; see the documentation for this option to
+\fB@IMAGEX_PROGNAME@-capture\fR (1) for more details.
 .TP
 \fB--threads\fR=\fINUM_THREADS\fR
 Number of threads to use for compressing data.  Default: autodetect (number of