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