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