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