X-Git-Url: https://wimlib.net/git/?p=wimlib;a=blobdiff_plain;f=doc%2Fimagex-export.1.in;h=981d7767ef53a9b01e9642b181ef6cf96ce95975;hp=63ed09d2ab2f4c73ac3335790fb0570b91a399e2;hb=88a9d8314ba480d0eb7be351581d2be183efa91e;hpb=f1153575fae2fad42e2b73ff744c25e3a8d01ad0

diff --git a/doc/imagex-export.1.in b/doc/imagex-export.1.in
index 63ed09d2..981d7767 100644
--- a/doc/imagex-export.1.in
+++ b/doc/imagex-export.1.in
@@ -1,6 +1,6 @@
-.TH IMAGEX "1" "May 2012" "imagex (wimlib) wimlib @VERSION@" "User Commands"
+.TH IMAGEX "1" "January 2013" "imagex (wimlib) wimlib @VERSION@" "User Commands"
 .SH NAME
-imagex export \- Exports an image from a WIM archive to an existing or new WIM archive
+imagex-export \- Exports an image from a WIM archive to an existing or new WIM archive
 
 .SH SYNOPSIS
 \fBimagex export\fR \fISRC_WIMFILE\fR (\fISRC_IMAGE_NUM\fR | \
@@ -29,6 +29,10 @@ If given, \fIDEST_IMAGE_DESCRIPTION\fR specifies the description to give the
 image being exported to \fIDEST_WIMFILE\fR.  The default is its description in
 \fISRC_WIMFILE\fR.
 
+\fBimagex export\fR supports exporting images from stand-alone WIMs as well as
+from split WIMs.  However, you cannot export an image to a split WIM.  See
+\fBSPLIT WIMS\fR.
+
 .SH OPTIONS
 .TP 6
 \fB--boot\fR
@@ -41,31 +45,87 @@ If multiple images are being exported, this flag indicates that the image in the
 error.
 .TP
 \fB--check\fR
-When reading \fISRC_WIMFILE\fR, verify its integrity if the integrity table is
-present; additionally, when writing \fIDEST_WIMFILE\fR with the new image added,
-write an integrity table.  If this option is not specified, no integrity table
-is included in \fIDEST_WIMFILE\fR, even if there was one before.
+When reading \fISRC_WIMFILE\fR, and \fIDEST_WIMFILE\fR if it exists, verify the
+file's integrity if the integrity table is present; additionally, when writing
+\fIDEST_WIMFILE\fR with the new image added, write an integrity table.  If this
+option is not specified, no integrity table is included in \fIDEST_WIMFILE\fR,
+even if there was one before.
 .TP
 \fB--compress\fR=\fITYPE\fR
 Specifies the compression type for \fIDEST_WIMFILE\fR.  This is only valid if
 \fIDEST_WIMFILE\fR does not yet exist, since if \fIDEST_WIMFILE\fR exists, the
 compression type must be the same as that of \fIDEST_WIMFILE\fR.
 
-\fITYPE\fR may be "none", "maximum", or "fast".  By default, it is "fast".
+\fITYPE\fR may be "none", "maximum", or "fast".  By default, it is the same as
+that of the input WIM file.
 
 You may also specify the actual names of the compression algorithms, "XPRESS"
 and "LZX", instead of "fast" and "maximum", respectively.
+.TP
+\fB--threads\fR=\fINUM_THREADS\fR
+Number of threads to use for compressing data.  Default: autodetect (number of
+processors).  Note: if exporting to an uncompressed WIM, or exporting to a WIM
+with the same compression type as the source WIM, additional threads will not
+be used, regardless of this parameter, since no data compression needs to be
+done in these cases.
+.TP
+\fB--rebuild\fR
+When exporting image(s) to an existing WIM: rebuild the entire WIM rather than
+appending data to the end of it.  Rebuilding the WIM is slower, but will save a
+little bit of space that would otherwise be left as a hole in the WIM.  Also see
+\fBimagex optimize\fR.
+.TP
+\fB--ref\fR="\fIGLOB\fR"
+File glob of additional split WIM parts that are part of the split WIM being
+exported.  See \fBSPLIT_WIMS\fR.
+
+.SH SPLIT WIMS
+
+You may use \fBimagex export\fR to export images from a split WIM.  The
+\fISRC_WIMFILE\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 \fISRC_WIMFILE\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
+.RE
+
+To export the first image of this split WIM to a new or existing WIM file
+"other.wim", run:
+.PP
+.RS
+imagex export mywim.swm 1 other.wim --ref="mywim*.swm"
+.RE
+.PP
 
 .SH NOTES
 
-\fBimagex export\fR does not yet support split WIMs.
+Unless --rebuild is specified, aborting an \fBimagex export\fR command mid-way
+through has a small chance of corrupting the destination WIM file.  However, a
+precaution is taken against this, so it should be very unlikely.  In the event
+of an aborted \fBimagex export\fR, \fBimagex optimize\fR can be run to remove
+extra data that may have been partially appended to the physical destination WIM
+file but not yet incorporated into the structure of the WIM.
 
 .SH EXAMPLES
-Export the second image of 'boot.wim' to the new WIM file 'image2.wim', and
+Export the second image of 'boot.wim' to the new WIM file 'new.wim', and
 change the compression type to maximum, if it wasn't maximum already:
 .RS
 .PP
-image export boot.wim 2 image2.wim --compress=maximum
+image export boot.wim 2 new.wim --compress=maximum
 .RE
 .PP