]> wimlib.net Git - wimlib/blobdiff - doc/imagex-apply.1.in
imagex-apply.1.in: Update
[wimlib] / doc / imagex-apply.1.in
index 3d982a7bd2aa5d96ee75a74024b0365e863eadf4..3eb5644eca8e28351d3fb89cd491ac1d4afe18b5 100644 (file)
@@ -1,6 +1,6 @@
-.TH IMAGEX "1" "October 2012" "imagex (wimlib) wimlib @VERSION@" "User Commands"
+.TH IMAGEX "1" "January 2013" "imagex (wimlib) wimlib @VERSION@" "User Commands"
 .SH NAME
-imagex apply \- Extract one image, or all images, from a WIM archive
+imagex-apply \- Extract one image, or all images, from a WIM archive
 
 .SH SYNOPSIS
 \fBimagex apply\fR \fIWIMFILE\fR \fIIMAGE\fR \fITARGET\fR [\fIOPTION\fR]...
@@ -42,7 +42,7 @@ the WIM image(s):
 .IP \[bu] 4
 The default (unnamed) data stream of each file
 .IP \[bu]
-Hard links, if supported by the underlying filesystem
+Hard links
 .IP \[bu]
 File and directory creation, access, and modification timestamps to the nearest
 microsecond, if supported by the underlying filesystem
@@ -71,8 +71,8 @@ Short (DOS) names for files
 A special extraction mode is entered when \fITARGET\fR is a regular file or
 block device.  If this is the case, \fITARGET\fR is interpreted as an NTFS
 volume and opened using libntfs-3g.  If successful, the WIM image is extracted
-to the root of the NTFS volume in a special mode that preserves all, or almost
-all, information contained in the WIM.  \fIIMAGE\fR may not be "all" for this
+to the root of the NTFS volume in a special mode that preserves almost all
+information contained in the WIM image.  \fIIMAGE\fR may not be "all" for this
 action.
 
 The NTFS volume does not need to be empty, although it's expected that it be
@@ -107,20 +107,25 @@ the WIM.
 .IP \[bu]
 File attribute flags are applied.
 .IP \[bu]
-Short (DOS) names for files are extracted.  The corresponding long name for each
-DOS name is made to be a Win32 name.  Any additional names for the file in the
-same directory are made to be names in the POSIX namespace.
+Short (DOS) names for non-hard-linked files are extracted.  The corresponding
+long name for each DOS name is made to be a Win32 name.  Files with multiple
+hard links are extracted with filenames in the POSIX namespace, and short names
+(if any) are ignored.  A singly-linked file with no short name is also extracted
+in the POSIX namespace.  Note that this assigning of namespaces may not be
+exactly the same as in the original filesystem that was captured, and also this
+means that some DOS names may be lost (most likely inconsequentially).
 
 .PP
 
-In the NTFS extraction mode, we restore enough information from the WIM that it
-is possible, in most cases, to restore or install an image of an actual Windows
-installation. In the examples at the end of this manual page, we show 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.
+Since almost all information from the WIM image is restored in the NTFS
+extraction mode, it is possible to restore an image of an actual Windows
+installation. 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.
 
-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
+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
@@ -181,10 +186,9 @@ mywim2.swm
 mywim3.swm
 mywim4.swm
 mywim5.swm
-\. ... etc.
 .RE
 
-To apply the first image of this split WIM to the directory "dir", we would do:
+To apply the first image of this split WIM to the directory "dir", run:
 .PP
 .RS
 imagex apply mywim.swm 1 dir --ref="mywim*.swm"
@@ -199,12 +203,11 @@ present.
 .TP
 \fB--hardlink\fR
 When extracting a file from the WIM that is identical to a file that has already
-extracted, create a hard link using \fBlink\fR (3) rather than creating a
-separate file.  This option causes all identical files to be hard-linked,
-overriding the hard link groups that are specified in the WIM image(s).  In the
-case of extracting all images from the WIM, files may be hard-linked even if
-they are in different WIM images.  This option is not available in the NTFS
-extraction mode.
+extracted, create a hard link rather than creating a separate file.  This option
+causes all identical files to be hard-linked, overriding the hard link groups
+that are specified in the WIM image(s).  In the case of extracting all images
+from the WIM, files may be hard-linked even if they are in different WIM images.
+This option is not available in the NTFS extraction mode.
 .TP
 \fB--symlink\fR
 This option is similar to \fB--hardlink\fR, except symbolic links are created
@@ -225,12 +228,15 @@ extracts and verifies that it is the same as the SHA1 message digest provided in
 the WIM file.  It is an error if the message digests don't match.  It's also
 considered to be an error if any WIM resources cannot be found in the stream
 lookup table.  So you can be fairly certain that the file streams are extracted
-correctly, even though we don't provide a \fB/verify\fR option like Microsoft's
-version of imagex does.  Please note that this is separate from the integrity
-table of the WIM, which provides SHA1 message digests over raw chunks of the
-entire WIM file and is checked separately if the \fB--check\fR option is
+correctly, even though \fBimagex apply\fR don't have a \fB/verify\fR option like
+Microsoft's version of imagex does.  Please note that this is separate from the
+integrity table of the WIM, which provides SHA1 message digests over raw chunks
+of the entire WIM file and is checked separately if the \fB--check\fR option is
 specified.
 
+You cannot use \fBimagex apply\fR to apply a WIM from a pipe (such as standard
+input) because the WIM file format is not designed for this.
+
 .SH EXAMPLES
 .SS Normal extraction mode
 Extract the first image from the Windows PE image from the Windows Vista/7/8
@@ -248,10 +254,10 @@ image apply /media/windows8/sources/boot.wim all boot --hardlink
 .RE
 .PP
 .SS NTFS extraction mode
-Verbosely apply a WIM image to a NTFS filesystem image:
+Apply a WIM image to a NTFS filesystem image:
 .RS
 .PP
-imagex apply mywim.wim 1 fsimage.ntfs --verbose
+imagex apply mywim.wim 1 fsimage.ntfs
 .RE
 .PP
 Create a new NTFS filesystem on the partition /dev/sda2 and apply the first