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