]>
Commit | Line | Data |
---|---|---|
57b2d9d4 | 1 | HXCOMM Keep the list of subcommands sorted by name. |
153859be SB |
2 | HXCOMM Use DEFHEADING() to define headings in both help text and texi |
3 | HXCOMM Text between STEXI and ETEXI are copied to texi version and | |
4 | HXCOMM discarded from C version | |
5 | HXCOMM DEF(command, callback, arg_string) is used to construct | |
6 | HXCOMM command structures and help message. | |
7 | HXCOMM HXCOMM can be used for comments, discarded from both texi and C | |
8 | ||
4885b0ca JS |
9 | HXCOMM When amending the TEXI sections, please remember to copy the usage |
10 | HXCOMM over to the per-command sections in qemu-img.texi. | |
11 | ||
153859be SB |
12 | STEXI |
13 | @table @option | |
3c4c3210 | 14 | ETEXI |
153859be | 15 | |
57b2d9d4 EB |
16 | DEF("amend", img_amend, |
17 | "amend [--object objectdef] [--image-opts] [-p] [-q] [-f fmt] [-t cache] -o options filename") | |
18 | STEXI | |
19 | @item amend [--object @var{objectdef}] [--image-opts] [-p] [-q] [-f @var{fmt}] [-t @var{cache}] -o @var{options} @var{filename} | |
20 | ETEXI | |
195b5109 PM |
21 | SRST |
22 | .. option:: amend [--object OBJECTDEF] [--image-opts] [-p] [-q] [-f FMT] [-t CACHE] -o OPTIONS FILENAME | |
23 | ERST | |
57b2d9d4 | 24 | |
b6133b8c | 25 | DEF("bench", img_bench, |
cdd26774 | 26 | "bench [-c count] [-d depth] [-f fmt] [--flush-interval=flush_interval] [-n] [--no-drain] [-o offset] [--pattern=pattern] [-q] [-s buffer_size] [-S step_size] [-t cache] [-i aio] [-w] [-U] filename") |
b6133b8c | 27 | STEXI |
cdd26774 | 28 | @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}] [-i @var{aio}] [-w] [-U] @var{filename} |
b6133b8c | 29 | ETEXI |
195b5109 PM |
30 | SRST |
31 | .. option:: bench [-c COUNT] [-d DEPTH] [-f FMT] [--flush-interval=FLUSH_INTERVAL] [-n] [--no-drain] [-o OFFSET] [--pattern=PATTERN] [-q] [-s BUFFER_SIZE] [-S STEP_SIZE] [-t CACHE] [-i AIO] [-w] [-U] FILENAME | |
32 | ERST | |
153859be | 33 | DEF("check", img_check, |
65f389c0 | 34 | "check [--object objectdef] [--image-opts] [-q] [-f fmt] [--output=ofmt] [-r [leaks | all]] [-T src_cache] [-U] filename") |
153859be | 35 | STEXI |
a8d16f9c | 36 | @item check [--object @var{objectdef}] [--image-opts] [-q] [-f @var{fmt}] [--output=@var{ofmt}] [-r [leaks | all]] [-T @var{src_cache}] [-U] @var{filename} |
153859be | 37 | ETEXI |
195b5109 PM |
38 | SRST |
39 | .. option:: check [--object OBJECTDEF] [--image-opts] [-q] [-f FMT] [--output=OFMT] [-r [leaks | all]] [-T SRC_CACHE] [-U] FILENAME | |
40 | ERST | |
153859be | 41 | |
153859be | 42 | DEF("commit", img_commit, |
65f389c0 | 43 | "commit [--object objectdef] [--image-opts] [-q] [-f fmt] [-t cache] [-b base] [-d] [-p] filename") |
153859be | 44 | STEXI |
eb769f74 | 45 | @item commit [--object @var{objectdef}] [--image-opts] [-q] [-f @var{fmt}] [-t @var{cache}] [-b @var{base}] [-d] [-p] @var{filename} |
153859be | 46 | ETEXI |
195b5109 PM |
47 | SRST |
48 | .. option:: commit [--object OBJECTDEF] [--image-opts] [-q] [-f FMT] [-t CACHE] [-b BASE] [-d] [-p] FILENAME | |
49 | ERST | |
153859be | 50 | |
d14ed18c | 51 | DEF("compare", img_compare, |
a8d16f9c | 52 | "compare [--object objectdef] [--image-opts] [-f fmt] [-F fmt] [-T src_cache] [-p] [-q] [-s] [-U] filename1 filename2") |
d14ed18c | 53 | STEXI |
a8d16f9c | 54 | @item compare [--object @var{objectdef}] [--image-opts] [-f @var{fmt}] [-F @var{fmt}] [-T @var{src_cache}] [-p] [-q] [-s] [-U] @var{filename1} @var{filename2} |
d14ed18c | 55 | ETEXI |
195b5109 PM |
56 | SRST |
57 | .. option:: compare [--object OBJECTDEF] [--image-opts] [-f FMT] [-F FMT] [-T SRC_CACHE] [-p] [-q] [-s] [-U] FILENAME1 FILENAME2 | |
58 | ERST | |
d14ed18c | 59 | |
153859be | 60 | DEF("convert", img_convert, |
8eaac025 | 61 | "convert [--object objectdef] [--image-opts] [--target-image-opts] [-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") |
153859be | 62 | STEXI |
8eaac025 | 63 | @item convert [--object @var{objectdef}] [--image-opts] [--target-image-opts] [-U] [-C] [-c] [-p] [-q] [-n] [-f @var{fmt}] [-t @var{cache}] [-T @var{src_cache}] [-O @var{output_fmt}] [-B @var{backing_file}] [-o @var{options}] [-l @var{snapshot_param}] [-S @var{sparse_size}] [-m @var{num_coroutines}] [-W] [--salvage] @var{filename} [@var{filename2} [...]] @var{output_filename} |
153859be | 64 | ETEXI |
195b5109 PM |
65 | SRST |
66 | .. option:: convert [--object OBJECTDEF] [--image-opts] [--target-image-opts] [-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 | |
67 | ERST | |
153859be | 68 | |
57b2d9d4 | 69 | DEF("create", img_create, |
65f389c0 | 70 | "create [--object objectdef] [-q] [-f fmt] [-b backing_file] [-F backing_fmt] [-u] [-o options] filename [size]") |
57b2d9d4 EB |
71 | STEXI |
72 | @item create [--object @var{objectdef}] [-q] [-f @var{fmt}] [-b @var{backing_file}] [-F @var{backing_fmt}] [-u] [-o @var{options}] @var{filename} [@var{size}] | |
73 | ETEXI | |
195b5109 PM |
74 | SRST |
75 | .. option:: create [--object OBJECTDEF] [-q] [-f FMT] [-b BACKING_FILE] [-F BACKING_FMT] [-u] [-o OPTIONS] FILENAME [SIZE] | |
76 | ERST | |
57b2d9d4 | 77 | |
86ce1f6e | 78 | DEF("dd", img_dd, |
a8d16f9c | 79 | "dd [--image-opts] [-U] [-f fmt] [-O output_fmt] [bs=block_size] [count=blocks] [skip=blocks] if=input of=output") |
86ce1f6e | 80 | STEXI |
a8d16f9c | 81 | @item dd [--image-opts] [-U] [-f @var{fmt}] [-O @var{output_fmt}] [bs=@var{block_size}] [count=@var{blocks}] [skip=@var{blocks}] if=@var{input} of=@var{output} |
86ce1f6e | 82 | ETEXI |
195b5109 PM |
83 | SRST |
84 | .. option:: dd [--image-opts] [-U] [-f FMT] [-O OUTPUT_FMT] [bs=BLOCK_SIZE] [count=BLOCKS] [skip=BLOCKS] if=INPUT of=OUTPUT | |
85 | ERST | |
86ce1f6e | 86 | |
153859be | 87 | DEF("info", img_info, |
a8d16f9c | 88 | "info [--object objectdef] [--image-opts] [-f fmt] [--output=ofmt] [--backing-chain] [-U] filename") |
153859be | 89 | STEXI |
a8d16f9c | 90 | @item info [--object @var{objectdef}] [--image-opts] [-f @var{fmt}] [--output=@var{ofmt}] [--backing-chain] [-U] @var{filename} |
153859be | 91 | ETEXI |
195b5109 PM |
92 | SRST |
93 | .. option:: info [--object OBJECTDEF] [--image-opts] [-f FMT] [--output=OFMT] [--backing-chain] [-U] FILENAME | |
94 | ERST | |
153859be | 95 | |
4c93a13b | 96 | DEF("map", img_map, |
a8d16f9c | 97 | "map [--object objectdef] [--image-opts] [-f fmt] [--output=ofmt] [-U] filename") |
4c93a13b | 98 | STEXI |
a8d16f9c | 99 | @item map [--object @var{objectdef}] [--image-opts] [-f @var{fmt}] [--output=@var{ofmt}] [-U] @var{filename} |
4c93a13b | 100 | ETEXI |
195b5109 PM |
101 | SRST |
102 | .. option:: map [--object OBJECTDEF] [--image-opts] [-f FMT] [--output=OFMT] [-U] FILENAME | |
103 | ERST | |
4c93a13b | 104 | |
fd03c2b8 SH |
105 | DEF("measure", img_measure, |
106 | "measure [--output=ofmt] [-O output_fmt] [-o options] [--size N | [--object objectdef] [--image-opts] [-f fmt] [-l snapshot_param] filename]") | |
107 | STEXI | |
108 | @item measure [--output=@var{ofmt}] [-O @var{output_fmt}] [-o @var{options}] [--size @var{N} | [--object @var{objectdef}] [--image-opts] [-f @var{fmt}] [-l @var{snapshot_param}] @var{filename}] | |
109 | ETEXI | |
195b5109 PM |
110 | SRST |
111 | .. option:: measure [--output=OFMT] [-O OUTPUT_FMT] [-o OPTIONS] [--size N | [--object OBJECTDEF] [--image-opts] [-f FMT] [-l SNAPSHOT_PARAM] FILENAME] | |
112 | ERST | |
fd03c2b8 | 113 | |
153859be | 114 | DEF("snapshot", img_snapshot, |
a8d16f9c | 115 | "snapshot [--object objectdef] [--image-opts] [-U] [-q] [-l | -a snapshot | -c snapshot | -d snapshot] filename") |
153859be | 116 | STEXI |
a8d16f9c | 117 | @item snapshot [--object @var{objectdef}] [--image-opts] [-U] [-q] [-l | -a @var{snapshot} | -c @var{snapshot} | -d @var{snapshot}] @var{filename} |
3e85c6fd | 118 | ETEXI |
195b5109 PM |
119 | SRST |
120 | .. option:: snapshot [--object OBJECTDEF] [--image-opts] [-U] [-q] [-l | -a SNAPSHOT | -c SNAPSHOT | -d SNAPSHOT] FILENAME | |
121 | ERST | |
3e85c6fd KW |
122 | |
123 | DEF("rebase", img_rebase, | |
a8d16f9c | 124 | "rebase [--object objectdef] [--image-opts] [-U] [-q] [-f fmt] [-t cache] [-T src_cache] [-p] [-u] -b backing_file [-F backing_fmt] filename") |
3e85c6fd | 125 | STEXI |
a8d16f9c | 126 | @item rebase [--object @var{objectdef}] [--image-opts] [-U] [-q] [-f @var{fmt}] [-t @var{cache}] [-T @var{src_cache}] [-p] [-u] -b @var{backing_file} [-F @var{backing_fmt}] @var{filename} |
ae6b0ed6 | 127 | ETEXI |
195b5109 PM |
128 | SRST |
129 | .. option:: rebase [--object OBJECTDEF] [--image-opts] [-U] [-q] [-f FMT] [-t CACHE] [-T SRC_CACHE] [-p] [-u] -b BACKING_FILE [-F BACKING_FMT] FILENAME | |
130 | ERST | |
ae6b0ed6 SH |
131 | |
132 | DEF("resize", img_resize, | |
9775fcdb | 133 | "resize [--object objectdef] [--image-opts] [-f fmt] [--preallocation=prealloc] [-q] [--shrink] filename [+ | -]size") |
ae6b0ed6 | 134 | STEXI |
9775fcdb | 135 | @item resize [--object @var{objectdef}] [--image-opts] [-f @var{fmt}] [--preallocation=@var{prealloc}] [-q] [--shrink] @var{filename} [+ | -]@var{size} |
6f176b48 | 136 | ETEXI |
195b5109 PM |
137 | SRST |
138 | .. option:: resize [--object OBJECTDEF] [--image-opts] [-f FMT] [--preallocation=PREALLOC] [-q] [--shrink] FILENAME [+ | -]SIZE | |
139 | ERST | |
6f176b48 | 140 | |
6f176b48 | 141 | STEXI |
153859be SB |
142 | @end table |
143 | ETEXI |