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