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