- INTRODUCTION
-wimlib 1.3.0 has added experimental support for Windows builds. The support has
-been further improved in later versions. The Windows build consists of both the
-"wimlib" library (which can be built as a DLL) and the "wimlib-imagex"
-executable.
+ INTRODUCTION
-The Windows build of wimlib uses native Win32 calls when appropriate to handle
-alternate data streams, security descriptors, reparse points, encrypted files,
-compressed files, and sparse files.
+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
-"wimlib-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
+For the convenience of Windows users, the Windows distribution of wimlib is a
+ZIP file containing the following items:
-"wimlib-imagex capture", "wimlib-imagex append", and "wimlib-imagex apply" will
-work on Windows and have the added advantage of saving and restoring
-NTFS-specific data, such as alternate data streams, security descriptors, and
-reparse points.
+ * wimlib-imagex.exe, a command-line tool to deal with WIM (.wim) and split WIM
+ (.swm) files that is similar to Microsoft's ImageX. This is a ready-to-run
+ executable and not an installer.
-"wimlib-imagex delete", "wimlib-imagex dir", "wimlib-imagex export",
-"wimlib-imagex info", "wimlib-imagex join", "wimlib-imagex optimize", and
-"wimlib-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').
-"wimlib-imagex mount", "wimlib-imagex mountrw", and "wimlib-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.
-So on Windows, why would you want to use wimlib's ImageX instead of Microsoft's?
-Well, here are a few reasons:
+ * Various DLL (.dll) files, including the wimlib library itself
+ (libwim-9.dll). The C header wimlib.h is not included; download the source
+ if you want it.
-- wimlib offers fast multithreaded compression, so making WIM images can be much
- faster.
+ * License files for all software included. These are all free software
+ licenses.
-- Whenever possible I have included improved documentation and informational
- output compared to Microsoft's software.
+ WIMLIB-IMAGEX
-- wimlib can correctly save and restore some combinations of data that
- Microsoft's ImageX runs into bugs on --- for example, uncompressed files in
- compressed directories, or files with alternate data streams and multiple
- links.
+wimlib-imagex provides most features of Microsoft's ImageX, plus additional
+features. First, the main limitations of wimlib-imagex compared to Microsoft's
+ImageX are the following:
-- wimlib is free software, so you can modify and/or audit the source code.
+ * Mounting images from a WIM file is not supported on Windows.
-See the man page for 'wimlib-imagex' for more information.
+ * The LZX ("maximum") compression ratio is several percent worse than
+ Microsoft's implementation.
- BUILDING ON WINDOWS
+However, wimlib-imagex provides a number of advantages compared to Microsoft's
+ImageX, including but not limited to the following:
-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-imagex provides "extract" and "update" commands that can be used to
+ work around the lack of mount support. These commands are very fast
+ compared to mounting and unmounting images with Microsoft's ImageX, so you
+ may prefer them anyway.
-$ ./configure --host=i686-w64-mingw32
+ * wimlib-imagex offers fast multithreaded compression, so making WIM images
+ can be much faster.
-after having installed the required libraries:
+ * wimlib-imagex provides a better XPRESS ("fast") compression ratio than
+ Microsoft's ImageX.
-* mingw-w64-gettext
-* mingw-w64-libiconv
-* mingw-w64-libxml2
-* mingw-w64-winpthreads
-* mingw-w64-zlib
+ * wimlib-imagex provides an easy-to-use "optimize" command to remove wasted
+ space from WIM files.
-Note: zlib and gettext are only necessary when required by the build of libxml2.
+ * In some cases, wimlib-imagex uses simpler command-line syntax. For
+ example, `wimlib-imagex capture' (or simply `wimcapture') defaults to
+ maximum compression by default, integrity tables are treated as persistent,
+ and in some cases image names need not be explicitly specified.
-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 made it possible to do a native Win32 build
-instead.
+ * Whenever possible, wimlib-imagex includes improved documentation and
+ informational output compared to Microsoft's software.
+
+ * On Windows, wimlib-imagex can correctly save and restore some combinations
+ of data that Microsoft's ImageX runs into bugs on --- for example,
+ uncompressed files in compressed directories, or files with alternate data
+ streams and multiple hard links.
+
+ * wimlib and wimlib-imagex are free software, so you can modify and/or audit
+ the source code.
+
+ ADDITIONAL NOTES
+
+Currently there is no graphical user interface available for wimlib or
+wimlib-imagex. 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.
git://wimlib.net / wimlib / blobdiff