wimlib-imagex: Support being invoked as wimCOMMAND
[wimlib] / NEWS
1 Only the most important changes more recent than version 0.6 are noted here.
2
3 Version 1.5.0:
4         Added support for "pipable" WIMs.  This support allows capturing images
5         to standard output or applying images from standard input, but they are
6         not compatible with Microsoft's software and are not created by default.
7         See documentation for --pipable flag of `wimlib-imagex capture' for more
8         information.  Two new functions have been added to the library to fully
9         support this: wimlib_write_to_fd() and wimlib_extract_image_from_pipe().
10
11         wimlib now preserve WIM integrity tables by default, even if
12         WIMLIB_WRITE_FLAG_CHECK_INTEGRITY is not specified.  This changes the
13         behavior of `wimlib-imagex' whenever the WIM being operated on contains
14         an integrity table and the '--check' option is not specified.
15
16         `wimlib-imagex capture' now creates LZX-compressed WIMs by default
17         (when --compress is not specified).  This provides the best compression
18         ratio by default, which is usually what is desired, at a cost of some
19         speed.
20
21         Security descriptors are now extracted correctly on Windows.
22
23         `mkwinpeimg' now supports grabbing files from the WAIK supplement rather
24         than the WAIK itself.
25
26         The test suite no longer fails when run in a locale where the decimal
27         separator is not a period.
28
29         WIMLIB_PROGRESS_MSG_EXTRACT_DENTRY has been removed and
30         WIMLIB_EXTRACT_FLAG_VERBOSE re-reserved for future use.
31
32         The extraction code has been rewritten and it will now be easier to
33         support new features on all supported backends (currently Win32, UNIX,
34         and NTFS-3g).  For example, hard-linked extraction mode (--hardlink) is
35         now supported on all backends, not just UNIX.
36
37         A few changes were made to the error codes returned by library routines.
38
39 Version 1.4.2:
40         Fixed bug in `wimlib-imagex export' that made it impossible to export an
41         image from a WIM that is readonly at the filesystem level.
42
43         Return error code rather than segfaulting when trying to list files from
44         a non-first part of a split WIM.
45
46         Joining a WIM will now preserve the RP_FIX and READONLY flags.
47
48 Version 1.4.1:
49         On Windows, paths given to wimlib-imagex are now treated case
50         insensitively.
51
52         Improved behavior regarding invalid filenames; in particular, on
53         Windows, wimlib-imagex will, when extracting, now omit (with an option
54         to override this default) filenames differing only in case, or filenames
55         containing characters not valid on Windows.
56
57         On Windows, wimlib now supports capturing and extracting long paths
58         (longer than the so-called MAX_PATH).
59
60         On Windows, `wimlib-imagex update' now acquires proper privileges when
61         running as an Administrator.
62
63         `wimlib-imagex update' will now complain if no image is specified when
64         trying to update a multi-image WIM.
65
66         `wimlib-imagex update' now supports specifying a single update command
67         directly on the command line using the --command option.
68
69         wimlib-imagex will now choose different units for progress messages,
70         depending on the amount of data that needs to be processed.
71
72         `wimlib-imagex append' will now generate a unique WIM image name if no
73         name is specified and the defaulted name already exists in the WIM.
74
75         wimlib now allows you to create unnamed WIM images, which can then only
76         be referred to by index.
77
78         wimlib now allows you to explicitly declare you want write access to a
79         WIM by providing the WIMLIB_OPEN_FLAG_WRITE_ACCESS flag to
80         wimlib_open_wim().
81
82         wimlib now respects the WIM_HDR_FLAG_READONLY flag when set in the WIM
83         header.
84
85         Progress callbacks have been added to wimlib's wimlib_update_image()
86         function.
87
88         Added wimlib_get_wim_info(), wimlib_set_wim_info(),
89         wimlib_iterate_dir_tree(), and wimlib_iterate_lookup_table() functions
90         to the library.
91
92         NTFS-3g capture now only warns about two conditions previously treated
93         as errors.
94
95         Fixed a couple issues with using wimlib-imagex on UDF filesystems on
96         Windows.
97
98         wimlib now correctly detects and returns an error when reading a WIM
99         image with a cyclic directory structure.  (Fun fact: such a WIM will
100         crash Microsoft's software.)
101
102 Version 1.4.0:
103         Added new "extract" and "update" subcommands to wimlib-imagex, along
104         with associated APIs in the library.  These commands are intended mainly
105         for Windows use but can be used on UNIX as well.
106
107         Many documentation improvements.
108
109         Fixed a bug in the Windows build where relative symbolic links were not
110         captured in reparse-point fixup mode.
111
112         Fixed a bug in the Windows build where file handles were left open to
113         the WIM file, causing `wimlib_imagex optimize' to fail in some cases.
114
115         Fixed a bug in the Windows build of wimlib-imagex where globbing
116         split-WIM parts could cause the program to crash.
117
118         Fixed a bug where the creation time of WIM images would be shown instead
119         of the last modification time.
120
121         With the Windows build it is now possible to restore a WIM containing
122         symbolic links as a non-Administrator; however you will receive warnings
123         about not being able to extract the symbolic links.
124
125 Version 1.3.3:
126         Capturing a WIM image should now be significantly faster in most cases
127         due to improved use of the operating system's cache and avoiding reading
128         files twice whenever possible.
129
130         The Windows build should now work on Windows XP.
131
132         The Windows build now supports capturing and restoring hidden,
133         compressed, sparse, and encrypted files.
134
135         The Windows build now supports capturing and applying WIM images from
136         filesystems other than NTFS (with some reduced functionality).
137
138         The Windows build now extracts short names correctly.
139
140         Added support for "reparse-point" fixups (i.e. fixing up of symbolic
141         links).  See docs for --rpfix and --norpfix flags of `wimlib-imagex
142         capture' and `wimlib-imagex apply'.
143
144         The performance of splitting and joining WIMs should be slightly
145         improved.
146
147         The LZX and XPRESS compression and decompression functions are now
148         exported from the library.
149
150 Version 1.3.2:
151         Improvements and bugfixes for the Windows build.
152
153         Added --strict-acls options.
154
155         Fixed the way that wimlib determines the order of images in the WIM.
156
157 Version 1.3.1:
158         Since wimlib can now be used on Windows, wimlib's implementation of
159         ImageX has been renamed to wimlib-imagex to avoid confusion with
160         Microsoft's implementation of ImageX, which would have the same file
161         name ("imagex.exe").  If you really don't like this you can pass the
162         --with-imagex-progname option to `configure' to choose a different name,
163         or even simply rename the binary yourself (but the former way will
164         configure the man pages to use the chosen name).
165
166         Various bugs fixed in the Windows build.  Mainly to do with capturing
167         and restoring alternate data streams correctly in weird cases, and
168         requesting the correct privileges when opening files.  Also added the
169         --noacls options to wimlib-imagex capture, append, and apply.
170
171         Windows build again: FindFirstStreamW() and FindNextStreamW() are now
172         dynamically loaded, so this may make the library compatible with Windows
173         XP (however, there may still be other problems).
174
175 Version 1.3.0:
176         Added experimental support for native Windows builds.  Binaries can be
177         downloaded from the SourceForge page.
178
179         --source-list option added to `imagex capture' and `imagex append'.
180
181         Better support for different character encodings.
182
183 Version 1.2.6:
184         Storing UNIX file owners, groups, and modes in WIM images is now
185         possible using `imagex capture' with the --unix-data flag.
186
187         Minor bug fixes and documentation fixes.
188
189 Version 1.2.5:
190         NTFS capture: Fixed capturing duplicate reparse points.
191
192         NTFS capture: Capture first unnamed stream if there are more than one
193         (print warning instead of error).
194
195         Allow multiple test cases to execute concurrently (e.g. make -j2 check).
196
197 Version 1.2.4:
198         Added --arch switch to mkwinpeimg script to support getting AMD64 WinPE
199         from the WAIK.
200
201         Update to work with ntfs-3g version 2013.1.13.
202
203 Version 1.2.3:
204         Fixed truncating file to shorter but non-zero length on read-write
205         mounted WIM image.
206
207         Various code cleanups and minor documentation fixes.
208
209 Version 1.2.2:
210         LZX and XPRESS decompression have received some additional optimizations
211         and should now be even faster.  (Although, they were already pretty
212         fast--- much faster than typical I/O speeds.)
213
214         Fixed a bug introduced in v1.2.1 that would cause a directory tree
215         containing hard links to be captured incorrectly in some cases.
216
217 Version 1.2.1:
218         By default, unmounting a read-write mounted WIM with 'imagex unmount
219         --commit' will now change the WIM in-place without needing to write the
220         entire WIM again.  Use 'imagex unmount --commit --rebuild' to get the
221         old behavior.
222
223         'imagex unmount' no longer has a hard-coded limit of 10 minutes to wait
224         for a response from the daemon servicing the mounted WIM.  Instead,
225         every second 'imagex unmount' will check if the daemon is still alive,
226         and keep waiting if so, otherwise terminate with an error.
227
228         'imagex unmount --commit' on a read-write mounted WIM will now print
229         progress information regarding the writing of new or modified streams
230         the WIM, just like when capturing or appending a WIM.
231
232         A small change has been made to XPRESS compression and it should improve
233         the compression ratio slightly.
234
235         A change was made that may improve performance slightly when applying a
236         WIM image to a NTFS volume.
237
238         Microsoft has managed to introduce even more bugs into their software,
239         and now the WIMs for Windows 8 have incorrect (too low) reference counts
240         for some streams.  This is unsafe because such streams can be removed
241         when they are in actuality still referenced in the WIM (perhaps by a
242         different image).  wimlib will now work around this problem by fixing
243         the stream reference counts.  This is only done when wimlib_delete_image() is
244         called ('imagex delete') or when wimlib_mount_image() is called with
245         WIMLIB_MOUNT_FLAG_READWRITE ('imagex mountrw').  Please note that this
246         requires reading the metadata for all images in the WIM, so this will
247         make these operations noticably slower on WIMs with multiple images.
248
249         Various other bugfixes.
250
251 Version 1.2.0:
252         Appending images to a WIM is now be done by default without re-building
253         the whole WIM.  Use the --rebuild flag to get the old behavior (which
254         was to re-build the entire WIM when a new image is appended).
255
256         A new command `imagex optimize' is now available to manually re-build a
257         WIM that has wasted space due to repeated appends.
258
259         Progress information has been improved, and now arbitrary callback
260         functions can be used to show the progress of a WIM operation.
261
262         A possible bug with changing the bootable image of a WIM was fixed.
263
264         Some advisory locking is now done to prevent two processes from
265         modifying a WIM at the same time (but only in some cases).  For example,
266         you cannot mount two images from a WIM read-write at the same time.
267
268         Some functions have been reorganized:
269                 * wimlib_mount() renamed to wimlib_mount_image().
270                 * wimlib_unmount() renamed to wimlib_unmount_image().
271                 * wimlib_overwrite_xml_and_header() removed as
272                 wimlib_overwrite() suffices now.
273                 * wimlib_apply_image_to_ntfs_volume() removed as
274                 wimlib_extract_image() suffices now.
275                 * wimlib_add_image_from_ntfs_volume() removed as
276                 * wimlib_add_image() suffices now.
277
278         Previously, the soname of libwim.so has been 0.0.0, despite many
279         interface changes.  The soname is now updated to 1.0.0 and will now be
280         updated each release.
281
282 Version 1.1.0:
283         Resources will now be compressed using multiple threads by default.
284         (This applies to `imagex capture', `imagex append', and `imagex
285         export').
286
287         Some performance improvements in mounted WIMs.
288
289         More progress information is shown when capturing a WIM.
290
291 Version 1.0.4:
292         Lots of minor fixes, code cleanups, and some documentation updates.
293         Nothing in particular is really noteworthy.
294
295 Version 1.0.3:
296         LZX and XPRESS compression improvements.
297
298         Fixed calculation of Directory Count, File Count, Total Bytes, and Hard
299         Link Bytes of the WIM.
300
301 Version 1.0.2:
302         Fixed bug when capturing NTFS file with multiple named data streams.
303
304         Internally, we are now using inode structures, even though these don't
305         appear literally in the WIM file.  This simplifies some of the code
306         (mainly for WIM mounting) and likely fixed a few problems, although it
307         needs more testing.
308
309 Version 1.0.1:
310         Fixed problem when exporting images from XPRESS to LZX compressed WIM or
311         vice versa
312
313 Version 1.0.0:
314         Enough changes to call it version 1.0.0!
315
316         Capturing a WIM directly from a NTFS volume, and applying a WIM directly
317         to a NTFS volume, is now supported.
318
319         Hard links and symbolic links have much improved support.  They are
320         supported for WIM capture, WIM application, and mounted WIMs (you can
321         even make them on read-write mounted WIMs).
322
323         Alternate data streams are now supported on mounted WIMs through an
324         xattr or a Windows-style stream interface.  Also they are supported when
325         capturing a WIM from NTFS or applying a WIM to NTFS.
326
327         Split WIMs are better supported.  You may now apply an image directly
328         from a split WIM, mount an image from a split WIM read-only, or export
329         an image from a split WIM.
330
331         Using a capture configuration file is now supported (but not fully yet).
332
333         SHA1 message digests are checked in more places, so we can make sure
334         applied and captured data is correct.
335
336         Man pages have been updated and consolidated.
337
338 Version 0.7.2:
339         Fixed segfault when unmounting read-only WIM.
340
341 Version 0.7.1:
342         Support for joining and splitting WIMs.
343         Also, security data is now preserved by default.
344
345 Version 0.6.3:
346         Can now build with older gcc and system headers, like on CentOS 5.
347
348 Version 0.6.2:
349         Fixed bug that made it impossible to overwrite files in read-write
350         mount.
351
352 Version 0.6.1:
353         Write byte-order mark before WIM XML data.  (imagex.exe requires this to
354         be there.)