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