Remove sle{16,32,64} types
[wimlib] / README
diff --git a/README b/README
index 419c3da..3365dca 100644 (file)
--- a/README
+++ b/README
@@ -1,6 +1,6 @@
                                   INTRODUCTION
 
-This is wimlib version 1.7.2-BETA (August 2014).  wimlib is a C library for
+This is wimlib version 1.9.1-BETA (February 2016).  wimlib is a C library for
 creating, modifying, extracting, and mounting files in the Windows Imaging
 Format (WIM files).  wimlib and its command-line frontend 'wimlib-imagex'
 provide a free and cross-platform alternative to Microsoft's WIMGAPI, ImageX,
@@ -8,41 +8,44 @@ and DISM.
 
                                   INSTALLATION
 
-To install wimlib and wimlib-imagex on Windows, simply download and extract the
-ZIP file containing the latest binaries from the SourceForge page
-(http://sourceforge.net/projects/wimlib/).  You probably have already done this!
-
-To install wimlib and wimlib-imagex on UNIX-like systems (with Linux being the
-primary supported and tested platform), you must compile the source code, which
-is also available at http://sourceforge.net/projects/wimlib/.  Alternatively,
-check if a package has been prepared for your Linux distribution.  Example files
+To install wimlib and wimlib-imagex on UNIX-like systems, you can compile from
+source (e.g. './configure && make && sudo make install').  Alternatively, check
+if a package has already been prepared for your operating system.  Example files
 for Debian and RPM packaging are in the debian/ and rpm/ directories.
 
-                                    WIM FILES
+To install wimlib and wimlib-imagex on Windows, just download and extract the
+ZIP file containing the latest binaries.  See README.WINDOWS for more details.
+
+All official wimlib releases are available from https://wimlib.net.
+
+                                   WIM FILES
 
 A Windows Imaging (WIM) file is an archive designed primarily for archiving
 Windows filesystems.  However, it can be used on other platforms as well, with
 some limitations.  Like some other archive formats such as ZIP, files in WIM
-archives may be compressed.  WIM files support multiple compression formats,
+archives may be compressed.  WIM archives support multiple compression formats,
 including LZX, XPRESS, and LZMS.  All these formats are supported by wimlib.
 
-A WIM file consists of one or more "images".  Each image is an independent
-top-level directory structure and is logically separate from all other images in
-the WIM.  Each image has a name as well as a 1-based index in the WIM file.  To
-save space, WIM archives automatically combine all duplicate files across all
-images.
+A WIM archive contains one or more "images", each of which is a logically
+independent directory tree.  Each image has a 1-based index and usually a name.
+
+WIM archives provide data deduplication at the level of full file contents.  In
+other words, each unique "file contents" is only stored once in the archive,
+regardless of how many files have that contents across all images.
 
-A WIM file may be either stand-alone or split into multiple parts.  Split WIMs
-are read-only and cannot be modified.
+A WIM archive may be either stand-alone or split into multiple parts.
 
-Since version 1.6.0, wimlib also supports ESD (.esd) files, except when
-encrypted.  These are still WIM files but they use a newer version of the file
-format.
+An update of the WIM format --- first added by Microsoft for Windows 8 ---
+supports solid-mode compression.  This refers to files being compressed together
+(e.g. as in a .tar.xz or .7z archive) rather than separately (e.g. as in a .zip
+archive).  This usually produces a much better compression ratio.  Solid
+archives are sometimes called "ESD files" by Microsoft and may have the ".esd"
+file extension rather than ".wim".  They are supported in wimlib since v1.6.0.
 
                              IMAGEX IMPLEMENTATION
 
 wimlib itself is a C library, and it provides a documented public API (See:
-http://wimlib.sourceforge.net) for other programs to use.  However, it is also
+https://wimlib.net/apidoc) for other programs to use.  However, it is also
 distributed with a command-line program called "wimlib-imagex" that uses this
 library to implement an imaging tool similar to Microsoft's ImageX.
 wimlib-imagex supports almost all the capabilities of Microsoft's ImageX as well
@@ -62,119 +65,14 @@ commands and their syntax.  For additional documentation:
     files are converted from UNIX-style "man pages", they do document
     Windows-specific behavior when appropriate.
 
-                                COMPRESSION RATIO
-
-wimlib (and wimlib-imagex) can create XPRESS, LZX, or LZMS compressed WIM files.
-wimlib includes its own compression codecs and does not use the compression API
-available on some versions of Windows.
-
-I have gradually been improving the compression codecs in wimlib.  For XPRESS
-and LZX, they now usually outperform and outcompress the equivalent Microsoft
-implementations.  Although results will vary depending on the data being
-compressed, in the table below I present the results for a common use case:
-compressing an x86 Windows PE image.  Each row displays the compression type,
-the size of the resulting WIM file in bytes, and how many seconds it took to
-create the file.  When applicable, the results with the equivalent Microsoft
-implementation in WIMGAPI is included.
-
-  =============================================================================
-  | Compression            ||  wimlib (v1.7.2)       |  WIMGAPI (Windows 8.1) |
-  =============================================================================
-  | None             [1]   ||  361,314,224 in 3.4s   |  361,315,338 in 4.5s   |
-  | XPRESS           [2]   ||  138,380,918 in 4.2s   |  140,457,487 in 6.3s   |
-  | XPRESS (slow)    [3]   ||  135,269,627 in 11.1s  |  N/A                   |
-  | LZX (quick)      [4]   ||  130,332,081 in 4.7s   |  N/A                   |
-  | LZX (normal)     [5]   ||  126,714,941 in 12.9s  |  127,293,240 in 19.2s  |
-  | LZX (slow)       [6]   ||  126,150,725 in 23.4s  |  N/A                   |
-  | LZMS (non-solid) [7]   ||  121,909,750 in 13.3s  |  N/A                   |
-  | LZMS (solid)     [8]   ||  93,650,894  in 44.4s  |  88,771,192 in 109.2   |
-  | "WIMBoot"        [9]   ||  167,095,369 in 6.4s   |  169,109,650 in 10.7s  |
-  | "WIMBoot" (slow) [10]  ||  165,195,668 in 9.5s   |  N/A                   |
-  =============================================================================
-
-Notes:
-   [1] '--compress=none' for wimlib-imagex; '/compress:none' for DISM.
-
-   [2] '--compress=XPRESS' for wimlib-imagex; '/compress:fast' for DISM.
-       Compression chunk size defaults to 32768 bytes in both cases.
-
-   [3] '--compress=XPRESS:80' for wimlib-imagex; no known equivalent for DISM.
-       Compression chunk size defaults to 32768 bytes.
-
-   [4] '--compress=LZX:20' for wimlib-imagex; no known equivalent for DISM.
-       Compression chunk size defaults to 32768 bytes.
-
-   [5] '--compress=LZX' or '--compress=LZX:50' or no option for wimlib-imagex;
-       '/compress:maximum' for DISM.
-       Compression chunk size defaults to 32768 bytes in both cases.
-
-   [6] '--compress=LZX:100' for wimlib-imagex; no known equivalent for DISM.
-       Compression chunk size defaults to 32768 bytes.
-
-   [7] '--compress=LZMS' for wimlib-imagex; no known equivalent for DISM.
-       Compression chunk size defaults to 131072 bytes.
-
-   [8] '--solid' for wimlib-imagex.  Should be '/compress:recovery' for DISM,
-       but only works for /Export-Image, not /Capture-Image.  Compression chunk
-       size in solid blocks defaults to 33554432 for wimlib, 67108864 for DISM.
-
-   [9] '--wimboot' for wimlib-imagex; '/wimboot' for DISM.
-       This is really XPRESS compression with 4096 byte chunks, so the same as
-       '--compress=XPRESS --chunk-size=4096'.
-
-   [10] '--wimboot --compress=XPRESS:80' for wimlib-imagex;
-        no known equivalent for DISM.
-        Same format as [9], but trying harder to get a good compression ratio.
-
-Note: wimlib-imagex's --compress option also accepts the "fast", "maximum", and
-"recovery" aliases for XPRESS, LZX, and LZMS, respectively.
-
-Testing environment:
-
-    - 64 bit binaries
-    - Windows 8.1 virtual machine running on Linux with VT-x
-    - 4 CPUs and 4 GiB memory given to virtual machine
-    - SSD-backed virtual disk
-    - All tests done with page cache warmed
-
-The compression ratio provided by wimlib is also competitive with commonly used
-archive formats.  Below are file sizes that result when the Canterbury corpus is
-compressed with wimlib (v1.7.2), WIMGAPI (Windows 8.1), and some other
-formats/programs:
-
-     =====================================================
-     | Format                             | Size (bytes) |
-     =====================================================
-     | tar                                | 2,826,240    |
-     | WIM (WIMGAPI, None)                | 2,814,254    |
-     | WIM (wimlib, None)                 | 2,814,216    |
-     | WIM (WIMGAPI, XPRESS)              | 825,536      |
-     | WIM (wimlib, XPRESS)               | 790,016      |
-     | tar.gz (gzip, default)             | 738,796      |
-     | ZIP (Info-ZIP, default)            | 735,334      |
-     | tar.gz (gzip, -9)                  | 733,971      |
-     | ZIP (Info-ZIP, -9)                 | 732,297      |
-     | WIM (wimlib, LZX quick)            | 704,006      |
-     | WIM (WIMGAPI, LZX)                 | 651,866      |
-     | WIM (wimlib, LZX normal)           | 632,614      |
-     | WIM (wimlib, LZX slow)             | 625,050      |
-     | WIM (wimlib, LZMS non-solid)       | 581,960      |
-     | tar.bz2 (bzip, default)            | 565,008      |
-     | tar.bz2 (bzip, -9)                 | 565,008      |
-     | WIM (wimlib, LZX solid)            | 532,700      |
-     | WIM (wimlib, LZMS solid)           | 525,990      |
-     | WIM (wimlib, LZX solid, slow)      | 525,140      |
-     | WIM (wimlib, LZMS solid, slow)     | 523,728      |
-     | WIM (WIMGAPI, LZMS solid)          | 521,366      |
-     | WIM (wimlib, LZX solid, very slow) | 520,832      |
-     | tar.xz (xz, default)               | 486,916      |
-     | tar.xz (xz, -9)                    | 486,904      |
-     | 7z  (7-zip, default)               | 484,700      |
-     | 7z  (7-zip, -9)                    | 483,239      |
-     =====================================================
-
-Note: WIM does even better on directory trees containing duplicate files, which
-the Canterbury corpus doesn't have.
+                                  COMPRESSION
+
+wimlib (and wimlib-imagex) can create XPRESS, LZX, and LZMS compressed WIM
+archives.  wimlib's compression codecs usually outperform and outcompress their
+closed-source Microsoft equivalents.  Multiple compression levels and chunk
+sizes as well as solid mode compression are supported.  Compression is
+multithreaded by default.  Detailed benchmark results and descriptions of the
+algorithms used can be found at https://wimlib.net/compression.html.
 
                                   NTFS SUPPORT
 
@@ -192,14 +90,14 @@ platform-dependent way:
     Windows-specific data are ordinarily ignored; however, there is also special
     support for capturing and extracting images directly to/from unmounted NTFS
     volumes.  This was made possible with the help of libntfs-3g from the
-    NTFS-3g project.
+    NTFS-3G project.
 
 For both platforms the code for NTFS capture and extraction is complete enough
 that it is possible to apply an image from the "install.wim" contained in recent
-Windows installation media (Vista, Windows 7, or Windows 8) directly to an NTFS
-filesystem, and then boot Windows from it after preparing the Boot Configuration
-Data.  In addition, a Windows installation can be captured (or backed up) into a
-WIM file, and then re-applied later.
+Windows installation media (Vista or later) directly to an NTFS filesystem, and
+then boot Windows from it after preparing the Boot Configuration Data.  In
+addition, a Windows installation can be captured (or backed up) into a WIM file,
+and then re-applied later.
 
                                    WINDOWS PE
 
@@ -213,12 +111,11 @@ and can be used to install Windows from local media or a network drive or
 perform maintenance.  It is the operating system that runs when you boot from
 the Windows installation media.
 
-You can find Windows PE on the installation DVD for Windows Vista, Windows 7, or
-Windows 8, in the file `sources/boot.wim'.  Windows PE can also be found in the
-Windows Automated Installation Kit (WAIK), which is free to download from
-Microsoft, inside the `WinPE.cab' file, which you can extract natively on
-Windows, or on UNIX-like systems if you install either the `cabextract' or
-`p7zip' programs.
+You can find Windows PE on the installation media for Windows (Vista or later)
+as the file `sources/boot.wim'.  Windows PE can also be found in the Windows
+Automated Installation Kit (WAIK), which is free to download from Microsoft,
+inside the `WinPE.cab' file, which you can extract natively on Windows, or on
+UNIX-like systems if you install either the `cabextract' or `p7zip' programs.
 
 In addition, Windows installations and recovery partitions frequently contain a
 WIM containing an image of the Windows Recovery Environment, which is similar to
@@ -291,9 +188,9 @@ This section documents the most important options that may be passed to the
        and --without-ntfs-3g when building for Windows.
 
 --without-fuse
-       The --without-fuse option completely disables support for mounting WIM
-       images.  This removes dependencies on libfuse, librt, and libattr.  The
-       wimmount, wimmountrw, and wimunmount commands will not work.
+       The --without-fuse option disables support for mounting WIM images.
+       This removes dependencies on libfuse, librt, and libattr.  The wimmount,
+       wimmountrw, and wimunmount commands will not work.
 
        The default is --with-fuse when building for Linux, and --without-fuse
        otherwise.
@@ -312,13 +209,12 @@ Windows (XP and later).
 As much code as possible is shared among all supported platforms, but there
 necessarily are some differences in what features are supported on each platform
 and how they are implemented.  Most notable is that file tree scanning and
-extraction are implemented separately for Windows, UNIX, and UNIX (NTFS-3g
+extraction are implemented separately for Windows, UNIX, and UNIX (NTFS-3G
 mode), to ensure a fast and feature-rich implementation of each platform/mode.
 
 wimlib is mainly used on x86 and x86_64 CPUs, but it should also work on a
-number of other GCC-supported 32-bit or 64-bit architectures.  No assumptions
-are made about endianness, but some code assumes that unaligned memory accesses
-are supported and relatively efficient.
+number of other GCC-supported 32-bit or 64-bit architectures.  It has been
+tested on the ARM and MIPS architectures.
 
 Currently, gcc and clang are the only supported compilers.  A few nonstandard
 extensions are used in the code.
@@ -328,7 +224,7 @@ extensions are used in the code.
 The WIM file format is partially specified in a document that can be found in
 the Microsoft Download Center.  However, this document really only provides an
 overview of the format and is not a formal specification.  It also does not
-cover later extensions of the format, such as solid blocks.
+cover later extensions of the format, such as solid resources.
 
 With regards to the supported compression formats:
 
@@ -337,14 +233,14 @@ With regards to the supported compression formats:
   neither of which is completely applicable to its use in the WIM format, and
   the first of which contains multiple errors.
 - There does not seem to be any official documentation for LZMS, so my comments
-  and code in src/lzms-decompress.c may in fact be the best documentation
+  and code in src/lzms_decompress.c may in fact be the best documentation
   available for this particular compression format.
 
 The algorithms used by wimlib's compression and decompression codecs are
 inspired by a variety of sources, including open source projects and computer
 science papers.
 
-The code in ntfs-3g_apply.c and ntfs-3g_capture.c uses the NTFS-3g library,
+The code in ntfs-3g_apply.c and ntfs-3g_capture.c uses the NTFS-3G library,
 which is a library for reading and writing to NTFS filesystems (the filesystem
 used by recent versions of Windows).  See
 http://www.tuxera.com/community/ntfs-3g-download/ for more information.
@@ -360,9 +256,8 @@ file format:
     security descriptors and hard links, support for LZMS compression, and
     support for solid archives.
   * ImagePyX (https://github.com/maxpat78/ImagePyX) is a Python program that
-    provides similar capabilities to wimlib-imagex.  One thing to note, though,
-    is that it does not support compression and decompression by itself, but
-    instead relies on external native code, such as the codecs from wimlib.
+    provides some capabilities of wimlib-imagex, with the help of external
+    compression codecs.
 
 If you are looking for an archive format that provides features similar to WIM
 but was designed primarily for UNIX, you may want to consider SquashFS
@@ -372,7 +267,15 @@ has optional support for storing UNIX owners, groups, modes, and special files
 such as device nodes and FIFOs.  Actually, I use it to back up my own files on
 Linux!
 
-                            LICENSE AND DISCLAIMER
+                                    HISTORY
+
+wimlib was originally a project started by Carl Thijssen for use on Linux in the
+Ultimate Deployment Appliance (http://www.ultimatedeployment.org/).  Since then
+the code has been entirely rewritten and improved (main author: Eric Biggers).
+Windows support has been available since version 1.3.0 (March 2013).  A list of
+version-to-version changes can be found in the NEWS file.
+
+                             LICENSE AND DISCLAIMER
 
 See COPYING for information about the license.