3 ## Version 1.14.3-BETA1
5 - Fixed a bug introduced in v1.14.0 where non-ASCII characters stopped being
6 accepted in image names and descriptions. This bug only affected UNIX-like
7 systems that use `signed char`, e.g. x86 Linux systems.
11 - Fixed a bug introduced in v1.14.0 where a crash would sometimes occur if a
12 Delphi application or Visual Studio compiled application called into the
13 32-bit x86 build of the library.
15 - Fixed an issue where some WIM images written by wimlib weren't accepted by
16 some MS software versions. wimlib-written WIM images containing directory
17 reparse points (e.g. junctions) weren't accepted by some versions of the
18 Windows 8 setup wizard. Also, recent versions of DISM had stopped accepting
19 wimlib-written WIM images containing directories with named data streams.
21 - Commands passed to wimupdate on standard input are now interpreted as UTF-8 or
22 UTF-16LE (autodetected), just like wimcapture config files and wimextract path
23 list files. Previously, on Windows the Windows code page was used instead of
24 UTF-8, which made it hard to specify non-ASCII file paths in wimupdate
25 commands. The same change also applies to wimcapture source list files.
29 - Fixed a bug introduced in v1.14.0 where wimlib would crash on older CPUs.
33 - Removed libxml2 and libcrypto (OpenSSL) as dependencies of wimlib. Also
34 removed winpthreads as a dependency of wimlib on Windows.
36 - Upgraded the support for mounting WIM images on Linux from fuse2 to fuse3.
37 fuse2 is no longer supported.
39 - Converted the README, README.WINDOWS, and NEWS files to Markdown.
41 - Simplified the process of building wimlib for Windows. See README.WINDOWS for
42 the updated instructions, which use MSYS2 instead of Cygwin. Windows ARM64
43 builds are now supported (experimentally) as well.
45 - Improved performance on CPUs that have SHA-1 instructions in cases where
46 wimlib wasn't using OpenSSL, e.g. the Windows binaries.
48 - Fixed a bug in `wimsplit` where it didn't accept part sizes of 4 GiB or larger
49 on Windows and on 32-bit platforms.
51 - `wimupdate` now supports the `--ref` option. It should be specified when
52 updating a delta WIM to avoid two minor issues.
54 - `wimoptimize` now has better default behavior when converting to and from
55 solid archives, i.e. WIM <=> ESD. It now is consistent with `wimcapture` and
56 `wimexport`. For WIM => ESD, `wimoptimize --solid` now works. Before, the
57 needed command was `wimoptimize --solid --compress=LZMS --chunk-size=128K`.
58 For ESD => WIM, `wimoptimize --compress=LZX` now works. Before, the needed
59 command was `wimoptimize --compress=LZX --chunk-size=32K`.
61 - Removed support for Windows XP.
63 - Added a GitHub Actions workflow that tests wimlib.
67 - `wimsplit` no longer prints a success message on failure.
69 - `wimlib_iterate_dir_tree()` no longer hashes files that haven't yet been
70 written to the WIM file.
72 - Reduced the maximum number of file descriptors that wimlib can use when
73 extracting files from a WIM image on macOS.
75 - The files that used the CC0 public domain dedication now use the MIT license
78 - Removed some configuration options (`--disable-assertions`,
79 `--disable-error-messages`, and `--disable-multithreaded-compression`) that
80 probably weren't being used by anyone.
84 - Exporting "all" images from a WIM file no longer fails if multiple
85 images in that WIM file have the same name.
87 - wimlib now warns rather than aborts if two files have the same SHA-1
88 hash but different sizes.
90 - Fixed build errors with the latest version of MinGW-w64.
94 - wimsplit now prints progress messages regularly rather than just once per WIM
97 - Added support for a data recovery mode which causes files to be extracted even
98 if they are corrupted. The option is `--recover-data` for `wimapply` and
99 `wimextract`, and `WIMLIB_EXTRACT_FLAG_RECOVER_DATA` for the library. Note
100 that this option won't help with all types of corruption; some types of
101 corruption will still cause a fatal error.
105 - On Windows, improved performance of capturing an entire drive in some cases.
107 - On Windows, fixed leaking a directory handle (or triggering a SEH exception
108 when running under a debugger) when referencing WIM files.
110 - On Windows, when applying a Windows OS image using the `--compact` flag,
111 bootloader files can now be compressed with stronger compression algorithms if
112 the version of Windows is recent enough to support it.
114 - Clarified the license text.
118 - Prevented miscompilation with gcc 10 at -O3 due to [a gcc
119 bug](https://gcc.gnu.org/bugzilla/show_bug.cgi?id=94994).
121 - Avoided some compiler warnings with gcc 9 and later.
123 - The `mkwinpeimg` script now also looks for syslinux modules in
124 `/usr/share/syslinux`, to handle where openSUSE installs them.
126 - Removed obsolete packaging files from the source tree.
130 - Fixed a crash or incorrect output during LZMS compression with a compression
131 level greater than 50 and a chunk size greater than 64 MiB. This affected
132 wimlib v1.8.0 and later. In the unlikely event that you used all these
133 non-default compression settings in combination, e.g. `wimcapture --solid
134 --solid-compress=LZMS:100 --solid-chunk-size=128M`, run `wimverify` on your
135 archives to verify your data is intact.
139 - On Windows, wimlib now supports capturing and applying extended attributes
140 (EAs). It is compatible with DISM with the `/EA` option, available since
141 Windows 10 version 1607. wimlib's EA support is on by default and works on
142 older versions of Windows too.
144 - Partially fixed a bug where `[ExclusionException]` entries didn't take effect
145 when the containing directory is matched by `[ExclusionList]`. It now works
146 when the `[ExclusionException]` patterns are absolute. For example, listing
147 `/dir/file` in `[ExclusionException]` now works even if `/dir` is matched by
150 - Added a `--create` option to `wimappend` which makes it create the WIM
151 file (like `wimcapture`) if it doesn't exist yet.
153 - Added an `--include-integrity` option to various `wimlib-imagex` commands.
154 `--include-integrity` is like `--check`, but it will just include an integrity
155 table in the output WIM(s), while skipping verification of any existing
156 integrity tables. This can be useful to avoid unwanted verification of large
157 WIM files, e.g. WIMs given by `--delta-from`.
159 - `wimextract` now reads a pathlist file from standard input when `@-` is given
162 - `wimsplit` (API: `wimlib_split()`) now correctly handles a dot in the path to
163 the first split WIM part, prior to the filename extension.
165 - `wimlib-imagex --version` now shows the version of the library it is actually
166 using (in case it is different from `wimlib-imagex`'s version).
170 - Fixed a bug that was causing the LZMS decompressor to be miscompiled with GCC
171 7 (this broke extracting "solid" archives).
173 - The Windows 10 Recycle Bin directory (`\$RECYCLE.BIN`) has been added to the
174 default exclusion list.
176 - Added a `--quiet` option to `wimlib-imagex`.
178 - The `mkwinpeimg` script now also looks for the syslinux BIOS modules in the
179 directory `/usr/lib/syslinux/modules/bios`.
181 - Files with timestamps before the year 1970 are now extracted correctly to
182 UNIX-style filesystems, are displayed correctly by `wimdir --detailed`, and
183 show up correctly in mounted WIM images.
185 - Files with timestamps after the year 2038 are now displayed correctly by the
186 32-bit Windows build of wimlib.
190 - Fixed a data corruption bug (incorrect compression) when storing an already
191 highly-compressed file in an LZX-compressed WIM with a chunk size greater than
192 or equal to 64K. Note that this is not the default setting and such WIMs are
193 not supported by Microsoft's WIM software, so only users who used the
194 `--chunk-size` option to `wimlib-imagex` or the
195 `wimlib_set_output_chunk_size()` API function may have been affected. This
196 bug was introduced in wimlib v1.10.0. See [this forum
197 thread](https://wimlib.net/forums/viewtopic.php?f=1&t=300) for more details.
199 - On all platforms, sparse files are now extracted as sparse.
201 - Sparse files captured from UNIX-style filesystems are now marked as sparse in
202 the resulting WIM image.
204 - Added support for storing Linux-style extended attributes in WIM images. When
205 the `--unix-data` option is used on Linux, `wimlib-imagex` now captures and
206 applies extended attributes, in addition to the already-supported standard
207 UNIX file permissions (owner/group/mode) and special files.
209 - `--delta-from` is now supported by `wimappend`. (Previously it was only
210 supported by `wimcapture`.)
212 - On Windows, improved the way in which files deduplicated with Windows' Data
213 Deduplication feature are captured.
215 - The development files needed to link with wimlib using Visual Studio are now
216 included in the Windows release archives.
218 - `wimlib.h` can now be included by Visual Studio without errors.
220 - The example programs can now be compiled in C++ mode, and they also now work
223 - Updated `mkwinpeimg` to work correctly on images that have a `windows`
224 (lower case) directory rather than a `Windows` (upper case) directory.
226 - Fixed configuring with `--enable-ssse3-sha1` from release tarball (the file
227 `nasm_lt.sh` was missing).
229 - Made some documentation improvements.
233 - The LZX compression ratio has been slightly improved. The default mode, LZX
234 level 50, is now almost as good as the old LZX level 100, while being nearly
235 the same speed as before.
237 - Decompression performance has been slightly improved.
239 - Filenames are now always listed in NTFS collation order.
241 - On UNIX-like systems, wimlib can now process Windows filenames that are
242 not valid Unicode due to the presence of unpaired surrogates.
244 - On UNIX-like systems, wimlib now always assumes UTF-8 encoding with the
245 addition of surrogate codepoints. Consequently, the environmental variable
246 `WIMLIB_IMAGEX_USE_UTF8` and the flag `WIMLIB_INIT_FLAG_ASSUME_UTF8` no longer
249 - wimlib no longer depends on iconv.
251 - Reduced memory usage slightly.
253 - When a WIM image is applied in NTFS-3G mode, security descriptors are now
254 created in NTFS v3.0 format when supported by the volume.
256 - Workarounds for bugs in libntfs-3g version 2013.1.13 and earlier have been
257 removed. Users are advised to upgrade to a later version of libntfs-3g.
259 - On Windows, wimlib now supports case-sensitive filename extraction when
260 supported by the underlying operating system and filesystem (operating system
261 support requires a registry setting).
265 - On UNIX, wimlib can now overwrite readonly files when extracting.
267 - On Windows, fixed a bug where wimlib could leave a null DACL (a.k.a. "no NTFS
268 permissions") set on some existing directories after extraction.
270 - On Windows, when applying a WIM image in "WIMBoot mode" when the WOF driver is
271 not loaded, wimlib can now correctly register a new WIM file with the target
272 volume when the target volume previously had had WIM files unregistered.
274 - Added a new testing program.
276 - Clarified the main license text and updated public domain dedications for
277 certain files to be more thorough.
281 - Object IDs are now saved and restored on Windows and in NTFS-3G mode.
283 - Reduced memory usage when exporting large numbers of WIM images.
285 - Non UTF-8 locales are now detected correctly.
287 - Addressed compiler warnings and enabled "silent" make rules by default.
289 - Windows-specific updates:
291 - Fixed a bug where duplicate backslashes could be generated in link targets
292 when extracting symbolic links and junctions.
294 - Fixed a bug where the `.cmd` shortcuts for `wimlib-imagex` wouldn't work if
295 their full path contained a space.
297 - Fixed bugs related to scanning SMB filesystems.
299 - Added warning message about known issue with WindowsApps folder.
301 - Added instructions for building from source on Windows.
303 - VSS support is no longer marked "experimental".
305 - Added missing license file for libdivsufsort-lite.
309 - Added experimental support for Windows VSS (Volume Shadow Copy Service). The
310 new `--snapshot` argument to `wimcapture` makes wimlib automatically create
311 and use a temporary VSS snapshot when capturing a WIM image.
313 - Implemented setting of Windows-specific XML information, such as architecture,
314 system root, and version details. This information is now automatically set
315 in newly captured WIM images, when appropriate.
317 - Improved performance of directory tree scans on Windows.
319 - On Windows, to improve capture performance, wimlib now sometimes opens files
320 by inode number rather than by path. This is enabled for `wimcapture` and
321 `wimappend`, but for now other applications have to opt-in.
323 - The progress messages printed by `wimlib-imagex` while writing WIM files have
324 been slightly tweaked.
326 - Progress information for directory tree scans now counts all hard links.
327 Also, on Windows `\\?\` is no longer stripped from the current path.
329 - Added a new `--image-property` option to `wimcapture`, `wimappend`, and
330 `wiminfo`. This option lets you assign values to elements in a WIM file's XML
333 - The `wimlib_get_image_property()` and `wimlib_set_image_property()` API
334 functions now support numerically indexed elements.
336 - Fixed a bug where, on Windows, wimlib would change the security descriptor of
337 the target directory of an extraction even when the `--no-acls` option was
342 - Fixed a bug with libntfs-3g extraction present since v1.8.1. Sometimes, some
343 Microsoft software would not correctly recognize data in the resulting
346 - Made some small improvements to the compression algorithms:
347 - LZX compression ratio was slightly improved.
348 - XPRESS compression ratio and speed was slightly improved.
349 - LZMS compression speed was slightly improved.
351 - Improved handling of WIM XML data. wimlib no longer drops unrecognized
352 elements when exporting images. In addition, two API functions were added for
353 better access to elements in the XML document: `wimlib_get_image_property()`
354 and `wimlib_set_image_property()`.
356 - Added support for (unsafe) in-place compaction of WIM files.
358 - Improved performance of image export by reusing metadata resources
359 instead of always rebuilding and recompressing them.
361 - Improved performance of `wimlib_update_image()` by delaying the update to the
362 WIM's XML document until a write is requested.
364 - On Windows, the target of an extraction may now be a reparse point
365 (which will be dereferenced).
367 - On Windows, wimlib now correctly restores non-Microsoft reparse points.
368 However, this remains broken in NTFS-3G mode due to a libntfs-3g bug.
370 - On Windows, wimlib now has improved performance when archiving files
371 from a filesystem backed by a WIM (a "WIMBoot" setup).
373 - Several improvements to System Compression (compact mode) support:
375 - `wof.sys` (or `wofadk.sys`) is now automatically attached to the target
378 - Compact-mode extractions now work correctly with `wofadk.sys` on older
381 - For compatibility with the Windows bootloader, the requested compression
382 format now is overridden on certain files.
384 - Other minor bugfixes.
388 - This release primarily contains various minor bug fixes and improvements,
391 - Improved handling of deep directory structures.
393 - Fixed a bug where on 32-bit systems, the library could enter an infinite
394 loop if a WIM file was malformed in a specific way.
396 - Added a workaround for a case where libntfs-3g may report duplicate streams
399 - Windows symbolic links and junctions in mounted WIM images are now
400 automatically rewritten to be valid in the mounted location.
402 - Reparse point fixes: correctly handle the "ReparseReserved" field, and
403 correctly handle "empty" (data-less) reparse points.
405 - On Windows, wimlib now acquires SeManageVolumePrivilege, which is needed to
406 create externally backed files using the `wofadk.sys` driver.
408 - Improved validation of filenames.
410 - Improved LZMS decompression speed.
412 - The configure script now honors alternate pkg-config settings.
414 - Links have been updated to point to the new website.
416 - In addition, experimental support has been added for compressing extracted
417 files using System Compression on Windows 10. This functionality is available
418 through the new `--compact` option to `wimapply` and `wimextract` as well as
423 - Fixed a bug in the LZX decompressor: malicious input data could cause out of
424 bounds writes to memory (since wimlib v1.2.2).
426 - The output of the `wiminfo` command now consolidates various boolean flags
427 (such as "Relative path junction") into a single line.
429 - A file can now have both an unnamed data stream ("file contents") and a
430 reparse point stream. Such files can exist as a result of the use of certain
431 Windows features, such as offline storage, including "OneDrive". wimlib will
432 now store and restore both streams on Windows as well as in NTFS-3G mode.
433 Microsoft's WIMGAPI also has this behavior.
435 - On Windows, named data streams of encrypted files are no longer stored twice
438 - On Windows, named data streams are now correctly extracted to existing
439 "readonly" directories. Before, an error would be reported.
441 - On Windows, it is now possible to do a "WIMBoot mode" extraction with
442 non-standalone WIMs such as delta WIMs.
444 - On Windows, when doing an extraction in "WIMBoot mode", files larger
445 than 4 gigabytes are now never extracted as externally backed. This
446 works around a bug in Microsoft's "WOF" driver.
448 - The `--enable-verify-compression` configure option has been removed. If you
449 want to verify a WIM file, use the `wimverify` program.
451 - The way the "file count", "directory count", "total bytes", and "hard link
452 bytes" image statistics (stored in the WIM XML data) is calculated has been
455 - In mounted WIM images, the disk usage provided for each file (`st_blocks`) is
456 now the compressed size rather than the uncompressed size.
458 - The performance of the NTFS-3G and Windows capture modes has been slightly
461 - On UNIX-like systems, symbolic links whose targets contain the backslash
462 character are now handled correctly (losslessly).
466 - Improved the LZX compressor. It is now 15-20% faster than before and provides
467 a slightly better compression ratio.
469 - Improved the LZMS compressor. It now provides a compression ratio slightly
470 better than WIMGAPI while still being faster and using slightly less memory.
472 - The compression chunk size in solid resources, e.g. when capturing or
473 exporting a WIM file using the `--solid` option, now defaults to 64 MiB
474 (67108864 bytes) instead of 32 MiB (33554432 bytes). This provides a better
475 compression ratio and is the same value that WIMGAPI uses. The memory usage
476 is less than 50% higher than wimlib v1.7.4 and is slightly lower than
477 WIMGAPI's memory usage, but if it is too much, it is still possible to choose
478 a lower value, e.g. with the `--solid-chunk-size` option to `wimlib-imagex`.
480 - The `--chunk-size` and `--solid-chunk-size` options to `wimlib-imagex` now
481 accept the 'K', 'M', and 'G' suffixes.
483 - Files are now sorted by name extension when creating a solid WIM file.
485 - Fixed various issues related to capture/apply of EFS-encrypted files on
488 - The file list printed by `wimdir` is now sorted by the platform-specific
489 case sensitivity setting, rather than always case sensitively. This
490 also affects the library function `wimlib_iterate_dir_tree()`.
492 - On Windows, some error and warning messages have been improved.
496 - The Windows binary distribution no longer contains third party DLLs. These
497 dependencies are instead compiled directly into the libwim DLL.
499 - Added more fixes for wimlib on non-x86 architectures such as ARM.
501 - Extracting files to a Windows PE in-memory filesystem no longer fails if
502 the target files do not yet exist.
504 - Improved the performance of XPRESS compression and LZMS decompression.
506 - Enabled SSSE3 accelerated SHA-1 computation in `x86_64` Windows builds. It
507 will automatically be faster on newer Intel and AMD processors.
509 - Removed the `--with-imagex-progname` and `--enable-more-assertions` configure
514 - Fix for very slow export from solid WIM / ESD files.
516 - Fix for LZX and LZMS algorithms on non-x86 architectures, such as ARM.
518 - New progress message: `WIMLIB_PROGRESS_MSG_HANDLE_ERROR`. Applications may
519 use this to treat some types of errors as non-fatal.
521 - The library now permits making in-memory changes to a WIMStruct backed by a
524 - Fixes for "WIMBoot" extraction mode (Windows only):
526 - When not using the WOF driver, extraction no longer fails if the disk
527 containing the WIM file has too many partitions.
529 - When matching patterns in `[PrepopulateList]`, all hard links of each file
532 - The system registry files are now automatically treated as being in
535 - Added a hack to try to work around an intermittent bug in Microsoft's WOF
536 (Windows Overlay Filesystem) driver.
540 - Made more improvements to the XPRESS, LZX, and LZMS compressors.
542 - A number of improvements to the Windows port:
544 - Fixes for setting short filenames.
546 - Faster "WIMBoot" extraction.
548 - Updated and slimmed down the dependent DLLs.
550 - ACL inheritence bits are now restored.
552 - Mandatory integrity labels are now backed up and restored.
554 - Added a workaround for an issue where in rare cases, wimlib could create a
555 compressed data stream that could not be read correctly by Windows after an
556 extraction in "WIMBoot" mode.
560 - Added file count progress data for
561 `WIMLIB_PROGRESS_MSG_EXTRACT_FILE_STRUCTURE` and
562 `WIMLIB_PROGRESS_MSG_EXTRACT_METADATA`.
564 - Added support for testing file exclusions via the user-provided progress
567 - Some documentation improvements.
569 - Made some clarifications to the license text in the COPYING file.
573 - Made more improvements to the XPRESS, LZX, and LZMS compressors.
575 - The default compression mode for wimcapture is now LZX compression in its
576 default mode, which is the same as `--compress=maximum`.
578 - You can now specify an optional integer compression level to the
579 `--compress` option; e.g. `--compress=lzx:75`.
581 - Made a minor change to the LZMS compressor and decompressor to fix an
582 incompatibility with the Microsoft implementation. In the unlikely event that
583 you created an LZMS-compressed WIM with wimlib v1.7.0 or earlier and a
584 checksum error is reported when extracting files from it with wimlib v1.7.1,
585 decompress it with v1.7.0 then compress it with v1.7.1.
587 - Added `verify` subcommand to `wimlib-imagex`.
589 - Notable library changes:
591 - Custom compressor parameters have been removed from the library in favor of
592 the simpler level-based API.
594 - Decompressor parameters have been removed entirely.
596 - Library users can now specify a custom file for warning and error messages
597 to be sent to, rather than the default of standard error.
599 - New progress messages: `WIMLIB_PROGRESS_MSG_EXTRACT_FILE_STRUCTURE`,
600 `WIMLIB_PROGRESS_MSG_EXTRACT_METADATA`.
602 New function: `wimlib_verify_wim()`.
606 - Improved compression, decompression, and extraction performance.
608 - Improved compatibility with version 3584 WIM / ESD files:
610 - Add support for reading and writing multiple solid blocks per archive, which
611 WIMGAPI/DISM can create when appending an image.
613 - Correctly create solid blocks larger than 4 GiB.
615 - `add` commands passed to wimupdate will now replace existing nondirectory
616 files by default. Use the `--no-replace` option to get the old behavior.
618 - The license for the library now contains an exception that allows using it
619 under the LGPL. See the COPYING file for details.
621 - In reparse-point fixup mode (the default for capture), symbolic links and
622 junctions that point outside the tree being captured are no longer excluded
625 - Added support for "WIMBoot" capture and extraction. See the documentation for
626 the new `--wimboot` option to wimcapture and wimapply for more information.
628 - On UNIX-like systems, you can now backup and restore device nodes, named
629 pipes, and sockets. In addition, 32-bit user and group IDs are now supported.
631 - The way that UNIX data is stored in WIM files has been changed. If you
632 captured any WIMs with the `--unix-data` option, to upgrade them you'll need
633 to apply them with `--unix-data` using `wimlib-imagex` v1.6.2, then re-capture
634 them with `--unix-data` using this version.
636 - wimlib now understands tagged metadata items, such as object IDs, that
637 can be stored in WIM directory entries.
639 - Removed the `--hardlink` and `--symlink` options to wimapply, since I don't
640 think they are too useful and they got in the way of improving the code.
642 - WIMs will now retain their GUIDs when rebuilt (e.g. with wimoptimize).
644 - The `mkwinpeimg` script now supports writing the ISO image to standard output.
646 - The `<ARCH>` element in WIM XML data is now exported correctly.
648 - On Windows, sparse file attributes are no longer set on extracted files.
649 Oddly enough, this actually saves disk space in some cases.
651 - On UNIX, configuring with `--disable-xattr` or `--enable-xattr` is no longer
652 supported. Mounting WIM images now always requires extended attribute
653 support. Use `--without-fuse` to disable support for mounting WIM images;
654 this will also disable the need for extended attribute support.
656 - Configuring with `--enable-ssse3-sha1` now works correctly.
658 - The shared library version has been bumped up. The main incompatibilities
661 - `WIMLIB_COMPRESSION_TYPE_XPRESS` is now 1 and `WIMLIB_COMPRESSION_TYPE_LZX`
662 is now 2 (so it's the same as WIMGAPI).
664 - User-provided progress functions are now registered using a separate
665 function, `wimlib_register_progress_function()`. The `progress_func`
666 argument to many functions no longer exists.
668 - The return value from user-provided progress functions is now significant.
670 - A context argument has been added to the prototype of user-provided progress
673 - `struct wimlib_capture_config` has been removed. The library now takes the
674 path to the configuration file directly. This affects `wimlib_add_image()`,
675 `wimlib_add_image_multisource()`, and `wimlib_update_image()`. However, a
676 NULL value passed in the argument retains the same meaning.
678 - Removed deprecated functions: some (de)compression functions,
679 `wimlib_extract_files()`, and `wimlib_print_metadata()`.
681 - Removed extraction flags: `WIMLIB_EXTRACT_FLAG_HARDLINK`,
682 `WIMLIB_EXTRACT_FLAG_SYMLINK`, `WIMLIB_EXTRACT_FLAG_FILE_ORDER`, and
683 `WIMLIB_EXTRACT_FLAG_SEQUENTIAL`.
685 - Removed some progress messages: `WIMLIB_PROGRESS_MSG_APPLY_TIMESTAMPS`,
686 `WIMLIB_PROGRESS_MSG_EXTRACT_DIR_STRUCTURE_BEGIN`,
687 `WIMLIB_PROGRESS_MSG_EXTRACT_DIR_STRUCTURE_END`. Numbering stays the same.
689 - Removed some error codes. Numbering stays the same.
691 - Replaced `WIMLIB_UNMOUNT_FLAG_LAZY` with `WIMLIB_UNMOUNT_FLAG_FORCE`.
693 - WIM paths passed to progress functions now have a leading slash.
697 - Case-insensitive comparisons of strings (e.g. filenames) containing UTF-16
698 codepoints above 32767 are now done correctly.
700 - Fixed build failure on Mac OS X.
702 - `wimunmount` now provides the `--new-image` option to cause changes to a
703 read-write mounted image to be committed as a new image rather than as an
704 update of the mounted image. (The corresponding new library flag is
705 `WIMLIB_UNMOUNT_FLAG_NEW_IMAGE`.)
707 - The LZMS ("recovery") compression chunk size, or "dictionary size", may now be
708 up to 1 GiB (1,073,741,824 bytes).
710 - The performance of LZX ("maximum") and LZMS ("recovery") compression with
711 large chunk sizes has been slightly improved.
715 - Stored files with size exactly 4 GiB (4,294,967,296 bytes) are now
716 decompressed correctly.
718 - Fixed a bug in the LZX compressor introduced in v1.5.3. The bug occurred in
719 an unlikely case, and due to validity checks it did not affect successfully
722 - Fixed a minor compatibility issue with the LZMS compressor and decompressor.
723 This is *not* the default compression type and was only introduced in v1.6.0.
724 In the unlikely event that you created an LZMS-compressed WIM with v1.6.0 and
725 a checksum error is reported when applying it with v1.6.1, decompress it with
726 v1.6.0 then compress it with v1.6.1.
728 - Memory usage for LZMS and LZX compression has been decreased.
730 - wimextract now allows wildcard characters in paths specified on the command
731 line. Also, the `--strict-wildcards` option has been removed and replaced
732 with the inverse option `--nullglob`. See the documentation for wimextract
733 for more details and changes.
735 - The `wimlib_extract_files()` function is now considered deprecated in favor of
736 `wimlib_extract_paths()`.
738 - Fixed more permissions problems when extracting files on Windows.
740 - A new `--no-attributes` option has been added to `wimapply` and `wimextract`.
741 The library flag is `WIMLIB_EXTRACT_FLAG_NO_ATTRIBUTES`.
743 - The default chunk size is now set correctly when changing the compression type
744 of a WIM, for example with `wimoptimize`.
746 - The `--metadata` option to `wiminfo` has been replaced with the `--detailed`
749 - In relevant `wimlib-imagex` commands, `--solid` may now be used as an alias
750 for `--pack-streams`.
754 - Support for extracting and updating the new version 3584 WIMs has been added.
755 These WIMs typically pack many streams ("files") together into a single
756 compressed resource, thereby saving space. This degrades the performance of
757 random access (such as that which occurs on a mounted image), but
758 optimizations have been implemented for extraction. These new WIM files also
759 typically use a new compression format (LZMS), which is similar to LZMA and
760 can offer a better compression ratio than LZX. These new WIM files can be
761 created using `wimcapture` with the `--compress=lzms --pack-streams` options.
762 Note: this new WIM format is used by the Windows 8 web downloader, but
763 important segments of the raw `.esd` files are encrypted, so wimlib will not
764 be able to extract such files until they are first decrypted.
766 - wimlib now supports extracting files and directories from a WIM image based on
767 a "listfile" that itself contains the list of paths to extract. For
768 `wimextract`, the syntax is to specify `@LISTFILE` instead of a `PATH`, and
769 for the library itself, the new APIs are `wimlib_extract_pathlist()` and
770 `wimlib_extract_paths()`. Path globs containing wildcard characters are
773 - For searching WIM files, wimlib now has configurable case sensitivity. The
774 default on Windows is still case-insensitive and the default on UNIX-like
775 systems is still case-sensitive, but this can be overridden on either platform
776 through flags to `wimlib_global_init()`. For `wimlib-imagex`, the
777 environmental variable `WIMLIB_IMAGEX_IGNORE_CASE` can be set to 1 or 0 for
778 case-insensitive or case-sensitive behavior, respectively.
780 - Support for compression chunk sizes greater than the default of 32768
781 bytes has been added. A larger chunk size typically results in a better
782 compression ratio. However, the MS implementation is seemingly not
783 compatible with all chunk sizes, especially for LZX compression, so the
784 defaults remain unchanged, with the exception of the new LZMS-compressed
785 WIMs, which use a larger chunk size by default.
787 - The compression/decompression API exported by wimlib has been changed. Now
788 one set of functions handles all supported compression formats.
790 - `wimcapture` and `wimappend` will now display the progress of scanning the
791 directory tree to capture, in addition to the progress of writing data to the
792 WIM. The `--verbose` option no longer does anything. The library API change
793 for this is the addition of several members to `struct
794 wimlib_progress_info_scan` available to progress callbacks.
796 - `mkwinpeimg` now correctly handles the `--start-script` option when the start
797 script is not in the working directory.
799 - Sequential extraction, previously requested by using
800 `WIMLIB_EXTRACT_FLAG_SEQUENTIAL`, is now the default.
801 `WIMLIB_EXTRACT_FLAG_FILE_ORDER` can be used to get the old default behavior
802 (extract in file order).
806 - The new LZX compressor added in v1.5.2 has been improved and is now enabled by
807 default, except when `wimcapture` or `wimappend` is run *without* the
808 `--compress` option, in which case the faster LZX compressor is used (the same
809 as before). This behavior is reasonably consistent with ImageX which actually
810 uses "fast" (XPRESS) compression by default. In those cases, use
811 `--compress=maximum` to explicitly capture a WIM image using the new (slower
812 but better) LZX compressor.
814 The `--compress-slow` option still exists to `wimlib-imagex optimize`, but its
815 new behavior is to tweak the new LZX compressor even more to produce an even
816 better compression ratio at the cost of more time spent compressing.
818 - `wimlib-imagex optimize` now supports the `--compress=TYPE` option, which
819 recompresses the WIM file using the specified compression TYPE. The new
820 library API function used for this is `wimlib_set_output_compression_type()`.
822 - Added the `wimlib_get_xml_data()` function to allow library clients to easily
823 retrieve the raw XML data from a WIM file if needed.
825 - Fixed a bug that could cause an error code to be incorrectly returned when
826 writing XML data containing a `<WINDOWS>` element.
828 - Mounted WIM images will now correctly show the default file stream even if
829 appears in the alternate data stream entries of the corresponding WIM
834 - Added a new experimental LZX compressor which can be enabled by passing
835 `--compress-slow` to `wimlib-imagex capture` or `wimlib-imagex optimize`.
836 (The latter is only applicable if the WIM is already LZX-compressed and the
837 `--recompress` option is also given.) The experimental compressor is much
838 slower but compresses the data slightly more --- currently usually to within a
839 fraction of a percent of the results from WIMGAPI/ImageX.
841 - A workaround has been added for compatibility with versions of WinPE that
842 interpret alternate data stream entries in the boot WIM incorrectly.
844 - An alignment bug that caused a crash in the LZX decompressor on some builds
847 - wimlib now attempts to clear the `WIM_HDR_FLAG_WRITE_IN_PROGRESS` flag in the
848 WIM header when restoring the previous state of a WIM it failed to
851 - Added a workaround to avoid an access denied error on Windows when replacing a
852 WIM file that another process has opened.
856 - wimlib can now open WinPE WIMs from WAIK v2.1, which had a quirk that needed
859 - A bug in the interpretation of negative `IMAGE` indices in the
860 `--update-of=[WIMFILE:]IMAGE` option to `wimlib-imagex capture` and
861 `wimlib-imagex append` has been fixed.
863 - A workaround has been added to successfully apply security descriptors with
864 empty DACLs when the NTFS-3G apply mode is being used with NTFS-3G 2013.1.13
867 - `wimlib-imagex capture` can now accept the `--delta-from` option multiple
872 - Added support for "pipable" WIMs. Pipable WIMs allow capturing images to
873 standard output and applying images from standard input, but they are not
874 compatible with Microsoft's software and are not created by default. See the
875 documentation for `--pipable` flag of `wimlib-imagex capture` for more
878 - To better support incremental backups, added support for declaring an image as
879 a modified form of another image. See the documentation for the `--update-of`
880 option of `wimlib-imagex append` and `wimlib-imagex capture`.
882 - Added supported for "delta" WIMs. See the documentation for the
883 `--delta-from` option of `wimlib-imagex capture`.
885 - The library support for managing split WIMs has been changed to support other
886 arrangements, such as delta WIMs, and be easier to use. This change is
887 visible in `wimlib-imagex`, which also can now accept the `--ref` option
888 multiple times, and also now supports "delta" WIMs as mentioned above.
890 - wimlib now preserves WIM integrity tables by default, even if
891 `WIMLIB_WRITE_FLAG_CHECK_INTEGRITY` is not specified. This changes the
892 behavior of `wimlib-imagex` whenever the WIM being operated on contains
893 an integrity table and the `--check` option is not specified.
895 - `wimlib-imagex capture` now creates LZX-compressed WIMs by default (when
896 `--compress` is not specified). This provides the best compression ratio by
897 default, which is usually what is desired, at a cost of some speed.
899 - `wimlib-imagex` now supports being invoked as `wimCOMMAND`, where `COMMAND` is
900 the command as in `wimlib-imagex COMMAND`; for example, it can be invoked as
901 `wimapply` as an alternative to `wimlib-imagex apply`. The appropriate hard
902 links are created in UNIX installations of `wimlib-imagex`, while for the
903 Windows distribution of `wimlib-imagex`, batch files that emulate this
904 behavior are generated.
906 - Security descriptors are now extracted correctly on Windows.
908 - Fixed archiving DOS names in NTFS-3G capture mode.
910 - The extraction code has been rewritten and it will now be easier to support
911 new features on all supported backends (currently Win32, UNIX, and NTFS-3G).
912 For example, hard-linked extraction mode (`--hardlink`) is now supported on
913 all backends, not just UNIX.
915 - `mkwinpeimg` now supports grabbing files from the WAIK supplement rather
916 than the WAIK itself.
918 - `wimlib_global_init()` now, by default, attempts to acquire additional
919 privileges on Windows, so library clients need not do this.
921 - This update bumps the shared library version number up to 9, since it is not
922 binary compatibible with previous releases.
926 - Fixed bug in `wimlib-imagex export` that made it impossible to export an image
927 from a WIM that is readonly at the filesystem level.
929 - Return error code rather than segfaulting when trying to list files from a
930 non-first part of a split WIM.
932 - Joining a WIM will now preserve the `RP_FIX` and `READONLY` flags.
936 - On Windows, paths given to `wimlib-imagex` are now treated case insensitively.
938 - Improved behavior regarding invalid filenames; in particular, on Windows,
939 `wimlib-imagex` will, when extracting, now omit (with an option to override
940 this default) filenames differing only in case, or filenames containing
941 characters not valid on Windows.
943 - On Windows, wimlib now supports capturing and extracting long paths (longer
944 than the so-called `MAX_PATH`).
946 - On Windows, `wimlib-imagex update` now acquires proper privileges when running
949 - `wimlib-imagex update` will now complain if no image is specified when trying
950 to update a multi-image WIM.
952 - `wimlib-imagex update` now supports specifying a single update command
953 directly on the command line using the `--command` option.
955 - `wimlib-imagex` will now choose different units for progress messages,
956 depending on the amount of data that needs to be processed.
958 - `wimlib-imagex append` will now generate a unique WIM image name if no name is
959 specified and the defaulted name already exists in the WIM.
961 - wimlib now allows you to create unnamed WIM images, which can then only be
962 referred to by index.
964 - wimlib now allows you to explicitly declare you want write access to a WIM by
965 providing the `WIMLIB_OPEN_FLAG_WRITE_ACCESS` flag to `wimlib_open_wim()`.
967 - wimlib now respects the `WIM_HDR_FLAG_READONLY` flag when set in the WIM header.
969 - Progress callbacks have been added to wimlib's `wimlib_update_image()`
972 - Added `wimlib_get_wim_info()`, `wimlib_set_wim_info()`,
973 `wimlib_iterate_dir_tree()`, and `wimlib_iterate_lookup_table()` functions to
976 - NTFS-3G capture now only warns about two conditions previously treated as
979 - Fixed a couple issues with using `wimlib-imagex` on UDF filesystems on
982 - wimlib now correctly detects and returns an error when reading a WIM image
983 with a cyclic directory structure. (Fun fact: such a WIM will crash
984 Microsoft's software.)
988 - Added new "extract" and "update" subcommands to `wimlib-imagex`, along with
989 associated APIs in the library. These commands are intended mainly for
990 Windows use but can be used on UNIX as well.
992 - Many documentation improvements.
994 - Fixed a bug in the Windows build where relative symbolic links were not
995 captured in reparse-point fixup mode.
997 - Fixed a bug in the Windows build where file handles were left open to the WIM
998 file, causing `wimlib-imagex optimize` to fail in some cases.
1000 - Fixed a bug in the Windows build of `wimlib-imagex` where globbing split-WIM
1001 parts could cause the program to crash.
1003 - Fixed a bug where the creation time of WIM images would be shown instead of
1004 the last modification time.
1006 - With the Windows build it is now possible to restore a WIM containing symbolic
1007 links as a non-Administrator; however you will receive warnings about not
1008 being able to extract the symbolic links.
1012 - Capturing a WIM image should now be significantly faster in most cases due to
1013 improved use of the operating system's cache and avoiding reading files twice
1016 - The Windows build should now work on Windows XP.
1018 - The Windows build now supports capturing and restoring hidden, compressed,
1019 sparse, and encrypted files.
1021 - The Windows build now supports capturing and applying WIM images from
1022 filesystems other than NTFS (with some reduced functionality).
1024 - The Windows build now extracts short names correctly.
1026 - Added support for "reparse-point" fixups (i.e. fixing up of symbolic links).
1027 See docs for `--rpfix` and `--norpfix` flags of `wimlib-imagex capture` and
1028 `wimlib-imagex apply`.
1030 - The performance of splitting and joining WIMs should be slightly improved.
1032 - The LZX and XPRESS compression and decompression functions are now exported
1037 - Improvements and bugfixes for the Windows build.
1039 - Added `--strict-acls` options.
1041 - Fixed the way that wimlib determines the order of images in the WIM.
1045 - Since wimlib can now be used on Windows, wimlib's implementation of ImageX has
1046 been renamed to `wimlib-imagex` to avoid confusion with Microsoft's
1047 implementation of ImageX, which would have the same file name (`imagex.exe`).
1048 If you really don't like this you can pass the `--with-imagex-progname` option
1049 to `configure` to choose a different name, or even simply rename the binary
1050 yourself (but the former way will configure the man pages to use the chosen
1053 - Various bugs fixed in the Windows build. Mainly to do with capturing and
1054 restoring alternate data streams correctly in weird cases, and requesting the
1055 correct privileges when opening files. Also added the `--noacls` options to
1056 `wimlib-imagex` capture, append, and apply.
1058 - Windows build again: `FindFirstStreamW()` and `FindNextStreamW()` are now
1059 dynamically loaded, so this may make the library compatible with Windows XP
1060 (however, there may still be other problems).
1064 - Added experimental support for native Windows builds. Binaries can be
1065 downloaded from the SourceForge page.
1067 - `--source-list` option added to `imagex capture` and `imagex append`.
1069 - Better support for different character encodings.
1073 - Storing UNIX file owners, groups, and modes in WIM images is now
1074 - possible using `imagex capture` with the `--unix-data` flag.
1076 - Minor bug fixes and documentation fixes.
1080 - NTFS capture: Fixed capturing duplicate reparse points.
1082 - NTFS capture: Capture first unnamed stream if there are more than one (print
1083 warning instead of error).
1085 - Allow multiple test cases to execute concurrently (e.g. `make -j2 check`).
1089 - Added `--arch` switch to mkwinpeimg script to support getting AMD64 WinPE from
1092 - Update to work with ntfs-3g version 2013.1.13.
1096 - Fixed truncating file to shorter but non-zero length on read-write mounted WIM
1099 - Various code cleanups and minor documentation fixes.
1103 - LZX and XPRESS decompression have received some additional optimizations and
1104 should now be even faster. (Although, they were already pretty fast --- much
1105 faster than typical I/O speeds.)
1107 - Fixed a bug introduced in v1.2.1 that would cause a directory tree containing
1108 hard links to be captured incorrectly in some cases.
1112 - By default, unmounting a read-write mounted WIM with `imagex unmount --commit`
1113 will now change the WIM in-place without needing to write the entire WIM
1114 again. Use `imagex unmount --commit --rebuild` to get the old behavior.
1116 - `imagex unmount` no longer has a hard-coded limit of 10 minutes to wait for a
1117 response from the daemon servicing the mounted WIM. Instead, every second
1118 `imagex unmount` will check if the daemon is still alive, and keep waiting if
1119 so, otherwise terminate with an error.
1121 - `imagex unmount --commit` on a read-write mounted WIM will now print progress
1122 information regarding the writing of new or modified streams the WIM, just
1123 like when capturing or appending a WIM.
1125 - A small change has been made to XPRESS compression and it should improve the
1126 compression ratio slightly.
1128 - A change was made that may improve performance slightly when applying a WIM
1129 image to a NTFS volume.
1131 - Microsoft has managed to introduce even more bugs into their software, and now
1132 the WIMs for Windows 8 have incorrect (too low) reference counts for some
1133 streams. This is unsafe because such streams can be removed when they are in
1134 actuality still referenced in the WIM (perhaps by a different image). wimlib
1135 will now work around this problem by fixing the stream reference counts. This
1136 is only done when `wimlib_delete_image()` is called (`imagex delete`) or when
1137 `wimlib_mount_image()` is called with `WIMLIB_MOUNT_FLAG_READWRITE` (`imagex
1138 mountrw`). Please note that this requires reading the metadata for all images
1139 in the WIM, so this will make these operations noticably slower on WIMs with
1142 - Various other bugfixes.
1146 - Appending images to a WIM is now be done by default without re-building the
1147 whole WIM. Use the `--rebuild` flag to get the old behavior (which was to
1148 re-build the entire WIM when a new image is appended).
1150 - A new command `imagex optimize` is now available to manually re-build a WIM
1151 that has wasted space due to repeated appends.
1153 - Progress information has been improved, and now arbitrary callback functions
1154 can be used to show the progress of a WIM operation.
1156 - A possible bug with changing the bootable image of a WIM was fixed.
1158 - Some advisory locking is now done to prevent two processes from modifying a
1159 WIM at the same time (but only in some cases). For example, you cannot mount
1160 two images from a WIM read-write at the same time.
1162 - Some functions have been reorganized:
1163 - `wimlib_mount()` renamed to `wimlib_mount_image()`.
1164 - `wimlib_unmount()` renamed to `wimlib_unmount_image()`.
1165 - `wimlib_overwrite_xml_and_header()` removed as `wimlib_overwrite()` suffices
1167 - `wimlib_apply_image_to_ntfs_volume()` removed as `wimlib_extract_image()`
1169 - `wimlib_add_image_from_ntfs_volume()` removed as `wimlib_add_image()`
1172 - Previously, the soname of libwim.so has been 0.0.0, despite many interface
1173 changes. The soname is now updated to 1.0.0 and will now be updated each
1178 - Resources will now be compressed using multiple threads by default. (This
1179 applies to `imagex capture`, `imagex append`, and `imagex export`).
1181 - Some performance improvements in mounted WIMs.
1183 - More progress information is shown when capturing a WIM.
1187 - Lots of minor fixes, code cleanups, and some documentation updates. Nothing
1188 in particular is really noteworthy.
1192 - LZX and XPRESS compression improvements.
1194 - Fixed calculation of Directory Count, File Count, Total Bytes, and Hard Link
1199 - Fixed bug when capturing NTFS file with multiple named data streams.
1201 - Internally, we are now using inode structures, even though these don't appear
1202 literally in the WIM file. This simplifies some of the code (mainly for WIM
1203 mounting) and likely fixed a few problems, although it needs more testing.
1207 - Fixed problem when exporting images from XPRESS to LZX compressed WIM or vice
1212 - Enough changes to call it version 1.0.0!
1214 - Capturing a WIM directly from a NTFS volume, and applying a WIM directly to a
1215 NTFS volume, is now supported.
1217 - Hard links and symbolic links have much improved support. They are supported
1218 for WIM capture, WIM application, and mounted WIMs (you can even make them on
1219 read-write mounted WIMs).
1221 - Alternate data streams are now supported on mounted WIMs through an xattr or a
1222 Windows-style stream interface. Also they are supported when capturing a WIM
1223 from NTFS or applying a WIM to NTFS.
1225 - Split WIMs are better supported. You may now apply an image directly from a
1226 split WIM, mount an image from a split WIM read-only, or export an image from
1229 - Using a capture configuration file is now supported (but not fully yet).
1231 - SHA1 message digests are checked in more places, so we can make sure applied
1232 and captured data is correct.
1234 - Man pages have been updated and consolidated.
1238 - Fixed segfault when unmounting read-only WIM.
1242 - Support for joining and splitting WIMs.
1244 - Also, security data is now preserved by default.
1248 - Can now build with older gcc and system headers, like on CentOS 5.
1252 - Fixed bug that made it impossible to overwrite files in read-write mount.
1256 - Write byte-order mark before WIM XML data. (`imagex.exe` requires this to be