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