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