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