2 wimsplit now prints progress messages regularly rather than just once
6 On Windows, improved performance of capturing an entire drive in some
9 On Windows, fixed leaking a directory handle (or triggering a SEH
10 exception when running under a debugger) when referencing WIM files.
12 On Windows, when applying a Windows OS image using the --compact flag,
13 bootloader files can now be compressed with stronger compression
14 algorithms if the version of Windows is recent enough to support it.
16 Clarified the license text.
19 Prevented miscompilation with gcc 10 at -O3
20 (https://gcc.gnu.org/bugzilla/show_bug.cgi?id=94994).
22 Avoided some compiler warnings with gcc 9 and later.
24 The 'mkwinpeimg' script now also looks for syslinux modules in
25 /usr/share/syslinux, to handle where openSUSE installs them.
27 Removed obsolete packaging files from the source tree.
30 Fixed a crash or incorrect output during LZMS compression with a
31 compression level greater than 50 and a chunk size greater than 64 MiB.
32 This affected wimlib v1.8.0 and later. In the unlikely event that you
33 used all these non-default compression settings in combination, e.g.
34 'wimcapture --solid --solid-compress=LZMS:100 --solid-chunk-size=128M',
35 run 'wimverify' on your archives to verify your data is intact.
38 On Windows, wimlib now supports capturing and applying extended
39 attributes (EAs). It is compatible with DISM with the /EA option,
40 available since Windows 10 version 1607. wimlib's EA support is on by
41 default and works on older versions of Windows too.
43 Partially fixed a bug where [ExclusionException] entries didn't take
44 effect when the containing directory is matched by [ExclusionList]. It
45 now works when the [ExclusionException] patterns are absolute. For
46 example, listing "/dir/file" in [ExclusionException] now works even if
47 "/dir" is matched by [ExclusionList].
49 Added a '--create' option to 'wimappend' which makes it create the WIM
50 file (like 'wimcapture') if it doesn't exist yet.
52 Added an '--include-integrity' option to various wimlib-imagex commands.
53 '--include-integrity' is like '--check', but it will just include an
54 integrity table in the output WIM(s), while skipping verification of any
55 existing integrity tables. This can be useful to avoid unwanted
56 verification of large WIM files, e.g. WIMs given by '--delta-from'.
58 'wimextract' now reads a pathlist file from standard input when "@-" is
61 wimsplit (API: wimlib_split()) now correctly handles a dot in the path
62 to the first split WIM part, prior to the filename extension.
64 'wimlib-imagex --version' now shows the version of the library it is
65 actually using (in case it is different from wimlib-imagex's version).
68 Fixed a bug that was causing the LZMS decompressor to be miscompiled
69 with GCC 7 (this broke extracting "solid" archives).
71 The Windows 10 Recycle Bin directory (\$RECYCLE.BIN) has been added to
72 the default exclusion list.
74 Added a '--quiet' option to wimlib-imagex.
76 The 'mkwinpeimg' script now also looks for the syslinux BIOS modules in
77 the directory /usr/lib/syslinux/modules/bios.
79 Files with timestamps before the year 1970 are now extracted correctly
80 to UNIX-style filesystems, are displayed correctly by
81 'wimdir --detailed', and show up correctly in mounted WIM images.
83 Files with timestamps after the year 2038 are now displayed correctly by
84 the 32-bit Windows build of wimlib.
87 Fixed a data corruption bug (incorrect compression) when storing an
88 already highly-compressed file in an LZX-compressed WIM with a chunk
89 size greater than or equal to 64K. Note that this is not the default
90 setting and such WIMs are not supported by Microsoft's WIM software, so
91 only users who used the --chunk-size option to wimlib-imagex or the
92 wimlib_set_output_chunk_size() API function may have been affected.
93 This bug was introduced in wimlib v1.10.0. See
94 https://wimlib.net/forums/viewtopic.php?f=1&t=300 for more details.
96 On all platforms, sparse files are now extracted as sparse.
98 Sparse files captured from UNIX-style filesystems are now marked as
99 sparse in the resulting WIM image.
101 Added support for storing Linux-style extended attributes in WIM images.
102 When the --unix-data option is used on Linux, wimlib-imagex now captures
103 and applies extended attributes, in addition to the already-supported
104 standard UNIX file permissions (owner/group/mode) and special files.
106 --delta-from is now supported by wimappend. (Previously it was only
107 supported by wimcapture.)
109 On Windows, improved the way in which files deduplicated with Windows'
110 Data Deduplication feature are captured.
112 The development files needed to link with wimlib using Visual Studio are
113 now included in the Windows release archives.
115 wimlib.h can now be included by Visual Studio without errors.
117 The example programs can now be compiled in C++ mode, and they also now
120 Updated 'mkwinpeimg' to work correctly on images that have a "windows"
121 (lower case) directory rather than a "Windows" (upper case) directory.
123 Fixed configuring with --enable-ssse3-sha1 from release tarball
124 (the file nasm_lt.sh was missing).
126 Made some documentation improvements.
129 The LZX compression ratio has been slightly improved. The default mode,
130 LZX level 50, is now almost as good as the old LZX level 100, while
131 being nearly the same speed as before.
133 Decompression performance has been slightly improved.
135 Filenames are now always listed in NTFS collation order.
137 On UNIX-like systems, wimlib can now process Windows filenames that are
138 not valid Unicode due to the presence of unpaired surrogates.
140 On UNIX-like systems, wimlib now always assumes UTF-8 encoding with the
141 addition of surrogate codepoints. Consequently, the environmental
142 variable WIMLIB_IMAGEX_USE_UTF8 and the flag
143 WIMLIB_INIT_FLAG_ASSUME_UTF8 no longer have any effect.
145 wimlib no longer depends on iconv.
147 Reduced memory usage slightly.
149 When a WIM image is applied in NTFS-3G mode, security descriptors are
150 now created in NTFS v3.0 format when supported by the volume.
152 Workarounds for bugs in libntfs-3g version 2013.1.13 and earlier have
153 been removed. Users are advised to upgrade to a later version of
156 On Windows, wimlib now supports case-sensitive filename extraction when
157 supported by the underlying operating system and filesystem (operating
158 system support requires a registry setting).
161 On UNIX, wimlib can now overwrite readonly files when extracting.
163 On Windows, fixed a bug where wimlib could leave a null DACL (a.k.a. "no
164 NTFS permissions") set on some existing directories after extraction.
166 On Windows, when applying a WIM image in "WIMBoot mode" when the WOF
167 driver is not loaded, wimlib can now correctly register a new WIM file
168 with the target volume when the target volume previously had had WIM
171 Added a new testing program.
173 Clarified the main license text and updated public domain dedications
174 for certain files to be more thorough.
177 Object IDs are now saved and restored on Windows and in NTFS-3G mode.
179 Reduced memory usage when exporting large numbers of WIM images.
181 Non UTF-8 locales are now detected correctly.
183 Addressed compiler warnings and enabled "silent" make rules by default.
185 Windows-specific updates:
186 Fixed a bug where duplicate backslashes could be generated in
187 link targets when extracting symbolic links and junctions.
189 Fixed a bug where the .cmd shortcuts for wimlib-imagex wouldn't
190 work if their full path contained a space.
192 Fixed bugs related to scanning SMB filesystems.
194 Added warning message about known issue with WindowsApps folder.
196 Added instructions for building from source on Windows.
198 VSS support is no longer marked "experimental".
200 Added missing license file for libdivsufsort-lite.
203 Added experimental support for Windows VSS (Volume Shadow Copy Service).
204 The new '--snapshot' argument to 'wimcapture' makes wimlib automatically
205 create and use a temporary VSS snapshot when capturing a WIM image.
207 Implemented setting of Windows-specific XML information, such as
208 architecture, system root, and version details. This information is now
209 automatically set in newly captured WIM images, when appropriate.
211 Improved performance of directory tree scans on Windows.
213 On Windows, to improve capture performance, wimlib now sometimes opens
214 files by inode number rather than by path. This is enabled for
215 wimcapture and wimappend, but for now other applications have to opt-in.
217 The progress messages printed by wimlib-imagex while writing WIM files
218 have been slightly tweaked.
220 Progress information for directory tree scans now counts all hard links.
221 Also, on Windows "\\?\" is no longer stripped from the current path.
223 Added a new '--image-property' option to 'wimcapture', 'wimappend', and
224 'wiminfo'. This option lets you assign values to elements in a WIM
225 file's XML document by name.
227 The wimlib_get_image_property() and wimlib_set_image_property() API
228 functions now support numerically indexed elements.
230 Fixed a bug where, on Windows, wimlib would change the security
231 descriptor of the target directory of an extraction even when the
232 '--no-acls' option was specified.
235 Fixed a bug with libntfs-3g extraction present since v1.8.1. Sometimes,
236 some Microsoft software would not correctly recognize data in the
237 resulting filesystem.
239 Made some small improvements to the compression algorithms:
240 LZX compression ratio was slightly improved.
241 XPRESS compression ratio and speed was slightly improved.
242 LZMS compression speed was slightly improved.
244 Improved handling of WIM XML data. wimlib no longer drops unrecognized
245 elements when exporting images. In addition, two API functions were
246 added for better access to elements in the XML document:
247 wimlib_get_image_property() and wimlib_set_image_property().
249 Added support for (unsafe) in-place compaction of WIM files.
251 Improved performance of image export by reusing metadata resources
252 instead of always rebuilding and recompressing them.
254 Improved performance of wimlib_update_image() by delaying the update to
255 the WIM's XML document until a write is requested.
257 On Windows, the target of an extraction may now be a reparse point
258 (which will be dereferenced).
260 On Windows, wimlib now correctly restores non-Microsoft reparse points.
261 However, this remains broken in NTFS-3g mode due to a libntfs-3g bug.
263 On Windows, wimlib now has improved performance when archiving files
264 from a filesystem backed by a WIM (a "WIMBoot" setup).
266 Several improvements to System Compression (compact mode) support:
268 wof.sys (or wofadk.sys) is now automatically attached to the
269 target volume if needed.
271 Compact-mode extractions now work correctly with wofadk.sys on
272 older versions of Windows.
274 For compatibility with the Windows bootloader, the requested
275 compression format now is overridden on certain files.
277 Other minor bugfixes.
280 This release primarily contains various minor bug fixes and
281 improvements, including:
283 Improved handling of deep directory structures.
285 Fixed a bug where on 32-bit systems, the library could enter an
286 infinite loop if a WIM file was malformed in a specific way.
288 Added a workaround for a case where libntfs-3g may report
289 duplicate streams in an NTFS file.
291 Windows symbolic links and junctions in mounted WIM images are
292 now automatically rewritten to be valid in the mounted location.
294 Reparse point fixes: correctly handle the "ReparseReserved"
295 field, and correctly handle "empty" (data-less) reparse points.
297 On Windows, wimlib now acquires SeManageVolumePrivilege, which
298 is needed to create externally backed files using the
301 Improved validation of filenames.
303 Improved LZMS decompression speed.
305 The configure script now honors alternate pkg-config settings.
307 Links have been updated to point to the new website.
309 In addition, experimental support has been added for compressing
310 extracted files using System Compression on Windows 10. This
311 functionality is available through the new '--compact' option to
312 'wimapply' and 'wimextract' as well as new library flags.
315 Fixed a bug in the LZX decompressor: malicious input data could cause
316 out of bounds writes to memory (since wimlib v1.2.2).
318 The output of the 'wiminfo' command now consolidates various boolean
319 flags (such as "Relative path junction") into a single line.
321 A file can now have both an unnamed data stream ("file contents") and a
322 reparse point stream. Such files can exist as a result of the use of
323 certain Windows features, such as offline storage, including "OneDrive".
324 wimlib will now store and restore both streams on Windows as well as in
325 NTFS-3g mode. Microsoft's WIMGAPI also has this behavior.
327 On Windows, named data streams of encrypted files are no longer stored
328 twice in WIM archives.
330 On Windows, named data streams are now correctly extracted to existing
331 "readonly" directories. Before, an error would be reported.
333 On Windows, it is now possible to do a "WIMBoot mode" extraction with
334 non-standalone WIMs such as delta WIMs.
336 On Windows, when doing an extraction in "WIMBoot mode", files larger
337 than 4 gigabytes are now never extracted as externally backed. This
338 works around a bug in Microsoft's "WOF" driver.
340 The '--enable-verify-compression' configure option has been removed. If
341 you want to verify a WIM file, use the 'wimverify' program.
343 The way the "file count", "directory count", "total bytes", and "hard
344 link bytes" image statistics (stored in the WIM XML data) is calculated
345 has been slightly changed.
347 In mounted WIM images, the disk usage provided for each file (st_blocks)
348 is now the compressed size rather than the uncompressed size.
350 The performance of the NTFS-3g and Windows capture modes has been
353 On UNIX-like systems, symbolic links whose targets contain the backslash
354 character are now handled correctly (losslessly).
357 Improved the LZX compressor. It is now 15-20% faster than before and
358 provides a slightly better compression ratio.
360 Improved the LZMS compressor. It now provides a compression ratio
361 slightly better than WIMGAPI while still being faster and using slightly
364 The compression chunk size in solid resources, e.g. when capturing or
365 exporting a WIM file using the '--solid' option, now defaults to 64 MiB
366 (67108864 bytes) instead of 32 MiB (33554432 bytes). This provides a
367 better compression ratio and is the same value that WIMGAPI uses. The
368 memory usage is less than 50% higher than wimlib v1.7.4 and is slightly
369 lower than WIMGAPI's memory usage, but if it is too much, it is still
370 possible to choose a lower value, e.g. with the '--solid-chunk-size'
371 option to wimlib-imagex.
373 The '--chunk-size' and '--solid-chunk-size' options to wimlib-imagex now
374 accept the 'K', 'M', and 'G' suffixes.
376 Files are now sorted by name extension when creating a solid WIM file.
378 Fixed various issues related to capture/apply of EFS-encrypted files on
381 The file list printed by 'wimdir' is now sorted by the platform-specific
382 case sensitivity setting, rather than always case sensitively. This
383 also affects the library function wimlib_iterate_dir_tree().
385 On Windows, some error and warning messages have been improved.
388 The Windows binary distribution no longer contains third party DLLs.
389 These dependencies are instead compiled directly into the libwim DLL.
391 Added more fixes for wimlib on non-x86 architectures such as ARM.
393 Extracting files to a Windows PE in-memory filesystem no longer fails if
394 the target files do not yet exist.
396 Improved the performance of XPRESS compression and LZMS decompression.
398 Enabled SSSE3 accelerated SHA-1 computation in x86_64 Windows builds.
399 It will automatically be faster on newer Intel and AMD processors.
401 Removed the --with-imagex-progname and --enable-more-assertions
405 Fix for very slow export from solid WIM / ESD files.
407 Fix for LZX and LZMS algorithms on non-x86 architectures, such as ARM.
409 New progress message: WIMLIB_PROGRESS_MSG_HANDLE_ERROR. Applications
410 may use this to treat some types of errors as non-fatal.
412 The library now permits making in-memory changes to a WIMStruct backed
413 by a read-only WIM file.
415 Fixes for "WIMBoot" extraction mode (Windows only):
417 When not using the WOF driver, extraction no longer fails if the
418 disk containing the WIM file has too many partitions.
420 When matching patterns in [PrepopulateList], all hard links of
421 each file are now considered.
423 The system registry files are now automatically treated as being
424 in [PrepopulateList].
426 Added a hack to try to work around an intermittent bug in
427 Microsoft's WOF (Windows Overlay Filesystem) driver.
430 Made more improvements to the XPRESS, LZX, and LZMS compressors.
432 A number of improvements to the Windows port:
434 Fixes for setting short filenames.
436 Faster "WIMBoot" extraction.
438 Updated and slimmed down the dependent DLLs.
440 ACL inheritence bits are now restored.
442 Mandatory integrity labels are now backed up and restored.
444 Added a workaround for an issue where in rare cases, wimlib could create
445 a compressed data stream that could not be read correctly by Windows
446 after an extraction in "WIMBoot" mode.
449 Added file count progress data for
450 WIMLIB_PROGRESS_MSG_EXTRACT_FILE_STRUCTURE and
451 WIMLIB_PROGRESS_MSG_EXTRACT_METADATA.
453 Added support for testing file exclusions via the user-provided
456 Some documentation improvements.
458 Made some clarifications to the license text in the COPYING file.
461 Made more improvements to the XPRESS, LZX, and LZMS compressors.
463 The default compression mode for wimcapture is now LZX compression in
464 its default mode, which is the same as '--compress=maximum'.
466 You can now specify an optional integer compression level to the
467 '--compress' option; e.g. '--compress=lzx:75'.
469 Made a minor change to the LZMS compressor and decompressor to fix an
470 incompatibility with the Microsoft implementation. In the unlikely
471 event that you created an LZMS-compressed WIM with wimlib v1.7.0 or
472 earlier and a checksum error is reported when extracting files from it
473 with wimlib v1.7.1, decompress it with v1.7.0 then compress it with
476 Added 'verify' subcommand to wimlib-imagex.
478 Notable library changes:
480 Custom compressor parameters have been removed from the library
481 in favor of the simpler level-based API.
483 Decompressor parameters have been removed entirely.
485 Library users can now specify a custom file for warning and
486 error messages to be sent to, rather than the default of
489 New progress messages:
490 WIMLIB_PROGRESS_MSG_EXTRACT_FILE_STRUCTURE,
491 WIMLIB_PROGRESS_MSG_EXTRACT_METADATA.
493 New function: wimlib_verify_wim().
496 Improved compression, decompression, and extraction performance.
498 Improved compatibility with version 3584 WIM / ESD files:
499 - Add support for reading and writing multiple solid blocks per
500 archive, which WIMGAPI/DISM can create when appending an image.
501 - Correctly create solid blocks larger than 4 GiB.
503 'add' commands passed to wimupdate will now replace existing
504 nondirectory files by default. Use the --no-replace option to get the
507 The license for the library now contains an exception that allows using
508 it under the LGPL. See the COPYING file for details.
510 In reparse-point fixup mode (the default for capture), symbolic links
511 and junctions that point outside the tree being captured are no longer
512 excluded from capture.
514 Added support for "WIMBoot" capture and extraction. See the
515 documentation for the new '--wimboot' option to wimcapture and wimapply
516 for more information.
518 On UNIX-like systems, you can now backup and restore device nodes, named
519 pipes, and sockets. In addition, 32-bit user and group IDs are now
522 The way that UNIX data is stored in WIM files has been changed. If you
523 captured any WIMs with the --unix-data option, to upgrade them you'll
524 need to apply them with --unix-data using wimlib-imagex v1.6.2, then
525 re-capture them with --unix-data using this version.
527 wimlib now understands tagged metadata items, such as object IDs, that
528 can be stored in WIM directory entries.
530 Removed the --hardlink and --symlink options to wimapply, since I don't
531 think they are too useful and they got in the way of improving the code.
533 WIMs will now retain their GUIDs when rebuilt (e.g. with wimoptimize).
535 The 'mkwinpeimg' script now supports writing the ISO image to standard
538 The <ARCH> element in WIM XML data is now exported correctly.
540 On Windows, sparse file attributes are no longer set on extracted files.
541 Oddly enough, this actually saves disk space in some cases.
543 On UNIX, configuring with --disable-xattr or --enable-xattr is no longer
544 supported. Mounting WIM images now always requires extended attribute
545 support. Use --without-fuse to disable support for mounting WIM images;
546 this will also disable the need for extended attribute support.
548 Configuring with --enable-ssse3-sha1 now works correctly.
550 The shared library version has been bumped up. The main
551 incompatibilities are:
553 - WIMLIB_COMPRESSION_TYPE_XPRESS is now 1 and
554 WIMLIB_COMPRESSION_TYPE_LZX is now 2 (so it's the same as
557 - User-provided progress functions are now registered using a
558 separate function, wimlib_register_progress_function(). The
559 'progress_func' argument to many functions no longer exists.
561 - The return value from user-provided progress functions is now
564 - A context argument has been added to the prototype of
565 user-provided progress functions.
567 - 'struct wimlib_capture_config' has been removed. The library
568 now takes the path to the configuration file directly. This
569 affects wimlib_add_image(), wimlib_add_image_multisource(),
570 and wimlib_update_image(). However, a NULL value passed in
571 the argument retains the same meaning.
573 - Removed deprecated functions: some (de)compression functions,
574 wimlib_extract_files(), and wimlib_print_metadata().
576 - Removed extraction flags: WIMLIB_EXTRACT_FLAG_HARDLINK,
577 WIMLIB_EXTRACT_FLAG_SYMLINK, WIMLIB_EXTRACT_FLAG_FILE_ORDER,
578 and WIMLIB_EXTRACT_FLAG_SEQUENTIAL.
580 - Removed some progress messages:
581 WIMLIB_PROGRESS_MSG_APPLY_TIMESTAMPS,
582 WIMLIB_PROGRESS_MSG_EXTRACT_DIR_STRUCTURE_BEGIN,
583 WIMLIB_PROGRESS_MSG_EXTRACT_DIR_STRUCTURE_END. Numbering
586 - Removed some error codes. Numbering stays the same.
588 - Replaced WIMLIB_UNMOUNT_FLAG_LAZY with
589 WIMLIB_UNMOUNT_FLAG_FORCE.
591 - WIM paths passed to progress functions now have a leading
595 Case-insensitive comparisons of strings (e.g. filenames) containing
596 UTF-16 codepoints above 32767 are now done correctly.
598 Fixed build failure on Mac OS X.
600 wimunmount now provides the '--new-image' option to cause changes to a
601 read-write mounted image to be committed as a new image rather than as
602 an update of the mounted image. (The corresponding new library flag is
603 WIMLIB_UNMOUNT_FLAG_NEW_IMAGE.)
605 The LZMS ("recovery") compression chunk size, or "dictionary size", may
606 now be up to 1 GiB (1,073,741,824 bytes).
608 The performance of LZX ("maximum") and LZMS ("recovery") compression
609 with large chunk sizes has been slightly improved.
612 Stored files with size exactly 4 GiB (4,294,967,296 bytes) are now
613 decompressed correctly.
615 Fixed a bug in the LZX compressor introduced in v1.5.3. The bug
616 occurred in an unlikely case, and due to validity checks it did not
617 affect successfully created archives.
619 Fixed a minor compatibility issue with the LZMS compressor and
620 decompressor. This is *not* the default compression type and was only
621 introduced in v1.6.0. In the unlikely event that you created an
622 LZMS-compressed WIM with v1.6.0 and a checksum error is reported when
623 applying it with v1.6.1, decompress it with v1.6.0 then compress it with
626 Memory usage for LZMS and LZX compression has been decreased.
628 wimextract now allows wildcard characters in paths specified on the
629 command line. Also, the '--strict-wildcards' option has been removed
630 and replaced with the inverse option '--nullglob'. See the
631 documentation for wimextract for more details and changes.
633 The wimlib_extract_files() function is now considered deprecated in
634 favor of wimlib_extract_paths().
636 Fixed more permissions problems when extracting files on Windows.
638 A new '--no-attributes' option has been added to wimapply and
639 wimextract. The library flag is WIMLIB_EXTRACT_FLAG_NO_ATTRIBUTES.
641 The default chunk size is now set correctly when changing the
642 compression type of a WIM, for example with 'wimoptimize'.
644 The '--metadata' option to wiminfo has been replaced with the
645 '--detailed' option to wimdir.
647 In relevant wimlib-imagex commands, '--solid' may now be used as an
648 alias for '--pack-streams'.
651 Support for extracting and updating the new version 3584 WIMs has been
652 added. These WIMs typically pack many streams ("files") together into a
653 single compressed resource, thereby saving space. This degrades the
654 performance of random access (such as that which occurs on a mounted
655 image), but optimizations have been implemented for extraction. These
656 new WIM files also typically use a new compression format (LZMS), which
657 is similar to LZMA and can offer a better compression ratio than LZX.
658 These new WIM files can be created using `wimcapture' with
659 the '--compress=lzms --pack-streams' options. Note: this new WIM format
660 is used by the Windows 8 web downloader, but important segments of the
661 raw '.esd' files are encrypted, so wimlib will not be able to extract
662 such files until they are first decrypted.
664 wimlib now supports extracting files and directories from a WIM image
665 based on a "listfile" that itself contains the list of paths to extract.
666 For `wimextract', the syntax is to specify @LISTFILE instead of a PATH,
667 and for the library itself, the new APIs are wimlib_extract_pathlist()
668 and wimlib_extract_paths(). Path globs containing wildcard characters
671 For searching WIM files, wimlib now has configurable case sensitivity.
672 The default on Windows is still case-insensitive and the default on
673 UNIX-like systems is still case-sensitive, but this can be overridden
674 on either platform through flags to wimlib_global_init(). For
675 `wimlib-imagex', the environmental variable WIMLIB_IMAGEX_IGNORE_CASE
676 can be set to 1 or 0 for case-insensitive or case-sensitive behavior,
679 Support for compression chunk sizes greater than the default of 32768
680 bytes has been added. A larger chunk size typically results in a better
681 compression ratio. However, the MS implementation is seemingly not
682 compatible with all chunk sizes, especially for LZX compression, so the
683 defaults remain unchanged, with the exception of the new LZMS-compressed
684 WIMs, which use a larger chunk size by default.
686 The compression/decompression API exported by wimlib has been changed.
687 Now one set of functions handles all supported compression formats.
689 `wimcapture' and `wimappend' will now display the progress of scanning
690 the directory tree to capture, in addition to the progress of writing
691 data to the WIM. The '--verbose' option no longer does anything. The
692 library API change for this is the addition of several members to
693 `struct wimlib_progress_info_scan' available to progress callbacks.
695 `mkwinpeimg' now correctly handles the '--start-script' option when the
696 start script is not in the working directory.
698 Sequential extraction, previously requested by using
699 WIMLIB_EXTRACT_FLAG_SEQUENTIAL, is now the default.
700 WIMLIB_EXTRACT_FLAG_FILE_ORDER can be used to get the old default
701 behavior (extract in file order).
704 The new LZX compressor added in v1.5.2 has been improved and is now
705 enabled by default, except when `wimcapture' or `wimappend' is run
706 *without* the '--compress' option, in which case the faster LZX
707 compressor is used (the same as before). This behavior is reasonably
708 consistent with ImageX which actually uses "fast" (XPRESS) compression
709 by default. In those cases, use '--compress=maximum' to explicitly
710 capture a WIM image using the new (slower but better) LZX compressor.
712 The '--compress-slow' option still exists to `wimlib-imagex optimize',
713 but its new behavior is to tweak the new LZX compressor even more to
714 produce an even better compression ratio at the cost of more time spent
717 `wimlib-imagex optimize' now supports the '--compress=TYPE' option,
718 which recompresses the WIM file using the specified compression TYPE.
719 The new library API function used for this is
720 wimlib_set_output_compression_type().
722 Added the wimlib_get_xml_data() function to allow library clients to
723 easily retrieve the raw XML data from a WIM file if needed.
725 Fixed a bug that could cause an error code to be incorrectly returned
726 when writing XML data containing a <WINDOWS> element.
728 Mounted WIM images will now correctly show the default file stream even
729 if appears in the alternate data stream entries of the corresponding WIM
733 Added a new experimental LZX compressor which can be enabled by passing
734 '--compress-slow' to `wimlib-imagex capture' or `wimlib-imagex
735 optimize'. (The latter is only applicable if the WIM is already
736 LZX-compressed and the '--recompress' option is also given.) The
737 experimental compressor is much slower but compresses the data slightly
738 more --- currently usually to within a fraction of a percent of the
739 results from WIMGAPI/ImageX.
741 A workaround has been added for compatibility with versions of WinPE
742 that interpret alternate data stream entries in the boot WIM
745 An alignment bug that caused a crash in the LZX decompressor on some
748 wimlib now attempts to clear the WIM_HDR_FLAG_WRITE_IN_PROGRESS flag in
749 the WIM header when restoring the previous state of a WIM it failed to
752 Added a workaround to avoid an access denied error on Windows when
753 replacing a WIM file that another process has opened.
756 wimlib can now open WinPE WIMs from WAIK v2.1, which had a quirk that
757 needed to be handled.
759 A bug in the interpretation of negative IMAGE indices in the
760 --update-of=[WIMFILE:]IMAGE option to `wimlib-imagex capture' and
761 `wimlib-imagex append' has been fixed.
763 A workaround has been added to successfully apply security descriptors
764 with empty DACLs when the NTFS-3g apply mode is being used with NTFS-3g
765 2013.1.13 or earlier.
767 `wimlib-imagex capture' can now accept the '--delta-from' option
771 Added support for "pipable" WIMs. Pipable WIMs allow capturing images
772 to standard output and applying images from standard input, but they are
773 not compatible with Microsoft's software and are not created by default.
774 See the documentation for --pipable flag of `wimlib-imagex capture' for
777 To better support incremental backups, added support for declaring an
778 image as a modified form of another image. See the documentation for
779 the '--update-of' option of `wimlib-imagex append' and `wimlib-imagex
782 Added supported for "delta" WIMs. See the documentation for the
783 '--delta-from' option of `wimlib-imagex capture'.
785 The library support for managing split WIMs has been changed to support
786 other arrangements, such as delta WIMs, and be easier to use. This
787 change is visible in `wimlib-imagex', which also can now accept the
788 '--ref' option multiple times, and also now supports "delta" WIMs as
791 wimlib now preserves WIM integrity tables by default, even if
792 WIMLIB_WRITE_FLAG_CHECK_INTEGRITY is not specified. This changes the
793 behavior of `wimlib-imagex' whenever the WIM being operated on contains
794 an integrity table and the '--check' option is not specified.
796 `wimlib-imagex capture' now creates LZX-compressed WIMs by default
797 (when --compress is not specified). This provides the best compression
798 ratio by default, which is usually what is desired, at a cost of some
801 `wimlib-imagex' now supports being invoked as wimCOMMAND, where COMMAND
802 is the command as in `wimlib-imagex COMMAND'; for example, it can be
803 invoked as `wimapply' as an alternative to `wimlib-imagex apply'. The
804 appropriate hard links are created in UNIX installations of
805 `wimlib-imagex', while for the Windows distribution of `wimlib-imagex',
806 batch files that emulate this behavior are generated.
808 Security descriptors are now extracted correctly on Windows.
810 Fixed archiving DOS names in NTFS-3g capture mode.
812 The extraction code has been rewritten and it will now be easier to
813 support new features on all supported backends (currently Win32, UNIX,
814 and NTFS-3g). For example, hard-linked extraction mode (--hardlink) is
815 now supported on all backends, not just UNIX.
817 `mkwinpeimg' now supports grabbing files from the WAIK supplement rather
818 than the WAIK itself.
820 wimlib_global_init() now, by default, attempts to acquire additional
821 privileges on Windows, so library clients need not do this.
823 This update bumps the shared library version number up to 9, since it is
824 not binary compatibible with previous releases.
827 Fixed bug in `wimlib-imagex export' that made it impossible to export an
828 image from a WIM that is readonly at the filesystem level.
830 Return error code rather than segfaulting when trying to list files from
831 a non-first part of a split WIM.
833 Joining a WIM will now preserve the RP_FIX and READONLY flags.
836 On Windows, paths given to wimlib-imagex are now treated case
839 Improved behavior regarding invalid filenames; in particular, on
840 Windows, wimlib-imagex will, when extracting, now omit (with an option
841 to override this default) filenames differing only in case, or filenames
842 containing characters not valid on Windows.
844 On Windows, wimlib now supports capturing and extracting long paths
845 (longer than the so-called MAX_PATH).
847 On Windows, `wimlib-imagex update' now acquires proper privileges when
848 running as an Administrator.
850 `wimlib-imagex update' will now complain if no image is specified when
851 trying to update a multi-image WIM.
853 `wimlib-imagex update' now supports specifying a single update command
854 directly on the command line using the --command option.
856 wimlib-imagex will now choose different units for progress messages,
857 depending on the amount of data that needs to be processed.
859 `wimlib-imagex append' will now generate a unique WIM image name if no
860 name is specified and the defaulted name already exists in the WIM.
862 wimlib now allows you to create unnamed WIM images, which can then only
863 be referred to by index.
865 wimlib now allows you to explicitly declare you want write access to a
866 WIM by providing the WIMLIB_OPEN_FLAG_WRITE_ACCESS flag to
869 wimlib now respects the WIM_HDR_FLAG_READONLY flag when set in the WIM
872 Progress callbacks have been added to wimlib's wimlib_update_image()
875 Added wimlib_get_wim_info(), wimlib_set_wim_info(),
876 wimlib_iterate_dir_tree(), and wimlib_iterate_lookup_table() functions
879 NTFS-3g capture now only warns about two conditions previously treated
882 Fixed a couple issues with using wimlib-imagex on UDF filesystems on
885 wimlib now correctly detects and returns an error when reading a WIM
886 image with a cyclic directory structure. (Fun fact: such a WIM will
887 crash Microsoft's software.)
890 Added new "extract" and "update" subcommands to wimlib-imagex, along
891 with associated APIs in the library. These commands are intended mainly
892 for Windows use but can be used on UNIX as well.
894 Many documentation improvements.
896 Fixed a bug in the Windows build where relative symbolic links were not
897 captured in reparse-point fixup mode.
899 Fixed a bug in the Windows build where file handles were left open to
900 the WIM file, causing `wimlib_imagex optimize' to fail in some cases.
902 Fixed a bug in the Windows build of wimlib-imagex where globbing
903 split-WIM parts could cause the program to crash.
905 Fixed a bug where the creation time of WIM images would be shown instead
906 of the last modification time.
908 With the Windows build it is now possible to restore a WIM containing
909 symbolic links as a non-Administrator; however you will receive warnings
910 about not being able to extract the symbolic links.
913 Capturing a WIM image should now be significantly faster in most cases
914 due to improved use of the operating system's cache and avoiding reading
915 files twice whenever possible.
917 The Windows build should now work on Windows XP.
919 The Windows build now supports capturing and restoring hidden,
920 compressed, sparse, and encrypted files.
922 The Windows build now supports capturing and applying WIM images from
923 filesystems other than NTFS (with some reduced functionality).
925 The Windows build now extracts short names correctly.
927 Added support for "reparse-point" fixups (i.e. fixing up of symbolic
928 links). See docs for --rpfix and --norpfix flags of `wimlib-imagex
929 capture' and `wimlib-imagex apply'.
931 The performance of splitting and joining WIMs should be slightly
934 The LZX and XPRESS compression and decompression functions are now
935 exported from the library.
938 Improvements and bugfixes for the Windows build.
940 Added --strict-acls options.
942 Fixed the way that wimlib determines the order of images in the WIM.
945 Since wimlib can now be used on Windows, wimlib's implementation of
946 ImageX has been renamed to wimlib-imagex to avoid confusion with
947 Microsoft's implementation of ImageX, which would have the same file
948 name ("imagex.exe"). If you really don't like this you can pass the
949 --with-imagex-progname option to `configure' to choose a different name,
950 or even simply rename the binary yourself (but the former way will
951 configure the man pages to use the chosen name).
953 Various bugs fixed in the Windows build. Mainly to do with capturing
954 and restoring alternate data streams correctly in weird cases, and
955 requesting the correct privileges when opening files. Also added the
956 --noacls options to wimlib-imagex capture, append, and apply.
958 Windows build again: FindFirstStreamW() and FindNextStreamW() are now
959 dynamically loaded, so this may make the library compatible with Windows
960 XP (however, there may still be other problems).
963 Added experimental support for native Windows builds. Binaries can be
964 downloaded from the SourceForge page.
966 --source-list option added to `imagex capture' and `imagex append'.
968 Better support for different character encodings.
971 Storing UNIX file owners, groups, and modes in WIM images is now
972 possible using `imagex capture' with the --unix-data flag.
974 Minor bug fixes and documentation fixes.
977 NTFS capture: Fixed capturing duplicate reparse points.
979 NTFS capture: Capture first unnamed stream if there are more than one
980 (print warning instead of error).
982 Allow multiple test cases to execute concurrently (e.g. make -j2 check).
985 Added --arch switch to mkwinpeimg script to support getting AMD64 WinPE
988 Update to work with ntfs-3g version 2013.1.13.
991 Fixed truncating file to shorter but non-zero length on read-write
994 Various code cleanups and minor documentation fixes.
997 LZX and XPRESS decompression have received some additional optimizations
998 and should now be even faster. (Although, they were already pretty
999 fast--- much faster than typical I/O speeds.)
1001 Fixed a bug introduced in v1.2.1 that would cause a directory tree
1002 containing hard links to be captured incorrectly in some cases.
1005 By default, unmounting a read-write mounted WIM with 'imagex unmount
1006 --commit' will now change the WIM in-place without needing to write the
1007 entire WIM again. Use 'imagex unmount --commit --rebuild' to get the
1010 'imagex unmount' no longer has a hard-coded limit of 10 minutes to wait
1011 for a response from the daemon servicing the mounted WIM. Instead,
1012 every second 'imagex unmount' will check if the daemon is still alive,
1013 and keep waiting if so, otherwise terminate with an error.
1015 'imagex unmount --commit' on a read-write mounted WIM will now print
1016 progress information regarding the writing of new or modified streams
1017 the WIM, just like when capturing or appending a WIM.
1019 A small change has been made to XPRESS compression and it should improve
1020 the compression ratio slightly.
1022 A change was made that may improve performance slightly when applying a
1023 WIM image to a NTFS volume.
1025 Microsoft has managed to introduce even more bugs into their software,
1026 and now the WIMs for Windows 8 have incorrect (too low) reference counts
1027 for some streams. This is unsafe because such streams can be removed
1028 when they are in actuality still referenced in the WIM (perhaps by a
1029 different image). wimlib will now work around this problem by fixing
1030 the stream reference counts. This is only done when wimlib_delete_image() is
1031 called ('imagex delete') or when wimlib_mount_image() is called with
1032 WIMLIB_MOUNT_FLAG_READWRITE ('imagex mountrw'). Please note that this
1033 requires reading the metadata for all images in the WIM, so this will
1034 make these operations noticably slower on WIMs with multiple images.
1036 Various other bugfixes.
1039 Appending images to a WIM is now be done by default without re-building
1040 the whole WIM. Use the --rebuild flag to get the old behavior (which
1041 was to re-build the entire WIM when a new image is appended).
1043 A new command `imagex optimize' is now available to manually re-build a
1044 WIM that has wasted space due to repeated appends.
1046 Progress information has been improved, and now arbitrary callback
1047 functions can be used to show the progress of a WIM operation.
1049 A possible bug with changing the bootable image of a WIM was fixed.
1051 Some advisory locking is now done to prevent two processes from
1052 modifying a WIM at the same time (but only in some cases). For example,
1053 you cannot mount two images from a WIM read-write at the same time.
1055 Some functions have been reorganized:
1056 * wimlib_mount() renamed to wimlib_mount_image().
1057 * wimlib_unmount() renamed to wimlib_unmount_image().
1058 * wimlib_overwrite_xml_and_header() removed as
1059 wimlib_overwrite() suffices now.
1060 * wimlib_apply_image_to_ntfs_volume() removed as
1061 wimlib_extract_image() suffices now.
1062 * wimlib_add_image_from_ntfs_volume() removed as
1063 * wimlib_add_image() suffices now.
1065 Previously, the soname of libwim.so has been 0.0.0, despite many
1066 interface changes. The soname is now updated to 1.0.0 and will now be
1067 updated each release.
1070 Resources will now be compressed using multiple threads by default.
1071 (This applies to `imagex capture', `imagex append', and `imagex
1074 Some performance improvements in mounted WIMs.
1076 More progress information is shown when capturing a WIM.
1079 Lots of minor fixes, code cleanups, and some documentation updates.
1080 Nothing in particular is really noteworthy.
1083 LZX and XPRESS compression improvements.
1085 Fixed calculation of Directory Count, File Count, Total Bytes, and Hard
1086 Link Bytes of the WIM.
1089 Fixed bug when capturing NTFS file with multiple named data streams.
1091 Internally, we are now using inode structures, even though these don't
1092 appear literally in the WIM file. This simplifies some of the code
1093 (mainly for WIM mounting) and likely fixed a few problems, although it
1097 Fixed problem when exporting images from XPRESS to LZX compressed WIM or
1101 Enough changes to call it version 1.0.0!
1103 Capturing a WIM directly from a NTFS volume, and applying a WIM directly
1104 to a NTFS volume, is now supported.
1106 Hard links and symbolic links have much improved support. They are
1107 supported for WIM capture, WIM application, and mounted WIMs (you can
1108 even make them on read-write mounted WIMs).
1110 Alternate data streams are now supported on mounted WIMs through an
1111 xattr or a Windows-style stream interface. Also they are supported when
1112 capturing a WIM from NTFS or applying a WIM to NTFS.
1114 Split WIMs are better supported. You may now apply an image directly
1115 from a split WIM, mount an image from a split WIM read-only, or export
1116 an image from a split WIM.
1118 Using a capture configuration file is now supported (but not fully yet).
1120 SHA1 message digests are checked in more places, so we can make sure
1121 applied and captured data is correct.
1123 Man pages have been updated and consolidated.
1126 Fixed segfault when unmounting read-only WIM.
1129 Support for joining and splitting WIMs.
1130 Also, security data is now preserved by default.
1133 Can now build with older gcc and system headers, like on CentOS 5.
1136 Fixed bug that made it impossible to overwrite files in read-write
1140 Write byte-order mark before WIM XML data. (imagex.exe requires this to
git://wimlib.net / wimlib / blob