]> wimlib.net Git - wimlib/blobdiff - README
Speed up LZ77 match copying
[wimlib] / README
diff --git a/README b/README
index c78f3ce3da85ed9d784242283e7bc3f80ad38b69..5173583f7cba782554a853a9783f5b89db5dadbc 100644 (file)
--- a/README
+++ b/README
@@ -1,6 +1,6 @@
                                   INTRODUCTION
 
-This is wimlib version 1.6.2 (March 2014).  wimlib is a C library for
+This is wimlib version 1.7.0-BETA (June 2014).  wimlib is a C library for
 creating, modifying, extracting, and mounting files in the Windows Imaging
 Format (WIM files).  These files are normally created using the ImageX
 (imagex.exe) or Dism (Dism.exe) utilities on Windows, but wimlib is distributed
@@ -182,7 +182,7 @@ platform-dependent way:
 
 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 a NTFS
+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.
@@ -280,12 +280,6 @@ This section documents the most important options that may be passed to the
        from libcrypto (part of OpenSSL).  The default is to use libcrypto if it
        is found on the system.
 
---enable-xattr, --disable-xattr
-       Enable or disable support for the extended-attributes interface to NTFS
-       alternate data streams in mounted WIMs.  To support these, wimlib
-       requires that the setxattr() function and the attr/xattr.h header are
-       available.  The default is to autodetect whether support is possible.
-
 --disable-multithreaded-compression
        By default, data will be compressed using multiple threads when writing
        a WIM, unless only 1 processor is detected.  Specify this option to
@@ -336,17 +330,16 @@ used by recent versions of Windows).  See
 http://www.tuxera.com/community/ntfs-3g-download/ for more information.
 
 The LZX decompressor (lzx-decompress.c) was originally based on code from the
-cabextract project (http://www.cabextract.org.uk) but has been rewritten.
+cabextract project (http://www.cabextract.org.uk).  The LZX compressor
+(lzx-compress.c) was originally based on code written by Matthew Russotto
+(www.russotto.net/chm/).  However I have since rewritten and made many
+improvements to both the decompressor and compressor.
 
-The LZX compressor (lzx-compress.c) was originally based on code written by
-Matthew Russotto (www.russotto.net/chm/) but has been rewritten.  It now uses
-suffix array construction code from divsufsort
-(https://code.google.com/p/libdivsufsort/) and algorithms from 7-Zip as well as
-several published papers.
+lz_hash.c contains LZ77 match-finding code that uses hash chains.  It is based
+on code from zlib but I have since rewritten it.
 
-lz_hash.c contains a hash-table-based LZ77 matchfinder that is based on code
-from zlib but has been rewritten.  This code is applicable to XPRESS, LZX, and
-LZMS, all of which are partly based on LZ77 compression.
+lz_bt.c contains LZ77 match-finding code that uses binary trees.  It is based on
+code from liblzma but I have since rewritten it.
 
 A limited number of other free programs can handle some parts of the WIM
 file format:
@@ -355,25 +348,24 @@ file format:
     other archive formats).  However, wimlib is designed specifically to handle
     WIM files and provides features previously only available in Microsoft's
     implementation, such as the ability to mount WIMs read-write as well as
-    read-only, the ability to create LZX or XPRESS compressed WIMs, and the
-    correct handling of security descriptors and hard links.
+    read-only, the ability to create compressed WIMs, and the correct handling
+    of security descriptors and hard links.
   * 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.
 
-A very early version of wimlib is being used to deploy Windows 7 from the
-Ultimate Deployment Appliance.  For more information see
-http://www.ultimatedeployment.org/.
-
-If you are looking for a UNIX archive format that provides features similar to
-WIM, I recommend you take a look at SquashFS (http://squashfs.sourceforge.net/).
+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
+(http://squashfs.sourceforge.net/).  However, you may find that wimlib works
+surprisingly well on UNIX.  It will store hard links and symbolic links, and it
+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
+                            LICENSE AND DISCLAIMER
 
-As of version 1.0.0, wimlib and all programs and scripts distributed with it are
-released under the GNU GPL version 3.0 or later.  See COPYING for details.
-Some individual source files are also released under more permissive licenses.
+See COPYING for information about the license.
 
 wimlib is independently developed and does not contain any code, data, or files
 copyrighted by Microsoft.  It is not known to be affected by any patents.
@@ -383,8 +375,6 @@ libcrypto (OpenSSL), configure with --without-libcrypto.  This replaces the SHA1
 implementation with built-in code and there will be no difference in
 functionality.
 
-                                   DISCLAIMER
-
 wimlib comes with no warranty whatsoever.  Please submit a bug report (to
 ebiggers3@gmail.com) if you find a bug in wimlib and/or wimlib-imagex.