1 HXCOMM Keep the list of subcommands sorted by name
.
2 HXCOMM Use
DEFHEADING() to define headings
in both help text and texi
3 HXCOMM Text between STEXI and ETEXI are copied to texi version and
4 HXCOMM discarded from C version
5 HXCOMM
DEF(command
, callback, arg_string
) is used to construct
6 HXCOMM command structures and help message
.
7 HXCOMM HXCOMM can be used
for comments
, discarded from both texi and C
9 HXCOMM When amending the TEXI sections
, please remember to copy the usage
10 HXCOMM over to the per
-command sections
in qemu
-img
.texi
.
16 DEF("amend", img_amend
,
17 "amend [--object objectdef] [--image-opts] [-p] [-q] [-f fmt] [-t cache] -o options filename")
19 @item amend
[--object @
var{objectdef
}] [--image
-opts
] [-p
] [-q
] [-f @
var{fmt
}] [-t @
var{cache
}] -o @
var{options
} @
var{filename
}
22 .. option
:: amend
[--object OBJECTDEF
] [--image
-opts
] [-p
] [-q
] [-f FMT
] [-t CACHE
] -o OPTIONS FILENAME
25 DEF("bench", img_bench
,
26 "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] [-i aio] [-w] [-U] filename")
28 @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
}] [-i @
var{aio
}] [-w
] [-U
] @
var{filename
}
31 .. option
:: 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
] [-i AIO
] [-w
] [-U
] FILENAME
33 DEF("check", img_check
,
34 "check [--object objectdef] [--image-opts] [-q] [-f fmt] [--output=ofmt] [-r [leaks | all]] [-T src_cache] [-U] filename")
36 @item check
[--object @
var{objectdef
}] [--image
-opts
] [-q
] [-f @
var{fmt
}] [--output
=@
var{ofmt
}] [-r
[leaks | all
]] [-T @
var{src_cache
}] [-U
] @
var{filename
}
39 .. option
:: check
[--object OBJECTDEF
] [--image
-opts
] [-q
] [-f FMT
] [--output
=OFMT
] [-r
[leaks | all
]] [-T SRC_CACHE
] [-U
] FILENAME
42 DEF("commit", img_commit
,
43 "commit [--object objectdef] [--image-opts] [-q] [-f fmt] [-t cache] [-b base] [-d] [-p] filename")
45 @item commit
[--object @
var{objectdef
}] [--image
-opts
] [-q
] [-f @
var{fmt
}] [-t @
var{cache
}] [-b @
var{base
}] [-d
] [-p
] @
var{filename
}
48 .. option
:: commit
[--object OBJECTDEF
] [--image
-opts
] [-q
] [-f FMT
] [-t CACHE
] [-b BASE
] [-d
] [-p
] FILENAME
51 DEF("compare", img_compare
,
52 "compare [--object objectdef] [--image-opts] [-f fmt] [-F fmt] [-T src_cache] [-p] [-q] [-s] [-U] filename1 filename2")
54 @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
}
57 .. option
:: compare
[--object OBJECTDEF
] [--image
-opts
] [-f FMT
] [-F FMT
] [-T SRC_CACHE
] [-p
] [-q
] [-s
] [-U
] FILENAME1 FILENAME2
60 DEF("convert", img_convert
,
61 "convert [--object objectdef] [--image-opts] [--target-image-opts] [-U] [-C] [-c] [-p] [-q] [-n] [-f fmt] [-t cache] [-T src_cache] [-O output_fmt] [-B backing_file] [-o options] [-l snapshot_param] [-S sparse_size] [-m num_coroutines] [-W] [--salvage] filename [filename2 [...]] output_filename")
63 @item convert
[--object @
var{objectdef
}] [--image
-opts
] [--target
-image
-opts
] [-U
] [-C
] [-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
}] [-l @
var{snapshot_param
}] [-S @
var{sparse_size
}] [-m @
var{num_coroutines
}] [-W
] [--salvage
] @
var{filename
} [@
var{filename2
} [...]] @
var{output_filename
}
66 .. option
:: convert
[--object OBJECTDEF
] [--image
-opts
] [--target
-image
-opts
] [-U
] [-C
] [-c
] [-p
] [-q
] [-n
] [-f FMT
] [-t CACHE
] [-T SRC_CACHE
] [-O OUTPUT_FMT
] [-B BACKING_FILE
] [-o OPTIONS
] [-l SNAPSHOT_PARAM
] [-S SPARSE_SIZE
] [-m NUM_COROUTINES
] [-W
] [--salvage
] FILENAME
[FILENAME2
[...]] OUTPUT_FILENAME
69 DEF("create", img_create
,
70 "create [--object objectdef] [-q] [-f fmt] [-b backing_file] [-F backing_fmt] [-u] [-o options] filename [size]")
72 @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
}]
75 .. option
:: create
[--object OBJECTDEF
] [-q
] [-f FMT
] [-b BACKING_FILE
] [-F BACKING_FMT
] [-u
] [-o OPTIONS
] FILENAME
[SIZE
]
79 "dd [--image-opts] [-U] [-f fmt] [-O output_fmt] [bs=block_size] [count=blocks] [skip=blocks] if=input of=output")
81 @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
}
84 .. option
:: dd
[--image
-opts
] [-U
] [-f FMT
] [-O OUTPUT_FMT
] [bs
=BLOCK_SIZE
] [count
=BLOCKS
] [skip
=BLOCKS
] if=INPUT of
=OUTPUT
88 "info [--object objectdef] [--image-opts] [-f fmt] [--output=ofmt] [--backing-chain] [-U] filename")
90 @item info
[--object @
var{objectdef
}] [--image
-opts
] [-f @
var{fmt
}] [--output
=@
var{ofmt
}] [--backing
-chain
] [-U
] @
var{filename
}
93 .. option
:: info
[--object OBJECTDEF
] [--image
-opts
] [-f FMT
] [--output
=OFMT
] [--backing
-chain
] [-U
] FILENAME
97 "map [--object objectdef] [--image-opts] [-f fmt] [--output=ofmt] [-U] filename")
99 @item map
[--object @
var{objectdef
}] [--image
-opts
] [-f @
var{fmt
}] [--output
=@
var{ofmt
}] [-U
] @
var{filename
}
102 .. option
:: map
[--object OBJECTDEF
] [--image
-opts
] [-f FMT
] [--output
=OFMT
] [-U
] FILENAME
105 DEF("measure", img_measure
,
106 "measure [--output=ofmt] [-O output_fmt] [-o options] [--size N | [--object objectdef] [--image-opts] [-f fmt] [-l snapshot_param] filename]")
108 @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
}]
111 .. option
:: measure
[--output
=OFMT
] [-O OUTPUT_FMT
] [-o OPTIONS
] [--size N |
[--object OBJECTDEF
] [--image
-opts
] [-f FMT
] [-l SNAPSHOT_PARAM
] FILENAME
]
114 DEF("snapshot", img_snapshot
,
115 "snapshot [--object objectdef] [--image-opts] [-U] [-q] [-l | -a snapshot | -c snapshot | -d snapshot] filename")
117 @item snapshot
[--object @
var{objectdef
}] [--image
-opts
] [-U
] [-q
] [-l |
-a @
var{snapshot
} |
-c @
var{snapshot
} |
-d @
var{snapshot
}] @
var{filename
}
120 .. option
:: snapshot
[--object OBJECTDEF
] [--image
-opts
] [-U
] [-q
] [-l |
-a SNAPSHOT |
-c SNAPSHOT |
-d SNAPSHOT
] FILENAME
123 DEF("rebase", img_rebase
,
124 "rebase [--object objectdef] [--image-opts] [-U] [-q] [-f fmt] [-t cache] [-T src_cache] [-p] [-u] -b backing_file [-F backing_fmt] filename")
126 @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
}
129 .. option
:: rebase
[--object OBJECTDEF
] [--image
-opts
] [-U
] [-q
] [-f FMT
] [-t CACHE
] [-T SRC_CACHE
] [-p
] [-u
] -b BACKING_FILE
[-F BACKING_FMT
] FILENAME
132 DEF("resize", img_resize
,
133 "resize [--object objectdef] [--image-opts] [-f fmt] [--preallocation=prealloc] [-q] [--shrink] filename [+ | -]size")
135 @item resize
[--object @
var{objectdef
}] [--image
-opts
] [-f @
var{fmt
}] [--preallocation
=@
var{prealloc
}] [-q
] [--shrink
] @
var{filename
} [+ |
-]@
var{size
}
138 .. option
:: resize
[--object OBJECTDEF
] [--image
-opts
] [-f FMT
] [--preallocation
=PREALLOC
] [-q
] [--shrink
] FILENAME
[+ |
-]SIZE