Code and docs cleanup
[wimlib] / README.WINDOWS
1 wimlib 1.3.0 has added experimental support for Windows builds.  These builds
2 include both the "wimlib" library (built as a DLL) and the "imagex" executable.
3
4 The Windows builds use native Win32 calls when appropriate to handle alternate
5 data streams, security descriptors, and reparse points.
6
7 Windows support currently has the following limitations:
8
9 -  It relies on the Cygwin UNIX-compatibility layer.  You do not, however, need
10    to have the Cygwin distribution installed to run it, as I have posted a ZIP
11    file on SourceForge that contains the build of wimlib and "imagex" along with
12    the DLLs needed for it to run.  Please note that these DLLs are free and open
13    source software; see http://www.cygwin.com/ for more details.
14
15 -  Mounting WIM files is not supported.
16
17 -  wimlib's API is not compatible with Microsoft's WIMGAPI, although they offer
18    some of the same functionality.
19
20 So, in terms of the "imagex" program:
21
22 "imagex capture", "imagex append", and "imagex apply" will work on Windows and
23 have the added advantage of saving and restoring alternate data streams,
24 security descriptors, and reparse points.
25
26 "imagex delete", "imagex dir", "imagex export", "imagex info", "imagex join",
27 "imagex optimize", and "imagex split" are all portable and should work the same
28 way on Windows as on UNIX.
29
30 "imagex mount", "imagex mountrw", and "imagex unmount" will NOT work on Windows.
31
32 So on Windows, why would you want to use wimlib's ImageX instead of Microsoft's?
33 Well, here are a few reasons:
34
35 - wimlib can be freely distributed; there is no need to download a 1.8 gigabyte
36   "Windows Automated Installation Kit".
37 - wimlib offers fast multithreaded compression, so making WIM images can be much
38   faster.
39 - wimlib is free software, so you can modify and/or audit the source code.