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