Windows build updates
[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), split WIM
16     (.swm), and ESD (.esd) files that is inspired by Microsoft's ImageX and
17     DISM.  This is a ready-to-run 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   * The library itself (libwim-15.dll).  The C header wimlib.h is not
26     included; download the source if you want it.
27
28   * License files for all software included.  These are all free software
29     licenses.
30
31                                  WIMLIB-IMAGEX
32
33 wimlib-imagex provides most features of Microsoft's ImageX, plus additional
34 features.  Perhaps the main limitation is that mounting images from a WIM file
35 is not supported on Windows.  However, wimlib-imagex provides a number of
36 advantages compared to Microsoft's ImageX, including but not limited to the
37 following:
38
39   * wimlib-imagex provides "extract" and "update" commands that can be used to
40     work around the lack of mount support.  These commands are very fast
41     compared to mounting and unmounting images with Microsoft's ImageX, so you
42     may prefer them anyway.
43
44   * wimlib-imagex provides an easy-to-use "optimize" command to remove wasted
45     space from WIM files.
46
47   * In some cases, wimlib-imagex uses simpler command-line syntax.  For
48     example, integrity tables are treated as persistent, and in some cases image
49     names need not be explicitly specified.
50
51   * Whenever possible, wimlib-imagex includes improved documentation and
52     informational output compared to Microsoft's software.
53
54   * On Windows, wimlib-imagex can correctly save and restore some combinations
55     of data that Microsoft's ImageX runs into bugs on --- for example,
56     uncompressed files in compressed directories, or files with alternate data
57     streams and multiple hard links.
58
59   * wimlib-imagex also supports ESD (.esd) files, except when encrypted.  (These
60     use a newer version of the WIM file format.)
61
62   * wimlib and wimlib-imagex are free software, so you can modify and/or audit
63     the source code.
64
65                                 ADDITIONAL NOTES
66
67 It's recommended to use wimlib-imagex in scripts to avoid having to
68 interactively enter commands.  However, note that wimlib-imagex is largely just
69 a command-line front-end for wimlib, and it's possible to use wimlib's API in
70 other front-ends or applications.  Currently there is no official graphical user
71 interface available for wimlib or wimlib-imagex.  However, an unofficial, beta,
72 Windows-only graphical user interface that provides a thin wrapper around
73 wimlib-imagex can be downloaded at
74 http://reboot.pro/files/file/485-wimlib-imagex-command-line-compiler/.