-.TH WIMLIB-IMAGEX "1" "February 2015" "wimlib 1.8.0" "User Commands"
+.TH WIMLIB-IMAGEX "1" "May 2015" "wimlib 1.8.1" "User Commands"
.SH NAME
wimlib-imagex-apply \- Extract one image, or all images, from a WIM archive
.SH SYNOPSIS
file, so extracted "sparse" files may not actually contain any sparse regions.
.PP
Regardless, since almost all information from the WIM image is restored in this
-mode, it is possible to restore an image of an actual Windows installation using
-\fBwimlib-imagex\fR on UNIX-like systems in addition to with
-\fBwimlib-imagex\fR on Windows. In the examples at the end of this manual
-page, there is an example of applying an image from the "install.wim" file
-contained in the installation media for Windows Vista, Windows 7, and Windows 8
-in the "sources" directory.
-.PP
-But in order to actually boot Windows from an applied image, you must understand
-the boot process of Windows versions Vista and later. Basically, it is the
-following:
-.nr step 1 1
-.IP \n[step]. 3
-The Master Boot Record loads the Volume Boot Record (also called the Boot
-Sector) of the active partition, which is on an NTFS filesystem. This partition
-is called the "system partition".
-.IP \n+[step].
-The "bootmgr" program on the "system partition" is loaded (\\BOOTMGR).
-.IP \n+[step].
-bootmgr loads the Boot Configuration Data (\\Boot\\BCD) from the "system
-partition".
-.IP \n+[step].
-Based on the information contained in the Boot Configuration Data, a loader for
-the Windows kernel is executed from the "Boot" partition, which is where Windows
-is installed.
-.PP
-So let's say you applied an image from an existing "install.wim" as in the
-example, or you've applied a custom Windows image that you've created using the
-\fBwimlib-imagex capture\fR (1) command. You've just applied the "Boot" partition, or
-the main Windows partition, but there is no "System" partition yet (i.e. no
-\\BOOTMGR and no \\Boot\\BCD).
-.PP
-A "System" partition can be created created by running the "bcdboot.exe" program
-from within Windows or Windows PE. Alternatively, you can capture a separate
-WIM image containing the "System" partition. Or, the "System" partition may the
-same as the "Boot" partition, so the two "partitions" may be combined in one WIM
-image. However, as the \\Boot\\BCD file contains the Windows bootloader
-configuration, a WIM containing it can only be used on systems where you are
-setting up the same bootloader configuration, including the same partition
-layout.
-.PP
-Besides setting up the files on the "System" partition, don't forget to set the
-bootable flag on it, and have a master boot record that loads the bootable
-partition (Windows' MBR does, and SYSLINUX provides an equivalent MBR).
+mode, it is possible (and fully supported) to restore an image of an actual
+Windows installation using \fBwimlib-imagex\fR on UNIX-like systems as an
+alternative to using \fBwimlib-imagex\fR on Windows. In the examples at the end
+of this manual page, there is an example of applying an image from the
+"install.wim" file contained in the installation media for Windows (Vista or
+later) in the "sources" directory.
+.PP
+Note that to actually boot Windows (Vista or later) from an applied
+"install.wim" image, you also need to mark the partition as "bootable" and set
+up various boot files, such as \\BOOTMGR and \\BOOT\\BCD. The latter task is
+most easily accomplished by running the "bcdboot.exe" program from a live
+Windows system (such as Windows PE), but there are other options as well.
.SH DIRECTORY EXTRACTION (WINDOWS)
On Windows, \fBwimlib-imagex apply\fR and \fBwimlib-imagex extract\fR
natively support Windows-specific and NTFS-specific data. For best results, the
.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
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 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.
+.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.
.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
target drive when extracting a malicious WIM file containing files named
\fI..\fR or containing path separators.
.SH EXAMPLES
-Extract the first image from the Windows PE image on the Windows Vista/7/8
-installation media to the directory "boot":
+Extract the first image from the Windows PE image on the Windows (Vista or
+later) installation media to the directory "boot":
.RS
.PP
wimlib-imagex apply /mnt/windows/sources/boot.wim 1 boot
.RE
.PP
On Windows, apply an image of an entire volume, for example from "install.wim"
-which can be found on the Windows Vista/7/8 installation media:
+which can be found on the Windows (Vista or later) installation media:
.RS
.PP
wimlib-imagex apply install.wim 1 E:\\
git://wimlib.net / wimlib / blobdiff