2 The new (as of v1.7.0) extraction code will no longer run out of file
3 handles when extracting many (1000+) identical files.
5 Library users can now initialize and de-initialize the library multiple
6 times in one run of an application program.
8 Library users will now receive WIMLIB_PROGRESS_MSG_WRITE_STREAMS and
9 WIMLIB_PROGRESS_MSG_EXTRACT_STREAMS messages more frequently when
10 writing or extracting large WIM files.
12 Added experimental new write flag:
13 WIMLIB_WRITE_FLAG_SEND_DONE_WITH_FILE_MESSAGES.
16 Improved compression, decompression, and extraction performance.
18 Improved compatibility with version 3584 WIM / ESD files:
19 - Add support for reading and writing multiple solid blocks per
20 archive, which WIMGAPI/DISM can create when appending an image.
21 - Correctly create solid blocks larger than 4 GiB.
23 'add' commands passed to wimupdate will now replace existing
24 nondirectory files by default. Use the --no-replace option to get the
27 The license for the library now contains an exception that allows using
28 it under the LGPL. See the COPYING file for details.
30 In reparse-point fixup mode (the default for capture), symbolic links
31 and junctions that point outside the tree being captured are no longer
32 excluded from capture.
34 Added support for "WIMBoot" capture and extraction. See the
35 documentation for the new '--wimboot' option to wimcapture and wimapply
38 On UNIX-like systems, you can now backup and restore device nodes, named
39 pipes, and sockets. In addition, 32-bit user and group IDs are now
42 The way that UNIX data is stored in WIM files has been changed. If you
43 captured any WIMs with the --unix-data option, to upgrade them you'll
44 need to apply them with --unix-data using wimlib-imagex v1.6.2, then
45 re-capture them with --unix-data using this version.
47 wimlib now understands tagged metadata items, such as object IDs, that
48 can be stored in WIM directory entries.
50 Removed the --hardlink and --symlink options to wimapply, since I don't
51 think they are too useful and they got in the way of improving the code.
53 WIMs will now retain their GUIDs when rebuilt (e.g. with wimoptimize).
55 The 'mkwinpeimg' script now supports writing the ISO image to standard
58 The <ARCH> element in WIM XML data is now exported correctly.
60 On Windows, sparse file attributes are no longer set on extracted files.
61 Oddly enough, this actually saves disk space in some cases.
63 On UNIX, configuring with --disable-xattr or --enable-xattr is no longer
64 supported. Mounting WIM images now always requires extended attribute
65 support. Use --without-fuse to disable support for mounting WIM images;
66 this will also disable the need for extended attribute support.
68 Configuring with --enable-ssse3-sha1 now works correctly.
70 The shared library version has been bumped up. The main
71 incompatibilities are:
73 - WIMLIB_COMPRESSION_TYPE_XPRESS is now 1 and
74 WIMLIB_COMPRESSION_TYPE_LZX is now 2 (so it's the same as
77 - User-provided progress functions are now registered using a
78 separate function, wimlib_register_progress_function(). The
79 'progress_func' argument to many functions no longer exists.
81 - The return value from user-provided progress functions is now
84 - A context argument has been added to the prototype of
85 user-provided progress functions.
87 - 'struct wimlib_capture_config' has been removed. The library
88 now takes the path to the configuration file directly. This
89 affects wimlib_add_image(), wimlib_add_image_multisource(),
90 and wimlib_update_image(). However, a NULL value passed in
91 the argument retains the same meaning.
93 - Removed deprecated functions: some (de)compression functions,
94 wimlib_extract_files(), and wimlib_print_metadata().
96 - Removed extraction flags: WIMLIB_EXTRACT_FLAG_HARDLINK,
97 WIMLIB_EXTRACT_FLAG_SYMLINK, WIMLIB_EXTRACT_FLAG_FILE_ORDER,
98 and WIMLIB_EXTRACT_FLAG_SEQUENTIAL.
100 - Removed some progress messages:
101 WIMLIB_PROGRESS_MSG_APPLY_TIMESTAMPS,
102 WIMLIB_PROGRESS_MSG_EXTRACT_DIR_STRUCTURE_BEGIN,
103 WIMLIB_PROGRESS_MSG_EXTRACT_DIR_STRUCTURE_END. Numbering
106 - Removed some error codes. Numbering stays the same.
108 - Replaced WIMLIB_UNMOUNT_FLAG_LAZY with
109 WIMLIB_UNMOUNT_FLAG_FORCE.
111 - WIM paths passed to progress functions now have a leading
115 Case-insensitive comparisons of strings (e.g. filenames) containing
116 UTF-16 codepoints above 32767 are now done correctly.
118 Fixed build failure on Mac OS X.
120 wimunmount now provides the '--new-image' option to cause changes to a
121 read-write mounted image to be committed as a new image rather than as
122 an update of the mounted image. (The corresponding new library flag is
123 WIMLIB_UNMOUNT_FLAG_NEW_IMAGE.)
125 The LZMS ("recovery") compression chunk size, or "dictionary size", may
126 now be up to 1 GiB (1,073,741,824 bytes).
128 The performance of LZX ("maximum") and LZMS ("recovery") compression
129 with large chunk sizes has been slightly improved.
132 Stored files with size exactly 4 GiB (4,294,967,296 bytes) are now
133 decompressed correctly.
135 Fixed a bug in the LZX compressor introduced in v1.5.3. The bug
136 occurred in an unlikely case, and due to validity checks it did not
137 affect successfully created archives.
139 Fixed a minor compatibility issue with the LZMS compressor and
140 decompressor. This is *not* the default compression type and was only
141 introduced in v1.6.0. In the unlikely event that you created an
142 LZMS-compressed WIM with v1.6.0 and a checksum error is reported when
143 applying it with v1.6.1, decompress it with v1.6.0 then compress it with
146 Memory usage for LZMS and LZX compression has been decreased.
148 wimextract now allows wildcard characters in paths specified on the
149 command line. Also, the '--strict-wildcards' option has been removed
150 and replaced with the inverse option '--nullglob'. See the
151 documentation for wimextract for more details and changes.
153 The wimlib_extract_files() function is now considered deprecated in
154 favor of wimlib_extract_paths().
156 Fixed more permissions problems when extracting files on Windows.
158 A new '--no-attributes' option has been added to wimapply and
159 wimextract. The library flag is WIMLIB_EXTRACT_FLAG_NO_ATTRIBUTES.
161 The default chunk size is now set correctly when changing the
162 compression type of a WIM, for example with 'wimoptimize'.
164 The '--metadata' option to wiminfo has been replaced with the
165 '--detailed' option to wimdir.
167 In relevant wimlib-imagex commands, '--solid' may now be used as an
168 alias for '--pack-streams'.
171 Support for extracting and updating the new version 3584 WIMs has been
172 added. These WIMs typically pack many streams ("files") together into a
173 single compressed resource, thereby saving space. This degrades the
174 performance of random access (such as that which occurs on a mounted
175 image), but optimizations have been implemented for extraction. These
176 new WIM files also typically use a new compression format (LZMS), which
177 is similar to LZMA and can offer a better compression ratio than LZX.
178 These new WIM files can be created using `wimcapture' with
179 the '--compress=lzms --pack-streams' options. Note: this new WIM format
180 is used by the Windows 8 web downloader, but important segments of the
181 raw '.esd' files are encrypted, so wimlib will not be able to extract
182 such files until they are first decrypted.
184 wimlib now supports extracting files and directories from a WIM image
185 based on a "listfile" that itself contains the list of paths to extract.
186 For `wimextract', the syntax is to specify @LISTFILE instead of a PATH,
187 and for the library itself, the new APIs are wimlib_extract_pathlist()
188 and wimlib_extract_paths(). Path globs containing wildcard characters
191 For searching WIM files, wimlib now has configurable case sensitivity.
192 The default on Windows is still case-insensitive and the default on
193 UNIX-like systems is still case-sensitive, but this can be overridden
194 on either platform through flags to wimlib_global_init(). For
195 `wimlib-imagex', the environmental variable WIMLIB_IMAGEX_IGNORE_CASE
196 can be set to 1 or 0 for case-insensitive or case-sensitive behavior,
199 Support for compression chunk sizes greater than the default of 32768
200 bytes has been added. A larger chunk size typically results in a better
201 compression ratio. However, the MS implementation is seemingly not
202 compatible with all chunk sizes, especially for LZX compression, so the
203 defaults remain unchanged, with the exception of the new LZMS-compressed
204 WIMs, which use a larger chunk size by default.
206 The compression/decompression API exported by wimlib has been changed.
207 Now one set of functions handles all supported compression formats.
209 `wimcapture' and `wimappend' will now display the progress of scanning
210 the directory tree to capture, in addition to the progress of writing
211 data to the WIM. The '--verbose' option no longer does anything. The
212 library API change for this is the addition of several members to
213 `struct wimlib_progress_info_scan' available to progress callbacks.
215 `mkwinpeimg' now correctly handles the '--start-script' option when the
216 start script is not in the working directory.
218 Sequential extraction, previously requested by using
219 WIMLIB_EXTRACT_FLAG_SEQUENTIAL, is now the default.
220 WIMLIB_EXTRACT_FLAG_FILE_ORDER can be used to get the old default
221 behavior (extract in file order).
224 The new LZX compressor added in v1.5.2 has been improved and is now
225 enabled by default, except when `wimcapture' or `wimappend' is run
226 *without* the '--compress' option, in which case the faster LZX
227 compressor is used (the same as before). This behavior is reasonably
228 consistent with ImageX which actually uses "fast" (XPRESS) compression
229 by default. In those cases, use '--compress=maximum' to explicitly
230 capture a WIM image using the new (slower but better) LZX compressor.
232 The '--compress-slow' option still exists to `wimlib-imagex optimize',
233 but its new behavior is to tweak the new LZX compressor even more to
234 produce an even better compression ratio at the cost of more time spent
237 `wimlib-imagex optimize' now supports the '--compress=TYPE' option,
238 which recompresses the WIM file using the specified compression TYPE.
239 The new library API function used for this is
240 wimlib_set_output_compression_type().
242 Added the wimlib_get_xml_data() function to allow library clients to
243 easily retrieve the raw XML data from a WIM file if needed.
245 Fixed a bug that could cause an error code to be incorrectly returned
246 when writing XML data containing a <WINDOWS> element.
248 Mounted WIM images will now correctly show the default file stream even
249 if appears in the alternate data stream entries of the corresponding WIM
253 Added a new experimental LZX compressor which can be enabled by passing
254 '--compress-slow' to `wimlib-imagex capture' or `wimlib-imagex
255 optimize'. (The latter is only applicable if the WIM is already
256 LZX-compressed and the '--recompress' option is also given.) The
257 experimental compressor is much slower but compresses the data slightly
258 more --- currently usually to within a fraction of a percent of the
259 results from WIMGAPI/ImageX.
261 A workaround has been added for compatibility with versions of WinPE
262 that interpret alternate data stream entries in the boot WIM
265 An alignment bug that caused a crash in the LZX decompressor on some
268 wimlib now attempts to clear the WIM_HDR_FLAG_WRITE_IN_PROGRESS flag in
269 the WIM header when restoring the previous state of a WIM it failed to
272 Added a workaround to avoid an access denied error on Windows when
273 replacing a WIM file that another process has opened.
276 wimlib can now open WinPE WIMs from WAIK v2.1, which had a quirk that
277 needed to be handled.
279 A bug in the interpretation of negative IMAGE indices in the
280 --update-of=[WIMFILE:]IMAGE option to `wimlib-imagex capture' and
281 `wimlib-imagex append' has been fixed.
283 A workaround has been added to successfully apply security descriptors
284 with empty DACLs when the NTFS-3g apply mode is being used with NTFS-3g
285 2013.1.13 or earlier.
287 `wimlib-imagex capture' can now accept the '--delta-from' option
291 Added support for "pipable" WIMs. Pipable WIMs allow capturing images
292 to standard output and applying images from standard input, but they are
293 not compatible with Microsoft's software and are not created by default.
294 See the documentation for --pipable flag of `wimlib-imagex capture' for
297 To better support incremental backups, added support for declaring an
298 image as a modified form of another image. See the documentation for
299 the '--update-of' option of `wimlib-imagex append' and `wimlib-imagex
302 Added supported for "delta" WIMs. See the documentation for the
303 '--delta-from' option of `wimlib-imagex capture'.
305 The library support for managing split WIMs has been changed to support
306 other arrangements, such as delta WIMs, and be easier to use. This
307 change is visible in `wimlib-imagex', which also can now accept the
308 '--ref' option multiple times, and also now supports "delta" WIMs as
311 wimlib now preserves WIM integrity tables by default, even if
312 WIMLIB_WRITE_FLAG_CHECK_INTEGRITY is not specified. This changes the
313 behavior of `wimlib-imagex' whenever the WIM being operated on contains
314 an integrity table and the '--check' option is not specified.
316 `wimlib-imagex capture' now creates LZX-compressed WIMs by default
317 (when --compress is not specified). This provides the best compression
318 ratio by default, which is usually what is desired, at a cost of some
321 `wimlib-imagex' now supports being invoked as wimCOMMAND, where COMMAND
322 is the command as in `wimlib-imagex COMMAND'; for example, it can be
323 invoked as `wimapply' as an alternative to `wimlib-imagex apply'. The
324 appropriate hard links are created in UNIX installations of
325 `wimlib-imagex', while for the Windows distribution of `wimlib-imagex',
326 batch files that emulate this behavior are generated.
328 Security descriptors are now extracted correctly on Windows.
330 Fixed archiving DOS names in NTFS-3g capture mode.
332 The extraction code has been rewritten and it will now be easier to
333 support new features on all supported backends (currently Win32, UNIX,
334 and NTFS-3g). For example, hard-linked extraction mode (--hardlink) is
335 now supported on all backends, not just UNIX.
337 `mkwinpeimg' now supports grabbing files from the WAIK supplement rather
338 than the WAIK itself.
340 wimlib_global_init() now, by default, attempts to acquire additional
341 privileges on Windows, so library clients need not do this.
343 This update bumps the shared library version number up to 9, since it is
344 not binary compatibible with previous releases.
347 Fixed bug in `wimlib-imagex export' that made it impossible to export an
348 image from a WIM that is readonly at the filesystem level.
350 Return error code rather than segfaulting when trying to list files from
351 a non-first part of a split WIM.
353 Joining a WIM will now preserve the RP_FIX and READONLY flags.
356 On Windows, paths given to wimlib-imagex are now treated case
359 Improved behavior regarding invalid filenames; in particular, on
360 Windows, wimlib-imagex will, when extracting, now omit (with an option
361 to override this default) filenames differing only in case, or filenames
362 containing characters not valid on Windows.
364 On Windows, wimlib now supports capturing and extracting long paths
365 (longer than the so-called MAX_PATH).
367 On Windows, `wimlib-imagex update' now acquires proper privileges when
368 running as an Administrator.
370 `wimlib-imagex update' will now complain if no image is specified when
371 trying to update a multi-image WIM.
373 `wimlib-imagex update' now supports specifying a single update command
374 directly on the command line using the --command option.
376 wimlib-imagex will now choose different units for progress messages,
377 depending on the amount of data that needs to be processed.
379 `wimlib-imagex append' will now generate a unique WIM image name if no
380 name is specified and the defaulted name already exists in the WIM.
382 wimlib now allows you to create unnamed WIM images, which can then only
383 be referred to by index.
385 wimlib now allows you to explicitly declare you want write access to a
386 WIM by providing the WIMLIB_OPEN_FLAG_WRITE_ACCESS flag to
389 wimlib now respects the WIM_HDR_FLAG_READONLY flag when set in the WIM
392 Progress callbacks have been added to wimlib's wimlib_update_image()
395 Added wimlib_get_wim_info(), wimlib_set_wim_info(),
396 wimlib_iterate_dir_tree(), and wimlib_iterate_lookup_table() functions
399 NTFS-3g capture now only warns about two conditions previously treated
402 Fixed a couple issues with using wimlib-imagex on UDF filesystems on
405 wimlib now correctly detects and returns an error when reading a WIM
406 image with a cyclic directory structure. (Fun fact: such a WIM will
407 crash Microsoft's software.)
410 Added new "extract" and "update" subcommands to wimlib-imagex, along
411 with associated APIs in the library. These commands are intended mainly
412 for Windows use but can be used on UNIX as well.
414 Many documentation improvements.
416 Fixed a bug in the Windows build where relative symbolic links were not
417 captured in reparse-point fixup mode.
419 Fixed a bug in the Windows build where file handles were left open to
420 the WIM file, causing `wimlib_imagex optimize' to fail in some cases.
422 Fixed a bug in the Windows build of wimlib-imagex where globbing
423 split-WIM parts could cause the program to crash.
425 Fixed a bug where the creation time of WIM images would be shown instead
426 of the last modification time.
428 With the Windows build it is now possible to restore a WIM containing
429 symbolic links as a non-Administrator; however you will receive warnings
430 about not being able to extract the symbolic links.
433 Capturing a WIM image should now be significantly faster in most cases
434 due to improved use of the operating system's cache and avoiding reading
435 files twice whenever possible.
437 The Windows build should now work on Windows XP.
439 The Windows build now supports capturing and restoring hidden,
440 compressed, sparse, and encrypted files.
442 The Windows build now supports capturing and applying WIM images from
443 filesystems other than NTFS (with some reduced functionality).
445 The Windows build now extracts short names correctly.
447 Added support for "reparse-point" fixups (i.e. fixing up of symbolic
448 links). See docs for --rpfix and --norpfix flags of `wimlib-imagex
449 capture' and `wimlib-imagex apply'.
451 The performance of splitting and joining WIMs should be slightly
454 The LZX and XPRESS compression and decompression functions are now
455 exported from the library.
458 Improvements and bugfixes for the Windows build.
460 Added --strict-acls options.
462 Fixed the way that wimlib determines the order of images in the WIM.
465 Since wimlib can now be used on Windows, wimlib's implementation of
466 ImageX has been renamed to wimlib-imagex to avoid confusion with
467 Microsoft's implementation of ImageX, which would have the same file
468 name ("imagex.exe"). If you really don't like this you can pass the
469 --with-imagex-progname option to `configure' to choose a different name,
470 or even simply rename the binary yourself (but the former way will
471 configure the man pages to use the chosen name).
473 Various bugs fixed in the Windows build. Mainly to do with capturing
474 and restoring alternate data streams correctly in weird cases, and
475 requesting the correct privileges when opening files. Also added the
476 --noacls options to wimlib-imagex capture, append, and apply.
478 Windows build again: FindFirstStreamW() and FindNextStreamW() are now
479 dynamically loaded, so this may make the library compatible with Windows
480 XP (however, there may still be other problems).
483 Added experimental support for native Windows builds. Binaries can be
484 downloaded from the SourceForge page.
486 --source-list option added to `imagex capture' and `imagex append'.
488 Better support for different character encodings.
491 Storing UNIX file owners, groups, and modes in WIM images is now
492 possible using `imagex capture' with the --unix-data flag.
494 Minor bug fixes and documentation fixes.
497 NTFS capture: Fixed capturing duplicate reparse points.
499 NTFS capture: Capture first unnamed stream if there are more than one
500 (print warning instead of error).
502 Allow multiple test cases to execute concurrently (e.g. make -j2 check).
505 Added --arch switch to mkwinpeimg script to support getting AMD64 WinPE
508 Update to work with ntfs-3g version 2013.1.13.
511 Fixed truncating file to shorter but non-zero length on read-write
514 Various code cleanups and minor documentation fixes.
517 LZX and XPRESS decompression have received some additional optimizations
518 and should now be even faster. (Although, they were already pretty
519 fast--- much faster than typical I/O speeds.)
521 Fixed a bug introduced in v1.2.1 that would cause a directory tree
522 containing hard links to be captured incorrectly in some cases.
525 By default, unmounting a read-write mounted WIM with 'imagex unmount
526 --commit' will now change the WIM in-place without needing to write the
527 entire WIM again. Use 'imagex unmount --commit --rebuild' to get the
530 'imagex unmount' no longer has a hard-coded limit of 10 minutes to wait
531 for a response from the daemon servicing the mounted WIM. Instead,
532 every second 'imagex unmount' will check if the daemon is still alive,
533 and keep waiting if so, otherwise terminate with an error.
535 'imagex unmount --commit' on a read-write mounted WIM will now print
536 progress information regarding the writing of new or modified streams
537 the WIM, just like when capturing or appending a WIM.
539 A small change has been made to XPRESS compression and it should improve
540 the compression ratio slightly.
542 A change was made that may improve performance slightly when applying a
543 WIM image to a NTFS volume.
545 Microsoft has managed to introduce even more bugs into their software,
546 and now the WIMs for Windows 8 have incorrect (too low) reference counts
547 for some streams. This is unsafe because such streams can be removed
548 when they are in actuality still referenced in the WIM (perhaps by a
549 different image). wimlib will now work around this problem by fixing
550 the stream reference counts. This is only done when wimlib_delete_image() is
551 called ('imagex delete') or when wimlib_mount_image() is called with
552 WIMLIB_MOUNT_FLAG_READWRITE ('imagex mountrw'). Please note that this
553 requires reading the metadata for all images in the WIM, so this will
554 make these operations noticably slower on WIMs with multiple images.
556 Various other bugfixes.
559 Appending images to a WIM is now be done by default without re-building
560 the whole WIM. Use the --rebuild flag to get the old behavior (which
561 was to re-build the entire WIM when a new image is appended).
563 A new command `imagex optimize' is now available to manually re-build a
564 WIM that has wasted space due to repeated appends.
566 Progress information has been improved, and now arbitrary callback
567 functions can be used to show the progress of a WIM operation.
569 A possible bug with changing the bootable image of a WIM was fixed.
571 Some advisory locking is now done to prevent two processes from
572 modifying a WIM at the same time (but only in some cases). For example,
573 you cannot mount two images from a WIM read-write at the same time.
575 Some functions have been reorganized:
576 * wimlib_mount() renamed to wimlib_mount_image().
577 * wimlib_unmount() renamed to wimlib_unmount_image().
578 * wimlib_overwrite_xml_and_header() removed as
579 wimlib_overwrite() suffices now.
580 * wimlib_apply_image_to_ntfs_volume() removed as
581 wimlib_extract_image() suffices now.
582 * wimlib_add_image_from_ntfs_volume() removed as
583 * wimlib_add_image() suffices now.
585 Previously, the soname of libwim.so has been 0.0.0, despite many
586 interface changes. The soname is now updated to 1.0.0 and will now be
587 updated each release.
590 Resources will now be compressed using multiple threads by default.
591 (This applies to `imagex capture', `imagex append', and `imagex
594 Some performance improvements in mounted WIMs.
596 More progress information is shown when capturing a WIM.
599 Lots of minor fixes, code cleanups, and some documentation updates.
600 Nothing in particular is really noteworthy.
603 LZX and XPRESS compression improvements.
605 Fixed calculation of Directory Count, File Count, Total Bytes, and Hard
606 Link Bytes of the WIM.
609 Fixed bug when capturing NTFS file with multiple named data streams.
611 Internally, we are now using inode structures, even though these don't
612 appear literally in the WIM file. This simplifies some of the code
613 (mainly for WIM mounting) and likely fixed a few problems, although it
617 Fixed problem when exporting images from XPRESS to LZX compressed WIM or
621 Enough changes to call it version 1.0.0!
623 Capturing a WIM directly from a NTFS volume, and applying a WIM directly
624 to a NTFS volume, is now supported.
626 Hard links and symbolic links have much improved support. They are
627 supported for WIM capture, WIM application, and mounted WIMs (you can
628 even make them on read-write mounted WIMs).
630 Alternate data streams are now supported on mounted WIMs through an
631 xattr or a Windows-style stream interface. Also they are supported when
632 capturing a WIM from NTFS or applying a WIM to NTFS.
634 Split WIMs are better supported. You may now apply an image directly
635 from a split WIM, mount an image from a split WIM read-only, or export
636 an image from a split WIM.
638 Using a capture configuration file is now supported (but not fully yet).
640 SHA1 message digests are checked in more places, so we can make sure
641 applied and captured data is correct.
643 Man pages have been updated and consolidated.
646 Fixed segfault when unmounting read-only WIM.
649 Support for joining and splitting WIMs.
650 Also, security data is now preserved by default.
653 Can now build with older gcc and system headers, like on CentOS 5.
656 Fixed bug that made it impossible to overwrite files in read-write
660 Write byte-order mark before WIM XML data. (imagex.exe requires this to