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