2 Removed OpenSSL (libcrypto) as a dependency of wimlib.
4 Improved the performance of the Windows binaries on CPUs that have SHA-1
7 Fixed a bug in 'wimsplit' where it didn't accept part sizes of 4 GiB or
8 larger on Windows and on 32-bit platforms.
11 wimsplit no longer prints a success message on failure.
13 wimlib_iterate_dir_tree() no longer hashes files that haven't yet been
14 written to the WIM file.
16 Reduced the maximum number of file descriptors that wimlib can use when
17 extracting files from a WIM image on macOS.
19 The files that used the CC0 public domain dedication now use the MIT
22 Removed some configuration options (--disable-assertions,
23 --disable-error-messages, and --disable-multithreaded-compression)
24 that probably weren't being used by anyone.
27 Exporting "all" images from a WIM file no longer fails if multiple
28 images in that WIM file have the same name.
30 wimlib now warns rather than aborts if two files have the same SHA-1
31 hash but different sizes.
33 Fixed build errors with the latest version of Mingw-w64.
36 wimsplit now prints progress messages regularly rather than just once
39 Added support for a data recovery mode which causes files to be
40 extracted even if they are corrupted. The option is --recover-data for
41 wimapply and wimextract, and WIMLIB_EXTRACT_FLAG_RECOVER_DATA for the
42 library. Note that this option won't help with all types of corruption;
43 some types of corruption will still cause a fatal error.
46 On Windows, improved performance of capturing an entire drive in some
49 On Windows, fixed leaking a directory handle (or triggering a SEH
50 exception when running under a debugger) when referencing WIM files.
52 On Windows, when applying a Windows OS image using the --compact flag,
53 bootloader files can now be compressed with stronger compression
54 algorithms if the version of Windows is recent enough to support it.
56 Clarified the license text.
59 Prevented miscompilation with gcc 10 at -O3
60 (https://gcc.gnu.org/bugzilla/show_bug.cgi?id=94994).
62 Avoided some compiler warnings with gcc 9 and later.
64 The 'mkwinpeimg' script now also looks for syslinux modules in
65 /usr/share/syslinux, to handle where openSUSE installs them.
67 Removed obsolete packaging files from the source tree.
70 Fixed a crash or incorrect output during LZMS compression with a
71 compression level greater than 50 and a chunk size greater than 64 MiB.
72 This affected wimlib v1.8.0 and later. In the unlikely event that you
73 used all these non-default compression settings in combination, e.g.
74 'wimcapture --solid --solid-compress=LZMS:100 --solid-chunk-size=128M',
75 run 'wimverify' on your archives to verify your data is intact.
78 On Windows, wimlib now supports capturing and applying extended
79 attributes (EAs). It is compatible with DISM with the /EA option,
80 available since Windows 10 version 1607. wimlib's EA support is on by
81 default and works on older versions of Windows too.
83 Partially fixed a bug where [ExclusionException] entries didn't take
84 effect when the containing directory is matched by [ExclusionList]. It
85 now works when the [ExclusionException] patterns are absolute. For
86 example, listing "/dir/file" in [ExclusionException] now works even if
87 "/dir" is matched by [ExclusionList].
89 Added a '--create' option to 'wimappend' which makes it create the WIM
90 file (like 'wimcapture') if it doesn't exist yet.
92 Added an '--include-integrity' option to various wimlib-imagex commands.
93 '--include-integrity' is like '--check', but it will just include an
94 integrity table in the output WIM(s), while skipping verification of any
95 existing integrity tables. This can be useful to avoid unwanted
96 verification of large WIM files, e.g. WIMs given by '--delta-from'.
98 'wimextract' now reads a pathlist file from standard input when "@-" is
101 wimsplit (API: wimlib_split()) now correctly handles a dot in the path
102 to the first split WIM part, prior to the filename extension.
104 'wimlib-imagex --version' now shows the version of the library it is
105 actually using (in case it is different from wimlib-imagex's version).
108 Fixed a bug that was causing the LZMS decompressor to be miscompiled
109 with GCC 7 (this broke extracting "solid" archives).
111 The Windows 10 Recycle Bin directory (\$RECYCLE.BIN) has been added to
112 the default exclusion list.
114 Added a '--quiet' option to wimlib-imagex.
116 The 'mkwinpeimg' script now also looks for the syslinux BIOS modules in
117 the directory /usr/lib/syslinux/modules/bios.
119 Files with timestamps before the year 1970 are now extracted correctly
120 to UNIX-style filesystems, are displayed correctly by
121 'wimdir --detailed', and show up correctly in mounted WIM images.
123 Files with timestamps after the year 2038 are now displayed correctly by
124 the 32-bit Windows build of wimlib.
127 Fixed a data corruption bug (incorrect compression) when storing an
128 already highly-compressed file in an LZX-compressed WIM with a chunk
129 size greater than or equal to 64K. Note that this is not the default
130 setting and such WIMs are not supported by Microsoft's WIM software, so
131 only users who used the --chunk-size option to wimlib-imagex or the
132 wimlib_set_output_chunk_size() API function may have been affected.
133 This bug was introduced in wimlib v1.10.0. See
134 https://wimlib.net/forums/viewtopic.php?f=1&t=300 for more details.
136 On all platforms, sparse files are now extracted as sparse.
138 Sparse files captured from UNIX-style filesystems are now marked as
139 sparse in the resulting WIM image.
141 Added support for storing Linux-style extended attributes in WIM images.
142 When the --unix-data option is used on Linux, wimlib-imagex now captures
143 and applies extended attributes, in addition to the already-supported
144 standard UNIX file permissions (owner/group/mode) and special files.
146 --delta-from is now supported by wimappend. (Previously it was only
147 supported by wimcapture.)
149 On Windows, improved the way in which files deduplicated with Windows'
150 Data Deduplication feature are captured.
152 The development files needed to link with wimlib using Visual Studio are
153 now included in the Windows release archives.
155 wimlib.h can now be included by Visual Studio without errors.
157 The example programs can now be compiled in C++ mode, and they also now
160 Updated 'mkwinpeimg' to work correctly on images that have a "windows"
161 (lower case) directory rather than a "Windows" (upper case) directory.
163 Fixed configuring with --enable-ssse3-sha1 from release tarball
164 (the file nasm_lt.sh was missing).
166 Made some documentation improvements.
169 The LZX compression ratio has been slightly improved. The default mode,
170 LZX level 50, is now almost as good as the old LZX level 100, while
171 being nearly the same speed as before.
173 Decompression performance has been slightly improved.
175 Filenames are now always listed in NTFS collation order.
177 On UNIX-like systems, wimlib can now process Windows filenames that are
178 not valid Unicode due to the presence of unpaired surrogates.
180 On UNIX-like systems, wimlib now always assumes UTF-8 encoding with the
181 addition of surrogate codepoints. Consequently, the environmental
182 variable WIMLIB_IMAGEX_USE_UTF8 and the flag
183 WIMLIB_INIT_FLAG_ASSUME_UTF8 no longer have any effect.
185 wimlib no longer depends on iconv.
187 Reduced memory usage slightly.
189 When a WIM image is applied in NTFS-3G mode, security descriptors are
190 now created in NTFS v3.0 format when supported by the volume.
192 Workarounds for bugs in libntfs-3g version 2013.1.13 and earlier have
193 been removed. Users are advised to upgrade to a later version of
196 On Windows, wimlib now supports case-sensitive filename extraction when
197 supported by the underlying operating system and filesystem (operating
198 system support requires a registry setting).
201 On UNIX, wimlib can now overwrite readonly files when extracting.
203 On Windows, fixed a bug where wimlib could leave a null DACL (a.k.a. "no
204 NTFS permissions") set on some existing directories after extraction.
206 On Windows, when applying a WIM image in "WIMBoot mode" when the WOF
207 driver is not loaded, wimlib can now correctly register a new WIM file
208 with the target volume when the target volume previously had had WIM
211 Added a new testing program.
213 Clarified the main license text and updated public domain dedications
214 for certain files to be more thorough.
217 Object IDs are now saved and restored on Windows and in NTFS-3G mode.
219 Reduced memory usage when exporting large numbers of WIM images.
221 Non UTF-8 locales are now detected correctly.
223 Addressed compiler warnings and enabled "silent" make rules by default.
225 Windows-specific updates:
226 Fixed a bug where duplicate backslashes could be generated in
227 link targets when extracting symbolic links and junctions.
229 Fixed a bug where the .cmd shortcuts for wimlib-imagex wouldn't
230 work if their full path contained a space.
232 Fixed bugs related to scanning SMB filesystems.
234 Added warning message about known issue with WindowsApps folder.
236 Added instructions for building from source on Windows.
238 VSS support is no longer marked "experimental".
240 Added missing license file for libdivsufsort-lite.
243 Added experimental support for Windows VSS (Volume Shadow Copy Service).
244 The new '--snapshot' argument to 'wimcapture' makes wimlib automatically
245 create and use a temporary VSS snapshot when capturing a WIM image.
247 Implemented setting of Windows-specific XML information, such as
248 architecture, system root, and version details. This information is now
249 automatically set in newly captured WIM images, when appropriate.
251 Improved performance of directory tree scans on Windows.
253 On Windows, to improve capture performance, wimlib now sometimes opens
254 files by inode number rather than by path. This is enabled for
255 wimcapture and wimappend, but for now other applications have to opt-in.
257 The progress messages printed by wimlib-imagex while writing WIM files
258 have been slightly tweaked.
260 Progress information for directory tree scans now counts all hard links.
261 Also, on Windows "\\?\" is no longer stripped from the current path.
263 Added a new '--image-property' option to 'wimcapture', 'wimappend', and
264 'wiminfo'. This option lets you assign values to elements in a WIM
265 file's XML document by name.
267 The wimlib_get_image_property() and wimlib_set_image_property() API
268 functions now support numerically indexed elements.
270 Fixed a bug where, on Windows, wimlib would change the security
271 descriptor of the target directory of an extraction even when the
272 '--no-acls' option was specified.
275 Fixed a bug with libntfs-3g extraction present since v1.8.1. Sometimes,
276 some Microsoft software would not correctly recognize data in the
277 resulting filesystem.
279 Made some small improvements to the compression algorithms:
280 LZX compression ratio was slightly improved.
281 XPRESS compression ratio and speed was slightly improved.
282 LZMS compression speed was slightly improved.
284 Improved handling of WIM XML data. wimlib no longer drops unrecognized
285 elements when exporting images. In addition, two API functions were
286 added for better access to elements in the XML document:
287 wimlib_get_image_property() and wimlib_set_image_property().
289 Added support for (unsafe) in-place compaction of WIM files.
291 Improved performance of image export by reusing metadata resources
292 instead of always rebuilding and recompressing them.
294 Improved performance of wimlib_update_image() by delaying the update to
295 the WIM's XML document until a write is requested.
297 On Windows, the target of an extraction may now be a reparse point
298 (which will be dereferenced).
300 On Windows, wimlib now correctly restores non-Microsoft reparse points.
301 However, this remains broken in NTFS-3g mode due to a libntfs-3g bug.
303 On Windows, wimlib now has improved performance when archiving files
304 from a filesystem backed by a WIM (a "WIMBoot" setup).
306 Several improvements to System Compression (compact mode) support:
308 wof.sys (or wofadk.sys) is now automatically attached to the
309 target volume if needed.
311 Compact-mode extractions now work correctly with wofadk.sys on
312 older versions of Windows.
314 For compatibility with the Windows bootloader, the requested
315 compression format now is overridden on certain files.
317 Other minor bugfixes.
320 This release primarily contains various minor bug fixes and
321 improvements, including:
323 Improved handling of deep directory structures.
325 Fixed a bug where on 32-bit systems, the library could enter an
326 infinite loop if a WIM file was malformed in a specific way.
328 Added a workaround for a case where libntfs-3g may report
329 duplicate streams in an NTFS file.
331 Windows symbolic links and junctions in mounted WIM images are
332 now automatically rewritten to be valid in the mounted location.
334 Reparse point fixes: correctly handle the "ReparseReserved"
335 field, and correctly handle "empty" (data-less) reparse points.
337 On Windows, wimlib now acquires SeManageVolumePrivilege, which
338 is needed to create externally backed files using the
341 Improved validation of filenames.
343 Improved LZMS decompression speed.
345 The configure script now honors alternate pkg-config settings.
347 Links have been updated to point to the new website.
349 In addition, experimental support has been added for compressing
350 extracted files using System Compression on Windows 10. This
351 functionality is available through the new '--compact' option to
352 'wimapply' and 'wimextract' as well as new library flags.
355 Fixed a bug in the LZX decompressor: malicious input data could cause
356 out of bounds writes to memory (since wimlib v1.2.2).
358 The output of the 'wiminfo' command now consolidates various boolean
359 flags (such as "Relative path junction") into a single line.
361 A file can now have both an unnamed data stream ("file contents") and a
362 reparse point stream. Such files can exist as a result of the use of
363 certain Windows features, such as offline storage, including "OneDrive".
364 wimlib will now store and restore both streams on Windows as well as in
365 NTFS-3g mode. Microsoft's WIMGAPI also has this behavior.
367 On Windows, named data streams of encrypted files are no longer stored
368 twice in WIM archives.
370 On Windows, named data streams are now correctly extracted to existing
371 "readonly" directories. Before, an error would be reported.
373 On Windows, it is now possible to do a "WIMBoot mode" extraction with
374 non-standalone WIMs such as delta WIMs.
376 On Windows, when doing an extraction in "WIMBoot mode", files larger
377 than 4 gigabytes are now never extracted as externally backed. This
378 works around a bug in Microsoft's "WOF" driver.
380 The '--enable-verify-compression' configure option has been removed. If
381 you want to verify a WIM file, use the 'wimverify' program.
383 The way the "file count", "directory count", "total bytes", and "hard
384 link bytes" image statistics (stored in the WIM XML data) is calculated
385 has been slightly changed.
387 In mounted WIM images, the disk usage provided for each file (st_blocks)
388 is now the compressed size rather than the uncompressed size.
390 The performance of the NTFS-3g and Windows capture modes has been
393 On UNIX-like systems, symbolic links whose targets contain the backslash
394 character are now handled correctly (losslessly).
397 Improved the LZX compressor. It is now 15-20% faster than before and
398 provides a slightly better compression ratio.
400 Improved the LZMS compressor. It now provides a compression ratio
401 slightly better than WIMGAPI while still being faster and using slightly
404 The compression chunk size in solid resources, e.g. when capturing or
405 exporting a WIM file using the '--solid' option, now defaults to 64 MiB
406 (67108864 bytes) instead of 32 MiB (33554432 bytes). This provides a
407 better compression ratio and is the same value that WIMGAPI uses. The
408 memory usage is less than 50% higher than wimlib v1.7.4 and is slightly
409 lower than WIMGAPI's memory usage, but if it is too much, it is still
410 possible to choose a lower value, e.g. with the '--solid-chunk-size'
411 option to wimlib-imagex.
413 The '--chunk-size' and '--solid-chunk-size' options to wimlib-imagex now
414 accept the 'K', 'M', and 'G' suffixes.
416 Files are now sorted by name extension when creating a solid WIM file.
418 Fixed various issues related to capture/apply of EFS-encrypted files on
421 The file list printed by 'wimdir' is now sorted by the platform-specific
422 case sensitivity setting, rather than always case sensitively. This
423 also affects the library function wimlib_iterate_dir_tree().
425 On Windows, some error and warning messages have been improved.
428 The Windows binary distribution no longer contains third party DLLs.
429 These dependencies are instead compiled directly into the libwim DLL.
431 Added more fixes for wimlib on non-x86 architectures such as ARM.
433 Extracting files to a Windows PE in-memory filesystem no longer fails if
434 the target files do not yet exist.
436 Improved the performance of XPRESS compression and LZMS decompression.
438 Enabled SSSE3 accelerated SHA-1 computation in x86_64 Windows builds.
439 It will automatically be faster on newer Intel and AMD processors.
441 Removed the --with-imagex-progname and --enable-more-assertions
445 Fix for very slow export from solid WIM / ESD files.
447 Fix for LZX and LZMS algorithms on non-x86 architectures, such as ARM.
449 New progress message: WIMLIB_PROGRESS_MSG_HANDLE_ERROR. Applications
450 may use this to treat some types of errors as non-fatal.
452 The library now permits making in-memory changes to a WIMStruct backed
453 by a read-only WIM file.
455 Fixes for "WIMBoot" extraction mode (Windows only):
457 When not using the WOF driver, extraction no longer fails if the
458 disk containing the WIM file has too many partitions.
460 When matching patterns in [PrepopulateList], all hard links of
461 each file are now considered.
463 The system registry files are now automatically treated as being
464 in [PrepopulateList].
466 Added a hack to try to work around an intermittent bug in
467 Microsoft's WOF (Windows Overlay Filesystem) driver.
470 Made more improvements to the XPRESS, LZX, and LZMS compressors.
472 A number of improvements to the Windows port:
474 Fixes for setting short filenames.
476 Faster "WIMBoot" extraction.
478 Updated and slimmed down the dependent DLLs.
480 ACL inheritence bits are now restored.
482 Mandatory integrity labels are now backed up and restored.
484 Added a workaround for an issue where in rare cases, wimlib could create
485 a compressed data stream that could not be read correctly by Windows
486 after an extraction in "WIMBoot" mode.
489 Added file count progress data for
490 WIMLIB_PROGRESS_MSG_EXTRACT_FILE_STRUCTURE and
491 WIMLIB_PROGRESS_MSG_EXTRACT_METADATA.
493 Added support for testing file exclusions via the user-provided
496 Some documentation improvements.
498 Made some clarifications to the license text in the COPYING file.
501 Made more improvements to the XPRESS, LZX, and LZMS compressors.
503 The default compression mode for wimcapture is now LZX compression in
504 its default mode, which is the same as '--compress=maximum'.
506 You can now specify an optional integer compression level to the
507 '--compress' option; e.g. '--compress=lzx:75'.
509 Made a minor change to the LZMS compressor and decompressor to fix an
510 incompatibility with the Microsoft implementation. In the unlikely
511 event that you created an LZMS-compressed WIM with wimlib v1.7.0 or
512 earlier and a checksum error is reported when extracting files from it
513 with wimlib v1.7.1, decompress it with v1.7.0 then compress it with
516 Added 'verify' subcommand to wimlib-imagex.
518 Notable library changes:
520 Custom compressor parameters have been removed from the library
521 in favor of the simpler level-based API.
523 Decompressor parameters have been removed entirely.
525 Library users can now specify a custom file for warning and
526 error messages to be sent to, rather than the default of
529 New progress messages:
530 WIMLIB_PROGRESS_MSG_EXTRACT_FILE_STRUCTURE,
531 WIMLIB_PROGRESS_MSG_EXTRACT_METADATA.
533 New function: wimlib_verify_wim().
536 Improved compression, decompression, and extraction performance.
538 Improved compatibility with version 3584 WIM / ESD files:
539 - Add support for reading and writing multiple solid blocks per
540 archive, which WIMGAPI/DISM can create when appending an image.
541 - Correctly create solid blocks larger than 4 GiB.
543 'add' commands passed to wimupdate will now replace existing
544 nondirectory files by default. Use the --no-replace option to get the
547 The license for the library now contains an exception that allows using
548 it under the LGPL. See the COPYING file for details.
550 In reparse-point fixup mode (the default for capture), symbolic links
551 and junctions that point outside the tree being captured are no longer
552 excluded from capture.
554 Added support for "WIMBoot" capture and extraction. See the
555 documentation for the new '--wimboot' option to wimcapture and wimapply
556 for more information.
558 On UNIX-like systems, you can now backup and restore device nodes, named
559 pipes, and sockets. In addition, 32-bit user and group IDs are now
562 The way that UNIX data is stored in WIM files has been changed. If you
563 captured any WIMs with the --unix-data option, to upgrade them you'll
564 need to apply them with --unix-data using wimlib-imagex v1.6.2, then
565 re-capture them with --unix-data using this version.
567 wimlib now understands tagged metadata items, such as object IDs, that
568 can be stored in WIM directory entries.
570 Removed the --hardlink and --symlink options to wimapply, since I don't
571 think they are too useful and they got in the way of improving the code.
573 WIMs will now retain their GUIDs when rebuilt (e.g. with wimoptimize).
575 The 'mkwinpeimg' script now supports writing the ISO image to standard
578 The <ARCH> element in WIM XML data is now exported correctly.
580 On Windows, sparse file attributes are no longer set on extracted files.
581 Oddly enough, this actually saves disk space in some cases.
583 On UNIX, configuring with --disable-xattr or --enable-xattr is no longer
584 supported. Mounting WIM images now always requires extended attribute
585 support. Use --without-fuse to disable support for mounting WIM images;
586 this will also disable the need for extended attribute support.
588 Configuring with --enable-ssse3-sha1 now works correctly.
590 The shared library version has been bumped up. The main
591 incompatibilities are:
593 - WIMLIB_COMPRESSION_TYPE_XPRESS is now 1 and
594 WIMLIB_COMPRESSION_TYPE_LZX is now 2 (so it's the same as
597 - User-provided progress functions are now registered using a
598 separate function, wimlib_register_progress_function(). The
599 'progress_func' argument to many functions no longer exists.
601 - The return value from user-provided progress functions is now
604 - A context argument has been added to the prototype of
605 user-provided progress functions.
607 - 'struct wimlib_capture_config' has been removed. The library
608 now takes the path to the configuration file directly. This
609 affects wimlib_add_image(), wimlib_add_image_multisource(),
610 and wimlib_update_image(). However, a NULL value passed in
611 the argument retains the same meaning.
613 - Removed deprecated functions: some (de)compression functions,
614 wimlib_extract_files(), and wimlib_print_metadata().
616 - Removed extraction flags: WIMLIB_EXTRACT_FLAG_HARDLINK,
617 WIMLIB_EXTRACT_FLAG_SYMLINK, WIMLIB_EXTRACT_FLAG_FILE_ORDER,
618 and WIMLIB_EXTRACT_FLAG_SEQUENTIAL.
620 - Removed some progress messages:
621 WIMLIB_PROGRESS_MSG_APPLY_TIMESTAMPS,
622 WIMLIB_PROGRESS_MSG_EXTRACT_DIR_STRUCTURE_BEGIN,
623 WIMLIB_PROGRESS_MSG_EXTRACT_DIR_STRUCTURE_END. Numbering
626 - Removed some error codes. Numbering stays the same.
628 - Replaced WIMLIB_UNMOUNT_FLAG_LAZY with
629 WIMLIB_UNMOUNT_FLAG_FORCE.
631 - WIM paths passed to progress functions now have a leading
635 Case-insensitive comparisons of strings (e.g. filenames) containing
636 UTF-16 codepoints above 32767 are now done correctly.
638 Fixed build failure on Mac OS X.
640 wimunmount now provides the '--new-image' option to cause changes to a
641 read-write mounted image to be committed as a new image rather than as
642 an update of the mounted image. (The corresponding new library flag is
643 WIMLIB_UNMOUNT_FLAG_NEW_IMAGE.)
645 The LZMS ("recovery") compression chunk size, or "dictionary size", may
646 now be up to 1 GiB (1,073,741,824 bytes).
648 The performance of LZX ("maximum") and LZMS ("recovery") compression
649 with large chunk sizes has been slightly improved.
652 Stored files with size exactly 4 GiB (4,294,967,296 bytes) are now
653 decompressed correctly.
655 Fixed a bug in the LZX compressor introduced in v1.5.3. The bug
656 occurred in an unlikely case, and due to validity checks it did not
657 affect successfully created archives.
659 Fixed a minor compatibility issue with the LZMS compressor and
660 decompressor. This is *not* the default compression type and was only
661 introduced in v1.6.0. In the unlikely event that you created an
662 LZMS-compressed WIM with v1.6.0 and a checksum error is reported when
663 applying it with v1.6.1, decompress it with v1.6.0 then compress it with
666 Memory usage for LZMS and LZX compression has been decreased.
668 wimextract now allows wildcard characters in paths specified on the
669 command line. Also, the '--strict-wildcards' option has been removed
670 and replaced with the inverse option '--nullglob'. See the
671 documentation for wimextract for more details and changes.
673 The wimlib_extract_files() function is now considered deprecated in
674 favor of wimlib_extract_paths().
676 Fixed more permissions problems when extracting files on Windows.
678 A new '--no-attributes' option has been added to wimapply and
679 wimextract. The library flag is WIMLIB_EXTRACT_FLAG_NO_ATTRIBUTES.
681 The default chunk size is now set correctly when changing the
682 compression type of a WIM, for example with 'wimoptimize'.
684 The '--metadata' option to wiminfo has been replaced with the
685 '--detailed' option to wimdir.
687 In relevant wimlib-imagex commands, '--solid' may now be used as an
688 alias for '--pack-streams'.
691 Support for extracting and updating the new version 3584 WIMs has been
692 added. These WIMs typically pack many streams ("files") together into a
693 single compressed resource, thereby saving space. This degrades the
694 performance of random access (such as that which occurs on a mounted
695 image), but optimizations have been implemented for extraction. These
696 new WIM files also typically use a new compression format (LZMS), which
697 is similar to LZMA and can offer a better compression ratio than LZX.
698 These new WIM files can be created using `wimcapture' with
699 the '--compress=lzms --pack-streams' options. Note: this new WIM format
700 is used by the Windows 8 web downloader, but important segments of the
701 raw '.esd' files are encrypted, so wimlib will not be able to extract
702 such files until they are first decrypted.
704 wimlib now supports extracting files and directories from a WIM image
705 based on a "listfile" that itself contains the list of paths to extract.
706 For `wimextract', the syntax is to specify @LISTFILE instead of a PATH,
707 and for the library itself, the new APIs are wimlib_extract_pathlist()
708 and wimlib_extract_paths(). Path globs containing wildcard characters
711 For searching WIM files, wimlib now has configurable case sensitivity.
712 The default on Windows is still case-insensitive and the default on
713 UNIX-like systems is still case-sensitive, but this can be overridden
714 on either platform through flags to wimlib_global_init(). For
715 `wimlib-imagex', the environmental variable WIMLIB_IMAGEX_IGNORE_CASE
716 can be set to 1 or 0 for case-insensitive or case-sensitive behavior,
719 Support for compression chunk sizes greater than the default of 32768
720 bytes has been added. A larger chunk size typically results in a better
721 compression ratio. However, the MS implementation is seemingly not
722 compatible with all chunk sizes, especially for LZX compression, so the
723 defaults remain unchanged, with the exception of the new LZMS-compressed
724 WIMs, which use a larger chunk size by default.
726 The compression/decompression API exported by wimlib has been changed.
727 Now one set of functions handles all supported compression formats.
729 `wimcapture' and `wimappend' will now display the progress of scanning
730 the directory tree to capture, in addition to the progress of writing
731 data to the WIM. The '--verbose' option no longer does anything. The
732 library API change for this is the addition of several members to
733 `struct wimlib_progress_info_scan' available to progress callbacks.
735 `mkwinpeimg' now correctly handles the '--start-script' option when the
736 start script is not in the working directory.
738 Sequential extraction, previously requested by using
739 WIMLIB_EXTRACT_FLAG_SEQUENTIAL, is now the default.
740 WIMLIB_EXTRACT_FLAG_FILE_ORDER can be used to get the old default
741 behavior (extract in file order).
744 The new LZX compressor added in v1.5.2 has been improved and is now
745 enabled by default, except when `wimcapture' or `wimappend' is run
746 *without* the '--compress' option, in which case the faster LZX
747 compressor is used (the same as before). This behavior is reasonably
748 consistent with ImageX which actually uses "fast" (XPRESS) compression
749 by default. In those cases, use '--compress=maximum' to explicitly
750 capture a WIM image using the new (slower but better) LZX compressor.
752 The '--compress-slow' option still exists to `wimlib-imagex optimize',
753 but its new behavior is to tweak the new LZX compressor even more to
754 produce an even better compression ratio at the cost of more time spent
757 `wimlib-imagex optimize' now supports the '--compress=TYPE' option,
758 which recompresses the WIM file using the specified compression TYPE.
759 The new library API function used for this is
760 wimlib_set_output_compression_type().
762 Added the wimlib_get_xml_data() function to allow library clients to
763 easily retrieve the raw XML data from a WIM file if needed.
765 Fixed a bug that could cause an error code to be incorrectly returned
766 when writing XML data containing a <WINDOWS> element.
768 Mounted WIM images will now correctly show the default file stream even
769 if appears in the alternate data stream entries of the corresponding WIM
773 Added a new experimental LZX compressor which can be enabled by passing
774 '--compress-slow' to `wimlib-imagex capture' or `wimlib-imagex
775 optimize'. (The latter is only applicable if the WIM is already
776 LZX-compressed and the '--recompress' option is also given.) The
777 experimental compressor is much slower but compresses the data slightly
778 more --- currently usually to within a fraction of a percent of the
779 results from WIMGAPI/ImageX.
781 A workaround has been added for compatibility with versions of WinPE
782 that interpret alternate data stream entries in the boot WIM
785 An alignment bug that caused a crash in the LZX decompressor on some
788 wimlib now attempts to clear the WIM_HDR_FLAG_WRITE_IN_PROGRESS flag in
789 the WIM header when restoring the previous state of a WIM it failed to
792 Added a workaround to avoid an access denied error on Windows when
793 replacing a WIM file that another process has opened.
796 wimlib can now open WinPE WIMs from WAIK v2.1, which had a quirk that
797 needed to be handled.
799 A bug in the interpretation of negative IMAGE indices in the
800 --update-of=[WIMFILE:]IMAGE option to `wimlib-imagex capture' and
801 `wimlib-imagex append' has been fixed.
803 A workaround has been added to successfully apply security descriptors
804 with empty DACLs when the NTFS-3g apply mode is being used with NTFS-3g
805 2013.1.13 or earlier.
807 `wimlib-imagex capture' can now accept the '--delta-from' option
811 Added support for "pipable" WIMs. Pipable WIMs allow capturing images
812 to standard output and applying images from standard input, but they are
813 not compatible with Microsoft's software and are not created by default.
814 See the documentation for --pipable flag of `wimlib-imagex capture' for
817 To better support incremental backups, added support for declaring an
818 image as a modified form of another image. See the documentation for
819 the '--update-of' option of `wimlib-imagex append' and `wimlib-imagex
822 Added supported for "delta" WIMs. See the documentation for the
823 '--delta-from' option of `wimlib-imagex capture'.
825 The library support for managing split WIMs has been changed to support
826 other arrangements, such as delta WIMs, and be easier to use. This
827 change is visible in `wimlib-imagex', which also can now accept the
828 '--ref' option multiple times, and also now supports "delta" WIMs as
831 wimlib now preserves WIM integrity tables by default, even if
832 WIMLIB_WRITE_FLAG_CHECK_INTEGRITY is not specified. This changes the
833 behavior of `wimlib-imagex' whenever the WIM being operated on contains
834 an integrity table and the '--check' option is not specified.
836 `wimlib-imagex capture' now creates LZX-compressed WIMs by default
837 (when --compress is not specified). This provides the best compression
838 ratio by default, which is usually what is desired, at a cost of some
841 `wimlib-imagex' now supports being invoked as wimCOMMAND, where COMMAND
842 is the command as in `wimlib-imagex COMMAND'; for example, it can be
843 invoked as `wimapply' as an alternative to `wimlib-imagex apply'. The
844 appropriate hard links are created in UNIX installations of
845 `wimlib-imagex', while for the Windows distribution of `wimlib-imagex',
846 batch files that emulate this behavior are generated.
848 Security descriptors are now extracted correctly on Windows.
850 Fixed archiving DOS names in NTFS-3g capture mode.
852 The extraction code has been rewritten and it will now be easier to
853 support new features on all supported backends (currently Win32, UNIX,
854 and NTFS-3g). For example, hard-linked extraction mode (--hardlink) is
855 now supported on all backends, not just UNIX.
857 `mkwinpeimg' now supports grabbing files from the WAIK supplement rather
858 than the WAIK itself.
860 wimlib_global_init() now, by default, attempts to acquire additional
861 privileges on Windows, so library clients need not do this.
863 This update bumps the shared library version number up to 9, since it is
864 not binary compatibible with previous releases.
867 Fixed bug in `wimlib-imagex export' that made it impossible to export an
868 image from a WIM that is readonly at the filesystem level.
870 Return error code rather than segfaulting when trying to list files from
871 a non-first part of a split WIM.
873 Joining a WIM will now preserve the RP_FIX and READONLY flags.
876 On Windows, paths given to wimlib-imagex are now treated case
879 Improved behavior regarding invalid filenames; in particular, on
880 Windows, wimlib-imagex will, when extracting, now omit (with an option
881 to override this default) filenames differing only in case, or filenames
882 containing characters not valid on Windows.
884 On Windows, wimlib now supports capturing and extracting long paths
885 (longer than the so-called MAX_PATH).
887 On Windows, `wimlib-imagex update' now acquires proper privileges when
888 running as an Administrator.
890 `wimlib-imagex update' will now complain if no image is specified when
891 trying to update a multi-image WIM.
893 `wimlib-imagex update' now supports specifying a single update command
894 directly on the command line using the --command option.
896 wimlib-imagex will now choose different units for progress messages,
897 depending on the amount of data that needs to be processed.
899 `wimlib-imagex append' will now generate a unique WIM image name if no
900 name is specified and the defaulted name already exists in the WIM.
902 wimlib now allows you to create unnamed WIM images, which can then only
903 be referred to by index.
905 wimlib now allows you to explicitly declare you want write access to a
906 WIM by providing the WIMLIB_OPEN_FLAG_WRITE_ACCESS flag to
909 wimlib now respects the WIM_HDR_FLAG_READONLY flag when set in the WIM
912 Progress callbacks have been added to wimlib's wimlib_update_image()
915 Added wimlib_get_wim_info(), wimlib_set_wim_info(),
916 wimlib_iterate_dir_tree(), and wimlib_iterate_lookup_table() functions
919 NTFS-3g capture now only warns about two conditions previously treated
922 Fixed a couple issues with using wimlib-imagex on UDF filesystems on
925 wimlib now correctly detects and returns an error when reading a WIM
926 image with a cyclic directory structure. (Fun fact: such a WIM will
927 crash Microsoft's software.)
930 Added new "extract" and "update" subcommands to wimlib-imagex, along
931 with associated APIs in the library. These commands are intended mainly
932 for Windows use but can be used on UNIX as well.
934 Many documentation improvements.
936 Fixed a bug in the Windows build where relative symbolic links were not
937 captured in reparse-point fixup mode.
939 Fixed a bug in the Windows build where file handles were left open to
940 the WIM file, causing `wimlib_imagex optimize' to fail in some cases.
942 Fixed a bug in the Windows build of wimlib-imagex where globbing
943 split-WIM parts could cause the program to crash.
945 Fixed a bug where the creation time of WIM images would be shown instead
946 of the last modification time.
948 With the Windows build it is now possible to restore a WIM containing
949 symbolic links as a non-Administrator; however you will receive warnings
950 about not being able to extract the symbolic links.
953 Capturing a WIM image should now be significantly faster in most cases
954 due to improved use of the operating system's cache and avoiding reading
955 files twice whenever possible.
957 The Windows build should now work on Windows XP.
959 The Windows build now supports capturing and restoring hidden,
960 compressed, sparse, and encrypted files.
962 The Windows build now supports capturing and applying WIM images from
963 filesystems other than NTFS (with some reduced functionality).
965 The Windows build now extracts short names correctly.
967 Added support for "reparse-point" fixups (i.e. fixing up of symbolic
968 links). See docs for --rpfix and --norpfix flags of `wimlib-imagex
969 capture' and `wimlib-imagex apply'.
971 The performance of splitting and joining WIMs should be slightly
974 The LZX and XPRESS compression and decompression functions are now
975 exported from the library.
978 Improvements and bugfixes for the Windows build.
980 Added --strict-acls options.
982 Fixed the way that wimlib determines the order of images in the WIM.
985 Since wimlib can now be used on Windows, wimlib's implementation of
986 ImageX has been renamed to wimlib-imagex to avoid confusion with
987 Microsoft's implementation of ImageX, which would have the same file
988 name ("imagex.exe"). If you really don't like this you can pass the
989 --with-imagex-progname option to `configure' to choose a different name,
990 or even simply rename the binary yourself (but the former way will
991 configure the man pages to use the chosen name).
993 Various bugs fixed in the Windows build. Mainly to do with capturing
994 and restoring alternate data streams correctly in weird cases, and
995 requesting the correct privileges when opening files. Also added the
996 --noacls options to wimlib-imagex capture, append, and apply.
998 Windows build again: FindFirstStreamW() and FindNextStreamW() are now
999 dynamically loaded, so this may make the library compatible with Windows
1000 XP (however, there may still be other problems).
1003 Added experimental support for native Windows builds. Binaries can be
1004 downloaded from the SourceForge page.
1006 --source-list option added to `imagex capture' and `imagex append'.
1008 Better support for different character encodings.
1011 Storing UNIX file owners, groups, and modes in WIM images is now
1012 possible using `imagex capture' with the --unix-data flag.
1014 Minor bug fixes and documentation fixes.
1017 NTFS capture: Fixed capturing duplicate reparse points.
1019 NTFS capture: Capture first unnamed stream if there are more than one
1020 (print warning instead of error).
1022 Allow multiple test cases to execute concurrently (e.g. make -j2 check).
1025 Added --arch switch to mkwinpeimg script to support getting AMD64 WinPE
1028 Update to work with ntfs-3g version 2013.1.13.
1031 Fixed truncating file to shorter but non-zero length on read-write
1034 Various code cleanups and minor documentation fixes.
1037 LZX and XPRESS decompression have received some additional optimizations
1038 and should now be even faster. (Although, they were already pretty
1039 fast--- much faster than typical I/O speeds.)
1041 Fixed a bug introduced in v1.2.1 that would cause a directory tree
1042 containing hard links to be captured incorrectly in some cases.
1045 By default, unmounting a read-write mounted WIM with 'imagex unmount
1046 --commit' will now change the WIM in-place without needing to write the
1047 entire WIM again. Use 'imagex unmount --commit --rebuild' to get the
1050 'imagex unmount' no longer has a hard-coded limit of 10 minutes to wait
1051 for a response from the daemon servicing the mounted WIM. Instead,
1052 every second 'imagex unmount' will check if the daemon is still alive,
1053 and keep waiting if so, otherwise terminate with an error.
1055 'imagex unmount --commit' on a read-write mounted WIM will now print
1056 progress information regarding the writing of new or modified streams
1057 the WIM, just like when capturing or appending a WIM.
1059 A small change has been made to XPRESS compression and it should improve
1060 the compression ratio slightly.
1062 A change was made that may improve performance slightly when applying a
1063 WIM image to a NTFS volume.
1065 Microsoft has managed to introduce even more bugs into their software,
1066 and now the WIMs for Windows 8 have incorrect (too low) reference counts
1067 for some streams. This is unsafe because such streams can be removed
1068 when they are in actuality still referenced in the WIM (perhaps by a
1069 different image). wimlib will now work around this problem by fixing
1070 the stream reference counts. This is only done when wimlib_delete_image() is
1071 called ('imagex delete') or when wimlib_mount_image() is called with
1072 WIMLIB_MOUNT_FLAG_READWRITE ('imagex mountrw'). Please note that this
1073 requires reading the metadata for all images in the WIM, so this will
1074 make these operations noticably slower on WIMs with multiple images.
1076 Various other bugfixes.
1079 Appending images to a WIM is now be done by default without re-building
1080 the whole WIM. Use the --rebuild flag to get the old behavior (which
1081 was to re-build the entire WIM when a new image is appended).
1083 A new command `imagex optimize' is now available to manually re-build a
1084 WIM that has wasted space due to repeated appends.
1086 Progress information has been improved, and now arbitrary callback
1087 functions can be used to show the progress of a WIM operation.
1089 A possible bug with changing the bootable image of a WIM was fixed.
1091 Some advisory locking is now done to prevent two processes from
1092 modifying a WIM at the same time (but only in some cases). For example,
1093 you cannot mount two images from a WIM read-write at the same time.
1095 Some functions have been reorganized:
1096 * wimlib_mount() renamed to wimlib_mount_image().
1097 * wimlib_unmount() renamed to wimlib_unmount_image().
1098 * wimlib_overwrite_xml_and_header() removed as
1099 wimlib_overwrite() suffices now.
1100 * wimlib_apply_image_to_ntfs_volume() removed as
1101 wimlib_extract_image() suffices now.
1102 * wimlib_add_image_from_ntfs_volume() removed as
1103 * wimlib_add_image() suffices now.
1105 Previously, the soname of libwim.so has been 0.0.0, despite many
1106 interface changes. The soname is now updated to 1.0.0 and will now be
1107 updated each release.
1110 Resources will now be compressed using multiple threads by default.
1111 (This applies to `imagex capture', `imagex append', and `imagex
1114 Some performance improvements in mounted WIMs.
1116 More progress information is shown when capturing a WIM.
1119 Lots of minor fixes, code cleanups, and some documentation updates.
1120 Nothing in particular is really noteworthy.
1123 LZX and XPRESS compression improvements.
1125 Fixed calculation of Directory Count, File Count, Total Bytes, and Hard
1126 Link Bytes of the WIM.
1129 Fixed bug when capturing NTFS file with multiple named data streams.
1131 Internally, we are now using inode structures, even though these don't
1132 appear literally in the WIM file. This simplifies some of the code
1133 (mainly for WIM mounting) and likely fixed a few problems, although it
1137 Fixed problem when exporting images from XPRESS to LZX compressed WIM or
1141 Enough changes to call it version 1.0.0!
1143 Capturing a WIM directly from a NTFS volume, and applying a WIM directly
1144 to a NTFS volume, is now supported.
1146 Hard links and symbolic links have much improved support. They are
1147 supported for WIM capture, WIM application, and mounted WIMs (you can
1148 even make them on read-write mounted WIMs).
1150 Alternate data streams are now supported on mounted WIMs through an
1151 xattr or a Windows-style stream interface. Also they are supported when
1152 capturing a WIM from NTFS or applying a WIM to NTFS.
1154 Split WIMs are better supported. You may now apply an image directly
1155 from a split WIM, mount an image from a split WIM read-only, or export
1156 an image from a split WIM.
1158 Using a capture configuration file is now supported (but not fully yet).
1160 SHA1 message digests are checked in more places, so we can make sure
1161 applied and captured data is correct.
1163 Man pages have been updated and consolidated.
1166 Fixed segfault when unmounting read-only WIM.
1169 Support for joining and splitting WIMs.
1170 Also, security data is now preserved by default.
1173 Can now build with older gcc and system headers, like on CentOS 5.
1176 Fixed bug that made it impossible to overwrite files in read-write
1180 Write byte-order mark before WIM XML data. (imagex.exe requires this to
git://wimlib.net / wimlib / blob