2 Removed libxml2 and libcrypto (OpenSSL) as dependencies of wimlib.
3 Also removed winpthreads as a dependency of wimlib on Windows.
5 Improved the performance of the Windows binaries on CPUs that have SHA-1
8 Fixed a bug in 'wimsplit' where it didn't accept part sizes of 4 GiB or
9 larger on Windows and on 32-bit platforms.
11 The README.WINDOWS file and the tools/windows-build.sh script (renamed
12 from 'make-windows-release') have been improved to make it easier to
13 build wimlib on Windows. The instructions now use MSYS2 (instead of
14 Cygwin as they did before), and both gcc and clang are supported.
15 Windows ARM64 builds are now supported (experimentally) as well.
17 Removed support for Windows XP.
20 wimsplit no longer prints a success message on failure.
22 wimlib_iterate_dir_tree() no longer hashes files that haven't yet been
23 written to the WIM file.
25 Reduced the maximum number of file descriptors that wimlib can use when
26 extracting files from a WIM image on macOS.
28 The files that used the CC0 public domain dedication now use the MIT
31 Removed some configuration options (--disable-assertions,
32 --disable-error-messages, and --disable-multithreaded-compression)
33 that probably weren't being used by anyone.
36 Exporting "all" images from a WIM file no longer fails if multiple
37 images in that WIM file have the same name.
39 wimlib now warns rather than aborts if two files have the same SHA-1
40 hash but different sizes.
42 Fixed build errors with the latest version of Mingw-w64.
45 wimsplit now prints progress messages regularly rather than just once
48 Added support for a data recovery mode which causes files to be
49 extracted even if they are corrupted. The option is --recover-data for
50 wimapply and wimextract, and WIMLIB_EXTRACT_FLAG_RECOVER_DATA for the
51 library. Note that this option won't help with all types of corruption;
52 some types of corruption will still cause a fatal error.
55 On Windows, improved performance of capturing an entire drive in some
58 On Windows, fixed leaking a directory handle (or triggering a SEH
59 exception when running under a debugger) when referencing WIM files.
61 On Windows, when applying a Windows OS image using the --compact flag,
62 bootloader files can now be compressed with stronger compression
63 algorithms if the version of Windows is recent enough to support it.
65 Clarified the license text.
68 Prevented miscompilation with gcc 10 at -O3
69 (https://gcc.gnu.org/bugzilla/show_bug.cgi?id=94994).
71 Avoided some compiler warnings with gcc 9 and later.
73 The 'mkwinpeimg' script now also looks for syslinux modules in
74 /usr/share/syslinux, to handle where openSUSE installs them.
76 Removed obsolete packaging files from the source tree.
79 Fixed a crash or incorrect output during LZMS compression with a
80 compression level greater than 50 and a chunk size greater than 64 MiB.
81 This affected wimlib v1.8.0 and later. In the unlikely event that you
82 used all these non-default compression settings in combination, e.g.
83 'wimcapture --solid --solid-compress=LZMS:100 --solid-chunk-size=128M',
84 run 'wimverify' on your archives to verify your data is intact.
87 On Windows, wimlib now supports capturing and applying extended
88 attributes (EAs). It is compatible with DISM with the /EA option,
89 available since Windows 10 version 1607. wimlib's EA support is on by
90 default and works on older versions of Windows too.
92 Partially fixed a bug where [ExclusionException] entries didn't take
93 effect when the containing directory is matched by [ExclusionList]. It
94 now works when the [ExclusionException] patterns are absolute. For
95 example, listing "/dir/file" in [ExclusionException] now works even if
96 "/dir" is matched by [ExclusionList].
98 Added a '--create' option to 'wimappend' which makes it create the WIM
99 file (like 'wimcapture') if it doesn't exist yet.
101 Added an '--include-integrity' option to various wimlib-imagex commands.
102 '--include-integrity' is like '--check', but it will just include an
103 integrity table in the output WIM(s), while skipping verification of any
104 existing integrity tables. This can be useful to avoid unwanted
105 verification of large WIM files, e.g. WIMs given by '--delta-from'.
107 'wimextract' now reads a pathlist file from standard input when "@-" is
108 given as an argument.
110 wimsplit (API: wimlib_split()) now correctly handles a dot in the path
111 to the first split WIM part, prior to the filename extension.
113 'wimlib-imagex --version' now shows the version of the library it is
114 actually using (in case it is different from wimlib-imagex's version).
117 Fixed a bug that was causing the LZMS decompressor to be miscompiled
118 with GCC 7 (this broke extracting "solid" archives).
120 The Windows 10 Recycle Bin directory (\$RECYCLE.BIN) has been added to
121 the default exclusion list.
123 Added a '--quiet' option to wimlib-imagex.
125 The 'mkwinpeimg' script now also looks for the syslinux BIOS modules in
126 the directory /usr/lib/syslinux/modules/bios.
128 Files with timestamps before the year 1970 are now extracted correctly
129 to UNIX-style filesystems, are displayed correctly by
130 'wimdir --detailed', and show up correctly in mounted WIM images.
132 Files with timestamps after the year 2038 are now displayed correctly by
133 the 32-bit Windows build of wimlib.
136 Fixed a data corruption bug (incorrect compression) when storing an
137 already highly-compressed file in an LZX-compressed WIM with a chunk
138 size greater than or equal to 64K. Note that this is not the default
139 setting and such WIMs are not supported by Microsoft's WIM software, so
140 only users who used the --chunk-size option to wimlib-imagex or the
141 wimlib_set_output_chunk_size() API function may have been affected.
142 This bug was introduced in wimlib v1.10.0. See
143 https://wimlib.net/forums/viewtopic.php?f=1&t=300 for more details.
145 On all platforms, sparse files are now extracted as sparse.
147 Sparse files captured from UNIX-style filesystems are now marked as
148 sparse in the resulting WIM image.
150 Added support for storing Linux-style extended attributes in WIM images.
151 When the --unix-data option is used on Linux, wimlib-imagex now captures
152 and applies extended attributes, in addition to the already-supported
153 standard UNIX file permissions (owner/group/mode) and special files.
155 --delta-from is now supported by wimappend. (Previously it was only
156 supported by wimcapture.)
158 On Windows, improved the way in which files deduplicated with Windows'
159 Data Deduplication feature are captured.
161 The development files needed to link with wimlib using Visual Studio are
162 now included in the Windows release archives.
164 wimlib.h can now be included by Visual Studio without errors.
166 The example programs can now be compiled in C++ mode, and they also now
169 Updated 'mkwinpeimg' to work correctly on images that have a "windows"
170 (lower case) directory rather than a "Windows" (upper case) directory.
172 Fixed configuring with --enable-ssse3-sha1 from release tarball
173 (the file nasm_lt.sh was missing).
175 Made some documentation improvements.
178 The LZX compression ratio has been slightly improved. The default mode,
179 LZX level 50, is now almost as good as the old LZX level 100, while
180 being nearly the same speed as before.
182 Decompression performance has been slightly improved.
184 Filenames are now always listed in NTFS collation order.
186 On UNIX-like systems, wimlib can now process Windows filenames that are
187 not valid Unicode due to the presence of unpaired surrogates.
189 On UNIX-like systems, wimlib now always assumes UTF-8 encoding with the
190 addition of surrogate codepoints. Consequently, the environmental
191 variable WIMLIB_IMAGEX_USE_UTF8 and the flag
192 WIMLIB_INIT_FLAG_ASSUME_UTF8 no longer have any effect.
194 wimlib no longer depends on iconv.
196 Reduced memory usage slightly.
198 When a WIM image is applied in NTFS-3G mode, security descriptors are
199 now created in NTFS v3.0 format when supported by the volume.
201 Workarounds for bugs in libntfs-3g version 2013.1.13 and earlier have
202 been removed. Users are advised to upgrade to a later version of
205 On Windows, wimlib now supports case-sensitive filename extraction when
206 supported by the underlying operating system and filesystem (operating
207 system support requires a registry setting).
210 On UNIX, wimlib can now overwrite readonly files when extracting.
212 On Windows, fixed a bug where wimlib could leave a null DACL (a.k.a. "no
213 NTFS permissions") set on some existing directories after extraction.
215 On Windows, when applying a WIM image in "WIMBoot mode" when the WOF
216 driver is not loaded, wimlib can now correctly register a new WIM file
217 with the target volume when the target volume previously had had WIM
220 Added a new testing program.
222 Clarified the main license text and updated public domain dedications
223 for certain files to be more thorough.
226 Object IDs are now saved and restored on Windows and in NTFS-3G mode.
228 Reduced memory usage when exporting large numbers of WIM images.
230 Non UTF-8 locales are now detected correctly.
232 Addressed compiler warnings and enabled "silent" make rules by default.
234 Windows-specific updates:
235 Fixed a bug where duplicate backslashes could be generated in
236 link targets when extracting symbolic links and junctions.
238 Fixed a bug where the .cmd shortcuts for wimlib-imagex wouldn't
239 work if their full path contained a space.
241 Fixed bugs related to scanning SMB filesystems.
243 Added warning message about known issue with WindowsApps folder.
245 Added instructions for building from source on Windows.
247 VSS support is no longer marked "experimental".
249 Added missing license file for libdivsufsort-lite.
252 Added experimental support for Windows VSS (Volume Shadow Copy Service).
253 The new '--snapshot' argument to 'wimcapture' makes wimlib automatically
254 create and use a temporary VSS snapshot when capturing a WIM image.
256 Implemented setting of Windows-specific XML information, such as
257 architecture, system root, and version details. This information is now
258 automatically set in newly captured WIM images, when appropriate.
260 Improved performance of directory tree scans on Windows.
262 On Windows, to improve capture performance, wimlib now sometimes opens
263 files by inode number rather than by path. This is enabled for
264 wimcapture and wimappend, but for now other applications have to opt-in.
266 The progress messages printed by wimlib-imagex while writing WIM files
267 have been slightly tweaked.
269 Progress information for directory tree scans now counts all hard links.
270 Also, on Windows "\\?\" is no longer stripped from the current path.
272 Added a new '--image-property' option to 'wimcapture', 'wimappend', and
273 'wiminfo'. This option lets you assign values to elements in a WIM
274 file's XML document by name.
276 The wimlib_get_image_property() and wimlib_set_image_property() API
277 functions now support numerically indexed elements.
279 Fixed a bug where, on Windows, wimlib would change the security
280 descriptor of the target directory of an extraction even when the
281 '--no-acls' option was specified.
284 Fixed a bug with libntfs-3g extraction present since v1.8.1. Sometimes,
285 some Microsoft software would not correctly recognize data in the
286 resulting filesystem.
288 Made some small improvements to the compression algorithms:
289 LZX compression ratio was slightly improved.
290 XPRESS compression ratio and speed was slightly improved.
291 LZMS compression speed was slightly improved.
293 Improved handling of WIM XML data. wimlib no longer drops unrecognized
294 elements when exporting images. In addition, two API functions were
295 added for better access to elements in the XML document:
296 wimlib_get_image_property() and wimlib_set_image_property().
298 Added support for (unsafe) in-place compaction of WIM files.
300 Improved performance of image export by reusing metadata resources
301 instead of always rebuilding and recompressing them.
303 Improved performance of wimlib_update_image() by delaying the update to
304 the WIM's XML document until a write is requested.
306 On Windows, the target of an extraction may now be a reparse point
307 (which will be dereferenced).
309 On Windows, wimlib now correctly restores non-Microsoft reparse points.
310 However, this remains broken in NTFS-3g mode due to a libntfs-3g bug.
312 On Windows, wimlib now has improved performance when archiving files
313 from a filesystem backed by a WIM (a "WIMBoot" setup).
315 Several improvements to System Compression (compact mode) support:
317 wof.sys (or wofadk.sys) is now automatically attached to the
318 target volume if needed.
320 Compact-mode extractions now work correctly with wofadk.sys on
321 older versions of Windows.
323 For compatibility with the Windows bootloader, the requested
324 compression format now is overridden on certain files.
326 Other minor bugfixes.
329 This release primarily contains various minor bug fixes and
330 improvements, including:
332 Improved handling of deep directory structures.
334 Fixed a bug where on 32-bit systems, the library could enter an
335 infinite loop if a WIM file was malformed in a specific way.
337 Added a workaround for a case where libntfs-3g may report
338 duplicate streams in an NTFS file.
340 Windows symbolic links and junctions in mounted WIM images are
341 now automatically rewritten to be valid in the mounted location.
343 Reparse point fixes: correctly handle the "ReparseReserved"
344 field, and correctly handle "empty" (data-less) reparse points.
346 On Windows, wimlib now acquires SeManageVolumePrivilege, which
347 is needed to create externally backed files using the
350 Improved validation of filenames.
352 Improved LZMS decompression speed.
354 The configure script now honors alternate pkg-config settings.
356 Links have been updated to point to the new website.
358 In addition, experimental support has been added for compressing
359 extracted files using System Compression on Windows 10. This
360 functionality is available through the new '--compact' option to
361 'wimapply' and 'wimextract' as well as new library flags.
364 Fixed a bug in the LZX decompressor: malicious input data could cause
365 out of bounds writes to memory (since wimlib v1.2.2).
367 The output of the 'wiminfo' command now consolidates various boolean
368 flags (such as "Relative path junction") into a single line.
370 A file can now have both an unnamed data stream ("file contents") and a
371 reparse point stream. Such files can exist as a result of the use of
372 certain Windows features, such as offline storage, including "OneDrive".
373 wimlib will now store and restore both streams on Windows as well as in
374 NTFS-3g mode. Microsoft's WIMGAPI also has this behavior.
376 On Windows, named data streams of encrypted files are no longer stored
377 twice in WIM archives.
379 On Windows, named data streams are now correctly extracted to existing
380 "readonly" directories. Before, an error would be reported.
382 On Windows, it is now possible to do a "WIMBoot mode" extraction with
383 non-standalone WIMs such as delta WIMs.
385 On Windows, when doing an extraction in "WIMBoot mode", files larger
386 than 4 gigabytes are now never extracted as externally backed. This
387 works around a bug in Microsoft's "WOF" driver.
389 The '--enable-verify-compression' configure option has been removed. If
390 you want to verify a WIM file, use the 'wimverify' program.
392 The way the "file count", "directory count", "total bytes", and "hard
393 link bytes" image statistics (stored in the WIM XML data) is calculated
394 has been slightly changed.
396 In mounted WIM images, the disk usage provided for each file (st_blocks)
397 is now the compressed size rather than the uncompressed size.
399 The performance of the NTFS-3g and Windows capture modes has been
402 On UNIX-like systems, symbolic links whose targets contain the backslash
403 character are now handled correctly (losslessly).
406 Improved the LZX compressor. It is now 15-20% faster than before and
407 provides a slightly better compression ratio.
409 Improved the LZMS compressor. It now provides a compression ratio
410 slightly better than WIMGAPI while still being faster and using slightly
413 The compression chunk size in solid resources, e.g. when capturing or
414 exporting a WIM file using the '--solid' option, now defaults to 64 MiB
415 (67108864 bytes) instead of 32 MiB (33554432 bytes). This provides a
416 better compression ratio and is the same value that WIMGAPI uses. The
417 memory usage is less than 50% higher than wimlib v1.7.4 and is slightly
418 lower than WIMGAPI's memory usage, but if it is too much, it is still
419 possible to choose a lower value, e.g. with the '--solid-chunk-size'
420 option to wimlib-imagex.
422 The '--chunk-size' and '--solid-chunk-size' options to wimlib-imagex now
423 accept the 'K', 'M', and 'G' suffixes.
425 Files are now sorted by name extension when creating a solid WIM file.
427 Fixed various issues related to capture/apply of EFS-encrypted files on
430 The file list printed by 'wimdir' is now sorted by the platform-specific
431 case sensitivity setting, rather than always case sensitively. This
432 also affects the library function wimlib_iterate_dir_tree().
434 On Windows, some error and warning messages have been improved.
437 The Windows binary distribution no longer contains third party DLLs.
438 These dependencies are instead compiled directly into the libwim DLL.
440 Added more fixes for wimlib on non-x86 architectures such as ARM.
442 Extracting files to a Windows PE in-memory filesystem no longer fails if
443 the target files do not yet exist.
445 Improved the performance of XPRESS compression and LZMS decompression.
447 Enabled SSSE3 accelerated SHA-1 computation in x86_64 Windows builds.
448 It will automatically be faster on newer Intel and AMD processors.
450 Removed the --with-imagex-progname and --enable-more-assertions
454 Fix for very slow export from solid WIM / ESD files.
456 Fix for LZX and LZMS algorithms on non-x86 architectures, such as ARM.
458 New progress message: WIMLIB_PROGRESS_MSG_HANDLE_ERROR. Applications
459 may use this to treat some types of errors as non-fatal.
461 The library now permits making in-memory changes to a WIMStruct backed
462 by a read-only WIM file.
464 Fixes for "WIMBoot" extraction mode (Windows only):
466 When not using the WOF driver, extraction no longer fails if the
467 disk containing the WIM file has too many partitions.
469 When matching patterns in [PrepopulateList], all hard links of
470 each file are now considered.
472 The system registry files are now automatically treated as being
473 in [PrepopulateList].
475 Added a hack to try to work around an intermittent bug in
476 Microsoft's WOF (Windows Overlay Filesystem) driver.
479 Made more improvements to the XPRESS, LZX, and LZMS compressors.
481 A number of improvements to the Windows port:
483 Fixes for setting short filenames.
485 Faster "WIMBoot" extraction.
487 Updated and slimmed down the dependent DLLs.
489 ACL inheritence bits are now restored.
491 Mandatory integrity labels are now backed up and restored.
493 Added a workaround for an issue where in rare cases, wimlib could create
494 a compressed data stream that could not be read correctly by Windows
495 after an extraction in "WIMBoot" mode.
498 Added file count progress data for
499 WIMLIB_PROGRESS_MSG_EXTRACT_FILE_STRUCTURE and
500 WIMLIB_PROGRESS_MSG_EXTRACT_METADATA.
502 Added support for testing file exclusions via the user-provided
505 Some documentation improvements.
507 Made some clarifications to the license text in the COPYING file.
510 Made more improvements to the XPRESS, LZX, and LZMS compressors.
512 The default compression mode for wimcapture is now LZX compression in
513 its default mode, which is the same as '--compress=maximum'.
515 You can now specify an optional integer compression level to the
516 '--compress' option; e.g. '--compress=lzx:75'.
518 Made a minor change to the LZMS compressor and decompressor to fix an
519 incompatibility with the Microsoft implementation. In the unlikely
520 event that you created an LZMS-compressed WIM with wimlib v1.7.0 or
521 earlier and a checksum error is reported when extracting files from it
522 with wimlib v1.7.1, decompress it with v1.7.0 then compress it with
525 Added 'verify' subcommand to wimlib-imagex.
527 Notable library changes:
529 Custom compressor parameters have been removed from the library
530 in favor of the simpler level-based API.
532 Decompressor parameters have been removed entirely.
534 Library users can now specify a custom file for warning and
535 error messages to be sent to, rather than the default of
538 New progress messages:
539 WIMLIB_PROGRESS_MSG_EXTRACT_FILE_STRUCTURE,
540 WIMLIB_PROGRESS_MSG_EXTRACT_METADATA.
542 New function: wimlib_verify_wim().
545 Improved compression, decompression, and extraction performance.
547 Improved compatibility with version 3584 WIM / ESD files:
548 - Add support for reading and writing multiple solid blocks per
549 archive, which WIMGAPI/DISM can create when appending an image.
550 - Correctly create solid blocks larger than 4 GiB.
552 'add' commands passed to wimupdate will now replace existing
553 nondirectory files by default. Use the --no-replace option to get the
556 The license for the library now contains an exception that allows using
557 it under the LGPL. See the COPYING file for details.
559 In reparse-point fixup mode (the default for capture), symbolic links
560 and junctions that point outside the tree being captured are no longer
561 excluded from capture.
563 Added support for "WIMBoot" capture and extraction. See the
564 documentation for the new '--wimboot' option to wimcapture and wimapply
565 for more information.
567 On UNIX-like systems, you can now backup and restore device nodes, named
568 pipes, and sockets. In addition, 32-bit user and group IDs are now
571 The way that UNIX data is stored in WIM files has been changed. If you
572 captured any WIMs with the --unix-data option, to upgrade them you'll
573 need to apply them with --unix-data using wimlib-imagex v1.6.2, then
574 re-capture them with --unix-data using this version.
576 wimlib now understands tagged metadata items, such as object IDs, that
577 can be stored in WIM directory entries.
579 Removed the --hardlink and --symlink options to wimapply, since I don't
580 think they are too useful and they got in the way of improving the code.
582 WIMs will now retain their GUIDs when rebuilt (e.g. with wimoptimize).
584 The 'mkwinpeimg' script now supports writing the ISO image to standard
587 The <ARCH> element in WIM XML data is now exported correctly.
589 On Windows, sparse file attributes are no longer set on extracted files.
590 Oddly enough, this actually saves disk space in some cases.
592 On UNIX, configuring with --disable-xattr or --enable-xattr is no longer
593 supported. Mounting WIM images now always requires extended attribute
594 support. Use --without-fuse to disable support for mounting WIM images;
595 this will also disable the need for extended attribute support.
597 Configuring with --enable-ssse3-sha1 now works correctly.
599 The shared library version has been bumped up. The main
600 incompatibilities are:
602 - WIMLIB_COMPRESSION_TYPE_XPRESS is now 1 and
603 WIMLIB_COMPRESSION_TYPE_LZX is now 2 (so it's the same as
606 - User-provided progress functions are now registered using a
607 separate function, wimlib_register_progress_function(). The
608 'progress_func' argument to many functions no longer exists.
610 - The return value from user-provided progress functions is now
613 - A context argument has been added to the prototype of
614 user-provided progress functions.
616 - 'struct wimlib_capture_config' has been removed. The library
617 now takes the path to the configuration file directly. This
618 affects wimlib_add_image(), wimlib_add_image_multisource(),
619 and wimlib_update_image(). However, a NULL value passed in
620 the argument retains the same meaning.
622 - Removed deprecated functions: some (de)compression functions,
623 wimlib_extract_files(), and wimlib_print_metadata().
625 - Removed extraction flags: WIMLIB_EXTRACT_FLAG_HARDLINK,
626 WIMLIB_EXTRACT_FLAG_SYMLINK, WIMLIB_EXTRACT_FLAG_FILE_ORDER,
627 and WIMLIB_EXTRACT_FLAG_SEQUENTIAL.
629 - Removed some progress messages:
630 WIMLIB_PROGRESS_MSG_APPLY_TIMESTAMPS,
631 WIMLIB_PROGRESS_MSG_EXTRACT_DIR_STRUCTURE_BEGIN,
632 WIMLIB_PROGRESS_MSG_EXTRACT_DIR_STRUCTURE_END. Numbering
635 - Removed some error codes. Numbering stays the same.
637 - Replaced WIMLIB_UNMOUNT_FLAG_LAZY with
638 WIMLIB_UNMOUNT_FLAG_FORCE.
640 - WIM paths passed to progress functions now have a leading
644 Case-insensitive comparisons of strings (e.g. filenames) containing
645 UTF-16 codepoints above 32767 are now done correctly.
647 Fixed build failure on Mac OS X.
649 wimunmount now provides the '--new-image' option to cause changes to a
650 read-write mounted image to be committed as a new image rather than as
651 an update of the mounted image. (The corresponding new library flag is
652 WIMLIB_UNMOUNT_FLAG_NEW_IMAGE.)
654 The LZMS ("recovery") compression chunk size, or "dictionary size", may
655 now be up to 1 GiB (1,073,741,824 bytes).
657 The performance of LZX ("maximum") and LZMS ("recovery") compression
658 with large chunk sizes has been slightly improved.
661 Stored files with size exactly 4 GiB (4,294,967,296 bytes) are now
662 decompressed correctly.
664 Fixed a bug in the LZX compressor introduced in v1.5.3. The bug
665 occurred in an unlikely case, and due to validity checks it did not
666 affect successfully created archives.
668 Fixed a minor compatibility issue with the LZMS compressor and
669 decompressor. This is *not* the default compression type and was only
670 introduced in v1.6.0. In the unlikely event that you created an
671 LZMS-compressed WIM with v1.6.0 and a checksum error is reported when
672 applying it with v1.6.1, decompress it with v1.6.0 then compress it with
675 Memory usage for LZMS and LZX compression has been decreased.
677 wimextract now allows wildcard characters in paths specified on the
678 command line. Also, the '--strict-wildcards' option has been removed
679 and replaced with the inverse option '--nullglob'. See the
680 documentation for wimextract for more details and changes.
682 The wimlib_extract_files() function is now considered deprecated in
683 favor of wimlib_extract_paths().
685 Fixed more permissions problems when extracting files on Windows.
687 A new '--no-attributes' option has been added to wimapply and
688 wimextract. The library flag is WIMLIB_EXTRACT_FLAG_NO_ATTRIBUTES.
690 The default chunk size is now set correctly when changing the
691 compression type of a WIM, for example with 'wimoptimize'.
693 The '--metadata' option to wiminfo has been replaced with the
694 '--detailed' option to wimdir.
696 In relevant wimlib-imagex commands, '--solid' may now be used as an
697 alias for '--pack-streams'.
700 Support for extracting and updating the new version 3584 WIMs has been
701 added. These WIMs typically pack many streams ("files") together into a
702 single compressed resource, thereby saving space. This degrades the
703 performance of random access (such as that which occurs on a mounted
704 image), but optimizations have been implemented for extraction. These
705 new WIM files also typically use a new compression format (LZMS), which
706 is similar to LZMA and can offer a better compression ratio than LZX.
707 These new WIM files can be created using `wimcapture' with
708 the '--compress=lzms --pack-streams' options. Note: this new WIM format
709 is used by the Windows 8 web downloader, but important segments of the
710 raw '.esd' files are encrypted, so wimlib will not be able to extract
711 such files until they are first decrypted.
713 wimlib now supports extracting files and directories from a WIM image
714 based on a "listfile" that itself contains the list of paths to extract.
715 For `wimextract', the syntax is to specify @LISTFILE instead of a PATH,
716 and for the library itself, the new APIs are wimlib_extract_pathlist()
717 and wimlib_extract_paths(). Path globs containing wildcard characters
720 For searching WIM files, wimlib now has configurable case sensitivity.
721 The default on Windows is still case-insensitive and the default on
722 UNIX-like systems is still case-sensitive, but this can be overridden
723 on either platform through flags to wimlib_global_init(). For
724 `wimlib-imagex', the environmental variable WIMLIB_IMAGEX_IGNORE_CASE
725 can be set to 1 or 0 for case-insensitive or case-sensitive behavior,
728 Support for compression chunk sizes greater than the default of 32768
729 bytes has been added. A larger chunk size typically results in a better
730 compression ratio. However, the MS implementation is seemingly not
731 compatible with all chunk sizes, especially for LZX compression, so the
732 defaults remain unchanged, with the exception of the new LZMS-compressed
733 WIMs, which use a larger chunk size by default.
735 The compression/decompression API exported by wimlib has been changed.
736 Now one set of functions handles all supported compression formats.
738 `wimcapture' and `wimappend' will now display the progress of scanning
739 the directory tree to capture, in addition to the progress of writing
740 data to the WIM. The '--verbose' option no longer does anything. The
741 library API change for this is the addition of several members to
742 `struct wimlib_progress_info_scan' available to progress callbacks.
744 `mkwinpeimg' now correctly handles the '--start-script' option when the
745 start script is not in the working directory.
747 Sequential extraction, previously requested by using
748 WIMLIB_EXTRACT_FLAG_SEQUENTIAL, is now the default.
749 WIMLIB_EXTRACT_FLAG_FILE_ORDER can be used to get the old default
750 behavior (extract in file order).
753 The new LZX compressor added in v1.5.2 has been improved and is now
754 enabled by default, except when `wimcapture' or `wimappend' is run
755 *without* the '--compress' option, in which case the faster LZX
756 compressor is used (the same as before). This behavior is reasonably
757 consistent with ImageX which actually uses "fast" (XPRESS) compression
758 by default. In those cases, use '--compress=maximum' to explicitly
759 capture a WIM image using the new (slower but better) LZX compressor.
761 The '--compress-slow' option still exists to `wimlib-imagex optimize',
762 but its new behavior is to tweak the new LZX compressor even more to
763 produce an even better compression ratio at the cost of more time spent
766 `wimlib-imagex optimize' now supports the '--compress=TYPE' option,
767 which recompresses the WIM file using the specified compression TYPE.
768 The new library API function used for this is
769 wimlib_set_output_compression_type().
771 Added the wimlib_get_xml_data() function to allow library clients to
772 easily retrieve the raw XML data from a WIM file if needed.
774 Fixed a bug that could cause an error code to be incorrectly returned
775 when writing XML data containing a <WINDOWS> element.
777 Mounted WIM images will now correctly show the default file stream even
778 if appears in the alternate data stream entries of the corresponding WIM
782 Added a new experimental LZX compressor which can be enabled by passing
783 '--compress-slow' to `wimlib-imagex capture' or `wimlib-imagex
784 optimize'. (The latter is only applicable if the WIM is already
785 LZX-compressed and the '--recompress' option is also given.) The
786 experimental compressor is much slower but compresses the data slightly
787 more --- currently usually to within a fraction of a percent of the
788 results from WIMGAPI/ImageX.
790 A workaround has been added for compatibility with versions of WinPE
791 that interpret alternate data stream entries in the boot WIM
794 An alignment bug that caused a crash in the LZX decompressor on some
797 wimlib now attempts to clear the WIM_HDR_FLAG_WRITE_IN_PROGRESS flag in
798 the WIM header when restoring the previous state of a WIM it failed to
801 Added a workaround to avoid an access denied error on Windows when
802 replacing a WIM file that another process has opened.
805 wimlib can now open WinPE WIMs from WAIK v2.1, which had a quirk that
806 needed to be handled.
808 A bug in the interpretation of negative IMAGE indices in the
809 --update-of=[WIMFILE:]IMAGE option to `wimlib-imagex capture' and
810 `wimlib-imagex append' has been fixed.
812 A workaround has been added to successfully apply security descriptors
813 with empty DACLs when the NTFS-3g apply mode is being used with NTFS-3g
814 2013.1.13 or earlier.
816 `wimlib-imagex capture' can now accept the '--delta-from' option
820 Added support for "pipable" WIMs. Pipable WIMs allow capturing images
821 to standard output and applying images from standard input, but they are
822 not compatible with Microsoft's software and are not created by default.
823 See the documentation for --pipable flag of `wimlib-imagex capture' for
826 To better support incremental backups, added support for declaring an
827 image as a modified form of another image. See the documentation for
828 the '--update-of' option of `wimlib-imagex append' and `wimlib-imagex
831 Added supported for "delta" WIMs. See the documentation for the
832 '--delta-from' option of `wimlib-imagex capture'.
834 The library support for managing split WIMs has been changed to support
835 other arrangements, such as delta WIMs, and be easier to use. This
836 change is visible in `wimlib-imagex', which also can now accept the
837 '--ref' option multiple times, and also now supports "delta" WIMs as
840 wimlib now preserves WIM integrity tables by default, even if
841 WIMLIB_WRITE_FLAG_CHECK_INTEGRITY is not specified. This changes the
842 behavior of `wimlib-imagex' whenever the WIM being operated on contains
843 an integrity table and the '--check' option is not specified.
845 `wimlib-imagex capture' now creates LZX-compressed WIMs by default
846 (when --compress is not specified). This provides the best compression
847 ratio by default, which is usually what is desired, at a cost of some
850 `wimlib-imagex' now supports being invoked as wimCOMMAND, where COMMAND
851 is the command as in `wimlib-imagex COMMAND'; for example, it can be
852 invoked as `wimapply' as an alternative to `wimlib-imagex apply'. The
853 appropriate hard links are created in UNIX installations of
854 `wimlib-imagex', while for the Windows distribution of `wimlib-imagex',
855 batch files that emulate this behavior are generated.
857 Security descriptors are now extracted correctly on Windows.
859 Fixed archiving DOS names in NTFS-3g capture mode.
861 The extraction code has been rewritten and it will now be easier to
862 support new features on all supported backends (currently Win32, UNIX,
863 and NTFS-3g). For example, hard-linked extraction mode (--hardlink) is
864 now supported on all backends, not just UNIX.
866 `mkwinpeimg' now supports grabbing files from the WAIK supplement rather
867 than the WAIK itself.
869 wimlib_global_init() now, by default, attempts to acquire additional
870 privileges on Windows, so library clients need not do this.
872 This update bumps the shared library version number up to 9, since it is
873 not binary compatibible with previous releases.
876 Fixed bug in `wimlib-imagex export' that made it impossible to export an
877 image from a WIM that is readonly at the filesystem level.
879 Return error code rather than segfaulting when trying to list files from
880 a non-first part of a split WIM.
882 Joining a WIM will now preserve the RP_FIX and READONLY flags.
885 On Windows, paths given to wimlib-imagex are now treated case
888 Improved behavior regarding invalid filenames; in particular, on
889 Windows, wimlib-imagex will, when extracting, now omit (with an option
890 to override this default) filenames differing only in case, or filenames
891 containing characters not valid on Windows.
893 On Windows, wimlib now supports capturing and extracting long paths
894 (longer than the so-called MAX_PATH).
896 On Windows, `wimlib-imagex update' now acquires proper privileges when
897 running as an Administrator.
899 `wimlib-imagex update' will now complain if no image is specified when
900 trying to update a multi-image WIM.
902 `wimlib-imagex update' now supports specifying a single update command
903 directly on the command line using the --command option.
905 wimlib-imagex will now choose different units for progress messages,
906 depending on the amount of data that needs to be processed.
908 `wimlib-imagex append' will now generate a unique WIM image name if no
909 name is specified and the defaulted name already exists in the WIM.
911 wimlib now allows you to create unnamed WIM images, which can then only
912 be referred to by index.
914 wimlib now allows you to explicitly declare you want write access to a
915 WIM by providing the WIMLIB_OPEN_FLAG_WRITE_ACCESS flag to
918 wimlib now respects the WIM_HDR_FLAG_READONLY flag when set in the WIM
921 Progress callbacks have been added to wimlib's wimlib_update_image()
924 Added wimlib_get_wim_info(), wimlib_set_wim_info(),
925 wimlib_iterate_dir_tree(), and wimlib_iterate_lookup_table() functions
928 NTFS-3g capture now only warns about two conditions previously treated
931 Fixed a couple issues with using wimlib-imagex on UDF filesystems on
934 wimlib now correctly detects and returns an error when reading a WIM
935 image with a cyclic directory structure. (Fun fact: such a WIM will
936 crash Microsoft's software.)
939 Added new "extract" and "update" subcommands to wimlib-imagex, along
940 with associated APIs in the library. These commands are intended mainly
941 for Windows use but can be used on UNIX as well.
943 Many documentation improvements.
945 Fixed a bug in the Windows build where relative symbolic links were not
946 captured in reparse-point fixup mode.
948 Fixed a bug in the Windows build where file handles were left open to
949 the WIM file, causing `wimlib_imagex optimize' to fail in some cases.
951 Fixed a bug in the Windows build of wimlib-imagex where globbing
952 split-WIM parts could cause the program to crash.
954 Fixed a bug where the creation time of WIM images would be shown instead
955 of the last modification time.
957 With the Windows build it is now possible to restore a WIM containing
958 symbolic links as a non-Administrator; however you will receive warnings
959 about not being able to extract the symbolic links.
962 Capturing a WIM image should now be significantly faster in most cases
963 due to improved use of the operating system's cache and avoiding reading
964 files twice whenever possible.
966 The Windows build should now work on Windows XP.
968 The Windows build now supports capturing and restoring hidden,
969 compressed, sparse, and encrypted files.
971 The Windows build now supports capturing and applying WIM images from
972 filesystems other than NTFS (with some reduced functionality).
974 The Windows build now extracts short names correctly.
976 Added support for "reparse-point" fixups (i.e. fixing up of symbolic
977 links). See docs for --rpfix and --norpfix flags of `wimlib-imagex
978 capture' and `wimlib-imagex apply'.
980 The performance of splitting and joining WIMs should be slightly
983 The LZX and XPRESS compression and decompression functions are now
984 exported from the library.
987 Improvements and bugfixes for the Windows build.
989 Added --strict-acls options.
991 Fixed the way that wimlib determines the order of images in the WIM.
994 Since wimlib can now be used on Windows, wimlib's implementation of
995 ImageX has been renamed to wimlib-imagex to avoid confusion with
996 Microsoft's implementation of ImageX, which would have the same file
997 name ("imagex.exe"). If you really don't like this you can pass the
998 --with-imagex-progname option to `configure' to choose a different name,
999 or even simply rename the binary yourself (but the former way will
1000 configure the man pages to use the chosen name).
1002 Various bugs fixed in the Windows build. Mainly to do with capturing
1003 and restoring alternate data streams correctly in weird cases, and
1004 requesting the correct privileges when opening files. Also added the
1005 --noacls options to wimlib-imagex capture, append, and apply.
1007 Windows build again: FindFirstStreamW() and FindNextStreamW() are now
1008 dynamically loaded, so this may make the library compatible with Windows
1009 XP (however, there may still be other problems).
1012 Added experimental support for native Windows builds. Binaries can be
1013 downloaded from the SourceForge page.
1015 --source-list option added to `imagex capture' and `imagex append'.
1017 Better support for different character encodings.
1020 Storing UNIX file owners, groups, and modes in WIM images is now
1021 possible using `imagex capture' with the --unix-data flag.
1023 Minor bug fixes and documentation fixes.
1026 NTFS capture: Fixed capturing duplicate reparse points.
1028 NTFS capture: Capture first unnamed stream if there are more than one
1029 (print warning instead of error).
1031 Allow multiple test cases to execute concurrently (e.g. make -j2 check).
1034 Added --arch switch to mkwinpeimg script to support getting AMD64 WinPE
1037 Update to work with ntfs-3g version 2013.1.13.
1040 Fixed truncating file to shorter but non-zero length on read-write
1043 Various code cleanups and minor documentation fixes.
1046 LZX and XPRESS decompression have received some additional optimizations
1047 and should now be even faster. (Although, they were already pretty
1048 fast--- much faster than typical I/O speeds.)
1050 Fixed a bug introduced in v1.2.1 that would cause a directory tree
1051 containing hard links to be captured incorrectly in some cases.
1054 By default, unmounting a read-write mounted WIM with 'imagex unmount
1055 --commit' will now change the WIM in-place without needing to write the
1056 entire WIM again. Use 'imagex unmount --commit --rebuild' to get the
1059 'imagex unmount' no longer has a hard-coded limit of 10 minutes to wait
1060 for a response from the daemon servicing the mounted WIM. Instead,
1061 every second 'imagex unmount' will check if the daemon is still alive,
1062 and keep waiting if so, otherwise terminate with an error.
1064 'imagex unmount --commit' on a read-write mounted WIM will now print
1065 progress information regarding the writing of new or modified streams
1066 the WIM, just like when capturing or appending a WIM.
1068 A small change has been made to XPRESS compression and it should improve
1069 the compression ratio slightly.
1071 A change was made that may improve performance slightly when applying a
1072 WIM image to a NTFS volume.
1074 Microsoft has managed to introduce even more bugs into their software,
1075 and now the WIMs for Windows 8 have incorrect (too low) reference counts
1076 for some streams. This is unsafe because such streams can be removed
1077 when they are in actuality still referenced in the WIM (perhaps by a
1078 different image). wimlib will now work around this problem by fixing
1079 the stream reference counts. This is only done when wimlib_delete_image() is
1080 called ('imagex delete') or when wimlib_mount_image() is called with
1081 WIMLIB_MOUNT_FLAG_READWRITE ('imagex mountrw'). Please note that this
1082 requires reading the metadata for all images in the WIM, so this will
1083 make these operations noticably slower on WIMs with multiple images.
1085 Various other bugfixes.
1088 Appending images to a WIM is now be done by default without re-building
1089 the whole WIM. Use the --rebuild flag to get the old behavior (which
1090 was to re-build the entire WIM when a new image is appended).
1092 A new command `imagex optimize' is now available to manually re-build a
1093 WIM that has wasted space due to repeated appends.
1095 Progress information has been improved, and now arbitrary callback
1096 functions can be used to show the progress of a WIM operation.
1098 A possible bug with changing the bootable image of a WIM was fixed.
1100 Some advisory locking is now done to prevent two processes from
1101 modifying a WIM at the same time (but only in some cases). For example,
1102 you cannot mount two images from a WIM read-write at the same time.
1104 Some functions have been reorganized:
1105 * wimlib_mount() renamed to wimlib_mount_image().
1106 * wimlib_unmount() renamed to wimlib_unmount_image().
1107 * wimlib_overwrite_xml_and_header() removed as
1108 wimlib_overwrite() suffices now.
1109 * wimlib_apply_image_to_ntfs_volume() removed as
1110 wimlib_extract_image() suffices now.
1111 * wimlib_add_image_from_ntfs_volume() removed as
1112 * wimlib_add_image() suffices now.
1114 Previously, the soname of libwim.so has been 0.0.0, despite many
1115 interface changes. The soname is now updated to 1.0.0 and will now be
1116 updated each release.
1119 Resources will now be compressed using multiple threads by default.
1120 (This applies to `imagex capture', `imagex append', and `imagex
1123 Some performance improvements in mounted WIMs.
1125 More progress information is shown when capturing a WIM.
1128 Lots of minor fixes, code cleanups, and some documentation updates.
1129 Nothing in particular is really noteworthy.
1132 LZX and XPRESS compression improvements.
1134 Fixed calculation of Directory Count, File Count, Total Bytes, and Hard
1135 Link Bytes of the WIM.
1138 Fixed bug when capturing NTFS file with multiple named data streams.
1140 Internally, we are now using inode structures, even though these don't
1141 appear literally in the WIM file. This simplifies some of the code
1142 (mainly for WIM mounting) and likely fixed a few problems, although it
1146 Fixed problem when exporting images from XPRESS to LZX compressed WIM or
1150 Enough changes to call it version 1.0.0!
1152 Capturing a WIM directly from a NTFS volume, and applying a WIM directly
1153 to a NTFS volume, is now supported.
1155 Hard links and symbolic links have much improved support. They are
1156 supported for WIM capture, WIM application, and mounted WIMs (you can
1157 even make them on read-write mounted WIMs).
1159 Alternate data streams are now supported on mounted WIMs through an
1160 xattr or a Windows-style stream interface. Also they are supported when
1161 capturing a WIM from NTFS or applying a WIM to NTFS.
1163 Split WIMs are better supported. You may now apply an image directly
1164 from a split WIM, mount an image from a split WIM read-only, or export
1165 an image from a split WIM.
1167 Using a capture configuration file is now supported (but not fully yet).
1169 SHA1 message digests are checked in more places, so we can make sure
1170 applied and captured data is correct.
1172 Man pages have been updated and consolidated.
1175 Fixed segfault when unmounting read-only WIM.
1178 Support for joining and splitting WIMs.
1179 Also, security data is now preserved by default.
1182 Can now build with older gcc and system headers, like on CentOS 5.
1185 Fixed bug that made it impossible to overwrite files in read-write
1189 Write byte-order mark before WIM XML data. (imagex.exe requires this to
git://wimlib.net / wimlib / blob