blob: f054599a91253ccd4e149c1baf04c78ccfb06b97 [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
Kevin Wolfb6133b82014-08-05 14:17:13 +020012DEF("bench", img_bench,
Kevin Wolf55d539c2016-06-03 13:59:41 +020013 "bench [-c count] [-d depth] [-f fmt] [--flush-interval=flush_interval] [-n] [--no-drain] [-o offset] [--pattern=pattern] [-q] [-s buffer_size] [-S step_size] [-t cache] [-w] filename")
Kevin Wolfb6133b82014-08-05 14:17:13 +020014STEXI
Kevin Wolf55d539c2016-06-03 13:59:41 +020015@item bench [-c @var{count}] [-d @var{depth}] [-f @var{fmt}] [--flush-interval=@var{flush_interval}] [-n] [--no-drain] [-o @var{offset}] [--pattern=@var{pattern}] [-q] [-s @var{buffer_size}] [-S @var{step_size}] [-t @var{cache}] [-w] @var{filename}
Kevin Wolfb6133b82014-08-05 14:17:13 +020016ETEXI
17
Stuart Brady153859b2009-06-07 00:42:17 +010018DEF("check", img_check,
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +000019 "check [-q] [--object objectdef] [--image-opts] [-f fmt] [--output=ofmt] [-r [leaks | all]] [-T src_cache] filename")
Stuart Brady153859b2009-06-07 00:42:17 +010020STEXI
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +000021@item check [--object @var{objectdef}] [--image-opts] [-q] [-f @var{fmt}] [--output=@var{ofmt}] [-r [leaks | all]] [-T @var{src_cache}] @var{filename}
Stuart Brady153859b2009-06-07 00:42:17 +010022ETEXI
23
24DEF("create", img_create,
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +000025 "create [-q] [--object objectdef] [--image-opts] [-f fmt] [-o options] filename [size]")
Stuart Brady153859b2009-06-07 00:42:17 +010026STEXI
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +000027@item create [--object @var{objectdef}] [--image-opts] [-q] [-f @var{fmt}] [-o @var{options}] @var{filename} [@var{size}]
Stuart Brady153859b2009-06-07 00:42:17 +010028ETEXI
29
30DEF("commit", img_commit,
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +000031 "commit [-q] [--object objectdef] [--image-opts] [-f fmt] [-t cache] [-b base] [-d] [-p] filename")
Stuart Brady153859b2009-06-07 00:42:17 +010032STEXI
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +000033@item commit [--object @var{objectdef}] [--image-opts] [-q] [-f @var{fmt}] [-t @var{cache}] [-b @var{base}] [-d] [-p] @var{filename}
Stuart Brady153859b2009-06-07 00:42:17 +010034ETEXI
35
Miroslav Rezaninad14ed182013-02-13 09:09:41 +010036DEF("compare", img_compare,
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +000037 "compare [--object objectdef] [--image-opts] [-f fmt] [-F fmt] [-T src_cache] [-p] [-q] [-s] filename1 filename2")
Miroslav Rezaninad14ed182013-02-13 09:09:41 +010038STEXI
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +000039@item compare [--object @var{objectdef}] [--image-opts] [-f @var{fmt}] [-F @var{fmt}] [-T @var{src_cache}] [-p] [-q] [-s] @var{filename1} @var{filename2}
Miroslav Rezaninad14ed182013-02-13 09:09:41 +010040ETEXI
41
Stuart Brady153859b2009-06-07 00:42:17 +010042DEF("convert", img_convert,
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +000043 "convert [--object objectdef] [--image-opts] [-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 +010044STEXI
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +000045@item convert [--object @var{objectdef}] [--image-opts] [-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 +010046ETEXI
47
Reda Sallahi86ce1f62016-08-10 04:43:12 +020048DEF("dd", img_dd,
Reda Sallahif7c15532016-08-10 16:16:09 +020049 "dd [--image-opts] [-f fmt] [-O output_fmt] [bs=block_size] [count=blocks] [skip=blocks] if=input of=output")
Reda Sallahi86ce1f62016-08-10 04:43:12 +020050STEXI
Reda Sallahif7c15532016-08-10 16:16:09 +020051@item dd [--image-opts] [-f @var{fmt}] [-O @var{output_fmt}] [bs=@var{block_size}] [count=@var{blocks}] [skip=@var{blocks}] if=@var{input} of=@var{output}
Reda Sallahi86ce1f62016-08-10 04:43:12 +020052ETEXI
53
Stuart Brady153859b2009-06-07 00:42:17 +010054DEF("info", img_info,
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +000055 "info [--object objectdef] [--image-opts] [-f fmt] [--output=ofmt] [--backing-chain] filename")
Stuart Brady153859b2009-06-07 00:42:17 +010056STEXI
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +000057@item info [--object @var{objectdef}] [--image-opts] [-f @var{fmt}] [--output=@var{ofmt}] [--backing-chain] @var{filename}
Stuart Brady153859b2009-06-07 00:42:17 +010058ETEXI
59
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +020060DEF("map", img_map,
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +000061 "map [--object objectdef] [--image-opts] [-f fmt] [--output=ofmt] filename")
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +020062STEXI
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +000063@item map [--object @var{objectdef}] [--image-opts] [-f @var{fmt}] [--output=@var{ofmt}] @var{filename}
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +020064ETEXI
65
Stuart Brady153859b2009-06-07 00:42:17 +010066DEF("snapshot", img_snapshot,
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +000067 "snapshot [--object objectdef] [--image-opts] [-q] [-l | -a snapshot | -c snapshot | -d snapshot] filename")
Stuart Brady153859b2009-06-07 00:42:17 +010068STEXI
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +000069@item snapshot [--object @var{objectdef}] [--image-opts] [-q] [-l | -a @var{snapshot} | -c @var{snapshot} | -d @var{snapshot}] @var{filename}
Kevin Wolf3e85c6f2010-01-12 12:55:18 +010070ETEXI
71
72DEF("rebase", img_rebase,
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +000073 "rebase [--object objectdef] [--image-opts] [-q] [-f fmt] [-t cache] [-T src_cache] [-p] [-u] -b backing_file [-F backing_fmt] filename")
Kevin Wolf3e85c6f2010-01-12 12:55:18 +010074STEXI
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +000075@item rebase [--object @var{objectdef}] [--image-opts] [-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 +010076ETEXI
77
78DEF("resize", img_resize,
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +000079 "resize [--object objectdef] [--image-opts] [-q] filename [+ | -]size")
Stefan Hajnocziae6b0ed2010-04-24 09:12:12 +010080STEXI
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +000081@item resize [--object @var{objectdef}] [--image-opts] [-q] @var{filename} [+ | -]@var{size}
Max Reitz6f176b42013-09-03 10:09:50 +020082ETEXI
83
84DEF("amend", img_amend,
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +000085 "amend [--object objectdef] [--image-opts] [-p] [-q] [-f fmt] [-t cache] -o options filename")
Max Reitz6f176b42013-09-03 10:09:50 +020086STEXI
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +000087@item amend [--object @var{objectdef}] [--image-opts] [-p] [-q] [-f @var{fmt}] [-t @var{cache}] -o @var{options} @var{filename}
Stuart Brady153859b2009-06-07 00:42:17 +010088@end table
89ETEXI