1 Only the most important changes more recent than version 0.6 are noted here.
4 An alignment bug that caused a crash in the LZX decompressor on some
7 wimlib now attempts to clear the WIM_HDR_FLAG_WRITE_IN_PROGRESS flag in
8 the WIM header when restoring the previous state of a WIM it failed to
11 A workaround has been added for compatibility with versions of WinPE
12 that interpret alternate data stream entries in the boot WIM
16 wimlib can now open WinPE WIMs from WAIK v2.1, which had a quirk that
19 A bug in the interpretation of negative IMAGE indices in the
20 --update-of=[WIMFILE:]IMAGE option to `wimlib-imagex capture' and
21 `wimlib-imagex append' has been fixed.
23 A workaround has been added to successfully apply security descriptors
24 with empty DACLs when the NTFS-3g apply mode is being used with NTFS-3g
27 `wimlib-imagex capture' can now accept the '--delta-from' option
31 Added support for "pipable" WIMs. Pipable WIMs allow capturing images
32 to standard output and applying images from standard input, but they are
33 not compatible with Microsoft's software and are not created by default.
34 See the documentation for --pipable flag of `wimlib-imagex capture' for
37 To better support incremental backups, added support for declaring an
38 image as a modified form of another image. See the documentation for
39 the '--update-of' option of `wimlib-imagex append' and `wimlib-imagex
42 Added supported for "delta" WIMs. See the documentation for the
43 '--delta-from' option of `wimlib-imagex capture'.
45 The library support for managing split WIMs has been changed to support
46 other arrangements, such as delta WIMs, and be easier to use. This
47 change is visible in `wimlib-imagex', which also can now accept the
48 '--ref' option multiple times, and also now supports "delta" WIMs as
51 wimlib now preserves WIM integrity tables by default, even if
52 WIMLIB_WRITE_FLAG_CHECK_INTEGRITY is not specified. This changes the
53 behavior of `wimlib-imagex' whenever the WIM being operated on contains
54 an integrity table and the '--check' option is not specified.
56 `wimlib-imagex capture' now creates LZX-compressed WIMs by default
57 (when --compress is not specified). This provides the best compression
58 ratio by default, which is usually what is desired, at a cost of some
61 `wimlib-imagex' now supports being invoked as wimCOMMAND, where COMMAND
62 is the command as in `wimlib-imagex COMMAND'; for example, it can be
63 invoked as `wimapply' as an alternative to `wimlib-imagex apply'. The
64 appropriate hard links are created in UNIX installations of
65 `wimlib-imagex', while for the Windows distribution of `wimlib-imagex',
66 batch files that emulate this behavior are generated.
68 Security descriptors are now extracted correctly on Windows.
70 Fixed archiving DOS names in NTFS-3g capture mode.
72 The extraction code has been rewritten and it will now be easier to
73 support new features on all supported backends (currently Win32, UNIX,
74 and NTFS-3g). For example, hard-linked extraction mode (--hardlink) is
75 now supported on all backends, not just UNIX.
77 `mkwinpeimg' now supports grabbing files from the WAIK supplement rather
80 wimlib_global_init() now, by default, attempts to acquire additional
81 privileges on Windows, so library clients need not do this.
83 This update bumps the shared library version number up to 9, since it is
84 not binary compatibible with previous releases.
87 Fixed bug in `wimlib-imagex export' that made it impossible to export an
88 image from a WIM that is readonly at the filesystem level.
90 Return error code rather than segfaulting when trying to list files from
91 a non-first part of a split WIM.
93 Joining a WIM will now preserve the RP_FIX and READONLY flags.
96 On Windows, paths given to wimlib-imagex are now treated case
99 Improved behavior regarding invalid filenames; in particular, on
100 Windows, wimlib-imagex will, when extracting, now omit (with an option
101 to override this default) filenames differing only in case, or filenames
102 containing characters not valid on Windows.
104 On Windows, wimlib now supports capturing and extracting long paths
105 (longer than the so-called MAX_PATH).
107 On Windows, `wimlib-imagex update' now acquires proper privileges when
108 running as an Administrator.
110 `wimlib-imagex update' will now complain if no image is specified when
111 trying to update a multi-image WIM.
113 `wimlib-imagex update' now supports specifying a single update command
114 directly on the command line using the --command option.
116 wimlib-imagex will now choose different units for progress messages,
117 depending on the amount of data that needs to be processed.
119 `wimlib-imagex append' will now generate a unique WIM image name if no
120 name is specified and the defaulted name already exists in the WIM.
122 wimlib now allows you to create unnamed WIM images, which can then only
123 be referred to by index.
125 wimlib now allows you to explicitly declare you want write access to a
126 WIM by providing the WIMLIB_OPEN_FLAG_WRITE_ACCESS flag to
129 wimlib now respects the WIM_HDR_FLAG_READONLY flag when set in the WIM
132 Progress callbacks have been added to wimlib's wimlib_update_image()
135 Added wimlib_get_wim_info(), wimlib_set_wim_info(),
136 wimlib_iterate_dir_tree(), and wimlib_iterate_lookup_table() functions
139 NTFS-3g capture now only warns about two conditions previously treated
142 Fixed a couple issues with using wimlib-imagex on UDF filesystems on
145 wimlib now correctly detects and returns an error when reading a WIM
146 image with a cyclic directory structure. (Fun fact: such a WIM will
147 crash Microsoft's software.)
150 Added new "extract" and "update" subcommands to wimlib-imagex, along
151 with associated APIs in the library. These commands are intended mainly
152 for Windows use but can be used on UNIX as well.
154 Many documentation improvements.
156 Fixed a bug in the Windows build where relative symbolic links were not
157 captured in reparse-point fixup mode.
159 Fixed a bug in the Windows build where file handles were left open to
160 the WIM file, causing `wimlib_imagex optimize' to fail in some cases.
162 Fixed a bug in the Windows build of wimlib-imagex where globbing
163 split-WIM parts could cause the program to crash.
165 Fixed a bug where the creation time of WIM images would be shown instead
166 of the last modification time.
168 With the Windows build it is now possible to restore a WIM containing
169 symbolic links as a non-Administrator; however you will receive warnings
170 about not being able to extract the symbolic links.
173 Capturing a WIM image should now be significantly faster in most cases
174 due to improved use of the operating system's cache and avoiding reading
175 files twice whenever possible.
177 The Windows build should now work on Windows XP.
179 The Windows build now supports capturing and restoring hidden,
180 compressed, sparse, and encrypted files.
182 The Windows build now supports capturing and applying WIM images from
183 filesystems other than NTFS (with some reduced functionality).
185 The Windows build now extracts short names correctly.
187 Added support for "reparse-point" fixups (i.e. fixing up of symbolic
188 links). See docs for --rpfix and --norpfix flags of `wimlib-imagex
189 capture' and `wimlib-imagex apply'.
191 The performance of splitting and joining WIMs should be slightly
194 The LZX and XPRESS compression and decompression functions are now
195 exported from the library.
198 Improvements and bugfixes for the Windows build.
200 Added --strict-acls options.
202 Fixed the way that wimlib determines the order of images in the WIM.
205 Since wimlib can now be used on Windows, wimlib's implementation of
206 ImageX has been renamed to wimlib-imagex to avoid confusion with
207 Microsoft's implementation of ImageX, which would have the same file
208 name ("imagex.exe"). If you really don't like this you can pass the
209 --with-imagex-progname option to `configure' to choose a different name,
210 or even simply rename the binary yourself (but the former way will
211 configure the man pages to use the chosen name).
213 Various bugs fixed in the Windows build. Mainly to do with capturing
214 and restoring alternate data streams correctly in weird cases, and
215 requesting the correct privileges when opening files. Also added the
216 --noacls options to wimlib-imagex capture, append, and apply.
218 Windows build again: FindFirstStreamW() and FindNextStreamW() are now
219 dynamically loaded, so this may make the library compatible with Windows
220 XP (however, there may still be other problems).
223 Added experimental support for native Windows builds. Binaries can be
224 downloaded from the SourceForge page.
226 --source-list option added to `imagex capture' and `imagex append'.
228 Better support for different character encodings.
231 Storing UNIX file owners, groups, and modes in WIM images is now
232 possible using `imagex capture' with the --unix-data flag.
234 Minor bug fixes and documentation fixes.
237 NTFS capture: Fixed capturing duplicate reparse points.
239 NTFS capture: Capture first unnamed stream if there are more than one
240 (print warning instead of error).
242 Allow multiple test cases to execute concurrently (e.g. make -j2 check).
245 Added --arch switch to mkwinpeimg script to support getting AMD64 WinPE
248 Update to work with ntfs-3g version 2013.1.13.
251 Fixed truncating file to shorter but non-zero length on read-write
254 Various code cleanups and minor documentation fixes.
257 LZX and XPRESS decompression have received some additional optimizations
258 and should now be even faster. (Although, they were already pretty
259 fast--- much faster than typical I/O speeds.)
261 Fixed a bug introduced in v1.2.1 that would cause a directory tree
262 containing hard links to be captured incorrectly in some cases.
265 By default, unmounting a read-write mounted WIM with 'imagex unmount
266 --commit' will now change the WIM in-place without needing to write the
267 entire WIM again. Use 'imagex unmount --commit --rebuild' to get the
270 'imagex unmount' no longer has a hard-coded limit of 10 minutes to wait
271 for a response from the daemon servicing the mounted WIM. Instead,
272 every second 'imagex unmount' will check if the daemon is still alive,
273 and keep waiting if so, otherwise terminate with an error.
275 'imagex unmount --commit' on a read-write mounted WIM will now print
276 progress information regarding the writing of new or modified streams
277 the WIM, just like when capturing or appending a WIM.
279 A small change has been made to XPRESS compression and it should improve
280 the compression ratio slightly.
282 A change was made that may improve performance slightly when applying a
283 WIM image to a NTFS volume.
285 Microsoft has managed to introduce even more bugs into their software,
286 and now the WIMs for Windows 8 have incorrect (too low) reference counts
287 for some streams. This is unsafe because such streams can be removed
288 when they are in actuality still referenced in the WIM (perhaps by a
289 different image). wimlib will now work around this problem by fixing
290 the stream reference counts. This is only done when wimlib_delete_image() is
291 called ('imagex delete') or when wimlib_mount_image() is called with
292 WIMLIB_MOUNT_FLAG_READWRITE ('imagex mountrw'). Please note that this
293 requires reading the metadata for all images in the WIM, so this will
294 make these operations noticably slower on WIMs with multiple images.
296 Various other bugfixes.
299 Appending images to a WIM is now be done by default without re-building
300 the whole WIM. Use the --rebuild flag to get the old behavior (which
301 was to re-build the entire WIM when a new image is appended).
303 A new command `imagex optimize' is now available to manually re-build a
304 WIM that has wasted space due to repeated appends.
306 Progress information has been improved, and now arbitrary callback
307 functions can be used to show the progress of a WIM operation.
309 A possible bug with changing the bootable image of a WIM was fixed.
311 Some advisory locking is now done to prevent two processes from
312 modifying a WIM at the same time (but only in some cases). For example,
313 you cannot mount two images from a WIM read-write at the same time.
315 Some functions have been reorganized:
316 * wimlib_mount() renamed to wimlib_mount_image().
317 * wimlib_unmount() renamed to wimlib_unmount_image().
318 * wimlib_overwrite_xml_and_header() removed as
319 wimlib_overwrite() suffices now.
320 * wimlib_apply_image_to_ntfs_volume() removed as
321 wimlib_extract_image() suffices now.
322 * wimlib_add_image_from_ntfs_volume() removed as
323 * wimlib_add_image() suffices now.
325 Previously, the soname of libwim.so has been 0.0.0, despite many
326 interface changes. The soname is now updated to 1.0.0 and will now be
327 updated each release.
330 Resources will now be compressed using multiple threads by default.
331 (This applies to `imagex capture', `imagex append', and `imagex
334 Some performance improvements in mounted WIMs.
336 More progress information is shown when capturing a WIM.
339 Lots of minor fixes, code cleanups, and some documentation updates.
340 Nothing in particular is really noteworthy.
343 LZX and XPRESS compression improvements.
345 Fixed calculation of Directory Count, File Count, Total Bytes, and Hard
346 Link Bytes of the WIM.
349 Fixed bug when capturing NTFS file with multiple named data streams.
351 Internally, we are now using inode structures, even though these don't
352 appear literally in the WIM file. This simplifies some of the code
353 (mainly for WIM mounting) and likely fixed a few problems, although it
357 Fixed problem when exporting images from XPRESS to LZX compressed WIM or
361 Enough changes to call it version 1.0.0!
363 Capturing a WIM directly from a NTFS volume, and applying a WIM directly
364 to a NTFS volume, is now supported.
366 Hard links and symbolic links have much improved support. They are
367 supported for WIM capture, WIM application, and mounted WIMs (you can
368 even make them on read-write mounted WIMs).
370 Alternate data streams are now supported on mounted WIMs through an
371 xattr or a Windows-style stream interface. Also they are supported when
372 capturing a WIM from NTFS or applying a WIM to NTFS.
374 Split WIMs are better supported. You may now apply an image directly
375 from a split WIM, mount an image from a split WIM read-only, or export
376 an image from a split WIM.
378 Using a capture configuration file is now supported (but not fully yet).
380 SHA1 message digests are checked in more places, so we can make sure
381 applied and captured data is correct.
383 Man pages have been updated and consolidated.
386 Fixed segfault when unmounting read-only WIM.
389 Support for joining and splitting WIMs.
390 Also, security data is now preserved by default.
393 Can now build with older gcc and system headers, like on CentOS 5.
396 Fixed bug that made it impossible to overwrite files in read-write
400 Write byte-order mark before WIM XML data. (imagex.exe requires this to