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