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