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