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