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