Merge remote-tracking branch 'remotes/cohuck/tags/s390x-20150528' into staging
[qemu/qmp-unstable.git] / qemu-img-cmds.hx
blob95677745f9064fe76ddd3e0af302c03f8204e08c
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
8 STEXI
9 @table @option
10 ETEXI
12 DEF("check", img_check,
13 "check [-q] [-f fmt] [--output=ofmt] [-r [leaks | all]] [-T src_cache] filename")
14 STEXI
15 @item check [-q] [-f @var{fmt}] [--output=@var{ofmt}] [-r [leaks | all]] [-T @var{src_cache}] @var{filename}
16 ETEXI
18 DEF("create", img_create,
19 "create [-q] [-f fmt] [-o options] filename [size]")
20 STEXI
21 @item create [-q] [-f @var{fmt}] [-o @var{options}] @var{filename} [@var{size}]
22 ETEXI
24 DEF("commit", img_commit,
25 "commit [-q] [-f fmt] [-t cache] [-b base] [-d] [-p] filename")
26 STEXI
27 @item commit [-q] [-f @var{fmt}] [-t @var{cache}] [-b @var{base}] [-d] [-p] @var{filename}
28 ETEXI
30 DEF("compare", img_compare,
31 "compare [-f fmt] [-F fmt] [-T src_cache] [-p] [-q] [-s] filename1 filename2")
32 STEXI
33 @item compare [-f @var{fmt}] [-F @var{fmt}] [-T @var{src_cache}] [-p] [-q] [-s] @var{filename1} @var{filename2}
34 ETEXI
36 DEF("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")
38 STEXI
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}
40 ETEXI
42 DEF("info", img_info,
43 "info [-f fmt] [--output=ofmt] [--backing-chain] filename")
44 STEXI
45 @item info [-f @var{fmt}] [--output=@var{ofmt}] [--backing-chain] @var{filename}
46 ETEXI
48 DEF("map", img_map,
49 "map [-f fmt] [--output=ofmt] filename")
50 STEXI
51 @item map [-f @var{fmt}] [--output=@var{ofmt}] @var{filename}
52 ETEXI
54 DEF("snapshot", img_snapshot,
55 "snapshot [-q] [-l | -a snapshot | -c snapshot | -d snapshot] filename")
56 STEXI
57 @item snapshot [-q] [-l | -a @var{snapshot} | -c @var{snapshot} | -d @var{snapshot}] @var{filename}
58 ETEXI
60 DEF("rebase", img_rebase,
61 "rebase [-q] [-f fmt] [-t cache] [-T src_cache] [-p] [-u] -b backing_file [-F backing_fmt] filename")
62 STEXI
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}
64 ETEXI
66 DEF("resize", img_resize,
67 "resize [-q] filename [+ | -]size")
68 STEXI
69 @item resize [-q] @var{filename} [+ | -]@var{size}
70 ETEXI
72 DEF("amend", img_amend,
73 "amend [-p] [-q] [-f fmt] [-t cache] -o options filename")
74 STEXI
75 @item amend [-p] [-q] [-f @var{fmt}] [-t @var{cache}] -o @var{options} @var{filename}
76 @end table
77 ETEXI