Cleanups

[wimlib] / doc / imagex-export.1.in

diff --git a/doc/imagex-export.1.in b/doc/imagex-export.1.in
index 1555e4f26bf779c247300ea65c870be2817a69a2..a024e38315d97af8f66c7f026b8d6de875db7b51 100644 (file)
--- a/doc/imagex-export.1.in
+++ b/doc/imagex-export.1.in
@@ -1,4 +1,4 @@
-.TH WIMLIB-IMAGEX "1" "October 2013" "@IMAGEX_PROGNAME@ @VERSION@" "User Commands"
+.TH WIMLIB-IMAGEX "1" "March 2014" "@IMAGEX_PROGNAME@ @VERSION@" "User Commands"
 .SH NAME
 @IMAGEX_PROGNAME@-export \- Exports an image from a WIM archive to an existing or new WIM archive
 .SH SYNOPSIS
@@ -74,6 +74,25 @@ that of the input WIM file.
 .IP ""
 You may also specify the actual names of the compression algorithms, "XPRESS"
 and "LZX", instead of "fast" and "maximum", respectively.
+.IP ""
+\fITYPE\fR may also be "recovery" (or "LZMS"); however, this will result in
+reduced compatibility.  See the documentation for this option to
+\fB@IMAGEX_PROGNAME@ capture\fR (1) for more details.
+.TP
+\fB--compress-slow\fR
+Spend even more time compressing the data to achieve a very slightly better
+compression ratio.  This currently only has an effect for LZX ("maximum") and
+LZMS ("recovery") compression.  This option does not itself set the compression
+format.
+.TP
+\fB--pack-streams\fR, \fB--solid\fR
+Create a "solid" archive that compresses multiple files together.  This can
+result in a higher compression ratio, but has disadvantages such as reduced
+compatibility; see the documentation for this option to
+\fB@IMAGEX_PROGNAME@ capture\fR (1) for more details.
+.TP
+\fB--pack-chunk-size\fR=\fISIZE\fR, \fB--solid-chunk-size\fR=\fISIZE\fR
+Like \fB--chunk-size\fR, but set the chunk size used in packed resources.
 .TP
 \fB--threads\fR=\fINUM_THREADS\fR
 Number of threads to use for compressing data.  Default: autodetect (number of
@@ -129,18 +148,26 @@ To export the first image of this split WIM to a new or existing WIM file
 @IMAGEX_PROGNAME@ export mywim.swm 1 other.wim --ref="mywim*.swm"
 .RE
 .SH NOTES
-It is safe to abort an \fB@IMAGEX_PROGNAME@ export\fR command partway through;
-however, after doing this, it is recommended to run \fB@IMAGEX_PROGNAME@
+\fIData integrity\fR:  It is safe to abort a \fB@IMAGEX_PROGNAME@ export\fR command partway through.
+However, after doing this, it is recommended to run \fB@IMAGEX_PROGNAME@
 optimize\fR on the destination WIM to remove any data that was appended to the
 physical WIM file but not yet incorporated into the structure of the WIM, unless
-the WIM was being rebuild (e.g. with \fB--rebuild\fR), in which case you should
+the WIM was being rebuilt (e.g. with \fB--rebuild\fR), in which case you should
 delete the temporary file left over.
 .PP
-Since the WIM format uses single-instancing (streams are content-addressed by
-SHA1 message digests), when an image is exported, only the streams not already
-present in the destination WIM need to be copied.  However, a new copy of the
-image's metadata resource always needs to be created.
+\fISingle instancing\fR: The WIM format uses single-instance streams (roughly,
+"files").  When an image is exported, only the streams ("files") not already
+present in the destination WIM will be copied.  However, a new copy of the
+image's metadata resource, which describes the full directory structure, will
+always be created.
 .PP
+\fIESD files\fR: wimlib v1.6.0 and later can export images from version 3584
+WIMs, which usually contain LZMS-compressed solid blocks and may carry the
+\fI.esd\fR file extension rather than \fI.wim\fR.  However, \fI.esd\fR files
+downloaded directly by the Windows 8 web downloader have encrypted segments, and
+wimlib cannot export images from such files until they are first decrypted.  In
+addition, to ensure the destination archive is created in the original WIM
+format rather than in the newer format, specify \fB--compress\fR=\fImaximum\fR.
 .SH EXAMPLES
 Export the second image of 'boot.wim' to the new WIM file 'new.wim':
 .RS