1 Only the most important changes more recent than version 0.6 are noted here.
4 Case-insensitive comparisons of strings (e.g. filenames) containing
5 UTF-16 codepoints above 32767 are now done correctly.
7 Fixed build failure on Mac OS X.
9 The LZMS compression chunk size, or "dictionary size", may now be up to
12 The performance of LZX and LZMS compression with large chunk sizes has
13 been slightly improved.
16 Stored files with size exactly 4 GiB (4,294,967,296 bytes) are now
17 decompressed correctly.
19 Fixed a bug in the LZX compressor introduced in v1.5.3. The bug
20 occurred in an unlikely case, and due to validity checks it did not
21 affect successfully created archives.
23 Fixed a minor compatibility issue with the LZMS compressor and
24 decompressor. This is *not* the default compression type and was only
25 introduced in v1.6.0. In the unlikely event that you created an
26 LZMS-compressed WIM with v1.6.0 and a checksum error is reported when
27 applying it with v1.6.1, decompress it with v1.6.0 then compress it with
30 Memory usage for LZMS and LZX compression has been decreased.
32 wimextract now allows wildcard characters in paths specified on the
33 command line. Also, the '--strict-wildcards' option has been removed
34 and replaced with the inverse option '--nullglob'. See the
35 documentation for wimextract for more details and changes.
37 The wimlib_extract_files() function is now considered deprecated in
38 favor of wimlib_extract_paths().
40 Fixed more permissions problems when extracting files on Windows.
42 A new '--no-attributes' option has been added to wimapply and
43 wimextract. The library flag is WIMLIB_EXTRACT_FLAG_NO_ATTRIBUTES.
45 The default chunk size is now set correctly when changing the
46 compression type of a WIM, for example with 'wimoptimize'.
48 The '--metadata' option to wiminfo has been replaced with the
49 '--detailed' option to wimdir.
51 In relevant wimlib-imagex commands, '--solid' may now be used as an
52 alias for '--pack-streams'.
55 Support for extracting and updating the new version 3584 WIMs has been
56 added. These WIMs typically pack many streams ("files") together into a
57 single compressed resource, thereby saving space. This degrades the
58 performance of random access (such as that which occurs on a mounted
59 image), but optimizations have been implemented for extraction. These
60 new WIM files also typically use a new compression format (LZMS), which
61 is similar to LZMA and can offer a better compression ratio than LZX.
62 These new WIM files can be created using `wimcapture' with
63 the '--compress=lzms --pack-streams' options. Note: this new WIM format
64 is used by the Windows 8 web downloader, but important segments of the
65 raw '.esd' files are encrypted, so wimlib will not be able to extract
66 such files until they are first decrypted.
68 wimlib now supports extracting files and directories from a WIM image
69 based on a "listfile" that itself contains the list of paths to extract.
70 For `wimextract', the syntax is to specify @LISTFILE instead of a PATH,
71 and for the library itself, the new APIs are wimlib_extract_pathlist()
72 and wimlib_extract_paths(). Path globs containing wildcard characters
75 For searching WIM files, wimlib now has configurable case sensitivity.
76 The default on Windows is still case-insensitive and the default on
77 UNIX-like systems is still case-sensitive, but this can be overridden
78 on either platform through flags to wimlib_global_init(). For
79 `wimlib-imagex', the environmental variable WIMLIB_IMAGEX_IGNORE_CASE
80 can be set to 1 or 0 for case-insensitive or case-sensitive behavior,
83 Support for compression chunk sizes greater than the default of 32768
84 bytes has been added. A larger chunk size typically results in a better
85 compression ratio. However, the MS implementation is seemingly not
86 compatible with all chunk sizes, especially for LZX compression, so the
87 defaults remain unchanged, with the exception of the new LZMS-compressed
88 WIMs, which use a larger chunk size by default.
90 The compression/decompression API exported by wimlib has been changed.
91 Now one set of functions handles all supported compression formats.
93 `wimcapture' and `wimappend' will now display the progress of scanning
94 the directory tree to capture, in addition to the progress of writing
95 data to the WIM. The '--verbose' option no longer does anything. The
96 library API change for this is the addition of several members to
97 `struct wimlib_progress_info_scan' available to progress callbacks.
99 `mkwinpeimg' now correctly handles the '--start-script' option when the
100 start script is not in the working directory.
102 Sequential extraction, previously requested by using
103 WIMLIB_EXTRACT_FLAG_SEQUENTIAL, is now the default.
104 WIMLIB_EXTRACT_FLAG_FILE_ORDER can be used to get the old default
105 behavior (extract in file order).
108 The new LZX compressor added in v1.5.2 has been improved and is now
109 enabled by default, except when `wimcapture' or `wimappend' is run
110 *without* the '--compress' option, in which case the faster LZX
111 compressor is used (the same as before). This behavior is reasonably
112 consistent with ImageX which actually uses "fast" (XPRESS) compression
113 by default. In those cases, use '--compress=maximum' to explicitly
114 capture a WIM image using the new (slower but better) LZX compressor.
116 The '--compress-slow' option still exists to `wimlib-imagex optimize',
117 but its new behavior is to tweak the new LZX compressor even more to
118 produce an even better compression ratio at the cost of more time spent
121 `wimlib-imagex optimize' now supports the '--compress=TYPE' option,
122 which recompresses the WIM file using the specified compression TYPE.
123 The new library API function used for this is
124 wimlib_set_output_compression_type().
126 Added the wimlib_get_xml_data() function to allow library clients to
127 easily retrieve the raw XML data from a WIM file if needed.
129 Fixed a bug that could cause an error code to be incorrectly returned
130 when writing XML data containing a <WINDOWS> element.
132 Mounted WIM images will now correctly show the default file stream even
133 if appears in the alternate data stream entries of the corresponding WIM
137 Added a new experimental LZX compressor which can be enabled by passing
138 '--compress-slow' to `wimlib-imagex capture' or `wimlib-imagex
139 optimize'. (The latter is only applicable if the WIM is already
140 LZX-compressed and the '--recompress' option is also given.) The
141 experimental compressor is much slower but compresses the data slightly
142 more --- currently usually to within a fraction of a percent of the
143 results from WIMGAPI/ImageX.
145 A workaround has been added for compatibility with versions of WinPE
146 that interpret alternate data stream entries in the boot WIM
149 An alignment bug that caused a crash in the LZX decompressor on some
152 wimlib now attempts to clear the WIM_HDR_FLAG_WRITE_IN_PROGRESS flag in
153 the WIM header when restoring the previous state of a WIM it failed to
156 Added a workaround to avoid an access denied error on Windows when
157 replacing a WIM file that another process has opened.
160 wimlib can now open WinPE WIMs from WAIK v2.1, which had a quirk that
161 needed to be handled.
163 A bug in the interpretation of negative IMAGE indices in the
164 --update-of=[WIMFILE:]IMAGE option to `wimlib-imagex capture' and
165 `wimlib-imagex append' has been fixed.
167 A workaround has been added to successfully apply security descriptors
168 with empty DACLs when the NTFS-3g apply mode is being used with NTFS-3g
169 2013.1.13 or earlier.
171 `wimlib-imagex capture' can now accept the '--delta-from' option
175 Added support for "pipable" WIMs. Pipable WIMs allow capturing images
176 to standard output and applying images from standard input, but they are
177 not compatible with Microsoft's software and are not created by default.
178 See the documentation for --pipable flag of `wimlib-imagex capture' for
181 To better support incremental backups, added support for declaring an
182 image as a modified form of another image. See the documentation for
183 the '--update-of' option of `wimlib-imagex append' and `wimlib-imagex
186 Added supported for "delta" WIMs. See the documentation for the
187 '--delta-from' option of `wimlib-imagex capture'.
189 The library support for managing split WIMs has been changed to support
190 other arrangements, such as delta WIMs, and be easier to use. This
191 change is visible in `wimlib-imagex', which also can now accept the
192 '--ref' option multiple times, and also now supports "delta" WIMs as
195 wimlib now preserves WIM integrity tables by default, even if
196 WIMLIB_WRITE_FLAG_CHECK_INTEGRITY is not specified. This changes the
197 behavior of `wimlib-imagex' whenever the WIM being operated on contains
198 an integrity table and the '--check' option is not specified.
200 `wimlib-imagex capture' now creates LZX-compressed WIMs by default
201 (when --compress is not specified). This provides the best compression
202 ratio by default, which is usually what is desired, at a cost of some
205 `wimlib-imagex' now supports being invoked as wimCOMMAND, where COMMAND
206 is the command as in `wimlib-imagex COMMAND'; for example, it can be
207 invoked as `wimapply' as an alternative to `wimlib-imagex apply'. The
208 appropriate hard links are created in UNIX installations of
209 `wimlib-imagex', while for the Windows distribution of `wimlib-imagex',
210 batch files that emulate this behavior are generated.
212 Security descriptors are now extracted correctly on Windows.
214 Fixed archiving DOS names in NTFS-3g capture mode.
216 The extraction code has been rewritten and it will now be easier to
217 support new features on all supported backends (currently Win32, UNIX,
218 and NTFS-3g). For example, hard-linked extraction mode (--hardlink) is
219 now supported on all backends, not just UNIX.
221 `mkwinpeimg' now supports grabbing files from the WAIK supplement rather
222 than the WAIK itself.
224 wimlib_global_init() now, by default, attempts to acquire additional
225 privileges on Windows, so library clients need not do this.
227 This update bumps the shared library version number up to 9, since it is
228 not binary compatibible with previous releases.
231 Fixed bug in `wimlib-imagex export' that made it impossible to export an
232 image from a WIM that is readonly at the filesystem level.
234 Return error code rather than segfaulting when trying to list files from
235 a non-first part of a split WIM.
237 Joining a WIM will now preserve the RP_FIX and READONLY flags.
240 On Windows, paths given to wimlib-imagex are now treated case
243 Improved behavior regarding invalid filenames; in particular, on
244 Windows, wimlib-imagex will, when extracting, now omit (with an option
245 to override this default) filenames differing only in case, or filenames
246 containing characters not valid on Windows.
248 On Windows, wimlib now supports capturing and extracting long paths
249 (longer than the so-called MAX_PATH).
251 On Windows, `wimlib-imagex update' now acquires proper privileges when
252 running as an Administrator.
254 `wimlib-imagex update' will now complain if no image is specified when
255 trying to update a multi-image WIM.
257 `wimlib-imagex update' now supports specifying a single update command
258 directly on the command line using the --command option.
260 wimlib-imagex will now choose different units for progress messages,
261 depending on the amount of data that needs to be processed.
263 `wimlib-imagex append' will now generate a unique WIM image name if no
264 name is specified and the defaulted name already exists in the WIM.
266 wimlib now allows you to create unnamed WIM images, which can then only
267 be referred to by index.
269 wimlib now allows you to explicitly declare you want write access to a
270 WIM by providing the WIMLIB_OPEN_FLAG_WRITE_ACCESS flag to
273 wimlib now respects the WIM_HDR_FLAG_READONLY flag when set in the WIM
276 Progress callbacks have been added to wimlib's wimlib_update_image()
279 Added wimlib_get_wim_info(), wimlib_set_wim_info(),
280 wimlib_iterate_dir_tree(), and wimlib_iterate_lookup_table() functions
283 NTFS-3g capture now only warns about two conditions previously treated
286 Fixed a couple issues with using wimlib-imagex on UDF filesystems on
289 wimlib now correctly detects and returns an error when reading a WIM
290 image with a cyclic directory structure. (Fun fact: such a WIM will
291 crash Microsoft's software.)
294 Added new "extract" and "update" subcommands to wimlib-imagex, along
295 with associated APIs in the library. These commands are intended mainly
296 for Windows use but can be used on UNIX as well.
298 Many documentation improvements.
300 Fixed a bug in the Windows build where relative symbolic links were not
301 captured in reparse-point fixup mode.
303 Fixed a bug in the Windows build where file handles were left open to
304 the WIM file, causing `wimlib_imagex optimize' to fail in some cases.
306 Fixed a bug in the Windows build of wimlib-imagex where globbing
307 split-WIM parts could cause the program to crash.
309 Fixed a bug where the creation time of WIM images would be shown instead
310 of the last modification time.
312 With the Windows build it is now possible to restore a WIM containing
313 symbolic links as a non-Administrator; however you will receive warnings
314 about not being able to extract the symbolic links.
317 Capturing a WIM image should now be significantly faster in most cases
318 due to improved use of the operating system's cache and avoiding reading
319 files twice whenever possible.
321 The Windows build should now work on Windows XP.
323 The Windows build now supports capturing and restoring hidden,
324 compressed, sparse, and encrypted files.
326 The Windows build now supports capturing and applying WIM images from
327 filesystems other than NTFS (with some reduced functionality).
329 The Windows build now extracts short names correctly.
331 Added support for "reparse-point" fixups (i.e. fixing up of symbolic
332 links). See docs for --rpfix and --norpfix flags of `wimlib-imagex
333 capture' and `wimlib-imagex apply'.
335 The performance of splitting and joining WIMs should be slightly
338 The LZX and XPRESS compression and decompression functions are now
339 exported from the library.
342 Improvements and bugfixes for the Windows build.
344 Added --strict-acls options.
346 Fixed the way that wimlib determines the order of images in the WIM.
349 Since wimlib can now be used on Windows, wimlib's implementation of
350 ImageX has been renamed to wimlib-imagex to avoid confusion with
351 Microsoft's implementation of ImageX, which would have the same file
352 name ("imagex.exe"). If you really don't like this you can pass the
353 --with-imagex-progname option to `configure' to choose a different name,
354 or even simply rename the binary yourself (but the former way will
355 configure the man pages to use the chosen name).
357 Various bugs fixed in the Windows build. Mainly to do with capturing
358 and restoring alternate data streams correctly in weird cases, and
359 requesting the correct privileges when opening files. Also added the
360 --noacls options to wimlib-imagex capture, append, and apply.
362 Windows build again: FindFirstStreamW() and FindNextStreamW() are now
363 dynamically loaded, so this may make the library compatible with Windows
364 XP (however, there may still be other problems).
367 Added experimental support for native Windows builds. Binaries can be
368 downloaded from the SourceForge page.
370 --source-list option added to `imagex capture' and `imagex append'.
372 Better support for different character encodings.
375 Storing UNIX file owners, groups, and modes in WIM images is now
376 possible using `imagex capture' with the --unix-data flag.
378 Minor bug fixes and documentation fixes.
381 NTFS capture: Fixed capturing duplicate reparse points.
383 NTFS capture: Capture first unnamed stream if there are more than one
384 (print warning instead of error).
386 Allow multiple test cases to execute concurrently (e.g. make -j2 check).
389 Added --arch switch to mkwinpeimg script to support getting AMD64 WinPE
392 Update to work with ntfs-3g version 2013.1.13.
395 Fixed truncating file to shorter but non-zero length on read-write
398 Various code cleanups and minor documentation fixes.
401 LZX and XPRESS decompression have received some additional optimizations
402 and should now be even faster. (Although, they were already pretty
403 fast--- much faster than typical I/O speeds.)
405 Fixed a bug introduced in v1.2.1 that would cause a directory tree
406 containing hard links to be captured incorrectly in some cases.
409 By default, unmounting a read-write mounted WIM with 'imagex unmount
410 --commit' will now change the WIM in-place without needing to write the
411 entire WIM again. Use 'imagex unmount --commit --rebuild' to get the
414 'imagex unmount' no longer has a hard-coded limit of 10 minutes to wait
415 for a response from the daemon servicing the mounted WIM. Instead,
416 every second 'imagex unmount' will check if the daemon is still alive,
417 and keep waiting if so, otherwise terminate with an error.
419 'imagex unmount --commit' on a read-write mounted WIM will now print
420 progress information regarding the writing of new or modified streams
421 the WIM, just like when capturing or appending a WIM.
423 A small change has been made to XPRESS compression and it should improve
424 the compression ratio slightly.
426 A change was made that may improve performance slightly when applying a
427 WIM image to a NTFS volume.
429 Microsoft has managed to introduce even more bugs into their software,
430 and now the WIMs for Windows 8 have incorrect (too low) reference counts
431 for some streams. This is unsafe because such streams can be removed
432 when they are in actuality still referenced in the WIM (perhaps by a
433 different image). wimlib will now work around this problem by fixing
434 the stream reference counts. This is only done when wimlib_delete_image() is
435 called ('imagex delete') or when wimlib_mount_image() is called with
436 WIMLIB_MOUNT_FLAG_READWRITE ('imagex mountrw'). Please note that this
437 requires reading the metadata for all images in the WIM, so this will
438 make these operations noticably slower on WIMs with multiple images.
440 Various other bugfixes.
443 Appending images to a WIM is now be done by default without re-building
444 the whole WIM. Use the --rebuild flag to get the old behavior (which
445 was to re-build the entire WIM when a new image is appended).
447 A new command `imagex optimize' is now available to manually re-build a
448 WIM that has wasted space due to repeated appends.
450 Progress information has been improved, and now arbitrary callback
451 functions can be used to show the progress of a WIM operation.
453 A possible bug with changing the bootable image of a WIM was fixed.
455 Some advisory locking is now done to prevent two processes from
456 modifying a WIM at the same time (but only in some cases). For example,
457 you cannot mount two images from a WIM read-write at the same time.
459 Some functions have been reorganized:
460 * wimlib_mount() renamed to wimlib_mount_image().
461 * wimlib_unmount() renamed to wimlib_unmount_image().
462 * wimlib_overwrite_xml_and_header() removed as
463 wimlib_overwrite() suffices now.
464 * wimlib_apply_image_to_ntfs_volume() removed as
465 wimlib_extract_image() suffices now.
466 * wimlib_add_image_from_ntfs_volume() removed as
467 * wimlib_add_image() suffices now.
469 Previously, the soname of libwim.so has been 0.0.0, despite many
470 interface changes. The soname is now updated to 1.0.0 and will now be
471 updated each release.
474 Resources will now be compressed using multiple threads by default.
475 (This applies to `imagex capture', `imagex append', and `imagex
478 Some performance improvements in mounted WIMs.
480 More progress information is shown when capturing a WIM.
483 Lots of minor fixes, code cleanups, and some documentation updates.
484 Nothing in particular is really noteworthy.
487 LZX and XPRESS compression improvements.
489 Fixed calculation of Directory Count, File Count, Total Bytes, and Hard
490 Link Bytes of the WIM.
493 Fixed bug when capturing NTFS file with multiple named data streams.
495 Internally, we are now using inode structures, even though these don't
496 appear literally in the WIM file. This simplifies some of the code
497 (mainly for WIM mounting) and likely fixed a few problems, although it
501 Fixed problem when exporting images from XPRESS to LZX compressed WIM or
505 Enough changes to call it version 1.0.0!
507 Capturing a WIM directly from a NTFS volume, and applying a WIM directly
508 to a NTFS volume, is now supported.
510 Hard links and symbolic links have much improved support. They are
511 supported for WIM capture, WIM application, and mounted WIMs (you can
512 even make them on read-write mounted WIMs).
514 Alternate data streams are now supported on mounted WIMs through an
515 xattr or a Windows-style stream interface. Also they are supported when
516 capturing a WIM from NTFS or applying a WIM to NTFS.
518 Split WIMs are better supported. You may now apply an image directly
519 from a split WIM, mount an image from a split WIM read-only, or export
520 an image from a split WIM.
522 Using a capture configuration file is now supported (but not fully yet).
524 SHA1 message digests are checked in more places, so we can make sure
525 applied and captured data is correct.
527 Man pages have been updated and consolidated.
530 Fixed segfault when unmounting read-only WIM.
533 Support for joining and splitting WIMs.
534 Also, security data is now preserved by default.
537 Can now build with older gcc and system headers, like on CentOS 5.
540 Fixed bug that made it impossible to overwrite files in read-write
544 Write byte-order mark before WIM XML data. (imagex.exe requires this to