]> wimlib.net Git - wimlib/blobdiff - doc/man1/imagex-export.1.in
wimexport: Document --wimboot option
[wimlib] / doc / man1 / imagex-export.1.in
index a024e38315d97af8f66c7f026b8d6de875db7b51..eeefe592f6a33c8ab8714a7619e7479d6dd216f7 100644 (file)
@@ -1,4 +1,4 @@
-.TH WIMLIB-IMAGEX "1" "March 2014" "@IMAGEX_PROGNAME@ @VERSION@" "User Commands"
+.TH WIMLIB-IMAGEX "1" "May 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
@@ -8,7 +8,7 @@
 .SH DESCRIPTION
 Copies the specified image in \fISRC_WIMFILE\fR to \fIDEST_WIMFILE\fR,
 optionally changing its name and/or description and/or compression type.
-If \fIDEST_WIMFILE\fR exists, it is taken be be a WIM archive to which the image
+If \fIDEST_WIMFILE\fR exists, it is taken be a WIM archive to which the image
 will be appended.  Otherwise, it is created as a new WIM archive containing only
 the exported image.
 This command is also available as simply \fBwimexport\fR if the appropriate hard
@@ -85,14 +85,25 @@ 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--chunk-size\fR=\fISIZE\fR
+Set the WIM compression chunk size to \fISIZE\fR.  See the documentation for
+this option to \fB@IMAGEX_PROGNAME@ capture\fR (1) for more details.
+.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.
+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.
+Like \fB--chunk-size\fR, but set the chunk size used in packed resources.  See
+the documentation for this option to \fB@IMAGEX_PROGNAME@ capture\fR (1) for
+more details.
+.TP
+\fB--pack-compress\fR=\fITYPE\fR, \fB--solid-compress\fR=\fITYPE\fR
+Like \fB--compress\fR, but set the compression format used in packed resources.
+See the documentation for this option to \fB@IMAGEX_PROGNAME@ capture\fR (1) for
+more details.
 .TP
 \fB--threads\fR=\fINUM_THREADS\fR
 Number of threads to use for compressing data.  Default: autodetect (number of
@@ -124,6 +135,11 @@ existed and was already pipable, or was "-" (standard output).
 Build, or rebuild, \fIDEST_WIMFILE\fR as a normal, non-pipable WIM.  This is the
 default behavior, unless \fIDEST_WIMFILE\fR already existed and was already
 pipable, or if \fIDEST_WIMFILE\fR was "-" (standard output).
+.TP
+\fB--wimboot\fR
+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).
 .SH SPLIT WIMS
 You may use \fB@IMAGEX_PROGNAME@ export\fR to export images from a split WIM.
 The \fISRC_WIMFILE\fR argument must specify the first part of the split WIM,