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}. 1130 1131@item password 1132 1133Require that password based authentication is used for client connections. 1134 1135The password must be set separately using the @code{set_password} command in 1136the @ref{pcsys_monitor}. The syntax to change your password is: 1137@code{set_password <protocol> <password>} where <protocol> could be either 1138"vnc" or "spice". 1139 1140If you would like to change <protocol> password expiration, you should use 1141@code{expire_password <protocol> <expiration-time>} where expiration time could 1142be one of the following options: now, never, +seconds or UNIX time of 1143expiration, e.g. +60 to make password expire in 60 seconds, or 1335196800 1144to make password expire on "Mon Apr 23 12:00:00 EDT 2012" (UNIX time for this 1145date and time). 1146 1147You can also use keywords "now" or "never" for the expiration time to 1148allow <protocol> password to expire immediately or never expire. 1149 1150@item tls 1151 1152Require that client use TLS when communicating with the VNC server. This 1153uses anonymous TLS credentials so is susceptible to a man-in-the-middle 1154attack. It is recommended that this option be combined with either the 1155@option{x509} or @option{x509verify} options. 1156 1157@item x509=@var{/path/to/certificate/dir} 1158 1159Valid if @option{tls} is specified. Require that x509 credentials are used 1160for negotiating the TLS session. The server will send its x509 certificate 1161to the client. It is recommended that a password be set on the VNC server 1162to provide authentication of the client when this is used. The path following 1163this option specifies where the x509 certificates are to be loaded from. 1164See the @ref{vnc_security} section for details on generating certificates. 1165 1166@item x509verify=@var{/path/to/certificate/dir} 1167 1168Valid if @option{tls} is specified. Require that x509 credentials are used 1169for negotiating the TLS session. The server will send its x509 certificate 1170to the client, and request that the client send its own x509 certificate. 1171The server will validate the client's certificate against the CA certificate, 1172and reject clients when validation fails. If the certificate authority is 1173trusted, this is a sufficient authentication mechanism. You may still wish 1174to set a password on the VNC server as a second authentication layer. The 1175path following this option specifies where the x509 certificates are to 1176be loaded from. See the @ref{vnc_security} section for details on generating 1177certificates. 1178 1179@item sasl 1180 1181Require that the client use SASL to authenticate with the VNC server. 1182The exact choice of authentication method used is controlled from the 1183system / user's SASL configuration file for the 'qemu' service. This 1184is typically found in /etc/sasl2/qemu.conf. If running QEMU as an 1185unprivileged user, an environment variable SASL_CONF_PATH can be used 1186to make it search alternate locations for the service config. 1187While some SASL auth methods can also provide data encryption (eg GSSAPI), 1188it is recommended that SASL always be combined with the 'tls' and 1189'x509' settings to enable use of SSL and server certificates. This 1190ensures a data encryption preventing compromise of authentication 1191credentials. See the @ref{vnc_security} section for details on using 1192SASL authentication. 1193 1194@item acl 1195 1196Turn on access control lists for checking of the x509 client certificate 1197and SASL party. For x509 certs, the ACL check is made against the 1198certificate's distinguished name. This is something that looks like 1199@code{C=GB,O=ACME,L=Boston,CN=bob}. For SASL party, the ACL check is 1200made against the username, which depending on the SASL plugin, may 1201include a realm component, eg @code{bob} or @code{bob@@EXAMPLE.COM}. 1202When the @option{acl} flag is set, the initial access list will be 1203empty, with a @code{deny} policy. Thus no one will be allowed to 1204use the VNC server until the ACLs have been loaded. This can be 1205achieved using the @code{acl} monitor command. 1206 1207@item lossy 1208 1209Enable lossy compression methods (gradient, JPEG, ...). If this 1210option is set, VNC client may receive lossy framebuffer updates 1211depending on its encoding settings. Enabling this option can save 1212a lot of bandwidth at the expense of quality. 1213 1214@item non-adaptive 1215 1216Disable adaptive encodings. Adaptive encodings are enabled by default. 1217An adaptive encoding will try to detect frequently updated screen regions, 1218and send updates in these regions using a lossy encoding (like JPEG). 1219This can be really helpful to save bandwidth when playing videos. Disabling 1220adaptive encodings allows to restore the original static behavior of encodings 1221like Tight. 1222 1223@item share=[allow-exclusive|force-shared|ignore] 1224 1225Set display sharing policy. 'allow-exclusive' allows clients to ask 1226for exclusive access. As suggested by the rfb spec this is 1227implemented by dropping other connections. Connecting multiple 1228clients in parallel requires all clients asking for a shared session 1229(vncviewer: -shared switch). This is the default. 'force-shared' 1230disables exclusive client access. Useful for shared desktop sessions, 1231where you don't want someone forgetting specify -shared disconnect 1232everybody else. 'ignore' completely ignores the shared flag and 1233allows everybody connect unconditionally. Doesn't conform to the rfb 1234spec but is traditional QEMU behavior. 1235 1236@end table 1237ETEXI 1238 1239STEXI 1240@end table 1241ETEXI 1242ARCHHEADING(, QEMU_ARCH_I386) 1243 1244ARCHHEADING(i386 target only:, QEMU_ARCH_I386) 1245STEXI 1246@table @option 1247ETEXI 1248 1249DEF("win2k-hack", 0, QEMU_OPTION_win2k_hack, 1250 "-win2k-hack use it when installing Windows 2000 to avoid a disk full bug\n", 1251 QEMU_ARCH_I386) 1252STEXI 1253@item -win2k-hack 1254@findex -win2k-hack 1255Use it when installing Windows 2000 to avoid a disk full bug. After 1256Windows 2000 is installed, you no longer need this option (this option 1257slows down the IDE transfers). 1258ETEXI 1259 1260HXCOMM Deprecated by -rtc 1261DEF("rtc-td-hack", 0, QEMU_OPTION_rtc_td_hack, "", QEMU_ARCH_I386) 1262 1263DEF("no-fd-bootchk", 0, QEMU_OPTION_no_fd_bootchk, 1264 "-no-fd-bootchk disable boot signature checking for floppy disks\n", 1265 QEMU_ARCH_I386) 1266STEXI 1267@item -no-fd-bootchk 1268@findex -no-fd-bootchk 1269Disable boot signature checking for floppy disks in Bochs BIOS. It may 1270be needed to boot from old floppy disks. 1271TODO: check reference to Bochs BIOS. 1272ETEXI 1273 1274DEF("no-acpi", 0, QEMU_OPTION_no_acpi, 1275 "-no-acpi disable ACPI\n", QEMU_ARCH_I386) 1276STEXI 1277@item -no-acpi 1278@findex -no-acpi 1279Disable ACPI (Advanced Configuration and Power Interface) support. Use 1280it if your guest OS complains about ACPI problems (PC target machine 1281only). 1282ETEXI 1283 1284DEF("no-hpet", 0, QEMU_OPTION_no_hpet, 1285 "-no-hpet disable HPET\n", QEMU_ARCH_I386) 1286STEXI 1287@item -no-hpet 1288@findex -no-hpet 1289Disable HPET support. 1290ETEXI 1291 1292DEF("acpitable", HAS_ARG, QEMU_OPTION_acpitable, 1293 "-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" 1294 " ACPI table description\n", QEMU_ARCH_I386) 1295STEXI 1296@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}]...] 1297@findex -acpitable 1298Add ACPI table with specified header fields and context from specified files. 1299For file=, take whole ACPI table from the specified files, including all 1300ACPI headers (possible overridden by other options). 1301For data=, only data 1302portion of the table is used, all header information is specified in the 1303command line. 1304ETEXI 1305 1306DEF("smbios", HAS_ARG, QEMU_OPTION_smbios, 1307 "-smbios file=binary\n" 1308 " load SMBIOS entry from binary file\n" 1309 "-smbios type=0[,vendor=str][,version=str][,date=str][,release=%d.%d]\n" 1310 " specify SMBIOS type 0 fields\n" 1311 "-smbios type=1[,manufacturer=str][,product=str][,version=str][,serial=str]\n" 1312 " [,uuid=uuid][,sku=str][,family=str]\n" 1313 " specify SMBIOS type 1 fields\n", QEMU_ARCH_I386) 1314STEXI 1315@item -smbios file=@var{binary} 1316@findex -smbios 1317Load SMBIOS entry from binary file. 1318 1319@item -smbios type=0[,vendor=@var{str}][,version=@var{str}][,date=@var{str}][,release=@var{%d.%d}] 1320Specify SMBIOS type 0 fields 1321 1322@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}] 1323Specify SMBIOS type 1 fields 1324ETEXI 1325 1326STEXI 1327@end table 1328ETEXI 1329DEFHEADING() 1330 1331DEFHEADING(Network options:) 1332STEXI 1333@table @option 1334ETEXI 1335 1336HXCOMM Legacy slirp options (now moved to -net user): 1337#ifdef CONFIG_SLIRP 1338DEF("tftp", HAS_ARG, QEMU_OPTION_tftp, "", QEMU_ARCH_ALL) 1339DEF("bootp", HAS_ARG, QEMU_OPTION_bootp, "", QEMU_ARCH_ALL) 1340DEF("redir", HAS_ARG, QEMU_OPTION_redir, "", QEMU_ARCH_ALL) 1341#ifndef _WIN32 1342DEF("smb", HAS_ARG, QEMU_OPTION_smb, "", QEMU_ARCH_ALL) 1343#endif 1344#endif 1345 1346DEF("net", HAS_ARG, QEMU_OPTION_net, 1347 "-net nic[,vlan=n][,macaddr=mac][,model=type][,name=str][,addr=str][,vectors=v]\n" 1348 " create a new Network Interface Card and connect it to VLAN 'n'\n" 1349#ifdef CONFIG_SLIRP 1350 "-net user[,vlan=n][,name=str][,net=addr[/mask]][,host=addr][,restrict=on|off]\n" 1351 " [,hostname=host][,dhcpstart=addr][,dns=addr][,dnssearch=domain][,tftp=dir]\n" 1352 " [,bootfile=f][,hostfwd=rule][,guestfwd=rule]" 1353#ifndef _WIN32 1354 "[,smb=dir[,smbserver=addr]]\n" 1355#endif 1356 " connect the user mode network stack to VLAN 'n', configure its\n" 1357 " DHCP server and enabled optional services\n" 1358#endif 1359#ifdef _WIN32 1360 "-net tap[,vlan=n][,name=str],ifname=name\n" 1361 " connect the host TAP network interface to VLAN 'n'\n" 1362#else 1363 "-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" 1364 " connect the host TAP network interface to VLAN 'n'\n" 1365 " use network scripts 'file' (default=" DEFAULT_NETWORK_SCRIPT ")\n" 1366 " to configure it and 'dfile' (default=" DEFAULT_NETWORK_DOWN_SCRIPT ")\n" 1367 " to deconfigure it\n" 1368 " use '[down]script=no' to disable script execution\n" 1369 " use network helper 'helper' (default=" DEFAULT_BRIDGE_HELPER ") to\n" 1370 " configure it\n" 1371 " use 'fd=h' to connect to an already opened TAP interface\n" 1372 " use 'fds=x:y:...:z' to connect to already opened multiqueue capable TAP interfaces\n" 1373 " use 'sndbuf=nbytes' to limit the size of the send buffer (the\n" 1374 " default is disabled 'sndbuf=0' to enable flow control set 'sndbuf=1048576')\n" 1375 " use vnet_hdr=off to avoid enabling the IFF_VNET_HDR tap flag\n" 1376 " use vnet_hdr=on to make the lack of IFF_VNET_HDR support an error condition\n" 1377 " use vhost=on to enable experimental in kernel accelerator\n" 1378 " (only has effect for virtio guests which use MSIX)\n" 1379 " use vhostforce=on to force vhost on for non-MSIX virtio guests\n" 1380 " use 'vhostfd=h' to connect to an already opened vhost net device\n" 1381 " use 'vhostfds=x:y:...:z to connect to multiple already opened vhost net devices\n" 1382 " use 'queues=n' to specify the number of queues to be created for multiqueue TAP\n" 1383 "-net bridge[,vlan=n][,name=str][,br=bridge][,helper=helper]\n" 1384 " connects a host TAP network interface to a host bridge device 'br'\n" 1385 " (default=" DEFAULT_BRIDGE_INTERFACE ") using the program 'helper'\n" 1386 " (default=" DEFAULT_BRIDGE_HELPER ")\n" 1387#endif 1388 "-net socket[,vlan=n][,name=str][,fd=h][,listen=[host]:port][,connect=host:port]\n" 1389 " connect the vlan 'n' to another VLAN using a socket connection\n" 1390 "-net socket[,vlan=n][,name=str][,fd=h][,mcast=maddr:port[,localaddr=addr]]\n" 1391 " connect the vlan 'n' to multicast maddr and port\n" 1392 " use 'localaddr=addr' to specify the host address to send packets from\n" 1393 "-net socket[,vlan=n][,name=str][,fd=h][,udp=host:port][,localaddr=host:port]\n" 1394 " connect the vlan 'n' to another VLAN using an UDP tunnel\n" 1395#ifdef CONFIG_VDE 1396 "-net vde[,vlan=n][,name=str][,sock=socketpath][,port=n][,group=groupname][,mode=octalmode]\n" 1397 " connect the vlan 'n' to port 'n' of a vde switch running\n" 1398 " on host and listening for incoming connections on 'socketpath'.\n" 1399 " Use group 'groupname' and mode 'octalmode' to change default\n" 1400 " ownership and permissions for communication port.\n" 1401#endif 1402 "-net dump[,vlan=n][,file=f][,len=n]\n" 1403 " dump traffic on vlan 'n' to file 'f' (max n bytes per packet)\n" 1404 "-net none use it alone to have zero network devices. If no -net option\n" 1405 " is provided, the default is '-net nic -net user'\n", QEMU_ARCH_ALL) 1406DEF("netdev", HAS_ARG, QEMU_OPTION_netdev, 1407 "-netdev [" 1408#ifdef CONFIG_SLIRP 1409 "user|" 1410#endif 1411 "tap|" 1412 "bridge|" 1413#ifdef CONFIG_VDE 1414 "vde|" 1415#endif 1416 "socket|" 1417 "hubport],id=str[,option][,option][,...]\n", QEMU_ARCH_ALL) 1418STEXI 1419@item -net nic[,vlan=@var{n}][,macaddr=@var{mac}][,model=@var{type}] [,name=@var{name}][,addr=@var{addr}][,vectors=@var{v}] 1420@findex -net 1421Create a new Network Interface Card and connect it to VLAN @var{n} (@var{n} 1422= 0 is the default). The NIC is an e1000 by default on the PC 1423target. Optionally, the MAC address can be changed to @var{mac}, the 1424device address set to @var{addr} (PCI cards only), 1425and a @var{name} can be assigned for use in monitor commands. 1426Optionally, for PCI cards, you can specify the number @var{v} of MSI-X vectors 1427that the card should have; this option currently only affects virtio cards; set 1428@var{v} = 0 to disable MSI-X. If no @option{-net} option is specified, a single 1429NIC is created. QEMU can emulate several different models of network card. 1430Valid values for @var{type} are 1431@code{virtio}, @code{i82551}, @code{i82557b}, @code{i82559er}, 1432@code{ne2k_pci}, @code{ne2k_isa}, @code{pcnet}, @code{rtl8139}, 1433@code{e1000}, @code{smc91c111}, @code{lance} and @code{mcf_fec}. 1434Not all devices are supported on all targets. Use @code{-net nic,model=help} 1435for a list of available devices for your target. 1436 1437@item -netdev user,id=@var{id}[,@var{option}][,@var{option}][,...] 1438@findex -netdev 1439@item -net user[,@var{option}][,@var{option}][,...] 1440Use the user mode network stack which requires no administrator 1441privilege to run. Valid options are: 1442 1443@table @option 1444@item vlan=@var{n} 1445Connect user mode stack to VLAN @var{n} (@var{n} = 0 is the default). 1446 1447@item id=@var{id} 1448@item name=@var{name} 1449Assign symbolic name for use in monitor commands. 1450 1451@item net=@var{addr}[/@var{mask}] 1452Set IP network address the guest will see. Optionally specify the netmask, 1453either in the form a.b.c.d or as number of valid top-most bits. Default is 145410.0.2.0/24. 1455 1456@item host=@var{addr} 1457Specify the guest-visible address of the host. Default is the 2nd IP in the 1458guest network, i.e. x.x.x.2. 1459 1460@item restrict=on|off 1461If this option is enabled, the guest will be isolated, i.e. it will not be 1462able to contact the host and no guest IP packets will be routed over the host 1463to the outside. This option does not affect any explicitly set forwarding rules. 1464 1465@item hostname=@var{name} 1466Specifies the client hostname reported by the built-in DHCP server. 1467 1468@item dhcpstart=@var{addr} 1469Specify the first of the 16 IPs the built-in DHCP server can assign. Default 1470is the 15th to 31st IP in the guest network, i.e. x.x.x.15 to x.x.x.31. 1471 1472@item dns=@var{addr} 1473Specify the guest-visible address of the virtual nameserver. The address must 1474be different from the host address. Default is the 3rd IP in the guest network, 1475i.e. x.x.x.3. 1476 1477@item dnssearch=@var{domain} 1478Provides an entry for the domain-search list sent by the built-in 1479DHCP server. More than one domain suffix can be transmitted by specifying 1480this option multiple times. If supported, this will cause the guest to 1481automatically try to append the given domain suffix(es) in case a domain name 1482can not be resolved. 1483 1484Example: 1485@example 1486qemu -net user,dnssearch=mgmt.example.org,dnssearch=example.org [...] 1487@end example 1488 1489@item tftp=@var{dir} 1490When using the user mode network stack, activate a built-in TFTP 1491server. The files in @var{dir} will be exposed as the root of a TFTP server. 1492The TFTP client on the guest must be configured in binary mode (use the command 1493@code{bin} of the Unix TFTP client). 1494 1495@item bootfile=@var{file} 1496When using the user mode network stack, broadcast @var{file} as the BOOTP 1497filename. In conjunction with @option{tftp}, this can be used to network boot 1498a guest from a local directory. 1499 1500Example (using pxelinux): 1501@example 1502qemu-system-i386 -hda linux.img -boot n -net user,tftp=/path/to/tftp/files,bootfile=/pxelinux.0 1503@end example 1504 1505@item smb=@var{dir}[,smbserver=@var{addr}] 1506When using the user mode network stack, activate a built-in SMB 1507server so that Windows OSes can access to the host files in @file{@var{dir}} 1508transparently. The IP address of the SMB server can be set to @var{addr}. By 1509default the 4th IP in the guest network is used, i.e. x.x.x.4. 1510 1511In the guest Windows OS, the line: 1512@example 151310.0.2.4 smbserver 1514@end example 1515must be added in the file @file{C:\WINDOWS\LMHOSTS} (for windows 9x/Me) 1516or @file{C:\WINNT\SYSTEM32\DRIVERS\ETC\LMHOSTS} (Windows NT/2000). 1517 1518Then @file{@var{dir}} can be accessed in @file{\\smbserver\qemu}. 1519 1520Note that a SAMBA server must be installed on the host OS. 1521QEMU was tested successfully with smbd versions from Red Hat 9, 1522Fedora Core 3 and OpenSUSE 11.x. 1523 1524@item hostfwd=[tcp|udp]:[@var{hostaddr}]:@var{hostport}-[@var{guestaddr}]:@var{guestport} 1525Redirect incoming TCP or UDP connections to the host port @var{hostport} to 1526the guest IP address @var{guestaddr} on guest port @var{guestport}. If 1527@var{guestaddr} is not specified, its value is x.x.x.15 (default first address 1528given by the built-in DHCP server). By specifying @var{hostaddr}, the rule can 1529be bound to a specific host interface. If no connection type is set, TCP is 1530used. This option can be given multiple times. 1531 1532For example, to redirect host X11 connection from screen 1 to guest 1533screen 0, use the following: 1534 1535@example 1536# on the host 1537qemu-system-i386 -net user,hostfwd=tcp:127.0.0.1:6001-:6000 [...] 1538# this host xterm should open in the guest X11 server 1539xterm -display :1 1540@end example 1541 1542To redirect telnet connections from host port 5555 to telnet port on 1543the guest, use the following: 1544 1545@example 1546# on the host 1547qemu-system-i386 -net user,hostfwd=tcp::5555-:23 [...] 1548telnet localhost 5555 1549@end example 1550 1551Then when you use on the host @code{telnet localhost 5555}, you 1552connect to the guest telnet server. 1553 1554@item guestfwd=[tcp]:@var{server}:@var{port}-@var{dev} 1555@item guestfwd=[tcp]:@var{server}:@var{port}-@var{cmd:command} 1556Forward guest TCP connections to the IP address @var{server} on port @var{port} 1557to the character device @var{dev} or to a program executed by @var{cmd:command} 1558which gets spawned for each connection. This option can be given multiple times. 1559 1560You can either use a chardev directly and have that one used throughout QEMU's 1561lifetime, like in the following example: 1562 1563@example 1564# open 10.10.1.1:4321 on bootup, connect 10.0.2.100:1234 to it whenever 1565# the guest accesses it 1566qemu -net user,guestfwd=tcp:10.0.2.100:1234-tcp:10.10.1.1:4321 [...] 1567@end example 1568 1569Or you can execute a command on every TCP connection established by the guest, 1570so that QEMU behaves similar to an inetd process for that virtual server: 1571 1572@example 1573# call "netcat 10.10.1.1 4321" on every TCP connection to 10.0.2.100:1234 1574# and connect the TCP stream to its stdin/stdout 1575qemu -net 'user,guestfwd=tcp:10.0.2.100:1234-cmd:netcat 10.10.1.1 4321' 1576@end example 1577 1578@end table 1579 1580Note: Legacy stand-alone options -tftp, -bootp, -smb and -redir are still 1581processed and applied to -net user. Mixing them with the new configuration 1582syntax gives undefined results. Their use for new applications is discouraged 1583as they will be removed from future versions. 1584 1585@item -netdev tap,id=@var{id}[,fd=@var{h}][,ifname=@var{name}][,script=@var{file}][,downscript=@var{dfile}][,helper=@var{helper}] 1586@item -net tap[,vlan=@var{n}][,name=@var{name}][,fd=@var{h}][,ifname=@var{name}][,script=@var{file}][,downscript=@var{dfile}][,helper=@var{helper}] 1587Connect the host TAP network interface @var{name} to VLAN @var{n}. 1588 1589Use the network script @var{file} to configure it and the network script 1590@var{dfile} to deconfigure it. If @var{name} is not provided, the OS 1591automatically provides one. The default network configure script is 1592@file{/etc/qemu-ifup} and the default network deconfigure script is 1593@file{/etc/qemu-ifdown}. Use @option{script=no} or @option{downscript=no} 1594to disable script execution. 1595 1596If running QEMU as an unprivileged user, use the network helper 1597@var{helper} to configure the TAP interface. The default network 1598helper executable is @file{/usr/local/libexec/qemu-bridge-helper}. 1599 1600@option{fd}=@var{h} can be used to specify the handle of an already 1601opened host TAP interface. 1602 1603Examples: 1604 1605@example 1606#launch a QEMU instance with the default network script 1607qemu-system-i386 linux.img -net nic -net tap 1608@end example 1609 1610@example 1611#launch a QEMU instance with two NICs, each one connected 1612#to a TAP device 1613qemu-system-i386 linux.img \ 1614 -net nic,vlan=0 -net tap,vlan=0,ifname=tap0 \ 1615 -net nic,vlan=1 -net tap,vlan=1,ifname=tap1 1616@end example 1617 1618@example 1619#launch a QEMU instance with the default network helper to 1620#connect a TAP device to bridge br0 1621qemu-system-i386 linux.img \ 1622 -net nic -net tap,"helper=/usr/local/libexec/qemu-bridge-helper" 1623@end example 1624 1625@item -netdev bridge,id=@var{id}[,br=@var{bridge}][,helper=@var{helper}] 1626@item -net bridge[,vlan=@var{n}][,name=@var{name}][,br=@var{bridge}][,helper=@var{helper}] 1627Connect a host TAP network interface to a host bridge device. 1628 1629Use the network helper @var{helper} to configure the TAP interface and 1630attach it to the bridge. The default network helper executable is 1631@file{/usr/local/libexec/qemu-bridge-helper} and the default bridge 1632device is @file{br0}. 1633 1634Examples: 1635 1636@example 1637#launch a QEMU instance with the default network helper to 1638#connect a TAP device to bridge br0 1639qemu-system-i386 linux.img -net bridge -net nic,model=virtio 1640@end example 1641 1642@example 1643#launch a QEMU instance with the default network helper to 1644#connect a TAP device to bridge qemubr0 1645qemu-system-i386 linux.img -net bridge,br=qemubr0 -net nic,model=virtio 1646@end example 1647 1648@item -netdev socket,id=@var{id}[,fd=@var{h}][,listen=[@var{host}]:@var{port}][,connect=@var{host}:@var{port}] 1649@item -net socket[,vlan=@var{n}][,name=@var{name}][,fd=@var{h}] [,listen=[@var{host}]:@var{port}][,connect=@var{host}:@var{port}] 1650 1651Connect the VLAN @var{n} to a remote VLAN in another QEMU virtual 1652machine using a TCP socket connection. If @option{listen} is 1653specified, QEMU waits for incoming connections on @var{port} 1654(@var{host} is optional). @option{connect} is used to connect to 1655another QEMU instance using the @option{listen} option. @option{fd}=@var{h} 1656specifies an already opened TCP socket. 1657 1658Example: 1659@example 1660# launch a first QEMU instance 1661qemu-system-i386 linux.img \ 1662 -net nic,macaddr=52:54:00:12:34:56 \ 1663 -net socket,listen=:1234 1664# connect the VLAN 0 of this instance to the VLAN 0 1665# of the first instance 1666qemu-system-i386 linux.img \ 1667 -net nic,macaddr=52:54:00:12:34:57 \ 1668 -net socket,connect=127.0.0.1:1234 1669@end example 1670 1671@item -netdev socket,id=@var{id}[,fd=@var{h}][,mcast=@var{maddr}:@var{port}[,localaddr=@var{addr}]] 1672@item -net socket[,vlan=@var{n}][,name=@var{name}][,fd=@var{h}][,mcast=@var{maddr}:@var{port}[,localaddr=@var{addr}]] 1673 1674Create a VLAN @var{n} shared with another QEMU virtual 1675machines using a UDP multicast socket, effectively making a bus for 1676every QEMU with same multicast address @var{maddr} and @var{port}. 1677NOTES: 1678@enumerate 1679@item 1680Several QEMU can be running on different hosts and share same bus (assuming 1681correct multicast setup for these hosts). 1682@item 1683mcast support is compatible with User Mode Linux (argument @option{eth@var{N}=mcast}), see 1684@url{http://user-mode-linux.sf.net}. 1685@item 1686Use @option{fd=h} to specify an already opened UDP multicast socket. 1687@end enumerate 1688 1689Example: 1690@example 1691# launch one QEMU instance 1692qemu-system-i386 linux.img \ 1693 -net nic,macaddr=52:54:00:12:34:56 \ 1694 -net socket,mcast=230.0.0.1:1234 1695# launch another QEMU instance on same "bus" 1696qemu-system-i386 linux.img \ 1697 -net nic,macaddr=52:54:00:12:34:57 \ 1698 -net socket,mcast=230.0.0.1:1234 1699# launch yet another QEMU instance on same "bus" 1700qemu-system-i386 linux.img \ 1701 -net nic,macaddr=52:54:00:12:34:58 \ 1702 -net socket,mcast=230.0.0.1:1234 1703@end example 1704 1705Example (User Mode Linux compat.): 1706@example 1707# launch QEMU instance (note mcast address selected 1708# is UML's default) 1709qemu-system-i386 linux.img \ 1710 -net nic,macaddr=52:54:00:12:34:56 \ 1711 -net socket,mcast=239.192.168.1:1102 1712# launch UML 1713/path/to/linux ubd0=/path/to/root_fs eth0=mcast 1714@end example 1715 1716Example (send packets from host's 1.2.3.4): 1717@example 1718qemu-system-i386 linux.img \ 1719 -net nic,macaddr=52:54:00:12:34:56 \ 1720 -net socket,mcast=239.192.168.1:1102,localaddr=1.2.3.4 1721@end example 1722 1723@item -netdev vde,id=@var{id}[,sock=@var{socketpath}][,port=@var{n}][,group=@var{groupname}][,mode=@var{octalmode}] 1724@item -net vde[,vlan=@var{n}][,name=@var{name}][,sock=@var{socketpath}] [,port=@var{n}][,group=@var{groupname}][,mode=@var{octalmode}] 1725Connect VLAN @var{n} to PORT @var{n} of a vde switch running on host and 1726listening for incoming connections on @var{socketpath}. Use GROUP @var{groupname} 1727and MODE @var{octalmode} to change default ownership and permissions for 1728communication port. This option is only available if QEMU has been compiled 1729with vde support enabled. 1730 1731Example: 1732@example 1733# launch vde switch 1734vde_switch -F -sock /tmp/myswitch 1735# launch QEMU instance 1736qemu-system-i386 linux.img -net nic -net vde,sock=/tmp/myswitch 1737@end example 1738 1739@item -netdev hubport,id=@var{id},hubid=@var{hubid} 1740 1741Create a hub port on QEMU "vlan" @var{hubid}. 1742 1743The hubport netdev lets you connect a NIC to a QEMU "vlan" instead of a single 1744netdev. @code{-net} and @code{-device} with parameter @option{vlan} create the 1745required hub automatically. 1746 1747@item -net dump[,vlan=@var{n}][,file=@var{file}][,len=@var{len}] 1748Dump network traffic on VLAN @var{n} to file @var{file} (@file{qemu-vlan0.pcap} by default). 1749At most @var{len} bytes (64k by default) per packet are stored. The file format is 1750libpcap, so it can be analyzed with tools such as tcpdump or Wireshark. 1751 1752@item -net none 1753Indicate that no network devices should be configured. It is used to 1754override the default configuration (@option{-net nic -net user}) which 1755is activated if no @option{-net} options are provided. 1756ETEXI 1757 1758STEXI 1759@end table 1760ETEXI 1761DEFHEADING() 1762 1763DEFHEADING(Character device options:) 1764STEXI 1765 1766The general form of a character device option is: 1767@table @option 1768ETEXI 1769 1770DEF("chardev", HAS_ARG, QEMU_OPTION_chardev, 1771 "-chardev null,id=id[,mux=on|off]\n" 1772 "-chardev socket,id=id[,host=host],port=host[,to=to][,ipv4][,ipv6][,nodelay]\n" 1773 " [,server][,nowait][,telnet][,mux=on|off] (tcp)\n" 1774 "-chardev socket,id=id,path=path[,server][,nowait][,telnet],[mux=on|off] (unix)\n" 1775 "-chardev udp,id=id[,host=host],port=port[,localaddr=localaddr]\n" 1776 " [,localport=localport][,ipv4][,ipv6][,mux=on|off]\n" 1777 "-chardev msmouse,id=id[,mux=on|off]\n" 1778 "-chardev vc,id=id[[,width=width][,height=height]][[,cols=cols][,rows=rows]]\n" 1779 " [,mux=on|off]\n" 1780 "-chardev ringbuf,id=id[,size=size]\n" 1781 "-chardev file,id=id,path=path[,mux=on|off]\n" 1782 "-chardev pipe,id=id,path=path[,mux=on|off]\n" 1783#ifdef _WIN32 1784 "-chardev console,id=id[,mux=on|off]\n" 1785 "-chardev serial,id=id,path=path[,mux=on|off]\n" 1786#else 1787 "-chardev pty,id=id[,mux=on|off]\n" 1788 "-chardev stdio,id=id[,mux=on|off][,signal=on|off]\n" 1789#endif 1790#ifdef CONFIG_BRLAPI 1791 "-chardev braille,id=id[,mux=on|off]\n" 1792#endif 1793#if defined(__linux__) || defined(__sun__) || defined(__FreeBSD__) \ 1794 || defined(__NetBSD__) || defined(__OpenBSD__) || defined(__DragonFly__) 1795 "-chardev serial,id=id,path=path[,mux=on|off]\n" 1796 "-chardev tty,id=id,path=path[,mux=on|off]\n" 1797#endif 1798#if defined(__linux__) || defined(__FreeBSD__) || defined(__DragonFly__) 1799 "-chardev parallel,id=id,path=path[,mux=on|off]\n" 1800 "-chardev parport,id=id,path=path[,mux=on|off]\n" 1801#endif 1802#if defined(CONFIG_SPICE) 1803 "-chardev spicevmc,id=id,name=name[,debug=debug]\n" 1804 "-chardev spiceport,id=id,name=name[,debug=debug]\n" 1805#endif 1806 , QEMU_ARCH_ALL 1807) 1808 1809STEXI 1810@item -chardev @var{backend} ,id=@var{id} [,mux=on|off] [,@var{options}] 1811@findex -chardev 1812Backend is one of: 1813@option{null}, 1814@option{socket}, 1815@option{udp}, 1816@option{msmouse}, 1817@option{vc}, 1818@option{ringbuf}, 1819@option{file}, 1820@option{pipe}, 1821@option{console}, 1822@option{serial}, 1823@option{pty}, 1824@option{stdio}, 1825@option{braille}, 1826@option{tty}, 1827@option{parallel}, 1828@option{parport}, 1829@option{spicevmc}. 1830@option{spiceport}. 1831The specific backend will determine the applicable options. 1832 1833All devices must have an id, which can be any string up to 127 characters long. 1834It is used to uniquely identify this device in other command line directives. 1835 1836A character device may be used in multiplexing mode by multiple front-ends. 1837The key sequence of @key{Control-a} and @key{c} will rotate the input focus 1838between attached front-ends. Specify @option{mux=on} to enable this mode. 1839 1840Options to each backend are described below. 1841 1842@item -chardev null ,id=@var{id} 1843A void device. This device will not emit any data, and will drop any data it 1844receives. The null backend does not take any options. 1845 1846@item -chardev socket ,id=@var{id} [@var{TCP options} or @var{unix options}] [,server] [,nowait] [,telnet] 1847 1848Create a two-way stream socket, which can be either a TCP or a unix socket. A 1849unix socket will be created if @option{path} is specified. Behaviour is 1850undefined if TCP options are specified for a unix socket. 1851 1852@option{server} specifies that the socket shall be a listening socket. 1853 1854@option{nowait} specifies that QEMU should not block waiting for a client to 1855connect to a listening socket. 1856 1857@option{telnet} specifies that traffic on the socket should interpret telnet 1858escape sequences. 1859 1860TCP and unix socket options are given below: 1861 1862@table @option 1863 1864@item TCP options: port=@var{port} [,host=@var{host}] [,to=@var{to}] [,ipv4] [,ipv6] [,nodelay] 1865 1866@option{host} for a listening socket specifies the local address to be bound. 1867For a connecting socket species the remote host to connect to. @option{host} is 1868optional for listening sockets. If not specified it defaults to @code{0.0.0.0}. 1869 1870@option{port} for a listening socket specifies the local port to be bound. For a 1871connecting socket specifies the port on the remote host to connect to. 1872@option{port} can be given as either a port number or a service name. 1873@option{port} is required. 1874 1875@option{to} is only relevant to listening sockets. If it is specified, and 1876@option{port} cannot be bound, QEMU will attempt to bind to subsequent ports up 1877to and including @option{to} until it succeeds. @option{to} must be specified 1878as a port number. 1879 1880@option{ipv4} and @option{ipv6} specify that either IPv4 or IPv6 must be used. 1881If neither is specified the socket may use either protocol. 1882 1883@option{nodelay} disables the Nagle algorithm. 1884 1885@item unix options: path=@var{path} 1886 1887@option{path} specifies the local path of the unix socket. @option{path} is 1888required. 1889 1890@end table 1891 1892@item -chardev udp ,id=@var{id} [,host=@var{host}] ,port=@var{port} [,localaddr=@var{localaddr}] [,localport=@var{localport}] [,ipv4] [,ipv6] 1893 1894Sends all traffic from the guest to a remote host over UDP. 1895 1896@option{host} specifies the remote host to connect to. If not specified it 1897defaults to @code{localhost}. 1898 1899@option{port} specifies the port on the remote host to connect to. @option{port} 1900is required. 1901 1902@option{localaddr} specifies the local address to bind to. If not specified it 1903defaults to @code{0.0.0.0}. 1904 1905@option{localport} specifies the local port to bind to. If not specified any 1906available local port will be used. 1907 1908@option{ipv4} and @option{ipv6} specify that either IPv4 or IPv6 must be used. 1909If neither is specified the device may use either protocol. 1910 1911@item -chardev msmouse ,id=@var{id} 1912 1913Forward QEMU's emulated msmouse events to the guest. @option{msmouse} does not 1914take any options. 1915 1916@item -chardev vc ,id=@var{id} [[,width=@var{width}] [,height=@var{height}]] [[,cols=@var{cols}] [,rows=@var{rows}]] 1917 1918Connect to a QEMU text console. @option{vc} may optionally be given a specific 1919size. 1920 1921@option{width} and @option{height} specify the width and height respectively of 1922the console, in pixels. 1923 1924@option{cols} and @option{rows} specify that the console be sized to fit a text 1925console with the given dimensions. 1926 1927@item -chardev ringbuf ,id=@var{id} [,size=@var{size}] 1928 1929Create a ring buffer with fixed size @option{size}. 1930@var{size} must be a power of two, and defaults to @code{64K}). 1931 1932@item -chardev file ,id=@var{id} ,path=@var{path} 1933 1934Log all traffic received from the guest to a file. 1935 1936@option{path} specifies the path of the file to be opened. This file will be 1937created if it does not already exist, and overwritten if it does. @option{path} 1938is required. 1939 1940@item -chardev pipe ,id=@var{id} ,path=@var{path} 1941 1942Create a two-way connection to the guest. The behaviour differs slightly between 1943Windows hosts and other hosts: 1944 1945On Windows, a single duplex pipe will be created at 1946@file{\\.pipe\@option{path}}. 1947 1948On other hosts, 2 pipes will be created called @file{@option{path}.in} and 1949@file{@option{path}.out}. Data written to @file{@option{path}.in} will be 1950received by the guest. Data written by the guest can be read from 1951@file{@option{path}.out}. QEMU will not create these fifos, and requires them to 1952be present. 1953 1954@option{path} forms part of the pipe path as described above. @option{path} is 1955required. 1956 1957@item -chardev console ,id=@var{id} 1958 1959Send traffic from the guest to QEMU's standard output. @option{console} does not 1960take any options. 1961 1962@option{console} is only available on Windows hosts. 1963 1964@item -chardev serial ,id=@var{id} ,path=@option{path} 1965 1966Send traffic from the guest to a serial device on the host. 1967 1968On Unix hosts serial will actually accept any tty device, 1969not only serial lines. 1970 1971@option{path} specifies the name of the serial device to open. 1972 1973@item -chardev pty ,id=@var{id} 1974 1975Create a new pseudo-terminal on the host and connect to it. @option{pty} does 1976not take any options. 1977 1978@option{pty} is not available on Windows hosts. 1979 1980@item -chardev stdio ,id=@var{id} [,signal=on|off] 1981Connect to standard input and standard output of the QEMU process. 1982 1983@option{signal} controls if signals are enabled on the terminal, that includes 1984exiting QEMU with the key sequence @key{Control-c}. This option is enabled by 1985default, use @option{signal=off} to disable it. 1986 1987@option{stdio} is not available on Windows hosts. 1988 1989@item -chardev braille ,id=@var{id} 1990 1991Connect to a local BrlAPI server. @option{braille} does not take any options. 1992 1993@item -chardev tty ,id=@var{id} ,path=@var{path} 1994 1995@option{tty} is only available on Linux, Sun, FreeBSD, NetBSD, OpenBSD and 1996DragonFlyBSD hosts. It is an alias for @option{serial}. 1997 1998@option{path} specifies the path to the tty. @option{path} is required. 1999 2000@item -chardev parallel ,id=@var{id} ,path=@var{path} 2001@item -chardev parport ,id=@var{id} ,path=@var{path} 2002 2003@option{parallel} is only available on Linux, FreeBSD and DragonFlyBSD hosts. 2004 2005Connect to a local parallel port. 2006 2007@option{path} specifies the path to the parallel port device. @option{path} is 2008required. 2009 2010@item -chardev spicevmc ,id=@var{id} ,debug=@var{debug}, name=@var{name} 2011 2012@option{spicevmc} is only available when spice support is built in. 2013 2014@option{debug} debug level for spicevmc 2015 2016@option{name} name of spice channel to connect to 2017 2018Connect to a spice virtual machine channel, such as vdiport. 2019 2020@item -chardev spiceport ,id=@var{id} ,debug=@var{debug}, name=@var{name} 2021 2022@option{spiceport} is only available when spice support is built in. 2023 2024@option{debug} debug level for spicevmc 2025 2026@option{name} name of spice port to connect to 2027 2028Connect to a spice port, allowing a Spice client to handle the traffic 2029identified by a name (preferably a fqdn). 2030ETEXI 2031 2032STEXI 2033@end table 2034ETEXI 2035DEFHEADING() 2036 2037DEFHEADING(Device URL Syntax:) 2038STEXI 2039 2040In addition to using normal file images for the emulated storage devices, 2041QEMU can also use networked resources such as iSCSI devices. These are 2042specified using a special URL syntax. 2043 2044@table @option 2045@item iSCSI 2046iSCSI support allows QEMU to access iSCSI resources directly and use as 2047images for the guest storage. Both disk and cdrom images are supported. 2048 2049Syntax for specifying iSCSI LUNs is 2050``iscsi://<target-ip>[:<port>]/<target-iqn>/<lun>'' 2051 2052By default qemu will use the iSCSI initiator-name 2053'iqn.2008-11.org.linux-kvm[:<name>]' but this can also be set from the command 2054line or a configuration file. 2055 2056 2057Example (without authentication): 2058@example 2059qemu-system-i386 -iscsi initiator-name=iqn.2001-04.com.example:my-initiator \ 2060 -cdrom iscsi://192.0.2.1/iqn.2001-04.com.example/2 \ 2061 -drive file=iscsi://192.0.2.1/iqn.2001-04.com.example/1 2062@end example 2063 2064Example (CHAP username/password via URL): 2065@example 2066qemu-system-i386 -drive file=iscsi://user%password@@192.0.2.1/iqn.2001-04.com.example/1 2067@end example 2068 2069Example (CHAP username/password via environment variables): 2070@example 2071LIBISCSI_CHAP_USERNAME="user" \ 2072LIBISCSI_CHAP_PASSWORD="password" \ 2073qemu-system-i386 -drive file=iscsi://192.0.2.1/iqn.2001-04.com.example/1 2074@end example 2075 2076iSCSI support is an optional feature of QEMU and only available when 2077compiled and linked against libiscsi. 2078ETEXI 2079DEF("iscsi", HAS_ARG, QEMU_OPTION_iscsi, 2080 "-iscsi [user=user][,password=password]\n" 2081 " [,header-digest=CRC32C|CR32C-NONE|NONE-CRC32C|NONE\n" 2082 " [,initiator-name=iqn]\n" 2083 " iSCSI session parameters\n", QEMU_ARCH_ALL) 2084STEXI 2085 2086iSCSI parameters such as username and password can also be specified via 2087a configuration file. See qemu-doc for more information and examples. 2088 2089@item NBD 2090QEMU supports NBD (Network Block Devices) both using TCP protocol as well 2091as Unix Domain Sockets. 2092 2093Syntax for specifying a NBD device using TCP 2094``nbd:<server-ip>:<port>[:exportname=<export>]'' 2095 2096Syntax for specifying a NBD device using Unix Domain Sockets 2097``nbd:unix:<domain-socket>[:exportname=<export>]'' 2098 2099 2100Example for TCP 2101@example 2102qemu-system-i386 --drive file=nbd:192.0.2.1:30000 2103@end example 2104 2105Example for Unix Domain Sockets 2106@example 2107qemu-system-i386 --drive file=nbd:unix:/tmp/nbd-socket 2108@end example 2109 2110@item SSH 2111QEMU supports SSH (Secure Shell) access to remote disks. 2112 2113Examples: 2114@example 2115qemu-system-i386 -drive file=ssh://user@@host/path/to/disk.img 2116qemu-system-i386 -drive file.driver=ssh,file.user=user,file.host=host,file.port=22,file.path=/path/to/disk.img 2117@end example 2118 2119Currently authentication must be done using ssh-agent. Other 2120authentication methods may be supported in future. 2121 2122@item Sheepdog 2123Sheepdog is a distributed storage system for QEMU. 2124QEMU supports using either local sheepdog devices or remote networked 2125devices. 2126 2127Syntax for specifying a sheepdog device 2128@example 2129sheepdog[+tcp|+unix]://[host:port]/vdiname[?socket=path][#snapid|#tag] 2130@end example 2131 2132Example 2133@example 2134qemu-system-i386 --drive file=sheepdog://192.0.2.1:30000/MyVirtualMachine 2135@end example 2136 2137See also @url{http://http://www.osrg.net/sheepdog/}. 2138 2139@item GlusterFS 2140GlusterFS is an user space distributed file system. 2141QEMU supports the use of GlusterFS volumes for hosting VM disk images using 2142TCP, Unix Domain Sockets and RDMA transport protocols. 2143 2144Syntax for specifying a VM disk image on GlusterFS volume is 2145@example 2146gluster[+transport]://[server[:port]]/volname/image[?socket=...] 2147@end example 2148 2149 2150Example 2151@example 2152qemu-system-x86_64 --drive file=gluster://192.0.2.1/testvol/a.img 2153@end example 2154 2155See also @url{http://www.gluster.org}. 2156ETEXI 2157 2158STEXI 2159@end table 2160ETEXI 2161 2162DEFHEADING(Bluetooth(R) options:) 2163STEXI 2164@table @option 2165ETEXI 2166 2167DEF("bt", HAS_ARG, QEMU_OPTION_bt, \ 2168 "-bt hci,null dumb bluetooth HCI - doesn't respond to commands\n" \ 2169 "-bt hci,host[:id]\n" \ 2170 " use host's HCI with the given name\n" \ 2171 "-bt hci[,vlan=n]\n" \ 2172 " emulate a standard HCI in virtual scatternet 'n'\n" \ 2173 "-bt vhci[,vlan=n]\n" \ 2174 " add host computer to virtual scatternet 'n' using VHCI\n" \ 2175 "-bt device:dev[,vlan=n]\n" \ 2176 " emulate a bluetooth device 'dev' in scatternet 'n'\n", 2177 QEMU_ARCH_ALL) 2178STEXI 2179@item -bt hci[...] 2180@findex -bt 2181Defines the function of the corresponding Bluetooth HCI. -bt options 2182are matched with the HCIs present in the chosen machine type. For 2183example when emulating a machine with only one HCI built into it, only 2184the first @code{-bt hci[...]} option is valid and defines the HCI's 2185logic. The Transport Layer is decided by the machine type. Currently 2186the machines @code{n800} and @code{n810} have one HCI and all other 2187machines have none. 2188 2189@anchor{bt-hcis} 2190The following three types are recognized: 2191 2192@table @option 2193@item -bt hci,null 2194(default) The corresponding Bluetooth HCI assumes no internal logic 2195and will not respond to any HCI commands or emit events. 2196 2197@item -bt hci,host[:@var{id}] 2198(@code{bluez} only) The corresponding HCI passes commands / events 2199to / from the physical HCI identified by the name @var{id} (default: 2200@code{hci0}) on the computer running QEMU. Only available on @code{bluez} 2201capable systems like Linux. 2202 2203@item -bt hci[,vlan=@var{n}] 2204Add a virtual, standard HCI that will participate in the Bluetooth 2205scatternet @var{n} (default @code{0}). Similarly to @option{-net} 2206VLANs, devices inside a bluetooth network @var{n} can only communicate 2207with other devices in the same network (scatternet). 2208@end table 2209 2210@item -bt vhci[,vlan=@var{n}] 2211(Linux-host only) Create a HCI in scatternet @var{n} (default 0) attached 2212to the host bluetooth stack instead of to the emulated target. This 2213allows the host and target machines to participate in a common scatternet 2214and communicate. Requires the Linux @code{vhci} driver installed. Can 2215be used as following: 2216 2217@example 2218qemu-system-i386 [...OPTIONS...] -bt hci,vlan=5 -bt vhci,vlan=5 2219@end example 2220 2221@item -bt device:@var{dev}[,vlan=@var{n}] 2222Emulate a bluetooth device @var{dev} and place it in network @var{n} 2223(default @code{0}). QEMU can only emulate one type of bluetooth devices 2224currently: 2225 2226@table @option 2227@item keyboard 2228Virtual wireless keyboard implementing the HIDP bluetooth profile. 2229@end table 2230ETEXI 2231 2232STEXI 2233@end table 2234ETEXI 2235DEFHEADING() 2236 2237#ifdef CONFIG_TPM 2238DEFHEADING(TPM device options:) 2239 2240DEF("tpmdev", HAS_ARG, QEMU_OPTION_tpmdev, \ 2241 "-tpmdev passthrough,id=id[,path=path][,cancel-path=path]\n" 2242 " use path to provide path to a character device; default is /dev/tpm0\n" 2243 " use cancel-path to provide path to TPM's cancel sysfs entry; if\n" 2244 " not provided it will be searched for in /sys/class/misc/tpm?/device\n", 2245 QEMU_ARCH_ALL) 2246STEXI 2247 2248The general form of a TPM device option is: 2249@table @option 2250 2251@item -tpmdev @var{backend} ,id=@var{id} [,@var{options}] 2252@findex -tpmdev 2253Backend type must be: 2254@option{passthrough}. 2255 2256The specific backend type will determine the applicable options. 2257The @code{-tpmdev} option creates the TPM backend and requires a 2258@code{-device} option that specifies the TPM frontend interface model. 2259 2260Options to each backend are described below. 2261 2262Use 'help' to print all available TPM backend types. 2263@example 2264qemu -tpmdev help 2265@end example 2266 2267@item -tpmdev passthrough, id=@var{id}, path=@var{path}, cancel-path=@var{cancel-path} 2268 2269(Linux-host only) Enable access to the host's TPM using the passthrough 2270driver. 2271 2272@option{path} specifies the path to the host's TPM device, i.e., on 2273a Linux host this would be @code{/dev/tpm0}. 2274@option{path} is optional and by default @code{/dev/tpm0} is used. 2275 2276@option{cancel-path} specifies the path to the host TPM device's sysfs 2277entry allowing for cancellation of an ongoing TPM command. 2278@option{cancel-path} is optional and by default QEMU will search for the 2279sysfs entry to use. 2280 2281Some notes about using the host's TPM with the passthrough driver: 2282 2283The TPM device accessed by the passthrough driver must not be 2284used by any other application on the host. 2285 2286Since the host's firmware (BIOS/UEFI) has already initialized the TPM, 2287the VM's firmware (BIOS/UEFI) will not be able to initialize the 2288TPM again and may therefore not show a TPM-specific menu that would 2289otherwise allow the user to configure the TPM, e.g., allow the user to 2290enable/disable or activate/deactivate the TPM. 2291Further, if TPM ownership is released from within a VM then the host's TPM 2292will get disabled and deactivated. To enable and activate the 2293TPM again afterwards, the host has to be rebooted and the user is 2294required to enter the firmware's menu to enable and activate the TPM. 2295If the TPM is left disabled and/or deactivated most TPM commands will fail. 2296 2297To create a passthrough TPM use the following two options: 2298@example 2299-tpmdev passthrough,id=tpm0 -device tpm-tis,tpmdev=tpm0 2300@end example 2301Note that the @code{-tpmdev} id is @code{tpm0} and is referenced by 2302@code{tpmdev=tpm0} in the device option. 2303 2304@end table 2305 2306ETEXI 2307 2308DEFHEADING() 2309 2310#endif 2311 2312DEFHEADING(Linux/Multiboot boot specific:) 2313STEXI 2314 2315When using these options, you can use a given Linux or Multiboot 2316kernel without installing it in the disk image. It can be useful 2317for easier testing of various kernels. 2318 2319@table @option 2320ETEXI 2321 2322DEF("kernel", HAS_ARG, QEMU_OPTION_kernel, \ 2323 "-kernel bzImage use 'bzImage' as kernel image\n", QEMU_ARCH_ALL) 2324STEXI 2325@item -kernel @var{bzImage} 2326@findex -kernel 2327Use @var{bzImage} as kernel image. The kernel can be either a Linux kernel 2328or in multiboot format. 2329ETEXI 2330 2331DEF("append", HAS_ARG, QEMU_OPTION_append, \ 2332 "-append cmdline use 'cmdline' as kernel command line\n", QEMU_ARCH_ALL) 2333STEXI 2334@item -append @var{cmdline} 2335@findex -append 2336Use @var{cmdline} as kernel command line 2337ETEXI 2338 2339DEF("initrd", HAS_ARG, QEMU_OPTION_initrd, \ 2340 "-initrd file use 'file' as initial ram disk\n", QEMU_ARCH_ALL) 2341STEXI 2342@item -initrd @var{file} 2343@findex -initrd 2344Use @var{file} as initial ram disk. 2345 2346@item -initrd "@var{file1} arg=foo,@var{file2}" 2347 2348This syntax is only available with multiboot. 2349 2350Use @var{file1} and @var{file2} as modules and pass arg=foo as parameter to the 2351first module. 2352ETEXI 2353 2354DEF("dtb", HAS_ARG, QEMU_OPTION_dtb, \ 2355 "-dtb file use 'file' as device tree image\n", QEMU_ARCH_ALL) 2356STEXI 2357@item -dtb @var{file} 2358@findex -dtb 2359Use @var{file} as a device tree binary (dtb) image and pass it to the kernel 2360on boot. 2361ETEXI 2362 2363STEXI 2364@end table 2365ETEXI 2366DEFHEADING() 2367 2368DEFHEADING(Debug/Expert options:) 2369STEXI 2370@table @option 2371ETEXI 2372 2373DEF("serial", HAS_ARG, QEMU_OPTION_serial, \ 2374 "-serial dev redirect the serial port to char device 'dev'\n", 2375 QEMU_ARCH_ALL) 2376STEXI 2377@item -serial @var{dev} 2378@findex -serial 2379Redirect the virtual serial port to host character device 2380@var{dev}. The default device is @code{vc} in graphical mode and 2381@code{stdio} in non graphical mode. 2382 2383This option can be used several times to simulate up to 4 serial 2384ports. 2385 2386Use @code{-serial none} to disable all serial ports. 2387 2388Available character devices are: 2389@table @option 2390@item vc[:@var{W}x@var{H}] 2391Virtual console. Optionally, a width and height can be given in pixel with 2392@example 2393vc:800x600 2394@end example 2395It is also possible to specify width or height in characters: 2396@example 2397vc:80Cx24C 2398@end example 2399@item pty 2400[Linux only] Pseudo TTY (a new PTY is automatically allocated) 2401@item none 2402No device is allocated. 2403@item null 2404void device 2405@item /dev/XXX 2406[Linux only] Use host tty, e.g. @file{/dev/ttyS0}. The host serial port 2407parameters are set according to the emulated ones. 2408@item /dev/parport@var{N} 2409[Linux only, parallel port only] Use host parallel port 2410@var{N}. Currently SPP and EPP parallel port features can be used. 2411@item file:@var{filename} 2412Write output to @var{filename}. No character can be read. 2413@item stdio 2414[Unix only] standard input/output 2415@item pipe:@var{filename} 2416name pipe @var{filename} 2417@item COM@var{n} 2418[Windows only] Use host serial port @var{n} 2419@item udp:[@var{remote_host}]:@var{remote_port}[@@[@var{src_ip}]:@var{src_port}] 2420This implements UDP Net Console. 2421When @var{remote_host} or @var{src_ip} are not specified 2422they default to @code{0.0.0.0}. 2423When not using a specified @var{src_port} a random port is automatically chosen. 2424 2425If you just want a simple readonly console you can use @code{netcat} or 2426@code{nc}, by starting QEMU with: @code{-serial udp::4555} and nc as: 2427@code{nc -u -l -p 4555}. Any time QEMU writes something to that port it 2428will appear in the netconsole session. 2429 2430If you plan to send characters back via netconsole or you want to stop 2431and start QEMU a lot of times, you should have QEMU use the same 2432source port each time by using something like @code{-serial 2433udp::4555@@:4556} to QEMU. Another approach is to use a patched 2434version of netcat which can listen to a TCP port and send and receive 2435characters via udp. If you have a patched version of netcat which 2436activates telnet remote echo and single char transfer, then you can 2437use the following options to step up a netcat redirector to allow 2438telnet on port 5555 to access the QEMU port. 2439@table @code 2440@item QEMU Options: 2441-serial udp::4555@@:4556 2442@item netcat options: 2443-u -P 4555 -L 0.0.0.0:4556 -t -p 5555 -I -T 2444@item telnet options: 2445localhost 5555 2446@end table 2447 2448@item tcp:[@var{host}]:@var{port}[,@var{server}][,nowait][,nodelay] 2449The TCP Net Console has two modes of operation. It can send the serial 2450I/O to a location or wait for a connection from a location. By default 2451the TCP Net Console is sent to @var{host} at the @var{port}. If you use 2452the @var{server} option QEMU will wait for a client socket application 2453to connect to the port before continuing, unless the @code{nowait} 2454option was specified. The @code{nodelay} option disables the Nagle buffering 2455algorithm. If @var{host} is omitted, 0.0.0.0 is assumed. Only 2456one TCP connection at a time is accepted. You can use @code{telnet} to 2457connect to the corresponding character device. 2458@table @code 2459@item Example to send tcp console to 192.168.0.2 port 4444 2460-serial tcp:192.168.0.2:4444 2461@item Example to listen and wait on port 4444 for connection 2462-serial tcp::4444,server 2463@item Example to not wait and listen on ip 192.168.0.100 port 4444 2464-serial tcp:192.168.0.100:4444,server,nowait 2465@end table 2466 2467@item telnet:@var{host}:@var{port}[,server][,nowait][,nodelay] 2468The telnet protocol is used instead of raw tcp sockets. The options 2469work the same as if you had specified @code{-serial tcp}. The 2470difference is that the port acts like a telnet server or client using 2471telnet option negotiation. This will also allow you to send the 2472MAGIC_SYSRQ sequence if you use a telnet that supports sending the break 2473sequence. Typically in unix telnet you do it with Control-] and then 2474type "send break" followed by pressing the enter key. 2475 2476@item unix:@var{path}[,server][,nowait] 2477A unix domain socket is used instead of a tcp socket. The option works the 2478same as if you had specified @code{-serial tcp} except the unix domain socket 2479@var{path} is used for connections. 2480 2481@item mon:@var{dev_string} 2482This is a special option to allow the monitor to be multiplexed onto 2483another serial port. The monitor is accessed with key sequence of 2484@key{Control-a} and then pressing @key{c}. See monitor access 2485@ref{pcsys_keys} in the -nographic section for more keys. 2486@var{dev_string} should be any one of the serial devices specified 2487above. An example to multiplex the monitor onto a telnet server 2488listening on port 4444 would be: 2489@table @code 2490@item -serial mon:telnet::4444,server,nowait 2491@end table 2492 2493@item braille 2494Braille device. This will use BrlAPI to display the braille output on a real 2495or fake device. 2496 2497@item msmouse 2498Three button serial mouse. Configure the guest to use Microsoft protocol. 2499@end table 2500ETEXI 2501 2502DEF("parallel", HAS_ARG, QEMU_OPTION_parallel, \ 2503 "-parallel dev redirect the parallel port to char device 'dev'\n", 2504 QEMU_ARCH_ALL) 2505STEXI 2506@item -parallel @var{dev} 2507@findex -parallel 2508Redirect the virtual parallel port to host device @var{dev} (same 2509devices as the serial port). On Linux hosts, @file{/dev/parportN} can 2510be used to use hardware devices connected on the corresponding host 2511parallel port. 2512 2513This option can be used several times to simulate up to 3 parallel 2514ports. 2515 2516Use @code{-parallel none} to disable all parallel ports. 2517ETEXI 2518 2519DEF("monitor", HAS_ARG, QEMU_OPTION_monitor, \ 2520 "-monitor dev redirect the monitor to char device 'dev'\n", 2521 QEMU_ARCH_ALL) 2522STEXI 2523@item -monitor @var{dev} 2524@findex -monitor 2525Redirect the monitor to host device @var{dev} (same devices as the 2526serial port). 2527The default device is @code{vc} in graphical mode and @code{stdio} in 2528non graphical mode. 2529ETEXI 2530DEF("qmp", HAS_ARG, QEMU_OPTION_qmp, \ 2531 "-qmp dev like -monitor but opens in 'control' mode\n", 2532 QEMU_ARCH_ALL) 2533STEXI 2534@item -qmp @var{dev} 2535@findex -qmp 2536Like -monitor but opens in 'control' mode. 2537ETEXI 2538 2539DEF("mon", HAS_ARG, QEMU_OPTION_mon, \ 2540 "-mon chardev=[name][,mode=readline|control][,default]\n", QEMU_ARCH_ALL) 2541STEXI 2542@item -mon chardev=[name][,mode=readline|control][,default] 2543@findex -mon 2544Setup monitor on chardev @var{name}. 2545ETEXI 2546 2547DEF("debugcon", HAS_ARG, QEMU_OPTION_debugcon, \ 2548 "-debugcon dev redirect the debug console to char device 'dev'\n", 2549 QEMU_ARCH_ALL) 2550STEXI 2551@item -debugcon @var{dev} 2552@findex -debugcon 2553Redirect the debug console to host device @var{dev} (same devices as the 2554serial port). The debug console is an I/O port which is typically port 25550xe9; writing to that I/O port sends output to this device. 2556The default device is @code{vc} in graphical mode and @code{stdio} in 2557non graphical mode. 2558ETEXI 2559 2560DEF("pidfile", HAS_ARG, QEMU_OPTION_pidfile, \ 2561 "-pidfile file write PID to 'file'\n", QEMU_ARCH_ALL) 2562STEXI 2563@item -pidfile @var{file} 2564@findex -pidfile 2565Store the QEMU process PID in @var{file}. It is useful if you launch QEMU 2566from a script. 2567ETEXI 2568 2569DEF("singlestep", 0, QEMU_OPTION_singlestep, \ 2570 "-singlestep always run in singlestep mode\n", QEMU_ARCH_ALL) 2571STEXI 2572@item -singlestep 2573@findex -singlestep 2574Run the emulation in single step mode. 2575ETEXI 2576 2577DEF("S", 0, QEMU_OPTION_S, \ 2578 "-S freeze CPU at startup (use 'c' to start execution)\n", 2579 QEMU_ARCH_ALL) 2580STEXI 2581@item -S 2582@findex -S 2583Do not start CPU at startup (you must type 'c' in the monitor). 2584ETEXI 2585 2586DEF("gdb", HAS_ARG, QEMU_OPTION_gdb, \ 2587 "-gdb dev wait for gdb connection on 'dev'\n", QEMU_ARCH_ALL) 2588STEXI 2589@item -gdb @var{dev} 2590@findex -gdb 2591Wait for gdb connection on device @var{dev} (@pxref{gdb_usage}). Typical 2592connections will likely be TCP-based, but also UDP, pseudo TTY, or even 2593stdio are reasonable use case. The latter is allowing to start QEMU from 2594within gdb and establish the connection via a pipe: 2595@example 2596(gdb) target remote | exec qemu-system-i386 -gdb stdio ... 2597@end example 2598ETEXI 2599 2600DEF("s", 0, QEMU_OPTION_s, \ 2601 "-s shorthand for -gdb tcp::" DEFAULT_GDBSTUB_PORT "\n", 2602 QEMU_ARCH_ALL) 2603STEXI 2604@item -s 2605@findex -s 2606Shorthand for -gdb tcp::1234, i.e. open a gdbserver on TCP port 1234 2607(@pxref{gdb_usage}). 2608ETEXI 2609 2610DEF("d", HAS_ARG, QEMU_OPTION_d, \ 2611 "-d item1,... enable logging of specified items (use '-d help' for a list of log items)\n", 2612 QEMU_ARCH_ALL) 2613STEXI 2614@item -d @var{item1}[,...] 2615@findex -d 2616Enable logging of specified items. Use '-d help' for a list of log items. 2617ETEXI 2618 2619DEF("D", HAS_ARG, QEMU_OPTION_D, \ 2620 "-D logfile output log to logfile (default stderr)\n", 2621 QEMU_ARCH_ALL) 2622STEXI 2623@item -D @var{logfile} 2624@findex -D 2625Output log in @var{logfile} instead of to stderr 2626ETEXI 2627 2628DEF("L", HAS_ARG, QEMU_OPTION_L, \ 2629 "-L path set the directory for the BIOS, VGA BIOS and keymaps\n", 2630 QEMU_ARCH_ALL) 2631STEXI 2632@item -L @var{path} 2633@findex -L 2634Set the directory for the BIOS, VGA BIOS and keymaps. 2635ETEXI 2636 2637DEF("bios", HAS_ARG, QEMU_OPTION_bios, \ 2638 "-bios file set the filename for the BIOS\n", QEMU_ARCH_ALL) 2639STEXI 2640@item -bios @var{file} 2641@findex -bios 2642Set the filename for the BIOS. 2643ETEXI 2644 2645DEF("enable-kvm", 0, QEMU_OPTION_enable_kvm, \ 2646 "-enable-kvm enable KVM full virtualization support\n", QEMU_ARCH_ALL) 2647STEXI 2648@item -enable-kvm 2649@findex -enable-kvm 2650Enable KVM full virtualization support. This option is only available 2651if KVM support is enabled when compiling. 2652ETEXI 2653 2654DEF("xen-domid", HAS_ARG, QEMU_OPTION_xen_domid, 2655 "-xen-domid id specify xen guest domain id\n", QEMU_ARCH_ALL) 2656DEF("xen-create", 0, QEMU_OPTION_xen_create, 2657 "-xen-create create domain using xen hypercalls, bypassing xend\n" 2658 " warning: should not be used when xend is in use\n", 2659 QEMU_ARCH_ALL) 2660DEF("xen-attach", 0, QEMU_OPTION_xen_attach, 2661 "-xen-attach attach to existing xen domain\n" 2662 " xend will use this when starting QEMU\n", 2663 QEMU_ARCH_ALL) 2664STEXI 2665@item -xen-domid @var{id} 2666@findex -xen-domid 2667Specify xen guest domain @var{id} (XEN only). 2668@item -xen-create 2669@findex -xen-create 2670Create domain using xen hypercalls, bypassing xend. 2671Warning: should not be used when xend is in use (XEN only). 2672@item -xen-attach 2673@findex -xen-attach 2674Attach to existing xen domain. 2675xend will use this when starting QEMU (XEN only). 2676ETEXI 2677 2678DEF("no-reboot", 0, QEMU_OPTION_no_reboot, \ 2679 "-no-reboot exit instead of rebooting\n", QEMU_ARCH_ALL) 2680STEXI 2681@item -no-reboot 2682@findex -no-reboot 2683Exit instead of rebooting. 2684ETEXI 2685 2686DEF("no-shutdown", 0, QEMU_OPTION_no_shutdown, \ 2687 "-no-shutdown stop before shutdown\n", QEMU_ARCH_ALL) 2688STEXI 2689@item -no-shutdown 2690@findex -no-shutdown 2691Don't exit QEMU on guest shutdown, but instead only stop the emulation. 2692This allows for instance switching to monitor to commit changes to the 2693disk image. 2694ETEXI 2695 2696DEF("loadvm", HAS_ARG, QEMU_OPTION_loadvm, \ 2697 "-loadvm [tag|id]\n" \ 2698 " start right away with a saved state (loadvm in monitor)\n", 2699 QEMU_ARCH_ALL) 2700STEXI 2701@item -loadvm @var{file} 2702@findex -loadvm 2703Start right away with a saved state (@code{loadvm} in monitor) 2704ETEXI 2705 2706#ifndef _WIN32 2707DEF("daemonize", 0, QEMU_OPTION_daemonize, \ 2708 "-daemonize daemonize QEMU after initializing\n", QEMU_ARCH_ALL) 2709#endif 2710STEXI 2711@item -daemonize 2712@findex -daemonize 2713Daemonize the QEMU process after initialization. QEMU will not detach from 2714standard IO until it is ready to receive connections on any of its devices. 2715This option is a useful way for external programs to launch QEMU without having 2716to cope with initialization race conditions. 2717ETEXI 2718 2719DEF("option-rom", HAS_ARG, QEMU_OPTION_option_rom, \ 2720 "-option-rom rom load a file, rom, into the option ROM space\n", 2721 QEMU_ARCH_ALL) 2722STEXI 2723@item -option-rom @var{file} 2724@findex -option-rom 2725Load the contents of @var{file} as an option ROM. 2726This option is useful to load things like EtherBoot. 2727ETEXI 2728 2729DEF("clock", HAS_ARG, QEMU_OPTION_clock, \ 2730 "-clock force the use of the given methods for timer alarm.\n" \ 2731 " To see what timers are available use '-clock help'\n", 2732 QEMU_ARCH_ALL) 2733STEXI 2734@item -clock @var{method} 2735@findex -clock 2736Force the use of the given methods for timer alarm. To see what timers 2737are available use @code{-clock help}. 2738ETEXI 2739 2740HXCOMM Options deprecated by -rtc 2741DEF("localtime", 0, QEMU_OPTION_localtime, "", QEMU_ARCH_ALL) 2742DEF("startdate", HAS_ARG, QEMU_OPTION_startdate, "", QEMU_ARCH_ALL) 2743 2744DEF("rtc", HAS_ARG, QEMU_OPTION_rtc, \ 2745 "-rtc [base=utc|localtime|date][,clock=host|rt|vm][,driftfix=none|slew]\n" \ 2746 " set the RTC base and clock, enable drift fix for clock ticks (x86 only)\n", 2747 QEMU_ARCH_ALL) 2748 2749STEXI 2750 2751@item -rtc [base=utc|localtime|@var{date}][,clock=host|vm][,driftfix=none|slew] 2752@findex -rtc 2753Specify @option{base} as @code{utc} or @code{localtime} to let the RTC start at the current 2754UTC or local time, respectively. @code{localtime} is required for correct date in 2755MS-DOS or Windows. To start at a specific point in time, provide @var{date} in the 2756format @code{2006-06-17T16:01:21} or @code{2006-06-17}. The default base is UTC. 2757 2758By default the RTC is driven by the host system time. This allows to use the 2759RTC as accurate reference clock inside the guest, specifically if the host 2760time is smoothly following an accurate external reference clock, e.g. via NTP. 2761If you want to isolate the guest time from the host, you can set @option{clock} 2762to @code{rt} instead. To even prevent it from progressing during suspension, 2763you can set it to @code{vm}. 2764 2765Enable @option{driftfix} (i386 targets only) if you experience time drift problems, 2766specifically with Windows' ACPI HAL. This option will try to figure out how 2767many timer interrupts were not processed by the Windows guest and will 2768re-inject them. 2769ETEXI 2770 2771DEF("icount", HAS_ARG, QEMU_OPTION_icount, \ 2772 "-icount [N|auto]\n" \ 2773 " enable virtual instruction counter with 2^N clock ticks per\n" \ 2774 " instruction\n", QEMU_ARCH_ALL) 2775STEXI 2776@item -icount [@var{N}|auto] 2777@findex -icount 2778Enable virtual instruction counter. The virtual cpu will execute one 2779instruction every 2^@var{N} ns of virtual time. If @code{auto} is specified 2780then the virtual cpu speed will be automatically adjusted to keep virtual 2781time within a few seconds of real time. 2782 2783Note that while this option can give deterministic behavior, it does not 2784provide cycle accurate emulation. Modern CPUs contain superscalar out of 2785order cores with complex cache hierarchies. The number of instructions 2786executed often has little or no correlation with actual performance. 2787ETEXI 2788 2789DEF("watchdog", HAS_ARG, QEMU_OPTION_watchdog, \ 2790 "-watchdog i6300esb|ib700\n" \ 2791 " enable virtual hardware watchdog [default=none]\n", 2792 QEMU_ARCH_ALL) 2793STEXI 2794@item -watchdog @var{model} 2795@findex -watchdog 2796Create a virtual hardware watchdog device. Once enabled (by a guest 2797action), the watchdog must be periodically polled by an agent inside 2798the guest or else the guest will be restarted. 2799 2800The @var{model} is the model of hardware watchdog to emulate. Choices 2801for model are: @code{ib700} (iBASE 700) which is a very simple ISA 2802watchdog with a single timer, or @code{i6300esb} (Intel 6300ESB I/O 2803controller hub) which is a much more featureful PCI-based dual-timer 2804watchdog. Choose a model for which your guest has drivers. 2805 2806Use @code{-watchdog help} to list available hardware models. Only one 2807watchdog can be enabled for a guest. 2808ETEXI 2809 2810DEF("watchdog-action", HAS_ARG, QEMU_OPTION_watchdog_action, \ 2811 "-watchdog-action reset|shutdown|poweroff|pause|debug|none\n" \ 2812 " action when watchdog fires [default=reset]\n", 2813 QEMU_ARCH_ALL) 2814STEXI 2815@item -watchdog-action @var{action} 2816@findex -watchdog-action 2817 2818The @var{action} controls what QEMU will do when the watchdog timer 2819expires. 2820The default is 2821@code{reset} (forcefully reset the guest). 2822Other possible actions are: 2823@code{shutdown} (attempt to gracefully shutdown the guest), 2824@code{poweroff} (forcefully poweroff the guest), 2825@code{pause} (pause the guest), 2826@code{debug} (print a debug message and continue), or 2827@code{none} (do nothing). 2828 2829Note that the @code{shutdown} action requires that the guest responds 2830to ACPI signals, which it may not be able to do in the sort of 2831situations where the watchdog would have expired, and thus 2832@code{-watchdog-action shutdown} is not recommended for production use. 2833 2834Examples: 2835 2836@table @code 2837@item -watchdog i6300esb -watchdog-action pause 2838@item -watchdog ib700 2839@end table 2840ETEXI 2841 2842DEF("echr", HAS_ARG, QEMU_OPTION_echr, \ 2843 "-echr chr set terminal escape character instead of ctrl-a\n", 2844 QEMU_ARCH_ALL) 2845STEXI 2846 2847@item -echr @var{numeric_ascii_value} 2848@findex -echr 2849Change the escape character used for switching to the monitor when using 2850monitor and serial sharing. The default is @code{0x01} when using the 2851@code{-nographic} option. @code{0x01} is equal to pressing 2852@code{Control-a}. You can select a different character from the ascii 2853control keys where 1 through 26 map to Control-a through Control-z. For 2854instance you could use the either of the following to change the escape 2855character to Control-t. 2856@table @code 2857@item -echr 0x14 2858@item -echr 20 2859@end table 2860ETEXI 2861 2862DEF("virtioconsole", HAS_ARG, QEMU_OPTION_virtiocon, \ 2863 "-virtioconsole c\n" \ 2864 " set virtio console\n", QEMU_ARCH_ALL) 2865STEXI 2866@item -virtioconsole @var{c} 2867@findex -virtioconsole 2868Set virtio console. 2869 2870This option is maintained for backward compatibility. 2871 2872Please use @code{-device virtconsole} for the new way of invocation. 2873ETEXI 2874 2875DEF("show-cursor", 0, QEMU_OPTION_show_cursor, \ 2876 "-show-cursor show cursor\n", QEMU_ARCH_ALL) 2877STEXI 2878@item -show-cursor 2879@findex -show-cursor 2880Show cursor. 2881ETEXI 2882 2883DEF("tb-size", HAS_ARG, QEMU_OPTION_tb_size, \ 2884 "-tb-size n set TB size\n", QEMU_ARCH_ALL) 2885STEXI 2886@item -tb-size @var{n} 2887@findex -tb-size 2888Set TB size. 2889ETEXI 2890 2891DEF("incoming", HAS_ARG, QEMU_OPTION_incoming, \ 2892 "-incoming p prepare for incoming migration, listen on port p\n", 2893 QEMU_ARCH_ALL) 2894STEXI 2895@item -incoming @var{port} 2896@findex -incoming 2897Prepare for incoming migration, listen on @var{port}. 2898ETEXI 2899 2900DEF("nodefaults", 0, QEMU_OPTION_nodefaults, \ 2901 "-nodefaults don't create default devices\n", QEMU_ARCH_ALL) 2902STEXI 2903@item -nodefaults 2904@findex -nodefaults 2905Don't create default devices. Normally, QEMU sets the default devices like serial 2906port, parallel port, virtual console, monitor device, VGA adapter, floppy and 2907CD-ROM drive and others. The @code{-nodefaults} option will disable all those 2908default devices. 2909ETEXI 2910 2911#ifndef _WIN32 2912DEF("chroot", HAS_ARG, QEMU_OPTION_chroot, \ 2913 "-chroot dir chroot to dir just before starting the VM\n", 2914 QEMU_ARCH_ALL) 2915#endif 2916STEXI 2917@item -chroot @var{dir} 2918@findex -chroot 2919Immediately before starting guest execution, chroot to the specified 2920directory. Especially useful in combination with -runas. 2921ETEXI 2922 2923#ifndef _WIN32 2924DEF("runas", HAS_ARG, QEMU_OPTION_runas, \ 2925 "-runas user change to user id user just before starting the VM\n", 2926 QEMU_ARCH_ALL) 2927#endif 2928STEXI 2929@item -runas @var{user} 2930@findex -runas 2931Immediately before starting guest execution, drop root privileges, switching 2932to the specified user. 2933ETEXI 2934 2935DEF("prom-env", HAS_ARG, QEMU_OPTION_prom_env, 2936 "-prom-env variable=value\n" 2937 " set OpenBIOS nvram variables\n", 2938 QEMU_ARCH_PPC | QEMU_ARCH_SPARC) 2939STEXI 2940@item -prom-env @var{variable}=@var{value} 2941@findex -prom-env 2942Set OpenBIOS nvram @var{variable} to given @var{value} (PPC, SPARC only). 2943ETEXI 2944DEF("semihosting", 0, QEMU_OPTION_semihosting, 2945 "-semihosting semihosting mode\n", QEMU_ARCH_ARM | QEMU_ARCH_M68K | QEMU_ARCH_XTENSA) 2946STEXI 2947@item -semihosting 2948@findex -semihosting 2949Semihosting mode (ARM, M68K, Xtensa only). 2950ETEXI 2951DEF("old-param", 0, QEMU_OPTION_old_param, 2952 "-old-param old param mode\n", QEMU_ARCH_ARM) 2953STEXI 2954@item -old-param 2955@findex -old-param (ARM) 2956Old param mode (ARM only). 2957ETEXI 2958 2959DEF("sandbox", HAS_ARG, QEMU_OPTION_sandbox, \ 2960 "-sandbox <arg> Enable seccomp mode 2 system call filter (default 'off').\n", 2961 QEMU_ARCH_ALL) 2962STEXI 2963@item -sandbox @var{arg} 2964@findex -sandbox 2965Enable Seccomp mode 2 system call filter. 'on' will enable syscall filtering and 'off' will 2966disable it. The default is 'off'. 2967ETEXI 2968 2969DEF("readconfig", HAS_ARG, QEMU_OPTION_readconfig, 2970 "-readconfig <file>\n", QEMU_ARCH_ALL) 2971STEXI 2972@item -readconfig @var{file} 2973@findex -readconfig 2974Read device configuration from @var{file}. This approach is useful when you want to spawn 2975QEMU process with many command line options but you don't want to exceed the command line 2976character limit. 2977ETEXI 2978DEF("writeconfig", HAS_ARG, QEMU_OPTION_writeconfig, 2979 "-writeconfig <file>\n" 2980 " read/write config file\n", QEMU_ARCH_ALL) 2981STEXI 2982@item -writeconfig @var{file} 2983@findex -writeconfig 2984Write device configuration to @var{file}. The @var{file} can be either filename to save 2985command line and device configuration into file or dash @code{-}) character to print the 2986output to stdout. This can be later used as input file for @code{-readconfig} option. 2987ETEXI 2988DEF("nodefconfig", 0, QEMU_OPTION_nodefconfig, 2989 "-nodefconfig\n" 2990 " do not load default config files at startup\n", 2991 QEMU_ARCH_ALL) 2992STEXI 2993@item -nodefconfig 2994@findex -nodefconfig 2995Normally QEMU loads configuration files from @var{sysconfdir} and @var{datadir} at startup. 2996The @code{-nodefconfig} option will prevent QEMU from loading any of those config files. 2997ETEXI 2998DEF("no-user-config", 0, QEMU_OPTION_nouserconfig, 2999 "-no-user-config\n" 3000 " do not load user-provided config files at startup\n", 3001 QEMU_ARCH_ALL) 3002STEXI 3003@item -no-user-config 3004@findex -no-user-config 3005The @code{-no-user-config} option makes QEMU not load any of the user-provided 3006config files on @var{sysconfdir}, but won't make it skip the QEMU-provided config 3007files from @var{datadir}. 3008ETEXI 3009DEF("trace", HAS_ARG, QEMU_OPTION_trace, 3010 "-trace [events=<file>][,file=<file>]\n" 3011 " specify tracing options\n", 3012 QEMU_ARCH_ALL) 3013STEXI 3014HXCOMM This line is not accurate, as some sub-options are backend-specific but 3015HXCOMM HX does not support conditional compilation of text. 3016@item -trace [events=@var{file}][,file=@var{file}] 3017@findex -trace 3018 3019Specify tracing options. 3020 3021@table @option 3022@item events=@var{file} 3023Immediately enable events listed in @var{file}. 3024The file must contain one event name (as listed in the @var{trace-events} file) 3025per line. 3026This option is only available if QEMU has been compiled with 3027either @var{simple} or @var{stderr} tracing backend. 3028@item file=@var{file} 3029Log output traces to @var{file}. 3030 3031This option is only available if QEMU has been compiled with 3032the @var{simple} tracing backend. 3033@end table 3034ETEXI 3035 3036HXCOMM Internal use 3037DEF("qtest", HAS_ARG, QEMU_OPTION_qtest, "", QEMU_ARCH_ALL) 3038DEF("qtest-log", HAS_ARG, QEMU_OPTION_qtest_log, "", QEMU_ARCH_ALL) 3039 3040#ifdef __linux__ 3041DEF("enable-fips", 0, QEMU_OPTION_enablefips, 3042 "-enable-fips enable FIPS 140-2 compliance\n", 3043 QEMU_ARCH_ALL) 3044#endif 3045STEXI 3046@item -enable-fips 3047@findex -enable-fips 3048Enable FIPS 140-2 compliance mode. 3049ETEXI 3050 3051HXCOMM Deprecated by -machine accel=tcg property 3052DEF("no-kvm", 0, QEMU_OPTION_no_kvm, "", QEMU_ARCH_I386) 3053 3054HXCOMM Deprecated by kvm-pit driver properties 3055DEF("no-kvm-pit-reinjection", 0, QEMU_OPTION_no_kvm_pit_reinjection, 3056 "", QEMU_ARCH_I386) 3057 3058HXCOMM Deprecated (ignored) 3059DEF("no-kvm-pit", 0, QEMU_OPTION_no_kvm_pit, "", QEMU_ARCH_I386) 3060 3061HXCOMM Deprecated by -machine kernel_irqchip=on|off property 3062DEF("no-kvm-irqchip", 0, QEMU_OPTION_no_kvm_irqchip, "", QEMU_ARCH_I386) 3063 3064HXCOMM Deprecated (ignored) 3065DEF("tdf", 0, QEMU_OPTION_tdf,"", QEMU_ARCH_ALL) 3066 3067DEF("object", HAS_ARG, QEMU_OPTION_object, 3068 "-object TYPENAME[,PROP1=VALUE1,...]\n" 3069 " create an new object of type TYPENAME setting properties\n" 3070 " in the order they are specified. Note that the 'id'\n" 3071 " property must be set. These objects are placed in the\n" 3072 " '/objects' path.\n", 3073 QEMU_ARCH_ALL) 3074STEXI 3075@item -object @var{typename}[,@var{prop1}=@var{value1},...] 3076@findex -object 3077Create an new object of type @var{typename} setting properties 3078in the order they are specified. Note that the 'id' 3079property must be set. These objects are placed in the 3080'/objects' path. 3081ETEXI 3082 3083HXCOMM This is the last statement. Insert new options before this line! 3084STEXI 3085@end table 3086ETEXI 3087
