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