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