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