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|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 none 776Disable VGA card. 777@end table 778ETEXI 779 780DEF("full-screen", 0, QEMU_OPTION_full_screen, 781 "-full-screen start in full screen\n", QEMU_ARCH_ALL) 782STEXI 783@item -full-screen 784@findex -full-screen 785Start in full screen. 786ETEXI 787 788DEF("g", 1, QEMU_OPTION_g , 789 "-g WxH[xDEPTH] Set the initial graphical resolution and depth\n", 790 QEMU_ARCH_PPC | QEMU_ARCH_SPARC) 791STEXI 792@item -g @var{width}x@var{height}[x@var{depth}] 793@findex -g 794Set the initial graphical resolution and depth (PPC, SPARC only). 795ETEXI 796 797DEF("vnc", HAS_ARG, QEMU_OPTION_vnc , 798 "-vnc display start a VNC server on display\n", QEMU_ARCH_ALL) 799STEXI 800@item -vnc @var{display}[,@var{option}[,@var{option}[,...]]] 801@findex -vnc 802Normally, QEMU uses SDL to display the VGA output. With this option, 803you can have QEMU listen on VNC display @var{display} and redirect the VGA 804display over the VNC session. It is very useful to enable the usb 805tablet device when using this option (option @option{-usbdevice 806tablet}). When using the VNC display, you must use the @option{-k} 807parameter to set the keyboard layout if you are not using en-us. Valid 808syntax for the @var{display} is 809 810@table @option 811 812@item @var{host}:@var{d} 813 814TCP connections will only be allowed from @var{host} on display @var{d}. 815By convention the TCP port is 5900+@var{d}. Optionally, @var{host} can 816be omitted in which case the server will accept connections from any host. 817 818@item unix:@var{path} 819 820Connections will be allowed over UNIX domain sockets where @var{path} is the 821location of a unix socket to listen for connections on. 822 823@item none 824 825VNC is initialized but not started. The monitor @code{change} command 826can be used to later start the VNC server. 827 828@end table 829 830Following the @var{display} value there may be one or more @var{option} flags 831separated by commas. Valid options are 832 833@table @option 834 835@item reverse 836 837Connect to a listening VNC client via a ``reverse'' connection. The 838client is specified by the @var{display}. For reverse network 839connections (@var{host}:@var{d},@code{reverse}), the @var{d} argument 840is a TCP port number, not a display number. 841 842@item password 843 844Require that password based authentication is used for client connections. 845The password must be set separately using the @code{change} command in the 846@ref{pcsys_monitor} 847 848@item tls 849 850Require that client use TLS when communicating with the VNC server. This 851uses anonymous TLS credentials so is susceptible to a man-in-the-middle 852attack. It is recommended that this option be combined with either the 853@option{x509} or @option{x509verify} options. 854 855@item x509=@var{/path/to/certificate/dir} 856 857Valid if @option{tls} is specified. Require that x509 credentials are used 858for negotiating the TLS session. The server will send its x509 certificate 859to the client. It is recommended that a password be set on the VNC server 860to provide authentication of the client when this is used. The path following 861this option specifies where the x509 certificates are to be loaded from. 862See the @ref{vnc_security} section for details on generating certificates. 863 864@item x509verify=@var{/path/to/certificate/dir} 865 866Valid if @option{tls} is specified. Require that x509 credentials are used 867for negotiating the TLS session. The server will send its x509 certificate 868to the client, and request that the client send its own x509 certificate. 869The server will validate the client's certificate against the CA certificate, 870and reject clients when validation fails. If the certificate authority is 871trusted, this is a sufficient authentication mechanism. You may still wish 872to set a password on the VNC server as a second authentication layer. The 873path following this option specifies where the x509 certificates are to 874be loaded from. See the @ref{vnc_security} section for details on generating 875certificates. 876 877@item sasl 878 879Require that the client use SASL to authenticate with the VNC server. 880The exact choice of authentication method used is controlled from the 881system / user's SASL configuration file for the 'qemu' service. This 882is typically found in /etc/sasl2/qemu.conf. If running QEMU as an 883unprivileged user, an environment variable SASL_CONF_PATH can be used 884to make it search alternate locations for the service config. 885While some SASL auth methods can also provide data encryption (eg GSSAPI), 886it is recommended that SASL always be combined with the 'tls' and 887'x509' settings to enable use of SSL and server certificates. This 888ensures a data encryption preventing compromise of authentication 889credentials. See the @ref{vnc_security} section for details on using 890SASL authentication. 891 892@item acl 893 894Turn on access control lists for checking of the x509 client certificate 895and SASL party. For x509 certs, the ACL check is made against the 896certificate's distinguished name. This is something that looks like 897@code{C=GB,O=ACME,L=Boston,CN=bob}. For SASL party, the ACL check is 898made against the username, which depending on the SASL plugin, may 899include a realm component, eg @code{bob} or @code{bob@@EXAMPLE.COM}. 900When the @option{acl} flag is set, the initial access list will be 901empty, with a @code{deny} policy. Thus no one will be allowed to 902use the VNC server until the ACLs have been loaded. This can be 903achieved using the @code{acl} monitor command. 904 905@item lossy 906 907Enable lossy compression methods (gradient, JPEG, ...). If this 908option is set, VNC client may receive lossy framebuffer updates 909depending on its encoding settings. Enabling this option can save 910a lot of bandwidth at the expense of quality. 911 912@end table 913ETEXI 914 915STEXI 916@end table 917ETEXI 918 919DEFHEADING() 920 921DEFHEADING(i386 target only:) 922STEXI 923@table @option 924ETEXI 925 926DEF("win2k-hack", 0, QEMU_OPTION_win2k_hack, 927 "-win2k-hack use it when installing Windows 2000 to avoid a disk full bug\n", 928 QEMU_ARCH_I386) 929STEXI 930@item -win2k-hack 931@findex -win2k-hack 932Use it when installing Windows 2000 to avoid a disk full bug. After 933Windows 2000 is installed, you no longer need this option (this option 934slows down the IDE transfers). 935ETEXI 936 937HXCOMM Deprecated by -rtc 938DEF("rtc-td-hack", 0, QEMU_OPTION_rtc_td_hack, "", QEMU_ARCH_I386) 939 940DEF("no-fd-bootchk", 0, QEMU_OPTION_no_fd_bootchk, 941 "-no-fd-bootchk disable boot signature checking for floppy disks\n", 942 QEMU_ARCH_I386) 943STEXI 944@item -no-fd-bootchk 945@findex -no-fd-bootchk 946Disable boot signature checking for floppy disks in Bochs BIOS. It may 947be needed to boot from old floppy disks. 948TODO: check reference to Bochs BIOS. 949ETEXI 950 951DEF("no-acpi", 0, QEMU_OPTION_no_acpi, 952 "-no-acpi disable ACPI\n", QEMU_ARCH_I386) 953STEXI 954@item -no-acpi 955@findex -no-acpi 956Disable ACPI (Advanced Configuration and Power Interface) support. Use 957it if your guest OS complains about ACPI problems (PC target machine 958only). 959ETEXI 960 961DEF("no-hpet", 0, QEMU_OPTION_no_hpet, 962 "-no-hpet disable HPET\n", QEMU_ARCH_I386) 963STEXI 964@item -no-hpet 965@findex -no-hpet 966Disable HPET support. 967ETEXI 968 969DEF("balloon", HAS_ARG, QEMU_OPTION_balloon, 970 "-balloon none disable balloon device\n" 971 "-balloon virtio[,addr=str]\n" 972 " enable virtio balloon device (default)\n", QEMU_ARCH_ALL) 973STEXI 974@item -balloon none 975@findex -balloon 976Disable balloon device. 977@item -balloon virtio[,addr=@var{addr}] 978Enable virtio balloon device (default), optionally with PCI address 979@var{addr}. 980ETEXI 981 982DEF("acpitable", HAS_ARG, QEMU_OPTION_acpitable, 983 "-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" 984 " ACPI table description\n", QEMU_ARCH_I386) 985STEXI 986@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}]...] 987@findex -acpitable 988Add ACPI table with specified header fields and context from specified files. 989ETEXI 990 991DEF("smbios", HAS_ARG, QEMU_OPTION_smbios, 992 "-smbios file=binary\n" 993 " load SMBIOS entry from binary file\n" 994 "-smbios type=0[,vendor=str][,version=str][,date=str][,release=%d.%d]\n" 995 " specify SMBIOS type 0 fields\n" 996 "-smbios type=1[,manufacturer=str][,product=str][,version=str][,serial=str]\n" 997 " [,uuid=uuid][,sku=str][,family=str]\n" 998 " specify SMBIOS type 1 fields\n", QEMU_ARCH_I386) 999STEXI 1000@item -smbios file=@var{binary} 1001@findex -smbios 1002Load SMBIOS entry from binary file. 1003 1004@item -smbios type=0[,vendor=@var{str}][,version=@var{str}][,date=@var{str}][,release=@var{%d.%d}] 1005@findex -smbios 1006Specify SMBIOS type 0 fields 1007 1008@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}] 1009Specify SMBIOS type 1 fields 1010ETEXI 1011 1012DEFHEADING() 1013STEXI 1014@end table 1015ETEXI 1016 1017DEFHEADING(Network options:) 1018STEXI 1019@table @option 1020ETEXI 1021 1022HXCOMM Legacy slirp options (now moved to -net user): 1023#ifdef CONFIG_SLIRP 1024DEF("tftp", HAS_ARG, QEMU_OPTION_tftp, "", QEMU_ARCH_ALL) 1025DEF("bootp", HAS_ARG, QEMU_OPTION_bootp, "", QEMU_ARCH_ALL) 1026DEF("redir", HAS_ARG, QEMU_OPTION_redir, "", QEMU_ARCH_ALL) 1027#ifndef _WIN32 1028DEF("smb", HAS_ARG, QEMU_OPTION_smb, "", QEMU_ARCH_ALL) 1029#endif 1030#endif 1031 1032DEF("net", HAS_ARG, QEMU_OPTION_net, 1033 "-net nic[,vlan=n][,macaddr=mac][,model=type][,name=str][,addr=str][,vectors=v]\n" 1034 " create a new Network Interface Card and connect it to VLAN 'n'\n" 1035#ifdef CONFIG_SLIRP 1036 "-net user[,vlan=n][,name=str][,net=addr[/mask]][,host=addr][,restrict=y|n]\n" 1037 " [,hostname=host][,dhcpstart=addr][,dns=addr][,tftp=dir][,bootfile=f]\n" 1038 " [,hostfwd=rule][,guestfwd=rule]" 1039#ifndef _WIN32 1040 "[,smb=dir[,smbserver=addr]]\n" 1041#endif 1042 " connect the user mode network stack to VLAN 'n', configure its\n" 1043 " DHCP server and enabled optional services\n" 1044#endif 1045#ifdef _WIN32 1046 "-net tap[,vlan=n][,name=str],ifname=name\n" 1047 " connect the host TAP network interface to VLAN 'n'\n" 1048#else 1049 "-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]\n" 1050 " connect the host TAP network interface to VLAN 'n' and use the\n" 1051 " network scripts 'file' (default=" DEFAULT_NETWORK_SCRIPT ")\n" 1052 " and 'dfile' (default=" DEFAULT_NETWORK_DOWN_SCRIPT ")\n" 1053 " use '[down]script=no' to disable script execution\n" 1054 " use 'fd=h' to connect to an already opened TAP interface\n" 1055 " use 'sndbuf=nbytes' to limit the size of the send buffer (the\n" 1056 " default of 'sndbuf=1048576' can be disabled using 'sndbuf=0')\n" 1057 " use vnet_hdr=off to avoid enabling the IFF_VNET_HDR tap flag\n" 1058 " use vnet_hdr=on to make the lack of IFF_VNET_HDR support an error condition\n" 1059 " use vhost=on to enable experimental in kernel accelerator\n" 1060 " use 'vhostfd=h' to connect to an already opened vhost net device\n" 1061#endif 1062 "-net socket[,vlan=n][,name=str][,fd=h][,listen=[host]:port][,connect=host:port]\n" 1063 " connect the vlan 'n' to another VLAN using a socket connection\n" 1064 "-net socket[,vlan=n][,name=str][,fd=h][,mcast=maddr:port[,localaddr=addr]]\n" 1065 " connect the vlan 'n' to multicast maddr and port\n" 1066 " use 'localaddr=addr' to specify the host address to send packets from\n" 1067#ifdef CONFIG_VDE 1068 "-net vde[,vlan=n][,name=str][,sock=socketpath][,port=n][,group=groupname][,mode=octalmode]\n" 1069 " connect the vlan 'n' to port 'n' of a vde switch running\n" 1070 " on host and listening for incoming connections on 'socketpath'.\n" 1071 " Use group 'groupname' and mode 'octalmode' to change default\n" 1072 " ownership and permissions for communication port.\n" 1073#endif 1074 "-net dump[,vlan=n][,file=f][,len=n]\n" 1075 " dump traffic on vlan 'n' to file 'f' (max n bytes per packet)\n" 1076 "-net none use it alone to have zero network devices. If no -net option\n" 1077 " is provided, the default is '-net nic -net user'\n", QEMU_ARCH_ALL) 1078DEF("netdev", HAS_ARG, QEMU_OPTION_netdev, 1079 "-netdev [" 1080#ifdef CONFIG_SLIRP 1081 "user|" 1082#endif 1083 "tap|" 1084#ifdef CONFIG_VDE 1085 "vde|" 1086#endif 1087 "socket],id=str[,option][,option][,...]\n", QEMU_ARCH_ALL) 1088STEXI 1089@item -net nic[,vlan=@var{n}][,macaddr=@var{mac}][,model=@var{type}] [,name=@var{name}][,addr=@var{addr}][,vectors=@var{v}] 1090@findex -net 1091Create a new Network Interface Card and connect it to VLAN @var{n} (@var{n} 1092= 0 is the default). The NIC is an e1000 by default on the PC 1093target. Optionally, the MAC address can be changed to @var{mac}, the 1094device address set to @var{addr} (PCI cards only), 1095and a @var{name} can be assigned for use in monitor commands. 1096Optionally, for PCI cards, you can specify the number @var{v} of MSI-X vectors 1097that the card should have; this option currently only affects virtio cards; set 1098@var{v} = 0 to disable MSI-X. If no @option{-net} option is specified, a single 1099NIC is created. Qemu can emulate several different models of network card. 1100Valid values for @var{type} are 1101@code{virtio}, @code{i82551}, @code{i82557b}, @code{i82559er}, 1102@code{ne2k_pci}, @code{ne2k_isa}, @code{pcnet}, @code{rtl8139}, 1103@code{e1000}, @code{smc91c111}, @code{lance} and @code{mcf_fec}. 1104Not all devices are supported on all targets. Use -net nic,model=? 1105for a list of available devices for your target. 1106 1107@item -net user[,@var{option}][,@var{option}][,...] 1108Use the user mode network stack which requires no administrator 1109privilege to run. Valid options are: 1110 1111@table @option 1112@item vlan=@var{n} 1113Connect user mode stack to VLAN @var{n} (@var{n} = 0 is the default). 1114 1115@item name=@var{name} 1116Assign symbolic name for use in monitor commands. 1117 1118@item net=@var{addr}[/@var{mask}] 1119Set IP network address the guest will see. Optionally specify the netmask, 1120either in the form a.b.c.d or as number of valid top-most bits. Default is 112110.0.2.0/8. 1122 1123@item host=@var{addr} 1124Specify the guest-visible address of the host. Default is the 2nd IP in the 1125guest network, i.e. x.x.x.2. 1126 1127@item restrict=y|yes|n|no 1128If this options is enabled, the guest will be isolated, i.e. it will not be 1129able to contact the host and no guest IP packets will be routed over the host 1130to the outside. This option does not affect explicitly set forwarding rule. 1131 1132@item hostname=@var{name} 1133Specifies the client hostname reported by the builtin DHCP server. 1134 1135@item dhcpstart=@var{addr} 1136Specify the first of the 16 IPs the built-in DHCP server can assign. Default 1137is the 16th to 31st IP in the guest network, i.e. x.x.x.16 to x.x.x.31. 1138 1139@item dns=@var{addr} 1140Specify the guest-visible address of the virtual nameserver. The address must 1141be different from the host address. Default is the 3rd IP in the guest network, 1142i.e. x.x.x.3. 1143 1144@item tftp=@var{dir} 1145When using the user mode network stack, activate a built-in TFTP 1146server. The files in @var{dir} will be exposed as the root of a TFTP server. 1147The TFTP client on the guest must be configured in binary mode (use the command 1148@code{bin} of the Unix TFTP client). 1149 1150@item bootfile=@var{file} 1151When using the user mode network stack, broadcast @var{file} as the BOOTP 1152filename. In conjunction with @option{tftp}, this can be used to network boot 1153a guest from a local directory. 1154 1155Example (using pxelinux): 1156@example 1157qemu -hda linux.img -boot n -net user,tftp=/path/to/tftp/files,bootfile=/pxelinux.0 1158@end example 1159 1160@item smb=@var{dir}[,smbserver=@var{addr}] 1161When using the user mode network stack, activate a built-in SMB 1162server so that Windows OSes can access to the host files in @file{@var{dir}} 1163transparently. The IP address of the SMB server can be set to @var{addr}. By 1164default the 4th IP in the guest network is used, i.e. x.x.x.4. 1165 1166In the guest Windows OS, the line: 1167@example 116810.0.2.4 smbserver 1169@end example 1170must be added in the file @file{C:\WINDOWS\LMHOSTS} (for windows 9x/Me) 1171or @file{C:\WINNT\SYSTEM32\DRIVERS\ETC\LMHOSTS} (Windows NT/2000). 1172 1173Then @file{@var{dir}} can be accessed in @file{\\smbserver\qemu}. 1174 1175Note that a SAMBA server must be installed on the host OS in 1176@file{/usr/sbin/smbd}. QEMU was tested successfully with smbd versions from 1177Red Hat 9, Fedora Core 3 and OpenSUSE 11.x. 1178 1179@item hostfwd=[tcp|udp]:[@var{hostaddr}]:@var{hostport}-[@var{guestaddr}]:@var{guestport} 1180Redirect incoming TCP or UDP connections to the host port @var{hostport} to 1181the guest IP address @var{guestaddr} on guest port @var{guestport}. If 1182@var{guestaddr} is not specified, its value is x.x.x.15 (default first address 1183given by the built-in DHCP server). By specifying @var{hostaddr}, the rule can 1184be bound to a specific host interface. If no connection type is set, TCP is 1185used. This option can be given multiple times. 1186 1187For example, to redirect host X11 connection from screen 1 to guest 1188screen 0, use the following: 1189 1190@example 1191# on the host 1192qemu -net user,hostfwd=tcp:127.0.0.1:6001-:6000 [...] 1193# this host xterm should open in the guest X11 server 1194xterm -display :1 1195@end example 1196 1197To redirect telnet connections from host port 5555 to telnet port on 1198the guest, use the following: 1199 1200@example 1201# on the host 1202qemu -net user,hostfwd=tcp::5555-:23 [...] 1203telnet localhost 5555 1204@end example 1205 1206Then when you use on the host @code{telnet localhost 5555}, you 1207connect to the guest telnet server. 1208 1209@item guestfwd=[tcp]:@var{server}:@var{port}-@var{dev} 1210Forward guest TCP connections to the IP address @var{server} on port @var{port} 1211to the character device @var{dev}. This option can be given multiple times. 1212 1213@end table 1214 1215Note: Legacy stand-alone options -tftp, -bootp, -smb and -redir are still 1216processed and applied to -net user. Mixing them with the new configuration 1217syntax gives undefined results. Their use for new applications is discouraged 1218as they will be removed from future versions. 1219 1220@item -net tap[,vlan=@var{n}][,name=@var{name}][,fd=@var{h}][,ifname=@var{name}] [,script=@var{file}][,downscript=@var{dfile}] 1221Connect the host TAP network interface @var{name} to VLAN @var{n}, use 1222the network script @var{file} to configure it and the network script 1223@var{dfile} to deconfigure it. If @var{name} is not provided, the OS 1224automatically provides one. @option{fd}=@var{h} can be used to specify 1225the handle of an already opened host TAP interface. The default network 1226configure script is @file{/etc/qemu-ifup} and the default network 1227deconfigure script is @file{/etc/qemu-ifdown}. Use @option{script=no} 1228or @option{downscript=no} to disable script execution. Example: 1229 1230@example 1231qemu linux.img -net nic -net tap 1232@end example 1233 1234More complicated example (two NICs, each one connected to a TAP device) 1235@example 1236qemu linux.img -net nic,vlan=0 -net tap,vlan=0,ifname=tap0 \ 1237 -net nic,vlan=1 -net tap,vlan=1,ifname=tap1 1238@end example 1239 1240@item -net socket[,vlan=@var{n}][,name=@var{name}][,fd=@var{h}] [,listen=[@var{host}]:@var{port}][,connect=@var{host}:@var{port}] 1241 1242Connect the VLAN @var{n} to a remote VLAN in another QEMU virtual 1243machine using a TCP socket connection. If @option{listen} is 1244specified, QEMU waits for incoming connections on @var{port} 1245(@var{host} is optional). @option{connect} is used to connect to 1246another QEMU instance using the @option{listen} option. @option{fd}=@var{h} 1247specifies an already opened TCP socket. 1248 1249Example: 1250@example 1251# launch a first QEMU instance 1252qemu linux.img -net nic,macaddr=52:54:00:12:34:56 \ 1253 -net socket,listen=:1234 1254# connect the VLAN 0 of this instance to the VLAN 0 1255# of the first instance 1256qemu linux.img -net nic,macaddr=52:54:00:12:34:57 \ 1257 -net socket,connect=127.0.0.1:1234 1258@end example 1259 1260@item -net socket[,vlan=@var{n}][,name=@var{name}][,fd=@var{h}][,mcast=@var{maddr}:@var{port}[,localaddr=@var{addr}]] 1261 1262Create a VLAN @var{n} shared with another QEMU virtual 1263machines using a UDP multicast socket, effectively making a bus for 1264every QEMU with same multicast address @var{maddr} and @var{port}. 1265NOTES: 1266@enumerate 1267@item 1268Several QEMU can be running on different hosts and share same bus (assuming 1269correct multicast setup for these hosts). 1270@item 1271mcast support is compatible with User Mode Linux (argument @option{eth@var{N}=mcast}), see 1272@url{http://user-mode-linux.sf.net}. 1273@item 1274Use @option{fd=h} to specify an already opened UDP multicast socket. 1275@end enumerate 1276 1277Example: 1278@example 1279# launch one QEMU instance 1280qemu linux.img -net nic,macaddr=52:54:00:12:34:56 \ 1281 -net socket,mcast=230.0.0.1:1234 1282# launch another QEMU instance on same "bus" 1283qemu linux.img -net nic,macaddr=52:54:00:12:34:57 \ 1284 -net socket,mcast=230.0.0.1:1234 1285# launch yet another QEMU instance on same "bus" 1286qemu linux.img -net nic,macaddr=52:54:00:12:34:58 \ 1287 -net socket,mcast=230.0.0.1:1234 1288@end example 1289 1290Example (User Mode Linux compat.): 1291@example 1292# launch QEMU instance (note mcast address selected 1293# is UML's default) 1294qemu linux.img -net nic,macaddr=52:54:00:12:34:56 \ 1295 -net socket,mcast=239.192.168.1:1102 1296# launch UML 1297/path/to/linux ubd0=/path/to/root_fs eth0=mcast 1298@end example 1299 1300Example (send packets from host's 1.2.3.4): 1301@example 1302qemu linux.img -net nic,macaddr=52:54:00:12:34:56 \ 1303 -net socket,mcast=239.192.168.1:1102,localaddr=1.2.3.4 1304@end example 1305 1306@item -net vde[,vlan=@var{n}][,name=@var{name}][,sock=@var{socketpath}] [,port=@var{n}][,group=@var{groupname}][,mode=@var{octalmode}] 1307Connect VLAN @var{n} to PORT @var{n} of a vde switch running on host and 1308listening for incoming connections on @var{socketpath}. Use GROUP @var{groupname} 1309and MODE @var{octalmode} to change default ownership and permissions for 1310communication port. This option is available only if QEMU has been compiled 1311with vde support enabled. 1312 1313Example: 1314@example 1315# launch vde switch 1316vde_switch -F -sock /tmp/myswitch 1317# launch QEMU instance 1318qemu linux.img -net nic -net vde,sock=/tmp/myswitch 1319@end example 1320 1321@item -net dump[,vlan=@var{n}][,file=@var{file}][,len=@var{len}] 1322Dump network traffic on VLAN @var{n} to file @var{file} (@file{qemu-vlan0.pcap} by default). 1323At most @var{len} bytes (64k by default) per packet are stored. The file format is 1324libpcap, so it can be analyzed with tools such as tcpdump or Wireshark. 1325 1326@item -net none 1327Indicate that no network devices should be configured. It is used to 1328override the default configuration (@option{-net nic -net user}) which 1329is activated if no @option{-net} options are provided. 1330 1331@end table 1332ETEXI 1333 1334DEFHEADING() 1335 1336DEFHEADING(Character device options:) 1337 1338DEF("chardev", HAS_ARG, QEMU_OPTION_chardev, 1339 "-chardev null,id=id[,mux=on|off]\n" 1340 "-chardev socket,id=id[,host=host],port=host[,to=to][,ipv4][,ipv6][,nodelay]\n" 1341 " [,server][,nowait][,telnet][,mux=on|off] (tcp)\n" 1342 "-chardev socket,id=id,path=path[,server][,nowait][,telnet],[mux=on|off] (unix)\n" 1343 "-chardev udp,id=id[,host=host],port=port[,localaddr=localaddr]\n" 1344 " [,localport=localport][,ipv4][,ipv6][,mux=on|off]\n" 1345 "-chardev msmouse,id=id[,mux=on|off]\n" 1346 "-chardev vc,id=id[[,width=width][,height=height]][[,cols=cols][,rows=rows]]\n" 1347 " [,mux=on|off]\n" 1348 "-chardev file,id=id,path=path[,mux=on|off]\n" 1349 "-chardev pipe,id=id,path=path[,mux=on|off]\n" 1350#ifdef _WIN32 1351 "-chardev console,id=id[,mux=on|off]\n" 1352 "-chardev serial,id=id,path=path[,mux=on|off]\n" 1353#else 1354 "-chardev pty,id=id[,mux=on|off]\n" 1355 "-chardev stdio,id=id[,mux=on|off][,signal=on|off]\n" 1356#endif 1357#ifdef CONFIG_BRLAPI 1358 "-chardev braille,id=id[,mux=on|off]\n" 1359#endif 1360#if defined(__linux__) || defined(__sun__) || defined(__FreeBSD__) \ 1361 || defined(__NetBSD__) || defined(__OpenBSD__) || defined(__DragonFly__) 1362 "-chardev tty,id=id,path=path[,mux=on|off]\n" 1363#endif 1364#if defined(__linux__) || defined(__FreeBSD__) || defined(__DragonFly__) 1365 "-chardev parport,id=id,path=path[,mux=on|off]\n" 1366#endif 1367 , QEMU_ARCH_ALL 1368) 1369 1370STEXI 1371 1372The general form of a character device option is: 1373@table @option 1374 1375@item -chardev @var{backend} ,id=@var{id} [,mux=on|off] [,@var{options}] 1376@findex -chardev 1377Backend is one of: 1378@option{null}, 1379@option{socket}, 1380@option{udp}, 1381@option{msmouse}, 1382@option{vc}, 1383@option{file}, 1384@option{pipe}, 1385@option{console}, 1386@option{serial}, 1387@option{pty}, 1388@option{stdio}, 1389@option{braille}, 1390@option{tty}, 1391@option{parport}. 1392The specific backend will determine the applicable options. 1393 1394All devices must have an id, which can be any string up to 127 characters long. 1395It is used to uniquely identify this device in other command line directives. 1396 1397A character device may be used in multiplexing mode by multiple front-ends. 1398The key sequence of @key{Control-a} and @key{c} will rotate the input focus 1399between attached front-ends. Specify @option{mux=on} to enable this mode. 1400 1401Options to each backend are described below. 1402 1403@item -chardev null ,id=@var{id} 1404A void device. This device will not emit any data, and will drop any data it 1405receives. The null backend does not take any options. 1406 1407@item -chardev socket ,id=@var{id} [@var{TCP options} or @var{unix options}] [,server] [,nowait] [,telnet] 1408 1409Create a two-way stream socket, which can be either a TCP or a unix socket. A 1410unix socket will be created if @option{path} is specified. Behaviour is 1411undefined if TCP options are specified for a unix socket. 1412 1413@option{server} specifies that the socket shall be a listening socket. 1414 1415@option{nowait} specifies that QEMU should not block waiting for a client to 1416connect to a listening socket. 1417 1418@option{telnet} specifies that traffic on the socket should interpret telnet 1419escape sequences. 1420 1421TCP and unix socket options are given below: 1422 1423@table @option 1424 1425@item TCP options: port=@var{port} [,host=@var{host}] [,to=@var{to}] [,ipv4] [,ipv6] [,nodelay] 1426 1427@option{host} for a listening socket specifies the local address to be bound. 1428For a connecting socket species the remote host to connect to. @option{host} is 1429optional for listening sockets. If not specified it defaults to @code{0.0.0.0}. 1430 1431@option{port} for a listening socket specifies the local port to be bound. For a 1432connecting socket specifies the port on the remote host to connect to. 1433@option{port} can be given as either a port number or a service name. 1434@option{port} is required. 1435 1436@option{to} is only relevant to listening sockets. If it is specified, and 1437@option{port} cannot be bound, QEMU will attempt to bind to subsequent ports up 1438to and including @option{to} until it succeeds. @option{to} must be specified 1439as a port number. 1440 1441@option{ipv4} and @option{ipv6} specify that either IPv4 or IPv6 must be used. 1442If neither is specified the socket may use either protocol. 1443 1444@option{nodelay} disables the Nagle algorithm. 1445 1446@item unix options: path=@var{path} 1447 1448@option{path} specifies the local path of the unix socket. @option{path} is 1449required. 1450 1451@end table 1452 1453@item -chardev udp ,id=@var{id} [,host=@var{host}] ,port=@var{port} [,localaddr=@var{localaddr}] [,localport=@var{localport}] [,ipv4] [,ipv6] 1454 1455Sends all traffic from the guest to a remote host over UDP. 1456 1457@option{host} specifies the remote host to connect to. If not specified it 1458defaults to @code{localhost}. 1459 1460@option{port} specifies the port on the remote host to connect to. @option{port} 1461is required. 1462 1463@option{localaddr} specifies the local address to bind to. If not specified it 1464defaults to @code{0.0.0.0}. 1465 1466@option{localport} specifies the local port to bind to. If not specified any 1467available local port will be used. 1468 1469@option{ipv4} and @option{ipv6} specify that either IPv4 or IPv6 must be used. 1470If neither is specified the device may use either protocol. 1471 1472@item -chardev msmouse ,id=@var{id} 1473 1474Forward QEMU's emulated msmouse events to the guest. @option{msmouse} does not 1475take any options. 1476 1477@item -chardev vc ,id=@var{id} [[,width=@var{width}] [,height=@var{height}]] [[,cols=@var{cols}] [,rows=@var{rows}]] 1478 1479Connect to a QEMU text console. @option{vc} may optionally be given a specific 1480size. 1481 1482@option{width} and @option{height} specify the width and height respectively of 1483the console, in pixels. 1484 1485@option{cols} and @option{rows} specify that the console be sized to fit a text 1486console with the given dimensions. 1487 1488@item -chardev file ,id=@var{id} ,path=@var{path} 1489 1490Log all traffic received from the guest to a file. 1491 1492@option{path} specifies the path of the file to be opened. This file will be 1493created if it does not already exist, and overwritten if it does. @option{path} 1494is required. 1495 1496@item -chardev pipe ,id=@var{id} ,path=@var{path} 1497 1498Create a two-way connection to the guest. The behaviour differs slightly between 1499Windows hosts and other hosts: 1500 1501On Windows, a single duplex pipe will be created at 1502@file{\\.pipe\@option{path}}. 1503 1504On other hosts, 2 pipes will be created called @file{@option{path}.in} and 1505@file{@option{path}.out}. Data written to @file{@option{path}.in} will be 1506received by the guest. Data written by the guest can be read from 1507@file{@option{path}.out}. QEMU will not create these fifos, and requires them to 1508be present. 1509 1510@option{path} forms part of the pipe path as described above. @option{path} is 1511required. 1512 1513@item -chardev console ,id=@var{id} 1514 1515Send traffic from the guest to QEMU's standard output. @option{console} does not 1516take any options. 1517 1518@option{console} is only available on Windows hosts. 1519 1520@item -chardev serial ,id=@var{id} ,path=@option{path} 1521 1522Send traffic from the guest to a serial device on the host. 1523 1524@option{serial} is 1525only available on Windows hosts. 1526 1527@option{path} specifies the name of the serial device to open. 1528 1529@item -chardev pty ,id=@var{id} 1530 1531Create a new pseudo-terminal on the host and connect to it. @option{pty} does 1532not take any options. 1533 1534@option{pty} is not available on Windows hosts. 1535 1536@item -chardev stdio ,id=@var{id} [,signal=on|off] 1537Connect to standard input and standard output of the qemu process. 1538 1539@option{signal} controls if signals are enabled on the terminal, that includes 1540exiting QEMU with the key sequence @key{Control-c}. This option is enabled by 1541default, use @option{signal=off} to disable it. 1542 1543@option{stdio} is not available on Windows hosts. 1544 1545@item -chardev braille ,id=@var{id} 1546 1547Connect to a local BrlAPI server. @option{braille} does not take any options. 1548 1549@item -chardev tty ,id=@var{id} ,path=@var{path} 1550 1551Connect to a local tty device. 1552 1553@option{tty} is only available on Linux, Sun, FreeBSD, NetBSD, OpenBSD and 1554DragonFlyBSD hosts. 1555 1556@option{path} specifies the path to the tty. @option{path} is required. 1557 1558@item -chardev parport ,id=@var{id} ,path=@var{path} 1559 1560@option{parport} is only available on Linux, FreeBSD and DragonFlyBSD hosts. 1561 1562Connect to a local parallel port. 1563 1564@option{path} specifies the path to the parallel port device. @option{path} is 1565required. 1566 1567@end table 1568ETEXI 1569 1570DEFHEADING() 1571 1572DEFHEADING(Bluetooth(R) options:) 1573 1574DEF("bt", HAS_ARG, QEMU_OPTION_bt, \ 1575 "-bt hci,null dumb bluetooth HCI - doesn't respond to commands\n" \ 1576 "-bt hci,host[:id]\n" \ 1577 " use host's HCI with the given name\n" \ 1578 "-bt hci[,vlan=n]\n" \ 1579 " emulate a standard HCI in virtual scatternet 'n'\n" \ 1580 "-bt vhci[,vlan=n]\n" \ 1581 " add host computer to virtual scatternet 'n' using VHCI\n" \ 1582 "-bt device:dev[,vlan=n]\n" \ 1583 " emulate a bluetooth device 'dev' in scatternet 'n'\n", 1584 QEMU_ARCH_ALL) 1585STEXI 1586@table @option 1587 1588@item -bt hci[...] 1589@findex -bt 1590Defines the function of the corresponding Bluetooth HCI. -bt options 1591are matched with the HCIs present in the chosen machine type. For 1592example when emulating a machine with only one HCI built into it, only 1593the first @code{-bt hci[...]} option is valid and defines the HCI's 1594logic. The Transport Layer is decided by the machine type. Currently 1595the machines @code{n800} and @code{n810} have one HCI and all other 1596machines have none. 1597 1598@anchor{bt-hcis} 1599The following three types are recognized: 1600 1601@table @option 1602@item -bt hci,null 1603(default) The corresponding Bluetooth HCI assumes no internal logic 1604and will not respond to any HCI commands or emit events. 1605 1606@item -bt hci,host[:@var{id}] 1607(@code{bluez} only) The corresponding HCI passes commands / events 1608to / from the physical HCI identified by the name @var{id} (default: 1609@code{hci0}) on the computer running QEMU. Only available on @code{bluez} 1610capable systems like Linux. 1611 1612@item -bt hci[,vlan=@var{n}] 1613Add a virtual, standard HCI that will participate in the Bluetooth 1614scatternet @var{n} (default @code{0}). Similarly to @option{-net} 1615VLANs, devices inside a bluetooth network @var{n} can only communicate 1616with other devices in the same network (scatternet). 1617@end table 1618 1619@item -bt vhci[,vlan=@var{n}] 1620(Linux-host only) Create a HCI in scatternet @var{n} (default 0) attached 1621to the host bluetooth stack instead of to the emulated target. This 1622allows the host and target machines to participate in a common scatternet 1623and communicate. Requires the Linux @code{vhci} driver installed. Can 1624be used as following: 1625 1626@example 1627qemu [...OPTIONS...] -bt hci,vlan=5 -bt vhci,vlan=5 1628@end example 1629 1630@item -bt device:@var{dev}[,vlan=@var{n}] 1631Emulate a bluetooth device @var{dev} and place it in network @var{n} 1632(default @code{0}). QEMU can only emulate one type of bluetooth devices 1633currently: 1634 1635@table @option 1636@item keyboard 1637Virtual wireless keyboard implementing the HIDP bluetooth profile. 1638@end table 1639@end table 1640ETEXI 1641 1642DEFHEADING() 1643 1644DEFHEADING(Linux/Multiboot boot specific:) 1645STEXI 1646 1647When using these options, you can use a given Linux or Multiboot 1648kernel without installing it in the disk image. It can be useful 1649for easier testing of various kernels. 1650 1651@table @option 1652ETEXI 1653 1654DEF("kernel", HAS_ARG, QEMU_OPTION_kernel, \ 1655 "-kernel bzImage use 'bzImage' as kernel image\n", QEMU_ARCH_ALL) 1656STEXI 1657@item -kernel @var{bzImage} 1658@findex -kernel 1659Use @var{bzImage} as kernel image. The kernel can be either a Linux kernel 1660or in multiboot format. 1661ETEXI 1662 1663DEF("append", HAS_ARG, QEMU_OPTION_append, \ 1664 "-append cmdline use 'cmdline' as kernel command line\n", QEMU_ARCH_ALL) 1665STEXI 1666@item -append @var{cmdline} 1667@findex -append 1668Use @var{cmdline} as kernel command line 1669ETEXI 1670 1671DEF("initrd", HAS_ARG, QEMU_OPTION_initrd, \ 1672 "-initrd file use 'file' as initial ram disk\n", QEMU_ARCH_ALL) 1673STEXI 1674@item -initrd @var{file} 1675@findex -initrd 1676Use @var{file} as initial ram disk. 1677 1678@item -initrd "@var{file1} arg=foo,@var{file2}" 1679 1680This syntax is only available with multiboot. 1681 1682Use @var{file1} and @var{file2} as modules and pass arg=foo as parameter to the 1683first module. 1684ETEXI 1685 1686STEXI 1687@end table 1688ETEXI 1689 1690DEFHEADING() 1691 1692DEFHEADING(Debug/Expert options:) 1693 1694STEXI 1695@table @option 1696ETEXI 1697 1698DEF("serial", HAS_ARG, QEMU_OPTION_serial, \ 1699 "-serial dev redirect the serial port to char device 'dev'\n", 1700 QEMU_ARCH_ALL) 1701STEXI 1702@item -serial @var{dev} 1703@findex -serial 1704Redirect the virtual serial port to host character device 1705@var{dev}. The default device is @code{vc} in graphical mode and 1706@code{stdio} in non graphical mode. 1707 1708This option can be used several times to simulate up to 4 serial 1709ports. 1710 1711Use @code{-serial none} to disable all serial ports. 1712 1713Available character devices are: 1714@table @option 1715@item vc[:@var{W}x@var{H}] 1716Virtual console. Optionally, a width and height can be given in pixel with 1717@example 1718vc:800x600 1719@end example 1720It is also possible to specify width or height in characters: 1721@example 1722vc:80Cx24C 1723@end example 1724@item pty 1725[Linux only] Pseudo TTY (a new PTY is automatically allocated) 1726@item none 1727No device is allocated. 1728@item null 1729void device 1730@item /dev/XXX 1731[Linux only] Use host tty, e.g. @file{/dev/ttyS0}. The host serial port 1732parameters are set according to the emulated ones. 1733@item /dev/parport@var{N} 1734[Linux only, parallel port only] Use host parallel port 1735@var{N}. Currently SPP and EPP parallel port features can be used. 1736@item file:@var{filename} 1737Write output to @var{filename}. No character can be read. 1738@item stdio 1739[Unix only] standard input/output 1740@item pipe:@var{filename} 1741name pipe @var{filename} 1742@item COM@var{n} 1743[Windows only] Use host serial port @var{n} 1744@item udp:[@var{remote_host}]:@var{remote_port}[@@[@var{src_ip}]:@var{src_port}] 1745This implements UDP Net Console. 1746When @var{remote_host} or @var{src_ip} are not specified 1747they default to @code{0.0.0.0}. 1748When not using a specified @var{src_port} a random port is automatically chosen. 1749 1750If you just want a simple readonly console you can use @code{netcat} or 1751@code{nc}, by starting qemu with: @code{-serial udp::4555} and nc as: 1752@code{nc -u -l -p 4555}. Any time qemu writes something to that port it 1753will appear in the netconsole session. 1754 1755If you plan to send characters back via netconsole or you want to stop 1756and start qemu a lot of times, you should have qemu use the same 1757source port each time by using something like @code{-serial 1758udp::4555@@:4556} to qemu. Another approach is to use a patched 1759version of netcat which can listen to a TCP port and send and receive 1760characters via udp. If you have a patched version of netcat which 1761activates telnet remote echo and single char transfer, then you can 1762use the following options to step up a netcat redirector to allow 1763telnet on port 5555 to access the qemu port. 1764@table @code 1765@item Qemu Options: 1766-serial udp::4555@@:4556 1767@item netcat options: 1768-u -P 4555 -L 0.0.0.0:4556 -t -p 5555 -I -T 1769@item telnet options: 1770localhost 5555 1771@end table 1772 1773@item tcp:[@var{host}]:@var{port}[,@var{server}][,nowait][,nodelay] 1774The TCP Net Console has two modes of operation. It can send the serial 1775I/O to a location or wait for a connection from a location. By default 1776the TCP Net Console is sent to @var{host} at the @var{port}. If you use 1777the @var{server} option QEMU will wait for a client socket application 1778to connect to the port before continuing, unless the @code{nowait} 1779option was specified. The @code{nodelay} option disables the Nagle buffering 1780algorithm. If @var{host} is omitted, 0.0.0.0 is assumed. Only 1781one TCP connection at a time is accepted. You can use @code{telnet} to 1782connect to the corresponding character device. 1783@table @code 1784@item Example to send tcp console to 192.168.0.2 port 4444 1785-serial tcp:192.168.0.2:4444 1786@item Example to listen and wait on port 4444 for connection 1787-serial tcp::4444,server 1788@item Example to not wait and listen on ip 192.168.0.100 port 4444 1789-serial tcp:192.168.0.100:4444,server,nowait 1790@end table 1791 1792@item telnet:@var{host}:@var{port}[,server][,nowait][,nodelay] 1793The telnet protocol is used instead of raw tcp sockets. The options 1794work the same as if you had specified @code{-serial tcp}. The 1795difference is that the port acts like a telnet server or client using 1796telnet option negotiation. This will also allow you to send the 1797MAGIC_SYSRQ sequence if you use a telnet that supports sending the break 1798sequence. Typically in unix telnet you do it with Control-] and then 1799type "send break" followed by pressing the enter key. 1800 1801@item unix:@var{path}[,server][,nowait] 1802A unix domain socket is used instead of a tcp socket. The option works the 1803same as if you had specified @code{-serial tcp} except the unix domain socket 1804@var{path} is used for connections. 1805 1806@item mon:@var{dev_string} 1807This is a special option to allow the monitor to be multiplexed onto 1808another serial port. The monitor is accessed with key sequence of 1809@key{Control-a} and then pressing @key{c}. See monitor access 1810@ref{pcsys_keys} in the -nographic section for more keys. 1811@var{dev_string} should be any one of the serial devices specified 1812above. An example to multiplex the monitor onto a telnet server 1813listening on port 4444 would be: 1814@table @code 1815@item -serial mon:telnet::4444,server,nowait 1816@end table 1817 1818@item braille 1819Braille device. This will use BrlAPI to display the braille output on a real 1820or fake device. 1821 1822@item msmouse 1823Three button serial mouse. Configure the guest to use Microsoft protocol. 1824@end table 1825ETEXI 1826 1827DEF("parallel", HAS_ARG, QEMU_OPTION_parallel, \ 1828 "-parallel dev redirect the parallel port to char device 'dev'\n", 1829 QEMU_ARCH_ALL) 1830STEXI 1831@item -parallel @var{dev} 1832@findex -parallel 1833Redirect the virtual parallel port to host device @var{dev} (same 1834devices as the serial port). On Linux hosts, @file{/dev/parportN} can 1835be used to use hardware devices connected on the corresponding host 1836parallel port. 1837 1838This option can be used several times to simulate up to 3 parallel 1839ports. 1840 1841Use @code{-parallel none} to disable all parallel ports. 1842ETEXI 1843 1844DEF("monitor", HAS_ARG, QEMU_OPTION_monitor, \ 1845 "-monitor dev redirect the monitor to char device 'dev'\n", 1846 QEMU_ARCH_ALL) 1847STEXI 1848@item -monitor @var{dev} 1849@findex -monitor 1850Redirect the monitor to host device @var{dev} (same devices as the 1851serial port). 1852The default device is @code{vc} in graphical mode and @code{stdio} in 1853non graphical mode. 1854ETEXI 1855DEF("qmp", HAS_ARG, QEMU_OPTION_qmp, \ 1856 "-qmp dev like -monitor but opens in 'control' mode\n", 1857 QEMU_ARCH_ALL) 1858STEXI 1859@item -qmp @var{dev} 1860@findex -qmp 1861Like -monitor but opens in 'control' mode. 1862ETEXI 1863 1864DEF("mon", HAS_ARG, QEMU_OPTION_mon, \ 1865 "-mon chardev=[name][,mode=readline|control][,default]\n", QEMU_ARCH_ALL) 1866STEXI 1867@item -mon chardev=[name][,mode=readline|control][,default] 1868@findex -mon 1869Setup monitor on chardev @var{name}. 1870ETEXI 1871 1872DEF("debugcon", HAS_ARG, QEMU_OPTION_debugcon, \ 1873 "-debugcon dev redirect the debug console to char device 'dev'\n", 1874 QEMU_ARCH_ALL) 1875STEXI 1876@item -debugcon @var{dev} 1877@findex -debugcon 1878Redirect the debug console to host device @var{dev} (same devices as the 1879serial port). The debug console is an I/O port which is typically port 18800xe9; writing to that I/O port sends output to this device. 1881The default device is @code{vc} in graphical mode and @code{stdio} in 1882non graphical mode. 1883ETEXI 1884 1885DEF("pidfile", HAS_ARG, QEMU_OPTION_pidfile, \ 1886 "-pidfile file write PID to 'file'\n", QEMU_ARCH_ALL) 1887STEXI 1888@item -pidfile @var{file} 1889@findex -pidfile 1890Store the QEMU process PID in @var{file}. It is useful if you launch QEMU 1891from a script. 1892ETEXI 1893 1894DEF("singlestep", 0, QEMU_OPTION_singlestep, \ 1895 "-singlestep always run in singlestep mode\n", QEMU_ARCH_ALL) 1896STEXI 1897@item -singlestep 1898@findex -singlestep 1899Run the emulation in single step mode. 1900ETEXI 1901 1902DEF("S", 0, QEMU_OPTION_S, \ 1903 "-S freeze CPU at startup (use 'c' to start execution)\n", 1904 QEMU_ARCH_ALL) 1905STEXI 1906@item -S 1907@findex -S 1908Do not start CPU at startup (you must type 'c' in the monitor). 1909ETEXI 1910 1911DEF("gdb", HAS_ARG, QEMU_OPTION_gdb, \ 1912 "-gdb dev wait for gdb connection on 'dev'\n", QEMU_ARCH_ALL) 1913STEXI 1914@item -gdb @var{dev} 1915@findex -gdb 1916Wait for gdb connection on device @var{dev} (@pxref{gdb_usage}). Typical 1917connections will likely be TCP-based, but also UDP, pseudo TTY, or even 1918stdio are reasonable use case. The latter is allowing to start qemu from 1919within gdb and establish the connection via a pipe: 1920@example 1921(gdb) target remote | exec qemu -gdb stdio ... 1922@end example 1923ETEXI 1924 1925DEF("s", 0, QEMU_OPTION_s, \ 1926 "-s shorthand for -gdb tcp::" DEFAULT_GDBSTUB_PORT "\n", 1927 QEMU_ARCH_ALL) 1928STEXI 1929@item -s 1930@findex -s 1931Shorthand for -gdb tcp::1234, i.e. open a gdbserver on TCP port 1234 1932(@pxref{gdb_usage}). 1933ETEXI 1934 1935DEF("d", HAS_ARG, QEMU_OPTION_d, \ 1936 "-d item1,... output log to /tmp/qemu.log (use -d ? for a list of log items)\n", 1937 QEMU_ARCH_ALL) 1938STEXI 1939@item -d 1940@findex -d 1941Output log in /tmp/qemu.log 1942ETEXI 1943 1944DEF("hdachs", HAS_ARG, QEMU_OPTION_hdachs, \ 1945 "-hdachs c,h,s[,t]\n" \ 1946 " force hard disk 0 physical geometry and the optional BIOS\n" \ 1947 " translation (t=none or lba) (usually qemu can guess them)\n", 1948 QEMU_ARCH_ALL) 1949STEXI 1950@item -hdachs @var{c},@var{h},@var{s},[,@var{t}] 1951@findex -hdachs 1952Force hard disk 0 physical geometry (1 <= @var{c} <= 16383, 1 <= 1953@var{h} <= 16, 1 <= @var{s} <= 63) and optionally force the BIOS 1954translation mode (@var{t}=none, lba or auto). Usually QEMU can guess 1955all those parameters. This option is useful for old MS-DOS disk 1956images. 1957ETEXI 1958 1959DEF("L", HAS_ARG, QEMU_OPTION_L, \ 1960 "-L path set the directory for the BIOS, VGA BIOS and keymaps\n", 1961 QEMU_ARCH_ALL) 1962STEXI 1963@item -L @var{path} 1964@findex -L 1965Set the directory for the BIOS, VGA BIOS and keymaps. 1966ETEXI 1967 1968DEF("bios", HAS_ARG, QEMU_OPTION_bios, \ 1969 "-bios file set the filename for the BIOS\n", QEMU_ARCH_ALL) 1970STEXI 1971@item -bios @var{file} 1972@findex -bios 1973Set the filename for the BIOS. 1974ETEXI 1975 1976DEF("enable-kvm", 0, QEMU_OPTION_enable_kvm, \ 1977 "-enable-kvm enable KVM full virtualization support\n", QEMU_ARCH_ALL) 1978STEXI 1979@item -enable-kvm 1980@findex -enable-kvm 1981Enable KVM full virtualization support. This option is only available 1982if KVM support is enabled when compiling. 1983ETEXI 1984 1985DEF("xen-domid", HAS_ARG, QEMU_OPTION_xen_domid, 1986 "-xen-domid id specify xen guest domain id\n", QEMU_ARCH_ALL) 1987DEF("xen-create", 0, QEMU_OPTION_xen_create, 1988 "-xen-create create domain using xen hypercalls, bypassing xend\n" 1989 " warning: should not be used when xend is in use\n", 1990 QEMU_ARCH_ALL) 1991DEF("xen-attach", 0, QEMU_OPTION_xen_attach, 1992 "-xen-attach attach to existing xen domain\n" 1993 " xend will use this when starting qemu\n", 1994 QEMU_ARCH_ALL) 1995STEXI 1996@item -xen-domid @var{id} 1997@findex -xen-domid 1998Specify xen guest domain @var{id} (XEN only). 1999@item -xen-create 2000@findex -xen-create 2001Create domain using xen hypercalls, bypassing xend. 2002Warning: should not be used when xend is in use (XEN only). 2003@item -xen-attach 2004@findex -xen-attach 2005Attach to existing xen domain. 2006xend will use this when starting qemu (XEN only). 2007ETEXI 2008 2009DEF("no-reboot", 0, QEMU_OPTION_no_reboot, \ 2010 "-no-reboot exit instead of rebooting\n", QEMU_ARCH_ALL) 2011STEXI 2012@item -no-reboot 2013@findex -no-reboot 2014Exit instead of rebooting. 2015ETEXI 2016 2017DEF("no-shutdown", 0, QEMU_OPTION_no_shutdown, \ 2018 "-no-shutdown stop before shutdown\n", QEMU_ARCH_ALL) 2019STEXI 2020@item -no-shutdown 2021@findex -no-shutdown 2022Don't exit QEMU on guest shutdown, but instead only stop the emulation. 2023This allows for instance switching to monitor to commit changes to the 2024disk image. 2025ETEXI 2026 2027DEF("loadvm", HAS_ARG, QEMU_OPTION_loadvm, \ 2028 "-loadvm [tag|id]\n" \ 2029 " start right away with a saved state (loadvm in monitor)\n", 2030 QEMU_ARCH_ALL) 2031STEXI 2032@item -loadvm @var{file} 2033@findex -loadvm 2034Start right away with a saved state (@code{loadvm} in monitor) 2035ETEXI 2036 2037#ifndef _WIN32 2038DEF("daemonize", 0, QEMU_OPTION_daemonize, \ 2039 "-daemonize daemonize QEMU after initializing\n", QEMU_ARCH_ALL) 2040#endif 2041STEXI 2042@item -daemonize 2043@findex -daemonize 2044Daemonize the QEMU process after initialization. QEMU will not detach from 2045standard IO until it is ready to receive connections on any of its devices. 2046This option is a useful way for external programs to launch QEMU without having 2047to cope with initialization race conditions. 2048ETEXI 2049 2050DEF("option-rom", HAS_ARG, QEMU_OPTION_option_rom, \ 2051 "-option-rom rom load a file, rom, into the option ROM space\n", 2052 QEMU_ARCH_ALL) 2053STEXI 2054@item -option-rom @var{file} 2055@findex -option-rom 2056Load the contents of @var{file} as an option ROM. 2057This option is useful to load things like EtherBoot. 2058ETEXI 2059 2060DEF("clock", HAS_ARG, QEMU_OPTION_clock, \ 2061 "-clock force the use of the given methods for timer alarm.\n" \ 2062 " To see what timers are available use -clock ?\n", 2063 QEMU_ARCH_ALL) 2064STEXI 2065@item -clock @var{method} 2066@findex -clock 2067Force the use of the given methods for timer alarm. To see what timers 2068are available use -clock ?. 2069ETEXI 2070 2071HXCOMM Options deprecated by -rtc 2072DEF("localtime", 0, QEMU_OPTION_localtime, "", QEMU_ARCH_ALL) 2073DEF("startdate", HAS_ARG, QEMU_OPTION_startdate, "", QEMU_ARCH_ALL) 2074 2075DEF("rtc", HAS_ARG, QEMU_OPTION_rtc, \ 2076 "-rtc [base=utc|localtime|date][,clock=host|vm][,driftfix=none|slew]\n" \ 2077 " set the RTC base and clock, enable drift fix for clock ticks (x86 only)\n", 2078 QEMU_ARCH_ALL) 2079 2080STEXI 2081 2082@item -rtc [base=utc|localtime|@var{date}][,clock=host|vm][,driftfix=none|slew] 2083@findex -rtc 2084Specify @option{base} as @code{utc} or @code{localtime} to let the RTC start at the current 2085UTC or local time, respectively. @code{localtime} is required for correct date in 2086MS-DOS or Windows. To start at a specific point in time, provide @var{date} in the 2087format @code{2006-06-17T16:01:21} or @code{2006-06-17}. The default base is UTC. 2088 2089By default the RTC is driven by the host system time. This allows to use the 2090RTC as accurate reference clock inside the guest, specifically if the host 2091time is smoothly following an accurate external reference clock, e.g. via NTP. 2092If you want to isolate the guest time from the host, even prevent it from 2093progressing during suspension, you can set @option{clock} to @code{vm} instead. 2094 2095Enable @option{driftfix} (i386 targets only) if you experience time drift problems, 2096specifically with Windows' ACPI HAL. This option will try to figure out how 2097many timer interrupts were not processed by the Windows guest and will 2098re-inject them. 2099ETEXI 2100 2101DEF("icount", HAS_ARG, QEMU_OPTION_icount, \ 2102 "-icount [N|auto]\n" \ 2103 " enable virtual instruction counter with 2^N clock ticks per\n" \ 2104 " instruction\n", QEMU_ARCH_ALL) 2105STEXI 2106@item -icount [@var{N}|auto] 2107@findex -icount 2108Enable virtual instruction counter. The virtual cpu will execute one 2109instruction every 2^@var{N} ns of virtual time. If @code{auto} is specified 2110then the virtual cpu speed will be automatically adjusted to keep virtual 2111time within a few seconds of real time. 2112 2113Note that while this option can give deterministic behavior, it does not 2114provide cycle accurate emulation. Modern CPUs contain superscalar out of 2115order cores with complex cache hierarchies. The number of instructions 2116executed often has little or no correlation with actual performance. 2117ETEXI 2118 2119DEF("watchdog", HAS_ARG, QEMU_OPTION_watchdog, \ 2120 "-watchdog i6300esb|ib700\n" \ 2121 " enable virtual hardware watchdog [default=none]\n", 2122 QEMU_ARCH_ALL) 2123STEXI 2124@item -watchdog @var{model} 2125@findex -watchdog 2126Create a virtual hardware watchdog device. Once enabled (by a guest 2127action), the watchdog must be periodically polled by an agent inside 2128the guest or else the guest will be restarted. 2129 2130The @var{model} is the model of hardware watchdog to emulate. Choices 2131for model are: @code{ib700} (iBASE 700) which is a very simple ISA 2132watchdog with a single timer, or @code{i6300esb} (Intel 6300ESB I/O 2133controller hub) which is a much more featureful PCI-based dual-timer 2134watchdog. Choose a model for which your guest has drivers. 2135 2136Use @code{-watchdog ?} to list available hardware models. Only one 2137watchdog can be enabled for a guest. 2138ETEXI 2139 2140DEF("watchdog-action", HAS_ARG, QEMU_OPTION_watchdog_action, \ 2141 "-watchdog-action reset|shutdown|poweroff|pause|debug|none\n" \ 2142 " action when watchdog fires [default=reset]\n", 2143 QEMU_ARCH_ALL) 2144STEXI 2145@item -watchdog-action @var{action} 2146 2147The @var{action} controls what QEMU will do when the watchdog timer 2148expires. 2149The default is 2150@code{reset} (forcefully reset the guest). 2151Other possible actions are: 2152@code{shutdown} (attempt to gracefully shutdown the guest), 2153@code{poweroff} (forcefully poweroff the guest), 2154@code{pause} (pause the guest), 2155@code{debug} (print a debug message and continue), or 2156@code{none} (do nothing). 2157 2158Note that the @code{shutdown} action requires that the guest responds 2159to ACPI signals, which it may not be able to do in the sort of 2160situations where the watchdog would have expired, and thus 2161@code{-watchdog-action shutdown} is not recommended for production use. 2162 2163Examples: 2164 2165@table @code 2166@item -watchdog i6300esb -watchdog-action pause 2167@item -watchdog ib700 2168@end table 2169ETEXI 2170 2171DEF("echr", HAS_ARG, QEMU_OPTION_echr, \ 2172 "-echr chr set terminal escape character instead of ctrl-a\n", 2173 QEMU_ARCH_ALL) 2174STEXI 2175 2176@item -echr @var{numeric_ascii_value} 2177@findex -echr 2178Change the escape character used for switching to the monitor when using 2179monitor and serial sharing. The default is @code{0x01} when using the 2180@code{-nographic} option. @code{0x01} is equal to pressing 2181@code{Control-a}. You can select a different character from the ascii 2182control keys where 1 through 26 map to Control-a through Control-z. For 2183instance you could use the either of the following to change the escape 2184character to Control-t. 2185@table @code 2186@item -echr 0x14 2187@item -echr 20 2188@end table 2189ETEXI 2190 2191DEF("virtioconsole", HAS_ARG, QEMU_OPTION_virtiocon, \ 2192 "-virtioconsole c\n" \ 2193 " set virtio console\n", QEMU_ARCH_ALL) 2194STEXI 2195@item -virtioconsole @var{c} 2196@findex -virtioconsole 2197Set virtio console. 2198 2199This option is maintained for backward compatibility. 2200 2201Please use @code{-device virtconsole} for the new way of invocation. 2202ETEXI 2203 2204DEF("show-cursor", 0, QEMU_OPTION_show_cursor, \ 2205 "-show-cursor show cursor\n", QEMU_ARCH_ALL) 2206STEXI 2207@item -show-cursor 2208@findex -show-cursor 2209Show cursor. 2210ETEXI 2211 2212DEF("tb-size", HAS_ARG, QEMU_OPTION_tb_size, \ 2213 "-tb-size n set TB size\n", QEMU_ARCH_ALL) 2214STEXI 2215@item -tb-size @var{n} 2216@findex -tb-size 2217Set TB size. 2218ETEXI 2219 2220DEF("incoming", HAS_ARG, QEMU_OPTION_incoming, \ 2221 "-incoming p prepare for incoming migration, listen on port p\n", 2222 QEMU_ARCH_ALL) 2223STEXI 2224@item -incoming @var{port} 2225@findex -incoming 2226Prepare for incoming migration, listen on @var{port}. 2227ETEXI 2228 2229DEF("nodefaults", 0, QEMU_OPTION_nodefaults, \ 2230 "-nodefaults don't create default devices\n", QEMU_ARCH_ALL) 2231STEXI 2232@item -nodefaults 2233@findex -nodefaults 2234Don't create default devices. 2235ETEXI 2236 2237#ifndef _WIN32 2238DEF("chroot", HAS_ARG, QEMU_OPTION_chroot, \ 2239 "-chroot dir chroot to dir just before starting the VM\n", 2240 QEMU_ARCH_ALL) 2241#endif 2242STEXI 2243@item -chroot @var{dir} 2244@findex -chroot 2245Immediately before starting guest execution, chroot to the specified 2246directory. Especially useful in combination with -runas. 2247ETEXI 2248 2249#ifndef _WIN32 2250DEF("runas", HAS_ARG, QEMU_OPTION_runas, \ 2251 "-runas user change to user id user just before starting the VM\n", 2252 QEMU_ARCH_ALL) 2253#endif 2254STEXI 2255@item -runas @var{user} 2256@findex -runas 2257Immediately before starting guest execution, drop root privileges, switching 2258to the specified user. 2259ETEXI 2260 2261DEF("prom-env", HAS_ARG, QEMU_OPTION_prom_env, 2262 "-prom-env variable=value\n" 2263 " set OpenBIOS nvram variables\n", 2264 QEMU_ARCH_PPC | QEMU_ARCH_SPARC) 2265STEXI 2266@item -prom-env @var{variable}=@var{value} 2267@findex -prom-env 2268Set OpenBIOS nvram @var{variable} to given @var{value} (PPC, SPARC only). 2269ETEXI 2270DEF("semihosting", 0, QEMU_OPTION_semihosting, 2271 "-semihosting semihosting mode\n", QEMU_ARCH_ARM | QEMU_ARCH_M68K) 2272STEXI 2273@item -semihosting 2274@findex -semihosting 2275Semihosting mode (ARM, M68K only). 2276ETEXI 2277DEF("old-param", 0, QEMU_OPTION_old_param, 2278 "-old-param old param mode\n", QEMU_ARCH_ARM) 2279STEXI 2280@item -old-param 2281@findex -old-param (ARM) 2282Old param mode (ARM only). 2283ETEXI 2284 2285DEF("readconfig", HAS_ARG, QEMU_OPTION_readconfig, 2286 "-readconfig <file>\n", QEMU_ARCH_ALL) 2287STEXI 2288@item -readconfig @var{file} 2289@findex -readconfig 2290Read device configuration from @var{file}. 2291ETEXI 2292DEF("writeconfig", HAS_ARG, QEMU_OPTION_writeconfig, 2293 "-writeconfig <file>\n" 2294 " read/write config file\n", QEMU_ARCH_ALL) 2295STEXI 2296@item -writeconfig @var{file} 2297@findex -writeconfig 2298Write device configuration to @var{file}. 2299ETEXI 2300DEF("nodefconfig", 0, QEMU_OPTION_nodefconfig, 2301 "-nodefconfig\n" 2302 " do not load default config files at startup\n", 2303 QEMU_ARCH_ALL) 2304STEXI 2305@item -nodefconfig 2306@findex -nodefconfig 2307Normally QEMU loads a configuration file from @var{sysconfdir}/qemu.conf and 2308@var{sysconfdir}/target-@var{ARCH}.conf on startup. The @code{-nodefconfig} 2309option will prevent QEMU from loading these configuration files at startup. 2310ETEXI 2311#ifdef CONFIG_SIMPLE_TRACE 2312DEF("trace", HAS_ARG, QEMU_OPTION_trace, 2313 "-trace\n" 2314 " Specify a trace file to log traces to\n", 2315 QEMU_ARCH_ALL) 2316STEXI 2317@item -trace 2318@findex -trace 2319Specify a trace file to log output traces to. 2320ETEXI 2321#endif 2322 2323HXCOMM This is the last statement. Insert new options before this line! 2324STEXI 2325@end table 2326ETEXI 2327