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