Start using NEWS and stop using ChangeLog
[wimlib] / doc / imagex-capture.1
1 .TH IMAGEX "1" "May 2012" "imagex (wimlib) wimlib 0.6.3" "User Commands"
2 .SH NAME
3 imagex capture \- Create a new WIM file from a directory.
4
5 .SH SYNOPSIS
6 \fBimagex capture\fR \fIDIRECTORY\fR \fIWIMFILE\fR [\fIIMAGE_NAME\fR] \
7 [\fIDESCRIPTION\fR] [\fIOPTION\fR]...
8
9 .SH DESCRIPTION
10 .PP
11
12 Captures a WIM image from \fIDIRECTORY\fR and creates a new WIM archive,
13 \fIWIMFILE\fR, that contains it.  \fIDIRECTORY\fR becomes the root directory of
14 the image.
15
16 \fIIMAGE_NAME\fR and \fIDESCRIPTION\fR specify the name and description of the
17 new image.  If \fIIMAGE_NAME\fR is not given, it is taken to be the same as the
18 base name of \fIDIRECTORY\fR.  If \fIDESCRIPTION\fR is not given, the
19 description is taken to be empty.
20
21 .SH OPTIONS
22 .TP 6
23 \fB--boot\fR
24 Specifies that the new image is to be made the bootable image of the WIM archive.
25 .TP
26 \fB--check\fR
27 Include an integrity table in the new WIM file.
28 .TP
29 \fB--compress\fR[=\fITYPE\fR]
30 Specifies the compression type for the WIM file.  \fITYPE\fR may be "none",
31 "maximum", or "fast".  By default, the compression type is "none".  If \fB--compress\fR
32 is specified but \fITYPE\fR is not, the compression type is taken to be
33 "maximum", which is LZX compression.  "fast" compression is XPRESS compression.
34 .TP
35 \fB--config\fR \fICONFIG_FILE\fR
36 This option is currently unsupported.
37 .TP
38 \fB--flags\fR \fIEDITIONID\fR
39 Specify a string to use in the <FLAGS> element of the XML data for the image.
40 .TP
41 \fB--norpfix
42 This option is currently unsupported.
43 .TP
44 \fB--verify\fR
45 This option is currently unsupported.
46 .TP
47 \fB--verbose\fR
48 Print the names of files and directories as they are captured.
49 .SH SEE ALSO
50 .BR imagex (1)
51