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