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