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