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 On Windows, improved the way in which files deduplicated with Windows'
13 Data Deduplication feature are captured.
15 The development files needed to link with wimlib using Visual Studio are
16 now included in the Windows release archives.
18 wimlib.h can now be included by Visual Studio without errors.
20 The example programs can now be compiled in C++ mode, and they also now
23 Updated 'mkwinpeimg' to work correctly on images that have a "windows"
24 (lower case) directory rather than a "Windows" (upper case) directory.
26 Fixed configuring with --enable-ssse3-sha1 from release tarball
27 (the file nasm_lt.sh was missing).
30 The LZX compression ratio has been slightly improved. The default mode,
31 LZX level 50, is now almost as good as the old LZX level 100, while
32 being nearly the same speed as before.
34 Decompression performance has been slightly improved.
36 Filenames are now always listed in NTFS collation order.
38 On UNIX-like systems, wimlib can now process Windows filenames that are
39 not valid Unicode due to the presence of unpaired surrogates.
41 On UNIX-like systems, wimlib now always assumes UTF-8 encoding with the
42 addition of surrogate codepoints. Consequently, the environmental
43 variable WIMLIB_IMAGEX_USE_UTF8 and the flag
44 WIMLIB_INIT_FLAG_ASSUME_UTF8 no longer have any effect.
46 wimlib no longer depends on iconv.
48 Reduced memory usage slightly.
50 When a WIM image is applied in NTFS-3G mode, security descriptors are
51 now created in NTFS v3.0 format when supported by the volume.
53 Workarounds for bugs in libntfs-3g version 2013.1.13 and earlier have
54 been removed. Users are advised to upgrade to a later version of
57 On Windows, wimlib now supports case-sensitive filename extraction when
58 supported by the underlying operating system and filesystem (operating
59 system support requires a registry setting).
62 On UNIX, wimlib can now overwrite readonly files when extracting.
64 On Windows, fixed a bug where wimlib could leave a null DACL (a.k.a. "no
65 NTFS permissions") set on some existing directories after extraction.
67 On Windows, when applying a WIM image in "WIMBoot mode" when the WOF
68 driver is not loaded, wimlib can now correctly register a new WIM file
69 with the target volume when the target volume previously had had WIM
72 Added a new testing program.
74 Clarified the main license text and updated public domain dedications
75 for certain files to be more thorough.
78 Object IDs are now saved and restored on Windows and in NTFS-3G mode.
80 Reduced memory usage when exporting large numbers of WIM images.
82 Non UTF-8 locales are now detected correctly.
84 Addressed compiler warnings and enabled "silent" make rules by default.
86 Windows-specific updates:
87 Fixed a bug where duplicate backslashes could be generated in
88 link targets when extracting symbolic links and junctions.
90 Fixed a bug where the .cmd shortcuts for wimlib-imagex wouldn't
91 work if their full path contained a space.
93 Fixed bugs related to scanning SMB filesystems.
95 Added warning message about known issue with WindowsApps folder.
97 Added instructions for building from source on Windows.
99 VSS support is no longer marked "experimental".
101 Added missing license file for libdivsufsort-lite.
104 Added experimental support for Windows VSS (Volume Shadow Copy Service).
105 The new '--snapshot' argument to 'wimcapture' makes wimlib automatically
106 create and use a temporary VSS snapshot when capturing a WIM image.
108 Implemented setting of Windows-specific XML information, such as
109 architecture, system root, and version details. This information is now
110 automatically set in newly captured WIM images, when appropriate.
112 Improved performance of directory tree scans on Windows.
114 On Windows, to improve capture performance, wimlib now sometimes opens
115 files by inode number rather than by path. This is enabled for
116 wimcapture and wimappend, but for now other applications have to opt-in.
118 The progress messages printed by wimlib-imagex while writing WIM files
119 have been slightly tweaked.
121 Progress information for directory tree scans now counts all hard links.
122 Also, on Windows "\\?\" is no longer stripped from the current path.
124 Added a new '--image-property' option to 'wimcapture', 'wimappend', and
125 'wiminfo'. This option lets you assign values to elements in a WIM
126 file's XML document by name.
128 The wimlib_get_image_property() and wimlib_set_image_property() API
129 functions now support numerically indexed elements.
131 Fixed a bug where, on Windows, wimlib would change the security
132 descriptor of the target directory of an extraction even when the
133 '--no-acls' option was specified.
136 Fixed a bug with libntfs-3g extraction present since v1.8.1. Sometimes,
137 some Microsoft software would not correctly recognize data in the
138 resulting filesystem.
140 Made some small improvements to the compression algorithms:
141 LZX compression ratio was slightly improved.
142 XPRESS compression ratio and speed was slightly improved.
143 LZMS compression speed was slightly improved.
145 Improved handling of WIM XML data. wimlib no longer drops unrecognized
146 elements when exporting images. In addition, two API functions were
147 added for better access to elements in the XML document:
148 wimlib_get_image_property() and wimlib_set_image_property().
150 Added support for (unsafe) in-place compaction of WIM files.
152 Improved performance of image export by reusing metadata resources
153 instead of always rebuilding and recompressing them.
155 Improved performance of wimlib_update_image() by delaying the update to
156 the WIM's XML document until a write is requested.
158 On Windows, the target of an extraction may now be a reparse point
159 (which will be dereferenced).
161 On Windows, wimlib now correctly restores non-Microsoft reparse points.
162 However, this remains broken in NTFS-3g mode due to a libntfs-3g bug.
164 On Windows, wimlib now has improved performance when archiving files
165 from a filesystem backed by a WIM (a "WIMBoot" setup).
167 Several improvements to System Compression (compact mode) support:
169 wof.sys (or wofadk.sys) is now automatically attached to the
170 target volume if needed.
172 Compact-mode extractions now work correctly with wofadk.sys on
173 older versions of Windows.
175 For compatibility with the Windows bootloader, the requested
176 compression format now is overridden on certain files.
178 Other minor bugfixes.
181 This release primarily contains various minor bug fixes and
182 improvements, including:
184 Improved handling of deep directory structures.
186 Fixed a bug where on 32-bit systems, the library could enter an
187 infinite loop if a WIM file was malformed in a specific way.
189 Added a workaround for a case where libntfs-3g may report
190 duplicate streams in an NTFS file.
192 Windows symbolic links and junctions in mounted WIM images are
193 now automatically rewritten to be valid in the mounted location.
195 Reparse point fixes: correctly handle the "ReparseReserved"
196 field, and correctly handle "empty" (data-less) reparse points.
198 On Windows, wimlib now acquires SeManageVolumePrivilege, which
199 is needed to create externally backed files using the
202 Improved validation of filenames.
204 Improved LZMS decompression speed.
206 The configure script now honors alternate pkg-config settings.
208 Links have been updated to point to the new website.
210 In addition, experimental support has been added for compressing
211 extracted files using System Compression on Windows 10. This
212 functionality is available through the new '--compact' option to
213 'wimapply' and 'wimextract' as well as new library flags.
216 Fixed a bug in the LZX decompressor: malicious input data could cause
217 out of bounds writes to memory (since wimlib v1.2.2).
219 The output of the 'wiminfo' command now consolidates various boolean
220 flags (such as "Relative path junction") into a single line.
222 A file can now have both an unnamed data stream ("file contents") and a
223 reparse point stream. Such files can exist as a result of the use of
224 certain Windows features, such as offline storage, including "OneDrive".
225 wimlib will now store and restore both streams on Windows as well as in
226 NTFS-3g mode. Microsoft's WIMGAPI also has this behavior.
228 On Windows, named data streams of encrypted files are no longer stored
229 twice in WIM archives.
231 On Windows, named data streams are now correctly extracted to existing
232 "readonly" directories. Before, an error would be reported.
234 On Windows, it is now possible to do a "WIMBoot mode" extraction with
235 non-standalone WIMs such as delta WIMs.
237 On Windows, when doing an extraction in "WIMBoot mode", files larger
238 than 4 gigabytes are now never extracted as externally backed. This
239 works around a bug in Microsoft's "WOF" driver.
241 The '--enable-verify-compression' configure option has been removed. If
242 you want to verify a WIM file, use the 'wimverify' program.
244 The way the "file count", "directory count", "total bytes", and "hard
245 link bytes" image statistics (stored in the WIM XML data) is calculated
246 has been slightly changed.
248 In mounted WIM images, the disk usage provided for each file (st_blocks)
249 is now the compressed size rather than the uncompressed size.
251 The performance of the NTFS-3g and Windows capture modes has been
254 On UNIX-like systems, symbolic links whose targets contain the backslash
255 character are now handled correctly (losslessly).
258 Improved the LZX compressor. It is now 15-20% faster than before and
259 provides a slightly better compression ratio.
261 Improved the LZMS compressor. It now provides a compression ratio
262 slightly better than WIMGAPI while still being faster and using slightly
265 The compression chunk size in solid resources, e.g. when capturing or
266 exporting a WIM file using the '--solid' option, now defaults to 64 MiB
267 (67108864 bytes) instead of 32 MiB (33554432 bytes). This provides a
268 better compression ratio and is the same value that WIMGAPI uses. The
269 memory usage is less than 50% higher than wimlib v1.7.4 and is slightly
270 lower than WIMGAPI's memory usage, but if it is too much, it is still
271 possible to choose a lower value, e.g. with the '--solid-chunk-size'
272 option to wimlib-imagex.
274 The '--chunk-size' and '--solid-chunk-size' options to wimlib-imagex now
275 accept the 'K', 'M', and 'G' suffixes.
277 Files are now sorted by name extension when creating a solid WIM file.
279 Fixed various issues related to capture/apply of EFS-encrypted files on
282 The file list printed by 'wimdir' is now sorted by the platform-specific
283 case sensitivity setting, rather than always case sensitively. This
284 also affects the library function wimlib_iterate_dir_tree().
286 On Windows, some error and warning messages have been improved.
289 The Windows binary distribution no longer contains third party DLLs.
290 These dependencies are instead compiled directly into the libwim DLL.
292 Added more fixes for wimlib on non-x86 architectures such as ARM.
294 Extracting files to a Windows PE in-memory filesystem no longer fails if
295 the target files do not yet exist.
297 Improved the performance of XPRESS compression and LZMS decompression.
299 Enabled SSSE3 accelerated SHA-1 computation in x86_64 Windows builds.
300 It will automatically be faster on newer Intel and AMD processors.
302 Removed the --with-imagex-progname and --enable-more-assertions
306 Fix for very slow export from solid WIM / ESD files.
308 Fix for LZX and LZMS algorithms on non-x86 architectures, such as ARM.
310 New progress message: WIMLIB_PROGRESS_MSG_HANDLE_ERROR. Applications
311 may use this to treat some types of errors as non-fatal.
313 The library now permits making in-memory changes to a WIMStruct backed
314 by a read-only WIM file.
316 Fixes for "WIMBoot" extraction mode (Windows only):
318 When not using the WOF driver, extraction no longer fails if the
319 disk containing the WIM file has too many partitions.
321 When matching patterns in [PrepopulateList], all hard links of
322 each file are now considered.
324 The system registry files are now automatically treated as being
325 in [PrepopulateList].
327 Added a hack to try to work around an intermittent bug in
328 Microsoft's WOF (Windows Overlay Filesystem) driver.
331 Made more improvements to the XPRESS, LZX, and LZMS compressors.
333 A number of improvements to the Windows port:
335 Fixes for setting short filenames.
337 Faster "WIMBoot" extraction.
339 Updated and slimmed down the dependent DLLs.
341 ACL inheritence bits are now restored.
343 Mandatory integrity labels are now backed up and restored.
345 Added a workaround for an issue where in rare cases, wimlib could create
346 a compressed data stream that could not be read correctly by Windows
347 after an extraction in "WIMBoot" mode.
350 Added file count progress data for
351 WIMLIB_PROGRESS_MSG_EXTRACT_FILE_STRUCTURE and
352 WIMLIB_PROGRESS_MSG_EXTRACT_METADATA.
354 Added support for testing file exclusions via the user-provided
357 Some documentation improvements.
359 Made some clarifications to the license text in the COPYING file.
362 Made more improvements to the XPRESS, LZX, and LZMS compressors.
364 The default compression mode for wimcapture is now LZX compression in
365 its default mode, which is the same as '--compress=maximum'.
367 You can now specify an optional integer compression level to the
368 '--compress' option; e.g. '--compress=lzx:75'.
370 Made a minor change to the LZMS compressor and decompressor to fix an
371 incompatibility with the Microsoft implementation. In the unlikely
372 event that you created an LZMS-compressed WIM with wimlib v1.7.0 or
373 earlier and a checksum error is reported when extracting files from it
374 with wimlib v1.7.1, decompress it with v1.7.0 then compress it with
377 Added 'verify' subcommand to wimlib-imagex.
379 Notable library changes:
381 Custom compressor parameters have been removed from the library
382 in favor of the simpler level-based API.
384 Decompressor parameters have been removed entirely.
386 Library users can now specify a custom file for warning and
387 error messages to be sent to, rather than the default of
390 New progress messages:
391 WIMLIB_PROGRESS_MSG_EXTRACT_FILE_STRUCTURE,
392 WIMLIB_PROGRESS_MSG_EXTRACT_METADATA.
394 New function: wimlib_verify_wim().
397 Improved compression, decompression, and extraction performance.
399 Improved compatibility with version 3584 WIM / ESD files:
400 - Add support for reading and writing multiple solid blocks per
401 archive, which WIMGAPI/DISM can create when appending an image.
402 - Correctly create solid blocks larger than 4 GiB.
404 'add' commands passed to wimupdate will now replace existing
405 nondirectory files by default. Use the --no-replace option to get the
408 The license for the library now contains an exception that allows using
409 it under the LGPL. See the COPYING file for details.
411 In reparse-point fixup mode (the default for capture), symbolic links
412 and junctions that point outside the tree being captured are no longer
413 excluded from capture.
415 Added support for "WIMBoot" capture and extraction. See the
416 documentation for the new '--wimboot' option to wimcapture and wimapply
417 for more information.
419 On UNIX-like systems, you can now backup and restore device nodes, named
420 pipes, and sockets. In addition, 32-bit user and group IDs are now
423 The way that UNIX data is stored in WIM files has been changed. If you
424 captured any WIMs with the --unix-data option, to upgrade them you'll
425 need to apply them with --unix-data using wimlib-imagex v1.6.2, then
426 re-capture them with --unix-data using this version.
428 wimlib now understands tagged metadata items, such as object IDs, that
429 can be stored in WIM directory entries.
431 Removed the --hardlink and --symlink options to wimapply, since I don't
432 think they are too useful and they got in the way of improving the code.
434 WIMs will now retain their GUIDs when rebuilt (e.g. with wimoptimize).
436 The 'mkwinpeimg' script now supports writing the ISO image to standard
439 The <ARCH> element in WIM XML data is now exported correctly.
441 On Windows, sparse file attributes are no longer set on extracted files.
442 Oddly enough, this actually saves disk space in some cases.
444 On UNIX, configuring with --disable-xattr or --enable-xattr is no longer
445 supported. Mounting WIM images now always requires extended attribute
446 support. Use --without-fuse to disable support for mounting WIM images;
447 this will also disable the need for extended attribute support.
449 Configuring with --enable-ssse3-sha1 now works correctly.
451 The shared library version has been bumped up. The main
452 incompatibilities are:
454 - WIMLIB_COMPRESSION_TYPE_XPRESS is now 1 and
455 WIMLIB_COMPRESSION_TYPE_LZX is now 2 (so it's the same as
458 - User-provided progress functions are now registered using a
459 separate function, wimlib_register_progress_function(). The
460 'progress_func' argument to many functions no longer exists.
462 - The return value from user-provided progress functions is now
465 - A context argument has been added to the prototype of
466 user-provided progress functions.
468 - 'struct wimlib_capture_config' has been removed. The library
469 now takes the path to the configuration file directly. This
470 affects wimlib_add_image(), wimlib_add_image_multisource(),
471 and wimlib_update_image(). However, a NULL value passed in
472 the argument retains the same meaning.
474 - Removed deprecated functions: some (de)compression functions,
475 wimlib_extract_files(), and wimlib_print_metadata().
477 - Removed extraction flags: WIMLIB_EXTRACT_FLAG_HARDLINK,
478 WIMLIB_EXTRACT_FLAG_SYMLINK, WIMLIB_EXTRACT_FLAG_FILE_ORDER,
479 and WIMLIB_EXTRACT_FLAG_SEQUENTIAL.
481 - Removed some progress messages:
482 WIMLIB_PROGRESS_MSG_APPLY_TIMESTAMPS,
483 WIMLIB_PROGRESS_MSG_EXTRACT_DIR_STRUCTURE_BEGIN,
484 WIMLIB_PROGRESS_MSG_EXTRACT_DIR_STRUCTURE_END. Numbering
487 - Removed some error codes. Numbering stays the same.
489 - Replaced WIMLIB_UNMOUNT_FLAG_LAZY with
490 WIMLIB_UNMOUNT_FLAG_FORCE.
492 - WIM paths passed to progress functions now have a leading
496 Case-insensitive comparisons of strings (e.g. filenames) containing
497 UTF-16 codepoints above 32767 are now done correctly.
499 Fixed build failure on Mac OS X.
501 wimunmount now provides the '--new-image' option to cause changes to a
502 read-write mounted image to be committed as a new image rather than as
503 an update of the mounted image. (The corresponding new library flag is
504 WIMLIB_UNMOUNT_FLAG_NEW_IMAGE.)
506 The LZMS ("recovery") compression chunk size, or "dictionary size", may
507 now be up to 1 GiB (1,073,741,824 bytes).
509 The performance of LZX ("maximum") and LZMS ("recovery") compression
510 with large chunk sizes has been slightly improved.
513 Stored files with size exactly 4 GiB (4,294,967,296 bytes) are now
514 decompressed correctly.
516 Fixed a bug in the LZX compressor introduced in v1.5.3. The bug
517 occurred in an unlikely case, and due to validity checks it did not
518 affect successfully created archives.
520 Fixed a minor compatibility issue with the LZMS compressor and
521 decompressor. This is *not* the default compression type and was only
522 introduced in v1.6.0. In the unlikely event that you created an
523 LZMS-compressed WIM with v1.6.0 and a checksum error is reported when
524 applying it with v1.6.1, decompress it with v1.6.0 then compress it with
527 Memory usage for LZMS and LZX compression has been decreased.
529 wimextract now allows wildcard characters in paths specified on the
530 command line. Also, the '--strict-wildcards' option has been removed
531 and replaced with the inverse option '--nullglob'. See the
532 documentation for wimextract for more details and changes.
534 The wimlib_extract_files() function is now considered deprecated in
535 favor of wimlib_extract_paths().
537 Fixed more permissions problems when extracting files on Windows.
539 A new '--no-attributes' option has been added to wimapply and
540 wimextract. The library flag is WIMLIB_EXTRACT_FLAG_NO_ATTRIBUTES.
542 The default chunk size is now set correctly when changing the
543 compression type of a WIM, for example with 'wimoptimize'.
545 The '--metadata' option to wiminfo has been replaced with the
546 '--detailed' option to wimdir.
548 In relevant wimlib-imagex commands, '--solid' may now be used as an
549 alias for '--pack-streams'.
552 Support for extracting and updating the new version 3584 WIMs has been
553 added. These WIMs typically pack many streams ("files") together into a
554 single compressed resource, thereby saving space. This degrades the
555 performance of random access (such as that which occurs on a mounted
556 image), but optimizations have been implemented for extraction. These
557 new WIM files also typically use a new compression format (LZMS), which
558 is similar to LZMA and can offer a better compression ratio than LZX.
559 These new WIM files can be created using `wimcapture' with
560 the '--compress=lzms --pack-streams' options. Note: this new WIM format
561 is used by the Windows 8 web downloader, but important segments of the
562 raw '.esd' files are encrypted, so wimlib will not be able to extract
563 such files until they are first decrypted.
565 wimlib now supports extracting files and directories from a WIM image
566 based on a "listfile" that itself contains the list of paths to extract.
567 For `wimextract', the syntax is to specify @LISTFILE instead of a PATH,
568 and for the library itself, the new APIs are wimlib_extract_pathlist()
569 and wimlib_extract_paths(). Path globs containing wildcard characters
572 For searching WIM files, wimlib now has configurable case sensitivity.
573 The default on Windows is still case-insensitive and the default on
574 UNIX-like systems is still case-sensitive, but this can be overridden
575 on either platform through flags to wimlib_global_init(). For
576 `wimlib-imagex', the environmental variable WIMLIB_IMAGEX_IGNORE_CASE
577 can be set to 1 or 0 for case-insensitive or case-sensitive behavior,
580 Support for compression chunk sizes greater than the default of 32768
581 bytes has been added. A larger chunk size typically results in a better
582 compression ratio. However, the MS implementation is seemingly not
583 compatible with all chunk sizes, especially for LZX compression, so the
584 defaults remain unchanged, with the exception of the new LZMS-compressed
585 WIMs, which use a larger chunk size by default.
587 The compression/decompression API exported by wimlib has been changed.
588 Now one set of functions handles all supported compression formats.
590 `wimcapture' and `wimappend' will now display the progress of scanning
591 the directory tree to capture, in addition to the progress of writing
592 data to the WIM. The '--verbose' option no longer does anything. The
593 library API change for this is the addition of several members to
594 `struct wimlib_progress_info_scan' available to progress callbacks.
596 `mkwinpeimg' now correctly handles the '--start-script' option when the
597 start script is not in the working directory.
599 Sequential extraction, previously requested by using
600 WIMLIB_EXTRACT_FLAG_SEQUENTIAL, is now the default.
601 WIMLIB_EXTRACT_FLAG_FILE_ORDER can be used to get the old default
602 behavior (extract in file order).
605 The new LZX compressor added in v1.5.2 has been improved and is now
606 enabled by default, except when `wimcapture' or `wimappend' is run
607 *without* the '--compress' option, in which case the faster LZX
608 compressor is used (the same as before). This behavior is reasonably
609 consistent with ImageX which actually uses "fast" (XPRESS) compression
610 by default. In those cases, use '--compress=maximum' to explicitly
611 capture a WIM image using the new (slower but better) LZX compressor.
613 The '--compress-slow' option still exists to `wimlib-imagex optimize',
614 but its new behavior is to tweak the new LZX compressor even more to
615 produce an even better compression ratio at the cost of more time spent
618 `wimlib-imagex optimize' now supports the '--compress=TYPE' option,
619 which recompresses the WIM file using the specified compression TYPE.
620 The new library API function used for this is
621 wimlib_set_output_compression_type().
623 Added the wimlib_get_xml_data() function to allow library clients to
624 easily retrieve the raw XML data from a WIM file if needed.
626 Fixed a bug that could cause an error code to be incorrectly returned
627 when writing XML data containing a <WINDOWS> element.
629 Mounted WIM images will now correctly show the default file stream even
630 if appears in the alternate data stream entries of the corresponding WIM
634 Added a new experimental LZX compressor which can be enabled by passing
635 '--compress-slow' to `wimlib-imagex capture' or `wimlib-imagex
636 optimize'. (The latter is only applicable if the WIM is already
637 LZX-compressed and the '--recompress' option is also given.) The
638 experimental compressor is much slower but compresses the data slightly
639 more --- currently usually to within a fraction of a percent of the
640 results from WIMGAPI/ImageX.
642 A workaround has been added for compatibility with versions of WinPE
643 that interpret alternate data stream entries in the boot WIM
646 An alignment bug that caused a crash in the LZX decompressor on some
649 wimlib now attempts to clear the WIM_HDR_FLAG_WRITE_IN_PROGRESS flag in
650 the WIM header when restoring the previous state of a WIM it failed to
653 Added a workaround to avoid an access denied error on Windows when
654 replacing a WIM file that another process has opened.
657 wimlib can now open WinPE WIMs from WAIK v2.1, which had a quirk that
658 needed to be handled.
660 A bug in the interpretation of negative IMAGE indices in the
661 --update-of=[WIMFILE:]IMAGE option to `wimlib-imagex capture' and
662 `wimlib-imagex append' has been fixed.
664 A workaround has been added to successfully apply security descriptors
665 with empty DACLs when the NTFS-3g apply mode is being used with NTFS-3g
666 2013.1.13 or earlier.
668 `wimlib-imagex capture' can now accept the '--delta-from' option
672 Added support for "pipable" WIMs. Pipable WIMs allow capturing images
673 to standard output and applying images from standard input, but they are
674 not compatible with Microsoft's software and are not created by default.
675 See the documentation for --pipable flag of `wimlib-imagex capture' for
678 To better support incremental backups, added support for declaring an
679 image as a modified form of another image. See the documentation for
680 the '--update-of' option of `wimlib-imagex append' and `wimlib-imagex
683 Added supported for "delta" WIMs. See the documentation for the
684 '--delta-from' option of `wimlib-imagex capture'.
686 The library support for managing split WIMs has been changed to support
687 other arrangements, such as delta WIMs, and be easier to use. This
688 change is visible in `wimlib-imagex', which also can now accept the
689 '--ref' option multiple times, and also now supports "delta" WIMs as
692 wimlib now preserves WIM integrity tables by default, even if
693 WIMLIB_WRITE_FLAG_CHECK_INTEGRITY is not specified. This changes the
694 behavior of `wimlib-imagex' whenever the WIM being operated on contains
695 an integrity table and the '--check' option is not specified.
697 `wimlib-imagex capture' now creates LZX-compressed WIMs by default
698 (when --compress is not specified). This provides the best compression
699 ratio by default, which is usually what is desired, at a cost of some
702 `wimlib-imagex' now supports being invoked as wimCOMMAND, where COMMAND
703 is the command as in `wimlib-imagex COMMAND'; for example, it can be
704 invoked as `wimapply' as an alternative to `wimlib-imagex apply'. The
705 appropriate hard links are created in UNIX installations of
706 `wimlib-imagex', while for the Windows distribution of `wimlib-imagex',
707 batch files that emulate this behavior are generated.
709 Security descriptors are now extracted correctly on Windows.
711 Fixed archiving DOS names in NTFS-3g capture mode.
713 The extraction code has been rewritten and it will now be easier to
714 support new features on all supported backends (currently Win32, UNIX,
715 and NTFS-3g). For example, hard-linked extraction mode (--hardlink) is
716 now supported on all backends, not just UNIX.
718 `mkwinpeimg' now supports grabbing files from the WAIK supplement rather
719 than the WAIK itself.
721 wimlib_global_init() now, by default, attempts to acquire additional
722 privileges on Windows, so library clients need not do this.
724 This update bumps the shared library version number up to 9, since it is
725 not binary compatibible with previous releases.
728 Fixed bug in `wimlib-imagex export' that made it impossible to export an
729 image from a WIM that is readonly at the filesystem level.
731 Return error code rather than segfaulting when trying to list files from
732 a non-first part of a split WIM.
734 Joining a WIM will now preserve the RP_FIX and READONLY flags.
737 On Windows, paths given to wimlib-imagex are now treated case
740 Improved behavior regarding invalid filenames; in particular, on
741 Windows, wimlib-imagex will, when extracting, now omit (with an option
742 to override this default) filenames differing only in case, or filenames
743 containing characters not valid on Windows.
745 On Windows, wimlib now supports capturing and extracting long paths
746 (longer than the so-called MAX_PATH).
748 On Windows, `wimlib-imagex update' now acquires proper privileges when
749 running as an Administrator.
751 `wimlib-imagex update' will now complain if no image is specified when
752 trying to update a multi-image WIM.
754 `wimlib-imagex update' now supports specifying a single update command
755 directly on the command line using the --command option.
757 wimlib-imagex will now choose different units for progress messages,
758 depending on the amount of data that needs to be processed.
760 `wimlib-imagex append' will now generate a unique WIM image name if no
761 name is specified and the defaulted name already exists in the WIM.
763 wimlib now allows you to create unnamed WIM images, which can then only
764 be referred to by index.
766 wimlib now allows you to explicitly declare you want write access to a
767 WIM by providing the WIMLIB_OPEN_FLAG_WRITE_ACCESS flag to
770 wimlib now respects the WIM_HDR_FLAG_READONLY flag when set in the WIM
773 Progress callbacks have been added to wimlib's wimlib_update_image()
776 Added wimlib_get_wim_info(), wimlib_set_wim_info(),
777 wimlib_iterate_dir_tree(), and wimlib_iterate_lookup_table() functions
780 NTFS-3g capture now only warns about two conditions previously treated
783 Fixed a couple issues with using wimlib-imagex on UDF filesystems on
786 wimlib now correctly detects and returns an error when reading a WIM
787 image with a cyclic directory structure. (Fun fact: such a WIM will
788 crash Microsoft's software.)
791 Added new "extract" and "update" subcommands to wimlib-imagex, along
792 with associated APIs in the library. These commands are intended mainly
793 for Windows use but can be used on UNIX as well.
795 Many documentation improvements.
797 Fixed a bug in the Windows build where relative symbolic links were not
798 captured in reparse-point fixup mode.
800 Fixed a bug in the Windows build where file handles were left open to
801 the WIM file, causing `wimlib_imagex optimize' to fail in some cases.
803 Fixed a bug in the Windows build of wimlib-imagex where globbing
804 split-WIM parts could cause the program to crash.
806 Fixed a bug where the creation time of WIM images would be shown instead
807 of the last modification time.
809 With the Windows build it is now possible to restore a WIM containing
810 symbolic links as a non-Administrator; however you will receive warnings
811 about not being able to extract the symbolic links.
814 Capturing a WIM image should now be significantly faster in most cases
815 due to improved use of the operating system's cache and avoiding reading
816 files twice whenever possible.
818 The Windows build should now work on Windows XP.
820 The Windows build now supports capturing and restoring hidden,
821 compressed, sparse, and encrypted files.
823 The Windows build now supports capturing and applying WIM images from
824 filesystems other than NTFS (with some reduced functionality).
826 The Windows build now extracts short names correctly.
828 Added support for "reparse-point" fixups (i.e. fixing up of symbolic
829 links). See docs for --rpfix and --norpfix flags of `wimlib-imagex
830 capture' and `wimlib-imagex apply'.
832 The performance of splitting and joining WIMs should be slightly
835 The LZX and XPRESS compression and decompression functions are now
836 exported from the library.
839 Improvements and bugfixes for the Windows build.
841 Added --strict-acls options.
843 Fixed the way that wimlib determines the order of images in the WIM.
846 Since wimlib can now be used on Windows, wimlib's implementation of
847 ImageX has been renamed to wimlib-imagex to avoid confusion with
848 Microsoft's implementation of ImageX, which would have the same file
849 name ("imagex.exe"). If you really don't like this you can pass the
850 --with-imagex-progname option to `configure' to choose a different name,
851 or even simply rename the binary yourself (but the former way will
852 configure the man pages to use the chosen name).
854 Various bugs fixed in the Windows build. Mainly to do with capturing
855 and restoring alternate data streams correctly in weird cases, and
856 requesting the correct privileges when opening files. Also added the
857 --noacls options to wimlib-imagex capture, append, and apply.
859 Windows build again: FindFirstStreamW() and FindNextStreamW() are now
860 dynamically loaded, so this may make the library compatible with Windows
861 XP (however, there may still be other problems).
864 Added experimental support for native Windows builds. Binaries can be
865 downloaded from the SourceForge page.
867 --source-list option added to `imagex capture' and `imagex append'.
869 Better support for different character encodings.
872 Storing UNIX file owners, groups, and modes in WIM images is now
873 possible using `imagex capture' with the --unix-data flag.
875 Minor bug fixes and documentation fixes.
878 NTFS capture: Fixed capturing duplicate reparse points.
880 NTFS capture: Capture first unnamed stream if there are more than one
881 (print warning instead of error).
883 Allow multiple test cases to execute concurrently (e.g. make -j2 check).
886 Added --arch switch to mkwinpeimg script to support getting AMD64 WinPE
889 Update to work with ntfs-3g version 2013.1.13.
892 Fixed truncating file to shorter but non-zero length on read-write
895 Various code cleanups and minor documentation fixes.
898 LZX and XPRESS decompression have received some additional optimizations
899 and should now be even faster. (Although, they were already pretty
900 fast--- much faster than typical I/O speeds.)
902 Fixed a bug introduced in v1.2.1 that would cause a directory tree
903 containing hard links to be captured incorrectly in some cases.
906 By default, unmounting a read-write mounted WIM with 'imagex unmount
907 --commit' will now change the WIM in-place without needing to write the
908 entire WIM again. Use 'imagex unmount --commit --rebuild' to get the
911 'imagex unmount' no longer has a hard-coded limit of 10 minutes to wait
912 for a response from the daemon servicing the mounted WIM. Instead,
913 every second 'imagex unmount' will check if the daemon is still alive,
914 and keep waiting if so, otherwise terminate with an error.
916 'imagex unmount --commit' on a read-write mounted WIM will now print
917 progress information regarding the writing of new or modified streams
918 the WIM, just like when capturing or appending a WIM.
920 A small change has been made to XPRESS compression and it should improve
921 the compression ratio slightly.
923 A change was made that may improve performance slightly when applying a
924 WIM image to a NTFS volume.
926 Microsoft has managed to introduce even more bugs into their software,
927 and now the WIMs for Windows 8 have incorrect (too low) reference counts
928 for some streams. This is unsafe because such streams can be removed
929 when they are in actuality still referenced in the WIM (perhaps by a
930 different image). wimlib will now work around this problem by fixing
931 the stream reference counts. This is only done when wimlib_delete_image() is
932 called ('imagex delete') or when wimlib_mount_image() is called with
933 WIMLIB_MOUNT_FLAG_READWRITE ('imagex mountrw'). Please note that this
934 requires reading the metadata for all images in the WIM, so this will
935 make these operations noticably slower on WIMs with multiple images.
937 Various other bugfixes.
940 Appending images to a WIM is now be done by default without re-building
941 the whole WIM. Use the --rebuild flag to get the old behavior (which
942 was to re-build the entire WIM when a new image is appended).
944 A new command `imagex optimize' is now available to manually re-build a
945 WIM that has wasted space due to repeated appends.
947 Progress information has been improved, and now arbitrary callback
948 functions can be used to show the progress of a WIM operation.
950 A possible bug with changing the bootable image of a WIM was fixed.
952 Some advisory locking is now done to prevent two processes from
953 modifying a WIM at the same time (but only in some cases). For example,
954 you cannot mount two images from a WIM read-write at the same time.
956 Some functions have been reorganized:
957 * wimlib_mount() renamed to wimlib_mount_image().
958 * wimlib_unmount() renamed to wimlib_unmount_image().
959 * wimlib_overwrite_xml_and_header() removed as
960 wimlib_overwrite() suffices now.
961 * wimlib_apply_image_to_ntfs_volume() removed as
962 wimlib_extract_image() suffices now.
963 * wimlib_add_image_from_ntfs_volume() removed as
964 * wimlib_add_image() suffices now.
966 Previously, the soname of libwim.so has been 0.0.0, despite many
967 interface changes. The soname is now updated to 1.0.0 and will now be
968 updated each release.
971 Resources will now be compressed using multiple threads by default.
972 (This applies to `imagex capture', `imagex append', and `imagex
975 Some performance improvements in mounted WIMs.
977 More progress information is shown when capturing a WIM.
980 Lots of minor fixes, code cleanups, and some documentation updates.
981 Nothing in particular is really noteworthy.
984 LZX and XPRESS compression improvements.
986 Fixed calculation of Directory Count, File Count, Total Bytes, and Hard
987 Link Bytes of the WIM.
990 Fixed bug when capturing NTFS file with multiple named data streams.
992 Internally, we are now using inode structures, even though these don't
993 appear literally in the WIM file. This simplifies some of the code
994 (mainly for WIM mounting) and likely fixed a few problems, although it
998 Fixed problem when exporting images from XPRESS to LZX compressed WIM or
1002 Enough changes to call it version 1.0.0!
1004 Capturing a WIM directly from a NTFS volume, and applying a WIM directly
1005 to a NTFS volume, is now supported.
1007 Hard links and symbolic links have much improved support. They are
1008 supported for WIM capture, WIM application, and mounted WIMs (you can
1009 even make them on read-write mounted WIMs).
1011 Alternate data streams are now supported on mounted WIMs through an
1012 xattr or a Windows-style stream interface. Also they are supported when
1013 capturing a WIM from NTFS or applying a WIM to NTFS.
1015 Split WIMs are better supported. You may now apply an image directly
1016 from a split WIM, mount an image from a split WIM read-only, or export
1017 an image from a split WIM.
1019 Using a capture configuration file is now supported (but not fully yet).
1021 SHA1 message digests are checked in more places, so we can make sure
1022 applied and captured data is correct.
1024 Man pages have been updated and consolidated.
1027 Fixed segfault when unmounting read-only WIM.
1030 Support for joining and splitting WIMs.
1031 Also, security data is now preserved by default.
1034 Can now build with older gcc and system headers, like on CentOS 5.
1037 Fixed bug that made it impossible to overwrite files in read-write
1041 Write byte-order mark before WIM XML data. (imagex.exe requires this to
git://wimlib.net / wimlib / blob