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