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