]> wimlib.net Git - wimlib/blobdiff - doc/imagex-export.1.in
Win32: Get encrypted capture actually working
[wimlib] / doc / imagex-export.1.in
index 191a41c7812b36bc38a346e7be0fe867e8fa26d2..e0991fc7b645b1a2ab8e099edb735c185e67656f 100644 (file)
@@ -1,9 +1,9 @@
-.TH IMAGEX "1" "February 2013" "imagex (wimlib) wimlib @VERSION@" "User Commands"
+.TH IMAGEX "1" "April 2013" "@IMAGEX_PROGNAME@ @VERSION@" "User Commands"
 .SH NAME
-imagex-export \- Exports an image from a WIM archive to an existing or new WIM archive
+@IMAGEX_PROGNAME@-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 | \
+\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]...
 
@@ -29,7 +29,7 @@ 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
+\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.
 
@@ -73,7 +73,7 @@ done in these cases.
 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.
+\fB@IMAGEX_PROGNAME@ optimize\fR.
 .TP
 \fB--ref\fR="\fIGLOB\fR"
 File glob of additional split WIM parts that are part of the split WIM being
@@ -81,7 +81,7 @@ exported.  See \fBSPLIT_WIMS\fR.
 
 .SH SPLIT WIMS
 
-You may use \fBimagex export\fR to export images from a split WIM.  The
+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
 that specifies the additional parts of the split WIM.  \fIGLOB\fR is expected to
@@ -92,7 +92,7 @@ included in the glob (but the first part MUST be specified as \fISRC_WIMFILE\fR
 well).
 
 Here's an example.  The names for the split WIMs usually go something like:
-       
+
 .RS
 .PP
 .nf
@@ -107,18 +107,18 @@ 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"
+@IMAGEX_PROGNAME@ export mywim.swm 1 other.wim --ref="mywim*.swm"
 .RE
 .PP
 
 .SH NOTES
 
-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.
+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.
 
 .SH EXAMPLES
 Export the second image of 'boot.wim' to the new WIM file 'new.wim', and
@@ -130,5 +130,5 @@ image export boot.wim 2 new.wim --compress=maximum
 .PP
 
 .SH SEE ALSO
-.BR imagex (1)
+.BR @IMAGEX_PROGNAME@ (1)