]> git.ipfire.org Git - thirdparty/qemu.git/blame - qemu-img-cmds.hx
block: Avoid memleak on qcow2 image info failure
[thirdparty/qemu.git] / qemu-img-cmds.hx
CommitLineData
57b2d9d4 1HXCOMM Keep the list of subcommands sorted by name.
153859be 2HXCOMM Use DEFHEADING() to define headings in both help text and texi
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
4885b0ca
JS
10HXCOMM over to the per-command sections in qemu-img.texi.
11
57b2d9d4
EB
12DEF("amend", img_amend,
13 "amend [--object objectdef] [--image-opts] [-p] [-q] [-f fmt] [-t cache] -o options filename")
195b5109
PM
14SRST
15.. option:: amend [--object OBJECTDEF] [--image-opts] [-p] [-q] [-f FMT] [-t CACHE] -o OPTIONS FILENAME
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
153859be 23DEF("check", img_check,
65f389c0 24 "check [--object objectdef] [--image-opts] [-q] [-f fmt] [--output=ofmt] [-r [leaks | all]] [-T src_cache] [-U] filename")
195b5109
PM
25SRST
26.. option:: check [--object OBJECTDEF] [--image-opts] [-q] [-f FMT] [--output=OFMT] [-r [leaks | all]] [-T SRC_CACHE] [-U] FILENAME
27ERST
153859be 28
153859be 29DEF("commit", img_commit,
65f389c0 30 "commit [--object objectdef] [--image-opts] [-q] [-f fmt] [-t cache] [-b base] [-d] [-p] filename")
195b5109
PM
31SRST
32.. option:: commit [--object OBJECTDEF] [--image-opts] [-q] [-f FMT] [-t CACHE] [-b BASE] [-d] [-p] FILENAME
33ERST
153859be 34
d14ed18c 35DEF("compare", img_compare,
a8d16f9c 36 "compare [--object objectdef] [--image-opts] [-f fmt] [-F fmt] [-T src_cache] [-p] [-q] [-s] [-U] filename1 filename2")
195b5109
PM
37SRST
38.. option:: compare [--object OBJECTDEF] [--image-opts] [-f FMT] [-F FMT] [-T SRC_CACHE] [-p] [-q] [-s] [-U] FILENAME1 FILENAME2
39ERST
d14ed18c 40
153859be 41DEF("convert", img_convert,
168468fe 42 "convert [--object objectdef] [--image-opts] [--target-image-opts] [--target-is-zero] [-U] [-C] [-c] [-p] [-q] [-n] [-f fmt] [-t cache] [-T src_cache] [-O output_fmt] [-B backing_file] [-o options] [-l snapshot_param] [-S sparse_size] [-m num_coroutines] [-W] [--salvage] filename [filename2 [...]] output_filename")
195b5109 43SRST
168468fe 44.. option:: convert [--object OBJECTDEF] [--image-opts] [--target-image-opts] [--target-is-zero] [-U] [-C] [-c] [-p] [-q] [-n] [-f FMT] [-t CACHE] [-T SRC_CACHE] [-O OUTPUT_FMT] [-B BACKING_FILE] [-o OPTIONS] [-l SNAPSHOT_PARAM] [-S SPARSE_SIZE] [-m NUM_COROUTINES] [-W] [--salvage] FILENAME [FILENAME2 [...]] OUTPUT_FILENAME
195b5109 45ERST
153859be 46
57b2d9d4 47DEF("create", img_create,
65f389c0 48 "create [--object objectdef] [-q] [-f fmt] [-b backing_file] [-F backing_fmt] [-u] [-o options] filename [size]")
195b5109
PM
49SRST
50.. option:: create [--object OBJECTDEF] [-q] [-f FMT] [-b BACKING_FILE] [-F BACKING_FMT] [-u] [-o OPTIONS] FILENAME [SIZE]
51ERST
57b2d9d4 52
86ce1f6e 53DEF("dd", img_dd,
a8d16f9c 54 "dd [--image-opts] [-U] [-f fmt] [-O output_fmt] [bs=block_size] [count=blocks] [skip=blocks] if=input of=output")
195b5109
PM
55SRST
56.. option:: dd [--image-opts] [-U] [-f FMT] [-O OUTPUT_FMT] [bs=BLOCK_SIZE] [count=BLOCKS] [skip=BLOCKS] if=INPUT of=OUTPUT
57ERST
86ce1f6e 58
153859be 59DEF("info", img_info,
a8d16f9c 60 "info [--object objectdef] [--image-opts] [-f fmt] [--output=ofmt] [--backing-chain] [-U] filename")
195b5109
PM
61SRST
62.. option:: info [--object OBJECTDEF] [--image-opts] [-f FMT] [--output=OFMT] [--backing-chain] [-U] FILENAME
63ERST
153859be 64
4c93a13b 65DEF("map", img_map,
a8d16f9c 66 "map [--object objectdef] [--image-opts] [-f fmt] [--output=ofmt] [-U] filename")
195b5109
PM
67SRST
68.. option:: map [--object OBJECTDEF] [--image-opts] [-f FMT] [--output=OFMT] [-U] FILENAME
69ERST
4c93a13b 70
fd03c2b8
SH
71DEF("measure", img_measure,
72"measure [--output=ofmt] [-O output_fmt] [-o options] [--size N | [--object objectdef] [--image-opts] [-f fmt] [-l snapshot_param] filename]")
195b5109
PM
73SRST
74.. option:: measure [--output=OFMT] [-O OUTPUT_FMT] [-o OPTIONS] [--size N | [--object OBJECTDEF] [--image-opts] [-f FMT] [-l SNAPSHOT_PARAM] FILENAME]
75ERST
fd03c2b8 76
153859be 77DEF("snapshot", img_snapshot,
a8d16f9c 78 "snapshot [--object objectdef] [--image-opts] [-U] [-q] [-l | -a snapshot | -c snapshot | -d snapshot] filename")
195b5109
PM
79SRST
80.. option:: snapshot [--object OBJECTDEF] [--image-opts] [-U] [-q] [-l | -a SNAPSHOT | -c SNAPSHOT | -d SNAPSHOT] FILENAME
81ERST
3e85c6fd
KW
82
83DEF("rebase", img_rebase,
a8d16f9c 84 "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
85SRST
86.. option:: rebase [--object OBJECTDEF] [--image-opts] [-U] [-q] [-f FMT] [-t CACHE] [-T SRC_CACHE] [-p] [-u] -b BACKING_FILE [-F BACKING_FMT] FILENAME
87ERST
ae6b0ed6
SH
88
89DEF("resize", img_resize,
9775fcdb 90 "resize [--object objectdef] [--image-opts] [-f fmt] [--preallocation=prealloc] [-q] [--shrink] filename [+ | -]size")
195b5109
PM
91SRST
92.. option:: resize [--object OBJECTDEF] [--image-opts] [-f FMT] [--preallocation=PREALLOC] [-q] [--shrink] FILENAME [+ | -]SIZE
93ERST