qapi2texi: Fix up output around #optional
[qemu.git] / qemu-img.texi
1 @example
2 @c man begin SYNOPSIS
3 @command{qemu-img} [@var{standard} @var{options}] @var{command} [@var{command} @var{options}]
4 @c man end
5 @end example
6
7 @c man begin DESCRIPTION
8 qemu-img allows you to create, convert and modify images offline. It can handle
9 all image formats supported by QEMU.
10
11 @b{Warning:} Never use qemu-img to modify images in use by a running virtual
12 machine or any other process; this may destroy the image. Also, be aware that
13 querying an image that is being modified by another process may encounter
14 inconsistent state.
15 @c man end
16
17 @c man begin OPTIONS
18
19 Standard options:
20 @table @option
21 @item -h, --help
22 Display this help and exit
23 @item -V, --version
24 Display version information and exit
25 @item -T, --trace [[enable=]@var{pattern}][,events=@var{file}][,file=@var{file}]
26 @findex --trace
27 @include qemu-option-trace.texi
28 @end table
29
30 The following commands are supported:
31
32 @include qemu-img-cmds.texi
33
34 Command parameters:
35 @table @var
36 @item filename
37  is a disk image filename
38
39 @item --object @var{objectdef}
40
41 is a QEMU user creatable object definition. See the @code{qemu(1)} manual
42 page for a description of the object properties. The most common object
43 type is a @code{secret}, which is used to supply passwords and/or encryption
44 keys.
45
46 @item --image-opts
47
48 Indicates that the @var{filename} parameter is to be interpreted as a
49 full option string, not a plain filename. This parameter is mutually
50 exclusive with the @var{-f} and @var{-F} parameters.
51
52 @item fmt
53 is the disk image format. It is guessed automatically in most cases. See below
54 for a description of the supported disk formats.
55
56 @item --backing-chain
57 will enumerate information about backing files in a disk image chain. Refer
58 below for further description.
59
60 @item size
61 is the disk image size in bytes. Optional suffixes @code{k} or @code{K}
62 (kilobyte, 1024) @code{M} (megabyte, 1024k) and @code{G} (gigabyte, 1024M)
63 and T (terabyte, 1024G) are supported.  @code{b} is ignored.
64
65 @item output_filename
66 is the destination disk image filename
67
68 @item output_fmt
69  is the destination format
70 @item options
71 is a comma separated list of format specific options in a
72 name=value format. Use @code{-o ?} for an overview of the options supported
73 by the used format or see the format descriptions below for details.
74 @item snapshot_param
75 is param used for internal snapshot, format is
76 'snapshot.id=[ID],snapshot.name=[NAME]' or '[ID_OR_NAME]'
77 @item snapshot_id_or_name
78 is deprecated, use snapshot_param instead
79
80 @item -c
81 indicates that target image must be compressed (qcow format only)
82 @item -h
83 with or without a command shows help and lists the supported formats
84 @item -p
85 display progress bar (compare, convert and rebase commands only).
86 If the @var{-p} option is not used for a command that supports it, the
87 progress is reported when the process receives a @code{SIGUSR1} signal.
88 @item -q
89 Quiet mode - do not print any output (except errors). There's no progress bar
90 in case both @var{-q} and @var{-p} options are used.
91 @item -S @var{size}
92 indicates the consecutive number of bytes that must contain only zeros
93 for qemu-img to create a sparse image during conversion. This value is rounded
94 down to the nearest 512 bytes. You may use the common size suffixes like
95 @code{k} for kilobytes.
96 @item -t @var{cache}
97 specifies the cache mode that should be used with the (destination) file. See
98 the documentation of the emulator's @code{-drive cache=...} option for allowed
99 values.
100 @item -T @var{src_cache}
101 specifies the cache mode that should be used with the source file(s). See
102 the documentation of the emulator's @code{-drive cache=...} option for allowed
103 values.
104 @end table
105
106 Parameters to snapshot subcommand:
107
108 @table @option
109
110 @item snapshot
111 is the name of the snapshot to create, apply or delete
112 @item -a
113 applies a snapshot (revert disk to saved state)
114 @item -c
115 creates a snapshot
116 @item -d
117 deletes a snapshot
118 @item -l
119 lists all snapshots in the given image
120 @end table
121
122 Parameters to compare subcommand:
123
124 @table @option
125
126 @item -f
127 First image format
128 @item -F
129 Second image format
130 @item -s
131 Strict mode - fail on different image size or sector allocation
132 @end table
133
134 Parameters to convert subcommand:
135
136 @table @option
137
138 @item -n
139 Skip the creation of the target volume
140 @item -m
141 Number of parallel coroutines for the convert process
142 @item -W
143 Allow out-of-order writes to the destination. This option improves performance,
144 but is only recommended for preallocated devices like host devices or other
145 raw block devices.
146 @end table
147
148 Parameters to dd subcommand:
149
150 @table @option
151
152 @item bs=@var{block_size}
153 defines the block size
154 @item count=@var{blocks}
155 sets the number of input blocks to copy
156 @item if=@var{input}
157 sets the input file
158 @item of=@var{output}
159 sets the output file
160 @item skip=@var{blocks}
161 sets the number of input blocks to skip
162 @end table
163
164 Command description:
165
166 @table @option
167 @item bench [-c @var{count}] [-d @var{depth}] [-f @var{fmt}] [--flush-interval=@var{flush_interval}] [-n] [--no-drain] [-o @var{offset}] [--pattern=@var{pattern}] [-q] [-s @var{buffer_size}] [-S @var{step_size}] [-t @var{cache}] [-w] @var{filename}
168
169 Run a simple sequential I/O benchmark on the specified image. If @code{-w} is
170 specified, a write test is performed, otherwise a read test is performed.
171
172 A total number of @var{count} I/O requests is performed, each @var{buffer_size}
173 bytes in size, and with @var{depth} requests in parallel. The first request
174 starts at the position given by @var{offset}, each following request increases
175 the current position by @var{step_size}. If @var{step_size} is not given,
176 @var{buffer_size} is used for its value.
177
178 If @var{flush_interval} is specified for a write test, the request queue is
179 drained and a flush is issued before new writes are made whenever the number of
180 remaining requests is a multiple of @var{flush_interval}. If additionally
181 @code{--no-drain} is specified, a flush is issued without draining the request
182 queue first.
183
184 If @code{-n} is specified, the native AIO backend is used if possible. On
185 Linux, this option only works if @code{-t none} or @code{-t directsync} is
186 specified as well.
187
188 For write tests, by default a buffer filled with zeros is written. This can be
189 overridden with a pattern byte specified by @var{pattern}.
190
191 @item check [-f @var{fmt}] [--output=@var{ofmt}] [-r [leaks | all]] [-T @var{src_cache}] @var{filename}
192
193 Perform a consistency check on the disk image @var{filename}. The command can
194 output in the format @var{ofmt} which is either @code{human} or @code{json}.
195
196 If @code{-r} is specified, qemu-img tries to repair any inconsistencies found
197 during the check. @code{-r leaks} repairs only cluster leaks, whereas
198 @code{-r all} fixes all kinds of errors, with a higher risk of choosing the
199 wrong fix or hiding corruption that has already occurred.
200
201 Only the formats @code{qcow2}, @code{qed} and @code{vdi} support
202 consistency checks.
203
204 In case the image does not have any inconsistencies, check exits with @code{0}.
205 Other exit codes indicate the kind of inconsistency found or if another error
206 occurred. The following table summarizes all exit codes of the check subcommand:
207
208 @table @option
209
210 @item 0
211 Check completed, the image is (now) consistent
212 @item 1
213 Check not completed because of internal errors
214 @item 2
215 Check completed, image is corrupted
216 @item 3
217 Check completed, image has leaked clusters, but is not corrupted
218 @item 63
219 Checks are not supported by the image format
220
221 @end table
222
223 If @code{-r} is specified, exit codes representing the image state refer to the
224 state after (the attempt at) repairing it. That is, a successful @code{-r all}
225 will yield the exit code 0, independently of the image state before.
226
227 @item create [-f @var{fmt}] [-o @var{options}] @var{filename} [@var{size}]
228
229 Create the new disk image @var{filename} of size @var{size} and format
230 @var{fmt}. Depending on the file format, you can add one or more @var{options}
231 that enable additional features of this format.
232
233 If the option @var{backing_file} is specified, then the image will record
234 only the differences from @var{backing_file}. No size needs to be specified in
235 this case. @var{backing_file} will never be modified unless you use the
236 @code{commit} monitor command (or qemu-img commit).
237
238 The size can also be specified using the @var{size} option with @code{-o},
239 it doesn't need to be specified separately in this case.
240
241 @item commit [-q] [-f @var{fmt}] [-t @var{cache}] [-b @var{base}] [-d] [-p] @var{filename}
242
243 Commit the changes recorded in @var{filename} in its base image or backing file.
244 If the backing file is smaller than the snapshot, then the backing file will be
245 resized to be the same size as the snapshot.  If the snapshot is smaller than
246 the backing file, the backing file will not be truncated.  If you want the
247 backing file to match the size of the smaller snapshot, you can safely truncate
248 it yourself once the commit operation successfully completes.
249
250 The image @var{filename} is emptied after the operation has succeeded. If you do
251 not need @var{filename} afterwards and intend to drop it, you may skip emptying
252 @var{filename} by specifying the @code{-d} flag.
253
254 If the backing chain of the given image file @var{filename} has more than one
255 layer, the backing file into which the changes will be committed may be
256 specified as @var{base} (which has to be part of @var{filename}'s backing
257 chain). If @var{base} is not specified, the immediate backing file of the top
258 image (which is @var{filename}) will be used. For reasons of consistency,
259 explicitly specifying @var{base} will always imply @code{-d} (since emptying an
260 image after committing to an indirect backing file would lead to different data
261 being read from the image due to content in the intermediate backing chain
262 overruling the commit target).
263
264 @item compare [-f @var{fmt}] [-F @var{fmt}] [-T @var{src_cache}] [-p] [-s] [-q] @var{filename1} @var{filename2}
265
266 Check if two images have the same content. You can compare images with
267 different format or settings.
268
269 The format is probed unless you specify it by @var{-f} (used for
270 @var{filename1}) and/or @var{-F} (used for @var{filename2}) option.
271
272 By default, images with different size are considered identical if the larger
273 image contains only unallocated and/or zeroed sectors in the area after the end
274 of the other image. In addition, if any sector is not allocated in one image
275 and contains only zero bytes in the second one, it is evaluated as equal. You
276 can use Strict mode by specifying the @var{-s} option. When compare runs in
277 Strict mode, it fails in case image size differs or a sector is allocated in
278 one image and is not allocated in the second one.
279
280 By default, compare prints out a result message. This message displays
281 information that both images are same or the position of the first different
282 byte. In addition, result message can report different image size in case
283 Strict mode is used.
284
285 Compare exits with @code{0} in case the images are equal and with @code{1}
286 in case the images differ. Other exit codes mean an error occurred during
287 execution and standard error output should contain an error message.
288 The following table sumarizes all exit codes of the compare subcommand:
289
290 @table @option
291
292 @item 0
293 Images are identical
294 @item 1
295 Images differ
296 @item 2
297 Error on opening an image
298 @item 3
299 Error on checking a sector allocation
300 @item 4
301 Error on reading data
302
303 @end table
304
305 @item convert [-c] [-p] [-n] [-f @var{fmt}] [-t @var{cache}] [-T @var{src_cache}] [-O @var{output_fmt}] [-o @var{options}] [-s @var{snapshot_id_or_name}] [-l @var{snapshot_param}] [-m @var{num_coroutines}] [-W] [-S @var{sparse_size}] @var{filename} [@var{filename2} [...]] @var{output_filename}
306
307 Convert the disk image @var{filename} or a snapshot @var{snapshot_param}(@var{snapshot_id_or_name} is deprecated)
308 to disk image @var{output_filename} using format @var{output_fmt}. It can be optionally compressed (@code{-c}
309 option) or use any format specific options like encryption (@code{-o} option).
310
311 Only the formats @code{qcow} and @code{qcow2} support compression. The
312 compression is read-only. It means that if a compressed sector is
313 rewritten, then it is rewritten as uncompressed data.
314
315 Image conversion is also useful to get smaller image when using a
316 growable format such as @code{qcow}: the empty sectors are detected and
317 suppressed from the destination image.
318
319 @var{sparse_size} indicates the consecutive number of bytes (defaults to 4k)
320 that must contain only zeros for qemu-img to create a sparse image during
321 conversion. If @var{sparse_size} is 0, the source will not be scanned for
322 unallocated or zero sectors, and the destination image will always be
323 fully allocated.
324
325 You can use the @var{backing_file} option to force the output image to be
326 created as a copy on write image of the specified base image; the
327 @var{backing_file} should have the same content as the input's base image,
328 however the path, image format, etc may differ.
329
330 If the @code{-n} option is specified, the target volume creation will be
331 skipped. This is useful for formats such as @code{rbd} if the target
332 volume has already been created with site specific options that cannot
333 be supplied through qemu-img.
334
335 Out of order writes can be enabled with @code{-W} to improve performance.
336 This is only recommended for preallocated devices like host devices or other
337 raw block devices. Out of order write does not work in combination with
338 creating compressed images.
339
340 @var{num_coroutines} specifies how many coroutines work in parallel during
341 the convert process (defaults to 8).
342
343 @item dd [-f @var{fmt}] [-O @var{output_fmt}] [bs=@var{block_size}] [count=@var{blocks}] [skip=@var{blocks}] if=@var{input} of=@var{output}
344
345 Dd copies from @var{input} file to @var{output} file converting it from
346 @var{fmt} format to @var{output_fmt} format.
347
348 The data is by default read and written using blocks of 512 bytes but can be
349 modified by specifying @var{block_size}. If count=@var{blocks} is specified
350 dd will stop reading input after reading @var{blocks} input blocks.
351
352 The size syntax is similar to dd(1)'s size syntax.
353
354 @item info [-f @var{fmt}] [--output=@var{ofmt}] [--backing-chain] @var{filename}
355
356 Give information about the disk image @var{filename}. Use it in
357 particular to know the size reserved on disk which can be different
358 from the displayed size. If VM snapshots are stored in the disk image,
359 they are displayed too. The command can output in the format @var{ofmt}
360 which is either @code{human} or @code{json}.
361
362 If a disk image has a backing file chain, information about each disk image in
363 the chain can be recursively enumerated by using the option @code{--backing-chain}.
364
365 For instance, if you have an image chain like:
366
367 @example
368 base.qcow2 <- snap1.qcow2 <- snap2.qcow2
369 @end example
370
371 To enumerate information about each disk image in the above chain, starting from top to base, do:
372
373 @example
374 qemu-img info --backing-chain snap2.qcow2
375 @end example
376
377 @item map [-f @var{fmt}] [--output=@var{ofmt}] @var{filename}
378
379 Dump the metadata of image @var{filename} and its backing file chain.
380 In particular, this commands dumps the allocation state of every sector
381 of @var{filename}, together with the topmost file that allocates it in
382 the backing file chain.
383
384 Two option formats are possible.  The default format (@code{human})
385 only dumps known-nonzero areas of the file.  Known-zero parts of the
386 file are omitted altogether, and likewise for parts that are not allocated
387 throughout the chain.  @command{qemu-img} output will identify a file
388 from where the data can be read, and the offset in the file.  Each line
389 will include four fields, the first three of which are hexadecimal
390 numbers.  For example the first line of:
391 @example
392 Offset          Length          Mapped to       File
393 0               0x20000         0x50000         /tmp/overlay.qcow2
394 0x100000        0x10000         0x95380000      /tmp/backing.qcow2
395 @end example
396 @noindent
397 means that 0x20000 (131072) bytes starting at offset 0 in the image are
398 available in /tmp/overlay.qcow2 (opened in @code{raw} format) starting
399 at offset 0x50000 (327680).  Data that is compressed, encrypted, or
400 otherwise not available in raw format will cause an error if @code{human}
401 format is in use.  Note that file names can include newlines, thus it is
402 not safe to parse this output format in scripts.
403
404 The alternative format @code{json} will return an array of dictionaries
405 in JSON format.  It will include similar information in
406 the @code{start}, @code{length}, @code{offset} fields;
407 it will also include other more specific information:
408 @itemize @minus
409 @item
410 whether the sectors contain actual data or not (boolean field @code{data};
411 if false, the sectors are either unallocated or stored as optimized
412 all-zero clusters);
413
414 @item
415 whether the data is known to read as zero (boolean field @code{zero});
416
417 @item
418 in order to make the output shorter, the target file is expressed as
419 a @code{depth}; for example, a depth of 2 refers to the backing file
420 of the backing file of @var{filename}.
421 @end itemize
422
423 In JSON format, the @code{offset} field is optional; it is absent in
424 cases where @code{human} format would omit the entry or exit with an error.
425 If @code{data} is false and the @code{offset} field is present, the
426 corresponding sectors in the file are not yet in use, but they are
427 preallocated.
428
429 For more information, consult @file{include/block/block.h} in QEMU's
430 source code.
431
432 @item snapshot [-l | -a @var{snapshot} | -c @var{snapshot} | -d @var{snapshot} ] @var{filename}
433
434 List, apply, create or delete snapshots in image @var{filename}.
435
436 @item rebase [-f @var{fmt}] [-t @var{cache}] [-T @var{src_cache}] [-p] [-u] -b @var{backing_file} [-F @var{backing_fmt}] @var{filename}
437
438 Changes the backing file of an image. Only the formats @code{qcow2} and
439 @code{qed} support changing the backing file.
440
441 The backing file is changed to @var{backing_file} and (if the image format of
442 @var{filename} supports this) the backing file format is changed to
443 @var{backing_fmt}. If @var{backing_file} is specified as ``'' (the empty
444 string), then the image is rebased onto no backing file (i.e. it will exist
445 independently of any backing file).
446
447 @var{cache} specifies the cache mode to be used for @var{filename}, whereas
448 @var{src_cache} specifies the cache mode for reading backing files.
449
450 There are two different modes in which @code{rebase} can operate:
451 @table @option
452 @item Safe mode
453 This is the default mode and performs a real rebase operation. The new backing
454 file may differ from the old one and qemu-img rebase will take care of keeping
455 the guest-visible content of @var{filename} unchanged.
456
457 In order to achieve this, any clusters that differ between @var{backing_file}
458 and the old backing file of @var{filename} are merged into @var{filename}
459 before actually changing the backing file.
460
461 Note that the safe mode is an expensive operation, comparable to converting
462 an image. It only works if the old backing file still exists.
463
464 @item Unsafe mode
465 qemu-img uses the unsafe mode if @code{-u} is specified. In this mode, only the
466 backing file name and format of @var{filename} is changed without any checks
467 on the file contents. The user must take care of specifying the correct new
468 backing file, or the guest-visible content of the image will be corrupted.
469
470 This mode is useful for renaming or moving the backing file to somewhere else.
471 It can be used without an accessible old backing file, i.e. you can use it to
472 fix an image whose backing file has already been moved/renamed.
473 @end table
474
475 You can use @code{rebase} to perform a ``diff'' operation on two
476 disk images.  This can be useful when you have copied or cloned
477 a guest, and you want to get back to a thin image on top of a
478 template or base image.
479
480 Say that @code{base.img} has been cloned as @code{modified.img} by
481 copying it, and that the @code{modified.img} guest has run so there
482 are now some changes compared to @code{base.img}.  To construct a thin
483 image called @code{diff.qcow2} that contains just the differences, do:
484
485 @example
486 qemu-img create -f qcow2 -b modified.img diff.qcow2
487 qemu-img rebase -b base.img diff.qcow2
488 @end example
489
490 At this point, @code{modified.img} can be discarded, since
491 @code{base.img + diff.qcow2} contains the same information.
492
493 @item resize @var{filename} [+ | -]@var{size}
494
495 Change the disk image as if it had been created with @var{size}.
496
497 Before using this command to shrink a disk image, you MUST use file system and
498 partitioning tools inside the VM to reduce allocated file systems and partition
499 sizes accordingly.  Failure to do so will result in data loss!
500
501 After using this command to grow a disk image, you must use file system and
502 partitioning tools inside the VM to actually begin using the new space on the
503 device.
504
505 @item amend [-p] [-f @var{fmt}] [-t @var{cache}] -o @var{options} @var{filename}
506
507 Amends the image format specific @var{options} for the image file
508 @var{filename}. Not all file formats support this operation.
509 @end table
510 @c man end
511
512 @ignore
513 @c man begin NOTES
514 Supported image file formats:
515
516 @table @option
517 @item raw
518
519 Raw disk image format (default). This format has the advantage of
520 being simple and easily exportable to all other emulators. If your
521 file system supports @emph{holes} (for example in ext2 or ext3 on
522 Linux or NTFS on Windows), then only the written sectors will reserve
523 space. Use @code{qemu-img info} to know the real size used by the
524 image or @code{ls -ls} on Unix/Linux.
525
526 Supported options:
527 @table @code
528 @item preallocation
529 Preallocation mode (allowed values: @code{off}, @code{falloc}, @code{full}).
530 @code{falloc} mode preallocates space for image by calling posix_fallocate().
531 @code{full} mode preallocates space for image by writing zeros to underlying
532 storage.
533 @end table
534
535 @item qcow2
536 QEMU image format, the most versatile format. Use it to have smaller
537 images (useful if your filesystem does not supports holes, for example
538 on Windows), optional AES encryption, zlib based compression and
539 support of multiple VM snapshots.
540
541 Supported options:
542 @table @code
543 @item compat
544 Determines the qcow2 version to use. @code{compat=0.10} uses the
545 traditional image format that can be read by any QEMU since 0.10.
546 @code{compat=1.1} enables image format extensions that only QEMU 1.1 and
547 newer understand (this is the default). Amongst others, this includes zero
548 clusters, which allow efficient copy-on-read for sparse images.
549
550 @item backing_file
551 File name of a base image (see @option{create} subcommand)
552 @item backing_fmt
553 Image format of the base image
554 @item encryption
555 If this option is set to @code{on}, the image is encrypted with 128-bit AES-CBC.
556
557 The use of encryption in qcow and qcow2 images is considered to be flawed by
558 modern cryptography standards, suffering from a number of design problems:
559
560 @itemize @minus
561 @item The AES-CBC cipher is used with predictable initialization vectors based
562 on the sector number. This makes it vulnerable to chosen plaintext attacks
563 which can reveal the existence of encrypted data.
564 @item The user passphrase is directly used as the encryption key. A poorly
565 chosen or short passphrase will compromise the security of the encryption.
566 @item In the event of the passphrase being compromised there is no way to
567 change the passphrase to protect data in any qcow images. The files must
568 be cloned, using a different encryption passphrase in the new file. The
569 original file must then be securely erased using a program like shred,
570 though even this is ineffective with many modern storage technologies.
571 @end itemize
572
573 Use of qcow / qcow2 encryption is thus strongly discouraged. Users are
574 recommended to use an alternative encryption technology such as the
575 Linux dm-crypt / LUKS system.
576
577 @item cluster_size
578 Changes the qcow2 cluster size (must be between 512 and 2M). Smaller cluster
579 sizes can improve the image file size whereas larger cluster sizes generally
580 provide better performance.
581
582 @item preallocation
583 Preallocation mode (allowed values: @code{off}, @code{metadata}, @code{falloc},
584 @code{full}). An image with preallocated metadata is initially larger but can
585 improve performance when the image needs to grow. @code{falloc} and @code{full}
586 preallocations are like the same options of @code{raw} format, but sets up
587 metadata also.
588
589 @item lazy_refcounts
590 If this option is set to @code{on}, reference count updates are postponed with
591 the goal of avoiding metadata I/O and improving performance. This is
592 particularly interesting with @option{cache=writethrough} which doesn't batch
593 metadata updates. The tradeoff is that after a host crash, the reference count
594 tables must be rebuilt, i.e. on the next open an (automatic) @code{qemu-img
595 check -r all} is required, which may take some time.
596
597 This option can only be enabled if @code{compat=1.1} is specified.
598
599 @item nocow
600 If this option is set to @code{on}, it will turn off COW of the file. It's only
601 valid on btrfs, no effect on other file systems.
602
603 Btrfs has low performance when hosting a VM image file, even more when the guest
604 on the VM also using btrfs as file system. Turning off COW is a way to mitigate
605 this bad performance. Generally there are two ways to turn off COW on btrfs:
606 a) Disable it by mounting with nodatacow, then all newly created files will be
607 NOCOW. b) For an empty file, add the NOCOW file attribute. That's what this option
608 does.
609
610 Note: this option is only valid to new or empty files. If there is an existing
611 file which is COW and has data blocks already, it couldn't be changed to NOCOW
612 by setting @code{nocow=on}. One can issue @code{lsattr filename} to check if
613 the NOCOW flag is set or not (Capital 'C' is NOCOW flag).
614
615 @end table
616
617 @item Other
618 QEMU also supports various other image file formats for compatibility with
619 older QEMU versions or other hypervisors, including VMDK, VDI, VHD (vpc), VHDX,
620 qcow1 and QED. For a full list of supported formats see @code{qemu-img --help}.
621 For a more detailed description of these formats, see the QEMU Emulation User
622 Documentation.
623
624 The main purpose of the block drivers for these formats is image conversion.
625 For running VMs, it is recommended to convert the disk images to either raw or
626 qcow2 in order to achieve good performance.
627 @end table
628
629
630 @c man end
631
632 @setfilename qemu-img
633 @settitle QEMU disk image utility
634
635 @c man begin SEEALSO
636 The HTML documentation of QEMU for more precise information and Linux
637 user mode emulator invocation.
638 @c man end
639
640 @c man begin AUTHOR
641 Fabrice Bellard
642 @c man end
643
644 @end ignore