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" 36d1048befSDon Slutz " vmport=on|off|auto controls emulation of vmport (default: auto)\n" 37ddb97f1dSJason Baron " kvm_shadow_mem=size of KVM shadow MMU\n" 388490fc78SLuiz Capitulino " dump-guest-core=on|off include guest memory in a core dump (default=on)\n" 39a52a7fdfSLe Tan " mem-merge=on|off controls memory merge support (default: on)\n" 402eb1cd07STony Krowiak " iommu=on|off controls emulated Intel IOMMU (VT-d) support (default=off)\n" 412eb1cd07STony Krowiak " aes-key-wrap=on|off controls support for AES key wrapping (default=on)\n" 429850c604SAlexander Graf " dea-key-wrap=on|off controls support for DEA key wrapping (default=on)\n" 439850c604SAlexander Graf " suppress-vmdesc=on|off disables self-describing migration (default=off)\n", 4480f52a66SJan Kiszka QEMU_ARCH_ALL) 455824d651Sblueswir1STEXI 4680f52a66SJan Kiszka@item -machine [type=]@var{name}[,prop=@var{value}[,...]] 4780f52a66SJan Kiszka@findex -machine 48585f6036SPeter MaydellSelect the emulated machine by @var{name}. Use @code{-machine help} to list 4980f52a66SJan Kiszkaavailable machines. Supported machine properties are: 5080f52a66SJan Kiszka@table @option 5180f52a66SJan Kiszka@item accel=@var{accels1}[:@var{accels2}[:...]] 5280f52a66SJan KiszkaThis is used to enable an accelerator. Depending on the target architecture, 5380f52a66SJan Kiszkakvm, xen, or tcg can be available. By default, tcg is used. If there is more 5480f52a66SJan Kiszkathan one accelerator specified, the next one is used if the previous one fails 5580f52a66SJan Kiszkato initialize. 566a48ffaaSJan Kiszka@item kernel_irqchip=on|off 576a48ffaaSJan KiszkaEnables in-kernel irqchip support for the chosen accelerator when available. 58d1048befSDon Slutz@item vmport=on|off|auto 59d1048befSDon SlutzEnables emulation of VMWare IO port, for vmmouse etc. auto says to select the 60d1048befSDon Slutzvalue based on accel. For accel=xen the default is off otherwise the default 61d1048befSDon Slutzis on. 6239d6960aSJan Kiszka@item kvm_shadow_mem=size 6339d6960aSJan KiszkaDefines the size of the KVM shadow MMU. 64ddb97f1dSJason Baron@item dump-guest-core=on|off 65ddb97f1dSJason BaronInclude guest memory in a core dump. The default is on. 668490fc78SLuiz Capitulino@item mem-merge=on|off 678490fc78SLuiz CapitulinoEnables or disables memory merge support. This feature, when supported by 688490fc78SLuiz Capitulinothe host, de-duplicates identical memory pages among VMs instances 698490fc78SLuiz Capitulino(enabled by default). 70a52a7fdfSLe Tan@item iommu=on|off 71a52a7fdfSLe TanEnables or disables emulated Intel IOMMU (VT-d) support. The default is off. 722eb1cd07STony Krowiak@item aes-key-wrap=on|off 732eb1cd07STony KrowiakEnables or disables AES key wrapping support on s390-ccw hosts. This feature 742eb1cd07STony Krowiakcontrols whether AES wrapping keys will be created to allow 752eb1cd07STony Krowiakexecution of AES cryptographic functions. The default is on. 762eb1cd07STony Krowiak@item dea-key-wrap=on|off 772eb1cd07STony KrowiakEnables or disables DEA key wrapping support on s390-ccw hosts. This feature 782eb1cd07STony Krowiakcontrols whether DEA wrapping keys will be created to allow 792eb1cd07STony Krowiakexecution of DEA cryptographic functions. The default is on. 8080f52a66SJan Kiszka@end table 815824d651Sblueswir1ETEXI 825824d651Sblueswir1 8380f52a66SJan KiszkaHXCOMM Deprecated by -machine 8480f52a66SJan KiszkaDEF("M", HAS_ARG, QEMU_OPTION_M, "", QEMU_ARCH_ALL) 8580f52a66SJan Kiszka 865824d651Sblueswir1DEF("cpu", HAS_ARG, QEMU_OPTION_cpu, 87585f6036SPeter Maydell "-cpu cpu select CPU ('-cpu help' for list)\n", QEMU_ARCH_ALL) 885824d651Sblueswir1STEXI 895824d651Sblueswir1@item -cpu @var{model} 906616b2adSStefan Weil@findex -cpu 91585f6036SPeter MaydellSelect CPU model (@code{-cpu help} for list and additional feature selection) 925824d651Sblueswir1ETEXI 935824d651Sblueswir1 945824d651Sblueswir1DEF("smp", HAS_ARG, QEMU_OPTION_smp, 9512b7f57eSMichael Tokarev "-smp [cpus=]n[,maxcpus=cpus][,cores=cores][,threads=threads][,sockets=sockets]\n" 966be68d7eSJes Sorensen " set the number of CPUs to 'n' [default=1]\n" 976be68d7eSJes Sorensen " maxcpus= maximum number of total cpus, including\n" 98ca1a8a06SBruce Rogers " offline CPUs for hotplug, etc\n" 9958a04db1SAndre Przywara " cores= number of CPU cores on one socket\n" 10058a04db1SAndre Przywara " threads= number of threads on one CPU core\n" 101ad96090aSBlue Swirl " sockets= number of discrete sockets in the system\n", 102ad96090aSBlue Swirl QEMU_ARCH_ALL) 1035824d651Sblueswir1STEXI 10412b7f57eSMichael Tokarev@item -smp [cpus=]@var{n}[,cores=@var{cores}][,threads=@var{threads}][,sockets=@var{sockets}][,maxcpus=@var{maxcpus}] 1056616b2adSStefan Weil@findex -smp 1065824d651Sblueswir1Simulate an SMP system with @var{n} CPUs. On the PC target, up to 255 1075824d651Sblueswir1CPUs are supported. On Sparc32 target, Linux limits the number of usable CPUs 1085824d651Sblueswir1to 4. 10958a04db1SAndre PrzywaraFor the PC target, the number of @var{cores} per socket, the number 11058a04db1SAndre Przywaraof @var{threads} per cores and the total number of @var{sockets} can be 11158a04db1SAndre Przywaraspecified. Missing values will be computed. If any on the three values is 11258a04db1SAndre Przywaragiven, the total number of CPUs @var{n} can be omitted. @var{maxcpus} 11358a04db1SAndre Przywaraspecifies the maximum number of hotpluggable CPUs. 1145824d651Sblueswir1ETEXI 1155824d651Sblueswir1 116268a362cSaliguoriDEF("numa", HAS_ARG, QEMU_OPTION_numa, 1177febe36fSPaolo Bonzini "-numa node[,mem=size][,cpus=cpu[-cpu]][,nodeid=node]\n" 1187febe36fSPaolo Bonzini "-numa node[,memdev=id][,cpus=cpu[-cpu]][,nodeid=node]\n", QEMU_ARCH_ALL) 119268a362cSaliguoriSTEXI 1204932b897SLuiz Capitulino@item -numa node[,mem=@var{size}][,cpus=@var{cpu[-cpu]}][,nodeid=@var{node}] 1217febe36fSPaolo Bonzini@item -numa node[,memdev=@var{id}][,cpus=@var{cpu[-cpu]}][,nodeid=@var{node}] 1226616b2adSStefan Weil@findex -numa 1237febe36fSPaolo BonziniSimulate a multi node NUMA system. If @samp{mem}, @samp{memdev} 1244932b897SLuiz Capitulinoand @samp{cpus} are omitted, resources are split equally. Also, note 1254932b897SLuiz Capitulinothat the -@option{numa} option doesn't allocate any of the specified 1264932b897SLuiz Capitulinoresources. That is, it just assigns existing resources to NUMA nodes. This 1274932b897SLuiz Capitulinomeans that one still has to use the @option{-m}, @option{-smp} options 1287febe36fSPaolo Bonzinito allocate RAM and VCPUs respectively, and possibly @option{-object} 1297febe36fSPaolo Bonzinito specify the memory backend for the @samp{memdev} suboption. 1307febe36fSPaolo Bonzini 1317febe36fSPaolo Bonzini@samp{mem} and @samp{memdev} are mutually exclusive. Furthermore, if one 1327febe36fSPaolo Bonzininode uses @samp{memdev}, all of them have to use it. 133268a362cSaliguoriETEXI 134268a362cSaliguori 13510adb8beSMarkus ArmbrusterDEF("add-fd", HAS_ARG, QEMU_OPTION_add_fd, 13610adb8beSMarkus Armbruster "-add-fd fd=fd,set=set[,opaque=opaque]\n" 13710adb8beSMarkus Armbruster " Add 'fd' to fd 'set'\n", QEMU_ARCH_ALL) 13810adb8beSMarkus ArmbrusterSTEXI 13910adb8beSMarkus Armbruster@item -add-fd fd=@var{fd},set=@var{set}[,opaque=@var{opaque}] 14010adb8beSMarkus Armbruster@findex -add-fd 14110adb8beSMarkus Armbruster 14210adb8beSMarkus ArmbrusterAdd a file descriptor to an fd set. Valid options are: 14310adb8beSMarkus Armbruster 14410adb8beSMarkus Armbruster@table @option 14510adb8beSMarkus Armbruster@item fd=@var{fd} 14610adb8beSMarkus ArmbrusterThis option defines the file descriptor of which a duplicate is added to fd set. 14710adb8beSMarkus ArmbrusterThe file descriptor cannot be stdin, stdout, or stderr. 14810adb8beSMarkus Armbruster@item set=@var{set} 14910adb8beSMarkus ArmbrusterThis option defines the ID of the fd set to add the file descriptor to. 15010adb8beSMarkus Armbruster@item opaque=@var{opaque} 15110adb8beSMarkus ArmbrusterThis option defines a free-form string that can be used to describe @var{fd}. 15210adb8beSMarkus Armbruster@end table 15310adb8beSMarkus Armbruster 15410adb8beSMarkus ArmbrusterYou can open an image using pre-opened file descriptors from an fd set: 15510adb8beSMarkus Armbruster@example 15610adb8beSMarkus Armbrusterqemu-system-i386 15710adb8beSMarkus Armbruster-add-fd fd=3,set=2,opaque="rdwr:/path/to/file" 15810adb8beSMarkus Armbruster-add-fd fd=4,set=2,opaque="rdonly:/path/to/file" 15910adb8beSMarkus Armbruster-drive file=/dev/fdset/2,index=0,media=disk 16010adb8beSMarkus Armbruster@end example 16110adb8beSMarkus ArmbrusterETEXI 16210adb8beSMarkus Armbruster 16310adb8beSMarkus ArmbrusterDEF("set", HAS_ARG, QEMU_OPTION_set, 16410adb8beSMarkus Armbruster "-set group.id.arg=value\n" 16510adb8beSMarkus Armbruster " set <arg> parameter for item <id> of type <group>\n" 16610adb8beSMarkus Armbruster " i.e. -set drive.$id.file=/path/to/image\n", QEMU_ARCH_ALL) 16710adb8beSMarkus ArmbrusterSTEXI 16810adb8beSMarkus Armbruster@item -set @var{group}.@var{id}.@var{arg}=@var{value} 16910adb8beSMarkus Armbruster@findex -set 17010adb8beSMarkus ArmbrusterSet parameter @var{arg} for item @var{id} of type @var{group}\n" 17110adb8beSMarkus ArmbrusterETEXI 17210adb8beSMarkus Armbruster 17310adb8beSMarkus ArmbrusterDEF("global", HAS_ARG, QEMU_OPTION_global, 1743751d7c4SPaolo Bonzini "-global driver.property=value\n" 1753751d7c4SPaolo Bonzini "-global driver=driver,property=property,value=value\n" 17610adb8beSMarkus Armbruster " set a global default for a driver property\n", 17710adb8beSMarkus Armbruster QEMU_ARCH_ALL) 17810adb8beSMarkus ArmbrusterSTEXI 17910adb8beSMarkus Armbruster@item -global @var{driver}.@var{prop}=@var{value} 1803751d7c4SPaolo Bonzini@itemx -global driver=@var{driver},property=@var{property},value=@var{value} 18110adb8beSMarkus Armbruster@findex -global 18210adb8beSMarkus ArmbrusterSet default value of @var{driver}'s property @var{prop} to @var{value}, e.g.: 18310adb8beSMarkus Armbruster 18410adb8beSMarkus Armbruster@example 18510adb8beSMarkus Armbrusterqemu-system-i386 -global ide-drive.physical_block_size=4096 -drive file=file,if=ide,index=0,media=disk 18610adb8beSMarkus Armbruster@end example 18710adb8beSMarkus Armbruster 18810adb8beSMarkus ArmbrusterIn particular, you can use this to set driver properties for devices which are 18910adb8beSMarkus Armbrustercreated automatically by the machine model. To create a device which is not 19010adb8beSMarkus Armbrustercreated automatically and set properties on it, use -@option{device}. 1913751d7c4SPaolo Bonzini 1923751d7c4SPaolo BonziniThe two syntaxes are equivalent. The longer one works for drivers whose name 1933751d7c4SPaolo Bonzinicontains a dot. 19410adb8beSMarkus ArmbrusterETEXI 19510adb8beSMarkus Armbruster 19610adb8beSMarkus ArmbrusterDEF("boot", HAS_ARG, QEMU_OPTION_boot, 19710adb8beSMarkus Armbruster "-boot [order=drives][,once=drives][,menu=on|off]\n" 198c8a6ae8bSAmos Kong " [,splash=sp_name][,splash-time=sp_time][,reboot-timeout=rb_time][,strict=on|off]\n" 19910adb8beSMarkus Armbruster " 'drives': floppy (a), hard disk (c), CD-ROM (d), network (n)\n" 20010adb8beSMarkus Armbruster " 'sp_name': the file's name that would be passed to bios as logo picture, if menu=on\n" 20110adb8beSMarkus Armbruster " 'sp_time': the period that splash picture last if menu=on, unit is ms\n" 20210adb8beSMarkus Armbruster " 'rb_timeout': the timeout before guest reboot when boot failed, unit is ms\n", 20310adb8beSMarkus Armbruster QEMU_ARCH_ALL) 20410adb8beSMarkus ArmbrusterSTEXI 205c8a6ae8bSAmos 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] 20610adb8beSMarkus Armbruster@findex -boot 20710adb8beSMarkus ArmbrusterSpecify boot order @var{drives} as a string of drive letters. Valid 20810adb8beSMarkus Armbrusterdrive letters depend on the target achitecture. The x86 PC uses: a, b 20910adb8beSMarkus Armbruster(floppy 1 and 2), c (first hard disk), d (first CD-ROM), n-p (Etherboot 21010adb8beSMarkus Armbrusterfrom network adapter 1-4), hard disk boot is the default. To apply a 21110adb8beSMarkus Armbrusterparticular boot order only on the first startup, specify it via 21210adb8beSMarkus Armbruster@option{once}. 21310adb8beSMarkus Armbruster 21410adb8beSMarkus ArmbrusterInteractive boot menus/prompts can be enabled via @option{menu=on} as far 21510adb8beSMarkus Armbrusteras firmware/BIOS supports them. The default is non-interactive boot. 21610adb8beSMarkus Armbruster 21710adb8beSMarkus ArmbrusterA splash picture could be passed to bios, enabling user to show it as logo, 21810adb8beSMarkus Armbrusterwhen option splash=@var{sp_name} is given and menu=on, If firmware/BIOS 21910adb8beSMarkus Armbrustersupports them. Currently Seabios for X86 system support it. 22010adb8beSMarkus Armbrusterlimitation: The splash file could be a jpeg file or a BMP file in 24 BPP 22110adb8beSMarkus Armbrusterformat(true color). The resolution should be supported by the SVGA mode, so 22210adb8beSMarkus Armbrusterthe recommended is 320x240, 640x480, 800x640. 22310adb8beSMarkus Armbruster 22410adb8beSMarkus ArmbrusterA timeout could be passed to bios, guest will pause for @var{rb_timeout} ms 22510adb8beSMarkus Armbrusterwhen boot failed, then reboot. If @var{rb_timeout} is '-1', guest will not 22610adb8beSMarkus Armbrusterreboot, qemu passes '-1' to bios by default. Currently Seabios for X86 22710adb8beSMarkus Armbrustersystem support it. 22810adb8beSMarkus Armbruster 229c8a6ae8bSAmos KongDo strict boot via @option{strict=on} as far as firmware/BIOS 230c8a6ae8bSAmos Kongsupports it. This only effects when boot priority is changed by 231c8a6ae8bSAmos Kongbootindex options. The default is non-strict boot. 232c8a6ae8bSAmos Kong 23310adb8beSMarkus Armbruster@example 23410adb8beSMarkus Armbruster# try to boot from network first, then from hard disk 23510adb8beSMarkus Armbrusterqemu-system-i386 -boot order=nc 23610adb8beSMarkus Armbruster# boot from CD-ROM first, switch back to default order after reboot 23710adb8beSMarkus Armbrusterqemu-system-i386 -boot once=d 23810adb8beSMarkus Armbruster# boot with a splash picture for 5 seconds. 23910adb8beSMarkus Armbrusterqemu-system-i386 -boot menu=on,splash=/root/boot.bmp,splash-time=5000 24010adb8beSMarkus Armbruster@end example 24110adb8beSMarkus Armbruster 24210adb8beSMarkus ArmbrusterNote: The legacy format '-boot @var{drives}' is still supported but its 24310adb8beSMarkus Armbrusteruse is discouraged as it may be removed from future versions. 24410adb8beSMarkus ArmbrusterETEXI 24510adb8beSMarkus Armbruster 24610adb8beSMarkus ArmbrusterDEF("m", HAS_ARG, QEMU_OPTION_m, 247c270fb9eSIgor Mammedov "-m[emory] [size=]megs[,slots=n,maxmem=size]\n" 2486e1d3c1cSIgor Mammedov " configure guest RAM\n" 2490daba1f0SAlexander Graf " size: initial amount of guest memory\n" 250c270fb9eSIgor Mammedov " slots: number of hotplug slots (default: none)\n" 251b6fe0124SMatthew Rosato " maxmem: maximum amount of guest memory (default: none)\n" 252b6fe0124SMatthew Rosato "NOTE: Some architectures might enforce a specific granularity\n", 2536e1d3c1cSIgor Mammedov QEMU_ARCH_ALL) 25410adb8beSMarkus ArmbrusterSTEXI 2559fcc0794SLuiz Capitulino@item -m [size=]@var{megs}[,slots=n,maxmem=size] 25610adb8beSMarkus Armbruster@findex -m 2579fcc0794SLuiz CapitulinoSets guest startup RAM size to @var{megs} megabytes. Default is 128 MiB. 2589fcc0794SLuiz CapitulinoOptionally, a suffix of ``M'' or ``G'' can be used to signify a value in 2599fcc0794SLuiz Capitulinomegabytes or gigabytes respectively. Optional pair @var{slots}, @var{maxmem} 2609fcc0794SLuiz Capitulinocould be used to set amount of hotpluggable memory slots and maximum amount of 2619fcc0794SLuiz Capitulinomemory. Note that @var{maxmem} must be aligned to the page size. 2629fcc0794SLuiz Capitulino 2639fcc0794SLuiz CapitulinoFor example, the following command-line sets the guest startup RAM size to 2649fcc0794SLuiz Capitulino1GB, creates 3 slots to hotplug additional memory and sets the maximum 2659fcc0794SLuiz Capitulinomemory the guest can reach to 4GB: 2669fcc0794SLuiz Capitulino 2679fcc0794SLuiz Capitulino@example 2689fcc0794SLuiz Capitulinoqemu-system-x86_64 -m 1G,slots=3,maxmem=4G 2699fcc0794SLuiz Capitulino@end example 2709fcc0794SLuiz Capitulino 2719fcc0794SLuiz CapitulinoIf @var{slots} and @var{maxmem} are not specified, memory hotplug won't 2729fcc0794SLuiz Capitulinobe enabled and the guest startup RAM will never increase. 27310adb8beSMarkus ArmbrusterETEXI 27410adb8beSMarkus Armbruster 27510adb8beSMarkus ArmbrusterDEF("mem-path", HAS_ARG, QEMU_OPTION_mempath, 27610adb8beSMarkus Armbruster "-mem-path FILE provide backing storage for guest RAM\n", QEMU_ARCH_ALL) 27710adb8beSMarkus ArmbrusterSTEXI 27810adb8beSMarkus Armbruster@item -mem-path @var{path} 27910adb8beSMarkus Armbruster@findex -mem-path 28010adb8beSMarkus ArmbrusterAllocate guest RAM from a temporarily created file in @var{path}. 28110adb8beSMarkus ArmbrusterETEXI 28210adb8beSMarkus Armbruster 28310adb8beSMarkus ArmbrusterDEF("mem-prealloc", 0, QEMU_OPTION_mem_prealloc, 28410adb8beSMarkus Armbruster "-mem-prealloc preallocate guest memory (use with -mem-path)\n", 28510adb8beSMarkus Armbruster QEMU_ARCH_ALL) 28610adb8beSMarkus ArmbrusterSTEXI 28710adb8beSMarkus Armbruster@item -mem-prealloc 28810adb8beSMarkus Armbruster@findex -mem-prealloc 28910adb8beSMarkus ArmbrusterPreallocate memory when using -mem-path. 29010adb8beSMarkus ArmbrusterETEXI 29110adb8beSMarkus Armbruster 29210adb8beSMarkus ArmbrusterDEF("k", HAS_ARG, QEMU_OPTION_k, 29310adb8beSMarkus Armbruster "-k language use keyboard layout (for example 'fr' for French)\n", 29410adb8beSMarkus Armbruster QEMU_ARCH_ALL) 29510adb8beSMarkus ArmbrusterSTEXI 29610adb8beSMarkus Armbruster@item -k @var{language} 29710adb8beSMarkus Armbruster@findex -k 29810adb8beSMarkus ArmbrusterUse keyboard layout @var{language} (for example @code{fr} for 29910adb8beSMarkus ArmbrusterFrench). This option is only needed where it is not easy to get raw PC 30010adb8beSMarkus Armbrusterkeycodes (e.g. on Macs, with some X11 servers or with a VNC 30110adb8beSMarkus Armbrusterdisplay). You don't normally need to use it on PC/Linux or PC/Windows 30210adb8beSMarkus Armbrusterhosts. 30310adb8beSMarkus Armbruster 30410adb8beSMarkus ArmbrusterThe available layouts are: 30510adb8beSMarkus Armbruster@example 30610adb8beSMarkus Armbrusterar de-ch es fo fr-ca hu ja mk no pt-br sv 30710adb8beSMarkus Armbrusterda en-gb et fr fr-ch is lt nl pl ru th 30810adb8beSMarkus Armbrusterde en-us fi fr-be hr it lv nl-be pt sl tr 30910adb8beSMarkus Armbruster@end example 31010adb8beSMarkus Armbruster 31110adb8beSMarkus ArmbrusterThe default is @code{en-us}. 31210adb8beSMarkus ArmbrusterETEXI 31310adb8beSMarkus Armbruster 31410adb8beSMarkus Armbruster 31510adb8beSMarkus ArmbrusterDEF("audio-help", 0, QEMU_OPTION_audio_help, 31610adb8beSMarkus Armbruster "-audio-help print list of audio drivers and their options\n", 31710adb8beSMarkus Armbruster QEMU_ARCH_ALL) 31810adb8beSMarkus ArmbrusterSTEXI 31910adb8beSMarkus Armbruster@item -audio-help 32010adb8beSMarkus Armbruster@findex -audio-help 32110adb8beSMarkus ArmbrusterWill show the audio subsystem help: list of drivers, tunable 32210adb8beSMarkus Armbrusterparameters. 32310adb8beSMarkus ArmbrusterETEXI 32410adb8beSMarkus Armbruster 32510adb8beSMarkus ArmbrusterDEF("soundhw", HAS_ARG, QEMU_OPTION_soundhw, 32610adb8beSMarkus Armbruster "-soundhw c1,... enable audio support\n" 32710adb8beSMarkus Armbruster " and only specified sound cards (comma separated list)\n" 32810adb8beSMarkus Armbruster " use '-soundhw help' to get the list of supported cards\n" 32910adb8beSMarkus Armbruster " use '-soundhw all' to enable all of them\n", QEMU_ARCH_ALL) 33010adb8beSMarkus ArmbrusterSTEXI 33110adb8beSMarkus Armbruster@item -soundhw @var{card1}[,@var{card2},...] or -soundhw all 33210adb8beSMarkus Armbruster@findex -soundhw 33310adb8beSMarkus ArmbrusterEnable audio and selected sound hardware. Use 'help' to print all 33410adb8beSMarkus Armbrusteravailable sound hardware. 33510adb8beSMarkus Armbruster 33610adb8beSMarkus Armbruster@example 33710adb8beSMarkus Armbrusterqemu-system-i386 -soundhw sb16,adlib disk.img 33810adb8beSMarkus Armbrusterqemu-system-i386 -soundhw es1370 disk.img 33910adb8beSMarkus Armbrusterqemu-system-i386 -soundhw ac97 disk.img 34010adb8beSMarkus Armbrusterqemu-system-i386 -soundhw hda disk.img 34110adb8beSMarkus Armbrusterqemu-system-i386 -soundhw all disk.img 34210adb8beSMarkus Armbrusterqemu-system-i386 -soundhw help 34310adb8beSMarkus Armbruster@end example 34410adb8beSMarkus Armbruster 34510adb8beSMarkus ArmbrusterNote that Linux's i810_audio OSS kernel (for AC97) module might 34610adb8beSMarkus Armbrusterrequire manually specifying clocking. 34710adb8beSMarkus Armbruster 34810adb8beSMarkus Armbruster@example 34910adb8beSMarkus Armbrustermodprobe i810_audio clocking=48000 35010adb8beSMarkus Armbruster@end example 35110adb8beSMarkus ArmbrusterETEXI 35210adb8beSMarkus Armbruster 35310adb8beSMarkus ArmbrusterDEF("balloon", HAS_ARG, QEMU_OPTION_balloon, 35410adb8beSMarkus Armbruster "-balloon none disable balloon device\n" 35510adb8beSMarkus Armbruster "-balloon virtio[,addr=str]\n" 35610adb8beSMarkus Armbruster " enable virtio balloon device (default)\n", QEMU_ARCH_ALL) 35710adb8beSMarkus ArmbrusterSTEXI 35810adb8beSMarkus Armbruster@item -balloon none 35910adb8beSMarkus Armbruster@findex -balloon 36010adb8beSMarkus ArmbrusterDisable balloon device. 36110adb8beSMarkus Armbruster@item -balloon virtio[,addr=@var{addr}] 36210adb8beSMarkus ArmbrusterEnable virtio balloon device (default), optionally with PCI address 36310adb8beSMarkus Armbruster@var{addr}. 36410adb8beSMarkus ArmbrusterETEXI 36510adb8beSMarkus Armbruster 36610adb8beSMarkus ArmbrusterDEF("device", HAS_ARG, QEMU_OPTION_device, 36710adb8beSMarkus Armbruster "-device driver[,prop[=value][,...]]\n" 36810adb8beSMarkus Armbruster " add device (based on driver)\n" 36910adb8beSMarkus Armbruster " prop=value,... sets driver properties\n" 37010adb8beSMarkus Armbruster " use '-device help' to print all possible drivers\n" 37110adb8beSMarkus Armbruster " use '-device driver,help' to print all possible properties\n", 37210adb8beSMarkus Armbruster QEMU_ARCH_ALL) 37310adb8beSMarkus ArmbrusterSTEXI 37410adb8beSMarkus Armbruster@item -device @var{driver}[,@var{prop}[=@var{value}][,...]] 37510adb8beSMarkus Armbruster@findex -device 37610adb8beSMarkus ArmbrusterAdd device @var{driver}. @var{prop}=@var{value} sets driver 37710adb8beSMarkus Armbrusterproperties. Valid properties depend on the driver. To get help on 37810adb8beSMarkus Armbrusterpossible drivers and properties, use @code{-device help} and 37910adb8beSMarkus Armbruster@code{-device @var{driver},help}. 38010adb8beSMarkus ArmbrusterETEXI 38110adb8beSMarkus Armbruster 38210adb8beSMarkus ArmbrusterDEF("name", HAS_ARG, QEMU_OPTION_name, 3838f480de0SDr. David Alan Gilbert "-name string1[,process=string2][,debug-threads=on|off]\n" 38410adb8beSMarkus Armbruster " set the name of the guest\n" 3858f480de0SDr. David Alan Gilbert " string1 sets the window title and string2 the process name (on Linux)\n" 3868f480de0SDr. David Alan Gilbert " When debug-threads is enabled, individual threads are given a separate name (on Linux)\n" 3878f480de0SDr. David Alan Gilbert " NOTE: The thread names are for debugging and not a stable API.\n", 38810adb8beSMarkus Armbruster QEMU_ARCH_ALL) 38910adb8beSMarkus ArmbrusterSTEXI 39010adb8beSMarkus Armbruster@item -name @var{name} 39110adb8beSMarkus Armbruster@findex -name 39210adb8beSMarkus ArmbrusterSets the @var{name} of the guest. 39310adb8beSMarkus ArmbrusterThis name will be displayed in the SDL window caption. 39410adb8beSMarkus ArmbrusterThe @var{name} will also be used for the VNC server. 39510adb8beSMarkus ArmbrusterAlso optionally set the top visible process name in Linux. 3968f480de0SDr. David Alan GilbertNaming of individual threads can also be enabled on Linux to aid debugging. 39710adb8beSMarkus ArmbrusterETEXI 39810adb8beSMarkus Armbruster 39910adb8beSMarkus ArmbrusterDEF("uuid", HAS_ARG, QEMU_OPTION_uuid, 40010adb8beSMarkus Armbruster "-uuid %08x-%04x-%04x-%04x-%012x\n" 40110adb8beSMarkus Armbruster " specify machine UUID\n", QEMU_ARCH_ALL) 40210adb8beSMarkus ArmbrusterSTEXI 40310adb8beSMarkus Armbruster@item -uuid @var{uuid} 40410adb8beSMarkus Armbruster@findex -uuid 40510adb8beSMarkus ArmbrusterSet system UUID. 40610adb8beSMarkus ArmbrusterETEXI 40710adb8beSMarkus Armbruster 40810adb8beSMarkus ArmbrusterSTEXI 40910adb8beSMarkus Armbruster@end table 41010adb8beSMarkus ArmbrusterETEXI 41110adb8beSMarkus ArmbrusterDEFHEADING() 41210adb8beSMarkus Armbruster 41310adb8beSMarkus ArmbrusterDEFHEADING(Block device options:) 41410adb8beSMarkus ArmbrusterSTEXI 41510adb8beSMarkus Armbruster@table @option 41610adb8beSMarkus ArmbrusterETEXI 41710adb8beSMarkus Armbruster 4185824d651Sblueswir1DEF("fda", HAS_ARG, QEMU_OPTION_fda, 419ad96090aSBlue Swirl "-fda/-fdb file use 'file' as floppy disk 0/1 image\n", QEMU_ARCH_ALL) 420ad96090aSBlue SwirlDEF("fdb", HAS_ARG, QEMU_OPTION_fdb, "", QEMU_ARCH_ALL) 4215824d651Sblueswir1STEXI 4225824d651Sblueswir1@item -fda @var{file} 4235824d651Sblueswir1@item -fdb @var{file} 4246616b2adSStefan Weil@findex -fda 4256616b2adSStefan Weil@findex -fdb 42692a539d2SMarkus ArmbrusterUse @var{file} as floppy disk 0/1 image (@pxref{disk_images}). 4275824d651Sblueswir1ETEXI 4285824d651Sblueswir1 4295824d651Sblueswir1DEF("hda", HAS_ARG, QEMU_OPTION_hda, 430ad96090aSBlue Swirl "-hda/-hdb file use 'file' as IDE hard disk 0/1 image\n", QEMU_ARCH_ALL) 431ad96090aSBlue SwirlDEF("hdb", HAS_ARG, QEMU_OPTION_hdb, "", QEMU_ARCH_ALL) 4325824d651Sblueswir1DEF("hdc", HAS_ARG, QEMU_OPTION_hdc, 433ad96090aSBlue Swirl "-hdc/-hdd file use 'file' as IDE hard disk 2/3 image\n", QEMU_ARCH_ALL) 434ad96090aSBlue SwirlDEF("hdd", HAS_ARG, QEMU_OPTION_hdd, "", QEMU_ARCH_ALL) 4355824d651Sblueswir1STEXI 4365824d651Sblueswir1@item -hda @var{file} 4375824d651Sblueswir1@item -hdb @var{file} 4385824d651Sblueswir1@item -hdc @var{file} 4395824d651Sblueswir1@item -hdd @var{file} 4406616b2adSStefan Weil@findex -hda 4416616b2adSStefan Weil@findex -hdb 4426616b2adSStefan Weil@findex -hdc 4436616b2adSStefan Weil@findex -hdd 4445824d651Sblueswir1Use @var{file} as hard disk 0, 1, 2 or 3 image (@pxref{disk_images}). 4455824d651Sblueswir1ETEXI 4465824d651Sblueswir1 4475824d651Sblueswir1DEF("cdrom", HAS_ARG, QEMU_OPTION_cdrom, 448ad96090aSBlue Swirl "-cdrom file use 'file' as IDE cdrom image (cdrom is ide1 master)\n", 449ad96090aSBlue Swirl QEMU_ARCH_ALL) 4505824d651Sblueswir1STEXI 4515824d651Sblueswir1@item -cdrom @var{file} 4526616b2adSStefan Weil@findex -cdrom 4535824d651Sblueswir1Use @var{file} as CD-ROM image (you cannot use @option{-hdc} and 4545824d651Sblueswir1@option{-cdrom} at the same time). You can use the host CD-ROM by 4555824d651Sblueswir1using @file{/dev/cdrom} as filename (@pxref{host_drives}). 4565824d651Sblueswir1ETEXI 4575824d651Sblueswir1 4585824d651Sblueswir1DEF("drive", HAS_ARG, QEMU_OPTION_drive, 4595824d651Sblueswir1 "-drive [file=file][,if=type][,bus=n][,unit=m][,media=d][,index=i]\n" 4605824d651Sblueswir1 " [,cyls=c,heads=h,secs=s[,trans=t]][,snapshot=on|off]\n" 46192196b2fSStefan Hajnoczi " [,cache=writethrough|writeback|none|directsync|unsafe][,format=f]\n" 462d1db760dSStefan Hajnoczi " [,serial=s][,addr=A][,rerror=ignore|stop|report]\n" 463d1db760dSStefan Hajnoczi " [,werror=ignore|stop|report|enospc][,id=name][,aio=threads|native]\n" 464fb0490f6SStefan Hajnoczi " [,readonly=on|off][,copy-on-read=on|off]\n" 4652f7133b2SPeter Lieven " [,discard=ignore|unmap][,detect-zeroes=on|off|unmap]\n" 4663e9fab69SBenoît Canet " [[,bps=b]|[[,bps_rd=r][,bps_wr=w]]]\n" 4673e9fab69SBenoît Canet " [[,iops=i]|[[,iops_rd=r][,iops_wr=w]]]\n" 4683e9fab69SBenoît Canet " [[,bps_max=bm]|[[,bps_rd_max=rm][,bps_wr_max=wm]]]\n" 4693e9fab69SBenoît Canet " [[,iops_max=im]|[[,iops_rd_max=irm][,iops_wr_max=iwm]]]\n" 4702024c1dfSBenoît Canet " [[,iops_size=is]]\n" 471*76f4afb4SAlberto Garcia " [[,group=g]]\n" 472ad96090aSBlue Swirl " use 'file' as a drive image\n", QEMU_ARCH_ALL) 4735824d651Sblueswir1STEXI 4745824d651Sblueswir1@item -drive @var{option}[,@var{option}[,@var{option}[,...]]] 4756616b2adSStefan Weil@findex -drive 4765824d651Sblueswir1 4775824d651Sblueswir1Define a new drive. Valid options are: 4785824d651Sblueswir1 479b3f046c2SKevin Wolf@table @option 4805824d651Sblueswir1@item file=@var{file} 4815824d651Sblueswir1This option defines which disk image (@pxref{disk_images}) to use with 4825824d651Sblueswir1this drive. If the filename contains comma, you must double it 4835824d651Sblueswir1(for instance, "file=my,,file" to use file "my,file"). 4840f5314a2SRonnie Sahlberg 4850f5314a2SRonnie SahlbergSpecial files such as iSCSI devices can be specified using protocol 4860f5314a2SRonnie Sahlbergspecific URLs. See the section for "Device URL Syntax" for more information. 4875824d651Sblueswir1@item if=@var{interface} 4885824d651Sblueswir1This option defines on which type on interface the drive is connected. 4895824d651Sblueswir1Available types are: ide, scsi, sd, mtd, floppy, pflash, virtio. 4905824d651Sblueswir1@item bus=@var{bus},unit=@var{unit} 4915824d651Sblueswir1These options define where is connected the drive by defining the bus number and 4925824d651Sblueswir1the unit id. 4935824d651Sblueswir1@item index=@var{index} 4945824d651Sblueswir1This option defines where is connected the drive by using an index in the list 4955824d651Sblueswir1of available connectors of a given interface type. 4965824d651Sblueswir1@item media=@var{media} 4975824d651Sblueswir1This option defines the type of the media: disk or cdrom. 4985824d651Sblueswir1@item cyls=@var{c},heads=@var{h},secs=@var{s}[,trans=@var{t}] 4995824d651Sblueswir1These options have the same definition as they have in @option{-hdachs}. 5005824d651Sblueswir1@item snapshot=@var{snapshot} 5019d85d557SMichael Tokarev@var{snapshot} is "on" or "off" and controls snapshot mode for the given drive 5029d85d557SMichael Tokarev(see @option{-snapshot}). 5035824d651Sblueswir1@item cache=@var{cache} 50492196b2fSStefan Hajnoczi@var{cache} is "none", "writeback", "unsafe", "directsync" or "writethrough" and controls how the host cache is used to access block data. 5055c6c3a6cSChristoph Hellwig@item aio=@var{aio} 5065c6c3a6cSChristoph Hellwig@var{aio} is "threads", or "native" and selects between pthread based disk I/O and native Linux AIO. 507a9384affSPaolo Bonzini@item discard=@var{discard} 508a9384affSPaolo 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. 5095824d651Sblueswir1@item format=@var{format} 5105824d651Sblueswir1Specify which disk @var{format} will be used rather than detecting 5115824d651Sblueswir1the format. Can be used to specifiy format=raw to avoid interpreting 5125824d651Sblueswir1an untrusted format header. 5135824d651Sblueswir1@item serial=@var{serial} 5145824d651Sblueswir1This option specifies the serial number to assign to the device. 515c2cc47a4SMarkus Armbruster@item addr=@var{addr} 516c2cc47a4SMarkus ArmbrusterSpecify the controller's PCI address (if=virtio only). 517ae73e591SLuiz Capitulino@item werror=@var{action},rerror=@var{action} 518ae73e591SLuiz CapitulinoSpecify which @var{action} to take on write and read errors. Valid actions are: 519ae73e591SLuiz Capitulino"ignore" (ignore the error and try to continue), "stop" (pause QEMU), 520ae73e591SLuiz Capitulino"report" (report the error to the guest), "enospc" (pause QEMU only if the 521ae73e591SLuiz Capitulinohost disk is full; report the error to the guest otherwise). 522ae73e591SLuiz CapitulinoThe default setting is @option{werror=enospc} and @option{rerror=report}. 523ae73e591SLuiz Capitulino@item readonly 524ae73e591SLuiz CapitulinoOpen drive @option{file} as read-only. Guest write attempts will fail. 525fb0490f6SStefan Hajnoczi@item copy-on-read=@var{copy-on-read} 526fb0490f6SStefan Hajnoczi@var{copy-on-read} is "on" or "off" and enables whether to copy read backing 527fb0490f6SStefan Hajnoczifile sectors into the image file. 528465bee1dSPeter Lieven@item detect-zeroes=@var{detect-zeroes} 529465bee1dSPeter Lieven@var{detect-zeroes} is "off", "on" or "unmap" and enables the automatic 530465bee1dSPeter Lievenconversion of plain zero writes by the OS to driver specific optimized 531465bee1dSPeter Lievenzero write commands. You may even choose "unmap" if @var{discard} is set 532465bee1dSPeter Lievento "unmap" to allow a zero write to be converted to an UNMAP operation. 5335824d651Sblueswir1@end table 5345824d651Sblueswir1 535a13e5e05SKevin WolfBy default, the @option{cache=writeback} mode is used. It will report data 536a13e5e05SKevin Wolfwrites as completed as soon as the data is present in the host page cache. 537a13e5e05SKevin WolfThis is safe as long as your guest OS makes sure to correctly flush disk caches 538a13e5e05SKevin Wolfwhere needed. If your guest OS does not handle volatile disk write caches 539a13e5e05SKevin Wolfcorrectly and your host crashes or loses power, then the guest may experience 540a13e5e05SKevin Wolfdata corruption. 5415824d651Sblueswir1 542a13e5e05SKevin WolfFor such guests, you should consider using @option{cache=writethrough}. This 543a13e5e05SKevin Wolfmeans that the host page cache will be used to read and write data, but write 544a13e5e05SKevin Wolfnotification will be sent to the guest only after QEMU has made sure to flush 545a13e5e05SKevin Wolfeach write to the disk. Be aware that this has a major impact on performance. 5465824d651Sblueswir1 547c304d317SAurelien JarnoThe host page cache can be avoided entirely with @option{cache=none}. This will 548a13e5e05SKevin Wolfattempt to do disk IO directly to the guest's memory. QEMU may still perform 549a13e5e05SKevin Wolfan internal copy of the data. Note that this is considered a writeback mode and 550a13e5e05SKevin Wolfthe guest OS must handle the disk write cache correctly in order to avoid data 551a13e5e05SKevin Wolfcorruption on host crashes. 5525824d651Sblueswir1 55392196b2fSStefan HajnocziThe host page cache can be avoided while only sending write notifications to 554a13e5e05SKevin Wolfthe guest when the data has been flushed to the disk using 555a13e5e05SKevin Wolf@option{cache=directsync}. 5565824d651Sblueswir1 557016f5cf6SAlexander GrafIn case you don't care about data integrity over host failures, use 558a13e5e05SKevin Wolf@option{cache=unsafe}. This option tells QEMU that it never needs to write any 559a13e5e05SKevin Wolfdata to the disk but can instead keep things in cache. If anything goes wrong, 560e7d81004SStefan Weillike your host losing power, the disk storage getting disconnected accidentally, 561a13e5e05SKevin Wolfetc. your image will most probably be rendered unusable. When using 562c3177288SAlexander Grafthe @option{-snapshot} option, unsafe caching is always used. 563016f5cf6SAlexander Graf 564fb0490f6SStefan HajnocziCopy-on-read avoids accessing the same backing file sectors repeatedly and is 565fb0490f6SStefan Hajnocziuseful when the backing file is over a slow network. By default copy-on-read 566fb0490f6SStefan Hajnocziis off. 567fb0490f6SStefan Hajnoczi 5685824d651Sblueswir1Instead of @option{-cdrom} you can use: 5695824d651Sblueswir1@example 5703804da9dSStefan Weilqemu-system-i386 -drive file=file,index=2,media=cdrom 5715824d651Sblueswir1@end example 5725824d651Sblueswir1 5735824d651Sblueswir1Instead of @option{-hda}, @option{-hdb}, @option{-hdc}, @option{-hdd}, you can 5745824d651Sblueswir1use: 5755824d651Sblueswir1@example 5763804da9dSStefan Weilqemu-system-i386 -drive file=file,index=0,media=disk 5773804da9dSStefan Weilqemu-system-i386 -drive file=file,index=1,media=disk 5783804da9dSStefan Weilqemu-system-i386 -drive file=file,index=2,media=disk 5793804da9dSStefan Weilqemu-system-i386 -drive file=file,index=3,media=disk 5805824d651Sblueswir1@end example 5815824d651Sblueswir1 582587ed6beSCorey BryantYou can open an image using pre-opened file descriptors from an fd set: 583587ed6beSCorey Bryant@example 584587ed6beSCorey Bryantqemu-system-i386 585587ed6beSCorey Bryant-add-fd fd=3,set=2,opaque="rdwr:/path/to/file" 586587ed6beSCorey Bryant-add-fd fd=4,set=2,opaque="rdonly:/path/to/file" 587587ed6beSCorey Bryant-drive file=/dev/fdset/2,index=0,media=disk 588587ed6beSCorey Bryant@end example 589587ed6beSCorey Bryant 5905824d651Sblueswir1You can connect a CDROM to the slave of ide0: 5915824d651Sblueswir1@example 5923804da9dSStefan Weilqemu-system-i386 -drive file=file,if=ide,index=1,media=cdrom 5935824d651Sblueswir1@end example 5945824d651Sblueswir1 5955824d651Sblueswir1If you don't specify the "file=" argument, you define an empty drive: 5965824d651Sblueswir1@example 5973804da9dSStefan Weilqemu-system-i386 -drive if=ide,index=1,media=cdrom 5985824d651Sblueswir1@end example 5995824d651Sblueswir1 6005824d651Sblueswir1You can connect a SCSI disk with unit ID 6 on the bus #0: 6015824d651Sblueswir1@example 6023804da9dSStefan Weilqemu-system-i386 -drive file=file,if=scsi,bus=0,unit=6 6035824d651Sblueswir1@end example 6045824d651Sblueswir1 6055824d651Sblueswir1Instead of @option{-fda}, @option{-fdb}, you can use: 6065824d651Sblueswir1@example 6073804da9dSStefan Weilqemu-system-i386 -drive file=file,index=0,if=floppy 6083804da9dSStefan Weilqemu-system-i386 -drive file=file,index=1,if=floppy 6095824d651Sblueswir1@end example 6105824d651Sblueswir1 6115824d651Sblueswir1By default, @var{interface} is "ide" and @var{index} is automatically 6125824d651Sblueswir1incremented: 6135824d651Sblueswir1@example 6143804da9dSStefan Weilqemu-system-i386 -drive file=a -drive file=b" 6155824d651Sblueswir1@end example 6165824d651Sblueswir1is interpreted like: 6175824d651Sblueswir1@example 6183804da9dSStefan Weilqemu-system-i386 -hda a -hdb b 6195824d651Sblueswir1@end example 6205824d651Sblueswir1ETEXI 6215824d651Sblueswir1 6225824d651Sblueswir1DEF("mtdblock", HAS_ARG, QEMU_OPTION_mtdblock, 623ad96090aSBlue Swirl "-mtdblock file use 'file' as on-board Flash memory image\n", 624ad96090aSBlue Swirl QEMU_ARCH_ALL) 6255824d651Sblueswir1STEXI 6264e257e5eSKevin Wolf@item -mtdblock @var{file} 6276616b2adSStefan Weil@findex -mtdblock 6284e257e5eSKevin WolfUse @var{file} as on-board Flash memory image. 6295824d651Sblueswir1ETEXI 6305824d651Sblueswir1 6315824d651Sblueswir1DEF("sd", HAS_ARG, QEMU_OPTION_sd, 632ad96090aSBlue Swirl "-sd file use 'file' as SecureDigital card image\n", QEMU_ARCH_ALL) 6335824d651Sblueswir1STEXI 6344e257e5eSKevin Wolf@item -sd @var{file} 6356616b2adSStefan Weil@findex -sd 6364e257e5eSKevin WolfUse @var{file} as SecureDigital card image. 6375824d651Sblueswir1ETEXI 6385824d651Sblueswir1 6395824d651Sblueswir1DEF("pflash", HAS_ARG, QEMU_OPTION_pflash, 640ad96090aSBlue Swirl "-pflash file use 'file' as a parallel flash image\n", QEMU_ARCH_ALL) 6415824d651Sblueswir1STEXI 6424e257e5eSKevin Wolf@item -pflash @var{file} 6436616b2adSStefan Weil@findex -pflash 6444e257e5eSKevin WolfUse @var{file} as a parallel flash image. 6455824d651Sblueswir1ETEXI 6465824d651Sblueswir1 6475824d651Sblueswir1DEF("snapshot", 0, QEMU_OPTION_snapshot, 648ad96090aSBlue Swirl "-snapshot write to temporary files instead of disk image files\n", 649ad96090aSBlue Swirl QEMU_ARCH_ALL) 6505824d651Sblueswir1STEXI 6515824d651Sblueswir1@item -snapshot 6526616b2adSStefan Weil@findex -snapshot 6535824d651Sblueswir1Write to temporary files instead of disk image files. In this case, 6545824d651Sblueswir1the raw disk image you use is not written back. You can however force 6555824d651Sblueswir1the write back by pressing @key{C-a s} (@pxref{disk_images}). 6565824d651Sblueswir1ETEXI 6575824d651Sblueswir1 65810adb8beSMarkus ArmbrusterDEF("hdachs", HAS_ARG, QEMU_OPTION_hdachs, \ 65910adb8beSMarkus Armbruster "-hdachs c,h,s[,t]\n" \ 66010adb8beSMarkus Armbruster " force hard disk 0 physical geometry and the optional BIOS\n" \ 66110adb8beSMarkus Armbruster " translation (t=none or lba) (usually QEMU can guess them)\n", 662ad96090aSBlue Swirl QEMU_ARCH_ALL) 663c902760fSMarcelo TosattiSTEXI 66410adb8beSMarkus Armbruster@item -hdachs @var{c},@var{h},@var{s},[,@var{t}] 66510adb8beSMarkus Armbruster@findex -hdachs 66610adb8beSMarkus ArmbrusterForce hard disk 0 physical geometry (1 <= @var{c} <= 16383, 1 <= 66710adb8beSMarkus Armbruster@var{h} <= 16, 1 <= @var{s} <= 63) and optionally force the BIOS 66810adb8beSMarkus Armbrustertranslation mode (@var{t}=none, lba or auto). Usually QEMU can guess 66910adb8beSMarkus Armbrusterall those parameters. This option is useful for old MS-DOS disk 67010adb8beSMarkus Armbrusterimages. 671c70a01e4SMarkus ArmbrusterETEXI 67274db920cSGautham R Shenoy 67374db920cSGautham R ShenoyDEF("fsdev", HAS_ARG, QEMU_OPTION_fsdev, 6742c30dd74SAneesh Kumar K.V "-fsdev fsdriver,id=id[,path=path,][security_model={mapped-xattr|mapped-file|passthrough|none}]\n" 67584a87cc4SM. Mohan Kumar " [,writeout=immediate][,readonly][,socket=socket|sock_fd=sock_fd]\n", 67674db920cSGautham R Shenoy QEMU_ARCH_ALL) 67774db920cSGautham R Shenoy 67874db920cSGautham R ShenoySTEXI 67974db920cSGautham R Shenoy 68084a87cc4SM. 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}] 68174db920cSGautham R Shenoy@findex -fsdev 6827c92a3d2SAneesh Kumar K.VDefine a new file system device. Valid options are: 6837c92a3d2SAneesh Kumar K.V@table @option 6847c92a3d2SAneesh Kumar K.V@item @var{fsdriver} 6857c92a3d2SAneesh Kumar K.VThis option specifies the fs driver backend to use. 686f67e3ffdSM. Mohan KumarCurrently "local", "handle" and "proxy" file system drivers are supported. 6877c92a3d2SAneesh Kumar K.V@item id=@var{id} 6887c92a3d2SAneesh Kumar K.VSpecifies identifier for this device 6897c92a3d2SAneesh Kumar K.V@item path=@var{path} 6907c92a3d2SAneesh Kumar K.VSpecifies the export path for the file system device. Files under 6917c92a3d2SAneesh Kumar K.Vthis path will be available to the 9p client on the guest. 6927c92a3d2SAneesh Kumar K.V@item security_model=@var{security_model} 6937c92a3d2SAneesh Kumar K.VSpecifies the security model to be used for this export path. 6942c30dd74SAneesh Kumar K.VSupported security models are "passthrough", "mapped-xattr", "mapped-file" and "none". 6957c92a3d2SAneesh Kumar K.VIn "passthrough" security model, files are stored using the same 696b65ee4faSStefan Weilcredentials as they are created on the guest. This requires QEMU 6972c30dd74SAneesh Kumar K.Vto run as root. In "mapped-xattr" security model, some of the file 6987c92a3d2SAneesh Kumar K.Vattributes like uid, gid, mode bits and link target are stored as 6992c30dd74SAneesh Kumar K.Vfile attributes. For "mapped-file" these attributes are stored in the 7002c30dd74SAneesh Kumar K.Vhidden .virtfs_metadata directory. Directories exported by this security model cannot 7017c92a3d2SAneesh Kumar K.Vinteract with other unix tools. "none" security model is same as 7027c92a3d2SAneesh Kumar K.Vpassthrough except the sever won't report failures if it fails to 703d9b36a6eSM. Mohan Kumarset file attributes like ownership. Security model is mandatory 704f67e3ffdSM. Mohan Kumaronly for local fsdriver. Other fsdrivers (like handle, proxy) don't take 705d9b36a6eSM. Mohan Kumarsecurity model as a parameter. 7067c92a3d2SAneesh Kumar K.V@item writeout=@var{writeout} 7077c92a3d2SAneesh Kumar K.VThis is an optional argument. The only supported value is "immediate". 7087c92a3d2SAneesh Kumar K.VThis means that host page cache will be used to read and write data but 7097c92a3d2SAneesh Kumar K.Vwrite notification will be sent to the guest only when the data has been 7107c92a3d2SAneesh Kumar K.Vreported as written by the storage subsystem. 7112c74c2cbSM. Mohan Kumar@item readonly 7122c74c2cbSM. Mohan KumarEnables exporting 9p share as a readonly mount for guests. By default 7132c74c2cbSM. Mohan Kumarread-write access is given. 71484a87cc4SM. Mohan Kumar@item socket=@var{socket} 71584a87cc4SM. Mohan KumarEnables proxy filesystem driver to use passed socket file for communicating 71684a87cc4SM. Mohan Kumarwith virtfs-proxy-helper 717f67e3ffdSM. Mohan Kumar@item sock_fd=@var{sock_fd} 718f67e3ffdSM. Mohan KumarEnables proxy filesystem driver to use passed socket descriptor for 719f67e3ffdSM. Mohan Kumarcommunicating with virtfs-proxy-helper. Usually a helper like libvirt 720f67e3ffdSM. Mohan Kumarwill create socketpair and pass one of the fds as sock_fd 72174db920cSGautham R Shenoy@end table 7227c92a3d2SAneesh Kumar K.V 7237c92a3d2SAneesh Kumar K.V-fsdev option is used along with -device driver "virtio-9p-pci". 7247c92a3d2SAneesh Kumar K.V@item -device virtio-9p-pci,fsdev=@var{id},mount_tag=@var{mount_tag} 7257c92a3d2SAneesh Kumar K.VOptions for virtio-9p-pci driver are: 7267c92a3d2SAneesh Kumar K.V@table @option 7277c92a3d2SAneesh Kumar K.V@item fsdev=@var{id} 7287c92a3d2SAneesh Kumar K.VSpecifies the id value specified along with -fsdev option 7297c92a3d2SAneesh Kumar K.V@item mount_tag=@var{mount_tag} 7307c92a3d2SAneesh Kumar K.VSpecifies the tag name to be used by the guest to mount this export point 7317c92a3d2SAneesh Kumar K.V@end table 7327c92a3d2SAneesh Kumar K.V 73374db920cSGautham R ShenoyETEXI 73474db920cSGautham R Shenoy 7353d54abc7SGautham R ShenoyDEF("virtfs", HAS_ARG, QEMU_OPTION_virtfs, 7362c30dd74SAneesh Kumar K.V "-virtfs local,path=path,mount_tag=tag,security_model=[mapped-xattr|mapped-file|passthrough|none]\n" 73784a87cc4SM. Mohan Kumar " [,writeout=immediate][,readonly][,socket=socket|sock_fd=sock_fd]\n", 7383d54abc7SGautham R Shenoy QEMU_ARCH_ALL) 7393d54abc7SGautham R Shenoy 7403d54abc7SGautham R ShenoySTEXI 7413d54abc7SGautham R Shenoy 74284a87cc4SM. 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}] 7433d54abc7SGautham R Shenoy@findex -virtfs 7443d54abc7SGautham R Shenoy 7457c92a3d2SAneesh Kumar K.VThe general form of a Virtual File system pass-through options are: 7467c92a3d2SAneesh Kumar K.V@table @option 7477c92a3d2SAneesh Kumar K.V@item @var{fsdriver} 7487c92a3d2SAneesh Kumar K.VThis option specifies the fs driver backend to use. 749f67e3ffdSM. Mohan KumarCurrently "local", "handle" and "proxy" file system drivers are supported. 7507c92a3d2SAneesh Kumar K.V@item id=@var{id} 7517c92a3d2SAneesh Kumar K.VSpecifies identifier for this device 7527c92a3d2SAneesh Kumar K.V@item path=@var{path} 7537c92a3d2SAneesh Kumar K.VSpecifies the export path for the file system device. Files under 7547c92a3d2SAneesh Kumar K.Vthis path will be available to the 9p client on the guest. 7557c92a3d2SAneesh Kumar K.V@item security_model=@var{security_model} 7567c92a3d2SAneesh Kumar K.VSpecifies the security model to be used for this export path. 7572c30dd74SAneesh Kumar K.VSupported security models are "passthrough", "mapped-xattr", "mapped-file" and "none". 7587c92a3d2SAneesh Kumar K.VIn "passthrough" security model, files are stored using the same 759b65ee4faSStefan Weilcredentials as they are created on the guest. This requires QEMU 7602c30dd74SAneesh Kumar K.Vto run as root. In "mapped-xattr" security model, some of the file 7617c92a3d2SAneesh Kumar K.Vattributes like uid, gid, mode bits and link target are stored as 7622c30dd74SAneesh Kumar K.Vfile attributes. For "mapped-file" these attributes are stored in the 7632c30dd74SAneesh Kumar K.Vhidden .virtfs_metadata directory. Directories exported by this security model cannot 7647c92a3d2SAneesh Kumar K.Vinteract with other unix tools. "none" security model is same as 7657c92a3d2SAneesh Kumar K.Vpassthrough except the sever won't report failures if it fails to 766d9b36a6eSM. Mohan Kumarset file attributes like ownership. Security model is mandatory only 767f67e3ffdSM. Mohan Kumarfor local fsdriver. Other fsdrivers (like handle, proxy) don't take security 768d9b36a6eSM. Mohan Kumarmodel as a parameter. 7697c92a3d2SAneesh Kumar K.V@item writeout=@var{writeout} 7707c92a3d2SAneesh Kumar K.VThis is an optional argument. The only supported value is "immediate". 7717c92a3d2SAneesh Kumar K.VThis means that host page cache will be used to read and write data but 7727c92a3d2SAneesh Kumar K.Vwrite notification will be sent to the guest only when the data has been 7737c92a3d2SAneesh Kumar K.Vreported as written by the storage subsystem. 7742c74c2cbSM. Mohan Kumar@item readonly 7752c74c2cbSM. Mohan KumarEnables exporting 9p share as a readonly mount for guests. By default 7762c74c2cbSM. Mohan Kumarread-write access is given. 77784a87cc4SM. Mohan Kumar@item socket=@var{socket} 77884a87cc4SM. Mohan KumarEnables proxy filesystem driver to use passed socket file for 77984a87cc4SM. Mohan Kumarcommunicating with virtfs-proxy-helper. Usually a helper like libvirt 78084a87cc4SM. Mohan Kumarwill create socketpair and pass one of the fds as sock_fd 781f67e3ffdSM. Mohan Kumar@item sock_fd 782f67e3ffdSM. Mohan KumarEnables proxy filesystem driver to use passed 'sock_fd' as the socket 783f67e3ffdSM. Mohan Kumardescriptor for interfacing with virtfs-proxy-helper 7843d54abc7SGautham R Shenoy@end table 7853d54abc7SGautham R ShenoyETEXI 7863d54abc7SGautham R Shenoy 7879db221aeSAneesh Kumar K.VDEF("virtfs_synth", 0, QEMU_OPTION_virtfs_synth, 7889db221aeSAneesh Kumar K.V "-virtfs_synth Create synthetic file system image\n", 7899db221aeSAneesh Kumar K.V QEMU_ARCH_ALL) 7909db221aeSAneesh Kumar K.VSTEXI 7919db221aeSAneesh Kumar K.V@item -virtfs_synth 7929db221aeSAneesh Kumar K.V@findex -virtfs_synth 7939db221aeSAneesh Kumar K.VCreate synthetic file system image 7949db221aeSAneesh Kumar K.VETEXI 7959db221aeSAneesh Kumar K.V 7965824d651Sblueswir1STEXI 7975824d651Sblueswir1@end table 7985824d651Sblueswir1ETEXI 7995824d651Sblueswir1DEFHEADING() 8005824d651Sblueswir1 80110adb8beSMarkus ArmbrusterDEFHEADING(USB options:) 80210adb8beSMarkus ArmbrusterSTEXI 80310adb8beSMarkus Armbruster@table @option 80410adb8beSMarkus ArmbrusterETEXI 80510adb8beSMarkus Armbruster 80610adb8beSMarkus ArmbrusterDEF("usb", 0, QEMU_OPTION_usb, 80710adb8beSMarkus Armbruster "-usb enable the USB driver (will be the default soon)\n", 80810adb8beSMarkus Armbruster QEMU_ARCH_ALL) 80910adb8beSMarkus ArmbrusterSTEXI 81010adb8beSMarkus Armbruster@item -usb 81110adb8beSMarkus Armbruster@findex -usb 81210adb8beSMarkus ArmbrusterEnable the USB driver (will be the default soon) 81310adb8beSMarkus ArmbrusterETEXI 81410adb8beSMarkus Armbruster 81510adb8beSMarkus ArmbrusterDEF("usbdevice", HAS_ARG, QEMU_OPTION_usbdevice, 81610adb8beSMarkus Armbruster "-usbdevice name add the host or guest USB device 'name'\n", 81710adb8beSMarkus Armbruster QEMU_ARCH_ALL) 81810adb8beSMarkus ArmbrusterSTEXI 81910adb8beSMarkus Armbruster 82010adb8beSMarkus Armbruster@item -usbdevice @var{devname} 82110adb8beSMarkus Armbruster@findex -usbdevice 82210adb8beSMarkus ArmbrusterAdd the USB device @var{devname}. @xref{usb_devices}. 82310adb8beSMarkus Armbruster 82410adb8beSMarkus Armbruster@table @option 82510adb8beSMarkus Armbruster 82610adb8beSMarkus Armbruster@item mouse 82710adb8beSMarkus ArmbrusterVirtual Mouse. This will override the PS/2 mouse emulation when activated. 82810adb8beSMarkus Armbruster 82910adb8beSMarkus Armbruster@item tablet 83010adb8beSMarkus ArmbrusterPointer device that uses absolute coordinates (like a touchscreen). This 83110adb8beSMarkus Armbrustermeans QEMU is able to report the mouse position without having to grab the 83210adb8beSMarkus Armbrustermouse. Also overrides the PS/2 mouse emulation when activated. 83310adb8beSMarkus Armbruster 83410adb8beSMarkus Armbruster@item disk:[format=@var{format}]:@var{file} 83510adb8beSMarkus ArmbrusterMass storage device based on file. The optional @var{format} argument 83610adb8beSMarkus Armbrusterwill be used rather than detecting the format. Can be used to specifiy 83710adb8beSMarkus Armbruster@code{format=raw} to avoid interpreting an untrusted format header. 83810adb8beSMarkus Armbruster 83910adb8beSMarkus Armbruster@item host:@var{bus}.@var{addr} 84010adb8beSMarkus ArmbrusterPass through the host device identified by @var{bus}.@var{addr} (Linux only). 84110adb8beSMarkus Armbruster 84210adb8beSMarkus Armbruster@item host:@var{vendor_id}:@var{product_id} 84310adb8beSMarkus ArmbrusterPass through the host device identified by @var{vendor_id}:@var{product_id} 84410adb8beSMarkus Armbruster(Linux only). 84510adb8beSMarkus Armbruster 84610adb8beSMarkus Armbruster@item serial:[vendorid=@var{vendor_id}][,productid=@var{product_id}]:@var{dev} 84710adb8beSMarkus ArmbrusterSerial converter to host character device @var{dev}, see @code{-serial} for the 84810adb8beSMarkus Armbrusteravailable devices. 84910adb8beSMarkus Armbruster 85010adb8beSMarkus Armbruster@item braille 85110adb8beSMarkus ArmbrusterBraille device. This will use BrlAPI to display the braille output on a real 85210adb8beSMarkus Armbrusteror fake device. 85310adb8beSMarkus Armbruster 85410adb8beSMarkus Armbruster@item net:@var{options} 85510adb8beSMarkus ArmbrusterNetwork adapter that supports CDC ethernet and RNDIS protocols. 85610adb8beSMarkus Armbruster 85710adb8beSMarkus Armbruster@end table 85810adb8beSMarkus ArmbrusterETEXI 85910adb8beSMarkus Armbruster 86010adb8beSMarkus ArmbrusterSTEXI 86110adb8beSMarkus Armbruster@end table 86210adb8beSMarkus ArmbrusterETEXI 86310adb8beSMarkus ArmbrusterDEFHEADING() 86410adb8beSMarkus Armbruster 8655824d651Sblueswir1DEFHEADING(Display options:) 8665824d651Sblueswir1STEXI 8675824d651Sblueswir1@table @option 8685824d651Sblueswir1ETEXI 8695824d651Sblueswir1 8701472a95bSJes SorensenDEF("display", HAS_ARG, QEMU_OPTION_display, 8711472a95bSJes Sorensen "-display sdl[,frame=on|off][,alt_grab=on|off][,ctrl_grab=on|off]\n" 8723264ff12SJes Sorensen " [,window_close=on|off]|curses|none|\n" 873881249c7SJan Kiszka " gtk[,grab_on_hover=on|off]|\n" 8743264ff12SJes Sorensen " vnc=<display>[,<optargs>]\n" 8751472a95bSJes Sorensen " select display type\n", QEMU_ARCH_ALL) 8761472a95bSJes SorensenSTEXI 8771472a95bSJes Sorensen@item -display @var{type} 8781472a95bSJes Sorensen@findex -display 8791472a95bSJes SorensenSelect type of display to use. This option is a replacement for the 8801472a95bSJes Sorensenold style -sdl/-curses/... options. Valid values for @var{type} are 8811472a95bSJes Sorensen@table @option 8821472a95bSJes Sorensen@item sdl 8831472a95bSJes SorensenDisplay video output via SDL (usually in a separate graphics 8841472a95bSJes Sorensenwindow; see the SDL documentation for other possibilities). 8851472a95bSJes Sorensen@item curses 8861472a95bSJes SorensenDisplay video output via curses. For graphics device models which 8871472a95bSJes Sorensensupport a text mode, QEMU can display this output using a 8881472a95bSJes Sorensencurses/ncurses interface. Nothing is displayed when the graphics 8891472a95bSJes Sorensendevice is in graphical mode or if the graphics device does not support 8901472a95bSJes Sorensena text mode. Generally only the VGA device models support text mode. 8914171d32eSJes Sorensen@item none 8924171d32eSJes SorensenDo not display video output. The guest will still see an emulated 8934171d32eSJes Sorensengraphics card, but its output will not be displayed to the QEMU 8944171d32eSJes Sorensenuser. This option differs from the -nographic option in that it 8954171d32eSJes Sorensenonly affects what is done with video output; -nographic also changes 8964171d32eSJes Sorensenthe destination of the serial and parallel port data. 897881249c7SJan Kiszka@item gtk 898881249c7SJan KiszkaDisplay video output in a GTK window. This interface provides drop-down 899881249c7SJan Kiszkamenus and other UI elements to configure and control the VM during 900881249c7SJan Kiszkaruntime. 9013264ff12SJes Sorensen@item vnc 9023264ff12SJes SorensenStart a VNC server on display <arg> 9031472a95bSJes Sorensen@end table 9041472a95bSJes SorensenETEXI 9051472a95bSJes Sorensen 9065824d651Sblueswir1DEF("nographic", 0, QEMU_OPTION_nographic, 907ad96090aSBlue Swirl "-nographic disable graphical output and redirect serial I/Os to console\n", 908ad96090aSBlue Swirl QEMU_ARCH_ALL) 9095824d651Sblueswir1STEXI 9105824d651Sblueswir1@item -nographic 9116616b2adSStefan Weil@findex -nographic 9125824d651Sblueswir1Normally, QEMU uses SDL to display the VGA output. With this option, 9135824d651Sblueswir1you can totally disable graphical output so that QEMU is a simple 9145824d651Sblueswir1command line application. The emulated serial port is redirected on 91502c4bdf1SPaolo Bonzinithe console and muxed with the monitor (unless redirected elsewhere 91602c4bdf1SPaolo Bonziniexplicitly). Therefore, you can still use QEMU to debug a Linux kernel 917b031f413SRamkumar Ramachandrawith a serial console. Use @key{C-a h} for help on switching between 918b031f413SRamkumar Ramachandrathe console and monitor. 9195824d651Sblueswir1ETEXI 9205824d651Sblueswir1 9215824d651Sblueswir1DEF("curses", 0, QEMU_OPTION_curses, 922ad96090aSBlue Swirl "-curses use a curses/ncurses interface instead of SDL\n", 923ad96090aSBlue Swirl QEMU_ARCH_ALL) 9245824d651Sblueswir1STEXI 9255824d651Sblueswir1@item -curses 926b8f490ebSMarkus Armbruster@findex -curses 9275824d651Sblueswir1Normally, QEMU uses SDL to display the VGA output. With this option, 9285824d651Sblueswir1QEMU can display the VGA output when in text mode using a 9295824d651Sblueswir1curses/ncurses interface. Nothing is displayed in graphical mode. 9305824d651Sblueswir1ETEXI 9315824d651Sblueswir1 9325824d651Sblueswir1DEF("no-frame", 0, QEMU_OPTION_no_frame, 933ad96090aSBlue Swirl "-no-frame open SDL window without a frame and window decorations\n", 934ad96090aSBlue Swirl QEMU_ARCH_ALL) 9355824d651Sblueswir1STEXI 9365824d651Sblueswir1@item -no-frame 9376616b2adSStefan Weil@findex -no-frame 9385824d651Sblueswir1Do not use decorations for SDL windows and start them using the whole 9395824d651Sblueswir1available screen space. This makes the using QEMU in a dedicated desktop 9405824d651Sblueswir1workspace more convenient. 9415824d651Sblueswir1ETEXI 9425824d651Sblueswir1 9435824d651Sblueswir1DEF("alt-grab", 0, QEMU_OPTION_alt_grab, 944ad96090aSBlue Swirl "-alt-grab use Ctrl-Alt-Shift to grab mouse (instead of Ctrl-Alt)\n", 945ad96090aSBlue Swirl QEMU_ARCH_ALL) 9465824d651Sblueswir1STEXI 9475824d651Sblueswir1@item -alt-grab 9486616b2adSStefan Weil@findex -alt-grab 949de1db2a1SBrad HardsUse Ctrl-Alt-Shift to grab mouse (instead of Ctrl-Alt). Note that this also 950de1db2a1SBrad Hardsaffects the special keys (for fullscreen, monitor-mode switching, etc). 9515824d651Sblueswir1ETEXI 9525824d651Sblueswir1 9530ca9f8a4SDustin KirklandDEF("ctrl-grab", 0, QEMU_OPTION_ctrl_grab, 954ad96090aSBlue Swirl "-ctrl-grab use Right-Ctrl to grab mouse (instead of Ctrl-Alt)\n", 955ad96090aSBlue Swirl QEMU_ARCH_ALL) 9560ca9f8a4SDustin KirklandSTEXI 9570ca9f8a4SDustin Kirkland@item -ctrl-grab 9586616b2adSStefan Weil@findex -ctrl-grab 959de1db2a1SBrad HardsUse Right-Ctrl to grab mouse (instead of Ctrl-Alt). Note that this also 960de1db2a1SBrad Hardsaffects the special keys (for fullscreen, monitor-mode switching, etc). 9610ca9f8a4SDustin KirklandETEXI 9620ca9f8a4SDustin Kirkland 9635824d651Sblueswir1DEF("no-quit", 0, QEMU_OPTION_no_quit, 964ad96090aSBlue Swirl "-no-quit disable SDL window close capability\n", QEMU_ARCH_ALL) 9655824d651Sblueswir1STEXI 9665824d651Sblueswir1@item -no-quit 9676616b2adSStefan Weil@findex -no-quit 9685824d651Sblueswir1Disable SDL window close capability. 9695824d651Sblueswir1ETEXI 9705824d651Sblueswir1 9715824d651Sblueswir1DEF("sdl", 0, QEMU_OPTION_sdl, 972ad96090aSBlue Swirl "-sdl enable SDL\n", QEMU_ARCH_ALL) 9735824d651Sblueswir1STEXI 9745824d651Sblueswir1@item -sdl 9756616b2adSStefan Weil@findex -sdl 9765824d651Sblueswir1Enable SDL. 9775824d651Sblueswir1ETEXI 9785824d651Sblueswir1 97929b0040bSGerd HoffmannDEF("spice", HAS_ARG, QEMU_OPTION_spice, 98027af7788SYonit Halperin "-spice [port=port][,tls-port=secured-port][,x509-dir=<dir>]\n" 98127af7788SYonit Halperin " [,x509-key-file=<file>][,x509-key-password=<file>]\n" 98227af7788SYonit Halperin " [,x509-cert-file=<file>][,x509-cacert-file=<file>]\n" 983fe4831b1SMarc-André Lureau " [,x509-dh-key-file=<file>][,addr=addr][,ipv4|ipv6|unix]\n" 98427af7788SYonit Halperin " [,tls-ciphers=<list>]\n" 98527af7788SYonit Halperin " [,tls-channel=[main|display|cursor|inputs|record|playback]]\n" 98627af7788SYonit Halperin " [,plaintext-channel=[main|display|cursor|inputs|record|playback]]\n" 98727af7788SYonit Halperin " [,sasl][,password=<secret>][,disable-ticketing]\n" 98827af7788SYonit Halperin " [,image-compression=[auto_glz|auto_lz|quic|glz|lz|off]]\n" 98927af7788SYonit Halperin " [,jpeg-wan-compression=[auto|never|always]]\n" 99027af7788SYonit Halperin " [,zlib-glz-wan-compression=[auto|never|always]]\n" 99127af7788SYonit Halperin " [,streaming-video=[off|all|filter]][,disable-copy-paste]\n" 9925ad24e5fSHans de Goede " [,disable-agent-file-xfer][,agent-mouse=[on|off]]\n" 9935ad24e5fSHans de Goede " [,playback-compression=[on|off]][,seamless-migration=[on|off]]\n" 99427af7788SYonit Halperin " enable spice\n" 99527af7788SYonit Halperin " at least one of {port, tls-port} is mandatory\n", 99627af7788SYonit Halperin QEMU_ARCH_ALL) 99729b0040bSGerd HoffmannSTEXI 99829b0040bSGerd Hoffmann@item -spice @var{option}[,@var{option}[,...]] 99929b0040bSGerd Hoffmann@findex -spice 100029b0040bSGerd HoffmannEnable the spice remote desktop protocol. Valid options are 100129b0040bSGerd Hoffmann 100229b0040bSGerd Hoffmann@table @option 100329b0040bSGerd Hoffmann 100429b0040bSGerd Hoffmann@item port=<nr> 1005c448e855SGerd HoffmannSet the TCP port spice is listening on for plaintext channels. 100629b0040bSGerd Hoffmann 1007333b0eebSGerd Hoffmann@item addr=<addr> 1008333b0eebSGerd HoffmannSet the IP address spice is listening on. Default is any address. 1009333b0eebSGerd Hoffmann 1010333b0eebSGerd Hoffmann@item ipv4 1011333b0eebSGerd Hoffmann@item ipv6 1012fe4831b1SMarc-André Lureau@item unix 1013333b0eebSGerd HoffmannForce using the specified IP version. 1014333b0eebSGerd Hoffmann 101529b0040bSGerd Hoffmann@item password=<secret> 101629b0040bSGerd HoffmannSet the password you need to authenticate. 101729b0040bSGerd Hoffmann 101848b3ed0aSMarc-André Lureau@item sasl 101948b3ed0aSMarc-André LureauRequire that the client use SASL to authenticate with the spice. 102048b3ed0aSMarc-André LureauThe exact choice of authentication method used is controlled from the 102148b3ed0aSMarc-André Lureausystem / user's SASL configuration file for the 'qemu' service. This 102248b3ed0aSMarc-André Lureauis typically found in /etc/sasl2/qemu.conf. If running QEMU as an 102348b3ed0aSMarc-André Lureauunprivileged user, an environment variable SASL_CONF_PATH can be used 102448b3ed0aSMarc-André Lureauto make it search alternate locations for the service config. 102548b3ed0aSMarc-André LureauWhile some SASL auth methods can also provide data encryption (eg GSSAPI), 102648b3ed0aSMarc-André Lureauit is recommended that SASL always be combined with the 'tls' and 102748b3ed0aSMarc-André Lureau'x509' settings to enable use of SSL and server certificates. This 102848b3ed0aSMarc-André Lureauensures a data encryption preventing compromise of authentication 102948b3ed0aSMarc-André Lureaucredentials. 103048b3ed0aSMarc-André Lureau 103129b0040bSGerd Hoffmann@item disable-ticketing 103229b0040bSGerd HoffmannAllow client connects without authentication. 103329b0040bSGerd Hoffmann 1034d4970b07SHans de Goede@item disable-copy-paste 1035d4970b07SHans de GoedeDisable copy paste between the client and the guest. 1036d4970b07SHans de Goede 10375ad24e5fSHans de Goede@item disable-agent-file-xfer 10385ad24e5fSHans de GoedeDisable spice-vdagent based file-xfer between the client and the guest. 10395ad24e5fSHans de Goede 1040c448e855SGerd Hoffmann@item tls-port=<nr> 1041c448e855SGerd HoffmannSet the TCP port spice is listening on for encrypted channels. 1042c448e855SGerd Hoffmann 1043c448e855SGerd Hoffmann@item x509-dir=<dir> 1044c448e855SGerd HoffmannSet the x509 file directory. Expects same filenames as -vnc $display,x509=$dir 1045c448e855SGerd Hoffmann 1046c448e855SGerd Hoffmann@item x509-key-file=<file> 1047c448e855SGerd Hoffmann@item x509-key-password=<file> 1048c448e855SGerd Hoffmann@item x509-cert-file=<file> 1049c448e855SGerd Hoffmann@item x509-cacert-file=<file> 1050c448e855SGerd Hoffmann@item x509-dh-key-file=<file> 1051c448e855SGerd HoffmannThe x509 file names can also be configured individually. 1052c448e855SGerd Hoffmann 1053c448e855SGerd Hoffmann@item tls-ciphers=<list> 1054c448e855SGerd HoffmannSpecify which ciphers to use. 1055c448e855SGerd Hoffmann 1056d70d6b31SAlon Levy@item tls-channel=[main|display|cursor|inputs|record|playback] 1057d70d6b31SAlon Levy@item plaintext-channel=[main|display|cursor|inputs|record|playback] 105817b6dea0SGerd HoffmannForce specific channel to be used with or without TLS encryption. The 105917b6dea0SGerd Hoffmannoptions can be specified multiple times to configure multiple 106017b6dea0SGerd Hoffmannchannels. The special name "default" can be used to set the default 106117b6dea0SGerd Hoffmannmode. For channels which are not explicitly forced into one mode the 106217b6dea0SGerd Hoffmannspice client is allowed to pick tls/plaintext as he pleases. 106317b6dea0SGerd Hoffmann 10649f04e09eSYonit Halperin@item image-compression=[auto_glz|auto_lz|quic|glz|lz|off] 10659f04e09eSYonit HalperinConfigure image compression (lossless). 10669f04e09eSYonit HalperinDefault is auto_glz. 10679f04e09eSYonit Halperin 10689f04e09eSYonit Halperin@item jpeg-wan-compression=[auto|never|always] 10699f04e09eSYonit Halperin@item zlib-glz-wan-compression=[auto|never|always] 10709f04e09eSYonit HalperinConfigure wan image compression (lossy for slow links). 10719f04e09eSYonit HalperinDefault is auto. 10729f04e09eSYonit Halperin 107384a23f25SGerd Hoffmann@item streaming-video=[off|all|filter] 107484a23f25SGerd HoffmannConfigure video stream detection. Default is filter. 107584a23f25SGerd Hoffmann 107684a23f25SGerd Hoffmann@item agent-mouse=[on|off] 107784a23f25SGerd HoffmannEnable/disable passing mouse events via vdagent. Default is on. 107884a23f25SGerd Hoffmann 107984a23f25SGerd Hoffmann@item playback-compression=[on|off] 108084a23f25SGerd HoffmannEnable/disable audio stream compression (using celt 0.5.1). Default is on. 108184a23f25SGerd Hoffmann 10828c957053SYonit Halperin@item seamless-migration=[on|off] 10838c957053SYonit HalperinEnable/disable spice seamless migration. Default is off. 10848c957053SYonit Halperin 108529b0040bSGerd Hoffmann@end table 108629b0040bSGerd HoffmannETEXI 108729b0040bSGerd Hoffmann 10885824d651Sblueswir1DEF("portrait", 0, QEMU_OPTION_portrait, 1089ad96090aSBlue Swirl "-portrait rotate graphical output 90 deg left (only PXA LCD)\n", 1090ad96090aSBlue Swirl QEMU_ARCH_ALL) 10915824d651Sblueswir1STEXI 10925824d651Sblueswir1@item -portrait 10936616b2adSStefan Weil@findex -portrait 10945824d651Sblueswir1Rotate graphical output 90 deg left (only PXA LCD). 10955824d651Sblueswir1ETEXI 10965824d651Sblueswir1 10979312805dSVasily KhoruzhickDEF("rotate", HAS_ARG, QEMU_OPTION_rotate, 10989312805dSVasily Khoruzhick "-rotate <deg> rotate graphical output some deg left (only PXA LCD)\n", 10999312805dSVasily Khoruzhick QEMU_ARCH_ALL) 11009312805dSVasily KhoruzhickSTEXI 11016265c43bSMarkus Armbruster@item -rotate @var{deg} 11029312805dSVasily Khoruzhick@findex -rotate 11039312805dSVasily KhoruzhickRotate graphical output some deg left (only PXA LCD). 11049312805dSVasily KhoruzhickETEXI 11059312805dSVasily Khoruzhick 11065824d651Sblueswir1DEF("vga", HAS_ARG, QEMU_OPTION_vga, 110733632788SMark Cave-Ayland "-vga [std|cirrus|vmware|qxl|xenfb|tcx|cg3|none]\n" 1108ad96090aSBlue Swirl " select video card type\n", QEMU_ARCH_ALL) 11095824d651Sblueswir1STEXI 1110e4558dcaSmalc@item -vga @var{type} 11116616b2adSStefan Weil@findex -vga 11125824d651Sblueswir1Select type of VGA card to emulate. Valid values for @var{type} are 1113b3f046c2SKevin Wolf@table @option 11145824d651Sblueswir1@item cirrus 11155824d651Sblueswir1Cirrus Logic GD5446 Video card. All Windows versions starting from 11165824d651Sblueswir1Windows 95 should recognize and use this graphic card. For optimal 11175824d651Sblueswir1performances, use 16 bit color depth in the guest and the host OS. 11185824d651Sblueswir1(This one is the default) 11195824d651Sblueswir1@item std 11205824d651Sblueswir1Standard VGA card with Bochs VBE extensions. If your guest OS 11215824d651Sblueswir1supports the VESA 2.0 VBE extensions (e.g. Windows XP) and if you want 11225824d651Sblueswir1to use high resolution modes (>= 1280x1024x16) then you should use 11235824d651Sblueswir1this option. 11245824d651Sblueswir1@item vmware 11255824d651Sblueswir1VMWare SVGA-II compatible adapter. Use it if you have sufficiently 11265824d651Sblueswir1recent XFree86/XOrg server or Windows guest with a driver for this 11275824d651Sblueswir1card. 1128a19cbfb3SGerd Hoffmann@item qxl 1129a19cbfb3SGerd HoffmannQXL paravirtual graphic card. It is VGA compatible (including VESA 1130a19cbfb3SGerd Hoffmann2.0 VBE support). Works best with qxl guest drivers installed though. 1131a19cbfb3SGerd HoffmannRecommended choice when using the spice protocol. 113233632788SMark Cave-Ayland@item tcx 113333632788SMark Cave-Ayland(sun4m only) Sun TCX framebuffer. This is the default framebuffer for 113433632788SMark Cave-Aylandsun4m machines and offers both 8-bit and 24-bit colour depths at a 113533632788SMark Cave-Aylandfixed resolution of 1024x768. 113633632788SMark Cave-Ayland@item cg3 113733632788SMark Cave-Ayland(sun4m only) Sun cgthree framebuffer. This is a simple 8-bit framebuffer 113833632788SMark Cave-Aylandfor sun4m machines available in both 1024x768 (OpenBIOS) and 1152x900 (OBP) 113933632788SMark Cave-Aylandresolutions aimed at people wishing to run older Solaris versions. 11405824d651Sblueswir1@item none 11415824d651Sblueswir1Disable VGA card. 11425824d651Sblueswir1@end table 11435824d651Sblueswir1ETEXI 11445824d651Sblueswir1 11455824d651Sblueswir1DEF("full-screen", 0, QEMU_OPTION_full_screen, 1146ad96090aSBlue Swirl "-full-screen start in full screen\n", QEMU_ARCH_ALL) 11475824d651Sblueswir1STEXI 11485824d651Sblueswir1@item -full-screen 11496616b2adSStefan Weil@findex -full-screen 11505824d651Sblueswir1Start in full screen. 11515824d651Sblueswir1ETEXI 11525824d651Sblueswir1 11535824d651Sblueswir1DEF("g", 1, QEMU_OPTION_g , 1154ad96090aSBlue Swirl "-g WxH[xDEPTH] Set the initial graphical resolution and depth\n", 1155ad96090aSBlue Swirl QEMU_ARCH_PPC | QEMU_ARCH_SPARC) 11565824d651Sblueswir1STEXI 115795d5f08bSStefan Weil@item -g @var{width}x@var{height}[x@var{depth}] 11586616b2adSStefan Weil@findex -g 115995d5f08bSStefan WeilSet the initial graphical resolution and depth (PPC, SPARC only). 11605824d651Sblueswir1ETEXI 11615824d651Sblueswir1 11625824d651Sblueswir1DEF("vnc", HAS_ARG, QEMU_OPTION_vnc , 1163ad96090aSBlue Swirl "-vnc display start a VNC server on display\n", QEMU_ARCH_ALL) 11645824d651Sblueswir1STEXI 11655824d651Sblueswir1@item -vnc @var{display}[,@var{option}[,@var{option}[,...]]] 11666616b2adSStefan Weil@findex -vnc 11675824d651Sblueswir1Normally, QEMU uses SDL to display the VGA output. With this option, 11685824d651Sblueswir1you can have QEMU listen on VNC display @var{display} and redirect the VGA 11695824d651Sblueswir1display over the VNC session. It is very useful to enable the usb 11705824d651Sblueswir1tablet device when using this option (option @option{-usbdevice 11715824d651Sblueswir1tablet}). When using the VNC display, you must use the @option{-k} 11725824d651Sblueswir1parameter to set the keyboard layout if you are not using en-us. Valid 11735824d651Sblueswir1syntax for the @var{display} is 11745824d651Sblueswir1 1175b3f046c2SKevin Wolf@table @option 11765824d651Sblueswir1 11775824d651Sblueswir1@item @var{host}:@var{d} 11785824d651Sblueswir1 11795824d651Sblueswir1TCP connections will only be allowed from @var{host} on display @var{d}. 11805824d651Sblueswir1By convention the TCP port is 5900+@var{d}. Optionally, @var{host} can 11815824d651Sblueswir1be omitted in which case the server will accept connections from any host. 11825824d651Sblueswir1 11834e257e5eSKevin Wolf@item unix:@var{path} 11845824d651Sblueswir1 11855824d651Sblueswir1Connections will be allowed over UNIX domain sockets where @var{path} is the 11865824d651Sblueswir1location of a unix socket to listen for connections on. 11875824d651Sblueswir1 11885824d651Sblueswir1@item none 11895824d651Sblueswir1 11905824d651Sblueswir1VNC is initialized but not started. The monitor @code{change} command 11915824d651Sblueswir1can be used to later start the VNC server. 11925824d651Sblueswir1 11935824d651Sblueswir1@end table 11945824d651Sblueswir1 11955824d651Sblueswir1Following the @var{display} value there may be one or more @var{option} flags 11965824d651Sblueswir1separated by commas. Valid options are 11975824d651Sblueswir1 1198b3f046c2SKevin Wolf@table @option 11995824d651Sblueswir1 12005824d651Sblueswir1@item reverse 12015824d651Sblueswir1 12025824d651Sblueswir1Connect to a listening VNC client via a ``reverse'' connection. The 12035824d651Sblueswir1client is specified by the @var{display}. For reverse network 12045824d651Sblueswir1connections (@var{host}:@var{d},@code{reverse}), the @var{d} argument 12055824d651Sblueswir1is a TCP port number, not a display number. 12065824d651Sblueswir1 12077536ee4bSTim Hardeck@item websocket 12087536ee4bSTim Hardeck 12097536ee4bSTim HardeckOpens an additional TCP listening port dedicated to VNC Websocket connections. 1210085d8134SPeter MaydellBy definition the Websocket port is 5700+@var{display}. If @var{host} is 12117536ee4bSTim Hardeckspecified connections will only be allowed from this host. 12127536ee4bSTim HardeckAs an alternative the Websocket port could be specified by using 12137536ee4bSTim Hardeck@code{websocket}=@var{port}. 12140057a0d5STim HardeckTLS encryption for the Websocket connection is supported if the required 12150057a0d5STim Hardeckcertificates are specified with the VNC option @option{x509}. 12167536ee4bSTim Hardeck 12175824d651Sblueswir1@item password 12185824d651Sblueswir1 12195824d651Sblueswir1Require that password based authentication is used for client connections. 122086ee5bc3SMichal Novotny 122186ee5bc3SMichal NovotnyThe password must be set separately using the @code{set_password} command in 122286ee5bc3SMichal Novotnythe @ref{pcsys_monitor}. The syntax to change your password is: 122386ee5bc3SMichal Novotny@code{set_password <protocol> <password>} where <protocol> could be either 122486ee5bc3SMichal Novotny"vnc" or "spice". 122586ee5bc3SMichal Novotny 122686ee5bc3SMichal NovotnyIf you would like to change <protocol> password expiration, you should use 122786ee5bc3SMichal Novotny@code{expire_password <protocol> <expiration-time>} where expiration time could 122886ee5bc3SMichal Novotnybe one of the following options: now, never, +seconds or UNIX time of 122986ee5bc3SMichal Novotnyexpiration, e.g. +60 to make password expire in 60 seconds, or 1335196800 123086ee5bc3SMichal Novotnyto make password expire on "Mon Apr 23 12:00:00 EDT 2012" (UNIX time for this 123186ee5bc3SMichal Novotnydate and time). 123286ee5bc3SMichal Novotny 123386ee5bc3SMichal NovotnyYou can also use keywords "now" or "never" for the expiration time to 123486ee5bc3SMichal Novotnyallow <protocol> password to expire immediately or never expire. 12355824d651Sblueswir1 12365824d651Sblueswir1@item tls 12375824d651Sblueswir1 12385824d651Sblueswir1Require that client use TLS when communicating with the VNC server. This 12395824d651Sblueswir1uses anonymous TLS credentials so is susceptible to a man-in-the-middle 12405824d651Sblueswir1attack. It is recommended that this option be combined with either the 12414e257e5eSKevin Wolf@option{x509} or @option{x509verify} options. 12425824d651Sblueswir1 12435824d651Sblueswir1@item x509=@var{/path/to/certificate/dir} 12445824d651Sblueswir1 12455824d651Sblueswir1Valid if @option{tls} is specified. Require that x509 credentials are used 12465824d651Sblueswir1for negotiating the TLS session. The server will send its x509 certificate 12475824d651Sblueswir1to the client. It is recommended that a password be set on the VNC server 12485824d651Sblueswir1to provide authentication of the client when this is used. The path following 12495824d651Sblueswir1this option specifies where the x509 certificates are to be loaded from. 12505824d651Sblueswir1See the @ref{vnc_security} section for details on generating certificates. 12515824d651Sblueswir1 12525824d651Sblueswir1@item x509verify=@var{/path/to/certificate/dir} 12535824d651Sblueswir1 12545824d651Sblueswir1Valid if @option{tls} is specified. Require that x509 credentials are used 12555824d651Sblueswir1for negotiating the TLS session. The server will send its x509 certificate 12565824d651Sblueswir1to the client, and request that the client send its own x509 certificate. 12575824d651Sblueswir1The server will validate the client's certificate against the CA certificate, 12585824d651Sblueswir1and reject clients when validation fails. If the certificate authority is 12595824d651Sblueswir1trusted, this is a sufficient authentication mechanism. You may still wish 12605824d651Sblueswir1to set a password on the VNC server as a second authentication layer. The 12615824d651Sblueswir1path following this option specifies where the x509 certificates are to 12625824d651Sblueswir1be loaded from. See the @ref{vnc_security} section for details on generating 12635824d651Sblueswir1certificates. 12645824d651Sblueswir1 12655824d651Sblueswir1@item sasl 12665824d651Sblueswir1 12675824d651Sblueswir1Require that the client use SASL to authenticate with the VNC server. 12685824d651Sblueswir1The exact choice of authentication method used is controlled from the 12695824d651Sblueswir1system / user's SASL configuration file for the 'qemu' service. This 12705824d651Sblueswir1is typically found in /etc/sasl2/qemu.conf. If running QEMU as an 12715824d651Sblueswir1unprivileged user, an environment variable SASL_CONF_PATH can be used 12725824d651Sblueswir1to make it search alternate locations for the service config. 12735824d651Sblueswir1While some SASL auth methods can also provide data encryption (eg GSSAPI), 12745824d651Sblueswir1it is recommended that SASL always be combined with the 'tls' and 12755824d651Sblueswir1'x509' settings to enable use of SSL and server certificates. This 12765824d651Sblueswir1ensures a data encryption preventing compromise of authentication 12775824d651Sblueswir1credentials. See the @ref{vnc_security} section for details on using 12785824d651Sblueswir1SASL authentication. 12795824d651Sblueswir1 12805824d651Sblueswir1@item acl 12815824d651Sblueswir1 12825824d651Sblueswir1Turn on access control lists for checking of the x509 client certificate 12835824d651Sblueswir1and SASL party. For x509 certs, the ACL check is made against the 12845824d651Sblueswir1certificate's distinguished name. This is something that looks like 12855824d651Sblueswir1@code{C=GB,O=ACME,L=Boston,CN=bob}. For SASL party, the ACL check is 12865824d651Sblueswir1made against the username, which depending on the SASL plugin, may 12875824d651Sblueswir1include a realm component, eg @code{bob} or @code{bob@@EXAMPLE.COM}. 12885824d651Sblueswir1When the @option{acl} flag is set, the initial access list will be 12895824d651Sblueswir1empty, with a @code{deny} policy. Thus no one will be allowed to 12905824d651Sblueswir1use the VNC server until the ACLs have been loaded. This can be 12915824d651Sblueswir1achieved using the @code{acl} monitor command. 12925824d651Sblueswir1 12936f9c78c1SCorentin Chary@item lossy 12946f9c78c1SCorentin Chary 12956f9c78c1SCorentin CharyEnable lossy compression methods (gradient, JPEG, ...). If this 12966f9c78c1SCorentin Charyoption is set, VNC client may receive lossy framebuffer updates 12976f9c78c1SCorentin Charydepending on its encoding settings. Enabling this option can save 12986f9c78c1SCorentin Charya lot of bandwidth at the expense of quality. 12996f9c78c1SCorentin Chary 130080e0c8c3SCorentin Chary@item non-adaptive 130180e0c8c3SCorentin Chary 130280e0c8c3SCorentin CharyDisable adaptive encodings. Adaptive encodings are enabled by default. 130380e0c8c3SCorentin CharyAn adaptive encoding will try to detect frequently updated screen regions, 130480e0c8c3SCorentin Charyand send updates in these regions using a lossy encoding (like JPEG). 130561cc8701SStefan WeilThis can be really helpful to save bandwidth when playing videos. Disabling 13069d85d557SMichael Tokarevadaptive encodings restores the original static behavior of encodings 130780e0c8c3SCorentin Charylike Tight. 130880e0c8c3SCorentin Chary 13098cf36489SGerd Hoffmann@item share=[allow-exclusive|force-shared|ignore] 13108cf36489SGerd Hoffmann 13118cf36489SGerd HoffmannSet display sharing policy. 'allow-exclusive' allows clients to ask 13128cf36489SGerd Hoffmannfor exclusive access. As suggested by the rfb spec this is 13138cf36489SGerd Hoffmannimplemented by dropping other connections. Connecting multiple 13148cf36489SGerd Hoffmannclients in parallel requires all clients asking for a shared session 13158cf36489SGerd Hoffmann(vncviewer: -shared switch). This is the default. 'force-shared' 13168cf36489SGerd Hoffmanndisables exclusive client access. Useful for shared desktop sessions, 13178cf36489SGerd Hoffmannwhere you don't want someone forgetting specify -shared disconnect 13188cf36489SGerd Hoffmanneverybody else. 'ignore' completely ignores the shared flag and 13198cf36489SGerd Hoffmannallows everybody connect unconditionally. Doesn't conform to the rfb 1320b65ee4faSStefan Weilspec but is traditional QEMU behavior. 13218cf36489SGerd Hoffmann 13225824d651Sblueswir1@end table 13235824d651Sblueswir1ETEXI 13245824d651Sblueswir1 13255824d651Sblueswir1STEXI 13265824d651Sblueswir1@end table 13275824d651Sblueswir1ETEXI 1328a3adb7adSMichael EllermanARCHHEADING(, QEMU_ARCH_I386) 13295824d651Sblueswir1 1330a3adb7adSMichael EllermanARCHHEADING(i386 target only:, QEMU_ARCH_I386) 13315824d651Sblueswir1STEXI 13325824d651Sblueswir1@table @option 13335824d651Sblueswir1ETEXI 13345824d651Sblueswir1 13355824d651Sblueswir1DEF("win2k-hack", 0, QEMU_OPTION_win2k_hack, 1336ad96090aSBlue Swirl "-win2k-hack use it when installing Windows 2000 to avoid a disk full bug\n", 1337ad96090aSBlue Swirl QEMU_ARCH_I386) 13385824d651Sblueswir1STEXI 13395824d651Sblueswir1@item -win2k-hack 13406616b2adSStefan Weil@findex -win2k-hack 13415824d651Sblueswir1Use it when installing Windows 2000 to avoid a disk full bug. After 13425824d651Sblueswir1Windows 2000 is installed, you no longer need this option (this option 13435824d651Sblueswir1slows down the IDE transfers). 13445824d651Sblueswir1ETEXI 13455824d651Sblueswir1 13461ed2fc1fSJan KiszkaHXCOMM Deprecated by -rtc 1347ad96090aSBlue SwirlDEF("rtc-td-hack", 0, QEMU_OPTION_rtc_td_hack, "", QEMU_ARCH_I386) 13485824d651Sblueswir1 13495824d651Sblueswir1DEF("no-fd-bootchk", 0, QEMU_OPTION_no_fd_bootchk, 1350ad96090aSBlue Swirl "-no-fd-bootchk disable boot signature checking for floppy disks\n", 1351ad96090aSBlue Swirl QEMU_ARCH_I386) 13525824d651Sblueswir1STEXI 13535824d651Sblueswir1@item -no-fd-bootchk 13546616b2adSStefan Weil@findex -no-fd-bootchk 13554eda32f5SMarkus ArmbrusterDisable boot signature checking for floppy disks in BIOS. May 13565824d651Sblueswir1be needed to boot from old floppy disks. 13575824d651Sblueswir1ETEXI 13585824d651Sblueswir1 13595824d651Sblueswir1DEF("no-acpi", 0, QEMU_OPTION_no_acpi, 1360f5d8c8cdSShannon Zhao "-no-acpi disable ACPI\n", QEMU_ARCH_I386 | QEMU_ARCH_ARM) 13615824d651Sblueswir1STEXI 13625824d651Sblueswir1@item -no-acpi 13636616b2adSStefan Weil@findex -no-acpi 13645824d651Sblueswir1Disable ACPI (Advanced Configuration and Power Interface) support. Use 13655824d651Sblueswir1it if your guest OS complains about ACPI problems (PC target machine 13665824d651Sblueswir1only). 13675824d651Sblueswir1ETEXI 13685824d651Sblueswir1 13695824d651Sblueswir1DEF("no-hpet", 0, QEMU_OPTION_no_hpet, 1370ad96090aSBlue Swirl "-no-hpet disable HPET\n", QEMU_ARCH_I386) 13715824d651Sblueswir1STEXI 13725824d651Sblueswir1@item -no-hpet 13736616b2adSStefan Weil@findex -no-hpet 13745824d651Sblueswir1Disable HPET support. 13755824d651Sblueswir1ETEXI 13765824d651Sblueswir1 13775824d651Sblueswir1DEF("acpitable", HAS_ARG, QEMU_OPTION_acpitable, 1378104bf02eSMichael 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" 1379ad96090aSBlue Swirl " ACPI table description\n", QEMU_ARCH_I386) 13805824d651Sblueswir1STEXI 13815824d651Sblueswir1@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}]...] 13826616b2adSStefan Weil@findex -acpitable 13835824d651Sblueswir1Add ACPI table with specified header fields and context from specified files. 1384104bf02eSMichael TokarevFor file=, take whole ACPI table from the specified files, including all 1385104bf02eSMichael TokarevACPI headers (possible overridden by other options). 1386104bf02eSMichael TokarevFor data=, only data 1387104bf02eSMichael Tokarevportion of the table is used, all header information is specified in the 1388104bf02eSMichael Tokarevcommand line. 13895824d651Sblueswir1ETEXI 13905824d651Sblueswir1 1391b6f6e3d3SaliguoriDEF("smbios", HAS_ARG, QEMU_OPTION_smbios, 1392b6f6e3d3Saliguori "-smbios file=binary\n" 1393ca1a8a06SBruce Rogers " load SMBIOS entry from binary file\n" 1394b155eb1dSGabriel L. Somlo "-smbios type=0[,vendor=str][,version=str][,date=str][,release=%d.%d]\n" 1395b155eb1dSGabriel L. Somlo " [,uefi=on|off]\n" 1396ca1a8a06SBruce Rogers " specify SMBIOS type 0 fields\n" 1397b6f6e3d3Saliguori "-smbios type=1[,manufacturer=str][,product=str][,version=str][,serial=str]\n" 1398b6f6e3d3Saliguori " [,uuid=uuid][,sku=str][,family=str]\n" 1399b155eb1dSGabriel L. Somlo " specify SMBIOS type 1 fields\n" 1400b155eb1dSGabriel L. Somlo "-smbios type=2[,manufacturer=str][,product=str][,version=str][,serial=str]\n" 1401b155eb1dSGabriel L. Somlo " [,asset=str][,location=str]\n" 1402b155eb1dSGabriel L. Somlo " specify SMBIOS type 2 fields\n" 1403b155eb1dSGabriel L. Somlo "-smbios type=3[,manufacturer=str][,version=str][,serial=str][,asset=str]\n" 1404b155eb1dSGabriel L. Somlo " [,sku=str]\n" 1405b155eb1dSGabriel L. Somlo " specify SMBIOS type 3 fields\n" 1406b155eb1dSGabriel L. Somlo "-smbios type=4[,sock_pfx=str][,manufacturer=str][,version=str][,serial=str]\n" 1407b155eb1dSGabriel L. Somlo " [,asset=str][,part=str]\n" 1408b155eb1dSGabriel L. Somlo " specify SMBIOS type 4 fields\n" 1409b155eb1dSGabriel L. Somlo "-smbios type=17[,loc_pfx=str][,bank=str][,manufacturer=str][,serial=str]\n" 14103ebd6cc8SGabriel L. Somlo " [,asset=str][,part=str][,speed=%d]\n" 1411b155eb1dSGabriel L. Somlo " specify SMBIOS type 17 fields\n", 1412b155eb1dSGabriel L. Somlo QEMU_ARCH_I386) 1413b6f6e3d3SaliguoriSTEXI 1414b6f6e3d3Saliguori@item -smbios file=@var{binary} 14156616b2adSStefan Weil@findex -smbios 1416b6f6e3d3SaliguoriLoad SMBIOS entry from binary file. 1417b6f6e3d3Saliguori 141884351843SGabriel L. Somlo@item -smbios type=0[,vendor=@var{str}][,version=@var{str}][,date=@var{str}][,release=@var{%d.%d}][,uefi=on|off] 1419b6f6e3d3SaliguoriSpecify SMBIOS type 0 fields 1420b6f6e3d3Saliguori 1421b6f6e3d3Saliguori@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}] 1422b6f6e3d3SaliguoriSpecify SMBIOS type 1 fields 1423b155eb1dSGabriel L. Somlo 1424b155eb1dSGabriel L. Somlo@item -smbios type=2[,manufacturer=@var{str}][,product=@var{str}][,version=@var{str}][,serial=@var{str}][,asset=@var{str}][,location=@var{str}][,family=@var{str}] 1425b155eb1dSGabriel L. SomloSpecify SMBIOS type 2 fields 1426b155eb1dSGabriel L. Somlo 1427b155eb1dSGabriel L. Somlo@item -smbios type=3[,manufacturer=@var{str}][,version=@var{str}][,serial=@var{str}][,asset=@var{str}][,sku=@var{str}] 1428b155eb1dSGabriel L. SomloSpecify SMBIOS type 3 fields 1429b155eb1dSGabriel L. Somlo 1430b155eb1dSGabriel L. Somlo@item -smbios type=4[,sock_pfx=@var{str}][,manufacturer=@var{str}][,version=@var{str}][,serial=@var{str}][,asset=@var{str}][,part=@var{str}] 1431b155eb1dSGabriel L. SomloSpecify SMBIOS type 4 fields 1432b155eb1dSGabriel L. Somlo 14333ebd6cc8SGabriel L. Somlo@item -smbios type=17[,loc_pfx=@var{str}][,bank=@var{str}][,manufacturer=@var{str}][,serial=@var{str}][,asset=@var{str}][,part=@var{str}][,speed=@var{%d}] 1434b155eb1dSGabriel L. SomloSpecify SMBIOS type 17 fields 1435b6f6e3d3SaliguoriETEXI 1436b6f6e3d3Saliguori 14375824d651Sblueswir1STEXI 14385824d651Sblueswir1@end table 14395824d651Sblueswir1ETEXI 1440c70a01e4SMarkus ArmbrusterDEFHEADING() 14415824d651Sblueswir1 14425824d651Sblueswir1DEFHEADING(Network options:) 14435824d651Sblueswir1STEXI 14445824d651Sblueswir1@table @option 14455824d651Sblueswir1ETEXI 14465824d651Sblueswir1 1447ad196a9dSJan KiszkaHXCOMM Legacy slirp options (now moved to -net user): 1448ad196a9dSJan Kiszka#ifdef CONFIG_SLIRP 1449ad96090aSBlue SwirlDEF("tftp", HAS_ARG, QEMU_OPTION_tftp, "", QEMU_ARCH_ALL) 1450ad96090aSBlue SwirlDEF("bootp", HAS_ARG, QEMU_OPTION_bootp, "", QEMU_ARCH_ALL) 1451ad96090aSBlue SwirlDEF("redir", HAS_ARG, QEMU_OPTION_redir, "", QEMU_ARCH_ALL) 1452ad196a9dSJan Kiszka#ifndef _WIN32 1453ad96090aSBlue SwirlDEF("smb", HAS_ARG, QEMU_OPTION_smb, "", QEMU_ARCH_ALL) 1454ad196a9dSJan Kiszka#endif 1455ad196a9dSJan Kiszka#endif 1456ad196a9dSJan Kiszka 14576a8b4a5bSThomas HuthDEF("netdev", HAS_ARG, QEMU_OPTION_netdev, 14585824d651Sblueswir1#ifdef CONFIG_SLIRP 14596a8b4a5bSThomas Huth "-netdev user,id=str[,net=addr[/mask]][,host=addr][,restrict=on|off]\n" 146063d2960bSKlaus Stengel " [,hostname=host][,dhcpstart=addr][,dns=addr][,dnssearch=domain][,tftp=dir]\n" 146163d2960bSKlaus Stengel " [,bootfile=f][,hostfwd=rule][,guestfwd=rule]" 1462ad196a9dSJan Kiszka#ifndef _WIN32 1463c92ef6a2SJan Kiszka "[,smb=dir[,smbserver=addr]]\n" 1464ad196a9dSJan Kiszka#endif 14656a8b4a5bSThomas Huth " configure a user mode network backend with ID 'str',\n" 14666a8b4a5bSThomas Huth " its DHCP server and optional services\n" 14675824d651Sblueswir1#endif 14685824d651Sblueswir1#ifdef _WIN32 14696a8b4a5bSThomas Huth "-netdev tap,id=str,ifname=name\n" 14706a8b4a5bSThomas Huth " configure a host TAP network backend with ID 'str'\n" 14715824d651Sblueswir1#else 14726a8b4a5bSThomas Huth "-netdev tap,id=str[,fd=h][,fds=x:y:...:z][,ifname=name][,script=file][,downscript=dfile]\n" 14736a8b4a5bSThomas Huth " [,helper=helper][,sndbuf=nbytes][,vnet_hdr=on|off][,vhost=on|off]\n" 14746a8b4a5bSThomas Huth " [,vhostfd=h][,vhostfds=x:y:...:z][,vhostforce=on|off][,queues=n]\n" 14756a8b4a5bSThomas Huth " configure a host TAP network backend with ID 'str'\n" 1476a7c36ee4SCorey Bryant " use network scripts 'file' (default=" DEFAULT_NETWORK_SCRIPT ")\n" 1477a7c36ee4SCorey Bryant " to configure it and 'dfile' (default=" DEFAULT_NETWORK_DOWN_SCRIPT ")\n" 1478a7c36ee4SCorey Bryant " to deconfigure it\n" 1479ca1a8a06SBruce Rogers " use '[down]script=no' to disable script execution\n" 1480a7c36ee4SCorey Bryant " use network helper 'helper' (default=" DEFAULT_BRIDGE_HELPER ") to\n" 1481a7c36ee4SCorey Bryant " configure it\n" 14825824d651Sblueswir1 " use 'fd=h' to connect to an already opened TAP interface\n" 14832ca81baaSJason Wang " use 'fds=x:y:...:z' to connect to already opened multiqueue capable TAP interfaces\n" 1484ca1a8a06SBruce Rogers " use 'sndbuf=nbytes' to limit the size of the send buffer (the\n" 1485f157ed20SMichael S. Tsirkin " default is disabled 'sndbuf=0' to enable flow control set 'sndbuf=1048576')\n" 1486ca1a8a06SBruce Rogers " use vnet_hdr=off to avoid enabling the IFF_VNET_HDR tap flag\n" 1487ca1a8a06SBruce Rogers " use vnet_hdr=on to make the lack of IFF_VNET_HDR support an error condition\n" 148882b0d80eSMichael S. Tsirkin " use vhost=on to enable experimental in kernel accelerator\n" 14895430a28fSmst@redhat.com " (only has effect for virtio guests which use MSIX)\n" 14905430a28fSmst@redhat.com " use vhostforce=on to force vhost on for non-MSIX virtio guests\n" 149182b0d80eSMichael S. Tsirkin " use 'vhostfd=h' to connect to an already opened vhost net device\n" 14922ca81baaSJason Wang " use 'vhostfds=x:y:...:z to connect to multiple already opened vhost net devices\n" 1493ec396014SJason Wang " use 'queues=n' to specify the number of queues to be created for multiqueue TAP\n" 14946a8b4a5bSThomas Huth "-netdev bridge,id=str[,br=bridge][,helper=helper]\n" 14956a8b4a5bSThomas Huth " configure a host TAP network backend with ID 'str' that is\n" 14966a8b4a5bSThomas Huth " connected to a bridge (default=" DEFAULT_BRIDGE_INTERFACE ")\n" 14976a8b4a5bSThomas Huth " using the program 'helper (default=" DEFAULT_BRIDGE_HELPER ")\n" 14980df0ff6dSMark McLoughlin#endif 14993fb69aa1SAnton Ivanov#ifdef __linux__ 15006a8b4a5bSThomas Huth "-netdev l2tpv3,id=str,src=srcaddr,dst=dstaddr[,srcport=srcport][,dstport=dstport]\n" 15016a8b4a5bSThomas Huth " [,rxsession=rxsession],txsession=txsession[,ipv6=on/off][,udp=on/off]\n" 15026a8b4a5bSThomas Huth " [,cookie64=on/off][,counter][,pincounter][,txcookie=txcookie]\n" 15036a8b4a5bSThomas Huth " [,rxcookie=rxcookie][,offset=offset]\n" 15046a8b4a5bSThomas Huth " configure a network backend with ID 'str' connected to\n" 15056a8b4a5bSThomas Huth " an Ethernet over L2TPv3 pseudowire.\n" 15063fb69aa1SAnton Ivanov " Linux kernel 3.3+ as well as most routers can talk\n" 15072f47b403SMichael Tokarev " L2TPv3. This transport allows connecting a VM to a VM,\n" 15083fb69aa1SAnton Ivanov " VM to a router and even VM to Host. It is a nearly-universal\n" 15093fb69aa1SAnton Ivanov " standard (RFC3391). Note - this implementation uses static\n" 15103fb69aa1SAnton Ivanov " pre-configured tunnels (same as the Linux kernel).\n" 15113fb69aa1SAnton Ivanov " use 'src=' to specify source address\n" 15123fb69aa1SAnton Ivanov " use 'dst=' to specify destination address\n" 15133fb69aa1SAnton Ivanov " use 'udp=on' to specify udp encapsulation\n" 15143952651aSGonglei " use 'srcport=' to specify source udp port\n" 15153fb69aa1SAnton Ivanov " use 'dstport=' to specify destination udp port\n" 15163fb69aa1SAnton Ivanov " use 'ipv6=on' to force v6\n" 15173fb69aa1SAnton Ivanov " L2TPv3 uses cookies to prevent misconfiguration as\n" 15183fb69aa1SAnton Ivanov " well as a weak security measure\n" 15193fb69aa1SAnton Ivanov " use 'rxcookie=0x012345678' to specify a rxcookie\n" 15203fb69aa1SAnton Ivanov " use 'txcookie=0x012345678' to specify a txcookie\n" 15213fb69aa1SAnton Ivanov " use 'cookie64=on' to set cookie size to 64 bit, otherwise 32\n" 15223fb69aa1SAnton Ivanov " use 'counter=off' to force a 'cut-down' L2TPv3 with no counter\n" 15233fb69aa1SAnton Ivanov " use 'pincounter=on' to work around broken counter handling in peer\n" 15243fb69aa1SAnton Ivanov " use 'offset=X' to add an extra offset between header and data\n" 15253fb69aa1SAnton Ivanov#endif 15266a8b4a5bSThomas Huth "-netdev socket,id=str[,fd=h][,listen=[host]:port][,connect=host:port]\n" 15276a8b4a5bSThomas Huth " configure a network backend to connect to another network\n" 15286a8b4a5bSThomas Huth " using a socket connection\n" 15296a8b4a5bSThomas Huth "-netdev socket,id=str[,fd=h][,mcast=maddr:port[,localaddr=addr]]\n" 15306a8b4a5bSThomas Huth " configure a network backend to connect to a multicast maddr and port\n" 15313a75e74cSMike Ryan " use 'localaddr=addr' to specify the host address to send packets from\n" 15326a8b4a5bSThomas Huth "-netdev socket,id=str[,fd=h][,udp=host:port][,localaddr=host:port]\n" 15336a8b4a5bSThomas Huth " configure a network backend to connect to another network\n" 15346a8b4a5bSThomas Huth " using an UDP tunnel\n" 15355824d651Sblueswir1#ifdef CONFIG_VDE 15366a8b4a5bSThomas Huth "-netdev vde,id=str[,sock=socketpath][,port=n][,group=groupname][,mode=octalmode]\n" 15376a8b4a5bSThomas Huth " configure a network backend to connect to port 'n' of a vde switch\n" 15386a8b4a5bSThomas Huth " running on host and listening for incoming connections on 'socketpath'.\n" 15395824d651Sblueswir1 " Use group 'groupname' and mode 'octalmode' to change default\n" 15405824d651Sblueswir1 " ownership and permissions for communication port.\n" 15415824d651Sblueswir1#endif 154258952137SVincenzo Maffione#ifdef CONFIG_NETMAP 15436a8b4a5bSThomas Huth "-netdev netmap,id=str,ifname=name[,devname=nmname]\n" 154458952137SVincenzo Maffione " attach to the existing netmap-enabled network interface 'name', or to a\n" 154558952137SVincenzo Maffione " VALE port (created on the fly) called 'name' ('nmname' is name of the \n" 154658952137SVincenzo Maffione " netmap device, defaults to '/dev/netmap')\n" 154758952137SVincenzo Maffione#endif 15486a8b4a5bSThomas Huth "-netdev vhost-user,id=str,chardev=dev[,vhostforce=on|off]\n" 15496a8b4a5bSThomas Huth " configure a vhost-user network, backed by a chardev 'dev'\n" 15506a8b4a5bSThomas Huth "-netdev hubport,id=str,hubid=n\n" 15516a8b4a5bSThomas Huth " configure a hub port on QEMU VLAN 'n'\n", QEMU_ARCH_ALL) 15526a8b4a5bSThomas HuthDEF("net", HAS_ARG, QEMU_OPTION_net, 15536a8b4a5bSThomas Huth "-net nic[,vlan=n][,macaddr=mac][,model=type][,name=str][,addr=str][,vectors=v]\n" 15546a8b4a5bSThomas Huth " old way to create a new NIC and connect it to VLAN 'n'\n" 15556a8b4a5bSThomas Huth " (use the '-device devtype,netdev=str' option if possible instead)\n" 1556bb9ea79eSaliguori "-net dump[,vlan=n][,file=f][,len=n]\n" 1557bb9ea79eSaliguori " dump traffic on vlan 'n' to file 'f' (max n bytes per packet)\n" 1558ca1a8a06SBruce Rogers "-net none use it alone to have zero network devices. If no -net option\n" 15596a8b4a5bSThomas Huth " is provided, the default is '-net nic -net user'\n" 15606a8b4a5bSThomas Huth "-net [" 1561a1ea458fSMark McLoughlin#ifdef CONFIG_SLIRP 1562a1ea458fSMark McLoughlin "user|" 1563a1ea458fSMark McLoughlin#endif 1564a1ea458fSMark McLoughlin "tap|" 1565a7c36ee4SCorey Bryant "bridge|" 1566a1ea458fSMark McLoughlin#ifdef CONFIG_VDE 1567a1ea458fSMark McLoughlin "vde|" 1568a1ea458fSMark McLoughlin#endif 156958952137SVincenzo Maffione#ifdef CONFIG_NETMAP 157058952137SVincenzo Maffione "netmap|" 157158952137SVincenzo Maffione#endif 15726a8b4a5bSThomas Huth "socket][,vlan=n][,option][,option][,...]\n" 15736a8b4a5bSThomas Huth " old way to initialize a host network interface\n" 15746a8b4a5bSThomas Huth " (use the -netdev option if possible instead)\n", QEMU_ARCH_ALL) 15755824d651Sblueswir1STEXI 1576ffe6370cSMichael S. Tsirkin@item -net nic[,vlan=@var{n}][,macaddr=@var{mac}][,model=@var{type}] [,name=@var{name}][,addr=@var{addr}][,vectors=@var{v}] 15776616b2adSStefan Weil@findex -net 15785824d651Sblueswir1Create a new Network Interface Card and connect it to VLAN @var{n} (@var{n} 15790d6b0b1dSAnthony Liguori= 0 is the default). The NIC is an e1000 by default on the PC 15805607c388SMarkus Armbrustertarget. Optionally, the MAC address can be changed to @var{mac}, the 15815607c388SMarkus Armbrusterdevice address set to @var{addr} (PCI cards only), 1582ffe6370cSMichael S. Tsirkinand a @var{name} can be assigned for use in monitor commands. 1583ffe6370cSMichael S. TsirkinOptionally, for PCI cards, you can specify the number @var{v} of MSI-X vectors 1584ffe6370cSMichael S. Tsirkinthat the card should have; this option currently only affects virtio cards; set 1585ffe6370cSMichael S. Tsirkin@var{v} = 0 to disable MSI-X. If no @option{-net} option is specified, a single 1586071c9394SStefan WeilNIC is created. QEMU can emulate several different models of network card. 15875824d651Sblueswir1Valid values for @var{type} are 1588ffe6370cSMichael S. Tsirkin@code{virtio}, @code{i82551}, @code{i82557b}, @code{i82559er}, 15895824d651Sblueswir1@code{ne2k_pci}, @code{ne2k_isa}, @code{pcnet}, @code{rtl8139}, 15905824d651Sblueswir1@code{e1000}, @code{smc91c111}, @code{lance} and @code{mcf_fec}. 1591585f6036SPeter MaydellNot all devices are supported on all targets. Use @code{-net nic,model=help} 15925824d651Sblueswir1for a list of available devices for your target. 15935824d651Sblueswir1 159408d12022SStefan Hajnoczi@item -netdev user,id=@var{id}[,@var{option}][,@var{option}][,...] 1595b8f490ebSMarkus Armbruster@findex -netdev 1596ad196a9dSJan Kiszka@item -net user[,@var{option}][,@var{option}][,...] 15975824d651Sblueswir1Use the user mode network stack which requires no administrator 1598ad196a9dSJan Kiszkaprivilege to run. Valid options are: 15995824d651Sblueswir1 1600b3f046c2SKevin Wolf@table @option 1601ad196a9dSJan Kiszka@item vlan=@var{n} 1602ad196a9dSJan KiszkaConnect user mode stack to VLAN @var{n} (@var{n} = 0 is the default). 1603ad196a9dSJan Kiszka 160408d12022SStefan Hajnoczi@item id=@var{id} 1605ad196a9dSJan Kiszka@item name=@var{name} 1606ad196a9dSJan KiszkaAssign symbolic name for use in monitor commands. 1607ad196a9dSJan Kiszka 1608c92ef6a2SJan Kiszka@item net=@var{addr}[/@var{mask}] 1609c92ef6a2SJan KiszkaSet IP network address the guest will see. Optionally specify the netmask, 1610c92ef6a2SJan Kiszkaeither in the form a.b.c.d or as number of valid top-most bits. Default is 1611b0b36e5dSBrad Hards10.0.2.0/24. 1612c92ef6a2SJan Kiszka 1613c92ef6a2SJan Kiszka@item host=@var{addr} 1614c92ef6a2SJan KiszkaSpecify the guest-visible address of the host. Default is the 2nd IP in the 1615c92ef6a2SJan Kiszkaguest network, i.e. x.x.x.2. 1616ad196a9dSJan Kiszka 1617c54ed5bcSJan Kiszka@item restrict=on|off 1618caef55edSBrad HardsIf this option is enabled, the guest will be isolated, i.e. it will not be 1619ad196a9dSJan Kiszkaable to contact the host and no guest IP packets will be routed over the host 1620caef55edSBrad Hardsto the outside. This option does not affect any explicitly set forwarding rules. 1621ad196a9dSJan Kiszka 1622ad196a9dSJan Kiszka@item hostname=@var{name} 162363d2960bSKlaus StengelSpecifies the client hostname reported by the built-in DHCP server. 1624ad196a9dSJan Kiszka 1625c92ef6a2SJan Kiszka@item dhcpstart=@var{addr} 1626c92ef6a2SJan KiszkaSpecify the first of the 16 IPs the built-in DHCP server can assign. Default 1627b0b36e5dSBrad Hardsis the 15th to 31st IP in the guest network, i.e. x.x.x.15 to x.x.x.31. 1628c92ef6a2SJan Kiszka 1629c92ef6a2SJan Kiszka@item dns=@var{addr} 1630c92ef6a2SJan KiszkaSpecify the guest-visible address of the virtual nameserver. The address must 1631c92ef6a2SJan Kiszkabe different from the host address. Default is the 3rd IP in the guest network, 1632c92ef6a2SJan Kiszkai.e. x.x.x.3. 1633c92ef6a2SJan Kiszka 163463d2960bSKlaus Stengel@item dnssearch=@var{domain} 163563d2960bSKlaus StengelProvides an entry for the domain-search list sent by the built-in 163663d2960bSKlaus StengelDHCP server. More than one domain suffix can be transmitted by specifying 163763d2960bSKlaus Stengelthis option multiple times. If supported, this will cause the guest to 163863d2960bSKlaus Stengelautomatically try to append the given domain suffix(es) in case a domain name 163963d2960bSKlaus Stengelcan not be resolved. 164063d2960bSKlaus Stengel 164163d2960bSKlaus StengelExample: 164263d2960bSKlaus Stengel@example 164363d2960bSKlaus Stengelqemu -net user,dnssearch=mgmt.example.org,dnssearch=example.org [...] 164463d2960bSKlaus Stengel@end example 164563d2960bSKlaus Stengel 1646ad196a9dSJan Kiszka@item tftp=@var{dir} 1647ad196a9dSJan KiszkaWhen using the user mode network stack, activate a built-in TFTP 1648ad196a9dSJan Kiszkaserver. The files in @var{dir} will be exposed as the root of a TFTP server. 1649ad196a9dSJan KiszkaThe TFTP client on the guest must be configured in binary mode (use the command 1650c92ef6a2SJan Kiszka@code{bin} of the Unix TFTP client). 1651ad196a9dSJan Kiszka 1652ad196a9dSJan Kiszka@item bootfile=@var{file} 1653ad196a9dSJan KiszkaWhen using the user mode network stack, broadcast @var{file} as the BOOTP 1654ad196a9dSJan Kiszkafilename. In conjunction with @option{tftp}, this can be used to network boot 1655ad196a9dSJan Kiszkaa guest from a local directory. 1656ad196a9dSJan Kiszka 1657ad196a9dSJan KiszkaExample (using pxelinux): 1658ad196a9dSJan Kiszka@example 16593804da9dSStefan Weilqemu-system-i386 -hda linux.img -boot n -net user,tftp=/path/to/tftp/files,bootfile=/pxelinux.0 1660ad196a9dSJan Kiszka@end example 1661ad196a9dSJan Kiszka 1662c92ef6a2SJan Kiszka@item smb=@var{dir}[,smbserver=@var{addr}] 1663ad196a9dSJan KiszkaWhen using the user mode network stack, activate a built-in SMB 1664ad196a9dSJan Kiszkaserver so that Windows OSes can access to the host files in @file{@var{dir}} 1665c92ef6a2SJan Kiszkatransparently. The IP address of the SMB server can be set to @var{addr}. By 1666c92ef6a2SJan Kiszkadefault the 4th IP in the guest network is used, i.e. x.x.x.4. 1667ad196a9dSJan Kiszka 1668ad196a9dSJan KiszkaIn the guest Windows OS, the line: 1669ad196a9dSJan Kiszka@example 1670ad196a9dSJan Kiszka10.0.2.4 smbserver 1671ad196a9dSJan Kiszka@end example 1672ad196a9dSJan Kiszkamust be added in the file @file{C:\WINDOWS\LMHOSTS} (for windows 9x/Me) 1673ad196a9dSJan Kiszkaor @file{C:\WINNT\SYSTEM32\DRIVERS\ETC\LMHOSTS} (Windows NT/2000). 1674ad196a9dSJan Kiszka 1675ad196a9dSJan KiszkaThen @file{@var{dir}} can be accessed in @file{\\smbserver\qemu}. 1676ad196a9dSJan Kiszka 1677e2d8830eSBradNote that a SAMBA server must be installed on the host OS. 1678e2d8830eSBradQEMU was tested successfully with smbd versions from Red Hat 9, 1679e2d8830eSBradFedora Core 3 and OpenSUSE 11.x. 1680ad196a9dSJan Kiszka 16813c6a0580SJan Kiszka@item hostfwd=[tcp|udp]:[@var{hostaddr}]:@var{hostport}-[@var{guestaddr}]:@var{guestport} 1682c92ef6a2SJan KiszkaRedirect incoming TCP or UDP connections to the host port @var{hostport} to 1683c92ef6a2SJan Kiszkathe guest IP address @var{guestaddr} on guest port @var{guestport}. If 1684c92ef6a2SJan Kiszka@var{guestaddr} is not specified, its value is x.x.x.15 (default first address 16853c6a0580SJan Kiszkagiven by the built-in DHCP server). By specifying @var{hostaddr}, the rule can 16863c6a0580SJan Kiszkabe bound to a specific host interface. If no connection type is set, TCP is 1687c92ef6a2SJan Kiszkaused. This option can be given multiple times. 1688ad196a9dSJan Kiszka 1689ad196a9dSJan KiszkaFor example, to redirect host X11 connection from screen 1 to guest 1690ad196a9dSJan Kiszkascreen 0, use the following: 1691ad196a9dSJan Kiszka 1692ad196a9dSJan Kiszka@example 1693ad196a9dSJan Kiszka# on the host 16943804da9dSStefan Weilqemu-system-i386 -net user,hostfwd=tcp:127.0.0.1:6001-:6000 [...] 1695ad196a9dSJan Kiszka# this host xterm should open in the guest X11 server 1696ad196a9dSJan Kiszkaxterm -display :1 1697ad196a9dSJan Kiszka@end example 1698ad196a9dSJan Kiszka 1699ad196a9dSJan KiszkaTo redirect telnet connections from host port 5555 to telnet port on 1700ad196a9dSJan Kiszkathe guest, use the following: 1701ad196a9dSJan Kiszka 1702ad196a9dSJan Kiszka@example 1703ad196a9dSJan Kiszka# on the host 17043804da9dSStefan Weilqemu-system-i386 -net user,hostfwd=tcp::5555-:23 [...] 1705ad196a9dSJan Kiszkatelnet localhost 5555 1706ad196a9dSJan Kiszka@end example 1707ad196a9dSJan Kiszka 1708ad196a9dSJan KiszkaThen when you use on the host @code{telnet localhost 5555}, you 1709ad196a9dSJan Kiszkaconnect to the guest telnet server. 1710ad196a9dSJan Kiszka 1711c92ef6a2SJan Kiszka@item guestfwd=[tcp]:@var{server}:@var{port}-@var{dev} 1712b412eb61SAlexander Graf@item guestfwd=[tcp]:@var{server}:@var{port}-@var{cmd:command} 17133c6a0580SJan KiszkaForward guest TCP connections to the IP address @var{server} on port @var{port} 1714b412eb61SAlexander Grafto the character device @var{dev} or to a program executed by @var{cmd:command} 1715b412eb61SAlexander Grafwhich gets spawned for each connection. This option can be given multiple times. 1716b412eb61SAlexander Graf 171743ffe61fSStefan WeilYou can either use a chardev directly and have that one used throughout QEMU's 1718b412eb61SAlexander Graflifetime, like in the following example: 1719b412eb61SAlexander Graf 1720b412eb61SAlexander Graf@example 1721b412eb61SAlexander Graf# open 10.10.1.1:4321 on bootup, connect 10.0.2.100:1234 to it whenever 1722b412eb61SAlexander Graf# the guest accesses it 1723b412eb61SAlexander Grafqemu -net user,guestfwd=tcp:10.0.2.100:1234-tcp:10.10.1.1:4321 [...] 1724b412eb61SAlexander Graf@end example 1725b412eb61SAlexander Graf 1726b412eb61SAlexander GrafOr you can execute a command on every TCP connection established by the guest, 172743ffe61fSStefan Weilso that QEMU behaves similar to an inetd process for that virtual server: 1728b412eb61SAlexander Graf 1729b412eb61SAlexander Graf@example 1730b412eb61SAlexander Graf# call "netcat 10.10.1.1 4321" on every TCP connection to 10.0.2.100:1234 1731b412eb61SAlexander Graf# and connect the TCP stream to its stdin/stdout 1732b412eb61SAlexander Grafqemu -net 'user,guestfwd=tcp:10.0.2.100:1234-cmd:netcat 10.10.1.1 4321' 1733b412eb61SAlexander Graf@end example 1734ad196a9dSJan Kiszka 1735ad196a9dSJan Kiszka@end table 1736ad196a9dSJan Kiszka 1737ad196a9dSJan KiszkaNote: Legacy stand-alone options -tftp, -bootp, -smb and -redir are still 1738ad196a9dSJan Kiszkaprocessed and applied to -net user. Mixing them with the new configuration 1739ad196a9dSJan Kiszkasyntax gives undefined results. Their use for new applications is discouraged 1740ad196a9dSJan Kiszkaas they will be removed from future versions. 17415824d651Sblueswir1 174208d12022SStefan Hajnoczi@item -netdev tap,id=@var{id}[,fd=@var{h}][,ifname=@var{name}][,script=@var{file}][,downscript=@var{dfile}][,helper=@var{helper}] 1743a7c36ee4SCorey 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}] 1744a7c36ee4SCorey BryantConnect the host TAP network interface @var{name} to VLAN @var{n}. 1745a7c36ee4SCorey Bryant 1746a7c36ee4SCorey BryantUse the network script @var{file} to configure it and the network script 17475824d651Sblueswir1@var{dfile} to deconfigure it. If @var{name} is not provided, the OS 1748a7c36ee4SCorey Bryantautomatically provides one. The default network configure script is 1749a7c36ee4SCorey Bryant@file{/etc/qemu-ifup} and the default network deconfigure script is 1750a7c36ee4SCorey Bryant@file{/etc/qemu-ifdown}. Use @option{script=no} or @option{downscript=no} 1751a7c36ee4SCorey Bryantto disable script execution. 1752a7c36ee4SCorey Bryant 1753a7c36ee4SCorey BryantIf running QEMU as an unprivileged user, use the network helper 1754a7c36ee4SCorey Bryant@var{helper} to configure the TAP interface. The default network 1755420508fbSAmos Konghelper executable is @file{/path/to/qemu-bridge-helper}. 1756a7c36ee4SCorey Bryant 1757a7c36ee4SCorey Bryant@option{fd}=@var{h} can be used to specify the handle of an already 1758a7c36ee4SCorey Bryantopened host TAP interface. 1759a7c36ee4SCorey Bryant 1760a7c36ee4SCorey BryantExamples: 17615824d651Sblueswir1 17625824d651Sblueswir1@example 1763a7c36ee4SCorey Bryant#launch a QEMU instance with the default network script 17643804da9dSStefan Weilqemu-system-i386 linux.img -net nic -net tap 17655824d651Sblueswir1@end example 17665824d651Sblueswir1 17675824d651Sblueswir1@example 1768a7c36ee4SCorey Bryant#launch a QEMU instance with two NICs, each one connected 1769a7c36ee4SCorey Bryant#to a TAP device 17703804da9dSStefan Weilqemu-system-i386 linux.img \ 17713804da9dSStefan Weil -net nic,vlan=0 -net tap,vlan=0,ifname=tap0 \ 17725824d651Sblueswir1 -net nic,vlan=1 -net tap,vlan=1,ifname=tap1 17735824d651Sblueswir1@end example 17745824d651Sblueswir1 1775a7c36ee4SCorey Bryant@example 1776a7c36ee4SCorey Bryant#launch a QEMU instance with the default network helper to 1777a7c36ee4SCorey Bryant#connect a TAP device to bridge br0 17783804da9dSStefan Weilqemu-system-i386 linux.img \ 1779420508fbSAmos Kong -net nic -net tap,"helper=/path/to/qemu-bridge-helper" 1780a7c36ee4SCorey Bryant@end example 1781a7c36ee4SCorey Bryant 178208d12022SStefan Hajnoczi@item -netdev bridge,id=@var{id}[,br=@var{bridge}][,helper=@var{helper}] 1783a7c36ee4SCorey Bryant@item -net bridge[,vlan=@var{n}][,name=@var{name}][,br=@var{bridge}][,helper=@var{helper}] 1784a7c36ee4SCorey BryantConnect a host TAP network interface to a host bridge device. 1785a7c36ee4SCorey Bryant 1786a7c36ee4SCorey BryantUse the network helper @var{helper} to configure the TAP interface and 1787a7c36ee4SCorey Bryantattach it to the bridge. The default network helper executable is 1788420508fbSAmos Kong@file{/path/to/qemu-bridge-helper} and the default bridge 1789a7c36ee4SCorey Bryantdevice is @file{br0}. 1790a7c36ee4SCorey Bryant 1791a7c36ee4SCorey BryantExamples: 1792a7c36ee4SCorey Bryant 1793a7c36ee4SCorey Bryant@example 1794a7c36ee4SCorey Bryant#launch a QEMU instance with the default network helper to 1795a7c36ee4SCorey Bryant#connect a TAP device to bridge br0 17963804da9dSStefan Weilqemu-system-i386 linux.img -net bridge -net nic,model=virtio 1797a7c36ee4SCorey Bryant@end example 1798a7c36ee4SCorey Bryant 1799a7c36ee4SCorey Bryant@example 1800a7c36ee4SCorey Bryant#launch a QEMU instance with the default network helper to 1801a7c36ee4SCorey Bryant#connect a TAP device to bridge qemubr0 18023804da9dSStefan Weilqemu-system-i386 linux.img -net bridge,br=qemubr0 -net nic,model=virtio 1803a7c36ee4SCorey Bryant@end example 1804a7c36ee4SCorey Bryant 180508d12022SStefan Hajnoczi@item -netdev socket,id=@var{id}[,fd=@var{h}][,listen=[@var{host}]:@var{port}][,connect=@var{host}:@var{port}] 18065824d651Sblueswir1@item -net socket[,vlan=@var{n}][,name=@var{name}][,fd=@var{h}] [,listen=[@var{host}]:@var{port}][,connect=@var{host}:@var{port}] 18075824d651Sblueswir1 18085824d651Sblueswir1Connect the VLAN @var{n} to a remote VLAN in another QEMU virtual 18095824d651Sblueswir1machine using a TCP socket connection. If @option{listen} is 18105824d651Sblueswir1specified, QEMU waits for incoming connections on @var{port} 18115824d651Sblueswir1(@var{host} is optional). @option{connect} is used to connect to 18125824d651Sblueswir1another QEMU instance using the @option{listen} option. @option{fd}=@var{h} 18135824d651Sblueswir1specifies an already opened TCP socket. 18145824d651Sblueswir1 18155824d651Sblueswir1Example: 18165824d651Sblueswir1@example 18175824d651Sblueswir1# launch a first QEMU instance 18183804da9dSStefan Weilqemu-system-i386 linux.img \ 18193804da9dSStefan Weil -net nic,macaddr=52:54:00:12:34:56 \ 18205824d651Sblueswir1 -net socket,listen=:1234 18215824d651Sblueswir1# connect the VLAN 0 of this instance to the VLAN 0 18225824d651Sblueswir1# of the first instance 18233804da9dSStefan Weilqemu-system-i386 linux.img \ 18243804da9dSStefan Weil -net nic,macaddr=52:54:00:12:34:57 \ 18255824d651Sblueswir1 -net socket,connect=127.0.0.1:1234 18265824d651Sblueswir1@end example 18275824d651Sblueswir1 182808d12022SStefan Hajnoczi@item -netdev socket,id=@var{id}[,fd=@var{h}][,mcast=@var{maddr}:@var{port}[,localaddr=@var{addr}]] 18293a75e74cSMike Ryan@item -net socket[,vlan=@var{n}][,name=@var{name}][,fd=@var{h}][,mcast=@var{maddr}:@var{port}[,localaddr=@var{addr}]] 18305824d651Sblueswir1 18315824d651Sblueswir1Create a VLAN @var{n} shared with another QEMU virtual 18325824d651Sblueswir1machines using a UDP multicast socket, effectively making a bus for 18335824d651Sblueswir1every QEMU with same multicast address @var{maddr} and @var{port}. 18345824d651Sblueswir1NOTES: 18355824d651Sblueswir1@enumerate 18365824d651Sblueswir1@item 18375824d651Sblueswir1Several QEMU can be running on different hosts and share same bus (assuming 18385824d651Sblueswir1correct multicast setup for these hosts). 18395824d651Sblueswir1@item 18405824d651Sblueswir1mcast support is compatible with User Mode Linux (argument @option{eth@var{N}=mcast}), see 18415824d651Sblueswir1@url{http://user-mode-linux.sf.net}. 18425824d651Sblueswir1@item 18435824d651Sblueswir1Use @option{fd=h} to specify an already opened UDP multicast socket. 18445824d651Sblueswir1@end enumerate 18455824d651Sblueswir1 18465824d651Sblueswir1Example: 18475824d651Sblueswir1@example 18485824d651Sblueswir1# launch one QEMU instance 18493804da9dSStefan Weilqemu-system-i386 linux.img \ 18503804da9dSStefan Weil -net nic,macaddr=52:54:00:12:34:56 \ 18515824d651Sblueswir1 -net socket,mcast=230.0.0.1:1234 18525824d651Sblueswir1# launch another QEMU instance on same "bus" 18533804da9dSStefan Weilqemu-system-i386 linux.img \ 18543804da9dSStefan Weil -net nic,macaddr=52:54:00:12:34:57 \ 18555824d651Sblueswir1 -net socket,mcast=230.0.0.1:1234 18565824d651Sblueswir1# launch yet another QEMU instance on same "bus" 18573804da9dSStefan Weilqemu-system-i386 linux.img \ 18583804da9dSStefan Weil -net nic,macaddr=52:54:00:12:34:58 \ 18595824d651Sblueswir1 -net socket,mcast=230.0.0.1:1234 18605824d651Sblueswir1@end example 18615824d651Sblueswir1 18625824d651Sblueswir1Example (User Mode Linux compat.): 18635824d651Sblueswir1@example 18645824d651Sblueswir1# launch QEMU instance (note mcast address selected 18655824d651Sblueswir1# is UML's default) 18663804da9dSStefan Weilqemu-system-i386 linux.img \ 18673804da9dSStefan Weil -net nic,macaddr=52:54:00:12:34:56 \ 18685824d651Sblueswir1 -net socket,mcast=239.192.168.1:1102 18695824d651Sblueswir1# launch UML 18705824d651Sblueswir1/path/to/linux ubd0=/path/to/root_fs eth0=mcast 18715824d651Sblueswir1@end example 18725824d651Sblueswir1 18733a75e74cSMike RyanExample (send packets from host's 1.2.3.4): 18743a75e74cSMike Ryan@example 18753804da9dSStefan Weilqemu-system-i386 linux.img \ 18763804da9dSStefan Weil -net nic,macaddr=52:54:00:12:34:56 \ 18773a75e74cSMike Ryan -net socket,mcast=239.192.168.1:1102,localaddr=1.2.3.4 18783a75e74cSMike Ryan@end example 18793a75e74cSMike Ryan 18803fb69aa1SAnton Ivanov@item -netdev l2tpv3,id=@var{id},src=@var{srcaddr},dst=@var{dstaddr}[,srcport=@var{srcport}][,dstport=@var{dstport}],txsession=@var{txsession}[,rxsession=@var{rxsession}][,ipv6][,udp][,cookie64][,counter][,pincounter][,txcookie=@var{txcookie}][,rxcookie=@var{rxcookie}][,offset=@var{offset}] 18813fb69aa1SAnton Ivanov@item -net l2tpv3[,vlan=@var{n}][,name=@var{name}],src=@var{srcaddr},dst=@var{dstaddr}[,srcport=@var{srcport}][,dstport=@var{dstport}],txsession=@var{txsession}[,rxsession=@var{rxsession}][,ipv6][,udp][,cookie64][,counter][,pincounter][,txcookie=@var{txcookie}][,rxcookie=@var{rxcookie}][,offset=@var{offset}] 18823fb69aa1SAnton IvanovConnect VLAN @var{n} to L2TPv3 pseudowire. L2TPv3 (RFC3391) is a popular 18833fb69aa1SAnton Ivanovprotocol to transport Ethernet (and other Layer 2) data frames between 18843fb69aa1SAnton Ivanovtwo systems. It is present in routers, firewalls and the Linux kernel 18853fb69aa1SAnton Ivanov(from version 3.3 onwards). 18863fb69aa1SAnton Ivanov 18873fb69aa1SAnton IvanovThis transport allows a VM to communicate to another VM, router or firewall directly. 18883fb69aa1SAnton Ivanov 18893fb69aa1SAnton Ivanov@item src=@var{srcaddr} 18903fb69aa1SAnton Ivanov source address (mandatory) 18913fb69aa1SAnton Ivanov@item dst=@var{dstaddr} 18923fb69aa1SAnton Ivanov destination address (mandatory) 18933fb69aa1SAnton Ivanov@item udp 18943fb69aa1SAnton Ivanov select udp encapsulation (default is ip). 18953fb69aa1SAnton Ivanov@item srcport=@var{srcport} 18963fb69aa1SAnton Ivanov source udp port. 18973fb69aa1SAnton Ivanov@item dstport=@var{dstport} 18983fb69aa1SAnton Ivanov destination udp port. 18993fb69aa1SAnton Ivanov@item ipv6 19003fb69aa1SAnton Ivanov force v6, otherwise defaults to v4. 19013fb69aa1SAnton Ivanov@item rxcookie=@var{rxcookie} 19023fb69aa1SAnton Ivanov@item txcookie=@var{txcookie} 19033fb69aa1SAnton Ivanov Cookies are a weak form of security in the l2tpv3 specification. 19043fb69aa1SAnton IvanovTheir function is mostly to prevent misconfiguration. By default they are 32 19053fb69aa1SAnton Ivanovbit. 19063fb69aa1SAnton Ivanov@item cookie64 19073fb69aa1SAnton Ivanov Set cookie size to 64 bit instead of the default 32 19083fb69aa1SAnton Ivanov@item counter=off 19093fb69aa1SAnton Ivanov Force a 'cut-down' L2TPv3 with no counter as in 19103fb69aa1SAnton Ivanovdraft-mkonstan-l2tpext-keyed-ipv6-tunnel-00 19113fb69aa1SAnton Ivanov@item pincounter=on 19123fb69aa1SAnton Ivanov Work around broken counter handling in peer. This may also help on 19133fb69aa1SAnton Ivanovnetworks which have packet reorder. 19143fb69aa1SAnton Ivanov@item offset=@var{offset} 19153fb69aa1SAnton Ivanov Add an extra offset between header and data 19163fb69aa1SAnton Ivanov 19173fb69aa1SAnton IvanovFor example, to attach a VM running on host 4.3.2.1 via L2TPv3 to the bridge br-lan 19183fb69aa1SAnton Ivanovon the remote Linux host 1.2.3.4: 19193fb69aa1SAnton Ivanov@example 19203fb69aa1SAnton Ivanov# Setup tunnel on linux host using raw ip as encapsulation 19213fb69aa1SAnton Ivanov# on 1.2.3.4 19223fb69aa1SAnton Ivanovip l2tp add tunnel remote 4.3.2.1 local 1.2.3.4 tunnel_id 1 peer_tunnel_id 1 \ 19233fb69aa1SAnton Ivanov encap udp udp_sport 16384 udp_dport 16384 19243fb69aa1SAnton Ivanovip l2tp add session tunnel_id 1 name vmtunnel0 session_id \ 19253fb69aa1SAnton Ivanov 0xFFFFFFFF peer_session_id 0xFFFFFFFF 19263fb69aa1SAnton Ivanovifconfig vmtunnel0 mtu 1500 19273fb69aa1SAnton Ivanovifconfig vmtunnel0 up 19283fb69aa1SAnton Ivanovbrctl addif br-lan vmtunnel0 19293fb69aa1SAnton Ivanov 19303fb69aa1SAnton Ivanov 19313fb69aa1SAnton Ivanov# on 4.3.2.1 19323fb69aa1SAnton Ivanov# launch QEMU instance - if your network has reorder or is very lossy add ,pincounter 19333fb69aa1SAnton Ivanov 19343fb69aa1SAnton Ivanovqemu-system-i386 linux.img -net nic -net l2tpv3,src=4.2.3.1,dst=1.2.3.4,udp,srcport=16384,dstport=16384,rxsession=0xffffffff,txsession=0xffffffff,counter 19353fb69aa1SAnton Ivanov 19363fb69aa1SAnton Ivanov 19373fb69aa1SAnton Ivanov@end example 19383fb69aa1SAnton Ivanov 193908d12022SStefan Hajnoczi@item -netdev vde,id=@var{id}[,sock=@var{socketpath}][,port=@var{n}][,group=@var{groupname}][,mode=@var{octalmode}] 19405824d651Sblueswir1@item -net vde[,vlan=@var{n}][,name=@var{name}][,sock=@var{socketpath}] [,port=@var{n}][,group=@var{groupname}][,mode=@var{octalmode}] 19415824d651Sblueswir1Connect VLAN @var{n} to PORT @var{n} of a vde switch running on host and 19425824d651Sblueswir1listening for incoming connections on @var{socketpath}. Use GROUP @var{groupname} 19435824d651Sblueswir1and MODE @var{octalmode} to change default ownership and permissions for 1944c1ba4e0bSStefan Weilcommunication port. This option is only available if QEMU has been compiled 19455824d651Sblueswir1with vde support enabled. 19465824d651Sblueswir1 19475824d651Sblueswir1Example: 19485824d651Sblueswir1@example 19495824d651Sblueswir1# launch vde switch 19505824d651Sblueswir1vde_switch -F -sock /tmp/myswitch 19515824d651Sblueswir1# launch QEMU instance 19523804da9dSStefan Weilqemu-system-i386 linux.img -net nic -net vde,sock=/tmp/myswitch 19535824d651Sblueswir1@end example 19545824d651Sblueswir1 195540e8c26dSStefan Hajnoczi@item -netdev hubport,id=@var{id},hubid=@var{hubid} 195640e8c26dSStefan Hajnoczi 195740e8c26dSStefan HajnocziCreate a hub port on QEMU "vlan" @var{hubid}. 195840e8c26dSStefan Hajnoczi 195940e8c26dSStefan HajnocziThe hubport netdev lets you connect a NIC to a QEMU "vlan" instead of a single 196040e8c26dSStefan Hajnoczinetdev. @code{-net} and @code{-device} with parameter @option{vlan} create the 196140e8c26dSStefan Hajnoczirequired hub automatically. 196240e8c26dSStefan Hajnoczi 1963830d70dbSOuyang Changchun@item -netdev vhost-user,chardev=@var{id}[,vhostforce=on|off][,queues=n] 196403ce5744SNikolay Nikolaev 196503ce5744SNikolay NikolaevEstablish a vhost-user netdev, backed by a chardev @var{id}. The chardev should 196603ce5744SNikolay Nikolaevbe a unix domain socket backed one. The vhost-user uses a specifically defined 196703ce5744SNikolay Nikolaevprotocol to pass vhost ioctl replacement messages to an application on the other 196803ce5744SNikolay Nikolaevend of the socket. On non-MSIX guests, the feature can be forced with 1969830d70dbSOuyang Changchun@var{vhostforce}. Use 'queues=@var{n}' to specify the number of queues to 1970830d70dbSOuyang Changchunbe created for multiqueue vhost-user. 197103ce5744SNikolay Nikolaev 197203ce5744SNikolay NikolaevExample: 197303ce5744SNikolay Nikolaev@example 197403ce5744SNikolay Nikolaevqemu -m 512 -object memory-backend-file,id=mem,size=512M,mem-path=/hugetlbfs,share=on \ 197503ce5744SNikolay Nikolaev -numa node,memdev=mem \ 197603ce5744SNikolay Nikolaev -chardev socket,path=/path/to/socket \ 197703ce5744SNikolay Nikolaev -netdev type=vhost-user,id=net0,chardev=chr0 \ 197803ce5744SNikolay Nikolaev -device virtio-net-pci,netdev=net0 197903ce5744SNikolay Nikolaev@end example 198003ce5744SNikolay Nikolaev 1981bb9ea79eSaliguori@item -net dump[,vlan=@var{n}][,file=@var{file}][,len=@var{len}] 1982bb9ea79eSaliguoriDump network traffic on VLAN @var{n} to file @var{file} (@file{qemu-vlan0.pcap} by default). 1983bb9ea79eSaliguoriAt most @var{len} bytes (64k by default) per packet are stored. The file format is 1984bb9ea79eSaliguorilibpcap, so it can be analyzed with tools such as tcpdump or Wireshark. 1985bb9ea79eSaliguori 19865824d651Sblueswir1@item -net none 19875824d651Sblueswir1Indicate that no network devices should be configured. It is used to 19885824d651Sblueswir1override the default configuration (@option{-net nic -net user}) which 19895824d651Sblueswir1is activated if no @option{-net} options are provided. 19905824d651Sblueswir1ETEXI 19915824d651Sblueswir1 1992c70a01e4SMarkus ArmbrusterSTEXI 1993c70a01e4SMarkus Armbruster@end table 1994c70a01e4SMarkus ArmbrusterETEXI 19957273a2dbSMatthew BoothDEFHEADING() 19967273a2dbSMatthew Booth 19977273a2dbSMatthew BoothDEFHEADING(Character device options:) 1998c70a01e4SMarkus ArmbrusterSTEXI 1999c70a01e4SMarkus Armbruster 2000c70a01e4SMarkus ArmbrusterThe general form of a character device option is: 2001c70a01e4SMarkus Armbruster@table @option 2002c70a01e4SMarkus ArmbrusterETEXI 20037273a2dbSMatthew Booth 20047273a2dbSMatthew BoothDEF("chardev", HAS_ARG, QEMU_OPTION_chardev, 200597331287SJan Kiszka "-chardev null,id=id[,mux=on|off]\n" 20065dd1f02bSCorey Minyard "-chardev socket,id=id[,host=host],port=port[,to=to][,ipv4][,ipv6][,nodelay][,reconnect=seconds]\n" 20075dd1f02bSCorey Minyard " [,server][,nowait][,telnet][,reconnect=seconds][,mux=on|off] (tcp)\n" 20085dd1f02bSCorey Minyard "-chardev socket,id=id,path=path[,server][,nowait][,telnet][,reconnect=seconds][,mux=on|off] (unix)\n" 20097273a2dbSMatthew Booth "-chardev udp,id=id[,host=host],port=port[,localaddr=localaddr]\n" 201097331287SJan Kiszka " [,localport=localport][,ipv4][,ipv6][,mux=on|off]\n" 201197331287SJan Kiszka "-chardev msmouse,id=id[,mux=on|off]\n" 20127273a2dbSMatthew Booth "-chardev vc,id=id[[,width=width][,height=height]][[,cols=cols][,rows=rows]]\n" 201397331287SJan Kiszka " [,mux=on|off]\n" 20144f57378fSMarkus Armbruster "-chardev ringbuf,id=id[,size=size]\n" 201597331287SJan Kiszka "-chardev file,id=id,path=path[,mux=on|off]\n" 201697331287SJan Kiszka "-chardev pipe,id=id,path=path[,mux=on|off]\n" 20177273a2dbSMatthew Booth#ifdef _WIN32 201897331287SJan Kiszka "-chardev console,id=id[,mux=on|off]\n" 201997331287SJan Kiszka "-chardev serial,id=id,path=path[,mux=on|off]\n" 20207273a2dbSMatthew Booth#else 202197331287SJan Kiszka "-chardev pty,id=id[,mux=on|off]\n" 2022b7fdb3abSAurelien Jarno "-chardev stdio,id=id[,mux=on|off][,signal=on|off]\n" 20237273a2dbSMatthew Booth#endif 20247273a2dbSMatthew Booth#ifdef CONFIG_BRLAPI 202597331287SJan Kiszka "-chardev braille,id=id[,mux=on|off]\n" 20267273a2dbSMatthew Booth#endif 20277273a2dbSMatthew Booth#if defined(__linux__) || defined(__sun__) || defined(__FreeBSD__) \ 20287273a2dbSMatthew Booth || defined(__NetBSD__) || defined(__OpenBSD__) || defined(__DragonFly__) 2029d59044efSGerd Hoffmann "-chardev serial,id=id,path=path[,mux=on|off]\n" 203097331287SJan Kiszka "-chardev tty,id=id,path=path[,mux=on|off]\n" 20317273a2dbSMatthew Booth#endif 20327273a2dbSMatthew Booth#if defined(__linux__) || defined(__FreeBSD__) || defined(__DragonFly__) 203388a946d3SGerd Hoffmann "-chardev parallel,id=id,path=path[,mux=on|off]\n" 203497331287SJan Kiszka "-chardev parport,id=id,path=path[,mux=on|off]\n" 20357273a2dbSMatthew Booth#endif 2036cbcc6336SAlon Levy#if defined(CONFIG_SPICE) 2037cbcc6336SAlon Levy "-chardev spicevmc,id=id,name=name[,debug=debug]\n" 20385a49d3e9SMarc-André Lureau "-chardev spiceport,id=id,name=name[,debug=debug]\n" 2039cbcc6336SAlon Levy#endif 2040ad96090aSBlue Swirl , QEMU_ARCH_ALL 20417273a2dbSMatthew Booth) 20427273a2dbSMatthew Booth 20437273a2dbSMatthew BoothSTEXI 204497331287SJan Kiszka@item -chardev @var{backend} ,id=@var{id} [,mux=on|off] [,@var{options}] 20456616b2adSStefan Weil@findex -chardev 20467273a2dbSMatthew BoothBackend is one of: 20477273a2dbSMatthew Booth@option{null}, 20487273a2dbSMatthew Booth@option{socket}, 20497273a2dbSMatthew Booth@option{udp}, 20507273a2dbSMatthew Booth@option{msmouse}, 20517273a2dbSMatthew Booth@option{vc}, 20524f57378fSMarkus Armbruster@option{ringbuf}, 20537273a2dbSMatthew Booth@option{file}, 20547273a2dbSMatthew Booth@option{pipe}, 20557273a2dbSMatthew Booth@option{console}, 20567273a2dbSMatthew Booth@option{serial}, 20577273a2dbSMatthew Booth@option{pty}, 20587273a2dbSMatthew Booth@option{stdio}, 20597273a2dbSMatthew Booth@option{braille}, 20607273a2dbSMatthew Booth@option{tty}, 206188a946d3SGerd Hoffmann@option{parallel}, 2062cbcc6336SAlon Levy@option{parport}, 2063cbcc6336SAlon Levy@option{spicevmc}. 20645a49d3e9SMarc-André Lureau@option{spiceport}. 20657273a2dbSMatthew BoothThe specific backend will determine the applicable options. 20667273a2dbSMatthew Booth 20677273a2dbSMatthew BoothAll devices must have an id, which can be any string up to 127 characters long. 20687273a2dbSMatthew BoothIt is used to uniquely identify this device in other command line directives. 20697273a2dbSMatthew Booth 207097331287SJan KiszkaA character device may be used in multiplexing mode by multiple front-ends. 207197331287SJan KiszkaThe key sequence of @key{Control-a} and @key{c} will rotate the input focus 207297331287SJan Kiszkabetween attached front-ends. Specify @option{mux=on} to enable this mode. 207397331287SJan Kiszka 20747273a2dbSMatthew BoothOptions to each backend are described below. 20757273a2dbSMatthew Booth 20767273a2dbSMatthew Booth@item -chardev null ,id=@var{id} 20777273a2dbSMatthew BoothA void device. This device will not emit any data, and will drop any data it 20787273a2dbSMatthew Boothreceives. The null backend does not take any options. 20797273a2dbSMatthew Booth 20805dd1f02bSCorey Minyard@item -chardev socket ,id=@var{id} [@var{TCP options} or @var{unix options}] [,server] [,nowait] [,telnet] [,reconnect=@var{seconds}] 20817273a2dbSMatthew Booth 20827273a2dbSMatthew BoothCreate a two-way stream socket, which can be either a TCP or a unix socket. A 20837273a2dbSMatthew Boothunix socket will be created if @option{path} is specified. Behaviour is 20847273a2dbSMatthew Boothundefined if TCP options are specified for a unix socket. 20857273a2dbSMatthew Booth 20867273a2dbSMatthew Booth@option{server} specifies that the socket shall be a listening socket. 20877273a2dbSMatthew Booth 20887273a2dbSMatthew Booth@option{nowait} specifies that QEMU should not block waiting for a client to 20897273a2dbSMatthew Boothconnect to a listening socket. 20907273a2dbSMatthew Booth 20917273a2dbSMatthew Booth@option{telnet} specifies that traffic on the socket should interpret telnet 20927273a2dbSMatthew Boothescape sequences. 20937273a2dbSMatthew Booth 20945dd1f02bSCorey Minyard@option{reconnect} sets the timeout for reconnecting on non-server sockets when 20955dd1f02bSCorey Minyardthe remote end goes away. qemu will delay this many seconds and then attempt 20965dd1f02bSCorey Minyardto reconnect. Zero disables reconnecting, and is the default. 20975dd1f02bSCorey Minyard 20987273a2dbSMatthew BoothTCP and unix socket options are given below: 20997273a2dbSMatthew Booth 21007273a2dbSMatthew Booth@table @option 21017273a2dbSMatthew Booth 21028d533561SAurelien Jarno@item TCP options: port=@var{port} [,host=@var{host}] [,to=@var{to}] [,ipv4] [,ipv6] [,nodelay] 21037273a2dbSMatthew Booth 21047273a2dbSMatthew Booth@option{host} for a listening socket specifies the local address to be bound. 21057273a2dbSMatthew BoothFor a connecting socket species the remote host to connect to. @option{host} is 21067273a2dbSMatthew Boothoptional for listening sockets. If not specified it defaults to @code{0.0.0.0}. 21077273a2dbSMatthew Booth 21087273a2dbSMatthew Booth@option{port} for a listening socket specifies the local port to be bound. For a 21097273a2dbSMatthew Boothconnecting socket specifies the port on the remote host to connect to. 21107273a2dbSMatthew Booth@option{port} can be given as either a port number or a service name. 21117273a2dbSMatthew Booth@option{port} is required. 21127273a2dbSMatthew Booth 21137273a2dbSMatthew Booth@option{to} is only relevant to listening sockets. If it is specified, and 21147273a2dbSMatthew Booth@option{port} cannot be bound, QEMU will attempt to bind to subsequent ports up 21157273a2dbSMatthew Boothto and including @option{to} until it succeeds. @option{to} must be specified 21167273a2dbSMatthew Boothas a port number. 21177273a2dbSMatthew Booth 21187273a2dbSMatthew Booth@option{ipv4} and @option{ipv6} specify that either IPv4 or IPv6 must be used. 21197273a2dbSMatthew BoothIf neither is specified the socket may use either protocol. 21207273a2dbSMatthew Booth 21217273a2dbSMatthew Booth@option{nodelay} disables the Nagle algorithm. 21227273a2dbSMatthew Booth 21237273a2dbSMatthew Booth@item unix options: path=@var{path} 21247273a2dbSMatthew Booth 21257273a2dbSMatthew Booth@option{path} specifies the local path of the unix socket. @option{path} is 21267273a2dbSMatthew Boothrequired. 21277273a2dbSMatthew Booth 21287273a2dbSMatthew Booth@end table 21297273a2dbSMatthew Booth 21307273a2dbSMatthew Booth@item -chardev udp ,id=@var{id} [,host=@var{host}] ,port=@var{port} [,localaddr=@var{localaddr}] [,localport=@var{localport}] [,ipv4] [,ipv6] 21317273a2dbSMatthew Booth 21327273a2dbSMatthew BoothSends all traffic from the guest to a remote host over UDP. 21337273a2dbSMatthew Booth 21347273a2dbSMatthew Booth@option{host} specifies the remote host to connect to. If not specified it 21357273a2dbSMatthew Boothdefaults to @code{localhost}. 21367273a2dbSMatthew Booth 21377273a2dbSMatthew Booth@option{port} specifies the port on the remote host to connect to. @option{port} 21387273a2dbSMatthew Boothis required. 21397273a2dbSMatthew Booth 21407273a2dbSMatthew Booth@option{localaddr} specifies the local address to bind to. If not specified it 21417273a2dbSMatthew Boothdefaults to @code{0.0.0.0}. 21427273a2dbSMatthew Booth 21437273a2dbSMatthew Booth@option{localport} specifies the local port to bind to. If not specified any 21447273a2dbSMatthew Boothavailable local port will be used. 21457273a2dbSMatthew Booth 21467273a2dbSMatthew Booth@option{ipv4} and @option{ipv6} specify that either IPv4 or IPv6 must be used. 21477273a2dbSMatthew BoothIf neither is specified the device may use either protocol. 21487273a2dbSMatthew Booth 21497273a2dbSMatthew Booth@item -chardev msmouse ,id=@var{id} 21507273a2dbSMatthew Booth 21517273a2dbSMatthew BoothForward QEMU's emulated msmouse events to the guest. @option{msmouse} does not 21527273a2dbSMatthew Boothtake any options. 21537273a2dbSMatthew Booth 21547273a2dbSMatthew Booth@item -chardev vc ,id=@var{id} [[,width=@var{width}] [,height=@var{height}]] [[,cols=@var{cols}] [,rows=@var{rows}]] 21557273a2dbSMatthew Booth 21567273a2dbSMatthew BoothConnect to a QEMU text console. @option{vc} may optionally be given a specific 21577273a2dbSMatthew Boothsize. 21587273a2dbSMatthew Booth 21597273a2dbSMatthew Booth@option{width} and @option{height} specify the width and height respectively of 21607273a2dbSMatthew Booththe console, in pixels. 21617273a2dbSMatthew Booth 21627273a2dbSMatthew Booth@option{cols} and @option{rows} specify that the console be sized to fit a text 21637273a2dbSMatthew Boothconsole with the given dimensions. 21647273a2dbSMatthew Booth 21654f57378fSMarkus Armbruster@item -chardev ringbuf ,id=@var{id} [,size=@var{size}] 216651767e7cSLei Li 21673949e594SMarkus ArmbrusterCreate a ring buffer with fixed size @option{size}. 21683949e594SMarkus Armbruster@var{size} must be a power of two, and defaults to @code{64K}). 216951767e7cSLei Li 21707273a2dbSMatthew Booth@item -chardev file ,id=@var{id} ,path=@var{path} 21717273a2dbSMatthew Booth 21727273a2dbSMatthew BoothLog all traffic received from the guest to a file. 21737273a2dbSMatthew Booth 21747273a2dbSMatthew Booth@option{path} specifies the path of the file to be opened. This file will be 21757273a2dbSMatthew Boothcreated if it does not already exist, and overwritten if it does. @option{path} 21767273a2dbSMatthew Boothis required. 21777273a2dbSMatthew Booth 21787273a2dbSMatthew Booth@item -chardev pipe ,id=@var{id} ,path=@var{path} 21797273a2dbSMatthew Booth 21807273a2dbSMatthew BoothCreate a two-way connection to the guest. The behaviour differs slightly between 21817273a2dbSMatthew BoothWindows hosts and other hosts: 21827273a2dbSMatthew Booth 21837273a2dbSMatthew BoothOn Windows, a single duplex pipe will be created at 21847273a2dbSMatthew Booth@file{\\.pipe\@option{path}}. 21857273a2dbSMatthew Booth 21867273a2dbSMatthew BoothOn other hosts, 2 pipes will be created called @file{@option{path}.in} and 21877273a2dbSMatthew Booth@file{@option{path}.out}. Data written to @file{@option{path}.in} will be 21887273a2dbSMatthew Boothreceived by the guest. Data written by the guest can be read from 21897273a2dbSMatthew Booth@file{@option{path}.out}. QEMU will not create these fifos, and requires them to 21907273a2dbSMatthew Boothbe present. 21917273a2dbSMatthew Booth 21927273a2dbSMatthew Booth@option{path} forms part of the pipe path as described above. @option{path} is 21937273a2dbSMatthew Boothrequired. 21947273a2dbSMatthew Booth 21957273a2dbSMatthew Booth@item -chardev console ,id=@var{id} 21967273a2dbSMatthew Booth 21977273a2dbSMatthew BoothSend traffic from the guest to QEMU's standard output. @option{console} does not 21987273a2dbSMatthew Boothtake any options. 21997273a2dbSMatthew Booth 22007273a2dbSMatthew Booth@option{console} is only available on Windows hosts. 22017273a2dbSMatthew Booth 22027273a2dbSMatthew Booth@item -chardev serial ,id=@var{id} ,path=@option{path} 22037273a2dbSMatthew Booth 22047273a2dbSMatthew BoothSend traffic from the guest to a serial device on the host. 22057273a2dbSMatthew Booth 2206d59044efSGerd HoffmannOn Unix hosts serial will actually accept any tty device, 2207d59044efSGerd Hoffmannnot only serial lines. 22087273a2dbSMatthew Booth 22097273a2dbSMatthew Booth@option{path} specifies the name of the serial device to open. 22107273a2dbSMatthew Booth 22117273a2dbSMatthew Booth@item -chardev pty ,id=@var{id} 22127273a2dbSMatthew Booth 22137273a2dbSMatthew BoothCreate a new pseudo-terminal on the host and connect to it. @option{pty} does 22147273a2dbSMatthew Boothnot take any options. 22157273a2dbSMatthew Booth 22167273a2dbSMatthew Booth@option{pty} is not available on Windows hosts. 22177273a2dbSMatthew Booth 2218b7fdb3abSAurelien Jarno@item -chardev stdio ,id=@var{id} [,signal=on|off] 2219b65ee4faSStefan WeilConnect to standard input and standard output of the QEMU process. 2220b7fdb3abSAurelien Jarno 2221b7fdb3abSAurelien Jarno@option{signal} controls if signals are enabled on the terminal, that includes 2222b7fdb3abSAurelien Jarnoexiting QEMU with the key sequence @key{Control-c}. This option is enabled by 2223b7fdb3abSAurelien Jarnodefault, use @option{signal=off} to disable it. 2224b7fdb3abSAurelien Jarno 2225b7fdb3abSAurelien Jarno@option{stdio} is not available on Windows hosts. 22267273a2dbSMatthew Booth 22277273a2dbSMatthew Booth@item -chardev braille ,id=@var{id} 22287273a2dbSMatthew Booth 22297273a2dbSMatthew BoothConnect to a local BrlAPI server. @option{braille} does not take any options. 22307273a2dbSMatthew Booth 22317273a2dbSMatthew Booth@item -chardev tty ,id=@var{id} ,path=@var{path} 22327273a2dbSMatthew Booth 22337273a2dbSMatthew Booth@option{tty} is only available on Linux, Sun, FreeBSD, NetBSD, OpenBSD and 2234d037d6bbSMarkus ArmbrusterDragonFlyBSD hosts. It is an alias for @option{serial}. 22357273a2dbSMatthew Booth 22367273a2dbSMatthew Booth@option{path} specifies the path to the tty. @option{path} is required. 22377273a2dbSMatthew Booth 223888a946d3SGerd Hoffmann@item -chardev parallel ,id=@var{id} ,path=@var{path} 22397273a2dbSMatthew Booth@item -chardev parport ,id=@var{id} ,path=@var{path} 22407273a2dbSMatthew Booth 224188a946d3SGerd Hoffmann@option{parallel} is only available on Linux, FreeBSD and DragonFlyBSD hosts. 22427273a2dbSMatthew Booth 22437273a2dbSMatthew BoothConnect to a local parallel port. 22447273a2dbSMatthew Booth 22457273a2dbSMatthew Booth@option{path} specifies the path to the parallel port device. @option{path} is 22467273a2dbSMatthew Boothrequired. 22477273a2dbSMatthew Booth 2248cbcc6336SAlon Levy@item -chardev spicevmc ,id=@var{id} ,debug=@var{debug}, name=@var{name} 2249cbcc6336SAlon Levy 22503a846906SStefan Hajnoczi@option{spicevmc} is only available when spice support is built in. 22513a846906SStefan Hajnoczi 2252cbcc6336SAlon Levy@option{debug} debug level for spicevmc 2253cbcc6336SAlon Levy 2254cbcc6336SAlon Levy@option{name} name of spice channel to connect to 2255cbcc6336SAlon Levy 2256cbcc6336SAlon LevyConnect to a spice virtual machine channel, such as vdiport. 2257cbcc6336SAlon Levy 22585a49d3e9SMarc-André Lureau@item -chardev spiceport ,id=@var{id} ,debug=@var{debug}, name=@var{name} 22595a49d3e9SMarc-André Lureau 22605a49d3e9SMarc-André Lureau@option{spiceport} is only available when spice support is built in. 22615a49d3e9SMarc-André Lureau 22625a49d3e9SMarc-André Lureau@option{debug} debug level for spicevmc 22635a49d3e9SMarc-André Lureau 22645a49d3e9SMarc-André Lureau@option{name} name of spice port to connect to 22655a49d3e9SMarc-André Lureau 22665a49d3e9SMarc-André LureauConnect to a spice port, allowing a Spice client to handle the traffic 22675a49d3e9SMarc-André Lureauidentified by a name (preferably a fqdn). 22687273a2dbSMatthew BoothETEXI 22697273a2dbSMatthew Booth 2270c70a01e4SMarkus ArmbrusterSTEXI 2271c70a01e4SMarkus Armbruster@end table 2272c70a01e4SMarkus ArmbrusterETEXI 22737273a2dbSMatthew BoothDEFHEADING() 22747273a2dbSMatthew Booth 22750f5314a2SRonnie SahlbergDEFHEADING(Device URL Syntax:) 2276c70a01e4SMarkus ArmbrusterSTEXI 22770f5314a2SRonnie Sahlberg 22780f5314a2SRonnie SahlbergIn addition to using normal file images for the emulated storage devices, 22790f5314a2SRonnie SahlbergQEMU can also use networked resources such as iSCSI devices. These are 22800f5314a2SRonnie Sahlbergspecified using a special URL syntax. 22810f5314a2SRonnie Sahlberg 22820f5314a2SRonnie Sahlberg@table @option 22830f5314a2SRonnie Sahlberg@item iSCSI 22840f5314a2SRonnie SahlbergiSCSI support allows QEMU to access iSCSI resources directly and use as 22850f5314a2SRonnie Sahlbergimages for the guest storage. Both disk and cdrom images are supported. 22860f5314a2SRonnie Sahlberg 22870f5314a2SRonnie SahlbergSyntax for specifying iSCSI LUNs is 22880f5314a2SRonnie Sahlberg``iscsi://<target-ip>[:<port>]/<target-iqn>/<lun>'' 22890f5314a2SRonnie Sahlberg 229031459f46SRonnie SahlbergBy default qemu will use the iSCSI initiator-name 229131459f46SRonnie Sahlberg'iqn.2008-11.org.linux-kvm[:<name>]' but this can also be set from the command 229231459f46SRonnie Sahlbergline or a configuration file. 229331459f46SRonnie Sahlberg 229431459f46SRonnie Sahlberg 22950f5314a2SRonnie SahlbergExample (without authentication): 22960f5314a2SRonnie Sahlberg@example 22973804da9dSStefan Weilqemu-system-i386 -iscsi initiator-name=iqn.2001-04.com.example:my-initiator \ 2298f9dadc98SRonnie Sahlberg -cdrom iscsi://192.0.2.1/iqn.2001-04.com.example/2 \ 2299f9dadc98SRonnie Sahlberg -drive file=iscsi://192.0.2.1/iqn.2001-04.com.example/1 23000f5314a2SRonnie Sahlberg@end example 23010f5314a2SRonnie Sahlberg 23020f5314a2SRonnie SahlbergExample (CHAP username/password via URL): 23030f5314a2SRonnie Sahlberg@example 23043804da9dSStefan Weilqemu-system-i386 -drive file=iscsi://user%password@@192.0.2.1/iqn.2001-04.com.example/1 23050f5314a2SRonnie Sahlberg@end example 23060f5314a2SRonnie Sahlberg 23070f5314a2SRonnie SahlbergExample (CHAP username/password via environment variables): 23080f5314a2SRonnie Sahlberg@example 23090f5314a2SRonnie SahlbergLIBISCSI_CHAP_USERNAME="user" \ 23100f5314a2SRonnie SahlbergLIBISCSI_CHAP_PASSWORD="password" \ 23113804da9dSStefan Weilqemu-system-i386 -drive file=iscsi://192.0.2.1/iqn.2001-04.com.example/1 23120f5314a2SRonnie Sahlberg@end example 23130f5314a2SRonnie Sahlberg 23140f5314a2SRonnie SahlbergiSCSI support is an optional feature of QEMU and only available when 23150f5314a2SRonnie Sahlbergcompiled and linked against libiscsi. 2316f9dadc98SRonnie SahlbergETEXI 2317f9dadc98SRonnie SahlbergDEF("iscsi", HAS_ARG, QEMU_OPTION_iscsi, 2318f9dadc98SRonnie Sahlberg "-iscsi [user=user][,password=password]\n" 2319f9dadc98SRonnie Sahlberg " [,header-digest=CRC32C|CR32C-NONE|NONE-CRC32C|NONE\n" 23202fe3798cSPaolo Bonzini " [,initiator-name=initiator-iqn][,id=target-iqn]\n" 2321f9dadc98SRonnie Sahlberg " iSCSI session parameters\n", QEMU_ARCH_ALL) 2322f9dadc98SRonnie SahlbergSTEXI 23230f5314a2SRonnie Sahlberg 232431459f46SRonnie SahlbergiSCSI parameters such as username and password can also be specified via 232531459f46SRonnie Sahlberga configuration file. See qemu-doc for more information and examples. 232631459f46SRonnie Sahlberg 232708ae330eSRonnie Sahlberg@item NBD 232808ae330eSRonnie SahlbergQEMU supports NBD (Network Block Devices) both using TCP protocol as well 232908ae330eSRonnie Sahlbergas Unix Domain Sockets. 233008ae330eSRonnie Sahlberg 233108ae330eSRonnie SahlbergSyntax for specifying a NBD device using TCP 233208ae330eSRonnie Sahlberg``nbd:<server-ip>:<port>[:exportname=<export>]'' 233308ae330eSRonnie Sahlberg 233408ae330eSRonnie SahlbergSyntax for specifying a NBD device using Unix Domain Sockets 233508ae330eSRonnie Sahlberg``nbd:unix:<domain-socket>[:exportname=<export>]'' 233608ae330eSRonnie Sahlberg 233708ae330eSRonnie Sahlberg 233808ae330eSRonnie SahlbergExample for TCP 233908ae330eSRonnie Sahlberg@example 23403804da9dSStefan Weilqemu-system-i386 --drive file=nbd:192.0.2.1:30000 234108ae330eSRonnie Sahlberg@end example 234208ae330eSRonnie Sahlberg 234308ae330eSRonnie SahlbergExample for Unix Domain Sockets 234408ae330eSRonnie Sahlberg@example 23453804da9dSStefan Weilqemu-system-i386 --drive file=nbd:unix:/tmp/nbd-socket 234608ae330eSRonnie Sahlberg@end example 234708ae330eSRonnie Sahlberg 23480a12ec87SRichard W.M. Jones@item SSH 23490a12ec87SRichard W.M. JonesQEMU supports SSH (Secure Shell) access to remote disks. 23500a12ec87SRichard W.M. Jones 23510a12ec87SRichard W.M. JonesExamples: 23520a12ec87SRichard W.M. Jones@example 23530a12ec87SRichard W.M. Jonesqemu-system-i386 -drive file=ssh://user@@host/path/to/disk.img 23540a12ec87SRichard W.M. Jonesqemu-system-i386 -drive file.driver=ssh,file.user=user,file.host=host,file.port=22,file.path=/path/to/disk.img 23550a12ec87SRichard W.M. Jones@end example 23560a12ec87SRichard W.M. Jones 23570a12ec87SRichard W.M. JonesCurrently authentication must be done using ssh-agent. Other 23580a12ec87SRichard W.M. Jonesauthentication methods may be supported in future. 23590a12ec87SRichard W.M. Jones 2360d9990228SRonnie Sahlberg@item Sheepdog 2361d9990228SRonnie SahlbergSheepdog is a distributed storage system for QEMU. 2362d9990228SRonnie SahlbergQEMU supports using either local sheepdog devices or remote networked 2363d9990228SRonnie Sahlbergdevices. 2364d9990228SRonnie Sahlberg 2365d9990228SRonnie SahlbergSyntax for specifying a sheepdog device 23665d6768e3SMORITA Kazutaka@example 23671b8bbb46SMORITA Kazutakasheepdog[+tcp|+unix]://[host:port]/vdiname[?socket=path][#snapid|#tag] 23685d6768e3SMORITA Kazutaka@end example 2369d9990228SRonnie Sahlberg 2370d9990228SRonnie SahlbergExample 2371d9990228SRonnie Sahlberg@example 23725d6768e3SMORITA Kazutakaqemu-system-i386 --drive file=sheepdog://192.0.2.1:30000/MyVirtualMachine 2373d9990228SRonnie Sahlberg@end example 2374d9990228SRonnie Sahlberg 2375d9990228SRonnie SahlbergSee also @url{http://http://www.osrg.net/sheepdog/}. 2376d9990228SRonnie Sahlberg 23778809e289SBharata B Rao@item GlusterFS 23788809e289SBharata B RaoGlusterFS is an user space distributed file system. 23798809e289SBharata B RaoQEMU supports the use of GlusterFS volumes for hosting VM disk images using 23808809e289SBharata B RaoTCP, Unix Domain Sockets and RDMA transport protocols. 23818809e289SBharata B Rao 23828809e289SBharata B RaoSyntax for specifying a VM disk image on GlusterFS volume is 23838809e289SBharata B Rao@example 23848809e289SBharata B Raogluster[+transport]://[server[:port]]/volname/image[?socket=...] 23858809e289SBharata B Rao@end example 23868809e289SBharata B Rao 23878809e289SBharata B Rao 23888809e289SBharata B RaoExample 23898809e289SBharata B Rao@example 2390db2d5ebaSLei Liqemu-system-x86_64 --drive file=gluster://192.0.2.1/testvol/a.img 23918809e289SBharata B Rao@end example 23928809e289SBharata B Rao 23938809e289SBharata B RaoSee also @url{http://www.gluster.org}. 23940a86cb73SMatthew Booth 23950a86cb73SMatthew Booth@item HTTP/HTTPS/FTP/FTPS/TFTP 23960a86cb73SMatthew BoothQEMU supports read-only access to files accessed over http(s), ftp(s) and tftp. 23970a86cb73SMatthew Booth 23980a86cb73SMatthew BoothSyntax using a single filename: 23990a86cb73SMatthew Booth@example 24000a86cb73SMatthew Booth<protocol>://[<username>[:<password>]@@]<host>/<path> 24010a86cb73SMatthew Booth@end example 24020a86cb73SMatthew Booth 24030a86cb73SMatthew Boothwhere: 24040a86cb73SMatthew Booth@table @option 24050a86cb73SMatthew Booth@item protocol 24060a86cb73SMatthew Booth'http', 'https', 'ftp', 'ftps', or 'tftp'. 24070a86cb73SMatthew Booth 24080a86cb73SMatthew Booth@item username 24090a86cb73SMatthew BoothOptional username for authentication to the remote server. 24100a86cb73SMatthew Booth 24110a86cb73SMatthew Booth@item password 24120a86cb73SMatthew BoothOptional password for authentication to the remote server. 24130a86cb73SMatthew Booth 24140a86cb73SMatthew Booth@item host 24150a86cb73SMatthew BoothAddress of the remote server. 24160a86cb73SMatthew Booth 24170a86cb73SMatthew Booth@item path 24180a86cb73SMatthew BoothPath on the remote server, including any query string. 24190a86cb73SMatthew Booth@end table 24200a86cb73SMatthew Booth 24210a86cb73SMatthew BoothThe following options are also supported: 24220a86cb73SMatthew Booth@table @option 24230a86cb73SMatthew Booth@item url 24240a86cb73SMatthew BoothThe full URL when passing options to the driver explicitly. 24250a86cb73SMatthew Booth 24260a86cb73SMatthew Booth@item readahead 24270a86cb73SMatthew BoothThe amount of data to read ahead with each range request to the remote server. 24280a86cb73SMatthew BoothThis value may optionally have the suffix 'T', 'G', 'M', 'K', 'k' or 'b'. If it 24290a86cb73SMatthew Boothdoes not have a suffix, it will be assumed to be in bytes. The value must be a 24300a86cb73SMatthew Boothmultiple of 512 bytes. It defaults to 256k. 24310a86cb73SMatthew Booth 24320a86cb73SMatthew Booth@item sslverify 24330a86cb73SMatthew BoothWhether to verify the remote server's certificate when connecting over SSL. It 24340a86cb73SMatthew Boothcan have the value 'on' or 'off'. It defaults to 'on'. 2435212aefaaSDaniel Henrique Barboza 2436a94f83d9SRichard W.M. Jones@item cookie 2437a94f83d9SRichard W.M. JonesSend this cookie (it can also be a list of cookies separated by ';') with 2438a94f83d9SRichard W.M. Joneseach outgoing request. Only supported when using protocols such as HTTP 2439a94f83d9SRichard W.M. Joneswhich support cookies, otherwise ignored. 2440a94f83d9SRichard W.M. Jones 2441212aefaaSDaniel Henrique Barboza@item timeout 2442212aefaaSDaniel Henrique BarbozaSet the timeout in seconds of the CURL connection. This timeout is the time 2443212aefaaSDaniel Henrique Barbozathat CURL waits for a response from the remote server to get the size of the 2444212aefaaSDaniel Henrique Barbozaimage to be downloaded. If not set, the default timeout of 5 seconds is used. 24450a86cb73SMatthew Booth@end table 24460a86cb73SMatthew Booth 24470a86cb73SMatthew BoothNote that when passing options to qemu explicitly, @option{driver} is the value 24480a86cb73SMatthew Boothof <protocol>. 24490a86cb73SMatthew Booth 24500a86cb73SMatthew BoothExample: boot from a remote Fedora 20 live ISO image 24510a86cb73SMatthew Booth@example 24520a86cb73SMatthew 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 24530a86cb73SMatthew Booth 24540a86cb73SMatthew 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 24550a86cb73SMatthew Booth@end example 24560a86cb73SMatthew Booth 24570a86cb73SMatthew BoothExample: boot from a remote Fedora 20 cloud image using a local overlay for 24580a86cb73SMatthew Boothwrites, copy-on-read, and a readahead of 64k 24590a86cb73SMatthew Booth@example 24600a86cb73SMatthew 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 24610a86cb73SMatthew Booth 24620a86cb73SMatthew Boothqemu-system-x86_64 -drive file=/tmp/Fedora-x86_64-20-20131211.1-sda.qcow2,copy-on-read=on 24630a86cb73SMatthew Booth@end example 24640a86cb73SMatthew Booth 24650a86cb73SMatthew BoothExample: boot from an image stored on a VMware vSphere server with a self-signed 2466212aefaaSDaniel Henrique Barbozacertificate using a local overlay for writes, a readahead of 64k and a timeout 2467212aefaaSDaniel Henrique Barbozaof 10 seconds. 24680a86cb73SMatthew Booth@example 2469212aefaaSDaniel Henrique Barbozaqemu-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",, "file.timeout":10@}' /tmp/test.qcow2 24700a86cb73SMatthew Booth 24710a86cb73SMatthew Boothqemu-system-x86_64 -drive file=/tmp/test.qcow2 24720a86cb73SMatthew Booth@end example 2473c70a01e4SMarkus ArmbrusterETEXI 2474c70a01e4SMarkus Armbruster 2475c70a01e4SMarkus ArmbrusterSTEXI 24760f5314a2SRonnie Sahlberg@end table 24770f5314a2SRonnie SahlbergETEXI 24780f5314a2SRonnie Sahlberg 24797273a2dbSMatthew BoothDEFHEADING(Bluetooth(R) options:) 2480c70a01e4SMarkus ArmbrusterSTEXI 2481c70a01e4SMarkus Armbruster@table @option 2482c70a01e4SMarkus ArmbrusterETEXI 24837273a2dbSMatthew Booth 24845824d651Sblueswir1DEF("bt", HAS_ARG, QEMU_OPTION_bt, \ 24855824d651Sblueswir1 "-bt hci,null dumb bluetooth HCI - doesn't respond to commands\n" \ 24865824d651Sblueswir1 "-bt hci,host[:id]\n" \ 24875824d651Sblueswir1 " use host's HCI with the given name\n" \ 24885824d651Sblueswir1 "-bt hci[,vlan=n]\n" \ 24895824d651Sblueswir1 " emulate a standard HCI in virtual scatternet 'n'\n" \ 24905824d651Sblueswir1 "-bt vhci[,vlan=n]\n" \ 24915824d651Sblueswir1 " add host computer to virtual scatternet 'n' using VHCI\n" \ 24925824d651Sblueswir1 "-bt device:dev[,vlan=n]\n" \ 2493ad96090aSBlue Swirl " emulate a bluetooth device 'dev' in scatternet 'n'\n", 2494ad96090aSBlue Swirl QEMU_ARCH_ALL) 24955824d651Sblueswir1STEXI 24965824d651Sblueswir1@item -bt hci[...] 24976616b2adSStefan Weil@findex -bt 24985824d651Sblueswir1Defines the function of the corresponding Bluetooth HCI. -bt options 24995824d651Sblueswir1are matched with the HCIs present in the chosen machine type. For 25005824d651Sblueswir1example when emulating a machine with only one HCI built into it, only 25015824d651Sblueswir1the first @code{-bt hci[...]} option is valid and defines the HCI's 25025824d651Sblueswir1logic. The Transport Layer is decided by the machine type. Currently 25035824d651Sblueswir1the machines @code{n800} and @code{n810} have one HCI and all other 25045824d651Sblueswir1machines have none. 25055824d651Sblueswir1 25065824d651Sblueswir1@anchor{bt-hcis} 25075824d651Sblueswir1The following three types are recognized: 25085824d651Sblueswir1 2509b3f046c2SKevin Wolf@table @option 25105824d651Sblueswir1@item -bt hci,null 25115824d651Sblueswir1(default) The corresponding Bluetooth HCI assumes no internal logic 25125824d651Sblueswir1and will not respond to any HCI commands or emit events. 25135824d651Sblueswir1 25145824d651Sblueswir1@item -bt hci,host[:@var{id}] 25155824d651Sblueswir1(@code{bluez} only) The corresponding HCI passes commands / events 25165824d651Sblueswir1to / from the physical HCI identified by the name @var{id} (default: 25175824d651Sblueswir1@code{hci0}) on the computer running QEMU. Only available on @code{bluez} 25185824d651Sblueswir1capable systems like Linux. 25195824d651Sblueswir1 25205824d651Sblueswir1@item -bt hci[,vlan=@var{n}] 25215824d651Sblueswir1Add a virtual, standard HCI that will participate in the Bluetooth 25225824d651Sblueswir1scatternet @var{n} (default @code{0}). Similarly to @option{-net} 25235824d651Sblueswir1VLANs, devices inside a bluetooth network @var{n} can only communicate 25245824d651Sblueswir1with other devices in the same network (scatternet). 25255824d651Sblueswir1@end table 25265824d651Sblueswir1 25275824d651Sblueswir1@item -bt vhci[,vlan=@var{n}] 25285824d651Sblueswir1(Linux-host only) Create a HCI in scatternet @var{n} (default 0) attached 25295824d651Sblueswir1to the host bluetooth stack instead of to the emulated target. This 25305824d651Sblueswir1allows the host and target machines to participate in a common scatternet 25315824d651Sblueswir1and communicate. Requires the Linux @code{vhci} driver installed. Can 25325824d651Sblueswir1be used as following: 25335824d651Sblueswir1 25345824d651Sblueswir1@example 25353804da9dSStefan Weilqemu-system-i386 [...OPTIONS...] -bt hci,vlan=5 -bt vhci,vlan=5 25365824d651Sblueswir1@end example 25375824d651Sblueswir1 25385824d651Sblueswir1@item -bt device:@var{dev}[,vlan=@var{n}] 25395824d651Sblueswir1Emulate a bluetooth device @var{dev} and place it in network @var{n} 25405824d651Sblueswir1(default @code{0}). QEMU can only emulate one type of bluetooth devices 25415824d651Sblueswir1currently: 25425824d651Sblueswir1 2543b3f046c2SKevin Wolf@table @option 25445824d651Sblueswir1@item keyboard 25455824d651Sblueswir1Virtual wireless keyboard implementing the HIDP bluetooth profile. 25465824d651Sblueswir1@end table 25475824d651Sblueswir1ETEXI 25485824d651Sblueswir1 2549c70a01e4SMarkus ArmbrusterSTEXI 2550c70a01e4SMarkus Armbruster@end table 2551c70a01e4SMarkus ArmbrusterETEXI 25525824d651Sblueswir1DEFHEADING() 25535824d651Sblueswir1 2554d1a0cf73SStefan Berger#ifdef CONFIG_TPM 2555d1a0cf73SStefan BergerDEFHEADING(TPM device options:) 2556d1a0cf73SStefan Berger 2557d1a0cf73SStefan BergerDEF("tpmdev", HAS_ARG, QEMU_OPTION_tpmdev, \ 255892dcc234SStefan Berger "-tpmdev passthrough,id=id[,path=path][,cancel-path=path]\n" 255992dcc234SStefan Berger " use path to provide path to a character device; default is /dev/tpm0\n" 256092dcc234SStefan Berger " use cancel-path to provide path to TPM's cancel sysfs entry; if\n" 256192dcc234SStefan Berger " not provided it will be searched for in /sys/class/misc/tpm?/device\n", 2562d1a0cf73SStefan Berger QEMU_ARCH_ALL) 2563d1a0cf73SStefan BergerSTEXI 2564d1a0cf73SStefan Berger 2565d1a0cf73SStefan BergerThe general form of a TPM device option is: 2566d1a0cf73SStefan Berger@table @option 2567d1a0cf73SStefan Berger 2568d1a0cf73SStefan Berger@item -tpmdev @var{backend} ,id=@var{id} [,@var{options}] 2569d1a0cf73SStefan Berger@findex -tpmdev 2570d1a0cf73SStefan BergerBackend type must be: 25714549a8b7SStefan Berger@option{passthrough}. 2572d1a0cf73SStefan Berger 2573d1a0cf73SStefan BergerThe specific backend type will determine the applicable options. 257428c4fa32SCorey BryantThe @code{-tpmdev} option creates the TPM backend and requires a 257528c4fa32SCorey Bryant@code{-device} option that specifies the TPM frontend interface model. 2576d1a0cf73SStefan Berger 2577d1a0cf73SStefan BergerOptions to each backend are described below. 2578d1a0cf73SStefan Berger 2579d1a0cf73SStefan BergerUse 'help' to print all available TPM backend types. 2580d1a0cf73SStefan Berger@example 2581d1a0cf73SStefan Bergerqemu -tpmdev help 2582d1a0cf73SStefan Berger@end example 2583d1a0cf73SStefan Berger 258492dcc234SStefan Berger@item -tpmdev passthrough, id=@var{id}, path=@var{path}, cancel-path=@var{cancel-path} 25854549a8b7SStefan Berger 25864549a8b7SStefan Berger(Linux-host only) Enable access to the host's TPM using the passthrough 25874549a8b7SStefan Bergerdriver. 25884549a8b7SStefan Berger 25894549a8b7SStefan Berger@option{path} specifies the path to the host's TPM device, i.e., on 25904549a8b7SStefan Bergera Linux host this would be @code{/dev/tpm0}. 25914549a8b7SStefan Berger@option{path} is optional and by default @code{/dev/tpm0} is used. 25924549a8b7SStefan Berger 259392dcc234SStefan Berger@option{cancel-path} specifies the path to the host TPM device's sysfs 259492dcc234SStefan Bergerentry allowing for cancellation of an ongoing TPM command. 259592dcc234SStefan Berger@option{cancel-path} is optional and by default QEMU will search for the 259692dcc234SStefan Bergersysfs entry to use. 259792dcc234SStefan Berger 25984549a8b7SStefan BergerSome notes about using the host's TPM with the passthrough driver: 25994549a8b7SStefan Berger 26004549a8b7SStefan BergerThe TPM device accessed by the passthrough driver must not be 26014549a8b7SStefan Bergerused by any other application on the host. 26024549a8b7SStefan Berger 26034549a8b7SStefan BergerSince the host's firmware (BIOS/UEFI) has already initialized the TPM, 26044549a8b7SStefan Bergerthe VM's firmware (BIOS/UEFI) will not be able to initialize the 26054549a8b7SStefan BergerTPM again and may therefore not show a TPM-specific menu that would 26064549a8b7SStefan Bergerotherwise allow the user to configure the TPM, e.g., allow the user to 26074549a8b7SStefan Bergerenable/disable or activate/deactivate the TPM. 26084549a8b7SStefan BergerFurther, if TPM ownership is released from within a VM then the host's TPM 26094549a8b7SStefan Bergerwill get disabled and deactivated. To enable and activate the 26104549a8b7SStefan BergerTPM again afterwards, the host has to be rebooted and the user is 26114549a8b7SStefan Bergerrequired to enter the firmware's menu to enable and activate the TPM. 26124549a8b7SStefan BergerIf the TPM is left disabled and/or deactivated most TPM commands will fail. 26134549a8b7SStefan Berger 26144549a8b7SStefan BergerTo create a passthrough TPM use the following two options: 26154549a8b7SStefan Berger@example 26164549a8b7SStefan Berger-tpmdev passthrough,id=tpm0 -device tpm-tis,tpmdev=tpm0 26174549a8b7SStefan Berger@end example 26184549a8b7SStefan BergerNote that the @code{-tpmdev} id is @code{tpm0} and is referenced by 26194549a8b7SStefan Berger@code{tpmdev=tpm0} in the device option. 26204549a8b7SStefan Berger 2621d1a0cf73SStefan Berger@end table 2622d1a0cf73SStefan Berger 2623d1a0cf73SStefan BergerETEXI 2624d1a0cf73SStefan Berger 2625d1a0cf73SStefan BergerDEFHEADING() 2626d1a0cf73SStefan Berger 2627d1a0cf73SStefan Berger#endif 2628d1a0cf73SStefan Berger 26297677f05dSAlexander GrafDEFHEADING(Linux/Multiboot boot specific:) 26305824d651Sblueswir1STEXI 26317677f05dSAlexander Graf 26327677f05dSAlexander GrafWhen using these options, you can use a given Linux or Multiboot 26337677f05dSAlexander Grafkernel without installing it in the disk image. It can be useful 26345824d651Sblueswir1for easier testing of various kernels. 26355824d651Sblueswir1 26365824d651Sblueswir1@table @option 26375824d651Sblueswir1ETEXI 26385824d651Sblueswir1 26395824d651Sblueswir1DEF("kernel", HAS_ARG, QEMU_OPTION_kernel, \ 2640ad96090aSBlue Swirl "-kernel bzImage use 'bzImage' as kernel image\n", QEMU_ARCH_ALL) 26415824d651Sblueswir1STEXI 26425824d651Sblueswir1@item -kernel @var{bzImage} 26436616b2adSStefan Weil@findex -kernel 26447677f05dSAlexander GrafUse @var{bzImage} as kernel image. The kernel can be either a Linux kernel 26457677f05dSAlexander Grafor in multiboot format. 26465824d651Sblueswir1ETEXI 26475824d651Sblueswir1 26485824d651Sblueswir1DEF("append", HAS_ARG, QEMU_OPTION_append, \ 2649ad96090aSBlue Swirl "-append cmdline use 'cmdline' as kernel command line\n", QEMU_ARCH_ALL) 26505824d651Sblueswir1STEXI 26515824d651Sblueswir1@item -append @var{cmdline} 26526616b2adSStefan Weil@findex -append 26535824d651Sblueswir1Use @var{cmdline} as kernel command line 26545824d651Sblueswir1ETEXI 26555824d651Sblueswir1 26565824d651Sblueswir1DEF("initrd", HAS_ARG, QEMU_OPTION_initrd, \ 2657ad96090aSBlue Swirl "-initrd file use 'file' as initial ram disk\n", QEMU_ARCH_ALL) 26585824d651Sblueswir1STEXI 26595824d651Sblueswir1@item -initrd @var{file} 26606616b2adSStefan Weil@findex -initrd 26615824d651Sblueswir1Use @var{file} as initial ram disk. 26627677f05dSAlexander Graf 26637677f05dSAlexander Graf@item -initrd "@var{file1} arg=foo,@var{file2}" 26647677f05dSAlexander Graf 26657677f05dSAlexander GrafThis syntax is only available with multiboot. 26667677f05dSAlexander Graf 26677677f05dSAlexander GrafUse @var{file1} and @var{file2} as modules and pass arg=foo as parameter to the 26687677f05dSAlexander Graffirst module. 26695824d651Sblueswir1ETEXI 26705824d651Sblueswir1 2671412beee6SGrant LikelyDEF("dtb", HAS_ARG, QEMU_OPTION_dtb, \ 2672379b5c7cSPeter A. G. Crosthwaite "-dtb file use 'file' as device tree image\n", QEMU_ARCH_ALL) 2673412beee6SGrant LikelySTEXI 2674412beee6SGrant Likely@item -dtb @var{file} 2675412beee6SGrant Likely@findex -dtb 2676412beee6SGrant LikelyUse @var{file} as a device tree binary (dtb) image and pass it to the kernel 2677412beee6SGrant Likelyon boot. 2678412beee6SGrant LikelyETEXI 2679412beee6SGrant Likely 26805824d651Sblueswir1STEXI 26815824d651Sblueswir1@end table 26825824d651Sblueswir1ETEXI 26835824d651Sblueswir1DEFHEADING() 26845824d651Sblueswir1 26855824d651Sblueswir1DEFHEADING(Debug/Expert options:) 26865824d651Sblueswir1STEXI 26875824d651Sblueswir1@table @option 26885824d651Sblueswir1ETEXI 26895824d651Sblueswir1 269081b2b810SGabriel L. SomloDEF("fw_cfg", HAS_ARG, QEMU_OPTION_fwcfg, 269181b2b810SGabriel L. Somlo "-fw_cfg [name=]<name>,file=<file>\n" 269281b2b810SGabriel L. Somlo " add named fw_cfg entry from file\n", 269381b2b810SGabriel L. Somlo QEMU_ARCH_ALL) 269481b2b810SGabriel L. SomloSTEXI 269581b2b810SGabriel L. Somlo@item -fw_cfg [name=]@var{name},file=@var{file} 269681b2b810SGabriel L. Somlo@findex -fw_cfg 269781b2b810SGabriel L. SomloAdd named fw_cfg entry from file. @var{name} determines the name of 269881b2b810SGabriel L. Somlothe entry in the fw_cfg file directory exposed to the guest. 269981b2b810SGabriel L. SomloETEXI 270081b2b810SGabriel L. Somlo 27015824d651Sblueswir1DEF("serial", HAS_ARG, QEMU_OPTION_serial, \ 2702ad96090aSBlue Swirl "-serial dev redirect the serial port to char device 'dev'\n", 2703ad96090aSBlue Swirl QEMU_ARCH_ALL) 27045824d651Sblueswir1STEXI 27055824d651Sblueswir1@item -serial @var{dev} 27066616b2adSStefan Weil@findex -serial 27075824d651Sblueswir1Redirect the virtual serial port to host character device 27085824d651Sblueswir1@var{dev}. The default device is @code{vc} in graphical mode and 27095824d651Sblueswir1@code{stdio} in non graphical mode. 27105824d651Sblueswir1 27115824d651Sblueswir1This option can be used several times to simulate up to 4 serial 27125824d651Sblueswir1ports. 27135824d651Sblueswir1 27145824d651Sblueswir1Use @code{-serial none} to disable all serial ports. 27155824d651Sblueswir1 27165824d651Sblueswir1Available character devices are: 2717b3f046c2SKevin Wolf@table @option 27184e257e5eSKevin Wolf@item vc[:@var{W}x@var{H}] 27195824d651Sblueswir1Virtual console. Optionally, a width and height can be given in pixel with 27205824d651Sblueswir1@example 27215824d651Sblueswir1vc:800x600 27225824d651Sblueswir1@end example 27235824d651Sblueswir1It is also possible to specify width or height in characters: 27245824d651Sblueswir1@example 27255824d651Sblueswir1vc:80Cx24C 27265824d651Sblueswir1@end example 27275824d651Sblueswir1@item pty 27285824d651Sblueswir1[Linux only] Pseudo TTY (a new PTY is automatically allocated) 27295824d651Sblueswir1@item none 27305824d651Sblueswir1No device is allocated. 27315824d651Sblueswir1@item null 27325824d651Sblueswir1void device 273388e020e5SIngo van Lil@item chardev:@var{id} 273488e020e5SIngo van LilUse a named character device defined with the @code{-chardev} option. 27355824d651Sblueswir1@item /dev/XXX 27365824d651Sblueswir1[Linux only] Use host tty, e.g. @file{/dev/ttyS0}. The host serial port 27375824d651Sblueswir1parameters are set according to the emulated ones. 27385824d651Sblueswir1@item /dev/parport@var{N} 27395824d651Sblueswir1[Linux only, parallel port only] Use host parallel port 27405824d651Sblueswir1@var{N}. Currently SPP and EPP parallel port features can be used. 27415824d651Sblueswir1@item file:@var{filename} 27425824d651Sblueswir1Write output to @var{filename}. No character can be read. 27435824d651Sblueswir1@item stdio 27445824d651Sblueswir1[Unix only] standard input/output 27455824d651Sblueswir1@item pipe:@var{filename} 27465824d651Sblueswir1name pipe @var{filename} 27475824d651Sblueswir1@item COM@var{n} 27485824d651Sblueswir1[Windows only] Use host serial port @var{n} 27495824d651Sblueswir1@item udp:[@var{remote_host}]:@var{remote_port}[@@[@var{src_ip}]:@var{src_port}] 27505824d651Sblueswir1This implements UDP Net Console. 27515824d651Sblueswir1When @var{remote_host} or @var{src_ip} are not specified 27525824d651Sblueswir1they default to @code{0.0.0.0}. 27535824d651Sblueswir1When not using a specified @var{src_port} a random port is automatically chosen. 27545824d651Sblueswir1 27555824d651Sblueswir1If you just want a simple readonly console you can use @code{netcat} or 2756b65ee4faSStefan Weil@code{nc}, by starting QEMU with: @code{-serial udp::4555} and nc as: 2757b65ee4faSStefan Weil@code{nc -u -l -p 4555}. Any time QEMU writes something to that port it 27585824d651Sblueswir1will appear in the netconsole session. 27595824d651Sblueswir1 27605824d651Sblueswir1If you plan to send characters back via netconsole or you want to stop 2761b65ee4faSStefan Weiland start QEMU a lot of times, you should have QEMU use the same 27625824d651Sblueswir1source port each time by using something like @code{-serial 2763b65ee4faSStefan Weiludp::4555@@:4556} to QEMU. Another approach is to use a patched 27645824d651Sblueswir1version of netcat which can listen to a TCP port and send and receive 27655824d651Sblueswir1characters via udp. If you have a patched version of netcat which 27665824d651Sblueswir1activates telnet remote echo and single char transfer, then you can 27675824d651Sblueswir1use the following options to step up a netcat redirector to allow 2768b65ee4faSStefan Weiltelnet on port 5555 to access the QEMU port. 27695824d651Sblueswir1@table @code 2770071c9394SStefan Weil@item QEMU Options: 27715824d651Sblueswir1-serial udp::4555@@:4556 27725824d651Sblueswir1@item netcat options: 27735824d651Sblueswir1-u -P 4555 -L 0.0.0.0:4556 -t -p 5555 -I -T 27745824d651Sblueswir1@item telnet options: 27755824d651Sblueswir1localhost 5555 27765824d651Sblueswir1@end table 27775824d651Sblueswir1 27785dd1f02bSCorey Minyard@item tcp:[@var{host}]:@var{port}[,@var{server}][,nowait][,nodelay][,reconnect=@var{seconds}] 27795824d651Sblueswir1The TCP Net Console has two modes of operation. It can send the serial 27805824d651Sblueswir1I/O to a location or wait for a connection from a location. By default 27815824d651Sblueswir1the TCP Net Console is sent to @var{host} at the @var{port}. If you use 27825824d651Sblueswir1the @var{server} option QEMU will wait for a client socket application 27835824d651Sblueswir1to connect to the port before continuing, unless the @code{nowait} 27845824d651Sblueswir1option was specified. The @code{nodelay} option disables the Nagle buffering 27855dd1f02bSCorey Minyardalgorithm. The @code{reconnect} option only applies if @var{noserver} is 27865dd1f02bSCorey Minyardset, if the connection goes down it will attempt to reconnect at the 27875dd1f02bSCorey Minyardgiven interval. If @var{host} is omitted, 0.0.0.0 is assumed. Only 27885824d651Sblueswir1one TCP connection at a time is accepted. You can use @code{telnet} to 27895824d651Sblueswir1connect to the corresponding character device. 27905824d651Sblueswir1@table @code 27915824d651Sblueswir1@item Example to send tcp console to 192.168.0.2 port 4444 27925824d651Sblueswir1-serial tcp:192.168.0.2:4444 27935824d651Sblueswir1@item Example to listen and wait on port 4444 for connection 27945824d651Sblueswir1-serial tcp::4444,server 27955824d651Sblueswir1@item Example to not wait and listen on ip 192.168.0.100 port 4444 27965824d651Sblueswir1-serial tcp:192.168.0.100:4444,server,nowait 27975824d651Sblueswir1@end table 27985824d651Sblueswir1 27995824d651Sblueswir1@item telnet:@var{host}:@var{port}[,server][,nowait][,nodelay] 28005824d651Sblueswir1The telnet protocol is used instead of raw tcp sockets. The options 28015824d651Sblueswir1work the same as if you had specified @code{-serial tcp}. The 28025824d651Sblueswir1difference is that the port acts like a telnet server or client using 28035824d651Sblueswir1telnet option negotiation. This will also allow you to send the 28045824d651Sblueswir1MAGIC_SYSRQ sequence if you use a telnet that supports sending the break 28055824d651Sblueswir1sequence. Typically in unix telnet you do it with Control-] and then 28065824d651Sblueswir1type "send break" followed by pressing the enter key. 28075824d651Sblueswir1 28085dd1f02bSCorey Minyard@item unix:@var{path}[,server][,nowait][,reconnect=@var{seconds}] 28095824d651Sblueswir1A unix domain socket is used instead of a tcp socket. The option works the 28105824d651Sblueswir1same as if you had specified @code{-serial tcp} except the unix domain socket 28115824d651Sblueswir1@var{path} is used for connections. 28125824d651Sblueswir1 28135824d651Sblueswir1@item mon:@var{dev_string} 28145824d651Sblueswir1This is a special option to allow the monitor to be multiplexed onto 28155824d651Sblueswir1another serial port. The monitor is accessed with key sequence of 281602c4bdf1SPaolo Bonzini@key{Control-a} and then pressing @key{c}. 28175824d651Sblueswir1@var{dev_string} should be any one of the serial devices specified 28185824d651Sblueswir1above. An example to multiplex the monitor onto a telnet server 28195824d651Sblueswir1listening on port 4444 would be: 28205824d651Sblueswir1@table @code 28215824d651Sblueswir1@item -serial mon:telnet::4444,server,nowait 28225824d651Sblueswir1@end table 2823be022d61SMichael TokarevWhen the monitor is multiplexed to stdio in this way, Ctrl+C will not terminate 282402c4bdf1SPaolo BonziniQEMU any more but will be passed to the guest instead. 28255824d651Sblueswir1 28265824d651Sblueswir1@item braille 28275824d651Sblueswir1Braille device. This will use BrlAPI to display the braille output on a real 28285824d651Sblueswir1or fake device. 28295824d651Sblueswir1 2830be8b28a9SKevin Wolf@item msmouse 2831be8b28a9SKevin WolfThree button serial mouse. Configure the guest to use Microsoft protocol. 28325824d651Sblueswir1@end table 28335824d651Sblueswir1ETEXI 28345824d651Sblueswir1 28355824d651Sblueswir1DEF("parallel", HAS_ARG, QEMU_OPTION_parallel, \ 2836ad96090aSBlue Swirl "-parallel dev redirect the parallel port to char device 'dev'\n", 2837ad96090aSBlue Swirl QEMU_ARCH_ALL) 28385824d651Sblueswir1STEXI 28395824d651Sblueswir1@item -parallel @var{dev} 28406616b2adSStefan Weil@findex -parallel 28415824d651Sblueswir1Redirect the virtual parallel port to host device @var{dev} (same 28425824d651Sblueswir1devices as the serial port). On Linux hosts, @file{/dev/parportN} can 28435824d651Sblueswir1be used to use hardware devices connected on the corresponding host 28445824d651Sblueswir1parallel port. 28455824d651Sblueswir1 28465824d651Sblueswir1This option can be used several times to simulate up to 3 parallel 28475824d651Sblueswir1ports. 28485824d651Sblueswir1 28495824d651Sblueswir1Use @code{-parallel none} to disable all parallel ports. 28505824d651Sblueswir1ETEXI 28515824d651Sblueswir1 28525824d651Sblueswir1DEF("monitor", HAS_ARG, QEMU_OPTION_monitor, \ 2853ad96090aSBlue Swirl "-monitor dev redirect the monitor to char device 'dev'\n", 2854ad96090aSBlue Swirl QEMU_ARCH_ALL) 28555824d651Sblueswir1STEXI 28564e307fc8SGerd Hoffmann@item -monitor @var{dev} 28576616b2adSStefan Weil@findex -monitor 28585824d651Sblueswir1Redirect the monitor to host device @var{dev} (same devices as the 28595824d651Sblueswir1serial port). 28605824d651Sblueswir1The default device is @code{vc} in graphical mode and @code{stdio} in 28615824d651Sblueswir1non graphical mode. 286270e098afSLuiz CapitulinoUse @code{-monitor none} to disable the default monitor. 28635824d651Sblueswir1ETEXI 28646ca5582dSGerd HoffmannDEF("qmp", HAS_ARG, QEMU_OPTION_qmp, \ 2865ad96090aSBlue Swirl "-qmp dev like -monitor but opens in 'control' mode\n", 2866ad96090aSBlue Swirl QEMU_ARCH_ALL) 286795d5f08bSStefan WeilSTEXI 286895d5f08bSStefan Weil@item -qmp @var{dev} 28696616b2adSStefan Weil@findex -qmp 287095d5f08bSStefan WeilLike -monitor but opens in 'control' mode. 287195d5f08bSStefan WeilETEXI 28724821cd4cSMax ReitzDEF("qmp-pretty", HAS_ARG, QEMU_OPTION_qmp_pretty, \ 28734821cd4cSMax Reitz "-qmp-pretty dev like -qmp but uses pretty JSON formatting\n", 28744821cd4cSMax Reitz QEMU_ARCH_ALL) 28754821cd4cSMax ReitzSTEXI 28764821cd4cSMax Reitz@item -qmp-pretty @var{dev} 28774821cd4cSMax Reitz@findex -qmp-pretty 28784821cd4cSMax ReitzLike -qmp but uses pretty JSON formatting. 28794821cd4cSMax ReitzETEXI 28805824d651Sblueswir1 288122a0e04bSGerd HoffmannDEF("mon", HAS_ARG, QEMU_OPTION_mon, \ 2882f17e4eaaSMichael Tokarev "-mon [chardev=]name[,mode=readline|control][,default]\n", QEMU_ARCH_ALL) 288322a0e04bSGerd HoffmannSTEXI 2884f17e4eaaSMichael Tokarev@item -mon [chardev=]name[,mode=readline|control][,default] 28856616b2adSStefan Weil@findex -mon 288622a0e04bSGerd HoffmannSetup monitor on chardev @var{name}. 288722a0e04bSGerd HoffmannETEXI 288822a0e04bSGerd Hoffmann 2889c9f398e5SH. Peter AnvinDEF("debugcon", HAS_ARG, QEMU_OPTION_debugcon, \ 2890ad96090aSBlue Swirl "-debugcon dev redirect the debug console to char device 'dev'\n", 2891ad96090aSBlue Swirl QEMU_ARCH_ALL) 2892c9f398e5SH. Peter AnvinSTEXI 2893c9f398e5SH. Peter Anvin@item -debugcon @var{dev} 28946616b2adSStefan Weil@findex -debugcon 2895c9f398e5SH. Peter AnvinRedirect the debug console to host device @var{dev} (same devices as the 2896c9f398e5SH. Peter Anvinserial port). The debug console is an I/O port which is typically port 2897c9f398e5SH. Peter Anvin0xe9; writing to that I/O port sends output to this device. 2898c9f398e5SH. Peter AnvinThe default device is @code{vc} in graphical mode and @code{stdio} in 2899c9f398e5SH. Peter Anvinnon graphical mode. 2900c9f398e5SH. Peter AnvinETEXI 2901c9f398e5SH. Peter Anvin 29025824d651Sblueswir1DEF("pidfile", HAS_ARG, QEMU_OPTION_pidfile, \ 2903ad96090aSBlue Swirl "-pidfile file write PID to 'file'\n", QEMU_ARCH_ALL) 29045824d651Sblueswir1STEXI 29055824d651Sblueswir1@item -pidfile @var{file} 29066616b2adSStefan Weil@findex -pidfile 29075824d651Sblueswir1Store the QEMU process PID in @var{file}. It is useful if you launch QEMU 29085824d651Sblueswir1from a script. 29095824d651Sblueswir1ETEXI 29105824d651Sblueswir1 29111b530a6dSaurel32DEF("singlestep", 0, QEMU_OPTION_singlestep, \ 2912ad96090aSBlue Swirl "-singlestep always run in singlestep mode\n", QEMU_ARCH_ALL) 29131b530a6dSaurel32STEXI 29141b530a6dSaurel32@item -singlestep 29156616b2adSStefan Weil@findex -singlestep 29161b530a6dSaurel32Run the emulation in single step mode. 29171b530a6dSaurel32ETEXI 29181b530a6dSaurel32 29195824d651Sblueswir1DEF("S", 0, QEMU_OPTION_S, \ 2920ad96090aSBlue Swirl "-S freeze CPU at startup (use 'c' to start execution)\n", 2921ad96090aSBlue Swirl QEMU_ARCH_ALL) 29225824d651Sblueswir1STEXI 29235824d651Sblueswir1@item -S 29246616b2adSStefan Weil@findex -S 29255824d651Sblueswir1Do not start CPU at startup (you must type 'c' in the monitor). 29265824d651Sblueswir1ETEXI 29275824d651Sblueswir1 2928888a6bc6SSatoru MoriyaDEF("realtime", HAS_ARG, QEMU_OPTION_realtime, 2929888a6bc6SSatoru Moriya "-realtime [mlock=on|off]\n" 2930888a6bc6SSatoru Moriya " run qemu with realtime features\n" 2931888a6bc6SSatoru Moriya " mlock=on|off controls mlock support (default: on)\n", 2932888a6bc6SSatoru Moriya QEMU_ARCH_ALL) 2933888a6bc6SSatoru MoriyaSTEXI 2934888a6bc6SSatoru Moriya@item -realtime mlock=on|off 2935888a6bc6SSatoru Moriya@findex -realtime 2936888a6bc6SSatoru MoriyaRun qemu with realtime features. 2937888a6bc6SSatoru Moriyamlocking qemu and guest memory can be enabled via @option{mlock=on} 2938888a6bc6SSatoru Moriya(enabled by default). 2939888a6bc6SSatoru MoriyaETEXI 2940888a6bc6SSatoru Moriya 294159030a8cSaliguoriDEF("gdb", HAS_ARG, QEMU_OPTION_gdb, \ 2942ad96090aSBlue Swirl "-gdb dev wait for gdb connection on 'dev'\n", QEMU_ARCH_ALL) 29435824d651Sblueswir1STEXI 294459030a8cSaliguori@item -gdb @var{dev} 29456616b2adSStefan Weil@findex -gdb 294659030a8cSaliguoriWait for gdb connection on device @var{dev} (@pxref{gdb_usage}). Typical 294759030a8cSaliguoriconnections will likely be TCP-based, but also UDP, pseudo TTY, or even 2948b65ee4faSStefan Weilstdio are reasonable use case. The latter is allowing to start QEMU from 294959030a8cSaliguoriwithin gdb and establish the connection via a pipe: 295059030a8cSaliguori@example 29513804da9dSStefan Weil(gdb) target remote | exec qemu-system-i386 -gdb stdio ... 295259030a8cSaliguori@end example 29535824d651Sblueswir1ETEXI 29545824d651Sblueswir1 295559030a8cSaliguoriDEF("s", 0, QEMU_OPTION_s, \ 2956ad96090aSBlue Swirl "-s shorthand for -gdb tcp::" DEFAULT_GDBSTUB_PORT "\n", 2957ad96090aSBlue Swirl QEMU_ARCH_ALL) 29585824d651Sblueswir1STEXI 295959030a8cSaliguori@item -s 29606616b2adSStefan Weil@findex -s 296159030a8cSaliguoriShorthand for -gdb tcp::1234, i.e. open a gdbserver on TCP port 1234 296259030a8cSaliguori(@pxref{gdb_usage}). 29635824d651Sblueswir1ETEXI 29645824d651Sblueswir1 29655824d651Sblueswir1DEF("d", HAS_ARG, QEMU_OPTION_d, \ 2966989b697dSPeter Maydell "-d item1,... enable logging of specified items (use '-d help' for a list of log items)\n", 2967ad96090aSBlue Swirl QEMU_ARCH_ALL) 29685824d651Sblueswir1STEXI 2969989b697dSPeter Maydell@item -d @var{item1}[,...] 29706616b2adSStefan Weil@findex -d 2971989b697dSPeter MaydellEnable logging of specified items. Use '-d help' for a list of log items. 29725824d651Sblueswir1ETEXI 29735824d651Sblueswir1 2974c235d738SMatthew FernandezDEF("D", HAS_ARG, QEMU_OPTION_D, \ 2975989b697dSPeter Maydell "-D logfile output log to logfile (default stderr)\n", 2976c235d738SMatthew Fernandez QEMU_ARCH_ALL) 2977c235d738SMatthew FernandezSTEXI 29788bd383b4SStefan Weil@item -D @var{logfile} 2979c235d738SMatthew Fernandez@findex -D 2980989b697dSPeter MaydellOutput log in @var{logfile} instead of to stderr 2981c235d738SMatthew FernandezETEXI 2982c235d738SMatthew Fernandez 29835824d651Sblueswir1DEF("L", HAS_ARG, QEMU_OPTION_L, \ 2984ad96090aSBlue Swirl "-L path set the directory for the BIOS, VGA BIOS and keymaps\n", 2985ad96090aSBlue Swirl QEMU_ARCH_ALL) 29865824d651Sblueswir1STEXI 29875824d651Sblueswir1@item -L @var{path} 29886616b2adSStefan Weil@findex -L 29895824d651Sblueswir1Set the directory for the BIOS, VGA BIOS and keymaps. 29905824d651Sblueswir1ETEXI 29915824d651Sblueswir1 29925824d651Sblueswir1DEF("bios", HAS_ARG, QEMU_OPTION_bios, \ 2993ad96090aSBlue Swirl "-bios file set the filename for the BIOS\n", QEMU_ARCH_ALL) 29945824d651Sblueswir1STEXI 29955824d651Sblueswir1@item -bios @var{file} 29966616b2adSStefan Weil@findex -bios 29975824d651Sblueswir1Set the filename for the BIOS. 29985824d651Sblueswir1ETEXI 29995824d651Sblueswir1 30005824d651Sblueswir1DEF("enable-kvm", 0, QEMU_OPTION_enable_kvm, \ 3001ad96090aSBlue Swirl "-enable-kvm enable KVM full virtualization support\n", QEMU_ARCH_ALL) 30025824d651Sblueswir1STEXI 30035824d651Sblueswir1@item -enable-kvm 30046616b2adSStefan Weil@findex -enable-kvm 30055824d651Sblueswir1Enable KVM full virtualization support. This option is only available 30065824d651Sblueswir1if KVM support is enabled when compiling. 30075824d651Sblueswir1ETEXI 30085824d651Sblueswir1 3009e37630caSaliguoriDEF("xen-domid", HAS_ARG, QEMU_OPTION_xen_domid, 3010ad96090aSBlue Swirl "-xen-domid id specify xen guest domain id\n", QEMU_ARCH_ALL) 3011e37630caSaliguoriDEF("xen-create", 0, QEMU_OPTION_xen_create, 3012e37630caSaliguori "-xen-create create domain using xen hypercalls, bypassing xend\n" 3013ad96090aSBlue Swirl " warning: should not be used when xend is in use\n", 3014ad96090aSBlue Swirl QEMU_ARCH_ALL) 3015e37630caSaliguoriDEF("xen-attach", 0, QEMU_OPTION_xen_attach, 3016e37630caSaliguori "-xen-attach attach to existing xen domain\n" 3017b65ee4faSStefan Weil " xend will use this when starting QEMU\n", 3018ad96090aSBlue Swirl QEMU_ARCH_ALL) 301995d5f08bSStefan WeilSTEXI 302095d5f08bSStefan Weil@item -xen-domid @var{id} 30216616b2adSStefan Weil@findex -xen-domid 302295d5f08bSStefan WeilSpecify xen guest domain @var{id} (XEN only). 302395d5f08bSStefan Weil@item -xen-create 30246616b2adSStefan Weil@findex -xen-create 302595d5f08bSStefan WeilCreate domain using xen hypercalls, bypassing xend. 302695d5f08bSStefan WeilWarning: should not be used when xend is in use (XEN only). 302795d5f08bSStefan Weil@item -xen-attach 30286616b2adSStefan Weil@findex -xen-attach 302995d5f08bSStefan WeilAttach to existing xen domain. 3030b65ee4faSStefan Weilxend will use this when starting QEMU (XEN only). 303195d5f08bSStefan WeilETEXI 3032e37630caSaliguori 30335824d651Sblueswir1DEF("no-reboot", 0, QEMU_OPTION_no_reboot, \ 3034ad96090aSBlue Swirl "-no-reboot exit instead of rebooting\n", QEMU_ARCH_ALL) 30355824d651Sblueswir1STEXI 30365824d651Sblueswir1@item -no-reboot 30376616b2adSStefan Weil@findex -no-reboot 30385824d651Sblueswir1Exit instead of rebooting. 30395824d651Sblueswir1ETEXI 30405824d651Sblueswir1 30415824d651Sblueswir1DEF("no-shutdown", 0, QEMU_OPTION_no_shutdown, \ 3042ad96090aSBlue Swirl "-no-shutdown stop before shutdown\n", QEMU_ARCH_ALL) 30435824d651Sblueswir1STEXI 30445824d651Sblueswir1@item -no-shutdown 30456616b2adSStefan Weil@findex -no-shutdown 30465824d651Sblueswir1Don't exit QEMU on guest shutdown, but instead only stop the emulation. 30475824d651Sblueswir1This allows for instance switching to monitor to commit changes to the 30485824d651Sblueswir1disk image. 30495824d651Sblueswir1ETEXI 30505824d651Sblueswir1 30515824d651Sblueswir1DEF("loadvm", HAS_ARG, QEMU_OPTION_loadvm, \ 30525824d651Sblueswir1 "-loadvm [tag|id]\n" \ 3053ad96090aSBlue Swirl " start right away with a saved state (loadvm in monitor)\n", 3054ad96090aSBlue Swirl QEMU_ARCH_ALL) 30555824d651Sblueswir1STEXI 30565824d651Sblueswir1@item -loadvm @var{file} 30576616b2adSStefan Weil@findex -loadvm 30585824d651Sblueswir1Start right away with a saved state (@code{loadvm} in monitor) 30595824d651Sblueswir1ETEXI 30605824d651Sblueswir1 30615824d651Sblueswir1#ifndef _WIN32 30625824d651Sblueswir1DEF("daemonize", 0, QEMU_OPTION_daemonize, \ 3063ad96090aSBlue Swirl "-daemonize daemonize QEMU after initializing\n", QEMU_ARCH_ALL) 30645824d651Sblueswir1#endif 30655824d651Sblueswir1STEXI 30665824d651Sblueswir1@item -daemonize 30676616b2adSStefan Weil@findex -daemonize 30685824d651Sblueswir1Daemonize the QEMU process after initialization. QEMU will not detach from 30695824d651Sblueswir1standard IO until it is ready to receive connections on any of its devices. 30705824d651Sblueswir1This option is a useful way for external programs to launch QEMU without having 30715824d651Sblueswir1to cope with initialization race conditions. 30725824d651Sblueswir1ETEXI 30735824d651Sblueswir1 30745824d651Sblueswir1DEF("option-rom", HAS_ARG, QEMU_OPTION_option_rom, \ 3075ad96090aSBlue Swirl "-option-rom rom load a file, rom, into the option ROM space\n", 3076ad96090aSBlue Swirl QEMU_ARCH_ALL) 30775824d651Sblueswir1STEXI 30785824d651Sblueswir1@item -option-rom @var{file} 30796616b2adSStefan Weil@findex -option-rom 30805824d651Sblueswir1Load the contents of @var{file} as an option ROM. 30815824d651Sblueswir1This option is useful to load things like EtherBoot. 30825824d651Sblueswir1ETEXI 30835824d651Sblueswir1 3084e218052fSMarkus ArmbrusterHXCOMM Silently ignored for compatibility 3085e218052fSMarkus ArmbrusterDEF("clock", HAS_ARG, QEMU_OPTION_clock, "", QEMU_ARCH_ALL) 30865824d651Sblueswir1 30871ed2fc1fSJan KiszkaHXCOMM Options deprecated by -rtc 3088ad96090aSBlue SwirlDEF("localtime", 0, QEMU_OPTION_localtime, "", QEMU_ARCH_ALL) 3089ad96090aSBlue SwirlDEF("startdate", HAS_ARG, QEMU_OPTION_startdate, "", QEMU_ARCH_ALL) 30905824d651Sblueswir1 30911ed2fc1fSJan KiszkaDEF("rtc", HAS_ARG, QEMU_OPTION_rtc, \ 309278808141SPaolo Bonzini "-rtc [base=utc|localtime|date][,clock=host|rt|vm][,driftfix=none|slew]\n" \ 3093ad96090aSBlue Swirl " set the RTC base and clock, enable drift fix for clock ticks (x86 only)\n", 3094ad96090aSBlue Swirl QEMU_ARCH_ALL) 30951ed2fc1fSJan Kiszka 30965824d651Sblueswir1STEXI 30975824d651Sblueswir1 30986875204cSJan Kiszka@item -rtc [base=utc|localtime|@var{date}][,clock=host|vm][,driftfix=none|slew] 30996616b2adSStefan Weil@findex -rtc 31001ed2fc1fSJan KiszkaSpecify @option{base} as @code{utc} or @code{localtime} to let the RTC start at the current 31011ed2fc1fSJan KiszkaUTC or local time, respectively. @code{localtime} is required for correct date in 31021ed2fc1fSJan KiszkaMS-DOS or Windows. To start at a specific point in time, provide @var{date} in the 31031ed2fc1fSJan Kiszkaformat @code{2006-06-17T16:01:21} or @code{2006-06-17}. The default base is UTC. 31041ed2fc1fSJan Kiszka 31059d85d557SMichael TokarevBy default the RTC is driven by the host system time. This allows using of the 31066875204cSJan KiszkaRTC as accurate reference clock inside the guest, specifically if the host 31076875204cSJan Kiszkatime is smoothly following an accurate external reference clock, e.g. via NTP. 310878808141SPaolo BonziniIf you want to isolate the guest time from the host, you can set @option{clock} 310978808141SPaolo Bonzinito @code{rt} instead. To even prevent it from progressing during suspension, 311078808141SPaolo Bonziniyou can set it to @code{vm}. 31116875204cSJan Kiszka 31121ed2fc1fSJan KiszkaEnable @option{driftfix} (i386 targets only) if you experience time drift problems, 31131ed2fc1fSJan Kiszkaspecifically with Windows' ACPI HAL. This option will try to figure out how 31141ed2fc1fSJan Kiszkamany timer interrupts were not processed by the Windows guest and will 31151ed2fc1fSJan Kiszkare-inject them. 31165824d651Sblueswir1ETEXI 31175824d651Sblueswir1 31185824d651Sblueswir1DEF("icount", HAS_ARG, QEMU_OPTION_icount, \ 3119f1f4b57eSVictor CLEMENT "-icount [shift=N|auto][,align=on|off][,sleep=no]\n" \ 3120bc14ca24Saliguori " enable virtual instruction counter with 2^N clock ticks per\n" \ 3121f1f4b57eSVictor CLEMENT " instruction, enable aligning the host and virtual clocks\n" \ 3122f1f4b57eSVictor CLEMENT " or disable real time cpu sleeping\n", QEMU_ARCH_ALL) 31235824d651Sblueswir1STEXI 31241ad9580bSSebastian Tanase@item -icount [shift=@var{N}|auto] 31256616b2adSStefan Weil@findex -icount 31265824d651Sblueswir1Enable virtual instruction counter. The virtual cpu will execute one 31274e257e5eSKevin Wolfinstruction every 2^@var{N} ns of virtual time. If @code{auto} is specified 31285824d651Sblueswir1then the virtual cpu speed will be automatically adjusted to keep virtual 31295824d651Sblueswir1time within a few seconds of real time. 31305824d651Sblueswir1 3131f1f4b57eSVictor CLEMENTWhen the virtual cpu is sleeping, the virtual time will advance at default 3132f1f4b57eSVictor CLEMENTspeed unless @option{sleep=no} is specified. 3133f1f4b57eSVictor CLEMENTWith @option{sleep=no}, the virtual time will jump to the next timer deadline 3134f1f4b57eSVictor CLEMENTinstantly whenever the virtual cpu goes to sleep mode and will not advance 3135f1f4b57eSVictor CLEMENTif no timer is enabled. This behavior give deterministic execution times from 3136f1f4b57eSVictor CLEMENTthe guest point of view. 3137f1f4b57eSVictor CLEMENT 31385824d651Sblueswir1Note that while this option can give deterministic behavior, it does not 31395824d651Sblueswir1provide cycle accurate emulation. Modern CPUs contain superscalar out of 31405824d651Sblueswir1order cores with complex cache hierarchies. The number of instructions 31415824d651Sblueswir1executed often has little or no correlation with actual performance. 3142a8bfac37SSebastian Tanase 3143a8bfac37SSebastian Tanase@option{align=on} will activate the delay algorithm which will try to 3144a8bfac37SSebastian Tanaseto synchronise the host clock and the virtual clock. The goal is to 3145a8bfac37SSebastian Tanasehave a guest running at the real frequency imposed by the shift option. 3146a8bfac37SSebastian TanaseWhenever the guest clock is behind the host clock and if 314782597615SMichael Tokarev@option{align=on} is specified then we print a message to the user 3148a8bfac37SSebastian Tanaseto inform about the delay. 3149a8bfac37SSebastian TanaseCurrently this option does not work when @option{shift} is @code{auto}. 3150a8bfac37SSebastian TanaseNote: The sync algorithm will work for those shift values for which 3151a8bfac37SSebastian Tanasethe guest clock runs ahead of the host clock. Typically this happens 3152a8bfac37SSebastian Tanasewhen the shift value is high (how high depends on the host machine). 31535824d651Sblueswir1ETEXI 31545824d651Sblueswir1 31559dd986ccSRichard W.M. JonesDEF("watchdog", HAS_ARG, QEMU_OPTION_watchdog, \ 31569dd986ccSRichard W.M. Jones "-watchdog i6300esb|ib700\n" \ 3157ad96090aSBlue Swirl " enable virtual hardware watchdog [default=none]\n", 3158ad96090aSBlue Swirl QEMU_ARCH_ALL) 31599dd986ccSRichard W.M. JonesSTEXI 31609dd986ccSRichard W.M. Jones@item -watchdog @var{model} 31616616b2adSStefan Weil@findex -watchdog 31629dd986ccSRichard W.M. JonesCreate a virtual hardware watchdog device. Once enabled (by a guest 31639dd986ccSRichard W.M. Jonesaction), the watchdog must be periodically polled by an agent inside 31649dd986ccSRichard W.M. Jonesthe guest or else the guest will be restarted. 31659dd986ccSRichard W.M. Jones 31669dd986ccSRichard W.M. JonesThe @var{model} is the model of hardware watchdog to emulate. Choices 31679dd986ccSRichard W.M. Jonesfor model are: @code{ib700} (iBASE 700) which is a very simple ISA 31689dd986ccSRichard W.M. Joneswatchdog with a single timer, or @code{i6300esb} (Intel 6300ESB I/O 31699dd986ccSRichard W.M. Jonescontroller hub) which is a much more featureful PCI-based dual-timer 31709dd986ccSRichard W.M. Joneswatchdog. Choose a model for which your guest has drivers. 31719dd986ccSRichard W.M. Jones 3172585f6036SPeter MaydellUse @code{-watchdog help} to list available hardware models. Only one 31739dd986ccSRichard W.M. Joneswatchdog can be enabled for a guest. 31749dd986ccSRichard W.M. JonesETEXI 31759dd986ccSRichard W.M. Jones 31769dd986ccSRichard W.M. JonesDEF("watchdog-action", HAS_ARG, QEMU_OPTION_watchdog_action, \ 31779dd986ccSRichard W.M. Jones "-watchdog-action reset|shutdown|poweroff|pause|debug|none\n" \ 3178ad96090aSBlue Swirl " action when watchdog fires [default=reset]\n", 3179ad96090aSBlue Swirl QEMU_ARCH_ALL) 31809dd986ccSRichard W.M. JonesSTEXI 31819dd986ccSRichard W.M. Jones@item -watchdog-action @var{action} 3182b8f490ebSMarkus Armbruster@findex -watchdog-action 31839dd986ccSRichard W.M. Jones 31849dd986ccSRichard W.M. JonesThe @var{action} controls what QEMU will do when the watchdog timer 31859dd986ccSRichard W.M. Jonesexpires. 31869dd986ccSRichard W.M. JonesThe default is 31879dd986ccSRichard W.M. Jones@code{reset} (forcefully reset the guest). 31889dd986ccSRichard W.M. JonesOther possible actions are: 31899dd986ccSRichard W.M. Jones@code{shutdown} (attempt to gracefully shutdown the guest), 31909dd986ccSRichard W.M. Jones@code{poweroff} (forcefully poweroff the guest), 31919dd986ccSRichard W.M. Jones@code{pause} (pause the guest), 31929dd986ccSRichard W.M. Jones@code{debug} (print a debug message and continue), or 31939dd986ccSRichard W.M. Jones@code{none} (do nothing). 31949dd986ccSRichard W.M. Jones 31959dd986ccSRichard W.M. JonesNote that the @code{shutdown} action requires that the guest responds 31969dd986ccSRichard W.M. Jonesto ACPI signals, which it may not be able to do in the sort of 31979dd986ccSRichard W.M. Jonessituations where the watchdog would have expired, and thus 31989dd986ccSRichard W.M. Jones@code{-watchdog-action shutdown} is not recommended for production use. 31999dd986ccSRichard W.M. Jones 32009dd986ccSRichard W.M. JonesExamples: 32019dd986ccSRichard W.M. Jones 32029dd986ccSRichard W.M. Jones@table @code 32039dd986ccSRichard W.M. Jones@item -watchdog i6300esb -watchdog-action pause 32049dd986ccSRichard W.M. Jones@item -watchdog ib700 32059dd986ccSRichard W.M. Jones@end table 32069dd986ccSRichard W.M. JonesETEXI 32079dd986ccSRichard W.M. Jones 32085824d651Sblueswir1DEF("echr", HAS_ARG, QEMU_OPTION_echr, \ 3209ad96090aSBlue Swirl "-echr chr set terminal escape character instead of ctrl-a\n", 3210ad96090aSBlue Swirl QEMU_ARCH_ALL) 32115824d651Sblueswir1STEXI 32125824d651Sblueswir1 32134e257e5eSKevin Wolf@item -echr @var{numeric_ascii_value} 32146616b2adSStefan Weil@findex -echr 32155824d651Sblueswir1Change the escape character used for switching to the monitor when using 32165824d651Sblueswir1monitor and serial sharing. The default is @code{0x01} when using the 32175824d651Sblueswir1@code{-nographic} option. @code{0x01} is equal to pressing 32185824d651Sblueswir1@code{Control-a}. You can select a different character from the ascii 32195824d651Sblueswir1control keys where 1 through 26 map to Control-a through Control-z. For 32205824d651Sblueswir1instance you could use the either of the following to change the escape 32215824d651Sblueswir1character to Control-t. 32225824d651Sblueswir1@table @code 32235824d651Sblueswir1@item -echr 0x14 32245824d651Sblueswir1@item -echr 20 32255824d651Sblueswir1@end table 32265824d651Sblueswir1ETEXI 32275824d651Sblueswir1 32285824d651Sblueswir1DEF("virtioconsole", HAS_ARG, QEMU_OPTION_virtiocon, \ 32295824d651Sblueswir1 "-virtioconsole c\n" \ 3230ad96090aSBlue Swirl " set virtio console\n", QEMU_ARCH_ALL) 32315824d651Sblueswir1STEXI 32325824d651Sblueswir1@item -virtioconsole @var{c} 32336616b2adSStefan Weil@findex -virtioconsole 32345824d651Sblueswir1Set virtio console. 323598b19252SAmit Shah 323698b19252SAmit ShahThis option is maintained for backward compatibility. 323798b19252SAmit Shah 323898b19252SAmit ShahPlease use @code{-device virtconsole} for the new way of invocation. 32395824d651Sblueswir1ETEXI 32405824d651Sblueswir1 32415824d651Sblueswir1DEF("show-cursor", 0, QEMU_OPTION_show_cursor, \ 3242ad96090aSBlue Swirl "-show-cursor show cursor\n", QEMU_ARCH_ALL) 32435824d651Sblueswir1STEXI 324495d5f08bSStefan Weil@item -show-cursor 32456616b2adSStefan Weil@findex -show-cursor 324695d5f08bSStefan WeilShow cursor. 32475824d651Sblueswir1ETEXI 32485824d651Sblueswir1 32495824d651Sblueswir1DEF("tb-size", HAS_ARG, QEMU_OPTION_tb_size, \ 3250ad96090aSBlue Swirl "-tb-size n set TB size\n", QEMU_ARCH_ALL) 32515824d651Sblueswir1STEXI 325295d5f08bSStefan Weil@item -tb-size @var{n} 32536616b2adSStefan Weil@findex -tb-size 325495d5f08bSStefan WeilSet TB size. 32555824d651Sblueswir1ETEXI 32565824d651Sblueswir1 32575824d651Sblueswir1DEF("incoming", HAS_ARG, QEMU_OPTION_incoming, \ 32587c601803SMichael Tokarev "-incoming tcp:[host]:port[,to=maxport][,ipv4][,ipv6]\n" \ 32597c601803SMichael Tokarev "-incoming rdma:host:port[,ipv4][,ipv6]\n" \ 32607c601803SMichael Tokarev "-incoming unix:socketpath\n" \ 32617c601803SMichael Tokarev " prepare for incoming migration, listen on\n" \ 32627c601803SMichael Tokarev " specified protocol and socket address\n" \ 32637c601803SMichael Tokarev "-incoming fd:fd\n" \ 32647c601803SMichael Tokarev "-incoming exec:cmdline\n" \ 32657c601803SMichael Tokarev " accept incoming migration on given file descriptor\n" \ 32661597051bSDr. David Alan Gilbert " or from given external command\n" \ 32671597051bSDr. David Alan Gilbert "-incoming defer\n" \ 32681597051bSDr. David Alan Gilbert " wait for the URI to be specified via migrate_incoming\n", 3269ad96090aSBlue Swirl QEMU_ARCH_ALL) 32705824d651Sblueswir1STEXI 32717c601803SMichael Tokarev@item -incoming tcp:[@var{host}]:@var{port}[,to=@var{maxport}][,ipv4][,ipv6] 32727c601803SMichael Tokarev@item -incoming rdma:@var{host}:@var{port}[,ipv4][,ipv6] 32736616b2adSStefan Weil@findex -incoming 32747c601803SMichael TokarevPrepare for incoming migration, listen on a given tcp port. 32757c601803SMichael Tokarev 32767c601803SMichael Tokarev@item -incoming unix:@var{socketpath} 32777c601803SMichael TokarevPrepare for incoming migration, listen on a given unix socket. 32787c601803SMichael Tokarev 32797c601803SMichael Tokarev@item -incoming fd:@var{fd} 32807c601803SMichael TokarevAccept incoming migration from a given filedescriptor. 32817c601803SMichael Tokarev 32827c601803SMichael Tokarev@item -incoming exec:@var{cmdline} 32837c601803SMichael TokarevAccept incoming migration as an output from specified external command. 32841597051bSDr. David Alan Gilbert 32851597051bSDr. David Alan Gilbert@item -incoming defer 32861597051bSDr. David Alan GilbertWait for the URI to be specified via migrate_incoming. The monitor can 32871597051bSDr. David Alan Gilbertbe used to change settings (such as migration parameters) prior to issuing 32881597051bSDr. David Alan Gilbertthe migrate_incoming to allow the migration to begin. 32895824d651Sblueswir1ETEXI 32905824d651Sblueswir1 3291d8c208ddSGerd HoffmannDEF("nodefaults", 0, QEMU_OPTION_nodefaults, \ 3292ad96090aSBlue Swirl "-nodefaults don't create default devices\n", QEMU_ARCH_ALL) 3293d8c208ddSGerd HoffmannSTEXI 32943dbf2c7fSStefan Weil@item -nodefaults 32956616b2adSStefan Weil@findex -nodefaults 329666c19bf1SMichal NovotnyDon't create default devices. Normally, QEMU sets the default devices like serial 329766c19bf1SMichal Novotnyport, parallel port, virtual console, monitor device, VGA adapter, floppy and 329866c19bf1SMichal NovotnyCD-ROM drive and others. The @code{-nodefaults} option will disable all those 329966c19bf1SMichal Novotnydefault devices. 3300d8c208ddSGerd HoffmannETEXI 3301d8c208ddSGerd Hoffmann 33025824d651Sblueswir1#ifndef _WIN32 33035824d651Sblueswir1DEF("chroot", HAS_ARG, QEMU_OPTION_chroot, \ 3304ad96090aSBlue Swirl "-chroot dir chroot to dir just before starting the VM\n", 3305ad96090aSBlue Swirl QEMU_ARCH_ALL) 33065824d651Sblueswir1#endif 33075824d651Sblueswir1STEXI 33084e257e5eSKevin Wolf@item -chroot @var{dir} 33096616b2adSStefan Weil@findex -chroot 33105824d651Sblueswir1Immediately before starting guest execution, chroot to the specified 33115824d651Sblueswir1directory. Especially useful in combination with -runas. 33125824d651Sblueswir1ETEXI 33135824d651Sblueswir1 33145824d651Sblueswir1#ifndef _WIN32 33155824d651Sblueswir1DEF("runas", HAS_ARG, QEMU_OPTION_runas, \ 3316ad96090aSBlue Swirl "-runas user change to user id user just before starting the VM\n", 3317ad96090aSBlue Swirl QEMU_ARCH_ALL) 33185824d651Sblueswir1#endif 33195824d651Sblueswir1STEXI 33204e257e5eSKevin Wolf@item -runas @var{user} 33216616b2adSStefan Weil@findex -runas 33225824d651Sblueswir1Immediately before starting guest execution, drop root privileges, switching 33235824d651Sblueswir1to the specified user. 33245824d651Sblueswir1ETEXI 33255824d651Sblueswir1 33265824d651Sblueswir1DEF("prom-env", HAS_ARG, QEMU_OPTION_prom_env, 33275824d651Sblueswir1 "-prom-env variable=value\n" 3328ad96090aSBlue Swirl " set OpenBIOS nvram variables\n", 3329ad96090aSBlue Swirl QEMU_ARCH_PPC | QEMU_ARCH_SPARC) 333095d5f08bSStefan WeilSTEXI 333195d5f08bSStefan Weil@item -prom-env @var{variable}=@var{value} 33326616b2adSStefan Weil@findex -prom-env 333395d5f08bSStefan WeilSet OpenBIOS nvram @var{variable} to given @var{value} (PPC, SPARC only). 333495d5f08bSStefan WeilETEXI 33355824d651Sblueswir1DEF("semihosting", 0, QEMU_OPTION_semihosting, 3336f7bbcfb5SMichael Walle "-semihosting semihosting mode\n", 3337f7bbcfb5SMichael Walle QEMU_ARCH_ARM | QEMU_ARCH_M68K | QEMU_ARCH_XTENSA | QEMU_ARCH_LM32) 333895d5f08bSStefan WeilSTEXI 333995d5f08bSStefan Weil@item -semihosting 33406616b2adSStefan Weil@findex -semihosting 3341a38bb079SLiviu IonescuEnable semihosting mode (ARM, M68K, Xtensa only). 3342a38bb079SLiviu IonescuETEXI 3343a38bb079SLiviu IonescuDEF("semihosting-config", HAS_ARG, QEMU_OPTION_semihosting_config, 3344a38bb079SLiviu Ionescu "-semihosting-config [enable=on|off,]target=native|gdb|auto semihosting configuration\n", 3345a38bb079SLiviu IonescuQEMU_ARCH_ARM | QEMU_ARCH_M68K | QEMU_ARCH_XTENSA | QEMU_ARCH_LM32) 3346a38bb079SLiviu IonescuSTEXI 3347a38bb079SLiviu Ionescu@item -semihosting-config [enable=on|off,]target=native|gdb|auto 3348a38bb079SLiviu Ionescu@findex -semihosting-config 3349a38bb079SLiviu IonescuEnable semihosting and define where the semihosting calls will be addressed, 3350a38bb079SLiviu Ionescuto QEMU (@code{native}) or to GDB (@code{gdb}). The default is @code{auto}, which means 3351a38bb079SLiviu Ionescu@code{gdb} during debug sessions and @code{native} otherwise (ARM, M68K, Xtensa only). 335295d5f08bSStefan WeilETEXI 33535824d651Sblueswir1DEF("old-param", 0, QEMU_OPTION_old_param, 3354ad96090aSBlue Swirl "-old-param old param mode\n", QEMU_ARCH_ARM) 335595d5f08bSStefan WeilSTEXI 335695d5f08bSStefan Weil@item -old-param 33576616b2adSStefan Weil@findex -old-param (ARM) 335895d5f08bSStefan WeilOld param mode (ARM only). 335995d5f08bSStefan WeilETEXI 336095d5f08bSStefan Weil 33617d76ad4fSEduardo OtuboDEF("sandbox", HAS_ARG, QEMU_OPTION_sandbox, \ 33627d76ad4fSEduardo Otubo "-sandbox <arg> Enable seccomp mode 2 system call filter (default 'off').\n", 33637d76ad4fSEduardo Otubo QEMU_ARCH_ALL) 33647d76ad4fSEduardo OtuboSTEXI 33656265c43bSMarkus Armbruster@item -sandbox @var{arg} 33667d76ad4fSEduardo Otubo@findex -sandbox 33677d76ad4fSEduardo OtuboEnable Seccomp mode 2 system call filter. 'on' will enable syscall filtering and 'off' will 33687d76ad4fSEduardo Otubodisable it. The default is 'off'. 33697d76ad4fSEduardo OtuboETEXI 33707d76ad4fSEduardo Otubo 3371715a664aSGerd HoffmannDEF("readconfig", HAS_ARG, QEMU_OPTION_readconfig, 3372ad96090aSBlue Swirl "-readconfig <file>\n", QEMU_ARCH_ALL) 33733dbf2c7fSStefan WeilSTEXI 33743dbf2c7fSStefan Weil@item -readconfig @var{file} 33756616b2adSStefan Weil@findex -readconfig 3376ed24cfacSMichal NovotnyRead device configuration from @var{file}. This approach is useful when you want to spawn 3377ed24cfacSMichal NovotnyQEMU process with many command line options but you don't want to exceed the command line 3378ed24cfacSMichal Novotnycharacter limit. 33793dbf2c7fSStefan WeilETEXI 3380715a664aSGerd HoffmannDEF("writeconfig", HAS_ARG, QEMU_OPTION_writeconfig, 3381715a664aSGerd Hoffmann "-writeconfig <file>\n" 3382ad96090aSBlue Swirl " read/write config file\n", QEMU_ARCH_ALL) 33833dbf2c7fSStefan WeilSTEXI 33843dbf2c7fSStefan Weil@item -writeconfig @var{file} 33856616b2adSStefan Weil@findex -writeconfig 3386ed24cfacSMichal NovotnyWrite device configuration to @var{file}. The @var{file} can be either filename to save 3387ed24cfacSMichal Novotnycommand line and device configuration into file or dash @code{-}) character to print the 3388ed24cfacSMichal Novotnyoutput to stdout. This can be later used as input file for @code{-readconfig} option. 33893dbf2c7fSStefan WeilETEXI 3390292444cbSAnthony LiguoriDEF("nodefconfig", 0, QEMU_OPTION_nodefconfig, 3391292444cbSAnthony Liguori "-nodefconfig\n" 3392ad96090aSBlue Swirl " do not load default config files at startup\n", 3393ad96090aSBlue Swirl QEMU_ARCH_ALL) 3394292444cbSAnthony LiguoriSTEXI 3395292444cbSAnthony Liguori@item -nodefconfig 33966616b2adSStefan Weil@findex -nodefconfig 3397f29a5614SEduardo HabkostNormally QEMU loads configuration files from @var{sysconfdir} and @var{datadir} at startup. 3398f29a5614SEduardo HabkostThe @code{-nodefconfig} option will prevent QEMU from loading any of those config files. 3399f29a5614SEduardo HabkostETEXI 3400f29a5614SEduardo HabkostDEF("no-user-config", 0, QEMU_OPTION_nouserconfig, 3401f29a5614SEduardo Habkost "-no-user-config\n" 3402f29a5614SEduardo Habkost " do not load user-provided config files at startup\n", 3403f29a5614SEduardo Habkost QEMU_ARCH_ALL) 3404f29a5614SEduardo HabkostSTEXI 3405f29a5614SEduardo Habkost@item -no-user-config 3406f29a5614SEduardo Habkost@findex -no-user-config 3407f29a5614SEduardo HabkostThe @code{-no-user-config} option makes QEMU not load any of the user-provided 3408f29a5614SEduardo Habkostconfig files on @var{sysconfdir}, but won't make it skip the QEMU-provided config 3409f29a5614SEduardo Habkostfiles from @var{datadir}. 3410292444cbSAnthony LiguoriETEXI 3411ab6540d5SPrerna SaxenaDEF("trace", HAS_ARG, QEMU_OPTION_trace, 341223d15e86SLluís "-trace [events=<file>][,file=<file>]\n" 341323d15e86SLluís " specify tracing options\n", 3414ab6540d5SPrerna Saxena QEMU_ARCH_ALL) 3415ab6540d5SPrerna SaxenaSTEXI 341623d15e86SLluísHXCOMM This line is not accurate, as some sub-options are backend-specific but 341723d15e86SLluísHXCOMM HX does not support conditional compilation of text. 341823d15e86SLluís@item -trace [events=@var{file}][,file=@var{file}] 3419ab6540d5SPrerna Saxena@findex -trace 3420e4858974SLluís 342123d15e86SLluísSpecify tracing options. 342223d15e86SLluís 342323d15e86SLluís@table @option 342423d15e86SLluís@item events=@var{file} 342523d15e86SLluísImmediately enable events listed in @var{file}. 342623d15e86SLluísThe file must contain one event name (as listed in the @var{trace-events} file) 342723d15e86SLluísper line. 3428c1ba4e0bSStefan WeilThis option is only available if QEMU has been compiled with 3429c1ba4e0bSStefan Weileither @var{simple} or @var{stderr} tracing backend. 343023d15e86SLluís@item file=@var{file} 343123d15e86SLluísLog output traces to @var{file}. 343223d15e86SLluís 3433c1ba4e0bSStefan WeilThis option is only available if QEMU has been compiled with 3434c1ba4e0bSStefan Weilthe @var{simple} tracing backend. 343523d15e86SLluís@end table 3436ab6540d5SPrerna SaxenaETEXI 34373dbf2c7fSStefan Weil 343831e70d6cSMarkus ArmbrusterHXCOMM Internal use 343931e70d6cSMarkus ArmbrusterDEF("qtest", HAS_ARG, QEMU_OPTION_qtest, "", QEMU_ARCH_ALL) 344031e70d6cSMarkus ArmbrusterDEF("qtest-log", HAS_ARG, QEMU_OPTION_qtest_log, "", QEMU_ARCH_ALL) 3441c7f0f3b1SAnthony Liguori 34420f66998fSPaul Moore#ifdef __linux__ 34430f66998fSPaul MooreDEF("enable-fips", 0, QEMU_OPTION_enablefips, 34440f66998fSPaul Moore "-enable-fips enable FIPS 140-2 compliance\n", 34450f66998fSPaul Moore QEMU_ARCH_ALL) 34460f66998fSPaul Moore#endif 34470f66998fSPaul MooreSTEXI 34480f66998fSPaul Moore@item -enable-fips 34490f66998fSPaul Moore@findex -enable-fips 34500f66998fSPaul MooreEnable FIPS 140-2 compliance mode. 34510f66998fSPaul MooreETEXI 34520f66998fSPaul Moore 3453a0dac021SJan KiszkaHXCOMM Deprecated by -machine accel=tcg property 3454c6e88b3bSBruce RogersDEF("no-kvm", 0, QEMU_OPTION_no_kvm, "", QEMU_ARCH_I386) 3455a0dac021SJan Kiszka 3456c21fb4f8SJan KiszkaHXCOMM Deprecated by kvm-pit driver properties 3457c6e88b3bSBruce RogersDEF("no-kvm-pit-reinjection", 0, QEMU_OPTION_no_kvm_pit_reinjection, 3458c21fb4f8SJan Kiszka "", QEMU_ARCH_I386) 3459c21fb4f8SJan Kiszka 34604086bde8SJan KiszkaHXCOMM Deprecated (ignored) 3461c6e88b3bSBruce RogersDEF("no-kvm-pit", 0, QEMU_OPTION_no_kvm_pit, "", QEMU_ARCH_I386) 34624086bde8SJan Kiszka 3463e43d594eSJan KiszkaHXCOMM Deprecated by -machine kernel_irqchip=on|off property 3464c6e88b3bSBruce RogersDEF("no-kvm-irqchip", 0, QEMU_OPTION_no_kvm_irqchip, "", QEMU_ARCH_I386) 3465e43d594eSJan Kiszka 346688eed34aSJan KiszkaHXCOMM Deprecated (ignored) 346788eed34aSJan KiszkaDEF("tdf", 0, QEMU_OPTION_tdf,"", QEMU_ARCH_ALL) 346888eed34aSJan Kiszka 346968d98d3eSAnthony LiguoriDEF("object", HAS_ARG, QEMU_OPTION_object, 347068d98d3eSAnthony Liguori "-object TYPENAME[,PROP1=VALUE1,...]\n" 347168d98d3eSAnthony Liguori " create an new object of type TYPENAME setting properties\n" 347268d98d3eSAnthony Liguori " in the order they are specified. Note that the 'id'\n" 347368d98d3eSAnthony Liguori " property must be set. These objects are placed in the\n" 347468d98d3eSAnthony Liguori " '/objects' path.\n", 347568d98d3eSAnthony Liguori QEMU_ARCH_ALL) 34766265c43bSMarkus ArmbrusterSTEXI 34776265c43bSMarkus Armbruster@item -object @var{typename}[,@var{prop1}=@var{value1},...] 34786265c43bSMarkus Armbruster@findex -object 34796265c43bSMarkus ArmbrusterCreate an new object of type @var{typename} setting properties 34806265c43bSMarkus Armbrusterin the order they are specified. Note that the 'id' 34816265c43bSMarkus Armbrusterproperty must be set. These objects are placed in the 34826265c43bSMarkus Armbruster'/objects' path. 34836265c43bSMarkus ArmbrusterETEXI 348468d98d3eSAnthony Liguori 34855e2ac519SSeiji AguchiDEF("msg", HAS_ARG, QEMU_OPTION_msg, 34865e2ac519SSeiji Aguchi "-msg timestamp[=on|off]\n" 34875e2ac519SSeiji Aguchi " change the format of messages\n" 34885e2ac519SSeiji Aguchi " on|off controls leading timestamps (default:on)\n", 34895e2ac519SSeiji Aguchi QEMU_ARCH_ALL) 34905e2ac519SSeiji AguchiSTEXI 34915e2ac519SSeiji Aguchi@item -msg timestamp[=on|off] 34925e2ac519SSeiji Aguchi@findex -msg 34935e2ac519SSeiji Aguchiprepend a timestamp to each log message.(default:on) 34945e2ac519SSeiji AguchiETEXI 34955e2ac519SSeiji Aguchi 3496abfd9ce3SAmit ShahDEF("dump-vmstate", HAS_ARG, QEMU_OPTION_dump_vmstate, 3497abfd9ce3SAmit Shah "-dump-vmstate <file>\n" 3498abfd9ce3SAmit Shah " Output vmstate information in JSON format to file.\n" 3499abfd9ce3SAmit Shah " Use the scripts/vmstate-static-checker.py file to\n" 3500abfd9ce3SAmit Shah " check for possible regressions in migration code\n" 3501abfd9ce3SAmit Shah " by comparing two such vmstate dumps.", 3502abfd9ce3SAmit Shah QEMU_ARCH_ALL) 3503abfd9ce3SAmit ShahSTEXI 3504abfd9ce3SAmit Shah@item -dump-vmstate @var{file} 3505abfd9ce3SAmit Shah@findex -dump-vmstate 3506abfd9ce3SAmit ShahDump json-encoded vmstate information for current machine type to file 3507abfd9ce3SAmit Shahin @var{file} 3508abfd9ce3SAmit ShahETEXI 3509abfd9ce3SAmit Shah 35103dbf2c7fSStefan WeilHXCOMM This is the last statement. Insert new options before this line! 35113dbf2c7fSStefan WeilSTEXI 35123dbf2c7fSStefan Weil@end table 35133dbf2c7fSStefan WeilETEXI 3514