blob: f96876ae3b794c9a6049051d430b7b2b089f09d3 [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
10STEXI
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,
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,
25 "commit [-f fmt] filename")
26STEXI
27@item commit [-f @var{fmt}] @var{filename}
28ETEXI
29
30DEF("convert", img_convert,
Kevin Wolf8063d0f2009-10-28 12:49:16 +010031 "convert [-c] [-f fmt] [-O output_fmt] [-o options] filename [filename2 [...]] output_filename")
Stuart Brady153859b2009-06-07 00:42:17 +010032STEXI
Kevin Wolf8063d0f2009-10-28 12:49:16 +010033@item convert [-c] [-f @var{fmt}] [-O @var{output_fmt}] [-o @var{options}] @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,
Kevin Wolfcb66ffc2010-03-12 14:03:49 +010049 "rebase [-f fmt] [-u] -b backing_file [-F backing_fmt] filename")
Kevin Wolf3e85c6f2010-01-12 12:55:18 +010050STEXI
Kevin Wolfcb66ffc2010-03-12 14:03:49 +010051@item rebase [-f @var{fmt}] [-u] -b @var{backing_file} [-F @var{backing_fmt}] @var{filename}
Stuart Brady153859b2009-06-07 00:42:17 +010052@end table
53ETEXI