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 78861770239ad890c1d138a69457bf9f841384ea..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" "February 2015" "wimlib 1.8.0" "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
@@ -347,9 +347,9 @@ form.
 .TP
 \fB--wimboot\fR
 Windows only: Instead of extracting the files themselves, extract "pointer
-files" back to the WIM archive.  This can result in significant space savings.
+files" back to the WIM archive(s).  This can result in significant space savings.
 However, it comes at several potential costs, such as not being able to delete
-the WIM archive and possibly having slower access to files.  See Microsoft's
+the WIM archive(s) and possibly having slower access to files.  See Microsoft's
 documentation for "WIMBoot" for more information.
 .IP ""
 If it exists, the [PrepopulateList] section of the file
@@ -387,6 +387,23 @@ WIM files that use XPRESS chunks of size 8192, 16384, and 32768, or LZX chunks
 of size 32768, in addition to the default XPRESS chunks of size 4096 that are
 created when \fBwimlib-imagex capture\fR is run with the \fB--wimboot\fR
 option.
+.TP
+\fB--compact\fR=\fIFORMAT\fR
+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.
+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