docs/tools/qemu-img.rst

28 .. option:: -h, --help
32 .. option:: -V, --version
36 .. option:: -T, --trace [[enable=]PATTERN][,events=FILE][,file=FILE]
38   .. include:: ../qemu-option-trace.rst.inc
68   the -h option appearing both in the above option list and this one.
72 .. option:: --object OBJECTDEF
79 .. option:: --image-opts
82   full option string, not a plain filename. This parameter is mutually
85 .. option:: --target-image-opts
88   a full option string, not a plain filename. This parameter is mutually
93 .. option:: --force-share (-U)
99   concurrent metadata changes, etc. This option is only allowed when opening
102 .. option:: --backing-chain
107 .. option:: -c
113   compression_type=...`` option (see below).
115 .. option:: -h
119 .. option:: -p
122   If the *-p* option is not used for a command that supports it, the
126 .. option:: -q
131 .. option:: -S SIZE
138 .. option:: -t CACHE
141   the documentation of the emulator's ``-drive cache=...`` option for allowed
144 .. option:: -T SRC_CACHE
147   the documentation of the emulator's ``-drive cache=...`` option for allowed
154 .. option:: -f
158 .. option:: -F
162 .. option:: -s
170 .. option:: --bitmaps
174 .. option:: -n
178 .. option:: -m
182 .. option:: -W
184   Allow out-of-order writes to the destination. This option improves performance,
188 .. option:: -C
196 .. option:: -r
200 .. option:: --salvage
206 .. option:: --target-is-zero
217 .. option:: bs=BLOCK_SIZE
221 .. option:: count=BLOCKS
225 .. option:: if=INPUT
229 .. option:: of=OUTPUT
233 .. option:: skip=BLOCKS
241 .. option:: snapshot
245 .. option:: -a
249 .. option:: -c
253 .. option:: -d
257 .. option:: -l
265 .. option:: amend [--object OBJECTDEF] [--image-opts] [-p] [-q] [-f FMT] [-t CACHE] [--force] -o OP…
277 .. option:: bench [-c COUNT] [-d DEPTH] [-f FMT] [--flush-interval=FLUSH_INTERVAL] [-i AIO] [-n] [-…
294   if ``-i`` is specified, *AIO* option can be used to specify different
298   Linux, this option only works if ``-t none`` or ``-t directsync`` is
304 .. option:: bitmap (--merge SOURCE | --add | --remove | --clear | --enable | --disable)... [-b SOUR…
328 .. option:: check [--object OBJECTDEF] [--image-opts] [-q] [-f FMT] [--output=OFMT] [-r [leaks | al…
361 .. option:: commit [--object OBJECTDEF] [--image-opts] [-q] [-f FMT] [-t CACHE] [-b BASE] [-r RATE_…
385 .. option:: compare [--object OBJECTDEF] [--image-opts] [-f FMT] [-F FMT] [-T SRC_CACHE] [-p] [-q] …
391   *FILENAME1*) and/or ``-F`` (used for *FILENAME2*) option.
397   can use Strict mode by specifying the ``-s`` option. When compare runs in
422 .. option:: convert [--object OBJECTDEF] [--image-opts] [--target-image-opts] [--target-is-zero] [-…
426   be optionally compressed (``-c`` option) or use any format specific
427   options like encryption (``-o`` option).
443   You can use the *BACKING_FILE* option to force the output image to be
451   If the ``-n`` option is specified, the target volume creation will be
470 .. option:: create [--object OBJECTDEF] [-q] [-f FMT] [-b BACKING_FILE [-F BACKING_FMT]] [-u] [-o O…
476   If the option *BACKING_FILE* is specified, then the image will record
485   the ``-u`` option to enable unsafe backing file mode, which means that the
491   The size can also be specified using the *SIZE* option with ``-o``,
495 .. option:: dd [--image-opts] [-U] [-f FMT] [-O OUTPUT_FMT] [bs=BLOCK_SIZE] [count=BLOCKS] [skip=BL…
506 .. option:: info [--object OBJECTDEF] [--image-opts] [-f FMT] [--output=OFMT] [--backing-chain] [-U…
514   the chain can be recursively enumerated by using the option ``--backing-chain``.
574 .. option:: map [--object OBJECTDEF] [--image-opts] [-f FMT] [--start-offset=OFFSET] [--max-length=…
581   Two option formats are possible.  The default format (``human``)
627 .. option:: measure [--output=OFMT] [-O OUTPUT_FMT] [-o OPTIONS] [--size N | [--object OBJECTDEF] […
666 .. option:: snapshot [--object OBJECTDEF] [--image-opts] [-U] [-q] [-l | -a SNAPSHOT | -c SNAPSHOT …
670 .. option:: rebase [--object OBJECTDEF] [--image-opts] [-U] [-q] [-f FMT] [-t CACHE] [-T SRC_CACHE]…
698     ``-c`` option specified, the clusters which are being merged (but not
735 .. option:: resize [--object OBJECTDEF] [--image-opts] [-f FMT] [--preallocation=PREALLOC] [-q] [--…
743   When shrinking images, the ``--shrink`` option must be given. This informs
751   When growing an image, the ``--preallocation`` option may be used to specify
754   option may result in slightly more data being allocated than necessary.
804     This option configures which compression algorithm will be used for
805     compressed clusters on the image. Note that setting this option doesn't yet
807     used with the ``-c`` option of ``qemu-img convert``, but can also be used
815     If this option is set to ``on``, the image is encrypted with
866     If this option is set to ``on``, reference count updates are
874     This option can only be enabled if ``compat=1.1`` is specified.
877     If this option is set to ``on``, it will turn off COW of the file. It's
888       option does.
890     Note: this option is only valid to new or empty files. If there is
897     Filename where all guest data will be stored. If this option is used,
901     using this option with ``qemu-img create`` since ``qemu-img`` will create
907     If this option is set to ``on``, QEMU will always keep the external data
918     If this option is ``off``, QEMU will use the data file to store data in an
925     This option can only be enabled if ``data_file`` is set.