X-Git-Url: https://wimlib.net/git/?p=wimlib;a=blobdiff_plain;f=doc%2Fman1%2Fwimlib-imagex-apply.1;h=0fad8dd41fbda7a1aad0e210272391e58fe6bc55;hp=78861770239ad890c1d138a69457bf9f841384ea;hb=5260cf0b5649fc25b9d69a97f9604a3be257e13e;hpb=915a3f57a0aeee1d6401fdc0e3fca5e6187ddcac diff --git a/doc/man1/wimlib-imagex-apply.1 b/doc/man1/wimlib-imagex-apply.1 index 78861770..0fad8dd4 100644 --- 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" "March 2016" "wimlib 1.9.1" "User Commands" .SH NAME wimlib-imagex-apply \- Extract one image, or all images, from a WIM archive .SH SYNOPSIS @@ -118,16 +118,15 @@ DOS/Windows file attribute flags. .IP \[bu] All names of all files, including names in the Win32 namespace, DOS namespace, Win32+DOS namespace, and POSIX namespace. This includes hard links. +.IP \[bu] +Object IDs. .PP However, there are also several known limitations of the NTFS volume extraction mode: .IP \[bu] 4 Encrypted files will not be extracted. .IP \[bu] -wimlib v1.7.0 and later: Sparse file attributes will not be extracted (same -behavior as ImageX/DISM/WIMGAPI). wimlib v1.6.2 and earlier: Although sparse -file attributes will be applied, the full data will be extracted to each sparse -file, so extracted "sparse" files may not actually contain any sparse regions. +Sparse file attributes will not be extracted. .PP Regardless, since almost all information from the WIM image is restored in this mode, it is possible (and fully supported) to restore an image of an actual @@ -175,13 +174,15 @@ descriptors for individual files or directories may be omitted or only partially set if the user does not have permission to set them, which can be a problem if \fBwimlib-imagex\fR is run as a non-Administrator. .IP \[bu] -File attributes, including hidden, sparse, compressed, encrypted, etc, when -supported by the filesystem. +File attributes, including hidden, compressed, encrypted, etc, when supported by +the filesystem. .IP \[bu] DOS names (8.3) names of files; however, the failure to set them is not considered an error condition. .IP \[bu] -Hard links, if supported by the filesystem. +Hard links, if supported by the target filesystem. +.IP \[bu] +Object IDs, if supported by the target filesystem. .PP Additional notes about extracting files on Windows: .IP \[bu] 4 @@ -189,6 +190,8 @@ Additional notes about extracting files on Windows: exact metadata and data of the WIM image, for example due to features mentioned above not being supported by the target filesystem. .IP \[bu] +Sparse file attributes will not be extracted. +.IP \[bu] Since encrypted files (with FILE_ATTRIBUTE_ENCRYPTED) are not stored in plaintext in the WIM image, \fBwimlib-imagex\fR cannot restore encrypted files to filesystems not supporting encryption. Therefore, on such filesystems, @@ -250,13 +253,13 @@ option is unneeded; instead you must ensure that all the split WIM parts are concatenated together on standard input. They can be provided in any order, with the exception of the first part, which must be first. .SH PIPABLE WIMS -As of wimlib 1.5.0, \fBwimlib-imagex apply\fR supports applying a WIM from a +Since wimlib v1.5.0, \fBwimlib-imagex apply\fR supports applying a WIM from a nonseekable file, such as a pipe, provided that the WIM was captured with -\fB--pipable\fR (see \fBwimlib-imagex capture\fR(1)). To use standard input -as the WIM, specify "-" as \fIWIMFILE\fR. A useful use of this ability is to -apply an image from a WIM while streaming it from a server. For example, to -apply the first image from a WIM file available on a HTTP server to an NTFS -volume on /dev/sda1, run something like: +\fB--pipable\fR (see \fBwimlib-imagex capture\fR(1)). To use standard input as +the WIM, specify "-" as \fIWIMFILE\fR. A useful use of this ability is to apply +an image from a WIM while streaming it from a server. For example, to apply the +first image from a WIM file available on a HTTP server to an NTFS volume on +/dev/sda1, run something like: .PP .RS wget -O - http://myserver/mywim.wim | wimapply - 1 /dev/sda1 @@ -301,11 +304,10 @@ UNIX-like systems. .TP \fB--unix-data\fR (UNIX-like systems only) Restore UNIX owners, groups, modes, and device IDs -(major and minor numbers) that were captured by \fBwimlib-imagex capture\fR -with the \fB--unix-data\fR option. As of wimlib v1.7.0, you can backup and -restore not only the standard UNIX file permission information, but also -character device nodes, block device nodes, named pipes (FIFOs), and UNIX domain -sockets. +(major and minor numbers) that were captured by \fBwimlib-imagex capture\fR with +the \fB--unix-data\fR option. Since wimlib v1.7.0, you can backup and restore +not only the standard UNIX file permission information, but also character +device nodes, block device nodes, named pipes (FIFOs), and UNIX domain sockets. .TP \fB--no-acls\fR Do not restore security descriptors on extracted files and directories. @@ -347,9 +349,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 @@ -363,9 +365,8 @@ target volume is NTFS or another filesystem that supports reparse points. .IP "" In addition, this option works best when running on Windows 8.1 Update 1 or later, since that is the first version of Windows that contains the Windows -Overlay File System Filter Driver ("WOF"). If the WOF driver is detected, -wimlib will create the WIMBoot "pointer files" using documented ioctls provided -by WOF. +Overlay Filesystem filter driver ("WOF"). If the WOF driver is detected, wimlib +will create the WIMBoot "pointer files" using documented ioctls provided by WOF. .IP "" Otherwise, if the WOF driver is not detected, wimlib will create the reparse points and edit the file "\\System Volume Information\\WimOverlay.dat" on the @@ -387,6 +388,22 @@ 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 +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 for which it knows, for +compatibility with the Windows bootloader, to override the requested compression +format. .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 @@ -438,7 +455,7 @@ wimlib-imagex apply install.wim 1 /dev/sda2 .PP Note that before running either of the above commands, an NTFS filesystem may need to be created on the partition, for example with format.exe on Windows or -\fBmkntfs\fR(8) (part of NTFS-3g) on UNIX-like systems. For example, you might +\fBmkntfs\fR(8) (part of NTFS-3G) on UNIX-like systems. For example, you might run: .RS .PP