1 Only the most important changes more recent than version 0.6 are noted here.
4 Improved compatibility with version 3584 WIM / ESD files.
6 Performance improvements, including for extraction.
8 'add' commands passed to wimupdate will now replace existing
9 nondirectory files by default. Use the --no-replace option to get the
12 Added support for "WIMBoot" capture and extraction. See the
13 documentation for the new '--wimboot' option to wimcapture and wimapply
16 Removed the --hardlink and --symlink options to wimapply, since I don't
17 think they are too useful and they got in the way of improving the code.
19 WIMs will now retain their GUIDs when rebuilt (e.g. with wimoptimize).
21 The 'mkwinpeimg' script now supports writing the ISO image to standard
24 On Windows, sparse file attributes are no longer set on extracted files.
26 The shared library version has been bumped up. The main
27 incompatibilities are:
29 - WIMLIB_COMPRESSION_TYPE_XPRESS is now 1 and
30 WIMLIB_COMPRESSION_TYPE_LZX is now 2 (so it's the same as
33 - 'struct wimlib_capture_config' has been removed. The library
34 now takes the path to the configuration file directly. This
35 affects wimlib_add_image(), wimlib_add_image_multisource(),
36 and wimlib_update_image(). However no code changes are
37 necessary if a NULL configuration was being used.
39 - Removed deprecated functions: some (de)compression functions,
40 wimlib_extract_files(), and wimlib_print_metadata().
42 - Removed extraction flags: WIMLIB_EXTRACT_FLAG_HARDLINK,
43 WIMLIB_EXTRACT_FLAG_SYMLINK, and
44 WIMLIB_EXTRACT_FLAG_FILE_ORDER.
46 - Removed progress messages:
47 WIMLIB_PROGRESS_MSG_APPLY_TIMESTAMPS,
48 WIMLIB_PROGRESS_MSG_EXTRACT_DIR_STRUCTURE_BEGIN,
49 WIMLIB_PROGRESS_MSG_EXTRACT_DIR_STRUCTURE_END.
51 - WIM paths passed to progress functions now have a leading
55 Case-insensitive comparisons of strings (e.g. filenames) containing
56 UTF-16 codepoints above 32767 are now done correctly.
58 Fixed build failure on Mac OS X.
60 wimunmount now provides the '--new-image' option to cause changes to a
61 read-write mounted image to be committed as a new image rather than as
62 an update of the mounted image. (The corresponding new library flag is
63 WIMLIB_UNMOUNT_FLAG_NEW_IMAGE.)
65 The LZMS ("recovery") compression chunk size, or "dictionary size", may
66 now be up to 1 GiB (1,073,741,824 bytes).
68 The performance of LZX ("maximum") and LZMS ("recovery") compression
69 with large chunk sizes has been slightly improved.
72 Stored files with size exactly 4 GiB (4,294,967,296 bytes) are now
73 decompressed correctly.
75 Fixed a bug in the LZX compressor introduced in v1.5.3. The bug
76 occurred in an unlikely case, and due to validity checks it did not
77 affect successfully created archives.
79 Fixed a minor compatibility issue with the LZMS compressor and
80 decompressor. This is *not* the default compression type and was only
81 introduced in v1.6.0. In the unlikely event that you created an
82 LZMS-compressed WIM with v1.6.0 and a checksum error is reported when
83 applying it with v1.6.1, decompress it with v1.6.0 then compress it with
86 Memory usage for LZMS and LZX compression has been decreased.
88 wimextract now allows wildcard characters in paths specified on the
89 command line. Also, the '--strict-wildcards' option has been removed
90 and replaced with the inverse option '--nullglob'. See the
91 documentation for wimextract for more details and changes.
93 The wimlib_extract_files() function is now considered deprecated in
94 favor of wimlib_extract_paths().
96 Fixed more permissions problems when extracting files on Windows.
98 A new '--no-attributes' option has been added to wimapply and
99 wimextract. The library flag is WIMLIB_EXTRACT_FLAG_NO_ATTRIBUTES.
101 The default chunk size is now set correctly when changing the
102 compression type of a WIM, for example with 'wimoptimize'.
104 The '--metadata' option to wiminfo has been replaced with the
105 '--detailed' option to wimdir.
107 In relevant wimlib-imagex commands, '--solid' may now be used as an
108 alias for '--pack-streams'.
111 Support for extracting and updating the new version 3584 WIMs has been
112 added. These WIMs typically pack many streams ("files") together into a
113 single compressed resource, thereby saving space. This degrades the
114 performance of random access (such as that which occurs on a mounted
115 image), but optimizations have been implemented for extraction. These
116 new WIM files also typically use a new compression format (LZMS), which
117 is similar to LZMA and can offer a better compression ratio than LZX.
118 These new WIM files can be created using `wimcapture' with
119 the '--compress=lzms --pack-streams' options. Note: this new WIM format
120 is used by the Windows 8 web downloader, but important segments of the
121 raw '.esd' files are encrypted, so wimlib will not be able to extract
122 such files until they are first decrypted.
124 wimlib now supports extracting files and directories from a WIM image
125 based on a "listfile" that itself contains the list of paths to extract.
126 For `wimextract', the syntax is to specify @LISTFILE instead of a PATH,
127 and for the library itself, the new APIs are wimlib_extract_pathlist()
128 and wimlib_extract_paths(). Path globs containing wildcard characters
131 For searching WIM files, wimlib now has configurable case sensitivity.
132 The default on Windows is still case-insensitive and the default on
133 UNIX-like systems is still case-sensitive, but this can be overridden
134 on either platform through flags to wimlib_global_init(). For
135 `wimlib-imagex', the environmental variable WIMLIB_IMAGEX_IGNORE_CASE
136 can be set to 1 or 0 for case-insensitive or case-sensitive behavior,
139 Support for compression chunk sizes greater than the default of 32768
140 bytes has been added. A larger chunk size typically results in a better
141 compression ratio. However, the MS implementation is seemingly not
142 compatible with all chunk sizes, especially for LZX compression, so the
143 defaults remain unchanged, with the exception of the new LZMS-compressed
144 WIMs, which use a larger chunk size by default.
146 The compression/decompression API exported by wimlib has been changed.
147 Now one set of functions handles all supported compression formats.
149 `wimcapture' and `wimappend' will now display the progress of scanning
150 the directory tree to capture, in addition to the progress of writing
151 data to the WIM. The '--verbose' option no longer does anything. The
152 library API change for this is the addition of several members to
153 `struct wimlib_progress_info_scan' available to progress callbacks.
155 `mkwinpeimg' now correctly handles the '--start-script' option when the
156 start script is not in the working directory.
158 Sequential extraction, previously requested by using
159 WIMLIB_EXTRACT_FLAG_SEQUENTIAL, is now the default.
160 WIMLIB_EXTRACT_FLAG_FILE_ORDER can be used to get the old default
161 behavior (extract in file order).
164 The new LZX compressor added in v1.5.2 has been improved and is now
165 enabled by default, except when `wimcapture' or `wimappend' is run
166 *without* the '--compress' option, in which case the faster LZX
167 compressor is used (the same as before). This behavior is reasonably
168 consistent with ImageX which actually uses "fast" (XPRESS) compression
169 by default. In those cases, use '--compress=maximum' to explicitly
170 capture a WIM image using the new (slower but better) LZX compressor.
172 The '--compress-slow' option still exists to `wimlib-imagex optimize',
173 but its new behavior is to tweak the new LZX compressor even more to
174 produce an even better compression ratio at the cost of more time spent
177 `wimlib-imagex optimize' now supports the '--compress=TYPE' option,
178 which recompresses the WIM file using the specified compression TYPE.
179 The new library API function used for this is
180 wimlib_set_output_compression_type().
182 Added the wimlib_get_xml_data() function to allow library clients to
183 easily retrieve the raw XML data from a WIM file if needed.
185 Fixed a bug that could cause an error code to be incorrectly returned
186 when writing XML data containing a <WINDOWS> element.
188 Mounted WIM images will now correctly show the default file stream even
189 if appears in the alternate data stream entries of the corresponding WIM
193 Added a new experimental LZX compressor which can be enabled by passing
194 '--compress-slow' to `wimlib-imagex capture' or `wimlib-imagex
195 optimize'. (The latter is only applicable if the WIM is already
196 LZX-compressed and the '--recompress' option is also given.) The
197 experimental compressor is much slower but compresses the data slightly
198 more --- currently usually to within a fraction of a percent of the
199 results from WIMGAPI/ImageX.
201 A workaround has been added for compatibility with versions of WinPE
202 that interpret alternate data stream entries in the boot WIM
205 An alignment bug that caused a crash in the LZX decompressor on some
208 wimlib now attempts to clear the WIM_HDR_FLAG_WRITE_IN_PROGRESS flag in
209 the WIM header when restoring the previous state of a WIM it failed to
212 Added a workaround to avoid an access denied error on Windows when
213 replacing a WIM file that another process has opened.
216 wimlib can now open WinPE WIMs from WAIK v2.1, which had a quirk that
217 needed to be handled.
219 A bug in the interpretation of negative IMAGE indices in the
220 --update-of=[WIMFILE:]IMAGE option to `wimlib-imagex capture' and
221 `wimlib-imagex append' has been fixed.
223 A workaround has been added to successfully apply security descriptors
224 with empty DACLs when the NTFS-3g apply mode is being used with NTFS-3g
225 2013.1.13 or earlier.
227 `wimlib-imagex capture' can now accept the '--delta-from' option
231 Added support for "pipable" WIMs. Pipable WIMs allow capturing images
232 to standard output and applying images from standard input, but they are
233 not compatible with Microsoft's software and are not created by default.
234 See the documentation for --pipable flag of `wimlib-imagex capture' for
237 To better support incremental backups, added support for declaring an
238 image as a modified form of another image. See the documentation for
239 the '--update-of' option of `wimlib-imagex append' and `wimlib-imagex
242 Added supported for "delta" WIMs. See the documentation for the
243 '--delta-from' option of `wimlib-imagex capture'.
245 The library support for managing split WIMs has been changed to support
246 other arrangements, such as delta WIMs, and be easier to use. This
247 change is visible in `wimlib-imagex', which also can now accept the
248 '--ref' option multiple times, and also now supports "delta" WIMs as
251 wimlib now preserves WIM integrity tables by default, even if
252 WIMLIB_WRITE_FLAG_CHECK_INTEGRITY is not specified. This changes the
253 behavior of `wimlib-imagex' whenever the WIM being operated on contains
254 an integrity table and the '--check' option is not specified.
256 `wimlib-imagex capture' now creates LZX-compressed WIMs by default
257 (when --compress is not specified). This provides the best compression
258 ratio by default, which is usually what is desired, at a cost of some
261 `wimlib-imagex' now supports being invoked as wimCOMMAND, where COMMAND
262 is the command as in `wimlib-imagex COMMAND'; for example, it can be
263 invoked as `wimapply' as an alternative to `wimlib-imagex apply'. The
264 appropriate hard links are created in UNIX installations of
265 `wimlib-imagex', while for the Windows distribution of `wimlib-imagex',
266 batch files that emulate this behavior are generated.
268 Security descriptors are now extracted correctly on Windows.
270 Fixed archiving DOS names in NTFS-3g capture mode.
272 The extraction code has been rewritten and it will now be easier to
273 support new features on all supported backends (currently Win32, UNIX,
274 and NTFS-3g). For example, hard-linked extraction mode (--hardlink) is
275 now supported on all backends, not just UNIX.
277 `mkwinpeimg' now supports grabbing files from the WAIK supplement rather
278 than the WAIK itself.
280 wimlib_global_init() now, by default, attempts to acquire additional
281 privileges on Windows, so library clients need not do this.
283 This update bumps the shared library version number up to 9, since it is
284 not binary compatibible with previous releases.
287 Fixed bug in `wimlib-imagex export' that made it impossible to export an
288 image from a WIM that is readonly at the filesystem level.
290 Return error code rather than segfaulting when trying to list files from
291 a non-first part of a split WIM.
293 Joining a WIM will now preserve the RP_FIX and READONLY flags.
296 On Windows, paths given to wimlib-imagex are now treated case
299 Improved behavior regarding invalid filenames; in particular, on
300 Windows, wimlib-imagex will, when extracting, now omit (with an option
301 to override this default) filenames differing only in case, or filenames
302 containing characters not valid on Windows.
304 On Windows, wimlib now supports capturing and extracting long paths
305 (longer than the so-called MAX_PATH).
307 On Windows, `wimlib-imagex update' now acquires proper privileges when
308 running as an Administrator.
310 `wimlib-imagex update' will now complain if no image is specified when
311 trying to update a multi-image WIM.
313 `wimlib-imagex update' now supports specifying a single update command
314 directly on the command line using the --command option.
316 wimlib-imagex will now choose different units for progress messages,
317 depending on the amount of data that needs to be processed.
319 `wimlib-imagex append' will now generate a unique WIM image name if no
320 name is specified and the defaulted name already exists in the WIM.
322 wimlib now allows you to create unnamed WIM images, which can then only
323 be referred to by index.
325 wimlib now allows you to explicitly declare you want write access to a
326 WIM by providing the WIMLIB_OPEN_FLAG_WRITE_ACCESS flag to
329 wimlib now respects the WIM_HDR_FLAG_READONLY flag when set in the WIM
332 Progress callbacks have been added to wimlib's wimlib_update_image()
335 Added wimlib_get_wim_info(), wimlib_set_wim_info(),
336 wimlib_iterate_dir_tree(), and wimlib_iterate_lookup_table() functions
339 NTFS-3g capture now only warns about two conditions previously treated
342 Fixed a couple issues with using wimlib-imagex on UDF filesystems on
345 wimlib now correctly detects and returns an error when reading a WIM
346 image with a cyclic directory structure. (Fun fact: such a WIM will
347 crash Microsoft's software.)
350 Added new "extract" and "update" subcommands to wimlib-imagex, along
351 with associated APIs in the library. These commands are intended mainly
352 for Windows use but can be used on UNIX as well.
354 Many documentation improvements.
356 Fixed a bug in the Windows build where relative symbolic links were not
357 captured in reparse-point fixup mode.
359 Fixed a bug in the Windows build where file handles were left open to
360 the WIM file, causing `wimlib_imagex optimize' to fail in some cases.
362 Fixed a bug in the Windows build of wimlib-imagex where globbing
363 split-WIM parts could cause the program to crash.
365 Fixed a bug where the creation time of WIM images would be shown instead
366 of the last modification time.
368 With the Windows build it is now possible to restore a WIM containing
369 symbolic links as a non-Administrator; however you will receive warnings
370 about not being able to extract the symbolic links.
373 Capturing a WIM image should now be significantly faster in most cases
374 due to improved use of the operating system's cache and avoiding reading
375 files twice whenever possible.
377 The Windows build should now work on Windows XP.
379 The Windows build now supports capturing and restoring hidden,
380 compressed, sparse, and encrypted files.
382 The Windows build now supports capturing and applying WIM images from
383 filesystems other than NTFS (with some reduced functionality).
385 The Windows build now extracts short names correctly.
387 Added support for "reparse-point" fixups (i.e. fixing up of symbolic
388 links). See docs for --rpfix and --norpfix flags of `wimlib-imagex
389 capture' and `wimlib-imagex apply'.
391 The performance of splitting and joining WIMs should be slightly
394 The LZX and XPRESS compression and decompression functions are now
395 exported from the library.
398 Improvements and bugfixes for the Windows build.
400 Added --strict-acls options.
402 Fixed the way that wimlib determines the order of images in the WIM.
405 Since wimlib can now be used on Windows, wimlib's implementation of
406 ImageX has been renamed to wimlib-imagex to avoid confusion with
407 Microsoft's implementation of ImageX, which would have the same file
408 name ("imagex.exe"). If you really don't like this you can pass the
409 --with-imagex-progname option to `configure' to choose a different name,
410 or even simply rename the binary yourself (but the former way will
411 configure the man pages to use the chosen name).
413 Various bugs fixed in the Windows build. Mainly to do with capturing
414 and restoring alternate data streams correctly in weird cases, and
415 requesting the correct privileges when opening files. Also added the
416 --noacls options to wimlib-imagex capture, append, and apply.
418 Windows build again: FindFirstStreamW() and FindNextStreamW() are now
419 dynamically loaded, so this may make the library compatible with Windows
420 XP (however, there may still be other problems).
423 Added experimental support for native Windows builds. Binaries can be
424 downloaded from the SourceForge page.
426 --source-list option added to `imagex capture' and `imagex append'.
428 Better support for different character encodings.
431 Storing UNIX file owners, groups, and modes in WIM images is now
432 possible using `imagex capture' with the --unix-data flag.
434 Minor bug fixes and documentation fixes.
437 NTFS capture: Fixed capturing duplicate reparse points.
439 NTFS capture: Capture first unnamed stream if there are more than one
440 (print warning instead of error).
442 Allow multiple test cases to execute concurrently (e.g. make -j2 check).
445 Added --arch switch to mkwinpeimg script to support getting AMD64 WinPE
448 Update to work with ntfs-3g version 2013.1.13.
451 Fixed truncating file to shorter but non-zero length on read-write
454 Various code cleanups and minor documentation fixes.
457 LZX and XPRESS decompression have received some additional optimizations
458 and should now be even faster. (Although, they were already pretty
459 fast--- much faster than typical I/O speeds.)
461 Fixed a bug introduced in v1.2.1 that would cause a directory tree
462 containing hard links to be captured incorrectly in some cases.
465 By default, unmounting a read-write mounted WIM with 'imagex unmount
466 --commit' will now change the WIM in-place without needing to write the
467 entire WIM again. Use 'imagex unmount --commit --rebuild' to get the
470 'imagex unmount' no longer has a hard-coded limit of 10 minutes to wait
471 for a response from the daemon servicing the mounted WIM. Instead,
472 every second 'imagex unmount' will check if the daemon is still alive,
473 and keep waiting if so, otherwise terminate with an error.
475 'imagex unmount --commit' on a read-write mounted WIM will now print
476 progress information regarding the writing of new or modified streams
477 the WIM, just like when capturing or appending a WIM.
479 A small change has been made to XPRESS compression and it should improve
480 the compression ratio slightly.
482 A change was made that may improve performance slightly when applying a
483 WIM image to a NTFS volume.
485 Microsoft has managed to introduce even more bugs into their software,
486 and now the WIMs for Windows 8 have incorrect (too low) reference counts
487 for some streams. This is unsafe because such streams can be removed
488 when they are in actuality still referenced in the WIM (perhaps by a
489 different image). wimlib will now work around this problem by fixing
490 the stream reference counts. This is only done when wimlib_delete_image() is
491 called ('imagex delete') or when wimlib_mount_image() is called with
492 WIMLIB_MOUNT_FLAG_READWRITE ('imagex mountrw'). Please note that this
493 requires reading the metadata for all images in the WIM, so this will
494 make these operations noticably slower on WIMs with multiple images.
496 Various other bugfixes.
499 Appending images to a WIM is now be done by default without re-building
500 the whole WIM. Use the --rebuild flag to get the old behavior (which
501 was to re-build the entire WIM when a new image is appended).
503 A new command `imagex optimize' is now available to manually re-build a
504 WIM that has wasted space due to repeated appends.
506 Progress information has been improved, and now arbitrary callback
507 functions can be used to show the progress of a WIM operation.
509 A possible bug with changing the bootable image of a WIM was fixed.
511 Some advisory locking is now done to prevent two processes from
512 modifying a WIM at the same time (but only in some cases). For example,
513 you cannot mount two images from a WIM read-write at the same time.
515 Some functions have been reorganized:
516 * wimlib_mount() renamed to wimlib_mount_image().
517 * wimlib_unmount() renamed to wimlib_unmount_image().
518 * wimlib_overwrite_xml_and_header() removed as
519 wimlib_overwrite() suffices now.
520 * wimlib_apply_image_to_ntfs_volume() removed as
521 wimlib_extract_image() suffices now.
522 * wimlib_add_image_from_ntfs_volume() removed as
523 * wimlib_add_image() suffices now.
525 Previously, the soname of libwim.so has been 0.0.0, despite many
526 interface changes. The soname is now updated to 1.0.0 and will now be
527 updated each release.
530 Resources will now be compressed using multiple threads by default.
531 (This applies to `imagex capture', `imagex append', and `imagex
534 Some performance improvements in mounted WIMs.
536 More progress information is shown when capturing a WIM.
539 Lots of minor fixes, code cleanups, and some documentation updates.
540 Nothing in particular is really noteworthy.
543 LZX and XPRESS compression improvements.
545 Fixed calculation of Directory Count, File Count, Total Bytes, and Hard
546 Link Bytes of the WIM.
549 Fixed bug when capturing NTFS file with multiple named data streams.
551 Internally, we are now using inode structures, even though these don't
552 appear literally in the WIM file. This simplifies some of the code
553 (mainly for WIM mounting) and likely fixed a few problems, although it
557 Fixed problem when exporting images from XPRESS to LZX compressed WIM or
561 Enough changes to call it version 1.0.0!
563 Capturing a WIM directly from a NTFS volume, and applying a WIM directly
564 to a NTFS volume, is now supported.
566 Hard links and symbolic links have much improved support. They are
567 supported for WIM capture, WIM application, and mounted WIMs (you can
568 even make them on read-write mounted WIMs).
570 Alternate data streams are now supported on mounted WIMs through an
571 xattr or a Windows-style stream interface. Also they are supported when
572 capturing a WIM from NTFS or applying a WIM to NTFS.
574 Split WIMs are better supported. You may now apply an image directly
575 from a split WIM, mount an image from a split WIM read-only, or export
576 an image from a split WIM.
578 Using a capture configuration file is now supported (but not fully yet).
580 SHA1 message digests are checked in more places, so we can make sure
581 applied and captured data is correct.
583 Man pages have been updated and consolidated.
586 Fixed segfault when unmounting read-only WIM.
589 Support for joining and splitting WIMs.
590 Also, security data is now preserved by default.
593 Can now build with older gcc and system headers, like on CentOS 5.
596 Fixed bug that made it impossible to overwrite files in read-write
600 Write byte-order mark before WIM XML data. (imagex.exe requires this to