qemu-img-cmds.hx 2.26 KB
Newer Older
1 2 3 4 5 6 7 8 9
HXCOMM Use DEFHEADING() to define headings in both help text and texi
HXCOMM Text between STEXI and ETEXI are copied to texi version and
HXCOMM discarded from C version
HXCOMM DEF(command, callback, arg_string) is used to construct
HXCOMM command structures and help message.
HXCOMM HXCOMM can be used for comments, discarded from both texi and C

STEXI
@table @option
10
ETEXI
11 12

DEF("check", img_check,
13
    "check [-q] [-f fmt] [--output=ofmt]  [-r [leaks | all]] filename")
14
STEXI
15
@item check [-q] [-f @var{fmt}] [--output=@var{ofmt}] [-r [leaks | all]] @var{filename}
16 17 18
ETEXI

DEF("create", img_create,
19
    "create [-q] [-f fmt] [-o options] filename [size]")
20
STEXI
21
@item create [-q] [-f @var{fmt}] [-o @var{options}] @var{filename} [@var{size}]
22 23 24
ETEXI

DEF("commit", img_commit,
25
    "commit [-q] [-f fmt] [-t cache] filename")
26
STEXI
27
@item commit [-q] [-f @var{fmt}] [-t @var{cache}] @var{filename}
28 29
ETEXI

30 31 32 33 34 35
DEF("compare", img_compare,
    "compare [-f fmt] [-F fmt] [-p] [-q] [-s] filename1 filename2")
STEXI
@item compare [-f @var{fmt}] [-F @var{fmt}] [-p] [-q] [-s] @var{filename1} @var{filename2}
ETEXI

36
DEF("convert", img_convert,
37
    "convert [-c] [-p] [-q] [-n] [-f fmt] [-t cache] [-O output_fmt] [-o options] [-s snapshot_name] [-S sparse_size] filename [filename2 [...]] output_filename")
38
STEXI
39
@item convert [-c] [-p] [-q] [-n] [-f @var{fmt}] [-t @var{cache}] [-O @var{output_fmt}] [-o @var{options}] [-s @var{snapshot_name}] [-S @var{sparse_size}] @var{filename} [@var{filename2} [...]] @var{output_filename}
40 41 42
ETEXI

DEF("info", img_info,
43
    "info [-f fmt] [--output=ofmt] [--backing-chain] filename")
44
STEXI
45
@item info [-f @var{fmt}] [--output=@var{ofmt}] [--backing-chain] @var{filename}
46 47 48
ETEXI

DEF("snapshot", img_snapshot,
49
    "snapshot [-q] [-l | -a snapshot | -c snapshot | -d snapshot] filename")
50
STEXI
51
@item snapshot [-q] [-l | -a @var{snapshot} | -c @var{snapshot} | -d @var{snapshot}] @var{filename}
Kevin Wolf's avatar
Kevin Wolf committed
52 53 54
ETEXI

DEF("rebase", img_rebase,
55
    "rebase [-q] [-f fmt] [-t cache] [-p] [-u] -b backing_file [-F backing_fmt] filename")
Kevin Wolf's avatar
Kevin Wolf committed
56
STEXI
57
@item rebase [-q] [-f @var{fmt}] [-t @var{cache}] [-p] [-u] -b @var{backing_file} [-F @var{backing_fmt}] @var{filename}
58 59 60
ETEXI

DEF("resize", img_resize,
61
    "resize [-q] filename [+ | -]size")
62
STEXI
63
@item resize [-q] @var{filename} [+ | -]@var{size}
64 65
@end table
ETEXI