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