2 On Windows, wimlib now supports capturing and applying extended
3 attributes (EAs). It is compatible with DISM with the /EA option,
4 available since Windows 10 version 1607. wimlib's EA support is on by
5 default; no option has to be provided, and it should work on older
6 versions of Windows too.
8 Partially fixed a bug where [ExclusionException] entries didn't take
9 effect when the containing directory is matched by [ExclusionList]. It
10 now works when the [ExclusionException] patterns are absolute. For
11 example, listing "/dir/file" in [ExclusionException] now works even if
12 "/dir" is matched by [ExclusionList].
14 Added an '--include-integrity' option to various wimlib-imagex commands.
15 '--include-integrity' is like '--check', but it will just include an
16 integrity table in the output WIM(s), while skipping verification of any
17 existing integrity tables. This can be useful to avoid unwanted
18 verification of large WIM files, e.g. WIMs given by '--delta-from'.
20 'wimextract' now reads a pathlist file from standard input when "@-" is
23 wimsplit (API: wimlib_split()) now correctly handles a dot in the path
24 to the first split WIM part, prior to the filename extension.
26 'wimlib-imagex --version' now shows the version of the library it is
27 actually using (in case it is different from wimlib-imagex's version).
30 Fixed a bug that was causing the LZMS decompressor to be miscompiled
31 with GCC 7 (this broke extracting "solid" archives).
33 The Windows 10 Recycle Bin directory (\$RECYCLE.BIN) has been added to
34 the default exclusion list.
36 Added a '--quiet' option to wimlib-imagex.
38 The 'mkwinpeimg' script now also looks for the syslinux BIOS modules in
39 the directory /usr/lib/syslinux/modules/bios.
41 Files with timestamps before the year 1970 are now extracted correctly
42 to UNIX-style filesystems, are displayed correctly by
43 'wimdir --detailed', and show up correctly in mounted WIM images.
45 Files with timestamps after the year 2038 are now displayed correctly by
46 the 32-bit Windows build of wimlib.
49 Fixed a data corruption bug (incorrect compression) when storing an
50 already highly-compressed file in an LZX-compressed WIM with a chunk
51 size greater than or equal to 64K. Note that this is not the default
52 setting and such WIMs are not supported by Microsoft's WIM software, so
53 only users who used the --chunk-size option to wimlib-imagex or the
54 wimlib_set_output_chunk_size() API function may have been affected.
55 This bug was introduced in wimlib v1.10.0. See
56 https://wimlib.net/forums/viewtopic.php?f=1&t=300 for more details.
58 On all platforms, sparse files are now extracted as sparse.
60 Sparse files captured from UNIX-style filesystems are now marked as
61 sparse in the resulting WIM image.
63 Added support for storing Linux-style extended attributes in WIM images.
64 When the --unix-data option is used on Linux, wimlib-imagex now captures
65 and applies extended attributes, in addition to the already-supported
66 standard UNIX file permissions (owner/group/mode) and special files.
68 --delta-from is now supported by wimappend. (Previously it was only
69 supported by wimcapture.)
71 On Windows, improved the way in which files deduplicated with Windows'
72 Data Deduplication feature are captured.
74 The development files needed to link with wimlib using Visual Studio are
75 now included in the Windows release archives.
77 wimlib.h can now be included by Visual Studio without errors.
79 The example programs can now be compiled in C++ mode, and they also now
82 Updated 'mkwinpeimg' to work correctly on images that have a "windows"
83 (lower case) directory rather than a "Windows" (upper case) directory.
85 Fixed configuring with --enable-ssse3-sha1 from release tarball
86 (the file nasm_lt.sh was missing).
88 Made some documentation improvements.
91 The LZX compression ratio has been slightly improved. The default mode,
92 LZX level 50, is now almost as good as the old LZX level 100, while
93 being nearly the same speed as before.
95 Decompression performance has been slightly improved.
97 Filenames are now always listed in NTFS collation order.
99 On UNIX-like systems, wimlib can now process Windows filenames that are
100 not valid Unicode due to the presence of unpaired surrogates.
102 On UNIX-like systems, wimlib now always assumes UTF-8 encoding with the
103 addition of surrogate codepoints. Consequently, the environmental
104 variable WIMLIB_IMAGEX_USE_UTF8 and the flag
105 WIMLIB_INIT_FLAG_ASSUME_UTF8 no longer have any effect.
107 wimlib no longer depends on iconv.
109 Reduced memory usage slightly.
111 When a WIM image is applied in NTFS-3G mode, security descriptors are
112 now created in NTFS v3.0 format when supported by the volume.
114 Workarounds for bugs in libntfs-3g version 2013.1.13 and earlier have
115 been removed. Users are advised to upgrade to a later version of
118 On Windows, wimlib now supports case-sensitive filename extraction when
119 supported by the underlying operating system and filesystem (operating
120 system support requires a registry setting).
123 On UNIX, wimlib can now overwrite readonly files when extracting.
125 On Windows, fixed a bug where wimlib could leave a null DACL (a.k.a. "no
126 NTFS permissions") set on some existing directories after extraction.
128 On Windows, when applying a WIM image in "WIMBoot mode" when the WOF
129 driver is not loaded, wimlib can now correctly register a new WIM file
130 with the target volume when the target volume previously had had WIM
133 Added a new testing program.
135 Clarified the main license text and updated public domain dedications
136 for certain files to be more thorough.
139 Object IDs are now saved and restored on Windows and in NTFS-3G mode.
141 Reduced memory usage when exporting large numbers of WIM images.
143 Non UTF-8 locales are now detected correctly.
145 Addressed compiler warnings and enabled "silent" make rules by default.
147 Windows-specific updates:
148 Fixed a bug where duplicate backslashes could be generated in
149 link targets when extracting symbolic links and junctions.
151 Fixed a bug where the .cmd shortcuts for wimlib-imagex wouldn't
152 work if their full path contained a space.
154 Fixed bugs related to scanning SMB filesystems.
156 Added warning message about known issue with WindowsApps folder.
158 Added instructions for building from source on Windows.
160 VSS support is no longer marked "experimental".
162 Added missing license file for libdivsufsort-lite.
165 Added experimental support for Windows VSS (Volume Shadow Copy Service).
166 The new '--snapshot' argument to 'wimcapture' makes wimlib automatically
167 create and use a temporary VSS snapshot when capturing a WIM image.
169 Implemented setting of Windows-specific XML information, such as
170 architecture, system root, and version details. This information is now
171 automatically set in newly captured WIM images, when appropriate.
173 Improved performance of directory tree scans on Windows.
175 On Windows, to improve capture performance, wimlib now sometimes opens
176 files by inode number rather than by path. This is enabled for
177 wimcapture and wimappend, but for now other applications have to opt-in.
179 The progress messages printed by wimlib-imagex while writing WIM files
180 have been slightly tweaked.
182 Progress information for directory tree scans now counts all hard links.
183 Also, on Windows "\\?\" is no longer stripped from the current path.
185 Added a new '--image-property' option to 'wimcapture', 'wimappend', and
186 'wiminfo'. This option lets you assign values to elements in a WIM
187 file's XML document by name.
189 The wimlib_get_image_property() and wimlib_set_image_property() API
190 functions now support numerically indexed elements.
192 Fixed a bug where, on Windows, wimlib would change the security
193 descriptor of the target directory of an extraction even when the
194 '--no-acls' option was specified.
197 Fixed a bug with libntfs-3g extraction present since v1.8.1. Sometimes,
198 some Microsoft software would not correctly recognize data in the
199 resulting filesystem.
201 Made some small improvements to the compression algorithms:
202 LZX compression ratio was slightly improved.
203 XPRESS compression ratio and speed was slightly improved.
204 LZMS compression speed was slightly improved.
206 Improved handling of WIM XML data. wimlib no longer drops unrecognized
207 elements when exporting images. In addition, two API functions were
208 added for better access to elements in the XML document:
209 wimlib_get_image_property() and wimlib_set_image_property().
211 Added support for (unsafe) in-place compaction of WIM files.
213 Improved performance of image export by reusing metadata resources
214 instead of always rebuilding and recompressing them.
216 Improved performance of wimlib_update_image() by delaying the update to
217 the WIM's XML document until a write is requested.
219 On Windows, the target of an extraction may now be a reparse point
220 (which will be dereferenced).
222 On Windows, wimlib now correctly restores non-Microsoft reparse points.
223 However, this remains broken in NTFS-3g mode due to a libntfs-3g bug.
225 On Windows, wimlib now has improved performance when archiving files
226 from a filesystem backed by a WIM (a "WIMBoot" setup).
228 Several improvements to System Compression (compact mode) support:
230 wof.sys (or wofadk.sys) is now automatically attached to the
231 target volume if needed.
233 Compact-mode extractions now work correctly with wofadk.sys on
234 older versions of Windows.
236 For compatibility with the Windows bootloader, the requested
237 compression format now is overridden on certain files.
239 Other minor bugfixes.
242 This release primarily contains various minor bug fixes and
243 improvements, including:
245 Improved handling of deep directory structures.
247 Fixed a bug where on 32-bit systems, the library could enter an
248 infinite loop if a WIM file was malformed in a specific way.
250 Added a workaround for a case where libntfs-3g may report
251 duplicate streams in an NTFS file.
253 Windows symbolic links and junctions in mounted WIM images are
254 now automatically rewritten to be valid in the mounted location.
256 Reparse point fixes: correctly handle the "ReparseReserved"
257 field, and correctly handle "empty" (data-less) reparse points.
259 On Windows, wimlib now acquires SeManageVolumePrivilege, which
260 is needed to create externally backed files using the
263 Improved validation of filenames.
265 Improved LZMS decompression speed.
267 The configure script now honors alternate pkg-config settings.
269 Links have been updated to point to the new website.
271 In addition, experimental support has been added for compressing
272 extracted files using System Compression on Windows 10. This
273 functionality is available through the new '--compact' option to
274 'wimapply' and 'wimextract' as well as new library flags.
277 Fixed a bug in the LZX decompressor: malicious input data could cause
278 out of bounds writes to memory (since wimlib v1.2.2).
280 The output of the 'wiminfo' command now consolidates various boolean
281 flags (such as "Relative path junction") into a single line.
283 A file can now have both an unnamed data stream ("file contents") and a
284 reparse point stream. Such files can exist as a result of the use of
285 certain Windows features, such as offline storage, including "OneDrive".
286 wimlib will now store and restore both streams on Windows as well as in
287 NTFS-3g mode. Microsoft's WIMGAPI also has this behavior.
289 On Windows, named data streams of encrypted files are no longer stored
290 twice in WIM archives.
292 On Windows, named data streams are now correctly extracted to existing
293 "readonly" directories. Before, an error would be reported.
295 On Windows, it is now possible to do a "WIMBoot mode" extraction with
296 non-standalone WIMs such as delta WIMs.
298 On Windows, when doing an extraction in "WIMBoot mode", files larger
299 than 4 gigabytes are now never extracted as externally backed. This
300 works around a bug in Microsoft's "WOF" driver.
302 The '--enable-verify-compression' configure option has been removed. If
303 you want to verify a WIM file, use the 'wimverify' program.
305 The way the "file count", "directory count", "total bytes", and "hard
306 link bytes" image statistics (stored in the WIM XML data) is calculated
307 has been slightly changed.
309 In mounted WIM images, the disk usage provided for each file (st_blocks)
310 is now the compressed size rather than the uncompressed size.
312 The performance of the NTFS-3g and Windows capture modes has been
315 On UNIX-like systems, symbolic links whose targets contain the backslash
316 character are now handled correctly (losslessly).
319 Improved the LZX compressor. It is now 15-20% faster than before and
320 provides a slightly better compression ratio.
322 Improved the LZMS compressor. It now provides a compression ratio
323 slightly better than WIMGAPI while still being faster and using slightly
326 The compression chunk size in solid resources, e.g. when capturing or
327 exporting a WIM file using the '--solid' option, now defaults to 64 MiB
328 (67108864 bytes) instead of 32 MiB (33554432 bytes). This provides a
329 better compression ratio and is the same value that WIMGAPI uses. The
330 memory usage is less than 50% higher than wimlib v1.7.4 and is slightly
331 lower than WIMGAPI's memory usage, but if it is too much, it is still
332 possible to choose a lower value, e.g. with the '--solid-chunk-size'
333 option to wimlib-imagex.
335 The '--chunk-size' and '--solid-chunk-size' options to wimlib-imagex now
336 accept the 'K', 'M', and 'G' suffixes.
338 Files are now sorted by name extension when creating a solid WIM file.
340 Fixed various issues related to capture/apply of EFS-encrypted files on
343 The file list printed by 'wimdir' is now sorted by the platform-specific
344 case sensitivity setting, rather than always case sensitively. This
345 also affects the library function wimlib_iterate_dir_tree().
347 On Windows, some error and warning messages have been improved.
350 The Windows binary distribution no longer contains third party DLLs.
351 These dependencies are instead compiled directly into the libwim DLL.
353 Added more fixes for wimlib on non-x86 architectures such as ARM.
355 Extracting files to a Windows PE in-memory filesystem no longer fails if
356 the target files do not yet exist.
358 Improved the performance of XPRESS compression and LZMS decompression.
360 Enabled SSSE3 accelerated SHA-1 computation in x86_64 Windows builds.
361 It will automatically be faster on newer Intel and AMD processors.
363 Removed the --with-imagex-progname and --enable-more-assertions
367 Fix for very slow export from solid WIM / ESD files.
369 Fix for LZX and LZMS algorithms on non-x86 architectures, such as ARM.
371 New progress message: WIMLIB_PROGRESS_MSG_HANDLE_ERROR. Applications
372 may use this to treat some types of errors as non-fatal.
374 The library now permits making in-memory changes to a WIMStruct backed
375 by a read-only WIM file.
377 Fixes for "WIMBoot" extraction mode (Windows only):
379 When not using the WOF driver, extraction no longer fails if the
380 disk containing the WIM file has too many partitions.
382 When matching patterns in [PrepopulateList], all hard links of
383 each file are now considered.
385 The system registry files are now automatically treated as being
386 in [PrepopulateList].
388 Added a hack to try to work around an intermittent bug in
389 Microsoft's WOF (Windows Overlay Filesystem) driver.
392 Made more improvements to the XPRESS, LZX, and LZMS compressors.
394 A number of improvements to the Windows port:
396 Fixes for setting short filenames.
398 Faster "WIMBoot" extraction.
400 Updated and slimmed down the dependent DLLs.
402 ACL inheritence bits are now restored.
404 Mandatory integrity labels are now backed up and restored.
406 Added a workaround for an issue where in rare cases, wimlib could create
407 a compressed data stream that could not be read correctly by Windows
408 after an extraction in "WIMBoot" mode.
411 Added file count progress data for
412 WIMLIB_PROGRESS_MSG_EXTRACT_FILE_STRUCTURE and
413 WIMLIB_PROGRESS_MSG_EXTRACT_METADATA.
415 Added support for testing file exclusions via the user-provided
418 Some documentation improvements.
420 Made some clarifications to the license text in the COPYING file.
423 Made more improvements to the XPRESS, LZX, and LZMS compressors.
425 The default compression mode for wimcapture is now LZX compression in
426 its default mode, which is the same as '--compress=maximum'.
428 You can now specify an optional integer compression level to the
429 '--compress' option; e.g. '--compress=lzx:75'.
431 Made a minor change to the LZMS compressor and decompressor to fix an
432 incompatibility with the Microsoft implementation. In the unlikely
433 event that you created an LZMS-compressed WIM with wimlib v1.7.0 or
434 earlier and a checksum error is reported when extracting files from it
435 with wimlib v1.7.1, decompress it with v1.7.0 then compress it with
438 Added 'verify' subcommand to wimlib-imagex.
440 Notable library changes:
442 Custom compressor parameters have been removed from the library
443 in favor of the simpler level-based API.
445 Decompressor parameters have been removed entirely.
447 Library users can now specify a custom file for warning and
448 error messages to be sent to, rather than the default of
451 New progress messages:
452 WIMLIB_PROGRESS_MSG_EXTRACT_FILE_STRUCTURE,
453 WIMLIB_PROGRESS_MSG_EXTRACT_METADATA.
455 New function: wimlib_verify_wim().
458 Improved compression, decompression, and extraction performance.
460 Improved compatibility with version 3584 WIM / ESD files:
461 - Add support for reading and writing multiple solid blocks per
462 archive, which WIMGAPI/DISM can create when appending an image.
463 - Correctly create solid blocks larger than 4 GiB.
465 'add' commands passed to wimupdate will now replace existing
466 nondirectory files by default. Use the --no-replace option to get the
469 The license for the library now contains an exception that allows using
470 it under the LGPL. See the COPYING file for details.
472 In reparse-point fixup mode (the default for capture), symbolic links
473 and junctions that point outside the tree being captured are no longer
474 excluded from capture.
476 Added support for "WIMBoot" capture and extraction. See the
477 documentation for the new '--wimboot' option to wimcapture and wimapply
478 for more information.
480 On UNIX-like systems, you can now backup and restore device nodes, named
481 pipes, and sockets. In addition, 32-bit user and group IDs are now
484 The way that UNIX data is stored in WIM files has been changed. If you
485 captured any WIMs with the --unix-data option, to upgrade them you'll
486 need to apply them with --unix-data using wimlib-imagex v1.6.2, then
487 re-capture them with --unix-data using this version.
489 wimlib now understands tagged metadata items, such as object IDs, that
490 can be stored in WIM directory entries.
492 Removed the --hardlink and --symlink options to wimapply, since I don't
493 think they are too useful and they got in the way of improving the code.
495 WIMs will now retain their GUIDs when rebuilt (e.g. with wimoptimize).
497 The 'mkwinpeimg' script now supports writing the ISO image to standard
500 The <ARCH> element in WIM XML data is now exported correctly.
502 On Windows, sparse file attributes are no longer set on extracted files.
503 Oddly enough, this actually saves disk space in some cases.
505 On UNIX, configuring with --disable-xattr or --enable-xattr is no longer
506 supported. Mounting WIM images now always requires extended attribute
507 support. Use --without-fuse to disable support for mounting WIM images;
508 this will also disable the need for extended attribute support.
510 Configuring with --enable-ssse3-sha1 now works correctly.
512 The shared library version has been bumped up. The main
513 incompatibilities are:
515 - WIMLIB_COMPRESSION_TYPE_XPRESS is now 1 and
516 WIMLIB_COMPRESSION_TYPE_LZX is now 2 (so it's the same as
519 - User-provided progress functions are now registered using a
520 separate function, wimlib_register_progress_function(). The
521 'progress_func' argument to many functions no longer exists.
523 - The return value from user-provided progress functions is now
526 - A context argument has been added to the prototype of
527 user-provided progress functions.
529 - 'struct wimlib_capture_config' has been removed. The library
530 now takes the path to the configuration file directly. This
531 affects wimlib_add_image(), wimlib_add_image_multisource(),
532 and wimlib_update_image(). However, a NULL value passed in
533 the argument retains the same meaning.
535 - Removed deprecated functions: some (de)compression functions,
536 wimlib_extract_files(), and wimlib_print_metadata().
538 - Removed extraction flags: WIMLIB_EXTRACT_FLAG_HARDLINK,
539 WIMLIB_EXTRACT_FLAG_SYMLINK, WIMLIB_EXTRACT_FLAG_FILE_ORDER,
540 and WIMLIB_EXTRACT_FLAG_SEQUENTIAL.
542 - Removed some progress messages:
543 WIMLIB_PROGRESS_MSG_APPLY_TIMESTAMPS,
544 WIMLIB_PROGRESS_MSG_EXTRACT_DIR_STRUCTURE_BEGIN,
545 WIMLIB_PROGRESS_MSG_EXTRACT_DIR_STRUCTURE_END. Numbering
548 - Removed some error codes. Numbering stays the same.
550 - Replaced WIMLIB_UNMOUNT_FLAG_LAZY with
551 WIMLIB_UNMOUNT_FLAG_FORCE.
553 - WIM paths passed to progress functions now have a leading
557 Case-insensitive comparisons of strings (e.g. filenames) containing
558 UTF-16 codepoints above 32767 are now done correctly.
560 Fixed build failure on Mac OS X.
562 wimunmount now provides the '--new-image' option to cause changes to a
563 read-write mounted image to be committed as a new image rather than as
564 an update of the mounted image. (The corresponding new library flag is
565 WIMLIB_UNMOUNT_FLAG_NEW_IMAGE.)
567 The LZMS ("recovery") compression chunk size, or "dictionary size", may
568 now be up to 1 GiB (1,073,741,824 bytes).
570 The performance of LZX ("maximum") and LZMS ("recovery") compression
571 with large chunk sizes has been slightly improved.
574 Stored files with size exactly 4 GiB (4,294,967,296 bytes) are now
575 decompressed correctly.
577 Fixed a bug in the LZX compressor introduced in v1.5.3. The bug
578 occurred in an unlikely case, and due to validity checks it did not
579 affect successfully created archives.
581 Fixed a minor compatibility issue with the LZMS compressor and
582 decompressor. This is *not* the default compression type and was only
583 introduced in v1.6.0. In the unlikely event that you created an
584 LZMS-compressed WIM with v1.6.0 and a checksum error is reported when
585 applying it with v1.6.1, decompress it with v1.6.0 then compress it with
588 Memory usage for LZMS and LZX compression has been decreased.
590 wimextract now allows wildcard characters in paths specified on the
591 command line. Also, the '--strict-wildcards' option has been removed
592 and replaced with the inverse option '--nullglob'. See the
593 documentation for wimextract for more details and changes.
595 The wimlib_extract_files() function is now considered deprecated in
596 favor of wimlib_extract_paths().
598 Fixed more permissions problems when extracting files on Windows.
600 A new '--no-attributes' option has been added to wimapply and
601 wimextract. The library flag is WIMLIB_EXTRACT_FLAG_NO_ATTRIBUTES.
603 The default chunk size is now set correctly when changing the
604 compression type of a WIM, for example with 'wimoptimize'.
606 The '--metadata' option to wiminfo has been replaced with the
607 '--detailed' option to wimdir.
609 In relevant wimlib-imagex commands, '--solid' may now be used as an
610 alias for '--pack-streams'.
613 Support for extracting and updating the new version 3584 WIMs has been
614 added. These WIMs typically pack many streams ("files") together into a
615 single compressed resource, thereby saving space. This degrades the
616 performance of random access (such as that which occurs on a mounted
617 image), but optimizations have been implemented for extraction. These
618 new WIM files also typically use a new compression format (LZMS), which
619 is similar to LZMA and can offer a better compression ratio than LZX.
620 These new WIM files can be created using `wimcapture' with
621 the '--compress=lzms --pack-streams' options. Note: this new WIM format
622 is used by the Windows 8 web downloader, but important segments of the
623 raw '.esd' files are encrypted, so wimlib will not be able to extract
624 such files until they are first decrypted.
626 wimlib now supports extracting files and directories from a WIM image
627 based on a "listfile" that itself contains the list of paths to extract.
628 For `wimextract', the syntax is to specify @LISTFILE instead of a PATH,
629 and for the library itself, the new APIs are wimlib_extract_pathlist()
630 and wimlib_extract_paths(). Path globs containing wildcard characters
633 For searching WIM files, wimlib now has configurable case sensitivity.
634 The default on Windows is still case-insensitive and the default on
635 UNIX-like systems is still case-sensitive, but this can be overridden
636 on either platform through flags to wimlib_global_init(). For
637 `wimlib-imagex', the environmental variable WIMLIB_IMAGEX_IGNORE_CASE
638 can be set to 1 or 0 for case-insensitive or case-sensitive behavior,
641 Support for compression chunk sizes greater than the default of 32768
642 bytes has been added. A larger chunk size typically results in a better
643 compression ratio. However, the MS implementation is seemingly not
644 compatible with all chunk sizes, especially for LZX compression, so the
645 defaults remain unchanged, with the exception of the new LZMS-compressed
646 WIMs, which use a larger chunk size by default.
648 The compression/decompression API exported by wimlib has been changed.
649 Now one set of functions handles all supported compression formats.
651 `wimcapture' and `wimappend' will now display the progress of scanning
652 the directory tree to capture, in addition to the progress of writing
653 data to the WIM. The '--verbose' option no longer does anything. The
654 library API change for this is the addition of several members to
655 `struct wimlib_progress_info_scan' available to progress callbacks.
657 `mkwinpeimg' now correctly handles the '--start-script' option when the
658 start script is not in the working directory.
660 Sequential extraction, previously requested by using
661 WIMLIB_EXTRACT_FLAG_SEQUENTIAL, is now the default.
662 WIMLIB_EXTRACT_FLAG_FILE_ORDER can be used to get the old default
663 behavior (extract in file order).
666 The new LZX compressor added in v1.5.2 has been improved and is now
667 enabled by default, except when `wimcapture' or `wimappend' is run
668 *without* the '--compress' option, in which case the faster LZX
669 compressor is used (the same as before). This behavior is reasonably
670 consistent with ImageX which actually uses "fast" (XPRESS) compression
671 by default. In those cases, use '--compress=maximum' to explicitly
672 capture a WIM image using the new (slower but better) LZX compressor.
674 The '--compress-slow' option still exists to `wimlib-imagex optimize',
675 but its new behavior is to tweak the new LZX compressor even more to
676 produce an even better compression ratio at the cost of more time spent
679 `wimlib-imagex optimize' now supports the '--compress=TYPE' option,
680 which recompresses the WIM file using the specified compression TYPE.
681 The new library API function used for this is
682 wimlib_set_output_compression_type().
684 Added the wimlib_get_xml_data() function to allow library clients to
685 easily retrieve the raw XML data from a WIM file if needed.
687 Fixed a bug that could cause an error code to be incorrectly returned
688 when writing XML data containing a <WINDOWS> element.
690 Mounted WIM images will now correctly show the default file stream even
691 if appears in the alternate data stream entries of the corresponding WIM
695 Added a new experimental LZX compressor which can be enabled by passing
696 '--compress-slow' to `wimlib-imagex capture' or `wimlib-imagex
697 optimize'. (The latter is only applicable if the WIM is already
698 LZX-compressed and the '--recompress' option is also given.) The
699 experimental compressor is much slower but compresses the data slightly
700 more --- currently usually to within a fraction of a percent of the
701 results from WIMGAPI/ImageX.
703 A workaround has been added for compatibility with versions of WinPE
704 that interpret alternate data stream entries in the boot WIM
707 An alignment bug that caused a crash in the LZX decompressor on some
710 wimlib now attempts to clear the WIM_HDR_FLAG_WRITE_IN_PROGRESS flag in
711 the WIM header when restoring the previous state of a WIM it failed to
714 Added a workaround to avoid an access denied error on Windows when
715 replacing a WIM file that another process has opened.
718 wimlib can now open WinPE WIMs from WAIK v2.1, which had a quirk that
719 needed to be handled.
721 A bug in the interpretation of negative IMAGE indices in the
722 --update-of=[WIMFILE:]IMAGE option to `wimlib-imagex capture' and
723 `wimlib-imagex append' has been fixed.
725 A workaround has been added to successfully apply security descriptors
726 with empty DACLs when the NTFS-3g apply mode is being used with NTFS-3g
727 2013.1.13 or earlier.
729 `wimlib-imagex capture' can now accept the '--delta-from' option
733 Added support for "pipable" WIMs. Pipable WIMs allow capturing images
734 to standard output and applying images from standard input, but they are
735 not compatible with Microsoft's software and are not created by default.
736 See the documentation for --pipable flag of `wimlib-imagex capture' for
739 To better support incremental backups, added support for declaring an
740 image as a modified form of another image. See the documentation for
741 the '--update-of' option of `wimlib-imagex append' and `wimlib-imagex
744 Added supported for "delta" WIMs. See the documentation for the
745 '--delta-from' option of `wimlib-imagex capture'.
747 The library support for managing split WIMs has been changed to support
748 other arrangements, such as delta WIMs, and be easier to use. This
749 change is visible in `wimlib-imagex', which also can now accept the
750 '--ref' option multiple times, and also now supports "delta" WIMs as
753 wimlib now preserves WIM integrity tables by default, even if
754 WIMLIB_WRITE_FLAG_CHECK_INTEGRITY is not specified. This changes the
755 behavior of `wimlib-imagex' whenever the WIM being operated on contains
756 an integrity table and the '--check' option is not specified.
758 `wimlib-imagex capture' now creates LZX-compressed WIMs by default
759 (when --compress is not specified). This provides the best compression
760 ratio by default, which is usually what is desired, at a cost of some
763 `wimlib-imagex' now supports being invoked as wimCOMMAND, where COMMAND
764 is the command as in `wimlib-imagex COMMAND'; for example, it can be
765 invoked as `wimapply' as an alternative to `wimlib-imagex apply'. The
766 appropriate hard links are created in UNIX installations of
767 `wimlib-imagex', while for the Windows distribution of `wimlib-imagex',
768 batch files that emulate this behavior are generated.
770 Security descriptors are now extracted correctly on Windows.
772 Fixed archiving DOS names in NTFS-3g capture mode.
774 The extraction code has been rewritten and it will now be easier to
775 support new features on all supported backends (currently Win32, UNIX,
776 and NTFS-3g). For example, hard-linked extraction mode (--hardlink) is
777 now supported on all backends, not just UNIX.
779 `mkwinpeimg' now supports grabbing files from the WAIK supplement rather
780 than the WAIK itself.
782 wimlib_global_init() now, by default, attempts to acquire additional
783 privileges on Windows, so library clients need not do this.
785 This update bumps the shared library version number up to 9, since it is
786 not binary compatibible with previous releases.
789 Fixed bug in `wimlib-imagex export' that made it impossible to export an
790 image from a WIM that is readonly at the filesystem level.
792 Return error code rather than segfaulting when trying to list files from
793 a non-first part of a split WIM.
795 Joining a WIM will now preserve the RP_FIX and READONLY flags.
798 On Windows, paths given to wimlib-imagex are now treated case
801 Improved behavior regarding invalid filenames; in particular, on
802 Windows, wimlib-imagex will, when extracting, now omit (with an option
803 to override this default) filenames differing only in case, or filenames
804 containing characters not valid on Windows.
806 On Windows, wimlib now supports capturing and extracting long paths
807 (longer than the so-called MAX_PATH).
809 On Windows, `wimlib-imagex update' now acquires proper privileges when
810 running as an Administrator.
812 `wimlib-imagex update' will now complain if no image is specified when
813 trying to update a multi-image WIM.
815 `wimlib-imagex update' now supports specifying a single update command
816 directly on the command line using the --command option.
818 wimlib-imagex will now choose different units for progress messages,
819 depending on the amount of data that needs to be processed.
821 `wimlib-imagex append' will now generate a unique WIM image name if no
822 name is specified and the defaulted name already exists in the WIM.
824 wimlib now allows you to create unnamed WIM images, which can then only
825 be referred to by index.
827 wimlib now allows you to explicitly declare you want write access to a
828 WIM by providing the WIMLIB_OPEN_FLAG_WRITE_ACCESS flag to
831 wimlib now respects the WIM_HDR_FLAG_READONLY flag when set in the WIM
834 Progress callbacks have been added to wimlib's wimlib_update_image()
837 Added wimlib_get_wim_info(), wimlib_set_wim_info(),
838 wimlib_iterate_dir_tree(), and wimlib_iterate_lookup_table() functions
841 NTFS-3g capture now only warns about two conditions previously treated
844 Fixed a couple issues with using wimlib-imagex on UDF filesystems on
847 wimlib now correctly detects and returns an error when reading a WIM
848 image with a cyclic directory structure. (Fun fact: such a WIM will
849 crash Microsoft's software.)
852 Added new "extract" and "update" subcommands to wimlib-imagex, along
853 with associated APIs in the library. These commands are intended mainly
854 for Windows use but can be used on UNIX as well.
856 Many documentation improvements.
858 Fixed a bug in the Windows build where relative symbolic links were not
859 captured in reparse-point fixup mode.
861 Fixed a bug in the Windows build where file handles were left open to
862 the WIM file, causing `wimlib_imagex optimize' to fail in some cases.
864 Fixed a bug in the Windows build of wimlib-imagex where globbing
865 split-WIM parts could cause the program to crash.
867 Fixed a bug where the creation time of WIM images would be shown instead
868 of the last modification time.
870 With the Windows build it is now possible to restore a WIM containing
871 symbolic links as a non-Administrator; however you will receive warnings
872 about not being able to extract the symbolic links.
875 Capturing a WIM image should now be significantly faster in most cases
876 due to improved use of the operating system's cache and avoiding reading
877 files twice whenever possible.
879 The Windows build should now work on Windows XP.
881 The Windows build now supports capturing and restoring hidden,
882 compressed, sparse, and encrypted files.
884 The Windows build now supports capturing and applying WIM images from
885 filesystems other than NTFS (with some reduced functionality).
887 The Windows build now extracts short names correctly.
889 Added support for "reparse-point" fixups (i.e. fixing up of symbolic
890 links). See docs for --rpfix and --norpfix flags of `wimlib-imagex
891 capture' and `wimlib-imagex apply'.
893 The performance of splitting and joining WIMs should be slightly
896 The LZX and XPRESS compression and decompression functions are now
897 exported from the library.
900 Improvements and bugfixes for the Windows build.
902 Added --strict-acls options.
904 Fixed the way that wimlib determines the order of images in the WIM.
907 Since wimlib can now be used on Windows, wimlib's implementation of
908 ImageX has been renamed to wimlib-imagex to avoid confusion with
909 Microsoft's implementation of ImageX, which would have the same file
910 name ("imagex.exe"). If you really don't like this you can pass the
911 --with-imagex-progname option to `configure' to choose a different name,
912 or even simply rename the binary yourself (but the former way will
913 configure the man pages to use the chosen name).
915 Various bugs fixed in the Windows build. Mainly to do with capturing
916 and restoring alternate data streams correctly in weird cases, and
917 requesting the correct privileges when opening files. Also added the
918 --noacls options to wimlib-imagex capture, append, and apply.
920 Windows build again: FindFirstStreamW() and FindNextStreamW() are now
921 dynamically loaded, so this may make the library compatible with Windows
922 XP (however, there may still be other problems).
925 Added experimental support for native Windows builds. Binaries can be
926 downloaded from the SourceForge page.
928 --source-list option added to `imagex capture' and `imagex append'.
930 Better support for different character encodings.
933 Storing UNIX file owners, groups, and modes in WIM images is now
934 possible using `imagex capture' with the --unix-data flag.
936 Minor bug fixes and documentation fixes.
939 NTFS capture: Fixed capturing duplicate reparse points.
941 NTFS capture: Capture first unnamed stream if there are more than one
942 (print warning instead of error).
944 Allow multiple test cases to execute concurrently (e.g. make -j2 check).
947 Added --arch switch to mkwinpeimg script to support getting AMD64 WinPE
950 Update to work with ntfs-3g version 2013.1.13.
953 Fixed truncating file to shorter but non-zero length on read-write
956 Various code cleanups and minor documentation fixes.
959 LZX and XPRESS decompression have received some additional optimizations
960 and should now be even faster. (Although, they were already pretty
961 fast--- much faster than typical I/O speeds.)
963 Fixed a bug introduced in v1.2.1 that would cause a directory tree
964 containing hard links to be captured incorrectly in some cases.
967 By default, unmounting a read-write mounted WIM with 'imagex unmount
968 --commit' will now change the WIM in-place without needing to write the
969 entire WIM again. Use 'imagex unmount --commit --rebuild' to get the
972 'imagex unmount' no longer has a hard-coded limit of 10 minutes to wait
973 for a response from the daemon servicing the mounted WIM. Instead,
974 every second 'imagex unmount' will check if the daemon is still alive,
975 and keep waiting if so, otherwise terminate with an error.
977 'imagex unmount --commit' on a read-write mounted WIM will now print
978 progress information regarding the writing of new or modified streams
979 the WIM, just like when capturing or appending a WIM.
981 A small change has been made to XPRESS compression and it should improve
982 the compression ratio slightly.
984 A change was made that may improve performance slightly when applying a
985 WIM image to a NTFS volume.
987 Microsoft has managed to introduce even more bugs into their software,
988 and now the WIMs for Windows 8 have incorrect (too low) reference counts
989 for some streams. This is unsafe because such streams can be removed
990 when they are in actuality still referenced in the WIM (perhaps by a
991 different image). wimlib will now work around this problem by fixing
992 the stream reference counts. This is only done when wimlib_delete_image() is
993 called ('imagex delete') or when wimlib_mount_image() is called with
994 WIMLIB_MOUNT_FLAG_READWRITE ('imagex mountrw'). Please note that this
995 requires reading the metadata for all images in the WIM, so this will
996 make these operations noticably slower on WIMs with multiple images.
998 Various other bugfixes.
1001 Appending images to a WIM is now be done by default without re-building
1002 the whole WIM. Use the --rebuild flag to get the old behavior (which
1003 was to re-build the entire WIM when a new image is appended).
1005 A new command `imagex optimize' is now available to manually re-build a
1006 WIM that has wasted space due to repeated appends.
1008 Progress information has been improved, and now arbitrary callback
1009 functions can be used to show the progress of a WIM operation.
1011 A possible bug with changing the bootable image of a WIM was fixed.
1013 Some advisory locking is now done to prevent two processes from
1014 modifying a WIM at the same time (but only in some cases). For example,
1015 you cannot mount two images from a WIM read-write at the same time.
1017 Some functions have been reorganized:
1018 * wimlib_mount() renamed to wimlib_mount_image().
1019 * wimlib_unmount() renamed to wimlib_unmount_image().
1020 * wimlib_overwrite_xml_and_header() removed as
1021 wimlib_overwrite() suffices now.
1022 * wimlib_apply_image_to_ntfs_volume() removed as
1023 wimlib_extract_image() suffices now.
1024 * wimlib_add_image_from_ntfs_volume() removed as
1025 * wimlib_add_image() suffices now.
1027 Previously, the soname of libwim.so has been 0.0.0, despite many
1028 interface changes. The soname is now updated to 1.0.0 and will now be
1029 updated each release.
1032 Resources will now be compressed using multiple threads by default.
1033 (This applies to `imagex capture', `imagex append', and `imagex
1036 Some performance improvements in mounted WIMs.
1038 More progress information is shown when capturing a WIM.
1041 Lots of minor fixes, code cleanups, and some documentation updates.
1042 Nothing in particular is really noteworthy.
1045 LZX and XPRESS compression improvements.
1047 Fixed calculation of Directory Count, File Count, Total Bytes, and Hard
1048 Link Bytes of the WIM.
1051 Fixed bug when capturing NTFS file with multiple named data streams.
1053 Internally, we are now using inode structures, even though these don't
1054 appear literally in the WIM file. This simplifies some of the code
1055 (mainly for WIM mounting) and likely fixed a few problems, although it
1059 Fixed problem when exporting images from XPRESS to LZX compressed WIM or
1063 Enough changes to call it version 1.0.0!
1065 Capturing a WIM directly from a NTFS volume, and applying a WIM directly
1066 to a NTFS volume, is now supported.
1068 Hard links and symbolic links have much improved support. They are
1069 supported for WIM capture, WIM application, and mounted WIMs (you can
1070 even make them on read-write mounted WIMs).
1072 Alternate data streams are now supported on mounted WIMs through an
1073 xattr or a Windows-style stream interface. Also they are supported when
1074 capturing a WIM from NTFS or applying a WIM to NTFS.
1076 Split WIMs are better supported. You may now apply an image directly
1077 from a split WIM, mount an image from a split WIM read-only, or export
1078 an image from a split WIM.
1080 Using a capture configuration file is now supported (but not fully yet).
1082 SHA1 message digests are checked in more places, so we can make sure
1083 applied and captured data is correct.
1085 Man pages have been updated and consolidated.
1088 Fixed segfault when unmounting read-only WIM.
1091 Support for joining and splitting WIMs.
1092 Also, security data is now preserved by default.
1095 Can now build with older gcc and system headers, like on CentOS 5.
1098 Fixed bug that made it impossible to overwrite files in read-write
1102 Write byte-order mark before WIM XML data. (imagex.exe requires this to
git://wimlib.net / wimlib / blob