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