Update version to 1.4.2
[wimlib] / doc / imagex-optimize.1.in
1 .TH IMAGEX "1" "June 2013" "@IMAGEX_PROGNAME@ @VERSION@" "User Commands"
2 .SH NAME
3 @IMAGEX_PROGNAME@-optimize \- Optimize a WIM archive
4 .SH SYNOPSIS
5 \fB@IMAGEX_PROGNAME@ optimize\fR \fIWIMFILE\fR [--check] [--recompress]
6 .SH DESCRIPTION
7 \fB@IMAGEX_PROGNAME@ optimize\fR will rebuild the stand-alone WIM \fIWIMFILE\fR.  The new
8 WIM is written to a temporary file, and it is renamed to the original file when
9 it's ready.  This action will remove any holes that have been left as a result
10 of appending images, so the new WIM may be slightly smaller than the old WIM.
11 In addition, some errors in the original WIM may be fixed by re-writing it
12 (although most cannot).
13 .SH OPTIONS
14 .TP 6
15 \fB--check\fR
16 When reading \fIWIMFILE\fR, verify its integrity if the integrity table is
17 present; in addition, include an integrity table in the optimized WIM.  If this
18 option is not specified, no integrity table is included in the optimized WIM,
19 even if there was one in the original WIM.
20 .TP
21 \fB--recompress\fR
22 Recompress all compressed streams in \fIWIMFILE\fR when rebuilding it.  This
23 will increase the time needed to rebuild the WIM, unless the WIM is
24 uncompressed, but it may result in a better compression ratio if wimlib can do a
25 better job than the program that wrote the original file.  A side effect of this
26 is that every stream in the original WIM will be checksummed, so this can help
27 verify that the WIM is intact (equivalent to applying all the images from it).
28 .IP ""
29 Note: as mentioned in the README, wimlib generally provides a slightly better
30 XPRESS compression ratio than Microsoft's software, while it generally provides
31 a slightly worse LZX compression ratio than Microsoft's software.  So, you may
32 not want to specify \fB--recompress\fR when optimizing a LZX-compressed WIM
33 created on Windows with Microsoft's ImageX.
34 .TP
35 \fB--threads\fR=\fINUM_THREADS\fR
36 Number of threads to use for compressing data.  Default: autodetect (number of
37 processors).  This parameter is only meaningful when \fB--recompress\fR is also
38 specified.
39 .SH NOTES
40 \fB@IMAGEX_PROGNAME@ optimize\fR does not support split WIMs.
41 .PP
42 \fB@IMAGEX_PROGNAME@ optimize\fR is roughly equivalent to:
43 .RS
44 .PP
45 \fB@IMAGEX_PROGNAME@ export\fR \fIWIMFILE\fR all tmp.wim [--check] && mv tmp.wim \fIWIMFILE\fR
46 .RE
47 .PP
48 .SH SEE ALSO
49 .BR @IMAGEX_PROGNAME@ (1)
50 .BR @IMAGEX_PROGNAME@-export (1)