e73e93550e9216e95f7b20a190b2b92583f18b4e
[wimlib] / NEWS
1 Version 1.7.4-BETA:
2         The Windows binary distribution no longer contains third party DLLs.
3         These dependencies are instead compiled directly into the libwim DLL.
4
5         Added more fixes for wimlib on non-x86 architectures such as ARM.
6
7         Extracting files to a Windows PE in-memory filesystem no longer fails if
8         the target files do not yet exist.
9
10         Improved the performance of XPRESS compression and LZMS decompression.
11
12         Removed the --with-imagex-progname and --enable-more-assertions
13         configure options.
14
15 Version 1.7.3:
16         Fix for very slow export from solid WIM / ESD files.
17
18         Fix for LZX and LZMS algorithms on non-x86 architectures, such as ARM.
19
20         New progress message: WIMLIB_PROGRESS_MSG_HANDLE_ERROR.  Applications
21         may use this to treat some types of errors as non-fatal.
22
23         The library now permits making in-memory changes to a WIMStruct backed
24         by a read-only WIM file.
25
26         Fixes for "WIMBoot" extraction mode (Windows only):
27
28                 When not using the WOF driver, extraction no longer fails if the
29                 disk containing the WIM file has too many partitions.
30
31                 When matching patterns in [PrepopulateList], all hard links of
32                 each file are now considered.
33
34                 The system registry files are now automatically treated as being
35                 in [PrepopulateList].
36
37                 Added a hack to try to work around an intermittent bug in
38                 Microsoft's WOF (Windows Overlay Filesystem) driver.
39
40 Version 1.7.2:
41         Made more improvements to the XPRESS, LZX, and LZMS compressors.
42
43         A number of improvements to the Windows port:
44
45                 Fixes for setting short filenames.
46
47                 Faster "WIMBoot" extraction.
48
49                 Updated and slimmed down the dependent DLLs.
50
51                 ACL inheritence bits are now restored.
52
53                 Mandatory integrity labels are now backed up and restored.
54
55         Added a workaround for an issue where in rare cases, wimlib could create
56         a compressed data stream that could not be read correctly by Windows
57         after an extraction in "WIMBoot" mode.
58
59         Library changes:
60                 Added file count progress data for
61                 WIMLIB_PROGRESS_MSG_EXTRACT_FILE_STRUCTURE and
62                 WIMLIB_PROGRESS_MSG_EXTRACT_METADATA.
63
64                 Added support for testing file exclusions via the user-provided
65                 progress function.
66
67                 Some documentation improvements.
68
69         Made some clarifications to the license text in the COPYING file.
70
71 Version 1.7.1:
72         Made more improvements to the XPRESS, LZX, and LZMS compressors.
73
74         The default compression mode for wimcapture is now LZX compression in
75         its default mode, which is the same as '--compress=maximum'.
76
77         You can now specify an optional integer compression level to the
78         '--compress' option; e.g. '--compress=lzx:75'.
79
80         Made a minor change to the LZMS compressor and decompressor to fix an
81         incompatibility with the Microsoft implementation.  In the unlikely
82         event that you created an LZMS-compressed WIM with wimlib v1.7.0 or
83         earlier and a checksum error is reported when extracting files from it
84         with wimlib v1.7.1, decompress it with v1.7.0 then compress it with
85         v1.7.1.
86
87         Added 'verify' subcommand to wimlib-imagex.
88
89         Notable library changes:
90
91                 Custom compressor parameters have been removed from the library
92                 in favor of the simpler level-based API.
93
94                 Decompressor parameters have been removed entirely.
95
96                 Library users can now specify a custom file for warning and
97                 error messages to be sent to, rather than the default of
98                 standard error.
99
100                 New progress messages:
101                 WIMLIB_PROGRESS_MSG_EXTRACT_FILE_STRUCTURE,
102                 WIMLIB_PROGRESS_MSG_EXTRACT_METADATA.
103
104                 New function: wimlib_verify_wim().
105
106 Version 1.7.0:
107         Improved compression, decompression, and extraction performance.
108
109         Improved compatibility with version 3584 WIM / ESD files:
110             - Add support for reading and writing multiple solid blocks per
111               archive, which WIMGAPI/DISM can create when appending an image.
112             - Correctly create solid blocks larger than 4 GiB.
113
114         'add' commands passed to wimupdate will now replace existing
115         nondirectory files by default.  Use the --no-replace option to get the
116         old behavior.
117
118         The license for the library now contains an exception that allows using
119         it under the LGPL.  See the COPYING file for details.
120
121         In reparse-point fixup mode (the default for capture), symbolic links
122         and junctions that point outside the tree being captured are no longer
123         excluded from capture.
124
125         Added support for "WIMBoot" capture and extraction.  See the
126         documentation for the new '--wimboot' option to wimcapture and wimapply
127         for more information.
128
129         On UNIX-like systems, you can now backup and restore device nodes, named
130         pipes, and sockets.  In addition, 32-bit user and group IDs are now
131         supported.
132
133         The way that UNIX data is stored in WIM files has been changed.  If you
134         captured any WIMs with the --unix-data option, to upgrade them you'll
135         need to apply them with --unix-data using wimlib-imagex v1.6.2, then
136         re-capture them with --unix-data using this version.
137
138         wimlib now understands tagged metadata items, such as object IDs, that
139         can be stored in WIM directory entries.
140
141         Removed the --hardlink and --symlink options to wimapply, since I don't
142         think they are too useful and they got in the way of improving the code.
143
144         WIMs will now retain their GUIDs when rebuilt (e.g. with wimoptimize).
145
146         The 'mkwinpeimg' script now supports writing the ISO image to standard
147         output.
148
149         The <ARCH> element in WIM XML data is now exported correctly.
150
151         On Windows, sparse file attributes are no longer set on extracted files.
152         Oddly enough, this actually saves disk space in some cases.
153
154         On UNIX, configuring with --disable-xattr or --enable-xattr is no longer
155         supported.  Mounting WIM images now always requires extended attribute
156         support.  Use --without-fuse to disable support for mounting WIM images;
157         this will also disable the need for extended attribute support.
158
159         Configuring with --enable-ssse3-sha1 now works correctly.
160
161         The shared library version has been bumped up.  The main
162         incompatibilities are:
163
164                 - WIMLIB_COMPRESSION_TYPE_XPRESS is now 1 and
165                   WIMLIB_COMPRESSION_TYPE_LZX is now 2 (so it's the same as
166                   WIMGAPI).
167
168                 - User-provided progress functions are now registered using a
169                   separate function, wimlib_register_progress_function().  The
170                   'progress_func' argument to many functions no longer exists.
171
172                 - The return value from user-provided progress functions is now
173                   significant.
174
175                 - A context argument has been added to the prototype of
176                   user-provided progress functions.
177
178                 - 'struct wimlib_capture_config' has been removed.  The library
179                   now takes the path to the configuration file directly.  This
180                   affects wimlib_add_image(), wimlib_add_image_multisource(),
181                   and wimlib_update_image().  However, a NULL value passed in
182                   the argument retains the same meaning.
183
184                 - Removed deprecated functions: some (de)compression functions,
185                   wimlib_extract_files(), and wimlib_print_metadata().
186
187                 - Removed extraction flags: WIMLIB_EXTRACT_FLAG_HARDLINK,
188                   WIMLIB_EXTRACT_FLAG_SYMLINK, WIMLIB_EXTRACT_FLAG_FILE_ORDER,
189                   and WIMLIB_EXTRACT_FLAG_SEQUENTIAL.
190
191                 - Removed some progress messages:
192                   WIMLIB_PROGRESS_MSG_APPLY_TIMESTAMPS,
193                   WIMLIB_PROGRESS_MSG_EXTRACT_DIR_STRUCTURE_BEGIN,
194                   WIMLIB_PROGRESS_MSG_EXTRACT_DIR_STRUCTURE_END.  Numbering
195                   stays the same.
196
197                 - Removed some error codes.  Numbering stays the same.
198
199                 - Replaced WIMLIB_UNMOUNT_FLAG_LAZY with
200                   WIMLIB_UNMOUNT_FLAG_FORCE.
201
202                 - WIM paths passed to progress functions now have a leading
203                   slash.
204
205 Version 1.6.2:
206         Case-insensitive comparisons of strings (e.g. filenames) containing
207         UTF-16 codepoints above 32767 are now done correctly.
208
209         Fixed build failure on Mac OS X.
210
211         wimunmount now provides the '--new-image' option to cause changes to a
212         read-write mounted image to be committed as a new image rather than as
213         an update of the mounted image.  (The corresponding new library flag is
214         WIMLIB_UNMOUNT_FLAG_NEW_IMAGE.)
215
216         The LZMS ("recovery") compression chunk size, or "dictionary size", may
217         now be up to 1 GiB (1,073,741,824 bytes).
218
219         The performance of LZX ("maximum") and LZMS ("recovery") compression
220         with large chunk sizes has been slightly improved.
221
222 Version 1.6.1:
223         Stored files with size exactly 4 GiB (4,294,967,296 bytes) are now
224         decompressed correctly.
225
226         Fixed a bug in the LZX compressor introduced in v1.5.3.  The bug
227         occurred in an unlikely case, and due to validity checks it did not
228         affect successfully created archives.
229
230         Fixed a minor compatibility issue with the LZMS compressor and
231         decompressor.  This is *not* the default compression type and was only
232         introduced in v1.6.0.  In the unlikely event that you created an
233         LZMS-compressed WIM with v1.6.0 and a checksum error is reported when
234         applying it with v1.6.1, decompress it with v1.6.0 then compress it with
235         v1.6.1.
236
237         Memory usage for LZMS and LZX compression has been decreased.
238
239         wimextract now allows wildcard characters in paths specified on the
240         command line.  Also, the '--strict-wildcards' option has been removed
241         and replaced with the inverse option '--nullglob'.  See the
242         documentation for wimextract for more details and changes.
243
244         The wimlib_extract_files() function is now considered deprecated in
245         favor of wimlib_extract_paths().
246
247         Fixed more permissions problems when extracting files on Windows.
248
249         A new '--no-attributes' option has been added to wimapply and
250         wimextract.  The library flag is WIMLIB_EXTRACT_FLAG_NO_ATTRIBUTES.
251
252         The default chunk size is now set correctly when changing the
253         compression type of a WIM, for example with 'wimoptimize'.
254
255         The '--metadata' option to wiminfo has been replaced with the
256         '--detailed' option to wimdir.
257
258         In relevant wimlib-imagex commands, '--solid' may now be used as an
259         alias for '--pack-streams'.
260
261 Version 1.6.0:
262         Support for extracting and updating the new version 3584 WIMs has been
263         added.  These WIMs typically pack many streams ("files") together into a
264         single compressed resource, thereby saving space.  This degrades the
265         performance of random access (such as that which occurs on a mounted
266         image), but optimizations have been implemented for extraction.  These
267         new WIM files also typically use a new compression format (LZMS), which
268         is similar to LZMA and can offer a better compression ratio than LZX.
269         These new WIM files can be created using `wimcapture' with
270         the '--compress=lzms --pack-streams' options.  Note: this new WIM format
271         is used by the Windows 8 web downloader, but important segments of the
272         raw '.esd' files are encrypted, so wimlib will not be able to extract
273         such files until they are first decrypted.
274
275         wimlib now supports extracting files and directories from a WIM image
276         based on a "listfile" that itself contains the list of paths to extract.
277         For `wimextract', the syntax is to specify @LISTFILE instead of a PATH,
278         and for the library itself, the new APIs are wimlib_extract_pathlist()
279         and wimlib_extract_paths().  Path globs containing wildcard characters
280         are supported.
281
282         For searching WIM files, wimlib now has configurable case sensitivity.
283         The default on Windows is still case-insensitive and the default on
284         UNIX-like systems is still case-sensitive, but this can be overridden
285         on either platform through flags to wimlib_global_init().  For
286         `wimlib-imagex', the environmental variable WIMLIB_IMAGEX_IGNORE_CASE
287         can be set to 1 or 0 for case-insensitive or case-sensitive behavior,
288         respectively.
289
290         Support for compression chunk sizes greater than the default of 32768
291         bytes has been added.  A larger chunk size typically results in a better
292         compression ratio.  However, the MS implementation is seemingly not
293         compatible with all chunk sizes, especially for LZX compression, so the
294         defaults remain unchanged, with the exception of the new LZMS-compressed
295         WIMs, which use a larger chunk size by default.
296
297         The compression/decompression API exported by wimlib has been changed.
298         Now one set of functions handles all supported compression formats.
299
300         `wimcapture' and `wimappend' will now display the progress of scanning
301         the directory tree to capture, in addition to the progress of writing
302         data to the WIM.  The '--verbose' option no longer does anything.  The
303         library API change for this is the addition of several members to
304         `struct wimlib_progress_info_scan' available to progress callbacks.
305
306         `mkwinpeimg' now correctly handles the '--start-script' option when the
307         start script is not in the working directory.
308
309         Sequential extraction, previously requested by using
310         WIMLIB_EXTRACT_FLAG_SEQUENTIAL, is now the default.
311         WIMLIB_EXTRACT_FLAG_FILE_ORDER can be used to get the old default
312         behavior (extract in file order).
313
314 Version 1.5.3:
315         The new LZX compressor added in v1.5.2 has been improved and is now
316         enabled by default, except when `wimcapture' or `wimappend' is run
317         *without* the '--compress' option, in which case the faster LZX
318         compressor is used (the same as before).  This behavior is reasonably
319         consistent with ImageX which actually uses "fast" (XPRESS) compression
320         by default.  In those cases, use '--compress=maximum' to explicitly
321         capture a WIM image using the new (slower but better) LZX compressor.
322
323         The '--compress-slow' option still exists to `wimlib-imagex optimize',
324         but its new behavior is to tweak the new LZX compressor even more to
325         produce an even better compression ratio at the cost of more time spent
326         compressing.
327
328         `wimlib-imagex optimize' now supports the '--compress=TYPE' option,
329         which recompresses the WIM file using the specified compression TYPE.
330         The new library API function used for this is
331         wimlib_set_output_compression_type().
332
333         Added the wimlib_get_xml_data() function to allow library clients to
334         easily retrieve the raw XML data from a WIM file if needed.
335
336         Fixed a bug that could cause an error code to be incorrectly returned
337         when writing XML data containing a <WINDOWS> element.
338
339         Mounted WIM images will now correctly show the default file stream even
340         if appears in the alternate data stream entries of the corresponding WIM
341         directory entry.
342
343 Version 1.5.2:
344         Added a new experimental LZX compressor which can be enabled by passing
345         '--compress-slow' to `wimlib-imagex capture' or `wimlib-imagex
346         optimize'.  (The latter is only applicable if the WIM is already
347         LZX-compressed and the '--recompress' option is also given.)  The
348         experimental compressor is much slower but compresses the data slightly
349         more --- currently usually to within a fraction of a percent of the
350         results from WIMGAPI/ImageX.
351
352         A workaround has been added for compatibility with versions of WinPE
353         that interpret alternate data stream entries in the boot WIM
354         incorrectly.
355
356         An alignment bug that caused a crash in the LZX decompressor on some
357         builds was fixed.
358
359         wimlib now attempts to clear the WIM_HDR_FLAG_WRITE_IN_PROGRESS flag in
360         the WIM header when restoring the previous state of a WIM it failed to
361         successfully update.
362
363         Added a workaround to avoid an access denied error on Windows when
364         replacing a WIM file that another process has opened.
365
366 Version 1.5.1:
367         wimlib can now open WinPE WIMs from WAIK v2.1, which had a quirk that
368         needed to be handled.
369
370         A bug in the interpretation of negative IMAGE indices in the
371         --update-of=[WIMFILE:]IMAGE option to `wimlib-imagex capture' and
372         `wimlib-imagex append' has been fixed.
373
374         A workaround has been added to successfully apply security descriptors
375         with empty DACLs when the NTFS-3g apply mode is being used with NTFS-3g
376         2013.1.13 or earlier.
377
378         `wimlib-imagex capture' can now accept the '--delta-from' option
379         multiple times.
380
381 Version 1.5.0:
382         Added support for "pipable" WIMs.  Pipable WIMs allow capturing images
383         to standard output and applying images from standard input, but they are
384         not compatible with Microsoft's software and are not created by default.
385         See the documentation for --pipable flag of `wimlib-imagex capture' for
386         more information.
387
388         To better support incremental backups, added support for declaring an
389         image as a modified form of another image.  See the documentation for
390         the '--update-of' option of `wimlib-imagex append' and `wimlib-imagex
391         capture'.
392
393         Added supported for "delta" WIMs.  See the documentation for the
394         '--delta-from' option of `wimlib-imagex capture'.
395
396         The library support for managing split WIMs has been changed to support
397         other arrangements, such as delta WIMs, and be easier to use.  This
398         change is visible in `wimlib-imagex', which also can now accept the
399         '--ref' option multiple times, and also now supports "delta" WIMs as
400         mentioned above.
401
402         wimlib now preserves WIM integrity tables by default, even if
403         WIMLIB_WRITE_FLAG_CHECK_INTEGRITY is not specified.  This changes the
404         behavior of `wimlib-imagex' whenever the WIM being operated on contains
405         an integrity table and the '--check' option is not specified.
406
407         `wimlib-imagex capture' now creates LZX-compressed WIMs by default
408         (when --compress is not specified).  This provides the best compression
409         ratio by default, which is usually what is desired, at a cost of some
410         speed.
411
412         `wimlib-imagex' now supports being invoked as wimCOMMAND, where COMMAND
413         is the command as in `wimlib-imagex COMMAND'; for example, it can be
414         invoked as `wimapply' as an alternative to `wimlib-imagex apply'.  The
415         appropriate hard links are created in UNIX installations of
416         `wimlib-imagex', while for the Windows distribution of `wimlib-imagex',
417         batch files that emulate this behavior are generated.
418
419         Security descriptors are now extracted correctly on Windows.
420
421         Fixed archiving DOS names in NTFS-3g capture mode.
422
423         The extraction code has been rewritten and it will now be easier to
424         support new features on all supported backends (currently Win32, UNIX,
425         and NTFS-3g).  For example, hard-linked extraction mode (--hardlink) is
426         now supported on all backends, not just UNIX.
427
428         `mkwinpeimg' now supports grabbing files from the WAIK supplement rather
429         than the WAIK itself.
430
431         wimlib_global_init() now, by default, attempts to acquire additional
432         privileges on Windows, so library clients need not do this.
433
434         This update bumps the shared library version number up to 9, since it is
435         not binary compatibible with previous releases.
436
437 Version 1.4.2:
438         Fixed bug in `wimlib-imagex export' that made it impossible to export an
439         image from a WIM that is readonly at the filesystem level.
440
441         Return error code rather than segfaulting when trying to list files from
442         a non-first part of a split WIM.
443
444         Joining a WIM will now preserve the RP_FIX and READONLY flags.
445
446 Version 1.4.1:
447         On Windows, paths given to wimlib-imagex are now treated case
448         insensitively.
449
450         Improved behavior regarding invalid filenames; in particular, on
451         Windows, wimlib-imagex will, when extracting, now omit (with an option
452         to override this default) filenames differing only in case, or filenames
453         containing characters not valid on Windows.
454
455         On Windows, wimlib now supports capturing and extracting long paths
456         (longer than the so-called MAX_PATH).
457
458         On Windows, `wimlib-imagex update' now acquires proper privileges when
459         running as an Administrator.
460
461         `wimlib-imagex update' will now complain if no image is specified when
462         trying to update a multi-image WIM.
463
464         `wimlib-imagex update' now supports specifying a single update command
465         directly on the command line using the --command option.
466
467         wimlib-imagex will now choose different units for progress messages,
468         depending on the amount of data that needs to be processed.
469
470         `wimlib-imagex append' will now generate a unique WIM image name if no
471         name is specified and the defaulted name already exists in the WIM.
472
473         wimlib now allows you to create unnamed WIM images, which can then only
474         be referred to by index.
475
476         wimlib now allows you to explicitly declare you want write access to a
477         WIM by providing the WIMLIB_OPEN_FLAG_WRITE_ACCESS flag to
478         wimlib_open_wim().
479
480         wimlib now respects the WIM_HDR_FLAG_READONLY flag when set in the WIM
481         header.
482
483         Progress callbacks have been added to wimlib's wimlib_update_image()
484         function.
485
486         Added wimlib_get_wim_info(), wimlib_set_wim_info(),
487         wimlib_iterate_dir_tree(), and wimlib_iterate_lookup_table() functions
488         to the library.
489
490         NTFS-3g capture now only warns about two conditions previously treated
491         as errors.
492
493         Fixed a couple issues with using wimlib-imagex on UDF filesystems on
494         Windows.
495
496         wimlib now correctly detects and returns an error when reading a WIM
497         image with a cyclic directory structure.  (Fun fact: such a WIM will
498         crash Microsoft's software.)
499
500 Version 1.4.0:
501         Added new "extract" and "update" subcommands to wimlib-imagex, along
502         with associated APIs in the library.  These commands are intended mainly
503         for Windows use but can be used on UNIX as well.
504
505         Many documentation improvements.
506
507         Fixed a bug in the Windows build where relative symbolic links were not
508         captured in reparse-point fixup mode.
509
510         Fixed a bug in the Windows build where file handles were left open to
511         the WIM file, causing `wimlib_imagex optimize' to fail in some cases.
512
513         Fixed a bug in the Windows build of wimlib-imagex where globbing
514         split-WIM parts could cause the program to crash.
515
516         Fixed a bug where the creation time of WIM images would be shown instead
517         of the last modification time.
518
519         With the Windows build it is now possible to restore a WIM containing
520         symbolic links as a non-Administrator; however you will receive warnings
521         about not being able to extract the symbolic links.
522
523 Version 1.3.3:
524         Capturing a WIM image should now be significantly faster in most cases
525         due to improved use of the operating system's cache and avoiding reading
526         files twice whenever possible.
527
528         The Windows build should now work on Windows XP.
529
530         The Windows build now supports capturing and restoring hidden,
531         compressed, sparse, and encrypted files.
532
533         The Windows build now supports capturing and applying WIM images from
534         filesystems other than NTFS (with some reduced functionality).
535
536         The Windows build now extracts short names correctly.
537
538         Added support for "reparse-point" fixups (i.e. fixing up of symbolic
539         links).  See docs for --rpfix and --norpfix flags of `wimlib-imagex
540         capture' and `wimlib-imagex apply'.
541
542         The performance of splitting and joining WIMs should be slightly
543         improved.
544
545         The LZX and XPRESS compression and decompression functions are now
546         exported from the library.
547
548 Version 1.3.2:
549         Improvements and bugfixes for the Windows build.
550
551         Added --strict-acls options.
552
553         Fixed the way that wimlib determines the order of images in the WIM.
554
555 Version 1.3.1:
556         Since wimlib can now be used on Windows, wimlib's implementation of
557         ImageX has been renamed to wimlib-imagex to avoid confusion with
558         Microsoft's implementation of ImageX, which would have the same file
559         name ("imagex.exe").  If you really don't like this you can pass the
560         --with-imagex-progname option to `configure' to choose a different name,
561         or even simply rename the binary yourself (but the former way will
562         configure the man pages to use the chosen name).
563
564         Various bugs fixed in the Windows build.  Mainly to do with capturing
565         and restoring alternate data streams correctly in weird cases, and
566         requesting the correct privileges when opening files.  Also added the
567         --noacls options to wimlib-imagex capture, append, and apply.
568
569         Windows build again: FindFirstStreamW() and FindNextStreamW() are now
570         dynamically loaded, so this may make the library compatible with Windows
571         XP (however, there may still be other problems).
572
573 Version 1.3.0:
574         Added experimental support for native Windows builds.  Binaries can be
575         downloaded from the SourceForge page.
576
577         --source-list option added to `imagex capture' and `imagex append'.
578
579         Better support for different character encodings.
580
581 Version 1.2.6:
582         Storing UNIX file owners, groups, and modes in WIM images is now
583         possible using `imagex capture' with the --unix-data flag.
584
585         Minor bug fixes and documentation fixes.
586
587 Version 1.2.5:
588         NTFS capture: Fixed capturing duplicate reparse points.
589
590         NTFS capture: Capture first unnamed stream if there are more than one
591         (print warning instead of error).
592
593         Allow multiple test cases to execute concurrently (e.g. make -j2 check).
594
595 Version 1.2.4:
596         Added --arch switch to mkwinpeimg script to support getting AMD64 WinPE
597         from the WAIK.
598
599         Update to work with ntfs-3g version 2013.1.13.
600
601 Version 1.2.3:
602         Fixed truncating file to shorter but non-zero length on read-write
603         mounted WIM image.
604
605         Various code cleanups and minor documentation fixes.
606
607 Version 1.2.2:
608         LZX and XPRESS decompression have received some additional optimizations
609         and should now be even faster.  (Although, they were already pretty
610         fast--- much faster than typical I/O speeds.)
611
612         Fixed a bug introduced in v1.2.1 that would cause a directory tree
613         containing hard links to be captured incorrectly in some cases.
614
615 Version 1.2.1:
616         By default, unmounting a read-write mounted WIM with 'imagex unmount
617         --commit' will now change the WIM in-place without needing to write the
618         entire WIM again.  Use 'imagex unmount --commit --rebuild' to get the
619         old behavior.
620
621         'imagex unmount' no longer has a hard-coded limit of 10 minutes to wait
622         for a response from the daemon servicing the mounted WIM.  Instead,
623         every second 'imagex unmount' will check if the daemon is still alive,
624         and keep waiting if so, otherwise terminate with an error.
625
626         'imagex unmount --commit' on a read-write mounted WIM will now print
627         progress information regarding the writing of new or modified streams
628         the WIM, just like when capturing or appending a WIM.
629
630         A small change has been made to XPRESS compression and it should improve
631         the compression ratio slightly.
632
633         A change was made that may improve performance slightly when applying a
634         WIM image to a NTFS volume.
635
636         Microsoft has managed to introduce even more bugs into their software,
637         and now the WIMs for Windows 8 have incorrect (too low) reference counts
638         for some streams.  This is unsafe because such streams can be removed
639         when they are in actuality still referenced in the WIM (perhaps by a
640         different image).  wimlib will now work around this problem by fixing
641         the stream reference counts.  This is only done when wimlib_delete_image() is
642         called ('imagex delete') or when wimlib_mount_image() is called with
643         WIMLIB_MOUNT_FLAG_READWRITE ('imagex mountrw').  Please note that this
644         requires reading the metadata for all images in the WIM, so this will
645         make these operations noticably slower on WIMs with multiple images.
646
647         Various other bugfixes.
648
649 Version 1.2.0:
650         Appending images to a WIM is now be done by default without re-building
651         the whole WIM.  Use the --rebuild flag to get the old behavior (which
652         was to re-build the entire WIM when a new image is appended).
653
654         A new command `imagex optimize' is now available to manually re-build a
655         WIM that has wasted space due to repeated appends.
656
657         Progress information has been improved, and now arbitrary callback
658         functions can be used to show the progress of a WIM operation.
659
660         A possible bug with changing the bootable image of a WIM was fixed.
661
662         Some advisory locking is now done to prevent two processes from
663         modifying a WIM at the same time (but only in some cases).  For example,
664         you cannot mount two images from a WIM read-write at the same time.
665
666         Some functions have been reorganized:
667                 * wimlib_mount() renamed to wimlib_mount_image().
668                 * wimlib_unmount() renamed to wimlib_unmount_image().
669                 * wimlib_overwrite_xml_and_header() removed as
670                 wimlib_overwrite() suffices now.
671                 * wimlib_apply_image_to_ntfs_volume() removed as
672                 wimlib_extract_image() suffices now.
673                 * wimlib_add_image_from_ntfs_volume() removed as
674                 * wimlib_add_image() suffices now.
675
676         Previously, the soname of libwim.so has been 0.0.0, despite many
677         interface changes.  The soname is now updated to 1.0.0 and will now be
678         updated each release.
679
680 Version 1.1.0:
681         Resources will now be compressed using multiple threads by default.
682         (This applies to `imagex capture', `imagex append', and `imagex
683         export').
684
685         Some performance improvements in mounted WIMs.
686
687         More progress information is shown when capturing a WIM.
688
689 Version 1.0.4:
690         Lots of minor fixes, code cleanups, and some documentation updates.
691         Nothing in particular is really noteworthy.
692
693 Version 1.0.3:
694         LZX and XPRESS compression improvements.
695
696         Fixed calculation of Directory Count, File Count, Total Bytes, and Hard
697         Link Bytes of the WIM.
698
699 Version 1.0.2:
700         Fixed bug when capturing NTFS file with multiple named data streams.
701
702         Internally, we are now using inode structures, even though these don't
703         appear literally in the WIM file.  This simplifies some of the code
704         (mainly for WIM mounting) and likely fixed a few problems, although it
705         needs more testing.
706
707 Version 1.0.1:
708         Fixed problem when exporting images from XPRESS to LZX compressed WIM or
709         vice versa
710
711 Version 1.0.0:
712         Enough changes to call it version 1.0.0!
713
714         Capturing a WIM directly from a NTFS volume, and applying a WIM directly
715         to a NTFS volume, is now supported.
716
717         Hard links and symbolic links have much improved support.  They are
718         supported for WIM capture, WIM application, and mounted WIMs (you can
719         even make them on read-write mounted WIMs).
720
721         Alternate data streams are now supported on mounted WIMs through an
722         xattr or a Windows-style stream interface.  Also they are supported when
723         capturing a WIM from NTFS or applying a WIM to NTFS.
724
725         Split WIMs are better supported.  You may now apply an image directly
726         from a split WIM, mount an image from a split WIM read-only, or export
727         an image from a split WIM.
728
729         Using a capture configuration file is now supported (but not fully yet).
730
731         SHA1 message digests are checked in more places, so we can make sure
732         applied and captured data is correct.
733
734         Man pages have been updated and consolidated.
735
736 Version 0.7.2:
737         Fixed segfault when unmounting read-only WIM.
738
739 Version 0.7.1:
740         Support for joining and splitting WIMs.
741         Also, security data is now preserved by default.
742
743 Version 0.6.3:
744         Can now build with older gcc and system headers, like on CentOS 5.
745
746 Version 0.6.2:
747         Fixed bug that made it impossible to overwrite files in read-write
748         mount.
749
750 Version 0.6.1:
751         Write byte-order mark before WIM XML data.  (imagex.exe requires this to
752         be there.)