Win32 fixes

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

diff --git a/doc/imagex-optimize.1.in b/doc/imagex-optimize.1.in
index a229ec7bb5a6c75754fd53f0a326e2cbf15768d2..20041a1ef083c3705d8d1b681c1ac5f6a482bbe7 100644 (file)
--- a/doc/imagex-optimize.1.in
+++ b/doc/imagex-optimize.1.in
@@ -1,13 +1,13 @@
-.TH IMAGEX "1" "January 2013" "imagex (wimlib) wimlib @VERSION@" "User Commands"
+.TH IMAGEX "1" "March 2013" "@IMAGEX_PROGNAME@ @VERSION@" "User Commands"

 .SH NAME
 .SH NAME

-imagex-optimize \- Optimize a WIM archive
+@IMAGEX_PROGNAME@-optimize \- Optimize a WIM archive

 
 .SH SYNOPSIS
 
 .SH SYNOPSIS

-\fBimagex optimize\fR \fIWIMFILE\fR [--check] [--recompress]
+\fB@IMAGEX_PROGNAME@ optimize\fR \fIWIMFILE\fR [--check] [--recompress]

 
 .SH DESCRIPTION
 .PP
 
 .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.
 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.


@@ -20,28 +20,34 @@ 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
 

-\fBimagex optimize\fR does not support split WIMs.
+\fB@IMAGEX_PROGNAME@ optimize\fR does not support split WIMs.

 
 

-\fBimagex optimize\fR is roughly equivalent to:
+\fB@IMAGEX_PROGNAME@ optimize\fR is roughly equivalent to:

 .RS
 .PP
 .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 [--check] && mv tmp.wim \fIWIMFILE\fR

 .RE
 .PP
 
 .SH SEE ALSO
 .RE
 .PP
 
 .SH SEE ALSO

-.BR imagex (1)
-.BR imagex-export (1)
+.BR @IMAGEX_PROGNAME@ (1)
+.BR @IMAGEX_PROGNAME@-export (1)