Sync AVL tree code from project
[wimlib] / README
1                                   INTRODUCTION
2
3 This is wimlib version 1.10.0-BETA (July 2016).  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 UNIX-like systems, you can compile from
12 source (e.g. './configure && make && sudo make install').  Alternatively, check
13 if a package has already been prepared for your operating system.  Example files
14 for Debian and RPM packaging are in the debian/ and rpm/ directories.
15
16 To install wimlib and wimlib-imagex on Windows, just download and extract the
17 ZIP file containing the latest binaries.  See README.WINDOWS for more details.
18
19 All official wimlib releases are available from https://wimlib.net.
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 archives support multiple compression formats,
27 including LZX, XPRESS, and LZMS.  All these formats are supported by wimlib.
28
29 A WIM archive contains one or more "images", each of which is a logically
30 independent directory tree.  Each image has a 1-based index and usually a name.
31
32 WIM archives provide data deduplication at the level of full file contents.  In
33 other words, each unique "file contents" is only stored once in the archive,
34 regardless of how many files have that contents across all images.
35
36 A WIM archive may be either stand-alone or split into multiple parts.
37
38 An update of the WIM format --- first added by Microsoft for Windows 8 ---
39 supports solid-mode compression.  This refers to files being compressed together
40 (e.g. as in a .tar.xz or .7z archive) rather than separately (e.g. as in a .zip
41 archive).  This usually produces a much better compression ratio.  Solid
42 archives are sometimes called "ESD files" by Microsoft and may have the ".esd"
43 file extension rather than ".wim".  They are supported in wimlib since v1.6.0.
44
45                              IMAGEX IMPLEMENTATION
46
47 wimlib itself is a C library, and it provides a documented public API (See:
48 https://wimlib.net/apidoc) for other programs to use.  However, it is also
49 distributed with a command-line program called "wimlib-imagex" that uses this
50 library to implement an imaging tool similar to Microsoft's ImageX.
51 wimlib-imagex supports almost all the capabilities of Microsoft's ImageX as well
52 as additional capabilities.  wimlib-imagex works on both UNIX-like systems and
53 Windows, although some features differ between the platforms.
54
55 Run `wimlib-imagex' with no arguments to see an overview of the available
56 commands and their syntax.  For additional documentation:
57
58   * If you have installed wimlib-imagex on a UNIX-like system, you will find
59     further documentation in the man pages; run `man wimlib-imagex' to get
60     started.
61
62   * If you have downloaded the Windows binary distribution, you will find the
63     documentation for wimlib-imagex in PDF format in the "doc" directory,
64     ready for viewing with any PDF viewer.  Please note that although the PDF
65     files are converted from UNIX-style "man pages", they do document
66     Windows-specific behavior when appropriate.
67
68                                   COMPRESSION
69
70 wimlib (and wimlib-imagex) can create XPRESS, LZX, and LZMS compressed WIM
71 archives.  wimlib's compression codecs usually outperform and outcompress their
72 closed-source Microsoft equivalents.  Multiple compression levels and chunk
73 sizes as well as solid mode compression are supported.  Compression is
74 multithreaded by default.  Detailed benchmark results and descriptions of the
75 algorithms used can be found at https://wimlib.net/compression.html.
76
77                                   NTFS SUPPORT
78
79 WIM images may contain data, such as alternate data streams and
80 compression/encryption flags, that are best represented on the NTFS filesystem
81 used on Windows.  Also, WIM images may contain security descriptors which are
82 specific to Windows and cannot be represented on other operating systems.
83 wimlib handles this NTFS-specific or Windows-specific data in a
84 platform-dependent way:
85
86   * In the Windows version of wimlib and wimlib-imagex, NTFS-specific and
87     Windows-specific data are supported natively.
88
89   * In the UNIX version of wimlib and wimlib-imagex, NTFS-specific and
90     Windows-specific data are ordinarily ignored; however, there is also special
91     support for capturing and extracting images directly to/from unmounted NTFS
92     volumes.  This was made possible with the help of libntfs-3g from the
93     NTFS-3G project.
94
95 For both platforms the code for NTFS capture and extraction is complete enough
96 that it is possible to apply an image from the "install.wim" contained in recent
97 Windows installation media (Vista or later) directly to an NTFS filesystem, and
98 then boot Windows from it after preparing the Boot Configuration Data.  In
99 addition, a Windows installation can be captured (or backed up) into a WIM file,
100 and then re-applied later.
101
102                                    WINDOWS PE
103
104 A major use for wimlib and wimlib-imagex is to create customized images of
105 Windows PE, the Windows Preinstallation Environment, on either UNIX-like systems
106 or Windows without having to rely on Microsoft's software and its restrictions
107 and limitations.
108
109 Windows PE is a lightweight version of Windows that can run entirely from memory
110 and can be used to install Windows from local media or a network drive or
111 perform maintenance.  It is the operating system that runs when you boot from
112 the Windows installation media.
113
114 You can find Windows PE on the installation media for Windows (Vista or later)
115 as the file `sources/boot.wim'.  Windows PE can also be found in the Windows
116 Automated Installation Kit (WAIK), which is free to download from Microsoft,
117 inside the `WinPE.cab' file, which you can extract natively on Windows, or on
118 UNIX-like systems if you install either the `cabextract' or `p7zip' programs.
119
120 In addition, Windows installations and recovery partitions frequently contain a
121 WIM containing an image of the Windows Recovery Environment, which is similar to
122 Windows PE.
123
124 A shell script `mkwinpeimg' is distributed with wimlib on UNIX-like systems to
125 ease the process of creating and customizing a bootable Windows PE image.
126
127                                   DEPENDENCIES
128
129 This section documents the dependencies of wimlib and the programs distributed
130 with it, when building for a UNIX-like system from source.  If you have
131 downloaded the Windows binary distribution of wimlib and wimlib-imagex then all
132 dependencies were already included and this section is irrelevant.
133
134 * libxml2 (required)
135         This is a commonly used free library to read and write XML documents.
136         Almost all Linux distributions should include this; however, you may
137         need to install the header files, which might be in a package named
138         "libxml2-dev" or similar.  For more information see http://xmlsoft.org/.
139
140 * libfuse (optional but recommended)
141         Unless configured --without-fuse, wimlib requires a non-ancient version
142         of libfuse.  Most Linux distributions already include this, but make
143         sure you have the libfuse package installed, and also libfuse-dev if
144         your distribution distributes header files separately.  FUSE also
145         requires a kernel module.  If the kernel module is available it should
146         automatically be loaded if you try to mount a WIM image.  For more
147         information see http://fuse.sourceforge.net/.
148
149 * libattr (optional but recommended)
150         Unless configured --without-fuse, wimlib also requires libattr.  Almost
151         all Linux distributions should include this; however, you may need to
152         install the header files, which might be in a package named "attr-dev",
153         "libattr1-dev", or similar.
154
155 * libntfs-3g (optional but recommended)
156         Unless configured --without-ntfs-3g, wimlib requires the library and
157         headers for libntfs-3g to be installed.  The minimum required version is
158         2011-4-12, but newer versions contain important bug fixes.
159
160 * OpenSSL / libcrypto (optional)
161         wimlib can use the SHA-1 message digest implementation from libcrypto
162         (usually provided by OpenSSL) instead of compiling in yet another SHA-1
163         implementation.
164
165 * cdrkit (optional)
166 * mtools (optional)
167 * syslinux (optional)
168 * cabextract (optional)
169         The `mkwinpeimg' shell script will look for several other programs
170         depending on what options are given to it.  Depending on your Linux
171         distribution, you may already have these programs installed, or they may
172         be in the software repository.  Making an ISO filesystem requires
173         `mkisofs' from `cdrkit' (http://www.cdrkit.org).  Making a disk image
174         requires `mtools' (http://www.gnu.org/software/mtools) and `syslinux'
175         (http://www.syslinux.org).  Retrieving files from the Windows Automated
176         Installation Kit requires `cabextract' (http://www.cabextract.org.uk).
177
178                                  CONFIGURATION
179
180 This section documents the most important options that may be passed to the
181 "configure" script when building from source:
182
183 --without-ntfs-3g
184         If libntfs-3g is not available or is not version 2011-4-12 or later,
185         wimlib can be built without it, in which case it will not be possible to
186         capture or apply WIM images directly from/to NTFS volumes.
187
188         The default is --with-ntfs-3g when building for any UNIX-like system,
189         and --without-ntfs-3g when building for Windows.
190
191 --without-fuse
192         The --without-fuse option disables support for mounting WIM images.
193         This removes dependencies on libfuse, librt, and libattr.  The wimmount,
194         wimmountrw, and wimunmount commands will not work.
195
196         The default is --with-fuse when building for Linux, and --without-fuse
197         otherwise.
198
199 --without-libcrypto
200         Build in functions for SHA-1 rather than using external SHA-1 functions
201         from libcrypto (usually provided by OpenSSL).
202
203         The default is to use libcrypto if it is found on your system.
204
205                                   PORTABILITY
206
207 wimlib works on both UNIX-like systems (Linux, Mac OS X, FreeBSD, etc.) and
208 Windows (XP and later).
209
210 As much code as possible is shared among all supported platforms, but there
211 necessarily are some differences in what features are supported on each platform
212 and how they are implemented.  Most notable is that file tree scanning and
213 extraction are implemented separately for Windows, UNIX, and UNIX (NTFS-3G
214 mode), to ensure a fast and feature-rich implementation of each platform/mode.
215
216 wimlib is mainly used on x86 and x86_64 CPUs, but it should also work on a
217 number of other GCC-supported 32-bit or 64-bit architectures.  It has been
218 tested on the ARM and MIPS architectures.
219
220 Currently, gcc and clang are the only supported compilers.  A few nonstandard
221 extensions are used in the code.
222
223                                    REFERENCES
224
225 The WIM file format is partially specified in a document that can be found in
226 the Microsoft Download Center.  However, this document really only provides an
227 overview of the format and is not a formal specification.  It also does not
228 cover later extensions of the format, such as solid resources.
229
230 With regards to the supported compression formats:
231
232 - Microsoft has official documentation for XPRESS that is of reasonable quality.
233 - Microsoft has official documentation for LZX, but in two different documents,
234   neither of which is completely applicable to its use in the WIM format, and
235   the first of which contains multiple errors.
236 - There does not seem to be any official documentation for LZMS, so my comments
237   and code in src/lzms_decompress.c may in fact be the best documentation
238   available for this particular compression format.
239
240 The algorithms used by wimlib's compression and decompression codecs are
241 inspired by a variety of sources, including open source projects and computer
242 science papers.
243
244 The code in ntfs-3g_apply.c and ntfs-3g_capture.c uses the NTFS-3G library,
245 which is a library for reading and writing to NTFS filesystems (the filesystem
246 used by recent versions of Windows).  See
247 http://www.tuxera.com/community/ntfs-3g-download/ for more information.
248
249 A limited number of other free programs can handle some parts of the WIM
250 file format:
251
252   * 7-zip is able to extract and create WIMs (as well as files in many
253     other archive formats).  However, wimlib is designed specifically to handle
254     WIM files and provides features previously only available in Microsoft's
255     implementation, such as the ability to mount WIMs read-write as well as
256     read-only, the ability to create compressed WIMs, the correct handling of
257     security descriptors and hard links, support for LZMS compression, and
258     support for solid archives.
259   * ImagePyX (https://github.com/maxpat78/ImagePyX) is a Python program that
260     provides some capabilities of wimlib-imagex, with the help of external
261     compression codecs.
262
263 If you are looking for an archive format that provides features similar to WIM
264 but was designed primarily for UNIX, you may want to consider SquashFS
265 (http://squashfs.sourceforge.net/).  However, you may find that wimlib works
266 surprisingly well on UNIX.  It will store hard links and symbolic links, and it
267 has optional support for storing UNIX owners, groups, modes, and special files
268 such as device nodes and FIFOs.  Actually, I use it to back up my own files on
269 Linux!
270
271                                     HISTORY
272
273 wimlib was originally a project started by Carl Thijssen for use on Linux in the
274 Ultimate Deployment Appliance (http://www.ultimatedeployment.org/).  Since then
275 the code has been entirely rewritten and improved (main author: Eric Biggers).
276 Windows support has been available since version 1.3.0 (March 2013).  A list of
277 version-to-version changes can be found in the NEWS file.
278
279                                     NOTICES
280
281 wimlib is free software that comes with NO WARRANTY, to the extent permitted by
282 law.  See the COPYING file for more details.
283
284 Bug reports, suggestions, and other contributions are appreciated and may be
285 sent via email to ebiggers3@gmail.com or posted to https://wimlib.net/forums.
286
287 wimlib is independently developed and does not contain any code, data, or files
288 copyrighted by Microsoft.  It is not known to be affected by any patents.
289
290 On UNIX-like systems, if you do not want wimlib to be dynamically linked with
291 libcrypto (OpenSSL), configure with --without-libcrypto.  This replaces the SHA1
292 implementation with built-in code and there will be no difference in
293 functionality.
294
295 Note: copyright years may be listed using range notation, e.g., 2012-2016,
296 indicating that every year in the range, inclusive, is a copyrightable year that
297 would otherwise be listed individually.