blob: 4be00a5eddd7383834fc801c66aaf1a9d19e6321 [file] [log] [blame]
Stuart Brady153859b2009-06-07 00:42:17 +01001HXCOMM 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
Jan Kiszka3c4c3212010-05-20 09:16:30 +020010ETEXI
Stuart Brady153859b2009-06-07 00:42:17 +010011
12DEF("check", img_check,
13 "check [-f fmt] filename")
14STEXI
15@item check [-f @var{fmt}] @var{filename}
16ETEXI
17
18DEF("create", img_create,
Kevin Wolf8063d0f2009-10-28 12:49:16 +010019 "create [-f fmt] [-o options] filename [size]")
Stuart Brady153859b2009-06-07 00:42:17 +010020STEXI
Kevin Wolf8063d0f2009-10-28 12:49:16 +010021@item create [-f @var{fmt}] [-o @var{options}] @var{filename} [@var{size}]
Stuart Brady153859b2009-06-07 00:42:17 +010022ETEXI
23
24DEF("commit", img_commit,
Federico Simoncelli661a0f72011-06-20 12:48:19 -040025 "commit [-f fmt] [-t cache] filename")
Stuart Brady153859b2009-06-07 00:42:17 +010026STEXI
27@item commit [-f @var{fmt}] @var{filename}
28ETEXI
29
30DEF("convert", img_convert,
Kevin Wolfa22f1232011-08-26 15:27:13 +020031 "convert [-c] [-p] [-f fmt] [-t cache] [-O output_fmt] [-o options] [-s snapshot_name] [-S sparse_size] filename [filename2 [...]] output_filename")
Stuart Brady153859b2009-06-07 00:42:17 +010032STEXI
Kevin Wolfa22f1232011-08-26 15:27:13 +020033@item convert [-c] [-p] [-f @var{fmt}] [-O @var{output_fmt}] [-o @var{options}] [-s @var{snapshot_name}] [-S @var{sparse_size}] @var{filename} [@var{filename2} [...]] @var{output_filename}
Stuart Brady153859b2009-06-07 00:42:17 +010034ETEXI
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}
Kevin Wolf3e85c6f2010-01-12 12:55:18 +010046ETEXI
47
48DEF("rebase", img_rebase,
Federico Simoncelli661a0f72011-06-20 12:48:19 -040049 "rebase [-f fmt] [-t cache] [-p] [-u] -b backing_file [-F backing_fmt] filename")
Kevin Wolf3e85c6f2010-01-12 12:55:18 +010050STEXI
Jes Sorensenaaf55b42011-07-19 15:01:34 +020051@item rebase [-f @var{fmt}] [-p] [-u] -b @var{backing_file} [-F @var{backing_fmt}] @var{filename}
Stefan Hajnocziae6b0ed2010-04-24 09:12:12 +010052ETEXI
53
54DEF("resize", img_resize,
55 "resize filename [+ | -]size")
56STEXI
Stefan Weil5fb58b02010-07-09 20:30:07 +020057@item resize @var{filename} [+ | -]@var{size}
Stuart Brady153859b2009-06-07 00:42:17 +010058@end table
59ETEXI