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