2 Improved compression, decompression, and extraction performance.
4 Improved compatibility with version 3584 WIM / ESD files:
5 - Add support for reading and writing multiple solid blocks per
6 archive, which WIMGAPI/DISM can create when appending an image.
7 - Correctly create solid blocks larger than 4 GiB.
9 'add' commands passed to wimupdate will now replace existing
10 nondirectory files by default. Use the --no-replace option to get the
13 The license for the library now contains an exception that allows using
14 it under the LGPL. See the COPYING file for details.
16 In reparse-point fixup mode (the default for capture), symbolic links
17 and junctions that point outside the tree being captured are no longer
18 excluded from capture.
20 Added support for "WIMBoot" capture and extraction. See the
21 documentation for the new '--wimboot' option to wimcapture and wimapply
24 On UNIX-like systems, you can now backup and restore device nodes, named
25 pipes, and sockets. In addition, 32-bit user and group IDs are now
28 The way that UNIX data is stored in WIM files has been changed. If you
29 captured any WIMs with the --unix-data option, to upgrade them you'll
30 need to apply them with --unix-data using wimlib-imagex v1.6.2, then
31 re-capture them with --unix-data using this version.
33 wimlib now understands tagged metadata items, such as object IDs, that
34 can be stored in WIM directory entries.
36 Removed the --hardlink and --symlink options to wimapply, since I don't
37 think they are too useful and they got in the way of improving the code.
39 WIMs will now retain their GUIDs when rebuilt (e.g. with wimoptimize).
41 The 'mkwinpeimg' script now supports writing the ISO image to standard
44 The <ARCH> element in WIM XML data is now exported correctly.
46 On Windows, sparse file attributes are no longer set on extracted files.
47 Oddly enough, this actually saves disk space in some cases.
49 On UNIX, configuring with --disable-xattr or --enable-xattr is no longer
50 supported. Mounting WIM images now always requires extended attribute
51 support. Use --without-fuse to disable support for mounting WIM images;
52 this will also disable the need for extended attribute support.
54 Configuring with --enable-ssse3-sha1 now works correctly.
56 The shared library version has been bumped up. The main
57 incompatibilities are:
59 - WIMLIB_COMPRESSION_TYPE_XPRESS is now 1 and
60 WIMLIB_COMPRESSION_TYPE_LZX is now 2 (so it's the same as
63 - User-provided progress functions are now registered using a
64 separate function, wimlib_register_progress_function(). The
65 'progress_func' argument to many functions no longer exists.
67 - The return value from user-provided progress functions is now
70 - A context argument has been added to the prototype of
71 user-provided progress functions.
73 - 'struct wimlib_capture_config' has been removed. The library
74 now takes the path to the configuration file directly. This
75 affects wimlib_add_image(), wimlib_add_image_multisource(),
76 and wimlib_update_image(). However, a NULL value passed in
77 the argument retains the same meaning.
79 - Removed deprecated functions: some (de)compression functions,
80 wimlib_extract_files(), and wimlib_print_metadata().
82 - Removed extraction flags: WIMLIB_EXTRACT_FLAG_HARDLINK,
83 WIMLIB_EXTRACT_FLAG_SYMLINK, WIMLIB_EXTRACT_FLAG_FILE_ORDER,
84 and WIMLIB_EXTRACT_FLAG_SEQUENTIAL.
86 - Removed some progress messages:
87 WIMLIB_PROGRESS_MSG_APPLY_TIMESTAMPS,
88 WIMLIB_PROGRESS_MSG_EXTRACT_DIR_STRUCTURE_BEGIN,
89 WIMLIB_PROGRESS_MSG_EXTRACT_DIR_STRUCTURE_END. Numbering
92 - Removed some error codes. Numbering stays the same.
94 - Replaced WIMLIB_UNMOUNT_FLAG_LAZY with
95 WIMLIB_UNMOUNT_FLAG_FORCE.
97 - WIM paths passed to progress functions now have a leading
101 Case-insensitive comparisons of strings (e.g. filenames) containing
102 UTF-16 codepoints above 32767 are now done correctly.
104 Fixed build failure on Mac OS X.
106 wimunmount now provides the '--new-image' option to cause changes to a
107 read-write mounted image to be committed as a new image rather than as
108 an update of the mounted image. (The corresponding new library flag is
109 WIMLIB_UNMOUNT_FLAG_NEW_IMAGE.)
111 The LZMS ("recovery") compression chunk size, or "dictionary size", may
112 now be up to 1 GiB (1,073,741,824 bytes).
114 The performance of LZX ("maximum") and LZMS ("recovery") compression
115 with large chunk sizes has been slightly improved.
118 Stored files with size exactly 4 GiB (4,294,967,296 bytes) are now
119 decompressed correctly.
121 Fixed a bug in the LZX compressor introduced in v1.5.3. The bug
122 occurred in an unlikely case, and due to validity checks it did not
123 affect successfully created archives.
125 Fixed a minor compatibility issue with the LZMS compressor and
126 decompressor. This is *not* the default compression type and was only
127 introduced in v1.6.0. In the unlikely event that you created an
128 LZMS-compressed WIM with v1.6.0 and a checksum error is reported when
129 applying it with v1.6.1, decompress it with v1.6.0 then compress it with
132 Memory usage for LZMS and LZX compression has been decreased.
134 wimextract now allows wildcard characters in paths specified on the
135 command line. Also, the '--strict-wildcards' option has been removed
136 and replaced with the inverse option '--nullglob'. See the
137 documentation for wimextract for more details and changes.
139 The wimlib_extract_files() function is now considered deprecated in
140 favor of wimlib_extract_paths().
142 Fixed more permissions problems when extracting files on Windows.
144 A new '--no-attributes' option has been added to wimapply and
145 wimextract. The library flag is WIMLIB_EXTRACT_FLAG_NO_ATTRIBUTES.
147 The default chunk size is now set correctly when changing the
148 compression type of a WIM, for example with 'wimoptimize'.
150 The '--metadata' option to wiminfo has been replaced with the
151 '--detailed' option to wimdir.
153 In relevant wimlib-imagex commands, '--solid' may now be used as an
154 alias for '--pack-streams'.
157 Support for extracting and updating the new version 3584 WIMs has been
158 added. These WIMs typically pack many streams ("files") together into a
159 single compressed resource, thereby saving space. This degrades the
160 performance of random access (such as that which occurs on a mounted
161 image), but optimizations have been implemented for extraction. These
162 new WIM files also typically use a new compression format (LZMS), which
163 is similar to LZMA and can offer a better compression ratio than LZX.
164 These new WIM files can be created using `wimcapture' with
165 the '--compress=lzms --pack-streams' options. Note: this new WIM format
166 is used by the Windows 8 web downloader, but important segments of the
167 raw '.esd' files are encrypted, so wimlib will not be able to extract
168 such files until they are first decrypted.
170 wimlib now supports extracting files and directories from a WIM image
171 based on a "listfile" that itself contains the list of paths to extract.
172 For `wimextract', the syntax is to specify @LISTFILE instead of a PATH,
173 and for the library itself, the new APIs are wimlib_extract_pathlist()
174 and wimlib_extract_paths(). Path globs containing wildcard characters
177 For searching WIM files, wimlib now has configurable case sensitivity.
178 The default on Windows is still case-insensitive and the default on
179 UNIX-like systems is still case-sensitive, but this can be overridden
180 on either platform through flags to wimlib_global_init(). For
181 `wimlib-imagex', the environmental variable WIMLIB_IMAGEX_IGNORE_CASE
182 can be set to 1 or 0 for case-insensitive or case-sensitive behavior,
185 Support for compression chunk sizes greater than the default of 32768
186 bytes has been added. A larger chunk size typically results in a better
187 compression ratio. However, the MS implementation is seemingly not
188 compatible with all chunk sizes, especially for LZX compression, so the
189 defaults remain unchanged, with the exception of the new LZMS-compressed
190 WIMs, which use a larger chunk size by default.
192 The compression/decompression API exported by wimlib has been changed.
193 Now one set of functions handles all supported compression formats.
195 `wimcapture' and `wimappend' will now display the progress of scanning
196 the directory tree to capture, in addition to the progress of writing
197 data to the WIM. The '--verbose' option no longer does anything. The
198 library API change for this is the addition of several members to
199 `struct wimlib_progress_info_scan' available to progress callbacks.
201 `mkwinpeimg' now correctly handles the '--start-script' option when the
202 start script is not in the working directory.
204 Sequential extraction, previously requested by using
205 WIMLIB_EXTRACT_FLAG_SEQUENTIAL, is now the default.
206 WIMLIB_EXTRACT_FLAG_FILE_ORDER can be used to get the old default
207 behavior (extract in file order).
210 The new LZX compressor added in v1.5.2 has been improved and is now
211 enabled by default, except when `wimcapture' or `wimappend' is run
212 *without* the '--compress' option, in which case the faster LZX
213 compressor is used (the same as before). This behavior is reasonably
214 consistent with ImageX which actually uses "fast" (XPRESS) compression
215 by default. In those cases, use '--compress=maximum' to explicitly
216 capture a WIM image using the new (slower but better) LZX compressor.
218 The '--compress-slow' option still exists to `wimlib-imagex optimize',
219 but its new behavior is to tweak the new LZX compressor even more to
220 produce an even better compression ratio at the cost of more time spent
223 `wimlib-imagex optimize' now supports the '--compress=TYPE' option,
224 which recompresses the WIM file using the specified compression TYPE.
225 The new library API function used for this is
226 wimlib_set_output_compression_type().
228 Added the wimlib_get_xml_data() function to allow library clients to
229 easily retrieve the raw XML data from a WIM file if needed.
231 Fixed a bug that could cause an error code to be incorrectly returned
232 when writing XML data containing a <WINDOWS> element.
234 Mounted WIM images will now correctly show the default file stream even
235 if appears in the alternate data stream entries of the corresponding WIM
239 Added a new experimental LZX compressor which can be enabled by passing
240 '--compress-slow' to `wimlib-imagex capture' or `wimlib-imagex
241 optimize'. (The latter is only applicable if the WIM is already
242 LZX-compressed and the '--recompress' option is also given.) The
243 experimental compressor is much slower but compresses the data slightly
244 more --- currently usually to within a fraction of a percent of the
245 results from WIMGAPI/ImageX.
247 A workaround has been added for compatibility with versions of WinPE
248 that interpret alternate data stream entries in the boot WIM
251 An alignment bug that caused a crash in the LZX decompressor on some
254 wimlib now attempts to clear the WIM_HDR_FLAG_WRITE_IN_PROGRESS flag in
255 the WIM header when restoring the previous state of a WIM it failed to
258 Added a workaround to avoid an access denied error on Windows when
259 replacing a WIM file that another process has opened.
262 wimlib can now open WinPE WIMs from WAIK v2.1, which had a quirk that
263 needed to be handled.
265 A bug in the interpretation of negative IMAGE indices in the
266 --update-of=[WIMFILE:]IMAGE option to `wimlib-imagex capture' and
267 `wimlib-imagex append' has been fixed.
269 A workaround has been added to successfully apply security descriptors
270 with empty DACLs when the NTFS-3g apply mode is being used with NTFS-3g
271 2013.1.13 or earlier.
273 `wimlib-imagex capture' can now accept the '--delta-from' option
277 Added support for "pipable" WIMs. Pipable WIMs allow capturing images
278 to standard output and applying images from standard input, but they are
279 not compatible with Microsoft's software and are not created by default.
280 See the documentation for --pipable flag of `wimlib-imagex capture' for
283 To better support incremental backups, added support for declaring an
284 image as a modified form of another image. See the documentation for
285 the '--update-of' option of `wimlib-imagex append' and `wimlib-imagex
288 Added supported for "delta" WIMs. See the documentation for the
289 '--delta-from' option of `wimlib-imagex capture'.
291 The library support for managing split WIMs has been changed to support
292 other arrangements, such as delta WIMs, and be easier to use. This
293 change is visible in `wimlib-imagex', which also can now accept the
294 '--ref' option multiple times, and also now supports "delta" WIMs as
297 wimlib now preserves WIM integrity tables by default, even if
298 WIMLIB_WRITE_FLAG_CHECK_INTEGRITY is not specified. This changes the
299 behavior of `wimlib-imagex' whenever the WIM being operated on contains
300 an integrity table and the '--check' option is not specified.
302 `wimlib-imagex capture' now creates LZX-compressed WIMs by default
303 (when --compress is not specified). This provides the best compression
304 ratio by default, which is usually what is desired, at a cost of some
307 `wimlib-imagex' now supports being invoked as wimCOMMAND, where COMMAND
308 is the command as in `wimlib-imagex COMMAND'; for example, it can be
309 invoked as `wimapply' as an alternative to `wimlib-imagex apply'. The
310 appropriate hard links are created in UNIX installations of
311 `wimlib-imagex', while for the Windows distribution of `wimlib-imagex',
312 batch files that emulate this behavior are generated.
314 Security descriptors are now extracted correctly on Windows.
316 Fixed archiving DOS names in NTFS-3g capture mode.
318 The extraction code has been rewritten and it will now be easier to
319 support new features on all supported backends (currently Win32, UNIX,
320 and NTFS-3g). For example, hard-linked extraction mode (--hardlink) is
321 now supported on all backends, not just UNIX.
323 `mkwinpeimg' now supports grabbing files from the WAIK supplement rather
324 than the WAIK itself.
326 wimlib_global_init() now, by default, attempts to acquire additional
327 privileges on Windows, so library clients need not do this.
329 This update bumps the shared library version number up to 9, since it is
330 not binary compatibible with previous releases.
333 Fixed bug in `wimlib-imagex export' that made it impossible to export an
334 image from a WIM that is readonly at the filesystem level.
336 Return error code rather than segfaulting when trying to list files from
337 a non-first part of a split WIM.
339 Joining a WIM will now preserve the RP_FIX and READONLY flags.
342 On Windows, paths given to wimlib-imagex are now treated case
345 Improved behavior regarding invalid filenames; in particular, on
346 Windows, wimlib-imagex will, when extracting, now omit (with an option
347 to override this default) filenames differing only in case, or filenames
348 containing characters not valid on Windows.
350 On Windows, wimlib now supports capturing and extracting long paths
351 (longer than the so-called MAX_PATH).
353 On Windows, `wimlib-imagex update' now acquires proper privileges when
354 running as an Administrator.
356 `wimlib-imagex update' will now complain if no image is specified when
357 trying to update a multi-image WIM.
359 `wimlib-imagex update' now supports specifying a single update command
360 directly on the command line using the --command option.
362 wimlib-imagex will now choose different units for progress messages,
363 depending on the amount of data that needs to be processed.
365 `wimlib-imagex append' will now generate a unique WIM image name if no
366 name is specified and the defaulted name already exists in the WIM.
368 wimlib now allows you to create unnamed WIM images, which can then only
369 be referred to by index.
371 wimlib now allows you to explicitly declare you want write access to a
372 WIM by providing the WIMLIB_OPEN_FLAG_WRITE_ACCESS flag to
375 wimlib now respects the WIM_HDR_FLAG_READONLY flag when set in the WIM
378 Progress callbacks have been added to wimlib's wimlib_update_image()
381 Added wimlib_get_wim_info(), wimlib_set_wim_info(),
382 wimlib_iterate_dir_tree(), and wimlib_iterate_lookup_table() functions
385 NTFS-3g capture now only warns about two conditions previously treated
388 Fixed a couple issues with using wimlib-imagex on UDF filesystems on
391 wimlib now correctly detects and returns an error when reading a WIM
392 image with a cyclic directory structure. (Fun fact: such a WIM will
393 crash Microsoft's software.)
396 Added new "extract" and "update" subcommands to wimlib-imagex, along
397 with associated APIs in the library. These commands are intended mainly
398 for Windows use but can be used on UNIX as well.
400 Many documentation improvements.
402 Fixed a bug in the Windows build where relative symbolic links were not
403 captured in reparse-point fixup mode.
405 Fixed a bug in the Windows build where file handles were left open to
406 the WIM file, causing `wimlib_imagex optimize' to fail in some cases.
408 Fixed a bug in the Windows build of wimlib-imagex where globbing
409 split-WIM parts could cause the program to crash.
411 Fixed a bug where the creation time of WIM images would be shown instead
412 of the last modification time.
414 With the Windows build it is now possible to restore a WIM containing
415 symbolic links as a non-Administrator; however you will receive warnings
416 about not being able to extract the symbolic links.
419 Capturing a WIM image should now be significantly faster in most cases
420 due to improved use of the operating system's cache and avoiding reading
421 files twice whenever possible.
423 The Windows build should now work on Windows XP.
425 The Windows build now supports capturing and restoring hidden,
426 compressed, sparse, and encrypted files.
428 The Windows build now supports capturing and applying WIM images from
429 filesystems other than NTFS (with some reduced functionality).
431 The Windows build now extracts short names correctly.
433 Added support for "reparse-point" fixups (i.e. fixing up of symbolic
434 links). See docs for --rpfix and --norpfix flags of `wimlib-imagex
435 capture' and `wimlib-imagex apply'.
437 The performance of splitting and joining WIMs should be slightly
440 The LZX and XPRESS compression and decompression functions are now
441 exported from the library.
444 Improvements and bugfixes for the Windows build.
446 Added --strict-acls options.
448 Fixed the way that wimlib determines the order of images in the WIM.
451 Since wimlib can now be used on Windows, wimlib's implementation of
452 ImageX has been renamed to wimlib-imagex to avoid confusion with
453 Microsoft's implementation of ImageX, which would have the same file
454 name ("imagex.exe"). If you really don't like this you can pass the
455 --with-imagex-progname option to `configure' to choose a different name,
456 or even simply rename the binary yourself (but the former way will
457 configure the man pages to use the chosen name).
459 Various bugs fixed in the Windows build. Mainly to do with capturing
460 and restoring alternate data streams correctly in weird cases, and
461 requesting the correct privileges when opening files. Also added the
462 --noacls options to wimlib-imagex capture, append, and apply.
464 Windows build again: FindFirstStreamW() and FindNextStreamW() are now
465 dynamically loaded, so this may make the library compatible with Windows
466 XP (however, there may still be other problems).
469 Added experimental support for native Windows builds. Binaries can be
470 downloaded from the SourceForge page.
472 --source-list option added to `imagex capture' and `imagex append'.
474 Better support for different character encodings.
477 Storing UNIX file owners, groups, and modes in WIM images is now
478 possible using `imagex capture' with the --unix-data flag.
480 Minor bug fixes and documentation fixes.
483 NTFS capture: Fixed capturing duplicate reparse points.
485 NTFS capture: Capture first unnamed stream if there are more than one
486 (print warning instead of error).
488 Allow multiple test cases to execute concurrently (e.g. make -j2 check).
491 Added --arch switch to mkwinpeimg script to support getting AMD64 WinPE
494 Update to work with ntfs-3g version 2013.1.13.
497 Fixed truncating file to shorter but non-zero length on read-write
500 Various code cleanups and minor documentation fixes.
503 LZX and XPRESS decompression have received some additional optimizations
504 and should now be even faster. (Although, they were already pretty
505 fast--- much faster than typical I/O speeds.)
507 Fixed a bug introduced in v1.2.1 that would cause a directory tree
508 containing hard links to be captured incorrectly in some cases.
511 By default, unmounting a read-write mounted WIM with 'imagex unmount
512 --commit' will now change the WIM in-place without needing to write the
513 entire WIM again. Use 'imagex unmount --commit --rebuild' to get the
516 'imagex unmount' no longer has a hard-coded limit of 10 minutes to wait
517 for a response from the daemon servicing the mounted WIM. Instead,
518 every second 'imagex unmount' will check if the daemon is still alive,
519 and keep waiting if so, otherwise terminate with an error.
521 'imagex unmount --commit' on a read-write mounted WIM will now print
522 progress information regarding the writing of new or modified streams
523 the WIM, just like when capturing or appending a WIM.
525 A small change has been made to XPRESS compression and it should improve
526 the compression ratio slightly.
528 A change was made that may improve performance slightly when applying a
529 WIM image to a NTFS volume.
531 Microsoft has managed to introduce even more bugs into their software,
532 and now the WIMs for Windows 8 have incorrect (too low) reference counts
533 for some streams. This is unsafe because such streams can be removed
534 when they are in actuality still referenced in the WIM (perhaps by a
535 different image). wimlib will now work around this problem by fixing
536 the stream reference counts. This is only done when wimlib_delete_image() is
537 called ('imagex delete') or when wimlib_mount_image() is called with
538 WIMLIB_MOUNT_FLAG_READWRITE ('imagex mountrw'). Please note that this
539 requires reading the metadata for all images in the WIM, so this will
540 make these operations noticably slower on WIMs with multiple images.
542 Various other bugfixes.
545 Appending images to a WIM is now be done by default without re-building
546 the whole WIM. Use the --rebuild flag to get the old behavior (which
547 was to re-build the entire WIM when a new image is appended).
549 A new command `imagex optimize' is now available to manually re-build a
550 WIM that has wasted space due to repeated appends.
552 Progress information has been improved, and now arbitrary callback
553 functions can be used to show the progress of a WIM operation.
555 A possible bug with changing the bootable image of a WIM was fixed.
557 Some advisory locking is now done to prevent two processes from
558 modifying a WIM at the same time (but only in some cases). For example,
559 you cannot mount two images from a WIM read-write at the same time.
561 Some functions have been reorganized:
562 * wimlib_mount() renamed to wimlib_mount_image().
563 * wimlib_unmount() renamed to wimlib_unmount_image().
564 * wimlib_overwrite_xml_and_header() removed as
565 wimlib_overwrite() suffices now.
566 * wimlib_apply_image_to_ntfs_volume() removed as
567 wimlib_extract_image() suffices now.
568 * wimlib_add_image_from_ntfs_volume() removed as
569 * wimlib_add_image() suffices now.
571 Previously, the soname of libwim.so has been 0.0.0, despite many
572 interface changes. The soname is now updated to 1.0.0 and will now be
573 updated each release.
576 Resources will now be compressed using multiple threads by default.
577 (This applies to `imagex capture', `imagex append', and `imagex
580 Some performance improvements in mounted WIMs.
582 More progress information is shown when capturing a WIM.
585 Lots of minor fixes, code cleanups, and some documentation updates.
586 Nothing in particular is really noteworthy.
589 LZX and XPRESS compression improvements.
591 Fixed calculation of Directory Count, File Count, Total Bytes, and Hard
592 Link Bytes of the WIM.
595 Fixed bug when capturing NTFS file with multiple named data streams.
597 Internally, we are now using inode structures, even though these don't
598 appear literally in the WIM file. This simplifies some of the code
599 (mainly for WIM mounting) and likely fixed a few problems, although it
603 Fixed problem when exporting images from XPRESS to LZX compressed WIM or
607 Enough changes to call it version 1.0.0!
609 Capturing a WIM directly from a NTFS volume, and applying a WIM directly
610 to a NTFS volume, is now supported.
612 Hard links and symbolic links have much improved support. They are
613 supported for WIM capture, WIM application, and mounted WIMs (you can
614 even make them on read-write mounted WIMs).
616 Alternate data streams are now supported on mounted WIMs through an
617 xattr or a Windows-style stream interface. Also they are supported when
618 capturing a WIM from NTFS or applying a WIM to NTFS.
620 Split WIMs are better supported. You may now apply an image directly
621 from a split WIM, mount an image from a split WIM read-only, or export
622 an image from a split WIM.
624 Using a capture configuration file is now supported (but not fully yet).
626 SHA1 message digests are checked in more places, so we can make sure
627 applied and captured data is correct.
629 Man pages have been updated and consolidated.
632 Fixed segfault when unmounting read-only WIM.
635 Support for joining and splitting WIMs.
636 Also, security data is now preserved by default.
639 Can now build with older gcc and system headers, like on CentOS 5.
642 Fixed bug that made it impossible to overwrite files in read-write
646 Write byte-order mark before WIM XML data. (imagex.exe requires this to