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

   1 .TH WIMLIB-IMAGEX "1" "May 2014" "@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 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 This command is also available as simply \fBwimexport\fR if the appropriate hard
  15 link or batch file has been installed.
  16 .PP
  17 \fISRC_IMAGE\fR specifies the image in \fISRC_WIMFILE\fR to export.  It may be a
  18 1-based index of an image in \fISRC_WIMFILE\fR, the name of an image in
  19 \fISRC_WIMFILE\fR, or the keyword "all" to indicate that all images in
  20 \fISRC_WIMFILE\fR are to be exported.  Use the \fB@IMAGEX_PROGNAME@ info\fR (1)
  21 command to list the images a WIM file contains.
  22 .PP
  23 If specified, \fIDEST_IMAGE_NAME\fR is the name to give the image being exported
  24 to \fIDEST_WIMFILE\fR.  The default is its name in \fISRC_WIMFILE\fR.
  25 \fIDEST_IMAGE_NAME\fR cannot be specified if multiple images are being exported.
  26 .PP
  27 If specified, \fIDEST_IMAGE_DESCRIPTION\fR is the description to give the image
  28 being exported to \fIDEST_WIMFILE\fR.  The default is its description in
  29 \fISRC_WIMFILE\fR.
  30 .PP
  31 \fB@IMAGEX_PROGNAME@ export\fR supports exporting images from stand-alone WIMs as well as
  32 from split WIMs.  However, you cannot export an image to a split WIM.  See
  33 \fBSPLIT WIMS\fR.
  34 .PP
  35 \fB@IMAGEX_PROGNAME@ export\fR also supports exporting images from a non-pipable
  36 WIM into a (possibly new) pipable WIM, and vice versa.  Furthermore, it will
  37 export a pipable WIM directly to standard output if "-" is specified as
  38 \fIDEST_WIMFILE\fR (this implies \fB--pipable\fR).  See \fB--pipable\fR and
  39 \fB--not-pipable\fR.
  40 .PP
  41 .SH OPTIONS
  42 .TP 6
  43 \fB--boot\fR
  44 Specifies that the exported image is to be the bootable image of the destination
  45 WIM archive.
  46 .IP ""
  47 If multiple images are being exported, this flag indicates that the image in the
  48 \fISRC_WIMFILE\fR that is currently marked as bootable is to be made bootable in
  49 \fIDEST_WIMFILE\fR.  If no image in \fISRC_WIMFILE\fR is bootable, it is an
  50 error.
  51 .TP
  52 \fB--check\fR
  53 When reading \fISRC_WIMFILE\fR, and \fIDEST_WIMFILE\fR if it exists, verify the
  54 file's integrity if the integrity table is present; additionally, when writing
  55 \fIDEST_WIMFILE\fR with the new image(s) added, write an integrity table.
  56 If neither \fB--check\fR nor \fB--nocheck\fR is specified, an integrity
  57 table is included in \fIDEST_WIMFILE\fR if and only if \fIDEST_WIMFILE\fR
  58 already existed and it had an integrity table before.
  59 .TP
  60 \fB--nocheck\fR
  61 When writing \fIDEST_WIMFILE\fR with the new image(s) added, do not write an
  62 integrity table.
  63 If neither \fB--check\fR nor \fB--nocheck\fR is specified, an integrity
  64 table is included in \fIDEST_WIMFILE\fR if and only if \fIDEST_WIMFILE\fR
  65 already existed and it had an integrity table before.
  66 .TP
  67 \fB--compress\fR=\fITYPE\fR
  68 Specifies the compression type for \fIDEST_WIMFILE\fR.  This is only valid if
  69 \fIDEST_WIMFILE\fR does not yet exist, since if \fIDEST_WIMFILE\fR exists, the
  70 compression type must be the same as that of \fIDEST_WIMFILE\fR.
  71 .IP ""
  72 \fITYPE\fR may be "none", "maximum", or "fast".  By default, it is the same as
  73 that of the input WIM file.
  74 .IP ""
  75 You may also specify the actual names of the compression algorithms, "XPRESS"
  76 and "LZX", instead of "fast" and "maximum", respectively.
  77 .IP ""
  78 \fITYPE\fR may also be "recovery" (or "LZMS"); however, this will result in
  79 reduced compatibility.  See the documentation for this option to
  80 \fB@IMAGEX_PROGNAME@ capture\fR (1) for more details.
  81 .TP
  82 \fB--compress-slow\fR
  83 Spend even more time compressing the data to achieve a very slightly better
  84 compression ratio.  This currently only has an effect for LZX ("maximum") and
  85 LZMS ("recovery") compression.  This option does not itself set the compression
  86 format.
  87 .TP
  88 \fB--chunk-size\fR=\fISIZE\fR
  89 Set the WIM compression chunk size to \fISIZE\fR.  See the documentation for
  90 this option to \fB@IMAGEX_PROGNAME@ capture\fR (1) for more details.
  91 .TP
  92 \fB--pack-streams\fR, \fB--solid\fR
  93 Create a "solid" archive that compresses multiple files together.  This can
  94 result in a higher compression ratio, but has disadvantages such as reduced
  95 compatibility.  See the documentation for this option to \fB@IMAGEX_PROGNAME@
  96 capture\fR (1) for more details.
  97 .TP
  98 \fB--pack-chunk-size\fR=\fISIZE\fR, \fB--solid-chunk-size\fR=\fISIZE\fR
  99 Like \fB--chunk-size\fR, but set the chunk size used in packed resources.  See
 100 the documentation for this option to \fB@IMAGEX_PROGNAME@ capture\fR (1) for
 101 more details.
 102 .TP
 103 \fB--pack-compress\fR=\fITYPE\fR, \fB--solid-compress\fR=\fITYPE\fR
 104 Like \fB--compress\fR, but set the compression format used in packed resources.
 105 See the documentation for this option to \fB@IMAGEX_PROGNAME@ capture\fR (1) for
 106 more details.
 107 .TP
 108 \fB--threads\fR=\fINUM_THREADS\fR
 109 Number of threads to use for compressing data.  Default: autodetect (number of
 110 processors).  Note: multiple compressor threads are not very useful when
 111 exporting to a WIM with the same compression type as the source WIM, since
 112 wimlib optimizes this case by re-using the raw compressed data.
 113 .TP
 114 \fB--rebuild\fR
 115 When exporting image(s) to an existing WIM: rebuild the entire WIM rather than
 116 appending data to the end of it.  Rebuilding the WIM is slower, but will save a
 117 little bit of space that would otherwise be left as a hole in the WIM.  Also see
 118 \fB@IMAGEX_PROGNAME@ optimize\fR.
 119 .TP
 120 \fB--ref\fR="\fIGLOB\fR"
 121 File glob of additional WIMs or split WIM parts to reference resources from.
 122 See \fBSPLIT_WIMS\fR.  This option can be specified multiple times.  Note:
 123 \fIGLOB\fR is listed in quotes because it is interpreted by
 124 \fB@IMAGEX_PROGNAME@\fR and may need to be quoted to protect against shell
 125 expansion.
 126 .TP
 127 \fB--pipable\fR
 128 Build, or rebuild, \fIDEST_WIMFILE\fR as a "pipable WIM" so that it can be
 129 applied fully sequentially, including from a pipe.  See \fB@IMAGEX_PROGNAME@
 130 capture\fR(1) for more details about creating pipable WIMs.  The default without
 131 this option is to make \fIDEST_WIMFILE\fR pipable if and only if it already
 132 existed and was already pipable, or was "-" (standard output).
 133 .TP
 134 \fB--not-pipable\fR
 135 Build, or rebuild, \fIDEST_WIMFILE\fR as a normal, non-pipable WIM.  This is the
 136 default behavior, unless \fIDEST_WIMFILE\fR already existed and was already
 137 pipable, or if \fIDEST_WIMFILE\fR was "-" (standard output).
 138 .SH SPLIT WIMS
 139 You may use \fB@IMAGEX_PROGNAME@ export\fR to export images from a split WIM.
 140 The \fISRC_WIMFILE\fR argument must specify the first part of the split WIM,
 141 while the additional parts of the split WIM must be specified in one or more
 142 \fB--ref\fR="\fIGLOB\fR" options.  Since globbing is built into the \fB--ref\fR
 143 option, typically only one \fB--ref\fR option is necessary.  For example, the
 144 names for the split WIM parts usually go something like:
 145 .PP
 146 .RS
 147 .nf
 148 mywim.swm
 149 mywim2.swm
 150 mywim3.swm
 151 mywim4.swm
 152 mywim5.swm
 153 .RE
 154 .PP
 155 To export the first image of this split WIM to a new or existing WIM file
 156 "other.wim", run:
 157 .PP
 158 .RS
 159 @IMAGEX_PROGNAME@ export mywim.swm 1 other.wim --ref="mywim*.swm"
 160 .RE
 161 .SH NOTES
 162 \fIData integrity\fR:  It is safe to abort a \fB@IMAGEX_PROGNAME@ export\fR command partway through.
 163 However, after doing this, it is recommended to run \fB@IMAGEX_PROGNAME@
 164 optimize\fR on the destination WIM to remove any data that was appended to the
 165 physical WIM file but not yet incorporated into the structure of the WIM, unless
 166 the WIM was being rebuilt (e.g. with \fB--rebuild\fR), in which case you should
 167 delete the temporary file left over.
 168 .PP
 169 \fISingle instancing\fR: The WIM format uses single-instance streams (roughly,
 170 "files").  When an image is exported, only the streams ("files") not already
 171 present in the destination WIM will be copied.  However, a new copy of the
 172 image's metadata resource, which describes the full directory structure, will
 173 always be created.
 174 .PP
 175 \fIESD files\fR: wimlib v1.6.0 and later can export images from version 3584
 176 WIMs, which usually contain LZMS-compressed solid blocks and may carry the
 177 \fI.esd\fR file extension rather than \fI.wim\fR.  However, \fI.esd\fR files
 178 downloaded directly by the Windows 8 web downloader have encrypted segments, and
 179 wimlib cannot export images from such files until they are first decrypted.  In
 180 addition, to ensure the destination archive is created in the original WIM
 181 format rather than in the newer format, specify \fB--compress\fR=\fImaximum\fR.
 182 .SH EXAMPLES
 183 Export the second image of 'boot.wim' to the new WIM file 'new.wim':
 184 .RS
 185 .PP
 186 @IMAGEX_PROGNAME@ export boot.wim 2 new.wim
 187 .RE
 188 .PP
 189 The above example creates "new.wim" with the same compression type as
 190 "boot.wim".  If you wish to change the compression type, specify
 191 \fB--compress\fR=\fITYPE\fR; for example:
 192 .RS
 193 .PP
 194 @IMAGEX_PROGNAME@ export boot.wim 2 new.wim --compress=maximum
 195 .RE
 196 .PP
 197 .SH SEE ALSO
 198 .BR @IMAGEX_PROGNAME@ (1)
 199 .BR @IMAGEX_PROGNAME@-info (1)
 200 .BR @IMAGEX_PROGNAME@-optimize (1)