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