wimlib.net Git - wimlib/blob - doc/imagex-export.1.in

   1 .TH IMAGEX "1" "August 2013" "@IMAGEX_PROGNAME@ @VERSION@" "User Commands"
   2 .SH NAME
   3 @IMAGEX_PROGNAME@-export \- Exports an image from a WIM archive to an existing or new WIM archive
   4 .SH SYNOPSIS
   5 \fB@IMAGEX_PROGNAME@ export\fR \fISRC_WIMFILE\fR \fISRC_IMAGE\fR
   6 \fIDEST_WIMFILE\fR [\fIDEST_IMAGE_NAME\fR\] [\fIDEST_IMAGE_DESCRIPTION\fR]
   7 [\fIOPTION\fR...]
   8 .SH DESCRIPTION
   9 Copies the specified image in \fISRC_WIMFILE\fR to \fIDEST_WIMFILE\fR,
  10 optionally changing its name and/or description and/or compression type.
  11 If \fIDEST_WIMFILE\fR exists, it is taken be be a WIM archive to which the image
  12 will be appended.  Otherwise, it is created as a new WIM archive containing only
  13 the exported image.
  14 .PP
  15 \fISRC_IMAGE\fR specifies the image in \fISRC_WIMFILE\fR to export.  It may be a
  16 1-based index of an image in the WIM, the name of an image in the WIM, or the
  17 keyword "all" to indicate that all images are to be exported.  Use the
  18 \fB@IMAGEX_PROGNAME@ info\fR (1) command to list the images a WIM file contains.
  19 .PP
  20 If given, \fIDEST_IMAGE_NAME\fR specifies the name to give the image being
  21 exported to \fIDEST_WIMFILE\fR.  The default is its name in \fISRC_WIMFILE\fR.
  22 \fIDEST_IMAGE_NAME\fR cannot be specified if multiple images are being exported.
  23 .PP
  24 If given, \fIDEST_IMAGE_DESCRIPTION\fR specifies the description to give the
  25 image being exported to \fIDEST_WIMFILE\fR.  The default is its description in
  26 \fISRC_WIMFILE\fR.
  27 .PP
  28 \fB@IMAGEX_PROGNAME@ export\fR supports exporting images from stand-alone WIMs as well as
  29 from split WIMs.  However, you cannot export an image to a split WIM.  See
  30 \fBSPLIT WIMS\fR.
  31 .PP
  32 \fB@IMAGEX_PROGNAME@ export\fR also supports exporting images from a non-pipable
  33 WIM into a (possibly new) pipable WIM, and vice versa.  See \fB--pipable\fR and
  34 \fB--not-pipable\fR.
  35 .PP
  36 .SH OPTIONS
  37 .TP 6
  38 \fB--boot\fR
  39 Specifies that the exported image is to be the bootable image of the destination
  40 WIM archive.
  41 .IP ""
  42 If multiple images are being exported, this flag indicates that the image in the
  43 \fISRC_WIMFILE\fR that is currently marked as bootable is to be made bootable in
  44 \fIDEST_WIMFILE\fR.  If no image in \fISRC_WIMFILE\fR is bootable, it is an
  45 error.
  46 .TP
  47 \fB--check\fR
  48 When reading \fISRC_WIMFILE\fR, and \fIDEST_WIMFILE\fR if it exists, verify the
  49 file's integrity if the integrity table is present; additionally, when writing
  50 \fIDEST_WIMFILE\fR with the new image(s) added, write an integrity table.
  51 If neither \fB--check\fR nor \fB--nocheck\fR is specified, an integrity
  52 table is included in \fIDEST_WIMFILE\fR if and only if \fIDEST_WIMFILE\fR
  53 already existed and it had an integrity table before.
  54 .TP
  55 \fB--nocheck\fR
  56 When writing \fIDEST_WIMFILE\fR with the new image(s) added, do not write an
  57 integrity table.
  58 If neither \fB--check\fR nor \fB--nocheck\fR is specified, an integrity
  59 table is included in \fIDEST_WIMFILE\fR if and only if \fIDEST_WIMFILE\fR
  60 already existed and it had an integrity table before.
  61 .TP
  62 \fB--compress\fR=\fITYPE\fR
  63 Specifies the compression type for \fIDEST_WIMFILE\fR.  This is only valid if
  64 \fIDEST_WIMFILE\fR does not yet exist, since if \fIDEST_WIMFILE\fR exists, the
  65 compression type must be the same as that of \fIDEST_WIMFILE\fR.
  66 .IP ""
  67 \fITYPE\fR may be "none", "maximum", or "fast".  By default, it is the same as
  68 that of the input WIM file.
  69 .IP ""
  70 You may also specify the actual names of the compression algorithms, "XPRESS"
  71 and "LZX", instead of "fast" and "maximum", respectively.
  72 .TP
  73 \fB--threads\fR=\fINUM_THREADS\fR
  74 Number of threads to use for compressing data.  Default: autodetect (number of
  75 processors).  Note: if exporting to an uncompressed WIM, or exporting to a WIM
  76 with the same compression type as the source WIM, additional threads will not
  77 be used, regardless of this parameter, since no data compression needs to be
  78 done in these cases.
  79 .TP
  80 \fB--rebuild\fR
  81 When exporting image(s) to an existing WIM: rebuild the entire WIM rather than
  82 appending data to the end of it.  Rebuilding the WIM is slower, but will save a
  83 little bit of space that would otherwise be left as a hole in the WIM.  Also see
  84 \fB@IMAGEX_PROGNAME@ optimize\fR.
  85 .TP
  86 \fB--ref\fR="\fIGLOB\fR"
  87 File glob of additional split WIM parts that are part of the split WIM being
  88 exported.  See \fBSPLIT_WIMS\fR.
  89 .TP
  90 \fB--pipable\fR
  91 Build, or rebuild, \fIDEST_WIMFILE\fR as a "pipable WIM" so that it can be
  92 applied fully sequentially, including from a pipe.  See \fB@IMAGEX_PROGNAME@
  93 capture\fR(1) for more details about creating pipable WIMs.  The default without
  94 this option is to make \fIDEST_WIMFILE\fR pipable if and only if it already
  95 existed and was already pipable.
  96 .TP
  97 \fB--not-pipable\fR
  98 Build, or rebuld, \fIDEST_WIMFILE\fR as a normal, non-pipable WIM.  This is the
  99 default behavior, unless \fIDEST_WIMFILE\fR already existed and was already
 100 pipable.
 101 .SH SPLIT WIMS
 102 You may use \fB@IMAGEX_PROGNAME@ export\fR to export images from a split WIM.  The
 103 \fISRC_WIMFILE\fR argument is used to specify the first part of the split WIM, and
 104 the \fB--refs\fR="\fIGLOB\fR" option is used to provide a shell-style file glob
 105 that specifies the additional parts of the split WIM.  \fIGLOB\fR is expected to
 106 be a single string on the command line, so \fIGLOB\fR must be quoted so that it
 107 is protected against shell expansion.  \fIGLOB\fR must expand to all parts of
 108 the split WIM, except optionally the first part which may either omitted or
 109 included in the glob (but the first part MUST be specified as \fISRC_WIMFILE\fR as
 110 well).
 111 .PP
 112 Here's an example.  The names for the split WIMs usually go something like:
 113 .PP
 114 .RS
 115 .nf
 116 mywim.swm
 117 mywim2.swm
 118 mywim3.swm
 119 mywim4.swm
 120 mywim5.swm
 121 .RE
 122 .PP
 123 To export the first image of this split WIM to a new or existing WIM file
 124 "other.wim", run:
 125 .PP
 126 .RS
 127 @IMAGEX_PROGNAME@ export mywim.swm 1 other.wim --ref="mywim*.swm"
 128 .RE
 129 .SH NOTES
 130 It is safe to abort an \fB@IMAGEX_PROGNAME@ export\fR command partway through;
 131 however, after doing this, it is recommended to run \fB@IMAGEX_PROGNAME@
 132 optimize\fR on the destination WIM to remove any data that was appended to the
 133 physical WIM file but not yet incorporated into the structure of the WIM, unless
 134 \fB--rebuild\fR was specified, in which case you should delete the temporary
 135 file left over.
 136 .SH EXAMPLES
 137 Export the second image of 'boot.wim' to the new WIM file 'new.wim', and
 138 change the compression type to maximum, if it wasn't maximum already:
 139 .RS
 140 .PP
 141 @IMAGEX_PROGNAME@ export boot.wim 2 new.wim --compress=maximum
 142 .RE
 143 .PP
 144 .SH SEE ALSO
 145 .BR @IMAGEX_PROGNAME@ (1)
 146 .BR @IMAGEX_PROGNAME@-info (1)
 147 .BR @IMAGEX_PROGNAME@-optimize (1)