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