2 On Windows, improved performance of capturing an entire drive in some
5 On Windows, fixed leaking a directory handle (or triggering a SEH
6 exception when running under a debugger) when referencing WIM files.
8 On Windows, when applying a Windows OS image using the --compact flag,
9 bootloader files can now be compressed with stronger compression
10 algorithms if the version of Windows is recent enough to support it.
12 Clarified the license text.
15 Prevented miscompilation with gcc 10 at -O3
16 (https://gcc.gnu.org/bugzilla/show_bug.cgi?id=94994).
18 Avoided some compiler warnings with gcc 9 and later.
20 The 'mkwinpeimg' script now also looks for syslinux modules in
21 /usr/share/syslinux, to handle where openSUSE installs them.
23 Removed obsolete packaging files from the source tree.
26 Fixed a crash or incorrect output during LZMS compression with a
27 compression level greater than 50 and a chunk size greater than 64 MiB.
28 This affected wimlib v1.8.0 and later. In the unlikely event that you
29 used all these non-default compression settings in combination, e.g.
30 'wimcapture --solid --solid-compress=LZMS:100 --solid-chunk-size=128M',
31 run 'wimverify' on your archives to verify your data is intact.
34 On Windows, wimlib now supports capturing and applying extended
35 attributes (EAs). It is compatible with DISM with the /EA option,
36 available since Windows 10 version 1607. wimlib's EA support is on by
37 default and works on older versions of Windows too.
39 Partially fixed a bug where [ExclusionException] entries didn't take
40 effect when the containing directory is matched by [ExclusionList]. It
41 now works when the [ExclusionException] patterns are absolute. For
42 example, listing "/dir/file" in [ExclusionException] now works even if
43 "/dir" is matched by [ExclusionList].
45 Added a '--create' option to 'wimappend' which makes it create the WIM
46 file (like 'wimcapture') if it doesn't exist yet.
48 Added an '--include-integrity' option to various wimlib-imagex commands.
49 '--include-integrity' is like '--check', but it will just include an
50 integrity table in the output WIM(s), while skipping verification of any
51 existing integrity tables. This can be useful to avoid unwanted
52 verification of large WIM files, e.g. WIMs given by '--delta-from'.
54 'wimextract' now reads a pathlist file from standard input when "@-" is
57 wimsplit (API: wimlib_split()) now correctly handles a dot in the path
58 to the first split WIM part, prior to the filename extension.
60 'wimlib-imagex --version' now shows the version of the library it is
61 actually using (in case it is different from wimlib-imagex's version).
64 Fixed a bug that was causing the LZMS decompressor to be miscompiled
65 with GCC 7 (this broke extracting "solid" archives).
67 The Windows 10 Recycle Bin directory (\$RECYCLE.BIN) has been added to
68 the default exclusion list.
70 Added a '--quiet' option to wimlib-imagex.
72 The 'mkwinpeimg' script now also looks for the syslinux BIOS modules in
73 the directory /usr/lib/syslinux/modules/bios.
75 Files with timestamps before the year 1970 are now extracted correctly
76 to UNIX-style filesystems, are displayed correctly by
77 'wimdir --detailed', and show up correctly in mounted WIM images.
79 Files with timestamps after the year 2038 are now displayed correctly by
80 the 32-bit Windows build of wimlib.
83 Fixed a data corruption bug (incorrect compression) when storing an
84 already highly-compressed file in an LZX-compressed WIM with a chunk
85 size greater than or equal to 64K. Note that this is not the default
86 setting and such WIMs are not supported by Microsoft's WIM software, so
87 only users who used the --chunk-size option to wimlib-imagex or the
88 wimlib_set_output_chunk_size() API function may have been affected.
89 This bug was introduced in wimlib v1.10.0. See
90 https://wimlib.net/forums/viewtopic.php?f=1&t=300 for more details.
92 On all platforms, sparse files are now extracted as sparse.
94 Sparse files captured from UNIX-style filesystems are now marked as
95 sparse in the resulting WIM image.
97 Added support for storing Linux-style extended attributes in WIM images.
98 When the --unix-data option is used on Linux, wimlib-imagex now captures
99 and applies extended attributes, in addition to the already-supported
100 standard UNIX file permissions (owner/group/mode) and special files.
102 --delta-from is now supported by wimappend. (Previously it was only
103 supported by wimcapture.)
105 On Windows, improved the way in which files deduplicated with Windows'
106 Data Deduplication feature are captured.
108 The development files needed to link with wimlib using Visual Studio are
109 now included in the Windows release archives.
111 wimlib.h can now be included by Visual Studio without errors.
113 The example programs can now be compiled in C++ mode, and they also now
116 Updated 'mkwinpeimg' to work correctly on images that have a "windows"
117 (lower case) directory rather than a "Windows" (upper case) directory.
119 Fixed configuring with --enable-ssse3-sha1 from release tarball
120 (the file nasm_lt.sh was missing).
122 Made some documentation improvements.
125 The LZX compression ratio has been slightly improved. The default mode,
126 LZX level 50, is now almost as good as the old LZX level 100, while
127 being nearly the same speed as before.
129 Decompression performance has been slightly improved.
131 Filenames are now always listed in NTFS collation order.
133 On UNIX-like systems, wimlib can now process Windows filenames that are
134 not valid Unicode due to the presence of unpaired surrogates.
136 On UNIX-like systems, wimlib now always assumes UTF-8 encoding with the
137 addition of surrogate codepoints. Consequently, the environmental
138 variable WIMLIB_IMAGEX_USE_UTF8 and the flag
139 WIMLIB_INIT_FLAG_ASSUME_UTF8 no longer have any effect.
141 wimlib no longer depends on iconv.
143 Reduced memory usage slightly.
145 When a WIM image is applied in NTFS-3G mode, security descriptors are
146 now created in NTFS v3.0 format when supported by the volume.
148 Workarounds for bugs in libntfs-3g version 2013.1.13 and earlier have
149 been removed. Users are advised to upgrade to a later version of
152 On Windows, wimlib now supports case-sensitive filename extraction when
153 supported by the underlying operating system and filesystem (operating
154 system support requires a registry setting).
157 On UNIX, wimlib can now overwrite readonly files when extracting.
159 On Windows, fixed a bug where wimlib could leave a null DACL (a.k.a. "no
160 NTFS permissions") set on some existing directories after extraction.
162 On Windows, when applying a WIM image in "WIMBoot mode" when the WOF
163 driver is not loaded, wimlib can now correctly register a new WIM file
164 with the target volume when the target volume previously had had WIM
167 Added a new testing program.
169 Clarified the main license text and updated public domain dedications
170 for certain files to be more thorough.
173 Object IDs are now saved and restored on Windows and in NTFS-3G mode.
175 Reduced memory usage when exporting large numbers of WIM images.
177 Non UTF-8 locales are now detected correctly.
179 Addressed compiler warnings and enabled "silent" make rules by default.
181 Windows-specific updates:
182 Fixed a bug where duplicate backslashes could be generated in
183 link targets when extracting symbolic links and junctions.
185 Fixed a bug where the .cmd shortcuts for wimlib-imagex wouldn't
186 work if their full path contained a space.
188 Fixed bugs related to scanning SMB filesystems.
190 Added warning message about known issue with WindowsApps folder.
192 Added instructions for building from source on Windows.
194 VSS support is no longer marked "experimental".
196 Added missing license file for libdivsufsort-lite.
199 Added experimental support for Windows VSS (Volume Shadow Copy Service).
200 The new '--snapshot' argument to 'wimcapture' makes wimlib automatically
201 create and use a temporary VSS snapshot when capturing a WIM image.
203 Implemented setting of Windows-specific XML information, such as
204 architecture, system root, and version details. This information is now
205 automatically set in newly captured WIM images, when appropriate.
207 Improved performance of directory tree scans on Windows.
209 On Windows, to improve capture performance, wimlib now sometimes opens
210 files by inode number rather than by path. This is enabled for
211 wimcapture and wimappend, but for now other applications have to opt-in.
213 The progress messages printed by wimlib-imagex while writing WIM files
214 have been slightly tweaked.
216 Progress information for directory tree scans now counts all hard links.
217 Also, on Windows "\\?\" is no longer stripped from the current path.
219 Added a new '--image-property' option to 'wimcapture', 'wimappend', and
220 'wiminfo'. This option lets you assign values to elements in a WIM
221 file's XML document by name.
223 The wimlib_get_image_property() and wimlib_set_image_property() API
224 functions now support numerically indexed elements.
226 Fixed a bug where, on Windows, wimlib would change the security
227 descriptor of the target directory of an extraction even when the
228 '--no-acls' option was specified.
231 Fixed a bug with libntfs-3g extraction present since v1.8.1. Sometimes,
232 some Microsoft software would not correctly recognize data in the
233 resulting filesystem.
235 Made some small improvements to the compression algorithms:
236 LZX compression ratio was slightly improved.
237 XPRESS compression ratio and speed was slightly improved.
238 LZMS compression speed was slightly improved.
240 Improved handling of WIM XML data. wimlib no longer drops unrecognized
241 elements when exporting images. In addition, two API functions were
242 added for better access to elements in the XML document:
243 wimlib_get_image_property() and wimlib_set_image_property().
245 Added support for (unsafe) in-place compaction of WIM files.
247 Improved performance of image export by reusing metadata resources
248 instead of always rebuilding and recompressing them.
250 Improved performance of wimlib_update_image() by delaying the update to
251 the WIM's XML document until a write is requested.
253 On Windows, the target of an extraction may now be a reparse point
254 (which will be dereferenced).
256 On Windows, wimlib now correctly restores non-Microsoft reparse points.
257 However, this remains broken in NTFS-3g mode due to a libntfs-3g bug.
259 On Windows, wimlib now has improved performance when archiving files
260 from a filesystem backed by a WIM (a "WIMBoot" setup).
262 Several improvements to System Compression (compact mode) support:
264 wof.sys (or wofadk.sys) is now automatically attached to the
265 target volume if needed.
267 Compact-mode extractions now work correctly with wofadk.sys on
268 older versions of Windows.
270 For compatibility with the Windows bootloader, the requested
271 compression format now is overridden on certain files.
273 Other minor bugfixes.
276 This release primarily contains various minor bug fixes and
277 improvements, including:
279 Improved handling of deep directory structures.
281 Fixed a bug where on 32-bit systems, the library could enter an
282 infinite loop if a WIM file was malformed in a specific way.
284 Added a workaround for a case where libntfs-3g may report
285 duplicate streams in an NTFS file.
287 Windows symbolic links and junctions in mounted WIM images are
288 now automatically rewritten to be valid in the mounted location.
290 Reparse point fixes: correctly handle the "ReparseReserved"
291 field, and correctly handle "empty" (data-less) reparse points.
293 On Windows, wimlib now acquires SeManageVolumePrivilege, which
294 is needed to create externally backed files using the
297 Improved validation of filenames.
299 Improved LZMS decompression speed.
301 The configure script now honors alternate pkg-config settings.
303 Links have been updated to point to the new website.
305 In addition, experimental support has been added for compressing
306 extracted files using System Compression on Windows 10. This
307 functionality is available through the new '--compact' option to
308 'wimapply' and 'wimextract' as well as new library flags.
311 Fixed a bug in the LZX decompressor: malicious input data could cause
312 out of bounds writes to memory (since wimlib v1.2.2).
314 The output of the 'wiminfo' command now consolidates various boolean
315 flags (such as "Relative path junction") into a single line.
317 A file can now have both an unnamed data stream ("file contents") and a
318 reparse point stream. Such files can exist as a result of the use of
319 certain Windows features, such as offline storage, including "OneDrive".
320 wimlib will now store and restore both streams on Windows as well as in
321 NTFS-3g mode. Microsoft's WIMGAPI also has this behavior.
323 On Windows, named data streams of encrypted files are no longer stored
324 twice in WIM archives.
326 On Windows, named data streams are now correctly extracted to existing
327 "readonly" directories. Before, an error would be reported.
329 On Windows, it is now possible to do a "WIMBoot mode" extraction with
330 non-standalone WIMs such as delta WIMs.
332 On Windows, when doing an extraction in "WIMBoot mode", files larger
333 than 4 gigabytes are now never extracted as externally backed. This
334 works around a bug in Microsoft's "WOF" driver.
336 The '--enable-verify-compression' configure option has been removed. If
337 you want to verify a WIM file, use the 'wimverify' program.
339 The way the "file count", "directory count", "total bytes", and "hard
340 link bytes" image statistics (stored in the WIM XML data) is calculated
341 has been slightly changed.
343 In mounted WIM images, the disk usage provided for each file (st_blocks)
344 is now the compressed size rather than the uncompressed size.
346 The performance of the NTFS-3g and Windows capture modes has been
349 On UNIX-like systems, symbolic links whose targets contain the backslash
350 character are now handled correctly (losslessly).
353 Improved the LZX compressor. It is now 15-20% faster than before and
354 provides a slightly better compression ratio.
356 Improved the LZMS compressor. It now provides a compression ratio
357 slightly better than WIMGAPI while still being faster and using slightly
360 The compression chunk size in solid resources, e.g. when capturing or
361 exporting a WIM file using the '--solid' option, now defaults to 64 MiB
362 (67108864 bytes) instead of 32 MiB (33554432 bytes). This provides a
363 better compression ratio and is the same value that WIMGAPI uses. The
364 memory usage is less than 50% higher than wimlib v1.7.4 and is slightly
365 lower than WIMGAPI's memory usage, but if it is too much, it is still
366 possible to choose a lower value, e.g. with the '--solid-chunk-size'
367 option to wimlib-imagex.
369 The '--chunk-size' and '--solid-chunk-size' options to wimlib-imagex now
370 accept the 'K', 'M', and 'G' suffixes.
372 Files are now sorted by name extension when creating a solid WIM file.
374 Fixed various issues related to capture/apply of EFS-encrypted files on
377 The file list printed by 'wimdir' is now sorted by the platform-specific
378 case sensitivity setting, rather than always case sensitively. This
379 also affects the library function wimlib_iterate_dir_tree().
381 On Windows, some error and warning messages have been improved.
384 The Windows binary distribution no longer contains third party DLLs.
385 These dependencies are instead compiled directly into the libwim DLL.
387 Added more fixes for wimlib on non-x86 architectures such as ARM.
389 Extracting files to a Windows PE in-memory filesystem no longer fails if
390 the target files do not yet exist.
392 Improved the performance of XPRESS compression and LZMS decompression.
394 Enabled SSSE3 accelerated SHA-1 computation in x86_64 Windows builds.
395 It will automatically be faster on newer Intel and AMD processors.
397 Removed the --with-imagex-progname and --enable-more-assertions
401 Fix for very slow export from solid WIM / ESD files.
403 Fix for LZX and LZMS algorithms on non-x86 architectures, such as ARM.
405 New progress message: WIMLIB_PROGRESS_MSG_HANDLE_ERROR. Applications
406 may use this to treat some types of errors as non-fatal.
408 The library now permits making in-memory changes to a WIMStruct backed
409 by a read-only WIM file.
411 Fixes for "WIMBoot" extraction mode (Windows only):
413 When not using the WOF driver, extraction no longer fails if the
414 disk containing the WIM file has too many partitions.
416 When matching patterns in [PrepopulateList], all hard links of
417 each file are now considered.
419 The system registry files are now automatically treated as being
420 in [PrepopulateList].
422 Added a hack to try to work around an intermittent bug in
423 Microsoft's WOF (Windows Overlay Filesystem) driver.
426 Made more improvements to the XPRESS, LZX, and LZMS compressors.
428 A number of improvements to the Windows port:
430 Fixes for setting short filenames.
432 Faster "WIMBoot" extraction.
434 Updated and slimmed down the dependent DLLs.
436 ACL inheritence bits are now restored.
438 Mandatory integrity labels are now backed up and restored.
440 Added a workaround for an issue where in rare cases, wimlib could create
441 a compressed data stream that could not be read correctly by Windows
442 after an extraction in "WIMBoot" mode.
445 Added file count progress data for
446 WIMLIB_PROGRESS_MSG_EXTRACT_FILE_STRUCTURE and
447 WIMLIB_PROGRESS_MSG_EXTRACT_METADATA.
449 Added support for testing file exclusions via the user-provided
452 Some documentation improvements.
454 Made some clarifications to the license text in the COPYING file.
457 Made more improvements to the XPRESS, LZX, and LZMS compressors.
459 The default compression mode for wimcapture is now LZX compression in
460 its default mode, which is the same as '--compress=maximum'.
462 You can now specify an optional integer compression level to the
463 '--compress' option; e.g. '--compress=lzx:75'.
465 Made a minor change to the LZMS compressor and decompressor to fix an
466 incompatibility with the Microsoft implementation. In the unlikely
467 event that you created an LZMS-compressed WIM with wimlib v1.7.0 or
468 earlier and a checksum error is reported when extracting files from it
469 with wimlib v1.7.1, decompress it with v1.7.0 then compress it with
472 Added 'verify' subcommand to wimlib-imagex.
474 Notable library changes:
476 Custom compressor parameters have been removed from the library
477 in favor of the simpler level-based API.
479 Decompressor parameters have been removed entirely.
481 Library users can now specify a custom file for warning and
482 error messages to be sent to, rather than the default of
485 New progress messages:
486 WIMLIB_PROGRESS_MSG_EXTRACT_FILE_STRUCTURE,
487 WIMLIB_PROGRESS_MSG_EXTRACT_METADATA.
489 New function: wimlib_verify_wim().
492 Improved compression, decompression, and extraction performance.
494 Improved compatibility with version 3584 WIM / ESD files:
495 - Add support for reading and writing multiple solid blocks per
496 archive, which WIMGAPI/DISM can create when appending an image.
497 - Correctly create solid blocks larger than 4 GiB.
499 'add' commands passed to wimupdate will now replace existing
500 nondirectory files by default. Use the --no-replace option to get the
503 The license for the library now contains an exception that allows using
504 it under the LGPL. See the COPYING file for details.
506 In reparse-point fixup mode (the default for capture), symbolic links
507 and junctions that point outside the tree being captured are no longer
508 excluded from capture.
510 Added support for "WIMBoot" capture and extraction. See the
511 documentation for the new '--wimboot' option to wimcapture and wimapply
512 for more information.
514 On UNIX-like systems, you can now backup and restore device nodes, named
515 pipes, and sockets. In addition, 32-bit user and group IDs are now
518 The way that UNIX data is stored in WIM files has been changed. If you
519 captured any WIMs with the --unix-data option, to upgrade them you'll
520 need to apply them with --unix-data using wimlib-imagex v1.6.2, then
521 re-capture them with --unix-data using this version.
523 wimlib now understands tagged metadata items, such as object IDs, that
524 can be stored in WIM directory entries.
526 Removed the --hardlink and --symlink options to wimapply, since I don't
527 think they are too useful and they got in the way of improving the code.
529 WIMs will now retain their GUIDs when rebuilt (e.g. with wimoptimize).
531 The 'mkwinpeimg' script now supports writing the ISO image to standard
534 The <ARCH> element in WIM XML data is now exported correctly.
536 On Windows, sparse file attributes are no longer set on extracted files.
537 Oddly enough, this actually saves disk space in some cases.
539 On UNIX, configuring with --disable-xattr or --enable-xattr is no longer
540 supported. Mounting WIM images now always requires extended attribute
541 support. Use --without-fuse to disable support for mounting WIM images;
542 this will also disable the need for extended attribute support.
544 Configuring with --enable-ssse3-sha1 now works correctly.
546 The shared library version has been bumped up. The main
547 incompatibilities are:
549 - WIMLIB_COMPRESSION_TYPE_XPRESS is now 1 and
550 WIMLIB_COMPRESSION_TYPE_LZX is now 2 (so it's the same as
553 - User-provided progress functions are now registered using a
554 separate function, wimlib_register_progress_function(). The
555 'progress_func' argument to many functions no longer exists.
557 - The return value from user-provided progress functions is now
560 - A context argument has been added to the prototype of
561 user-provided progress functions.
563 - 'struct wimlib_capture_config' has been removed. The library
564 now takes the path to the configuration file directly. This
565 affects wimlib_add_image(), wimlib_add_image_multisource(),
566 and wimlib_update_image(). However, a NULL value passed in
567 the argument retains the same meaning.
569 - Removed deprecated functions: some (de)compression functions,
570 wimlib_extract_files(), and wimlib_print_metadata().
572 - Removed extraction flags: WIMLIB_EXTRACT_FLAG_HARDLINK,
573 WIMLIB_EXTRACT_FLAG_SYMLINK, WIMLIB_EXTRACT_FLAG_FILE_ORDER,
574 and WIMLIB_EXTRACT_FLAG_SEQUENTIAL.
576 - Removed some progress messages:
577 WIMLIB_PROGRESS_MSG_APPLY_TIMESTAMPS,
578 WIMLIB_PROGRESS_MSG_EXTRACT_DIR_STRUCTURE_BEGIN,
579 WIMLIB_PROGRESS_MSG_EXTRACT_DIR_STRUCTURE_END. Numbering
582 - Removed some error codes. Numbering stays the same.
584 - Replaced WIMLIB_UNMOUNT_FLAG_LAZY with
585 WIMLIB_UNMOUNT_FLAG_FORCE.
587 - WIM paths passed to progress functions now have a leading
591 Case-insensitive comparisons of strings (e.g. filenames) containing
592 UTF-16 codepoints above 32767 are now done correctly.
594 Fixed build failure on Mac OS X.
596 wimunmount now provides the '--new-image' option to cause changes to a
597 read-write mounted image to be committed as a new image rather than as
598 an update of the mounted image. (The corresponding new library flag is
599 WIMLIB_UNMOUNT_FLAG_NEW_IMAGE.)
601 The LZMS ("recovery") compression chunk size, or "dictionary size", may
602 now be up to 1 GiB (1,073,741,824 bytes).
604 The performance of LZX ("maximum") and LZMS ("recovery") compression
605 with large chunk sizes has been slightly improved.
608 Stored files with size exactly 4 GiB (4,294,967,296 bytes) are now
609 decompressed correctly.
611 Fixed a bug in the LZX compressor introduced in v1.5.3. The bug
612 occurred in an unlikely case, and due to validity checks it did not
613 affect successfully created archives.
615 Fixed a minor compatibility issue with the LZMS compressor and
616 decompressor. This is *not* the default compression type and was only
617 introduced in v1.6.0. In the unlikely event that you created an
618 LZMS-compressed WIM with v1.6.0 and a checksum error is reported when
619 applying it with v1.6.1, decompress it with v1.6.0 then compress it with
622 Memory usage for LZMS and LZX compression has been decreased.
624 wimextract now allows wildcard characters in paths specified on the
625 command line. Also, the '--strict-wildcards' option has been removed
626 and replaced with the inverse option '--nullglob'. See the
627 documentation for wimextract for more details and changes.
629 The wimlib_extract_files() function is now considered deprecated in
630 favor of wimlib_extract_paths().
632 Fixed more permissions problems when extracting files on Windows.
634 A new '--no-attributes' option has been added to wimapply and
635 wimextract. The library flag is WIMLIB_EXTRACT_FLAG_NO_ATTRIBUTES.
637 The default chunk size is now set correctly when changing the
638 compression type of a WIM, for example with 'wimoptimize'.
640 The '--metadata' option to wiminfo has been replaced with the
641 '--detailed' option to wimdir.
643 In relevant wimlib-imagex commands, '--solid' may now be used as an
644 alias for '--pack-streams'.
647 Support for extracting and updating the new version 3584 WIMs has been
648 added. These WIMs typically pack many streams ("files") together into a
649 single compressed resource, thereby saving space. This degrades the
650 performance of random access (such as that which occurs on a mounted
651 image), but optimizations have been implemented for extraction. These
652 new WIM files also typically use a new compression format (LZMS), which
653 is similar to LZMA and can offer a better compression ratio than LZX.
654 These new WIM files can be created using `wimcapture' with
655 the '--compress=lzms --pack-streams' options. Note: this new WIM format
656 is used by the Windows 8 web downloader, but important segments of the
657 raw '.esd' files are encrypted, so wimlib will not be able to extract
658 such files until they are first decrypted.
660 wimlib now supports extracting files and directories from a WIM image
661 based on a "listfile" that itself contains the list of paths to extract.
662 For `wimextract', the syntax is to specify @LISTFILE instead of a PATH,
663 and for the library itself, the new APIs are wimlib_extract_pathlist()
664 and wimlib_extract_paths(). Path globs containing wildcard characters
667 For searching WIM files, wimlib now has configurable case sensitivity.
668 The default on Windows is still case-insensitive and the default on
669 UNIX-like systems is still case-sensitive, but this can be overridden
670 on either platform through flags to wimlib_global_init(). For
671 `wimlib-imagex', the environmental variable WIMLIB_IMAGEX_IGNORE_CASE
672 can be set to 1 or 0 for case-insensitive or case-sensitive behavior,
675 Support for compression chunk sizes greater than the default of 32768
676 bytes has been added. A larger chunk size typically results in a better
677 compression ratio. However, the MS implementation is seemingly not
678 compatible with all chunk sizes, especially for LZX compression, so the
679 defaults remain unchanged, with the exception of the new LZMS-compressed
680 WIMs, which use a larger chunk size by default.
682 The compression/decompression API exported by wimlib has been changed.
683 Now one set of functions handles all supported compression formats.
685 `wimcapture' and `wimappend' will now display the progress of scanning
686 the directory tree to capture, in addition to the progress of writing
687 data to the WIM. The '--verbose' option no longer does anything. The
688 library API change for this is the addition of several members to
689 `struct wimlib_progress_info_scan' available to progress callbacks.
691 `mkwinpeimg' now correctly handles the '--start-script' option when the
692 start script is not in the working directory.
694 Sequential extraction, previously requested by using
695 WIMLIB_EXTRACT_FLAG_SEQUENTIAL, is now the default.
696 WIMLIB_EXTRACT_FLAG_FILE_ORDER can be used to get the old default
697 behavior (extract in file order).
700 The new LZX compressor added in v1.5.2 has been improved and is now
701 enabled by default, except when `wimcapture' or `wimappend' is run
702 *without* the '--compress' option, in which case the faster LZX
703 compressor is used (the same as before). This behavior is reasonably
704 consistent with ImageX which actually uses "fast" (XPRESS) compression
705 by default. In those cases, use '--compress=maximum' to explicitly
706 capture a WIM image using the new (slower but better) LZX compressor.
708 The '--compress-slow' option still exists to `wimlib-imagex optimize',
709 but its new behavior is to tweak the new LZX compressor even more to
710 produce an even better compression ratio at the cost of more time spent
713 `wimlib-imagex optimize' now supports the '--compress=TYPE' option,
714 which recompresses the WIM file using the specified compression TYPE.
715 The new library API function used for this is
716 wimlib_set_output_compression_type().
718 Added the wimlib_get_xml_data() function to allow library clients to
719 easily retrieve the raw XML data from a WIM file if needed.
721 Fixed a bug that could cause an error code to be incorrectly returned
722 when writing XML data containing a <WINDOWS> element.
724 Mounted WIM images will now correctly show the default file stream even
725 if appears in the alternate data stream entries of the corresponding WIM
729 Added a new experimental LZX compressor which can be enabled by passing
730 '--compress-slow' to `wimlib-imagex capture' or `wimlib-imagex
731 optimize'. (The latter is only applicable if the WIM is already
732 LZX-compressed and the '--recompress' option is also given.) The
733 experimental compressor is much slower but compresses the data slightly
734 more --- currently usually to within a fraction of a percent of the
735 results from WIMGAPI/ImageX.
737 A workaround has been added for compatibility with versions of WinPE
738 that interpret alternate data stream entries in the boot WIM
741 An alignment bug that caused a crash in the LZX decompressor on some
744 wimlib now attempts to clear the WIM_HDR_FLAG_WRITE_IN_PROGRESS flag in
745 the WIM header when restoring the previous state of a WIM it failed to
748 Added a workaround to avoid an access denied error on Windows when
749 replacing a WIM file that another process has opened.
752 wimlib can now open WinPE WIMs from WAIK v2.1, which had a quirk that
753 needed to be handled.
755 A bug in the interpretation of negative IMAGE indices in the
756 --update-of=[WIMFILE:]IMAGE option to `wimlib-imagex capture' and
757 `wimlib-imagex append' has been fixed.
759 A workaround has been added to successfully apply security descriptors
760 with empty DACLs when the NTFS-3g apply mode is being used with NTFS-3g
761 2013.1.13 or earlier.
763 `wimlib-imagex capture' can now accept the '--delta-from' option
767 Added support for "pipable" WIMs. Pipable WIMs allow capturing images
768 to standard output and applying images from standard input, but they are
769 not compatible with Microsoft's software and are not created by default.
770 See the documentation for --pipable flag of `wimlib-imagex capture' for
773 To better support incremental backups, added support for declaring an
774 image as a modified form of another image. See the documentation for
775 the '--update-of' option of `wimlib-imagex append' and `wimlib-imagex
778 Added supported for "delta" WIMs. See the documentation for the
779 '--delta-from' option of `wimlib-imagex capture'.
781 The library support for managing split WIMs has been changed to support
782 other arrangements, such as delta WIMs, and be easier to use. This
783 change is visible in `wimlib-imagex', which also can now accept the
784 '--ref' option multiple times, and also now supports "delta" WIMs as
787 wimlib now preserves WIM integrity tables by default, even if
788 WIMLIB_WRITE_FLAG_CHECK_INTEGRITY is not specified. This changes the
789 behavior of `wimlib-imagex' whenever the WIM being operated on contains
790 an integrity table and the '--check' option is not specified.
792 `wimlib-imagex capture' now creates LZX-compressed WIMs by default
793 (when --compress is not specified). This provides the best compression
794 ratio by default, which is usually what is desired, at a cost of some
797 `wimlib-imagex' now supports being invoked as wimCOMMAND, where COMMAND
798 is the command as in `wimlib-imagex COMMAND'; for example, it can be
799 invoked as `wimapply' as an alternative to `wimlib-imagex apply'. The
800 appropriate hard links are created in UNIX installations of
801 `wimlib-imagex', while for the Windows distribution of `wimlib-imagex',
802 batch files that emulate this behavior are generated.
804 Security descriptors are now extracted correctly on Windows.
806 Fixed archiving DOS names in NTFS-3g capture mode.
808 The extraction code has been rewritten and it will now be easier to
809 support new features on all supported backends (currently Win32, UNIX,
810 and NTFS-3g). For example, hard-linked extraction mode (--hardlink) is
811 now supported on all backends, not just UNIX.
813 `mkwinpeimg' now supports grabbing files from the WAIK supplement rather
814 than the WAIK itself.
816 wimlib_global_init() now, by default, attempts to acquire additional
817 privileges on Windows, so library clients need not do this.
819 This update bumps the shared library version number up to 9, since it is
820 not binary compatibible with previous releases.
823 Fixed bug in `wimlib-imagex export' that made it impossible to export an
824 image from a WIM that is readonly at the filesystem level.
826 Return error code rather than segfaulting when trying to list files from
827 a non-first part of a split WIM.
829 Joining a WIM will now preserve the RP_FIX and READONLY flags.
832 On Windows, paths given to wimlib-imagex are now treated case
835 Improved behavior regarding invalid filenames; in particular, on
836 Windows, wimlib-imagex will, when extracting, now omit (with an option
837 to override this default) filenames differing only in case, or filenames
838 containing characters not valid on Windows.
840 On Windows, wimlib now supports capturing and extracting long paths
841 (longer than the so-called MAX_PATH).
843 On Windows, `wimlib-imagex update' now acquires proper privileges when
844 running as an Administrator.
846 `wimlib-imagex update' will now complain if no image is specified when
847 trying to update a multi-image WIM.
849 `wimlib-imagex update' now supports specifying a single update command
850 directly on the command line using the --command option.
852 wimlib-imagex will now choose different units for progress messages,
853 depending on the amount of data that needs to be processed.
855 `wimlib-imagex append' will now generate a unique WIM image name if no
856 name is specified and the defaulted name already exists in the WIM.
858 wimlib now allows you to create unnamed WIM images, which can then only
859 be referred to by index.
861 wimlib now allows you to explicitly declare you want write access to a
862 WIM by providing the WIMLIB_OPEN_FLAG_WRITE_ACCESS flag to
865 wimlib now respects the WIM_HDR_FLAG_READONLY flag when set in the WIM
868 Progress callbacks have been added to wimlib's wimlib_update_image()
871 Added wimlib_get_wim_info(), wimlib_set_wim_info(),
872 wimlib_iterate_dir_tree(), and wimlib_iterate_lookup_table() functions
875 NTFS-3g capture now only warns about two conditions previously treated
878 Fixed a couple issues with using wimlib-imagex on UDF filesystems on
881 wimlib now correctly detects and returns an error when reading a WIM
882 image with a cyclic directory structure. (Fun fact: such a WIM will
883 crash Microsoft's software.)
886 Added new "extract" and "update" subcommands to wimlib-imagex, along
887 with associated APIs in the library. These commands are intended mainly
888 for Windows use but can be used on UNIX as well.
890 Many documentation improvements.
892 Fixed a bug in the Windows build where relative symbolic links were not
893 captured in reparse-point fixup mode.
895 Fixed a bug in the Windows build where file handles were left open to
896 the WIM file, causing `wimlib_imagex optimize' to fail in some cases.
898 Fixed a bug in the Windows build of wimlib-imagex where globbing
899 split-WIM parts could cause the program to crash.
901 Fixed a bug where the creation time of WIM images would be shown instead
902 of the last modification time.
904 With the Windows build it is now possible to restore a WIM containing
905 symbolic links as a non-Administrator; however you will receive warnings
906 about not being able to extract the symbolic links.
909 Capturing a WIM image should now be significantly faster in most cases
910 due to improved use of the operating system's cache and avoiding reading
911 files twice whenever possible.
913 The Windows build should now work on Windows XP.
915 The Windows build now supports capturing and restoring hidden,
916 compressed, sparse, and encrypted files.
918 The Windows build now supports capturing and applying WIM images from
919 filesystems other than NTFS (with some reduced functionality).
921 The Windows build now extracts short names correctly.
923 Added support for "reparse-point" fixups (i.e. fixing up of symbolic
924 links). See docs for --rpfix and --norpfix flags of `wimlib-imagex
925 capture' and `wimlib-imagex apply'.
927 The performance of splitting and joining WIMs should be slightly
930 The LZX and XPRESS compression and decompression functions are now
931 exported from the library.
934 Improvements and bugfixes for the Windows build.
936 Added --strict-acls options.
938 Fixed the way that wimlib determines the order of images in the WIM.
941 Since wimlib can now be used on Windows, wimlib's implementation of
942 ImageX has been renamed to wimlib-imagex to avoid confusion with
943 Microsoft's implementation of ImageX, which would have the same file
944 name ("imagex.exe"). If you really don't like this you can pass the
945 --with-imagex-progname option to `configure' to choose a different name,
946 or even simply rename the binary yourself (but the former way will
947 configure the man pages to use the chosen name).
949 Various bugs fixed in the Windows build. Mainly to do with capturing
950 and restoring alternate data streams correctly in weird cases, and
951 requesting the correct privileges when opening files. Also added the
952 --noacls options to wimlib-imagex capture, append, and apply.
954 Windows build again: FindFirstStreamW() and FindNextStreamW() are now
955 dynamically loaded, so this may make the library compatible with Windows
956 XP (however, there may still be other problems).
959 Added experimental support for native Windows builds. Binaries can be
960 downloaded from the SourceForge page.
962 --source-list option added to `imagex capture' and `imagex append'.
964 Better support for different character encodings.
967 Storing UNIX file owners, groups, and modes in WIM images is now
968 possible using `imagex capture' with the --unix-data flag.
970 Minor bug fixes and documentation fixes.
973 NTFS capture: Fixed capturing duplicate reparse points.
975 NTFS capture: Capture first unnamed stream if there are more than one
976 (print warning instead of error).
978 Allow multiple test cases to execute concurrently (e.g. make -j2 check).
981 Added --arch switch to mkwinpeimg script to support getting AMD64 WinPE
984 Update to work with ntfs-3g version 2013.1.13.
987 Fixed truncating file to shorter but non-zero length on read-write
990 Various code cleanups and minor documentation fixes.
993 LZX and XPRESS decompression have received some additional optimizations
994 and should now be even faster. (Although, they were already pretty
995 fast--- much faster than typical I/O speeds.)
997 Fixed a bug introduced in v1.2.1 that would cause a directory tree
998 containing hard links to be captured incorrectly in some cases.
1001 By default, unmounting a read-write mounted WIM with 'imagex unmount
1002 --commit' will now change the WIM in-place without needing to write the
1003 entire WIM again. Use 'imagex unmount --commit --rebuild' to get the
1006 'imagex unmount' no longer has a hard-coded limit of 10 minutes to wait
1007 for a response from the daemon servicing the mounted WIM. Instead,
1008 every second 'imagex unmount' will check if the daemon is still alive,
1009 and keep waiting if so, otherwise terminate with an error.
1011 'imagex unmount --commit' on a read-write mounted WIM will now print
1012 progress information regarding the writing of new or modified streams
1013 the WIM, just like when capturing or appending a WIM.
1015 A small change has been made to XPRESS compression and it should improve
1016 the compression ratio slightly.
1018 A change was made that may improve performance slightly when applying a
1019 WIM image to a NTFS volume.
1021 Microsoft has managed to introduce even more bugs into their software,
1022 and now the WIMs for Windows 8 have incorrect (too low) reference counts
1023 for some streams. This is unsafe because such streams can be removed
1024 when they are in actuality still referenced in the WIM (perhaps by a
1025 different image). wimlib will now work around this problem by fixing
1026 the stream reference counts. This is only done when wimlib_delete_image() is
1027 called ('imagex delete') or when wimlib_mount_image() is called with
1028 WIMLIB_MOUNT_FLAG_READWRITE ('imagex mountrw'). Please note that this
1029 requires reading the metadata for all images in the WIM, so this will
1030 make these operations noticably slower on WIMs with multiple images.
1032 Various other bugfixes.
1035 Appending images to a WIM is now be done by default without re-building
1036 the whole WIM. Use the --rebuild flag to get the old behavior (which
1037 was to re-build the entire WIM when a new image is appended).
1039 A new command `imagex optimize' is now available to manually re-build a
1040 WIM that has wasted space due to repeated appends.
1042 Progress information has been improved, and now arbitrary callback
1043 functions can be used to show the progress of a WIM operation.
1045 A possible bug with changing the bootable image of a WIM was fixed.
1047 Some advisory locking is now done to prevent two processes from
1048 modifying a WIM at the same time (but only in some cases). For example,
1049 you cannot mount two images from a WIM read-write at the same time.
1051 Some functions have been reorganized:
1052 * wimlib_mount() renamed to wimlib_mount_image().
1053 * wimlib_unmount() renamed to wimlib_unmount_image().
1054 * wimlib_overwrite_xml_and_header() removed as
1055 wimlib_overwrite() suffices now.
1056 * wimlib_apply_image_to_ntfs_volume() removed as
1057 wimlib_extract_image() suffices now.
1058 * wimlib_add_image_from_ntfs_volume() removed as
1059 * wimlib_add_image() suffices now.
1061 Previously, the soname of libwim.so has been 0.0.0, despite many
1062 interface changes. The soname is now updated to 1.0.0 and will now be
1063 updated each release.
1066 Resources will now be compressed using multiple threads by default.
1067 (This applies to `imagex capture', `imagex append', and `imagex
1070 Some performance improvements in mounted WIMs.
1072 More progress information is shown when capturing a WIM.
1075 Lots of minor fixes, code cleanups, and some documentation updates.
1076 Nothing in particular is really noteworthy.
1079 LZX and XPRESS compression improvements.
1081 Fixed calculation of Directory Count, File Count, Total Bytes, and Hard
1082 Link Bytes of the WIM.
1085 Fixed bug when capturing NTFS file with multiple named data streams.
1087 Internally, we are now using inode structures, even though these don't
1088 appear literally in the WIM file. This simplifies some of the code
1089 (mainly for WIM mounting) and likely fixed a few problems, although it
1093 Fixed problem when exporting images from XPRESS to LZX compressed WIM or
1097 Enough changes to call it version 1.0.0!
1099 Capturing a WIM directly from a NTFS volume, and applying a WIM directly
1100 to a NTFS volume, is now supported.
1102 Hard links and symbolic links have much improved support. They are
1103 supported for WIM capture, WIM application, and mounted WIMs (you can
1104 even make them on read-write mounted WIMs).
1106 Alternate data streams are now supported on mounted WIMs through an
1107 xattr or a Windows-style stream interface. Also they are supported when
1108 capturing a WIM from NTFS or applying a WIM to NTFS.
1110 Split WIMs are better supported. You may now apply an image directly
1111 from a split WIM, mount an image from a split WIM read-only, or export
1112 an image from a split WIM.
1114 Using a capture configuration file is now supported (but not fully yet).
1116 SHA1 message digests are checked in more places, so we can make sure
1117 applied and captured data is correct.
1119 Man pages have been updated and consolidated.
1122 Fixed segfault when unmounting read-only WIM.
1125 Support for joining and splitting WIMs.
1126 Also, security data is now preserved by default.
1129 Can now build with older gcc and system headers, like on CentOS 5.
1132 Fixed bug that made it impossible to overwrite files in read-write
1136 Write byte-order mark before WIM XML data. (imagex.exe requires this to
git://wimlib.net / wimlib / blob