Update version number to 1.4.0; update NEWS
[wimlib] / doc / imagex-extract.1.in
1 .TH IMAGEX "1" "May 2013" "@IMAGEX_PROGNAME@ @VERSION@" "User Commands"
2 .SH NAME
3 @IMAGEX_PROGNAME@-extract \- Extract files or directories from a WIM image
4
5 .SH SYNOPSIS
6 \fB@IMAGEX_PROGNAME@ extract\fR \fIWIMFILE\fR \fIIMAGE\fR [\fIPATH\fR...]  [\fIOPTION\fR...]
7
8 .SH DESCRIPTION
9 .PP
10
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
13 \fIWIMFILE\fR.
14
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.
18
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.
23
24 Each \fIPATH\fR specifies a file or directory tree within the WIM image to
25 extract.  See \fBPATH_SPECIFICATIONS\fR.
26
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
30 program.
31
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.
34
35 .SH PATH SPECIFICATIONS
36
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.
42
43 If no \fIPATH\fRs are provided, the default behavior is to extract the full
44 image, as if the path "/" had been provided.
45
46 .SH SPLIT WIMS
47
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.
52
53 .SH OPTIONS
54 .TP 6
55 \fB--check\fR
56 When reading \fIWIMFILE\fR, verify its integrity if the integrity table is
57 present.
58 .TP
59 \fB--ref\fR="\fIGLOB\fR"
60 File glob of additional split WIM parts that are part of the split WIM.  See
61 \fBSPLIT_WIMS\fR.
62 .TP
63 \fB--verbose\fR
64 Print the path to of each file or directory within the WIM image as it is
65 extracted.
66 .TP
67 \fB--unix-data\fR
68 See the documentation for this option in \fB@IMAGEX_PROGNAME@-apply\fR (1).
69 .TP
70 \fB--no-acls\fR
71 See the documentation for this option in \fB@IMAGEX_PROGNAME@-apply\fR (1).
72 .TP
73 \fB--strict-acls\fR
74 See the documentation for this option in \fB@IMAGEX_PROGNAME@-apply\fR (1).
75 .TP
76 \fB--to-stdout\fR
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
80 extracted.
81
82 .SH NOTES
83
84 See the documentation \fB@IMAGEX_PROGNAME@ apply\fR (1) for documentation about
85 what data and metadata are extracted on UNIX versus on Windows.
86
87 On UNIX, one can alternatively mount the WIM image with \fB@IMAGEX_PROGNAME@
88 mount\fR and then extract the desired files or directories using any standard
89 command-line or graphical program.
90
91 Reparse-point fixups (a.k.a. changing absolute symbolic links and junctions to
92 point within the extraction location) are never done by \fB@IMAGEX_PROGNAME@
93 extract\fR.  Use \fB@IMAGEX_PROGNAME@ apply\fR if you want this behavior.
94
95 Unlike \fB@IMAGEX_PROGNAME@ apply\fR, \fB@IMAGEX_PROGNAME@ extract\fR does not
96 support extracting files directly to a NTFS volume using libntfs-3g.
97
98 .SH EXAMPLES
99 Extract a file from the first image in "boot.wim" to the current directory:
100 .RS
101 .PP
102 @IMAGEX_PROGNAME@ extract boot.wim 1 /Windows/System32/notepad.exe
103 .RE
104 .PP
105 Extract a file from the first image in "boot.wim" to standard output:
106 .RS
107 .PP
108 @IMAGEX_PROGNAME@ extract boot.wim 1 /Windows/System32/notepad.exe --to-stdout
109 .RE
110 .PP
111 Extract a file from the first image in "boot.wim" to the specified directory:
112 .RS
113 .PP
114 @IMAGEX_PROGNAME@ extract boot.wim 1 /Windows/System32/notepad.exe --dest-dir=somedir
115 .RE
116 .PP
117 Extract the "sources" directory from the first image in "boot.wim" to the
118 current directory:
119 .RS
120 .PP
121 @IMAGEX_PROGNAME@ extract boot.wim 1 /sources
122 .RE
123 .PP
124 Extract multiple files and directories in one command:
125 .RS
126 .PP
127 @IMAGEX_PROGNAME@ extract boot.wim 1 /Windows/Fonts /sources /Windows/System32/cmd.exe
128 .RE
129 .PP
130
131 .SH SEE ALSO
132 .BR @IMAGEX_PROGNAME@ (1)
133 .BR @IMAGEX_PROGNAME@-apply (1)
134 .BR @IMAGEX_PROGNAME@-dir (1)
135 .BR @IMAGEX_PROGNAME@-info (1)
136 .BR @IMAGEX_PROGNAME@-mount (1)