-.TH IMAGEX "1" "April 2013" "@IMAGEX_PROGNAME@ @VERSION@" "User Commands"
+.TH IMAGEX "1" "June 2013" "@IMAGEX_PROGNAME@ @VERSION@" "User Commands"
.SH NAME
@IMAGEX_PROGNAME@-export \- Exports an image from a WIM archive to an existing or new WIM archive
-
.SH SYNOPSIS
-\fB@IMAGEX_PROGNAME@ export\fR \fISRC_WIMFILE\fR (\fISRC_IMAGE_NUM\fR | \
-\fISRC_IMAGE_NAME\fR | all ) \fIDEST_WIMFILE\fR [\fIDEST_IMAGE_NAME\fR\] \
-[\fIDEST_IMAGE_DESCRIPTION\fR] [\fIOPTION\fR]...
-
+\fB@IMAGEX_PROGNAME@ export\fR \fISRC_WIMFILE\fR \fISRC_IMAGE\fR
+\fIDEST_WIMFILE\fR [\fIDEST_IMAGE_NAME\fR\] [\fIDEST_IMAGE_DESCRIPTION\fR]
+[\fIOPTION\fR...]
.SH DESCRIPTION
-.PP
-
Copies the specified image in \fISRC_WIMFILE\fR to \fIDEST_WIMFILE\fR,
optionally changing its name and/or description and/or compression type.
If \fIDEST_WIMFILE\fR exists, it is taken be be a WIM archive to which the image
will be appended. Otherwise, it is created as a new WIM archive containing only
the exported image.
-
-The source image may be specified by \fISRC_IMAGE_NUM\fR, which must be an integer that is
-an index of an image in \fISRC_WIMFILE\fR, starting at 1. Alternatively, it may be
-the name of an image in \fISRC_WIMFILE\fR, or it may be the keyword "all" to
-specify that all images are to be exported.
-
+.PP
+\fISRC_IMAGE\fR specifies the image in \fISRC_WIMFILE\fR to export. It may be a
+1-based index of an image in the WIM, the name of an image in the WIM, or the
+keyword "all" to indicate that all images are to be exported. Use the
+\fB@IMAGEX_PROGNAME@ info\fR (1) command to list the images a WIM file contains.
+.PP
If given, \fIDEST_IMAGE_NAME\fR specifies the name to give the image being
exported to \fIDEST_WIMFILE\fR. The default is its name in \fISRC_WIMFILE\fR.
\fIDEST_IMAGE_NAME\fR cannot be specified if multiple images are being exported.
-
+.PP
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.
-
+.PP
\fB@IMAGEX_PROGNAME@ 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.
-
+.PP
.SH OPTIONS
.TP 6
\fB--boot\fR
Specifies that the exported image is to be the bootable image of the destination
WIM archive.
-
+.IP ""
If multiple images are being exported, this flag indicates that the image in the
\fISRC_WIMFILE\fR that is currently marked as bootable is to be made bootable in
\fIDEST_WIMFILE\fR. If no image in \fISRC_WIMFILE\fR is bootable, it is an
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.
-
+.IP ""
\fITYPE\fR may be "none", "maximum", or "fast". By default, it is the same as
that of the input WIM file.
-
+.IP ""
You may also specify the actual names of the compression algorithms, "XPRESS"
and "LZX", instead of "fast" and "maximum", respectively.
.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 \fB@IMAGEX_PROGNAME@ 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
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).
-
+.PP
Here's an example. The names for the split WIMs usually go something like:
-
-.RS
.PP
+.RS
.nf
mywim.swm
mywim2.swm
mywim4.swm
mywim5.swm
.RE
-
+.PP
To export the first image of this split WIM to a new or existing WIM file
"other.wim", run:
.PP
.RS
@IMAGEX_PROGNAME@ export mywim.swm 1 other.wim --ref="mywim*.swm"
.RE
-.PP
-
.SH NOTES
-
-Unless \fB--rebuild\fR is specified, aborting an \fB@IMAGEX_PROGNAME@ 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 \fB@IMAGEX_PROGNAME@ export\fR, \fB@IMAGEX_PROGNAME@ 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.
-
+It is safe to abort an \fB@IMAGEX_PROGNAME@ export\fR command partway through;
+however, after doing this, it is recommended to run \fB@IMAGEX_PROGNAME@
+optimize\fR on the destination WIM to remove any data that was appended to the
+physical WIM file but not yet incorporated into the structure of the WIM, unless
+\fB--rebuild\fR was specified, in which case you should delete the temporary
+file left over.
.SH EXAMPLES
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 new.wim --compress=maximum
+@IMAGEX_PROGNAME@ export boot.wim 2 new.wim --compress=maximum
.RE
.PP
-
.SH SEE ALSO
.BR @IMAGEX_PROGNAME@ (1)
-
+.BR @IMAGEX_PROGNAME@-info (1)
+.BR @IMAGEX_PROGNAME@-optimize (1)