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