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