1 .TH IMAGEX "1" "May 2013" "@IMAGEX_PROGNAME@ @VERSION@" "User Commands"
3 @IMAGEX_PROGNAME@-extract \- Extract files or directories from a WIM image
6 \fB@IMAGEX_PROGNAME@ extract\fR \fIWIMFILE\fR \fIIMAGE\fR [\fIPATH\fR...] [\fIOPTION\fR...]
11 \fB@IMAGEX_PROGNAME@ extract\fR extracts one or more files or directory trees
12 from the specified \fIIMAGE\fR contained in the Windows Imaging (WIM) file
15 \fB@IMAGEX_PROGNAME@ extract\fR is intended for extracting only a subset of a
16 WIM image. If you want to extract or "apply" a full WIM image to a directory or
17 NTFS volume, use \fB@IMAGEX_PROGNAME@ apply\fR (1) instead.
19 \fIIMAGE\fR specifies the image in \fIWIMFILE\fR that contains the files or
20 directory trees to extract. It may be a 1-based index of an image in the WIM or
21 the name of an image in the WIM. Use the \fB@IMAGEX_PROGNAME@ info\fR (1)
22 command to show what images a WIM file contains.
24 Each \fIPATH\fR specifies a file or directory tree within the WIM image to
25 extract. See \fBPATH_SPECIFICATIONS\fR.
27 By default, files and directories are extracted to the current directory. Use
28 \fB--dest-dir\fR to choose an alternate target directory. Alternatively, use
29 \fB--to-stdout\fR to extract a file to standard output to pipe into another
32 \fB@IMAGEX_PROGNAME@ extract\fR supports extracting files and directory trees
33 from stand-alone WIMs as well as split WIMs. See \fBSPLIT WIMS\fR.
35 .SH PATH SPECIFICATIONS
37 Each \fIPATH\fR specifies a file or directory tree within the WIM image to
38 extract. Each path must be specified as an absolute path starting from the root
39 of the WIM image, like those output by the \fB@IMAGEX_PROGNAME@ dir\fR (1)
40 command. Path separators may be forward slashes on UNIX, or either forward
41 slashes or backward slashes on Windows. The leading slash is optional.
43 If no \fIPATH\fRs are provided, the default behavior is to extract the full
44 image, as if the path "/" had been provided.
48 You may use \fB@IMAGEX_PROGNAME@ extract\fR to extract files or directory trees
49 from a split WIM. This uses the \fB--refs\fR="\fIGLOB\fR" option in the same
50 way as in other commands such as \fB@IMAGEX_PROGNAME@ apply\fR. See
51 \fB@IMAGEX_PROGNAME@ apply\fR (1) for more details.
56 When reading \fIWIMFILE\fR, verify its integrity if the integrity table is
59 \fB--ref\fR="\fIGLOB\fR"
60 File glob of additional split WIM parts that are part of the split WIM. See
64 Print the path to of each file or directory within the WIM image as it is
68 See the documentation for this option in \fB@IMAGEX_PROGNAME@-apply\fR (1).
71 See the documentation for this option in \fB@IMAGEX_PROGNAME@-apply\fR (1).
74 See the documentation for this option in \fB@IMAGEX_PROGNAME@-apply\fR (1).
77 Extract the files to standard output instead of to the filesystem. This can
78 only be provided if all the specified \fIPATH\fRs are to regular files (not
79 directories or reparse points). If present, alternate data streams are not
82 \fB--dest-dir\fR=\fIDIR\fR
83 Extract the files and directories to the directory \fIDIR\fR instead of to the
84 current working directory.
88 See the documentation \fB@IMAGEX_PROGNAME@ apply\fR (1) for documentation about
89 what data and metadata are extracted on UNIX versus on Windows.
91 On UNIX, one can alternatively mount the WIM image with \fB@IMAGEX_PROGNAME@
92 mount\fR and then extract the desired files or directories using any standard
93 command-line or graphical program.
95 Reparse-point fixups (a.k.a. changing absolute symbolic links and junctions to
96 point within the extraction location) are never done by \fB@IMAGEX_PROGNAME@
97 extract\fR. Use \fB@IMAGEX_PROGNAME@ apply\fR if you want this behavior.
99 Unlike \fB@IMAGEX_PROGNAME@ apply\fR, \fB@IMAGEX_PROGNAME@ extract\fR does not
100 support extracting files directly to a NTFS volume using libntfs-3g.
103 Extract a file from the first image in "boot.wim" to the current directory:
106 @IMAGEX_PROGNAME@ extract boot.wim 1 /Windows/System32/notepad.exe
109 Extract a file from the first image in "boot.wim" to standard output:
112 @IMAGEX_PROGNAME@ extract boot.wim 1 /Windows/System32/notepad.exe --to-stdout
115 Extract a file from the first image in "boot.wim" to the specified directory:
118 @IMAGEX_PROGNAME@ extract boot.wim 1 /Windows/System32/notepad.exe --dest-dir=somedir
121 Extract the "sources" directory from the first image in "boot.wim" to the
125 @IMAGEX_PROGNAME@ extract boot.wim 1 /sources
128 Extract multiple files and directories in one command:
131 @IMAGEX_PROGNAME@ extract boot.wim 1 /Windows/Fonts /sources /Windows/System32/cmd.exe
136 .BR @IMAGEX_PROGNAME@ (1)
137 .BR @IMAGEX_PROGNAME@-apply (1)
138 .BR @IMAGEX_PROGNAME@-dir (1)
139 .BR @IMAGEX_PROGNAME@-info (1)
140 .BR @IMAGEX_PROGNAME@-mount (1)