xref: /illumos-kvm-cmd/qemu-img-cmds.hx (revision 68396ea9)
1HXCOMM Use DEFHEADING() to define headings in both help text and texi
2HXCOMM Text between STEXI and ETEXI are copied to texi version and
3HXCOMM discarded from C version
4HXCOMM DEF(command, callback, arg_string) is used to construct
5HXCOMM command structures and help message.
6HXCOMM HXCOMM can be used for comments, discarded from both texi and C
7
8STEXI
9@table @option
10ETEXI
11
12DEF("check", img_check,
13    "check [-f fmt] filename")
14STEXI
15@item check [-f @var{fmt}] @var{filename}
16ETEXI
17
18DEF("create", img_create,
19    "create [-f fmt] [-o options] filename [size]")
20STEXI
21@item create [-f @var{fmt}] [-o @var{options}] @var{filename} [@var{size}]
22ETEXI
23
24DEF("commit", img_commit,
25    "commit [-f fmt] filename")
26STEXI
27@item commit [-f @var{fmt}] @var{filename}
28ETEXI
29
30DEF("convert", img_convert,
31    "convert [-c] [-f fmt] [-O output_fmt] [-o options] [-s snapshot_name] filename [filename2 [...]] output_filename")
32STEXI
33@item convert [-c] [-f @var{fmt}] [-O @var{output_fmt}] [-o @var{options}] [-s @var{snapshot_name}] @var{filename} [@var{filename2} [...]] @var{output_filename}
34ETEXI
35
36DEF("info", img_info,
37    "info [-f fmt] filename")
38STEXI
39@item info [-f @var{fmt}] @var{filename}
40ETEXI
41
42DEF("snapshot", img_snapshot,
43    "snapshot [-l | -a snapshot | -c snapshot | -d snapshot] filename")
44STEXI
45@item snapshot [-l | -a @var{snapshot} | -c @var{snapshot} | -d @var{snapshot}] @var{filename}
46ETEXI
47
48DEF("rebase", img_rebase,
49    "rebase [-f fmt] [-u] -b backing_file [-F backing_fmt] filename")
50STEXI
51@item rebase [-f @var{fmt}] [-u] -b @var{backing_file} [-F @var{backing_fmt}] @var{filename}
52ETEXI
53
54DEF("resize", img_resize,
55    "resize filename [+ | -]size")
56STEXI
57@item resize @var{filename} [+ | -]@var{size}
58@end table
59ETEXI
60