system compression: force XPRESS4K on files accessed by Windows bootloader

[wimlib] / doc / man1 / wimlib-imagex-apply.1

diff --git a/doc/man1/wimlib-imagex-apply.1 b/doc/man1/wimlib-imagex-apply.1
index 64067b25f858b76768b9875be4555a58cfd9cf1e..b12f8fdb334c5606a86a46e6e91c7a85649e16d2 100644 (file)
--- a/doc/man1/wimlib-imagex-apply.1
+++ b/doc/man1/wimlib-imagex-apply.1
@@ -1,4 +1,4 @@
-.TH WIMLIB-IMAGEX "1" "May 2015" "wimlib 1.8.1" "User Commands"
+.TH WIMLIB-IMAGEX "1" "August 2015" "wimlib 1.8.2" "User Commands"

 .SH NAME
 wimlib-imagex-apply \- Extract one image, or all images, from a WIM archive
 .SH SYNOPSIS
 .SH NAME
 wimlib-imagex-apply \- Extract one image, or all images, from a WIM archive
 .SH SYNOPSIS


@@ -389,16 +389,21 @@ created when \fBwimlib-imagex capture\fR is run with the \fB--wimboot\fR
 option.
 .TP
 \fB--compact\fR=\fIFORMAT\fR
 option.
 .TP
 \fB--compact\fR=\fIFORMAT\fR

-EXPERIMENTAL and only works on Windows 10 or later: compress the extracted files
-using the System Compression feature, when possible.  System Compression is only
-supported by Windows 10 or later.  Several different compression formats may be
-used with System Compression, and one must be specified as \fIFORMAT\fR.  The
-choices are: xpress4k, xpress8k, xpress16k, and lzx.
+EXPERIMENTAL, Windows-only: compress the extracted files using System
+Compression, when possible.  This only works on either Windows 10 or later, or
+on an older Windows to which Microsoft's wofadk.sys driver has been added.
+Several different compression formats may be used with System Compression, and
+one must be specified as \fIFORMAT\fR.  The choices are: xpress4k, xpress8k,
+xpress16k, and lzx.

 .IP ""
 Exclusions are handled in the same way as with the \fB--wimboot\fR option.
 That is: if it exists, the [PrepopulateList] section of the file
 \\Windows\\System32\\WimBootCompress.ini in the WIM image will be read, and
 files matching any of the patterns in this section will not be compressed.
 .IP ""
 Exclusions are handled in the same way as with the \fB--wimboot\fR option.
 That is: if it exists, the [PrepopulateList] section of the file
 \\Windows\\System32\\WimBootCompress.ini in the WIM image will be read, and
 files matching any of the patterns in this section will not be compressed.

+In addition, wimlib has a hardcoded list of files which it knows to, for
+compatibility with the Windows bootloader which only supports
+XPRESS4K-compressed files, always extract using either XPRESS4K or no
+compression.

 .SH NOTES
 \fIData integrity\fR:  WIM files include SHA1 message digests for file data.
 \fBwimlib-imagex apply\fR calculates the SHA1 message digest of every file
 .SH NOTES
 \fIData integrity\fR:  WIM files include SHA1 message digests for file data.
 \fBwimlib-imagex apply\fR calculates the SHA1 message digest of every file