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