2 Removed OpenSSL (libcrypto) as a dependency of wimlib.
4 Improved the performance of the Windows binaries on CPUs that have SHA-1
7 Removed support for Windows XP.
9 On Windows, wimlib no longer depends on winpthreads.
11 Fixed a bug in 'wimsplit' where it didn't accept part sizes of 4 GiB or
12 larger on Windows and on 32-bit platforms.
15 wimsplit no longer prints a success message on failure.
17 wimlib_iterate_dir_tree() no longer hashes files that haven't yet been
18 written to the WIM file.
20 Reduced the maximum number of file descriptors that wimlib can use when
21 extracting files from a WIM image on macOS.
23 The files that used the CC0 public domain dedication now use the MIT
26 Removed some configuration options (--disable-assertions,
27 --disable-error-messages, and --disable-multithreaded-compression)
28 that probably weren't being used by anyone.
31 Exporting "all" images from a WIM file no longer fails if multiple
32 images in that WIM file have the same name.
34 wimlib now warns rather than aborts if two files have the same SHA-1
35 hash but different sizes.
37 Fixed build errors with the latest version of Mingw-w64.
40 wimsplit now prints progress messages regularly rather than just once
43 Added support for a data recovery mode which causes files to be
44 extracted even if they are corrupted. The option is --recover-data for
45 wimapply and wimextract, and WIMLIB_EXTRACT_FLAG_RECOVER_DATA for the
46 library. Note that this option won't help with all types of corruption;
47 some types of corruption will still cause a fatal error.
50 On Windows, improved performance of capturing an entire drive in some
53 On Windows, fixed leaking a directory handle (or triggering a SEH
54 exception when running under a debugger) when referencing WIM files.
56 On Windows, when applying a Windows OS image using the --compact flag,
57 bootloader files can now be compressed with stronger compression
58 algorithms if the version of Windows is recent enough to support it.
60 Clarified the license text.
63 Prevented miscompilation with gcc 10 at -O3
64 (https://gcc.gnu.org/bugzilla/show_bug.cgi?id=94994).
66 Avoided some compiler warnings with gcc 9 and later.
68 The 'mkwinpeimg' script now also looks for syslinux modules in
69 /usr/share/syslinux, to handle where openSUSE installs them.
71 Removed obsolete packaging files from the source tree.
74 Fixed a crash or incorrect output during LZMS compression with a
75 compression level greater than 50 and a chunk size greater than 64 MiB.
76 This affected wimlib v1.8.0 and later. In the unlikely event that you
77 used all these non-default compression settings in combination, e.g.
78 'wimcapture --solid --solid-compress=LZMS:100 --solid-chunk-size=128M',
79 run 'wimverify' on your archives to verify your data is intact.
82 On Windows, wimlib now supports capturing and applying extended
83 attributes (EAs). It is compatible with DISM with the /EA option,
84 available since Windows 10 version 1607. wimlib's EA support is on by
85 default and works on older versions of Windows too.
87 Partially fixed a bug where [ExclusionException] entries didn't take
88 effect when the containing directory is matched by [ExclusionList]. It
89 now works when the [ExclusionException] patterns are absolute. For
90 example, listing "/dir/file" in [ExclusionException] now works even if
91 "/dir" is matched by [ExclusionList].
93 Added a '--create' option to 'wimappend' which makes it create the WIM
94 file (like 'wimcapture') if it doesn't exist yet.
96 Added an '--include-integrity' option to various wimlib-imagex commands.
97 '--include-integrity' is like '--check', but it will just include an
98 integrity table in the output WIM(s), while skipping verification of any
99 existing integrity tables. This can be useful to avoid unwanted
100 verification of large WIM files, e.g. WIMs given by '--delta-from'.
102 'wimextract' now reads a pathlist file from standard input when "@-" is
103 given as an argument.
105 wimsplit (API: wimlib_split()) now correctly handles a dot in the path
106 to the first split WIM part, prior to the filename extension.
108 'wimlib-imagex --version' now shows the version of the library it is
109 actually using (in case it is different from wimlib-imagex's version).
112 Fixed a bug that was causing the LZMS decompressor to be miscompiled
113 with GCC 7 (this broke extracting "solid" archives).
115 The Windows 10 Recycle Bin directory (\$RECYCLE.BIN) has been added to
116 the default exclusion list.
118 Added a '--quiet' option to wimlib-imagex.
120 The 'mkwinpeimg' script now also looks for the syslinux BIOS modules in
121 the directory /usr/lib/syslinux/modules/bios.
123 Files with timestamps before the year 1970 are now extracted correctly
124 to UNIX-style filesystems, are displayed correctly by
125 'wimdir --detailed', and show up correctly in mounted WIM images.
127 Files with timestamps after the year 2038 are now displayed correctly by
128 the 32-bit Windows build of wimlib.
131 Fixed a data corruption bug (incorrect compression) when storing an
132 already highly-compressed file in an LZX-compressed WIM with a chunk
133 size greater than or equal to 64K. Note that this is not the default
134 setting and such WIMs are not supported by Microsoft's WIM software, so
135 only users who used the --chunk-size option to wimlib-imagex or the
136 wimlib_set_output_chunk_size() API function may have been affected.
137 This bug was introduced in wimlib v1.10.0. See
138 https://wimlib.net/forums/viewtopic.php?f=1&t=300 for more details.
140 On all platforms, sparse files are now extracted as sparse.
142 Sparse files captured from UNIX-style filesystems are now marked as
143 sparse in the resulting WIM image.
145 Added support for storing Linux-style extended attributes in WIM images.
146 When the --unix-data option is used on Linux, wimlib-imagex now captures
147 and applies extended attributes, in addition to the already-supported
148 standard UNIX file permissions (owner/group/mode) and special files.
150 --delta-from is now supported by wimappend. (Previously it was only
151 supported by wimcapture.)
153 On Windows, improved the way in which files deduplicated with Windows'
154 Data Deduplication feature are captured.
156 The development files needed to link with wimlib using Visual Studio are
157 now included in the Windows release archives.
159 wimlib.h can now be included by Visual Studio without errors.
161 The example programs can now be compiled in C++ mode, and they also now
164 Updated 'mkwinpeimg' to work correctly on images that have a "windows"
165 (lower case) directory rather than a "Windows" (upper case) directory.
167 Fixed configuring with --enable-ssse3-sha1 from release tarball
168 (the file nasm_lt.sh was missing).
170 Made some documentation improvements.
173 The LZX compression ratio has been slightly improved. The default mode,
174 LZX level 50, is now almost as good as the old LZX level 100, while
175 being nearly the same speed as before.
177 Decompression performance has been slightly improved.
179 Filenames are now always listed in NTFS collation order.
181 On UNIX-like systems, wimlib can now process Windows filenames that are
182 not valid Unicode due to the presence of unpaired surrogates.
184 On UNIX-like systems, wimlib now always assumes UTF-8 encoding with the
185 addition of surrogate codepoints. Consequently, the environmental
186 variable WIMLIB_IMAGEX_USE_UTF8 and the flag
187 WIMLIB_INIT_FLAG_ASSUME_UTF8 no longer have any effect.
189 wimlib no longer depends on iconv.
191 Reduced memory usage slightly.
193 When a WIM image is applied in NTFS-3G mode, security descriptors are
194 now created in NTFS v3.0 format when supported by the volume.
196 Workarounds for bugs in libntfs-3g version 2013.1.13 and earlier have
197 been removed. Users are advised to upgrade to a later version of
200 On Windows, wimlib now supports case-sensitive filename extraction when
201 supported by the underlying operating system and filesystem (operating
202 system support requires a registry setting).
205 On UNIX, wimlib can now overwrite readonly files when extracting.
207 On Windows, fixed a bug where wimlib could leave a null DACL (a.k.a. "no
208 NTFS permissions") set on some existing directories after extraction.
210 On Windows, when applying a WIM image in "WIMBoot mode" when the WOF
211 driver is not loaded, wimlib can now correctly register a new WIM file
212 with the target volume when the target volume previously had had WIM
215 Added a new testing program.
217 Clarified the main license text and updated public domain dedications
218 for certain files to be more thorough.
221 Object IDs are now saved and restored on Windows and in NTFS-3G mode.
223 Reduced memory usage when exporting large numbers of WIM images.
225 Non UTF-8 locales are now detected correctly.
227 Addressed compiler warnings and enabled "silent" make rules by default.
229 Windows-specific updates:
230 Fixed a bug where duplicate backslashes could be generated in
231 link targets when extracting symbolic links and junctions.
233 Fixed a bug where the .cmd shortcuts for wimlib-imagex wouldn't
234 work if their full path contained a space.
236 Fixed bugs related to scanning SMB filesystems.
238 Added warning message about known issue with WindowsApps folder.
240 Added instructions for building from source on Windows.
242 VSS support is no longer marked "experimental".
244 Added missing license file for libdivsufsort-lite.
247 Added experimental support for Windows VSS (Volume Shadow Copy Service).
248 The new '--snapshot' argument to 'wimcapture' makes wimlib automatically
249 create and use a temporary VSS snapshot when capturing a WIM image.
251 Implemented setting of Windows-specific XML information, such as
252 architecture, system root, and version details. This information is now
253 automatically set in newly captured WIM images, when appropriate.
255 Improved performance of directory tree scans on Windows.
257 On Windows, to improve capture performance, wimlib now sometimes opens
258 files by inode number rather than by path. This is enabled for
259 wimcapture and wimappend, but for now other applications have to opt-in.
261 The progress messages printed by wimlib-imagex while writing WIM files
262 have been slightly tweaked.
264 Progress information for directory tree scans now counts all hard links.
265 Also, on Windows "\\?\" is no longer stripped from the current path.
267 Added a new '--image-property' option to 'wimcapture', 'wimappend', and
268 'wiminfo'. This option lets you assign values to elements in a WIM
269 file's XML document by name.
271 The wimlib_get_image_property() and wimlib_set_image_property() API
272 functions now support numerically indexed elements.
274 Fixed a bug where, on Windows, wimlib would change the security
275 descriptor of the target directory of an extraction even when the
276 '--no-acls' option was specified.
279 Fixed a bug with libntfs-3g extraction present since v1.8.1. Sometimes,
280 some Microsoft software would not correctly recognize data in the
281 resulting filesystem.
283 Made some small improvements to the compression algorithms:
284 LZX compression ratio was slightly improved.
285 XPRESS compression ratio and speed was slightly improved.
286 LZMS compression speed was slightly improved.
288 Improved handling of WIM XML data. wimlib no longer drops unrecognized
289 elements when exporting images. In addition, two API functions were
290 added for better access to elements in the XML document:
291 wimlib_get_image_property() and wimlib_set_image_property().
293 Added support for (unsafe) in-place compaction of WIM files.
295 Improved performance of image export by reusing metadata resources
296 instead of always rebuilding and recompressing them.
298 Improved performance of wimlib_update_image() by delaying the update to
299 the WIM's XML document until a write is requested.
301 On Windows, the target of an extraction may now be a reparse point
302 (which will be dereferenced).
304 On Windows, wimlib now correctly restores non-Microsoft reparse points.
305 However, this remains broken in NTFS-3g mode due to a libntfs-3g bug.
307 On Windows, wimlib now has improved performance when archiving files
308 from a filesystem backed by a WIM (a "WIMBoot" setup).
310 Several improvements to System Compression (compact mode) support:
312 wof.sys (or wofadk.sys) is now automatically attached to the
313 target volume if needed.
315 Compact-mode extractions now work correctly with wofadk.sys on
316 older versions of Windows.
318 For compatibility with the Windows bootloader, the requested
319 compression format now is overridden on certain files.
321 Other minor bugfixes.
324 This release primarily contains various minor bug fixes and
325 improvements, including:
327 Improved handling of deep directory structures.
329 Fixed a bug where on 32-bit systems, the library could enter an
330 infinite loop if a WIM file was malformed in a specific way.
332 Added a workaround for a case where libntfs-3g may report
333 duplicate streams in an NTFS file.
335 Windows symbolic links and junctions in mounted WIM images are
336 now automatically rewritten to be valid in the mounted location.
338 Reparse point fixes: correctly handle the "ReparseReserved"
339 field, and correctly handle "empty" (data-less) reparse points.
341 On Windows, wimlib now acquires SeManageVolumePrivilege, which
342 is needed to create externally backed files using the
345 Improved validation of filenames.
347 Improved LZMS decompression speed.
349 The configure script now honors alternate pkg-config settings.
351 Links have been updated to point to the new website.
353 In addition, experimental support has been added for compressing
354 extracted files using System Compression on Windows 10. This
355 functionality is available through the new '--compact' option to
356 'wimapply' and 'wimextract' as well as new library flags.
359 Fixed a bug in the LZX decompressor: malicious input data could cause
360 out of bounds writes to memory (since wimlib v1.2.2).
362 The output of the 'wiminfo' command now consolidates various boolean
363 flags (such as "Relative path junction") into a single line.
365 A file can now have both an unnamed data stream ("file contents") and a
366 reparse point stream. Such files can exist as a result of the use of
367 certain Windows features, such as offline storage, including "OneDrive".
368 wimlib will now store and restore both streams on Windows as well as in
369 NTFS-3g mode. Microsoft's WIMGAPI also has this behavior.
371 On Windows, named data streams of encrypted files are no longer stored
372 twice in WIM archives.
374 On Windows, named data streams are now correctly extracted to existing
375 "readonly" directories. Before, an error would be reported.
377 On Windows, it is now possible to do a "WIMBoot mode" extraction with
378 non-standalone WIMs such as delta WIMs.
380 On Windows, when doing an extraction in "WIMBoot mode", files larger
381 than 4 gigabytes are now never extracted as externally backed. This
382 works around a bug in Microsoft's "WOF" driver.
384 The '--enable-verify-compression' configure option has been removed. If
385 you want to verify a WIM file, use the 'wimverify' program.
387 The way the "file count", "directory count", "total bytes", and "hard
388 link bytes" image statistics (stored in the WIM XML data) is calculated
389 has been slightly changed.
391 In mounted WIM images, the disk usage provided for each file (st_blocks)
392 is now the compressed size rather than the uncompressed size.
394 The performance of the NTFS-3g and Windows capture modes has been
397 On UNIX-like systems, symbolic links whose targets contain the backslash
398 character are now handled correctly (losslessly).
401 Improved the LZX compressor. It is now 15-20% faster than before and
402 provides a slightly better compression ratio.
404 Improved the LZMS compressor. It now provides a compression ratio
405 slightly better than WIMGAPI while still being faster and using slightly
408 The compression chunk size in solid resources, e.g. when capturing or
409 exporting a WIM file using the '--solid' option, now defaults to 64 MiB
410 (67108864 bytes) instead of 32 MiB (33554432 bytes). This provides a
411 better compression ratio and is the same value that WIMGAPI uses. The
412 memory usage is less than 50% higher than wimlib v1.7.4 and is slightly
413 lower than WIMGAPI's memory usage, but if it is too much, it is still
414 possible to choose a lower value, e.g. with the '--solid-chunk-size'
415 option to wimlib-imagex.
417 The '--chunk-size' and '--solid-chunk-size' options to wimlib-imagex now
418 accept the 'K', 'M', and 'G' suffixes.
420 Files are now sorted by name extension when creating a solid WIM file.
422 Fixed various issues related to capture/apply of EFS-encrypted files on
425 The file list printed by 'wimdir' is now sorted by the platform-specific
426 case sensitivity setting, rather than always case sensitively. This
427 also affects the library function wimlib_iterate_dir_tree().
429 On Windows, some error and warning messages have been improved.
432 The Windows binary distribution no longer contains third party DLLs.
433 These dependencies are instead compiled directly into the libwim DLL.
435 Added more fixes for wimlib on non-x86 architectures such as ARM.
437 Extracting files to a Windows PE in-memory filesystem no longer fails if
438 the target files do not yet exist.
440 Improved the performance of XPRESS compression and LZMS decompression.
442 Enabled SSSE3 accelerated SHA-1 computation in x86_64 Windows builds.
443 It will automatically be faster on newer Intel and AMD processors.
445 Removed the --with-imagex-progname and --enable-more-assertions
449 Fix for very slow export from solid WIM / ESD files.
451 Fix for LZX and LZMS algorithms on non-x86 architectures, such as ARM.
453 New progress message: WIMLIB_PROGRESS_MSG_HANDLE_ERROR. Applications
454 may use this to treat some types of errors as non-fatal.
456 The library now permits making in-memory changes to a WIMStruct backed
457 by a read-only WIM file.
459 Fixes for "WIMBoot" extraction mode (Windows only):
461 When not using the WOF driver, extraction no longer fails if the
462 disk containing the WIM file has too many partitions.
464 When matching patterns in [PrepopulateList], all hard links of
465 each file are now considered.
467 The system registry files are now automatically treated as being
468 in [PrepopulateList].
470 Added a hack to try to work around an intermittent bug in
471 Microsoft's WOF (Windows Overlay Filesystem) driver.
474 Made more improvements to the XPRESS, LZX, and LZMS compressors.
476 A number of improvements to the Windows port:
478 Fixes for setting short filenames.
480 Faster "WIMBoot" extraction.
482 Updated and slimmed down the dependent DLLs.
484 ACL inheritence bits are now restored.
486 Mandatory integrity labels are now backed up and restored.
488 Added a workaround for an issue where in rare cases, wimlib could create
489 a compressed data stream that could not be read correctly by Windows
490 after an extraction in "WIMBoot" mode.
493 Added file count progress data for
494 WIMLIB_PROGRESS_MSG_EXTRACT_FILE_STRUCTURE and
495 WIMLIB_PROGRESS_MSG_EXTRACT_METADATA.
497 Added support for testing file exclusions via the user-provided
500 Some documentation improvements.
502 Made some clarifications to the license text in the COPYING file.
505 Made more improvements to the XPRESS, LZX, and LZMS compressors.
507 The default compression mode for wimcapture is now LZX compression in
508 its default mode, which is the same as '--compress=maximum'.
510 You can now specify an optional integer compression level to the
511 '--compress' option; e.g. '--compress=lzx:75'.
513 Made a minor change to the LZMS compressor and decompressor to fix an
514 incompatibility with the Microsoft implementation. In the unlikely
515 event that you created an LZMS-compressed WIM with wimlib v1.7.0 or
516 earlier and a checksum error is reported when extracting files from it
517 with wimlib v1.7.1, decompress it with v1.7.0 then compress it with
520 Added 'verify' subcommand to wimlib-imagex.
522 Notable library changes:
524 Custom compressor parameters have been removed from the library
525 in favor of the simpler level-based API.
527 Decompressor parameters have been removed entirely.
529 Library users can now specify a custom file for warning and
530 error messages to be sent to, rather than the default of
533 New progress messages:
534 WIMLIB_PROGRESS_MSG_EXTRACT_FILE_STRUCTURE,
535 WIMLIB_PROGRESS_MSG_EXTRACT_METADATA.
537 New function: wimlib_verify_wim().
540 Improved compression, decompression, and extraction performance.
542 Improved compatibility with version 3584 WIM / ESD files:
543 - Add support for reading and writing multiple solid blocks per
544 archive, which WIMGAPI/DISM can create when appending an image.
545 - Correctly create solid blocks larger than 4 GiB.
547 'add' commands passed to wimupdate will now replace existing
548 nondirectory files by default. Use the --no-replace option to get the
551 The license for the library now contains an exception that allows using
552 it under the LGPL. See the COPYING file for details.
554 In reparse-point fixup mode (the default for capture), symbolic links
555 and junctions that point outside the tree being captured are no longer
556 excluded from capture.
558 Added support for "WIMBoot" capture and extraction. See the
559 documentation for the new '--wimboot' option to wimcapture and wimapply
560 for more information.
562 On UNIX-like systems, you can now backup and restore device nodes, named
563 pipes, and sockets. In addition, 32-bit user and group IDs are now
566 The way that UNIX data is stored in WIM files has been changed. If you
567 captured any WIMs with the --unix-data option, to upgrade them you'll
568 need to apply them with --unix-data using wimlib-imagex v1.6.2, then
569 re-capture them with --unix-data using this version.
571 wimlib now understands tagged metadata items, such as object IDs, that
572 can be stored in WIM directory entries.
574 Removed the --hardlink and --symlink options to wimapply, since I don't
575 think they are too useful and they got in the way of improving the code.
577 WIMs will now retain their GUIDs when rebuilt (e.g. with wimoptimize).
579 The 'mkwinpeimg' script now supports writing the ISO image to standard
582 The <ARCH> element in WIM XML data is now exported correctly.
584 On Windows, sparse file attributes are no longer set on extracted files.
585 Oddly enough, this actually saves disk space in some cases.
587 On UNIX, configuring with --disable-xattr or --enable-xattr is no longer
588 supported. Mounting WIM images now always requires extended attribute
589 support. Use --without-fuse to disable support for mounting WIM images;
590 this will also disable the need for extended attribute support.
592 Configuring with --enable-ssse3-sha1 now works correctly.
594 The shared library version has been bumped up. The main
595 incompatibilities are:
597 - WIMLIB_COMPRESSION_TYPE_XPRESS is now 1 and
598 WIMLIB_COMPRESSION_TYPE_LZX is now 2 (so it's the same as
601 - User-provided progress functions are now registered using a
602 separate function, wimlib_register_progress_function(). The
603 'progress_func' argument to many functions no longer exists.
605 - The return value from user-provided progress functions is now
608 - A context argument has been added to the prototype of
609 user-provided progress functions.
611 - 'struct wimlib_capture_config' has been removed. The library
612 now takes the path to the configuration file directly. This
613 affects wimlib_add_image(), wimlib_add_image_multisource(),
614 and wimlib_update_image(). However, a NULL value passed in
615 the argument retains the same meaning.
617 - Removed deprecated functions: some (de)compression functions,
618 wimlib_extract_files(), and wimlib_print_metadata().
620 - Removed extraction flags: WIMLIB_EXTRACT_FLAG_HARDLINK,
621 WIMLIB_EXTRACT_FLAG_SYMLINK, WIMLIB_EXTRACT_FLAG_FILE_ORDER,
622 and WIMLIB_EXTRACT_FLAG_SEQUENTIAL.
624 - Removed some progress messages:
625 WIMLIB_PROGRESS_MSG_APPLY_TIMESTAMPS,
626 WIMLIB_PROGRESS_MSG_EXTRACT_DIR_STRUCTURE_BEGIN,
627 WIMLIB_PROGRESS_MSG_EXTRACT_DIR_STRUCTURE_END. Numbering
630 - Removed some error codes. Numbering stays the same.
632 - Replaced WIMLIB_UNMOUNT_FLAG_LAZY with
633 WIMLIB_UNMOUNT_FLAG_FORCE.
635 - WIM paths passed to progress functions now have a leading
639 Case-insensitive comparisons of strings (e.g. filenames) containing
640 UTF-16 codepoints above 32767 are now done correctly.
642 Fixed build failure on Mac OS X.
644 wimunmount now provides the '--new-image' option to cause changes to a
645 read-write mounted image to be committed as a new image rather than as
646 an update of the mounted image. (The corresponding new library flag is
647 WIMLIB_UNMOUNT_FLAG_NEW_IMAGE.)
649 The LZMS ("recovery") compression chunk size, or "dictionary size", may
650 now be up to 1 GiB (1,073,741,824 bytes).
652 The performance of LZX ("maximum") and LZMS ("recovery") compression
653 with large chunk sizes has been slightly improved.
656 Stored files with size exactly 4 GiB (4,294,967,296 bytes) are now
657 decompressed correctly.
659 Fixed a bug in the LZX compressor introduced in v1.5.3. The bug
660 occurred in an unlikely case, and due to validity checks it did not
661 affect successfully created archives.
663 Fixed a minor compatibility issue with the LZMS compressor and
664 decompressor. This is *not* the default compression type and was only
665 introduced in v1.6.0. In the unlikely event that you created an
666 LZMS-compressed WIM with v1.6.0 and a checksum error is reported when
667 applying it with v1.6.1, decompress it with v1.6.0 then compress it with
670 Memory usage for LZMS and LZX compression has been decreased.
672 wimextract now allows wildcard characters in paths specified on the
673 command line. Also, the '--strict-wildcards' option has been removed
674 and replaced with the inverse option '--nullglob'. See the
675 documentation for wimextract for more details and changes.
677 The wimlib_extract_files() function is now considered deprecated in
678 favor of wimlib_extract_paths().
680 Fixed more permissions problems when extracting files on Windows.
682 A new '--no-attributes' option has been added to wimapply and
683 wimextract. The library flag is WIMLIB_EXTRACT_FLAG_NO_ATTRIBUTES.
685 The default chunk size is now set correctly when changing the
686 compression type of a WIM, for example with 'wimoptimize'.
688 The '--metadata' option to wiminfo has been replaced with the
689 '--detailed' option to wimdir.
691 In relevant wimlib-imagex commands, '--solid' may now be used as an
692 alias for '--pack-streams'.
695 Support for extracting and updating the new version 3584 WIMs has been
696 added. These WIMs typically pack many streams ("files") together into a
697 single compressed resource, thereby saving space. This degrades the
698 performance of random access (such as that which occurs on a mounted
699 image), but optimizations have been implemented for extraction. These
700 new WIM files also typically use a new compression format (LZMS), which
701 is similar to LZMA and can offer a better compression ratio than LZX.
702 These new WIM files can be created using `wimcapture' with
703 the '--compress=lzms --pack-streams' options. Note: this new WIM format
704 is used by the Windows 8 web downloader, but important segments of the
705 raw '.esd' files are encrypted, so wimlib will not be able to extract
706 such files until they are first decrypted.
708 wimlib now supports extracting files and directories from a WIM image
709 based on a "listfile" that itself contains the list of paths to extract.
710 For `wimextract', the syntax is to specify @LISTFILE instead of a PATH,
711 and for the library itself, the new APIs are wimlib_extract_pathlist()
712 and wimlib_extract_paths(). Path globs containing wildcard characters
715 For searching WIM files, wimlib now has configurable case sensitivity.
716 The default on Windows is still case-insensitive and the default on
717 UNIX-like systems is still case-sensitive, but this can be overridden
718 on either platform through flags to wimlib_global_init(). For
719 `wimlib-imagex', the environmental variable WIMLIB_IMAGEX_IGNORE_CASE
720 can be set to 1 or 0 for case-insensitive or case-sensitive behavior,
723 Support for compression chunk sizes greater than the default of 32768
724 bytes has been added. A larger chunk size typically results in a better
725 compression ratio. However, the MS implementation is seemingly not
726 compatible with all chunk sizes, especially for LZX compression, so the
727 defaults remain unchanged, with the exception of the new LZMS-compressed
728 WIMs, which use a larger chunk size by default.
730 The compression/decompression API exported by wimlib has been changed.
731 Now one set of functions handles all supported compression formats.
733 `wimcapture' and `wimappend' will now display the progress of scanning
734 the directory tree to capture, in addition to the progress of writing
735 data to the WIM. The '--verbose' option no longer does anything. The
736 library API change for this is the addition of several members to
737 `struct wimlib_progress_info_scan' available to progress callbacks.
739 `mkwinpeimg' now correctly handles the '--start-script' option when the
740 start script is not in the working directory.
742 Sequential extraction, previously requested by using
743 WIMLIB_EXTRACT_FLAG_SEQUENTIAL, is now the default.
744 WIMLIB_EXTRACT_FLAG_FILE_ORDER can be used to get the old default
745 behavior (extract in file order).
748 The new LZX compressor added in v1.5.2 has been improved and is now
749 enabled by default, except when `wimcapture' or `wimappend' is run
750 *without* the '--compress' option, in which case the faster LZX
751 compressor is used (the same as before). This behavior is reasonably
752 consistent with ImageX which actually uses "fast" (XPRESS) compression
753 by default. In those cases, use '--compress=maximum' to explicitly
754 capture a WIM image using the new (slower but better) LZX compressor.
756 The '--compress-slow' option still exists to `wimlib-imagex optimize',
757 but its new behavior is to tweak the new LZX compressor even more to
758 produce an even better compression ratio at the cost of more time spent
761 `wimlib-imagex optimize' now supports the '--compress=TYPE' option,
762 which recompresses the WIM file using the specified compression TYPE.
763 The new library API function used for this is
764 wimlib_set_output_compression_type().
766 Added the wimlib_get_xml_data() function to allow library clients to
767 easily retrieve the raw XML data from a WIM file if needed.
769 Fixed a bug that could cause an error code to be incorrectly returned
770 when writing XML data containing a <WINDOWS> element.
772 Mounted WIM images will now correctly show the default file stream even
773 if appears in the alternate data stream entries of the corresponding WIM
777 Added a new experimental LZX compressor which can be enabled by passing
778 '--compress-slow' to `wimlib-imagex capture' or `wimlib-imagex
779 optimize'. (The latter is only applicable if the WIM is already
780 LZX-compressed and the '--recompress' option is also given.) The
781 experimental compressor is much slower but compresses the data slightly
782 more --- currently usually to within a fraction of a percent of the
783 results from WIMGAPI/ImageX.
785 A workaround has been added for compatibility with versions of WinPE
786 that interpret alternate data stream entries in the boot WIM
789 An alignment bug that caused a crash in the LZX decompressor on some
792 wimlib now attempts to clear the WIM_HDR_FLAG_WRITE_IN_PROGRESS flag in
793 the WIM header when restoring the previous state of a WIM it failed to
796 Added a workaround to avoid an access denied error on Windows when
797 replacing a WIM file that another process has opened.
800 wimlib can now open WinPE WIMs from WAIK v2.1, which had a quirk that
801 needed to be handled.
803 A bug in the interpretation of negative IMAGE indices in the
804 --update-of=[WIMFILE:]IMAGE option to `wimlib-imagex capture' and
805 `wimlib-imagex append' has been fixed.
807 A workaround has been added to successfully apply security descriptors
808 with empty DACLs when the NTFS-3g apply mode is being used with NTFS-3g
809 2013.1.13 or earlier.
811 `wimlib-imagex capture' can now accept the '--delta-from' option
815 Added support for "pipable" WIMs. Pipable WIMs allow capturing images
816 to standard output and applying images from standard input, but they are
817 not compatible with Microsoft's software and are not created by default.
818 See the documentation for --pipable flag of `wimlib-imagex capture' for
821 To better support incremental backups, added support for declaring an
822 image as a modified form of another image. See the documentation for
823 the '--update-of' option of `wimlib-imagex append' and `wimlib-imagex
826 Added supported for "delta" WIMs. See the documentation for the
827 '--delta-from' option of `wimlib-imagex capture'.
829 The library support for managing split WIMs has been changed to support
830 other arrangements, such as delta WIMs, and be easier to use. This
831 change is visible in `wimlib-imagex', which also can now accept the
832 '--ref' option multiple times, and also now supports "delta" WIMs as
835 wimlib now preserves WIM integrity tables by default, even if
836 WIMLIB_WRITE_FLAG_CHECK_INTEGRITY is not specified. This changes the
837 behavior of `wimlib-imagex' whenever the WIM being operated on contains
838 an integrity table and the '--check' option is not specified.
840 `wimlib-imagex capture' now creates LZX-compressed WIMs by default
841 (when --compress is not specified). This provides the best compression
842 ratio by default, which is usually what is desired, at a cost of some
845 `wimlib-imagex' now supports being invoked as wimCOMMAND, where COMMAND
846 is the command as in `wimlib-imagex COMMAND'; for example, it can be
847 invoked as `wimapply' as an alternative to `wimlib-imagex apply'. The
848 appropriate hard links are created in UNIX installations of
849 `wimlib-imagex', while for the Windows distribution of `wimlib-imagex',
850 batch files that emulate this behavior are generated.
852 Security descriptors are now extracted correctly on Windows.
854 Fixed archiving DOS names in NTFS-3g capture mode.
856 The extraction code has been rewritten and it will now be easier to
857 support new features on all supported backends (currently Win32, UNIX,
858 and NTFS-3g). For example, hard-linked extraction mode (--hardlink) is
859 now supported on all backends, not just UNIX.
861 `mkwinpeimg' now supports grabbing files from the WAIK supplement rather
862 than the WAIK itself.
864 wimlib_global_init() now, by default, attempts to acquire additional
865 privileges on Windows, so library clients need not do this.
867 This update bumps the shared library version number up to 9, since it is
868 not binary compatibible with previous releases.
871 Fixed bug in `wimlib-imagex export' that made it impossible to export an
872 image from a WIM that is readonly at the filesystem level.
874 Return error code rather than segfaulting when trying to list files from
875 a non-first part of a split WIM.
877 Joining a WIM will now preserve the RP_FIX and READONLY flags.
880 On Windows, paths given to wimlib-imagex are now treated case
883 Improved behavior regarding invalid filenames; in particular, on
884 Windows, wimlib-imagex will, when extracting, now omit (with an option
885 to override this default) filenames differing only in case, or filenames
886 containing characters not valid on Windows.
888 On Windows, wimlib now supports capturing and extracting long paths
889 (longer than the so-called MAX_PATH).
891 On Windows, `wimlib-imagex update' now acquires proper privileges when
892 running as an Administrator.
894 `wimlib-imagex update' will now complain if no image is specified when
895 trying to update a multi-image WIM.
897 `wimlib-imagex update' now supports specifying a single update command
898 directly on the command line using the --command option.
900 wimlib-imagex will now choose different units for progress messages,
901 depending on the amount of data that needs to be processed.
903 `wimlib-imagex append' will now generate a unique WIM image name if no
904 name is specified and the defaulted name already exists in the WIM.
906 wimlib now allows you to create unnamed WIM images, which can then only
907 be referred to by index.
909 wimlib now allows you to explicitly declare you want write access to a
910 WIM by providing the WIMLIB_OPEN_FLAG_WRITE_ACCESS flag to
913 wimlib now respects the WIM_HDR_FLAG_READONLY flag when set in the WIM
916 Progress callbacks have been added to wimlib's wimlib_update_image()
919 Added wimlib_get_wim_info(), wimlib_set_wim_info(),
920 wimlib_iterate_dir_tree(), and wimlib_iterate_lookup_table() functions
923 NTFS-3g capture now only warns about two conditions previously treated
926 Fixed a couple issues with using wimlib-imagex on UDF filesystems on
929 wimlib now correctly detects and returns an error when reading a WIM
930 image with a cyclic directory structure. (Fun fact: such a WIM will
931 crash Microsoft's software.)
934 Added new "extract" and "update" subcommands to wimlib-imagex, along
935 with associated APIs in the library. These commands are intended mainly
936 for Windows use but can be used on UNIX as well.
938 Many documentation improvements.
940 Fixed a bug in the Windows build where relative symbolic links were not
941 captured in reparse-point fixup mode.
943 Fixed a bug in the Windows build where file handles were left open to
944 the WIM file, causing `wimlib_imagex optimize' to fail in some cases.
946 Fixed a bug in the Windows build of wimlib-imagex where globbing
947 split-WIM parts could cause the program to crash.
949 Fixed a bug where the creation time of WIM images would be shown instead
950 of the last modification time.
952 With the Windows build it is now possible to restore a WIM containing
953 symbolic links as a non-Administrator; however you will receive warnings
954 about not being able to extract the symbolic links.
957 Capturing a WIM image should now be significantly faster in most cases
958 due to improved use of the operating system's cache and avoiding reading
959 files twice whenever possible.
961 The Windows build should now work on Windows XP.
963 The Windows build now supports capturing and restoring hidden,
964 compressed, sparse, and encrypted files.
966 The Windows build now supports capturing and applying WIM images from
967 filesystems other than NTFS (with some reduced functionality).
969 The Windows build now extracts short names correctly.
971 Added support for "reparse-point" fixups (i.e. fixing up of symbolic
972 links). See docs for --rpfix and --norpfix flags of `wimlib-imagex
973 capture' and `wimlib-imagex apply'.
975 The performance of splitting and joining WIMs should be slightly
978 The LZX and XPRESS compression and decompression functions are now
979 exported from the library.
982 Improvements and bugfixes for the Windows build.
984 Added --strict-acls options.
986 Fixed the way that wimlib determines the order of images in the WIM.
989 Since wimlib can now be used on Windows, wimlib's implementation of
990 ImageX has been renamed to wimlib-imagex to avoid confusion with
991 Microsoft's implementation of ImageX, which would have the same file
992 name ("imagex.exe"). If you really don't like this you can pass the
993 --with-imagex-progname option to `configure' to choose a different name,
994 or even simply rename the binary yourself (but the former way will
995 configure the man pages to use the chosen name).
997 Various bugs fixed in the Windows build. Mainly to do with capturing
998 and restoring alternate data streams correctly in weird cases, and
999 requesting the correct privileges when opening files. Also added the
1000 --noacls options to wimlib-imagex capture, append, and apply.
1002 Windows build again: FindFirstStreamW() and FindNextStreamW() are now
1003 dynamically loaded, so this may make the library compatible with Windows
1004 XP (however, there may still be other problems).
1007 Added experimental support for native Windows builds. Binaries can be
1008 downloaded from the SourceForge page.
1010 --source-list option added to `imagex capture' and `imagex append'.
1012 Better support for different character encodings.
1015 Storing UNIX file owners, groups, and modes in WIM images is now
1016 possible using `imagex capture' with the --unix-data flag.
1018 Minor bug fixes and documentation fixes.
1021 NTFS capture: Fixed capturing duplicate reparse points.
1023 NTFS capture: Capture first unnamed stream if there are more than one
1024 (print warning instead of error).
1026 Allow multiple test cases to execute concurrently (e.g. make -j2 check).
1029 Added --arch switch to mkwinpeimg script to support getting AMD64 WinPE
1032 Update to work with ntfs-3g version 2013.1.13.
1035 Fixed truncating file to shorter but non-zero length on read-write
1038 Various code cleanups and minor documentation fixes.
1041 LZX and XPRESS decompression have received some additional optimizations
1042 and should now be even faster. (Although, they were already pretty
1043 fast--- much faster than typical I/O speeds.)
1045 Fixed a bug introduced in v1.2.1 that would cause a directory tree
1046 containing hard links to be captured incorrectly in some cases.
1049 By default, unmounting a read-write mounted WIM with 'imagex unmount
1050 --commit' will now change the WIM in-place without needing to write the
1051 entire WIM again. Use 'imagex unmount --commit --rebuild' to get the
1054 'imagex unmount' no longer has a hard-coded limit of 10 minutes to wait
1055 for a response from the daemon servicing the mounted WIM. Instead,
1056 every second 'imagex unmount' will check if the daemon is still alive,
1057 and keep waiting if so, otherwise terminate with an error.
1059 'imagex unmount --commit' on a read-write mounted WIM will now print
1060 progress information regarding the writing of new or modified streams
1061 the WIM, just like when capturing or appending a WIM.
1063 A small change has been made to XPRESS compression and it should improve
1064 the compression ratio slightly.
1066 A change was made that may improve performance slightly when applying a
1067 WIM image to a NTFS volume.
1069 Microsoft has managed to introduce even more bugs into their software,
1070 and now the WIMs for Windows 8 have incorrect (too low) reference counts
1071 for some streams. This is unsafe because such streams can be removed
1072 when they are in actuality still referenced in the WIM (perhaps by a
1073 different image). wimlib will now work around this problem by fixing
1074 the stream reference counts. This is only done when wimlib_delete_image() is
1075 called ('imagex delete') or when wimlib_mount_image() is called with
1076 WIMLIB_MOUNT_FLAG_READWRITE ('imagex mountrw'). Please note that this
1077 requires reading the metadata for all images in the WIM, so this will
1078 make these operations noticably slower on WIMs with multiple images.
1080 Various other bugfixes.
1083 Appending images to a WIM is now be done by default without re-building
1084 the whole WIM. Use the --rebuild flag to get the old behavior (which
1085 was to re-build the entire WIM when a new image is appended).
1087 A new command `imagex optimize' is now available to manually re-build a
1088 WIM that has wasted space due to repeated appends.
1090 Progress information has been improved, and now arbitrary callback
1091 functions can be used to show the progress of a WIM operation.
1093 A possible bug with changing the bootable image of a WIM was fixed.
1095 Some advisory locking is now done to prevent two processes from
1096 modifying a WIM at the same time (but only in some cases). For example,
1097 you cannot mount two images from a WIM read-write at the same time.
1099 Some functions have been reorganized:
1100 * wimlib_mount() renamed to wimlib_mount_image().
1101 * wimlib_unmount() renamed to wimlib_unmount_image().
1102 * wimlib_overwrite_xml_and_header() removed as
1103 wimlib_overwrite() suffices now.
1104 * wimlib_apply_image_to_ntfs_volume() removed as
1105 wimlib_extract_image() suffices now.
1106 * wimlib_add_image_from_ntfs_volume() removed as
1107 * wimlib_add_image() suffices now.
1109 Previously, the soname of libwim.so has been 0.0.0, despite many
1110 interface changes. The soname is now updated to 1.0.0 and will now be
1111 updated each release.
1114 Resources will now be compressed using multiple threads by default.
1115 (This applies to `imagex capture', `imagex append', and `imagex
1118 Some performance improvements in mounted WIMs.
1120 More progress information is shown when capturing a WIM.
1123 Lots of minor fixes, code cleanups, and some documentation updates.
1124 Nothing in particular is really noteworthy.
1127 LZX and XPRESS compression improvements.
1129 Fixed calculation of Directory Count, File Count, Total Bytes, and Hard
1130 Link Bytes of the WIM.
1133 Fixed bug when capturing NTFS file with multiple named data streams.
1135 Internally, we are now using inode structures, even though these don't
1136 appear literally in the WIM file. This simplifies some of the code
1137 (mainly for WIM mounting) and likely fixed a few problems, although it
1141 Fixed problem when exporting images from XPRESS to LZX compressed WIM or
1145 Enough changes to call it version 1.0.0!
1147 Capturing a WIM directly from a NTFS volume, and applying a WIM directly
1148 to a NTFS volume, is now supported.
1150 Hard links and symbolic links have much improved support. They are
1151 supported for WIM capture, WIM application, and mounted WIMs (you can
1152 even make them on read-write mounted WIMs).
1154 Alternate data streams are now supported on mounted WIMs through an
1155 xattr or a Windows-style stream interface. Also they are supported when
1156 capturing a WIM from NTFS or applying a WIM to NTFS.
1158 Split WIMs are better supported. You may now apply an image directly
1159 from a split WIM, mount an image from a split WIM read-only, or export
1160 an image from a split WIM.
1162 Using a capture configuration file is now supported (but not fully yet).
1164 SHA1 message digests are checked in more places, so we can make sure
1165 applied and captured data is correct.
1167 Man pages have been updated and consolidated.
1170 Fixed segfault when unmounting read-only WIM.
1173 Support for joining and splitting WIMs.
1174 Also, security data is now preserved by default.
1177 Can now build with older gcc and system headers, like on CentOS 5.
1180 Fixed bug that made it impossible to overwrite files in read-write
1184 Write byte-order mark before WIM XML data. (imagex.exe requires this to
git://wimlib.net / wimlib / blob