]> wimlib.net Git - wimlib/blobdiff - doc/man1/imagex-export.1.in
v1.7.1
[wimlib] / doc / man1 / imagex-export.1.in
index 4d4d6c2e6e979eed8167cd65e319a05796a91064..c380d6e91929ba65abea310fc45a208b5ce79294 100644 (file)
@@ -1,4 +1,4 @@
-.TH WIMLIB-IMAGEX "1" "May 2014" "@IMAGEX_PROGNAME@ @VERSION@" "User Commands"
+.TH WIMLIB-IMAGEX "1" "August 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
@@ -64,45 +64,37 @@ If neither \fB--check\fR nor \fB--nocheck\fR is specified, an integrity
 table is included in \fIDEST_WIMFILE\fR if and only if \fIDEST_WIMFILE\fR
 already existed and it had an integrity table before.
 .TP
-\fB--compress\fR=\fITYPE\fR
-Specifies the compression type for \fIDEST_WIMFILE\fR.  This is only valid if
-\fIDEST_WIMFILE\fR does not yet exist, since if \fIDEST_WIMFILE\fR exists, the
-compression type must be the same as that of \fIDEST_WIMFILE\fR.
+\fB--compress\fR=\fITYPE\fR[:\fILEVEL\fR]
+Specifies the compression type, and optionally the compression level for that
+compression type, for \fIDEST_WIMFILE\fR.  Setting the compression type only has
+an effect if \fIDEST_WIMFILE\fR does not yet exist, since if \fIDEST_WIMFILE\fR
+exists, the compression type must be the same as that of \fIDEST_WIMFILE\fR.
 .IP ""
-\fITYPE\fR may be "none", "maximum", or "fast".  By default, it is the same as
-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.
+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.
+\fB--recompress\fR
+Force all exported data to be recompressed, even if the destination WIM will use
+the same compression type as the source WIM.
 .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
+\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.  See
-the documentation for this option to \fB@IMAGEX_PROGNAME@ capture\fR (1) for
-more details.
+\fB--solid-chunk-size\fR=\fISIZE\fR
+Like \fB--chunk-size\fR, but set the chunk size used in solid blocks.  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
+\fB--solid-compress\fR=\fITYPE\fR[:\fILEVEL\fR]
+Like \fB--compress\fR, but set the compression type used in solid blocks.  See
+the documentation for this option to \fB@IMAGEX_PROGNAME@ capture\fR (1) for
 more details.
 .TP
 \fB--threads\fR=\fINUM_THREADS\fR
@@ -135,6 +127,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,
@@ -178,7 +175,8 @@ WIMs, which usually contain LZMS-compressed solid blocks and may carry the
 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.
+format rather than in the newer format, specify \fB--compress\fR=\fILZX\fR (or
+\fB--compress\fR=\fImaximum\fR).
 .SH EXAMPLES
 Export the second image of 'boot.wim' to the new WIM file 'new.wim':
 .RS
@@ -191,7 +189,19 @@ The above example creates "new.wim" with the same compression type as
 \fB--compress\fR=\fITYPE\fR; for example:
 .RS
 .PP
-@IMAGEX_PROGNAME@ export boot.wim 2 new.wim --compress=maximum
+@IMAGEX_PROGNAME@ export boot.wim 2 new.wim --compress=LZX
+.RE
+.PP
+Export "ESD to WIM" --- that is, solid WIM to non-solid WIM:
+.RS
+.PP
+@IMAGEX_PROGNAME@ export install.esd all install.wim --compress=LZX
+.RE
+.PP
+Export "WIM to ESD" --- that is, non-solid WIM to solid WIM:
+.RS
+.PP
+@IMAGEX_PROGNAME@ export install.wim all install.esd --solid
 .RE
 .PP
 .SH SEE ALSO