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