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