blob: c9dd70a89209ad270aad6659877688d6c5966cdd [file] [log] [blame]
Peter Maydelld95f2602023-12-12 16:23:13 +00001HXCOMM See docs/devel/docs.rst for the format of this file.
2HXCOMM
Eric Blake57b2d9d2017-08-03 11:33:50 -05003HXCOMM Keep the list of subcommands sorted by name.
Markus Armbrustera64627e2020-09-29 09:58:23 +02004HXCOMM Use DEFHEADING() to define headings in both help text and rST
Peter Maydell96ddefb2020-01-24 16:26:04 +00005HXCOMM Text between SRST and ERST are copied to rST version and
Stuart Brady153859b2009-06-07 00:42:17 +01006HXCOMM discarded from C version
7HXCOMM DEF(command, callback, arg_string) is used to construct
8HXCOMM command structures and help message.
Peter Maydell96ddefb2020-01-24 16:26:04 +00009HXCOMM HXCOMM can be used for comments, discarded from both rST and C
Stuart Brady153859b2009-06-07 00:42:17 +010010
Peter Maydell96ddefb2020-01-24 16:26:04 +000011HXCOMM When amending the rST sections, please remember to copy the usage
Eric Blake0562adf2020-05-12 20:16:41 -050012HXCOMM over to the per-command sections in docs/tools/qemu-img.rst.
John Snow4885b0c2018-05-03 18:56:48 -040013
Eric Blake57b2d9d2017-08-03 11:33:50 -050014DEF("amend", img_amend,
Maxim Levitskya3579bf2020-06-25 14:55:38 +020015 "amend [--object objectdef] [--image-opts] [-p] [-q] [-f fmt] [-t cache] [--force] -o options filename")
Peter Maydell195b5102020-01-24 16:26:02 +000016SRST
Maxim Levitskya3579bf2020-06-25 14:55:38 +020017.. option:: amend [--object OBJECTDEF] [--image-opts] [-p] [-q] [-f FMT] [-t CACHE] [--force] -o OPTIONS FILENAME
Peter Maydell195b5102020-01-24 16:26:02 +000018ERST
Eric Blake57b2d9d2017-08-03 11:33:50 -050019
Kevin Wolfb6133b82014-08-05 14:17:13 +020020DEF("bench", img_bench,
Julia Suvorova890fb1f2020-02-05 17:30:08 +010021 "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")
Peter Maydell195b5102020-01-24 16:26:02 +000022SRST
Julia Suvorova890fb1f2020-02-05 17:30:08 +010023.. 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
Peter Maydell195b5102020-01-24 16:26:02 +000024ERST
Eric Blake3b51ab42020-05-12 20:16:45 -050025
26DEF("bitmap", img_bitmap,
27 "bitmap (--merge SOURCE | --add | --remove | --clear | --enable | --disable)... [-b source_file [-F source_fmt]] [-g granularity] [--object objectdef] [--image-opts | -f fmt] filename bitmap")
28SRST
29.. 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
30ERST
31
Stuart Brady153859b2009-06-07 00:42:17 +010032DEF("check", img_check,
John Snow65f389c2018-05-03 18:56:44 -040033 "check [--object objectdef] [--image-opts] [-q] [-f fmt] [--output=ofmt] [-r [leaks | all]] [-T src_cache] [-U] filename")
Peter Maydell195b5102020-01-24 16:26:02 +000034SRST
35.. option:: check [--object OBJECTDEF] [--image-opts] [-q] [-f FMT] [--output=OFMT] [-r [leaks | all]] [-T SRC_CACHE] [-U] FILENAME
36ERST
Stuart Brady153859b2009-06-07 00:42:17 +010037
Stuart Brady153859b2009-06-07 00:42:17 +010038DEF("commit", img_commit,
Zhenguia0441b62020-10-20 14:47:43 +000039 "commit [--object objectdef] [--image-opts] [-q] [-f fmt] [-t cache] [-b base] [-r rate_limit] [-d] [-p] filename")
Peter Maydell195b5102020-01-24 16:26:02 +000040SRST
Zhenguia0441b62020-10-20 14:47:43 +000041.. option:: commit [--object OBJECTDEF] [--image-opts] [-q] [-f FMT] [-t CACHE] [-b BASE] [-r RATE_LIMIT] [-d] [-p] FILENAME
Peter Maydell195b5102020-01-24 16:26:02 +000042ERST
Stuart Brady153859b2009-06-07 00:42:17 +010043
Miroslav Rezaninad14ed182013-02-13 09:09:41 +010044DEF("compare", img_compare,
Fam Zhenga8d16f92017-05-03 00:35:40 +080045 "compare [--object objectdef] [--image-opts] [-f fmt] [-F fmt] [-T src_cache] [-p] [-q] [-s] [-U] filename1 filename2")
Peter Maydell195b5102020-01-24 16:26:02 +000046SRST
47.. option:: compare [--object OBJECTDEF] [--image-opts] [-f FMT] [-F FMT] [-T SRC_CACHE] [-p] [-q] [-s] [-U] FILENAME1 FILENAME2
48ERST
Miroslav Rezaninad14ed182013-02-13 09:09:41 +010049
Stuart Brady153859b2009-06-07 00:42:17 +010050DEF("convert", img_convert,
Eric Blake1899bf42021-09-13 08:17:35 -050051 "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")
Peter Maydell195b5102020-01-24 16:26:02 +000052SRST
Eric Blake9a5d1352021-09-21 09:28:12 -050053.. 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
Peter Maydell195b5102020-01-24 16:26:02 +000054ERST
Stuart Brady153859b2009-06-07 00:42:17 +010055
Eric Blake57b2d9d2017-08-03 11:33:50 -050056DEF("create", img_create,
Hanna Reitz111fbd72022-01-31 14:59:08 +010057 "create [--object objectdef] [-q] [-f fmt] [-b backing_file [-F backing_fmt]] [-u] [-o options] filename [size]")
Peter Maydell195b5102020-01-24 16:26:02 +000058SRST
Hanna Reitz111fbd72022-01-31 14:59:08 +010059.. option:: create [--object OBJECTDEF] [-q] [-f FMT] [-b BACKING_FILE [-F BACKING_FMT]] [-u] [-o OPTIONS] FILENAME [SIZE]
Peter Maydell195b5102020-01-24 16:26:02 +000060ERST
Eric Blake57b2d9d2017-08-03 11:33:50 -050061
Reda Sallahi86ce1f62016-08-10 04:43:12 +020062DEF("dd", img_dd,
Fam Zhenga8d16f92017-05-03 00:35:40 +080063 "dd [--image-opts] [-U] [-f fmt] [-O output_fmt] [bs=block_size] [count=blocks] [skip=blocks] if=input of=output")
Peter Maydell195b5102020-01-24 16:26:02 +000064SRST
65.. option:: dd [--image-opts] [-U] [-f FMT] [-O OUTPUT_FMT] [bs=BLOCK_SIZE] [count=BLOCKS] [skip=BLOCKS] if=INPUT of=OUTPUT
66ERST
Reda Sallahi86ce1f62016-08-10 04:43:12 +020067
Stuart Brady153859b2009-06-07 00:42:17 +010068DEF("info", img_info,
Fam Zhenga8d16f92017-05-03 00:35:40 +080069 "info [--object objectdef] [--image-opts] [-f fmt] [--output=ofmt] [--backing-chain] [-U] filename")
Peter Maydell195b5102020-01-24 16:26:02 +000070SRST
71.. option:: info [--object OBJECTDEF] [--image-opts] [-f FMT] [--output=OFMT] [--backing-chain] [-U] FILENAME
72ERST
Stuart Brady153859b2009-06-07 00:42:17 +010073
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +020074DEF("map", img_map,
Eyal Moscovicic0469492020-05-13 16:36:29 +030075 "map [--object objectdef] [--image-opts] [-f fmt] [--start-offset=offset] [--max-length=len] [--output=ofmt] [-U] filename")
Peter Maydell195b5102020-01-24 16:26:02 +000076SRST
Eyal Moscovicic0469492020-05-13 16:36:29 +030077.. option:: map [--object OBJECTDEF] [--image-opts] [-f FMT] [--start-offset=OFFSET] [--max-length=LEN] [--output=OFMT] [-U] FILENAME
Peter Maydell195b5102020-01-24 16:26:02 +000078ERST
Paolo Bonzini4c93a13b2013-09-04 19:00:33 +020079
Stefan Hajnoczifd03c2b2017-07-05 13:57:36 +010080DEF("measure", img_measure,
81"measure [--output=ofmt] [-O output_fmt] [-o options] [--size N | [--object objectdef] [--image-opts] [-f fmt] [-l snapshot_param] filename]")
Peter Maydell195b5102020-01-24 16:26:02 +000082SRST
83.. option:: measure [--output=OFMT] [-O OUTPUT_FMT] [-o OPTIONS] [--size N | [--object OBJECTDEF] [--image-opts] [-f FMT] [-l SNAPSHOT_PARAM] FILENAME]
84ERST
Stefan Hajnoczifd03c2b2017-07-05 13:57:36 +010085
Stuart Brady153859b2009-06-07 00:42:17 +010086DEF("snapshot", img_snapshot,
Fam Zhenga8d16f92017-05-03 00:35:40 +080087 "snapshot [--object objectdef] [--image-opts] [-U] [-q] [-l | -a snapshot | -c snapshot | -d snapshot] filename")
Peter Maydell195b5102020-01-24 16:26:02 +000088SRST
89.. option:: snapshot [--object OBJECTDEF] [--image-opts] [-U] [-q] [-l | -a SNAPSHOT | -c SNAPSHOT | -d SNAPSHOT] FILENAME
90ERST
Kevin Wolf3e85c6f2010-01-12 12:55:18 +010091
92DEF("rebase", img_rebase,
Andrey Drobyshev26ea2782023-09-19 19:58:03 +030093 "rebase [--object objectdef] [--image-opts] [-U] [-q] [-f fmt] [-t cache] [-T src_cache] [-p] [-u] [-c] -b backing_file [-F backing_fmt] filename")
Peter Maydell195b5102020-01-24 16:26:02 +000094SRST
Andrey Drobyshev26ea2782023-09-19 19:58:03 +030095.. option:: rebase [--object OBJECTDEF] [--image-opts] [-U] [-q] [-f FMT] [-t CACHE] [-T SRC_CACHE] [-p] [-u] [-c] -b BACKING_FILE [-F BACKING_FMT] FILENAME
Peter Maydell195b5102020-01-24 16:26:02 +000096ERST
Stefan Hajnocziae6b0ed2010-04-24 09:12:12 +010097
98DEF("resize", img_resize,
John Snow9775fcd2018-05-03 18:56:47 -040099 "resize [--object objectdef] [--image-opts] [-f fmt] [--preallocation=prealloc] [-q] [--shrink] filename [+ | -]size")
Peter Maydell195b5102020-01-24 16:26:02 +0000100SRST
101.. option:: resize [--object OBJECTDEF] [--image-opts] [-f FMT] [--preallocation=PREALLOC] [-q] [--shrink] FILENAME [+ | -]SIZE
102ERST