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