]> wimlib.net Git - wimlib/blobdiff - README
struct dentry, struct inode: remone unused flags
[wimlib] / README
diff --git a/README b/README
index 650d8a3e7d3bc597e90fb75135e8a8900602d1dc..4ffd1420667a346b4e877e1cc927bdd8acbf8a4e 100644 (file)
--- a/README
+++ b/README
@@ -1,10 +1,9 @@
                                   WIMLIB
 
-This is wimlib version 1.0.4 (October 2012).  wimlib can be used to read,
-write, and mount files in the Windows Imaging Format (WIM files).  These
-files are normally created by using the `imagex.exe' utility on Windows,
-but this library provides a free implementation of imagex for UNIX-based
-systems.
+This is wimlib version 1.2.1 (December 2012).  wimlib can be used to read,
+write, and mount files in the Windows Imaging Format (WIM files).  These files
+are normally created by using the `imagex.exe' utility on Windows, but this
+library provides a free implementation of imagex for UNIX-based systems.
 
                                   WIM FILES
 
@@ -23,7 +22,7 @@ Windows that are almost exactly the same.
 Microsoft provides documentation for the WIM file format, XPRESS compression
 format, and LZX compression format.  The XPRESS documentation is acceptable, but
 the LZX documentation is not entirely correct, and the WIM documentation itself
-is very incomplete and is of unacceptable quality.
+is incomplete.
 
 A WIM file may be either stand-alone or split into multiple parts.
 
@@ -39,15 +38,22 @@ details.
 
 `mkwinpeimg' is shell script that makes it easy to create a customized bootable
 image of Windows PE that can be put on a CD or USB drive, or published on a
-server for PXE booting.  See the main page `doc/mkwinpeiso.1' for more details.
+server for PXE booting.  See the main page `doc/mkwinpeimg.1' for more details.
+
+There is an additional program, `wimapply', that is not installed by default.
+It can be used to build a small executable with the ability to apply a WIM image
+from a standalone WIM, without having to build the whole shared library.  This
+could be useful on Linux boot clients that only need to be able to apply a WIM,
+not capture/split/join/append/export/mount a WIM.  See `programs/wimapply.c'.
 
                               COMPRESSION RATIO
 
-wimlib can create XPRESS or LZX compressed WIM archives.  As of wimlib v1.0.3,
-the XPRESS compression ratio is slightly better than that provided by
-Microsoft's software, while the LZX compression ratio is approaching that of
-Microsoft's software but is not quite there yet.  Running time is as good as or
-better than Microsoft's software.
+wimlib can create XPRESS or LZX compressed WIM archives.  Currently, the the
+XPRESS compression ratio is slightly better than that provided by Microsoft's
+software, while the LZX compression ratio is approaching that of Microsoft's
+software but is not quite there yet.  Running time is as good as or better than
+Microsoft's software, especially with multithreaded compression, available in
+wimlib v1.1.0 and later.
 
 The following tables compare the compression ratio and performance for creating
 a compressed Windows PE image (disk usage of about 524 MB, uncompressed WIM size
@@ -56,16 +62,14 @@ a compressed Windows PE image (disk usage of about 524 MB, uncompressed WIM size
        Table 1. WIM size
 
                                        XPRESS Compression      LZX Compression
-       wimlib imagex (v1.0.2):         145,283,871 bytes       139,288,293 bytes
-       wimlib imagex (v1.0.3):         139,288,293 bytes       131,379,869 bytes
+       wimlib imagex (v1.2.1):         138,971,353 bytes       131,379,943 bytes
        Microsoft imagex.exe:           140,406,981 bytes       127,249,176 bytes
 
        Table 2. Time to create WIM
 
-                                       XPRESS Compression      LZX Compression
-       wimlib imagex (v1.0.2):         18 sec                  49 sec
-       wimlib imagex (v1.0.3):         19 sec                  30 sec
-       Microsoft imagex.exe:           25 sec                  89 sec
+                                          XPRESS Compression   LZX Compression
+       wimlib imagex (v1.2.1, 2 threads): 11 sec               17 sec
+       Microsoft imagex.exe:              25 sec               89 sec
 
                                  NTFS SUPPORT
 
@@ -148,8 +152,8 @@ Besides the various well-known options, the following options can be passed to
 wimlib's `configure' script:
 
 --without-ntfs-3g
-       If libntfs-3g is not available or is not the correct version, we can
-       build without it.  wimlib will then not be able to apply or capture
+       If libntfs-3g is not available or is not version 2011-4-12 or later, we
+       can build without it.  wimlib will then not be able to apply or capture
        images directly to NTFS volumes.
 
 --without-fuse
@@ -169,6 +173,11 @@ wimlib's `configure' script:
        the setxattr() function and the attr/xattr.h header be 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
+       disable support for this.
+
 --enable-ssse3-sha1
        Use a very fast assembly language implementation of SHA1 from Intel.
        Only use this if the build target supports the SSSE3 instructions.
@@ -213,11 +222,10 @@ wimlib has mostly been developed and tested on x86_64 (64-bit) GNU/Linux.
 
 It has been tested on x86 (32-bit) GNU/Linux occasionally.
 
-wimlib may work on FreeBSD.  However, this is not well tested.  If you do not
-have libntfs-3g 2011-4-12 or later available, you must configure with
---without-ntfs-3g.  Also, GNU coreutils is needed to run the test suite.  Before
-mounting a WIM you need to load the POSIX message queue module (run `kldload
-mqueuefs').
+wimlib may work on FreeBSD and Mac OS X.  However, this is not well tested.  If
+you do not have libntfs-3g 2011-4-12 or later available, you must configure with
+--without-ntfs-3g.  On FreeBSD, before mounting a WIM you need to load the POSIX
+message queue module (run `kldload mqueuefs').
 
 wimlib should work on big endian machines but it has not been tested.