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