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