X-Git-Url: https://wimlib.net/git/?a=blobdiff_plain;f=doc%2Fman1%2Fimagex-optimize.1.in;h=68360060eee98eeab4e2a940f3eff71642137f0e;hb=5b6eaafbaab217fc69946685862a09afa28b30cb;hp=b3e41bf84696e26d1f226bb17f4e58d0c0810423;hpb=95ab9826b75bcb92ea660f45c5d4ae891a6d5f2f;p=wimlib

diff --git a/doc/man1/imagex-optimize.1.in b/doc/man1/imagex-optimize.1.in
index b3e41bf8..68360060 100644
--- a/doc/man1/imagex-optimize.1.in
+++ b/doc/man1/imagex-optimize.1.in
@@ -1,4 +1,4 @@
-.TH WIMLIB-IMAGEX "1" "May 2014" "@IMAGEX_PROGNAME@ @VERSION@" "User Commands"
+.TH WIMLIB-IMAGEX "1" "October 2014" "@IMAGEX_PROGNAME@ @VERSION@" "User Commands"
 .SH NAME
 @IMAGEX_PROGNAME@-optimize \- Optimize a WIM archive
 .SH SYNOPSIS
@@ -8,8 +8,11 @@
 WIM is written to a temporary file, and it is renamed to the original file when
 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).
+.PP
+By default, compressed data will be re-used, and not recompressed.  Use the
+\fB--recompress\fR or \fB--compress\fR=\fITYPE\fR[:\fILEVEL\fR] option to
+request recompression.
+.PP
 This command is also available as simply \fBwimoptimize\fR if the appropriate
 hard link or batch file has been installed.
 .SH OPTIONS
@@ -27,59 +30,42 @@ include an integrity table in the rebuilt WIM file.
 .TP
 \fB--recompress\fR
 Recompress all compressed streams in \fIWIMFILE\fR when rebuilding it.  This
-will increase the time needed to rebuild the WIM, unless the WIM is
-uncompressed, but it may result in a better compression ratio if wimlib can do a
-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 of wimlib v1.5.3, wimlib's LZX compressor usually achieves the same or
-better compression than Microsoft's, but is slightly slower.
+will greatly increase the time needed to rebuild the WIM file, but it may result
+in a better compression ratio if wimlib can do a better job than the program
+that wrote the original file.
 .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.  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--compress\fR=\fITYPE\fR[:\fILEVEL\fR]
+Recompress the WIM file using the specified compression type, and optionally the
+specified compression level for that compression type.  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.
+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
+\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--pack-chunk-size\fR=\fISIZE\fR, \fB--solid-chunk-size\fR=\fISIZE\fR
-Like \fB--chunk-size\fR, but set the chunk size used in packed resources.  See
-the documentation for this option to \fB@IMAGEX_PROGNAME@ capture\fR (1) for
-more details.
+\fB--solid-chunk-size\fR=\fISIZE\fR
+Like \fB--chunk-size\fR, but set the chunk size used in solid blocks.  See the
+documentation for this option to \fB@IMAGEX_PROGNAME@ capture\fR (1) for more
+details.
 .TP
-\fB--pack-compress\fR=\fITYPE\fR, \fB--solid-compress\fR=\fITYPE\fR
-Like \fB--compress\fR, but set the compression format used in packed resources.
-See the documentation for this option to \fB@IMAGEX_PROGNAME@ capture\fR (1) for
+\fB--solid-compress\fR=\fITYPE\fR[:\fILEVEL\fR]
+Like \fB--compress\fR, but set the compression type used in solid blocks.  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
-processors).  This parameter is only meaningful when \fB--recompress\fR is also
-specified.
+processors).  This parameter only has an effect when data recompression is
+requested.
 .TP
 \fB--pipable\fR
 Rebuild the WIM so that it can be applied fully sequentially, including from a
@@ -100,6 +86,30 @@ Rebuild the WIM in the non-pipable format.  (This is the default if
 \fB@IMAGEX_PROGNAME@ export\fR \fIWIMFILE\fR all tmp.wim && mv tmp.wim \fIWIMFILE\fR
 .RE
 .PP
+.SH EXAMPLES
+Rebuild the WIM file 'install.wim':
+.RS
+.PP
+wimoptimize install.wim
+.RE
+.PP
+Rebuild and recompress the WIM file 'install.wim':
+.RS
+.PP
+wimoptimize install.wim --recompress
+.RE
+.PP
+Rebuild and recompress the WIM file 'install.wim', using "maximum" (LZX)
+compression at a higher-than-default compression level.  The compression chunk
+size remains unchanged.  This command will be slow, but it might be useful for
+optimizing files for distribution.  See the COMPRESSION RATIO section of the
+README file for some benchmark results.
+.RS
+.PP
+wimoptimize install.wim --compress=maximum:100
+.RE
+.PP
 .SH SEE ALSO
 .BR @IMAGEX_PROGNAME@ (1)
 .BR @IMAGEX_PROGNAME@-export (1)
+.BR @IMAGEX_PROGNAME@-verify (1)