doc: note that data integrity is not guaranteed in --unsafe-compact mode

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

diff --git a/doc/man1/wimlib-imagex-export.1 b/doc/man1/wimlib-imagex-export.1
index 5c3c4d073910deb0d284e74da35875a3152c0991..4c5430a48fb44bd10aa7a3a24dd6224e4e90f00b 100644 (file)
--- a/doc/man1/wimlib-imagex-export.1
+++ b/doc/man1/wimlib-imagex-export.1
@@ -1,4 +1,4 @@
-.TH WIMLIB-IMAGEX "1" "November 2014" "wimlib 1.7.3" "User Commands"
+.TH WIMLIB-IMAGEX "1" "August 2015" "wimlib 1.8.2" "User Commands"

 .SH NAME
 wimlib-imagex-export \- Exports an image from a WIM archive to an existing or new WIM archive
 .SH SYNOPSIS
 .SH NAME
 wimlib-imagex-export \- Exports an image from a WIM archive to an existing or new WIM archive
 .SH SYNOPSIS


@@ -88,12 +88,12 @@ compatibility.  See the documentation for this option to \fBwimlib-imagex
 capture\fR (1) for more details.
 .TP
 \fB--solid-chunk-size\fR=\fISIZE\fR
 capture\fR (1) for more details.
 .TP
 \fB--solid-chunk-size\fR=\fISIZE\fR

-Like \fB--chunk-size\fR, but set the chunk size used in solid blocks.  See the
+Like \fB--chunk-size\fR, but set the chunk size used in solid resources.  See the

 documentation for this option to \fBwimlib-imagex capture\fR (1) for more
 details.
 .TP
 \fB--solid-compress\fR=\fITYPE\fR[:\fILEVEL\fR]
 documentation for this option to \fBwimlib-imagex capture\fR (1) for more
 details.
 .TP
 \fB--solid-compress\fR=\fITYPE\fR[:\fILEVEL\fR]

-Like \fB--compress\fR, but set the compression type used in solid blocks.  See
+Like \fB--compress\fR, but set the compression type used in solid resources.  See

 the documentation for this option to \fBwimlib-imagex capture\fR (1) for
 more details.
 .TP
 the documentation for this option to \fBwimlib-imagex capture\fR (1) for
 more details.
 .TP


@@ -132,6 +132,9 @@ pipable, or if \fIDEST_WIMFILE\fR was "-" (standard output).
 Mark the destination image as WIMBoot-compatible.  Also, if exporting to a new
 archive, set the compression type to that recommended for WIMBoot (currently,
 XPRESS with 4096 byte chunks).
 Mark the destination image as WIMBoot-compatible.  Also, if exporting to a new
 archive, set the compression type to that recommended for WIMBoot (currently,
 XPRESS with 4096 byte chunks).

+.TP
+\fB--unsafe-compact\fR
+See the documentation for this option in \fBwimlib-imagex-optimize\fR (1).

 .SH SPLIT WIMS
 You may use \fBwimlib-imagex export\fR to export images from a split WIM.
 The \fISRC_WIMFILE\fR argument must specify the first part of the split WIM,
 .SH SPLIT WIMS
 You may use \fBwimlib-imagex export\fR to export images from a split WIM.
 The \fISRC_WIMFILE\fR argument must specify the first part of the split WIM,


@@ -156,12 +159,13 @@ To export the first image of this split WIM to a new or existing WIM file
 wimlib-imagex export mywim.swm 1 other.wim --ref="mywim*.swm"
 .RE
 .SH NOTES
 wimlib-imagex export mywim.swm 1 other.wim --ref="mywim*.swm"
 .RE
 .SH NOTES

-\fIData integrity\fR:  It is safe to abort a \fBwimlib-imagex export\fR command partway through.
-However, after doing this, it is recommended to run \fBwimlib-imagex
-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 rebuilt (e.g. with \fB--rebuild\fR), in which case you should
-delete the temporary file left over.
+\fIData integrity\fR: Except when using \fB--unsafe-compact\fR, it is safe to
+abort a \fBwimlib-imagex export\fR command partway through.  However, after
+doing this, it is recommended to run \fBwimlib-imagex 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
+rebuilt (e.g. with \fB--rebuild\fR), in which case you should delete the
+temporary file left over.

 .PP
 \fISingle instancing\fR: The WIM format uses single-instance streams (roughly,
 "files").  When an image is exported, only the streams ("files") not already
 .PP
 \fISingle instancing\fR: The WIM format uses single-instance streams (roughly,
 "files").  When an image is exported, only the streams ("files") not already


@@ -170,7 +174,7 @@ 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
 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
+WIMs, which usually contain LZMS-compressed solid resources 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
 \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