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