blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 1 | HXCOMM Use DEFHEADING() to define headings in both help text and texi |
| 2 | HXCOMM Text between STEXI and ETEXI are copied to texi version and |
| 3 | HXCOMM discarded from C version |
Blue Swirl | ad96090 | 2010-03-29 19:23:52 +0000 | [diff] [blame] | 4 | HXCOMM DEF(option, HAS_ARG/0, opt_enum, opt_help, arch_mask) is used to |
| 5 | HXCOMM construct option structures, enums and help message for specified |
| 6 | HXCOMM architectures. |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 7 | HXCOMM HXCOMM can be used for comments, discarded from both texi and C |
| 8 | |
| 9 | DEFHEADING(Standard options:) |
| 10 | STEXI |
| 11 | @table @option |
| 12 | ETEXI |
| 13 | |
| 14 | DEF("help", 0, QEMU_OPTION_h, |
Blue Swirl | ad96090 | 2010-03-29 19:23:52 +0000 | [diff] [blame] | 15 | "-h or -help display this help and exit\n", QEMU_ARCH_ALL) |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 16 | STEXI |
| 17 | @item -h |
Stefan Weil | 6616b2a | 2010-02-05 23:52:05 +0100 | [diff] [blame] | 18 | @findex -h |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 19 | Display help and exit |
| 20 | ETEXI |
| 21 | |
pbrook | 9bd7e6d | 2009-04-07 22:58:45 +0000 | [diff] [blame] | 22 | DEF("version", 0, QEMU_OPTION_version, |
Blue Swirl | ad96090 | 2010-03-29 19:23:52 +0000 | [diff] [blame] | 23 | "-version display version information and exit\n", QEMU_ARCH_ALL) |
pbrook | 9bd7e6d | 2009-04-07 22:58:45 +0000 | [diff] [blame] | 24 | STEXI |
| 25 | @item -version |
Stefan Weil | 6616b2a | 2010-02-05 23:52:05 +0100 | [diff] [blame] | 26 | @findex -version |
pbrook | 9bd7e6d | 2009-04-07 22:58:45 +0000 | [diff] [blame] | 27 | Display version information and exit |
| 28 | ETEXI |
| 29 | |
Jan Kiszka | 80f52a6 | 2011-07-23 12:39:46 +0200 | [diff] [blame] | 30 | DEF("machine", HAS_ARG, QEMU_OPTION_machine, \ |
| 31 | "-machine [type=]name[,prop[=value][,...]]\n" |
Peter Maydell | 585f603 | 2012-10-04 16:22:01 +0100 | [diff] [blame] | 32 | " selects emulated machine ('-machine help' for list)\n" |
Jan Kiszka | 80f52a6 | 2011-07-23 12:39:46 +0200 | [diff] [blame] | 33 | " property accel=accel1[:accel2[:...]] selects accelerator\n" |
Jan Kiszka | 6a48ffa | 2011-10-15 13:43:48 +0200 | [diff] [blame] | 34 | " supported accelerators are kvm, xen, tcg (default: tcg)\n" |
Jan Kiszka | 39d6960 | 2012-01-25 18:14:15 +0100 | [diff] [blame] | 35 | " kernel_irqchip=on|off controls accelerated irqchip support\n" |
Don Slutz | d1048be | 2014-11-21 11:18:52 -0500 | [diff] [blame] | 36 | " vmport=on|off|auto controls emulation of vmport (default: auto)\n" |
Jason Baron | ddb97f1 | 2012-08-02 15:44:16 -0400 | [diff] [blame] | 37 | " kvm_shadow_mem=size of KVM shadow MMU\n" |
Luiz Capitulino | 8490fc7 | 2012-09-05 16:50:16 -0300 | [diff] [blame] | 38 | " dump-guest-core=on|off include guest memory in a core dump (default=on)\n" |
Le Tan | a52a7fd | 2014-08-16 13:55:40 +0800 | [diff] [blame] | 39 | " mem-merge=on|off controls memory merge support (default: on)\n" |
| 40 | " iommu=on|off controls emulated Intel IOMMU (VT-d) support (default=off)\n", |
Jan Kiszka | 80f52a6 | 2011-07-23 12:39:46 +0200 | [diff] [blame] | 41 | QEMU_ARCH_ALL) |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 42 | STEXI |
Jan Kiszka | 80f52a6 | 2011-07-23 12:39:46 +0200 | [diff] [blame] | 43 | @item -machine [type=]@var{name}[,prop=@var{value}[,...]] |
| 44 | @findex -machine |
Peter Maydell | 585f603 | 2012-10-04 16:22:01 +0100 | [diff] [blame] | 45 | Select the emulated machine by @var{name}. Use @code{-machine help} to list |
Jan Kiszka | 80f52a6 | 2011-07-23 12:39:46 +0200 | [diff] [blame] | 46 | available machines. Supported machine properties are: |
| 47 | @table @option |
| 48 | @item accel=@var{accels1}[:@var{accels2}[:...]] |
| 49 | This is used to enable an accelerator. Depending on the target architecture, |
| 50 | kvm, xen, or tcg can be available. By default, tcg is used. If there is more |
| 51 | than one accelerator specified, the next one is used if the previous one fails |
| 52 | to initialize. |
Jan Kiszka | 6a48ffa | 2011-10-15 13:43:48 +0200 | [diff] [blame] | 53 | @item kernel_irqchip=on|off |
| 54 | Enables in-kernel irqchip support for the chosen accelerator when available. |
Don Slutz | d1048be | 2014-11-21 11:18:52 -0500 | [diff] [blame] | 55 | @item vmport=on|off|auto |
| 56 | Enables emulation of VMWare IO port, for vmmouse etc. auto says to select the |
| 57 | value based on accel. For accel=xen the default is off otherwise the default |
| 58 | is on. |
Jan Kiszka | 39d6960 | 2012-01-25 18:14:15 +0100 | [diff] [blame] | 59 | @item kvm_shadow_mem=size |
| 60 | Defines the size of the KVM shadow MMU. |
Jason Baron | ddb97f1 | 2012-08-02 15:44:16 -0400 | [diff] [blame] | 61 | @item dump-guest-core=on|off |
| 62 | Include guest memory in a core dump. The default is on. |
Luiz Capitulino | 8490fc7 | 2012-09-05 16:50:16 -0300 | [diff] [blame] | 63 | @item mem-merge=on|off |
| 64 | Enables or disables memory merge support. This feature, when supported by |
| 65 | the host, de-duplicates identical memory pages among VMs instances |
| 66 | (enabled by default). |
Le Tan | a52a7fd | 2014-08-16 13:55:40 +0800 | [diff] [blame] | 67 | @item iommu=on|off |
| 68 | Enables or disables emulated Intel IOMMU (VT-d) support. The default is off. |
Jan Kiszka | 80f52a6 | 2011-07-23 12:39:46 +0200 | [diff] [blame] | 69 | @end table |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 70 | ETEXI |
| 71 | |
Jan Kiszka | 80f52a6 | 2011-07-23 12:39:46 +0200 | [diff] [blame] | 72 | HXCOMM Deprecated by -machine |
| 73 | DEF("M", HAS_ARG, QEMU_OPTION_M, "", QEMU_ARCH_ALL) |
| 74 | |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 75 | DEF("cpu", HAS_ARG, QEMU_OPTION_cpu, |
Peter Maydell | 585f603 | 2012-10-04 16:22:01 +0100 | [diff] [blame] | 76 | "-cpu cpu select CPU ('-cpu help' for list)\n", QEMU_ARCH_ALL) |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 77 | STEXI |
| 78 | @item -cpu @var{model} |
Stefan Weil | 6616b2a | 2010-02-05 23:52:05 +0100 | [diff] [blame] | 79 | @findex -cpu |
Peter Maydell | 585f603 | 2012-10-04 16:22:01 +0100 | [diff] [blame] | 80 | Select CPU model (@code{-cpu help} for list and additional feature selection) |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 81 | ETEXI |
| 82 | |
| 83 | DEF("smp", HAS_ARG, QEMU_OPTION_smp, |
Michael Tokarev | 12b7f57 | 2013-06-24 15:06:52 +0400 | [diff] [blame] | 84 | "-smp [cpus=]n[,maxcpus=cpus][,cores=cores][,threads=threads][,sockets=sockets]\n" |
Jes Sorensen | 6be68d7 | 2009-07-23 17:03:42 +0200 | [diff] [blame] | 85 | " set the number of CPUs to 'n' [default=1]\n" |
| 86 | " maxcpus= maximum number of total cpus, including\n" |
Bruce Rogers | ca1a8a0 | 2010-01-06 12:33:57 -0700 | [diff] [blame] | 87 | " offline CPUs for hotplug, etc\n" |
Andre Przywara | 58a04db | 2009-08-28 10:49:57 +0200 | [diff] [blame] | 88 | " cores= number of CPU cores on one socket\n" |
| 89 | " threads= number of threads on one CPU core\n" |
Blue Swirl | ad96090 | 2010-03-29 19:23:52 +0000 | [diff] [blame] | 90 | " sockets= number of discrete sockets in the system\n", |
| 91 | QEMU_ARCH_ALL) |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 92 | STEXI |
Michael Tokarev | 12b7f57 | 2013-06-24 15:06:52 +0400 | [diff] [blame] | 93 | @item -smp [cpus=]@var{n}[,cores=@var{cores}][,threads=@var{threads}][,sockets=@var{sockets}][,maxcpus=@var{maxcpus}] |
Stefan Weil | 6616b2a | 2010-02-05 23:52:05 +0100 | [diff] [blame] | 94 | @findex -smp |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 95 | Simulate an SMP system with @var{n} CPUs. On the PC target, up to 255 |
| 96 | CPUs are supported. On Sparc32 target, Linux limits the number of usable CPUs |
| 97 | to 4. |
Andre Przywara | 58a04db | 2009-08-28 10:49:57 +0200 | [diff] [blame] | 98 | For the PC target, the number of @var{cores} per socket, the number |
| 99 | of @var{threads} per cores and the total number of @var{sockets} can be |
| 100 | specified. Missing values will be computed. If any on the three values is |
| 101 | given, the total number of CPUs @var{n} can be omitted. @var{maxcpus} |
| 102 | specifies the maximum number of hotpluggable CPUs. |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 103 | ETEXI |
| 104 | |
aliguori | 268a362 | 2009-04-21 22:30:27 +0000 | [diff] [blame] | 105 | DEF("numa", HAS_ARG, QEMU_OPTION_numa, |
Paolo Bonzini | 7febe36 | 2014-05-14 17:43:17 +0800 | [diff] [blame] | 106 | "-numa node[,mem=size][,cpus=cpu[-cpu]][,nodeid=node]\n" |
| 107 | "-numa node[,memdev=id][,cpus=cpu[-cpu]][,nodeid=node]\n", QEMU_ARCH_ALL) |
aliguori | 268a362 | 2009-04-21 22:30:27 +0000 | [diff] [blame] | 108 | STEXI |
Luiz Capitulino | 4932b89 | 2014-05-14 17:43:10 +0800 | [diff] [blame] | 109 | @item -numa node[,mem=@var{size}][,cpus=@var{cpu[-cpu]}][,nodeid=@var{node}] |
Paolo Bonzini | 7febe36 | 2014-05-14 17:43:17 +0800 | [diff] [blame] | 110 | @item -numa node[,memdev=@var{id}][,cpus=@var{cpu[-cpu]}][,nodeid=@var{node}] |
Stefan Weil | 6616b2a | 2010-02-05 23:52:05 +0100 | [diff] [blame] | 111 | @findex -numa |
Paolo Bonzini | 7febe36 | 2014-05-14 17:43:17 +0800 | [diff] [blame] | 112 | Simulate a multi node NUMA system. If @samp{mem}, @samp{memdev} |
Luiz Capitulino | 4932b89 | 2014-05-14 17:43:10 +0800 | [diff] [blame] | 113 | and @samp{cpus} are omitted, resources are split equally. Also, note |
| 114 | that the -@option{numa} option doesn't allocate any of the specified |
| 115 | resources. That is, it just assigns existing resources to NUMA nodes. This |
| 116 | means that one still has to use the @option{-m}, @option{-smp} options |
Paolo Bonzini | 7febe36 | 2014-05-14 17:43:17 +0800 | [diff] [blame] | 117 | to allocate RAM and VCPUs respectively, and possibly @option{-object} |
| 118 | to specify the memory backend for the @samp{memdev} suboption. |
| 119 | |
| 120 | @samp{mem} and @samp{memdev} are mutually exclusive. Furthermore, if one |
| 121 | node uses @samp{memdev}, all of them have to use it. |
aliguori | 268a362 | 2009-04-21 22:30:27 +0000 | [diff] [blame] | 122 | ETEXI |
| 123 | |
Markus Armbruster | 10adb8b | 2013-02-13 19:49:43 +0100 | [diff] [blame] | 124 | DEF("add-fd", HAS_ARG, QEMU_OPTION_add_fd, |
| 125 | "-add-fd fd=fd,set=set[,opaque=opaque]\n" |
| 126 | " Add 'fd' to fd 'set'\n", QEMU_ARCH_ALL) |
| 127 | STEXI |
| 128 | @item -add-fd fd=@var{fd},set=@var{set}[,opaque=@var{opaque}] |
| 129 | @findex -add-fd |
| 130 | |
| 131 | Add a file descriptor to an fd set. Valid options are: |
| 132 | |
| 133 | @table @option |
| 134 | @item fd=@var{fd} |
| 135 | This option defines the file descriptor of which a duplicate is added to fd set. |
| 136 | The file descriptor cannot be stdin, stdout, or stderr. |
| 137 | @item set=@var{set} |
| 138 | This option defines the ID of the fd set to add the file descriptor to. |
| 139 | @item opaque=@var{opaque} |
| 140 | This option defines a free-form string that can be used to describe @var{fd}. |
| 141 | @end table |
| 142 | |
| 143 | You can open an image using pre-opened file descriptors from an fd set: |
| 144 | @example |
| 145 | qemu-system-i386 |
| 146 | -add-fd fd=3,set=2,opaque="rdwr:/path/to/file" |
| 147 | -add-fd fd=4,set=2,opaque="rdonly:/path/to/file" |
| 148 | -drive file=/dev/fdset/2,index=0,media=disk |
| 149 | @end example |
| 150 | ETEXI |
| 151 | |
| 152 | DEF("set", HAS_ARG, QEMU_OPTION_set, |
| 153 | "-set group.id.arg=value\n" |
| 154 | " set <arg> parameter for item <id> of type <group>\n" |
| 155 | " i.e. -set drive.$id.file=/path/to/image\n", QEMU_ARCH_ALL) |
| 156 | STEXI |
| 157 | @item -set @var{group}.@var{id}.@var{arg}=@var{value} |
| 158 | @findex -set |
| 159 | Set parameter @var{arg} for item @var{id} of type @var{group}\n" |
| 160 | ETEXI |
| 161 | |
| 162 | DEF("global", HAS_ARG, QEMU_OPTION_global, |
| 163 | "-global driver.prop=value\n" |
| 164 | " set a global default for a driver property\n", |
| 165 | QEMU_ARCH_ALL) |
| 166 | STEXI |
| 167 | @item -global @var{driver}.@var{prop}=@var{value} |
| 168 | @findex -global |
| 169 | Set default value of @var{driver}'s property @var{prop} to @var{value}, e.g.: |
| 170 | |
| 171 | @example |
| 172 | qemu-system-i386 -global ide-drive.physical_block_size=4096 -drive file=file,if=ide,index=0,media=disk |
| 173 | @end example |
| 174 | |
| 175 | In particular, you can use this to set driver properties for devices which are |
| 176 | created automatically by the machine model. To create a device which is not |
| 177 | created automatically and set properties on it, use -@option{device}. |
| 178 | ETEXI |
| 179 | |
| 180 | DEF("boot", HAS_ARG, QEMU_OPTION_boot, |
| 181 | "-boot [order=drives][,once=drives][,menu=on|off]\n" |
Amos Kong | c8a6ae8 | 2013-03-19 14:23:27 +0800 | [diff] [blame] | 182 | " [,splash=sp_name][,splash-time=sp_time][,reboot-timeout=rb_time][,strict=on|off]\n" |
Markus Armbruster | 10adb8b | 2013-02-13 19:49:43 +0100 | [diff] [blame] | 183 | " 'drives': floppy (a), hard disk (c), CD-ROM (d), network (n)\n" |
| 184 | " 'sp_name': the file's name that would be passed to bios as logo picture, if menu=on\n" |
| 185 | " 'sp_time': the period that splash picture last if menu=on, unit is ms\n" |
| 186 | " 'rb_timeout': the timeout before guest reboot when boot failed, unit is ms\n", |
| 187 | QEMU_ARCH_ALL) |
| 188 | STEXI |
Amos Kong | c8a6ae8 | 2013-03-19 14:23:27 +0800 | [diff] [blame] | 189 | @item -boot [order=@var{drives}][,once=@var{drives}][,menu=on|off][,splash=@var{sp_name}][,splash-time=@var{sp_time}][,reboot-timeout=@var{rb_timeout}][,strict=on|off] |
Markus Armbruster | 10adb8b | 2013-02-13 19:49:43 +0100 | [diff] [blame] | 190 | @findex -boot |
| 191 | Specify boot order @var{drives} as a string of drive letters. Valid |
| 192 | drive letters depend on the target achitecture. The x86 PC uses: a, b |
| 193 | (floppy 1 and 2), c (first hard disk), d (first CD-ROM), n-p (Etherboot |
| 194 | from network adapter 1-4), hard disk boot is the default. To apply a |
| 195 | particular boot order only on the first startup, specify it via |
| 196 | @option{once}. |
| 197 | |
| 198 | Interactive boot menus/prompts can be enabled via @option{menu=on} as far |
| 199 | as firmware/BIOS supports them. The default is non-interactive boot. |
| 200 | |
| 201 | A splash picture could be passed to bios, enabling user to show it as logo, |
| 202 | when option splash=@var{sp_name} is given and menu=on, If firmware/BIOS |
| 203 | supports them. Currently Seabios for X86 system support it. |
| 204 | limitation: The splash file could be a jpeg file or a BMP file in 24 BPP |
| 205 | format(true color). The resolution should be supported by the SVGA mode, so |
| 206 | the recommended is 320x240, 640x480, 800x640. |
| 207 | |
| 208 | A timeout could be passed to bios, guest will pause for @var{rb_timeout} ms |
| 209 | when boot failed, then reboot. If @var{rb_timeout} is '-1', guest will not |
| 210 | reboot, qemu passes '-1' to bios by default. Currently Seabios for X86 |
| 211 | system support it. |
| 212 | |
Amos Kong | c8a6ae8 | 2013-03-19 14:23:27 +0800 | [diff] [blame] | 213 | Do strict boot via @option{strict=on} as far as firmware/BIOS |
| 214 | supports it. This only effects when boot priority is changed by |
| 215 | bootindex options. The default is non-strict boot. |
| 216 | |
Markus Armbruster | 10adb8b | 2013-02-13 19:49:43 +0100 | [diff] [blame] | 217 | @example |
| 218 | # try to boot from network first, then from hard disk |
| 219 | qemu-system-i386 -boot order=nc |
| 220 | # boot from CD-ROM first, switch back to default order after reboot |
| 221 | qemu-system-i386 -boot once=d |
| 222 | # boot with a splash picture for 5 seconds. |
| 223 | qemu-system-i386 -boot menu=on,splash=/root/boot.bmp,splash-time=5000 |
| 224 | @end example |
| 225 | |
| 226 | Note: The legacy format '-boot @var{drives}' is still supported but its |
| 227 | use is discouraged as it may be removed from future versions. |
| 228 | ETEXI |
| 229 | |
| 230 | DEF("m", HAS_ARG, QEMU_OPTION_m, |
Igor Mammedov | c270fb9 | 2014-06-02 15:25:02 +0200 | [diff] [blame] | 231 | "-m[emory] [size=]megs[,slots=n,maxmem=size]\n" |
Igor Mammedov | 6e1d3c1 | 2013-11-27 01:27:35 +0100 | [diff] [blame] | 232 | " configure guest RAM\n" |
| 233 | " size: initial amount of guest memory (default: " |
Igor Mammedov | c270fb9 | 2014-06-02 15:25:02 +0200 | [diff] [blame] | 234 | stringify(DEFAULT_RAM_SIZE) "MiB)\n" |
| 235 | " slots: number of hotplug slots (default: none)\n" |
Matthew Rosato | b6fe012 | 2014-08-28 11:25:33 -0400 | [diff] [blame] | 236 | " maxmem: maximum amount of guest memory (default: none)\n" |
| 237 | "NOTE: Some architectures might enforce a specific granularity\n", |
Igor Mammedov | 6e1d3c1 | 2013-11-27 01:27:35 +0100 | [diff] [blame] | 238 | QEMU_ARCH_ALL) |
Markus Armbruster | 10adb8b | 2013-02-13 19:49:43 +0100 | [diff] [blame] | 239 | STEXI |
Igor Mammedov | 6e1d3c1 | 2013-11-27 01:27:35 +0100 | [diff] [blame] | 240 | @item -m [size=]@var{megs} |
Markus Armbruster | 10adb8b | 2013-02-13 19:49:43 +0100 | [diff] [blame] | 241 | @findex -m |
| 242 | Set virtual RAM size to @var{megs} megabytes. Default is 128 MiB. Optionally, |
| 243 | a suffix of ``M'' or ``G'' can be used to signify a value in megabytes or |
Igor Mammedov | c270fb9 | 2014-06-02 15:25:02 +0200 | [diff] [blame] | 244 | gigabytes respectively. Optional pair @var{slots}, @var{maxmem} could be used |
| 245 | to set amount of hotluggable memory slots and possible maximum amount of memory. |
Markus Armbruster | 10adb8b | 2013-02-13 19:49:43 +0100 | [diff] [blame] | 246 | ETEXI |
| 247 | |
| 248 | DEF("mem-path", HAS_ARG, QEMU_OPTION_mempath, |
| 249 | "-mem-path FILE provide backing storage for guest RAM\n", QEMU_ARCH_ALL) |
| 250 | STEXI |
| 251 | @item -mem-path @var{path} |
| 252 | @findex -mem-path |
| 253 | Allocate guest RAM from a temporarily created file in @var{path}. |
| 254 | ETEXI |
| 255 | |
Markus Armbruster | 10adb8b | 2013-02-13 19:49:43 +0100 | [diff] [blame] | 256 | DEF("mem-prealloc", 0, QEMU_OPTION_mem_prealloc, |
| 257 | "-mem-prealloc preallocate guest memory (use with -mem-path)\n", |
| 258 | QEMU_ARCH_ALL) |
| 259 | STEXI |
| 260 | @item -mem-prealloc |
| 261 | @findex -mem-prealloc |
| 262 | Preallocate memory when using -mem-path. |
| 263 | ETEXI |
Markus Armbruster | 10adb8b | 2013-02-13 19:49:43 +0100 | [diff] [blame] | 264 | |
| 265 | DEF("k", HAS_ARG, QEMU_OPTION_k, |
| 266 | "-k language use keyboard layout (for example 'fr' for French)\n", |
| 267 | QEMU_ARCH_ALL) |
| 268 | STEXI |
| 269 | @item -k @var{language} |
| 270 | @findex -k |
| 271 | Use keyboard layout @var{language} (for example @code{fr} for |
| 272 | French). This option is only needed where it is not easy to get raw PC |
| 273 | keycodes (e.g. on Macs, with some X11 servers or with a VNC |
| 274 | display). You don't normally need to use it on PC/Linux or PC/Windows |
| 275 | hosts. |
| 276 | |
| 277 | The available layouts are: |
| 278 | @example |
| 279 | ar de-ch es fo fr-ca hu ja mk no pt-br sv |
| 280 | da en-gb et fr fr-ch is lt nl pl ru th |
| 281 | de en-us fi fr-be hr it lv nl-be pt sl tr |
| 282 | @end example |
| 283 | |
| 284 | The default is @code{en-us}. |
| 285 | ETEXI |
| 286 | |
| 287 | |
| 288 | DEF("audio-help", 0, QEMU_OPTION_audio_help, |
| 289 | "-audio-help print list of audio drivers and their options\n", |
| 290 | QEMU_ARCH_ALL) |
| 291 | STEXI |
| 292 | @item -audio-help |
| 293 | @findex -audio-help |
| 294 | Will show the audio subsystem help: list of drivers, tunable |
| 295 | parameters. |
| 296 | ETEXI |
| 297 | |
| 298 | DEF("soundhw", HAS_ARG, QEMU_OPTION_soundhw, |
| 299 | "-soundhw c1,... enable audio support\n" |
| 300 | " and only specified sound cards (comma separated list)\n" |
| 301 | " use '-soundhw help' to get the list of supported cards\n" |
| 302 | " use '-soundhw all' to enable all of them\n", QEMU_ARCH_ALL) |
| 303 | STEXI |
| 304 | @item -soundhw @var{card1}[,@var{card2},...] or -soundhw all |
| 305 | @findex -soundhw |
| 306 | Enable audio and selected sound hardware. Use 'help' to print all |
| 307 | available sound hardware. |
| 308 | |
| 309 | @example |
| 310 | qemu-system-i386 -soundhw sb16,adlib disk.img |
| 311 | qemu-system-i386 -soundhw es1370 disk.img |
| 312 | qemu-system-i386 -soundhw ac97 disk.img |
| 313 | qemu-system-i386 -soundhw hda disk.img |
| 314 | qemu-system-i386 -soundhw all disk.img |
| 315 | qemu-system-i386 -soundhw help |
| 316 | @end example |
| 317 | |
| 318 | Note that Linux's i810_audio OSS kernel (for AC97) module might |
| 319 | require manually specifying clocking. |
| 320 | |
| 321 | @example |
| 322 | modprobe i810_audio clocking=48000 |
| 323 | @end example |
| 324 | ETEXI |
| 325 | |
| 326 | DEF("balloon", HAS_ARG, QEMU_OPTION_balloon, |
| 327 | "-balloon none disable balloon device\n" |
| 328 | "-balloon virtio[,addr=str]\n" |
| 329 | " enable virtio balloon device (default)\n", QEMU_ARCH_ALL) |
| 330 | STEXI |
| 331 | @item -balloon none |
| 332 | @findex -balloon |
| 333 | Disable balloon device. |
| 334 | @item -balloon virtio[,addr=@var{addr}] |
| 335 | Enable virtio balloon device (default), optionally with PCI address |
| 336 | @var{addr}. |
| 337 | ETEXI |
| 338 | |
| 339 | DEF("device", HAS_ARG, QEMU_OPTION_device, |
| 340 | "-device driver[,prop[=value][,...]]\n" |
| 341 | " add device (based on driver)\n" |
| 342 | " prop=value,... sets driver properties\n" |
| 343 | " use '-device help' to print all possible drivers\n" |
| 344 | " use '-device driver,help' to print all possible properties\n", |
| 345 | QEMU_ARCH_ALL) |
| 346 | STEXI |
| 347 | @item -device @var{driver}[,@var{prop}[=@var{value}][,...]] |
| 348 | @findex -device |
| 349 | Add device @var{driver}. @var{prop}=@var{value} sets driver |
| 350 | properties. Valid properties depend on the driver. To get help on |
| 351 | possible drivers and properties, use @code{-device help} and |
| 352 | @code{-device @var{driver},help}. |
| 353 | ETEXI |
| 354 | |
| 355 | DEF("name", HAS_ARG, QEMU_OPTION_name, |
Dr. David Alan Gilbert | 8f480de | 2014-01-30 10:20:31 +0000 | [diff] [blame] | 356 | "-name string1[,process=string2][,debug-threads=on|off]\n" |
Markus Armbruster | 10adb8b | 2013-02-13 19:49:43 +0100 | [diff] [blame] | 357 | " set the name of the guest\n" |
Dr. David Alan Gilbert | 8f480de | 2014-01-30 10:20:31 +0000 | [diff] [blame] | 358 | " string1 sets the window title and string2 the process name (on Linux)\n" |
| 359 | " When debug-threads is enabled, individual threads are given a separate name (on Linux)\n" |
| 360 | " NOTE: The thread names are for debugging and not a stable API.\n", |
Markus Armbruster | 10adb8b | 2013-02-13 19:49:43 +0100 | [diff] [blame] | 361 | QEMU_ARCH_ALL) |
| 362 | STEXI |
| 363 | @item -name @var{name} |
| 364 | @findex -name |
| 365 | Sets the @var{name} of the guest. |
| 366 | This name will be displayed in the SDL window caption. |
| 367 | The @var{name} will also be used for the VNC server. |
| 368 | Also optionally set the top visible process name in Linux. |
Dr. David Alan Gilbert | 8f480de | 2014-01-30 10:20:31 +0000 | [diff] [blame] | 369 | Naming of individual threads can also be enabled on Linux to aid debugging. |
Markus Armbruster | 10adb8b | 2013-02-13 19:49:43 +0100 | [diff] [blame] | 370 | ETEXI |
| 371 | |
| 372 | DEF("uuid", HAS_ARG, QEMU_OPTION_uuid, |
| 373 | "-uuid %08x-%04x-%04x-%04x-%012x\n" |
| 374 | " specify machine UUID\n", QEMU_ARCH_ALL) |
| 375 | STEXI |
| 376 | @item -uuid @var{uuid} |
| 377 | @findex -uuid |
| 378 | Set system UUID. |
| 379 | ETEXI |
| 380 | |
| 381 | STEXI |
| 382 | @end table |
| 383 | ETEXI |
| 384 | DEFHEADING() |
| 385 | |
| 386 | DEFHEADING(Block device options:) |
| 387 | STEXI |
| 388 | @table @option |
| 389 | ETEXI |
| 390 | |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 391 | DEF("fda", HAS_ARG, QEMU_OPTION_fda, |
Blue Swirl | ad96090 | 2010-03-29 19:23:52 +0000 | [diff] [blame] | 392 | "-fda/-fdb file use 'file' as floppy disk 0/1 image\n", QEMU_ARCH_ALL) |
| 393 | DEF("fdb", HAS_ARG, QEMU_OPTION_fdb, "", QEMU_ARCH_ALL) |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 394 | STEXI |
| 395 | @item -fda @var{file} |
| 396 | @item -fdb @var{file} |
Stefan Weil | 6616b2a | 2010-02-05 23:52:05 +0100 | [diff] [blame] | 397 | @findex -fda |
| 398 | @findex -fdb |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 399 | Use @var{file} as floppy disk 0/1 image (@pxref{disk_images}). You can |
| 400 | use the host floppy by using @file{/dev/fd0} as filename (@pxref{host_drives}). |
| 401 | ETEXI |
| 402 | |
| 403 | DEF("hda", HAS_ARG, QEMU_OPTION_hda, |
Blue Swirl | ad96090 | 2010-03-29 19:23:52 +0000 | [diff] [blame] | 404 | "-hda/-hdb file use 'file' as IDE hard disk 0/1 image\n", QEMU_ARCH_ALL) |
| 405 | DEF("hdb", HAS_ARG, QEMU_OPTION_hdb, "", QEMU_ARCH_ALL) |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 406 | DEF("hdc", HAS_ARG, QEMU_OPTION_hdc, |
Blue Swirl | ad96090 | 2010-03-29 19:23:52 +0000 | [diff] [blame] | 407 | "-hdc/-hdd file use 'file' as IDE hard disk 2/3 image\n", QEMU_ARCH_ALL) |
| 408 | DEF("hdd", HAS_ARG, QEMU_OPTION_hdd, "", QEMU_ARCH_ALL) |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 409 | STEXI |
| 410 | @item -hda @var{file} |
| 411 | @item -hdb @var{file} |
| 412 | @item -hdc @var{file} |
| 413 | @item -hdd @var{file} |
Stefan Weil | 6616b2a | 2010-02-05 23:52:05 +0100 | [diff] [blame] | 414 | @findex -hda |
| 415 | @findex -hdb |
| 416 | @findex -hdc |
| 417 | @findex -hdd |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 418 | Use @var{file} as hard disk 0, 1, 2 or 3 image (@pxref{disk_images}). |
| 419 | ETEXI |
| 420 | |
| 421 | DEF("cdrom", HAS_ARG, QEMU_OPTION_cdrom, |
Blue Swirl | ad96090 | 2010-03-29 19:23:52 +0000 | [diff] [blame] | 422 | "-cdrom file use 'file' as IDE cdrom image (cdrom is ide1 master)\n", |
| 423 | QEMU_ARCH_ALL) |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 424 | STEXI |
| 425 | @item -cdrom @var{file} |
Stefan Weil | 6616b2a | 2010-02-05 23:52:05 +0100 | [diff] [blame] | 426 | @findex -cdrom |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 427 | Use @var{file} as CD-ROM image (you cannot use @option{-hdc} and |
| 428 | @option{-cdrom} at the same time). You can use the host CD-ROM by |
| 429 | using @file{/dev/cdrom} as filename (@pxref{host_drives}). |
| 430 | ETEXI |
| 431 | |
| 432 | DEF("drive", HAS_ARG, QEMU_OPTION_drive, |
| 433 | "-drive [file=file][,if=type][,bus=n][,unit=m][,media=d][,index=i]\n" |
| 434 | " [,cyls=c,heads=h,secs=s[,trans=t]][,snapshot=on|off]\n" |
Stefan Hajnoczi | 92196b2 | 2011-08-04 12:26:52 +0100 | [diff] [blame] | 435 | " [,cache=writethrough|writeback|none|directsync|unsafe][,format=f]\n" |
Stefan Hajnoczi | d1db760 | 2014-04-23 13:55:37 +0200 | [diff] [blame] | 436 | " [,serial=s][,addr=A][,rerror=ignore|stop|report]\n" |
| 437 | " [,werror=ignore|stop|report|enospc][,id=name][,aio=threads|native]\n" |
Stefan Hajnoczi | fb0490f | 2011-11-17 13:40:32 +0000 | [diff] [blame] | 438 | " [,readonly=on|off][,copy-on-read=on|off]\n" |
Peter Lieven | 2f7133b | 2014-07-28 21:53:02 +0200 | [diff] [blame] | 439 | " [,discard=ignore|unmap][,detect-zeroes=on|off|unmap]\n" |
Benoît Canet | 3e9fab6 | 2013-09-02 14:14:40 +0200 | [diff] [blame] | 440 | " [[,bps=b]|[[,bps_rd=r][,bps_wr=w]]]\n" |
| 441 | " [[,iops=i]|[[,iops_rd=r][,iops_wr=w]]]\n" |
| 442 | " [[,bps_max=bm]|[[,bps_rd_max=rm][,bps_wr_max=wm]]]\n" |
| 443 | " [[,iops_max=im]|[[,iops_rd_max=irm][,iops_wr_max=iwm]]]\n" |
Benoît Canet | 2024c1d | 2013-09-02 14:14:41 +0200 | [diff] [blame] | 444 | " [[,iops_size=is]]\n" |
Blue Swirl | ad96090 | 2010-03-29 19:23:52 +0000 | [diff] [blame] | 445 | " use 'file' as a drive image\n", QEMU_ARCH_ALL) |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 446 | STEXI |
| 447 | @item -drive @var{option}[,@var{option}[,@var{option}[,...]]] |
Stefan Weil | 6616b2a | 2010-02-05 23:52:05 +0100 | [diff] [blame] | 448 | @findex -drive |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 449 | |
| 450 | Define a new drive. Valid options are: |
| 451 | |
Kevin Wolf | b3f046c | 2009-10-09 10:58:35 +0200 | [diff] [blame] | 452 | @table @option |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 453 | @item file=@var{file} |
| 454 | This option defines which disk image (@pxref{disk_images}) to use with |
| 455 | this drive. If the filename contains comma, you must double it |
| 456 | (for instance, "file=my,,file" to use file "my,file"). |
Ronnie Sahlberg | 0f5314a | 2011-10-26 23:51:37 +1100 | [diff] [blame] | 457 | |
| 458 | Special files such as iSCSI devices can be specified using protocol |
| 459 | specific URLs. See the section for "Device URL Syntax" for more information. |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 460 | @item if=@var{interface} |
| 461 | This option defines on which type on interface the drive is connected. |
| 462 | Available types are: ide, scsi, sd, mtd, floppy, pflash, virtio. |
| 463 | @item bus=@var{bus},unit=@var{unit} |
| 464 | These options define where is connected the drive by defining the bus number and |
| 465 | the unit id. |
| 466 | @item index=@var{index} |
| 467 | This option defines where is connected the drive by using an index in the list |
| 468 | of available connectors of a given interface type. |
| 469 | @item media=@var{media} |
| 470 | This option defines the type of the media: disk or cdrom. |
| 471 | @item cyls=@var{c},heads=@var{h},secs=@var{s}[,trans=@var{t}] |
| 472 | These options have the same definition as they have in @option{-hdachs}. |
| 473 | @item snapshot=@var{snapshot} |
Michael Tokarev | 9d85d55 | 2014-04-07 13:34:58 +0400 | [diff] [blame] | 474 | @var{snapshot} is "on" or "off" and controls snapshot mode for the given drive |
| 475 | (see @option{-snapshot}). |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 476 | @item cache=@var{cache} |
Stefan Hajnoczi | 92196b2 | 2011-08-04 12:26:52 +0100 | [diff] [blame] | 477 | @var{cache} is "none", "writeback", "unsafe", "directsync" or "writethrough" and controls how the host cache is used to access block data. |
Christoph Hellwig | 5c6c3a6 | 2009-08-20 16:58:35 +0200 | [diff] [blame] | 478 | @item aio=@var{aio} |
| 479 | @var{aio} is "threads", or "native" and selects between pthread based disk I/O and native Linux AIO. |
Paolo Bonzini | a9384af | 2013-02-08 14:06:12 +0100 | [diff] [blame] | 480 | @item discard=@var{discard} |
| 481 | @var{discard} is one of "ignore" (or "off") or "unmap" (or "on") and controls whether @dfn{discard} (also known as @dfn{trim} or @dfn{unmap}) requests are ignored or passed to the filesystem. Some machine types may not support discard requests. |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 482 | @item format=@var{format} |
| 483 | Specify which disk @var{format} will be used rather than detecting |
| 484 | the format. Can be used to specifiy format=raw to avoid interpreting |
| 485 | an untrusted format header. |
| 486 | @item serial=@var{serial} |
| 487 | This option specifies the serial number to assign to the device. |
Markus Armbruster | c2cc47a | 2009-06-18 15:14:10 +0200 | [diff] [blame] | 488 | @item addr=@var{addr} |
| 489 | Specify the controller's PCI address (if=virtio only). |
Luiz Capitulino | ae73e59 | 2011-07-12 17:35:08 -0300 | [diff] [blame] | 490 | @item werror=@var{action},rerror=@var{action} |
| 491 | Specify which @var{action} to take on write and read errors. Valid actions are: |
| 492 | "ignore" (ignore the error and try to continue), "stop" (pause QEMU), |
| 493 | "report" (report the error to the guest), "enospc" (pause QEMU only if the |
| 494 | host disk is full; report the error to the guest otherwise). |
| 495 | The default setting is @option{werror=enospc} and @option{rerror=report}. |
| 496 | @item readonly |
| 497 | Open drive @option{file} as read-only. Guest write attempts will fail. |
Stefan Hajnoczi | fb0490f | 2011-11-17 13:40:32 +0000 | [diff] [blame] | 498 | @item copy-on-read=@var{copy-on-read} |
| 499 | @var{copy-on-read} is "on" or "off" and enables whether to copy read backing |
| 500 | file sectors into the image file. |
Peter Lieven | 465bee1 | 2014-05-18 00:58:19 +0200 | [diff] [blame] | 501 | @item detect-zeroes=@var{detect-zeroes} |
| 502 | @var{detect-zeroes} is "off", "on" or "unmap" and enables the automatic |
| 503 | conversion of plain zero writes by the OS to driver specific optimized |
| 504 | zero write commands. You may even choose "unmap" if @var{discard} is set |
| 505 | to "unmap" to allow a zero write to be converted to an UNMAP operation. |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 506 | @end table |
| 507 | |
Kevin Wolf | a13e5e0 | 2012-11-21 12:26:56 +0100 | [diff] [blame] | 508 | By default, the @option{cache=writeback} mode is used. It will report data |
| 509 | writes as completed as soon as the data is present in the host page cache. |
| 510 | This is safe as long as your guest OS makes sure to correctly flush disk caches |
| 511 | where needed. If your guest OS does not handle volatile disk write caches |
| 512 | correctly and your host crashes or loses power, then the guest may experience |
| 513 | data corruption. |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 514 | |
Kevin Wolf | a13e5e0 | 2012-11-21 12:26:56 +0100 | [diff] [blame] | 515 | For such guests, you should consider using @option{cache=writethrough}. This |
| 516 | means that the host page cache will be used to read and write data, but write |
| 517 | notification will be sent to the guest only after QEMU has made sure to flush |
| 518 | each write to the disk. Be aware that this has a major impact on performance. |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 519 | |
Aurelien Jarno | c304d31 | 2009-05-03 23:29:14 +0200 | [diff] [blame] | 520 | The host page cache can be avoided entirely with @option{cache=none}. This will |
Kevin Wolf | a13e5e0 | 2012-11-21 12:26:56 +0100 | [diff] [blame] | 521 | attempt to do disk IO directly to the guest's memory. QEMU may still perform |
| 522 | an internal copy of the data. Note that this is considered a writeback mode and |
| 523 | the guest OS must handle the disk write cache correctly in order to avoid data |
| 524 | corruption on host crashes. |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 525 | |
Stefan Hajnoczi | 92196b2 | 2011-08-04 12:26:52 +0100 | [diff] [blame] | 526 | The host page cache can be avoided while only sending write notifications to |
Kevin Wolf | a13e5e0 | 2012-11-21 12:26:56 +0100 | [diff] [blame] | 527 | the guest when the data has been flushed to the disk using |
| 528 | @option{cache=directsync}. |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 529 | |
Alexander Graf | 016f5cf | 2010-05-26 17:51:49 +0200 | [diff] [blame] | 530 | In case you don't care about data integrity over host failures, use |
Kevin Wolf | a13e5e0 | 2012-11-21 12:26:56 +0100 | [diff] [blame] | 531 | @option{cache=unsafe}. This option tells QEMU that it never needs to write any |
| 532 | data to the disk but can instead keep things in cache. If anything goes wrong, |
Stefan Weil | e7d8100 | 2011-12-10 00:19:46 +0100 | [diff] [blame] | 533 | like your host losing power, the disk storage getting disconnected accidentally, |
Kevin Wolf | a13e5e0 | 2012-11-21 12:26:56 +0100 | [diff] [blame] | 534 | etc. your image will most probably be rendered unusable. When using |
Alexander Graf | c317728 | 2010-05-26 21:04:32 +0200 | [diff] [blame] | 535 | the @option{-snapshot} option, unsafe caching is always used. |
Alexander Graf | 016f5cf | 2010-05-26 17:51:49 +0200 | [diff] [blame] | 536 | |
Stefan Hajnoczi | fb0490f | 2011-11-17 13:40:32 +0000 | [diff] [blame] | 537 | Copy-on-read avoids accessing the same backing file sectors repeatedly and is |
| 538 | useful when the backing file is over a slow network. By default copy-on-read |
| 539 | is off. |
| 540 | |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 541 | Instead of @option{-cdrom} you can use: |
| 542 | @example |
Stefan Weil | 3804da9 | 2012-05-11 22:21:50 +0200 | [diff] [blame] | 543 | qemu-system-i386 -drive file=file,index=2,media=cdrom |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 544 | @end example |
| 545 | |
| 546 | Instead of @option{-hda}, @option{-hdb}, @option{-hdc}, @option{-hdd}, you can |
| 547 | use: |
| 548 | @example |
Stefan Weil | 3804da9 | 2012-05-11 22:21:50 +0200 | [diff] [blame] | 549 | qemu-system-i386 -drive file=file,index=0,media=disk |
| 550 | qemu-system-i386 -drive file=file,index=1,media=disk |
| 551 | qemu-system-i386 -drive file=file,index=2,media=disk |
| 552 | qemu-system-i386 -drive file=file,index=3,media=disk |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 553 | @end example |
| 554 | |
Corey Bryant | 587ed6b | 2012-10-18 15:19:34 -0400 | [diff] [blame] | 555 | You can open an image using pre-opened file descriptors from an fd set: |
| 556 | @example |
| 557 | qemu-system-i386 |
| 558 | -add-fd fd=3,set=2,opaque="rdwr:/path/to/file" |
| 559 | -add-fd fd=4,set=2,opaque="rdonly:/path/to/file" |
| 560 | -drive file=/dev/fdset/2,index=0,media=disk |
| 561 | @end example |
| 562 | |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 563 | You can connect a CDROM to the slave of ide0: |
| 564 | @example |
Stefan Weil | 3804da9 | 2012-05-11 22:21:50 +0200 | [diff] [blame] | 565 | qemu-system-i386 -drive file=file,if=ide,index=1,media=cdrom |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 566 | @end example |
| 567 | |
| 568 | If you don't specify the "file=" argument, you define an empty drive: |
| 569 | @example |
Stefan Weil | 3804da9 | 2012-05-11 22:21:50 +0200 | [diff] [blame] | 570 | qemu-system-i386 -drive if=ide,index=1,media=cdrom |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 571 | @end example |
| 572 | |
| 573 | You can connect a SCSI disk with unit ID 6 on the bus #0: |
| 574 | @example |
Stefan Weil | 3804da9 | 2012-05-11 22:21:50 +0200 | [diff] [blame] | 575 | qemu-system-i386 -drive file=file,if=scsi,bus=0,unit=6 |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 576 | @end example |
| 577 | |
| 578 | Instead of @option{-fda}, @option{-fdb}, you can use: |
| 579 | @example |
Stefan Weil | 3804da9 | 2012-05-11 22:21:50 +0200 | [diff] [blame] | 580 | qemu-system-i386 -drive file=file,index=0,if=floppy |
| 581 | qemu-system-i386 -drive file=file,index=1,if=floppy |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 582 | @end example |
| 583 | |
| 584 | By default, @var{interface} is "ide" and @var{index} is automatically |
| 585 | incremented: |
| 586 | @example |
Stefan Weil | 3804da9 | 2012-05-11 22:21:50 +0200 | [diff] [blame] | 587 | qemu-system-i386 -drive file=a -drive file=b" |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 588 | @end example |
| 589 | is interpreted like: |
| 590 | @example |
Stefan Weil | 3804da9 | 2012-05-11 22:21:50 +0200 | [diff] [blame] | 591 | qemu-system-i386 -hda a -hdb b |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 592 | @end example |
| 593 | ETEXI |
| 594 | |
| 595 | DEF("mtdblock", HAS_ARG, QEMU_OPTION_mtdblock, |
Blue Swirl | ad96090 | 2010-03-29 19:23:52 +0000 | [diff] [blame] | 596 | "-mtdblock file use 'file' as on-board Flash memory image\n", |
| 597 | QEMU_ARCH_ALL) |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 598 | STEXI |
Kevin Wolf | 4e257e5 | 2009-10-09 10:58:36 +0200 | [diff] [blame] | 599 | @item -mtdblock @var{file} |
Stefan Weil | 6616b2a | 2010-02-05 23:52:05 +0100 | [diff] [blame] | 600 | @findex -mtdblock |
Kevin Wolf | 4e257e5 | 2009-10-09 10:58:36 +0200 | [diff] [blame] | 601 | Use @var{file} as on-board Flash memory image. |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 602 | ETEXI |
| 603 | |
| 604 | DEF("sd", HAS_ARG, QEMU_OPTION_sd, |
Blue Swirl | ad96090 | 2010-03-29 19:23:52 +0000 | [diff] [blame] | 605 | "-sd file use 'file' as SecureDigital card image\n", QEMU_ARCH_ALL) |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 606 | STEXI |
Kevin Wolf | 4e257e5 | 2009-10-09 10:58:36 +0200 | [diff] [blame] | 607 | @item -sd @var{file} |
Stefan Weil | 6616b2a | 2010-02-05 23:52:05 +0100 | [diff] [blame] | 608 | @findex -sd |
Kevin Wolf | 4e257e5 | 2009-10-09 10:58:36 +0200 | [diff] [blame] | 609 | Use @var{file} as SecureDigital card image. |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 610 | ETEXI |
| 611 | |
| 612 | DEF("pflash", HAS_ARG, QEMU_OPTION_pflash, |
Blue Swirl | ad96090 | 2010-03-29 19:23:52 +0000 | [diff] [blame] | 613 | "-pflash file use 'file' as a parallel flash image\n", QEMU_ARCH_ALL) |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 614 | STEXI |
Kevin Wolf | 4e257e5 | 2009-10-09 10:58:36 +0200 | [diff] [blame] | 615 | @item -pflash @var{file} |
Stefan Weil | 6616b2a | 2010-02-05 23:52:05 +0100 | [diff] [blame] | 616 | @findex -pflash |
Kevin Wolf | 4e257e5 | 2009-10-09 10:58:36 +0200 | [diff] [blame] | 617 | Use @var{file} as a parallel flash image. |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 618 | ETEXI |
| 619 | |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 620 | DEF("snapshot", 0, QEMU_OPTION_snapshot, |
Blue Swirl | ad96090 | 2010-03-29 19:23:52 +0000 | [diff] [blame] | 621 | "-snapshot write to temporary files instead of disk image files\n", |
| 622 | QEMU_ARCH_ALL) |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 623 | STEXI |
| 624 | @item -snapshot |
Stefan Weil | 6616b2a | 2010-02-05 23:52:05 +0100 | [diff] [blame] | 625 | @findex -snapshot |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 626 | Write to temporary files instead of disk image files. In this case, |
| 627 | the raw disk image you use is not written back. You can however force |
| 628 | the write back by pressing @key{C-a s} (@pxref{disk_images}). |
| 629 | ETEXI |
| 630 | |
Markus Armbruster | 10adb8b | 2013-02-13 19:49:43 +0100 | [diff] [blame] | 631 | DEF("hdachs", HAS_ARG, QEMU_OPTION_hdachs, \ |
| 632 | "-hdachs c,h,s[,t]\n" \ |
| 633 | " force hard disk 0 physical geometry and the optional BIOS\n" \ |
| 634 | " translation (t=none or lba) (usually QEMU can guess them)\n", |
Blue Swirl | ad96090 | 2010-03-29 19:23:52 +0000 | [diff] [blame] | 635 | QEMU_ARCH_ALL) |
Marcelo Tosatti | c902760 | 2010-03-01 20:25:08 -0300 | [diff] [blame] | 636 | STEXI |
Markus Armbruster | 10adb8b | 2013-02-13 19:49:43 +0100 | [diff] [blame] | 637 | @item -hdachs @var{c},@var{h},@var{s},[,@var{t}] |
| 638 | @findex -hdachs |
| 639 | Force hard disk 0 physical geometry (1 <= @var{c} <= 16383, 1 <= |
| 640 | @var{h} <= 16, 1 <= @var{s} <= 63) and optionally force the BIOS |
| 641 | translation mode (@var{t}=none, lba or auto). Usually QEMU can guess |
| 642 | all those parameters. This option is useful for old MS-DOS disk |
| 643 | images. |
Markus Armbruster | c70a01e | 2013-02-13 19:49:40 +0100 | [diff] [blame] | 644 | ETEXI |
Gautham R Shenoy | 74db920 | 2010-04-29 17:44:43 +0530 | [diff] [blame] | 645 | |
| 646 | DEF("fsdev", HAS_ARG, QEMU_OPTION_fsdev, |
Aneesh Kumar K.V | 2c30dd7 | 2012-01-19 12:21:11 +0530 | [diff] [blame] | 647 | "-fsdev fsdriver,id=id[,path=path,][security_model={mapped-xattr|mapped-file|passthrough|none}]\n" |
M. Mohan Kumar | 84a87cc | 2011-12-14 13:58:47 +0530 | [diff] [blame] | 648 | " [,writeout=immediate][,readonly][,socket=socket|sock_fd=sock_fd]\n", |
Gautham R Shenoy | 74db920 | 2010-04-29 17:44:43 +0530 | [diff] [blame] | 649 | QEMU_ARCH_ALL) |
| 650 | |
| 651 | STEXI |
| 652 | |
M. Mohan Kumar | 84a87cc | 2011-12-14 13:58:47 +0530 | [diff] [blame] | 653 | @item -fsdev @var{fsdriver},id=@var{id},path=@var{path},[security_model=@var{security_model}][,writeout=@var{writeout}][,readonly][,socket=@var{socket}|sock_fd=@var{sock_fd}] |
Gautham R Shenoy | 74db920 | 2010-04-29 17:44:43 +0530 | [diff] [blame] | 654 | @findex -fsdev |
Aneesh Kumar K.V | 7c92a3d | 2011-10-12 19:11:24 +0530 | [diff] [blame] | 655 | Define a new file system device. Valid options are: |
| 656 | @table @option |
| 657 | @item @var{fsdriver} |
| 658 | This option specifies the fs driver backend to use. |
M. Mohan Kumar | f67e3ff | 2011-12-14 13:58:46 +0530 | [diff] [blame] | 659 | Currently "local", "handle" and "proxy" file system drivers are supported. |
Aneesh Kumar K.V | 7c92a3d | 2011-10-12 19:11:24 +0530 | [diff] [blame] | 660 | @item id=@var{id} |
| 661 | Specifies identifier for this device |
| 662 | @item path=@var{path} |
| 663 | Specifies the export path for the file system device. Files under |
| 664 | this path will be available to the 9p client on the guest. |
| 665 | @item security_model=@var{security_model} |
| 666 | Specifies the security model to be used for this export path. |
Aneesh Kumar K.V | 2c30dd7 | 2012-01-19 12:21:11 +0530 | [diff] [blame] | 667 | Supported security models are "passthrough", "mapped-xattr", "mapped-file" and "none". |
Aneesh Kumar K.V | 7c92a3d | 2011-10-12 19:11:24 +0530 | [diff] [blame] | 668 | In "passthrough" security model, files are stored using the same |
Stefan Weil | b65ee4f | 2012-05-11 22:25:50 +0200 | [diff] [blame] | 669 | credentials as they are created on the guest. This requires QEMU |
Aneesh Kumar K.V | 2c30dd7 | 2012-01-19 12:21:11 +0530 | [diff] [blame] | 670 | to run as root. In "mapped-xattr" security model, some of the file |
Aneesh Kumar K.V | 7c92a3d | 2011-10-12 19:11:24 +0530 | [diff] [blame] | 671 | attributes like uid, gid, mode bits and link target are stored as |
Aneesh Kumar K.V | 2c30dd7 | 2012-01-19 12:21:11 +0530 | [diff] [blame] | 672 | file attributes. For "mapped-file" these attributes are stored in the |
| 673 | hidden .virtfs_metadata directory. Directories exported by this security model cannot |
Aneesh Kumar K.V | 7c92a3d | 2011-10-12 19:11:24 +0530 | [diff] [blame] | 674 | interact with other unix tools. "none" security model is same as |
| 675 | passthrough except the sever won't report failures if it fails to |
M. Mohan Kumar | d9b36a6 | 2011-10-14 12:59:37 +0530 | [diff] [blame] | 676 | set file attributes like ownership. Security model is mandatory |
M. Mohan Kumar | f67e3ff | 2011-12-14 13:58:46 +0530 | [diff] [blame] | 677 | only for local fsdriver. Other fsdrivers (like handle, proxy) don't take |
M. Mohan Kumar | d9b36a6 | 2011-10-14 12:59:37 +0530 | [diff] [blame] | 678 | security model as a parameter. |
Aneesh Kumar K.V | 7c92a3d | 2011-10-12 19:11:24 +0530 | [diff] [blame] | 679 | @item writeout=@var{writeout} |
| 680 | This is an optional argument. The only supported value is "immediate". |
| 681 | This means that host page cache will be used to read and write data but |
| 682 | write notification will be sent to the guest only when the data has been |
| 683 | reported as written by the storage subsystem. |
M. Mohan Kumar | 2c74c2c | 2011-10-25 12:10:39 +0530 | [diff] [blame] | 684 | @item readonly |
| 685 | Enables exporting 9p share as a readonly mount for guests. By default |
| 686 | read-write access is given. |
M. Mohan Kumar | 84a87cc | 2011-12-14 13:58:47 +0530 | [diff] [blame] | 687 | @item socket=@var{socket} |
| 688 | Enables proxy filesystem driver to use passed socket file for communicating |
| 689 | with virtfs-proxy-helper |
M. Mohan Kumar | f67e3ff | 2011-12-14 13:58:46 +0530 | [diff] [blame] | 690 | @item sock_fd=@var{sock_fd} |
| 691 | Enables proxy filesystem driver to use passed socket descriptor for |
| 692 | communicating with virtfs-proxy-helper. Usually a helper like libvirt |
| 693 | will create socketpair and pass one of the fds as sock_fd |
Gautham R Shenoy | 74db920 | 2010-04-29 17:44:43 +0530 | [diff] [blame] | 694 | @end table |
Aneesh Kumar K.V | 7c92a3d | 2011-10-12 19:11:24 +0530 | [diff] [blame] | 695 | |
| 696 | -fsdev option is used along with -device driver "virtio-9p-pci". |
| 697 | @item -device virtio-9p-pci,fsdev=@var{id},mount_tag=@var{mount_tag} |
| 698 | Options for virtio-9p-pci driver are: |
| 699 | @table @option |
| 700 | @item fsdev=@var{id} |
| 701 | Specifies the id value specified along with -fsdev option |
| 702 | @item mount_tag=@var{mount_tag} |
| 703 | Specifies the tag name to be used by the guest to mount this export point |
| 704 | @end table |
| 705 | |
Gautham R Shenoy | 74db920 | 2010-04-29 17:44:43 +0530 | [diff] [blame] | 706 | ETEXI |
Gautham R Shenoy | 74db920 | 2010-04-29 17:44:43 +0530 | [diff] [blame] | 707 | |
Gautham R Shenoy | 3d54abc | 2010-04-29 17:45:03 +0530 | [diff] [blame] | 708 | DEF("virtfs", HAS_ARG, QEMU_OPTION_virtfs, |
Aneesh Kumar K.V | 2c30dd7 | 2012-01-19 12:21:11 +0530 | [diff] [blame] | 709 | "-virtfs local,path=path,mount_tag=tag,security_model=[mapped-xattr|mapped-file|passthrough|none]\n" |
M. Mohan Kumar | 84a87cc | 2011-12-14 13:58:47 +0530 | [diff] [blame] | 710 | " [,writeout=immediate][,readonly][,socket=socket|sock_fd=sock_fd]\n", |
Gautham R Shenoy | 3d54abc | 2010-04-29 17:45:03 +0530 | [diff] [blame] | 711 | QEMU_ARCH_ALL) |
| 712 | |
| 713 | STEXI |
| 714 | |
M. Mohan Kumar | 84a87cc | 2011-12-14 13:58:47 +0530 | [diff] [blame] | 715 | @item -virtfs @var{fsdriver}[,path=@var{path}],mount_tag=@var{mount_tag}[,security_model=@var{security_model}][,writeout=@var{writeout}][,readonly][,socket=@var{socket}|sock_fd=@var{sock_fd}] |
Gautham R Shenoy | 3d54abc | 2010-04-29 17:45:03 +0530 | [diff] [blame] | 716 | @findex -virtfs |
Gautham R Shenoy | 3d54abc | 2010-04-29 17:45:03 +0530 | [diff] [blame] | 717 | |
Aneesh Kumar K.V | 7c92a3d | 2011-10-12 19:11:24 +0530 | [diff] [blame] | 718 | The general form of a Virtual File system pass-through options are: |
| 719 | @table @option |
| 720 | @item @var{fsdriver} |
| 721 | This option specifies the fs driver backend to use. |
M. Mohan Kumar | f67e3ff | 2011-12-14 13:58:46 +0530 | [diff] [blame] | 722 | Currently "local", "handle" and "proxy" file system drivers are supported. |
Aneesh Kumar K.V | 7c92a3d | 2011-10-12 19:11:24 +0530 | [diff] [blame] | 723 | @item id=@var{id} |
| 724 | Specifies identifier for this device |
| 725 | @item path=@var{path} |
| 726 | Specifies the export path for the file system device. Files under |
| 727 | this path will be available to the 9p client on the guest. |
| 728 | @item security_model=@var{security_model} |
| 729 | Specifies the security model to be used for this export path. |
Aneesh Kumar K.V | 2c30dd7 | 2012-01-19 12:21:11 +0530 | [diff] [blame] | 730 | Supported security models are "passthrough", "mapped-xattr", "mapped-file" and "none". |
Aneesh Kumar K.V | 7c92a3d | 2011-10-12 19:11:24 +0530 | [diff] [blame] | 731 | In "passthrough" security model, files are stored using the same |
Stefan Weil | b65ee4f | 2012-05-11 22:25:50 +0200 | [diff] [blame] | 732 | credentials as they are created on the guest. This requires QEMU |
Aneesh Kumar K.V | 2c30dd7 | 2012-01-19 12:21:11 +0530 | [diff] [blame] | 733 | to run as root. In "mapped-xattr" security model, some of the file |
Aneesh Kumar K.V | 7c92a3d | 2011-10-12 19:11:24 +0530 | [diff] [blame] | 734 | attributes like uid, gid, mode bits and link target are stored as |
Aneesh Kumar K.V | 2c30dd7 | 2012-01-19 12:21:11 +0530 | [diff] [blame] | 735 | file attributes. For "mapped-file" these attributes are stored in the |
| 736 | hidden .virtfs_metadata directory. Directories exported by this security model cannot |
Aneesh Kumar K.V | 7c92a3d | 2011-10-12 19:11:24 +0530 | [diff] [blame] | 737 | interact with other unix tools. "none" security model is same as |
| 738 | passthrough except the sever won't report failures if it fails to |
M. Mohan Kumar | d9b36a6 | 2011-10-14 12:59:37 +0530 | [diff] [blame] | 739 | set file attributes like ownership. Security model is mandatory only |
M. Mohan Kumar | f67e3ff | 2011-12-14 13:58:46 +0530 | [diff] [blame] | 740 | for local fsdriver. Other fsdrivers (like handle, proxy) don't take security |
M. Mohan Kumar | d9b36a6 | 2011-10-14 12:59:37 +0530 | [diff] [blame] | 741 | model as a parameter. |
Aneesh Kumar K.V | 7c92a3d | 2011-10-12 19:11:24 +0530 | [diff] [blame] | 742 | @item writeout=@var{writeout} |
| 743 | This is an optional argument. The only supported value is "immediate". |
| 744 | This means that host page cache will be used to read and write data but |
| 745 | write notification will be sent to the guest only when the data has been |
| 746 | reported as written by the storage subsystem. |
M. Mohan Kumar | 2c74c2c | 2011-10-25 12:10:39 +0530 | [diff] [blame] | 747 | @item readonly |
| 748 | Enables exporting 9p share as a readonly mount for guests. By default |
| 749 | read-write access is given. |
M. Mohan Kumar | 84a87cc | 2011-12-14 13:58:47 +0530 | [diff] [blame] | 750 | @item socket=@var{socket} |
| 751 | Enables proxy filesystem driver to use passed socket file for |
| 752 | communicating with virtfs-proxy-helper. Usually a helper like libvirt |
| 753 | will create socketpair and pass one of the fds as sock_fd |
M. Mohan Kumar | f67e3ff | 2011-12-14 13:58:46 +0530 | [diff] [blame] | 754 | @item sock_fd |
| 755 | Enables proxy filesystem driver to use passed 'sock_fd' as the socket |
| 756 | descriptor for interfacing with virtfs-proxy-helper |
Gautham R Shenoy | 3d54abc | 2010-04-29 17:45:03 +0530 | [diff] [blame] | 757 | @end table |
| 758 | ETEXI |
Gautham R Shenoy | 3d54abc | 2010-04-29 17:45:03 +0530 | [diff] [blame] | 759 | |
Aneesh Kumar K.V | 9db221a | 2011-10-25 12:10:40 +0530 | [diff] [blame] | 760 | DEF("virtfs_synth", 0, QEMU_OPTION_virtfs_synth, |
| 761 | "-virtfs_synth Create synthetic file system image\n", |
| 762 | QEMU_ARCH_ALL) |
| 763 | STEXI |
| 764 | @item -virtfs_synth |
| 765 | @findex -virtfs_synth |
| 766 | Create synthetic file system image |
| 767 | ETEXI |
| 768 | |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 769 | STEXI |
| 770 | @end table |
| 771 | ETEXI |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 772 | DEFHEADING() |
| 773 | |
Markus Armbruster | 10adb8b | 2013-02-13 19:49:43 +0100 | [diff] [blame] | 774 | DEFHEADING(USB options:) |
| 775 | STEXI |
| 776 | @table @option |
| 777 | ETEXI |
| 778 | |
| 779 | DEF("usb", 0, QEMU_OPTION_usb, |
| 780 | "-usb enable the USB driver (will be the default soon)\n", |
| 781 | QEMU_ARCH_ALL) |
| 782 | STEXI |
| 783 | @item -usb |
| 784 | @findex -usb |
| 785 | Enable the USB driver (will be the default soon) |
| 786 | ETEXI |
| 787 | |
| 788 | DEF("usbdevice", HAS_ARG, QEMU_OPTION_usbdevice, |
| 789 | "-usbdevice name add the host or guest USB device 'name'\n", |
| 790 | QEMU_ARCH_ALL) |
| 791 | STEXI |
| 792 | |
| 793 | @item -usbdevice @var{devname} |
| 794 | @findex -usbdevice |
| 795 | Add the USB device @var{devname}. @xref{usb_devices}. |
| 796 | |
| 797 | @table @option |
| 798 | |
| 799 | @item mouse |
| 800 | Virtual Mouse. This will override the PS/2 mouse emulation when activated. |
| 801 | |
| 802 | @item tablet |
| 803 | Pointer device that uses absolute coordinates (like a touchscreen). This |
| 804 | means QEMU is able to report the mouse position without having to grab the |
| 805 | mouse. Also overrides the PS/2 mouse emulation when activated. |
| 806 | |
| 807 | @item disk:[format=@var{format}]:@var{file} |
| 808 | Mass storage device based on file. The optional @var{format} argument |
| 809 | will be used rather than detecting the format. Can be used to specifiy |
| 810 | @code{format=raw} to avoid interpreting an untrusted format header. |
| 811 | |
| 812 | @item host:@var{bus}.@var{addr} |
| 813 | Pass through the host device identified by @var{bus}.@var{addr} (Linux only). |
| 814 | |
| 815 | @item host:@var{vendor_id}:@var{product_id} |
| 816 | Pass through the host device identified by @var{vendor_id}:@var{product_id} |
| 817 | (Linux only). |
| 818 | |
| 819 | @item serial:[vendorid=@var{vendor_id}][,productid=@var{product_id}]:@var{dev} |
| 820 | Serial converter to host character device @var{dev}, see @code{-serial} for the |
| 821 | available devices. |
| 822 | |
| 823 | @item braille |
| 824 | Braille device. This will use BrlAPI to display the braille output on a real |
| 825 | or fake device. |
| 826 | |
| 827 | @item net:@var{options} |
| 828 | Network adapter that supports CDC ethernet and RNDIS protocols. |
| 829 | |
| 830 | @end table |
| 831 | ETEXI |
| 832 | |
| 833 | STEXI |
| 834 | @end table |
| 835 | ETEXI |
| 836 | DEFHEADING() |
| 837 | |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 838 | DEFHEADING(Display options:) |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 839 | STEXI |
| 840 | @table @option |
| 841 | ETEXI |
| 842 | |
Jes Sorensen | 1472a95 | 2011-03-16 13:33:31 +0100 | [diff] [blame] | 843 | DEF("display", HAS_ARG, QEMU_OPTION_display, |
| 844 | "-display sdl[,frame=on|off][,alt_grab=on|off][,ctrl_grab=on|off]\n" |
Jes Sorensen | 3264ff1 | 2011-03-16 13:33:33 +0100 | [diff] [blame] | 845 | " [,window_close=on|off]|curses|none|\n" |
Jan Kiszka | 881249c | 2014-03-12 08:33:50 +0100 | [diff] [blame] | 846 | " gtk[,grab_on_hover=on|off]|\n" |
Jes Sorensen | 3264ff1 | 2011-03-16 13:33:33 +0100 | [diff] [blame] | 847 | " vnc=<display>[,<optargs>]\n" |
Jes Sorensen | 1472a95 | 2011-03-16 13:33:31 +0100 | [diff] [blame] | 848 | " select display type\n", QEMU_ARCH_ALL) |
| 849 | STEXI |
| 850 | @item -display @var{type} |
| 851 | @findex -display |
| 852 | Select type of display to use. This option is a replacement for the |
| 853 | old style -sdl/-curses/... options. Valid values for @var{type} are |
| 854 | @table @option |
| 855 | @item sdl |
| 856 | Display video output via SDL (usually in a separate graphics |
| 857 | window; see the SDL documentation for other possibilities). |
| 858 | @item curses |
| 859 | Display video output via curses. For graphics device models which |
| 860 | support a text mode, QEMU can display this output using a |
| 861 | curses/ncurses interface. Nothing is displayed when the graphics |
| 862 | device is in graphical mode or if the graphics device does not support |
| 863 | a text mode. Generally only the VGA device models support text mode. |
Jes Sorensen | 4171d32 | 2011-03-16 13:33:32 +0100 | [diff] [blame] | 864 | @item none |
| 865 | Do not display video output. The guest will still see an emulated |
| 866 | graphics card, but its output will not be displayed to the QEMU |
| 867 | user. This option differs from the -nographic option in that it |
| 868 | only affects what is done with video output; -nographic also changes |
| 869 | the destination of the serial and parallel port data. |
Jan Kiszka | 881249c | 2014-03-12 08:33:50 +0100 | [diff] [blame] | 870 | @item gtk |
| 871 | Display video output in a GTK window. This interface provides drop-down |
| 872 | menus and other UI elements to configure and control the VM during |
| 873 | runtime. |
Jes Sorensen | 3264ff1 | 2011-03-16 13:33:33 +0100 | [diff] [blame] | 874 | @item vnc |
| 875 | Start a VNC server on display <arg> |
Jes Sorensen | 1472a95 | 2011-03-16 13:33:31 +0100 | [diff] [blame] | 876 | @end table |
| 877 | ETEXI |
| 878 | |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 879 | DEF("nographic", 0, QEMU_OPTION_nographic, |
Blue Swirl | ad96090 | 2010-03-29 19:23:52 +0000 | [diff] [blame] | 880 | "-nographic disable graphical output and redirect serial I/Os to console\n", |
| 881 | QEMU_ARCH_ALL) |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 882 | STEXI |
| 883 | @item -nographic |
Stefan Weil | 6616b2a | 2010-02-05 23:52:05 +0100 | [diff] [blame] | 884 | @findex -nographic |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 885 | Normally, QEMU uses SDL to display the VGA output. With this option, |
| 886 | you can totally disable graphical output so that QEMU is a simple |
| 887 | command line application. The emulated serial port is redirected on |
Paolo Bonzini | 02c4bdf | 2013-07-03 20:29:45 +0400 | [diff] [blame] | 888 | the console and muxed with the monitor (unless redirected elsewhere |
| 889 | explicitly). Therefore, you can still use QEMU to debug a Linux kernel |
Ramkumar Ramachandra | b031f41 | 2013-07-20 16:53:09 +0530 | [diff] [blame] | 890 | with a serial console. Use @key{C-a h} for help on switching between |
| 891 | the console and monitor. |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 892 | ETEXI |
| 893 | |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 894 | DEF("curses", 0, QEMU_OPTION_curses, |
Blue Swirl | ad96090 | 2010-03-29 19:23:52 +0000 | [diff] [blame] | 895 | "-curses use a curses/ncurses interface instead of SDL\n", |
| 896 | QEMU_ARCH_ALL) |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 897 | STEXI |
| 898 | @item -curses |
Markus Armbruster | b8f490e | 2013-02-13 19:49:38 +0100 | [diff] [blame] | 899 | @findex -curses |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 900 | Normally, QEMU uses SDL to display the VGA output. With this option, |
| 901 | QEMU can display the VGA output when in text mode using a |
| 902 | curses/ncurses interface. Nothing is displayed in graphical mode. |
| 903 | ETEXI |
| 904 | |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 905 | DEF("no-frame", 0, QEMU_OPTION_no_frame, |
Blue Swirl | ad96090 | 2010-03-29 19:23:52 +0000 | [diff] [blame] | 906 | "-no-frame open SDL window without a frame and window decorations\n", |
| 907 | QEMU_ARCH_ALL) |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 908 | STEXI |
| 909 | @item -no-frame |
Stefan Weil | 6616b2a | 2010-02-05 23:52:05 +0100 | [diff] [blame] | 910 | @findex -no-frame |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 911 | Do not use decorations for SDL windows and start them using the whole |
| 912 | available screen space. This makes the using QEMU in a dedicated desktop |
| 913 | workspace more convenient. |
| 914 | ETEXI |
| 915 | |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 916 | DEF("alt-grab", 0, QEMU_OPTION_alt_grab, |
Blue Swirl | ad96090 | 2010-03-29 19:23:52 +0000 | [diff] [blame] | 917 | "-alt-grab use Ctrl-Alt-Shift to grab mouse (instead of Ctrl-Alt)\n", |
| 918 | QEMU_ARCH_ALL) |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 919 | STEXI |
| 920 | @item -alt-grab |
Stefan Weil | 6616b2a | 2010-02-05 23:52:05 +0100 | [diff] [blame] | 921 | @findex -alt-grab |
Brad Hards | de1db2a | 2011-04-29 21:46:12 +1000 | [diff] [blame] | 922 | Use Ctrl-Alt-Shift to grab mouse (instead of Ctrl-Alt). Note that this also |
| 923 | affects the special keys (for fullscreen, monitor-mode switching, etc). |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 924 | ETEXI |
| 925 | |
Dustin Kirkland | 0ca9f8a | 2009-09-17 15:48:04 -0500 | [diff] [blame] | 926 | DEF("ctrl-grab", 0, QEMU_OPTION_ctrl_grab, |
Blue Swirl | ad96090 | 2010-03-29 19:23:52 +0000 | [diff] [blame] | 927 | "-ctrl-grab use Right-Ctrl to grab mouse (instead of Ctrl-Alt)\n", |
| 928 | QEMU_ARCH_ALL) |
Dustin Kirkland | 0ca9f8a | 2009-09-17 15:48:04 -0500 | [diff] [blame] | 929 | STEXI |
| 930 | @item -ctrl-grab |
Stefan Weil | 6616b2a | 2010-02-05 23:52:05 +0100 | [diff] [blame] | 931 | @findex -ctrl-grab |
Brad Hards | de1db2a | 2011-04-29 21:46:12 +1000 | [diff] [blame] | 932 | Use Right-Ctrl to grab mouse (instead of Ctrl-Alt). Note that this also |
| 933 | affects the special keys (for fullscreen, monitor-mode switching, etc). |
Dustin Kirkland | 0ca9f8a | 2009-09-17 15:48:04 -0500 | [diff] [blame] | 934 | ETEXI |
| 935 | |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 936 | DEF("no-quit", 0, QEMU_OPTION_no_quit, |
Blue Swirl | ad96090 | 2010-03-29 19:23:52 +0000 | [diff] [blame] | 937 | "-no-quit disable SDL window close capability\n", QEMU_ARCH_ALL) |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 938 | STEXI |
| 939 | @item -no-quit |
Stefan Weil | 6616b2a | 2010-02-05 23:52:05 +0100 | [diff] [blame] | 940 | @findex -no-quit |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 941 | Disable SDL window close capability. |
| 942 | ETEXI |
| 943 | |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 944 | DEF("sdl", 0, QEMU_OPTION_sdl, |
Blue Swirl | ad96090 | 2010-03-29 19:23:52 +0000 | [diff] [blame] | 945 | "-sdl enable SDL\n", QEMU_ARCH_ALL) |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 946 | STEXI |
| 947 | @item -sdl |
Stefan Weil | 6616b2a | 2010-02-05 23:52:05 +0100 | [diff] [blame] | 948 | @findex -sdl |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 949 | Enable SDL. |
| 950 | ETEXI |
| 951 | |
Gerd Hoffmann | 29b0040 | 2010-03-11 11:13:27 -0300 | [diff] [blame] | 952 | DEF("spice", HAS_ARG, QEMU_OPTION_spice, |
Yonit Halperin | 27af778 | 2012-08-21 13:54:20 +0300 | [diff] [blame] | 953 | "-spice [port=port][,tls-port=secured-port][,x509-dir=<dir>]\n" |
| 954 | " [,x509-key-file=<file>][,x509-key-password=<file>]\n" |
| 955 | " [,x509-cert-file=<file>][,x509-cacert-file=<file>]\n" |
| 956 | " [,x509-dh-key-file=<file>][,addr=addr][,ipv4|ipv6]\n" |
| 957 | " [,tls-ciphers=<list>]\n" |
| 958 | " [,tls-channel=[main|display|cursor|inputs|record|playback]]\n" |
| 959 | " [,plaintext-channel=[main|display|cursor|inputs|record|playback]]\n" |
| 960 | " [,sasl][,password=<secret>][,disable-ticketing]\n" |
| 961 | " [,image-compression=[auto_glz|auto_lz|quic|glz|lz|off]]\n" |
| 962 | " [,jpeg-wan-compression=[auto|never|always]]\n" |
| 963 | " [,zlib-glz-wan-compression=[auto|never|always]]\n" |
| 964 | " [,streaming-video=[off|all|filter]][,disable-copy-paste]\n" |
Hans de Goede | 5ad24e5 | 2013-06-08 15:37:27 +0200 | [diff] [blame] | 965 | " [,disable-agent-file-xfer][,agent-mouse=[on|off]]\n" |
| 966 | " [,playback-compression=[on|off]][,seamless-migration=[on|off]]\n" |
Yonit Halperin | 27af778 | 2012-08-21 13:54:20 +0300 | [diff] [blame] | 967 | " enable spice\n" |
| 968 | " at least one of {port, tls-port} is mandatory\n", |
| 969 | QEMU_ARCH_ALL) |
Gerd Hoffmann | 29b0040 | 2010-03-11 11:13:27 -0300 | [diff] [blame] | 970 | STEXI |
| 971 | @item -spice @var{option}[,@var{option}[,...]] |
| 972 | @findex -spice |
| 973 | Enable the spice remote desktop protocol. Valid options are |
| 974 | |
| 975 | @table @option |
| 976 | |
| 977 | @item port=<nr> |
Gerd Hoffmann | c448e85 | 2010-03-11 11:13:32 -0300 | [diff] [blame] | 978 | Set the TCP port spice is listening on for plaintext channels. |
Gerd Hoffmann | 29b0040 | 2010-03-11 11:13:27 -0300 | [diff] [blame] | 979 | |
Gerd Hoffmann | 333b0ee | 2010-08-27 14:29:16 +0200 | [diff] [blame] | 980 | @item addr=<addr> |
| 981 | Set the IP address spice is listening on. Default is any address. |
| 982 | |
| 983 | @item ipv4 |
| 984 | @item ipv6 |
| 985 | Force using the specified IP version. |
| 986 | |
Gerd Hoffmann | 29b0040 | 2010-03-11 11:13:27 -0300 | [diff] [blame] | 987 | @item password=<secret> |
| 988 | Set the password you need to authenticate. |
| 989 | |
Marc-André Lureau | 48b3ed0 | 2011-05-17 10:40:33 +0200 | [diff] [blame] | 990 | @item sasl |
| 991 | Require that the client use SASL to authenticate with the spice. |
| 992 | The exact choice of authentication method used is controlled from the |
| 993 | system / user's SASL configuration file for the 'qemu' service. This |
| 994 | is typically found in /etc/sasl2/qemu.conf. If running QEMU as an |
| 995 | unprivileged user, an environment variable SASL_CONF_PATH can be used |
| 996 | to make it search alternate locations for the service config. |
| 997 | While some SASL auth methods can also provide data encryption (eg GSSAPI), |
| 998 | it is recommended that SASL always be combined with the 'tls' and |
| 999 | 'x509' settings to enable use of SSL and server certificates. This |
| 1000 | ensures a data encryption preventing compromise of authentication |
| 1001 | credentials. |
| 1002 | |
Gerd Hoffmann | 29b0040 | 2010-03-11 11:13:27 -0300 | [diff] [blame] | 1003 | @item disable-ticketing |
| 1004 | Allow client connects without authentication. |
| 1005 | |
Hans de Goede | d4970b0 | 2011-03-27 16:43:54 +0200 | [diff] [blame] | 1006 | @item disable-copy-paste |
| 1007 | Disable copy paste between the client and the guest. |
| 1008 | |
Hans de Goede | 5ad24e5 | 2013-06-08 15:37:27 +0200 | [diff] [blame] | 1009 | @item disable-agent-file-xfer |
| 1010 | Disable spice-vdagent based file-xfer between the client and the guest. |
| 1011 | |
Gerd Hoffmann | c448e85 | 2010-03-11 11:13:32 -0300 | [diff] [blame] | 1012 | @item tls-port=<nr> |
| 1013 | Set the TCP port spice is listening on for encrypted channels. |
| 1014 | |
| 1015 | @item x509-dir=<dir> |
| 1016 | Set the x509 file directory. Expects same filenames as -vnc $display,x509=$dir |
| 1017 | |
| 1018 | @item x509-key-file=<file> |
| 1019 | @item x509-key-password=<file> |
| 1020 | @item x509-cert-file=<file> |
| 1021 | @item x509-cacert-file=<file> |
| 1022 | @item x509-dh-key-file=<file> |
| 1023 | The x509 file names can also be configured individually. |
| 1024 | |
| 1025 | @item tls-ciphers=<list> |
| 1026 | Specify which ciphers to use. |
| 1027 | |
Alon Levy | d70d6b3 | 2011-12-20 13:05:18 +0200 | [diff] [blame] | 1028 | @item tls-channel=[main|display|cursor|inputs|record|playback] |
| 1029 | @item plaintext-channel=[main|display|cursor|inputs|record|playback] |
Gerd Hoffmann | 17b6dea | 2010-08-27 14:09:56 +0200 | [diff] [blame] | 1030 | Force specific channel to be used with or without TLS encryption. The |
| 1031 | options can be specified multiple times to configure multiple |
| 1032 | channels. The special name "default" can be used to set the default |
| 1033 | mode. For channels which are not explicitly forced into one mode the |
| 1034 | spice client is allowed to pick tls/plaintext as he pleases. |
| 1035 | |
Yonit Halperin | 9f04e09 | 2010-07-14 13:26:34 +0300 | [diff] [blame] | 1036 | @item image-compression=[auto_glz|auto_lz|quic|glz|lz|off] |
| 1037 | Configure image compression (lossless). |
| 1038 | Default is auto_glz. |
| 1039 | |
| 1040 | @item jpeg-wan-compression=[auto|never|always] |
| 1041 | @item zlib-glz-wan-compression=[auto|never|always] |
| 1042 | Configure wan image compression (lossy for slow links). |
| 1043 | Default is auto. |
| 1044 | |
Gerd Hoffmann | 84a23f2 | 2010-08-30 16:36:53 +0200 | [diff] [blame] | 1045 | @item streaming-video=[off|all|filter] |
| 1046 | Configure video stream detection. Default is filter. |
| 1047 | |
| 1048 | @item agent-mouse=[on|off] |
| 1049 | Enable/disable passing mouse events via vdagent. Default is on. |
| 1050 | |
| 1051 | @item playback-compression=[on|off] |
| 1052 | Enable/disable audio stream compression (using celt 0.5.1). Default is on. |
| 1053 | |
Yonit Halperin | 8c95705 | 2012-08-21 11:51:59 +0300 | [diff] [blame] | 1054 | @item seamless-migration=[on|off] |
| 1055 | Enable/disable spice seamless migration. Default is off. |
| 1056 | |
Gerd Hoffmann | 29b0040 | 2010-03-11 11:13:27 -0300 | [diff] [blame] | 1057 | @end table |
| 1058 | ETEXI |
| 1059 | |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 1060 | DEF("portrait", 0, QEMU_OPTION_portrait, |
Blue Swirl | ad96090 | 2010-03-29 19:23:52 +0000 | [diff] [blame] | 1061 | "-portrait rotate graphical output 90 deg left (only PXA LCD)\n", |
| 1062 | QEMU_ARCH_ALL) |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 1063 | STEXI |
| 1064 | @item -portrait |
Stefan Weil | 6616b2a | 2010-02-05 23:52:05 +0100 | [diff] [blame] | 1065 | @findex -portrait |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 1066 | Rotate graphical output 90 deg left (only PXA LCD). |
| 1067 | ETEXI |
| 1068 | |
Vasily Khoruzhick | 9312805 | 2011-06-17 13:04:36 +0300 | [diff] [blame] | 1069 | DEF("rotate", HAS_ARG, QEMU_OPTION_rotate, |
| 1070 | "-rotate <deg> rotate graphical output some deg left (only PXA LCD)\n", |
| 1071 | QEMU_ARCH_ALL) |
| 1072 | STEXI |
Markus Armbruster | 6265c43 | 2013-02-13 19:49:39 +0100 | [diff] [blame] | 1073 | @item -rotate @var{deg} |
Vasily Khoruzhick | 9312805 | 2011-06-17 13:04:36 +0300 | [diff] [blame] | 1074 | @findex -rotate |
| 1075 | Rotate graphical output some deg left (only PXA LCD). |
| 1076 | ETEXI |
| 1077 | |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 1078 | DEF("vga", HAS_ARG, QEMU_OPTION_vga, |
Mark Cave-Ayland | 3363278 | 2014-03-17 21:46:25 +0000 | [diff] [blame] | 1079 | "-vga [std|cirrus|vmware|qxl|xenfb|tcx|cg3|none]\n" |
Blue Swirl | ad96090 | 2010-03-29 19:23:52 +0000 | [diff] [blame] | 1080 | " select video card type\n", QEMU_ARCH_ALL) |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 1081 | STEXI |
malc | e4558dc | 2012-08-27 18:33:21 +0400 | [diff] [blame] | 1082 | @item -vga @var{type} |
Stefan Weil | 6616b2a | 2010-02-05 23:52:05 +0100 | [diff] [blame] | 1083 | @findex -vga |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 1084 | Select type of VGA card to emulate. Valid values for @var{type} are |
Kevin Wolf | b3f046c | 2009-10-09 10:58:35 +0200 | [diff] [blame] | 1085 | @table @option |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 1086 | @item cirrus |
| 1087 | Cirrus Logic GD5446 Video card. All Windows versions starting from |
| 1088 | Windows 95 should recognize and use this graphic card. For optimal |
| 1089 | performances, use 16 bit color depth in the guest and the host OS. |
| 1090 | (This one is the default) |
| 1091 | @item std |
| 1092 | Standard VGA card with Bochs VBE extensions. If your guest OS |
| 1093 | supports the VESA 2.0 VBE extensions (e.g. Windows XP) and if you want |
| 1094 | to use high resolution modes (>= 1280x1024x16) then you should use |
| 1095 | this option. |
| 1096 | @item vmware |
| 1097 | VMWare SVGA-II compatible adapter. Use it if you have sufficiently |
| 1098 | recent XFree86/XOrg server or Windows guest with a driver for this |
| 1099 | card. |
Gerd Hoffmann | a19cbfb | 2010-04-27 11:50:11 +0200 | [diff] [blame] | 1100 | @item qxl |
| 1101 | QXL paravirtual graphic card. It is VGA compatible (including VESA |
| 1102 | 2.0 VBE support). Works best with qxl guest drivers installed though. |
| 1103 | Recommended choice when using the spice protocol. |
Mark Cave-Ayland | 3363278 | 2014-03-17 21:46:25 +0000 | [diff] [blame] | 1104 | @item tcx |
| 1105 | (sun4m only) Sun TCX framebuffer. This is the default framebuffer for |
| 1106 | sun4m machines and offers both 8-bit and 24-bit colour depths at a |
| 1107 | fixed resolution of 1024x768. |
| 1108 | @item cg3 |
| 1109 | (sun4m only) Sun cgthree framebuffer. This is a simple 8-bit framebuffer |
| 1110 | for sun4m machines available in both 1024x768 (OpenBIOS) and 1152x900 (OBP) |
| 1111 | resolutions aimed at people wishing to run older Solaris versions. |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 1112 | @item none |
| 1113 | Disable VGA card. |
| 1114 | @end table |
| 1115 | ETEXI |
| 1116 | |
| 1117 | DEF("full-screen", 0, QEMU_OPTION_full_screen, |
Blue Swirl | ad96090 | 2010-03-29 19:23:52 +0000 | [diff] [blame] | 1118 | "-full-screen start in full screen\n", QEMU_ARCH_ALL) |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 1119 | STEXI |
| 1120 | @item -full-screen |
Stefan Weil | 6616b2a | 2010-02-05 23:52:05 +0100 | [diff] [blame] | 1121 | @findex -full-screen |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 1122 | Start in full screen. |
| 1123 | ETEXI |
| 1124 | |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 1125 | DEF("g", 1, QEMU_OPTION_g , |
Blue Swirl | ad96090 | 2010-03-29 19:23:52 +0000 | [diff] [blame] | 1126 | "-g WxH[xDEPTH] Set the initial graphical resolution and depth\n", |
| 1127 | QEMU_ARCH_PPC | QEMU_ARCH_SPARC) |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 1128 | STEXI |
Stefan Weil | 95d5f08 | 2010-01-20 22:25:27 +0100 | [diff] [blame] | 1129 | @item -g @var{width}x@var{height}[x@var{depth}] |
Stefan Weil | 6616b2a | 2010-02-05 23:52:05 +0100 | [diff] [blame] | 1130 | @findex -g |
Stefan Weil | 95d5f08 | 2010-01-20 22:25:27 +0100 | [diff] [blame] | 1131 | Set the initial graphical resolution and depth (PPC, SPARC only). |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 1132 | ETEXI |
| 1133 | |
| 1134 | DEF("vnc", HAS_ARG, QEMU_OPTION_vnc , |
Blue Swirl | ad96090 | 2010-03-29 19:23:52 +0000 | [diff] [blame] | 1135 | "-vnc display start a VNC server on display\n", QEMU_ARCH_ALL) |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 1136 | STEXI |
| 1137 | @item -vnc @var{display}[,@var{option}[,@var{option}[,...]]] |
Stefan Weil | 6616b2a | 2010-02-05 23:52:05 +0100 | [diff] [blame] | 1138 | @findex -vnc |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 1139 | Normally, QEMU uses SDL to display the VGA output. With this option, |
| 1140 | you can have QEMU listen on VNC display @var{display} and redirect the VGA |
| 1141 | display over the VNC session. It is very useful to enable the usb |
| 1142 | tablet device when using this option (option @option{-usbdevice |
| 1143 | tablet}). When using the VNC display, you must use the @option{-k} |
| 1144 | parameter to set the keyboard layout if you are not using en-us. Valid |
| 1145 | syntax for the @var{display} is |
| 1146 | |
Kevin Wolf | b3f046c | 2009-10-09 10:58:35 +0200 | [diff] [blame] | 1147 | @table @option |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 1148 | |
| 1149 | @item @var{host}:@var{d} |
| 1150 | |
| 1151 | TCP connections will only be allowed from @var{host} on display @var{d}. |
| 1152 | By convention the TCP port is 5900+@var{d}. Optionally, @var{host} can |
| 1153 | be omitted in which case the server will accept connections from any host. |
| 1154 | |
Kevin Wolf | 4e257e5 | 2009-10-09 10:58:36 +0200 | [diff] [blame] | 1155 | @item unix:@var{path} |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 1156 | |
| 1157 | Connections will be allowed over UNIX domain sockets where @var{path} is the |
| 1158 | location of a unix socket to listen for connections on. |
| 1159 | |
| 1160 | @item none |
| 1161 | |
| 1162 | VNC is initialized but not started. The monitor @code{change} command |
| 1163 | can be used to later start the VNC server. |
| 1164 | |
| 1165 | @end table |
| 1166 | |
| 1167 | Following the @var{display} value there may be one or more @var{option} flags |
| 1168 | separated by commas. Valid options are |
| 1169 | |
Kevin Wolf | b3f046c | 2009-10-09 10:58:35 +0200 | [diff] [blame] | 1170 | @table @option |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 1171 | |
| 1172 | @item reverse |
| 1173 | |
| 1174 | Connect to a listening VNC client via a ``reverse'' connection. The |
| 1175 | client is specified by the @var{display}. For reverse network |
| 1176 | connections (@var{host}:@var{d},@code{reverse}), the @var{d} argument |
| 1177 | is a TCP port number, not a display number. |
| 1178 | |
Tim Hardeck | 7536ee4 | 2013-01-21 11:04:44 +0100 | [diff] [blame] | 1179 | @item websocket |
| 1180 | |
| 1181 | Opens an additional TCP listening port dedicated to VNC Websocket connections. |
Peter Maydell | 085d813 | 2013-03-18 17:20:07 +0000 | [diff] [blame] | 1182 | By definition the Websocket port is 5700+@var{display}. If @var{host} is |
Tim Hardeck | 7536ee4 | 2013-01-21 11:04:44 +0100 | [diff] [blame] | 1183 | specified connections will only be allowed from this host. |
| 1184 | As an alternative the Websocket port could be specified by using |
| 1185 | @code{websocket}=@var{port}. |
Tim Hardeck | 0057a0d | 2013-04-23 16:33:01 +0200 | [diff] [blame] | 1186 | TLS encryption for the Websocket connection is supported if the required |
| 1187 | certificates are specified with the VNC option @option{x509}. |
Tim Hardeck | 7536ee4 | 2013-01-21 11:04:44 +0100 | [diff] [blame] | 1188 | |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 1189 | @item password |
| 1190 | |
| 1191 | Require that password based authentication is used for client connections. |
Michal Novotny | 86ee5bc | 2012-07-16 15:54:38 +0200 | [diff] [blame] | 1192 | |
| 1193 | The password must be set separately using the @code{set_password} command in |
| 1194 | the @ref{pcsys_monitor}. The syntax to change your password is: |
| 1195 | @code{set_password <protocol> <password>} where <protocol> could be either |
| 1196 | "vnc" or "spice". |
| 1197 | |
| 1198 | If you would like to change <protocol> password expiration, you should use |
| 1199 | @code{expire_password <protocol> <expiration-time>} where expiration time could |
| 1200 | be one of the following options: now, never, +seconds or UNIX time of |
| 1201 | expiration, e.g. +60 to make password expire in 60 seconds, or 1335196800 |
| 1202 | to make password expire on "Mon Apr 23 12:00:00 EDT 2012" (UNIX time for this |
| 1203 | date and time). |
| 1204 | |
| 1205 | You can also use keywords "now" or "never" for the expiration time to |
| 1206 | allow <protocol> password to expire immediately or never expire. |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 1207 | |
| 1208 | @item tls |
| 1209 | |
| 1210 | Require that client use TLS when communicating with the VNC server. This |
| 1211 | uses anonymous TLS credentials so is susceptible to a man-in-the-middle |
| 1212 | attack. It is recommended that this option be combined with either the |
Kevin Wolf | 4e257e5 | 2009-10-09 10:58:36 +0200 | [diff] [blame] | 1213 | @option{x509} or @option{x509verify} options. |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 1214 | |
| 1215 | @item x509=@var{/path/to/certificate/dir} |
| 1216 | |
| 1217 | Valid if @option{tls} is specified. Require that x509 credentials are used |
| 1218 | for negotiating the TLS session. The server will send its x509 certificate |
| 1219 | to the client. It is recommended that a password be set on the VNC server |
| 1220 | to provide authentication of the client when this is used. The path following |
| 1221 | this option specifies where the x509 certificates are to be loaded from. |
| 1222 | See the @ref{vnc_security} section for details on generating certificates. |
| 1223 | |
| 1224 | @item x509verify=@var{/path/to/certificate/dir} |
| 1225 | |
| 1226 | Valid if @option{tls} is specified. Require that x509 credentials are used |
| 1227 | for negotiating the TLS session. The server will send its x509 certificate |
| 1228 | to the client, and request that the client send its own x509 certificate. |
| 1229 | The server will validate the client's certificate against the CA certificate, |
| 1230 | and reject clients when validation fails. If the certificate authority is |
| 1231 | trusted, this is a sufficient authentication mechanism. You may still wish |
| 1232 | to set a password on the VNC server as a second authentication layer. The |
| 1233 | path following this option specifies where the x509 certificates are to |
| 1234 | be loaded from. See the @ref{vnc_security} section for details on generating |
| 1235 | certificates. |
| 1236 | |
| 1237 | @item sasl |
| 1238 | |
| 1239 | Require that the client use SASL to authenticate with the VNC server. |
| 1240 | The exact choice of authentication method used is controlled from the |
| 1241 | system / user's SASL configuration file for the 'qemu' service. This |
| 1242 | is typically found in /etc/sasl2/qemu.conf. If running QEMU as an |
| 1243 | unprivileged user, an environment variable SASL_CONF_PATH can be used |
| 1244 | to make it search alternate locations for the service config. |
| 1245 | While some SASL auth methods can also provide data encryption (eg GSSAPI), |
| 1246 | it is recommended that SASL always be combined with the 'tls' and |
| 1247 | 'x509' settings to enable use of SSL and server certificates. This |
| 1248 | ensures a data encryption preventing compromise of authentication |
| 1249 | credentials. See the @ref{vnc_security} section for details on using |
| 1250 | SASL authentication. |
| 1251 | |
| 1252 | @item acl |
| 1253 | |
| 1254 | Turn on access control lists for checking of the x509 client certificate |
| 1255 | and SASL party. For x509 certs, the ACL check is made against the |
| 1256 | certificate's distinguished name. This is something that looks like |
| 1257 | @code{C=GB,O=ACME,L=Boston,CN=bob}. For SASL party, the ACL check is |
| 1258 | made against the username, which depending on the SASL plugin, may |
| 1259 | include a realm component, eg @code{bob} or @code{bob@@EXAMPLE.COM}. |
| 1260 | When the @option{acl} flag is set, the initial access list will be |
| 1261 | empty, with a @code{deny} policy. Thus no one will be allowed to |
| 1262 | use the VNC server until the ACLs have been loaded. This can be |
| 1263 | achieved using the @code{acl} monitor command. |
| 1264 | |
Corentin Chary | 6f9c78c | 2010-07-07 20:57:51 +0200 | [diff] [blame] | 1265 | @item lossy |
| 1266 | |
| 1267 | Enable lossy compression methods (gradient, JPEG, ...). If this |
| 1268 | option is set, VNC client may receive lossy framebuffer updates |
| 1269 | depending on its encoding settings. Enabling this option can save |
| 1270 | a lot of bandwidth at the expense of quality. |
| 1271 | |
Corentin Chary | 80e0c8c | 2011-02-04 09:06:08 +0100 | [diff] [blame] | 1272 | @item non-adaptive |
| 1273 | |
| 1274 | Disable adaptive encodings. Adaptive encodings are enabled by default. |
| 1275 | An adaptive encoding will try to detect frequently updated screen regions, |
| 1276 | and send updates in these regions using a lossy encoding (like JPEG). |
Stefan Weil | 61cc870 | 2011-04-13 22:45:22 +0200 | [diff] [blame] | 1277 | This can be really helpful to save bandwidth when playing videos. Disabling |
Michael Tokarev | 9d85d55 | 2014-04-07 13:34:58 +0400 | [diff] [blame] | 1278 | adaptive encodings restores the original static behavior of encodings |
Corentin Chary | 80e0c8c | 2011-02-04 09:06:08 +0100 | [diff] [blame] | 1279 | like Tight. |
| 1280 | |
Gerd Hoffmann | 8cf3648 | 2011-11-24 18:10:49 +0100 | [diff] [blame] | 1281 | @item share=[allow-exclusive|force-shared|ignore] |
| 1282 | |
| 1283 | Set display sharing policy. 'allow-exclusive' allows clients to ask |
| 1284 | for exclusive access. As suggested by the rfb spec this is |
| 1285 | implemented by dropping other connections. Connecting multiple |
| 1286 | clients in parallel requires all clients asking for a shared session |
| 1287 | (vncviewer: -shared switch). This is the default. 'force-shared' |
| 1288 | disables exclusive client access. Useful for shared desktop sessions, |
| 1289 | where you don't want someone forgetting specify -shared disconnect |
| 1290 | everybody else. 'ignore' completely ignores the shared flag and |
| 1291 | allows everybody connect unconditionally. Doesn't conform to the rfb |
Stefan Weil | b65ee4f | 2012-05-11 22:25:50 +0200 | [diff] [blame] | 1292 | spec but is traditional QEMU behavior. |
Gerd Hoffmann | 8cf3648 | 2011-11-24 18:10:49 +0100 | [diff] [blame] | 1293 | |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 1294 | @end table |
| 1295 | ETEXI |
| 1296 | |
| 1297 | STEXI |
| 1298 | @end table |
| 1299 | ETEXI |
Michael Ellerman | a3adb7a | 2011-12-19 17:19:31 +1100 | [diff] [blame] | 1300 | ARCHHEADING(, QEMU_ARCH_I386) |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 1301 | |
Michael Ellerman | a3adb7a | 2011-12-19 17:19:31 +1100 | [diff] [blame] | 1302 | ARCHHEADING(i386 target only:, QEMU_ARCH_I386) |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 1303 | STEXI |
| 1304 | @table @option |
| 1305 | ETEXI |
| 1306 | |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 1307 | DEF("win2k-hack", 0, QEMU_OPTION_win2k_hack, |
Blue Swirl | ad96090 | 2010-03-29 19:23:52 +0000 | [diff] [blame] | 1308 | "-win2k-hack use it when installing Windows 2000 to avoid a disk full bug\n", |
| 1309 | QEMU_ARCH_I386) |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 1310 | STEXI |
| 1311 | @item -win2k-hack |
Stefan Weil | 6616b2a | 2010-02-05 23:52:05 +0100 | [diff] [blame] | 1312 | @findex -win2k-hack |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 1313 | Use it when installing Windows 2000 to avoid a disk full bug. After |
| 1314 | Windows 2000 is installed, you no longer need this option (this option |
| 1315 | slows down the IDE transfers). |
| 1316 | ETEXI |
| 1317 | |
Jan Kiszka | 1ed2fc1 | 2009-09-15 13:36:04 +0200 | [diff] [blame] | 1318 | HXCOMM Deprecated by -rtc |
Blue Swirl | ad96090 | 2010-03-29 19:23:52 +0000 | [diff] [blame] | 1319 | DEF("rtc-td-hack", 0, QEMU_OPTION_rtc_td_hack, "", QEMU_ARCH_I386) |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 1320 | |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 1321 | DEF("no-fd-bootchk", 0, QEMU_OPTION_no_fd_bootchk, |
Blue Swirl | ad96090 | 2010-03-29 19:23:52 +0000 | [diff] [blame] | 1322 | "-no-fd-bootchk disable boot signature checking for floppy disks\n", |
| 1323 | QEMU_ARCH_I386) |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 1324 | STEXI |
| 1325 | @item -no-fd-bootchk |
Stefan Weil | 6616b2a | 2010-02-05 23:52:05 +0100 | [diff] [blame] | 1326 | @findex -no-fd-bootchk |
Markus Armbruster | 4eda32f | 2013-06-14 13:15:06 +0200 | [diff] [blame] | 1327 | Disable boot signature checking for floppy disks in BIOS. May |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 1328 | be needed to boot from old floppy disks. |
| 1329 | ETEXI |
| 1330 | |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 1331 | DEF("no-acpi", 0, QEMU_OPTION_no_acpi, |
Blue Swirl | ad96090 | 2010-03-29 19:23:52 +0000 | [diff] [blame] | 1332 | "-no-acpi disable ACPI\n", QEMU_ARCH_I386) |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 1333 | STEXI |
| 1334 | @item -no-acpi |
Stefan Weil | 6616b2a | 2010-02-05 23:52:05 +0100 | [diff] [blame] | 1335 | @findex -no-acpi |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 1336 | Disable ACPI (Advanced Configuration and Power Interface) support. Use |
| 1337 | it if your guest OS complains about ACPI problems (PC target machine |
| 1338 | only). |
| 1339 | ETEXI |
| 1340 | |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 1341 | DEF("no-hpet", 0, QEMU_OPTION_no_hpet, |
Blue Swirl | ad96090 | 2010-03-29 19:23:52 +0000 | [diff] [blame] | 1342 | "-no-hpet disable HPET\n", QEMU_ARCH_I386) |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 1343 | STEXI |
| 1344 | @item -no-hpet |
Stefan Weil | 6616b2a | 2010-02-05 23:52:05 +0100 | [diff] [blame] | 1345 | @findex -no-hpet |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 1346 | Disable HPET support. |
| 1347 | ETEXI |
| 1348 | |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 1349 | DEF("acpitable", HAS_ARG, QEMU_OPTION_acpitable, |
Michael Tokarev | 104bf02 | 2011-05-12 18:44:17 +0400 | [diff] [blame] | 1350 | "-acpitable [sig=str][,rev=n][,oem_id=str][,oem_table_id=str][,oem_rev=n][,asl_compiler_id=str][,asl_compiler_rev=n][,{data|file}=file1[:file2]...]\n" |
Blue Swirl | ad96090 | 2010-03-29 19:23:52 +0000 | [diff] [blame] | 1351 | " ACPI table description\n", QEMU_ARCH_I386) |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 1352 | STEXI |
| 1353 | @item -acpitable [sig=@var{str}][,rev=@var{n}][,oem_id=@var{str}][,oem_table_id=@var{str}][,oem_rev=@var{n}] [,asl_compiler_id=@var{str}][,asl_compiler_rev=@var{n}][,data=@var{file1}[:@var{file2}]...] |
Stefan Weil | 6616b2a | 2010-02-05 23:52:05 +0100 | [diff] [blame] | 1354 | @findex -acpitable |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 1355 | Add ACPI table with specified header fields and context from specified files. |
Michael Tokarev | 104bf02 | 2011-05-12 18:44:17 +0400 | [diff] [blame] | 1356 | For file=, take whole ACPI table from the specified files, including all |
| 1357 | ACPI headers (possible overridden by other options). |
| 1358 | For data=, only data |
| 1359 | portion of the table is used, all header information is specified in the |
| 1360 | command line. |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 1361 | ETEXI |
| 1362 | |
aliguori | b6f6e3d | 2009-04-17 18:59:56 +0000 | [diff] [blame] | 1363 | DEF("smbios", HAS_ARG, QEMU_OPTION_smbios, |
| 1364 | "-smbios file=binary\n" |
Bruce Rogers | ca1a8a0 | 2010-01-06 12:33:57 -0700 | [diff] [blame] | 1365 | " load SMBIOS entry from binary file\n" |
Gabriel L. Somlo | 8435184 | 2014-05-19 10:09:54 -0400 | [diff] [blame] | 1366 | "-smbios type=0[,vendor=str][,version=str][,date=str][,release=%d.%d][,uefi=on|off]\n" |
Bruce Rogers | ca1a8a0 | 2010-01-06 12:33:57 -0700 | [diff] [blame] | 1367 | " specify SMBIOS type 0 fields\n" |
aliguori | b6f6e3d | 2009-04-17 18:59:56 +0000 | [diff] [blame] | 1368 | "-smbios type=1[,manufacturer=str][,product=str][,version=str][,serial=str]\n" |
| 1369 | " [,uuid=uuid][,sku=str][,family=str]\n" |
Blue Swirl | ad96090 | 2010-03-29 19:23:52 +0000 | [diff] [blame] | 1370 | " specify SMBIOS type 1 fields\n", QEMU_ARCH_I386) |
aliguori | b6f6e3d | 2009-04-17 18:59:56 +0000 | [diff] [blame] | 1371 | STEXI |
| 1372 | @item -smbios file=@var{binary} |
Stefan Weil | 6616b2a | 2010-02-05 23:52:05 +0100 | [diff] [blame] | 1373 | @findex -smbios |
aliguori | b6f6e3d | 2009-04-17 18:59:56 +0000 | [diff] [blame] | 1374 | Load SMBIOS entry from binary file. |
| 1375 | |
Gabriel L. Somlo | 8435184 | 2014-05-19 10:09:54 -0400 | [diff] [blame] | 1376 | @item -smbios type=0[,vendor=@var{str}][,version=@var{str}][,date=@var{str}][,release=@var{%d.%d}][,uefi=on|off] |
aliguori | b6f6e3d | 2009-04-17 18:59:56 +0000 | [diff] [blame] | 1377 | Specify SMBIOS type 0 fields |
| 1378 | |
Blue Swirl | 609c1da | 2010-03-18 18:41:49 +0000 | [diff] [blame] | 1379 | @item -smbios type=1[,manufacturer=@var{str}][,product=@var{str}] [,version=@var{str}][,serial=@var{str}][,uuid=@var{uuid}][,sku=@var{str}] [,family=@var{str}] |
aliguori | b6f6e3d | 2009-04-17 18:59:56 +0000 | [diff] [blame] | 1380 | Specify SMBIOS type 1 fields |
| 1381 | ETEXI |
| 1382 | |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 1383 | STEXI |
| 1384 | @end table |
| 1385 | ETEXI |
Markus Armbruster | c70a01e | 2013-02-13 19:49:40 +0100 | [diff] [blame] | 1386 | DEFHEADING() |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 1387 | |
| 1388 | DEFHEADING(Network options:) |
| 1389 | STEXI |
| 1390 | @table @option |
| 1391 | ETEXI |
| 1392 | |
Jan Kiszka | ad196a9 | 2009-06-24 14:42:28 +0200 | [diff] [blame] | 1393 | HXCOMM Legacy slirp options (now moved to -net user): |
| 1394 | #ifdef CONFIG_SLIRP |
Blue Swirl | ad96090 | 2010-03-29 19:23:52 +0000 | [diff] [blame] | 1395 | DEF("tftp", HAS_ARG, QEMU_OPTION_tftp, "", QEMU_ARCH_ALL) |
| 1396 | DEF("bootp", HAS_ARG, QEMU_OPTION_bootp, "", QEMU_ARCH_ALL) |
| 1397 | DEF("redir", HAS_ARG, QEMU_OPTION_redir, "", QEMU_ARCH_ALL) |
Jan Kiszka | ad196a9 | 2009-06-24 14:42:28 +0200 | [diff] [blame] | 1398 | #ifndef _WIN32 |
Blue Swirl | ad96090 | 2010-03-29 19:23:52 +0000 | [diff] [blame] | 1399 | DEF("smb", HAS_ARG, QEMU_OPTION_smb, "", QEMU_ARCH_ALL) |
Jan Kiszka | ad196a9 | 2009-06-24 14:42:28 +0200 | [diff] [blame] | 1400 | #endif |
| 1401 | #endif |
| 1402 | |
Blue Swirl | bab7944 | 2009-06-09 21:50:02 +0300 | [diff] [blame] | 1403 | DEF("net", HAS_ARG, QEMU_OPTION_net, |
Michael S. Tsirkin | ffe6370 | 2009-06-21 19:51:18 +0300 | [diff] [blame] | 1404 | "-net nic[,vlan=n][,macaddr=mac][,model=type][,name=str][,addr=str][,vectors=v]\n" |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 1405 | " create a new Network Interface Card and connect it to VLAN 'n'\n" |
| 1406 | #ifdef CONFIG_SLIRP |
Jan Kiszka | c54ed5b | 2011-07-20 12:20:14 +0200 | [diff] [blame] | 1407 | "-net user[,vlan=n][,name=str][,net=addr[/mask]][,host=addr][,restrict=on|off]\n" |
Klaus Stengel | 63d2960 | 2012-10-27 19:53:39 +0200 | [diff] [blame] | 1408 | " [,hostname=host][,dhcpstart=addr][,dns=addr][,dnssearch=domain][,tftp=dir]\n" |
| 1409 | " [,bootfile=f][,hostfwd=rule][,guestfwd=rule]" |
Jan Kiszka | ad196a9 | 2009-06-24 14:42:28 +0200 | [diff] [blame] | 1410 | #ifndef _WIN32 |
Jan Kiszka | c92ef6a | 2009-06-24 14:42:28 +0200 | [diff] [blame] | 1411 | "[,smb=dir[,smbserver=addr]]\n" |
Jan Kiszka | ad196a9 | 2009-06-24 14:42:28 +0200 | [diff] [blame] | 1412 | #endif |
| 1413 | " connect the user mode network stack to VLAN 'n', configure its\n" |
| 1414 | " DHCP server and enabled optional services\n" |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 1415 | #endif |
| 1416 | #ifdef _WIN32 |
| 1417 | "-net tap[,vlan=n][,name=str],ifname=name\n" |
| 1418 | " connect the host TAP network interface to VLAN 'n'\n" |
| 1419 | #else |
Jason Wang | ec39601 | 2013-02-22 22:57:52 +0800 | [diff] [blame] | 1420 | "-net tap[,vlan=n][,name=str][,fd=h][,fds=x:y:...:z][,ifname=name][,script=file][,downscript=dfile][,helper=helper][,sndbuf=nbytes][,vnet_hdr=on|off][,vhost=on|off][,vhostfd=h][,vhostfds=x:y:...:z][,vhostforce=on|off][,queues=n]\n" |
Michal Privoznik | 3528a3c | 2012-11-23 09:52:39 +0100 | [diff] [blame] | 1421 | " connect the host TAP network interface to VLAN 'n'\n" |
Corey Bryant | a7c36ee | 2012-01-26 09:42:27 -0500 | [diff] [blame] | 1422 | " use network scripts 'file' (default=" DEFAULT_NETWORK_SCRIPT ")\n" |
| 1423 | " to configure it and 'dfile' (default=" DEFAULT_NETWORK_DOWN_SCRIPT ")\n" |
| 1424 | " to deconfigure it\n" |
Bruce Rogers | ca1a8a0 | 2010-01-06 12:33:57 -0700 | [diff] [blame] | 1425 | " use '[down]script=no' to disable script execution\n" |
Corey Bryant | a7c36ee | 2012-01-26 09:42:27 -0500 | [diff] [blame] | 1426 | " use network helper 'helper' (default=" DEFAULT_BRIDGE_HELPER ") to\n" |
| 1427 | " configure it\n" |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 1428 | " use 'fd=h' to connect to an already opened TAP interface\n" |
Jason Wang | 2ca81ba | 2013-02-20 18:04:01 +0800 | [diff] [blame] | 1429 | " use 'fds=x:y:...:z' to connect to already opened multiqueue capable TAP interfaces\n" |
Bruce Rogers | ca1a8a0 | 2010-01-06 12:33:57 -0700 | [diff] [blame] | 1430 | " use 'sndbuf=nbytes' to limit the size of the send buffer (the\n" |
Michael S. Tsirkin | f157ed2 | 2011-02-01 14:25:40 +0200 | [diff] [blame] | 1431 | " default is disabled 'sndbuf=0' to enable flow control set 'sndbuf=1048576')\n" |
Bruce Rogers | ca1a8a0 | 2010-01-06 12:33:57 -0700 | [diff] [blame] | 1432 | " use vnet_hdr=off to avoid enabling the IFF_VNET_HDR tap flag\n" |
| 1433 | " use vnet_hdr=on to make the lack of IFF_VNET_HDR support an error condition\n" |
Michael S. Tsirkin | 82b0d80 | 2010-03-17 13:08:24 +0200 | [diff] [blame] | 1434 | " use vhost=on to enable experimental in kernel accelerator\n" |
mst@redhat.com | 5430a28 | 2011-02-01 22:13:42 +0200 | [diff] [blame] | 1435 | " (only has effect for virtio guests which use MSIX)\n" |
| 1436 | " use vhostforce=on to force vhost on for non-MSIX virtio guests\n" |
Michael S. Tsirkin | 82b0d80 | 2010-03-17 13:08:24 +0200 | [diff] [blame] | 1437 | " use 'vhostfd=h' to connect to an already opened vhost net device\n" |
Jason Wang | 2ca81ba | 2013-02-20 18:04:01 +0800 | [diff] [blame] | 1438 | " use 'vhostfds=x:y:...:z to connect to multiple already opened vhost net devices\n" |
Jason Wang | ec39601 | 2013-02-22 22:57:52 +0800 | [diff] [blame] | 1439 | " use 'queues=n' to specify the number of queues to be created for multiqueue TAP\n" |
Corey Bryant | a7c36ee | 2012-01-26 09:42:27 -0500 | [diff] [blame] | 1440 | "-net bridge[,vlan=n][,name=str][,br=bridge][,helper=helper]\n" |
| 1441 | " connects a host TAP network interface to a host bridge device 'br'\n" |
| 1442 | " (default=" DEFAULT_BRIDGE_INTERFACE ") using the program 'helper'\n" |
| 1443 | " (default=" DEFAULT_BRIDGE_HELPER ")\n" |
Mark McLoughlin | 0df0ff6 | 2009-06-18 18:21:34 +0100 | [diff] [blame] | 1444 | #endif |
Anton Ivanov | 3fb69aa | 2014-06-20 10:34:41 +0100 | [diff] [blame] | 1445 | #ifdef __linux__ |
| 1446 | "-net l2tpv3[,vlan=n][,name=str],src=srcaddr,dst=dstaddr[,srcport=srcport][,dstport=dstport],txsession=txsession[,rxsession=rxsession][,ipv6=on/off][,udp=on/off][,cookie64=on/off][,counter][,pincounter][,txcookie=txcookie][,rxcookie=rxcookie][,offset=offset]\n" |
| 1447 | " connect the VLAN to an Ethernet over L2TPv3 pseudowire\n" |
| 1448 | " Linux kernel 3.3+ as well as most routers can talk\n" |
Michael Tokarev | 2f47b40 | 2014-07-24 20:10:17 +0400 | [diff] [blame] | 1449 | " L2TPv3. This transport allows connecting a VM to a VM,\n" |
Anton Ivanov | 3fb69aa | 2014-06-20 10:34:41 +0100 | [diff] [blame] | 1450 | " VM to a router and even VM to Host. It is a nearly-universal\n" |
| 1451 | " standard (RFC3391). Note - this implementation uses static\n" |
| 1452 | " pre-configured tunnels (same as the Linux kernel).\n" |
| 1453 | " use 'src=' to specify source address\n" |
| 1454 | " use 'dst=' to specify destination address\n" |
| 1455 | " use 'udp=on' to specify udp encapsulation\n" |
Gonglei | 3952651 | 2014-08-14 14:35:48 +0800 | [diff] [blame] | 1456 | " use 'srcport=' to specify source udp port\n" |
Anton Ivanov | 3fb69aa | 2014-06-20 10:34:41 +0100 | [diff] [blame] | 1457 | " use 'dstport=' to specify destination udp port\n" |
| 1458 | " use 'ipv6=on' to force v6\n" |
| 1459 | " L2TPv3 uses cookies to prevent misconfiguration as\n" |
| 1460 | " well as a weak security measure\n" |
| 1461 | " use 'rxcookie=0x012345678' to specify a rxcookie\n" |
| 1462 | " use 'txcookie=0x012345678' to specify a txcookie\n" |
| 1463 | " use 'cookie64=on' to set cookie size to 64 bit, otherwise 32\n" |
| 1464 | " use 'counter=off' to force a 'cut-down' L2TPv3 with no counter\n" |
| 1465 | " use 'pincounter=on' to work around broken counter handling in peer\n" |
| 1466 | " use 'offset=X' to add an extra offset between header and data\n" |
| 1467 | #endif |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 1468 | "-net socket[,vlan=n][,name=str][,fd=h][,listen=[host]:port][,connect=host:port]\n" |
| 1469 | " connect the vlan 'n' to another VLAN using a socket connection\n" |
Mike Ryan | 3a75e74 | 2010-12-01 11:16:47 -0800 | [diff] [blame] | 1470 | "-net socket[,vlan=n][,name=str][,fd=h][,mcast=maddr:port[,localaddr=addr]]\n" |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 1471 | " connect the vlan 'n' to multicast maddr and port\n" |
Mike Ryan | 3a75e74 | 2010-12-01 11:16:47 -0800 | [diff] [blame] | 1472 | " use 'localaddr=addr' to specify the host address to send packets from\n" |
Benjamin | 0e0e7fa | 2012-01-11 09:20:54 +0900 | [diff] [blame] | 1473 | "-net socket[,vlan=n][,name=str][,fd=h][,udp=host:port][,localaddr=host:port]\n" |
| 1474 | " connect the vlan 'n' to another VLAN using an UDP tunnel\n" |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 1475 | #ifdef CONFIG_VDE |
| 1476 | "-net vde[,vlan=n][,name=str][,sock=socketpath][,port=n][,group=groupname][,mode=octalmode]\n" |
| 1477 | " connect the vlan 'n' to port 'n' of a vde switch running\n" |
| 1478 | " on host and listening for incoming connections on 'socketpath'.\n" |
| 1479 | " Use group 'groupname' and mode 'octalmode' to change default\n" |
| 1480 | " ownership and permissions for communication port.\n" |
| 1481 | #endif |
Vincenzo Maffione | 5895213 | 2013-11-06 11:44:06 +0100 | [diff] [blame] | 1482 | #ifdef CONFIG_NETMAP |
| 1483 | "-net netmap,ifname=name[,devname=nmname]\n" |
| 1484 | " attach to the existing netmap-enabled network interface 'name', or to a\n" |
| 1485 | " VALE port (created on the fly) called 'name' ('nmname' is name of the \n" |
| 1486 | " netmap device, defaults to '/dev/netmap')\n" |
| 1487 | #endif |
aliguori | bb9ea79 | 2009-04-21 19:56:28 +0000 | [diff] [blame] | 1488 | "-net dump[,vlan=n][,file=f][,len=n]\n" |
| 1489 | " dump traffic on vlan 'n' to file 'f' (max n bytes per packet)\n" |
Bruce Rogers | ca1a8a0 | 2010-01-06 12:33:57 -0700 | [diff] [blame] | 1490 | "-net none use it alone to have zero network devices. If no -net option\n" |
Blue Swirl | ad96090 | 2010-03-29 19:23:52 +0000 | [diff] [blame] | 1491 | " is provided, the default is '-net nic -net user'\n", QEMU_ARCH_ALL) |
Mark McLoughlin | a1ea458 | 2009-10-08 19:58:26 +0100 | [diff] [blame] | 1492 | DEF("netdev", HAS_ARG, QEMU_OPTION_netdev, |
| 1493 | "-netdev [" |
| 1494 | #ifdef CONFIG_SLIRP |
| 1495 | "user|" |
| 1496 | #endif |
| 1497 | "tap|" |
Corey Bryant | a7c36ee | 2012-01-26 09:42:27 -0500 | [diff] [blame] | 1498 | "bridge|" |
Mark McLoughlin | a1ea458 | 2009-10-08 19:58:26 +0100 | [diff] [blame] | 1499 | #ifdef CONFIG_VDE |
| 1500 | "vde|" |
| 1501 | #endif |
Vincenzo Maffione | 5895213 | 2013-11-06 11:44:06 +0100 | [diff] [blame] | 1502 | #ifdef CONFIG_NETMAP |
| 1503 | "netmap|" |
| 1504 | #endif |
Nikolay Nikolaev | 03ce574 | 2014-06-10 13:02:16 +0300 | [diff] [blame] | 1505 | "vhost-user|" |
Stefan Hajnoczi | 40e8c26 | 2013-02-26 11:07:16 +0100 | [diff] [blame] | 1506 | "socket|" |
| 1507 | "hubport],id=str[,option][,option][,...]\n", QEMU_ARCH_ALL) |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 1508 | STEXI |
Blue Swirl | 609c1da | 2010-03-18 18:41:49 +0000 | [diff] [blame] | 1509 | @item -net nic[,vlan=@var{n}][,macaddr=@var{mac}][,model=@var{type}] [,name=@var{name}][,addr=@var{addr}][,vectors=@var{v}] |
Stefan Weil | 6616b2a | 2010-02-05 23:52:05 +0100 | [diff] [blame] | 1510 | @findex -net |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 1511 | Create a new Network Interface Card and connect it to VLAN @var{n} (@var{n} |
Anthony Liguori | 0d6b0b1 | 2009-08-14 11:20:47 -0500 | [diff] [blame] | 1512 | = 0 is the default). The NIC is an e1000 by default on the PC |
Markus Armbruster | 5607c38 | 2009-06-18 15:14:08 +0200 | [diff] [blame] | 1513 | target. Optionally, the MAC address can be changed to @var{mac}, the |
| 1514 | device address set to @var{addr} (PCI cards only), |
Michael S. Tsirkin | ffe6370 | 2009-06-21 19:51:18 +0300 | [diff] [blame] | 1515 | and a @var{name} can be assigned for use in monitor commands. |
| 1516 | Optionally, for PCI cards, you can specify the number @var{v} of MSI-X vectors |
| 1517 | that the card should have; this option currently only affects virtio cards; set |
| 1518 | @var{v} = 0 to disable MSI-X. If no @option{-net} option is specified, a single |
Stefan Weil | 071c939 | 2012-04-07 09:23:36 +0200 | [diff] [blame] | 1519 | NIC is created. QEMU can emulate several different models of network card. |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 1520 | Valid values for @var{type} are |
Michael S. Tsirkin | ffe6370 | 2009-06-21 19:51:18 +0300 | [diff] [blame] | 1521 | @code{virtio}, @code{i82551}, @code{i82557b}, @code{i82559er}, |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 1522 | @code{ne2k_pci}, @code{ne2k_isa}, @code{pcnet}, @code{rtl8139}, |
| 1523 | @code{e1000}, @code{smc91c111}, @code{lance} and @code{mcf_fec}. |
Peter Maydell | 585f603 | 2012-10-04 16:22:01 +0100 | [diff] [blame] | 1524 | Not all devices are supported on all targets. Use @code{-net nic,model=help} |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 1525 | for a list of available devices for your target. |
| 1526 | |
Stefan Hajnoczi | 08d1202 | 2012-08-14 14:14:27 +0100 | [diff] [blame] | 1527 | @item -netdev user,id=@var{id}[,@var{option}][,@var{option}][,...] |
Markus Armbruster | b8f490e | 2013-02-13 19:49:38 +0100 | [diff] [blame] | 1528 | @findex -netdev |
Jan Kiszka | ad196a9 | 2009-06-24 14:42:28 +0200 | [diff] [blame] | 1529 | @item -net user[,@var{option}][,@var{option}][,...] |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 1530 | Use the user mode network stack which requires no administrator |
Jan Kiszka | ad196a9 | 2009-06-24 14:42:28 +0200 | [diff] [blame] | 1531 | privilege to run. Valid options are: |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 1532 | |
Kevin Wolf | b3f046c | 2009-10-09 10:58:35 +0200 | [diff] [blame] | 1533 | @table @option |
Jan Kiszka | ad196a9 | 2009-06-24 14:42:28 +0200 | [diff] [blame] | 1534 | @item vlan=@var{n} |
| 1535 | Connect user mode stack to VLAN @var{n} (@var{n} = 0 is the default). |
| 1536 | |
Stefan Hajnoczi | 08d1202 | 2012-08-14 14:14:27 +0100 | [diff] [blame] | 1537 | @item id=@var{id} |
Jan Kiszka | ad196a9 | 2009-06-24 14:42:28 +0200 | [diff] [blame] | 1538 | @item name=@var{name} |
| 1539 | Assign symbolic name for use in monitor commands. |
| 1540 | |
Jan Kiszka | c92ef6a | 2009-06-24 14:42:28 +0200 | [diff] [blame] | 1541 | @item net=@var{addr}[/@var{mask}] |
| 1542 | Set IP network address the guest will see. Optionally specify the netmask, |
| 1543 | either in the form a.b.c.d or as number of valid top-most bits. Default is |
Brad Hards | b0b36e5 | 2011-04-24 17:19:56 +1000 | [diff] [blame] | 1544 | 10.0.2.0/24. |
Jan Kiszka | c92ef6a | 2009-06-24 14:42:28 +0200 | [diff] [blame] | 1545 | |
| 1546 | @item host=@var{addr} |
| 1547 | Specify the guest-visible address of the host. Default is the 2nd IP in the |
| 1548 | guest network, i.e. x.x.x.2. |
Jan Kiszka | ad196a9 | 2009-06-24 14:42:28 +0200 | [diff] [blame] | 1549 | |
Jan Kiszka | c54ed5b | 2011-07-20 12:20:14 +0200 | [diff] [blame] | 1550 | @item restrict=on|off |
Brad Hards | caef55e | 2011-06-09 07:50:43 +1000 | [diff] [blame] | 1551 | If this option is enabled, the guest will be isolated, i.e. it will not be |
Jan Kiszka | ad196a9 | 2009-06-24 14:42:28 +0200 | [diff] [blame] | 1552 | able to contact the host and no guest IP packets will be routed over the host |
Brad Hards | caef55e | 2011-06-09 07:50:43 +1000 | [diff] [blame] | 1553 | to the outside. This option does not affect any explicitly set forwarding rules. |
Jan Kiszka | ad196a9 | 2009-06-24 14:42:28 +0200 | [diff] [blame] | 1554 | |
| 1555 | @item hostname=@var{name} |
Klaus Stengel | 63d2960 | 2012-10-27 19:53:39 +0200 | [diff] [blame] | 1556 | Specifies the client hostname reported by the built-in DHCP server. |
Jan Kiszka | ad196a9 | 2009-06-24 14:42:28 +0200 | [diff] [blame] | 1557 | |
Jan Kiszka | c92ef6a | 2009-06-24 14:42:28 +0200 | [diff] [blame] | 1558 | @item dhcpstart=@var{addr} |
| 1559 | Specify the first of the 16 IPs the built-in DHCP server can assign. Default |
Brad Hards | b0b36e5 | 2011-04-24 17:19:56 +1000 | [diff] [blame] | 1560 | is the 15th to 31st IP in the guest network, i.e. x.x.x.15 to x.x.x.31. |
Jan Kiszka | c92ef6a | 2009-06-24 14:42:28 +0200 | [diff] [blame] | 1561 | |
| 1562 | @item dns=@var{addr} |
| 1563 | Specify the guest-visible address of the virtual nameserver. The address must |
| 1564 | be different from the host address. Default is the 3rd IP in the guest network, |
| 1565 | i.e. x.x.x.3. |
| 1566 | |
Klaus Stengel | 63d2960 | 2012-10-27 19:53:39 +0200 | [diff] [blame] | 1567 | @item dnssearch=@var{domain} |
| 1568 | Provides an entry for the domain-search list sent by the built-in |
| 1569 | DHCP server. More than one domain suffix can be transmitted by specifying |
| 1570 | this option multiple times. If supported, this will cause the guest to |
| 1571 | automatically try to append the given domain suffix(es) in case a domain name |
| 1572 | can not be resolved. |
| 1573 | |
| 1574 | Example: |
| 1575 | @example |
| 1576 | qemu -net user,dnssearch=mgmt.example.org,dnssearch=example.org [...] |
| 1577 | @end example |
| 1578 | |
Jan Kiszka | ad196a9 | 2009-06-24 14:42:28 +0200 | [diff] [blame] | 1579 | @item tftp=@var{dir} |
| 1580 | When using the user mode network stack, activate a built-in TFTP |
| 1581 | server. The files in @var{dir} will be exposed as the root of a TFTP server. |
| 1582 | The TFTP client on the guest must be configured in binary mode (use the command |
Jan Kiszka | c92ef6a | 2009-06-24 14:42:28 +0200 | [diff] [blame] | 1583 | @code{bin} of the Unix TFTP client). |
Jan Kiszka | ad196a9 | 2009-06-24 14:42:28 +0200 | [diff] [blame] | 1584 | |
| 1585 | @item bootfile=@var{file} |
| 1586 | When using the user mode network stack, broadcast @var{file} as the BOOTP |
| 1587 | filename. In conjunction with @option{tftp}, this can be used to network boot |
| 1588 | a guest from a local directory. |
| 1589 | |
| 1590 | Example (using pxelinux): |
| 1591 | @example |
Stefan Weil | 3804da9 | 2012-05-11 22:21:50 +0200 | [diff] [blame] | 1592 | qemu-system-i386 -hda linux.img -boot n -net user,tftp=/path/to/tftp/files,bootfile=/pxelinux.0 |
Jan Kiszka | ad196a9 | 2009-06-24 14:42:28 +0200 | [diff] [blame] | 1593 | @end example |
| 1594 | |
Jan Kiszka | c92ef6a | 2009-06-24 14:42:28 +0200 | [diff] [blame] | 1595 | @item smb=@var{dir}[,smbserver=@var{addr}] |
Jan Kiszka | ad196a9 | 2009-06-24 14:42:28 +0200 | [diff] [blame] | 1596 | When using the user mode network stack, activate a built-in SMB |
| 1597 | server so that Windows OSes can access to the host files in @file{@var{dir}} |
Jan Kiszka | c92ef6a | 2009-06-24 14:42:28 +0200 | [diff] [blame] | 1598 | transparently. The IP address of the SMB server can be set to @var{addr}. By |
| 1599 | default the 4th IP in the guest network is used, i.e. x.x.x.4. |
Jan Kiszka | ad196a9 | 2009-06-24 14:42:28 +0200 | [diff] [blame] | 1600 | |
| 1601 | In the guest Windows OS, the line: |
| 1602 | @example |
| 1603 | 10.0.2.4 smbserver |
| 1604 | @end example |
| 1605 | must be added in the file @file{C:\WINDOWS\LMHOSTS} (for windows 9x/Me) |
| 1606 | or @file{C:\WINNT\SYSTEM32\DRIVERS\ETC\LMHOSTS} (Windows NT/2000). |
| 1607 | |
| 1608 | Then @file{@var{dir}} can be accessed in @file{\\smbserver\qemu}. |
| 1609 | |
Brad | e2d8830 | 2011-09-02 16:53:28 -0400 | [diff] [blame] | 1610 | Note that a SAMBA server must be installed on the host OS. |
| 1611 | QEMU was tested successfully with smbd versions from Red Hat 9, |
| 1612 | Fedora Core 3 and OpenSUSE 11.x. |
Jan Kiszka | ad196a9 | 2009-06-24 14:42:28 +0200 | [diff] [blame] | 1613 | |
Jan Kiszka | 3c6a058 | 2009-06-24 14:42:28 +0200 | [diff] [blame] | 1614 | @item hostfwd=[tcp|udp]:[@var{hostaddr}]:@var{hostport}-[@var{guestaddr}]:@var{guestport} |
Jan Kiszka | c92ef6a | 2009-06-24 14:42:28 +0200 | [diff] [blame] | 1615 | Redirect incoming TCP or UDP connections to the host port @var{hostport} to |
| 1616 | the guest IP address @var{guestaddr} on guest port @var{guestport}. If |
| 1617 | @var{guestaddr} is not specified, its value is x.x.x.15 (default first address |
Jan Kiszka | 3c6a058 | 2009-06-24 14:42:28 +0200 | [diff] [blame] | 1618 | given by the built-in DHCP server). By specifying @var{hostaddr}, the rule can |
| 1619 | be bound to a specific host interface. If no connection type is set, TCP is |
Jan Kiszka | c92ef6a | 2009-06-24 14:42:28 +0200 | [diff] [blame] | 1620 | used. This option can be given multiple times. |
Jan Kiszka | ad196a9 | 2009-06-24 14:42:28 +0200 | [diff] [blame] | 1621 | |
| 1622 | For example, to redirect host X11 connection from screen 1 to guest |
| 1623 | screen 0, use the following: |
| 1624 | |
| 1625 | @example |
| 1626 | # on the host |
Stefan Weil | 3804da9 | 2012-05-11 22:21:50 +0200 | [diff] [blame] | 1627 | qemu-system-i386 -net user,hostfwd=tcp:127.0.0.1:6001-:6000 [...] |
Jan Kiszka | ad196a9 | 2009-06-24 14:42:28 +0200 | [diff] [blame] | 1628 | # this host xterm should open in the guest X11 server |
| 1629 | xterm -display :1 |
| 1630 | @end example |
| 1631 | |
| 1632 | To redirect telnet connections from host port 5555 to telnet port on |
| 1633 | the guest, use the following: |
| 1634 | |
| 1635 | @example |
| 1636 | # on the host |
Stefan Weil | 3804da9 | 2012-05-11 22:21:50 +0200 | [diff] [blame] | 1637 | qemu-system-i386 -net user,hostfwd=tcp::5555-:23 [...] |
Jan Kiszka | ad196a9 | 2009-06-24 14:42:28 +0200 | [diff] [blame] | 1638 | telnet localhost 5555 |
| 1639 | @end example |
| 1640 | |
| 1641 | Then when you use on the host @code{telnet localhost 5555}, you |
| 1642 | connect to the guest telnet server. |
| 1643 | |
Jan Kiszka | c92ef6a | 2009-06-24 14:42:28 +0200 | [diff] [blame] | 1644 | @item guestfwd=[tcp]:@var{server}:@var{port}-@var{dev} |
Alexander Graf | b412eb6 | 2012-06-03 09:45:01 +0200 | [diff] [blame] | 1645 | @item guestfwd=[tcp]:@var{server}:@var{port}-@var{cmd:command} |
Jan Kiszka | 3c6a058 | 2009-06-24 14:42:28 +0200 | [diff] [blame] | 1646 | Forward guest TCP connections to the IP address @var{server} on port @var{port} |
Alexander Graf | b412eb6 | 2012-06-03 09:45:01 +0200 | [diff] [blame] | 1647 | to the character device @var{dev} or to a program executed by @var{cmd:command} |
| 1648 | which gets spawned for each connection. This option can be given multiple times. |
| 1649 | |
Stefan Weil | 43ffe61 | 2012-07-20 23:26:02 +0200 | [diff] [blame] | 1650 | You can either use a chardev directly and have that one used throughout QEMU's |
Alexander Graf | b412eb6 | 2012-06-03 09:45:01 +0200 | [diff] [blame] | 1651 | lifetime, like in the following example: |
| 1652 | |
| 1653 | @example |
| 1654 | # open 10.10.1.1:4321 on bootup, connect 10.0.2.100:1234 to it whenever |
| 1655 | # the guest accesses it |
| 1656 | qemu -net user,guestfwd=tcp:10.0.2.100:1234-tcp:10.10.1.1:4321 [...] |
| 1657 | @end example |
| 1658 | |
| 1659 | Or you can execute a command on every TCP connection established by the guest, |
Stefan Weil | 43ffe61 | 2012-07-20 23:26:02 +0200 | [diff] [blame] | 1660 | so that QEMU behaves similar to an inetd process for that virtual server: |
Alexander Graf | b412eb6 | 2012-06-03 09:45:01 +0200 | [diff] [blame] | 1661 | |
| 1662 | @example |
| 1663 | # call "netcat 10.10.1.1 4321" on every TCP connection to 10.0.2.100:1234 |
| 1664 | # and connect the TCP stream to its stdin/stdout |
| 1665 | qemu -net 'user,guestfwd=tcp:10.0.2.100:1234-cmd:netcat 10.10.1.1 4321' |
| 1666 | @end example |
Jan Kiszka | ad196a9 | 2009-06-24 14:42:28 +0200 | [diff] [blame] | 1667 | |
| 1668 | @end table |
| 1669 | |
| 1670 | Note: Legacy stand-alone options -tftp, -bootp, -smb and -redir are still |
| 1671 | processed and applied to -net user. Mixing them with the new configuration |
| 1672 | syntax gives undefined results. Their use for new applications is discouraged |
| 1673 | as they will be removed from future versions. |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 1674 | |
Stefan Hajnoczi | 08d1202 | 2012-08-14 14:14:27 +0100 | [diff] [blame] | 1675 | @item -netdev tap,id=@var{id}[,fd=@var{h}][,ifname=@var{name}][,script=@var{file}][,downscript=@var{dfile}][,helper=@var{helper}] |
Corey Bryant | a7c36ee | 2012-01-26 09:42:27 -0500 | [diff] [blame] | 1676 | @item -net tap[,vlan=@var{n}][,name=@var{name}][,fd=@var{h}][,ifname=@var{name}][,script=@var{file}][,downscript=@var{dfile}][,helper=@var{helper}] |
| 1677 | Connect the host TAP network interface @var{name} to VLAN @var{n}. |
| 1678 | |
| 1679 | Use the network script @var{file} to configure it and the network script |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 1680 | @var{dfile} to deconfigure it. If @var{name} is not provided, the OS |
Corey Bryant | a7c36ee | 2012-01-26 09:42:27 -0500 | [diff] [blame] | 1681 | automatically provides one. The default network configure script is |
| 1682 | @file{/etc/qemu-ifup} and the default network deconfigure script is |
| 1683 | @file{/etc/qemu-ifdown}. Use @option{script=no} or @option{downscript=no} |
| 1684 | to disable script execution. |
| 1685 | |
| 1686 | If running QEMU as an unprivileged user, use the network helper |
| 1687 | @var{helper} to configure the TAP interface. The default network |
Amos Kong | 420508f | 2013-10-23 04:49:28 +0800 | [diff] [blame] | 1688 | helper executable is @file{/path/to/qemu-bridge-helper}. |
Corey Bryant | a7c36ee | 2012-01-26 09:42:27 -0500 | [diff] [blame] | 1689 | |
| 1690 | @option{fd}=@var{h} can be used to specify the handle of an already |
| 1691 | opened host TAP interface. |
| 1692 | |
| 1693 | Examples: |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 1694 | |
| 1695 | @example |
Corey Bryant | a7c36ee | 2012-01-26 09:42:27 -0500 | [diff] [blame] | 1696 | #launch a QEMU instance with the default network script |
Stefan Weil | 3804da9 | 2012-05-11 22:21:50 +0200 | [diff] [blame] | 1697 | qemu-system-i386 linux.img -net nic -net tap |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 1698 | @end example |
| 1699 | |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 1700 | @example |
Corey Bryant | a7c36ee | 2012-01-26 09:42:27 -0500 | [diff] [blame] | 1701 | #launch a QEMU instance with two NICs, each one connected |
| 1702 | #to a TAP device |
Stefan Weil | 3804da9 | 2012-05-11 22:21:50 +0200 | [diff] [blame] | 1703 | qemu-system-i386 linux.img \ |
| 1704 | -net nic,vlan=0 -net tap,vlan=0,ifname=tap0 \ |
| 1705 | -net nic,vlan=1 -net tap,vlan=1,ifname=tap1 |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 1706 | @end example |
| 1707 | |
Corey Bryant | a7c36ee | 2012-01-26 09:42:27 -0500 | [diff] [blame] | 1708 | @example |
| 1709 | #launch a QEMU instance with the default network helper to |
| 1710 | #connect a TAP device to bridge br0 |
Stefan Weil | 3804da9 | 2012-05-11 22:21:50 +0200 | [diff] [blame] | 1711 | qemu-system-i386 linux.img \ |
Amos Kong | 420508f | 2013-10-23 04:49:28 +0800 | [diff] [blame] | 1712 | -net nic -net tap,"helper=/path/to/qemu-bridge-helper" |
Corey Bryant | a7c36ee | 2012-01-26 09:42:27 -0500 | [diff] [blame] | 1713 | @end example |
| 1714 | |
Stefan Hajnoczi | 08d1202 | 2012-08-14 14:14:27 +0100 | [diff] [blame] | 1715 | @item -netdev bridge,id=@var{id}[,br=@var{bridge}][,helper=@var{helper}] |
Corey Bryant | a7c36ee | 2012-01-26 09:42:27 -0500 | [diff] [blame] | 1716 | @item -net bridge[,vlan=@var{n}][,name=@var{name}][,br=@var{bridge}][,helper=@var{helper}] |
| 1717 | Connect a host TAP network interface to a host bridge device. |
| 1718 | |
| 1719 | Use the network helper @var{helper} to configure the TAP interface and |
| 1720 | attach it to the bridge. The default network helper executable is |
Amos Kong | 420508f | 2013-10-23 04:49:28 +0800 | [diff] [blame] | 1721 | @file{/path/to/qemu-bridge-helper} and the default bridge |
Corey Bryant | a7c36ee | 2012-01-26 09:42:27 -0500 | [diff] [blame] | 1722 | device is @file{br0}. |
| 1723 | |
| 1724 | Examples: |
| 1725 | |
| 1726 | @example |
| 1727 | #launch a QEMU instance with the default network helper to |
| 1728 | #connect a TAP device to bridge br0 |
Stefan Weil | 3804da9 | 2012-05-11 22:21:50 +0200 | [diff] [blame] | 1729 | qemu-system-i386 linux.img -net bridge -net nic,model=virtio |
Corey Bryant | a7c36ee | 2012-01-26 09:42:27 -0500 | [diff] [blame] | 1730 | @end example |
| 1731 | |
| 1732 | @example |
| 1733 | #launch a QEMU instance with the default network helper to |
| 1734 | #connect a TAP device to bridge qemubr0 |
Stefan Weil | 3804da9 | 2012-05-11 22:21:50 +0200 | [diff] [blame] | 1735 | qemu-system-i386 linux.img -net bridge,br=qemubr0 -net nic,model=virtio |
Corey Bryant | a7c36ee | 2012-01-26 09:42:27 -0500 | [diff] [blame] | 1736 | @end example |
| 1737 | |
Stefan Hajnoczi | 08d1202 | 2012-08-14 14:14:27 +0100 | [diff] [blame] | 1738 | @item -netdev socket,id=@var{id}[,fd=@var{h}][,listen=[@var{host}]:@var{port}][,connect=@var{host}:@var{port}] |
Blue Swirl | 609c1da | 2010-03-18 18:41:49 +0000 | [diff] [blame] | 1739 | @item -net socket[,vlan=@var{n}][,name=@var{name}][,fd=@var{h}] [,listen=[@var{host}]:@var{port}][,connect=@var{host}:@var{port}] |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 1740 | |
| 1741 | Connect the VLAN @var{n} to a remote VLAN in another QEMU virtual |
| 1742 | machine using a TCP socket connection. If @option{listen} is |
| 1743 | specified, QEMU waits for incoming connections on @var{port} |
| 1744 | (@var{host} is optional). @option{connect} is used to connect to |
| 1745 | another QEMU instance using the @option{listen} option. @option{fd}=@var{h} |
| 1746 | specifies an already opened TCP socket. |
| 1747 | |
| 1748 | Example: |
| 1749 | @example |
| 1750 | # launch a first QEMU instance |
Stefan Weil | 3804da9 | 2012-05-11 22:21:50 +0200 | [diff] [blame] | 1751 | qemu-system-i386 linux.img \ |
| 1752 | -net nic,macaddr=52:54:00:12:34:56 \ |
| 1753 | -net socket,listen=:1234 |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 1754 | # connect the VLAN 0 of this instance to the VLAN 0 |
| 1755 | # of the first instance |
Stefan Weil | 3804da9 | 2012-05-11 22:21:50 +0200 | [diff] [blame] | 1756 | qemu-system-i386 linux.img \ |
| 1757 | -net nic,macaddr=52:54:00:12:34:57 \ |
| 1758 | -net socket,connect=127.0.0.1:1234 |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 1759 | @end example |
| 1760 | |
Stefan Hajnoczi | 08d1202 | 2012-08-14 14:14:27 +0100 | [diff] [blame] | 1761 | @item -netdev socket,id=@var{id}[,fd=@var{h}][,mcast=@var{maddr}:@var{port}[,localaddr=@var{addr}]] |
Mike Ryan | 3a75e74 | 2010-12-01 11:16:47 -0800 | [diff] [blame] | 1762 | @item -net socket[,vlan=@var{n}][,name=@var{name}][,fd=@var{h}][,mcast=@var{maddr}:@var{port}[,localaddr=@var{addr}]] |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 1763 | |
| 1764 | Create a VLAN @var{n} shared with another QEMU virtual |
| 1765 | machines using a UDP multicast socket, effectively making a bus for |
| 1766 | every QEMU with same multicast address @var{maddr} and @var{port}. |
| 1767 | NOTES: |
| 1768 | @enumerate |
| 1769 | @item |
| 1770 | Several QEMU can be running on different hosts and share same bus (assuming |
| 1771 | correct multicast setup for these hosts). |
| 1772 | @item |
| 1773 | mcast support is compatible with User Mode Linux (argument @option{eth@var{N}=mcast}), see |
| 1774 | @url{http://user-mode-linux.sf.net}. |
| 1775 | @item |
| 1776 | Use @option{fd=h} to specify an already opened UDP multicast socket. |
| 1777 | @end enumerate |
| 1778 | |
| 1779 | Example: |
| 1780 | @example |
| 1781 | # launch one QEMU instance |
Stefan Weil | 3804da9 | 2012-05-11 22:21:50 +0200 | [diff] [blame] | 1782 | qemu-system-i386 linux.img \ |
| 1783 | -net nic,macaddr=52:54:00:12:34:56 \ |
| 1784 | -net socket,mcast=230.0.0.1:1234 |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 1785 | # launch another QEMU instance on same "bus" |
Stefan Weil | 3804da9 | 2012-05-11 22:21:50 +0200 | [diff] [blame] | 1786 | qemu-system-i386 linux.img \ |
| 1787 | -net nic,macaddr=52:54:00:12:34:57 \ |
| 1788 | -net socket,mcast=230.0.0.1:1234 |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 1789 | # launch yet another QEMU instance on same "bus" |
Stefan Weil | 3804da9 | 2012-05-11 22:21:50 +0200 | [diff] [blame] | 1790 | qemu-system-i386 linux.img \ |
| 1791 | -net nic,macaddr=52:54:00:12:34:58 \ |
| 1792 | -net socket,mcast=230.0.0.1:1234 |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 1793 | @end example |
| 1794 | |
| 1795 | Example (User Mode Linux compat.): |
| 1796 | @example |
| 1797 | # launch QEMU instance (note mcast address selected |
| 1798 | # is UML's default) |
Stefan Weil | 3804da9 | 2012-05-11 22:21:50 +0200 | [diff] [blame] | 1799 | qemu-system-i386 linux.img \ |
| 1800 | -net nic,macaddr=52:54:00:12:34:56 \ |
| 1801 | -net socket,mcast=239.192.168.1:1102 |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 1802 | # launch UML |
| 1803 | /path/to/linux ubd0=/path/to/root_fs eth0=mcast |
| 1804 | @end example |
| 1805 | |
Mike Ryan | 3a75e74 | 2010-12-01 11:16:47 -0800 | [diff] [blame] | 1806 | Example (send packets from host's 1.2.3.4): |
| 1807 | @example |
Stefan Weil | 3804da9 | 2012-05-11 22:21:50 +0200 | [diff] [blame] | 1808 | qemu-system-i386 linux.img \ |
| 1809 | -net nic,macaddr=52:54:00:12:34:56 \ |
| 1810 | -net socket,mcast=239.192.168.1:1102,localaddr=1.2.3.4 |
Mike Ryan | 3a75e74 | 2010-12-01 11:16:47 -0800 | [diff] [blame] | 1811 | @end example |
| 1812 | |
Anton Ivanov | 3fb69aa | 2014-06-20 10:34:41 +0100 | [diff] [blame] | 1813 | @item -netdev l2tpv3,id=@var{id},src=@var{srcaddr},dst=@var{dstaddr}[,srcport=@var{srcport}][,dstport=@var{dstport}],txsession=@var{txsession}[,rxsession=@var{rxsession}][,ipv6][,udp][,cookie64][,counter][,pincounter][,txcookie=@var{txcookie}][,rxcookie=@var{rxcookie}][,offset=@var{offset}] |
| 1814 | @item -net l2tpv3[,vlan=@var{n}][,name=@var{name}],src=@var{srcaddr},dst=@var{dstaddr}[,srcport=@var{srcport}][,dstport=@var{dstport}],txsession=@var{txsession}[,rxsession=@var{rxsession}][,ipv6][,udp][,cookie64][,counter][,pincounter][,txcookie=@var{txcookie}][,rxcookie=@var{rxcookie}][,offset=@var{offset}] |
| 1815 | Connect VLAN @var{n} to L2TPv3 pseudowire. L2TPv3 (RFC3391) is a popular |
| 1816 | protocol to transport Ethernet (and other Layer 2) data frames between |
| 1817 | two systems. It is present in routers, firewalls and the Linux kernel |
| 1818 | (from version 3.3 onwards). |
| 1819 | |
| 1820 | This transport allows a VM to communicate to another VM, router or firewall directly. |
| 1821 | |
| 1822 | @item src=@var{srcaddr} |
| 1823 | source address (mandatory) |
| 1824 | @item dst=@var{dstaddr} |
| 1825 | destination address (mandatory) |
| 1826 | @item udp |
| 1827 | select udp encapsulation (default is ip). |
| 1828 | @item srcport=@var{srcport} |
| 1829 | source udp port. |
| 1830 | @item dstport=@var{dstport} |
| 1831 | destination udp port. |
| 1832 | @item ipv6 |
| 1833 | force v6, otherwise defaults to v4. |
| 1834 | @item rxcookie=@var{rxcookie} |
| 1835 | @item txcookie=@var{txcookie} |
| 1836 | Cookies are a weak form of security in the l2tpv3 specification. |
| 1837 | Their function is mostly to prevent misconfiguration. By default they are 32 |
| 1838 | bit. |
| 1839 | @item cookie64 |
| 1840 | Set cookie size to 64 bit instead of the default 32 |
| 1841 | @item counter=off |
| 1842 | Force a 'cut-down' L2TPv3 with no counter as in |
| 1843 | draft-mkonstan-l2tpext-keyed-ipv6-tunnel-00 |
| 1844 | @item pincounter=on |
| 1845 | Work around broken counter handling in peer. This may also help on |
| 1846 | networks which have packet reorder. |
| 1847 | @item offset=@var{offset} |
| 1848 | Add an extra offset between header and data |
| 1849 | |
| 1850 | For example, to attach a VM running on host 4.3.2.1 via L2TPv3 to the bridge br-lan |
| 1851 | on the remote Linux host 1.2.3.4: |
| 1852 | @example |
| 1853 | # Setup tunnel on linux host using raw ip as encapsulation |
| 1854 | # on 1.2.3.4 |
| 1855 | ip l2tp add tunnel remote 4.3.2.1 local 1.2.3.4 tunnel_id 1 peer_tunnel_id 1 \ |
| 1856 | encap udp udp_sport 16384 udp_dport 16384 |
| 1857 | ip l2tp add session tunnel_id 1 name vmtunnel0 session_id \ |
| 1858 | 0xFFFFFFFF peer_session_id 0xFFFFFFFF |
| 1859 | ifconfig vmtunnel0 mtu 1500 |
| 1860 | ifconfig vmtunnel0 up |
| 1861 | brctl addif br-lan vmtunnel0 |
| 1862 | |
| 1863 | |
| 1864 | # on 4.3.2.1 |
| 1865 | # launch QEMU instance - if your network has reorder or is very lossy add ,pincounter |
| 1866 | |
| 1867 | qemu-system-i386 linux.img -net nic -net l2tpv3,src=4.2.3.1,dst=1.2.3.4,udp,srcport=16384,dstport=16384,rxsession=0xffffffff,txsession=0xffffffff,counter |
| 1868 | |
| 1869 | |
| 1870 | @end example |
| 1871 | |
Stefan Hajnoczi | 08d1202 | 2012-08-14 14:14:27 +0100 | [diff] [blame] | 1872 | @item -netdev vde,id=@var{id}[,sock=@var{socketpath}][,port=@var{n}][,group=@var{groupname}][,mode=@var{octalmode}] |
Blue Swirl | 609c1da | 2010-03-18 18:41:49 +0000 | [diff] [blame] | 1873 | @item -net vde[,vlan=@var{n}][,name=@var{name}][,sock=@var{socketpath}] [,port=@var{n}][,group=@var{groupname}][,mode=@var{octalmode}] |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 1874 | Connect VLAN @var{n} to PORT @var{n} of a vde switch running on host and |
| 1875 | listening for incoming connections on @var{socketpath}. Use GROUP @var{groupname} |
| 1876 | and MODE @var{octalmode} to change default ownership and permissions for |
Stefan Weil | c1ba4e0 | 2011-09-05 18:13:03 +0200 | [diff] [blame] | 1877 | communication port. This option is only available if QEMU has been compiled |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 1878 | with vde support enabled. |
| 1879 | |
| 1880 | Example: |
| 1881 | @example |
| 1882 | # launch vde switch |
| 1883 | vde_switch -F -sock /tmp/myswitch |
| 1884 | # launch QEMU instance |
Stefan Weil | 3804da9 | 2012-05-11 22:21:50 +0200 | [diff] [blame] | 1885 | qemu-system-i386 linux.img -net nic -net vde,sock=/tmp/myswitch |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 1886 | @end example |
| 1887 | |
Stefan Hajnoczi | 40e8c26 | 2013-02-26 11:07:16 +0100 | [diff] [blame] | 1888 | @item -netdev hubport,id=@var{id},hubid=@var{hubid} |
| 1889 | |
| 1890 | Create a hub port on QEMU "vlan" @var{hubid}. |
| 1891 | |
| 1892 | The hubport netdev lets you connect a NIC to a QEMU "vlan" instead of a single |
| 1893 | netdev. @code{-net} and @code{-device} with parameter @option{vlan} create the |
| 1894 | required hub automatically. |
| 1895 | |
Nikolay Nikolaev | 03ce574 | 2014-06-10 13:02:16 +0300 | [diff] [blame] | 1896 | @item -netdev vhost-user,chardev=@var{id}[,vhostforce=on|off] |
| 1897 | |
| 1898 | Establish a vhost-user netdev, backed by a chardev @var{id}. The chardev should |
| 1899 | be a unix domain socket backed one. The vhost-user uses a specifically defined |
| 1900 | protocol to pass vhost ioctl replacement messages to an application on the other |
| 1901 | end of the socket. On non-MSIX guests, the feature can be forced with |
| 1902 | @var{vhostforce}. |
| 1903 | |
| 1904 | Example: |
| 1905 | @example |
| 1906 | qemu -m 512 -object memory-backend-file,id=mem,size=512M,mem-path=/hugetlbfs,share=on \ |
| 1907 | -numa node,memdev=mem \ |
| 1908 | -chardev socket,path=/path/to/socket \ |
| 1909 | -netdev type=vhost-user,id=net0,chardev=chr0 \ |
| 1910 | -device virtio-net-pci,netdev=net0 |
| 1911 | @end example |
| 1912 | |
aliguori | bb9ea79 | 2009-04-21 19:56:28 +0000 | [diff] [blame] | 1913 | @item -net dump[,vlan=@var{n}][,file=@var{file}][,len=@var{len}] |
| 1914 | Dump network traffic on VLAN @var{n} to file @var{file} (@file{qemu-vlan0.pcap} by default). |
| 1915 | At most @var{len} bytes (64k by default) per packet are stored. The file format is |
| 1916 | libpcap, so it can be analyzed with tools such as tcpdump or Wireshark. |
| 1917 | |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 1918 | @item -net none |
| 1919 | Indicate that no network devices should be configured. It is used to |
| 1920 | override the default configuration (@option{-net nic -net user}) which |
| 1921 | is activated if no @option{-net} options are provided. |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 1922 | ETEXI |
| 1923 | |
Markus Armbruster | c70a01e | 2013-02-13 19:49:40 +0100 | [diff] [blame] | 1924 | STEXI |
| 1925 | @end table |
| 1926 | ETEXI |
Matthew Booth | 7273a2d | 2009-10-30 13:41:12 +0000 | [diff] [blame] | 1927 | DEFHEADING() |
| 1928 | |
| 1929 | DEFHEADING(Character device options:) |
Markus Armbruster | c70a01e | 2013-02-13 19:49:40 +0100 | [diff] [blame] | 1930 | STEXI |
| 1931 | |
| 1932 | The general form of a character device option is: |
| 1933 | @table @option |
| 1934 | ETEXI |
Matthew Booth | 7273a2d | 2009-10-30 13:41:12 +0000 | [diff] [blame] | 1935 | |
| 1936 | DEF("chardev", HAS_ARG, QEMU_OPTION_chardev, |
Jan Kiszka | 9733128 | 2010-04-06 16:55:54 +0200 | [diff] [blame] | 1937 | "-chardev null,id=id[,mux=on|off]\n" |
Corey Minyard | 5dd1f02 | 2014-10-02 11:17:37 -0500 | [diff] [blame] | 1938 | "-chardev socket,id=id[,host=host],port=port[,to=to][,ipv4][,ipv6][,nodelay][,reconnect=seconds]\n" |
| 1939 | " [,server][,nowait][,telnet][,reconnect=seconds][,mux=on|off] (tcp)\n" |
| 1940 | "-chardev socket,id=id,path=path[,server][,nowait][,telnet][,reconnect=seconds][,mux=on|off] (unix)\n" |
Matthew Booth | 7273a2d | 2009-10-30 13:41:12 +0000 | [diff] [blame] | 1941 | "-chardev udp,id=id[,host=host],port=port[,localaddr=localaddr]\n" |
Jan Kiszka | 9733128 | 2010-04-06 16:55:54 +0200 | [diff] [blame] | 1942 | " [,localport=localport][,ipv4][,ipv6][,mux=on|off]\n" |
| 1943 | "-chardev msmouse,id=id[,mux=on|off]\n" |
Matthew Booth | 7273a2d | 2009-10-30 13:41:12 +0000 | [diff] [blame] | 1944 | "-chardev vc,id=id[[,width=width][,height=height]][[,cols=cols][,rows=rows]]\n" |
Jan Kiszka | 9733128 | 2010-04-06 16:55:54 +0200 | [diff] [blame] | 1945 | " [,mux=on|off]\n" |
Markus Armbruster | 4f57378 | 2013-07-26 16:44:32 +0200 | [diff] [blame] | 1946 | "-chardev ringbuf,id=id[,size=size]\n" |
Jan Kiszka | 9733128 | 2010-04-06 16:55:54 +0200 | [diff] [blame] | 1947 | "-chardev file,id=id,path=path[,mux=on|off]\n" |
| 1948 | "-chardev pipe,id=id,path=path[,mux=on|off]\n" |
Matthew Booth | 7273a2d | 2009-10-30 13:41:12 +0000 | [diff] [blame] | 1949 | #ifdef _WIN32 |
Jan Kiszka | 9733128 | 2010-04-06 16:55:54 +0200 | [diff] [blame] | 1950 | "-chardev console,id=id[,mux=on|off]\n" |
| 1951 | "-chardev serial,id=id,path=path[,mux=on|off]\n" |
Matthew Booth | 7273a2d | 2009-10-30 13:41:12 +0000 | [diff] [blame] | 1952 | #else |
Jan Kiszka | 9733128 | 2010-04-06 16:55:54 +0200 | [diff] [blame] | 1953 | "-chardev pty,id=id[,mux=on|off]\n" |
Aurelien Jarno | b7fdb3a | 2010-07-13 21:13:12 +0200 | [diff] [blame] | 1954 | "-chardev stdio,id=id[,mux=on|off][,signal=on|off]\n" |
Matthew Booth | 7273a2d | 2009-10-30 13:41:12 +0000 | [diff] [blame] | 1955 | #endif |
| 1956 | #ifdef CONFIG_BRLAPI |
Jan Kiszka | 9733128 | 2010-04-06 16:55:54 +0200 | [diff] [blame] | 1957 | "-chardev braille,id=id[,mux=on|off]\n" |
Matthew Booth | 7273a2d | 2009-10-30 13:41:12 +0000 | [diff] [blame] | 1958 | #endif |
| 1959 | #if defined(__linux__) || defined(__sun__) || defined(__FreeBSD__) \ |
| 1960 | || defined(__NetBSD__) || defined(__OpenBSD__) || defined(__DragonFly__) |
Gerd Hoffmann | d59044e | 2012-12-19 13:50:29 +0100 | [diff] [blame] | 1961 | "-chardev serial,id=id,path=path[,mux=on|off]\n" |
Jan Kiszka | 9733128 | 2010-04-06 16:55:54 +0200 | [diff] [blame] | 1962 | "-chardev tty,id=id,path=path[,mux=on|off]\n" |
Matthew Booth | 7273a2d | 2009-10-30 13:41:12 +0000 | [diff] [blame] | 1963 | #endif |
| 1964 | #if defined(__linux__) || defined(__FreeBSD__) || defined(__DragonFly__) |
Gerd Hoffmann | 88a946d | 2013-01-10 14:20:58 +0100 | [diff] [blame] | 1965 | "-chardev parallel,id=id,path=path[,mux=on|off]\n" |
Jan Kiszka | 9733128 | 2010-04-06 16:55:54 +0200 | [diff] [blame] | 1966 | "-chardev parport,id=id,path=path[,mux=on|off]\n" |
Matthew Booth | 7273a2d | 2009-10-30 13:41:12 +0000 | [diff] [blame] | 1967 | #endif |
Alon Levy | cbcc633 | 2011-01-19 10:49:50 +0200 | [diff] [blame] | 1968 | #if defined(CONFIG_SPICE) |
| 1969 | "-chardev spicevmc,id=id,name=name[,debug=debug]\n" |
Marc-André Lureau | 5a49d3e | 2012-12-05 16:15:34 +0100 | [diff] [blame] | 1970 | "-chardev spiceport,id=id,name=name[,debug=debug]\n" |
Alon Levy | cbcc633 | 2011-01-19 10:49:50 +0200 | [diff] [blame] | 1971 | #endif |
Blue Swirl | ad96090 | 2010-03-29 19:23:52 +0000 | [diff] [blame] | 1972 | , QEMU_ARCH_ALL |
Matthew Booth | 7273a2d | 2009-10-30 13:41:12 +0000 | [diff] [blame] | 1973 | ) |
| 1974 | |
| 1975 | STEXI |
Jan Kiszka | 9733128 | 2010-04-06 16:55:54 +0200 | [diff] [blame] | 1976 | @item -chardev @var{backend} ,id=@var{id} [,mux=on|off] [,@var{options}] |
Stefan Weil | 6616b2a | 2010-02-05 23:52:05 +0100 | [diff] [blame] | 1977 | @findex -chardev |
Matthew Booth | 7273a2d | 2009-10-30 13:41:12 +0000 | [diff] [blame] | 1978 | Backend is one of: |
| 1979 | @option{null}, |
| 1980 | @option{socket}, |
| 1981 | @option{udp}, |
| 1982 | @option{msmouse}, |
| 1983 | @option{vc}, |
Markus Armbruster | 4f57378 | 2013-07-26 16:44:32 +0200 | [diff] [blame] | 1984 | @option{ringbuf}, |
Matthew Booth | 7273a2d | 2009-10-30 13:41:12 +0000 | [diff] [blame] | 1985 | @option{file}, |
| 1986 | @option{pipe}, |
| 1987 | @option{console}, |
| 1988 | @option{serial}, |
| 1989 | @option{pty}, |
| 1990 | @option{stdio}, |
| 1991 | @option{braille}, |
| 1992 | @option{tty}, |
Gerd Hoffmann | 88a946d | 2013-01-10 14:20:58 +0100 | [diff] [blame] | 1993 | @option{parallel}, |
Alon Levy | cbcc633 | 2011-01-19 10:49:50 +0200 | [diff] [blame] | 1994 | @option{parport}, |
| 1995 | @option{spicevmc}. |
Marc-André Lureau | 5a49d3e | 2012-12-05 16:15:34 +0100 | [diff] [blame] | 1996 | @option{spiceport}. |
Matthew Booth | 7273a2d | 2009-10-30 13:41:12 +0000 | [diff] [blame] | 1997 | The specific backend will determine the applicable options. |
| 1998 | |
| 1999 | All devices must have an id, which can be any string up to 127 characters long. |
| 2000 | It is used to uniquely identify this device in other command line directives. |
| 2001 | |
Jan Kiszka | 9733128 | 2010-04-06 16:55:54 +0200 | [diff] [blame] | 2002 | A character device may be used in multiplexing mode by multiple front-ends. |
| 2003 | The key sequence of @key{Control-a} and @key{c} will rotate the input focus |
| 2004 | between attached front-ends. Specify @option{mux=on} to enable this mode. |
| 2005 | |
Matthew Booth | 7273a2d | 2009-10-30 13:41:12 +0000 | [diff] [blame] | 2006 | Options to each backend are described below. |
| 2007 | |
| 2008 | @item -chardev null ,id=@var{id} |
| 2009 | A void device. This device will not emit any data, and will drop any data it |
| 2010 | receives. The null backend does not take any options. |
| 2011 | |
Corey Minyard | 5dd1f02 | 2014-10-02 11:17:37 -0500 | [diff] [blame] | 2012 | @item -chardev socket ,id=@var{id} [@var{TCP options} or @var{unix options}] [,server] [,nowait] [,telnet] [,reconnect=@var{seconds}] |
Matthew Booth | 7273a2d | 2009-10-30 13:41:12 +0000 | [diff] [blame] | 2013 | |
| 2014 | Create a two-way stream socket, which can be either a TCP or a unix socket. A |
| 2015 | unix socket will be created if @option{path} is specified. Behaviour is |
| 2016 | undefined if TCP options are specified for a unix socket. |
| 2017 | |
| 2018 | @option{server} specifies that the socket shall be a listening socket. |
| 2019 | |
| 2020 | @option{nowait} specifies that QEMU should not block waiting for a client to |
| 2021 | connect to a listening socket. |
| 2022 | |
| 2023 | @option{telnet} specifies that traffic on the socket should interpret telnet |
| 2024 | escape sequences. |
| 2025 | |
Corey Minyard | 5dd1f02 | 2014-10-02 11:17:37 -0500 | [diff] [blame] | 2026 | @option{reconnect} sets the timeout for reconnecting on non-server sockets when |
| 2027 | the remote end goes away. qemu will delay this many seconds and then attempt |
| 2028 | to reconnect. Zero disables reconnecting, and is the default. |
| 2029 | |
Matthew Booth | 7273a2d | 2009-10-30 13:41:12 +0000 | [diff] [blame] | 2030 | TCP and unix socket options are given below: |
| 2031 | |
| 2032 | @table @option |
| 2033 | |
Aurelien Jarno | 8d53356 | 2010-03-27 11:52:05 +0100 | [diff] [blame] | 2034 | @item TCP options: port=@var{port} [,host=@var{host}] [,to=@var{to}] [,ipv4] [,ipv6] [,nodelay] |
Matthew Booth | 7273a2d | 2009-10-30 13:41:12 +0000 | [diff] [blame] | 2035 | |
| 2036 | @option{host} for a listening socket specifies the local address to be bound. |
| 2037 | For a connecting socket species the remote host to connect to. @option{host} is |
| 2038 | optional for listening sockets. If not specified it defaults to @code{0.0.0.0}. |
| 2039 | |
| 2040 | @option{port} for a listening socket specifies the local port to be bound. For a |
| 2041 | connecting socket specifies the port on the remote host to connect to. |
| 2042 | @option{port} can be given as either a port number or a service name. |
| 2043 | @option{port} is required. |
| 2044 | |
| 2045 | @option{to} is only relevant to listening sockets. If it is specified, and |
| 2046 | @option{port} cannot be bound, QEMU will attempt to bind to subsequent ports up |
| 2047 | to and including @option{to} until it succeeds. @option{to} must be specified |
| 2048 | as a port number. |
| 2049 | |
| 2050 | @option{ipv4} and @option{ipv6} specify that either IPv4 or IPv6 must be used. |
| 2051 | If neither is specified the socket may use either protocol. |
| 2052 | |
| 2053 | @option{nodelay} disables the Nagle algorithm. |
| 2054 | |
| 2055 | @item unix options: path=@var{path} |
| 2056 | |
| 2057 | @option{path} specifies the local path of the unix socket. @option{path} is |
| 2058 | required. |
| 2059 | |
| 2060 | @end table |
| 2061 | |
| 2062 | @item -chardev udp ,id=@var{id} [,host=@var{host}] ,port=@var{port} [,localaddr=@var{localaddr}] [,localport=@var{localport}] [,ipv4] [,ipv6] |
| 2063 | |
| 2064 | Sends all traffic from the guest to a remote host over UDP. |
| 2065 | |
| 2066 | @option{host} specifies the remote host to connect to. If not specified it |
| 2067 | defaults to @code{localhost}. |
| 2068 | |
| 2069 | @option{port} specifies the port on the remote host to connect to. @option{port} |
| 2070 | is required. |
| 2071 | |
| 2072 | @option{localaddr} specifies the local address to bind to. If not specified it |
| 2073 | defaults to @code{0.0.0.0}. |
| 2074 | |
| 2075 | @option{localport} specifies the local port to bind to. If not specified any |
| 2076 | available local port will be used. |
| 2077 | |
| 2078 | @option{ipv4} and @option{ipv6} specify that either IPv4 or IPv6 must be used. |
| 2079 | If neither is specified the device may use either protocol. |
| 2080 | |
| 2081 | @item -chardev msmouse ,id=@var{id} |
| 2082 | |
| 2083 | Forward QEMU's emulated msmouse events to the guest. @option{msmouse} does not |
| 2084 | take any options. |
| 2085 | |
| 2086 | @item -chardev vc ,id=@var{id} [[,width=@var{width}] [,height=@var{height}]] [[,cols=@var{cols}] [,rows=@var{rows}]] |
| 2087 | |
| 2088 | Connect to a QEMU text console. @option{vc} may optionally be given a specific |
| 2089 | size. |
| 2090 | |
| 2091 | @option{width} and @option{height} specify the width and height respectively of |
| 2092 | the console, in pixels. |
| 2093 | |
| 2094 | @option{cols} and @option{rows} specify that the console be sized to fit a text |
| 2095 | console with the given dimensions. |
| 2096 | |
Markus Armbruster | 4f57378 | 2013-07-26 16:44:32 +0200 | [diff] [blame] | 2097 | @item -chardev ringbuf ,id=@var{id} [,size=@var{size}] |
Lei Li | 51767e7 | 2013-01-25 00:03:19 +0800 | [diff] [blame] | 2098 | |
Markus Armbruster | 3949e59 | 2013-02-06 21:27:24 +0100 | [diff] [blame] | 2099 | Create a ring buffer with fixed size @option{size}. |
| 2100 | @var{size} must be a power of two, and defaults to @code{64K}). |
Lei Li | 51767e7 | 2013-01-25 00:03:19 +0800 | [diff] [blame] | 2101 | |
Matthew Booth | 7273a2d | 2009-10-30 13:41:12 +0000 | [diff] [blame] | 2102 | @item -chardev file ,id=@var{id} ,path=@var{path} |
| 2103 | |
| 2104 | Log all traffic received from the guest to a file. |
| 2105 | |
| 2106 | @option{path} specifies the path of the file to be opened. This file will be |
| 2107 | created if it does not already exist, and overwritten if it does. @option{path} |
| 2108 | is required. |
| 2109 | |
| 2110 | @item -chardev pipe ,id=@var{id} ,path=@var{path} |
| 2111 | |
| 2112 | Create a two-way connection to the guest. The behaviour differs slightly between |
| 2113 | Windows hosts and other hosts: |
| 2114 | |
| 2115 | On Windows, a single duplex pipe will be created at |
| 2116 | @file{\\.pipe\@option{path}}. |
| 2117 | |
| 2118 | On other hosts, 2 pipes will be created called @file{@option{path}.in} and |
| 2119 | @file{@option{path}.out}. Data written to @file{@option{path}.in} will be |
| 2120 | received by the guest. Data written by the guest can be read from |
| 2121 | @file{@option{path}.out}. QEMU will not create these fifos, and requires them to |
| 2122 | be present. |
| 2123 | |
| 2124 | @option{path} forms part of the pipe path as described above. @option{path} is |
| 2125 | required. |
| 2126 | |
| 2127 | @item -chardev console ,id=@var{id} |
| 2128 | |
| 2129 | Send traffic from the guest to QEMU's standard output. @option{console} does not |
| 2130 | take any options. |
| 2131 | |
| 2132 | @option{console} is only available on Windows hosts. |
| 2133 | |
| 2134 | @item -chardev serial ,id=@var{id} ,path=@option{path} |
| 2135 | |
| 2136 | Send traffic from the guest to a serial device on the host. |
| 2137 | |
Gerd Hoffmann | d59044e | 2012-12-19 13:50:29 +0100 | [diff] [blame] | 2138 | On Unix hosts serial will actually accept any tty device, |
| 2139 | not only serial lines. |
Matthew Booth | 7273a2d | 2009-10-30 13:41:12 +0000 | [diff] [blame] | 2140 | |
| 2141 | @option{path} specifies the name of the serial device to open. |
| 2142 | |
| 2143 | @item -chardev pty ,id=@var{id} |
| 2144 | |
| 2145 | Create a new pseudo-terminal on the host and connect to it. @option{pty} does |
| 2146 | not take any options. |
| 2147 | |
| 2148 | @option{pty} is not available on Windows hosts. |
| 2149 | |
Aurelien Jarno | b7fdb3a | 2010-07-13 21:13:12 +0200 | [diff] [blame] | 2150 | @item -chardev stdio ,id=@var{id} [,signal=on|off] |
Stefan Weil | b65ee4f | 2012-05-11 22:25:50 +0200 | [diff] [blame] | 2151 | Connect to standard input and standard output of the QEMU process. |
Aurelien Jarno | b7fdb3a | 2010-07-13 21:13:12 +0200 | [diff] [blame] | 2152 | |
| 2153 | @option{signal} controls if signals are enabled on the terminal, that includes |
| 2154 | exiting QEMU with the key sequence @key{Control-c}. This option is enabled by |
| 2155 | default, use @option{signal=off} to disable it. |
| 2156 | |
| 2157 | @option{stdio} is not available on Windows hosts. |
Matthew Booth | 7273a2d | 2009-10-30 13:41:12 +0000 | [diff] [blame] | 2158 | |
| 2159 | @item -chardev braille ,id=@var{id} |
| 2160 | |
| 2161 | Connect to a local BrlAPI server. @option{braille} does not take any options. |
| 2162 | |
| 2163 | @item -chardev tty ,id=@var{id} ,path=@var{path} |
| 2164 | |
Matthew Booth | 7273a2d | 2009-10-30 13:41:12 +0000 | [diff] [blame] | 2165 | @option{tty} is only available on Linux, Sun, FreeBSD, NetBSD, OpenBSD and |
Markus Armbruster | d037d6b | 2013-02-13 15:54:15 +0100 | [diff] [blame] | 2166 | DragonFlyBSD hosts. It is an alias for @option{serial}. |
Matthew Booth | 7273a2d | 2009-10-30 13:41:12 +0000 | [diff] [blame] | 2167 | |
| 2168 | @option{path} specifies the path to the tty. @option{path} is required. |
| 2169 | |
Gerd Hoffmann | 88a946d | 2013-01-10 14:20:58 +0100 | [diff] [blame] | 2170 | @item -chardev parallel ,id=@var{id} ,path=@var{path} |
Matthew Booth | 7273a2d | 2009-10-30 13:41:12 +0000 | [diff] [blame] | 2171 | @item -chardev parport ,id=@var{id} ,path=@var{path} |
| 2172 | |
Gerd Hoffmann | 88a946d | 2013-01-10 14:20:58 +0100 | [diff] [blame] | 2173 | @option{parallel} is only available on Linux, FreeBSD and DragonFlyBSD hosts. |
Matthew Booth | 7273a2d | 2009-10-30 13:41:12 +0000 | [diff] [blame] | 2174 | |
| 2175 | Connect to a local parallel port. |
| 2176 | |
| 2177 | @option{path} specifies the path to the parallel port device. @option{path} is |
| 2178 | required. |
| 2179 | |
Alon Levy | cbcc633 | 2011-01-19 10:49:50 +0200 | [diff] [blame] | 2180 | @item -chardev spicevmc ,id=@var{id} ,debug=@var{debug}, name=@var{name} |
| 2181 | |
Stefan Hajnoczi | 3a84690 | 2011-10-06 11:24:12 +0100 | [diff] [blame] | 2182 | @option{spicevmc} is only available when spice support is built in. |
| 2183 | |
Alon Levy | cbcc633 | 2011-01-19 10:49:50 +0200 | [diff] [blame] | 2184 | @option{debug} debug level for spicevmc |
| 2185 | |
| 2186 | @option{name} name of spice channel to connect to |
| 2187 | |
| 2188 | Connect to a spice virtual machine channel, such as vdiport. |
Alon Levy | cbcc633 | 2011-01-19 10:49:50 +0200 | [diff] [blame] | 2189 | |
Marc-André Lureau | 5a49d3e | 2012-12-05 16:15:34 +0100 | [diff] [blame] | 2190 | @item -chardev spiceport ,id=@var{id} ,debug=@var{debug}, name=@var{name} |
| 2191 | |
| 2192 | @option{spiceport} is only available when spice support is built in. |
| 2193 | |
| 2194 | @option{debug} debug level for spicevmc |
| 2195 | |
| 2196 | @option{name} name of spice port to connect to |
| 2197 | |
| 2198 | Connect to a spice port, allowing a Spice client to handle the traffic |
| 2199 | identified by a name (preferably a fqdn). |
Matthew Booth | 7273a2d | 2009-10-30 13:41:12 +0000 | [diff] [blame] | 2200 | ETEXI |
| 2201 | |
Markus Armbruster | c70a01e | 2013-02-13 19:49:40 +0100 | [diff] [blame] | 2202 | STEXI |
| 2203 | @end table |
| 2204 | ETEXI |
Matthew Booth | 7273a2d | 2009-10-30 13:41:12 +0000 | [diff] [blame] | 2205 | DEFHEADING() |
| 2206 | |
Ronnie Sahlberg | 0f5314a | 2011-10-26 23:51:37 +1100 | [diff] [blame] | 2207 | DEFHEADING(Device URL Syntax:) |
Markus Armbruster | c70a01e | 2013-02-13 19:49:40 +0100 | [diff] [blame] | 2208 | STEXI |
Ronnie Sahlberg | 0f5314a | 2011-10-26 23:51:37 +1100 | [diff] [blame] | 2209 | |
| 2210 | In addition to using normal file images for the emulated storage devices, |
| 2211 | QEMU can also use networked resources such as iSCSI devices. These are |
| 2212 | specified using a special URL syntax. |
| 2213 | |
| 2214 | @table @option |
| 2215 | @item iSCSI |
| 2216 | iSCSI support allows QEMU to access iSCSI resources directly and use as |
| 2217 | images for the guest storage. Both disk and cdrom images are supported. |
| 2218 | |
| 2219 | Syntax for specifying iSCSI LUNs is |
| 2220 | ``iscsi://<target-ip>[:<port>]/<target-iqn>/<lun>'' |
| 2221 | |
Ronnie Sahlberg | 31459f4 | 2012-08-06 18:24:55 +1000 | [diff] [blame] | 2222 | By default qemu will use the iSCSI initiator-name |
| 2223 | 'iqn.2008-11.org.linux-kvm[:<name>]' but this can also be set from the command |
| 2224 | line or a configuration file. |
| 2225 | |
| 2226 | |
Ronnie Sahlberg | 0f5314a | 2011-10-26 23:51:37 +1100 | [diff] [blame] | 2227 | Example (without authentication): |
| 2228 | @example |
Stefan Weil | 3804da9 | 2012-05-11 22:21:50 +0200 | [diff] [blame] | 2229 | qemu-system-i386 -iscsi initiator-name=iqn.2001-04.com.example:my-initiator \ |
| 2230 | -cdrom iscsi://192.0.2.1/iqn.2001-04.com.example/2 \ |
| 2231 | -drive file=iscsi://192.0.2.1/iqn.2001-04.com.example/1 |
Ronnie Sahlberg | 0f5314a | 2011-10-26 23:51:37 +1100 | [diff] [blame] | 2232 | @end example |
| 2233 | |
| 2234 | Example (CHAP username/password via URL): |
| 2235 | @example |
Stefan Weil | 3804da9 | 2012-05-11 22:21:50 +0200 | [diff] [blame] | 2236 | qemu-system-i386 -drive file=iscsi://user%password@@192.0.2.1/iqn.2001-04.com.example/1 |
Ronnie Sahlberg | 0f5314a | 2011-10-26 23:51:37 +1100 | [diff] [blame] | 2237 | @end example |
| 2238 | |
| 2239 | Example (CHAP username/password via environment variables): |
| 2240 | @example |
| 2241 | LIBISCSI_CHAP_USERNAME="user" \ |
| 2242 | LIBISCSI_CHAP_PASSWORD="password" \ |
Stefan Weil | 3804da9 | 2012-05-11 22:21:50 +0200 | [diff] [blame] | 2243 | qemu-system-i386 -drive file=iscsi://192.0.2.1/iqn.2001-04.com.example/1 |
Ronnie Sahlberg | 0f5314a | 2011-10-26 23:51:37 +1100 | [diff] [blame] | 2244 | @end example |
| 2245 | |
| 2246 | iSCSI support is an optional feature of QEMU and only available when |
| 2247 | compiled and linked against libiscsi. |
Ronnie Sahlberg | f9dadc9 | 2012-01-26 09:39:02 +1100 | [diff] [blame] | 2248 | ETEXI |
| 2249 | DEF("iscsi", HAS_ARG, QEMU_OPTION_iscsi, |
| 2250 | "-iscsi [user=user][,password=password]\n" |
| 2251 | " [,header-digest=CRC32C|CR32C-NONE|NONE-CRC32C|NONE\n" |
Paolo Bonzini | 2fe3798 | 2013-12-06 16:08:05 +0100 | [diff] [blame] | 2252 | " [,initiator-name=initiator-iqn][,id=target-iqn]\n" |
Ronnie Sahlberg | f9dadc9 | 2012-01-26 09:39:02 +1100 | [diff] [blame] | 2253 | " iSCSI session parameters\n", QEMU_ARCH_ALL) |
| 2254 | STEXI |
Ronnie Sahlberg | 0f5314a | 2011-10-26 23:51:37 +1100 | [diff] [blame] | 2255 | |
Ronnie Sahlberg | 31459f4 | 2012-08-06 18:24:55 +1000 | [diff] [blame] | 2256 | iSCSI parameters such as username and password can also be specified via |
| 2257 | a configuration file. See qemu-doc for more information and examples. |
| 2258 | |
Ronnie Sahlberg | 08ae330 | 2011-10-27 20:33:21 +1100 | [diff] [blame] | 2259 | @item NBD |
| 2260 | QEMU supports NBD (Network Block Devices) both using TCP protocol as well |
| 2261 | as Unix Domain Sockets. |
| 2262 | |
| 2263 | Syntax for specifying a NBD device using TCP |
| 2264 | ``nbd:<server-ip>:<port>[:exportname=<export>]'' |
| 2265 | |
| 2266 | Syntax for specifying a NBD device using Unix Domain Sockets |
| 2267 | ``nbd:unix:<domain-socket>[:exportname=<export>]'' |
| 2268 | |
| 2269 | |
| 2270 | Example for TCP |
| 2271 | @example |
Stefan Weil | 3804da9 | 2012-05-11 22:21:50 +0200 | [diff] [blame] | 2272 | qemu-system-i386 --drive file=nbd:192.0.2.1:30000 |
Ronnie Sahlberg | 08ae330 | 2011-10-27 20:33:21 +1100 | [diff] [blame] | 2273 | @end example |
| 2274 | |
| 2275 | Example for Unix Domain Sockets |
| 2276 | @example |
Stefan Weil | 3804da9 | 2012-05-11 22:21:50 +0200 | [diff] [blame] | 2277 | qemu-system-i386 --drive file=nbd:unix:/tmp/nbd-socket |
Ronnie Sahlberg | 08ae330 | 2011-10-27 20:33:21 +1100 | [diff] [blame] | 2278 | @end example |
| 2279 | |
Richard W.M. Jones | 0a12ec8 | 2013-04-09 15:30:53 +0100 | [diff] [blame] | 2280 | @item SSH |
| 2281 | QEMU supports SSH (Secure Shell) access to remote disks. |
| 2282 | |
| 2283 | Examples: |
| 2284 | @example |
| 2285 | qemu-system-i386 -drive file=ssh://user@@host/path/to/disk.img |
| 2286 | qemu-system-i386 -drive file.driver=ssh,file.user=user,file.host=host,file.port=22,file.path=/path/to/disk.img |
| 2287 | @end example |
| 2288 | |
| 2289 | Currently authentication must be done using ssh-agent. Other |
| 2290 | authentication methods may be supported in future. |
| 2291 | |
Ronnie Sahlberg | d999022 | 2011-10-28 20:13:39 +1100 | [diff] [blame] | 2292 | @item Sheepdog |
| 2293 | Sheepdog is a distributed storage system for QEMU. |
| 2294 | QEMU supports using either local sheepdog devices or remote networked |
| 2295 | devices. |
| 2296 | |
| 2297 | Syntax for specifying a sheepdog device |
MORITA Kazutaka | 5d6768e | 2013-02-22 12:39:51 +0900 | [diff] [blame] | 2298 | @example |
MORITA Kazutaka | 1b8bbb4 | 2013-02-22 12:39:53 +0900 | [diff] [blame] | 2299 | sheepdog[+tcp|+unix]://[host:port]/vdiname[?socket=path][#snapid|#tag] |
MORITA Kazutaka | 5d6768e | 2013-02-22 12:39:51 +0900 | [diff] [blame] | 2300 | @end example |
Ronnie Sahlberg | d999022 | 2011-10-28 20:13:39 +1100 | [diff] [blame] | 2301 | |
| 2302 | Example |
| 2303 | @example |
MORITA Kazutaka | 5d6768e | 2013-02-22 12:39:51 +0900 | [diff] [blame] | 2304 | qemu-system-i386 --drive file=sheepdog://192.0.2.1:30000/MyVirtualMachine |
Ronnie Sahlberg | d999022 | 2011-10-28 20:13:39 +1100 | [diff] [blame] | 2305 | @end example |
| 2306 | |
| 2307 | See also @url{http://http://www.osrg.net/sheepdog/}. |
| 2308 | |
Bharata B Rao | 8809e28 | 2012-10-24 17:17:53 +0530 | [diff] [blame] | 2309 | @item GlusterFS |
| 2310 | GlusterFS is an user space distributed file system. |
| 2311 | QEMU supports the use of GlusterFS volumes for hosting VM disk images using |
| 2312 | TCP, Unix Domain Sockets and RDMA transport protocols. |
| 2313 | |
| 2314 | Syntax for specifying a VM disk image on GlusterFS volume is |
| 2315 | @example |
| 2316 | gluster[+transport]://[server[:port]]/volname/image[?socket=...] |
| 2317 | @end example |
| 2318 | |
| 2319 | |
| 2320 | Example |
| 2321 | @example |
Lei Li | db2d5eb | 2013-03-07 15:50:26 +0800 | [diff] [blame] | 2322 | qemu-system-x86_64 --drive file=gluster://192.0.2.1/testvol/a.img |
Bharata B Rao | 8809e28 | 2012-10-24 17:17:53 +0530 | [diff] [blame] | 2323 | @end example |
| 2324 | |
| 2325 | See also @url{http://www.gluster.org}. |
Matthew Booth | 0a86cb7 | 2014-05-14 19:28:43 -0400 | [diff] [blame] | 2326 | |
| 2327 | @item HTTP/HTTPS/FTP/FTPS/TFTP |
| 2328 | QEMU supports read-only access to files accessed over http(s), ftp(s) and tftp. |
| 2329 | |
| 2330 | Syntax using a single filename: |
| 2331 | @example |
| 2332 | <protocol>://[<username>[:<password>]@@]<host>/<path> |
| 2333 | @end example |
| 2334 | |
| 2335 | where: |
| 2336 | @table @option |
| 2337 | @item protocol |
| 2338 | 'http', 'https', 'ftp', 'ftps', or 'tftp'. |
| 2339 | |
| 2340 | @item username |
| 2341 | Optional username for authentication to the remote server. |
| 2342 | |
| 2343 | @item password |
| 2344 | Optional password for authentication to the remote server. |
| 2345 | |
| 2346 | @item host |
| 2347 | Address of the remote server. |
| 2348 | |
| 2349 | @item path |
| 2350 | Path on the remote server, including any query string. |
| 2351 | @end table |
| 2352 | |
| 2353 | The following options are also supported: |
| 2354 | @table @option |
| 2355 | @item url |
| 2356 | The full URL when passing options to the driver explicitly. |
| 2357 | |
| 2358 | @item readahead |
| 2359 | The amount of data to read ahead with each range request to the remote server. |
| 2360 | This value may optionally have the suffix 'T', 'G', 'M', 'K', 'k' or 'b'. If it |
| 2361 | does not have a suffix, it will be assumed to be in bytes. The value must be a |
| 2362 | multiple of 512 bytes. It defaults to 256k. |
| 2363 | |
| 2364 | @item sslverify |
| 2365 | Whether to verify the remote server's certificate when connecting over SSL. It |
| 2366 | can have the value 'on' or 'off'. It defaults to 'on'. |
Daniel Henrique Barboza | 212aefa | 2014-08-13 12:44:27 -0300 | [diff] [blame] | 2367 | |
Richard W.M. Jones | a94f83d | 2014-08-29 16:03:12 +0100 | [diff] [blame] | 2368 | @item cookie |
| 2369 | Send this cookie (it can also be a list of cookies separated by ';') with |
| 2370 | each outgoing request. Only supported when using protocols such as HTTP |
| 2371 | which support cookies, otherwise ignored. |
| 2372 | |
Daniel Henrique Barboza | 212aefa | 2014-08-13 12:44:27 -0300 | [diff] [blame] | 2373 | @item timeout |
| 2374 | Set the timeout in seconds of the CURL connection. This timeout is the time |
| 2375 | that CURL waits for a response from the remote server to get the size of the |
| 2376 | image to be downloaded. If not set, the default timeout of 5 seconds is used. |
Matthew Booth | 0a86cb7 | 2014-05-14 19:28:43 -0400 | [diff] [blame] | 2377 | @end table |
| 2378 | |
| 2379 | Note that when passing options to qemu explicitly, @option{driver} is the value |
| 2380 | of <protocol>. |
| 2381 | |
| 2382 | Example: boot from a remote Fedora 20 live ISO image |
| 2383 | @example |
| 2384 | qemu-system-x86_64 --drive media=cdrom,file=http://dl.fedoraproject.org/pub/fedora/linux/releases/20/Live/x86_64/Fedora-Live-Desktop-x86_64-20-1.iso,readonly |
| 2385 | |
| 2386 | qemu-system-x86_64 --drive media=cdrom,file.driver=http,file.url=http://dl.fedoraproject.org/pub/fedora/linux/releases/20/Live/x86_64/Fedora-Live-Desktop-x86_64-20-1.iso,readonly |
| 2387 | @end example |
| 2388 | |
| 2389 | Example: boot from a remote Fedora 20 cloud image using a local overlay for |
| 2390 | writes, copy-on-read, and a readahead of 64k |
| 2391 | @example |
| 2392 | qemu-img create -f qcow2 -o backing_file='json:@{"file.driver":"http",, "file.url":"https://dl.fedoraproject.org/pub/fedora/linux/releases/20/Images/x86_64/Fedora-x86_64-20-20131211.1-sda.qcow2",, "file.readahead":"64k"@}' /tmp/Fedora-x86_64-20-20131211.1-sda.qcow2 |
| 2393 | |
| 2394 | qemu-system-x86_64 -drive file=/tmp/Fedora-x86_64-20-20131211.1-sda.qcow2,copy-on-read=on |
| 2395 | @end example |
| 2396 | |
| 2397 | Example: boot from an image stored on a VMware vSphere server with a self-signed |
Daniel Henrique Barboza | 212aefa | 2014-08-13 12:44:27 -0300 | [diff] [blame] | 2398 | certificate using a local overlay for writes, a readahead of 64k and a timeout |
| 2399 | of 10 seconds. |
Matthew Booth | 0a86cb7 | 2014-05-14 19:28:43 -0400 | [diff] [blame] | 2400 | @example |
Daniel Henrique Barboza | 212aefa | 2014-08-13 12:44:27 -0300 | [diff] [blame] | 2401 | qemu-img create -f qcow2 -o backing_file='json:@{"file.driver":"https",, "file.url":"https://user:password@@vsphere.example.com/folder/test/test-flat.vmdk?dcPath=Datacenter&dsName=datastore1",, "file.sslverify":"off",, "file.readahead":"64k",, "file.timeout":10@}' /tmp/test.qcow2 |
Matthew Booth | 0a86cb7 | 2014-05-14 19:28:43 -0400 | [diff] [blame] | 2402 | |
| 2403 | qemu-system-x86_64 -drive file=/tmp/test.qcow2 |
| 2404 | @end example |
Markus Armbruster | c70a01e | 2013-02-13 19:49:40 +0100 | [diff] [blame] | 2405 | ETEXI |
| 2406 | |
| 2407 | STEXI |
Ronnie Sahlberg | 0f5314a | 2011-10-26 23:51:37 +1100 | [diff] [blame] | 2408 | @end table |
| 2409 | ETEXI |
| 2410 | |
Matthew Booth | 7273a2d | 2009-10-30 13:41:12 +0000 | [diff] [blame] | 2411 | DEFHEADING(Bluetooth(R) options:) |
Markus Armbruster | c70a01e | 2013-02-13 19:49:40 +0100 | [diff] [blame] | 2412 | STEXI |
| 2413 | @table @option |
| 2414 | ETEXI |
Matthew Booth | 7273a2d | 2009-10-30 13:41:12 +0000 | [diff] [blame] | 2415 | |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 2416 | DEF("bt", HAS_ARG, QEMU_OPTION_bt, \ |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 2417 | "-bt hci,null dumb bluetooth HCI - doesn't respond to commands\n" \ |
| 2418 | "-bt hci,host[:id]\n" \ |
| 2419 | " use host's HCI with the given name\n" \ |
| 2420 | "-bt hci[,vlan=n]\n" \ |
| 2421 | " emulate a standard HCI in virtual scatternet 'n'\n" \ |
| 2422 | "-bt vhci[,vlan=n]\n" \ |
| 2423 | " add host computer to virtual scatternet 'n' using VHCI\n" \ |
| 2424 | "-bt device:dev[,vlan=n]\n" \ |
Blue Swirl | ad96090 | 2010-03-29 19:23:52 +0000 | [diff] [blame] | 2425 | " emulate a bluetooth device 'dev' in scatternet 'n'\n", |
| 2426 | QEMU_ARCH_ALL) |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 2427 | STEXI |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 2428 | @item -bt hci[...] |
Stefan Weil | 6616b2a | 2010-02-05 23:52:05 +0100 | [diff] [blame] | 2429 | @findex -bt |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 2430 | Defines the function of the corresponding Bluetooth HCI. -bt options |
| 2431 | are matched with the HCIs present in the chosen machine type. For |
| 2432 | example when emulating a machine with only one HCI built into it, only |
| 2433 | the first @code{-bt hci[...]} option is valid and defines the HCI's |
| 2434 | logic. The Transport Layer is decided by the machine type. Currently |
| 2435 | the machines @code{n800} and @code{n810} have one HCI and all other |
| 2436 | machines have none. |
| 2437 | |
| 2438 | @anchor{bt-hcis} |
| 2439 | The following three types are recognized: |
| 2440 | |
Kevin Wolf | b3f046c | 2009-10-09 10:58:35 +0200 | [diff] [blame] | 2441 | @table @option |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 2442 | @item -bt hci,null |
| 2443 | (default) The corresponding Bluetooth HCI assumes no internal logic |
| 2444 | and will not respond to any HCI commands or emit events. |
| 2445 | |
| 2446 | @item -bt hci,host[:@var{id}] |
| 2447 | (@code{bluez} only) The corresponding HCI passes commands / events |
| 2448 | to / from the physical HCI identified by the name @var{id} (default: |
| 2449 | @code{hci0}) on the computer running QEMU. Only available on @code{bluez} |
| 2450 | capable systems like Linux. |
| 2451 | |
| 2452 | @item -bt hci[,vlan=@var{n}] |
| 2453 | Add a virtual, standard HCI that will participate in the Bluetooth |
| 2454 | scatternet @var{n} (default @code{0}). Similarly to @option{-net} |
| 2455 | VLANs, devices inside a bluetooth network @var{n} can only communicate |
| 2456 | with other devices in the same network (scatternet). |
| 2457 | @end table |
| 2458 | |
| 2459 | @item -bt vhci[,vlan=@var{n}] |
| 2460 | (Linux-host only) Create a HCI in scatternet @var{n} (default 0) attached |
| 2461 | to the host bluetooth stack instead of to the emulated target. This |
| 2462 | allows the host and target machines to participate in a common scatternet |
| 2463 | and communicate. Requires the Linux @code{vhci} driver installed. Can |
| 2464 | be used as following: |
| 2465 | |
| 2466 | @example |
Stefan Weil | 3804da9 | 2012-05-11 22:21:50 +0200 | [diff] [blame] | 2467 | qemu-system-i386 [...OPTIONS...] -bt hci,vlan=5 -bt vhci,vlan=5 |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 2468 | @end example |
| 2469 | |
| 2470 | @item -bt device:@var{dev}[,vlan=@var{n}] |
| 2471 | Emulate a bluetooth device @var{dev} and place it in network @var{n} |
| 2472 | (default @code{0}). QEMU can only emulate one type of bluetooth devices |
| 2473 | currently: |
| 2474 | |
Kevin Wolf | b3f046c | 2009-10-09 10:58:35 +0200 | [diff] [blame] | 2475 | @table @option |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 2476 | @item keyboard |
| 2477 | Virtual wireless keyboard implementing the HIDP bluetooth profile. |
| 2478 | @end table |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 2479 | ETEXI |
| 2480 | |
Markus Armbruster | c70a01e | 2013-02-13 19:49:40 +0100 | [diff] [blame] | 2481 | STEXI |
| 2482 | @end table |
| 2483 | ETEXI |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 2484 | DEFHEADING() |
| 2485 | |
Stefan Berger | d1a0cf7 | 2013-02-27 12:47:49 -0500 | [diff] [blame] | 2486 | #ifdef CONFIG_TPM |
| 2487 | DEFHEADING(TPM device options:) |
| 2488 | |
| 2489 | DEF("tpmdev", HAS_ARG, QEMU_OPTION_tpmdev, \ |
Stefan Berger | 92dcc23 | 2013-02-27 12:47:54 -0500 | [diff] [blame] | 2490 | "-tpmdev passthrough,id=id[,path=path][,cancel-path=path]\n" |
| 2491 | " use path to provide path to a character device; default is /dev/tpm0\n" |
| 2492 | " use cancel-path to provide path to TPM's cancel sysfs entry; if\n" |
| 2493 | " not provided it will be searched for in /sys/class/misc/tpm?/device\n", |
Stefan Berger | d1a0cf7 | 2013-02-27 12:47:49 -0500 | [diff] [blame] | 2494 | QEMU_ARCH_ALL) |
| 2495 | STEXI |
| 2496 | |
| 2497 | The general form of a TPM device option is: |
| 2498 | @table @option |
| 2499 | |
| 2500 | @item -tpmdev @var{backend} ,id=@var{id} [,@var{options}] |
| 2501 | @findex -tpmdev |
| 2502 | Backend type must be: |
Stefan Berger | 4549a8b | 2013-02-27 12:47:53 -0500 | [diff] [blame] | 2503 | @option{passthrough}. |
Stefan Berger | d1a0cf7 | 2013-02-27 12:47:49 -0500 | [diff] [blame] | 2504 | |
| 2505 | The specific backend type will determine the applicable options. |
Corey Bryant | 28c4fa3 | 2013-03-20 12:34:49 -0400 | [diff] [blame] | 2506 | The @code{-tpmdev} option creates the TPM backend and requires a |
| 2507 | @code{-device} option that specifies the TPM frontend interface model. |
Stefan Berger | d1a0cf7 | 2013-02-27 12:47:49 -0500 | [diff] [blame] | 2508 | |
| 2509 | Options to each backend are described below. |
| 2510 | |
| 2511 | Use 'help' to print all available TPM backend types. |
| 2512 | @example |
| 2513 | qemu -tpmdev help |
| 2514 | @end example |
| 2515 | |
Stefan Berger | 92dcc23 | 2013-02-27 12:47:54 -0500 | [diff] [blame] | 2516 | @item -tpmdev passthrough, id=@var{id}, path=@var{path}, cancel-path=@var{cancel-path} |
Stefan Berger | 4549a8b | 2013-02-27 12:47:53 -0500 | [diff] [blame] | 2517 | |
| 2518 | (Linux-host only) Enable access to the host's TPM using the passthrough |
| 2519 | driver. |
| 2520 | |
| 2521 | @option{path} specifies the path to the host's TPM device, i.e., on |
| 2522 | a Linux host this would be @code{/dev/tpm0}. |
| 2523 | @option{path} is optional and by default @code{/dev/tpm0} is used. |
| 2524 | |
Stefan Berger | 92dcc23 | 2013-02-27 12:47:54 -0500 | [diff] [blame] | 2525 | @option{cancel-path} specifies the path to the host TPM device's sysfs |
| 2526 | entry allowing for cancellation of an ongoing TPM command. |
| 2527 | @option{cancel-path} is optional and by default QEMU will search for the |
| 2528 | sysfs entry to use. |
| 2529 | |
Stefan Berger | 4549a8b | 2013-02-27 12:47:53 -0500 | [diff] [blame] | 2530 | Some notes about using the host's TPM with the passthrough driver: |
| 2531 | |
| 2532 | The TPM device accessed by the passthrough driver must not be |
| 2533 | used by any other application on the host. |
| 2534 | |
| 2535 | Since the host's firmware (BIOS/UEFI) has already initialized the TPM, |
| 2536 | the VM's firmware (BIOS/UEFI) will not be able to initialize the |
| 2537 | TPM again and may therefore not show a TPM-specific menu that would |
| 2538 | otherwise allow the user to configure the TPM, e.g., allow the user to |
| 2539 | enable/disable or activate/deactivate the TPM. |
| 2540 | Further, if TPM ownership is released from within a VM then the host's TPM |
| 2541 | will get disabled and deactivated. To enable and activate the |
| 2542 | TPM again afterwards, the host has to be rebooted and the user is |
| 2543 | required to enter the firmware's menu to enable and activate the TPM. |
| 2544 | If the TPM is left disabled and/or deactivated most TPM commands will fail. |
| 2545 | |
| 2546 | To create a passthrough TPM use the following two options: |
| 2547 | @example |
| 2548 | -tpmdev passthrough,id=tpm0 -device tpm-tis,tpmdev=tpm0 |
| 2549 | @end example |
| 2550 | Note that the @code{-tpmdev} id is @code{tpm0} and is referenced by |
| 2551 | @code{tpmdev=tpm0} in the device option. |
| 2552 | |
Stefan Berger | d1a0cf7 | 2013-02-27 12:47:49 -0500 | [diff] [blame] | 2553 | @end table |
| 2554 | |
| 2555 | ETEXI |
| 2556 | |
| 2557 | DEFHEADING() |
| 2558 | |
| 2559 | #endif |
| 2560 | |
Alexander Graf | 7677f05 | 2009-06-28 16:55:55 +0200 | [diff] [blame] | 2561 | DEFHEADING(Linux/Multiboot boot specific:) |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 2562 | STEXI |
Alexander Graf | 7677f05 | 2009-06-28 16:55:55 +0200 | [diff] [blame] | 2563 | |
| 2564 | When using these options, you can use a given Linux or Multiboot |
| 2565 | kernel without installing it in the disk image. It can be useful |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 2566 | for easier testing of various kernels. |
| 2567 | |
| 2568 | @table @option |
| 2569 | ETEXI |
| 2570 | |
| 2571 | DEF("kernel", HAS_ARG, QEMU_OPTION_kernel, \ |
Blue Swirl | ad96090 | 2010-03-29 19:23:52 +0000 | [diff] [blame] | 2572 | "-kernel bzImage use 'bzImage' as kernel image\n", QEMU_ARCH_ALL) |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 2573 | STEXI |
| 2574 | @item -kernel @var{bzImage} |
Stefan Weil | 6616b2a | 2010-02-05 23:52:05 +0100 | [diff] [blame] | 2575 | @findex -kernel |
Alexander Graf | 7677f05 | 2009-06-28 16:55:55 +0200 | [diff] [blame] | 2576 | Use @var{bzImage} as kernel image. The kernel can be either a Linux kernel |
| 2577 | or in multiboot format. |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 2578 | ETEXI |
| 2579 | |
| 2580 | DEF("append", HAS_ARG, QEMU_OPTION_append, \ |
Blue Swirl | ad96090 | 2010-03-29 19:23:52 +0000 | [diff] [blame] | 2581 | "-append cmdline use 'cmdline' as kernel command line\n", QEMU_ARCH_ALL) |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 2582 | STEXI |
| 2583 | @item -append @var{cmdline} |
Stefan Weil | 6616b2a | 2010-02-05 23:52:05 +0100 | [diff] [blame] | 2584 | @findex -append |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 2585 | Use @var{cmdline} as kernel command line |
| 2586 | ETEXI |
| 2587 | |
| 2588 | DEF("initrd", HAS_ARG, QEMU_OPTION_initrd, \ |
Blue Swirl | ad96090 | 2010-03-29 19:23:52 +0000 | [diff] [blame] | 2589 | "-initrd file use 'file' as initial ram disk\n", QEMU_ARCH_ALL) |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 2590 | STEXI |
| 2591 | @item -initrd @var{file} |
Stefan Weil | 6616b2a | 2010-02-05 23:52:05 +0100 | [diff] [blame] | 2592 | @findex -initrd |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 2593 | Use @var{file} as initial ram disk. |
Alexander Graf | 7677f05 | 2009-06-28 16:55:55 +0200 | [diff] [blame] | 2594 | |
| 2595 | @item -initrd "@var{file1} arg=foo,@var{file2}" |
| 2596 | |
| 2597 | This syntax is only available with multiboot. |
| 2598 | |
| 2599 | Use @var{file1} and @var{file2} as modules and pass arg=foo as parameter to the |
| 2600 | first module. |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 2601 | ETEXI |
| 2602 | |
Grant Likely | 412beee | 2012-03-02 11:56:38 +0000 | [diff] [blame] | 2603 | DEF("dtb", HAS_ARG, QEMU_OPTION_dtb, \ |
Peter A. G. Crosthwaite | 379b5c7 | 2012-03-04 21:03:54 +1000 | [diff] [blame] | 2604 | "-dtb file use 'file' as device tree image\n", QEMU_ARCH_ALL) |
Grant Likely | 412beee | 2012-03-02 11:56:38 +0000 | [diff] [blame] | 2605 | STEXI |
| 2606 | @item -dtb @var{file} |
| 2607 | @findex -dtb |
| 2608 | Use @var{file} as a device tree binary (dtb) image and pass it to the kernel |
| 2609 | on boot. |
| 2610 | ETEXI |
| 2611 | |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 2612 | STEXI |
| 2613 | @end table |
| 2614 | ETEXI |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 2615 | DEFHEADING() |
| 2616 | |
| 2617 | DEFHEADING(Debug/Expert options:) |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 2618 | STEXI |
| 2619 | @table @option |
| 2620 | ETEXI |
| 2621 | |
| 2622 | DEF("serial", HAS_ARG, QEMU_OPTION_serial, \ |
Blue Swirl | ad96090 | 2010-03-29 19:23:52 +0000 | [diff] [blame] | 2623 | "-serial dev redirect the serial port to char device 'dev'\n", |
| 2624 | QEMU_ARCH_ALL) |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 2625 | STEXI |
| 2626 | @item -serial @var{dev} |
Stefan Weil | 6616b2a | 2010-02-05 23:52:05 +0100 | [diff] [blame] | 2627 | @findex -serial |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 2628 | Redirect the virtual serial port to host character device |
| 2629 | @var{dev}. The default device is @code{vc} in graphical mode and |
| 2630 | @code{stdio} in non graphical mode. |
| 2631 | |
| 2632 | This option can be used several times to simulate up to 4 serial |
| 2633 | ports. |
| 2634 | |
| 2635 | Use @code{-serial none} to disable all serial ports. |
| 2636 | |
| 2637 | Available character devices are: |
Kevin Wolf | b3f046c | 2009-10-09 10:58:35 +0200 | [diff] [blame] | 2638 | @table @option |
Kevin Wolf | 4e257e5 | 2009-10-09 10:58:36 +0200 | [diff] [blame] | 2639 | @item vc[:@var{W}x@var{H}] |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 2640 | Virtual console. Optionally, a width and height can be given in pixel with |
| 2641 | @example |
| 2642 | vc:800x600 |
| 2643 | @end example |
| 2644 | It is also possible to specify width or height in characters: |
| 2645 | @example |
| 2646 | vc:80Cx24C |
| 2647 | @end example |
| 2648 | @item pty |
| 2649 | [Linux only] Pseudo TTY (a new PTY is automatically allocated) |
| 2650 | @item none |
| 2651 | No device is allocated. |
| 2652 | @item null |
| 2653 | void device |
Ingo van Lil | 88e020e | 2013-12-20 14:44:53 +0100 | [diff] [blame] | 2654 | @item chardev:@var{id} |
| 2655 | Use a named character device defined with the @code{-chardev} option. |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 2656 | @item /dev/XXX |
| 2657 | [Linux only] Use host tty, e.g. @file{/dev/ttyS0}. The host serial port |
| 2658 | parameters are set according to the emulated ones. |
| 2659 | @item /dev/parport@var{N} |
| 2660 | [Linux only, parallel port only] Use host parallel port |
| 2661 | @var{N}. Currently SPP and EPP parallel port features can be used. |
| 2662 | @item file:@var{filename} |
| 2663 | Write output to @var{filename}. No character can be read. |
| 2664 | @item stdio |
| 2665 | [Unix only] standard input/output |
| 2666 | @item pipe:@var{filename} |
| 2667 | name pipe @var{filename} |
| 2668 | @item COM@var{n} |
| 2669 | [Windows only] Use host serial port @var{n} |
| 2670 | @item udp:[@var{remote_host}]:@var{remote_port}[@@[@var{src_ip}]:@var{src_port}] |
| 2671 | This implements UDP Net Console. |
| 2672 | When @var{remote_host} or @var{src_ip} are not specified |
| 2673 | they default to @code{0.0.0.0}. |
| 2674 | When not using a specified @var{src_port} a random port is automatically chosen. |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 2675 | |
| 2676 | If you just want a simple readonly console you can use @code{netcat} or |
Stefan Weil | b65ee4f | 2012-05-11 22:25:50 +0200 | [diff] [blame] | 2677 | @code{nc}, by starting QEMU with: @code{-serial udp::4555} and nc as: |
| 2678 | @code{nc -u -l -p 4555}. Any time QEMU writes something to that port it |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 2679 | will appear in the netconsole session. |
| 2680 | |
| 2681 | If you plan to send characters back via netconsole or you want to stop |
Stefan Weil | b65ee4f | 2012-05-11 22:25:50 +0200 | [diff] [blame] | 2682 | and start QEMU a lot of times, you should have QEMU use the same |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 2683 | source port each time by using something like @code{-serial |
Stefan Weil | b65ee4f | 2012-05-11 22:25:50 +0200 | [diff] [blame] | 2684 | udp::4555@@:4556} to QEMU. Another approach is to use a patched |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 2685 | version of netcat which can listen to a TCP port and send and receive |
| 2686 | characters via udp. If you have a patched version of netcat which |
| 2687 | activates telnet remote echo and single char transfer, then you can |
| 2688 | use the following options to step up a netcat redirector to allow |
Stefan Weil | b65ee4f | 2012-05-11 22:25:50 +0200 | [diff] [blame] | 2689 | telnet on port 5555 to access the QEMU port. |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 2690 | @table @code |
Stefan Weil | 071c939 | 2012-04-07 09:23:36 +0200 | [diff] [blame] | 2691 | @item QEMU Options: |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 2692 | -serial udp::4555@@:4556 |
| 2693 | @item netcat options: |
| 2694 | -u -P 4555 -L 0.0.0.0:4556 -t -p 5555 -I -T |
| 2695 | @item telnet options: |
| 2696 | localhost 5555 |
| 2697 | @end table |
| 2698 | |
Corey Minyard | 5dd1f02 | 2014-10-02 11:17:37 -0500 | [diff] [blame] | 2699 | @item tcp:[@var{host}]:@var{port}[,@var{server}][,nowait][,nodelay][,reconnect=@var{seconds}] |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 2700 | The TCP Net Console has two modes of operation. It can send the serial |
| 2701 | I/O to a location or wait for a connection from a location. By default |
| 2702 | the TCP Net Console is sent to @var{host} at the @var{port}. If you use |
| 2703 | the @var{server} option QEMU will wait for a client socket application |
| 2704 | to connect to the port before continuing, unless the @code{nowait} |
| 2705 | option was specified. The @code{nodelay} option disables the Nagle buffering |
Corey Minyard | 5dd1f02 | 2014-10-02 11:17:37 -0500 | [diff] [blame] | 2706 | algorithm. The @code{reconnect} option only applies if @var{noserver} is |
| 2707 | set, if the connection goes down it will attempt to reconnect at the |
| 2708 | given interval. If @var{host} is omitted, 0.0.0.0 is assumed. Only |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 2709 | one TCP connection at a time is accepted. You can use @code{telnet} to |
| 2710 | connect to the corresponding character device. |
| 2711 | @table @code |
| 2712 | @item Example to send tcp console to 192.168.0.2 port 4444 |
| 2713 | -serial tcp:192.168.0.2:4444 |
| 2714 | @item Example to listen and wait on port 4444 for connection |
| 2715 | -serial tcp::4444,server |
| 2716 | @item Example to not wait and listen on ip 192.168.0.100 port 4444 |
| 2717 | -serial tcp:192.168.0.100:4444,server,nowait |
| 2718 | @end table |
| 2719 | |
| 2720 | @item telnet:@var{host}:@var{port}[,server][,nowait][,nodelay] |
| 2721 | The telnet protocol is used instead of raw tcp sockets. The options |
| 2722 | work the same as if you had specified @code{-serial tcp}. The |
| 2723 | difference is that the port acts like a telnet server or client using |
| 2724 | telnet option negotiation. This will also allow you to send the |
| 2725 | MAGIC_SYSRQ sequence if you use a telnet that supports sending the break |
| 2726 | sequence. Typically in unix telnet you do it with Control-] and then |
| 2727 | type "send break" followed by pressing the enter key. |
| 2728 | |
Corey Minyard | 5dd1f02 | 2014-10-02 11:17:37 -0500 | [diff] [blame] | 2729 | @item unix:@var{path}[,server][,nowait][,reconnect=@var{seconds}] |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 2730 | A unix domain socket is used instead of a tcp socket. The option works the |
| 2731 | same as if you had specified @code{-serial tcp} except the unix domain socket |
| 2732 | @var{path} is used for connections. |
| 2733 | |
| 2734 | @item mon:@var{dev_string} |
| 2735 | This is a special option to allow the monitor to be multiplexed onto |
| 2736 | another serial port. The monitor is accessed with key sequence of |
Paolo Bonzini | 02c4bdf | 2013-07-03 20:29:45 +0400 | [diff] [blame] | 2737 | @key{Control-a} and then pressing @key{c}. |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 2738 | @var{dev_string} should be any one of the serial devices specified |
| 2739 | above. An example to multiplex the monitor onto a telnet server |
| 2740 | listening on port 4444 would be: |
| 2741 | @table @code |
| 2742 | @item -serial mon:telnet::4444,server,nowait |
| 2743 | @end table |
Michael Tokarev | be022d6 | 2013-07-11 12:55:50 +0400 | [diff] [blame] | 2744 | When the monitor is multiplexed to stdio in this way, Ctrl+C will not terminate |
| 2745 | QEMU any more but will be passed to the guest instead. |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 2746 | |
| 2747 | @item braille |
| 2748 | Braille device. This will use BrlAPI to display the braille output on a real |
| 2749 | or fake device. |
| 2750 | |
Kevin Wolf | be8b28a | 2009-10-09 10:58:37 +0200 | [diff] [blame] | 2751 | @item msmouse |
| 2752 | Three button serial mouse. Configure the guest to use Microsoft protocol. |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 2753 | @end table |
| 2754 | ETEXI |
| 2755 | |
| 2756 | DEF("parallel", HAS_ARG, QEMU_OPTION_parallel, \ |
Blue Swirl | ad96090 | 2010-03-29 19:23:52 +0000 | [diff] [blame] | 2757 | "-parallel dev redirect the parallel port to char device 'dev'\n", |
| 2758 | QEMU_ARCH_ALL) |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 2759 | STEXI |
| 2760 | @item -parallel @var{dev} |
Stefan Weil | 6616b2a | 2010-02-05 23:52:05 +0100 | [diff] [blame] | 2761 | @findex -parallel |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 2762 | Redirect the virtual parallel port to host device @var{dev} (same |
| 2763 | devices as the serial port). On Linux hosts, @file{/dev/parportN} can |
| 2764 | be used to use hardware devices connected on the corresponding host |
| 2765 | parallel port. |
| 2766 | |
| 2767 | This option can be used several times to simulate up to 3 parallel |
| 2768 | ports. |
| 2769 | |
| 2770 | Use @code{-parallel none} to disable all parallel ports. |
| 2771 | ETEXI |
| 2772 | |
| 2773 | DEF("monitor", HAS_ARG, QEMU_OPTION_monitor, \ |
Blue Swirl | ad96090 | 2010-03-29 19:23:52 +0000 | [diff] [blame] | 2774 | "-monitor dev redirect the monitor to char device 'dev'\n", |
| 2775 | QEMU_ARCH_ALL) |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 2776 | STEXI |
Gerd Hoffmann | 4e307fc | 2009-12-08 13:11:37 +0100 | [diff] [blame] | 2777 | @item -monitor @var{dev} |
Stefan Weil | 6616b2a | 2010-02-05 23:52:05 +0100 | [diff] [blame] | 2778 | @findex -monitor |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 2779 | Redirect the monitor to host device @var{dev} (same devices as the |
| 2780 | serial port). |
| 2781 | The default device is @code{vc} in graphical mode and @code{stdio} in |
| 2782 | non graphical mode. |
Luiz Capitulino | 70e098a | 2013-05-16 12:02:55 -0400 | [diff] [blame] | 2783 | Use @code{-monitor none} to disable the default monitor. |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 2784 | ETEXI |
Gerd Hoffmann | 6ca5582 | 2009-12-08 13:11:52 +0100 | [diff] [blame] | 2785 | DEF("qmp", HAS_ARG, QEMU_OPTION_qmp, \ |
Blue Swirl | ad96090 | 2010-03-29 19:23:52 +0000 | [diff] [blame] | 2786 | "-qmp dev like -monitor but opens in 'control' mode\n", |
| 2787 | QEMU_ARCH_ALL) |
Stefan Weil | 95d5f08 | 2010-01-20 22:25:27 +0100 | [diff] [blame] | 2788 | STEXI |
| 2789 | @item -qmp @var{dev} |
Stefan Weil | 6616b2a | 2010-02-05 23:52:05 +0100 | [diff] [blame] | 2790 | @findex -qmp |
Stefan Weil | 95d5f08 | 2010-01-20 22:25:27 +0100 | [diff] [blame] | 2791 | Like -monitor but opens in 'control' mode. |
| 2792 | ETEXI |
Max Reitz | 4821cd4 | 2014-11-17 13:31:04 +0100 | [diff] [blame] | 2793 | DEF("qmp-pretty", HAS_ARG, QEMU_OPTION_qmp_pretty, \ |
| 2794 | "-qmp-pretty dev like -qmp but uses pretty JSON formatting\n", |
| 2795 | QEMU_ARCH_ALL) |
| 2796 | STEXI |
| 2797 | @item -qmp-pretty @var{dev} |
| 2798 | @findex -qmp-pretty |
| 2799 | Like -qmp but uses pretty JSON formatting. |
| 2800 | ETEXI |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 2801 | |
Gerd Hoffmann | 22a0e04 | 2009-12-08 13:11:51 +0100 | [diff] [blame] | 2802 | DEF("mon", HAS_ARG, QEMU_OPTION_mon, \ |
Michael Tokarev | f17e4ea | 2013-06-15 13:47:32 +0400 | [diff] [blame] | 2803 | "-mon [chardev=]name[,mode=readline|control][,default]\n", QEMU_ARCH_ALL) |
Gerd Hoffmann | 22a0e04 | 2009-12-08 13:11:51 +0100 | [diff] [blame] | 2804 | STEXI |
Michael Tokarev | f17e4ea | 2013-06-15 13:47:32 +0400 | [diff] [blame] | 2805 | @item -mon [chardev=]name[,mode=readline|control][,default] |
Stefan Weil | 6616b2a | 2010-02-05 23:52:05 +0100 | [diff] [blame] | 2806 | @findex -mon |
Gerd Hoffmann | 22a0e04 | 2009-12-08 13:11:51 +0100 | [diff] [blame] | 2807 | Setup monitor on chardev @var{name}. |
| 2808 | ETEXI |
| 2809 | |
H. Peter Anvin | c9f398e | 2009-12-29 13:51:36 -0800 | [diff] [blame] | 2810 | DEF("debugcon", HAS_ARG, QEMU_OPTION_debugcon, \ |
Blue Swirl | ad96090 | 2010-03-29 19:23:52 +0000 | [diff] [blame] | 2811 | "-debugcon dev redirect the debug console to char device 'dev'\n", |
| 2812 | QEMU_ARCH_ALL) |
H. Peter Anvin | c9f398e | 2009-12-29 13:51:36 -0800 | [diff] [blame] | 2813 | STEXI |
| 2814 | @item -debugcon @var{dev} |
Stefan Weil | 6616b2a | 2010-02-05 23:52:05 +0100 | [diff] [blame] | 2815 | @findex -debugcon |
H. Peter Anvin | c9f398e | 2009-12-29 13:51:36 -0800 | [diff] [blame] | 2816 | Redirect the debug console to host device @var{dev} (same devices as the |
| 2817 | serial port). The debug console is an I/O port which is typically port |
| 2818 | 0xe9; writing to that I/O port sends output to this device. |
| 2819 | The default device is @code{vc} in graphical mode and @code{stdio} in |
| 2820 | non graphical mode. |
| 2821 | ETEXI |
| 2822 | |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 2823 | DEF("pidfile", HAS_ARG, QEMU_OPTION_pidfile, \ |
Blue Swirl | ad96090 | 2010-03-29 19:23:52 +0000 | [diff] [blame] | 2824 | "-pidfile file write PID to 'file'\n", QEMU_ARCH_ALL) |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 2825 | STEXI |
| 2826 | @item -pidfile @var{file} |
Stefan Weil | 6616b2a | 2010-02-05 23:52:05 +0100 | [diff] [blame] | 2827 | @findex -pidfile |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 2828 | Store the QEMU process PID in @var{file}. It is useful if you launch QEMU |
| 2829 | from a script. |
| 2830 | ETEXI |
| 2831 | |
aurel32 | 1b530a6 | 2009-04-05 20:08:59 +0000 | [diff] [blame] | 2832 | DEF("singlestep", 0, QEMU_OPTION_singlestep, \ |
Blue Swirl | ad96090 | 2010-03-29 19:23:52 +0000 | [diff] [blame] | 2833 | "-singlestep always run in singlestep mode\n", QEMU_ARCH_ALL) |
aurel32 | 1b530a6 | 2009-04-05 20:08:59 +0000 | [diff] [blame] | 2834 | STEXI |
| 2835 | @item -singlestep |
Stefan Weil | 6616b2a | 2010-02-05 23:52:05 +0100 | [diff] [blame] | 2836 | @findex -singlestep |
aurel32 | 1b530a6 | 2009-04-05 20:08:59 +0000 | [diff] [blame] | 2837 | Run the emulation in single step mode. |
| 2838 | ETEXI |
| 2839 | |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 2840 | DEF("S", 0, QEMU_OPTION_S, \ |
Blue Swirl | ad96090 | 2010-03-29 19:23:52 +0000 | [diff] [blame] | 2841 | "-S freeze CPU at startup (use 'c' to start execution)\n", |
| 2842 | QEMU_ARCH_ALL) |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 2843 | STEXI |
| 2844 | @item -S |
Stefan Weil | 6616b2a | 2010-02-05 23:52:05 +0100 | [diff] [blame] | 2845 | @findex -S |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 2846 | Do not start CPU at startup (you must type 'c' in the monitor). |
| 2847 | ETEXI |
| 2848 | |
Satoru Moriya | 888a6bc | 2013-04-19 16:42:06 +0200 | [diff] [blame] | 2849 | DEF("realtime", HAS_ARG, QEMU_OPTION_realtime, |
| 2850 | "-realtime [mlock=on|off]\n" |
| 2851 | " run qemu with realtime features\n" |
| 2852 | " mlock=on|off controls mlock support (default: on)\n", |
| 2853 | QEMU_ARCH_ALL) |
| 2854 | STEXI |
| 2855 | @item -realtime mlock=on|off |
| 2856 | @findex -realtime |
| 2857 | Run qemu with realtime features. |
| 2858 | mlocking qemu and guest memory can be enabled via @option{mlock=on} |
| 2859 | (enabled by default). |
| 2860 | ETEXI |
| 2861 | |
aliguori | 59030a8 | 2009-04-05 18:43:41 +0000 | [diff] [blame] | 2862 | DEF("gdb", HAS_ARG, QEMU_OPTION_gdb, \ |
Blue Swirl | ad96090 | 2010-03-29 19:23:52 +0000 | [diff] [blame] | 2863 | "-gdb dev wait for gdb connection on 'dev'\n", QEMU_ARCH_ALL) |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 2864 | STEXI |
aliguori | 59030a8 | 2009-04-05 18:43:41 +0000 | [diff] [blame] | 2865 | @item -gdb @var{dev} |
Stefan Weil | 6616b2a | 2010-02-05 23:52:05 +0100 | [diff] [blame] | 2866 | @findex -gdb |
aliguori | 59030a8 | 2009-04-05 18:43:41 +0000 | [diff] [blame] | 2867 | Wait for gdb connection on device @var{dev} (@pxref{gdb_usage}). Typical |
| 2868 | connections will likely be TCP-based, but also UDP, pseudo TTY, or even |
Stefan Weil | b65ee4f | 2012-05-11 22:25:50 +0200 | [diff] [blame] | 2869 | stdio are reasonable use case. The latter is allowing to start QEMU from |
aliguori | 59030a8 | 2009-04-05 18:43:41 +0000 | [diff] [blame] | 2870 | within gdb and establish the connection via a pipe: |
| 2871 | @example |
Stefan Weil | 3804da9 | 2012-05-11 22:21:50 +0200 | [diff] [blame] | 2872 | (gdb) target remote | exec qemu-system-i386 -gdb stdio ... |
aliguori | 59030a8 | 2009-04-05 18:43:41 +0000 | [diff] [blame] | 2873 | @end example |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 2874 | ETEXI |
| 2875 | |
aliguori | 59030a8 | 2009-04-05 18:43:41 +0000 | [diff] [blame] | 2876 | DEF("s", 0, QEMU_OPTION_s, \ |
Blue Swirl | ad96090 | 2010-03-29 19:23:52 +0000 | [diff] [blame] | 2877 | "-s shorthand for -gdb tcp::" DEFAULT_GDBSTUB_PORT "\n", |
| 2878 | QEMU_ARCH_ALL) |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 2879 | STEXI |
aliguori | 59030a8 | 2009-04-05 18:43:41 +0000 | [diff] [blame] | 2880 | @item -s |
Stefan Weil | 6616b2a | 2010-02-05 23:52:05 +0100 | [diff] [blame] | 2881 | @findex -s |
aliguori | 59030a8 | 2009-04-05 18:43:41 +0000 | [diff] [blame] | 2882 | Shorthand for -gdb tcp::1234, i.e. open a gdbserver on TCP port 1234 |
| 2883 | (@pxref{gdb_usage}). |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 2884 | ETEXI |
| 2885 | |
| 2886 | DEF("d", HAS_ARG, QEMU_OPTION_d, \ |
Peter Maydell | 989b697 | 2013-02-26 17:52:40 +0000 | [diff] [blame] | 2887 | "-d item1,... enable logging of specified items (use '-d help' for a list of log items)\n", |
Blue Swirl | ad96090 | 2010-03-29 19:23:52 +0000 | [diff] [blame] | 2888 | QEMU_ARCH_ALL) |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 2889 | STEXI |
Peter Maydell | 989b697 | 2013-02-26 17:52:40 +0000 | [diff] [blame] | 2890 | @item -d @var{item1}[,...] |
Stefan Weil | 6616b2a | 2010-02-05 23:52:05 +0100 | [diff] [blame] | 2891 | @findex -d |
Peter Maydell | 989b697 | 2013-02-26 17:52:40 +0000 | [diff] [blame] | 2892 | Enable logging of specified items. Use '-d help' for a list of log items. |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 2893 | ETEXI |
| 2894 | |
Matthew Fernandez | c235d73 | 2011-06-07 16:32:40 +0000 | [diff] [blame] | 2895 | DEF("D", HAS_ARG, QEMU_OPTION_D, \ |
Peter Maydell | 989b697 | 2013-02-26 17:52:40 +0000 | [diff] [blame] | 2896 | "-D logfile output log to logfile (default stderr)\n", |
Matthew Fernandez | c235d73 | 2011-06-07 16:32:40 +0000 | [diff] [blame] | 2897 | QEMU_ARCH_ALL) |
| 2898 | STEXI |
Stefan Weil | 8bd383b | 2012-05-11 22:40:50 +0200 | [diff] [blame] | 2899 | @item -D @var{logfile} |
Matthew Fernandez | c235d73 | 2011-06-07 16:32:40 +0000 | [diff] [blame] | 2900 | @findex -D |
Peter Maydell | 989b697 | 2013-02-26 17:52:40 +0000 | [diff] [blame] | 2901 | Output log in @var{logfile} instead of to stderr |
Matthew Fernandez | c235d73 | 2011-06-07 16:32:40 +0000 | [diff] [blame] | 2902 | ETEXI |
| 2903 | |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 2904 | DEF("L", HAS_ARG, QEMU_OPTION_L, \ |
Blue Swirl | ad96090 | 2010-03-29 19:23:52 +0000 | [diff] [blame] | 2905 | "-L path set the directory for the BIOS, VGA BIOS and keymaps\n", |
| 2906 | QEMU_ARCH_ALL) |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 2907 | STEXI |
| 2908 | @item -L @var{path} |
Stefan Weil | 6616b2a | 2010-02-05 23:52:05 +0100 | [diff] [blame] | 2909 | @findex -L |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 2910 | Set the directory for the BIOS, VGA BIOS and keymaps. |
| 2911 | ETEXI |
| 2912 | |
| 2913 | DEF("bios", HAS_ARG, QEMU_OPTION_bios, \ |
Blue Swirl | ad96090 | 2010-03-29 19:23:52 +0000 | [diff] [blame] | 2914 | "-bios file set the filename for the BIOS\n", QEMU_ARCH_ALL) |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 2915 | STEXI |
| 2916 | @item -bios @var{file} |
Stefan Weil | 6616b2a | 2010-02-05 23:52:05 +0100 | [diff] [blame] | 2917 | @findex -bios |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 2918 | Set the filename for the BIOS. |
| 2919 | ETEXI |
| 2920 | |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 2921 | DEF("enable-kvm", 0, QEMU_OPTION_enable_kvm, \ |
Blue Swirl | ad96090 | 2010-03-29 19:23:52 +0000 | [diff] [blame] | 2922 | "-enable-kvm enable KVM full virtualization support\n", QEMU_ARCH_ALL) |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 2923 | STEXI |
| 2924 | @item -enable-kvm |
Stefan Weil | 6616b2a | 2010-02-05 23:52:05 +0100 | [diff] [blame] | 2925 | @findex -enable-kvm |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 2926 | Enable KVM full virtualization support. This option is only available |
| 2927 | if KVM support is enabled when compiling. |
| 2928 | ETEXI |
| 2929 | |
aliguori | e37630c | 2009-04-22 15:19:10 +0000 | [diff] [blame] | 2930 | DEF("xen-domid", HAS_ARG, QEMU_OPTION_xen_domid, |
Blue Swirl | ad96090 | 2010-03-29 19:23:52 +0000 | [diff] [blame] | 2931 | "-xen-domid id specify xen guest domain id\n", QEMU_ARCH_ALL) |
aliguori | e37630c | 2009-04-22 15:19:10 +0000 | [diff] [blame] | 2932 | DEF("xen-create", 0, QEMU_OPTION_xen_create, |
| 2933 | "-xen-create create domain using xen hypercalls, bypassing xend\n" |
Blue Swirl | ad96090 | 2010-03-29 19:23:52 +0000 | [diff] [blame] | 2934 | " warning: should not be used when xend is in use\n", |
| 2935 | QEMU_ARCH_ALL) |
aliguori | e37630c | 2009-04-22 15:19:10 +0000 | [diff] [blame] | 2936 | DEF("xen-attach", 0, QEMU_OPTION_xen_attach, |
| 2937 | "-xen-attach attach to existing xen domain\n" |
Stefan Weil | b65ee4f | 2012-05-11 22:25:50 +0200 | [diff] [blame] | 2938 | " xend will use this when starting QEMU\n", |
Blue Swirl | ad96090 | 2010-03-29 19:23:52 +0000 | [diff] [blame] | 2939 | QEMU_ARCH_ALL) |
Stefan Weil | 95d5f08 | 2010-01-20 22:25:27 +0100 | [diff] [blame] | 2940 | STEXI |
| 2941 | @item -xen-domid @var{id} |
Stefan Weil | 6616b2a | 2010-02-05 23:52:05 +0100 | [diff] [blame] | 2942 | @findex -xen-domid |
Stefan Weil | 95d5f08 | 2010-01-20 22:25:27 +0100 | [diff] [blame] | 2943 | Specify xen guest domain @var{id} (XEN only). |
| 2944 | @item -xen-create |
Stefan Weil | 6616b2a | 2010-02-05 23:52:05 +0100 | [diff] [blame] | 2945 | @findex -xen-create |
Stefan Weil | 95d5f08 | 2010-01-20 22:25:27 +0100 | [diff] [blame] | 2946 | Create domain using xen hypercalls, bypassing xend. |
| 2947 | Warning: should not be used when xend is in use (XEN only). |
| 2948 | @item -xen-attach |
Stefan Weil | 6616b2a | 2010-02-05 23:52:05 +0100 | [diff] [blame] | 2949 | @findex -xen-attach |
Stefan Weil | 95d5f08 | 2010-01-20 22:25:27 +0100 | [diff] [blame] | 2950 | Attach to existing xen domain. |
Stefan Weil | b65ee4f | 2012-05-11 22:25:50 +0200 | [diff] [blame] | 2951 | xend will use this when starting QEMU (XEN only). |
Stefan Weil | 95d5f08 | 2010-01-20 22:25:27 +0100 | [diff] [blame] | 2952 | ETEXI |
aliguori | e37630c | 2009-04-22 15:19:10 +0000 | [diff] [blame] | 2953 | |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 2954 | DEF("no-reboot", 0, QEMU_OPTION_no_reboot, \ |
Blue Swirl | ad96090 | 2010-03-29 19:23:52 +0000 | [diff] [blame] | 2955 | "-no-reboot exit instead of rebooting\n", QEMU_ARCH_ALL) |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 2956 | STEXI |
| 2957 | @item -no-reboot |
Stefan Weil | 6616b2a | 2010-02-05 23:52:05 +0100 | [diff] [blame] | 2958 | @findex -no-reboot |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 2959 | Exit instead of rebooting. |
| 2960 | ETEXI |
| 2961 | |
| 2962 | DEF("no-shutdown", 0, QEMU_OPTION_no_shutdown, \ |
Blue Swirl | ad96090 | 2010-03-29 19:23:52 +0000 | [diff] [blame] | 2963 | "-no-shutdown stop before shutdown\n", QEMU_ARCH_ALL) |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 2964 | STEXI |
| 2965 | @item -no-shutdown |
Stefan Weil | 6616b2a | 2010-02-05 23:52:05 +0100 | [diff] [blame] | 2966 | @findex -no-shutdown |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 2967 | Don't exit QEMU on guest shutdown, but instead only stop the emulation. |
| 2968 | This allows for instance switching to monitor to commit changes to the |
| 2969 | disk image. |
| 2970 | ETEXI |
| 2971 | |
| 2972 | DEF("loadvm", HAS_ARG, QEMU_OPTION_loadvm, \ |
| 2973 | "-loadvm [tag|id]\n" \ |
Blue Swirl | ad96090 | 2010-03-29 19:23:52 +0000 | [diff] [blame] | 2974 | " start right away with a saved state (loadvm in monitor)\n", |
| 2975 | QEMU_ARCH_ALL) |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 2976 | STEXI |
| 2977 | @item -loadvm @var{file} |
Stefan Weil | 6616b2a | 2010-02-05 23:52:05 +0100 | [diff] [blame] | 2978 | @findex -loadvm |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 2979 | Start right away with a saved state (@code{loadvm} in monitor) |
| 2980 | ETEXI |
| 2981 | |
| 2982 | #ifndef _WIN32 |
| 2983 | DEF("daemonize", 0, QEMU_OPTION_daemonize, \ |
Blue Swirl | ad96090 | 2010-03-29 19:23:52 +0000 | [diff] [blame] | 2984 | "-daemonize daemonize QEMU after initializing\n", QEMU_ARCH_ALL) |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 2985 | #endif |
| 2986 | STEXI |
| 2987 | @item -daemonize |
Stefan Weil | 6616b2a | 2010-02-05 23:52:05 +0100 | [diff] [blame] | 2988 | @findex -daemonize |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 2989 | Daemonize the QEMU process after initialization. QEMU will not detach from |
| 2990 | standard IO until it is ready to receive connections on any of its devices. |
| 2991 | This option is a useful way for external programs to launch QEMU without having |
| 2992 | to cope with initialization race conditions. |
| 2993 | ETEXI |
| 2994 | |
| 2995 | DEF("option-rom", HAS_ARG, QEMU_OPTION_option_rom, \ |
Blue Swirl | ad96090 | 2010-03-29 19:23:52 +0000 | [diff] [blame] | 2996 | "-option-rom rom load a file, rom, into the option ROM space\n", |
| 2997 | QEMU_ARCH_ALL) |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 2998 | STEXI |
| 2999 | @item -option-rom @var{file} |
Stefan Weil | 6616b2a | 2010-02-05 23:52:05 +0100 | [diff] [blame] | 3000 | @findex -option-rom |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 3001 | Load the contents of @var{file} as an option ROM. |
| 3002 | This option is useful to load things like EtherBoot. |
| 3003 | ETEXI |
| 3004 | |
Markus Armbruster | e218052 | 2014-10-06 16:19:07 +0200 | [diff] [blame] | 3005 | HXCOMM Silently ignored for compatibility |
| 3006 | DEF("clock", HAS_ARG, QEMU_OPTION_clock, "", QEMU_ARCH_ALL) |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 3007 | |
Jan Kiszka | 1ed2fc1 | 2009-09-15 13:36:04 +0200 | [diff] [blame] | 3008 | HXCOMM Options deprecated by -rtc |
Blue Swirl | ad96090 | 2010-03-29 19:23:52 +0000 | [diff] [blame] | 3009 | DEF("localtime", 0, QEMU_OPTION_localtime, "", QEMU_ARCH_ALL) |
| 3010 | DEF("startdate", HAS_ARG, QEMU_OPTION_startdate, "", QEMU_ARCH_ALL) |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 3011 | |
Jan Kiszka | 1ed2fc1 | 2009-09-15 13:36:04 +0200 | [diff] [blame] | 3012 | DEF("rtc", HAS_ARG, QEMU_OPTION_rtc, \ |
Paolo Bonzini | 7880814 | 2012-03-30 10:31:21 +0000 | [diff] [blame] | 3013 | "-rtc [base=utc|localtime|date][,clock=host|rt|vm][,driftfix=none|slew]\n" \ |
Blue Swirl | ad96090 | 2010-03-29 19:23:52 +0000 | [diff] [blame] | 3014 | " set the RTC base and clock, enable drift fix for clock ticks (x86 only)\n", |
| 3015 | QEMU_ARCH_ALL) |
Jan Kiszka | 1ed2fc1 | 2009-09-15 13:36:04 +0200 | [diff] [blame] | 3016 | |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 3017 | STEXI |
| 3018 | |
Jan Kiszka | 6875204 | 2009-09-15 13:36:04 +0200 | [diff] [blame] | 3019 | @item -rtc [base=utc|localtime|@var{date}][,clock=host|vm][,driftfix=none|slew] |
Stefan Weil | 6616b2a | 2010-02-05 23:52:05 +0100 | [diff] [blame] | 3020 | @findex -rtc |
Jan Kiszka | 1ed2fc1 | 2009-09-15 13:36:04 +0200 | [diff] [blame] | 3021 | Specify @option{base} as @code{utc} or @code{localtime} to let the RTC start at the current |
| 3022 | UTC or local time, respectively. @code{localtime} is required for correct date in |
| 3023 | MS-DOS or Windows. To start at a specific point in time, provide @var{date} in the |
| 3024 | format @code{2006-06-17T16:01:21} or @code{2006-06-17}. The default base is UTC. |
| 3025 | |
Michael Tokarev | 9d85d55 | 2014-04-07 13:34:58 +0400 | [diff] [blame] | 3026 | By default the RTC is driven by the host system time. This allows using of the |
Jan Kiszka | 6875204 | 2009-09-15 13:36:04 +0200 | [diff] [blame] | 3027 | RTC as accurate reference clock inside the guest, specifically if the host |
| 3028 | time is smoothly following an accurate external reference clock, e.g. via NTP. |
Paolo Bonzini | 7880814 | 2012-03-30 10:31:21 +0000 | [diff] [blame] | 3029 | If you want to isolate the guest time from the host, you can set @option{clock} |
| 3030 | to @code{rt} instead. To even prevent it from progressing during suspension, |
| 3031 | you can set it to @code{vm}. |
Jan Kiszka | 6875204 | 2009-09-15 13:36:04 +0200 | [diff] [blame] | 3032 | |
Jan Kiszka | 1ed2fc1 | 2009-09-15 13:36:04 +0200 | [diff] [blame] | 3033 | Enable @option{driftfix} (i386 targets only) if you experience time drift problems, |
| 3034 | specifically with Windows' ACPI HAL. This option will try to figure out how |
| 3035 | many timer interrupts were not processed by the Windows guest and will |
| 3036 | re-inject them. |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 3037 | ETEXI |
| 3038 | |
| 3039 | DEF("icount", HAS_ARG, QEMU_OPTION_icount, \ |
Sebastian Tanase | a8bfac3 | 2014-07-25 11:56:29 +0200 | [diff] [blame] | 3040 | "-icount [shift=N|auto][,align=on|off]\n" \ |
aliguori | bc14ca2 | 2009-04-05 18:43:37 +0000 | [diff] [blame] | 3041 | " enable virtual instruction counter with 2^N clock ticks per\n" \ |
Sebastian Tanase | a8bfac3 | 2014-07-25 11:56:29 +0200 | [diff] [blame] | 3042 | " instruction and enable aligning the host and virtual clocks\n", QEMU_ARCH_ALL) |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 3043 | STEXI |
Sebastian Tanase | 1ad9580 | 2014-07-25 11:56:28 +0200 | [diff] [blame] | 3044 | @item -icount [shift=@var{N}|auto] |
Stefan Weil | 6616b2a | 2010-02-05 23:52:05 +0100 | [diff] [blame] | 3045 | @findex -icount |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 3046 | Enable virtual instruction counter. The virtual cpu will execute one |
Kevin Wolf | 4e257e5 | 2009-10-09 10:58:36 +0200 | [diff] [blame] | 3047 | instruction every 2^@var{N} ns of virtual time. If @code{auto} is specified |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 3048 | then the virtual cpu speed will be automatically adjusted to keep virtual |
| 3049 | time within a few seconds of real time. |
| 3050 | |
| 3051 | Note that while this option can give deterministic behavior, it does not |
| 3052 | provide cycle accurate emulation. Modern CPUs contain superscalar out of |
| 3053 | order cores with complex cache hierarchies. The number of instructions |
| 3054 | executed often has little or no correlation with actual performance. |
Sebastian Tanase | a8bfac3 | 2014-07-25 11:56:29 +0200 | [diff] [blame] | 3055 | |
| 3056 | @option{align=on} will activate the delay algorithm which will try to |
| 3057 | to synchronise the host clock and the virtual clock. The goal is to |
| 3058 | have a guest running at the real frequency imposed by the shift option. |
| 3059 | Whenever the guest clock is behind the host clock and if |
| 3060 | @option{align=on} is specified then we print a messsage to the user |
| 3061 | to inform about the delay. |
| 3062 | Currently this option does not work when @option{shift} is @code{auto}. |
| 3063 | Note: The sync algorithm will work for those shift values for which |
| 3064 | the guest clock runs ahead of the host clock. Typically this happens |
| 3065 | when the shift value is high (how high depends on the host machine). |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 3066 | ETEXI |
| 3067 | |
Richard W.M. Jones | 9dd986c | 2009-04-25 13:56:19 +0100 | [diff] [blame] | 3068 | DEF("watchdog", HAS_ARG, QEMU_OPTION_watchdog, \ |
| 3069 | "-watchdog i6300esb|ib700\n" \ |
Blue Swirl | ad96090 | 2010-03-29 19:23:52 +0000 | [diff] [blame] | 3070 | " enable virtual hardware watchdog [default=none]\n", |
| 3071 | QEMU_ARCH_ALL) |
Richard W.M. Jones | 9dd986c | 2009-04-25 13:56:19 +0100 | [diff] [blame] | 3072 | STEXI |
| 3073 | @item -watchdog @var{model} |
Stefan Weil | 6616b2a | 2010-02-05 23:52:05 +0100 | [diff] [blame] | 3074 | @findex -watchdog |
Richard W.M. Jones | 9dd986c | 2009-04-25 13:56:19 +0100 | [diff] [blame] | 3075 | Create a virtual hardware watchdog device. Once enabled (by a guest |
| 3076 | action), the watchdog must be periodically polled by an agent inside |
| 3077 | the guest or else the guest will be restarted. |
| 3078 | |
| 3079 | The @var{model} is the model of hardware watchdog to emulate. Choices |
| 3080 | for model are: @code{ib700} (iBASE 700) which is a very simple ISA |
| 3081 | watchdog with a single timer, or @code{i6300esb} (Intel 6300ESB I/O |
| 3082 | controller hub) which is a much more featureful PCI-based dual-timer |
| 3083 | watchdog. Choose a model for which your guest has drivers. |
| 3084 | |
Peter Maydell | 585f603 | 2012-10-04 16:22:01 +0100 | [diff] [blame] | 3085 | Use @code{-watchdog help} to list available hardware models. Only one |
Richard W.M. Jones | 9dd986c | 2009-04-25 13:56:19 +0100 | [diff] [blame] | 3086 | watchdog can be enabled for a guest. |
| 3087 | ETEXI |
| 3088 | |
| 3089 | DEF("watchdog-action", HAS_ARG, QEMU_OPTION_watchdog_action, \ |
| 3090 | "-watchdog-action reset|shutdown|poweroff|pause|debug|none\n" \ |
Blue Swirl | ad96090 | 2010-03-29 19:23:52 +0000 | [diff] [blame] | 3091 | " action when watchdog fires [default=reset]\n", |
| 3092 | QEMU_ARCH_ALL) |
Richard W.M. Jones | 9dd986c | 2009-04-25 13:56:19 +0100 | [diff] [blame] | 3093 | STEXI |
| 3094 | @item -watchdog-action @var{action} |
Markus Armbruster | b8f490e | 2013-02-13 19:49:38 +0100 | [diff] [blame] | 3095 | @findex -watchdog-action |
Richard W.M. Jones | 9dd986c | 2009-04-25 13:56:19 +0100 | [diff] [blame] | 3096 | |
| 3097 | The @var{action} controls what QEMU will do when the watchdog timer |
| 3098 | expires. |
| 3099 | The default is |
| 3100 | @code{reset} (forcefully reset the guest). |
| 3101 | Other possible actions are: |
| 3102 | @code{shutdown} (attempt to gracefully shutdown the guest), |
| 3103 | @code{poweroff} (forcefully poweroff the guest), |
| 3104 | @code{pause} (pause the guest), |
| 3105 | @code{debug} (print a debug message and continue), or |
| 3106 | @code{none} (do nothing). |
| 3107 | |
| 3108 | Note that the @code{shutdown} action requires that the guest responds |
| 3109 | to ACPI signals, which it may not be able to do in the sort of |
| 3110 | situations where the watchdog would have expired, and thus |
| 3111 | @code{-watchdog-action shutdown} is not recommended for production use. |
| 3112 | |
| 3113 | Examples: |
| 3114 | |
| 3115 | @table @code |
| 3116 | @item -watchdog i6300esb -watchdog-action pause |
| 3117 | @item -watchdog ib700 |
| 3118 | @end table |
| 3119 | ETEXI |
| 3120 | |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 3121 | DEF("echr", HAS_ARG, QEMU_OPTION_echr, \ |
Blue Swirl | ad96090 | 2010-03-29 19:23:52 +0000 | [diff] [blame] | 3122 | "-echr chr set terminal escape character instead of ctrl-a\n", |
| 3123 | QEMU_ARCH_ALL) |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 3124 | STEXI |
| 3125 | |
Kevin Wolf | 4e257e5 | 2009-10-09 10:58:36 +0200 | [diff] [blame] | 3126 | @item -echr @var{numeric_ascii_value} |
Stefan Weil | 6616b2a | 2010-02-05 23:52:05 +0100 | [diff] [blame] | 3127 | @findex -echr |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 3128 | Change the escape character used for switching to the monitor when using |
| 3129 | monitor and serial sharing. The default is @code{0x01} when using the |
| 3130 | @code{-nographic} option. @code{0x01} is equal to pressing |
| 3131 | @code{Control-a}. You can select a different character from the ascii |
| 3132 | control keys where 1 through 26 map to Control-a through Control-z. For |
| 3133 | instance you could use the either of the following to change the escape |
| 3134 | character to Control-t. |
| 3135 | @table @code |
| 3136 | @item -echr 0x14 |
| 3137 | @item -echr 20 |
| 3138 | @end table |
| 3139 | ETEXI |
| 3140 | |
| 3141 | DEF("virtioconsole", HAS_ARG, QEMU_OPTION_virtiocon, \ |
| 3142 | "-virtioconsole c\n" \ |
Blue Swirl | ad96090 | 2010-03-29 19:23:52 +0000 | [diff] [blame] | 3143 | " set virtio console\n", QEMU_ARCH_ALL) |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 3144 | STEXI |
| 3145 | @item -virtioconsole @var{c} |
Stefan Weil | 6616b2a | 2010-02-05 23:52:05 +0100 | [diff] [blame] | 3146 | @findex -virtioconsole |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 3147 | Set virtio console. |
Amit Shah | 98b1925 | 2010-01-20 00:36:52 +0530 | [diff] [blame] | 3148 | |
| 3149 | This option is maintained for backward compatibility. |
| 3150 | |
| 3151 | Please use @code{-device virtconsole} for the new way of invocation. |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 3152 | ETEXI |
| 3153 | |
| 3154 | DEF("show-cursor", 0, QEMU_OPTION_show_cursor, \ |
Blue Swirl | ad96090 | 2010-03-29 19:23:52 +0000 | [diff] [blame] | 3155 | "-show-cursor show cursor\n", QEMU_ARCH_ALL) |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 3156 | STEXI |
Stefan Weil | 95d5f08 | 2010-01-20 22:25:27 +0100 | [diff] [blame] | 3157 | @item -show-cursor |
Stefan Weil | 6616b2a | 2010-02-05 23:52:05 +0100 | [diff] [blame] | 3158 | @findex -show-cursor |
Stefan Weil | 95d5f08 | 2010-01-20 22:25:27 +0100 | [diff] [blame] | 3159 | Show cursor. |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 3160 | ETEXI |
| 3161 | |
| 3162 | DEF("tb-size", HAS_ARG, QEMU_OPTION_tb_size, \ |
Blue Swirl | ad96090 | 2010-03-29 19:23:52 +0000 | [diff] [blame] | 3163 | "-tb-size n set TB size\n", QEMU_ARCH_ALL) |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 3164 | STEXI |
Stefan Weil | 95d5f08 | 2010-01-20 22:25:27 +0100 | [diff] [blame] | 3165 | @item -tb-size @var{n} |
Stefan Weil | 6616b2a | 2010-02-05 23:52:05 +0100 | [diff] [blame] | 3166 | @findex -tb-size |
Stefan Weil | 95d5f08 | 2010-01-20 22:25:27 +0100 | [diff] [blame] | 3167 | Set TB size. |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 3168 | ETEXI |
| 3169 | |
| 3170 | DEF("incoming", HAS_ARG, QEMU_OPTION_incoming, \ |
Blue Swirl | ad96090 | 2010-03-29 19:23:52 +0000 | [diff] [blame] | 3171 | "-incoming p prepare for incoming migration, listen on port p\n", |
| 3172 | QEMU_ARCH_ALL) |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 3173 | STEXI |
Stefan Weil | 95d5f08 | 2010-01-20 22:25:27 +0100 | [diff] [blame] | 3174 | @item -incoming @var{port} |
Stefan Weil | 6616b2a | 2010-02-05 23:52:05 +0100 | [diff] [blame] | 3175 | @findex -incoming |
Stefan Weil | 95d5f08 | 2010-01-20 22:25:27 +0100 | [diff] [blame] | 3176 | Prepare for incoming migration, listen on @var{port}. |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 3177 | ETEXI |
| 3178 | |
Gerd Hoffmann | d8c208d | 2009-12-08 13:11:46 +0100 | [diff] [blame] | 3179 | DEF("nodefaults", 0, QEMU_OPTION_nodefaults, \ |
Blue Swirl | ad96090 | 2010-03-29 19:23:52 +0000 | [diff] [blame] | 3180 | "-nodefaults don't create default devices\n", QEMU_ARCH_ALL) |
Gerd Hoffmann | d8c208d | 2009-12-08 13:11:46 +0100 | [diff] [blame] | 3181 | STEXI |
Stefan Weil | 3dbf2c7 | 2010-01-16 18:19:44 +0100 | [diff] [blame] | 3182 | @item -nodefaults |
Stefan Weil | 6616b2a | 2010-02-05 23:52:05 +0100 | [diff] [blame] | 3183 | @findex -nodefaults |
Michal Novotny | 66c19bf | 2012-07-16 14:35:10 +0200 | [diff] [blame] | 3184 | Don't create default devices. Normally, QEMU sets the default devices like serial |
| 3185 | port, parallel port, virtual console, monitor device, VGA adapter, floppy and |
| 3186 | CD-ROM drive and others. The @code{-nodefaults} option will disable all those |
| 3187 | default devices. |
Gerd Hoffmann | d8c208d | 2009-12-08 13:11:46 +0100 | [diff] [blame] | 3188 | ETEXI |
| 3189 | |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 3190 | #ifndef _WIN32 |
| 3191 | DEF("chroot", HAS_ARG, QEMU_OPTION_chroot, \ |
Blue Swirl | ad96090 | 2010-03-29 19:23:52 +0000 | [diff] [blame] | 3192 | "-chroot dir chroot to dir just before starting the VM\n", |
| 3193 | QEMU_ARCH_ALL) |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 3194 | #endif |
| 3195 | STEXI |
Kevin Wolf | 4e257e5 | 2009-10-09 10:58:36 +0200 | [diff] [blame] | 3196 | @item -chroot @var{dir} |
Stefan Weil | 6616b2a | 2010-02-05 23:52:05 +0100 | [diff] [blame] | 3197 | @findex -chroot |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 3198 | Immediately before starting guest execution, chroot to the specified |
| 3199 | directory. Especially useful in combination with -runas. |
| 3200 | ETEXI |
| 3201 | |
| 3202 | #ifndef _WIN32 |
| 3203 | DEF("runas", HAS_ARG, QEMU_OPTION_runas, \ |
Blue Swirl | ad96090 | 2010-03-29 19:23:52 +0000 | [diff] [blame] | 3204 | "-runas user change to user id user just before starting the VM\n", |
| 3205 | QEMU_ARCH_ALL) |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 3206 | #endif |
| 3207 | STEXI |
Kevin Wolf | 4e257e5 | 2009-10-09 10:58:36 +0200 | [diff] [blame] | 3208 | @item -runas @var{user} |
Stefan Weil | 6616b2a | 2010-02-05 23:52:05 +0100 | [diff] [blame] | 3209 | @findex -runas |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 3210 | Immediately before starting guest execution, drop root privileges, switching |
| 3211 | to the specified user. |
| 3212 | ETEXI |
| 3213 | |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 3214 | DEF("prom-env", HAS_ARG, QEMU_OPTION_prom_env, |
| 3215 | "-prom-env variable=value\n" |
Blue Swirl | ad96090 | 2010-03-29 19:23:52 +0000 | [diff] [blame] | 3216 | " set OpenBIOS nvram variables\n", |
| 3217 | QEMU_ARCH_PPC | QEMU_ARCH_SPARC) |
Stefan Weil | 95d5f08 | 2010-01-20 22:25:27 +0100 | [diff] [blame] | 3218 | STEXI |
| 3219 | @item -prom-env @var{variable}=@var{value} |
Stefan Weil | 6616b2a | 2010-02-05 23:52:05 +0100 | [diff] [blame] | 3220 | @findex -prom-env |
Stefan Weil | 95d5f08 | 2010-01-20 22:25:27 +0100 | [diff] [blame] | 3221 | Set OpenBIOS nvram @var{variable} to given @var{value} (PPC, SPARC only). |
| 3222 | ETEXI |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 3223 | DEF("semihosting", 0, QEMU_OPTION_semihosting, |
Michael Walle | f7bbcfb | 2014-04-22 20:18:42 +0200 | [diff] [blame] | 3224 | "-semihosting semihosting mode\n", |
| 3225 | QEMU_ARCH_ARM | QEMU_ARCH_M68K | QEMU_ARCH_XTENSA | QEMU_ARCH_LM32) |
Stefan Weil | 95d5f08 | 2010-01-20 22:25:27 +0100 | [diff] [blame] | 3226 | STEXI |
| 3227 | @item -semihosting |
Stefan Weil | 6616b2a | 2010-02-05 23:52:05 +0100 | [diff] [blame] | 3228 | @findex -semihosting |
Liviu Ionescu | a38bb07 | 2014-12-11 12:07:48 +0000 | [diff] [blame] | 3229 | Enable semihosting mode (ARM, M68K, Xtensa only). |
| 3230 | ETEXI |
| 3231 | DEF("semihosting-config", HAS_ARG, QEMU_OPTION_semihosting_config, |
| 3232 | "-semihosting-config [enable=on|off,]target=native|gdb|auto semihosting configuration\n", |
| 3233 | QEMU_ARCH_ARM | QEMU_ARCH_M68K | QEMU_ARCH_XTENSA | QEMU_ARCH_LM32) |
| 3234 | STEXI |
| 3235 | @item -semihosting-config [enable=on|off,]target=native|gdb|auto |
| 3236 | @findex -semihosting-config |
| 3237 | Enable semihosting and define where the semihosting calls will be addressed, |
| 3238 | to QEMU (@code{native}) or to GDB (@code{gdb}). The default is @code{auto}, which means |
| 3239 | @code{gdb} during debug sessions and @code{native} otherwise (ARM, M68K, Xtensa only). |
Stefan Weil | 95d5f08 | 2010-01-20 22:25:27 +0100 | [diff] [blame] | 3240 | ETEXI |
blueswir1 | 5824d65 | 2009-03-28 06:44:27 +0000 | [diff] [blame] | 3241 | DEF("old-param", 0, QEMU_OPTION_old_param, |
Blue Swirl | ad96090 | 2010-03-29 19:23:52 +0000 | [diff] [blame] | 3242 | "-old-param old param mode\n", QEMU_ARCH_ARM) |
Stefan Weil | 95d5f08 | 2010-01-20 22:25:27 +0100 | [diff] [blame] | 3243 | STEXI |
| 3244 | @item -old-param |
Stefan Weil | 6616b2a | 2010-02-05 23:52:05 +0100 | [diff] [blame] | 3245 | @findex -old-param (ARM) |
Stefan Weil | 95d5f08 | 2010-01-20 22:25:27 +0100 | [diff] [blame] | 3246 | Old param mode (ARM only). |
| 3247 | ETEXI |
| 3248 | |
Eduardo Otubo | 7d76ad4 | 2012-08-14 18:44:08 -0300 | [diff] [blame] | 3249 | DEF("sandbox", HAS_ARG, QEMU_OPTION_sandbox, \ |
| 3250 | "-sandbox <arg> Enable seccomp mode 2 system call filter (default 'off').\n", |
| 3251 | QEMU_ARCH_ALL) |
| 3252 | STEXI |
Markus Armbruster | 6265c43 | 2013-02-13 19:49:39 +0100 | [diff] [blame] | 3253 | @item -sandbox @var{arg} |
Eduardo Otubo | 7d76ad4 | 2012-08-14 18:44:08 -0300 | [diff] [blame] | 3254 | @findex -sandbox |
| 3255 | Enable Seccomp mode 2 system call filter. 'on' will enable syscall filtering and 'off' will |
| 3256 | disable it. The default is 'off'. |
| 3257 | ETEXI |
| 3258 | |
Gerd Hoffmann | 715a664 | 2009-10-14 10:39:28 +0200 | [diff] [blame] | 3259 | DEF("readconfig", HAS_ARG, QEMU_OPTION_readconfig, |
Blue Swirl | ad96090 | 2010-03-29 19:23:52 +0000 | [diff] [blame] | 3260 | "-readconfig <file>\n", QEMU_ARCH_ALL) |
Stefan Weil | 3dbf2c7 | 2010-01-16 18:19:44 +0100 | [diff] [blame] | 3261 | STEXI |
| 3262 | @item -readconfig @var{file} |
Stefan Weil | 6616b2a | 2010-02-05 23:52:05 +0100 | [diff] [blame] | 3263 | @findex -readconfig |
Michal Novotny | ed24cfa | 2012-07-16 14:28:32 +0200 | [diff] [blame] | 3264 | Read device configuration from @var{file}. This approach is useful when you want to spawn |
| 3265 | QEMU process with many command line options but you don't want to exceed the command line |
| 3266 | character limit. |
Stefan Weil | 3dbf2c7 | 2010-01-16 18:19:44 +0100 | [diff] [blame] | 3267 | ETEXI |
Gerd Hoffmann | 715a664 | 2009-10-14 10:39:28 +0200 | [diff] [blame] | 3268 | DEF("writeconfig", HAS_ARG, QEMU_OPTION_writeconfig, |
| 3269 | "-writeconfig <file>\n" |
Blue Swirl | ad96090 | 2010-03-29 19:23:52 +0000 | [diff] [blame] | 3270 | " read/write config file\n", QEMU_ARCH_ALL) |
Stefan Weil | 3dbf2c7 | 2010-01-16 18:19:44 +0100 | [diff] [blame] | 3271 | STEXI |
| 3272 | @item -writeconfig @var{file} |
Stefan Weil | 6616b2a | 2010-02-05 23:52:05 +0100 | [diff] [blame] | 3273 | @findex -writeconfig |
Michal Novotny | ed24cfa | 2012-07-16 14:28:32 +0200 | [diff] [blame] | 3274 | Write device configuration to @var{file}. The @var{file} can be either filename to save |
| 3275 | command line and device configuration into file or dash @code{-}) character to print the |
| 3276 | output to stdout. This can be later used as input file for @code{-readconfig} option. |
Stefan Weil | 3dbf2c7 | 2010-01-16 18:19:44 +0100 | [diff] [blame] | 3277 | ETEXI |
Anthony Liguori | 292444c | 2010-01-21 10:57:58 -0600 | [diff] [blame] | 3278 | DEF("nodefconfig", 0, QEMU_OPTION_nodefconfig, |
| 3279 | "-nodefconfig\n" |
Blue Swirl | ad96090 | 2010-03-29 19:23:52 +0000 | [diff] [blame] | 3280 | " do not load default config files at startup\n", |
| 3281 | QEMU_ARCH_ALL) |
Anthony Liguori | 292444c | 2010-01-21 10:57:58 -0600 | [diff] [blame] | 3282 | STEXI |
| 3283 | @item -nodefconfig |
Stefan Weil | 6616b2a | 2010-02-05 23:52:05 +0100 | [diff] [blame] | 3284 | @findex -nodefconfig |
Eduardo Habkost | f29a561 | 2012-05-02 13:07:29 -0300 | [diff] [blame] | 3285 | Normally QEMU loads configuration files from @var{sysconfdir} and @var{datadir} at startup. |
| 3286 | The @code{-nodefconfig} option will prevent QEMU from loading any of those config files. |
| 3287 | ETEXI |
| 3288 | DEF("no-user-config", 0, QEMU_OPTION_nouserconfig, |
| 3289 | "-no-user-config\n" |
| 3290 | " do not load user-provided config files at startup\n", |
| 3291 | QEMU_ARCH_ALL) |
| 3292 | STEXI |
| 3293 | @item -no-user-config |
| 3294 | @findex -no-user-config |
| 3295 | The @code{-no-user-config} option makes QEMU not load any of the user-provided |
| 3296 | config files on @var{sysconfdir}, but won't make it skip the QEMU-provided config |
| 3297 | files from @var{datadir}. |
Anthony Liguori | 292444c | 2010-01-21 10:57:58 -0600 | [diff] [blame] | 3298 | ETEXI |
Prerna Saxena | ab6540d | 2010-08-09 11:48:32 +0100 | [diff] [blame] | 3299 | DEF("trace", HAS_ARG, QEMU_OPTION_trace, |
Lluís | 23d15e8 | 2011-08-31 20:31:31 +0200 | [diff] [blame] | 3300 | "-trace [events=<file>][,file=<file>]\n" |
| 3301 | " specify tracing options\n", |
Prerna Saxena | ab6540d | 2010-08-09 11:48:32 +0100 | [diff] [blame] | 3302 | QEMU_ARCH_ALL) |
| 3303 | STEXI |
Lluís | 23d15e8 | 2011-08-31 20:31:31 +0200 | [diff] [blame] | 3304 | HXCOMM This line is not accurate, as some sub-options are backend-specific but |
| 3305 | HXCOMM HX does not support conditional compilation of text. |
| 3306 | @item -trace [events=@var{file}][,file=@var{file}] |
Prerna Saxena | ab6540d | 2010-08-09 11:48:32 +0100 | [diff] [blame] | 3307 | @findex -trace |
Lluís | e485897 | 2011-08-31 20:31:03 +0200 | [diff] [blame] | 3308 | |
Lluís | 23d15e8 | 2011-08-31 20:31:31 +0200 | [diff] [blame] | 3309 | Specify tracing options. |
| 3310 | |
| 3311 | @table @option |
| 3312 | @item events=@var{file} |
| 3313 | Immediately enable events listed in @var{file}. |
| 3314 | The file must contain one event name (as listed in the @var{trace-events} file) |
| 3315 | per line. |
Stefan Weil | c1ba4e0 | 2011-09-05 18:13:03 +0200 | [diff] [blame] | 3316 | This option is only available if QEMU has been compiled with |
| 3317 | either @var{simple} or @var{stderr} tracing backend. |
Lluís | 23d15e8 | 2011-08-31 20:31:31 +0200 | [diff] [blame] | 3318 | @item file=@var{file} |
| 3319 | Log output traces to @var{file}. |
| 3320 | |
Stefan Weil | c1ba4e0 | 2011-09-05 18:13:03 +0200 | [diff] [blame] | 3321 | This option is only available if QEMU has been compiled with |
| 3322 | the @var{simple} tracing backend. |
Lluís | 23d15e8 | 2011-08-31 20:31:31 +0200 | [diff] [blame] | 3323 | @end table |
Prerna Saxena | ab6540d | 2010-08-09 11:48:32 +0100 | [diff] [blame] | 3324 | ETEXI |
Stefan Weil | 3dbf2c7 | 2010-01-16 18:19:44 +0100 | [diff] [blame] | 3325 | |
Markus Armbruster | 31e70d6 | 2013-02-13 19:49:37 +0100 | [diff] [blame] | 3326 | HXCOMM Internal use |
| 3327 | DEF("qtest", HAS_ARG, QEMU_OPTION_qtest, "", QEMU_ARCH_ALL) |
| 3328 | DEF("qtest-log", HAS_ARG, QEMU_OPTION_qtest_log, "", QEMU_ARCH_ALL) |
Anthony Liguori | c7f0f3b | 2012-03-28 15:42:02 +0200 | [diff] [blame] | 3329 | |
Paul Moore | 0f66998 | 2012-08-03 14:39:21 -0400 | [diff] [blame] | 3330 | #ifdef __linux__ |
| 3331 | DEF("enable-fips", 0, QEMU_OPTION_enablefips, |
| 3332 | "-enable-fips enable FIPS 140-2 compliance\n", |
| 3333 | QEMU_ARCH_ALL) |
| 3334 | #endif |
| 3335 | STEXI |
| 3336 | @item -enable-fips |
| 3337 | @findex -enable-fips |
| 3338 | Enable FIPS 140-2 compliance mode. |
| 3339 | ETEXI |
| 3340 | |
Jan Kiszka | a0dac02 | 2012-10-05 14:51:45 -0300 | [diff] [blame] | 3341 | HXCOMM Deprecated by -machine accel=tcg property |
Bruce Rogers | c6e88b3 | 2012-11-20 07:11:21 -0700 | [diff] [blame] | 3342 | DEF("no-kvm", 0, QEMU_OPTION_no_kvm, "", QEMU_ARCH_I386) |
Jan Kiszka | a0dac02 | 2012-10-05 14:51:45 -0300 | [diff] [blame] | 3343 | |
Jan Kiszka | c21fb4f | 2012-10-05 14:51:42 -0300 | [diff] [blame] | 3344 | HXCOMM Deprecated by kvm-pit driver properties |
Bruce Rogers | c6e88b3 | 2012-11-20 07:11:21 -0700 | [diff] [blame] | 3345 | DEF("no-kvm-pit-reinjection", 0, QEMU_OPTION_no_kvm_pit_reinjection, |
Jan Kiszka | c21fb4f | 2012-10-05 14:51:42 -0300 | [diff] [blame] | 3346 | "", QEMU_ARCH_I386) |
| 3347 | |
Jan Kiszka | 4086bde | 2012-10-05 14:51:41 -0300 | [diff] [blame] | 3348 | HXCOMM Deprecated (ignored) |
Bruce Rogers | c6e88b3 | 2012-11-20 07:11:21 -0700 | [diff] [blame] | 3349 | DEF("no-kvm-pit", 0, QEMU_OPTION_no_kvm_pit, "", QEMU_ARCH_I386) |
Jan Kiszka | 4086bde | 2012-10-05 14:51:41 -0300 | [diff] [blame] | 3350 | |
Jan Kiszka | e43d594 | 2012-10-05 14:51:40 -0300 | [diff] [blame] | 3351 | HXCOMM Deprecated by -machine kernel_irqchip=on|off property |
Bruce Rogers | c6e88b3 | 2012-11-20 07:11:21 -0700 | [diff] [blame] | 3352 | DEF("no-kvm-irqchip", 0, QEMU_OPTION_no_kvm_irqchip, "", QEMU_ARCH_I386) |
Jan Kiszka | e43d594 | 2012-10-05 14:51:40 -0300 | [diff] [blame] | 3353 | |
Jan Kiszka | 88eed34 | 2012-10-05 14:51:44 -0300 | [diff] [blame] | 3354 | HXCOMM Deprecated (ignored) |
| 3355 | DEF("tdf", 0, QEMU_OPTION_tdf,"", QEMU_ARCH_ALL) |
| 3356 | |
Anthony Liguori | 68d98d3 | 2012-06-25 14:36:33 -0500 | [diff] [blame] | 3357 | DEF("object", HAS_ARG, QEMU_OPTION_object, |
| 3358 | "-object TYPENAME[,PROP1=VALUE1,...]\n" |
| 3359 | " create an new object of type TYPENAME setting properties\n" |
| 3360 | " in the order they are specified. Note that the 'id'\n" |
| 3361 | " property must be set. These objects are placed in the\n" |
| 3362 | " '/objects' path.\n", |
| 3363 | QEMU_ARCH_ALL) |
Markus Armbruster | 6265c43 | 2013-02-13 19:49:39 +0100 | [diff] [blame] | 3364 | STEXI |
| 3365 | @item -object @var{typename}[,@var{prop1}=@var{value1},...] |
| 3366 | @findex -object |
| 3367 | Create an new object of type @var{typename} setting properties |
| 3368 | in the order they are specified. Note that the 'id' |
| 3369 | property must be set. These objects are placed in the |
| 3370 | '/objects' path. |
| 3371 | ETEXI |
Anthony Liguori | 68d98d3 | 2012-06-25 14:36:33 -0500 | [diff] [blame] | 3372 | |
Seiji Aguchi | 5e2ac51 | 2013-07-03 23:02:46 -0400 | [diff] [blame] | 3373 | DEF("msg", HAS_ARG, QEMU_OPTION_msg, |
| 3374 | "-msg timestamp[=on|off]\n" |
| 3375 | " change the format of messages\n" |
| 3376 | " on|off controls leading timestamps (default:on)\n", |
| 3377 | QEMU_ARCH_ALL) |
| 3378 | STEXI |
| 3379 | @item -msg timestamp[=on|off] |
| 3380 | @findex -msg |
| 3381 | prepend a timestamp to each log message.(default:on) |
| 3382 | ETEXI |
| 3383 | |
Amit Shah | abfd9ce | 2014-06-20 18:56:08 +0530 | [diff] [blame] | 3384 | DEF("dump-vmstate", HAS_ARG, QEMU_OPTION_dump_vmstate, |
| 3385 | "-dump-vmstate <file>\n" |
| 3386 | " Output vmstate information in JSON format to file.\n" |
| 3387 | " Use the scripts/vmstate-static-checker.py file to\n" |
| 3388 | " check for possible regressions in migration code\n" |
| 3389 | " by comparing two such vmstate dumps.", |
| 3390 | QEMU_ARCH_ALL) |
| 3391 | STEXI |
| 3392 | @item -dump-vmstate @var{file} |
| 3393 | @findex -dump-vmstate |
| 3394 | Dump json-encoded vmstate information for current machine type to file |
| 3395 | in @var{file} |
| 3396 | ETEXI |
| 3397 | |
Stefan Weil | 3dbf2c7 | 2010-01-16 18:19:44 +0100 | [diff] [blame] | 3398 | HXCOMM This is the last statement. Insert new options before this line! |
| 3399 | STEXI |
| 3400 | @end table |
| 3401 | ETEXI |