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