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