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