2 On all platforms, sparse files are now extracted as sparse.
4 Sparse files captured from UNIX-style filesystems are now marked as
5 sparse in the resulting WIM image.
7 Added support for storing Linux-style extended attributes in WIM images.
8 When the --unix-data option is used on Linux, wimlib-imagex now captures
9 and applies extended attributes, in addition to the already-supported
10 standard UNIX file permissions (owner/group/mode) and special files.
12 --delta-from is now supported by wimappend. (Previously it was only
13 supported by wimcapture.)
15 On Windows, improved the way in which files deduplicated with Windows'
16 Data Deduplication feature are captured.
18 The development files needed to link with wimlib using Visual Studio are
19 now included in the Windows release archives.
21 wimlib.h can now be included by Visual Studio without errors.
23 The example programs can now be compiled in C++ mode, and they also now
26 Updated 'mkwinpeimg' to work correctly on images that have a "windows"
27 (lower case) directory rather than a "Windows" (upper case) directory.
29 Fixed configuring with --enable-ssse3-sha1 from release tarball
30 (the file nasm_lt.sh was missing).
32 Made some documentation improvements.
35 The LZX compression ratio has been slightly improved. The default mode,
36 LZX level 50, is now almost as good as the old LZX level 100, while
37 being nearly the same speed as before.
39 Decompression performance has been slightly improved.
41 Filenames are now always listed in NTFS collation order.
43 On UNIX-like systems, wimlib can now process Windows filenames that are
44 not valid Unicode due to the presence of unpaired surrogates.
46 On UNIX-like systems, wimlib now always assumes UTF-8 encoding with the
47 addition of surrogate codepoints. Consequently, the environmental
48 variable WIMLIB_IMAGEX_USE_UTF8 and the flag
49 WIMLIB_INIT_FLAG_ASSUME_UTF8 no longer have any effect.
51 wimlib no longer depends on iconv.
53 Reduced memory usage slightly.
55 When a WIM image is applied in NTFS-3G mode, security descriptors are
56 now created in NTFS v3.0 format when supported by the volume.
58 Workarounds for bugs in libntfs-3g version 2013.1.13 and earlier have
59 been removed. Users are advised to upgrade to a later version of
62 On Windows, wimlib now supports case-sensitive filename extraction when
63 supported by the underlying operating system and filesystem (operating
64 system support requires a registry setting).
67 On UNIX, wimlib can now overwrite readonly files when extracting.
69 On Windows, fixed a bug where wimlib could leave a null DACL (a.k.a. "no
70 NTFS permissions") set on some existing directories after extraction.
72 On Windows, when applying a WIM image in "WIMBoot mode" when the WOF
73 driver is not loaded, wimlib can now correctly register a new WIM file
74 with the target volume when the target volume previously had had WIM
77 Added a new testing program.
79 Clarified the main license text and updated public domain dedications
80 for certain files to be more thorough.
83 Object IDs are now saved and restored on Windows and in NTFS-3G mode.
85 Reduced memory usage when exporting large numbers of WIM images.
87 Non UTF-8 locales are now detected correctly.
89 Addressed compiler warnings and enabled "silent" make rules by default.
91 Windows-specific updates:
92 Fixed a bug where duplicate backslashes could be generated in
93 link targets when extracting symbolic links and junctions.
95 Fixed a bug where the .cmd shortcuts for wimlib-imagex wouldn't
96 work if their full path contained a space.
98 Fixed bugs related to scanning SMB filesystems.
100 Added warning message about known issue with WindowsApps folder.
102 Added instructions for building from source on Windows.
104 VSS support is no longer marked "experimental".
106 Added missing license file for libdivsufsort-lite.
109 Added experimental support for Windows VSS (Volume Shadow Copy Service).
110 The new '--snapshot' argument to 'wimcapture' makes wimlib automatically
111 create and use a temporary VSS snapshot when capturing a WIM image.
113 Implemented setting of Windows-specific XML information, such as
114 architecture, system root, and version details. This information is now
115 automatically set in newly captured WIM images, when appropriate.
117 Improved performance of directory tree scans on Windows.
119 On Windows, to improve capture performance, wimlib now sometimes opens
120 files by inode number rather than by path. This is enabled for
121 wimcapture and wimappend, but for now other applications have to opt-in.
123 The progress messages printed by wimlib-imagex while writing WIM files
124 have been slightly tweaked.
126 Progress information for directory tree scans now counts all hard links.
127 Also, on Windows "\\?\" is no longer stripped from the current path.
129 Added a new '--image-property' option to 'wimcapture', 'wimappend', and
130 'wiminfo'. This option lets you assign values to elements in a WIM
131 file's XML document by name.
133 The wimlib_get_image_property() and wimlib_set_image_property() API
134 functions now support numerically indexed elements.
136 Fixed a bug where, on Windows, wimlib would change the security
137 descriptor of the target directory of an extraction even when the
138 '--no-acls' option was specified.
141 Fixed a bug with libntfs-3g extraction present since v1.8.1. Sometimes,
142 some Microsoft software would not correctly recognize data in the
143 resulting filesystem.
145 Made some small improvements to the compression algorithms:
146 LZX compression ratio was slightly improved.
147 XPRESS compression ratio and speed was slightly improved.
148 LZMS compression speed was slightly improved.
150 Improved handling of WIM XML data. wimlib no longer drops unrecognized
151 elements when exporting images. In addition, two API functions were
152 added for better access to elements in the XML document:
153 wimlib_get_image_property() and wimlib_set_image_property().
155 Added support for (unsafe) in-place compaction of WIM files.
157 Improved performance of image export by reusing metadata resources
158 instead of always rebuilding and recompressing them.
160 Improved performance of wimlib_update_image() by delaying the update to
161 the WIM's XML document until a write is requested.
163 On Windows, the target of an extraction may now be a reparse point
164 (which will be dereferenced).
166 On Windows, wimlib now correctly restores non-Microsoft reparse points.
167 However, this remains broken in NTFS-3g mode due to a libntfs-3g bug.
169 On Windows, wimlib now has improved performance when archiving files
170 from a filesystem backed by a WIM (a "WIMBoot" setup).
172 Several improvements to System Compression (compact mode) support:
174 wof.sys (or wofadk.sys) is now automatically attached to the
175 target volume if needed.
177 Compact-mode extractions now work correctly with wofadk.sys on
178 older versions of Windows.
180 For compatibility with the Windows bootloader, the requested
181 compression format now is overridden on certain files.
183 Other minor bugfixes.
186 This release primarily contains various minor bug fixes and
187 improvements, including:
189 Improved handling of deep directory structures.
191 Fixed a bug where on 32-bit systems, the library could enter an
192 infinite loop if a WIM file was malformed in a specific way.
194 Added a workaround for a case where libntfs-3g may report
195 duplicate streams in an NTFS file.
197 Windows symbolic links and junctions in mounted WIM images are
198 now automatically rewritten to be valid in the mounted location.
200 Reparse point fixes: correctly handle the "ReparseReserved"
201 field, and correctly handle "empty" (data-less) reparse points.
203 On Windows, wimlib now acquires SeManageVolumePrivilege, which
204 is needed to create externally backed files using the
207 Improved validation of filenames.
209 Improved LZMS decompression speed.
211 The configure script now honors alternate pkg-config settings.
213 Links have been updated to point to the new website.
215 In addition, experimental support has been added for compressing
216 extracted files using System Compression on Windows 10. This
217 functionality is available through the new '--compact' option to
218 'wimapply' and 'wimextract' as well as new library flags.
221 Fixed a bug in the LZX decompressor: malicious input data could cause
222 out of bounds writes to memory (since wimlib v1.2.2).
224 The output of the 'wiminfo' command now consolidates various boolean
225 flags (such as "Relative path junction") into a single line.
227 A file can now have both an unnamed data stream ("file contents") and a
228 reparse point stream. Such files can exist as a result of the use of
229 certain Windows features, such as offline storage, including "OneDrive".
230 wimlib will now store and restore both streams on Windows as well as in
231 NTFS-3g mode. Microsoft's WIMGAPI also has this behavior.
233 On Windows, named data streams of encrypted files are no longer stored
234 twice in WIM archives.
236 On Windows, named data streams are now correctly extracted to existing
237 "readonly" directories. Before, an error would be reported.
239 On Windows, it is now possible to do a "WIMBoot mode" extraction with
240 non-standalone WIMs such as delta WIMs.
242 On Windows, when doing an extraction in "WIMBoot mode", files larger
243 than 4 gigabytes are now never extracted as externally backed. This
244 works around a bug in Microsoft's "WOF" driver.
246 The '--enable-verify-compression' configure option has been removed. If
247 you want to verify a WIM file, use the 'wimverify' program.
249 The way the "file count", "directory count", "total bytes", and "hard
250 link bytes" image statistics (stored in the WIM XML data) is calculated
251 has been slightly changed.
253 In mounted WIM images, the disk usage provided for each file (st_blocks)
254 is now the compressed size rather than the uncompressed size.
256 The performance of the NTFS-3g and Windows capture modes has been
259 On UNIX-like systems, symbolic links whose targets contain the backslash
260 character are now handled correctly (losslessly).
263 Improved the LZX compressor. It is now 15-20% faster than before and
264 provides a slightly better compression ratio.
266 Improved the LZMS compressor. It now provides a compression ratio
267 slightly better than WIMGAPI while still being faster and using slightly
270 The compression chunk size in solid resources, e.g. when capturing or
271 exporting a WIM file using the '--solid' option, now defaults to 64 MiB
272 (67108864 bytes) instead of 32 MiB (33554432 bytes). This provides a
273 better compression ratio and is the same value that WIMGAPI uses. The
274 memory usage is less than 50% higher than wimlib v1.7.4 and is slightly
275 lower than WIMGAPI's memory usage, but if it is too much, it is still
276 possible to choose a lower value, e.g. with the '--solid-chunk-size'
277 option to wimlib-imagex.
279 The '--chunk-size' and '--solid-chunk-size' options to wimlib-imagex now
280 accept the 'K', 'M', and 'G' suffixes.
282 Files are now sorted by name extension when creating a solid WIM file.
284 Fixed various issues related to capture/apply of EFS-encrypted files on
287 The file list printed by 'wimdir' is now sorted by the platform-specific
288 case sensitivity setting, rather than always case sensitively. This
289 also affects the library function wimlib_iterate_dir_tree().
291 On Windows, some error and warning messages have been improved.
294 The Windows binary distribution no longer contains third party DLLs.
295 These dependencies are instead compiled directly into the libwim DLL.
297 Added more fixes for wimlib on non-x86 architectures such as ARM.
299 Extracting files to a Windows PE in-memory filesystem no longer fails if
300 the target files do not yet exist.
302 Improved the performance of XPRESS compression and LZMS decompression.
304 Enabled SSSE3 accelerated SHA-1 computation in x86_64 Windows builds.
305 It will automatically be faster on newer Intel and AMD processors.
307 Removed the --with-imagex-progname and --enable-more-assertions
311 Fix for very slow export from solid WIM / ESD files.
313 Fix for LZX and LZMS algorithms on non-x86 architectures, such as ARM.
315 New progress message: WIMLIB_PROGRESS_MSG_HANDLE_ERROR. Applications
316 may use this to treat some types of errors as non-fatal.
318 The library now permits making in-memory changes to a WIMStruct backed
319 by a read-only WIM file.
321 Fixes for "WIMBoot" extraction mode (Windows only):
323 When not using the WOF driver, extraction no longer fails if the
324 disk containing the WIM file has too many partitions.
326 When matching patterns in [PrepopulateList], all hard links of
327 each file are now considered.
329 The system registry files are now automatically treated as being
330 in [PrepopulateList].
332 Added a hack to try to work around an intermittent bug in
333 Microsoft's WOF (Windows Overlay Filesystem) driver.
336 Made more improvements to the XPRESS, LZX, and LZMS compressors.
338 A number of improvements to the Windows port:
340 Fixes for setting short filenames.
342 Faster "WIMBoot" extraction.
344 Updated and slimmed down the dependent DLLs.
346 ACL inheritence bits are now restored.
348 Mandatory integrity labels are now backed up and restored.
350 Added a workaround for an issue where in rare cases, wimlib could create
351 a compressed data stream that could not be read correctly by Windows
352 after an extraction in "WIMBoot" mode.
355 Added file count progress data for
356 WIMLIB_PROGRESS_MSG_EXTRACT_FILE_STRUCTURE and
357 WIMLIB_PROGRESS_MSG_EXTRACT_METADATA.
359 Added support for testing file exclusions via the user-provided
362 Some documentation improvements.
364 Made some clarifications to the license text in the COPYING file.
367 Made more improvements to the XPRESS, LZX, and LZMS compressors.
369 The default compression mode for wimcapture is now LZX compression in
370 its default mode, which is the same as '--compress=maximum'.
372 You can now specify an optional integer compression level to the
373 '--compress' option; e.g. '--compress=lzx:75'.
375 Made a minor change to the LZMS compressor and decompressor to fix an
376 incompatibility with the Microsoft implementation. In the unlikely
377 event that you created an LZMS-compressed WIM with wimlib v1.7.0 or
378 earlier and a checksum error is reported when extracting files from it
379 with wimlib v1.7.1, decompress it with v1.7.0 then compress it with
382 Added 'verify' subcommand to wimlib-imagex.
384 Notable library changes:
386 Custom compressor parameters have been removed from the library
387 in favor of the simpler level-based API.
389 Decompressor parameters have been removed entirely.
391 Library users can now specify a custom file for warning and
392 error messages to be sent to, rather than the default of
395 New progress messages:
396 WIMLIB_PROGRESS_MSG_EXTRACT_FILE_STRUCTURE,
397 WIMLIB_PROGRESS_MSG_EXTRACT_METADATA.
399 New function: wimlib_verify_wim().
402 Improved compression, decompression, and extraction performance.
404 Improved compatibility with version 3584 WIM / ESD files:
405 - Add support for reading and writing multiple solid blocks per
406 archive, which WIMGAPI/DISM can create when appending an image.
407 - Correctly create solid blocks larger than 4 GiB.
409 'add' commands passed to wimupdate will now replace existing
410 nondirectory files by default. Use the --no-replace option to get the
413 The license for the library now contains an exception that allows using
414 it under the LGPL. See the COPYING file for details.
416 In reparse-point fixup mode (the default for capture), symbolic links
417 and junctions that point outside the tree being captured are no longer
418 excluded from capture.
420 Added support for "WIMBoot" capture and extraction. See the
421 documentation for the new '--wimboot' option to wimcapture and wimapply
422 for more information.
424 On UNIX-like systems, you can now backup and restore device nodes, named
425 pipes, and sockets. In addition, 32-bit user and group IDs are now
428 The way that UNIX data is stored in WIM files has been changed. If you
429 captured any WIMs with the --unix-data option, to upgrade them you'll
430 need to apply them with --unix-data using wimlib-imagex v1.6.2, then
431 re-capture them with --unix-data using this version.
433 wimlib now understands tagged metadata items, such as object IDs, that
434 can be stored in WIM directory entries.
436 Removed the --hardlink and --symlink options to wimapply, since I don't
437 think they are too useful and they got in the way of improving the code.
439 WIMs will now retain their GUIDs when rebuilt (e.g. with wimoptimize).
441 The 'mkwinpeimg' script now supports writing the ISO image to standard
444 The <ARCH> element in WIM XML data is now exported correctly.
446 On Windows, sparse file attributes are no longer set on extracted files.
447 Oddly enough, this actually saves disk space in some cases.
449 On UNIX, configuring with --disable-xattr or --enable-xattr is no longer
450 supported. Mounting WIM images now always requires extended attribute
451 support. Use --without-fuse to disable support for mounting WIM images;
452 this will also disable the need for extended attribute support.
454 Configuring with --enable-ssse3-sha1 now works correctly.
456 The shared library version has been bumped up. The main
457 incompatibilities are:
459 - WIMLIB_COMPRESSION_TYPE_XPRESS is now 1 and
460 WIMLIB_COMPRESSION_TYPE_LZX is now 2 (so it's the same as
463 - User-provided progress functions are now registered using a
464 separate function, wimlib_register_progress_function(). The
465 'progress_func' argument to many functions no longer exists.
467 - The return value from user-provided progress functions is now
470 - A context argument has been added to the prototype of
471 user-provided progress functions.
473 - 'struct wimlib_capture_config' has been removed. The library
474 now takes the path to the configuration file directly. This
475 affects wimlib_add_image(), wimlib_add_image_multisource(),
476 and wimlib_update_image(). However, a NULL value passed in
477 the argument retains the same meaning.
479 - Removed deprecated functions: some (de)compression functions,
480 wimlib_extract_files(), and wimlib_print_metadata().
482 - Removed extraction flags: WIMLIB_EXTRACT_FLAG_HARDLINK,
483 WIMLIB_EXTRACT_FLAG_SYMLINK, WIMLIB_EXTRACT_FLAG_FILE_ORDER,
484 and WIMLIB_EXTRACT_FLAG_SEQUENTIAL.
486 - Removed some progress messages:
487 WIMLIB_PROGRESS_MSG_APPLY_TIMESTAMPS,
488 WIMLIB_PROGRESS_MSG_EXTRACT_DIR_STRUCTURE_BEGIN,
489 WIMLIB_PROGRESS_MSG_EXTRACT_DIR_STRUCTURE_END. Numbering
492 - Removed some error codes. Numbering stays the same.
494 - Replaced WIMLIB_UNMOUNT_FLAG_LAZY with
495 WIMLIB_UNMOUNT_FLAG_FORCE.
497 - WIM paths passed to progress functions now have a leading
501 Case-insensitive comparisons of strings (e.g. filenames) containing
502 UTF-16 codepoints above 32767 are now done correctly.
504 Fixed build failure on Mac OS X.
506 wimunmount now provides the '--new-image' option to cause changes to a
507 read-write mounted image to be committed as a new image rather than as
508 an update of the mounted image. (The corresponding new library flag is
509 WIMLIB_UNMOUNT_FLAG_NEW_IMAGE.)
511 The LZMS ("recovery") compression chunk size, or "dictionary size", may
512 now be up to 1 GiB (1,073,741,824 bytes).
514 The performance of LZX ("maximum") and LZMS ("recovery") compression
515 with large chunk sizes has been slightly improved.
518 Stored files with size exactly 4 GiB (4,294,967,296 bytes) are now
519 decompressed correctly.
521 Fixed a bug in the LZX compressor introduced in v1.5.3. The bug
522 occurred in an unlikely case, and due to validity checks it did not
523 affect successfully created archives.
525 Fixed a minor compatibility issue with the LZMS compressor and
526 decompressor. This is *not* the default compression type and was only
527 introduced in v1.6.0. In the unlikely event that you created an
528 LZMS-compressed WIM with v1.6.0 and a checksum error is reported when
529 applying it with v1.6.1, decompress it with v1.6.0 then compress it with
532 Memory usage for LZMS and LZX compression has been decreased.
534 wimextract now allows wildcard characters in paths specified on the
535 command line. Also, the '--strict-wildcards' option has been removed
536 and replaced with the inverse option '--nullglob'. See the
537 documentation for wimextract for more details and changes.
539 The wimlib_extract_files() function is now considered deprecated in
540 favor of wimlib_extract_paths().
542 Fixed more permissions problems when extracting files on Windows.
544 A new '--no-attributes' option has been added to wimapply and
545 wimextract. The library flag is WIMLIB_EXTRACT_FLAG_NO_ATTRIBUTES.
547 The default chunk size is now set correctly when changing the
548 compression type of a WIM, for example with 'wimoptimize'.
550 The '--metadata' option to wiminfo has been replaced with the
551 '--detailed' option to wimdir.
553 In relevant wimlib-imagex commands, '--solid' may now be used as an
554 alias for '--pack-streams'.
557 Support for extracting and updating the new version 3584 WIMs has been
558 added. These WIMs typically pack many streams ("files") together into a
559 single compressed resource, thereby saving space. This degrades the
560 performance of random access (such as that which occurs on a mounted
561 image), but optimizations have been implemented for extraction. These
562 new WIM files also typically use a new compression format (LZMS), which
563 is similar to LZMA and can offer a better compression ratio than LZX.
564 These new WIM files can be created using `wimcapture' with
565 the '--compress=lzms --pack-streams' options. Note: this new WIM format
566 is used by the Windows 8 web downloader, but important segments of the
567 raw '.esd' files are encrypted, so wimlib will not be able to extract
568 such files until they are first decrypted.
570 wimlib now supports extracting files and directories from a WIM image
571 based on a "listfile" that itself contains the list of paths to extract.
572 For `wimextract', the syntax is to specify @LISTFILE instead of a PATH,
573 and for the library itself, the new APIs are wimlib_extract_pathlist()
574 and wimlib_extract_paths(). Path globs containing wildcard characters
577 For searching WIM files, wimlib now has configurable case sensitivity.
578 The default on Windows is still case-insensitive and the default on
579 UNIX-like systems is still case-sensitive, but this can be overridden
580 on either platform through flags to wimlib_global_init(). For
581 `wimlib-imagex', the environmental variable WIMLIB_IMAGEX_IGNORE_CASE
582 can be set to 1 or 0 for case-insensitive or case-sensitive behavior,
585 Support for compression chunk sizes greater than the default of 32768
586 bytes has been added. A larger chunk size typically results in a better
587 compression ratio. However, the MS implementation is seemingly not
588 compatible with all chunk sizes, especially for LZX compression, so the
589 defaults remain unchanged, with the exception of the new LZMS-compressed
590 WIMs, which use a larger chunk size by default.
592 The compression/decompression API exported by wimlib has been changed.
593 Now one set of functions handles all supported compression formats.
595 `wimcapture' and `wimappend' will now display the progress of scanning
596 the directory tree to capture, in addition to the progress of writing
597 data to the WIM. The '--verbose' option no longer does anything. The
598 library API change for this is the addition of several members to
599 `struct wimlib_progress_info_scan' available to progress callbacks.
601 `mkwinpeimg' now correctly handles the '--start-script' option when the
602 start script is not in the working directory.
604 Sequential extraction, previously requested by using
605 WIMLIB_EXTRACT_FLAG_SEQUENTIAL, is now the default.
606 WIMLIB_EXTRACT_FLAG_FILE_ORDER can be used to get the old default
607 behavior (extract in file order).
610 The new LZX compressor added in v1.5.2 has been improved and is now
611 enabled by default, except when `wimcapture' or `wimappend' is run
612 *without* the '--compress' option, in which case the faster LZX
613 compressor is used (the same as before). This behavior is reasonably
614 consistent with ImageX which actually uses "fast" (XPRESS) compression
615 by default. In those cases, use '--compress=maximum' to explicitly
616 capture a WIM image using the new (slower but better) LZX compressor.
618 The '--compress-slow' option still exists to `wimlib-imagex optimize',
619 but its new behavior is to tweak the new LZX compressor even more to
620 produce an even better compression ratio at the cost of more time spent
623 `wimlib-imagex optimize' now supports the '--compress=TYPE' option,
624 which recompresses the WIM file using the specified compression TYPE.
625 The new library API function used for this is
626 wimlib_set_output_compression_type().
628 Added the wimlib_get_xml_data() function to allow library clients to
629 easily retrieve the raw XML data from a WIM file if needed.
631 Fixed a bug that could cause an error code to be incorrectly returned
632 when writing XML data containing a <WINDOWS> element.
634 Mounted WIM images will now correctly show the default file stream even
635 if appears in the alternate data stream entries of the corresponding WIM
639 Added a new experimental LZX compressor which can be enabled by passing
640 '--compress-slow' to `wimlib-imagex capture' or `wimlib-imagex
641 optimize'. (The latter is only applicable if the WIM is already
642 LZX-compressed and the '--recompress' option is also given.) The
643 experimental compressor is much slower but compresses the data slightly
644 more --- currently usually to within a fraction of a percent of the
645 results from WIMGAPI/ImageX.
647 A workaround has been added for compatibility with versions of WinPE
648 that interpret alternate data stream entries in the boot WIM
651 An alignment bug that caused a crash in the LZX decompressor on some
654 wimlib now attempts to clear the WIM_HDR_FLAG_WRITE_IN_PROGRESS flag in
655 the WIM header when restoring the previous state of a WIM it failed to
658 Added a workaround to avoid an access denied error on Windows when
659 replacing a WIM file that another process has opened.
662 wimlib can now open WinPE WIMs from WAIK v2.1, which had a quirk that
663 needed to be handled.
665 A bug in the interpretation of negative IMAGE indices in the
666 --update-of=[WIMFILE:]IMAGE option to `wimlib-imagex capture' and
667 `wimlib-imagex append' has been fixed.
669 A workaround has been added to successfully apply security descriptors
670 with empty DACLs when the NTFS-3g apply mode is being used with NTFS-3g
671 2013.1.13 or earlier.
673 `wimlib-imagex capture' can now accept the '--delta-from' option
677 Added support for "pipable" WIMs. Pipable WIMs allow capturing images
678 to standard output and applying images from standard input, but they are
679 not compatible with Microsoft's software and are not created by default.
680 See the documentation for --pipable flag of `wimlib-imagex capture' for
683 To better support incremental backups, added support for declaring an
684 image as a modified form of another image. See the documentation for
685 the '--update-of' option of `wimlib-imagex append' and `wimlib-imagex
688 Added supported for "delta" WIMs. See the documentation for the
689 '--delta-from' option of `wimlib-imagex capture'.
691 The library support for managing split WIMs has been changed to support
692 other arrangements, such as delta WIMs, and be easier to use. This
693 change is visible in `wimlib-imagex', which also can now accept the
694 '--ref' option multiple times, and also now supports "delta" WIMs as
697 wimlib now preserves WIM integrity tables by default, even if
698 WIMLIB_WRITE_FLAG_CHECK_INTEGRITY is not specified. This changes the
699 behavior of `wimlib-imagex' whenever the WIM being operated on contains
700 an integrity table and the '--check' option is not specified.
702 `wimlib-imagex capture' now creates LZX-compressed WIMs by default
703 (when --compress is not specified). This provides the best compression
704 ratio by default, which is usually what is desired, at a cost of some
707 `wimlib-imagex' now supports being invoked as wimCOMMAND, where COMMAND
708 is the command as in `wimlib-imagex COMMAND'; for example, it can be
709 invoked as `wimapply' as an alternative to `wimlib-imagex apply'. The
710 appropriate hard links are created in UNIX installations of
711 `wimlib-imagex', while for the Windows distribution of `wimlib-imagex',
712 batch files that emulate this behavior are generated.
714 Security descriptors are now extracted correctly on Windows.
716 Fixed archiving DOS names in NTFS-3g capture mode.
718 The extraction code has been rewritten and it will now be easier to
719 support new features on all supported backends (currently Win32, UNIX,
720 and NTFS-3g). For example, hard-linked extraction mode (--hardlink) is
721 now supported on all backends, not just UNIX.
723 `mkwinpeimg' now supports grabbing files from the WAIK supplement rather
724 than the WAIK itself.
726 wimlib_global_init() now, by default, attempts to acquire additional
727 privileges on Windows, so library clients need not do this.
729 This update bumps the shared library version number up to 9, since it is
730 not binary compatibible with previous releases.
733 Fixed bug in `wimlib-imagex export' that made it impossible to export an
734 image from a WIM that is readonly at the filesystem level.
736 Return error code rather than segfaulting when trying to list files from
737 a non-first part of a split WIM.
739 Joining a WIM will now preserve the RP_FIX and READONLY flags.
742 On Windows, paths given to wimlib-imagex are now treated case
745 Improved behavior regarding invalid filenames; in particular, on
746 Windows, wimlib-imagex will, when extracting, now omit (with an option
747 to override this default) filenames differing only in case, or filenames
748 containing characters not valid on Windows.
750 On Windows, wimlib now supports capturing and extracting long paths
751 (longer than the so-called MAX_PATH).
753 On Windows, `wimlib-imagex update' now acquires proper privileges when
754 running as an Administrator.
756 `wimlib-imagex update' will now complain if no image is specified when
757 trying to update a multi-image WIM.
759 `wimlib-imagex update' now supports specifying a single update command
760 directly on the command line using the --command option.
762 wimlib-imagex will now choose different units for progress messages,
763 depending on the amount of data that needs to be processed.
765 `wimlib-imagex append' will now generate a unique WIM image name if no
766 name is specified and the defaulted name already exists in the WIM.
768 wimlib now allows you to create unnamed WIM images, which can then only
769 be referred to by index.
771 wimlib now allows you to explicitly declare you want write access to a
772 WIM by providing the WIMLIB_OPEN_FLAG_WRITE_ACCESS flag to
775 wimlib now respects the WIM_HDR_FLAG_READONLY flag when set in the WIM
778 Progress callbacks have been added to wimlib's wimlib_update_image()
781 Added wimlib_get_wim_info(), wimlib_set_wim_info(),
782 wimlib_iterate_dir_tree(), and wimlib_iterate_lookup_table() functions
785 NTFS-3g capture now only warns about two conditions previously treated
788 Fixed a couple issues with using wimlib-imagex on UDF filesystems on
791 wimlib now correctly detects and returns an error when reading a WIM
792 image with a cyclic directory structure. (Fun fact: such a WIM will
793 crash Microsoft's software.)
796 Added new "extract" and "update" subcommands to wimlib-imagex, along
797 with associated APIs in the library. These commands are intended mainly
798 for Windows use but can be used on UNIX as well.
800 Many documentation improvements.
802 Fixed a bug in the Windows build where relative symbolic links were not
803 captured in reparse-point fixup mode.
805 Fixed a bug in the Windows build where file handles were left open to
806 the WIM file, causing `wimlib_imagex optimize' to fail in some cases.
808 Fixed a bug in the Windows build of wimlib-imagex where globbing
809 split-WIM parts could cause the program to crash.
811 Fixed a bug where the creation time of WIM images would be shown instead
812 of the last modification time.
814 With the Windows build it is now possible to restore a WIM containing
815 symbolic links as a non-Administrator; however you will receive warnings
816 about not being able to extract the symbolic links.
819 Capturing a WIM image should now be significantly faster in most cases
820 due to improved use of the operating system's cache and avoiding reading
821 files twice whenever possible.
823 The Windows build should now work on Windows XP.
825 The Windows build now supports capturing and restoring hidden,
826 compressed, sparse, and encrypted files.
828 The Windows build now supports capturing and applying WIM images from
829 filesystems other than NTFS (with some reduced functionality).
831 The Windows build now extracts short names correctly.
833 Added support for "reparse-point" fixups (i.e. fixing up of symbolic
834 links). See docs for --rpfix and --norpfix flags of `wimlib-imagex
835 capture' and `wimlib-imagex apply'.
837 The performance of splitting and joining WIMs should be slightly
840 The LZX and XPRESS compression and decompression functions are now
841 exported from the library.
844 Improvements and bugfixes for the Windows build.
846 Added --strict-acls options.
848 Fixed the way that wimlib determines the order of images in the WIM.
851 Since wimlib can now be used on Windows, wimlib's implementation of
852 ImageX has been renamed to wimlib-imagex to avoid confusion with
853 Microsoft's implementation of ImageX, which would have the same file
854 name ("imagex.exe"). If you really don't like this you can pass the
855 --with-imagex-progname option to `configure' to choose a different name,
856 or even simply rename the binary yourself (but the former way will
857 configure the man pages to use the chosen name).
859 Various bugs fixed in the Windows build. Mainly to do with capturing
860 and restoring alternate data streams correctly in weird cases, and
861 requesting the correct privileges when opening files. Also added the
862 --noacls options to wimlib-imagex capture, append, and apply.
864 Windows build again: FindFirstStreamW() and FindNextStreamW() are now
865 dynamically loaded, so this may make the library compatible with Windows
866 XP (however, there may still be other problems).
869 Added experimental support for native Windows builds. Binaries can be
870 downloaded from the SourceForge page.
872 --source-list option added to `imagex capture' and `imagex append'.
874 Better support for different character encodings.
877 Storing UNIX file owners, groups, and modes in WIM images is now
878 possible using `imagex capture' with the --unix-data flag.
880 Minor bug fixes and documentation fixes.
883 NTFS capture: Fixed capturing duplicate reparse points.
885 NTFS capture: Capture first unnamed stream if there are more than one
886 (print warning instead of error).
888 Allow multiple test cases to execute concurrently (e.g. make -j2 check).
891 Added --arch switch to mkwinpeimg script to support getting AMD64 WinPE
894 Update to work with ntfs-3g version 2013.1.13.
897 Fixed truncating file to shorter but non-zero length on read-write
900 Various code cleanups and minor documentation fixes.
903 LZX and XPRESS decompression have received some additional optimizations
904 and should now be even faster. (Although, they were already pretty
905 fast--- much faster than typical I/O speeds.)
907 Fixed a bug introduced in v1.2.1 that would cause a directory tree
908 containing hard links to be captured incorrectly in some cases.
911 By default, unmounting a read-write mounted WIM with 'imagex unmount
912 --commit' will now change the WIM in-place without needing to write the
913 entire WIM again. Use 'imagex unmount --commit --rebuild' to get the
916 'imagex unmount' no longer has a hard-coded limit of 10 minutes to wait
917 for a response from the daemon servicing the mounted WIM. Instead,
918 every second 'imagex unmount' will check if the daemon is still alive,
919 and keep waiting if so, otherwise terminate with an error.
921 'imagex unmount --commit' on a read-write mounted WIM will now print
922 progress information regarding the writing of new or modified streams
923 the WIM, just like when capturing or appending a WIM.
925 A small change has been made to XPRESS compression and it should improve
926 the compression ratio slightly.
928 A change was made that may improve performance slightly when applying a
929 WIM image to a NTFS volume.
931 Microsoft has managed to introduce even more bugs into their software,
932 and now the WIMs for Windows 8 have incorrect (too low) reference counts
933 for some streams. This is unsafe because such streams can be removed
934 when they are in actuality still referenced in the WIM (perhaps by a
935 different image). wimlib will now work around this problem by fixing
936 the stream reference counts. This is only done when wimlib_delete_image() is
937 called ('imagex delete') or when wimlib_mount_image() is called with
938 WIMLIB_MOUNT_FLAG_READWRITE ('imagex mountrw'). Please note that this
939 requires reading the metadata for all images in the WIM, so this will
940 make these operations noticably slower on WIMs with multiple images.
942 Various other bugfixes.
945 Appending images to a WIM is now be done by default without re-building
946 the whole WIM. Use the --rebuild flag to get the old behavior (which
947 was to re-build the entire WIM when a new image is appended).
949 A new command `imagex optimize' is now available to manually re-build a
950 WIM that has wasted space due to repeated appends.
952 Progress information has been improved, and now arbitrary callback
953 functions can be used to show the progress of a WIM operation.
955 A possible bug with changing the bootable image of a WIM was fixed.
957 Some advisory locking is now done to prevent two processes from
958 modifying a WIM at the same time (but only in some cases). For example,
959 you cannot mount two images from a WIM read-write at the same time.
961 Some functions have been reorganized:
962 * wimlib_mount() renamed to wimlib_mount_image().
963 * wimlib_unmount() renamed to wimlib_unmount_image().
964 * wimlib_overwrite_xml_and_header() removed as
965 wimlib_overwrite() suffices now.
966 * wimlib_apply_image_to_ntfs_volume() removed as
967 wimlib_extract_image() suffices now.
968 * wimlib_add_image_from_ntfs_volume() removed as
969 * wimlib_add_image() suffices now.
971 Previously, the soname of libwim.so has been 0.0.0, despite many
972 interface changes. The soname is now updated to 1.0.0 and will now be
973 updated each release.
976 Resources will now be compressed using multiple threads by default.
977 (This applies to `imagex capture', `imagex append', and `imagex
980 Some performance improvements in mounted WIMs.
982 More progress information is shown when capturing a WIM.
985 Lots of minor fixes, code cleanups, and some documentation updates.
986 Nothing in particular is really noteworthy.
989 LZX and XPRESS compression improvements.
991 Fixed calculation of Directory Count, File Count, Total Bytes, and Hard
992 Link Bytes of the WIM.
995 Fixed bug when capturing NTFS file with multiple named data streams.
997 Internally, we are now using inode structures, even though these don't
998 appear literally in the WIM file. This simplifies some of the code
999 (mainly for WIM mounting) and likely fixed a few problems, although it
1003 Fixed problem when exporting images from XPRESS to LZX compressed WIM or
1007 Enough changes to call it version 1.0.0!
1009 Capturing a WIM directly from a NTFS volume, and applying a WIM directly
1010 to a NTFS volume, is now supported.
1012 Hard links and symbolic links have much improved support. They are
1013 supported for WIM capture, WIM application, and mounted WIMs (you can
1014 even make them on read-write mounted WIMs).
1016 Alternate data streams are now supported on mounted WIMs through an
1017 xattr or a Windows-style stream interface. Also they are supported when
1018 capturing a WIM from NTFS or applying a WIM to NTFS.
1020 Split WIMs are better supported. You may now apply an image directly
1021 from a split WIM, mount an image from a split WIM read-only, or export
1022 an image from a split WIM.
1024 Using a capture configuration file is now supported (but not fully yet).
1026 SHA1 message digests are checked in more places, so we can make sure
1027 applied and captured data is correct.
1029 Man pages have been updated and consolidated.
1032 Fixed segfault when unmounting read-only WIM.
1035 Support for joining and splitting WIMs.
1036 Also, security data is now preserved by default.
1039 Can now build with older gcc and system headers, like on CentOS 5.
1042 Fixed bug that made it impossible to overwrite files in read-write
1046 Write byte-order mark before WIM XML data. (imagex.exe requires this to