wimlib.net Git - wimlib/blob - doc/imagex-capture.1.in

   1 .TH IMAGEX "1" "May 2012" "imagex (wimlib) wimlib @VERSION@" "User Commands"
   2 .SH NAME
   3 imagex capture \- Create a new WIM file from a directory.
   4
   5 .SH SYNOPSIS
   6 \fBimagex capture\fR \fIDIRECTORY\fR \fIWIMFILE\fR [\fIIMAGE_NAME\fR] \
   7 [\fIDESCRIPTION\fR] [\fIOPTION\fR]...
   8
   9 .SH DESCRIPTION
  10 .PP
  11
  12 Captures a WIM image from \fIDIRECTORY\fR and creates a new WIM archive,
  13 \fIWIMFILE\fR, that contains it.  \fIDIRECTORY\fR becomes the root directory of
  14 the image.
  15
  16 \fIIMAGE_NAME\fR and \fIDESCRIPTION\fR specify the name and description of the
  17 new image.  If \fIIMAGE_NAME\fR is not given, it is taken to be the same as the
  18 base name of \fIDIRECTORY\fR.  If \fIDESCRIPTION\fR is not given, the
  19 description is taken to be empty.
  20
  21 .SH OPTIONS
  22 .TP 6
  23 \fB--boot\fR
  24 Specifies that the new image is to be made the bootable image of the WIM archive.
  25 .TP
  26 \fB--check\fR
  27 Include an integrity table in the new WIM file.
  28 .TP
  29 \fB--compress\fR[=\fITYPE\fR]
  30 Specifies the compression type for the WIM file.  \fITYPE\fR may be "none",
  31 "maximum", or "fast".  By default, the compression type is "none".  If \fB--compress\fR
  32 is specified but \fITYPE\fR is not, the compression type is taken to be
  33 "maximum", which is LZX compression.  "fast" compression is XPRESS compression.
  34 .TP
  35 \fB--flags\fR \fIEDITIONID\fR
  36 Specify a string to use in the <FLAGS> element of the XML data for the image.
  37 .TP
  38 \fB--verbose\fR
  39 Print the names of files and directories as they are captured.
  40 .TP
  41 \fB--dereference\fR
  42 Follow symlinks; archive and dump the files they point to.  (The default is to
  43 archive the symlinks themselves)
  44
  45 .SH EXAMPLES
  46 .IP
  47 image capture boot boot.wim --compress=maximum --check
  48 .LP
  49 Create a new WIM 'boot.wim' from the directory 'boot', using LZX compression and
  50 including an integrity table.
  51
  52 .SH SEE ALSO
  53 .BR imagex (1)
  54