2 Prevented miscompilation with gcc 10 at -O3
3 (https://gcc.gnu.org/bugzilla/show_bug.cgi?id=94994).
5 Avoided some compiler warnings with gcc 9 and later.
7 The 'mkwinpeimg' script now also looks for syslinux modules in
8 /usr/share/syslinux, to handle where openSUSE installs them.
10 Removed obsolete packaging files from the source tree.
13 Fixed a crash or incorrect output during LZMS compression with a
14 compression level greater than 50 and a chunk size greater than 64 MiB.
15 This affected wimlib v1.8.0 and later. In the unlikely event that you
16 used all these non-default compression settings in combination, e.g.
17 'wimcapture --solid --solid-compress=LZMS:100 --solid-chunk-size=128M',
18 run 'wimverify' on your archives to verify your data is intact.
21 On Windows, wimlib now supports capturing and applying extended
22 attributes (EAs). It is compatible with DISM with the /EA option,
23 available since Windows 10 version 1607. wimlib's EA support is on by
24 default and works on older versions of Windows too.
26 Partially fixed a bug where [ExclusionException] entries didn't take
27 effect when the containing directory is matched by [ExclusionList]. It
28 now works when the [ExclusionException] patterns are absolute. For
29 example, listing "/dir/file" in [ExclusionException] now works even if
30 "/dir" is matched by [ExclusionList].
32 Added a '--create' option to 'wimappend' which makes it create the WIM
33 file (like 'wimcapture') if it doesn't exist yet.
35 Added an '--include-integrity' option to various wimlib-imagex commands.
36 '--include-integrity' is like '--check', but it will just include an
37 integrity table in the output WIM(s), while skipping verification of any
38 existing integrity tables. This can be useful to avoid unwanted
39 verification of large WIM files, e.g. WIMs given by '--delta-from'.
41 'wimextract' now reads a pathlist file from standard input when "@-" is
44 wimsplit (API: wimlib_split()) now correctly handles a dot in the path
45 to the first split WIM part, prior to the filename extension.
47 'wimlib-imagex --version' now shows the version of the library it is
48 actually using (in case it is different from wimlib-imagex's version).
51 Fixed a bug that was causing the LZMS decompressor to be miscompiled
52 with GCC 7 (this broke extracting "solid" archives).
54 The Windows 10 Recycle Bin directory (\$RECYCLE.BIN) has been added to
55 the default exclusion list.
57 Added a '--quiet' option to wimlib-imagex.
59 The 'mkwinpeimg' script now also looks for the syslinux BIOS modules in
60 the directory /usr/lib/syslinux/modules/bios.
62 Files with timestamps before the year 1970 are now extracted correctly
63 to UNIX-style filesystems, are displayed correctly by
64 'wimdir --detailed', and show up correctly in mounted WIM images.
66 Files with timestamps after the year 2038 are now displayed correctly by
67 the 32-bit Windows build of wimlib.
70 Fixed a data corruption bug (incorrect compression) when storing an
71 already highly-compressed file in an LZX-compressed WIM with a chunk
72 size greater than or equal to 64K. Note that this is not the default
73 setting and such WIMs are not supported by Microsoft's WIM software, so
74 only users who used the --chunk-size option to wimlib-imagex or the
75 wimlib_set_output_chunk_size() API function may have been affected.
76 This bug was introduced in wimlib v1.10.0. See
77 https://wimlib.net/forums/viewtopic.php?f=1&t=300 for more details.
79 On all platforms, sparse files are now extracted as sparse.
81 Sparse files captured from UNIX-style filesystems are now marked as
82 sparse in the resulting WIM image.
84 Added support for storing Linux-style extended attributes in WIM images.
85 When the --unix-data option is used on Linux, wimlib-imagex now captures
86 and applies extended attributes, in addition to the already-supported
87 standard UNIX file permissions (owner/group/mode) and special files.
89 --delta-from is now supported by wimappend. (Previously it was only
90 supported by wimcapture.)
92 On Windows, improved the way in which files deduplicated with Windows'
93 Data Deduplication feature are captured.
95 The development files needed to link with wimlib using Visual Studio are
96 now included in the Windows release archives.
98 wimlib.h can now be included by Visual Studio without errors.
100 The example programs can now be compiled in C++ mode, and they also now
103 Updated 'mkwinpeimg' to work correctly on images that have a "windows"
104 (lower case) directory rather than a "Windows" (upper case) directory.
106 Fixed configuring with --enable-ssse3-sha1 from release tarball
107 (the file nasm_lt.sh was missing).
109 Made some documentation improvements.
112 The LZX compression ratio has been slightly improved. The default mode,
113 LZX level 50, is now almost as good as the old LZX level 100, while
114 being nearly the same speed as before.
116 Decompression performance has been slightly improved.
118 Filenames are now always listed in NTFS collation order.
120 On UNIX-like systems, wimlib can now process Windows filenames that are
121 not valid Unicode due to the presence of unpaired surrogates.
123 On UNIX-like systems, wimlib now always assumes UTF-8 encoding with the
124 addition of surrogate codepoints. Consequently, the environmental
125 variable WIMLIB_IMAGEX_USE_UTF8 and the flag
126 WIMLIB_INIT_FLAG_ASSUME_UTF8 no longer have any effect.
128 wimlib no longer depends on iconv.
130 Reduced memory usage slightly.
132 When a WIM image is applied in NTFS-3G mode, security descriptors are
133 now created in NTFS v3.0 format when supported by the volume.
135 Workarounds for bugs in libntfs-3g version 2013.1.13 and earlier have
136 been removed. Users are advised to upgrade to a later version of
139 On Windows, wimlib now supports case-sensitive filename extraction when
140 supported by the underlying operating system and filesystem (operating
141 system support requires a registry setting).
144 On UNIX, wimlib can now overwrite readonly files when extracting.
146 On Windows, fixed a bug where wimlib could leave a null DACL (a.k.a. "no
147 NTFS permissions") set on some existing directories after extraction.
149 On Windows, when applying a WIM image in "WIMBoot mode" when the WOF
150 driver is not loaded, wimlib can now correctly register a new WIM file
151 with the target volume when the target volume previously had had WIM
154 Added a new testing program.
156 Clarified the main license text and updated public domain dedications
157 for certain files to be more thorough.
160 Object IDs are now saved and restored on Windows and in NTFS-3G mode.
162 Reduced memory usage when exporting large numbers of WIM images.
164 Non UTF-8 locales are now detected correctly.
166 Addressed compiler warnings and enabled "silent" make rules by default.
168 Windows-specific updates:
169 Fixed a bug where duplicate backslashes could be generated in
170 link targets when extracting symbolic links and junctions.
172 Fixed a bug where the .cmd shortcuts for wimlib-imagex wouldn't
173 work if their full path contained a space.
175 Fixed bugs related to scanning SMB filesystems.
177 Added warning message about known issue with WindowsApps folder.
179 Added instructions for building from source on Windows.
181 VSS support is no longer marked "experimental".
183 Added missing license file for libdivsufsort-lite.
186 Added experimental support for Windows VSS (Volume Shadow Copy Service).
187 The new '--snapshot' argument to 'wimcapture' makes wimlib automatically
188 create and use a temporary VSS snapshot when capturing a WIM image.
190 Implemented setting of Windows-specific XML information, such as
191 architecture, system root, and version details. This information is now
192 automatically set in newly captured WIM images, when appropriate.
194 Improved performance of directory tree scans on Windows.
196 On Windows, to improve capture performance, wimlib now sometimes opens
197 files by inode number rather than by path. This is enabled for
198 wimcapture and wimappend, but for now other applications have to opt-in.
200 The progress messages printed by wimlib-imagex while writing WIM files
201 have been slightly tweaked.
203 Progress information for directory tree scans now counts all hard links.
204 Also, on Windows "\\?\" is no longer stripped from the current path.
206 Added a new '--image-property' option to 'wimcapture', 'wimappend', and
207 'wiminfo'. This option lets you assign values to elements in a WIM
208 file's XML document by name.
210 The wimlib_get_image_property() and wimlib_set_image_property() API
211 functions now support numerically indexed elements.
213 Fixed a bug where, on Windows, wimlib would change the security
214 descriptor of the target directory of an extraction even when the
215 '--no-acls' option was specified.
218 Fixed a bug with libntfs-3g extraction present since v1.8.1. Sometimes,
219 some Microsoft software would not correctly recognize data in the
220 resulting filesystem.
222 Made some small improvements to the compression algorithms:
223 LZX compression ratio was slightly improved.
224 XPRESS compression ratio and speed was slightly improved.
225 LZMS compression speed was slightly improved.
227 Improved handling of WIM XML data. wimlib no longer drops unrecognized
228 elements when exporting images. In addition, two API functions were
229 added for better access to elements in the XML document:
230 wimlib_get_image_property() and wimlib_set_image_property().
232 Added support for (unsafe) in-place compaction of WIM files.
234 Improved performance of image export by reusing metadata resources
235 instead of always rebuilding and recompressing them.
237 Improved performance of wimlib_update_image() by delaying the update to
238 the WIM's XML document until a write is requested.
240 On Windows, the target of an extraction may now be a reparse point
241 (which will be dereferenced).
243 On Windows, wimlib now correctly restores non-Microsoft reparse points.
244 However, this remains broken in NTFS-3g mode due to a libntfs-3g bug.
246 On Windows, wimlib now has improved performance when archiving files
247 from a filesystem backed by a WIM (a "WIMBoot" setup).
249 Several improvements to System Compression (compact mode) support:
251 wof.sys (or wofadk.sys) is now automatically attached to the
252 target volume if needed.
254 Compact-mode extractions now work correctly with wofadk.sys on
255 older versions of Windows.
257 For compatibility with the Windows bootloader, the requested
258 compression format now is overridden on certain files.
260 Other minor bugfixes.
263 This release primarily contains various minor bug fixes and
264 improvements, including:
266 Improved handling of deep directory structures.
268 Fixed a bug where on 32-bit systems, the library could enter an
269 infinite loop if a WIM file was malformed in a specific way.
271 Added a workaround for a case where libntfs-3g may report
272 duplicate streams in an NTFS file.
274 Windows symbolic links and junctions in mounted WIM images are
275 now automatically rewritten to be valid in the mounted location.
277 Reparse point fixes: correctly handle the "ReparseReserved"
278 field, and correctly handle "empty" (data-less) reparse points.
280 On Windows, wimlib now acquires SeManageVolumePrivilege, which
281 is needed to create externally backed files using the
284 Improved validation of filenames.
286 Improved LZMS decompression speed.
288 The configure script now honors alternate pkg-config settings.
290 Links have been updated to point to the new website.
292 In addition, experimental support has been added for compressing
293 extracted files using System Compression on Windows 10. This
294 functionality is available through the new '--compact' option to
295 'wimapply' and 'wimextract' as well as new library flags.
298 Fixed a bug in the LZX decompressor: malicious input data could cause
299 out of bounds writes to memory (since wimlib v1.2.2).
301 The output of the 'wiminfo' command now consolidates various boolean
302 flags (such as "Relative path junction") into a single line.
304 A file can now have both an unnamed data stream ("file contents") and a
305 reparse point stream. Such files can exist as a result of the use of
306 certain Windows features, such as offline storage, including "OneDrive".
307 wimlib will now store and restore both streams on Windows as well as in
308 NTFS-3g mode. Microsoft's WIMGAPI also has this behavior.
310 On Windows, named data streams of encrypted files are no longer stored
311 twice in WIM archives.
313 On Windows, named data streams are now correctly extracted to existing
314 "readonly" directories. Before, an error would be reported.
316 On Windows, it is now possible to do a "WIMBoot mode" extraction with
317 non-standalone WIMs such as delta WIMs.
319 On Windows, when doing an extraction in "WIMBoot mode", files larger
320 than 4 gigabytes are now never extracted as externally backed. This
321 works around a bug in Microsoft's "WOF" driver.
323 The '--enable-verify-compression' configure option has been removed. If
324 you want to verify a WIM file, use the 'wimverify' program.
326 The way the "file count", "directory count", "total bytes", and "hard
327 link bytes" image statistics (stored in the WIM XML data) is calculated
328 has been slightly changed.
330 In mounted WIM images, the disk usage provided for each file (st_blocks)
331 is now the compressed size rather than the uncompressed size.
333 The performance of the NTFS-3g and Windows capture modes has been
336 On UNIX-like systems, symbolic links whose targets contain the backslash
337 character are now handled correctly (losslessly).
340 Improved the LZX compressor. It is now 15-20% faster than before and
341 provides a slightly better compression ratio.
343 Improved the LZMS compressor. It now provides a compression ratio
344 slightly better than WIMGAPI while still being faster and using slightly
347 The compression chunk size in solid resources, e.g. when capturing or
348 exporting a WIM file using the '--solid' option, now defaults to 64 MiB
349 (67108864 bytes) instead of 32 MiB (33554432 bytes). This provides a
350 better compression ratio and is the same value that WIMGAPI uses. The
351 memory usage is less than 50% higher than wimlib v1.7.4 and is slightly
352 lower than WIMGAPI's memory usage, but if it is too much, it is still
353 possible to choose a lower value, e.g. with the '--solid-chunk-size'
354 option to wimlib-imagex.
356 The '--chunk-size' and '--solid-chunk-size' options to wimlib-imagex now
357 accept the 'K', 'M', and 'G' suffixes.
359 Files are now sorted by name extension when creating a solid WIM file.
361 Fixed various issues related to capture/apply of EFS-encrypted files on
364 The file list printed by 'wimdir' is now sorted by the platform-specific
365 case sensitivity setting, rather than always case sensitively. This
366 also affects the library function wimlib_iterate_dir_tree().
368 On Windows, some error and warning messages have been improved.
371 The Windows binary distribution no longer contains third party DLLs.
372 These dependencies are instead compiled directly into the libwim DLL.
374 Added more fixes for wimlib on non-x86 architectures such as ARM.
376 Extracting files to a Windows PE in-memory filesystem no longer fails if
377 the target files do not yet exist.
379 Improved the performance of XPRESS compression and LZMS decompression.
381 Enabled SSSE3 accelerated SHA-1 computation in x86_64 Windows builds.
382 It will automatically be faster on newer Intel and AMD processors.
384 Removed the --with-imagex-progname and --enable-more-assertions
388 Fix for very slow export from solid WIM / ESD files.
390 Fix for LZX and LZMS algorithms on non-x86 architectures, such as ARM.
392 New progress message: WIMLIB_PROGRESS_MSG_HANDLE_ERROR. Applications
393 may use this to treat some types of errors as non-fatal.
395 The library now permits making in-memory changes to a WIMStruct backed
396 by a read-only WIM file.
398 Fixes for "WIMBoot" extraction mode (Windows only):
400 When not using the WOF driver, extraction no longer fails if the
401 disk containing the WIM file has too many partitions.
403 When matching patterns in [PrepopulateList], all hard links of
404 each file are now considered.
406 The system registry files are now automatically treated as being
407 in [PrepopulateList].
409 Added a hack to try to work around an intermittent bug in
410 Microsoft's WOF (Windows Overlay Filesystem) driver.
413 Made more improvements to the XPRESS, LZX, and LZMS compressors.
415 A number of improvements to the Windows port:
417 Fixes for setting short filenames.
419 Faster "WIMBoot" extraction.
421 Updated and slimmed down the dependent DLLs.
423 ACL inheritence bits are now restored.
425 Mandatory integrity labels are now backed up and restored.
427 Added a workaround for an issue where in rare cases, wimlib could create
428 a compressed data stream that could not be read correctly by Windows
429 after an extraction in "WIMBoot" mode.
432 Added file count progress data for
433 WIMLIB_PROGRESS_MSG_EXTRACT_FILE_STRUCTURE and
434 WIMLIB_PROGRESS_MSG_EXTRACT_METADATA.
436 Added support for testing file exclusions via the user-provided
439 Some documentation improvements.
441 Made some clarifications to the license text in the COPYING file.
444 Made more improvements to the XPRESS, LZX, and LZMS compressors.
446 The default compression mode for wimcapture is now LZX compression in
447 its default mode, which is the same as '--compress=maximum'.
449 You can now specify an optional integer compression level to the
450 '--compress' option; e.g. '--compress=lzx:75'.
452 Made a minor change to the LZMS compressor and decompressor to fix an
453 incompatibility with the Microsoft implementation. In the unlikely
454 event that you created an LZMS-compressed WIM with wimlib v1.7.0 or
455 earlier and a checksum error is reported when extracting files from it
456 with wimlib v1.7.1, decompress it with v1.7.0 then compress it with
459 Added 'verify' subcommand to wimlib-imagex.
461 Notable library changes:
463 Custom compressor parameters have been removed from the library
464 in favor of the simpler level-based API.
466 Decompressor parameters have been removed entirely.
468 Library users can now specify a custom file for warning and
469 error messages to be sent to, rather than the default of
472 New progress messages:
473 WIMLIB_PROGRESS_MSG_EXTRACT_FILE_STRUCTURE,
474 WIMLIB_PROGRESS_MSG_EXTRACT_METADATA.
476 New function: wimlib_verify_wim().
479 Improved compression, decompression, and extraction performance.
481 Improved compatibility with version 3584 WIM / ESD files:
482 - Add support for reading and writing multiple solid blocks per
483 archive, which WIMGAPI/DISM can create when appending an image.
484 - Correctly create solid blocks larger than 4 GiB.
486 'add' commands passed to wimupdate will now replace existing
487 nondirectory files by default. Use the --no-replace option to get the
490 The license for the library now contains an exception that allows using
491 it under the LGPL. See the COPYING file for details.
493 In reparse-point fixup mode (the default for capture), symbolic links
494 and junctions that point outside the tree being captured are no longer
495 excluded from capture.
497 Added support for "WIMBoot" capture and extraction. See the
498 documentation for the new '--wimboot' option to wimcapture and wimapply
499 for more information.
501 On UNIX-like systems, you can now backup and restore device nodes, named
502 pipes, and sockets. In addition, 32-bit user and group IDs are now
505 The way that UNIX data is stored in WIM files has been changed. If you
506 captured any WIMs with the --unix-data option, to upgrade them you'll
507 need to apply them with --unix-data using wimlib-imagex v1.6.2, then
508 re-capture them with --unix-data using this version.
510 wimlib now understands tagged metadata items, such as object IDs, that
511 can be stored in WIM directory entries.
513 Removed the --hardlink and --symlink options to wimapply, since I don't
514 think they are too useful and they got in the way of improving the code.
516 WIMs will now retain their GUIDs when rebuilt (e.g. with wimoptimize).
518 The 'mkwinpeimg' script now supports writing the ISO image to standard
521 The <ARCH> element in WIM XML data is now exported correctly.
523 On Windows, sparse file attributes are no longer set on extracted files.
524 Oddly enough, this actually saves disk space in some cases.
526 On UNIX, configuring with --disable-xattr or --enable-xattr is no longer
527 supported. Mounting WIM images now always requires extended attribute
528 support. Use --without-fuse to disable support for mounting WIM images;
529 this will also disable the need for extended attribute support.
531 Configuring with --enable-ssse3-sha1 now works correctly.
533 The shared library version has been bumped up. The main
534 incompatibilities are:
536 - WIMLIB_COMPRESSION_TYPE_XPRESS is now 1 and
537 WIMLIB_COMPRESSION_TYPE_LZX is now 2 (so it's the same as
540 - User-provided progress functions are now registered using a
541 separate function, wimlib_register_progress_function(). The
542 'progress_func' argument to many functions no longer exists.
544 - The return value from user-provided progress functions is now
547 - A context argument has been added to the prototype of
548 user-provided progress functions.
550 - 'struct wimlib_capture_config' has been removed. The library
551 now takes the path to the configuration file directly. This
552 affects wimlib_add_image(), wimlib_add_image_multisource(),
553 and wimlib_update_image(). However, a NULL value passed in
554 the argument retains the same meaning.
556 - Removed deprecated functions: some (de)compression functions,
557 wimlib_extract_files(), and wimlib_print_metadata().
559 - Removed extraction flags: WIMLIB_EXTRACT_FLAG_HARDLINK,
560 WIMLIB_EXTRACT_FLAG_SYMLINK, WIMLIB_EXTRACT_FLAG_FILE_ORDER,
561 and WIMLIB_EXTRACT_FLAG_SEQUENTIAL.
563 - Removed some progress messages:
564 WIMLIB_PROGRESS_MSG_APPLY_TIMESTAMPS,
565 WIMLIB_PROGRESS_MSG_EXTRACT_DIR_STRUCTURE_BEGIN,
566 WIMLIB_PROGRESS_MSG_EXTRACT_DIR_STRUCTURE_END. Numbering
569 - Removed some error codes. Numbering stays the same.
571 - Replaced WIMLIB_UNMOUNT_FLAG_LAZY with
572 WIMLIB_UNMOUNT_FLAG_FORCE.
574 - WIM paths passed to progress functions now have a leading
578 Case-insensitive comparisons of strings (e.g. filenames) containing
579 UTF-16 codepoints above 32767 are now done correctly.
581 Fixed build failure on Mac OS X.
583 wimunmount now provides the '--new-image' option to cause changes to a
584 read-write mounted image to be committed as a new image rather than as
585 an update of the mounted image. (The corresponding new library flag is
586 WIMLIB_UNMOUNT_FLAG_NEW_IMAGE.)
588 The LZMS ("recovery") compression chunk size, or "dictionary size", may
589 now be up to 1 GiB (1,073,741,824 bytes).
591 The performance of LZX ("maximum") and LZMS ("recovery") compression
592 with large chunk sizes has been slightly improved.
595 Stored files with size exactly 4 GiB (4,294,967,296 bytes) are now
596 decompressed correctly.
598 Fixed a bug in the LZX compressor introduced in v1.5.3. The bug
599 occurred in an unlikely case, and due to validity checks it did not
600 affect successfully created archives.
602 Fixed a minor compatibility issue with the LZMS compressor and
603 decompressor. This is *not* the default compression type and was only
604 introduced in v1.6.0. In the unlikely event that you created an
605 LZMS-compressed WIM with v1.6.0 and a checksum error is reported when
606 applying it with v1.6.1, decompress it with v1.6.0 then compress it with
609 Memory usage for LZMS and LZX compression has been decreased.
611 wimextract now allows wildcard characters in paths specified on the
612 command line. Also, the '--strict-wildcards' option has been removed
613 and replaced with the inverse option '--nullglob'. See the
614 documentation for wimextract for more details and changes.
616 The wimlib_extract_files() function is now considered deprecated in
617 favor of wimlib_extract_paths().
619 Fixed more permissions problems when extracting files on Windows.
621 A new '--no-attributes' option has been added to wimapply and
622 wimextract. The library flag is WIMLIB_EXTRACT_FLAG_NO_ATTRIBUTES.
624 The default chunk size is now set correctly when changing the
625 compression type of a WIM, for example with 'wimoptimize'.
627 The '--metadata' option to wiminfo has been replaced with the
628 '--detailed' option to wimdir.
630 In relevant wimlib-imagex commands, '--solid' may now be used as an
631 alias for '--pack-streams'.
634 Support for extracting and updating the new version 3584 WIMs has been
635 added. These WIMs typically pack many streams ("files") together into a
636 single compressed resource, thereby saving space. This degrades the
637 performance of random access (such as that which occurs on a mounted
638 image), but optimizations have been implemented for extraction. These
639 new WIM files also typically use a new compression format (LZMS), which
640 is similar to LZMA and can offer a better compression ratio than LZX.
641 These new WIM files can be created using `wimcapture' with
642 the '--compress=lzms --pack-streams' options. Note: this new WIM format
643 is used by the Windows 8 web downloader, but important segments of the
644 raw '.esd' files are encrypted, so wimlib will not be able to extract
645 such files until they are first decrypted.
647 wimlib now supports extracting files and directories from a WIM image
648 based on a "listfile" that itself contains the list of paths to extract.
649 For `wimextract', the syntax is to specify @LISTFILE instead of a PATH,
650 and for the library itself, the new APIs are wimlib_extract_pathlist()
651 and wimlib_extract_paths(). Path globs containing wildcard characters
654 For searching WIM files, wimlib now has configurable case sensitivity.
655 The default on Windows is still case-insensitive and the default on
656 UNIX-like systems is still case-sensitive, but this can be overridden
657 on either platform through flags to wimlib_global_init(). For
658 `wimlib-imagex', the environmental variable WIMLIB_IMAGEX_IGNORE_CASE
659 can be set to 1 or 0 for case-insensitive or case-sensitive behavior,
662 Support for compression chunk sizes greater than the default of 32768
663 bytes has been added. A larger chunk size typically results in a better
664 compression ratio. However, the MS implementation is seemingly not
665 compatible with all chunk sizes, especially for LZX compression, so the
666 defaults remain unchanged, with the exception of the new LZMS-compressed
667 WIMs, which use a larger chunk size by default.
669 The compression/decompression API exported by wimlib has been changed.
670 Now one set of functions handles all supported compression formats.
672 `wimcapture' and `wimappend' will now display the progress of scanning
673 the directory tree to capture, in addition to the progress of writing
674 data to the WIM. The '--verbose' option no longer does anything. The
675 library API change for this is the addition of several members to
676 `struct wimlib_progress_info_scan' available to progress callbacks.
678 `mkwinpeimg' now correctly handles the '--start-script' option when the
679 start script is not in the working directory.
681 Sequential extraction, previously requested by using
682 WIMLIB_EXTRACT_FLAG_SEQUENTIAL, is now the default.
683 WIMLIB_EXTRACT_FLAG_FILE_ORDER can be used to get the old default
684 behavior (extract in file order).
687 The new LZX compressor added in v1.5.2 has been improved and is now
688 enabled by default, except when `wimcapture' or `wimappend' is run
689 *without* the '--compress' option, in which case the faster LZX
690 compressor is used (the same as before). This behavior is reasonably
691 consistent with ImageX which actually uses "fast" (XPRESS) compression
692 by default. In those cases, use '--compress=maximum' to explicitly
693 capture a WIM image using the new (slower but better) LZX compressor.
695 The '--compress-slow' option still exists to `wimlib-imagex optimize',
696 but its new behavior is to tweak the new LZX compressor even more to
697 produce an even better compression ratio at the cost of more time spent
700 `wimlib-imagex optimize' now supports the '--compress=TYPE' option,
701 which recompresses the WIM file using the specified compression TYPE.
702 The new library API function used for this is
703 wimlib_set_output_compression_type().
705 Added the wimlib_get_xml_data() function to allow library clients to
706 easily retrieve the raw XML data from a WIM file if needed.
708 Fixed a bug that could cause an error code to be incorrectly returned
709 when writing XML data containing a <WINDOWS> element.
711 Mounted WIM images will now correctly show the default file stream even
712 if appears in the alternate data stream entries of the corresponding WIM
716 Added a new experimental LZX compressor which can be enabled by passing
717 '--compress-slow' to `wimlib-imagex capture' or `wimlib-imagex
718 optimize'. (The latter is only applicable if the WIM is already
719 LZX-compressed and the '--recompress' option is also given.) The
720 experimental compressor is much slower but compresses the data slightly
721 more --- currently usually to within a fraction of a percent of the
722 results from WIMGAPI/ImageX.
724 A workaround has been added for compatibility with versions of WinPE
725 that interpret alternate data stream entries in the boot WIM
728 An alignment bug that caused a crash in the LZX decompressor on some
731 wimlib now attempts to clear the WIM_HDR_FLAG_WRITE_IN_PROGRESS flag in
732 the WIM header when restoring the previous state of a WIM it failed to
735 Added a workaround to avoid an access denied error on Windows when
736 replacing a WIM file that another process has opened.
739 wimlib can now open WinPE WIMs from WAIK v2.1, which had a quirk that
740 needed to be handled.
742 A bug in the interpretation of negative IMAGE indices in the
743 --update-of=[WIMFILE:]IMAGE option to `wimlib-imagex capture' and
744 `wimlib-imagex append' has been fixed.
746 A workaround has been added to successfully apply security descriptors
747 with empty DACLs when the NTFS-3g apply mode is being used with NTFS-3g
748 2013.1.13 or earlier.
750 `wimlib-imagex capture' can now accept the '--delta-from' option
754 Added support for "pipable" WIMs. Pipable WIMs allow capturing images
755 to standard output and applying images from standard input, but they are
756 not compatible with Microsoft's software and are not created by default.
757 See the documentation for --pipable flag of `wimlib-imagex capture' for
760 To better support incremental backups, added support for declaring an
761 image as a modified form of another image. See the documentation for
762 the '--update-of' option of `wimlib-imagex append' and `wimlib-imagex
765 Added supported for "delta" WIMs. See the documentation for the
766 '--delta-from' option of `wimlib-imagex capture'.
768 The library support for managing split WIMs has been changed to support
769 other arrangements, such as delta WIMs, and be easier to use. This
770 change is visible in `wimlib-imagex', which also can now accept the
771 '--ref' option multiple times, and also now supports "delta" WIMs as
774 wimlib now preserves WIM integrity tables by default, even if
775 WIMLIB_WRITE_FLAG_CHECK_INTEGRITY is not specified. This changes the
776 behavior of `wimlib-imagex' whenever the WIM being operated on contains
777 an integrity table and the '--check' option is not specified.
779 `wimlib-imagex capture' now creates LZX-compressed WIMs by default
780 (when --compress is not specified). This provides the best compression
781 ratio by default, which is usually what is desired, at a cost of some
784 `wimlib-imagex' now supports being invoked as wimCOMMAND, where COMMAND
785 is the command as in `wimlib-imagex COMMAND'; for example, it can be
786 invoked as `wimapply' as an alternative to `wimlib-imagex apply'. The
787 appropriate hard links are created in UNIX installations of
788 `wimlib-imagex', while for the Windows distribution of `wimlib-imagex',
789 batch files that emulate this behavior are generated.
791 Security descriptors are now extracted correctly on Windows.
793 Fixed archiving DOS names in NTFS-3g capture mode.
795 The extraction code has been rewritten and it will now be easier to
796 support new features on all supported backends (currently Win32, UNIX,
797 and NTFS-3g). For example, hard-linked extraction mode (--hardlink) is
798 now supported on all backends, not just UNIX.
800 `mkwinpeimg' now supports grabbing files from the WAIK supplement rather
801 than the WAIK itself.
803 wimlib_global_init() now, by default, attempts to acquire additional
804 privileges on Windows, so library clients need not do this.
806 This update bumps the shared library version number up to 9, since it is
807 not binary compatibible with previous releases.
810 Fixed bug in `wimlib-imagex export' that made it impossible to export an
811 image from a WIM that is readonly at the filesystem level.
813 Return error code rather than segfaulting when trying to list files from
814 a non-first part of a split WIM.
816 Joining a WIM will now preserve the RP_FIX and READONLY flags.
819 On Windows, paths given to wimlib-imagex are now treated case
822 Improved behavior regarding invalid filenames; in particular, on
823 Windows, wimlib-imagex will, when extracting, now omit (with an option
824 to override this default) filenames differing only in case, or filenames
825 containing characters not valid on Windows.
827 On Windows, wimlib now supports capturing and extracting long paths
828 (longer than the so-called MAX_PATH).
830 On Windows, `wimlib-imagex update' now acquires proper privileges when
831 running as an Administrator.
833 `wimlib-imagex update' will now complain if no image is specified when
834 trying to update a multi-image WIM.
836 `wimlib-imagex update' now supports specifying a single update command
837 directly on the command line using the --command option.
839 wimlib-imagex will now choose different units for progress messages,
840 depending on the amount of data that needs to be processed.
842 `wimlib-imagex append' will now generate a unique WIM image name if no
843 name is specified and the defaulted name already exists in the WIM.
845 wimlib now allows you to create unnamed WIM images, which can then only
846 be referred to by index.
848 wimlib now allows you to explicitly declare you want write access to a
849 WIM by providing the WIMLIB_OPEN_FLAG_WRITE_ACCESS flag to
852 wimlib now respects the WIM_HDR_FLAG_READONLY flag when set in the WIM
855 Progress callbacks have been added to wimlib's wimlib_update_image()
858 Added wimlib_get_wim_info(), wimlib_set_wim_info(),
859 wimlib_iterate_dir_tree(), and wimlib_iterate_lookup_table() functions
862 NTFS-3g capture now only warns about two conditions previously treated
865 Fixed a couple issues with using wimlib-imagex on UDF filesystems on
868 wimlib now correctly detects and returns an error when reading a WIM
869 image with a cyclic directory structure. (Fun fact: such a WIM will
870 crash Microsoft's software.)
873 Added new "extract" and "update" subcommands to wimlib-imagex, along
874 with associated APIs in the library. These commands are intended mainly
875 for Windows use but can be used on UNIX as well.
877 Many documentation improvements.
879 Fixed a bug in the Windows build where relative symbolic links were not
880 captured in reparse-point fixup mode.
882 Fixed a bug in the Windows build where file handles were left open to
883 the WIM file, causing `wimlib_imagex optimize' to fail in some cases.
885 Fixed a bug in the Windows build of wimlib-imagex where globbing
886 split-WIM parts could cause the program to crash.
888 Fixed a bug where the creation time of WIM images would be shown instead
889 of the last modification time.
891 With the Windows build it is now possible to restore a WIM containing
892 symbolic links as a non-Administrator; however you will receive warnings
893 about not being able to extract the symbolic links.
896 Capturing a WIM image should now be significantly faster in most cases
897 due to improved use of the operating system's cache and avoiding reading
898 files twice whenever possible.
900 The Windows build should now work on Windows XP.
902 The Windows build now supports capturing and restoring hidden,
903 compressed, sparse, and encrypted files.
905 The Windows build now supports capturing and applying WIM images from
906 filesystems other than NTFS (with some reduced functionality).
908 The Windows build now extracts short names correctly.
910 Added support for "reparse-point" fixups (i.e. fixing up of symbolic
911 links). See docs for --rpfix and --norpfix flags of `wimlib-imagex
912 capture' and `wimlib-imagex apply'.
914 The performance of splitting and joining WIMs should be slightly
917 The LZX and XPRESS compression and decompression functions are now
918 exported from the library.
921 Improvements and bugfixes for the Windows build.
923 Added --strict-acls options.
925 Fixed the way that wimlib determines the order of images in the WIM.
928 Since wimlib can now be used on Windows, wimlib's implementation of
929 ImageX has been renamed to wimlib-imagex to avoid confusion with
930 Microsoft's implementation of ImageX, which would have the same file
931 name ("imagex.exe"). If you really don't like this you can pass the
932 --with-imagex-progname option to `configure' to choose a different name,
933 or even simply rename the binary yourself (but the former way will
934 configure the man pages to use the chosen name).
936 Various bugs fixed in the Windows build. Mainly to do with capturing
937 and restoring alternate data streams correctly in weird cases, and
938 requesting the correct privileges when opening files. Also added the
939 --noacls options to wimlib-imagex capture, append, and apply.
941 Windows build again: FindFirstStreamW() and FindNextStreamW() are now
942 dynamically loaded, so this may make the library compatible with Windows
943 XP (however, there may still be other problems).
946 Added experimental support for native Windows builds. Binaries can be
947 downloaded from the SourceForge page.
949 --source-list option added to `imagex capture' and `imagex append'.
951 Better support for different character encodings.
954 Storing UNIX file owners, groups, and modes in WIM images is now
955 possible using `imagex capture' with the --unix-data flag.
957 Minor bug fixes and documentation fixes.
960 NTFS capture: Fixed capturing duplicate reparse points.
962 NTFS capture: Capture first unnamed stream if there are more than one
963 (print warning instead of error).
965 Allow multiple test cases to execute concurrently (e.g. make -j2 check).
968 Added --arch switch to mkwinpeimg script to support getting AMD64 WinPE
971 Update to work with ntfs-3g version 2013.1.13.
974 Fixed truncating file to shorter but non-zero length on read-write
977 Various code cleanups and minor documentation fixes.
980 LZX and XPRESS decompression have received some additional optimizations
981 and should now be even faster. (Although, they were already pretty
982 fast--- much faster than typical I/O speeds.)
984 Fixed a bug introduced in v1.2.1 that would cause a directory tree
985 containing hard links to be captured incorrectly in some cases.
988 By default, unmounting a read-write mounted WIM with 'imagex unmount
989 --commit' will now change the WIM in-place without needing to write the
990 entire WIM again. Use 'imagex unmount --commit --rebuild' to get the
993 'imagex unmount' no longer has a hard-coded limit of 10 minutes to wait
994 for a response from the daemon servicing the mounted WIM. Instead,
995 every second 'imagex unmount' will check if the daemon is still alive,
996 and keep waiting if so, otherwise terminate with an error.
998 'imagex unmount --commit' on a read-write mounted WIM will now print
999 progress information regarding the writing of new or modified streams
1000 the WIM, just like when capturing or appending a WIM.
1002 A small change has been made to XPRESS compression and it should improve
1003 the compression ratio slightly.
1005 A change was made that may improve performance slightly when applying a
1006 WIM image to a NTFS volume.
1008 Microsoft has managed to introduce even more bugs into their software,
1009 and now the WIMs for Windows 8 have incorrect (too low) reference counts
1010 for some streams. This is unsafe because such streams can be removed
1011 when they are in actuality still referenced in the WIM (perhaps by a
1012 different image). wimlib will now work around this problem by fixing
1013 the stream reference counts. This is only done when wimlib_delete_image() is
1014 called ('imagex delete') or when wimlib_mount_image() is called with
1015 WIMLIB_MOUNT_FLAG_READWRITE ('imagex mountrw'). Please note that this
1016 requires reading the metadata for all images in the WIM, so this will
1017 make these operations noticably slower on WIMs with multiple images.
1019 Various other bugfixes.
1022 Appending images to a WIM is now be done by default without re-building
1023 the whole WIM. Use the --rebuild flag to get the old behavior (which
1024 was to re-build the entire WIM when a new image is appended).
1026 A new command `imagex optimize' is now available to manually re-build a
1027 WIM that has wasted space due to repeated appends.
1029 Progress information has been improved, and now arbitrary callback
1030 functions can be used to show the progress of a WIM operation.
1032 A possible bug with changing the bootable image of a WIM was fixed.
1034 Some advisory locking is now done to prevent two processes from
1035 modifying a WIM at the same time (but only in some cases). For example,
1036 you cannot mount two images from a WIM read-write at the same time.
1038 Some functions have been reorganized:
1039 * wimlib_mount() renamed to wimlib_mount_image().
1040 * wimlib_unmount() renamed to wimlib_unmount_image().
1041 * wimlib_overwrite_xml_and_header() removed as
1042 wimlib_overwrite() suffices now.
1043 * wimlib_apply_image_to_ntfs_volume() removed as
1044 wimlib_extract_image() suffices now.
1045 * wimlib_add_image_from_ntfs_volume() removed as
1046 * wimlib_add_image() suffices now.
1048 Previously, the soname of libwim.so has been 0.0.0, despite many
1049 interface changes. The soname is now updated to 1.0.0 and will now be
1050 updated each release.
1053 Resources will now be compressed using multiple threads by default.
1054 (This applies to `imagex capture', `imagex append', and `imagex
1057 Some performance improvements in mounted WIMs.
1059 More progress information is shown when capturing a WIM.
1062 Lots of minor fixes, code cleanups, and some documentation updates.
1063 Nothing in particular is really noteworthy.
1066 LZX and XPRESS compression improvements.
1068 Fixed calculation of Directory Count, File Count, Total Bytes, and Hard
1069 Link Bytes of the WIM.
1072 Fixed bug when capturing NTFS file with multiple named data streams.
1074 Internally, we are now using inode structures, even though these don't
1075 appear literally in the WIM file. This simplifies some of the code
1076 (mainly for WIM mounting) and likely fixed a few problems, although it
1080 Fixed problem when exporting images from XPRESS to LZX compressed WIM or
1084 Enough changes to call it version 1.0.0!
1086 Capturing a WIM directly from a NTFS volume, and applying a WIM directly
1087 to a NTFS volume, is now supported.
1089 Hard links and symbolic links have much improved support. They are
1090 supported for WIM capture, WIM application, and mounted WIMs (you can
1091 even make them on read-write mounted WIMs).
1093 Alternate data streams are now supported on mounted WIMs through an
1094 xattr or a Windows-style stream interface. Also they are supported when
1095 capturing a WIM from NTFS or applying a WIM to NTFS.
1097 Split WIMs are better supported. You may now apply an image directly
1098 from a split WIM, mount an image from a split WIM read-only, or export
1099 an image from a split WIM.
1101 Using a capture configuration file is now supported (but not fully yet).
1103 SHA1 message digests are checked in more places, so we can make sure
1104 applied and captured data is correct.
1106 Man pages have been updated and consolidated.
1109 Fixed segfault when unmounting read-only WIM.
1112 Support for joining and splitting WIMs.
1113 Also, security data is now preserved by default.
1116 Can now build with older gcc and system headers, like on CentOS 5.
1119 Fixed bug that made it impossible to overwrite files in read-write
1123 Write byte-order mark before WIM XML data. (imagex.exe requires this to
git://wimlib.net / wimlib / blob