Symbolic links (IN PROGRESS)
[wimlib] / doc / imagex-append.1.in
1 .TH IMAGEX "1" "May 2012" "imagex (wimlib) wimlib @VERSION@" "User Commands"
2 .SH NAME
3 imagex append \- Append a directory to a WIM archive as a new image
4
5 .SH SYNOPSIS
6 \fBimagex append\fR \fIDIRECTORY\fR \fIWIMFILE\fR [\fIIMAGE_NAME\fR] \
7 [\fIDESCRIPTION\fR] [\fIOPTION\fR]...
8
9 .SH DESCRIPTION
10 .PP
11 Captures a WIM image from \fIDIRECTORY\fR and appends it to \fIWIMFILE\fR, which
12 must be a valid WIM archive.  \fIDIRECTORY\fR becomes the root directory of the
13 image.
14
15 \fIIMAGE_NAME\fR and \fIDESCRIPTION\fR specify the name and description of the
16 new image.  If \fIIMAGE_NAME\fR is not given, it is taken to be the same as the
17 base name of \fIDIRECTORY\fR.  If \fIDESCRIPTION\fR is not given, the
18 description is taken to be empty.
19
20 .SH OPTIONS
21 .TP 6
22 \fB--boot\fR
23 Specifies that the new image is to be the bootable image of the WIM archive.
24 .TP
25 \fB--check\fR
26 When reading \fIWIMFILE\fR, verify its integrity if the integrity table is
27 present; additionally, when writing \fIWIMFILE\fR with the new image added,
28 write an integrity table.  If this option is not specified, no integrity table
29 is included in the new WIM file, even if there was one before.
30 .TP
31 \fB--flags\fR \fIEDITIONID\fR
32 Specify a string to use in the <FLAGS> element of the XML data for the image.
33 .TP
34 \fB--dereference\fR
35 Follow symlinks; archive and dump the files they point to.  (The default is to
36 archive the symlinks themselves)
37
38 .SH EXAMPLES
39 .IP 
40 image append boot.wim winpe/ "Microsoft Windows PE"
41 .LP 
42 Add a new image to the existing WIM file boot.wim.  The files in the directory 'winpe' 
43 are added recursively to the image.  The image is given the name "Microsoft
44 Windows PE" and no description.
45
46 .SH SEE ALSO
47 .BR imagex (1)
48