More logical behavior when canonicalizing WIM paths
[wimlib] / NEWS
1 Only the most important changes more recent than version 0.6 are noted here.
2
3 Version 1.6.3-BETA:
4         Added support for "WIMBoot".  On any platform, you can now capture a WIM
5         as WIMBoot-compatible.  In addition, on Windows, you can now apply a WIM
6         archive in a special mode that causes extracted files to be externally
7         backed by the WIM archive.  See the documentation for the new
8         '--wimboot' option to wimcapture and wimapply for more information.
9
10         'add' commands passed to wimupdate will now replace existing
11         nondirectory files by default.  Use the --no-replace option to get the
12         old behavior.
13
14         Fixed reading out-of-order entries in lookup table of version 3584 WIM /
15         ESD files.
16
17         The shared library version has been bumped up; however, there are only a
18         few incompatibilities:
19
20                 - WIMLIB_COMPRESSION_TYPE_XPRESS is now 1 and
21                   WIMLIB_COMPRESSION_TYPE_LZX is now 2 (so it's the same as
22                   WIMGAPI).
23
24                 - 'struct wimlib_capture_config' has been removed.  The library
25                   now takes the path to the configuration file directly.  This
26                   affects wimlib_add_image(), wimlib_add_image_multisource(),
27                   and wimlib_update_image().  However no code changes are
28                   necessary if a NULL configuration was being used.
29
30                 - Removed deprecated functions: some (de)compression functions,
31                   wimlib_extract_files(), and wimlib_print_metadata().
32
33                 - WIM paths passed to progress functions now have a leading
34                   slash.
35
36 Version 1.6.2:
37         Case-insensitive comparisons of strings (e.g. filenames) containing
38         UTF-16 codepoints above 32767 are now done correctly.
39
40         Fixed build failure on Mac OS X.
41
42         wimunmount now provides the '--new-image' option to cause changes to a
43         read-write mounted image to be committed as a new image rather than as
44         an update of the mounted image.  (The corresponding new library flag is
45         WIMLIB_UNMOUNT_FLAG_NEW_IMAGE.)
46
47         The LZMS ("recovery") compression chunk size, or "dictionary size", may
48         now be up to 1 GiB (1,073,741,824 bytes).
49
50         The performance of LZX ("maximum") and LZMS ("recovery") compression
51         with large chunk sizes has been slightly improved.
52
53 Version 1.6.1:
54         Stored files with size exactly 4 GiB (4,294,967,296 bytes) are now
55         decompressed correctly.
56
57         Fixed a bug in the LZX compressor introduced in v1.5.3.  The bug
58         occurred in an unlikely case, and due to validity checks it did not
59         affect successfully created archives.
60
61         Fixed a minor compatibility issue with the LZMS compressor and
62         decompressor.  This is *not* the default compression type and was only
63         introduced in v1.6.0.  In the unlikely event that you created an
64         LZMS-compressed WIM with v1.6.0 and a checksum error is reported when
65         applying it with v1.6.1, decompress it with v1.6.0 then compress it with
66         v1.6.1.
67
68         Memory usage for LZMS and LZX compression has been decreased.
69
70         wimextract now allows wildcard characters in paths specified on the
71         command line.  Also, the '--strict-wildcards' option has been removed
72         and replaced with the inverse option '--nullglob'.  See the
73         documentation for wimextract for more details and changes.
74
75         The wimlib_extract_files() function is now considered deprecated in
76         favor of wimlib_extract_paths().
77
78         Fixed more permissions problems when extracting files on Windows.
79
80         A new '--no-attributes' option has been added to wimapply and
81         wimextract.  The library flag is WIMLIB_EXTRACT_FLAG_NO_ATTRIBUTES.
82
83         The default chunk size is now set correctly when changing the
84         compression type of a WIM, for example with 'wimoptimize'.
85
86         The '--metadata' option to wiminfo has been replaced with the
87         '--detailed' option to wimdir.
88
89         In relevant wimlib-imagex commands, '--solid' may now be used as an
90         alias for '--pack-streams'.
91
92 Version 1.6.0:
93         Support for extracting and updating the new version 3584 WIMs has been
94         added.  These WIMs typically pack many streams ("files") together into a
95         single compressed resource, thereby saving space.  This degrades the
96         performance of random access (such as that which occurs on a mounted
97         image), but optimizations have been implemented for extraction.  These
98         new WIM files also typically use a new compression format (LZMS), which
99         is similar to LZMA and can offer a better compression ratio than LZX.
100         These new WIM files can be created using `wimcapture' with
101         the '--compress=lzms --pack-streams' options.  Note: this new WIM format
102         is used by the Windows 8 web downloader, but important segments of the
103         raw '.esd' files are encrypted, so wimlib will not be able to extract
104         such files until they are first decrypted.
105
106         wimlib now supports extracting files and directories from a WIM image
107         based on a "listfile" that itself contains the list of paths to extract.
108         For `wimextract', the syntax is to specify @LISTFILE instead of a PATH,
109         and for the library itself, the new APIs are wimlib_extract_pathlist()
110         and wimlib_extract_paths().  Path globs containing wildcard characters
111         are supported.
112
113         For searching WIM files, wimlib now has configurable case sensitivity.
114         The default on Windows is still case-insensitive and the default on
115         UNIX-like systems is still case-sensitive, but this can be overridden
116         on either platform through flags to wimlib_global_init().  For
117         `wimlib-imagex', the environmental variable WIMLIB_IMAGEX_IGNORE_CASE
118         can be set to 1 or 0 for case-insensitive or case-sensitive behavior,
119         respectively.
120
121         Support for compression chunk sizes greater than the default of 32768
122         bytes has been added.  A larger chunk size typically results in a better
123         compression ratio.  However, the MS implementation is seemingly not
124         compatible with all chunk sizes, especially for LZX compression, so the
125         defaults remain unchanged, with the exception of the new LZMS-compressed
126         WIMs, which use a larger chunk size by default.
127
128         The compression/decompression API exported by wimlib has been changed.
129         Now one set of functions handles all supported compression formats.
130
131         `wimcapture' and `wimappend' will now display the progress of scanning
132         the directory tree to capture, in addition to the progress of writing
133         data to the WIM.  The '--verbose' option no longer does anything.  The
134         library API change for this is the addition of several members to
135         `struct wimlib_progress_info_scan' available to progress callbacks.
136
137         `mkwinpeimg' now correctly handles the '--start-script' option when the
138         start script is not in the working directory.
139
140         Sequential extraction, previously requested by using
141         WIMLIB_EXTRACT_FLAG_SEQUENTIAL, is now the default.
142         WIMLIB_EXTRACT_FLAG_FILE_ORDER can be used to get the old default
143         behavior (extract in file order).
144
145 Version 1.5.3:
146         The new LZX compressor added in v1.5.2 has been improved and is now
147         enabled by default, except when `wimcapture' or `wimappend' is run
148         *without* the '--compress' option, in which case the faster LZX
149         compressor is used (the same as before).  This behavior is reasonably
150         consistent with ImageX which actually uses "fast" (XPRESS) compression
151         by default.  In those cases, use '--compress=maximum' to explicitly
152         capture a WIM image using the new (slower but better) LZX compressor.
153
154         The '--compress-slow' option still exists to `wimlib-imagex optimize',
155         but its new behavior is to tweak the new LZX compressor even more to
156         produce an even better compression ratio at the cost of more time spent
157         compressing.
158
159         `wimlib-imagex optimize' now supports the '--compress=TYPE' option,
160         which recompresses the WIM file using the specified compression TYPE.
161         The new library API function used for this is
162         wimlib_set_output_compression_type().
163
164         Added the wimlib_get_xml_data() function to allow library clients to
165         easily retrieve the raw XML data from a WIM file if needed.
166
167         Fixed a bug that could cause an error code to be incorrectly returned
168         when writing XML data containing a <WINDOWS> element.
169
170         Mounted WIM images will now correctly show the default file stream even
171         if appears in the alternate data stream entries of the corresponding WIM
172         directory entry.
173
174 Version 1.5.2:
175         Added a new experimental LZX compressor which can be enabled by passing
176         '--compress-slow' to `wimlib-imagex capture' or `wimlib-imagex
177         optimize'.  (The latter is only applicable if the WIM is already
178         LZX-compressed and the '--recompress' option is also given.)  The
179         experimental compressor is much slower but compresses the data slightly
180         more --- currently usually to within a fraction of a percent of the
181         results from WIMGAPI/ImageX.
182
183         A workaround has been added for compatibility with versions of WinPE
184         that interpret alternate data stream entries in the boot WIM
185         incorrectly.
186
187         An alignment bug that caused a crash in the LZX decompressor on some
188         builds was fixed.
189
190         wimlib now attempts to clear the WIM_HDR_FLAG_WRITE_IN_PROGRESS flag in
191         the WIM header when restoring the previous state of a WIM it failed to
192         successfully update.
193
194         Added a workaround to avoid an access denied error on Windows when
195         replacing a WIM file that another process has opened.
196
197 Version 1.5.1:
198         wimlib can now open WinPE WIMs from WAIK v2.1, which had a quirk that
199         needed to be handled.
200
201         A bug in the interpretation of negative IMAGE indices in the
202         --update-of=[WIMFILE:]IMAGE option to `wimlib-imagex capture' and
203         `wimlib-imagex append' has been fixed.
204
205         A workaround has been added to successfully apply security descriptors
206         with empty DACLs when the NTFS-3g apply mode is being used with NTFS-3g
207         2013.1.13 or earlier.
208
209         `wimlib-imagex capture' can now accept the '--delta-from' option
210         multiple times.
211
212 Version 1.5.0:
213         Added support for "pipable" WIMs.  Pipable WIMs allow capturing images
214         to standard output and applying images from standard input, but they are
215         not compatible with Microsoft's software and are not created by default.
216         See the documentation for --pipable flag of `wimlib-imagex capture' for
217         more information.
218
219         To better support incremental backups, added support for declaring an
220         image as a modified form of another image.  See the documentation for
221         the '--update-of' option of `wimlib-imagex append' and `wimlib-imagex
222         capture'.
223
224         Added supported for "delta" WIMs.  See the documentation for the
225         '--delta-from' option of `wimlib-imagex capture'.
226
227         The library support for managing split WIMs has been changed to support
228         other arrangements, such as delta WIMs, and be easier to use.  This
229         change is visible in `wimlib-imagex', which also can now accept the
230         '--ref' option multiple times, and also now supports "delta" WIMs as
231         mentioned above.
232
233         wimlib now preserves WIM integrity tables by default, even if
234         WIMLIB_WRITE_FLAG_CHECK_INTEGRITY is not specified.  This changes the
235         behavior of `wimlib-imagex' whenever the WIM being operated on contains
236         an integrity table and the '--check' option is not specified.
237
238         `wimlib-imagex capture' now creates LZX-compressed WIMs by default
239         (when --compress is not specified).  This provides the best compression
240         ratio by default, which is usually what is desired, at a cost of some
241         speed.
242
243         `wimlib-imagex' now supports being invoked as wimCOMMAND, where COMMAND
244         is the command as in `wimlib-imagex COMMAND'; for example, it can be
245         invoked as `wimapply' as an alternative to `wimlib-imagex apply'.  The
246         appropriate hard links are created in UNIX installations of
247         `wimlib-imagex', while for the Windows distribution of `wimlib-imagex',
248         batch files that emulate this behavior are generated.
249
250         Security descriptors are now extracted correctly on Windows.
251
252         Fixed archiving DOS names in NTFS-3g capture mode.
253
254         The extraction code has been rewritten and it will now be easier to
255         support new features on all supported backends (currently Win32, UNIX,
256         and NTFS-3g).  For example, hard-linked extraction mode (--hardlink) is
257         now supported on all backends, not just UNIX.
258
259         `mkwinpeimg' now supports grabbing files from the WAIK supplement rather
260         than the WAIK itself.
261
262         wimlib_global_init() now, by default, attempts to acquire additional
263         privileges on Windows, so library clients need not do this.
264
265         This update bumps the shared library version number up to 9, since it is
266         not binary compatibible with previous releases.
267
268 Version 1.4.2:
269         Fixed bug in `wimlib-imagex export' that made it impossible to export an
270         image from a WIM that is readonly at the filesystem level.
271
272         Return error code rather than segfaulting when trying to list files from
273         a non-first part of a split WIM.
274
275         Joining a WIM will now preserve the RP_FIX and READONLY flags.
276
277 Version 1.4.1:
278         On Windows, paths given to wimlib-imagex are now treated case
279         insensitively.
280
281         Improved behavior regarding invalid filenames; in particular, on
282         Windows, wimlib-imagex will, when extracting, now omit (with an option
283         to override this default) filenames differing only in case, or filenames
284         containing characters not valid on Windows.
285
286         On Windows, wimlib now supports capturing and extracting long paths
287         (longer than the so-called MAX_PATH).
288
289         On Windows, `wimlib-imagex update' now acquires proper privileges when
290         running as an Administrator.
291
292         `wimlib-imagex update' will now complain if no image is specified when
293         trying to update a multi-image WIM.
294
295         `wimlib-imagex update' now supports specifying a single update command
296         directly on the command line using the --command option.
297
298         wimlib-imagex will now choose different units for progress messages,
299         depending on the amount of data that needs to be processed.
300
301         `wimlib-imagex append' will now generate a unique WIM image name if no
302         name is specified and the defaulted name already exists in the WIM.
303
304         wimlib now allows you to create unnamed WIM images, which can then only
305         be referred to by index.
306
307         wimlib now allows you to explicitly declare you want write access to a
308         WIM by providing the WIMLIB_OPEN_FLAG_WRITE_ACCESS flag to
309         wimlib_open_wim().
310
311         wimlib now respects the WIM_HDR_FLAG_READONLY flag when set in the WIM
312         header.
313
314         Progress callbacks have been added to wimlib's wimlib_update_image()
315         function.
316
317         Added wimlib_get_wim_info(), wimlib_set_wim_info(),
318         wimlib_iterate_dir_tree(), and wimlib_iterate_lookup_table() functions
319         to the library.
320
321         NTFS-3g capture now only warns about two conditions previously treated
322         as errors.
323
324         Fixed a couple issues with using wimlib-imagex on UDF filesystems on
325         Windows.
326
327         wimlib now correctly detects and returns an error when reading a WIM
328         image with a cyclic directory structure.  (Fun fact: such a WIM will
329         crash Microsoft's software.)
330
331 Version 1.4.0:
332         Added new "extract" and "update" subcommands to wimlib-imagex, along
333         with associated APIs in the library.  These commands are intended mainly
334         for Windows use but can be used on UNIX as well.
335
336         Many documentation improvements.
337
338         Fixed a bug in the Windows build where relative symbolic links were not
339         captured in reparse-point fixup mode.
340
341         Fixed a bug in the Windows build where file handles were left open to
342         the WIM file, causing `wimlib_imagex optimize' to fail in some cases.
343
344         Fixed a bug in the Windows build of wimlib-imagex where globbing
345         split-WIM parts could cause the program to crash.
346
347         Fixed a bug where the creation time of WIM images would be shown instead
348         of the last modification time.
349
350         With the Windows build it is now possible to restore a WIM containing
351         symbolic links as a non-Administrator; however you will receive warnings
352         about not being able to extract the symbolic links.
353
354 Version 1.3.3:
355         Capturing a WIM image should now be significantly faster in most cases
356         due to improved use of the operating system's cache and avoiding reading
357         files twice whenever possible.
358
359         The Windows build should now work on Windows XP.
360
361         The Windows build now supports capturing and restoring hidden,
362         compressed, sparse, and encrypted files.
363
364         The Windows build now supports capturing and applying WIM images from
365         filesystems other than NTFS (with some reduced functionality).
366
367         The Windows build now extracts short names correctly.
368
369         Added support for "reparse-point" fixups (i.e. fixing up of symbolic
370         links).  See docs for --rpfix and --norpfix flags of `wimlib-imagex
371         capture' and `wimlib-imagex apply'.
372
373         The performance of splitting and joining WIMs should be slightly
374         improved.
375
376         The LZX and XPRESS compression and decompression functions are now
377         exported from the library.
378
379 Version 1.3.2:
380         Improvements and bugfixes for the Windows build.
381
382         Added --strict-acls options.
383
384         Fixed the way that wimlib determines the order of images in the WIM.
385
386 Version 1.3.1:
387         Since wimlib can now be used on Windows, wimlib's implementation of
388         ImageX has been renamed to wimlib-imagex to avoid confusion with
389         Microsoft's implementation of ImageX, which would have the same file
390         name ("imagex.exe").  If you really don't like this you can pass the
391         --with-imagex-progname option to `configure' to choose a different name,
392         or even simply rename the binary yourself (but the former way will
393         configure the man pages to use the chosen name).
394
395         Various bugs fixed in the Windows build.  Mainly to do with capturing
396         and restoring alternate data streams correctly in weird cases, and
397         requesting the correct privileges when opening files.  Also added the
398         --noacls options to wimlib-imagex capture, append, and apply.
399
400         Windows build again: FindFirstStreamW() and FindNextStreamW() are now
401         dynamically loaded, so this may make the library compatible with Windows
402         XP (however, there may still be other problems).
403
404 Version 1.3.0:
405         Added experimental support for native Windows builds.  Binaries can be
406         downloaded from the SourceForge page.
407
408         --source-list option added to `imagex capture' and `imagex append'.
409
410         Better support for different character encodings.
411
412 Version 1.2.6:
413         Storing UNIX file owners, groups, and modes in WIM images is now
414         possible using `imagex capture' with the --unix-data flag.
415
416         Minor bug fixes and documentation fixes.
417
418 Version 1.2.5:
419         NTFS capture: Fixed capturing duplicate reparse points.
420
421         NTFS capture: Capture first unnamed stream if there are more than one
422         (print warning instead of error).
423
424         Allow multiple test cases to execute concurrently (e.g. make -j2 check).
425
426 Version 1.2.4:
427         Added --arch switch to mkwinpeimg script to support getting AMD64 WinPE
428         from the WAIK.
429
430         Update to work with ntfs-3g version 2013.1.13.
431
432 Version 1.2.3:
433         Fixed truncating file to shorter but non-zero length on read-write
434         mounted WIM image.
435
436         Various code cleanups and minor documentation fixes.
437
438 Version 1.2.2:
439         LZX and XPRESS decompression have received some additional optimizations
440         and should now be even faster.  (Although, they were already pretty
441         fast--- much faster than typical I/O speeds.)
442
443         Fixed a bug introduced in v1.2.1 that would cause a directory tree
444         containing hard links to be captured incorrectly in some cases.
445
446 Version 1.2.1:
447         By default, unmounting a read-write mounted WIM with 'imagex unmount
448         --commit' will now change the WIM in-place without needing to write the
449         entire WIM again.  Use 'imagex unmount --commit --rebuild' to get the
450         old behavior.
451
452         'imagex unmount' no longer has a hard-coded limit of 10 minutes to wait
453         for a response from the daemon servicing the mounted WIM.  Instead,
454         every second 'imagex unmount' will check if the daemon is still alive,
455         and keep waiting if so, otherwise terminate with an error.
456
457         'imagex unmount --commit' on a read-write mounted WIM will now print
458         progress information regarding the writing of new or modified streams
459         the WIM, just like when capturing or appending a WIM.
460
461         A small change has been made to XPRESS compression and it should improve
462         the compression ratio slightly.
463
464         A change was made that may improve performance slightly when applying a
465         WIM image to a NTFS volume.
466
467         Microsoft has managed to introduce even more bugs into their software,
468         and now the WIMs for Windows 8 have incorrect (too low) reference counts
469         for some streams.  This is unsafe because such streams can be removed
470         when they are in actuality still referenced in the WIM (perhaps by a
471         different image).  wimlib will now work around this problem by fixing
472         the stream reference counts.  This is only done when wimlib_delete_image() is
473         called ('imagex delete') or when wimlib_mount_image() is called with
474         WIMLIB_MOUNT_FLAG_READWRITE ('imagex mountrw').  Please note that this
475         requires reading the metadata for all images in the WIM, so this will
476         make these operations noticably slower on WIMs with multiple images.
477
478         Various other bugfixes.
479
480 Version 1.2.0:
481         Appending images to a WIM is now be done by default without re-building
482         the whole WIM.  Use the --rebuild flag to get the old behavior (which
483         was to re-build the entire WIM when a new image is appended).
484
485         A new command `imagex optimize' is now available to manually re-build a
486         WIM that has wasted space due to repeated appends.
487
488         Progress information has been improved, and now arbitrary callback
489         functions can be used to show the progress of a WIM operation.
490
491         A possible bug with changing the bootable image of a WIM was fixed.
492
493         Some advisory locking is now done to prevent two processes from
494         modifying a WIM at the same time (but only in some cases).  For example,
495         you cannot mount two images from a WIM read-write at the same time.
496
497         Some functions have been reorganized:
498                 * wimlib_mount() renamed to wimlib_mount_image().
499                 * wimlib_unmount() renamed to wimlib_unmount_image().
500                 * wimlib_overwrite_xml_and_header() removed as
501                 wimlib_overwrite() suffices now.
502                 * wimlib_apply_image_to_ntfs_volume() removed as
503                 wimlib_extract_image() suffices now.
504                 * wimlib_add_image_from_ntfs_volume() removed as
505                 * wimlib_add_image() suffices now.
506
507         Previously, the soname of libwim.so has been 0.0.0, despite many
508         interface changes.  The soname is now updated to 1.0.0 and will now be
509         updated each release.
510
511 Version 1.1.0:
512         Resources will now be compressed using multiple threads by default.
513         (This applies to `imagex capture', `imagex append', and `imagex
514         export').
515
516         Some performance improvements in mounted WIMs.
517
518         More progress information is shown when capturing a WIM.
519
520 Version 1.0.4:
521         Lots of minor fixes, code cleanups, and some documentation updates.
522         Nothing in particular is really noteworthy.
523
524 Version 1.0.3:
525         LZX and XPRESS compression improvements.
526
527         Fixed calculation of Directory Count, File Count, Total Bytes, and Hard
528         Link Bytes of the WIM.
529
530 Version 1.0.2:
531         Fixed bug when capturing NTFS file with multiple named data streams.
532
533         Internally, we are now using inode structures, even though these don't
534         appear literally in the WIM file.  This simplifies some of the code
535         (mainly for WIM mounting) and likely fixed a few problems, although it
536         needs more testing.
537
538 Version 1.0.1:
539         Fixed problem when exporting images from XPRESS to LZX compressed WIM or
540         vice versa
541
542 Version 1.0.0:
543         Enough changes to call it version 1.0.0!
544
545         Capturing a WIM directly from a NTFS volume, and applying a WIM directly
546         to a NTFS volume, is now supported.
547
548         Hard links and symbolic links have much improved support.  They are
549         supported for WIM capture, WIM application, and mounted WIMs (you can
550         even make them on read-write mounted WIMs).
551
552         Alternate data streams are now supported on mounted WIMs through an
553         xattr or a Windows-style stream interface.  Also they are supported when
554         capturing a WIM from NTFS or applying a WIM to NTFS.
555
556         Split WIMs are better supported.  You may now apply an image directly
557         from a split WIM, mount an image from a split WIM read-only, or export
558         an image from a split WIM.
559
560         Using a capture configuration file is now supported (but not fully yet).
561
562         SHA1 message digests are checked in more places, so we can make sure
563         applied and captured data is correct.
564
565         Man pages have been updated and consolidated.
566
567 Version 0.7.2:
568         Fixed segfault when unmounting read-only WIM.
569
570 Version 0.7.1:
571         Support for joining and splitting WIMs.
572         Also, security data is now preserved by default.
573
574 Version 0.6.3:
575         Can now build with older gcc and system headers, like on CentOS 5.
576
577 Version 0.6.2:
578         Fixed bug that made it impossible to overwrite files in read-write
579         mount.
580
581 Version 0.6.1:
582         Write byte-order mark before WIM XML data.  (imagex.exe requires this to
583         be there.)