blob: 95677745f9064fe76ddd3e0af302c03f8204e08c [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,
Max Reitz40055952014-07-22 22:58:42 +020013 "check [-q] [-f fmt] [--output=ofmt] [-r [leaks | all]] [-T src_cache] filename")
Stuart Brady153859b2009-06-07 00:42:17 +010014STEXI
Max Reitz40055952014-07-22 22:58:42 +020015@item check [-q] [-f @var{fmt}] [--output=@var{ofmt}] [-r [leaks | all]] [-T @var{src_cache}] @var{filename}
Stuart Brady153859b2009-06-07 00:42:17 +010016ETEXI
17
18DEF("create", img_create,
Miroslav Rezaninaf382d432013-02-13 09:09:40 +010019 "create [-q] [-f fmt] [-o options] filename [size]")
Stuart Brady153859b2009-06-07 00:42:17 +010020STEXI
Miroslav Rezaninaf382d432013-02-13 09:09:40 +010021@item create [-q] [-f @var{fmt}] [-o @var{options}] @var{filename} [@var{size}]
Stuart Brady153859b2009-06-07 00:42:17 +010022ETEXI
23
24DEF("commit", img_commit,
Max Reitz1b22bff2014-10-24 15:57:40 +020025 "commit [-q] [-f fmt] [-t cache] [-b base] [-d] [-p] filename")
Stuart Brady153859b2009-06-07 00:42:17 +010026STEXI
Max Reitz1b22bff2014-10-24 15:57:40 +020027@item commit [-q] [-f @var{fmt}] [-t @var{cache}] [-b @var{base}] [-d] [-p] @var{filename}
Stuart Brady153859b2009-06-07 00:42:17 +010028ETEXI
29
Miroslav Rezaninad14ed182013-02-13 09:09:41 +010030DEF("compare", img_compare,
Max Reitz40055952014-07-22 22:58:42 +020031 "compare [-f fmt] [-F fmt] [-T src_cache] [-p] [-q] [-s] filename1 filename2")
Miroslav Rezaninad14ed182013-02-13 09:09:41 +010032STEXI
Max Reitz40055952014-07-22 22:58:42 +020033@item compare [-f @var{fmt}] [-F @var{fmt}] [-T @var{src_cache}] [-p] [-q] [-s] @var{filename1} @var{filename2}
Miroslav Rezaninad14ed182013-02-13 09:09:41 +010034ETEXI
35
Stuart Brady153859b2009-06-07 00:42:17 +010036DEF("convert", img_convert,
Max Reitz40055952014-07-22 22:58:42 +020037 "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")
Stuart Brady153859b2009-06-07 00:42:17 +010038STEXI
Max Reitz40055952014-07-22 22:58:42 +020039@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}
Stuart Brady153859b2009-06-07 00:42:17 +010040ETEXI
41
42DEF("info", img_info,
Kashyap Chamarthye5357562012-10-18 11:25:34 +053043 "info [-f fmt] [--output=ofmt] [--backing-chain] filename")
Stuart Brady153859b2009-06-07 00:42:17 +010044STEXI
Kashyap Chamarthye5357562012-10-18 11:25:34 +053045@item info [-f @var{fmt}] [--output=@var{ofmt}] [--backing-chain] @var{filename}
Stuart Brady153859b2009-06-07 00:42:17 +010046ETEXI
47
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +020048DEF("map", img_map,
49 "map [-f fmt] [--output=ofmt] filename")
50STEXI
51@item map [-f @var{fmt}] [--output=@var{ofmt}] @var{filename}
52ETEXI
53
Stuart Brady153859b2009-06-07 00:42:17 +010054DEF("snapshot", img_snapshot,
Miroslav Rezaninaf382d432013-02-13 09:09:40 +010055 "snapshot [-q] [-l | -a snapshot | -c snapshot | -d snapshot] filename")
Stuart Brady153859b2009-06-07 00:42:17 +010056STEXI
Miroslav Rezaninaf382d432013-02-13 09:09:40 +010057@item snapshot [-q] [-l | -a @var{snapshot} | -c @var{snapshot} | -d @var{snapshot}] @var{filename}
Kevin Wolf3e85c6f2010-01-12 12:55:18 +010058ETEXI
59
60DEF("rebase", img_rebase,
Max Reitz40055952014-07-22 22:58:42 +020061 "rebase [-q] [-f fmt] [-t cache] [-T src_cache] [-p] [-u] -b backing_file [-F backing_fmt] filename")
Kevin Wolf3e85c6f2010-01-12 12:55:18 +010062STEXI
Max Reitz40055952014-07-22 22:58:42 +020063@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}
Stefan Hajnocziae6b0ed2010-04-24 09:12:12 +010064ETEXI
65
66DEF("resize", img_resize,
Miroslav Rezaninaf382d432013-02-13 09:09:40 +010067 "resize [-q] filename [+ | -]size")
Stefan Hajnocziae6b0ed2010-04-24 09:12:12 +010068STEXI
Miroslav Rezaninaf382d432013-02-13 09:09:40 +010069@item resize [-q] @var{filename} [+ | -]@var{size}
Max Reitz6f176b42013-09-03 10:09:50 +020070ETEXI
71
72DEF("amend", img_amend,
Max Reitz76a3a342014-10-27 11:12:51 +010073 "amend [-p] [-q] [-f fmt] [-t cache] -o options filename")
Max Reitz6f176b42013-09-03 10:09:50 +020074STEXI
Max Reitz76a3a342014-10-27 11:12:51 +010075@item amend [-p] [-q] [-f @var{fmt}] [-t @var{cache}] -o @var{options} @var{filename}
Stuart Brady153859b2009-06-07 00:42:17 +010076@end table
77ETEXI