README.WINDOWS: describe 64-bit build by default
[wimlib] / README.WINDOWS
index 45b7ad5..9d57fbc 100644 (file)
-                                  INTRODUCTION
 
-wimlib 1.3.0 has added experimental support for Windows builds.  The Windows
-build consists of both the "wimlib" library (which can be built as a DLL) and
-the "imagex" executable.
+                                  INTRODUCTION
 
-The Windows build of wimlib uses native Win32 calls when appropriate to handle
-alternate data streams, security descriptors, and reparse points.
+wimlib is free and open source software that is available on both UNIX-like
+systems and Windows.  This file provides additional information specifically
+about the Windows version of wimlib and the command line tool "wimlib-imagex"
+that is distributed with it.  It does not obsolete the generic README.txt, which
+you should read too.
 
-Mounting WIM files is not supported on Windows.  Also please note that wimlib's
-"imagex" is NOT intended to be command-line compatible with Microsoft's
-"imagex", and wimlib is NOT intended to be API compatible with Microsoft's
-WIMGAPI.  They are similar, though.
+                              WINDOWS DISTRIBUTION
 
-                                NOTES ABOUT IMAGEX
+The Windows distribution of wimlib is a ZIP file containing the following items:
 
-"imagex capture", "imagex append", and "imagex apply" will work on Windows and
-have the added advantage of saving and restoring alternate data streams,
-security descriptors, and reparse points.
+  * wimlib-imagex.exe, a command-line tool to deal with WIM (.wim), split WIM
+    (.swm), and ESD (.esd) files that is inspired by Microsoft's ImageX and
+    DISM.  This is a ready-to-run executable and not an installer.
 
