]> wimlib.net Git - wimlib/blobdiff - doc/man1/wimlib-imagex-apply.1
Document xattr support
[wimlib] / doc / man1 / wimlib-imagex-apply.1
index 1245b7ba4865f93c23293fffc705078d64af459e..48865ba8f68fa15bf650e1b1b3b919b674d0b678 100644 (file)
@@ -1,4 +1,4 @@
-.TH WIMLIB-IMAGEX "1" "January 2016" "wimlib 1.9.0" "User Commands"
+.TH WIMLIB-IMAGEX "1" "August 2016" "wimlib 1.10.0" "User Commands"
 .SH NAME
 wimlib-imagex-apply \- Extract one image, or all images, from a WIM archive
 .SH SYNOPSIS
@@ -63,7 +63,7 @@ Named data streams.
 .IP \[bu]
 Reparse points other than symbolic links and junction points.
 .IP \[bu]
-Certain file attributes such as compression, encryption, and sparseness.
+Certain file attributes such as compression and encryption.
 .IP \[bu]
 Short (DOS) names for files.
 .IP \[bu]
@@ -121,12 +121,8 @@ 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]
-Sparse file attributes will not be extracted.
+However, a limitation of the NTFS volume extraction mode is that encrypted files
+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
@@ -190,8 +186,6 @@ 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,
@@ -305,9 +299,9 @@ UNIX-like systems.
 \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.  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.
+the \fB--unix-data\fR option.  Since wimlib v1.7.0, device nodes, named pipes,
+and socket files are also restored correctly.  Since wimlib v1.11.0, on Linux
+extended attributes are also restored.
 .TP
 \fB--no-acls\fR
 Do not restore security descriptors on extracted files and directories.
@@ -337,15 +331,20 @@ byte except '\\0' and \'/', so on a POSIX-compliant system this option will only
 have an effect in the unlikely case that the WIM image for some reason has a
 filename containing one of these characters.
 .IP ""
-On Windows, filenames are case-insensitive, cannot include the characters '/',
-\'\\0', '\\', ':', '*', '?', '"', '<', '>', or '|', and cannot end with a space
-or period.  Ordinarily, files in WIM images should meet these conditions as
-well. However, it is not guaranteed, and in particular a WIM image captured with
-\fBwimlib-imagex\fR on a POSIX-compliant system could contain such files.  By
-default, invalid names will be ignored, and if there are multiple names
-differing only in case, one will be chosen to extract arbitrarily; however, with
-\fB--include-invalid-names\fR, all names will be sanitized and extracted in some
-form.
+On Windows, filenames are case-insensitive(*), cannot include control
+characters, and cannot include the characters '/', \'\\0', '\\', ':', '*', '?',
+\'"', '<', '>', or '|'.  Ordinarily, files in WIM images should meet these
+conditions as well. However, it is not guaranteed, and in particular a WIM image
+captured with \fBwimlib-imagex\fR on a POSIX-compliant system could contain such
+files.  By default, invalid names will be ignored, and if there are multiple
+names differing only in case, one will be chosen to extract arbitrarily;
+however, with \fB--include-invalid-names\fR, all names will be sanitized and
+extracted in some form.
+.IP ""
+(*) Unless the ObCaseInsensitive setting has been set to 0 in the Windows
+registry, in which case certain software, including the Windows version of
+\fBwimlib-imagex\fR, will honor case-sensitive filenames on NTFS and other
+compatible filesystems.
 .TP
 \fB--wimboot\fR
 Windows only: Instead of extracting the files themselves, extract "pointer
@@ -365,9 +364,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
@@ -456,7 +454,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