Fix sequential extraction, and include progress info
[wimlib] / doc / imagex-optimize.1.in
1 .TH IMAGEX "1" "November 2012" "imagex (wimlib) wimlib @VERSION@" "User Commands"
2 .SH NAME
3 imagex-optimize \- Optimize a WIM archive
4
5 .SH SYNOPSIS
6 \fBimagex optimize\fR \fIWIMFILE\fR [--check] [--recompress]
7
8 .SH DESCRIPTION
9 .PP
10 \fBimagex 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; include an integrity table in the optimized WIM.  If this option is not
22 specified and \fIWIMFILE\fR, no integrity table is included in the optimized
23 WIM, even if there was one before.
24 .TP 6
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 uncompressed,
28 but it may result in a better compression ratio if wimlib can do a better job
29 than the program that wrote the original file.  A side effect of this is that
30 every stream in the original WIM will be checksummed, so this can help verify
31 that the WIM is intact (equivalent to applying all the images from it).
32
33 .SH NOTES
34
35 \fBimagex optimize\fR does not support split WIMs.
36
37 .SH SEE ALSO
38 .BR imagex (1)
39