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