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 Added an '--include-integrity' option to various wimlib-imagex commands.
9 '--include-integrity' is like '--check', but it will just include an
10 integrity table in the output WIM(s), while skipping verification of any
11 existing integrity tables. This can be useful to avoid unwanted
12 verification of large WIM files, e.g. WIMs given by '--delta-from'.
14 'wimlib-imagex --version' now shows the version of the library it is
15 actually using (in case it is different from wimlib-imagex's version).
18 Fixed a bug that was causing the LZMS decompressor to be miscompiled
19 with GCC 7 (this broke extracting "solid" archives).
21 The Windows 10 Recycle Bin directory (\$RECYCLE.BIN) has been added to
22 the default exclusion list.
24 Added a '--quiet' option to wimlib-imagex.
26 The 'mkwinpeimg' script now also looks for the syslinux BIOS modules in
27 the directory /usr/lib/syslinux/modules/bios.
29 Files with timestamps before the year 1970 are now extracted correctly
30 to UNIX-style filesystems, are displayed correctly by
31 'wimdir --detailed', and show up correctly in mounted WIM images.
33 Files with timestamps after the year 2038 are now displayed correctly by
34 the 32-bit Windows build of wimlib.
37 Fixed a data corruption bug (incorrect compression) when storing an
38 already highly-compressed file in an LZX-compressed WIM with a chunk
39 size greater than or equal to 64K. Note that this is not the default
40 setting and such WIMs are not supported by Microsoft's WIM software, so
41 only users who used the --chunk-size option to wimlib-imagex or the
42 wimlib_set_output_chunk_size() API function may have been affected.
43 This bug was introduced in wimlib v1.10.0. See
44 https://wimlib.net/forums/viewtopic.php?f=1&t=300 for more details.
46 On all platforms, sparse files are now extracted as sparse.
48 Sparse files captured from UNIX-style filesystems are now marked as
49 sparse in the resulting WIM image.
51 Added support for storing Linux-style extended attributes in WIM images.
52 When the --unix-data option is used on Linux, wimlib-imagex now captures
53 and applies extended attributes, in addition to the already-supported
54 standard UNIX file permissions (owner/group/mode) and special files.
56 --delta-from is now supported by wimappend. (Previously it was only
57 supported by wimcapture.)
59 On Windows, improved the way in which files deduplicated with Windows'
60 Data Deduplication feature are captured.
62 The development files needed to link with wimlib using Visual Studio are
63 now included in the Windows release archives.
65 wimlib.h can now be included by Visual Studio without errors.
67 The example programs can now be compiled in C++ mode, and they also now
70 Updated 'mkwinpeimg' to work correctly on images that have a "windows"
71 (lower case) directory rather than a "Windows" (upper case) directory.
73 Fixed configuring with --enable-ssse3-sha1 from release tarball
74 (the file nasm_lt.sh was missing).
76 Made some documentation improvements.
79 The LZX compression ratio has been slightly improved. The default mode,
80 LZX level 50, is now almost as good as the old LZX level 100, while
81 being nearly the same speed as before.
83 Decompression performance has been slightly improved.
85 Filenames are now always listed in NTFS collation order.
87 On UNIX-like systems, wimlib can now process Windows filenames that are
88 not valid Unicode due to the presence of unpaired surrogates.
90 On UNIX-like systems, wimlib now always assumes UTF-8 encoding with the
91 addition of surrogate codepoints. Consequently, the environmental
92 variable WIMLIB_IMAGEX_USE_UTF8 and the flag
93 WIMLIB_INIT_FLAG_ASSUME_UTF8 no longer have any effect.
95 wimlib no longer depends on iconv.
97 Reduced memory usage slightly.
99 When a WIM image is applied in NTFS-3G mode, security descriptors are
100 now created in NTFS v3.0 format when supported by the volume.
102 Workarounds for bugs in libntfs-3g version 2013.1.13 and earlier have
103 been removed. Users are advised to upgrade to a later version of
106 On Windows, wimlib now supports case-sensitive filename extraction when
107 supported by the underlying operating system and filesystem (operating
108 system support requires a registry setting).
111 On UNIX, wimlib can now overwrite readonly files when extracting.
113 On Windows, fixed a bug where wimlib could leave a null DACL (a.k.a. "no
114 NTFS permissions") set on some existing directories after extraction.
116 On Windows, when applying a WIM image in "WIMBoot mode" when the WOF
117 driver is not loaded, wimlib can now correctly register a new WIM file
118 with the target volume when the target volume previously had had WIM
121 Added a new testing program.
123 Clarified the main license text and updated public domain dedications
124 for certain files to be more thorough.
127 Object IDs are now saved and restored on Windows and in NTFS-3G mode.
129 Reduced memory usage when exporting large numbers of WIM images.
131 Non UTF-8 locales are now detected correctly.
133 Addressed compiler warnings and enabled "silent" make rules by default.
135 Windows-specific updates:
136 Fixed a bug where duplicate backslashes could be generated in
137 link targets when extracting symbolic links and junctions.
139 Fixed a bug where the .cmd shortcuts for wimlib-imagex wouldn't
140 work if their full path contained a space.
142 Fixed bugs related to scanning SMB filesystems.
144 Added warning message about known issue with WindowsApps folder.
146 Added instructions for building from source on Windows.
148 VSS support is no longer marked "experimental".
150 Added missing license file for libdivsufsort-lite.
153 Added experimental support for Windows VSS (Volume Shadow Copy Service).
154 The new '--snapshot' argument to 'wimcapture' makes wimlib automatically
155 create and use a temporary VSS snapshot when capturing a WIM image.
157 Implemented setting of Windows-specific XML information, such as
158 architecture, system root, and version details. This information is now
159 automatically set in newly captured WIM images, when appropriate.
161 Improved performance of directory tree scans on Windows.
163 On Windows, to improve capture performance, wimlib now sometimes opens
164 files by inode number rather than by path. This is enabled for
165 wimcapture and wimappend, but for now other applications have to opt-in.
167 The progress messages printed by wimlib-imagex while writing WIM files
168 have been slightly tweaked.
170 Progress information for directory tree scans now counts all hard links.
171 Also, on Windows "\\?\" is no longer stripped from the current path.
173 Added a new '--image-property' option to 'wimcapture', 'wimappend', and
174 'wiminfo'. This option lets you assign values to elements in a WIM
175 file's XML document by name.
177 The wimlib_get_image_property() and wimlib_set_image_property() API
178 functions now support numerically indexed elements.
180 Fixed a bug where, on Windows, wimlib would change the security
181 descriptor of the target directory of an extraction even when the
182 '--no-acls' option was specified.
185 Fixed a bug with libntfs-3g extraction present since v1.8.1. Sometimes,
186 some Microsoft software would not correctly recognize data in the
187 resulting filesystem.
189 Made some small improvements to the compression algorithms:
190 LZX compression ratio was slightly improved.
191 XPRESS compression ratio and speed was slightly improved.
192 LZMS compression speed was slightly improved.
194 Improved handling of WIM XML data. wimlib no longer drops unrecognized
195 elements when exporting images. In addition, two API functions were
196 added for better access to elements in the XML document:
197 wimlib_get_image_property() and wimlib_set_image_property().
199 Added support for (unsafe) in-place compaction of WIM files.
201 Improved performance of image export by reusing metadata resources
202 instead of always rebuilding and recompressing them.
204 Improved performance of wimlib_update_image() by delaying the update to
205 the WIM's XML document until a write is requested.
207 On Windows, the target of an extraction may now be a reparse point
208 (which will be dereferenced).
210 On Windows, wimlib now correctly restores non-Microsoft reparse points.
211 However, this remains broken in NTFS-3g mode due to a libntfs-3g bug.
213 On Windows, wimlib now has improved performance when archiving files
214 from a filesystem backed by a WIM (a "WIMBoot" setup).
216 Several improvements to System Compression (compact mode) support:
218 wof.sys (or wofadk.sys) is now automatically attached to the
219 target volume if needed.
221 Compact-mode extractions now work correctly with wofadk.sys on
222 older versions of Windows.
224 For compatibility with the Windows bootloader, the requested
225 compression format now is overridden on certain files.
227 Other minor bugfixes.
230 This release primarily contains various minor bug fixes and
231 improvements, including:
233 Improved handling of deep directory structures.
235 Fixed a bug where on 32-bit systems, the library could enter an
236 infinite loop if a WIM file was malformed in a specific way.
238 Added a workaround for a case where libntfs-3g may report
239 duplicate streams in an NTFS file.
241 Windows symbolic links and junctions in mounted WIM images are
242 now automatically rewritten to be valid in the mounted location.
244 Reparse point fixes: correctly handle the "ReparseReserved"
245 field, and correctly handle "empty" (data-less) reparse points.
247 On Windows, wimlib now acquires SeManageVolumePrivilege, which
248 is needed to create externally backed files using the
251 Improved validation of filenames.
253 Improved LZMS decompression speed.
255 The configure script now honors alternate pkg-config settings.
257 Links have been updated to point to the new website.
259 In addition, experimental support has been added for compressing
260 extracted files using System Compression on Windows 10. This
261 functionality is available through the new '--compact' option to
262 'wimapply' and 'wimextract' as well as new library flags.
265 Fixed a bug in the LZX decompressor: malicious input data could cause
266 out of bounds writes to memory (since wimlib v1.2.2).
268 The output of the 'wiminfo' command now consolidates various boolean
269 flags (such as "Relative path junction") into a single line.
271 A file can now have both an unnamed data stream ("file contents") and a
272 reparse point stream. Such files can exist as a result of the use of
273 certain Windows features, such as offline storage, including "OneDrive".
274 wimlib will now store and restore both streams on Windows as well as in
275 NTFS-3g mode. Microsoft's WIMGAPI also has this behavior.
277 On Windows, named data streams of encrypted files are no longer stored
278 twice in WIM archives.
280 On Windows, named data streams are now correctly extracted to existing
281 "readonly" directories. Before, an error would be reported.
283 On Windows, it is now possible to do a "WIMBoot mode" extraction with
284 non-standalone WIMs such as delta WIMs.
286 On Windows, when doing an extraction in "WIMBoot mode", files larger
287 than 4 gigabytes are now never extracted as externally backed. This
288 works around a bug in Microsoft's "WOF" driver.
290 The '--enable-verify-compression' configure option has been removed. If
291 you want to verify a WIM file, use the 'wimverify' program.
293 The way the "file count", "directory count", "total bytes", and "hard
294 link bytes" image statistics (stored in the WIM XML data) is calculated
295 has been slightly changed.
297 In mounted WIM images, the disk usage provided for each file (st_blocks)
298 is now the compressed size rather than the uncompressed size.
300 The performance of the NTFS-3g and Windows capture modes has been
303 On UNIX-like systems, symbolic links whose targets contain the backslash
304 character are now handled correctly (losslessly).
307 Improved the LZX compressor. It is now 15-20% faster than before and
308 provides a slightly better compression ratio.
310 Improved the LZMS compressor. It now provides a compression ratio
311 slightly better than WIMGAPI while still being faster and using slightly
314 The compression chunk size in solid resources, e.g. when capturing or
315 exporting a WIM file using the '--solid' option, now defaults to 64 MiB
316 (67108864 bytes) instead of 32 MiB (33554432 bytes). This provides a
317 better compression ratio and is the same value that WIMGAPI uses. The
318 memory usage is less than 50% higher than wimlib v1.7.4 and is slightly
319 lower than WIMGAPI's memory usage, but if it is too much, it is still
320 possible to choose a lower value, e.g. with the '--solid-chunk-size'
321 option to wimlib-imagex.
323 The '--chunk-size' and '--solid-chunk-size' options to wimlib-imagex now
324 accept the 'K', 'M', and 'G' suffixes.
326 Files are now sorted by name extension when creating a solid WIM file.
328 Fixed various issues related to capture/apply of EFS-encrypted files on
331 The file list printed by 'wimdir' is now sorted by the platform-specific
332 case sensitivity setting, rather than always case sensitively. This
333 also affects the library function wimlib_iterate_dir_tree().
335 On Windows, some error and warning messages have been improved.
338 The Windows binary distribution no longer contains third party DLLs.
339 These dependencies are instead compiled directly into the libwim DLL.
341 Added more fixes for wimlib on non-x86 architectures such as ARM.
343 Extracting files to a Windows PE in-memory filesystem no longer fails if
344 the target files do not yet exist.
346 Improved the performance of XPRESS compression and LZMS decompression.
348 Enabled SSSE3 accelerated SHA-1 computation in x86_64 Windows builds.
349 It will automatically be faster on newer Intel and AMD processors.
351 Removed the --with-imagex-progname and --enable-more-assertions
355 Fix for very slow export from solid WIM / ESD files.
357 Fix for LZX and LZMS algorithms on non-x86 architectures, such as ARM.
359 New progress message: WIMLIB_PROGRESS_MSG_HANDLE_ERROR. Applications
360 may use this to treat some types of errors as non-fatal.
362 The library now permits making in-memory changes to a WIMStruct backed
363 by a read-only WIM file.
365 Fixes for "WIMBoot" extraction mode (Windows only):
367 When not using the WOF driver, extraction no longer fails if the
368 disk containing the WIM file has too many partitions.
370 When matching patterns in [PrepopulateList], all hard links of
371 each file are now considered.
373 The system registry files are now automatically treated as being
374 in [PrepopulateList].
376 Added a hack to try to work around an intermittent bug in
377 Microsoft's WOF (Windows Overlay Filesystem) driver.
380 Made more improvements to the XPRESS, LZX, and LZMS compressors.
382 A number of improvements to the Windows port:
384 Fixes for setting short filenames.
386 Faster "WIMBoot" extraction.
388 Updated and slimmed down the dependent DLLs.
390 ACL inheritence bits are now restored.
392 Mandatory integrity labels are now backed up and restored.
394 Added a workaround for an issue where in rare cases, wimlib could create
395 a compressed data stream that could not be read correctly by Windows
396 after an extraction in "WIMBoot" mode.
399 Added file count progress data for
400 WIMLIB_PROGRESS_MSG_EXTRACT_FILE_STRUCTURE and
401 WIMLIB_PROGRESS_MSG_EXTRACT_METADATA.
403 Added support for testing file exclusions via the user-provided
406 Some documentation improvements.
408 Made some clarifications to the license text in the COPYING file.
411 Made more improvements to the XPRESS, LZX, and LZMS compressors.
413 The default compression mode for wimcapture is now LZX compression in
414 its default mode, which is the same as '--compress=maximum'.
416 You can now specify an optional integer compression level to the
417 '--compress' option; e.g. '--compress=lzx:75'.
419 Made a minor change to the LZMS compressor and decompressor to fix an
420 incompatibility with the Microsoft implementation. In the unlikely
421 event that you created an LZMS-compressed WIM with wimlib v1.7.0 or
422 earlier and a checksum error is reported when extracting files from it
423 with wimlib v1.7.1, decompress it with v1.7.0 then compress it with
426 Added 'verify' subcommand to wimlib-imagex.
428 Notable library changes:
430 Custom compressor parameters have been removed from the library
431 in favor of the simpler level-based API.
433 Decompressor parameters have been removed entirely.
435 Library users can now specify a custom file for warning and
436 error messages to be sent to, rather than the default of
439 New progress messages:
440 WIMLIB_PROGRESS_MSG_EXTRACT_FILE_STRUCTURE,
441 WIMLIB_PROGRESS_MSG_EXTRACT_METADATA.
443 New function: wimlib_verify_wim().
446 Improved compression, decompression, and extraction performance.
448 Improved compatibility with version 3584 WIM / ESD files:
449 - Add support for reading and writing multiple solid blocks per
450 archive, which WIMGAPI/DISM can create when appending an image.
451 - Correctly create solid blocks larger than 4 GiB.
453 'add' commands passed to wimupdate will now replace existing
454 nondirectory files by default. Use the --no-replace option to get the
457 The license for the library now contains an exception that allows using
458 it under the LGPL. See the COPYING file for details.
460 In reparse-point fixup mode (the default for capture), symbolic links
461 and junctions that point outside the tree being captured are no longer
462 excluded from capture.
464 Added support for "WIMBoot" capture and extraction. See the
465 documentation for the new '--wimboot' option to wimcapture and wimapply
466 for more information.
468 On UNIX-like systems, you can now backup and restore device nodes, named
469 pipes, and sockets. In addition, 32-bit user and group IDs are now
472 The way that UNIX data is stored in WIM files has been changed. If you
473 captured any WIMs with the --unix-data option, to upgrade them you'll
474 need to apply them with --unix-data using wimlib-imagex v1.6.2, then
475 re-capture them with --unix-data using this version.
477 wimlib now understands tagged metadata items, such as object IDs, that
478 can be stored in WIM directory entries.
480 Removed the --hardlink and --symlink options to wimapply, since I don't
481 think they are too useful and they got in the way of improving the code.
483 WIMs will now retain their GUIDs when rebuilt (e.g. with wimoptimize).
485 The 'mkwinpeimg' script now supports writing the ISO image to standard
488 The <ARCH> element in WIM XML data is now exported correctly.
490 On Windows, sparse file attributes are no longer set on extracted files.
491 Oddly enough, this actually saves disk space in some cases.
493 On UNIX, configuring with --disable-xattr or --enable-xattr is no longer
494 supported. Mounting WIM images now always requires extended attribute
495 support. Use --without-fuse to disable support for mounting WIM images;
496 this will also disable the need for extended attribute support.
498 Configuring with --enable-ssse3-sha1 now works correctly.
500 The shared library version has been bumped up. The main
501 incompatibilities are:
503 - WIMLIB_COMPRESSION_TYPE_XPRESS is now 1 and
504 WIMLIB_COMPRESSION_TYPE_LZX is now 2 (so it's the same as
507 - User-provided progress functions are now registered using a
508 separate function, wimlib_register_progress_function(). The
509 'progress_func' argument to many functions no longer exists.
511 - The return value from user-provided progress functions is now
514 - A context argument has been added to the prototype of
515 user-provided progress functions.
517 - 'struct wimlib_capture_config' has been removed. The library
518 now takes the path to the configuration file directly. This
519 affects wimlib_add_image(), wimlib_add_image_multisource(),
520 and wimlib_update_image(). However, a NULL value passed in
521 the argument retains the same meaning.
523 - Removed deprecated functions: some (de)compression functions,
524 wimlib_extract_files(), and wimlib_print_metadata().
526 - Removed extraction flags: WIMLIB_EXTRACT_FLAG_HARDLINK,
527 WIMLIB_EXTRACT_FLAG_SYMLINK, WIMLIB_EXTRACT_FLAG_FILE_ORDER,
528 and WIMLIB_EXTRACT_FLAG_SEQUENTIAL.
530 - Removed some progress messages:
531 WIMLIB_PROGRESS_MSG_APPLY_TIMESTAMPS,
532 WIMLIB_PROGRESS_MSG_EXTRACT_DIR_STRUCTURE_BEGIN,
533 WIMLIB_PROGRESS_MSG_EXTRACT_DIR_STRUCTURE_END. Numbering
536 - Removed some error codes. Numbering stays the same.
538 - Replaced WIMLIB_UNMOUNT_FLAG_LAZY with
539 WIMLIB_UNMOUNT_FLAG_FORCE.
541 - WIM paths passed to progress functions now have a leading
545 Case-insensitive comparisons of strings (e.g. filenames) containing
546 UTF-16 codepoints above 32767 are now done correctly.
548 Fixed build failure on Mac OS X.
550 wimunmount now provides the '--new-image' option to cause changes to a
551 read-write mounted image to be committed as a new image rather than as
552 an update of the mounted image. (The corresponding new library flag is
553 WIMLIB_UNMOUNT_FLAG_NEW_IMAGE.)
555 The LZMS ("recovery") compression chunk size, or "dictionary size", may
556 now be up to 1 GiB (1,073,741,824 bytes).
558 The performance of LZX ("maximum") and LZMS ("recovery") compression
559 with large chunk sizes has been slightly improved.
562 Stored files with size exactly 4 GiB (4,294,967,296 bytes) are now
563 decompressed correctly.
565 Fixed a bug in the LZX compressor introduced in v1.5.3. The bug
566 occurred in an unlikely case, and due to validity checks it did not
567 affect successfully created archives.
569 Fixed a minor compatibility issue with the LZMS compressor and
570 decompressor. This is *not* the default compression type and was only
571 introduced in v1.6.0. In the unlikely event that you created an
572 LZMS-compressed WIM with v1.6.0 and a checksum error is reported when
573 applying it with v1.6.1, decompress it with v1.6.0 then compress it with
576 Memory usage for LZMS and LZX compression has been decreased.
578 wimextract now allows wildcard characters in paths specified on the
579 command line. Also, the '--strict-wildcards' option has been removed
580 and replaced with the inverse option '--nullglob'. See the
581 documentation for wimextract for more details and changes.
583 The wimlib_extract_files() function is now considered deprecated in
584 favor of wimlib_extract_paths().
586 Fixed more permissions problems when extracting files on Windows.
588 A new '--no-attributes' option has been added to wimapply and
589 wimextract. The library flag is WIMLIB_EXTRACT_FLAG_NO_ATTRIBUTES.
591 The default chunk size is now set correctly when changing the
592 compression type of a WIM, for example with 'wimoptimize'.
594 The '--metadata' option to wiminfo has been replaced with the
595 '--detailed' option to wimdir.
597 In relevant wimlib-imagex commands, '--solid' may now be used as an
598 alias for '--pack-streams'.
601 Support for extracting and updating the new version 3584 WIMs has been
602 added. These WIMs typically pack many streams ("files") together into a
603 single compressed resource, thereby saving space. This degrades the
604 performance of random access (such as that which occurs on a mounted
605 image), but optimizations have been implemented for extraction. These
606 new WIM files also typically use a new compression format (LZMS), which
607 is similar to LZMA and can offer a better compression ratio than LZX.
608 These new WIM files can be created using `wimcapture' with
609 the '--compress=lzms --pack-streams' options. Note: this new WIM format
610 is used by the Windows 8 web downloader, but important segments of the
611 raw '.esd' files are encrypted, so wimlib will not be able to extract
612 such files until they are first decrypted.
614 wimlib now supports extracting files and directories from a WIM image
615 based on a "listfile" that itself contains the list of paths to extract.
616 For `wimextract', the syntax is to specify @LISTFILE instead of a PATH,
617 and for the library itself, the new APIs are wimlib_extract_pathlist()
618 and wimlib_extract_paths(). Path globs containing wildcard characters
621 For searching WIM files, wimlib now has configurable case sensitivity.
622 The default on Windows is still case-insensitive and the default on
623 UNIX-like systems is still case-sensitive, but this can be overridden
624 on either platform through flags to wimlib_global_init(). For
625 `wimlib-imagex', the environmental variable WIMLIB_IMAGEX_IGNORE_CASE
626 can be set to 1 or 0 for case-insensitive or case-sensitive behavior,
629 Support for compression chunk sizes greater than the default of 32768
630 bytes has been added. A larger chunk size typically results in a better
631 compression ratio. However, the MS implementation is seemingly not
632 compatible with all chunk sizes, especially for LZX compression, so the
633 defaults remain unchanged, with the exception of the new LZMS-compressed
634 WIMs, which use a larger chunk size by default.
636 The compression/decompression API exported by wimlib has been changed.
637 Now one set of functions handles all supported compression formats.
639 `wimcapture' and `wimappend' will now display the progress of scanning
640 the directory tree to capture, in addition to the progress of writing
641 data to the WIM. The '--verbose' option no longer does anything. The
642 library API change for this is the addition of several members to
643 `struct wimlib_progress_info_scan' available to progress callbacks.
645 `mkwinpeimg' now correctly handles the '--start-script' option when the
646 start script is not in the working directory.
648 Sequential extraction, previously requested by using
649 WIMLIB_EXTRACT_FLAG_SEQUENTIAL, is now the default.
650 WIMLIB_EXTRACT_FLAG_FILE_ORDER can be used to get the old default
651 behavior (extract in file order).
654 The new LZX compressor added in v1.5.2 has been improved and is now
655 enabled by default, except when `wimcapture' or `wimappend' is run
656 *without* the '--compress' option, in which case the faster LZX
657 compressor is used (the same as before). This behavior is reasonably
658 consistent with ImageX which actually uses "fast" (XPRESS) compression
659 by default. In those cases, use '--compress=maximum' to explicitly
660 capture a WIM image using the new (slower but better) LZX compressor.
662 The '--compress-slow' option still exists to `wimlib-imagex optimize',
663 but its new behavior is to tweak the new LZX compressor even more to
664 produce an even better compression ratio at the cost of more time spent
667 `wimlib-imagex optimize' now supports the '--compress=TYPE' option,
668 which recompresses the WIM file using the specified compression TYPE.
669 The new library API function used for this is
670 wimlib_set_output_compression_type().
672 Added the wimlib_get_xml_data() function to allow library clients to
673 easily retrieve the raw XML data from a WIM file if needed.
675 Fixed a bug that could cause an error code to be incorrectly returned
676 when writing XML data containing a <WINDOWS> element.
678 Mounted WIM images will now correctly show the default file stream even
679 if appears in the alternate data stream entries of the corresponding WIM
683 Added a new experimental LZX compressor which can be enabled by passing
684 '--compress-slow' to `wimlib-imagex capture' or `wimlib-imagex
685 optimize'. (The latter is only applicable if the WIM is already
686 LZX-compressed and the '--recompress' option is also given.) The
687 experimental compressor is much slower but compresses the data slightly
688 more --- currently usually to within a fraction of a percent of the
689 results from WIMGAPI/ImageX.
691 A workaround has been added for compatibility with versions of WinPE
692 that interpret alternate data stream entries in the boot WIM
695 An alignment bug that caused a crash in the LZX decompressor on some
698 wimlib now attempts to clear the WIM_HDR_FLAG_WRITE_IN_PROGRESS flag in
699 the WIM header when restoring the previous state of a WIM it failed to
702 Added a workaround to avoid an access denied error on Windows when
703 replacing a WIM file that another process has opened.
706 wimlib can now open WinPE WIMs from WAIK v2.1, which had a quirk that
707 needed to be handled.
709 A bug in the interpretation of negative IMAGE indices in the
710 --update-of=[WIMFILE:]IMAGE option to `wimlib-imagex capture' and
711 `wimlib-imagex append' has been fixed.
713 A workaround has been added to successfully apply security descriptors
714 with empty DACLs when the NTFS-3g apply mode is being used with NTFS-3g
715 2013.1.13 or earlier.
717 `wimlib-imagex capture' can now accept the '--delta-from' option
721 Added support for "pipable" WIMs. Pipable WIMs allow capturing images
722 to standard output and applying images from standard input, but they are
723 not compatible with Microsoft's software and are not created by default.
724 See the documentation for --pipable flag of `wimlib-imagex capture' for
727 To better support incremental backups, added support for declaring an
728 image as a modified form of another image. See the documentation for
729 the '--update-of' option of `wimlib-imagex append' and `wimlib-imagex
732 Added supported for "delta" WIMs. See the documentation for the
733 '--delta-from' option of `wimlib-imagex capture'.
735 The library support for managing split WIMs has been changed to support
736 other arrangements, such as delta WIMs, and be easier to use. This
737 change is visible in `wimlib-imagex', which also can now accept the
738 '--ref' option multiple times, and also now supports "delta" WIMs as
741 wimlib now preserves WIM integrity tables by default, even if
742 WIMLIB_WRITE_FLAG_CHECK_INTEGRITY is not specified. This changes the
743 behavior of `wimlib-imagex' whenever the WIM being operated on contains
744 an integrity table and the '--check' option is not specified.
746 `wimlib-imagex capture' now creates LZX-compressed WIMs by default
747 (when --compress is not specified). This provides the best compression
748 ratio by default, which is usually what is desired, at a cost of some
751 `wimlib-imagex' now supports being invoked as wimCOMMAND, where COMMAND
752 is the command as in `wimlib-imagex COMMAND'; for example, it can be
753 invoked as `wimapply' as an alternative to `wimlib-imagex apply'. The
754 appropriate hard links are created in UNIX installations of
755 `wimlib-imagex', while for the Windows distribution of `wimlib-imagex',
756 batch files that emulate this behavior are generated.
758 Security descriptors are now extracted correctly on Windows.
760 Fixed archiving DOS names in NTFS-3g capture mode.
762 The extraction code has been rewritten and it will now be easier to
763 support new features on all supported backends (currently Win32, UNIX,
764 and NTFS-3g). For example, hard-linked extraction mode (--hardlink) is
765 now supported on all backends, not just UNIX.
767 `mkwinpeimg' now supports grabbing files from the WAIK supplement rather
768 than the WAIK itself.
770 wimlib_global_init() now, by default, attempts to acquire additional
771 privileges on Windows, so library clients need not do this.
773 This update bumps the shared library version number up to 9, since it is
774 not binary compatibible with previous releases.
777 Fixed bug in `wimlib-imagex export' that made it impossible to export an
778 image from a WIM that is readonly at the filesystem level.
780 Return error code rather than segfaulting when trying to list files from
781 a non-first part of a split WIM.
783 Joining a WIM will now preserve the RP_FIX and READONLY flags.
786 On Windows, paths given to wimlib-imagex are now treated case
789 Improved behavior regarding invalid filenames; in particular, on
790 Windows, wimlib-imagex will, when extracting, now omit (with an option
791 to override this default) filenames differing only in case, or filenames
792 containing characters not valid on Windows.
794 On Windows, wimlib now supports capturing and extracting long paths
795 (longer than the so-called MAX_PATH).
797 On Windows, `wimlib-imagex update' now acquires proper privileges when
798 running as an Administrator.
800 `wimlib-imagex update' will now complain if no image is specified when
801 trying to update a multi-image WIM.
803 `wimlib-imagex update' now supports specifying a single update command
804 directly on the command line using the --command option.
806 wimlib-imagex will now choose different units for progress messages,
807 depending on the amount of data that needs to be processed.
809 `wimlib-imagex append' will now generate a unique WIM image name if no
810 name is specified and the defaulted name already exists in the WIM.
812 wimlib now allows you to create unnamed WIM images, which can then only
813 be referred to by index.
815 wimlib now allows you to explicitly declare you want write access to a
816 WIM by providing the WIMLIB_OPEN_FLAG_WRITE_ACCESS flag to
819 wimlib now respects the WIM_HDR_FLAG_READONLY flag when set in the WIM
822 Progress callbacks have been added to wimlib's wimlib_update_image()
825 Added wimlib_get_wim_info(), wimlib_set_wim_info(),
826 wimlib_iterate_dir_tree(), and wimlib_iterate_lookup_table() functions
829 NTFS-3g capture now only warns about two conditions previously treated
832 Fixed a couple issues with using wimlib-imagex on UDF filesystems on
835 wimlib now correctly detects and returns an error when reading a WIM
836 image with a cyclic directory structure. (Fun fact: such a WIM will
837 crash Microsoft's software.)
840 Added new "extract" and "update" subcommands to wimlib-imagex, along
841 with associated APIs in the library. These commands are intended mainly
842 for Windows use but can be used on UNIX as well.
844 Many documentation improvements.
846 Fixed a bug in the Windows build where relative symbolic links were not
847 captured in reparse-point fixup mode.
849 Fixed a bug in the Windows build where file handles were left open to
850 the WIM file, causing `wimlib_imagex optimize' to fail in some cases.
852 Fixed a bug in the Windows build of wimlib-imagex where globbing
853 split-WIM parts could cause the program to crash.
855 Fixed a bug where the creation time of WIM images would be shown instead
856 of the last modification time.
858 With the Windows build it is now possible to restore a WIM containing
859 symbolic links as a non-Administrator; however you will receive warnings
860 about not being able to extract the symbolic links.
863 Capturing a WIM image should now be significantly faster in most cases
864 due to improved use of the operating system's cache and avoiding reading
865 files twice whenever possible.
867 The Windows build should now work on Windows XP.
869 The Windows build now supports capturing and restoring hidden,
870 compressed, sparse, and encrypted files.
872 The Windows build now supports capturing and applying WIM images from
873 filesystems other than NTFS (with some reduced functionality).
875 The Windows build now extracts short names correctly.
877 Added support for "reparse-point" fixups (i.e. fixing up of symbolic
878 links). See docs for --rpfix and --norpfix flags of `wimlib-imagex
879 capture' and `wimlib-imagex apply'.
881 The performance of splitting and joining WIMs should be slightly
884 The LZX and XPRESS compression and decompression functions are now
885 exported from the library.
888 Improvements and bugfixes for the Windows build.
890 Added --strict-acls options.
892 Fixed the way that wimlib determines the order of images in the WIM.
895 Since wimlib can now be used on Windows, wimlib's implementation of
896 ImageX has been renamed to wimlib-imagex to avoid confusion with
897 Microsoft's implementation of ImageX, which would have the same file
898 name ("imagex.exe"). If you really don't like this you can pass the
899 --with-imagex-progname option to `configure' to choose a different name,
900 or even simply rename the binary yourself (but the former way will
901 configure the man pages to use the chosen name).
903 Various bugs fixed in the Windows build. Mainly to do with capturing
904 and restoring alternate data streams correctly in weird cases, and
905 requesting the correct privileges when opening files. Also added the
906 --noacls options to wimlib-imagex capture, append, and apply.
908 Windows build again: FindFirstStreamW() and FindNextStreamW() are now
909 dynamically loaded, so this may make the library compatible with Windows
910 XP (however, there may still be other problems).
913 Added experimental support for native Windows builds. Binaries can be
914 downloaded from the SourceForge page.
916 --source-list option added to `imagex capture' and `imagex append'.
918 Better support for different character encodings.
921 Storing UNIX file owners, groups, and modes in WIM images is now
922 possible using `imagex capture' with the --unix-data flag.
924 Minor bug fixes and documentation fixes.
927 NTFS capture: Fixed capturing duplicate reparse points.
929 NTFS capture: Capture first unnamed stream if there are more than one
930 (print warning instead of error).
932 Allow multiple test cases to execute concurrently (e.g. make -j2 check).
935 Added --arch switch to mkwinpeimg script to support getting AMD64 WinPE
938 Update to work with ntfs-3g version 2013.1.13.
941 Fixed truncating file to shorter but non-zero length on read-write
944 Various code cleanups and minor documentation fixes.
947 LZX and XPRESS decompression have received some additional optimizations
948 and should now be even faster. (Although, they were already pretty
949 fast--- much faster than typical I/O speeds.)
951 Fixed a bug introduced in v1.2.1 that would cause a directory tree
952 containing hard links to be captured incorrectly in some cases.
955 By default, unmounting a read-write mounted WIM with 'imagex unmount
956 --commit' will now change the WIM in-place without needing to write the
957 entire WIM again. Use 'imagex unmount --commit --rebuild' to get the
960 'imagex unmount' no longer has a hard-coded limit of 10 minutes to wait
961 for a response from the daemon servicing the mounted WIM. Instead,
962 every second 'imagex unmount' will check if the daemon is still alive,
963 and keep waiting if so, otherwise terminate with an error.
965 'imagex unmount --commit' on a read-write mounted WIM will now print
966 progress information regarding the writing of new or modified streams
967 the WIM, just like when capturing or appending a WIM.
969 A small change has been made to XPRESS compression and it should improve
970 the compression ratio slightly.
972 A change was made that may improve performance slightly when applying a
973 WIM image to a NTFS volume.
975 Microsoft has managed to introduce even more bugs into their software,
976 and now the WIMs for Windows 8 have incorrect (too low) reference counts
977 for some streams. This is unsafe because such streams can be removed
978 when they are in actuality still referenced in the WIM (perhaps by a
979 different image). wimlib will now work around this problem by fixing
980 the stream reference counts. This is only done when wimlib_delete_image() is
981 called ('imagex delete') or when wimlib_mount_image() is called with
982 WIMLIB_MOUNT_FLAG_READWRITE ('imagex mountrw'). Please note that this
983 requires reading the metadata for all images in the WIM, so this will
984 make these operations noticably slower on WIMs with multiple images.
986 Various other bugfixes.
989 Appending images to a WIM is now be done by default without re-building
990 the whole WIM. Use the --rebuild flag to get the old behavior (which
991 was to re-build the entire WIM when a new image is appended).
993 A new command `imagex optimize' is now available to manually re-build a
994 WIM that has wasted space due to repeated appends.
996 Progress information has been improved, and now arbitrary callback
997 functions can be used to show the progress of a WIM operation.
999 A possible bug with changing the bootable image of a WIM was fixed.
1001 Some advisory locking is now done to prevent two processes from
1002 modifying a WIM at the same time (but only in some cases). For example,
1003 you cannot mount two images from a WIM read-write at the same time.
1005 Some functions have been reorganized:
1006 * wimlib_mount() renamed to wimlib_mount_image().
1007 * wimlib_unmount() renamed to wimlib_unmount_image().
1008 * wimlib_overwrite_xml_and_header() removed as
1009 wimlib_overwrite() suffices now.
1010 * wimlib_apply_image_to_ntfs_volume() removed as
1011 wimlib_extract_image() suffices now.
1012 * wimlib_add_image_from_ntfs_volume() removed as
1013 * wimlib_add_image() suffices now.
1015 Previously, the soname of libwim.so has been 0.0.0, despite many
1016 interface changes. The soname is now updated to 1.0.0 and will now be
1017 updated each release.
1020 Resources will now be compressed using multiple threads by default.
1021 (This applies to `imagex capture', `imagex append', and `imagex
1024 Some performance improvements in mounted WIMs.
1026 More progress information is shown when capturing a WIM.
1029 Lots of minor fixes, code cleanups, and some documentation updates.
1030 Nothing in particular is really noteworthy.
1033 LZX and XPRESS compression improvements.
1035 Fixed calculation of Directory Count, File Count, Total Bytes, and Hard
1036 Link Bytes of the WIM.
1039 Fixed bug when capturing NTFS file with multiple named data streams.
1041 Internally, we are now using inode structures, even though these don't
1042 appear literally in the WIM file. This simplifies some of the code
1043 (mainly for WIM mounting) and likely fixed a few problems, although it
1047 Fixed problem when exporting images from XPRESS to LZX compressed WIM or
1051 Enough changes to call it version 1.0.0!
1053 Capturing a WIM directly from a NTFS volume, and applying a WIM directly
1054 to a NTFS volume, is now supported.
1056 Hard links and symbolic links have much improved support. They are
1057 supported for WIM capture, WIM application, and mounted WIMs (you can
1058 even make them on read-write mounted WIMs).
1060 Alternate data streams are now supported on mounted WIMs through an
1061 xattr or a Windows-style stream interface. Also they are supported when
1062 capturing a WIM from NTFS or applying a WIM to NTFS.
1064 Split WIMs are better supported. You may now apply an image directly
1065 from a split WIM, mount an image from a split WIM read-only, or export
1066 an image from a split WIM.
1068 Using a capture configuration file is now supported (but not fully yet).
1070 SHA1 message digests are checked in more places, so we can make sure
1071 applied and captured data is correct.
1073 Man pages have been updated and consolidated.
1076 Fixed segfault when unmounting read-only WIM.
1079 Support for joining and splitting WIMs.
1080 Also, security data is now preserved by default.
1083 Can now build with older gcc and system headers, like on CentOS 5.
1086 Fixed bug that made it impossible to overwrite files in read-write
1090 Write byte-order mark before WIM XML data. (imagex.exe requires this to
git://wimlib.net / wimlib / blob