Source list mode

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

diff --git a/doc/imagex-optimize.1.in b/doc/imagex-optimize.1.in
index 779c7f374ce1942a2c5c3d6f33aae9f04d8eb736..c21585cd81f352f1e3919cdc911298de9a48fbb8 100644 (file)
--- a/doc/imagex-optimize.1.in
+++ b/doc/imagex-optimize.1.in
@@ -1,4 +1,4 @@
-.TH IMAGEX "1" "December 2012" "imagex (wimlib) wimlib @VERSION@" "User Commands"
+.TH IMAGEX "1" "March 2013" "imagex (wimlib) wimlib @VERSION@" "User Commands"

 .SH NAME
 imagex-optimize \- Optimize a WIM archive
 
 .SH NAME
 imagex-optimize \- Optimize a WIM archive
 


@@ -20,15 +20,21 @@ In addition, some errors in the original WIM may be fixed by re-writing it
 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,
 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 before.
+even if there was one in the original WIM.

 .TP 6
 \fB--recompress\fR
 Recompress all compressed streams in \fIWIMFILE\fR when rebuilding it.  This
 .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).
+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).
+
+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.

 
 .SH NOTES
 
 
 .SH NOTES