Start using NEWS and stop using ChangeLog
[wimlib] / doc / imagex-apply.1
1 .TH IMAGEX "1" "May 2012" "imagex (wimlib) wimlib 0.6.3" "User Commands"
2 .SH NAME
3 imagex apply \- Extract one image, or all images, from a WIM archive
4
5 .SH SYNOPSIS
6 \fBimagex apply\fR \fIWIMFILE\fR [\fIIMAGE_NUM\fR | \fIIMAGE_NAME\fR | all] \
7 \fIDIRECTORY\fR [\fIOPTION\fR]...
8
9 .SH DESCRIPTION
10 .PP
11
12 \fBimagex apply\fR extracts the specified image from \fIWIMFILE\fR to
13 \fIDIRECTORY\fR.
14
15 The image to extract may be specified by \fIIMAGE_NUM\fR, which must be an
16 integer that is an index of an image in the WIM file, starting at 1.
17 Alternatively, it may be the name of an image in the WIM file.  It also may be
18 the keyword \fBall\fR, which indicates that all images in the WIM are to be
19 extracted. If the keyword \fBall\fR is given, the images are extracted into
20 subdirectories of \fIDIRECTORY\fR that will be named after the image names.
21
22 .SH OPTIONS
23 .TP 6
24 \fB--check\fR
25 When reading \fIWIMFILE\fR, verify its integrity if the integrity table is
26 present.
27 .TP
28 \fB--hardlink\fR
29 When extracting a file from the WIM that is identical to a file that is already
30 extracted, create a hard link using \fBlink\fR (3) rather than creating a
31 separate file.  Files of this type are already hard linked together inside the
32 WIM to save space.
33 .TP
34 \fB--symlink\fR
35 When extracting a file from the WIM that is identical to a file that is already
36 extracted, create a symbolic link using \fBsymlink\fR (3) rather than creating a
37 separate file.  Files of this type are already hard linked together inside the
38 WIM to save space.
39 .TP
40 \fB--verbose\fR
41 Print the path to of each file or directory within the WIM image as it is extracted.
42 .TP
43 \fB--verify\fR
44 This option is currently unsupported.
45 .SH SEE ALSO
46 .BR imagex (1)
47