2 Fixed build errors with the latest version of Mingw-w64.
4 wimlib now warns rather than aborts if two files have the same SHA-1
5 hash but different sizes.
8 wimsplit now prints progress messages regularly rather than just once
11 Added support for a data recovery mode which causes files to be
12 extracted even if they are corrupted. The option is --recover-data for
13 wimapply and wimextract, and WIMLIB_EXTRACT_FLAG_RECOVER_DATA for the
14 library. Note that this option won't help with all types of corruption;
15 some types of corruption will still cause a fatal error.
18 On Windows, improved performance of capturing an entire drive in some
21 On Windows, fixed leaking a directory handle (or triggering a SEH
22 exception when running under a debugger) when referencing WIM files.
24 On Windows, when applying a Windows OS image using the --compact flag,
25 bootloader files can now be compressed with stronger compression
26 algorithms if the version of Windows is recent enough to support it.
28 Clarified the license text.
31 Prevented miscompilation with gcc 10 at -O3
32 (https://gcc.gnu.org/bugzilla/show_bug.cgi?id=94994).
34 Avoided some compiler warnings with gcc 9 and later.
36 The 'mkwinpeimg' script now also looks for syslinux modules in
37 /usr/share/syslinux, to handle where openSUSE installs them.
39 Removed obsolete packaging files from the source tree.
42 Fixed a crash or incorrect output during LZMS compression with a
43 compression level greater than 50 and a chunk size greater than 64 MiB.
44 This affected wimlib v1.8.0 and later. In the unlikely event that you
45 used all these non-default compression settings in combination, e.g.
46 'wimcapture --solid --solid-compress=LZMS:100 --solid-chunk-size=128M',
47 run 'wimverify' on your archives to verify your data is intact.
50 On Windows, wimlib now supports capturing and applying extended
51 attributes (EAs). It is compatible with DISM with the /EA option,
52 available since Windows 10 version 1607. wimlib's EA support is on by
53 default and works on older versions of Windows too.
55 Partially fixed a bug where [ExclusionException] entries didn't take
56 effect when the containing directory is matched by [ExclusionList]. It
57 now works when the [ExclusionException] patterns are absolute. For
58 example, listing "/dir/file" in [ExclusionException] now works even if
59 "/dir" is matched by [ExclusionList].
61 Added a '--create' option to 'wimappend' which makes it create the WIM
62 file (like 'wimcapture') if it doesn't exist yet.
64 Added an '--include-integrity' option to various wimlib-imagex commands.
65 '--include-integrity' is like '--check', but it will just include an
66 integrity table in the output WIM(s), while skipping verification of any
67 existing integrity tables. This can be useful to avoid unwanted
68 verification of large WIM files, e.g. WIMs given by '--delta-from'.
70 'wimextract' now reads a pathlist file from standard input when "@-" is
73 wimsplit (API: wimlib_split()) now correctly handles a dot in the path
74 to the first split WIM part, prior to the filename extension.
76 'wimlib-imagex --version' now shows the version of the library it is
77 actually using (in case it is different from wimlib-imagex's version).
80 Fixed a bug that was causing the LZMS decompressor to be miscompiled
81 with GCC 7 (this broke extracting "solid" archives).
83 The Windows 10 Recycle Bin directory (\$RECYCLE.BIN) has been added to
84 the default exclusion list.
86 Added a '--quiet' option to wimlib-imagex.
88 The 'mkwinpeimg' script now also looks for the syslinux BIOS modules in
89 the directory /usr/lib/syslinux/modules/bios.
91 Files with timestamps before the year 1970 are now extracted correctly
92 to UNIX-style filesystems, are displayed correctly by
93 'wimdir --detailed', and show up correctly in mounted WIM images.
95 Files with timestamps after the year 2038 are now displayed correctly by
96 the 32-bit Windows build of wimlib.
99 Fixed a data corruption bug (incorrect compression) when storing an
100 already highly-compressed file in an LZX-compressed WIM with a chunk
101 size greater than or equal to 64K. Note that this is not the default
102 setting and such WIMs are not supported by Microsoft's WIM software, so
103 only users who used the --chunk-size option to wimlib-imagex or the
104 wimlib_set_output_chunk_size() API function may have been affected.
105 This bug was introduced in wimlib v1.10.0. See
106 https://wimlib.net/forums/viewtopic.php?f=1&t=300 for more details.
108 On all platforms, sparse files are now extracted as sparse.
110 Sparse files captured from UNIX-style filesystems are now marked as
111 sparse in the resulting WIM image.
113 Added support for storing Linux-style extended attributes in WIM images.
114 When the --unix-data option is used on Linux, wimlib-imagex now captures
115 and applies extended attributes, in addition to the already-supported
116 standard UNIX file permissions (owner/group/mode) and special files.
118 --delta-from is now supported by wimappend. (Previously it was only
119 supported by wimcapture.)
121 On Windows, improved the way in which files deduplicated with Windows'
122 Data Deduplication feature are captured.
124 The development files needed to link with wimlib using Visual Studio are
125 now included in the Windows release archives.
127 wimlib.h can now be included by Visual Studio without errors.
129 The example programs can now be compiled in C++ mode, and they also now
132 Updated 'mkwinpeimg' to work correctly on images that have a "windows"
133 (lower case) directory rather than a "Windows" (upper case) directory.
135 Fixed configuring with --enable-ssse3-sha1 from release tarball
136 (the file nasm_lt.sh was missing).
138 Made some documentation improvements.
141 The LZX compression ratio has been slightly improved. The default mode,
142 LZX level 50, is now almost as good as the old LZX level 100, while
143 being nearly the same speed as before.
145 Decompression performance has been slightly improved.
147 Filenames are now always listed in NTFS collation order.
149 On UNIX-like systems, wimlib can now process Windows filenames that are
150 not valid Unicode due to the presence of unpaired surrogates.
152 On UNIX-like systems, wimlib now always assumes UTF-8 encoding with the
153 addition of surrogate codepoints. Consequently, the environmental
154 variable WIMLIB_IMAGEX_USE_UTF8 and the flag
155 WIMLIB_INIT_FLAG_ASSUME_UTF8 no longer have any effect.
157 wimlib no longer depends on iconv.
159 Reduced memory usage slightly.
161 When a WIM image is applied in NTFS-3G mode, security descriptors are
162 now created in NTFS v3.0 format when supported by the volume.
164 Workarounds for bugs in libntfs-3g version 2013.1.13 and earlier have
165 been removed. Users are advised to upgrade to a later version of
168 On Windows, wimlib now supports case-sensitive filename extraction when
169 supported by the underlying operating system and filesystem (operating
170 system support requires a registry setting).
173 On UNIX, wimlib can now overwrite readonly files when extracting.
175 On Windows, fixed a bug where wimlib could leave a null DACL (a.k.a. "no
176 NTFS permissions") set on some existing directories after extraction.
178 On Windows, when applying a WIM image in "WIMBoot mode" when the WOF
179 driver is not loaded, wimlib can now correctly register a new WIM file
180 with the target volume when the target volume previously had had WIM
183 Added a new testing program.
185 Clarified the main license text and updated public domain dedications
186 for certain files to be more thorough.
189 Object IDs are now saved and restored on Windows and in NTFS-3G mode.
191 Reduced memory usage when exporting large numbers of WIM images.
193 Non UTF-8 locales are now detected correctly.
195 Addressed compiler warnings and enabled "silent" make rules by default.
197 Windows-specific updates:
198 Fixed a bug where duplicate backslashes could be generated in
199 link targets when extracting symbolic links and junctions.
201 Fixed a bug where the .cmd shortcuts for wimlib-imagex wouldn't
202 work if their full path contained a space.
204 Fixed bugs related to scanning SMB filesystems.
206 Added warning message about known issue with WindowsApps folder.
208 Added instructions for building from source on Windows.
210 VSS support is no longer marked "experimental".
212 Added missing license file for libdivsufsort-lite.
215 Added experimental support for Windows VSS (Volume Shadow Copy Service).
216 The new '--snapshot' argument to 'wimcapture' makes wimlib automatically
217 create and use a temporary VSS snapshot when capturing a WIM image.
219 Implemented setting of Windows-specific XML information, such as
220 architecture, system root, and version details. This information is now
221 automatically set in newly captured WIM images, when appropriate.
223 Improved performance of directory tree scans on Windows.
225 On Windows, to improve capture performance, wimlib now sometimes opens
226 files by inode number rather than by path. This is enabled for
227 wimcapture and wimappend, but for now other applications have to opt-in.
229 The progress messages printed by wimlib-imagex while writing WIM files
230 have been slightly tweaked.
232 Progress information for directory tree scans now counts all hard links.
233 Also, on Windows "\\?\" is no longer stripped from the current path.
235 Added a new '--image-property' option to 'wimcapture', 'wimappend', and
236 'wiminfo'. This option lets you assign values to elements in a WIM
237 file's XML document by name.
239 The wimlib_get_image_property() and wimlib_set_image_property() API
240 functions now support numerically indexed elements.
242 Fixed a bug where, on Windows, wimlib would change the security
243 descriptor of the target directory of an extraction even when the
244 '--no-acls' option was specified.
247 Fixed a bug with libntfs-3g extraction present since v1.8.1. Sometimes,
248 some Microsoft software would not correctly recognize data in the
249 resulting filesystem.
251 Made some small improvements to the compression algorithms:
252 LZX compression ratio was slightly improved.
253 XPRESS compression ratio and speed was slightly improved.
254 LZMS compression speed was slightly improved.
256 Improved handling of WIM XML data. wimlib no longer drops unrecognized
257 elements when exporting images. In addition, two API functions were
258 added for better access to elements in the XML document:
259 wimlib_get_image_property() and wimlib_set_image_property().
261 Added support for (unsafe) in-place compaction of WIM files.
263 Improved performance of image export by reusing metadata resources
264 instead of always rebuilding and recompressing them.
266 Improved performance of wimlib_update_image() by delaying the update to
267 the WIM's XML document until a write is requested.
269 On Windows, the target of an extraction may now be a reparse point
270 (which will be dereferenced).
272 On Windows, wimlib now correctly restores non-Microsoft reparse points.
273 However, this remains broken in NTFS-3g mode due to a libntfs-3g bug.
275 On Windows, wimlib now has improved performance when archiving files
276 from a filesystem backed by a WIM (a "WIMBoot" setup).
278 Several improvements to System Compression (compact mode) support:
280 wof.sys (or wofadk.sys) is now automatically attached to the
281 target volume if needed.
283 Compact-mode extractions now work correctly with wofadk.sys on
284 older versions of Windows.
286 For compatibility with the Windows bootloader, the requested
287 compression format now is overridden on certain files.
289 Other minor bugfixes.
292 This release primarily contains various minor bug fixes and
293 improvements, including:
295 Improved handling of deep directory structures.
297 Fixed a bug where on 32-bit systems, the library could enter an
298 infinite loop if a WIM file was malformed in a specific way.
300 Added a workaround for a case where libntfs-3g may report
301 duplicate streams in an NTFS file.
303 Windows symbolic links and junctions in mounted WIM images are
304 now automatically rewritten to be valid in the mounted location.
306 Reparse point fixes: correctly handle the "ReparseReserved"
307 field, and correctly handle "empty" (data-less) reparse points.
309 On Windows, wimlib now acquires SeManageVolumePrivilege, which
310 is needed to create externally backed files using the
313 Improved validation of filenames.
315 Improved LZMS decompression speed.
317 The configure script now honors alternate pkg-config settings.
319 Links have been updated to point to the new website.
321 In addition, experimental support has been added for compressing
322 extracted files using System Compression on Windows 10. This
323 functionality is available through the new '--compact' option to
324 'wimapply' and 'wimextract' as well as new library flags.
327 Fixed a bug in the LZX decompressor: malicious input data could cause
328 out of bounds writes to memory (since wimlib v1.2.2).
330 The output of the 'wiminfo' command now consolidates various boolean
331 flags (such as "Relative path junction") into a single line.
333 A file can now have both an unnamed data stream ("file contents") and a
334 reparse point stream. Such files can exist as a result of the use of
335 certain Windows features, such as offline storage, including "OneDrive".
336 wimlib will now store and restore both streams on Windows as well as in
337 NTFS-3g mode. Microsoft's WIMGAPI also has this behavior.
339 On Windows, named data streams of encrypted files are no longer stored
340 twice in WIM archives.
342 On Windows, named data streams are now correctly extracted to existing
343 "readonly" directories. Before, an error would be reported.
345 On Windows, it is now possible to do a "WIMBoot mode" extraction with
346 non-standalone WIMs such as delta WIMs.
348 On Windows, when doing an extraction in "WIMBoot mode", files larger
349 than 4 gigabytes are now never extracted as externally backed. This
350 works around a bug in Microsoft's "WOF" driver.
352 The '--enable-verify-compression' configure option has been removed. If
353 you want to verify a WIM file, use the 'wimverify' program.
355 The way the "file count", "directory count", "total bytes", and "hard
356 link bytes" image statistics (stored in the WIM XML data) is calculated
357 has been slightly changed.
359 In mounted WIM images, the disk usage provided for each file (st_blocks)
360 is now the compressed size rather than the uncompressed size.
362 The performance of the NTFS-3g and Windows capture modes has been
365 On UNIX-like systems, symbolic links whose targets contain the backslash
366 character are now handled correctly (losslessly).
369 Improved the LZX compressor. It is now 15-20% faster than before and
370 provides a slightly better compression ratio.
372 Improved the LZMS compressor. It now provides a compression ratio
373 slightly better than WIMGAPI while still being faster and using slightly
376 The compression chunk size in solid resources, e.g. when capturing or
377 exporting a WIM file using the '--solid' option, now defaults to 64 MiB
378 (67108864 bytes) instead of 32 MiB (33554432 bytes). This provides a
379 better compression ratio and is the same value that WIMGAPI uses. The
380 memory usage is less than 50% higher than wimlib v1.7.4 and is slightly
381 lower than WIMGAPI's memory usage, but if it is too much, it is still
382 possible to choose a lower value, e.g. with the '--solid-chunk-size'
383 option to wimlib-imagex.
385 The '--chunk-size' and '--solid-chunk-size' options to wimlib-imagex now
386 accept the 'K', 'M', and 'G' suffixes.
388 Files are now sorted by name extension when creating a solid WIM file.
390 Fixed various issues related to capture/apply of EFS-encrypted files on
393 The file list printed by 'wimdir' is now sorted by the platform-specific
394 case sensitivity setting, rather than always case sensitively. This
395 also affects the library function wimlib_iterate_dir_tree().
397 On Windows, some error and warning messages have been improved.
400 The Windows binary distribution no longer contains third party DLLs.
401 These dependencies are instead compiled directly into the libwim DLL.
403 Added more fixes for wimlib on non-x86 architectures such as ARM.
405 Extracting files to a Windows PE in-memory filesystem no longer fails if
406 the target files do not yet exist.
408 Improved the performance of XPRESS compression and LZMS decompression.
410 Enabled SSSE3 accelerated SHA-1 computation in x86_64 Windows builds.
411 It will automatically be faster on newer Intel and AMD processors.
413 Removed the --with-imagex-progname and --enable-more-assertions
417 Fix for very slow export from solid WIM / ESD files.
419 Fix for LZX and LZMS algorithms on non-x86 architectures, such as ARM.
421 New progress message: WIMLIB_PROGRESS_MSG_HANDLE_ERROR. Applications
422 may use this to treat some types of errors as non-fatal.
424 The library now permits making in-memory changes to a WIMStruct backed
425 by a read-only WIM file.
427 Fixes for "WIMBoot" extraction mode (Windows only):
429 When not using the WOF driver, extraction no longer fails if the
430 disk containing the WIM file has too many partitions.
432 When matching patterns in [PrepopulateList], all hard links of
433 each file are now considered.
435 The system registry files are now automatically treated as being
436 in [PrepopulateList].
438 Added a hack to try to work around an intermittent bug in
439 Microsoft's WOF (Windows Overlay Filesystem) driver.
442 Made more improvements to the XPRESS, LZX, and LZMS compressors.
444 A number of improvements to the Windows port:
446 Fixes for setting short filenames.
448 Faster "WIMBoot" extraction.
450 Updated and slimmed down the dependent DLLs.
452 ACL inheritence bits are now restored.
454 Mandatory integrity labels are now backed up and restored.
456 Added a workaround for an issue where in rare cases, wimlib could create
457 a compressed data stream that could not be read correctly by Windows
458 after an extraction in "WIMBoot" mode.
461 Added file count progress data for
462 WIMLIB_PROGRESS_MSG_EXTRACT_FILE_STRUCTURE and
463 WIMLIB_PROGRESS_MSG_EXTRACT_METADATA.
465 Added support for testing file exclusions via the user-provided
468 Some documentation improvements.
470 Made some clarifications to the license text in the COPYING file.
473 Made more improvements to the XPRESS, LZX, and LZMS compressors.
475 The default compression mode for wimcapture is now LZX compression in
476 its default mode, which is the same as '--compress=maximum'.
478 You can now specify an optional integer compression level to the
479 '--compress' option; e.g. '--compress=lzx:75'.
481 Made a minor change to the LZMS compressor and decompressor to fix an
482 incompatibility with the Microsoft implementation. In the unlikely
483 event that you created an LZMS-compressed WIM with wimlib v1.7.0 or
484 earlier and a checksum error is reported when extracting files from it
485 with wimlib v1.7.1, decompress it with v1.7.0 then compress it with
488 Added 'verify' subcommand to wimlib-imagex.
490 Notable library changes:
492 Custom compressor parameters have been removed from the library
493 in favor of the simpler level-based API.
495 Decompressor parameters have been removed entirely.
497 Library users can now specify a custom file for warning and
498 error messages to be sent to, rather than the default of
501 New progress messages:
502 WIMLIB_PROGRESS_MSG_EXTRACT_FILE_STRUCTURE,
503 WIMLIB_PROGRESS_MSG_EXTRACT_METADATA.
505 New function: wimlib_verify_wim().
508 Improved compression, decompression, and extraction performance.
510 Improved compatibility with version 3584 WIM / ESD files:
511 - Add support for reading and writing multiple solid blocks per
512 archive, which WIMGAPI/DISM can create when appending an image.
513 - Correctly create solid blocks larger than 4 GiB.
515 'add' commands passed to wimupdate will now replace existing
516 nondirectory files by default. Use the --no-replace option to get the
519 The license for the library now contains an exception that allows using
520 it under the LGPL. See the COPYING file for details.
522 In reparse-point fixup mode (the default for capture), symbolic links
523 and junctions that point outside the tree being captured are no longer
524 excluded from capture.
526 Added support for "WIMBoot" capture and extraction. See the
527 documentation for the new '--wimboot' option to wimcapture and wimapply
528 for more information.
530 On UNIX-like systems, you can now backup and restore device nodes, named
531 pipes, and sockets. In addition, 32-bit user and group IDs are now
534 The way that UNIX data is stored in WIM files has been changed. If you
535 captured any WIMs with the --unix-data option, to upgrade them you'll
536 need to apply them with --unix-data using wimlib-imagex v1.6.2, then
537 re-capture them with --unix-data using this version.
539 wimlib now understands tagged metadata items, such as object IDs, that
540 can be stored in WIM directory entries.
542 Removed the --hardlink and --symlink options to wimapply, since I don't
543 think they are too useful and they got in the way of improving the code.
545 WIMs will now retain their GUIDs when rebuilt (e.g. with wimoptimize).
547 The 'mkwinpeimg' script now supports writing the ISO image to standard
550 The <ARCH> element in WIM XML data is now exported correctly.
552 On Windows, sparse file attributes are no longer set on extracted files.
553 Oddly enough, this actually saves disk space in some cases.
555 On UNIX, configuring with --disable-xattr or --enable-xattr is no longer
556 supported. Mounting WIM images now always requires extended attribute
557 support. Use --without-fuse to disable support for mounting WIM images;
558 this will also disable the need for extended attribute support.
560 Configuring with --enable-ssse3-sha1 now works correctly.
562 The shared library version has been bumped up. The main
563 incompatibilities are:
565 - WIMLIB_COMPRESSION_TYPE_XPRESS is now 1 and
566 WIMLIB_COMPRESSION_TYPE_LZX is now 2 (so it's the same as
569 - User-provided progress functions are now registered using a
570 separate function, wimlib_register_progress_function(). The
571 'progress_func' argument to many functions no longer exists.
573 - The return value from user-provided progress functions is now
576 - A context argument has been added to the prototype of
577 user-provided progress functions.
579 - 'struct wimlib_capture_config' has been removed. The library
580 now takes the path to the configuration file directly. This
581 affects wimlib_add_image(), wimlib_add_image_multisource(),
582 and wimlib_update_image(). However, a NULL value passed in
583 the argument retains the same meaning.
585 - Removed deprecated functions: some (de)compression functions,
586 wimlib_extract_files(), and wimlib_print_metadata().
588 - Removed extraction flags: WIMLIB_EXTRACT_FLAG_HARDLINK,
589 WIMLIB_EXTRACT_FLAG_SYMLINK, WIMLIB_EXTRACT_FLAG_FILE_ORDER,
590 and WIMLIB_EXTRACT_FLAG_SEQUENTIAL.
592 - Removed some progress messages:
593 WIMLIB_PROGRESS_MSG_APPLY_TIMESTAMPS,
594 WIMLIB_PROGRESS_MSG_EXTRACT_DIR_STRUCTURE_BEGIN,
595 WIMLIB_PROGRESS_MSG_EXTRACT_DIR_STRUCTURE_END. Numbering
598 - Removed some error codes. Numbering stays the same.
600 - Replaced WIMLIB_UNMOUNT_FLAG_LAZY with
601 WIMLIB_UNMOUNT_FLAG_FORCE.
603 - WIM paths passed to progress functions now have a leading
607 Case-insensitive comparisons of strings (e.g. filenames) containing
608 UTF-16 codepoints above 32767 are now done correctly.
610 Fixed build failure on Mac OS X.
612 wimunmount now provides the '--new-image' option to cause changes to a
613 read-write mounted image to be committed as a new image rather than as
614 an update of the mounted image. (The corresponding new library flag is
615 WIMLIB_UNMOUNT_FLAG_NEW_IMAGE.)
617 The LZMS ("recovery") compression chunk size, or "dictionary size", may
618 now be up to 1 GiB (1,073,741,824 bytes).
620 The performance of LZX ("maximum") and LZMS ("recovery") compression
621 with large chunk sizes has been slightly improved.
624 Stored files with size exactly 4 GiB (4,294,967,296 bytes) are now
625 decompressed correctly.
627 Fixed a bug in the LZX compressor introduced in v1.5.3. The bug
628 occurred in an unlikely case, and due to validity checks it did not
629 affect successfully created archives.
631 Fixed a minor compatibility issue with the LZMS compressor and
632 decompressor. This is *not* the default compression type and was only
633 introduced in v1.6.0. In the unlikely event that you created an
634 LZMS-compressed WIM with v1.6.0 and a checksum error is reported when
635 applying it with v1.6.1, decompress it with v1.6.0 then compress it with
638 Memory usage for LZMS and LZX compression has been decreased.
640 wimextract now allows wildcard characters in paths specified on the
641 command line. Also, the '--strict-wildcards' option has been removed
642 and replaced with the inverse option '--nullglob'. See the
643 documentation for wimextract for more details and changes.
645 The wimlib_extract_files() function is now considered deprecated in
646 favor of wimlib_extract_paths().
648 Fixed more permissions problems when extracting files on Windows.
650 A new '--no-attributes' option has been added to wimapply and
651 wimextract. The library flag is WIMLIB_EXTRACT_FLAG_NO_ATTRIBUTES.
653 The default chunk size is now set correctly when changing the
654 compression type of a WIM, for example with 'wimoptimize'.
656 The '--metadata' option to wiminfo has been replaced with the
657 '--detailed' option to wimdir.
659 In relevant wimlib-imagex commands, '--solid' may now be used as an
660 alias for '--pack-streams'.
663 Support for extracting and updating the new version 3584 WIMs has been
664 added. These WIMs typically pack many streams ("files") together into a
665 single compressed resource, thereby saving space. This degrades the
666 performance of random access (such as that which occurs on a mounted
667 image), but optimizations have been implemented for extraction. These
668 new WIM files also typically use a new compression format (LZMS), which
669 is similar to LZMA and can offer a better compression ratio than LZX.
670 These new WIM files can be created using `wimcapture' with
671 the '--compress=lzms --pack-streams' options. Note: this new WIM format
672 is used by the Windows 8 web downloader, but important segments of the
673 raw '.esd' files are encrypted, so wimlib will not be able to extract
674 such files until they are first decrypted.
676 wimlib now supports extracting files and directories from a WIM image
677 based on a "listfile" that itself contains the list of paths to extract.
678 For `wimextract', the syntax is to specify @LISTFILE instead of a PATH,
679 and for the library itself, the new APIs are wimlib_extract_pathlist()
680 and wimlib_extract_paths(). Path globs containing wildcard characters
683 For searching WIM files, wimlib now has configurable case sensitivity.
684 The default on Windows is still case-insensitive and the default on
685 UNIX-like systems is still case-sensitive, but this can be overridden
686 on either platform through flags to wimlib_global_init(). For
687 `wimlib-imagex', the environmental variable WIMLIB_IMAGEX_IGNORE_CASE
688 can be set to 1 or 0 for case-insensitive or case-sensitive behavior,
691 Support for compression chunk sizes greater than the default of 32768
692 bytes has been added. A larger chunk size typically results in a better
693 compression ratio. However, the MS implementation is seemingly not
694 compatible with all chunk sizes, especially for LZX compression, so the
695 defaults remain unchanged, with the exception of the new LZMS-compressed
696 WIMs, which use a larger chunk size by default.
698 The compression/decompression API exported by wimlib has been changed.
699 Now one set of functions handles all supported compression formats.
701 `wimcapture' and `wimappend' will now display the progress of scanning
702 the directory tree to capture, in addition to the progress of writing
703 data to the WIM. The '--verbose' option no longer does anything. The
704 library API change for this is the addition of several members to
705 `struct wimlib_progress_info_scan' available to progress callbacks.
707 `mkwinpeimg' now correctly handles the '--start-script' option when the
708 start script is not in the working directory.
710 Sequential extraction, previously requested by using
711 WIMLIB_EXTRACT_FLAG_SEQUENTIAL, is now the default.
712 WIMLIB_EXTRACT_FLAG_FILE_ORDER can be used to get the old default
713 behavior (extract in file order).
716 The new LZX compressor added in v1.5.2 has been improved and is now
717 enabled by default, except when `wimcapture' or `wimappend' is run
718 *without* the '--compress' option, in which case the faster LZX
719 compressor is used (the same as before). This behavior is reasonably
720 consistent with ImageX which actually uses "fast" (XPRESS) compression
721 by default. In those cases, use '--compress=maximum' to explicitly
722 capture a WIM image using the new (slower but better) LZX compressor.
724 The '--compress-slow' option still exists to `wimlib-imagex optimize',
725 but its new behavior is to tweak the new LZX compressor even more to
726 produce an even better compression ratio at the cost of more time spent
729 `wimlib-imagex optimize' now supports the '--compress=TYPE' option,
730 which recompresses the WIM file using the specified compression TYPE.
731 The new library API function used for this is
732 wimlib_set_output_compression_type().
734 Added the wimlib_get_xml_data() function to allow library clients to
735 easily retrieve the raw XML data from a WIM file if needed.
737 Fixed a bug that could cause an error code to be incorrectly returned
738 when writing XML data containing a <WINDOWS> element.
740 Mounted WIM images will now correctly show the default file stream even
741 if appears in the alternate data stream entries of the corresponding WIM
745 Added a new experimental LZX compressor which can be enabled by passing
746 '--compress-slow' to `wimlib-imagex capture' or `wimlib-imagex
747 optimize'. (The latter is only applicable if the WIM is already
748 LZX-compressed and the '--recompress' option is also given.) The
749 experimental compressor is much slower but compresses the data slightly
750 more --- currently usually to within a fraction of a percent of the
751 results from WIMGAPI/ImageX.
753 A workaround has been added for compatibility with versions of WinPE
754 that interpret alternate data stream entries in the boot WIM
757 An alignment bug that caused a crash in the LZX decompressor on some
760 wimlib now attempts to clear the WIM_HDR_FLAG_WRITE_IN_PROGRESS flag in
761 the WIM header when restoring the previous state of a WIM it failed to
764 Added a workaround to avoid an access denied error on Windows when
765 replacing a WIM file that another process has opened.
768 wimlib can now open WinPE WIMs from WAIK v2.1, which had a quirk that
769 needed to be handled.
771 A bug in the interpretation of negative IMAGE indices in the
772 --update-of=[WIMFILE:]IMAGE option to `wimlib-imagex capture' and
773 `wimlib-imagex append' has been fixed.
775 A workaround has been added to successfully apply security descriptors
776 with empty DACLs when the NTFS-3g apply mode is being used with NTFS-3g
777 2013.1.13 or earlier.
779 `wimlib-imagex capture' can now accept the '--delta-from' option
783 Added support for "pipable" WIMs. Pipable WIMs allow capturing images
784 to standard output and applying images from standard input, but they are
785 not compatible with Microsoft's software and are not created by default.
786 See the documentation for --pipable flag of `wimlib-imagex capture' for
789 To better support incremental backups, added support for declaring an
790 image as a modified form of another image. See the documentation for
791 the '--update-of' option of `wimlib-imagex append' and `wimlib-imagex
794 Added supported for "delta" WIMs. See the documentation for the
795 '--delta-from' option of `wimlib-imagex capture'.
797 The library support for managing split WIMs has been changed to support
798 other arrangements, such as delta WIMs, and be easier to use. This
799 change is visible in `wimlib-imagex', which also can now accept the
800 '--ref' option multiple times, and also now supports "delta" WIMs as
803 wimlib now preserves WIM integrity tables by default, even if
804 WIMLIB_WRITE_FLAG_CHECK_INTEGRITY is not specified. This changes the
805 behavior of `wimlib-imagex' whenever the WIM being operated on contains
806 an integrity table and the '--check' option is not specified.
808 `wimlib-imagex capture' now creates LZX-compressed WIMs by default
809 (when --compress is not specified). This provides the best compression
810 ratio by default, which is usually what is desired, at a cost of some
813 `wimlib-imagex' now supports being invoked as wimCOMMAND, where COMMAND
814 is the command as in `wimlib-imagex COMMAND'; for example, it can be
815 invoked as `wimapply' as an alternative to `wimlib-imagex apply'. The
816 appropriate hard links are created in UNIX installations of
817 `wimlib-imagex', while for the Windows distribution of `wimlib-imagex',
818 batch files that emulate this behavior are generated.
820 Security descriptors are now extracted correctly on Windows.
822 Fixed archiving DOS names in NTFS-3g capture mode.
824 The extraction code has been rewritten and it will now be easier to
825 support new features on all supported backends (currently Win32, UNIX,
826 and NTFS-3g). For example, hard-linked extraction mode (--hardlink) is
827 now supported on all backends, not just UNIX.
829 `mkwinpeimg' now supports grabbing files from the WAIK supplement rather
830 than the WAIK itself.
832 wimlib_global_init() now, by default, attempts to acquire additional
833 privileges on Windows, so library clients need not do this.
835 This update bumps the shared library version number up to 9, since it is
836 not binary compatibible with previous releases.
839 Fixed bug in `wimlib-imagex export' that made it impossible to export an
840 image from a WIM that is readonly at the filesystem level.
842 Return error code rather than segfaulting when trying to list files from
843 a non-first part of a split WIM.
845 Joining a WIM will now preserve the RP_FIX and READONLY flags.
848 On Windows, paths given to wimlib-imagex are now treated case
851 Improved behavior regarding invalid filenames; in particular, on
852 Windows, wimlib-imagex will, when extracting, now omit (with an option
853 to override this default) filenames differing only in case, or filenames
854 containing characters not valid on Windows.
856 On Windows, wimlib now supports capturing and extracting long paths
857 (longer than the so-called MAX_PATH).
859 On Windows, `wimlib-imagex update' now acquires proper privileges when
860 running as an Administrator.
862 `wimlib-imagex update' will now complain if no image is specified when
863 trying to update a multi-image WIM.
865 `wimlib-imagex update' now supports specifying a single update command
866 directly on the command line using the --command option.
868 wimlib-imagex will now choose different units for progress messages,
869 depending on the amount of data that needs to be processed.
871 `wimlib-imagex append' will now generate a unique WIM image name if no
872 name is specified and the defaulted name already exists in the WIM.
874 wimlib now allows you to create unnamed WIM images, which can then only
875 be referred to by index.
877 wimlib now allows you to explicitly declare you want write access to a
878 WIM by providing the WIMLIB_OPEN_FLAG_WRITE_ACCESS flag to
881 wimlib now respects the WIM_HDR_FLAG_READONLY flag when set in the WIM
884 Progress callbacks have been added to wimlib's wimlib_update_image()
887 Added wimlib_get_wim_info(), wimlib_set_wim_info(),
888 wimlib_iterate_dir_tree(), and wimlib_iterate_lookup_table() functions
891 NTFS-3g capture now only warns about two conditions previously treated
894 Fixed a couple issues with using wimlib-imagex on UDF filesystems on
897 wimlib now correctly detects and returns an error when reading a WIM
898 image with a cyclic directory structure. (Fun fact: such a WIM will
899 crash Microsoft's software.)
902 Added new "extract" and "update" subcommands to wimlib-imagex, along
903 with associated APIs in the library. These commands are intended mainly
904 for Windows use but can be used on UNIX as well.
906 Many documentation improvements.
908 Fixed a bug in the Windows build where relative symbolic links were not
909 captured in reparse-point fixup mode.
911 Fixed a bug in the Windows build where file handles were left open to
912 the WIM file, causing `wimlib_imagex optimize' to fail in some cases.
914 Fixed a bug in the Windows build of wimlib-imagex where globbing
915 split-WIM parts could cause the program to crash.
917 Fixed a bug where the creation time of WIM images would be shown instead
918 of the last modification time.
920 With the Windows build it is now possible to restore a WIM containing
921 symbolic links as a non-Administrator; however you will receive warnings
922 about not being able to extract the symbolic links.
925 Capturing a WIM image should now be significantly faster in most cases
926 due to improved use of the operating system's cache and avoiding reading
927 files twice whenever possible.
929 The Windows build should now work on Windows XP.
931 The Windows build now supports capturing and restoring hidden,
932 compressed, sparse, and encrypted files.
934 The Windows build now supports capturing and applying WIM images from
935 filesystems other than NTFS (with some reduced functionality).
937 The Windows build now extracts short names correctly.
939 Added support for "reparse-point" fixups (i.e. fixing up of symbolic
940 links). See docs for --rpfix and --norpfix flags of `wimlib-imagex
941 capture' and `wimlib-imagex apply'.
943 The performance of splitting and joining WIMs should be slightly
946 The LZX and XPRESS compression and decompression functions are now
947 exported from the library.
950 Improvements and bugfixes for the Windows build.
952 Added --strict-acls options.
954 Fixed the way that wimlib determines the order of images in the WIM.
957 Since wimlib can now be used on Windows, wimlib's implementation of
958 ImageX has been renamed to wimlib-imagex to avoid confusion with
959 Microsoft's implementation of ImageX, which would have the same file
960 name ("imagex.exe"). If you really don't like this you can pass the
961 --with-imagex-progname option to `configure' to choose a different name,
962 or even simply rename the binary yourself (but the former way will
963 configure the man pages to use the chosen name).
965 Various bugs fixed in the Windows build. Mainly to do with capturing
966 and restoring alternate data streams correctly in weird cases, and
967 requesting the correct privileges when opening files. Also added the
968 --noacls options to wimlib-imagex capture, append, and apply.
970 Windows build again: FindFirstStreamW() and FindNextStreamW() are now
971 dynamically loaded, so this may make the library compatible with Windows
972 XP (however, there may still be other problems).
975 Added experimental support for native Windows builds. Binaries can be
976 downloaded from the SourceForge page.
978 --source-list option added to `imagex capture' and `imagex append'.
980 Better support for different character encodings.
983 Storing UNIX file owners, groups, and modes in WIM images is now
984 possible using `imagex capture' with the --unix-data flag.
986 Minor bug fixes and documentation fixes.
989 NTFS capture: Fixed capturing duplicate reparse points.
991 NTFS capture: Capture first unnamed stream if there are more than one
992 (print warning instead of error).
994 Allow multiple test cases to execute concurrently (e.g. make -j2 check).
997 Added --arch switch to mkwinpeimg script to support getting AMD64 WinPE
1000 Update to work with ntfs-3g version 2013.1.13.
1003 Fixed truncating file to shorter but non-zero length on read-write
1006 Various code cleanups and minor documentation fixes.
1009 LZX and XPRESS decompression have received some additional optimizations
1010 and should now be even faster. (Although, they were already pretty
1011 fast--- much faster than typical I/O speeds.)
1013 Fixed a bug introduced in v1.2.1 that would cause a directory tree
1014 containing hard links to be captured incorrectly in some cases.
1017 By default, unmounting a read-write mounted WIM with 'imagex unmount
1018 --commit' will now change the WIM in-place without needing to write the
1019 entire WIM again. Use 'imagex unmount --commit --rebuild' to get the
1022 'imagex unmount' no longer has a hard-coded limit of 10 minutes to wait
1023 for a response from the daemon servicing the mounted WIM. Instead,
1024 every second 'imagex unmount' will check if the daemon is still alive,
1025 and keep waiting if so, otherwise terminate with an error.
1027 'imagex unmount --commit' on a read-write mounted WIM will now print
1028 progress information regarding the writing of new or modified streams
1029 the WIM, just like when capturing or appending a WIM.
1031 A small change has been made to XPRESS compression and it should improve
1032 the compression ratio slightly.
1034 A change was made that may improve performance slightly when applying a
1035 WIM image to a NTFS volume.
1037 Microsoft has managed to introduce even more bugs into their software,
1038 and now the WIMs for Windows 8 have incorrect (too low) reference counts
1039 for some streams. This is unsafe because such streams can be removed
1040 when they are in actuality still referenced in the WIM (perhaps by a
1041 different image). wimlib will now work around this problem by fixing
1042 the stream reference counts. This is only done when wimlib_delete_image() is
1043 called ('imagex delete') or when wimlib_mount_image() is called with
1044 WIMLIB_MOUNT_FLAG_READWRITE ('imagex mountrw'). Please note that this
1045 requires reading the metadata for all images in the WIM, so this will
1046 make these operations noticably slower on WIMs with multiple images.
1048 Various other bugfixes.
1051 Appending images to a WIM is now be done by default without re-building
1052 the whole WIM. Use the --rebuild flag to get the old behavior (which
1053 was to re-build the entire WIM when a new image is appended).
1055 A new command `imagex optimize' is now available to manually re-build a
1056 WIM that has wasted space due to repeated appends.
1058 Progress information has been improved, and now arbitrary callback
1059 functions can be used to show the progress of a WIM operation.
1061 A possible bug with changing the bootable image of a WIM was fixed.
1063 Some advisory locking is now done to prevent two processes from
1064 modifying a WIM at the same time (but only in some cases). For example,
1065 you cannot mount two images from a WIM read-write at the same time.
1067 Some functions have been reorganized:
1068 * wimlib_mount() renamed to wimlib_mount_image().
1069 * wimlib_unmount() renamed to wimlib_unmount_image().
1070 * wimlib_overwrite_xml_and_header() removed as
1071 wimlib_overwrite() suffices now.
1072 * wimlib_apply_image_to_ntfs_volume() removed as
1073 wimlib_extract_image() suffices now.
1074 * wimlib_add_image_from_ntfs_volume() removed as
1075 * wimlib_add_image() suffices now.
1077 Previously, the soname of libwim.so has been 0.0.0, despite many
1078 interface changes. The soname is now updated to 1.0.0 and will now be
1079 updated each release.
1082 Resources will now be compressed using multiple threads by default.
1083 (This applies to `imagex capture', `imagex append', and `imagex
1086 Some performance improvements in mounted WIMs.
1088 More progress information is shown when capturing a WIM.
1091 Lots of minor fixes, code cleanups, and some documentation updates.
1092 Nothing in particular is really noteworthy.
1095 LZX and XPRESS compression improvements.
1097 Fixed calculation of Directory Count, File Count, Total Bytes, and Hard
1098 Link Bytes of the WIM.
1101 Fixed bug when capturing NTFS file with multiple named data streams.
1103 Internally, we are now using inode structures, even though these don't
1104 appear literally in the WIM file. This simplifies some of the code
1105 (mainly for WIM mounting) and likely fixed a few problems, although it
1109 Fixed problem when exporting images from XPRESS to LZX compressed WIM or
1113 Enough changes to call it version 1.0.0!
1115 Capturing a WIM directly from a NTFS volume, and applying a WIM directly
1116 to a NTFS volume, is now supported.
1118 Hard links and symbolic links have much improved support. They are
1119 supported for WIM capture, WIM application, and mounted WIMs (you can
1120 even make them on read-write mounted WIMs).
1122 Alternate data streams are now supported on mounted WIMs through an
1123 xattr or a Windows-style stream interface. Also they are supported when
1124 capturing a WIM from NTFS or applying a WIM to NTFS.
1126 Split WIMs are better supported. You may now apply an image directly
1127 from a split WIM, mount an image from a split WIM read-only, or export
1128 an image from a split WIM.
1130 Using a capture configuration file is now supported (but not fully yet).
1132 SHA1 message digests are checked in more places, so we can make sure
1133 applied and captured data is correct.
1135 Man pages have been updated and consolidated.
1138 Fixed segfault when unmounting read-only WIM.
1141 Support for joining and splitting WIMs.
1142 Also, security data is now preserved by default.
1145 Can now build with older gcc and system headers, like on CentOS 5.
1148 Fixed bug that made it impossible to overwrite files in read-write
1152 Write byte-order mark before WIM XML data. (imagex.exe requires this to
git://wimlib.net / wimlib / blob