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 and works on older versions of Windows too.
7 Partially fixed a bug where [ExclusionException] entries didn't take
8 effect when the containing directory is matched by [ExclusionList]. It
9 now works when the [ExclusionException] patterns are absolute. For
10 example, listing "/dir/file" in [ExclusionException] now works even if
11 "/dir" is matched by [ExclusionList].
13 Added a '--create' option to 'wimappend' which makes it create the WIM
14 file (like 'wimcapture') if it doesn't exist yet.
16 Added an '--include-integrity' option to various wimlib-imagex commands.
17 '--include-integrity' is like '--check', but it will just include an
18 integrity table in the output WIM(s), while skipping verification of any
19 existing integrity tables. This can be useful to avoid unwanted
20 verification of large WIM files, e.g. WIMs given by '--delta-from'.
22 'wimextract' now reads a pathlist file from standard input when "@-" is
25 wimsplit (API: wimlib_split()) now correctly handles a dot in the path
26 to the first split WIM part, prior to the filename extension.
28 'wimlib-imagex --version' now shows the version of the library it is
29 actually using (in case it is different from wimlib-imagex's version).
32 Fixed a bug that was causing the LZMS decompressor to be miscompiled
33 with GCC 7 (this broke extracting "solid" archives).
35 The Windows 10 Recycle Bin directory (\$RECYCLE.BIN) has been added to
36 the default exclusion list.
38 Added a '--quiet' option to wimlib-imagex.
40 The 'mkwinpeimg' script now also looks for the syslinux BIOS modules in
41 the directory /usr/lib/syslinux/modules/bios.
43 Files with timestamps before the year 1970 are now extracted correctly
44 to UNIX-style filesystems, are displayed correctly by
45 'wimdir --detailed', and show up correctly in mounted WIM images.
47 Files with timestamps after the year 2038 are now displayed correctly by
48 the 32-bit Windows build of wimlib.
51 Fixed a data corruption bug (incorrect compression) when storing an
52 already highly-compressed file in an LZX-compressed WIM with a chunk
53 size greater than or equal to 64K. Note that this is not the default
54 setting and such WIMs are not supported by Microsoft's WIM software, so
55 only users who used the --chunk-size option to wimlib-imagex or the
56 wimlib_set_output_chunk_size() API function may have been affected.
57 This bug was introduced in wimlib v1.10.0. See
58 https://wimlib.net/forums/viewtopic.php?f=1&t=300 for more details.
60 On all platforms, sparse files are now extracted as sparse.
62 Sparse files captured from UNIX-style filesystems are now marked as
63 sparse in the resulting WIM image.
65 Added support for storing Linux-style extended attributes in WIM images.
66 When the --unix-data option is used on Linux, wimlib-imagex now captures
67 and applies extended attributes, in addition to the already-supported
68 standard UNIX file permissions (owner/group/mode) and special files.
70 --delta-from is now supported by wimappend. (Previously it was only
71 supported by wimcapture.)
73 On Windows, improved the way in which files deduplicated with Windows'
74 Data Deduplication feature are captured.
76 The development files needed to link with wimlib using Visual Studio are
77 now included in the Windows release archives.
79 wimlib.h can now be included by Visual Studio without errors.
81 The example programs can now be compiled in C++ mode, and they also now
84 Updated 'mkwinpeimg' to work correctly on images that have a "windows"
85 (lower case) directory rather than a "Windows" (upper case) directory.
87 Fixed configuring with --enable-ssse3-sha1 from release tarball
88 (the file nasm_lt.sh was missing).
90 Made some documentation improvements.
93 The LZX compression ratio has been slightly improved. The default mode,
94 LZX level 50, is now almost as good as the old LZX level 100, while
95 being nearly the same speed as before.
97 Decompression performance has been slightly improved.
99 Filenames are now always listed in NTFS collation order.
101 On UNIX-like systems, wimlib can now process Windows filenames that are
102 not valid Unicode due to the presence of unpaired surrogates.
104 On UNIX-like systems, wimlib now always assumes UTF-8 encoding with the
105 addition of surrogate codepoints. Consequently, the environmental
106 variable WIMLIB_IMAGEX_USE_UTF8 and the flag
107 WIMLIB_INIT_FLAG_ASSUME_UTF8 no longer have any effect.
109 wimlib no longer depends on iconv.
111 Reduced memory usage slightly.
113 When a WIM image is applied in NTFS-3G mode, security descriptors are
114 now created in NTFS v3.0 format when supported by the volume.
116 Workarounds for bugs in libntfs-3g version 2013.1.13 and earlier have
117 been removed. Users are advised to upgrade to a later version of
120 On Windows, wimlib now supports case-sensitive filename extraction when
121 supported by the underlying operating system and filesystem (operating
122 system support requires a registry setting).
125 On UNIX, wimlib can now overwrite readonly files when extracting.
127 On Windows, fixed a bug where wimlib could leave a null DACL (a.k.a. "no
128 NTFS permissions") set on some existing directories after extraction.
130 On Windows, when applying a WIM image in "WIMBoot mode" when the WOF
131 driver is not loaded, wimlib can now correctly register a new WIM file
132 with the target volume when the target volume previously had had WIM
135 Added a new testing program.
137 Clarified the main license text and updated public domain dedications
138 for certain files to be more thorough.
141 Object IDs are now saved and restored on Windows and in NTFS-3G mode.
143 Reduced memory usage when exporting large numbers of WIM images.
145 Non UTF-8 locales are now detected correctly.
147 Addressed compiler warnings and enabled "silent" make rules by default.
149 Windows-specific updates:
150 Fixed a bug where duplicate backslashes could be generated in
151 link targets when extracting symbolic links and junctions.
153 Fixed a bug where the .cmd shortcuts for wimlib-imagex wouldn't
154 work if their full path contained a space.
156 Fixed bugs related to scanning SMB filesystems.
158 Added warning message about known issue with WindowsApps folder.
160 Added instructions for building from source on Windows.
162 VSS support is no longer marked "experimental".
164 Added missing license file for libdivsufsort-lite.
167 Added experimental support for Windows VSS (Volume Shadow Copy Service).
168 The new '--snapshot' argument to 'wimcapture' makes wimlib automatically
169 create and use a temporary VSS snapshot when capturing a WIM image.
171 Implemented setting of Windows-specific XML information, such as
172 architecture, system root, and version details. This information is now
173 automatically set in newly captured WIM images, when appropriate.
175 Improved performance of directory tree scans on Windows.
177 On Windows, to improve capture performance, wimlib now sometimes opens
178 files by inode number rather than by path. This is enabled for
179 wimcapture and wimappend, but for now other applications have to opt-in.
181 The progress messages printed by wimlib-imagex while writing WIM files
182 have been slightly tweaked.
184 Progress information for directory tree scans now counts all hard links.
185 Also, on Windows "\\?\" is no longer stripped from the current path.
187 Added a new '--image-property' option to 'wimcapture', 'wimappend', and
188 'wiminfo'. This option lets you assign values to elements in a WIM
189 file's XML document by name.
191 The wimlib_get_image_property() and wimlib_set_image_property() API
192 functions now support numerically indexed elements.
194 Fixed a bug where, on Windows, wimlib would change the security
195 descriptor of the target directory of an extraction even when the
196 '--no-acls' option was specified.
199 Fixed a bug with libntfs-3g extraction present since v1.8.1. Sometimes,
200 some Microsoft software would not correctly recognize data in the
201 resulting filesystem.
203 Made some small improvements to the compression algorithms:
204 LZX compression ratio was slightly improved.
205 XPRESS compression ratio and speed was slightly improved.
206 LZMS compression speed was slightly improved.
208 Improved handling of WIM XML data. wimlib no longer drops unrecognized
209 elements when exporting images. In addition, two API functions were
210 added for better access to elements in the XML document:
211 wimlib_get_image_property() and wimlib_set_image_property().
213 Added support for (unsafe) in-place compaction of WIM files.
215 Improved performance of image export by reusing metadata resources
216 instead of always rebuilding and recompressing them.
218 Improved performance of wimlib_update_image() by delaying the update to
219 the WIM's XML document until a write is requested.
221 On Windows, the target of an extraction may now be a reparse point
222 (which will be dereferenced).
224 On Windows, wimlib now correctly restores non-Microsoft reparse points.
225 However, this remains broken in NTFS-3g mode due to a libntfs-3g bug.
227 On Windows, wimlib now has improved performance when archiving files
228 from a filesystem backed by a WIM (a "WIMBoot" setup).
230 Several improvements to System Compression (compact mode) support:
232 wof.sys (or wofadk.sys) is now automatically attached to the
233 target volume if needed.
235 Compact-mode extractions now work correctly with wofadk.sys on
236 older versions of Windows.
238 For compatibility with the Windows bootloader, the requested
239 compression format now is overridden on certain files.
241 Other minor bugfixes.
244 This release primarily contains various minor bug fixes and
245 improvements, including:
247 Improved handling of deep directory structures.
249 Fixed a bug where on 32-bit systems, the library could enter an
250 infinite loop if a WIM file was malformed in a specific way.
252 Added a workaround for a case where libntfs-3g may report
253 duplicate streams in an NTFS file.
255 Windows symbolic links and junctions in mounted WIM images are
256 now automatically rewritten to be valid in the mounted location.
258 Reparse point fixes: correctly handle the "ReparseReserved"
259 field, and correctly handle "empty" (data-less) reparse points.
261 On Windows, wimlib now acquires SeManageVolumePrivilege, which
262 is needed to create externally backed files using the
265 Improved validation of filenames.
267 Improved LZMS decompression speed.
269 The configure script now honors alternate pkg-config settings.
271 Links have been updated to point to the new website.
273 In addition, experimental support has been added for compressing
274 extracted files using System Compression on Windows 10. This
275 functionality is available through the new '--compact' option to
276 'wimapply' and 'wimextract' as well as new library flags.
279 Fixed a bug in the LZX decompressor: malicious input data could cause
280 out of bounds writes to memory (since wimlib v1.2.2).
282 The output of the 'wiminfo' command now consolidates various boolean
283 flags (such as "Relative path junction") into a single line.
285 A file can now have both an unnamed data stream ("file contents") and a
286 reparse point stream. Such files can exist as a result of the use of
287 certain Windows features, such as offline storage, including "OneDrive".
288 wimlib will now store and restore both streams on Windows as well as in
289 NTFS-3g mode. Microsoft's WIMGAPI also has this behavior.
291 On Windows, named data streams of encrypted files are no longer stored
292 twice in WIM archives.
294 On Windows, named data streams are now correctly extracted to existing
295 "readonly" directories. Before, an error would be reported.
297 On Windows, it is now possible to do a "WIMBoot mode" extraction with
298 non-standalone WIMs such as delta WIMs.
300 On Windows, when doing an extraction in "WIMBoot mode", files larger
301 than 4 gigabytes are now never extracted as externally backed. This
302 works around a bug in Microsoft's "WOF" driver.
304 The '--enable-verify-compression' configure option has been removed. If
305 you want to verify a WIM file, use the 'wimverify' program.
307 The way the "file count", "directory count", "total bytes", and "hard
308 link bytes" image statistics (stored in the WIM XML data) is calculated
309 has been slightly changed.
311 In mounted WIM images, the disk usage provided for each file (st_blocks)
312 is now the compressed size rather than the uncompressed size.
314 The performance of the NTFS-3g and Windows capture modes has been
317 On UNIX-like systems, symbolic links whose targets contain the backslash
318 character are now handled correctly (losslessly).
321 Improved the LZX compressor. It is now 15-20% faster than before and
322 provides a slightly better compression ratio.
324 Improved the LZMS compressor. It now provides a compression ratio
325 slightly better than WIMGAPI while still being faster and using slightly
328 The compression chunk size in solid resources, e.g. when capturing or
329 exporting a WIM file using the '--solid' option, now defaults to 64 MiB
330 (67108864 bytes) instead of 32 MiB (33554432 bytes). This provides a
331 better compression ratio and is the same value that WIMGAPI uses. The
332 memory usage is less than 50% higher than wimlib v1.7.4 and is slightly
333 lower than WIMGAPI's memory usage, but if it is too much, it is still
334 possible to choose a lower value, e.g. with the '--solid-chunk-size'
335 option to wimlib-imagex.
337 The '--chunk-size' and '--solid-chunk-size' options to wimlib-imagex now
338 accept the 'K', 'M', and 'G' suffixes.
340 Files are now sorted by name extension when creating a solid WIM file.
342 Fixed various issues related to capture/apply of EFS-encrypted files on
345 The file list printed by 'wimdir' is now sorted by the platform-specific
346 case sensitivity setting, rather than always case sensitively. This
347 also affects the library function wimlib_iterate_dir_tree().
349 On Windows, some error and warning messages have been improved.
352 The Windows binary distribution no longer contains third party DLLs.
353 These dependencies are instead compiled directly into the libwim DLL.
355 Added more fixes for wimlib on non-x86 architectures such as ARM.
357 Extracting files to a Windows PE in-memory filesystem no longer fails if
358 the target files do not yet exist.
360 Improved the performance of XPRESS compression and LZMS decompression.
362 Enabled SSSE3 accelerated SHA-1 computation in x86_64 Windows builds.
363 It will automatically be faster on newer Intel and AMD processors.
365 Removed the --with-imagex-progname and --enable-more-assertions
369 Fix for very slow export from solid WIM / ESD files.
371 Fix for LZX and LZMS algorithms on non-x86 architectures, such as ARM.
373 New progress message: WIMLIB_PROGRESS_MSG_HANDLE_ERROR. Applications
374 may use this to treat some types of errors as non-fatal.
376 The library now permits making in-memory changes to a WIMStruct backed
377 by a read-only WIM file.
379 Fixes for "WIMBoot" extraction mode (Windows only):
381 When not using the WOF driver, extraction no longer fails if the
382 disk containing the WIM file has too many partitions.
384 When matching patterns in [PrepopulateList], all hard links of
385 each file are now considered.
387 The system registry files are now automatically treated as being
388 in [PrepopulateList].
390 Added a hack to try to work around an intermittent bug in
391 Microsoft's WOF (Windows Overlay Filesystem) driver.
394 Made more improvements to the XPRESS, LZX, and LZMS compressors.
396 A number of improvements to the Windows port:
398 Fixes for setting short filenames.
400 Faster "WIMBoot" extraction.
402 Updated and slimmed down the dependent DLLs.
404 ACL inheritence bits are now restored.
406 Mandatory integrity labels are now backed up and restored.
408 Added a workaround for an issue where in rare cases, wimlib could create
409 a compressed data stream that could not be read correctly by Windows
410 after an extraction in "WIMBoot" mode.
413 Added file count progress data for
414 WIMLIB_PROGRESS_MSG_EXTRACT_FILE_STRUCTURE and
415 WIMLIB_PROGRESS_MSG_EXTRACT_METADATA.
417 Added support for testing file exclusions via the user-provided
420 Some documentation improvements.
422 Made some clarifications to the license text in the COPYING file.
425 Made more improvements to the XPRESS, LZX, and LZMS compressors.
427 The default compression mode for wimcapture is now LZX compression in
428 its default mode, which is the same as '--compress=maximum'.
430 You can now specify an optional integer compression level to the
431 '--compress' option; e.g. '--compress=lzx:75'.
433 Made a minor change to the LZMS compressor and decompressor to fix an
434 incompatibility with the Microsoft implementation. In the unlikely
435 event that you created an LZMS-compressed WIM with wimlib v1.7.0 or
436 earlier and a checksum error is reported when extracting files from it
437 with wimlib v1.7.1, decompress it with v1.7.0 then compress it with
440 Added 'verify' subcommand to wimlib-imagex.
442 Notable library changes:
444 Custom compressor parameters have been removed from the library
445 in favor of the simpler level-based API.
447 Decompressor parameters have been removed entirely.
449 Library users can now specify a custom file for warning and
450 error messages to be sent to, rather than the default of
453 New progress messages:
454 WIMLIB_PROGRESS_MSG_EXTRACT_FILE_STRUCTURE,
455 WIMLIB_PROGRESS_MSG_EXTRACT_METADATA.
457 New function: wimlib_verify_wim().
460 Improved compression, decompression, and extraction performance.
462 Improved compatibility with version 3584 WIM / ESD files:
463 - Add support for reading and writing multiple solid blocks per
464 archive, which WIMGAPI/DISM can create when appending an image.
465 - Correctly create solid blocks larger than 4 GiB.
467 'add' commands passed to wimupdate will now replace existing
468 nondirectory files by default. Use the --no-replace option to get the
471 The license for the library now contains an exception that allows using
472 it under the LGPL. See the COPYING file for details.
474 In reparse-point fixup mode (the default for capture), symbolic links
475 and junctions that point outside the tree being captured are no longer
476 excluded from capture.
478 Added support for "WIMBoot" capture and extraction. See the
479 documentation for the new '--wimboot' option to wimcapture and wimapply
480 for more information.
482 On UNIX-like systems, you can now backup and restore device nodes, named
483 pipes, and sockets. In addition, 32-bit user and group IDs are now
486 The way that UNIX data is stored in WIM files has been changed. If you
487 captured any WIMs with the --unix-data option, to upgrade them you'll
488 need to apply them with --unix-data using wimlib-imagex v1.6.2, then
489 re-capture them with --unix-data using this version.
491 wimlib now understands tagged metadata items, such as object IDs, that
492 can be stored in WIM directory entries.
494 Removed the --hardlink and --symlink options to wimapply, since I don't
495 think they are too useful and they got in the way of improving the code.
497 WIMs will now retain their GUIDs when rebuilt (e.g. with wimoptimize).
499 The 'mkwinpeimg' script now supports writing the ISO image to standard
502 The <ARCH> element in WIM XML data is now exported correctly.
504 On Windows, sparse file attributes are no longer set on extracted files.
505 Oddly enough, this actually saves disk space in some cases.
507 On UNIX, configuring with --disable-xattr or --enable-xattr is no longer
508 supported. Mounting WIM images now always requires extended attribute
509 support. Use --without-fuse to disable support for mounting WIM images;
510 this will also disable the need for extended attribute support.
512 Configuring with --enable-ssse3-sha1 now works correctly.
514 The shared library version has been bumped up. The main
515 incompatibilities are:
517 - WIMLIB_COMPRESSION_TYPE_XPRESS is now 1 and
518 WIMLIB_COMPRESSION_TYPE_LZX is now 2 (so it's the same as
521 - User-provided progress functions are now registered using a
522 separate function, wimlib_register_progress_function(). The
523 'progress_func' argument to many functions no longer exists.
525 - The return value from user-provided progress functions is now
528 - A context argument has been added to the prototype of
529 user-provided progress functions.
531 - 'struct wimlib_capture_config' has been removed. The library
532 now takes the path to the configuration file directly. This
533 affects wimlib_add_image(), wimlib_add_image_multisource(),
534 and wimlib_update_image(). However, a NULL value passed in
535 the argument retains the same meaning.
537 - Removed deprecated functions: some (de)compression functions,
538 wimlib_extract_files(), and wimlib_print_metadata().
540 - Removed extraction flags: WIMLIB_EXTRACT_FLAG_HARDLINK,
541 WIMLIB_EXTRACT_FLAG_SYMLINK, WIMLIB_EXTRACT_FLAG_FILE_ORDER,
542 and WIMLIB_EXTRACT_FLAG_SEQUENTIAL.
544 - Removed some progress messages:
545 WIMLIB_PROGRESS_MSG_APPLY_TIMESTAMPS,
546 WIMLIB_PROGRESS_MSG_EXTRACT_DIR_STRUCTURE_BEGIN,
547 WIMLIB_PROGRESS_MSG_EXTRACT_DIR_STRUCTURE_END. Numbering
550 - Removed some error codes. Numbering stays the same.
552 - Replaced WIMLIB_UNMOUNT_FLAG_LAZY with
553 WIMLIB_UNMOUNT_FLAG_FORCE.
555 - WIM paths passed to progress functions now have a leading
559 Case-insensitive comparisons of strings (e.g. filenames) containing
560 UTF-16 codepoints above 32767 are now done correctly.
562 Fixed build failure on Mac OS X.
564 wimunmount now provides the '--new-image' option to cause changes to a
565 read-write mounted image to be committed as a new image rather than as
566 an update of the mounted image. (The corresponding new library flag is
567 WIMLIB_UNMOUNT_FLAG_NEW_IMAGE.)
569 The LZMS ("recovery") compression chunk size, or "dictionary size", may
570 now be up to 1 GiB (1,073,741,824 bytes).
572 The performance of LZX ("maximum") and LZMS ("recovery") compression
573 with large chunk sizes has been slightly improved.
576 Stored files with size exactly 4 GiB (4,294,967,296 bytes) are now
577 decompressed correctly.
579 Fixed a bug in the LZX compressor introduced in v1.5.3. The bug
580 occurred in an unlikely case, and due to validity checks it did not
581 affect successfully created archives.
583 Fixed a minor compatibility issue with the LZMS compressor and
584 decompressor. This is *not* the default compression type and was only
585 introduced in v1.6.0. In the unlikely event that you created an
586 LZMS-compressed WIM with v1.6.0 and a checksum error is reported when
587 applying it with v1.6.1, decompress it with v1.6.0 then compress it with
590 Memory usage for LZMS and LZX compression has been decreased.
592 wimextract now allows wildcard characters in paths specified on the
593 command line. Also, the '--strict-wildcards' option has been removed
594 and replaced with the inverse option '--nullglob'. See the
595 documentation for wimextract for more details and changes.
597 The wimlib_extract_files() function is now considered deprecated in
598 favor of wimlib_extract_paths().
600 Fixed more permissions problems when extracting files on Windows.
602 A new '--no-attributes' option has been added to wimapply and
603 wimextract. The library flag is WIMLIB_EXTRACT_FLAG_NO_ATTRIBUTES.
605 The default chunk size is now set correctly when changing the
606 compression type of a WIM, for example with 'wimoptimize'.
608 The '--metadata' option to wiminfo has been replaced with the
609 '--detailed' option to wimdir.
611 In relevant wimlib-imagex commands, '--solid' may now be used as an
612 alias for '--pack-streams'.
615 Support for extracting and updating the new version 3584 WIMs has been
616 added. These WIMs typically pack many streams ("files") together into a
617 single compressed resource, thereby saving space. This degrades the
618 performance of random access (such as that which occurs on a mounted
619 image), but optimizations have been implemented for extraction. These
620 new WIM files also typically use a new compression format (LZMS), which
621 is similar to LZMA and can offer a better compression ratio than LZX.
622 These new WIM files can be created using `wimcapture' with
623 the '--compress=lzms --pack-streams' options. Note: this new WIM format
624 is used by the Windows 8 web downloader, but important segments of the
625 raw '.esd' files are encrypted, so wimlib will not be able to extract
626 such files until they are first decrypted.
628 wimlib now supports extracting files and directories from a WIM image
629 based on a "listfile" that itself contains the list of paths to extract.
630 For `wimextract', the syntax is to specify @LISTFILE instead of a PATH,
631 and for the library itself, the new APIs are wimlib_extract_pathlist()
632 and wimlib_extract_paths(). Path globs containing wildcard characters
635 For searching WIM files, wimlib now has configurable case sensitivity.
636 The default on Windows is still case-insensitive and the default on
637 UNIX-like systems is still case-sensitive, but this can be overridden
638 on either platform through flags to wimlib_global_init(). For
639 `wimlib-imagex', the environmental variable WIMLIB_IMAGEX_IGNORE_CASE
640 can be set to 1 or 0 for case-insensitive or case-sensitive behavior,
643 Support for compression chunk sizes greater than the default of 32768
644 bytes has been added. A larger chunk size typically results in a better
645 compression ratio. However, the MS implementation is seemingly not
646 compatible with all chunk sizes, especially for LZX compression, so the
647 defaults remain unchanged, with the exception of the new LZMS-compressed
648 WIMs, which use a larger chunk size by default.
650 The compression/decompression API exported by wimlib has been changed.
651 Now one set of functions handles all supported compression formats.
653 `wimcapture' and `wimappend' will now display the progress of scanning
654 the directory tree to capture, in addition to the progress of writing
655 data to the WIM. The '--verbose' option no longer does anything. The
656 library API change for this is the addition of several members to
657 `struct wimlib_progress_info_scan' available to progress callbacks.
659 `mkwinpeimg' now correctly handles the '--start-script' option when the
660 start script is not in the working directory.
662 Sequential extraction, previously requested by using
663 WIMLIB_EXTRACT_FLAG_SEQUENTIAL, is now the default.
664 WIMLIB_EXTRACT_FLAG_FILE_ORDER can be used to get the old default
665 behavior (extract in file order).
668 The new LZX compressor added in v1.5.2 has been improved and is now
669 enabled by default, except when `wimcapture' or `wimappend' is run
670 *without* the '--compress' option, in which case the faster LZX
671 compressor is used (the same as before). This behavior is reasonably
672 consistent with ImageX which actually uses "fast" (XPRESS) compression
673 by default. In those cases, use '--compress=maximum' to explicitly
674 capture a WIM image using the new (slower but better) LZX compressor.
676 The '--compress-slow' option still exists to `wimlib-imagex optimize',
677 but its new behavior is to tweak the new LZX compressor even more to
678 produce an even better compression ratio at the cost of more time spent
681 `wimlib-imagex optimize' now supports the '--compress=TYPE' option,
682 which recompresses the WIM file using the specified compression TYPE.
683 The new library API function used for this is
684 wimlib_set_output_compression_type().
686 Added the wimlib_get_xml_data() function to allow library clients to
687 easily retrieve the raw XML data from a WIM file if needed.
689 Fixed a bug that could cause an error code to be incorrectly returned
690 when writing XML data containing a <WINDOWS> element.
692 Mounted WIM images will now correctly show the default file stream even
693 if appears in the alternate data stream entries of the corresponding WIM
697 Added a new experimental LZX compressor which can be enabled by passing
698 '--compress-slow' to `wimlib-imagex capture' or `wimlib-imagex
699 optimize'. (The latter is only applicable if the WIM is already
700 LZX-compressed and the '--recompress' option is also given.) The
701 experimental compressor is much slower but compresses the data slightly
702 more --- currently usually to within a fraction of a percent of the
703 results from WIMGAPI/ImageX.
705 A workaround has been added for compatibility with versions of WinPE
706 that interpret alternate data stream entries in the boot WIM
709 An alignment bug that caused a crash in the LZX decompressor on some
712 wimlib now attempts to clear the WIM_HDR_FLAG_WRITE_IN_PROGRESS flag in
713 the WIM header when restoring the previous state of a WIM it failed to
716 Added a workaround to avoid an access denied error on Windows when
717 replacing a WIM file that another process has opened.
720 wimlib can now open WinPE WIMs from WAIK v2.1, which had a quirk that
721 needed to be handled.
723 A bug in the interpretation of negative IMAGE indices in the
724 --update-of=[WIMFILE:]IMAGE option to `wimlib-imagex capture' and
725 `wimlib-imagex append' has been fixed.
727 A workaround has been added to successfully apply security descriptors
728 with empty DACLs when the NTFS-3g apply mode is being used with NTFS-3g
729 2013.1.13 or earlier.
731 `wimlib-imagex capture' can now accept the '--delta-from' option
735 Added support for "pipable" WIMs. Pipable WIMs allow capturing images
736 to standard output and applying images from standard input, but they are
737 not compatible with Microsoft's software and are not created by default.
738 See the documentation for --pipable flag of `wimlib-imagex capture' for
741 To better support incremental backups, added support for declaring an
742 image as a modified form of another image. See the documentation for
743 the '--update-of' option of `wimlib-imagex append' and `wimlib-imagex
746 Added supported for "delta" WIMs. See the documentation for the
747 '--delta-from' option of `wimlib-imagex capture'.
749 The library support for managing split WIMs has been changed to support
750 other arrangements, such as delta WIMs, and be easier to use. This
751 change is visible in `wimlib-imagex', which also can now accept the
752 '--ref' option multiple times, and also now supports "delta" WIMs as
755 wimlib now preserves WIM integrity tables by default, even if
756 WIMLIB_WRITE_FLAG_CHECK_INTEGRITY is not specified. This changes the
757 behavior of `wimlib-imagex' whenever the WIM being operated on contains
758 an integrity table and the '--check' option is not specified.
760 `wimlib-imagex capture' now creates LZX-compressed WIMs by default
761 (when --compress is not specified). This provides the best compression
762 ratio by default, which is usually what is desired, at a cost of some
765 `wimlib-imagex' now supports being invoked as wimCOMMAND, where COMMAND
766 is the command as in `wimlib-imagex COMMAND'; for example, it can be
767 invoked as `wimapply' as an alternative to `wimlib-imagex apply'. The
768 appropriate hard links are created in UNIX installations of
769 `wimlib-imagex', while for the Windows distribution of `wimlib-imagex',
770 batch files that emulate this behavior are generated.
772 Security descriptors are now extracted correctly on Windows.
774 Fixed archiving DOS names in NTFS-3g capture mode.
776 The extraction code has been rewritten and it will now be easier to
777 support new features on all supported backends (currently Win32, UNIX,
778 and NTFS-3g). For example, hard-linked extraction mode (--hardlink) is
779 now supported on all backends, not just UNIX.
781 `mkwinpeimg' now supports grabbing files from the WAIK supplement rather
782 than the WAIK itself.
784 wimlib_global_init() now, by default, attempts to acquire additional
785 privileges on Windows, so library clients need not do this.
787 This update bumps the shared library version number up to 9, since it is
788 not binary compatibible with previous releases.
791 Fixed bug in `wimlib-imagex export' that made it impossible to export an
792 image from a WIM that is readonly at the filesystem level.
794 Return error code rather than segfaulting when trying to list files from
795 a non-first part of a split WIM.
797 Joining a WIM will now preserve the RP_FIX and READONLY flags.
800 On Windows, paths given to wimlib-imagex are now treated case
803 Improved behavior regarding invalid filenames; in particular, on
804 Windows, wimlib-imagex will, when extracting, now omit (with an option
805 to override this default) filenames differing only in case, or filenames
806 containing characters not valid on Windows.
808 On Windows, wimlib now supports capturing and extracting long paths
809 (longer than the so-called MAX_PATH).
811 On Windows, `wimlib-imagex update' now acquires proper privileges when
812 running as an Administrator.
814 `wimlib-imagex update' will now complain if no image is specified when
815 trying to update a multi-image WIM.
817 `wimlib-imagex update' now supports specifying a single update command
818 directly on the command line using the --command option.
820 wimlib-imagex will now choose different units for progress messages,
821 depending on the amount of data that needs to be processed.
823 `wimlib-imagex append' will now generate a unique WIM image name if no
824 name is specified and the defaulted name already exists in the WIM.
826 wimlib now allows you to create unnamed WIM images, which can then only
827 be referred to by index.
829 wimlib now allows you to explicitly declare you want write access to a
830 WIM by providing the WIMLIB_OPEN_FLAG_WRITE_ACCESS flag to
833 wimlib now respects the WIM_HDR_FLAG_READONLY flag when set in the WIM
836 Progress callbacks have been added to wimlib's wimlib_update_image()
839 Added wimlib_get_wim_info(), wimlib_set_wim_info(),
840 wimlib_iterate_dir_tree(), and wimlib_iterate_lookup_table() functions
843 NTFS-3g capture now only warns about two conditions previously treated
846 Fixed a couple issues with using wimlib-imagex on UDF filesystems on
849 wimlib now correctly detects and returns an error when reading a WIM
850 image with a cyclic directory structure. (Fun fact: such a WIM will
851 crash Microsoft's software.)
854 Added new "extract" and "update" subcommands to wimlib-imagex, along
855 with associated APIs in the library. These commands are intended mainly
856 for Windows use but can be used on UNIX as well.
858 Many documentation improvements.
860 Fixed a bug in the Windows build where relative symbolic links were not
861 captured in reparse-point fixup mode.
863 Fixed a bug in the Windows build where file handles were left open to
864 the WIM file, causing `wimlib_imagex optimize' to fail in some cases.
866 Fixed a bug in the Windows build of wimlib-imagex where globbing
867 split-WIM parts could cause the program to crash.
869 Fixed a bug where the creation time of WIM images would be shown instead
870 of the last modification time.
872 With the Windows build it is now possible to restore a WIM containing
873 symbolic links as a non-Administrator; however you will receive warnings
874 about not being able to extract the symbolic links.
877 Capturing a WIM image should now be significantly faster in most cases
878 due to improved use of the operating system's cache and avoiding reading
879 files twice whenever possible.
881 The Windows build should now work on Windows XP.
883 The Windows build now supports capturing and restoring hidden,
884 compressed, sparse, and encrypted files.
886 The Windows build now supports capturing and applying WIM images from
887 filesystems other than NTFS (with some reduced functionality).
889 The Windows build now extracts short names correctly.
891 Added support for "reparse-point" fixups (i.e. fixing up of symbolic
892 links). See docs for --rpfix and --norpfix flags of `wimlib-imagex
893 capture' and `wimlib-imagex apply'.
895 The performance of splitting and joining WIMs should be slightly
898 The LZX and XPRESS compression and decompression functions are now
899 exported from the library.
902 Improvements and bugfixes for the Windows build.
904 Added --strict-acls options.
906 Fixed the way that wimlib determines the order of images in the WIM.
909 Since wimlib can now be used on Windows, wimlib's implementation of
910 ImageX has been renamed to wimlib-imagex to avoid confusion with
911 Microsoft's implementation of ImageX, which would have the same file
912 name ("imagex.exe"). If you really don't like this you can pass the
913 --with-imagex-progname option to `configure' to choose a different name,
914 or even simply rename the binary yourself (but the former way will
915 configure the man pages to use the chosen name).
917 Various bugs fixed in the Windows build. Mainly to do with capturing
918 and restoring alternate data streams correctly in weird cases, and
919 requesting the correct privileges when opening files. Also added the
920 --noacls options to wimlib-imagex capture, append, and apply.
922 Windows build again: FindFirstStreamW() and FindNextStreamW() are now
923 dynamically loaded, so this may make the library compatible with Windows
924 XP (however, there may still be other problems).
927 Added experimental support for native Windows builds. Binaries can be
928 downloaded from the SourceForge page.
930 --source-list option added to `imagex capture' and `imagex append'.
932 Better support for different character encodings.
935 Storing UNIX file owners, groups, and modes in WIM images is now
936 possible using `imagex capture' with the --unix-data flag.
938 Minor bug fixes and documentation fixes.
941 NTFS capture: Fixed capturing duplicate reparse points.
943 NTFS capture: Capture first unnamed stream if there are more than one
944 (print warning instead of error).
946 Allow multiple test cases to execute concurrently (e.g. make -j2 check).
949 Added --arch switch to mkwinpeimg script to support getting AMD64 WinPE
952 Update to work with ntfs-3g version 2013.1.13.
955 Fixed truncating file to shorter but non-zero length on read-write
958 Various code cleanups and minor documentation fixes.
961 LZX and XPRESS decompression have received some additional optimizations
962 and should now be even faster. (Although, they were already pretty
963 fast--- much faster than typical I/O speeds.)
965 Fixed a bug introduced in v1.2.1 that would cause a directory tree
966 containing hard links to be captured incorrectly in some cases.
969 By default, unmounting a read-write mounted WIM with 'imagex unmount
970 --commit' will now change the WIM in-place without needing to write the
971 entire WIM again. Use 'imagex unmount --commit --rebuild' to get the
974 'imagex unmount' no longer has a hard-coded limit of 10 minutes to wait
975 for a response from the daemon servicing the mounted WIM. Instead,
976 every second 'imagex unmount' will check if the daemon is still alive,
977 and keep waiting if so, otherwise terminate with an error.
979 'imagex unmount --commit' on a read-write mounted WIM will now print
980 progress information regarding the writing of new or modified streams
981 the WIM, just like when capturing or appending a WIM.
983 A small change has been made to XPRESS compression and it should improve
984 the compression ratio slightly.
986 A change was made that may improve performance slightly when applying a
987 WIM image to a NTFS volume.
989 Microsoft has managed to introduce even more bugs into their software,
990 and now the WIMs for Windows 8 have incorrect (too low) reference counts
991 for some streams. This is unsafe because such streams can be removed
992 when they are in actuality still referenced in the WIM (perhaps by a
993 different image). wimlib will now work around this problem by fixing
994 the stream reference counts. This is only done when wimlib_delete_image() is
995 called ('imagex delete') or when wimlib_mount_image() is called with
996 WIMLIB_MOUNT_FLAG_READWRITE ('imagex mountrw'). Please note that this
997 requires reading the metadata for all images in the WIM, so this will
998 make these operations noticably slower on WIMs with multiple images.
1000 Various other bugfixes.
1003 Appending images to a WIM is now be done by default without re-building
1004 the whole WIM. Use the --rebuild flag to get the old behavior (which
1005 was to re-build the entire WIM when a new image is appended).
1007 A new command `imagex optimize' is now available to manually re-build a
1008 WIM that has wasted space due to repeated appends.
1010 Progress information has been improved, and now arbitrary callback
1011 functions can be used to show the progress of a WIM operation.
1013 A possible bug with changing the bootable image of a WIM was fixed.
1015 Some advisory locking is now done to prevent two processes from
1016 modifying a WIM at the same time (but only in some cases). For example,
1017 you cannot mount two images from a WIM read-write at the same time.
1019 Some functions have been reorganized:
1020 * wimlib_mount() renamed to wimlib_mount_image().
1021 * wimlib_unmount() renamed to wimlib_unmount_image().
1022 * wimlib_overwrite_xml_and_header() removed as
1023 wimlib_overwrite() suffices now.
1024 * wimlib_apply_image_to_ntfs_volume() removed as
1025 wimlib_extract_image() suffices now.
1026 * wimlib_add_image_from_ntfs_volume() removed as
1027 * wimlib_add_image() suffices now.
1029 Previously, the soname of libwim.so has been 0.0.0, despite many
1030 interface changes. The soname is now updated to 1.0.0 and will now be
1031 updated each release.
1034 Resources will now be compressed using multiple threads by default.
1035 (This applies to `imagex capture', `imagex append', and `imagex
1038 Some performance improvements in mounted WIMs.
1040 More progress information is shown when capturing a WIM.
1043 Lots of minor fixes, code cleanups, and some documentation updates.
1044 Nothing in particular is really noteworthy.
1047 LZX and XPRESS compression improvements.
1049 Fixed calculation of Directory Count, File Count, Total Bytes, and Hard
1050 Link Bytes of the WIM.
1053 Fixed bug when capturing NTFS file with multiple named data streams.
1055 Internally, we are now using inode structures, even though these don't
1056 appear literally in the WIM file. This simplifies some of the code
1057 (mainly for WIM mounting) and likely fixed a few problems, although it
1061 Fixed problem when exporting images from XPRESS to LZX compressed WIM or
1065 Enough changes to call it version 1.0.0!
1067 Capturing a WIM directly from a NTFS volume, and applying a WIM directly
1068 to a NTFS volume, is now supported.
1070 Hard links and symbolic links have much improved support. They are
1071 supported for WIM capture, WIM application, and mounted WIMs (you can
1072 even make them on read-write mounted WIMs).
1074 Alternate data streams are now supported on mounted WIMs through an
1075 xattr or a Windows-style stream interface. Also they are supported when
1076 capturing a WIM from NTFS or applying a WIM to NTFS.
1078 Split WIMs are better supported. You may now apply an image directly
1079 from a split WIM, mount an image from a split WIM read-only, or export
1080 an image from a split WIM.
1082 Using a capture configuration file is now supported (but not fully yet).
1084 SHA1 message digests are checked in more places, so we can make sure
1085 applied and captured data is correct.
1087 Man pages have been updated and consolidated.
1090 Fixed segfault when unmounting read-only WIM.
1093 Support for joining and splitting WIMs.
1094 Also, security data is now preserved by default.
1097 Can now build with older gcc and system headers, like on CentOS 5.
1100 Fixed bug that made it impossible to overwrite files in read-write
1104 Write byte-order mark before WIM XML data. (imagex.exe requires this to
git://wimlib.net / wimlib / blob