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