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