2 Fixed a bug that was causing the LZMS decompressor to be miscompiled
3 with GCC 7 (this broke extracting "solid" archives).
5 The Windows 10 Recycle Bin directory (\$RECYCLE.BIN) has been added to
6 the default exclusion list.
8 Added a '--quiet' option to wimlib-imagex.
10 The 'mkwinpeimg' script now also looks for the syslinux BIOS modules in
11 the directory /usr/lib/syslinux/modules/bios.
13 Files with timestamps before the year 1970 are now extracted correctly
14 to UNIX-style filesystems, are displayed correctly by
15 'wimdir --detailed', and show up correctly in mounted WIM images.
17 Files with timestamps after the year 2038 are now displayed correctly by
18 the 32-bit Windows build of wimlib.
21 Fixed a data corruption bug (incorrect compression) when storing an
22 already highly-compressed file in an LZX-compressed WIM with a chunk
23 size greater than or equal to 64K. Note that this is not the default
24 setting and such WIMs are not supported by Microsoft's WIM software, so
25 only users who used the --chunk-size option to wimlib-imagex or the
26 wimlib_set_output_chunk_size() API function may have been affected.
27 This bug was introduced in wimlib v1.10.0. See
28 https://wimlib.net/forums/viewtopic.php?f=1&t=300 for more details.
30 On all platforms, sparse files are now extracted as sparse.
32 Sparse files captured from UNIX-style filesystems are now marked as
33 sparse in the resulting WIM image.
35 Added support for storing Linux-style extended attributes in WIM images.
36 When the --unix-data option is used on Linux, wimlib-imagex now captures
37 and applies extended attributes, in addition to the already-supported
38 standard UNIX file permissions (owner/group/mode) and special files.
40 --delta-from is now supported by wimappend. (Previously it was only
41 supported by wimcapture.)
43 On Windows, improved the way in which files deduplicated with Windows'
44 Data Deduplication feature are captured.
46 The development files needed to link with wimlib using Visual Studio are
47 now included in the Windows release archives.
49 wimlib.h can now be included by Visual Studio without errors.
51 The example programs can now be compiled in C++ mode, and they also now
54 Updated 'mkwinpeimg' to work correctly on images that have a "windows"
55 (lower case) directory rather than a "Windows" (upper case) directory.
57 Fixed configuring with --enable-ssse3-sha1 from release tarball
58 (the file nasm_lt.sh was missing).
60 Made some documentation improvements.
63 The LZX compression ratio has been slightly improved. The default mode,
64 LZX level 50, is now almost as good as the old LZX level 100, while
65 being nearly the same speed as before.
67 Decompression performance has been slightly improved.
69 Filenames are now always listed in NTFS collation order.
71 On UNIX-like systems, wimlib can now process Windows filenames that are
72 not valid Unicode due to the presence of unpaired surrogates.
74 On UNIX-like systems, wimlib now always assumes UTF-8 encoding with the
75 addition of surrogate codepoints. Consequently, the environmental
76 variable WIMLIB_IMAGEX_USE_UTF8 and the flag
77 WIMLIB_INIT_FLAG_ASSUME_UTF8 no longer have any effect.
79 wimlib no longer depends on iconv.
81 Reduced memory usage slightly.
83 When a WIM image is applied in NTFS-3G mode, security descriptors are
84 now created in NTFS v3.0 format when supported by the volume.
86 Workarounds for bugs in libntfs-3g version 2013.1.13 and earlier have
87 been removed. Users are advised to upgrade to a later version of
90 On Windows, wimlib now supports case-sensitive filename extraction when
91 supported by the underlying operating system and filesystem (operating
92 system support requires a registry setting).
95 On UNIX, wimlib can now overwrite readonly files when extracting.
97 On Windows, fixed a bug where wimlib could leave a null DACL (a.k.a. "no
98 NTFS permissions") set on some existing directories after extraction.
100 On Windows, when applying a WIM image in "WIMBoot mode" when the WOF
101 driver is not loaded, wimlib can now correctly register a new WIM file
102 with the target volume when the target volume previously had had WIM
105 Added a new testing program.
107 Clarified the main license text and updated public domain dedications
108 for certain files to be more thorough.
111 Object IDs are now saved and restored on Windows and in NTFS-3G mode.
113 Reduced memory usage when exporting large numbers of WIM images.
115 Non UTF-8 locales are now detected correctly.
117 Addressed compiler warnings and enabled "silent" make rules by default.
119 Windows-specific updates:
120 Fixed a bug where duplicate backslashes could be generated in
121 link targets when extracting symbolic links and junctions.
123 Fixed a bug where the .cmd shortcuts for wimlib-imagex wouldn't
124 work if their full path contained a space.
126 Fixed bugs related to scanning SMB filesystems.
128 Added warning message about known issue with WindowsApps folder.
130 Added instructions for building from source on Windows.
132 VSS support is no longer marked "experimental".
134 Added missing license file for libdivsufsort-lite.
137 Added experimental support for Windows VSS (Volume Shadow Copy Service).
138 The new '--snapshot' argument to 'wimcapture' makes wimlib automatically
139 create and use a temporary VSS snapshot when capturing a WIM image.
141 Implemented setting of Windows-specific XML information, such as
142 architecture, system root, and version details. This information is now
143 automatically set in newly captured WIM images, when appropriate.
145 Improved performance of directory tree scans on Windows.
147 On Windows, to improve capture performance, wimlib now sometimes opens
148 files by inode number rather than by path. This is enabled for
149 wimcapture and wimappend, but for now other applications have to opt-in.
151 The progress messages printed by wimlib-imagex while writing WIM files
152 have been slightly tweaked.
154 Progress information for directory tree scans now counts all hard links.
155 Also, on Windows "\\?\" is no longer stripped from the current path.
157 Added a new '--image-property' option to 'wimcapture', 'wimappend', and
158 'wiminfo'. This option lets you assign values to elements in a WIM
159 file's XML document by name.
161 The wimlib_get_image_property() and wimlib_set_image_property() API
162 functions now support numerically indexed elements.
164 Fixed a bug where, on Windows, wimlib would change the security
165 descriptor of the target directory of an extraction even when the
166 '--no-acls' option was specified.
169 Fixed a bug with libntfs-3g extraction present since v1.8.1. Sometimes,
170 some Microsoft software would not correctly recognize data in the
171 resulting filesystem.
173 Made some small improvements to the compression algorithms:
174 LZX compression ratio was slightly improved.
175 XPRESS compression ratio and speed was slightly improved.
176 LZMS compression speed was slightly improved.
178 Improved handling of WIM XML data. wimlib no longer drops unrecognized
179 elements when exporting images. In addition, two API functions were
180 added for better access to elements in the XML document:
181 wimlib_get_image_property() and wimlib_set_image_property().
183 Added support for (unsafe) in-place compaction of WIM files.
185 Improved performance of image export by reusing metadata resources
186 instead of always rebuilding and recompressing them.
188 Improved performance of wimlib_update_image() by delaying the update to
189 the WIM's XML document until a write is requested.
191 On Windows, the target of an extraction may now be a reparse point
192 (which will be dereferenced).
194 On Windows, wimlib now correctly restores non-Microsoft reparse points.
195 However, this remains broken in NTFS-3g mode due to a libntfs-3g bug.
197 On Windows, wimlib now has improved performance when archiving files
198 from a filesystem backed by a WIM (a "WIMBoot" setup).
200 Several improvements to System Compression (compact mode) support:
202 wof.sys (or wofadk.sys) is now automatically attached to the
203 target volume if needed.
205 Compact-mode extractions now work correctly with wofadk.sys on
206 older versions of Windows.
208 For compatibility with the Windows bootloader, the requested
209 compression format now is overridden on certain files.
211 Other minor bugfixes.
214 This release primarily contains various minor bug fixes and
215 improvements, including:
217 Improved handling of deep directory structures.
219 Fixed a bug where on 32-bit systems, the library could enter an
220 infinite loop if a WIM file was malformed in a specific way.
222 Added a workaround for a case where libntfs-3g may report
223 duplicate streams in an NTFS file.
225 Windows symbolic links and junctions in mounted WIM images are
226 now automatically rewritten to be valid in the mounted location.
228 Reparse point fixes: correctly handle the "ReparseReserved"
229 field, and correctly handle "empty" (data-less) reparse points.
231 On Windows, wimlib now acquires SeManageVolumePrivilege, which
232 is needed to create externally backed files using the
235 Improved validation of filenames.
237 Improved LZMS decompression speed.
239 The configure script now honors alternate pkg-config settings.
241 Links have been updated to point to the new website.
243 In addition, experimental support has been added for compressing
244 extracted files using System Compression on Windows 10. This
245 functionality is available through the new '--compact' option to
246 'wimapply' and 'wimextract' as well as new library flags.
249 Fixed a bug in the LZX decompressor: malicious input data could cause
250 out of bounds writes to memory (since wimlib v1.2.2).
252 The output of the 'wiminfo' command now consolidates various boolean
253 flags (such as "Relative path junction") into a single line.
255 A file can now have both an unnamed data stream ("file contents") and a
256 reparse point stream. Such files can exist as a result of the use of
257 certain Windows features, such as offline storage, including "OneDrive".
258 wimlib will now store and restore both streams on Windows as well as in
259 NTFS-3g mode. Microsoft's WIMGAPI also has this behavior.
261 On Windows, named data streams of encrypted files are no longer stored
262 twice in WIM archives.
264 On Windows, named data streams are now correctly extracted to existing
265 "readonly" directories. Before, an error would be reported.
267 On Windows, it is now possible to do a "WIMBoot mode" extraction with
268 non-standalone WIMs such as delta WIMs.
270 On Windows, when doing an extraction in "WIMBoot mode", files larger
271 than 4 gigabytes are now never extracted as externally backed. This
272 works around a bug in Microsoft's "WOF" driver.
274 The '--enable-verify-compression' configure option has been removed. If
275 you want to verify a WIM file, use the 'wimverify' program.
277 The way the "file count", "directory count", "total bytes", and "hard
278 link bytes" image statistics (stored in the WIM XML data) is calculated
279 has been slightly changed.
281 In mounted WIM images, the disk usage provided for each file (st_blocks)
282 is now the compressed size rather than the uncompressed size.
284 The performance of the NTFS-3g and Windows capture modes has been
287 On UNIX-like systems, symbolic links whose targets contain the backslash
288 character are now handled correctly (losslessly).
291 Improved the LZX compressor. It is now 15-20% faster than before and
292 provides a slightly better compression ratio.
294 Improved the LZMS compressor. It now provides a compression ratio
295 slightly better than WIMGAPI while still being faster and using slightly
298 The compression chunk size in solid resources, e.g. when capturing or
299 exporting a WIM file using the '--solid' option, now defaults to 64 MiB
300 (67108864 bytes) instead of 32 MiB (33554432 bytes). This provides a
301 better compression ratio and is the same value that WIMGAPI uses. The
302 memory usage is less than 50% higher than wimlib v1.7.4 and is slightly
303 lower than WIMGAPI's memory usage, but if it is too much, it is still
304 possible to choose a lower value, e.g. with the '--solid-chunk-size'
305 option to wimlib-imagex.
307 The '--chunk-size' and '--solid-chunk-size' options to wimlib-imagex now
308 accept the 'K', 'M', and 'G' suffixes.
310 Files are now sorted by name extension when creating a solid WIM file.
312 Fixed various issues related to capture/apply of EFS-encrypted files on
315 The file list printed by 'wimdir' is now sorted by the platform-specific
316 case sensitivity setting, rather than always case sensitively. This
317 also affects the library function wimlib_iterate_dir_tree().
319 On Windows, some error and warning messages have been improved.
322 The Windows binary distribution no longer contains third party DLLs.
323 These dependencies are instead compiled directly into the libwim DLL.
325 Added more fixes for wimlib on non-x86 architectures such as ARM.
327 Extracting files to a Windows PE in-memory filesystem no longer fails if
328 the target files do not yet exist.
330 Improved the performance of XPRESS compression and LZMS decompression.
332 Enabled SSSE3 accelerated SHA-1 computation in x86_64 Windows builds.
333 It will automatically be faster on newer Intel and AMD processors.
335 Removed the --with-imagex-progname and --enable-more-assertions
339 Fix for very slow export from solid WIM / ESD files.
341 Fix for LZX and LZMS algorithms on non-x86 architectures, such as ARM.
343 New progress message: WIMLIB_PROGRESS_MSG_HANDLE_ERROR. Applications
344 may use this to treat some types of errors as non-fatal.
346 The library now permits making in-memory changes to a WIMStruct backed
347 by a read-only WIM file.
349 Fixes for "WIMBoot" extraction mode (Windows only):
351 When not using the WOF driver, extraction no longer fails if the
352 disk containing the WIM file has too many partitions.
354 When matching patterns in [PrepopulateList], all hard links of
355 each file are now considered.
357 The system registry files are now automatically treated as being
358 in [PrepopulateList].
360 Added a hack to try to work around an intermittent bug in
361 Microsoft's WOF (Windows Overlay Filesystem) driver.
364 Made more improvements to the XPRESS, LZX, and LZMS compressors.
366 A number of improvements to the Windows port:
368 Fixes for setting short filenames.
370 Faster "WIMBoot" extraction.
372 Updated and slimmed down the dependent DLLs.
374 ACL inheritence bits are now restored.
376 Mandatory integrity labels are now backed up and restored.
378 Added a workaround for an issue where in rare cases, wimlib could create
379 a compressed data stream that could not be read correctly by Windows
380 after an extraction in "WIMBoot" mode.
383 Added file count progress data for
384 WIMLIB_PROGRESS_MSG_EXTRACT_FILE_STRUCTURE and
385 WIMLIB_PROGRESS_MSG_EXTRACT_METADATA.
387 Added support for testing file exclusions via the user-provided
390 Some documentation improvements.
392 Made some clarifications to the license text in the COPYING file.
395 Made more improvements to the XPRESS, LZX, and LZMS compressors.
397 The default compression mode for wimcapture is now LZX compression in
398 its default mode, which is the same as '--compress=maximum'.
400 You can now specify an optional integer compression level to the
401 '--compress' option; e.g. '--compress=lzx:75'.
403 Made a minor change to the LZMS compressor and decompressor to fix an
404 incompatibility with the Microsoft implementation. In the unlikely
405 event that you created an LZMS-compressed WIM with wimlib v1.7.0 or
406 earlier and a checksum error is reported when extracting files from it
407 with wimlib v1.7.1, decompress it with v1.7.0 then compress it with
410 Added 'verify' subcommand to wimlib-imagex.
412 Notable library changes:
414 Custom compressor parameters have been removed from the library
415 in favor of the simpler level-based API.
417 Decompressor parameters have been removed entirely.
419 Library users can now specify a custom file for warning and
420 error messages to be sent to, rather than the default of
423 New progress messages:
424 WIMLIB_PROGRESS_MSG_EXTRACT_FILE_STRUCTURE,
425 WIMLIB_PROGRESS_MSG_EXTRACT_METADATA.
427 New function: wimlib_verify_wim().
430 Improved compression, decompression, and extraction performance.
432 Improved compatibility with version 3584 WIM / ESD files:
433 - Add support for reading and writing multiple solid blocks per
434 archive, which WIMGAPI/DISM can create when appending an image.
435 - Correctly create solid blocks larger than 4 GiB.
437 'add' commands passed to wimupdate will now replace existing
438 nondirectory files by default. Use the --no-replace option to get the
441 The license for the library now contains an exception that allows using
442 it under the LGPL. See the COPYING file for details.
444 In reparse-point fixup mode (the default for capture), symbolic links
445 and junctions that point outside the tree being captured are no longer
446 excluded from capture.
448 Added support for "WIMBoot" capture and extraction. See the
449 documentation for the new '--wimboot' option to wimcapture and wimapply
450 for more information.
452 On UNIX-like systems, you can now backup and restore device nodes, named
453 pipes, and sockets. In addition, 32-bit user and group IDs are now
456 The way that UNIX data is stored in WIM files has been changed. If you
457 captured any WIMs with the --unix-data option, to upgrade them you'll
458 need to apply them with --unix-data using wimlib-imagex v1.6.2, then
459 re-capture them with --unix-data using this version.
461 wimlib now understands tagged metadata items, such as object IDs, that
462 can be stored in WIM directory entries.
464 Removed the --hardlink and --symlink options to wimapply, since I don't
465 think they are too useful and they got in the way of improving the code.
467 WIMs will now retain their GUIDs when rebuilt (e.g. with wimoptimize).
469 The 'mkwinpeimg' script now supports writing the ISO image to standard
472 The <ARCH> element in WIM XML data is now exported correctly.
474 On Windows, sparse file attributes are no longer set on extracted files.
475 Oddly enough, this actually saves disk space in some cases.
477 On UNIX, configuring with --disable-xattr or --enable-xattr is no longer
478 supported. Mounting WIM images now always requires extended attribute
479 support. Use --without-fuse to disable support for mounting WIM images;
480 this will also disable the need for extended attribute support.
482 Configuring with --enable-ssse3-sha1 now works correctly.
484 The shared library version has been bumped up. The main
485 incompatibilities are:
487 - WIMLIB_COMPRESSION_TYPE_XPRESS is now 1 and
488 WIMLIB_COMPRESSION_TYPE_LZX is now 2 (so it's the same as
491 - User-provided progress functions are now registered using a
492 separate function, wimlib_register_progress_function(). The
493 'progress_func' argument to many functions no longer exists.
495 - The return value from user-provided progress functions is now
498 - A context argument has been added to the prototype of
499 user-provided progress functions.
501 - 'struct wimlib_capture_config' has been removed. The library
502 now takes the path to the configuration file directly. This
503 affects wimlib_add_image(), wimlib_add_image_multisource(),
504 and wimlib_update_image(). However, a NULL value passed in
505 the argument retains the same meaning.
507 - Removed deprecated functions: some (de)compression functions,
508 wimlib_extract_files(), and wimlib_print_metadata().
510 - Removed extraction flags: WIMLIB_EXTRACT_FLAG_HARDLINK,
511 WIMLIB_EXTRACT_FLAG_SYMLINK, WIMLIB_EXTRACT_FLAG_FILE_ORDER,
512 and WIMLIB_EXTRACT_FLAG_SEQUENTIAL.
514 - Removed some progress messages:
515 WIMLIB_PROGRESS_MSG_APPLY_TIMESTAMPS,
516 WIMLIB_PROGRESS_MSG_EXTRACT_DIR_STRUCTURE_BEGIN,
517 WIMLIB_PROGRESS_MSG_EXTRACT_DIR_STRUCTURE_END. Numbering
520 - Removed some error codes. Numbering stays the same.
522 - Replaced WIMLIB_UNMOUNT_FLAG_LAZY with
523 WIMLIB_UNMOUNT_FLAG_FORCE.
525 - WIM paths passed to progress functions now have a leading
529 Case-insensitive comparisons of strings (e.g. filenames) containing
530 UTF-16 codepoints above 32767 are now done correctly.
532 Fixed build failure on Mac OS X.
534 wimunmount now provides the '--new-image' option to cause changes to a
535 read-write mounted image to be committed as a new image rather than as
536 an update of the mounted image. (The corresponding new library flag is
537 WIMLIB_UNMOUNT_FLAG_NEW_IMAGE.)
539 The LZMS ("recovery") compression chunk size, or "dictionary size", may
540 now be up to 1 GiB (1,073,741,824 bytes).
542 The performance of LZX ("maximum") and LZMS ("recovery") compression
543 with large chunk sizes has been slightly improved.
546 Stored files with size exactly 4 GiB (4,294,967,296 bytes) are now
547 decompressed correctly.
549 Fixed a bug in the LZX compressor introduced in v1.5.3. The bug
550 occurred in an unlikely case, and due to validity checks it did not
551 affect successfully created archives.
553 Fixed a minor compatibility issue with the LZMS compressor and
554 decompressor. This is *not* the default compression type and was only
555 introduced in v1.6.0. In the unlikely event that you created an
556 LZMS-compressed WIM with v1.6.0 and a checksum error is reported when
557 applying it with v1.6.1, decompress it with v1.6.0 then compress it with
560 Memory usage for LZMS and LZX compression has been decreased.
562 wimextract now allows wildcard characters in paths specified on the
563 command line. Also, the '--strict-wildcards' option has been removed
564 and replaced with the inverse option '--nullglob'. See the
565 documentation for wimextract for more details and changes.
567 The wimlib_extract_files() function is now considered deprecated in
568 favor of wimlib_extract_paths().
570 Fixed more permissions problems when extracting files on Windows.
572 A new '--no-attributes' option has been added to wimapply and
573 wimextract. The library flag is WIMLIB_EXTRACT_FLAG_NO_ATTRIBUTES.
575 The default chunk size is now set correctly when changing the
576 compression type of a WIM, for example with 'wimoptimize'.
578 The '--metadata' option to wiminfo has been replaced with the
579 '--detailed' option to wimdir.
581 In relevant wimlib-imagex commands, '--solid' may now be used as an
582 alias for '--pack-streams'.
585 Support for extracting and updating the new version 3584 WIMs has been
586 added. These WIMs typically pack many streams ("files") together into a
587 single compressed resource, thereby saving space. This degrades the
588 performance of random access (such as that which occurs on a mounted
589 image), but optimizations have been implemented for extraction. These
590 new WIM files also typically use a new compression format (LZMS), which
591 is similar to LZMA and can offer a better compression ratio than LZX.
592 These new WIM files can be created using `wimcapture' with
593 the '--compress=lzms --pack-streams' options. Note: this new WIM format
594 is used by the Windows 8 web downloader, but important segments of the
595 raw '.esd' files are encrypted, so wimlib will not be able to extract
596 such files until they are first decrypted.
598 wimlib now supports extracting files and directories from a WIM image
599 based on a "listfile" that itself contains the list of paths to extract.
600 For `wimextract', the syntax is to specify @LISTFILE instead of a PATH,
601 and for the library itself, the new APIs are wimlib_extract_pathlist()
602 and wimlib_extract_paths(). Path globs containing wildcard characters
605 For searching WIM files, wimlib now has configurable case sensitivity.
606 The default on Windows is still case-insensitive and the default on
607 UNIX-like systems is still case-sensitive, but this can be overridden
608 on either platform through flags to wimlib_global_init(). For
609 `wimlib-imagex', the environmental variable WIMLIB_IMAGEX_IGNORE_CASE
610 can be set to 1 or 0 for case-insensitive or case-sensitive behavior,
613 Support for compression chunk sizes greater than the default of 32768
614 bytes has been added. A larger chunk size typically results in a better
615 compression ratio. However, the MS implementation is seemingly not
616 compatible with all chunk sizes, especially for LZX compression, so the
617 defaults remain unchanged, with the exception of the new LZMS-compressed
618 WIMs, which use a larger chunk size by default.
620 The compression/decompression API exported by wimlib has been changed.
621 Now one set of functions handles all supported compression formats.
623 `wimcapture' and `wimappend' will now display the progress of scanning
624 the directory tree to capture, in addition to the progress of writing
625 data to the WIM. The '--verbose' option no longer does anything. The
626 library API change for this is the addition of several members to
627 `struct wimlib_progress_info_scan' available to progress callbacks.
629 `mkwinpeimg' now correctly handles the '--start-script' option when the
630 start script is not in the working directory.
632 Sequential extraction, previously requested by using
633 WIMLIB_EXTRACT_FLAG_SEQUENTIAL, is now the default.
634 WIMLIB_EXTRACT_FLAG_FILE_ORDER can be used to get the old default
635 behavior (extract in file order).
638 The new LZX compressor added in v1.5.2 has been improved and is now
639 enabled by default, except when `wimcapture' or `wimappend' is run
640 *without* the '--compress' option, in which case the faster LZX
641 compressor is used (the same as before). This behavior is reasonably
642 consistent with ImageX which actually uses "fast" (XPRESS) compression
643 by default. In those cases, use '--compress=maximum' to explicitly
644 capture a WIM image using the new (slower but better) LZX compressor.
646 The '--compress-slow' option still exists to `wimlib-imagex optimize',
647 but its new behavior is to tweak the new LZX compressor even more to
648 produce an even better compression ratio at the cost of more time spent
651 `wimlib-imagex optimize' now supports the '--compress=TYPE' option,
652 which recompresses the WIM file using the specified compression TYPE.
653 The new library API function used for this is
654 wimlib_set_output_compression_type().
656 Added the wimlib_get_xml_data() function to allow library clients to
657 easily retrieve the raw XML data from a WIM file if needed.
659 Fixed a bug that could cause an error code to be incorrectly returned
660 when writing XML data containing a <WINDOWS> element.
662 Mounted WIM images will now correctly show the default file stream even
663 if appears in the alternate data stream entries of the corresponding WIM
667 Added a new experimental LZX compressor which can be enabled by passing
668 '--compress-slow' to `wimlib-imagex capture' or `wimlib-imagex
669 optimize'. (The latter is only applicable if the WIM is already
670 LZX-compressed and the '--recompress' option is also given.) The
671 experimental compressor is much slower but compresses the data slightly
672 more --- currently usually to within a fraction of a percent of the
673 results from WIMGAPI/ImageX.
675 A workaround has been added for compatibility with versions of WinPE
676 that interpret alternate data stream entries in the boot WIM
679 An alignment bug that caused a crash in the LZX decompressor on some
682 wimlib now attempts to clear the WIM_HDR_FLAG_WRITE_IN_PROGRESS flag in
683 the WIM header when restoring the previous state of a WIM it failed to
686 Added a workaround to avoid an access denied error on Windows when
687 replacing a WIM file that another process has opened.
690 wimlib can now open WinPE WIMs from WAIK v2.1, which had a quirk that
691 needed to be handled.
693 A bug in the interpretation of negative IMAGE indices in the
694 --update-of=[WIMFILE:]IMAGE option to `wimlib-imagex capture' and
695 `wimlib-imagex append' has been fixed.
697 A workaround has been added to successfully apply security descriptors
698 with empty DACLs when the NTFS-3g apply mode is being used with NTFS-3g
699 2013.1.13 or earlier.
701 `wimlib-imagex capture' can now accept the '--delta-from' option
705 Added support for "pipable" WIMs. Pipable WIMs allow capturing images
706 to standard output and applying images from standard input, but they are
707 not compatible with Microsoft's software and are not created by default.
708 See the documentation for --pipable flag of `wimlib-imagex capture' for
711 To better support incremental backups, added support for declaring an
712 image as a modified form of another image. See the documentation for
713 the '--update-of' option of `wimlib-imagex append' and `wimlib-imagex
716 Added supported for "delta" WIMs. See the documentation for the
717 '--delta-from' option of `wimlib-imagex capture'.
719 The library support for managing split WIMs has been changed to support
720 other arrangements, such as delta WIMs, and be easier to use. This
721 change is visible in `wimlib-imagex', which also can now accept the
722 '--ref' option multiple times, and also now supports "delta" WIMs as
725 wimlib now preserves WIM integrity tables by default, even if
726 WIMLIB_WRITE_FLAG_CHECK_INTEGRITY is not specified. This changes the
727 behavior of `wimlib-imagex' whenever the WIM being operated on contains
728 an integrity table and the '--check' option is not specified.
730 `wimlib-imagex capture' now creates LZX-compressed WIMs by default
731 (when --compress is not specified). This provides the best compression
732 ratio by default, which is usually what is desired, at a cost of some
735 `wimlib-imagex' now supports being invoked as wimCOMMAND, where COMMAND
736 is the command as in `wimlib-imagex COMMAND'; for example, it can be
737 invoked as `wimapply' as an alternative to `wimlib-imagex apply'. The
738 appropriate hard links are created in UNIX installations of
739 `wimlib-imagex', while for the Windows distribution of `wimlib-imagex',
740 batch files that emulate this behavior are generated.
742 Security descriptors are now extracted correctly on Windows.
744 Fixed archiving DOS names in NTFS-3g capture mode.
746 The extraction code has been rewritten and it will now be easier to
747 support new features on all supported backends (currently Win32, UNIX,
748 and NTFS-3g). For example, hard-linked extraction mode (--hardlink) is
749 now supported on all backends, not just UNIX.
751 `mkwinpeimg' now supports grabbing files from the WAIK supplement rather
752 than the WAIK itself.
754 wimlib_global_init() now, by default, attempts to acquire additional
755 privileges on Windows, so library clients need not do this.
757 This update bumps the shared library version number up to 9, since it is
758 not binary compatibible with previous releases.
761 Fixed bug in `wimlib-imagex export' that made it impossible to export an
762 image from a WIM that is readonly at the filesystem level.
764 Return error code rather than segfaulting when trying to list files from
765 a non-first part of a split WIM.
767 Joining a WIM will now preserve the RP_FIX and READONLY flags.
770 On Windows, paths given to wimlib-imagex are now treated case
773 Improved behavior regarding invalid filenames; in particular, on
774 Windows, wimlib-imagex will, when extracting, now omit (with an option
775 to override this default) filenames differing only in case, or filenames
776 containing characters not valid on Windows.
778 On Windows, wimlib now supports capturing and extracting long paths
779 (longer than the so-called MAX_PATH).
781 On Windows, `wimlib-imagex update' now acquires proper privileges when
782 running as an Administrator.
784 `wimlib-imagex update' will now complain if no image is specified when
785 trying to update a multi-image WIM.
787 `wimlib-imagex update' now supports specifying a single update command
788 directly on the command line using the --command option.
790 wimlib-imagex will now choose different units for progress messages,
791 depending on the amount of data that needs to be processed.
793 `wimlib-imagex append' will now generate a unique WIM image name if no
794 name is specified and the defaulted name already exists in the WIM.
796 wimlib now allows you to create unnamed WIM images, which can then only
797 be referred to by index.
799 wimlib now allows you to explicitly declare you want write access to a
800 WIM by providing the WIMLIB_OPEN_FLAG_WRITE_ACCESS flag to
803 wimlib now respects the WIM_HDR_FLAG_READONLY flag when set in the WIM
806 Progress callbacks have been added to wimlib's wimlib_update_image()
809 Added wimlib_get_wim_info(), wimlib_set_wim_info(),
810 wimlib_iterate_dir_tree(), and wimlib_iterate_lookup_table() functions
813 NTFS-3g capture now only warns about two conditions previously treated
816 Fixed a couple issues with using wimlib-imagex on UDF filesystems on
819 wimlib now correctly detects and returns an error when reading a WIM
820 image with a cyclic directory structure. (Fun fact: such a WIM will
821 crash Microsoft's software.)
824 Added new "extract" and "update" subcommands to wimlib-imagex, along
825 with associated APIs in the library. These commands are intended mainly
826 for Windows use but can be used on UNIX as well.
828 Many documentation improvements.
830 Fixed a bug in the Windows build where relative symbolic links were not
831 captured in reparse-point fixup mode.
833 Fixed a bug in the Windows build where file handles were left open to
834 the WIM file, causing `wimlib_imagex optimize' to fail in some cases.
836 Fixed a bug in the Windows build of wimlib-imagex where globbing
837 split-WIM parts could cause the program to crash.
839 Fixed a bug where the creation time of WIM images would be shown instead
840 of the last modification time.
842 With the Windows build it is now possible to restore a WIM containing
843 symbolic links as a non-Administrator; however you will receive warnings
844 about not being able to extract the symbolic links.
847 Capturing a WIM image should now be significantly faster in most cases
848 due to improved use of the operating system's cache and avoiding reading
849 files twice whenever possible.
851 The Windows build should now work on Windows XP.
853 The Windows build now supports capturing and restoring hidden,
854 compressed, sparse, and encrypted files.
856 The Windows build now supports capturing and applying WIM images from
857 filesystems other than NTFS (with some reduced functionality).
859 The Windows build now extracts short names correctly.
861 Added support for "reparse-point" fixups (i.e. fixing up of symbolic
862 links). See docs for --rpfix and --norpfix flags of `wimlib-imagex
863 capture' and `wimlib-imagex apply'.
865 The performance of splitting and joining WIMs should be slightly
868 The LZX and XPRESS compression and decompression functions are now
869 exported from the library.
872 Improvements and bugfixes for the Windows build.
874 Added --strict-acls options.
876 Fixed the way that wimlib determines the order of images in the WIM.
879 Since wimlib can now be used on Windows, wimlib's implementation of
880 ImageX has been renamed to wimlib-imagex to avoid confusion with
881 Microsoft's implementation of ImageX, which would have the same file
882 name ("imagex.exe"). If you really don't like this you can pass the
883 --with-imagex-progname option to `configure' to choose a different name,
884 or even simply rename the binary yourself (but the former way will
885 configure the man pages to use the chosen name).
887 Various bugs fixed in the Windows build. Mainly to do with capturing
888 and restoring alternate data streams correctly in weird cases, and
889 requesting the correct privileges when opening files. Also added the
890 --noacls options to wimlib-imagex capture, append, and apply.
892 Windows build again: FindFirstStreamW() and FindNextStreamW() are now
893 dynamically loaded, so this may make the library compatible with Windows
894 XP (however, there may still be other problems).
897 Added experimental support for native Windows builds. Binaries can be
898 downloaded from the SourceForge page.
900 --source-list option added to `imagex capture' and `imagex append'.
902 Better support for different character encodings.
905 Storing UNIX file owners, groups, and modes in WIM images is now
906 possible using `imagex capture' with the --unix-data flag.
908 Minor bug fixes and documentation fixes.
911 NTFS capture: Fixed capturing duplicate reparse points.
913 NTFS capture: Capture first unnamed stream if there are more than one
914 (print warning instead of error).
916 Allow multiple test cases to execute concurrently (e.g. make -j2 check).
919 Added --arch switch to mkwinpeimg script to support getting AMD64 WinPE
922 Update to work with ntfs-3g version 2013.1.13.
925 Fixed truncating file to shorter but non-zero length on read-write
928 Various code cleanups and minor documentation fixes.
931 LZX and XPRESS decompression have received some additional optimizations
932 and should now be even faster. (Although, they were already pretty
933 fast--- much faster than typical I/O speeds.)
935 Fixed a bug introduced in v1.2.1 that would cause a directory tree
936 containing hard links to be captured incorrectly in some cases.
939 By default, unmounting a read-write mounted WIM with 'imagex unmount
940 --commit' will now change the WIM in-place without needing to write the
941 entire WIM again. Use 'imagex unmount --commit --rebuild' to get the
944 'imagex unmount' no longer has a hard-coded limit of 10 minutes to wait
945 for a response from the daemon servicing the mounted WIM. Instead,
946 every second 'imagex unmount' will check if the daemon is still alive,
947 and keep waiting if so, otherwise terminate with an error.
949 'imagex unmount --commit' on a read-write mounted WIM will now print
950 progress information regarding the writing of new or modified streams
951 the WIM, just like when capturing or appending a WIM.
953 A small change has been made to XPRESS compression and it should improve
954 the compression ratio slightly.
956 A change was made that may improve performance slightly when applying a
957 WIM image to a NTFS volume.
959 Microsoft has managed to introduce even more bugs into their software,
960 and now the WIMs for Windows 8 have incorrect (too low) reference counts
961 for some streams. This is unsafe because such streams can be removed
962 when they are in actuality still referenced in the WIM (perhaps by a
963 different image). wimlib will now work around this problem by fixing
964 the stream reference counts. This is only done when wimlib_delete_image() is
965 called ('imagex delete') or when wimlib_mount_image() is called with
966 WIMLIB_MOUNT_FLAG_READWRITE ('imagex mountrw'). Please note that this
967 requires reading the metadata for all images in the WIM, so this will
968 make these operations noticably slower on WIMs with multiple images.
970 Various other bugfixes.
973 Appending images to a WIM is now be done by default without re-building
974 the whole WIM. Use the --rebuild flag to get the old behavior (which
975 was to re-build the entire WIM when a new image is appended).
977 A new command `imagex optimize' is now available to manually re-build a
978 WIM that has wasted space due to repeated appends.
980 Progress information has been improved, and now arbitrary callback
981 functions can be used to show the progress of a WIM operation.
983 A possible bug with changing the bootable image of a WIM was fixed.
985 Some advisory locking is now done to prevent two processes from
986 modifying a WIM at the same time (but only in some cases). For example,
987 you cannot mount two images from a WIM read-write at the same time.
989 Some functions have been reorganized:
990 * wimlib_mount() renamed to wimlib_mount_image().
991 * wimlib_unmount() renamed to wimlib_unmount_image().
992 * wimlib_overwrite_xml_and_header() removed as
993 wimlib_overwrite() suffices now.
994 * wimlib_apply_image_to_ntfs_volume() removed as
995 wimlib_extract_image() suffices now.
996 * wimlib_add_image_from_ntfs_volume() removed as
997 * wimlib_add_image() suffices now.
999 Previously, the soname of libwim.so has been 0.0.0, despite many
1000 interface changes. The soname is now updated to 1.0.0 and will now be
1001 updated each release.
1004 Resources will now be compressed using multiple threads by default.
1005 (This applies to `imagex capture', `imagex append', and `imagex
1008 Some performance improvements in mounted WIMs.
1010 More progress information is shown when capturing a WIM.
1013 Lots of minor fixes, code cleanups, and some documentation updates.
1014 Nothing in particular is really noteworthy.
1017 LZX and XPRESS compression improvements.
1019 Fixed calculation of Directory Count, File Count, Total Bytes, and Hard
1020 Link Bytes of the WIM.
1023 Fixed bug when capturing NTFS file with multiple named data streams.
1025 Internally, we are now using inode structures, even though these don't
1026 appear literally in the WIM file. This simplifies some of the code
1027 (mainly for WIM mounting) and likely fixed a few problems, although it
1031 Fixed problem when exporting images from XPRESS to LZX compressed WIM or
1035 Enough changes to call it version 1.0.0!
1037 Capturing a WIM directly from a NTFS volume, and applying a WIM directly
1038 to a NTFS volume, is now supported.
1040 Hard links and symbolic links have much improved support. They are
1041 supported for WIM capture, WIM application, and mounted WIMs (you can
1042 even make them on read-write mounted WIMs).
1044 Alternate data streams are now supported on mounted WIMs through an
1045 xattr or a Windows-style stream interface. Also they are supported when
1046 capturing a WIM from NTFS or applying a WIM to NTFS.
1048 Split WIMs are better supported. You may now apply an image directly
1049 from a split WIM, mount an image from a split WIM read-only, or export
1050 an image from a split WIM.
1052 Using a capture configuration file is now supported (but not fully yet).
1054 SHA1 message digests are checked in more places, so we can make sure
1055 applied and captured data is correct.
1057 Man pages have been updated and consolidated.
1060 Fixed segfault when unmounting read-only WIM.
1063 Support for joining and splitting WIMs.
1064 Also, security data is now preserved by default.
1067 Can now build with older gcc and system headers, like on CentOS 5.
1070 Fixed bug that made it impossible to overwrite files in read-write
1074 Write byte-order mark before WIM XML data. (imagex.exe requires this to
git://wimlib.net / wimlib / blob