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