Win32 fixes

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

diff --git a/doc/imagex-export.1.in b/doc/imagex-export.1.in
index b49e19290ee59df3b30f93712993387998166db3..00a03eb2e1449e1eb4f3ebf9e99c5922ceb072b6 100644 (file)
--- a/doc/imagex-export.1.in
+++ b/doc/imagex-export.1.in
@@ -1,9 +1,9 @@
-.TH IMAGEX "1" "January 2013" "imagex (wimlib) wimlib @VERSION@" "User Commands"
+.TH IMAGEX "1" "March 2013" "@IMAGEX_PROGNAME@ @VERSION@" "User Commands"

 .SH NAME
 .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
 
 .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]...
 
 \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.
 
 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.
 
 from split WIMs.  However, you cannot export an image to a split WIM.  See
 \fBSPLIT WIMS\fR.
 


@@ -45,10 +45,11 @@ If multiple images are being exported, this flag indicates that the image in the
 error.
 .TP
 \fB--check\fR
 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
 .TP
 \fB--compress\fR=\fITYPE\fR
 Specifies the compression type for \fIDEST_WIMFILE\fR.  This is only valid if


@@ -72,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
 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
 .TP
 \fB--ref\fR="\fIGLOB\fR"
 File glob of additional split WIM parts that are part of the split WIM being


@@ -80,7 +81,7 @@ exported.  See \fBSPLIT_WIMS\fR.
 
 .SH SPLIT WIMS
 
 
 .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
 \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


@@ -91,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:
 well).
 
 Here's an example.  The names for the split WIMs usually go something like:

-       
+

 .RS
 .PP
 .nf
 .RS
 .PP
 .nf


@@ -106,18 +107,18 @@ To export the first image of this split WIM to a new or existing WIM file
 "other.wim", run:
 .PP
 .RS
 "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
 
 .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
 
 .SH EXAMPLES
 Export the second image of 'boot.wim' to the new WIM file 'new.wim', and


@@ -129,5 +130,5 @@ image export boot.wim 2 new.wim --compress=maximum
 .PP
 
 .SH SEE ALSO
 .PP
 
 .SH SEE ALSO

-.BR imagex (1)
+.BR @IMAGEX_PROGNAME@ (1)