]> wimlib.net Git - wimlib/blobdiff - doc/man1/imagex-capture.1.in
imagex-capture.1.in: Update
[wimlib] / doc / man1 / imagex-capture.1.in
index 465b01b092698f0342bab9aca16f2ba29877429c..6f7116da40df3d0760a9ea2018b4d9fe7cd91daf 100644 (file)
@@ -192,29 +192,20 @@ a WIM file created with \fB@IMAGEX_PROGNAME@ capture\fR, while a WIM file
 updated with \fB@IMAGEX_PROGNAME@ append\fR will be written with an integrity
 table if and only if one was present before.
 .TP
-\fB--compress\fR=\fITYPE\fR
-Specifies the compression type for the new WIM file.  This flag is only valid
-for \fB@IMAGEX_PROGNAME@ capture\fR, since the compression mode for
-\fB@IMAGEX_PROGNAME@ append\fR must be the same as that of the existing
-WIM (and is automatically set as such).  \fITYPE\fR may be "none",
-"fast", or "maximum".  As of wimlib v1.5.3, the default is LZX compression, but
-in a special mode that is somewhere in between "fast" and "maximum" in terms of
-speed and compression ratio.  Use \fB--compress\fR=\fImaximum\fR to explicitly
-request a better compression ratio at the cost of more time spent compressing.
-.IP ""
-You may also specify the actual names of the compression algorithms, "XPRESS"
-and "LZX", instead of "fast" and "maximum", respectively.
-.IP ""
-As of wimlib v1.6.0, a third compression type, "recovery" or "LZMS", is also
-available.  Its use is generally not recommended because other than wimlib
-itself, it is only compatible with WIMGAPI Windows 8 and later, and DISM Windows
-8.1 and later.  However, LZMS is the compression algorithm used by default in
-packed resources created if the \fB--pack-streams\fR option is specified.
-.TP
-\fB--compress-slow\fR
-Spend even more time compressing the data to achieve a very slightly better
-compression ratio.  This currently only has an effect for LZX ("maximum", the
-default) and LZMS ("recovery") compression.
+\fB--compress\fR=\fITYPE\fR[:\fILEVEL\fR]
+Specifies the compression format for the new WIM file.  \fITYPE\fR may be
+"none", "XPRESS" (alias: "fast"), "LZX" (alias: "maximum"), or "LZMS" (alias:
+"recovery").  \fITYPE\fR is matched case-insensitively.  The default is "LZX".
+.IP ""
+You can optionally also specify an integer compression \fILEVEL\fR.  The
+compression level specifies how hard the compression algorithm for the specified
+compression \fITYPE\fR will work to compress the data.  The values are scaled so
+that 20 is quick compression, 50 is medium compression, and 100 is high
+compression.  However, you can choose any value, and not just these particular
+values.  The default is 50.
+.IP ""
+Be careful if you choose LZMS compression.  It is not compatible with wimlib
+before v1.6.0, WIMGAPI before Windows 8, DISM before Windows 8.1, and 7-Zip.
 .TP
 \fB--chunk-size\fR=\fISIZE\fR
 Set the WIM compression chunk size to \fISIZE\fR bytes.  Larger chunks mean larger
@@ -225,7 +216,7 @@ decide to use this option regardless, you may choose a chunk size that is
 allowed by the compression format.  All formats only allow power-of-2 chunk
 sizes.  For LZX ("maximum") compression the maximum allowed chunk size is 2^21
 (2097152), for XPRESS ("fast") compression the maximum allowed chunk size is
-2^26 (67108864), and for LZMS ("recovery") compression the maximum allowed chunk
+2^16 (65536), and for LZMS ("recovery") compression the maximum allowed chunk
 size is 2^30 (1073741824).
 .IP ""
 Beware that Microsoft's implementation has limited support for non-default chunk
@@ -234,7 +225,7 @@ open it and crash, or open it and report the data is invalid, or even extract
 the data incorrectly.  In addition, wimlib versions before 1.6.0 do not support
 alternate chunk sizes.
 .TP
-\fB--pack-streams\fR, \fB--solid\fR
+\fB--solid\fR
 Create a "solid" archive that compresses multiple unique streams ("files")
 together, rather than each unique stream ("file") independently.  This can
 result in a significantly better compression ratio, but this format greatly
@@ -243,23 +234,21 @@ mounted with \fB@IMAGEX_PROGNAME@ mount\fR.  Also, WIMs created using this
 option use a different version number in their header and are only compatible
 with WIMGAPI Windows 8 and later, and DISM Windows 8.1 and later.
 .IP ""
-The default compression type and chunk size in packed resources is LZMS with
-2^26 (67108864) byte chunks.  This is independent of the WIM's main compression
-type and chunk size.
+The default compression type and chunk size in solid blocks is LZMS with 2^25
+(33554432) byte chunks.  This is independent of the WIM's main compression type
+and chunk size.
 .TP
