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