-.TH IMAGEX "1" "January 2013" "imagex (wimlib) wimlib @VERSION@" "User Commands"
+.TH WIMLIB-IMAGEX "1" "December 2013" "@IMAGEX_PROGNAME@ @VERSION@" "User Commands"
.SH NAME
-imagex-optimize \- Optimize a WIM archive
-
+@IMAGEX_PROGNAME@-optimize \- Optimize a WIM archive
.SH SYNOPSIS
-\fBimagex optimize\fR \fIWIMFILE\fR [--check] [--recompress]
-
+\fB@IMAGEX_PROGNAME@ optimize\fR \fIWIMFILE\fR [\fIOPTION\fR...]
.SH DESCRIPTION
-.PP
-\fBimagex optimize\fR will rebuild the stand-alone WIM \fIWIMFILE\fR. The new
+\fB@IMAGEX_PROGNAME@ optimize\fR will rebuild the stand-alone WIM \fIWIMFILE\fR. The new
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).
-
+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 the integrity table is
-present; in addition, include an integrity table in the optimized WIM. If this
-option is not specified, no integrity table is included in the optimized WIM,
-even if there was one in the original WIM.
-.TP 6
+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, 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
+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
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).
-
-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.
-
+.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.
+.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
+processors). This parameter is only meaningful when \fB--recompress\fR is also
+specified.
+.TP
+\fB--pipable\fR
+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
+pipable.
+.TP
+\fB--not-pipable\fR
+Rebuild the WIM in the non-pipable format. (This is the default if
+\fIWIMFILE\fR is not pipable.)
.SH NOTES
-
-\fBimagex optimize\fR does not support split WIMs.
-
-\fBimagex optimize\fR is roughly equivalent to:
+\fB@IMAGEX_PROGNAME@ optimize\fR does not support split WIMs.
+.PP
+\fB@IMAGEX_PROGNAME@ optimize\fR is roughly equivalent to:
.RS
.PP
-\fBimagex export\fR \fIWIMFILE\fR all tmp.wim [--check] && mv tmp.wim \fIWIMFILE\fR
+\fB@IMAGEX_PROGNAME@ export\fR \fIWIMFILE\fR all tmp.wim && mv tmp.wim \fIWIMFILE\fR
.RE
.PP
-
.SH SEE ALSO
-.BR imagex (1)
-.BR imagex-export (1)
-
+.BR @IMAGEX_PROGNAME@ (1)
+.BR @IMAGEX_PROGNAME@-export (1)
git://wimlib.net / wimlib / blobdiff