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