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