2017-08-04 00:33:50 +08:00
|
|
|
HXCOMM Keep the list of subcommands sorted by name.
|
2020-09-29 15:58:23 +08:00
|
|
|
HXCOMM Use DEFHEADING() to define headings in both help text and rST
|
2020-01-25 00:26:04 +08:00
|
|
|
HXCOMM Text between SRST and ERST are copied to rST version and
|
2009-06-07 07:42:17 +08:00
|
|
|
HXCOMM discarded from C version
|
|
|
|
HXCOMM DEF(command, callback, arg_string) is used to construct
|
|
|
|
HXCOMM command structures and help message.
|
2020-01-25 00:26:04 +08:00
|
|
|
HXCOMM HXCOMM can be used for comments, discarded from both rST and C
|
2009-06-07 07:42:17 +08:00
|
|
|
|
2020-01-25 00:26:04 +08:00
|
|
|
HXCOMM When amending the rST sections, please remember to copy the usage
|
2020-05-13 09:16:41 +08:00
|
|
|
HXCOMM over to the per-command sections in docs/tools/qemu-img.rst.
|
2018-05-04 06:56:48 +08:00
|
|
|
|
2017-08-04 00:33:50 +08:00
|
|
|
DEF("amend", img_amend,
|
2020-06-25 20:55:38 +08:00
|
|
|
"amend [--object objectdef] [--image-opts] [-p] [-q] [-f fmt] [-t cache] [--force] -o options filename")
|
2020-01-25 00:26:02 +08:00
|
|
|
SRST
|
2020-06-25 20:55:38 +08:00
|
|
|
.. option:: amend [--object OBJECTDEF] [--image-opts] [-p] [-q] [-f FMT] [-t CACHE] [--force] -o OPTIONS FILENAME
|
2020-01-25 00:26:02 +08:00
|
|
|
ERST
|
2017-08-04 00:33:50 +08:00
|
|
|
|
2014-08-05 20:17:13 +08:00
|
|
|
DEF("bench", img_bench,
|
2020-02-06 00:30:08 +08:00
|
|
|
"bench [-c count] [-d depth] [-f fmt] [--flush-interval=flush_interval] [-i aio] [-n] [--no-drain] [-o offset] [--pattern=pattern] [-q] [-s buffer_size] [-S step_size] [-t cache] [-w] [-U] filename")
|
2020-01-25 00:26:02 +08:00
|
|
|
SRST
|
2020-02-06 00:30:08 +08:00
|
|
|
.. option:: bench [-c COUNT] [-d DEPTH] [-f FMT] [--flush-interval=FLUSH_INTERVAL] [-i AIO] [-n] [--no-drain] [-o OFFSET] [--pattern=PATTERN] [-q] [-s BUFFER_SIZE] [-S STEP_SIZE] [-t CACHE] [-w] [-U] FILENAME
|
2020-01-25 00:26:02 +08:00
|
|
|
ERST
|
qemu-img: Add bitmap sub-command
Include actions for --add, --remove, --clear, --enable, --disable, and
--merge (note that --clear is a bit of fluff, because the same can be
accomplished by removing a bitmap and then adding a new one in its
place, but it matches what QMP commands exist). Listing is omitted,
because it does not require a bitmap name and because it was already
possible with 'qemu-img info'. A single command line can play one or
more bitmap commands in sequence on the same bitmap name (although all
added bitmaps share the same granularity, and and all merged bitmaps
come from the same source file). Merge defaults to other bitmaps in
the primary image, but can also be told to merge bitmaps from a
distinct image.
While this supports --image-opts for the file being modified, I did
not think it worth the extra complexity to support that for the source
file in a cross-file merges. Likewise, I chose to have --merge only
take a single source rather than following the QMP support for
multiple merges in one go (although you can still use more than one
--merge in the command line); in part because qemu-img is offline and
therefore atomicity is not an issue.
Upcoming patches will add iotest coverage of these commands while
also testing other features.
Signed-off-by: Eric Blake <eblake@redhat.com>
Reviewed-by: Max Reitz <mreitz@redhat.com>
Message-Id: <20200513011648.166876-7-eblake@redhat.com>
Reviewed-by: Vladimir Sementsov-Ogievskiy <vsementsov@virtuozzo.com>
2020-05-13 09:16:45 +08:00
|
|
|
|
|
|
|
DEF("bitmap", img_bitmap,
|
|
|
|
"bitmap (--merge SOURCE | --add | --remove | --clear | --enable | --disable)... [-b source_file [-F source_fmt]] [-g granularity] [--object objectdef] [--image-opts | -f fmt] filename bitmap")
|
|
|
|
SRST
|
|
|
|
.. option:: bitmap (--merge SOURCE | --add | --remove | --clear | --enable | --disable)... [-b SOURCE_FILE [-F SOURCE_FMT]] [-g GRANULARITY] [--object OBJECTDEF] [--image-opts | -f FMT] FILENAME BITMAP
|
|
|
|
ERST
|
|
|
|
|
2009-06-07 07:42:17 +08:00
|
|
|
DEF("check", img_check,
|
2018-05-04 06:56:44 +08:00
|
|
|
"check [--object objectdef] [--image-opts] [-q] [-f fmt] [--output=ofmt] [-r [leaks | all]] [-T src_cache] [-U] filename")
|
2020-01-25 00:26:02 +08:00
|
|
|
SRST
|
|
|
|
.. option:: check [--object OBJECTDEF] [--image-opts] [-q] [-f FMT] [--output=OFMT] [-r [leaks | all]] [-T SRC_CACHE] [-U] FILENAME
|
|
|
|
ERST
|
2009-06-07 07:42:17 +08:00
|
|
|
|
|
|
|
DEF("commit", img_commit,
|
2020-10-20 22:47:43 +08:00
|
|
|
"commit [--object objectdef] [--image-opts] [-q] [-f fmt] [-t cache] [-b base] [-r rate_limit] [-d] [-p] filename")
|
2020-01-25 00:26:02 +08:00
|
|
|
SRST
|
2020-10-20 22:47:43 +08:00
|
|
|
.. option:: commit [--object OBJECTDEF] [--image-opts] [-q] [-f FMT] [-t CACHE] [-b BASE] [-r RATE_LIMIT] [-d] [-p] FILENAME
|
2020-01-25 00:26:02 +08:00
|
|
|
ERST
|
2009-06-07 07:42:17 +08:00
|
|
|
|
2013-02-13 16:09:41 +08:00
|
|
|
DEF("compare", img_compare,
|
2017-05-03 00:35:40 +08:00
|
|
|
"compare [--object objectdef] [--image-opts] [-f fmt] [-F fmt] [-T src_cache] [-p] [-q] [-s] [-U] filename1 filename2")
|
2020-01-25 00:26:02 +08:00
|
|
|
SRST
|
|
|
|
.. option:: compare [--object OBJECTDEF] [--image-opts] [-f FMT] [-F FMT] [-T SRC_CACHE] [-p] [-q] [-s] [-U] FILENAME1 FILENAME2
|
|
|
|
ERST
|
2013-02-13 16:09:41 +08:00
|
|
|
|
2009-06-07 07:42:17 +08:00
|
|
|
DEF("convert", img_convert,
|
2021-09-13 21:17:35 +08:00
|
|
|
"convert [--object objectdef] [--image-opts] [--target-image-opts] [--target-is-zero] [--bitmaps] [-U] [-C] [-c] [-p] [-q] [-n] [-f fmt] [-t cache] [-T src_cache] [-O output_fmt] [-B backing_file [-F backing_fmt]] [-o options] [-l snapshot_param] [-S sparse_size] [-r rate_limit] [-m num_coroutines] [-W] [--salvage] filename [filename2 [...]] output_filename")
|
2020-01-25 00:26:02 +08:00
|
|
|
SRST
|
2021-09-21 22:28:12 +08:00
|
|
|
.. option:: convert [--object OBJECTDEF] [--image-opts] [--target-image-opts] [--target-is-zero] [--bitmaps] [-U] [-C] [-c] [-p] [-q] [-n] [-f FMT] [-t CACHE] [-T SRC_CACHE] [-O OUTPUT_FMT] [-B BACKING_FILE [-F BACKING_FMT]] [-o OPTIONS] [-l SNAPSHOT_PARAM] [-S SPARSE_SIZE] [-r RATE_LIMIT] [-m NUM_COROUTINES] [-W] [--salvage] FILENAME [FILENAME2 [...]] OUTPUT_FILENAME
|
2020-01-25 00:26:02 +08:00
|
|
|
ERST
|
2009-06-07 07:42:17 +08:00
|
|
|
|
2017-08-04 00:33:50 +08:00
|
|
|
DEF("create", img_create,
|
2018-05-04 06:56:44 +08:00
|
|
|
"create [--object objectdef] [-q] [-f fmt] [-b backing_file] [-F backing_fmt] [-u] [-o options] filename [size]")
|
2020-01-25 00:26:02 +08:00
|
|
|
SRST
|
|
|
|
.. option:: create [--object OBJECTDEF] [-q] [-f FMT] [-b BACKING_FILE] [-F BACKING_FMT] [-u] [-o OPTIONS] FILENAME [SIZE]
|
|
|
|
ERST
|
2017-08-04 00:33:50 +08:00
|
|
|
|
2016-08-10 10:43:12 +08:00
|
|
|
DEF("dd", img_dd,
|
2017-05-03 00:35:40 +08:00
|
|
|
"dd [--image-opts] [-U] [-f fmt] [-O output_fmt] [bs=block_size] [count=blocks] [skip=blocks] if=input of=output")
|
2020-01-25 00:26:02 +08:00
|
|
|
SRST
|
|
|
|
.. option:: dd [--image-opts] [-U] [-f FMT] [-O OUTPUT_FMT] [bs=BLOCK_SIZE] [count=BLOCKS] [skip=BLOCKS] if=INPUT of=OUTPUT
|
|
|
|
ERST
|
2016-08-10 10:43:12 +08:00
|
|
|
|
2009-06-07 07:42:17 +08:00
|
|
|
DEF("info", img_info,
|
2017-05-03 00:35:40 +08:00
|
|
|
"info [--object objectdef] [--image-opts] [-f fmt] [--output=ofmt] [--backing-chain] [-U] filename")
|
2020-01-25 00:26:02 +08:00
|
|
|
SRST
|
|
|
|
.. option:: info [--object OBJECTDEF] [--image-opts] [-f FMT] [--output=OFMT] [--backing-chain] [-U] FILENAME
|
|
|
|
ERST
|
2009-06-07 07:42:17 +08:00
|
|
|
|
2013-09-05 01:00:33 +08:00
|
|
|
DEF("map", img_map,
|
2020-05-13 21:36:29 +08:00
|
|
|
"map [--object objectdef] [--image-opts] [-f fmt] [--start-offset=offset] [--max-length=len] [--output=ofmt] [-U] filename")
|
2020-01-25 00:26:02 +08:00
|
|
|
SRST
|
2020-05-13 21:36:29 +08:00
|
|
|
.. option:: map [--object OBJECTDEF] [--image-opts] [-f FMT] [--start-offset=OFFSET] [--max-length=LEN] [--output=OFMT] [-U] FILENAME
|
2020-01-25 00:26:02 +08:00
|
|
|
ERST
|
2013-09-05 01:00:33 +08:00
|
|
|
|
2017-07-05 20:57:36 +08:00
|
|
|
DEF("measure", img_measure,
|
|
|
|
"measure [--output=ofmt] [-O output_fmt] [-o options] [--size N | [--object objectdef] [--image-opts] [-f fmt] [-l snapshot_param] filename]")
|
2020-01-25 00:26:02 +08:00
|
|
|
SRST
|
|
|
|
.. option:: measure [--output=OFMT] [-O OUTPUT_FMT] [-o OPTIONS] [--size N | [--object OBJECTDEF] [--image-opts] [-f FMT] [-l SNAPSHOT_PARAM] FILENAME]
|
|
|
|
ERST
|
2017-07-05 20:57:36 +08:00
|
|
|
|
2009-06-07 07:42:17 +08:00
|
|
|
DEF("snapshot", img_snapshot,
|
2017-05-03 00:35:40 +08:00
|
|
|
"snapshot [--object objectdef] [--image-opts] [-U] [-q] [-l | -a snapshot | -c snapshot | -d snapshot] filename")
|
2020-01-25 00:26:02 +08:00
|
|
|
SRST
|
|
|
|
.. option:: snapshot [--object OBJECTDEF] [--image-opts] [-U] [-q] [-l | -a SNAPSHOT | -c SNAPSHOT | -d SNAPSHOT] FILENAME
|
|
|
|
ERST
|
2010-01-12 19:55:18 +08:00
|
|
|
|
|
|
|
DEF("rebase", img_rebase,
|
2017-05-03 00:35:40 +08:00
|
|
|
"rebase [--object objectdef] [--image-opts] [-U] [-q] [-f fmt] [-t cache] [-T src_cache] [-p] [-u] -b backing_file [-F backing_fmt] filename")
|
2020-01-25 00:26:02 +08:00
|
|
|
SRST
|
|
|
|
.. option:: rebase [--object OBJECTDEF] [--image-opts] [-U] [-q] [-f FMT] [-t CACHE] [-T SRC_CACHE] [-p] [-u] -b BACKING_FILE [-F BACKING_FMT] FILENAME
|
|
|
|
ERST
|
2010-04-24 16:12:12 +08:00
|
|
|
|
|
|
|
DEF("resize", img_resize,
|
2018-05-04 06:56:47 +08:00
|
|
|
"resize [--object objectdef] [--image-opts] [-f fmt] [--preallocation=prealloc] [-q] [--shrink] filename [+ | -]size")
|
2020-01-25 00:26:02 +08:00
|
|
|
SRST
|
|
|
|
.. option:: resize [--object OBJECTDEF] [--image-opts] [-f FMT] [--preallocation=PREALLOC] [-q] [--shrink] FILENAME [+ | -]SIZE
|
|
|
|
ERST
|