wimlib.net Git - wimlib/blob - README

   1                                   INTRODUCTION
   2
   3 This is wimlib version 1.13.6 (September 2022).  wimlib is a C library for
   4 creating, modifying, extracting, and mounting files in the Windows Imaging
   5 Format (WIM files).  wimlib and its command-line frontend 'wimlib-imagex'
   6 provide a free and cross-platform alternative to Microsoft's WIMGAPI, ImageX,
   7 and DISM.
   8
   9                                   INSTALLATION
  10
  11 To install wimlib and wimlib-imagex on UNIX-like systems, you can compile from
  12 source (e.g. './configure && make && sudo make install').  Alternatively, check
  13 if a package has already been prepared for your operating system.
  14
  15 To install wimlib and wimlib-imagex on Windows, just download and extract the
  16 ZIP file containing the latest binaries.  See README.WINDOWS for more details.
  17
  18 All official wimlib releases are available from https://wimlib.net.
  19
  20                                    WIM FILES
  21
  22 A Windows Imaging (WIM) file is an archive designed primarily for archiving
  23 Windows filesystems.  However, it can be used on other platforms as well, with
  24 some limitations.  Like some other archive formats such as ZIP, files in WIM
  25 archives may be compressed.  WIM archives support multiple compression formats,
  26 including LZX, XPRESS, and LZMS.  All these formats are supported by wimlib.
  27
  28 A WIM archive contains one or more "images", each of which is a logically
  29 independent directory tree.  Each image has a 1-based index and usually a name.
  30
  31 WIM archives provide data deduplication at the level of full file contents.  In
  32 other words, each unique "file contents" is only stored once in the archive,
  33 regardless of how many files have that contents across all images.
  34
  35 A WIM archive may be either stand-alone or split into multiple parts.
  36
  37 An update of the WIM format --- first added by Microsoft for Windows 8 ---
  38 supports solid-mode compression.  This refers to files being compressed together
  39 (e.g. as in a .tar.xz or .7z archive) rather than separately (e.g. as in a .zip
  40 archive).  This usually produces a much better compression ratio.  Solid
  41 archives are sometimes called "ESD files" by Microsoft and may have the ".esd"
  42 file extension rather than ".wim".  They are supported in wimlib since v1.6.0.
  43
  44                              IMAGEX IMPLEMENTATION
  45
  46 wimlib itself is a C library, and it provides a documented public API (See:
  47 https://wimlib.net/apidoc) for other programs to use.  However, it is also
  48 distributed with a command-line program called "wimlib-imagex" that uses this
  49 library to implement an imaging tool similar to Microsoft's ImageX.
  50 wimlib-imagex supports almost all the capabilities of Microsoft's ImageX as well
  51 as additional capabilities.  wimlib-imagex works on both UNIX-like systems and
  52 Windows, although some features differ between the platforms.
  53
  54 Run `wimlib-imagex' with no arguments to see an overview of the available
  55 commands and their syntax.  Note that the commands have both long and short
  56 forms, e.g. `wimlib-imagex apply' is equivalent to `wimapply'.  For additional
  57 documentation:
  58
  59   * If you have installed wimlib-imagex on a UNIX-like system, you will find
  60     further documentation in the man pages; run `man wimlib-imagex' to get
  61     started.
  62
  63   * If you have downloaded the Windows binary distribution, you will find the
  64     documentation for wimlib-imagex in PDF format in the "doc" directory.  Note
  65     that although the documentation is written in the style of UNIX manual
  66     pages, it does document Windows-specific behavior when relevant.
  67
  68                                   COMPRESSION
  69
  70 wimlib (and wimlib-imagex) can create XPRESS, LZX, and LZMS compressed WIM
  71 archives.  wimlib's compression codecs usually outperform and outcompress their
  72 closed-source Microsoft equivalents.  Multiple compression levels and chunk
  73 sizes as well as solid mode compression are supported.  Compression is
  74 multithreaded by default.  Detailed benchmark results and descriptions of the
  75 algorithms used can be found at https://wimlib.net/compression.html.
  76
  77                                   NTFS SUPPORT
  78
  79 WIM images may contain data, such as named data streams and
  80 compression/encryption flags, that are best represented on the NTFS filesystem
  81 used on Windows.  Also, WIM images may contain security descriptors which are
  82 specific to Windows and cannot be represented on other operating systems.
  83 wimlib handles this NTFS-specific or Windows-specific data in a
  84 platform-dependent way:
  85
  86   * In the Windows version of wimlib and wimlib-imagex, NTFS-specific and
  87     Windows-specific data are supported natively.
  88
  89   * In the UNIX version of wimlib and wimlib-imagex, NTFS-specific and
  90     Windows-specific data are ordinarily ignored; however, there is also special
  91     support for capturing and extracting images directly to/from unmounted NTFS
  92     volumes.  This was made possible with the help of libntfs-3g from the
  93     NTFS-3G project.
  94
  95 For both platforms the code for NTFS capture and extraction is complete enough
  96 that it is possible to apply an image from the "install.wim" contained in recent
  97 Windows installation media (Vista or later) directly to an NTFS filesystem, and
  98 then boot Windows from it after preparing the Boot Configuration Data.  In
  99 addition, a Windows installation can be captured (or backed up) into a WIM file,
 100 and then re-applied later.
 101
 102                                    WINDOWS PE
 103
 104 wimlib can also be used to create customized images of Windows PE on either
 105 UNIX-like systems or Windows.  Windows PE (Preinstallation Environment) is a
 106 lightweight version of Windows that runs entirely from memory and can be used to
 107 perform maintenance or to install Windows.  It is the operating system that runs
 108 when you boot from the Windows installation media.
 109
 110 A copy of Windows PE can be found on the installation media for Windows (Vista
 111 or later) as the file `sources/boot.wim', or in the Windows Automated
 112 Installation Kit (WAIK), which is free to download from Microsoft.
 113
 114 A shell script `mkwinpeimg' is provided with wimlib on UNIX-like systems to
 115 simplify the process of creating and customizing a bootable Windows PE image,
 116 sourcing the needed files from the Windows installation media or from the WAIK.
 117
 118                                   DEPENDENCIES
 119
 120 This section documents the dependencies of wimlib and the programs distributed
 121 with it, when building for a UNIX-like system from source.  If you have
 122 downloaded the Windows binary distribution of wimlib and wimlib-imagex then all
 123 dependencies were already included and this section is irrelevant.
 124
 125 * libfuse (optional but recommended)
 126         Unless configured --without-fuse, wimlib requires a non-ancient version
 127         of libfuse.  Most Linux distributions already include this, but make
 128         sure you have the libfuse package installed, and also libfuse-dev if
 129         your distribution distributes header files separately.  FUSE also
 130         requires a kernel module.  If the kernel module is available it should
 131         automatically be loaded if you try to mount a WIM image.  For more
 132         information see http://fuse.sourceforge.net/.
 133
 134 * libntfs-3g (optional but recommended)
 135         Unless configured --without-ntfs-3g, wimlib requires the library and
 136         headers for libntfs-3g to be installed.  The minimum required version is
 137         2011-4-12, but newer versions contain important bug fixes.
 138
 139 * cdrkit (optional)
 140 * mtools (optional)
 141 * syslinux (optional)
 142 * cabextract (optional)
 143         The `mkwinpeimg' shell script will look for several other programs
 144         depending on what options are given to it.  Depending on your Linux
 145         distribution, you may already have these programs installed, or they may
 146         be in the software repository.  Making an ISO filesystem requires
 147         `mkisofs' from `cdrkit' (http://www.cdrkit.org).  Making a disk image
 148         requires `mtools' (http://www.gnu.org/software/mtools) and `syslinux'
 149         (http://www.syslinux.org).  Retrieving files from the Windows Automated
 150         Installation Kit requires `cabextract' (http://www.cabextract.org.uk).
 151
 152                                  CONFIGURATION
 153
 154 This section documents the most important options that may be passed to the
 155 "configure" script when building from source:
 156
 157 --without-ntfs-3g
 158         If libntfs-3g is not available or is not version 2011-4-12 or later,
 159         wimlib can be built without it, in which case it will not be possible to
 160         capture or apply WIM images directly from/to NTFS volumes.
 161
 162         The default is --with-ntfs-3g when building for any UNIX-like system,
 163         and --without-ntfs-3g when building for Windows.
 164
 165 --without-fuse
 166         The --without-fuse option disables support for mounting WIM images.
 167         This removes dependencies on libfuse and librt.  The wimmount,
 168         wimmountrw, and wimunmount commands will not work.
 169
 170         The default is --with-fuse when building for Linux, and --without-fuse
 171         otherwise.
 172
 173                                   PORTABILITY
 174
 175 wimlib works on both UNIX-like systems (Linux, Mac OS X, FreeBSD, etc.) and
 176 Windows (Vista and later).
 177
 178 As much code as possible is shared among all supported platforms, but there
 179 necessarily are some differences in what features are supported on each platform
 180 and how they are implemented.  Most notable is that file tree scanning and
 181 extraction are implemented separately for Windows, UNIX, and UNIX (NTFS-3G
 182 mode), to ensure a fast and feature-rich implementation of each platform/mode.
 183
 184 wimlib is mainly used on x86 and x86_64 CPUs, but it should also work on a
 185 number of other GCC-supported 32-bit or 64-bit architectures.  It has been
 186 tested on the ARM and MIPS architectures.
 187
 188 Currently, gcc and clang are the only supported compilers.  A few nonstandard
 189 extensions are used in the code.
 190
 191                                    REFERENCES
 192
 193 The WIM file format is partially specified in a document that can be found in
 194 the Microsoft Download Center.  However, this document really only provides an
 195 overview of the format and is not a formal specification.  It also does not
 196 cover later extensions of the format, such as solid resources.
 197
 198 With regards to the supported compression formats:
 199
 200 - Microsoft has official documentation for XPRESS that is of reasonable quality.
 201 - Microsoft has official documentation for LZX, but in two different documents,
 202   neither of which is completely applicable to its use in the WIM format, and
 203   the first of which contains multiple errors.
 204 - There does not seem to be any official documentation for LZMS, so my comments
 205   and code in src/lzms_decompress.c may in fact be the best documentation
 206   available for this particular compression format.
 207
 208 The algorithms used by wimlib's compression and decompression codecs are
 209 inspired by a variety of sources, including open source projects and computer
 210 science papers.
 211
 212 The code in ntfs-3g_apply.c and ntfs-3g_capture.c uses the NTFS-3G library,
 213 which is a library for reading and writing to NTFS filesystems (the filesystem
 214 used by recent versions of Windows).  See
 215 http://www.tuxera.com/community/open-source-ntfs-3g/ for more information.
 216
 217 A limited number of other free programs can handle some parts of the WIM
 218 file format:
 219
 220   * 7-Zip is able to extract and create WIMs (as well as files in many
 221     other archive formats).  However, wimlib is designed specifically to handle
 222     WIM files and provides features previously only available in Microsoft's
 223     implementation, such as the ability to mount WIMs read-write as well as
 224     read-only, the ability to create compressed WIMs, the correct handling of
 225     security descriptors and hard links, support for LZMS compression, and
 226     support for solid archives.
 227   * ImagePyX (https://github.com/maxpat78/ImagePyX) is a Python program that
 228     provides some capabilities of wimlib-imagex, with the help of external
 229     compression codecs.
 230
 231 If you are looking for an archive format that provides features similar to WIM
 232 but was designed primarily for UNIX, you may want to consider SquashFS
 233 (http://squashfs.sourceforge.net/).  However, you may find that wimlib works
 234 surprisingly well on UNIX.  It will store hard links and symbolic links, and it
 235 supports storing standard UNIX file permissions (owners, groups, and modes);
 236 special files such as device nodes and FIFOs; and extended attributes.
 237 Actually, I use it to back up my own files on Linux!
 238
 239                                     HISTORY
 240
 241 wimlib was originally a project started by Carl Thijssen for use on Linux in the
 242 Ultimate Deployment Appliance (http://www.ultimatedeployment.org/).  Since then
 243 the code has been entirely rewritten and improved (main author: Eric Biggers).
 244 Windows support has been available since version 1.3.0 (March 2013).  A list of
 245 version-to-version changes can be found in the NEWS file.
 246
 247                                     NOTICES
 248
 249 wimlib is free software that comes with NO WARRANTY, to the extent permitted by
 250 law.  See the COPYING file for more details.
 251
 252 Bug reports, suggestions, and other contributions are appreciated and may be
 253 posted to https://wimlib.net/forums/.
 254
 255 wimlib is independently developed and does not contain any code, data, or files
 256 copyrighted by Microsoft.  It is not known to be affected by any patents.
 257
 258 Note: copyright years may be listed using range notation, e.g., 2012-2016,
 259 indicating that every year in the range, inclusive, is a copyrightable year that
 260 would otherwise be listed individually.