a5cacf67d3daadbcb85cb77f007371338f0dd166
[wimlib] / README
1                                    WIMLIB                                    
2
3 This is wimlib version 0.6.3 (May 2012).  wimlib can be used to read, write,
4 and mount files in the Windows Imaging Format (WIM files).  These files are
5 normally created by using the `imagex.exe' utility on Windows, but this library
6 provides a free implementetion of imagex for UNIX-based systems.
7
8 The main use of this library is to create customized images of Windows PE, the
9 Windows Preinstallation Environment, without having to rely on Windows.  Windows
10 PE is a lightweight version of Windows that can run entirely from memory and can
11 be used to install Windows from local media or a network drive or perform
12 maintenance.  Windows PE is the operating systems runs when you boot from the
13 Windows DVD.
14
15 You can find Windows PE on the ISO filesystem on the installation DVD for both
16 Windows 7 and Windows 8.  I don't have a DVD for Vista but it should be on there
17 too.  The Windows PE image a WIM file, `sources/boot.wim', on the ISO
18 filesystem.  Windows PE can also be found in the Windows Automated Installation
19 Kit (WAIK), which is free to download from Microsoft, inside the `WinPE.cab'
20 file, which you can extract if you install the `cabextract' program.
21
22 wimlib provides a public API for other programs to use, but also comes with two
23 programs: `imagex' and `mkwinpeimg'.  
24
25 `imagex' is intended to be like the imagex.exe program from Windows.  `imagex'
26 can be used to create, extract, and mount WIM files.  Both read-only and
27 read-write mounts are supported.  See the man page `doc/imagex.1' for more
28 details.
29
30 `mkwinpeimg' is shell script that makes it easy to create a customized bootable
31 image of Windows PE that can be put on a CD or USB drive, or published on a
32 server for PXE booting.  See the main page `doc/mkwinpeiso.1' for more details.
33
34 Wimlib can also be used to handle larger WIM files such as the `install.wim'
35 file that comes on the Windows DVD; however, this has not been well tested.
36
37 An earlier version of Wimlib is being used to deploy Windows 7 from the Ultimate
38 Deployment Appliance.  For more information see
39 http://www.ultimatedeployment.org/.  
40
41 -------------------------------------------------------------------------------
42
43                                  CONFIGURATION
44
45 Besides the various well-known options, the following options can be passed to
46 wimlib's `configure' script:
47
48 --without-fuse
49         If libfuse or the FUSE kernel module is not available, wimlib can be
50         compiled with --without-fuse.  This will remove the ability to mount and
51         unmount WIM files.  wimlib_mount() and wimlib_unmount() will fail with
52         WIMLIB_ERR_UNSUPPORTED.
53
54 --disable-libcrypto
55         Build in functions for SHA1 rather than using external SHA1 functions
56         from libcrypto (part of OpenSSL).  The default is to use libcrypto if it
57         is found on the system.
58
59 --enable-ssse3-sha1
60         Use a very fast assembly language implementation of SHA1 from Intel.
61         Only use this if the build target supports the SSSE3 instructions.
62
63 --disable-custom-memory-allocator
64         If this option is given, MALLOC(), FREE(), CALLOC(), and STRDUP() will
65         directly call the appropriate functions in the C library.
66         wimlib_set_memory_allocator() will fail with WIMLIB_ERR_UNSUPPORTED.
67
68 --disable-verify-compression
69         Unless this option is given, every time wimlib compresses a data block
70         it will decompress it into a temporary buffer and abort() the program
71         with an error message if the decompressed data does not exactly match
72         the original data.  This is to find bugs.
73
74 --disable-error-messages
75         Removes all error messages from the library.  If left in, they still
76         have to explicitly turned on with wimlib_set_print_errors() in order to
77         see them.  Also, error codes will still be returned regardless of
78         whether error messages are printed or not.  
79
80         If --disable-error-messages is given, wimlib_set_print_errors() will
81         fail with WIMLIB_ERR_UNSUPPORTED if the action is to turn error messages
82         on.
83
84 --disable-assertions
85         Remove all assertions.  Without this option, wimlib will abort() the
86         program if an assertion fails.  An assertion failure should only occur
87         if there is a bug in wimlib.
88
89 --disable-security-data
90         Wimlib cannot create or modify WIM security data, but by default it will
91         copy existing security data when modifying a WIM or exporting an image.
92         Passing this flag will disable this support; then wimlib will always
93         write WIMs without security data.
94
95 --enable-debug
96         Include debugging messages.  Only use this option if you have found a
97         bug in the library.
98
99 --enable-more-debug
100         Include more debugging messages.  Only use this option if you have found
101         a bug in the library.
102
103
104 -------------------------------------------------------------------------------
105
106                                   DEPENDENCIES
107
108 Wimlib requires libxml2 to build.  This is a commonly used free library to read
109 and write XML files.  You likely already have it installed as a dependency for
110 some other program.  For more information see http://xmlsoft.org/.
111
112 Wimlib also requires libfuse to build (unless configured with --without-fuse;
113 see above).  Most GNU/Linux distributions already include this, but make sure
114 you have the libfuse package installed (libfuse-dev if your distribution
115 distributes header files separately).  FUSE also requires a kernel module.  If
116 the kernel module is available it will automatically be loaded if you try to
117 mount a WIM file.  Wimlib has only been tested with the Linux version of FUSE.
118 For more information see http://fuse.sourceforge.net/.
119
120 The `mkwinpeimg' shell script will look for several other programs depending on
121 what options are given to it.  Depending on your GNU/Linux distribution, you may
122 already have these programs installed, or they may be in the software
123 repository.  Making an ISO filesystem requires `mkisofs' from `cdrkit'
124 (http://www.cdrkit.org).  Making a disk image requires `mtools'
125 (http://www.gnu.org/software/mtools) and `syslinux' (http://www.syslinux.org).
126 Retrieving files from the Windows Automated Installation Kit requires
127 `cabextract' (http://www.cabextract.org.uk).
128
129 ------------------------------------------------------------------------------
130
131                                   PORTABILITY
132
133 wimlib has mostly been developed and tested on x86_64 (64-bit) GNU/Linux.
134
135 It has been tested on x86 (32-bit) GNU/Linux occasionally.
136
137 It can also be compiled and run on FreeBSD.
138
139 wimlib should work on big endian machines but it has not been tested.
140
141 There are no plans to port wimlib to Windows since the programming interface on
142 Windows is very different and Microsoft's imagex.exe is already available.
143
144 ------------------------------------------------------------------------------
145
146                                    REFERENCES 
147
148 The WIM file format is specified in a document that can be found in the
149 Microsoft Download Center.  There is a similar document that specifies the LZX
150 compression format, and a document that specifies the XPRESS compression format.
151 However, some aspects of these formats are poorly documented.  Some particularly
152 poorly documented parts of the formats have had comments added in various places
153 in the library.
154
155 lzx-decomp.c, the code to decompress WIM file resources that are compressed
156 using LZX compression, is originally based on code from the cabextract project
157 (http://www.cabextract.org.uk).  
158
159 lzx-comp.c, the code to compress WIM file resources using LZX compression, is
160 originally based on code written by Matthew Russotto (www.russotto.net/chm/).
161
162 lz.c, the code to find LZ77 matches, is based on code from zlib.
163
164 sha1.c and sha1.h, the code to compute SHA1 message digests of WIM resources or
165 of the WIM file itself in the case of integrity checks, are based on code from
166 GNU coreutils.
167
168 A very limited number of other free programs can handle some parts of the WIM
169 file format.  7-zip is able to extract and create WIMs and files in many other
170 archive formats.  However, WIMLIB is designed specifically to handle WIM files
171 and provides features previously only available in Microsoft's imagex.exe, such
172 as the ability to mount WIMs read-write.
173
174 ------------------------------------------------------------------------------
175
176                                 MORE INFORMATION
177
178 See the manual pages for `imagex', the manual pages for the subcommands of
179 `imagex', and the manual page for `mkwinpeimg'.
180
181 As of version 0.5.0, Wimlib's public API is documented.  Doxygen is required to
182 build the documentation.  To build the documentation, run `configure', then
183 enter the directory `doc' and run `doxygen'.  The HTML documentation will be
184 created in a directory named `html'.
185
186 ------------------------------------------------------------------------------
187
188                                     LICENSE
189
190 Wimlib is released under the GNU LGPL version 2.1 or later.  The files in the
191 `programs' directory are released under the GPL version 3.
192
193 ------------------------------------------------------------------------------
194
195                                    DISCLAIMER 
196
197 Wimlib is experimental.  Use Microsoft's `imagex.exe' if you want to make sure
198 your WIM files are made correctly.  Please submit a bug report (to
199 ebiggers3@gmail.com) if you find a bug.
200
201 Some parts of the WIM file format are poorly documented or even completely
202 undocumented, so these parts had to be reverse engineered.