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