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