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