imagex-optimize.1.in: Note compression ratio
authorEric Biggers <ebiggers3@gmail.com>
Mon, 31 Dec 2012 22:42:44 +0000 (16:42 -0600)
committerEric Biggers <ebiggers3@gmail.com>
Mon, 31 Dec 2012 22:42:44 +0000 (16:42 -0600)
doc/imagex-optimize.1.in

index a229ec7..bcbcd82 100644 (file)
@@ -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,
-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
-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