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