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