vcs.maemo.org Git - qemu/blob - qemu/qemu-img.1

   1 .\" Automatically generated by Pod::Man v1.34, Pod::Parser v1.13
   2 .\"
   3 .\" Standard preamble:
   4 .\" ========================================================================
   5 .de Sh \" Subsection heading
   6 .br
   7 .if t .Sp
   8 .ne 5
   9 .PP
  10 \fB\\$1\fR
  11 .PP
  12 ..
  13 .de Sp \" Vertical space (when we can't use .PP)
  14 .if t .sp .5v
  15 .if n .sp
  16 ..
  17 .de Vb \" Begin verbatim text
  18 .ft CW
  19 .nf
  20 .ne \\$1
  21 ..
  22 .de Ve \" End verbatim text
  23 .ft R
  24 .fi
  25 ..
  26 .\" Set up some character translations and predefined strings.  \*(-- will
  27 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
  28 .\" double quote, and \*(R" will give a right double quote.  | will give a
  29 .\" real vertical bar.  \*(C+ will give a nicer C++.  Capital omega is used to
  30 .\" do unbreakable dashes and therefore won't be available.  \*(C` and \*(C'
  31 .\" expand to `' in nroff, nothing in troff, for use with C<>.
  32 .tr \(*W-|\(bv\*(Tr
  33 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
  34 .ie n \{\
  35 .    ds -- \(*W-
  36 .    ds PI pi
  37 .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
  38 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
  39 .    ds L" ""
  40 .    ds R" ""
  41 .    ds C` ""
  42 .    ds C' ""
  43 'br\}
  44 .el\{\
  45 .    ds -- \|\(em\|
  46 .    ds PI \(*p
  47 .    ds L" ``
  48 .    ds R" ''
  49 'br\}
  50 .\"
  51 .\" If the F register is turned on, we'll generate index entries on stderr for
  52 .\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
  53 .\" entries marked with X<> in POD.  Of course, you'll have to process the
  54 .\" output yourself in some meaningful fashion.
  55 .if \nF \{\
  56 .    de IX
  57 .    tm Index:\\$1\t\\n%\t"\\$2"
  58 ..
  59 .    nr % 0
  60 .    rr F
  61 .\}
  62 .\"
  63 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
  64 .\" way too many mistakes in technical documents.
  65 .hy 0
  66 .if n .na
  67 .\"
  68 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
  69 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
  70 .    \" fudge factors for nroff and troff
  71 .if n \{\
  72 .    ds #H 0
  73 .    ds #V .8m
  74 .    ds #F .3m
  75 .    ds #[ \f1
  76 .    ds #] \fP
  77 .\}
  78 .if t \{\
  79 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  80 .    ds #V .6m
  81 .    ds #F 0
  82 .    ds #[ \&
  83 .    ds #] \&
  84 .\}
  85 .    \" simple accents for nroff and troff
  86 .if n \{\
  87 .    ds ' \&
  88 .    ds ` \&
  89 .    ds ^ \&
  90 .    ds , \&
  91 .    ds ~ ~
  92 .    ds /
  93 .\}
  94 .if t \{\
  95 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
  96 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
  97 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
  98 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
  99 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
 100 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
 101 .\}
 102 .    \" troff and (daisy-wheel) nroff accents
 103 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
 104 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 105 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 106 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 107 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 108 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 109 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 110 .ds ae a\h'-(\w'a'u*4/10)'e
 111 .ds Ae A\h'-(\w'A'u*4/10)'E
 112 .    \" corrections for vroff
 113 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 114 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 115 .    \" for low resolution devices (crt and lpr)
 116 .if \n(.H>23 .if \n(.V>19 \
 117 \{\
 118 .    ds : e
 119 .    ds 8 ss
 120 .    ds o a
 121 .    ds d- d\h'-1'\(ga
 122 .    ds D- D\h'-1'\(hy
 123 .    ds th \o'bp'
 124 .    ds Th \o'LP'
 125 .    ds ae ae
 126 .    ds Ae AE
 127 .\}
 128 .rm #[ #] #H #V #F C
 129 .\" ========================================================================
 130 .\"
 131 .IX Title "QEMU-IMG 1"
 132 .TH QEMU-IMG 1 "2005-09-04" " " " "
 133 .SH "NAME"
 134 qemu\-img \- QEMU disk image utility
 135 .SH "SYNOPSIS"
 136 .IX Header "SYNOPSIS"
 137 usage: qemu-img command [command options]
 138 .SH "OPTIONS"
 139 .IX Header "OPTIONS"
 140 The following commands are supported:
 141 .IP "\fBcreate [\-e] [\-b\fR \fIbase_image\fR\fB] [\-f\fR \fIfmt\fR\fB]\fR \fIfilename\fR \fB[\fR\fIsize\fR\fB]\fR" 4
 142 .IX Item "create [-e] [-b base_image] [-f fmt] filename [size]"
 143 .PD 0
 144 .IP "\fBcommit [\-f\fR \fIfmt\fR\fB]\fR \fIfilename\fR" 4
 145 .IX Item "commit [-f fmt] filename"
 146 .IP "\fBconvert [\-c] [\-e] [\-f\fR \fIfmt\fR\fB]\fR \fIfilename\fR \fB[\-O\fR \fIoutput_fmt\fR\fB]\fR \fIoutput_filename\fR" 4
 147 .IX Item "convert [-c] [-e] [-f fmt] filename [-O output_fmt] output_filename"
 148 .IP "\fBinfo [\-f\fR \fIfmt\fR\fB]\fR \fIfilename\fR" 4
 149 .IX Item "info [-f fmt] filename"
 150 .PD
 151 .PP
 152 Command parameters:
 153 .IP "\fIfilename\fR" 4
 154 .IX Item "filename"
 155 .Vb 1
 156 \& is a disk image filename
 157 .Ve
 158 .IP "\fIbase_image\fR" 4
 159 .IX Item "base_image"
 160 is the read-only disk image which is used as base for a copy on
 161     write image; the copy on write image only stores the modified data
 162 .IP "\fIfmt\fR" 4
 163 .IX Item "fmt"
 164 is the disk image format. It is guessed automatically in most cases. The following formats are supported:
 165 .RS 4
 166 .ie n .IP """raw""" 4
 167 .el .IP "\f(CWraw\fR" 4
 168 .IX Item "raw"
 169 Raw disk image format (default). This format has the advantage of
 170 being simple and easily exportable to all other emulators. If your file
 171 system supports \fIholes\fR (for example in ext2 or ext3 on Linux),
 172 then only the written sectors will reserve space. Use \f(CW\*(C`qemu\-img
 173 info\*(C'\fR to know the real size used by the image or \f(CW\*(C`ls \-ls\*(C'\fR on
 174 Unix/Linux.
 175 .ie n .IP """qcow""" 4
 176 .el .IP "\f(CWqcow\fR" 4
 177 .IX Item "qcow"
 178 \&\s-1QEMU\s0 image format, the most versatile format. Use it to have smaller
 179 images (useful if your filesystem does not supports holes, for example
 180 on Windows), optional \s-1AES\s0 encryption and zlib based compression.
 181 .ie n .IP """cow""" 4
 182 .el .IP "\f(CWcow\fR" 4
 183 .IX Item "cow"
 184 User Mode Linux Copy On Write image format. Used to be the only growable
 185 image format in \s-1QEMU\s0. It is supported only for compatibility with
 186 previous versions. It does not work on win32.
 187 .ie n .IP """vmdk""" 4
 188 .el .IP "\f(CWvmdk\fR" 4
 189 .IX Item "vmdk"
 190 VMware 3 and 4 compatible image format.
 191 .ie n .IP """cloop""" 4
 192 .el .IP "\f(CWcloop\fR" 4
 193 .IX Item "cloop"
 194 Linux Compressed Loop image, useful only to reuse directly compressed
 195 CD-ROM images present for example in the Knoppix CD\-ROMs.
 196 .RE
 197 .RS 4
 198 .RE
 199 .IP "\fIsize\fR" 4
 200 .IX Item "size"
 201 is the disk image size in kilobytes. Optional suffixes \f(CW\*(C`M\*(C'\fR
 202 (megabyte) and \f(CW\*(C`G\*(C'\fR (gigabyte) are supported
 203 .IP "\fIoutput_filename\fR" 4
 204 .IX Item "output_filename"
 205 is the destination disk image filename
 206 .IP "\fIoutput_fmt\fR" 4
 207 .IX Item "output_fmt"
 208 .Vb 1
 209 \& is the destination format
 210 .Ve
 211 .IP "\fI\-c\fR" 4
 212 .IX Item "-c"
 213 indicates that target image must be compressed (qcow format only)
 214 .IP "\fI\-e\fR" 4
 215 .IX Item "-e"
 216 indicates that the target image must be encrypted (qcow format only)
 217 .PP
 218 Command description:
 219 .IP "\fBcreate [\-e] [\-b\fR \fIbase_image\fR\fB] [\-f\fR \fIfmt\fR\fB]\fR \fIfilename\fR \fB[\fR\fIsize\fR\fB]\fR" 4
 220 .IX Item "create [-e] [-b base_image] [-f fmt] filename [size]"
 221 Create the new disk image \fIfilename\fR of size \fIsize\fR and format
 222 \&\fIfmt\fR.
 223 .Sp
 224 If \fIbase_image\fR is specified, then the image will record only the
 225 differences from \fIbase_image\fR. No size needs to be specified in
 226 this case. \fIbase_image\fR will never be modified unless you use the
 227 \&\f(CW\*(C`commit\*(C'\fR monitor command.
 228 .IP "\fBcommit [\-f\fR \fIfmt\fR\fB]\fR \fIfilename\fR" 4
 229 .IX Item "commit [-f fmt] filename"
 230 Commit the changes recorded in \fIfilename\fR in its base image.
 231 .IP "\fBconvert [\-c] [\-e] [\-f\fR \fIfmt\fR\fB]\fR \fIfilename\fR \fB[\-O\fR \fIoutput_fmt\fR\fB]\fR \fIoutput_filename\fR" 4
 232 .IX Item "convert [-c] [-e] [-f fmt] filename [-O output_fmt] output_filename"
 233 Convert the disk image \fIfilename\fR to disk image \fIoutput_filename\fR
 234 using format \fIoutput_fmt\fR. It can be optionnaly encrypted
 235 (\f(CW\*(C`\-e\*(C'\fR option) or compressed (\f(CW\*(C`\-c\*(C'\fR option).
 236 .Sp
 237 Only the format \f(CW\*(C`qcow\*(C'\fR supports encryption or compression. The
 238 compression is read\-only. It means that if a compressed sector is
 239 rewritten, then it is rewritten as uncompressed data.
 240 .Sp
 241 Encryption uses the \s-1AES\s0 format which is very secure (128 bit keys). Use
 242 a long password (16 characters) to get maximum protection.
 243 .Sp
 244 Image conversion is also useful to get smaller image when using a
 245 growable format such as \f(CW\*(C`qcow\*(C'\fR or \f(CW\*(C`cow\*(C'\fR: the empty sectors
 246 are detected and suppressed from the destination image.
 247 .IP "\fBinfo [\-f\fR \fIfmt\fR\fB]\fR \fIfilename\fR" 4
 248 .IX Item "info [-f fmt] filename"
 249 Give information about the disk image \fIfilename\fR. Use it in
 250 particular to know the size reserved on disk which can be different
 251 from the displayed size.
 252 .SH "SEE ALSO"
 253 .IX Header "SEE ALSO"
 254 The \s-1HTML\s0 documentation of \s-1QEMU\s0 for more precise information and Linux
 255 user mode emulator invocation.
 256 .SH "AUTHOR"
 257 .IX Header "AUTHOR"
 258 Fabrice Bellard