1 Only the most important changes more recent than version 0.6 are noted here.
4 Added support for "WIMBoot". On any platform, you can now capture a WIM
5 as WIMBoot-compatible. In addition, on Windows, you can now apply a WIM
6 archive in a special mode that causes extracted files to be externally
7 backed by the WIM archive. See the documentation for the new
8 '--wimboot' option to wimcapture and wimapply for more information.
10 'add' commands passed to wimupdate will now replace existing
11 nondirectory files by default. Use the --no-replace option to get the
14 Fixed reading out-of-order entries in lookup table of version 3584 WIM /
17 The shared library version has been bumped up; however, there are only a
18 few incompatibilities:
20 - WIMLIB_COMPRESSION_TYPE_XPRESS is now 1 and
21 WIMLIB_COMPRESSION_TYPE_LZX is now 2 (so it's the same as
24 - 'struct wimlib_capture_config' has been removed. The library
25 now takes the path to the configuration file directly. This
26 affects wimlib_add_image(), wimlib_add_image_multisource(),
27 and wimlib_update_image(). However no code changes are
28 necessary if a NULL configuration was being used.
30 - Removed deprecated functions: some (de)compression functions,
31 wimlib_extract_files(), and wimlib_print_metadata().
34 Case-insensitive comparisons of strings (e.g. filenames) containing
35 UTF-16 codepoints above 32767 are now done correctly.
37 Fixed build failure on Mac OS X.
39 wimunmount now provides the '--new-image' option to cause changes to a
40 read-write mounted image to be committed as a new image rather than as
41 an update of the mounted image. (The corresponding new library flag is
42 WIMLIB_UNMOUNT_FLAG_NEW_IMAGE.)
44 The LZMS ("recovery") compression chunk size, or "dictionary size", may
45 now be up to 1 GiB (1,073,741,824 bytes).
47 The performance of LZX ("maximum") and LZMS ("recovery") compression
48 with large chunk sizes has been slightly improved.
51 Stored files with size exactly 4 GiB (4,294,967,296 bytes) are now
52 decompressed correctly.
54 Fixed a bug in the LZX compressor introduced in v1.5.3. The bug
55 occurred in an unlikely case, and due to validity checks it did not
56 affect successfully created archives.
58 Fixed a minor compatibility issue with the LZMS compressor and
59 decompressor. This is *not* the default compression type and was only
60 introduced in v1.6.0. In the unlikely event that you created an
61 LZMS-compressed WIM with v1.6.0 and a checksum error is reported when
62 applying it with v1.6.1, decompress it with v1.6.0 then compress it with
65 Memory usage for LZMS and LZX compression has been decreased.
67 wimextract now allows wildcard characters in paths specified on the
68 command line. Also, the '--strict-wildcards' option has been removed
69 and replaced with the inverse option '--nullglob'. See the
70 documentation for wimextract for more details and changes.
72 The wimlib_extract_files() function is now considered deprecated in
73 favor of wimlib_extract_paths().
75 Fixed more permissions problems when extracting files on Windows.
77 A new '--no-attributes' option has been added to wimapply and
78 wimextract. The library flag is WIMLIB_EXTRACT_FLAG_NO_ATTRIBUTES.
80 The default chunk size is now set correctly when changing the
81 compression type of a WIM, for example with 'wimoptimize'.
83 The '--metadata' option to wiminfo has been replaced with the
84 '--detailed' option to wimdir.
86 In relevant wimlib-imagex commands, '--solid' may now be used as an
87 alias for '--pack-streams'.
90 Support for extracting and updating the new version 3584 WIMs has been
91 added. These WIMs typically pack many streams ("files") together into a
92 single compressed resource, thereby saving space. This degrades the
93 performance of random access (such as that which occurs on a mounted
94 image), but optimizations have been implemented for extraction. These
95 new WIM files also typically use a new compression format (LZMS), which
96 is similar to LZMA and can offer a better compression ratio than LZX.
97 These new WIM files can be created using `wimcapture' with
98 the '--compress=lzms --pack-streams' options. Note: this new WIM format
99 is used by the Windows 8 web downloader, but important segments of the
100 raw '.esd' files are encrypted, so wimlib will not be able to extract
101 such files until they are first decrypted.
103 wimlib now supports extracting files and directories from a WIM image
104 based on a "listfile" that itself contains the list of paths to extract.
105 For `wimextract', the syntax is to specify @LISTFILE instead of a PATH,
106 and for the library itself, the new APIs are wimlib_extract_pathlist()
107 and wimlib_extract_paths(). Path globs containing wildcard characters
110 For searching WIM files, wimlib now has configurable case sensitivity.
111 The default on Windows is still case-insensitive and the default on
112 UNIX-like systems is still case-sensitive, but this can be overridden
113 on either platform through flags to wimlib_global_init(). For
114 `wimlib-imagex', the environmental variable WIMLIB_IMAGEX_IGNORE_CASE
115 can be set to 1 or 0 for case-insensitive or case-sensitive behavior,
118 Support for compression chunk sizes greater than the default of 32768
119 bytes has been added. A larger chunk size typically results in a better
120 compression ratio. However, the MS implementation is seemingly not
121 compatible with all chunk sizes, especially for LZX compression, so the
122 defaults remain unchanged, with the exception of the new LZMS-compressed
123 WIMs, which use a larger chunk size by default.
125 The compression/decompression API exported by wimlib has been changed.
126 Now one set of functions handles all supported compression formats.
128 `wimcapture' and `wimappend' will now display the progress of scanning
129 the directory tree to capture, in addition to the progress of writing
130 data to the WIM. The '--verbose' option no longer does anything. The
131 library API change for this is the addition of several members to
132 `struct wimlib_progress_info_scan' available to progress callbacks.
134 `mkwinpeimg' now correctly handles the '--start-script' option when the
135 start script is not in the working directory.
137 Sequential extraction, previously requested by using
138 WIMLIB_EXTRACT_FLAG_SEQUENTIAL, is now the default.
139 WIMLIB_EXTRACT_FLAG_FILE_ORDER can be used to get the old default
140 behavior (extract in file order).
143 The new LZX compressor added in v1.5.2 has been improved and is now
144 enabled by default, except when `wimcapture' or `wimappend' is run
145 *without* the '--compress' option, in which case the faster LZX
146 compressor is used (the same as before). This behavior is reasonably
147 consistent with ImageX which actually uses "fast" (XPRESS) compression
148 by default. In those cases, use '--compress=maximum' to explicitly
149 capture a WIM image using the new (slower but better) LZX compressor.
151 The '--compress-slow' option still exists to `wimlib-imagex optimize',
152 but its new behavior is to tweak the new LZX compressor even more to
153 produce an even better compression ratio at the cost of more time spent
156 `wimlib-imagex optimize' now supports the '--compress=TYPE' option,
157 which recompresses the WIM file using the specified compression TYPE.
158 The new library API function used for this is
159 wimlib_set_output_compression_type().
161 Added the wimlib_get_xml_data() function to allow library clients to
162 easily retrieve the raw XML data from a WIM file if needed.
164 Fixed a bug that could cause an error code to be incorrectly returned
165 when writing XML data containing a <WINDOWS> element.
167 Mounted WIM images will now correctly show the default file stream even
168 if appears in the alternate data stream entries of the corresponding WIM
172 Added a new experimental LZX compressor which can be enabled by passing
173 '--compress-slow' to `wimlib-imagex capture' or `wimlib-imagex
174 optimize'. (The latter is only applicable if the WIM is already
175 LZX-compressed and the '--recompress' option is also given.) The
176 experimental compressor is much slower but compresses the data slightly
177 more --- currently usually to within a fraction of a percent of the
178 results from WIMGAPI/ImageX.
180 A workaround has been added for compatibility with versions of WinPE
181 that interpret alternate data stream entries in the boot WIM
184 An alignment bug that caused a crash in the LZX decompressor on some
187 wimlib now attempts to clear the WIM_HDR_FLAG_WRITE_IN_PROGRESS flag in
188 the WIM header when restoring the previous state of a WIM it failed to
191 Added a workaround to avoid an access denied error on Windows when
192 replacing a WIM file that another process has opened.
195 wimlib can now open WinPE WIMs from WAIK v2.1, which had a quirk that
196 needed to be handled.
198 A bug in the interpretation of negative IMAGE indices in the
199 --update-of=[WIMFILE:]IMAGE option to `wimlib-imagex capture' and
200 `wimlib-imagex append' has been fixed.
202 A workaround has been added to successfully apply security descriptors
203 with empty DACLs when the NTFS-3g apply mode is being used with NTFS-3g
204 2013.1.13 or earlier.
206 `wimlib-imagex capture' can now accept the '--delta-from' option
210 Added support for "pipable" WIMs. Pipable WIMs allow capturing images
211 to standard output and applying images from standard input, but they are
212 not compatible with Microsoft's software and are not created by default.
213 See the documentation for --pipable flag of `wimlib-imagex capture' for
216 To better support incremental backups, added support for declaring an
217 image as a modified form of another image. See the documentation for
218 the '--update-of' option of `wimlib-imagex append' and `wimlib-imagex
221 Added supported for "delta" WIMs. See the documentation for the
222 '--delta-from' option of `wimlib-imagex capture'.
224 The library support for managing split WIMs has been changed to support
225 other arrangements, such as delta WIMs, and be easier to use. This
226 change is visible in `wimlib-imagex', which also can now accept the
227 '--ref' option multiple times, and also now supports "delta" WIMs as
230 wimlib now preserves WIM integrity tables by default, even if
231 WIMLIB_WRITE_FLAG_CHECK_INTEGRITY is not specified. This changes the
232 behavior of `wimlib-imagex' whenever the WIM being operated on contains
233 an integrity table and the '--check' option is not specified.
235 `wimlib-imagex capture' now creates LZX-compressed WIMs by default
236 (when --compress is not specified). This provides the best compression
237 ratio by default, which is usually what is desired, at a cost of some
240 `wimlib-imagex' now supports being invoked as wimCOMMAND, where COMMAND
241 is the command as in `wimlib-imagex COMMAND'; for example, it can be
242 invoked as `wimapply' as an alternative to `wimlib-imagex apply'. The
243 appropriate hard links are created in UNIX installations of
244 `wimlib-imagex', while for the Windows distribution of `wimlib-imagex',
245 batch files that emulate this behavior are generated.
247 Security descriptors are now extracted correctly on Windows.
249 Fixed archiving DOS names in NTFS-3g capture mode.
251 The extraction code has been rewritten and it will now be easier to
252 support new features on all supported backends (currently Win32, UNIX,
253 and NTFS-3g). For example, hard-linked extraction mode (--hardlink) is
254 now supported on all backends, not just UNIX.
256 `mkwinpeimg' now supports grabbing files from the WAIK supplement rather
257 than the WAIK itself.
259 wimlib_global_init() now, by default, attempts to acquire additional
260 privileges on Windows, so library clients need not do this.
262 This update bumps the shared library version number up to 9, since it is
263 not binary compatibible with previous releases.
266 Fixed bug in `wimlib-imagex export' that made it impossible to export an
267 image from a WIM that is readonly at the filesystem level.
269 Return error code rather than segfaulting when trying to list files from
270 a non-first part of a split WIM.
272 Joining a WIM will now preserve the RP_FIX and READONLY flags.
275 On Windows, paths given to wimlib-imagex are now treated case
278 Improved behavior regarding invalid filenames; in particular, on
279 Windows, wimlib-imagex will, when extracting, now omit (with an option
280 to override this default) filenames differing only in case, or filenames
281 containing characters not valid on Windows.
283 On Windows, wimlib now supports capturing and extracting long paths
284 (longer than the so-called MAX_PATH).
286 On Windows, `wimlib-imagex update' now acquires proper privileges when
287 running as an Administrator.
289 `wimlib-imagex update' will now complain if no image is specified when
290 trying to update a multi-image WIM.
292 `wimlib-imagex update' now supports specifying a single update command
293 directly on the command line using the --command option.
295 wimlib-imagex will now choose different units for progress messages,
296 depending on the amount of data that needs to be processed.
298 `wimlib-imagex append' will now generate a unique WIM image name if no
299 name is specified and the defaulted name already exists in the WIM.
301 wimlib now allows you to create unnamed WIM images, which can then only
302 be referred to by index.
304 wimlib now allows you to explicitly declare you want write access to a
305 WIM by providing the WIMLIB_OPEN_FLAG_WRITE_ACCESS flag to
308 wimlib now respects the WIM_HDR_FLAG_READONLY flag when set in the WIM
311 Progress callbacks have been added to wimlib's wimlib_update_image()
314 Added wimlib_get_wim_info(), wimlib_set_wim_info(),
315 wimlib_iterate_dir_tree(), and wimlib_iterate_lookup_table() functions
318 NTFS-3g capture now only warns about two conditions previously treated
321 Fixed a couple issues with using wimlib-imagex on UDF filesystems on
324 wimlib now correctly detects and returns an error when reading a WIM
325 image with a cyclic directory structure. (Fun fact: such a WIM will
326 crash Microsoft's software.)
329 Added new "extract" and "update" subcommands to wimlib-imagex, along
330 with associated APIs in the library. These commands are intended mainly
331 for Windows use but can be used on UNIX as well.
333 Many documentation improvements.
335 Fixed a bug in the Windows build where relative symbolic links were not
336 captured in reparse-point fixup mode.
338 Fixed a bug in the Windows build where file handles were left open to
339 the WIM file, causing `wimlib_imagex optimize' to fail in some cases.
341 Fixed a bug in the Windows build of wimlib-imagex where globbing
342 split-WIM parts could cause the program to crash.
344 Fixed a bug where the creation time of WIM images would be shown instead
345 of the last modification time.
347 With the Windows build it is now possible to restore a WIM containing
348 symbolic links as a non-Administrator; however you will receive warnings
349 about not being able to extract the symbolic links.
352 Capturing a WIM image should now be significantly faster in most cases
353 due to improved use of the operating system's cache and avoiding reading
354 files twice whenever possible.
356 The Windows build should now work on Windows XP.
358 The Windows build now supports capturing and restoring hidden,
359 compressed, sparse, and encrypted files.
361 The Windows build now supports capturing and applying WIM images from
362 filesystems other than NTFS (with some reduced functionality).
364 The Windows build now extracts short names correctly.
366 Added support for "reparse-point" fixups (i.e. fixing up of symbolic
367 links). See docs for --rpfix and --norpfix flags of `wimlib-imagex
368 capture' and `wimlib-imagex apply'.
370 The performance of splitting and joining WIMs should be slightly
373 The LZX and XPRESS compression and decompression functions are now
374 exported from the library.
377 Improvements and bugfixes for the Windows build.
379 Added --strict-acls options.
381 Fixed the way that wimlib determines the order of images in the WIM.
384 Since wimlib can now be used on Windows, wimlib's implementation of
385 ImageX has been renamed to wimlib-imagex to avoid confusion with
386 Microsoft's implementation of ImageX, which would have the same file
387 name ("imagex.exe"). If you really don't like this you can pass the
388 --with-imagex-progname option to `configure' to choose a different name,
389 or even simply rename the binary yourself (but the former way will
390 configure the man pages to use the chosen name).
392 Various bugs fixed in the Windows build. Mainly to do with capturing
393 and restoring alternate data streams correctly in weird cases, and
394 requesting the correct privileges when opening files. Also added the
395 --noacls options to wimlib-imagex capture, append, and apply.
397 Windows build again: FindFirstStreamW() and FindNextStreamW() are now
398 dynamically loaded, so this may make the library compatible with Windows
399 XP (however, there may still be other problems).
402 Added experimental support for native Windows builds. Binaries can be
403 downloaded from the SourceForge page.
405 --source-list option added to `imagex capture' and `imagex append'.
407 Better support for different character encodings.
410 Storing UNIX file owners, groups, and modes in WIM images is now
411 possible using `imagex capture' with the --unix-data flag.
413 Minor bug fixes and documentation fixes.
416 NTFS capture: Fixed capturing duplicate reparse points.
418 NTFS capture: Capture first unnamed stream if there are more than one
419 (print warning instead of error).
421 Allow multiple test cases to execute concurrently (e.g. make -j2 check).
424 Added --arch switch to mkwinpeimg script to support getting AMD64 WinPE
427 Update to work with ntfs-3g version 2013.1.13.
430 Fixed truncating file to shorter but non-zero length on read-write
433 Various code cleanups and minor documentation fixes.
436 LZX and XPRESS decompression have received some additional optimizations
437 and should now be even faster. (Although, they were already pretty
438 fast--- much faster than typical I/O speeds.)
440 Fixed a bug introduced in v1.2.1 that would cause a directory tree
441 containing hard links to be captured incorrectly in some cases.
444 By default, unmounting a read-write mounted WIM with 'imagex unmount
445 --commit' will now change the WIM in-place without needing to write the
446 entire WIM again. Use 'imagex unmount --commit --rebuild' to get the
449 'imagex unmount' no longer has a hard-coded limit of 10 minutes to wait
450 for a response from the daemon servicing the mounted WIM. Instead,
451 every second 'imagex unmount' will check if the daemon is still alive,
452 and keep waiting if so, otherwise terminate with an error.
454 'imagex unmount --commit' on a read-write mounted WIM will now print
455 progress information regarding the writing of new or modified streams
456 the WIM, just like when capturing or appending a WIM.
458 A small change has been made to XPRESS compression and it should improve
459 the compression ratio slightly.
461 A change was made that may improve performance slightly when applying a
462 WIM image to a NTFS volume.
464 Microsoft has managed to introduce even more bugs into their software,
465 and now the WIMs for Windows 8 have incorrect (too low) reference counts
466 for some streams. This is unsafe because such streams can be removed
467 when they are in actuality still referenced in the WIM (perhaps by a
468 different image). wimlib will now work around this problem by fixing
469 the stream reference counts. This is only done when wimlib_delete_image() is
470 called ('imagex delete') or when wimlib_mount_image() is called with
471 WIMLIB_MOUNT_FLAG_READWRITE ('imagex mountrw'). Please note that this
472 requires reading the metadata for all images in the WIM, so this will
473 make these operations noticably slower on WIMs with multiple images.
475 Various other bugfixes.
478 Appending images to a WIM is now be done by default without re-building
479 the whole WIM. Use the --rebuild flag to get the old behavior (which
480 was to re-build the entire WIM when a new image is appended).
482 A new command `imagex optimize' is now available to manually re-build a
483 WIM that has wasted space due to repeated appends.
485 Progress information has been improved, and now arbitrary callback
486 functions can be used to show the progress of a WIM operation.
488 A possible bug with changing the bootable image of a WIM was fixed.
490 Some advisory locking is now done to prevent two processes from
491 modifying a WIM at the same time (but only in some cases). For example,
492 you cannot mount two images from a WIM read-write at the same time.
494 Some functions have been reorganized:
495 * wimlib_mount() renamed to wimlib_mount_image().
496 * wimlib_unmount() renamed to wimlib_unmount_image().
497 * wimlib_overwrite_xml_and_header() removed as
498 wimlib_overwrite() suffices now.
499 * wimlib_apply_image_to_ntfs_volume() removed as
500 wimlib_extract_image() suffices now.
501 * wimlib_add_image_from_ntfs_volume() removed as
502 * wimlib_add_image() suffices now.
504 Previously, the soname of libwim.so has been 0.0.0, despite many
505 interface changes. The soname is now updated to 1.0.0 and will now be
506 updated each release.
509 Resources will now be compressed using multiple threads by default.
510 (This applies to `imagex capture', `imagex append', and `imagex
513 Some performance improvements in mounted WIMs.
515 More progress information is shown when capturing a WIM.
518 Lots of minor fixes, code cleanups, and some documentation updates.
519 Nothing in particular is really noteworthy.
522 LZX and XPRESS compression improvements.
524 Fixed calculation of Directory Count, File Count, Total Bytes, and Hard
525 Link Bytes of the WIM.
528 Fixed bug when capturing NTFS file with multiple named data streams.
530 Internally, we are now using inode structures, even though these don't
531 appear literally in the WIM file. This simplifies some of the code
532 (mainly for WIM mounting) and likely fixed a few problems, although it
536 Fixed problem when exporting images from XPRESS to LZX compressed WIM or
540 Enough changes to call it version 1.0.0!
542 Capturing a WIM directly from a NTFS volume, and applying a WIM directly
543 to a NTFS volume, is now supported.
545 Hard links and symbolic links have much improved support. They are
546 supported for WIM capture, WIM application, and mounted WIMs (you can
547 even make them on read-write mounted WIMs).
549 Alternate data streams are now supported on mounted WIMs through an
550 xattr or a Windows-style stream interface. Also they are supported when
551 capturing a WIM from NTFS or applying a WIM to NTFS.
553 Split WIMs are better supported. You may now apply an image directly
554 from a split WIM, mount an image from a split WIM read-only, or export
555 an image from a split WIM.
557 Using a capture configuration file is now supported (but not fully yet).
559 SHA1 message digests are checked in more places, so we can make sure
560 applied and captured data is correct.
562 Man pages have been updated and consolidated.
565 Fixed segfault when unmounting read-only WIM.
568 Support for joining and splitting WIMs.
569 Also, security data is now preserved by default.
572 Can now build with older gcc and system headers, like on CentOS 5.
575 Fixed bug that made it impossible to overwrite files in read-write
579 Write byte-order mark before WIM XML data. (imagex.exe requires this to