Remove support for --with-imagex-progname configure option

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

diff --git a/doc/man1/imagex-optimize.1.in b/doc/man1/imagex-optimize.1.in
index 67894196b0638ba265a956bab9bfc03cd48908b5..338fdaed091e1f10c906941d5349f7641e03db0c 100644 (file)
--- a/doc/man1/imagex-optimize.1.in
+++ b/doc/man1/imagex-optimize.1.in
@@ -1,15 +1,18 @@
-.TH WIMLIB-IMAGEX "1" "June 2014" "@IMAGEX_PROGNAME@ @VERSION@" "User Commands"
+.TH WIMLIB-IMAGEX "1" "November 2014" "wimlib-imagex @VERSION@" "User Commands"

 .SH NAME
 .SH NAME

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

 .SH SYNOPSIS
 .SH SYNOPSIS

-\fB@IMAGEX_PROGNAME@ optimize\fR \fIWIMFILE\fR [\fIOPTION\fR...]
+\fBwimlib-imagex optimize\fR \fIWIMFILE\fR [\fIOPTION\fR...]

 .SH DESCRIPTION
 .SH DESCRIPTION

-\fB@IMAGEX_PROGNAME@ optimize\fR will rebuild the stand-alone WIM \fIWIMFILE\fR.  The new
+\fBwimlib-imagex 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.

-In addition, some errors in the original WIM may be fixed by re-writing it
-(although most cannot).
+.PP
+By default, compressed data will be re-used, and not recompressed.  Use the
+\fB--recompress\fR or \fB--compress\fR=\fITYPE\fR[:\fILEVEL\fR] option to
+request recompression.
+.PP

 This command is also available as simply \fBwimoptimize\fR if the appropriate
 hard link or batch file has been installed.
 .SH OPTIONS
 This command is also available as simply \fBwimoptimize\fR if the appropriate
 hard link or batch file has been installed.
 .SH OPTIONS


@@ -27,48 +30,46 @@ include an integrity table in the rebuilt WIM file.
 .TP
 \fB--recompress\fR
 Recompress all compressed streams in \fIWIMFILE\fR when rebuilding it.  This
 .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
-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 greatly increase the time needed to rebuild the WIM file, but it may result
+in a better compression ratio if wimlib can do a better job than the program
+that wrote the original file.

 .TP
 .TP

-\fB--compress\fR=\fITYPE\fR[:\fILEVEL\fR
+\fB--compress\fR=\fITYPE\fR[:\fILEVEL\fR]

 Recompress the WIM file using the specified compression type, and optionally the
 specified compression level for that compression type.  This implies
 \fB--recompress\fR.
 .IP ""
 Recompress the WIM file using the specified compression type, and optionally the
 specified compression level for that compression type.  This implies
 \fB--recompress\fR.
 .IP ""

-See the documentation for this option to \fB@IMAGEX_PROGNAME@ capture\fR (1) for
+See the documentation for this option to \fBwimlib-imagex capture\fR (1) for

 more details.
 .TP
 \fB--chunk-size\fR=\fISIZE\fR
 Set the WIM compression chunk size to \fISIZE\fR.  See the documentation for
 more details.
 .TP
 \fB--chunk-size\fR=\fISIZE\fR
 Set the WIM compression chunk size to \fISIZE\fR.  See the documentation for

-this option to \fB@IMAGEX_PROGNAME@ capture\fR (1) for more details.
+this option to \fBwimlib-imagex capture\fR (1) for more details.

 .TP
 \fB--solid\fR
 Create a "solid" archive that compresses multiple files together.  This can
 result in a higher compression ratio, but has disadvantages such as reduced
 .TP
 \fB--solid\fR
 Create a "solid" archive that compresses multiple files together.  This can
 result in a higher compression ratio, but has disadvantages such as reduced

-compatibility.  See the documentation for this option to \fB@IMAGEX_PROGNAME@
+compatibility.  See the documentation for this option to \fBwimlib-imagex

 capture\fR (1) for more details.
 .TP
 \fB--solid-chunk-size\fR=\fISIZE\fR
 Like \fB--chunk-size\fR, but set the chunk size used in solid blocks.  See the
 capture\fR (1) for more details.
 .TP
 \fB--solid-chunk-size\fR=\fISIZE\fR
 Like \fB--chunk-size\fR, but set the chunk size used in solid blocks.  See the

-documentation for this option to \fB@IMAGEX_PROGNAME@ capture\fR (1) for more
+documentation for this option to \fBwimlib-imagex capture\fR (1) for more

 details.
 .TP
 \fB--solid-compress\fR=\fITYPE\fR[:\fILEVEL\fR]
 Like \fB--compress\fR, but set the compression type used in solid blocks.  See
 details.
 .TP
 \fB--solid-compress\fR=\fITYPE\fR[:\fILEVEL\fR]
 Like \fB--compress\fR, but set the compression type used in solid blocks.  See

-the documentation for this option to \fB@IMAGEX_PROGNAME@ capture\fR (1) for
+the documentation for this option to \fBwimlib-imagex capture\fR (1) for

 more details.
 .TP
 \fB--threads\fR=\fINUM_THREADS\fR
 Number of threads to use for compressing data.  Default: autodetect (number of
 more details.
 .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.
+processors).  This parameter only has an effect when data recompression is
+requested.

 .TP
 \fB--pipable\fR
 Rebuild the WIM so that it can be applied fully sequentially, including from a
 .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
+pipe.  See \fBwimlib-imagex 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.
 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.


@@ -77,14 +78,38 @@ pipable.
 Rebuild the WIM in the non-pipable format.  (This is the default if
 \fIWIMFILE\fR is not pipable.)
 .SH NOTES
 Rebuild the WIM in the non-pipable format.  (This is the default if
 \fIWIMFILE\fR is not pipable.)
 .SH NOTES

-\fB@IMAGEX_PROGNAME@ optimize\fR does not support split WIMs.
+\fBwimlib-imagex optimize\fR does not support split WIMs.
+.PP
+\fBwimlib-imagex optimize\fR is roughly equivalent to:
+.RS
+.PP
+\fBwimlib-imagex export\fR \fIWIMFILE\fR all tmp.wim && mv tmp.wim \fIWIMFILE\fR
+.RE
+.PP
+.SH EXAMPLES
+Rebuild the WIM file 'install.wim':
+.RS
+.PP
+wimoptimize install.wim
+.RE
+.PP
+Rebuild and recompress the WIM file 'install.wim':
+.RS
+.PP
+wimoptimize install.wim --recompress
+.RE

 .PP
 .PP

-\fB@IMAGEX_PROGNAME@ optimize\fR is roughly equivalent to:
+Rebuild and recompress the WIM file 'install.wim', using "maximum" (LZX)
+compression at a higher-than-default compression level.  The compression chunk
+size remains unchanged.  This command will be slow, but it might be useful for
+optimizing files for distribution.  See the COMPRESSION RATIO section of the
+README file for some benchmark results.

 .RS
 .PP
 .RS
 .PP

-\fB@IMAGEX_PROGNAME@ export\fR \fIWIMFILE\fR all tmp.wim && mv tmp.wim \fIWIMFILE\fR
+wimoptimize install.wim --compress=maximum:100

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

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