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