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