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