wimlib.net Git - wimlib/blob - doc/imagex-optimize.1.in

   1 .TH WIMLIB-IMAGEX "1" "January 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 .IP ""
  36 Note: as of wimlib v1.5.3, wimlib's LZX compressor usually achieves the same or
  37 better compression than Microsoft's, but is slightly slower.
  38 .TP
  39 \fB--recompress-slow\fR, \fB--compress-slow\fR
  40 Spend even more time compressing the data in order to achieve a more optimal
  41 compression ratio.  For LZX ("maximum") compression, compared to the default
  42 \fB--recompress\fR this will make compression about twice as slow and may
  43 improve the compression ratio by maybe 1%, depending on the data.  For LZMS
  44 ("recovery") compression this option also has an effect.  For XPRESS ("fast")
  45 compression this option has no effect; however you may use \fB--compress\fR=LZX
  46 \fB--recompress-slow\fR to change the compression type to LZX and recompress
  47 slowly, as per this option.  In any case, this option implies
  48 \fB--recompress\fR.
  49 .TP
  50 \fB--compress\fR=\fITYPE\fR
  51 Recompress the WIM file using the specified compression type.  \fITYPE\fR may be
  52 "none", "fast" (or "XPRESS"), or "maximum" (or "LZX").  This implies
  53 \fB--recompress\fR.
  54 .IP ""
  55 \fITYPE\fR may also be "recovery" (or "LZMS"); however, this will result in
  56 reduced compatibility.  See the documentation for this option to
  57 \fB@IMAGEX_PROGNAME@ capture\fR (1) for more details.
  58 .TP
  59 \fB--chunk-size\fR=\fISIZE\fR
  60 Set the WIM compression chunk size to \fISIZE\fR.  See the documentation for
  61 this option to \fB@IMAGEX_PROGNAME@ capture\fR (1) for more details.
  62 .TP
  63 \fB--pack-streams\fR
  64 Create a "solid" archive that compresses multiple files together.  This can
  65 result in a higher compression ratio, but has disadvantages such as reduced
  66 compatibility; see the documentation for this option to
  67 \fB@IMAGEX_PROGNAME@-capture\fR (1) for more details.
  68 .TP
  69 \fB--threads\fR=\fINUM_THREADS\fR
  70 Number of threads to use for compressing data.  Default: autodetect (number of
  71 processors).  This parameter is only meaningful when \fB--recompress\fR is also
  72 specified.
  73 .TP
  74 \fB--pipable\fR
  75 Rebuild the WIM so that it can be applied fully sequentially, including from a
  76 pipe.  See \fB@IMAGEX_PROGNAME@ capture\fR(1) for more details about creating
  77 pipable WIMs.  By default, when neither \fB--pipable\fR or \fB--not-pipable\fR
  78 is specified, the rebuilt WIM will be pipable if and only if it was already
  79 pipable.
  80 .TP
  81 \fB--not-pipable\fR
  82 Rebuild the WIM in the non-pipable format.  (This is the default if
  83 \fIWIMFILE\fR is not pipable.)
  84 .SH NOTES
  85 \fB@IMAGEX_PROGNAME@ optimize\fR does not support split WIMs.
  86 .PP
  87 \fB@IMAGEX_PROGNAME@ optimize\fR is roughly equivalent to:
  88 .RS
  89 .PP
  90 \fB@IMAGEX_PROGNAME@ export\fR \fIWIMFILE\fR all tmp.wim && mv tmp.wim \fIWIMFILE\fR
  91 .RE
  92 .PP
  93 .SH SEE ALSO
  94 .BR @IMAGEX_PROGNAME@ (1)
  95 .BR @IMAGEX_PROGNAME@-export (1)