-\fB--pack-chunk-size\fR=\fISIZE\fR, \fB--solid-chunk-size\fR=\fISIZE\fR
-Like \fB--chunk-size\fR, but set the chunk size used in packed resources.  The
-default is LZMS compression with 2^26 (67108864) byte chunks.  This option only
-has an effect when \fB--pack-streams\fR is also specified.  For maximum
-compatibility with the Microsoft implementation, do not use either of these
-options.
+\fB--solid-chunk-size\fR=\fISIZE\fR
+Like \fB--chunk-size\fR, but set the chunk size used in solid blocks.  The
+default is LZMS compression with 2^25 (33554432) byte chunks.  This option only
+has an effect when \fB--solid\fR is also specified.  For maximum compatibility
+with the Microsoft implementation, do not use either of these options.
 .TP
-\fB--pack-compress\fR=\fITYPE\fR, \fB--solid-compress\fR=\fITYPE\fR
-Like \fB--compress\fR, but set the compression format used in packed resources.
-The default is LZMS compression with 2^26 (67108864) byte chunks.  This option
-only has an effect when \fB--pack-streams\fR is also specified.  For maximum
-compatibility with the Microsoft implementation, do not use either of these
-options.
+\fB--solid-compress\fR=\fITYPE\fR[:\fILEVEL\fR]
+Like \fB--compress\fR, but set the compression type used in solid blocks.  The
+default is LZMS compression with 2^25 (33554432) byte chunks.  This option only
+has an effect when \fB--solid\fR is also specified.  For maximum compatibility
+with the Microsoft implementation, do not use either of these options.
 .TP
 \fB--threads\fR=\fINUM_THREADS\fR
 Number of threads to use for compressing data.  Default: autodetect (number of
@@ -411,15 +400,15 @@ winpe     /
 overlay        /overlay
 
 # Overlay a separate directory directly on the root of the WIM image.
-# This is only legal if there are no conflicting files.
 /data/stuff    /
 .RE
 .RE
 .fi
 .IP ""
 Subdirectories in the WIM are created as needed.  Multiple source directories
-may share the same target, which implies an overlay; however, an error is issued
-if the same file appears in different overlays to the same directory.
+may share the same target, which implies an overlay.  In the event that this
+results a nondirectory file being added to the WIM image multiple times, the
+last version (as listed in the source list file) overrides any earlier version.
 .IP ""
 File paths containing whitespace may be quoted with either single quotes or
 double quotes.  Quotes may not be escaped.
@@ -501,7 +490,7 @@ delta is being based.  The new WIM will still contain a full copy of the image
 metadata, but this is typically only a small fraction of a WIM's total size.
 .IP ""
 This option can be specified multiple times, in which case the resulting delta
-WIM will only contain streams not present in any of the specified base
+WIM will only contain streams not present in any of the specified base WIMs.
 .IP ""
 To operate on the resulting delta WIM using other commands such as
 \fB@IMAGEX_PROGNAME@ apply\fR, you must specify the delta WIM as the WIM file to
@@ -553,7 +542,7 @@ pipe after the delta WIM.
 \fB--wimboot\fR
 Mark the image as WIMBoot-compatible.  See Microsoft's
 documentation for more information about WIMBoot.  This option will, by default,
-change the compression type to XPRESS and the chunk size to 4096 bytes; these
+set the compression type to XPRESS and the chunk size to 4096 bytes; these
 can, however, still be overridden through the \fB--compress\fR and
 \fB--chunk-size\fR parameters, respectively.  In addition, this option will, by
 default, set the configuration file to
@@ -587,24 +576,24 @@ created only if \fIWIMFILE\fR was specified as "-" (standard output) or if
 the \fB--pipable\fR flag was specified.
 .IP \[bu]
 WIMs captured with a non-default chunk size (with the \fB--chunk-size\fR option)
-or as solid archives (with the \fB--pack-streams\fR option) or with LZMS
+or as solid archives (with the \fB--solid\fR option) or with LZMS
 compression (with \fB--compress\fR=LZMS or \fB--compress\fR=recovery) have
 varying levels of compatibility with Microsoft's software.  Generally, more
 recent versions of Microsoft's software are more compatible.
 .SH EXAMPLES
-First example:  Create a new WIM 'mywim.wim' with "maximum" (LZX) compression
+First example:  Create a new WIM 'mywim.wim' with LZX ("maximum") compression
 that will contain a captured image of the directory tree 'somedir'.  Note that
 the image name need not be specified and will default to 'somedir':
 .RS
 .PP
-@IMAGEX_PROGNAME@ capture somedir mywim.wim --compress=maximum
+@IMAGEX_PROGNAME@ capture somedir mywim.wim
 .RE
 .PP
 or, if the \fBwimcapture\fR hard link or batch file has been installed, the
 abbreviated form can be used:
 .RS
 .PP
-wimcapture somedir mywim.wim --compress=maximum
+wimcapture somedir mywim.wim
 .RE
 .PP
 The remaining examples will use the long form, however.  Next, append the image
@@ -616,7 +605,7 @@ of a different directory tree to the WIM created above:
 .PP
 Easy enough, and the above examples of imaging directory trees work on both
 UNIX-like systems and Windows.  Next, capture a WIM with several non-default
-options, including "fast" (XPRESS) compression, an integrity table, no messing
+options, including XPRESS ("fast") compression, an integrity table, no messing
 with absolute symbolic links, and an image name and description:
 .RS
 .PP