wimlib.net Git - wimlib/blob - README

   1                                    WIMLIB
   2
   3 This is wimlib version 1.0.0 (September 2012).  wimlib can be used to read,
   4 write, and mount files in the Windows Imaging Format (WIM files).  These
   5 files are normally created by using the `imagex.exe' utility on Windows,
   6 but this library provides a free implementetion of imagex for UNIX-based
   7 systems.
   8
   9                                    WIM FILES
  10
  11 A Windows Imaging (WIM) file is an archive.  Like some other archive formats
  12 such as ZIP, files in WIM archives may be compressed.  WIM archives support two
  13 Microsoft-specific compression formats:  LZX and XPRESS.  Both are based on LZ77
  14 and Huffman encoding, and both are supported by wimlib.
  15
  16 Unlike ZIP files, WIM files can contain multiple independent toplevel directory
  17 trees known as images.  While each image has its own metadata describing a
  18 directory tree and file access modes, files are not duplicated for each image;
  19 instead, each file is included only once in the entire WIM.  Microsoft did this
  20 so that in one WIM file, they could do things like have 5 different versions of
  21 Windows that are almost exactly the same.
  22
  23 Microsoft provides documentation for the WIM file format, XPRESS compression
  24 format, and LZX compression format.  The XPRESS documentation is acceptable, but
  25 the LZX documentation is not entirely correct, and the WIM documentation itself
  26 is very incomplete and is of unacceptable quality.
  27
  28                                    WINDOWS PE
  29
  30 A major use for this library is to create customized images of Windows PE, the
  31 Windows Preinstallation Environment, without having to rely on Windows.  Windows
  32 PE is a lightweight version of Windows that can run entirely from memory and can
  33 be used to install Windows from local media or a network drive or perform
  34 maintenance.  Windows PE is the operating system that runs when you boot from
  35 the Windows installation media.
  36
  37 You can find Windows PE on the installation DVD for Windows Vista, Windows 7, or
  38 Windows 8, in the file `sources/boot.wim'.  Windows PE can also be found in the
  39 Windows Automated Installation Kit (WAIK), which is free to download from
  40 Microsoft, inside the `WinPE.cab' file, which you can extract if you install
  41 either the `cabextract' or `p7zip' programs.
  42
  43 In addition, Windows installations and recovery partitions frequently contain a
  44 WIM containing an image of the Windows Recovery Environment, which is similar to
  45 Windows PE.
  46
  47                                   NTFS SUPPORT
  48
  49 As of version 1.0.0, wimlib supports capturing and applying images directly to
  50 NTFS volumes.  This was made possible with the help of libntfs-3g from the
  51 NTFS-3g project.  This feature supports capturing and restoring NTFS-specific
  52 data such as security descriptors, alternate data streams, and reparse point
  53 data.
  54
  55 The code for NTFS image capture and image application is complete enough that it
  56 is possible to apply an image from the "install.wim" contained in recent Windows
  57 installation media (Vista, Windows 7, or Windows 8) directly to a NTFS volume,
  58 and then boot Windows from it after preparing the Boot Configuration Data.  In
  59 addition, a Windows installation can be captured (or backed up) into a WIM file,
  60 and then re-applied later.
  61
  62                                     PROGRAMS
  63
  64 wimlib provides a public API for other programs to use, but also comes with two
  65 programs: `imagex' and `mkwinpeimg'.
  66
  67 `imagex' is intended to be like the imagex.exe program from Windows.  `imagex'
  68 can be used to create, extract, and mount WIM files.  Both read-only and
  69 read-write mounts are supported.  See the man page `doc/imagex.1' for more
  70 details.
  71
  72 `mkwinpeimg' is shell script that makes it easy to create a customized bootable
  73 image of Windows PE that can be put on a CD or USB drive, or published on a
  74 server for PXE booting.  See the main page `doc/mkwinpeiso.1' for more details.
  75
  76                                   DEPENDENCIES
  77
  78 * libxml2
  79         This is a commonly used free library to read and write XML files.  You
  80         likely already have it installed as a dependency for some other program.
  81         For more information see http://xmlsoft.org/.
  82
  83 * libfuse
  84         Unless configured with --without-fuse, wimlib requires a non-ancient
  85         version of libfuse to be installed.  Most GNU/Linux distributions
  86         already include this, but make sure you have the libfuse package
  87         installed, and also libfuse-dev if your distribution distributes header
  88         files separately.  FUSE also requires a kernel module.  If the kernel
  89         module is available it will automatically be loaded if you try to mount
  90         a WIM file.  For more information see http://fuse.sourceforge.net/.
  91         FUSE is also available for FreeBSD.
  92
  93 * libntfs-3g
  94         Unless configured with --without-ntfs-3g, wimlib requires the library
  95         and headers for libntfs-3g to be installed.  Currently, the libntfs-3g
  96         version dated 2012-1-15 is required because I've cloned some of the code
  97         from the library, and it needs to compiled against the same version.
  98         I'm hoping to be able to use future version of libntfs-3g without code
  99         cloning after submitting some patches, however.
 100
 101 * cdrkit (optional)
 102 * mtools (optional)
 103 * syslinux (optional)
 104 * cabextract (optional)
 105         The `mkwinpeimg' shell script will look for several other programs
 106         depending on what options are given to it.  Depending on your GNU/Linux
 107         distribution, you may already have these programs installed, or they may
 108         be in the software repository.  Making an ISO filesystem requires
 109         `mkisofs' from `cdrkit' (http://www.cdrkit.org).  Making a disk image
 110         requires `mtools' (http://www.gnu.org/software/mtools) and `syslinux'
 111         (http://www.syslinux.org).  Retrieving files from the Windows Automated
 112         Installation Kit requires `cabextract' (http://www.cabextract.org.uk).
 113
 114
 115                                  CONFIGURATION
 116
 117 Besides the various well-known options, the following options can be passed to
 118 wimlib's `configure' script:
 119
 120 --without-ntfs-3g
 121         If libntfs-3g is not available or is not the correct version, we can
 122         build without it.  wimlib will then not be able to apply or capture
 123         images directly to NTFS volumes.
 124
 125 --without-fuse
 126         If libfuse or the FUSE kernel module is not available, wimlib can be
 127         compiled with --without-fuse.  This will remove the ability to mount and
 128         unmount WIM files.  wimlib_mount() and wimlib_unmount() will fail with
 129         WIMLIB_ERR_UNSUPPORTED.
 130
 131 --without-libcrypto
 132         Build in functions for SHA1 rather than using external SHA1 functions
 133         from libcrypto (part of OpenSSL).  The default is to use libcrypto if it
 134         is found on the system.
 135
 136 --enable-xattr, --disable-xattr
 137         Enable or disable support for the extended-attributes interface to NTFS
 138         alternate data streams in mounted WIMs.  To support these, we require
 139         the setxattr() function and the attr/xattr.h header be available.  The
 140         default is to autodetect whether support is possible.
 141
 142 --enable-ssse3-sha1
 143         Use a very fast assembly language implementation of SHA1 from Intel.
 144         Only use this if the build target supports the SSSE3 instructions.
 145
 146 --disable-custom-memory-allocator
 147         If this option is given, MALLOC(), FREE(), CALLOC(), and STRDUP() will
 148         directly call the appropriate functions in the C library.
 149         wimlib_set_memory_allocator() will fail with WIMLIB_ERR_UNSUPPORTED.
 150
 151 --disable-verify-compression
 152         Unless this option is given, every time wimlib compresses a data block
 153         it will decompress it into a temporary buffer and abort() the program
 154         with an error message if the decompressed data does not exactly match
 155         the original data.  This is to find bugs.
 156
 157 --disable-error-messages
 158         Removes all error messages from the library.  If left in, they still
 159         have to explicitly turned on with wimlib_set_print_errors() in order to
 160         see them.  Also, error codes will still be returned regardless of
 161         whether error messages are printed or not.
 162
 163         If --disable-error-messages is given, wimlib_set_print_errors() will
 164         fail with WIMLIB_ERR_UNSUPPORTED if the action is to turn error messages
 165         on.
 166
 167 --disable-assertions
 168         Remove all assertions.  Without this option, wimlib will abort() the
 169         program if an assertion fails.  An assertion failure should only occur
 170         if there is a bug in wimlib.
 171
 172 --enable-debug
 173         Include debugging messages.  Only use this option if you have found a
 174         bug in the library.
 175
 176 --enable-more-debug
 177         Include more debugging messages.  Only use this option if you have found
 178         a bug in the library.
 179
 180                                   PORTABILITY
 181
 182 wimlib has mostly been developed and tested on x86_64 (64-bit) GNU/Linux.
 183
 184 It has been tested on x86 (32-bit) GNU/Linux occasionally.
 185
 186 I have tested a previous version of wimlib on FreeBSD and it worked, but this is
 187 not well tested, especially with the more recent versions of this software.
 188
 189 wimlib should work on big endian machines but it has not been tested.
 190
 191 There are no plans to port wimlib to Windows since the programming interface on
 192 Windows is very different and Microsoft's imagex.exe is already available.
 193
 194                                    REFERENCES
 195
 196 The WIM file format is specified in a document that can be found in the
 197 Microsoft Download Center.  There is a similar document that specifies the LZX
 198 compression format, and a document that specifies the XPRESS compression format.
 199 However, many parts of these formats are poorly documented, and some parts have
 200 no documentation whatsoever.  Some particularly poorly documented parts of the
 201 formats have had comments added in various places in the library.  Please see
 202 the code and/or ask me if you have any questions about the WIM file format as it
 203 exists in reality and not as it exists in Microsoft's poorly written
 204 documentation.
 205
 206 The code in ntfs-apply.c and ntfs-capture.c uses the NTFS-3g library, which is a
 207 library for reading and writing to NTFS filesystems (the filesystem used by
 208 recent versions of Windows).  Additionally, the code in ntfs-3g-security.c is
 209 mostly copied from NTFS-3g, but I'm hoping to get rid of this file eventually.
 210 See http://www.tuxera.com/community/ntfs-3g-download/ for more information.
 211
 212 lzx-decomp.c, the code to decompress WIM file resources that are compressed
 213 using LZX compression, is originally based on code from the cabextract project
 214 (http://www.cabextract.org.uk).
 215
 216 lzx-comp.c, the code to compress WIM file resources using LZX compression, is
 217 originally based on code written by Matthew Russotto (www.russotto.net/chm/).
 218
 219 lz.c, the code to find LZ77 matches (used for both XPRESS and LZX compression),
 220 is based on code from zlib.
 221
 222 A very limited number of other free programs can handle some parts of the WIM
 223 file format.  7-zip is able to extract and create WIMs (as well as files in many
 224 other archive formats).  However, wimlib is designed specifically to handle WIM
 225 files and provides features previously only available in Microsoft's imagex.exe,
 226 such as the ability to mount WIMs read-write as well as read-only, and the
 227 ability to create LZX or XPRESS compressed WIMs.
 228
 229 An earlier version of wimlib is being used to deploy Windows 7 from the Ultimate
 230 Deployment Appliance.  For more information see
 231 http://www.ultimatedeployment.org/.
 232
 233 You can see the documentation about Microsoft's version of the imagex program at
 234 http://technet.microsoft.com/en-us/library/cc749447(v=ws.10).aspx, so you can
 235 see how it compares.
 236
 237                                 MORE INFORMATION
 238
 239 See the manual pages for `imagex', the manual pages for the subcommands of
 240 `imagex', and the manual page for `mkwinpeimg'.
 241
 242 As of version 0.5.0, wimlib's public API is documented.  Doxygen is required to
 243 build the documentation.  To build the documentation, run `configure', then
 244 enter the directory `doc' and run `doxygen'.  The HTML documentation will be
 245 created in a directory named `html'.
 246
 247                                     LICENSE
 248
 249 As of version 1.0.0, wimlib is released under the GNU GPL version 3.0 or later.
 250 This includes the files in the `programs' directory.
 251
 252                                    DISCLAIMER
 253
 254 wimlib is experimental.  Use Microsoft's `imagex.exe' if you want to make sure
 255 your WIM files are made correctly (but beware: Microsoft's version contains some
 256 bugs).
 257
 258 Please submit a bug report (to ebiggers3@gmail.com) if you find a bug in wimlib.
 259
 260 Some parts of the WIM file format are poorly documented or even completely
 261 undocumented, so I've just had to do the best I can to read and write WIMs that
 262 appear to be compatible with Microsoft's software.