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