2 On Windows, wimlib now supports capturing and applying extended
3 attributes (EAs). It is compatible with DISM with the /EA option,
4 available since Windows 10 version 1607. wimlib's EA support is on by
5 default; no option has to be provided, and it should work on older
6 versions of Windows too.
8 Partially fixed a bug where [ExclusionException] entries didn't take
9 effect when the containing directory is matched by [ExclusionList]. It
10 now works when the [ExclusionException] patterns are absolute. For
11 example, listing "/dir/file" in [ExclusionException] now works even if
12 "/dir" is matched by [ExclusionList].
14 Added an '--include-integrity' option to various wimlib-imagex commands.
15 '--include-integrity' is like '--check', but it will just include an
16 integrity table in the output WIM(s), while skipping verification of any
17 existing integrity tables. This can be useful to avoid unwanted
18 verification of large WIM files, e.g. WIMs given by '--delta-from'.
20 wimsplit (API: wimlib_split()) now correctly handles a dot in the path
21 to the first split WIM part, prior to the filename extension.
23 'wimlib-imagex --version' now shows the version of the library it is
24 actually using (in case it is different from wimlib-imagex's version).
27 Fixed a bug that was causing the LZMS decompressor to be miscompiled
28 with GCC 7 (this broke extracting "solid" archives).
30 The Windows 10 Recycle Bin directory (\$RECYCLE.BIN) has been added to
31 the default exclusion list.
33 Added a '--quiet' option to wimlib-imagex.
35 The 'mkwinpeimg' script now also looks for the syslinux BIOS modules in
36 the directory /usr/lib/syslinux/modules/bios.
38 Files with timestamps before the year 1970 are now extracted correctly
39 to UNIX-style filesystems, are displayed correctly by
40 'wimdir --detailed', and show up correctly in mounted WIM images.
42 Files with timestamps after the year 2038 are now displayed correctly by
43 the 32-bit Windows build of wimlib.
46 Fixed a data corruption bug (incorrect compression) when storing an
47 already highly-compressed file in an LZX-compressed WIM with a chunk
48 size greater than or equal to 64K. Note that this is not the default
49 setting and such WIMs are not supported by Microsoft's WIM software, so
50 only users who used the --chunk-size option to wimlib-imagex or the
51 wimlib_set_output_chunk_size() API function may have been affected.
52 This bug was introduced in wimlib v1.10.0. See
53 https://wimlib.net/forums/viewtopic.php?f=1&t=300 for more details.
55 On all platforms, sparse files are now extracted as sparse.
57 Sparse files captured from UNIX-style filesystems are now marked as
58 sparse in the resulting WIM image.
60 Added support for storing Linux-style extended attributes in WIM images.
61 When the --unix-data option is used on Linux, wimlib-imagex now captures
62 and applies extended attributes, in addition to the already-supported
63 standard UNIX file permissions (owner/group/mode) and special files.
65 --delta-from is now supported by wimappend. (Previously it was only
66 supported by wimcapture.)
68 On Windows, improved the way in which files deduplicated with Windows'
69 Data Deduplication feature are captured.
71 The development files needed to link with wimlib using Visual Studio are
72 now included in the Windows release archives.
74 wimlib.h can now be included by Visual Studio without errors.
76 The example programs can now be compiled in C++ mode, and they also now
79 Updated 'mkwinpeimg' to work correctly on images that have a "windows"
80 (lower case) directory rather than a "Windows" (upper case) directory.
82 Fixed configuring with --enable-ssse3-sha1 from release tarball
83 (the file nasm_lt.sh was missing).
85 Made some documentation improvements.
88 The LZX compression ratio has been slightly improved. The default mode,
89 LZX level 50, is now almost as good as the old LZX level 100, while
90 being nearly the same speed as before.
92 Decompression performance has been slightly improved.
94 Filenames are now always listed in NTFS collation order.
96 On UNIX-like systems, wimlib can now process Windows filenames that are
97 not valid Unicode due to the presence of unpaired surrogates.
99 On UNIX-like systems, wimlib now always assumes UTF-8 encoding with the
100 addition of surrogate codepoints. Consequently, the environmental
101 variable WIMLIB_IMAGEX_USE_UTF8 and the flag
102 WIMLIB_INIT_FLAG_ASSUME_UTF8 no longer have any effect.
104 wimlib no longer depends on iconv.
106 Reduced memory usage slightly.
108 When a WIM image is applied in NTFS-3G mode, security descriptors are
109 now created in NTFS v3.0 format when supported by the volume.
111 Workarounds for bugs in libntfs-3g version 2013.1.13 and earlier have
112 been removed. Users are advised to upgrade to a later version of
115 On Windows, wimlib now supports case-sensitive filename extraction when
116 supported by the underlying operating system and filesystem (operating
117 system support requires a registry setting).
120 On UNIX, wimlib can now overwrite readonly files when extracting.
122 On Windows, fixed a bug where wimlib could leave a null DACL (a.k.a. "no
123 NTFS permissions") set on some existing directories after extraction.
125 On Windows, when applying a WIM image in "WIMBoot mode" when the WOF
126 driver is not loaded, wimlib can now correctly register a new WIM file
127 with the target volume when the target volume previously had had WIM
130 Added a new testing program.
132 Clarified the main license text and updated public domain dedications
133 for certain files to be more thorough.
136 Object IDs are now saved and restored on Windows and in NTFS-3G mode.
138 Reduced memory usage when exporting large numbers of WIM images.
140 Non UTF-8 locales are now detected correctly.
142 Addressed compiler warnings and enabled "silent" make rules by default.
144 Windows-specific updates:
145 Fixed a bug where duplicate backslashes could be generated in
146 link targets when extracting symbolic links and junctions.
148 Fixed a bug where the .cmd shortcuts for wimlib-imagex wouldn't
149 work if their full path contained a space.
151 Fixed bugs related to scanning SMB filesystems.
153 Added warning message about known issue with WindowsApps folder.
155 Added instructions for building from source on Windows.
157 VSS support is no longer marked "experimental".
159 Added missing license file for libdivsufsort-lite.
162 Added experimental support for Windows VSS (Volume Shadow Copy Service).
163 The new '--snapshot' argument to 'wimcapture' makes wimlib automatically
164 create and use a temporary VSS snapshot when capturing a WIM image.
166 Implemented setting of Windows-specific XML information, such as
167 architecture, system root, and version details. This information is now
168 automatically set in newly captured WIM images, when appropriate.
170 Improved performance of directory tree scans on Windows.
172 On Windows, to improve capture performance, wimlib now sometimes opens
173 files by inode number rather than by path. This is enabled for
174 wimcapture and wimappend, but for now other applications have to opt-in.
176 The progress messages printed by wimlib-imagex while writing WIM files
177 have been slightly tweaked.
179 Progress information for directory tree scans now counts all hard links.
180 Also, on Windows "\\?\" is no longer stripped from the current path.
182 Added a new '--image-property' option to 'wimcapture', 'wimappend', and
183 'wiminfo'. This option lets you assign values to elements in a WIM
184 file's XML document by name.
186 The wimlib_get_image_property() and wimlib_set_image_property() API
187 functions now support numerically indexed elements.
189 Fixed a bug where, on Windows, wimlib would change the security
190 descriptor of the target directory of an extraction even when the
191 '--no-acls' option was specified.
194 Fixed a bug with libntfs-3g extraction present since v1.8.1. Sometimes,
195 some Microsoft software would not correctly recognize data in the
196 resulting filesystem.
198 Made some small improvements to the compression algorithms:
199 LZX compression ratio was slightly improved.
200 XPRESS compression ratio and speed was slightly improved.
201 LZMS compression speed was slightly improved.
203 Improved handling of WIM XML data. wimlib no longer drops unrecognized
204 elements when exporting images. In addition, two API functions were
205 added for better access to elements in the XML document:
206 wimlib_get_image_property() and wimlib_set_image_property().
208 Added support for (unsafe) in-place compaction of WIM files.
210 Improved performance of image export by reusing metadata resources
211 instead of always rebuilding and recompressing them.
213 Improved performance of wimlib_update_image() by delaying the update to
214 the WIM's XML document until a write is requested.
216 On Windows, the target of an extraction may now be a reparse point
217 (which will be dereferenced).
219 On Windows, wimlib now correctly restores non-Microsoft reparse points.
220 However, this remains broken in NTFS-3g mode due to a libntfs-3g bug.
222 On Windows, wimlib now has improved performance when archiving files
223 from a filesystem backed by a WIM (a "WIMBoot" setup).
225 Several improvements to System Compression (compact mode) support:
227 wof.sys (or wofadk.sys) is now automatically attached to the
228 target volume if needed.
230 Compact-mode extractions now work correctly with wofadk.sys on
231 older versions of Windows.
233 For compatibility with the Windows bootloader, the requested
234 compression format now is overridden on certain files.
236 Other minor bugfixes.
239 This release primarily contains various minor bug fixes and
240 improvements, including:
242 Improved handling of deep directory structures.
244 Fixed a bug where on 32-bit systems, the library could enter an
245 infinite loop if a WIM file was malformed in a specific way.
247 Added a workaround for a case where libntfs-3g may report
248 duplicate streams in an NTFS file.
250 Windows symbolic links and junctions in mounted WIM images are
251 now automatically rewritten to be valid in the mounted location.
253 Reparse point fixes: correctly handle the "ReparseReserved"
254 field, and correctly handle "empty" (data-less) reparse points.
256 On Windows, wimlib now acquires SeManageVolumePrivilege, which
257 is needed to create externally backed files using the
260 Improved validation of filenames.
262 Improved LZMS decompression speed.
264 The configure script now honors alternate pkg-config settings.
266 Links have been updated to point to the new website.
268 In addition, experimental support has been added for compressing
269 extracted files using System Compression on Windows 10. This
270 functionality is available through the new '--compact' option to
271 'wimapply' and 'wimextract' as well as new library flags.
274 Fixed a bug in the LZX decompressor: malicious input data could cause
275 out of bounds writes to memory (since wimlib v1.2.2).
277 The output of the 'wiminfo' command now consolidates various boolean
278 flags (such as "Relative path junction") into a single line.
280 A file can now have both an unnamed data stream ("file contents") and a
281 reparse point stream. Such files can exist as a result of the use of
282 certain Windows features, such as offline storage, including "OneDrive".
283 wimlib will now store and restore both streams on Windows as well as in
284 NTFS-3g mode. Microsoft's WIMGAPI also has this behavior.
286 On Windows, named data streams of encrypted files are no longer stored
287 twice in WIM archives.
289 On Windows, named data streams are now correctly extracted to existing
290 "readonly" directories. Before, an error would be reported.
292 On Windows, it is now possible to do a "WIMBoot mode" extraction with
293 non-standalone WIMs such as delta WIMs.
295 On Windows, when doing an extraction in "WIMBoot mode", files larger
296 than 4 gigabytes are now never extracted as externally backed. This
297 works around a bug in Microsoft's "WOF" driver.
299 The '--enable-verify-compression' configure option has been removed. If
300 you want to verify a WIM file, use the 'wimverify' program.
302 The way the "file count", "directory count", "total bytes", and "hard
303 link bytes" image statistics (stored in the WIM XML data) is calculated
304 has been slightly changed.
306 In mounted WIM images, the disk usage provided for each file (st_blocks)
307 is now the compressed size rather than the uncompressed size.
309 The performance of the NTFS-3g and Windows capture modes has been
312 On UNIX-like systems, symbolic links whose targets contain the backslash
313 character are now handled correctly (losslessly).
316 Improved the LZX compressor. It is now 15-20% faster than before and
317 provides a slightly better compression ratio.
319 Improved the LZMS compressor. It now provides a compression ratio
320 slightly better than WIMGAPI while still being faster and using slightly
323 The compression chunk size in solid resources, e.g. when capturing or
324 exporting a WIM file using the '--solid' option, now defaults to 64 MiB
325 (67108864 bytes) instead of 32 MiB (33554432 bytes). This provides a
326 better compression ratio and is the same value that WIMGAPI uses. The
327 memory usage is less than 50% higher than wimlib v1.7.4 and is slightly
328 lower than WIMGAPI's memory usage, but if it is too much, it is still
329 possible to choose a lower value, e.g. with the '--solid-chunk-size'
330 option to wimlib-imagex.
332 The '--chunk-size' and '--solid-chunk-size' options to wimlib-imagex now
333 accept the 'K', 'M', and 'G' suffixes.
335 Files are now sorted by name extension when creating a solid WIM file.
337 Fixed various issues related to capture/apply of EFS-encrypted files on
340 The file list printed by 'wimdir' is now sorted by the platform-specific
341 case sensitivity setting, rather than always case sensitively. This
342 also affects the library function wimlib_iterate_dir_tree().
344 On Windows, some error and warning messages have been improved.
347 The Windows binary distribution no longer contains third party DLLs.
348 These dependencies are instead compiled directly into the libwim DLL.
350 Added more fixes for wimlib on non-x86 architectures such as ARM.
352 Extracting files to a Windows PE in-memory filesystem no longer fails if
353 the target files do not yet exist.
355 Improved the performance of XPRESS compression and LZMS decompression.
357 Enabled SSSE3 accelerated SHA-1 computation in x86_64 Windows builds.
358 It will automatically be faster on newer Intel and AMD processors.
360 Removed the --with-imagex-progname and --enable-more-assertions
364 Fix for very slow export from solid WIM / ESD files.
366 Fix for LZX and LZMS algorithms on non-x86 architectures, such as ARM.
368 New progress message: WIMLIB_PROGRESS_MSG_HANDLE_ERROR. Applications
369 may use this to treat some types of errors as non-fatal.
371 The library now permits making in-memory changes to a WIMStruct backed
372 by a read-only WIM file.
374 Fixes for "WIMBoot" extraction mode (Windows only):
376 When not using the WOF driver, extraction no longer fails if the
377 disk containing the WIM file has too many partitions.
379 When matching patterns in [PrepopulateList], all hard links of
380 each file are now considered.
382 The system registry files are now automatically treated as being
383 in [PrepopulateList].
385 Added a hack to try to work around an intermittent bug in
386 Microsoft's WOF (Windows Overlay Filesystem) driver.
389 Made more improvements to the XPRESS, LZX, and LZMS compressors.
391 A number of improvements to the Windows port:
393 Fixes for setting short filenames.
395 Faster "WIMBoot" extraction.
397 Updated and slimmed down the dependent DLLs.
399 ACL inheritence bits are now restored.
401 Mandatory integrity labels are now backed up and restored.
403 Added a workaround for an issue where in rare cases, wimlib could create
404 a compressed data stream that could not be read correctly by Windows
405 after an extraction in "WIMBoot" mode.
408 Added file count progress data for
409 WIMLIB_PROGRESS_MSG_EXTRACT_FILE_STRUCTURE and
410 WIMLIB_PROGRESS_MSG_EXTRACT_METADATA.
412 Added support for testing file exclusions via the user-provided
415 Some documentation improvements.
417 Made some clarifications to the license text in the COPYING file.
420 Made more improvements to the XPRESS, LZX, and LZMS compressors.
422 The default compression mode for wimcapture is now LZX compression in
423 its default mode, which is the same as '--compress=maximum'.
425 You can now specify an optional integer compression level to the
426 '--compress' option; e.g. '--compress=lzx:75'.
428 Made a minor change to the LZMS compressor and decompressor to fix an
429 incompatibility with the Microsoft implementation. In the unlikely
430 event that you created an LZMS-compressed WIM with wimlib v1.7.0 or
431 earlier and a checksum error is reported when extracting files from it
432 with wimlib v1.7.1, decompress it with v1.7.0 then compress it with
435 Added 'verify' subcommand to wimlib-imagex.
437 Notable library changes:
439 Custom compressor parameters have been removed from the library
440 in favor of the simpler level-based API.
442 Decompressor parameters have been removed entirely.
444 Library users can now specify a custom file for warning and
445 error messages to be sent to, rather than the default of
448 New progress messages:
449 WIMLIB_PROGRESS_MSG_EXTRACT_FILE_STRUCTURE,
450 WIMLIB_PROGRESS_MSG_EXTRACT_METADATA.
452 New function: wimlib_verify_wim().
455 Improved compression, decompression, and extraction performance.
457 Improved compatibility with version 3584 WIM / ESD files:
458 - Add support for reading and writing multiple solid blocks per
459 archive, which WIMGAPI/DISM can create when appending an image.
460 - Correctly create solid blocks larger than 4 GiB.
462 'add' commands passed to wimupdate will now replace existing
463 nondirectory files by default. Use the --no-replace option to get the
466 The license for the library now contains an exception that allows using
467 it under the LGPL. See the COPYING file for details.
469 In reparse-point fixup mode (the default for capture), symbolic links
470 and junctions that point outside the tree being captured are no longer
471 excluded from capture.
473 Added support for "WIMBoot" capture and extraction. See the
474 documentation for the new '--wimboot' option to wimcapture and wimapply
475 for more information.
477 On UNIX-like systems, you can now backup and restore device nodes, named
478 pipes, and sockets. In addition, 32-bit user and group IDs are now
481 The way that UNIX data is stored in WIM files has been changed. If you
482 captured any WIMs with the --unix-data option, to upgrade them you'll
483 need to apply them with --unix-data using wimlib-imagex v1.6.2, then
484 re-capture them with --unix-data using this version.
486 wimlib now understands tagged metadata items, such as object IDs, that
487 can be stored in WIM directory entries.
489 Removed the --hardlink and --symlink options to wimapply, since I don't
490 think they are too useful and they got in the way of improving the code.
492 WIMs will now retain their GUIDs when rebuilt (e.g. with wimoptimize).
494 The 'mkwinpeimg' script now supports writing the ISO image to standard
497 The <ARCH> element in WIM XML data is now exported correctly.
499 On Windows, sparse file attributes are no longer set on extracted files.
500 Oddly enough, this actually saves disk space in some cases.
502 On UNIX, configuring with --disable-xattr or --enable-xattr is no longer
503 supported. Mounting WIM images now always requires extended attribute
504 support. Use --without-fuse to disable support for mounting WIM images;
505 this will also disable the need for extended attribute support.
507 Configuring with --enable-ssse3-sha1 now works correctly.
509 The shared library version has been bumped up. The main
510 incompatibilities are:
512 - WIMLIB_COMPRESSION_TYPE_XPRESS is now 1 and
513 WIMLIB_COMPRESSION_TYPE_LZX is now 2 (so it's the same as
516 - User-provided progress functions are now registered using a
517 separate function, wimlib_register_progress_function(). The
518 'progress_func' argument to many functions no longer exists.
520 - The return value from user-provided progress functions is now
523 - A context argument has been added to the prototype of
524 user-provided progress functions.
526 - 'struct wimlib_capture_config' has been removed. The library
527 now takes the path to the configuration file directly. This
528 affects wimlib_add_image(), wimlib_add_image_multisource(),
529 and wimlib_update_image(). However, a NULL value passed in
530 the argument retains the same meaning.
532 - Removed deprecated functions: some (de)compression functions,
533 wimlib_extract_files(), and wimlib_print_metadata().
535 - Removed extraction flags: WIMLIB_EXTRACT_FLAG_HARDLINK,
536 WIMLIB_EXTRACT_FLAG_SYMLINK, WIMLIB_EXTRACT_FLAG_FILE_ORDER,
537 and WIMLIB_EXTRACT_FLAG_SEQUENTIAL.
539 - Removed some progress messages:
540 WIMLIB_PROGRESS_MSG_APPLY_TIMESTAMPS,
541 WIMLIB_PROGRESS_MSG_EXTRACT_DIR_STRUCTURE_BEGIN,
542 WIMLIB_PROGRESS_MSG_EXTRACT_DIR_STRUCTURE_END. Numbering
545 - Removed some error codes. Numbering stays the same.
547 - Replaced WIMLIB_UNMOUNT_FLAG_LAZY with
548 WIMLIB_UNMOUNT_FLAG_FORCE.
550 - WIM paths passed to progress functions now have a leading
554 Case-insensitive comparisons of strings (e.g. filenames) containing
555 UTF-16 codepoints above 32767 are now done correctly.
557 Fixed build failure on Mac OS X.
559 wimunmount now provides the '--new-image' option to cause changes to a
560 read-write mounted image to be committed as a new image rather than as
561 an update of the mounted image. (The corresponding new library flag is
562 WIMLIB_UNMOUNT_FLAG_NEW_IMAGE.)
564 The LZMS ("recovery") compression chunk size, or "dictionary size", may
565 now be up to 1 GiB (1,073,741,824 bytes).
567 The performance of LZX ("maximum") and LZMS ("recovery") compression
568 with large chunk sizes has been slightly improved.
571 Stored files with size exactly 4 GiB (4,294,967,296 bytes) are now
572 decompressed correctly.
574 Fixed a bug in the LZX compressor introduced in v1.5.3. The bug
575 occurred in an unlikely case, and due to validity checks it did not
576 affect successfully created archives.
578 Fixed a minor compatibility issue with the LZMS compressor and
579 decompressor. This is *not* the default compression type and was only
580 introduced in v1.6.0. In the unlikely event that you created an
581 LZMS-compressed WIM with v1.6.0 and a checksum error is reported when
582 applying it with v1.6.1, decompress it with v1.6.0 then compress it with
585 Memory usage for LZMS and LZX compression has been decreased.
587 wimextract now allows wildcard characters in paths specified on the
588 command line. Also, the '--strict-wildcards' option has been removed
589 and replaced with the inverse option '--nullglob'. See the
590 documentation for wimextract for more details and changes.
592 The wimlib_extract_files() function is now considered deprecated in
593 favor of wimlib_extract_paths().
595 Fixed more permissions problems when extracting files on Windows.
597 A new '--no-attributes' option has been added to wimapply and
598 wimextract. The library flag is WIMLIB_EXTRACT_FLAG_NO_ATTRIBUTES.
600 The default chunk size is now set correctly when changing the
601 compression type of a WIM, for example with 'wimoptimize'.
603 The '--metadata' option to wiminfo has been replaced with the
604 '--detailed' option to wimdir.
606 In relevant wimlib-imagex commands, '--solid' may now be used as an
607 alias for '--pack-streams'.
610 Support for extracting and updating the new version 3584 WIMs has been
611 added. These WIMs typically pack many streams ("files") together into a
612 single compressed resource, thereby saving space. This degrades the
613 performance of random access (such as that which occurs on a mounted
614 image), but optimizations have been implemented for extraction. These
615 new WIM files also typically use a new compression format (LZMS), which
616 is similar to LZMA and can offer a better compression ratio than LZX.
617 These new WIM files can be created using `wimcapture' with
618 the '--compress=lzms --pack-streams' options. Note: this new WIM format
619 is used by the Windows 8 web downloader, but important segments of the
620 raw '.esd' files are encrypted, so wimlib will not be able to extract
621 such files until they are first decrypted.
623 wimlib now supports extracting files and directories from a WIM image
624 based on a "listfile" that itself contains the list of paths to extract.
625 For `wimextract', the syntax is to specify @LISTFILE instead of a PATH,
626 and for the library itself, the new APIs are wimlib_extract_pathlist()
627 and wimlib_extract_paths(). Path globs containing wildcard characters
630 For searching WIM files, wimlib now has configurable case sensitivity.
631 The default on Windows is still case-insensitive and the default on
632 UNIX-like systems is still case-sensitive, but this can be overridden
633 on either platform through flags to wimlib_global_init(). For
634 `wimlib-imagex', the environmental variable WIMLIB_IMAGEX_IGNORE_CASE
635 can be set to 1 or 0 for case-insensitive or case-sensitive behavior,
638 Support for compression chunk sizes greater than the default of 32768
639 bytes has been added. A larger chunk size typically results in a better
640 compression ratio. However, the MS implementation is seemingly not
641 compatible with all chunk sizes, especially for LZX compression, so the
642 defaults remain unchanged, with the exception of the new LZMS-compressed
643 WIMs, which use a larger chunk size by default.
645 The compression/decompression API exported by wimlib has been changed.
646 Now one set of functions handles all supported compression formats.
648 `wimcapture' and `wimappend' will now display the progress of scanning
649 the directory tree to capture, in addition to the progress of writing
650 data to the WIM. The '--verbose' option no longer does anything. The
651 library API change for this is the addition of several members to
652 `struct wimlib_progress_info_scan' available to progress callbacks.
654 `mkwinpeimg' now correctly handles the '--start-script' option when the
655 start script is not in the working directory.
657 Sequential extraction, previously requested by using
658 WIMLIB_EXTRACT_FLAG_SEQUENTIAL, is now the default.
659 WIMLIB_EXTRACT_FLAG_FILE_ORDER can be used to get the old default
660 behavior (extract in file order).
663 The new LZX compressor added in v1.5.2 has been improved and is now
664 enabled by default, except when `wimcapture' or `wimappend' is run
665 *without* the '--compress' option, in which case the faster LZX
666 compressor is used (the same as before). This behavior is reasonably
667 consistent with ImageX which actually uses "fast" (XPRESS) compression
668 by default. In those cases, use '--compress=maximum' to explicitly
669 capture a WIM image using the new (slower but better) LZX compressor.
671 The '--compress-slow' option still exists to `wimlib-imagex optimize',
672 but its new behavior is to tweak the new LZX compressor even more to
673 produce an even better compression ratio at the cost of more time spent
676 `wimlib-imagex optimize' now supports the '--compress=TYPE' option,
677 which recompresses the WIM file using the specified compression TYPE.
678 The new library API function used for this is
679 wimlib_set_output_compression_type().
681 Added the wimlib_get_xml_data() function to allow library clients to
682 easily retrieve the raw XML data from a WIM file if needed.
684 Fixed a bug that could cause an error code to be incorrectly returned
685 when writing XML data containing a <WINDOWS> element.
687 Mounted WIM images will now correctly show the default file stream even
688 if appears in the alternate data stream entries of the corresponding WIM
692 Added a new experimental LZX compressor which can be enabled by passing
693 '--compress-slow' to `wimlib-imagex capture' or `wimlib-imagex
694 optimize'. (The latter is only applicable if the WIM is already
695 LZX-compressed and the '--recompress' option is also given.) The
696 experimental compressor is much slower but compresses the data slightly
697 more --- currently usually to within a fraction of a percent of the
698 results from WIMGAPI/ImageX.
700 A workaround has been added for compatibility with versions of WinPE
701 that interpret alternate data stream entries in the boot WIM
704 An alignment bug that caused a crash in the LZX decompressor on some
707 wimlib now attempts to clear the WIM_HDR_FLAG_WRITE_IN_PROGRESS flag in
708 the WIM header when restoring the previous state of a WIM it failed to
711 Added a workaround to avoid an access denied error on Windows when
712 replacing a WIM file that another process has opened.
715 wimlib can now open WinPE WIMs from WAIK v2.1, which had a quirk that
716 needed to be handled.
718 A bug in the interpretation of negative IMAGE indices in the
719 --update-of=[WIMFILE:]IMAGE option to `wimlib-imagex capture' and
720 `wimlib-imagex append' has been fixed.
722 A workaround has been added to successfully apply security descriptors
723 with empty DACLs when the NTFS-3g apply mode is being used with NTFS-3g
724 2013.1.13 or earlier.
726 `wimlib-imagex capture' can now accept the '--delta-from' option
730 Added support for "pipable" WIMs. Pipable WIMs allow capturing images
731 to standard output and applying images from standard input, but they are
732 not compatible with Microsoft's software and are not created by default.
733 See the documentation for --pipable flag of `wimlib-imagex capture' for
736 To better support incremental backups, added support for declaring an
737 image as a modified form of another image. See the documentation for
738 the '--update-of' option of `wimlib-imagex append' and `wimlib-imagex
741 Added supported for "delta" WIMs. See the documentation for the
742 '--delta-from' option of `wimlib-imagex capture'.
744 The library support for managing split WIMs has been changed to support
745 other arrangements, such as delta WIMs, and be easier to use. This
746 change is visible in `wimlib-imagex', which also can now accept the
747 '--ref' option multiple times, and also now supports "delta" WIMs as
750 wimlib now preserves WIM integrity tables by default, even if
751 WIMLIB_WRITE_FLAG_CHECK_INTEGRITY is not specified. This changes the
752 behavior of `wimlib-imagex' whenever the WIM being operated on contains
753 an integrity table and the '--check' option is not specified.
755 `wimlib-imagex capture' now creates LZX-compressed WIMs by default
756 (when --compress is not specified). This provides the best compression
757 ratio by default, which is usually what is desired, at a cost of some
760 `wimlib-imagex' now supports being invoked as wimCOMMAND, where COMMAND
761 is the command as in `wimlib-imagex COMMAND'; for example, it can be
762 invoked as `wimapply' as an alternative to `wimlib-imagex apply'. The
763 appropriate hard links are created in UNIX installations of
764 `wimlib-imagex', while for the Windows distribution of `wimlib-imagex',
765 batch files that emulate this behavior are generated.
767 Security descriptors are now extracted correctly on Windows.
769 Fixed archiving DOS names in NTFS-3g capture mode.
771 The extraction code has been rewritten and it will now be easier to
772 support new features on all supported backends (currently Win32, UNIX,
773 and NTFS-3g). For example, hard-linked extraction mode (--hardlink) is
774 now supported on all backends, not just UNIX.
776 `mkwinpeimg' now supports grabbing files from the WAIK supplement rather
777 than the WAIK itself.
779 wimlib_global_init() now, by default, attempts to acquire additional
780 privileges on Windows, so library clients need not do this.
782 This update bumps the shared library version number up to 9, since it is
783 not binary compatibible with previous releases.
786 Fixed bug in `wimlib-imagex export' that made it impossible to export an
787 image from a WIM that is readonly at the filesystem level.
789 Return error code rather than segfaulting when trying to list files from
790 a non-first part of a split WIM.
792 Joining a WIM will now preserve the RP_FIX and READONLY flags.
795 On Windows, paths given to wimlib-imagex are now treated case
798 Improved behavior regarding invalid filenames; in particular, on
799 Windows, wimlib-imagex will, when extracting, now omit (with an option
800 to override this default) filenames differing only in case, or filenames
801 containing characters not valid on Windows.
803 On Windows, wimlib now supports capturing and extracting long paths
804 (longer than the so-called MAX_PATH).
806 On Windows, `wimlib-imagex update' now acquires proper privileges when
807 running as an Administrator.
809 `wimlib-imagex update' will now complain if no image is specified when
810 trying to update a multi-image WIM.
812 `wimlib-imagex update' now supports specifying a single update command
813 directly on the command line using the --command option.
815 wimlib-imagex will now choose different units for progress messages,
816 depending on the amount of data that needs to be processed.
818 `wimlib-imagex append' will now generate a unique WIM image name if no
819 name is specified and the defaulted name already exists in the WIM.
821 wimlib now allows you to create unnamed WIM images, which can then only
822 be referred to by index.
824 wimlib now allows you to explicitly declare you want write access to a
825 WIM by providing the WIMLIB_OPEN_FLAG_WRITE_ACCESS flag to
828 wimlib now respects the WIM_HDR_FLAG_READONLY flag when set in the WIM
831 Progress callbacks have been added to wimlib's wimlib_update_image()
834 Added wimlib_get_wim_info(), wimlib_set_wim_info(),
835 wimlib_iterate_dir_tree(), and wimlib_iterate_lookup_table() functions
838 NTFS-3g capture now only warns about two conditions previously treated
841 Fixed a couple issues with using wimlib-imagex on UDF filesystems on
844 wimlib now correctly detects and returns an error when reading a WIM
845 image with a cyclic directory structure. (Fun fact: such a WIM will
846 crash Microsoft's software.)
849 Added new "extract" and "update" subcommands to wimlib-imagex, along
850 with associated APIs in the library. These commands are intended mainly
851 for Windows use but can be used on UNIX as well.
853 Many documentation improvements.
855 Fixed a bug in the Windows build where relative symbolic links were not
856 captured in reparse-point fixup mode.
858 Fixed a bug in the Windows build where file handles were left open to
859 the WIM file, causing `wimlib_imagex optimize' to fail in some cases.
861 Fixed a bug in the Windows build of wimlib-imagex where globbing
862 split-WIM parts could cause the program to crash.
864 Fixed a bug where the creation time of WIM images would be shown instead
865 of the last modification time.
867 With the Windows build it is now possible to restore a WIM containing
868 symbolic links as a non-Administrator; however you will receive warnings
869 about not being able to extract the symbolic links.
872 Capturing a WIM image should now be significantly faster in most cases
873 due to improved use of the operating system's cache and avoiding reading
874 files twice whenever possible.
876 The Windows build should now work on Windows XP.
878 The Windows build now supports capturing and restoring hidden,
879 compressed, sparse, and encrypted files.
881 The Windows build now supports capturing and applying WIM images from
882 filesystems other than NTFS (with some reduced functionality).
884 The Windows build now extracts short names correctly.
886 Added support for "reparse-point" fixups (i.e. fixing up of symbolic
887 links). See docs for --rpfix and --norpfix flags of `wimlib-imagex
888 capture' and `wimlib-imagex apply'.
890 The performance of splitting and joining WIMs should be slightly
893 The LZX and XPRESS compression and decompression functions are now
894 exported from the library.
897 Improvements and bugfixes for the Windows build.
899 Added --strict-acls options.
901 Fixed the way that wimlib determines the order of images in the WIM.
904 Since wimlib can now be used on Windows, wimlib's implementation of
905 ImageX has been renamed to wimlib-imagex to avoid confusion with
906 Microsoft's implementation of ImageX, which would have the same file
907 name ("imagex.exe"). If you really don't like this you can pass the
908 --with-imagex-progname option to `configure' to choose a different name,
909 or even simply rename the binary yourself (but the former way will
910 configure the man pages to use the chosen name).
912 Various bugs fixed in the Windows build. Mainly to do with capturing
913 and restoring alternate data streams correctly in weird cases, and
914 requesting the correct privileges when opening files. Also added the
915 --noacls options to wimlib-imagex capture, append, and apply.
917 Windows build again: FindFirstStreamW() and FindNextStreamW() are now
918 dynamically loaded, so this may make the library compatible with Windows
919 XP (however, there may still be other problems).
922 Added experimental support for native Windows builds. Binaries can be
923 downloaded from the SourceForge page.
925 --source-list option added to `imagex capture' and `imagex append'.
927 Better support for different character encodings.
930 Storing UNIX file owners, groups, and modes in WIM images is now
931 possible using `imagex capture' with the --unix-data flag.
933 Minor bug fixes and documentation fixes.
936 NTFS capture: Fixed capturing duplicate reparse points.
938 NTFS capture: Capture first unnamed stream if there are more than one
939 (print warning instead of error).
941 Allow multiple test cases to execute concurrently (e.g. make -j2 check).
944 Added --arch switch to mkwinpeimg script to support getting AMD64 WinPE
947 Update to work with ntfs-3g version 2013.1.13.
950 Fixed truncating file to shorter but non-zero length on read-write
953 Various code cleanups and minor documentation fixes.
956 LZX and XPRESS decompression have received some additional optimizations
957 and should now be even faster. (Although, they were already pretty
958 fast--- much faster than typical I/O speeds.)
960 Fixed a bug introduced in v1.2.1 that would cause a directory tree
961 containing hard links to be captured incorrectly in some cases.
964 By default, unmounting a read-write mounted WIM with 'imagex unmount
965 --commit' will now change the WIM in-place without needing to write the
966 entire WIM again. Use 'imagex unmount --commit --rebuild' to get the
969 'imagex unmount' no longer has a hard-coded limit of 10 minutes to wait
970 for a response from the daemon servicing the mounted WIM. Instead,
971 every second 'imagex unmount' will check if the daemon is still alive,
972 and keep waiting if so, otherwise terminate with an error.
974 'imagex unmount --commit' on a read-write mounted WIM will now print
975 progress information regarding the writing of new or modified streams
976 the WIM, just like when capturing or appending a WIM.
978 A small change has been made to XPRESS compression and it should improve
979 the compression ratio slightly.
981 A change was made that may improve performance slightly when applying a
982 WIM image to a NTFS volume.
984 Microsoft has managed to introduce even more bugs into their software,
985 and now the WIMs for Windows 8 have incorrect (too low) reference counts
986 for some streams. This is unsafe because such streams can be removed
987 when they are in actuality still referenced in the WIM (perhaps by a
988 different image). wimlib will now work around this problem by fixing
989 the stream reference counts. This is only done when wimlib_delete_image() is
990 called ('imagex delete') or when wimlib_mount_image() is called with
991 WIMLIB_MOUNT_FLAG_READWRITE ('imagex mountrw'). Please note that this
992 requires reading the metadata for all images in the WIM, so this will
993 make these operations noticably slower on WIMs with multiple images.
995 Various other bugfixes.
998 Appending images to a WIM is now be done by default without re-building
999 the whole WIM. Use the --rebuild flag to get the old behavior (which
1000 was to re-build the entire WIM when a new image is appended).
1002 A new command `imagex optimize' is now available to manually re-build a
1003 WIM that has wasted space due to repeated appends.
1005 Progress information has been improved, and now arbitrary callback
1006 functions can be used to show the progress of a WIM operation.
1008 A possible bug with changing the bootable image of a WIM was fixed.
1010 Some advisory locking is now done to prevent two processes from
1011 modifying a WIM at the same time (but only in some cases). For example,
1012 you cannot mount two images from a WIM read-write at the same time.
1014 Some functions have been reorganized:
1015 * wimlib_mount() renamed to wimlib_mount_image().
1016 * wimlib_unmount() renamed to wimlib_unmount_image().
1017 * wimlib_overwrite_xml_and_header() removed as
1018 wimlib_overwrite() suffices now.
1019 * wimlib_apply_image_to_ntfs_volume() removed as
1020 wimlib_extract_image() suffices now.
1021 * wimlib_add_image_from_ntfs_volume() removed as
1022 * wimlib_add_image() suffices now.
1024 Previously, the soname of libwim.so has been 0.0.0, despite many
1025 interface changes. The soname is now updated to 1.0.0 and will now be
1026 updated each release.
1029 Resources will now be compressed using multiple threads by default.
1030 (This applies to `imagex capture', `imagex append', and `imagex
1033 Some performance improvements in mounted WIMs.
1035 More progress information is shown when capturing a WIM.
1038 Lots of minor fixes, code cleanups, and some documentation updates.
1039 Nothing in particular is really noteworthy.
1042 LZX and XPRESS compression improvements.
1044 Fixed calculation of Directory Count, File Count, Total Bytes, and Hard
1045 Link Bytes of the WIM.
1048 Fixed bug when capturing NTFS file with multiple named data streams.
1050 Internally, we are now using inode structures, even though these don't
1051 appear literally in the WIM file. This simplifies some of the code
1052 (mainly for WIM mounting) and likely fixed a few problems, although it
1056 Fixed problem when exporting images from XPRESS to LZX compressed WIM or
1060 Enough changes to call it version 1.0.0!
1062 Capturing a WIM directly from a NTFS volume, and applying a WIM directly
1063 to a NTFS volume, is now supported.
1065 Hard links and symbolic links have much improved support. They are
1066 supported for WIM capture, WIM application, and mounted WIMs (you can
1067 even make them on read-write mounted WIMs).
1069 Alternate data streams are now supported on mounted WIMs through an
1070 xattr or a Windows-style stream interface. Also they are supported when
1071 capturing a WIM from NTFS or applying a WIM to NTFS.
1073 Split WIMs are better supported. You may now apply an image directly
1074 from a split WIM, mount an image from a split WIM read-only, or export
1075 an image from a split WIM.
1077 Using a capture configuration file is now supported (but not fully yet).
1079 SHA1 message digests are checked in more places, so we can make sure
1080 applied and captured data is correct.
1082 Man pages have been updated and consolidated.
1085 Fixed segfault when unmounting read-only WIM.
1088 Support for joining and splitting WIMs.
1089 Also, security data is now preserved by default.
1092 Can now build with older gcc and system headers, like on CentOS 5.
1095 Fixed bug that made it impossible to overwrite files in read-write
1099 Write byte-order mark before WIM XML data. (imagex.exe requires this to
git://wimlib.net / wimlib / blob