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