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