15824d651Sblueswir1HXCOMM Use DEFHEADING() to define headings in both help text and texi 25824d651Sblueswir1HXCOMM Text between STEXI and ETEXI are copied to texi version and 35824d651Sblueswir1HXCOMM discarded from C version 4ad96090aSBlue SwirlHXCOMM DEF(option, HAS_ARG/0, opt_enum, opt_help, arch_mask) is used to 5ad96090aSBlue SwirlHXCOMM construct option structures, enums and help message for specified 6ad96090aSBlue SwirlHXCOMM architectures. 75824d651Sblueswir1HXCOMM HXCOMM can be used for comments, discarded from both texi and C 85824d651Sblueswir1 95824d651Sblueswir1DEFHEADING(Standard options:) 105824d651Sblueswir1STEXI 115824d651Sblueswir1@table @option 125824d651Sblueswir1ETEXI 135824d651Sblueswir1 145824d651Sblueswir1DEF("help", 0, QEMU_OPTION_h, 15ad96090aSBlue Swirl "-h or -help display this help and exit\n", QEMU_ARCH_ALL) 165824d651Sblueswir1STEXI 175824d651Sblueswir1@item -h 186616b2adSStefan Weil@findex -h 195824d651Sblueswir1Display help and exit 205824d651Sblueswir1ETEXI 215824d651Sblueswir1 229bd7e6d9SpbrookDEF("version", 0, QEMU_OPTION_version, 23ad96090aSBlue Swirl "-version display version information and exit\n", QEMU_ARCH_ALL) 249bd7e6d9SpbrookSTEXI 259bd7e6d9Spbrook@item -version 266616b2adSStefan Weil@findex -version 279bd7e6d9SpbrookDisplay version information and exit 289bd7e6d9SpbrookETEXI 299bd7e6d9Spbrook 3080f52a66SJan KiszkaDEF("machine", HAS_ARG, QEMU_OPTION_machine, \ 3180f52a66SJan Kiszka "-machine [type=]name[,prop[=value][,...]]\n" 32585f6036SPeter Maydell " selects emulated machine ('-machine help' for list)\n" 3380f52a66SJan Kiszka " property accel=accel1[:accel2[:...]] selects accelerator\n" 346a48ffaaSJan Kiszka " supported accelerators are kvm, xen, tcg (default: tcg)\n" 3539d6960aSJan Kiszka " kernel_irqchip=on|off controls accelerated irqchip support\n" 36ddb97f1dSJason Baron " kvm_shadow_mem=size of KVM shadow MMU\n" 378490fc78SLuiz Capitulino " dump-guest-core=on|off include guest memory in a core dump (default=on)\n" 388490fc78SLuiz Capitulino " mem-merge=on|off controls memory merge support (default: on)\n", 3980f52a66SJan Kiszka QEMU_ARCH_ALL) 405824d651Sblueswir1STEXI 4180f52a66SJan Kiszka@item -machine [type=]@var{name}[,prop=@var{value}[,...]] 4280f52a66SJan Kiszka@findex -machine 43585f6036SPeter MaydellSelect the emulated machine by @var{name}. Use @code{-machine help} to list 4480f52a66SJan Kiszkaavailable machines. Supported machine properties are: 4580f52a66SJan Kiszka@table @option 4680f52a66SJan Kiszka@item accel=@var{accels1}[:@var{accels2}[:...]] 4780f52a66SJan KiszkaThis is used to enable an accelerator. Depending on the target architecture, 4880f52a66SJan Kiszkakvm, xen, or tcg can be available. By default, tcg is used. If there is more 4980f52a66SJan Kiszkathan one accelerator specified, the next one is used if the previous one fails 5080f52a66SJan Kiszkato initialize. 516a48ffaaSJan Kiszka@item kernel_irqchip=on|off 526a48ffaaSJan KiszkaEnables in-kernel irqchip support for the chosen accelerator when available. 5339d6960aSJan Kiszka@item kvm_shadow_mem=size 5439d6960aSJan KiszkaDefines the size of the KVM shadow MMU. 55ddb97f1dSJason Baron@item dump-guest-core=on|off 56ddb97f1dSJason BaronInclude guest memory in a core dump. The default is on. 578490fc78SLuiz Capitulino@item mem-merge=on|off 588490fc78SLuiz CapitulinoEnables or disables memory merge support. This feature, when supported by 598490fc78SLuiz Capitulinothe host, de-duplicates identical memory pages among VMs instances 608490fc78SLuiz Capitulino(enabled by default). 6180f52a66SJan Kiszka@end table 625824d651Sblueswir1ETEXI 635824d651Sblueswir1 6480f52a66SJan KiszkaHXCOMM Deprecated by -machine 6580f52a66SJan KiszkaDEF("M", HAS_ARG, QEMU_OPTION_M, "", QEMU_ARCH_ALL) 6680f52a66SJan Kiszka 675824d651Sblueswir1DEF("cpu", HAS_ARG, QEMU_OPTION_cpu, 68585f6036SPeter Maydell "-cpu cpu select CPU ('-cpu help' for list)\n", QEMU_ARCH_ALL) 695824d651Sblueswir1STEXI 705824d651Sblueswir1@item -cpu @var{model} 716616b2adSStefan Weil@findex -cpu 72585f6036SPeter MaydellSelect CPU model (@code{-cpu help} for list and additional feature selection) 735824d651Sblueswir1ETEXI 745824d651Sblueswir1 755824d651Sblueswir1DEF("smp", HAS_ARG, QEMU_OPTION_smp, 7612b7f57eSMichael Tokarev "-smp [cpus=]n[,maxcpus=cpus][,cores=cores][,threads=threads][,sockets=sockets]\n" 776be68d7eSJes Sorensen " set the number of CPUs to 'n' [default=1]\n" 786be68d7eSJes Sorensen " maxcpus= maximum number of total cpus, including\n" 79ca1a8a06SBruce Rogers " offline CPUs for hotplug, etc\n" 8058a04db1SAndre Przywara " cores= number of CPU cores on one socket\n" 8158a04db1SAndre Przywara " threads= number of threads on one CPU core\n" 82ad96090aSBlue Swirl " sockets= number of discrete sockets in the system\n", 83ad96090aSBlue Swirl QEMU_ARCH_ALL) 845824d651Sblueswir1STEXI 8512b7f57eSMichael Tokarev@item -smp [cpus=]@var{n}[,cores=@var{cores}][,threads=@var{threads}][,sockets=@var{sockets}][,maxcpus=@var{maxcpus}] 866616b2adSStefan Weil@findex -smp 875824d651Sblueswir1Simulate an SMP system with @var{n} CPUs. On the PC target, up to 255 885824d651Sblueswir1CPUs are supported. On Sparc32 target, Linux limits the number of usable CPUs 895824d651Sblueswir1to 4. 9058a04db1SAndre PrzywaraFor the PC target, the number of @var{cores} per socket, the number 9158a04db1SAndre Przywaraof @var{threads} per cores and the total number of @var{sockets} can be 9258a04db1SAndre Przywaraspecified. Missing values will be computed. If any on the three values is 9358a04db1SAndre Przywaragiven, the total number of CPUs @var{n} can be omitted. @var{maxcpus} 9458a04db1SAndre Przywaraspecifies the maximum number of hotpluggable CPUs. 955824d651Sblueswir1ETEXI 965824d651Sblueswir1 97268a362cSaliguoriDEF("numa", HAS_ARG, QEMU_OPTION_numa, 98ad96090aSBlue Swirl "-numa node[,mem=size][,cpus=cpu[-cpu]][,nodeid=node]\n", QEMU_ARCH_ALL) 99268a362cSaliguoriSTEXI 100268a362cSaliguori@item -numa @var{opts} 1016616b2adSStefan Weil@findex -numa 102268a362cSaliguoriSimulate a multi node NUMA system. If mem and cpus are omitted, resources 103268a362cSaliguoriare split equally. 104268a362cSaliguoriETEXI 105268a362cSaliguori 10610adb8beSMarkus ArmbrusterDEF("add-fd", HAS_ARG, QEMU_OPTION_add_fd, 10710adb8beSMarkus Armbruster "-add-fd fd=fd,set=set[,opaque=opaque]\n" 10810adb8beSMarkus Armbruster " Add 'fd' to fd 'set'\n", QEMU_ARCH_ALL) 10910adb8beSMarkus ArmbrusterSTEXI 11010adb8beSMarkus Armbruster@item -add-fd fd=@var{fd},set=@var{set}[,opaque=@var{opaque}] 11110adb8beSMarkus Armbruster@findex -add-fd 11210adb8beSMarkus Armbruster 11310adb8beSMarkus ArmbrusterAdd a file descriptor to an fd set. Valid options are: 11410adb8beSMarkus Armbruster 11510adb8beSMarkus Armbruster@table @option 11610adb8beSMarkus Armbruster@item fd=@var{fd} 11710adb8beSMarkus ArmbrusterThis option defines the file descriptor of which a duplicate is added to fd set. 11810adb8beSMarkus ArmbrusterThe file descriptor cannot be stdin, stdout, or stderr. 11910adb8beSMarkus Armbruster@item set=@var{set} 12010adb8beSMarkus ArmbrusterThis option defines the ID of the fd set to add the file descriptor to. 12110adb8beSMarkus Armbruster@item opaque=@var{opaque} 12210adb8beSMarkus ArmbrusterThis option defines a free-form string that can be used to describe @var{fd}. 12310adb8beSMarkus Armbruster@end table 12410adb8beSMarkus Armbruster 12510adb8beSMarkus ArmbrusterYou can open an image using pre-opened file descriptors from an fd set: 12610adb8beSMarkus Armbruster@example 12710adb8beSMarkus Armbrusterqemu-system-i386 12810adb8beSMarkus Armbruster-add-fd fd=3,set=2,opaque="rdwr:/path/to/file" 12910adb8beSMarkus Armbruster-add-fd fd=4,set=2,opaque="rdonly:/path/to/file" 13010adb8beSMarkus Armbruster-drive file=/dev/fdset/2,index=0,media=disk 13110adb8beSMarkus Armbruster@end example 13210adb8beSMarkus ArmbrusterETEXI 13310adb8beSMarkus Armbruster 13410adb8beSMarkus ArmbrusterDEF("set", HAS_ARG, QEMU_OPTION_set, 13510adb8beSMarkus Armbruster "-set group.id.arg=value\n" 13610adb8beSMarkus Armbruster " set <arg> parameter for item <id> of type <group>\n" 13710adb8beSMarkus Armbruster " i.e. -set drive.$id.file=/path/to/image\n", QEMU_ARCH_ALL) 13810adb8beSMarkus ArmbrusterSTEXI 13910adb8beSMarkus Armbruster@item -set @var{group}.@var{id}.@var{arg}=@var{value} 14010adb8beSMarkus Armbruster@findex -set 14110adb8beSMarkus ArmbrusterSet parameter @var{arg} for item @var{id} of type @var{group}\n" 14210adb8beSMarkus ArmbrusterETEXI 14310adb8beSMarkus Armbruster 14410adb8beSMarkus ArmbrusterDEF("global", HAS_ARG, QEMU_OPTION_global, 14510adb8beSMarkus Armbruster "-global driver.prop=value\n" 14610adb8beSMarkus Armbruster " set a global default for a driver property\n", 14710adb8beSMarkus Armbruster QEMU_ARCH_ALL) 14810adb8beSMarkus ArmbrusterSTEXI 14910adb8beSMarkus Armbruster@item -global @var{driver}.@var{prop}=@var{value} 15010adb8beSMarkus Armbruster@findex -global 15110adb8beSMarkus ArmbrusterSet default value of @var{driver}'s property @var{prop} to @var{value}, e.g.: 15210adb8beSMarkus Armbruster 15310adb8beSMarkus Armbruster@example 15410adb8beSMarkus Armbrusterqemu-system-i386 -global ide-drive.physical_block_size=4096 -drive file=file,if=ide,index=0,media=disk 15510adb8beSMarkus Armbruster@end example 15610adb8beSMarkus Armbruster 15710adb8beSMarkus ArmbrusterIn particular, you can use this to set driver properties for devices which are 15810adb8beSMarkus Armbrustercreated automatically by the machine model. To create a device which is not 15910adb8beSMarkus Armbrustercreated automatically and set properties on it, use -@option{device}. 16010adb8beSMarkus ArmbrusterETEXI 16110adb8beSMarkus Armbruster 16210adb8beSMarkus ArmbrusterDEF("boot", HAS_ARG, QEMU_OPTION_boot, 16310adb8beSMarkus Armbruster "-boot [order=drives][,once=drives][,menu=on|off]\n" 164c8a6ae8bSAmos Kong " [,splash=sp_name][,splash-time=sp_time][,reboot-timeout=rb_time][,strict=on|off]\n" 16510adb8beSMarkus Armbruster " 'drives': floppy (a), hard disk (c), CD-ROM (d), network (n)\n" 16610adb8beSMarkus Armbruster " 'sp_name': the file's name that would be passed to bios as logo picture, if menu=on\n" 16710adb8beSMarkus Armbruster " 'sp_time': the period that splash picture last if menu=on, unit is ms\n" 16810adb8beSMarkus Armbruster " 'rb_timeout': the timeout before guest reboot when boot failed, unit is ms\n", 16910adb8beSMarkus Armbruster QEMU_ARCH_ALL) 17010adb8beSMarkus ArmbrusterSTEXI 171c8a6ae8bSAmos Kong@item -boot [order=@var{drives}][,once=@var{drives}][,menu=on|off][,splash=@var{sp_name}][,splash-time=@var{sp_time}][,reboot-timeout=@var{rb_timeout}][,strict=on|off] 17210adb8beSMarkus Armbruster@findex -boot 17310adb8beSMarkus ArmbrusterSpecify boot order @var{drives} as a string of drive letters. Valid 17410adb8beSMarkus Armbrusterdrive letters depend on the target achitecture. The x86 PC uses: a, b 17510adb8beSMarkus Armbruster(floppy 1 and 2), c (first hard disk), d (first CD-ROM), n-p (Etherboot 17610adb8beSMarkus Armbrusterfrom network adapter 1-4), hard disk boot is the default. To apply a 17710adb8beSMarkus Armbrusterparticular boot order only on the first startup, specify it via 17810adb8beSMarkus Armbruster@option{once}. 17910adb8beSMarkus Armbruster 18010adb8beSMarkus ArmbrusterInteractive boot menus/prompts can be enabled via @option{menu=on} as far 18110adb8beSMarkus Armbrusteras firmware/BIOS supports them. The default is non-interactive boot. 18210adb8beSMarkus Armbruster 18310adb8beSMarkus ArmbrusterA splash picture could be passed to bios, enabling user to show it as logo, 18410adb8beSMarkus Armbrusterwhen option splash=@var{sp_name} is given and menu=on, If firmware/BIOS 18510adb8beSMarkus Armbrustersupports them. Currently Seabios for X86 system support it. 18610adb8beSMarkus Armbrusterlimitation: The splash file could be a jpeg file or a BMP file in 24 BPP 18710adb8beSMarkus Armbrusterformat(true color). The resolution should be supported by the SVGA mode, so 18810adb8beSMarkus Armbrusterthe recommended is 320x240, 640x480, 800x640. 18910adb8beSMarkus Armbruster 19010adb8beSMarkus ArmbrusterA timeout could be passed to bios, guest will pause for @var{rb_timeout} ms 19110adb8beSMarkus Armbrusterwhen boot failed, then reboot. If @var{rb_timeout} is '-1', guest will not 19210adb8beSMarkus Armbrusterreboot, qemu passes '-1' to bios by default. Currently Seabios for X86 19310adb8beSMarkus Armbrustersystem support it. 19410adb8beSMarkus Armbruster 195c8a6ae8bSAmos KongDo strict boot via @option{strict=on} as far as firmware/BIOS 196c8a6ae8bSAmos Kongsupports it. This only effects when boot priority is changed by 197c8a6ae8bSAmos Kongbootindex options. The default is non-strict boot. 198c8a6ae8bSAmos Kong 19910adb8beSMarkus Armbruster@example 20010adb8beSMarkus Armbruster# try to boot from network first, then from hard disk 20110adb8beSMarkus Armbrusterqemu-system-i386 -boot order=nc 20210adb8beSMarkus Armbruster# boot from CD-ROM first, switch back to default order after reboot 20310adb8beSMarkus Armbrusterqemu-system-i386 -boot once=d 20410adb8beSMarkus Armbruster# boot with a splash picture for 5 seconds. 20510adb8beSMarkus Armbrusterqemu-system-i386 -boot menu=on,splash=/root/boot.bmp,splash-time=5000 20610adb8beSMarkus Armbruster@end example 20710adb8beSMarkus Armbruster 20810adb8beSMarkus ArmbrusterNote: The legacy format '-boot @var{drives}' is still supported but its 20910adb8beSMarkus Armbrusteruse is discouraged as it may be removed from future versions. 21010adb8beSMarkus ArmbrusterETEXI 21110adb8beSMarkus Armbruster 21210adb8beSMarkus ArmbrusterDEF("m", HAS_ARG, QEMU_OPTION_m, 2136e1d3c1cSIgor Mammedov "-m [size=]megs\n" 2146e1d3c1cSIgor Mammedov " configure guest RAM\n" 2156e1d3c1cSIgor Mammedov " size: initial amount of guest memory (default: " 2166e1d3c1cSIgor Mammedov stringify(DEFAULT_RAM_SIZE) "MiB)\n", 2176e1d3c1cSIgor Mammedov QEMU_ARCH_ALL) 21810adb8beSMarkus ArmbrusterSTEXI 2196e1d3c1cSIgor Mammedov@item -m [size=]@var{megs} 22010adb8beSMarkus Armbruster@findex -m 22110adb8beSMarkus ArmbrusterSet virtual RAM size to @var{megs} megabytes. Default is 128 MiB. Optionally, 22210adb8beSMarkus Armbrustera suffix of ``M'' or ``G'' can be used to signify a value in megabytes or 22310adb8beSMarkus Armbrustergigabytes respectively. 22410adb8beSMarkus ArmbrusterETEXI 22510adb8beSMarkus Armbruster 22610adb8beSMarkus ArmbrusterDEF("mem-path", HAS_ARG, QEMU_OPTION_mempath, 22710adb8beSMarkus Armbruster "-mem-path FILE provide backing storage for guest RAM\n", QEMU_ARCH_ALL) 22810adb8beSMarkus ArmbrusterSTEXI 22910adb8beSMarkus Armbruster@item -mem-path @var{path} 23010adb8beSMarkus Armbruster@findex -mem-path 23110adb8beSMarkus ArmbrusterAllocate guest RAM from a temporarily created file in @var{path}. 23210adb8beSMarkus ArmbrusterETEXI 23310adb8beSMarkus Armbruster 23410adb8beSMarkus ArmbrusterDEF("mem-prealloc", 0, QEMU_OPTION_mem_prealloc, 23510adb8beSMarkus Armbruster "-mem-prealloc preallocate guest memory (use with -mem-path)\n", 23610adb8beSMarkus Armbruster QEMU_ARCH_ALL) 23710adb8beSMarkus ArmbrusterSTEXI 23810adb8beSMarkus Armbruster@item -mem-prealloc 23910adb8beSMarkus Armbruster@findex -mem-prealloc 24010adb8beSMarkus ArmbrusterPreallocate memory when using -mem-path. 24110adb8beSMarkus ArmbrusterETEXI 24210adb8beSMarkus Armbruster 24310adb8beSMarkus ArmbrusterDEF("k", HAS_ARG, QEMU_OPTION_k, 24410adb8beSMarkus Armbruster "-k language use keyboard layout (for example 'fr' for French)\n", 24510adb8beSMarkus Armbruster QEMU_ARCH_ALL) 24610adb8beSMarkus ArmbrusterSTEXI 24710adb8beSMarkus Armbruster@item -k @var{language} 24810adb8beSMarkus Armbruster@findex -k 24910adb8beSMarkus ArmbrusterUse keyboard layout @var{language} (for example @code{fr} for 25010adb8beSMarkus ArmbrusterFrench). This option is only needed where it is not easy to get raw PC 25110adb8beSMarkus Armbrusterkeycodes (e.g. on Macs, with some X11 servers or with a VNC 25210adb8beSMarkus Armbrusterdisplay). You don't normally need to use it on PC/Linux or PC/Windows 25310adb8beSMarkus Armbrusterhosts. 25410adb8beSMarkus Armbruster 25510adb8beSMarkus ArmbrusterThe available layouts are: 25610adb8beSMarkus Armbruster@example 25710adb8beSMarkus Armbrusterar de-ch es fo fr-ca hu ja mk no pt-br sv 25810adb8beSMarkus Armbrusterda en-gb et fr fr-ch is lt nl pl ru th 25910adb8beSMarkus Armbrusterde en-us fi fr-be hr it lv nl-be pt sl tr 26010adb8beSMarkus Armbruster@end example 26110adb8beSMarkus Armbruster 26210adb8beSMarkus ArmbrusterThe default is @code{en-us}. 26310adb8beSMarkus ArmbrusterETEXI 26410adb8beSMarkus Armbruster 26510adb8beSMarkus Armbruster 26610adb8beSMarkus ArmbrusterDEF("audio-help", 0, QEMU_OPTION_audio_help, 26710adb8beSMarkus Armbruster "-audio-help print list of audio drivers and their options\n", 26810adb8beSMarkus Armbruster QEMU_ARCH_ALL) 26910adb8beSMarkus ArmbrusterSTEXI 27010adb8beSMarkus Armbruster@item -audio-help 27110adb8beSMarkus Armbruster@findex -audio-help 27210adb8beSMarkus ArmbrusterWill show the audio subsystem help: list of drivers, tunable 27310adb8beSMarkus Armbrusterparameters. 27410adb8beSMarkus ArmbrusterETEXI 27510adb8beSMarkus Armbruster 27610adb8beSMarkus ArmbrusterDEF("soundhw", HAS_ARG, QEMU_OPTION_soundhw, 27710adb8beSMarkus Armbruster "-soundhw c1,... enable audio support\n" 27810adb8beSMarkus Armbruster " and only specified sound cards (comma separated list)\n" 27910adb8beSMarkus Armbruster " use '-soundhw help' to get the list of supported cards\n" 28010adb8beSMarkus Armbruster " use '-soundhw all' to enable all of them\n", QEMU_ARCH_ALL) 28110adb8beSMarkus ArmbrusterSTEXI 28210adb8beSMarkus Armbruster@item -soundhw @var{card1}[,@var{card2},...] or -soundhw all 28310adb8beSMarkus Armbruster@findex -soundhw 28410adb8beSMarkus ArmbrusterEnable audio and selected sound hardware. Use 'help' to print all 28510adb8beSMarkus Armbrusteravailable sound hardware. 28610adb8beSMarkus Armbruster 28710adb8beSMarkus Armbruster@example 28810adb8beSMarkus Armbrusterqemu-system-i386 -soundhw sb16,adlib disk.img 28910adb8beSMarkus Armbrusterqemu-system-i386 -soundhw es1370 disk.img 29010adb8beSMarkus Armbrusterqemu-system-i386 -soundhw ac97 disk.img 29110adb8beSMarkus Armbrusterqemu-system-i386 -soundhw hda disk.img 29210adb8beSMarkus Armbrusterqemu-system-i386 -soundhw all disk.img 29310adb8beSMarkus Armbrusterqemu-system-i386 -soundhw help 29410adb8beSMarkus Armbruster@end example 29510adb8beSMarkus Armbruster 29610adb8beSMarkus ArmbrusterNote that Linux's i810_audio OSS kernel (for AC97) module might 29710adb8beSMarkus Armbrusterrequire manually specifying clocking. 29810adb8beSMarkus Armbruster 29910adb8beSMarkus Armbruster@example 30010adb8beSMarkus Armbrustermodprobe i810_audio clocking=48000 30110adb8beSMarkus Armbruster@end example 30210adb8beSMarkus ArmbrusterETEXI 30310adb8beSMarkus Armbruster 30410adb8beSMarkus ArmbrusterDEF("balloon", HAS_ARG, QEMU_OPTION_balloon, 30510adb8beSMarkus Armbruster "-balloon none disable balloon device\n" 30610adb8beSMarkus Armbruster "-balloon virtio[,addr=str]\n" 30710adb8beSMarkus Armbruster " enable virtio balloon device (default)\n", QEMU_ARCH_ALL) 30810adb8beSMarkus ArmbrusterSTEXI 30910adb8beSMarkus Armbruster@item -balloon none 31010adb8beSMarkus Armbruster@findex -balloon 31110adb8beSMarkus ArmbrusterDisable balloon device. 31210adb8beSMarkus Armbruster@item -balloon virtio[,addr=@var{addr}] 31310adb8beSMarkus ArmbrusterEnable virtio balloon device (default), optionally with PCI address 31410adb8beSMarkus Armbruster@var{addr}. 31510adb8beSMarkus ArmbrusterETEXI 31610adb8beSMarkus Armbruster 31710adb8beSMarkus ArmbrusterDEF("device", HAS_ARG, QEMU_OPTION_device, 31810adb8beSMarkus Armbruster "-device driver[,prop[=value][,...]]\n" 31910adb8beSMarkus Armbruster " add device (based on driver)\n" 32010adb8beSMarkus Armbruster " prop=value,... sets driver properties\n" 32110adb8beSMarkus Armbruster " use '-device help' to print all possible drivers\n" 32210adb8beSMarkus Armbruster " use '-device driver,help' to print all possible properties\n", 32310adb8beSMarkus Armbruster QEMU_ARCH_ALL) 32410adb8beSMarkus ArmbrusterSTEXI 32510adb8beSMarkus Armbruster@item -device @var{driver}[,@var{prop}[=@var{value}][,...]] 32610adb8beSMarkus Armbruster@findex -device 32710adb8beSMarkus ArmbrusterAdd device @var{driver}. @var{prop}=@var{value} sets driver 32810adb8beSMarkus Armbrusterproperties. Valid properties depend on the driver. To get help on 32910adb8beSMarkus Armbrusterpossible drivers and properties, use @code{-device help} and 33010adb8beSMarkus Armbruster@code{-device @var{driver},help}. 33110adb8beSMarkus ArmbrusterETEXI 33210adb8beSMarkus Armbruster 33310adb8beSMarkus ArmbrusterDEF("name", HAS_ARG, QEMU_OPTION_name, 3348f480de0SDr. David Alan Gilbert "-name string1[,process=string2][,debug-threads=on|off]\n" 33510adb8beSMarkus Armbruster " set the name of the guest\n" 3368f480de0SDr. David Alan Gilbert " string1 sets the window title and string2 the process name (on Linux)\n" 3378f480de0SDr. David Alan Gilbert " When debug-threads is enabled, individual threads are given a separate name (on Linux)\n" 3388f480de0SDr. David Alan Gilbert " NOTE: The thread names are for debugging and not a stable API.\n", 33910adb8beSMarkus Armbruster QEMU_ARCH_ALL) 34010adb8beSMarkus ArmbrusterSTEXI 34110adb8beSMarkus Armbruster@item -name @var{name} 34210adb8beSMarkus Armbruster@findex -name 34310adb8beSMarkus ArmbrusterSets the @var{name} of the guest. 34410adb8beSMarkus ArmbrusterThis name will be displayed in the SDL window caption. 34510adb8beSMarkus ArmbrusterThe @var{name} will also be used for the VNC server. 34610adb8beSMarkus ArmbrusterAlso optionally set the top visible process name in Linux. 3478f480de0SDr. David Alan GilbertNaming of individual threads can also be enabled on Linux to aid debugging. 34810adb8beSMarkus ArmbrusterETEXI 34910adb8beSMarkus Armbruster 35010adb8beSMarkus ArmbrusterDEF("uuid", HAS_ARG, QEMU_OPTION_uuid, 35110adb8beSMarkus Armbruster "-uuid %08x-%04x-%04x-%04x-%012x\n" 35210adb8beSMarkus Armbruster " specify machine UUID\n", QEMU_ARCH_ALL) 35310adb8beSMarkus ArmbrusterSTEXI 35410adb8beSMarkus Armbruster@item -uuid @var{uuid} 35510adb8beSMarkus Armbruster@findex -uuid 35610adb8beSMarkus ArmbrusterSet system UUID. 35710adb8beSMarkus ArmbrusterETEXI 35810adb8beSMarkus Armbruster 35910adb8beSMarkus ArmbrusterSTEXI 36010adb8beSMarkus Armbruster@end table 36110adb8beSMarkus ArmbrusterETEXI 36210adb8beSMarkus ArmbrusterDEFHEADING() 36310adb8beSMarkus Armbruster 36410adb8beSMarkus ArmbrusterDEFHEADING(Block device options:) 36510adb8beSMarkus ArmbrusterSTEXI 36610adb8beSMarkus Armbruster@table @option 36710adb8beSMarkus ArmbrusterETEXI 36810adb8beSMarkus Armbruster 3695824d651Sblueswir1DEF("fda", HAS_ARG, QEMU_OPTION_fda, 370ad96090aSBlue Swirl "-fda/-fdb file use 'file' as floppy disk 0/1 image\n", QEMU_ARCH_ALL) 371ad96090aSBlue SwirlDEF("fdb", HAS_ARG, QEMU_OPTION_fdb, "", QEMU_ARCH_ALL) 3725824d651Sblueswir1STEXI 3735824d651Sblueswir1@item -fda @var{file} 3745824d651Sblueswir1@item -fdb @var{file} 3756616b2adSStefan Weil@findex -fda 3766616b2adSStefan Weil@findex -fdb 3775824d651Sblueswir1Use @var{file} as floppy disk 0/1 image (@pxref{disk_images}). You can 3785824d651Sblueswir1use the host floppy by using @file{/dev/fd0} as filename (@pxref{host_drives}). 3795824d651Sblueswir1ETEXI 3805824d651Sblueswir1 3815824d651Sblueswir1DEF("hda", HAS_ARG, QEMU_OPTION_hda, 382ad96090aSBlue Swirl "-hda/-hdb file use 'file' as IDE hard disk 0/1 image\n", QEMU_ARCH_ALL) 383ad96090aSBlue SwirlDEF("hdb", HAS_ARG, QEMU_OPTION_hdb, "", QEMU_ARCH_ALL) 3845824d651Sblueswir1DEF("hdc", HAS_ARG, QEMU_OPTION_hdc, 385ad96090aSBlue Swirl "-hdc/-hdd file use 'file' as IDE hard disk 2/3 image\n", QEMU_ARCH_ALL) 386ad96090aSBlue SwirlDEF("hdd", HAS_ARG, QEMU_OPTION_hdd, "", QEMU_ARCH_ALL) 3875824d651Sblueswir1STEXI 3885824d651Sblueswir1@item -hda @var{file} 3895824d651Sblueswir1@item -hdb @var{file} 3905824d651Sblueswir1@item -hdc @var{file} 3915824d651Sblueswir1@item -hdd @var{file} 3926616b2adSStefan Weil@findex -hda 3936616b2adSStefan Weil@findex -hdb 3946616b2adSStefan Weil@findex -hdc 3956616b2adSStefan Weil@findex -hdd 3965824d651Sblueswir1Use @var{file} as hard disk 0, 1, 2 or 3 image (@pxref{disk_images}). 3975824d651Sblueswir1ETEXI 3985824d651Sblueswir1 3995824d651Sblueswir1DEF("cdrom", HAS_ARG, QEMU_OPTION_cdrom, 400ad96090aSBlue Swirl "-cdrom file use 'file' as IDE cdrom image (cdrom is ide1 master)\n", 401ad96090aSBlue Swirl QEMU_ARCH_ALL) 4025824d651Sblueswir1STEXI 4035824d651Sblueswir1@item -cdrom @var{file} 4046616b2adSStefan Weil@findex -cdrom 4055824d651Sblueswir1Use @var{file} as CD-ROM image (you cannot use @option{-hdc} and 4065824d651Sblueswir1@option{-cdrom} at the same time). You can use the host CD-ROM by 4075824d651Sblueswir1using @file{/dev/cdrom} as filename (@pxref{host_drives}). 4085824d651Sblueswir1ETEXI 4095824d651Sblueswir1 4105824d651Sblueswir1DEF("drive", HAS_ARG, QEMU_OPTION_drive, 4115824d651Sblueswir1 "-drive [file=file][,if=type][,bus=n][,unit=m][,media=d][,index=i]\n" 4125824d651Sblueswir1 " [,cyls=c,heads=h,secs=s[,trans=t]][,snapshot=on|off]\n" 41392196b2fSStefan Hajnoczi " [,cache=writethrough|writeback|none|directsync|unsafe][,format=f]\n" 414d1db760dSStefan Hajnoczi " [,serial=s][,addr=A][,rerror=ignore|stop|report]\n" 415d1db760dSStefan Hajnoczi " [,werror=ignore|stop|report|enospc][,id=name][,aio=threads|native]\n" 416fb0490f6SStefan Hajnoczi " [,readonly=on|off][,copy-on-read=on|off]\n" 417*465bee1dSPeter Lieven " [,detect-zeroes=on|off|unmap]\n" 4183e9fab69SBenoît Canet " [[,bps=b]|[[,bps_rd=r][,bps_wr=w]]]\n" 4193e9fab69SBenoît Canet " [[,iops=i]|[[,iops_rd=r][,iops_wr=w]]]\n" 4203e9fab69SBenoît Canet " [[,bps_max=bm]|[[,bps_rd_max=rm][,bps_wr_max=wm]]]\n" 4213e9fab69SBenoît Canet " [[,iops_max=im]|[[,iops_rd_max=irm][,iops_wr_max=iwm]]]\n" 4222024c1dfSBenoît Canet " [[,iops_size=is]]\n" 423ad96090aSBlue Swirl " use 'file' as a drive image\n", QEMU_ARCH_ALL) 4245824d651Sblueswir1STEXI 4255824d651Sblueswir1@item -drive @var{option}[,@var{option}[,@var{option}[,...]]] 4266616b2adSStefan Weil@findex -drive 4275824d651Sblueswir1 4285824d651Sblueswir1Define a new drive. Valid options are: 4295824d651Sblueswir1 430b3f046c2SKevin Wolf@table @option 4315824d651Sblueswir1@item file=@var{file} 4325824d651Sblueswir1This option defines which disk image (@pxref{disk_images}) to use with 4335824d651Sblueswir1this drive. If the filename contains comma, you must double it 4345824d651Sblueswir1(for instance, "file=my,,file" to use file "my,file"). 4350f5314a2SRonnie Sahlberg 4360f5314a2SRonnie SahlbergSpecial files such as iSCSI devices can be specified using protocol 4370f5314a2SRonnie Sahlbergspecific URLs. See the section for "Device URL Syntax" for more information. 4385824d651Sblueswir1@item if=@var{interface} 4395824d651Sblueswir1This option defines on which type on interface the drive is connected. 4405824d651Sblueswir1Available types are: ide, scsi, sd, mtd, floppy, pflash, virtio. 4415824d651Sblueswir1@item bus=@var{bus},unit=@var{unit} 4425824d651Sblueswir1These options define where is connected the drive by defining the bus number and 4435824d651Sblueswir1the unit id. 4445824d651Sblueswir1@item index=@var{index} 4455824d651Sblueswir1This option defines where is connected the drive by using an index in the list 4465824d651Sblueswir1of available connectors of a given interface type. 4475824d651Sblueswir1@item media=@var{media} 4485824d651Sblueswir1This option defines the type of the media: disk or cdrom. 4495824d651Sblueswir1@item cyls=@var{c},heads=@var{h},secs=@var{s}[,trans=@var{t}] 4505824d651Sblueswir1These options have the same definition as they have in @option{-hdachs}. 4515824d651Sblueswir1@item snapshot=@var{snapshot} 4529d85d557SMichael Tokarev@var{snapshot} is "on" or "off" and controls snapshot mode for the given drive 4539d85d557SMichael Tokarev(see @option{-snapshot}). 4545824d651Sblueswir1@item cache=@var{cache} 45592196b2fSStefan Hajnoczi@var{cache} is "none", "writeback", "unsafe", "directsync" or "writethrough" and controls how the host cache is used to access block data. 4565c6c3a6cSChristoph Hellwig@item aio=@var{aio} 4575c6c3a6cSChristoph Hellwig@var{aio} is "threads", or "native" and selects between pthread based disk I/O and native Linux AIO. 458a9384affSPaolo Bonzini@item discard=@var{discard} 459a9384affSPaolo Bonzini@var{discard} is one of "ignore" (or "off") or "unmap" (or "on") and controls whether @dfn{discard} (also known as @dfn{trim} or @dfn{unmap}) requests are ignored or passed to the filesystem. Some machine types may not support discard requests. 4605824d651Sblueswir1@item format=@var{format} 4615824d651Sblueswir1Specify which disk @var{format} will be used rather than detecting 4625824d651Sblueswir1the format. Can be used to specifiy format=raw to avoid interpreting 4635824d651Sblueswir1an untrusted format header. 4645824d651Sblueswir1@item serial=@var{serial} 4655824d651Sblueswir1This option specifies the serial number to assign to the device. 466c2cc47a4SMarkus Armbruster@item addr=@var{addr} 467c2cc47a4SMarkus ArmbrusterSpecify the controller's PCI address (if=virtio only). 468ae73e591SLuiz Capitulino@item werror=@var{action},rerror=@var{action} 469ae73e591SLuiz CapitulinoSpecify which @var{action} to take on write and read errors. Valid actions are: 470ae73e591SLuiz Capitulino"ignore" (ignore the error and try to continue), "stop" (pause QEMU), 471ae73e591SLuiz Capitulino"report" (report the error to the guest), "enospc" (pause QEMU only if the 472ae73e591SLuiz Capitulinohost disk is full; report the error to the guest otherwise). 473ae73e591SLuiz CapitulinoThe default setting is @option{werror=enospc} and @option{rerror=report}. 474ae73e591SLuiz Capitulino@item readonly 475ae73e591SLuiz CapitulinoOpen drive @option{file} as read-only. Guest write attempts will fail. 476fb0490f6SStefan Hajnoczi@item copy-on-read=@var{copy-on-read} 477fb0490f6SStefan Hajnoczi@var{copy-on-read} is "on" or "off" and enables whether to copy read backing 478fb0490f6SStefan Hajnoczifile sectors into the image file. 479*465bee1dSPeter Lieven@item detect-zeroes=@var{detect-zeroes} 480*465bee1dSPeter Lieven@var{detect-zeroes} is "off", "on" or "unmap" and enables the automatic 481*465bee1dSPeter Lievenconversion of plain zero writes by the OS to driver specific optimized 482*465bee1dSPeter Lievenzero write commands. You may even choose "unmap" if @var{discard} is set 483*465bee1dSPeter Lievento "unmap" to allow a zero write to be converted to an UNMAP operation. 4845824d651Sblueswir1@end table 4855824d651Sblueswir1 486a13e5e05SKevin WolfBy default, the @option{cache=writeback} mode is used. It will report data 487a13e5e05SKevin Wolfwrites as completed as soon as the data is present in the host page cache. 488a13e5e05SKevin WolfThis is safe as long as your guest OS makes sure to correctly flush disk caches 489a13e5e05SKevin Wolfwhere needed. If your guest OS does not handle volatile disk write caches 490a13e5e05SKevin Wolfcorrectly and your host crashes or loses power, then the guest may experience 491a13e5e05SKevin Wolfdata corruption. 4925824d651Sblueswir1 493a13e5e05SKevin WolfFor such guests, you should consider using @option{cache=writethrough}. This 494a13e5e05SKevin Wolfmeans that the host page cache will be used to read and write data, but write 495a13e5e05SKevin Wolfnotification will be sent to the guest only after QEMU has made sure to flush 496a13e5e05SKevin Wolfeach write to the disk. Be aware that this has a major impact on performance. 4975824d651Sblueswir1 498c304d317SAurelien JarnoThe host page cache can be avoided entirely with @option{cache=none}. This will 499a13e5e05SKevin Wolfattempt to do disk IO directly to the guest's memory. QEMU may still perform 500a13e5e05SKevin Wolfan internal copy of the data. Note that this is considered a writeback mode and 501a13e5e05SKevin Wolfthe guest OS must handle the disk write cache correctly in order to avoid data 502a13e5e05SKevin Wolfcorruption on host crashes. 5035824d651Sblueswir1 50492196b2fSStefan HajnocziThe host page cache can be avoided while only sending write notifications to 505a13e5e05SKevin Wolfthe guest when the data has been flushed to the disk using 506a13e5e05SKevin Wolf@option{cache=directsync}. 5075824d651Sblueswir1 508016f5cf6SAlexander GrafIn case you don't care about data integrity over host failures, use 509a13e5e05SKevin Wolf@option{cache=unsafe}. This option tells QEMU that it never needs to write any 510a13e5e05SKevin Wolfdata to the disk but can instead keep things in cache. If anything goes wrong, 511e7d81004SStefan Weillike your host losing power, the disk storage getting disconnected accidentally, 512a13e5e05SKevin Wolfetc. your image will most probably be rendered unusable. When using 513c3177288SAlexander Grafthe @option{-snapshot} option, unsafe caching is always used. 514016f5cf6SAlexander Graf 515fb0490f6SStefan HajnocziCopy-on-read avoids accessing the same backing file sectors repeatedly and is 516fb0490f6SStefan Hajnocziuseful when the backing file is over a slow network. By default copy-on-read 517fb0490f6SStefan Hajnocziis off. 518fb0490f6SStefan Hajnoczi 5195824d651Sblueswir1Instead of @option{-cdrom} you can use: 5205824d651Sblueswir1@example 5213804da9dSStefan Weilqemu-system-i386 -drive file=file,index=2,media=cdrom 5225824d651Sblueswir1@end example 5235824d651Sblueswir1 5245824d651Sblueswir1Instead of @option{-hda}, @option{-hdb}, @option{-hdc}, @option{-hdd}, you can 5255824d651Sblueswir1use: 5265824d651Sblueswir1@example 5273804da9dSStefan Weilqemu-system-i386 -drive file=file,index=0,media=disk 5283804da9dSStefan Weilqemu-system-i386 -drive file=file,index=1,media=disk 5293804da9dSStefan Weilqemu-system-i386 -drive file=file,index=2,media=disk 5303804da9dSStefan Weilqemu-system-i386 -drive file=file,index=3,media=disk 5315824d651Sblueswir1@end example 5325824d651Sblueswir1 533587ed6beSCorey BryantYou can open an image using pre-opened file descriptors from an fd set: 534587ed6beSCorey Bryant@example 535587ed6beSCorey Bryantqemu-system-i386 536587ed6beSCorey Bryant-add-fd fd=3,set=2,opaque="rdwr:/path/to/file" 537587ed6beSCorey Bryant-add-fd fd=4,set=2,opaque="rdonly:/path/to/file" 538587ed6beSCorey Bryant-drive file=/dev/fdset/2,index=0,media=disk 539587ed6beSCorey Bryant@end example 540587ed6beSCorey Bryant 5415824d651Sblueswir1You can connect a CDROM to the slave of ide0: 5425824d651Sblueswir1@example 5433804da9dSStefan Weilqemu-system-i386 -drive file=file,if=ide,index=1,media=cdrom 5445824d651Sblueswir1@end example 5455824d651Sblueswir1 5465824d651Sblueswir1If you don't specify the "file=" argument, you define an empty drive: 5475824d651Sblueswir1@example 5483804da9dSStefan Weilqemu-system-i386 -drive if=ide,index=1,media=cdrom 5495824d651Sblueswir1@end example 5505824d651Sblueswir1 5515824d651Sblueswir1You can connect a SCSI disk with unit ID 6 on the bus #0: 5525824d651Sblueswir1@example 5533804da9dSStefan Weilqemu-system-i386 -drive file=file,if=scsi,bus=0,unit=6 5545824d651Sblueswir1@end example 5555824d651Sblueswir1 5565824d651Sblueswir1Instead of @option{-fda}, @option{-fdb}, you can use: 5575824d651Sblueswir1@example 5583804da9dSStefan Weilqemu-system-i386 -drive file=file,index=0,if=floppy 5593804da9dSStefan Weilqemu-system-i386 -drive file=file,index=1,if=floppy 5605824d651Sblueswir1@end example 5615824d651Sblueswir1 5625824d651Sblueswir1By default, @var{interface} is "ide" and @var{index} is automatically 5635824d651Sblueswir1incremented: 5645824d651Sblueswir1@example 5653804da9dSStefan Weilqemu-system-i386 -drive file=a -drive file=b" 5665824d651Sblueswir1@end example 5675824d651Sblueswir1is interpreted like: 5685824d651Sblueswir1@example 5693804da9dSStefan Weilqemu-system-i386 -hda a -hdb b 5705824d651Sblueswir1@end example 5715824d651Sblueswir1ETEXI 5725824d651Sblueswir1 5735824d651Sblueswir1DEF("mtdblock", HAS_ARG, QEMU_OPTION_mtdblock, 574ad96090aSBlue Swirl "-mtdblock file use 'file' as on-board Flash memory image\n", 575ad96090aSBlue Swirl QEMU_ARCH_ALL) 5765824d651Sblueswir1STEXI 5774e257e5eSKevin Wolf@item -mtdblock @var{file} 5786616b2adSStefan Weil@findex -mtdblock 5794e257e5eSKevin WolfUse @var{file} as on-board Flash memory image. 5805824d651Sblueswir1ETEXI 5815824d651Sblueswir1 5825824d651Sblueswir1DEF("sd", HAS_ARG, QEMU_OPTION_sd, 583ad96090aSBlue Swirl "-sd file use 'file' as SecureDigital card image\n", QEMU_ARCH_ALL) 5845824d651Sblueswir1STEXI 5854e257e5eSKevin Wolf@item -sd @var{file} 5866616b2adSStefan Weil@findex -sd 5874e257e5eSKevin WolfUse @var{file} as SecureDigital card image. 5885824d651Sblueswir1ETEXI 5895824d651Sblueswir1 5905824d651Sblueswir1DEF("pflash", HAS_ARG, QEMU_OPTION_pflash, 591ad96090aSBlue Swirl "-pflash file use 'file' as a parallel flash image\n", QEMU_ARCH_ALL) 5925824d651Sblueswir1STEXI 5934e257e5eSKevin Wolf@item -pflash @var{file} 5946616b2adSStefan Weil@findex -pflash 5954e257e5eSKevin WolfUse @var{file} as a parallel flash image. 5965824d651Sblueswir1ETEXI 5975824d651Sblueswir1 5985824d651Sblueswir1DEF("snapshot", 0, QEMU_OPTION_snapshot, 599ad96090aSBlue Swirl "-snapshot write to temporary files instead of disk image files\n", 600ad96090aSBlue Swirl QEMU_ARCH_ALL) 6015824d651Sblueswir1STEXI 6025824d651Sblueswir1@item -snapshot 6036616b2adSStefan Weil@findex -snapshot 6045824d651Sblueswir1Write to temporary files instead of disk image files. In this case, 6055824d651Sblueswir1the raw disk image you use is not written back. You can however force 6065824d651Sblueswir1the write back by pressing @key{C-a s} (@pxref{disk_images}). 6075824d651Sblueswir1ETEXI 6085824d651Sblueswir1 60910adb8beSMarkus ArmbrusterDEF("hdachs", HAS_ARG, QEMU_OPTION_hdachs, \ 61010adb8beSMarkus Armbruster "-hdachs c,h,s[,t]\n" \ 61110adb8beSMarkus Armbruster " force hard disk 0 physical geometry and the optional BIOS\n" \ 61210adb8beSMarkus Armbruster " translation (t=none or lba) (usually QEMU can guess them)\n", 613ad96090aSBlue Swirl QEMU_ARCH_ALL) 614c902760fSMarcelo TosattiSTEXI 61510adb8beSMarkus Armbruster@item -hdachs @var{c},@var{h},@var{s},[,@var{t}] 61610adb8beSMarkus Armbruster@findex -hdachs 61710adb8beSMarkus ArmbrusterForce hard disk 0 physical geometry (1 <= @var{c} <= 16383, 1 <= 61810adb8beSMarkus Armbruster@var{h} <= 16, 1 <= @var{s} <= 63) and optionally force the BIOS 61910adb8beSMarkus Armbrustertranslation mode (@var{t}=none, lba or auto). Usually QEMU can guess 62010adb8beSMarkus Armbrusterall those parameters. This option is useful for old MS-DOS disk 62110adb8beSMarkus Armbrusterimages. 622c70a01e4SMarkus ArmbrusterETEXI 62374db920cSGautham R Shenoy 62474db920cSGautham R ShenoyDEF("fsdev", HAS_ARG, QEMU_OPTION_fsdev, 6252c30dd74SAneesh Kumar K.V "-fsdev fsdriver,id=id[,path=path,][security_model={mapped-xattr|mapped-file|passthrough|none}]\n" 62684a87cc4SM. Mohan Kumar " [,writeout=immediate][,readonly][,socket=socket|sock_fd=sock_fd]\n", 62774db920cSGautham R Shenoy QEMU_ARCH_ALL) 62874db920cSGautham R Shenoy 62974db920cSGautham R ShenoySTEXI 63074db920cSGautham R Shenoy 63184a87cc4SM. Mohan Kumar@item -fsdev @var{fsdriver},id=@var{id},path=@var{path},[security_model=@var{security_model}][,writeout=@var{writeout}][,readonly][,socket=@var{socket}|sock_fd=@var{sock_fd}] 63274db920cSGautham R Shenoy@findex -fsdev 6337c92a3d2SAneesh Kumar K.VDefine a new file system device. Valid options are: 6347c92a3d2SAneesh Kumar K.V@table @option 6357c92a3d2SAneesh Kumar K.V@item @var{fsdriver} 6367c92a3d2SAneesh Kumar K.VThis option specifies the fs driver backend to use. 637f67e3ffdSM. Mohan KumarCurrently "local", "handle" and "proxy" file system drivers are supported. 6387c92a3d2SAneesh Kumar K.V@item id=@var{id} 6397c92a3d2SAneesh Kumar K.VSpecifies identifier for this device 6407c92a3d2SAneesh Kumar K.V@item path=@var{path} 6417c92a3d2SAneesh Kumar K.VSpecifies the export path for the file system device. Files under 6427c92a3d2SAneesh Kumar K.Vthis path will be available to the 9p client on the guest. 6437c92a3d2SAneesh Kumar K.V@item security_model=@var{security_model} 6447c92a3d2SAneesh Kumar K.VSpecifies the security model to be used for this export path. 6452c30dd74SAneesh Kumar K.VSupported security models are "passthrough", "mapped-xattr", "mapped-file" and "none". 6467c92a3d2SAneesh Kumar K.VIn "passthrough" security model, files are stored using the same 647b65ee4faSStefan Weilcredentials as they are created on the guest. This requires QEMU 6482c30dd74SAneesh Kumar K.Vto run as root. In "mapped-xattr" security model, some of the file 6497c92a3d2SAneesh Kumar K.Vattributes like uid, gid, mode bits and link target are stored as 6502c30dd74SAneesh Kumar K.Vfile attributes. For "mapped-file" these attributes are stored in the 6512c30dd74SAneesh Kumar K.Vhidden .virtfs_metadata directory. Directories exported by this security model cannot 6527c92a3d2SAneesh Kumar K.Vinteract with other unix tools. "none" security model is same as 6537c92a3d2SAneesh Kumar K.Vpassthrough except the sever won't report failures if it fails to 654d9b36a6eSM. Mohan Kumarset file attributes like ownership. Security model is mandatory 655f67e3ffdSM. Mohan Kumaronly for local fsdriver. Other fsdrivers (like handle, proxy) don't take 656d9b36a6eSM. Mohan Kumarsecurity model as a parameter. 6577c92a3d2SAneesh Kumar K.V@item writeout=@var{writeout} 6587c92a3d2SAneesh Kumar K.VThis is an optional argument. The only supported value is "immediate". 6597c92a3d2SAneesh Kumar K.VThis means that host page cache will be used to read and write data but 6607c92a3d2SAneesh Kumar K.Vwrite notification will be sent to the guest only when the data has been 6617c92a3d2SAneesh Kumar K.Vreported as written by the storage subsystem. 6622c74c2cbSM. Mohan Kumar@item readonly 6632c74c2cbSM. Mohan KumarEnables exporting 9p share as a readonly mount for guests. By default 6642c74c2cbSM. Mohan Kumarread-write access is given. 66584a87cc4SM. Mohan Kumar@item socket=@var{socket} 66684a87cc4SM. Mohan KumarEnables proxy filesystem driver to use passed socket file for communicating 66784a87cc4SM. Mohan Kumarwith virtfs-proxy-helper 668f67e3ffdSM. Mohan Kumar@item sock_fd=@var{sock_fd} 669f67e3ffdSM. Mohan KumarEnables proxy filesystem driver to use passed socket descriptor for 670f67e3ffdSM. Mohan Kumarcommunicating with virtfs-proxy-helper. Usually a helper like libvirt 671f67e3ffdSM. Mohan Kumarwill create socketpair and pass one of the fds as sock_fd 67274db920cSGautham R Shenoy@end table 6737c92a3d2SAneesh Kumar K.V 6747c92a3d2SAneesh Kumar K.V-fsdev option is used along with -device driver "virtio-9p-pci". 6757c92a3d2SAneesh Kumar K.V@item -device virtio-9p-pci,fsdev=@var{id},mount_tag=@var{mount_tag} 6767c92a3d2SAneesh Kumar K.VOptions for virtio-9p-pci driver are: 6777c92a3d2SAneesh Kumar K.V@table @option 6787c92a3d2SAneesh Kumar K.V@item fsdev=@var{id} 6797c92a3d2SAneesh Kumar K.VSpecifies the id value specified along with -fsdev option 6807c92a3d2SAneesh Kumar K.V@item mount_tag=@var{mount_tag} 6817c92a3d2SAneesh Kumar K.VSpecifies the tag name to be used by the guest to mount this export point 6827c92a3d2SAneesh Kumar K.V@end table 6837c92a3d2SAneesh Kumar K.V 68474db920cSGautham R ShenoyETEXI 68574db920cSGautham R Shenoy 6863d54abc7SGautham R ShenoyDEF("virtfs", HAS_ARG, QEMU_OPTION_virtfs, 6872c30dd74SAneesh Kumar K.V "-virtfs local,path=path,mount_tag=tag,security_model=[mapped-xattr|mapped-file|passthrough|none]\n" 68884a87cc4SM. Mohan Kumar " [,writeout=immediate][,readonly][,socket=socket|sock_fd=sock_fd]\n", 6893d54abc7SGautham R Shenoy QEMU_ARCH_ALL) 6903d54abc7SGautham R Shenoy 6913d54abc7SGautham R ShenoySTEXI 6923d54abc7SGautham R Shenoy 69384a87cc4SM. Mohan Kumar@item -virtfs @var{fsdriver}[,path=@var{path}],mount_tag=@var{mount_tag}[,security_model=@var{security_model}][,writeout=@var{writeout}][,readonly][,socket=@var{socket}|sock_fd=@var{sock_fd}] 6943d54abc7SGautham R Shenoy@findex -virtfs 6953d54abc7SGautham R Shenoy 6967c92a3d2SAneesh Kumar K.VThe general form of a Virtual File system pass-through options are: 6977c92a3d2SAneesh Kumar K.V@table @option 6987c92a3d2SAneesh Kumar K.V@item @var{fsdriver} 6997c92a3d2SAneesh Kumar K.VThis option specifies the fs driver backend to use. 700f67e3ffdSM. Mohan KumarCurrently "local", "handle" and "proxy" file system drivers are supported. 7017c92a3d2SAneesh Kumar K.V@item id=@var{id} 7027c92a3d2SAneesh Kumar K.VSpecifies identifier for this device 7037c92a3d2SAneesh Kumar K.V@item path=@var{path} 7047c92a3d2SAneesh Kumar K.VSpecifies the export path for the file system device. Files under 7057c92a3d2SAneesh Kumar K.Vthis path will be available to the 9p client on the guest. 7067c92a3d2SAneesh Kumar K.V@item security_model=@var{security_model} 7077c92a3d2SAneesh Kumar K.VSpecifies the security model to be used for this export path. 7082c30dd74SAneesh Kumar K.VSupported security models are "passthrough", "mapped-xattr", "mapped-file" and "none". 7097c92a3d2SAneesh Kumar K.VIn "passthrough" security model, files are stored using the same 710b65ee4faSStefan Weilcredentials as they are created on the guest. This requires QEMU 7112c30dd74SAneesh Kumar K.Vto run as root. In "mapped-xattr" security model, some of the file 7127c92a3d2SAneesh Kumar K.Vattributes like uid, gid, mode bits and link target are stored as 7132c30dd74SAneesh Kumar K.Vfile attributes. For "mapped-file" these attributes are stored in the 7142c30dd74SAneesh Kumar K.Vhidden .virtfs_metadata directory. Directories exported by this security model cannot 7157c92a3d2SAneesh Kumar K.Vinteract with other unix tools. "none" security model is same as 7167c92a3d2SAneesh Kumar K.Vpassthrough except the sever won't report failures if it fails to 717d9b36a6eSM. Mohan Kumarset file attributes like ownership. Security model is mandatory only 718f67e3ffdSM. Mohan Kumarfor local fsdriver. Other fsdrivers (like handle, proxy) don't take security 719d9b36a6eSM. Mohan Kumarmodel as a parameter. 7207c92a3d2SAneesh Kumar K.V@item writeout=@var{writeout} 7217c92a3d2SAneesh Kumar K.VThis is an optional argument. The only supported value is "immediate". 7227c92a3d2SAneesh Kumar K.VThis means that host page cache will be used to read and write data but 7237c92a3d2SAneesh Kumar K.Vwrite notification will be sent to the guest only when the data has been 7247c92a3d2SAneesh Kumar K.Vreported as written by the storage subsystem. 7252c74c2cbSM. Mohan Kumar@item readonly 7262c74c2cbSM. Mohan KumarEnables exporting 9p share as a readonly mount for guests. By default 7272c74c2cbSM. Mohan Kumarread-write access is given. 72884a87cc4SM. Mohan Kumar@item socket=@var{socket} 72984a87cc4SM. Mohan KumarEnables proxy filesystem driver to use passed socket file for 73084a87cc4SM. Mohan Kumarcommunicating with virtfs-proxy-helper. Usually a helper like libvirt 73184a87cc4SM. Mohan Kumarwill create socketpair and pass one of the fds as sock_fd 732f67e3ffdSM. Mohan Kumar@item sock_fd 733f67e3ffdSM. Mohan KumarEnables proxy filesystem driver to use passed 'sock_fd' as the socket 734f67e3ffdSM. Mohan Kumardescriptor for interfacing with virtfs-proxy-helper 7353d54abc7SGautham R Shenoy@end table 7363d54abc7SGautham R ShenoyETEXI 7373d54abc7SGautham R Shenoy 7389db221aeSAneesh Kumar K.VDEF("virtfs_synth", 0, QEMU_OPTION_virtfs_synth, 7399db221aeSAneesh Kumar K.V "-virtfs_synth Create synthetic file system image\n", 7409db221aeSAneesh Kumar K.V QEMU_ARCH_ALL) 7419db221aeSAneesh Kumar K.VSTEXI 7429db221aeSAneesh Kumar K.V@item -virtfs_synth 7439db221aeSAneesh Kumar K.V@findex -virtfs_synth 7449db221aeSAneesh Kumar K.VCreate synthetic file system image 7459db221aeSAneesh Kumar K.VETEXI 7469db221aeSAneesh Kumar K.V 7475824d651Sblueswir1STEXI 7485824d651Sblueswir1@end table 7495824d651Sblueswir1ETEXI 7505824d651Sblueswir1DEFHEADING() 7515824d651Sblueswir1 75210adb8beSMarkus ArmbrusterDEFHEADING(USB options:) 75310adb8beSMarkus ArmbrusterSTEXI 75410adb8beSMarkus Armbruster@table @option 75510adb8beSMarkus ArmbrusterETEXI 75610adb8beSMarkus Armbruster 75710adb8beSMarkus ArmbrusterDEF("usb", 0, QEMU_OPTION_usb, 75810adb8beSMarkus Armbruster "-usb enable the USB driver (will be the default soon)\n", 75910adb8beSMarkus Armbruster QEMU_ARCH_ALL) 76010adb8beSMarkus ArmbrusterSTEXI 76110adb8beSMarkus Armbruster@item -usb 76210adb8beSMarkus Armbruster@findex -usb 76310adb8beSMarkus ArmbrusterEnable the USB driver (will be the default soon) 76410adb8beSMarkus ArmbrusterETEXI 76510adb8beSMarkus Armbruster 76610adb8beSMarkus ArmbrusterDEF("usbdevice", HAS_ARG, QEMU_OPTION_usbdevice, 76710adb8beSMarkus Armbruster "-usbdevice name add the host or guest USB device 'name'\n", 76810adb8beSMarkus Armbruster QEMU_ARCH_ALL) 76910adb8beSMarkus ArmbrusterSTEXI 77010adb8beSMarkus Armbruster 77110adb8beSMarkus Armbruster@item -usbdevice @var{devname} 77210adb8beSMarkus Armbruster@findex -usbdevice 77310adb8beSMarkus ArmbrusterAdd the USB device @var{devname}. @xref{usb_devices}. 77410adb8beSMarkus Armbruster 77510adb8beSMarkus Armbruster@table @option 77610adb8beSMarkus Armbruster 77710adb8beSMarkus Armbruster@item mouse 77810adb8beSMarkus ArmbrusterVirtual Mouse. This will override the PS/2 mouse emulation when activated. 77910adb8beSMarkus Armbruster 78010adb8beSMarkus Armbruster@item tablet 78110adb8beSMarkus ArmbrusterPointer device that uses absolute coordinates (like a touchscreen). This 78210adb8beSMarkus Armbrustermeans QEMU is able to report the mouse position without having to grab the 78310adb8beSMarkus Armbrustermouse. Also overrides the PS/2 mouse emulation when activated. 78410adb8beSMarkus Armbruster 78510adb8beSMarkus Armbruster@item disk:[format=@var{format}]:@var{file} 78610adb8beSMarkus ArmbrusterMass storage device based on file. The optional @var{format} argument 78710adb8beSMarkus Armbrusterwill be used rather than detecting the format. Can be used to specifiy 78810adb8beSMarkus Armbruster@code{format=raw} to avoid interpreting an untrusted format header. 78910adb8beSMarkus Armbruster 79010adb8beSMarkus Armbruster@item host:@var{bus}.@var{addr} 79110adb8beSMarkus ArmbrusterPass through the host device identified by @var{bus}.@var{addr} (Linux only). 79210adb8beSMarkus Armbruster 79310adb8beSMarkus Armbruster@item host:@var{vendor_id}:@var{product_id} 79410adb8beSMarkus ArmbrusterPass through the host device identified by @var{vendor_id}:@var{product_id} 79510adb8beSMarkus Armbruster(Linux only). 79610adb8beSMarkus Armbruster 79710adb8beSMarkus Armbruster@item serial:[vendorid=@var{vendor_id}][,productid=@var{product_id}]:@var{dev} 79810adb8beSMarkus ArmbrusterSerial converter to host character device @var{dev}, see @code{-serial} for the 79910adb8beSMarkus Armbrusteravailable devices. 80010adb8beSMarkus Armbruster 80110adb8beSMarkus Armbruster@item braille 80210adb8beSMarkus ArmbrusterBraille device. This will use BrlAPI to display the braille output on a real 80310adb8beSMarkus Armbrusteror fake device. 80410adb8beSMarkus Armbruster 80510adb8beSMarkus Armbruster@item net:@var{options} 80610adb8beSMarkus ArmbrusterNetwork adapter that supports CDC ethernet and RNDIS protocols. 80710adb8beSMarkus Armbruster 80810adb8beSMarkus Armbruster@end table 80910adb8beSMarkus ArmbrusterETEXI 81010adb8beSMarkus Armbruster 81110adb8beSMarkus ArmbrusterSTEXI 81210adb8beSMarkus Armbruster@end table 81310adb8beSMarkus ArmbrusterETEXI 81410adb8beSMarkus ArmbrusterDEFHEADING() 81510adb8beSMarkus Armbruster 8165824d651Sblueswir1DEFHEADING(Display options:) 8175824d651Sblueswir1STEXI 8185824d651Sblueswir1@table @option 8195824d651Sblueswir1ETEXI 8205824d651Sblueswir1 8211472a95bSJes SorensenDEF("display", HAS_ARG, QEMU_OPTION_display, 8221472a95bSJes Sorensen "-display sdl[,frame=on|off][,alt_grab=on|off][,ctrl_grab=on|off]\n" 8233264ff12SJes Sorensen " [,window_close=on|off]|curses|none|\n" 824881249c7SJan Kiszka " gtk[,grab_on_hover=on|off]|\n" 8253264ff12SJes Sorensen " vnc=<display>[,<optargs>]\n" 8261472a95bSJes Sorensen " select display type\n", QEMU_ARCH_ALL) 8271472a95bSJes SorensenSTEXI 8281472a95bSJes Sorensen@item -display @var{type} 8291472a95bSJes Sorensen@findex -display 8301472a95bSJes SorensenSelect type of display to use. This option is a replacement for the 8311472a95bSJes Sorensenold style -sdl/-curses/... options. Valid values for @var{type} are 8321472a95bSJes Sorensen@table @option 8331472a95bSJes Sorensen@item sdl 8341472a95bSJes SorensenDisplay video output via SDL (usually in a separate graphics 8351472a95bSJes Sorensenwindow; see the SDL documentation for other possibilities). 8361472a95bSJes Sorensen@item curses 8371472a95bSJes SorensenDisplay video output via curses. For graphics device models which 8381472a95bSJes Sorensensupport a text mode, QEMU can display this output using a 8391472a95bSJes Sorensencurses/ncurses interface. Nothing is displayed when the graphics 8401472a95bSJes Sorensendevice is in graphical mode or if the graphics device does not support 8411472a95bSJes Sorensena text mode. Generally only the VGA device models support text mode. 8424171d32eSJes Sorensen@item none 8434171d32eSJes SorensenDo not display video output. The guest will still see an emulated 8444171d32eSJes Sorensengraphics card, but its output will not be displayed to the QEMU 8454171d32eSJes Sorensenuser. This option differs from the -nographic option in that it 8464171d32eSJes Sorensenonly affects what is done with video output; -nographic also changes 8474171d32eSJes Sorensenthe destination of the serial and parallel port data. 848881249c7SJan Kiszka@item gtk 849881249c7SJan KiszkaDisplay video output in a GTK window. This interface provides drop-down 850881249c7SJan Kiszkamenus and other UI elements to configure and control the VM during 851881249c7SJan Kiszkaruntime. 8523264ff12SJes Sorensen@item vnc 8533264ff12SJes SorensenStart a VNC server on display <arg> 8541472a95bSJes Sorensen@end table 8551472a95bSJes SorensenETEXI 8561472a95bSJes Sorensen 8575824d651Sblueswir1DEF("nographic", 0, QEMU_OPTION_nographic, 858ad96090aSBlue Swirl "-nographic disable graphical output and redirect serial I/Os to console\n", 859ad96090aSBlue Swirl QEMU_ARCH_ALL) 8605824d651Sblueswir1STEXI 8615824d651Sblueswir1@item -nographic 8626616b2adSStefan Weil@findex -nographic 8635824d651Sblueswir1Normally, QEMU uses SDL to display the VGA output. With this option, 8645824d651Sblueswir1you can totally disable graphical output so that QEMU is a simple 8655824d651Sblueswir1command line application. The emulated serial port is redirected on 86602c4bdf1SPaolo Bonzinithe console and muxed with the monitor (unless redirected elsewhere 86702c4bdf1SPaolo Bonziniexplicitly). Therefore, you can still use QEMU to debug a Linux kernel 868b031f413SRamkumar Ramachandrawith a serial console. Use @key{C-a h} for help on switching between 869b031f413SRamkumar Ramachandrathe console and monitor. 8705824d651Sblueswir1ETEXI 8715824d651Sblueswir1 8725824d651Sblueswir1DEF("curses", 0, QEMU_OPTION_curses, 873ad96090aSBlue Swirl "-curses use a curses/ncurses interface instead of SDL\n", 874ad96090aSBlue Swirl QEMU_ARCH_ALL) 8755824d651Sblueswir1STEXI 8765824d651Sblueswir1@item -curses 877b8f490ebSMarkus Armbruster@findex -curses 8785824d651Sblueswir1Normally, QEMU uses SDL to display the VGA output. With this option, 8795824d651Sblueswir1QEMU can display the VGA output when in text mode using a 8805824d651Sblueswir1curses/ncurses interface. Nothing is displayed in graphical mode. 8815824d651Sblueswir1ETEXI 8825824d651Sblueswir1 8835824d651Sblueswir1DEF("no-frame", 0, QEMU_OPTION_no_frame, 884ad96090aSBlue Swirl "-no-frame open SDL window without a frame and window decorations\n", 885ad96090aSBlue Swirl QEMU_ARCH_ALL) 8865824d651Sblueswir1STEXI 8875824d651Sblueswir1@item -no-frame 8886616b2adSStefan Weil@findex -no-frame 8895824d651Sblueswir1Do not use decorations for SDL windows and start them using the whole 8905824d651Sblueswir1available screen space. This makes the using QEMU in a dedicated desktop 8915824d651Sblueswir1workspace more convenient. 8925824d651Sblueswir1ETEXI 8935824d651Sblueswir1 8945824d651Sblueswir1DEF("alt-grab", 0, QEMU_OPTION_alt_grab, 895ad96090aSBlue Swirl "-alt-grab use Ctrl-Alt-Shift to grab mouse (instead of Ctrl-Alt)\n", 896ad96090aSBlue Swirl QEMU_ARCH_ALL) 8975824d651Sblueswir1STEXI 8985824d651Sblueswir1@item -alt-grab 8996616b2adSStefan Weil@findex -alt-grab 900de1db2a1SBrad HardsUse Ctrl-Alt-Shift to grab mouse (instead of Ctrl-Alt). Note that this also 901de1db2a1SBrad Hardsaffects the special keys (for fullscreen, monitor-mode switching, etc). 9025824d651Sblueswir1ETEXI 9035824d651Sblueswir1 9040ca9f8a4SDustin KirklandDEF("ctrl-grab", 0, QEMU_OPTION_ctrl_grab, 905ad96090aSBlue Swirl "-ctrl-grab use Right-Ctrl to grab mouse (instead of Ctrl-Alt)\n", 906ad96090aSBlue Swirl QEMU_ARCH_ALL) 9070ca9f8a4SDustin KirklandSTEXI 9080ca9f8a4SDustin Kirkland@item -ctrl-grab 9096616b2adSStefan Weil@findex -ctrl-grab 910de1db2a1SBrad HardsUse Right-Ctrl to grab mouse (instead of Ctrl-Alt). Note that this also 911de1db2a1SBrad Hardsaffects the special keys (for fullscreen, monitor-mode switching, etc). 9120ca9f8a4SDustin KirklandETEXI 9130ca9f8a4SDustin Kirkland 9145824d651Sblueswir1DEF("no-quit", 0, QEMU_OPTION_no_quit, 915ad96090aSBlue Swirl "-no-quit disable SDL window close capability\n", QEMU_ARCH_ALL) 9165824d651Sblueswir1STEXI 9175824d651Sblueswir1@item -no-quit 9186616b2adSStefan Weil@findex -no-quit 9195824d651Sblueswir1Disable SDL window close capability. 9205824d651Sblueswir1ETEXI 9215824d651Sblueswir1 9225824d651Sblueswir1DEF("sdl", 0, QEMU_OPTION_sdl, 923ad96090aSBlue Swirl "-sdl enable SDL\n", QEMU_ARCH_ALL) 9245824d651Sblueswir1STEXI 9255824d651Sblueswir1@item -sdl 9266616b2adSStefan Weil@findex -sdl 9275824d651Sblueswir1Enable SDL. 9285824d651Sblueswir1ETEXI 9295824d651Sblueswir1 93029b0040bSGerd HoffmannDEF("spice", HAS_ARG, QEMU_OPTION_spice, 93127af7788SYonit Halperin "-spice [port=port][,tls-port=secured-port][,x509-dir=<dir>]\n" 93227af7788SYonit Halperin " [,x509-key-file=<file>][,x509-key-password=<file>]\n" 93327af7788SYonit Halperin " [,x509-cert-file=<file>][,x509-cacert-file=<file>]\n" 93427af7788SYonit Halperin " [,x509-dh-key-file=<file>][,addr=addr][,ipv4|ipv6]\n" 93527af7788SYonit Halperin " [,tls-ciphers=<list>]\n" 93627af7788SYonit Halperin " [,tls-channel=[main|display|cursor|inputs|record|playback]]\n" 93727af7788SYonit Halperin " [,plaintext-channel=[main|display|cursor|inputs|record|playback]]\n" 93827af7788SYonit Halperin " [,sasl][,password=<secret>][,disable-ticketing]\n" 93927af7788SYonit Halperin " [,image-compression=[auto_glz|auto_lz|quic|glz|lz|off]]\n" 94027af7788SYonit Halperin " [,jpeg-wan-compression=[auto|never|always]]\n" 94127af7788SYonit Halperin " [,zlib-glz-wan-compression=[auto|never|always]]\n" 94227af7788SYonit Halperin " [,streaming-video=[off|all|filter]][,disable-copy-paste]\n" 9435ad24e5fSHans de Goede " [,disable-agent-file-xfer][,agent-mouse=[on|off]]\n" 9445ad24e5fSHans de Goede " [,playback-compression=[on|off]][,seamless-migration=[on|off]]\n" 94527af7788SYonit Halperin " enable spice\n" 94627af7788SYonit Halperin " at least one of {port, tls-port} is mandatory\n", 94727af7788SYonit Halperin QEMU_ARCH_ALL) 94829b0040bSGerd HoffmannSTEXI 94929b0040bSGerd Hoffmann@item -spice @var{option}[,@var{option}[,...]] 95029b0040bSGerd Hoffmann@findex -spice 95129b0040bSGerd HoffmannEnable the spice remote desktop protocol. Valid options are 95229b0040bSGerd Hoffmann 95329b0040bSGerd Hoffmann@table @option 95429b0040bSGerd Hoffmann 95529b0040bSGerd Hoffmann@item port=<nr> 956c448e855SGerd HoffmannSet the TCP port spice is listening on for plaintext channels. 95729b0040bSGerd Hoffmann 958333b0eebSGerd Hoffmann@item addr=<addr> 959333b0eebSGerd HoffmannSet the IP address spice is listening on. Default is any address. 960333b0eebSGerd Hoffmann 961333b0eebSGerd Hoffmann@item ipv4 962333b0eebSGerd Hoffmann@item ipv6 963333b0eebSGerd HoffmannForce using the specified IP version. 964333b0eebSGerd Hoffmann 96529b0040bSGerd Hoffmann@item password=<secret> 96629b0040bSGerd HoffmannSet the password you need to authenticate. 96729b0040bSGerd Hoffmann 96848b3ed0aSMarc-André Lureau@item sasl 96948b3ed0aSMarc-André LureauRequire that the client use SASL to authenticate with the spice. 97048b3ed0aSMarc-André LureauThe exact choice of authentication method used is controlled from the 97148b3ed0aSMarc-André Lureausystem / user's SASL configuration file for the 'qemu' service. This 97248b3ed0aSMarc-André Lureauis typically found in /etc/sasl2/qemu.conf. If running QEMU as an 97348b3ed0aSMarc-André Lureauunprivileged user, an environment variable SASL_CONF_PATH can be used 97448b3ed0aSMarc-André Lureauto make it search alternate locations for the service config. 97548b3ed0aSMarc-André LureauWhile some SASL auth methods can also provide data encryption (eg GSSAPI), 97648b3ed0aSMarc-André Lureauit is recommended that SASL always be combined with the 'tls' and 97748b3ed0aSMarc-André Lureau'x509' settings to enable use of SSL and server certificates. This 97848b3ed0aSMarc-André Lureauensures a data encryption preventing compromise of authentication 97948b3ed0aSMarc-André Lureaucredentials. 98048b3ed0aSMarc-André Lureau 98129b0040bSGerd Hoffmann@item disable-ticketing 98229b0040bSGerd HoffmannAllow client connects without authentication. 98329b0040bSGerd Hoffmann 984d4970b07SHans de Goede@item disable-copy-paste 985d4970b07SHans de GoedeDisable copy paste between the client and the guest. 986d4970b07SHans de Goede 9875ad24e5fSHans de Goede@item disable-agent-file-xfer 9885ad24e5fSHans de GoedeDisable spice-vdagent based file-xfer between the client and the guest. 9895ad24e5fSHans de Goede 990c448e855SGerd Hoffmann@item tls-port=<nr> 991c448e855SGerd HoffmannSet the TCP port spice is listening on for encrypted channels. 992c448e855SGerd Hoffmann 993c448e855SGerd Hoffmann@item x509-dir=<dir> 994c448e855SGerd HoffmannSet the x509 file directory. Expects same filenames as -vnc $display,x509=$dir 995c448e855SGerd Hoffmann 996c448e855SGerd Hoffmann@item x509-key-file=<file> 997c448e855SGerd Hoffmann@item x509-key-password=<file> 998c448e855SGerd Hoffmann@item x509-cert-file=<file> 999c448e855SGerd Hoffmann@item x509-cacert-file=<file> 1000c448e855SGerd Hoffmann@item x509-dh-key-file=<file> 1001c448e855SGerd HoffmannThe x509 file names can also be configured individually. 1002c448e855SGerd Hoffmann 1003c448e855SGerd Hoffmann@item tls-ciphers=<list> 1004c448e855SGerd HoffmannSpecify which ciphers to use. 1005c448e855SGerd Hoffmann 1006d70d6b31SAlon Levy@item tls-channel=[main|display|cursor|inputs|record|playback] 1007d70d6b31SAlon Levy@item plaintext-channel=[main|display|cursor|inputs|record|playback] 100817b6dea0SGerd HoffmannForce specific channel to be used with or without TLS encryption. The 100917b6dea0SGerd Hoffmannoptions can be specified multiple times to configure multiple 101017b6dea0SGerd Hoffmannchannels. The special name "default" can be used to set the default 101117b6dea0SGerd Hoffmannmode. For channels which are not explicitly forced into one mode the 101217b6dea0SGerd Hoffmannspice client is allowed to pick tls/plaintext as he pleases. 101317b6dea0SGerd Hoffmann 10149f04e09eSYonit Halperin@item image-compression=[auto_glz|auto_lz|quic|glz|lz|off] 10159f04e09eSYonit HalperinConfigure image compression (lossless). 10169f04e09eSYonit HalperinDefault is auto_glz. 10179f04e09eSYonit Halperin 10189f04e09eSYonit Halperin@item jpeg-wan-compression=[auto|never|always] 10199f04e09eSYonit Halperin@item zlib-glz-wan-compression=[auto|never|always] 10209f04e09eSYonit HalperinConfigure wan image compression (lossy for slow links). 10219f04e09eSYonit HalperinDefault is auto. 10229f04e09eSYonit Halperin 102384a23f25SGerd Hoffmann@item streaming-video=[off|all|filter] 102484a23f25SGerd HoffmannConfigure video stream detection. Default is filter. 102584a23f25SGerd Hoffmann 102684a23f25SGerd Hoffmann@item agent-mouse=[on|off] 102784a23f25SGerd HoffmannEnable/disable passing mouse events via vdagent. Default is on. 102884a23f25SGerd Hoffmann 102984a23f25SGerd Hoffmann@item playback-compression=[on|off] 103084a23f25SGerd HoffmannEnable/disable audio stream compression (using celt 0.5.1). Default is on. 103184a23f25SGerd Hoffmann 10328c957053SYonit Halperin@item seamless-migration=[on|off] 10338c957053SYonit HalperinEnable/disable spice seamless migration. Default is off. 10348c957053SYonit Halperin 103529b0040bSGerd Hoffmann@end table 103629b0040bSGerd HoffmannETEXI 103729b0040bSGerd Hoffmann 10385824d651Sblueswir1DEF("portrait", 0, QEMU_OPTION_portrait, 1039ad96090aSBlue Swirl "-portrait rotate graphical output 90 deg left (only PXA LCD)\n", 1040ad96090aSBlue Swirl QEMU_ARCH_ALL) 10415824d651Sblueswir1STEXI 10425824d651Sblueswir1@item -portrait 10436616b2adSStefan Weil@findex -portrait 10445824d651Sblueswir1Rotate graphical output 90 deg left (only PXA LCD). 10455824d651Sblueswir1ETEXI 10465824d651Sblueswir1 10479312805dSVasily KhoruzhickDEF("rotate", HAS_ARG, QEMU_OPTION_rotate, 10489312805dSVasily Khoruzhick "-rotate <deg> rotate graphical output some deg left (only PXA LCD)\n", 10499312805dSVasily Khoruzhick QEMU_ARCH_ALL) 10509312805dSVasily KhoruzhickSTEXI 10516265c43bSMarkus Armbruster@item -rotate @var{deg} 10529312805dSVasily Khoruzhick@findex -rotate 10539312805dSVasily KhoruzhickRotate graphical output some deg left (only PXA LCD). 10549312805dSVasily KhoruzhickETEXI 10559312805dSVasily Khoruzhick 10565824d651Sblueswir1DEF("vga", HAS_ARG, QEMU_OPTION_vga, 105733632788SMark Cave-Ayland "-vga [std|cirrus|vmware|qxl|xenfb|tcx|cg3|none]\n" 1058ad96090aSBlue Swirl " select video card type\n", QEMU_ARCH_ALL) 10595824d651Sblueswir1STEXI 1060e4558dcaSmalc@item -vga @var{type} 10616616b2adSStefan Weil@findex -vga 10625824d651Sblueswir1Select type of VGA card to emulate. Valid values for @var{type} are 1063b3f046c2SKevin Wolf@table @option 10645824d651Sblueswir1@item cirrus 10655824d651Sblueswir1Cirrus Logic GD5446 Video card. All Windows versions starting from 10665824d651Sblueswir1Windows 95 should recognize and use this graphic card. For optimal 10675824d651Sblueswir1performances, use 16 bit color depth in the guest and the host OS. 10685824d651Sblueswir1(This one is the default) 10695824d651Sblueswir1@item std 10705824d651Sblueswir1Standard VGA card with Bochs VBE extensions. If your guest OS 10715824d651Sblueswir1supports the VESA 2.0 VBE extensions (e.g. Windows XP) and if you want 10725824d651Sblueswir1to use high resolution modes (>= 1280x1024x16) then you should use 10735824d651Sblueswir1this option. 10745824d651Sblueswir1@item vmware 10755824d651Sblueswir1VMWare SVGA-II compatible adapter. Use it if you have sufficiently 10765824d651Sblueswir1recent XFree86/XOrg server or Windows guest with a driver for this 10775824d651Sblueswir1card. 1078a19cbfb3SGerd Hoffmann@item qxl 1079a19cbfb3SGerd HoffmannQXL paravirtual graphic card. It is VGA compatible (including VESA 1080a19cbfb3SGerd Hoffmann2.0 VBE support). Works best with qxl guest drivers installed though. 1081a19cbfb3SGerd HoffmannRecommended choice when using the spice protocol. 108233632788SMark Cave-Ayland@item tcx 108333632788SMark Cave-Ayland(sun4m only) Sun TCX framebuffer. This is the default framebuffer for 108433632788SMark Cave-Aylandsun4m machines and offers both 8-bit and 24-bit colour depths at a 108533632788SMark Cave-Aylandfixed resolution of 1024x768. 108633632788SMark Cave-Ayland@item cg3 108733632788SMark Cave-Ayland(sun4m only) Sun cgthree framebuffer. This is a simple 8-bit framebuffer 108833632788SMark Cave-Aylandfor sun4m machines available in both 1024x768 (OpenBIOS) and 1152x900 (OBP) 108933632788SMark Cave-Aylandresolutions aimed at people wishing to run older Solaris versions. 10905824d651Sblueswir1@item none 10915824d651Sblueswir1Disable VGA card. 10925824d651Sblueswir1@end table 10935824d651Sblueswir1ETEXI 10945824d651Sblueswir1 10955824d651Sblueswir1DEF("full-screen", 0, QEMU_OPTION_full_screen, 1096ad96090aSBlue Swirl "-full-screen start in full screen\n", QEMU_ARCH_ALL) 10975824d651Sblueswir1STEXI 10985824d651Sblueswir1@item -full-screen 10996616b2adSStefan Weil@findex -full-screen 11005824d651Sblueswir1Start in full screen. 11015824d651Sblueswir1ETEXI 11025824d651Sblueswir1 11035824d651Sblueswir1DEF("g", 1, QEMU_OPTION_g , 1104ad96090aSBlue Swirl "-g WxH[xDEPTH] Set the initial graphical resolution and depth\n", 1105ad96090aSBlue Swirl QEMU_ARCH_PPC | QEMU_ARCH_SPARC) 11065824d651Sblueswir1STEXI 110795d5f08bSStefan Weil@item -g @var{width}x@var{height}[x@var{depth}] 11086616b2adSStefan Weil@findex -g 110995d5f08bSStefan WeilSet the initial graphical resolution and depth (PPC, SPARC only). 11105824d651Sblueswir1ETEXI 11115824d651Sblueswir1 11125824d651Sblueswir1DEF("vnc", HAS_ARG, QEMU_OPTION_vnc , 1113ad96090aSBlue Swirl "-vnc display start a VNC server on display\n", QEMU_ARCH_ALL) 11145824d651Sblueswir1STEXI 11155824d651Sblueswir1@item -vnc @var{display}[,@var{option}[,@var{option}[,...]]] 11166616b2adSStefan Weil@findex -vnc 11175824d651Sblueswir1Normally, QEMU uses SDL to display the VGA output. With this option, 11185824d651Sblueswir1you can have QEMU listen on VNC display @var{display} and redirect the VGA 11195824d651Sblueswir1display over the VNC session. It is very useful to enable the usb 11205824d651Sblueswir1tablet device when using this option (option @option{-usbdevice 11215824d651Sblueswir1tablet}). When using the VNC display, you must use the @option{-k} 11225824d651Sblueswir1parameter to set the keyboard layout if you are not using en-us. Valid 11235824d651Sblueswir1syntax for the @var{display} is 11245824d651Sblueswir1 1125b3f046c2SKevin Wolf@table @option 11265824d651Sblueswir1 11275824d651Sblueswir1@item @var{host}:@var{d} 11285824d651Sblueswir1 11295824d651Sblueswir1TCP connections will only be allowed from @var{host} on display @var{d}. 11305824d651Sblueswir1By convention the TCP port is 5900+@var{d}. Optionally, @var{host} can 11315824d651Sblueswir1be omitted in which case the server will accept connections from any host. 11325824d651Sblueswir1 11334e257e5eSKevin Wolf@item unix:@var{path} 11345824d651Sblueswir1 11355824d651Sblueswir1Connections will be allowed over UNIX domain sockets where @var{path} is the 11365824d651Sblueswir1location of a unix socket to listen for connections on. 11375824d651Sblueswir1 11385824d651Sblueswir1@item none 11395824d651Sblueswir1 11405824d651Sblueswir1VNC is initialized but not started. The monitor @code{change} command 11415824d651Sblueswir1can be used to later start the VNC server. 11425824d651Sblueswir1 11435824d651Sblueswir1@end table 11445824d651Sblueswir1 11455824d651Sblueswir1Following the @var{display} value there may be one or more @var{option} flags 11465824d651Sblueswir1separated by commas. Valid options are 11475824d651Sblueswir1 1148b3f046c2SKevin Wolf@table @option 11495824d651Sblueswir1 11505824d651Sblueswir1@item reverse 11515824d651Sblueswir1 11525824d651Sblueswir1Connect to a listening VNC client via a ``reverse'' connection. The 11535824d651Sblueswir1client is specified by the @var{display}. For reverse network 11545824d651Sblueswir1connections (@var{host}:@var{d},@code{reverse}), the @var{d} argument 11555824d651Sblueswir1is a TCP port number, not a display number. 11565824d651Sblueswir1 11577536ee4bSTim Hardeck@item websocket 11587536ee4bSTim Hardeck 11597536ee4bSTim HardeckOpens an additional TCP listening port dedicated to VNC Websocket connections. 1160085d8134SPeter MaydellBy definition the Websocket port is 5700+@var{display}. If @var{host} is 11617536ee4bSTim Hardeckspecified connections will only be allowed from this host. 11627536ee4bSTim HardeckAs an alternative the Websocket port could be specified by using 11637536ee4bSTim Hardeck@code{websocket}=@var{port}. 11640057a0d5STim HardeckTLS encryption for the Websocket connection is supported if the required 11650057a0d5STim Hardeckcertificates are specified with the VNC option @option{x509}. 11667536ee4bSTim Hardeck 11675824d651Sblueswir1@item password 11685824d651Sblueswir1 11695824d651Sblueswir1Require that password based authentication is used for client connections. 117086ee5bc3SMichal Novotny 117186ee5bc3SMichal NovotnyThe password must be set separately using the @code{set_password} command in 117286ee5bc3SMichal Novotnythe @ref{pcsys_monitor}. The syntax to change your password is: 117386ee5bc3SMichal Novotny@code{set_password <protocol> <password>} where <protocol> could be either 117486ee5bc3SMichal Novotny"vnc" or "spice". 117586ee5bc3SMichal Novotny 117686ee5bc3SMichal NovotnyIf you would like to change <protocol> password expiration, you should use 117786ee5bc3SMichal Novotny@code{expire_password <protocol> <expiration-time>} where expiration time could 117886ee5bc3SMichal Novotnybe one of the following options: now, never, +seconds or UNIX time of 117986ee5bc3SMichal Novotnyexpiration, e.g. +60 to make password expire in 60 seconds, or 1335196800 118086ee5bc3SMichal Novotnyto make password expire on "Mon Apr 23 12:00:00 EDT 2012" (UNIX time for this 118186ee5bc3SMichal Novotnydate and time). 118286ee5bc3SMichal Novotny 118386ee5bc3SMichal NovotnyYou can also use keywords "now" or "never" for the expiration time to 118486ee5bc3SMichal Novotnyallow <protocol> password to expire immediately or never expire. 11855824d651Sblueswir1 11865824d651Sblueswir1@item tls 11875824d651Sblueswir1 11885824d651Sblueswir1Require that client use TLS when communicating with the VNC server. This 11895824d651Sblueswir1uses anonymous TLS credentials so is susceptible to a man-in-the-middle 11905824d651Sblueswir1attack. It is recommended that this option be combined with either the 11914e257e5eSKevin Wolf@option{x509} or @option{x509verify} options. 11925824d651Sblueswir1 11935824d651Sblueswir1@item x509=@var{/path/to/certificate/dir} 11945824d651Sblueswir1 11955824d651Sblueswir1Valid if @option{tls} is specified. Require that x509 credentials are used 11965824d651Sblueswir1for negotiating the TLS session. The server will send its x509 certificate 11975824d651Sblueswir1to the client. It is recommended that a password be set on the VNC server 11985824d651Sblueswir1to provide authentication of the client when this is used. The path following 11995824d651Sblueswir1this option specifies where the x509 certificates are to be loaded from. 12005824d651Sblueswir1See the @ref{vnc_security} section for details on generating certificates. 12015824d651Sblueswir1 12025824d651Sblueswir1@item x509verify=@var{/path/to/certificate/dir} 12035824d651Sblueswir1 12045824d651Sblueswir1Valid if @option{tls} is specified. Require that x509 credentials are used 12055824d651Sblueswir1for negotiating the TLS session. The server will send its x509 certificate 12065824d651Sblueswir1to the client, and request that the client send its own x509 certificate. 12075824d651Sblueswir1The server will validate the client's certificate against the CA certificate, 12085824d651Sblueswir1and reject clients when validation fails. If the certificate authority is 12095824d651Sblueswir1trusted, this is a sufficient authentication mechanism. You may still wish 12105824d651Sblueswir1to set a password on the VNC server as a second authentication layer. The 12115824d651Sblueswir1path following this option specifies where the x509 certificates are to 12125824d651Sblueswir1be loaded from. See the @ref{vnc_security} section for details on generating 12135824d651Sblueswir1certificates. 12145824d651Sblueswir1 12155824d651Sblueswir1@item sasl 12165824d651Sblueswir1 12175824d651Sblueswir1Require that the client use SASL to authenticate with the VNC server. 12185824d651Sblueswir1The exact choice of authentication method used is controlled from the 12195824d651Sblueswir1system / user's SASL configuration file for the 'qemu' service. This 12205824d651Sblueswir1is typically found in /etc/sasl2/qemu.conf. If running QEMU as an 12215824d651Sblueswir1unprivileged user, an environment variable SASL_CONF_PATH can be used 12225824d651Sblueswir1to make it search alternate locations for the service config. 12235824d651Sblueswir1While some SASL auth methods can also provide data encryption (eg GSSAPI), 12245824d651Sblueswir1it is recommended that SASL always be combined with the 'tls' and 12255824d651Sblueswir1'x509' settings to enable use of SSL and server certificates. This 12265824d651Sblueswir1ensures a data encryption preventing compromise of authentication 12275824d651Sblueswir1credentials. See the @ref{vnc_security} section for details on using 12285824d651Sblueswir1SASL authentication. 12295824d651Sblueswir1 12305824d651Sblueswir1@item acl 12315824d651Sblueswir1 12325824d651Sblueswir1Turn on access control lists for checking of the x509 client certificate 12335824d651Sblueswir1and SASL party. For x509 certs, the ACL check is made against the 12345824d651Sblueswir1certificate's distinguished name. This is something that looks like 12355824d651Sblueswir1@code{C=GB,O=ACME,L=Boston,CN=bob}. For SASL party, the ACL check is 12365824d651Sblueswir1made against the username, which depending on the SASL plugin, may 12375824d651Sblueswir1include a realm component, eg @code{bob} or @code{bob@@EXAMPLE.COM}. 12385824d651Sblueswir1When the @option{acl} flag is set, the initial access list will be 12395824d651Sblueswir1empty, with a @code{deny} policy. Thus no one will be allowed to 12405824d651Sblueswir1use the VNC server until the ACLs have been loaded. This can be 12415824d651Sblueswir1achieved using the @code{acl} monitor command. 12425824d651Sblueswir1 12436f9c78c1SCorentin Chary@item lossy 12446f9c78c1SCorentin Chary 12456f9c78c1SCorentin CharyEnable lossy compression methods (gradient, JPEG, ...). If this 12466f9c78c1SCorentin Charyoption is set, VNC client may receive lossy framebuffer updates 12476f9c78c1SCorentin Charydepending on its encoding settings. Enabling this option can save 12486f9c78c1SCorentin Charya lot of bandwidth at the expense of quality. 12496f9c78c1SCorentin Chary 125080e0c8c3SCorentin Chary@item non-adaptive 125180e0c8c3SCorentin Chary 125280e0c8c3SCorentin CharyDisable adaptive encodings. Adaptive encodings are enabled by default. 125380e0c8c3SCorentin CharyAn adaptive encoding will try to detect frequently updated screen regions, 125480e0c8c3SCorentin Charyand send updates in these regions using a lossy encoding (like JPEG). 125561cc8701SStefan WeilThis can be really helpful to save bandwidth when playing videos. Disabling 12569d85d557SMichael Tokarevadaptive encodings restores the original static behavior of encodings 125780e0c8c3SCorentin Charylike Tight. 125880e0c8c3SCorentin Chary 12598cf36489SGerd Hoffmann@item share=[allow-exclusive|force-shared|ignore] 12608cf36489SGerd Hoffmann 12618cf36489SGerd HoffmannSet display sharing policy. 'allow-exclusive' allows clients to ask 12628cf36489SGerd Hoffmannfor exclusive access. As suggested by the rfb spec this is 12638cf36489SGerd Hoffmannimplemented by dropping other connections. Connecting multiple 12648cf36489SGerd Hoffmannclients in parallel requires all clients asking for a shared session 12658cf36489SGerd Hoffmann(vncviewer: -shared switch). This is the default. 'force-shared' 12668cf36489SGerd Hoffmanndisables exclusive client access. Useful for shared desktop sessions, 12678cf36489SGerd Hoffmannwhere you don't want someone forgetting specify -shared disconnect 12688cf36489SGerd Hoffmanneverybody else. 'ignore' completely ignores the shared flag and 12698cf36489SGerd Hoffmannallows everybody connect unconditionally. Doesn't conform to the rfb 1270b65ee4faSStefan Weilspec but is traditional QEMU behavior. 12718cf36489SGerd Hoffmann 12725824d651Sblueswir1@end table 12735824d651Sblueswir1ETEXI 12745824d651Sblueswir1 12755824d651Sblueswir1STEXI 12765824d651Sblueswir1@end table 12775824d651Sblueswir1ETEXI 1278a3adb7adSMichael EllermanARCHHEADING(, QEMU_ARCH_I386) 12795824d651Sblueswir1 1280a3adb7adSMichael EllermanARCHHEADING(i386 target only:, QEMU_ARCH_I386) 12815824d651Sblueswir1STEXI 12825824d651Sblueswir1@table @option 12835824d651Sblueswir1ETEXI 12845824d651Sblueswir1 12855824d651Sblueswir1DEF("win2k-hack", 0, QEMU_OPTION_win2k_hack, 1286ad96090aSBlue Swirl "-win2k-hack use it when installing Windows 2000 to avoid a disk full bug\n", 1287ad96090aSBlue Swirl QEMU_ARCH_I386) 12885824d651Sblueswir1STEXI 12895824d651Sblueswir1@item -win2k-hack 12906616b2adSStefan Weil@findex -win2k-hack 12915824d651Sblueswir1Use it when installing Windows 2000 to avoid a disk full bug. After 12925824d651Sblueswir1Windows 2000 is installed, you no longer need this option (this option 12935824d651Sblueswir1slows down the IDE transfers). 12945824d651Sblueswir1ETEXI 12955824d651Sblueswir1 12961ed2fc1fSJan KiszkaHXCOMM Deprecated by -rtc 1297ad96090aSBlue SwirlDEF("rtc-td-hack", 0, QEMU_OPTION_rtc_td_hack, "", QEMU_ARCH_I386) 12985824d651Sblueswir1 12995824d651Sblueswir1DEF("no-fd-bootchk", 0, QEMU_OPTION_no_fd_bootchk, 1300ad96090aSBlue Swirl "-no-fd-bootchk disable boot signature checking for floppy disks\n", 1301ad96090aSBlue Swirl QEMU_ARCH_I386) 13025824d651Sblueswir1STEXI 13035824d651Sblueswir1@item -no-fd-bootchk 13046616b2adSStefan Weil@findex -no-fd-bootchk 13054eda32f5SMarkus ArmbrusterDisable boot signature checking for floppy disks in BIOS. May 13065824d651Sblueswir1be needed to boot from old floppy disks. 13075824d651Sblueswir1ETEXI 13085824d651Sblueswir1 13095824d651Sblueswir1DEF("no-acpi", 0, QEMU_OPTION_no_acpi, 1310ad96090aSBlue Swirl "-no-acpi disable ACPI\n", QEMU_ARCH_I386) 13115824d651Sblueswir1STEXI 13125824d651Sblueswir1@item -no-acpi 13136616b2adSStefan Weil@findex -no-acpi 13145824d651Sblueswir1Disable ACPI (Advanced Configuration and Power Interface) support. Use 13155824d651Sblueswir1it if your guest OS complains about ACPI problems (PC target machine 13165824d651Sblueswir1only). 13175824d651Sblueswir1ETEXI 13185824d651Sblueswir1 13195824d651Sblueswir1DEF("no-hpet", 0, QEMU_OPTION_no_hpet, 1320ad96090aSBlue Swirl "-no-hpet disable HPET\n", QEMU_ARCH_I386) 13215824d651Sblueswir1STEXI 13225824d651Sblueswir1@item -no-hpet 13236616b2adSStefan Weil@findex -no-hpet 13245824d651Sblueswir1Disable HPET support. 13255824d651Sblueswir1ETEXI 13265824d651Sblueswir1 13275824d651Sblueswir1DEF("acpitable", HAS_ARG, QEMU_OPTION_acpitable, 1328104bf02eSMichael Tokarev "-acpitable [sig=str][,rev=n][,oem_id=str][,oem_table_id=str][,oem_rev=n][,asl_compiler_id=str][,asl_compiler_rev=n][,{data|file}=file1[:file2]...]\n" 1329ad96090aSBlue Swirl " ACPI table description\n", QEMU_ARCH_I386) 13305824d651Sblueswir1STEXI 13315824d651Sblueswir1@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}]...] 13326616b2adSStefan Weil@findex -acpitable 13335824d651Sblueswir1Add ACPI table with specified header fields and context from specified files. 1334104bf02eSMichael TokarevFor file=, take whole ACPI table from the specified files, including all 1335104bf02eSMichael TokarevACPI headers (possible overridden by other options). 1336104bf02eSMichael TokarevFor data=, only data 1337104bf02eSMichael Tokarevportion of the table is used, all header information is specified in the 1338104bf02eSMichael Tokarevcommand line. 13395824d651Sblueswir1ETEXI 13405824d651Sblueswir1 1341b6f6e3d3SaliguoriDEF("smbios", HAS_ARG, QEMU_OPTION_smbios, 1342b6f6e3d3Saliguori "-smbios file=binary\n" 1343ca1a8a06SBruce Rogers " load SMBIOS entry from binary file\n" 1344e8105ebbSPaolo Bonzini "-smbios type=0[,vendor=str][,version=str][,date=str][,release=%d.%d]\n" 1345ca1a8a06SBruce Rogers " specify SMBIOS type 0 fields\n" 1346b6f6e3d3Saliguori "-smbios type=1[,manufacturer=str][,product=str][,version=str][,serial=str]\n" 1347b6f6e3d3Saliguori " [,uuid=uuid][,sku=str][,family=str]\n" 1348ad96090aSBlue Swirl " specify SMBIOS type 1 fields\n", QEMU_ARCH_I386) 1349b6f6e3d3SaliguoriSTEXI 1350b6f6e3d3Saliguori@item -smbios file=@var{binary} 13516616b2adSStefan Weil@findex -smbios 1352b6f6e3d3SaliguoriLoad SMBIOS entry from binary file. 1353b6f6e3d3Saliguori 1354b6f6e3d3Saliguori@item -smbios type=0[,vendor=@var{str}][,version=@var{str}][,date=@var{str}][,release=@var{%d.%d}] 1355b6f6e3d3SaliguoriSpecify SMBIOS type 0 fields 1356b6f6e3d3Saliguori 1357b6f6e3d3Saliguori@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}] 1358b6f6e3d3SaliguoriSpecify SMBIOS type 1 fields 1359b6f6e3d3SaliguoriETEXI 1360b6f6e3d3Saliguori 13615824d651Sblueswir1STEXI 13625824d651Sblueswir1@end table 13635824d651Sblueswir1ETEXI 1364c70a01e4SMarkus ArmbrusterDEFHEADING() 13655824d651Sblueswir1 13665824d651Sblueswir1DEFHEADING(Network options:) 13675824d651Sblueswir1STEXI 13685824d651Sblueswir1@table @option 13695824d651Sblueswir1ETEXI 13705824d651Sblueswir1 1371ad196a9dSJan KiszkaHXCOMM Legacy slirp options (now moved to -net user): 1372ad196a9dSJan Kiszka#ifdef CONFIG_SLIRP 1373ad96090aSBlue SwirlDEF("tftp", HAS_ARG, QEMU_OPTION_tftp, "", QEMU_ARCH_ALL) 1374ad96090aSBlue SwirlDEF("bootp", HAS_ARG, QEMU_OPTION_bootp, "", QEMU_ARCH_ALL) 1375ad96090aSBlue SwirlDEF("redir", HAS_ARG, QEMU_OPTION_redir, "", QEMU_ARCH_ALL) 1376ad196a9dSJan Kiszka#ifndef _WIN32 1377ad96090aSBlue SwirlDEF("smb", HAS_ARG, QEMU_OPTION_smb, "", QEMU_ARCH_ALL) 1378ad196a9dSJan Kiszka#endif 1379ad196a9dSJan Kiszka#endif 1380ad196a9dSJan Kiszka 1381bab7944cSBlue SwirlDEF("net", HAS_ARG, QEMU_OPTION_net, 1382ffe6370cSMichael S. Tsirkin "-net nic[,vlan=n][,macaddr=mac][,model=type][,name=str][,addr=str][,vectors=v]\n" 13835824d651Sblueswir1 " create a new Network Interface Card and connect it to VLAN 'n'\n" 13845824d651Sblueswir1#ifdef CONFIG_SLIRP 1385c54ed5bcSJan Kiszka "-net user[,vlan=n][,name=str][,net=addr[/mask]][,host=addr][,restrict=on|off]\n" 138663d2960bSKlaus Stengel " [,hostname=host][,dhcpstart=addr][,dns=addr][,dnssearch=domain][,tftp=dir]\n" 138763d2960bSKlaus Stengel " [,bootfile=f][,hostfwd=rule][,guestfwd=rule]" 1388ad196a9dSJan Kiszka#ifndef _WIN32 1389c92ef6a2SJan Kiszka "[,smb=dir[,smbserver=addr]]\n" 1390ad196a9dSJan Kiszka#endif 1391ad196a9dSJan Kiszka " connect the user mode network stack to VLAN 'n', configure its\n" 1392ad196a9dSJan Kiszka " DHCP server and enabled optional services\n" 13935824d651Sblueswir1#endif 13945824d651Sblueswir1#ifdef _WIN32 13955824d651Sblueswir1 "-net tap[,vlan=n][,name=str],ifname=name\n" 13965824d651Sblueswir1 " connect the host TAP network interface to VLAN 'n'\n" 13975824d651Sblueswir1#else 1398ec396014SJason Wang "-net tap[,vlan=n][,name=str][,fd=h][,fds=x:y:...:z][,ifname=name][,script=file][,downscript=dfile][,helper=helper][,sndbuf=nbytes][,vnet_hdr=on|off][,vhost=on|off][,vhostfd=h][,vhostfds=x:y:...:z][,vhostforce=on|off][,queues=n]\n" 1399a7c36ee4SCorey Bryant " connect the host TAP network interface to VLAN 'n'\n" 1400a7c36ee4SCorey Bryant " use network scripts 'file' (default=" DEFAULT_NETWORK_SCRIPT ")\n" 1401a7c36ee4SCorey Bryant " to configure it and 'dfile' (default=" DEFAULT_NETWORK_DOWN_SCRIPT ")\n" 1402a7c36ee4SCorey Bryant " to deconfigure it\n" 1403ca1a8a06SBruce Rogers " use '[down]script=no' to disable script execution\n" 1404a7c36ee4SCorey Bryant " use network helper 'helper' (default=" DEFAULT_BRIDGE_HELPER ") to\n" 1405a7c36ee4SCorey Bryant " configure it\n" 14065824d651Sblueswir1 " use 'fd=h' to connect to an already opened TAP interface\n" 14072ca81baaSJason Wang " use 'fds=x:y:...:z' to connect to already opened multiqueue capable TAP interfaces\n" 1408ca1a8a06SBruce Rogers " use 'sndbuf=nbytes' to limit the size of the send buffer (the\n" 1409f157ed20SMichael S. Tsirkin " default is disabled 'sndbuf=0' to enable flow control set 'sndbuf=1048576')\n" 1410ca1a8a06SBruce Rogers " use vnet_hdr=off to avoid enabling the IFF_VNET_HDR tap flag\n" 1411ca1a8a06SBruce Rogers " use vnet_hdr=on to make the lack of IFF_VNET_HDR support an error condition\n" 141282b0d80eSMichael S. Tsirkin " use vhost=on to enable experimental in kernel accelerator\n" 14135430a28fSmst@redhat.com " (only has effect for virtio guests which use MSIX)\n" 14145430a28fSmst@redhat.com " use vhostforce=on to force vhost on for non-MSIX virtio guests\n" 141582b0d80eSMichael S. Tsirkin " use 'vhostfd=h' to connect to an already opened vhost net device\n" 14162ca81baaSJason Wang " use 'vhostfds=x:y:...:z to connect to multiple already opened vhost net devices\n" 1417ec396014SJason Wang " use 'queues=n' to specify the number of queues to be created for multiqueue TAP\n" 1418a7c36ee4SCorey Bryant "-net bridge[,vlan=n][,name=str][,br=bridge][,helper=helper]\n" 1419a7c36ee4SCorey Bryant " connects a host TAP network interface to a host bridge device 'br'\n" 1420a7c36ee4SCorey Bryant " (default=" DEFAULT_BRIDGE_INTERFACE ") using the program 'helper'\n" 1421a7c36ee4SCorey Bryant " (default=" DEFAULT_BRIDGE_HELPER ")\n" 14220df0ff6dSMark McLoughlin#endif 14235824d651Sblueswir1 "-net socket[,vlan=n][,name=str][,fd=h][,listen=[host]:port][,connect=host:port]\n" 14245824d651Sblueswir1 " connect the vlan 'n' to another VLAN using a socket connection\n" 14253a75e74cSMike Ryan "-net socket[,vlan=n][,name=str][,fd=h][,mcast=maddr:port[,localaddr=addr]]\n" 14265824d651Sblueswir1 " connect the vlan 'n' to multicast maddr and port\n" 14273a75e74cSMike Ryan " use 'localaddr=addr' to specify the host address to send packets from\n" 14280e0e7facSBenjamin "-net socket[,vlan=n][,name=str][,fd=h][,udp=host:port][,localaddr=host:port]\n" 14290e0e7facSBenjamin " connect the vlan 'n' to another VLAN using an UDP tunnel\n" 14305824d651Sblueswir1#ifdef CONFIG_VDE 14315824d651Sblueswir1 "-net vde[,vlan=n][,name=str][,sock=socketpath][,port=n][,group=groupname][,mode=octalmode]\n" 14325824d651Sblueswir1 " connect the vlan 'n' to port 'n' of a vde switch running\n" 14335824d651Sblueswir1 " on host and listening for incoming connections on 'socketpath'.\n" 14345824d651Sblueswir1 " Use group 'groupname' and mode 'octalmode' to change default\n" 14355824d651Sblueswir1 " ownership and permissions for communication port.\n" 14365824d651Sblueswir1#endif 143758952137SVincenzo Maffione#ifdef CONFIG_NETMAP 143858952137SVincenzo Maffione "-net netmap,ifname=name[,devname=nmname]\n" 143958952137SVincenzo Maffione " attach to the existing netmap-enabled network interface 'name', or to a\n" 144058952137SVincenzo Maffione " VALE port (created on the fly) called 'name' ('nmname' is name of the \n" 144158952137SVincenzo Maffione " netmap device, defaults to '/dev/netmap')\n" 144258952137SVincenzo Maffione#endif 1443bb9ea79eSaliguori "-net dump[,vlan=n][,file=f][,len=n]\n" 1444bb9ea79eSaliguori " dump traffic on vlan 'n' to file 'f' (max n bytes per packet)\n" 1445ca1a8a06SBruce Rogers "-net none use it alone to have zero network devices. If no -net option\n" 1446ad96090aSBlue Swirl " is provided, the default is '-net nic -net user'\n", QEMU_ARCH_ALL) 1447a1ea458fSMark McLoughlinDEF("netdev", HAS_ARG, QEMU_OPTION_netdev, 1448a1ea458fSMark McLoughlin "-netdev [" 1449a1ea458fSMark McLoughlin#ifdef CONFIG_SLIRP 1450a1ea458fSMark McLoughlin "user|" 1451a1ea458fSMark McLoughlin#endif 1452a1ea458fSMark McLoughlin "tap|" 1453a7c36ee4SCorey Bryant "bridge|" 1454a1ea458fSMark McLoughlin#ifdef CONFIG_VDE 1455a1ea458fSMark McLoughlin "vde|" 1456a1ea458fSMark McLoughlin#endif 145758952137SVincenzo Maffione#ifdef CONFIG_NETMAP 145858952137SVincenzo Maffione "netmap|" 145958952137SVincenzo Maffione#endif 146040e8c26dSStefan Hajnoczi "socket|" 146140e8c26dSStefan Hajnoczi "hubport],id=str[,option][,option][,...]\n", QEMU_ARCH_ALL) 14625824d651Sblueswir1STEXI 1463ffe6370cSMichael S. Tsirkin@item -net nic[,vlan=@var{n}][,macaddr=@var{mac}][,model=@var{type}] [,name=@var{name}][,addr=@var{addr}][,vectors=@var{v}] 14646616b2adSStefan Weil@findex -net 14655824d651Sblueswir1Create a new Network Interface Card and connect it to VLAN @var{n} (@var{n} 14660d6b0b1dSAnthony Liguori= 0 is the default). The NIC is an e1000 by default on the PC 14675607c388SMarkus Armbrustertarget. Optionally, the MAC address can be changed to @var{mac}, the 14685607c388SMarkus Armbrusterdevice address set to @var{addr} (PCI cards only), 1469ffe6370cSMichael S. Tsirkinand a @var{name} can be assigned for use in monitor commands. 1470ffe6370cSMichael S. TsirkinOptionally, for PCI cards, you can specify the number @var{v} of MSI-X vectors 1471ffe6370cSMichael S. Tsirkinthat the card should have; this option currently only affects virtio cards; set 1472ffe6370cSMichael S. Tsirkin@var{v} = 0 to disable MSI-X. If no @option{-net} option is specified, a single 1473071c9394SStefan WeilNIC is created. QEMU can emulate several different models of network card. 14745824d651Sblueswir1Valid values for @var{type} are 1475ffe6370cSMichael S. Tsirkin@code{virtio}, @code{i82551}, @code{i82557b}, @code{i82559er}, 14765824d651Sblueswir1@code{ne2k_pci}, @code{ne2k_isa}, @code{pcnet}, @code{rtl8139}, 14775824d651Sblueswir1@code{e1000}, @code{smc91c111}, @code{lance} and @code{mcf_fec}. 1478585f6036SPeter MaydellNot all devices are supported on all targets. Use @code{-net nic,model=help} 14795824d651Sblueswir1for a list of available devices for your target. 14805824d651Sblueswir1 148108d12022SStefan Hajnoczi@item -netdev user,id=@var{id}[,@var{option}][,@var{option}][,...] 1482b8f490ebSMarkus Armbruster@findex -netdev 1483ad196a9dSJan Kiszka@item -net user[,@var{option}][,@var{option}][,...] 14845824d651Sblueswir1Use the user mode network stack which requires no administrator 1485ad196a9dSJan Kiszkaprivilege to run. Valid options are: 14865824d651Sblueswir1 1487b3f046c2SKevin Wolf@table @option 1488ad196a9dSJan Kiszka@item vlan=@var{n} 1489ad196a9dSJan KiszkaConnect user mode stack to VLAN @var{n} (@var{n} = 0 is the default). 1490ad196a9dSJan Kiszka 149108d12022SStefan Hajnoczi@item id=@var{id} 1492ad196a9dSJan Kiszka@item name=@var{name} 1493ad196a9dSJan KiszkaAssign symbolic name for use in monitor commands. 1494ad196a9dSJan Kiszka 1495c92ef6a2SJan Kiszka@item net=@var{addr}[/@var{mask}] 1496c92ef6a2SJan KiszkaSet IP network address the guest will see. Optionally specify the netmask, 1497c92ef6a2SJan Kiszkaeither in the form a.b.c.d or as number of valid top-most bits. Default is 1498b0b36e5dSBrad Hards10.0.2.0/24. 1499c92ef6a2SJan Kiszka 1500c92ef6a2SJan Kiszka@item host=@var{addr} 1501c92ef6a2SJan KiszkaSpecify the guest-visible address of the host. Default is the 2nd IP in the 1502c92ef6a2SJan Kiszkaguest network, i.e. x.x.x.2. 1503ad196a9dSJan Kiszka 1504c54ed5bcSJan Kiszka@item restrict=on|off 1505caef55edSBrad HardsIf this option is enabled, the guest will be isolated, i.e. it will not be 1506ad196a9dSJan Kiszkaable to contact the host and no guest IP packets will be routed over the host 1507caef55edSBrad Hardsto the outside. This option does not affect any explicitly set forwarding rules. 1508ad196a9dSJan Kiszka 1509ad196a9dSJan Kiszka@item hostname=@var{name} 151063d2960bSKlaus StengelSpecifies the client hostname reported by the built-in DHCP server. 1511ad196a9dSJan Kiszka 1512c92ef6a2SJan Kiszka@item dhcpstart=@var{addr} 1513c92ef6a2SJan KiszkaSpecify the first of the 16 IPs the built-in DHCP server can assign. Default 1514b0b36e5dSBrad Hardsis the 15th to 31st IP in the guest network, i.e. x.x.x.15 to x.x.x.31. 1515c92ef6a2SJan Kiszka 1516c92ef6a2SJan Kiszka@item dns=@var{addr} 1517c92ef6a2SJan KiszkaSpecify the guest-visible address of the virtual nameserver. The address must 1518c92ef6a2SJan Kiszkabe different from the host address. Default is the 3rd IP in the guest network, 1519c92ef6a2SJan Kiszkai.e. x.x.x.3. 1520c92ef6a2SJan Kiszka 152163d2960bSKlaus Stengel@item dnssearch=@var{domain} 152263d2960bSKlaus StengelProvides an entry for the domain-search list sent by the built-in 152363d2960bSKlaus StengelDHCP server. More than one domain suffix can be transmitted by specifying 152463d2960bSKlaus Stengelthis option multiple times. If supported, this will cause the guest to 152563d2960bSKlaus Stengelautomatically try to append the given domain suffix(es) in case a domain name 152663d2960bSKlaus Stengelcan not be resolved. 152763d2960bSKlaus Stengel 152863d2960bSKlaus StengelExample: 152963d2960bSKlaus Stengel@example 153063d2960bSKlaus Stengelqemu -net user,dnssearch=mgmt.example.org,dnssearch=example.org [...] 153163d2960bSKlaus Stengel@end example 153263d2960bSKlaus Stengel 1533ad196a9dSJan Kiszka@item tftp=@var{dir} 1534ad196a9dSJan KiszkaWhen using the user mode network stack, activate a built-in TFTP 1535ad196a9dSJan Kiszkaserver. The files in @var{dir} will be exposed as the root of a TFTP server. 1536ad196a9dSJan KiszkaThe TFTP client on the guest must be configured in binary mode (use the command 1537c92ef6a2SJan Kiszka@code{bin} of the Unix TFTP client). 1538ad196a9dSJan Kiszka 1539ad196a9dSJan Kiszka@item bootfile=@var{file} 1540ad196a9dSJan KiszkaWhen using the user mode network stack, broadcast @var{file} as the BOOTP 1541ad196a9dSJan Kiszkafilename. In conjunction with @option{tftp}, this can be used to network boot 1542ad196a9dSJan Kiszkaa guest from a local directory. 1543ad196a9dSJan Kiszka 1544ad196a9dSJan KiszkaExample (using pxelinux): 1545ad196a9dSJan Kiszka@example 15463804da9dSStefan Weilqemu-system-i386 -hda linux.img -boot n -net user,tftp=/path/to/tftp/files,bootfile=/pxelinux.0 1547ad196a9dSJan Kiszka@end example 1548ad196a9dSJan Kiszka 1549c92ef6a2SJan Kiszka@item smb=@var{dir}[,smbserver=@var{addr}] 1550ad196a9dSJan KiszkaWhen using the user mode network stack, activate a built-in SMB 1551ad196a9dSJan Kiszkaserver so that Windows OSes can access to the host files in @file{@var{dir}} 1552c92ef6a2SJan Kiszkatransparently. The IP address of the SMB server can be set to @var{addr}. By 1553c92ef6a2SJan Kiszkadefault the 4th IP in the guest network is used, i.e. x.x.x.4. 1554ad196a9dSJan Kiszka 1555ad196a9dSJan KiszkaIn the guest Windows OS, the line: 1556ad196a9dSJan Kiszka@example 1557ad196a9dSJan Kiszka10.0.2.4 smbserver 1558ad196a9dSJan Kiszka@end example 1559ad196a9dSJan Kiszkamust be added in the file @file{C:\WINDOWS\LMHOSTS} (for windows 9x/Me) 1560ad196a9dSJan Kiszkaor @file{C:\WINNT\SYSTEM32\DRIVERS\ETC\LMHOSTS} (Windows NT/2000). 1561ad196a9dSJan Kiszka 1562ad196a9dSJan KiszkaThen @file{@var{dir}} can be accessed in @file{\\smbserver\qemu}. 1563ad196a9dSJan Kiszka 1564e2d8830eSBradNote that a SAMBA server must be installed on the host OS. 1565e2d8830eSBradQEMU was tested successfully with smbd versions from Red Hat 9, 1566e2d8830eSBradFedora Core 3 and OpenSUSE 11.x. 1567ad196a9dSJan Kiszka 15683c6a0580SJan Kiszka@item hostfwd=[tcp|udp]:[@var{hostaddr}]:@var{hostport}-[@var{guestaddr}]:@var{guestport} 1569c92ef6a2SJan KiszkaRedirect incoming TCP or UDP connections to the host port @var{hostport} to 1570c92ef6a2SJan Kiszkathe guest IP address @var{guestaddr} on guest port @var{guestport}. If 1571c92ef6a2SJan Kiszka@var{guestaddr} is not specified, its value is x.x.x.15 (default first address 15723c6a0580SJan Kiszkagiven by the built-in DHCP server). By specifying @var{hostaddr}, the rule can 15733c6a0580SJan Kiszkabe bound to a specific host interface. If no connection type is set, TCP is 1574c92ef6a2SJan Kiszkaused. This option can be given multiple times. 1575ad196a9dSJan Kiszka 1576ad196a9dSJan KiszkaFor example, to redirect host X11 connection from screen 1 to guest 1577ad196a9dSJan Kiszkascreen 0, use the following: 1578ad196a9dSJan Kiszka 1579ad196a9dSJan Kiszka@example 1580ad196a9dSJan Kiszka# on the host 15813804da9dSStefan Weilqemu-system-i386 -net user,hostfwd=tcp:127.0.0.1:6001-:6000 [...] 1582ad196a9dSJan Kiszka# this host xterm should open in the guest X11 server 1583ad196a9dSJan Kiszkaxterm -display :1 1584ad196a9dSJan Kiszka@end example 1585ad196a9dSJan Kiszka 1586ad196a9dSJan KiszkaTo redirect telnet connections from host port 5555 to telnet port on 1587ad196a9dSJan Kiszkathe guest, use the following: 1588ad196a9dSJan Kiszka 1589ad196a9dSJan Kiszka@example 1590ad196a9dSJan Kiszka# on the host 15913804da9dSStefan Weilqemu-system-i386 -net user,hostfwd=tcp::5555-:23 [...] 1592ad196a9dSJan Kiszkatelnet localhost 5555 1593ad196a9dSJan Kiszka@end example 1594ad196a9dSJan Kiszka 1595ad196a9dSJan KiszkaThen when you use on the host @code{telnet localhost 5555}, you 1596ad196a9dSJan Kiszkaconnect to the guest telnet server. 1597ad196a9dSJan Kiszka 1598c92ef6a2SJan Kiszka@item guestfwd=[tcp]:@var{server}:@var{port}-@var{dev} 1599b412eb61SAlexander Graf@item guestfwd=[tcp]:@var{server}:@var{port}-@var{cmd:command} 16003c6a0580SJan KiszkaForward guest TCP connections to the IP address @var{server} on port @var{port} 1601b412eb61SAlexander Grafto the character device @var{dev} or to a program executed by @var{cmd:command} 1602b412eb61SAlexander Grafwhich gets spawned for each connection. This option can be given multiple times. 1603b412eb61SAlexander Graf 160443ffe61fSStefan WeilYou can either use a chardev directly and have that one used throughout QEMU's 1605b412eb61SAlexander Graflifetime, like in the following example: 1606b412eb61SAlexander Graf 1607b412eb61SAlexander Graf@example 1608b412eb61SAlexander Graf# open 10.10.1.1:4321 on bootup, connect 10.0.2.100:1234 to it whenever 1609b412eb61SAlexander Graf# the guest accesses it 1610b412eb61SAlexander Grafqemu -net user,guestfwd=tcp:10.0.2.100:1234-tcp:10.10.1.1:4321 [...] 1611b412eb61SAlexander Graf@end example 1612b412eb61SAlexander Graf 1613b412eb61SAlexander GrafOr you can execute a command on every TCP connection established by the guest, 161443ffe61fSStefan Weilso that QEMU behaves similar to an inetd process for that virtual server: 1615b412eb61SAlexander Graf 1616b412eb61SAlexander Graf@example 1617b412eb61SAlexander Graf# call "netcat 10.10.1.1 4321" on every TCP connection to 10.0.2.100:1234 1618b412eb61SAlexander Graf# and connect the TCP stream to its stdin/stdout 1619b412eb61SAlexander Grafqemu -net 'user,guestfwd=tcp:10.0.2.100:1234-cmd:netcat 10.10.1.1 4321' 1620b412eb61SAlexander Graf@end example 1621ad196a9dSJan Kiszka 1622ad196a9dSJan Kiszka@end table 1623ad196a9dSJan Kiszka 1624ad196a9dSJan KiszkaNote: Legacy stand-alone options -tftp, -bootp, -smb and -redir are still 1625ad196a9dSJan Kiszkaprocessed and applied to -net user. Mixing them with the new configuration 1626ad196a9dSJan Kiszkasyntax gives undefined results. Their use for new applications is discouraged 1627ad196a9dSJan Kiszkaas they will be removed from future versions. 16285824d651Sblueswir1 162908d12022SStefan Hajnoczi@item -netdev tap,id=@var{id}[,fd=@var{h}][,ifname=@var{name}][,script=@var{file}][,downscript=@var{dfile}][,helper=@var{helper}] 1630a7c36ee4SCorey Bryant@item -net tap[,vlan=@var{n}][,name=@var{name}][,fd=@var{h}][,ifname=@var{name}][,script=@var{file}][,downscript=@var{dfile}][,helper=@var{helper}] 1631a7c36ee4SCorey BryantConnect the host TAP network interface @var{name} to VLAN @var{n}. 1632a7c36ee4SCorey Bryant 1633a7c36ee4SCorey BryantUse the network script @var{file} to configure it and the network script 16345824d651Sblueswir1@var{dfile} to deconfigure it. If @var{name} is not provided, the OS 1635a7c36ee4SCorey Bryantautomatically provides one. The default network configure script is 1636a7c36ee4SCorey Bryant@file{/etc/qemu-ifup} and the default network deconfigure script is 1637a7c36ee4SCorey Bryant@file{/etc/qemu-ifdown}. Use @option{script=no} or @option{downscript=no} 1638a7c36ee4SCorey Bryantto disable script execution. 1639a7c36ee4SCorey Bryant 1640a7c36ee4SCorey BryantIf running QEMU as an unprivileged user, use the network helper 1641a7c36ee4SCorey Bryant@var{helper} to configure the TAP interface. The default network 1642420508fbSAmos Konghelper executable is @file{/path/to/qemu-bridge-helper}. 1643a7c36ee4SCorey Bryant 1644a7c36ee4SCorey Bryant@option{fd}=@var{h} can be used to specify the handle of an already 1645a7c36ee4SCorey Bryantopened host TAP interface. 1646a7c36ee4SCorey Bryant 1647a7c36ee4SCorey BryantExamples: 16485824d651Sblueswir1 16495824d651Sblueswir1@example 1650a7c36ee4SCorey Bryant#launch a QEMU instance with the default network script 16513804da9dSStefan Weilqemu-system-i386 linux.img -net nic -net tap 16525824d651Sblueswir1@end example 16535824d651Sblueswir1 16545824d651Sblueswir1@example 1655a7c36ee4SCorey Bryant#launch a QEMU instance with two NICs, each one connected 1656a7c36ee4SCorey Bryant#to a TAP device 16573804da9dSStefan Weilqemu-system-i386 linux.img \ 16583804da9dSStefan Weil -net nic,vlan=0 -net tap,vlan=0,ifname=tap0 \ 16595824d651Sblueswir1 -net nic,vlan=1 -net tap,vlan=1,ifname=tap1 16605824d651Sblueswir1@end example 16615824d651Sblueswir1 1662a7c36ee4SCorey Bryant@example 1663a7c36ee4SCorey Bryant#launch a QEMU instance with the default network helper to 1664a7c36ee4SCorey Bryant#connect a TAP device to bridge br0 16653804da9dSStefan Weilqemu-system-i386 linux.img \ 1666420508fbSAmos Kong -net nic -net tap,"helper=/path/to/qemu-bridge-helper" 1667a7c36ee4SCorey Bryant@end example 1668a7c36ee4SCorey Bryant 166908d12022SStefan Hajnoczi@item -netdev bridge,id=@var{id}[,br=@var{bridge}][,helper=@var{helper}] 1670a7c36ee4SCorey Bryant@item -net bridge[,vlan=@var{n}][,name=@var{name}][,br=@var{bridge}][,helper=@var{helper}] 1671a7c36ee4SCorey BryantConnect a host TAP network interface to a host bridge device. 1672a7c36ee4SCorey Bryant 1673a7c36ee4SCorey BryantUse the network helper @var{helper} to configure the TAP interface and 1674a7c36ee4SCorey Bryantattach it to the bridge. The default network helper executable is 1675420508fbSAmos Kong@file{/path/to/qemu-bridge-helper} and the default bridge 1676a7c36ee4SCorey Bryantdevice is @file{br0}. 1677a7c36ee4SCorey Bryant 1678a7c36ee4SCorey BryantExamples: 1679a7c36ee4SCorey Bryant 1680a7c36ee4SCorey Bryant@example 1681a7c36ee4SCorey Bryant#launch a QEMU instance with the default network helper to 1682a7c36ee4SCorey Bryant#connect a TAP device to bridge br0 16833804da9dSStefan Weilqemu-system-i386 linux.img -net bridge -net nic,model=virtio 1684a7c36ee4SCorey Bryant@end example 1685a7c36ee4SCorey Bryant 1686a7c36ee4SCorey Bryant@example 1687a7c36ee4SCorey Bryant#launch a QEMU instance with the default network helper to 1688a7c36ee4SCorey Bryant#connect a TAP device to bridge qemubr0 16893804da9dSStefan Weilqemu-system-i386 linux.img -net bridge,br=qemubr0 -net nic,model=virtio 1690a7c36ee4SCorey Bryant@end example 1691a7c36ee4SCorey Bryant 169208d12022SStefan Hajnoczi@item -netdev socket,id=@var{id}[,fd=@var{h}][,listen=[@var{host}]:@var{port}][,connect=@var{host}:@var{port}] 16935824d651Sblueswir1@item -net socket[,vlan=@var{n}][,name=@var{name}][,fd=@var{h}] [,listen=[@var{host}]:@var{port}][,connect=@var{host}:@var{port}] 16945824d651Sblueswir1 16955824d651Sblueswir1Connect the VLAN @var{n} to a remote VLAN in another QEMU virtual 16965824d651Sblueswir1machine using a TCP socket connection. If @option{listen} is 16975824d651Sblueswir1specified, QEMU waits for incoming connections on @var{port} 16985824d651Sblueswir1(@var{host} is optional). @option{connect} is used to connect to 16995824d651Sblueswir1another QEMU instance using the @option{listen} option. @option{fd}=@var{h} 17005824d651Sblueswir1specifies an already opened TCP socket. 17015824d651Sblueswir1 17025824d651Sblueswir1Example: 17035824d651Sblueswir1@example 17045824d651Sblueswir1# launch a first QEMU instance 17053804da9dSStefan Weilqemu-system-i386 linux.img \ 17063804da9dSStefan Weil -net nic,macaddr=52:54:00:12:34:56 \ 17075824d651Sblueswir1 -net socket,listen=:1234 17085824d651Sblueswir1# connect the VLAN 0 of this instance to the VLAN 0 17095824d651Sblueswir1# of the first instance 17103804da9dSStefan Weilqemu-system-i386 linux.img \ 17113804da9dSStefan Weil -net nic,macaddr=52:54:00:12:34:57 \ 17125824d651Sblueswir1 -net socket,connect=127.0.0.1:1234 17135824d651Sblueswir1@end example 17145824d651Sblueswir1 171508d12022SStefan Hajnoczi@item -netdev socket,id=@var{id}[,fd=@var{h}][,mcast=@var{maddr}:@var{port}[,localaddr=@var{addr}]] 17163a75e74cSMike Ryan@item -net socket[,vlan=@var{n}][,name=@var{name}][,fd=@var{h}][,mcast=@var{maddr}:@var{port}[,localaddr=@var{addr}]] 17175824d651Sblueswir1 17185824d651Sblueswir1Create a VLAN @var{n} shared with another QEMU virtual 17195824d651Sblueswir1machines using a UDP multicast socket, effectively making a bus for 17205824d651Sblueswir1every QEMU with same multicast address @var{maddr} and @var{port}. 17215824d651Sblueswir1NOTES: 17225824d651Sblueswir1@enumerate 17235824d651Sblueswir1@item 17245824d651Sblueswir1Several QEMU can be running on different hosts and share same bus (assuming 17255824d651Sblueswir1correct multicast setup for these hosts). 17265824d651Sblueswir1@item 17275824d651Sblueswir1mcast support is compatible with User Mode Linux (argument @option{eth@var{N}=mcast}), see 17285824d651Sblueswir1@url{http://user-mode-linux.sf.net}. 17295824d651Sblueswir1@item 17305824d651Sblueswir1Use @option{fd=h} to specify an already opened UDP multicast socket. 17315824d651Sblueswir1@end enumerate 17325824d651Sblueswir1 17335824d651Sblueswir1Example: 17345824d651Sblueswir1@example 17355824d651Sblueswir1# launch one QEMU instance 17363804da9dSStefan Weilqemu-system-i386 linux.img \ 17373804da9dSStefan Weil -net nic,macaddr=52:54:00:12:34:56 \ 17385824d651Sblueswir1 -net socket,mcast=230.0.0.1:1234 17395824d651Sblueswir1# launch another QEMU instance on same "bus" 17403804da9dSStefan Weilqemu-system-i386 linux.img \ 17413804da9dSStefan Weil -net nic,macaddr=52:54:00:12:34:57 \ 17425824d651Sblueswir1 -net socket,mcast=230.0.0.1:1234 17435824d651Sblueswir1# launch yet another QEMU instance on same "bus" 17443804da9dSStefan Weilqemu-system-i386 linux.img \ 17453804da9dSStefan Weil -net nic,macaddr=52:54:00:12:34:58 \ 17465824d651Sblueswir1 -net socket,mcast=230.0.0.1:1234 17475824d651Sblueswir1@end example 17485824d651Sblueswir1 17495824d651Sblueswir1Example (User Mode Linux compat.): 17505824d651Sblueswir1@example 17515824d651Sblueswir1# launch QEMU instance (note mcast address selected 17525824d651Sblueswir1# is UML's default) 17533804da9dSStefan Weilqemu-system-i386 linux.img \ 17543804da9dSStefan Weil -net nic,macaddr=52:54:00:12:34:56 \ 17555824d651Sblueswir1 -net socket,mcast=239.192.168.1:1102 17565824d651Sblueswir1# launch UML 17575824d651Sblueswir1/path/to/linux ubd0=/path/to/root_fs eth0=mcast 17585824d651Sblueswir1@end example 17595824d651Sblueswir1 17603a75e74cSMike RyanExample (send packets from host's 1.2.3.4): 17613a75e74cSMike Ryan@example 17623804da9dSStefan Weilqemu-system-i386 linux.img \ 17633804da9dSStefan Weil -net nic,macaddr=52:54:00:12:34:56 \ 17643a75e74cSMike Ryan -net socket,mcast=239.192.168.1:1102,localaddr=1.2.3.4 17653a75e74cSMike Ryan@end example 17663a75e74cSMike Ryan 176708d12022SStefan Hajnoczi@item -netdev vde,id=@var{id}[,sock=@var{socketpath}][,port=@var{n}][,group=@var{groupname}][,mode=@var{octalmode}] 17685824d651Sblueswir1@item -net vde[,vlan=@var{n}][,name=@var{name}][,sock=@var{socketpath}] [,port=@var{n}][,group=@var{groupname}][,mode=@var{octalmode}] 17695824d651Sblueswir1Connect VLAN @var{n} to PORT @var{n} of a vde switch running on host and 17705824d651Sblueswir1listening for incoming connections on @var{socketpath}. Use GROUP @var{groupname} 17715824d651Sblueswir1and MODE @var{octalmode} to change default ownership and permissions for 1772c1ba4e0bSStefan Weilcommunication port. This option is only available if QEMU has been compiled 17735824d651Sblueswir1with vde support enabled. 17745824d651Sblueswir1 17755824d651Sblueswir1Example: 17765824d651Sblueswir1@example 17775824d651Sblueswir1# launch vde switch 17785824d651Sblueswir1vde_switch -F -sock /tmp/myswitch 17795824d651Sblueswir1# launch QEMU instance 17803804da9dSStefan Weilqemu-system-i386 linux.img -net nic -net vde,sock=/tmp/myswitch 17815824d651Sblueswir1@end example 17825824d651Sblueswir1 178340e8c26dSStefan Hajnoczi@item -netdev hubport,id=@var{id},hubid=@var{hubid} 178440e8c26dSStefan Hajnoczi 178540e8c26dSStefan HajnocziCreate a hub port on QEMU "vlan" @var{hubid}. 178640e8c26dSStefan Hajnoczi 178740e8c26dSStefan HajnocziThe hubport netdev lets you connect a NIC to a QEMU "vlan" instead of a single 178840e8c26dSStefan Hajnoczinetdev. @code{-net} and @code{-device} with parameter @option{vlan} create the 178940e8c26dSStefan Hajnoczirequired hub automatically. 179040e8c26dSStefan Hajnoczi 1791bb9ea79eSaliguori@item -net dump[,vlan=@var{n}][,file=@var{file}][,len=@var{len}] 1792bb9ea79eSaliguoriDump network traffic on VLAN @var{n} to file @var{file} (@file{qemu-vlan0.pcap} by default). 1793bb9ea79eSaliguoriAt most @var{len} bytes (64k by default) per packet are stored. The file format is 1794bb9ea79eSaliguorilibpcap, so it can be analyzed with tools such as tcpdump or Wireshark. 1795bb9ea79eSaliguori 17965824d651Sblueswir1@item -net none 17975824d651Sblueswir1Indicate that no network devices should be configured. It is used to 17985824d651Sblueswir1override the default configuration (@option{-net nic -net user}) which 17995824d651Sblueswir1is activated if no @option{-net} options are provided. 18005824d651Sblueswir1ETEXI 18015824d651Sblueswir1 1802c70a01e4SMarkus ArmbrusterSTEXI 1803c70a01e4SMarkus Armbruster@end table 1804c70a01e4SMarkus ArmbrusterETEXI 18057273a2dbSMatthew BoothDEFHEADING() 18067273a2dbSMatthew Booth 18077273a2dbSMatthew BoothDEFHEADING(Character device options:) 1808c70a01e4SMarkus ArmbrusterSTEXI 1809c70a01e4SMarkus Armbruster 1810c70a01e4SMarkus ArmbrusterThe general form of a character device option is: 1811c70a01e4SMarkus Armbruster@table @option 1812c70a01e4SMarkus ArmbrusterETEXI 18137273a2dbSMatthew Booth 18147273a2dbSMatthew BoothDEF("chardev", HAS_ARG, QEMU_OPTION_chardev, 181597331287SJan Kiszka "-chardev null,id=id[,mux=on|off]\n" 18167273a2dbSMatthew Booth "-chardev socket,id=id[,host=host],port=host[,to=to][,ipv4][,ipv6][,nodelay]\n" 181797331287SJan Kiszka " [,server][,nowait][,telnet][,mux=on|off] (tcp)\n" 181897331287SJan Kiszka "-chardev socket,id=id,path=path[,server][,nowait][,telnet],[mux=on|off] (unix)\n" 18197273a2dbSMatthew Booth "-chardev udp,id=id[,host=host],port=port[,localaddr=localaddr]\n" 182097331287SJan Kiszka " [,localport=localport][,ipv4][,ipv6][,mux=on|off]\n" 182197331287SJan Kiszka "-chardev msmouse,id=id[,mux=on|off]\n" 18227273a2dbSMatthew Booth "-chardev vc,id=id[[,width=width][,height=height]][[,cols=cols][,rows=rows]]\n" 182397331287SJan Kiszka " [,mux=on|off]\n" 18244f57378fSMarkus Armbruster "-chardev ringbuf,id=id[,size=size]\n" 182597331287SJan Kiszka "-chardev file,id=id,path=path[,mux=on|off]\n" 182697331287SJan Kiszka "-chardev pipe,id=id,path=path[,mux=on|off]\n" 18277273a2dbSMatthew Booth#ifdef _WIN32 182897331287SJan Kiszka "-chardev console,id=id[,mux=on|off]\n" 182997331287SJan Kiszka "-chardev serial,id=id,path=path[,mux=on|off]\n" 18307273a2dbSMatthew Booth#else 183197331287SJan Kiszka "-chardev pty,id=id[,mux=on|off]\n" 1832b7fdb3abSAurelien Jarno "-chardev stdio,id=id[,mux=on|off][,signal=on|off]\n" 18337273a2dbSMatthew Booth#endif 18347273a2dbSMatthew Booth#ifdef CONFIG_BRLAPI 183597331287SJan Kiszka "-chardev braille,id=id[,mux=on|off]\n" 18367273a2dbSMatthew Booth#endif 18377273a2dbSMatthew Booth#if defined(__linux__) || defined(__sun__) || defined(__FreeBSD__) \ 18387273a2dbSMatthew Booth || defined(__NetBSD__) || defined(__OpenBSD__) || defined(__DragonFly__) 1839d59044efSGerd Hoffmann "-chardev serial,id=id,path=path[,mux=on|off]\n" 184097331287SJan Kiszka "-chardev tty,id=id,path=path[,mux=on|off]\n" 18417273a2dbSMatthew Booth#endif 18427273a2dbSMatthew Booth#if defined(__linux__) || defined(__FreeBSD__) || defined(__DragonFly__) 184388a946d3SGerd Hoffmann "-chardev parallel,id=id,path=path[,mux=on|off]\n" 184497331287SJan Kiszka "-chardev parport,id=id,path=path[,mux=on|off]\n" 18457273a2dbSMatthew Booth#endif 1846cbcc6336SAlon Levy#if defined(CONFIG_SPICE) 1847cbcc6336SAlon Levy "-chardev spicevmc,id=id,name=name[,debug=debug]\n" 18485a49d3e9SMarc-André Lureau "-chardev spiceport,id=id,name=name[,debug=debug]\n" 1849cbcc6336SAlon Levy#endif 1850ad96090aSBlue Swirl , QEMU_ARCH_ALL 18517273a2dbSMatthew Booth) 18527273a2dbSMatthew Booth 18537273a2dbSMatthew BoothSTEXI 185497331287SJan Kiszka@item -chardev @var{backend} ,id=@var{id} [,mux=on|off] [,@var{options}] 18556616b2adSStefan Weil@findex -chardev 18567273a2dbSMatthew BoothBackend is one of: 18577273a2dbSMatthew Booth@option{null}, 18587273a2dbSMatthew Booth@option{socket}, 18597273a2dbSMatthew Booth@option{udp}, 18607273a2dbSMatthew Booth@option{msmouse}, 18617273a2dbSMatthew Booth@option{vc}, 18624f57378fSMarkus Armbruster@option{ringbuf}, 18637273a2dbSMatthew Booth@option{file}, 18647273a2dbSMatthew Booth@option{pipe}, 18657273a2dbSMatthew Booth@option{console}, 18667273a2dbSMatthew Booth@option{serial}, 18677273a2dbSMatthew Booth@option{pty}, 18687273a2dbSMatthew Booth@option{stdio}, 18697273a2dbSMatthew Booth@option{braille}, 18707273a2dbSMatthew Booth@option{tty}, 187188a946d3SGerd Hoffmann@option{parallel}, 1872cbcc6336SAlon Levy@option{parport}, 1873cbcc6336SAlon Levy@option{spicevmc}. 18745a49d3e9SMarc-André Lureau@option{spiceport}. 18757273a2dbSMatthew BoothThe specific backend will determine the applicable options. 18767273a2dbSMatthew Booth 18777273a2dbSMatthew BoothAll devices must have an id, which can be any string up to 127 characters long. 18787273a2dbSMatthew BoothIt is used to uniquely identify this device in other command line directives. 18797273a2dbSMatthew Booth 188097331287SJan KiszkaA character device may be used in multiplexing mode by multiple front-ends. 188197331287SJan KiszkaThe key sequence of @key{Control-a} and @key{c} will rotate the input focus 188297331287SJan Kiszkabetween attached front-ends. Specify @option{mux=on} to enable this mode. 188397331287SJan Kiszka 18847273a2dbSMatthew BoothOptions to each backend are described below. 18857273a2dbSMatthew Booth 18867273a2dbSMatthew Booth@item -chardev null ,id=@var{id} 18877273a2dbSMatthew BoothA void device. This device will not emit any data, and will drop any data it 18887273a2dbSMatthew Boothreceives. The null backend does not take any options. 18897273a2dbSMatthew Booth 18907273a2dbSMatthew Booth@item -chardev socket ,id=@var{id} [@var{TCP options} or @var{unix options}] [,server] [,nowait] [,telnet] 18917273a2dbSMatthew Booth 18927273a2dbSMatthew BoothCreate a two-way stream socket, which can be either a TCP or a unix socket. A 18937273a2dbSMatthew Boothunix socket will be created if @option{path} is specified. Behaviour is 18947273a2dbSMatthew Boothundefined if TCP options are specified for a unix socket. 18957273a2dbSMatthew Booth 18967273a2dbSMatthew Booth@option{server} specifies that the socket shall be a listening socket. 18977273a2dbSMatthew Booth 18987273a2dbSMatthew Booth@option{nowait} specifies that QEMU should not block waiting for a client to 18997273a2dbSMatthew Boothconnect to a listening socket. 19007273a2dbSMatthew Booth 19017273a2dbSMatthew Booth@option{telnet} specifies that traffic on the socket should interpret telnet 19027273a2dbSMatthew Boothescape sequences. 19037273a2dbSMatthew Booth 19047273a2dbSMatthew BoothTCP and unix socket options are given below: 19057273a2dbSMatthew Booth 19067273a2dbSMatthew Booth@table @option 19077273a2dbSMatthew Booth 19088d533561SAurelien Jarno@item TCP options: port=@var{port} [,host=@var{host}] [,to=@var{to}] [,ipv4] [,ipv6] [,nodelay] 19097273a2dbSMatthew Booth 19107273a2dbSMatthew Booth@option{host} for a listening socket specifies the local address to be bound. 19117273a2dbSMatthew BoothFor a connecting socket species the remote host to connect to. @option{host} is 19127273a2dbSMatthew Boothoptional for listening sockets. If not specified it defaults to @code{0.0.0.0}. 19137273a2dbSMatthew Booth 19147273a2dbSMatthew Booth@option{port} for a listening socket specifies the local port to be bound. For a 19157273a2dbSMatthew Boothconnecting socket specifies the port on the remote host to connect to. 19167273a2dbSMatthew Booth@option{port} can be given as either a port number or a service name. 19177273a2dbSMatthew Booth@option{port} is required. 19187273a2dbSMatthew Booth 19197273a2dbSMatthew Booth@option{to} is only relevant to listening sockets. If it is specified, and 19207273a2dbSMatthew Booth@option{port} cannot be bound, QEMU will attempt to bind to subsequent ports up 19217273a2dbSMatthew Boothto and including @option{to} until it succeeds. @option{to} must be specified 19227273a2dbSMatthew Boothas a port number. 19237273a2dbSMatthew Booth 19247273a2dbSMatthew Booth@option{ipv4} and @option{ipv6} specify that either IPv4 or IPv6 must be used. 19257273a2dbSMatthew BoothIf neither is specified the socket may use either protocol. 19267273a2dbSMatthew Booth 19277273a2dbSMatthew Booth@option{nodelay} disables the Nagle algorithm. 19287273a2dbSMatthew Booth 19297273a2dbSMatthew Booth@item unix options: path=@var{path} 19307273a2dbSMatthew Booth 19317273a2dbSMatthew Booth@option{path} specifies the local path of the unix socket. @option{path} is 19327273a2dbSMatthew Boothrequired. 19337273a2dbSMatthew Booth 19347273a2dbSMatthew Booth@end table 19357273a2dbSMatthew Booth 19367273a2dbSMatthew Booth@item -chardev udp ,id=@var{id} [,host=@var{host}] ,port=@var{port} [,localaddr=@var{localaddr}] [,localport=@var{localport}] [,ipv4] [,ipv6] 19377273a2dbSMatthew Booth 19387273a2dbSMatthew BoothSends all traffic from the guest to a remote host over UDP. 19397273a2dbSMatthew Booth 19407273a2dbSMatthew Booth@option{host} specifies the remote host to connect to. If not specified it 19417273a2dbSMatthew Boothdefaults to @code{localhost}. 19427273a2dbSMatthew Booth 19437273a2dbSMatthew Booth@option{port} specifies the port on the remote host to connect to. @option{port} 19447273a2dbSMatthew Boothis required. 19457273a2dbSMatthew Booth 19467273a2dbSMatthew Booth@option{localaddr} specifies the local address to bind to. If not specified it 19477273a2dbSMatthew Boothdefaults to @code{0.0.0.0}. 19487273a2dbSMatthew Booth 19497273a2dbSMatthew Booth@option{localport} specifies the local port to bind to. If not specified any 19507273a2dbSMatthew Boothavailable local port will be used. 19517273a2dbSMatthew Booth 19527273a2dbSMatthew Booth@option{ipv4} and @option{ipv6} specify that either IPv4 or IPv6 must be used. 19537273a2dbSMatthew BoothIf neither is specified the device may use either protocol. 19547273a2dbSMatthew Booth 19557273a2dbSMatthew Booth@item -chardev msmouse ,id=@var{id} 19567273a2dbSMatthew Booth 19577273a2dbSMatthew BoothForward QEMU's emulated msmouse events to the guest. @option{msmouse} does not 19587273a2dbSMatthew Boothtake any options. 19597273a2dbSMatthew Booth 19607273a2dbSMatthew Booth@item -chardev vc ,id=@var{id} [[,width=@var{width}] [,height=@var{height}]] [[,cols=@var{cols}] [,rows=@var{rows}]] 19617273a2dbSMatthew Booth 19627273a2dbSMatthew BoothConnect to a QEMU text console. @option{vc} may optionally be given a specific 19637273a2dbSMatthew Boothsize. 19647273a2dbSMatthew Booth 19657273a2dbSMatthew Booth@option{width} and @option{height} specify the width and height respectively of 19667273a2dbSMatthew Booththe console, in pixels. 19677273a2dbSMatthew Booth 19687273a2dbSMatthew Booth@option{cols} and @option{rows} specify that the console be sized to fit a text 19697273a2dbSMatthew Boothconsole with the given dimensions. 19707273a2dbSMatthew Booth 19714f57378fSMarkus Armbruster@item -chardev ringbuf ,id=@var{id} [,size=@var{size}] 197251767e7cSLei Li 19733949e594SMarkus ArmbrusterCreate a ring buffer with fixed size @option{size}. 19743949e594SMarkus Armbruster@var{size} must be a power of two, and defaults to @code{64K}). 197551767e7cSLei Li 19767273a2dbSMatthew Booth@item -chardev file ,id=@var{id} ,path=@var{path} 19777273a2dbSMatthew Booth 19787273a2dbSMatthew BoothLog all traffic received from the guest to a file. 19797273a2dbSMatthew Booth 19807273a2dbSMatthew Booth@option{path} specifies the path of the file to be opened. This file will be 19817273a2dbSMatthew Boothcreated if it does not already exist, and overwritten if it does. @option{path} 19827273a2dbSMatthew Boothis required. 19837273a2dbSMatthew Booth 19847273a2dbSMatthew Booth@item -chardev pipe ,id=@var{id} ,path=@var{path} 19857273a2dbSMatthew Booth 19867273a2dbSMatthew BoothCreate a two-way connection to the guest. The behaviour differs slightly between 19877273a2dbSMatthew BoothWindows hosts and other hosts: 19887273a2dbSMatthew Booth 19897273a2dbSMatthew BoothOn Windows, a single duplex pipe will be created at 19907273a2dbSMatthew Booth@file{\\.pipe\@option{path}}. 19917273a2dbSMatthew Booth 19927273a2dbSMatthew BoothOn other hosts, 2 pipes will be created called @file{@option{path}.in} and 19937273a2dbSMatthew Booth@file{@option{path}.out}. Data written to @file{@option{path}.in} will be 19947273a2dbSMatthew Boothreceived by the guest. Data written by the guest can be read from 19957273a2dbSMatthew Booth@file{@option{path}.out}. QEMU will not create these fifos, and requires them to 19967273a2dbSMatthew Boothbe present. 19977273a2dbSMatthew Booth 19987273a2dbSMatthew Booth@option{path} forms part of the pipe path as described above. @option{path} is 19997273a2dbSMatthew Boothrequired. 20007273a2dbSMatthew Booth 20017273a2dbSMatthew Booth@item -chardev console ,id=@var{id} 20027273a2dbSMatthew Booth 20037273a2dbSMatthew BoothSend traffic from the guest to QEMU's standard output. @option{console} does not 20047273a2dbSMatthew Boothtake any options. 20057273a2dbSMatthew Booth 20067273a2dbSMatthew Booth@option{console} is only available on Windows hosts. 20077273a2dbSMatthew Booth 20087273a2dbSMatthew Booth@item -chardev serial ,id=@var{id} ,path=@option{path} 20097273a2dbSMatthew Booth 20107273a2dbSMatthew BoothSend traffic from the guest to a serial device on the host. 20117273a2dbSMatthew Booth 2012d59044efSGerd HoffmannOn Unix hosts serial will actually accept any tty device, 2013d59044efSGerd Hoffmannnot only serial lines. 20147273a2dbSMatthew Booth 20157273a2dbSMatthew Booth@option{path} specifies the name of the serial device to open. 20167273a2dbSMatthew Booth 20177273a2dbSMatthew Booth@item -chardev pty ,id=@var{id} 20187273a2dbSMatthew Booth 20197273a2dbSMatthew BoothCreate a new pseudo-terminal on the host and connect to it. @option{pty} does 20207273a2dbSMatthew Boothnot take any options. 20217273a2dbSMatthew Booth 20227273a2dbSMatthew Booth@option{pty} is not available on Windows hosts. 20237273a2dbSMatthew Booth 2024b7fdb3abSAurelien Jarno@item -chardev stdio ,id=@var{id} [,signal=on|off] 2025b65ee4faSStefan WeilConnect to standard input and standard output of the QEMU process. 2026b7fdb3abSAurelien Jarno 2027b7fdb3abSAurelien Jarno@option{signal} controls if signals are enabled on the terminal, that includes 2028b7fdb3abSAurelien Jarnoexiting QEMU with the key sequence @key{Control-c}. This option is enabled by 2029b7fdb3abSAurelien Jarnodefault, use @option{signal=off} to disable it. 2030b7fdb3abSAurelien Jarno 2031b7fdb3abSAurelien Jarno@option{stdio} is not available on Windows hosts. 20327273a2dbSMatthew Booth 20337273a2dbSMatthew Booth@item -chardev braille ,id=@var{id} 20347273a2dbSMatthew Booth 20357273a2dbSMatthew BoothConnect to a local BrlAPI server. @option{braille} does not take any options. 20367273a2dbSMatthew Booth 20377273a2dbSMatthew Booth@item -chardev tty ,id=@var{id} ,path=@var{path} 20387273a2dbSMatthew Booth 20397273a2dbSMatthew Booth@option{tty} is only available on Linux, Sun, FreeBSD, NetBSD, OpenBSD and 2040d037d6bbSMarkus ArmbrusterDragonFlyBSD hosts. It is an alias for @option{serial}. 20417273a2dbSMatthew Booth 20427273a2dbSMatthew Booth@option{path} specifies the path to the tty. @option{path} is required. 20437273a2dbSMatthew Booth 204488a946d3SGerd Hoffmann@item -chardev parallel ,id=@var{id} ,path=@var{path} 20457273a2dbSMatthew Booth@item -chardev parport ,id=@var{id} ,path=@var{path} 20467273a2dbSMatthew Booth 204788a946d3SGerd Hoffmann@option{parallel} is only available on Linux, FreeBSD and DragonFlyBSD hosts. 20487273a2dbSMatthew Booth 20497273a2dbSMatthew BoothConnect to a local parallel port. 20507273a2dbSMatthew Booth 20517273a2dbSMatthew Booth@option{path} specifies the path to the parallel port device. @option{path} is 20527273a2dbSMatthew Boothrequired. 20537273a2dbSMatthew Booth 2054cbcc6336SAlon Levy@item -chardev spicevmc ,id=@var{id} ,debug=@var{debug}, name=@var{name} 2055cbcc6336SAlon Levy 20563a846906SStefan Hajnoczi@option{spicevmc} is only available when spice support is built in. 20573a846906SStefan Hajnoczi 2058cbcc6336SAlon Levy@option{debug} debug level for spicevmc 2059cbcc6336SAlon Levy 2060cbcc6336SAlon Levy@option{name} name of spice channel to connect to 2061cbcc6336SAlon Levy 2062cbcc6336SAlon LevyConnect to a spice virtual machine channel, such as vdiport. 2063cbcc6336SAlon Levy 20645a49d3e9SMarc-André Lureau@item -chardev spiceport ,id=@var{id} ,debug=@var{debug}, name=@var{name} 20655a49d3e9SMarc-André Lureau 20665a49d3e9SMarc-André Lureau@option{spiceport} is only available when spice support is built in. 20675a49d3e9SMarc-André Lureau 20685a49d3e9SMarc-André Lureau@option{debug} debug level for spicevmc 20695a49d3e9SMarc-André Lureau 20705a49d3e9SMarc-André Lureau@option{name} name of spice port to connect to 20715a49d3e9SMarc-André Lureau 20725a49d3e9SMarc-André LureauConnect to a spice port, allowing a Spice client to handle the traffic 20735a49d3e9SMarc-André Lureauidentified by a name (preferably a fqdn). 20747273a2dbSMatthew BoothETEXI 20757273a2dbSMatthew Booth 2076c70a01e4SMarkus ArmbrusterSTEXI 2077c70a01e4SMarkus Armbruster@end table 2078c70a01e4SMarkus ArmbrusterETEXI 20797273a2dbSMatthew BoothDEFHEADING() 20807273a2dbSMatthew Booth 20810f5314a2SRonnie SahlbergDEFHEADING(Device URL Syntax:) 2082c70a01e4SMarkus ArmbrusterSTEXI 20830f5314a2SRonnie Sahlberg 20840f5314a2SRonnie SahlbergIn addition to using normal file images for the emulated storage devices, 20850f5314a2SRonnie SahlbergQEMU can also use networked resources such as iSCSI devices. These are 20860f5314a2SRonnie Sahlbergspecified using a special URL syntax. 20870f5314a2SRonnie Sahlberg 20880f5314a2SRonnie Sahlberg@table @option 20890f5314a2SRonnie Sahlberg@item iSCSI 20900f5314a2SRonnie SahlbergiSCSI support allows QEMU to access iSCSI resources directly and use as 20910f5314a2SRonnie Sahlbergimages for the guest storage. Both disk and cdrom images are supported. 20920f5314a2SRonnie Sahlberg 20930f5314a2SRonnie SahlbergSyntax for specifying iSCSI LUNs is 20940f5314a2SRonnie Sahlberg``iscsi://<target-ip>[:<port>]/<target-iqn>/<lun>'' 20950f5314a2SRonnie Sahlberg 209631459f46SRonnie SahlbergBy default qemu will use the iSCSI initiator-name 209731459f46SRonnie Sahlberg'iqn.2008-11.org.linux-kvm[:<name>]' but this can also be set from the command 209831459f46SRonnie Sahlbergline or a configuration file. 209931459f46SRonnie Sahlberg 210031459f46SRonnie Sahlberg 21010f5314a2SRonnie SahlbergExample (without authentication): 21020f5314a2SRonnie Sahlberg@example 21033804da9dSStefan Weilqemu-system-i386 -iscsi initiator-name=iqn.2001-04.com.example:my-initiator \ 2104f9dadc98SRonnie Sahlberg -cdrom iscsi://192.0.2.1/iqn.2001-04.com.example/2 \ 2105f9dadc98SRonnie Sahlberg -drive file=iscsi://192.0.2.1/iqn.2001-04.com.example/1 21060f5314a2SRonnie Sahlberg@end example 21070f5314a2SRonnie Sahlberg 21080f5314a2SRonnie SahlbergExample (CHAP username/password via URL): 21090f5314a2SRonnie Sahlberg@example 21103804da9dSStefan Weilqemu-system-i386 -drive file=iscsi://user%password@@192.0.2.1/iqn.2001-04.com.example/1 21110f5314a2SRonnie Sahlberg@end example 21120f5314a2SRonnie Sahlberg 21130f5314a2SRonnie SahlbergExample (CHAP username/password via environment variables): 21140f5314a2SRonnie Sahlberg@example 21150f5314a2SRonnie SahlbergLIBISCSI_CHAP_USERNAME="user" \ 21160f5314a2SRonnie SahlbergLIBISCSI_CHAP_PASSWORD="password" \ 21173804da9dSStefan Weilqemu-system-i386 -drive file=iscsi://192.0.2.1/iqn.2001-04.com.example/1 21180f5314a2SRonnie Sahlberg@end example 21190f5314a2SRonnie Sahlberg 21200f5314a2SRonnie SahlbergiSCSI support is an optional feature of QEMU and only available when 21210f5314a2SRonnie Sahlbergcompiled and linked against libiscsi. 2122f9dadc98SRonnie SahlbergETEXI 2123f9dadc98SRonnie SahlbergDEF("iscsi", HAS_ARG, QEMU_OPTION_iscsi, 2124f9dadc98SRonnie Sahlberg "-iscsi [user=user][,password=password]\n" 2125f9dadc98SRonnie Sahlberg " [,header-digest=CRC32C|CR32C-NONE|NONE-CRC32C|NONE\n" 21262fe3798cSPaolo Bonzini " [,initiator-name=initiator-iqn][,id=target-iqn]\n" 2127f9dadc98SRonnie Sahlberg " iSCSI session parameters\n", QEMU_ARCH_ALL) 2128f9dadc98SRonnie SahlbergSTEXI 21290f5314a2SRonnie Sahlberg 213031459f46SRonnie SahlbergiSCSI parameters such as username and password can also be specified via 213131459f46SRonnie Sahlberga configuration file. See qemu-doc for more information and examples. 213231459f46SRonnie Sahlberg 213308ae330eSRonnie Sahlberg@item NBD 213408ae330eSRonnie SahlbergQEMU supports NBD (Network Block Devices) both using TCP protocol as well 213508ae330eSRonnie Sahlbergas Unix Domain Sockets. 213608ae330eSRonnie Sahlberg 213708ae330eSRonnie SahlbergSyntax for specifying a NBD device using TCP 213808ae330eSRonnie Sahlberg``nbd:<server-ip>:<port>[:exportname=<export>]'' 213908ae330eSRonnie Sahlberg 214008ae330eSRonnie SahlbergSyntax for specifying a NBD device using Unix Domain Sockets 214108ae330eSRonnie Sahlberg``nbd:unix:<domain-socket>[:exportname=<export>]'' 214208ae330eSRonnie Sahlberg 214308ae330eSRonnie Sahlberg 214408ae330eSRonnie SahlbergExample for TCP 214508ae330eSRonnie Sahlberg@example 21463804da9dSStefan Weilqemu-system-i386 --drive file=nbd:192.0.2.1:30000 214708ae330eSRonnie Sahlberg@end example 214808ae330eSRonnie Sahlberg 214908ae330eSRonnie SahlbergExample for Unix Domain Sockets 215008ae330eSRonnie Sahlberg@example 21513804da9dSStefan Weilqemu-system-i386 --drive file=nbd:unix:/tmp/nbd-socket 215208ae330eSRonnie Sahlberg@end example 215308ae330eSRonnie Sahlberg 21540a12ec87SRichard W.M. Jones@item SSH 21550a12ec87SRichard W.M. JonesQEMU supports SSH (Secure Shell) access to remote disks. 21560a12ec87SRichard W.M. Jones 21570a12ec87SRichard W.M. JonesExamples: 21580a12ec87SRichard W.M. Jones@example 21590a12ec87SRichard W.M. Jonesqemu-system-i386 -drive file=ssh://user@@host/path/to/disk.img 21600a12ec87SRichard W.M. Jonesqemu-system-i386 -drive file.driver=ssh,file.user=user,file.host=host,file.port=22,file.path=/path/to/disk.img 21610a12ec87SRichard W.M. Jones@end example 21620a12ec87SRichard W.M. Jones 21630a12ec87SRichard W.M. JonesCurrently authentication must be done using ssh-agent. Other 21640a12ec87SRichard W.M. Jonesauthentication methods may be supported in future. 21650a12ec87SRichard W.M. Jones 2166d9990228SRonnie Sahlberg@item Sheepdog 2167d9990228SRonnie SahlbergSheepdog is a distributed storage system for QEMU. 2168d9990228SRonnie SahlbergQEMU supports using either local sheepdog devices or remote networked 2169d9990228SRonnie Sahlbergdevices. 2170d9990228SRonnie Sahlberg 2171d9990228SRonnie SahlbergSyntax for specifying a sheepdog device 21725d6768e3SMORITA Kazutaka@example 21731b8bbb46SMORITA Kazutakasheepdog[+tcp|+unix]://[host:port]/vdiname[?socket=path][#snapid|#tag] 21745d6768e3SMORITA Kazutaka@end example 2175d9990228SRonnie Sahlberg 2176d9990228SRonnie SahlbergExample 2177d9990228SRonnie Sahlberg@example 21785d6768e3SMORITA Kazutakaqemu-system-i386 --drive file=sheepdog://192.0.2.1:30000/MyVirtualMachine 2179d9990228SRonnie Sahlberg@end example 2180d9990228SRonnie Sahlberg 2181d9990228SRonnie SahlbergSee also @url{http://http://www.osrg.net/sheepdog/}. 2182d9990228SRonnie Sahlberg 21838809e289SBharata B Rao@item GlusterFS 21848809e289SBharata B RaoGlusterFS is an user space distributed file system. 21858809e289SBharata B RaoQEMU supports the use of GlusterFS volumes for hosting VM disk images using 21868809e289SBharata B RaoTCP, Unix Domain Sockets and RDMA transport protocols. 21878809e289SBharata B Rao 21888809e289SBharata B RaoSyntax for specifying a VM disk image on GlusterFS volume is 21898809e289SBharata B Rao@example 21908809e289SBharata B Raogluster[+transport]://[server[:port]]/volname/image[?socket=...] 21918809e289SBharata B Rao@end example 21928809e289SBharata B Rao 21938809e289SBharata B Rao 21948809e289SBharata B RaoExample 21958809e289SBharata B Rao@example 2196db2d5ebaSLei Liqemu-system-x86_64 --drive file=gluster://192.0.2.1/testvol/a.img 21978809e289SBharata B Rao@end example 21988809e289SBharata B Rao 21998809e289SBharata B RaoSee also @url{http://www.gluster.org}. 22000a86cb73SMatthew Booth 22010a86cb73SMatthew Booth@item HTTP/HTTPS/FTP/FTPS/TFTP 22020a86cb73SMatthew BoothQEMU supports read-only access to files accessed over http(s), ftp(s) and tftp. 22030a86cb73SMatthew Booth 22040a86cb73SMatthew BoothSyntax using a single filename: 22050a86cb73SMatthew Booth@example 22060a86cb73SMatthew Booth<protocol>://[<username>[:<password>]@@]<host>/<path> 22070a86cb73SMatthew Booth@end example 22080a86cb73SMatthew Booth 22090a86cb73SMatthew Boothwhere: 22100a86cb73SMatthew Booth@table @option 22110a86cb73SMatthew Booth@item protocol 22120a86cb73SMatthew Booth'http', 'https', 'ftp', 'ftps', or 'tftp'. 22130a86cb73SMatthew Booth 22140a86cb73SMatthew Booth@item username 22150a86cb73SMatthew BoothOptional username for authentication to the remote server. 22160a86cb73SMatthew Booth 22170a86cb73SMatthew Booth@item password 22180a86cb73SMatthew BoothOptional password for authentication to the remote server. 22190a86cb73SMatthew Booth 22200a86cb73SMatthew Booth@item host 22210a86cb73SMatthew BoothAddress of the remote server. 22220a86cb73SMatthew Booth 22230a86cb73SMatthew Booth@item path 22240a86cb73SMatthew BoothPath on the remote server, including any query string. 22250a86cb73SMatthew Booth@end table 22260a86cb73SMatthew Booth 22270a86cb73SMatthew BoothThe following options are also supported: 22280a86cb73SMatthew Booth@table @option 22290a86cb73SMatthew Booth@item url 22300a86cb73SMatthew BoothThe full URL when passing options to the driver explicitly. 22310a86cb73SMatthew Booth 22320a86cb73SMatthew Booth@item readahead 22330a86cb73SMatthew BoothThe amount of data to read ahead with each range request to the remote server. 22340a86cb73SMatthew BoothThis value may optionally have the suffix 'T', 'G', 'M', 'K', 'k' or 'b'. If it 22350a86cb73SMatthew Boothdoes not have a suffix, it will be assumed to be in bytes. The value must be a 22360a86cb73SMatthew Boothmultiple of 512 bytes. It defaults to 256k. 22370a86cb73SMatthew Booth 22380a86cb73SMatthew Booth@item sslverify 22390a86cb73SMatthew BoothWhether to verify the remote server's certificate when connecting over SSL. It 22400a86cb73SMatthew Boothcan have the value 'on' or 'off'. It defaults to 'on'. 22410a86cb73SMatthew Booth@end table 22420a86cb73SMatthew Booth 22430a86cb73SMatthew BoothNote that when passing options to qemu explicitly, @option{driver} is the value 22440a86cb73SMatthew Boothof <protocol>. 22450a86cb73SMatthew Booth 22460a86cb73SMatthew BoothExample: boot from a remote Fedora 20 live ISO image 22470a86cb73SMatthew Booth@example 22480a86cb73SMatthew Boothqemu-system-x86_64 --drive media=cdrom,file=http://dl.fedoraproject.org/pub/fedora/linux/releases/20/Live/x86_64/Fedora-Live-Desktop-x86_64-20-1.iso,readonly 22490a86cb73SMatthew Booth 22500a86cb73SMatthew Boothqemu-system-x86_64 --drive media=cdrom,file.driver=http,file.url=http://dl.fedoraproject.org/pub/fedora/linux/releases/20/Live/x86_64/Fedora-Live-Desktop-x86_64-20-1.iso,readonly 22510a86cb73SMatthew Booth@end example 22520a86cb73SMatthew Booth 22530a86cb73SMatthew BoothExample: boot from a remote Fedora 20 cloud image using a local overlay for 22540a86cb73SMatthew Boothwrites, copy-on-read, and a readahead of 64k 22550a86cb73SMatthew Booth@example 22560a86cb73SMatthew Boothqemu-img create -f qcow2 -o backing_file='json:@{"file.driver":"http",, "file.url":"https://dl.fedoraproject.org/pub/fedora/linux/releases/20/Images/x86_64/Fedora-x86_64-20-20131211.1-sda.qcow2",, "file.readahead":"64k"@}' /tmp/Fedora-x86_64-20-20131211.1-sda.qcow2 22570a86cb73SMatthew Booth 22580a86cb73SMatthew Boothqemu-system-x86_64 -drive file=/tmp/Fedora-x86_64-20-20131211.1-sda.qcow2,copy-on-read=on 22590a86cb73SMatthew Booth@end example 22600a86cb73SMatthew Booth 22610a86cb73SMatthew BoothExample: boot from an image stored on a VMware vSphere server with a self-signed 22620a86cb73SMatthew Boothcertificate using a local overlay for writes and a readahead of 64k 22630a86cb73SMatthew Booth@example 22640a86cb73SMatthew Boothqemu-img create -f qcow2 -o backing_file='json:@{"file.driver":"https",, "file.url":"https://user:password@@vsphere.example.com/folder/test/test-flat.vmdk?dcPath=Datacenter&dsName=datastore1",, "file.sslverify":"off",, "file.readahead":"64k"@}' /tmp/test.qcow2 22650a86cb73SMatthew Booth 22660a86cb73SMatthew Boothqemu-system-x86_64 -drive file=/tmp/test.qcow2 22670a86cb73SMatthew Booth@end example 2268c70a01e4SMarkus ArmbrusterETEXI 2269c70a01e4SMarkus Armbruster 2270c70a01e4SMarkus ArmbrusterSTEXI 22710f5314a2SRonnie Sahlberg@end table 22720f5314a2SRonnie SahlbergETEXI 22730f5314a2SRonnie Sahlberg 22747273a2dbSMatthew BoothDEFHEADING(Bluetooth(R) options:) 2275c70a01e4SMarkus ArmbrusterSTEXI 2276c70a01e4SMarkus Armbruster@table @option 2277c70a01e4SMarkus ArmbrusterETEXI 22787273a2dbSMatthew Booth 22795824d651Sblueswir1DEF("bt", HAS_ARG, QEMU_OPTION_bt, \ 22805824d651Sblueswir1 "-bt hci,null dumb bluetooth HCI - doesn't respond to commands\n" \ 22815824d651Sblueswir1 "-bt hci,host[:id]\n" \ 22825824d651Sblueswir1 " use host's HCI with the given name\n" \ 22835824d651Sblueswir1 "-bt hci[,vlan=n]\n" \ 22845824d651Sblueswir1 " emulate a standard HCI in virtual scatternet 'n'\n" \ 22855824d651Sblueswir1 "-bt vhci[,vlan=n]\n" \ 22865824d651Sblueswir1 " add host computer to virtual scatternet 'n' using VHCI\n" \ 22875824d651Sblueswir1 "-bt device:dev[,vlan=n]\n" \ 2288ad96090aSBlue Swirl " emulate a bluetooth device 'dev' in scatternet 'n'\n", 2289ad96090aSBlue Swirl QEMU_ARCH_ALL) 22905824d651Sblueswir1STEXI 22915824d651Sblueswir1@item -bt hci[...] 22926616b2adSStefan Weil@findex -bt 22935824d651Sblueswir1Defines the function of the corresponding Bluetooth HCI. -bt options 22945824d651Sblueswir1are matched with the HCIs present in the chosen machine type. For 22955824d651Sblueswir1example when emulating a machine with only one HCI built into it, only 22965824d651Sblueswir1the first @code{-bt hci[...]} option is valid and defines the HCI's 22975824d651Sblueswir1logic. The Transport Layer is decided by the machine type. Currently 22985824d651Sblueswir1the machines @code{n800} and @code{n810} have one HCI and all other 22995824d651Sblueswir1machines have none. 23005824d651Sblueswir1 23015824d651Sblueswir1@anchor{bt-hcis} 23025824d651Sblueswir1The following three types are recognized: 23035824d651Sblueswir1 2304b3f046c2SKevin Wolf@table @option 23055824d651Sblueswir1@item -bt hci,null 23065824d651Sblueswir1(default) The corresponding Bluetooth HCI assumes no internal logic 23075824d651Sblueswir1and will not respond to any HCI commands or emit events. 23085824d651Sblueswir1 23095824d651Sblueswir1@item -bt hci,host[:@var{id}] 23105824d651Sblueswir1(@code{bluez} only) The corresponding HCI passes commands / events 23115824d651Sblueswir1to / from the physical HCI identified by the name @var{id} (default: 23125824d651Sblueswir1@code{hci0}) on the computer running QEMU. Only available on @code{bluez} 23135824d651Sblueswir1capable systems like Linux. 23145824d651Sblueswir1 23155824d651Sblueswir1@item -bt hci[,vlan=@var{n}] 23165824d651Sblueswir1Add a virtual, standard HCI that will participate in the Bluetooth 23175824d651Sblueswir1scatternet @var{n} (default @code{0}). Similarly to @option{-net} 23185824d651Sblueswir1VLANs, devices inside a bluetooth network @var{n} can only communicate 23195824d651Sblueswir1with other devices in the same network (scatternet). 23205824d651Sblueswir1@end table 23215824d651Sblueswir1 23225824d651Sblueswir1@item -bt vhci[,vlan=@var{n}] 23235824d651Sblueswir1(Linux-host only) Create a HCI in scatternet @var{n} (default 0) attached 23245824d651Sblueswir1to the host bluetooth stack instead of to the emulated target. This 23255824d651Sblueswir1allows the host and target machines to participate in a common scatternet 23265824d651Sblueswir1and communicate. Requires the Linux @code{vhci} driver installed. Can 23275824d651Sblueswir1be used as following: 23285824d651Sblueswir1 23295824d651Sblueswir1@example 23303804da9dSStefan Weilqemu-system-i386 [...OPTIONS...] -bt hci,vlan=5 -bt vhci,vlan=5 23315824d651Sblueswir1@end example 23325824d651Sblueswir1 23335824d651Sblueswir1@item -bt device:@var{dev}[,vlan=@var{n}] 23345824d651Sblueswir1Emulate a bluetooth device @var{dev} and place it in network @var{n} 23355824d651Sblueswir1(default @code{0}). QEMU can only emulate one type of bluetooth devices 23365824d651Sblueswir1currently: 23375824d651Sblueswir1 2338b3f046c2SKevin Wolf@table @option 23395824d651Sblueswir1@item keyboard 23405824d651Sblueswir1Virtual wireless keyboard implementing the HIDP bluetooth profile. 23415824d651Sblueswir1@end table 23425824d651Sblueswir1ETEXI 23435824d651Sblueswir1 2344c70a01e4SMarkus ArmbrusterSTEXI 2345c70a01e4SMarkus Armbruster@end table 2346c70a01e4SMarkus ArmbrusterETEXI 23475824d651Sblueswir1DEFHEADING() 23485824d651Sblueswir1 2349d1a0cf73SStefan Berger#ifdef CONFIG_TPM 2350d1a0cf73SStefan BergerDEFHEADING(TPM device options:) 2351d1a0cf73SStefan Berger 2352d1a0cf73SStefan BergerDEF("tpmdev", HAS_ARG, QEMU_OPTION_tpmdev, \ 235392dcc234SStefan Berger "-tpmdev passthrough,id=id[,path=path][,cancel-path=path]\n" 235492dcc234SStefan Berger " use path to provide path to a character device; default is /dev/tpm0\n" 235592dcc234SStefan Berger " use cancel-path to provide path to TPM's cancel sysfs entry; if\n" 235692dcc234SStefan Berger " not provided it will be searched for in /sys/class/misc/tpm?/device\n", 2357d1a0cf73SStefan Berger QEMU_ARCH_ALL) 2358d1a0cf73SStefan BergerSTEXI 2359d1a0cf73SStefan Berger 2360d1a0cf73SStefan BergerThe general form of a TPM device option is: 2361d1a0cf73SStefan Berger@table @option 2362d1a0cf73SStefan Berger 2363d1a0cf73SStefan Berger@item -tpmdev @var{backend} ,id=@var{id} [,@var{options}] 2364d1a0cf73SStefan Berger@findex -tpmdev 2365d1a0cf73SStefan BergerBackend type must be: 23664549a8b7SStefan Berger@option{passthrough}. 2367d1a0cf73SStefan Berger 2368d1a0cf73SStefan BergerThe specific backend type will determine the applicable options. 236928c4fa32SCorey BryantThe @code{-tpmdev} option creates the TPM backend and requires a 237028c4fa32SCorey Bryant@code{-device} option that specifies the TPM frontend interface model. 2371d1a0cf73SStefan Berger 2372d1a0cf73SStefan BergerOptions to each backend are described below. 2373d1a0cf73SStefan Berger 2374d1a0cf73SStefan BergerUse 'help' to print all available TPM backend types. 2375d1a0cf73SStefan Berger@example 2376d1a0cf73SStefan Bergerqemu -tpmdev help 2377d1a0cf73SStefan Berger@end example 2378d1a0cf73SStefan Berger 237992dcc234SStefan Berger@item -tpmdev passthrough, id=@var{id}, path=@var{path}, cancel-path=@var{cancel-path} 23804549a8b7SStefan Berger 23814549a8b7SStefan Berger(Linux-host only) Enable access to the host's TPM using the passthrough 23824549a8b7SStefan Bergerdriver. 23834549a8b7SStefan Berger 23844549a8b7SStefan Berger@option{path} specifies the path to the host's TPM device, i.e., on 23854549a8b7SStefan Bergera Linux host this would be @code{/dev/tpm0}. 23864549a8b7SStefan Berger@option{path} is optional and by default @code{/dev/tpm0} is used. 23874549a8b7SStefan Berger 238892dcc234SStefan Berger@option{cancel-path} specifies the path to the host TPM device's sysfs 238992dcc234SStefan Bergerentry allowing for cancellation of an ongoing TPM command. 239092dcc234SStefan Berger@option{cancel-path} is optional and by default QEMU will search for the 239192dcc234SStefan Bergersysfs entry to use. 239292dcc234SStefan Berger 23934549a8b7SStefan BergerSome notes about using the host's TPM with the passthrough driver: 23944549a8b7SStefan Berger 23954549a8b7SStefan BergerThe TPM device accessed by the passthrough driver must not be 23964549a8b7SStefan Bergerused by any other application on the host. 23974549a8b7SStefan Berger 23984549a8b7SStefan BergerSince the host's firmware (BIOS/UEFI) has already initialized the TPM, 23994549a8b7SStefan Bergerthe VM's firmware (BIOS/UEFI) will not be able to initialize the 24004549a8b7SStefan BergerTPM again and may therefore not show a TPM-specific menu that would 24014549a8b7SStefan Bergerotherwise allow the user to configure the TPM, e.g., allow the user to 24024549a8b7SStefan Bergerenable/disable or activate/deactivate the TPM. 24034549a8b7SStefan BergerFurther, if TPM ownership is released from within a VM then the host's TPM 24044549a8b7SStefan Bergerwill get disabled and deactivated. To enable and activate the 24054549a8b7SStefan BergerTPM again afterwards, the host has to be rebooted and the user is 24064549a8b7SStefan Bergerrequired to enter the firmware's menu to enable and activate the TPM. 24074549a8b7SStefan BergerIf the TPM is left disabled and/or deactivated most TPM commands will fail. 24084549a8b7SStefan Berger 24094549a8b7SStefan BergerTo create a passthrough TPM use the following two options: 24104549a8b7SStefan Berger@example 24114549a8b7SStefan Berger-tpmdev passthrough,id=tpm0 -device tpm-tis,tpmdev=tpm0 24124549a8b7SStefan Berger@end example 24134549a8b7SStefan BergerNote that the @code{-tpmdev} id is @code{tpm0} and is referenced by 24144549a8b7SStefan Berger@code{tpmdev=tpm0} in the device option. 24154549a8b7SStefan Berger 2416d1a0cf73SStefan Berger@end table 2417d1a0cf73SStefan Berger 2418d1a0cf73SStefan BergerETEXI 2419d1a0cf73SStefan Berger 2420d1a0cf73SStefan BergerDEFHEADING() 2421d1a0cf73SStefan Berger 2422d1a0cf73SStefan Berger#endif 2423d1a0cf73SStefan Berger 24247677f05dSAlexander GrafDEFHEADING(Linux/Multiboot boot specific:) 24255824d651Sblueswir1STEXI 24267677f05dSAlexander Graf 24277677f05dSAlexander GrafWhen using these options, you can use a given Linux or Multiboot 24287677f05dSAlexander Grafkernel without installing it in the disk image. It can be useful 24295824d651Sblueswir1for easier testing of various kernels. 24305824d651Sblueswir1 24315824d651Sblueswir1@table @option 24325824d651Sblueswir1ETEXI 24335824d651Sblueswir1 24345824d651Sblueswir1DEF("kernel", HAS_ARG, QEMU_OPTION_kernel, \ 2435ad96090aSBlue Swirl "-kernel bzImage use 'bzImage' as kernel image\n", QEMU_ARCH_ALL) 24365824d651Sblueswir1STEXI 24375824d651Sblueswir1@item -kernel @var{bzImage} 24386616b2adSStefan Weil@findex -kernel 24397677f05dSAlexander GrafUse @var{bzImage} as kernel image. The kernel can be either a Linux kernel 24407677f05dSAlexander Grafor in multiboot format. 24415824d651Sblueswir1ETEXI 24425824d651Sblueswir1 24435824d651Sblueswir1DEF("append", HAS_ARG, QEMU_OPTION_append, \ 2444ad96090aSBlue Swirl "-append cmdline use 'cmdline' as kernel command line\n", QEMU_ARCH_ALL) 24455824d651Sblueswir1STEXI 24465824d651Sblueswir1@item -append @var{cmdline} 24476616b2adSStefan Weil@findex -append 24485824d651Sblueswir1Use @var{cmdline} as kernel command line 24495824d651Sblueswir1ETEXI 24505824d651Sblueswir1 24515824d651Sblueswir1DEF("initrd", HAS_ARG, QEMU_OPTION_initrd, \ 2452ad96090aSBlue Swirl "-initrd file use 'file' as initial ram disk\n", QEMU_ARCH_ALL) 24535824d651Sblueswir1STEXI 24545824d651Sblueswir1@item -initrd @var{file} 24556616b2adSStefan Weil@findex -initrd 24565824d651Sblueswir1Use @var{file} as initial ram disk. 24577677f05dSAlexander Graf 24587677f05dSAlexander Graf@item -initrd "@var{file1} arg=foo,@var{file2}" 24597677f05dSAlexander Graf 24607677f05dSAlexander GrafThis syntax is only available with multiboot. 24617677f05dSAlexander Graf 24627677f05dSAlexander GrafUse @var{file1} and @var{file2} as modules and pass arg=foo as parameter to the 24637677f05dSAlexander Graffirst module. 24645824d651Sblueswir1ETEXI 24655824d651Sblueswir1 2466412beee6SGrant LikelyDEF("dtb", HAS_ARG, QEMU_OPTION_dtb, \ 2467379b5c7cSPeter A. G. Crosthwaite "-dtb file use 'file' as device tree image\n", QEMU_ARCH_ALL) 2468412beee6SGrant LikelySTEXI 2469412beee6SGrant Likely@item -dtb @var{file} 2470412beee6SGrant Likely@findex -dtb 2471412beee6SGrant LikelyUse @var{file} as a device tree binary (dtb) image and pass it to the kernel 2472412beee6SGrant Likelyon boot. 2473412beee6SGrant LikelyETEXI 2474412beee6SGrant Likely 24755824d651Sblueswir1STEXI 24765824d651Sblueswir1@end table 24775824d651Sblueswir1ETEXI 24785824d651Sblueswir1DEFHEADING() 24795824d651Sblueswir1 24805824d651Sblueswir1DEFHEADING(Debug/Expert options:) 24815824d651Sblueswir1STEXI 24825824d651Sblueswir1@table @option 24835824d651Sblueswir1ETEXI 24845824d651Sblueswir1 24855824d651Sblueswir1DEF("serial", HAS_ARG, QEMU_OPTION_serial, \ 2486ad96090aSBlue Swirl "-serial dev redirect the serial port to char device 'dev'\n", 2487ad96090aSBlue Swirl QEMU_ARCH_ALL) 24885824d651Sblueswir1STEXI 24895824d651Sblueswir1@item -serial @var{dev} 24906616b2adSStefan Weil@findex -serial 24915824d651Sblueswir1Redirect the virtual serial port to host character device 24925824d651Sblueswir1@var{dev}. The default device is @code{vc} in graphical mode and 24935824d651Sblueswir1@code{stdio} in non graphical mode. 24945824d651Sblueswir1 24955824d651Sblueswir1This option can be used several times to simulate up to 4 serial 24965824d651Sblueswir1ports. 24975824d651Sblueswir1 24985824d651Sblueswir1Use @code{-serial none} to disable all serial ports. 24995824d651Sblueswir1 25005824d651Sblueswir1Available character devices are: 2501b3f046c2SKevin Wolf@table @option 25024e257e5eSKevin Wolf@item vc[:@var{W}x@var{H}] 25035824d651Sblueswir1Virtual console. Optionally, a width and height can be given in pixel with 25045824d651Sblueswir1@example 25055824d651Sblueswir1vc:800x600 25065824d651Sblueswir1@end example 25075824d651Sblueswir1It is also possible to specify width or height in characters: 25085824d651Sblueswir1@example 25095824d651Sblueswir1vc:80Cx24C 25105824d651Sblueswir1@end example 25115824d651Sblueswir1@item pty 25125824d651Sblueswir1[Linux only] Pseudo TTY (a new PTY is automatically allocated) 25135824d651Sblueswir1@item none 25145824d651Sblueswir1No device is allocated. 25155824d651Sblueswir1@item null 25165824d651Sblueswir1void device 251788e020e5SIngo van Lil@item chardev:@var{id} 251888e020e5SIngo van LilUse a named character device defined with the @code{-chardev} option. 25195824d651Sblueswir1@item /dev/XXX 25205824d651Sblueswir1[Linux only] Use host tty, e.g. @file{/dev/ttyS0}. The host serial port 25215824d651Sblueswir1parameters are set according to the emulated ones. 25225824d651Sblueswir1@item /dev/parport@var{N} 25235824d651Sblueswir1[Linux only, parallel port only] Use host parallel port 25245824d651Sblueswir1@var{N}. Currently SPP and EPP parallel port features can be used. 25255824d651Sblueswir1@item file:@var{filename} 25265824d651Sblueswir1Write output to @var{filename}. No character can be read. 25275824d651Sblueswir1@item stdio 25285824d651Sblueswir1[Unix only] standard input/output 25295824d651Sblueswir1@item pipe:@var{filename} 25305824d651Sblueswir1name pipe @var{filename} 25315824d651Sblueswir1@item COM@var{n} 25325824d651Sblueswir1[Windows only] Use host serial port @var{n} 25335824d651Sblueswir1@item udp:[@var{remote_host}]:@var{remote_port}[@@[@var{src_ip}]:@var{src_port}] 25345824d651Sblueswir1This implements UDP Net Console. 25355824d651Sblueswir1When @var{remote_host} or @var{src_ip} are not specified 25365824d651Sblueswir1they default to @code{0.0.0.0}. 25375824d651Sblueswir1When not using a specified @var{src_port} a random port is automatically chosen. 25385824d651Sblueswir1 25395824d651Sblueswir1If you just want a simple readonly console you can use @code{netcat} or 2540b65ee4faSStefan Weil@code{nc}, by starting QEMU with: @code{-serial udp::4555} and nc as: 2541b65ee4faSStefan Weil@code{nc -u -l -p 4555}. Any time QEMU writes something to that port it 25425824d651Sblueswir1will appear in the netconsole session. 25435824d651Sblueswir1 25445824d651Sblueswir1If you plan to send characters back via netconsole or you want to stop 2545b65ee4faSStefan Weiland start QEMU a lot of times, you should have QEMU use the same 25465824d651Sblueswir1source port each time by using something like @code{-serial 2547b65ee4faSStefan Weiludp::4555@@:4556} to QEMU. Another approach is to use a patched 25485824d651Sblueswir1version of netcat which can listen to a TCP port and send and receive 25495824d651Sblueswir1characters via udp. If you have a patched version of netcat which 25505824d651Sblueswir1activates telnet remote echo and single char transfer, then you can 25515824d651Sblueswir1use the following options to step up a netcat redirector to allow 2552b65ee4faSStefan Weiltelnet on port 5555 to access the QEMU port. 25535824d651Sblueswir1@table @code 2554071c9394SStefan Weil@item QEMU Options: 25555824d651Sblueswir1-serial udp::4555@@:4556 25565824d651Sblueswir1@item netcat options: 25575824d651Sblueswir1-u -P 4555 -L 0.0.0.0:4556 -t -p 5555 -I -T 25585824d651Sblueswir1@item telnet options: 25595824d651Sblueswir1localhost 5555 25605824d651Sblueswir1@end table 25615824d651Sblueswir1 25625824d651Sblueswir1@item tcp:[@var{host}]:@var{port}[,@var{server}][,nowait][,nodelay] 25635824d651Sblueswir1The TCP Net Console has two modes of operation. It can send the serial 25645824d651Sblueswir1I/O to a location or wait for a connection from a location. By default 25655824d651Sblueswir1the TCP Net Console is sent to @var{host} at the @var{port}. If you use 25665824d651Sblueswir1the @var{server} option QEMU will wait for a client socket application 25675824d651Sblueswir1to connect to the port before continuing, unless the @code{nowait} 25685824d651Sblueswir1option was specified. The @code{nodelay} option disables the Nagle buffering 25695824d651Sblueswir1algorithm. If @var{host} is omitted, 0.0.0.0 is assumed. Only 25705824d651Sblueswir1one TCP connection at a time is accepted. You can use @code{telnet} to 25715824d651Sblueswir1connect to the corresponding character device. 25725824d651Sblueswir1@table @code 25735824d651Sblueswir1@item Example to send tcp console to 192.168.0.2 port 4444 25745824d651Sblueswir1-serial tcp:192.168.0.2:4444 25755824d651Sblueswir1@item Example to listen and wait on port 4444 for connection 25765824d651Sblueswir1-serial tcp::4444,server 25775824d651Sblueswir1@item Example to not wait and listen on ip 192.168.0.100 port 4444 25785824d651Sblueswir1-serial tcp:192.168.0.100:4444,server,nowait 25795824d651Sblueswir1@end table 25805824d651Sblueswir1 25815824d651Sblueswir1@item telnet:@var{host}:@var{port}[,server][,nowait][,nodelay] 25825824d651Sblueswir1The telnet protocol is used instead of raw tcp sockets. The options 25835824d651Sblueswir1work the same as if you had specified @code{-serial tcp}. The 25845824d651Sblueswir1difference is that the port acts like a telnet server or client using 25855824d651Sblueswir1telnet option negotiation. This will also allow you to send the 25865824d651Sblueswir1MAGIC_SYSRQ sequence if you use a telnet that supports sending the break 25875824d651Sblueswir1sequence. Typically in unix telnet you do it with Control-] and then 25885824d651Sblueswir1type "send break" followed by pressing the enter key. 25895824d651Sblueswir1 25905824d651Sblueswir1@item unix:@var{path}[,server][,nowait] 25915824d651Sblueswir1A unix domain socket is used instead of a tcp socket. The option works the 25925824d651Sblueswir1same as if you had specified @code{-serial tcp} except the unix domain socket 25935824d651Sblueswir1@var{path} is used for connections. 25945824d651Sblueswir1 25955824d651Sblueswir1@item mon:@var{dev_string} 25965824d651Sblueswir1This is a special option to allow the monitor to be multiplexed onto 25975824d651Sblueswir1another serial port. The monitor is accessed with key sequence of 259802c4bdf1SPaolo Bonzini@key{Control-a} and then pressing @key{c}. 25995824d651Sblueswir1@var{dev_string} should be any one of the serial devices specified 26005824d651Sblueswir1above. An example to multiplex the monitor onto a telnet server 26015824d651Sblueswir1listening on port 4444 would be: 26025824d651Sblueswir1@table @code 26035824d651Sblueswir1@item -serial mon:telnet::4444,server,nowait 26045824d651Sblueswir1@end table 2605be022d61SMichael TokarevWhen the monitor is multiplexed to stdio in this way, Ctrl+C will not terminate 260602c4bdf1SPaolo BonziniQEMU any more but will be passed to the guest instead. 26075824d651Sblueswir1 26085824d651Sblueswir1@item braille 26095824d651Sblueswir1Braille device. This will use BrlAPI to display the braille output on a real 26105824d651Sblueswir1or fake device. 26115824d651Sblueswir1 2612be8b28a9SKevin Wolf@item msmouse 2613be8b28a9SKevin WolfThree button serial mouse. Configure the guest to use Microsoft protocol. 26145824d651Sblueswir1@end table 26155824d651Sblueswir1ETEXI 26165824d651Sblueswir1 26175824d651Sblueswir1DEF("parallel", HAS_ARG, QEMU_OPTION_parallel, \ 2618ad96090aSBlue Swirl "-parallel dev redirect the parallel port to char device 'dev'\n", 2619ad96090aSBlue Swirl QEMU_ARCH_ALL) 26205824d651Sblueswir1STEXI 26215824d651Sblueswir1@item -parallel @var{dev} 26226616b2adSStefan Weil@findex -parallel 26235824d651Sblueswir1Redirect the virtual parallel port to host device @var{dev} (same 26245824d651Sblueswir1devices as the serial port). On Linux hosts, @file{/dev/parportN} can 26255824d651Sblueswir1be used to use hardware devices connected on the corresponding host 26265824d651Sblueswir1parallel port. 26275824d651Sblueswir1 26285824d651Sblueswir1This option can be used several times to simulate up to 3 parallel 26295824d651Sblueswir1ports. 26305824d651Sblueswir1 26315824d651Sblueswir1Use @code{-parallel none} to disable all parallel ports. 26325824d651Sblueswir1ETEXI 26335824d651Sblueswir1 26345824d651Sblueswir1DEF("monitor", HAS_ARG, QEMU_OPTION_monitor, \ 2635ad96090aSBlue Swirl "-monitor dev redirect the monitor to char device 'dev'\n", 2636ad96090aSBlue Swirl QEMU_ARCH_ALL) 26375824d651Sblueswir1STEXI 26384e307fc8SGerd Hoffmann@item -monitor @var{dev} 26396616b2adSStefan Weil@findex -monitor 26405824d651Sblueswir1Redirect the monitor to host device @var{dev} (same devices as the 26415824d651Sblueswir1serial port). 26425824d651Sblueswir1The default device is @code{vc} in graphical mode and @code{stdio} in 26435824d651Sblueswir1non graphical mode. 264470e098afSLuiz CapitulinoUse @code{-monitor none} to disable the default monitor. 26455824d651Sblueswir1ETEXI 26466ca5582dSGerd HoffmannDEF("qmp", HAS_ARG, QEMU_OPTION_qmp, \ 2647ad96090aSBlue Swirl "-qmp dev like -monitor but opens in 'control' mode\n", 2648ad96090aSBlue Swirl QEMU_ARCH_ALL) 264995d5f08bSStefan WeilSTEXI 265095d5f08bSStefan Weil@item -qmp @var{dev} 26516616b2adSStefan Weil@findex -qmp 265295d5f08bSStefan WeilLike -monitor but opens in 'control' mode. 265395d5f08bSStefan WeilETEXI 26545824d651Sblueswir1 265522a0e04bSGerd HoffmannDEF("mon", HAS_ARG, QEMU_OPTION_mon, \ 2656f17e4eaaSMichael Tokarev "-mon [chardev=]name[,mode=readline|control][,default]\n", QEMU_ARCH_ALL) 265722a0e04bSGerd HoffmannSTEXI 2658f17e4eaaSMichael Tokarev@item -mon [chardev=]name[,mode=readline|control][,default] 26596616b2adSStefan Weil@findex -mon 266022a0e04bSGerd HoffmannSetup monitor on chardev @var{name}. 266122a0e04bSGerd HoffmannETEXI 266222a0e04bSGerd Hoffmann 2663c9f398e5SH. Peter AnvinDEF("debugcon", HAS_ARG, QEMU_OPTION_debugcon, \ 2664ad96090aSBlue Swirl "-debugcon dev redirect the debug console to char device 'dev'\n", 2665ad96090aSBlue Swirl QEMU_ARCH_ALL) 2666c9f398e5SH. Peter AnvinSTEXI 2667c9f398e5SH. Peter Anvin@item -debugcon @var{dev} 26686616b2adSStefan Weil@findex -debugcon 2669c9f398e5SH. Peter AnvinRedirect the debug console to host device @var{dev} (same devices as the 2670c9f398e5SH. Peter Anvinserial port). The debug console is an I/O port which is typically port 2671c9f398e5SH. Peter Anvin0xe9; writing to that I/O port sends output to this device. 2672c9f398e5SH. Peter AnvinThe default device is @code{vc} in graphical mode and @code{stdio} in 2673c9f398e5SH. Peter Anvinnon graphical mode. 2674c9f398e5SH. Peter AnvinETEXI 2675c9f398e5SH. Peter Anvin 26765824d651Sblueswir1DEF("pidfile", HAS_ARG, QEMU_OPTION_pidfile, \ 2677ad96090aSBlue Swirl "-pidfile file write PID to 'file'\n", QEMU_ARCH_ALL) 26785824d651Sblueswir1STEXI 26795824d651Sblueswir1@item -pidfile @var{file} 26806616b2adSStefan Weil@findex -pidfile 26815824d651Sblueswir1Store the QEMU process PID in @var{file}. It is useful if you launch QEMU 26825824d651Sblueswir1from a script. 26835824d651Sblueswir1ETEXI 26845824d651Sblueswir1 26851b530a6dSaurel32DEF("singlestep", 0, QEMU_OPTION_singlestep, \ 2686ad96090aSBlue Swirl "-singlestep always run in singlestep mode\n", QEMU_ARCH_ALL) 26871b530a6dSaurel32STEXI 26881b530a6dSaurel32@item -singlestep 26896616b2adSStefan Weil@findex -singlestep 26901b530a6dSaurel32Run the emulation in single step mode. 26911b530a6dSaurel32ETEXI 26921b530a6dSaurel32 26935824d651Sblueswir1DEF("S", 0, QEMU_OPTION_S, \ 2694ad96090aSBlue Swirl "-S freeze CPU at startup (use 'c' to start execution)\n", 2695ad96090aSBlue Swirl QEMU_ARCH_ALL) 26965824d651Sblueswir1STEXI 26975824d651Sblueswir1@item -S 26986616b2adSStefan Weil@findex -S 26995824d651Sblueswir1Do not start CPU at startup (you must type 'c' in the monitor). 27005824d651Sblueswir1ETEXI 27015824d651Sblueswir1 2702888a6bc6SSatoru MoriyaDEF("realtime", HAS_ARG, QEMU_OPTION_realtime, 2703888a6bc6SSatoru Moriya "-realtime [mlock=on|off]\n" 2704888a6bc6SSatoru Moriya " run qemu with realtime features\n" 2705888a6bc6SSatoru Moriya " mlock=on|off controls mlock support (default: on)\n", 2706888a6bc6SSatoru Moriya QEMU_ARCH_ALL) 2707888a6bc6SSatoru MoriyaSTEXI 2708888a6bc6SSatoru Moriya@item -realtime mlock=on|off 2709888a6bc6SSatoru Moriya@findex -realtime 2710888a6bc6SSatoru MoriyaRun qemu with realtime features. 2711888a6bc6SSatoru Moriyamlocking qemu and guest memory can be enabled via @option{mlock=on} 2712888a6bc6SSatoru Moriya(enabled by default). 2713888a6bc6SSatoru MoriyaETEXI 2714888a6bc6SSatoru Moriya 271559030a8cSaliguoriDEF("gdb", HAS_ARG, QEMU_OPTION_gdb, \ 2716ad96090aSBlue Swirl "-gdb dev wait for gdb connection on 'dev'\n", QEMU_ARCH_ALL) 27175824d651Sblueswir1STEXI 271859030a8cSaliguori@item -gdb @var{dev} 27196616b2adSStefan Weil@findex -gdb 272059030a8cSaliguoriWait for gdb connection on device @var{dev} (@pxref{gdb_usage}). Typical 272159030a8cSaliguoriconnections will likely be TCP-based, but also UDP, pseudo TTY, or even 2722b65ee4faSStefan Weilstdio are reasonable use case. The latter is allowing to start QEMU from 272359030a8cSaliguoriwithin gdb and establish the connection via a pipe: 272459030a8cSaliguori@example 27253804da9dSStefan Weil(gdb) target remote | exec qemu-system-i386 -gdb stdio ... 272659030a8cSaliguori@end example 27275824d651Sblueswir1ETEXI 27285824d651Sblueswir1 272959030a8cSaliguoriDEF("s", 0, QEMU_OPTION_s, \ 2730ad96090aSBlue Swirl "-s shorthand for -gdb tcp::" DEFAULT_GDBSTUB_PORT "\n", 2731ad96090aSBlue Swirl QEMU_ARCH_ALL) 27325824d651Sblueswir1STEXI 273359030a8cSaliguori@item -s 27346616b2adSStefan Weil@findex -s 273559030a8cSaliguoriShorthand for -gdb tcp::1234, i.e. open a gdbserver on TCP port 1234 273659030a8cSaliguori(@pxref{gdb_usage}). 27375824d651Sblueswir1ETEXI 27385824d651Sblueswir1 27395824d651Sblueswir1DEF("d", HAS_ARG, QEMU_OPTION_d, \ 2740989b697dSPeter Maydell "-d item1,... enable logging of specified items (use '-d help' for a list of log items)\n", 2741ad96090aSBlue Swirl QEMU_ARCH_ALL) 27425824d651Sblueswir1STEXI 2743989b697dSPeter Maydell@item -d @var{item1}[,...] 27446616b2adSStefan Weil@findex -d 2745989b697dSPeter MaydellEnable logging of specified items. Use '-d help' for a list of log items. 27465824d651Sblueswir1ETEXI 27475824d651Sblueswir1 2748c235d738SMatthew FernandezDEF("D", HAS_ARG, QEMU_OPTION_D, \ 2749989b697dSPeter Maydell "-D logfile output log to logfile (default stderr)\n", 2750c235d738SMatthew Fernandez QEMU_ARCH_ALL) 2751c235d738SMatthew FernandezSTEXI 27528bd383b4SStefan Weil@item -D @var{logfile} 2753c235d738SMatthew Fernandez@findex -D 2754989b697dSPeter MaydellOutput log in @var{logfile} instead of to stderr 2755c235d738SMatthew FernandezETEXI 2756c235d738SMatthew Fernandez 27575824d651Sblueswir1DEF("L", HAS_ARG, QEMU_OPTION_L, \ 2758ad96090aSBlue Swirl "-L path set the directory for the BIOS, VGA BIOS and keymaps\n", 2759ad96090aSBlue Swirl QEMU_ARCH_ALL) 27605824d651Sblueswir1STEXI 27615824d651Sblueswir1@item -L @var{path} 27626616b2adSStefan Weil@findex -L 27635824d651Sblueswir1Set the directory for the BIOS, VGA BIOS and keymaps. 27645824d651Sblueswir1ETEXI 27655824d651Sblueswir1 27665824d651Sblueswir1DEF("bios", HAS_ARG, QEMU_OPTION_bios, \ 2767ad96090aSBlue Swirl "-bios file set the filename for the BIOS\n", QEMU_ARCH_ALL) 27685824d651Sblueswir1STEXI 27695824d651Sblueswir1@item -bios @var{file} 27706616b2adSStefan Weil@findex -bios 27715824d651Sblueswir1Set the filename for the BIOS. 27725824d651Sblueswir1ETEXI 27735824d651Sblueswir1 27745824d651Sblueswir1DEF("enable-kvm", 0, QEMU_OPTION_enable_kvm, \ 2775ad96090aSBlue Swirl "-enable-kvm enable KVM full virtualization support\n", QEMU_ARCH_ALL) 27765824d651Sblueswir1STEXI 27775824d651Sblueswir1@item -enable-kvm 27786616b2adSStefan Weil@findex -enable-kvm 27795824d651Sblueswir1Enable KVM full virtualization support. This option is only available 27805824d651Sblueswir1if KVM support is enabled when compiling. 27815824d651Sblueswir1ETEXI 27825824d651Sblueswir1 2783e37630caSaliguoriDEF("xen-domid", HAS_ARG, QEMU_OPTION_xen_domid, 2784ad96090aSBlue Swirl "-xen-domid id specify xen guest domain id\n", QEMU_ARCH_ALL) 2785e37630caSaliguoriDEF("xen-create", 0, QEMU_OPTION_xen_create, 2786e37630caSaliguori "-xen-create create domain using xen hypercalls, bypassing xend\n" 2787ad96090aSBlue Swirl " warning: should not be used when xend is in use\n", 2788ad96090aSBlue Swirl QEMU_ARCH_ALL) 2789e37630caSaliguoriDEF("xen-attach", 0, QEMU_OPTION_xen_attach, 2790e37630caSaliguori "-xen-attach attach to existing xen domain\n" 2791b65ee4faSStefan Weil " xend will use this when starting QEMU\n", 2792ad96090aSBlue Swirl QEMU_ARCH_ALL) 279395d5f08bSStefan WeilSTEXI 279495d5f08bSStefan Weil@item -xen-domid @var{id} 27956616b2adSStefan Weil@findex -xen-domid 279695d5f08bSStefan WeilSpecify xen guest domain @var{id} (XEN only). 279795d5f08bSStefan Weil@item -xen-create 27986616b2adSStefan Weil@findex -xen-create 279995d5f08bSStefan WeilCreate domain using xen hypercalls, bypassing xend. 280095d5f08bSStefan WeilWarning: should not be used when xend is in use (XEN only). 280195d5f08bSStefan Weil@item -xen-attach 28026616b2adSStefan Weil@findex -xen-attach 280395d5f08bSStefan WeilAttach to existing xen domain. 2804b65ee4faSStefan Weilxend will use this when starting QEMU (XEN only). 280595d5f08bSStefan WeilETEXI 2806e37630caSaliguori 28075824d651Sblueswir1DEF("no-reboot", 0, QEMU_OPTION_no_reboot, \ 2808ad96090aSBlue Swirl "-no-reboot exit instead of rebooting\n", QEMU_ARCH_ALL) 28095824d651Sblueswir1STEXI 28105824d651Sblueswir1@item -no-reboot 28116616b2adSStefan Weil@findex -no-reboot 28125824d651Sblueswir1Exit instead of rebooting. 28135824d651Sblueswir1ETEXI 28145824d651Sblueswir1 28155824d651Sblueswir1DEF("no-shutdown", 0, QEMU_OPTION_no_shutdown, \ 2816ad96090aSBlue Swirl "-no-shutdown stop before shutdown\n", QEMU_ARCH_ALL) 28175824d651Sblueswir1STEXI 28185824d651Sblueswir1@item -no-shutdown 28196616b2adSStefan Weil@findex -no-shutdown 28205824d651Sblueswir1Don't exit QEMU on guest shutdown, but instead only stop the emulation. 28215824d651Sblueswir1This allows for instance switching to monitor to commit changes to the 28225824d651Sblueswir1disk image. 28235824d651Sblueswir1ETEXI 28245824d651Sblueswir1 28255824d651Sblueswir1DEF("loadvm", HAS_ARG, QEMU_OPTION_loadvm, \ 28265824d651Sblueswir1 "-loadvm [tag|id]\n" \ 2827ad96090aSBlue Swirl " start right away with a saved state (loadvm in monitor)\n", 2828ad96090aSBlue Swirl QEMU_ARCH_ALL) 28295824d651Sblueswir1STEXI 28305824d651Sblueswir1@item -loadvm @var{file} 28316616b2adSStefan Weil@findex -loadvm 28325824d651Sblueswir1Start right away with a saved state (@code{loadvm} in monitor) 28335824d651Sblueswir1ETEXI 28345824d651Sblueswir1 28355824d651Sblueswir1#ifndef _WIN32 28365824d651Sblueswir1DEF("daemonize", 0, QEMU_OPTION_daemonize, \ 2837ad96090aSBlue Swirl "-daemonize daemonize QEMU after initializing\n", QEMU_ARCH_ALL) 28385824d651Sblueswir1#endif 28395824d651Sblueswir1STEXI 28405824d651Sblueswir1@item -daemonize 28416616b2adSStefan Weil@findex -daemonize 28425824d651Sblueswir1Daemonize the QEMU process after initialization. QEMU will not detach from 28435824d651Sblueswir1standard IO until it is ready to receive connections on any of its devices. 28445824d651Sblueswir1This option is a useful way for external programs to launch QEMU without having 28455824d651Sblueswir1to cope with initialization race conditions. 28465824d651Sblueswir1ETEXI 28475824d651Sblueswir1 28485824d651Sblueswir1DEF("option-rom", HAS_ARG, QEMU_OPTION_option_rom, \ 2849ad96090aSBlue Swirl "-option-rom rom load a file, rom, into the option ROM space\n", 2850ad96090aSBlue Swirl QEMU_ARCH_ALL) 28515824d651Sblueswir1STEXI 28525824d651Sblueswir1@item -option-rom @var{file} 28536616b2adSStefan Weil@findex -option-rom 28545824d651Sblueswir1Load the contents of @var{file} as an option ROM. 28555824d651Sblueswir1This option is useful to load things like EtherBoot. 28565824d651Sblueswir1ETEXI 28575824d651Sblueswir1 28585824d651Sblueswir1DEF("clock", HAS_ARG, QEMU_OPTION_clock, \ 28595824d651Sblueswir1 "-clock force the use of the given methods for timer alarm.\n" \ 2860585f6036SPeter Maydell " To see what timers are available use '-clock help'\n", 2861ad96090aSBlue Swirl QEMU_ARCH_ALL) 28625824d651Sblueswir1STEXI 28635824d651Sblueswir1@item -clock @var{method} 28646616b2adSStefan Weil@findex -clock 28655824d651Sblueswir1Force the use of the given methods for timer alarm. To see what timers 2866585f6036SPeter Maydellare available use @code{-clock help}. 28675824d651Sblueswir1ETEXI 28685824d651Sblueswir1 28691ed2fc1fSJan KiszkaHXCOMM Options deprecated by -rtc 2870ad96090aSBlue SwirlDEF("localtime", 0, QEMU_OPTION_localtime, "", QEMU_ARCH_ALL) 2871ad96090aSBlue SwirlDEF("startdate", HAS_ARG, QEMU_OPTION_startdate, "", QEMU_ARCH_ALL) 28725824d651Sblueswir1 28731ed2fc1fSJan KiszkaDEF("rtc", HAS_ARG, QEMU_OPTION_rtc, \ 287478808141SPaolo Bonzini "-rtc [base=utc|localtime|date][,clock=host|rt|vm][,driftfix=none|slew]\n" \ 2875ad96090aSBlue Swirl " set the RTC base and clock, enable drift fix for clock ticks (x86 only)\n", 2876ad96090aSBlue Swirl QEMU_ARCH_ALL) 28771ed2fc1fSJan Kiszka 28785824d651Sblueswir1STEXI 28795824d651Sblueswir1 28806875204cSJan Kiszka@item -rtc [base=utc|localtime|@var{date}][,clock=host|vm][,driftfix=none|slew] 28816616b2adSStefan Weil@findex -rtc 28821ed2fc1fSJan KiszkaSpecify @option{base} as @code{utc} or @code{localtime} to let the RTC start at the current 28831ed2fc1fSJan KiszkaUTC or local time, respectively. @code{localtime} is required for correct date in 28841ed2fc1fSJan KiszkaMS-DOS or Windows. To start at a specific point in time, provide @var{date} in the 28851ed2fc1fSJan Kiszkaformat @code{2006-06-17T16:01:21} or @code{2006-06-17}. The default base is UTC. 28861ed2fc1fSJan Kiszka 28879d85d557SMichael TokarevBy default the RTC is driven by the host system time. This allows using of the 28886875204cSJan KiszkaRTC as accurate reference clock inside the guest, specifically if the host 28896875204cSJan Kiszkatime is smoothly following an accurate external reference clock, e.g. via NTP. 289078808141SPaolo BonziniIf you want to isolate the guest time from the host, you can set @option{clock} 289178808141SPaolo Bonzinito @code{rt} instead. To even prevent it from progressing during suspension, 289278808141SPaolo Bonziniyou can set it to @code{vm}. 28936875204cSJan Kiszka 28941ed2fc1fSJan KiszkaEnable @option{driftfix} (i386 targets only) if you experience time drift problems, 28951ed2fc1fSJan Kiszkaspecifically with Windows' ACPI HAL. This option will try to figure out how 28961ed2fc1fSJan Kiszkamany timer interrupts were not processed by the Windows guest and will 28971ed2fc1fSJan Kiszkare-inject them. 28985824d651Sblueswir1ETEXI 28995824d651Sblueswir1 29005824d651Sblueswir1DEF("icount", HAS_ARG, QEMU_OPTION_icount, \ 29015824d651Sblueswir1 "-icount [N|auto]\n" \ 2902bc14ca24Saliguori " enable virtual instruction counter with 2^N clock ticks per\n" \ 2903ad96090aSBlue Swirl " instruction\n", QEMU_ARCH_ALL) 29045824d651Sblueswir1STEXI 29054e257e5eSKevin Wolf@item -icount [@var{N}|auto] 29066616b2adSStefan Weil@findex -icount 29075824d651Sblueswir1Enable virtual instruction counter. The virtual cpu will execute one 29084e257e5eSKevin Wolfinstruction every 2^@var{N} ns of virtual time. If @code{auto} is specified 29095824d651Sblueswir1then the virtual cpu speed will be automatically adjusted to keep virtual 29105824d651Sblueswir1time within a few seconds of real time. 29115824d651Sblueswir1 29125824d651Sblueswir1Note that while this option can give deterministic behavior, it does not 29135824d651Sblueswir1provide cycle accurate emulation. Modern CPUs contain superscalar out of 29145824d651Sblueswir1order cores with complex cache hierarchies. The number of instructions 29155824d651Sblueswir1executed often has little or no correlation with actual performance. 29165824d651Sblueswir1ETEXI 29175824d651Sblueswir1 29189dd986ccSRichard W.M. JonesDEF("watchdog", HAS_ARG, QEMU_OPTION_watchdog, \ 29199dd986ccSRichard W.M. Jones "-watchdog i6300esb|ib700\n" \ 2920ad96090aSBlue Swirl " enable virtual hardware watchdog [default=none]\n", 2921ad96090aSBlue Swirl QEMU_ARCH_ALL) 29229dd986ccSRichard W.M. JonesSTEXI 29239dd986ccSRichard W.M. Jones@item -watchdog @var{model} 29246616b2adSStefan Weil@findex -watchdog 29259dd986ccSRichard W.M. JonesCreate a virtual hardware watchdog device. Once enabled (by a guest 29269dd986ccSRichard W.M. Jonesaction), the watchdog must be periodically polled by an agent inside 29279dd986ccSRichard W.M. Jonesthe guest or else the guest will be restarted. 29289dd986ccSRichard W.M. Jones 29299dd986ccSRichard W.M. JonesThe @var{model} is the model of hardware watchdog to emulate. Choices 29309dd986ccSRichard W.M. Jonesfor model are: @code{ib700} (iBASE 700) which is a very simple ISA 29319dd986ccSRichard W.M. Joneswatchdog with a single timer, or @code{i6300esb} (Intel 6300ESB I/O 29329dd986ccSRichard W.M. Jonescontroller hub) which is a much more featureful PCI-based dual-timer 29339dd986ccSRichard W.M. Joneswatchdog. Choose a model for which your guest has drivers. 29349dd986ccSRichard W.M. Jones 2935585f6036SPeter MaydellUse @code{-watchdog help} to list available hardware models. Only one 29369dd986ccSRichard W.M. Joneswatchdog can be enabled for a guest. 29379dd986ccSRichard W.M. JonesETEXI 29389dd986ccSRichard W.M. Jones 29399dd986ccSRichard W.M. JonesDEF("watchdog-action", HAS_ARG, QEMU_OPTION_watchdog_action, \ 29409dd986ccSRichard W.M. Jones "-watchdog-action reset|shutdown|poweroff|pause|debug|none\n" \ 2941ad96090aSBlue Swirl " action when watchdog fires [default=reset]\n", 2942ad96090aSBlue Swirl QEMU_ARCH_ALL) 29439dd986ccSRichard W.M. JonesSTEXI 29449dd986ccSRichard W.M. Jones@item -watchdog-action @var{action} 2945b8f490ebSMarkus Armbruster@findex -watchdog-action 29469dd986ccSRichard W.M. Jones 29479dd986ccSRichard W.M. JonesThe @var{action} controls what QEMU will do when the watchdog timer 29489dd986ccSRichard W.M. Jonesexpires. 29499dd986ccSRichard W.M. JonesThe default is 29509dd986ccSRichard W.M. Jones@code{reset} (forcefully reset the guest). 29519dd986ccSRichard W.M. JonesOther possible actions are: 29529dd986ccSRichard W.M. Jones@code{shutdown} (attempt to gracefully shutdown the guest), 29539dd986ccSRichard W.M. Jones@code{poweroff} (forcefully poweroff the guest), 29549dd986ccSRichard W.M. Jones@code{pause} (pause the guest), 29559dd986ccSRichard W.M. Jones@code{debug} (print a debug message and continue), or 29569dd986ccSRichard W.M. Jones@code{none} (do nothing). 29579dd986ccSRichard W.M. Jones 29589dd986ccSRichard W.M. JonesNote that the @code{shutdown} action requires that the guest responds 29599dd986ccSRichard W.M. Jonesto ACPI signals, which it may not be able to do in the sort of 29609dd986ccSRichard W.M. Jonessituations where the watchdog would have expired, and thus 29619dd986ccSRichard W.M. Jones@code{-watchdog-action shutdown} is not recommended for production use. 29629dd986ccSRichard W.M. Jones 29639dd986ccSRichard W.M. JonesExamples: 29649dd986ccSRichard W.M. Jones 29659dd986ccSRichard W.M. Jones@table @code 29669dd986ccSRichard W.M. Jones@item -watchdog i6300esb -watchdog-action pause 29679dd986ccSRichard W.M. Jones@item -watchdog ib700 29689dd986ccSRichard W.M. Jones@end table 29699dd986ccSRichard W.M. JonesETEXI 29709dd986ccSRichard W.M. Jones 29715824d651Sblueswir1DEF("echr", HAS_ARG, QEMU_OPTION_echr, \ 2972ad96090aSBlue Swirl "-echr chr set terminal escape character instead of ctrl-a\n", 2973ad96090aSBlue Swirl QEMU_ARCH_ALL) 29745824d651Sblueswir1STEXI 29755824d651Sblueswir1 29764e257e5eSKevin Wolf@item -echr @var{numeric_ascii_value} 29776616b2adSStefan Weil@findex -echr 29785824d651Sblueswir1Change the escape character used for switching to the monitor when using 29795824d651Sblueswir1monitor and serial sharing. The default is @code{0x01} when using the 29805824d651Sblueswir1@code{-nographic} option. @code{0x01} is equal to pressing 29815824d651Sblueswir1@code{Control-a}. You can select a different character from the ascii 29825824d651Sblueswir1control keys where 1 through 26 map to Control-a through Control-z. For 29835824d651Sblueswir1instance you could use the either of the following to change the escape 29845824d651Sblueswir1character to Control-t. 29855824d651Sblueswir1@table @code 29865824d651Sblueswir1@item -echr 0x14 29875824d651Sblueswir1@item -echr 20 29885824d651Sblueswir1@end table 29895824d651Sblueswir1ETEXI 29905824d651Sblueswir1 29915824d651Sblueswir1DEF("virtioconsole", HAS_ARG, QEMU_OPTION_virtiocon, \ 29925824d651Sblueswir1 "-virtioconsole c\n" \ 2993ad96090aSBlue Swirl " set virtio console\n", QEMU_ARCH_ALL) 29945824d651Sblueswir1STEXI 29955824d651Sblueswir1@item -virtioconsole @var{c} 29966616b2adSStefan Weil@findex -virtioconsole 29975824d651Sblueswir1Set virtio console. 299898b19252SAmit Shah 299998b19252SAmit ShahThis option is maintained for backward compatibility. 300098b19252SAmit Shah 300198b19252SAmit ShahPlease use @code{-device virtconsole} for the new way of invocation. 30025824d651Sblueswir1ETEXI 30035824d651Sblueswir1 30045824d651Sblueswir1DEF("show-cursor", 0, QEMU_OPTION_show_cursor, \ 3005ad96090aSBlue Swirl "-show-cursor show cursor\n", QEMU_ARCH_ALL) 30065824d651Sblueswir1STEXI 300795d5f08bSStefan Weil@item -show-cursor 30086616b2adSStefan Weil@findex -show-cursor 300995d5f08bSStefan WeilShow cursor. 30105824d651Sblueswir1ETEXI 30115824d651Sblueswir1 30125824d651Sblueswir1DEF("tb-size", HAS_ARG, QEMU_OPTION_tb_size, \ 3013ad96090aSBlue Swirl "-tb-size n set TB size\n", QEMU_ARCH_ALL) 30145824d651Sblueswir1STEXI 301595d5f08bSStefan Weil@item -tb-size @var{n} 30166616b2adSStefan Weil@findex -tb-size 301795d5f08bSStefan WeilSet TB size. 30185824d651Sblueswir1ETEXI 30195824d651Sblueswir1 30205824d651Sblueswir1DEF("incoming", HAS_ARG, QEMU_OPTION_incoming, \ 3021ad96090aSBlue Swirl "-incoming p prepare for incoming migration, listen on port p\n", 3022ad96090aSBlue Swirl QEMU_ARCH_ALL) 30235824d651Sblueswir1STEXI 302495d5f08bSStefan Weil@item -incoming @var{port} 30256616b2adSStefan Weil@findex -incoming 302695d5f08bSStefan WeilPrepare for incoming migration, listen on @var{port}. 30275824d651Sblueswir1ETEXI 30285824d651Sblueswir1 3029d8c208ddSGerd HoffmannDEF("nodefaults", 0, QEMU_OPTION_nodefaults, \ 3030ad96090aSBlue Swirl "-nodefaults don't create default devices\n", QEMU_ARCH_ALL) 3031d8c208ddSGerd HoffmannSTEXI 30323dbf2c7fSStefan Weil@item -nodefaults 30336616b2adSStefan Weil@findex -nodefaults 303466c19bf1SMichal NovotnyDon't create default devices. Normally, QEMU sets the default devices like serial 303566c19bf1SMichal Novotnyport, parallel port, virtual console, monitor device, VGA adapter, floppy and 303666c19bf1SMichal NovotnyCD-ROM drive and others. The @code{-nodefaults} option will disable all those 303766c19bf1SMichal Novotnydefault devices. 3038d8c208ddSGerd HoffmannETEXI 3039d8c208ddSGerd Hoffmann 30405824d651Sblueswir1#ifndef _WIN32 30415824d651Sblueswir1DEF("chroot", HAS_ARG, QEMU_OPTION_chroot, \ 3042ad96090aSBlue Swirl "-chroot dir chroot to dir just before starting the VM\n", 3043ad96090aSBlue Swirl QEMU_ARCH_ALL) 30445824d651Sblueswir1#endif 30455824d651Sblueswir1STEXI 30464e257e5eSKevin Wolf@item -chroot @var{dir} 30476616b2adSStefan Weil@findex -chroot 30485824d651Sblueswir1Immediately before starting guest execution, chroot to the specified 30495824d651Sblueswir1directory. Especially useful in combination with -runas. 30505824d651Sblueswir1ETEXI 30515824d651Sblueswir1 30525824d651Sblueswir1#ifndef _WIN32 30535824d651Sblueswir1DEF("runas", HAS_ARG, QEMU_OPTION_runas, \ 3054ad96090aSBlue Swirl "-runas user change to user id user just before starting the VM\n", 3055ad96090aSBlue Swirl QEMU_ARCH_ALL) 30565824d651Sblueswir1#endif 30575824d651Sblueswir1STEXI 30584e257e5eSKevin Wolf@item -runas @var{user} 30596616b2adSStefan Weil@findex -runas 30605824d651Sblueswir1Immediately before starting guest execution, drop root privileges, switching 30615824d651Sblueswir1to the specified user. 30625824d651Sblueswir1ETEXI 30635824d651Sblueswir1 30645824d651Sblueswir1DEF("prom-env", HAS_ARG, QEMU_OPTION_prom_env, 30655824d651Sblueswir1 "-prom-env variable=value\n" 3066ad96090aSBlue Swirl " set OpenBIOS nvram variables\n", 3067ad96090aSBlue Swirl QEMU_ARCH_PPC | QEMU_ARCH_SPARC) 306895d5f08bSStefan WeilSTEXI 306995d5f08bSStefan Weil@item -prom-env @var{variable}=@var{value} 30706616b2adSStefan Weil@findex -prom-env 307195d5f08bSStefan WeilSet OpenBIOS nvram @var{variable} to given @var{value} (PPC, SPARC only). 307295d5f08bSStefan WeilETEXI 30735824d651Sblueswir1DEF("semihosting", 0, QEMU_OPTION_semihosting, 30741ddeaa5dSMax Filippov "-semihosting semihosting mode\n", QEMU_ARCH_ARM | QEMU_ARCH_M68K | QEMU_ARCH_XTENSA) 307595d5f08bSStefan WeilSTEXI 307695d5f08bSStefan Weil@item -semihosting 30776616b2adSStefan Weil@findex -semihosting 30781ddeaa5dSMax FilippovSemihosting mode (ARM, M68K, Xtensa only). 307995d5f08bSStefan WeilETEXI 30805824d651Sblueswir1DEF("old-param", 0, QEMU_OPTION_old_param, 3081ad96090aSBlue Swirl "-old-param old param mode\n", QEMU_ARCH_ARM) 308295d5f08bSStefan WeilSTEXI 308395d5f08bSStefan Weil@item -old-param 30846616b2adSStefan Weil@findex -old-param (ARM) 308595d5f08bSStefan WeilOld param mode (ARM only). 308695d5f08bSStefan WeilETEXI 308795d5f08bSStefan Weil 30887d76ad4fSEduardo OtuboDEF("sandbox", HAS_ARG, QEMU_OPTION_sandbox, \ 30897d76ad4fSEduardo Otubo "-sandbox <arg> Enable seccomp mode 2 system call filter (default 'off').\n", 30907d76ad4fSEduardo Otubo QEMU_ARCH_ALL) 30917d76ad4fSEduardo OtuboSTEXI 30926265c43bSMarkus Armbruster@item -sandbox @var{arg} 30937d76ad4fSEduardo Otubo@findex -sandbox 30947d76ad4fSEduardo OtuboEnable Seccomp mode 2 system call filter. 'on' will enable syscall filtering and 'off' will 30957d76ad4fSEduardo Otubodisable it. The default is 'off'. 30967d76ad4fSEduardo OtuboETEXI 30977d76ad4fSEduardo Otubo 3098715a664aSGerd HoffmannDEF("readconfig", HAS_ARG, QEMU_OPTION_readconfig, 3099ad96090aSBlue Swirl "-readconfig <file>\n", QEMU_ARCH_ALL) 31003dbf2c7fSStefan WeilSTEXI 31013dbf2c7fSStefan Weil@item -readconfig @var{file} 31026616b2adSStefan Weil@findex -readconfig 3103ed24cfacSMichal NovotnyRead device configuration from @var{file}. This approach is useful when you want to spawn 3104ed24cfacSMichal NovotnyQEMU process with many command line options but you don't want to exceed the command line 3105ed24cfacSMichal Novotnycharacter limit. 31063dbf2c7fSStefan WeilETEXI 3107715a664aSGerd HoffmannDEF("writeconfig", HAS_ARG, QEMU_OPTION_writeconfig, 3108715a664aSGerd Hoffmann "-writeconfig <file>\n" 3109ad96090aSBlue Swirl " read/write config file\n", QEMU_ARCH_ALL) 31103dbf2c7fSStefan WeilSTEXI 31113dbf2c7fSStefan Weil@item -writeconfig @var{file} 31126616b2adSStefan Weil@findex -writeconfig 3113ed24cfacSMichal NovotnyWrite device configuration to @var{file}. The @var{file} can be either filename to save 3114ed24cfacSMichal Novotnycommand line and device configuration into file or dash @code{-}) character to print the 3115ed24cfacSMichal Novotnyoutput to stdout. This can be later used as input file for @code{-readconfig} option. 31163dbf2c7fSStefan WeilETEXI 3117292444cbSAnthony LiguoriDEF("nodefconfig", 0, QEMU_OPTION_nodefconfig, 3118292444cbSAnthony Liguori "-nodefconfig\n" 3119ad96090aSBlue Swirl " do not load default config files at startup\n", 3120ad96090aSBlue Swirl QEMU_ARCH_ALL) 3121292444cbSAnthony LiguoriSTEXI 3122292444cbSAnthony Liguori@item -nodefconfig 31236616b2adSStefan Weil@findex -nodefconfig 3124f29a5614SEduardo HabkostNormally QEMU loads configuration files from @var{sysconfdir} and @var{datadir} at startup. 3125f29a5614SEduardo HabkostThe @code{-nodefconfig} option will prevent QEMU from loading any of those config files. 3126f29a5614SEduardo HabkostETEXI 3127f29a5614SEduardo HabkostDEF("no-user-config", 0, QEMU_OPTION_nouserconfig, 3128f29a5614SEduardo Habkost "-no-user-config\n" 3129f29a5614SEduardo Habkost " do not load user-provided config files at startup\n", 3130f29a5614SEduardo Habkost QEMU_ARCH_ALL) 3131f29a5614SEduardo HabkostSTEXI 3132f29a5614SEduardo Habkost@item -no-user-config 3133f29a5614SEduardo Habkost@findex -no-user-config 3134f29a5614SEduardo HabkostThe @code{-no-user-config} option makes QEMU not load any of the user-provided 3135f29a5614SEduardo Habkostconfig files on @var{sysconfdir}, but won't make it skip the QEMU-provided config 3136f29a5614SEduardo Habkostfiles from @var{datadir}. 3137292444cbSAnthony LiguoriETEXI 3138ab6540d5SPrerna SaxenaDEF("trace", HAS_ARG, QEMU_OPTION_trace, 313923d15e86SLluís "-trace [events=<file>][,file=<file>]\n" 314023d15e86SLluís " specify tracing options\n", 3141ab6540d5SPrerna Saxena QEMU_ARCH_ALL) 3142ab6540d5SPrerna SaxenaSTEXI 314323d15e86SLluísHXCOMM This line is not accurate, as some sub-options are backend-specific but 314423d15e86SLluísHXCOMM HX does not support conditional compilation of text. 314523d15e86SLluís@item -trace [events=@var{file}][,file=@var{file}] 3146ab6540d5SPrerna Saxena@findex -trace 3147e4858974SLluís 314823d15e86SLluísSpecify tracing options. 314923d15e86SLluís 315023d15e86SLluís@table @option 315123d15e86SLluís@item events=@var{file} 315223d15e86SLluísImmediately enable events listed in @var{file}. 315323d15e86SLluísThe file must contain one event name (as listed in the @var{trace-events} file) 315423d15e86SLluísper line. 3155c1ba4e0bSStefan WeilThis option is only available if QEMU has been compiled with 3156c1ba4e0bSStefan Weileither @var{simple} or @var{stderr} tracing backend. 315723d15e86SLluís@item file=@var{file} 315823d15e86SLluísLog output traces to @var{file}. 315923d15e86SLluís 3160c1ba4e0bSStefan WeilThis option is only available if QEMU has been compiled with 3161c1ba4e0bSStefan Weilthe @var{simple} tracing backend. 316223d15e86SLluís@end table 3163ab6540d5SPrerna SaxenaETEXI 31643dbf2c7fSStefan Weil 316531e70d6cSMarkus ArmbrusterHXCOMM Internal use 316631e70d6cSMarkus ArmbrusterDEF("qtest", HAS_ARG, QEMU_OPTION_qtest, "", QEMU_ARCH_ALL) 316731e70d6cSMarkus ArmbrusterDEF("qtest-log", HAS_ARG, QEMU_OPTION_qtest_log, "", QEMU_ARCH_ALL) 3168c7f0f3b1SAnthony Liguori 31690f66998fSPaul Moore#ifdef __linux__ 31700f66998fSPaul MooreDEF("enable-fips", 0, QEMU_OPTION_enablefips, 31710f66998fSPaul Moore "-enable-fips enable FIPS 140-2 compliance\n", 31720f66998fSPaul Moore QEMU_ARCH_ALL) 31730f66998fSPaul Moore#endif 31740f66998fSPaul MooreSTEXI 31750f66998fSPaul Moore@item -enable-fips 31760f66998fSPaul Moore@findex -enable-fips 31770f66998fSPaul MooreEnable FIPS 140-2 compliance mode. 31780f66998fSPaul MooreETEXI 31790f66998fSPaul Moore 3180a0dac021SJan KiszkaHXCOMM Deprecated by -machine accel=tcg property 3181c6e88b3bSBruce RogersDEF("no-kvm", 0, QEMU_OPTION_no_kvm, "", QEMU_ARCH_I386) 3182a0dac021SJan Kiszka 3183c21fb4f8SJan KiszkaHXCOMM Deprecated by kvm-pit driver properties 3184c6e88b3bSBruce RogersDEF("no-kvm-pit-reinjection", 0, QEMU_OPTION_no_kvm_pit_reinjection, 3185c21fb4f8SJan Kiszka "", QEMU_ARCH_I386) 3186c21fb4f8SJan Kiszka 31874086bde8SJan KiszkaHXCOMM Deprecated (ignored) 3188c6e88b3bSBruce RogersDEF("no-kvm-pit", 0, QEMU_OPTION_no_kvm_pit, "", QEMU_ARCH_I386) 31894086bde8SJan Kiszka 3190e43d594eSJan KiszkaHXCOMM Deprecated by -machine kernel_irqchip=on|off property 3191c6e88b3bSBruce RogersDEF("no-kvm-irqchip", 0, QEMU_OPTION_no_kvm_irqchip, "", QEMU_ARCH_I386) 3192e43d594eSJan Kiszka 319388eed34aSJan KiszkaHXCOMM Deprecated (ignored) 319488eed34aSJan KiszkaDEF("tdf", 0, QEMU_OPTION_tdf,"", QEMU_ARCH_ALL) 319588eed34aSJan Kiszka 319668d98d3eSAnthony LiguoriDEF("object", HAS_ARG, QEMU_OPTION_object, 319768d98d3eSAnthony Liguori "-object TYPENAME[,PROP1=VALUE1,...]\n" 319868d98d3eSAnthony Liguori " create an new object of type TYPENAME setting properties\n" 319968d98d3eSAnthony Liguori " in the order they are specified. Note that the 'id'\n" 320068d98d3eSAnthony Liguori " property must be set. These objects are placed in the\n" 320168d98d3eSAnthony Liguori " '/objects' path.\n", 320268d98d3eSAnthony Liguori QEMU_ARCH_ALL) 32036265c43bSMarkus ArmbrusterSTEXI 32046265c43bSMarkus Armbruster@item -object @var{typename}[,@var{prop1}=@var{value1},...] 32056265c43bSMarkus Armbruster@findex -object 32066265c43bSMarkus ArmbrusterCreate an new object of type @var{typename} setting properties 32076265c43bSMarkus Armbrusterin the order they are specified. Note that the 'id' 32086265c43bSMarkus Armbrusterproperty must be set. These objects are placed in the 32096265c43bSMarkus Armbruster'/objects' path. 32106265c43bSMarkus ArmbrusterETEXI 321168d98d3eSAnthony Liguori 32125e2ac519SSeiji AguchiDEF("msg", HAS_ARG, QEMU_OPTION_msg, 32135e2ac519SSeiji Aguchi "-msg timestamp[=on|off]\n" 32145e2ac519SSeiji Aguchi " change the format of messages\n" 32155e2ac519SSeiji Aguchi " on|off controls leading timestamps (default:on)\n", 32165e2ac519SSeiji Aguchi QEMU_ARCH_ALL) 32175e2ac519SSeiji AguchiSTEXI 32185e2ac519SSeiji Aguchi@item -msg timestamp[=on|off] 32195e2ac519SSeiji Aguchi@findex -msg 32205e2ac519SSeiji Aguchiprepend a timestamp to each log message.(default:on) 32215e2ac519SSeiji AguchiETEXI 32225e2ac519SSeiji Aguchi 32233dbf2c7fSStefan WeilHXCOMM This is the last statement. Insert new options before this line! 32243dbf2c7fSStefan WeilSTEXI 32253dbf2c7fSStefan Weil@end table 32263dbf2c7fSStefan WeilETEXI 3227