]>
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 | |
21 | ||
b6133b8c | 22 | DEF("bench", img_bench, |
a8d16f9c | 23 | "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] [-w] [-U] filename") |
b6133b8c | 24 | STEXI |
a8d16f9c | 25 | @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] [-U] @var{filename} |
b6133b8c KW |
26 | ETEXI |
27 | ||
153859be | 28 | DEF("check", img_check, |
65f389c0 | 29 | "check [--object objectdef] [--image-opts] [-q] [-f fmt] [--output=ofmt] [-r [leaks | all]] [-T src_cache] [-U] filename") |
153859be | 30 | STEXI |
a8d16f9c | 31 | @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 SB |
32 | ETEXI |
33 | ||
153859be | 34 | DEF("commit", img_commit, |
65f389c0 | 35 | "commit [--object objectdef] [--image-opts] [-q] [-f fmt] [-t cache] [-b base] [-d] [-p] filename") |
153859be | 36 | STEXI |
eb769f74 | 37 | @item commit [--object @var{objectdef}] [--image-opts] [-q] [-f @var{fmt}] [-t @var{cache}] [-b @var{base}] [-d] [-p] @var{filename} |
153859be SB |
38 | ETEXI |
39 | ||
d14ed18c | 40 | DEF("compare", img_compare, |
a8d16f9c | 41 | "compare [--object objectdef] [--image-opts] [-f fmt] [-F fmt] [-T src_cache] [-p] [-q] [-s] [-U] filename1 filename2") |
d14ed18c | 42 | STEXI |
a8d16f9c | 43 | @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 MR |
44 | ETEXI |
45 | ||
153859be | 46 | DEF("convert", img_convert, |
8eaac025 | 47 | "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 | 48 | STEXI |
8eaac025 | 49 | @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 SB |
50 | ETEXI |
51 | ||
57b2d9d4 | 52 | DEF("create", img_create, |
65f389c0 | 53 | "create [--object objectdef] [-q] [-f fmt] [-b backing_file] [-F backing_fmt] [-u] [-o options] filename [size]") |
57b2d9d4 EB |
54 | STEXI |
55 | @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}] | |
56 | ETEXI | |
57 | ||
86ce1f6e | 58 | DEF("dd", img_dd, |
a8d16f9c | 59 | "dd [--image-opts] [-U] [-f fmt] [-O output_fmt] [bs=block_size] [count=blocks] [skip=blocks] if=input of=output") |
86ce1f6e | 60 | STEXI |
a8d16f9c | 61 | @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 RS |
62 | ETEXI |
63 | ||
153859be | 64 | DEF("info", img_info, |
a8d16f9c | 65 | "info [--object objectdef] [--image-opts] [-f fmt] [--output=ofmt] [--backing-chain] [-U] filename") |
153859be | 66 | STEXI |
a8d16f9c | 67 | @item info [--object @var{objectdef}] [--image-opts] [-f @var{fmt}] [--output=@var{ofmt}] [--backing-chain] [-U] @var{filename} |
153859be SB |
68 | ETEXI |
69 | ||
4c93a13b | 70 | DEF("map", img_map, |
a8d16f9c | 71 | "map [--object objectdef] [--image-opts] [-f fmt] [--output=ofmt] [-U] filename") |
4c93a13b | 72 | STEXI |
a8d16f9c | 73 | @item map [--object @var{objectdef}] [--image-opts] [-f @var{fmt}] [--output=@var{ofmt}] [-U] @var{filename} |
4c93a13b PB |
74 | ETEXI |
75 | ||
fd03c2b8 SH |
76 | DEF("measure", img_measure, |
77 | "measure [--output=ofmt] [-O output_fmt] [-o options] [--size N | [--object objectdef] [--image-opts] [-f fmt] [-l snapshot_param] filename]") | |
78 | STEXI | |
79 | @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}] | |
80 | ETEXI | |
81 | ||
153859be | 82 | DEF("snapshot", img_snapshot, |
a8d16f9c | 83 | "snapshot [--object objectdef] [--image-opts] [-U] [-q] [-l | -a snapshot | -c snapshot | -d snapshot] filename") |
153859be | 84 | STEXI |
a8d16f9c | 85 | @item snapshot [--object @var{objectdef}] [--image-opts] [-U] [-q] [-l | -a @var{snapshot} | -c @var{snapshot} | -d @var{snapshot}] @var{filename} |
3e85c6fd KW |
86 | ETEXI |
87 | ||
88 | DEF("rebase", img_rebase, | |
a8d16f9c | 89 | "rebase [--object objectdef] [--image-opts] [-U] [-q] [-f fmt] [-t cache] [-T src_cache] [-p] [-u] -b backing_file [-F backing_fmt] filename") |
3e85c6fd | 90 | STEXI |
a8d16f9c | 91 | @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 SH |
92 | ETEXI |
93 | ||
94 | DEF("resize", img_resize, | |
9775fcdb | 95 | "resize [--object objectdef] [--image-opts] [-f fmt] [--preallocation=prealloc] [-q] [--shrink] filename [+ | -]size") |
ae6b0ed6 | 96 | STEXI |
9775fcdb | 97 | @item resize [--object @var{objectdef}] [--image-opts] [-f @var{fmt}] [--preallocation=@var{prealloc}] [-q] [--shrink] @var{filename} [+ | -]@var{size} |
6f176b48 HR |
98 | ETEXI |
99 | ||
6f176b48 | 100 | STEXI |
153859be SB |
101 | @end table |
102 | ETEXI |