]> git.proxmox.com Git - mirror_qemu.git/blame - qemu-img-cmds.hx
ide_ioport_read: Return lower octet of data register instead of 0xFF
[mirror_qemu.git] / qemu-img-cmds.hx
CommitLineData
57b2d9d4 1HXCOMM Keep the list of subcommands sorted by name.
a64627ed 2HXCOMM Use DEFHEADING() to define headings in both help text and rST
96ddefbc 3HXCOMM Text between SRST and ERST are copied to rST version and
153859be
SB
4HXCOMM discarded from C version
5HXCOMM DEF(command, callback, arg_string) is used to construct
6HXCOMM command structures and help message.
96ddefbc 7HXCOMM HXCOMM can be used for comments, discarded from both rST and C
153859be 8
96ddefbc 9HXCOMM When amending the rST sections, please remember to copy the usage
0562adf5 10HXCOMM over to the per-command sections in docs/tools/qemu-img.rst.
4885b0ca 11
57b2d9d4 12DEF("amend", img_amend,
a3579bfa 13 "amend [--object objectdef] [--image-opts] [-p] [-q] [-f fmt] [-t cache] [--force] -o options filename")
195b5109 14SRST
a3579bfa 15.. option:: amend [--object OBJECTDEF] [--image-opts] [-p] [-q] [-f FMT] [-t CACHE] [--force] -o OPTIONS FILENAME
195b5109 16ERST
57b2d9d4 17
b6133b8c 18DEF("bench", img_bench,
890fb1f6 19 "bench [-c count] [-d depth] [-f fmt] [--flush-interval=flush_interval] [-i aio] [-n] [--no-drain] [-o offset] [--pattern=pattern] [-q] [-s buffer_size] [-S step_size] [-t cache] [-w] [-U] filename")
195b5109 20SRST
890fb1f6 21.. option:: bench [-c COUNT] [-d DEPTH] [-f FMT] [--flush-interval=FLUSH_INTERVAL] [-i AIO] [-n] [--no-drain] [-o OFFSET] [--pattern=PATTERN] [-q] [-s BUFFER_SIZE] [-S STEP_SIZE] [-t CACHE] [-w] [-U] FILENAME
195b5109 22ERST
3b51ab4b
EB
23
24DEF("bitmap", img_bitmap,
25 "bitmap (--merge SOURCE | --add | --remove | --clear | --enable | --disable)... [-b source_file [-F source_fmt]] [-g granularity] [--object objectdef] [--image-opts | -f fmt] filename bitmap")
26SRST
27.. option:: bitmap (--merge SOURCE | --add | --remove | --clear | --enable | --disable)... [-b SOURCE_FILE [-F SOURCE_FMT]] [-g GRANULARITY] [--object OBJECTDEF] [--image-opts | -f FMT] FILENAME BITMAP
28ERST
29
153859be 30DEF("check", img_check,
65f389c0 31 "check [--object objectdef] [--image-opts] [-q] [-f fmt] [--output=ofmt] [-r [leaks | all]] [-T src_cache] [-U] filename")
195b5109
PM
32SRST
33.. option:: check [--object OBJECTDEF] [--image-opts] [-q] [-f FMT] [--output=OFMT] [-r [leaks | all]] [-T SRC_CACHE] [-U] FILENAME
34ERST
153859be 35
153859be 36DEF("commit", img_commit,
a0441b66 37 "commit [--object objectdef] [--image-opts] [-q] [-f fmt] [-t cache] [-b base] [-r rate_limit] [-d] [-p] filename")
195b5109 38SRST
a0441b66 39.. option:: commit [--object OBJECTDEF] [--image-opts] [-q] [-f FMT] [-t CACHE] [-b BASE] [-r RATE_LIMIT] [-d] [-p] FILENAME
195b5109 40ERST
153859be 41
d14ed18c 42DEF("compare", img_compare,
a8d16f9c 43 "compare [--object objectdef] [--image-opts] [-f fmt] [-F fmt] [-T src_cache] [-p] [-q] [-s] [-U] filename1 filename2")
195b5109
PM
44SRST
45.. option:: compare [--object OBJECTDEF] [--image-opts] [-f FMT] [-F FMT] [-T SRC_CACHE] [-p] [-q] [-s] [-U] FILENAME1 FILENAME2
46ERST
d14ed18c 47
153859be 48DEF("convert", img_convert,
1899bf47 49 "convert [--object objectdef] [--image-opts] [--target-image-opts] [--target-is-zero] [--bitmaps] [-U] [-C] [-c] [-p] [-q] [-n] [-f fmt] [-t cache] [-T src_cache] [-O output_fmt] [-B backing_file [-F backing_fmt]] [-o options] [-l snapshot_param] [-S sparse_size] [-r rate_limit] [-m num_coroutines] [-W] [--salvage] filename [filename2 [...]] output_filename")
195b5109 50SRST
9a5d1352 51.. option:: convert [--object OBJECTDEF] [--image-opts] [--target-image-opts] [--target-is-zero] [--bitmaps] [-U] [-C] [-c] [-p] [-q] [-n] [-f FMT] [-t CACHE] [-T SRC_CACHE] [-O OUTPUT_FMT] [-B BACKING_FILE [-F BACKING_FMT]] [-o OPTIONS] [-l SNAPSHOT_PARAM] [-S SPARSE_SIZE] [-r RATE_LIMIT] [-m NUM_COROUTINES] [-W] [--salvage] FILENAME [FILENAME2 [...]] OUTPUT_FILENAME
195b5109 52ERST
153859be 53
57b2d9d4 54DEF("create", img_create,
111fbd74 55 "create [--object objectdef] [-q] [-f fmt] [-b backing_file [-F backing_fmt]] [-u] [-o options] filename [size]")
195b5109 56SRST
111fbd74 57.. option:: create [--object OBJECTDEF] [-q] [-f FMT] [-b BACKING_FILE [-F BACKING_FMT]] [-u] [-o OPTIONS] FILENAME [SIZE]
195b5109 58ERST
57b2d9d4 59
86ce1f6e 60DEF("dd", img_dd,
a8d16f9c 61 "dd [--image-opts] [-U] [-f fmt] [-O output_fmt] [bs=block_size] [count=blocks] [skip=blocks] if=input of=output")
195b5109
PM
62SRST
63.. option:: dd [--image-opts] [-U] [-f FMT] [-O OUTPUT_FMT] [bs=BLOCK_SIZE] [count=BLOCKS] [skip=BLOCKS] if=INPUT of=OUTPUT
64ERST
86ce1f6e 65
153859be 66DEF("info", img_info,
a8d16f9c 67 "info [--object objectdef] [--image-opts] [-f fmt] [--output=ofmt] [--backing-chain] [-U] filename")
195b5109
PM
68SRST
69.. option:: info [--object OBJECTDEF] [--image-opts] [-f FMT] [--output=OFMT] [--backing-chain] [-U] FILENAME
70ERST
153859be 71
4c93a13b 72DEF("map", img_map,
c0469496 73 "map [--object objectdef] [--image-opts] [-f fmt] [--start-offset=offset] [--max-length=len] [--output=ofmt] [-U] filename")
195b5109 74SRST
c0469496 75.. option:: map [--object OBJECTDEF] [--image-opts] [-f FMT] [--start-offset=OFFSET] [--max-length=LEN] [--output=OFMT] [-U] FILENAME
195b5109 76ERST
4c93a13b 77
fd03c2b8
SH
78DEF("measure", img_measure,
79"measure [--output=ofmt] [-O output_fmt] [-o options] [--size N | [--object objectdef] [--image-opts] [-f fmt] [-l snapshot_param] filename]")
195b5109
PM
80SRST
81.. option:: measure [--output=OFMT] [-O OUTPUT_FMT] [-o OPTIONS] [--size N | [--object OBJECTDEF] [--image-opts] [-f FMT] [-l SNAPSHOT_PARAM] FILENAME]
82ERST
fd03c2b8 83
153859be 84DEF("snapshot", img_snapshot,
a8d16f9c 85 "snapshot [--object objectdef] [--image-opts] [-U] [-q] [-l | -a snapshot | -c snapshot | -d snapshot] filename")
195b5109
PM
86SRST
87.. option:: snapshot [--object OBJECTDEF] [--image-opts] [-U] [-q] [-l | -a SNAPSHOT | -c SNAPSHOT | -d SNAPSHOT] FILENAME
88ERST
3e85c6fd
KW
89
90DEF("rebase", img_rebase,
a8d16f9c 91 "rebase [--object objectdef] [--image-opts] [-U] [-q] [-f fmt] [-t cache] [-T src_cache] [-p] [-u] -b backing_file [-F backing_fmt] filename")
195b5109
PM
92SRST
93.. option:: rebase [--object OBJECTDEF] [--image-opts] [-U] [-q] [-f FMT] [-t CACHE] [-T SRC_CACHE] [-p] [-u] -b BACKING_FILE [-F BACKING_FMT] FILENAME
94ERST
ae6b0ed6
SH
95
96DEF("resize", img_resize,
9775fcdb 97 "resize [--object objectdef] [--image-opts] [-f fmt] [--preallocation=prealloc] [-q] [--shrink] filename [+ | -]size")
195b5109
PM
98SRST
99.. option:: resize [--object OBJECTDEF] [--image-opts] [-f FMT] [--preallocation=PREALLOC] [-q] [--shrink] FILENAME [+ | -]SIZE
100ERST