Split WIM mount and split WIM documentation

[wimlib] / doc / imagex-apply.1.in

diff --git a/doc/imagex-apply.1.in b/doc/imagex-apply.1.in
index b4b16eaeec7fcbe1508992b3e857797ec071ed0c..e9dd4684fd6a663daae20fb0ba6ba3e5d5387b25 100644 (file)
--- a/doc/imagex-apply.1.in
+++ b/doc/imagex-apply.1.in
@@ -16,19 +16,22 @@ image in the WIM, the name of an image in the WIM, or the keyword "all" to
 indicate that all images are to be extracted.  Use the \fBimagex info\fR (1)
 command to show what images a WIM file contains.
 
-\fBTARGET\fR specifies where to extract the WIM image(s) to.  If \fBTARGET\fR
+\fITARGET\fR specifies where to extract the WIM image(s) to.  If \fITARGET\fR
 specifies a directory, the WIM image(s) are extracted to that directory.  If
-\fBTARGET\fR specifies a non-existent file, a directory is created in that
-location and the WIM image(s) are extracted to that directory.  If \fBTARGET\fR
+\fITARGET\fR specifies a non-existent file, a directory is created in that
+location and the WIM image(s) are extracted to that directory.  If \fITARGET\fR
 specifies a regular file or block device, it is interpreted as a NTFS volume to
 which the WIM image is to be extracted.
 
+\fBimagex apply\fR supports applying images from stand-alone WIMs as well as
+split WIM.  See \fBSPLIT WIMS\fR.
+
 .SH NORMAL MODE
 
-The normal extraction mode is entered when \fBTARGET\fR is a directory or
+The normal extraction mode is entered when \fITARGET\fR is a directory or
 non-existent file.  If a single WIM image is being extracted, it will be
 extracted with the root of the image corresponding to the directory named by
-\fBTARGET\fR; or, if the keyword \fBall\fR is given, the images are extracted
+\fITARGET\fR; or, if the keyword \fBall\fR is given, the images are extracted
 into subdirectories of \fITARGET\fR that will be named after the image names,
 falling back to the image indices if there is an image with no name.
 \fITARGET\fR can specify a directory on any type of filesystem.
@@ -65,11 +68,11 @@ Short (DOS) names for files
 
 .SH NTFS MODE
 
-A special extraction mode is entered when \fBTARGET\fR is a regular file or
-block device.  \fBTARGET\fR is interpreted as an NTFS volume and opened using
+A special extraction mode is entered when \fITARGET\fR is a regular file or
+block device.  \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.  \fBIMAGE\fR may not be "all" for this action.
+contained in the WIM.  \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
 empty for the intended use cases.  A new NTFS filesystem can be created using
@@ -155,6 +158,38 @@ 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).
 
+.SH SPLIT WIMS
+
+You may use \fBimagex apply\fR to apply images from a split WIM.  The
+\fIWIMFILE\fR argument is used to specify the first part of the split WIM, and
+the \fB--refs\fR="\fIGLOB\fR" option is used to provide a shell-style file glob
+that specifies the additional parts of the split WIM.  \fIGLOB\fR is expected to
+be a single string on the command line, so \fIGLOB\fR must be quoted so that it
+is protected against shell expansion.  \fIGLOB\fR must expand to all parts of
+the split WIM, except optionally the first part which may either omitted or
+included in the glob (but the first part MUST be specified as \fIWIMFILE\fR as
+well).
+
+Here's an example.  The names for the split WIMs usually go something like:
+       
+.RS
+.PP
+.nf
+mywim.swm
+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:
+.PP
+.RS
+imagex apply mywim.swm 1 dir --ref="mywim*.swm"
+.RE
+.PP
+
 .SH OPTIONS
 .TP 6
 \fB--check\fR
@@ -177,11 +212,13 @@ instead.  This option is not available in the NTFS extraction mode.
 \fB--verbose\fR
 Print the path to of each file or directory within the WIM image as it is
 extracted, and some additional informational messages.
+.TP
+\fB--ref\fR="\fIGLOB\fR"
+File glob of additional split WIM parts that are part of the split WIM being
+applied.  See \fBSPLIT_WIMS\fR.
 
 .SH NOTES
 
-\fBimagex apply\fR does not yet support split WIMs.
-
 \fBimagex apply\fR calculates the SHA1 message digest of every file stream it
 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