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 The format of UNIX data has been changed. If you captured any WIMs with
17 the --unix-data option, to upgrade them you'll need to apply them with
18 --unix-data using wimlib v1.6.2, then re-capture them with --unix-data
21 Removed the --hardlink and --symlink options to wimapply, since I don't
22 think they are too useful and they got in the way of improving the code.
24 WIMs will now retain their GUIDs when rebuilt (e.g. with wimoptimize).
26 The 'mkwinpeimg' script now supports writing the ISO image to standard
29 On Windows, sparse file attributes are no longer set on extracted files.
31 The shared library version has been bumped up. The main
32 incompatibilities are:
34 - WIMLIB_COMPRESSION_TYPE_XPRESS is now 1 and
35 WIMLIB_COMPRESSION_TYPE_LZX is now 2 (so it's the same as
38 - 'struct wimlib_capture_config' has been removed. The library
39 now takes the path to the configuration file directly. This
40 affects wimlib_add_image(), wimlib_add_image_multisource(),
41 and wimlib_update_image(). However no code changes are
42 necessary if a NULL configuration was being used.
44 - Removed deprecated functions: some (de)compression functions,
45 wimlib_extract_files(), and wimlib_print_metadata().
47 - Removed extraction flags: WIMLIB_EXTRACT_FLAG_HARDLINK,
48 WIMLIB_EXTRACT_FLAG_SYMLINK, and
49 WIMLIB_EXTRACT_FLAG_FILE_ORDER.
51 - Removed progress messages:
52 WIMLIB_PROGRESS_MSG_APPLY_TIMESTAMPS,
53 WIMLIB_PROGRESS_MSG_EXTRACT_DIR_STRUCTURE_BEGIN,
54 WIMLIB_PROGRESS_MSG_EXTRACT_DIR_STRUCTURE_END.
56 - WIM paths passed to progress functions now have a leading
60 Case-insensitive comparisons of strings (e.g. filenames) containing
61 UTF-16 codepoints above 32767 are now done correctly.
63 Fixed build failure on Mac OS X.
65 wimunmount now provides the '--new-image' option to cause changes to a
66 read-write mounted image to be committed as a new image rather than as
67 an update of the mounted image. (The corresponding new library flag is
68 WIMLIB_UNMOUNT_FLAG_NEW_IMAGE.)
70 The LZMS ("recovery") compression chunk size, or "dictionary size", may
71 now be up to 1 GiB (1,073,741,824 bytes).
73 The performance of LZX ("maximum") and LZMS ("recovery") compression
74 with large chunk sizes has been slightly improved.
77 Stored files with size exactly 4 GiB (4,294,967,296 bytes) are now
78 decompressed correctly.
80 Fixed a bug in the LZX compressor introduced in v1.5.3. The bug
81 occurred in an unlikely case, and due to validity checks it did not
82 affect successfully created archives.
84 Fixed a minor compatibility issue with the LZMS compressor and
85 decompressor. This is *not* the default compression type and was only
86 introduced in v1.6.0. In the unlikely event that you created an
87 LZMS-compressed WIM with v1.6.0 and a checksum error is reported when
88 applying it with v1.6.1, decompress it with v1.6.0 then compress it with
91 Memory usage for LZMS and LZX compression has been decreased.
93 wimextract now allows wildcard characters in paths specified on the
94 command line. Also, the '--strict-wildcards' option has been removed
95 and replaced with the inverse option '--nullglob'. See the
96 documentation for wimextract for more details and changes.
98 The wimlib_extract_files() function is now considered deprecated in
99 favor of wimlib_extract_paths().
101 Fixed more permissions problems when extracting files on Windows.
103 A new '--no-attributes' option has been added to wimapply and
104 wimextract. The library flag is WIMLIB_EXTRACT_FLAG_NO_ATTRIBUTES.
106 The default chunk size is now set correctly when changing the
107 compression type of a WIM, for example with 'wimoptimize'.
109 The '--metadata' option to wiminfo has been replaced with the
110 '--detailed' option to wimdir.
112 In relevant wimlib-imagex commands, '--solid' may now be used as an
113 alias for '--pack-streams'.
116 Support for extracting and updating the new version 3584 WIMs has been
117 added. These WIMs typically pack many streams ("files") together into a
118 single compressed resource, thereby saving space. This degrades the
119 performance of random access (such as that which occurs on a mounted
120 image), but optimizations have been implemented for extraction. These
121 new WIM files also typically use a new compression format (LZMS), which
122 is similar to LZMA and can offer a better compression ratio than LZX.
123 These new WIM files can be created using `wimcapture' with
124 the '--compress=lzms --pack-streams' options. Note: this new WIM format
125 is used by the Windows 8 web downloader, but important segments of the
126 raw '.esd' files are encrypted, so wimlib will not be able to extract
127 such files until they are first decrypted.
129 wimlib now supports extracting files and directories from a WIM image
130 based on a "listfile" that itself contains the list of paths to extract.
131 For `wimextract', the syntax is to specify @LISTFILE instead of a PATH,
132 and for the library itself, the new APIs are wimlib_extract_pathlist()
133 and wimlib_extract_paths(). Path globs containing wildcard characters
136 For searching WIM files, wimlib now has configurable case sensitivity.
137 The default on Windows is still case-insensitive and the default on
138 UNIX-like systems is still case-sensitive, but this can be overridden
139 on either platform through flags to wimlib_global_init(). For
140 `wimlib-imagex', the environmental variable WIMLIB_IMAGEX_IGNORE_CASE
141 can be set to 1 or 0 for case-insensitive or case-sensitive behavior,
144 Support for compression chunk sizes greater than the default of 32768
145 bytes has been added. A larger chunk size typically results in a better
146 compression ratio. However, the MS implementation is seemingly not
147 compatible with all chunk sizes, especially for LZX compression, so the
148 defaults remain unchanged, with the exception of the new LZMS-compressed
149 WIMs, which use a larger chunk size by default.
151 The compression/decompression API exported by wimlib has been changed.
152 Now one set of functions handles all supported compression formats.
154 `wimcapture' and `wimappend' will now display the progress of scanning
155 the directory tree to capture, in addition to the progress of writing
156 data to the WIM. The '--verbose' option no longer does anything. The
157 library API change for this is the addition of several members to
158 `struct wimlib_progress_info_scan' available to progress callbacks.
160 `mkwinpeimg' now correctly handles the '--start-script' option when the
161 start script is not in the working directory.
163 Sequential extraction, previously requested by using
164 WIMLIB_EXTRACT_FLAG_SEQUENTIAL, is now the default.
165 WIMLIB_EXTRACT_FLAG_FILE_ORDER can be used to get the old default
166 behavior (extract in file order).
169 The new LZX compressor added in v1.5.2 has been improved and is now
170 enabled by default, except when `wimcapture' or `wimappend' is run
171 *without* the '--compress' option, in which case the faster LZX
172 compressor is used (the same as before). This behavior is reasonably
173 consistent with ImageX which actually uses "fast" (XPRESS) compression
174 by default. In those cases, use '--compress=maximum' to explicitly
175 capture a WIM image using the new (slower but better) LZX compressor.
177 The '--compress-slow' option still exists to `wimlib-imagex optimize',
178 but its new behavior is to tweak the new LZX compressor even more to
179 produce an even better compression ratio at the cost of more time spent
182 `wimlib-imagex optimize' now supports the '--compress=TYPE' option,
183 which recompresses the WIM file using the specified compression TYPE.
184 The new library API function used for this is
185 wimlib_set_output_compression_type().
187 Added the wimlib_get_xml_data() function to allow library clients to
188 easily retrieve the raw XML data from a WIM file if needed.
190 Fixed a bug that could cause an error code to be incorrectly returned
191 when writing XML data containing a <WINDOWS> element.
193 Mounted WIM images will now correctly show the default file stream even
194 if appears in the alternate data stream entries of the corresponding WIM
198 Added a new experimental LZX compressor which can be enabled by passing
199 '--compress-slow' to `wimlib-imagex capture' or `wimlib-imagex
200 optimize'. (The latter is only applicable if the WIM is already
201 LZX-compressed and the '--recompress' option is also given.) The
202 experimental compressor is much slower but compresses the data slightly
203 more --- currently usually to within a fraction of a percent of the
204 results from WIMGAPI/ImageX.
206 A workaround has been added for compatibility with versions of WinPE
207 that interpret alternate data stream entries in the boot WIM
210 An alignment bug that caused a crash in the LZX decompressor on some
213 wimlib now attempts to clear the WIM_HDR_FLAG_WRITE_IN_PROGRESS flag in
214 the WIM header when restoring the previous state of a WIM it failed to
217 Added a workaround to avoid an access denied error on Windows when
218 replacing a WIM file that another process has opened.
221 wimlib can now open WinPE WIMs from WAIK v2.1, which had a quirk that
222 needed to be handled.
224 A bug in the interpretation of negative IMAGE indices in the
225 --update-of=[WIMFILE:]IMAGE option to `wimlib-imagex capture' and
226 `wimlib-imagex append' has been fixed.
228 A workaround has been added to successfully apply security descriptors
229 with empty DACLs when the NTFS-3g apply mode is being used with NTFS-3g
230 2013.1.13 or earlier.
232 `wimlib-imagex capture' can now accept the '--delta-from' option
236 Added support for "pipable" WIMs. Pipable WIMs allow capturing images
237 to standard output and applying images from standard input, but they are
238 not compatible with Microsoft's software and are not created by default.
239 See the documentation for --pipable flag of `wimlib-imagex capture' for
242 To better support incremental backups, added support for declaring an
243 image as a modified form of another image. See the documentation for
244 the '--update-of' option of `wimlib-imagex append' and `wimlib-imagex
247 Added supported for "delta" WIMs. See the documentation for the
248 '--delta-from' option of `wimlib-imagex capture'.
250 The library support for managing split WIMs has been changed to support
251 other arrangements, such as delta WIMs, and be easier to use. This
252 change is visible in `wimlib-imagex', which also can now accept the
253 '--ref' option multiple times, and also now supports "delta" WIMs as
256 wimlib now preserves WIM integrity tables by default, even if
257 WIMLIB_WRITE_FLAG_CHECK_INTEGRITY is not specified. This changes the
258 behavior of `wimlib-imagex' whenever the WIM being operated on contains
259 an integrity table and the '--check' option is not specified.
261 `wimlib-imagex capture' now creates LZX-compressed WIMs by default
262 (when --compress is not specified). This provides the best compression
263 ratio by default, which is usually what is desired, at a cost of some
266 `wimlib-imagex' now supports being invoked as wimCOMMAND, where COMMAND
267 is the command as in `wimlib-imagex COMMAND'; for example, it can be
268 invoked as `wimapply' as an alternative to `wimlib-imagex apply'. The
269 appropriate hard links are created in UNIX installations of
270 `wimlib-imagex', while for the Windows distribution of `wimlib-imagex',
271 batch files that emulate this behavior are generated.
273 Security descriptors are now extracted correctly on Windows.
275 Fixed archiving DOS names in NTFS-3g capture mode.
277 The extraction code has been rewritten and it will now be easier to
278 support new features on all supported backends (currently Win32, UNIX,
279 and NTFS-3g). For example, hard-linked extraction mode (--hardlink) is
280 now supported on all backends, not just UNIX.
282 `mkwinpeimg' now supports grabbing files from the WAIK supplement rather
283 than the WAIK itself.
285 wimlib_global_init() now, by default, attempts to acquire additional
286 privileges on Windows, so library clients need not do this.
288 This update bumps the shared library version number up to 9, since it is
289 not binary compatibible with previous releases.
292 Fixed bug in `wimlib-imagex export' that made it impossible to export an
293 image from a WIM that is readonly at the filesystem level.
295 Return error code rather than segfaulting when trying to list files from
296 a non-first part of a split WIM.
298 Joining a WIM will now preserve the RP_FIX and READONLY flags.
301 On Windows, paths given to wimlib-imagex are now treated case
304 Improved behavior regarding invalid filenames; in particular, on
305 Windows, wimlib-imagex will, when extracting, now omit (with an option
306 to override this default) filenames differing only in case, or filenames
307 containing characters not valid on Windows.
309 On Windows, wimlib now supports capturing and extracting long paths
310 (longer than the so-called MAX_PATH).
312 On Windows, `wimlib-imagex update' now acquires proper privileges when
313 running as an Administrator.
315 `wimlib-imagex update' will now complain if no image is specified when
316 trying to update a multi-image WIM.
318 `wimlib-imagex update' now supports specifying a single update command
319 directly on the command line using the --command option.
321 wimlib-imagex will now choose different units for progress messages,
322 depending on the amount of data that needs to be processed.
324 `wimlib-imagex append' will now generate a unique WIM image name if no
325 name is specified and the defaulted name already exists in the WIM.
327 wimlib now allows you to create unnamed WIM images, which can then only
328 be referred to by index.
330 wimlib now allows you to explicitly declare you want write access to a
331 WIM by providing the WIMLIB_OPEN_FLAG_WRITE_ACCESS flag to
334 wimlib now respects the WIM_HDR_FLAG_READONLY flag when set in the WIM
337 Progress callbacks have been added to wimlib's wimlib_update_image()
340 Added wimlib_get_wim_info(), wimlib_set_wim_info(),
341 wimlib_iterate_dir_tree(), and wimlib_iterate_lookup_table() functions
344 NTFS-3g capture now only warns about two conditions previously treated
347 Fixed a couple issues with using wimlib-imagex on UDF filesystems on
350 wimlib now correctly detects and returns an error when reading a WIM
351 image with a cyclic directory structure. (Fun fact: such a WIM will
352 crash Microsoft's software.)
355 Added new "extract" and "update" subcommands to wimlib-imagex, along
356 with associated APIs in the library. These commands are intended mainly
357 for Windows use but can be used on UNIX as well.
359 Many documentation improvements.
361 Fixed a bug in the Windows build where relative symbolic links were not
362 captured in reparse-point fixup mode.
364 Fixed a bug in the Windows build where file handles were left open to
365 the WIM file, causing `wimlib_imagex optimize' to fail in some cases.
367 Fixed a bug in the Windows build of wimlib-imagex where globbing
368 split-WIM parts could cause the program to crash.
370 Fixed a bug where the creation time of WIM images would be shown instead
371 of the last modification time.
373 With the Windows build it is now possible to restore a WIM containing
374 symbolic links as a non-Administrator; however you will receive warnings
375 about not being able to extract the symbolic links.
378 Capturing a WIM image should now be significantly faster in most cases
379 due to improved use of the operating system's cache and avoiding reading
380 files twice whenever possible.
382 The Windows build should now work on Windows XP.
384 The Windows build now supports capturing and restoring hidden,
385 compressed, sparse, and encrypted files.
387 The Windows build now supports capturing and applying WIM images from
388 filesystems other than NTFS (with some reduced functionality).
390 The Windows build now extracts short names correctly.
392 Added support for "reparse-point" fixups (i.e. fixing up of symbolic
393 links). See docs for --rpfix and --norpfix flags of `wimlib-imagex
394 capture' and `wimlib-imagex apply'.
396 The performance of splitting and joining WIMs should be slightly
399 The LZX and XPRESS compression and decompression functions are now
400 exported from the library.
403 Improvements and bugfixes for the Windows build.
405 Added --strict-acls options.
407 Fixed the way that wimlib determines the order of images in the WIM.
410 Since wimlib can now be used on Windows, wimlib's implementation of
411 ImageX has been renamed to wimlib-imagex to avoid confusion with
412 Microsoft's implementation of ImageX, which would have the same file
413 name ("imagex.exe"). If you really don't like this you can pass the
414 --with-imagex-progname option to `configure' to choose a different name,
415 or even simply rename the binary yourself (but the former way will
416 configure the man pages to use the chosen name).
418 Various bugs fixed in the Windows build. Mainly to do with capturing
419 and restoring alternate data streams correctly in weird cases, and
420 requesting the correct privileges when opening files. Also added the
421 --noacls options to wimlib-imagex capture, append, and apply.
423 Windows build again: FindFirstStreamW() and FindNextStreamW() are now
424 dynamically loaded, so this may make the library compatible with Windows
425 XP (however, there may still be other problems).
428 Added experimental support for native Windows builds. Binaries can be
429 downloaded from the SourceForge page.
431 --source-list option added to `imagex capture' and `imagex append'.
433 Better support for different character encodings.
436 Storing UNIX file owners, groups, and modes in WIM images is now
437 possible using `imagex capture' with the --unix-data flag.
439 Minor bug fixes and documentation fixes.
442 NTFS capture: Fixed capturing duplicate reparse points.
444 NTFS capture: Capture first unnamed stream if there are more than one
445 (print warning instead of error).
447 Allow multiple test cases to execute concurrently (e.g. make -j2 check).
450 Added --arch switch to mkwinpeimg script to support getting AMD64 WinPE
453 Update to work with ntfs-3g version 2013.1.13.
456 Fixed truncating file to shorter but non-zero length on read-write
459 Various code cleanups and minor documentation fixes.
462 LZX and XPRESS decompression have received some additional optimizations
463 and should now be even faster. (Although, they were already pretty
464 fast--- much faster than typical I/O speeds.)
466 Fixed a bug introduced in v1.2.1 that would cause a directory tree
467 containing hard links to be captured incorrectly in some cases.
470 By default, unmounting a read-write mounted WIM with 'imagex unmount
471 --commit' will now change the WIM in-place without needing to write the
472 entire WIM again. Use 'imagex unmount --commit --rebuild' to get the
475 'imagex unmount' no longer has a hard-coded limit of 10 minutes to wait
476 for a response from the daemon servicing the mounted WIM. Instead,
477 every second 'imagex unmount' will check if the daemon is still alive,
478 and keep waiting if so, otherwise terminate with an error.
480 'imagex unmount --commit' on a read-write mounted WIM will now print
481 progress information regarding the writing of new or modified streams
482 the WIM, just like when capturing or appending a WIM.
484 A small change has been made to XPRESS compression and it should improve
485 the compression ratio slightly.
487 A change was made that may improve performance slightly when applying a
488 WIM image to a NTFS volume.
490 Microsoft has managed to introduce even more bugs into their software,
491 and now the WIMs for Windows 8 have incorrect (too low) reference counts
492 for some streams. This is unsafe because such streams can be removed
493 when they are in actuality still referenced in the WIM (perhaps by a
494 different image). wimlib will now work around this problem by fixing
495 the stream reference counts. This is only done when wimlib_delete_image() is
496 called ('imagex delete') or when wimlib_mount_image() is called with
497 WIMLIB_MOUNT_FLAG_READWRITE ('imagex mountrw'). Please note that this
498 requires reading the metadata for all images in the WIM, so this will
499 make these operations noticably slower on WIMs with multiple images.
501 Various other bugfixes.
504 Appending images to a WIM is now be done by default without re-building
505 the whole WIM. Use the --rebuild flag to get the old behavior (which
506 was to re-build the entire WIM when a new image is appended).
508 A new command `imagex optimize' is now available to manually re-build a
509 WIM that has wasted space due to repeated appends.
511 Progress information has been improved, and now arbitrary callback
512 functions can be used to show the progress of a WIM operation.
514 A possible bug with changing the bootable image of a WIM was fixed.
516 Some advisory locking is now done to prevent two processes from
517 modifying a WIM at the same time (but only in some cases). For example,
518 you cannot mount two images from a WIM read-write at the same time.
520 Some functions have been reorganized:
521 * wimlib_mount() renamed to wimlib_mount_image().
522 * wimlib_unmount() renamed to wimlib_unmount_image().
523 * wimlib_overwrite_xml_and_header() removed as
524 wimlib_overwrite() suffices now.
525 * wimlib_apply_image_to_ntfs_volume() removed as
526 wimlib_extract_image() suffices now.
527 * wimlib_add_image_from_ntfs_volume() removed as
528 * wimlib_add_image() suffices now.
530 Previously, the soname of libwim.so has been 0.0.0, despite many
531 interface changes. The soname is now updated to 1.0.0 and will now be
532 updated each release.
535 Resources will now be compressed using multiple threads by default.
536 (This applies to `imagex capture', `imagex append', and `imagex
539 Some performance improvements in mounted WIMs.
541 More progress information is shown when capturing a WIM.
544 Lots of minor fixes, code cleanups, and some documentation updates.
545 Nothing in particular is really noteworthy.
548 LZX and XPRESS compression improvements.
550 Fixed calculation of Directory Count, File Count, Total Bytes, and Hard
551 Link Bytes of the WIM.
554 Fixed bug when capturing NTFS file with multiple named data streams.
556 Internally, we are now using inode structures, even though these don't
557 appear literally in the WIM file. This simplifies some of the code
558 (mainly for WIM mounting) and likely fixed a few problems, although it
562 Fixed problem when exporting images from XPRESS to LZX compressed WIM or
566 Enough changes to call it version 1.0.0!
568 Capturing a WIM directly from a NTFS volume, and applying a WIM directly
569 to a NTFS volume, is now supported.
571 Hard links and symbolic links have much improved support. They are
572 supported for WIM capture, WIM application, and mounted WIMs (you can
573 even make them on read-write mounted WIMs).
575 Alternate data streams are now supported on mounted WIMs through an
576 xattr or a Windows-style stream interface. Also they are supported when
577 capturing a WIM from NTFS or applying a WIM to NTFS.
579 Split WIMs are better supported. You may now apply an image directly
580 from a split WIM, mount an image from a split WIM read-only, or export
581 an image from a split WIM.
583 Using a capture configuration file is now supported (but not fully yet).
585 SHA1 message digests are checked in more places, so we can make sure
586 applied and captured data is correct.
588 Man pages have been updated and consolidated.
591 Fixed segfault when unmounting read-only WIM.
594 Support for joining and splitting WIMs.
595 Also, security data is now preserved by default.
598 Can now build with older gcc and system headers, like on CentOS 5.
601 Fixed bug that made it impossible to overwrite files in read-write
605 Write byte-order mark before WIM XML data. (imagex.exe requires this to