Update NEWS and documentation for WIMBoot
authorEric Biggers <ebiggers3@gmail.com>
Wed, 23 Apr 2014 21:24:06 +0000 (16:24 -0500)
committerEric Biggers <ebiggers3@gmail.com>
Wed, 23 Apr 2014 21:24:06 +0000 (16:24 -0500)
NEWS
doc/man1/imagex-apply.1.in
doc/man1/imagex-capture.1.in

diff --git a/NEWS b/NEWS
index a812d72..c415e0a 100644 (file)
--- a/NEWS
+++ b/NEWS
@@ -1,5 +1,13 @@
 Only the most important changes more recent than version 0.6 are noted here.
 
+Version 1.6.3-BETA:
+       Added support for "WIMBoot".  On any platform, you can now capture a WIM
+       as WIMBoot-compatible.  In addition, on Windows, specifically Windows
+       8.1 Update 1 and later, you can now apply a WIM archive in a special
+       mode that causes extracted files to be externally backed by the WIM
+       archive.  See the documentation for the new '--wimboot' option to
+       wimcapture and wimapply, respectively, for more information.
+
 Version 1.6.2:
        Case-insensitive comparisons of strings (e.g. filenames) containing
        UTF-16 codepoints above 32767 are now done correctly.
index e869174..9df08fd 100644 (file)
@@ -395,10 +395,23 @@ form.
 .TP
 \fB--wimboot\fR
 Windows only: Instead of extracting the files themselves, extract "pointer
-files" back to the original WIM.  This is only expected to work on Windows 8.1
-and later, since only those versions of Windows contain the Windows Overlay File
-System Filter Driver that is necessary for this feature.  See Microsoft's
-documentation for "WIMBoot" for more information.
+files" back to the WIM archive.  This can result in significant space savings.
+However, it comes at several potential costs, such as not being able to delete
+the WIM archive and possibly having slower access to files.  See Microsoft's
+documentation for "WIMBoot" for more information.  Also, this option only works
+when several conditions hold:
+.RS
+.IP \[bu] 4
+The operating system is Windows 8.1 update 1 or later, since that is the first
+version of Windows that contains the Windows Overlay File System Filter Driver
+("WOF") necessary for this feature.
+.IP \[bu]
+The program is run as an Administrator.
+.IP \[bu]
+The WIM archive is not solid (i.e. is not an "ESD file").
+.IP \[bu]
+The target volume is NTFS or another filesystem that supports reparse points.
+.RE
 .SH NOTES
 \fIData integrity\fR:  WIM files include SHA1 message digests for file data.
 \fB@IMAGEX_PROGNAME@ apply\fR calculates the SHA1 message digest of every file
index a6d93b0..c096b6a 100644 (file)
@@ -485,17 +485,6 @@ metadata, but this is typically only a small fraction of a WIM's total size.
 .IP ""
 This option can be specified multiple times, in which case the resulting delta
 WIM will only contain streams not present in any of the specified base
-.TP
-\fB--wimboot\fR
-Windows only: mark the image as WIMBoot-compatible.  See Microsoft's
-documentation for more information about WIMBoot.  This option will, by default,
-change the compression type to XPRESS and the chunk size to 4096 bytes; these
-can, however, still be overridden through the \fB--compress\fR and
-\fB--chunk-size\fR parameters, respectively.  In addition, this option will, by
-default, set the configuration file to
-\fISOURCE\fR\\Windows\\System32\\WimBootCompress.ini if present and accessible;
-however, this may still be overridden through the \fB--config\fR parameter.
-\fIWIMFILE\fRs.
 .IP ""
 To operate on the resulting delta WIM using other commands such as
 \fB@IMAGEX_PROGNAME@ apply\fR, you must specify the delta WIM as the WIM file to
@@ -543,6 +532,16 @@ fact combine \fB--pipable\fR and \fB--delta-from\fR to create pipable delta
 WIMs.  In such cases, the base WIM(s) must be captured as pipable as well as the
 delta WIM, and when applying an image, the base WIM(s) must be sent over the
 pipe after the delta WIM.
+.TP
+\fB--wimboot\fR
+Windows only: mark the image as WIMBoot-compatible.  See Microsoft's
+documentation for more information about WIMBoot.  This option will, by default,
+change the compression type to XPRESS and the chunk size to 4096 bytes; these
+can, however, still be overridden through the \fB--compress\fR and
+\fB--chunk-size\fR parameters, respectively.  In addition, this option will, by
+default, set the configuration file to
+\fISOURCE\fR\\Windows\\System32\\WimBootCompress.ini if present and accessible;
+however, this may still be overridden through the \fB--config\fR parameter.
 .SH NOTES
 \fB@IMAGEX_PROGNAME@ append\fR does not support appending an image to a split WIM.
 .PP