X-Git-Url: https://wimlib.net/git/?p=wimlib;a=blobdiff_plain;f=doc%2Fimagex-export.1.in;h=e0ad169aef3712b7f5a6bd77b934c73e6f076ca7;hp=e80a5d13b67529058f886d2c0f0dbc37ea88523d;hb=6cc8db9fac4dcfdcd474ee49790a30a54b83c798;hpb=6f841e85af6215e88bce12a34a00548664fba6ea diff --git a/doc/imagex-export.1.in b/doc/imagex-export.1.in index e80a5d13..e0ad169a 100644 --- a/doc/imagex-export.1.in +++ b/doc/imagex-export.1.in @@ -1,6 +1,6 @@ -.TH IMAGEX "1" "September 2012" "imagex (wimlib) wimlib @VERSION@" "User Commands" +.TH IMAGEX "1" "March 2013" "imagex (wimlib) wimlib @VERSION@" "User Commands" .SH NAME -imagex export \- Exports an image from a WIM archive to an existing or new WIM archive +imagex-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 | \ @@ -45,21 +45,35 @@ 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 \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. -\fITYPE\fR may be "none", "maximum", or "fast". By default, it is "fast". +\fITYPE\fR may be "none", "maximum", or "fast". By default, it is the same as +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 +\fBimagex optimize\fR. .TP \fB--ref\fR="\fIGLOB\fR" File glob of additional split WIM parts that are part of the split WIM being @@ -78,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 @@ -87,7 +101,6 @@ mywim2.swm mywim3.swm mywim4.swm mywim5.swm -\. ... etc. .RE To export the first image of this split WIM to a new or existing WIM file @@ -98,6 +111,15 @@ imagex export mywim.swm 1 other.wim --ref="mywim*.swm" .RE .PP +.SH NOTES + +Unless \fB--rebuild\fR 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. + .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: