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