2 Fixed a data corruption bug (incorrect compression) when storing an
3 already highly-compressed file in an LZX-compressed WIM with a chunk
4 size greater than or equal to 64K. Note that this is not the default
5 setting and such WIMs are not supported by Microsoft's WIM software, so
6 only users who used the --chunk-size option to wimlib-imagex or the
7 wimlib_set_output_chunk_size() API function may have been affected.
8 This bug was introduced in wimlib v1.10.0. See
9 https://wimlib.net/forums/viewtopic.php?f=1&t=300 for more details.
11 On all platforms, sparse files are now extracted as sparse.
13 Sparse files captured from UNIX-style filesystems are now marked as
14 sparse in the resulting WIM image.
16 Added support for storing Linux-style extended attributes in WIM images.
17 When the --unix-data option is used on Linux, wimlib-imagex now captures
18 and applies extended attributes, in addition to the already-supported
19 standard UNIX file permissions (owner/group/mode) and special files.
21 --delta-from is now supported by wimappend. (Previously it was only
22 supported by wimcapture.)
24 On Windows, improved the way in which files deduplicated with Windows'
25 Data Deduplication feature are captured.
27 The development files needed to link with wimlib using Visual Studio are
28 now included in the Windows release archives.
30 wimlib.h can now be included by Visual Studio without errors.
32 The example programs can now be compiled in C++ mode, and they also now
35 Updated 'mkwinpeimg' to work correctly on images that have a "windows"
36 (lower case) directory rather than a "Windows" (upper case) directory.
38 Fixed configuring with --enable-ssse3-sha1 from release tarball
39 (the file nasm_lt.sh was missing).
41 Made some documentation improvements.
44 The LZX compression ratio has been slightly improved. The default mode,
45 LZX level 50, is now almost as good as the old LZX level 100, while
46 being nearly the same speed as before.
48 Decompression performance has been slightly improved.
50 Filenames are now always listed in NTFS collation order.
52 On UNIX-like systems, wimlib can now process Windows filenames that are
53 not valid Unicode due to the presence of unpaired surrogates.
55 On UNIX-like systems, wimlib now always assumes UTF-8 encoding with the
56 addition of surrogate codepoints. Consequently, the environmental
57 variable WIMLIB_IMAGEX_USE_UTF8 and the flag
58 WIMLIB_INIT_FLAG_ASSUME_UTF8 no longer have any effect.
60 wimlib no longer depends on iconv.
62 Reduced memory usage slightly.
64 When a WIM image is applied in NTFS-3G mode, security descriptors are
65 now created in NTFS v3.0 format when supported by the volume.
67 Workarounds for bugs in libntfs-3g version 2013.1.13 and earlier have
68 been removed. Users are advised to upgrade to a later version of
71 On Windows, wimlib now supports case-sensitive filename extraction when
72 supported by the underlying operating system and filesystem (operating
73 system support requires a registry setting).
76 On UNIX, wimlib can now overwrite readonly files when extracting.
78 On Windows, fixed a bug where wimlib could leave a null DACL (a.k.a. "no
79 NTFS permissions") set on some existing directories after extraction.
81 On Windows, when applying a WIM image in "WIMBoot mode" when the WOF
82 driver is not loaded, wimlib can now correctly register a new WIM file
83 with the target volume when the target volume previously had had WIM
86 Added a new testing program.
88 Clarified the main license text and updated public domain dedications
89 for certain files to be more thorough.
92 Object IDs are now saved and restored on Windows and in NTFS-3G mode.
94 Reduced memory usage when exporting large numbers of WIM images.
96 Non UTF-8 locales are now detected correctly.
98 Addressed compiler warnings and enabled "silent" make rules by default.
100 Windows-specific updates:
101 Fixed a bug where duplicate backslashes could be generated in
102 link targets when extracting symbolic links and junctions.
104 Fixed a bug where the .cmd shortcuts for wimlib-imagex wouldn't
105 work if their full path contained a space.
107 Fixed bugs related to scanning SMB filesystems.
109 Added warning message about known issue with WindowsApps folder.
111 Added instructions for building from source on Windows.
113 VSS support is no longer marked "experimental".
115 Added missing license file for libdivsufsort-lite.
118 Added experimental support for Windows VSS (Volume Shadow Copy Service).
119 The new '--snapshot' argument to 'wimcapture' makes wimlib automatically
120 create and use a temporary VSS snapshot when capturing a WIM image.
122 Implemented setting of Windows-specific XML information, such as
123 architecture, system root, and version details. This information is now
124 automatically set in newly captured WIM images, when appropriate.
126 Improved performance of directory tree scans on Windows.
128 On Windows, to improve capture performance, wimlib now sometimes opens
129 files by inode number rather than by path. This is enabled for
130 wimcapture and wimappend, but for now other applications have to opt-in.
132 The progress messages printed by wimlib-imagex while writing WIM files
133 have been slightly tweaked.
135 Progress information for directory tree scans now counts all hard links.
136 Also, on Windows "\\?\" is no longer stripped from the current path.
138 Added a new '--image-property' option to 'wimcapture', 'wimappend', and
139 'wiminfo'. This option lets you assign values to elements in a WIM
140 file's XML document by name.
142 The wimlib_get_image_property() and wimlib_set_image_property() API
143 functions now support numerically indexed elements.
145 Fixed a bug where, on Windows, wimlib would change the security
146 descriptor of the target directory of an extraction even when the
147 '--no-acls' option was specified.
150 Fixed a bug with libntfs-3g extraction present since v1.8.1. Sometimes,
151 some Microsoft software would not correctly recognize data in the
152 resulting filesystem.
154 Made some small improvements to the compression algorithms:
155 LZX compression ratio was slightly improved.
156 XPRESS compression ratio and speed was slightly improved.
157 LZMS compression speed was slightly improved.
159 Improved handling of WIM XML data. wimlib no longer drops unrecognized
160 elements when exporting images. In addition, two API functions were
161 added for better access to elements in the XML document:
162 wimlib_get_image_property() and wimlib_set_image_property().
164 Added support for (unsafe) in-place compaction of WIM files.
166 Improved performance of image export by reusing metadata resources
167 instead of always rebuilding and recompressing them.
169 Improved performance of wimlib_update_image() by delaying the update to
170 the WIM's XML document until a write is requested.
172 On Windows, the target of an extraction may now be a reparse point
173 (which will be dereferenced).
175 On Windows, wimlib now correctly restores non-Microsoft reparse points.
176 However, this remains broken in NTFS-3g mode due to a libntfs-3g bug.
178 On Windows, wimlib now has improved performance when archiving files
179 from a filesystem backed by a WIM (a "WIMBoot" setup).
181 Several improvements to System Compression (compact mode) support:
183 wof.sys (or wofadk.sys) is now automatically attached to the
184 target volume if needed.
186 Compact-mode extractions now work correctly with wofadk.sys on
187 older versions of Windows.
189 For compatibility with the Windows bootloader, the requested
190 compression format now is overridden on certain files.
192 Other minor bugfixes.
195 This release primarily contains various minor bug fixes and
196 improvements, including:
198 Improved handling of deep directory structures.
200 Fixed a bug where on 32-bit systems, the library could enter an
201 infinite loop if a WIM file was malformed in a specific way.
203 Added a workaround for a case where libntfs-3g may report
204 duplicate streams in an NTFS file.
206 Windows symbolic links and junctions in mounted WIM images are
207 now automatically rewritten to be valid in the mounted location.
209 Reparse point fixes: correctly handle the "ReparseReserved"
210 field, and correctly handle "empty" (data-less) reparse points.
212 On Windows, wimlib now acquires SeManageVolumePrivilege, which
213 is needed to create externally backed files using the
216 Improved validation of filenames.
218 Improved LZMS decompression speed.
220 The configure script now honors alternate pkg-config settings.
222 Links have been updated to point to the new website.
224 In addition, experimental support has been added for compressing
225 extracted files using System Compression on Windows 10. This
226 functionality is available through the new '--compact' option to
227 'wimapply' and 'wimextract' as well as new library flags.
230 Fixed a bug in the LZX decompressor: malicious input data could cause
231 out of bounds writes to memory (since wimlib v1.2.2).
233 The output of the 'wiminfo' command now consolidates various boolean
234 flags (such as "Relative path junction") into a single line.
236 A file can now have both an unnamed data stream ("file contents") and a
237 reparse point stream. Such files can exist as a result of the use of
238 certain Windows features, such as offline storage, including "OneDrive".
239 wimlib will now store and restore both streams on Windows as well as in
240 NTFS-3g mode. Microsoft's WIMGAPI also has this behavior.
242 On Windows, named data streams of encrypted files are no longer stored
243 twice in WIM archives.
245 On Windows, named data streams are now correctly extracted to existing
246 "readonly" directories. Before, an error would be reported.
248 On Windows, it is now possible to do a "WIMBoot mode" extraction with
249 non-standalone WIMs such as delta WIMs.
251 On Windows, when doing an extraction in "WIMBoot mode", files larger
252 than 4 gigabytes are now never extracted as externally backed. This
253 works around a bug in Microsoft's "WOF" driver.
255 The '--enable-verify-compression' configure option has been removed. If
256 you want to verify a WIM file, use the 'wimverify' program.
258 The way the "file count", "directory count", "total bytes", and "hard
259 link bytes" image statistics (stored in the WIM XML data) is calculated
260 has been slightly changed.
262 In mounted WIM images, the disk usage provided for each file (st_blocks)
263 is now the compressed size rather than the uncompressed size.
265 The performance of the NTFS-3g and Windows capture modes has been
268 On UNIX-like systems, symbolic links whose targets contain the backslash
269 character are now handled correctly (losslessly).
272 Improved the LZX compressor. It is now 15-20% faster than before and
273 provides a slightly better compression ratio.
275 Improved the LZMS compressor. It now provides a compression ratio
276 slightly better than WIMGAPI while still being faster and using slightly
279 The compression chunk size in solid resources, e.g. when capturing or
280 exporting a WIM file using the '--solid' option, now defaults to 64 MiB
281 (67108864 bytes) instead of 32 MiB (33554432 bytes). This provides a
282 better compression ratio and is the same value that WIMGAPI uses. The
283 memory usage is less than 50% higher than wimlib v1.7.4 and is slightly
284 lower than WIMGAPI's memory usage, but if it is too much, it is still
285 possible to choose a lower value, e.g. with the '--solid-chunk-size'
286 option to wimlib-imagex.
288 The '--chunk-size' and '--solid-chunk-size' options to wimlib-imagex now
289 accept the 'K', 'M', and 'G' suffixes.
291 Files are now sorted by name extension when creating a solid WIM file.
293 Fixed various issues related to capture/apply of EFS-encrypted files on
296 The file list printed by 'wimdir' is now sorted by the platform-specific
297 case sensitivity setting, rather than always case sensitively. This
298 also affects the library function wimlib_iterate_dir_tree().
300 On Windows, some error and warning messages have been improved.
303 The Windows binary distribution no longer contains third party DLLs.
304 These dependencies are instead compiled directly into the libwim DLL.
306 Added more fixes for wimlib on non-x86 architectures such as ARM.
308 Extracting files to a Windows PE in-memory filesystem no longer fails if
309 the target files do not yet exist.
311 Improved the performance of XPRESS compression and LZMS decompression.
313 Enabled SSSE3 accelerated SHA-1 computation in x86_64 Windows builds.
314 It will automatically be faster on newer Intel and AMD processors.
316 Removed the --with-imagex-progname and --enable-more-assertions
320 Fix for very slow export from solid WIM / ESD files.
322 Fix for LZX and LZMS algorithms on non-x86 architectures, such as ARM.
324 New progress message: WIMLIB_PROGRESS_MSG_HANDLE_ERROR. Applications
325 may use this to treat some types of errors as non-fatal.
327 The library now permits making in-memory changes to a WIMStruct backed
328 by a read-only WIM file.
330 Fixes for "WIMBoot" extraction mode (Windows only):
332 When not using the WOF driver, extraction no longer fails if the
333 disk containing the WIM file has too many partitions.
335 When matching patterns in [PrepopulateList], all hard links of
336 each file are now considered.
338 The system registry files are now automatically treated as being
339 in [PrepopulateList].
341 Added a hack to try to work around an intermittent bug in
342 Microsoft's WOF (Windows Overlay Filesystem) driver.
345 Made more improvements to the XPRESS, LZX, and LZMS compressors.
347 A number of improvements to the Windows port:
349 Fixes for setting short filenames.
351 Faster "WIMBoot" extraction.
353 Updated and slimmed down the dependent DLLs.
355 ACL inheritence bits are now restored.
357 Mandatory integrity labels are now backed up and restored.
359 Added a workaround for an issue where in rare cases, wimlib could create
360 a compressed data stream that could not be read correctly by Windows
361 after an extraction in "WIMBoot" mode.
364 Added file count progress data for
365 WIMLIB_PROGRESS_MSG_EXTRACT_FILE_STRUCTURE and
366 WIMLIB_PROGRESS_MSG_EXTRACT_METADATA.
368 Added support for testing file exclusions via the user-provided
371 Some documentation improvements.
373 Made some clarifications to the license text in the COPYING file.
376 Made more improvements to the XPRESS, LZX, and LZMS compressors.
378 The default compression mode for wimcapture is now LZX compression in
379 its default mode, which is the same as '--compress=maximum'.
381 You can now specify an optional integer compression level to the
382 '--compress' option; e.g. '--compress=lzx:75'.
384 Made a minor change to the LZMS compressor and decompressor to fix an
385 incompatibility with the Microsoft implementation. In the unlikely
386 event that you created an LZMS-compressed WIM with wimlib v1.7.0 or
387 earlier and a checksum error is reported when extracting files from it
388 with wimlib v1.7.1, decompress it with v1.7.0 then compress it with
391 Added 'verify' subcommand to wimlib-imagex.
393 Notable library changes:
395 Custom compressor parameters have been removed from the library
396 in favor of the simpler level-based API.
398 Decompressor parameters have been removed entirely.
400 Library users can now specify a custom file for warning and
401 error messages to be sent to, rather than the default of
404 New progress messages:
405 WIMLIB_PROGRESS_MSG_EXTRACT_FILE_STRUCTURE,
406 WIMLIB_PROGRESS_MSG_EXTRACT_METADATA.
408 New function: wimlib_verify_wim().
411 Improved compression, decompression, and extraction performance.
413 Improved compatibility with version 3584 WIM / ESD files:
414 - Add support for reading and writing multiple solid blocks per
415 archive, which WIMGAPI/DISM can create when appending an image.
416 - Correctly create solid blocks larger than 4 GiB.
418 'add' commands passed to wimupdate will now replace existing
419 nondirectory files by default. Use the --no-replace option to get the
422 The license for the library now contains an exception that allows using
423 it under the LGPL. See the COPYING file for details.
425 In reparse-point fixup mode (the default for capture), symbolic links
426 and junctions that point outside the tree being captured are no longer
427 excluded from capture.
429 Added support for "WIMBoot" capture and extraction. See the
430 documentation for the new '--wimboot' option to wimcapture and wimapply
431 for more information.
433 On UNIX-like systems, you can now backup and restore device nodes, named
434 pipes, and sockets. In addition, 32-bit user and group IDs are now
437 The way that UNIX data is stored in WIM files has been changed. If you
438 captured any WIMs with the --unix-data option, to upgrade them you'll
439 need to apply them with --unix-data using wimlib-imagex v1.6.2, then
440 re-capture them with --unix-data using this version.
442 wimlib now understands tagged metadata items, such as object IDs, that
443 can be stored in WIM directory entries.
445 Removed the --hardlink and --symlink options to wimapply, since I don't
446 think they are too useful and they got in the way of improving the code.
448 WIMs will now retain their GUIDs when rebuilt (e.g. with wimoptimize).
450 The 'mkwinpeimg' script now supports writing the ISO image to standard
453 The <ARCH> element in WIM XML data is now exported correctly.
455 On Windows, sparse file attributes are no longer set on extracted files.
456 Oddly enough, this actually saves disk space in some cases.
458 On UNIX, configuring with --disable-xattr or --enable-xattr is no longer
459 supported. Mounting WIM images now always requires extended attribute
460 support. Use --without-fuse to disable support for mounting WIM images;
461 this will also disable the need for extended attribute support.
463 Configuring with --enable-ssse3-sha1 now works correctly.
465 The shared library version has been bumped up. The main
466 incompatibilities are:
468 - WIMLIB_COMPRESSION_TYPE_XPRESS is now 1 and
469 WIMLIB_COMPRESSION_TYPE_LZX is now 2 (so it's the same as
472 - User-provided progress functions are now registered using a
473 separate function, wimlib_register_progress_function(). The
474 'progress_func' argument to many functions no longer exists.
476 - The return value from user-provided progress functions is now
479 - A context argument has been added to the prototype of
480 user-provided progress functions.
482 - 'struct wimlib_capture_config' has been removed. The library
483 now takes the path to the configuration file directly. This
484 affects wimlib_add_image(), wimlib_add_image_multisource(),
485 and wimlib_update_image(). However, a NULL value passed in
486 the argument retains the same meaning.
488 - Removed deprecated functions: some (de)compression functions,
489 wimlib_extract_files(), and wimlib_print_metadata().
491 - Removed extraction flags: WIMLIB_EXTRACT_FLAG_HARDLINK,
492 WIMLIB_EXTRACT_FLAG_SYMLINK, WIMLIB_EXTRACT_FLAG_FILE_ORDER,
493 and WIMLIB_EXTRACT_FLAG_SEQUENTIAL.
495 - Removed some progress messages:
496 WIMLIB_PROGRESS_MSG_APPLY_TIMESTAMPS,
497 WIMLIB_PROGRESS_MSG_EXTRACT_DIR_STRUCTURE_BEGIN,
498 WIMLIB_PROGRESS_MSG_EXTRACT_DIR_STRUCTURE_END. Numbering
501 - Removed some error codes. Numbering stays the same.
503 - Replaced WIMLIB_UNMOUNT_FLAG_LAZY with
504 WIMLIB_UNMOUNT_FLAG_FORCE.
506 - WIM paths passed to progress functions now have a leading
510 Case-insensitive comparisons of strings (e.g. filenames) containing
511 UTF-16 codepoints above 32767 are now done correctly.
513 Fixed build failure on Mac OS X.
515 wimunmount now provides the '--new-image' option to cause changes to a
516 read-write mounted image to be committed as a new image rather than as
517 an update of the mounted image. (The corresponding new library flag is
518 WIMLIB_UNMOUNT_FLAG_NEW_IMAGE.)
520 The LZMS ("recovery") compression chunk size, or "dictionary size", may
521 now be up to 1 GiB (1,073,741,824 bytes).
523 The performance of LZX ("maximum") and LZMS ("recovery") compression
524 with large chunk sizes has been slightly improved.
527 Stored files with size exactly 4 GiB (4,294,967,296 bytes) are now
528 decompressed correctly.
530 Fixed a bug in the LZX compressor introduced in v1.5.3. The bug
531 occurred in an unlikely case, and due to validity checks it did not
532 affect successfully created archives.
534 Fixed a minor compatibility issue with the LZMS compressor and
535 decompressor. This is *not* the default compression type and was only
536 introduced in v1.6.0. In the unlikely event that you created an
537 LZMS-compressed WIM with v1.6.0 and a checksum error is reported when
538 applying it with v1.6.1, decompress it with v1.6.0 then compress it with
541 Memory usage for LZMS and LZX compression has been decreased.
543 wimextract now allows wildcard characters in paths specified on the
544 command line. Also, the '--strict-wildcards' option has been removed
545 and replaced with the inverse option '--nullglob'. See the
546 documentation for wimextract for more details and changes.
548 The wimlib_extract_files() function is now considered deprecated in
549 favor of wimlib_extract_paths().
551 Fixed more permissions problems when extracting files on Windows.
553 A new '--no-attributes' option has been added to wimapply and
554 wimextract. The library flag is WIMLIB_EXTRACT_FLAG_NO_ATTRIBUTES.
556 The default chunk size is now set correctly when changing the
557 compression type of a WIM, for example with 'wimoptimize'.
559 The '--metadata' option to wiminfo has been replaced with the
560 '--detailed' option to wimdir.
562 In relevant wimlib-imagex commands, '--solid' may now be used as an
563 alias for '--pack-streams'.
566 Support for extracting and updating the new version 3584 WIMs has been
567 added. These WIMs typically pack many streams ("files") together into a
568 single compressed resource, thereby saving space. This degrades the
569 performance of random access (such as that which occurs on a mounted
570 image), but optimizations have been implemented for extraction. These
571 new WIM files also typically use a new compression format (LZMS), which
572 is similar to LZMA and can offer a better compression ratio than LZX.
573 These new WIM files can be created using `wimcapture' with
574 the '--compress=lzms --pack-streams' options. Note: this new WIM format
575 is used by the Windows 8 web downloader, but important segments of the
576 raw '.esd' files are encrypted, so wimlib will not be able to extract
577 such files until they are first decrypted.
579 wimlib now supports extracting files and directories from a WIM image
580 based on a "listfile" that itself contains the list of paths to extract.
581 For `wimextract', the syntax is to specify @LISTFILE instead of a PATH,
582 and for the library itself, the new APIs are wimlib_extract_pathlist()
583 and wimlib_extract_paths(). Path globs containing wildcard characters
586 For searching WIM files, wimlib now has configurable case sensitivity.
587 The default on Windows is still case-insensitive and the default on
588 UNIX-like systems is still case-sensitive, but this can be overridden
589 on either platform through flags to wimlib_global_init(). For
590 `wimlib-imagex', the environmental variable WIMLIB_IMAGEX_IGNORE_CASE
591 can be set to 1 or 0 for case-insensitive or case-sensitive behavior,
594 Support for compression chunk sizes greater than the default of 32768
595 bytes has been added. A larger chunk size typically results in a better
596 compression ratio. However, the MS implementation is seemingly not
597 compatible with all chunk sizes, especially for LZX compression, so the
598 defaults remain unchanged, with the exception of the new LZMS-compressed
599 WIMs, which use a larger chunk size by default.
601 The compression/decompression API exported by wimlib has been changed.
602 Now one set of functions handles all supported compression formats.
604 `wimcapture' and `wimappend' will now display the progress of scanning
605 the directory tree to capture, in addition to the progress of writing
606 data to the WIM. The '--verbose' option no longer does anything. The
607 library API change for this is the addition of several members to
608 `struct wimlib_progress_info_scan' available to progress callbacks.
610 `mkwinpeimg' now correctly handles the '--start-script' option when the
611 start script is not in the working directory.
613 Sequential extraction, previously requested by using
614 WIMLIB_EXTRACT_FLAG_SEQUENTIAL, is now the default.
615 WIMLIB_EXTRACT_FLAG_FILE_ORDER can be used to get the old default
616 behavior (extract in file order).
619 The new LZX compressor added in v1.5.2 has been improved and is now
620 enabled by default, except when `wimcapture' or `wimappend' is run
621 *without* the '--compress' option, in which case the faster LZX
622 compressor is used (the same as before). This behavior is reasonably
623 consistent with ImageX which actually uses "fast" (XPRESS) compression
624 by default. In those cases, use '--compress=maximum' to explicitly
625 capture a WIM image using the new (slower but better) LZX compressor.
627 The '--compress-slow' option still exists to `wimlib-imagex optimize',
628 but its new behavior is to tweak the new LZX compressor even more to
629 produce an even better compression ratio at the cost of more time spent
632 `wimlib-imagex optimize' now supports the '--compress=TYPE' option,
633 which recompresses the WIM file using the specified compression TYPE.
634 The new library API function used for this is
635 wimlib_set_output_compression_type().
637 Added the wimlib_get_xml_data() function to allow library clients to
638 easily retrieve the raw XML data from a WIM file if needed.
640 Fixed a bug that could cause an error code to be incorrectly returned
641 when writing XML data containing a <WINDOWS> element.
643 Mounted WIM images will now correctly show the default file stream even
644 if appears in the alternate data stream entries of the corresponding WIM
648 Added a new experimental LZX compressor which can be enabled by passing
649 '--compress-slow' to `wimlib-imagex capture' or `wimlib-imagex
650 optimize'. (The latter is only applicable if the WIM is already
651 LZX-compressed and the '--recompress' option is also given.) The
652 experimental compressor is much slower but compresses the data slightly
653 more --- currently usually to within a fraction of a percent of the
654 results from WIMGAPI/ImageX.
656 A workaround has been added for compatibility with versions of WinPE
657 that interpret alternate data stream entries in the boot WIM
660 An alignment bug that caused a crash in the LZX decompressor on some
663 wimlib now attempts to clear the WIM_HDR_FLAG_WRITE_IN_PROGRESS flag in
664 the WIM header when restoring the previous state of a WIM it failed to
667 Added a workaround to avoid an access denied error on Windows when
668 replacing a WIM file that another process has opened.
671 wimlib can now open WinPE WIMs from WAIK v2.1, which had a quirk that
672 needed to be handled.
674 A bug in the interpretation of negative IMAGE indices in the
675 --update-of=[WIMFILE:]IMAGE option to `wimlib-imagex capture' and
676 `wimlib-imagex append' has been fixed.
678 A workaround has been added to successfully apply security descriptors
679 with empty DACLs when the NTFS-3g apply mode is being used with NTFS-3g
680 2013.1.13 or earlier.
682 `wimlib-imagex capture' can now accept the '--delta-from' option
686 Added support for "pipable" WIMs. Pipable WIMs allow capturing images
687 to standard output and applying images from standard input, but they are
688 not compatible with Microsoft's software and are not created by default.
689 See the documentation for --pipable flag of `wimlib-imagex capture' for
692 To better support incremental backups, added support for declaring an
693 image as a modified form of another image. See the documentation for
694 the '--update-of' option of `wimlib-imagex append' and `wimlib-imagex
697 Added supported for "delta" WIMs. See the documentation for the
698 '--delta-from' option of `wimlib-imagex capture'.
700 The library support for managing split WIMs has been changed to support
701 other arrangements, such as delta WIMs, and be easier to use. This
702 change is visible in `wimlib-imagex', which also can now accept the
703 '--ref' option multiple times, and also now supports "delta" WIMs as
706 wimlib now preserves WIM integrity tables by default, even if
707 WIMLIB_WRITE_FLAG_CHECK_INTEGRITY is not specified. This changes the
708 behavior of `wimlib-imagex' whenever the WIM being operated on contains
709 an integrity table and the '--check' option is not specified.
711 `wimlib-imagex capture' now creates LZX-compressed WIMs by default
712 (when --compress is not specified). This provides the best compression
713 ratio by default, which is usually what is desired, at a cost of some
716 `wimlib-imagex' now supports being invoked as wimCOMMAND, where COMMAND
717 is the command as in `wimlib-imagex COMMAND'; for example, it can be
718 invoked as `wimapply' as an alternative to `wimlib-imagex apply'. The
719 appropriate hard links are created in UNIX installations of
720 `wimlib-imagex', while for the Windows distribution of `wimlib-imagex',
721 batch files that emulate this behavior are generated.
723 Security descriptors are now extracted correctly on Windows.
725 Fixed archiving DOS names in NTFS-3g capture mode.
727 The extraction code has been rewritten and it will now be easier to
728 support new features on all supported backends (currently Win32, UNIX,
729 and NTFS-3g). For example, hard-linked extraction mode (--hardlink) is
730 now supported on all backends, not just UNIX.
732 `mkwinpeimg' now supports grabbing files from the WAIK supplement rather
733 than the WAIK itself.
735 wimlib_global_init() now, by default, attempts to acquire additional
736 privileges on Windows, so library clients need not do this.
738 This update bumps the shared library version number up to 9, since it is
739 not binary compatibible with previous releases.
742 Fixed bug in `wimlib-imagex export' that made it impossible to export an
743 image from a WIM that is readonly at the filesystem level.
745 Return error code rather than segfaulting when trying to list files from
746 a non-first part of a split WIM.
748 Joining a WIM will now preserve the RP_FIX and READONLY flags.
751 On Windows, paths given to wimlib-imagex are now treated case
754 Improved behavior regarding invalid filenames; in particular, on
755 Windows, wimlib-imagex will, when extracting, now omit (with an option
756 to override this default) filenames differing only in case, or filenames
757 containing characters not valid on Windows.
759 On Windows, wimlib now supports capturing and extracting long paths
760 (longer than the so-called MAX_PATH).
762 On Windows, `wimlib-imagex update' now acquires proper privileges when
763 running as an Administrator.
765 `wimlib-imagex update' will now complain if no image is specified when
766 trying to update a multi-image WIM.
768 `wimlib-imagex update' now supports specifying a single update command
769 directly on the command line using the --command option.
771 wimlib-imagex will now choose different units for progress messages,
772 depending on the amount of data that needs to be processed.
774 `wimlib-imagex append' will now generate a unique WIM image name if no
775 name is specified and the defaulted name already exists in the WIM.
777 wimlib now allows you to create unnamed WIM images, which can then only
778 be referred to by index.
780 wimlib now allows you to explicitly declare you want write access to a
781 WIM by providing the WIMLIB_OPEN_FLAG_WRITE_ACCESS flag to
784 wimlib now respects the WIM_HDR_FLAG_READONLY flag when set in the WIM
787 Progress callbacks have been added to wimlib's wimlib_update_image()
790 Added wimlib_get_wim_info(), wimlib_set_wim_info(),
791 wimlib_iterate_dir_tree(), and wimlib_iterate_lookup_table() functions
794 NTFS-3g capture now only warns about two conditions previously treated
797 Fixed a couple issues with using wimlib-imagex on UDF filesystems on
800 wimlib now correctly detects and returns an error when reading a WIM
801 image with a cyclic directory structure. (Fun fact: such a WIM will
802 crash Microsoft's software.)
805 Added new "extract" and "update" subcommands to wimlib-imagex, along
806 with associated APIs in the library. These commands are intended mainly
807 for Windows use but can be used on UNIX as well.
809 Many documentation improvements.
811 Fixed a bug in the Windows build where relative symbolic links were not
812 captured in reparse-point fixup mode.
814 Fixed a bug in the Windows build where file handles were left open to
815 the WIM file, causing `wimlib_imagex optimize' to fail in some cases.
817 Fixed a bug in the Windows build of wimlib-imagex where globbing
818 split-WIM parts could cause the program to crash.
820 Fixed a bug where the creation time of WIM images would be shown instead
821 of the last modification time.
823 With the Windows build it is now possible to restore a WIM containing
824 symbolic links as a non-Administrator; however you will receive warnings
825 about not being able to extract the symbolic links.
828 Capturing a WIM image should now be significantly faster in most cases
829 due to improved use of the operating system's cache and avoiding reading
830 files twice whenever possible.
832 The Windows build should now work on Windows XP.
834 The Windows build now supports capturing and restoring hidden,
835 compressed, sparse, and encrypted files.
837 The Windows build now supports capturing and applying WIM images from
838 filesystems other than NTFS (with some reduced functionality).
840 The Windows build now extracts short names correctly.
842 Added support for "reparse-point" fixups (i.e. fixing up of symbolic
843 links). See docs for --rpfix and --norpfix flags of `wimlib-imagex
844 capture' and `wimlib-imagex apply'.
846 The performance of splitting and joining WIMs should be slightly
849 The LZX and XPRESS compression and decompression functions are now
850 exported from the library.
853 Improvements and bugfixes for the Windows build.
855 Added --strict-acls options.
857 Fixed the way that wimlib determines the order of images in the WIM.
860 Since wimlib can now be used on Windows, wimlib's implementation of
861 ImageX has been renamed to wimlib-imagex to avoid confusion with
862 Microsoft's implementation of ImageX, which would have the same file
863 name ("imagex.exe"). If you really don't like this you can pass the
864 --with-imagex-progname option to `configure' to choose a different name,
865 or even simply rename the binary yourself (but the former way will
866 configure the man pages to use the chosen name).
868 Various bugs fixed in the Windows build. Mainly to do with capturing
869 and restoring alternate data streams correctly in weird cases, and
870 requesting the correct privileges when opening files. Also added the
871 --noacls options to wimlib-imagex capture, append, and apply.
873 Windows build again: FindFirstStreamW() and FindNextStreamW() are now
874 dynamically loaded, so this may make the library compatible with Windows
875 XP (however, there may still be other problems).
878 Added experimental support for native Windows builds. Binaries can be
879 downloaded from the SourceForge page.
881 --source-list option added to `imagex capture' and `imagex append'.
883 Better support for different character encodings.
886 Storing UNIX file owners, groups, and modes in WIM images is now
887 possible using `imagex capture' with the --unix-data flag.
889 Minor bug fixes and documentation fixes.
892 NTFS capture: Fixed capturing duplicate reparse points.
894 NTFS capture: Capture first unnamed stream if there are more than one
895 (print warning instead of error).
897 Allow multiple test cases to execute concurrently (e.g. make -j2 check).
900 Added --arch switch to mkwinpeimg script to support getting AMD64 WinPE
903 Update to work with ntfs-3g version 2013.1.13.
906 Fixed truncating file to shorter but non-zero length on read-write
909 Various code cleanups and minor documentation fixes.
912 LZX and XPRESS decompression have received some additional optimizations
913 and should now be even faster. (Although, they were already pretty
914 fast--- much faster than typical I/O speeds.)
916 Fixed a bug introduced in v1.2.1 that would cause a directory tree
917 containing hard links to be captured incorrectly in some cases.
920 By default, unmounting a read-write mounted WIM with 'imagex unmount
921 --commit' will now change the WIM in-place without needing to write the
922 entire WIM again. Use 'imagex unmount --commit --rebuild' to get the
925 'imagex unmount' no longer has a hard-coded limit of 10 minutes to wait
926 for a response from the daemon servicing the mounted WIM. Instead,
927 every second 'imagex unmount' will check if the daemon is still alive,
928 and keep waiting if so, otherwise terminate with an error.
930 'imagex unmount --commit' on a read-write mounted WIM will now print
931 progress information regarding the writing of new or modified streams
932 the WIM, just like when capturing or appending a WIM.
934 A small change has been made to XPRESS compression and it should improve
935 the compression ratio slightly.
937 A change was made that may improve performance slightly when applying a
938 WIM image to a NTFS volume.
940 Microsoft has managed to introduce even more bugs into their software,
941 and now the WIMs for Windows 8 have incorrect (too low) reference counts
942 for some streams. This is unsafe because such streams can be removed
943 when they are in actuality still referenced in the WIM (perhaps by a
944 different image). wimlib will now work around this problem by fixing
945 the stream reference counts. This is only done when wimlib_delete_image() is
946 called ('imagex delete') or when wimlib_mount_image() is called with
947 WIMLIB_MOUNT_FLAG_READWRITE ('imagex mountrw'). Please note that this
948 requires reading the metadata for all images in the WIM, so this will
949 make these operations noticably slower on WIMs with multiple images.
951 Various other bugfixes.
954 Appending images to a WIM is now be done by default without re-building
955 the whole WIM. Use the --rebuild flag to get the old behavior (which
956 was to re-build the entire WIM when a new image is appended).
958 A new command `imagex optimize' is now available to manually re-build a
959 WIM that has wasted space due to repeated appends.
961 Progress information has been improved, and now arbitrary callback
962 functions can be used to show the progress of a WIM operation.
964 A possible bug with changing the bootable image of a WIM was fixed.
966 Some advisory locking is now done to prevent two processes from
967 modifying a WIM at the same time (but only in some cases). For example,
968 you cannot mount two images from a WIM read-write at the same time.
970 Some functions have been reorganized:
971 * wimlib_mount() renamed to wimlib_mount_image().
972 * wimlib_unmount() renamed to wimlib_unmount_image().
973 * wimlib_overwrite_xml_and_header() removed as
974 wimlib_overwrite() suffices now.
975 * wimlib_apply_image_to_ntfs_volume() removed as
976 wimlib_extract_image() suffices now.
977 * wimlib_add_image_from_ntfs_volume() removed as
978 * wimlib_add_image() suffices now.
980 Previously, the soname of libwim.so has been 0.0.0, despite many
981 interface changes. The soname is now updated to 1.0.0 and will now be
982 updated each release.
985 Resources will now be compressed using multiple threads by default.
986 (This applies to `imagex capture', `imagex append', and `imagex
989 Some performance improvements in mounted WIMs.
991 More progress information is shown when capturing a WIM.
994 Lots of minor fixes, code cleanups, and some documentation updates.
995 Nothing in particular is really noteworthy.
998 LZX and XPRESS compression improvements.
1000 Fixed calculation of Directory Count, File Count, Total Bytes, and Hard
1001 Link Bytes of the WIM.
1004 Fixed bug when capturing NTFS file with multiple named data streams.
1006 Internally, we are now using inode structures, even though these don't
1007 appear literally in the WIM file. This simplifies some of the code
1008 (mainly for WIM mounting) and likely fixed a few problems, although it
1012 Fixed problem when exporting images from XPRESS to LZX compressed WIM or
1016 Enough changes to call it version 1.0.0!
1018 Capturing a WIM directly from a NTFS volume, and applying a WIM directly
1019 to a NTFS volume, is now supported.
1021 Hard links and symbolic links have much improved support. They are
1022 supported for WIM capture, WIM application, and mounted WIMs (you can
1023 even make them on read-write mounted WIMs).
1025 Alternate data streams are now supported on mounted WIMs through an
1026 xattr or a Windows-style stream interface. Also they are supported when
1027 capturing a WIM from NTFS or applying a WIM to NTFS.
1029 Split WIMs are better supported. You may now apply an image directly
1030 from a split WIM, mount an image from a split WIM read-only, or export
1031 an image from a split WIM.
1033 Using a capture configuration file is now supported (but not fully yet).
1035 SHA1 message digests are checked in more places, so we can make sure
1036 applied and captured data is correct.
1038 Man pages have been updated and consolidated.
1041 Fixed segfault when unmounting read-only WIM.
1044 Support for joining and splitting WIMs.
1045 Also, security data is now preserved by default.
1048 Can now build with older gcc and system headers, like on CentOS 5.
1051 Fixed bug that made it impossible to overwrite files in read-write
1055 Write byte-order mark before WIM XML data. (imagex.exe requires this to
git://wimlib.net / wimlib / blob