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