Documentation fixes/additions
[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 unmount\fR \fIarguments...\fR
26
27 .SH DESCRIPTION
28 \fBimagex\fR is able to deal with archives in the Windows Imaging Format (.wim
29 files). Its interface is meant to be similar to Microsoft's imagex.exe program.
30
31 To do its work, \fBimagex\fR uses \fBwimlib\fR, a library which provides
32 interfaces for manipulating WIM archives.  You could wimlib in your own programs
33 if you wanted to.  Wimlib's public interface is documented.
34
35 See \fBWARNING\fR.
36
37 .SH COMMANDS
38
39 There is a separate manual page for each \fBimagex\fR command.
40
41 .SH SUPPORTED FEATURES
42
43 The following features are currently supported:
44
45 .IP \[bu] 2
46 Mount an image in a WIM read-only (\fBimagex mount\fR)
47 .IP \[bu] 2
48 Mount an image in a WIM read-write (\fBimagex mountrw\fR)
49 .IP \[bu] 2
50 LZX decompression and compression
51 .IP \[bu] 2
52 XPRESS decompression and compression
53 .IP \[bu] 2
54 Integrity table
55 .IP \[bu] 2
56 XML data (parsed and written using \fBlibxml\fR(3))
57 .IP \[bu] 2
58 Create a WIM from a directory (\fBimagex capture\fR)
59 .IP \[bu] 2
60 Append a directory onto a WIM as a new image (\fBimagex append\fR)
61 .IP \[bu] 2
62 Delete image(s) from a WIM (\fBimagex delete\fR)
63 .IP \[bu] 2
64 Export image(s) from a WIM (\fBimagex export\fR)
65 .IP \[bu] 2
66 Display information about a WIM file (\fBimagex info\fR, \fBimagex dir\fR)
67 .IP \[bu] 2
68 Change the name or description of an image in the WIM (\fBimagex info\fR)
69 .IP \[bu] 2
70 Change which image in a WIM is bootable (\fBimagex info\fR)
71 .IP \[bu] 2
72 Combining split WIMs into one WIM (\fBimage join\fR)
73
74 .SH UNSUPPORTED FEATURES
75 The following features are currently unsupported:
76 .IP \[bu] 2
77 File permissions and security descriptors are ignored.  The information
78 contained in them in an existing WIM will be lost when wimlib writes a WIM file.
79 This does not seem to matter for Windows PE, but this means that you should not
80 use this program to image a drive containing Windows Vista/7/8 and expect it to
81 be applied with the correct file permissions.
82 .IP \[bu] 2
83 Split WIMs are not fully supported.  These can be used to split up a WIM to fit
84 on multiple CDs, if you can't use a DVD for some reason.  You can use
85 \fBimagex join\fR to combine split WIMs, but you cannot yet create split WIMs or
86 mount them directly.
87 .IP \[bu] 2
88 The \fB--verify\fR option, for all commands that use it.  Without this option,
89 there theoretically could be a SHA1 hash collision between two files, although
90 it's very unlikely.
91 .IP \[bu] 2
92 The \fB--config\fR option, for all commands that use it. 
93 .IP \[bu] 2
94 Alternate stream entries
95 .IP \[bu] 2
96 Different versions of the WIM file format (if different versions even exist)
97
98 Also see the Doxygen documentation for Wimlib.
99
100 .SH DIFFERENCES FROM MICROSOFT IMAGEX
101
102 See \fBUNSUPPORTED FEATURES\fR.
103
104 The \fB/scroll\fR and \fB/log\fR switches from Microsoft's version imagex are
105 not planned to be implemented.  Note that to scroll the output in the UNIX shell
106 you can just pipe the output into \fBless\fR(1).
107
108 Some features, such as the ability to keep files hard-linked when they are
109 extracted from a WIM, are not available in Microsoft's version of imagex.
110
111 See the documentation for each command; in some cases they do not do exactly the
112 same thing as imagex.exe.
113
114 Obviously, this version of imagex is free software but Microsoft's version is
115 not.
116
117 .SH WARNING
118
119 Note: \fBwimlib\fR and \fBimagex\fR are experimental.  Use Microsoft's
120 imagex.exe if you have to make sure your WIM files are made correctly.  Not all
121 features listed under \fBSUPPORTED FEATURES\fR have been thoroughly tested.
122 Feel free to submit a bug report if you find a bug.
123
124 Some parts of the WIM file format are poorly documented or even completely
125 undocumented, so these parts had to be reverse engineered for compatibility
126 purposes.
127
128 .SH REPORTING BUGS
129
130 Report bugs to ebiggers3@gmail.com.
131
132 .SH SEE ALSO
133 .BR imagex-append (1),
134 .BR imagex-apply (1),
135 .BR imagex-capture (1),
136 .BR imagex-delete (1),
137 .BR imagex-dir (1),
138 .BR imagex-export (1),
139 .BR imagex-info (1),
140 .BR imagex-join (1),
141 .BR imagex-mount (1),
142 .BR imagex-mountrw (1),
143 .BR imagex-unmount (1),
144