qemu-img-cmds.hx 2.82 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]] [-T src_cache] filename")
14
STEXI
15
@item check [-q] [-f @var{fmt}] [--output=@var{ofmt}] [-r [leaks | all]] [-T @var{src_cache}] @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] [-b base] [-d] [-p] filename")
26
STEXI
27
@item commit [-q] [-f @var{fmt}] [-t @var{cache}] [-b @var{base}] [-d] [-p] @var{filename}
28 29
ETEXI

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

36
DEF("convert", img_convert,
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")
38
STEXI
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}
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
ETEXI

48 49 50 51 52 53
DEF("map", img_map,
    "map [-f fmt] [--output=ofmt] filename")
STEXI
@item map [-f @var{fmt}] [--output=@var{ofmt}] @var{filename}
ETEXI

54
DEF("snapshot", img_snapshot,
55
    "snapshot [-q] [-l | -a snapshot | -c snapshot | -d snapshot] filename")
56
STEXI
57
@item snapshot [-q] [-l | -a @var{snapshot} | -c @var{snapshot} | -d @var{snapshot}] @var{filename}
Kevin Wolf's avatar
Kevin Wolf committed
58 59 60
ETEXI

DEF("rebase", img_rebase,
61
    "rebase [-q] [-f fmt] [-t cache] [-T src_cache] [-p] [-u] -b backing_file [-F backing_fmt] filename")
Kevin Wolf's avatar
Kevin Wolf committed
62
STEXI
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}
64 65 66
ETEXI

DEF("resize", img_resize,
67
    "resize [-q] filename [+ | -]size")
68
STEXI
69
@item resize [-q] @var{filename} [+ | -]@var{size}
70 71 72
ETEXI

DEF("amend", img_amend,
73
    "amend [-p] [-q] [-f fmt] [-t cache] -o options filename")
74
STEXI
75
@item amend [-p] [-q] [-f @var{fmt}] [-t @var{cache}] -o @var{options} @var{filename}
76 77
@end table
ETEXI