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" 40*2eb1cd07STony Krowiak " iommu=on|off controls emulated Intel IOMMU (VT-d) support (default=off)\n" 41*2eb1cd07STony Krowiak " aes-key-wrap=on|off controls support for AES key wrapping (default=on)\n" 42*2eb1cd07STony Krowiak " dea-key-wrap=on|off controls support for DEA key wrapping (default=on)\n", 4380f52a66SJan Kiszka QEMU_ARCH_ALL) 445824d651Sblueswir1STEXI 4580f52a66SJan Kiszka@item -machine [type=]@var{name}[,prop=@var{value}[,...]] 4680f52a66SJan Kiszka@findex -machine 47585f6036SPeter MaydellSelect the emulated machine by @var{name}. Use @code{-machine help} to list 4880f52a66SJan Kiszkaavailable machines. Supported machine properties are: 4980f52a66SJan Kiszka@table @option 5080f52a66SJan Kiszka@item accel=@var{accels1}[:@var{accels2}[:...]] 5180f52a66SJan KiszkaThis is used to enable an accelerator. Depending on the target architecture, 5280f52a66SJan Kiszkakvm, xen, or tcg can be available. By default, tcg is used. If there is more 5380f52a66SJan Kiszkathan one accelerator specified, the next one is used if the previous one fails 5480f52a66SJan Kiszkato initialize. 556a48ffaaSJan Kiszka@item kernel_irqchip=on|off 566a48ffaaSJan KiszkaEnables in-kernel irqchip support for the chosen accelerator when available. 57d1048befSDon Slutz@item vmport=on|off|auto 58d1048befSDon SlutzEnables emulation of VMWare IO port, for vmmouse etc. auto says to select the 59d1048befSDon Slutzvalue based on accel. For accel=xen the default is off otherwise the default 60d1048befSDon Slutzis on. 6139d6960aSJan Kiszka@item kvm_shadow_mem=size 6239d6960aSJan KiszkaDefines the size of the KVM shadow MMU. 63ddb97f1dSJason Baron@item dump-guest-core=on|off 64ddb97f1dSJason BaronInclude guest memory in a core dump. The default is on. 658490fc78SLuiz Capitulino@item mem-merge=on|off 668490fc78SLuiz CapitulinoEnables or disables memory merge support. This feature, when supported by 678490fc78SLuiz Capitulinothe host, de-duplicates identical memory pages among VMs instances 688490fc78SLuiz Capitulino(enabled by default). 69a52a7fdfSLe Tan@item iommu=on|off 70a52a7fdfSLe TanEnables or disables emulated Intel IOMMU (VT-d) support. The default is off. 71*2eb1cd07STony Krowiak@item aes-key-wrap=on|off 72*2eb1cd07STony KrowiakEnables or disables AES key wrapping support on s390-ccw hosts. This feature 73*2eb1cd07STony Krowiakcontrols whether AES wrapping keys will be created to allow 74*2eb1cd07STony Krowiakexecution of AES cryptographic functions. The default is on. 75*2eb1cd07STony Krowiak@item dea-key-wrap=on|off 76*2eb1cd07STony KrowiakEnables or disables DEA key wrapping support on s390-ccw hosts. This feature 77*2eb1cd07STony Krowiakcontrols whether DEA wrapping keys will be created to allow 78*2eb1cd07STony Krowiakexecution of DEA cryptographic functions. The default is on. 7980f52a66SJan Kiszka@end table 805824d651Sblueswir1ETEXI 815824d651Sblueswir1 8280f52a66SJan KiszkaHXCOMM Deprecated by -machine 8380f52a66SJan KiszkaDEF("M", HAS_ARG, QEMU_OPTION_M, "", QEMU_ARCH_ALL) 8480f52a66SJan Kiszka 855824d651Sblueswir1DEF("cpu", HAS_ARG, QEMU_OPTION_cpu, 86585f6036SPeter Maydell "-cpu cpu select CPU ('-cpu help' for list)\n", QEMU_ARCH_ALL) 875824d651Sblueswir1STEXI 885824d651Sblueswir1@item -cpu @var{model} 896616b2adSStefan Weil@findex -cpu 90585f6036SPeter MaydellSelect CPU model (@code{-cpu help} for list and additional feature selection) 915824d651Sblueswir1ETEXI 925824d651Sblueswir1 935824d651Sblueswir1DEF("smp", HAS_ARG, QEMU_OPTION_smp, 9412b7f57eSMichael Tokarev "-smp [cpus=]n[,maxcpus=cpus][,cores=cores][,threads=threads][,sockets=sockets]\n" 956be68d7eSJes Sorensen " set the number of CPUs to 'n' [default=1]\n" 966be68d7eSJes Sorensen " maxcpus= maximum number of total cpus, including\n" 97ca1a8a06SBruce Rogers " offline CPUs for hotplug, etc\n" 9858a04db1SAndre Przywara " cores= number of CPU cores on one socket\n" 9958a04db1SAndre Przywara " threads= number of threads on one CPU core\n" 100ad96090aSBlue Swirl " sockets= number of discrete sockets in the system\n", 101ad96090aSBlue Swirl QEMU_ARCH_ALL) 1025824d651Sblueswir1STEXI 10312b7f57eSMichael Tokarev@item -smp [cpus=]@var{n}[,cores=@var{cores}][,threads=@var{threads}][,sockets=@var{sockets}][,maxcpus=@var{maxcpus}] 1046616b2adSStefan Weil@findex -smp 1055824d651Sblueswir1Simulate an SMP system with @var{n} CPUs. On the PC target, up to 255 1065824d651Sblueswir1CPUs are supported. On Sparc32 target, Linux limits the number of usable CPUs 1075824d651Sblueswir1to 4. 10858a04db1SAndre PrzywaraFor the PC target, the number of @var{cores} per socket, the number 10958a04db1SAndre Przywaraof @var{threads} per cores and the total number of @var{sockets} can be 11058a04db1SAndre Przywaraspecified. Missing values will be computed. If any on the three values is 11158a04db1SAndre Przywaragiven, the total number of CPUs @var{n} can be omitted. @var{maxcpus} 11258a04db1SAndre Przywaraspecifies the maximum number of hotpluggable CPUs. 1135824d651Sblueswir1ETEXI 1145824d651Sblueswir1 115268a362cSaliguoriDEF("numa", HAS_ARG, QEMU_OPTION_numa, 1167febe36fSPaolo Bonzini "-numa node[,mem=size][,cpus=cpu[-cpu]][,nodeid=node]\n" 1177febe36fSPaolo Bonzini "-numa node[,memdev=id][,cpus=cpu[-cpu]][,nodeid=node]\n", QEMU_ARCH_ALL) 118268a362cSaliguoriSTEXI 1194932b897SLuiz Capitulino@item -numa node[,mem=@var{size}][,cpus=@var{cpu[-cpu]}][,nodeid=@var{node}] 1207febe36fSPaolo Bonzini@item -numa node[,memdev=@var{id}][,cpus=@var{cpu[-cpu]}][,nodeid=@var{node}] 1216616b2adSStefan Weil@findex -numa 1227febe36fSPaolo BonziniSimulate a multi node NUMA system. If @samp{mem}, @samp{memdev} 1234932b897SLuiz Capitulinoand @samp{cpus} are omitted, resources are split equally. Also, note 1244932b897SLuiz Capitulinothat the -@option{numa} option doesn't allocate any of the specified 1254932b897SLuiz Capitulinoresources. That is, it just assigns existing resources to NUMA nodes. This 1264932b897SLuiz Capitulinomeans that one still has to use the @option{-m}, @option{-smp} options 1277febe36fSPaolo Bonzinito allocate RAM and VCPUs respectively, and possibly @option{-object} 1287febe36fSPaolo Bonzinito specify the memory backend for the @samp{memdev} suboption. 1297febe36fSPaolo Bonzini 1307febe36fSPaolo Bonzini@samp{mem} and @samp{memdev} are mutually exclusive. Furthermore, if one 1317febe36fSPaolo Bonzininode uses @samp{memdev}, all of them have to use it. 132268a362cSaliguoriETEXI 133268a362cSaliguori 13410adb8beSMarkus ArmbrusterDEF("add-fd", HAS_ARG, QEMU_OPTION_add_fd, 13510adb8beSMarkus Armbruster "-add-fd fd=fd,set=set[,opaque=opaque]\n" 13610adb8beSMarkus Armbruster " Add 'fd' to fd 'set'\n", QEMU_ARCH_ALL) 13710adb8beSMarkus ArmbrusterSTEXI 13810adb8beSMarkus Armbruster@item -add-fd fd=@var{fd},set=@var{set}[,opaque=@var{opaque}] 13910adb8beSMarkus Armbruster@findex -add-fd 14010adb8beSMarkus Armbruster 14110adb8beSMarkus ArmbrusterAdd a file descriptor to an fd set. Valid options are: 14210adb8beSMarkus Armbruster 14310adb8beSMarkus Armbruster@table @option 14410adb8beSMarkus Armbruster@item fd=@var{fd} 14510adb8beSMarkus ArmbrusterThis option defines the file descriptor of which a duplicate is added to fd set. 14610adb8beSMarkus ArmbrusterThe file descriptor cannot be stdin, stdout, or stderr. 14710adb8beSMarkus Armbruster@item set=@var{set} 14810adb8beSMarkus ArmbrusterThis option defines the ID of the fd set to add the file descriptor to. 14910adb8beSMarkus Armbruster@item opaque=@var{opaque} 15010adb8beSMarkus ArmbrusterThis option defines a free-form string that can be used to describe @var{fd}. 15110adb8beSMarkus Armbruster@end table 15210adb8beSMarkus Armbruster 15310adb8beSMarkus ArmbrusterYou can open an image using pre-opened file descriptors from an fd set: 15410adb8beSMarkus Armbruster@example 15510adb8beSMarkus Armbrusterqemu-system-i386 15610adb8beSMarkus Armbruster-add-fd fd=3,set=2,opaque="rdwr:/path/to/file" 15710adb8beSMarkus Armbruster-add-fd fd=4,set=2,opaque="rdonly:/path/to/file" 15810adb8beSMarkus Armbruster-drive file=/dev/fdset/2,index=0,media=disk 15910adb8beSMarkus Armbruster@end example 16010adb8beSMarkus ArmbrusterETEXI 16110adb8beSMarkus Armbruster 16210adb8beSMarkus ArmbrusterDEF("set", HAS_ARG, QEMU_OPTION_set, 16310adb8beSMarkus Armbruster "-set group.id.arg=value\n" 16410adb8beSMarkus Armbruster " set <arg> parameter for item <id> of type <group>\n" 16510adb8beSMarkus Armbruster " i.e. -set drive.$id.file=/path/to/image\n", QEMU_ARCH_ALL) 16610adb8beSMarkus ArmbrusterSTEXI 16710adb8beSMarkus Armbruster@item -set @var{group}.@var{id}.@var{arg}=@var{value} 16810adb8beSMarkus Armbruster@findex -set 16910adb8beSMarkus ArmbrusterSet parameter @var{arg} for item @var{id} of type @var{group}\n" 17010adb8beSMarkus ArmbrusterETEXI 17110adb8beSMarkus Armbruster 17210adb8beSMarkus ArmbrusterDEF("global", HAS_ARG, QEMU_OPTION_global, 17310adb8beSMarkus Armbruster "-global driver.prop=value\n" 17410adb8beSMarkus Armbruster " set a global default for a driver property\n", 17510adb8beSMarkus Armbruster QEMU_ARCH_ALL) 17610adb8beSMarkus ArmbrusterSTEXI 17710adb8beSMarkus Armbruster@item -global @var{driver}.@var{prop}=@var{value} 17810adb8beSMarkus Armbruster@findex -global 17910adb8beSMarkus ArmbrusterSet default value of @var{driver}'s property @var{prop} to @var{value}, e.g.: 18010adb8beSMarkus Armbruster 18110adb8beSMarkus Armbruster@example 18210adb8beSMarkus Armbrusterqemu-system-i386 -global ide-drive.physical_block_size=4096 -drive file=file,if=ide,index=0,media=disk 18310adb8beSMarkus Armbruster@end example 18410adb8beSMarkus Armbruster 18510adb8beSMarkus ArmbrusterIn particular, you can use this to set driver properties for devices which are 18610adb8beSMarkus Armbrustercreated automatically by the machine model. To create a device which is not 18710adb8beSMarkus Armbrustercreated automatically and set properties on it, use -@option{device}. 18810adb8beSMarkus ArmbrusterETEXI 18910adb8beSMarkus Armbruster 19010adb8beSMarkus ArmbrusterDEF("boot", HAS_ARG, QEMU_OPTION_boot, 19110adb8beSMarkus Armbruster "-boot [order=drives][,once=drives][,menu=on|off]\n" 192c8a6ae8bSAmos Kong " [,splash=sp_name][,splash-time=sp_time][,reboot-timeout=rb_time][,strict=on|off]\n" 19310adb8beSMarkus Armbruster " 'drives': floppy (a), hard disk (c), CD-ROM (d), network (n)\n" 19410adb8beSMarkus Armbruster " 'sp_name': the file's name that would be passed to bios as logo picture, if menu=on\n" 19510adb8beSMarkus Armbruster " 'sp_time': the period that splash picture last if menu=on, unit is ms\n" 19610adb8beSMarkus Armbruster " 'rb_timeout': the timeout before guest reboot when boot failed, unit is ms\n", 19710adb8beSMarkus Armbruster QEMU_ARCH_ALL) 19810adb8beSMarkus ArmbrusterSTEXI 199c8a6ae8bSAmos 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] 20010adb8beSMarkus Armbruster@findex -boot 20110adb8beSMarkus ArmbrusterSpecify boot order @var{drives} as a string of drive letters. Valid 20210adb8beSMarkus Armbrusterdrive letters depend on the target achitecture. The x86 PC uses: a, b 20310adb8beSMarkus Armbruster(floppy 1 and 2), c (first hard disk), d (first CD-ROM), n-p (Etherboot 20410adb8beSMarkus Armbrusterfrom network adapter 1-4), hard disk boot is the default. To apply a 20510adb8beSMarkus Armbrusterparticular boot order only on the first startup, specify it via 20610adb8beSMarkus Armbruster@option{once}. 20710adb8beSMarkus Armbruster 20810adb8beSMarkus ArmbrusterInteractive boot menus/prompts can be enabled via @option{menu=on} as far 20910adb8beSMarkus Armbrusteras firmware/BIOS supports them. The default is non-interactive boot. 21010adb8beSMarkus Armbruster 21110adb8beSMarkus ArmbrusterA splash picture could be passed to bios, enabling user to show it as logo, 21210adb8beSMarkus Armbrusterwhen option splash=@var{sp_name} is given and menu=on, If firmware/BIOS 21310adb8beSMarkus Armbrustersupports them. Currently Seabios for X86 system support it. 21410adb8beSMarkus Armbrusterlimitation: The splash file could be a jpeg file or a BMP file in 24 BPP 21510adb8beSMarkus Armbrusterformat(true color). The resolution should be supported by the SVGA mode, so 21610adb8beSMarkus Armbrusterthe recommended is 320x240, 640x480, 800x640. 21710adb8beSMarkus Armbruster 21810adb8beSMarkus ArmbrusterA timeout could be passed to bios, guest will pause for @var{rb_timeout} ms 21910adb8beSMarkus Armbrusterwhen boot failed, then reboot. If @var{rb_timeout} is '-1', guest will not 22010adb8beSMarkus Armbrusterreboot, qemu passes '-1' to bios by default. Currently Seabios for X86 22110adb8beSMarkus Armbrustersystem support it. 22210adb8beSMarkus Armbruster 223c8a6ae8bSAmos KongDo strict boot via @option{strict=on} as far as firmware/BIOS 224c8a6ae8bSAmos Kongsupports it. This only effects when boot priority is changed by 225c8a6ae8bSAmos Kongbootindex options. The default is non-strict boot. 226c8a6ae8bSAmos Kong 22710adb8beSMarkus Armbruster@example 22810adb8beSMarkus Armbruster# try to boot from network first, then from hard disk 22910adb8beSMarkus Armbrusterqemu-system-i386 -boot order=nc 23010adb8beSMarkus Armbruster# boot from CD-ROM first, switch back to default order after reboot 23110adb8beSMarkus Armbrusterqemu-system-i386 -boot once=d 23210adb8beSMarkus Armbruster# boot with a splash picture for 5 seconds. 23310adb8beSMarkus Armbrusterqemu-system-i386 -boot menu=on,splash=/root/boot.bmp,splash-time=5000 23410adb8beSMarkus Armbruster@end example 23510adb8beSMarkus Armbruster 23610adb8beSMarkus ArmbrusterNote: The legacy format '-boot @var{drives}' is still supported but its 23710adb8beSMarkus Armbrusteruse is discouraged as it may be removed from future versions. 23810adb8beSMarkus ArmbrusterETEXI 23910adb8beSMarkus Armbruster 24010adb8beSMarkus ArmbrusterDEF("m", HAS_ARG, QEMU_OPTION_m, 241c270fb9eSIgor Mammedov "-m[emory] [size=]megs[,slots=n,maxmem=size]\n" 2426e1d3c1cSIgor Mammedov " configure guest RAM\n" 2436e1d3c1cSIgor Mammedov " size: initial amount of guest memory (default: " 244c270fb9eSIgor Mammedov stringify(DEFAULT_RAM_SIZE) "MiB)\n" 245c270fb9eSIgor Mammedov " slots: number of hotplug slots (default: none)\n" 246b6fe0124SMatthew Rosato " maxmem: maximum amount of guest memory (default: none)\n" 247b6fe0124SMatthew Rosato "NOTE: Some architectures might enforce a specific granularity\n", 2486e1d3c1cSIgor Mammedov QEMU_ARCH_ALL) 24910adb8beSMarkus ArmbrusterSTEXI 2509fcc0794SLuiz Capitulino@item -m [size=]@var{megs}[,slots=n,maxmem=size] 25110adb8beSMarkus Armbruster@findex -m 2529fcc0794SLuiz CapitulinoSets guest startup RAM size to @var{megs} megabytes. Default is 128 MiB. 2539fcc0794SLuiz CapitulinoOptionally, a suffix of ``M'' or ``G'' can be used to signify a value in 2549fcc0794SLuiz Capitulinomegabytes or gigabytes respectively. Optional pair @var{slots}, @var{maxmem} 2559fcc0794SLuiz Capitulinocould be used to set amount of hotpluggable memory slots and maximum amount of 2569fcc0794SLuiz Capitulinomemory. Note that @var{maxmem} must be aligned to the page size. 2579fcc0794SLuiz Capitulino 2589fcc0794SLuiz CapitulinoFor example, the following command-line sets the guest startup RAM size to 2599fcc0794SLuiz Capitulino1GB, creates 3 slots to hotplug additional memory and sets the maximum 2609fcc0794SLuiz Capitulinomemory the guest can reach to 4GB: 2619fcc0794SLuiz Capitulino 2629fcc0794SLuiz Capitulino@example 2639fcc0794SLuiz Capitulinoqemu-system-x86_64 -m 1G,slots=3,maxmem=4G 2649fcc0794SLuiz Capitulino@end example 2659fcc0794SLuiz Capitulino 2669fcc0794SLuiz CapitulinoIf @var{slots} and @var{maxmem} are not specified, memory hotplug won't 2679fcc0794SLuiz Capitulinobe enabled and the guest startup RAM will never increase. 26810adb8beSMarkus ArmbrusterETEXI 26910adb8beSMarkus Armbruster 27010adb8beSMarkus ArmbrusterDEF("mem-path", HAS_ARG, QEMU_OPTION_mempath, 27110adb8beSMarkus Armbruster "-mem-path FILE provide backing storage for guest RAM\n", QEMU_ARCH_ALL) 27210adb8beSMarkus ArmbrusterSTEXI 27310adb8beSMarkus Armbruster@item -mem-path @var{path} 27410adb8beSMarkus Armbruster@findex -mem-path 27510adb8beSMarkus ArmbrusterAllocate guest RAM from a temporarily created file in @var{path}. 27610adb8beSMarkus ArmbrusterETEXI 27710adb8beSMarkus Armbruster 27810adb8beSMarkus ArmbrusterDEF("mem-prealloc", 0, QEMU_OPTION_mem_prealloc, 27910adb8beSMarkus Armbruster "-mem-prealloc preallocate guest memory (use with -mem-path)\n", 28010adb8beSMarkus Armbruster QEMU_ARCH_ALL) 28110adb8beSMarkus ArmbrusterSTEXI 28210adb8beSMarkus Armbruster@item -mem-prealloc 28310adb8beSMarkus Armbruster@findex -mem-prealloc 28410adb8beSMarkus ArmbrusterPreallocate memory when using -mem-path. 28510adb8beSMarkus ArmbrusterETEXI 28610adb8beSMarkus Armbruster 28710adb8beSMarkus ArmbrusterDEF("k", HAS_ARG, QEMU_OPTION_k, 28810adb8beSMarkus Armbruster "-k language use keyboard layout (for example 'fr' for French)\n", 28910adb8beSMarkus Armbruster QEMU_ARCH_ALL) 29010adb8beSMarkus ArmbrusterSTEXI 29110adb8beSMarkus Armbruster@item -k @var{language} 29210adb8beSMarkus Armbruster@findex -k 29310adb8beSMarkus ArmbrusterUse keyboard layout @var{language} (for example @code{fr} for 29410adb8beSMarkus ArmbrusterFrench). This option is only needed where it is not easy to get raw PC 29510adb8beSMarkus Armbrusterkeycodes (e.g. on Macs, with some X11 servers or with a VNC 29610adb8beSMarkus Armbrusterdisplay). You don't normally need to use it on PC/Linux or PC/Windows 29710adb8beSMarkus Armbrusterhosts. 29810adb8beSMarkus Armbruster 29910adb8beSMarkus ArmbrusterThe available layouts are: 30010adb8beSMarkus Armbruster@example 30110adb8beSMarkus Armbrusterar de-ch es fo fr-ca hu ja mk no pt-br sv 30210adb8beSMarkus Armbrusterda en-gb et fr fr-ch is lt nl pl ru th 30310adb8beSMarkus Armbrusterde en-us fi fr-be hr it lv nl-be pt sl tr 30410adb8beSMarkus Armbruster@end example 30510adb8beSMarkus Armbruster 30610adb8beSMarkus ArmbrusterThe default is @code{en-us}. 30710adb8beSMarkus ArmbrusterETEXI 30810adb8beSMarkus Armbruster 30910adb8beSMarkus Armbruster 31010adb8beSMarkus ArmbrusterDEF("audio-help", 0, QEMU_OPTION_audio_help, 31110adb8beSMarkus Armbruster "-audio-help print list of audio drivers and their options\n", 31210adb8beSMarkus Armbruster QEMU_ARCH_ALL) 31310adb8beSMarkus ArmbrusterSTEXI 31410adb8beSMarkus Armbruster@item -audio-help 31510adb8beSMarkus Armbruster@findex -audio-help 31610adb8beSMarkus ArmbrusterWill show the audio subsystem help: list of drivers, tunable 31710adb8beSMarkus Armbrusterparameters. 31810adb8beSMarkus ArmbrusterETEXI 31910adb8beSMarkus Armbruster 32010adb8beSMarkus ArmbrusterDEF("soundhw", HAS_ARG, QEMU_OPTION_soundhw, 32110adb8beSMarkus Armbruster "-soundhw c1,... enable audio support\n" 32210adb8beSMarkus Armbruster " and only specified sound cards (comma separated list)\n" 32310adb8beSMarkus Armbruster " use '-soundhw help' to get the list of supported cards\n" 32410adb8beSMarkus Armbruster " use '-soundhw all' to enable all of them\n", QEMU_ARCH_ALL) 32510adb8beSMarkus ArmbrusterSTEXI 32610adb8beSMarkus Armbruster@item -soundhw @var{card1}[,@var{card2},...] or -soundhw all 32710adb8beSMarkus Armbruster@findex -soundhw 32810adb8beSMarkus ArmbrusterEnable audio and selected sound hardware. Use 'help' to print all 32910adb8beSMarkus Armbrusteravailable sound hardware. 33010adb8beSMarkus Armbruster 33110adb8beSMarkus Armbruster@example 33210adb8beSMarkus Armbrusterqemu-system-i386 -soundhw sb16,adlib disk.img 33310adb8beSMarkus Armbrusterqemu-system-i386 -soundhw es1370 disk.img 33410adb8beSMarkus Armbrusterqemu-system-i386 -soundhw ac97 disk.img 33510adb8beSMarkus Armbrusterqemu-system-i386 -soundhw hda disk.img 33610adb8beSMarkus Armbrusterqemu-system-i386 -soundhw all disk.img 33710adb8beSMarkus Armbrusterqemu-system-i386 -soundhw help 33810adb8beSMarkus Armbruster@end example 33910adb8beSMarkus Armbruster 34010adb8beSMarkus ArmbrusterNote that Linux's i810_audio OSS kernel (for AC97) module might 34110adb8beSMarkus Armbrusterrequire manually specifying clocking. 34210adb8beSMarkus Armbruster 34310adb8beSMarkus Armbruster@example 34410adb8beSMarkus Armbrustermodprobe i810_audio clocking=48000 34510adb8beSMarkus Armbruster@end example 34610adb8beSMarkus ArmbrusterETEXI 34710adb8beSMarkus Armbruster 34810adb8beSMarkus ArmbrusterDEF("balloon", HAS_ARG, QEMU_OPTION_balloon, 34910adb8beSMarkus Armbruster "-balloon none disable balloon device\n" 35010adb8beSMarkus Armbruster "-balloon virtio[,addr=str]\n" 35110adb8beSMarkus Armbruster " enable virtio balloon device (default)\n", QEMU_ARCH_ALL) 35210adb8beSMarkus ArmbrusterSTEXI 35310adb8beSMarkus Armbruster@item -balloon none 35410adb8beSMarkus Armbruster@findex -balloon 35510adb8beSMarkus ArmbrusterDisable balloon device. 35610adb8beSMarkus Armbruster@item -balloon virtio[,addr=@var{addr}] 35710adb8beSMarkus ArmbrusterEnable virtio balloon device (default), optionally with PCI address 35810adb8beSMarkus Armbruster@var{addr}. 35910adb8beSMarkus ArmbrusterETEXI 36010adb8beSMarkus Armbruster 36110adb8beSMarkus ArmbrusterDEF("device", HAS_ARG, QEMU_OPTION_device, 36210adb8beSMarkus Armbruster "-device driver[,prop[=value][,...]]\n" 36310adb8beSMarkus Armbruster " add device (based on driver)\n" 36410adb8beSMarkus Armbruster " prop=value,... sets driver properties\n" 36510adb8beSMarkus Armbruster " use '-device help' to print all possible drivers\n" 36610adb8beSMarkus Armbruster " use '-device driver,help' to print all possible properties\n", 36710adb8beSMarkus Armbruster QEMU_ARCH_ALL) 36810adb8beSMarkus ArmbrusterSTEXI 36910adb8beSMarkus Armbruster@item -device @var{driver}[,@var{prop}[=@var{value}][,...]] 37010adb8beSMarkus Armbruster@findex -device 37110adb8beSMarkus ArmbrusterAdd device @var{driver}. @var{prop}=@var{value} sets driver 37210adb8beSMarkus Armbrusterproperties. Valid properties depend on the driver. To get help on 37310adb8beSMarkus Armbrusterpossible drivers and properties, use @code{-device help} and 37410adb8beSMarkus Armbruster@code{-device @var{driver},help}. 37510adb8beSMarkus ArmbrusterETEXI 37610adb8beSMarkus Armbruster 37710adb8beSMarkus ArmbrusterDEF("name", HAS_ARG, QEMU_OPTION_name, 3788f480de0SDr. David Alan Gilbert "-name string1[,process=string2][,debug-threads=on|off]\n" 37910adb8beSMarkus Armbruster " set the name of the guest\n" 3808f480de0SDr. David Alan Gilbert " string1 sets the window title and string2 the process name (on Linux)\n" 3818f480de0SDr. David Alan Gilbert " When debug-threads is enabled, individual threads are given a separate name (on Linux)\n" 3828f480de0SDr. David Alan Gilbert " NOTE: The thread names are for debugging and not a stable API.\n", 38310adb8beSMarkus Armbruster QEMU_ARCH_ALL) 38410adb8beSMarkus ArmbrusterSTEXI 38510adb8beSMarkus Armbruster@item -name @var{name} 38610adb8beSMarkus Armbruster@findex -name 38710adb8beSMarkus ArmbrusterSets the @var{name} of the guest. 38810adb8beSMarkus ArmbrusterThis name will be displayed in the SDL window caption. 38910adb8beSMarkus ArmbrusterThe @var{name} will also be used for the VNC server. 39010adb8beSMarkus ArmbrusterAlso optionally set the top visible process name in Linux. 3918f480de0SDr. David Alan GilbertNaming of individual threads can also be enabled on Linux to aid debugging. 39210adb8beSMarkus ArmbrusterETEXI 39310adb8beSMarkus Armbruster 39410adb8beSMarkus ArmbrusterDEF("uuid", HAS_ARG, QEMU_OPTION_uuid, 39510adb8beSMarkus Armbruster "-uuid %08x-%04x-%04x-%04x-%012x\n" 39610adb8beSMarkus Armbruster " specify machine UUID\n", QEMU_ARCH_ALL) 39710adb8beSMarkus ArmbrusterSTEXI 39810adb8beSMarkus Armbruster@item -uuid @var{uuid} 39910adb8beSMarkus Armbruster@findex -uuid 40010adb8beSMarkus ArmbrusterSet system UUID. 40110adb8beSMarkus ArmbrusterETEXI 40210adb8beSMarkus Armbruster 40310adb8beSMarkus ArmbrusterSTEXI 40410adb8beSMarkus Armbruster@end table 40510adb8beSMarkus ArmbrusterETEXI 40610adb8beSMarkus ArmbrusterDEFHEADING() 40710adb8beSMarkus Armbruster 40810adb8beSMarkus ArmbrusterDEFHEADING(Block device options:) 40910adb8beSMarkus ArmbrusterSTEXI 41010adb8beSMarkus Armbruster@table @option 41110adb8beSMarkus ArmbrusterETEXI 41210adb8beSMarkus Armbruster 4135824d651Sblueswir1DEF("fda", HAS_ARG, QEMU_OPTION_fda, 414ad96090aSBlue Swirl "-fda/-fdb file use 'file' as floppy disk 0/1 image\n", QEMU_ARCH_ALL) 415ad96090aSBlue SwirlDEF("fdb", HAS_ARG, QEMU_OPTION_fdb, "", QEMU_ARCH_ALL) 4165824d651Sblueswir1STEXI 4175824d651Sblueswir1@item -fda @var{file} 4185824d651Sblueswir1@item -fdb @var{file} 4196616b2adSStefan Weil@findex -fda 4206616b2adSStefan Weil@findex -fdb 4215824d651Sblueswir1Use @var{file} as floppy disk 0/1 image (@pxref{disk_images}). You can 4225824d651Sblueswir1use the host floppy by using @file{/dev/fd0} as filename (@pxref{host_drives}). 4235824d651Sblueswir1ETEXI 4245824d651Sblueswir1 4255824d651Sblueswir1DEF("hda", HAS_ARG, QEMU_OPTION_hda, 426ad96090aSBlue Swirl "-hda/-hdb file use 'file' as IDE hard disk 0/1 image\n", QEMU_ARCH_ALL) 427ad96090aSBlue SwirlDEF("hdb", HAS_ARG, QEMU_OPTION_hdb, "", QEMU_ARCH_ALL) 4285824d651Sblueswir1DEF("hdc", HAS_ARG, QEMU_OPTION_hdc, 429ad96090aSBlue Swirl "-hdc/-hdd file use 'file' as IDE hard disk 2/3 image\n", QEMU_ARCH_ALL) 430ad96090aSBlue SwirlDEF("hdd", HAS_ARG, QEMU_OPTION_hdd, "", QEMU_ARCH_ALL) 4315824d651Sblueswir1STEXI 4325824d651Sblueswir1@item -hda @var{file} 4335824d651Sblueswir1@item -hdb @var{file} 4345824d651Sblueswir1@item -hdc @var{file} 4355824d651Sblueswir1@item -hdd @var{file} 4366616b2adSStefan Weil@findex -hda 4376616b2adSStefan Weil@findex -hdb 4386616b2adSStefan Weil@findex -hdc 4396616b2adSStefan Weil@findex -hdd 4405824d651Sblueswir1Use @var{file} as hard disk 0, 1, 2 or 3 image (@pxref{disk_images}). 4415824d651Sblueswir1ETEXI 4425824d651Sblueswir1 4435824d651Sblueswir1DEF("cdrom", HAS_ARG, QEMU_OPTION_cdrom, 444ad96090aSBlue Swirl "-cdrom file use 'file' as IDE cdrom image (cdrom is ide1 master)\n", 445ad96090aSBlue Swirl QEMU_ARCH_ALL) 4465824d651Sblueswir1STEXI 4475824d651Sblueswir1@item -cdrom @var{file} 4486616b2adSStefan Weil@findex -cdrom 4495824d651Sblueswir1Use @var{file} as CD-ROM image (you cannot use @option{-hdc} and 4505824d651Sblueswir1@option{-cdrom} at the same time). You can use the host CD-ROM by 4515824d651Sblueswir1using @file{/dev/cdrom} as filename (@pxref{host_drives}). 4525824d651Sblueswir1ETEXI 4535824d651Sblueswir1 4545824d651Sblueswir1DEF("drive", HAS_ARG, QEMU_OPTION_drive, 4555824d651Sblueswir1 "-drive [file=file][,if=type][,bus=n][,unit=m][,media=d][,index=i]\n" 4565824d651Sblueswir1 " [,cyls=c,heads=h,secs=s[,trans=t]][,snapshot=on|off]\n" 45792196b2fSStefan Hajnoczi " [,cache=writethrough|writeback|none|directsync|unsafe][,format=f]\n" 458d1db760dSStefan Hajnoczi " [,serial=s][,addr=A][,rerror=ignore|stop|report]\n" 459d1db760dSStefan Hajnoczi " [,werror=ignore|stop|report|enospc][,id=name][,aio=threads|native]\n" 460fb0490f6SStefan Hajnoczi " [,readonly=on|off][,copy-on-read=on|off]\n" 4612f7133b2SPeter Lieven " [,discard=ignore|unmap][,detect-zeroes=on|off|unmap]\n" 4623e9fab69SBenoît Canet " [[,bps=b]|[[,bps_rd=r][,bps_wr=w]]]\n" 4633e9fab69SBenoît Canet " [[,iops=i]|[[,iops_rd=r][,iops_wr=w]]]\n" 4643e9fab69SBenoît Canet " [[,bps_max=bm]|[[,bps_rd_max=rm][,bps_wr_max=wm]]]\n" 4653e9fab69SBenoît Canet " [[,iops_max=im]|[[,iops_rd_max=irm][,iops_wr_max=iwm]]]\n" 4662024c1dfSBenoît Canet " [[,iops_size=is]]\n" 467ad96090aSBlue Swirl " use 'file' as a drive image\n", QEMU_ARCH_ALL) 4685824d651Sblueswir1STEXI 4695824d651Sblueswir1@item -drive @var{option}[,@var{option}[,@var{option}[,...]]] 4706616b2adSStefan Weil@findex -drive 4715824d651Sblueswir1 4725824d651Sblueswir1Define a new drive. Valid options are: 4735824d651Sblueswir1 474b3f046c2SKevin Wolf@table @option 4755824d651Sblueswir1@item file=@var{file} 4765824d651Sblueswir1This option defines which disk image (@pxref{disk_images}) to use with 4775824d651Sblueswir1this drive. If the filename contains comma, you must double it 4785824d651Sblueswir1(for instance, "file=my,,file" to use file "my,file"). 4790f5314a2SRonnie Sahlberg 4800f5314a2SRonnie SahlbergSpecial files such as iSCSI devices can be specified using protocol 4810f5314a2SRonnie Sahlbergspecific URLs. See the section for "Device URL Syntax" for more information. 4825824d651Sblueswir1@item if=@var{interface} 4835824d651Sblueswir1This option defines on which type on interface the drive is connected. 4845824d651Sblueswir1Available types are: ide, scsi, sd, mtd, floppy, pflash, virtio. 4855824d651Sblueswir1@item bus=@var{bus},unit=@var{unit} 4865824d651Sblueswir1These options define where is connected the drive by defining the bus number and 4875824d651Sblueswir1the unit id. 4885824d651Sblueswir1@item index=@var{index} 4895824d651Sblueswir1This option defines where is connected the drive by using an index in the list 4905824d651Sblueswir1of available connectors of a given interface type. 4915824d651Sblueswir1@item media=@var{media} 4925824d651Sblueswir1This option defines the type of the media: disk or cdrom. 4935824d651Sblueswir1@item cyls=@var{c},heads=@var{h},secs=@var{s}[,trans=@var{t}] 4945824d651Sblueswir1These options have the same definition as they have in @option{-hdachs}. 4955824d651Sblueswir1@item snapshot=@var{snapshot} 4969d85d557SMichael Tokarev@var{snapshot} is "on" or "off" and controls snapshot mode for the given drive 4979d85d557SMichael Tokarev(see @option{-snapshot}). 4985824d651Sblueswir1@item cache=@var{cache} 49992196b2fSStefan Hajnoczi@var{cache} is "none", "writeback", "unsafe", "directsync" or "writethrough" and controls how the host cache is used to access block data. 5005c6c3a6cSChristoph Hellwig@item aio=@var{aio} 5015c6c3a6cSChristoph Hellwig@var{aio} is "threads", or "native" and selects between pthread based disk I/O and native Linux AIO. 502a9384affSPaolo Bonzini@item discard=@var{discard} 503a9384affSPaolo 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. 5045824d651Sblueswir1@item format=@var{format} 5055824d651Sblueswir1Specify which disk @var{format} will be used rather than detecting 5065824d651Sblueswir1the format. Can be used to specifiy format=raw to avoid interpreting 5075824d651Sblueswir1an untrusted format header. 5085824d651Sblueswir1@item serial=@var{serial} 5095824d651Sblueswir1This option specifies the serial number to assign to the device. 510c2cc47a4SMarkus Armbruster@item addr=@var{addr} 511c2cc47a4SMarkus ArmbrusterSpecify the controller's PCI address (if=virtio only). 512ae73e591SLuiz Capitulino@item werror=@var{action},rerror=@var{action} 513ae73e591SLuiz CapitulinoSpecify which @var{action} to take on write and read errors. Valid actions are: 514ae73e591SLuiz Capitulino"ignore" (ignore the error and try to continue), "stop" (pause QEMU), 515ae73e591SLuiz Capitulino"report" (report the error to the guest), "enospc" (pause QEMU only if the 516ae73e591SLuiz Capitulinohost disk is full; report the error to the guest otherwise). 517ae73e591SLuiz CapitulinoThe default setting is @option{werror=enospc} and @option{rerror=report}. 518ae73e591SLuiz Capitulino@item readonly 519ae73e591SLuiz CapitulinoOpen drive @option{file} as read-only. Guest write attempts will fail. 520fb0490f6SStefan Hajnoczi@item copy-on-read=@var{copy-on-read} 521fb0490f6SStefan Hajnoczi@var{copy-on-read} is "on" or "off" and enables whether to copy read backing 522fb0490f6SStefan Hajnoczifile sectors into the image file. 523465bee1dSPeter Lieven@item detect-zeroes=@var{detect-zeroes} 524465bee1dSPeter Lieven@var{detect-zeroes} is "off", "on" or "unmap" and enables the automatic 525465bee1dSPeter Lievenconversion of plain zero writes by the OS to driver specific optimized 526465bee1dSPeter Lievenzero write commands. You may even choose "unmap" if @var{discard} is set 527465bee1dSPeter Lievento "unmap" to allow a zero write to be converted to an UNMAP operation. 5285824d651Sblueswir1@end table 5295824d651Sblueswir1 530a13e5e05SKevin WolfBy default, the @option{cache=writeback} mode is used. It will report data 531a13e5e05SKevin Wolfwrites as completed as soon as the data is present in the host page cache. 532a13e5e05SKevin WolfThis is safe as long as your guest OS makes sure to correctly flush disk caches 533a13e5e05SKevin Wolfwhere needed. If your guest OS does not handle volatile disk write caches 534a13e5e05SKevin Wolfcorrectly and your host crashes or loses power, then the guest may experience 535a13e5e05SKevin Wolfdata corruption. 5365824d651Sblueswir1 537a13e5e05SKevin WolfFor such guests, you should consider using @option{cache=writethrough}. This 538a13e5e05SKevin Wolfmeans that the host page cache will be used to read and write data, but write 539a13e5e05SKevin Wolfnotification will be sent to the guest only after QEMU has made sure to flush 540a13e5e05SKevin Wolfeach write to the disk. Be aware that this has a major impact on performance. 5415824d651Sblueswir1 542c304d317SAurelien JarnoThe host page cache can be avoided entirely with @option{cache=none}. This will 543a13e5e05SKevin Wolfattempt to do disk IO directly to the guest's memory. QEMU may still perform 544a13e5e05SKevin Wolfan internal copy of the data. Note that this is considered a writeback mode and 545a13e5e05SKevin Wolfthe guest OS must handle the disk write cache correctly in order to avoid data 546a13e5e05SKevin Wolfcorruption on host crashes. 5475824d651Sblueswir1 54892196b2fSStefan HajnocziThe host page cache can be avoided while only sending write notifications to 549a13e5e05SKevin Wolfthe guest when the data has been flushed to the disk using 550a13e5e05SKevin Wolf@option{cache=directsync}. 5515824d651Sblueswir1 552016f5cf6SAlexander GrafIn case you don't care about data integrity over host failures, use 553a13e5e05SKevin Wolf@option{cache=unsafe}. This option tells QEMU that it never needs to write any 554a13e5e05SKevin Wolfdata to the disk but can instead keep things in cache. If anything goes wrong, 555e7d81004SStefan Weillike your host losing power, the disk storage getting disconnected accidentally, 556a13e5e05SKevin Wolfetc. your image will most probably be rendered unusable. When using 557c3177288SAlexander Grafthe @option{-snapshot} option, unsafe caching is always used. 558016f5cf6SAlexander Graf 559fb0490f6SStefan HajnocziCopy-on-read avoids accessing the same backing file sectors repeatedly and is 560fb0490f6SStefan Hajnocziuseful when the backing file is over a slow network. By default copy-on-read 561fb0490f6SStefan Hajnocziis off. 562fb0490f6SStefan Hajnoczi 5635824d651Sblueswir1Instead of @option{-cdrom} you can use: 5645824d651Sblueswir1@example 5653804da9dSStefan Weilqemu-system-i386 -drive file=file,index=2,media=cdrom 5665824d651Sblueswir1@end example 5675824d651Sblueswir1 5685824d651Sblueswir1Instead of @option{-hda}, @option{-hdb}, @option{-hdc}, @option{-hdd}, you can 5695824d651Sblueswir1use: 5705824d651Sblueswir1@example 5713804da9dSStefan Weilqemu-system-i386 -drive file=file,index=0,media=disk 5723804da9dSStefan Weilqemu-system-i386 -drive file=file,index=1,media=disk 5733804da9dSStefan Weilqemu-system-i386 -drive file=file,index=2,media=disk 5743804da9dSStefan Weilqemu-system-i386 -drive file=file,index=3,media=disk 5755824d651Sblueswir1@end example 5765824d651Sblueswir1 577587ed6beSCorey BryantYou can open an image using pre-opened file descriptors from an fd set: 578587ed6beSCorey Bryant@example 579587ed6beSCorey Bryantqemu-system-i386 580587ed6beSCorey Bryant-add-fd fd=3,set=2,opaque="rdwr:/path/to/file" 581587ed6beSCorey Bryant-add-fd fd=4,set=2,opaque="rdonly:/path/to/file" 582587ed6beSCorey Bryant-drive file=/dev/fdset/2,index=0,media=disk 583587ed6beSCorey Bryant@end example 584587ed6beSCorey Bryant 5855824d651Sblueswir1You can connect a CDROM to the slave of ide0: 5865824d651Sblueswir1@example 5873804da9dSStefan Weilqemu-system-i386 -drive file=file,if=ide,index=1,media=cdrom 5885824d651Sblueswir1@end example 5895824d651Sblueswir1 5905824d651Sblueswir1If you don't specify the "file=" argument, you define an empty drive: 5915824d651Sblueswir1@example 5923804da9dSStefan Weilqemu-system-i386 -drive if=ide,index=1,media=cdrom 5935824d651Sblueswir1@end example 5945824d651Sblueswir1 5955824d651Sblueswir1You can connect a SCSI disk with unit ID 6 on the bus #0: 5965824d651Sblueswir1@example 5973804da9dSStefan Weilqemu-system-i386 -drive file=file,if=scsi,bus=0,unit=6 5985824d651Sblueswir1@end example 5995824d651Sblueswir1 6005824d651Sblueswir1Instead of @option{-fda}, @option{-fdb}, you can use: 6015824d651Sblueswir1@example 6023804da9dSStefan Weilqemu-system-i386 -drive file=file,index=0,if=floppy 6033804da9dSStefan Weilqemu-system-i386 -drive file=file,index=1,if=floppy 6045824d651Sblueswir1@end example 6055824d651Sblueswir1 6065824d651Sblueswir1By default, @var{interface} is "ide" and @var{index} is automatically 6075824d651Sblueswir1incremented: 6085824d651Sblueswir1@example 6093804da9dSStefan Weilqemu-system-i386 -drive file=a -drive file=b" 6105824d651Sblueswir1@end example 6115824d651Sblueswir1is interpreted like: 6125824d651Sblueswir1@example 6133804da9dSStefan Weilqemu-system-i386 -hda a -hdb b 6145824d651Sblueswir1@end example 6155824d651Sblueswir1ETEXI 6165824d651Sblueswir1 6175824d651Sblueswir1DEF("mtdblock", HAS_ARG, QEMU_OPTION_mtdblock, 618ad96090aSBlue Swirl "-mtdblock file use 'file' as on-board Flash memory image\n", 619ad96090aSBlue Swirl QEMU_ARCH_ALL) 6205824d651Sblueswir1STEXI 6214e257e5eSKevin Wolf@item -mtdblock @var{file} 6226616b2adSStefan Weil@findex -mtdblock 6234e257e5eSKevin WolfUse @var{file} as on-board Flash memory image. 6245824d651Sblueswir1ETEXI 6255824d651Sblueswir1 6265824d651Sblueswir1DEF("sd", HAS_ARG, QEMU_OPTION_sd, 627ad96090aSBlue Swirl "-sd file use 'file' as SecureDigital card image\n", QEMU_ARCH_ALL) 6285824d651Sblueswir1STEXI 6294e257e5eSKevin Wolf@item -sd @var{file} 6306616b2adSStefan Weil@findex -sd 6314e257e5eSKevin WolfUse @var{file} as SecureDigital card image. 6325824d651Sblueswir1ETEXI 6335824d651Sblueswir1 6345824d651Sblueswir1DEF("pflash", HAS_ARG, QEMU_OPTION_pflash, 635ad96090aSBlue Swirl "-pflash file use 'file' as a parallel flash image\n", QEMU_ARCH_ALL) 6365824d651Sblueswir1STEXI 6374e257e5eSKevin Wolf@item -pflash @var{file} 6386616b2adSStefan Weil@findex -pflash 6394e257e5eSKevin WolfUse @var{file} as a parallel flash image. 6405824d651Sblueswir1ETEXI 6415824d651Sblueswir1 6425824d651Sblueswir1DEF("snapshot", 0, QEMU_OPTION_snapshot, 643ad96090aSBlue Swirl "-snapshot write to temporary files instead of disk image files\n", 644ad96090aSBlue Swirl QEMU_ARCH_ALL) 6455824d651Sblueswir1STEXI 6465824d651Sblueswir1@item -snapshot 6476616b2adSStefan Weil@findex -snapshot 6485824d651Sblueswir1Write to temporary files instead of disk image files. In this case, 6495824d651Sblueswir1the raw disk image you use is not written back. You can however force 6505824d651Sblueswir1the write back by pressing @key{C-a s} (@pxref{disk_images}). 6515824d651Sblueswir1ETEXI 6525824d651Sblueswir1 65310adb8beSMarkus ArmbrusterDEF("hdachs", HAS_ARG, QEMU_OPTION_hdachs, \ 65410adb8beSMarkus Armbruster "-hdachs c,h,s[,t]\n" \ 65510adb8beSMarkus Armbruster " force hard disk 0 physical geometry and the optional BIOS\n" \ 65610adb8beSMarkus Armbruster " translation (t=none or lba) (usually QEMU can guess them)\n", 657ad96090aSBlue Swirl QEMU_ARCH_ALL) 658c902760fSMarcelo TosattiSTEXI 65910adb8beSMarkus Armbruster@item -hdachs @var{c},@var{h},@var{s},[,@var{t}] 66010adb8beSMarkus Armbruster@findex -hdachs 66110adb8beSMarkus ArmbrusterForce hard disk 0 physical geometry (1 <= @var{c} <= 16383, 1 <= 66210adb8beSMarkus Armbruster@var{h} <= 16, 1 <= @var{s} <= 63) and optionally force the BIOS 66310adb8beSMarkus Armbrustertranslation mode (@var{t}=none, lba or auto). Usually QEMU can guess 66410adb8beSMarkus Armbrusterall those parameters. This option is useful for old MS-DOS disk 66510adb8beSMarkus Armbrusterimages. 666c70a01e4SMarkus ArmbrusterETEXI 66774db920cSGautham R Shenoy 66874db920cSGautham R ShenoyDEF("fsdev", HAS_ARG, QEMU_OPTION_fsdev, 6692c30dd74SAneesh Kumar K.V "-fsdev fsdriver,id=id[,path=path,][security_model={mapped-xattr|mapped-file|passthrough|none}]\n" 67084a87cc4SM. Mohan Kumar " [,writeout=immediate][,readonly][,socket=socket|sock_fd=sock_fd]\n", 67174db920cSGautham R Shenoy QEMU_ARCH_ALL) 67274db920cSGautham R Shenoy 67374db920cSGautham R ShenoySTEXI 67474db920cSGautham R Shenoy 67584a87cc4SM. 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}] 67674db920cSGautham R Shenoy@findex -fsdev 6777c92a3d2SAneesh Kumar K.VDefine a new file system device. Valid options are: 6787c92a3d2SAneesh Kumar K.V@table @option 6797c92a3d2SAneesh Kumar K.V@item @var{fsdriver} 6807c92a3d2SAneesh Kumar K.VThis option specifies the fs driver backend to use. 681f67e3ffdSM. Mohan KumarCurrently "local", "handle" and "proxy" file system drivers are supported. 6827c92a3d2SAneesh Kumar K.V@item id=@var{id} 6837c92a3d2SAneesh Kumar K.VSpecifies identifier for this device 6847c92a3d2SAneesh Kumar K.V@item path=@var{path} 6857c92a3d2SAneesh Kumar K.VSpecifies the export path for the file system device. Files under 6867c92a3d2SAneesh Kumar K.Vthis path will be available to the 9p client on the guest. 6877c92a3d2SAneesh Kumar K.V@item security_model=@var{security_model} 6887c92a3d2SAneesh Kumar K.VSpecifies the security model to be used for this export path. 6892c30dd74SAneesh Kumar K.VSupported security models are "passthrough", "mapped-xattr", "mapped-file" and "none". 6907c92a3d2SAneesh Kumar K.VIn "passthrough" security model, files are stored using the same 691b65ee4faSStefan Weilcredentials as they are created on the guest. This requires QEMU 6922c30dd74SAneesh Kumar K.Vto run as root. In "mapped-xattr" security model, some of the file 6937c92a3d2SAneesh Kumar K.Vattributes like uid, gid, mode bits and link target are stored as 6942c30dd74SAneesh Kumar K.Vfile attributes. For "mapped-file" these attributes are stored in the 6952c30dd74SAneesh Kumar K.Vhidden .virtfs_metadata directory. Directories exported by this security model cannot 6967c92a3d2SAneesh Kumar K.Vinteract with other unix tools. "none" security model is same as 6977c92a3d2SAneesh Kumar K.Vpassthrough except the sever won't report failures if it fails to 698d9b36a6eSM. Mohan Kumarset file attributes like ownership. Security model is mandatory 699f67e3ffdSM. Mohan Kumaronly for local fsdriver. Other fsdrivers (like handle, proxy) don't take 700d9b36a6eSM. Mohan Kumarsecurity model as a parameter. 7017c92a3d2SAneesh Kumar K.V@item writeout=@var{writeout} 7027c92a3d2SAneesh Kumar K.VThis is an optional argument. The only supported value is "immediate". 7037c92a3d2SAneesh Kumar K.VThis means that host page cache will be used to read and write data but 7047c92a3d2SAneesh Kumar K.Vwrite notification will be sent to the guest only when the data has been 7057c92a3d2SAneesh Kumar K.Vreported as written by the storage subsystem. 7062c74c2cbSM. Mohan Kumar@item readonly 7072c74c2cbSM. Mohan KumarEnables exporting 9p share as a readonly mount for guests. By default 7082c74c2cbSM. Mohan Kumarread-write access is given. 70984a87cc4SM. Mohan Kumar@item socket=@var{socket} 71084a87cc4SM. Mohan KumarEnables proxy filesystem driver to use passed socket file for communicating 71184a87cc4SM. Mohan Kumarwith virtfs-proxy-helper 712f67e3ffdSM. Mohan Kumar@item sock_fd=@var{sock_fd} 713f67e3ffdSM. Mohan KumarEnables proxy filesystem driver to use passed socket descriptor for 714f67e3ffdSM. Mohan Kumarcommunicating with virtfs-proxy-helper. Usually a helper like libvirt 715f67e3ffdSM. Mohan Kumarwill create socketpair and pass one of the fds as sock_fd 71674db920cSGautham R Shenoy@end table 7177c92a3d2SAneesh Kumar K.V 7187c92a3d2SAneesh Kumar K.V-fsdev option is used along with -device driver "virtio-9p-pci". 7197c92a3d2SAneesh Kumar K.V@item -device virtio-9p-pci,fsdev=@var{id},mount_tag=@var{mount_tag} 7207c92a3d2SAneesh Kumar K.VOptions for virtio-9p-pci driver are: 7217c92a3d2SAneesh Kumar K.V@table @option 7227c92a3d2SAneesh Kumar K.V@item fsdev=@var{id} 7237c92a3d2SAneesh Kumar K.VSpecifies the id value specified along with -fsdev option 7247c92a3d2SAneesh Kumar K.V@item mount_tag=@var{mount_tag} 7257c92a3d2SAneesh Kumar K.VSpecifies the tag name to be used by the guest to mount this export point 7267c92a3d2SAneesh Kumar K.V@end table 7277c92a3d2SAneesh Kumar K.V 72874db920cSGautham R ShenoyETEXI 72974db920cSGautham R Shenoy 7303d54abc7SGautham R ShenoyDEF("virtfs", HAS_ARG, QEMU_OPTION_virtfs, 7312c30dd74SAneesh Kumar K.V "-virtfs local,path=path,mount_tag=tag,security_model=[mapped-xattr|mapped-file|passthrough|none]\n" 73284a87cc4SM. Mohan Kumar " [,writeout=immediate][,readonly][,socket=socket|sock_fd=sock_fd]\n", 7333d54abc7SGautham R Shenoy QEMU_ARCH_ALL) 7343d54abc7SGautham R Shenoy 7353d54abc7SGautham R ShenoySTEXI 7363d54abc7SGautham R Shenoy 73784a87cc4SM. 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}] 7383d54abc7SGautham R Shenoy@findex -virtfs 7393d54abc7SGautham R Shenoy 7407c92a3d2SAneesh Kumar K.VThe general form of a Virtual File system pass-through options are: 7417c92a3d2SAneesh Kumar K.V@table @option 7427c92a3d2SAneesh Kumar K.V@item @var{fsdriver} 7437c92a3d2SAneesh Kumar K.VThis option specifies the fs driver backend to use. 744f67e3ffdSM. Mohan KumarCurrently "local", "handle" and "proxy" file system drivers are supported. 7457c92a3d2SAneesh Kumar K.V@item id=@var{id} 7467c92a3d2SAneesh Kumar K.VSpecifies identifier for this device 7477c92a3d2SAneesh Kumar K.V@item path=@var{path} 7487c92a3d2SAneesh Kumar K.VSpecifies the export path for the file system device. Files under 7497c92a3d2SAneesh Kumar K.Vthis path will be available to the 9p client on the guest. 7507c92a3d2SAneesh Kumar K.V@item security_model=@var{security_model} 7517c92a3d2SAneesh Kumar K.VSpecifies the security model to be used for this export path. 7522c30dd74SAneesh Kumar K.VSupported security models are "passthrough", "mapped-xattr", "mapped-file" and "none". 7537c92a3d2SAneesh Kumar K.VIn "passthrough" security model, files are stored using the same 754b65ee4faSStefan Weilcredentials as they are created on the guest. This requires QEMU 7552c30dd74SAneesh Kumar K.Vto run as root. In "mapped-xattr" security model, some of the file 7567c92a3d2SAneesh Kumar K.Vattributes like uid, gid, mode bits and link target are stored as 7572c30dd74SAneesh Kumar K.Vfile attributes. For "mapped-file" these attributes are stored in the 7582c30dd74SAneesh Kumar K.Vhidden .virtfs_metadata directory. Directories exported by this security model cannot 7597c92a3d2SAneesh Kumar K.Vinteract with other unix tools. "none" security model is same as 7607c92a3d2SAneesh Kumar K.Vpassthrough except the sever won't report failures if it fails to 761d9b36a6eSM. Mohan Kumarset file attributes like ownership. Security model is mandatory only 762f67e3ffdSM. Mohan Kumarfor local fsdriver. Other fsdrivers (like handle, proxy) don't take security 763d9b36a6eSM. Mohan Kumarmodel as a parameter. 7647c92a3d2SAneesh Kumar K.V@item writeout=@var{writeout} 7657c92a3d2SAneesh Kumar K.VThis is an optional argument. The only supported value is "immediate". 7667c92a3d2SAneesh Kumar K.VThis means that host page cache will be used to read and write data but 7677c92a3d2SAneesh Kumar K.Vwrite notification will be sent to the guest only when the data has been 7687c92a3d2SAneesh Kumar K.Vreported as written by the storage subsystem. 7692c74c2cbSM. Mohan Kumar@item readonly 7702c74c2cbSM. Mohan KumarEnables exporting 9p share as a readonly mount for guests. By default 7712c74c2cbSM. Mohan Kumarread-write access is given. 77284a87cc4SM. Mohan Kumar@item socket=@var{socket} 77384a87cc4SM. Mohan KumarEnables proxy filesystem driver to use passed socket file for 77484a87cc4SM. Mohan Kumarcommunicating with virtfs-proxy-helper. Usually a helper like libvirt 77584a87cc4SM. Mohan Kumarwill create socketpair and pass one of the fds as sock_fd 776f67e3ffdSM. Mohan Kumar@item sock_fd 777f67e3ffdSM. Mohan KumarEnables proxy filesystem driver to use passed 'sock_fd' as the socket 778f67e3ffdSM. Mohan Kumardescriptor for interfacing with virtfs-proxy-helper 7793d54abc7SGautham R Shenoy@end table 7803d54abc7SGautham R ShenoyETEXI 7813d54abc7SGautham R Shenoy 7829db221aeSAneesh Kumar K.VDEF("virtfs_synth", 0, QEMU_OPTION_virtfs_synth, 7839db221aeSAneesh Kumar K.V "-virtfs_synth Create synthetic file system image\n", 7849db221aeSAneesh Kumar K.V QEMU_ARCH_ALL) 7859db221aeSAneesh Kumar K.VSTEXI 7869db221aeSAneesh Kumar K.V@item -virtfs_synth 7879db221aeSAneesh Kumar K.V@findex -virtfs_synth 7889db221aeSAneesh Kumar K.VCreate synthetic file system image 7899db221aeSAneesh Kumar K.VETEXI 7909db221aeSAneesh Kumar K.V 7915824d651Sblueswir1STEXI 7925824d651Sblueswir1@end table 7935824d651Sblueswir1ETEXI 7945824d651Sblueswir1DEFHEADING() 7955824d651Sblueswir1 79610adb8beSMarkus ArmbrusterDEFHEADING(USB options:) 79710adb8beSMarkus ArmbrusterSTEXI 79810adb8beSMarkus Armbruster@table @option 79910adb8beSMarkus ArmbrusterETEXI 80010adb8beSMarkus Armbruster 80110adb8beSMarkus ArmbrusterDEF("usb", 0, QEMU_OPTION_usb, 80210adb8beSMarkus Armbruster "-usb enable the USB driver (will be the default soon)\n", 80310adb8beSMarkus Armbruster QEMU_ARCH_ALL) 80410adb8beSMarkus ArmbrusterSTEXI 80510adb8beSMarkus Armbruster@item -usb 80610adb8beSMarkus Armbruster@findex -usb 80710adb8beSMarkus ArmbrusterEnable the USB driver (will be the default soon) 80810adb8beSMarkus ArmbrusterETEXI 80910adb8beSMarkus Armbruster 81010adb8beSMarkus ArmbrusterDEF("usbdevice", HAS_ARG, QEMU_OPTION_usbdevice, 81110adb8beSMarkus Armbruster "-usbdevice name add the host or guest USB device 'name'\n", 81210adb8beSMarkus Armbruster QEMU_ARCH_ALL) 81310adb8beSMarkus ArmbrusterSTEXI 81410adb8beSMarkus Armbruster 81510adb8beSMarkus Armbruster@item -usbdevice @var{devname} 81610adb8beSMarkus Armbruster@findex -usbdevice 81710adb8beSMarkus ArmbrusterAdd the USB device @var{devname}. @xref{usb_devices}. 81810adb8beSMarkus Armbruster 81910adb8beSMarkus Armbruster@table @option 82010adb8beSMarkus Armbruster 82110adb8beSMarkus Armbruster@item mouse 82210adb8beSMarkus ArmbrusterVirtual Mouse. This will override the PS/2 mouse emulation when activated. 82310adb8beSMarkus Armbruster 82410adb8beSMarkus Armbruster@item tablet 82510adb8beSMarkus ArmbrusterPointer device that uses absolute coordinates (like a touchscreen). This 82610adb8beSMarkus Armbrustermeans QEMU is able to report the mouse position without having to grab the 82710adb8beSMarkus Armbrustermouse. Also overrides the PS/2 mouse emulation when activated. 82810adb8beSMarkus Armbruster 82910adb8beSMarkus Armbruster@item disk:[format=@var{format}]:@var{file} 83010adb8beSMarkus ArmbrusterMass storage device based on file. The optional @var{format} argument 83110adb8beSMarkus Armbrusterwill be used rather than detecting the format. Can be used to specifiy 83210adb8beSMarkus Armbruster@code{format=raw} to avoid interpreting an untrusted format header. 83310adb8beSMarkus Armbruster 83410adb8beSMarkus Armbruster@item host:@var{bus}.@var{addr} 83510adb8beSMarkus ArmbrusterPass through the host device identified by @var{bus}.@var{addr} (Linux only). 83610adb8beSMarkus Armbruster 83710adb8beSMarkus Armbruster@item host:@var{vendor_id}:@var{product_id} 83810adb8beSMarkus ArmbrusterPass through the host device identified by @var{vendor_id}:@var{product_id} 83910adb8beSMarkus Armbruster(Linux only). 84010adb8beSMarkus Armbruster 84110adb8beSMarkus Armbruster@item serial:[vendorid=@var{vendor_id}][,productid=@var{product_id}]:@var{dev} 84210adb8beSMarkus ArmbrusterSerial converter to host character device @var{dev}, see @code{-serial} for the 84310adb8beSMarkus Armbrusteravailable devices. 84410adb8beSMarkus Armbruster 84510adb8beSMarkus Armbruster@item braille 84610adb8beSMarkus ArmbrusterBraille device. This will use BrlAPI to display the braille output on a real 84710adb8beSMarkus Armbrusteror fake device. 84810adb8beSMarkus Armbruster 84910adb8beSMarkus Armbruster@item net:@var{options} 85010adb8beSMarkus ArmbrusterNetwork adapter that supports CDC ethernet and RNDIS protocols. 85110adb8beSMarkus Armbruster 85210adb8beSMarkus Armbruster@end table 85310adb8beSMarkus ArmbrusterETEXI 85410adb8beSMarkus Armbruster 85510adb8beSMarkus ArmbrusterSTEXI 85610adb8beSMarkus Armbruster@end table 85710adb8beSMarkus ArmbrusterETEXI 85810adb8beSMarkus ArmbrusterDEFHEADING() 85910adb8beSMarkus Armbruster 8605824d651Sblueswir1DEFHEADING(Display options:) 8615824d651Sblueswir1STEXI 8625824d651Sblueswir1@table @option 8635824d651Sblueswir1ETEXI 8645824d651Sblueswir1 8651472a95bSJes SorensenDEF("display", HAS_ARG, QEMU_OPTION_display, 8661472a95bSJes Sorensen "-display sdl[,frame=on|off][,alt_grab=on|off][,ctrl_grab=on|off]\n" 8673264ff12SJes Sorensen " [,window_close=on|off]|curses|none|\n" 868881249c7SJan Kiszka " gtk[,grab_on_hover=on|off]|\n" 8693264ff12SJes Sorensen " vnc=<display>[,<optargs>]\n" 8701472a95bSJes Sorensen " select display type\n", QEMU_ARCH_ALL) 8711472a95bSJes SorensenSTEXI 8721472a95bSJes Sorensen@item -display @var{type} 8731472a95bSJes Sorensen@findex -display 8741472a95bSJes SorensenSelect type of display to use. This option is a replacement for the 8751472a95bSJes Sorensenold style -sdl/-curses/... options. Valid values for @var{type} are 8761472a95bSJes Sorensen@table @option 8771472a95bSJes Sorensen@item sdl 8781472a95bSJes SorensenDisplay video output via SDL (usually in a separate graphics 8791472a95bSJes Sorensenwindow; see the SDL documentation for other possibilities). 8801472a95bSJes Sorensen@item curses 8811472a95bSJes SorensenDisplay video output via curses. For graphics device models which 8821472a95bSJes Sorensensupport a text mode, QEMU can display this output using a 8831472a95bSJes Sorensencurses/ncurses interface. Nothing is displayed when the graphics 8841472a95bSJes Sorensendevice is in graphical mode or if the graphics device does not support 8851472a95bSJes Sorensena text mode. Generally only the VGA device models support text mode. 8864171d32eSJes Sorensen@item none 8874171d32eSJes SorensenDo not display video output. The guest will still see an emulated 8884171d32eSJes Sorensengraphics card, but its output will not be displayed to the QEMU 8894171d32eSJes Sorensenuser. This option differs from the -nographic option in that it 8904171d32eSJes Sorensenonly affects what is done with video output; -nographic also changes 8914171d32eSJes Sorensenthe destination of the serial and parallel port data. 892881249c7SJan Kiszka@item gtk 893881249c7SJan KiszkaDisplay video output in a GTK window. This interface provides drop-down 894881249c7SJan Kiszkamenus and other UI elements to configure and control the VM during 895881249c7SJan Kiszkaruntime. 8963264ff12SJes Sorensen@item vnc 8973264ff12SJes SorensenStart a VNC server on display <arg> 8981472a95bSJes Sorensen@end table 8991472a95bSJes SorensenETEXI 9001472a95bSJes Sorensen 9015824d651Sblueswir1DEF("nographic", 0, QEMU_OPTION_nographic, 902ad96090aSBlue Swirl "-nographic disable graphical output and redirect serial I/Os to console\n", 903ad96090aSBlue Swirl QEMU_ARCH_ALL) 9045824d651Sblueswir1STEXI 9055824d651Sblueswir1@item -nographic 9066616b2adSStefan Weil@findex -nographic 9075824d651Sblueswir1Normally, QEMU uses SDL to display the VGA output. With this option, 9085824d651Sblueswir1you can totally disable graphical output so that QEMU is a simple 9095824d651Sblueswir1command line application. The emulated serial port is redirected on 91002c4bdf1SPaolo Bonzinithe console and muxed with the monitor (unless redirected elsewhere 91102c4bdf1SPaolo Bonziniexplicitly). Therefore, you can still use QEMU to debug a Linux kernel 912b031f413SRamkumar Ramachandrawith a serial console. Use @key{C-a h} for help on switching between 913b031f413SRamkumar Ramachandrathe console and monitor. 9145824d651Sblueswir1ETEXI 9155824d651Sblueswir1 9165824d651Sblueswir1DEF("curses", 0, QEMU_OPTION_curses, 917ad96090aSBlue Swirl "-curses use a curses/ncurses interface instead of SDL\n", 918ad96090aSBlue Swirl QEMU_ARCH_ALL) 9195824d651Sblueswir1STEXI 9205824d651Sblueswir1@item -curses 921b8f490ebSMarkus Armbruster@findex -curses 9225824d651Sblueswir1Normally, QEMU uses SDL to display the VGA output. With this option, 9235824d651Sblueswir1QEMU can display the VGA output when in text mode using a 9245824d651Sblueswir1curses/ncurses interface. Nothing is displayed in graphical mode. 9255824d651Sblueswir1ETEXI 9265824d651Sblueswir1 9275824d651Sblueswir1DEF("no-frame", 0, QEMU_OPTION_no_frame, 928ad96090aSBlue Swirl "-no-frame open SDL window without a frame and window decorations\n", 929ad96090aSBlue Swirl QEMU_ARCH_ALL) 9305824d651Sblueswir1STEXI 9315824d651Sblueswir1@item -no-frame 9326616b2adSStefan Weil@findex -no-frame 9335824d651Sblueswir1Do not use decorations for SDL windows and start them using the whole 9345824d651Sblueswir1available screen space. This makes the using QEMU in a dedicated desktop 9355824d651Sblueswir1workspace more convenient. 9365824d651Sblueswir1ETEXI 9375824d651Sblueswir1 9385824d651Sblueswir1DEF("alt-grab", 0, QEMU_OPTION_alt_grab, 939ad96090aSBlue Swirl "-alt-grab use Ctrl-Alt-Shift to grab mouse (instead of Ctrl-Alt)\n", 940ad96090aSBlue Swirl QEMU_ARCH_ALL) 9415824d651Sblueswir1STEXI 9425824d651Sblueswir1@item -alt-grab 9436616b2adSStefan Weil@findex -alt-grab 944de1db2a1SBrad HardsUse Ctrl-Alt-Shift to grab mouse (instead of Ctrl-Alt). Note that this also 945de1db2a1SBrad Hardsaffects the special keys (for fullscreen, monitor-mode switching, etc). 9465824d651Sblueswir1ETEXI 9475824d651Sblueswir1 9480ca9f8a4SDustin KirklandDEF("ctrl-grab", 0, QEMU_OPTION_ctrl_grab, 949ad96090aSBlue Swirl "-ctrl-grab use Right-Ctrl to grab mouse (instead of Ctrl-Alt)\n", 950ad96090aSBlue Swirl QEMU_ARCH_ALL) 9510ca9f8a4SDustin KirklandSTEXI 9520ca9f8a4SDustin Kirkland@item -ctrl-grab 9536616b2adSStefan Weil@findex -ctrl-grab 954de1db2a1SBrad HardsUse Right-Ctrl to grab mouse (instead of Ctrl-Alt). Note that this also 955de1db2a1SBrad Hardsaffects the special keys (for fullscreen, monitor-mode switching, etc). 9560ca9f8a4SDustin KirklandETEXI 9570ca9f8a4SDustin Kirkland 9585824d651Sblueswir1DEF("no-quit", 0, QEMU_OPTION_no_quit, 959ad96090aSBlue Swirl "-no-quit disable SDL window close capability\n", QEMU_ARCH_ALL) 9605824d651Sblueswir1STEXI 9615824d651Sblueswir1@item -no-quit 9626616b2adSStefan Weil@findex -no-quit 9635824d651Sblueswir1Disable SDL window close capability. 9645824d651Sblueswir1ETEXI 9655824d651Sblueswir1 9665824d651Sblueswir1DEF("sdl", 0, QEMU_OPTION_sdl, 967ad96090aSBlue Swirl "-sdl enable SDL\n", QEMU_ARCH_ALL) 9685824d651Sblueswir1STEXI 9695824d651Sblueswir1@item -sdl 9706616b2adSStefan Weil@findex -sdl 9715824d651Sblueswir1Enable SDL. 9725824d651Sblueswir1ETEXI 9735824d651Sblueswir1 97429b0040bSGerd HoffmannDEF("spice", HAS_ARG, QEMU_OPTION_spice, 97527af7788SYonit Halperin "-spice [port=port][,tls-port=secured-port][,x509-dir=<dir>]\n" 97627af7788SYonit Halperin " [,x509-key-file=<file>][,x509-key-password=<file>]\n" 97727af7788SYonit Halperin " [,x509-cert-file=<file>][,x509-cacert-file=<file>]\n" 978fe4831b1SMarc-André Lureau " [,x509-dh-key-file=<file>][,addr=addr][,ipv4|ipv6|unix]\n" 97927af7788SYonit Halperin " [,tls-ciphers=<list>]\n" 98027af7788SYonit Halperin " [,tls-channel=[main|display|cursor|inputs|record|playback]]\n" 98127af7788SYonit Halperin " [,plaintext-channel=[main|display|cursor|inputs|record|playback]]\n" 98227af7788SYonit Halperin " [,sasl][,password=<secret>][,disable-ticketing]\n" 98327af7788SYonit Halperin " [,image-compression=[auto_glz|auto_lz|quic|glz|lz|off]]\n" 98427af7788SYonit Halperin " [,jpeg-wan-compression=[auto|never|always]]\n" 98527af7788SYonit Halperin " [,zlib-glz-wan-compression=[auto|never|always]]\n" 98627af7788SYonit Halperin " [,streaming-video=[off|all|filter]][,disable-copy-paste]\n" 9875ad24e5fSHans de Goede " [,disable-agent-file-xfer][,agent-mouse=[on|off]]\n" 9885ad24e5fSHans de Goede " [,playback-compression=[on|off]][,seamless-migration=[on|off]]\n" 98927af7788SYonit Halperin " enable spice\n" 99027af7788SYonit Halperin " at least one of {port, tls-port} is mandatory\n", 99127af7788SYonit Halperin QEMU_ARCH_ALL) 99229b0040bSGerd HoffmannSTEXI 99329b0040bSGerd Hoffmann@item -spice @var{option}[,@var{option}[,...]] 99429b0040bSGerd Hoffmann@findex -spice 99529b0040bSGerd HoffmannEnable the spice remote desktop protocol. Valid options are 99629b0040bSGerd Hoffmann 99729b0040bSGerd Hoffmann@table @option 99829b0040bSGerd Hoffmann 99929b0040bSGerd Hoffmann@item port=<nr> 1000c448e855SGerd HoffmannSet the TCP port spice is listening on for plaintext channels. 100129b0040bSGerd Hoffmann 1002333b0eebSGerd Hoffmann@item addr=<addr> 1003333b0eebSGerd HoffmannSet the IP address spice is listening on. Default is any address. 1004333b0eebSGerd Hoffmann 1005333b0eebSGerd Hoffmann@item ipv4 1006333b0eebSGerd Hoffmann@item ipv6 1007fe4831b1SMarc-André Lureau@item unix 1008333b0eebSGerd HoffmannForce using the specified IP version. 1009333b0eebSGerd Hoffmann 101029b0040bSGerd Hoffmann@item password=<secret> 101129b0040bSGerd HoffmannSet the password you need to authenticate. 101229b0040bSGerd Hoffmann 101348b3ed0aSMarc-André Lureau@item sasl 101448b3ed0aSMarc-André LureauRequire that the client use SASL to authenticate with the spice. 101548b3ed0aSMarc-André LureauThe exact choice of authentication method used is controlled from the 101648b3ed0aSMarc-André Lureausystem / user's SASL configuration file for the 'qemu' service. This 101748b3ed0aSMarc-André Lureauis typically found in /etc/sasl2/qemu.conf. If running QEMU as an 101848b3ed0aSMarc-André Lureauunprivileged user, an environment variable SASL_CONF_PATH can be used 101948b3ed0aSMarc-André Lureauto make it search alternate locations for the service config. 102048b3ed0aSMarc-André LureauWhile some SASL auth methods can also provide data encryption (eg GSSAPI), 102148b3ed0aSMarc-André Lureauit is recommended that SASL always be combined with the 'tls' and 102248b3ed0aSMarc-André Lureau'x509' settings to enable use of SSL and server certificates. This 102348b3ed0aSMarc-André Lureauensures a data encryption preventing compromise of authentication 102448b3ed0aSMarc-André Lureaucredentials. 102548b3ed0aSMarc-André Lureau 102629b0040bSGerd Hoffmann@item disable-ticketing 102729b0040bSGerd HoffmannAllow client connects without authentication. 102829b0040bSGerd Hoffmann 1029d4970b07SHans de Goede@item disable-copy-paste 1030d4970b07SHans de GoedeDisable copy paste between the client and the guest. 1031d4970b07SHans de Goede 10325ad24e5fSHans de Goede@item disable-agent-file-xfer 10335ad24e5fSHans de GoedeDisable spice-vdagent based file-xfer between the client and the guest. 10345ad24e5fSHans de Goede 1035c448e855SGerd Hoffmann@item tls-port=<nr> 1036c448e855SGerd HoffmannSet the TCP port spice is listening on for encrypted channels. 1037c448e855SGerd Hoffmann 1038c448e855SGerd Hoffmann@item x509-dir=<dir> 1039c448e855SGerd HoffmannSet the x509 file directory. Expects same filenames as -vnc $display,x509=$dir 1040c448e855SGerd Hoffmann 1041c448e855SGerd Hoffmann@item x509-key-file=<file> 1042c448e855SGerd Hoffmann@item x509-key-password=<file> 1043c448e855SGerd Hoffmann@item x509-cert-file=<file> 1044c448e855SGerd Hoffmann@item x509-cacert-file=<file> 1045c448e855SGerd Hoffmann@item x509-dh-key-file=<file> 1046c448e855SGerd HoffmannThe x509 file names can also be configured individually. 1047c448e855SGerd Hoffmann 1048c448e855SGerd Hoffmann@item tls-ciphers=<list> 1049c448e855SGerd HoffmannSpecify which ciphers to use. 1050c448e855SGerd Hoffmann 1051d70d6b31SAlon Levy@item tls-channel=[main|display|cursor|inputs|record|playback] 1052d70d6b31SAlon Levy@item plaintext-channel=[main|display|cursor|inputs|record|playback] 105317b6dea0SGerd HoffmannForce specific channel to be used with or without TLS encryption. The 105417b6dea0SGerd Hoffmannoptions can be specified multiple times to configure multiple 105517b6dea0SGerd Hoffmannchannels. The special name "default" can be used to set the default 105617b6dea0SGerd Hoffmannmode. For channels which are not explicitly forced into one mode the 105717b6dea0SGerd Hoffmannspice client is allowed to pick tls/plaintext as he pleases. 105817b6dea0SGerd Hoffmann 10599f04e09eSYonit Halperin@item image-compression=[auto_glz|auto_lz|quic|glz|lz|off] 10609f04e09eSYonit HalperinConfigure image compression (lossless). 10619f04e09eSYonit HalperinDefault is auto_glz. 10629f04e09eSYonit Halperin 10639f04e09eSYonit Halperin@item jpeg-wan-compression=[auto|never|always] 10649f04e09eSYonit Halperin@item zlib-glz-wan-compression=[auto|never|always] 10659f04e09eSYonit HalperinConfigure wan image compression (lossy for slow links). 10669f04e09eSYonit HalperinDefault is auto. 10679f04e09eSYonit Halperin 106884a23f25SGerd Hoffmann@item streaming-video=[off|all|filter] 106984a23f25SGerd HoffmannConfigure video stream detection. Default is filter. 107084a23f25SGerd Hoffmann 107184a23f25SGerd Hoffmann@item agent-mouse=[on|off] 107284a23f25SGerd HoffmannEnable/disable passing mouse events via vdagent. Default is on. 107384a23f25SGerd Hoffmann 107484a23f25SGerd Hoffmann@item playback-compression=[on|off] 107584a23f25SGerd HoffmannEnable/disable audio stream compression (using celt 0.5.1). Default is on. 107684a23f25SGerd Hoffmann 10778c957053SYonit Halperin@item seamless-migration=[on|off] 10788c957053SYonit HalperinEnable/disable spice seamless migration. Default is off. 10798c957053SYonit Halperin 108029b0040bSGerd Hoffmann@end table 108129b0040bSGerd HoffmannETEXI 108229b0040bSGerd Hoffmann 10835824d651Sblueswir1DEF("portrait", 0, QEMU_OPTION_portrait, 1084ad96090aSBlue Swirl "-portrait rotate graphical output 90 deg left (only PXA LCD)\n", 1085ad96090aSBlue Swirl QEMU_ARCH_ALL) 10865824d651Sblueswir1STEXI 10875824d651Sblueswir1@item -portrait 10886616b2adSStefan Weil@findex -portrait 10895824d651Sblueswir1Rotate graphical output 90 deg left (only PXA LCD). 10905824d651Sblueswir1ETEXI 10915824d651Sblueswir1 10929312805dSVasily KhoruzhickDEF("rotate", HAS_ARG, QEMU_OPTION_rotate, 10939312805dSVasily Khoruzhick "-rotate <deg> rotate graphical output some deg left (only PXA LCD)\n", 10949312805dSVasily Khoruzhick QEMU_ARCH_ALL) 10959312805dSVasily KhoruzhickSTEXI 10966265c43bSMarkus Armbruster@item -rotate @var{deg} 10979312805dSVasily Khoruzhick@findex -rotate 10989312805dSVasily KhoruzhickRotate graphical output some deg left (only PXA LCD). 10999312805dSVasily KhoruzhickETEXI 11009312805dSVasily Khoruzhick 11015824d651Sblueswir1DEF("vga", HAS_ARG, QEMU_OPTION_vga, 110233632788SMark Cave-Ayland "-vga [std|cirrus|vmware|qxl|xenfb|tcx|cg3|none]\n" 1103ad96090aSBlue Swirl " select video card type\n", QEMU_ARCH_ALL) 11045824d651Sblueswir1STEXI 1105e4558dcaSmalc@item -vga @var{type} 11066616b2adSStefan Weil@findex -vga 11075824d651Sblueswir1Select type of VGA card to emulate. Valid values for @var{type} are 1108b3f046c2SKevin Wolf@table @option 11095824d651Sblueswir1@item cirrus 11105824d651Sblueswir1Cirrus Logic GD5446 Video card. All Windows versions starting from 11115824d651Sblueswir1Windows 95 should recognize and use this graphic card. For optimal 11125824d651Sblueswir1performances, use 16 bit color depth in the guest and the host OS. 11135824d651Sblueswir1(This one is the default) 11145824d651Sblueswir1@item std 11155824d651Sblueswir1Standard VGA card with Bochs VBE extensions. If your guest OS 11165824d651Sblueswir1supports the VESA 2.0 VBE extensions (e.g. Windows XP) and if you want 11175824d651Sblueswir1to use high resolution modes (>= 1280x1024x16) then you should use 11185824d651Sblueswir1this option. 11195824d651Sblueswir1@item vmware 11205824d651Sblueswir1VMWare SVGA-II compatible adapter. Use it if you have sufficiently 11215824d651Sblueswir1recent XFree86/XOrg server or Windows guest with a driver for this 11225824d651Sblueswir1card. 1123a19cbfb3SGerd Hoffmann@item qxl 1124a19cbfb3SGerd HoffmannQXL paravirtual graphic card. It is VGA compatible (including VESA 1125a19cbfb3SGerd Hoffmann2.0 VBE support). Works best with qxl guest drivers installed though. 1126a19cbfb3SGerd HoffmannRecommended choice when using the spice protocol. 112733632788SMark Cave-Ayland@item tcx 112833632788SMark Cave-Ayland(sun4m only) Sun TCX framebuffer. This is the default framebuffer for 112933632788SMark Cave-Aylandsun4m machines and offers both 8-bit and 24-bit colour depths at a 113033632788SMark Cave-Aylandfixed resolution of 1024x768. 113133632788SMark Cave-Ayland@item cg3 113233632788SMark Cave-Ayland(sun4m only) Sun cgthree framebuffer. This is a simple 8-bit framebuffer 113333632788SMark Cave-Aylandfor sun4m machines available in both 1024x768 (OpenBIOS) and 1152x900 (OBP) 113433632788SMark Cave-Aylandresolutions aimed at people wishing to run older Solaris versions. 11355824d651Sblueswir1@item none 11365824d651Sblueswir1Disable VGA card. 11375824d651Sblueswir1@end table 11385824d651Sblueswir1ETEXI 11395824d651Sblueswir1 11405824d651Sblueswir1DEF("full-screen", 0, QEMU_OPTION_full_screen, 1141ad96090aSBlue Swirl "-full-screen start in full screen\n", QEMU_ARCH_ALL) 11425824d651Sblueswir1STEXI 11435824d651Sblueswir1@item -full-screen 11446616b2adSStefan Weil@findex -full-screen 11455824d651Sblueswir1Start in full screen. 11465824d651Sblueswir1ETEXI 11475824d651Sblueswir1 11485824d651Sblueswir1DEF("g", 1, QEMU_OPTION_g , 1149ad96090aSBlue Swirl "-g WxH[xDEPTH] Set the initial graphical resolution and depth\n", 1150ad96090aSBlue Swirl QEMU_ARCH_PPC | QEMU_ARCH_SPARC) 11515824d651Sblueswir1STEXI 115295d5f08bSStefan Weil@item -g @var{width}x@var{height}[x@var{depth}] 11536616b2adSStefan Weil@findex -g 115495d5f08bSStefan WeilSet the initial graphical resolution and depth (PPC, SPARC only). 11555824d651Sblueswir1ETEXI 11565824d651Sblueswir1 11575824d651Sblueswir1DEF("vnc", HAS_ARG, QEMU_OPTION_vnc , 1158ad96090aSBlue Swirl "-vnc display start a VNC server on display\n", QEMU_ARCH_ALL) 11595824d651Sblueswir1STEXI 11605824d651Sblueswir1@item -vnc @var{display}[,@var{option}[,@var{option}[,...]]] 11616616b2adSStefan Weil@findex -vnc 11625824d651Sblueswir1Normally, QEMU uses SDL to display the VGA output. With this option, 11635824d651Sblueswir1you can have QEMU listen on VNC display @var{display} and redirect the VGA 11645824d651Sblueswir1display over the VNC session. It is very useful to enable the usb 11655824d651Sblueswir1tablet device when using this option (option @option{-usbdevice 11665824d651Sblueswir1tablet}). When using the VNC display, you must use the @option{-k} 11675824d651Sblueswir1parameter to set the keyboard layout if you are not using en-us. Valid 11685824d651Sblueswir1syntax for the @var{display} is 11695824d651Sblueswir1 1170b3f046c2SKevin Wolf@table @option 11715824d651Sblueswir1 11725824d651Sblueswir1@item @var{host}:@var{d} 11735824d651Sblueswir1 11745824d651Sblueswir1TCP connections will only be allowed from @var{host} on display @var{d}. 11755824d651Sblueswir1By convention the TCP port is 5900+@var{d}. Optionally, @var{host} can 11765824d651Sblueswir1be omitted in which case the server will accept connections from any host. 11775824d651Sblueswir1 11784e257e5eSKevin Wolf@item unix:@var{path} 11795824d651Sblueswir1 11805824d651Sblueswir1Connections will be allowed over UNIX domain sockets where @var{path} is the 11815824d651Sblueswir1location of a unix socket to listen for connections on. 11825824d651Sblueswir1 11835824d651Sblueswir1@item none 11845824d651Sblueswir1 11855824d651Sblueswir1VNC is initialized but not started. The monitor @code{change} command 11865824d651Sblueswir1can be used to later start the VNC server. 11875824d651Sblueswir1 11885824d651Sblueswir1@end table 11895824d651Sblueswir1 11905824d651Sblueswir1Following the @var{display} value there may be one or more @var{option} flags 11915824d651Sblueswir1separated by commas. Valid options are 11925824d651Sblueswir1 1193b3f046c2SKevin Wolf@table @option 11945824d651Sblueswir1 11955824d651Sblueswir1@item reverse 11965824d651Sblueswir1 11975824d651Sblueswir1Connect to a listening VNC client via a ``reverse'' connection. The 11985824d651Sblueswir1client is specified by the @var{display}. For reverse network 11995824d651Sblueswir1connections (@var{host}:@var{d},@code{reverse}), the @var{d} argument 12005824d651Sblueswir1is a TCP port number, not a display number. 12015824d651Sblueswir1 12027536ee4bSTim Hardeck@item websocket 12037536ee4bSTim Hardeck 12047536ee4bSTim HardeckOpens an additional TCP listening port dedicated to VNC Websocket connections. 1205085d8134SPeter MaydellBy definition the Websocket port is 5700+@var{display}. If @var{host} is 12067536ee4bSTim Hardeckspecified connections will only be allowed from this host. 12077536ee4bSTim HardeckAs an alternative the Websocket port could be specified by using 12087536ee4bSTim Hardeck@code{websocket}=@var{port}. 12090057a0d5STim HardeckTLS encryption for the Websocket connection is supported if the required 12100057a0d5STim Hardeckcertificates are specified with the VNC option @option{x509}. 12117536ee4bSTim Hardeck 12125824d651Sblueswir1@item password 12135824d651Sblueswir1 12145824d651Sblueswir1Require that password based authentication is used for client connections. 121586ee5bc3SMichal Novotny 121686ee5bc3SMichal NovotnyThe password must be set separately using the @code{set_password} command in 121786ee5bc3SMichal Novotnythe @ref{pcsys_monitor}. The syntax to change your password is: 121886ee5bc3SMichal Novotny@code{set_password <protocol> <password>} where <protocol> could be either 121986ee5bc3SMichal Novotny"vnc" or "spice". 122086ee5bc3SMichal Novotny 122186ee5bc3SMichal NovotnyIf you would like to change <protocol> password expiration, you should use 122286ee5bc3SMichal Novotny@code{expire_password <protocol> <expiration-time>} where expiration time could 122386ee5bc3SMichal Novotnybe one of the following options: now, never, +seconds or UNIX time of 122486ee5bc3SMichal Novotnyexpiration, e.g. +60 to make password expire in 60 seconds, or 1335196800 122586ee5bc3SMichal Novotnyto make password expire on "Mon Apr 23 12:00:00 EDT 2012" (UNIX time for this 122686ee5bc3SMichal Novotnydate and time). 122786ee5bc3SMichal Novotny 122886ee5bc3SMichal NovotnyYou can also use keywords "now" or "never" for the expiration time to 122986ee5bc3SMichal Novotnyallow <protocol> password to expire immediately or never expire. 12305824d651Sblueswir1 12315824d651Sblueswir1@item tls 12325824d651Sblueswir1 12335824d651Sblueswir1Require that client use TLS when communicating with the VNC server. This 12345824d651Sblueswir1uses anonymous TLS credentials so is susceptible to a man-in-the-middle 12355824d651Sblueswir1attack. It is recommended that this option be combined with either the 12364e257e5eSKevin Wolf@option{x509} or @option{x509verify} options. 12375824d651Sblueswir1 12385824d651Sblueswir1@item x509=@var{/path/to/certificate/dir} 12395824d651Sblueswir1 12405824d651Sblueswir1Valid if @option{tls} is specified. Require that x509 credentials are used 12415824d651Sblueswir1for negotiating the TLS session. The server will send its x509 certificate 12425824d651Sblueswir1to the client. It is recommended that a password be set on the VNC server 12435824d651Sblueswir1to provide authentication of the client when this is used. The path following 12445824d651Sblueswir1this option specifies where the x509 certificates are to be loaded from. 12455824d651Sblueswir1See the @ref{vnc_security} section for details on generating certificates. 12465824d651Sblueswir1 12475824d651Sblueswir1@item x509verify=@var{/path/to/certificate/dir} 12485824d651Sblueswir1 12495824d651Sblueswir1Valid if @option{tls} is specified. Require that x509 credentials are used 12505824d651Sblueswir1for negotiating the TLS session. The server will send its x509 certificate 12515824d651Sblueswir1to the client, and request that the client send its own x509 certificate. 12525824d651Sblueswir1The server will validate the client's certificate against the CA certificate, 12535824d651Sblueswir1and reject clients when validation fails. If the certificate authority is 12545824d651Sblueswir1trusted, this is a sufficient authentication mechanism. You may still wish 12555824d651Sblueswir1to set a password on the VNC server as a second authentication layer. The 12565824d651Sblueswir1path following this option specifies where the x509 certificates are to 12575824d651Sblueswir1be loaded from. See the @ref{vnc_security} section for details on generating 12585824d651Sblueswir1certificates. 12595824d651Sblueswir1 12605824d651Sblueswir1@item sasl 12615824d651Sblueswir1 12625824d651Sblueswir1Require that the client use SASL to authenticate with the VNC server. 12635824d651Sblueswir1The exact choice of authentication method used is controlled from the 12645824d651Sblueswir1system / user's SASL configuration file for the 'qemu' service. This 12655824d651Sblueswir1is typically found in /etc/sasl2/qemu.conf. If running QEMU as an 12665824d651Sblueswir1unprivileged user, an environment variable SASL_CONF_PATH can be used 12675824d651Sblueswir1to make it search alternate locations for the service config. 12685824d651Sblueswir1While some SASL auth methods can also provide data encryption (eg GSSAPI), 12695824d651Sblueswir1it is recommended that SASL always be combined with the 'tls' and 12705824d651Sblueswir1'x509' settings to enable use of SSL and server certificates. This 12715824d651Sblueswir1ensures a data encryption preventing compromise of authentication 12725824d651Sblueswir1credentials. See the @ref{vnc_security} section for details on using 12735824d651Sblueswir1SASL authentication. 12745824d651Sblueswir1 12755824d651Sblueswir1@item acl 12765824d651Sblueswir1 12775824d651Sblueswir1Turn on access control lists for checking of the x509 client certificate 12785824d651Sblueswir1and SASL party. For x509 certs, the ACL check is made against the 12795824d651Sblueswir1certificate's distinguished name. This is something that looks like 12805824d651Sblueswir1@code{C=GB,O=ACME,L=Boston,CN=bob}. For SASL party, the ACL check is 12815824d651Sblueswir1made against the username, which depending on the SASL plugin, may 12825824d651Sblueswir1include a realm component, eg @code{bob} or @code{bob@@EXAMPLE.COM}. 12835824d651Sblueswir1When the @option{acl} flag is set, the initial access list will be 12845824d651Sblueswir1empty, with a @code{deny} policy. Thus no one will be allowed to 12855824d651Sblueswir1use the VNC server until the ACLs have been loaded. This can be 12865824d651Sblueswir1achieved using the @code{acl} monitor command. 12875824d651Sblueswir1 12886f9c78c1SCorentin Chary@item lossy 12896f9c78c1SCorentin Chary 12906f9c78c1SCorentin CharyEnable lossy compression methods (gradient, JPEG, ...). If this 12916f9c78c1SCorentin Charyoption is set, VNC client may receive lossy framebuffer updates 12926f9c78c1SCorentin Charydepending on its encoding settings. Enabling this option can save 12936f9c78c1SCorentin Charya lot of bandwidth at the expense of quality. 12946f9c78c1SCorentin Chary 129580e0c8c3SCorentin Chary@item non-adaptive 129680e0c8c3SCorentin Chary 129780e0c8c3SCorentin CharyDisable adaptive encodings. Adaptive encodings are enabled by default. 129880e0c8c3SCorentin CharyAn adaptive encoding will try to detect frequently updated screen regions, 129980e0c8c3SCorentin Charyand send updates in these regions using a lossy encoding (like JPEG). 130061cc8701SStefan WeilThis can be really helpful to save bandwidth when playing videos. Disabling 13019d85d557SMichael Tokarevadaptive encodings restores the original static behavior of encodings 130280e0c8c3SCorentin Charylike Tight. 130380e0c8c3SCorentin Chary 13048cf36489SGerd Hoffmann@item share=[allow-exclusive|force-shared|ignore] 13058cf36489SGerd Hoffmann 13068cf36489SGerd HoffmannSet display sharing policy. 'allow-exclusive' allows clients to ask 13078cf36489SGerd Hoffmannfor exclusive access. As suggested by the rfb spec this is 13088cf36489SGerd Hoffmannimplemented by dropping other connections. Connecting multiple 13098cf36489SGerd Hoffmannclients in parallel requires all clients asking for a shared session 13108cf36489SGerd Hoffmann(vncviewer: -shared switch). This is the default. 'force-shared' 13118cf36489SGerd Hoffmanndisables exclusive client access. Useful for shared desktop sessions, 13128cf36489SGerd Hoffmannwhere you don't want someone forgetting specify -shared disconnect 13138cf36489SGerd Hoffmanneverybody else. 'ignore' completely ignores the shared flag and 13148cf36489SGerd Hoffmannallows everybody connect unconditionally. Doesn't conform to the rfb 1315b65ee4faSStefan Weilspec but is traditional QEMU behavior. 13168cf36489SGerd Hoffmann 13175824d651Sblueswir1@end table 13185824d651Sblueswir1ETEXI 13195824d651Sblueswir1 13205824d651Sblueswir1STEXI 13215824d651Sblueswir1@end table 13225824d651Sblueswir1ETEXI 1323a3adb7adSMichael EllermanARCHHEADING(, QEMU_ARCH_I386) 13245824d651Sblueswir1 1325a3adb7adSMichael EllermanARCHHEADING(i386 target only:, QEMU_ARCH_I386) 13265824d651Sblueswir1STEXI 13275824d651Sblueswir1@table @option 13285824d651Sblueswir1ETEXI 13295824d651Sblueswir1 13305824d651Sblueswir1DEF("win2k-hack", 0, QEMU_OPTION_win2k_hack, 1331ad96090aSBlue Swirl "-win2k-hack use it when installing Windows 2000 to avoid a disk full bug\n", 1332ad96090aSBlue Swirl QEMU_ARCH_I386) 13335824d651Sblueswir1STEXI 13345824d651Sblueswir1@item -win2k-hack 13356616b2adSStefan Weil@findex -win2k-hack 13365824d651Sblueswir1Use it when installing Windows 2000 to avoid a disk full bug. After 13375824d651Sblueswir1Windows 2000 is installed, you no longer need this option (this option 13385824d651Sblueswir1slows down the IDE transfers). 13395824d651Sblueswir1ETEXI 13405824d651Sblueswir1 13411ed2fc1fSJan KiszkaHXCOMM Deprecated by -rtc 1342ad96090aSBlue SwirlDEF("rtc-td-hack", 0, QEMU_OPTION_rtc_td_hack, "", QEMU_ARCH_I386) 13435824d651Sblueswir1 13445824d651Sblueswir1DEF("no-fd-bootchk", 0, QEMU_OPTION_no_fd_bootchk, 1345ad96090aSBlue Swirl "-no-fd-bootchk disable boot signature checking for floppy disks\n", 1346ad96090aSBlue Swirl QEMU_ARCH_I386) 13475824d651Sblueswir1STEXI 13485824d651Sblueswir1@item -no-fd-bootchk 13496616b2adSStefan Weil@findex -no-fd-bootchk 13504eda32f5SMarkus ArmbrusterDisable boot signature checking for floppy disks in BIOS. May 13515824d651Sblueswir1be needed to boot from old floppy disks. 13525824d651Sblueswir1ETEXI 13535824d651Sblueswir1 13545824d651Sblueswir1DEF("no-acpi", 0, QEMU_OPTION_no_acpi, 1355ad96090aSBlue Swirl "-no-acpi disable ACPI\n", QEMU_ARCH_I386) 13565824d651Sblueswir1STEXI 13575824d651Sblueswir1@item -no-acpi 13586616b2adSStefan Weil@findex -no-acpi 13595824d651Sblueswir1Disable ACPI (Advanced Configuration and Power Interface) support. Use 13605824d651Sblueswir1it if your guest OS complains about ACPI problems (PC target machine 13615824d651Sblueswir1only). 13625824d651Sblueswir1ETEXI 13635824d651Sblueswir1 13645824d651Sblueswir1DEF("no-hpet", 0, QEMU_OPTION_no_hpet, 1365ad96090aSBlue Swirl "-no-hpet disable HPET\n", QEMU_ARCH_I386) 13665824d651Sblueswir1STEXI 13675824d651Sblueswir1@item -no-hpet 13686616b2adSStefan Weil@findex -no-hpet 13695824d651Sblueswir1Disable HPET support. 13705824d651Sblueswir1ETEXI 13715824d651Sblueswir1 13725824d651Sblueswir1DEF("acpitable", HAS_ARG, QEMU_OPTION_acpitable, 1373104bf02eSMichael 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" 1374ad96090aSBlue Swirl " ACPI table description\n", QEMU_ARCH_I386) 13755824d651Sblueswir1STEXI 13765824d651Sblueswir1@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}]...] 13776616b2adSStefan Weil@findex -acpitable 13785824d651Sblueswir1Add ACPI table with specified header fields and context from specified files. 1379104bf02eSMichael TokarevFor file=, take whole ACPI table from the specified files, including all 1380104bf02eSMichael TokarevACPI headers (possible overridden by other options). 1381104bf02eSMichael TokarevFor data=, only data 1382104bf02eSMichael Tokarevportion of the table is used, all header information is specified in the 1383104bf02eSMichael Tokarevcommand line. 13845824d651Sblueswir1ETEXI 13855824d651Sblueswir1 1386b6f6e3d3SaliguoriDEF("smbios", HAS_ARG, QEMU_OPTION_smbios, 1387b6f6e3d3Saliguori "-smbios file=binary\n" 1388ca1a8a06SBruce Rogers " load SMBIOS entry from binary file\n" 1389b155eb1dSGabriel L. Somlo "-smbios type=0[,vendor=str][,version=str][,date=str][,release=%d.%d]\n" 1390b155eb1dSGabriel L. Somlo " [,uefi=on|off]\n" 1391ca1a8a06SBruce Rogers " specify SMBIOS type 0 fields\n" 1392b6f6e3d3Saliguori "-smbios type=1[,manufacturer=str][,product=str][,version=str][,serial=str]\n" 1393b6f6e3d3Saliguori " [,uuid=uuid][,sku=str][,family=str]\n" 1394b155eb1dSGabriel L. Somlo " specify SMBIOS type 1 fields\n" 1395b155eb1dSGabriel L. Somlo "-smbios type=2[,manufacturer=str][,product=str][,version=str][,serial=str]\n" 1396b155eb1dSGabriel L. Somlo " [,asset=str][,location=str]\n" 1397b155eb1dSGabriel L. Somlo " specify SMBIOS type 2 fields\n" 1398b155eb1dSGabriel L. Somlo "-smbios type=3[,manufacturer=str][,version=str][,serial=str][,asset=str]\n" 1399b155eb1dSGabriel L. Somlo " [,sku=str]\n" 1400b155eb1dSGabriel L. Somlo " specify SMBIOS type 3 fields\n" 1401b155eb1dSGabriel L. Somlo "-smbios type=4[,sock_pfx=str][,manufacturer=str][,version=str][,serial=str]\n" 1402b155eb1dSGabriel L. Somlo " [,asset=str][,part=str]\n" 1403b155eb1dSGabriel L. Somlo " specify SMBIOS type 4 fields\n" 1404b155eb1dSGabriel L. Somlo "-smbios type=17[,loc_pfx=str][,bank=str][,manufacturer=str][,serial=str]\n" 1405b155eb1dSGabriel L. Somlo " [,asset=str][,part=str]\n" 1406b155eb1dSGabriel L. Somlo " specify SMBIOS type 17 fields\n", 1407b155eb1dSGabriel L. Somlo QEMU_ARCH_I386) 1408b6f6e3d3SaliguoriSTEXI 1409b6f6e3d3Saliguori@item -smbios file=@var{binary} 14106616b2adSStefan Weil@findex -smbios 1411b6f6e3d3SaliguoriLoad SMBIOS entry from binary file. 1412b6f6e3d3Saliguori 141384351843SGabriel L. Somlo@item -smbios type=0[,vendor=@var{str}][,version=@var{str}][,date=@var{str}][,release=@var{%d.%d}][,uefi=on|off] 1414b6f6e3d3SaliguoriSpecify SMBIOS type 0 fields 1415b6f6e3d3Saliguori 1416b6f6e3d3Saliguori@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}] 1417b6f6e3d3SaliguoriSpecify SMBIOS type 1 fields 1418b155eb1dSGabriel L. Somlo 1419b155eb1dSGabriel 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}] 1420b155eb1dSGabriel L. SomloSpecify SMBIOS type 2 fields 1421b155eb1dSGabriel L. Somlo 1422b155eb1dSGabriel L. Somlo@item -smbios type=3[,manufacturer=@var{str}][,version=@var{str}][,serial=@var{str}][,asset=@var{str}][,sku=@var{str}] 1423b155eb1dSGabriel L. SomloSpecify SMBIOS type 3 fields 1424b155eb1dSGabriel L. Somlo 1425b155eb1dSGabriel 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}] 1426b155eb1dSGabriel L. SomloSpecify SMBIOS type 4 fields 1427b155eb1dSGabriel L. Somlo 1428b155eb1dSGabriel 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}] 1429b155eb1dSGabriel L. SomloSpecify SMBIOS type 17 fields 1430b6f6e3d3SaliguoriETEXI 1431b6f6e3d3Saliguori 14325824d651Sblueswir1STEXI 14335824d651Sblueswir1@end table 14345824d651Sblueswir1ETEXI 1435c70a01e4SMarkus ArmbrusterDEFHEADING() 14365824d651Sblueswir1 14375824d651Sblueswir1DEFHEADING(Network options:) 14385824d651Sblueswir1STEXI 14395824d651Sblueswir1@table @option 14405824d651Sblueswir1ETEXI 14415824d651Sblueswir1 1442ad196a9dSJan KiszkaHXCOMM Legacy slirp options (now moved to -net user): 1443ad196a9dSJan Kiszka#ifdef CONFIG_SLIRP 1444ad96090aSBlue SwirlDEF("tftp", HAS_ARG, QEMU_OPTION_tftp, "", QEMU_ARCH_ALL) 1445ad96090aSBlue SwirlDEF("bootp", HAS_ARG, QEMU_OPTION_bootp, "", QEMU_ARCH_ALL) 1446ad96090aSBlue SwirlDEF("redir", HAS_ARG, QEMU_OPTION_redir, "", QEMU_ARCH_ALL) 1447ad196a9dSJan Kiszka#ifndef _WIN32 1448ad96090aSBlue SwirlDEF("smb", HAS_ARG, QEMU_OPTION_smb, "", QEMU_ARCH_ALL) 1449ad196a9dSJan Kiszka#endif 1450ad196a9dSJan Kiszka#endif 1451ad196a9dSJan Kiszka 1452bab7944cSBlue SwirlDEF("net", HAS_ARG, QEMU_OPTION_net, 1453ffe6370cSMichael S. Tsirkin "-net nic[,vlan=n][,macaddr=mac][,model=type][,name=str][,addr=str][,vectors=v]\n" 14545824d651Sblueswir1 " create a new Network Interface Card and connect it to VLAN 'n'\n" 14555824d651Sblueswir1#ifdef CONFIG_SLIRP 1456c54ed5bcSJan Kiszka "-net user[,vlan=n][,name=str][,net=addr[/mask]][,host=addr][,restrict=on|off]\n" 145763d2960bSKlaus Stengel " [,hostname=host][,dhcpstart=addr][,dns=addr][,dnssearch=domain][,tftp=dir]\n" 145863d2960bSKlaus Stengel " [,bootfile=f][,hostfwd=rule][,guestfwd=rule]" 1459ad196a9dSJan Kiszka#ifndef _WIN32 1460c92ef6a2SJan Kiszka "[,smb=dir[,smbserver=addr]]\n" 1461ad196a9dSJan Kiszka#endif 1462ad196a9dSJan Kiszka " connect the user mode network stack to VLAN 'n', configure its\n" 1463ad196a9dSJan Kiszka " DHCP server and enabled optional services\n" 14645824d651Sblueswir1#endif 14655824d651Sblueswir1#ifdef _WIN32 14665824d651Sblueswir1 "-net tap[,vlan=n][,name=str],ifname=name\n" 14675824d651Sblueswir1 " connect the host TAP network interface to VLAN 'n'\n" 14685824d651Sblueswir1#else 1469ec396014SJason Wang "-net tap[,vlan=n][,name=str][,fd=h][,fds=x:y:...:z][,ifname=name][,script=file][,downscript=dfile][,helper=helper][,sndbuf=nbytes][,vnet_hdr=on|off][,vhost=on|off][,vhostfd=h][,vhostfds=x:y:...:z][,vhostforce=on|off][,queues=n]\n" 1470a7c36ee4SCorey Bryant " connect the host TAP network interface to VLAN 'n'\n" 1471a7c36ee4SCorey Bryant " use network scripts 'file' (default=" DEFAULT_NETWORK_SCRIPT ")\n" 1472a7c36ee4SCorey Bryant " to configure it and 'dfile' (default=" DEFAULT_NETWORK_DOWN_SCRIPT ")\n" 1473a7c36ee4SCorey Bryant " to deconfigure it\n" 1474ca1a8a06SBruce Rogers " use '[down]script=no' to disable script execution\n" 1475a7c36ee4SCorey Bryant " use network helper 'helper' (default=" DEFAULT_BRIDGE_HELPER ") to\n" 1476a7c36ee4SCorey Bryant " configure it\n" 14775824d651Sblueswir1 " use 'fd=h' to connect to an already opened TAP interface\n" 14782ca81baaSJason Wang " use 'fds=x:y:...:z' to connect to already opened multiqueue capable TAP interfaces\n" 1479ca1a8a06SBruce Rogers " use 'sndbuf=nbytes' to limit the size of the send buffer (the\n" 1480f157ed20SMichael S. Tsirkin " default is disabled 'sndbuf=0' to enable flow control set 'sndbuf=1048576')\n" 1481ca1a8a06SBruce Rogers " use vnet_hdr=off to avoid enabling the IFF_VNET_HDR tap flag\n" 1482ca1a8a06SBruce Rogers " use vnet_hdr=on to make the lack of IFF_VNET_HDR support an error condition\n" 148382b0d80eSMichael S. Tsirkin " use vhost=on to enable experimental in kernel accelerator\n" 14845430a28fSmst@redhat.com " (only has effect for virtio guests which use MSIX)\n" 14855430a28fSmst@redhat.com " use vhostforce=on to force vhost on for non-MSIX virtio guests\n" 148682b0d80eSMichael S. Tsirkin " use 'vhostfd=h' to connect to an already opened vhost net device\n" 14872ca81baaSJason Wang " use 'vhostfds=x:y:...:z to connect to multiple already opened vhost net devices\n" 1488ec396014SJason Wang " use 'queues=n' to specify the number of queues to be created for multiqueue TAP\n" 1489a7c36ee4SCorey Bryant "-net bridge[,vlan=n][,name=str][,br=bridge][,helper=helper]\n" 1490a7c36ee4SCorey Bryant " connects a host TAP network interface to a host bridge device 'br'\n" 1491a7c36ee4SCorey Bryant " (default=" DEFAULT_BRIDGE_INTERFACE ") using the program 'helper'\n" 1492a7c36ee4SCorey Bryant " (default=" DEFAULT_BRIDGE_HELPER ")\n" 14930df0ff6dSMark McLoughlin#endif 14943fb69aa1SAnton Ivanov#ifdef __linux__ 14953fb69aa1SAnton Ivanov "-net l2tpv3[,vlan=n][,name=str],src=srcaddr,dst=dstaddr[,srcport=srcport][,dstport=dstport],txsession=txsession[,rxsession=rxsession][,ipv6=on/off][,udp=on/off][,cookie64=on/off][,counter][,pincounter][,txcookie=txcookie][,rxcookie=rxcookie][,offset=offset]\n" 14963fb69aa1SAnton Ivanov " connect the VLAN to an Ethernet over L2TPv3 pseudowire\n" 14973fb69aa1SAnton Ivanov " Linux kernel 3.3+ as well as most routers can talk\n" 14982f47b403SMichael Tokarev " L2TPv3. This transport allows connecting a VM to a VM,\n" 14993fb69aa1SAnton Ivanov " VM to a router and even VM to Host. It is a nearly-universal\n" 15003fb69aa1SAnton Ivanov " standard (RFC3391). Note - this implementation uses static\n" 15013fb69aa1SAnton Ivanov " pre-configured tunnels (same as the Linux kernel).\n" 15023fb69aa1SAnton Ivanov " use 'src=' to specify source address\n" 15033fb69aa1SAnton Ivanov " use 'dst=' to specify destination address\n" 15043fb69aa1SAnton Ivanov " use 'udp=on' to specify udp encapsulation\n" 15053952651aSGonglei " use 'srcport=' to specify source udp port\n" 15063fb69aa1SAnton Ivanov " use 'dstport=' to specify destination udp port\n" 15073fb69aa1SAnton Ivanov " use 'ipv6=on' to force v6\n" 15083fb69aa1SAnton Ivanov " L2TPv3 uses cookies to prevent misconfiguration as\n" 15093fb69aa1SAnton Ivanov " well as a weak security measure\n" 15103fb69aa1SAnton Ivanov " use 'rxcookie=0x012345678' to specify a rxcookie\n" 15113fb69aa1SAnton Ivanov " use 'txcookie=0x012345678' to specify a txcookie\n" 15123fb69aa1SAnton Ivanov " use 'cookie64=on' to set cookie size to 64 bit, otherwise 32\n" 15133fb69aa1SAnton Ivanov " use 'counter=off' to force a 'cut-down' L2TPv3 with no counter\n" 15143fb69aa1SAnton Ivanov " use 'pincounter=on' to work around broken counter handling in peer\n" 15153fb69aa1SAnton Ivanov " use 'offset=X' to add an extra offset between header and data\n" 15163fb69aa1SAnton Ivanov#endif 15175824d651Sblueswir1 "-net socket[,vlan=n][,name=str][,fd=h][,listen=[host]:port][,connect=host:port]\n" 15185824d651Sblueswir1 " connect the vlan 'n' to another VLAN using a socket connection\n" 15193a75e74cSMike Ryan "-net socket[,vlan=n][,name=str][,fd=h][,mcast=maddr:port[,localaddr=addr]]\n" 15205824d651Sblueswir1 " connect the vlan 'n' to multicast maddr and port\n" 15213a75e74cSMike Ryan " use 'localaddr=addr' to specify the host address to send packets from\n" 15220e0e7facSBenjamin "-net socket[,vlan=n][,name=str][,fd=h][,udp=host:port][,localaddr=host:port]\n" 15230e0e7facSBenjamin " connect the vlan 'n' to another VLAN using an UDP tunnel\n" 15245824d651Sblueswir1#ifdef CONFIG_VDE 15255824d651Sblueswir1 "-net vde[,vlan=n][,name=str][,sock=socketpath][,port=n][,group=groupname][,mode=octalmode]\n" 15265824d651Sblueswir1 " connect the vlan 'n' to port 'n' of a vde switch running\n" 15275824d651Sblueswir1 " on host and listening for incoming connections on 'socketpath'.\n" 15285824d651Sblueswir1 " Use group 'groupname' and mode 'octalmode' to change default\n" 15295824d651Sblueswir1 " ownership and permissions for communication port.\n" 15305824d651Sblueswir1#endif 153158952137SVincenzo Maffione#ifdef CONFIG_NETMAP 153258952137SVincenzo Maffione "-net netmap,ifname=name[,devname=nmname]\n" 153358952137SVincenzo Maffione " attach to the existing netmap-enabled network interface 'name', or to a\n" 153458952137SVincenzo Maffione " VALE port (created on the fly) called 'name' ('nmname' is name of the \n" 153558952137SVincenzo Maffione " netmap device, defaults to '/dev/netmap')\n" 153658952137SVincenzo Maffione#endif 1537bb9ea79eSaliguori "-net dump[,vlan=n][,file=f][,len=n]\n" 1538bb9ea79eSaliguori " dump traffic on vlan 'n' to file 'f' (max n bytes per packet)\n" 1539ca1a8a06SBruce Rogers "-net none use it alone to have zero network devices. If no -net option\n" 1540ad96090aSBlue Swirl " is provided, the default is '-net nic -net user'\n", QEMU_ARCH_ALL) 1541a1ea458fSMark McLoughlinDEF("netdev", HAS_ARG, QEMU_OPTION_netdev, 1542a1ea458fSMark McLoughlin "-netdev [" 1543a1ea458fSMark McLoughlin#ifdef CONFIG_SLIRP 1544a1ea458fSMark McLoughlin "user|" 1545a1ea458fSMark McLoughlin#endif 1546a1ea458fSMark McLoughlin "tap|" 1547a7c36ee4SCorey Bryant "bridge|" 1548a1ea458fSMark McLoughlin#ifdef CONFIG_VDE 1549a1ea458fSMark McLoughlin "vde|" 1550a1ea458fSMark McLoughlin#endif 155158952137SVincenzo Maffione#ifdef CONFIG_NETMAP 155258952137SVincenzo Maffione "netmap|" 155358952137SVincenzo Maffione#endif 155403ce5744SNikolay Nikolaev "vhost-user|" 155540e8c26dSStefan Hajnoczi "socket|" 155640e8c26dSStefan Hajnoczi "hubport],id=str[,option][,option][,...]\n", QEMU_ARCH_ALL) 15575824d651Sblueswir1STEXI 1558ffe6370cSMichael S. Tsirkin@item -net nic[,vlan=@var{n}][,macaddr=@var{mac}][,model=@var{type}] [,name=@var{name}][,addr=@var{addr}][,vectors=@var{v}] 15596616b2adSStefan Weil@findex -net 15605824d651Sblueswir1Create a new Network Interface Card and connect it to VLAN @var{n} (@var{n} 15610d6b0b1dSAnthony Liguori= 0 is the default). The NIC is an e1000 by default on the PC 15625607c388SMarkus Armbrustertarget. Optionally, the MAC address can be changed to @var{mac}, the 15635607c388SMarkus Armbrusterdevice address set to @var{addr} (PCI cards only), 1564ffe6370cSMichael S. Tsirkinand a @var{name} can be assigned for use in monitor commands. 1565ffe6370cSMichael S. TsirkinOptionally, for PCI cards, you can specify the number @var{v} of MSI-X vectors 1566ffe6370cSMichael S. Tsirkinthat the card should have; this option currently only affects virtio cards; set 1567ffe6370cSMichael S. Tsirkin@var{v} = 0 to disable MSI-X. If no @option{-net} option is specified, a single 1568071c9394SStefan WeilNIC is created. QEMU can emulate several different models of network card. 15695824d651Sblueswir1Valid values for @var{type} are 1570ffe6370cSMichael S. Tsirkin@code{virtio}, @code{i82551}, @code{i82557b}, @code{i82559er}, 15715824d651Sblueswir1@code{ne2k_pci}, @code{ne2k_isa}, @code{pcnet}, @code{rtl8139}, 15725824d651Sblueswir1@code{e1000}, @code{smc91c111}, @code{lance} and @code{mcf_fec}. 1573585f6036SPeter MaydellNot all devices are supported on all targets. Use @code{-net nic,model=help} 15745824d651Sblueswir1for a list of available devices for your target. 15755824d651Sblueswir1 157608d12022SStefan Hajnoczi@item -netdev user,id=@var{id}[,@var{option}][,@var{option}][,...] 1577b8f490ebSMarkus Armbruster@findex -netdev 1578ad196a9dSJan Kiszka@item -net user[,@var{option}][,@var{option}][,...] 15795824d651Sblueswir1Use the user mode network stack which requires no administrator 1580ad196a9dSJan Kiszkaprivilege to run. Valid options are: 15815824d651Sblueswir1 1582b3f046c2SKevin Wolf@table @option 1583ad196a9dSJan Kiszka@item vlan=@var{n} 1584ad196a9dSJan KiszkaConnect user mode stack to VLAN @var{n} (@var{n} = 0 is the default). 1585ad196a9dSJan Kiszka 158608d12022SStefan Hajnoczi@item id=@var{id} 1587ad196a9dSJan Kiszka@item name=@var{name} 1588ad196a9dSJan KiszkaAssign symbolic name for use in monitor commands. 1589ad196a9dSJan Kiszka 1590c92ef6a2SJan Kiszka@item net=@var{addr}[/@var{mask}] 1591c92ef6a2SJan KiszkaSet IP network address the guest will see. Optionally specify the netmask, 1592c92ef6a2SJan Kiszkaeither in the form a.b.c.d or as number of valid top-most bits. Default is 1593b0b36e5dSBrad Hards10.0.2.0/24. 1594c92ef6a2SJan Kiszka 1595c92ef6a2SJan Kiszka@item host=@var{addr} 1596c92ef6a2SJan KiszkaSpecify the guest-visible address of the host. Default is the 2nd IP in the 1597c92ef6a2SJan Kiszkaguest network, i.e. x.x.x.2. 1598ad196a9dSJan Kiszka 1599c54ed5bcSJan Kiszka@item restrict=on|off 1600caef55edSBrad HardsIf this option is enabled, the guest will be isolated, i.e. it will not be 1601ad196a9dSJan Kiszkaable to contact the host and no guest IP packets will be routed over the host 1602caef55edSBrad Hardsto the outside. This option does not affect any explicitly set forwarding rules. 1603ad196a9dSJan Kiszka 1604ad196a9dSJan Kiszka@item hostname=@var{name} 160563d2960bSKlaus StengelSpecifies the client hostname reported by the built-in DHCP server. 1606ad196a9dSJan Kiszka 1607c92ef6a2SJan Kiszka@item dhcpstart=@var{addr} 1608c92ef6a2SJan KiszkaSpecify the first of the 16 IPs the built-in DHCP server can assign. Default 1609b0b36e5dSBrad Hardsis the 15th to 31st IP in the guest network, i.e. x.x.x.15 to x.x.x.31. 1610c92ef6a2SJan Kiszka 1611c92ef6a2SJan Kiszka@item dns=@var{addr} 1612c92ef6a2SJan KiszkaSpecify the guest-visible address of the virtual nameserver. The address must 1613c92ef6a2SJan Kiszkabe different from the host address. Default is the 3rd IP in the guest network, 1614c92ef6a2SJan Kiszkai.e. x.x.x.3. 1615c92ef6a2SJan Kiszka 161663d2960bSKlaus Stengel@item dnssearch=@var{domain} 161763d2960bSKlaus StengelProvides an entry for the domain-search list sent by the built-in 161863d2960bSKlaus StengelDHCP server. More than one domain suffix can be transmitted by specifying 161963d2960bSKlaus Stengelthis option multiple times. If supported, this will cause the guest to 162063d2960bSKlaus Stengelautomatically try to append the given domain suffix(es) in case a domain name 162163d2960bSKlaus Stengelcan not be resolved. 162263d2960bSKlaus Stengel 162363d2960bSKlaus StengelExample: 162463d2960bSKlaus Stengel@example 162563d2960bSKlaus Stengelqemu -net user,dnssearch=mgmt.example.org,dnssearch=example.org [...] 162663d2960bSKlaus Stengel@end example 162763d2960bSKlaus Stengel 1628ad196a9dSJan Kiszka@item tftp=@var{dir} 1629ad196a9dSJan KiszkaWhen using the user mode network stack, activate a built-in TFTP 1630ad196a9dSJan Kiszkaserver. The files in @var{dir} will be exposed as the root of a TFTP server. 1631ad196a9dSJan KiszkaThe TFTP client on the guest must be configured in binary mode (use the command 1632c92ef6a2SJan Kiszka@code{bin} of the Unix TFTP client). 1633ad196a9dSJan Kiszka 1634ad196a9dSJan Kiszka@item bootfile=@var{file} 1635ad196a9dSJan KiszkaWhen using the user mode network stack, broadcast @var{file} as the BOOTP 1636ad196a9dSJan Kiszkafilename. In conjunction with @option{tftp}, this can be used to network boot 1637ad196a9dSJan Kiszkaa guest from a local directory. 1638ad196a9dSJan Kiszka 1639ad196a9dSJan KiszkaExample (using pxelinux): 1640ad196a9dSJan Kiszka@example 16413804da9dSStefan Weilqemu-system-i386 -hda linux.img -boot n -net user,tftp=/path/to/tftp/files,bootfile=/pxelinux.0 1642ad196a9dSJan Kiszka@end example 1643ad196a9dSJan Kiszka 1644c92ef6a2SJan Kiszka@item smb=@var{dir}[,smbserver=@var{addr}] 1645ad196a9dSJan KiszkaWhen using the user mode network stack, activate a built-in SMB 1646ad196a9dSJan Kiszkaserver so that Windows OSes can access to the host files in @file{@var{dir}} 1647c92ef6a2SJan Kiszkatransparently. The IP address of the SMB server can be set to @var{addr}. By 1648c92ef6a2SJan Kiszkadefault the 4th IP in the guest network is used, i.e. x.x.x.4. 1649ad196a9dSJan Kiszka 1650ad196a9dSJan KiszkaIn the guest Windows OS, the line: 1651ad196a9dSJan Kiszka@example 1652ad196a9dSJan Kiszka10.0.2.4 smbserver 1653ad196a9dSJan Kiszka@end example 1654ad196a9dSJan Kiszkamust be added in the file @file{C:\WINDOWS\LMHOSTS} (for windows 9x/Me) 1655ad196a9dSJan Kiszkaor @file{C:\WINNT\SYSTEM32\DRIVERS\ETC\LMHOSTS} (Windows NT/2000). 1656ad196a9dSJan Kiszka 1657ad196a9dSJan KiszkaThen @file{@var{dir}} can be accessed in @file{\\smbserver\qemu}. 1658ad196a9dSJan Kiszka 1659e2d8830eSBradNote that a SAMBA server must be installed on the host OS. 1660e2d8830eSBradQEMU was tested successfully with smbd versions from Red Hat 9, 1661e2d8830eSBradFedora Core 3 and OpenSUSE 11.x. 1662ad196a9dSJan Kiszka 16633c6a0580SJan Kiszka@item hostfwd=[tcp|udp]:[@var{hostaddr}]:@var{hostport}-[@var{guestaddr}]:@var{guestport} 1664c92ef6a2SJan KiszkaRedirect incoming TCP or UDP connections to the host port @var{hostport} to 1665c92ef6a2SJan Kiszkathe guest IP address @var{guestaddr} on guest port @var{guestport}. If 1666c92ef6a2SJan Kiszka@var{guestaddr} is not specified, its value is x.x.x.15 (default first address 16673c6a0580SJan Kiszkagiven by the built-in DHCP server). By specifying @var{hostaddr}, the rule can 16683c6a0580SJan Kiszkabe bound to a specific host interface. If no connection type is set, TCP is 1669c92ef6a2SJan Kiszkaused. This option can be given multiple times. 1670ad196a9dSJan Kiszka 1671ad196a9dSJan KiszkaFor example, to redirect host X11 connection from screen 1 to guest 1672ad196a9dSJan Kiszkascreen 0, use the following: 1673ad196a9dSJan Kiszka 1674ad196a9dSJan Kiszka@example 1675ad196a9dSJan Kiszka# on the host 16763804da9dSStefan Weilqemu-system-i386 -net user,hostfwd=tcp:127.0.0.1:6001-:6000 [...] 1677ad196a9dSJan Kiszka# this host xterm should open in the guest X11 server 1678ad196a9dSJan Kiszkaxterm -display :1 1679ad196a9dSJan Kiszka@end example 1680ad196a9dSJan Kiszka 1681ad196a9dSJan KiszkaTo redirect telnet connections from host port 5555 to telnet port on 1682ad196a9dSJan Kiszkathe guest, use the following: 1683ad196a9dSJan Kiszka 1684ad196a9dSJan Kiszka@example 1685ad196a9dSJan Kiszka# on the host 16863804da9dSStefan Weilqemu-system-i386 -net user,hostfwd=tcp::5555-:23 [...] 1687ad196a9dSJan Kiszkatelnet localhost 5555 1688ad196a9dSJan Kiszka@end example 1689ad196a9dSJan Kiszka 1690ad196a9dSJan KiszkaThen when you use on the host @code{telnet localhost 5555}, you 1691ad196a9dSJan Kiszkaconnect to the guest telnet server. 1692ad196a9dSJan Kiszka 1693c92ef6a2SJan Kiszka@item guestfwd=[tcp]:@var{server}:@var{port}-@var{dev} 1694b412eb61SAlexander Graf@item guestfwd=[tcp]:@var{server}:@var{port}-@var{cmd:command} 16953c6a0580SJan KiszkaForward guest TCP connections to the IP address @var{server} on port @var{port} 1696b412eb61SAlexander Grafto the character device @var{dev} or to a program executed by @var{cmd:command} 1697b412eb61SAlexander Grafwhich gets spawned for each connection. This option can be given multiple times. 1698b412eb61SAlexander Graf 169943ffe61fSStefan WeilYou can either use a chardev directly and have that one used throughout QEMU's 1700b412eb61SAlexander Graflifetime, like in the following example: 1701b412eb61SAlexander Graf 1702b412eb61SAlexander Graf@example 1703b412eb61SAlexander Graf# open 10.10.1.1:4321 on bootup, connect 10.0.2.100:1234 to it whenever 1704b412eb61SAlexander Graf# the guest accesses it 1705b412eb61SAlexander Grafqemu -net user,guestfwd=tcp:10.0.2.100:1234-tcp:10.10.1.1:4321 [...] 1706b412eb61SAlexander Graf@end example 1707b412eb61SAlexander Graf 1708b412eb61SAlexander GrafOr you can execute a command on every TCP connection established by the guest, 170943ffe61fSStefan Weilso that QEMU behaves similar to an inetd process for that virtual server: 1710b412eb61SAlexander Graf 1711b412eb61SAlexander Graf@example 1712b412eb61SAlexander Graf# call "netcat 10.10.1.1 4321" on every TCP connection to 10.0.2.100:1234 1713b412eb61SAlexander Graf# and connect the TCP stream to its stdin/stdout 1714b412eb61SAlexander Grafqemu -net 'user,guestfwd=tcp:10.0.2.100:1234-cmd:netcat 10.10.1.1 4321' 1715b412eb61SAlexander Graf@end example 1716ad196a9dSJan Kiszka 1717ad196a9dSJan Kiszka@end table 1718ad196a9dSJan Kiszka 1719ad196a9dSJan KiszkaNote: Legacy stand-alone options -tftp, -bootp, -smb and -redir are still 1720ad196a9dSJan Kiszkaprocessed and applied to -net user. Mixing them with the new configuration 1721ad196a9dSJan Kiszkasyntax gives undefined results. Their use for new applications is discouraged 1722ad196a9dSJan Kiszkaas they will be removed from future versions. 17235824d651Sblueswir1 172408d12022SStefan Hajnoczi@item -netdev tap,id=@var{id}[,fd=@var{h}][,ifname=@var{name}][,script=@var{file}][,downscript=@var{dfile}][,helper=@var{helper}] 1725a7c36ee4SCorey 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}] 1726a7c36ee4SCorey BryantConnect the host TAP network interface @var{name} to VLAN @var{n}. 1727a7c36ee4SCorey Bryant 1728a7c36ee4SCorey BryantUse the network script @var{file} to configure it and the network script 17295824d651Sblueswir1@var{dfile} to deconfigure it. If @var{name} is not provided, the OS 1730a7c36ee4SCorey Bryantautomatically provides one. The default network configure script is 1731a7c36ee4SCorey Bryant@file{/etc/qemu-ifup} and the default network deconfigure script is 1732a7c36ee4SCorey Bryant@file{/etc/qemu-ifdown}. Use @option{script=no} or @option{downscript=no} 1733a7c36ee4SCorey Bryantto disable script execution. 1734a7c36ee4SCorey Bryant 1735a7c36ee4SCorey BryantIf running QEMU as an unprivileged user, use the network helper 1736a7c36ee4SCorey Bryant@var{helper} to configure the TAP interface. The default network 1737420508fbSAmos Konghelper executable is @file{/path/to/qemu-bridge-helper}. 1738a7c36ee4SCorey Bryant 1739a7c36ee4SCorey Bryant@option{fd}=@var{h} can be used to specify the handle of an already 1740a7c36ee4SCorey Bryantopened host TAP interface. 1741a7c36ee4SCorey Bryant 1742a7c36ee4SCorey BryantExamples: 17435824d651Sblueswir1 17445824d651Sblueswir1@example 1745a7c36ee4SCorey Bryant#launch a QEMU instance with the default network script 17463804da9dSStefan Weilqemu-system-i386 linux.img -net nic -net tap 17475824d651Sblueswir1@end example 17485824d651Sblueswir1 17495824d651Sblueswir1@example 1750a7c36ee4SCorey Bryant#launch a QEMU instance with two NICs, each one connected 1751a7c36ee4SCorey Bryant#to a TAP device 17523804da9dSStefan Weilqemu-system-i386 linux.img \ 17533804da9dSStefan Weil -net nic,vlan=0 -net tap,vlan=0,ifname=tap0 \ 17545824d651Sblueswir1 -net nic,vlan=1 -net tap,vlan=1,ifname=tap1 17555824d651Sblueswir1@end example 17565824d651Sblueswir1 1757a7c36ee4SCorey Bryant@example 1758a7c36ee4SCorey Bryant#launch a QEMU instance with the default network helper to 1759a7c36ee4SCorey Bryant#connect a TAP device to bridge br0 17603804da9dSStefan Weilqemu-system-i386 linux.img \ 1761420508fbSAmos Kong -net nic -net tap,"helper=/path/to/qemu-bridge-helper" 1762a7c36ee4SCorey Bryant@end example 1763a7c36ee4SCorey Bryant 176408d12022SStefan Hajnoczi@item -netdev bridge,id=@var{id}[,br=@var{bridge}][,helper=@var{helper}] 1765a7c36ee4SCorey Bryant@item -net bridge[,vlan=@var{n}][,name=@var{name}][,br=@var{bridge}][,helper=@var{helper}] 1766a7c36ee4SCorey BryantConnect a host TAP network interface to a host bridge device. 1767a7c36ee4SCorey Bryant 1768a7c36ee4SCorey BryantUse the network helper @var{helper} to configure the TAP interface and 1769a7c36ee4SCorey Bryantattach it to the bridge. The default network helper executable is 1770420508fbSAmos Kong@file{/path/to/qemu-bridge-helper} and the default bridge 1771a7c36ee4SCorey Bryantdevice is @file{br0}. 1772a7c36ee4SCorey Bryant 1773a7c36ee4SCorey BryantExamples: 1774a7c36ee4SCorey Bryant 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 -net bridge -net nic,model=virtio 1779a7c36ee4SCorey Bryant@end example 1780a7c36ee4SCorey Bryant 1781a7c36ee4SCorey Bryant@example 1782a7c36ee4SCorey Bryant#launch a QEMU instance with the default network helper to 1783a7c36ee4SCorey Bryant#connect a TAP device to bridge qemubr0 17843804da9dSStefan Weilqemu-system-i386 linux.img -net bridge,br=qemubr0 -net nic,model=virtio 1785a7c36ee4SCorey Bryant@end example 1786a7c36ee4SCorey Bryant 178708d12022SStefan Hajnoczi@item -netdev socket,id=@var{id}[,fd=@var{h}][,listen=[@var{host}]:@var{port}][,connect=@var{host}:@var{port}] 17885824d651Sblueswir1@item -net socket[,vlan=@var{n}][,name=@var{name}][,fd=@var{h}] [,listen=[@var{host}]:@var{port}][,connect=@var{host}:@var{port}] 17895824d651Sblueswir1 17905824d651Sblueswir1Connect the VLAN @var{n} to a remote VLAN in another QEMU virtual 17915824d651Sblueswir1machine using a TCP socket connection. If @option{listen} is 17925824d651Sblueswir1specified, QEMU waits for incoming connections on @var{port} 17935824d651Sblueswir1(@var{host} is optional). @option{connect} is used to connect to 17945824d651Sblueswir1another QEMU instance using the @option{listen} option. @option{fd}=@var{h} 17955824d651Sblueswir1specifies an already opened TCP socket. 17965824d651Sblueswir1 17975824d651Sblueswir1Example: 17985824d651Sblueswir1@example 17995824d651Sblueswir1# launch a first QEMU instance 18003804da9dSStefan Weilqemu-system-i386 linux.img \ 18013804da9dSStefan Weil -net nic,macaddr=52:54:00:12:34:56 \ 18025824d651Sblueswir1 -net socket,listen=:1234 18035824d651Sblueswir1# connect the VLAN 0 of this instance to the VLAN 0 18045824d651Sblueswir1# of the first instance 18053804da9dSStefan Weilqemu-system-i386 linux.img \ 18063804da9dSStefan Weil -net nic,macaddr=52:54:00:12:34:57 \ 18075824d651Sblueswir1 -net socket,connect=127.0.0.1:1234 18085824d651Sblueswir1@end example 18095824d651Sblueswir1 181008d12022SStefan Hajnoczi@item -netdev socket,id=@var{id}[,fd=@var{h}][,mcast=@var{maddr}:@var{port}[,localaddr=@var{addr}]] 18113a75e74cSMike Ryan@item -net socket[,vlan=@var{n}][,name=@var{name}][,fd=@var{h}][,mcast=@var{maddr}:@var{port}[,localaddr=@var{addr}]] 18125824d651Sblueswir1 18135824d651Sblueswir1Create a VLAN @var{n} shared with another QEMU virtual 18145824d651Sblueswir1machines using a UDP multicast socket, effectively making a bus for 18155824d651Sblueswir1every QEMU with same multicast address @var{maddr} and @var{port}. 18165824d651Sblueswir1NOTES: 18175824d651Sblueswir1@enumerate 18185824d651Sblueswir1@item 18195824d651Sblueswir1Several QEMU can be running on different hosts and share same bus (assuming 18205824d651Sblueswir1correct multicast setup for these hosts). 18215824d651Sblueswir1@item 18225824d651Sblueswir1mcast support is compatible with User Mode Linux (argument @option{eth@var{N}=mcast}), see 18235824d651Sblueswir1@url{http://user-mode-linux.sf.net}. 18245824d651Sblueswir1@item 18255824d651Sblueswir1Use @option{fd=h} to specify an already opened UDP multicast socket. 18265824d651Sblueswir1@end enumerate 18275824d651Sblueswir1 18285824d651Sblueswir1Example: 18295824d651Sblueswir1@example 18305824d651Sblueswir1# launch one QEMU instance 18313804da9dSStefan Weilqemu-system-i386 linux.img \ 18323804da9dSStefan Weil -net nic,macaddr=52:54:00:12:34:56 \ 18335824d651Sblueswir1 -net socket,mcast=230.0.0.1:1234 18345824d651Sblueswir1# launch another QEMU instance on same "bus" 18353804da9dSStefan Weilqemu-system-i386 linux.img \ 18363804da9dSStefan Weil -net nic,macaddr=52:54:00:12:34:57 \ 18375824d651Sblueswir1 -net socket,mcast=230.0.0.1:1234 18385824d651Sblueswir1# launch yet another QEMU instance on same "bus" 18393804da9dSStefan Weilqemu-system-i386 linux.img \ 18403804da9dSStefan Weil -net nic,macaddr=52:54:00:12:34:58 \ 18415824d651Sblueswir1 -net socket,mcast=230.0.0.1:1234 18425824d651Sblueswir1@end example 18435824d651Sblueswir1 18445824d651Sblueswir1Example (User Mode Linux compat.): 18455824d651Sblueswir1@example 18465824d651Sblueswir1# launch QEMU instance (note mcast address selected 18475824d651Sblueswir1# is UML's default) 18483804da9dSStefan Weilqemu-system-i386 linux.img \ 18493804da9dSStefan Weil -net nic,macaddr=52:54:00:12:34:56 \ 18505824d651Sblueswir1 -net socket,mcast=239.192.168.1:1102 18515824d651Sblueswir1# launch UML 18525824d651Sblueswir1/path/to/linux ubd0=/path/to/root_fs eth0=mcast 18535824d651Sblueswir1@end example 18545824d651Sblueswir1 18553a75e74cSMike RyanExample (send packets from host's 1.2.3.4): 18563a75e74cSMike Ryan@example 18573804da9dSStefan Weilqemu-system-i386 linux.img \ 18583804da9dSStefan Weil -net nic,macaddr=52:54:00:12:34:56 \ 18593a75e74cSMike Ryan -net socket,mcast=239.192.168.1:1102,localaddr=1.2.3.4 18603a75e74cSMike Ryan@end example 18613a75e74cSMike Ryan 18623fb69aa1SAnton 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}] 18633fb69aa1SAnton 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}] 18643fb69aa1SAnton IvanovConnect VLAN @var{n} to L2TPv3 pseudowire. L2TPv3 (RFC3391) is a popular 18653fb69aa1SAnton Ivanovprotocol to transport Ethernet (and other Layer 2) data frames between 18663fb69aa1SAnton Ivanovtwo systems. It is present in routers, firewalls and the Linux kernel 18673fb69aa1SAnton Ivanov(from version 3.3 onwards). 18683fb69aa1SAnton Ivanov 18693fb69aa1SAnton IvanovThis transport allows a VM to communicate to another VM, router or firewall directly. 18703fb69aa1SAnton Ivanov 18713fb69aa1SAnton Ivanov@item src=@var{srcaddr} 18723fb69aa1SAnton Ivanov source address (mandatory) 18733fb69aa1SAnton Ivanov@item dst=@var{dstaddr} 18743fb69aa1SAnton Ivanov destination address (mandatory) 18753fb69aa1SAnton Ivanov@item udp 18763fb69aa1SAnton Ivanov select udp encapsulation (default is ip). 18773fb69aa1SAnton Ivanov@item srcport=@var{srcport} 18783fb69aa1SAnton Ivanov source udp port. 18793fb69aa1SAnton Ivanov@item dstport=@var{dstport} 18803fb69aa1SAnton Ivanov destination udp port. 18813fb69aa1SAnton Ivanov@item ipv6 18823fb69aa1SAnton Ivanov force v6, otherwise defaults to v4. 18833fb69aa1SAnton Ivanov@item rxcookie=@var{rxcookie} 18843fb69aa1SAnton Ivanov@item txcookie=@var{txcookie} 18853fb69aa1SAnton Ivanov Cookies are a weak form of security in the l2tpv3 specification. 18863fb69aa1SAnton IvanovTheir function is mostly to prevent misconfiguration. By default they are 32 18873fb69aa1SAnton Ivanovbit. 18883fb69aa1SAnton Ivanov@item cookie64 18893fb69aa1SAnton Ivanov Set cookie size to 64 bit instead of the default 32 18903fb69aa1SAnton Ivanov@item counter=off 18913fb69aa1SAnton Ivanov Force a 'cut-down' L2TPv3 with no counter as in 18923fb69aa1SAnton Ivanovdraft-mkonstan-l2tpext-keyed-ipv6-tunnel-00 18933fb69aa1SAnton Ivanov@item pincounter=on 18943fb69aa1SAnton Ivanov Work around broken counter handling in peer. This may also help on 18953fb69aa1SAnton Ivanovnetworks which have packet reorder. 18963fb69aa1SAnton Ivanov@item offset=@var{offset} 18973fb69aa1SAnton Ivanov Add an extra offset between header and data 18983fb69aa1SAnton Ivanov 18993fb69aa1SAnton IvanovFor example, to attach a VM running on host 4.3.2.1 via L2TPv3 to the bridge br-lan 19003fb69aa1SAnton Ivanovon the remote Linux host 1.2.3.4: 19013fb69aa1SAnton Ivanov@example 19023fb69aa1SAnton Ivanov# Setup tunnel on linux host using raw ip as encapsulation 19033fb69aa1SAnton Ivanov# on 1.2.3.4 19043fb69aa1SAnton Ivanovip l2tp add tunnel remote 4.3.2.1 local 1.2.3.4 tunnel_id 1 peer_tunnel_id 1 \ 19053fb69aa1SAnton Ivanov encap udp udp_sport 16384 udp_dport 16384 19063fb69aa1SAnton Ivanovip l2tp add session tunnel_id 1 name vmtunnel0 session_id \ 19073fb69aa1SAnton Ivanov 0xFFFFFFFF peer_session_id 0xFFFFFFFF 19083fb69aa1SAnton Ivanovifconfig vmtunnel0 mtu 1500 19093fb69aa1SAnton Ivanovifconfig vmtunnel0 up 19103fb69aa1SAnton Ivanovbrctl addif br-lan vmtunnel0 19113fb69aa1SAnton Ivanov 19123fb69aa1SAnton Ivanov 19133fb69aa1SAnton Ivanov# on 4.3.2.1 19143fb69aa1SAnton Ivanov# launch QEMU instance - if your network has reorder or is very lossy add ,pincounter 19153fb69aa1SAnton Ivanov 19163fb69aa1SAnton 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 19173fb69aa1SAnton Ivanov 19183fb69aa1SAnton Ivanov 19193fb69aa1SAnton Ivanov@end example 19203fb69aa1SAnton Ivanov 192108d12022SStefan Hajnoczi@item -netdev vde,id=@var{id}[,sock=@var{socketpath}][,port=@var{n}][,group=@var{groupname}][,mode=@var{octalmode}] 19225824d651Sblueswir1@item -net vde[,vlan=@var{n}][,name=@var{name}][,sock=@var{socketpath}] [,port=@var{n}][,group=@var{groupname}][,mode=@var{octalmode}] 19235824d651Sblueswir1Connect VLAN @var{n} to PORT @var{n} of a vde switch running on host and 19245824d651Sblueswir1listening for incoming connections on @var{socketpath}. Use GROUP @var{groupname} 19255824d651Sblueswir1and MODE @var{octalmode} to change default ownership and permissions for 1926c1ba4e0bSStefan Weilcommunication port. This option is only available if QEMU has been compiled 19275824d651Sblueswir1with vde support enabled. 19285824d651Sblueswir1 19295824d651Sblueswir1Example: 19305824d651Sblueswir1@example 19315824d651Sblueswir1# launch vde switch 19325824d651Sblueswir1vde_switch -F -sock /tmp/myswitch 19335824d651Sblueswir1# launch QEMU instance 19343804da9dSStefan Weilqemu-system-i386 linux.img -net nic -net vde,sock=/tmp/myswitch 19355824d651Sblueswir1@end example 19365824d651Sblueswir1 193740e8c26dSStefan Hajnoczi@item -netdev hubport,id=@var{id},hubid=@var{hubid} 193840e8c26dSStefan Hajnoczi 193940e8c26dSStefan HajnocziCreate a hub port on QEMU "vlan" @var{hubid}. 194040e8c26dSStefan Hajnoczi 194140e8c26dSStefan HajnocziThe hubport netdev lets you connect a NIC to a QEMU "vlan" instead of a single 194240e8c26dSStefan Hajnoczinetdev. @code{-net} and @code{-device} with parameter @option{vlan} create the 194340e8c26dSStefan Hajnoczirequired hub automatically. 194440e8c26dSStefan Hajnoczi 194503ce5744SNikolay Nikolaev@item -netdev vhost-user,chardev=@var{id}[,vhostforce=on|off] 194603ce5744SNikolay Nikolaev 194703ce5744SNikolay NikolaevEstablish a vhost-user netdev, backed by a chardev @var{id}. The chardev should 194803ce5744SNikolay Nikolaevbe a unix domain socket backed one. The vhost-user uses a specifically defined 194903ce5744SNikolay Nikolaevprotocol to pass vhost ioctl replacement messages to an application on the other 195003ce5744SNikolay Nikolaevend of the socket. On non-MSIX guests, the feature can be forced with 195103ce5744SNikolay Nikolaev@var{vhostforce}. 195203ce5744SNikolay Nikolaev 195303ce5744SNikolay NikolaevExample: 195403ce5744SNikolay Nikolaev@example 195503ce5744SNikolay Nikolaevqemu -m 512 -object memory-backend-file,id=mem,size=512M,mem-path=/hugetlbfs,share=on \ 195603ce5744SNikolay Nikolaev -numa node,memdev=mem \ 195703ce5744SNikolay Nikolaev -chardev socket,path=/path/to/socket \ 195803ce5744SNikolay Nikolaev -netdev type=vhost-user,id=net0,chardev=chr0 \ 195903ce5744SNikolay Nikolaev -device virtio-net-pci,netdev=net0 196003ce5744SNikolay Nikolaev@end example 196103ce5744SNikolay Nikolaev 1962bb9ea79eSaliguori@item -net dump[,vlan=@var{n}][,file=@var{file}][,len=@var{len}] 1963bb9ea79eSaliguoriDump network traffic on VLAN @var{n} to file @var{file} (@file{qemu-vlan0.pcap} by default). 1964bb9ea79eSaliguoriAt most @var{len} bytes (64k by default) per packet are stored. The file format is 1965bb9ea79eSaliguorilibpcap, so it can be analyzed with tools such as tcpdump or Wireshark. 1966bb9ea79eSaliguori 19675824d651Sblueswir1@item -net none 19685824d651Sblueswir1Indicate that no network devices should be configured. It is used to 19695824d651Sblueswir1override the default configuration (@option{-net nic -net user}) which 19705824d651Sblueswir1is activated if no @option{-net} options are provided. 19715824d651Sblueswir1ETEXI 19725824d651Sblueswir1 1973c70a01e4SMarkus ArmbrusterSTEXI 1974c70a01e4SMarkus Armbruster@end table 1975c70a01e4SMarkus ArmbrusterETEXI 19767273a2dbSMatthew BoothDEFHEADING() 19777273a2dbSMatthew Booth 19787273a2dbSMatthew BoothDEFHEADING(Character device options:) 1979c70a01e4SMarkus ArmbrusterSTEXI 1980c70a01e4SMarkus Armbruster 1981c70a01e4SMarkus ArmbrusterThe general form of a character device option is: 1982c70a01e4SMarkus Armbruster@table @option 1983c70a01e4SMarkus ArmbrusterETEXI 19847273a2dbSMatthew Booth 19857273a2dbSMatthew BoothDEF("chardev", HAS_ARG, QEMU_OPTION_chardev, 198697331287SJan Kiszka "-chardev null,id=id[,mux=on|off]\n" 19875dd1f02bSCorey Minyard "-chardev socket,id=id[,host=host],port=port[,to=to][,ipv4][,ipv6][,nodelay][,reconnect=seconds]\n" 19885dd1f02bSCorey Minyard " [,server][,nowait][,telnet][,reconnect=seconds][,mux=on|off] (tcp)\n" 19895dd1f02bSCorey Minyard "-chardev socket,id=id,path=path[,server][,nowait][,telnet][,reconnect=seconds][,mux=on|off] (unix)\n" 19907273a2dbSMatthew Booth "-chardev udp,id=id[,host=host],port=port[,localaddr=localaddr]\n" 199197331287SJan Kiszka " [,localport=localport][,ipv4][,ipv6][,mux=on|off]\n" 199297331287SJan Kiszka "-chardev msmouse,id=id[,mux=on|off]\n" 19937273a2dbSMatthew Booth "-chardev vc,id=id[[,width=width][,height=height]][[,cols=cols][,rows=rows]]\n" 199497331287SJan Kiszka " [,mux=on|off]\n" 19954f57378fSMarkus Armbruster "-chardev ringbuf,id=id[,size=size]\n" 199697331287SJan Kiszka "-chardev file,id=id,path=path[,mux=on|off]\n" 199797331287SJan Kiszka "-chardev pipe,id=id,path=path[,mux=on|off]\n" 19987273a2dbSMatthew Booth#ifdef _WIN32 199997331287SJan Kiszka "-chardev console,id=id[,mux=on|off]\n" 200097331287SJan Kiszka "-chardev serial,id=id,path=path[,mux=on|off]\n" 20017273a2dbSMatthew Booth#else 200297331287SJan Kiszka "-chardev pty,id=id[,mux=on|off]\n" 2003b7fdb3abSAurelien Jarno "-chardev stdio,id=id[,mux=on|off][,signal=on|off]\n" 20047273a2dbSMatthew Booth#endif 20057273a2dbSMatthew Booth#ifdef CONFIG_BRLAPI 200697331287SJan Kiszka "-chardev braille,id=id[,mux=on|off]\n" 20077273a2dbSMatthew Booth#endif 20087273a2dbSMatthew Booth#if defined(__linux__) || defined(__sun__) || defined(__FreeBSD__) \ 20097273a2dbSMatthew Booth || defined(__NetBSD__) || defined(__OpenBSD__) || defined(__DragonFly__) 2010d59044efSGerd Hoffmann "-chardev serial,id=id,path=path[,mux=on|off]\n" 201197331287SJan Kiszka "-chardev tty,id=id,path=path[,mux=on|off]\n" 20127273a2dbSMatthew Booth#endif 20137273a2dbSMatthew Booth#if defined(__linux__) || defined(__FreeBSD__) || defined(__DragonFly__) 201488a946d3SGerd Hoffmann "-chardev parallel,id=id,path=path[,mux=on|off]\n" 201597331287SJan Kiszka "-chardev parport,id=id,path=path[,mux=on|off]\n" 20167273a2dbSMatthew Booth#endif 2017cbcc6336SAlon Levy#if defined(CONFIG_SPICE) 2018cbcc6336SAlon Levy "-chardev spicevmc,id=id,name=name[,debug=debug]\n" 20195a49d3e9SMarc-André Lureau "-chardev spiceport,id=id,name=name[,debug=debug]\n" 2020cbcc6336SAlon Levy#endif 2021ad96090aSBlue Swirl , QEMU_ARCH_ALL 20227273a2dbSMatthew Booth) 20237273a2dbSMatthew Booth 20247273a2dbSMatthew BoothSTEXI 202597331287SJan Kiszka@item -chardev @var{backend} ,id=@var{id} [,mux=on|off] [,@var{options}] 20266616b2adSStefan Weil@findex -chardev 20277273a2dbSMatthew BoothBackend is one of: 20287273a2dbSMatthew Booth@option{null}, 20297273a2dbSMatthew Booth@option{socket}, 20307273a2dbSMatthew Booth@option{udp}, 20317273a2dbSMatthew Booth@option{msmouse}, 20327273a2dbSMatthew Booth@option{vc}, 20334f57378fSMarkus Armbruster@option{ringbuf}, 20347273a2dbSMatthew Booth@option{file}, 20357273a2dbSMatthew Booth@option{pipe}, 20367273a2dbSMatthew Booth@option{console}, 20377273a2dbSMatthew Booth@option{serial}, 20387273a2dbSMatthew Booth@option{pty}, 20397273a2dbSMatthew Booth@option{stdio}, 20407273a2dbSMatthew Booth@option{braille}, 20417273a2dbSMatthew Booth@option{tty}, 204288a946d3SGerd Hoffmann@option{parallel}, 2043cbcc6336SAlon Levy@option{parport}, 2044cbcc6336SAlon Levy@option{spicevmc}. 20455a49d3e9SMarc-André Lureau@option{spiceport}. 20467273a2dbSMatthew BoothThe specific backend will determine the applicable options. 20477273a2dbSMatthew Booth 20487273a2dbSMatthew BoothAll devices must have an id, which can be any string up to 127 characters long. 20497273a2dbSMatthew BoothIt is used to uniquely identify this device in other command line directives. 20507273a2dbSMatthew Booth 205197331287SJan KiszkaA character device may be used in multiplexing mode by multiple front-ends. 205297331287SJan KiszkaThe key sequence of @key{Control-a} and @key{c} will rotate the input focus 205397331287SJan Kiszkabetween attached front-ends. Specify @option{mux=on} to enable this mode. 205497331287SJan Kiszka 20557273a2dbSMatthew BoothOptions to each backend are described below. 20567273a2dbSMatthew Booth 20577273a2dbSMatthew Booth@item -chardev null ,id=@var{id} 20587273a2dbSMatthew BoothA void device. This device will not emit any data, and will drop any data it 20597273a2dbSMatthew Boothreceives. The null backend does not take any options. 20607273a2dbSMatthew Booth 20615dd1f02bSCorey Minyard@item -chardev socket ,id=@var{id} [@var{TCP options} or @var{unix options}] [,server] [,nowait] [,telnet] [,reconnect=@var{seconds}] 20627273a2dbSMatthew Booth 20637273a2dbSMatthew BoothCreate a two-way stream socket, which can be either a TCP or a unix socket. A 20647273a2dbSMatthew Boothunix socket will be created if @option{path} is specified. Behaviour is 20657273a2dbSMatthew Boothundefined if TCP options are specified for a unix socket. 20667273a2dbSMatthew Booth 20677273a2dbSMatthew Booth@option{server} specifies that the socket shall be a listening socket. 20687273a2dbSMatthew Booth 20697273a2dbSMatthew Booth@option{nowait} specifies that QEMU should not block waiting for a client to 20707273a2dbSMatthew Boothconnect to a listening socket. 20717273a2dbSMatthew Booth 20727273a2dbSMatthew Booth@option{telnet} specifies that traffic on the socket should interpret telnet 20737273a2dbSMatthew Boothescape sequences. 20747273a2dbSMatthew Booth 20755dd1f02bSCorey Minyard@option{reconnect} sets the timeout for reconnecting on non-server sockets when 20765dd1f02bSCorey Minyardthe remote end goes away. qemu will delay this many seconds and then attempt 20775dd1f02bSCorey Minyardto reconnect. Zero disables reconnecting, and is the default. 20785dd1f02bSCorey Minyard 20797273a2dbSMatthew BoothTCP and unix socket options are given below: 20807273a2dbSMatthew Booth 20817273a2dbSMatthew Booth@table @option 20827273a2dbSMatthew Booth 20838d533561SAurelien Jarno@item TCP options: port=@var{port} [,host=@var{host}] [,to=@var{to}] [,ipv4] [,ipv6] [,nodelay] 20847273a2dbSMatthew Booth 20857273a2dbSMatthew Booth@option{host} for a listening socket specifies the local address to be bound. 20867273a2dbSMatthew BoothFor a connecting socket species the remote host to connect to. @option{host} is 20877273a2dbSMatthew Boothoptional for listening sockets. If not specified it defaults to @code{0.0.0.0}. 20887273a2dbSMatthew Booth 20897273a2dbSMatthew Booth@option{port} for a listening socket specifies the local port to be bound. For a 20907273a2dbSMatthew Boothconnecting socket specifies the port on the remote host to connect to. 20917273a2dbSMatthew Booth@option{port} can be given as either a port number or a service name. 20927273a2dbSMatthew Booth@option{port} is required. 20937273a2dbSMatthew Booth 20947273a2dbSMatthew Booth@option{to} is only relevant to listening sockets. If it is specified, and 20957273a2dbSMatthew Booth@option{port} cannot be bound, QEMU will attempt to bind to subsequent ports up 20967273a2dbSMatthew Boothto and including @option{to} until it succeeds. @option{to} must be specified 20977273a2dbSMatthew Boothas a port number. 20987273a2dbSMatthew Booth 20997273a2dbSMatthew Booth@option{ipv4} and @option{ipv6} specify that either IPv4 or IPv6 must be used. 21007273a2dbSMatthew BoothIf neither is specified the socket may use either protocol. 21017273a2dbSMatthew Booth 21027273a2dbSMatthew Booth@option{nodelay} disables the Nagle algorithm. 21037273a2dbSMatthew Booth 21047273a2dbSMatthew Booth@item unix options: path=@var{path} 21057273a2dbSMatthew Booth 21067273a2dbSMatthew Booth@option{path} specifies the local path of the unix socket. @option{path} is 21077273a2dbSMatthew Boothrequired. 21087273a2dbSMatthew Booth 21097273a2dbSMatthew Booth@end table 21107273a2dbSMatthew Booth 21117273a2dbSMatthew Booth@item -chardev udp ,id=@var{id} [,host=@var{host}] ,port=@var{port} [,localaddr=@var{localaddr}] [,localport=@var{localport}] [,ipv4] [,ipv6] 21127273a2dbSMatthew Booth 21137273a2dbSMatthew BoothSends all traffic from the guest to a remote host over UDP. 21147273a2dbSMatthew Booth 21157273a2dbSMatthew Booth@option{host} specifies the remote host to connect to. If not specified it 21167273a2dbSMatthew Boothdefaults to @code{localhost}. 21177273a2dbSMatthew Booth 21187273a2dbSMatthew Booth@option{port} specifies the port on the remote host to connect to. @option{port} 21197273a2dbSMatthew Boothis required. 21207273a2dbSMatthew Booth 21217273a2dbSMatthew Booth@option{localaddr} specifies the local address to bind to. If not specified it 21227273a2dbSMatthew Boothdefaults to @code{0.0.0.0}. 21237273a2dbSMatthew Booth 21247273a2dbSMatthew Booth@option{localport} specifies the local port to bind to. If not specified any 21257273a2dbSMatthew Boothavailable local port will be used. 21267273a2dbSMatthew Booth 21277273a2dbSMatthew Booth@option{ipv4} and @option{ipv6} specify that either IPv4 or IPv6 must be used. 21287273a2dbSMatthew BoothIf neither is specified the device may use either protocol. 21297273a2dbSMatthew Booth 21307273a2dbSMatthew Booth@item -chardev msmouse ,id=@var{id} 21317273a2dbSMatthew Booth 21327273a2dbSMatthew BoothForward QEMU's emulated msmouse events to the guest. @option{msmouse} does not 21337273a2dbSMatthew Boothtake any options. 21347273a2dbSMatthew Booth 21357273a2dbSMatthew Booth@item -chardev vc ,id=@var{id} [[,width=@var{width}] [,height=@var{height}]] [[,cols=@var{cols}] [,rows=@var{rows}]] 21367273a2dbSMatthew Booth 21377273a2dbSMatthew BoothConnect to a QEMU text console. @option{vc} may optionally be given a specific 21387273a2dbSMatthew Boothsize. 21397273a2dbSMatthew Booth 21407273a2dbSMatthew Booth@option{width} and @option{height} specify the width and height respectively of 21417273a2dbSMatthew Booththe console, in pixels. 21427273a2dbSMatthew Booth 21437273a2dbSMatthew Booth@option{cols} and @option{rows} specify that the console be sized to fit a text 21447273a2dbSMatthew Boothconsole with the given dimensions. 21457273a2dbSMatthew Booth 21464f57378fSMarkus Armbruster@item -chardev ringbuf ,id=@var{id} [,size=@var{size}] 214751767e7cSLei Li 21483949e594SMarkus ArmbrusterCreate a ring buffer with fixed size @option{size}. 21493949e594SMarkus Armbruster@var{size} must be a power of two, and defaults to @code{64K}). 215051767e7cSLei Li 21517273a2dbSMatthew Booth@item -chardev file ,id=@var{id} ,path=@var{path} 21527273a2dbSMatthew Booth 21537273a2dbSMatthew BoothLog all traffic received from the guest to a file. 21547273a2dbSMatthew Booth 21557273a2dbSMatthew Booth@option{path} specifies the path of the file to be opened. This file will be 21567273a2dbSMatthew Boothcreated if it does not already exist, and overwritten if it does. @option{path} 21577273a2dbSMatthew Boothis required. 21587273a2dbSMatthew Booth 21597273a2dbSMatthew Booth@item -chardev pipe ,id=@var{id} ,path=@var{path} 21607273a2dbSMatthew Booth 21617273a2dbSMatthew BoothCreate a two-way connection to the guest. The behaviour differs slightly between 21627273a2dbSMatthew BoothWindows hosts and other hosts: 21637273a2dbSMatthew Booth 21647273a2dbSMatthew BoothOn Windows, a single duplex pipe will be created at 21657273a2dbSMatthew Booth@file{\\.pipe\@option{path}}. 21667273a2dbSMatthew Booth 21677273a2dbSMatthew BoothOn other hosts, 2 pipes will be created called @file{@option{path}.in} and 21687273a2dbSMatthew Booth@file{@option{path}.out}. Data written to @file{@option{path}.in} will be 21697273a2dbSMatthew Boothreceived by the guest. Data written by the guest can be read from 21707273a2dbSMatthew Booth@file{@option{path}.out}. QEMU will not create these fifos, and requires them to 21717273a2dbSMatthew Boothbe present. 21727273a2dbSMatthew Booth 21737273a2dbSMatthew Booth@option{path} forms part of the pipe path as described above. @option{path} is 21747273a2dbSMatthew Boothrequired. 21757273a2dbSMatthew Booth 21767273a2dbSMatthew Booth@item -chardev console ,id=@var{id} 21777273a2dbSMatthew Booth 21787273a2dbSMatthew BoothSend traffic from the guest to QEMU's standard output. @option{console} does not 21797273a2dbSMatthew Boothtake any options. 21807273a2dbSMatthew Booth 21817273a2dbSMatthew Booth@option{console} is only available on Windows hosts. 21827273a2dbSMatthew Booth 21837273a2dbSMatthew Booth@item -chardev serial ,id=@var{id} ,path=@option{path} 21847273a2dbSMatthew Booth 21857273a2dbSMatthew BoothSend traffic from the guest to a serial device on the host. 21867273a2dbSMatthew Booth 2187d59044efSGerd HoffmannOn Unix hosts serial will actually accept any tty device, 2188d59044efSGerd Hoffmannnot only serial lines. 21897273a2dbSMatthew Booth 21907273a2dbSMatthew Booth@option{path} specifies the name of the serial device to open. 21917273a2dbSMatthew Booth 21927273a2dbSMatthew Booth@item -chardev pty ,id=@var{id} 21937273a2dbSMatthew Booth 21947273a2dbSMatthew BoothCreate a new pseudo-terminal on the host and connect to it. @option{pty} does 21957273a2dbSMatthew Boothnot take any options. 21967273a2dbSMatthew Booth 21977273a2dbSMatthew Booth@option{pty} is not available on Windows hosts. 21987273a2dbSMatthew Booth 2199b7fdb3abSAurelien Jarno@item -chardev stdio ,id=@var{id} [,signal=on|off] 2200b65ee4faSStefan WeilConnect to standard input and standard output of the QEMU process. 2201b7fdb3abSAurelien Jarno 2202b7fdb3abSAurelien Jarno@option{signal} controls if signals are enabled on the terminal, that includes 2203b7fdb3abSAurelien Jarnoexiting QEMU with the key sequence @key{Control-c}. This option is enabled by 2204b7fdb3abSAurelien Jarnodefault, use @option{signal=off} to disable it. 2205b7fdb3abSAurelien Jarno 2206b7fdb3abSAurelien Jarno@option{stdio} is not available on Windows hosts. 22077273a2dbSMatthew Booth 22087273a2dbSMatthew Booth@item -chardev braille ,id=@var{id} 22097273a2dbSMatthew Booth 22107273a2dbSMatthew BoothConnect to a local BrlAPI server. @option{braille} does not take any options. 22117273a2dbSMatthew Booth 22127273a2dbSMatthew Booth@item -chardev tty ,id=@var{id} ,path=@var{path} 22137273a2dbSMatthew Booth 22147273a2dbSMatthew Booth@option{tty} is only available on Linux, Sun, FreeBSD, NetBSD, OpenBSD and 2215d037d6bbSMarkus ArmbrusterDragonFlyBSD hosts. It is an alias for @option{serial}. 22167273a2dbSMatthew Booth 22177273a2dbSMatthew Booth@option{path} specifies the path to the tty. @option{path} is required. 22187273a2dbSMatthew Booth 221988a946d3SGerd Hoffmann@item -chardev parallel ,id=@var{id} ,path=@var{path} 22207273a2dbSMatthew Booth@item -chardev parport ,id=@var{id} ,path=@var{path} 22217273a2dbSMatthew Booth 222288a946d3SGerd Hoffmann@option{parallel} is only available on Linux, FreeBSD and DragonFlyBSD hosts. 22237273a2dbSMatthew Booth 22247273a2dbSMatthew BoothConnect to a local parallel port. 22257273a2dbSMatthew Booth 22267273a2dbSMatthew Booth@option{path} specifies the path to the parallel port device. @option{path} is 22277273a2dbSMatthew Boothrequired. 22287273a2dbSMatthew Booth 2229cbcc6336SAlon Levy@item -chardev spicevmc ,id=@var{id} ,debug=@var{debug}, name=@var{name} 2230cbcc6336SAlon Levy 22313a846906SStefan Hajnoczi@option{spicevmc} is only available when spice support is built in. 22323a846906SStefan Hajnoczi 2233cbcc6336SAlon Levy@option{debug} debug level for spicevmc 2234cbcc6336SAlon Levy 2235cbcc6336SAlon Levy@option{name} name of spice channel to connect to 2236cbcc6336SAlon Levy 2237cbcc6336SAlon LevyConnect to a spice virtual machine channel, such as vdiport. 2238cbcc6336SAlon Levy 22395a49d3e9SMarc-André Lureau@item -chardev spiceport ,id=@var{id} ,debug=@var{debug}, name=@var{name} 22405a49d3e9SMarc-André Lureau 22415a49d3e9SMarc-André Lureau@option{spiceport} is only available when spice support is built in. 22425a49d3e9SMarc-André Lureau 22435a49d3e9SMarc-André Lureau@option{debug} debug level for spicevmc 22445a49d3e9SMarc-André Lureau 22455a49d3e9SMarc-André Lureau@option{name} name of spice port to connect to 22465a49d3e9SMarc-André Lureau 22475a49d3e9SMarc-André LureauConnect to a spice port, allowing a Spice client to handle the traffic 22485a49d3e9SMarc-André Lureauidentified by a name (preferably a fqdn). 22497273a2dbSMatthew BoothETEXI 22507273a2dbSMatthew Booth 2251c70a01e4SMarkus ArmbrusterSTEXI 2252c70a01e4SMarkus Armbruster@end table 2253c70a01e4SMarkus ArmbrusterETEXI 22547273a2dbSMatthew BoothDEFHEADING() 22557273a2dbSMatthew Booth 22560f5314a2SRonnie SahlbergDEFHEADING(Device URL Syntax:) 2257c70a01e4SMarkus ArmbrusterSTEXI 22580f5314a2SRonnie Sahlberg 22590f5314a2SRonnie SahlbergIn addition to using normal file images for the emulated storage devices, 22600f5314a2SRonnie SahlbergQEMU can also use networked resources such as iSCSI devices. These are 22610f5314a2SRonnie Sahlbergspecified using a special URL syntax. 22620f5314a2SRonnie Sahlberg 22630f5314a2SRonnie Sahlberg@table @option 22640f5314a2SRonnie Sahlberg@item iSCSI 22650f5314a2SRonnie SahlbergiSCSI support allows QEMU to access iSCSI resources directly and use as 22660f5314a2SRonnie Sahlbergimages for the guest storage. Both disk and cdrom images are supported. 22670f5314a2SRonnie Sahlberg 22680f5314a2SRonnie SahlbergSyntax for specifying iSCSI LUNs is 22690f5314a2SRonnie Sahlberg``iscsi://<target-ip>[:<port>]/<target-iqn>/<lun>'' 22700f5314a2SRonnie Sahlberg 227131459f46SRonnie SahlbergBy default qemu will use the iSCSI initiator-name 227231459f46SRonnie Sahlberg'iqn.2008-11.org.linux-kvm[:<name>]' but this can also be set from the command 227331459f46SRonnie Sahlbergline or a configuration file. 227431459f46SRonnie Sahlberg 227531459f46SRonnie Sahlberg 22760f5314a2SRonnie SahlbergExample (without authentication): 22770f5314a2SRonnie Sahlberg@example 22783804da9dSStefan Weilqemu-system-i386 -iscsi initiator-name=iqn.2001-04.com.example:my-initiator \ 2279f9dadc98SRonnie Sahlberg -cdrom iscsi://192.0.2.1/iqn.2001-04.com.example/2 \ 2280f9dadc98SRonnie Sahlberg -drive file=iscsi://192.0.2.1/iqn.2001-04.com.example/1 22810f5314a2SRonnie Sahlberg@end example 22820f5314a2SRonnie Sahlberg 22830f5314a2SRonnie SahlbergExample (CHAP username/password via URL): 22840f5314a2SRonnie Sahlberg@example 22853804da9dSStefan Weilqemu-system-i386 -drive file=iscsi://user%password@@192.0.2.1/iqn.2001-04.com.example/1 22860f5314a2SRonnie Sahlberg@end example 22870f5314a2SRonnie Sahlberg 22880f5314a2SRonnie SahlbergExample (CHAP username/password via environment variables): 22890f5314a2SRonnie Sahlberg@example 22900f5314a2SRonnie SahlbergLIBISCSI_CHAP_USERNAME="user" \ 22910f5314a2SRonnie SahlbergLIBISCSI_CHAP_PASSWORD="password" \ 22923804da9dSStefan Weilqemu-system-i386 -drive file=iscsi://192.0.2.1/iqn.2001-04.com.example/1 22930f5314a2SRonnie Sahlberg@end example 22940f5314a2SRonnie Sahlberg 22950f5314a2SRonnie SahlbergiSCSI support is an optional feature of QEMU and only available when 22960f5314a2SRonnie Sahlbergcompiled and linked against libiscsi. 2297f9dadc98SRonnie SahlbergETEXI 2298f9dadc98SRonnie SahlbergDEF("iscsi", HAS_ARG, QEMU_OPTION_iscsi, 2299f9dadc98SRonnie Sahlberg "-iscsi [user=user][,password=password]\n" 2300f9dadc98SRonnie Sahlberg " [,header-digest=CRC32C|CR32C-NONE|NONE-CRC32C|NONE\n" 23012fe3798cSPaolo Bonzini " [,initiator-name=initiator-iqn][,id=target-iqn]\n" 2302f9dadc98SRonnie Sahlberg " iSCSI session parameters\n", QEMU_ARCH_ALL) 2303f9dadc98SRonnie SahlbergSTEXI 23040f5314a2SRonnie Sahlberg 230531459f46SRonnie SahlbergiSCSI parameters such as username and password can also be specified via 230631459f46SRonnie Sahlberga configuration file. See qemu-doc for more information and examples. 230731459f46SRonnie Sahlberg 230808ae330eSRonnie Sahlberg@item NBD 230908ae330eSRonnie SahlbergQEMU supports NBD (Network Block Devices) both using TCP protocol as well 231008ae330eSRonnie Sahlbergas Unix Domain Sockets. 231108ae330eSRonnie Sahlberg 231208ae330eSRonnie SahlbergSyntax for specifying a NBD device using TCP 231308ae330eSRonnie Sahlberg``nbd:<server-ip>:<port>[:exportname=<export>]'' 231408ae330eSRonnie Sahlberg 231508ae330eSRonnie SahlbergSyntax for specifying a NBD device using Unix Domain Sockets 231608ae330eSRonnie Sahlberg``nbd:unix:<domain-socket>[:exportname=<export>]'' 231708ae330eSRonnie Sahlberg 231808ae330eSRonnie Sahlberg 231908ae330eSRonnie SahlbergExample for TCP 232008ae330eSRonnie Sahlberg@example 23213804da9dSStefan Weilqemu-system-i386 --drive file=nbd:192.0.2.1:30000 232208ae330eSRonnie Sahlberg@end example 232308ae330eSRonnie Sahlberg 232408ae330eSRonnie SahlbergExample for Unix Domain Sockets 232508ae330eSRonnie Sahlberg@example 23263804da9dSStefan Weilqemu-system-i386 --drive file=nbd:unix:/tmp/nbd-socket 232708ae330eSRonnie Sahlberg@end example 232808ae330eSRonnie Sahlberg 23290a12ec87SRichard W.M. Jones@item SSH 23300a12ec87SRichard W.M. JonesQEMU supports SSH (Secure Shell) access to remote disks. 23310a12ec87SRichard W.M. Jones 23320a12ec87SRichard W.M. JonesExamples: 23330a12ec87SRichard W.M. Jones@example 23340a12ec87SRichard W.M. Jonesqemu-system-i386 -drive file=ssh://user@@host/path/to/disk.img 23350a12ec87SRichard W.M. Jonesqemu-system-i386 -drive file.driver=ssh,file.user=user,file.host=host,file.port=22,file.path=/path/to/disk.img 23360a12ec87SRichard W.M. Jones@end example 23370a12ec87SRichard W.M. Jones 23380a12ec87SRichard W.M. JonesCurrently authentication must be done using ssh-agent. Other 23390a12ec87SRichard W.M. Jonesauthentication methods may be supported in future. 23400a12ec87SRichard W.M. Jones 2341d9990228SRonnie Sahlberg@item Sheepdog 2342d9990228SRonnie SahlbergSheepdog is a distributed storage system for QEMU. 2343d9990228SRonnie SahlbergQEMU supports using either local sheepdog devices or remote networked 2344d9990228SRonnie Sahlbergdevices. 2345d9990228SRonnie Sahlberg 2346d9990228SRonnie SahlbergSyntax for specifying a sheepdog device 23475d6768e3SMORITA Kazutaka@example 23481b8bbb46SMORITA Kazutakasheepdog[+tcp|+unix]://[host:port]/vdiname[?socket=path][#snapid|#tag] 23495d6768e3SMORITA Kazutaka@end example 2350d9990228SRonnie Sahlberg 2351d9990228SRonnie SahlbergExample 2352d9990228SRonnie Sahlberg@example 23535d6768e3SMORITA Kazutakaqemu-system-i386 --drive file=sheepdog://192.0.2.1:30000/MyVirtualMachine 2354d9990228SRonnie Sahlberg@end example 2355d9990228SRonnie Sahlberg 2356d9990228SRonnie SahlbergSee also @url{http://http://www.osrg.net/sheepdog/}. 2357d9990228SRonnie Sahlberg 23588809e289SBharata B Rao@item GlusterFS 23598809e289SBharata B RaoGlusterFS is an user space distributed file system. 23608809e289SBharata B RaoQEMU supports the use of GlusterFS volumes for hosting VM disk images using 23618809e289SBharata B RaoTCP, Unix Domain Sockets and RDMA transport protocols. 23628809e289SBharata B Rao 23638809e289SBharata B RaoSyntax for specifying a VM disk image on GlusterFS volume is 23648809e289SBharata B Rao@example 23658809e289SBharata B Raogluster[+transport]://[server[:port]]/volname/image[?socket=...] 23668809e289SBharata B Rao@end example 23678809e289SBharata B Rao 23688809e289SBharata B Rao 23698809e289SBharata B RaoExample 23708809e289SBharata B Rao@example 2371db2d5ebaSLei Liqemu-system-x86_64 --drive file=gluster://192.0.2.1/testvol/a.img 23728809e289SBharata B Rao@end example 23738809e289SBharata B Rao 23748809e289SBharata B RaoSee also @url{http://www.gluster.org}. 23750a86cb73SMatthew Booth 23760a86cb73SMatthew Booth@item HTTP/HTTPS/FTP/FTPS/TFTP 23770a86cb73SMatthew BoothQEMU supports read-only access to files accessed over http(s), ftp(s) and tftp. 23780a86cb73SMatthew Booth 23790a86cb73SMatthew BoothSyntax using a single filename: 23800a86cb73SMatthew Booth@example 23810a86cb73SMatthew Booth<protocol>://[<username>[:<password>]@@]<host>/<path> 23820a86cb73SMatthew Booth@end example 23830a86cb73SMatthew Booth 23840a86cb73SMatthew Boothwhere: 23850a86cb73SMatthew Booth@table @option 23860a86cb73SMatthew Booth@item protocol 23870a86cb73SMatthew Booth'http', 'https', 'ftp', 'ftps', or 'tftp'. 23880a86cb73SMatthew Booth 23890a86cb73SMatthew Booth@item username 23900a86cb73SMatthew BoothOptional username for authentication to the remote server. 23910a86cb73SMatthew Booth 23920a86cb73SMatthew Booth@item password 23930a86cb73SMatthew BoothOptional password for authentication to the remote server. 23940a86cb73SMatthew Booth 23950a86cb73SMatthew Booth@item host 23960a86cb73SMatthew BoothAddress of the remote server. 23970a86cb73SMatthew Booth 23980a86cb73SMatthew Booth@item path 23990a86cb73SMatthew BoothPath on the remote server, including any query string. 24000a86cb73SMatthew Booth@end table 24010a86cb73SMatthew Booth 24020a86cb73SMatthew BoothThe following options are also supported: 24030a86cb73SMatthew Booth@table @option 24040a86cb73SMatthew Booth@item url 24050a86cb73SMatthew BoothThe full URL when passing options to the driver explicitly. 24060a86cb73SMatthew Booth 24070a86cb73SMatthew Booth@item readahead 24080a86cb73SMatthew BoothThe amount of data to read ahead with each range request to the remote server. 24090a86cb73SMatthew BoothThis value may optionally have the suffix 'T', 'G', 'M', 'K', 'k' or 'b'. If it 24100a86cb73SMatthew Boothdoes not have a suffix, it will be assumed to be in bytes. The value must be a 24110a86cb73SMatthew Boothmultiple of 512 bytes. It defaults to 256k. 24120a86cb73SMatthew Booth 24130a86cb73SMatthew Booth@item sslverify 24140a86cb73SMatthew BoothWhether to verify the remote server's certificate when connecting over SSL. It 24150a86cb73SMatthew Boothcan have the value 'on' or 'off'. It defaults to 'on'. 2416212aefaaSDaniel Henrique Barboza 2417a94f83d9SRichard W.M. Jones@item cookie 2418a94f83d9SRichard W.M. JonesSend this cookie (it can also be a list of cookies separated by ';') with 2419a94f83d9SRichard W.M. Joneseach outgoing request. Only supported when using protocols such as HTTP 2420a94f83d9SRichard W.M. Joneswhich support cookies, otherwise ignored. 2421a94f83d9SRichard W.M. Jones 2422212aefaaSDaniel Henrique Barboza@item timeout 2423212aefaaSDaniel Henrique BarbozaSet the timeout in seconds of the CURL connection. This timeout is the time 2424212aefaaSDaniel Henrique Barbozathat CURL waits for a response from the remote server to get the size of the 2425212aefaaSDaniel Henrique Barbozaimage to be downloaded. If not set, the default timeout of 5 seconds is used. 24260a86cb73SMatthew Booth@end table 24270a86cb73SMatthew Booth 24280a86cb73SMatthew BoothNote that when passing options to qemu explicitly, @option{driver} is the value 24290a86cb73SMatthew Boothof <protocol>. 24300a86cb73SMatthew Booth 24310a86cb73SMatthew BoothExample: boot from a remote Fedora 20 live ISO image 24320a86cb73SMatthew Booth@example 24330a86cb73SMatthew 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 24340a86cb73SMatthew Booth 24350a86cb73SMatthew 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 24360a86cb73SMatthew Booth@end example 24370a86cb73SMatthew Booth 24380a86cb73SMatthew BoothExample: boot from a remote Fedora 20 cloud image using a local overlay for 24390a86cb73SMatthew Boothwrites, copy-on-read, and a readahead of 64k 24400a86cb73SMatthew Booth@example 24410a86cb73SMatthew 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 24420a86cb73SMatthew Booth 24430a86cb73SMatthew Boothqemu-system-x86_64 -drive file=/tmp/Fedora-x86_64-20-20131211.1-sda.qcow2,copy-on-read=on 24440a86cb73SMatthew Booth@end example 24450a86cb73SMatthew Booth 24460a86cb73SMatthew BoothExample: boot from an image stored on a VMware vSphere server with a self-signed 2447212aefaaSDaniel Henrique Barbozacertificate using a local overlay for writes, a readahead of 64k and a timeout 2448212aefaaSDaniel Henrique Barbozaof 10 seconds. 24490a86cb73SMatthew Booth@example 2450212aefaaSDaniel 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 24510a86cb73SMatthew Booth 24520a86cb73SMatthew Boothqemu-system-x86_64 -drive file=/tmp/test.qcow2 24530a86cb73SMatthew Booth@end example 2454c70a01e4SMarkus ArmbrusterETEXI 2455c70a01e4SMarkus Armbruster 2456c70a01e4SMarkus ArmbrusterSTEXI 24570f5314a2SRonnie Sahlberg@end table 24580f5314a2SRonnie SahlbergETEXI 24590f5314a2SRonnie Sahlberg 24607273a2dbSMatthew BoothDEFHEADING(Bluetooth(R) options:) 2461c70a01e4SMarkus ArmbrusterSTEXI 2462c70a01e4SMarkus Armbruster@table @option 2463c70a01e4SMarkus ArmbrusterETEXI 24647273a2dbSMatthew Booth 24655824d651Sblueswir1DEF("bt", HAS_ARG, QEMU_OPTION_bt, \ 24665824d651Sblueswir1 "-bt hci,null dumb bluetooth HCI - doesn't respond to commands\n" \ 24675824d651Sblueswir1 "-bt hci,host[:id]\n" \ 24685824d651Sblueswir1 " use host's HCI with the given name\n" \ 24695824d651Sblueswir1 "-bt hci[,vlan=n]\n" \ 24705824d651Sblueswir1 " emulate a standard HCI in virtual scatternet 'n'\n" \ 24715824d651Sblueswir1 "-bt vhci[,vlan=n]\n" \ 24725824d651Sblueswir1 " add host computer to virtual scatternet 'n' using VHCI\n" \ 24735824d651Sblueswir1 "-bt device:dev[,vlan=n]\n" \ 2474ad96090aSBlue Swirl " emulate a bluetooth device 'dev' in scatternet 'n'\n", 2475ad96090aSBlue Swirl QEMU_ARCH_ALL) 24765824d651Sblueswir1STEXI 24775824d651Sblueswir1@item -bt hci[...] 24786616b2adSStefan Weil@findex -bt 24795824d651Sblueswir1Defines the function of the corresponding Bluetooth HCI. -bt options 24805824d651Sblueswir1are matched with the HCIs present in the chosen machine type. For 24815824d651Sblueswir1example when emulating a machine with only one HCI built into it, only 24825824d651Sblueswir1the first @code{-bt hci[...]} option is valid and defines the HCI's 24835824d651Sblueswir1logic. The Transport Layer is decided by the machine type. Currently 24845824d651Sblueswir1the machines @code{n800} and @code{n810} have one HCI and all other 24855824d651Sblueswir1machines have none. 24865824d651Sblueswir1 24875824d651Sblueswir1@anchor{bt-hcis} 24885824d651Sblueswir1The following three types are recognized: 24895824d651Sblueswir1 2490b3f046c2SKevin Wolf@table @option 24915824d651Sblueswir1@item -bt hci,null 24925824d651Sblueswir1(default) The corresponding Bluetooth HCI assumes no internal logic 24935824d651Sblueswir1and will not respond to any HCI commands or emit events. 24945824d651Sblueswir1 24955824d651Sblueswir1@item -bt hci,host[:@var{id}] 24965824d651Sblueswir1(@code{bluez} only) The corresponding HCI passes commands / events 24975824d651Sblueswir1to / from the physical HCI identified by the name @var{id} (default: 24985824d651Sblueswir1@code{hci0}) on the computer running QEMU. Only available on @code{bluez} 24995824d651Sblueswir1capable systems like Linux. 25005824d651Sblueswir1 25015824d651Sblueswir1@item -bt hci[,vlan=@var{n}] 25025824d651Sblueswir1Add a virtual, standard HCI that will participate in the Bluetooth 25035824d651Sblueswir1scatternet @var{n} (default @code{0}). Similarly to @option{-net} 25045824d651Sblueswir1VLANs, devices inside a bluetooth network @var{n} can only communicate 25055824d651Sblueswir1with other devices in the same network (scatternet). 25065824d651Sblueswir1@end table 25075824d651Sblueswir1 25085824d651Sblueswir1@item -bt vhci[,vlan=@var{n}] 25095824d651Sblueswir1(Linux-host only) Create a HCI in scatternet @var{n} (default 0) attached 25105824d651Sblueswir1to the host bluetooth stack instead of to the emulated target. This 25115824d651Sblueswir1allows the host and target machines to participate in a common scatternet 25125824d651Sblueswir1and communicate. Requires the Linux @code{vhci} driver installed. Can 25135824d651Sblueswir1be used as following: 25145824d651Sblueswir1 25155824d651Sblueswir1@example 25163804da9dSStefan Weilqemu-system-i386 [...OPTIONS...] -bt hci,vlan=5 -bt vhci,vlan=5 25175824d651Sblueswir1@end example 25185824d651Sblueswir1 25195824d651Sblueswir1@item -bt device:@var{dev}[,vlan=@var{n}] 25205824d651Sblueswir1Emulate a bluetooth device @var{dev} and place it in network @var{n} 25215824d651Sblueswir1(default @code{0}). QEMU can only emulate one type of bluetooth devices 25225824d651Sblueswir1currently: 25235824d651Sblueswir1 2524b3f046c2SKevin Wolf@table @option 25255824d651Sblueswir1@item keyboard 25265824d651Sblueswir1Virtual wireless keyboard implementing the HIDP bluetooth profile. 25275824d651Sblueswir1@end table 25285824d651Sblueswir1ETEXI 25295824d651Sblueswir1 2530c70a01e4SMarkus ArmbrusterSTEXI 2531c70a01e4SMarkus Armbruster@end table 2532c70a01e4SMarkus ArmbrusterETEXI 25335824d651Sblueswir1DEFHEADING() 25345824d651Sblueswir1 2535d1a0cf73SStefan Berger#ifdef CONFIG_TPM 2536d1a0cf73SStefan BergerDEFHEADING(TPM device options:) 2537d1a0cf73SStefan Berger 2538d1a0cf73SStefan BergerDEF("tpmdev", HAS_ARG, QEMU_OPTION_tpmdev, \ 253992dcc234SStefan Berger "-tpmdev passthrough,id=id[,path=path][,cancel-path=path]\n" 254092dcc234SStefan Berger " use path to provide path to a character device; default is /dev/tpm0\n" 254192dcc234SStefan Berger " use cancel-path to provide path to TPM's cancel sysfs entry; if\n" 254292dcc234SStefan Berger " not provided it will be searched for in /sys/class/misc/tpm?/device\n", 2543d1a0cf73SStefan Berger QEMU_ARCH_ALL) 2544d1a0cf73SStefan BergerSTEXI 2545d1a0cf73SStefan Berger 2546d1a0cf73SStefan BergerThe general form of a TPM device option is: 2547d1a0cf73SStefan Berger@table @option 2548d1a0cf73SStefan Berger 2549d1a0cf73SStefan Berger@item -tpmdev @var{backend} ,id=@var{id} [,@var{options}] 2550d1a0cf73SStefan Berger@findex -tpmdev 2551d1a0cf73SStefan BergerBackend type must be: 25524549a8b7SStefan Berger@option{passthrough}. 2553d1a0cf73SStefan Berger 2554d1a0cf73SStefan BergerThe specific backend type will determine the applicable options. 255528c4fa32SCorey BryantThe @code{-tpmdev} option creates the TPM backend and requires a 255628c4fa32SCorey Bryant@code{-device} option that specifies the TPM frontend interface model. 2557d1a0cf73SStefan Berger 2558d1a0cf73SStefan BergerOptions to each backend are described below. 2559d1a0cf73SStefan Berger 2560d1a0cf73SStefan BergerUse 'help' to print all available TPM backend types. 2561d1a0cf73SStefan Berger@example 2562d1a0cf73SStefan Bergerqemu -tpmdev help 2563d1a0cf73SStefan Berger@end example 2564d1a0cf73SStefan Berger 256592dcc234SStefan Berger@item -tpmdev passthrough, id=@var{id}, path=@var{path}, cancel-path=@var{cancel-path} 25664549a8b7SStefan Berger 25674549a8b7SStefan Berger(Linux-host only) Enable access to the host's TPM using the passthrough 25684549a8b7SStefan Bergerdriver. 25694549a8b7SStefan Berger 25704549a8b7SStefan Berger@option{path} specifies the path to the host's TPM device, i.e., on 25714549a8b7SStefan Bergera Linux host this would be @code{/dev/tpm0}. 25724549a8b7SStefan Berger@option{path} is optional and by default @code{/dev/tpm0} is used. 25734549a8b7SStefan Berger 257492dcc234SStefan Berger@option{cancel-path} specifies the path to the host TPM device's sysfs 257592dcc234SStefan Bergerentry allowing for cancellation of an ongoing TPM command. 257692dcc234SStefan Berger@option{cancel-path} is optional and by default QEMU will search for the 257792dcc234SStefan Bergersysfs entry to use. 257892dcc234SStefan Berger 25794549a8b7SStefan BergerSome notes about using the host's TPM with the passthrough driver: 25804549a8b7SStefan Berger 25814549a8b7SStefan BergerThe TPM device accessed by the passthrough driver must not be 25824549a8b7SStefan Bergerused by any other application on the host. 25834549a8b7SStefan Berger 25844549a8b7SStefan BergerSince the host's firmware (BIOS/UEFI) has already initialized the TPM, 25854549a8b7SStefan Bergerthe VM's firmware (BIOS/UEFI) will not be able to initialize the 25864549a8b7SStefan BergerTPM again and may therefore not show a TPM-specific menu that would 25874549a8b7SStefan Bergerotherwise allow the user to configure the TPM, e.g., allow the user to 25884549a8b7SStefan Bergerenable/disable or activate/deactivate the TPM. 25894549a8b7SStefan BergerFurther, if TPM ownership is released from within a VM then the host's TPM 25904549a8b7SStefan Bergerwill get disabled and deactivated. To enable and activate the 25914549a8b7SStefan BergerTPM again afterwards, the host has to be rebooted and the user is 25924549a8b7SStefan Bergerrequired to enter the firmware's menu to enable and activate the TPM. 25934549a8b7SStefan BergerIf the TPM is left disabled and/or deactivated most TPM commands will fail. 25944549a8b7SStefan Berger 25954549a8b7SStefan BergerTo create a passthrough TPM use the following two options: 25964549a8b7SStefan Berger@example 25974549a8b7SStefan Berger-tpmdev passthrough,id=tpm0 -device tpm-tis,tpmdev=tpm0 25984549a8b7SStefan Berger@end example 25994549a8b7SStefan BergerNote that the @code{-tpmdev} id is @code{tpm0} and is referenced by 26004549a8b7SStefan Berger@code{tpmdev=tpm0} in the device option. 26014549a8b7SStefan Berger 2602d1a0cf73SStefan Berger@end table 2603d1a0cf73SStefan Berger 2604d1a0cf73SStefan BergerETEXI 2605d1a0cf73SStefan Berger 2606d1a0cf73SStefan BergerDEFHEADING() 2607d1a0cf73SStefan Berger 2608d1a0cf73SStefan Berger#endif 2609d1a0cf73SStefan Berger 26107677f05dSAlexander GrafDEFHEADING(Linux/Multiboot boot specific:) 26115824d651Sblueswir1STEXI 26127677f05dSAlexander Graf 26137677f05dSAlexander GrafWhen using these options, you can use a given Linux or Multiboot 26147677f05dSAlexander Grafkernel without installing it in the disk image. It can be useful 26155824d651Sblueswir1for easier testing of various kernels. 26165824d651Sblueswir1 26175824d651Sblueswir1@table @option 26185824d651Sblueswir1ETEXI 26195824d651Sblueswir1 26205824d651Sblueswir1DEF("kernel", HAS_ARG, QEMU_OPTION_kernel, \ 2621ad96090aSBlue Swirl "-kernel bzImage use 'bzImage' as kernel image\n", QEMU_ARCH_ALL) 26225824d651Sblueswir1STEXI 26235824d651Sblueswir1@item -kernel @var{bzImage} 26246616b2adSStefan Weil@findex -kernel 26257677f05dSAlexander GrafUse @var{bzImage} as kernel image. The kernel can be either a Linux kernel 26267677f05dSAlexander Grafor in multiboot format. 26275824d651Sblueswir1ETEXI 26285824d651Sblueswir1 26295824d651Sblueswir1DEF("append", HAS_ARG, QEMU_OPTION_append, \ 2630ad96090aSBlue Swirl "-append cmdline use 'cmdline' as kernel command line\n", QEMU_ARCH_ALL) 26315824d651Sblueswir1STEXI 26325824d651Sblueswir1@item -append @var{cmdline} 26336616b2adSStefan Weil@findex -append 26345824d651Sblueswir1Use @var{cmdline} as kernel command line 26355824d651Sblueswir1ETEXI 26365824d651Sblueswir1 26375824d651Sblueswir1DEF("initrd", HAS_ARG, QEMU_OPTION_initrd, \ 2638ad96090aSBlue Swirl "-initrd file use 'file' as initial ram disk\n", QEMU_ARCH_ALL) 26395824d651Sblueswir1STEXI 26405824d651Sblueswir1@item -initrd @var{file} 26416616b2adSStefan Weil@findex -initrd 26425824d651Sblueswir1Use @var{file} as initial ram disk. 26437677f05dSAlexander Graf 26447677f05dSAlexander Graf@item -initrd "@var{file1} arg=foo,@var{file2}" 26457677f05dSAlexander Graf 26467677f05dSAlexander GrafThis syntax is only available with multiboot. 26477677f05dSAlexander Graf 26487677f05dSAlexander GrafUse @var{file1} and @var{file2} as modules and pass arg=foo as parameter to the 26497677f05dSAlexander Graffirst module. 26505824d651Sblueswir1ETEXI 26515824d651Sblueswir1 2652412beee6SGrant LikelyDEF("dtb", HAS_ARG, QEMU_OPTION_dtb, \ 2653379b5c7cSPeter A. G. Crosthwaite "-dtb file use 'file' as device tree image\n", QEMU_ARCH_ALL) 2654412beee6SGrant LikelySTEXI 2655412beee6SGrant Likely@item -dtb @var{file} 2656412beee6SGrant Likely@findex -dtb 2657412beee6SGrant LikelyUse @var{file} as a device tree binary (dtb) image and pass it to the kernel 2658412beee6SGrant Likelyon boot. 2659412beee6SGrant LikelyETEXI 2660412beee6SGrant Likely 26615824d651Sblueswir1STEXI 26625824d651Sblueswir1@end table 26635824d651Sblueswir1ETEXI 26645824d651Sblueswir1DEFHEADING() 26655824d651Sblueswir1 26665824d651Sblueswir1DEFHEADING(Debug/Expert options:) 26675824d651Sblueswir1STEXI 26685824d651Sblueswir1@table @option 26695824d651Sblueswir1ETEXI 26705824d651Sblueswir1 26715824d651Sblueswir1DEF("serial", HAS_ARG, QEMU_OPTION_serial, \ 2672ad96090aSBlue Swirl "-serial dev redirect the serial port to char device 'dev'\n", 2673ad96090aSBlue Swirl QEMU_ARCH_ALL) 26745824d651Sblueswir1STEXI 26755824d651Sblueswir1@item -serial @var{dev} 26766616b2adSStefan Weil@findex -serial 26775824d651Sblueswir1Redirect the virtual serial port to host character device 26785824d651Sblueswir1@var{dev}. The default device is @code{vc} in graphical mode and 26795824d651Sblueswir1@code{stdio} in non graphical mode. 26805824d651Sblueswir1 26815824d651Sblueswir1This option can be used several times to simulate up to 4 serial 26825824d651Sblueswir1ports. 26835824d651Sblueswir1 26845824d651Sblueswir1Use @code{-serial none} to disable all serial ports. 26855824d651Sblueswir1 26865824d651Sblueswir1Available character devices are: 2687b3f046c2SKevin Wolf@table @option 26884e257e5eSKevin Wolf@item vc[:@var{W}x@var{H}] 26895824d651Sblueswir1Virtual console. Optionally, a width and height can be given in pixel with 26905824d651Sblueswir1@example 26915824d651Sblueswir1vc:800x600 26925824d651Sblueswir1@end example 26935824d651Sblueswir1It is also possible to specify width or height in characters: 26945824d651Sblueswir1@example 26955824d651Sblueswir1vc:80Cx24C 26965824d651Sblueswir1@end example 26975824d651Sblueswir1@item pty 26985824d651Sblueswir1[Linux only] Pseudo TTY (a new PTY is automatically allocated) 26995824d651Sblueswir1@item none 27005824d651Sblueswir1No device is allocated. 27015824d651Sblueswir1@item null 27025824d651Sblueswir1void device 270388e020e5SIngo van Lil@item chardev:@var{id} 270488e020e5SIngo van LilUse a named character device defined with the @code{-chardev} option. 27055824d651Sblueswir1@item /dev/XXX 27065824d651Sblueswir1[Linux only] Use host tty, e.g. @file{/dev/ttyS0}. The host serial port 27075824d651Sblueswir1parameters are set according to the emulated ones. 27085824d651Sblueswir1@item /dev/parport@var{N} 27095824d651Sblueswir1[Linux only, parallel port only] Use host parallel port 27105824d651Sblueswir1@var{N}. Currently SPP and EPP parallel port features can be used. 27115824d651Sblueswir1@item file:@var{filename} 27125824d651Sblueswir1Write output to @var{filename}. No character can be read. 27135824d651Sblueswir1@item stdio 27145824d651Sblueswir1[Unix only] standard input/output 27155824d651Sblueswir1@item pipe:@var{filename} 27165824d651Sblueswir1name pipe @var{filename} 27175824d651Sblueswir1@item COM@var{n} 27185824d651Sblueswir1[Windows only] Use host serial port @var{n} 27195824d651Sblueswir1@item udp:[@var{remote_host}]:@var{remote_port}[@@[@var{src_ip}]:@var{src_port}] 27205824d651Sblueswir1This implements UDP Net Console. 27215824d651Sblueswir1When @var{remote_host} or @var{src_ip} are not specified 27225824d651Sblueswir1they default to @code{0.0.0.0}. 27235824d651Sblueswir1When not using a specified @var{src_port} a random port is automatically chosen. 27245824d651Sblueswir1 27255824d651Sblueswir1If you just want a simple readonly console you can use @code{netcat} or 2726b65ee4faSStefan Weil@code{nc}, by starting QEMU with: @code{-serial udp::4555} and nc as: 2727b65ee4faSStefan Weil@code{nc -u -l -p 4555}. Any time QEMU writes something to that port it 27285824d651Sblueswir1will appear in the netconsole session. 27295824d651Sblueswir1 27305824d651Sblueswir1If you plan to send characters back via netconsole or you want to stop 2731b65ee4faSStefan Weiland start QEMU a lot of times, you should have QEMU use the same 27325824d651Sblueswir1source port each time by using something like @code{-serial 2733b65ee4faSStefan Weiludp::4555@@:4556} to QEMU. Another approach is to use a patched 27345824d651Sblueswir1version of netcat which can listen to a TCP port and send and receive 27355824d651Sblueswir1characters via udp. If you have a patched version of netcat which 27365824d651Sblueswir1activates telnet remote echo and single char transfer, then you can 27375824d651Sblueswir1use the following options to step up a netcat redirector to allow 2738b65ee4faSStefan Weiltelnet on port 5555 to access the QEMU port. 27395824d651Sblueswir1@table @code 2740071c9394SStefan Weil@item QEMU Options: 27415824d651Sblueswir1-serial udp::4555@@:4556 27425824d651Sblueswir1@item netcat options: 27435824d651Sblueswir1-u -P 4555 -L 0.0.0.0:4556 -t -p 5555 -I -T 27445824d651Sblueswir1@item telnet options: 27455824d651Sblueswir1localhost 5555 27465824d651Sblueswir1@end table 27475824d651Sblueswir1 27485dd1f02bSCorey Minyard@item tcp:[@var{host}]:@var{port}[,@var{server}][,nowait][,nodelay][,reconnect=@var{seconds}] 27495824d651Sblueswir1The TCP Net Console has two modes of operation. It can send the serial 27505824d651Sblueswir1I/O to a location or wait for a connection from a location. By default 27515824d651Sblueswir1the TCP Net Console is sent to @var{host} at the @var{port}. If you use 27525824d651Sblueswir1the @var{server} option QEMU will wait for a client socket application 27535824d651Sblueswir1to connect to the port before continuing, unless the @code{nowait} 27545824d651Sblueswir1option was specified. The @code{nodelay} option disables the Nagle buffering 27555dd1f02bSCorey Minyardalgorithm. The @code{reconnect} option only applies if @var{noserver} is 27565dd1f02bSCorey Minyardset, if the connection goes down it will attempt to reconnect at the 27575dd1f02bSCorey Minyardgiven interval. If @var{host} is omitted, 0.0.0.0 is assumed. Only 27585824d651Sblueswir1one TCP connection at a time is accepted. You can use @code{telnet} to 27595824d651Sblueswir1connect to the corresponding character device. 27605824d651Sblueswir1@table @code 27615824d651Sblueswir1@item Example to send tcp console to 192.168.0.2 port 4444 27625824d651Sblueswir1-serial tcp:192.168.0.2:4444 27635824d651Sblueswir1@item Example to listen and wait on port 4444 for connection 27645824d651Sblueswir1-serial tcp::4444,server 27655824d651Sblueswir1@item Example to not wait and listen on ip 192.168.0.100 port 4444 27665824d651Sblueswir1-serial tcp:192.168.0.100:4444,server,nowait 27675824d651Sblueswir1@end table 27685824d651Sblueswir1 27695824d651Sblueswir1@item telnet:@var{host}:@var{port}[,server][,nowait][,nodelay] 27705824d651Sblueswir1The telnet protocol is used instead of raw tcp sockets. The options 27715824d651Sblueswir1work the same as if you had specified @code{-serial tcp}. The 27725824d651Sblueswir1difference is that the port acts like a telnet server or client using 27735824d651Sblueswir1telnet option negotiation. This will also allow you to send the 27745824d651Sblueswir1MAGIC_SYSRQ sequence if you use a telnet that supports sending the break 27755824d651Sblueswir1sequence. Typically in unix telnet you do it with Control-] and then 27765824d651Sblueswir1type "send break" followed by pressing the enter key. 27775824d651Sblueswir1 27785dd1f02bSCorey Minyard@item unix:@var{path}[,server][,nowait][,reconnect=@var{seconds}] 27795824d651Sblueswir1A unix domain socket is used instead of a tcp socket. The option works the 27805824d651Sblueswir1same as if you had specified @code{-serial tcp} except the unix domain socket 27815824d651Sblueswir1@var{path} is used for connections. 27825824d651Sblueswir1 27835824d651Sblueswir1@item mon:@var{dev_string} 27845824d651Sblueswir1This is a special option to allow the monitor to be multiplexed onto 27855824d651Sblueswir1another serial port. The monitor is accessed with key sequence of 278602c4bdf1SPaolo Bonzini@key{Control-a} and then pressing @key{c}. 27875824d651Sblueswir1@var{dev_string} should be any one of the serial devices specified 27885824d651Sblueswir1above. An example to multiplex the monitor onto a telnet server 27895824d651Sblueswir1listening on port 4444 would be: 27905824d651Sblueswir1@table @code 27915824d651Sblueswir1@item -serial mon:telnet::4444,server,nowait 27925824d651Sblueswir1@end table 2793be022d61SMichael TokarevWhen the monitor is multiplexed to stdio in this way, Ctrl+C will not terminate 279402c4bdf1SPaolo BonziniQEMU any more but will be passed to the guest instead. 27955824d651Sblueswir1 27965824d651Sblueswir1@item braille 27975824d651Sblueswir1Braille device. This will use BrlAPI to display the braille output on a real 27985824d651Sblueswir1or fake device. 27995824d651Sblueswir1 2800be8b28a9SKevin Wolf@item msmouse 2801be8b28a9SKevin WolfThree button serial mouse. Configure the guest to use Microsoft protocol. 28025824d651Sblueswir1@end table 28035824d651Sblueswir1ETEXI 28045824d651Sblueswir1 28055824d651Sblueswir1DEF("parallel", HAS_ARG, QEMU_OPTION_parallel, \ 2806ad96090aSBlue Swirl "-parallel dev redirect the parallel port to char device 'dev'\n", 2807ad96090aSBlue Swirl QEMU_ARCH_ALL) 28085824d651Sblueswir1STEXI 28095824d651Sblueswir1@item -parallel @var{dev} 28106616b2adSStefan Weil@findex -parallel 28115824d651Sblueswir1Redirect the virtual parallel port to host device @var{dev} (same 28125824d651Sblueswir1devices as the serial port). On Linux hosts, @file{/dev/parportN} can 28135824d651Sblueswir1be used to use hardware devices connected on the corresponding host 28145824d651Sblueswir1parallel port. 28155824d651Sblueswir1 28165824d651Sblueswir1This option can be used several times to simulate up to 3 parallel 28175824d651Sblueswir1ports. 28185824d651Sblueswir1 28195824d651Sblueswir1Use @code{-parallel none} to disable all parallel ports. 28205824d651Sblueswir1ETEXI 28215824d651Sblueswir1 28225824d651Sblueswir1DEF("monitor", HAS_ARG, QEMU_OPTION_monitor, \ 2823ad96090aSBlue Swirl "-monitor dev redirect the monitor to char device 'dev'\n", 2824ad96090aSBlue Swirl QEMU_ARCH_ALL) 28255824d651Sblueswir1STEXI 28264e307fc8SGerd Hoffmann@item -monitor @var{dev} 28276616b2adSStefan Weil@findex -monitor 28285824d651Sblueswir1Redirect the monitor to host device @var{dev} (same devices as the 28295824d651Sblueswir1serial port). 28305824d651Sblueswir1The default device is @code{vc} in graphical mode and @code{stdio} in 28315824d651Sblueswir1non graphical mode. 283270e098afSLuiz CapitulinoUse @code{-monitor none} to disable the default monitor. 28335824d651Sblueswir1ETEXI 28346ca5582dSGerd HoffmannDEF("qmp", HAS_ARG, QEMU_OPTION_qmp, \ 2835ad96090aSBlue Swirl "-qmp dev like -monitor but opens in 'control' mode\n", 2836ad96090aSBlue Swirl QEMU_ARCH_ALL) 283795d5f08bSStefan WeilSTEXI 283895d5f08bSStefan Weil@item -qmp @var{dev} 28396616b2adSStefan Weil@findex -qmp 284095d5f08bSStefan WeilLike -monitor but opens in 'control' mode. 284195d5f08bSStefan WeilETEXI 28424821cd4cSMax ReitzDEF("qmp-pretty", HAS_ARG, QEMU_OPTION_qmp_pretty, \ 28434821cd4cSMax Reitz "-qmp-pretty dev like -qmp but uses pretty JSON formatting\n", 28444821cd4cSMax Reitz QEMU_ARCH_ALL) 28454821cd4cSMax ReitzSTEXI 28464821cd4cSMax Reitz@item -qmp-pretty @var{dev} 28474821cd4cSMax Reitz@findex -qmp-pretty 28484821cd4cSMax ReitzLike -qmp but uses pretty JSON formatting. 28494821cd4cSMax ReitzETEXI 28505824d651Sblueswir1 285122a0e04bSGerd HoffmannDEF("mon", HAS_ARG, QEMU_OPTION_mon, \ 2852f17e4eaaSMichael Tokarev "-mon [chardev=]name[,mode=readline|control][,default]\n", QEMU_ARCH_ALL) 285322a0e04bSGerd HoffmannSTEXI 2854f17e4eaaSMichael Tokarev@item -mon [chardev=]name[,mode=readline|control][,default] 28556616b2adSStefan Weil@findex -mon 285622a0e04bSGerd HoffmannSetup monitor on chardev @var{name}. 285722a0e04bSGerd HoffmannETEXI 285822a0e04bSGerd Hoffmann 2859c9f398e5SH. Peter AnvinDEF("debugcon", HAS_ARG, QEMU_OPTION_debugcon, \ 2860ad96090aSBlue Swirl "-debugcon dev redirect the debug console to char device 'dev'\n", 2861ad96090aSBlue Swirl QEMU_ARCH_ALL) 2862c9f398e5SH. Peter AnvinSTEXI 2863c9f398e5SH. Peter Anvin@item -debugcon @var{dev} 28646616b2adSStefan Weil@findex -debugcon 2865c9f398e5SH. Peter AnvinRedirect the debug console to host device @var{dev} (same devices as the 2866c9f398e5SH. Peter Anvinserial port). The debug console is an I/O port which is typically port 2867c9f398e5SH. Peter Anvin0xe9; writing to that I/O port sends output to this device. 2868c9f398e5SH. Peter AnvinThe default device is @code{vc} in graphical mode and @code{stdio} in 2869c9f398e5SH. Peter Anvinnon graphical mode. 2870c9f398e5SH. Peter AnvinETEXI 2871c9f398e5SH. Peter Anvin 28725824d651Sblueswir1DEF("pidfile", HAS_ARG, QEMU_OPTION_pidfile, \ 2873ad96090aSBlue Swirl "-pidfile file write PID to 'file'\n", QEMU_ARCH_ALL) 28745824d651Sblueswir1STEXI 28755824d651Sblueswir1@item -pidfile @var{file} 28766616b2adSStefan Weil@findex -pidfile 28775824d651Sblueswir1Store the QEMU process PID in @var{file}. It is useful if you launch QEMU 28785824d651Sblueswir1from a script. 28795824d651Sblueswir1ETEXI 28805824d651Sblueswir1 28811b530a6dSaurel32DEF("singlestep", 0, QEMU_OPTION_singlestep, \ 2882ad96090aSBlue Swirl "-singlestep always run in singlestep mode\n", QEMU_ARCH_ALL) 28831b530a6dSaurel32STEXI 28841b530a6dSaurel32@item -singlestep 28856616b2adSStefan Weil@findex -singlestep 28861b530a6dSaurel32Run the emulation in single step mode. 28871b530a6dSaurel32ETEXI 28881b530a6dSaurel32 28895824d651Sblueswir1DEF("S", 0, QEMU_OPTION_S, \ 2890ad96090aSBlue Swirl "-S freeze CPU at startup (use 'c' to start execution)\n", 2891ad96090aSBlue Swirl QEMU_ARCH_ALL) 28925824d651Sblueswir1STEXI 28935824d651Sblueswir1@item -S 28946616b2adSStefan Weil@findex -S 28955824d651Sblueswir1Do not start CPU at startup (you must type 'c' in the monitor). 28965824d651Sblueswir1ETEXI 28975824d651Sblueswir1 2898888a6bc6SSatoru MoriyaDEF("realtime", HAS_ARG, QEMU_OPTION_realtime, 2899888a6bc6SSatoru Moriya "-realtime [mlock=on|off]\n" 2900888a6bc6SSatoru Moriya " run qemu with realtime features\n" 2901888a6bc6SSatoru Moriya " mlock=on|off controls mlock support (default: on)\n", 2902888a6bc6SSatoru Moriya QEMU_ARCH_ALL) 2903888a6bc6SSatoru MoriyaSTEXI 2904888a6bc6SSatoru Moriya@item -realtime mlock=on|off 2905888a6bc6SSatoru Moriya@findex -realtime 2906888a6bc6SSatoru MoriyaRun qemu with realtime features. 2907888a6bc6SSatoru Moriyamlocking qemu and guest memory can be enabled via @option{mlock=on} 2908888a6bc6SSatoru Moriya(enabled by default). 2909888a6bc6SSatoru MoriyaETEXI 2910888a6bc6SSatoru Moriya 291159030a8cSaliguoriDEF("gdb", HAS_ARG, QEMU_OPTION_gdb, \ 2912ad96090aSBlue Swirl "-gdb dev wait for gdb connection on 'dev'\n", QEMU_ARCH_ALL) 29135824d651Sblueswir1STEXI 291459030a8cSaliguori@item -gdb @var{dev} 29156616b2adSStefan Weil@findex -gdb 291659030a8cSaliguoriWait for gdb connection on device @var{dev} (@pxref{gdb_usage}). Typical 291759030a8cSaliguoriconnections will likely be TCP-based, but also UDP, pseudo TTY, or even 2918b65ee4faSStefan Weilstdio are reasonable use case. The latter is allowing to start QEMU from 291959030a8cSaliguoriwithin gdb and establish the connection via a pipe: 292059030a8cSaliguori@example 29213804da9dSStefan Weil(gdb) target remote | exec qemu-system-i386 -gdb stdio ... 292259030a8cSaliguori@end example 29235824d651Sblueswir1ETEXI 29245824d651Sblueswir1 292559030a8cSaliguoriDEF("s", 0, QEMU_OPTION_s, \ 2926ad96090aSBlue Swirl "-s shorthand for -gdb tcp::" DEFAULT_GDBSTUB_PORT "\n", 2927ad96090aSBlue Swirl QEMU_ARCH_ALL) 29285824d651Sblueswir1STEXI 292959030a8cSaliguori@item -s 29306616b2adSStefan Weil@findex -s 293159030a8cSaliguoriShorthand for -gdb tcp::1234, i.e. open a gdbserver on TCP port 1234 293259030a8cSaliguori(@pxref{gdb_usage}). 29335824d651Sblueswir1ETEXI 29345824d651Sblueswir1 29355824d651Sblueswir1DEF("d", HAS_ARG, QEMU_OPTION_d, \ 2936989b697dSPeter Maydell "-d item1,... enable logging of specified items (use '-d help' for a list of log items)\n", 2937ad96090aSBlue Swirl QEMU_ARCH_ALL) 29385824d651Sblueswir1STEXI 2939989b697dSPeter Maydell@item -d @var{item1}[,...] 29406616b2adSStefan Weil@findex -d 2941989b697dSPeter MaydellEnable logging of specified items. Use '-d help' for a list of log items. 29425824d651Sblueswir1ETEXI 29435824d651Sblueswir1 2944c235d738SMatthew FernandezDEF("D", HAS_ARG, QEMU_OPTION_D, \ 2945989b697dSPeter Maydell "-D logfile output log to logfile (default stderr)\n", 2946c235d738SMatthew Fernandez QEMU_ARCH_ALL) 2947c235d738SMatthew FernandezSTEXI 29488bd383b4SStefan Weil@item -D @var{logfile} 2949c235d738SMatthew Fernandez@findex -D 2950989b697dSPeter MaydellOutput log in @var{logfile} instead of to stderr 2951c235d738SMatthew FernandezETEXI 2952c235d738SMatthew Fernandez 29535824d651Sblueswir1DEF("L", HAS_ARG, QEMU_OPTION_L, \ 2954ad96090aSBlue Swirl "-L path set the directory for the BIOS, VGA BIOS and keymaps\n", 2955ad96090aSBlue Swirl QEMU_ARCH_ALL) 29565824d651Sblueswir1STEXI 29575824d651Sblueswir1@item -L @var{path} 29586616b2adSStefan Weil@findex -L 29595824d651Sblueswir1Set the directory for the BIOS, VGA BIOS and keymaps. 29605824d651Sblueswir1ETEXI 29615824d651Sblueswir1 29625824d651Sblueswir1DEF("bios", HAS_ARG, QEMU_OPTION_bios, \ 2963ad96090aSBlue Swirl "-bios file set the filename for the BIOS\n", QEMU_ARCH_ALL) 29645824d651Sblueswir1STEXI 29655824d651Sblueswir1@item -bios @var{file} 29666616b2adSStefan Weil@findex -bios 29675824d651Sblueswir1Set the filename for the BIOS. 29685824d651Sblueswir1ETEXI 29695824d651Sblueswir1 29705824d651Sblueswir1DEF("enable-kvm", 0, QEMU_OPTION_enable_kvm, \ 2971ad96090aSBlue Swirl "-enable-kvm enable KVM full virtualization support\n", QEMU_ARCH_ALL) 29725824d651Sblueswir1STEXI 29735824d651Sblueswir1@item -enable-kvm 29746616b2adSStefan Weil@findex -enable-kvm 29755824d651Sblueswir1Enable KVM full virtualization support. This option is only available 29765824d651Sblueswir1if KVM support is enabled when compiling. 29775824d651Sblueswir1ETEXI 29785824d651Sblueswir1 2979e37630caSaliguoriDEF("xen-domid", HAS_ARG, QEMU_OPTION_xen_domid, 2980ad96090aSBlue Swirl "-xen-domid id specify xen guest domain id\n", QEMU_ARCH_ALL) 2981e37630caSaliguoriDEF("xen-create", 0, QEMU_OPTION_xen_create, 2982e37630caSaliguori "-xen-create create domain using xen hypercalls, bypassing xend\n" 2983ad96090aSBlue Swirl " warning: should not be used when xend is in use\n", 2984ad96090aSBlue Swirl QEMU_ARCH_ALL) 2985e37630caSaliguoriDEF("xen-attach", 0, QEMU_OPTION_xen_attach, 2986e37630caSaliguori "-xen-attach attach to existing xen domain\n" 2987b65ee4faSStefan Weil " xend will use this when starting QEMU\n", 2988ad96090aSBlue Swirl QEMU_ARCH_ALL) 298995d5f08bSStefan WeilSTEXI 299095d5f08bSStefan Weil@item -xen-domid @var{id} 29916616b2adSStefan Weil@findex -xen-domid 299295d5f08bSStefan WeilSpecify xen guest domain @var{id} (XEN only). 299395d5f08bSStefan Weil@item -xen-create 29946616b2adSStefan Weil@findex -xen-create 299595d5f08bSStefan WeilCreate domain using xen hypercalls, bypassing xend. 299695d5f08bSStefan WeilWarning: should not be used when xend is in use (XEN only). 299795d5f08bSStefan Weil@item -xen-attach 29986616b2adSStefan Weil@findex -xen-attach 299995d5f08bSStefan WeilAttach to existing xen domain. 3000b65ee4faSStefan Weilxend will use this when starting QEMU (XEN only). 300195d5f08bSStefan WeilETEXI 3002e37630caSaliguori 30035824d651Sblueswir1DEF("no-reboot", 0, QEMU_OPTION_no_reboot, \ 3004ad96090aSBlue Swirl "-no-reboot exit instead of rebooting\n", QEMU_ARCH_ALL) 30055824d651Sblueswir1STEXI 30065824d651Sblueswir1@item -no-reboot 30076616b2adSStefan Weil@findex -no-reboot 30085824d651Sblueswir1Exit instead of rebooting. 30095824d651Sblueswir1ETEXI 30105824d651Sblueswir1 30115824d651Sblueswir1DEF("no-shutdown", 0, QEMU_OPTION_no_shutdown, \ 3012ad96090aSBlue Swirl "-no-shutdown stop before shutdown\n", QEMU_ARCH_ALL) 30135824d651Sblueswir1STEXI 30145824d651Sblueswir1@item -no-shutdown 30156616b2adSStefan Weil@findex -no-shutdown 30165824d651Sblueswir1Don't exit QEMU on guest shutdown, but instead only stop the emulation. 30175824d651Sblueswir1This allows for instance switching to monitor to commit changes to the 30185824d651Sblueswir1disk image. 30195824d651Sblueswir1ETEXI 30205824d651Sblueswir1 30215824d651Sblueswir1DEF("loadvm", HAS_ARG, QEMU_OPTION_loadvm, \ 30225824d651Sblueswir1 "-loadvm [tag|id]\n" \ 3023ad96090aSBlue Swirl " start right away with a saved state (loadvm in monitor)\n", 3024ad96090aSBlue Swirl QEMU_ARCH_ALL) 30255824d651Sblueswir1STEXI 30265824d651Sblueswir1@item -loadvm @var{file} 30276616b2adSStefan Weil@findex -loadvm 30285824d651Sblueswir1Start right away with a saved state (@code{loadvm} in monitor) 30295824d651Sblueswir1ETEXI 30305824d651Sblueswir1 30315824d651Sblueswir1#ifndef _WIN32 30325824d651Sblueswir1DEF("daemonize", 0, QEMU_OPTION_daemonize, \ 3033ad96090aSBlue Swirl "-daemonize daemonize QEMU after initializing\n", QEMU_ARCH_ALL) 30345824d651Sblueswir1#endif 30355824d651Sblueswir1STEXI 30365824d651Sblueswir1@item -daemonize 30376616b2adSStefan Weil@findex -daemonize 30385824d651Sblueswir1Daemonize the QEMU process after initialization. QEMU will not detach from 30395824d651Sblueswir1standard IO until it is ready to receive connections on any of its devices. 30405824d651Sblueswir1This option is a useful way for external programs to launch QEMU without having 30415824d651Sblueswir1to cope with initialization race conditions. 30425824d651Sblueswir1ETEXI 30435824d651Sblueswir1 30445824d651Sblueswir1DEF("option-rom", HAS_ARG, QEMU_OPTION_option_rom, \ 3045ad96090aSBlue Swirl "-option-rom rom load a file, rom, into the option ROM space\n", 3046ad96090aSBlue Swirl QEMU_ARCH_ALL) 30475824d651Sblueswir1STEXI 30485824d651Sblueswir1@item -option-rom @var{file} 30496616b2adSStefan Weil@findex -option-rom 30505824d651Sblueswir1Load the contents of @var{file} as an option ROM. 30515824d651Sblueswir1This option is useful to load things like EtherBoot. 30525824d651Sblueswir1ETEXI 30535824d651Sblueswir1 3054e218052fSMarkus ArmbrusterHXCOMM Silently ignored for compatibility 3055e218052fSMarkus ArmbrusterDEF("clock", HAS_ARG, QEMU_OPTION_clock, "", QEMU_ARCH_ALL) 30565824d651Sblueswir1 30571ed2fc1fSJan KiszkaHXCOMM Options deprecated by -rtc 3058ad96090aSBlue SwirlDEF("localtime", 0, QEMU_OPTION_localtime, "", QEMU_ARCH_ALL) 3059ad96090aSBlue SwirlDEF("startdate", HAS_ARG, QEMU_OPTION_startdate, "", QEMU_ARCH_ALL) 30605824d651Sblueswir1 30611ed2fc1fSJan KiszkaDEF("rtc", HAS_ARG, QEMU_OPTION_rtc, \ 306278808141SPaolo Bonzini "-rtc [base=utc|localtime|date][,clock=host|rt|vm][,driftfix=none|slew]\n" \ 3063ad96090aSBlue Swirl " set the RTC base and clock, enable drift fix for clock ticks (x86 only)\n", 3064ad96090aSBlue Swirl QEMU_ARCH_ALL) 30651ed2fc1fSJan Kiszka 30665824d651Sblueswir1STEXI 30675824d651Sblueswir1 30686875204cSJan Kiszka@item -rtc [base=utc|localtime|@var{date}][,clock=host|vm][,driftfix=none|slew] 30696616b2adSStefan Weil@findex -rtc 30701ed2fc1fSJan KiszkaSpecify @option{base} as @code{utc} or @code{localtime} to let the RTC start at the current 30711ed2fc1fSJan KiszkaUTC or local time, respectively. @code{localtime} is required for correct date in 30721ed2fc1fSJan KiszkaMS-DOS or Windows. To start at a specific point in time, provide @var{date} in the 30731ed2fc1fSJan Kiszkaformat @code{2006-06-17T16:01:21} or @code{2006-06-17}. The default base is UTC. 30741ed2fc1fSJan Kiszka 30759d85d557SMichael TokarevBy default the RTC is driven by the host system time. This allows using of the 30766875204cSJan KiszkaRTC as accurate reference clock inside the guest, specifically if the host 30776875204cSJan Kiszkatime is smoothly following an accurate external reference clock, e.g. via NTP. 307878808141SPaolo BonziniIf you want to isolate the guest time from the host, you can set @option{clock} 307978808141SPaolo Bonzinito @code{rt} instead. To even prevent it from progressing during suspension, 308078808141SPaolo Bonziniyou can set it to @code{vm}. 30816875204cSJan Kiszka 30821ed2fc1fSJan KiszkaEnable @option{driftfix} (i386 targets only) if you experience time drift problems, 30831ed2fc1fSJan Kiszkaspecifically with Windows' ACPI HAL. This option will try to figure out how 30841ed2fc1fSJan Kiszkamany timer interrupts were not processed by the Windows guest and will 30851ed2fc1fSJan Kiszkare-inject them. 30865824d651Sblueswir1ETEXI 30875824d651Sblueswir1 30885824d651Sblueswir1DEF("icount", HAS_ARG, QEMU_OPTION_icount, \ 3089a8bfac37SSebastian Tanase "-icount [shift=N|auto][,align=on|off]\n" \ 3090bc14ca24Saliguori " enable virtual instruction counter with 2^N clock ticks per\n" \ 3091a8bfac37SSebastian Tanase " instruction and enable aligning the host and virtual clocks\n", QEMU_ARCH_ALL) 30925824d651Sblueswir1STEXI 30931ad9580bSSebastian Tanase@item -icount [shift=@var{N}|auto] 30946616b2adSStefan Weil@findex -icount 30955824d651Sblueswir1Enable virtual instruction counter. The virtual cpu will execute one 30964e257e5eSKevin Wolfinstruction every 2^@var{N} ns of virtual time. If @code{auto} is specified 30975824d651Sblueswir1then the virtual cpu speed will be automatically adjusted to keep virtual 30985824d651Sblueswir1time within a few seconds of real time. 30995824d651Sblueswir1 31005824d651Sblueswir1Note that while this option can give deterministic behavior, it does not 31015824d651Sblueswir1provide cycle accurate emulation. Modern CPUs contain superscalar out of 31025824d651Sblueswir1order cores with complex cache hierarchies. The number of instructions 31035824d651Sblueswir1executed often has little or no correlation with actual performance. 3104a8bfac37SSebastian Tanase 3105a8bfac37SSebastian Tanase@option{align=on} will activate the delay algorithm which will try to 3106a8bfac37SSebastian Tanaseto synchronise the host clock and the virtual clock. The goal is to 3107a8bfac37SSebastian Tanasehave a guest running at the real frequency imposed by the shift option. 3108a8bfac37SSebastian TanaseWhenever the guest clock is behind the host clock and if 3109a8bfac37SSebastian Tanase@option{align=on} is specified then we print a messsage to the user 3110a8bfac37SSebastian Tanaseto inform about the delay. 3111a8bfac37SSebastian TanaseCurrently this option does not work when @option{shift} is @code{auto}. 3112a8bfac37SSebastian TanaseNote: The sync algorithm will work for those shift values for which 3113a8bfac37SSebastian Tanasethe guest clock runs ahead of the host clock. Typically this happens 3114a8bfac37SSebastian Tanasewhen the shift value is high (how high depends on the host machine). 31155824d651Sblueswir1ETEXI 31165824d651Sblueswir1 31179dd986ccSRichard W.M. JonesDEF("watchdog", HAS_ARG, QEMU_OPTION_watchdog, \ 31189dd986ccSRichard W.M. Jones "-watchdog i6300esb|ib700\n" \ 3119ad96090aSBlue Swirl " enable virtual hardware watchdog [default=none]\n", 3120ad96090aSBlue Swirl QEMU_ARCH_ALL) 31219dd986ccSRichard W.M. JonesSTEXI 31229dd986ccSRichard W.M. Jones@item -watchdog @var{model} 31236616b2adSStefan Weil@findex -watchdog 31249dd986ccSRichard W.M. JonesCreate a virtual hardware watchdog device. Once enabled (by a guest 31259dd986ccSRichard W.M. Jonesaction), the watchdog must be periodically polled by an agent inside 31269dd986ccSRichard W.M. Jonesthe guest or else the guest will be restarted. 31279dd986ccSRichard W.M. Jones 31289dd986ccSRichard W.M. JonesThe @var{model} is the model of hardware watchdog to emulate. Choices 31299dd986ccSRichard W.M. Jonesfor model are: @code{ib700} (iBASE 700) which is a very simple ISA 31309dd986ccSRichard W.M. Joneswatchdog with a single timer, or @code{i6300esb} (Intel 6300ESB I/O 31319dd986ccSRichard W.M. Jonescontroller hub) which is a much more featureful PCI-based dual-timer 31329dd986ccSRichard W.M. Joneswatchdog. Choose a model for which your guest has drivers. 31339dd986ccSRichard W.M. Jones 3134585f6036SPeter MaydellUse @code{-watchdog help} to list available hardware models. Only one 31359dd986ccSRichard W.M. Joneswatchdog can be enabled for a guest. 31369dd986ccSRichard W.M. JonesETEXI 31379dd986ccSRichard W.M. Jones 31389dd986ccSRichard W.M. JonesDEF("watchdog-action", HAS_ARG, QEMU_OPTION_watchdog_action, \ 31399dd986ccSRichard W.M. Jones "-watchdog-action reset|shutdown|poweroff|pause|debug|none\n" \ 3140ad96090aSBlue Swirl " action when watchdog fires [default=reset]\n", 3141ad96090aSBlue Swirl QEMU_ARCH_ALL) 31429dd986ccSRichard W.M. JonesSTEXI 31439dd986ccSRichard W.M. Jones@item -watchdog-action @var{action} 3144b8f490ebSMarkus Armbruster@findex -watchdog-action 31459dd986ccSRichard W.M. Jones 31469dd986ccSRichard W.M. JonesThe @var{action} controls what QEMU will do when the watchdog timer 31479dd986ccSRichard W.M. Jonesexpires. 31489dd986ccSRichard W.M. JonesThe default is 31499dd986ccSRichard W.M. Jones@code{reset} (forcefully reset the guest). 31509dd986ccSRichard W.M. JonesOther possible actions are: 31519dd986ccSRichard W.M. Jones@code{shutdown} (attempt to gracefully shutdown the guest), 31529dd986ccSRichard W.M. Jones@code{poweroff} (forcefully poweroff the guest), 31539dd986ccSRichard W.M. Jones@code{pause} (pause the guest), 31549dd986ccSRichard W.M. Jones@code{debug} (print a debug message and continue), or 31559dd986ccSRichard W.M. Jones@code{none} (do nothing). 31569dd986ccSRichard W.M. Jones 31579dd986ccSRichard W.M. JonesNote that the @code{shutdown} action requires that the guest responds 31589dd986ccSRichard W.M. Jonesto ACPI signals, which it may not be able to do in the sort of 31599dd986ccSRichard W.M. Jonessituations where the watchdog would have expired, and thus 31609dd986ccSRichard W.M. Jones@code{-watchdog-action shutdown} is not recommended for production use. 31619dd986ccSRichard W.M. Jones 31629dd986ccSRichard W.M. JonesExamples: 31639dd986ccSRichard W.M. Jones 31649dd986ccSRichard W.M. Jones@table @code 31659dd986ccSRichard W.M. Jones@item -watchdog i6300esb -watchdog-action pause 31669dd986ccSRichard W.M. Jones@item -watchdog ib700 31679dd986ccSRichard W.M. Jones@end table 31689dd986ccSRichard W.M. JonesETEXI 31699dd986ccSRichard W.M. Jones 31705824d651Sblueswir1DEF("echr", HAS_ARG, QEMU_OPTION_echr, \ 3171ad96090aSBlue Swirl "-echr chr set terminal escape character instead of ctrl-a\n", 3172ad96090aSBlue Swirl QEMU_ARCH_ALL) 31735824d651Sblueswir1STEXI 31745824d651Sblueswir1 31754e257e5eSKevin Wolf@item -echr @var{numeric_ascii_value} 31766616b2adSStefan Weil@findex -echr 31775824d651Sblueswir1Change the escape character used for switching to the monitor when using 31785824d651Sblueswir1monitor and serial sharing. The default is @code{0x01} when using the 31795824d651Sblueswir1@code{-nographic} option. @code{0x01} is equal to pressing 31805824d651Sblueswir1@code{Control-a}. You can select a different character from the ascii 31815824d651Sblueswir1control keys where 1 through 26 map to Control-a through Control-z. For 31825824d651Sblueswir1instance you could use the either of the following to change the escape 31835824d651Sblueswir1character to Control-t. 31845824d651Sblueswir1@table @code 31855824d651Sblueswir1@item -echr 0x14 31865824d651Sblueswir1@item -echr 20 31875824d651Sblueswir1@end table 31885824d651Sblueswir1ETEXI 31895824d651Sblueswir1 31905824d651Sblueswir1DEF("virtioconsole", HAS_ARG, QEMU_OPTION_virtiocon, \ 31915824d651Sblueswir1 "-virtioconsole c\n" \ 3192ad96090aSBlue Swirl " set virtio console\n", QEMU_ARCH_ALL) 31935824d651Sblueswir1STEXI 31945824d651Sblueswir1@item -virtioconsole @var{c} 31956616b2adSStefan Weil@findex -virtioconsole 31965824d651Sblueswir1Set virtio console. 319798b19252SAmit Shah 319898b19252SAmit ShahThis option is maintained for backward compatibility. 319998b19252SAmit Shah 320098b19252SAmit ShahPlease use @code{-device virtconsole} for the new way of invocation. 32015824d651Sblueswir1ETEXI 32025824d651Sblueswir1 32035824d651Sblueswir1DEF("show-cursor", 0, QEMU_OPTION_show_cursor, \ 3204ad96090aSBlue Swirl "-show-cursor show cursor\n", QEMU_ARCH_ALL) 32055824d651Sblueswir1STEXI 320695d5f08bSStefan Weil@item -show-cursor 32076616b2adSStefan Weil@findex -show-cursor 320895d5f08bSStefan WeilShow cursor. 32095824d651Sblueswir1ETEXI 32105824d651Sblueswir1 32115824d651Sblueswir1DEF("tb-size", HAS_ARG, QEMU_OPTION_tb_size, \ 3212ad96090aSBlue Swirl "-tb-size n set TB size\n", QEMU_ARCH_ALL) 32135824d651Sblueswir1STEXI 321495d5f08bSStefan Weil@item -tb-size @var{n} 32156616b2adSStefan Weil@findex -tb-size 321695d5f08bSStefan WeilSet TB size. 32175824d651Sblueswir1ETEXI 32185824d651Sblueswir1 32195824d651Sblueswir1DEF("incoming", HAS_ARG, QEMU_OPTION_incoming, \ 32207c601803SMichael Tokarev "-incoming tcp:[host]:port[,to=maxport][,ipv4][,ipv6]\n" \ 32217c601803SMichael Tokarev "-incoming rdma:host:port[,ipv4][,ipv6]\n" \ 32227c601803SMichael Tokarev "-incoming unix:socketpath\n" \ 32237c601803SMichael Tokarev " prepare for incoming migration, listen on\n" \ 32247c601803SMichael Tokarev " specified protocol and socket address\n" \ 32257c601803SMichael Tokarev "-incoming fd:fd\n" \ 32267c601803SMichael Tokarev "-incoming exec:cmdline\n" \ 32277c601803SMichael Tokarev " accept incoming migration on given file descriptor\n" \ 32287c601803SMichael Tokarev " or from given external command\n", 3229ad96090aSBlue Swirl QEMU_ARCH_ALL) 32305824d651Sblueswir1STEXI 32317c601803SMichael Tokarev@item -incoming tcp:[@var{host}]:@var{port}[,to=@var{maxport}][,ipv4][,ipv6] 32327c601803SMichael Tokarev@item -incoming rdma:@var{host}:@var{port}[,ipv4][,ipv6] 32336616b2adSStefan Weil@findex -incoming 32347c601803SMichael TokarevPrepare for incoming migration, listen on a given tcp port. 32357c601803SMichael Tokarev 32367c601803SMichael Tokarev@item -incoming unix:@var{socketpath} 32377c601803SMichael TokarevPrepare for incoming migration, listen on a given unix socket. 32387c601803SMichael Tokarev 32397c601803SMichael Tokarev@item -incoming fd:@var{fd} 32407c601803SMichael TokarevAccept incoming migration from a given filedescriptor. 32417c601803SMichael Tokarev 32427c601803SMichael Tokarev@item -incoming exec:@var{cmdline} 32437c601803SMichael TokarevAccept incoming migration as an output from specified external command. 32445824d651Sblueswir1ETEXI 32455824d651Sblueswir1 3246d8c208ddSGerd HoffmannDEF("nodefaults", 0, QEMU_OPTION_nodefaults, \ 3247ad96090aSBlue Swirl "-nodefaults don't create default devices\n", QEMU_ARCH_ALL) 3248d8c208ddSGerd HoffmannSTEXI 32493dbf2c7fSStefan Weil@item -nodefaults 32506616b2adSStefan Weil@findex -nodefaults 325166c19bf1SMichal NovotnyDon't create default devices. Normally, QEMU sets the default devices like serial 325266c19bf1SMichal Novotnyport, parallel port, virtual console, monitor device, VGA adapter, floppy and 325366c19bf1SMichal NovotnyCD-ROM drive and others. The @code{-nodefaults} option will disable all those 325466c19bf1SMichal Novotnydefault devices. 3255d8c208ddSGerd HoffmannETEXI 3256d8c208ddSGerd Hoffmann 32575824d651Sblueswir1#ifndef _WIN32 32585824d651Sblueswir1DEF("chroot", HAS_ARG, QEMU_OPTION_chroot, \ 3259ad96090aSBlue Swirl "-chroot dir chroot to dir just before starting the VM\n", 3260ad96090aSBlue Swirl QEMU_ARCH_ALL) 32615824d651Sblueswir1#endif 32625824d651Sblueswir1STEXI 32634e257e5eSKevin Wolf@item -chroot @var{dir} 32646616b2adSStefan Weil@findex -chroot 32655824d651Sblueswir1Immediately before starting guest execution, chroot to the specified 32665824d651Sblueswir1directory. Especially useful in combination with -runas. 32675824d651Sblueswir1ETEXI 32685824d651Sblueswir1 32695824d651Sblueswir1#ifndef _WIN32 32705824d651Sblueswir1DEF("runas", HAS_ARG, QEMU_OPTION_runas, \ 3271ad96090aSBlue Swirl "-runas user change to user id user just before starting the VM\n", 3272ad96090aSBlue Swirl QEMU_ARCH_ALL) 32735824d651Sblueswir1#endif 32745824d651Sblueswir1STEXI 32754e257e5eSKevin Wolf@item -runas @var{user} 32766616b2adSStefan Weil@findex -runas 32775824d651Sblueswir1Immediately before starting guest execution, drop root privileges, switching 32785824d651Sblueswir1to the specified user. 32795824d651Sblueswir1ETEXI 32805824d651Sblueswir1 32815824d651Sblueswir1DEF("prom-env", HAS_ARG, QEMU_OPTION_prom_env, 32825824d651Sblueswir1 "-prom-env variable=value\n" 3283ad96090aSBlue Swirl " set OpenBIOS nvram variables\n", 3284ad96090aSBlue Swirl QEMU_ARCH_PPC | QEMU_ARCH_SPARC) 328595d5f08bSStefan WeilSTEXI 328695d5f08bSStefan Weil@item -prom-env @var{variable}=@var{value} 32876616b2adSStefan Weil@findex -prom-env 328895d5f08bSStefan WeilSet OpenBIOS nvram @var{variable} to given @var{value} (PPC, SPARC only). 328995d5f08bSStefan WeilETEXI 32905824d651Sblueswir1DEF("semihosting", 0, QEMU_OPTION_semihosting, 3291f7bbcfb5SMichael Walle "-semihosting semihosting mode\n", 3292f7bbcfb5SMichael Walle QEMU_ARCH_ARM | QEMU_ARCH_M68K | QEMU_ARCH_XTENSA | QEMU_ARCH_LM32) 329395d5f08bSStefan WeilSTEXI 329495d5f08bSStefan Weil@item -semihosting 32956616b2adSStefan Weil@findex -semihosting 3296a38bb079SLiviu IonescuEnable semihosting mode (ARM, M68K, Xtensa only). 3297a38bb079SLiviu IonescuETEXI 3298a38bb079SLiviu IonescuDEF("semihosting-config", HAS_ARG, QEMU_OPTION_semihosting_config, 3299a38bb079SLiviu Ionescu "-semihosting-config [enable=on|off,]target=native|gdb|auto semihosting configuration\n", 3300a38bb079SLiviu IonescuQEMU_ARCH_ARM | QEMU_ARCH_M68K | QEMU_ARCH_XTENSA | QEMU_ARCH_LM32) 3301a38bb079SLiviu IonescuSTEXI 3302a38bb079SLiviu Ionescu@item -semihosting-config [enable=on|off,]target=native|gdb|auto 3303a38bb079SLiviu Ionescu@findex -semihosting-config 3304a38bb079SLiviu IonescuEnable semihosting and define where the semihosting calls will be addressed, 3305a38bb079SLiviu Ionescuto QEMU (@code{native}) or to GDB (@code{gdb}). The default is @code{auto}, which means 3306a38bb079SLiviu Ionescu@code{gdb} during debug sessions and @code{native} otherwise (ARM, M68K, Xtensa only). 330795d5f08bSStefan WeilETEXI 33085824d651Sblueswir1DEF("old-param", 0, QEMU_OPTION_old_param, 3309ad96090aSBlue Swirl "-old-param old param mode\n", QEMU_ARCH_ARM) 331095d5f08bSStefan WeilSTEXI 331195d5f08bSStefan Weil@item -old-param 33126616b2adSStefan Weil@findex -old-param (ARM) 331395d5f08bSStefan WeilOld param mode (ARM only). 331495d5f08bSStefan WeilETEXI 331595d5f08bSStefan Weil 33167d76ad4fSEduardo OtuboDEF("sandbox", HAS_ARG, QEMU_OPTION_sandbox, \ 33177d76ad4fSEduardo Otubo "-sandbox <arg> Enable seccomp mode 2 system call filter (default 'off').\n", 33187d76ad4fSEduardo Otubo QEMU_ARCH_ALL) 33197d76ad4fSEduardo OtuboSTEXI 33206265c43bSMarkus Armbruster@item -sandbox @var{arg} 33217d76ad4fSEduardo Otubo@findex -sandbox 33227d76ad4fSEduardo OtuboEnable Seccomp mode 2 system call filter. 'on' will enable syscall filtering and 'off' will 33237d76ad4fSEduardo Otubodisable it. The default is 'off'. 33247d76ad4fSEduardo OtuboETEXI 33257d76ad4fSEduardo Otubo 3326715a664aSGerd HoffmannDEF("readconfig", HAS_ARG, QEMU_OPTION_readconfig, 3327ad96090aSBlue Swirl "-readconfig <file>\n", QEMU_ARCH_ALL) 33283dbf2c7fSStefan WeilSTEXI 33293dbf2c7fSStefan Weil@item -readconfig @var{file} 33306616b2adSStefan Weil@findex -readconfig 3331ed24cfacSMichal NovotnyRead device configuration from @var{file}. This approach is useful when you want to spawn 3332ed24cfacSMichal NovotnyQEMU process with many command line options but you don't want to exceed the command line 3333ed24cfacSMichal Novotnycharacter limit. 33343dbf2c7fSStefan WeilETEXI 3335715a664aSGerd HoffmannDEF("writeconfig", HAS_ARG, QEMU_OPTION_writeconfig, 3336715a664aSGerd Hoffmann "-writeconfig <file>\n" 3337ad96090aSBlue Swirl " read/write config file\n", QEMU_ARCH_ALL) 33383dbf2c7fSStefan WeilSTEXI 33393dbf2c7fSStefan Weil@item -writeconfig @var{file} 33406616b2adSStefan Weil@findex -writeconfig 3341ed24cfacSMichal NovotnyWrite device configuration to @var{file}. The @var{file} can be either filename to save 3342ed24cfacSMichal Novotnycommand line and device configuration into file or dash @code{-}) character to print the 3343ed24cfacSMichal Novotnyoutput to stdout. This can be later used as input file for @code{-readconfig} option. 33443dbf2c7fSStefan WeilETEXI 3345292444cbSAnthony LiguoriDEF("nodefconfig", 0, QEMU_OPTION_nodefconfig, 3346292444cbSAnthony Liguori "-nodefconfig\n" 3347ad96090aSBlue Swirl " do not load default config files at startup\n", 3348ad96090aSBlue Swirl QEMU_ARCH_ALL) 3349292444cbSAnthony LiguoriSTEXI 3350292444cbSAnthony Liguori@item -nodefconfig 33516616b2adSStefan Weil@findex -nodefconfig 3352f29a5614SEduardo HabkostNormally QEMU loads configuration files from @var{sysconfdir} and @var{datadir} at startup. 3353f29a5614SEduardo HabkostThe @code{-nodefconfig} option will prevent QEMU from loading any of those config files. 3354f29a5614SEduardo HabkostETEXI 3355f29a5614SEduardo HabkostDEF("no-user-config", 0, QEMU_OPTION_nouserconfig, 3356f29a5614SEduardo Habkost "-no-user-config\n" 3357f29a5614SEduardo Habkost " do not load user-provided config files at startup\n", 3358f29a5614SEduardo Habkost QEMU_ARCH_ALL) 3359f29a5614SEduardo HabkostSTEXI 3360f29a5614SEduardo Habkost@item -no-user-config 3361f29a5614SEduardo Habkost@findex -no-user-config 3362f29a5614SEduardo HabkostThe @code{-no-user-config} option makes QEMU not load any of the user-provided 3363f29a5614SEduardo Habkostconfig files on @var{sysconfdir}, but won't make it skip the QEMU-provided config 3364f29a5614SEduardo Habkostfiles from @var{datadir}. 3365292444cbSAnthony LiguoriETEXI 3366ab6540d5SPrerna SaxenaDEF("trace", HAS_ARG, QEMU_OPTION_trace, 336723d15e86SLluís "-trace [events=<file>][,file=<file>]\n" 336823d15e86SLluís " specify tracing options\n", 3369ab6540d5SPrerna Saxena QEMU_ARCH_ALL) 3370ab6540d5SPrerna SaxenaSTEXI 337123d15e86SLluísHXCOMM This line is not accurate, as some sub-options are backend-specific but 337223d15e86SLluísHXCOMM HX does not support conditional compilation of text. 337323d15e86SLluís@item -trace [events=@var{file}][,file=@var{file}] 3374ab6540d5SPrerna Saxena@findex -trace 3375e4858974SLluís 337623d15e86SLluísSpecify tracing options. 337723d15e86SLluís 337823d15e86SLluís@table @option 337923d15e86SLluís@item events=@var{file} 338023d15e86SLluísImmediately enable events listed in @var{file}. 338123d15e86SLluísThe file must contain one event name (as listed in the @var{trace-events} file) 338223d15e86SLluísper line. 3383c1ba4e0bSStefan WeilThis option is only available if QEMU has been compiled with 3384c1ba4e0bSStefan Weileither @var{simple} or @var{stderr} tracing backend. 338523d15e86SLluís@item file=@var{file} 338623d15e86SLluísLog output traces to @var{file}. 338723d15e86SLluís 3388c1ba4e0bSStefan WeilThis option is only available if QEMU has been compiled with 3389c1ba4e0bSStefan Weilthe @var{simple} tracing backend. 339023d15e86SLluís@end table 3391ab6540d5SPrerna SaxenaETEXI 33923dbf2c7fSStefan Weil 339331e70d6cSMarkus ArmbrusterHXCOMM Internal use 339431e70d6cSMarkus ArmbrusterDEF("qtest", HAS_ARG, QEMU_OPTION_qtest, "", QEMU_ARCH_ALL) 339531e70d6cSMarkus ArmbrusterDEF("qtest-log", HAS_ARG, QEMU_OPTION_qtest_log, "", QEMU_ARCH_ALL) 3396c7f0f3b1SAnthony Liguori 33970f66998fSPaul Moore#ifdef __linux__ 33980f66998fSPaul MooreDEF("enable-fips", 0, QEMU_OPTION_enablefips, 33990f66998fSPaul Moore "-enable-fips enable FIPS 140-2 compliance\n", 34000f66998fSPaul Moore QEMU_ARCH_ALL) 34010f66998fSPaul Moore#endif 34020f66998fSPaul MooreSTEXI 34030f66998fSPaul Moore@item -enable-fips 34040f66998fSPaul Moore@findex -enable-fips 34050f66998fSPaul MooreEnable FIPS 140-2 compliance mode. 34060f66998fSPaul MooreETEXI 34070f66998fSPaul Moore 3408a0dac021SJan KiszkaHXCOMM Deprecated by -machine accel=tcg property 3409c6e88b3bSBruce RogersDEF("no-kvm", 0, QEMU_OPTION_no_kvm, "", QEMU_ARCH_I386) 3410a0dac021SJan Kiszka 3411c21fb4f8SJan KiszkaHXCOMM Deprecated by kvm-pit driver properties 3412c6e88b3bSBruce RogersDEF("no-kvm-pit-reinjection", 0, QEMU_OPTION_no_kvm_pit_reinjection, 3413c21fb4f8SJan Kiszka "", QEMU_ARCH_I386) 3414c21fb4f8SJan Kiszka 34154086bde8SJan KiszkaHXCOMM Deprecated (ignored) 3416c6e88b3bSBruce RogersDEF("no-kvm-pit", 0, QEMU_OPTION_no_kvm_pit, "", QEMU_ARCH_I386) 34174086bde8SJan Kiszka 3418e43d594eSJan KiszkaHXCOMM Deprecated by -machine kernel_irqchip=on|off property 3419c6e88b3bSBruce RogersDEF("no-kvm-irqchip", 0, QEMU_OPTION_no_kvm_irqchip, "", QEMU_ARCH_I386) 3420e43d594eSJan Kiszka 342188eed34aSJan KiszkaHXCOMM Deprecated (ignored) 342288eed34aSJan KiszkaDEF("tdf", 0, QEMU_OPTION_tdf,"", QEMU_ARCH_ALL) 342388eed34aSJan Kiszka 342468d98d3eSAnthony LiguoriDEF("object", HAS_ARG, QEMU_OPTION_object, 342568d98d3eSAnthony Liguori "-object TYPENAME[,PROP1=VALUE1,...]\n" 342668d98d3eSAnthony Liguori " create an new object of type TYPENAME setting properties\n" 342768d98d3eSAnthony Liguori " in the order they are specified. Note that the 'id'\n" 342868d98d3eSAnthony Liguori " property must be set. These objects are placed in the\n" 342968d98d3eSAnthony Liguori " '/objects' path.\n", 343068d98d3eSAnthony Liguori QEMU_ARCH_ALL) 34316265c43bSMarkus ArmbrusterSTEXI 34326265c43bSMarkus Armbruster@item -object @var{typename}[,@var{prop1}=@var{value1},...] 34336265c43bSMarkus Armbruster@findex -object 34346265c43bSMarkus ArmbrusterCreate an new object of type @var{typename} setting properties 34356265c43bSMarkus Armbrusterin the order they are specified. Note that the 'id' 34366265c43bSMarkus Armbrusterproperty must be set. These objects are placed in the 34376265c43bSMarkus Armbruster'/objects' path. 34386265c43bSMarkus ArmbrusterETEXI 343968d98d3eSAnthony Liguori 34405e2ac519SSeiji AguchiDEF("msg", HAS_ARG, QEMU_OPTION_msg, 34415e2ac519SSeiji Aguchi "-msg timestamp[=on|off]\n" 34425e2ac519SSeiji Aguchi " change the format of messages\n" 34435e2ac519SSeiji Aguchi " on|off controls leading timestamps (default:on)\n", 34445e2ac519SSeiji Aguchi QEMU_ARCH_ALL) 34455e2ac519SSeiji AguchiSTEXI 34465e2ac519SSeiji Aguchi@item -msg timestamp[=on|off] 34475e2ac519SSeiji Aguchi@findex -msg 34485e2ac519SSeiji Aguchiprepend a timestamp to each log message.(default:on) 34495e2ac519SSeiji AguchiETEXI 34505e2ac519SSeiji Aguchi 3451abfd9ce3SAmit ShahDEF("dump-vmstate", HAS_ARG, QEMU_OPTION_dump_vmstate, 3452abfd9ce3SAmit Shah "-dump-vmstate <file>\n" 3453abfd9ce3SAmit Shah " Output vmstate information in JSON format to file.\n" 3454abfd9ce3SAmit Shah " Use the scripts/vmstate-static-checker.py file to\n" 3455abfd9ce3SAmit Shah " check for possible regressions in migration code\n" 3456abfd9ce3SAmit Shah " by comparing two such vmstate dumps.", 3457abfd9ce3SAmit Shah QEMU_ARCH_ALL) 3458abfd9ce3SAmit ShahSTEXI 3459abfd9ce3SAmit Shah@item -dump-vmstate @var{file} 3460abfd9ce3SAmit Shah@findex -dump-vmstate 3461abfd9ce3SAmit ShahDump json-encoded vmstate information for current machine type to file 3462abfd9ce3SAmit Shahin @var{file} 3463abfd9ce3SAmit ShahETEXI 3464abfd9ce3SAmit Shah 34653dbf2c7fSStefan WeilHXCOMM This is the last statement. Insert new options before this line! 34663dbf2c7fSStefan WeilSTEXI 34673dbf2c7fSStefan Weil@end table 34683dbf2c7fSStefan WeilETEXI 3469