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