X-Git-Url: https://wimlib.net/git/?p=wimlib;a=blobdiff_plain;f=doc%2Fimagex-export.1.in;h=25996eb15b21ce64b936bb32ef96d370dc30dbe2;hp=e0991fc7b645b1a2ab8e099edb735c185e67656f;hb=7f0b7bd354274147b4e200c02c06d3e039df07dd;hpb=c040dac396c3ec1aa42fda92672cd5632e91b6d5 diff --git a/doc/imagex-export.1.in b/doc/imagex-export.1.in index e0991fc7..25996eb1 100644 --- a/doc/imagex-export.1.in +++ b/doc/imagex-export.1.in @@ -3,9 +3,9 @@ @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 @@ -16,10 +16,10 @@ 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. +\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. 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. @@ -113,22 +113,22 @@ To export the first image of this split WIM to a new or existing WIM file .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 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)