]>
Commit | Line | Data |
---|---|---|
d95f260a PM |
1 | HXCOMM See docs/devel/docs.rst for the format of this file. |
2 | HXCOMM | |
57b2d9d4 | 3 | HXCOMM Keep the list of subcommands sorted by name. |
a64627ed | 4 | HXCOMM Use DEFHEADING() to define headings in both help text and rST |
96ddefbc | 5 | HXCOMM Text between SRST and ERST are copied to rST version and |
153859be SB |
6 | HXCOMM discarded from C version |
7 | HXCOMM DEF(command, callback, arg_string) is used to construct | |
8 | HXCOMM command structures and help message. | |
96ddefbc | 9 | HXCOMM HXCOMM can be used for comments, discarded from both rST and C |
153859be | 10 | |
96ddefbc | 11 | HXCOMM When amending the rST sections, please remember to copy the usage |
0562adf5 | 12 | HXCOMM over to the per-command sections in docs/tools/qemu-img.rst. |
4885b0ca | 13 | |
57b2d9d4 | 14 | DEF("amend", img_amend, |
a3579bfa | 15 | "amend [--object objectdef] [--image-opts] [-p] [-q] [-f fmt] [-t cache] [--force] -o options filename") |
195b5109 | 16 | SRST |
a3579bfa | 17 | .. option:: amend [--object OBJECTDEF] [--image-opts] [-p] [-q] [-f FMT] [-t CACHE] [--force] -o OPTIONS FILENAME |
195b5109 | 18 | ERST |
57b2d9d4 | 19 | |
b6133b8c | 20 | DEF("bench", img_bench, |
890fb1f6 | 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") |
195b5109 | 22 | SRST |
890fb1f6 | 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 |
195b5109 | 24 | ERST |
3b51ab4b EB |
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 | ||
153859be | 32 | DEF("check", img_check, |
65f389c0 | 33 | "check [--object objectdef] [--image-opts] [-q] [-f fmt] [--output=ofmt] [-r [leaks | all]] [-T src_cache] [-U] filename") |
195b5109 PM |
34 | SRST |
35 | .. option:: check [--object OBJECTDEF] [--image-opts] [-q] [-f FMT] [--output=OFMT] [-r [leaks | all]] [-T SRC_CACHE] [-U] FILENAME | |
36 | ERST | |
153859be | 37 | |
153859be | 38 | DEF("commit", img_commit, |
a0441b66 | 39 | "commit [--object objectdef] [--image-opts] [-q] [-f fmt] [-t cache] [-b base] [-r rate_limit] [-d] [-p] filename") |
195b5109 | 40 | SRST |
a0441b66 | 41 | .. option:: commit [--object OBJECTDEF] [--image-opts] [-q] [-f FMT] [-t CACHE] [-b BASE] [-r RATE_LIMIT] [-d] [-p] FILENAME |
195b5109 | 42 | ERST |
153859be | 43 | |
d14ed18c | 44 | DEF("compare", img_compare, |
a8d16f9c | 45 | "compare [--object objectdef] [--image-opts] [-f fmt] [-F fmt] [-T src_cache] [-p] [-q] [-s] [-U] filename1 filename2") |
195b5109 PM |
46 | SRST |
47 | .. option:: compare [--object OBJECTDEF] [--image-opts] [-f FMT] [-F FMT] [-T SRC_CACHE] [-p] [-q] [-s] [-U] FILENAME1 FILENAME2 | |
48 | ERST | |
d14ed18c | 49 | |
153859be | 50 | DEF("convert", img_convert, |
1899bf47 | 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") |
195b5109 | 52 | SRST |
9a5d1352 | 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 |
195b5109 | 54 | ERST |
153859be | 55 | |
57b2d9d4 | 56 | DEF("create", img_create, |
111fbd74 | 57 | "create [--object objectdef] [-q] [-f fmt] [-b backing_file [-F backing_fmt]] [-u] [-o options] filename [size]") |
195b5109 | 58 | SRST |
111fbd74 | 59 | .. option:: create [--object OBJECTDEF] [-q] [-f FMT] [-b BACKING_FILE [-F BACKING_FMT]] [-u] [-o OPTIONS] FILENAME [SIZE] |
195b5109 | 60 | ERST |
57b2d9d4 | 61 | |
86ce1f6e | 62 | DEF("dd", img_dd, |
a8d16f9c | 63 | "dd [--image-opts] [-U] [-f fmt] [-O output_fmt] [bs=block_size] [count=blocks] [skip=blocks] if=input of=output") |
195b5109 PM |
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 | |
86ce1f6e | 67 | |
153859be | 68 | DEF("info", img_info, |
a8d16f9c | 69 | "info [--object objectdef] [--image-opts] [-f fmt] [--output=ofmt] [--backing-chain] [-U] filename") |
195b5109 PM |
70 | SRST |
71 | .. option:: info [--object OBJECTDEF] [--image-opts] [-f FMT] [--output=OFMT] [--backing-chain] [-U] FILENAME | |
72 | ERST | |
153859be | 73 | |
4c93a13b | 74 | DEF("map", img_map, |
c0469496 | 75 | "map [--object objectdef] [--image-opts] [-f fmt] [--start-offset=offset] [--max-length=len] [--output=ofmt] [-U] filename") |
195b5109 | 76 | SRST |
c0469496 | 77 | .. option:: map [--object OBJECTDEF] [--image-opts] [-f FMT] [--start-offset=OFFSET] [--max-length=LEN] [--output=OFMT] [-U] FILENAME |
195b5109 | 78 | ERST |
4c93a13b | 79 | |
fd03c2b8 SH |
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]") | |
195b5109 PM |
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 | |
fd03c2b8 | 85 | |
153859be | 86 | DEF("snapshot", img_snapshot, |
a8d16f9c | 87 | "snapshot [--object objectdef] [--image-opts] [-U] [-q] [-l | -a snapshot | -c snapshot | -d snapshot] filename") |
195b5109 PM |
88 | SRST |
89 | .. option:: snapshot [--object OBJECTDEF] [--image-opts] [-U] [-q] [-l | -a SNAPSHOT | -c SNAPSHOT | -d SNAPSHOT] FILENAME | |
90 | ERST | |
3e85c6fd KW |
91 | |
92 | DEF("rebase", img_rebase, | |
26ea2789 | 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") |
195b5109 | 94 | SRST |
26ea2789 | 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 |
195b5109 | 96 | ERST |
ae6b0ed6 SH |
97 | |
98 | DEF("resize", img_resize, | |
9775fcdb | 99 | "resize [--object objectdef] [--image-opts] [-f fmt] [--preallocation=prealloc] [-q] [--shrink] filename [+ | -]size") |
195b5109 PM |
100 | SRST |
101 | .. option:: resize [--object OBJECTDEF] [--image-opts] [-f FMT] [--preallocation=PREALLOC] [-q] [--shrink] FILENAME [+ | -]SIZE | |
102 | ERST |