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