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