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