fix version number in configure script
[wimlib] / doc / imagex-export.1
1 .TH IMAGEX "1" "May 2012" "imagex (wimlib) wimlib 0.6.3" "User Commands"
2 .SH NAME
3 imagex export \- Exports an image from a WIM archive to an existing or new WIM archive
4
5 .SH SYNOPSIS
6 \fBimagex export\fR \fISRC_WIMFILE\fR (\fISRC_IMAGE_NUM\fR | \
7 \fISRC_IMAGE_NAME\fR | all ) \fIDEST_WIMFILE\fR [\fIDEST_IMAGE_NAME\fR\] \
8 [\fIDEST_IMAGE_DESCRIPTION\fR] [\fIOPTION\fR]...
9
10 .SH DESCRIPTION
11 .PP
12
13 Copies the specified image in \fISRC_WIMFILE\fR to \fIDEST_WIMFILE\fR,
14 optionally changing its name and/or description and/or compression type.
15 If \fIDEST_WIMFILE\fR exists, it is taken be be a WIM archive to which the image
16 will be appended.  Otherwise, it is created as a new WIM archive containing only
17 the exported image.
18
19 The source image may be specified by \fISRC_IMAGE_NUM\fR, which must be an integer that is
20 an index of an image in \fISRC_WIMFILE\fR, starting at 1.  Alternatively, it may be
21 the name of an image in \fISRC_WIMFILE\fR, or it may be the keyword "all" to
22 specify that all images are to be exported.
23
24 If given, \fIDEST_IMAGE_NAME\fR specifies the name to give the image being
25 exported to \fIDEST_WIMFILE\fR.  The default is its name in \fISRC_WIMFILE\fR.
26 \fIDEST_IMAGE_NAME\fR cannot be specified if multiple images are being exported.
27
28 If given, \fIDEST_IMAGE_DESCRIPTION\fR specifies the description to give the
29 image being exported to \fIDEST_WIMFILE\fR.  The default is its description in
30 \fISRC_WIMFILE\fR.
31
32 .SH OPTIONS
33 .TP 6
34 \fB--boot\fR
35 Specifies that the exported image is to be the bootable image of the WIM archive.
36
37 If multiple images are being exported, this flag indicates that the image in the
38 \fISRC_WIMFILE\fR that is currently marked as bootable is to be made bootable in
39 \fIDEST_WIMFILE\fR.  If no image in \fISRC_WIMFILE\fR is bootable, it is an
40 error.
41 .TP
42 \fB--check\fR
43 When reading \fISRC_WIMFILE\fR, verify its integrity if the integrity table is
44 present; additionally, when writing \fIDEST_WIMFILE\fR with the new image added,
45 write an integrity table.  If this option is not specified, no integrity table
46 is included in \fIDEST_WIMFILE\fR, even if there was one before.
47 .TP
48 \fB--compress\fR[=\fITYPE\fR]
49 Specifies the compression type for \fIDEST_WIMFILE\fR.  This is only valid if
50 \fIDEST_WIMFILE\fR does not yet exist.
51
52 \fITYPE\fR may be "none",
53 "maximum", or "fast".  By default, the compression type is "none".  If \fB--compress\fR
54 is specified but \fITYPE\fR is not, the compression type is taken to be
55 "maximum", which is LZX compression.  "fast" compression is XPRESS compression.
56
57 .SH SEE ALSO
58 .BR imagex (1)
59