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