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