]> wimlib.net Git - wimlib/blobdiff - doc/imagex-optimize.1.in
imagex-optimize man page: fix wording
[wimlib] / doc / imagex-optimize.1.in
index 40a91ad3f79254c3599c10c476a8885e83df4aac..779c7f374ce1942a2c5c3d6f33aae9f04d8eb736 100644 (file)
@@ -1,9 +1,9 @@
-.TH IMAGEX "1" "November 2012" "imagex (wimlib) wimlib @VERSION@" "User Commands"
+.TH IMAGEX "1" "December 2012" "imagex (wimlib) wimlib @VERSION@" "User Commands"
 .SH NAME
 imagex-optimize \- Optimize a WIM archive
 
 .SH SYNOPSIS
-\fBimagex optimize\fR \fIWIMFILE\fR [--check]
+\fBimagex optimize\fR \fIWIMFILE\fR [--check] [--recompress]
 
 .SH DESCRIPTION
 .PP
@@ -16,15 +16,32 @@ In addition, some errors in the original WIM may be fixed by re-writing it
 
 .SH OPTIONS
 .TP 6
+\fB--check\fR
 When reading \fIWIMFILE\fR, verify its integrity if the integrity table is
-present; include an integrity table in the optimized WIM.  If this option is not
-specified and \fIWIMFILE\fR, no integrity table is included in the optimized
-WIM, even if there was one before.
+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 before.
+.TP 6
+\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).
 
 .SH NOTES
 
 \fBimagex optimize\fR does not support split WIMs.
 
+\fBimagex optimize\fR is roughly equivalent to:
+.RS
+.PP
+\fBimagex export\fR \fIWIMFILE\fR all tmp.wim [--check] && mv tmp.wim \fIWIMFILE\fR
+.RE
+.PP
+
 .SH SEE ALSO
 .BR imagex (1)
+.BR imagex-export (1)