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