2 Made more improvements to the XPRESS, LZX, and LZMS compressors.
4 The default compression mode for wimcapture is now LZX compression in
5 its default mode, which is the same as '--compress=maximum'.
7 You can now specify an optional integer compression level to the
8 '--compress' option; e.g. '--compress=lzx:75'.
10 Made a minor change to the LZMS compressor and decompressor to fix an
11 incompatibility with the Microsoft implementation. In the unlikely
12 event that you created an LZMS-compressed WIM with wimlib v1.7.0 or
13 earlier and a checksum error is reported when extracting files from it
14 with wimlib v1.7.1, decompress it with v1.7.0 then compress it with
17 Added 'verify' subcommand to wimlib-imagex.
19 Notable library changes:
21 Custom compressor parameters have been removed from the library
22 in favor of the simpler level-based API.
24 Decompressor parameters have been removed entirely.
26 Library users can now specify a custom file for warning and
27 error messages to be sent to, rather than the default of
30 New function: wimlib_verify_wim().
33 Improved compression, decompression, and extraction performance.
35 Improved compatibility with version 3584 WIM / ESD files:
36 - Add support for reading and writing multiple solid blocks per
37 archive, which WIMGAPI/DISM can create when appending an image.
38 - Correctly create solid blocks larger than 4 GiB.
40 'add' commands passed to wimupdate will now replace existing
41 nondirectory files by default. Use the --no-replace option to get the
44 The license for the library now contains an exception that allows using
45 it under the LGPL. See the COPYING file for details.
47 In reparse-point fixup mode (the default for capture), symbolic links
48 and junctions that point outside the tree being captured are no longer
49 excluded from capture.
51 Added support for "WIMBoot" capture and extraction. See the
52 documentation for the new '--wimboot' option to wimcapture and wimapply
55 On UNIX-like systems, you can now backup and restore device nodes, named
56 pipes, and sockets. In addition, 32-bit user and group IDs are now
59 The way that UNIX data is stored in WIM files has been changed. If you
60 captured any WIMs with the --unix-data option, to upgrade them you'll
61 need to apply them with --unix-data using wimlib-imagex v1.6.2, then
62 re-capture them with --unix-data using this version.
64 wimlib now understands tagged metadata items, such as object IDs, that
65 can be stored in WIM directory entries.
67 Removed the --hardlink and --symlink options to wimapply, since I don't
68 think they are too useful and they got in the way of improving the code.
70 WIMs will now retain their GUIDs when rebuilt (e.g. with wimoptimize).
72 The 'mkwinpeimg' script now supports writing the ISO image to standard
75 The <ARCH> element in WIM XML data is now exported correctly.
77 On Windows, sparse file attributes are no longer set on extracted files.
78 Oddly enough, this actually saves disk space in some cases.
80 On UNIX, configuring with --disable-xattr or --enable-xattr is no longer
81 supported. Mounting WIM images now always requires extended attribute
82 support. Use --without-fuse to disable support for mounting WIM images;
83 this will also disable the need for extended attribute support.
85 Configuring with --enable-ssse3-sha1 now works correctly.
87 The shared library version has been bumped up. The main
88 incompatibilities are:
90 - WIMLIB_COMPRESSION_TYPE_XPRESS is now 1 and
91 WIMLIB_COMPRESSION_TYPE_LZX is now 2 (so it's the same as
94 - User-provided progress functions are now registered using a
95 separate function, wimlib_register_progress_function(). The
96 'progress_func' argument to many functions no longer exists.
98 - The return value from user-provided progress functions is now
101 - A context argument has been added to the prototype of
102 user-provided progress functions.
104 - 'struct wimlib_capture_config' has been removed. The library
105 now takes the path to the configuration file directly. This
106 affects wimlib_add_image(), wimlib_add_image_multisource(),
107 and wimlib_update_image(). However, a NULL value passed in
108 the argument retains the same meaning.
110 - Removed deprecated functions: some (de)compression functions,
111 wimlib_extract_files(), and wimlib_print_metadata().
113 - Removed extraction flags: WIMLIB_EXTRACT_FLAG_HARDLINK,
114 WIMLIB_EXTRACT_FLAG_SYMLINK, WIMLIB_EXTRACT_FLAG_FILE_ORDER,
115 and WIMLIB_EXTRACT_FLAG_SEQUENTIAL.
117 - Removed some progress messages:
118 WIMLIB_PROGRESS_MSG_APPLY_TIMESTAMPS,
119 WIMLIB_PROGRESS_MSG_EXTRACT_DIR_STRUCTURE_BEGIN,
120 WIMLIB_PROGRESS_MSG_EXTRACT_DIR_STRUCTURE_END. Numbering
123 - Removed some error codes. Numbering stays the same.
125 - Replaced WIMLIB_UNMOUNT_FLAG_LAZY with
126 WIMLIB_UNMOUNT_FLAG_FORCE.
128 - WIM paths passed to progress functions now have a leading
132 Case-insensitive comparisons of strings (e.g. filenames) containing
133 UTF-16 codepoints above 32767 are now done correctly.
135 Fixed build failure on Mac OS X.
137 wimunmount now provides the '--new-image' option to cause changes to a
138 read-write mounted image to be committed as a new image rather than as
139 an update of the mounted image. (The corresponding new library flag is
140 WIMLIB_UNMOUNT_FLAG_NEW_IMAGE.)
142 The LZMS ("recovery") compression chunk size, or "dictionary size", may
143 now be up to 1 GiB (1,073,741,824 bytes).
145 The performance of LZX ("maximum") and LZMS ("recovery") compression
146 with large chunk sizes has been slightly improved.
149 Stored files with size exactly 4 GiB (4,294,967,296 bytes) are now
150 decompressed correctly.
152 Fixed a bug in the LZX compressor introduced in v1.5.3. The bug
153 occurred in an unlikely case, and due to validity checks it did not
154 affect successfully created archives.
156 Fixed a minor compatibility issue with the LZMS compressor and
157 decompressor. This is *not* the default compression type and was only
158 introduced in v1.6.0. In the unlikely event that you created an
159 LZMS-compressed WIM with v1.6.0 and a checksum error is reported when
160 applying it with v1.6.1, decompress it with v1.6.0 then compress it with
163 Memory usage for LZMS and LZX compression has been decreased.
165 wimextract now allows wildcard characters in paths specified on the
166 command line. Also, the '--strict-wildcards' option has been removed
167 and replaced with the inverse option '--nullglob'. See the
168 documentation for wimextract for more details and changes.
170 The wimlib_extract_files() function is now considered deprecated in
171 favor of wimlib_extract_paths().
173 Fixed more permissions problems when extracting files on Windows.
175 A new '--no-attributes' option has been added to wimapply and
176 wimextract. The library flag is WIMLIB_EXTRACT_FLAG_NO_ATTRIBUTES.
178 The default chunk size is now set correctly when changing the
179 compression type of a WIM, for example with 'wimoptimize'.
181 The '--metadata' option to wiminfo has been replaced with the
182 '--detailed' option to wimdir.
184 In relevant wimlib-imagex commands, '--solid' may now be used as an
185 alias for '--pack-streams'.
188 Support for extracting and updating the new version 3584 WIMs has been
189 added. These WIMs typically pack many streams ("files") together into a
190 single compressed resource, thereby saving space. This degrades the
191 performance of random access (such as that which occurs on a mounted
192 image), but optimizations have been implemented for extraction. These
193 new WIM files also typically use a new compression format (LZMS), which
194 is similar to LZMA and can offer a better compression ratio than LZX.
195 These new WIM files can be created using `wimcapture' with
196 the '--compress=lzms --pack-streams' options. Note: this new WIM format
197 is used by the Windows 8 web downloader, but important segments of the
198 raw '.esd' files are encrypted, so wimlib will not be able to extract
199 such files until they are first decrypted.
201 wimlib now supports extracting files and directories from a WIM image
202 based on a "listfile" that itself contains the list of paths to extract.
203 For `wimextract', the syntax is to specify @LISTFILE instead of a PATH,
204 and for the library itself, the new APIs are wimlib_extract_pathlist()
205 and wimlib_extract_paths(). Path globs containing wildcard characters
208 For searching WIM files, wimlib now has configurable case sensitivity.
209 The default on Windows is still case-insensitive and the default on
210 UNIX-like systems is still case-sensitive, but this can be overridden
211 on either platform through flags to wimlib_global_init(). For
212 `wimlib-imagex', the environmental variable WIMLIB_IMAGEX_IGNORE_CASE
213 can be set to 1 or 0 for case-insensitive or case-sensitive behavior,
216 Support for compression chunk sizes greater than the default of 32768
217 bytes has been added. A larger chunk size typically results in a better
218 compression ratio. However, the MS implementation is seemingly not
219 compatible with all chunk sizes, especially for LZX compression, so the
220 defaults remain unchanged, with the exception of the new LZMS-compressed
221 WIMs, which use a larger chunk size by default.
223 The compression/decompression API exported by wimlib has been changed.
224 Now one set of functions handles all supported compression formats.
226 `wimcapture' and `wimappend' will now display the progress of scanning
227 the directory tree to capture, in addition to the progress of writing
228 data to the WIM. The '--verbose' option no longer does anything. The
229 library API change for this is the addition of several members to
230 `struct wimlib_progress_info_scan' available to progress callbacks.
232 `mkwinpeimg' now correctly handles the '--start-script' option when the
233 start script is not in the working directory.
235 Sequential extraction, previously requested by using
236 WIMLIB_EXTRACT_FLAG_SEQUENTIAL, is now the default.
237 WIMLIB_EXTRACT_FLAG_FILE_ORDER can be used to get the old default
238 behavior (extract in file order).
241 The new LZX compressor added in v1.5.2 has been improved and is now
242 enabled by default, except when `wimcapture' or `wimappend' is run
243 *without* the '--compress' option, in which case the faster LZX
244 compressor is used (the same as before). This behavior is reasonably
245 consistent with ImageX which actually uses "fast" (XPRESS) compression
246 by default. In those cases, use '--compress=maximum' to explicitly
247 capture a WIM image using the new (slower but better) LZX compressor.
249 The '--compress-slow' option still exists to `wimlib-imagex optimize',
250 but its new behavior is to tweak the new LZX compressor even more to
251 produce an even better compression ratio at the cost of more time spent
254 `wimlib-imagex optimize' now supports the '--compress=TYPE' option,
255 which recompresses the WIM file using the specified compression TYPE.
256 The new library API function used for this is
257 wimlib_set_output_compression_type().
259 Added the wimlib_get_xml_data() function to allow library clients to
260 easily retrieve the raw XML data from a WIM file if needed.
262 Fixed a bug that could cause an error code to be incorrectly returned
263 when writing XML data containing a <WINDOWS> element.
265 Mounted WIM images will now correctly show the default file stream even
266 if appears in the alternate data stream entries of the corresponding WIM
270 Added a new experimental LZX compressor which can be enabled by passing
271 '--compress-slow' to `wimlib-imagex capture' or `wimlib-imagex
272 optimize'. (The latter is only applicable if the WIM is already
273 LZX-compressed and the '--recompress' option is also given.) The
274 experimental compressor is much slower but compresses the data slightly
275 more --- currently usually to within a fraction of a percent of the
276 results from WIMGAPI/ImageX.
278 A workaround has been added for compatibility with versions of WinPE
279 that interpret alternate data stream entries in the boot WIM
282 An alignment bug that caused a crash in the LZX decompressor on some
285 wimlib now attempts to clear the WIM_HDR_FLAG_WRITE_IN_PROGRESS flag in
286 the WIM header when restoring the previous state of a WIM it failed to
289 Added a workaround to avoid an access denied error on Windows when
290 replacing a WIM file that another process has opened.
293 wimlib can now open WinPE WIMs from WAIK v2.1, which had a quirk that
294 needed to be handled.
296 A bug in the interpretation of negative IMAGE indices in the
297 --update-of=[WIMFILE:]IMAGE option to `wimlib-imagex capture' and
298 `wimlib-imagex append' has been fixed.
300 A workaround has been added to successfully apply security descriptors
301 with empty DACLs when the NTFS-3g apply mode is being used with NTFS-3g
302 2013.1.13 or earlier.
304 `wimlib-imagex capture' can now accept the '--delta-from' option
308 Added support for "pipable" WIMs. Pipable WIMs allow capturing images
309 to standard output and applying images from standard input, but they are
310 not compatible with Microsoft's software and are not created by default.
311 See the documentation for --pipable flag of `wimlib-imagex capture' for
314 To better support incremental backups, added support for declaring an
315 image as a modified form of another image. See the documentation for
316 the '--update-of' option of `wimlib-imagex append' and `wimlib-imagex
319 Added supported for "delta" WIMs. See the documentation for the
320 '--delta-from' option of `wimlib-imagex capture'.
322 The library support for managing split WIMs has been changed to support
323 other arrangements, such as delta WIMs, and be easier to use. This
324 change is visible in `wimlib-imagex', which also can now accept the
325 '--ref' option multiple times, and also now supports "delta" WIMs as
328 wimlib now preserves WIM integrity tables by default, even if
329 WIMLIB_WRITE_FLAG_CHECK_INTEGRITY is not specified. This changes the
330 behavior of `wimlib-imagex' whenever the WIM being operated on contains
331 an integrity table and the '--check' option is not specified.
333 `wimlib-imagex capture' now creates LZX-compressed WIMs by default
334 (when --compress is not specified). This provides the best compression
335 ratio by default, which is usually what is desired, at a cost of some
338 `wimlib-imagex' now supports being invoked as wimCOMMAND, where COMMAND
339 is the command as in `wimlib-imagex COMMAND'; for example, it can be
340 invoked as `wimapply' as an alternative to `wimlib-imagex apply'. The
341 appropriate hard links are created in UNIX installations of
342 `wimlib-imagex', while for the Windows distribution of `wimlib-imagex',
343 batch files that emulate this behavior are generated.
345 Security descriptors are now extracted correctly on Windows.
347 Fixed archiving DOS names in NTFS-3g capture mode.
349 The extraction code has been rewritten and it will now be easier to
350 support new features on all supported backends (currently Win32, UNIX,
351 and NTFS-3g). For example, hard-linked extraction mode (--hardlink) is
352 now supported on all backends, not just UNIX.
354 `mkwinpeimg' now supports grabbing files from the WAIK supplement rather
355 than the WAIK itself.
357 wimlib_global_init() now, by default, attempts to acquire additional
358 privileges on Windows, so library clients need not do this.
360 This update bumps the shared library version number up to 9, since it is
361 not binary compatibible with previous releases.
364 Fixed bug in `wimlib-imagex export' that made it impossible to export an
365 image from a WIM that is readonly at the filesystem level.
367 Return error code rather than segfaulting when trying to list files from
368 a non-first part of a split WIM.
370 Joining a WIM will now preserve the RP_FIX and READONLY flags.
373 On Windows, paths given to wimlib-imagex are now treated case
376 Improved behavior regarding invalid filenames; in particular, on
377 Windows, wimlib-imagex will, when extracting, now omit (with an option
378 to override this default) filenames differing only in case, or filenames
379 containing characters not valid on Windows.
381 On Windows, wimlib now supports capturing and extracting long paths
382 (longer than the so-called MAX_PATH).
384 On Windows, `wimlib-imagex update' now acquires proper privileges when
385 running as an Administrator.
387 `wimlib-imagex update' will now complain if no image is specified when
388 trying to update a multi-image WIM.
390 `wimlib-imagex update' now supports specifying a single update command
391 directly on the command line using the --command option.
393 wimlib-imagex will now choose different units for progress messages,
394 depending on the amount of data that needs to be processed.
396 `wimlib-imagex append' will now generate a unique WIM image name if no
397 name is specified and the defaulted name already exists in the WIM.
399 wimlib now allows you to create unnamed WIM images, which can then only
400 be referred to by index.
402 wimlib now allows you to explicitly declare you want write access to a
403 WIM by providing the WIMLIB_OPEN_FLAG_WRITE_ACCESS flag to
406 wimlib now respects the WIM_HDR_FLAG_READONLY flag when set in the WIM
409 Progress callbacks have been added to wimlib's wimlib_update_image()
412 Added wimlib_get_wim_info(), wimlib_set_wim_info(),
413 wimlib_iterate_dir_tree(), and wimlib_iterate_lookup_table() functions
416 NTFS-3g capture now only warns about two conditions previously treated
419 Fixed a couple issues with using wimlib-imagex on UDF filesystems on
422 wimlib now correctly detects and returns an error when reading a WIM
423 image with a cyclic directory structure. (Fun fact: such a WIM will
424 crash Microsoft's software.)
427 Added new "extract" and "update" subcommands to wimlib-imagex, along
428 with associated APIs in the library. These commands are intended mainly
429 for Windows use but can be used on UNIX as well.
431 Many documentation improvements.
433 Fixed a bug in the Windows build where relative symbolic links were not
434 captured in reparse-point fixup mode.
436 Fixed a bug in the Windows build where file handles were left open to
437 the WIM file, causing `wimlib_imagex optimize' to fail in some cases.
439 Fixed a bug in the Windows build of wimlib-imagex where globbing
440 split-WIM parts could cause the program to crash.
442 Fixed a bug where the creation time of WIM images would be shown instead
443 of the last modification time.
445 With the Windows build it is now possible to restore a WIM containing
446 symbolic links as a non-Administrator; however you will receive warnings
447 about not being able to extract the symbolic links.
450 Capturing a WIM image should now be significantly faster in most cases
451 due to improved use of the operating system's cache and avoiding reading
452 files twice whenever possible.
454 The Windows build should now work on Windows XP.
456 The Windows build now supports capturing and restoring hidden,
457 compressed, sparse, and encrypted files.
459 The Windows build now supports capturing and applying WIM images from
460 filesystems other than NTFS (with some reduced functionality).
462 The Windows build now extracts short names correctly.
464 Added support for "reparse-point" fixups (i.e. fixing up of symbolic
465 links). See docs for --rpfix and --norpfix flags of `wimlib-imagex
466 capture' and `wimlib-imagex apply'.
468 The performance of splitting and joining WIMs should be slightly
471 The LZX and XPRESS compression and decompression functions are now
472 exported from the library.
475 Improvements and bugfixes for the Windows build.
477 Added --strict-acls options.
479 Fixed the way that wimlib determines the order of images in the WIM.
482 Since wimlib can now be used on Windows, wimlib's implementation of
483 ImageX has been renamed to wimlib-imagex to avoid confusion with
484 Microsoft's implementation of ImageX, which would have the same file
485 name ("imagex.exe"). If you really don't like this you can pass the
486 --with-imagex-progname option to `configure' to choose a different name,
487 or even simply rename the binary yourself (but the former way will
488 configure the man pages to use the chosen name).
490 Various bugs fixed in the Windows build. Mainly to do with capturing
491 and restoring alternate data streams correctly in weird cases, and
492 requesting the correct privileges when opening files. Also added the
493 --noacls options to wimlib-imagex capture, append, and apply.
495 Windows build again: FindFirstStreamW() and FindNextStreamW() are now
496 dynamically loaded, so this may make the library compatible with Windows
497 XP (however, there may still be other problems).
500 Added experimental support for native Windows builds. Binaries can be
501 downloaded from the SourceForge page.
503 --source-list option added to `imagex capture' and `imagex append'.
505 Better support for different character encodings.
508 Storing UNIX file owners, groups, and modes in WIM images is now
509 possible using `imagex capture' with the --unix-data flag.
511 Minor bug fixes and documentation fixes.
514 NTFS capture: Fixed capturing duplicate reparse points.
516 NTFS capture: Capture first unnamed stream if there are more than one
517 (print warning instead of error).
519 Allow multiple test cases to execute concurrently (e.g. make -j2 check).
522 Added --arch switch to mkwinpeimg script to support getting AMD64 WinPE
525 Update to work with ntfs-3g version 2013.1.13.
528 Fixed truncating file to shorter but non-zero length on read-write
531 Various code cleanups and minor documentation fixes.
534 LZX and XPRESS decompression have received some additional optimizations
535 and should now be even faster. (Although, they were already pretty
536 fast--- much faster than typical I/O speeds.)
538 Fixed a bug introduced in v1.2.1 that would cause a directory tree
539 containing hard links to be captured incorrectly in some cases.
542 By default, unmounting a read-write mounted WIM with 'imagex unmount
543 --commit' will now change the WIM in-place without needing to write the
544 entire WIM again. Use 'imagex unmount --commit --rebuild' to get the
547 'imagex unmount' no longer has a hard-coded limit of 10 minutes to wait
548 for a response from the daemon servicing the mounted WIM. Instead,
549 every second 'imagex unmount' will check if the daemon is still alive,
550 and keep waiting if so, otherwise terminate with an error.
552 'imagex unmount --commit' on a read-write mounted WIM will now print
553 progress information regarding the writing of new or modified streams
554 the WIM, just like when capturing or appending a WIM.
556 A small change has been made to XPRESS compression and it should improve
557 the compression ratio slightly.
559 A change was made that may improve performance slightly when applying a
560 WIM image to a NTFS volume.
562 Microsoft has managed to introduce even more bugs into their software,
563 and now the WIMs for Windows 8 have incorrect (too low) reference counts
564 for some streams. This is unsafe because such streams can be removed
565 when they are in actuality still referenced in the WIM (perhaps by a
566 different image). wimlib will now work around this problem by fixing
567 the stream reference counts. This is only done when wimlib_delete_image() is
568 called ('imagex delete') or when wimlib_mount_image() is called with
569 WIMLIB_MOUNT_FLAG_READWRITE ('imagex mountrw'). Please note that this
570 requires reading the metadata for all images in the WIM, so this will
571 make these operations noticably slower on WIMs with multiple images.
573 Various other bugfixes.
576 Appending images to a WIM is now be done by default without re-building
577 the whole WIM. Use the --rebuild flag to get the old behavior (which
578 was to re-build the entire WIM when a new image is appended).
580 A new command `imagex optimize' is now available to manually re-build a
581 WIM that has wasted space due to repeated appends.
583 Progress information has been improved, and now arbitrary callback
584 functions can be used to show the progress of a WIM operation.
586 A possible bug with changing the bootable image of a WIM was fixed.
588 Some advisory locking is now done to prevent two processes from
589 modifying a WIM at the same time (but only in some cases). For example,
590 you cannot mount two images from a WIM read-write at the same time.
592 Some functions have been reorganized:
593 * wimlib_mount() renamed to wimlib_mount_image().
594 * wimlib_unmount() renamed to wimlib_unmount_image().
595 * wimlib_overwrite_xml_and_header() removed as
596 wimlib_overwrite() suffices now.
597 * wimlib_apply_image_to_ntfs_volume() removed as
598 wimlib_extract_image() suffices now.
599 * wimlib_add_image_from_ntfs_volume() removed as
600 * wimlib_add_image() suffices now.
602 Previously, the soname of libwim.so has been 0.0.0, despite many
603 interface changes. The soname is now updated to 1.0.0 and will now be
604 updated each release.
607 Resources will now be compressed using multiple threads by default.
608 (This applies to `imagex capture', `imagex append', and `imagex
611 Some performance improvements in mounted WIMs.
613 More progress information is shown when capturing a WIM.
616 Lots of minor fixes, code cleanups, and some documentation updates.
617 Nothing in particular is really noteworthy.
620 LZX and XPRESS compression improvements.
622 Fixed calculation of Directory Count, File Count, Total Bytes, and Hard
623 Link Bytes of the WIM.
626 Fixed bug when capturing NTFS file with multiple named data streams.
628 Internally, we are now using inode structures, even though these don't
629 appear literally in the WIM file. This simplifies some of the code
630 (mainly for WIM mounting) and likely fixed a few problems, although it
634 Fixed problem when exporting images from XPRESS to LZX compressed WIM or
638 Enough changes to call it version 1.0.0!
640 Capturing a WIM directly from a NTFS volume, and applying a WIM directly
641 to a NTFS volume, is now supported.
643 Hard links and symbolic links have much improved support. They are
644 supported for WIM capture, WIM application, and mounted WIMs (you can
645 even make them on read-write mounted WIMs).
647 Alternate data streams are now supported on mounted WIMs through an
648 xattr or a Windows-style stream interface. Also they are supported when
649 capturing a WIM from NTFS or applying a WIM to NTFS.
651 Split WIMs are better supported. You may now apply an image directly
652 from a split WIM, mount an image from a split WIM read-only, or export
653 an image from a split WIM.
655 Using a capture configuration file is now supported (but not fully yet).
657 SHA1 message digests are checked in more places, so we can make sure
658 applied and captured data is correct.
660 Man pages have been updated and consolidated.
663 Fixed segfault when unmounting read-only WIM.
666 Support for joining and splitting WIMs.
667 Also, security data is now preserved by default.
670 Can now build with older gcc and system headers, like on CentOS 5.
673 Fixed bug that made it impossible to overwrite files in read-write
677 Write byte-order mark before WIM XML data. (imagex.exe requires this to