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