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