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