a0521f023e394f4245e3af38a8ab40fec3cf4562
[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 along with the DLLs
12    needed for it to run.  Please note that these DLLs are free and open source
13    software; see http://www.cygwin.com/ for more details.
14
15 -  Mounting WIM files is not supported.  On Windows there is no equivalent of
16    FUSE, which I used to get mounting working on Linux and BSD, so I would have
17    to program a "Filesystem Filter" driver with Microsoft's eccentric API.
18
19 -  wimlib's API is not compatible with Microsoft's WIMGAPI, although they offer
20    some of the same functionality.
21
22 So to be clear:
23
24 "imagex capture", "imagex append", and "imagex apply" will work on Windows and
25 have the added advantage of saving and restoring alternate data streams,
26 security descriptors, and reparse points.
27
28 "imagex delete", "imagex dir", "imagex export", "imagex info", "imagex join",
29 "imagex optimize", and "imagex split" are all portable and should work the same
30 way on Windows as on UNIX.
31
32 "imagex mount", "imagex mountrw", and "imagex unmount" will NOT work on Windows.
33
34 So on Windows, why would you want to use wimlib's ImageX instead of Microsoft's?
35 Well, here are a few reasons:
36
37 - wimlib can be freely distributed; there is no need to download a 1.8 gigabyte
38   "Windows Automated Installation Kit".
39 - wimlib offers fast multithreaded compression, so making WIM images can be much
40   faster.
41 - wimlib is free software, so you can modify and/or audit the source code.