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