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