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\n" 250 " slots: number of hotplug slots (default: none)\n" 251 " maxmem: maximum amount of guest memory (default: none)\n" 252 "NOTE: Some architectures might enforce a specific granularity\n", 253 QEMU_ARCH_ALL) 254STEXI 255@item -m [size=]@var{megs}[,slots=n,maxmem=size] 256@findex -m 257Sets guest startup RAM size to @var{megs} megabytes. Default is 128 MiB. 258Optionally, a suffix of ``M'' or ``G'' can be used to signify a value in 259megabytes or gigabytes respectively. Optional pair @var{slots}, @var{maxmem} 260could be used to set amount of hotpluggable memory slots and maximum amount of 261memory. Note that @var{maxmem} must be aligned to the page size. 262 263For example, the following command-line sets the guest startup RAM size to 2641GB, creates 3 slots to hotplug additional memory and sets the maximum 265memory the guest can reach to 4GB: 266 267@example 268qemu-system-x86_64 -m 1G,slots=3,maxmem=4G 269@end example 270 271If @var{slots} and @var{maxmem} are not specified, memory hotplug won't 272be enabled and the guest startup RAM will never increase. 273ETEXI 274 275DEF("mem-path", HAS_ARG, QEMU_OPTION_mempath, 276 "-mem-path FILE provide backing storage for guest RAM\n", QEMU_ARCH_ALL) 277STEXI 278@item -mem-path @var{path} 279@findex -mem-path 280Allocate guest RAM from a temporarily created file in @var{path}. 281ETEXI 282 283DEF("mem-prealloc", 0, QEMU_OPTION_mem_prealloc, 284 "-mem-prealloc preallocate guest memory (use with -mem-path)\n", 285 QEMU_ARCH_ALL) 286STEXI 287@item -mem-prealloc 288@findex -mem-prealloc 289Preallocate memory when using -mem-path. 290ETEXI 291 292DEF("k", HAS_ARG, QEMU_OPTION_k, 293 "-k language use keyboard layout (for example 'fr' for French)\n", 294 QEMU_ARCH_ALL) 295STEXI 296@item -k @var{language} 297@findex -k 298Use keyboard layout @var{language} (for example @code{fr} for 299French). This option is only needed where it is not easy to get raw PC 300keycodes (e.g. on Macs, with some X11 servers or with a VNC 301display). You don't normally need to use it on PC/Linux or PC/Windows 302hosts. 303 304The available layouts are: 305@example 306ar de-ch es fo fr-ca hu ja mk no pt-br sv 307da en-gb et fr fr-ch is lt nl pl ru th 308de en-us fi fr-be hr it lv nl-be pt sl tr 309@end example 310 311The default is @code{en-us}. 312ETEXI 313 314 315DEF("audio-help", 0, QEMU_OPTION_audio_help, 316 "-audio-help print list of audio drivers and their options\n", 317 QEMU_ARCH_ALL) 318STEXI 319@item -audio-help 320@findex -audio-help 321Will show the audio subsystem help: list of drivers, tunable 322parameters. 323ETEXI 324 325DEF("soundhw", HAS_ARG, QEMU_OPTION_soundhw, 326 "-soundhw c1,... enable audio support\n" 327 " and only specified sound cards (comma separated list)\n" 328 " use '-soundhw help' to get the list of supported cards\n" 329 " use '-soundhw all' to enable all of them\n", QEMU_ARCH_ALL) 330STEXI 331@item -soundhw @var{card1}[,@var{card2},...] or -soundhw all 332@findex -soundhw 333Enable audio and selected sound hardware. Use 'help' to print all 334available sound hardware. 335 336@example 337qemu-system-i386 -soundhw sb16,adlib disk.img 338qemu-system-i386 -soundhw es1370 disk.img 339qemu-system-i386 -soundhw ac97 disk.img 340qemu-system-i386 -soundhw hda disk.img 341qemu-system-i386 -soundhw all disk.img 342qemu-system-i386 -soundhw help 343@end example 344 345Note that Linux's i810_audio OSS kernel (for AC97) module might 346require manually specifying clocking. 347 348@example 349modprobe i810_audio clocking=48000 350@end example 351ETEXI 352 353DEF("balloon", HAS_ARG, QEMU_OPTION_balloon, 354 "-balloon none disable balloon device\n" 355 "-balloon virtio[,addr=str]\n" 356 " enable virtio balloon device (default)\n", QEMU_ARCH_ALL) 357STEXI 358@item -balloon none 359@findex -balloon 360Disable balloon device. 361@item -balloon virtio[,addr=@var{addr}] 362Enable virtio balloon device (default), optionally with PCI address 363@var{addr}. 364ETEXI 365 366DEF("device", HAS_ARG, QEMU_OPTION_device, 367 "-device driver[,prop[=value][,...]]\n" 368 " add device (based on driver)\n" 369 " prop=value,... sets driver properties\n" 370 " use '-device help' to print all possible drivers\n" 371 " use '-device driver,help' to print all possible properties\n", 372 QEMU_ARCH_ALL) 373STEXI 374@item -device @var{driver}[,@var{prop}[=@var{value}][,...]] 375@findex -device 376Add device @var{driver}. @var{prop}=@var{value} sets driver 377properties. Valid properties depend on the driver. To get help on 378possible drivers and properties, use @code{-device help} and 379@code{-device @var{driver},help}. 380ETEXI 381 382DEF("name", HAS_ARG, QEMU_OPTION_name, 383 "-name string1[,process=string2][,debug-threads=on|off]\n" 384 " set the name of the guest\n" 385 " string1 sets the window title and string2 the process name (on Linux)\n" 386 " When debug-threads is enabled, individual threads are given a separate name (on Linux)\n" 387 " NOTE: The thread names are for debugging and not a stable API.\n", 388 QEMU_ARCH_ALL) 389STEXI 390@item -name @var{name} 391@findex -name 392Sets the @var{name} of the guest. 393This name will be displayed in the SDL window caption. 394The @var{name} will also be used for the VNC server. 395Also optionally set the top visible process name in Linux. 396Naming of individual threads can also be enabled on Linux to aid debugging. 397ETEXI 398 399DEF("uuid", HAS_ARG, QEMU_OPTION_uuid, 400 "-uuid %08x-%04x-%04x-%04x-%012x\n" 401 " specify machine UUID\n", QEMU_ARCH_ALL) 402STEXI 403@item -uuid @var{uuid} 404@findex -uuid 405Set system UUID. 406ETEXI 407 408STEXI 409@end table 410ETEXI 411DEFHEADING() 412 413DEFHEADING(Block device options:) 414STEXI 415@table @option 416ETEXI 417 418DEF("fda", HAS_ARG, QEMU_OPTION_fda, 419 "-fda/-fdb file use 'file' as floppy disk 0/1 image\n", QEMU_ARCH_ALL) 420DEF("fdb", HAS_ARG, QEMU_OPTION_fdb, "", QEMU_ARCH_ALL) 421STEXI 422@item -fda @var{file} 423@item -fdb @var{file} 424@findex -fda 425@findex -fdb 426Use @var{file} as floppy disk 0/1 image (@pxref{disk_images}). 427ETEXI 428 429DEF("hda", HAS_ARG, QEMU_OPTION_hda, 430 "-hda/-hdb file use 'file' as IDE hard disk 0/1 image\n", QEMU_ARCH_ALL) 431DEF("hdb", HAS_ARG, QEMU_OPTION_hdb, "", QEMU_ARCH_ALL) 432DEF("hdc", HAS_ARG, QEMU_OPTION_hdc, 433 "-hdc/-hdd file use 'file' as IDE hard disk 2/3 image\n", QEMU_ARCH_ALL) 434DEF("hdd", HAS_ARG, QEMU_OPTION_hdd, "", QEMU_ARCH_ALL) 435STEXI 436@item -hda @var{file} 437@item -hdb @var{file} 438@item -hdc @var{file} 439@item -hdd @var{file} 440@findex -hda 441@findex -hdb 442@findex -hdc 443@findex -hdd 444Use @var{file} as hard disk 0, 1, 2 or 3 image (@pxref{disk_images}). 445ETEXI 446 447DEF("cdrom", HAS_ARG, QEMU_OPTION_cdrom, 448 "-cdrom file use 'file' as IDE cdrom image (cdrom is ide1 master)\n", 449 QEMU_ARCH_ALL) 450STEXI 451@item -cdrom @var{file} 452@findex -cdrom 453Use @var{file} as CD-ROM image (you cannot use @option{-hdc} and 454@option{-cdrom} at the same time). You can use the host CD-ROM by 455using @file{/dev/cdrom} as filename (@pxref{host_drives}). 456ETEXI 457 458DEF("drive", HAS_ARG, QEMU_OPTION_drive, 459 "-drive [file=file][,if=type][,bus=n][,unit=m][,media=d][,index=i]\n" 460 " [,cyls=c,heads=h,secs=s[,trans=t]][,snapshot=on|off]\n" 461 " [,cache=writethrough|writeback|none|directsync|unsafe][,format=f]\n" 462 " [,serial=s][,addr=A][,rerror=ignore|stop|report]\n" 463 " [,werror=ignore|stop|report|enospc][,id=name][,aio=threads|native]\n" 464 " [,readonly=on|off][,copy-on-read=on|off]\n" 465 " [,discard=ignore|unmap][,detect-zeroes=on|off|unmap]\n" 466 " [[,bps=b]|[[,bps_rd=r][,bps_wr=w]]]\n" 467 " [[,iops=i]|[[,iops_rd=r][,iops_wr=w]]]\n" 468 " [[,bps_max=bm]|[[,bps_rd_max=rm][,bps_wr_max=wm]]]\n" 469 " [[,iops_max=im]|[[,iops_rd_max=irm][,iops_wr_max=iwm]]]\n" 470 " [[,iops_size=is]]\n" 471 " [[,group=g]]\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|virtio|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 virtio 1141Virtio VGA card. 1142@item none 1143Disable VGA card. 1144@end table 1145ETEXI 1146 1147DEF("full-screen", 0, QEMU_OPTION_full_screen, 1148 "-full-screen start in full screen\n", QEMU_ARCH_ALL) 1149STEXI 1150@item -full-screen 1151@findex -full-screen 1152Start in full screen. 1153ETEXI 1154 1155DEF("g", 1, QEMU_OPTION_g , 1156 "-g WxH[xDEPTH] Set the initial graphical resolution and depth\n", 1157 QEMU_ARCH_PPC | QEMU_ARCH_SPARC) 1158STEXI 1159@item -g @var{width}x@var{height}[x@var{depth}] 1160@findex -g 1161Set the initial graphical resolution and depth (PPC, SPARC only). 1162ETEXI 1163 1164DEF("vnc", HAS_ARG, QEMU_OPTION_vnc , 1165 "-vnc display start a VNC server on display\n", QEMU_ARCH_ALL) 1166STEXI 1167@item -vnc @var{display}[,@var{option}[,@var{option}[,...]]] 1168@findex -vnc 1169Normally, QEMU uses SDL to display the VGA output. With this option, 1170you can have QEMU listen on VNC display @var{display} and redirect the VGA 1171display over the VNC session. It is very useful to enable the usb 1172tablet device when using this option (option @option{-usbdevice 1173tablet}). When using the VNC display, you must use the @option{-k} 1174parameter to set the keyboard layout if you are not using en-us. Valid 1175syntax for the @var{display} is 1176 1177@table @option 1178 1179@item @var{host}:@var{d} 1180 1181TCP connections will only be allowed from @var{host} on display @var{d}. 1182By convention the TCP port is 5900+@var{d}. Optionally, @var{host} can 1183be omitted in which case the server will accept connections from any host. 1184 1185@item unix:@var{path} 1186 1187Connections will be allowed over UNIX domain sockets where @var{path} is the 1188location of a unix socket to listen for connections on. 1189 1190@item none 1191 1192VNC is initialized but not started. The monitor @code{change} command 1193can be used to later start the VNC server. 1194 1195@end table 1196 1197Following the @var{display} value there may be one or more @var{option} flags 1198separated by commas. Valid options are 1199 1200@table @option 1201 1202@item reverse 1203 1204Connect to a listening VNC client via a ``reverse'' connection. The 1205client is specified by the @var{display}. For reverse network 1206connections (@var{host}:@var{d},@code{reverse}), the @var{d} argument 1207is a TCP port number, not a display number. 1208 1209@item websocket 1210 1211Opens an additional TCP listening port dedicated to VNC Websocket connections. 1212By definition the Websocket port is 5700+@var{display}. If @var{host} is 1213specified connections will only be allowed from this host. 1214As an alternative the Websocket port could be specified by using 1215@code{websocket}=@var{port}. 1216TLS encryption for the Websocket connection is supported if the required 1217certificates are specified with the VNC option @option{x509}. 1218 1219@item password 1220 1221Require that password based authentication is used for client connections. 1222 1223The password must be set separately using the @code{set_password} command in 1224the @ref{pcsys_monitor}. The syntax to change your password is: 1225@code{set_password <protocol> <password>} where <protocol> could be either 1226"vnc" or "spice". 1227 1228If you would like to change <protocol> password expiration, you should use 1229@code{expire_password <protocol> <expiration-time>} where expiration time could 1230be one of the following options: now, never, +seconds or UNIX time of 1231expiration, e.g. +60 to make password expire in 60 seconds, or 1335196800 1232to make password expire on "Mon Apr 23 12:00:00 EDT 2012" (UNIX time for this 1233date and time). 1234 1235You can also use keywords "now" or "never" for the expiration time to 1236allow <protocol> password to expire immediately or never expire. 1237 1238@item tls 1239 1240Require that client use TLS when communicating with the VNC server. This 1241uses anonymous TLS credentials so is susceptible to a man-in-the-middle 1242attack. It is recommended that this option be combined with either the 1243@option{x509} or @option{x509verify} options. 1244 1245@item x509=@var{/path/to/certificate/dir} 1246 1247Valid if @option{tls} is specified. Require that x509 credentials are used 1248for negotiating the TLS session. The server will send its x509 certificate 1249to the client. It is recommended that a password be set on the VNC server 1250to provide authentication of the client when this is used. The path following 1251this option specifies where the x509 certificates are to be loaded from. 1252See the @ref{vnc_security} section for details on generating certificates. 1253 1254@item x509verify=@var{/path/to/certificate/dir} 1255 1256Valid if @option{tls} is specified. Require that x509 credentials are used 1257for negotiating the TLS session. The server will send its x509 certificate 1258to the client, and request that the client send its own x509 certificate. 1259The server will validate the client's certificate against the CA certificate, 1260and reject clients when validation fails. If the certificate authority is 1261trusted, this is a sufficient authentication mechanism. You may still wish 1262to set a password on the VNC server as a second authentication layer. The 1263path following this option specifies where the x509 certificates are to 1264be loaded from. See the @ref{vnc_security} section for details on generating 1265certificates. 1266 1267@item sasl 1268 1269Require that the client use SASL to authenticate with the VNC server. 1270The exact choice of authentication method used is controlled from the 1271system / user's SASL configuration file for the 'qemu' service. This 1272is typically found in /etc/sasl2/qemu.conf. If running QEMU as an 1273unprivileged user, an environment variable SASL_CONF_PATH can be used 1274to make it search alternate locations for the service config. 1275While some SASL auth methods can also provide data encryption (eg GSSAPI), 1276it is recommended that SASL always be combined with the 'tls' and 1277'x509' settings to enable use of SSL and server certificates. This 1278ensures a data encryption preventing compromise of authentication 1279credentials. See the @ref{vnc_security} section for details on using 1280SASL authentication. 1281 1282@item acl 1283 1284Turn on access control lists for checking of the x509 client certificate 1285and SASL party. For x509 certs, the ACL check is made against the 1286certificate's distinguished name. This is something that looks like 1287@code{C=GB,O=ACME,L=Boston,CN=bob}. For SASL party, the ACL check is 1288made against the username, which depending on the SASL plugin, may 1289include a realm component, eg @code{bob} or @code{bob@@EXAMPLE.COM}. 1290When the @option{acl} flag is set, the initial access list will be 1291empty, with a @code{deny} policy. Thus no one will be allowed to 1292use the VNC server until the ACLs have been loaded. This can be 1293achieved using the @code{acl} monitor command. 1294 1295@item lossy 1296 1297Enable lossy compression methods (gradient, JPEG, ...). If this 1298option is set, VNC client may receive lossy framebuffer updates 1299depending on its encoding settings. Enabling this option can save 1300a lot of bandwidth at the expense of quality. 1301 1302@item non-adaptive 1303 1304Disable adaptive encodings. Adaptive encodings are enabled by default. 1305An adaptive encoding will try to detect frequently updated screen regions, 1306and send updates in these regions using a lossy encoding (like JPEG). 1307This can be really helpful to save bandwidth when playing videos. Disabling 1308adaptive encodings restores the original static behavior of encodings 1309like Tight. 1310 1311@item share=[allow-exclusive|force-shared|ignore] 1312 1313Set display sharing policy. 'allow-exclusive' allows clients to ask 1314for exclusive access. As suggested by the rfb spec this is 1315implemented by dropping other connections. Connecting multiple 1316clients in parallel requires all clients asking for a shared session 1317(vncviewer: -shared switch). This is the default. 'force-shared' 1318disables exclusive client access. Useful for shared desktop sessions, 1319where you don't want someone forgetting specify -shared disconnect 1320everybody else. 'ignore' completely ignores the shared flag and 1321allows everybody connect unconditionally. Doesn't conform to the rfb 1322spec but is traditional QEMU behavior. 1323 1324@end table 1325ETEXI 1326 1327STEXI 1328@end table 1329ETEXI 1330ARCHHEADING(, QEMU_ARCH_I386) 1331 1332ARCHHEADING(i386 target only:, QEMU_ARCH_I386) 1333STEXI 1334@table @option 1335ETEXI 1336 1337DEF("win2k-hack", 0, QEMU_OPTION_win2k_hack, 1338 "-win2k-hack use it when installing Windows 2000 to avoid a disk full bug\n", 1339 QEMU_ARCH_I386) 1340STEXI 1341@item -win2k-hack 1342@findex -win2k-hack 1343Use it when installing Windows 2000 to avoid a disk full bug. After 1344Windows 2000 is installed, you no longer need this option (this option 1345slows down the IDE transfers). 1346ETEXI 1347 1348HXCOMM Deprecated by -rtc 1349DEF("rtc-td-hack", 0, QEMU_OPTION_rtc_td_hack, "", QEMU_ARCH_I386) 1350 1351DEF("no-fd-bootchk", 0, QEMU_OPTION_no_fd_bootchk, 1352 "-no-fd-bootchk disable boot signature checking for floppy disks\n", 1353 QEMU_ARCH_I386) 1354STEXI 1355@item -no-fd-bootchk 1356@findex -no-fd-bootchk 1357Disable boot signature checking for floppy disks in BIOS. May 1358be needed to boot from old floppy disks. 1359ETEXI 1360 1361DEF("no-acpi", 0, QEMU_OPTION_no_acpi, 1362 "-no-acpi disable ACPI\n", QEMU_ARCH_I386 | QEMU_ARCH_ARM) 1363STEXI 1364@item -no-acpi 1365@findex -no-acpi 1366Disable ACPI (Advanced Configuration and Power Interface) support. Use 1367it if your guest OS complains about ACPI problems (PC target machine 1368only). 1369ETEXI 1370 1371DEF("no-hpet", 0, QEMU_OPTION_no_hpet, 1372 "-no-hpet disable HPET\n", QEMU_ARCH_I386) 1373STEXI 1374@item -no-hpet 1375@findex -no-hpet 1376Disable HPET support. 1377ETEXI 1378 1379DEF("acpitable", HAS_ARG, QEMU_OPTION_acpitable, 1380 "-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" 1381 " ACPI table description\n", QEMU_ARCH_I386) 1382STEXI 1383@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}]...] 1384@findex -acpitable 1385Add ACPI table with specified header fields and context from specified files. 1386For file=, take whole ACPI table from the specified files, including all 1387ACPI headers (possible overridden by other options). 1388For data=, only data 1389portion of the table is used, all header information is specified in the 1390command line. 1391ETEXI 1392 1393DEF("smbios", HAS_ARG, QEMU_OPTION_smbios, 1394 "-smbios file=binary\n" 1395 " load SMBIOS entry from binary file\n" 1396 "-smbios type=0[,vendor=str][,version=str][,date=str][,release=%d.%d]\n" 1397 " [,uefi=on|off]\n" 1398 " specify SMBIOS type 0 fields\n" 1399 "-smbios type=1[,manufacturer=str][,product=str][,version=str][,serial=str]\n" 1400 " [,uuid=uuid][,sku=str][,family=str]\n" 1401 " specify SMBIOS type 1 fields\n" 1402 "-smbios type=2[,manufacturer=str][,product=str][,version=str][,serial=str]\n" 1403 " [,asset=str][,location=str]\n" 1404 " specify SMBIOS type 2 fields\n" 1405 "-smbios type=3[,manufacturer=str][,version=str][,serial=str][,asset=str]\n" 1406 " [,sku=str]\n" 1407 " specify SMBIOS type 3 fields\n" 1408 "-smbios type=4[,sock_pfx=str][,manufacturer=str][,version=str][,serial=str]\n" 1409 " [,asset=str][,part=str]\n" 1410 " specify SMBIOS type 4 fields\n" 1411 "-smbios type=17[,loc_pfx=str][,bank=str][,manufacturer=str][,serial=str]\n" 1412 " [,asset=str][,part=str][,speed=%d]\n" 1413 " specify SMBIOS type 17 fields\n", 1414 QEMU_ARCH_I386) 1415STEXI 1416@item -smbios file=@var{binary} 1417@findex -smbios 1418Load SMBIOS entry from binary file. 1419 1420@item -smbios type=0[,vendor=@var{str}][,version=@var{str}][,date=@var{str}][,release=@var{%d.%d}][,uefi=on|off] 1421Specify SMBIOS type 0 fields 1422 1423@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}] 1424Specify SMBIOS type 1 fields 1425 1426@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}] 1427Specify SMBIOS type 2 fields 1428 1429@item -smbios type=3[,manufacturer=@var{str}][,version=@var{str}][,serial=@var{str}][,asset=@var{str}][,sku=@var{str}] 1430Specify SMBIOS type 3 fields 1431 1432@item -smbios type=4[,sock_pfx=@var{str}][,manufacturer=@var{str}][,version=@var{str}][,serial=@var{str}][,asset=@var{str}][,part=@var{str}] 1433Specify SMBIOS type 4 fields 1434 1435@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}] 1436Specify SMBIOS type 17 fields 1437ETEXI 1438 1439STEXI 1440@end table 1441ETEXI 1442DEFHEADING() 1443 1444DEFHEADING(Network options:) 1445STEXI 1446@table @option 1447ETEXI 1448 1449HXCOMM Legacy slirp options (now moved to -net user): 1450#ifdef CONFIG_SLIRP 1451DEF("tftp", HAS_ARG, QEMU_OPTION_tftp, "", QEMU_ARCH_ALL) 1452DEF("bootp", HAS_ARG, QEMU_OPTION_bootp, "", QEMU_ARCH_ALL) 1453DEF("redir", HAS_ARG, QEMU_OPTION_redir, "", QEMU_ARCH_ALL) 1454#ifndef _WIN32 1455DEF("smb", HAS_ARG, QEMU_OPTION_smb, "", QEMU_ARCH_ALL) 1456#endif 1457#endif 1458 1459DEF("netdev", HAS_ARG, QEMU_OPTION_netdev, 1460#ifdef CONFIG_SLIRP 1461 "-netdev user,id=str[,net=addr[/mask]][,host=addr][,restrict=on|off]\n" 1462 " [,hostname=host][,dhcpstart=addr][,dns=addr][,dnssearch=domain][,tftp=dir]\n" 1463 " [,bootfile=f][,hostfwd=rule][,guestfwd=rule]" 1464#ifndef _WIN32 1465 "[,smb=dir[,smbserver=addr]]\n" 1466#endif 1467 " configure a user mode network backend with ID 'str',\n" 1468 " its DHCP server and optional services\n" 1469#endif 1470#ifdef _WIN32 1471 "-netdev tap,id=str,ifname=name\n" 1472 " configure a host TAP network backend with ID 'str'\n" 1473#else 1474 "-netdev tap,id=str[,fd=h][,fds=x:y:...:z][,ifname=name][,script=file][,downscript=dfile]\n" 1475 " [,helper=helper][,sndbuf=nbytes][,vnet_hdr=on|off][,vhost=on|off]\n" 1476 " [,vhostfd=h][,vhostfds=x:y:...:z][,vhostforce=on|off][,queues=n]\n" 1477 " configure a host TAP network backend with ID 'str'\n" 1478 " use network scripts 'file' (default=" DEFAULT_NETWORK_SCRIPT ")\n" 1479 " to configure it and 'dfile' (default=" DEFAULT_NETWORK_DOWN_SCRIPT ")\n" 1480 " to deconfigure it\n" 1481 " use '[down]script=no' to disable script execution\n" 1482 " use network helper 'helper' (default=" DEFAULT_BRIDGE_HELPER ") to\n" 1483 " configure it\n" 1484 " use 'fd=h' to connect to an already opened TAP interface\n" 1485 " use 'fds=x:y:...:z' to connect to already opened multiqueue capable TAP interfaces\n" 1486 " use 'sndbuf=nbytes' to limit the size of the send buffer (the\n" 1487 " default is disabled 'sndbuf=0' to enable flow control set 'sndbuf=1048576')\n" 1488 " use vnet_hdr=off to avoid enabling the IFF_VNET_HDR tap flag\n" 1489 " use vnet_hdr=on to make the lack of IFF_VNET_HDR support an error condition\n" 1490 " use vhost=on to enable experimental in kernel accelerator\n" 1491 " (only has effect for virtio guests which use MSIX)\n" 1492 " use vhostforce=on to force vhost on for non-MSIX virtio guests\n" 1493 " use 'vhostfd=h' to connect to an already opened vhost net device\n" 1494 " use 'vhostfds=x:y:...:z to connect to multiple already opened vhost net devices\n" 1495 " use 'queues=n' to specify the number of queues to be created for multiqueue TAP\n" 1496 "-netdev bridge,id=str[,br=bridge][,helper=helper]\n" 1497 " configure a host TAP network backend with ID 'str' that is\n" 1498 " connected to a bridge (default=" DEFAULT_BRIDGE_INTERFACE ")\n" 1499 " using the program 'helper (default=" DEFAULT_BRIDGE_HELPER ")\n" 1500#endif 1501#ifdef __linux__ 1502 "-netdev l2tpv3,id=str,src=srcaddr,dst=dstaddr[,srcport=srcport][,dstport=dstport]\n" 1503 " [,rxsession=rxsession],txsession=txsession[,ipv6=on/off][,udp=on/off]\n" 1504 " [,cookie64=on/off][,counter][,pincounter][,txcookie=txcookie]\n" 1505 " [,rxcookie=rxcookie][,offset=offset]\n" 1506 " configure a network backend with ID 'str' connected to\n" 1507 " an Ethernet over L2TPv3 pseudowire.\n" 1508 " Linux kernel 3.3+ as well as most routers can talk\n" 1509 " L2TPv3. This transport allows connecting a VM to a VM,\n" 1510 " VM to a router and even VM to Host. It is a nearly-universal\n" 1511 " standard (RFC3391). Note - this implementation uses static\n" 1512 " pre-configured tunnels (same as the Linux kernel).\n" 1513 " use 'src=' to specify source address\n" 1514 " use 'dst=' to specify destination address\n" 1515 " use 'udp=on' to specify udp encapsulation\n" 1516 " use 'srcport=' to specify source udp port\n" 1517 " use 'dstport=' to specify destination udp port\n" 1518 " use 'ipv6=on' to force v6\n" 1519 " L2TPv3 uses cookies to prevent misconfiguration as\n" 1520 " well as a weak security measure\n" 1521 " use 'rxcookie=0x012345678' to specify a rxcookie\n" 1522 " use 'txcookie=0x012345678' to specify a txcookie\n" 1523 " use 'cookie64=on' to set cookie size to 64 bit, otherwise 32\n" 1524 " use 'counter=off' to force a 'cut-down' L2TPv3 with no counter\n" 1525 " use 'pincounter=on' to work around broken counter handling in peer\n" 1526 " use 'offset=X' to add an extra offset between header and data\n" 1527#endif 1528 "-netdev socket,id=str[,fd=h][,listen=[host]:port][,connect=host:port]\n" 1529 " configure a network backend to connect to another network\n" 1530 " using a socket connection\n" 1531 "-netdev socket,id=str[,fd=h][,mcast=maddr:port[,localaddr=addr]]\n" 1532 " configure a network backend to connect to a multicast maddr and port\n" 1533 " use 'localaddr=addr' to specify the host address to send packets from\n" 1534 "-netdev socket,id=str[,fd=h][,udp=host:port][,localaddr=host:port]\n" 1535 " configure a network backend to connect to another network\n" 1536 " using an UDP tunnel\n" 1537#ifdef CONFIG_VDE 1538 "-netdev vde,id=str[,sock=socketpath][,port=n][,group=groupname][,mode=octalmode]\n" 1539 " configure a network backend to connect to port 'n' of a vde switch\n" 1540 " running on host and listening for incoming connections on 'socketpath'.\n" 1541 " Use group 'groupname' and mode 'octalmode' to change default\n" 1542 " ownership and permissions for communication port.\n" 1543#endif 1544#ifdef CONFIG_NETMAP 1545 "-netdev netmap,id=str,ifname=name[,devname=nmname]\n" 1546 " attach to the existing netmap-enabled network interface 'name', or to a\n" 1547 " VALE port (created on the fly) called 'name' ('nmname' is name of the \n" 1548 " netmap device, defaults to '/dev/netmap')\n" 1549#endif 1550 "-netdev vhost-user,id=str,chardev=dev[,vhostforce=on|off]\n" 1551 " configure a vhost-user network, backed by a chardev 'dev'\n" 1552 "-netdev hubport,id=str,hubid=n\n" 1553 " configure a hub port on QEMU VLAN 'n'\n", QEMU_ARCH_ALL) 1554DEF("net", HAS_ARG, QEMU_OPTION_net, 1555 "-net nic[,vlan=n][,macaddr=mac][,model=type][,name=str][,addr=str][,vectors=v]\n" 1556 " old way to create a new NIC and connect it to VLAN 'n'\n" 1557 " (use the '-device devtype,netdev=str' option if possible instead)\n" 1558 "-net dump[,vlan=n][,file=f][,len=n]\n" 1559 " dump traffic on vlan 'n' to file 'f' (max n bytes per packet)\n" 1560 "-net none use it alone to have zero network devices. If no -net option\n" 1561 " is provided, the default is '-net nic -net user'\n" 1562 "-net [" 1563#ifdef CONFIG_SLIRP 1564 "user|" 1565#endif 1566 "tap|" 1567 "bridge|" 1568#ifdef CONFIG_VDE 1569 "vde|" 1570#endif 1571#ifdef CONFIG_NETMAP 1572 "netmap|" 1573#endif 1574 "socket][,vlan=n][,option][,option][,...]\n" 1575 " old way to initialize a host network interface\n" 1576 " (use the -netdev option if possible instead)\n", QEMU_ARCH_ALL) 1577STEXI 1578@item -net nic[,vlan=@var{n}][,macaddr=@var{mac}][,model=@var{type}] [,name=@var{name}][,addr=@var{addr}][,vectors=@var{v}] 1579@findex -net 1580Create a new Network Interface Card and connect it to VLAN @var{n} (@var{n} 1581= 0 is the default). The NIC is an e1000 by default on the PC 1582target. Optionally, the MAC address can be changed to @var{mac}, the 1583device address set to @var{addr} (PCI cards only), 1584and a @var{name} can be assigned for use in monitor commands. 1585Optionally, for PCI cards, you can specify the number @var{v} of MSI-X vectors 1586that the card should have; this option currently only affects virtio cards; set 1587@var{v} = 0 to disable MSI-X. If no @option{-net} option is specified, a single 1588NIC is created. QEMU can emulate several different models of network card. 1589Valid values for @var{type} are 1590@code{virtio}, @code{i82551}, @code{i82557b}, @code{i82559er}, 1591@code{ne2k_pci}, @code{ne2k_isa}, @code{pcnet}, @code{rtl8139}, 1592@code{e1000}, @code{smc91c111}, @code{lance} and @code{mcf_fec}. 1593Not all devices are supported on all targets. Use @code{-net nic,model=help} 1594for a list of available devices for your target. 1595 1596@item -netdev user,id=@var{id}[,@var{option}][,@var{option}][,...] 1597@findex -netdev 1598@item -net user[,@var{option}][,@var{option}][,...] 1599Use the user mode network stack which requires no administrator 1600privilege to run. Valid options are: 1601 1602@table @option 1603@item vlan=@var{n} 1604Connect user mode stack to VLAN @var{n} (@var{n} = 0 is the default). 1605 1606@item id=@var{id} 1607@item name=@var{name} 1608Assign symbolic name for use in monitor commands. 1609 1610@item net=@var{addr}[/@var{mask}] 1611Set IP network address the guest will see. Optionally specify the netmask, 1612either in the form a.b.c.d or as number of valid top-most bits. Default is 161310.0.2.0/24. 1614 1615@item host=@var{addr} 1616Specify the guest-visible address of the host. Default is the 2nd IP in the 1617guest network, i.e. x.x.x.2. 1618 1619@item restrict=on|off 1620If this option is enabled, the guest will be isolated, i.e. it will not be 1621able to contact the host and no guest IP packets will be routed over the host 1622to the outside. This option does not affect any explicitly set forwarding rules. 1623 1624@item hostname=@var{name} 1625Specifies the client hostname reported by the built-in DHCP server. 1626 1627@item dhcpstart=@var{addr} 1628Specify the first of the 16 IPs the built-in DHCP server can assign. Default 1629is the 15th to 31st IP in the guest network, i.e. x.x.x.15 to x.x.x.31. 1630 1631@item dns=@var{addr} 1632Specify the guest-visible address of the virtual nameserver. The address must 1633be different from the host address. Default is the 3rd IP in the guest network, 1634i.e. x.x.x.3. 1635 1636@item dnssearch=@var{domain} 1637Provides an entry for the domain-search list sent by the built-in 1638DHCP server. More than one domain suffix can be transmitted by specifying 1639this option multiple times. If supported, this will cause the guest to 1640automatically try to append the given domain suffix(es) in case a domain name 1641can not be resolved. 1642 1643Example: 1644@example 1645qemu -net user,dnssearch=mgmt.example.org,dnssearch=example.org [...] 1646@end example 1647 1648@item tftp=@var{dir} 1649When using the user mode network stack, activate a built-in TFTP 1650server. The files in @var{dir} will be exposed as the root of a TFTP server. 1651The TFTP client on the guest must be configured in binary mode (use the command 1652@code{bin} of the Unix TFTP client). 1653 1654@item bootfile=@var{file} 1655When using the user mode network stack, broadcast @var{file} as the BOOTP 1656filename. In conjunction with @option{tftp}, this can be used to network boot 1657a guest from a local directory. 1658 1659Example (using pxelinux): 1660@example 1661qemu-system-i386 -hda linux.img -boot n -net user,tftp=/path/to/tftp/files,bootfile=/pxelinux.0 1662@end example 1663 1664@item smb=@var{dir}[,smbserver=@var{addr}] 1665When using the user mode network stack, activate a built-in SMB 1666server so that Windows OSes can access to the host files in @file{@var{dir}} 1667transparently. The IP address of the SMB server can be set to @var{addr}. By 1668default the 4th IP in the guest network is used, i.e. x.x.x.4. 1669 1670In the guest Windows OS, the line: 1671@example 167210.0.2.4 smbserver 1673@end example 1674must be added in the file @file{C:\WINDOWS\LMHOSTS} (for windows 9x/Me) 1675or @file{C:\WINNT\SYSTEM32\DRIVERS\ETC\LMHOSTS} (Windows NT/2000). 1676 1677Then @file{@var{dir}} can be accessed in @file{\\smbserver\qemu}. 1678 1679Note that a SAMBA server must be installed on the host OS. 1680QEMU was tested successfully with smbd versions from Red Hat 9, 1681Fedora Core 3 and OpenSUSE 11.x. 1682 1683@item hostfwd=[tcp|udp]:[@var{hostaddr}]:@var{hostport}-[@var{guestaddr}]:@var{guestport} 1684Redirect incoming TCP or UDP connections to the host port @var{hostport} to 1685the guest IP address @var{guestaddr} on guest port @var{guestport}. If 1686@var{guestaddr} is not specified, its value is x.x.x.15 (default first address 1687given by the built-in DHCP server). By specifying @var{hostaddr}, the rule can 1688be bound to a specific host interface. If no connection type is set, TCP is 1689used. This option can be given multiple times. 1690 1691For example, to redirect host X11 connection from screen 1 to guest 1692screen 0, use the following: 1693 1694@example 1695# on the host 1696qemu-system-i386 -net user,hostfwd=tcp:127.0.0.1:6001-:6000 [...] 1697# this host xterm should open in the guest X11 server 1698xterm -display :1 1699@end example 1700 1701To redirect telnet connections from host port 5555 to telnet port on 1702the guest, use the following: 1703 1704@example 1705# on the host 1706qemu-system-i386 -net user,hostfwd=tcp::5555-:23 [...] 1707telnet localhost 5555 1708@end example 1709 1710Then when you use on the host @code{telnet localhost 5555}, you 1711connect to the guest telnet server. 1712 1713@item guestfwd=[tcp]:@var{server}:@var{port}-@var{dev} 1714@item guestfwd=[tcp]:@var{server}:@var{port}-@var{cmd:command} 1715Forward guest TCP connections to the IP address @var{server} on port @var{port} 1716to the character device @var{dev} or to a program executed by @var{cmd:command} 1717which gets spawned for each connection. This option can be given multiple times. 1718 1719You can either use a chardev directly and have that one used throughout QEMU's 1720lifetime, like in the following example: 1721 1722@example 1723# open 10.10.1.1:4321 on bootup, connect 10.0.2.100:1234 to it whenever 1724# the guest accesses it 1725qemu -net user,guestfwd=tcp:10.0.2.100:1234-tcp:10.10.1.1:4321 [...] 1726@end example 1727 1728Or you can execute a command on every TCP connection established by the guest, 1729so that QEMU behaves similar to an inetd process for that virtual server: 1730 1731@example 1732# call "netcat 10.10.1.1 4321" on every TCP connection to 10.0.2.100:1234 1733# and connect the TCP stream to its stdin/stdout 1734qemu -net 'user,guestfwd=tcp:10.0.2.100:1234-cmd:netcat 10.10.1.1 4321' 1735@end example 1736 1737@end table 1738 1739Note: Legacy stand-alone options -tftp, -bootp, -smb and -redir are still 1740processed and applied to -net user. Mixing them with the new configuration 1741syntax gives undefined results. Their use for new applications is discouraged 1742as they will be removed from future versions. 1743 1744@item -netdev tap,id=@var{id}[,fd=@var{h}][,ifname=@var{name}][,script=@var{file}][,downscript=@var{dfile}][,helper=@var{helper}] 1745@item -net tap[,vlan=@var{n}][,name=@var{name}][,fd=@var{h}][,ifname=@var{name}][,script=@var{file}][,downscript=@var{dfile}][,helper=@var{helper}] 1746Connect the host TAP network interface @var{name} to VLAN @var{n}. 1747 1748Use the network script @var{file} to configure it and the network script 1749@var{dfile} to deconfigure it. If @var{name} is not provided, the OS 1750automatically provides one. The default network configure script is 1751@file{/etc/qemu-ifup} and the default network deconfigure script is 1752@file{/etc/qemu-ifdown}. Use @option{script=no} or @option{downscript=no} 1753to disable script execution. 1754 1755If running QEMU as an unprivileged user, use the network helper 1756@var{helper} to configure the TAP interface. The default network 1757helper executable is @file{/path/to/qemu-bridge-helper}. 1758 1759@option{fd}=@var{h} can be used to specify the handle of an already 1760opened host TAP interface. 1761 1762Examples: 1763 1764@example 1765#launch a QEMU instance with the default network script 1766qemu-system-i386 linux.img -net nic -net tap 1767@end example 1768 1769@example 1770#launch a QEMU instance with two NICs, each one connected 1771#to a TAP device 1772qemu-system-i386 linux.img \ 1773 -net nic,vlan=0 -net tap,vlan=0,ifname=tap0 \ 1774 -net nic,vlan=1 -net tap,vlan=1,ifname=tap1 1775@end example 1776 1777@example 1778#launch a QEMU instance with the default network helper to 1779#connect a TAP device to bridge br0 1780qemu-system-i386 linux.img \ 1781 -net nic -net tap,"helper=/path/to/qemu-bridge-helper" 1782@end example 1783 1784@item -netdev bridge,id=@var{id}[,br=@var{bridge}][,helper=@var{helper}] 1785@item -net bridge[,vlan=@var{n}][,name=@var{name}][,br=@var{bridge}][,helper=@var{helper}] 1786Connect a host TAP network interface to a host bridge device. 1787 1788Use the network helper @var{helper} to configure the TAP interface and 1789attach it to the bridge. The default network helper executable is 1790@file{/path/to/qemu-bridge-helper} and the default bridge 1791device is @file{br0}. 1792 1793Examples: 1794 1795@example 1796#launch a QEMU instance with the default network helper to 1797#connect a TAP device to bridge br0 1798qemu-system-i386 linux.img -net bridge -net nic,model=virtio 1799@end example 1800 1801@example 1802#launch a QEMU instance with the default network helper to 1803#connect a TAP device to bridge qemubr0 1804qemu-system-i386 linux.img -net bridge,br=qemubr0 -net nic,model=virtio 1805@end example 1806 1807@item -netdev socket,id=@var{id}[,fd=@var{h}][,listen=[@var{host}]:@var{port}][,connect=@var{host}:@var{port}] 1808@item -net socket[,vlan=@var{n}][,name=@var{name}][,fd=@var{h}] [,listen=[@var{host}]:@var{port}][,connect=@var{host}:@var{port}] 1809 1810Connect the VLAN @var{n} to a remote VLAN in another QEMU virtual 1811machine using a TCP socket connection. If @option{listen} is 1812specified, QEMU waits for incoming connections on @var{port} 1813(@var{host} is optional). @option{connect} is used to connect to 1814another QEMU instance using the @option{listen} option. @option{fd}=@var{h} 1815specifies an already opened TCP socket. 1816 1817Example: 1818@example 1819# launch a first QEMU instance 1820qemu-system-i386 linux.img \ 1821 -net nic,macaddr=52:54:00:12:34:56 \ 1822 -net socket,listen=:1234 1823# connect the VLAN 0 of this instance to the VLAN 0 1824# of the first instance 1825qemu-system-i386 linux.img \ 1826 -net nic,macaddr=52:54:00:12:34:57 \ 1827 -net socket,connect=127.0.0.1:1234 1828@end example 1829 1830@item -netdev socket,id=@var{id}[,fd=@var{h}][,mcast=@var{maddr}:@var{port}[,localaddr=@var{addr}]] 1831@item -net socket[,vlan=@var{n}][,name=@var{name}][,fd=@var{h}][,mcast=@var{maddr}:@var{port}[,localaddr=@var{addr}]] 1832 1833Create a VLAN @var{n} shared with another QEMU virtual 1834machines using a UDP multicast socket, effectively making a bus for 1835every QEMU with same multicast address @var{maddr} and @var{port}. 1836NOTES: 1837@enumerate 1838@item 1839Several QEMU can be running on different hosts and share same bus (assuming 1840correct multicast setup for these hosts). 1841@item 1842mcast support is compatible with User Mode Linux (argument @option{eth@var{N}=mcast}), see 1843@url{http://user-mode-linux.sf.net}. 1844@item 1845Use @option{fd=h} to specify an already opened UDP multicast socket. 1846@end enumerate 1847 1848Example: 1849@example 1850# launch one QEMU instance 1851qemu-system-i386 linux.img \ 1852 -net nic,macaddr=52:54:00:12:34:56 \ 1853 -net socket,mcast=230.0.0.1:1234 1854# launch another QEMU instance on same "bus" 1855qemu-system-i386 linux.img \ 1856 -net nic,macaddr=52:54:00:12:34:57 \ 1857 -net socket,mcast=230.0.0.1:1234 1858# launch yet another QEMU instance on same "bus" 1859qemu-system-i386 linux.img \ 1860 -net nic,macaddr=52:54:00:12:34:58 \ 1861 -net socket,mcast=230.0.0.1:1234 1862@end example 1863 1864Example (User Mode Linux compat.): 1865@example 1866# launch QEMU instance (note mcast address selected 1867# is UML's default) 1868qemu-system-i386 linux.img \ 1869 -net nic,macaddr=52:54:00:12:34:56 \ 1870 -net socket,mcast=239.192.168.1:1102 1871# launch UML 1872/path/to/linux ubd0=/path/to/root_fs eth0=mcast 1873@end example 1874 1875Example (send packets from host's 1.2.3.4): 1876@example 1877qemu-system-i386 linux.img \ 1878 -net nic,macaddr=52:54:00:12:34:56 \ 1879 -net socket,mcast=239.192.168.1:1102,localaddr=1.2.3.4 1880@end example 1881 1882@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}] 1883@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}] 1884Connect VLAN @var{n} to L2TPv3 pseudowire. L2TPv3 (RFC3391) is a popular 1885protocol to transport Ethernet (and other Layer 2) data frames between 1886two systems. It is present in routers, firewalls and the Linux kernel 1887(from version 3.3 onwards). 1888 1889This transport allows a VM to communicate to another VM, router or firewall directly. 1890 1891@item src=@var{srcaddr} 1892 source address (mandatory) 1893@item dst=@var{dstaddr} 1894 destination address (mandatory) 1895@item udp 1896 select udp encapsulation (default is ip). 1897@item srcport=@var{srcport} 1898 source udp port. 1899@item dstport=@var{dstport} 1900 destination udp port. 1901@item ipv6 1902 force v6, otherwise defaults to v4. 1903@item rxcookie=@var{rxcookie} 1904@item txcookie=@var{txcookie} 1905 Cookies are a weak form of security in the l2tpv3 specification. 1906Their function is mostly to prevent misconfiguration. By default they are 32 1907bit. 1908@item cookie64 1909 Set cookie size to 64 bit instead of the default 32 1910@item counter=off 1911 Force a 'cut-down' L2TPv3 with no counter as in 1912draft-mkonstan-l2tpext-keyed-ipv6-tunnel-00 1913@item pincounter=on 1914 Work around broken counter handling in peer. This may also help on 1915networks which have packet reorder. 1916@item offset=@var{offset} 1917 Add an extra offset between header and data 1918 1919For example, to attach a VM running on host 4.3.2.1 via L2TPv3 to the bridge br-lan 1920on the remote Linux host 1.2.3.4: 1921@example 1922# Setup tunnel on linux host using raw ip as encapsulation 1923# on 1.2.3.4 1924ip l2tp add tunnel remote 4.3.2.1 local 1.2.3.4 tunnel_id 1 peer_tunnel_id 1 \ 1925 encap udp udp_sport 16384 udp_dport 16384 1926ip l2tp add session tunnel_id 1 name vmtunnel0 session_id \ 1927 0xFFFFFFFF peer_session_id 0xFFFFFFFF 1928ifconfig vmtunnel0 mtu 1500 1929ifconfig vmtunnel0 up 1930brctl addif br-lan vmtunnel0 1931 1932 1933# on 4.3.2.1 1934# launch QEMU instance - if your network has reorder or is very lossy add ,pincounter 1935 1936qemu-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 1937 1938 1939@end example 1940 1941@item -netdev vde,id=@var{id}[,sock=@var{socketpath}][,port=@var{n}][,group=@var{groupname}][,mode=@var{octalmode}] 1942@item -net vde[,vlan=@var{n}][,name=@var{name}][,sock=@var{socketpath}] [,port=@var{n}][,group=@var{groupname}][,mode=@var{octalmode}] 1943Connect VLAN @var{n} to PORT @var{n} of a vde switch running on host and 1944listening for incoming connections on @var{socketpath}. Use GROUP @var{groupname} 1945and MODE @var{octalmode} to change default ownership and permissions for 1946communication port. This option is only available if QEMU has been compiled 1947with vde support enabled. 1948 1949Example: 1950@example 1951# launch vde switch 1952vde_switch -F -sock /tmp/myswitch 1953# launch QEMU instance 1954qemu-system-i386 linux.img -net nic -net vde,sock=/tmp/myswitch 1955@end example 1956 1957@item -netdev hubport,id=@var{id},hubid=@var{hubid} 1958 1959Create a hub port on QEMU "vlan" @var{hubid}. 1960 1961The hubport netdev lets you connect a NIC to a QEMU "vlan" instead of a single 1962netdev. @code{-net} and @code{-device} with parameter @option{vlan} create the 1963required hub automatically. 1964 1965@item -netdev vhost-user,chardev=@var{id}[,vhostforce=on|off][,queues=n] 1966 1967Establish a vhost-user netdev, backed by a chardev @var{id}. The chardev should 1968be a unix domain socket backed one. The vhost-user uses a specifically defined 1969protocol to pass vhost ioctl replacement messages to an application on the other 1970end of the socket. On non-MSIX guests, the feature can be forced with 1971@var{vhostforce}. Use 'queues=@var{n}' to specify the number of queues to 1972be created for multiqueue vhost-user. 1973 1974Example: 1975@example 1976qemu -m 512 -object memory-backend-file,id=mem,size=512M,mem-path=/hugetlbfs,share=on \ 1977 -numa node,memdev=mem \ 1978 -chardev socket,path=/path/to/socket \ 1979 -netdev type=vhost-user,id=net0,chardev=chr0 \ 1980 -device virtio-net-pci,netdev=net0 1981@end example 1982 1983@item -net dump[,vlan=@var{n}][,file=@var{file}][,len=@var{len}] 1984Dump network traffic on VLAN @var{n} to file @var{file} (@file{qemu-vlan0.pcap} by default). 1985At most @var{len} bytes (64k by default) per packet are stored. The file format is 1986libpcap, so it can be analyzed with tools such as tcpdump or Wireshark. 1987 1988@item -net none 1989Indicate that no network devices should be configured. It is used to 1990override the default configuration (@option{-net nic -net user}) which 1991is activated if no @option{-net} options are provided. 1992ETEXI 1993 1994STEXI 1995@end table 1996ETEXI 1997DEFHEADING() 1998 1999DEFHEADING(Character device options:) 2000STEXI 2001 2002The general form of a character device option is: 2003@table @option 2004ETEXI 2005 2006DEF("chardev", HAS_ARG, QEMU_OPTION_chardev, 2007 "-chardev null,id=id[,mux=on|off]\n" 2008 "-chardev socket,id=id[,host=host],port=port[,to=to][,ipv4][,ipv6][,nodelay][,reconnect=seconds]\n" 2009 " [,server][,nowait][,telnet][,reconnect=seconds][,mux=on|off] (tcp)\n" 2010 "-chardev socket,id=id,path=path[,server][,nowait][,telnet][,reconnect=seconds][,mux=on|off] (unix)\n" 2011 "-chardev udp,id=id[,host=host],port=port[,localaddr=localaddr]\n" 2012 " [,localport=localport][,ipv4][,ipv6][,mux=on|off]\n" 2013 "-chardev msmouse,id=id[,mux=on|off]\n" 2014 "-chardev vc,id=id[[,width=width][,height=height]][[,cols=cols][,rows=rows]]\n" 2015 " [,mux=on|off]\n" 2016 "-chardev ringbuf,id=id[,size=size]\n" 2017 "-chardev file,id=id,path=path[,mux=on|off]\n" 2018 "-chardev pipe,id=id,path=path[,mux=on|off]\n" 2019#ifdef _WIN32 2020 "-chardev console,id=id[,mux=on|off]\n" 2021 "-chardev serial,id=id,path=path[,mux=on|off]\n" 2022#else 2023 "-chardev pty,id=id[,mux=on|off]\n" 2024 "-chardev stdio,id=id[,mux=on|off][,signal=on|off]\n" 2025#endif 2026#ifdef CONFIG_BRLAPI 2027 "-chardev braille,id=id[,mux=on|off]\n" 2028#endif 2029#if defined(__linux__) || defined(__sun__) || defined(__FreeBSD__) \ 2030 || defined(__NetBSD__) || defined(__OpenBSD__) || defined(__DragonFly__) 2031 "-chardev serial,id=id,path=path[,mux=on|off]\n" 2032 "-chardev tty,id=id,path=path[,mux=on|off]\n" 2033#endif 2034#if defined(__linux__) || defined(__FreeBSD__) || defined(__DragonFly__) 2035 "-chardev parallel,id=id,path=path[,mux=on|off]\n" 2036 "-chardev parport,id=id,path=path[,mux=on|off]\n" 2037#endif 2038#if defined(CONFIG_SPICE) 2039 "-chardev spicevmc,id=id,name=name[,debug=debug]\n" 2040 "-chardev spiceport,id=id,name=name[,debug=debug]\n" 2041#endif 2042 , QEMU_ARCH_ALL 2043) 2044 2045STEXI 2046@item -chardev @var{backend} ,id=@var{id} [,mux=on|off] [,@var{options}] 2047@findex -chardev 2048Backend is one of: 2049@option{null}, 2050@option{socket}, 2051@option{udp}, 2052@option{msmouse}, 2053@option{vc}, 2054@option{ringbuf}, 2055@option{file}, 2056@option{pipe}, 2057@option{console}, 2058@option{serial}, 2059@option{pty}, 2060@option{stdio}, 2061@option{braille}, 2062@option{tty}, 2063@option{parallel}, 2064@option{parport}, 2065@option{spicevmc}. 2066@option{spiceport}. 2067The specific backend will determine the applicable options. 2068 2069All devices must have an id, which can be any string up to 127 characters long. 2070It is used to uniquely identify this device in other command line directives. 2071 2072A character device may be used in multiplexing mode by multiple front-ends. 2073The key sequence of @key{Control-a} and @key{c} will rotate the input focus 2074between attached front-ends. Specify @option{mux=on} to enable this mode. 2075 2076Options to each backend are described below. 2077 2078@item -chardev null ,id=@var{id} 2079A void device. This device will not emit any data, and will drop any data it 2080receives. The null backend does not take any options. 2081 2082@item -chardev socket ,id=@var{id} [@var{TCP options} or @var{unix options}] [,server] [,nowait] [,telnet] [,reconnect=@var{seconds}] 2083 2084Create a two-way stream socket, which can be either a TCP or a unix socket. A 2085unix socket will be created if @option{path} is specified. Behaviour is 2086undefined if TCP options are specified for a unix socket. 2087 2088@option{server} specifies that the socket shall be a listening socket. 2089 2090@option{nowait} specifies that QEMU should not block waiting for a client to 2091connect to a listening socket. 2092 2093@option{telnet} specifies that traffic on the socket should interpret telnet 2094escape sequences. 2095 2096@option{reconnect} sets the timeout for reconnecting on non-server sockets when 2097the remote end goes away. qemu will delay this many seconds and then attempt 2098to reconnect. Zero disables reconnecting, and is the default. 2099 2100TCP and unix socket options are given below: 2101 2102@table @option 2103 2104@item TCP options: port=@var{port} [,host=@var{host}] [,to=@var{to}] [,ipv4] [,ipv6] [,nodelay] 2105 2106@option{host} for a listening socket specifies the local address to be bound. 2107For a connecting socket species the remote host to connect to. @option{host} is 2108optional for listening sockets. If not specified it defaults to @code{0.0.0.0}. 2109 2110@option{port} for a listening socket specifies the local port to be bound. For a 2111connecting socket specifies the port on the remote host to connect to. 2112@option{port} can be given as either a port number or a service name. 2113@option{port} is required. 2114 2115@option{to} is only relevant to listening sockets. If it is specified, and 2116@option{port} cannot be bound, QEMU will attempt to bind to subsequent ports up 2117to and including @option{to} until it succeeds. @option{to} must be specified 2118as a port number. 2119 2120@option{ipv4} and @option{ipv6} specify that either IPv4 or IPv6 must be used. 2121If neither is specified the socket may use either protocol. 2122 2123@option{nodelay} disables the Nagle algorithm. 2124 2125@item unix options: path=@var{path} 2126 2127@option{path} specifies the local path of the unix socket. @option{path} is 2128required. 2129 2130@end table 2131 2132@item -chardev udp ,id=@var{id} [,host=@var{host}] ,port=@var{port} [,localaddr=@var{localaddr}] [,localport=@var{localport}] [,ipv4] [,ipv6] 2133 2134Sends all traffic from the guest to a remote host over UDP. 2135 2136@option{host} specifies the remote host to connect to. If not specified it 2137defaults to @code{localhost}. 2138 2139@option{port} specifies the port on the remote host to connect to. @option{port} 2140is required. 2141 2142@option{localaddr} specifies the local address to bind to. If not specified it 2143defaults to @code{0.0.0.0}. 2144 2145@option{localport} specifies the local port to bind to. If not specified any 2146available local port will be used. 2147 2148@option{ipv4} and @option{ipv6} specify that either IPv4 or IPv6 must be used. 2149If neither is specified the device may use either protocol. 2150 2151@item -chardev msmouse ,id=@var{id} 2152 2153Forward QEMU's emulated msmouse events to the guest. @option{msmouse} does not 2154take any options. 2155 2156@item -chardev vc ,id=@var{id} [[,width=@var{width}] [,height=@var{height}]] [[,cols=@var{cols}] [,rows=@var{rows}]] 2157 2158Connect to a QEMU text console. @option{vc} may optionally be given a specific 2159size. 2160 2161@option{width} and @option{height} specify the width and height respectively of 2162the console, in pixels. 2163 2164@option{cols} and @option{rows} specify that the console be sized to fit a text 2165console with the given dimensions. 2166 2167@item -chardev ringbuf ,id=@var{id} [,size=@var{size}] 2168 2169Create a ring buffer with fixed size @option{size}. 2170@var{size} must be a power of two, and defaults to @code{64K}). 2171 2172@item -chardev file ,id=@var{id} ,path=@var{path} 2173 2174Log all traffic received from the guest to a file. 2175 2176@option{path} specifies the path of the file to be opened. This file will be 2177created if it does not already exist, and overwritten if it does. @option{path} 2178is required. 2179 2180@item -chardev pipe ,id=@var{id} ,path=@var{path} 2181 2182Create a two-way connection to the guest. The behaviour differs slightly between 2183Windows hosts and other hosts: 2184 2185On Windows, a single duplex pipe will be created at 2186@file{\\.pipe\@option{path}}. 2187 2188On other hosts, 2 pipes will be created called @file{@option{path}.in} and 2189@file{@option{path}.out}. Data written to @file{@option{path}.in} will be 2190received by the guest. Data written by the guest can be read from 2191@file{@option{path}.out}. QEMU will not create these fifos, and requires them to 2192be present. 2193 2194@option{path} forms part of the pipe path as described above. @option{path} is 2195required. 2196 2197@item -chardev console ,id=@var{id} 2198 2199Send traffic from the guest to QEMU's standard output. @option{console} does not 2200take any options. 2201 2202@option{console} is only available on Windows hosts. 2203 2204@item -chardev serial ,id=@var{id} ,path=@option{path} 2205 2206Send traffic from the guest to a serial device on the host. 2207 2208On Unix hosts serial will actually accept any tty device, 2209not only serial lines. 2210 2211@option{path} specifies the name of the serial device to open. 2212 2213@item -chardev pty ,id=@var{id} 2214 2215Create a new pseudo-terminal on the host and connect to it. @option{pty} does 2216not take any options. 2217 2218@option{pty} is not available on Windows hosts. 2219 2220@item -chardev stdio ,id=@var{id} [,signal=on|off] 2221Connect to standard input and standard output of the QEMU process. 2222 2223@option{signal} controls if signals are enabled on the terminal, that includes 2224exiting QEMU with the key sequence @key{Control-c}. This option is enabled by 2225default, use @option{signal=off} to disable it. 2226 2227@option{stdio} is not available on Windows hosts. 2228 2229@item -chardev braille ,id=@var{id} 2230 2231Connect to a local BrlAPI server. @option{braille} does not take any options. 2232 2233@item -chardev tty ,id=@var{id} ,path=@var{path} 2234 2235@option{tty} is only available on Linux, Sun, FreeBSD, NetBSD, OpenBSD and 2236DragonFlyBSD hosts. It is an alias for @option{serial}. 2237 2238@option{path} specifies the path to the tty. @option{path} is required. 2239 2240@item -chardev parallel ,id=@var{id} ,path=@var{path} 2241@item -chardev parport ,id=@var{id} ,path=@var{path} 2242 2243@option{parallel} is only available on Linux, FreeBSD and DragonFlyBSD hosts. 2244 2245Connect to a local parallel port. 2246 2247@option{path} specifies the path to the parallel port device. @option{path} is 2248required. 2249 2250@item -chardev spicevmc ,id=@var{id} ,debug=@var{debug}, name=@var{name} 2251 2252@option{spicevmc} is only available when spice support is built in. 2253 2254@option{debug} debug level for spicevmc 2255 2256@option{name} name of spice channel to connect to 2257 2258Connect to a spice virtual machine channel, such as vdiport. 2259 2260@item -chardev spiceport ,id=@var{id} ,debug=@var{debug}, name=@var{name} 2261 2262@option{spiceport} is only available when spice support is built in. 2263 2264@option{debug} debug level for spicevmc 2265 2266@option{name} name of spice port to connect to 2267 2268Connect to a spice port, allowing a Spice client to handle the traffic 2269identified by a name (preferably a fqdn). 2270ETEXI 2271 2272STEXI 2273@end table 2274ETEXI 2275DEFHEADING() 2276 2277DEFHEADING(Device URL Syntax:) 2278STEXI 2279 2280In addition to using normal file images for the emulated storage devices, 2281QEMU can also use networked resources such as iSCSI devices. These are 2282specified using a special URL syntax. 2283 2284@table @option 2285@item iSCSI 2286iSCSI support allows QEMU to access iSCSI resources directly and use as 2287images for the guest storage. Both disk and cdrom images are supported. 2288 2289Syntax for specifying iSCSI LUNs is 2290``iscsi://<target-ip>[:<port>]/<target-iqn>/<lun>'' 2291 2292By default qemu will use the iSCSI initiator-name 2293'iqn.2008-11.org.linux-kvm[:<name>]' but this can also be set from the command 2294line or a configuration file. 2295 2296 2297Example (without authentication): 2298@example 2299qemu-system-i386 -iscsi initiator-name=iqn.2001-04.com.example:my-initiator \ 2300 -cdrom iscsi://192.0.2.1/iqn.2001-04.com.example/2 \ 2301 -drive file=iscsi://192.0.2.1/iqn.2001-04.com.example/1 2302@end example 2303 2304Example (CHAP username/password via URL): 2305@example 2306qemu-system-i386 -drive file=iscsi://user%password@@192.0.2.1/iqn.2001-04.com.example/1 2307@end example 2308 2309Example (CHAP username/password via environment variables): 2310@example 2311LIBISCSI_CHAP_USERNAME="user" \ 2312LIBISCSI_CHAP_PASSWORD="password" \ 2313qemu-system-i386 -drive file=iscsi://192.0.2.1/iqn.2001-04.com.example/1 2314@end example 2315 2316iSCSI support is an optional feature of QEMU and only available when 2317compiled and linked against libiscsi. 2318ETEXI 2319DEF("iscsi", HAS_ARG, QEMU_OPTION_iscsi, 2320 "-iscsi [user=user][,password=password]\n" 2321 " [,header-digest=CRC32C|CR32C-NONE|NONE-CRC32C|NONE\n" 2322 " [,initiator-name=initiator-iqn][,id=target-iqn]\n" 2323 " iSCSI session parameters\n", QEMU_ARCH_ALL) 2324STEXI 2325 2326iSCSI parameters such as username and password can also be specified via 2327a configuration file. See qemu-doc for more information and examples. 2328 2329@item NBD 2330QEMU supports NBD (Network Block Devices) both using TCP protocol as well 2331as Unix Domain Sockets. 2332 2333Syntax for specifying a NBD device using TCP 2334``nbd:<server-ip>:<port>[:exportname=<export>]'' 2335 2336Syntax for specifying a NBD device using Unix Domain Sockets 2337``nbd:unix:<domain-socket>[:exportname=<export>]'' 2338 2339 2340Example for TCP 2341@example 2342qemu-system-i386 --drive file=nbd:192.0.2.1:30000 2343@end example 2344 2345Example for Unix Domain Sockets 2346@example 2347qemu-system-i386 --drive file=nbd:unix:/tmp/nbd-socket 2348@end example 2349 2350@item SSH 2351QEMU supports SSH (Secure Shell) access to remote disks. 2352 2353Examples: 2354@example 2355qemu-system-i386 -drive file=ssh://user@@host/path/to/disk.img 2356qemu-system-i386 -drive file.driver=ssh,file.user=user,file.host=host,file.port=22,file.path=/path/to/disk.img 2357@end example 2358 2359Currently authentication must be done using ssh-agent. Other 2360authentication methods may be supported in future. 2361 2362@item Sheepdog 2363Sheepdog is a distributed storage system for QEMU. 2364QEMU supports using either local sheepdog devices or remote networked 2365devices. 2366 2367Syntax for specifying a sheepdog device 2368@example 2369sheepdog[+tcp|+unix]://[host:port]/vdiname[?socket=path][#snapid|#tag] 2370@end example 2371 2372Example 2373@example 2374qemu-system-i386 --drive file=sheepdog://192.0.2.1:30000/MyVirtualMachine 2375@end example 2376 2377See also @url{http://http://www.osrg.net/sheepdog/}. 2378 2379@item GlusterFS 2380GlusterFS is an user space distributed file system. 2381QEMU supports the use of GlusterFS volumes for hosting VM disk images using 2382TCP, Unix Domain Sockets and RDMA transport protocols. 2383 2384Syntax for specifying a VM disk image on GlusterFS volume is 2385@example 2386gluster[+transport]://[server[:port]]/volname/image[?socket=...] 2387@end example 2388 2389 2390Example 2391@example 2392qemu-system-x86_64 --drive file=gluster://192.0.2.1/testvol/a.img 2393@end example 2394 2395See also @url{http://www.gluster.org}. 2396 2397@item HTTP/HTTPS/FTP/FTPS/TFTP 2398QEMU supports read-only access to files accessed over http(s), ftp(s) and tftp. 2399 2400Syntax using a single filename: 2401@example 2402<protocol>://[<username>[:<password>]@@]<host>/<path> 2403@end example 2404 2405where: 2406@table @option 2407@item protocol 2408'http', 'https', 'ftp', 'ftps', or 'tftp'. 2409 2410@item username 2411Optional username for authentication to the remote server. 2412 2413@item password 2414Optional password for authentication to the remote server. 2415 2416@item host 2417Address of the remote server. 2418 2419@item path 2420Path on the remote server, including any query string. 2421@end table 2422 2423The following options are also supported: 2424@table @option 2425@item url 2426The full URL when passing options to the driver explicitly. 2427 2428@item readahead 2429The amount of data to read ahead with each range request to the remote server. 2430This value may optionally have the suffix 'T', 'G', 'M', 'K', 'k' or 'b'. If it 2431does not have a suffix, it will be assumed to be in bytes. The value must be a 2432multiple of 512 bytes. It defaults to 256k. 2433 2434@item sslverify 2435Whether to verify the remote server's certificate when connecting over SSL. It 2436can have the value 'on' or 'off'. It defaults to 'on'. 2437 2438@item cookie 2439Send this cookie (it can also be a list of cookies separated by ';') with 2440each outgoing request. Only supported when using protocols such as HTTP 2441which support cookies, otherwise ignored. 2442 2443@item timeout 2444Set the timeout in seconds of the CURL connection. This timeout is the time 2445that CURL waits for a response from the remote server to get the size of the 2446image to be downloaded. If not set, the default timeout of 5 seconds is used. 2447@end table 2448 2449Note that when passing options to qemu explicitly, @option{driver} is the value 2450of <protocol>. 2451 2452Example: boot from a remote Fedora 20 live ISO image 2453@example 2454qemu-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 2455 2456qemu-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 2457@end example 2458 2459Example: boot from a remote Fedora 20 cloud image using a local overlay for 2460writes, copy-on-read, and a readahead of 64k 2461@example 2462qemu-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 2463 2464qemu-system-x86_64 -drive file=/tmp/Fedora-x86_64-20-20131211.1-sda.qcow2,copy-on-read=on 2465@end example 2466 2467Example: boot from an image stored on a VMware vSphere server with a self-signed 2468certificate using a local overlay for writes, a readahead of 64k and a timeout 2469of 10 seconds. 2470@example 2471qemu-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 2472 2473qemu-system-x86_64 -drive file=/tmp/test.qcow2 2474@end example 2475ETEXI 2476 2477STEXI 2478@end table 2479ETEXI 2480 2481DEFHEADING(Bluetooth(R) options:) 2482STEXI 2483@table @option 2484ETEXI 2485 2486DEF("bt", HAS_ARG, QEMU_OPTION_bt, \ 2487 "-bt hci,null dumb bluetooth HCI - doesn't respond to commands\n" \ 2488 "-bt hci,host[:id]\n" \ 2489 " use host's HCI with the given name\n" \ 2490 "-bt hci[,vlan=n]\n" \ 2491 " emulate a standard HCI in virtual scatternet 'n'\n" \ 2492 "-bt vhci[,vlan=n]\n" \ 2493 " add host computer to virtual scatternet 'n' using VHCI\n" \ 2494 "-bt device:dev[,vlan=n]\n" \ 2495 " emulate a bluetooth device 'dev' in scatternet 'n'\n", 2496 QEMU_ARCH_ALL) 2497STEXI 2498@item -bt hci[...] 2499@findex -bt 2500Defines the function of the corresponding Bluetooth HCI. -bt options 2501are matched with the HCIs present in the chosen machine type. For 2502example when emulating a machine with only one HCI built into it, only 2503the first @code{-bt hci[...]} option is valid and defines the HCI's 2504logic. The Transport Layer is decided by the machine type. Currently 2505the machines @code{n800} and @code{n810} have one HCI and all other 2506machines have none. 2507 2508@anchor{bt-hcis} 2509The following three types are recognized: 2510 2511@table @option 2512@item -bt hci,null 2513(default) The corresponding Bluetooth HCI assumes no internal logic 2514and will not respond to any HCI commands or emit events. 2515 2516@item -bt hci,host[:@var{id}] 2517(@code{bluez} only) The corresponding HCI passes commands / events 2518to / from the physical HCI identified by the name @var{id} (default: 2519@code{hci0}) on the computer running QEMU. Only available on @code{bluez} 2520capable systems like Linux. 2521 2522@item -bt hci[,vlan=@var{n}] 2523Add a virtual, standard HCI that will participate in the Bluetooth 2524scatternet @var{n} (default @code{0}). Similarly to @option{-net} 2525VLANs, devices inside a bluetooth network @var{n} can only communicate 2526with other devices in the same network (scatternet). 2527@end table 2528 2529@item -bt vhci[,vlan=@var{n}] 2530(Linux-host only) Create a HCI in scatternet @var{n} (default 0) attached 2531to the host bluetooth stack instead of to the emulated target. This 2532allows the host and target machines to participate in a common scatternet 2533and communicate. Requires the Linux @code{vhci} driver installed. Can 2534be used as following: 2535 2536@example 2537qemu-system-i386 [...OPTIONS...] -bt hci,vlan=5 -bt vhci,vlan=5 2538@end example 2539 2540@item -bt device:@var{dev}[,vlan=@var{n}] 2541Emulate a bluetooth device @var{dev} and place it in network @var{n} 2542(default @code{0}). QEMU can only emulate one type of bluetooth devices 2543currently: 2544 2545@table @option 2546@item keyboard 2547Virtual wireless keyboard implementing the HIDP bluetooth profile. 2548@end table 2549ETEXI 2550 2551STEXI 2552@end table 2553ETEXI 2554DEFHEADING() 2555 2556#ifdef CONFIG_TPM 2557DEFHEADING(TPM device options:) 2558 2559DEF("tpmdev", HAS_ARG, QEMU_OPTION_tpmdev, \ 2560 "-tpmdev passthrough,id=id[,path=path][,cancel-path=path]\n" 2561 " use path to provide path to a character device; default is /dev/tpm0\n" 2562 " use cancel-path to provide path to TPM's cancel sysfs entry; if\n" 2563 " not provided it will be searched for in /sys/class/misc/tpm?/device\n", 2564 QEMU_ARCH_ALL) 2565STEXI 2566 2567The general form of a TPM device option is: 2568@table @option 2569 2570@item -tpmdev @var{backend} ,id=@var{id} [,@var{options}] 2571@findex -tpmdev 2572Backend type must be: 2573@option{passthrough}. 2574 2575The specific backend type will determine the applicable options. 2576The @code{-tpmdev} option creates the TPM backend and requires a 2577@code{-device} option that specifies the TPM frontend interface model. 2578 2579Options to each backend are described below. 2580 2581Use 'help' to print all available TPM backend types. 2582@example 2583qemu -tpmdev help 2584@end example 2585 2586@item -tpmdev passthrough, id=@var{id}, path=@var{path}, cancel-path=@var{cancel-path} 2587 2588(Linux-host only) Enable access to the host's TPM using the passthrough 2589driver. 2590 2591@option{path} specifies the path to the host's TPM device, i.e., on 2592a Linux host this would be @code{/dev/tpm0}. 2593@option{path} is optional and by default @code{/dev/tpm0} is used. 2594 2595@option{cancel-path} specifies the path to the host TPM device's sysfs 2596entry allowing for cancellation of an ongoing TPM command. 2597@option{cancel-path} is optional and by default QEMU will search for the 2598sysfs entry to use. 2599 2600Some notes about using the host's TPM with the passthrough driver: 2601 2602The TPM device accessed by the passthrough driver must not be 2603used by any other application on the host. 2604 2605Since the host's firmware (BIOS/UEFI) has already initialized the TPM, 2606the VM's firmware (BIOS/UEFI) will not be able to initialize the 2607TPM again and may therefore not show a TPM-specific menu that would 2608otherwise allow the user to configure the TPM, e.g., allow the user to 2609enable/disable or activate/deactivate the TPM. 2610Further, if TPM ownership is released from within a VM then the host's TPM 2611will get disabled and deactivated. To enable and activate the 2612TPM again afterwards, the host has to be rebooted and the user is 2613required to enter the firmware's menu to enable and activate the TPM. 2614If the TPM is left disabled and/or deactivated most TPM commands will fail. 2615 2616To create a passthrough TPM use the following two options: 2617@example 2618-tpmdev passthrough,id=tpm0 -device tpm-tis,tpmdev=tpm0 2619@end example 2620Note that the @code{-tpmdev} id is @code{tpm0} and is referenced by 2621@code{tpmdev=tpm0} in the device option. 2622 2623@end table 2624 2625ETEXI 2626 2627DEFHEADING() 2628 2629#endif 2630 2631DEFHEADING(Linux/Multiboot boot specific:) 2632STEXI 2633 2634When using these options, you can use a given Linux or Multiboot 2635kernel without installing it in the disk image. It can be useful 2636for easier testing of various kernels. 2637 2638@table @option 2639ETEXI 2640 2641DEF("kernel", HAS_ARG, QEMU_OPTION_kernel, \ 2642 "-kernel bzImage use 'bzImage' as kernel image\n", QEMU_ARCH_ALL) 2643STEXI 2644@item -kernel @var{bzImage} 2645@findex -kernel 2646Use @var{bzImage} as kernel image. The kernel can be either a Linux kernel 2647or in multiboot format. 2648ETEXI 2649 2650DEF("append", HAS_ARG, QEMU_OPTION_append, \ 2651 "-append cmdline use 'cmdline' as kernel command line\n", QEMU_ARCH_ALL) 2652STEXI 2653@item -append @var{cmdline} 2654@findex -append 2655Use @var{cmdline} as kernel command line 2656ETEXI 2657 2658DEF("initrd", HAS_ARG, QEMU_OPTION_initrd, \ 2659 "-initrd file use 'file' as initial ram disk\n", QEMU_ARCH_ALL) 2660STEXI 2661@item -initrd @var{file} 2662@findex -initrd 2663Use @var{file} as initial ram disk. 2664 2665@item -initrd "@var{file1} arg=foo,@var{file2}" 2666 2667This syntax is only available with multiboot. 2668 2669Use @var{file1} and @var{file2} as modules and pass arg=foo as parameter to the 2670first module. 2671ETEXI 2672 2673DEF("dtb", HAS_ARG, QEMU_OPTION_dtb, \ 2674 "-dtb file use 'file' as device tree image\n", QEMU_ARCH_ALL) 2675STEXI 2676@item -dtb @var{file} 2677@findex -dtb 2678Use @var{file} as a device tree binary (dtb) image and pass it to the kernel 2679on boot. 2680ETEXI 2681 2682STEXI 2683@end table 2684ETEXI 2685DEFHEADING() 2686 2687DEFHEADING(Debug/Expert options:) 2688STEXI 2689@table @option 2690ETEXI 2691 2692DEF("fw_cfg", HAS_ARG, QEMU_OPTION_fwcfg, 2693 "-fw_cfg [name=]<name>,file=<file>\n" 2694 " add named fw_cfg entry from file\n", 2695 QEMU_ARCH_ALL) 2696STEXI 2697@item -fw_cfg [name=]@var{name},file=@var{file} 2698@findex -fw_cfg 2699Add named fw_cfg entry from file. @var{name} determines the name of 2700the entry in the fw_cfg file directory exposed to the guest. 2701ETEXI 2702 2703DEF("serial", HAS_ARG, QEMU_OPTION_serial, \ 2704 "-serial dev redirect the serial port to char device 'dev'\n", 2705 QEMU_ARCH_ALL) 2706STEXI 2707@item -serial @var{dev} 2708@findex -serial 2709Redirect the virtual serial port to host character device 2710@var{dev}. The default device is @code{vc} in graphical mode and 2711@code{stdio} in non graphical mode. 2712 2713This option can be used several times to simulate up to 4 serial 2714ports. 2715 2716Use @code{-serial none} to disable all serial ports. 2717 2718Available character devices are: 2719@table @option 2720@item vc[:@var{W}x@var{H}] 2721Virtual console. Optionally, a width and height can be given in pixel with 2722@example 2723vc:800x600 2724@end example 2725It is also possible to specify width or height in characters: 2726@example 2727vc:80Cx24C 2728@end example 2729@item pty 2730[Linux only] Pseudo TTY (a new PTY is automatically allocated) 2731@item none 2732No device is allocated. 2733@item null 2734void device 2735@item chardev:@var{id} 2736Use a named character device defined with the @code{-chardev} option. 2737@item /dev/XXX 2738[Linux only] Use host tty, e.g. @file{/dev/ttyS0}. The host serial port 2739parameters are set according to the emulated ones. 2740@item /dev/parport@var{N} 2741[Linux only, parallel port only] Use host parallel port 2742@var{N}. Currently SPP and EPP parallel port features can be used. 2743@item file:@var{filename} 2744Write output to @var{filename}. No character can be read. 2745@item stdio 2746[Unix only] standard input/output 2747@item pipe:@var{filename} 2748name pipe @var{filename} 2749@item COM@var{n} 2750[Windows only] Use host serial port @var{n} 2751@item udp:[@var{remote_host}]:@var{remote_port}[@@[@var{src_ip}]:@var{src_port}] 2752This implements UDP Net Console. 2753When @var{remote_host} or @var{src_ip} are not specified 2754they default to @code{0.0.0.0}. 2755When not using a specified @var{src_port} a random port is automatically chosen. 2756 2757If you just want a simple readonly console you can use @code{netcat} or 2758@code{nc}, by starting QEMU with: @code{-serial udp::4555} and nc as: 2759@code{nc -u -l -p 4555}. Any time QEMU writes something to that port it 2760will appear in the netconsole session. 2761 2762If you plan to send characters back via netconsole or you want to stop 2763and start QEMU a lot of times, you should have QEMU use the same 2764source port each time by using something like @code{-serial 2765udp::4555@@:4556} to QEMU. Another approach is to use a patched 2766version of netcat which can listen to a TCP port and send and receive 2767characters via udp. If you have a patched version of netcat which 2768activates telnet remote echo and single char transfer, then you can 2769use the following options to step up a netcat redirector to allow 2770telnet on port 5555 to access the QEMU port. 2771@table @code 2772@item QEMU Options: 2773-serial udp::4555@@:4556 2774@item netcat options: 2775-u -P 4555 -L 0.0.0.0:4556 -t -p 5555 -I -T 2776@item telnet options: 2777localhost 5555 2778@end table 2779 2780@item tcp:[@var{host}]:@var{port}[,@var{server}][,nowait][,nodelay][,reconnect=@var{seconds}] 2781The TCP Net Console has two modes of operation. It can send the serial 2782I/O to a location or wait for a connection from a location. By default 2783the TCP Net Console is sent to @var{host} at the @var{port}. If you use 2784the @var{server} option QEMU will wait for a client socket application 2785to connect to the port before continuing, unless the @code{nowait} 2786option was specified. The @code{nodelay} option disables the Nagle buffering 2787algorithm. The @code{reconnect} option only applies if @var{noserver} is 2788set, if the connection goes down it will attempt to reconnect at the 2789given interval. If @var{host} is omitted, 0.0.0.0 is assumed. Only 2790one TCP connection at a time is accepted. You can use @code{telnet} to 2791connect to the corresponding character device. 2792@table @code 2793@item Example to send tcp console to 192.168.0.2 port 4444 2794-serial tcp:192.168.0.2:4444 2795@item Example to listen and wait on port 4444 for connection 2796-serial tcp::4444,server 2797@item Example to not wait and listen on ip 192.168.0.100 port 4444 2798-serial tcp:192.168.0.100:4444,server,nowait 2799@end table 2800 2801@item telnet:@var{host}:@var{port}[,server][,nowait][,nodelay] 2802The telnet protocol is used instead of raw tcp sockets. The options 2803work the same as if you had specified @code{-serial tcp}. The 2804difference is that the port acts like a telnet server or client using 2805telnet option negotiation. This will also allow you to send the 2806MAGIC_SYSRQ sequence if you use a telnet that supports sending the break 2807sequence. Typically in unix telnet you do it with Control-] and then 2808type "send break" followed by pressing the enter key. 2809 2810@item unix:@var{path}[,server][,nowait][,reconnect=@var{seconds}] 2811A unix domain socket is used instead of a tcp socket. The option works the 2812same as if you had specified @code{-serial tcp} except the unix domain socket 2813@var{path} is used for connections. 2814 2815@item mon:@var{dev_string} 2816This is a special option to allow the monitor to be multiplexed onto 2817another serial port. The monitor is accessed with key sequence of 2818@key{Control-a} and then pressing @key{c}. 2819@var{dev_string} should be any one of the serial devices specified 2820above. An example to multiplex the monitor onto a telnet server 2821listening on port 4444 would be: 2822@table @code 2823@item -serial mon:telnet::4444,server,nowait 2824@end table 2825When the monitor is multiplexed to stdio in this way, Ctrl+C will not terminate 2826QEMU any more but will be passed to the guest instead. 2827 2828@item braille 2829Braille device. This will use BrlAPI to display the braille output on a real 2830or fake device. 2831 2832@item msmouse 2833Three button serial mouse. Configure the guest to use Microsoft protocol. 2834@end table 2835ETEXI 2836 2837DEF("parallel", HAS_ARG, QEMU_OPTION_parallel, \ 2838 "-parallel dev redirect the parallel port to char device 'dev'\n", 2839 QEMU_ARCH_ALL) 2840STEXI 2841@item -parallel @var{dev} 2842@findex -parallel 2843Redirect the virtual parallel port to host device @var{dev} (same 2844devices as the serial port). On Linux hosts, @file{/dev/parportN} can 2845be used to use hardware devices connected on the corresponding host 2846parallel port. 2847 2848This option can be used several times to simulate up to 3 parallel 2849ports. 2850 2851Use @code{-parallel none} to disable all parallel ports. 2852ETEXI 2853 2854DEF("monitor", HAS_ARG, QEMU_OPTION_monitor, \ 2855 "-monitor dev redirect the monitor to char device 'dev'\n", 2856 QEMU_ARCH_ALL) 2857STEXI 2858@item -monitor @var{dev} 2859@findex -monitor 2860Redirect the monitor to host device @var{dev} (same devices as the 2861serial port). 2862The default device is @code{vc} in graphical mode and @code{stdio} in 2863non graphical mode. 2864Use @code{-monitor none} to disable the default monitor. 2865ETEXI 2866DEF("qmp", HAS_ARG, QEMU_OPTION_qmp, \ 2867 "-qmp dev like -monitor but opens in 'control' mode\n", 2868 QEMU_ARCH_ALL) 2869STEXI 2870@item -qmp @var{dev} 2871@findex -qmp 2872Like -monitor but opens in 'control' mode. 2873ETEXI 2874DEF("qmp-pretty", HAS_ARG, QEMU_OPTION_qmp_pretty, \ 2875 "-qmp-pretty dev like -qmp but uses pretty JSON formatting\n", 2876 QEMU_ARCH_ALL) 2877STEXI 2878@item -qmp-pretty @var{dev} 2879@findex -qmp-pretty 2880Like -qmp but uses pretty JSON formatting. 2881ETEXI 2882 2883DEF("mon", HAS_ARG, QEMU_OPTION_mon, \ 2884 "-mon [chardev=]name[,mode=readline|control][,default]\n", QEMU_ARCH_ALL) 2885STEXI 2886@item -mon [chardev=]name[,mode=readline|control][,default] 2887@findex -mon 2888Setup monitor on chardev @var{name}. 2889ETEXI 2890 2891DEF("debugcon", HAS_ARG, QEMU_OPTION_debugcon, \ 2892 "-debugcon dev redirect the debug console to char device 'dev'\n", 2893 QEMU_ARCH_ALL) 2894STEXI 2895@item -debugcon @var{dev} 2896@findex -debugcon 2897Redirect the debug console to host device @var{dev} (same devices as the 2898serial port). The debug console is an I/O port which is typically port 28990xe9; writing to that I/O port sends output to this device. 2900The default device is @code{vc} in graphical mode and @code{stdio} in 2901non graphical mode. 2902ETEXI 2903 2904DEF("pidfile", HAS_ARG, QEMU_OPTION_pidfile, \ 2905 "-pidfile file write PID to 'file'\n", QEMU_ARCH_ALL) 2906STEXI 2907@item -pidfile @var{file} 2908@findex -pidfile 2909Store the QEMU process PID in @var{file}. It is useful if you launch QEMU 2910from a script. 2911ETEXI 2912 2913DEF("singlestep", 0, QEMU_OPTION_singlestep, \ 2914 "-singlestep always run in singlestep mode\n", QEMU_ARCH_ALL) 2915STEXI 2916@item -singlestep 2917@findex -singlestep 2918Run the emulation in single step mode. 2919ETEXI 2920 2921DEF("S", 0, QEMU_OPTION_S, \ 2922 "-S freeze CPU at startup (use 'c' to start execution)\n", 2923 QEMU_ARCH_ALL) 2924STEXI 2925@item -S 2926@findex -S 2927Do not start CPU at startup (you must type 'c' in the monitor). 2928ETEXI 2929 2930DEF("realtime", HAS_ARG, QEMU_OPTION_realtime, 2931 "-realtime [mlock=on|off]\n" 2932 " run qemu with realtime features\n" 2933 " mlock=on|off controls mlock support (default: on)\n", 2934 QEMU_ARCH_ALL) 2935STEXI 2936@item -realtime mlock=on|off 2937@findex -realtime 2938Run qemu with realtime features. 2939mlocking qemu and guest memory can be enabled via @option{mlock=on} 2940(enabled by default). 2941ETEXI 2942 2943DEF("gdb", HAS_ARG, QEMU_OPTION_gdb, \ 2944 "-gdb dev wait for gdb connection on 'dev'\n", QEMU_ARCH_ALL) 2945STEXI 2946@item -gdb @var{dev} 2947@findex -gdb 2948Wait for gdb connection on device @var{dev} (@pxref{gdb_usage}). Typical 2949connections will likely be TCP-based, but also UDP, pseudo TTY, or even 2950stdio are reasonable use case. The latter is allowing to start QEMU from 2951within gdb and establish the connection via a pipe: 2952@example 2953(gdb) target remote | exec qemu-system-i386 -gdb stdio ... 2954@end example 2955ETEXI 2956 2957DEF("s", 0, QEMU_OPTION_s, \ 2958 "-s shorthand for -gdb tcp::" DEFAULT_GDBSTUB_PORT "\n", 2959 QEMU_ARCH_ALL) 2960STEXI 2961@item -s 2962@findex -s 2963Shorthand for -gdb tcp::1234, i.e. open a gdbserver on TCP port 1234 2964(@pxref{gdb_usage}). 2965ETEXI 2966 2967DEF("d", HAS_ARG, QEMU_OPTION_d, \ 2968 "-d item1,... enable logging of specified items (use '-d help' for a list of log items)\n", 2969 QEMU_ARCH_ALL) 2970STEXI 2971@item -d @var{item1}[,...] 2972@findex -d 2973Enable logging of specified items. Use '-d help' for a list of log items. 2974ETEXI 2975 2976DEF("D", HAS_ARG, QEMU_OPTION_D, \ 2977 "-D logfile output log to logfile (default stderr)\n", 2978 QEMU_ARCH_ALL) 2979STEXI 2980@item -D @var{logfile} 2981@findex -D 2982Output log in @var{logfile} instead of to stderr 2983ETEXI 2984 2985DEF("L", HAS_ARG, QEMU_OPTION_L, \ 2986 "-L path set the directory for the BIOS, VGA BIOS and keymaps\n", 2987 QEMU_ARCH_ALL) 2988STEXI 2989@item -L @var{path} 2990@findex -L 2991Set the directory for the BIOS, VGA BIOS and keymaps. 2992ETEXI 2993 2994DEF("bios", HAS_ARG, QEMU_OPTION_bios, \ 2995 "-bios file set the filename for the BIOS\n", QEMU_ARCH_ALL) 2996STEXI 2997@item -bios @var{file} 2998@findex -bios 2999Set the filename for the BIOS. 3000ETEXI 3001 3002DEF("enable-kvm", 0, QEMU_OPTION_enable_kvm, \ 3003 "-enable-kvm enable KVM full virtualization support\n", QEMU_ARCH_ALL) 3004STEXI 3005@item -enable-kvm 3006@findex -enable-kvm 3007Enable KVM full virtualization support. This option is only available 3008if KVM support is enabled when compiling. 3009ETEXI 3010 3011DEF("xen-domid", HAS_ARG, QEMU_OPTION_xen_domid, 3012 "-xen-domid id specify xen guest domain id\n", QEMU_ARCH_ALL) 3013DEF("xen-create", 0, QEMU_OPTION_xen_create, 3014 "-xen-create create domain using xen hypercalls, bypassing xend\n" 3015 " warning: should not be used when xend is in use\n", 3016 QEMU_ARCH_ALL) 3017DEF("xen-attach", 0, QEMU_OPTION_xen_attach, 3018 "-xen-attach attach to existing xen domain\n" 3019 " xend will use this when starting QEMU\n", 3020 QEMU_ARCH_ALL) 3021STEXI 3022@item -xen-domid @var{id} 3023@findex -xen-domid 3024Specify xen guest domain @var{id} (XEN only). 3025@item -xen-create 3026@findex -xen-create 3027Create domain using xen hypercalls, bypassing xend. 3028Warning: should not be used when xend is in use (XEN only). 3029@item -xen-attach 3030@findex -xen-attach 3031Attach to existing xen domain. 3032xend will use this when starting QEMU (XEN only). 3033ETEXI 3034 3035DEF("no-reboot", 0, QEMU_OPTION_no_reboot, \ 3036 "-no-reboot exit instead of rebooting\n", QEMU_ARCH_ALL) 3037STEXI 3038@item -no-reboot 3039@findex -no-reboot 3040Exit instead of rebooting. 3041ETEXI 3042 3043DEF("no-shutdown", 0, QEMU_OPTION_no_shutdown, \ 3044 "-no-shutdown stop before shutdown\n", QEMU_ARCH_ALL) 3045STEXI 3046@item -no-shutdown 3047@findex -no-shutdown 3048Don't exit QEMU on guest shutdown, but instead only stop the emulation. 3049This allows for instance switching to monitor to commit changes to the 3050disk image. 3051ETEXI 3052 3053DEF("loadvm", HAS_ARG, QEMU_OPTION_loadvm, \ 3054 "-loadvm [tag|id]\n" \ 3055 " start right away with a saved state (loadvm in monitor)\n", 3056 QEMU_ARCH_ALL) 3057STEXI 3058@item -loadvm @var{file} 3059@findex -loadvm 3060Start right away with a saved state (@code{loadvm} in monitor) 3061ETEXI 3062 3063#ifndef _WIN32 3064DEF("daemonize", 0, QEMU_OPTION_daemonize, \ 3065 "-daemonize daemonize QEMU after initializing\n", QEMU_ARCH_ALL) 3066#endif 3067STEXI 3068@item -daemonize 3069@findex -daemonize 3070Daemonize the QEMU process after initialization. QEMU will not detach from 3071standard IO until it is ready to receive connections on any of its devices. 3072This option is a useful way for external programs to launch QEMU without having 3073to cope with initialization race conditions. 3074ETEXI 3075 3076DEF("option-rom", HAS_ARG, QEMU_OPTION_option_rom, \ 3077 "-option-rom rom load a file, rom, into the option ROM space\n", 3078 QEMU_ARCH_ALL) 3079STEXI 3080@item -option-rom @var{file} 3081@findex -option-rom 3082Load the contents of @var{file} as an option ROM. 3083This option is useful to load things like EtherBoot. 3084ETEXI 3085 3086HXCOMM Silently ignored for compatibility 3087DEF("clock", HAS_ARG, QEMU_OPTION_clock, "", QEMU_ARCH_ALL) 3088 3089HXCOMM Options deprecated by -rtc 3090DEF("localtime", 0, QEMU_OPTION_localtime, "", QEMU_ARCH_ALL) 3091DEF("startdate", HAS_ARG, QEMU_OPTION_startdate, "", QEMU_ARCH_ALL) 3092 3093DEF("rtc", HAS_ARG, QEMU_OPTION_rtc, \ 3094 "-rtc [base=utc|localtime|date][,clock=host|rt|vm][,driftfix=none|slew]\n" \ 3095 " set the RTC base and clock, enable drift fix for clock ticks (x86 only)\n", 3096 QEMU_ARCH_ALL) 3097 3098STEXI 3099 3100@item -rtc [base=utc|localtime|@var{date}][,clock=host|vm][,driftfix=none|slew] 3101@findex -rtc 3102Specify @option{base} as @code{utc} or @code{localtime} to let the RTC start at the current 3103UTC or local time, respectively. @code{localtime} is required for correct date in 3104MS-DOS or Windows. To start at a specific point in time, provide @var{date} in the 3105format @code{2006-06-17T16:01:21} or @code{2006-06-17}. The default base is UTC. 3106 3107By default the RTC is driven by the host system time. This allows using of the 3108RTC as accurate reference clock inside the guest, specifically if the host 3109time is smoothly following an accurate external reference clock, e.g. via NTP. 3110If you want to isolate the guest time from the host, you can set @option{clock} 3111to @code{rt} instead. To even prevent it from progressing during suspension, 3112you can set it to @code{vm}. 3113 3114Enable @option{driftfix} (i386 targets only) if you experience time drift problems, 3115specifically with Windows' ACPI HAL. This option will try to figure out how 3116many timer interrupts were not processed by the Windows guest and will 3117re-inject them. 3118ETEXI 3119 3120DEF("icount", HAS_ARG, QEMU_OPTION_icount, \ 3121 "-icount [shift=N|auto][,align=on|off][,sleep=no]\n" \ 3122 " enable virtual instruction counter with 2^N clock ticks per\n" \ 3123 " instruction, enable aligning the host and virtual clocks\n" \ 3124 " or disable real time cpu sleeping\n", QEMU_ARCH_ALL) 3125STEXI 3126@item -icount [shift=@var{N}|auto] 3127@findex -icount 3128Enable virtual instruction counter. The virtual cpu will execute one 3129instruction every 2^@var{N} ns of virtual time. If @code{auto} is specified 3130then the virtual cpu speed will be automatically adjusted to keep virtual 3131time within a few seconds of real time. 3132 3133When the virtual cpu is sleeping, the virtual time will advance at default 3134speed unless @option{sleep=no} is specified. 3135With @option{sleep=no}, the virtual time will jump to the next timer deadline 3136instantly whenever the virtual cpu goes to sleep mode and will not advance 3137if no timer is enabled. This behavior give deterministic execution times from 3138the guest point of view. 3139 3140Note that while this option can give deterministic behavior, it does not 3141provide cycle accurate emulation. Modern CPUs contain superscalar out of 3142order cores with complex cache hierarchies. The number of instructions 3143executed often has little or no correlation with actual performance. 3144 3145@option{align=on} will activate the delay algorithm which will try to 3146to synchronise the host clock and the virtual clock. The goal is to 3147have a guest running at the real frequency imposed by the shift option. 3148Whenever the guest clock is behind the host clock and if 3149@option{align=on} is specified then we print a message to the user 3150to inform about the delay. 3151Currently this option does not work when @option{shift} is @code{auto}. 3152Note: The sync algorithm will work for those shift values for which 3153the guest clock runs ahead of the host clock. Typically this happens 3154when the shift value is high (how high depends on the host machine). 3155ETEXI 3156 3157DEF("watchdog", HAS_ARG, QEMU_OPTION_watchdog, \ 3158 "-watchdog model\n" \ 3159 " enable virtual hardware watchdog [default=none]\n", 3160 QEMU_ARCH_ALL) 3161STEXI 3162@item -watchdog @var{model} 3163@findex -watchdog 3164Create a virtual hardware watchdog device. Once enabled (by a guest 3165action), the watchdog must be periodically polled by an agent inside 3166the guest or else the guest will be restarted. Choose a model for 3167which your guest has drivers. 3168 3169The @var{model} is the model of hardware watchdog to emulate. Use 3170@code{-watchdog help} to list available hardware models. Only one 3171watchdog can be enabled for a guest. 3172 3173The following models may be available: 3174@table @option 3175@item ib700 3176iBASE 700 is a very simple ISA watchdog with a single timer. 3177@item i6300esb 3178Intel 6300ESB I/O controller hub is a much more featureful PCI-based 3179dual-timer watchdog. 3180@item diag288 3181A virtual watchdog for s390x backed by the diagnose 288 hypercall 3182(currently KVM only). 3183@end table 3184ETEXI 3185 3186DEF("watchdog-action", HAS_ARG, QEMU_OPTION_watchdog_action, \ 3187 "-watchdog-action reset|shutdown|poweroff|pause|debug|none\n" \ 3188 " action when watchdog fires [default=reset]\n", 3189 QEMU_ARCH_ALL) 3190STEXI 3191@item -watchdog-action @var{action} 3192@findex -watchdog-action 3193 3194The @var{action} controls what QEMU will do when the watchdog timer 3195expires. 3196The default is 3197@code{reset} (forcefully reset the guest). 3198Other possible actions are: 3199@code{shutdown} (attempt to gracefully shutdown the guest), 3200@code{poweroff} (forcefully poweroff the guest), 3201@code{pause} (pause the guest), 3202@code{debug} (print a debug message and continue), or 3203@code{none} (do nothing). 3204 3205Note that the @code{shutdown} action requires that the guest responds 3206to ACPI signals, which it may not be able to do in the sort of 3207situations where the watchdog would have expired, and thus 3208@code{-watchdog-action shutdown} is not recommended for production use. 3209 3210Examples: 3211 3212@table @code 3213@item -watchdog i6300esb -watchdog-action pause 3214@item -watchdog ib700 3215@end table 3216ETEXI 3217 3218DEF("echr", HAS_ARG, QEMU_OPTION_echr, \ 3219 "-echr chr set terminal escape character instead of ctrl-a\n", 3220 QEMU_ARCH_ALL) 3221STEXI 3222 3223@item -echr @var{numeric_ascii_value} 3224@findex -echr 3225Change the escape character used for switching to the monitor when using 3226monitor and serial sharing. The default is @code{0x01} when using the 3227@code{-nographic} option. @code{0x01} is equal to pressing 3228@code{Control-a}. You can select a different character from the ascii 3229control keys where 1 through 26 map to Control-a through Control-z. For 3230instance you could use the either of the following to change the escape 3231character to Control-t. 3232@table @code 3233@item -echr 0x14 3234@item -echr 20 3235@end table 3236ETEXI 3237 3238DEF("virtioconsole", HAS_ARG, QEMU_OPTION_virtiocon, \ 3239 "-virtioconsole c\n" \ 3240 " set virtio console\n", QEMU_ARCH_ALL) 3241STEXI 3242@item -virtioconsole @var{c} 3243@findex -virtioconsole 3244Set virtio console. 3245 3246This option is maintained for backward compatibility. 3247 3248Please use @code{-device virtconsole} for the new way of invocation. 3249ETEXI 3250 3251DEF("show-cursor", 0, QEMU_OPTION_show_cursor, \ 3252 "-show-cursor show cursor\n", QEMU_ARCH_ALL) 3253STEXI 3254@item -show-cursor 3255@findex -show-cursor 3256Show cursor. 3257ETEXI 3258 3259DEF("tb-size", HAS_ARG, QEMU_OPTION_tb_size, \ 3260 "-tb-size n set TB size\n", QEMU_ARCH_ALL) 3261STEXI 3262@item -tb-size @var{n} 3263@findex -tb-size 3264Set TB size. 3265ETEXI 3266 3267DEF("incoming", HAS_ARG, QEMU_OPTION_incoming, \ 3268 "-incoming tcp:[host]:port[,to=maxport][,ipv4][,ipv6]\n" \ 3269 "-incoming rdma:host:port[,ipv4][,ipv6]\n" \ 3270 "-incoming unix:socketpath\n" \ 3271 " prepare for incoming migration, listen on\n" \ 3272 " specified protocol and socket address\n" \ 3273 "-incoming fd:fd\n" \ 3274 "-incoming exec:cmdline\n" \ 3275 " accept incoming migration on given file descriptor\n" \ 3276 " or from given external command\n" \ 3277 "-incoming defer\n" \ 3278 " wait for the URI to be specified via migrate_incoming\n", 3279 QEMU_ARCH_ALL) 3280STEXI 3281@item -incoming tcp:[@var{host}]:@var{port}[,to=@var{maxport}][,ipv4][,ipv6] 3282@item -incoming rdma:@var{host}:@var{port}[,ipv4][,ipv6] 3283@findex -incoming 3284Prepare for incoming migration, listen on a given tcp port. 3285 3286@item -incoming unix:@var{socketpath} 3287Prepare for incoming migration, listen on a given unix socket. 3288 3289@item -incoming fd:@var{fd} 3290Accept incoming migration from a given filedescriptor. 3291 3292@item -incoming exec:@var{cmdline} 3293Accept incoming migration as an output from specified external command. 3294 3295@item -incoming defer 3296Wait for the URI to be specified via migrate_incoming. The monitor can 3297be used to change settings (such as migration parameters) prior to issuing 3298the migrate_incoming to allow the migration to begin. 3299ETEXI 3300 3301DEF("nodefaults", 0, QEMU_OPTION_nodefaults, \ 3302 "-nodefaults don't create default devices\n", QEMU_ARCH_ALL) 3303STEXI 3304@item -nodefaults 3305@findex -nodefaults 3306Don't create default devices. Normally, QEMU sets the default devices like serial 3307port, parallel port, virtual console, monitor device, VGA adapter, floppy and 3308CD-ROM drive and others. The @code{-nodefaults} option will disable all those 3309default devices. 3310ETEXI 3311 3312#ifndef _WIN32 3313DEF("chroot", HAS_ARG, QEMU_OPTION_chroot, \ 3314 "-chroot dir chroot to dir just before starting the VM\n", 3315 QEMU_ARCH_ALL) 3316#endif 3317STEXI 3318@item -chroot @var{dir} 3319@findex -chroot 3320Immediately before starting guest execution, chroot to the specified 3321directory. Especially useful in combination with -runas. 3322ETEXI 3323 3324#ifndef _WIN32 3325DEF("runas", HAS_ARG, QEMU_OPTION_runas, \ 3326 "-runas user change to user id user just before starting the VM\n", 3327 QEMU_ARCH_ALL) 3328#endif 3329STEXI 3330@item -runas @var{user} 3331@findex -runas 3332Immediately before starting guest execution, drop root privileges, switching 3333to the specified user. 3334ETEXI 3335 3336DEF("prom-env", HAS_ARG, QEMU_OPTION_prom_env, 3337 "-prom-env variable=value\n" 3338 " set OpenBIOS nvram variables\n", 3339 QEMU_ARCH_PPC | QEMU_ARCH_SPARC) 3340STEXI 3341@item -prom-env @var{variable}=@var{value} 3342@findex -prom-env 3343Set OpenBIOS nvram @var{variable} to given @var{value} (PPC, SPARC only). 3344ETEXI 3345DEF("semihosting", 0, QEMU_OPTION_semihosting, 3346 "-semihosting semihosting mode\n", 3347 QEMU_ARCH_ARM | QEMU_ARCH_M68K | QEMU_ARCH_XTENSA | QEMU_ARCH_LM32) 3348STEXI 3349@item -semihosting 3350@findex -semihosting 3351Enable semihosting mode (ARM, M68K, Xtensa only). 3352ETEXI 3353DEF("semihosting-config", HAS_ARG, QEMU_OPTION_semihosting_config, 3354 "-semihosting-config [enable=on|off,]target=native|gdb|auto semihosting configuration\n", 3355QEMU_ARCH_ARM | QEMU_ARCH_M68K | QEMU_ARCH_XTENSA | QEMU_ARCH_LM32) 3356STEXI 3357@item -semihosting-config [enable=on|off,]target=native|gdb|auto 3358@findex -semihosting-config 3359Enable semihosting and define where the semihosting calls will be addressed, 3360to QEMU (@code{native}) or to GDB (@code{gdb}). The default is @code{auto}, which means 3361@code{gdb} during debug sessions and @code{native} otherwise (ARM, M68K, Xtensa only). 3362ETEXI 3363DEF("old-param", 0, QEMU_OPTION_old_param, 3364 "-old-param old param mode\n", QEMU_ARCH_ARM) 3365STEXI 3366@item -old-param 3367@findex -old-param (ARM) 3368Old param mode (ARM only). 3369ETEXI 3370 3371DEF("sandbox", HAS_ARG, QEMU_OPTION_sandbox, \ 3372 "-sandbox <arg> Enable seccomp mode 2 system call filter (default 'off').\n", 3373 QEMU_ARCH_ALL) 3374STEXI 3375@item -sandbox @var{arg} 3376@findex -sandbox 3377Enable Seccomp mode 2 system call filter. 'on' will enable syscall filtering and 'off' will 3378disable it. The default is 'off'. 3379ETEXI 3380 3381DEF("readconfig", HAS_ARG, QEMU_OPTION_readconfig, 3382 "-readconfig <file>\n", QEMU_ARCH_ALL) 3383STEXI 3384@item -readconfig @var{file} 3385@findex -readconfig 3386Read device configuration from @var{file}. This approach is useful when you want to spawn 3387QEMU process with many command line options but you don't want to exceed the command line 3388character limit. 3389ETEXI 3390DEF("writeconfig", HAS_ARG, QEMU_OPTION_writeconfig, 3391 "-writeconfig <file>\n" 3392 " read/write config file\n", QEMU_ARCH_ALL) 3393STEXI 3394@item -writeconfig @var{file} 3395@findex -writeconfig 3396Write device configuration to @var{file}. The @var{file} can be either filename to save 3397command line and device configuration into file or dash @code{-}) character to print the 3398output to stdout. This can be later used as input file for @code{-readconfig} option. 3399ETEXI 3400DEF("nodefconfig", 0, QEMU_OPTION_nodefconfig, 3401 "-nodefconfig\n" 3402 " do not load default config files at startup\n", 3403 QEMU_ARCH_ALL) 3404STEXI 3405@item -nodefconfig 3406@findex -nodefconfig 3407Normally QEMU loads configuration files from @var{sysconfdir} and @var{datadir} at startup. 3408The @code{-nodefconfig} option will prevent QEMU from loading any of those config files. 3409ETEXI 3410DEF("no-user-config", 0, QEMU_OPTION_nouserconfig, 3411 "-no-user-config\n" 3412 " do not load user-provided config files at startup\n", 3413 QEMU_ARCH_ALL) 3414STEXI 3415@item -no-user-config 3416@findex -no-user-config 3417The @code{-no-user-config} option makes QEMU not load any of the user-provided 3418config files on @var{sysconfdir}, but won't make it skip the QEMU-provided config 3419files from @var{datadir}. 3420ETEXI 3421DEF("trace", HAS_ARG, QEMU_OPTION_trace, 3422 "-trace [events=<file>][,file=<file>]\n" 3423 " specify tracing options\n", 3424 QEMU_ARCH_ALL) 3425STEXI 3426HXCOMM This line is not accurate, as some sub-options are backend-specific but 3427HXCOMM HX does not support conditional compilation of text. 3428@item -trace [events=@var{file}][,file=@var{file}] 3429@findex -trace 3430 3431Specify tracing options. 3432 3433@table @option 3434@item events=@var{file} 3435Immediately enable events listed in @var{file}. 3436The file must contain one event name (as listed in the @var{trace-events} file) 3437per line. 3438This option is only available if QEMU has been compiled with 3439either @var{simple} or @var{stderr} tracing backend. 3440@item file=@var{file} 3441Log output traces to @var{file}. 3442 3443This option is only available if QEMU has been compiled with 3444the @var{simple} tracing backend. 3445@end table 3446ETEXI 3447 3448HXCOMM Internal use 3449DEF("qtest", HAS_ARG, QEMU_OPTION_qtest, "", QEMU_ARCH_ALL) 3450DEF("qtest-log", HAS_ARG, QEMU_OPTION_qtest_log, "", QEMU_ARCH_ALL) 3451 3452#ifdef __linux__ 3453DEF("enable-fips", 0, QEMU_OPTION_enablefips, 3454 "-enable-fips enable FIPS 140-2 compliance\n", 3455 QEMU_ARCH_ALL) 3456#endif 3457STEXI 3458@item -enable-fips 3459@findex -enable-fips 3460Enable FIPS 140-2 compliance mode. 3461ETEXI 3462 3463HXCOMM Deprecated by -machine accel=tcg property 3464DEF("no-kvm", 0, QEMU_OPTION_no_kvm, "", QEMU_ARCH_I386) 3465 3466HXCOMM Deprecated by kvm-pit driver properties 3467DEF("no-kvm-pit-reinjection", 0, QEMU_OPTION_no_kvm_pit_reinjection, 3468 "", QEMU_ARCH_I386) 3469 3470HXCOMM Deprecated (ignored) 3471DEF("no-kvm-pit", 0, QEMU_OPTION_no_kvm_pit, "", QEMU_ARCH_I386) 3472 3473HXCOMM Deprecated by -machine kernel_irqchip=on|off property 3474DEF("no-kvm-irqchip", 0, QEMU_OPTION_no_kvm_irqchip, "", QEMU_ARCH_I386) 3475 3476HXCOMM Deprecated (ignored) 3477DEF("tdf", 0, QEMU_OPTION_tdf,"", QEMU_ARCH_ALL) 3478 3479DEF("object", HAS_ARG, QEMU_OPTION_object, 3480 "-object TYPENAME[,PROP1=VALUE1,...]\n" 3481 " create an new object of type TYPENAME setting properties\n" 3482 " in the order they are specified. Note that the 'id'\n" 3483 " property must be set. These objects are placed in the\n" 3484 " '/objects' path.\n", 3485 QEMU_ARCH_ALL) 3486STEXI 3487@item -object @var{typename}[,@var{prop1}=@var{value1},...] 3488@findex -object 3489Create an new object of type @var{typename} setting properties 3490in the order they are specified. Note that the 'id' 3491property must be set. These objects are placed in the 3492'/objects' path. 3493ETEXI 3494 3495DEF("msg", HAS_ARG, QEMU_OPTION_msg, 3496 "-msg timestamp[=on|off]\n" 3497 " change the format of messages\n" 3498 " on|off controls leading timestamps (default:on)\n", 3499 QEMU_ARCH_ALL) 3500STEXI 3501@item -msg timestamp[=on|off] 3502@findex -msg 3503prepend a timestamp to each log message.(default:on) 3504ETEXI 3505 3506DEF("dump-vmstate", HAS_ARG, QEMU_OPTION_dump_vmstate, 3507 "-dump-vmstate <file>\n" 3508 " Output vmstate information in JSON format to file.\n" 3509 " Use the scripts/vmstate-static-checker.py file to\n" 3510 " check for possible regressions in migration code\n" 3511 " by comparing two such vmstate dumps.", 3512 QEMU_ARCH_ALL) 3513STEXI 3514@item -dump-vmstate @var{file} 3515@findex -dump-vmstate 3516Dump json-encoded vmstate information for current machine type to file 3517in @var{file} 3518ETEXI 3519 3520HXCOMM This is the last statement. Insert new options before this line! 3521STEXI 3522@end table 3523ETEXI 3524
