X-Git-Url: https://wimlib.net/git/?a=blobdiff_plain;f=doc%2Fimagex-export.1.in;h=25996eb15b21ce64b936bb32ef96d370dc30dbe2;hb=7f0b7bd354274147b4e200c02c06d3e039df07dd;hp=164b1d01d2c33c029a7822d2aa8318b54eee6d5b;hpb=fd4b7f8da1550b65583b351a9af2672e6f825963;p=wimlib diff --git a/doc/imagex-export.1.in b/doc/imagex-export.1.in index 164b1d01..25996eb1 100644 --- a/doc/imagex-export.1.in +++ b/doc/imagex-export.1.in @@ -1,11 +1,11 @@ -.TH IMAGEX "1" "October 2012" "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 | \ -\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. @@ -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. @@ -45,10 +45,11 @@ 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 @@ -60,7 +61,19 @@ 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 +\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 @@ -68,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 @@ -79,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 @@ -94,19 +107,28 @@ 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 + +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 (1) - +.BR @IMAGEX_PROGNAME@ (1) +.BR @IMAGEX_PROGNAME@-info (1) +.BR @IMAGEX_PROGNAME@-optimize (1)