Use v1.8.0 as next version instead of v1.7.5
[wimlib] / README
1                                   INTRODUCTION
2
3 This is wimlib version 1.8.0-BETA (February 2015).  wimlib is a C library for
4 creating, modifying, extracting, and mounting files in the Windows Imaging
5 Format (WIM files).  wimlib and its command-line frontend 'wimlib-imagex'
6 provide a free and cross-platform alternative to Microsoft's WIMGAPI, ImageX,
7 and DISM.
8
9                                   INSTALLATION
10
11 To install wimlib and wimlib-imagex on Windows, simply download and extract the
12 ZIP file containing the latest binaries from the SourceForge page
13 (http://sourceforge.net/projects/wimlib/).  You probably have already done this!
14
15 To install wimlib and wimlib-imagex on UNIX-like systems (with Linux being the
16 primary supported and tested platform), you must compile the source code, which
17 is also available at http://sourceforge.net/projects/wimlib/.  Alternatively,
18 check if a package has been prepared for your Linux distribution.  Example files
19 for Debian and RPM packaging are in the debian/ and rpm/ directories.
20
21                                     WIM FILES
22
23 A Windows Imaging (WIM) file is an archive designed primarily for archiving
24 Windows filesystems.  However, it can be used on other platforms as well, with
25 some limitations.  Like some other archive formats such as ZIP, files in WIM
26 archives may be compressed.  WIM files support multiple compression formats,
27 including LZX, XPRESS, and LZMS.  All these formats are supported by wimlib.
28
29 A WIM file consists of one or more "images".  Each image is an independent
30 top-level directory structure and is logically separate from all other images in
31 the WIM.  Each image has a name as well as a 1-based index in the WIM file.  To
32 save space, WIM archives automatically combine all duplicate files across all
33 images.
34
35 A WIM file may be either stand-alone or split into multiple parts.  Split WIMs
36 are read-only and cannot be modified.
37
38 Since version 1.6.0, wimlib also supports ESD (.esd) files, except when
39 encrypted.  These are still WIM files but they use a newer version of the file
40 format.
41
42                              IMAGEX IMPLEMENTATION
43
44 wimlib itself is a C library, and it provides a documented public API (See:
45 http://wimlib.sourceforge.net) for other programs to use.  However, it is also
46 distributed with a command-line program called "wimlib-imagex" that uses this
47 library to implement an imaging tool similar to Microsoft's ImageX.
48 wimlib-imagex supports almost all the capabilities of Microsoft's ImageX as well
49 as additional capabilities.  wimlib-imagex works on both UNIX-like systems and
50 Windows, although some features differ between the platforms.
51
52 Run `wimlib-imagex' with no arguments to see an overview of the available
53 commands and their syntax.  For additional documentation:
54
55   * If you have installed wimlib-imagex on a UNIX-like system, you will find
56     further documentation in the man pages; run `man wimlib-imagex' to get
57     started.
58
59   * If you have downloaded the Windows binary distribution, you will find the
60     documentation for wimlib-imagex in PDF format in the "doc" directory,
61     ready for viewing with any PDF viewer.  Please note that although the PDF
62     files are converted from UNIX-style "man pages", they do document
63     Windows-specific behavior when appropriate.
64
65                                 COMPRESSION RATIO
66
67 wimlib (and wimlib-imagex) can create XPRESS, LZX, or LZMS compressed WIM files.
68 wimlib includes its own compression codecs and does not use the compression API
69 available on some versions of Windows.
70
71 I have gradually been improving the compression codecs in wimlib.  For all three
72 codecs, they now usually outperform and outcompress the equivalent Microsoft
73 implementations.  Although results will vary depending on the data being
74 compressed, in the table below I present the results for a common use case:
75 compressing an x86 Windows PE image.  Each row displays the compression type,
76 the size of the resulting WIM file in bytes, and how many seconds it took to
77 create the file.  When applicable, the results with the equivalent Microsoft
78 implementation in WIMGAPI is included.
79
80   =============================================================================
81   | Compression            ||  wimlib (v1.8.0)       |  WIMGAPI (Windows 8.1) |
82   =============================================================================
83   | None             [1]   ||  361,314,224 in 2.4s   |  361,315,338 in 4.5s   |
84   | XPRESS           [2]   ||  138,218,750 in 3.0s   |  140,457,436 in 6.0s   |
85   | XPRESS (slow)    [3]   ||  135,173,511 in 8.9s   |  N/A                   |
86   | LZX (quick)      [4]   ||  130,207,195 in 3.8s   |  N/A                   |
87   | LZX (normal)     [5]   ||  126,522,539 in 10.4s  |  127,293,240 in 19.2s  |
88   | LZX (slow)       [6]   ||  126,042,313 in 17.3s  |  N/A                   |
89   | LZMS (non-solid) [7]   ||  116,150,682 in 25.3s  |  N/A                   |
90   | LZMS (solid)     [8]   ||  88,107,484  in 61.7s  |  88,769,830 in 102.3s  |
91   | "WIMBoot"        [9]   ||  167,023,719 in 3.5s   |  169,109,211 in 10.4s  |
92   | "WIMBoot" (slow) [10]  ||  165,027,583 in 7.9s   |  N/A                   |
93   =============================================================================
94
95 Notes:
96    [1] '--compress=none' for wimlib-imagex; '/compress:none' for DISM.
97
98    [2] '--compress=XPRESS' for wimlib-imagex; '/compress:fast' for DISM.
99        Compression chunk size defaults to 32768 bytes in both cases.
100
101    [3] '--compress=XPRESS:80' for wimlib-imagex; no known equivalent for DISM.
102        Compression chunk size defaults to 32768 bytes.
103
104    [4] '--compress=LZX:20' for wimlib-imagex; no known equivalent for DISM.
105        Compression chunk size defaults to 32768 bytes.
106
107    [5] '--compress=LZX' or '--compress=LZX:50' or no option for wimlib-imagex;
108        '/compress:maximum' for DISM.
109        Compression chunk size defaults to 32768 bytes in both cases.
110
111    [6] '--compress=LZX:100' for wimlib-imagex; no known equivalent for DISM.
112        Compression chunk size defaults to 32768 bytes.
113
114    [7] '--compress=LZMS' for wimlib-imagex; no known equivalent for DISM.
115        Compression chunk size defaults to 131072 bytes.
116
117    [8] '--solid' for wimlib-imagex.  Should be '/compress:recovery' for DISM,
118        but only works for /Export-Image, not /Capture-Image.  Compression chunk
119        size in solid resources defaults to 67108864 bytes in both cases.
120
121    [9] '--wimboot' for wimlib-imagex; '/wimboot' for DISM.
122        This is really XPRESS compression with 4096 byte chunks, so the same as
123        '--compress=XPRESS --chunk-size=4096'.
124
125    [10] '--wimboot --compress=XPRESS:80' for wimlib-imagex;
126         no known equivalent for DISM.
127         Same format as [9], but trying harder to get a good compression ratio.
128
129 Note: wimlib-imagex's --compress option also accepts the "fast", "maximum", and
130 "recovery" aliases for XPRESS, LZX, and LZMS, respectively.
131
132 Testing environment:
133
134     - 64 bit binaries
135     - Windows 8.1 virtual machine running on Linux with VT-x
136     - 4 CPUs and 4 GiB memory given to virtual machine
137     - SSD-backed virtual disk
138     - All tests done with page cache warmed
139
140 The compression ratio provided by wimlib is also competitive with commonly used
141 archive formats.  Below are file sizes that result when the Canterbury corpus is
142 compressed with wimlib (v1.8.0), WIMGAPI (Windows 8.1), and some other
143 formats/programs:
144
145      =====================================================
146      | Format                             | Size (bytes) |
147      =====================================================
148      | tar                                | 2,826,240    |
149      | WIM (WIMGAPI, None)                | 2,814,254    |
150      | WIM (wimlib, None)                 | 2,814,216    |
151      | WIM (WIMGAPI, XPRESS)              | 825,536      |
152      | WIM (wimlib, XPRESS)               | 789,296      |
153      | tar.gz (gzip, default)             | 738,796      |
154      | ZIP (Info-ZIP, default)            | 735,334      |
155      | tar.gz (gzip, -9)                  | 733,971      |
156      | ZIP (Info-ZIP, -9)                 | 732,297      |
157      | WIM (wimlib, LZX quick)            | 690,110      |
158      | WIM (WIMGAPI, LZX)                 | 651,866      |
159      | WIM (wimlib, LZX normal)           | 624,634      |
160      | WIM (wimlib, LZX slow)             | 620,728      |
161      | WIM (wimlib, LZMS non-solid)       | 581,046      |
162      | tar.bz2 (bzip, default)            | 565,008      |
163      | tar.bz2 (bzip, -9)                 | 565,008      |
164      | WIM (WIMGAPI, LZMS solid)          | 521,366      |
165      | WIM (wimlib, LZMS solid)           | 515,800      |
166      | tar.xz (xz, default)               | 486,916      |
167      | tar.xz (xz, -9)                    | 486,904      |
168      | 7z  (7-zip, default)               | 484,700      |
169      | 7z  (7-zip, -9)                    | 483,239      |
170      =====================================================
171
172 Note: WIM does even better on directory trees containing duplicate files, which
173 the Canterbury corpus doesn't have.
174
175                                   NTFS SUPPORT
176
177 WIM images may contain data, such as alternate data streams and
178 compression/encryption flags, that are best represented on the NTFS filesystem
179 used on Windows.  Also, WIM images may contain security descriptors which are
180 specific to Windows and cannot be represented on other operating systems.
181 wimlib handles this NTFS-specific or Windows-specific data in a
182 platform-dependent way:
183
184   * In the Windows version of wimlib and wimlib-imagex, NTFS-specific and
185     Windows-specific data are supported natively.
186
187   * In the UNIX version of wimlib and wimlib-imagex, NTFS-specific and
188     Windows-specific data are ordinarily ignored; however, there is also special
189     support for capturing and extracting images directly to/from unmounted NTFS
190     volumes.  This was made possible with the help of libntfs-3g from the
191     NTFS-3g project.
192
193 For both platforms the code for NTFS capture and extraction is complete enough
194 that it is possible to apply an image from the "install.wim" contained in recent
195 Windows installation media (Vista, Windows 7, or Windows 8) directly to an NTFS
196 filesystem, and then boot Windows from it after preparing the Boot Configuration
197 Data.  In addition, a Windows installation can be captured (or backed up) into a
198 WIM file, and then re-applied later.
199
200                                    WINDOWS PE
201
202 A major use for wimlib and wimlib-imagex is to create customized images of
203 Windows PE, the Windows Preinstallation Environment, on either UNIX-like systems
204 or Windows without having to rely on Microsoft's software and its restrictions
205 and limitations.
206
207 Windows PE is a lightweight version of Windows that can run entirely from memory
208 and can be used to install Windows from local media or a network drive or
209 perform maintenance.  It is the operating system that runs when you boot from
210 the Windows installation media.
211
212 You can find Windows PE on the installation DVD for Windows Vista, Windows 7, or
213 Windows 8, in the file `sources/boot.wim'.  Windows PE can also be found in the
214 Windows Automated Installation Kit (WAIK), which is free to download from
215 Microsoft, inside the `WinPE.cab' file, which you can extract natively on
216 Windows, or on UNIX-like systems if you install either the `cabextract' or
217 `p7zip' programs.
218
219 In addition, Windows installations and recovery partitions frequently contain a
220 WIM containing an image of the Windows Recovery Environment, which is similar to
221 Windows PE.
222
223 A shell script `mkwinpeimg' is distributed with wimlib on UNIX-like systems to
224 ease the process of creating and customizing a bootable Windows PE image.
225
226                                   DEPENDENCIES
227
228 This section documents the dependencies of wimlib and the programs distributed
229 with it, when building for a UNIX-like system from source.  If you have
230 downloaded the Windows binary distribution of wimlib and wimlib-imagex then all
231 dependencies were already included and this section is irrelevant.
232
233 * libxml2 (required)
234         This is a commonly used free library to read and write XML documents.
235         Almost all Linux distributions should include this; however, you may
236         need to install the header files, which might be in a package named
237         "libxml2-dev" or similar.  For more information see http://xmlsoft.org/.
238
239 * libfuse (optional but recommended)
240         Unless configured --without-fuse, wimlib requires a non-ancient version
241         of libfuse.  Most Linux distributions already include this, but make
242         sure you have the libfuse package installed, and also libfuse-dev if
243         your distribution distributes header files separately.  FUSE also
244         requires a kernel module.  If the kernel module is available it should
245         automatically be loaded if you try to mount a WIM image.  For more
246         information see http://fuse.sourceforge.net/.
247
248 * libattr (optional but recommended)
249         Unless configured --without-fuse, wimlib also requires libattr.  Almost
250         all Linux distributions should include this; however, you may need to
251         install the header files, which might be in a package named "attr-dev",
252         "libattr1-dev", or similar.
253
254 * libntfs-3g (optional but recommended)
255         Unless configured --without-ntfs-3g, wimlib requires the library and
256         headers for libntfs-3g version 2011-4-12 or later to be installed.
257
258 * OpenSSL / libcrypto (optional)
259         wimlib can use the SHA-1 message digest implementation from libcrypto
260         (usually provided by OpenSSL) instead of compiling in yet another SHA-1
261         implementation.
262
263 * cdrkit (optional)
264 * mtools (optional)
265 * syslinux (optional)
266 * cabextract (optional)
267         The `mkwinpeimg' shell script will look for several other programs
268         depending on what options are given to it.  Depending on your Linux
269         distribution, you may already have these programs installed, or they may
270         be in the software repository.  Making an ISO filesystem requires
271         `mkisofs' from `cdrkit' (http://www.cdrkit.org).  Making a disk image
272         requires `mtools' (http://www.gnu.org/software/mtools) and `syslinux'
273         (http://www.syslinux.org).  Retrieving files from the Windows Automated
274         Installation Kit requires `cabextract' (http://www.cabextract.org.uk).
275
276                                  CONFIGURATION
277
278 This section documents the most important options that may be passed to the
279 "configure" script when building from source:
280
281 --without-ntfs-3g
282         If libntfs-3g is not available or is not version 2011-4-12 or later,
283         wimlib can be built without it, in which case it will not be possible to
284         capture or apply WIM images directly from/to NTFS volumes.
285
286         The default is --with-ntfs-3g when building for any UNIX-like system,
287         and --without-ntfs-3g when building for Windows.
288
289 --without-fuse
290         The --without-fuse option completely disables support for mounting WIM
291         images.  This removes dependencies on libfuse, librt, and libattr.  The
292         wimmount, wimmountrw, and wimunmount commands will not work.
293
294         The default is --with-fuse when building for Linux, and --without-fuse
295         otherwise.
296
297 --without-libcrypto
298         Build in functions for SHA-1 rather than using external SHA-1 functions
299         from libcrypto (usually provided by OpenSSL).
300
301         The default is to use libcrypto if it is found on your system.
302
303                                   PORTABILITY
304
305 wimlib works on both UNIX-like systems (Linux, Mac OS X, FreeBSD, etc.) and
306 Windows (XP and later).
307
308 As much code as possible is shared among all supported platforms, but there
309 necessarily are some differences in what features are supported on each platform
310 and how they are implemented.  Most notable is that file tree scanning and
311 extraction are implemented separately for Windows, UNIX, and UNIX (NTFS-3g
312 mode), to ensure a fast and feature-rich implementation of each platform/mode.
313
314 wimlib is mainly used on x86 and x86_64 CPUs, but it should also work on a
315 number of other GCC-supported 32-bit or 64-bit architectures.  It has been
316 tested on the ARM architecture.
317
318 Currently, gcc and clang are the only supported compilers.  A few nonstandard
319 extensions are used in the code.
320
321                                    REFERENCES
322
323 The WIM file format is partially specified in a document that can be found in
324 the Microsoft Download Center.  However, this document really only provides an
325 overview of the format and is not a formal specification.  It also does not
326 cover later extensions of the format, such as solid resources.
327
328 With regards to the supported compression formats:
329
330 - Microsoft has official documentation for XPRESS that is of reasonable quality.
331 - Microsoft has official documentation for LZX, but in two different documents,
332   neither of which is completely applicable to its use in the WIM format, and
333   the first of which contains multiple errors.
334 - There does not seem to be any official documentation for LZMS, so my comments
335   and code in src/lzms_decompress.c may in fact be the best documentation
336   available for this particular compression format.
337
338 The algorithms used by wimlib's compression and decompression codecs are
339 inspired by a variety of sources, including open source projects and computer
340 science papers.
341
342 The code in ntfs-3g_apply.c and ntfs-3g_capture.c uses the NTFS-3g library,
343 which is a library for reading and writing to NTFS filesystems (the filesystem
344 used by recent versions of Windows).  See
345 http://www.tuxera.com/community/ntfs-3g-download/ for more information.
346
347 A limited number of other free programs can handle some parts of the WIM
348 file format:
349
350   * 7-zip is able to extract and create WIMs (as well as files in many
351     other archive formats).  However, wimlib is designed specifically to handle
352     WIM files and provides features previously only available in Microsoft's
353     implementation, such as the ability to mount WIMs read-write as well as
354     read-only, the ability to create compressed WIMs, the correct handling of
355     security descriptors and hard links, support for LZMS compression, and
356     support for solid archives.
357   * ImagePyX (https://github.com/maxpat78/ImagePyX) is a Python program that
358     provides similar capabilities to wimlib-imagex.  One thing to note, though,
359     is that it does not support compression and decompression by itself, but
360     instead relies on external native code, such as the codecs from wimlib.
361
362 If you are looking for an archive format that provides features similar to WIM
363 but was designed primarily for UNIX, you may want to consider SquashFS
364 (http://squashfs.sourceforge.net/).  However, you may find that wimlib works
365 surprisingly well on UNIX.  It will store hard links and symbolic links, and it
366 has optional support for storing UNIX owners, groups, modes, and special files
367 such as device nodes and FIFOs.  Actually, I use it to back up my own files on
368 Linux!
369
370                              LICENSE AND DISCLAIMER
371
372 See COPYING for information about the license.
373
374 wimlib is independently developed and does not contain any code, data, or files
375 copyrighted by Microsoft.  It is not known to be affected by any patents.
376
377 On UNIX-like systems, if you do not want wimlib to be dynamically linked with
378 libcrypto (OpenSSL), configure with --without-libcrypto.  This replaces the SHA1
379 implementation with built-in code and there will be no difference in
380 functionality.
381
382 wimlib comes with no warranty whatsoever.  Please submit a bug report (to
383 ebiggers3@gmail.com) if you find a bug in wimlib and/or wimlib-imagex.