2 wimsplit no longer prints a success message on failure.
4 wimlib_iterate_dir_tree() no longer hashes files that haven't yet been
5 written to the WIM file.
7 Reduced the maximum number of file descriptors that wimlib can use when
8 extracting files from a WIM image on macOS.
10 The files that used the CC0 public domain dedication now use the MIT
13 Removed some configuration options (--disable-assertions,
14 --disable-error-messages, and --disable-multithreaded-compression)
15 that probably weren't being used by anyone.
18 Exporting "all" images from a WIM file no longer fails if multiple
19 images in that WIM file have the same name.
21 wimlib now warns rather than aborts if two files have the same SHA-1
22 hash but different sizes.
24 Fixed build errors with the latest version of Mingw-w64.
27 wimsplit now prints progress messages regularly rather than just once
30 Added support for a data recovery mode which causes files to be
31 extracted even if they are corrupted. The option is --recover-data for
32 wimapply and wimextract, and WIMLIB_EXTRACT_FLAG_RECOVER_DATA for the
33 library. Note that this option won't help with all types of corruption;
34 some types of corruption will still cause a fatal error.
37 On Windows, improved performance of capturing an entire drive in some
40 On Windows, fixed leaking a directory handle (or triggering a SEH
41 exception when running under a debugger) when referencing WIM files.
43 On Windows, when applying a Windows OS image using the --compact flag,
44 bootloader files can now be compressed with stronger compression
45 algorithms if the version of Windows is recent enough to support it.
47 Clarified the license text.
50 Prevented miscompilation with gcc 10 at -O3
51 (https://gcc.gnu.org/bugzilla/show_bug.cgi?id=94994).
53 Avoided some compiler warnings with gcc 9 and later.
55 The 'mkwinpeimg' script now also looks for syslinux modules in
56 /usr/share/syslinux, to handle where openSUSE installs them.
58 Removed obsolete packaging files from the source tree.
61 Fixed a crash or incorrect output during LZMS compression with a
62 compression level greater than 50 and a chunk size greater than 64 MiB.
63 This affected wimlib v1.8.0 and later. In the unlikely event that you
64 used all these non-default compression settings in combination, e.g.
65 'wimcapture --solid --solid-compress=LZMS:100 --solid-chunk-size=128M',
66 run 'wimverify' on your archives to verify your data is intact.
69 On Windows, wimlib now supports capturing and applying extended
70 attributes (EAs). It is compatible with DISM with the /EA option,
71 available since Windows 10 version 1607. wimlib's EA support is on by
72 default and works on older versions of Windows too.
74 Partially fixed a bug where [ExclusionException] entries didn't take
75 effect when the containing directory is matched by [ExclusionList]. It
76 now works when the [ExclusionException] patterns are absolute. For
77 example, listing "/dir/file" in [ExclusionException] now works even if
78 "/dir" is matched by [ExclusionList].
80 Added a '--create' option to 'wimappend' which makes it create the WIM
81 file (like 'wimcapture') if it doesn't exist yet.
83 Added an '--include-integrity' option to various wimlib-imagex commands.
84 '--include-integrity' is like '--check', but it will just include an
85 integrity table in the output WIM(s), while skipping verification of any
86 existing integrity tables. This can be useful to avoid unwanted
87 verification of large WIM files, e.g. WIMs given by '--delta-from'.
89 'wimextract' now reads a pathlist file from standard input when "@-" is
92 wimsplit (API: wimlib_split()) now correctly handles a dot in the path
93 to the first split WIM part, prior to the filename extension.
95 'wimlib-imagex --version' now shows the version of the library it is
96 actually using (in case it is different from wimlib-imagex's version).
99 Fixed a bug that was causing the LZMS decompressor to be miscompiled
100 with GCC 7 (this broke extracting "solid" archives).
102 The Windows 10 Recycle Bin directory (\$RECYCLE.BIN) has been added to
103 the default exclusion list.
105 Added a '--quiet' option to wimlib-imagex.
107 The 'mkwinpeimg' script now also looks for the syslinux BIOS modules in
108 the directory /usr/lib/syslinux/modules/bios.
110 Files with timestamps before the year 1970 are now extracted correctly
111 to UNIX-style filesystems, are displayed correctly by
112 'wimdir --detailed', and show up correctly in mounted WIM images.
114 Files with timestamps after the year 2038 are now displayed correctly by
115 the 32-bit Windows build of wimlib.
118 Fixed a data corruption bug (incorrect compression) when storing an
119 already highly-compressed file in an LZX-compressed WIM with a chunk
120 size greater than or equal to 64K. Note that this is not the default
121 setting and such WIMs are not supported by Microsoft's WIM software, so
122 only users who used the --chunk-size option to wimlib-imagex or the
123 wimlib_set_output_chunk_size() API function may have been affected.
124 This bug was introduced in wimlib v1.10.0. See
125 https://wimlib.net/forums/viewtopic.php?f=1&t=300 for more details.
127 On all platforms, sparse files are now extracted as sparse.
129 Sparse files captured from UNIX-style filesystems are now marked as
130 sparse in the resulting WIM image.
132 Added support for storing Linux-style extended attributes in WIM images.
133 When the --unix-data option is used on Linux, wimlib-imagex now captures
134 and applies extended attributes, in addition to the already-supported
135 standard UNIX file permissions (owner/group/mode) and special files.
137 --delta-from is now supported by wimappend. (Previously it was only
138 supported by wimcapture.)
140 On Windows, improved the way in which files deduplicated with Windows'
141 Data Deduplication feature are captured.
143 The development files needed to link with wimlib using Visual Studio are
144 now included in the Windows release archives.
146 wimlib.h can now be included by Visual Studio without errors.
148 The example programs can now be compiled in C++ mode, and they also now
151 Updated 'mkwinpeimg' to work correctly on images that have a "windows"
152 (lower case) directory rather than a "Windows" (upper case) directory.
154 Fixed configuring with --enable-ssse3-sha1 from release tarball
155 (the file nasm_lt.sh was missing).
157 Made some documentation improvements.
160 The LZX compression ratio has been slightly improved. The default mode,
161 LZX level 50, is now almost as good as the old LZX level 100, while
162 being nearly the same speed as before.
164 Decompression performance has been slightly improved.
166 Filenames are now always listed in NTFS collation order.
168 On UNIX-like systems, wimlib can now process Windows filenames that are
169 not valid Unicode due to the presence of unpaired surrogates.
171 On UNIX-like systems, wimlib now always assumes UTF-8 encoding with the
172 addition of surrogate codepoints. Consequently, the environmental
173 variable WIMLIB_IMAGEX_USE_UTF8 and the flag
174 WIMLIB_INIT_FLAG_ASSUME_UTF8 no longer have any effect.
176 wimlib no longer depends on iconv.
178 Reduced memory usage slightly.
180 When a WIM image is applied in NTFS-3G mode, security descriptors are
181 now created in NTFS v3.0 format when supported by the volume.
183 Workarounds for bugs in libntfs-3g version 2013.1.13 and earlier have
184 been removed. Users are advised to upgrade to a later version of
187 On Windows, wimlib now supports case-sensitive filename extraction when
188 supported by the underlying operating system and filesystem (operating
189 system support requires a registry setting).
192 On UNIX, wimlib can now overwrite readonly files when extracting.
194 On Windows, fixed a bug where wimlib could leave a null DACL (a.k.a. "no
195 NTFS permissions") set on some existing directories after extraction.
197 On Windows, when applying a WIM image in "WIMBoot mode" when the WOF
198 driver is not loaded, wimlib can now correctly register a new WIM file
199 with the target volume when the target volume previously had had WIM
202 Added a new testing program.
204 Clarified the main license text and updated public domain dedications
205 for certain files to be more thorough.
208 Object IDs are now saved and restored on Windows and in NTFS-3G mode.
210 Reduced memory usage when exporting large numbers of WIM images.
212 Non UTF-8 locales are now detected correctly.
214 Addressed compiler warnings and enabled "silent" make rules by default.
216 Windows-specific updates:
217 Fixed a bug where duplicate backslashes could be generated in
218 link targets when extracting symbolic links and junctions.
220 Fixed a bug where the .cmd shortcuts for wimlib-imagex wouldn't
221 work if their full path contained a space.
223 Fixed bugs related to scanning SMB filesystems.
225 Added warning message about known issue with WindowsApps folder.
227 Added instructions for building from source on Windows.
229 VSS support is no longer marked "experimental".
231 Added missing license file for libdivsufsort-lite.
234 Added experimental support for Windows VSS (Volume Shadow Copy Service).
235 The new '--snapshot' argument to 'wimcapture' makes wimlib automatically
236 create and use a temporary VSS snapshot when capturing a WIM image.
238 Implemented setting of Windows-specific XML information, such as
239 architecture, system root, and version details. This information is now
240 automatically set in newly captured WIM images, when appropriate.
242 Improved performance of directory tree scans on Windows.
244 On Windows, to improve capture performance, wimlib now sometimes opens
245 files by inode number rather than by path. This is enabled for
246 wimcapture and wimappend, but for now other applications have to opt-in.
248 The progress messages printed by wimlib-imagex while writing WIM files
249 have been slightly tweaked.
251 Progress information for directory tree scans now counts all hard links.
252 Also, on Windows "\\?\" is no longer stripped from the current path.
254 Added a new '--image-property' option to 'wimcapture', 'wimappend', and
255 'wiminfo'. This option lets you assign values to elements in a WIM
256 file's XML document by name.
258 The wimlib_get_image_property() and wimlib_set_image_property() API
259 functions now support numerically indexed elements.
261 Fixed a bug where, on Windows, wimlib would change the security
262 descriptor of the target directory of an extraction even when the
263 '--no-acls' option was specified.
266 Fixed a bug with libntfs-3g extraction present since v1.8.1. Sometimes,
267 some Microsoft software would not correctly recognize data in the
268 resulting filesystem.
270 Made some small improvements to the compression algorithms:
271 LZX compression ratio was slightly improved.
272 XPRESS compression ratio and speed was slightly improved.
273 LZMS compression speed was slightly improved.
275 Improved handling of WIM XML data. wimlib no longer drops unrecognized
276 elements when exporting images. In addition, two API functions were
277 added for better access to elements in the XML document:
278 wimlib_get_image_property() and wimlib_set_image_property().
280 Added support for (unsafe) in-place compaction of WIM files.
282 Improved performance of image export by reusing metadata resources
283 instead of always rebuilding and recompressing them.
285 Improved performance of wimlib_update_image() by delaying the update to
286 the WIM's XML document until a write is requested.
288 On Windows, the target of an extraction may now be a reparse point
289 (which will be dereferenced).
291 On Windows, wimlib now correctly restores non-Microsoft reparse points.
292 However, this remains broken in NTFS-3g mode due to a libntfs-3g bug.
294 On Windows, wimlib now has improved performance when archiving files
295 from a filesystem backed by a WIM (a "WIMBoot" setup).
297 Several improvements to System Compression (compact mode) support:
299 wof.sys (or wofadk.sys) is now automatically attached to the
300 target volume if needed.
302 Compact-mode extractions now work correctly with wofadk.sys on
303 older versions of Windows.
305 For compatibility with the Windows bootloader, the requested
306 compression format now is overridden on certain files.
308 Other minor bugfixes.
311 This release primarily contains various minor bug fixes and
312 improvements, including:
314 Improved handling of deep directory structures.
316 Fixed a bug where on 32-bit systems, the library could enter an
317 infinite loop if a WIM file was malformed in a specific way.
319 Added a workaround for a case where libntfs-3g may report
320 duplicate streams in an NTFS file.
322 Windows symbolic links and junctions in mounted WIM images are
323 now automatically rewritten to be valid in the mounted location.
325 Reparse point fixes: correctly handle the "ReparseReserved"
326 field, and correctly handle "empty" (data-less) reparse points.
328 On Windows, wimlib now acquires SeManageVolumePrivilege, which
329 is needed to create externally backed files using the
332 Improved validation of filenames.
334 Improved LZMS decompression speed.
336 The configure script now honors alternate pkg-config settings.
338 Links have been updated to point to the new website.
340 In addition, experimental support has been added for compressing
341 extracted files using System Compression on Windows 10. This
342 functionality is available through the new '--compact' option to
343 'wimapply' and 'wimextract' as well as new library flags.
346 Fixed a bug in the LZX decompressor: malicious input data could cause
347 out of bounds writes to memory (since wimlib v1.2.2).
349 The output of the 'wiminfo' command now consolidates various boolean
350 flags (such as "Relative path junction") into a single line.
352 A file can now have both an unnamed data stream ("file contents") and a
353 reparse point stream. Such files can exist as a result of the use of
354 certain Windows features, such as offline storage, including "OneDrive".
355 wimlib will now store and restore both streams on Windows as well as in
356 NTFS-3g mode. Microsoft's WIMGAPI also has this behavior.
358 On Windows, named data streams of encrypted files are no longer stored
359 twice in WIM archives.
361 On Windows, named data streams are now correctly extracted to existing
362 "readonly" directories. Before, an error would be reported.
364 On Windows, it is now possible to do a "WIMBoot mode" extraction with
365 non-standalone WIMs such as delta WIMs.
367 On Windows, when doing an extraction in "WIMBoot mode", files larger
368 than 4 gigabytes are now never extracted as externally backed. This
369 works around a bug in Microsoft's "WOF" driver.
371 The '--enable-verify-compression' configure option has been removed. If
372 you want to verify a WIM file, use the 'wimverify' program.
374 The way the "file count", "directory count", "total bytes", and "hard
375 link bytes" image statistics (stored in the WIM XML data) is calculated
376 has been slightly changed.
378 In mounted WIM images, the disk usage provided for each file (st_blocks)
379 is now the compressed size rather than the uncompressed size.
381 The performance of the NTFS-3g and Windows capture modes has been
384 On UNIX-like systems, symbolic links whose targets contain the backslash
385 character are now handled correctly (losslessly).
388 Improved the LZX compressor. It is now 15-20% faster than before and
389 provides a slightly better compression ratio.
391 Improved the LZMS compressor. It now provides a compression ratio
392 slightly better than WIMGAPI while still being faster and using slightly
395 The compression chunk size in solid resources, e.g. when capturing or
396 exporting a WIM file using the '--solid' option, now defaults to 64 MiB
397 (67108864 bytes) instead of 32 MiB (33554432 bytes). This provides a
398 better compression ratio and is the same value that WIMGAPI uses. The
399 memory usage is less than 50% higher than wimlib v1.7.4 and is slightly
400 lower than WIMGAPI's memory usage, but if it is too much, it is still
401 possible to choose a lower value, e.g. with the '--solid-chunk-size'
402 option to wimlib-imagex.
404 The '--chunk-size' and '--solid-chunk-size' options to wimlib-imagex now
405 accept the 'K', 'M', and 'G' suffixes.
407 Files are now sorted by name extension when creating a solid WIM file.
409 Fixed various issues related to capture/apply of EFS-encrypted files on
412 The file list printed by 'wimdir' is now sorted by the platform-specific
413 case sensitivity setting, rather than always case sensitively. This
414 also affects the library function wimlib_iterate_dir_tree().
416 On Windows, some error and warning messages have been improved.
419 The Windows binary distribution no longer contains third party DLLs.
420 These dependencies are instead compiled directly into the libwim DLL.
422 Added more fixes for wimlib on non-x86 architectures such as ARM.
424 Extracting files to a Windows PE in-memory filesystem no longer fails if
425 the target files do not yet exist.
427 Improved the performance of XPRESS compression and LZMS decompression.
429 Enabled SSSE3 accelerated SHA-1 computation in x86_64 Windows builds.
430 It will automatically be faster on newer Intel and AMD processors.
432 Removed the --with-imagex-progname and --enable-more-assertions
436 Fix for very slow export from solid WIM / ESD files.
438 Fix for LZX and LZMS algorithms on non-x86 architectures, such as ARM.
440 New progress message: WIMLIB_PROGRESS_MSG_HANDLE_ERROR. Applications
441 may use this to treat some types of errors as non-fatal.
443 The library now permits making in-memory changes to a WIMStruct backed
444 by a read-only WIM file.
446 Fixes for "WIMBoot" extraction mode (Windows only):
448 When not using the WOF driver, extraction no longer fails if the
449 disk containing the WIM file has too many partitions.
451 When matching patterns in [PrepopulateList], all hard links of
452 each file are now considered.
454 The system registry files are now automatically treated as being
455 in [PrepopulateList].
457 Added a hack to try to work around an intermittent bug in
458 Microsoft's WOF (Windows Overlay Filesystem) driver.
461 Made more improvements to the XPRESS, LZX, and LZMS compressors.
463 A number of improvements to the Windows port:
465 Fixes for setting short filenames.
467 Faster "WIMBoot" extraction.
469 Updated and slimmed down the dependent DLLs.
471 ACL inheritence bits are now restored.
473 Mandatory integrity labels are now backed up and restored.
475 Added a workaround for an issue where in rare cases, wimlib could create
476 a compressed data stream that could not be read correctly by Windows
477 after an extraction in "WIMBoot" mode.
480 Added file count progress data for
481 WIMLIB_PROGRESS_MSG_EXTRACT_FILE_STRUCTURE and
482 WIMLIB_PROGRESS_MSG_EXTRACT_METADATA.
484 Added support for testing file exclusions via the user-provided
487 Some documentation improvements.
489 Made some clarifications to the license text in the COPYING file.
492 Made more improvements to the XPRESS, LZX, and LZMS compressors.
494 The default compression mode for wimcapture is now LZX compression in
495 its default mode, which is the same as '--compress=maximum'.
497 You can now specify an optional integer compression level to the
498 '--compress' option; e.g. '--compress=lzx:75'.
500 Made a minor change to the LZMS compressor and decompressor to fix an
501 incompatibility with the Microsoft implementation. In the unlikely
502 event that you created an LZMS-compressed WIM with wimlib v1.7.0 or
503 earlier and a checksum error is reported when extracting files from it
504 with wimlib v1.7.1, decompress it with v1.7.0 then compress it with
507 Added 'verify' subcommand to wimlib-imagex.
509 Notable library changes:
511 Custom compressor parameters have been removed from the library
512 in favor of the simpler level-based API.
514 Decompressor parameters have been removed entirely.
516 Library users can now specify a custom file for warning and
517 error messages to be sent to, rather than the default of
520 New progress messages:
521 WIMLIB_PROGRESS_MSG_EXTRACT_FILE_STRUCTURE,
522 WIMLIB_PROGRESS_MSG_EXTRACT_METADATA.
524 New function: wimlib_verify_wim().
527 Improved compression, decompression, and extraction performance.
529 Improved compatibility with version 3584 WIM / ESD files:
530 - Add support for reading and writing multiple solid blocks per
531 archive, which WIMGAPI/DISM can create when appending an image.
532 - Correctly create solid blocks larger than 4 GiB.
534 'add' commands passed to wimupdate will now replace existing
535 nondirectory files by default. Use the --no-replace option to get the
538 The license for the library now contains an exception that allows using
539 it under the LGPL. See the COPYING file for details.
541 In reparse-point fixup mode (the default for capture), symbolic links
542 and junctions that point outside the tree being captured are no longer
543 excluded from capture.
545 Added support for "WIMBoot" capture and extraction. See the
546 documentation for the new '--wimboot' option to wimcapture and wimapply
547 for more information.
549 On UNIX-like systems, you can now backup and restore device nodes, named
550 pipes, and sockets. In addition, 32-bit user and group IDs are now
553 The way that UNIX data is stored in WIM files has been changed. If you
554 captured any WIMs with the --unix-data option, to upgrade them you'll
555 need to apply them with --unix-data using wimlib-imagex v1.6.2, then
556 re-capture them with --unix-data using this version.
558 wimlib now understands tagged metadata items, such as object IDs, that
559 can be stored in WIM directory entries.
561 Removed the --hardlink and --symlink options to wimapply, since I don't
562 think they are too useful and they got in the way of improving the code.
564 WIMs will now retain their GUIDs when rebuilt (e.g. with wimoptimize).
566 The 'mkwinpeimg' script now supports writing the ISO image to standard
569 The <ARCH> element in WIM XML data is now exported correctly.
571 On Windows, sparse file attributes are no longer set on extracted files.
572 Oddly enough, this actually saves disk space in some cases.
574 On UNIX, configuring with --disable-xattr or --enable-xattr is no longer
575 supported. Mounting WIM images now always requires extended attribute
576 support. Use --without-fuse to disable support for mounting WIM images;
577 this will also disable the need for extended attribute support.
579 Configuring with --enable-ssse3-sha1 now works correctly.
581 The shared library version has been bumped up. The main
582 incompatibilities are:
584 - WIMLIB_COMPRESSION_TYPE_XPRESS is now 1 and
585 WIMLIB_COMPRESSION_TYPE_LZX is now 2 (so it's the same as
588 - User-provided progress functions are now registered using a
589 separate function, wimlib_register_progress_function(). The
590 'progress_func' argument to many functions no longer exists.
592 - The return value from user-provided progress functions is now
595 - A context argument has been added to the prototype of
596 user-provided progress functions.
598 - 'struct wimlib_capture_config' has been removed. The library
599 now takes the path to the configuration file directly. This
600 affects wimlib_add_image(), wimlib_add_image_multisource(),
601 and wimlib_update_image(). However, a NULL value passed in
602 the argument retains the same meaning.
604 - Removed deprecated functions: some (de)compression functions,
605 wimlib_extract_files(), and wimlib_print_metadata().
607 - Removed extraction flags: WIMLIB_EXTRACT_FLAG_HARDLINK,
608 WIMLIB_EXTRACT_FLAG_SYMLINK, WIMLIB_EXTRACT_FLAG_FILE_ORDER,
609 and WIMLIB_EXTRACT_FLAG_SEQUENTIAL.
611 - Removed some progress messages:
612 WIMLIB_PROGRESS_MSG_APPLY_TIMESTAMPS,
613 WIMLIB_PROGRESS_MSG_EXTRACT_DIR_STRUCTURE_BEGIN,
614 WIMLIB_PROGRESS_MSG_EXTRACT_DIR_STRUCTURE_END. Numbering
617 - Removed some error codes. Numbering stays the same.
619 - Replaced WIMLIB_UNMOUNT_FLAG_LAZY with
620 WIMLIB_UNMOUNT_FLAG_FORCE.
622 - WIM paths passed to progress functions now have a leading
626 Case-insensitive comparisons of strings (e.g. filenames) containing
627 UTF-16 codepoints above 32767 are now done correctly.
629 Fixed build failure on Mac OS X.
631 wimunmount now provides the '--new-image' option to cause changes to a
632 read-write mounted image to be committed as a new image rather than as
633 an update of the mounted image. (The corresponding new library flag is
634 WIMLIB_UNMOUNT_FLAG_NEW_IMAGE.)
636 The LZMS ("recovery") compression chunk size, or "dictionary size", may
637 now be up to 1 GiB (1,073,741,824 bytes).
639 The performance of LZX ("maximum") and LZMS ("recovery") compression
640 with large chunk sizes has been slightly improved.
643 Stored files with size exactly 4 GiB (4,294,967,296 bytes) are now
644 decompressed correctly.
646 Fixed a bug in the LZX compressor introduced in v1.5.3. The bug
647 occurred in an unlikely case, and due to validity checks it did not
648 affect successfully created archives.
650 Fixed a minor compatibility issue with the LZMS compressor and
651 decompressor. This is *not* the default compression type and was only
652 introduced in v1.6.0. In the unlikely event that you created an
653 LZMS-compressed WIM with v1.6.0 and a checksum error is reported when
654 applying it with v1.6.1, decompress it with v1.6.0 then compress it with
657 Memory usage for LZMS and LZX compression has been decreased.
659 wimextract now allows wildcard characters in paths specified on the
660 command line. Also, the '--strict-wildcards' option has been removed
661 and replaced with the inverse option '--nullglob'. See the
662 documentation for wimextract for more details and changes.
664 The wimlib_extract_files() function is now considered deprecated in
665 favor of wimlib_extract_paths().
667 Fixed more permissions problems when extracting files on Windows.
669 A new '--no-attributes' option has been added to wimapply and
670 wimextract. The library flag is WIMLIB_EXTRACT_FLAG_NO_ATTRIBUTES.
672 The default chunk size is now set correctly when changing the
673 compression type of a WIM, for example with 'wimoptimize'.
675 The '--metadata' option to wiminfo has been replaced with the
676 '--detailed' option to wimdir.
678 In relevant wimlib-imagex commands, '--solid' may now be used as an
679 alias for '--pack-streams'.
682 Support for extracting and updating the new version 3584 WIMs has been
683 added. These WIMs typically pack many streams ("files") together into a
684 single compressed resource, thereby saving space. This degrades the
685 performance of random access (such as that which occurs on a mounted
686 image), but optimizations have been implemented for extraction. These
687 new WIM files also typically use a new compression format (LZMS), which
688 is similar to LZMA and can offer a better compression ratio than LZX.
689 These new WIM files can be created using `wimcapture' with
690 the '--compress=lzms --pack-streams' options. Note: this new WIM format
691 is used by the Windows 8 web downloader, but important segments of the
692 raw '.esd' files are encrypted, so wimlib will not be able to extract
693 such files until they are first decrypted.
695 wimlib now supports extracting files and directories from a WIM image
696 based on a "listfile" that itself contains the list of paths to extract.
697 For `wimextract', the syntax is to specify @LISTFILE instead of a PATH,
698 and for the library itself, the new APIs are wimlib_extract_pathlist()
699 and wimlib_extract_paths(). Path globs containing wildcard characters
702 For searching WIM files, wimlib now has configurable case sensitivity.
703 The default on Windows is still case-insensitive and the default on
704 UNIX-like systems is still case-sensitive, but this can be overridden
705 on either platform through flags to wimlib_global_init(). For
706 `wimlib-imagex', the environmental variable WIMLIB_IMAGEX_IGNORE_CASE
707 can be set to 1 or 0 for case-insensitive or case-sensitive behavior,
710 Support for compression chunk sizes greater than the default of 32768
711 bytes has been added. A larger chunk size typically results in a better
712 compression ratio. However, the MS implementation is seemingly not
713 compatible with all chunk sizes, especially for LZX compression, so the
714 defaults remain unchanged, with the exception of the new LZMS-compressed
715 WIMs, which use a larger chunk size by default.
717 The compression/decompression API exported by wimlib has been changed.
718 Now one set of functions handles all supported compression formats.
720 `wimcapture' and `wimappend' will now display the progress of scanning
721 the directory tree to capture, in addition to the progress of writing
722 data to the WIM. The '--verbose' option no longer does anything. The
723 library API change for this is the addition of several members to
724 `struct wimlib_progress_info_scan' available to progress callbacks.
726 `mkwinpeimg' now correctly handles the '--start-script' option when the
727 start script is not in the working directory.
729 Sequential extraction, previously requested by using
730 WIMLIB_EXTRACT_FLAG_SEQUENTIAL, is now the default.
731 WIMLIB_EXTRACT_FLAG_FILE_ORDER can be used to get the old default
732 behavior (extract in file order).
735 The new LZX compressor added in v1.5.2 has been improved and is now
736 enabled by default, except when `wimcapture' or `wimappend' is run
737 *without* the '--compress' option, in which case the faster LZX
738 compressor is used (the same as before). This behavior is reasonably
739 consistent with ImageX which actually uses "fast" (XPRESS) compression
740 by default. In those cases, use '--compress=maximum' to explicitly
741 capture a WIM image using the new (slower but better) LZX compressor.
743 The '--compress-slow' option still exists to `wimlib-imagex optimize',
744 but its new behavior is to tweak the new LZX compressor even more to
745 produce an even better compression ratio at the cost of more time spent
748 `wimlib-imagex optimize' now supports the '--compress=TYPE' option,
749 which recompresses the WIM file using the specified compression TYPE.
750 The new library API function used for this is
751 wimlib_set_output_compression_type().
753 Added the wimlib_get_xml_data() function to allow library clients to
754 easily retrieve the raw XML data from a WIM file if needed.
756 Fixed a bug that could cause an error code to be incorrectly returned
757 when writing XML data containing a <WINDOWS> element.
759 Mounted WIM images will now correctly show the default file stream even
760 if appears in the alternate data stream entries of the corresponding WIM
764 Added a new experimental LZX compressor which can be enabled by passing
765 '--compress-slow' to `wimlib-imagex capture' or `wimlib-imagex
766 optimize'. (The latter is only applicable if the WIM is already
767 LZX-compressed and the '--recompress' option is also given.) The
768 experimental compressor is much slower but compresses the data slightly
769 more --- currently usually to within a fraction of a percent of the
770 results from WIMGAPI/ImageX.
772 A workaround has been added for compatibility with versions of WinPE
773 that interpret alternate data stream entries in the boot WIM
776 An alignment bug that caused a crash in the LZX decompressor on some
779 wimlib now attempts to clear the WIM_HDR_FLAG_WRITE_IN_PROGRESS flag in
780 the WIM header when restoring the previous state of a WIM it failed to
783 Added a workaround to avoid an access denied error on Windows when
784 replacing a WIM file that another process has opened.
787 wimlib can now open WinPE WIMs from WAIK v2.1, which had a quirk that
788 needed to be handled.
790 A bug in the interpretation of negative IMAGE indices in the
791 --update-of=[WIMFILE:]IMAGE option to `wimlib-imagex capture' and
792 `wimlib-imagex append' has been fixed.
794 A workaround has been added to successfully apply security descriptors
795 with empty DACLs when the NTFS-3g apply mode is being used with NTFS-3g
796 2013.1.13 or earlier.
798 `wimlib-imagex capture' can now accept the '--delta-from' option
802 Added support for "pipable" WIMs. Pipable WIMs allow capturing images
803 to standard output and applying images from standard input, but they are
804 not compatible with Microsoft's software and are not created by default.
805 See the documentation for --pipable flag of `wimlib-imagex capture' for
808 To better support incremental backups, added support for declaring an
809 image as a modified form of another image. See the documentation for
810 the '--update-of' option of `wimlib-imagex append' and `wimlib-imagex
813 Added supported for "delta" WIMs. See the documentation for the
814 '--delta-from' option of `wimlib-imagex capture'.
816 The library support for managing split WIMs has been changed to support
817 other arrangements, such as delta WIMs, and be easier to use. This
818 change is visible in `wimlib-imagex', which also can now accept the
819 '--ref' option multiple times, and also now supports "delta" WIMs as
822 wimlib now preserves WIM integrity tables by default, even if
823 WIMLIB_WRITE_FLAG_CHECK_INTEGRITY is not specified. This changes the
824 behavior of `wimlib-imagex' whenever the WIM being operated on contains
825 an integrity table and the '--check' option is not specified.
827 `wimlib-imagex capture' now creates LZX-compressed WIMs by default
828 (when --compress is not specified). This provides the best compression
829 ratio by default, which is usually what is desired, at a cost of some
832 `wimlib-imagex' now supports being invoked as wimCOMMAND, where COMMAND
833 is the command as in `wimlib-imagex COMMAND'; for example, it can be
834 invoked as `wimapply' as an alternative to `wimlib-imagex apply'. The
835 appropriate hard links are created in UNIX installations of
836 `wimlib-imagex', while for the Windows distribution of `wimlib-imagex',
837 batch files that emulate this behavior are generated.
839 Security descriptors are now extracted correctly on Windows.
841 Fixed archiving DOS names in NTFS-3g capture mode.
843 The extraction code has been rewritten and it will now be easier to
844 support new features on all supported backends (currently Win32, UNIX,
845 and NTFS-3g). For example, hard-linked extraction mode (--hardlink) is
846 now supported on all backends, not just UNIX.
848 `mkwinpeimg' now supports grabbing files from the WAIK supplement rather
849 than the WAIK itself.
851 wimlib_global_init() now, by default, attempts to acquire additional
852 privileges on Windows, so library clients need not do this.
854 This update bumps the shared library version number up to 9, since it is
855 not binary compatibible with previous releases.
858 Fixed bug in `wimlib-imagex export' that made it impossible to export an
859 image from a WIM that is readonly at the filesystem level.
861 Return error code rather than segfaulting when trying to list files from
862 a non-first part of a split WIM.
864 Joining a WIM will now preserve the RP_FIX and READONLY flags.
867 On Windows, paths given to wimlib-imagex are now treated case
870 Improved behavior regarding invalid filenames; in particular, on
871 Windows, wimlib-imagex will, when extracting, now omit (with an option
872 to override this default) filenames differing only in case, or filenames
873 containing characters not valid on Windows.
875 On Windows, wimlib now supports capturing and extracting long paths
876 (longer than the so-called MAX_PATH).
878 On Windows, `wimlib-imagex update' now acquires proper privileges when
879 running as an Administrator.
881 `wimlib-imagex update' will now complain if no image is specified when
882 trying to update a multi-image WIM.
884 `wimlib-imagex update' now supports specifying a single update command
885 directly on the command line using the --command option.
887 wimlib-imagex will now choose different units for progress messages,
888 depending on the amount of data that needs to be processed.
890 `wimlib-imagex append' will now generate a unique WIM image name if no
891 name is specified and the defaulted name already exists in the WIM.
893 wimlib now allows you to create unnamed WIM images, which can then only
894 be referred to by index.
896 wimlib now allows you to explicitly declare you want write access to a
897 WIM by providing the WIMLIB_OPEN_FLAG_WRITE_ACCESS flag to
900 wimlib now respects the WIM_HDR_FLAG_READONLY flag when set in the WIM
903 Progress callbacks have been added to wimlib's wimlib_update_image()
906 Added wimlib_get_wim_info(), wimlib_set_wim_info(),
907 wimlib_iterate_dir_tree(), and wimlib_iterate_lookup_table() functions
910 NTFS-3g capture now only warns about two conditions previously treated
913 Fixed a couple issues with using wimlib-imagex on UDF filesystems on
916 wimlib now correctly detects and returns an error when reading a WIM
917 image with a cyclic directory structure. (Fun fact: such a WIM will
918 crash Microsoft's software.)
921 Added new "extract" and "update" subcommands to wimlib-imagex, along
922 with associated APIs in the library. These commands are intended mainly
923 for Windows use but can be used on UNIX as well.
925 Many documentation improvements.
927 Fixed a bug in the Windows build where relative symbolic links were not
928 captured in reparse-point fixup mode.
930 Fixed a bug in the Windows build where file handles were left open to
931 the WIM file, causing `wimlib_imagex optimize' to fail in some cases.
933 Fixed a bug in the Windows build of wimlib-imagex where globbing
934 split-WIM parts could cause the program to crash.
936 Fixed a bug where the creation time of WIM images would be shown instead
937 of the last modification time.
939 With the Windows build it is now possible to restore a WIM containing
940 symbolic links as a non-Administrator; however you will receive warnings
941 about not being able to extract the symbolic links.
944 Capturing a WIM image should now be significantly faster in most cases
945 due to improved use of the operating system's cache and avoiding reading
946 files twice whenever possible.
948 The Windows build should now work on Windows XP.
950 The Windows build now supports capturing and restoring hidden,
951 compressed, sparse, and encrypted files.
953 The Windows build now supports capturing and applying WIM images from
954 filesystems other than NTFS (with some reduced functionality).
956 The Windows build now extracts short names correctly.
958 Added support for "reparse-point" fixups (i.e. fixing up of symbolic
959 links). See docs for --rpfix and --norpfix flags of `wimlib-imagex
960 capture' and `wimlib-imagex apply'.
962 The performance of splitting and joining WIMs should be slightly
965 The LZX and XPRESS compression and decompression functions are now
966 exported from the library.
969 Improvements and bugfixes for the Windows build.
971 Added --strict-acls options.
973 Fixed the way that wimlib determines the order of images in the WIM.
976 Since wimlib can now be used on Windows, wimlib's implementation of
977 ImageX has been renamed to wimlib-imagex to avoid confusion with
978 Microsoft's implementation of ImageX, which would have the same file
979 name ("imagex.exe"). If you really don't like this you can pass the
980 --with-imagex-progname option to `configure' to choose a different name,
981 or even simply rename the binary yourself (but the former way will
982 configure the man pages to use the chosen name).
984 Various bugs fixed in the Windows build. Mainly to do with capturing
985 and restoring alternate data streams correctly in weird cases, and
986 requesting the correct privileges when opening files. Also added the
987 --noacls options to wimlib-imagex capture, append, and apply.
989 Windows build again: FindFirstStreamW() and FindNextStreamW() are now
990 dynamically loaded, so this may make the library compatible with Windows
991 XP (however, there may still be other problems).
994 Added experimental support for native Windows builds. Binaries can be
995 downloaded from the SourceForge page.
997 --source-list option added to `imagex capture' and `imagex append'.
999 Better support for different character encodings.
1002 Storing UNIX file owners, groups, and modes in WIM images is now
1003 possible using `imagex capture' with the --unix-data flag.
1005 Minor bug fixes and documentation fixes.
1008 NTFS capture: Fixed capturing duplicate reparse points.
1010 NTFS capture: Capture first unnamed stream if there are more than one
1011 (print warning instead of error).
1013 Allow multiple test cases to execute concurrently (e.g. make -j2 check).
1016 Added --arch switch to mkwinpeimg script to support getting AMD64 WinPE
1019 Update to work with ntfs-3g version 2013.1.13.
1022 Fixed truncating file to shorter but non-zero length on read-write
1025 Various code cleanups and minor documentation fixes.
1028 LZX and XPRESS decompression have received some additional optimizations
1029 and should now be even faster. (Although, they were already pretty
1030 fast--- much faster than typical I/O speeds.)
1032 Fixed a bug introduced in v1.2.1 that would cause a directory tree
1033 containing hard links to be captured incorrectly in some cases.
1036 By default, unmounting a read-write mounted WIM with 'imagex unmount
1037 --commit' will now change the WIM in-place without needing to write the
1038 entire WIM again. Use 'imagex unmount --commit --rebuild' to get the
1041 'imagex unmount' no longer has a hard-coded limit of 10 minutes to wait
1042 for a response from the daemon servicing the mounted WIM. Instead,
1043 every second 'imagex unmount' will check if the daemon is still alive,
1044 and keep waiting if so, otherwise terminate with an error.
1046 'imagex unmount --commit' on a read-write mounted WIM will now print
1047 progress information regarding the writing of new or modified streams
1048 the WIM, just like when capturing or appending a WIM.
1050 A small change has been made to XPRESS compression and it should improve
1051 the compression ratio slightly.
1053 A change was made that may improve performance slightly when applying a
1054 WIM image to a NTFS volume.
1056 Microsoft has managed to introduce even more bugs into their software,
1057 and now the WIMs for Windows 8 have incorrect (too low) reference counts
1058 for some streams. This is unsafe because such streams can be removed
1059 when they are in actuality still referenced in the WIM (perhaps by a
1060 different image). wimlib will now work around this problem by fixing
1061 the stream reference counts. This is only done when wimlib_delete_image() is
1062 called ('imagex delete') or when wimlib_mount_image() is called with
1063 WIMLIB_MOUNT_FLAG_READWRITE ('imagex mountrw'). Please note that this
1064 requires reading the metadata for all images in the WIM, so this will
1065 make these operations noticably slower on WIMs with multiple images.
1067 Various other bugfixes.
1070 Appending images to a WIM is now be done by default without re-building
1071 the whole WIM. Use the --rebuild flag to get the old behavior (which
1072 was to re-build the entire WIM when a new image is appended).
1074 A new command `imagex optimize' is now available to manually re-build a
1075 WIM that has wasted space due to repeated appends.
1077 Progress information has been improved, and now arbitrary callback
1078 functions can be used to show the progress of a WIM operation.
1080 A possible bug with changing the bootable image of a WIM was fixed.
1082 Some advisory locking is now done to prevent two processes from
1083 modifying a WIM at the same time (but only in some cases). For example,
1084 you cannot mount two images from a WIM read-write at the same time.
1086 Some functions have been reorganized:
1087 * wimlib_mount() renamed to wimlib_mount_image().
1088 * wimlib_unmount() renamed to wimlib_unmount_image().
1089 * wimlib_overwrite_xml_and_header() removed as
1090 wimlib_overwrite() suffices now.
1091 * wimlib_apply_image_to_ntfs_volume() removed as
1092 wimlib_extract_image() suffices now.
1093 * wimlib_add_image_from_ntfs_volume() removed as
1094 * wimlib_add_image() suffices now.
1096 Previously, the soname of libwim.so has been 0.0.0, despite many
1097 interface changes. The soname is now updated to 1.0.0 and will now be
1098 updated each release.
1101 Resources will now be compressed using multiple threads by default.
1102 (This applies to `imagex capture', `imagex append', and `imagex
1105 Some performance improvements in mounted WIMs.
1107 More progress information is shown when capturing a WIM.
1110 Lots of minor fixes, code cleanups, and some documentation updates.
1111 Nothing in particular is really noteworthy.
1114 LZX and XPRESS compression improvements.
1116 Fixed calculation of Directory Count, File Count, Total Bytes, and Hard
1117 Link Bytes of the WIM.
1120 Fixed bug when capturing NTFS file with multiple named data streams.
1122 Internally, we are now using inode structures, even though these don't
1123 appear literally in the WIM file. This simplifies some of the code
1124 (mainly for WIM mounting) and likely fixed a few problems, although it
1128 Fixed problem when exporting images from XPRESS to LZX compressed WIM or
1132 Enough changes to call it version 1.0.0!
1134 Capturing a WIM directly from a NTFS volume, and applying a WIM directly
1135 to a NTFS volume, is now supported.
1137 Hard links and symbolic links have much improved support. They are
1138 supported for WIM capture, WIM application, and mounted WIMs (you can
1139 even make them on read-write mounted WIMs).
1141 Alternate data streams are now supported on mounted WIMs through an
1142 xattr or a Windows-style stream interface. Also they are supported when
1143 capturing a WIM from NTFS or applying a WIM to NTFS.
1145 Split WIMs are better supported. You may now apply an image directly
1146 from a split WIM, mount an image from a split WIM read-only, or export
1147 an image from a split WIM.
1149 Using a capture configuration file is now supported (but not fully yet).
1151 SHA1 message digests are checked in more places, so we can make sure
1152 applied and captured data is correct.
1154 Man pages have been updated and consolidated.
1157 Fixed segfault when unmounting read-only WIM.
1160 Support for joining and splitting WIMs.
1161 Also, security data is now preserved by default.
1164 Can now build with older gcc and system headers, like on CentOS 5.
1167 Fixed bug that made it impossible to overwrite files in read-write
1171 Write byte-order mark before WIM XML data. (imagex.exe requires this to
git://wimlib.net / wimlib / blob