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