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