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