2 Removed OpenSSL (libcrypto) as a dependency of wimlib.
4 Improved the performance of the Windows binaries on CPUs that have SHA-1
7 Removed support for Windows XP.
9 Fixed a bug in 'wimsplit' where it didn't accept part sizes of 4 GiB or
10 larger on Windows and on 32-bit platforms.
13 wimsplit no longer prints a success message on failure.
15 wimlib_iterate_dir_tree() no longer hashes files that haven't yet been
16 written to the WIM file.
18 Reduced the maximum number of file descriptors that wimlib can use when
19 extracting files from a WIM image on macOS.
21 The files that used the CC0 public domain dedication now use the MIT
24 Removed some configuration options (--disable-assertions,
25 --disable-error-messages, and --disable-multithreaded-compression)
26 that probably weren't being used by anyone.
29 Exporting "all" images from a WIM file no longer fails if multiple
30 images in that WIM file have the same name.
32 wimlib now warns rather than aborts if two files have the same SHA-1
33 hash but different sizes.
35 Fixed build errors with the latest version of Mingw-w64.
38 wimsplit now prints progress messages regularly rather than just once
41 Added support for a data recovery mode which causes files to be
42 extracted even if they are corrupted. The option is --recover-data for
43 wimapply and wimextract, and WIMLIB_EXTRACT_FLAG_RECOVER_DATA for the
44 library. Note that this option won't help with all types of corruption;
45 some types of corruption will still cause a fatal error.
48 On Windows, improved performance of capturing an entire drive in some
51 On Windows, fixed leaking a directory handle (or triggering a SEH
52 exception when running under a debugger) when referencing WIM files.
54 On Windows, when applying a Windows OS image using the --compact flag,
55 bootloader files can now be compressed with stronger compression
56 algorithms if the version of Windows is recent enough to support it.
58 Clarified the license text.
61 Prevented miscompilation with gcc 10 at -O3
62 (https://gcc.gnu.org/bugzilla/show_bug.cgi?id=94994).
64 Avoided some compiler warnings with gcc 9 and later.
66 The 'mkwinpeimg' script now also looks for syslinux modules in
67 /usr/share/syslinux, to handle where openSUSE installs them.
69 Removed obsolete packaging files from the source tree.
72 Fixed a crash or incorrect output during LZMS compression with a
73 compression level greater than 50 and a chunk size greater than 64 MiB.
74 This affected wimlib v1.8.0 and later. In the unlikely event that you
75 used all these non-default compression settings in combination, e.g.
76 'wimcapture --solid --solid-compress=LZMS:100 --solid-chunk-size=128M',
77 run 'wimverify' on your archives to verify your data is intact.
80 On Windows, wimlib now supports capturing and applying extended
81 attributes (EAs). It is compatible with DISM with the /EA option,
82 available since Windows 10 version 1607. wimlib's EA support is on by
83 default and works on older versions of Windows too.
85 Partially fixed a bug where [ExclusionException] entries didn't take
86 effect when the containing directory is matched by [ExclusionList]. It
87 now works when the [ExclusionException] patterns are absolute. For
88 example, listing "/dir/file" in [ExclusionException] now works even if
89 "/dir" is matched by [ExclusionList].
91 Added a '--create' option to 'wimappend' which makes it create the WIM
92 file (like 'wimcapture') if it doesn't exist yet.
94 Added an '--include-integrity' option to various wimlib-imagex commands.
95 '--include-integrity' is like '--check', but it will just include an
96 integrity table in the output WIM(s), while skipping verification of any
97 existing integrity tables. This can be useful to avoid unwanted
98 verification of large WIM files, e.g. WIMs given by '--delta-from'.
100 'wimextract' now reads a pathlist file from standard input when "@-" is
101 given as an argument.
103 wimsplit (API: wimlib_split()) now correctly handles a dot in the path
104 to the first split WIM part, prior to the filename extension.
106 'wimlib-imagex --version' now shows the version of the library it is
107 actually using (in case it is different from wimlib-imagex's version).
110 Fixed a bug that was causing the LZMS decompressor to be miscompiled
111 with GCC 7 (this broke extracting "solid" archives).
113 The Windows 10 Recycle Bin directory (\$RECYCLE.BIN) has been added to
114 the default exclusion list.
116 Added a '--quiet' option to wimlib-imagex.
118 The 'mkwinpeimg' script now also looks for the syslinux BIOS modules in
119 the directory /usr/lib/syslinux/modules/bios.
121 Files with timestamps before the year 1970 are now extracted correctly
122 to UNIX-style filesystems, are displayed correctly by
123 'wimdir --detailed', and show up correctly in mounted WIM images.
125 Files with timestamps after the year 2038 are now displayed correctly by
126 the 32-bit Windows build of wimlib.
129 Fixed a data corruption bug (incorrect compression) when storing an
130 already highly-compressed file in an LZX-compressed WIM with a chunk
131 size greater than or equal to 64K. Note that this is not the default
132 setting and such WIMs are not supported by Microsoft's WIM software, so
133 only users who used the --chunk-size option to wimlib-imagex or the
134 wimlib_set_output_chunk_size() API function may have been affected.
135 This bug was introduced in wimlib v1.10.0. See
136 https://wimlib.net/forums/viewtopic.php?f=1&t=300 for more details.
138 On all platforms, sparse files are now extracted as sparse.
140 Sparse files captured from UNIX-style filesystems are now marked as
141 sparse in the resulting WIM image.
143 Added support for storing Linux-style extended attributes in WIM images.
144 When the --unix-data option is used on Linux, wimlib-imagex now captures
145 and applies extended attributes, in addition to the already-supported
146 standard UNIX file permissions (owner/group/mode) and special files.
148 --delta-from is now supported by wimappend. (Previously it was only
149 supported by wimcapture.)
151 On Windows, improved the way in which files deduplicated with Windows'
152 Data Deduplication feature are captured.
154 The development files needed to link with wimlib using Visual Studio are
155 now included in the Windows release archives.
157 wimlib.h can now be included by Visual Studio without errors.
159 The example programs can now be compiled in C++ mode, and they also now
162 Updated 'mkwinpeimg' to work correctly on images that have a "windows"
163 (lower case) directory rather than a "Windows" (upper case) directory.
165 Fixed configuring with --enable-ssse3-sha1 from release tarball
166 (the file nasm_lt.sh was missing).
168 Made some documentation improvements.
171 The LZX compression ratio has been slightly improved. The default mode,
172 LZX level 50, is now almost as good as the old LZX level 100, while
173 being nearly the same speed as before.
175 Decompression performance has been slightly improved.
177 Filenames are now always listed in NTFS collation order.
179 On UNIX-like systems, wimlib can now process Windows filenames that are
180 not valid Unicode due to the presence of unpaired surrogates.
182 On UNIX-like systems, wimlib now always assumes UTF-8 encoding with the
183 addition of surrogate codepoints. Consequently, the environmental
184 variable WIMLIB_IMAGEX_USE_UTF8 and the flag
185 WIMLIB_INIT_FLAG_ASSUME_UTF8 no longer have any effect.
187 wimlib no longer depends on iconv.
189 Reduced memory usage slightly.
191 When a WIM image is applied in NTFS-3G mode, security descriptors are
192 now created in NTFS v3.0 format when supported by the volume.
194 Workarounds for bugs in libntfs-3g version 2013.1.13 and earlier have
195 been removed. Users are advised to upgrade to a later version of
198 On Windows, wimlib now supports case-sensitive filename extraction when
199 supported by the underlying operating system and filesystem (operating
200 system support requires a registry setting).
203 On UNIX, wimlib can now overwrite readonly files when extracting.
205 On Windows, fixed a bug where wimlib could leave a null DACL (a.k.a. "no
206 NTFS permissions") set on some existing directories after extraction.
208 On Windows, when applying a WIM image in "WIMBoot mode" when the WOF
209 driver is not loaded, wimlib can now correctly register a new WIM file
210 with the target volume when the target volume previously had had WIM
213 Added a new testing program.
215 Clarified the main license text and updated public domain dedications
216 for certain files to be more thorough.
219 Object IDs are now saved and restored on Windows and in NTFS-3G mode.
221 Reduced memory usage when exporting large numbers of WIM images.
223 Non UTF-8 locales are now detected correctly.
225 Addressed compiler warnings and enabled "silent" make rules by default.
227 Windows-specific updates:
228 Fixed a bug where duplicate backslashes could be generated in
229 link targets when extracting symbolic links and junctions.
231 Fixed a bug where the .cmd shortcuts for wimlib-imagex wouldn't
232 work if their full path contained a space.
234 Fixed bugs related to scanning SMB filesystems.
236 Added warning message about known issue with WindowsApps folder.
238 Added instructions for building from source on Windows.
240 VSS support is no longer marked "experimental".
242 Added missing license file for libdivsufsort-lite.
245 Added experimental support for Windows VSS (Volume Shadow Copy Service).
246 The new '--snapshot' argument to 'wimcapture' makes wimlib automatically
247 create and use a temporary VSS snapshot when capturing a WIM image.
249 Implemented setting of Windows-specific XML information, such as
250 architecture, system root, and version details. This information is now
251 automatically set in newly captured WIM images, when appropriate.
253 Improved performance of directory tree scans on Windows.
255 On Windows, to improve capture performance, wimlib now sometimes opens
256 files by inode number rather than by path. This is enabled for
257 wimcapture and wimappend, but for now other applications have to opt-in.
259 The progress messages printed by wimlib-imagex while writing WIM files
260 have been slightly tweaked.
262 Progress information for directory tree scans now counts all hard links.
263 Also, on Windows "\\?\" is no longer stripped from the current path.
265 Added a new '--image-property' option to 'wimcapture', 'wimappend', and
266 'wiminfo'. This option lets you assign values to elements in a WIM
267 file's XML document by name.
269 The wimlib_get_image_property() and wimlib_set_image_property() API
270 functions now support numerically indexed elements.
272 Fixed a bug where, on Windows, wimlib would change the security
273 descriptor of the target directory of an extraction even when the
274 '--no-acls' option was specified.
277 Fixed a bug with libntfs-3g extraction present since v1.8.1. Sometimes,
278 some Microsoft software would not correctly recognize data in the
279 resulting filesystem.
281 Made some small improvements to the compression algorithms:
282 LZX compression ratio was slightly improved.
283 XPRESS compression ratio and speed was slightly improved.
284 LZMS compression speed was slightly improved.
286 Improved handling of WIM XML data. wimlib no longer drops unrecognized
287 elements when exporting images. In addition, two API functions were
288 added for better access to elements in the XML document:
289 wimlib_get_image_property() and wimlib_set_image_property().
291 Added support for (unsafe) in-place compaction of WIM files.
293 Improved performance of image export by reusing metadata resources
294 instead of always rebuilding and recompressing them.
296 Improved performance of wimlib_update_image() by delaying the update to
297 the WIM's XML document until a write is requested.
299 On Windows, the target of an extraction may now be a reparse point
300 (which will be dereferenced).
302 On Windows, wimlib now correctly restores non-Microsoft reparse points.
303 However, this remains broken in NTFS-3g mode due to a libntfs-3g bug.
305 On Windows, wimlib now has improved performance when archiving files
306 from a filesystem backed by a WIM (a "WIMBoot" setup).
308 Several improvements to System Compression (compact mode) support:
310 wof.sys (or wofadk.sys) is now automatically attached to the
311 target volume if needed.
313 Compact-mode extractions now work correctly with wofadk.sys on
314 older versions of Windows.
316 For compatibility with the Windows bootloader, the requested
317 compression format now is overridden on certain files.
319 Other minor bugfixes.
322 This release primarily contains various minor bug fixes and
323 improvements, including:
325 Improved handling of deep directory structures.
327 Fixed a bug where on 32-bit systems, the library could enter an
328 infinite loop if a WIM file was malformed in a specific way.
330 Added a workaround for a case where libntfs-3g may report
331 duplicate streams in an NTFS file.
333 Windows symbolic links and junctions in mounted WIM images are
334 now automatically rewritten to be valid in the mounted location.
336 Reparse point fixes: correctly handle the "ReparseReserved"
337 field, and correctly handle "empty" (data-less) reparse points.
339 On Windows, wimlib now acquires SeManageVolumePrivilege, which
340 is needed to create externally backed files using the
343 Improved validation of filenames.
345 Improved LZMS decompression speed.
347 The configure script now honors alternate pkg-config settings.
349 Links have been updated to point to the new website.
351 In addition, experimental support has been added for compressing
352 extracted files using System Compression on Windows 10. This
353 functionality is available through the new '--compact' option to
354 'wimapply' and 'wimextract' as well as new library flags.
357 Fixed a bug in the LZX decompressor: malicious input data could cause
358 out of bounds writes to memory (since wimlib v1.2.2).
360 The output of the 'wiminfo' command now consolidates various boolean
361 flags (such as "Relative path junction") into a single line.
363 A file can now have both an unnamed data stream ("file contents") and a
364 reparse point stream. Such files can exist as a result of the use of
365 certain Windows features, such as offline storage, including "OneDrive".
366 wimlib will now store and restore both streams on Windows as well as in
367 NTFS-3g mode. Microsoft's WIMGAPI also has this behavior.
369 On Windows, named data streams of encrypted files are no longer stored
370 twice in WIM archives.
372 On Windows, named data streams are now correctly extracted to existing
373 "readonly" directories. Before, an error would be reported.
375 On Windows, it is now possible to do a "WIMBoot mode" extraction with
376 non-standalone WIMs such as delta WIMs.
378 On Windows, when doing an extraction in "WIMBoot mode", files larger
379 than 4 gigabytes are now never extracted as externally backed. This
380 works around a bug in Microsoft's "WOF" driver.
382 The '--enable-verify-compression' configure option has been removed. If
383 you want to verify a WIM file, use the 'wimverify' program.
385 The way the "file count", "directory count", "total bytes", and "hard
386 link bytes" image statistics (stored in the WIM XML data) is calculated
387 has been slightly changed.
389 In mounted WIM images, the disk usage provided for each file (st_blocks)
390 is now the compressed size rather than the uncompressed size.
392 The performance of the NTFS-3g and Windows capture modes has been
395 On UNIX-like systems, symbolic links whose targets contain the backslash
396 character are now handled correctly (losslessly).
399 Improved the LZX compressor. It is now 15-20% faster than before and
400 provides a slightly better compression ratio.
402 Improved the LZMS compressor. It now provides a compression ratio
403 slightly better than WIMGAPI while still being faster and using slightly
406 The compression chunk size in solid resources, e.g. when capturing or
407 exporting a WIM file using the '--solid' option, now defaults to 64 MiB
408 (67108864 bytes) instead of 32 MiB (33554432 bytes). This provides a
409 better compression ratio and is the same value that WIMGAPI uses. The
410 memory usage is less than 50% higher than wimlib v1.7.4 and is slightly
411 lower than WIMGAPI's memory usage, but if it is too much, it is still
412 possible to choose a lower value, e.g. with the '--solid-chunk-size'
413 option to wimlib-imagex.
415 The '--chunk-size' and '--solid-chunk-size' options to wimlib-imagex now
416 accept the 'K', 'M', and 'G' suffixes.
418 Files are now sorted by name extension when creating a solid WIM file.
420 Fixed various issues related to capture/apply of EFS-encrypted files on
423 The file list printed by 'wimdir' is now sorted by the platform-specific
424 case sensitivity setting, rather than always case sensitively. This
425 also affects the library function wimlib_iterate_dir_tree().
427 On Windows, some error and warning messages have been improved.
430 The Windows binary distribution no longer contains third party DLLs.
431 These dependencies are instead compiled directly into the libwim DLL.
433 Added more fixes for wimlib on non-x86 architectures such as ARM.
435 Extracting files to a Windows PE in-memory filesystem no longer fails if
436 the target files do not yet exist.
438 Improved the performance of XPRESS compression and LZMS decompression.
440 Enabled SSSE3 accelerated SHA-1 computation in x86_64 Windows builds.
441 It will automatically be faster on newer Intel and AMD processors.
443 Removed the --with-imagex-progname and --enable-more-assertions
447 Fix for very slow export from solid WIM / ESD files.
449 Fix for LZX and LZMS algorithms on non-x86 architectures, such as ARM.
451 New progress message: WIMLIB_PROGRESS_MSG_HANDLE_ERROR. Applications
452 may use this to treat some types of errors as non-fatal.
454 The library now permits making in-memory changes to a WIMStruct backed
455 by a read-only WIM file.
457 Fixes for "WIMBoot" extraction mode (Windows only):
459 When not using the WOF driver, extraction no longer fails if the
460 disk containing the WIM file has too many partitions.
462 When matching patterns in [PrepopulateList], all hard links of
463 each file are now considered.
465 The system registry files are now automatically treated as being
466 in [PrepopulateList].
468 Added a hack to try to work around an intermittent bug in
469 Microsoft's WOF (Windows Overlay Filesystem) driver.
472 Made more improvements to the XPRESS, LZX, and LZMS compressors.
474 A number of improvements to the Windows port:
476 Fixes for setting short filenames.
478 Faster "WIMBoot" extraction.
480 Updated and slimmed down the dependent DLLs.
482 ACL inheritence bits are now restored.
484 Mandatory integrity labels are now backed up and restored.
486 Added a workaround for an issue where in rare cases, wimlib could create
487 a compressed data stream that could not be read correctly by Windows
488 after an extraction in "WIMBoot" mode.
491 Added file count progress data for
492 WIMLIB_PROGRESS_MSG_EXTRACT_FILE_STRUCTURE and
493 WIMLIB_PROGRESS_MSG_EXTRACT_METADATA.
495 Added support for testing file exclusions via the user-provided
498 Some documentation improvements.
500 Made some clarifications to the license text in the COPYING file.
503 Made more improvements to the XPRESS, LZX, and LZMS compressors.
505 The default compression mode for wimcapture is now LZX compression in
506 its default mode, which is the same as '--compress=maximum'.
508 You can now specify an optional integer compression level to the
509 '--compress' option; e.g. '--compress=lzx:75'.
511 Made a minor change to the LZMS compressor and decompressor to fix an
512 incompatibility with the Microsoft implementation. In the unlikely
513 event that you created an LZMS-compressed WIM with wimlib v1.7.0 or
514 earlier and a checksum error is reported when extracting files from it
515 with wimlib v1.7.1, decompress it with v1.7.0 then compress it with
518 Added 'verify' subcommand to wimlib-imagex.
520 Notable library changes:
522 Custom compressor parameters have been removed from the library
523 in favor of the simpler level-based API.
525 Decompressor parameters have been removed entirely.
527 Library users can now specify a custom file for warning and
528 error messages to be sent to, rather than the default of
531 New progress messages:
532 WIMLIB_PROGRESS_MSG_EXTRACT_FILE_STRUCTURE,
533 WIMLIB_PROGRESS_MSG_EXTRACT_METADATA.
535 New function: wimlib_verify_wim().
538 Improved compression, decompression, and extraction performance.
540 Improved compatibility with version 3584 WIM / ESD files:
541 - Add support for reading and writing multiple solid blocks per
542 archive, which WIMGAPI/DISM can create when appending an image.
543 - Correctly create solid blocks larger than 4 GiB.
545 'add' commands passed to wimupdate will now replace existing
546 nondirectory files by default. Use the --no-replace option to get the
549 The license for the library now contains an exception that allows using
550 it under the LGPL. See the COPYING file for details.
552 In reparse-point fixup mode (the default for capture), symbolic links
553 and junctions that point outside the tree being captured are no longer
554 excluded from capture.
556 Added support for "WIMBoot" capture and extraction. See the
557 documentation for the new '--wimboot' option to wimcapture and wimapply
558 for more information.
560 On UNIX-like systems, you can now backup and restore device nodes, named
561 pipes, and sockets. In addition, 32-bit user and group IDs are now
564 The way that UNIX data is stored in WIM files has been changed. If you
565 captured any WIMs with the --unix-data option, to upgrade them you'll
566 need to apply them with --unix-data using wimlib-imagex v1.6.2, then
567 re-capture them with --unix-data using this version.
569 wimlib now understands tagged metadata items, such as object IDs, that
570 can be stored in WIM directory entries.
572 Removed the --hardlink and --symlink options to wimapply, since I don't
573 think they are too useful and they got in the way of improving the code.
575 WIMs will now retain their GUIDs when rebuilt (e.g. with wimoptimize).
577 The 'mkwinpeimg' script now supports writing the ISO image to standard
580 The <ARCH> element in WIM XML data is now exported correctly.
582 On Windows, sparse file attributes are no longer set on extracted files.
583 Oddly enough, this actually saves disk space in some cases.
585 On UNIX, configuring with --disable-xattr or --enable-xattr is no longer
586 supported. Mounting WIM images now always requires extended attribute
587 support. Use --without-fuse to disable support for mounting WIM images;
588 this will also disable the need for extended attribute support.
590 Configuring with --enable-ssse3-sha1 now works correctly.
592 The shared library version has been bumped up. The main
593 incompatibilities are:
595 - WIMLIB_COMPRESSION_TYPE_XPRESS is now 1 and
596 WIMLIB_COMPRESSION_TYPE_LZX is now 2 (so it's the same as
599 - User-provided progress functions are now registered using a
600 separate function, wimlib_register_progress_function(). The
601 'progress_func' argument to many functions no longer exists.
603 - The return value from user-provided progress functions is now
606 - A context argument has been added to the prototype of
607 user-provided progress functions.
609 - 'struct wimlib_capture_config' has been removed. The library
610 now takes the path to the configuration file directly. This
611 affects wimlib_add_image(), wimlib_add_image_multisource(),
612 and wimlib_update_image(). However, a NULL value passed in
613 the argument retains the same meaning.
615 - Removed deprecated functions: some (de)compression functions,
616 wimlib_extract_files(), and wimlib_print_metadata().
618 - Removed extraction flags: WIMLIB_EXTRACT_FLAG_HARDLINK,
619 WIMLIB_EXTRACT_FLAG_SYMLINK, WIMLIB_EXTRACT_FLAG_FILE_ORDER,
620 and WIMLIB_EXTRACT_FLAG_SEQUENTIAL.
622 - Removed some progress messages:
623 WIMLIB_PROGRESS_MSG_APPLY_TIMESTAMPS,
624 WIMLIB_PROGRESS_MSG_EXTRACT_DIR_STRUCTURE_BEGIN,
625 WIMLIB_PROGRESS_MSG_EXTRACT_DIR_STRUCTURE_END. Numbering
628 - Removed some error codes. Numbering stays the same.
630 - Replaced WIMLIB_UNMOUNT_FLAG_LAZY with
631 WIMLIB_UNMOUNT_FLAG_FORCE.
633 - WIM paths passed to progress functions now have a leading
637 Case-insensitive comparisons of strings (e.g. filenames) containing
638 UTF-16 codepoints above 32767 are now done correctly.
640 Fixed build failure on Mac OS X.
642 wimunmount now provides the '--new-image' option to cause changes to a
643 read-write mounted image to be committed as a new image rather than as
644 an update of the mounted image. (The corresponding new library flag is
645 WIMLIB_UNMOUNT_FLAG_NEW_IMAGE.)
647 The LZMS ("recovery") compression chunk size, or "dictionary size", may
648 now be up to 1 GiB (1,073,741,824 bytes).
650 The performance of LZX ("maximum") and LZMS ("recovery") compression
651 with large chunk sizes has been slightly improved.
654 Stored files with size exactly 4 GiB (4,294,967,296 bytes) are now
655 decompressed correctly.
657 Fixed a bug in the LZX compressor introduced in v1.5.3. The bug
658 occurred in an unlikely case, and due to validity checks it did not
659 affect successfully created archives.
661 Fixed a minor compatibility issue with the LZMS compressor and
662 decompressor. This is *not* the default compression type and was only
663 introduced in v1.6.0. In the unlikely event that you created an
664 LZMS-compressed WIM with v1.6.0 and a checksum error is reported when
665 applying it with v1.6.1, decompress it with v1.6.0 then compress it with
668 Memory usage for LZMS and LZX compression has been decreased.
670 wimextract now allows wildcard characters in paths specified on the
671 command line. Also, the '--strict-wildcards' option has been removed
672 and replaced with the inverse option '--nullglob'. See the
673 documentation for wimextract for more details and changes.
675 The wimlib_extract_files() function is now considered deprecated in
676 favor of wimlib_extract_paths().
678 Fixed more permissions problems when extracting files on Windows.
680 A new '--no-attributes' option has been added to wimapply and
681 wimextract. The library flag is WIMLIB_EXTRACT_FLAG_NO_ATTRIBUTES.
683 The default chunk size is now set correctly when changing the
684 compression type of a WIM, for example with 'wimoptimize'.
686 The '--metadata' option to wiminfo has been replaced with the
687 '--detailed' option to wimdir.
689 In relevant wimlib-imagex commands, '--solid' may now be used as an
690 alias for '--pack-streams'.
693 Support for extracting and updating the new version 3584 WIMs has been
694 added. These WIMs typically pack many streams ("files") together into a
695 single compressed resource, thereby saving space. This degrades the
696 performance of random access (such as that which occurs on a mounted
697 image), but optimizations have been implemented for extraction. These
698 new WIM files also typically use a new compression format (LZMS), which
699 is similar to LZMA and can offer a better compression ratio than LZX.
700 These new WIM files can be created using `wimcapture' with
701 the '--compress=lzms --pack-streams' options. Note: this new WIM format
702 is used by the Windows 8 web downloader, but important segments of the
703 raw '.esd' files are encrypted, so wimlib will not be able to extract
704 such files until they are first decrypted.
706 wimlib now supports extracting files and directories from a WIM image
707 based on a "listfile" that itself contains the list of paths to extract.
708 For `wimextract', the syntax is to specify @LISTFILE instead of a PATH,
709 and for the library itself, the new APIs are wimlib_extract_pathlist()
710 and wimlib_extract_paths(). Path globs containing wildcard characters
713 For searching WIM files, wimlib now has configurable case sensitivity.
714 The default on Windows is still case-insensitive and the default on
715 UNIX-like systems is still case-sensitive, but this can be overridden
716 on either platform through flags to wimlib_global_init(). For
717 `wimlib-imagex', the environmental variable WIMLIB_IMAGEX_IGNORE_CASE
718 can be set to 1 or 0 for case-insensitive or case-sensitive behavior,
721 Support for compression chunk sizes greater than the default of 32768
722 bytes has been added. A larger chunk size typically results in a better
723 compression ratio. However, the MS implementation is seemingly not
724 compatible with all chunk sizes, especially for LZX compression, so the
725 defaults remain unchanged, with the exception of the new LZMS-compressed
726 WIMs, which use a larger chunk size by default.
728 The compression/decompression API exported by wimlib has been changed.
729 Now one set of functions handles all supported compression formats.
731 `wimcapture' and `wimappend' will now display the progress of scanning
732 the directory tree to capture, in addition to the progress of writing
733 data to the WIM. The '--verbose' option no longer does anything. The
734 library API change for this is the addition of several members to
735 `struct wimlib_progress_info_scan' available to progress callbacks.
737 `mkwinpeimg' now correctly handles the '--start-script' option when the
738 start script is not in the working directory.
740 Sequential extraction, previously requested by using
741 WIMLIB_EXTRACT_FLAG_SEQUENTIAL, is now the default.
742 WIMLIB_EXTRACT_FLAG_FILE_ORDER can be used to get the old default
743 behavior (extract in file order).
746 The new LZX compressor added in v1.5.2 has been improved and is now
747 enabled by default, except when `wimcapture' or `wimappend' is run
748 *without* the '--compress' option, in which case the faster LZX
749 compressor is used (the same as before). This behavior is reasonably
750 consistent with ImageX which actually uses "fast" (XPRESS) compression
751 by default. In those cases, use '--compress=maximum' to explicitly
752 capture a WIM image using the new (slower but better) LZX compressor.
754 The '--compress-slow' option still exists to `wimlib-imagex optimize',
755 but its new behavior is to tweak the new LZX compressor even more to
756 produce an even better compression ratio at the cost of more time spent
759 `wimlib-imagex optimize' now supports the '--compress=TYPE' option,
760 which recompresses the WIM file using the specified compression TYPE.
761 The new library API function used for this is
762 wimlib_set_output_compression_type().
764 Added the wimlib_get_xml_data() function to allow library clients to
765 easily retrieve the raw XML data from a WIM file if needed.
767 Fixed a bug that could cause an error code to be incorrectly returned
768 when writing XML data containing a <WINDOWS> element.
770 Mounted WIM images will now correctly show the default file stream even
771 if appears in the alternate data stream entries of the corresponding WIM
775 Added a new experimental LZX compressor which can be enabled by passing
776 '--compress-slow' to `wimlib-imagex capture' or `wimlib-imagex
777 optimize'. (The latter is only applicable if the WIM is already
778 LZX-compressed and the '--recompress' option is also given.) The
779 experimental compressor is much slower but compresses the data slightly
780 more --- currently usually to within a fraction of a percent of the
781 results from WIMGAPI/ImageX.
783 A workaround has been added for compatibility with versions of WinPE
784 that interpret alternate data stream entries in the boot WIM
787 An alignment bug that caused a crash in the LZX decompressor on some
790 wimlib now attempts to clear the WIM_HDR_FLAG_WRITE_IN_PROGRESS flag in
791 the WIM header when restoring the previous state of a WIM it failed to
794 Added a workaround to avoid an access denied error on Windows when
795 replacing a WIM file that another process has opened.
798 wimlib can now open WinPE WIMs from WAIK v2.1, which had a quirk that
799 needed to be handled.
801 A bug in the interpretation of negative IMAGE indices in the
802 --update-of=[WIMFILE:]IMAGE option to `wimlib-imagex capture' and
803 `wimlib-imagex append' has been fixed.
805 A workaround has been added to successfully apply security descriptors
806 with empty DACLs when the NTFS-3g apply mode is being used with NTFS-3g
807 2013.1.13 or earlier.
809 `wimlib-imagex capture' can now accept the '--delta-from' option
813 Added support for "pipable" WIMs. Pipable WIMs allow capturing images
814 to standard output and applying images from standard input, but they are
815 not compatible with Microsoft's software and are not created by default.
816 See the documentation for --pipable flag of `wimlib-imagex capture' for
819 To better support incremental backups, added support for declaring an
820 image as a modified form of another image. See the documentation for
821 the '--update-of' option of `wimlib-imagex append' and `wimlib-imagex
824 Added supported for "delta" WIMs. See the documentation for the
825 '--delta-from' option of `wimlib-imagex capture'.
827 The library support for managing split WIMs has been changed to support
828 other arrangements, such as delta WIMs, and be easier to use. This
829 change is visible in `wimlib-imagex', which also can now accept the
830 '--ref' option multiple times, and also now supports "delta" WIMs as
833 wimlib now preserves WIM integrity tables by default, even if
834 WIMLIB_WRITE_FLAG_CHECK_INTEGRITY is not specified. This changes the
835 behavior of `wimlib-imagex' whenever the WIM being operated on contains
836 an integrity table and the '--check' option is not specified.
838 `wimlib-imagex capture' now creates LZX-compressed WIMs by default
839 (when --compress is not specified). This provides the best compression
840 ratio by default, which is usually what is desired, at a cost of some
843 `wimlib-imagex' now supports being invoked as wimCOMMAND, where COMMAND
844 is the command as in `wimlib-imagex COMMAND'; for example, it can be
845 invoked as `wimapply' as an alternative to `wimlib-imagex apply'. The
846 appropriate hard links are created in UNIX installations of
847 `wimlib-imagex', while for the Windows distribution of `wimlib-imagex',
848 batch files that emulate this behavior are generated.
850 Security descriptors are now extracted correctly on Windows.
852 Fixed archiving DOS names in NTFS-3g capture mode.
854 The extraction code has been rewritten and it will now be easier to
855 support new features on all supported backends (currently Win32, UNIX,
856 and NTFS-3g). For example, hard-linked extraction mode (--hardlink) is
857 now supported on all backends, not just UNIX.
859 `mkwinpeimg' now supports grabbing files from the WAIK supplement rather
860 than the WAIK itself.
862 wimlib_global_init() now, by default, attempts to acquire additional
863 privileges on Windows, so library clients need not do this.
865 This update bumps the shared library version number up to 9, since it is
866 not binary compatibible with previous releases.
869 Fixed bug in `wimlib-imagex export' that made it impossible to export an
870 image from a WIM that is readonly at the filesystem level.
872 Return error code rather than segfaulting when trying to list files from
873 a non-first part of a split WIM.
875 Joining a WIM will now preserve the RP_FIX and READONLY flags.
878 On Windows, paths given to wimlib-imagex are now treated case
881 Improved behavior regarding invalid filenames; in particular, on
882 Windows, wimlib-imagex will, when extracting, now omit (with an option
883 to override this default) filenames differing only in case, or filenames
884 containing characters not valid on Windows.
886 On Windows, wimlib now supports capturing and extracting long paths
887 (longer than the so-called MAX_PATH).
889 On Windows, `wimlib-imagex update' now acquires proper privileges when
890 running as an Administrator.
892 `wimlib-imagex update' will now complain if no image is specified when
893 trying to update a multi-image WIM.
895 `wimlib-imagex update' now supports specifying a single update command
896 directly on the command line using the --command option.
898 wimlib-imagex will now choose different units for progress messages,
899 depending on the amount of data that needs to be processed.
901 `wimlib-imagex append' will now generate a unique WIM image name if no
902 name is specified and the defaulted name already exists in the WIM.
904 wimlib now allows you to create unnamed WIM images, which can then only
905 be referred to by index.
907 wimlib now allows you to explicitly declare you want write access to a
908 WIM by providing the WIMLIB_OPEN_FLAG_WRITE_ACCESS flag to
911 wimlib now respects the WIM_HDR_FLAG_READONLY flag when set in the WIM
914 Progress callbacks have been added to wimlib's wimlib_update_image()
917 Added wimlib_get_wim_info(), wimlib_set_wim_info(),
918 wimlib_iterate_dir_tree(), and wimlib_iterate_lookup_table() functions
921 NTFS-3g capture now only warns about two conditions previously treated
924 Fixed a couple issues with using wimlib-imagex on UDF filesystems on
927 wimlib now correctly detects and returns an error when reading a WIM
928 image with a cyclic directory structure. (Fun fact: such a WIM will
929 crash Microsoft's software.)
932 Added new "extract" and "update" subcommands to wimlib-imagex, along
933 with associated APIs in the library. These commands are intended mainly
934 for Windows use but can be used on UNIX as well.
936 Many documentation improvements.
938 Fixed a bug in the Windows build where relative symbolic links were not
939 captured in reparse-point fixup mode.
941 Fixed a bug in the Windows build where file handles were left open to
942 the WIM file, causing `wimlib_imagex optimize' to fail in some cases.
944 Fixed a bug in the Windows build of wimlib-imagex where globbing
945 split-WIM parts could cause the program to crash.
947 Fixed a bug where the creation time of WIM images would be shown instead
948 of the last modification time.
950 With the Windows build it is now possible to restore a WIM containing
951 symbolic links as a non-Administrator; however you will receive warnings
952 about not being able to extract the symbolic links.
955 Capturing a WIM image should now be significantly faster in most cases
956 due to improved use of the operating system's cache and avoiding reading
957 files twice whenever possible.
959 The Windows build should now work on Windows XP.
961 The Windows build now supports capturing and restoring hidden,
962 compressed, sparse, and encrypted files.
964 The Windows build now supports capturing and applying WIM images from
965 filesystems other than NTFS (with some reduced functionality).
967 The Windows build now extracts short names correctly.
969 Added support for "reparse-point" fixups (i.e. fixing up of symbolic
970 links). See docs for --rpfix and --norpfix flags of `wimlib-imagex
971 capture' and `wimlib-imagex apply'.
973 The performance of splitting and joining WIMs should be slightly
976 The LZX and XPRESS compression and decompression functions are now
977 exported from the library.
980 Improvements and bugfixes for the Windows build.
982 Added --strict-acls options.
984 Fixed the way that wimlib determines the order of images in the WIM.
987 Since wimlib can now be used on Windows, wimlib's implementation of
988 ImageX has been renamed to wimlib-imagex to avoid confusion with
989 Microsoft's implementation of ImageX, which would have the same file
990 name ("imagex.exe"). If you really don't like this you can pass the
991 --with-imagex-progname option to `configure' to choose a different name,
992 or even simply rename the binary yourself (but the former way will
993 configure the man pages to use the chosen name).
995 Various bugs fixed in the Windows build. Mainly to do with capturing
996 and restoring alternate data streams correctly in weird cases, and
997 requesting the correct privileges when opening files. Also added the
998 --noacls options to wimlib-imagex capture, append, and apply.
1000 Windows build again: FindFirstStreamW() and FindNextStreamW() are now
1001 dynamically loaded, so this may make the library compatible with Windows
1002 XP (however, there may still be other problems).
1005 Added experimental support for native Windows builds. Binaries can be
1006 downloaded from the SourceForge page.
1008 --source-list option added to `imagex capture' and `imagex append'.
1010 Better support for different character encodings.
1013 Storing UNIX file owners, groups, and modes in WIM images is now
1014 possible using `imagex capture' with the --unix-data flag.
1016 Minor bug fixes and documentation fixes.
1019 NTFS capture: Fixed capturing duplicate reparse points.
1021 NTFS capture: Capture first unnamed stream if there are more than one
1022 (print warning instead of error).
1024 Allow multiple test cases to execute concurrently (e.g. make -j2 check).
1027 Added --arch switch to mkwinpeimg script to support getting AMD64 WinPE
1030 Update to work with ntfs-3g version 2013.1.13.
1033 Fixed truncating file to shorter but non-zero length on read-write
1036 Various code cleanups and minor documentation fixes.
1039 LZX and XPRESS decompression have received some additional optimizations
1040 and should now be even faster. (Although, they were already pretty
1041 fast--- much faster than typical I/O speeds.)
1043 Fixed a bug introduced in v1.2.1 that would cause a directory tree
1044 containing hard links to be captured incorrectly in some cases.
1047 By default, unmounting a read-write mounted WIM with 'imagex unmount
1048 --commit' will now change the WIM in-place without needing to write the
1049 entire WIM again. Use 'imagex unmount --commit --rebuild' to get the
1052 'imagex unmount' no longer has a hard-coded limit of 10 minutes to wait
1053 for a response from the daemon servicing the mounted WIM. Instead,
1054 every second 'imagex unmount' will check if the daemon is still alive,
1055 and keep waiting if so, otherwise terminate with an error.
1057 'imagex unmount --commit' on a read-write mounted WIM will now print
1058 progress information regarding the writing of new or modified streams
1059 the WIM, just like when capturing or appending a WIM.
1061 A small change has been made to XPRESS compression and it should improve
1062 the compression ratio slightly.
1064 A change was made that may improve performance slightly when applying a
1065 WIM image to a NTFS volume.
1067 Microsoft has managed to introduce even more bugs into their software,
1068 and now the WIMs for Windows 8 have incorrect (too low) reference counts
1069 for some streams. This is unsafe because such streams can be removed
1070 when they are in actuality still referenced in the WIM (perhaps by a
1071 different image). wimlib will now work around this problem by fixing
1072 the stream reference counts. This is only done when wimlib_delete_image() is
1073 called ('imagex delete') or when wimlib_mount_image() is called with
1074 WIMLIB_MOUNT_FLAG_READWRITE ('imagex mountrw'). Please note that this
1075 requires reading the metadata for all images in the WIM, so this will
1076 make these operations noticably slower on WIMs with multiple images.
1078 Various other bugfixes.
1081 Appending images to a WIM is now be done by default without re-building
1082 the whole WIM. Use the --rebuild flag to get the old behavior (which
1083 was to re-build the entire WIM when a new image is appended).
1085 A new command `imagex optimize' is now available to manually re-build a
1086 WIM that has wasted space due to repeated appends.
1088 Progress information has been improved, and now arbitrary callback
1089 functions can be used to show the progress of a WIM operation.
1091 A possible bug with changing the bootable image of a WIM was fixed.
1093 Some advisory locking is now done to prevent two processes from
1094 modifying a WIM at the same time (but only in some cases). For example,
1095 you cannot mount two images from a WIM read-write at the same time.
1097 Some functions have been reorganized:
1098 * wimlib_mount() renamed to wimlib_mount_image().
1099 * wimlib_unmount() renamed to wimlib_unmount_image().
1100 * wimlib_overwrite_xml_and_header() removed as
1101 wimlib_overwrite() suffices now.
1102 * wimlib_apply_image_to_ntfs_volume() removed as
1103 wimlib_extract_image() suffices now.
1104 * wimlib_add_image_from_ntfs_volume() removed as
1105 * wimlib_add_image() suffices now.
1107 Previously, the soname of libwim.so has been 0.0.0, despite many
1108 interface changes. The soname is now updated to 1.0.0 and will now be
1109 updated each release.
1112 Resources will now be compressed using multiple threads by default.
1113 (This applies to `imagex capture', `imagex append', and `imagex
1116 Some performance improvements in mounted WIMs.
1118 More progress information is shown when capturing a WIM.
1121 Lots of minor fixes, code cleanups, and some documentation updates.
1122 Nothing in particular is really noteworthy.
1125 LZX and XPRESS compression improvements.
1127 Fixed calculation of Directory Count, File Count, Total Bytes, and Hard
1128 Link Bytes of the WIM.
1131 Fixed bug when capturing NTFS file with multiple named data streams.
1133 Internally, we are now using inode structures, even though these don't
1134 appear literally in the WIM file. This simplifies some of the code
1135 (mainly for WIM mounting) and likely fixed a few problems, although it
1139 Fixed problem when exporting images from XPRESS to LZX compressed WIM or
1143 Enough changes to call it version 1.0.0!
1145 Capturing a WIM directly from a NTFS volume, and applying a WIM directly
1146 to a NTFS volume, is now supported.
1148 Hard links and symbolic links have much improved support. They are
1149 supported for WIM capture, WIM application, and mounted WIMs (you can
1150 even make them on read-write mounted WIMs).
1152 Alternate data streams are now supported on mounted WIMs through an
1153 xattr or a Windows-style stream interface. Also they are supported when
1154 capturing a WIM from NTFS or applying a WIM to NTFS.
1156 Split WIMs are better supported. You may now apply an image directly
1157 from a split WIM, mount an image from a split WIM read-only, or export
1158 an image from a split WIM.
1160 Using a capture configuration file is now supported (but not fully yet).
1162 SHA1 message digests are checked in more places, so we can make sure
1163 applied and captured data is correct.
1165 Man pages have been updated and consolidated.
1168 Fixed segfault when unmounting read-only WIM.
1171 Support for joining and splitting WIMs.
1172 Also, security data is now preserved by default.
1175 Can now build with older gcc and system headers, like on CentOS 5.
1178 Fixed bug that made it impossible to overwrite files in read-write
1182 Write byte-order mark before WIM XML data. (imagex.exe requires this to
git://wimlib.net / wimlib / blob