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