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