2 Removed libxml2 and libcrypto (OpenSSL) as dependencies of wimlib.
3 Also removed winpthreads as a dependency of wimlib on Windows.
5 Improved the performance of the Windows binaries on CPUs that have SHA-1
8 Fixed a bug in 'wimsplit' where it didn't accept part sizes of 4 GiB or
9 larger on Windows and on 32-bit platforms.
11 The README.WINDOWS file and the tools/windows-build.sh script (renamed
12 from 'make-windows-release') have been improved to make it easier to
13 build wimlib on Windows. The instructions now use MSYS2 (instead of
14 Cygwin as they did before), and both gcc and clang are supported.
16 Removed support for Windows XP.
19 wimsplit no longer prints a success message on failure.
21 wimlib_iterate_dir_tree() no longer hashes files that haven't yet been
22 written to the WIM file.
24 Reduced the maximum number of file descriptors that wimlib can use when
25 extracting files from a WIM image on macOS.
27 The files that used the CC0 public domain dedication now use the MIT
30 Removed some configuration options (--disable-assertions,
31 --disable-error-messages, and --disable-multithreaded-compression)
32 that probably weren't being used by anyone.
35 Exporting "all" images from a WIM file no longer fails if multiple
36 images in that WIM file have the same name.
38 wimlib now warns rather than aborts if two files have the same SHA-1
39 hash but different sizes.
41 Fixed build errors with the latest version of Mingw-w64.
44 wimsplit now prints progress messages regularly rather than just once
47 Added support for a data recovery mode which causes files to be
48 extracted even if they are corrupted. The option is --recover-data for
49 wimapply and wimextract, and WIMLIB_EXTRACT_FLAG_RECOVER_DATA for the
50 library. Note that this option won't help with all types of corruption;
51 some types of corruption will still cause a fatal error.
54 On Windows, improved performance of capturing an entire drive in some
57 On Windows, fixed leaking a directory handle (or triggering a SEH
58 exception when running under a debugger) when referencing WIM files.
60 On Windows, when applying a Windows OS image using the --compact flag,
61 bootloader files can now be compressed with stronger compression
62 algorithms if the version of Windows is recent enough to support it.
64 Clarified the license text.
67 Prevented miscompilation with gcc 10 at -O3
68 (https://gcc.gnu.org/bugzilla/show_bug.cgi?id=94994).
70 Avoided some compiler warnings with gcc 9 and later.
72 The 'mkwinpeimg' script now also looks for syslinux modules in
73 /usr/share/syslinux, to handle where openSUSE installs them.
75 Removed obsolete packaging files from the source tree.
78 Fixed a crash or incorrect output during LZMS compression with a
79 compression level greater than 50 and a chunk size greater than 64 MiB.
80 This affected wimlib v1.8.0 and later. In the unlikely event that you
81 used all these non-default compression settings in combination, e.g.
82 'wimcapture --solid --solid-compress=LZMS:100 --solid-chunk-size=128M',
83 run 'wimverify' on your archives to verify your data is intact.
86 On Windows, wimlib now supports capturing and applying extended
87 attributes (EAs). It is compatible with DISM with the /EA option,
88 available since Windows 10 version 1607. wimlib's EA support is on by
89 default and works on older versions of Windows too.
91 Partially fixed a bug where [ExclusionException] entries didn't take
92 effect when the containing directory is matched by [ExclusionList]. It
93 now works when the [ExclusionException] patterns are absolute. For
94 example, listing "/dir/file" in [ExclusionException] now works even if
95 "/dir" is matched by [ExclusionList].
97 Added a '--create' option to 'wimappend' which makes it create the WIM
98 file (like 'wimcapture') if it doesn't exist yet.
100 Added an '--include-integrity' option to various wimlib-imagex commands.
101 '--include-integrity' is like '--check', but it will just include an
102 integrity table in the output WIM(s), while skipping verification of any
103 existing integrity tables. This can be useful to avoid unwanted
104 verification of large WIM files, e.g. WIMs given by '--delta-from'.
106 'wimextract' now reads a pathlist file from standard input when "@-" is
107 given as an argument.
109 wimsplit (API: wimlib_split()) now correctly handles a dot in the path
110 to the first split WIM part, prior to the filename extension.
112 'wimlib-imagex --version' now shows the version of the library it is
113 actually using (in case it is different from wimlib-imagex's version).
116 Fixed a bug that was causing the LZMS decompressor to be miscompiled
117 with GCC 7 (this broke extracting "solid" archives).
119 The Windows 10 Recycle Bin directory (\$RECYCLE.BIN) has been added to
120 the default exclusion list.
122 Added a '--quiet' option to wimlib-imagex.
124 The 'mkwinpeimg' script now also looks for the syslinux BIOS modules in
125 the directory /usr/lib/syslinux/modules/bios.
127 Files with timestamps before the year 1970 are now extracted correctly
128 to UNIX-style filesystems, are displayed correctly by
129 'wimdir --detailed', and show up correctly in mounted WIM images.
131 Files with timestamps after the year 2038 are now displayed correctly by
132 the 32-bit Windows build of wimlib.
135 Fixed a data corruption bug (incorrect compression) when storing an
136 already highly-compressed file in an LZX-compressed WIM with a chunk
137 size greater than or equal to 64K. Note that this is not the default
138 setting and such WIMs are not supported by Microsoft's WIM software, so
139 only users who used the --chunk-size option to wimlib-imagex or the
140 wimlib_set_output_chunk_size() API function may have been affected.
141 This bug was introduced in wimlib v1.10.0. See
142 https://wimlib.net/forums/viewtopic.php?f=1&t=300 for more details.
144 On all platforms, sparse files are now extracted as sparse.
146 Sparse files captured from UNIX-style filesystems are now marked as
147 sparse in the resulting WIM image.
149 Added support for storing Linux-style extended attributes in WIM images.
150 When the --unix-data option is used on Linux, wimlib-imagex now captures
151 and applies extended attributes, in addition to the already-supported
152 standard UNIX file permissions (owner/group/mode) and special files.
154 --delta-from is now supported by wimappend. (Previously it was only
155 supported by wimcapture.)
157 On Windows, improved the way in which files deduplicated with Windows'
158 Data Deduplication feature are captured.
160 The development files needed to link with wimlib using Visual Studio are
161 now included in the Windows release archives.
163 wimlib.h can now be included by Visual Studio without errors.
165 The example programs can now be compiled in C++ mode, and they also now
168 Updated 'mkwinpeimg' to work correctly on images that have a "windows"
169 (lower case) directory rather than a "Windows" (upper case) directory.
171 Fixed configuring with --enable-ssse3-sha1 from release tarball
172 (the file nasm_lt.sh was missing).
174 Made some documentation improvements.
177 The LZX compression ratio has been slightly improved. The default mode,
178 LZX level 50, is now almost as good as the old LZX level 100, while
179 being nearly the same speed as before.
181 Decompression performance has been slightly improved.
183 Filenames are now always listed in NTFS collation order.
185 On UNIX-like systems, wimlib can now process Windows filenames that are
186 not valid Unicode due to the presence of unpaired surrogates.
188 On UNIX-like systems, wimlib now always assumes UTF-8 encoding with the
189 addition of surrogate codepoints. Consequently, the environmental
190 variable WIMLIB_IMAGEX_USE_UTF8 and the flag
191 WIMLIB_INIT_FLAG_ASSUME_UTF8 no longer have any effect.
193 wimlib no longer depends on iconv.
195 Reduced memory usage slightly.
197 When a WIM image is applied in NTFS-3G mode, security descriptors are
198 now created in NTFS v3.0 format when supported by the volume.
200 Workarounds for bugs in libntfs-3g version 2013.1.13 and earlier have
201 been removed. Users are advised to upgrade to a later version of
204 On Windows, wimlib now supports case-sensitive filename extraction when
205 supported by the underlying operating system and filesystem (operating
206 system support requires a registry setting).
209 On UNIX, wimlib can now overwrite readonly files when extracting.
211 On Windows, fixed a bug where wimlib could leave a null DACL (a.k.a. "no
212 NTFS permissions") set on some existing directories after extraction.
214 On Windows, when applying a WIM image in "WIMBoot mode" when the WOF
215 driver is not loaded, wimlib can now correctly register a new WIM file
216 with the target volume when the target volume previously had had WIM
219 Added a new testing program.
221 Clarified the main license text and updated public domain dedications
222 for certain files to be more thorough.
225 Object IDs are now saved and restored on Windows and in NTFS-3G mode.
227 Reduced memory usage when exporting large numbers of WIM images.
229 Non UTF-8 locales are now detected correctly.
231 Addressed compiler warnings and enabled "silent" make rules by default.
233 Windows-specific updates:
234 Fixed a bug where duplicate backslashes could be generated in
235 link targets when extracting symbolic links and junctions.
237 Fixed a bug where the .cmd shortcuts for wimlib-imagex wouldn't
238 work if their full path contained a space.
240 Fixed bugs related to scanning SMB filesystems.
242 Added warning message about known issue with WindowsApps folder.
244 Added instructions for building from source on Windows.
246 VSS support is no longer marked "experimental".
248 Added missing license file for libdivsufsort-lite.
251 Added experimental support for Windows VSS (Volume Shadow Copy Service).
252 The new '--snapshot' argument to 'wimcapture' makes wimlib automatically
253 create and use a temporary VSS snapshot when capturing a WIM image.
255 Implemented setting of Windows-specific XML information, such as
256 architecture, system root, and version details. This information is now
257 automatically set in newly captured WIM images, when appropriate.
259 Improved performance of directory tree scans on Windows.
261 On Windows, to improve capture performance, wimlib now sometimes opens
262 files by inode number rather than by path. This is enabled for
263 wimcapture and wimappend, but for now other applications have to opt-in.
265 The progress messages printed by wimlib-imagex while writing WIM files
266 have been slightly tweaked.
268 Progress information for directory tree scans now counts all hard links.
269 Also, on Windows "\\?\" is no longer stripped from the current path.
271 Added a new '--image-property' option to 'wimcapture', 'wimappend', and
272 'wiminfo'. This option lets you assign values to elements in a WIM
273 file's XML document by name.
275 The wimlib_get_image_property() and wimlib_set_image_property() API
276 functions now support numerically indexed elements.
278 Fixed a bug where, on Windows, wimlib would change the security
279 descriptor of the target directory of an extraction even when the
280 '--no-acls' option was specified.
283 Fixed a bug with libntfs-3g extraction present since v1.8.1. Sometimes,
284 some Microsoft software would not correctly recognize data in the
285 resulting filesystem.
287 Made some small improvements to the compression algorithms:
288 LZX compression ratio was slightly improved.
289 XPRESS compression ratio and speed was slightly improved.
290 LZMS compression speed was slightly improved.
292 Improved handling of WIM XML data. wimlib no longer drops unrecognized
293 elements when exporting images. In addition, two API functions were
294 added for better access to elements in the XML document:
295 wimlib_get_image_property() and wimlib_set_image_property().
297 Added support for (unsafe) in-place compaction of WIM files.
299 Improved performance of image export by reusing metadata resources
300 instead of always rebuilding and recompressing them.
302 Improved performance of wimlib_update_image() by delaying the update to
303 the WIM's XML document until a write is requested.
305 On Windows, the target of an extraction may now be a reparse point
306 (which will be dereferenced).
308 On Windows, wimlib now correctly restores non-Microsoft reparse points.
309 However, this remains broken in NTFS-3g mode due to a libntfs-3g bug.
311 On Windows, wimlib now has improved performance when archiving files
312 from a filesystem backed by a WIM (a "WIMBoot" setup).
314 Several improvements to System Compression (compact mode) support:
316 wof.sys (or wofadk.sys) is now automatically attached to the
317 target volume if needed.
319 Compact-mode extractions now work correctly with wofadk.sys on
320 older versions of Windows.
322 For compatibility with the Windows bootloader, the requested
323 compression format now is overridden on certain files.
325 Other minor bugfixes.
328 This release primarily contains various minor bug fixes and
329 improvements, including:
331 Improved handling of deep directory structures.
333 Fixed a bug where on 32-bit systems, the library could enter an
334 infinite loop if a WIM file was malformed in a specific way.
336 Added a workaround for a case where libntfs-3g may report
337 duplicate streams in an NTFS file.
339 Windows symbolic links and junctions in mounted WIM images are
340 now automatically rewritten to be valid in the mounted location.
342 Reparse point fixes: correctly handle the "ReparseReserved"
343 field, and correctly handle "empty" (data-less) reparse points.
345 On Windows, wimlib now acquires SeManageVolumePrivilege, which
346 is needed to create externally backed files using the
349 Improved validation of filenames.
351 Improved LZMS decompression speed.
353 The configure script now honors alternate pkg-config settings.
355 Links have been updated to point to the new website.
357 In addition, experimental support has been added for compressing
358 extracted files using System Compression on Windows 10. This
359 functionality is available through the new '--compact' option to
360 'wimapply' and 'wimextract' as well as new library flags.
363 Fixed a bug in the LZX decompressor: malicious input data could cause
364 out of bounds writes to memory (since wimlib v1.2.2).
366 The output of the 'wiminfo' command now consolidates various boolean
367 flags (such as "Relative path junction") into a single line.
369 A file can now have both an unnamed data stream ("file contents") and a
370 reparse point stream. Such files can exist as a result of the use of
371 certain Windows features, such as offline storage, including "OneDrive".
372 wimlib will now store and restore both streams on Windows as well as in
373 NTFS-3g mode. Microsoft's WIMGAPI also has this behavior.
375 On Windows, named data streams of encrypted files are no longer stored
376 twice in WIM archives.
378 On Windows, named data streams are now correctly extracted to existing
379 "readonly" directories. Before, an error would be reported.
381 On Windows, it is now possible to do a "WIMBoot mode" extraction with
382 non-standalone WIMs such as delta WIMs.
384 On Windows, when doing an extraction in "WIMBoot mode", files larger
385 than 4 gigabytes are now never extracted as externally backed. This
386 works around a bug in Microsoft's "WOF" driver.
388 The '--enable-verify-compression' configure option has been removed. If
389 you want to verify a WIM file, use the 'wimverify' program.
391 The way the "file count", "directory count", "total bytes", and "hard
392 link bytes" image statistics (stored in the WIM XML data) is calculated
393 has been slightly changed.
395 In mounted WIM images, the disk usage provided for each file (st_blocks)
396 is now the compressed size rather than the uncompressed size.
398 The performance of the NTFS-3g and Windows capture modes has been
401 On UNIX-like systems, symbolic links whose targets contain the backslash
402 character are now handled correctly (losslessly).
405 Improved the LZX compressor. It is now 15-20% faster than before and
406 provides a slightly better compression ratio.
408 Improved the LZMS compressor. It now provides a compression ratio
409 slightly better than WIMGAPI while still being faster and using slightly
412 The compression chunk size in solid resources, e.g. when capturing or
413 exporting a WIM file using the '--solid' option, now defaults to 64 MiB
414 (67108864 bytes) instead of 32 MiB (33554432 bytes). This provides a
415 better compression ratio and is the same value that WIMGAPI uses. The
416 memory usage is less than 50% higher than wimlib v1.7.4 and is slightly
417 lower than WIMGAPI's memory usage, but if it is too much, it is still
418 possible to choose a lower value, e.g. with the '--solid-chunk-size'
419 option to wimlib-imagex.
421 The '--chunk-size' and '--solid-chunk-size' options to wimlib-imagex now
422 accept the 'K', 'M', and 'G' suffixes.
424 Files are now sorted by name extension when creating a solid WIM file.
426 Fixed various issues related to capture/apply of EFS-encrypted files on
429 The file list printed by 'wimdir' is now sorted by the platform-specific
430 case sensitivity setting, rather than always case sensitively. This
431 also affects the library function wimlib_iterate_dir_tree().
433 On Windows, some error and warning messages have been improved.
436 The Windows binary distribution no longer contains third party DLLs.
437 These dependencies are instead compiled directly into the libwim DLL.
439 Added more fixes for wimlib on non-x86 architectures such as ARM.
441 Extracting files to a Windows PE in-memory filesystem no longer fails if
442 the target files do not yet exist.
444 Improved the performance of XPRESS compression and LZMS decompression.
446 Enabled SSSE3 accelerated SHA-1 computation in x86_64 Windows builds.
447 It will automatically be faster on newer Intel and AMD processors.
449 Removed the --with-imagex-progname and --enable-more-assertions
453 Fix for very slow export from solid WIM / ESD files.
455 Fix for LZX and LZMS algorithms on non-x86 architectures, such as ARM.
457 New progress message: WIMLIB_PROGRESS_MSG_HANDLE_ERROR. Applications
458 may use this to treat some types of errors as non-fatal.
460 The library now permits making in-memory changes to a WIMStruct backed
461 by a read-only WIM file.
463 Fixes for "WIMBoot" extraction mode (Windows only):
465 When not using the WOF driver, extraction no longer fails if the
466 disk containing the WIM file has too many partitions.
468 When matching patterns in [PrepopulateList], all hard links of
469 each file are now considered.
471 The system registry files are now automatically treated as being
472 in [PrepopulateList].
474 Added a hack to try to work around an intermittent bug in
475 Microsoft's WOF (Windows Overlay Filesystem) driver.
478 Made more improvements to the XPRESS, LZX, and LZMS compressors.
480 A number of improvements to the Windows port:
482 Fixes for setting short filenames.
484 Faster "WIMBoot" extraction.
486 Updated and slimmed down the dependent DLLs.
488 ACL inheritence bits are now restored.
490 Mandatory integrity labels are now backed up and restored.
492 Added a workaround for an issue where in rare cases, wimlib could create
493 a compressed data stream that could not be read correctly by Windows
494 after an extraction in "WIMBoot" mode.
497 Added file count progress data for
498 WIMLIB_PROGRESS_MSG_EXTRACT_FILE_STRUCTURE and
499 WIMLIB_PROGRESS_MSG_EXTRACT_METADATA.
501 Added support for testing file exclusions via the user-provided
504 Some documentation improvements.
506 Made some clarifications to the license text in the COPYING file.
509 Made more improvements to the XPRESS, LZX, and LZMS compressors.
511 The default compression mode for wimcapture is now LZX compression in
512 its default mode, which is the same as '--compress=maximum'.
514 You can now specify an optional integer compression level to the
515 '--compress' option; e.g. '--compress=lzx:75'.
517 Made a minor change to the LZMS compressor and decompressor to fix an
518 incompatibility with the Microsoft implementation. In the unlikely
519 event that you created an LZMS-compressed WIM with wimlib v1.7.0 or
520 earlier and a checksum error is reported when extracting files from it
521 with wimlib v1.7.1, decompress it with v1.7.0 then compress it with
524 Added 'verify' subcommand to wimlib-imagex.
526 Notable library changes:
528 Custom compressor parameters have been removed from the library
529 in favor of the simpler level-based API.
531 Decompressor parameters have been removed entirely.
533 Library users can now specify a custom file for warning and
534 error messages to be sent to, rather than the default of
537 New progress messages:
538 WIMLIB_PROGRESS_MSG_EXTRACT_FILE_STRUCTURE,
539 WIMLIB_PROGRESS_MSG_EXTRACT_METADATA.
541 New function: wimlib_verify_wim().
544 Improved compression, decompression, and extraction performance.
546 Improved compatibility with version 3584 WIM / ESD files:
547 - Add support for reading and writing multiple solid blocks per
548 archive, which WIMGAPI/DISM can create when appending an image.
549 - Correctly create solid blocks larger than 4 GiB.
551 'add' commands passed to wimupdate will now replace existing
552 nondirectory files by default. Use the --no-replace option to get the
555 The license for the library now contains an exception that allows using
556 it under the LGPL. See the COPYING file for details.
558 In reparse-point fixup mode (the default for capture), symbolic links
559 and junctions that point outside the tree being captured are no longer
560 excluded from capture.
562 Added support for "WIMBoot" capture and extraction. See the
563 documentation for the new '--wimboot' option to wimcapture and wimapply
564 for more information.
566 On UNIX-like systems, you can now backup and restore device nodes, named
567 pipes, and sockets. In addition, 32-bit user and group IDs are now
570 The way that UNIX data is stored in WIM files has been changed. If you
571 captured any WIMs with the --unix-data option, to upgrade them you'll
572 need to apply them with --unix-data using wimlib-imagex v1.6.2, then
573 re-capture them with --unix-data using this version.
575 wimlib now understands tagged metadata items, such as object IDs, that
576 can be stored in WIM directory entries.
578 Removed the --hardlink and --symlink options to wimapply, since I don't
579 think they are too useful and they got in the way of improving the code.
581 WIMs will now retain their GUIDs when rebuilt (e.g. with wimoptimize).
583 The 'mkwinpeimg' script now supports writing the ISO image to standard
586 The <ARCH> element in WIM XML data is now exported correctly.
588 On Windows, sparse file attributes are no longer set on extracted files.
589 Oddly enough, this actually saves disk space in some cases.
591 On UNIX, configuring with --disable-xattr or --enable-xattr is no longer
592 supported. Mounting WIM images now always requires extended attribute
593 support. Use --without-fuse to disable support for mounting WIM images;
594 this will also disable the need for extended attribute support.
596 Configuring with --enable-ssse3-sha1 now works correctly.
598 The shared library version has been bumped up. The main
599 incompatibilities are:
601 - WIMLIB_COMPRESSION_TYPE_XPRESS is now 1 and
602 WIMLIB_COMPRESSION_TYPE_LZX is now 2 (so it's the same as
605 - User-provided progress functions are now registered using a
606 separate function, wimlib_register_progress_function(). The
607 'progress_func' argument to many functions no longer exists.
609 - The return value from user-provided progress functions is now
612 - A context argument has been added to the prototype of
613 user-provided progress functions.
615 - 'struct wimlib_capture_config' has been removed. The library
616 now takes the path to the configuration file directly. This
617 affects wimlib_add_image(), wimlib_add_image_multisource(),
618 and wimlib_update_image(). However, a NULL value passed in
619 the argument retains the same meaning.
621 - Removed deprecated functions: some (de)compression functions,
622 wimlib_extract_files(), and wimlib_print_metadata().
624 - Removed extraction flags: WIMLIB_EXTRACT_FLAG_HARDLINK,
625 WIMLIB_EXTRACT_FLAG_SYMLINK, WIMLIB_EXTRACT_FLAG_FILE_ORDER,
626 and WIMLIB_EXTRACT_FLAG_SEQUENTIAL.
628 - Removed some progress messages:
629 WIMLIB_PROGRESS_MSG_APPLY_TIMESTAMPS,
630 WIMLIB_PROGRESS_MSG_EXTRACT_DIR_STRUCTURE_BEGIN,
631 WIMLIB_PROGRESS_MSG_EXTRACT_DIR_STRUCTURE_END. Numbering
634 - Removed some error codes. Numbering stays the same.
636 - Replaced WIMLIB_UNMOUNT_FLAG_LAZY with
637 WIMLIB_UNMOUNT_FLAG_FORCE.
639 - WIM paths passed to progress functions now have a leading
643 Case-insensitive comparisons of strings (e.g. filenames) containing
644 UTF-16 codepoints above 32767 are now done correctly.
646 Fixed build failure on Mac OS X.
648 wimunmount now provides the '--new-image' option to cause changes to a
649 read-write mounted image to be committed as a new image rather than as
650 an update of the mounted image. (The corresponding new library flag is
651 WIMLIB_UNMOUNT_FLAG_NEW_IMAGE.)
653 The LZMS ("recovery") compression chunk size, or "dictionary size", may
654 now be up to 1 GiB (1,073,741,824 bytes).
656 The performance of LZX ("maximum") and LZMS ("recovery") compression
657 with large chunk sizes has been slightly improved.
660 Stored files with size exactly 4 GiB (4,294,967,296 bytes) are now
661 decompressed correctly.
663 Fixed a bug in the LZX compressor introduced in v1.5.3. The bug
664 occurred in an unlikely case, and due to validity checks it did not
665 affect successfully created archives.
667 Fixed a minor compatibility issue with the LZMS compressor and
668 decompressor. This is *not* the default compression type and was only
669 introduced in v1.6.0. In the unlikely event that you created an
670 LZMS-compressed WIM with v1.6.0 and a checksum error is reported when
671 applying it with v1.6.1, decompress it with v1.6.0 then compress it with
674 Memory usage for LZMS and LZX compression has been decreased.
676 wimextract now allows wildcard characters in paths specified on the
677 command line. Also, the '--strict-wildcards' option has been removed
678 and replaced with the inverse option '--nullglob'. See the
679 documentation for wimextract for more details and changes.
681 The wimlib_extract_files() function is now considered deprecated in
682 favor of wimlib_extract_paths().
684 Fixed more permissions problems when extracting files on Windows.
686 A new '--no-attributes' option has been added to wimapply and
687 wimextract. The library flag is WIMLIB_EXTRACT_FLAG_NO_ATTRIBUTES.
689 The default chunk size is now set correctly when changing the
690 compression type of a WIM, for example with 'wimoptimize'.
692 The '--metadata' option to wiminfo has been replaced with the
693 '--detailed' option to wimdir.
695 In relevant wimlib-imagex commands, '--solid' may now be used as an
696 alias for '--pack-streams'.
699 Support for extracting and updating the new version 3584 WIMs has been
700 added. These WIMs typically pack many streams ("files") together into a
701 single compressed resource, thereby saving space. This degrades the
702 performance of random access (such as that which occurs on a mounted
703 image), but optimizations have been implemented for extraction. These
704 new WIM files also typically use a new compression format (LZMS), which
705 is similar to LZMA and can offer a better compression ratio than LZX.
706 These new WIM files can be created using `wimcapture' with
707 the '--compress=lzms --pack-streams' options. Note: this new WIM format
708 is used by the Windows 8 web downloader, but important segments of the
709 raw '.esd' files are encrypted, so wimlib will not be able to extract
710 such files until they are first decrypted.
712 wimlib now supports extracting files and directories from a WIM image
713 based on a "listfile" that itself contains the list of paths to extract.
714 For `wimextract', the syntax is to specify @LISTFILE instead of a PATH,
715 and for the library itself, the new APIs are wimlib_extract_pathlist()
716 and wimlib_extract_paths(). Path globs containing wildcard characters
719 For searching WIM files, wimlib now has configurable case sensitivity.
720 The default on Windows is still case-insensitive and the default on
721 UNIX-like systems is still case-sensitive, but this can be overridden
722 on either platform through flags to wimlib_global_init(). For
723 `wimlib-imagex', the environmental variable WIMLIB_IMAGEX_IGNORE_CASE
724 can be set to 1 or 0 for case-insensitive or case-sensitive behavior,
727 Support for compression chunk sizes greater than the default of 32768
728 bytes has been added. A larger chunk size typically results in a better
729 compression ratio. However, the MS implementation is seemingly not
730 compatible with all chunk sizes, especially for LZX compression, so the
731 defaults remain unchanged, with the exception of the new LZMS-compressed
732 WIMs, which use a larger chunk size by default.
734 The compression/decompression API exported by wimlib has been changed.
735 Now one set of functions handles all supported compression formats.
737 `wimcapture' and `wimappend' will now display the progress of scanning
738 the directory tree to capture, in addition to the progress of writing
739 data to the WIM. The '--verbose' option no longer does anything. The
740 library API change for this is the addition of several members to
741 `struct wimlib_progress_info_scan' available to progress callbacks.
743 `mkwinpeimg' now correctly handles the '--start-script' option when the
744 start script is not in the working directory.
746 Sequential extraction, previously requested by using
747 WIMLIB_EXTRACT_FLAG_SEQUENTIAL, is now the default.
748 WIMLIB_EXTRACT_FLAG_FILE_ORDER can be used to get the old default
749 behavior (extract in file order).
752 The new LZX compressor added in v1.5.2 has been improved and is now
753 enabled by default, except when `wimcapture' or `wimappend' is run
754 *without* the '--compress' option, in which case the faster LZX
755 compressor is used (the same as before). This behavior is reasonably
756 consistent with ImageX which actually uses "fast" (XPRESS) compression
757 by default. In those cases, use '--compress=maximum' to explicitly
758 capture a WIM image using the new (slower but better) LZX compressor.
760 The '--compress-slow' option still exists to `wimlib-imagex optimize',
761 but its new behavior is to tweak the new LZX compressor even more to
762 produce an even better compression ratio at the cost of more time spent
765 `wimlib-imagex optimize' now supports the '--compress=TYPE' option,
766 which recompresses the WIM file using the specified compression TYPE.
767 The new library API function used for this is
768 wimlib_set_output_compression_type().
770 Added the wimlib_get_xml_data() function to allow library clients to
771 easily retrieve the raw XML data from a WIM file if needed.
773 Fixed a bug that could cause an error code to be incorrectly returned
774 when writing XML data containing a <WINDOWS> element.
776 Mounted WIM images will now correctly show the default file stream even
777 if appears in the alternate data stream entries of the corresponding WIM
781 Added a new experimental LZX compressor which can be enabled by passing
782 '--compress-slow' to `wimlib-imagex capture' or `wimlib-imagex
783 optimize'. (The latter is only applicable if the WIM is already
784 LZX-compressed and the '--recompress' option is also given.) The
785 experimental compressor is much slower but compresses the data slightly
786 more --- currently usually to within a fraction of a percent of the
787 results from WIMGAPI/ImageX.
789 A workaround has been added for compatibility with versions of WinPE
790 that interpret alternate data stream entries in the boot WIM
793 An alignment bug that caused a crash in the LZX decompressor on some
796 wimlib now attempts to clear the WIM_HDR_FLAG_WRITE_IN_PROGRESS flag in
797 the WIM header when restoring the previous state of a WIM it failed to
800 Added a workaround to avoid an access denied error on Windows when
801 replacing a WIM file that another process has opened.
804 wimlib can now open WinPE WIMs from WAIK v2.1, which had a quirk that
805 needed to be handled.
807 A bug in the interpretation of negative IMAGE indices in the
808 --update-of=[WIMFILE:]IMAGE option to `wimlib-imagex capture' and
809 `wimlib-imagex append' has been fixed.
811 A workaround has been added to successfully apply security descriptors
812 with empty DACLs when the NTFS-3g apply mode is being used with NTFS-3g
813 2013.1.13 or earlier.
815 `wimlib-imagex capture' can now accept the '--delta-from' option
819 Added support for "pipable" WIMs. Pipable WIMs allow capturing images
820 to standard output and applying images from standard input, but they are
821 not compatible with Microsoft's software and are not created by default.
822 See the documentation for --pipable flag of `wimlib-imagex capture' for
825 To better support incremental backups, added support for declaring an
826 image as a modified form of another image. See the documentation for
827 the '--update-of' option of `wimlib-imagex append' and `wimlib-imagex
830 Added supported for "delta" WIMs. See the documentation for the
831 '--delta-from' option of `wimlib-imagex capture'.
833 The library support for managing split WIMs has been changed to support
834 other arrangements, such as delta WIMs, and be easier to use. This
835 change is visible in `wimlib-imagex', which also can now accept the
836 '--ref' option multiple times, and also now supports "delta" WIMs as
839 wimlib now preserves WIM integrity tables by default, even if
840 WIMLIB_WRITE_FLAG_CHECK_INTEGRITY is not specified. This changes the
841 behavior of `wimlib-imagex' whenever the WIM being operated on contains
842 an integrity table and the '--check' option is not specified.
844 `wimlib-imagex capture' now creates LZX-compressed WIMs by default
845 (when --compress is not specified). This provides the best compression
846 ratio by default, which is usually what is desired, at a cost of some
849 `wimlib-imagex' now supports being invoked as wimCOMMAND, where COMMAND
850 is the command as in `wimlib-imagex COMMAND'; for example, it can be
851 invoked as `wimapply' as an alternative to `wimlib-imagex apply'. The
852 appropriate hard links are created in UNIX installations of
853 `wimlib-imagex', while for the Windows distribution of `wimlib-imagex',
854 batch files that emulate this behavior are generated.
856 Security descriptors are now extracted correctly on Windows.
858 Fixed archiving DOS names in NTFS-3g capture mode.
860 The extraction code has been rewritten and it will now be easier to
861 support new features on all supported backends (currently Win32, UNIX,
862 and NTFS-3g). For example, hard-linked extraction mode (--hardlink) is
863 now supported on all backends, not just UNIX.
865 `mkwinpeimg' now supports grabbing files from the WAIK supplement rather
866 than the WAIK itself.
868 wimlib_global_init() now, by default, attempts to acquire additional
869 privileges on Windows, so library clients need not do this.
871 This update bumps the shared library version number up to 9, since it is
872 not binary compatibible with previous releases.
875 Fixed bug in `wimlib-imagex export' that made it impossible to export an
876 image from a WIM that is readonly at the filesystem level.
878 Return error code rather than segfaulting when trying to list files from
879 a non-first part of a split WIM.
881 Joining a WIM will now preserve the RP_FIX and READONLY flags.
884 On Windows, paths given to wimlib-imagex are now treated case
887 Improved behavior regarding invalid filenames; in particular, on
888 Windows, wimlib-imagex will, when extracting, now omit (with an option
889 to override this default) filenames differing only in case, or filenames
890 containing characters not valid on Windows.
892 On Windows, wimlib now supports capturing and extracting long paths
893 (longer than the so-called MAX_PATH).
895 On Windows, `wimlib-imagex update' now acquires proper privileges when
896 running as an Administrator.
898 `wimlib-imagex update' will now complain if no image is specified when
899 trying to update a multi-image WIM.
901 `wimlib-imagex update' now supports specifying a single update command
902 directly on the command line using the --command option.
904 wimlib-imagex will now choose different units for progress messages,
905 depending on the amount of data that needs to be processed.
907 `wimlib-imagex append' will now generate a unique WIM image name if no
908 name is specified and the defaulted name already exists in the WIM.
910 wimlib now allows you to create unnamed WIM images, which can then only
911 be referred to by index.
913 wimlib now allows you to explicitly declare you want write access to a
914 WIM by providing the WIMLIB_OPEN_FLAG_WRITE_ACCESS flag to
917 wimlib now respects the WIM_HDR_FLAG_READONLY flag when set in the WIM
920 Progress callbacks have been added to wimlib's wimlib_update_image()
923 Added wimlib_get_wim_info(), wimlib_set_wim_info(),
924 wimlib_iterate_dir_tree(), and wimlib_iterate_lookup_table() functions
927 NTFS-3g capture now only warns about two conditions previously treated
930 Fixed a couple issues with using wimlib-imagex on UDF filesystems on
933 wimlib now correctly detects and returns an error when reading a WIM
934 image with a cyclic directory structure. (Fun fact: such a WIM will
935 crash Microsoft's software.)
938 Added new "extract" and "update" subcommands to wimlib-imagex, along
939 with associated APIs in the library. These commands are intended mainly
940 for Windows use but can be used on UNIX as well.
942 Many documentation improvements.
944 Fixed a bug in the Windows build where relative symbolic links were not
945 captured in reparse-point fixup mode.
947 Fixed a bug in the Windows build where file handles were left open to
948 the WIM file, causing `wimlib_imagex optimize' to fail in some cases.
950 Fixed a bug in the Windows build of wimlib-imagex where globbing
951 split-WIM parts could cause the program to crash.
953 Fixed a bug where the creation time of WIM images would be shown instead
954 of the last modification time.
956 With the Windows build it is now possible to restore a WIM containing
957 symbolic links as a non-Administrator; however you will receive warnings
958 about not being able to extract the symbolic links.
961 Capturing a WIM image should now be significantly faster in most cases
962 due to improved use of the operating system's cache and avoiding reading
963 files twice whenever possible.
965 The Windows build should now work on Windows XP.
967 The Windows build now supports capturing and restoring hidden,
968 compressed, sparse, and encrypted files.
970 The Windows build now supports capturing and applying WIM images from
971 filesystems other than NTFS (with some reduced functionality).
973 The Windows build now extracts short names correctly.
975 Added support for "reparse-point" fixups (i.e. fixing up of symbolic
976 links). See docs for --rpfix and --norpfix flags of `wimlib-imagex
977 capture' and `wimlib-imagex apply'.
979 The performance of splitting and joining WIMs should be slightly
982 The LZX and XPRESS compression and decompression functions are now
983 exported from the library.
986 Improvements and bugfixes for the Windows build.
988 Added --strict-acls options.
990 Fixed the way that wimlib determines the order of images in the WIM.
993 Since wimlib can now be used on Windows, wimlib's implementation of
994 ImageX has been renamed to wimlib-imagex to avoid confusion with
995 Microsoft's implementation of ImageX, which would have the same file
996 name ("imagex.exe"). If you really don't like this you can pass the
997 --with-imagex-progname option to `configure' to choose a different name,
998 or even simply rename the binary yourself (but the former way will
999 configure the man pages to use the chosen name).
1001 Various bugs fixed in the Windows build. Mainly to do with capturing
1002 and restoring alternate data streams correctly in weird cases, and
1003 requesting the correct privileges when opening files. Also added the
1004 --noacls options to wimlib-imagex capture, append, and apply.
1006 Windows build again: FindFirstStreamW() and FindNextStreamW() are now
1007 dynamically loaded, so this may make the library compatible with Windows
1008 XP (however, there may still be other problems).
1011 Added experimental support for native Windows builds. Binaries can be
1012 downloaded from the SourceForge page.
1014 --source-list option added to `imagex capture' and `imagex append'.
1016 Better support for different character encodings.
1019 Storing UNIX file owners, groups, and modes in WIM images is now
1020 possible using `imagex capture' with the --unix-data flag.
1022 Minor bug fixes and documentation fixes.
1025 NTFS capture: Fixed capturing duplicate reparse points.
1027 NTFS capture: Capture first unnamed stream if there are more than one
1028 (print warning instead of error).
1030 Allow multiple test cases to execute concurrently (e.g. make -j2 check).
1033 Added --arch switch to mkwinpeimg script to support getting AMD64 WinPE
1036 Update to work with ntfs-3g version 2013.1.13.
1039 Fixed truncating file to shorter but non-zero length on read-write
1042 Various code cleanups and minor documentation fixes.
1045 LZX and XPRESS decompression have received some additional optimizations
1046 and should now be even faster. (Although, they were already pretty
1047 fast--- much faster than typical I/O speeds.)
1049 Fixed a bug introduced in v1.2.1 that would cause a directory tree
1050 containing hard links to be captured incorrectly in some cases.
1053 By default, unmounting a read-write mounted WIM with 'imagex unmount
1054 --commit' will now change the WIM in-place without needing to write the
1055 entire WIM again. Use 'imagex unmount --commit --rebuild' to get the
1058 'imagex unmount' no longer has a hard-coded limit of 10 minutes to wait
1059 for a response from the daemon servicing the mounted WIM. Instead,
1060 every second 'imagex unmount' will check if the daemon is still alive,
1061 and keep waiting if so, otherwise terminate with an error.
1063 'imagex unmount --commit' on a read-write mounted WIM will now print
1064 progress information regarding the writing of new or modified streams
1065 the WIM, just like when capturing or appending a WIM.
1067 A small change has been made to XPRESS compression and it should improve
1068 the compression ratio slightly.
1070 A change was made that may improve performance slightly when applying a
1071 WIM image to a NTFS volume.
1073 Microsoft has managed to introduce even more bugs into their software,
1074 and now the WIMs for Windows 8 have incorrect (too low) reference counts
1075 for some streams. This is unsafe because such streams can be removed
1076 when they are in actuality still referenced in the WIM (perhaps by a
1077 different image). wimlib will now work around this problem by fixing
1078 the stream reference counts. This is only done when wimlib_delete_image() is
1079 called ('imagex delete') or when wimlib_mount_image() is called with
1080 WIMLIB_MOUNT_FLAG_READWRITE ('imagex mountrw'). Please note that this
1081 requires reading the metadata for all images in the WIM, so this will
1082 make these operations noticably slower on WIMs with multiple images.
1084 Various other bugfixes.
1087 Appending images to a WIM is now be done by default without re-building
1088 the whole WIM. Use the --rebuild flag to get the old behavior (which
1089 was to re-build the entire WIM when a new image is appended).
1091 A new command `imagex optimize' is now available to manually re-build a
1092 WIM that has wasted space due to repeated appends.
1094 Progress information has been improved, and now arbitrary callback
1095 functions can be used to show the progress of a WIM operation.
1097 A possible bug with changing the bootable image of a WIM was fixed.
1099 Some advisory locking is now done to prevent two processes from
1100 modifying a WIM at the same time (but only in some cases). For example,
1101 you cannot mount two images from a WIM read-write at the same time.
1103 Some functions have been reorganized:
1104 * wimlib_mount() renamed to wimlib_mount_image().
1105 * wimlib_unmount() renamed to wimlib_unmount_image().
1106 * wimlib_overwrite_xml_and_header() removed as
1107 wimlib_overwrite() suffices now.
1108 * wimlib_apply_image_to_ntfs_volume() removed as
1109 wimlib_extract_image() suffices now.
1110 * wimlib_add_image_from_ntfs_volume() removed as
1111 * wimlib_add_image() suffices now.
1113 Previously, the soname of libwim.so has been 0.0.0, despite many
1114 interface changes. The soname is now updated to 1.0.0 and will now be
1115 updated each release.
1118 Resources will now be compressed using multiple threads by default.
1119 (This applies to `imagex capture', `imagex append', and `imagex
1122 Some performance improvements in mounted WIMs.
1124 More progress information is shown when capturing a WIM.
1127 Lots of minor fixes, code cleanups, and some documentation updates.
1128 Nothing in particular is really noteworthy.
1131 LZX and XPRESS compression improvements.
1133 Fixed calculation of Directory Count, File Count, Total Bytes, and Hard
1134 Link Bytes of the WIM.
1137 Fixed bug when capturing NTFS file with multiple named data streams.
1139 Internally, we are now using inode structures, even though these don't
1140 appear literally in the WIM file. This simplifies some of the code
1141 (mainly for WIM mounting) and likely fixed a few problems, although it
1145 Fixed problem when exporting images from XPRESS to LZX compressed WIM or
1149 Enough changes to call it version 1.0.0!
1151 Capturing a WIM directly from a NTFS volume, and applying a WIM directly
1152 to a NTFS volume, is now supported.
1154 Hard links and symbolic links have much improved support. They are
1155 supported for WIM capture, WIM application, and mounted WIMs (you can
1156 even make them on read-write mounted WIMs).
1158 Alternate data streams are now supported on mounted WIMs through an
1159 xattr or a Windows-style stream interface. Also they are supported when
1160 capturing a WIM from NTFS or applying a WIM to NTFS.
1162 Split WIMs are better supported. You may now apply an image directly
1163 from a split WIM, mount an image from a split WIM read-only, or export
1164 an image from a split WIM.
1166 Using a capture configuration file is now supported (but not fully yet).
1168 SHA1 message digests are checked in more places, so we can make sure
1169 applied and captured data is correct.
1171 Man pages have been updated and consolidated.
1174 Fixed segfault when unmounting read-only WIM.
1177 Support for joining and splitting WIMs.
1178 Also, security data is now preserved by default.
1181 Can now build with older gcc and system headers, like on CentOS 5.
1184 Fixed bug that made it impossible to overwrite files in read-write
1188 Write byte-order mark before WIM XML data. (imagex.exe requires this to
git://wimlib.net / wimlib / blob