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