Update version to 1.4.2
[wimlib] / doc / imagex-extract.1.in
1 .TH IMAGEX "1" "June 2013" "@IMAGEX_PROGNAME@ @VERSION@" "User Commands"
2 .SH NAME
3 @IMAGEX_PROGNAME@-extract \- Extract files or directories from a WIM image
4 .SH SYNOPSIS
5 \fB@IMAGEX_PROGNAME@ extract\fR \fIWIMFILE\fR \fIIMAGE\fR [\fIPATH\fR...]  [\fIOPTION\fR...]
6 .SH DESCRIPTION
7 \fB@IMAGEX_PROGNAME@ extract\fR extracts one or more files or directory trees
8 from the specified \fIIMAGE\fR contained in the Windows Imaging (WIM) file
9 \fIWIMFILE\fR.
10 .PP
11 \fB@IMAGEX_PROGNAME@ extract\fR is intended for extracting only a subset of a
12 WIM image.  If you want to extract or "apply" a full WIM image to a directory or
13 NTFS volume, use \fB@IMAGEX_PROGNAME@ apply\fR (1) instead.
14 .PP
15 \fIIMAGE\fR specifies the image in \fIWIMFILE\fR that contains the files or
16 directory trees to extract.  It may be a 1-based index of an image in the WIM or
17 the name of an image in the WIM.  Use the \fB@IMAGEX_PROGNAME@ info\fR (1)
18 command to show what images a WIM file contains.
19 .PP
20 Each \fIPATH\fR specifies a file or directory tree within the WIM image to
21 extract.  See \fBPATH_SPECIFICATIONS\fR.
22 .PP
23 By default, files and directories are extracted to the current directory.  Use
24 \fB--dest-dir\fR to choose an alternate target directory.  Alternatively, use
25 \fB--to-stdout\fR to extract a file to standard output to pipe into another
26 program.
27 .PP
28 \fB@IMAGEX_PROGNAME@ extract\fR supports extracting files and directory trees
29 from stand-alone WIMs as well as split WIMs.  See \fBSPLIT WIMS\fR.
30 .SH PATH SPECIFICATIONS
31 Each \fIPATH\fR specifies a file or directory tree within the WIM image to
32 extract.  Each path must be specified as an absolute path starting from the root
33 of the WIM image, like those output by the \fB@IMAGEX_PROGNAME@ dir\fR (1)
34 command.  However, path separators may be either forward or backward slashes,
35 and the leading slash is optional; also, on Windows, the paths are treated
36 case-insensitively, while on UNIX, paths are treated case-sensitively.
37 .PP
38 If no \fIPATH\fRs are provided, the default behavior is to extract the full
39 image, as if the path "/" had been provided.
40 .SH SPLIT WIMS
41 You may use \fB@IMAGEX_PROGNAME@ extract\fR to extract files or directory trees
42 from a split WIM.  This uses the \fB--refs\fR="\fIGLOB\fR" option in the same
43 way as in other commands such as \fB@IMAGEX_PROGNAME@ apply\fR.  See
44 \fB@IMAGEX_PROGNAME@ apply\fR (1) for more details.
45 .SH OPTIONS
46 .TP 6
47 \fB--check\fR
48 When reading \fIWIMFILE\fR, verify its integrity if an integrity table is
49 present.
50 .TP
51 \fB--ref\fR="\fIGLOB\fR"
52 File glob of additional split WIM parts that are part of the split WIM.  See
53 \fBSPLIT_WIMS\fR.
54 .TP
55 \fB--verbose\fR
56 Print the path of each file or directory within the WIM image as it is
57 extracted.
58 .TP
59 \fB--unix-data\fR
60 See the documentation for this option in \fB@IMAGEX_PROGNAME@-apply\fR (1).
61 .TP
62 \fB--no-acls\fR
63 See the documentation for this option in \fB@IMAGEX_PROGNAME@-apply\fR (1).
64 .TP
65 \fB--strict-acls\fR
66 See the documentation for this option in \fB@IMAGEX_PROGNAME@-apply\fR (1).
67 .TP
68 \fB--include-invalid-names\fR
69 See the documentation for this option in \fB@IMAGEX_PROGNAME@-apply\fR (1).
70 .TP
71 \fB--to-stdout\fR
72 Extract the files to standard output instead of to the filesystem.  This can
73 only be provided if all the specified \fIPATH\fRs are to regular files (not
74 directories or reparse points).  If present, alternate data streams are not
75 extracted.
76 .TP
77 \fB--dest-dir\fR=\fIDIR\fR
78 Extract the files and directories to the directory \fIDIR\fR instead of to the
79 current working directory.
80 .SH NOTES
81 See the documentation \fB@IMAGEX_PROGNAME@ apply\fR (1) for documentation about
82 what data and metadata are extracted on UNIX versus on Windows.
83 .PP
84 On UNIX, one can alternatively mount the WIM image with \fB@IMAGEX_PROGNAME@
85 mount\fR and then extract the desired files or directories using any standard
86 command-line or graphical program.
87 .PP
88 Reparse-point fixups (a.k.a. changing absolute symbolic links and junctions to
89 point within the extraction location) are never done by \fB@IMAGEX_PROGNAME@
90 extract\fR.  Use \fB@IMAGEX_PROGNAME@ apply\fR if you want this behavior.
91 .PP
92 Unlike \fB@IMAGEX_PROGNAME@ apply\fR, \fB@IMAGEX_PROGNAME@ extract\fR does not
93 support extracting files directly to a NTFS volume using libntfs-3g.
94 .SH EXAMPLES
95 Extract a file from the first image in "boot.wim" to the current directory:
96 .RS
97 .PP
98 @IMAGEX_PROGNAME@ extract boot.wim 1 /Windows/System32/notepad.exe
99 .RE
100 .PP
101 Extract a file from the first image in "boot.wim" to standard output:
102 .RS
103 .PP
104 @IMAGEX_PROGNAME@ extract boot.wim 1 /Windows/System32/notepad.exe --to-stdout
105 .RE
106 .PP
107 Extract a file from the first image in "boot.wim" to the specified directory:
108 .RS
109 .PP
110 @IMAGEX_PROGNAME@ extract boot.wim 1 /Windows/System32/notepad.exe --dest-dir=somedir
111 .RE
112 .PP
113 Extract the "sources" directory from the first image in "boot.wim" to the
114 current directory:
115 .RS
116 .PP
117 @IMAGEX_PROGNAME@ extract boot.wim 1 /sources
118 .RE
119 .PP
120 Extract multiple files and directories in one command:
121 .RS
122 .PP
123 @IMAGEX_PROGNAME@ extract boot.wim 1 /Windows/Fonts /sources /Windows/System32/cmd.exe
124 .RE
125 .PP
126 .SH SEE ALSO
127 .BR @IMAGEX_PROGNAME@ (1)
128 .BR @IMAGEX_PROGNAME@-apply (1)
129 .BR @IMAGEX_PROGNAME@-dir (1)
130 .BR @IMAGEX_PROGNAME@-info (1)
131 .BR @IMAGEX_PROGNAME@-mount (1)