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