xref: /openbmc/qemu/qemu-img-cmds.hx (revision 461a2753)
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 [-q] [-f fmt] [--output=ofmt] [-r [leaks | all]] [-T src_cache] filename")
14STEXI
15@item check [-q] [-f @var{fmt}] [--output=@var{ofmt}] [-r [leaks | all]] [-T @var{src_cache}] @var{filename}
16ETEXI
17
18DEF("create", img_create,
19    "create [-q] [-f fmt] [-o options] filename [size]")
20STEXI
21@item create [-q] [-f @var{fmt}] [-o @var{options}] @var{filename} [@var{size}]
22ETEXI
23
24DEF("commit", img_commit,
25    "commit [-q] [-f fmt] [-t cache] filename")
26STEXI
27@item commit [-q] [-f @var{fmt}] [-t @var{cache}] @var{filename}
28ETEXI
29
30DEF("compare", img_compare,
31    "compare [-f fmt] [-F fmt] [-T src_cache] [-p] [-q] [-s] filename1 filename2")
32STEXI
33@item compare [-f @var{fmt}] [-F @var{fmt}] [-T @var{src_cache}] [-p] [-q] [-s] @var{filename1} @var{filename2}
34ETEXI
35
36DEF("convert", img_convert,
37    "convert [-c] [-p] [-q] [-n] [-f fmt] [-t cache] [-T src_cache] [-O output_fmt] [-o options] [-s snapshot_id_or_name] [-l snapshot_param] [-S sparse_size] filename [filename2 [...]] output_filename")
38STEXI
39@item convert [-c] [-p] [-q] [-n] [-f @var{fmt}] [-t @var{cache}] [-T @var{src_cache}] [-O @var{output_fmt}] [-o @var{options}] [-s @var{snapshot_id_or_name}] [-l @var{snapshot_param}] [-S @var{sparse_size}] @var{filename} [@var{filename2} [...]] @var{output_filename}
40ETEXI
41
42DEF("info", img_info,
43    "info [-f fmt] [--output=ofmt] [--backing-chain] filename")
44STEXI
45@item info [-f @var{fmt}] [--output=@var{ofmt}] [--backing-chain] @var{filename}
46ETEXI
47
48DEF("map", img_map,
49    "map [-f fmt] [--output=ofmt] filename")
50STEXI
51@item map [-f @var{fmt}] [--output=@var{ofmt}] @var{filename}
52ETEXI
53
54DEF("snapshot", img_snapshot,
55    "snapshot [-q] [-l | -a snapshot | -c snapshot | -d snapshot] filename")
56STEXI
57@item snapshot [-q] [-l | -a @var{snapshot} | -c @var{snapshot} | -d @var{snapshot}] @var{filename}
58ETEXI
59
60DEF("rebase", img_rebase,
61    "rebase [-q] [-f fmt] [-t cache] [-T src_cache] [-p] [-u] -b backing_file [-F backing_fmt] filename")
62STEXI
63@item rebase [-q] [-f @var{fmt}] [-t @var{cache}] [-T @var{src_cache}] [-p] [-u] -b @var{backing_file} [-F @var{backing_fmt}] @var{filename}
64ETEXI
65
66DEF("resize", img_resize,
67    "resize [-q] filename [+ | -]size")
68STEXI
69@item resize [-q] @var{filename} [+ | -]@var{size}
70ETEXI
71
72DEF("amend", img_amend,
73    "amend [-q] [-f fmt] [-t cache] -o options filename")
74STEXI
75@item amend [-q] [-f @var{fmt}] [-t @var{cache}] -o @var{options} @var{filename}
76@end table
77ETEXI
78