Support for copying security data
[wimlib] / doc / imagex.1.in
1 .TH IMAGEX 1 "May 2012" "imagex (wimlib @VERSION@)" "User Commands"
2 .SH NAME
3 imagex \- Create, modify, extract, mount, or unmount a WIM (Windows Imaging Format) archive
4 .SH SYNOPSIS
5 \fBimagex append\fR \fIarguments...\fR
6 .br
7 \fBimagex apply\fR \fIarguments...\fR
8 .br
9 \fBimagex capture\fR \fIarguments...\fR
10 .br
11 \fBimagex delete\fR \fIarguments...\fR
12 .br
13 \fBimagex dir\fR \fIarguments...\fR
14 .br
15 \fBimagex export\fR \fIarguments...\fR
16 .br
17 \fBimagex info\fR \fIarguments...\fR
18 .br
19 \fBimagex join\fR \fIarguments...\fR
20 .br
21 \fBimagex mount\fR \fIarguments...\fR
22 .br
23 \fBimagex mountrw\fR \fIarguments...\fR
24 .br
25 \fBimagex split\fR \fIarguments...\fR
26 .br
27 \fBimagex unmount\fR \fIarguments...\fR
28
29 .SH DESCRIPTION
30 \fBimagex\fR is able to deal with archives in the Windows Imaging Format (.wim
31 files). Its interface is meant to be similar to Microsoft's imagex.exe program.
32
33 To do its work, \fBimagex\fR uses \fBwimlib\fR, a library which provides
34 interfaces for manipulating WIM archives.  You could wimlib in your own programs
35 if you wanted to.  Wimlib's public interface is documented.
36
37 See \fBWARNING\fR.
38
39 .SH COMMANDS
40
41 There is a separate manual page for each \fBimagex\fR command.
42
43 .SH SUPPORTED FEATURES
44
45 The following features are currently supported:
46
47 .IP \[bu] 2
48 Mount an image in a WIM read-only (\fBimagex mount\fR)
49 .IP \[bu] 2
50 Mount an image in a WIM read-write (\fBimagex mountrw\fR)
51 .IP \[bu] 2
52 Create a WIM from a directory (\fBimagex capture\fR)
53 .IP \[bu] 2
54 Append a directory onto a WIM as a new image (\fBimagex append\fR)
55 .IP \[bu] 2
56 Delete image(s) from a WIM (\fBimagex delete\fR)
57 .IP \[bu] 2
58 Export image(s) from a WIM (\fBimagex export\fR)
59 .IP \[bu] 2
60 Display information about a WIM file (\fBimagex info\fR, \fBimagex dir\fR)
61 .IP \[bu] 2
62 Change the name or description of an image in the WIM (\fBimagex info\fR)
63 .IP \[bu] 2
64 Change which image in a WIM is bootable (\fBimagex info\fR)
65 .IP \[bu] 2
66 Combining split WIMs into one WIM (\fBimage join\fR)
67 .IP \[bu] 2
68 Splitting a WIM into multiple parts (\fBimage split\fR)
69 .IP \[bu] 2
70 Support for all WIM compression types, both compression and decompression (LZX,
71 XPRESS, and none)
72 .IP \[bu] 2
73 Integrity table
74 .IP \[bu] 2
75 XML data (parsed and written using \fBlibxml\fR(3))
76
77 .SH UNSUPPORTED FEATURES
78 The following features are currently unsupported:
79 .IP \[bu] 2
80 Wimlib cannot add security data when it captures a WIM file, although it will
81 preserve security data for existing WIM files.  New files added to a mounted
82 WIM will be added without security data.  This does not seem to matter for
83 Windows PE, but this means that you should not use this program to image a drive
84 containing Windows Vista/7/8 and expect it to be applied with the correct file
85 permissions.
86 .IP \[bu] 2
87 Alternate file streams are unsupported and will be lost when wimlib writes a WIM
88 file.  Note that you shouldn't really have these on your Windows system anyway
89 because they are unneeded and a security risk.
90 .IP \[bu] 2
91 Directly applying or mounting split WIMs is unsupported.  You have to combine
92 them together with \fBimagex join\fR first.
93 .IP \[bu] 2
94 The \fB--verify\fR option, for all commands that use it is unsupported.  Without
95 this option, there theoretically could be a SHA1 hash collision between two
96 files, although it's very unlikely.  You can still verify a WIM manually by
97 capturing it, then applying it to a different location, then running a recursive
98 diff on the two directory trees.
99 .IP \[bu] 2
100 The \fB--config\fR option, for all commands that use it.
101 .IP \[bu] 2
102 Different versions of the WIM file format (if different versions even exist).
103
104 Also see the Doxygen documentation for Wimlib.
105
106 .SH DIFFERENCES FROM MICROSOFT IMAGEX
107
108 See \fBUNSUPPORTED FEATURES\fR.
109
110 The most important difference is that this version of \fBimagex\fR cannot
111 capture and restore Windows images losslessly because file permissions and
112 alternate file streams cannot be captured.  This is because Microsoft designed
113 the WIM format to be specific to their NTFS filesystem and the Windows security
114 model/API, which is difficult to support in a non-Windows program.  However, you
115 can still create images of Windows PE, even from a directory tree on a non-NTFS
116 filesystem.
117
118 See the documentation for each subcommand of \fBimagex\fR; in some cases they do
119 not do exactly the same thing as imagex.exe.
120
121 Some features, such as the ability to keep files hard-linked when they are
122 extracted from a WIM, are not available in Microsoft's version of imagex.
123 Also, doesn't seem to be an equivalent of \fBimagex join\fR in Microsoft's
124 version; you would have to use \fBimagex.exe /export\fR, but that doesn't let
125 you export all images at once.
126
127 Microsoft's version has some weird limitations, like it won't let you extract a
128 WIM on a shared folder, and it requires some commands to be run only from
129 Windows PE and not from regular Windows.  This version does not have these
130 unusual limitations, although it won't actually run on Windows anyway.
131
132 The \fB/scroll\fR and \fB/log\fR switches from Microsoft's version of imagex
133 will not be implemented.  Note that to scroll the output in the UNIX shell you
134 can just pipe the output into \fBless\fR(1).
135
136 Obviously, this version of imagex is free software but Microsoft's version is
137 not.
138
139 .SH WARNING
140
141 Note: \fBwimlib\fR and \fBimagex\fR are experimental.  Use Microsoft's
142 imagex.exe if you have to make sure your WIM files are made "correctly".  Not
143 all features listed under \fBSUPPORTED FEATURES\fR have been thoroughly tested.
144 Feel free to submit a bug report if you find a bug.
145
146 Some parts of the WIM file format are poorly documented or even completely
147 undocumented, so I've just had to do the best I can to read and write WIMs in a
148 way that appears to be compatible with Microsoft's software.
149
150 .SH REPORTING BUGS
151
152 Report bugs to ebiggers3@gmail.com.
153
154 .SH SEE ALSO
155 .BR imagex-append (1),
156 .BR imagex-apply (1),
157 .BR imagex-capture (1),
158 .BR imagex-delete (1),
159 .BR imagex-dir (1),
160 .BR imagex-export (1),
161 .BR imagex-info (1),
162 .BR imagex-join (1),
163 .BR imagex-mount (1),
164 .BR imagex-mountrw (1),
165 .BR imagex-split (1),
166 .BR imagex-unmount (1),
167