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