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