--disable-multithreaded-compression option
[wimlib] / README
1                                    WIMLIB
2
3 This is wimlib version 1.0.4 (October 2012).  wimlib can be used to read,
4 write, and mount files in the Windows Imaging Format (WIM files).  These
5 files are normally created by using the `imagex.exe' utility on Windows,
6 but this library provides a free implementation of imagex for UNIX-based
7 systems.
8
9                                    WIM FILES
10
11 A Windows Imaging (WIM) file is an archive.  Like some other archive formats
12 such as ZIP, files in WIM archives may be compressed.  WIM archives support two
13 Microsoft-specific compression formats:  LZX and XPRESS.  Both are based on LZ77
14 and Huffman encoding, and both are supported by wimlib.
15
16 Unlike ZIP files, WIM files can contain multiple independent toplevel directory
17 trees known as images.  While each image has its own metadata describing a
18 directory tree and file access modes, files are not duplicated for each image;
19 instead, each file is included only once in the entire WIM.  Microsoft did this
20 so that in one WIM file, they could do things like have 5 different versions of
21 Windows that are almost exactly the same.
22
23 Microsoft provides documentation for the WIM file format, XPRESS compression
24 format, and LZX compression format.  The XPRESS documentation is acceptable, but
25 the LZX documentation is not entirely correct, and the WIM documentation itself
26 is very incomplete and is of unacceptable quality.
27
28 A WIM file may be either stand-alone or split into multiple parts.
29
30                                     PROGRAMS
31
32 wimlib provides a public API for other programs to use, but also comes with two
33 programs: `imagex' and `mkwinpeimg'.
34
35 `imagex' is intended to be like the imagex.exe program from Windows.  `imagex'
36 can be used to create, extract, and mount WIM files.  Both read-only and
37 read-write mounts are supported.  See the man page `doc/imagex.1' for more
38 details.
39
40 `mkwinpeimg' is shell script that makes it easy to create a customized bootable
41 image of Windows PE that can be put on a CD or USB drive, or published on a
42 server for PXE booting.  See the main page `doc/mkwinpeimg.1' for more details.
43
44                                COMPRESSION RATIO
45
46 wimlib can create XPRESS or LZX compressed WIM archives.  As of wimlib v1.0.3,
47 the XPRESS compression ratio is slightly better than that provided by
48 Microsoft's software, while the LZX compression ratio is approaching that of
49 Microsoft's software but is not quite there yet.  Running time is as good as or
50 better than Microsoft's software.
51
52 The following tables compare the compression ratio and performance for creating
53 a compressed Windows PE image (disk usage of about 524 MB, uncompressed WIM size
54 361 MB):
55
56         Table 1. WIM size
57
58                                         XPRESS Compression      LZX Compression
59         wimlib imagex (v1.0.2):         145,283,871 bytes       139,288,293 bytes
60         wimlib imagex (v1.0.3):         139,288,293 bytes       131,379,869 bytes
61         Microsoft imagex.exe:           140,406,981 bytes       127,249,176 bytes
62
63         Table 2. Time to create WIM
64
65                                         XPRESS Compression      LZX Compression
66         wimlib imagex (v1.0.2):         18 sec                  49 sec
67         wimlib imagex (v1.0.3):         19 sec                  30 sec
68         Microsoft imagex.exe:           25 sec                  89 sec
69
70                                   NTFS SUPPORT
71
72 As of version 1.0.0, wimlib supports capturing and applying images directly to
73 NTFS volumes.  This was made possible with the help of libntfs-3g from the
74 NTFS-3g project.  This feature supports capturing and restoring NTFS-specific
75 data such as security descriptors, alternate data streams, and reparse point
76 data.
77
78 The code for NTFS image capture and image application is complete enough that it
79 is possible to apply an image from the "install.wim" contained in recent Windows
80 installation media (Vista, Windows 7, or Windows 8) directly to a NTFS volume,
81 and then boot Windows from it after preparing the Boot Configuration Data.  In
82 addition, a Windows installation can be captured (or backed up) into a WIM file,
83 and then re-applied later.
84
85                                    WINDOWS PE
86
87 A major use for this library is to create customized images of Windows PE, the
88 Windows Preinstallation Environment, without having to rely on Windows.  Windows
89 PE is a lightweight version of Windows that can run entirely from memory and can
90 be used to install Windows from local media or a network drive or perform
91 maintenance.  Windows PE is the operating system that runs when you boot from
92 the Windows installation media.
93
94 You can find Windows PE on the installation DVD for Windows Vista, Windows 7, or
95 Windows 8, in the file `sources/boot.wim'.  Windows PE can also be found in the
96 Windows Automated Installation Kit (WAIK), which is free to download from
97 Microsoft, inside the `WinPE.cab' file, which you can extract if you install
98 either the `cabextract' or `p7zip' programs.
99
100 In addition, Windows installations and recovery partitions frequently contain a
101 WIM containing an image of the Windows Recovery Environment, which is similar to
102 Windows PE.
103
104                                   DEPENDENCIES
105
106 * libxml2 (required)
107         This is a commonly used free library to read and write XML files.  You
108         likely already have it installed as a dependency for some other program.
109         For more information see http://xmlsoft.org/.
110
111 * libfuse (optional but highly recommended)
112         Unless configured with --without-fuse, wimlib requires a non-ancient
113         version of libfuse to be installed.  Most GNU/Linux distributions
114         already include this, but make sure you have the libfuse package
115         installed, and also libfuse-dev if your distribution distributes header
116         files separately.  FUSE also requires a kernel module.  If the kernel
117         module is available it will automatically be loaded if you try to mount
118         a WIM file.  For more information see http://fuse.sourceforge.net/.
119         FUSE is also available for FreeBSD.
120
121 * libntfs-3g (optional but highly recommended)
122         Unless configured with --without-ntfs-3g, wimlib requires the library
123         and headers for libntfs-3g version 2011-4-12 or later to be installed.
124         Versions dated 2010-3-6 and earlier do not work because they are missing
125         the header xattrs.h (and the file xattrs.c, which contains functions we
126         need).
127
128 * OpenSSL / libcrypto (optional)
129         wimlib can use the SHA1 message digest code from OpenSSL instead of
130         compiling in yet another SHA1 implementation.   (See LICENSE section.)
131
132 * cdrkit (optional)
133 * mtools (optional)
134 * syslinux (optional)
135 * cabextract (optional)
136         The `mkwinpeimg' shell script will look for several other programs
137         depending on what options are given to it.  Depending on your GNU/Linux
138         distribution, you may already have these programs installed, or they may
139         be in the software repository.  Making an ISO filesystem requires
140         `mkisofs' from `cdrkit' (http://www.cdrkit.org).  Making a disk image
141         requires `mtools' (http://www.gnu.org/software/mtools) and `syslinux'
142         (http://www.syslinux.org).  Retrieving files from the Windows Automated
143         Installation Kit requires `cabextract' (http://www.cabextract.org.uk).
144
145                                  CONFIGURATION
146
147 Besides the various well-known options, the following options can be passed to
148 wimlib's `configure' script:
149
150 --without-ntfs-3g
151         If libntfs-3g is not available or is not version 2011-4-12 or later, we
152         can build without it.  wimlib will then not be able to apply or capture
153         images directly to NTFS volumes.
154
155 --without-fuse
156         If libfuse or the FUSE kernel module is not available, wimlib can be
157         compiled with --without-fuse.  This will remove the ability to mount and
158         unmount WIM files.  wimlib_mount() and wimlib_unmount() will fail with
159         WIMLIB_ERR_UNSUPPORTED.
160
161 --without-libcrypto
162         Build in functions for SHA1 rather than using external SHA1 functions
163         from libcrypto (part of OpenSSL).  The default is to use libcrypto if it
164         is found on the system.
165
166 --enable-xattr, --disable-xattr
167         Enable or disable support for the extended-attributes interface to NTFS
168         alternate data streams in mounted WIMs.  To support these, we require
169         the setxattr() function and the attr/xattr.h header be available.  The
170         default is to autodetect whether support is possible.
171
172 --disable-multithreaded-compression
173         By default, data will be compressed using multiple threads when writing
174         a WIM, unless only 1 processor is detected.  Specify this option to
175         disable support for this.
176
177 --enable-ssse3-sha1
178         Use a very fast assembly language implementation of SHA1 from Intel.
179         Only use this if the build target supports the SSSE3 instructions.
180
181 --disable-custom-memory-allocator
182         If this option is given, MALLOC(), FREE(), CALLOC(), and STRDUP() will
183         directly call the appropriate functions in the C library.
184         wimlib_set_memory_allocator() will fail with WIMLIB_ERR_UNSUPPORTED.
185
186 --disable-verify-compression
187         Unless this option is given, every time wimlib compresses a data block
188         it will decompress it into a temporary buffer and abort() the program
189         with an error message if the decompressed data does not exactly match
190         the original data.  This is to find bugs.
191
192 --disable-error-messages
193         Removes all error messages from the library.  If left in, they still
194         have to explicitly turned on with wimlib_set_print_errors() in order to
195         see them.  Also, error codes will still be returned regardless of
196         whether error messages are printed or not.
197
198         If --disable-error-messages is given, wimlib_set_print_errors() will
199         fail with WIMLIB_ERR_UNSUPPORTED if the action is to turn error messages
200         on.
201
202 --disable-assertions
203         Remove all assertions.  Without this option, wimlib will abort() the
204         program if an assertion fails.  An assertion failure should only occur
205         if there is a bug in the library.
206
207 --enable-debug
208         Include debugging messages.  Only use this option if you have found a
209         bug in the library.
210
211 --enable-more-debug
212         Include more debugging messages.  Only use this option if you have found
213         a bug in the library.
214
215                                   PORTABILITY
216
217 wimlib has mostly been developed and tested on x86_64 (64-bit) GNU/Linux.
218
219 It has been tested on x86 (32-bit) GNU/Linux occasionally.
220
221 wimlib may work on FreeBSD.  However, this is not well tested.  If you do not
222 have libntfs-3g 2011-4-12 or later available, you must configure with
223 --without-ntfs-3g.  Also, GNU coreutils is needed to run the test suite.  Before
224 mounting a WIM you need to load the POSIX message queue module (run `kldload
225 mqueuefs').
226
227 wimlib should work on big endian machines but it has not been tested.
228
229 There are no plans to port wimlib to Windows since the programming interface on
230 Windows is very different and Microsoft's imagex.exe is already available.
231
232                                    REFERENCES
233
234 The WIM file format is specified in a document that can be found in the
235 Microsoft Download Center.  There is a similar document that specifies the LZX
236 compression format, and a document that specifies the XPRESS compression format.
237 However, many parts of these formats are poorly documented, and some parts have
238 no documentation whatsoever.  Some particularly poorly documented parts of the
239 formats have had comments added in various places in the library.  Please see
240 the code and/or ask me if you have any questions about the WIM file format as it
241 exists in reality and not as it exists in Microsoft's poorly written
242 documentation.
243
244 The code in ntfs-apply.c and ntfs-capture.c uses the NTFS-3g library, which is a
245 library for reading and writing to NTFS filesystems (the filesystem used by
246 recent versions of Windows).  See
247 http://www.tuxera.com/community/ntfs-3g-download/ for more information.
248
249 lzx-decomp.c, the code to decompress WIM file resources that are compressed
250 using LZX compression, is originally based on code from the cabextract project
251 (http://www.cabextract.org.uk).
252
253 lzx-comp.c, the code to compress WIM file resources using LZX compression, is
254 originally based on code written by Matthew Russotto (www.russotto.net/chm/).
255
256 lz.c, the code to find LZ77 matches (used for both XPRESS and LZX compression),
257 is based on code from zlib.
258
259 A very limited number of other free programs can handle some parts of the WIM
260 file format.  7-zip is able to extract and create WIMs (as well as files in many
261 other archive formats).  However, wimlib is designed specifically to handle WIM
262 files and provides features previously only available in Microsoft's imagex.exe,
263 such as the ability to mount WIMs read-write as well as read-only, and the
264 ability to create LZX or XPRESS compressed WIMs.
265
266 An earlier version of wimlib is being used to deploy Windows 7 from the Ultimate
267 Deployment Appliance.  For more information see
268 http://www.ultimatedeployment.org/.
269
270 You can see the documentation about Microsoft's version of the imagex program at
271 http://technet.microsoft.com/en-us/library/cc749447(v=ws.10).aspx, so you can
272 see how it compares.
273
274                       GNU/Linux equivalents of WIM format
275
276 What's the equivalent way to capture the filesystem of a GNU/Linux operating
277 system into an archive file?  You have a few options:
278
279 SquashFS:
280         SquashFS (http://squashfs.sourceforge.net/) provides a compressed,
281         read-only filesystem for Linux, and it's probably the closest equivalent
282         of the WIM format and better designed.  Although you can't mount
283         SquashFS read-write, when wimlib does this for WIM files it's really an
284         illusion since the WIM isn't actually modified until the image is
285         unmounted.  Multiple top-level images in SquashFS files are not
286         supported, although nothing stops you from just putting each image in a
287         separate directory.
288
289 FSArchiver:
290         FSArchiver (http://www.fsarchiver.org/Main_Page) is not widely used, but
291         it appears to have some features quite similar to the WIM format.
292
293 Tar:
294         The well-known tar format can usually capture a UNIX filesystem just
295         fine, and compressing the tar file produces a good compression ratio
296         (better than WIM, especially if using XZ compression), but there is no
297         support for random access, file deduplication, multiple images per
298         archive, or extended attributes.
299
300 Zip:
301         Zip shares some features with WIM but is not designed to store entire
302         filesystems.
303
304 7z:
305         The 7z format has some nice features but is unfortunately not designed
306         with UNIX in mind.
307
308                                 MORE INFORMATION
309
310 See the manual pages for `imagex', the manual pages for the subcommands of
311 `imagex', and the manual page for `mkwinpeimg'.
312
313 As of version 0.5.0, wimlib's public API is documented.  Doxygen is required to
314 build the documentation.  To build the documentation, run `configure', then
315 enter the directory `doc' and run `doxygen'.  The HTML documentation will be
316 created in a directory named `html'.
317
318                                     LICENSE
319
320 As of version 1.0.0, wimlib is released under the GNU GPL version 3.0 or later.
321 This includes the files in the `programs' directory as well as the files in the
322 `src' directory.
323
324 wimlib is independently developed and does not contain any code, data, or files
325 copyrighted by Microsoft.  It is not known to be affected by any patents.
326
327 By default, wimlib will be linked to the system library "libcrypto", which
328 probably will be OpenSSL.  Some people believe that GPL code cannot be linked to
329 OpenSSL without a linking exception.  As far as I know, I cannot officially
330 include a linking exception with the license of this library because several
331 files could be considered derived works of LGPL code copyrighted by others.  If
332 you believe this to be a problem, configure with --without-libcrypto to avoid
333 linking with OpenSSL.  There is no difference in functionality--- there will
334 just be stand-alone SHA1 message digest code built into the library.
335
336                                    DISCLAIMER
337
338 wimlib is experimental.  Use Microsoft's `imagex.exe' if you want to make sure
339 your WIM files are made correctly (but beware: Microsoft's version contains some
340 bugs).
341
342 Please submit a bug report (to ebiggers3@gmail.com) if you find a bug in wimlib.
343
344 Some parts of the WIM file format are poorly documented or even completely
345 undocumented, so I've just had to do the best I can to read and write WIMs that
346 appear to be compatible with Microsoft's software.