-"imagex delete", "imagex dir", "imagex export", "imagex info", "imagex join",
-"imagex optimize", and "imagex split" are all portable and should work the same
-way on Windows as on UNIX.
+  * Very short batch scripts (e.g. wimapply.cmd) which are shortcuts to the
+    corresponding wimlib-imagex commands (e.g. `wimlib-imagex apply').
 
-"imagex mount", "imagex mountrw", and "imagex unmount" will NOT work on Windows.
+  * The documentation, including this file, the generic README.txt, and
+    PDF documentation for wimlib-imagex in the 'doc' directory.
 
+  * The library itself (libwim-15.dll).  The C header wimlib.h is not
+    included; download the source if you want it.
 
-So on Windows, why would you want to use wimlib's ImageX instead of Microsoft's?
-Well, here are a few reasons:
+  * License files for all software included.  These are all free software
+    licenses.  COPYING.txt is the main license, and it refers to
+    COPYING.GPLv3.txt and COPYING.LGPLv3.txt.  The other licenses are for
+    third-party software included in the library.
 
-- wimlib offers fast multithreaded compression, so making WIM images can be much
-  faster.
+Note that there are separate ZIP files for 32-bit (i686) and 64-bit (x86_64)
+binaries.  They are both fully supported, but you should prefer the 64-bit
+binaries when possible as they can be noticeably faster.
 
-- wimlib can correctly save and restore alternate data streams, which
-  Microsoft's ImageX sometimes captures incorrectly due to a bug.
+                                 WIMLIB-IMAGEX
 
-- wimlib is free software, so you can modify and/or audit the source code.
+wimlib-imagex supports most features of Microsoft's ImageX as well as some
+features that are supported by DISM but not by ImageX.  wimlib-imagex also
+supports some features that neither ImageX nor DISM support.  Some of the
+advantages of wimlib-imagex compared to ImageX and DISM are:
 
-See the man page for 'imagex' for more information.
+  * wimlib-imagex provides "extract" and "update" commands which allow
+    you to quickly work with WIM images without mounting them.
 
-                                BUILDING ON WINDOWS
+  * wimlib-imagex provides an easy-to-use "optimize" command which removes
+    wasted space from a WIM file and optionally recompresses it with stronger
+    compression.
 
-Actually doing the Windows build is a bit tricky, and I'd recommend you download
-precompiled binaries from http://sourceforge.net/projects/wimlib/files/ instead.
-I did it using MinGW-w64 on a Linux host, with the following configuration
-command:
+  * wimlib includes advanced implementations of all compression algorithms used
+    in WIM files.  They usually outperform and outcompress their Microsoft
+    equivalents.
 
-$ ./configure --host=i686-w64-mingw32 \
-              CPPFLAGS=-I/opt/libxml2-min/i686-w64-mingw32/include/libxml2 \
-              LDFLAGS=-L/opt/libxml2-min/i686-w64-mingw32/lib
+  * wimlib-imagex supports solid WIM files and LZMS compression, for example as
+    used in ESD (.esd) files.  (These are partially supported by recent DISM
+    versions but not by ImageX.)
 
-Building wimlib using Cygwin is not supported.  I was trying this for a while,
-but I ran into some issues with mixing native Win32 functions and
-Cygwin-provided functions, so I just made it possible to do a native Win32 build
-instead.
+  * wimlib-imagex supports imaging a live Windows system.  Just use the
+    --snapshot option.
+
+  * In many cases, wimlib-imagex has simpler command-line syntax than either
+    ImageX or DISM.
+
+  * Whenever possible, wimlib-imagex includes improved documentation and
+    informational output compared to Microsoft's software.
+
+  * wimlib and wimlib-imagex are free software, so you can modify and/or audit
+    the source code.
+
+However, some limitations of wimlib-imagex compared to ImageX and DISM are:
+
+  * On Windows, wimlib-imagex does not support mounting WIM images.
+
+  * wimlib-imagex has no awareness of Windows "packages".
+
+                                ADDITIONAL NOTES
+
+It's recommended to use wimlib-imagex in scripts to avoid having to
+interactively enter commands.  However, note that wimlib-imagex is largely just
+a command-line front-end for wimlib, and it's possible to use wimlib's API in
+other front-ends or applications.  Currently there is no official graphical user
+interface available for wimlib or wimlib-imagex.  However, an unofficial, beta,
+Windows-only graphical user interface that provides a thin wrapper around
+wimlib-imagex can be downloaded at
+http://reboot.pro/files/file/485-wimlib-imagex-command-line-compiler/.
+
+                              BUILDING FROM SOURCE
+
+As with other open source software, advanced users may choose to build wimlib
+from source, potentially with customizations.  Although wimlib's build system is
+designed for UNIX-like systems and is easiest to use on Linux, it's possible to
+build Windows binaries on Windows using Cygwin with MinGW.  To do this, follow
+the instructions below.  For the sake of example, I'll assume you are building a
+64-bit version of wimlib v1.10.0.
+
+Run the Cygwin installer, available from https://www.cygwin.com/setup-x86.exe.
+When you get to the package selection screen, choose the following additional
+packages from category "Devel":
+
+    - make
+    - mingw64-x86_64-binutils
+    - mingw64-x86_64-gcc-g++
+    - mingw64-x86_64-libxml2
+    - mingw64-x86_64-pkg-config
+    - mingw64-x86_64-winpthreads
+
+Download wimlib's source code from https://wimlib.net/downloads/wimlib-1.10.0.tar.gz.
+
+Start a Cygwin terminal and run the following commands:
+
+    cd /cygdrive/c/Users/example/Downloads # (or wherever you downloaded the source to)
+    tar xf wimlib-1.10.0.tar.gz
+    cd wimlib-1.10.0
+    ./configure --host=x86_64-w64-mingw32
+    make
+
+If successful, the new binaries "libwim-15.dll" and "wimlib-imagex.exe" will
+have been produced in the .libs directory.
+
+By default the binaries are built with debug symbols.  If desired, you can use
+x86_64-w64-mingw32-strip to strip them.
+
+libwim-15.dll will be linked to several other DLLs which you will need as well:
+
+    - libwinpthread-1.dll
+    - libxml2-2.dll, which also requires:
+        - iconv.dll
+        - liblzma-5.dll
+        - zlib1.dll
+
+These DLLs can be found in "C:\cygwin\usr\x86_64-w64-mingw32\sys-root\mingw\bin"
+and must be placed alongside libwim-15.dll for it to run portably.  (In the
+official binary release, these third-party libraries are linked to libwim-15.dll
+statically rather than dynamically --- or are unnecessary, in the case of
+libxml2's dependencies.)
+
+Building 32-bit binaries is very similar, but you'll need to replace "x86_64"
+with "i686" everywhere in the above instructions, and libwim-15.dll will also
+depend on libgcc_s_sjlj-1.dll.  Note that you can build both 32-bit and 64-bit
+binaries from the same Cygwin installation, provided that you install both the
+mingw64-i686-* and mingw64-x86_64-* packages; and you can run the Cygwin setup
+program to install more packages at any time.