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