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