imagex.1.in: Update difference list
[wimlib] / doc / imagex.1.in
1 .TH IMAGEX 1 "May 2013" "@IMAGEX_PROGNAME@ @VERSION@" "User Commands"
2 .SH NAME
3 @IMAGEX_PROGNAME@ \- Create, modify, extract, mount, or unmount a WIM (Windows Imaging Format) archive
4 .SH SYNOPSIS
5 \fB@IMAGEX_PROGNAME@ append\fR \fIarguments...\fR
6 .br
7 \fB@IMAGEX_PROGNAME@ apply\fR \fIarguments...\fR
8 .br
9 \fB@IMAGEX_PROGNAME@ capture\fR \fIarguments...\fR
10 .br
11 \fB@IMAGEX_PROGNAME@ delete\fR \fIarguments...\fR
12 .br
13 \fB@IMAGEX_PROGNAME@ dir\fR \fIarguments...\fR
14 .br
15 \fB@IMAGEX_PROGNAME@ export\fR \fIarguments...\fR
16 .br
17 \fB@IMAGEX_PROGNAME@ extract\fR \fIarguments...\fR
18 .br
19 \fB@IMAGEX_PROGNAME@ info\fR \fIarguments...\fR
20 .br
21 \fB@IMAGEX_PROGNAME@ join\fR \fIarguments...\fR
22 .br
23 \fB@IMAGEX_PROGNAME@ mount\fR \fIarguments...\fR
24 .br
25 \fB@IMAGEX_PROGNAME@ mountrw\fR \fIarguments...\fR
26 .br
27 \fB@IMAGEX_PROGNAME@ optimize\fR \fIarguments...\fR
28 .br
29 \fB@IMAGEX_PROGNAME@ split\fR \fIarguments...\fR
30 .br
31 \fB@IMAGEX_PROGNAME@ unmount\fR \fIarguments...\fR
32 .br
33 \fB@IMAGEX_PROGNAME@ update\fR \fIarguments...\fR
34 .SH DESCRIPTION
35 \fB@IMAGEX_PROGNAME@\fR is able to deal with archives in the Windows Imaging
36 Format (.wim files). Its interface is meant to be similar to Microsoft's
37 imagex.exe program.
38 .PP
39 To do its work, \fB@IMAGEX_PROGNAME@\fR uses \fBwimlib\fR, a library which
40 provides interfaces for manipulating WIM archives.  You could wimlib in your own
41 programs if you wanted to.  wimlib's public interface is documented.
42 .SH COMMANDS
43 There is a separate manual page for each \fB@IMAGEX_PROGNAME@\fR command.
44 .SH SUPPORTED FEATURES
45 The following general features are currently supported (note: this is not a
46 complete list; also, certain features, such as mounting, are supported on UNIX
47 but not Windows):
48 .IP \[bu] 4
49 Create a stand-alone WIM from a directory or NTFS volume (\fB@IMAGEX_PROGNAME@ capture\fR)
50 .IP \[bu]
51 Append a directory or NTFS volume onto a stand-alone WIM as a new image (\fB@IMAGEX_PROGNAME@
52 append\fR)
53 .IP \[bu]
54 Apply an image from a stand-alone or split WIM to a directory or NTFS volume
55 (\fB@IMAGEX_PROGNAME@ apply\fR)
56 .IP \[bu]
57 Mount an image from a stand-alone or split WIM read-only (\fB@IMAGEX_PROGNAME@ mount\fR)
58 .IP \[bu]
59 Mount an image from a stand-alone WIM read-write (\fB@IMAGEX_PROGNAME@ mountrw\fR)
60 .IP \[bu]
61 Extract individual files or directories from a WIM without mounting it
62 (\fB@IMAGEX_PROGNAME@ extract\fR)
63 .IP \[bu]
64 Make changes to a WIM image without mounting it (\fB@IMAGEX_PROGNAME@ update\fR)
65 .IP \[bu]
66 Delete image(s) from a stand-alone WIM (\fB@IMAGEX_PROGNAME@ delete\fR)
67 .IP \[bu]
68 Export image(s) from a stand-alone or split WIM (\fB@IMAGEX_PROGNAME@ export\fR)
69 .IP \[bu]
70 Display information about a WIM file (\fB@IMAGEX_PROGNAME@ info\fR, \fB@IMAGEX_PROGNAME@ dir\fR)
71 .IP \[bu]
72 Change the name or description of an image in the WIM (\fB@IMAGEX_PROGNAME@ info\fR)
73 .IP \[bu]
74 Change which image in a WIM is bootable (\fB@IMAGEX_PROGNAME@ info\fR)
75 .IP \[bu]
76 Combine split WIMs into one stand-alone WIM (\fB@IMAGEX_PROGNAME@ join\fR)
77 .IP \[bu]
78 Split a stand-alone WIM into multiple parts (\fB@IMAGEX_PROGNAME@ split\fR)
79 .IP \[bu]
80 Support for all WIM compression types, both compression and decompression (LZX,
81 XPRESS, and none)
82 .IP \[bu]
83 WIM integrity table is supported (\fB--check\fR option to many commands)
84 .IP \[bu]
85 WIM XML data (parsed and written using \fBlibxml\fR(3))
86 .SH DIFFERENCES FROM MICROSOFT IMAGEX
87 Although \fB@IMAGEX_PROGNAME@\fR is similar to Microsoft's implementation of
88 ImageX, there are a number of key differences between the two programs:
89 .IP \[bu] 6
90 \fB@IMAGEX_PROGNAME@\fR is supported on both UNIX-based systems and Windows;
91 thus, much functionality was designed around this.
92 .IP \[bu]
93 The command-line syntax of the two programs is similar but not exactly the same.
94 .IP \[bu]
95 On UNIX, because Microsoft designed the WIM file format to accomodate
96 Windows-specific and NTFS-specific features, wimlib must have two separate image
97 capture and application modes (although the \fB@IMAGEX_PROGNAME@\fR subcommands
98 for the modes are the same): one for general image capture and application, and
99 one for the capture or application of an image specifically from/to an NTFS
100 volume.
101 .IP ""
102 Note: the above applies to UNIX builds of \fB@IMAGEX_PROGNAME@\fR.  On the
103 Windows build, there is only one image capture and application mode, similar to
104 Microsoft's ImageX.
105 .IP \[bu]
106 Microsoft's version has some weird limitations, like it won't let you extract a
107 WIM on a shared folder, and it requires some commands to be run only from
108 Windows PE and not from regular Windows.  \fB@IMAGEX_PROGNAME@\fR does not have
109 these unusual limitations.
110 .IP \[bu]
111 There are bugs in Microsoft's WIM library and I obviously have not included the
112 same bugs in wimlib, although in some cases I have had to work around bugs for
113 compatibility purposes.
114 .IP \[bu]
115 \fB@IMAGEX_PROGNAME@\fR offers the extra command \fB@IMAGEX_PROGNAME@ optimize\fR,
116 which lets you easily remove wasted space in a WIM (which can arise after
117 a WIM image is appended or mounted read-write).
118 .IP \[bu]
119 \fB@IMAGEX_PROGNAME@\fR also offers the command \fB@IMAGEX_PROGNAME@ join\fR, which lets you
120 easily join the parts of a split WIM.
121 .IP \[bu]
122 \fB@IMAGEX_PROGNAME@\fR offers the extra commands \fB@IMAGEX_PROGNAME@
123 extract\fR and \fB@IMAGEX_PROGNAME@ update\fR, which let you quickly extract
124 files from or make changes to a WIM image without mounting it.
125 .IP \[bu]
126 \fB@IMAGEX_PROGNAME@ apply\fR supports keeping files hard-linked or symlinked
127 across WIM images when extracted from a WIM.  So you can, for example, extract
128 different versions of Windows from an install.wim without using much extra
129 space.  (Note: this functionality is only available in UNIX builds of wimlib.)
130 .IP \[bu]
131 \fB@IMAGEX_PROGNAME@ capture\fR supports combining multiple separate directories
132 and files together in a configurable way to create a WIM image.
133 .IP \[bu]
134 wimlib's XPRESS compressor is better than Microsoft's.
135 .IP \[bu]
136 wimlib's LZX compressor is worse than Microsoft's.
137 .IP \[bu]
138 wimlib supports multithreaded compression, which can make it much faster to
139 create compressed WIM files.
140 .IP \[bu]
141 \fB@IMAGEX_PROGNAME@ capture\fR supports a special mode where UNIX file modes,
142 owners, and groups are stored.  (Note: this functionality is only available in
143 UNIX builds.)
144 .IP \[bu]
145 \fB@IMAGEX_PROGNAME@ mount\fR and \fB@IMAGEX_PROGNAME@ mountrw\fR are much faster than
146 Microsoft's versions for some reason.  I don't know what they have their program
147 do that takes so long to simply set up a mountpoint.  (Note: this functionality
148 is only available in UNIX builds.)
149 .IP \[bu]
150 \fB@IMAGEX_PROGNAME@ mount\fR supports mounting an image from a split WIM, but
151 Microsoft's software does not.  (Note: this functionality is only available in
152 UNIX builds.)
153 .SH LOCALES AND CHARACTER ENCODINGS
154 On Windows, wimlib works in UTF-16LE, and there should be no problems with
155 character encodings.
156 .PP
157 On UNIX, wimlib works primarily in the locale-dependent multibyte encoding,
158 which you are strongly recommended to set to UTF-8 to avoid any problems.
159 .SH WARNING
160 Note: \fBwimlib\fR and \fB@IMAGEX_PROGNAME@\fR are experimental.  Use Microsoft's
161 imagex.exe if you have to make sure your WIM files are made "correctly".  Feel
162 free to submit a bug report if you find a bug.
163 .PP
164 Some parts of the WIM file format are poorly documented or even completely
165 undocumented, so I've just had to do the best I can to read and write WIMs in a
166 way that appears to be compatible with Microsoft's software.
167 .SH REPORTING BUGS
168 Report bugs to ebiggers3@gmail.com.
169 .SH SEE ALSO
170 .BR @IMAGEX_PROGNAME@-append (1),
171 .BR @IMAGEX_PROGNAME@-apply (1),
172 .BR @IMAGEX_PROGNAME@-capture (1),
173 .BR @IMAGEX_PROGNAME@-delete (1),
174 .BR @IMAGEX_PROGNAME@-dir (1),
175 .BR @IMAGEX_PROGNAME@-export (1),
176 .BR @IMAGEX_PROGNAME@-extract (1),
177 .BR @IMAGEX_PROGNAME@-info (1),
178 .BR @IMAGEX_PROGNAME@-join (1),
179 .BR @IMAGEX_PROGNAME@-mount (1),
180 .BR @IMAGEX_PROGNAME@-mountrw (1),
181 .BR @IMAGEX_PROGNAME@-optimize (1),
182 .BR @IMAGEX_PROGNAME@-split (1),
183 .BR @IMAGEX_PROGNAME@-unmount (1),
184 .BR @IMAGEX_PROGNAME@-update (1),