blob: b47d409665621cb880a3b626fb2cfea14abd2bab [file] [log] [blame]
Eric Blake57b2d9d2017-08-03 11:33:50 -05001HXCOMM Keep the list of subcommands sorted by name.
Stuart Brady153859b2009-06-07 00:42:17 +01002HXCOMM Use DEFHEADING() to define headings in both help text and texi
3HXCOMM Text between STEXI and ETEXI are copied to texi version and
4HXCOMM discarded from C version
5HXCOMM DEF(command, callback, arg_string) is used to construct
6HXCOMM command structures and help message.
7HXCOMM HXCOMM can be used for comments, discarded from both texi and C
8
9STEXI
10@table @option
Jan Kiszka3c4c3212010-05-20 09:16:30 +020011ETEXI
Stuart Brady153859b2009-06-07 00:42:17 +010012
Eric Blake57b2d9d2017-08-03 11:33:50 -050013DEF("amend", img_amend,
14 "amend [--object objectdef] [--image-opts] [-p] [-q] [-f fmt] [-t cache] -o options filename")
15STEXI
16@item amend [--object @var{objectdef}] [--image-opts] [-p] [-q] [-f @var{fmt}] [-t @var{cache}] -o @var{options} @var{filename}
17ETEXI
18
Kevin Wolfb6133b82014-08-05 14:17:13 +020019DEF("bench", img_bench,
Fam Zhenga8d16f92017-05-03 00:35:40 +080020 "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] [-U] filename")
Kevin Wolfb6133b82014-08-05 14:17:13 +020021STEXI
Fam Zhenga8d16f92017-05-03 00:35:40 +080022@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] [-U] @var{filename}
Kevin Wolfb6133b82014-08-05 14:17:13 +020023ETEXI
24
Stuart Brady153859b2009-06-07 00:42:17 +010025DEF("check", img_check,
Fam Zhenga8d16f92017-05-03 00:35:40 +080026 "check [-q] [--object objectdef] [--image-opts] [-f fmt] [--output=ofmt] [-r [leaks | all]] [-T src_cache] [-U] filename")
Stuart Brady153859b2009-06-07 00:42:17 +010027STEXI
Fam Zhenga8d16f92017-05-03 00:35:40 +080028@item check [--object @var{objectdef}] [--image-opts] [-q] [-f @var{fmt}] [--output=@var{ofmt}] [-r [leaks | all]] [-T @var{src_cache}] [-U] @var{filename}
Stuart Brady153859b2009-06-07 00:42:17 +010029ETEXI
30
Stuart Brady153859b2009-06-07 00:42:17 +010031DEF("commit", img_commit,
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +000032 "commit [-q] [--object objectdef] [--image-opts] [-f fmt] [-t cache] [-b base] [-d] [-p] filename")
Stuart Brady153859b2009-06-07 00:42:17 +010033STEXI
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +000034@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 +010035ETEXI
36
Miroslav Rezaninad14ed182013-02-13 09:09:41 +010037DEF("compare", img_compare,
Fam Zhenga8d16f92017-05-03 00:35:40 +080038 "compare [--object objectdef] [--image-opts] [-f fmt] [-F fmt] [-T src_cache] [-p] [-q] [-s] [-U] filename1 filename2")
Miroslav Rezaninad14ed182013-02-13 09:09:41 +010039STEXI
Fam Zhenga8d16f92017-05-03 00:35:40 +080040@item compare [--object @var{objectdef}] [--image-opts] [-f @var{fmt}] [-F @var{fmt}] [-T @var{src_cache}] [-p] [-q] [-s] [-U] @var{filename1} @var{filename2}
Miroslav Rezaninad14ed182013-02-13 09:09:41 +010041ETEXI
42
Stuart Brady153859b2009-06-07 00:42:17 +010043DEF("convert", img_convert,
Daniel P. Berrange305b4c62017-05-15 17:47:11 +010044 "convert [--object objectdef] [--image-opts] [--target-image-opts] [-U] [-c] [-p] [-q] [-n] [-f fmt] [-t cache] [-T src_cache] [-O output_fmt] [-B backing_file] [-o options] [-s snapshot_id_or_name] [-l snapshot_param] [-S sparse_size] [-m num_coroutines] [-W] filename [filename2 [...]] output_filename")
Stuart Brady153859b2009-06-07 00:42:17 +010045STEXI
Daniel P. Berrange305b4c62017-05-15 17:47:11 +010046@item convert [--object @var{objectdef}] [--image-opts] [--target-image-opts] [-U] [-c] [-p] [-q] [-n] [-f @var{fmt}] [-t @var{cache}] [-T @var{src_cache}] [-O @var{output_fmt}] [-B @var{backing_file}] [-o @var{options}] [-s @var{snapshot_id_or_name}] [-l @var{snapshot_param}] [-S @var{sparse_size}] [-m @var{num_coroutines}] [-W] @var{filename} [@var{filename2} [...]] @var{output_filename}
Stuart Brady153859b2009-06-07 00:42:17 +010047ETEXI
48
Eric Blake57b2d9d2017-08-03 11:33:50 -050049DEF("create", img_create,
50 "create [-q] [--object objectdef] [-f fmt] [-b backing_file] [-F backing_fmt] [-u] [-o options] filename [size]")
51STEXI
52@item create [--object @var{objectdef}] [-q] [-f @var{fmt}] [-b @var{backing_file}] [-F @var{backing_fmt}] [-u] [-o @var{options}] @var{filename} [@var{size}]
53ETEXI
54
Reda Sallahi86ce1f62016-08-10 04:43:12 +020055DEF("dd", img_dd,
Fam Zhenga8d16f92017-05-03 00:35:40 +080056 "dd [--image-opts] [-U] [-f fmt] [-O output_fmt] [bs=block_size] [count=blocks] [skip=blocks] if=input of=output")
Reda Sallahi86ce1f62016-08-10 04:43:12 +020057STEXI
Fam Zhenga8d16f92017-05-03 00:35:40 +080058@item dd [--image-opts] [-U] [-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 +020059ETEXI
60
Stuart Brady153859b2009-06-07 00:42:17 +010061DEF("info", img_info,
Fam Zhenga8d16f92017-05-03 00:35:40 +080062 "info [--object objectdef] [--image-opts] [-f fmt] [--output=ofmt] [--backing-chain] [-U] filename")
Stuart Brady153859b2009-06-07 00:42:17 +010063STEXI
Fam Zhenga8d16f92017-05-03 00:35:40 +080064@item info [--object @var{objectdef}] [--image-opts] [-f @var{fmt}] [--output=@var{ofmt}] [--backing-chain] [-U] @var{filename}
Stuart Brady153859b2009-06-07 00:42:17 +010065ETEXI
66
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +020067DEF("map", img_map,
Fam Zhenga8d16f92017-05-03 00:35:40 +080068 "map [--object objectdef] [--image-opts] [-f fmt] [--output=ofmt] [-U] filename")
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +020069STEXI
Fam Zhenga8d16f92017-05-03 00:35:40 +080070@item map [--object @var{objectdef}] [--image-opts] [-f @var{fmt}] [--output=@var{ofmt}] [-U] @var{filename}
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +020071ETEXI
72
Stefan Hajnoczifd03c2b2017-07-05 13:57:36 +010073DEF("measure", img_measure,
74"measure [--output=ofmt] [-O output_fmt] [-o options] [--size N | [--object objectdef] [--image-opts] [-f fmt] [-l snapshot_param] filename]")
75STEXI
76@item measure [--output=@var{ofmt}] [-O @var{output_fmt}] [-o @var{options}] [--size @var{N} | [--object @var{objectdef}] [--image-opts] [-f @var{fmt}] [-l @var{snapshot_param}] @var{filename}]
77ETEXI
78
Stuart Brady153859b2009-06-07 00:42:17 +010079DEF("snapshot", img_snapshot,
Fam Zhenga8d16f92017-05-03 00:35:40 +080080 "snapshot [--object objectdef] [--image-opts] [-U] [-q] [-l | -a snapshot | -c snapshot | -d snapshot] filename")
Stuart Brady153859b2009-06-07 00:42:17 +010081STEXI
Fam Zhenga8d16f92017-05-03 00:35:40 +080082@item snapshot [--object @var{objectdef}] [--image-opts] [-U] [-q] [-l | -a @var{snapshot} | -c @var{snapshot} | -d @var{snapshot}] @var{filename}
Kevin Wolf3e85c6f2010-01-12 12:55:18 +010083ETEXI
84
85DEF("rebase", img_rebase,
Fam Zhenga8d16f92017-05-03 00:35:40 +080086 "rebase [--object objectdef] [--image-opts] [-U] [-q] [-f fmt] [-t cache] [-T src_cache] [-p] [-u] -b backing_file [-F backing_fmt] filename")
Kevin Wolf3e85c6f2010-01-12 12:55:18 +010087STEXI
Fam Zhenga8d16f92017-05-03 00:35:40 +080088@item rebase [--object @var{objectdef}] [--image-opts] [-U] [-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 +010089ETEXI
90
91DEF("resize", img_resize,
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +000092 "resize [--object objectdef] [--image-opts] [-q] filename [+ | -]size")
Stefan Hajnocziae6b0ed2010-04-24 09:12:12 +010093STEXI
Daniel P. Berrangeeb769f72016-02-17 10:10:20 +000094@item resize [--object @var{objectdef}] [--image-opts] [-q] @var{filename} [+ | -]@var{size}
Max Reitz6f176b42013-09-03 10:09:50 +020095ETEXI
96
Max Reitz6f176b42013-09-03 10:09:50 +020097STEXI
Stuart Brady153859b2009-06-07 00:42:17 +010098@end table
99ETEXI