Update extraction documentation
[wimlib] / README.WINDOWS
1
2                                   INTRODUCTION
3
4 wimlib is free and open source software that is available on both UNIX-like
5 systems and Windows.  This file provides additional information specifically
6 about the Windows version of wimlib and the command line tool "wimlib-imagex"
7 that is distributed with it.  It does not obsolete the generic README.txt, which
8 you should read too.
9
10                               WINDOWS DISTRIBUTION
11
12 For the convenience of Windows users, the Windows distribution of wimlib is a
13 ZIP file containing the following items:
14
15   * wimlib-imagex.exe, a command-line tool to deal with WIM (.wim) and split WIM
16     (.swm) files that is similar to Microsoft's ImageX.  This is a ready-to-run
17     executable and not an installer.
18
19   * Very short batch scripts (e.g. wimapply.cmd) which are shortcuts to the
20     corresponding wimlib-imagex commands (e.g. `wimlib-imagex apply').
21
22   * The documentation, including this file, the generic README.txt, and
23     PDF documentation for wimlib-imagex in the 'doc' directory.
24
25   * Various DLL (.dll) files, including the wimlib library itself
26     (libwim-9.dll).  The C header wimlib.h is not included; download the source
27     if you want it.
28
29   * License files for all software included.  These are all free software
30     licenses.
31
32                                  WIMLIB-IMAGEX
33
34 wimlib-imagex provides most features of Microsoft's ImageX, plus additional
35 features.  Perhaps the main limitation is that mounting images from a WIM file
36 is not supported on Windows.  However, wimlib-imagex provides a number of
37 advantages compared to Microsoft's ImageX, including but not limited to the
38 following:
39
40   * wimlib-imagex provides "extract" and "update" commands that can be used to
41     work around the lack of mount support.  These commands are very fast
42     compared to mounting and unmounting images with Microsoft's ImageX, so you
43     may prefer them anyway.
44
45   * wimlib-imagex provides an easy-to-use "optimize" command to remove wasted
46     space from WIM files.
47
48   * In some cases, wimlib-imagex uses simpler command-line syntax.  For
49     example, integrity tables are treated as persistent, and in some cases image
50     names need not be explicitly specified.
51
52   * Whenever possible, wimlib-imagex includes improved documentation and
53     informational output compared to Microsoft's software.
54
55   * On Windows, wimlib-imagex can correctly save and restore some combinations
56     of data that Microsoft's ImageX runs into bugs on --- for example,
57     uncompressed files in compressed directories, or files with alternate data
58     streams and multiple hard links.
59
60   * wimlib and wimlib-imagex are free software, so you can modify and/or audit
61     the source code.
62
63                                 ADDITIONAL NOTES
64
65 Currently there is no graphical user interface available for wimlib or
66 wimlib-imagex.  It's recommended to use wimlib-imagex in scripts to avoid having
67 to interactively enter commands.  However, note that wimlib-imagex is largely
68 just a command-line front-end for wimlib, and it's possible to use wimlib's API
69 in other front-ends or applications.