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