Peter Maydell | d95f260 | 2023-12-12 16:23:13 +0000 | [diff] [blame] | 1 | HXCOMM See docs/devel/docs.rst for the format of this file. |
| 2 | HXCOMM |
Eric Blake | 57b2d9d | 2017-08-03 11:33:50 -0500 | [diff] [blame] | 3 | HXCOMM Keep the list of subcommands sorted by name. |
Markus Armbruster | a64627e | 2020-09-29 09:58:23 +0200 | [diff] [blame] | 4 | HXCOMM Use DEFHEADING() to define headings in both help text and rST |
Peter Maydell | 96ddefb | 2020-01-24 16:26:04 +0000 | [diff] [blame] | 5 | HXCOMM Text between SRST and ERST are copied to rST version and |
Stuart Brady | 153859b | 2009-06-07 00:42:17 +0100 | [diff] [blame] | 6 | HXCOMM discarded from C version |
| 7 | HXCOMM DEF(command, callback, arg_string) is used to construct |
| 8 | HXCOMM command structures and help message. |
Peter Maydell | 96ddefb | 2020-01-24 16:26:04 +0000 | [diff] [blame] | 9 | HXCOMM HXCOMM can be used for comments, discarded from both rST and C |
Stuart Brady | 153859b | 2009-06-07 00:42:17 +0100 | [diff] [blame] | 10 | |
Peter Maydell | 96ddefb | 2020-01-24 16:26:04 +0000 | [diff] [blame] | 11 | HXCOMM When amending the rST sections, please remember to copy the usage |
Eric Blake | 0562adf | 2020-05-12 20:16:41 -0500 | [diff] [blame] | 12 | HXCOMM over to the per-command sections in docs/tools/qemu-img.rst. |
John Snow | 4885b0c | 2018-05-03 18:56:48 -0400 | [diff] [blame] | 13 | |
Eric Blake | 57b2d9d | 2017-08-03 11:33:50 -0500 | [diff] [blame] | 14 | DEF("amend", img_amend, |
Maxim Levitsky | a3579bf | 2020-06-25 14:55:38 +0200 | [diff] [blame] | 15 | "amend [--object objectdef] [--image-opts] [-p] [-q] [-f fmt] [-t cache] [--force] -o options filename") |
Peter Maydell | 195b510 | 2020-01-24 16:26:02 +0000 | [diff] [blame] | 16 | SRST |
Maxim Levitsky | a3579bf | 2020-06-25 14:55:38 +0200 | [diff] [blame] | 17 | .. option:: amend [--object OBJECTDEF] [--image-opts] [-p] [-q] [-f FMT] [-t CACHE] [--force] -o OPTIONS FILENAME |
Peter Maydell | 195b510 | 2020-01-24 16:26:02 +0000 | [diff] [blame] | 18 | ERST |
Eric Blake | 57b2d9d | 2017-08-03 11:33:50 -0500 | [diff] [blame] | 19 | |
Kevin Wolf | b6133b8 | 2014-08-05 14:17:13 +0200 | [diff] [blame] | 20 | DEF("bench", img_bench, |
Julia Suvorova | 890fb1f | 2020-02-05 17:30:08 +0100 | [diff] [blame] | 21 | "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 Maydell | 195b510 | 2020-01-24 16:26:02 +0000 | [diff] [blame] | 22 | SRST |
Julia Suvorova | 890fb1f | 2020-02-05 17:30:08 +0100 | [diff] [blame] | 23 | .. 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 Maydell | 195b510 | 2020-01-24 16:26:02 +0000 | [diff] [blame] | 24 | ERST |
Eric Blake | 3b51ab4 | 2020-05-12 20:16:45 -0500 | [diff] [blame] | 25 | |
| 26 | DEF("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") |
| 28 | SRST |
| 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 |
| 30 | ERST |
| 31 | |
Stuart Brady | 153859b | 2009-06-07 00:42:17 +0100 | [diff] [blame] | 32 | DEF("check", img_check, |
John Snow | 65f389c | 2018-05-03 18:56:44 -0400 | [diff] [blame] | 33 | "check [--object objectdef] [--image-opts] [-q] [-f fmt] [--output=ofmt] [-r [leaks | all]] [-T src_cache] [-U] filename") |
Peter Maydell | 195b510 | 2020-01-24 16:26:02 +0000 | [diff] [blame] | 34 | SRST |
| 35 | .. option:: check [--object OBJECTDEF] [--image-opts] [-q] [-f FMT] [--output=OFMT] [-r [leaks | all]] [-T SRC_CACHE] [-U] FILENAME |
| 36 | ERST |
Stuart Brady | 153859b | 2009-06-07 00:42:17 +0100 | [diff] [blame] | 37 | |
Stuart Brady | 153859b | 2009-06-07 00:42:17 +0100 | [diff] [blame] | 38 | DEF("commit", img_commit, |
Zhengui | a0441b6 | 2020-10-20 14:47:43 +0000 | [diff] [blame] | 39 | "commit [--object objectdef] [--image-opts] [-q] [-f fmt] [-t cache] [-b base] [-r rate_limit] [-d] [-p] filename") |
Peter Maydell | 195b510 | 2020-01-24 16:26:02 +0000 | [diff] [blame] | 40 | SRST |
Zhengui | a0441b6 | 2020-10-20 14:47:43 +0000 | [diff] [blame] | 41 | .. option:: commit [--object OBJECTDEF] [--image-opts] [-q] [-f FMT] [-t CACHE] [-b BASE] [-r RATE_LIMIT] [-d] [-p] FILENAME |
Peter Maydell | 195b510 | 2020-01-24 16:26:02 +0000 | [diff] [blame] | 42 | ERST |
Stuart Brady | 153859b | 2009-06-07 00:42:17 +0100 | [diff] [blame] | 43 | |
Miroslav Rezanina | d14ed18 | 2013-02-13 09:09:41 +0100 | [diff] [blame] | 44 | DEF("compare", img_compare, |
Fam Zheng | a8d16f9 | 2017-05-03 00:35:40 +0800 | [diff] [blame] | 45 | "compare [--object objectdef] [--image-opts] [-f fmt] [-F fmt] [-T src_cache] [-p] [-q] [-s] [-U] filename1 filename2") |
Peter Maydell | 195b510 | 2020-01-24 16:26:02 +0000 | [diff] [blame] | 46 | SRST |
| 47 | .. option:: compare [--object OBJECTDEF] [--image-opts] [-f FMT] [-F FMT] [-T SRC_CACHE] [-p] [-q] [-s] [-U] FILENAME1 FILENAME2 |
| 48 | ERST |
Miroslav Rezanina | d14ed18 | 2013-02-13 09:09:41 +0100 | [diff] [blame] | 49 | |
Stuart Brady | 153859b | 2009-06-07 00:42:17 +0100 | [diff] [blame] | 50 | DEF("convert", img_convert, |
Eric Blake | 1899bf4 | 2021-09-13 08:17:35 -0500 | [diff] [blame] | 51 | "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 Maydell | 195b510 | 2020-01-24 16:26:02 +0000 | [diff] [blame] | 52 | SRST |
Eric Blake | 9a5d135 | 2021-09-21 09:28:12 -0500 | [diff] [blame] | 53 | .. 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 Maydell | 195b510 | 2020-01-24 16:26:02 +0000 | [diff] [blame] | 54 | ERST |
Stuart Brady | 153859b | 2009-06-07 00:42:17 +0100 | [diff] [blame] | 55 | |
Eric Blake | 57b2d9d | 2017-08-03 11:33:50 -0500 | [diff] [blame] | 56 | DEF("create", img_create, |
Hanna Reitz | 111fbd7 | 2022-01-31 14:59:08 +0100 | [diff] [blame] | 57 | "create [--object objectdef] [-q] [-f fmt] [-b backing_file [-F backing_fmt]] [-u] [-o options] filename [size]") |
Peter Maydell | 195b510 | 2020-01-24 16:26:02 +0000 | [diff] [blame] | 58 | SRST |
Hanna Reitz | 111fbd7 | 2022-01-31 14:59:08 +0100 | [diff] [blame] | 59 | .. option:: create [--object OBJECTDEF] [-q] [-f FMT] [-b BACKING_FILE [-F BACKING_FMT]] [-u] [-o OPTIONS] FILENAME [SIZE] |
Peter Maydell | 195b510 | 2020-01-24 16:26:02 +0000 | [diff] [blame] | 60 | ERST |
Eric Blake | 57b2d9d | 2017-08-03 11:33:50 -0500 | [diff] [blame] | 61 | |
Reda Sallahi | 86ce1f6 | 2016-08-10 04:43:12 +0200 | [diff] [blame] | 62 | DEF("dd", img_dd, |
Fam Zheng | a8d16f9 | 2017-05-03 00:35:40 +0800 | [diff] [blame] | 63 | "dd [--image-opts] [-U] [-f fmt] [-O output_fmt] [bs=block_size] [count=blocks] [skip=blocks] if=input of=output") |
Peter Maydell | 195b510 | 2020-01-24 16:26:02 +0000 | [diff] [blame] | 64 | SRST |
| 65 | .. option:: dd [--image-opts] [-U] [-f FMT] [-O OUTPUT_FMT] [bs=BLOCK_SIZE] [count=BLOCKS] [skip=BLOCKS] if=INPUT of=OUTPUT |
| 66 | ERST |
Reda Sallahi | 86ce1f6 | 2016-08-10 04:43:12 +0200 | [diff] [blame] | 67 | |
Stuart Brady | 153859b | 2009-06-07 00:42:17 +0100 | [diff] [blame] | 68 | DEF("info", img_info, |
Fam Zheng | a8d16f9 | 2017-05-03 00:35:40 +0800 | [diff] [blame] | 69 | "info [--object objectdef] [--image-opts] [-f fmt] [--output=ofmt] [--backing-chain] [-U] filename") |
Peter Maydell | 195b510 | 2020-01-24 16:26:02 +0000 | [diff] [blame] | 70 | SRST |
| 71 | .. option:: info [--object OBJECTDEF] [--image-opts] [-f FMT] [--output=OFMT] [--backing-chain] [-U] FILENAME |
| 72 | ERST |
Stuart Brady | 153859b | 2009-06-07 00:42:17 +0100 | [diff] [blame] | 73 | |
Paolo Bonzini | 4c93a13b | 2013-09-04 19:00:33 +0200 | [diff] [blame] | 74 | DEF("map", img_map, |
Eyal Moscovici | c046949 | 2020-05-13 16:36:29 +0300 | [diff] [blame] | 75 | "map [--object objectdef] [--image-opts] [-f fmt] [--start-offset=offset] [--max-length=len] [--output=ofmt] [-U] filename") |
Peter Maydell | 195b510 | 2020-01-24 16:26:02 +0000 | [diff] [blame] | 76 | SRST |
Eyal Moscovici | c046949 | 2020-05-13 16:36:29 +0300 | [diff] [blame] | 77 | .. option:: map [--object OBJECTDEF] [--image-opts] [-f FMT] [--start-offset=OFFSET] [--max-length=LEN] [--output=OFMT] [-U] FILENAME |
Peter Maydell | 195b510 | 2020-01-24 16:26:02 +0000 | [diff] [blame] | 78 | ERST |
Paolo Bonzini | 4c93a13b | 2013-09-04 19:00:33 +0200 | [diff] [blame] | 79 | |
Stefan Hajnoczi | fd03c2b | 2017-07-05 13:57:36 +0100 | [diff] [blame] | 80 | DEF("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 Maydell | 195b510 | 2020-01-24 16:26:02 +0000 | [diff] [blame] | 82 | SRST |
| 83 | .. option:: measure [--output=OFMT] [-O OUTPUT_FMT] [-o OPTIONS] [--size N | [--object OBJECTDEF] [--image-opts] [-f FMT] [-l SNAPSHOT_PARAM] FILENAME] |
| 84 | ERST |
Stefan Hajnoczi | fd03c2b | 2017-07-05 13:57:36 +0100 | [diff] [blame] | 85 | |
Stuart Brady | 153859b | 2009-06-07 00:42:17 +0100 | [diff] [blame] | 86 | DEF("snapshot", img_snapshot, |
Fam Zheng | a8d16f9 | 2017-05-03 00:35:40 +0800 | [diff] [blame] | 87 | "snapshot [--object objectdef] [--image-opts] [-U] [-q] [-l | -a snapshot | -c snapshot | -d snapshot] filename") |
Peter Maydell | 195b510 | 2020-01-24 16:26:02 +0000 | [diff] [blame] | 88 | SRST |
| 89 | .. option:: snapshot [--object OBJECTDEF] [--image-opts] [-U] [-q] [-l | -a SNAPSHOT | -c SNAPSHOT | -d SNAPSHOT] FILENAME |
| 90 | ERST |
Kevin Wolf | 3e85c6f | 2010-01-12 12:55:18 +0100 | [diff] [blame] | 91 | |
| 92 | DEF("rebase", img_rebase, |
Andrey Drobyshev | 26ea278 | 2023-09-19 19:58:03 +0300 | [diff] [blame] | 93 | "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 Maydell | 195b510 | 2020-01-24 16:26:02 +0000 | [diff] [blame] | 94 | SRST |
Andrey Drobyshev | 26ea278 | 2023-09-19 19:58:03 +0300 | [diff] [blame] | 95 | .. 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 Maydell | 195b510 | 2020-01-24 16:26:02 +0000 | [diff] [blame] | 96 | ERST |
Stefan Hajnoczi | ae6b0ed | 2010-04-24 09:12:12 +0100 | [diff] [blame] | 97 | |
| 98 | DEF("resize", img_resize, |
John Snow | 9775fcd | 2018-05-03 18:56:47 -0400 | [diff] [blame] | 99 | "resize [--object objectdef] [--image-opts] [-f fmt] [--preallocation=prealloc] [-q] [--shrink] filename [+ | -]size") |
Peter Maydell | 195b510 | 2020-01-24 16:26:02 +0000 | [diff] [blame] | 100 | SRST |
| 101 | .. option:: resize [--object OBJECTDEF] [--image-opts] [-f FMT] [--preallocation=PREALLOC] [-q] [--shrink] FILENAME [+ | -]SIZE |
| 102 | ERST |