Add 'wimlib-imagex verify' command
[wimlib] / doc / man1 / imagex-optimize.1.in
1 .TH WIMLIB-IMAGEX "1" "June 2014" "@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 [\fIOPTION\fR...]
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 This command is also available as simply \fBwimoptimize\fR if the appropriate
14 hard link or batch file has been installed.
15 .SH OPTIONS
16 .TP 6
17 \fB--check\fR
18 When reading \fIWIMFILE\fR, verify its integrity if an integrity table is
19 present.  In addition, include an integrity table in the optimized WIM.  If this
20 option is not specified, by default the integrity table (if present) is not
21 checked, and an integrity table is included in the rebuilt WIM if and only if
22 one was present in the original WIM.
23 .TP
24 \fB--nocheck\fR
25 Neither verify the integrity of \fIWIMFILE\fR using the integrity table, nor
26 include an integrity table in the rebuilt WIM file.
27 .TP
28 \fB--recompress\fR
29 Recompress all compressed streams in \fIWIMFILE\fR when rebuilding it.  This
30 will increase the time needed to rebuild the WIM, unless the WIM is
31 uncompressed, but it may result in a better compression ratio if wimlib can do a
32 better job than the program that wrote the original file.  A side effect of this
33 is that every stream in the original WIM will be checksummed, so this can help
34 verify that the WIM is intact (equivalent to applying all the images from it).
35 .TP
36 \fB--compress\fR=\fITYPE\fR[:\fILEVEL\fR]
37 Recompress the WIM file using the specified compression type, and optionally the
38 specified compression level for that compression type.  This implies
39 \fB--recompress\fR.
40 .IP ""
41 See the documentation for this option to \fB@IMAGEX_PROGNAME@ capture\fR (1) for
42 more details.
43 .TP
44 \fB--chunk-size\fR=\fISIZE\fR
45 Set the WIM compression chunk size to \fISIZE\fR.  See the documentation for
46 this option to \fB@IMAGEX_PROGNAME@ capture\fR (1) for more details.
47 .TP
48 \fB--solid\fR
49 Create a "solid" archive that compresses multiple files together.  This can
50 result in a higher compression ratio, but has disadvantages such as reduced
51 compatibility.  See the documentation for this option to \fB@IMAGEX_PROGNAME@
52 capture\fR (1) for more details.
53 .TP
54 \fB--solid-chunk-size\fR=\fISIZE\fR
55 Like \fB--chunk-size\fR, but set the chunk size used in solid blocks.  See the
56 documentation for this option to \fB@IMAGEX_PROGNAME@ capture\fR (1) for more
57 details.
58 .TP
59 \fB--solid-compress\fR=\fITYPE\fR[:\fILEVEL\fR]
60 Like \fB--compress\fR, but set the compression type used in solid blocks.  See
61 the documentation for this option to \fB@IMAGEX_PROGNAME@ capture\fR (1) for
62 more details.
63 .TP
64 \fB--threads\fR=\fINUM_THREADS\fR
65 Number of threads to use for compressing data.  Default: autodetect (number of
66 processors).  This parameter is only meaningful when \fB--recompress\fR is also
67 specified.
68 .TP
69 \fB--pipable\fR
70 Rebuild the WIM so that it can be applied fully sequentially, including from a
71 pipe.  See \fB@IMAGEX_PROGNAME@ capture\fR(1) for more details about creating
72 pipable WIMs.  By default, when neither \fB--pipable\fR or \fB--not-pipable\fR
73 is specified, the rebuilt WIM will be pipable if and only if it was already
74 pipable.
75 .TP
76 \fB--not-pipable\fR
77 Rebuild the WIM in the non-pipable format.  (This is the default if
78 \fIWIMFILE\fR is not pipable.)
79 .SH NOTES
80 \fB@IMAGEX_PROGNAME@ optimize\fR does not support split WIMs.
81 .PP
82 \fB@IMAGEX_PROGNAME@ optimize\fR is roughly equivalent to:
83 .RS
84 .PP
85 \fB@IMAGEX_PROGNAME@ export\fR \fIWIMFILE\fR all tmp.wim && mv tmp.wim \fIWIMFILE\fR
86 .RE
87 .PP
88 .SH SEE ALSO
89 .BR @IMAGEX_PROGNAME@ (1)
90 .BR @IMAGEX_PROGNAME@-export (1)
91 .BR @IMAGEX_PROGNAME@-verify (1)