Stuart Brady | 153859b | 2009-06-07 00:42:17 +0100 | [diff] [blame] | 1 | HXCOMM Use DEFHEADING() to define headings in both help text and texi |
| 2 | HXCOMM Text between STEXI and ETEXI are copied to texi version and |
| 3 | HXCOMM discarded from C version |
| 4 | HXCOMM DEF(command, callback, arg_string) is used to construct |
| 5 | HXCOMM command structures and help message. |
| 6 | HXCOMM HXCOMM can be used for comments, discarded from both texi and C |
| 7 | |
| 8 | STEXI |
| 9 | @table @option |
Jan Kiszka | 3c4c321 | 2010-05-20 09:16:30 +0200 | [diff] [blame] | 10 | ETEXI |
Stuart Brady | 153859b | 2009-06-07 00:42:17 +0100 | [diff] [blame] | 11 | |
| 12 | DEF("check", img_check, |
Max Reitz | 4005595 | 2014-07-22 22:58:42 +0200 | [diff] [blame] | 13 | "check [-q] [-f fmt] [--output=ofmt] [-r [leaks | all]] [-T src_cache] filename") |
Stuart Brady | 153859b | 2009-06-07 00:42:17 +0100 | [diff] [blame] | 14 | STEXI |
Max Reitz | 4005595 | 2014-07-22 22:58:42 +0200 | [diff] [blame] | 15 | @item check [-q] [-f @var{fmt}] [--output=@var{ofmt}] [-r [leaks | all]] [-T @var{src_cache}] @var{filename} |
Stuart Brady | 153859b | 2009-06-07 00:42:17 +0100 | [diff] [blame] | 16 | ETEXI |
| 17 | |
| 18 | DEF("create", img_create, |
Miroslav Rezanina | f382d43 | 2013-02-13 09:09:40 +0100 | [diff] [blame] | 19 | "create [-q] [-f fmt] [-o options] filename [size]") |
Stuart Brady | 153859b | 2009-06-07 00:42:17 +0100 | [diff] [blame] | 20 | STEXI |
Miroslav Rezanina | f382d43 | 2013-02-13 09:09:40 +0100 | [diff] [blame] | 21 | @item create [-q] [-f @var{fmt}] [-o @var{options}] @var{filename} [@var{size}] |
Stuart Brady | 153859b | 2009-06-07 00:42:17 +0100 | [diff] [blame] | 22 | ETEXI |
| 23 | |
| 24 | DEF("commit", img_commit, |
Max Reitz | 1b22bff | 2014-10-24 15:57:40 +0200 | [diff] [blame] | 25 | "commit [-q] [-f fmt] [-t cache] [-b base] [-d] [-p] filename") |
Stuart Brady | 153859b | 2009-06-07 00:42:17 +0100 | [diff] [blame] | 26 | STEXI |
Max Reitz | 1b22bff | 2014-10-24 15:57:40 +0200 | [diff] [blame] | 27 | @item commit [-q] [-f @var{fmt}] [-t @var{cache}] [-b @var{base}] [-d] [-p] @var{filename} |
Stuart Brady | 153859b | 2009-06-07 00:42:17 +0100 | [diff] [blame] | 28 | ETEXI |
| 29 | |
Miroslav Rezanina | d14ed18 | 2013-02-13 09:09:41 +0100 | [diff] [blame] | 30 | DEF("compare", img_compare, |
Max Reitz | 4005595 | 2014-07-22 22:58:42 +0200 | [diff] [blame] | 31 | "compare [-f fmt] [-F fmt] [-T src_cache] [-p] [-q] [-s] filename1 filename2") |
Miroslav Rezanina | d14ed18 | 2013-02-13 09:09:41 +0100 | [diff] [blame] | 32 | STEXI |
Max Reitz | 4005595 | 2014-07-22 22:58:42 +0200 | [diff] [blame] | 33 | @item compare [-f @var{fmt}] [-F @var{fmt}] [-T @var{src_cache}] [-p] [-q] [-s] @var{filename1} @var{filename2} |
Miroslav Rezanina | d14ed18 | 2013-02-13 09:09:41 +0100 | [diff] [blame] | 34 | ETEXI |
| 35 | |
Stuart Brady | 153859b | 2009-06-07 00:42:17 +0100 | [diff] [blame] | 36 | DEF("convert", img_convert, |
Max Reitz | 4005595 | 2014-07-22 22:58:42 +0200 | [diff] [blame] | 37 | "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 Brady | 153859b | 2009-06-07 00:42:17 +0100 | [diff] [blame] | 38 | STEXI |
Max Reitz | 4005595 | 2014-07-22 22:58:42 +0200 | [diff] [blame] | 39 | @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 Brady | 153859b | 2009-06-07 00:42:17 +0100 | [diff] [blame] | 40 | ETEXI |
| 41 | |
| 42 | DEF("info", img_info, |
Kashyap Chamarthy | e535756 | 2012-10-18 11:25:34 +0530 | [diff] [blame] | 43 | "info [-f fmt] [--output=ofmt] [--backing-chain] filename") |
Stuart Brady | 153859b | 2009-06-07 00:42:17 +0100 | [diff] [blame] | 44 | STEXI |
Kashyap Chamarthy | e535756 | 2012-10-18 11:25:34 +0530 | [diff] [blame] | 45 | @item info [-f @var{fmt}] [--output=@var{ofmt}] [--backing-chain] @var{filename} |
Stuart Brady | 153859b | 2009-06-07 00:42:17 +0100 | [diff] [blame] | 46 | ETEXI |
| 47 | |
Paolo Bonzini | 4c93a13b | 2013-09-04 19:00:33 +0200 | [diff] [blame] | 48 | DEF("map", img_map, |
| 49 | "map [-f fmt] [--output=ofmt] filename") |
| 50 | STEXI |
| 51 | @item map [-f @var{fmt}] [--output=@var{ofmt}] @var{filename} |
| 52 | ETEXI |
| 53 | |
Stuart Brady | 153859b | 2009-06-07 00:42:17 +0100 | [diff] [blame] | 54 | DEF("snapshot", img_snapshot, |
Miroslav Rezanina | f382d43 | 2013-02-13 09:09:40 +0100 | [diff] [blame] | 55 | "snapshot [-q] [-l | -a snapshot | -c snapshot | -d snapshot] filename") |
Stuart Brady | 153859b | 2009-06-07 00:42:17 +0100 | [diff] [blame] | 56 | STEXI |
Miroslav Rezanina | f382d43 | 2013-02-13 09:09:40 +0100 | [diff] [blame] | 57 | @item snapshot [-q] [-l | -a @var{snapshot} | -c @var{snapshot} | -d @var{snapshot}] @var{filename} |
Kevin Wolf | 3e85c6f | 2010-01-12 12:55:18 +0100 | [diff] [blame] | 58 | ETEXI |
| 59 | |
| 60 | DEF("rebase", img_rebase, |
Max Reitz | 4005595 | 2014-07-22 22:58:42 +0200 | [diff] [blame] | 61 | "rebase [-q] [-f fmt] [-t cache] [-T src_cache] [-p] [-u] -b backing_file [-F backing_fmt] filename") |
Kevin Wolf | 3e85c6f | 2010-01-12 12:55:18 +0100 | [diff] [blame] | 62 | STEXI |
Max Reitz | 4005595 | 2014-07-22 22:58:42 +0200 | [diff] [blame] | 63 | @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 Hajnoczi | ae6b0ed | 2010-04-24 09:12:12 +0100 | [diff] [blame] | 64 | ETEXI |
| 65 | |
| 66 | DEF("resize", img_resize, |
Miroslav Rezanina | f382d43 | 2013-02-13 09:09:40 +0100 | [diff] [blame] | 67 | "resize [-q] filename [+ | -]size") |
Stefan Hajnoczi | ae6b0ed | 2010-04-24 09:12:12 +0100 | [diff] [blame] | 68 | STEXI |
Miroslav Rezanina | f382d43 | 2013-02-13 09:09:40 +0100 | [diff] [blame] | 69 | @item resize [-q] @var{filename} [+ | -]@var{size} |
Max Reitz | 6f176b4 | 2013-09-03 10:09:50 +0200 | [diff] [blame] | 70 | ETEXI |
| 71 | |
| 72 | DEF("amend", img_amend, |
Max Reitz | 76a3a34 | 2014-10-27 11:12:51 +0100 | [diff] [blame] | 73 | "amend [-p] [-q] [-f fmt] [-t cache] -o options filename") |
Max Reitz | 6f176b4 | 2013-09-03 10:09:50 +0200 | [diff] [blame] | 74 | STEXI |
Max Reitz | 76a3a34 | 2014-10-27 11:12:51 +0100 | [diff] [blame] | 75 | @item amend [-p] [-q] [-f @var{fmt}] [-t @var{cache}] -o @var{options} @var{filename} |
Stuart Brady | 153859b | 2009-06-07 00:42:17 +0100 | [diff] [blame] | 76 | @end table |
| 77 | ETEXI |