15824d651Sblueswir1HXCOMM Use DEFHEADING() to define headings in both help text and texi 25824d651Sblueswir1HXCOMM Text between STEXI and ETEXI are copied to texi version and 35824d651Sblueswir1HXCOMM discarded from C version 4ad96090aSBlue SwirlHXCOMM DEF(option, HAS_ARG/0, opt_enum, opt_help, arch_mask) is used to 5ad96090aSBlue SwirlHXCOMM construct option structures, enums and help message for specified 6ad96090aSBlue SwirlHXCOMM architectures. 75824d651Sblueswir1HXCOMM HXCOMM can be used for comments, discarded from both texi and C 85824d651Sblueswir1 95824d651Sblueswir1DEFHEADING(Standard options:) 105824d651Sblueswir1STEXI 115824d651Sblueswir1@table @option 125824d651Sblueswir1ETEXI 135824d651Sblueswir1 145824d651Sblueswir1DEF("help", 0, QEMU_OPTION_h, 15ad96090aSBlue Swirl "-h or -help display this help and exit\n", QEMU_ARCH_ALL) 165824d651Sblueswir1STEXI 175824d651Sblueswir1@item -h 186616b2adSStefan Weil@findex -h 195824d651Sblueswir1Display help and exit 205824d651Sblueswir1ETEXI 215824d651Sblueswir1 229bd7e6d9SpbrookDEF("version", 0, QEMU_OPTION_version, 23ad96090aSBlue Swirl "-version display version information and exit\n", QEMU_ARCH_ALL) 249bd7e6d9SpbrookSTEXI 259bd7e6d9Spbrook@item -version 266616b2adSStefan Weil@findex -version 279bd7e6d9SpbrookDisplay version information and exit 289bd7e6d9SpbrookETEXI 299bd7e6d9Spbrook 3080f52a66SJan KiszkaDEF("machine", HAS_ARG, QEMU_OPTION_machine, \ 3180f52a66SJan Kiszka "-machine [type=]name[,prop[=value][,...]]\n" 32585f6036SPeter Maydell " selects emulated machine ('-machine help' for list)\n" 3380f52a66SJan Kiszka " property accel=accel1[:accel2[:...]] selects accelerator\n" 346a48ffaaSJan Kiszka " supported accelerators are kvm, xen, tcg (default: tcg)\n" 3539d6960aSJan Kiszka " kernel_irqchip=on|off controls accelerated irqchip support\n" 36ddb97f1dSJason Baron " kvm_shadow_mem=size of KVM shadow MMU\n" 378490fc78SLuiz Capitulino " dump-guest-core=on|off include guest memory in a core dump (default=on)\n" 38a52a7fdfSLe Tan " mem-merge=on|off controls memory merge support (default: on)\n" 39a52a7fdfSLe Tan " iommu=on|off controls emulated Intel IOMMU (VT-d) support (default=off)\n", 4080f52a66SJan Kiszka QEMU_ARCH_ALL) 415824d651Sblueswir1STEXI 4280f52a66SJan Kiszka@item -machine [type=]@var{name}[,prop=@var{value}[,...]] 4380f52a66SJan Kiszka@findex -machine 44585f6036SPeter MaydellSelect the emulated machine by @var{name}. Use @code{-machine help} to list 4580f52a66SJan Kiszkaavailable machines. Supported machine properties are: 4680f52a66SJan Kiszka@table @option 4780f52a66SJan Kiszka@item accel=@var{accels1}[:@var{accels2}[:...]] 4880f52a66SJan KiszkaThis is used to enable an accelerator. Depending on the target architecture, 4980f52a66SJan Kiszkakvm, xen, or tcg can be available. By default, tcg is used. If there is more 5080f52a66SJan Kiszkathan one accelerator specified, the next one is used if the previous one fails 5180f52a66SJan Kiszkato initialize. 526a48ffaaSJan Kiszka@item kernel_irqchip=on|off 536a48ffaaSJan KiszkaEnables in-kernel irqchip support for the chosen accelerator when available. 5439d6960aSJan Kiszka@item kvm_shadow_mem=size 5539d6960aSJan KiszkaDefines the size of the KVM shadow MMU. 56ddb97f1dSJason Baron@item dump-guest-core=on|off 57ddb97f1dSJason BaronInclude guest memory in a core dump. The default is on. 588490fc78SLuiz Capitulino@item mem-merge=on|off 598490fc78SLuiz CapitulinoEnables or disables memory merge support. This feature, when supported by 608490fc78SLuiz Capitulinothe host, de-duplicates identical memory pages among VMs instances 618490fc78SLuiz Capitulino(enabled by default). 62a52a7fdfSLe Tan@item iommu=on|off 63a52a7fdfSLe TanEnables or disables emulated Intel IOMMU (VT-d) support. The default is off. 6480f52a66SJan Kiszka@end table 655824d651Sblueswir1ETEXI 665824d651Sblueswir1 6780f52a66SJan KiszkaHXCOMM Deprecated by -machine 6880f52a66SJan KiszkaDEF("M", HAS_ARG, QEMU_OPTION_M, "", QEMU_ARCH_ALL) 6980f52a66SJan Kiszka 705824d651Sblueswir1DEF("cpu", HAS_ARG, QEMU_OPTION_cpu, 71585f6036SPeter Maydell "-cpu cpu select CPU ('-cpu help' for list)\n", QEMU_ARCH_ALL) 725824d651Sblueswir1STEXI 735824d651Sblueswir1@item -cpu @var{model} 746616b2adSStefan Weil@findex -cpu 75585f6036SPeter MaydellSelect CPU model (@code{-cpu help} for list and additional feature selection) 765824d651Sblueswir1ETEXI 775824d651Sblueswir1 785824d651Sblueswir1DEF("smp", HAS_ARG, QEMU_OPTION_smp, 7912b7f57eSMichael Tokarev "-smp [cpus=]n[,maxcpus=cpus][,cores=cores][,threads=threads][,sockets=sockets]\n" 806be68d7eSJes Sorensen " set the number of CPUs to 'n' [default=1]\n" 816be68d7eSJes Sorensen " maxcpus= maximum number of total cpus, including\n" 82ca1a8a06SBruce Rogers " offline CPUs for hotplug, etc\n" 8358a04db1SAndre Przywara " cores= number of CPU cores on one socket\n" 8458a04db1SAndre Przywara " threads= number of threads on one CPU core\n" 85ad96090aSBlue Swirl " sockets= number of discrete sockets in the system\n", 86ad96090aSBlue Swirl QEMU_ARCH_ALL) 875824d651Sblueswir1STEXI 8812b7f57eSMichael Tokarev@item -smp [cpus=]@var{n}[,cores=@var{cores}][,threads=@var{threads}][,sockets=@var{sockets}][,maxcpus=@var{maxcpus}] 896616b2adSStefan Weil@findex -smp 905824d651Sblueswir1Simulate an SMP system with @var{n} CPUs. On the PC target, up to 255 915824d651Sblueswir1CPUs are supported. On Sparc32 target, Linux limits the number of usable CPUs 925824d651Sblueswir1to 4. 9358a04db1SAndre PrzywaraFor the PC target, the number of @var{cores} per socket, the number 9458a04db1SAndre Przywaraof @var{threads} per cores and the total number of @var{sockets} can be 9558a04db1SAndre Przywaraspecified. Missing values will be computed. If any on the three values is 9658a04db1SAndre Przywaragiven, the total number of CPUs @var{n} can be omitted. @var{maxcpus} 9758a04db1SAndre Przywaraspecifies the maximum number of hotpluggable CPUs. 985824d651Sblueswir1ETEXI 995824d651Sblueswir1 100268a362cSaliguoriDEF("numa", HAS_ARG, QEMU_OPTION_numa, 1017febe36fSPaolo Bonzini "-numa node[,mem=size][,cpus=cpu[-cpu]][,nodeid=node]\n" 1027febe36fSPaolo Bonzini "-numa node[,memdev=id][,cpus=cpu[-cpu]][,nodeid=node]\n", QEMU_ARCH_ALL) 103268a362cSaliguoriSTEXI 1044932b897SLuiz Capitulino@item -numa node[,mem=@var{size}][,cpus=@var{cpu[-cpu]}][,nodeid=@var{node}] 1057febe36fSPaolo Bonzini@item -numa node[,memdev=@var{id}][,cpus=@var{cpu[-cpu]}][,nodeid=@var{node}] 1066616b2adSStefan Weil@findex -numa 1077febe36fSPaolo BonziniSimulate a multi node NUMA system. If @samp{mem}, @samp{memdev} 1084932b897SLuiz Capitulinoand @samp{cpus} are omitted, resources are split equally. Also, note 1094932b897SLuiz Capitulinothat the -@option{numa} option doesn't allocate any of the specified 1104932b897SLuiz Capitulinoresources. That is, it just assigns existing resources to NUMA nodes. This 1114932b897SLuiz Capitulinomeans that one still has to use the @option{-m}, @option{-smp} options 1127febe36fSPaolo Bonzinito allocate RAM and VCPUs respectively, and possibly @option{-object} 1137febe36fSPaolo Bonzinito specify the memory backend for the @samp{memdev} suboption. 1147febe36fSPaolo Bonzini 1157febe36fSPaolo Bonzini@samp{mem} and @samp{memdev} are mutually exclusive. Furthermore, if one 1167febe36fSPaolo Bonzininode uses @samp{memdev}, all of them have to use it. 117268a362cSaliguoriETEXI 118268a362cSaliguori 11910adb8beSMarkus ArmbrusterDEF("add-fd", HAS_ARG, QEMU_OPTION_add_fd, 12010adb8beSMarkus Armbruster "-add-fd fd=fd,set=set[,opaque=opaque]\n" 12110adb8beSMarkus Armbruster " Add 'fd' to fd 'set'\n", QEMU_ARCH_ALL) 12210adb8beSMarkus ArmbrusterSTEXI 12310adb8beSMarkus Armbruster@item -add-fd fd=@var{fd},set=@var{set}[,opaque=@var{opaque}] 12410adb8beSMarkus Armbruster@findex -add-fd 12510adb8beSMarkus Armbruster 12610adb8beSMarkus ArmbrusterAdd a file descriptor to an fd set. Valid options are: 12710adb8beSMarkus Armbruster 12810adb8beSMarkus Armbruster@table @option 12910adb8beSMarkus Armbruster@item fd=@var{fd} 13010adb8beSMarkus ArmbrusterThis option defines the file descriptor of which a duplicate is added to fd set. 13110adb8beSMarkus ArmbrusterThe file descriptor cannot be stdin, stdout, or stderr. 13210adb8beSMarkus Armbruster@item set=@var{set} 13310adb8beSMarkus ArmbrusterThis option defines the ID of the fd set to add the file descriptor to. 13410adb8beSMarkus Armbruster@item opaque=@var{opaque} 13510adb8beSMarkus ArmbrusterThis option defines a free-form string that can be used to describe @var{fd}. 13610adb8beSMarkus Armbruster@end table 13710adb8beSMarkus Armbruster 13810adb8beSMarkus ArmbrusterYou can open an image using pre-opened file descriptors from an fd set: 13910adb8beSMarkus Armbruster@example 14010adb8beSMarkus Armbrusterqemu-system-i386 14110adb8beSMarkus Armbruster-add-fd fd=3,set=2,opaque="rdwr:/path/to/file" 14210adb8beSMarkus Armbruster-add-fd fd=4,set=2,opaque="rdonly:/path/to/file" 14310adb8beSMarkus Armbruster-drive file=/dev/fdset/2,index=0,media=disk 14410adb8beSMarkus Armbruster@end example 14510adb8beSMarkus ArmbrusterETEXI 14610adb8beSMarkus Armbruster 14710adb8beSMarkus ArmbrusterDEF("set", HAS_ARG, QEMU_OPTION_set, 14810adb8beSMarkus Armbruster "-set group.id.arg=value\n" 14910adb8beSMarkus Armbruster " set <arg> parameter for item <id> of type <group>\n" 15010adb8beSMarkus Armbruster " i.e. -set drive.$id.file=/path/to/image\n", QEMU_ARCH_ALL) 15110adb8beSMarkus ArmbrusterSTEXI 15210adb8beSMarkus Armbruster@item -set @var{group}.@var{id}.@var{arg}=@var{value} 15310adb8beSMarkus Armbruster@findex -set 15410adb8beSMarkus ArmbrusterSet parameter @var{arg} for item @var{id} of type @var{group}\n" 15510adb8beSMarkus ArmbrusterETEXI 15610adb8beSMarkus Armbruster 15710adb8beSMarkus ArmbrusterDEF("global", HAS_ARG, QEMU_OPTION_global, 15810adb8beSMarkus Armbruster "-global driver.prop=value\n" 15910adb8beSMarkus Armbruster " set a global default for a driver property\n", 16010adb8beSMarkus Armbruster QEMU_ARCH_ALL) 16110adb8beSMarkus ArmbrusterSTEXI 16210adb8beSMarkus Armbruster@item -global @var{driver}.@var{prop}=@var{value} 16310adb8beSMarkus Armbruster@findex -global 16410adb8beSMarkus ArmbrusterSet default value of @var{driver}'s property @var{prop} to @var{value}, e.g.: 16510adb8beSMarkus Armbruster 16610adb8beSMarkus Armbruster@example 16710adb8beSMarkus Armbrusterqemu-system-i386 -global ide-drive.physical_block_size=4096 -drive file=file,if=ide,index=0,media=disk 16810adb8beSMarkus Armbruster@end example 16910adb8beSMarkus Armbruster 17010adb8beSMarkus ArmbrusterIn particular, you can use this to set driver properties for devices which are 17110adb8beSMarkus Armbrustercreated automatically by the machine model. To create a device which is not 17210adb8beSMarkus Armbrustercreated automatically and set properties on it, use -@option{device}. 17310adb8beSMarkus ArmbrusterETEXI 17410adb8beSMarkus Armbruster 17510adb8beSMarkus ArmbrusterDEF("boot", HAS_ARG, QEMU_OPTION_boot, 17610adb8beSMarkus Armbruster "-boot [order=drives][,once=drives][,menu=on|off]\n" 177c8a6ae8bSAmos Kong " [,splash=sp_name][,splash-time=sp_time][,reboot-timeout=rb_time][,strict=on|off]\n" 17810adb8beSMarkus Armbruster " 'drives': floppy (a), hard disk (c), CD-ROM (d), network (n)\n" 17910adb8beSMarkus Armbruster " 'sp_name': the file's name that would be passed to bios as logo picture, if menu=on\n" 18010adb8beSMarkus Armbruster " 'sp_time': the period that splash picture last if menu=on, unit is ms\n" 18110adb8beSMarkus Armbruster " 'rb_timeout': the timeout before guest reboot when boot failed, unit is ms\n", 18210adb8beSMarkus Armbruster QEMU_ARCH_ALL) 18310adb8beSMarkus ArmbrusterSTEXI 184c8a6ae8bSAmos 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] 18510adb8beSMarkus Armbruster@findex -boot 18610adb8beSMarkus ArmbrusterSpecify boot order @var{drives} as a string of drive letters. Valid 18710adb8beSMarkus Armbrusterdrive letters depend on the target achitecture. The x86 PC uses: a, b 18810adb8beSMarkus Armbruster(floppy 1 and 2), c (first hard disk), d (first CD-ROM), n-p (Etherboot 18910adb8beSMarkus Armbrusterfrom network adapter 1-4), hard disk boot is the default. To apply a 19010adb8beSMarkus Armbrusterparticular boot order only on the first startup, specify it via 19110adb8beSMarkus Armbruster@option{once}. 19210adb8beSMarkus Armbruster 19310adb8beSMarkus ArmbrusterInteractive boot menus/prompts can be enabled via @option{menu=on} as far 19410adb8beSMarkus Armbrusteras firmware/BIOS supports them. The default is non-interactive boot. 19510adb8beSMarkus Armbruster 19610adb8beSMarkus ArmbrusterA splash picture could be passed to bios, enabling user to show it as logo, 19710adb8beSMarkus Armbrusterwhen option splash=@var{sp_name} is given and menu=on, If firmware/BIOS 19810adb8beSMarkus Armbrustersupports them. Currently Seabios for X86 system support it. 19910adb8beSMarkus Armbrusterlimitation: The splash file could be a jpeg file or a BMP file in 24 BPP 20010adb8beSMarkus Armbrusterformat(true color). The resolution should be supported by the SVGA mode, so 20110adb8beSMarkus Armbrusterthe recommended is 320x240, 640x480, 800x640. 20210adb8beSMarkus Armbruster 20310adb8beSMarkus ArmbrusterA timeout could be passed to bios, guest will pause for @var{rb_timeout} ms 20410adb8beSMarkus Armbrusterwhen boot failed, then reboot. If @var{rb_timeout} is '-1', guest will not 20510adb8beSMarkus Armbrusterreboot, qemu passes '-1' to bios by default. Currently Seabios for X86 20610adb8beSMarkus Armbrustersystem support it. 20710adb8beSMarkus Armbruster 208c8a6ae8bSAmos KongDo strict boot via @option{strict=on} as far as firmware/BIOS 209c8a6ae8bSAmos Kongsupports it. This only effects when boot priority is changed by 210c8a6ae8bSAmos Kongbootindex options. The default is non-strict boot. 211c8a6ae8bSAmos Kong 21210adb8beSMarkus Armbruster@example 21310adb8beSMarkus Armbruster# try to boot from network first, then from hard disk 21410adb8beSMarkus Armbrusterqemu-system-i386 -boot order=nc 21510adb8beSMarkus Armbruster# boot from CD-ROM first, switch back to default order after reboot 21610adb8beSMarkus Armbrusterqemu-system-i386 -boot once=d 21710adb8beSMarkus Armbruster# boot with a splash picture for 5 seconds. 21810adb8beSMarkus Armbrusterqemu-system-i386 -boot menu=on,splash=/root/boot.bmp,splash-time=5000 21910adb8beSMarkus Armbruster@end example 22010adb8beSMarkus Armbruster 22110adb8beSMarkus ArmbrusterNote: The legacy format '-boot @var{drives}' is still supported but its 22210adb8beSMarkus Armbrusteruse is discouraged as it may be removed from future versions. 22310adb8beSMarkus ArmbrusterETEXI 22410adb8beSMarkus Armbruster 22510adb8beSMarkus ArmbrusterDEF("m", HAS_ARG, QEMU_OPTION_m, 226c270fb9eSIgor Mammedov "-m[emory] [size=]megs[,slots=n,maxmem=size]\n" 2276e1d3c1cSIgor Mammedov " configure guest RAM\n" 2286e1d3c1cSIgor Mammedov " size: initial amount of guest memory (default: " 229c270fb9eSIgor Mammedov stringify(DEFAULT_RAM_SIZE) "MiB)\n" 230c270fb9eSIgor Mammedov " slots: number of hotplug slots (default: none)\n" 231b6fe0124SMatthew Rosato " maxmem: maximum amount of guest memory (default: none)\n" 232b6fe0124SMatthew Rosato "NOTE: Some architectures might enforce a specific granularity\n", 2336e1d3c1cSIgor Mammedov QEMU_ARCH_ALL) 23410adb8beSMarkus ArmbrusterSTEXI 2356e1d3c1cSIgor Mammedov@item -m [size=]@var{megs} 23610adb8beSMarkus Armbruster@findex -m 23710adb8beSMarkus ArmbrusterSet virtual RAM size to @var{megs} megabytes. Default is 128 MiB. Optionally, 23810adb8beSMarkus Armbrustera suffix of ``M'' or ``G'' can be used to signify a value in megabytes or 239c270fb9eSIgor Mammedovgigabytes respectively. Optional pair @var{slots}, @var{maxmem} could be used 240c270fb9eSIgor Mammedovto set amount of hotluggable memory slots and possible maximum amount of memory. 24110adb8beSMarkus ArmbrusterETEXI 24210adb8beSMarkus Armbruster 24310adb8beSMarkus ArmbrusterDEF("mem-path", HAS_ARG, QEMU_OPTION_mempath, 24410adb8beSMarkus Armbruster "-mem-path FILE provide backing storage for guest RAM\n", QEMU_ARCH_ALL) 24510adb8beSMarkus ArmbrusterSTEXI 24610adb8beSMarkus Armbruster@item -mem-path @var{path} 24710adb8beSMarkus Armbruster@findex -mem-path 24810adb8beSMarkus ArmbrusterAllocate guest RAM from a temporarily created file in @var{path}. 24910adb8beSMarkus ArmbrusterETEXI 25010adb8beSMarkus Armbruster 25110adb8beSMarkus ArmbrusterDEF("mem-prealloc", 0, QEMU_OPTION_mem_prealloc, 25210adb8beSMarkus Armbruster "-mem-prealloc preallocate guest memory (use with -mem-path)\n", 25310adb8beSMarkus Armbruster QEMU_ARCH_ALL) 25410adb8beSMarkus ArmbrusterSTEXI 25510adb8beSMarkus Armbruster@item -mem-prealloc 25610adb8beSMarkus Armbruster@findex -mem-prealloc 25710adb8beSMarkus ArmbrusterPreallocate memory when using -mem-path. 25810adb8beSMarkus ArmbrusterETEXI 25910adb8beSMarkus Armbruster 26010adb8beSMarkus ArmbrusterDEF("k", HAS_ARG, QEMU_OPTION_k, 26110adb8beSMarkus Armbruster "-k language use keyboard layout (for example 'fr' for French)\n", 26210adb8beSMarkus Armbruster QEMU_ARCH_ALL) 26310adb8beSMarkus ArmbrusterSTEXI 26410adb8beSMarkus Armbruster@item -k @var{language} 26510adb8beSMarkus Armbruster@findex -k 26610adb8beSMarkus ArmbrusterUse keyboard layout @var{language} (for example @code{fr} for 26710adb8beSMarkus ArmbrusterFrench). This option is only needed where it is not easy to get raw PC 26810adb8beSMarkus Armbrusterkeycodes (e.g. on Macs, with some X11 servers or with a VNC 26910adb8beSMarkus Armbrusterdisplay). You don't normally need to use it on PC/Linux or PC/Windows 27010adb8beSMarkus Armbrusterhosts. 27110adb8beSMarkus Armbruster 27210adb8beSMarkus ArmbrusterThe available layouts are: 27310adb8beSMarkus Armbruster@example 27410adb8beSMarkus Armbrusterar de-ch es fo fr-ca hu ja mk no pt-br sv 27510adb8beSMarkus Armbrusterda en-gb et fr fr-ch is lt nl pl ru th 27610adb8beSMarkus Armbrusterde en-us fi fr-be hr it lv nl-be pt sl tr 27710adb8beSMarkus Armbruster@end example 27810adb8beSMarkus Armbruster 27910adb8beSMarkus ArmbrusterThe default is @code{en-us}. 28010adb8beSMarkus ArmbrusterETEXI 28110adb8beSMarkus Armbruster 28210adb8beSMarkus Armbruster 28310adb8beSMarkus ArmbrusterDEF("audio-help", 0, QEMU_OPTION_audio_help, 28410adb8beSMarkus Armbruster "-audio-help print list of audio drivers and their options\n", 28510adb8beSMarkus Armbruster QEMU_ARCH_ALL) 28610adb8beSMarkus ArmbrusterSTEXI 28710adb8beSMarkus Armbruster@item -audio-help 28810adb8beSMarkus Armbruster@findex -audio-help 28910adb8beSMarkus ArmbrusterWill show the audio subsystem help: list of drivers, tunable 29010adb8beSMarkus Armbrusterparameters. 29110adb8beSMarkus ArmbrusterETEXI 29210adb8beSMarkus Armbruster 29310adb8beSMarkus ArmbrusterDEF("soundhw", HAS_ARG, QEMU_OPTION_soundhw, 29410adb8beSMarkus Armbruster "-soundhw c1,... enable audio support\n" 29510adb8beSMarkus Armbruster " and only specified sound cards (comma separated list)\n" 29610adb8beSMarkus Armbruster " use '-soundhw help' to get the list of supported cards\n" 29710adb8beSMarkus Armbruster " use '-soundhw all' to enable all of them\n", QEMU_ARCH_ALL) 29810adb8beSMarkus ArmbrusterSTEXI 29910adb8beSMarkus Armbruster@item -soundhw @var{card1}[,@var{card2},...] or -soundhw all 30010adb8beSMarkus Armbruster@findex -soundhw 30110adb8beSMarkus ArmbrusterEnable audio and selected sound hardware. Use 'help' to print all 30210adb8beSMarkus Armbrusteravailable sound hardware. 30310adb8beSMarkus Armbruster 30410adb8beSMarkus Armbruster@example 30510adb8beSMarkus Armbrusterqemu-system-i386 -soundhw sb16,adlib disk.img 30610adb8beSMarkus Armbrusterqemu-system-i386 -soundhw es1370 disk.img 30710adb8beSMarkus Armbrusterqemu-system-i386 -soundhw ac97 disk.img 30810adb8beSMarkus Armbrusterqemu-system-i386 -soundhw hda disk.img 30910adb8beSMarkus Armbrusterqemu-system-i386 -soundhw all disk.img 31010adb8beSMarkus Armbrusterqemu-system-i386 -soundhw help 31110adb8beSMarkus Armbruster@end example 31210adb8beSMarkus Armbruster 31310adb8beSMarkus ArmbrusterNote that Linux's i810_audio OSS kernel (for AC97) module might 31410adb8beSMarkus Armbrusterrequire manually specifying clocking. 31510adb8beSMarkus Armbruster 31610adb8beSMarkus Armbruster@example 31710adb8beSMarkus Armbrustermodprobe i810_audio clocking=48000 31810adb8beSMarkus Armbruster@end example 31910adb8beSMarkus ArmbrusterETEXI 32010adb8beSMarkus Armbruster 32110adb8beSMarkus ArmbrusterDEF("balloon", HAS_ARG, QEMU_OPTION_balloon, 32210adb8beSMarkus Armbruster "-balloon none disable balloon device\n" 32310adb8beSMarkus Armbruster "-balloon virtio[,addr=str]\n" 32410adb8beSMarkus Armbruster " enable virtio balloon device (default)\n", QEMU_ARCH_ALL) 32510adb8beSMarkus ArmbrusterSTEXI 32610adb8beSMarkus Armbruster@item -balloon none 32710adb8beSMarkus Armbruster@findex -balloon 32810adb8beSMarkus ArmbrusterDisable balloon device. 32910adb8beSMarkus Armbruster@item -balloon virtio[,addr=@var{addr}] 33010adb8beSMarkus ArmbrusterEnable virtio balloon device (default), optionally with PCI address 33110adb8beSMarkus Armbruster@var{addr}. 33210adb8beSMarkus ArmbrusterETEXI 33310adb8beSMarkus Armbruster 33410adb8beSMarkus ArmbrusterDEF("device", HAS_ARG, QEMU_OPTION_device, 33510adb8beSMarkus Armbruster "-device driver[,prop[=value][,...]]\n" 33610adb8beSMarkus Armbruster " add device (based on driver)\n" 33710adb8beSMarkus Armbruster " prop=value,... sets driver properties\n" 33810adb8beSMarkus Armbruster " use '-device help' to print all possible drivers\n" 33910adb8beSMarkus Armbruster " use '-device driver,help' to print all possible properties\n", 34010adb8beSMarkus Armbruster QEMU_ARCH_ALL) 34110adb8beSMarkus ArmbrusterSTEXI 34210adb8beSMarkus Armbruster@item -device @var{driver}[,@var{prop}[=@var{value}][,...]] 34310adb8beSMarkus Armbruster@findex -device 34410adb8beSMarkus ArmbrusterAdd device @var{driver}. @var{prop}=@var{value} sets driver 34510adb8beSMarkus Armbrusterproperties. Valid properties depend on the driver. To get help on 34610adb8beSMarkus Armbrusterpossible drivers and properties, use @code{-device help} and 34710adb8beSMarkus Armbruster@code{-device @var{driver},help}. 34810adb8beSMarkus ArmbrusterETEXI 34910adb8beSMarkus Armbruster 35010adb8beSMarkus ArmbrusterDEF("name", HAS_ARG, QEMU_OPTION_name, 3518f480de0SDr. David Alan Gilbert "-name string1[,process=string2][,debug-threads=on|off]\n" 35210adb8beSMarkus Armbruster " set the name of the guest\n" 3538f480de0SDr. David Alan Gilbert " string1 sets the window title and string2 the process name (on Linux)\n" 3548f480de0SDr. David Alan Gilbert " When debug-threads is enabled, individual threads are given a separate name (on Linux)\n" 3558f480de0SDr. David Alan Gilbert " NOTE: The thread names are for debugging and not a stable API.\n", 35610adb8beSMarkus Armbruster QEMU_ARCH_ALL) 35710adb8beSMarkus ArmbrusterSTEXI 35810adb8beSMarkus Armbruster@item -name @var{name} 35910adb8beSMarkus Armbruster@findex -name 36010adb8beSMarkus ArmbrusterSets the @var{name} of the guest. 36110adb8beSMarkus ArmbrusterThis name will be displayed in the SDL window caption. 36210adb8beSMarkus ArmbrusterThe @var{name} will also be used for the VNC server. 36310adb8beSMarkus ArmbrusterAlso optionally set the top visible process name in Linux. 3648f480de0SDr. David Alan GilbertNaming of individual threads can also be enabled on Linux to aid debugging. 36510adb8beSMarkus ArmbrusterETEXI 36610adb8beSMarkus Armbruster 36710adb8beSMarkus ArmbrusterDEF("uuid", HAS_ARG, QEMU_OPTION_uuid, 36810adb8beSMarkus Armbruster "-uuid %08x-%04x-%04x-%04x-%012x\n" 36910adb8beSMarkus Armbruster " specify machine UUID\n", QEMU_ARCH_ALL) 37010adb8beSMarkus ArmbrusterSTEXI 37110adb8beSMarkus Armbruster@item -uuid @var{uuid} 37210adb8beSMarkus Armbruster@findex -uuid 37310adb8beSMarkus ArmbrusterSet system UUID. 37410adb8beSMarkus ArmbrusterETEXI 37510adb8beSMarkus Armbruster 37610adb8beSMarkus ArmbrusterSTEXI 37710adb8beSMarkus Armbruster@end table 37810adb8beSMarkus ArmbrusterETEXI 37910adb8beSMarkus ArmbrusterDEFHEADING() 38010adb8beSMarkus Armbruster 38110adb8beSMarkus ArmbrusterDEFHEADING(Block device options:) 38210adb8beSMarkus ArmbrusterSTEXI 38310adb8beSMarkus Armbruster@table @option 38410adb8beSMarkus ArmbrusterETEXI 38510adb8beSMarkus Armbruster 3865824d651Sblueswir1DEF("fda", HAS_ARG, QEMU_OPTION_fda, 387ad96090aSBlue Swirl "-fda/-fdb file use 'file' as floppy disk 0/1 image\n", QEMU_ARCH_ALL) 388ad96090aSBlue SwirlDEF("fdb", HAS_ARG, QEMU_OPTION_fdb, "", QEMU_ARCH_ALL) 3895824d651Sblueswir1STEXI 3905824d651Sblueswir1@item -fda @var{file} 3915824d651Sblueswir1@item -fdb @var{file} 3926616b2adSStefan Weil@findex -fda 3936616b2adSStefan Weil@findex -fdb 3945824d651Sblueswir1Use @var{file} as floppy disk 0/1 image (@pxref{disk_images}). You can 3955824d651Sblueswir1use the host floppy by using @file{/dev/fd0} as filename (@pxref{host_drives}). 3965824d651Sblueswir1ETEXI 3975824d651Sblueswir1 3985824d651Sblueswir1DEF("hda", HAS_ARG, QEMU_OPTION_hda, 399ad96090aSBlue Swirl "-hda/-hdb file use 'file' as IDE hard disk 0/1 image\n", QEMU_ARCH_ALL) 400ad96090aSBlue SwirlDEF("hdb", HAS_ARG, QEMU_OPTION_hdb, "", QEMU_ARCH_ALL) 4015824d651Sblueswir1DEF("hdc", HAS_ARG, QEMU_OPTION_hdc, 402ad96090aSBlue Swirl "-hdc/-hdd file use 'file' as IDE hard disk 2/3 image\n", QEMU_ARCH_ALL) 403ad96090aSBlue SwirlDEF("hdd", HAS_ARG, QEMU_OPTION_hdd, "", QEMU_ARCH_ALL) 4045824d651Sblueswir1STEXI 4055824d651Sblueswir1@item -hda @var{file} 4065824d651Sblueswir1@item -hdb @var{file} 4075824d651Sblueswir1@item -hdc @var{file} 4085824d651Sblueswir1@item -hdd @var{file} 4096616b2adSStefan Weil@findex -hda 4106616b2adSStefan Weil@findex -hdb 4116616b2adSStefan Weil@findex -hdc 4126616b2adSStefan Weil@findex -hdd 4135824d651Sblueswir1Use @var{file} as hard disk 0, 1, 2 or 3 image (@pxref{disk_images}). 4145824d651Sblueswir1ETEXI 4155824d651Sblueswir1 4165824d651Sblueswir1DEF("cdrom", HAS_ARG, QEMU_OPTION_cdrom, 417ad96090aSBlue Swirl "-cdrom file use 'file' as IDE cdrom image (cdrom is ide1 master)\n", 418ad96090aSBlue Swirl QEMU_ARCH_ALL) 4195824d651Sblueswir1STEXI 4205824d651Sblueswir1@item -cdrom @var{file} 4216616b2adSStefan Weil@findex -cdrom 4225824d651Sblueswir1Use @var{file} as CD-ROM image (you cannot use @option{-hdc} and 4235824d651Sblueswir1@option{-cdrom} at the same time). You can use the host CD-ROM by 4245824d651Sblueswir1using @file{/dev/cdrom} as filename (@pxref{host_drives}). 4255824d651Sblueswir1ETEXI 4265824d651Sblueswir1 4275824d651Sblueswir1DEF("drive", HAS_ARG, QEMU_OPTION_drive, 4285824d651Sblueswir1 "-drive [file=file][,if=type][,bus=n][,unit=m][,media=d][,index=i]\n" 4295824d651Sblueswir1 " [,cyls=c,heads=h,secs=s[,trans=t]][,snapshot=on|off]\n" 43092196b2fSStefan Hajnoczi " [,cache=writethrough|writeback|none|directsync|unsafe][,format=f]\n" 431d1db760dSStefan Hajnoczi " [,serial=s][,addr=A][,rerror=ignore|stop|report]\n" 432d1db760dSStefan Hajnoczi " [,werror=ignore|stop|report|enospc][,id=name][,aio=threads|native]\n" 433fb0490f6SStefan Hajnoczi " [,readonly=on|off][,copy-on-read=on|off]\n" 4342f7133b2SPeter Lieven " [,discard=ignore|unmap][,detect-zeroes=on|off|unmap]\n" 4353e9fab69SBenoît Canet " [[,bps=b]|[[,bps_rd=r][,bps_wr=w]]]\n" 4363e9fab69SBenoît Canet " [[,iops=i]|[[,iops_rd=r][,iops_wr=w]]]\n" 4373e9fab69SBenoît Canet " [[,bps_max=bm]|[[,bps_rd_max=rm][,bps_wr_max=wm]]]\n" 4383e9fab69SBenoît Canet " [[,iops_max=im]|[[,iops_rd_max=irm][,iops_wr_max=iwm]]]\n" 4392024c1dfSBenoît Canet " [[,iops_size=is]]\n" 440ad96090aSBlue Swirl " use 'file' as a drive image\n", QEMU_ARCH_ALL) 4415824d651Sblueswir1STEXI 4425824d651Sblueswir1@item -drive @var{option}[,@var{option}[,@var{option}[,...]]] 4436616b2adSStefan Weil@findex -drive 4445824d651Sblueswir1 4455824d651Sblueswir1Define a new drive. Valid options are: 4465824d651Sblueswir1 447b3f046c2SKevin Wolf@table @option 4485824d651Sblueswir1@item file=@var{file} 4495824d651Sblueswir1This option defines which disk image (@pxref{disk_images}) to use with 4505824d651Sblueswir1this drive. If the filename contains comma, you must double it 4515824d651Sblueswir1(for instance, "file=my,,file" to use file "my,file"). 4520f5314a2SRonnie Sahlberg 4530f5314a2SRonnie SahlbergSpecial files such as iSCSI devices can be specified using protocol 4540f5314a2SRonnie Sahlbergspecific URLs. See the section for "Device URL Syntax" for more information. 4555824d651Sblueswir1@item if=@var{interface} 4565824d651Sblueswir1This option defines on which type on interface the drive is connected. 4575824d651Sblueswir1Available types are: ide, scsi, sd, mtd, floppy, pflash, virtio. 4585824d651Sblueswir1@item bus=@var{bus},unit=@var{unit} 4595824d651Sblueswir1These options define where is connected the drive by defining the bus number and 4605824d651Sblueswir1the unit id. 4615824d651Sblueswir1@item index=@var{index} 4625824d651Sblueswir1This option defines where is connected the drive by using an index in the list 4635824d651Sblueswir1of available connectors of a given interface type. 4645824d651Sblueswir1@item media=@var{media} 4655824d651Sblueswir1This option defines the type of the media: disk or cdrom. 4665824d651Sblueswir1@item cyls=@var{c},heads=@var{h},secs=@var{s}[,trans=@var{t}] 4675824d651Sblueswir1These options have the same definition as they have in @option{-hdachs}. 4685824d651Sblueswir1@item snapshot=@var{snapshot} 4699d85d557SMichael Tokarev@var{snapshot} is "on" or "off" and controls snapshot mode for the given drive 4709d85d557SMichael Tokarev(see @option{-snapshot}). 4715824d651Sblueswir1@item cache=@var{cache} 47292196b2fSStefan Hajnoczi@var{cache} is "none", "writeback", "unsafe", "directsync" or "writethrough" and controls how the host cache is used to access block data. 4735c6c3a6cSChristoph Hellwig@item aio=@var{aio} 4745c6c3a6cSChristoph Hellwig@var{aio} is "threads", or "native" and selects between pthread based disk I/O and native Linux AIO. 475a9384affSPaolo Bonzini@item discard=@var{discard} 476a9384affSPaolo 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. 4775824d651Sblueswir1@item format=@var{format} 4785824d651Sblueswir1Specify which disk @var{format} will be used rather than detecting 4795824d651Sblueswir1the format. Can be used to specifiy format=raw to avoid interpreting 4805824d651Sblueswir1an untrusted format header. 4815824d651Sblueswir1@item serial=@var{serial} 4825824d651Sblueswir1This option specifies the serial number to assign to the device. 483c2cc47a4SMarkus Armbruster@item addr=@var{addr} 484c2cc47a4SMarkus ArmbrusterSpecify the controller's PCI address (if=virtio only). 485ae73e591SLuiz Capitulino@item werror=@var{action},rerror=@var{action} 486ae73e591SLuiz CapitulinoSpecify which @var{action} to take on write and read errors. Valid actions are: 487ae73e591SLuiz Capitulino"ignore" (ignore the error and try to continue), "stop" (pause QEMU), 488ae73e591SLuiz Capitulino"report" (report the error to the guest), "enospc" (pause QEMU only if the 489ae73e591SLuiz Capitulinohost disk is full; report the error to the guest otherwise). 490ae73e591SLuiz CapitulinoThe default setting is @option{werror=enospc} and @option{rerror=report}. 491ae73e591SLuiz Capitulino@item readonly 492ae73e591SLuiz CapitulinoOpen drive @option{file} as read-only. Guest write attempts will fail. 493fb0490f6SStefan Hajnoczi@item copy-on-read=@var{copy-on-read} 494fb0490f6SStefan Hajnoczi@var{copy-on-read} is "on" or "off" and enables whether to copy read backing 495fb0490f6SStefan Hajnoczifile sectors into the image file. 496465bee1dSPeter Lieven@item detect-zeroes=@var{detect-zeroes} 497465bee1dSPeter Lieven@var{detect-zeroes} is "off", "on" or "unmap" and enables the automatic 498465bee1dSPeter Lievenconversion of plain zero writes by the OS to driver specific optimized 499465bee1dSPeter Lievenzero write commands. You may even choose "unmap" if @var{discard} is set 500465bee1dSPeter Lievento "unmap" to allow a zero write to be converted to an UNMAP operation. 5015824d651Sblueswir1@end table 5025824d651Sblueswir1 503a13e5e05SKevin WolfBy default, the @option{cache=writeback} mode is used. It will report data 504a13e5e05SKevin Wolfwrites as completed as soon as the data is present in the host page cache. 505a13e5e05SKevin WolfThis is safe as long as your guest OS makes sure to correctly flush disk caches 506a13e5e05SKevin Wolfwhere needed. If your guest OS does not handle volatile disk write caches 507a13e5e05SKevin Wolfcorrectly and your host crashes or loses power, then the guest may experience 508a13e5e05SKevin Wolfdata corruption. 5095824d651Sblueswir1 510a13e5e05SKevin WolfFor such guests, you should consider using @option{cache=writethrough}. This 511a13e5e05SKevin Wolfmeans that the host page cache will be used to read and write data, but write 512a13e5e05SKevin Wolfnotification will be sent to the guest only after QEMU has made sure to flush 513a13e5e05SKevin Wolfeach write to the disk. Be aware that this has a major impact on performance. 5145824d651Sblueswir1 515c304d317SAurelien JarnoThe host page cache can be avoided entirely with @option{cache=none}. This will 516a13e5e05SKevin Wolfattempt to do disk IO directly to the guest's memory. QEMU may still perform 517a13e5e05SKevin Wolfan internal copy of the data. Note that this is considered a writeback mode and 518a13e5e05SKevin Wolfthe guest OS must handle the disk write cache correctly in order to avoid data 519a13e5e05SKevin Wolfcorruption on host crashes. 5205824d651Sblueswir1 52192196b2fSStefan HajnocziThe host page cache can be avoided while only sending write notifications to 522a13e5e05SKevin Wolfthe guest when the data has been flushed to the disk using 523a13e5e05SKevin Wolf@option{cache=directsync}. 5245824d651Sblueswir1 525016f5cf6SAlexander GrafIn case you don't care about data integrity over host failures, use 526a13e5e05SKevin Wolf@option{cache=unsafe}. This option tells QEMU that it never needs to write any 527a13e5e05SKevin Wolfdata to the disk but can instead keep things in cache. If anything goes wrong, 528e7d81004SStefan Weillike your host losing power, the disk storage getting disconnected accidentally, 529a13e5e05SKevin Wolfetc. your image will most probably be rendered unusable. When using 530c3177288SAlexander Grafthe @option{-snapshot} option, unsafe caching is always used. 531016f5cf6SAlexander Graf 532fb0490f6SStefan HajnocziCopy-on-read avoids accessing the same backing file sectors repeatedly and is 533fb0490f6SStefan Hajnocziuseful when the backing file is over a slow network. By default copy-on-read 534fb0490f6SStefan Hajnocziis off. 535fb0490f6SStefan Hajnoczi 5365824d651Sblueswir1Instead of @option{-cdrom} you can use: 5375824d651Sblueswir1@example 5383804da9dSStefan Weilqemu-system-i386 -drive file=file,index=2,media=cdrom 5395824d651Sblueswir1@end example 5405824d651Sblueswir1 5415824d651Sblueswir1Instead of @option{-hda}, @option{-hdb}, @option{-hdc}, @option{-hdd}, you can 5425824d651Sblueswir1use: 5435824d651Sblueswir1@example 5443804da9dSStefan Weilqemu-system-i386 -drive file=file,index=0,media=disk 5453804da9dSStefan Weilqemu-system-i386 -drive file=file,index=1,media=disk 5463804da9dSStefan Weilqemu-system-i386 -drive file=file,index=2,media=disk 5473804da9dSStefan Weilqemu-system-i386 -drive file=file,index=3,media=disk 5485824d651Sblueswir1@end example 5495824d651Sblueswir1 550587ed6beSCorey BryantYou can open an image using pre-opened file descriptors from an fd set: 551587ed6beSCorey Bryant@example 552587ed6beSCorey Bryantqemu-system-i386 553587ed6beSCorey Bryant-add-fd fd=3,set=2,opaque="rdwr:/path/to/file" 554587ed6beSCorey Bryant-add-fd fd=4,set=2,opaque="rdonly:/path/to/file" 555587ed6beSCorey Bryant-drive file=/dev/fdset/2,index=0,media=disk 556587ed6beSCorey Bryant@end example 557587ed6beSCorey Bryant 5585824d651Sblueswir1You can connect a CDROM to the slave of ide0: 5595824d651Sblueswir1@example 5603804da9dSStefan Weilqemu-system-i386 -drive file=file,if=ide,index=1,media=cdrom 5615824d651Sblueswir1@end example 5625824d651Sblueswir1 5635824d651Sblueswir1If you don't specify the "file=" argument, you define an empty drive: 5645824d651Sblueswir1@example 5653804da9dSStefan Weilqemu-system-i386 -drive if=ide,index=1,media=cdrom 5665824d651Sblueswir1@end example 5675824d651Sblueswir1 5685824d651Sblueswir1You can connect a SCSI disk with unit ID 6 on the bus #0: 5695824d651Sblueswir1@example 5703804da9dSStefan Weilqemu-system-i386 -drive file=file,if=scsi,bus=0,unit=6 5715824d651Sblueswir1@end example 5725824d651Sblueswir1 5735824d651Sblueswir1Instead of @option{-fda}, @option{-fdb}, you can use: 5745824d651Sblueswir1@example 5753804da9dSStefan Weilqemu-system-i386 -drive file=file,index=0,if=floppy 5763804da9dSStefan Weilqemu-system-i386 -drive file=file,index=1,if=floppy 5775824d651Sblueswir1@end example 5785824d651Sblueswir1 5795824d651Sblueswir1By default, @var{interface} is "ide" and @var{index} is automatically 5805824d651Sblueswir1incremented: 5815824d651Sblueswir1@example 5823804da9dSStefan Weilqemu-system-i386 -drive file=a -drive file=b" 5835824d651Sblueswir1@end example 5845824d651Sblueswir1is interpreted like: 5855824d651Sblueswir1@example 5863804da9dSStefan Weilqemu-system-i386 -hda a -hdb b 5875824d651Sblueswir1@end example 5885824d651Sblueswir1ETEXI 5895824d651Sblueswir1 5905824d651Sblueswir1DEF("mtdblock", HAS_ARG, QEMU_OPTION_mtdblock, 591ad96090aSBlue Swirl "-mtdblock file use 'file' as on-board Flash memory image\n", 592ad96090aSBlue Swirl QEMU_ARCH_ALL) 5935824d651Sblueswir1STEXI 5944e257e5eSKevin Wolf@item -mtdblock @var{file} 5956616b2adSStefan Weil@findex -mtdblock 5964e257e5eSKevin WolfUse @var{file} as on-board Flash memory image. 5975824d651Sblueswir1ETEXI 5985824d651Sblueswir1 5995824d651Sblueswir1DEF("sd", HAS_ARG, QEMU_OPTION_sd, 600ad96090aSBlue Swirl "-sd file use 'file' as SecureDigital card image\n", QEMU_ARCH_ALL) 6015824d651Sblueswir1STEXI 6024e257e5eSKevin Wolf@item -sd @var{file} 6036616b2adSStefan Weil@findex -sd 6044e257e5eSKevin WolfUse @var{file} as SecureDigital card image. 6055824d651Sblueswir1ETEXI 6065824d651Sblueswir1 6075824d651Sblueswir1DEF("pflash", HAS_ARG, QEMU_OPTION_pflash, 608ad96090aSBlue Swirl "-pflash file use 'file' as a parallel flash image\n", QEMU_ARCH_ALL) 6095824d651Sblueswir1STEXI 6104e257e5eSKevin Wolf@item -pflash @var{file} 6116616b2adSStefan Weil@findex -pflash 6124e257e5eSKevin WolfUse @var{file} as a parallel flash image. 6135824d651Sblueswir1ETEXI 6145824d651Sblueswir1 6155824d651Sblueswir1DEF("snapshot", 0, QEMU_OPTION_snapshot, 616ad96090aSBlue Swirl "-snapshot write to temporary files instead of disk image files\n", 617ad96090aSBlue Swirl QEMU_ARCH_ALL) 6185824d651Sblueswir1STEXI 6195824d651Sblueswir1@item -snapshot 6206616b2adSStefan Weil@findex -snapshot 6215824d651Sblueswir1Write to temporary files instead of disk image files. In this case, 6225824d651Sblueswir1the raw disk image you use is not written back. You can however force 6235824d651Sblueswir1the write back by pressing @key{C-a s} (@pxref{disk_images}). 6245824d651Sblueswir1ETEXI 6255824d651Sblueswir1 62610adb8beSMarkus ArmbrusterDEF("hdachs", HAS_ARG, QEMU_OPTION_hdachs, \ 62710adb8beSMarkus Armbruster "-hdachs c,h,s[,t]\n" \ 62810adb8beSMarkus Armbruster " force hard disk 0 physical geometry and the optional BIOS\n" \ 62910adb8beSMarkus Armbruster " translation (t=none or lba) (usually QEMU can guess them)\n", 630ad96090aSBlue Swirl QEMU_ARCH_ALL) 631c902760fSMarcelo TosattiSTEXI 63210adb8beSMarkus Armbruster@item -hdachs @var{c},@var{h},@var{s},[,@var{t}] 63310adb8beSMarkus Armbruster@findex -hdachs 63410adb8beSMarkus ArmbrusterForce hard disk 0 physical geometry (1 <= @var{c} <= 16383, 1 <= 63510adb8beSMarkus Armbruster@var{h} <= 16, 1 <= @var{s} <= 63) and optionally force the BIOS 63610adb8beSMarkus Armbrustertranslation mode (@var{t}=none, lba or auto). Usually QEMU can guess 63710adb8beSMarkus Armbrusterall those parameters. This option is useful for old MS-DOS disk 63810adb8beSMarkus Armbrusterimages. 639c70a01e4SMarkus ArmbrusterETEXI 64074db920cSGautham R Shenoy 64174db920cSGautham R ShenoyDEF("fsdev", HAS_ARG, QEMU_OPTION_fsdev, 6422c30dd74SAneesh Kumar K.V "-fsdev fsdriver,id=id[,path=path,][security_model={mapped-xattr|mapped-file|passthrough|none}]\n" 64384a87cc4SM. Mohan Kumar " [,writeout=immediate][,readonly][,socket=socket|sock_fd=sock_fd]\n", 64474db920cSGautham R Shenoy QEMU_ARCH_ALL) 64574db920cSGautham R Shenoy 64674db920cSGautham R ShenoySTEXI 64774db920cSGautham R Shenoy 64884a87cc4SM. 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}] 64974db920cSGautham R Shenoy@findex -fsdev 6507c92a3d2SAneesh Kumar K.VDefine a new file system device. Valid options are: 6517c92a3d2SAneesh Kumar K.V@table @option 6527c92a3d2SAneesh Kumar K.V@item @var{fsdriver} 6537c92a3d2SAneesh Kumar K.VThis option specifies the fs driver backend to use. 654f67e3ffdSM. Mohan KumarCurrently "local", "handle" and "proxy" file system drivers are supported. 6557c92a3d2SAneesh Kumar K.V@item id=@var{id} 6567c92a3d2SAneesh Kumar K.VSpecifies identifier for this device 6577c92a3d2SAneesh Kumar K.V@item path=@var{path} 6587c92a3d2SAneesh Kumar K.VSpecifies the export path for the file system device. Files under 6597c92a3d2SAneesh Kumar K.Vthis path will be available to the 9p client on the guest. 6607c92a3d2SAneesh Kumar K.V@item security_model=@var{security_model} 6617c92a3d2SAneesh Kumar K.VSpecifies the security model to be used for this export path. 6622c30dd74SAneesh Kumar K.VSupported security models are "passthrough", "mapped-xattr", "mapped-file" and "none". 6637c92a3d2SAneesh Kumar K.VIn "passthrough" security model, files are stored using the same 664b65ee4faSStefan Weilcredentials as they are created on the guest. This requires QEMU 6652c30dd74SAneesh Kumar K.Vto run as root. In "mapped-xattr" security model, some of the file 6667c92a3d2SAneesh Kumar K.Vattributes like uid, gid, mode bits and link target are stored as 6672c30dd74SAneesh Kumar K.Vfile attributes. For "mapped-file" these attributes are stored in the 6682c30dd74SAneesh Kumar K.Vhidden .virtfs_metadata directory. Directories exported by this security model cannot 6697c92a3d2SAneesh Kumar K.Vinteract with other unix tools. "none" security model is same as 6707c92a3d2SAneesh Kumar K.Vpassthrough except the sever won't report failures if it fails to 671d9b36a6eSM. Mohan Kumarset file attributes like ownership. Security model is mandatory 672f67e3ffdSM. Mohan Kumaronly for local fsdriver. Other fsdrivers (like handle, proxy) don't take 673d9b36a6eSM. Mohan Kumarsecurity model as a parameter. 6747c92a3d2SAneesh Kumar K.V@item writeout=@var{writeout} 6757c92a3d2SAneesh Kumar K.VThis is an optional argument. The only supported value is "immediate". 6767c92a3d2SAneesh Kumar K.VThis means that host page cache will be used to read and write data but 6777c92a3d2SAneesh Kumar K.Vwrite notification will be sent to the guest only when the data has been 6787c92a3d2SAneesh Kumar K.Vreported as written by the storage subsystem. 6792c74c2cbSM. Mohan Kumar@item readonly 6802c74c2cbSM. Mohan KumarEnables exporting 9p share as a readonly mount for guests. By default 6812c74c2cbSM. Mohan Kumarread-write access is given. 68284a87cc4SM. Mohan Kumar@item socket=@var{socket} 68384a87cc4SM. Mohan KumarEnables proxy filesystem driver to use passed socket file for communicating 68484a87cc4SM. Mohan Kumarwith virtfs-proxy-helper 685f67e3ffdSM. Mohan Kumar@item sock_fd=@var{sock_fd} 686f67e3ffdSM. Mohan KumarEnables proxy filesystem driver to use passed socket descriptor for 687f67e3ffdSM. Mohan Kumarcommunicating with virtfs-proxy-helper. Usually a helper like libvirt 688f67e3ffdSM. Mohan Kumarwill create socketpair and pass one of the fds as sock_fd 68974db920cSGautham R Shenoy@end table 6907c92a3d2SAneesh Kumar K.V 6917c92a3d2SAneesh Kumar K.V-fsdev option is used along with -device driver "virtio-9p-pci". 6927c92a3d2SAneesh Kumar K.V@item -device virtio-9p-pci,fsdev=@var{id},mount_tag=@var{mount_tag} 6937c92a3d2SAneesh Kumar K.VOptions for virtio-9p-pci driver are: 6947c92a3d2SAneesh Kumar K.V@table @option 6957c92a3d2SAneesh Kumar K.V@item fsdev=@var{id} 6967c92a3d2SAneesh Kumar K.VSpecifies the id value specified along with -fsdev option 6977c92a3d2SAneesh Kumar K.V@item mount_tag=@var{mount_tag} 6987c92a3d2SAneesh Kumar K.VSpecifies the tag name to be used by the guest to mount this export point 6997c92a3d2SAneesh Kumar K.V@end table 7007c92a3d2SAneesh Kumar K.V 70174db920cSGautham R ShenoyETEXI 70274db920cSGautham R Shenoy 7033d54abc7SGautham R ShenoyDEF("virtfs", HAS_ARG, QEMU_OPTION_virtfs, 7042c30dd74SAneesh Kumar K.V "-virtfs local,path=path,mount_tag=tag,security_model=[mapped-xattr|mapped-file|passthrough|none]\n" 70584a87cc4SM. Mohan Kumar " [,writeout=immediate][,readonly][,socket=socket|sock_fd=sock_fd]\n", 7063d54abc7SGautham R Shenoy QEMU_ARCH_ALL) 7073d54abc7SGautham R Shenoy 7083d54abc7SGautham R ShenoySTEXI 7093d54abc7SGautham R Shenoy 71084a87cc4SM. 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}] 7113d54abc7SGautham R Shenoy@findex -virtfs 7123d54abc7SGautham R Shenoy 7137c92a3d2SAneesh Kumar K.VThe general form of a Virtual File system pass-through options are: 7147c92a3d2SAneesh Kumar K.V@table @option 7157c92a3d2SAneesh Kumar K.V@item @var{fsdriver} 7167c92a3d2SAneesh Kumar K.VThis option specifies the fs driver backend to use. 717f67e3ffdSM. Mohan KumarCurrently "local", "handle" and "proxy" file system drivers are supported. 7187c92a3d2SAneesh Kumar K.V@item id=@var{id} 7197c92a3d2SAneesh Kumar K.VSpecifies identifier for this device 7207c92a3d2SAneesh Kumar K.V@item path=@var{path} 7217c92a3d2SAneesh Kumar K.VSpecifies the export path for the file system device. Files under 7227c92a3d2SAneesh Kumar K.Vthis path will be available to the 9p client on the guest. 7237c92a3d2SAneesh Kumar K.V@item security_model=@var{security_model} 7247c92a3d2SAneesh Kumar K.VSpecifies the security model to be used for this export path. 7252c30dd74SAneesh Kumar K.VSupported security models are "passthrough", "mapped-xattr", "mapped-file" and "none". 7267c92a3d2SAneesh Kumar K.VIn "passthrough" security model, files are stored using the same 727b65ee4faSStefan Weilcredentials as they are created on the guest. This requires QEMU 7282c30dd74SAneesh Kumar K.Vto run as root. In "mapped-xattr" security model, some of the file 7297c92a3d2SAneesh Kumar K.Vattributes like uid, gid, mode bits and link target are stored as 7302c30dd74SAneesh Kumar K.Vfile attributes. For "mapped-file" these attributes are stored in the 7312c30dd74SAneesh Kumar K.Vhidden .virtfs_metadata directory. Directories exported by this security model cannot 7327c92a3d2SAneesh Kumar K.Vinteract with other unix tools. "none" security model is same as 7337c92a3d2SAneesh Kumar K.Vpassthrough except the sever won't report failures if it fails to 734d9b36a6eSM. Mohan Kumarset file attributes like ownership. Security model is mandatory only 735f67e3ffdSM. Mohan Kumarfor local fsdriver. Other fsdrivers (like handle, proxy) don't take security 736d9b36a6eSM. Mohan Kumarmodel as a parameter. 7377c92a3d2SAneesh Kumar K.V@item writeout=@var{writeout} 7387c92a3d2SAneesh Kumar K.VThis is an optional argument. The only supported value is "immediate". 7397c92a3d2SAneesh Kumar K.VThis means that host page cache will be used to read and write data but 7407c92a3d2SAneesh Kumar K.Vwrite notification will be sent to the guest only when the data has been 7417c92a3d2SAneesh Kumar K.Vreported as written by the storage subsystem. 7422c74c2cbSM. Mohan Kumar@item readonly 7432c74c2cbSM. Mohan KumarEnables exporting 9p share as a readonly mount for guests. By default 7442c74c2cbSM. Mohan Kumarread-write access is given. 74584a87cc4SM. Mohan Kumar@item socket=@var{socket} 74684a87cc4SM. Mohan KumarEnables proxy filesystem driver to use passed socket file for 74784a87cc4SM. Mohan Kumarcommunicating with virtfs-proxy-helper. Usually a helper like libvirt 74884a87cc4SM. Mohan Kumarwill create socketpair and pass one of the fds as sock_fd 749f67e3ffdSM. Mohan Kumar@item sock_fd 750f67e3ffdSM. Mohan KumarEnables proxy filesystem driver to use passed 'sock_fd' as the socket 751f67e3ffdSM. Mohan Kumardescriptor for interfacing with virtfs-proxy-helper 7523d54abc7SGautham R Shenoy@end table 7533d54abc7SGautham R ShenoyETEXI 7543d54abc7SGautham R Shenoy 7559db221aeSAneesh Kumar K.VDEF("virtfs_synth", 0, QEMU_OPTION_virtfs_synth, 7569db221aeSAneesh Kumar K.V "-virtfs_synth Create synthetic file system image\n", 7579db221aeSAneesh Kumar K.V QEMU_ARCH_ALL) 7589db221aeSAneesh Kumar K.VSTEXI 7599db221aeSAneesh Kumar K.V@item -virtfs_synth 7609db221aeSAneesh Kumar K.V@findex -virtfs_synth 7619db221aeSAneesh Kumar K.VCreate synthetic file system image 7629db221aeSAneesh Kumar K.VETEXI 7639db221aeSAneesh Kumar K.V 7645824d651Sblueswir1STEXI 7655824d651Sblueswir1@end table 7665824d651Sblueswir1ETEXI 7675824d651Sblueswir1DEFHEADING() 7685824d651Sblueswir1 76910adb8beSMarkus ArmbrusterDEFHEADING(USB options:) 77010adb8beSMarkus ArmbrusterSTEXI 77110adb8beSMarkus Armbruster@table @option 77210adb8beSMarkus ArmbrusterETEXI 77310adb8beSMarkus Armbruster 77410adb8beSMarkus ArmbrusterDEF("usb", 0, QEMU_OPTION_usb, 77510adb8beSMarkus Armbruster "-usb enable the USB driver (will be the default soon)\n", 77610adb8beSMarkus Armbruster QEMU_ARCH_ALL) 77710adb8beSMarkus ArmbrusterSTEXI 77810adb8beSMarkus Armbruster@item -usb 77910adb8beSMarkus Armbruster@findex -usb 78010adb8beSMarkus ArmbrusterEnable the USB driver (will be the default soon) 78110adb8beSMarkus ArmbrusterETEXI 78210adb8beSMarkus Armbruster 78310adb8beSMarkus ArmbrusterDEF("usbdevice", HAS_ARG, QEMU_OPTION_usbdevice, 78410adb8beSMarkus Armbruster "-usbdevice name add the host or guest USB device 'name'\n", 78510adb8beSMarkus Armbruster QEMU_ARCH_ALL) 78610adb8beSMarkus ArmbrusterSTEXI 78710adb8beSMarkus Armbruster 78810adb8beSMarkus Armbruster@item -usbdevice @var{devname} 78910adb8beSMarkus Armbruster@findex -usbdevice 79010adb8beSMarkus ArmbrusterAdd the USB device @var{devname}. @xref{usb_devices}. 79110adb8beSMarkus Armbruster 79210adb8beSMarkus Armbruster@table @option 79310adb8beSMarkus Armbruster 79410adb8beSMarkus Armbruster@item mouse 79510adb8beSMarkus ArmbrusterVirtual Mouse. This will override the PS/2 mouse emulation when activated. 79610adb8beSMarkus Armbruster 79710adb8beSMarkus Armbruster@item tablet 79810adb8beSMarkus ArmbrusterPointer device that uses absolute coordinates (like a touchscreen). This 79910adb8beSMarkus Armbrustermeans QEMU is able to report the mouse position without having to grab the 80010adb8beSMarkus Armbrustermouse. Also overrides the PS/2 mouse emulation when activated. 80110adb8beSMarkus Armbruster 80210adb8beSMarkus Armbruster@item disk:[format=@var{format}]:@var{file} 80310adb8beSMarkus ArmbrusterMass storage device based on file. The optional @var{format} argument 80410adb8beSMarkus Armbrusterwill be used rather than detecting the format. Can be used to specifiy 80510adb8beSMarkus Armbruster@code{format=raw} to avoid interpreting an untrusted format header. 80610adb8beSMarkus Armbruster 80710adb8beSMarkus Armbruster@item host:@var{bus}.@var{addr} 80810adb8beSMarkus ArmbrusterPass through the host device identified by @var{bus}.@var{addr} (Linux only). 80910adb8beSMarkus Armbruster 81010adb8beSMarkus Armbruster@item host:@var{vendor_id}:@var{product_id} 81110adb8beSMarkus ArmbrusterPass through the host device identified by @var{vendor_id}:@var{product_id} 81210adb8beSMarkus Armbruster(Linux only). 81310adb8beSMarkus Armbruster 81410adb8beSMarkus Armbruster@item serial:[vendorid=@var{vendor_id}][,productid=@var{product_id}]:@var{dev} 81510adb8beSMarkus ArmbrusterSerial converter to host character device @var{dev}, see @code{-serial} for the 81610adb8beSMarkus Armbrusteravailable devices. 81710adb8beSMarkus Armbruster 81810adb8beSMarkus Armbruster@item braille 81910adb8beSMarkus ArmbrusterBraille device. This will use BrlAPI to display the braille output on a real 82010adb8beSMarkus Armbrusteror fake device. 82110adb8beSMarkus Armbruster 82210adb8beSMarkus Armbruster@item net:@var{options} 82310adb8beSMarkus ArmbrusterNetwork adapter that supports CDC ethernet and RNDIS protocols. 82410adb8beSMarkus Armbruster 82510adb8beSMarkus Armbruster@end table 82610adb8beSMarkus ArmbrusterETEXI 82710adb8beSMarkus Armbruster 82810adb8beSMarkus ArmbrusterSTEXI 82910adb8beSMarkus Armbruster@end table 83010adb8beSMarkus ArmbrusterETEXI 83110adb8beSMarkus ArmbrusterDEFHEADING() 83210adb8beSMarkus Armbruster 8335824d651Sblueswir1DEFHEADING(Display options:) 8345824d651Sblueswir1STEXI 8355824d651Sblueswir1@table @option 8365824d651Sblueswir1ETEXI 8375824d651Sblueswir1 8381472a95bSJes SorensenDEF("display", HAS_ARG, QEMU_OPTION_display, 8391472a95bSJes Sorensen "-display sdl[,frame=on|off][,alt_grab=on|off][,ctrl_grab=on|off]\n" 8403264ff12SJes Sorensen " [,window_close=on|off]|curses|none|\n" 841881249c7SJan Kiszka " gtk[,grab_on_hover=on|off]|\n" 8423264ff12SJes Sorensen " vnc=<display>[,<optargs>]\n" 8431472a95bSJes Sorensen " select display type\n", QEMU_ARCH_ALL) 8441472a95bSJes SorensenSTEXI 8451472a95bSJes Sorensen@item -display @var{type} 8461472a95bSJes Sorensen@findex -display 8471472a95bSJes SorensenSelect type of display to use. This option is a replacement for the 8481472a95bSJes Sorensenold style -sdl/-curses/... options. Valid values for @var{type} are 8491472a95bSJes Sorensen@table @option 8501472a95bSJes Sorensen@item sdl 8511472a95bSJes SorensenDisplay video output via SDL (usually in a separate graphics 8521472a95bSJes Sorensenwindow; see the SDL documentation for other possibilities). 8531472a95bSJes Sorensen@item curses 8541472a95bSJes SorensenDisplay video output via curses. For graphics device models which 8551472a95bSJes Sorensensupport a text mode, QEMU can display this output using a 8561472a95bSJes Sorensencurses/ncurses interface. Nothing is displayed when the graphics 8571472a95bSJes Sorensendevice is in graphical mode or if the graphics device does not support 8581472a95bSJes Sorensena text mode. Generally only the VGA device models support text mode. 8594171d32eSJes Sorensen@item none 8604171d32eSJes SorensenDo not display video output. The guest will still see an emulated 8614171d32eSJes Sorensengraphics card, but its output will not be displayed to the QEMU 8624171d32eSJes Sorensenuser. This option differs from the -nographic option in that it 8634171d32eSJes Sorensenonly affects what is done with video output; -nographic also changes 8644171d32eSJes Sorensenthe destination of the serial and parallel port data. 865881249c7SJan Kiszka@item gtk 866881249c7SJan KiszkaDisplay video output in a GTK window. This interface provides drop-down 867881249c7SJan Kiszkamenus and other UI elements to configure and control the VM during 868881249c7SJan Kiszkaruntime. 8693264ff12SJes Sorensen@item vnc 8703264ff12SJes SorensenStart a VNC server on display <arg> 8711472a95bSJes Sorensen@end table 8721472a95bSJes SorensenETEXI 8731472a95bSJes Sorensen 8745824d651Sblueswir1DEF("nographic", 0, QEMU_OPTION_nographic, 875ad96090aSBlue Swirl "-nographic disable graphical output and redirect serial I/Os to console\n", 876ad96090aSBlue Swirl QEMU_ARCH_ALL) 8775824d651Sblueswir1STEXI 8785824d651Sblueswir1@item -nographic 8796616b2adSStefan Weil@findex -nographic 8805824d651Sblueswir1Normally, QEMU uses SDL to display the VGA output. With this option, 8815824d651Sblueswir1you can totally disable graphical output so that QEMU is a simple 8825824d651Sblueswir1command line application. The emulated serial port is redirected on 88302c4bdf1SPaolo Bonzinithe console and muxed with the monitor (unless redirected elsewhere 88402c4bdf1SPaolo Bonziniexplicitly). Therefore, you can still use QEMU to debug a Linux kernel 885b031f413SRamkumar Ramachandrawith a serial console. Use @key{C-a h} for help on switching between 886b031f413SRamkumar Ramachandrathe console and monitor. 8875824d651Sblueswir1ETEXI 8885824d651Sblueswir1 8895824d651Sblueswir1DEF("curses", 0, QEMU_OPTION_curses, 890ad96090aSBlue Swirl "-curses use a curses/ncurses interface instead of SDL\n", 891ad96090aSBlue Swirl QEMU_ARCH_ALL) 8925824d651Sblueswir1STEXI 8935824d651Sblueswir1@item -curses 894b8f490ebSMarkus Armbruster@findex -curses 8955824d651Sblueswir1Normally, QEMU uses SDL to display the VGA output. With this option, 8965824d651Sblueswir1QEMU can display the VGA output when in text mode using a 8975824d651Sblueswir1curses/ncurses interface. Nothing is displayed in graphical mode. 8985824d651Sblueswir1ETEXI 8995824d651Sblueswir1 9005824d651Sblueswir1DEF("no-frame", 0, QEMU_OPTION_no_frame, 901ad96090aSBlue Swirl "-no-frame open SDL window without a frame and window decorations\n", 902ad96090aSBlue Swirl QEMU_ARCH_ALL) 9035824d651Sblueswir1STEXI 9045824d651Sblueswir1@item -no-frame 9056616b2adSStefan Weil@findex -no-frame 9065824d651Sblueswir1Do not use decorations for SDL windows and start them using the whole 9075824d651Sblueswir1available screen space. This makes the using QEMU in a dedicated desktop 9085824d651Sblueswir1workspace more convenient. 9095824d651Sblueswir1ETEXI 9105824d651Sblueswir1 9115824d651Sblueswir1DEF("alt-grab", 0, QEMU_OPTION_alt_grab, 912ad96090aSBlue Swirl "-alt-grab use Ctrl-Alt-Shift to grab mouse (instead of Ctrl-Alt)\n", 913ad96090aSBlue Swirl QEMU_ARCH_ALL) 9145824d651Sblueswir1STEXI 9155824d651Sblueswir1@item -alt-grab 9166616b2adSStefan Weil@findex -alt-grab 917de1db2a1SBrad HardsUse Ctrl-Alt-Shift to grab mouse (instead of Ctrl-Alt). Note that this also 918de1db2a1SBrad Hardsaffects the special keys (for fullscreen, monitor-mode switching, etc). 9195824d651Sblueswir1ETEXI 9205824d651Sblueswir1 9210ca9f8a4SDustin KirklandDEF("ctrl-grab", 0, QEMU_OPTION_ctrl_grab, 922ad96090aSBlue Swirl "-ctrl-grab use Right-Ctrl to grab mouse (instead of Ctrl-Alt)\n", 923ad96090aSBlue Swirl QEMU_ARCH_ALL) 9240ca9f8a4SDustin KirklandSTEXI 9250ca9f8a4SDustin Kirkland@item -ctrl-grab 9266616b2adSStefan Weil@findex -ctrl-grab 927de1db2a1SBrad HardsUse Right-Ctrl to grab mouse (instead of Ctrl-Alt). Note that this also 928de1db2a1SBrad Hardsaffects the special keys (for fullscreen, monitor-mode switching, etc). 9290ca9f8a4SDustin KirklandETEXI 9300ca9f8a4SDustin Kirkland 9315824d651Sblueswir1DEF("no-quit", 0, QEMU_OPTION_no_quit, 932ad96090aSBlue Swirl "-no-quit disable SDL window close capability\n", QEMU_ARCH_ALL) 9335824d651Sblueswir1STEXI 9345824d651Sblueswir1@item -no-quit 9356616b2adSStefan Weil@findex -no-quit 9365824d651Sblueswir1Disable SDL window close capability. 9375824d651Sblueswir1ETEXI 9385824d651Sblueswir1 9395824d651Sblueswir1DEF("sdl", 0, QEMU_OPTION_sdl, 940ad96090aSBlue Swirl "-sdl enable SDL\n", QEMU_ARCH_ALL) 9415824d651Sblueswir1STEXI 9425824d651Sblueswir1@item -sdl 9436616b2adSStefan Weil@findex -sdl 9445824d651Sblueswir1Enable SDL. 9455824d651Sblueswir1ETEXI 9465824d651Sblueswir1 94729b0040bSGerd HoffmannDEF("spice", HAS_ARG, QEMU_OPTION_spice, 94827af7788SYonit Halperin "-spice [port=port][,tls-port=secured-port][,x509-dir=<dir>]\n" 94927af7788SYonit Halperin " [,x509-key-file=<file>][,x509-key-password=<file>]\n" 95027af7788SYonit Halperin " [,x509-cert-file=<file>][,x509-cacert-file=<file>]\n" 95127af7788SYonit Halperin " [,x509-dh-key-file=<file>][,addr=addr][,ipv4|ipv6]\n" 95227af7788SYonit Halperin " [,tls-ciphers=<list>]\n" 95327af7788SYonit Halperin " [,tls-channel=[main|display|cursor|inputs|record|playback]]\n" 95427af7788SYonit Halperin " [,plaintext-channel=[main|display|cursor|inputs|record|playback]]\n" 95527af7788SYonit Halperin " [,sasl][,password=<secret>][,disable-ticketing]\n" 95627af7788SYonit Halperin " [,image-compression=[auto_glz|auto_lz|quic|glz|lz|off]]\n" 95727af7788SYonit Halperin " [,jpeg-wan-compression=[auto|never|always]]\n" 95827af7788SYonit Halperin " [,zlib-glz-wan-compression=[auto|never|always]]\n" 95927af7788SYonit Halperin " [,streaming-video=[off|all|filter]][,disable-copy-paste]\n" 9605ad24e5fSHans de Goede " [,disable-agent-file-xfer][,agent-mouse=[on|off]]\n" 9615ad24e5fSHans de Goede " [,playback-compression=[on|off]][,seamless-migration=[on|off]]\n" 96227af7788SYonit Halperin " enable spice\n" 96327af7788SYonit Halperin " at least one of {port, tls-port} is mandatory\n", 96427af7788SYonit Halperin QEMU_ARCH_ALL) 96529b0040bSGerd HoffmannSTEXI 96629b0040bSGerd Hoffmann@item -spice @var{option}[,@var{option}[,...]] 96729b0040bSGerd Hoffmann@findex -spice 96829b0040bSGerd HoffmannEnable the spice remote desktop protocol. Valid options are 96929b0040bSGerd Hoffmann 97029b0040bSGerd Hoffmann@table @option 97129b0040bSGerd Hoffmann 97229b0040bSGerd Hoffmann@item port=<nr> 973c448e855SGerd HoffmannSet the TCP port spice is listening on for plaintext channels. 97429b0040bSGerd Hoffmann 975333b0eebSGerd Hoffmann@item addr=<addr> 976333b0eebSGerd HoffmannSet the IP address spice is listening on. Default is any address. 977333b0eebSGerd Hoffmann 978333b0eebSGerd Hoffmann@item ipv4 979333b0eebSGerd Hoffmann@item ipv6 980333b0eebSGerd HoffmannForce using the specified IP version. 981333b0eebSGerd Hoffmann 98229b0040bSGerd Hoffmann@item password=<secret> 98329b0040bSGerd HoffmannSet the password you need to authenticate. 98429b0040bSGerd Hoffmann 98548b3ed0aSMarc-André Lureau@item sasl 98648b3ed0aSMarc-André LureauRequire that the client use SASL to authenticate with the spice. 98748b3ed0aSMarc-André LureauThe exact choice of authentication method used is controlled from the 98848b3ed0aSMarc-André Lureausystem / user's SASL configuration file for the 'qemu' service. This 98948b3ed0aSMarc-André Lureauis typically found in /etc/sasl2/qemu.conf. If running QEMU as an 99048b3ed0aSMarc-André Lureauunprivileged user, an environment variable SASL_CONF_PATH can be used 99148b3ed0aSMarc-André Lureauto make it search alternate locations for the service config. 99248b3ed0aSMarc-André LureauWhile some SASL auth methods can also provide data encryption (eg GSSAPI), 99348b3ed0aSMarc-André Lureauit is recommended that SASL always be combined with the 'tls' and 99448b3ed0aSMarc-André Lureau'x509' settings to enable use of SSL and server certificates. This 99548b3ed0aSMarc-André Lureauensures a data encryption preventing compromise of authentication 99648b3ed0aSMarc-André Lureaucredentials. 99748b3ed0aSMarc-André Lureau 99829b0040bSGerd Hoffmann@item disable-ticketing 99929b0040bSGerd HoffmannAllow client connects without authentication. 100029b0040bSGerd Hoffmann 1001d4970b07SHans de Goede@item disable-copy-paste 1002d4970b07SHans de GoedeDisable copy paste between the client and the guest. 1003d4970b07SHans de Goede 10045ad24e5fSHans de Goede@item disable-agent-file-xfer 10055ad24e5fSHans de GoedeDisable spice-vdagent based file-xfer between the client and the guest. 10065ad24e5fSHans de Goede 1007c448e855SGerd Hoffmann@item tls-port=<nr> 1008c448e855SGerd HoffmannSet the TCP port spice is listening on for encrypted channels. 1009c448e855SGerd Hoffmann 1010c448e855SGerd Hoffmann@item x509-dir=<dir> 1011c448e855SGerd HoffmannSet the x509 file directory. Expects same filenames as -vnc $display,x509=$dir 1012c448e855SGerd Hoffmann 1013c448e855SGerd Hoffmann@item x509-key-file=<file> 1014c448e855SGerd Hoffmann@item x509-key-password=<file> 1015c448e855SGerd Hoffmann@item x509-cert-file=<file> 1016c448e855SGerd Hoffmann@item x509-cacert-file=<file> 1017c448e855SGerd Hoffmann@item x509-dh-key-file=<file> 1018c448e855SGerd HoffmannThe x509 file names can also be configured individually. 1019c448e855SGerd Hoffmann 1020c448e855SGerd Hoffmann@item tls-ciphers=<list> 1021c448e855SGerd HoffmannSpecify which ciphers to use. 1022c448e855SGerd Hoffmann 1023d70d6b31SAlon Levy@item tls-channel=[main|display|cursor|inputs|record|playback] 1024d70d6b31SAlon Levy@item plaintext-channel=[main|display|cursor|inputs|record|playback] 102517b6dea0SGerd HoffmannForce specific channel to be used with or without TLS encryption. The 102617b6dea0SGerd Hoffmannoptions can be specified multiple times to configure multiple 102717b6dea0SGerd Hoffmannchannels. The special name "default" can be used to set the default 102817b6dea0SGerd Hoffmannmode. For channels which are not explicitly forced into one mode the 102917b6dea0SGerd Hoffmannspice client is allowed to pick tls/plaintext as he pleases. 103017b6dea0SGerd Hoffmann 10319f04e09eSYonit Halperin@item image-compression=[auto_glz|auto_lz|quic|glz|lz|off] 10329f04e09eSYonit HalperinConfigure image compression (lossless). 10339f04e09eSYonit HalperinDefault is auto_glz. 10349f04e09eSYonit Halperin 10359f04e09eSYonit Halperin@item jpeg-wan-compression=[auto|never|always] 10369f04e09eSYonit Halperin@item zlib-glz-wan-compression=[auto|never|always] 10379f04e09eSYonit HalperinConfigure wan image compression (lossy for slow links). 10389f04e09eSYonit HalperinDefault is auto. 10399f04e09eSYonit Halperin 104084a23f25SGerd Hoffmann@item streaming-video=[off|all|filter] 104184a23f25SGerd HoffmannConfigure video stream detection. Default is filter. 104284a23f25SGerd Hoffmann 104384a23f25SGerd Hoffmann@item agent-mouse=[on|off] 104484a23f25SGerd HoffmannEnable/disable passing mouse events via vdagent. Default is on. 104584a23f25SGerd Hoffmann 104684a23f25SGerd Hoffmann@item playback-compression=[on|off] 104784a23f25SGerd HoffmannEnable/disable audio stream compression (using celt 0.5.1). Default is on. 104884a23f25SGerd Hoffmann 10498c957053SYonit Halperin@item seamless-migration=[on|off] 10508c957053SYonit HalperinEnable/disable spice seamless migration. Default is off. 10518c957053SYonit Halperin 105229b0040bSGerd Hoffmann@end table 105329b0040bSGerd HoffmannETEXI 105429b0040bSGerd Hoffmann 10555824d651Sblueswir1DEF("portrait", 0, QEMU_OPTION_portrait, 1056ad96090aSBlue Swirl "-portrait rotate graphical output 90 deg left (only PXA LCD)\n", 1057ad96090aSBlue Swirl QEMU_ARCH_ALL) 10585824d651Sblueswir1STEXI 10595824d651Sblueswir1@item -portrait 10606616b2adSStefan Weil@findex -portrait 10615824d651Sblueswir1Rotate graphical output 90 deg left (only PXA LCD). 10625824d651Sblueswir1ETEXI 10635824d651Sblueswir1 10649312805dSVasily KhoruzhickDEF("rotate", HAS_ARG, QEMU_OPTION_rotate, 10659312805dSVasily Khoruzhick "-rotate <deg> rotate graphical output some deg left (only PXA LCD)\n", 10669312805dSVasily Khoruzhick QEMU_ARCH_ALL) 10679312805dSVasily KhoruzhickSTEXI 10686265c43bSMarkus Armbruster@item -rotate @var{deg} 10699312805dSVasily Khoruzhick@findex -rotate 10709312805dSVasily KhoruzhickRotate graphical output some deg left (only PXA LCD). 10719312805dSVasily KhoruzhickETEXI 10729312805dSVasily Khoruzhick 10735824d651Sblueswir1DEF("vga", HAS_ARG, QEMU_OPTION_vga, 107433632788SMark Cave-Ayland "-vga [std|cirrus|vmware|qxl|xenfb|tcx|cg3|none]\n" 1075ad96090aSBlue Swirl " select video card type\n", QEMU_ARCH_ALL) 10765824d651Sblueswir1STEXI 1077e4558dcaSmalc@item -vga @var{type} 10786616b2adSStefan Weil@findex -vga 10795824d651Sblueswir1Select type of VGA card to emulate. Valid values for @var{type} are 1080b3f046c2SKevin Wolf@table @option 10815824d651Sblueswir1@item cirrus 10825824d651Sblueswir1Cirrus Logic GD5446 Video card. All Windows versions starting from 10835824d651Sblueswir1Windows 95 should recognize and use this graphic card. For optimal 10845824d651Sblueswir1performances, use 16 bit color depth in the guest and the host OS. 10855824d651Sblueswir1(This one is the default) 10865824d651Sblueswir1@item std 10875824d651Sblueswir1Standard VGA card with Bochs VBE extensions. If your guest OS 10885824d651Sblueswir1supports the VESA 2.0 VBE extensions (e.g. Windows XP) and if you want 10895824d651Sblueswir1to use high resolution modes (>= 1280x1024x16) then you should use 10905824d651Sblueswir1this option. 10915824d651Sblueswir1@item vmware 10925824d651Sblueswir1VMWare SVGA-II compatible adapter. Use it if you have sufficiently 10935824d651Sblueswir1recent XFree86/XOrg server or Windows guest with a driver for this 10945824d651Sblueswir1card. 1095a19cbfb3SGerd Hoffmann@item qxl 1096a19cbfb3SGerd HoffmannQXL paravirtual graphic card. It is VGA compatible (including VESA 1097a19cbfb3SGerd Hoffmann2.0 VBE support). Works best with qxl guest drivers installed though. 1098a19cbfb3SGerd HoffmannRecommended choice when using the spice protocol. 109933632788SMark Cave-Ayland@item tcx 110033632788SMark Cave-Ayland(sun4m only) Sun TCX framebuffer. This is the default framebuffer for 110133632788SMark Cave-Aylandsun4m machines and offers both 8-bit and 24-bit colour depths at a 110233632788SMark Cave-Aylandfixed resolution of 1024x768. 110333632788SMark Cave-Ayland@item cg3 110433632788SMark Cave-Ayland(sun4m only) Sun cgthree framebuffer. This is a simple 8-bit framebuffer 110533632788SMark Cave-Aylandfor sun4m machines available in both 1024x768 (OpenBIOS) and 1152x900 (OBP) 110633632788SMark Cave-Aylandresolutions aimed at people wishing to run older Solaris versions. 11075824d651Sblueswir1@item none 11085824d651Sblueswir1Disable VGA card. 11095824d651Sblueswir1@end table 11105824d651Sblueswir1ETEXI 11115824d651Sblueswir1 11125824d651Sblueswir1DEF("full-screen", 0, QEMU_OPTION_full_screen, 1113ad96090aSBlue Swirl "-full-screen start in full screen\n", QEMU_ARCH_ALL) 11145824d651Sblueswir1STEXI 11155824d651Sblueswir1@item -full-screen 11166616b2adSStefan Weil@findex -full-screen 11175824d651Sblueswir1Start in full screen. 11185824d651Sblueswir1ETEXI 11195824d651Sblueswir1 11205824d651Sblueswir1DEF("g", 1, QEMU_OPTION_g , 1121ad96090aSBlue Swirl "-g WxH[xDEPTH] Set the initial graphical resolution and depth\n", 1122ad96090aSBlue Swirl QEMU_ARCH_PPC | QEMU_ARCH_SPARC) 11235824d651Sblueswir1STEXI 112495d5f08bSStefan Weil@item -g @var{width}x@var{height}[x@var{depth}] 11256616b2adSStefan Weil@findex -g 112695d5f08bSStefan WeilSet the initial graphical resolution and depth (PPC, SPARC only). 11275824d651Sblueswir1ETEXI 11285824d651Sblueswir1 11295824d651Sblueswir1DEF("vnc", HAS_ARG, QEMU_OPTION_vnc , 1130ad96090aSBlue Swirl "-vnc display start a VNC server on display\n", QEMU_ARCH_ALL) 11315824d651Sblueswir1STEXI 11325824d651Sblueswir1@item -vnc @var{display}[,@var{option}[,@var{option}[,...]]] 11336616b2adSStefan Weil@findex -vnc 11345824d651Sblueswir1Normally, QEMU uses SDL to display the VGA output. With this option, 11355824d651Sblueswir1you can have QEMU listen on VNC display @var{display} and redirect the VGA 11365824d651Sblueswir1display over the VNC session. It is very useful to enable the usb 11375824d651Sblueswir1tablet device when using this option (option @option{-usbdevice 11385824d651Sblueswir1tablet}). When using the VNC display, you must use the @option{-k} 11395824d651Sblueswir1parameter to set the keyboard layout if you are not using en-us. Valid 11405824d651Sblueswir1syntax for the @var{display} is 11415824d651Sblueswir1 1142b3f046c2SKevin Wolf@table @option 11435824d651Sblueswir1 11445824d651Sblueswir1@item @var{host}:@var{d} 11455824d651Sblueswir1 11465824d651Sblueswir1TCP connections will only be allowed from @var{host} on display @var{d}. 11475824d651Sblueswir1By convention the TCP port is 5900+@var{d}. Optionally, @var{host} can 11485824d651Sblueswir1be omitted in which case the server will accept connections from any host. 11495824d651Sblueswir1 11504e257e5eSKevin Wolf@item unix:@var{path} 11515824d651Sblueswir1 11525824d651Sblueswir1Connections will be allowed over UNIX domain sockets where @var{path} is the 11535824d651Sblueswir1location of a unix socket to listen for connections on. 11545824d651Sblueswir1 11555824d651Sblueswir1@item none 11565824d651Sblueswir1 11575824d651Sblueswir1VNC is initialized but not started. The monitor @code{change} command 11585824d651Sblueswir1can be used to later start the VNC server. 11595824d651Sblueswir1 11605824d651Sblueswir1@end table 11615824d651Sblueswir1 11625824d651Sblueswir1Following the @var{display} value there may be one or more @var{option} flags 11635824d651Sblueswir1separated by commas. Valid options are 11645824d651Sblueswir1 1165b3f046c2SKevin Wolf@table @option 11665824d651Sblueswir1 11675824d651Sblueswir1@item reverse 11685824d651Sblueswir1 11695824d651Sblueswir1Connect to a listening VNC client via a ``reverse'' connection. The 11705824d651Sblueswir1client is specified by the @var{display}. For reverse network 11715824d651Sblueswir1connections (@var{host}:@var{d},@code{reverse}), the @var{d} argument 11725824d651Sblueswir1is a TCP port number, not a display number. 11735824d651Sblueswir1 11747536ee4bSTim Hardeck@item websocket 11757536ee4bSTim Hardeck 11767536ee4bSTim HardeckOpens an additional TCP listening port dedicated to VNC Websocket connections. 1177085d8134SPeter MaydellBy definition the Websocket port is 5700+@var{display}. If @var{host} is 11787536ee4bSTim Hardeckspecified connections will only be allowed from this host. 11797536ee4bSTim HardeckAs an alternative the Websocket port could be specified by using 11807536ee4bSTim Hardeck@code{websocket}=@var{port}. 11810057a0d5STim HardeckTLS encryption for the Websocket connection is supported if the required 11820057a0d5STim Hardeckcertificates are specified with the VNC option @option{x509}. 11837536ee4bSTim Hardeck 11845824d651Sblueswir1@item password 11855824d651Sblueswir1 11865824d651Sblueswir1Require that password based authentication is used for client connections. 118786ee5bc3SMichal Novotny 118886ee5bc3SMichal NovotnyThe password must be set separately using the @code{set_password} command in 118986ee5bc3SMichal Novotnythe @ref{pcsys_monitor}. The syntax to change your password is: 119086ee5bc3SMichal Novotny@code{set_password <protocol> <password>} where <protocol> could be either 119186ee5bc3SMichal Novotny"vnc" or "spice". 119286ee5bc3SMichal Novotny 119386ee5bc3SMichal NovotnyIf you would like to change <protocol> password expiration, you should use 119486ee5bc3SMichal Novotny@code{expire_password <protocol> <expiration-time>} where expiration time could 119586ee5bc3SMichal Novotnybe one of the following options: now, never, +seconds or UNIX time of 119686ee5bc3SMichal Novotnyexpiration, e.g. +60 to make password expire in 60 seconds, or 1335196800 119786ee5bc3SMichal Novotnyto make password expire on "Mon Apr 23 12:00:00 EDT 2012" (UNIX time for this 119886ee5bc3SMichal Novotnydate and time). 119986ee5bc3SMichal Novotny 120086ee5bc3SMichal NovotnyYou can also use keywords "now" or "never" for the expiration time to 120186ee5bc3SMichal Novotnyallow <protocol> password to expire immediately or never expire. 12025824d651Sblueswir1 12035824d651Sblueswir1@item tls 12045824d651Sblueswir1 12055824d651Sblueswir1Require that client use TLS when communicating with the VNC server. This 12065824d651Sblueswir1uses anonymous TLS credentials so is susceptible to a man-in-the-middle 12075824d651Sblueswir1attack. It is recommended that this option be combined with either the 12084e257e5eSKevin Wolf@option{x509} or @option{x509verify} options. 12095824d651Sblueswir1 12105824d651Sblueswir1@item x509=@var{/path/to/certificate/dir} 12115824d651Sblueswir1 12125824d651Sblueswir1Valid if @option{tls} is specified. Require that x509 credentials are used 12135824d651Sblueswir1for negotiating the TLS session. The server will send its x509 certificate 12145824d651Sblueswir1to the client. It is recommended that a password be set on the VNC server 12155824d651Sblueswir1to provide authentication of the client when this is used. The path following 12165824d651Sblueswir1this option specifies where the x509 certificates are to be loaded from. 12175824d651Sblueswir1See the @ref{vnc_security} section for details on generating certificates. 12185824d651Sblueswir1 12195824d651Sblueswir1@item x509verify=@var{/path/to/certificate/dir} 12205824d651Sblueswir1 12215824d651Sblueswir1Valid if @option{tls} is specified. Require that x509 credentials are used 12225824d651Sblueswir1for negotiating the TLS session. The server will send its x509 certificate 12235824d651Sblueswir1to the client, and request that the client send its own x509 certificate. 12245824d651Sblueswir1The server will validate the client's certificate against the CA certificate, 12255824d651Sblueswir1and reject clients when validation fails. If the certificate authority is 12265824d651Sblueswir1trusted, this is a sufficient authentication mechanism. You may still wish 12275824d651Sblueswir1to set a password on the VNC server as a second authentication layer. The 12285824d651Sblueswir1path following this option specifies where the x509 certificates are to 12295824d651Sblueswir1be loaded from. See the @ref{vnc_security} section for details on generating 12305824d651Sblueswir1certificates. 12315824d651Sblueswir1 12325824d651Sblueswir1@item sasl 12335824d651Sblueswir1 12345824d651Sblueswir1Require that the client use SASL to authenticate with the VNC server. 12355824d651Sblueswir1The exact choice of authentication method used is controlled from the 12365824d651Sblueswir1system / user's SASL configuration file for the 'qemu' service. This 12375824d651Sblueswir1is typically found in /etc/sasl2/qemu.conf. If running QEMU as an 12385824d651Sblueswir1unprivileged user, an environment variable SASL_CONF_PATH can be used 12395824d651Sblueswir1to make it search alternate locations for the service config. 12405824d651Sblueswir1While some SASL auth methods can also provide data encryption (eg GSSAPI), 12415824d651Sblueswir1it is recommended that SASL always be combined with the 'tls' and 12425824d651Sblueswir1'x509' settings to enable use of SSL and server certificates. This 12435824d651Sblueswir1ensures a data encryption preventing compromise of authentication 12445824d651Sblueswir1credentials. See the @ref{vnc_security} section for details on using 12455824d651Sblueswir1SASL authentication. 12465824d651Sblueswir1 12475824d651Sblueswir1@item acl 12485824d651Sblueswir1 12495824d651Sblueswir1Turn on access control lists for checking of the x509 client certificate 12505824d651Sblueswir1and SASL party. For x509 certs, the ACL check is made against the 12515824d651Sblueswir1certificate's distinguished name. This is something that looks like 12525824d651Sblueswir1@code{C=GB,O=ACME,L=Boston,CN=bob}. For SASL party, the ACL check is 12535824d651Sblueswir1made against the username, which depending on the SASL plugin, may 12545824d651Sblueswir1include a realm component, eg @code{bob} or @code{bob@@EXAMPLE.COM}. 12555824d651Sblueswir1When the @option{acl} flag is set, the initial access list will be 12565824d651Sblueswir1empty, with a @code{deny} policy. Thus no one will be allowed to 12575824d651Sblueswir1use the VNC server until the ACLs have been loaded. This can be 12585824d651Sblueswir1achieved using the @code{acl} monitor command. 12595824d651Sblueswir1 12606f9c78c1SCorentin Chary@item lossy 12616f9c78c1SCorentin Chary 12626f9c78c1SCorentin CharyEnable lossy compression methods (gradient, JPEG, ...). If this 12636f9c78c1SCorentin Charyoption is set, VNC client may receive lossy framebuffer updates 12646f9c78c1SCorentin Charydepending on its encoding settings. Enabling this option can save 12656f9c78c1SCorentin Charya lot of bandwidth at the expense of quality. 12666f9c78c1SCorentin Chary 126780e0c8c3SCorentin Chary@item non-adaptive 126880e0c8c3SCorentin Chary 126980e0c8c3SCorentin CharyDisable adaptive encodings. Adaptive encodings are enabled by default. 127080e0c8c3SCorentin CharyAn adaptive encoding will try to detect frequently updated screen regions, 127180e0c8c3SCorentin Charyand send updates in these regions using a lossy encoding (like JPEG). 127261cc8701SStefan WeilThis can be really helpful to save bandwidth when playing videos. Disabling 12739d85d557SMichael Tokarevadaptive encodings restores the original static behavior of encodings 127480e0c8c3SCorentin Charylike Tight. 127580e0c8c3SCorentin Chary 12768cf36489SGerd Hoffmann@item share=[allow-exclusive|force-shared|ignore] 12778cf36489SGerd Hoffmann 12788cf36489SGerd HoffmannSet display sharing policy. 'allow-exclusive' allows clients to ask 12798cf36489SGerd Hoffmannfor exclusive access. As suggested by the rfb spec this is 12808cf36489SGerd Hoffmannimplemented by dropping other connections. Connecting multiple 12818cf36489SGerd Hoffmannclients in parallel requires all clients asking for a shared session 12828cf36489SGerd Hoffmann(vncviewer: -shared switch). This is the default. 'force-shared' 12838cf36489SGerd Hoffmanndisables exclusive client access. Useful for shared desktop sessions, 12848cf36489SGerd Hoffmannwhere you don't want someone forgetting specify -shared disconnect 12858cf36489SGerd Hoffmanneverybody else. 'ignore' completely ignores the shared flag and 12868cf36489SGerd Hoffmannallows everybody connect unconditionally. Doesn't conform to the rfb 1287b65ee4faSStefan Weilspec but is traditional QEMU behavior. 12888cf36489SGerd Hoffmann 12895824d651Sblueswir1@end table 12905824d651Sblueswir1ETEXI 12915824d651Sblueswir1 12925824d651Sblueswir1STEXI 12935824d651Sblueswir1@end table 12945824d651Sblueswir1ETEXI 1295a3adb7adSMichael EllermanARCHHEADING(, QEMU_ARCH_I386) 12965824d651Sblueswir1 1297a3adb7adSMichael EllermanARCHHEADING(i386 target only:, QEMU_ARCH_I386) 12985824d651Sblueswir1STEXI 12995824d651Sblueswir1@table @option 13005824d651Sblueswir1ETEXI 13015824d651Sblueswir1 13025824d651Sblueswir1DEF("win2k-hack", 0, QEMU_OPTION_win2k_hack, 1303ad96090aSBlue Swirl "-win2k-hack use it when installing Windows 2000 to avoid a disk full bug\n", 1304ad96090aSBlue Swirl QEMU_ARCH_I386) 13055824d651Sblueswir1STEXI 13065824d651Sblueswir1@item -win2k-hack 13076616b2adSStefan Weil@findex -win2k-hack 13085824d651Sblueswir1Use it when installing Windows 2000 to avoid a disk full bug. After 13095824d651Sblueswir1Windows 2000 is installed, you no longer need this option (this option 13105824d651Sblueswir1slows down the IDE transfers). 13115824d651Sblueswir1ETEXI 13125824d651Sblueswir1 13131ed2fc1fSJan KiszkaHXCOMM Deprecated by -rtc 1314ad96090aSBlue SwirlDEF("rtc-td-hack", 0, QEMU_OPTION_rtc_td_hack, "", QEMU_ARCH_I386) 13155824d651Sblueswir1 13165824d651Sblueswir1DEF("no-fd-bootchk", 0, QEMU_OPTION_no_fd_bootchk, 1317ad96090aSBlue Swirl "-no-fd-bootchk disable boot signature checking for floppy disks\n", 1318ad96090aSBlue Swirl QEMU_ARCH_I386) 13195824d651Sblueswir1STEXI 13205824d651Sblueswir1@item -no-fd-bootchk 13216616b2adSStefan Weil@findex -no-fd-bootchk 13224eda32f5SMarkus ArmbrusterDisable boot signature checking for floppy disks in BIOS. May 13235824d651Sblueswir1be needed to boot from old floppy disks. 13245824d651Sblueswir1ETEXI 13255824d651Sblueswir1 13265824d651Sblueswir1DEF("no-acpi", 0, QEMU_OPTION_no_acpi, 1327ad96090aSBlue Swirl "-no-acpi disable ACPI\n", QEMU_ARCH_I386) 13285824d651Sblueswir1STEXI 13295824d651Sblueswir1@item -no-acpi 13306616b2adSStefan Weil@findex -no-acpi 13315824d651Sblueswir1Disable ACPI (Advanced Configuration and Power Interface) support. Use 13325824d651Sblueswir1it if your guest OS complains about ACPI problems (PC target machine 13335824d651Sblueswir1only). 13345824d651Sblueswir1ETEXI 13355824d651Sblueswir1 13365824d651Sblueswir1DEF("no-hpet", 0, QEMU_OPTION_no_hpet, 1337ad96090aSBlue Swirl "-no-hpet disable HPET\n", QEMU_ARCH_I386) 13385824d651Sblueswir1STEXI 13395824d651Sblueswir1@item -no-hpet 13406616b2adSStefan Weil@findex -no-hpet 13415824d651Sblueswir1Disable HPET support. 13425824d651Sblueswir1ETEXI 13435824d651Sblueswir1 13445824d651Sblueswir1DEF("acpitable", HAS_ARG, QEMU_OPTION_acpitable, 1345104bf02eSMichael 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" 1346ad96090aSBlue Swirl " ACPI table description\n", QEMU_ARCH_I386) 13475824d651Sblueswir1STEXI 13485824d651Sblueswir1@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}]...] 13496616b2adSStefan Weil@findex -acpitable 13505824d651Sblueswir1Add ACPI table with specified header fields and context from specified files. 1351104bf02eSMichael TokarevFor file=, take whole ACPI table from the specified files, including all 1352104bf02eSMichael TokarevACPI headers (possible overridden by other options). 1353104bf02eSMichael TokarevFor data=, only data 1354104bf02eSMichael Tokarevportion of the table is used, all header information is specified in the 1355104bf02eSMichael Tokarevcommand line. 13565824d651Sblueswir1ETEXI 13575824d651Sblueswir1 1358b6f6e3d3SaliguoriDEF("smbios", HAS_ARG, QEMU_OPTION_smbios, 1359b6f6e3d3Saliguori "-smbios file=binary\n" 1360ca1a8a06SBruce Rogers " load SMBIOS entry from binary file\n" 136184351843SGabriel L. Somlo "-smbios type=0[,vendor=str][,version=str][,date=str][,release=%d.%d][,uefi=on|off]\n" 1362ca1a8a06SBruce Rogers " specify SMBIOS type 0 fields\n" 1363b6f6e3d3Saliguori "-smbios type=1[,manufacturer=str][,product=str][,version=str][,serial=str]\n" 1364b6f6e3d3Saliguori " [,uuid=uuid][,sku=str][,family=str]\n" 1365ad96090aSBlue Swirl " specify SMBIOS type 1 fields\n", QEMU_ARCH_I386) 1366b6f6e3d3SaliguoriSTEXI 1367b6f6e3d3Saliguori@item -smbios file=@var{binary} 13686616b2adSStefan Weil@findex -smbios 1369b6f6e3d3SaliguoriLoad SMBIOS entry from binary file. 1370b6f6e3d3Saliguori 137184351843SGabriel L. Somlo@item -smbios type=0[,vendor=@var{str}][,version=@var{str}][,date=@var{str}][,release=@var{%d.%d}][,uefi=on|off] 1372b6f6e3d3SaliguoriSpecify SMBIOS type 0 fields 1373b6f6e3d3Saliguori 1374b6f6e3d3Saliguori@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}] 1375b6f6e3d3SaliguoriSpecify SMBIOS type 1 fields 1376b6f6e3d3SaliguoriETEXI 1377b6f6e3d3Saliguori 13785824d651Sblueswir1STEXI 13795824d651Sblueswir1@end table 13805824d651Sblueswir1ETEXI 1381c70a01e4SMarkus ArmbrusterDEFHEADING() 13825824d651Sblueswir1 13835824d651Sblueswir1DEFHEADING(Network options:) 13845824d651Sblueswir1STEXI 13855824d651Sblueswir1@table @option 13865824d651Sblueswir1ETEXI 13875824d651Sblueswir1 1388ad196a9dSJan KiszkaHXCOMM Legacy slirp options (now moved to -net user): 1389ad196a9dSJan Kiszka#ifdef CONFIG_SLIRP 1390ad96090aSBlue SwirlDEF("tftp", HAS_ARG, QEMU_OPTION_tftp, "", QEMU_ARCH_ALL) 1391ad96090aSBlue SwirlDEF("bootp", HAS_ARG, QEMU_OPTION_bootp, "", QEMU_ARCH_ALL) 1392ad96090aSBlue SwirlDEF("redir", HAS_ARG, QEMU_OPTION_redir, "", QEMU_ARCH_ALL) 1393ad196a9dSJan Kiszka#ifndef _WIN32 1394ad96090aSBlue SwirlDEF("smb", HAS_ARG, QEMU_OPTION_smb, "", QEMU_ARCH_ALL) 1395ad196a9dSJan Kiszka#endif 1396ad196a9dSJan Kiszka#endif 1397ad196a9dSJan Kiszka 1398bab7944cSBlue SwirlDEF("net", HAS_ARG, QEMU_OPTION_net, 1399ffe6370cSMichael S. Tsirkin "-net nic[,vlan=n][,macaddr=mac][,model=type][,name=str][,addr=str][,vectors=v]\n" 14005824d651Sblueswir1 " create a new Network Interface Card and connect it to VLAN 'n'\n" 14015824d651Sblueswir1#ifdef CONFIG_SLIRP 1402c54ed5bcSJan Kiszka "-net user[,vlan=n][,name=str][,net=addr[/mask]][,host=addr][,restrict=on|off]\n" 140363d2960bSKlaus Stengel " [,hostname=host][,dhcpstart=addr][,dns=addr][,dnssearch=domain][,tftp=dir]\n" 140463d2960bSKlaus Stengel " [,bootfile=f][,hostfwd=rule][,guestfwd=rule]" 1405ad196a9dSJan Kiszka#ifndef _WIN32 1406c92ef6a2SJan Kiszka "[,smb=dir[,smbserver=addr]]\n" 1407ad196a9dSJan Kiszka#endif 1408ad196a9dSJan Kiszka " connect the user mode network stack to VLAN 'n', configure its\n" 1409ad196a9dSJan Kiszka " DHCP server and enabled optional services\n" 14105824d651Sblueswir1#endif 14115824d651Sblueswir1#ifdef _WIN32 14125824d651Sblueswir1 "-net tap[,vlan=n][,name=str],ifname=name\n" 14135824d651Sblueswir1 " connect the host TAP network interface to VLAN 'n'\n" 14145824d651Sblueswir1#else 1415ec396014SJason 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" 1416a7c36ee4SCorey Bryant " connect the host TAP network interface to VLAN 'n'\n" 1417a7c36ee4SCorey Bryant " use network scripts 'file' (default=" DEFAULT_NETWORK_SCRIPT ")\n" 1418a7c36ee4SCorey Bryant " to configure it and 'dfile' (default=" DEFAULT_NETWORK_DOWN_SCRIPT ")\n" 1419a7c36ee4SCorey Bryant " to deconfigure it\n" 1420ca1a8a06SBruce Rogers " use '[down]script=no' to disable script execution\n" 1421a7c36ee4SCorey Bryant " use network helper 'helper' (default=" DEFAULT_BRIDGE_HELPER ") to\n" 1422a7c36ee4SCorey Bryant " configure it\n" 14235824d651Sblueswir1 " use 'fd=h' to connect to an already opened TAP interface\n" 14242ca81baaSJason Wang " use 'fds=x:y:...:z' to connect to already opened multiqueue capable TAP interfaces\n" 1425ca1a8a06SBruce Rogers " use 'sndbuf=nbytes' to limit the size of the send buffer (the\n" 1426f157ed20SMichael S. Tsirkin " default is disabled 'sndbuf=0' to enable flow control set 'sndbuf=1048576')\n" 1427ca1a8a06SBruce Rogers " use vnet_hdr=off to avoid enabling the IFF_VNET_HDR tap flag\n" 1428ca1a8a06SBruce Rogers " use vnet_hdr=on to make the lack of IFF_VNET_HDR support an error condition\n" 142982b0d80eSMichael S. Tsirkin " use vhost=on to enable experimental in kernel accelerator\n" 14305430a28fSmst@redhat.com " (only has effect for virtio guests which use MSIX)\n" 14315430a28fSmst@redhat.com " use vhostforce=on to force vhost on for non-MSIX virtio guests\n" 143282b0d80eSMichael S. Tsirkin " use 'vhostfd=h' to connect to an already opened vhost net device\n" 14332ca81baaSJason Wang " use 'vhostfds=x:y:...:z to connect to multiple already opened vhost net devices\n" 1434ec396014SJason Wang " use 'queues=n' to specify the number of queues to be created for multiqueue TAP\n" 1435a7c36ee4SCorey Bryant "-net bridge[,vlan=n][,name=str][,br=bridge][,helper=helper]\n" 1436a7c36ee4SCorey Bryant " connects a host TAP network interface to a host bridge device 'br'\n" 1437a7c36ee4SCorey Bryant " (default=" DEFAULT_BRIDGE_INTERFACE ") using the program 'helper'\n" 1438a7c36ee4SCorey Bryant " (default=" DEFAULT_BRIDGE_HELPER ")\n" 14390df0ff6dSMark McLoughlin#endif 14403fb69aa1SAnton Ivanov#ifdef __linux__ 14413fb69aa1SAnton 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" 14423fb69aa1SAnton Ivanov " connect the VLAN to an Ethernet over L2TPv3 pseudowire\n" 14433fb69aa1SAnton Ivanov " Linux kernel 3.3+ as well as most routers can talk\n" 14442f47b403SMichael Tokarev " L2TPv3. This transport allows connecting a VM to a VM,\n" 14453fb69aa1SAnton Ivanov " VM to a router and even VM to Host. It is a nearly-universal\n" 14463fb69aa1SAnton Ivanov " standard (RFC3391). Note - this implementation uses static\n" 14473fb69aa1SAnton Ivanov " pre-configured tunnels (same as the Linux kernel).\n" 14483fb69aa1SAnton Ivanov " use 'src=' to specify source address\n" 14493fb69aa1SAnton Ivanov " use 'dst=' to specify destination address\n" 14503fb69aa1SAnton Ivanov " use 'udp=on' to specify udp encapsulation\n" 14513952651aSGonglei " use 'srcport=' to specify source udp port\n" 14523fb69aa1SAnton Ivanov " use 'dstport=' to specify destination udp port\n" 14533fb69aa1SAnton Ivanov " use 'ipv6=on' to force v6\n" 14543fb69aa1SAnton Ivanov " L2TPv3 uses cookies to prevent misconfiguration as\n" 14553fb69aa1SAnton Ivanov " well as a weak security measure\n" 14563fb69aa1SAnton Ivanov " use 'rxcookie=0x012345678' to specify a rxcookie\n" 14573fb69aa1SAnton Ivanov " use 'txcookie=0x012345678' to specify a txcookie\n" 14583fb69aa1SAnton Ivanov " use 'cookie64=on' to set cookie size to 64 bit, otherwise 32\n" 14593fb69aa1SAnton Ivanov " use 'counter=off' to force a 'cut-down' L2TPv3 with no counter\n" 14603fb69aa1SAnton Ivanov " use 'pincounter=on' to work around broken counter handling in peer\n" 14613fb69aa1SAnton Ivanov " use 'offset=X' to add an extra offset between header and data\n" 14623fb69aa1SAnton Ivanov#endif 14635824d651Sblueswir1 "-net socket[,vlan=n][,name=str][,fd=h][,listen=[host]:port][,connect=host:port]\n" 14645824d651Sblueswir1 " connect the vlan 'n' to another VLAN using a socket connection\n" 14653a75e74cSMike Ryan "-net socket[,vlan=n][,name=str][,fd=h][,mcast=maddr:port[,localaddr=addr]]\n" 14665824d651Sblueswir1 " connect the vlan 'n' to multicast maddr and port\n" 14673a75e74cSMike Ryan " use 'localaddr=addr' to specify the host address to send packets from\n" 14680e0e7facSBenjamin "-net socket[,vlan=n][,name=str][,fd=h][,udp=host:port][,localaddr=host:port]\n" 14690e0e7facSBenjamin " connect the vlan 'n' to another VLAN using an UDP tunnel\n" 14705824d651Sblueswir1#ifdef CONFIG_VDE 14715824d651Sblueswir1 "-net vde[,vlan=n][,name=str][,sock=socketpath][,port=n][,group=groupname][,mode=octalmode]\n" 14725824d651Sblueswir1 " connect the vlan 'n' to port 'n' of a vde switch running\n" 14735824d651Sblueswir1 " on host and listening for incoming connections on 'socketpath'.\n" 14745824d651Sblueswir1 " Use group 'groupname' and mode 'octalmode' to change default\n" 14755824d651Sblueswir1 " ownership and permissions for communication port.\n" 14765824d651Sblueswir1#endif 147758952137SVincenzo Maffione#ifdef CONFIG_NETMAP 147858952137SVincenzo Maffione "-net netmap,ifname=name[,devname=nmname]\n" 147958952137SVincenzo Maffione " attach to the existing netmap-enabled network interface 'name', or to a\n" 148058952137SVincenzo Maffione " VALE port (created on the fly) called 'name' ('nmname' is name of the \n" 148158952137SVincenzo Maffione " netmap device, defaults to '/dev/netmap')\n" 148258952137SVincenzo Maffione#endif 1483bb9ea79eSaliguori "-net dump[,vlan=n][,file=f][,len=n]\n" 1484bb9ea79eSaliguori " dump traffic on vlan 'n' to file 'f' (max n bytes per packet)\n" 1485ca1a8a06SBruce Rogers "-net none use it alone to have zero network devices. If no -net option\n" 1486ad96090aSBlue Swirl " is provided, the default is '-net nic -net user'\n", QEMU_ARCH_ALL) 1487a1ea458fSMark McLoughlinDEF("netdev", HAS_ARG, QEMU_OPTION_netdev, 1488a1ea458fSMark McLoughlin "-netdev [" 1489a1ea458fSMark McLoughlin#ifdef CONFIG_SLIRP 1490a1ea458fSMark McLoughlin "user|" 1491a1ea458fSMark McLoughlin#endif 1492a1ea458fSMark McLoughlin "tap|" 1493a7c36ee4SCorey Bryant "bridge|" 1494a1ea458fSMark McLoughlin#ifdef CONFIG_VDE 1495a1ea458fSMark McLoughlin "vde|" 1496a1ea458fSMark McLoughlin#endif 149758952137SVincenzo Maffione#ifdef CONFIG_NETMAP 149858952137SVincenzo Maffione "netmap|" 149958952137SVincenzo Maffione#endif 150003ce5744SNikolay Nikolaev "vhost-user|" 150140e8c26dSStefan Hajnoczi "socket|" 150240e8c26dSStefan Hajnoczi "hubport],id=str[,option][,option][,...]\n", QEMU_ARCH_ALL) 15035824d651Sblueswir1STEXI 1504ffe6370cSMichael S. Tsirkin@item -net nic[,vlan=@var{n}][,macaddr=@var{mac}][,model=@var{type}] [,name=@var{name}][,addr=@var{addr}][,vectors=@var{v}] 15056616b2adSStefan Weil@findex -net 15065824d651Sblueswir1Create a new Network Interface Card and connect it to VLAN @var{n} (@var{n} 15070d6b0b1dSAnthony Liguori= 0 is the default). The NIC is an e1000 by default on the PC 15085607c388SMarkus Armbrustertarget. Optionally, the MAC address can be changed to @var{mac}, the 15095607c388SMarkus Armbrusterdevice address set to @var{addr} (PCI cards only), 1510ffe6370cSMichael S. Tsirkinand a @var{name} can be assigned for use in monitor commands. 1511ffe6370cSMichael S. TsirkinOptionally, for PCI cards, you can specify the number @var{v} of MSI-X vectors 1512ffe6370cSMichael S. Tsirkinthat the card should have; this option currently only affects virtio cards; set 1513ffe6370cSMichael S. Tsirkin@var{v} = 0 to disable MSI-X. If no @option{-net} option is specified, a single 1514071c9394SStefan WeilNIC is created. QEMU can emulate several different models of network card. 15155824d651Sblueswir1Valid values for @var{type} are 1516ffe6370cSMichael S. Tsirkin@code{virtio}, @code{i82551}, @code{i82557b}, @code{i82559er}, 15175824d651Sblueswir1@code{ne2k_pci}, @code{ne2k_isa}, @code{pcnet}, @code{rtl8139}, 15185824d651Sblueswir1@code{e1000}, @code{smc91c111}, @code{lance} and @code{mcf_fec}. 1519585f6036SPeter MaydellNot all devices are supported on all targets. Use @code{-net nic,model=help} 15205824d651Sblueswir1for a list of available devices for your target. 15215824d651Sblueswir1 152208d12022SStefan Hajnoczi@item -netdev user,id=@var{id}[,@var{option}][,@var{option}][,...] 1523b8f490ebSMarkus Armbruster@findex -netdev 1524ad196a9dSJan Kiszka@item -net user[,@var{option}][,@var{option}][,...] 15255824d651Sblueswir1Use the user mode network stack which requires no administrator 1526ad196a9dSJan Kiszkaprivilege to run. Valid options are: 15275824d651Sblueswir1 1528b3f046c2SKevin Wolf@table @option 1529ad196a9dSJan Kiszka@item vlan=@var{n} 1530ad196a9dSJan KiszkaConnect user mode stack to VLAN @var{n} (@var{n} = 0 is the default). 1531ad196a9dSJan Kiszka 153208d12022SStefan Hajnoczi@item id=@var{id} 1533ad196a9dSJan Kiszka@item name=@var{name} 1534ad196a9dSJan KiszkaAssign symbolic name for use in monitor commands. 1535ad196a9dSJan Kiszka 1536c92ef6a2SJan Kiszka@item net=@var{addr}[/@var{mask}] 1537c92ef6a2SJan KiszkaSet IP network address the guest will see. Optionally specify the netmask, 1538c92ef6a2SJan Kiszkaeither in the form a.b.c.d or as number of valid top-most bits. Default is 1539b0b36e5dSBrad Hards10.0.2.0/24. 1540c92ef6a2SJan Kiszka 1541c92ef6a2SJan Kiszka@item host=@var{addr} 1542c92ef6a2SJan KiszkaSpecify the guest-visible address of the host. Default is the 2nd IP in the 1543c92ef6a2SJan Kiszkaguest network, i.e. x.x.x.2. 1544ad196a9dSJan Kiszka 1545c54ed5bcSJan Kiszka@item restrict=on|off 1546caef55edSBrad HardsIf this option is enabled, the guest will be isolated, i.e. it will not be 1547ad196a9dSJan Kiszkaable to contact the host and no guest IP packets will be routed over the host 1548caef55edSBrad Hardsto the outside. This option does not affect any explicitly set forwarding rules. 1549ad196a9dSJan Kiszka 1550ad196a9dSJan Kiszka@item hostname=@var{name} 155163d2960bSKlaus StengelSpecifies the client hostname reported by the built-in DHCP server. 1552ad196a9dSJan Kiszka 1553c92ef6a2SJan Kiszka@item dhcpstart=@var{addr} 1554c92ef6a2SJan KiszkaSpecify the first of the 16 IPs the built-in DHCP server can assign. Default 1555b0b36e5dSBrad Hardsis the 15th to 31st IP in the guest network, i.e. x.x.x.15 to x.x.x.31. 1556c92ef6a2SJan Kiszka 1557c92ef6a2SJan Kiszka@item dns=@var{addr} 1558c92ef6a2SJan KiszkaSpecify the guest-visible address of the virtual nameserver. The address must 1559c92ef6a2SJan Kiszkabe different from the host address. Default is the 3rd IP in the guest network, 1560c92ef6a2SJan Kiszkai.e. x.x.x.3. 1561c92ef6a2SJan Kiszka 156263d2960bSKlaus Stengel@item dnssearch=@var{domain} 156363d2960bSKlaus StengelProvides an entry for the domain-search list sent by the built-in 156463d2960bSKlaus StengelDHCP server. More than one domain suffix can be transmitted by specifying 156563d2960bSKlaus Stengelthis option multiple times. If supported, this will cause the guest to 156663d2960bSKlaus Stengelautomatically try to append the given domain suffix(es) in case a domain name 156763d2960bSKlaus Stengelcan not be resolved. 156863d2960bSKlaus Stengel 156963d2960bSKlaus StengelExample: 157063d2960bSKlaus Stengel@example 157163d2960bSKlaus Stengelqemu -net user,dnssearch=mgmt.example.org,dnssearch=example.org [...] 157263d2960bSKlaus Stengel@end example 157363d2960bSKlaus Stengel 1574ad196a9dSJan Kiszka@item tftp=@var{dir} 1575ad196a9dSJan KiszkaWhen using the user mode network stack, activate a built-in TFTP 1576ad196a9dSJan Kiszkaserver. The files in @var{dir} will be exposed as the root of a TFTP server. 1577ad196a9dSJan KiszkaThe TFTP client on the guest must be configured in binary mode (use the command 1578c92ef6a2SJan Kiszka@code{bin} of the Unix TFTP client). 1579ad196a9dSJan Kiszka 1580ad196a9dSJan Kiszka@item bootfile=@var{file} 1581ad196a9dSJan KiszkaWhen using the user mode network stack, broadcast @var{file} as the BOOTP 1582ad196a9dSJan Kiszkafilename. In conjunction with @option{tftp}, this can be used to network boot 1583ad196a9dSJan Kiszkaa guest from a local directory. 1584ad196a9dSJan Kiszka 1585ad196a9dSJan KiszkaExample (using pxelinux): 1586ad196a9dSJan Kiszka@example 15873804da9dSStefan Weilqemu-system-i386 -hda linux.img -boot n -net user,tftp=/path/to/tftp/files,bootfile=/pxelinux.0 1588ad196a9dSJan Kiszka@end example 1589ad196a9dSJan Kiszka 1590c92ef6a2SJan Kiszka@item smb=@var{dir}[,smbserver=@var{addr}] 1591ad196a9dSJan KiszkaWhen using the user mode network stack, activate a built-in SMB 1592ad196a9dSJan Kiszkaserver so that Windows OSes can access to the host files in @file{@var{dir}} 1593c92ef6a2SJan Kiszkatransparently. The IP address of the SMB server can be set to @var{addr}. By 1594c92ef6a2SJan Kiszkadefault the 4th IP in the guest network is used, i.e. x.x.x.4. 1595ad196a9dSJan Kiszka 1596ad196a9dSJan KiszkaIn the guest Windows OS, the line: 1597ad196a9dSJan Kiszka@example 1598ad196a9dSJan Kiszka10.0.2.4 smbserver 1599ad196a9dSJan Kiszka@end example 1600ad196a9dSJan Kiszkamust be added in the file @file{C:\WINDOWS\LMHOSTS} (for windows 9x/Me) 1601ad196a9dSJan Kiszkaor @file{C:\WINNT\SYSTEM32\DRIVERS\ETC\LMHOSTS} (Windows NT/2000). 1602ad196a9dSJan Kiszka 1603ad196a9dSJan KiszkaThen @file{@var{dir}} can be accessed in @file{\\smbserver\qemu}. 1604ad196a9dSJan Kiszka 1605e2d8830eSBradNote that a SAMBA server must be installed on the host OS. 1606e2d8830eSBradQEMU was tested successfully with smbd versions from Red Hat 9, 1607e2d8830eSBradFedora Core 3 and OpenSUSE 11.x. 1608ad196a9dSJan Kiszka 16093c6a0580SJan Kiszka@item hostfwd=[tcp|udp]:[@var{hostaddr}]:@var{hostport}-[@var{guestaddr}]:@var{guestport} 1610c92ef6a2SJan KiszkaRedirect incoming TCP or UDP connections to the host port @var{hostport} to 1611c92ef6a2SJan Kiszkathe guest IP address @var{guestaddr} on guest port @var{guestport}. If 1612c92ef6a2SJan Kiszka@var{guestaddr} is not specified, its value is x.x.x.15 (default first address 16133c6a0580SJan Kiszkagiven by the built-in DHCP server). By specifying @var{hostaddr}, the rule can 16143c6a0580SJan Kiszkabe bound to a specific host interface. If no connection type is set, TCP is 1615c92ef6a2SJan Kiszkaused. This option can be given multiple times. 1616ad196a9dSJan Kiszka 1617ad196a9dSJan KiszkaFor example, to redirect host X11 connection from screen 1 to guest 1618ad196a9dSJan Kiszkascreen 0, use the following: 1619ad196a9dSJan Kiszka 1620ad196a9dSJan Kiszka@example 1621ad196a9dSJan Kiszka# on the host 16223804da9dSStefan Weilqemu-system-i386 -net user,hostfwd=tcp:127.0.0.1:6001-:6000 [...] 1623ad196a9dSJan Kiszka# this host xterm should open in the guest X11 server 1624ad196a9dSJan Kiszkaxterm -display :1 1625ad196a9dSJan Kiszka@end example 1626ad196a9dSJan Kiszka 1627ad196a9dSJan KiszkaTo redirect telnet connections from host port 5555 to telnet port on 1628ad196a9dSJan Kiszkathe guest, use the following: 1629ad196a9dSJan Kiszka 1630ad196a9dSJan Kiszka@example 1631ad196a9dSJan Kiszka# on the host 16323804da9dSStefan Weilqemu-system-i386 -net user,hostfwd=tcp::5555-:23 [...] 1633ad196a9dSJan Kiszkatelnet localhost 5555 1634ad196a9dSJan Kiszka@end example 1635ad196a9dSJan Kiszka 1636ad196a9dSJan KiszkaThen when you use on the host @code{telnet localhost 5555}, you 1637ad196a9dSJan Kiszkaconnect to the guest telnet server. 1638ad196a9dSJan Kiszka 1639c92ef6a2SJan Kiszka@item guestfwd=[tcp]:@var{server}:@var{port}-@var{dev} 1640b412eb61SAlexander Graf@item guestfwd=[tcp]:@var{server}:@var{port}-@var{cmd:command} 16413c6a0580SJan KiszkaForward guest TCP connections to the IP address @var{server} on port @var{port} 1642b412eb61SAlexander Grafto the character device @var{dev} or to a program executed by @var{cmd:command} 1643b412eb61SAlexander Grafwhich gets spawned for each connection. This option can be given multiple times. 1644b412eb61SAlexander Graf 164543ffe61fSStefan WeilYou can either use a chardev directly and have that one used throughout QEMU's 1646b412eb61SAlexander Graflifetime, like in the following example: 1647b412eb61SAlexander Graf 1648b412eb61SAlexander Graf@example 1649b412eb61SAlexander Graf# open 10.10.1.1:4321 on bootup, connect 10.0.2.100:1234 to it whenever 1650b412eb61SAlexander Graf# the guest accesses it 1651b412eb61SAlexander Grafqemu -net user,guestfwd=tcp:10.0.2.100:1234-tcp:10.10.1.1:4321 [...] 1652b412eb61SAlexander Graf@end example 1653b412eb61SAlexander Graf 1654b412eb61SAlexander GrafOr you can execute a command on every TCP connection established by the guest, 165543ffe61fSStefan Weilso that QEMU behaves similar to an inetd process for that virtual server: 1656b412eb61SAlexander Graf 1657b412eb61SAlexander Graf@example 1658b412eb61SAlexander Graf# call "netcat 10.10.1.1 4321" on every TCP connection to 10.0.2.100:1234 1659b412eb61SAlexander Graf# and connect the TCP stream to its stdin/stdout 1660b412eb61SAlexander Grafqemu -net 'user,guestfwd=tcp:10.0.2.100:1234-cmd:netcat 10.10.1.1 4321' 1661b412eb61SAlexander Graf@end example 1662ad196a9dSJan Kiszka 1663ad196a9dSJan Kiszka@end table 1664ad196a9dSJan Kiszka 1665ad196a9dSJan KiszkaNote: Legacy stand-alone options -tftp, -bootp, -smb and -redir are still 1666ad196a9dSJan Kiszkaprocessed and applied to -net user. Mixing them with the new configuration 1667ad196a9dSJan Kiszkasyntax gives undefined results. Their use for new applications is discouraged 1668ad196a9dSJan Kiszkaas they will be removed from future versions. 16695824d651Sblueswir1 167008d12022SStefan Hajnoczi@item -netdev tap,id=@var{id}[,fd=@var{h}][,ifname=@var{name}][,script=@var{file}][,downscript=@var{dfile}][,helper=@var{helper}] 1671a7c36ee4SCorey 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}] 1672a7c36ee4SCorey BryantConnect the host TAP network interface @var{name} to VLAN @var{n}. 1673a7c36ee4SCorey Bryant 1674a7c36ee4SCorey BryantUse the network script @var{file} to configure it and the network script 16755824d651Sblueswir1@var{dfile} to deconfigure it. If @var{name} is not provided, the OS 1676a7c36ee4SCorey Bryantautomatically provides one. The default network configure script is 1677a7c36ee4SCorey Bryant@file{/etc/qemu-ifup} and the default network deconfigure script is 1678a7c36ee4SCorey Bryant@file{/etc/qemu-ifdown}. Use @option{script=no} or @option{downscript=no} 1679a7c36ee4SCorey Bryantto disable script execution. 1680a7c36ee4SCorey Bryant 1681a7c36ee4SCorey BryantIf running QEMU as an unprivileged user, use the network helper 1682a7c36ee4SCorey Bryant@var{helper} to configure the TAP interface. The default network 1683420508fbSAmos Konghelper executable is @file{/path/to/qemu-bridge-helper}. 1684a7c36ee4SCorey Bryant 1685a7c36ee4SCorey Bryant@option{fd}=@var{h} can be used to specify the handle of an already 1686a7c36ee4SCorey Bryantopened host TAP interface. 1687a7c36ee4SCorey Bryant 1688a7c36ee4SCorey BryantExamples: 16895824d651Sblueswir1 16905824d651Sblueswir1@example 1691a7c36ee4SCorey Bryant#launch a QEMU instance with the default network script 16923804da9dSStefan Weilqemu-system-i386 linux.img -net nic -net tap 16935824d651Sblueswir1@end example 16945824d651Sblueswir1 16955824d651Sblueswir1@example 1696a7c36ee4SCorey Bryant#launch a QEMU instance with two NICs, each one connected 1697a7c36ee4SCorey Bryant#to a TAP device 16983804da9dSStefan Weilqemu-system-i386 linux.img \ 16993804da9dSStefan Weil -net nic,vlan=0 -net tap,vlan=0,ifname=tap0 \ 17005824d651Sblueswir1 -net nic,vlan=1 -net tap,vlan=1,ifname=tap1 17015824d651Sblueswir1@end example 17025824d651Sblueswir1 1703a7c36ee4SCorey Bryant@example 1704a7c36ee4SCorey Bryant#launch a QEMU instance with the default network helper to 1705a7c36ee4SCorey Bryant#connect a TAP device to bridge br0 17063804da9dSStefan Weilqemu-system-i386 linux.img \ 1707420508fbSAmos Kong -net nic -net tap,"helper=/path/to/qemu-bridge-helper" 1708a7c36ee4SCorey Bryant@end example 1709a7c36ee4SCorey Bryant 171008d12022SStefan Hajnoczi@item -netdev bridge,id=@var{id}[,br=@var{bridge}][,helper=@var{helper}] 1711a7c36ee4SCorey Bryant@item -net bridge[,vlan=@var{n}][,name=@var{name}][,br=@var{bridge}][,helper=@var{helper}] 1712a7c36ee4SCorey BryantConnect a host TAP network interface to a host bridge device. 1713a7c36ee4SCorey Bryant 1714a7c36ee4SCorey BryantUse the network helper @var{helper} to configure the TAP interface and 1715a7c36ee4SCorey Bryantattach it to the bridge. The default network helper executable is 1716420508fbSAmos Kong@file{/path/to/qemu-bridge-helper} and the default bridge 1717a7c36ee4SCorey Bryantdevice is @file{br0}. 1718a7c36ee4SCorey Bryant 1719a7c36ee4SCorey BryantExamples: 1720a7c36ee4SCorey Bryant 1721a7c36ee4SCorey Bryant@example 1722a7c36ee4SCorey Bryant#launch a QEMU instance with the default network helper to 1723a7c36ee4SCorey Bryant#connect a TAP device to bridge br0 17243804da9dSStefan Weilqemu-system-i386 linux.img -net bridge -net nic,model=virtio 1725a7c36ee4SCorey Bryant@end example 1726a7c36ee4SCorey Bryant 1727a7c36ee4SCorey Bryant@example 1728a7c36ee4SCorey Bryant#launch a QEMU instance with the default network helper to 1729a7c36ee4SCorey Bryant#connect a TAP device to bridge qemubr0 17303804da9dSStefan Weilqemu-system-i386 linux.img -net bridge,br=qemubr0 -net nic,model=virtio 1731a7c36ee4SCorey Bryant@end example 1732a7c36ee4SCorey Bryant 173308d12022SStefan Hajnoczi@item -netdev socket,id=@var{id}[,fd=@var{h}][,listen=[@var{host}]:@var{port}][,connect=@var{host}:@var{port}] 17345824d651Sblueswir1@item -net socket[,vlan=@var{n}][,name=@var{name}][,fd=@var{h}] [,listen=[@var{host}]:@var{port}][,connect=@var{host}:@var{port}] 17355824d651Sblueswir1 17365824d651Sblueswir1Connect the VLAN @var{n} to a remote VLAN in another QEMU virtual 17375824d651Sblueswir1machine using a TCP socket connection. If @option{listen} is 17385824d651Sblueswir1specified, QEMU waits for incoming connections on @var{port} 17395824d651Sblueswir1(@var{host} is optional). @option{connect} is used to connect to 17405824d651Sblueswir1another QEMU instance using the @option{listen} option. @option{fd}=@var{h} 17415824d651Sblueswir1specifies an already opened TCP socket. 17425824d651Sblueswir1 17435824d651Sblueswir1Example: 17445824d651Sblueswir1@example 17455824d651Sblueswir1# launch a first QEMU instance 17463804da9dSStefan Weilqemu-system-i386 linux.img \ 17473804da9dSStefan Weil -net nic,macaddr=52:54:00:12:34:56 \ 17485824d651Sblueswir1 -net socket,listen=:1234 17495824d651Sblueswir1# connect the VLAN 0 of this instance to the VLAN 0 17505824d651Sblueswir1# of the first instance 17513804da9dSStefan Weilqemu-system-i386 linux.img \ 17523804da9dSStefan Weil -net nic,macaddr=52:54:00:12:34:57 \ 17535824d651Sblueswir1 -net socket,connect=127.0.0.1:1234 17545824d651Sblueswir1@end example 17555824d651Sblueswir1 175608d12022SStefan Hajnoczi@item -netdev socket,id=@var{id}[,fd=@var{h}][,mcast=@var{maddr}:@var{port}[,localaddr=@var{addr}]] 17573a75e74cSMike Ryan@item -net socket[,vlan=@var{n}][,name=@var{name}][,fd=@var{h}][,mcast=@var{maddr}:@var{port}[,localaddr=@var{addr}]] 17585824d651Sblueswir1 17595824d651Sblueswir1Create a VLAN @var{n} shared with another QEMU virtual 17605824d651Sblueswir1machines using a UDP multicast socket, effectively making a bus for 17615824d651Sblueswir1every QEMU with same multicast address @var{maddr} and @var{port}. 17625824d651Sblueswir1NOTES: 17635824d651Sblueswir1@enumerate 17645824d651Sblueswir1@item 17655824d651Sblueswir1Several QEMU can be running on different hosts and share same bus (assuming 17665824d651Sblueswir1correct multicast setup for these hosts). 17675824d651Sblueswir1@item 17685824d651Sblueswir1mcast support is compatible with User Mode Linux (argument @option{eth@var{N}=mcast}), see 17695824d651Sblueswir1@url{http://user-mode-linux.sf.net}. 17705824d651Sblueswir1@item 17715824d651Sblueswir1Use @option{fd=h} to specify an already opened UDP multicast socket. 17725824d651Sblueswir1@end enumerate 17735824d651Sblueswir1 17745824d651Sblueswir1Example: 17755824d651Sblueswir1@example 17765824d651Sblueswir1# launch one QEMU instance 17773804da9dSStefan Weilqemu-system-i386 linux.img \ 17783804da9dSStefan Weil -net nic,macaddr=52:54:00:12:34:56 \ 17795824d651Sblueswir1 -net socket,mcast=230.0.0.1:1234 17805824d651Sblueswir1# launch another QEMU instance on same "bus" 17813804da9dSStefan Weilqemu-system-i386 linux.img \ 17823804da9dSStefan Weil -net nic,macaddr=52:54:00:12:34:57 \ 17835824d651Sblueswir1 -net socket,mcast=230.0.0.1:1234 17845824d651Sblueswir1# launch yet another QEMU instance on same "bus" 17853804da9dSStefan Weilqemu-system-i386 linux.img \ 17863804da9dSStefan Weil -net nic,macaddr=52:54:00:12:34:58 \ 17875824d651Sblueswir1 -net socket,mcast=230.0.0.1:1234 17885824d651Sblueswir1@end example 17895824d651Sblueswir1 17905824d651Sblueswir1Example (User Mode Linux compat.): 17915824d651Sblueswir1@example 17925824d651Sblueswir1# launch QEMU instance (note mcast address selected 17935824d651Sblueswir1# is UML's default) 17943804da9dSStefan Weilqemu-system-i386 linux.img \ 17953804da9dSStefan Weil -net nic,macaddr=52:54:00:12:34:56 \ 17965824d651Sblueswir1 -net socket,mcast=239.192.168.1:1102 17975824d651Sblueswir1# launch UML 17985824d651Sblueswir1/path/to/linux ubd0=/path/to/root_fs eth0=mcast 17995824d651Sblueswir1@end example 18005824d651Sblueswir1 18013a75e74cSMike RyanExample (send packets from host's 1.2.3.4): 18023a75e74cSMike Ryan@example 18033804da9dSStefan Weilqemu-system-i386 linux.img \ 18043804da9dSStefan Weil -net nic,macaddr=52:54:00:12:34:56 \ 18053a75e74cSMike Ryan -net socket,mcast=239.192.168.1:1102,localaddr=1.2.3.4 18063a75e74cSMike Ryan@end example 18073a75e74cSMike Ryan 18083fb69aa1SAnton 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}] 18093fb69aa1SAnton 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}] 18103fb69aa1SAnton IvanovConnect VLAN @var{n} to L2TPv3 pseudowire. L2TPv3 (RFC3391) is a popular 18113fb69aa1SAnton Ivanovprotocol to transport Ethernet (and other Layer 2) data frames between 18123fb69aa1SAnton Ivanovtwo systems. It is present in routers, firewalls and the Linux kernel 18133fb69aa1SAnton Ivanov(from version 3.3 onwards). 18143fb69aa1SAnton Ivanov 18153fb69aa1SAnton IvanovThis transport allows a VM to communicate to another VM, router or firewall directly. 18163fb69aa1SAnton Ivanov 18173fb69aa1SAnton Ivanov@item src=@var{srcaddr} 18183fb69aa1SAnton Ivanov source address (mandatory) 18193fb69aa1SAnton Ivanov@item dst=@var{dstaddr} 18203fb69aa1SAnton Ivanov destination address (mandatory) 18213fb69aa1SAnton Ivanov@item udp 18223fb69aa1SAnton Ivanov select udp encapsulation (default is ip). 18233fb69aa1SAnton Ivanov@item srcport=@var{srcport} 18243fb69aa1SAnton Ivanov source udp port. 18253fb69aa1SAnton Ivanov@item dstport=@var{dstport} 18263fb69aa1SAnton Ivanov destination udp port. 18273fb69aa1SAnton Ivanov@item ipv6 18283fb69aa1SAnton Ivanov force v6, otherwise defaults to v4. 18293fb69aa1SAnton Ivanov@item rxcookie=@var{rxcookie} 18303fb69aa1SAnton Ivanov@item txcookie=@var{txcookie} 18313fb69aa1SAnton Ivanov Cookies are a weak form of security in the l2tpv3 specification. 18323fb69aa1SAnton IvanovTheir function is mostly to prevent misconfiguration. By default they are 32 18333fb69aa1SAnton Ivanovbit. 18343fb69aa1SAnton Ivanov@item cookie64 18353fb69aa1SAnton Ivanov Set cookie size to 64 bit instead of the default 32 18363fb69aa1SAnton Ivanov@item counter=off 18373fb69aa1SAnton Ivanov Force a 'cut-down' L2TPv3 with no counter as in 18383fb69aa1SAnton Ivanovdraft-mkonstan-l2tpext-keyed-ipv6-tunnel-00 18393fb69aa1SAnton Ivanov@item pincounter=on 18403fb69aa1SAnton Ivanov Work around broken counter handling in peer. This may also help on 18413fb69aa1SAnton Ivanovnetworks which have packet reorder. 18423fb69aa1SAnton Ivanov@item offset=@var{offset} 18433fb69aa1SAnton Ivanov Add an extra offset between header and data 18443fb69aa1SAnton Ivanov 18453fb69aa1SAnton IvanovFor example, to attach a VM running on host 4.3.2.1 via L2TPv3 to the bridge br-lan 18463fb69aa1SAnton Ivanovon the remote Linux host 1.2.3.4: 18473fb69aa1SAnton Ivanov@example 18483fb69aa1SAnton Ivanov# Setup tunnel on linux host using raw ip as encapsulation 18493fb69aa1SAnton Ivanov# on 1.2.3.4 18503fb69aa1SAnton Ivanovip l2tp add tunnel remote 4.3.2.1 local 1.2.3.4 tunnel_id 1 peer_tunnel_id 1 \ 18513fb69aa1SAnton Ivanov encap udp udp_sport 16384 udp_dport 16384 18523fb69aa1SAnton Ivanovip l2tp add session tunnel_id 1 name vmtunnel0 session_id \ 18533fb69aa1SAnton Ivanov 0xFFFFFFFF peer_session_id 0xFFFFFFFF 18543fb69aa1SAnton Ivanovifconfig vmtunnel0 mtu 1500 18553fb69aa1SAnton Ivanovifconfig vmtunnel0 up 18563fb69aa1SAnton Ivanovbrctl addif br-lan vmtunnel0 18573fb69aa1SAnton Ivanov 18583fb69aa1SAnton Ivanov 18593fb69aa1SAnton Ivanov# on 4.3.2.1 18603fb69aa1SAnton Ivanov# launch QEMU instance - if your network has reorder or is very lossy add ,pincounter 18613fb69aa1SAnton Ivanov 18623fb69aa1SAnton 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 18633fb69aa1SAnton Ivanov 18643fb69aa1SAnton Ivanov 18653fb69aa1SAnton Ivanov@end example 18663fb69aa1SAnton Ivanov 186708d12022SStefan Hajnoczi@item -netdev vde,id=@var{id}[,sock=@var{socketpath}][,port=@var{n}][,group=@var{groupname}][,mode=@var{octalmode}] 18685824d651Sblueswir1@item -net vde[,vlan=@var{n}][,name=@var{name}][,sock=@var{socketpath}] [,port=@var{n}][,group=@var{groupname}][,mode=@var{octalmode}] 18695824d651Sblueswir1Connect VLAN @var{n} to PORT @var{n} of a vde switch running on host and 18705824d651Sblueswir1listening for incoming connections on @var{socketpath}. Use GROUP @var{groupname} 18715824d651Sblueswir1and MODE @var{octalmode} to change default ownership and permissions for 1872c1ba4e0bSStefan Weilcommunication port. This option is only available if QEMU has been compiled 18735824d651Sblueswir1with vde support enabled. 18745824d651Sblueswir1 18755824d651Sblueswir1Example: 18765824d651Sblueswir1@example 18775824d651Sblueswir1# launch vde switch 18785824d651Sblueswir1vde_switch -F -sock /tmp/myswitch 18795824d651Sblueswir1# launch QEMU instance 18803804da9dSStefan Weilqemu-system-i386 linux.img -net nic -net vde,sock=/tmp/myswitch 18815824d651Sblueswir1@end example 18825824d651Sblueswir1 188340e8c26dSStefan Hajnoczi@item -netdev hubport,id=@var{id},hubid=@var{hubid} 188440e8c26dSStefan Hajnoczi 188540e8c26dSStefan HajnocziCreate a hub port on QEMU "vlan" @var{hubid}. 188640e8c26dSStefan Hajnoczi 188740e8c26dSStefan HajnocziThe hubport netdev lets you connect a NIC to a QEMU "vlan" instead of a single 188840e8c26dSStefan Hajnoczinetdev. @code{-net} and @code{-device} with parameter @option{vlan} create the 188940e8c26dSStefan Hajnoczirequired hub automatically. 189040e8c26dSStefan Hajnoczi 189103ce5744SNikolay Nikolaev@item -netdev vhost-user,chardev=@var{id}[,vhostforce=on|off] 189203ce5744SNikolay Nikolaev 189303ce5744SNikolay NikolaevEstablish a vhost-user netdev, backed by a chardev @var{id}. The chardev should 189403ce5744SNikolay Nikolaevbe a unix domain socket backed one. The vhost-user uses a specifically defined 189503ce5744SNikolay Nikolaevprotocol to pass vhost ioctl replacement messages to an application on the other 189603ce5744SNikolay Nikolaevend of the socket. On non-MSIX guests, the feature can be forced with 189703ce5744SNikolay Nikolaev@var{vhostforce}. 189803ce5744SNikolay Nikolaev 189903ce5744SNikolay NikolaevExample: 190003ce5744SNikolay Nikolaev@example 190103ce5744SNikolay Nikolaevqemu -m 512 -object memory-backend-file,id=mem,size=512M,mem-path=/hugetlbfs,share=on \ 190203ce5744SNikolay Nikolaev -numa node,memdev=mem \ 190303ce5744SNikolay Nikolaev -chardev socket,path=/path/to/socket \ 190403ce5744SNikolay Nikolaev -netdev type=vhost-user,id=net0,chardev=chr0 \ 190503ce5744SNikolay Nikolaev -device virtio-net-pci,netdev=net0 190603ce5744SNikolay Nikolaev@end example 190703ce5744SNikolay Nikolaev 1908bb9ea79eSaliguori@item -net dump[,vlan=@var{n}][,file=@var{file}][,len=@var{len}] 1909bb9ea79eSaliguoriDump network traffic on VLAN @var{n} to file @var{file} (@file{qemu-vlan0.pcap} by default). 1910bb9ea79eSaliguoriAt most @var{len} bytes (64k by default) per packet are stored. The file format is 1911bb9ea79eSaliguorilibpcap, so it can be analyzed with tools such as tcpdump or Wireshark. 1912bb9ea79eSaliguori 19135824d651Sblueswir1@item -net none 19145824d651Sblueswir1Indicate that no network devices should be configured. It is used to 19155824d651Sblueswir1override the default configuration (@option{-net nic -net user}) which 19165824d651Sblueswir1is activated if no @option{-net} options are provided. 19175824d651Sblueswir1ETEXI 19185824d651Sblueswir1 1919c70a01e4SMarkus ArmbrusterSTEXI 1920c70a01e4SMarkus Armbruster@end table 1921c70a01e4SMarkus ArmbrusterETEXI 19227273a2dbSMatthew BoothDEFHEADING() 19237273a2dbSMatthew Booth 19247273a2dbSMatthew BoothDEFHEADING(Character device options:) 1925c70a01e4SMarkus ArmbrusterSTEXI 1926c70a01e4SMarkus Armbruster 1927c70a01e4SMarkus ArmbrusterThe general form of a character device option is: 1928c70a01e4SMarkus Armbruster@table @option 1929c70a01e4SMarkus ArmbrusterETEXI 19307273a2dbSMatthew Booth 19317273a2dbSMatthew BoothDEF("chardev", HAS_ARG, QEMU_OPTION_chardev, 193297331287SJan Kiszka "-chardev null,id=id[,mux=on|off]\n" 19335dd1f02bSCorey Minyard "-chardev socket,id=id[,host=host],port=port[,to=to][,ipv4][,ipv6][,nodelay][,reconnect=seconds]\n" 19345dd1f02bSCorey Minyard " [,server][,nowait][,telnet][,reconnect=seconds][,mux=on|off] (tcp)\n" 19355dd1f02bSCorey Minyard "-chardev socket,id=id,path=path[,server][,nowait][,telnet][,reconnect=seconds][,mux=on|off] (unix)\n" 19367273a2dbSMatthew Booth "-chardev udp,id=id[,host=host],port=port[,localaddr=localaddr]\n" 193797331287SJan Kiszka " [,localport=localport][,ipv4][,ipv6][,mux=on|off]\n" 193897331287SJan Kiszka "-chardev msmouse,id=id[,mux=on|off]\n" 19397273a2dbSMatthew Booth "-chardev vc,id=id[[,width=width][,height=height]][[,cols=cols][,rows=rows]]\n" 194097331287SJan Kiszka " [,mux=on|off]\n" 19414f57378fSMarkus Armbruster "-chardev ringbuf,id=id[,size=size]\n" 194297331287SJan Kiszka "-chardev file,id=id,path=path[,mux=on|off]\n" 194397331287SJan Kiszka "-chardev pipe,id=id,path=path[,mux=on|off]\n" 19447273a2dbSMatthew Booth#ifdef _WIN32 194597331287SJan Kiszka "-chardev console,id=id[,mux=on|off]\n" 194697331287SJan Kiszka "-chardev serial,id=id,path=path[,mux=on|off]\n" 19477273a2dbSMatthew Booth#else 194897331287SJan Kiszka "-chardev pty,id=id[,mux=on|off]\n" 1949b7fdb3abSAurelien Jarno "-chardev stdio,id=id[,mux=on|off][,signal=on|off]\n" 19507273a2dbSMatthew Booth#endif 19517273a2dbSMatthew Booth#ifdef CONFIG_BRLAPI 195297331287SJan Kiszka "-chardev braille,id=id[,mux=on|off]\n" 19537273a2dbSMatthew Booth#endif 19547273a2dbSMatthew Booth#if defined(__linux__) || defined(__sun__) || defined(__FreeBSD__) \ 19557273a2dbSMatthew Booth || defined(__NetBSD__) || defined(__OpenBSD__) || defined(__DragonFly__) 1956d59044efSGerd Hoffmann "-chardev serial,id=id,path=path[,mux=on|off]\n" 195797331287SJan Kiszka "-chardev tty,id=id,path=path[,mux=on|off]\n" 19587273a2dbSMatthew Booth#endif 19597273a2dbSMatthew Booth#if defined(__linux__) || defined(__FreeBSD__) || defined(__DragonFly__) 196088a946d3SGerd Hoffmann "-chardev parallel,id=id,path=path[,mux=on|off]\n" 196197331287SJan Kiszka "-chardev parport,id=id,path=path[,mux=on|off]\n" 19627273a2dbSMatthew Booth#endif 1963cbcc6336SAlon Levy#if defined(CONFIG_SPICE) 1964cbcc6336SAlon Levy "-chardev spicevmc,id=id,name=name[,debug=debug]\n" 19655a49d3e9SMarc-André Lureau "-chardev spiceport,id=id,name=name[,debug=debug]\n" 1966cbcc6336SAlon Levy#endif 1967ad96090aSBlue Swirl , QEMU_ARCH_ALL 19687273a2dbSMatthew Booth) 19697273a2dbSMatthew Booth 19707273a2dbSMatthew BoothSTEXI 197197331287SJan Kiszka@item -chardev @var{backend} ,id=@var{id} [,mux=on|off] [,@var{options}] 19726616b2adSStefan Weil@findex -chardev 19737273a2dbSMatthew BoothBackend is one of: 19747273a2dbSMatthew Booth@option{null}, 19757273a2dbSMatthew Booth@option{socket}, 19767273a2dbSMatthew Booth@option{udp}, 19777273a2dbSMatthew Booth@option{msmouse}, 19787273a2dbSMatthew Booth@option{vc}, 19794f57378fSMarkus Armbruster@option{ringbuf}, 19807273a2dbSMatthew Booth@option{file}, 19817273a2dbSMatthew Booth@option{pipe}, 19827273a2dbSMatthew Booth@option{console}, 19837273a2dbSMatthew Booth@option{serial}, 19847273a2dbSMatthew Booth@option{pty}, 19857273a2dbSMatthew Booth@option{stdio}, 19867273a2dbSMatthew Booth@option{braille}, 19877273a2dbSMatthew Booth@option{tty}, 198888a946d3SGerd Hoffmann@option{parallel}, 1989cbcc6336SAlon Levy@option{parport}, 1990cbcc6336SAlon Levy@option{spicevmc}. 19915a49d3e9SMarc-André Lureau@option{spiceport}. 19927273a2dbSMatthew BoothThe specific backend will determine the applicable options. 19937273a2dbSMatthew Booth 19947273a2dbSMatthew BoothAll devices must have an id, which can be any string up to 127 characters long. 19957273a2dbSMatthew BoothIt is used to uniquely identify this device in other command line directives. 19967273a2dbSMatthew Booth 199797331287SJan KiszkaA character device may be used in multiplexing mode by multiple front-ends. 199897331287SJan KiszkaThe key sequence of @key{Control-a} and @key{c} will rotate the input focus 199997331287SJan Kiszkabetween attached front-ends. Specify @option{mux=on} to enable this mode. 200097331287SJan Kiszka 20017273a2dbSMatthew BoothOptions to each backend are described below. 20027273a2dbSMatthew Booth 20037273a2dbSMatthew Booth@item -chardev null ,id=@var{id} 20047273a2dbSMatthew BoothA void device. This device will not emit any data, and will drop any data it 20057273a2dbSMatthew Boothreceives. The null backend does not take any options. 20067273a2dbSMatthew Booth 20075dd1f02bSCorey Minyard@item -chardev socket ,id=@var{id} [@var{TCP options} or @var{unix options}] [,server] [,nowait] [,telnet] [,reconnect=@var{seconds}] 20087273a2dbSMatthew Booth 20097273a2dbSMatthew BoothCreate a two-way stream socket, which can be either a TCP or a unix socket. A 20107273a2dbSMatthew Boothunix socket will be created if @option{path} is specified. Behaviour is 20117273a2dbSMatthew Boothundefined if TCP options are specified for a unix socket. 20127273a2dbSMatthew Booth 20137273a2dbSMatthew Booth@option{server} specifies that the socket shall be a listening socket. 20147273a2dbSMatthew Booth 20157273a2dbSMatthew Booth@option{nowait} specifies that QEMU should not block waiting for a client to 20167273a2dbSMatthew Boothconnect to a listening socket. 20177273a2dbSMatthew Booth 20187273a2dbSMatthew Booth@option{telnet} specifies that traffic on the socket should interpret telnet 20197273a2dbSMatthew Boothescape sequences. 20207273a2dbSMatthew Booth 20215dd1f02bSCorey Minyard@option{reconnect} sets the timeout for reconnecting on non-server sockets when 20225dd1f02bSCorey Minyardthe remote end goes away. qemu will delay this many seconds and then attempt 20235dd1f02bSCorey Minyardto reconnect. Zero disables reconnecting, and is the default. 20245dd1f02bSCorey Minyard 20257273a2dbSMatthew BoothTCP and unix socket options are given below: 20267273a2dbSMatthew Booth 20277273a2dbSMatthew Booth@table @option 20287273a2dbSMatthew Booth 20298d533561SAurelien Jarno@item TCP options: port=@var{port} [,host=@var{host}] [,to=@var{to}] [,ipv4] [,ipv6] [,nodelay] 20307273a2dbSMatthew Booth 20317273a2dbSMatthew Booth@option{host} for a listening socket specifies the local address to be bound. 20327273a2dbSMatthew BoothFor a connecting socket species the remote host to connect to. @option{host} is 20337273a2dbSMatthew Boothoptional for listening sockets. If not specified it defaults to @code{0.0.0.0}. 20347273a2dbSMatthew Booth 20357273a2dbSMatthew Booth@option{port} for a listening socket specifies the local port to be bound. For a 20367273a2dbSMatthew Boothconnecting socket specifies the port on the remote host to connect to. 20377273a2dbSMatthew Booth@option{port} can be given as either a port number or a service name. 20387273a2dbSMatthew Booth@option{port} is required. 20397273a2dbSMatthew Booth 20407273a2dbSMatthew Booth@option{to} is only relevant to listening sockets. If it is specified, and 20417273a2dbSMatthew Booth@option{port} cannot be bound, QEMU will attempt to bind to subsequent ports up 20427273a2dbSMatthew Boothto and including @option{to} until it succeeds. @option{to} must be specified 20437273a2dbSMatthew Boothas a port number. 20447273a2dbSMatthew Booth 20457273a2dbSMatthew Booth@option{ipv4} and @option{ipv6} specify that either IPv4 or IPv6 must be used. 20467273a2dbSMatthew BoothIf neither is specified the socket may use either protocol. 20477273a2dbSMatthew Booth 20487273a2dbSMatthew Booth@option{nodelay} disables the Nagle algorithm. 20497273a2dbSMatthew Booth 20507273a2dbSMatthew Booth@item unix options: path=@var{path} 20517273a2dbSMatthew Booth 20527273a2dbSMatthew Booth@option{path} specifies the local path of the unix socket. @option{path} is 20537273a2dbSMatthew Boothrequired. 20547273a2dbSMatthew Booth 20557273a2dbSMatthew Booth@end table 20567273a2dbSMatthew Booth 20577273a2dbSMatthew Booth@item -chardev udp ,id=@var{id} [,host=@var{host}] ,port=@var{port} [,localaddr=@var{localaddr}] [,localport=@var{localport}] [,ipv4] [,ipv6] 20587273a2dbSMatthew Booth 20597273a2dbSMatthew BoothSends all traffic from the guest to a remote host over UDP. 20607273a2dbSMatthew Booth 20617273a2dbSMatthew Booth@option{host} specifies the remote host to connect to. If not specified it 20627273a2dbSMatthew Boothdefaults to @code{localhost}. 20637273a2dbSMatthew Booth 20647273a2dbSMatthew Booth@option{port} specifies the port on the remote host to connect to. @option{port} 20657273a2dbSMatthew Boothis required. 20667273a2dbSMatthew Booth 20677273a2dbSMatthew Booth@option{localaddr} specifies the local address to bind to. If not specified it 20687273a2dbSMatthew Boothdefaults to @code{0.0.0.0}. 20697273a2dbSMatthew Booth 20707273a2dbSMatthew Booth@option{localport} specifies the local port to bind to. If not specified any 20717273a2dbSMatthew Boothavailable local port will be used. 20727273a2dbSMatthew Booth 20737273a2dbSMatthew Booth@option{ipv4} and @option{ipv6} specify that either IPv4 or IPv6 must be used. 20747273a2dbSMatthew BoothIf neither is specified the device may use either protocol. 20757273a2dbSMatthew Booth 20767273a2dbSMatthew Booth@item -chardev msmouse ,id=@var{id} 20777273a2dbSMatthew Booth 20787273a2dbSMatthew BoothForward QEMU's emulated msmouse events to the guest. @option{msmouse} does not 20797273a2dbSMatthew Boothtake any options. 20807273a2dbSMatthew Booth 20817273a2dbSMatthew Booth@item -chardev vc ,id=@var{id} [[,width=@var{width}] [,height=@var{height}]] [[,cols=@var{cols}] [,rows=@var{rows}]] 20827273a2dbSMatthew Booth 20837273a2dbSMatthew BoothConnect to a QEMU text console. @option{vc} may optionally be given a specific 20847273a2dbSMatthew Boothsize. 20857273a2dbSMatthew Booth 20867273a2dbSMatthew Booth@option{width} and @option{height} specify the width and height respectively of 20877273a2dbSMatthew Booththe console, in pixels. 20887273a2dbSMatthew Booth 20897273a2dbSMatthew Booth@option{cols} and @option{rows} specify that the console be sized to fit a text 20907273a2dbSMatthew Boothconsole with the given dimensions. 20917273a2dbSMatthew Booth 20924f57378fSMarkus Armbruster@item -chardev ringbuf ,id=@var{id} [,size=@var{size}] 209351767e7cSLei Li 20943949e594SMarkus ArmbrusterCreate a ring buffer with fixed size @option{size}. 20953949e594SMarkus Armbruster@var{size} must be a power of two, and defaults to @code{64K}). 209651767e7cSLei Li 20977273a2dbSMatthew Booth@item -chardev file ,id=@var{id} ,path=@var{path} 20987273a2dbSMatthew Booth 20997273a2dbSMatthew BoothLog all traffic received from the guest to a file. 21007273a2dbSMatthew Booth 21017273a2dbSMatthew Booth@option{path} specifies the path of the file to be opened. This file will be 21027273a2dbSMatthew Boothcreated if it does not already exist, and overwritten if it does. @option{path} 21037273a2dbSMatthew Boothis required. 21047273a2dbSMatthew Booth 21057273a2dbSMatthew Booth@item -chardev pipe ,id=@var{id} ,path=@var{path} 21067273a2dbSMatthew Booth 21077273a2dbSMatthew BoothCreate a two-way connection to the guest. The behaviour differs slightly between 21087273a2dbSMatthew BoothWindows hosts and other hosts: 21097273a2dbSMatthew Booth 21107273a2dbSMatthew BoothOn Windows, a single duplex pipe will be created at 21117273a2dbSMatthew Booth@file{\\.pipe\@option{path}}. 21127273a2dbSMatthew Booth 21137273a2dbSMatthew BoothOn other hosts, 2 pipes will be created called @file{@option{path}.in} and 21147273a2dbSMatthew Booth@file{@option{path}.out}. Data written to @file{@option{path}.in} will be 21157273a2dbSMatthew Boothreceived by the guest. Data written by the guest can be read from 21167273a2dbSMatthew Booth@file{@option{path}.out}. QEMU will not create these fifos, and requires them to 21177273a2dbSMatthew Boothbe present. 21187273a2dbSMatthew Booth 21197273a2dbSMatthew Booth@option{path} forms part of the pipe path as described above. @option{path} is 21207273a2dbSMatthew Boothrequired. 21217273a2dbSMatthew Booth 21227273a2dbSMatthew Booth@item -chardev console ,id=@var{id} 21237273a2dbSMatthew Booth 21247273a2dbSMatthew BoothSend traffic from the guest to QEMU's standard output. @option{console} does not 21257273a2dbSMatthew Boothtake any options. 21267273a2dbSMatthew Booth 21277273a2dbSMatthew Booth@option{console} is only available on Windows hosts. 21287273a2dbSMatthew Booth 21297273a2dbSMatthew Booth@item -chardev serial ,id=@var{id} ,path=@option{path} 21307273a2dbSMatthew Booth 21317273a2dbSMatthew BoothSend traffic from the guest to a serial device on the host. 21327273a2dbSMatthew Booth 2133d59044efSGerd HoffmannOn Unix hosts serial will actually accept any tty device, 2134d59044efSGerd Hoffmannnot only serial lines. 21357273a2dbSMatthew Booth 21367273a2dbSMatthew Booth@option{path} specifies the name of the serial device to open. 21377273a2dbSMatthew Booth 21387273a2dbSMatthew Booth@item -chardev pty ,id=@var{id} 21397273a2dbSMatthew Booth 21407273a2dbSMatthew BoothCreate a new pseudo-terminal on the host and connect to it. @option{pty} does 21417273a2dbSMatthew Boothnot take any options. 21427273a2dbSMatthew Booth 21437273a2dbSMatthew Booth@option{pty} is not available on Windows hosts. 21447273a2dbSMatthew Booth 2145b7fdb3abSAurelien Jarno@item -chardev stdio ,id=@var{id} [,signal=on|off] 2146b65ee4faSStefan WeilConnect to standard input and standard output of the QEMU process. 2147b7fdb3abSAurelien Jarno 2148b7fdb3abSAurelien Jarno@option{signal} controls if signals are enabled on the terminal, that includes 2149b7fdb3abSAurelien Jarnoexiting QEMU with the key sequence @key{Control-c}. This option is enabled by 2150b7fdb3abSAurelien Jarnodefault, use @option{signal=off} to disable it. 2151b7fdb3abSAurelien Jarno 2152b7fdb3abSAurelien Jarno@option{stdio} is not available on Windows hosts. 21537273a2dbSMatthew Booth 21547273a2dbSMatthew Booth@item -chardev braille ,id=@var{id} 21557273a2dbSMatthew Booth 21567273a2dbSMatthew BoothConnect to a local BrlAPI server. @option{braille} does not take any options. 21577273a2dbSMatthew Booth 21587273a2dbSMatthew Booth@item -chardev tty ,id=@var{id} ,path=@var{path} 21597273a2dbSMatthew Booth 21607273a2dbSMatthew Booth@option{tty} is only available on Linux, Sun, FreeBSD, NetBSD, OpenBSD and 2161d037d6bbSMarkus ArmbrusterDragonFlyBSD hosts. It is an alias for @option{serial}. 21627273a2dbSMatthew Booth 21637273a2dbSMatthew Booth@option{path} specifies the path to the tty. @option{path} is required. 21647273a2dbSMatthew Booth 216588a946d3SGerd Hoffmann@item -chardev parallel ,id=@var{id} ,path=@var{path} 21667273a2dbSMatthew Booth@item -chardev parport ,id=@var{id} ,path=@var{path} 21677273a2dbSMatthew Booth 216888a946d3SGerd Hoffmann@option{parallel} is only available on Linux, FreeBSD and DragonFlyBSD hosts. 21697273a2dbSMatthew Booth 21707273a2dbSMatthew BoothConnect to a local parallel port. 21717273a2dbSMatthew Booth 21727273a2dbSMatthew Booth@option{path} specifies the path to the parallel port device. @option{path} is 21737273a2dbSMatthew Boothrequired. 21747273a2dbSMatthew Booth 2175cbcc6336SAlon Levy@item -chardev spicevmc ,id=@var{id} ,debug=@var{debug}, name=@var{name} 2176cbcc6336SAlon Levy 21773a846906SStefan Hajnoczi@option{spicevmc} is only available when spice support is built in. 21783a846906SStefan Hajnoczi 2179cbcc6336SAlon Levy@option{debug} debug level for spicevmc 2180cbcc6336SAlon Levy 2181cbcc6336SAlon Levy@option{name} name of spice channel to connect to 2182cbcc6336SAlon Levy 2183cbcc6336SAlon LevyConnect to a spice virtual machine channel, such as vdiport. 2184cbcc6336SAlon Levy 21855a49d3e9SMarc-André Lureau@item -chardev spiceport ,id=@var{id} ,debug=@var{debug}, name=@var{name} 21865a49d3e9SMarc-André Lureau 21875a49d3e9SMarc-André Lureau@option{spiceport} is only available when spice support is built in. 21885a49d3e9SMarc-André Lureau 21895a49d3e9SMarc-André Lureau@option{debug} debug level for spicevmc 21905a49d3e9SMarc-André Lureau 21915a49d3e9SMarc-André Lureau@option{name} name of spice port to connect to 21925a49d3e9SMarc-André Lureau 21935a49d3e9SMarc-André LureauConnect to a spice port, allowing a Spice client to handle the traffic 21945a49d3e9SMarc-André Lureauidentified by a name (preferably a fqdn). 21957273a2dbSMatthew BoothETEXI 21967273a2dbSMatthew Booth 2197c70a01e4SMarkus ArmbrusterSTEXI 2198c70a01e4SMarkus Armbruster@end table 2199c70a01e4SMarkus ArmbrusterETEXI 22007273a2dbSMatthew BoothDEFHEADING() 22017273a2dbSMatthew Booth 22020f5314a2SRonnie SahlbergDEFHEADING(Device URL Syntax:) 2203c70a01e4SMarkus ArmbrusterSTEXI 22040f5314a2SRonnie Sahlberg 22050f5314a2SRonnie SahlbergIn addition to using normal file images for the emulated storage devices, 22060f5314a2SRonnie SahlbergQEMU can also use networked resources such as iSCSI devices. These are 22070f5314a2SRonnie Sahlbergspecified using a special URL syntax. 22080f5314a2SRonnie Sahlberg 22090f5314a2SRonnie Sahlberg@table @option 22100f5314a2SRonnie Sahlberg@item iSCSI 22110f5314a2SRonnie SahlbergiSCSI support allows QEMU to access iSCSI resources directly and use as 22120f5314a2SRonnie Sahlbergimages for the guest storage. Both disk and cdrom images are supported. 22130f5314a2SRonnie Sahlberg 22140f5314a2SRonnie SahlbergSyntax for specifying iSCSI LUNs is 22150f5314a2SRonnie Sahlberg``iscsi://<target-ip>[:<port>]/<target-iqn>/<lun>'' 22160f5314a2SRonnie Sahlberg 221731459f46SRonnie SahlbergBy default qemu will use the iSCSI initiator-name 221831459f46SRonnie Sahlberg'iqn.2008-11.org.linux-kvm[:<name>]' but this can also be set from the command 221931459f46SRonnie Sahlbergline or a configuration file. 222031459f46SRonnie Sahlberg 222131459f46SRonnie Sahlberg 22220f5314a2SRonnie SahlbergExample (without authentication): 22230f5314a2SRonnie Sahlberg@example 22243804da9dSStefan Weilqemu-system-i386 -iscsi initiator-name=iqn.2001-04.com.example:my-initiator \ 2225f9dadc98SRonnie Sahlberg -cdrom iscsi://192.0.2.1/iqn.2001-04.com.example/2 \ 2226f9dadc98SRonnie Sahlberg -drive file=iscsi://192.0.2.1/iqn.2001-04.com.example/1 22270f5314a2SRonnie Sahlberg@end example 22280f5314a2SRonnie Sahlberg 22290f5314a2SRonnie SahlbergExample (CHAP username/password via URL): 22300f5314a2SRonnie Sahlberg@example 22313804da9dSStefan Weilqemu-system-i386 -drive file=iscsi://user%password@@192.0.2.1/iqn.2001-04.com.example/1 22320f5314a2SRonnie Sahlberg@end example 22330f5314a2SRonnie Sahlberg 22340f5314a2SRonnie SahlbergExample (CHAP username/password via environment variables): 22350f5314a2SRonnie Sahlberg@example 22360f5314a2SRonnie SahlbergLIBISCSI_CHAP_USERNAME="user" \ 22370f5314a2SRonnie SahlbergLIBISCSI_CHAP_PASSWORD="password" \ 22383804da9dSStefan Weilqemu-system-i386 -drive file=iscsi://192.0.2.1/iqn.2001-04.com.example/1 22390f5314a2SRonnie Sahlberg@end example 22400f5314a2SRonnie Sahlberg 22410f5314a2SRonnie SahlbergiSCSI support is an optional feature of QEMU and only available when 22420f5314a2SRonnie Sahlbergcompiled and linked against libiscsi. 2243f9dadc98SRonnie SahlbergETEXI 2244f9dadc98SRonnie SahlbergDEF("iscsi", HAS_ARG, QEMU_OPTION_iscsi, 2245f9dadc98SRonnie Sahlberg "-iscsi [user=user][,password=password]\n" 2246f9dadc98SRonnie Sahlberg " [,header-digest=CRC32C|CR32C-NONE|NONE-CRC32C|NONE\n" 22472fe3798cSPaolo Bonzini " [,initiator-name=initiator-iqn][,id=target-iqn]\n" 2248f9dadc98SRonnie Sahlberg " iSCSI session parameters\n", QEMU_ARCH_ALL) 2249f9dadc98SRonnie SahlbergSTEXI 22500f5314a2SRonnie Sahlberg 225131459f46SRonnie SahlbergiSCSI parameters such as username and password can also be specified via 225231459f46SRonnie Sahlberga configuration file. See qemu-doc for more information and examples. 225331459f46SRonnie Sahlberg 225408ae330eSRonnie Sahlberg@item NBD 225508ae330eSRonnie SahlbergQEMU supports NBD (Network Block Devices) both using TCP protocol as well 225608ae330eSRonnie Sahlbergas Unix Domain Sockets. 225708ae330eSRonnie Sahlberg 225808ae330eSRonnie SahlbergSyntax for specifying a NBD device using TCP 225908ae330eSRonnie Sahlberg``nbd:<server-ip>:<port>[:exportname=<export>]'' 226008ae330eSRonnie Sahlberg 226108ae330eSRonnie SahlbergSyntax for specifying a NBD device using Unix Domain Sockets 226208ae330eSRonnie Sahlberg``nbd:unix:<domain-socket>[:exportname=<export>]'' 226308ae330eSRonnie Sahlberg 226408ae330eSRonnie Sahlberg 226508ae330eSRonnie SahlbergExample for TCP 226608ae330eSRonnie Sahlberg@example 22673804da9dSStefan Weilqemu-system-i386 --drive file=nbd:192.0.2.1:30000 226808ae330eSRonnie Sahlberg@end example 226908ae330eSRonnie Sahlberg 227008ae330eSRonnie SahlbergExample for Unix Domain Sockets 227108ae330eSRonnie Sahlberg@example 22723804da9dSStefan Weilqemu-system-i386 --drive file=nbd:unix:/tmp/nbd-socket 227308ae330eSRonnie Sahlberg@end example 227408ae330eSRonnie Sahlberg 22750a12ec87SRichard W.M. Jones@item SSH 22760a12ec87SRichard W.M. JonesQEMU supports SSH (Secure Shell) access to remote disks. 22770a12ec87SRichard W.M. Jones 22780a12ec87SRichard W.M. JonesExamples: 22790a12ec87SRichard W.M. Jones@example 22800a12ec87SRichard W.M. Jonesqemu-system-i386 -drive file=ssh://user@@host/path/to/disk.img 22810a12ec87SRichard W.M. Jonesqemu-system-i386 -drive file.driver=ssh,file.user=user,file.host=host,file.port=22,file.path=/path/to/disk.img 22820a12ec87SRichard W.M. Jones@end example 22830a12ec87SRichard W.M. Jones 22840a12ec87SRichard W.M. JonesCurrently authentication must be done using ssh-agent. Other 22850a12ec87SRichard W.M. Jonesauthentication methods may be supported in future. 22860a12ec87SRichard W.M. Jones 2287d9990228SRonnie Sahlberg@item Sheepdog 2288d9990228SRonnie SahlbergSheepdog is a distributed storage system for QEMU. 2289d9990228SRonnie SahlbergQEMU supports using either local sheepdog devices or remote networked 2290d9990228SRonnie Sahlbergdevices. 2291d9990228SRonnie Sahlberg 2292d9990228SRonnie SahlbergSyntax for specifying a sheepdog device 22935d6768e3SMORITA Kazutaka@example 22941b8bbb46SMORITA Kazutakasheepdog[+tcp|+unix]://[host:port]/vdiname[?socket=path][#snapid|#tag] 22955d6768e3SMORITA Kazutaka@end example 2296d9990228SRonnie Sahlberg 2297d9990228SRonnie SahlbergExample 2298d9990228SRonnie Sahlberg@example 22995d6768e3SMORITA Kazutakaqemu-system-i386 --drive file=sheepdog://192.0.2.1:30000/MyVirtualMachine 2300d9990228SRonnie Sahlberg@end example 2301d9990228SRonnie Sahlberg 2302d9990228SRonnie SahlbergSee also @url{http://http://www.osrg.net/sheepdog/}. 2303d9990228SRonnie Sahlberg 23048809e289SBharata B Rao@item GlusterFS 23058809e289SBharata B RaoGlusterFS is an user space distributed file system. 23068809e289SBharata B RaoQEMU supports the use of GlusterFS volumes for hosting VM disk images using 23078809e289SBharata B RaoTCP, Unix Domain Sockets and RDMA transport protocols. 23088809e289SBharata B Rao 23098809e289SBharata B RaoSyntax for specifying a VM disk image on GlusterFS volume is 23108809e289SBharata B Rao@example 23118809e289SBharata B Raogluster[+transport]://[server[:port]]/volname/image[?socket=...] 23128809e289SBharata B Rao@end example 23138809e289SBharata B Rao 23148809e289SBharata B Rao 23158809e289SBharata B RaoExample 23168809e289SBharata B Rao@example 2317db2d5ebaSLei Liqemu-system-x86_64 --drive file=gluster://192.0.2.1/testvol/a.img 23188809e289SBharata B Rao@end example 23198809e289SBharata B Rao 23208809e289SBharata B RaoSee also @url{http://www.gluster.org}. 23210a86cb73SMatthew Booth 23220a86cb73SMatthew Booth@item HTTP/HTTPS/FTP/FTPS/TFTP 23230a86cb73SMatthew BoothQEMU supports read-only access to files accessed over http(s), ftp(s) and tftp. 23240a86cb73SMatthew Booth 23250a86cb73SMatthew BoothSyntax using a single filename: 23260a86cb73SMatthew Booth@example 23270a86cb73SMatthew Booth<protocol>://[<username>[:<password>]@@]<host>/<path> 23280a86cb73SMatthew Booth@end example 23290a86cb73SMatthew Booth 23300a86cb73SMatthew Boothwhere: 23310a86cb73SMatthew Booth@table @option 23320a86cb73SMatthew Booth@item protocol 23330a86cb73SMatthew Booth'http', 'https', 'ftp', 'ftps', or 'tftp'. 23340a86cb73SMatthew Booth 23350a86cb73SMatthew Booth@item username 23360a86cb73SMatthew BoothOptional username for authentication to the remote server. 23370a86cb73SMatthew Booth 23380a86cb73SMatthew Booth@item password 23390a86cb73SMatthew BoothOptional password for authentication to the remote server. 23400a86cb73SMatthew Booth 23410a86cb73SMatthew Booth@item host 23420a86cb73SMatthew BoothAddress of the remote server. 23430a86cb73SMatthew Booth 23440a86cb73SMatthew Booth@item path 23450a86cb73SMatthew BoothPath on the remote server, including any query string. 23460a86cb73SMatthew Booth@end table 23470a86cb73SMatthew Booth 23480a86cb73SMatthew BoothThe following options are also supported: 23490a86cb73SMatthew Booth@table @option 23500a86cb73SMatthew Booth@item url 23510a86cb73SMatthew BoothThe full URL when passing options to the driver explicitly. 23520a86cb73SMatthew Booth 23530a86cb73SMatthew Booth@item readahead 23540a86cb73SMatthew BoothThe amount of data to read ahead with each range request to the remote server. 23550a86cb73SMatthew BoothThis value may optionally have the suffix 'T', 'G', 'M', 'K', 'k' or 'b'. If it 23560a86cb73SMatthew Boothdoes not have a suffix, it will be assumed to be in bytes. The value must be a 23570a86cb73SMatthew Boothmultiple of 512 bytes. It defaults to 256k. 23580a86cb73SMatthew Booth 23590a86cb73SMatthew Booth@item sslverify 23600a86cb73SMatthew BoothWhether to verify the remote server's certificate when connecting over SSL. It 23610a86cb73SMatthew Boothcan have the value 'on' or 'off'. It defaults to 'on'. 2362212aefaaSDaniel Henrique Barboza 2363a94f83d9SRichard W.M. Jones@item cookie 2364a94f83d9SRichard W.M. JonesSend this cookie (it can also be a list of cookies separated by ';') with 2365a94f83d9SRichard W.M. Joneseach outgoing request. Only supported when using protocols such as HTTP 2366a94f83d9SRichard W.M. Joneswhich support cookies, otherwise ignored. 2367a94f83d9SRichard W.M. Jones 2368212aefaaSDaniel Henrique Barboza@item timeout 2369212aefaaSDaniel Henrique BarbozaSet the timeout in seconds of the CURL connection. This timeout is the time 2370212aefaaSDaniel Henrique Barbozathat CURL waits for a response from the remote server to get the size of the 2371212aefaaSDaniel Henrique Barbozaimage to be downloaded. If not set, the default timeout of 5 seconds is used. 23720a86cb73SMatthew Booth@end table 23730a86cb73SMatthew Booth 23740a86cb73SMatthew BoothNote that when passing options to qemu explicitly, @option{driver} is the value 23750a86cb73SMatthew Boothof <protocol>. 23760a86cb73SMatthew Booth 23770a86cb73SMatthew BoothExample: boot from a remote Fedora 20 live ISO image 23780a86cb73SMatthew Booth@example 23790a86cb73SMatthew 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 23800a86cb73SMatthew Booth 23810a86cb73SMatthew 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 23820a86cb73SMatthew Booth@end example 23830a86cb73SMatthew Booth 23840a86cb73SMatthew BoothExample: boot from a remote Fedora 20 cloud image using a local overlay for 23850a86cb73SMatthew Boothwrites, copy-on-read, and a readahead of 64k 23860a86cb73SMatthew Booth@example 23870a86cb73SMatthew 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 23880a86cb73SMatthew Booth 23890a86cb73SMatthew Boothqemu-system-x86_64 -drive file=/tmp/Fedora-x86_64-20-20131211.1-sda.qcow2,copy-on-read=on 23900a86cb73SMatthew Booth@end example 23910a86cb73SMatthew Booth 23920a86cb73SMatthew BoothExample: boot from an image stored on a VMware vSphere server with a self-signed 2393212aefaaSDaniel Henrique Barbozacertificate using a local overlay for writes, a readahead of 64k and a timeout 2394212aefaaSDaniel Henrique Barbozaof 10 seconds. 23950a86cb73SMatthew Booth@example 2396212aefaaSDaniel 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 23970a86cb73SMatthew Booth 23980a86cb73SMatthew Boothqemu-system-x86_64 -drive file=/tmp/test.qcow2 23990a86cb73SMatthew Booth@end example 2400c70a01e4SMarkus ArmbrusterETEXI 2401c70a01e4SMarkus Armbruster 2402c70a01e4SMarkus ArmbrusterSTEXI 24030f5314a2SRonnie Sahlberg@end table 24040f5314a2SRonnie SahlbergETEXI 24050f5314a2SRonnie Sahlberg 24067273a2dbSMatthew BoothDEFHEADING(Bluetooth(R) options:) 2407c70a01e4SMarkus ArmbrusterSTEXI 2408c70a01e4SMarkus Armbruster@table @option 2409c70a01e4SMarkus ArmbrusterETEXI 24107273a2dbSMatthew Booth 24115824d651Sblueswir1DEF("bt", HAS_ARG, QEMU_OPTION_bt, \ 24125824d651Sblueswir1 "-bt hci,null dumb bluetooth HCI - doesn't respond to commands\n" \ 24135824d651Sblueswir1 "-bt hci,host[:id]\n" \ 24145824d651Sblueswir1 " use host's HCI with the given name\n" \ 24155824d651Sblueswir1 "-bt hci[,vlan=n]\n" \ 24165824d651Sblueswir1 " emulate a standard HCI in virtual scatternet 'n'\n" \ 24175824d651Sblueswir1 "-bt vhci[,vlan=n]\n" \ 24185824d651Sblueswir1 " add host computer to virtual scatternet 'n' using VHCI\n" \ 24195824d651Sblueswir1 "-bt device:dev[,vlan=n]\n" \ 2420ad96090aSBlue Swirl " emulate a bluetooth device 'dev' in scatternet 'n'\n", 2421ad96090aSBlue Swirl QEMU_ARCH_ALL) 24225824d651Sblueswir1STEXI 24235824d651Sblueswir1@item -bt hci[...] 24246616b2adSStefan Weil@findex -bt 24255824d651Sblueswir1Defines the function of the corresponding Bluetooth HCI. -bt options 24265824d651Sblueswir1are matched with the HCIs present in the chosen machine type. For 24275824d651Sblueswir1example when emulating a machine with only one HCI built into it, only 24285824d651Sblueswir1the first @code{-bt hci[...]} option is valid and defines the HCI's 24295824d651Sblueswir1logic. The Transport Layer is decided by the machine type. Currently 24305824d651Sblueswir1the machines @code{n800} and @code{n810} have one HCI and all other 24315824d651Sblueswir1machines have none. 24325824d651Sblueswir1 24335824d651Sblueswir1@anchor{bt-hcis} 24345824d651Sblueswir1The following three types are recognized: 24355824d651Sblueswir1 2436b3f046c2SKevin Wolf@table @option 24375824d651Sblueswir1@item -bt hci,null 24385824d651Sblueswir1(default) The corresponding Bluetooth HCI assumes no internal logic 24395824d651Sblueswir1and will not respond to any HCI commands or emit events. 24405824d651Sblueswir1 24415824d651Sblueswir1@item -bt hci,host[:@var{id}] 24425824d651Sblueswir1(@code{bluez} only) The corresponding HCI passes commands / events 24435824d651Sblueswir1to / from the physical HCI identified by the name @var{id} (default: 24445824d651Sblueswir1@code{hci0}) on the computer running QEMU. Only available on @code{bluez} 24455824d651Sblueswir1capable systems like Linux. 24465824d651Sblueswir1 24475824d651Sblueswir1@item -bt hci[,vlan=@var{n}] 24485824d651Sblueswir1Add a virtual, standard HCI that will participate in the Bluetooth 24495824d651Sblueswir1scatternet @var{n} (default @code{0}). Similarly to @option{-net} 24505824d651Sblueswir1VLANs, devices inside a bluetooth network @var{n} can only communicate 24515824d651Sblueswir1with other devices in the same network (scatternet). 24525824d651Sblueswir1@end table 24535824d651Sblueswir1 24545824d651Sblueswir1@item -bt vhci[,vlan=@var{n}] 24555824d651Sblueswir1(Linux-host only) Create a HCI in scatternet @var{n} (default 0) attached 24565824d651Sblueswir1to the host bluetooth stack instead of to the emulated target. This 24575824d651Sblueswir1allows the host and target machines to participate in a common scatternet 24585824d651Sblueswir1and communicate. Requires the Linux @code{vhci} driver installed. Can 24595824d651Sblueswir1be used as following: 24605824d651Sblueswir1 24615824d651Sblueswir1@example 24623804da9dSStefan Weilqemu-system-i386 [...OPTIONS...] -bt hci,vlan=5 -bt vhci,vlan=5 24635824d651Sblueswir1@end example 24645824d651Sblueswir1 24655824d651Sblueswir1@item -bt device:@var{dev}[,vlan=@var{n}] 24665824d651Sblueswir1Emulate a bluetooth device @var{dev} and place it in network @var{n} 24675824d651Sblueswir1(default @code{0}). QEMU can only emulate one type of bluetooth devices 24685824d651Sblueswir1currently: 24695824d651Sblueswir1 2470b3f046c2SKevin Wolf@table @option 24715824d651Sblueswir1@item keyboard 24725824d651Sblueswir1Virtual wireless keyboard implementing the HIDP bluetooth profile. 24735824d651Sblueswir1@end table 24745824d651Sblueswir1ETEXI 24755824d651Sblueswir1 2476c70a01e4SMarkus ArmbrusterSTEXI 2477c70a01e4SMarkus Armbruster@end table 2478c70a01e4SMarkus ArmbrusterETEXI 24795824d651Sblueswir1DEFHEADING() 24805824d651Sblueswir1 2481d1a0cf73SStefan Berger#ifdef CONFIG_TPM 2482d1a0cf73SStefan BergerDEFHEADING(TPM device options:) 2483d1a0cf73SStefan Berger 2484d1a0cf73SStefan BergerDEF("tpmdev", HAS_ARG, QEMU_OPTION_tpmdev, \ 248592dcc234SStefan Berger "-tpmdev passthrough,id=id[,path=path][,cancel-path=path]\n" 248692dcc234SStefan Berger " use path to provide path to a character device; default is /dev/tpm0\n" 248792dcc234SStefan Berger " use cancel-path to provide path to TPM's cancel sysfs entry; if\n" 248892dcc234SStefan Berger " not provided it will be searched for in /sys/class/misc/tpm?/device\n", 2489d1a0cf73SStefan Berger QEMU_ARCH_ALL) 2490d1a0cf73SStefan BergerSTEXI 2491d1a0cf73SStefan Berger 2492d1a0cf73SStefan BergerThe general form of a TPM device option is: 2493d1a0cf73SStefan Berger@table @option 2494d1a0cf73SStefan Berger 2495d1a0cf73SStefan Berger@item -tpmdev @var{backend} ,id=@var{id} [,@var{options}] 2496d1a0cf73SStefan Berger@findex -tpmdev 2497d1a0cf73SStefan BergerBackend type must be: 24984549a8b7SStefan Berger@option{passthrough}. 2499d1a0cf73SStefan Berger 2500d1a0cf73SStefan BergerThe specific backend type will determine the applicable options. 250128c4fa32SCorey BryantThe @code{-tpmdev} option creates the TPM backend and requires a 250228c4fa32SCorey Bryant@code{-device} option that specifies the TPM frontend interface model. 2503d1a0cf73SStefan Berger 2504d1a0cf73SStefan BergerOptions to each backend are described below. 2505d1a0cf73SStefan Berger 2506d1a0cf73SStefan BergerUse 'help' to print all available TPM backend types. 2507d1a0cf73SStefan Berger@example 2508d1a0cf73SStefan Bergerqemu -tpmdev help 2509d1a0cf73SStefan Berger@end example 2510d1a0cf73SStefan Berger 251192dcc234SStefan Berger@item -tpmdev passthrough, id=@var{id}, path=@var{path}, cancel-path=@var{cancel-path} 25124549a8b7SStefan Berger 25134549a8b7SStefan Berger(Linux-host only) Enable access to the host's TPM using the passthrough 25144549a8b7SStefan Bergerdriver. 25154549a8b7SStefan Berger 25164549a8b7SStefan Berger@option{path} specifies the path to the host's TPM device, i.e., on 25174549a8b7SStefan Bergera Linux host this would be @code{/dev/tpm0}. 25184549a8b7SStefan Berger@option{path} is optional and by default @code{/dev/tpm0} is used. 25194549a8b7SStefan Berger 252092dcc234SStefan Berger@option{cancel-path} specifies the path to the host TPM device's sysfs 252192dcc234SStefan Bergerentry allowing for cancellation of an ongoing TPM command. 252292dcc234SStefan Berger@option{cancel-path} is optional and by default QEMU will search for the 252392dcc234SStefan Bergersysfs entry to use. 252492dcc234SStefan Berger 25254549a8b7SStefan BergerSome notes about using the host's TPM with the passthrough driver: 25264549a8b7SStefan Berger 25274549a8b7SStefan BergerThe TPM device accessed by the passthrough driver must not be 25284549a8b7SStefan Bergerused by any other application on the host. 25294549a8b7SStefan Berger 25304549a8b7SStefan BergerSince the host's firmware (BIOS/UEFI) has already initialized the TPM, 25314549a8b7SStefan Bergerthe VM's firmware (BIOS/UEFI) will not be able to initialize the 25324549a8b7SStefan BergerTPM again and may therefore not show a TPM-specific menu that would 25334549a8b7SStefan Bergerotherwise allow the user to configure the TPM, e.g., allow the user to 25344549a8b7SStefan Bergerenable/disable or activate/deactivate the TPM. 25354549a8b7SStefan BergerFurther, if TPM ownership is released from within a VM then the host's TPM 25364549a8b7SStefan Bergerwill get disabled and deactivated. To enable and activate the 25374549a8b7SStefan BergerTPM again afterwards, the host has to be rebooted and the user is 25384549a8b7SStefan Bergerrequired to enter the firmware's menu to enable and activate the TPM. 25394549a8b7SStefan BergerIf the TPM is left disabled and/or deactivated most TPM commands will fail. 25404549a8b7SStefan Berger 25414549a8b7SStefan BergerTo create a passthrough TPM use the following two options: 25424549a8b7SStefan Berger@example 25434549a8b7SStefan Berger-tpmdev passthrough,id=tpm0 -device tpm-tis,tpmdev=tpm0 25444549a8b7SStefan Berger@end example 25454549a8b7SStefan BergerNote that the @code{-tpmdev} id is @code{tpm0} and is referenced by 25464549a8b7SStefan Berger@code{tpmdev=tpm0} in the device option. 25474549a8b7SStefan Berger 2548d1a0cf73SStefan Berger@end table 2549d1a0cf73SStefan Berger 2550d1a0cf73SStefan BergerETEXI 2551d1a0cf73SStefan Berger 2552d1a0cf73SStefan BergerDEFHEADING() 2553d1a0cf73SStefan Berger 2554d1a0cf73SStefan Berger#endif 2555d1a0cf73SStefan Berger 25567677f05dSAlexander GrafDEFHEADING(Linux/Multiboot boot specific:) 25575824d651Sblueswir1STEXI 25587677f05dSAlexander Graf 25597677f05dSAlexander GrafWhen using these options, you can use a given Linux or Multiboot 25607677f05dSAlexander Grafkernel without installing it in the disk image. It can be useful 25615824d651Sblueswir1for easier testing of various kernels. 25625824d651Sblueswir1 25635824d651Sblueswir1@table @option 25645824d651Sblueswir1ETEXI 25655824d651Sblueswir1 25665824d651Sblueswir1DEF("kernel", HAS_ARG, QEMU_OPTION_kernel, \ 2567ad96090aSBlue Swirl "-kernel bzImage use 'bzImage' as kernel image\n", QEMU_ARCH_ALL) 25685824d651Sblueswir1STEXI 25695824d651Sblueswir1@item -kernel @var{bzImage} 25706616b2adSStefan Weil@findex -kernel 25717677f05dSAlexander GrafUse @var{bzImage} as kernel image. The kernel can be either a Linux kernel 25727677f05dSAlexander Grafor in multiboot format. 25735824d651Sblueswir1ETEXI 25745824d651Sblueswir1 25755824d651Sblueswir1DEF("append", HAS_ARG, QEMU_OPTION_append, \ 2576ad96090aSBlue Swirl "-append cmdline use 'cmdline' as kernel command line\n", QEMU_ARCH_ALL) 25775824d651Sblueswir1STEXI 25785824d651Sblueswir1@item -append @var{cmdline} 25796616b2adSStefan Weil@findex -append 25805824d651Sblueswir1Use @var{cmdline} as kernel command line 25815824d651Sblueswir1ETEXI 25825824d651Sblueswir1 25835824d651Sblueswir1DEF("initrd", HAS_ARG, QEMU_OPTION_initrd, \ 2584ad96090aSBlue Swirl "-initrd file use 'file' as initial ram disk\n", QEMU_ARCH_ALL) 25855824d651Sblueswir1STEXI 25865824d651Sblueswir1@item -initrd @var{file} 25876616b2adSStefan Weil@findex -initrd 25885824d651Sblueswir1Use @var{file} as initial ram disk. 25897677f05dSAlexander Graf 25907677f05dSAlexander Graf@item -initrd "@var{file1} arg=foo,@var{file2}" 25917677f05dSAlexander Graf 25927677f05dSAlexander GrafThis syntax is only available with multiboot. 25937677f05dSAlexander Graf 25947677f05dSAlexander GrafUse @var{file1} and @var{file2} as modules and pass arg=foo as parameter to the 25957677f05dSAlexander Graffirst module. 25965824d651Sblueswir1ETEXI 25975824d651Sblueswir1 2598412beee6SGrant LikelyDEF("dtb", HAS_ARG, QEMU_OPTION_dtb, \ 2599379b5c7cSPeter A. G. Crosthwaite "-dtb file use 'file' as device tree image\n", QEMU_ARCH_ALL) 2600412beee6SGrant LikelySTEXI 2601412beee6SGrant Likely@item -dtb @var{file} 2602412beee6SGrant Likely@findex -dtb 2603412beee6SGrant LikelyUse @var{file} as a device tree binary (dtb) image and pass it to the kernel 2604412beee6SGrant Likelyon boot. 2605412beee6SGrant LikelyETEXI 2606412beee6SGrant Likely 26075824d651Sblueswir1STEXI 26085824d651Sblueswir1@end table 26095824d651Sblueswir1ETEXI 26105824d651Sblueswir1DEFHEADING() 26115824d651Sblueswir1 26125824d651Sblueswir1DEFHEADING(Debug/Expert options:) 26135824d651Sblueswir1STEXI 26145824d651Sblueswir1@table @option 26155824d651Sblueswir1ETEXI 26165824d651Sblueswir1 26175824d651Sblueswir1DEF("serial", HAS_ARG, QEMU_OPTION_serial, \ 2618ad96090aSBlue Swirl "-serial dev redirect the serial port to char device 'dev'\n", 2619ad96090aSBlue Swirl QEMU_ARCH_ALL) 26205824d651Sblueswir1STEXI 26215824d651Sblueswir1@item -serial @var{dev} 26226616b2adSStefan Weil@findex -serial 26235824d651Sblueswir1Redirect the virtual serial port to host character device 26245824d651Sblueswir1@var{dev}. The default device is @code{vc} in graphical mode and 26255824d651Sblueswir1@code{stdio} in non graphical mode. 26265824d651Sblueswir1 26275824d651Sblueswir1This option can be used several times to simulate up to 4 serial 26285824d651Sblueswir1ports. 26295824d651Sblueswir1 26305824d651Sblueswir1Use @code{-serial none} to disable all serial ports. 26315824d651Sblueswir1 26325824d651Sblueswir1Available character devices are: 2633b3f046c2SKevin Wolf@table @option 26344e257e5eSKevin Wolf@item vc[:@var{W}x@var{H}] 26355824d651Sblueswir1Virtual console. Optionally, a width and height can be given in pixel with 26365824d651Sblueswir1@example 26375824d651Sblueswir1vc:800x600 26385824d651Sblueswir1@end example 26395824d651Sblueswir1It is also possible to specify width or height in characters: 26405824d651Sblueswir1@example 26415824d651Sblueswir1vc:80Cx24C 26425824d651Sblueswir1@end example 26435824d651Sblueswir1@item pty 26445824d651Sblueswir1[Linux only] Pseudo TTY (a new PTY is automatically allocated) 26455824d651Sblueswir1@item none 26465824d651Sblueswir1No device is allocated. 26475824d651Sblueswir1@item null 26485824d651Sblueswir1void device 264988e020e5SIngo van Lil@item chardev:@var{id} 265088e020e5SIngo van LilUse a named character device defined with the @code{-chardev} option. 26515824d651Sblueswir1@item /dev/XXX 26525824d651Sblueswir1[Linux only] Use host tty, e.g. @file{/dev/ttyS0}. The host serial port 26535824d651Sblueswir1parameters are set according to the emulated ones. 26545824d651Sblueswir1@item /dev/parport@var{N} 26555824d651Sblueswir1[Linux only, parallel port only] Use host parallel port 26565824d651Sblueswir1@var{N}. Currently SPP and EPP parallel port features can be used. 26575824d651Sblueswir1@item file:@var{filename} 26585824d651Sblueswir1Write output to @var{filename}. No character can be read. 26595824d651Sblueswir1@item stdio 26605824d651Sblueswir1[Unix only] standard input/output 26615824d651Sblueswir1@item pipe:@var{filename} 26625824d651Sblueswir1name pipe @var{filename} 26635824d651Sblueswir1@item COM@var{n} 26645824d651Sblueswir1[Windows only] Use host serial port @var{n} 26655824d651Sblueswir1@item udp:[@var{remote_host}]:@var{remote_port}[@@[@var{src_ip}]:@var{src_port}] 26665824d651Sblueswir1This implements UDP Net Console. 26675824d651Sblueswir1When @var{remote_host} or @var{src_ip} are not specified 26685824d651Sblueswir1they default to @code{0.0.0.0}. 26695824d651Sblueswir1When not using a specified @var{src_port} a random port is automatically chosen. 26705824d651Sblueswir1 26715824d651Sblueswir1If you just want a simple readonly console you can use @code{netcat} or 2672b65ee4faSStefan Weil@code{nc}, by starting QEMU with: @code{-serial udp::4555} and nc as: 2673b65ee4faSStefan Weil@code{nc -u -l -p 4555}. Any time QEMU writes something to that port it 26745824d651Sblueswir1will appear in the netconsole session. 26755824d651Sblueswir1 26765824d651Sblueswir1If you plan to send characters back via netconsole or you want to stop 2677b65ee4faSStefan Weiland start QEMU a lot of times, you should have QEMU use the same 26785824d651Sblueswir1source port each time by using something like @code{-serial 2679b65ee4faSStefan Weiludp::4555@@:4556} to QEMU. Another approach is to use a patched 26805824d651Sblueswir1version of netcat which can listen to a TCP port and send and receive 26815824d651Sblueswir1characters via udp. If you have a patched version of netcat which 26825824d651Sblueswir1activates telnet remote echo and single char transfer, then you can 26835824d651Sblueswir1use the following options to step up a netcat redirector to allow 2684b65ee4faSStefan Weiltelnet on port 5555 to access the QEMU port. 26855824d651Sblueswir1@table @code 2686071c9394SStefan Weil@item QEMU Options: 26875824d651Sblueswir1-serial udp::4555@@:4556 26885824d651Sblueswir1@item netcat options: 26895824d651Sblueswir1-u -P 4555 -L 0.0.0.0:4556 -t -p 5555 -I -T 26905824d651Sblueswir1@item telnet options: 26915824d651Sblueswir1localhost 5555 26925824d651Sblueswir1@end table 26935824d651Sblueswir1 26945dd1f02bSCorey Minyard@item tcp:[@var{host}]:@var{port}[,@var{server}][,nowait][,nodelay][,reconnect=@var{seconds}] 26955824d651Sblueswir1The TCP Net Console has two modes of operation. It can send the serial 26965824d651Sblueswir1I/O to a location or wait for a connection from a location. By default 26975824d651Sblueswir1the TCP Net Console is sent to @var{host} at the @var{port}. If you use 26985824d651Sblueswir1the @var{server} option QEMU will wait for a client socket application 26995824d651Sblueswir1to connect to the port before continuing, unless the @code{nowait} 27005824d651Sblueswir1option was specified. The @code{nodelay} option disables the Nagle buffering 27015dd1f02bSCorey Minyardalgorithm. The @code{reconnect} option only applies if @var{noserver} is 27025dd1f02bSCorey Minyardset, if the connection goes down it will attempt to reconnect at the 27035dd1f02bSCorey Minyardgiven interval. If @var{host} is omitted, 0.0.0.0 is assumed. Only 27045824d651Sblueswir1one TCP connection at a time is accepted. You can use @code{telnet} to 27055824d651Sblueswir1connect to the corresponding character device. 27065824d651Sblueswir1@table @code 27075824d651Sblueswir1@item Example to send tcp console to 192.168.0.2 port 4444 27085824d651Sblueswir1-serial tcp:192.168.0.2:4444 27095824d651Sblueswir1@item Example to listen and wait on port 4444 for connection 27105824d651Sblueswir1-serial tcp::4444,server 27115824d651Sblueswir1@item Example to not wait and listen on ip 192.168.0.100 port 4444 27125824d651Sblueswir1-serial tcp:192.168.0.100:4444,server,nowait 27135824d651Sblueswir1@end table 27145824d651Sblueswir1 27155824d651Sblueswir1@item telnet:@var{host}:@var{port}[,server][,nowait][,nodelay] 27165824d651Sblueswir1The telnet protocol is used instead of raw tcp sockets. The options 27175824d651Sblueswir1work the same as if you had specified @code{-serial tcp}. The 27185824d651Sblueswir1difference is that the port acts like a telnet server or client using 27195824d651Sblueswir1telnet option negotiation. This will also allow you to send the 27205824d651Sblueswir1MAGIC_SYSRQ sequence if you use a telnet that supports sending the break 27215824d651Sblueswir1sequence. Typically in unix telnet you do it with Control-] and then 27225824d651Sblueswir1type "send break" followed by pressing the enter key. 27235824d651Sblueswir1 27245dd1f02bSCorey Minyard@item unix:@var{path}[,server][,nowait][,reconnect=@var{seconds}] 27255824d651Sblueswir1A unix domain socket is used instead of a tcp socket. The option works the 27265824d651Sblueswir1same as if you had specified @code{-serial tcp} except the unix domain socket 27275824d651Sblueswir1@var{path} is used for connections. 27285824d651Sblueswir1 27295824d651Sblueswir1@item mon:@var{dev_string} 27305824d651Sblueswir1This is a special option to allow the monitor to be multiplexed onto 27315824d651Sblueswir1another serial port. The monitor is accessed with key sequence of 273202c4bdf1SPaolo Bonzini@key{Control-a} and then pressing @key{c}. 27335824d651Sblueswir1@var{dev_string} should be any one of the serial devices specified 27345824d651Sblueswir1above. An example to multiplex the monitor onto a telnet server 27355824d651Sblueswir1listening on port 4444 would be: 27365824d651Sblueswir1@table @code 27375824d651Sblueswir1@item -serial mon:telnet::4444,server,nowait 27385824d651Sblueswir1@end table 2739be022d61SMichael TokarevWhen the monitor is multiplexed to stdio in this way, Ctrl+C will not terminate 274002c4bdf1SPaolo BonziniQEMU any more but will be passed to the guest instead. 27415824d651Sblueswir1 27425824d651Sblueswir1@item braille 27435824d651Sblueswir1Braille device. This will use BrlAPI to display the braille output on a real 27445824d651Sblueswir1or fake device. 27455824d651Sblueswir1 2746be8b28a9SKevin Wolf@item msmouse 2747be8b28a9SKevin WolfThree button serial mouse. Configure the guest to use Microsoft protocol. 27485824d651Sblueswir1@end table 27495824d651Sblueswir1ETEXI 27505824d651Sblueswir1 27515824d651Sblueswir1DEF("parallel", HAS_ARG, QEMU_OPTION_parallel, \ 2752ad96090aSBlue Swirl "-parallel dev redirect the parallel port to char device 'dev'\n", 2753ad96090aSBlue Swirl QEMU_ARCH_ALL) 27545824d651Sblueswir1STEXI 27555824d651Sblueswir1@item -parallel @var{dev} 27566616b2adSStefan Weil@findex -parallel 27575824d651Sblueswir1Redirect the virtual parallel port to host device @var{dev} (same 27585824d651Sblueswir1devices as the serial port). On Linux hosts, @file{/dev/parportN} can 27595824d651Sblueswir1be used to use hardware devices connected on the corresponding host 27605824d651Sblueswir1parallel port. 27615824d651Sblueswir1 27625824d651Sblueswir1This option can be used several times to simulate up to 3 parallel 27635824d651Sblueswir1ports. 27645824d651Sblueswir1 27655824d651Sblueswir1Use @code{-parallel none} to disable all parallel ports. 27665824d651Sblueswir1ETEXI 27675824d651Sblueswir1 27685824d651Sblueswir1DEF("monitor", HAS_ARG, QEMU_OPTION_monitor, \ 2769ad96090aSBlue Swirl "-monitor dev redirect the monitor to char device 'dev'\n", 2770ad96090aSBlue Swirl QEMU_ARCH_ALL) 27715824d651Sblueswir1STEXI 27724e307fc8SGerd Hoffmann@item -monitor @var{dev} 27736616b2adSStefan Weil@findex -monitor 27745824d651Sblueswir1Redirect the monitor to host device @var{dev} (same devices as the 27755824d651Sblueswir1serial port). 27765824d651Sblueswir1The default device is @code{vc} in graphical mode and @code{stdio} in 27775824d651Sblueswir1non graphical mode. 277870e098afSLuiz CapitulinoUse @code{-monitor none} to disable the default monitor. 27795824d651Sblueswir1ETEXI 27806ca5582dSGerd HoffmannDEF("qmp", HAS_ARG, QEMU_OPTION_qmp, \ 2781ad96090aSBlue Swirl "-qmp dev like -monitor but opens in 'control' mode\n", 2782ad96090aSBlue Swirl QEMU_ARCH_ALL) 278395d5f08bSStefan WeilSTEXI 278495d5f08bSStefan Weil@item -qmp @var{dev} 27856616b2adSStefan Weil@findex -qmp 278695d5f08bSStefan WeilLike -monitor but opens in 'control' mode. 278795d5f08bSStefan WeilETEXI 27885824d651Sblueswir1 278922a0e04bSGerd HoffmannDEF("mon", HAS_ARG, QEMU_OPTION_mon, \ 2790f17e4eaaSMichael Tokarev "-mon [chardev=]name[,mode=readline|control][,default]\n", QEMU_ARCH_ALL) 279122a0e04bSGerd HoffmannSTEXI 2792f17e4eaaSMichael Tokarev@item -mon [chardev=]name[,mode=readline|control][,default] 27936616b2adSStefan Weil@findex -mon 279422a0e04bSGerd HoffmannSetup monitor on chardev @var{name}. 279522a0e04bSGerd HoffmannETEXI 279622a0e04bSGerd Hoffmann 2797c9f398e5SH. Peter AnvinDEF("debugcon", HAS_ARG, QEMU_OPTION_debugcon, \ 2798ad96090aSBlue Swirl "-debugcon dev redirect the debug console to char device 'dev'\n", 2799ad96090aSBlue Swirl QEMU_ARCH_ALL) 2800c9f398e5SH. Peter AnvinSTEXI 2801c9f398e5SH. Peter Anvin@item -debugcon @var{dev} 28026616b2adSStefan Weil@findex -debugcon 2803c9f398e5SH. Peter AnvinRedirect the debug console to host device @var{dev} (same devices as the 2804c9f398e5SH. Peter Anvinserial port). The debug console is an I/O port which is typically port 2805c9f398e5SH. Peter Anvin0xe9; writing to that I/O port sends output to this device. 2806c9f398e5SH. Peter AnvinThe default device is @code{vc} in graphical mode and @code{stdio} in 2807c9f398e5SH. Peter Anvinnon graphical mode. 2808c9f398e5SH. Peter AnvinETEXI 2809c9f398e5SH. Peter Anvin 28105824d651Sblueswir1DEF("pidfile", HAS_ARG, QEMU_OPTION_pidfile, \ 2811ad96090aSBlue Swirl "-pidfile file write PID to 'file'\n", QEMU_ARCH_ALL) 28125824d651Sblueswir1STEXI 28135824d651Sblueswir1@item -pidfile @var{file} 28146616b2adSStefan Weil@findex -pidfile 28155824d651Sblueswir1Store the QEMU process PID in @var{file}. It is useful if you launch QEMU 28165824d651Sblueswir1from a script. 28175824d651Sblueswir1ETEXI 28185824d651Sblueswir1 28191b530a6dSaurel32DEF("singlestep", 0, QEMU_OPTION_singlestep, \ 2820ad96090aSBlue Swirl "-singlestep always run in singlestep mode\n", QEMU_ARCH_ALL) 28211b530a6dSaurel32STEXI 28221b530a6dSaurel32@item -singlestep 28236616b2adSStefan Weil@findex -singlestep 28241b530a6dSaurel32Run the emulation in single step mode. 28251b530a6dSaurel32ETEXI 28261b530a6dSaurel32 28275824d651Sblueswir1DEF("S", 0, QEMU_OPTION_S, \ 2828ad96090aSBlue Swirl "-S freeze CPU at startup (use 'c' to start execution)\n", 2829ad96090aSBlue Swirl QEMU_ARCH_ALL) 28305824d651Sblueswir1STEXI 28315824d651Sblueswir1@item -S 28326616b2adSStefan Weil@findex -S 28335824d651Sblueswir1Do not start CPU at startup (you must type 'c' in the monitor). 28345824d651Sblueswir1ETEXI 28355824d651Sblueswir1 2836888a6bc6SSatoru MoriyaDEF("realtime", HAS_ARG, QEMU_OPTION_realtime, 2837888a6bc6SSatoru Moriya "-realtime [mlock=on|off]\n" 2838888a6bc6SSatoru Moriya " run qemu with realtime features\n" 2839888a6bc6SSatoru Moriya " mlock=on|off controls mlock support (default: on)\n", 2840888a6bc6SSatoru Moriya QEMU_ARCH_ALL) 2841888a6bc6SSatoru MoriyaSTEXI 2842888a6bc6SSatoru Moriya@item -realtime mlock=on|off 2843888a6bc6SSatoru Moriya@findex -realtime 2844888a6bc6SSatoru MoriyaRun qemu with realtime features. 2845888a6bc6SSatoru Moriyamlocking qemu and guest memory can be enabled via @option{mlock=on} 2846888a6bc6SSatoru Moriya(enabled by default). 2847888a6bc6SSatoru MoriyaETEXI 2848888a6bc6SSatoru Moriya 284959030a8cSaliguoriDEF("gdb", HAS_ARG, QEMU_OPTION_gdb, \ 2850ad96090aSBlue Swirl "-gdb dev wait for gdb connection on 'dev'\n", QEMU_ARCH_ALL) 28515824d651Sblueswir1STEXI 285259030a8cSaliguori@item -gdb @var{dev} 28536616b2adSStefan Weil@findex -gdb 285459030a8cSaliguoriWait for gdb connection on device @var{dev} (@pxref{gdb_usage}). Typical 285559030a8cSaliguoriconnections will likely be TCP-based, but also UDP, pseudo TTY, or even 2856b65ee4faSStefan Weilstdio are reasonable use case. The latter is allowing to start QEMU from 285759030a8cSaliguoriwithin gdb and establish the connection via a pipe: 285859030a8cSaliguori@example 28593804da9dSStefan Weil(gdb) target remote | exec qemu-system-i386 -gdb stdio ... 286059030a8cSaliguori@end example 28615824d651Sblueswir1ETEXI 28625824d651Sblueswir1 286359030a8cSaliguoriDEF("s", 0, QEMU_OPTION_s, \ 2864ad96090aSBlue Swirl "-s shorthand for -gdb tcp::" DEFAULT_GDBSTUB_PORT "\n", 2865ad96090aSBlue Swirl QEMU_ARCH_ALL) 28665824d651Sblueswir1STEXI 286759030a8cSaliguori@item -s 28686616b2adSStefan Weil@findex -s 286959030a8cSaliguoriShorthand for -gdb tcp::1234, i.e. open a gdbserver on TCP port 1234 287059030a8cSaliguori(@pxref{gdb_usage}). 28715824d651Sblueswir1ETEXI 28725824d651Sblueswir1 28735824d651Sblueswir1DEF("d", HAS_ARG, QEMU_OPTION_d, \ 2874989b697dSPeter Maydell "-d item1,... enable logging of specified items (use '-d help' for a list of log items)\n", 2875ad96090aSBlue Swirl QEMU_ARCH_ALL) 28765824d651Sblueswir1STEXI 2877989b697dSPeter Maydell@item -d @var{item1}[,...] 28786616b2adSStefan Weil@findex -d 2879989b697dSPeter MaydellEnable logging of specified items. Use '-d help' for a list of log items. 28805824d651Sblueswir1ETEXI 28815824d651Sblueswir1 2882c235d738SMatthew FernandezDEF("D", HAS_ARG, QEMU_OPTION_D, \ 2883989b697dSPeter Maydell "-D logfile output log to logfile (default stderr)\n", 2884c235d738SMatthew Fernandez QEMU_ARCH_ALL) 2885c235d738SMatthew FernandezSTEXI 28868bd383b4SStefan Weil@item -D @var{logfile} 2887c235d738SMatthew Fernandez@findex -D 2888989b697dSPeter MaydellOutput log in @var{logfile} instead of to stderr 2889c235d738SMatthew FernandezETEXI 2890c235d738SMatthew Fernandez 28915824d651Sblueswir1DEF("L", HAS_ARG, QEMU_OPTION_L, \ 2892ad96090aSBlue Swirl "-L path set the directory for the BIOS, VGA BIOS and keymaps\n", 2893ad96090aSBlue Swirl QEMU_ARCH_ALL) 28945824d651Sblueswir1STEXI 28955824d651Sblueswir1@item -L @var{path} 28966616b2adSStefan Weil@findex -L 28975824d651Sblueswir1Set the directory for the BIOS, VGA BIOS and keymaps. 28985824d651Sblueswir1ETEXI 28995824d651Sblueswir1 29005824d651Sblueswir1DEF("bios", HAS_ARG, QEMU_OPTION_bios, \ 2901ad96090aSBlue Swirl "-bios file set the filename for the BIOS\n", QEMU_ARCH_ALL) 29025824d651Sblueswir1STEXI 29035824d651Sblueswir1@item -bios @var{file} 29046616b2adSStefan Weil@findex -bios 29055824d651Sblueswir1Set the filename for the BIOS. 29065824d651Sblueswir1ETEXI 29075824d651Sblueswir1 29085824d651Sblueswir1DEF("enable-kvm", 0, QEMU_OPTION_enable_kvm, \ 2909ad96090aSBlue Swirl "-enable-kvm enable KVM full virtualization support\n", QEMU_ARCH_ALL) 29105824d651Sblueswir1STEXI 29115824d651Sblueswir1@item -enable-kvm 29126616b2adSStefan Weil@findex -enable-kvm 29135824d651Sblueswir1Enable KVM full virtualization support. This option is only available 29145824d651Sblueswir1if KVM support is enabled when compiling. 29155824d651Sblueswir1ETEXI 29165824d651Sblueswir1 2917e37630caSaliguoriDEF("xen-domid", HAS_ARG, QEMU_OPTION_xen_domid, 2918ad96090aSBlue Swirl "-xen-domid id specify xen guest domain id\n", QEMU_ARCH_ALL) 2919e37630caSaliguoriDEF("xen-create", 0, QEMU_OPTION_xen_create, 2920e37630caSaliguori "-xen-create create domain using xen hypercalls, bypassing xend\n" 2921ad96090aSBlue Swirl " warning: should not be used when xend is in use\n", 2922ad96090aSBlue Swirl QEMU_ARCH_ALL) 2923e37630caSaliguoriDEF("xen-attach", 0, QEMU_OPTION_xen_attach, 2924e37630caSaliguori "-xen-attach attach to existing xen domain\n" 2925b65ee4faSStefan Weil " xend will use this when starting QEMU\n", 2926ad96090aSBlue Swirl QEMU_ARCH_ALL) 292795d5f08bSStefan WeilSTEXI 292895d5f08bSStefan Weil@item -xen-domid @var{id} 29296616b2adSStefan Weil@findex -xen-domid 293095d5f08bSStefan WeilSpecify xen guest domain @var{id} (XEN only). 293195d5f08bSStefan Weil@item -xen-create 29326616b2adSStefan Weil@findex -xen-create 293395d5f08bSStefan WeilCreate domain using xen hypercalls, bypassing xend. 293495d5f08bSStefan WeilWarning: should not be used when xend is in use (XEN only). 293595d5f08bSStefan Weil@item -xen-attach 29366616b2adSStefan Weil@findex -xen-attach 293795d5f08bSStefan WeilAttach to existing xen domain. 2938b65ee4faSStefan Weilxend will use this when starting QEMU (XEN only). 293995d5f08bSStefan WeilETEXI 2940e37630caSaliguori 29415824d651Sblueswir1DEF("no-reboot", 0, QEMU_OPTION_no_reboot, \ 2942ad96090aSBlue Swirl "-no-reboot exit instead of rebooting\n", QEMU_ARCH_ALL) 29435824d651Sblueswir1STEXI 29445824d651Sblueswir1@item -no-reboot 29456616b2adSStefan Weil@findex -no-reboot 29465824d651Sblueswir1Exit instead of rebooting. 29475824d651Sblueswir1ETEXI 29485824d651Sblueswir1 29495824d651Sblueswir1DEF("no-shutdown", 0, QEMU_OPTION_no_shutdown, \ 2950ad96090aSBlue Swirl "-no-shutdown stop before shutdown\n", QEMU_ARCH_ALL) 29515824d651Sblueswir1STEXI 29525824d651Sblueswir1@item -no-shutdown 29536616b2adSStefan Weil@findex -no-shutdown 29545824d651Sblueswir1Don't exit QEMU on guest shutdown, but instead only stop the emulation. 29555824d651Sblueswir1This allows for instance switching to monitor to commit changes to the 29565824d651Sblueswir1disk image. 29575824d651Sblueswir1ETEXI 29585824d651Sblueswir1 29595824d651Sblueswir1DEF("loadvm", HAS_ARG, QEMU_OPTION_loadvm, \ 29605824d651Sblueswir1 "-loadvm [tag|id]\n" \ 2961ad96090aSBlue Swirl " start right away with a saved state (loadvm in monitor)\n", 2962ad96090aSBlue Swirl QEMU_ARCH_ALL) 29635824d651Sblueswir1STEXI 29645824d651Sblueswir1@item -loadvm @var{file} 29656616b2adSStefan Weil@findex -loadvm 29665824d651Sblueswir1Start right away with a saved state (@code{loadvm} in monitor) 29675824d651Sblueswir1ETEXI 29685824d651Sblueswir1 29695824d651Sblueswir1#ifndef _WIN32 29705824d651Sblueswir1DEF("daemonize", 0, QEMU_OPTION_daemonize, \ 2971ad96090aSBlue Swirl "-daemonize daemonize QEMU after initializing\n", QEMU_ARCH_ALL) 29725824d651Sblueswir1#endif 29735824d651Sblueswir1STEXI 29745824d651Sblueswir1@item -daemonize 29756616b2adSStefan Weil@findex -daemonize 29765824d651Sblueswir1Daemonize the QEMU process after initialization. QEMU will not detach from 29775824d651Sblueswir1standard IO until it is ready to receive connections on any of its devices. 29785824d651Sblueswir1This option is a useful way for external programs to launch QEMU without having 29795824d651Sblueswir1to cope with initialization race conditions. 29805824d651Sblueswir1ETEXI 29815824d651Sblueswir1 29825824d651Sblueswir1DEF("option-rom", HAS_ARG, QEMU_OPTION_option_rom, \ 2983ad96090aSBlue Swirl "-option-rom rom load a file, rom, into the option ROM space\n", 2984ad96090aSBlue Swirl QEMU_ARCH_ALL) 29855824d651Sblueswir1STEXI 29865824d651Sblueswir1@item -option-rom @var{file} 29876616b2adSStefan Weil@findex -option-rom 29885824d651Sblueswir1Load the contents of @var{file} as an option ROM. 29895824d651Sblueswir1This option is useful to load things like EtherBoot. 29905824d651Sblueswir1ETEXI 29915824d651Sblueswir1 2992*e218052fSMarkus ArmbrusterHXCOMM Silently ignored for compatibility 2993*e218052fSMarkus ArmbrusterDEF("clock", HAS_ARG, QEMU_OPTION_clock, "", QEMU_ARCH_ALL) 29945824d651Sblueswir1 29951ed2fc1fSJan KiszkaHXCOMM Options deprecated by -rtc 2996ad96090aSBlue SwirlDEF("localtime", 0, QEMU_OPTION_localtime, "", QEMU_ARCH_ALL) 2997ad96090aSBlue SwirlDEF("startdate", HAS_ARG, QEMU_OPTION_startdate, "", QEMU_ARCH_ALL) 29985824d651Sblueswir1 29991ed2fc1fSJan KiszkaDEF("rtc", HAS_ARG, QEMU_OPTION_rtc, \ 300078808141SPaolo Bonzini "-rtc [base=utc|localtime|date][,clock=host|rt|vm][,driftfix=none|slew]\n" \ 3001ad96090aSBlue Swirl " set the RTC base and clock, enable drift fix for clock ticks (x86 only)\n", 3002ad96090aSBlue Swirl QEMU_ARCH_ALL) 30031ed2fc1fSJan Kiszka 30045824d651Sblueswir1STEXI 30055824d651Sblueswir1 30066875204cSJan Kiszka@item -rtc [base=utc|localtime|@var{date}][,clock=host|vm][,driftfix=none|slew] 30076616b2adSStefan Weil@findex -rtc 30081ed2fc1fSJan KiszkaSpecify @option{base} as @code{utc} or @code{localtime} to let the RTC start at the current 30091ed2fc1fSJan KiszkaUTC or local time, respectively. @code{localtime} is required for correct date in 30101ed2fc1fSJan KiszkaMS-DOS or Windows. To start at a specific point in time, provide @var{date} in the 30111ed2fc1fSJan Kiszkaformat @code{2006-06-17T16:01:21} or @code{2006-06-17}. The default base is UTC. 30121ed2fc1fSJan Kiszka 30139d85d557SMichael TokarevBy default the RTC is driven by the host system time. This allows using of the 30146875204cSJan KiszkaRTC as accurate reference clock inside the guest, specifically if the host 30156875204cSJan Kiszkatime is smoothly following an accurate external reference clock, e.g. via NTP. 301678808141SPaolo BonziniIf you want to isolate the guest time from the host, you can set @option{clock} 301778808141SPaolo Bonzinito @code{rt} instead. To even prevent it from progressing during suspension, 301878808141SPaolo Bonziniyou can set it to @code{vm}. 30196875204cSJan Kiszka 30201ed2fc1fSJan KiszkaEnable @option{driftfix} (i386 targets only) if you experience time drift problems, 30211ed2fc1fSJan Kiszkaspecifically with Windows' ACPI HAL. This option will try to figure out how 30221ed2fc1fSJan Kiszkamany timer interrupts were not processed by the Windows guest and will 30231ed2fc1fSJan Kiszkare-inject them. 30245824d651Sblueswir1ETEXI 30255824d651Sblueswir1 30265824d651Sblueswir1DEF("icount", HAS_ARG, QEMU_OPTION_icount, \ 3027a8bfac37SSebastian Tanase "-icount [shift=N|auto][,align=on|off]\n" \ 3028bc14ca24Saliguori " enable virtual instruction counter with 2^N clock ticks per\n" \ 3029a8bfac37SSebastian Tanase " instruction and enable aligning the host and virtual clocks\n", QEMU_ARCH_ALL) 30305824d651Sblueswir1STEXI 30311ad9580bSSebastian Tanase@item -icount [shift=@var{N}|auto] 30326616b2adSStefan Weil@findex -icount 30335824d651Sblueswir1Enable virtual instruction counter. The virtual cpu will execute one 30344e257e5eSKevin Wolfinstruction every 2^@var{N} ns of virtual time. If @code{auto} is specified 30355824d651Sblueswir1then the virtual cpu speed will be automatically adjusted to keep virtual 30365824d651Sblueswir1time within a few seconds of real time. 30375824d651Sblueswir1 30385824d651Sblueswir1Note that while this option can give deterministic behavior, it does not 30395824d651Sblueswir1provide cycle accurate emulation. Modern CPUs contain superscalar out of 30405824d651Sblueswir1order cores with complex cache hierarchies. The number of instructions 30415824d651Sblueswir1executed often has little or no correlation with actual performance. 3042a8bfac37SSebastian Tanase 3043a8bfac37SSebastian Tanase@option{align=on} will activate the delay algorithm which will try to 3044a8bfac37SSebastian Tanaseto synchronise the host clock and the virtual clock. The goal is to 3045a8bfac37SSebastian Tanasehave a guest running at the real frequency imposed by the shift option. 3046a8bfac37SSebastian TanaseWhenever the guest clock is behind the host clock and if 3047a8bfac37SSebastian Tanase@option{align=on} is specified then we print a messsage to the user 3048a8bfac37SSebastian Tanaseto inform about the delay. 3049a8bfac37SSebastian TanaseCurrently this option does not work when @option{shift} is @code{auto}. 3050a8bfac37SSebastian TanaseNote: The sync algorithm will work for those shift values for which 3051a8bfac37SSebastian Tanasethe guest clock runs ahead of the host clock. Typically this happens 3052a8bfac37SSebastian Tanasewhen the shift value is high (how high depends on the host machine). 30535824d651Sblueswir1ETEXI 30545824d651Sblueswir1 30559dd986ccSRichard W.M. JonesDEF("watchdog", HAS_ARG, QEMU_OPTION_watchdog, \ 30569dd986ccSRichard W.M. Jones "-watchdog i6300esb|ib700\n" \ 3057ad96090aSBlue Swirl " enable virtual hardware watchdog [default=none]\n", 3058ad96090aSBlue Swirl QEMU_ARCH_ALL) 30599dd986ccSRichard W.M. JonesSTEXI 30609dd986ccSRichard W.M. Jones@item -watchdog @var{model} 30616616b2adSStefan Weil@findex -watchdog 30629dd986ccSRichard W.M. JonesCreate a virtual hardware watchdog device. Once enabled (by a guest 30639dd986ccSRichard W.M. Jonesaction), the watchdog must be periodically polled by an agent inside 30649dd986ccSRichard W.M. Jonesthe guest or else the guest will be restarted. 30659dd986ccSRichard W.M. Jones 30669dd986ccSRichard W.M. JonesThe @var{model} is the model of hardware watchdog to emulate. Choices 30679dd986ccSRichard W.M. Jonesfor model are: @code{ib700} (iBASE 700) which is a very simple ISA 30689dd986ccSRichard W.M. Joneswatchdog with a single timer, or @code{i6300esb} (Intel 6300ESB I/O 30699dd986ccSRichard W.M. Jonescontroller hub) which is a much more featureful PCI-based dual-timer 30709dd986ccSRichard W.M. Joneswatchdog. Choose a model for which your guest has drivers. 30719dd986ccSRichard W.M. Jones 3072585f6036SPeter MaydellUse @code{-watchdog help} to list available hardware models. Only one 30739dd986ccSRichard W.M. Joneswatchdog can be enabled for a guest. 30749dd986ccSRichard W.M. JonesETEXI 30759dd986ccSRichard W.M. Jones 30769dd986ccSRichard W.M. JonesDEF("watchdog-action", HAS_ARG, QEMU_OPTION_watchdog_action, \ 30779dd986ccSRichard W.M. Jones "-watchdog-action reset|shutdown|poweroff|pause|debug|none\n" \ 3078ad96090aSBlue Swirl " action when watchdog fires [default=reset]\n", 3079ad96090aSBlue Swirl QEMU_ARCH_ALL) 30809dd986ccSRichard W.M. JonesSTEXI 30819dd986ccSRichard W.M. Jones@item -watchdog-action @var{action} 3082b8f490ebSMarkus Armbruster@findex -watchdog-action 30839dd986ccSRichard W.M. Jones 30849dd986ccSRichard W.M. JonesThe @var{action} controls what QEMU will do when the watchdog timer 30859dd986ccSRichard W.M. Jonesexpires. 30869dd986ccSRichard W.M. JonesThe default is 30879dd986ccSRichard W.M. Jones@code{reset} (forcefully reset the guest). 30889dd986ccSRichard W.M. JonesOther possible actions are: 30899dd986ccSRichard W.M. Jones@code{shutdown} (attempt to gracefully shutdown the guest), 30909dd986ccSRichard W.M. Jones@code{poweroff} (forcefully poweroff the guest), 30919dd986ccSRichard W.M. Jones@code{pause} (pause the guest), 30929dd986ccSRichard W.M. Jones@code{debug} (print a debug message and continue), or 30939dd986ccSRichard W.M. Jones@code{none} (do nothing). 30949dd986ccSRichard W.M. Jones 30959dd986ccSRichard W.M. JonesNote that the @code{shutdown} action requires that the guest responds 30969dd986ccSRichard W.M. Jonesto ACPI signals, which it may not be able to do in the sort of 30979dd986ccSRichard W.M. Jonessituations where the watchdog would have expired, and thus 30989dd986ccSRichard W.M. Jones@code{-watchdog-action shutdown} is not recommended for production use. 30999dd986ccSRichard W.M. Jones 31009dd986ccSRichard W.M. JonesExamples: 31019dd986ccSRichard W.M. Jones 31029dd986ccSRichard W.M. Jones@table @code 31039dd986ccSRichard W.M. Jones@item -watchdog i6300esb -watchdog-action pause 31049dd986ccSRichard W.M. Jones@item -watchdog ib700 31059dd986ccSRichard W.M. Jones@end table 31069dd986ccSRichard W.M. JonesETEXI 31079dd986ccSRichard W.M. Jones 31085824d651Sblueswir1DEF("echr", HAS_ARG, QEMU_OPTION_echr, \ 3109ad96090aSBlue Swirl "-echr chr set terminal escape character instead of ctrl-a\n", 3110ad96090aSBlue Swirl QEMU_ARCH_ALL) 31115824d651Sblueswir1STEXI 31125824d651Sblueswir1 31134e257e5eSKevin Wolf@item -echr @var{numeric_ascii_value} 31146616b2adSStefan Weil@findex -echr 31155824d651Sblueswir1Change the escape character used for switching to the monitor when using 31165824d651Sblueswir1monitor and serial sharing. The default is @code{0x01} when using the 31175824d651Sblueswir1@code{-nographic} option. @code{0x01} is equal to pressing 31185824d651Sblueswir1@code{Control-a}. You can select a different character from the ascii 31195824d651Sblueswir1control keys where 1 through 26 map to Control-a through Control-z. For 31205824d651Sblueswir1instance you could use the either of the following to change the escape 31215824d651Sblueswir1character to Control-t. 31225824d651Sblueswir1@table @code 31235824d651Sblueswir1@item -echr 0x14 31245824d651Sblueswir1@item -echr 20 31255824d651Sblueswir1@end table 31265824d651Sblueswir1ETEXI 31275824d651Sblueswir1 31285824d651Sblueswir1DEF("virtioconsole", HAS_ARG, QEMU_OPTION_virtiocon, \ 31295824d651Sblueswir1 "-virtioconsole c\n" \ 3130ad96090aSBlue Swirl " set virtio console\n", QEMU_ARCH_ALL) 31315824d651Sblueswir1STEXI 31325824d651Sblueswir1@item -virtioconsole @var{c} 31336616b2adSStefan Weil@findex -virtioconsole 31345824d651Sblueswir1Set virtio console. 313598b19252SAmit Shah 313698b19252SAmit ShahThis option is maintained for backward compatibility. 313798b19252SAmit Shah 313898b19252SAmit ShahPlease use @code{-device virtconsole} for the new way of invocation. 31395824d651Sblueswir1ETEXI 31405824d651Sblueswir1 31415824d651Sblueswir1DEF("show-cursor", 0, QEMU_OPTION_show_cursor, \ 3142ad96090aSBlue Swirl "-show-cursor show cursor\n", QEMU_ARCH_ALL) 31435824d651Sblueswir1STEXI 314495d5f08bSStefan Weil@item -show-cursor 31456616b2adSStefan Weil@findex -show-cursor 314695d5f08bSStefan WeilShow cursor. 31475824d651Sblueswir1ETEXI 31485824d651Sblueswir1 31495824d651Sblueswir1DEF("tb-size", HAS_ARG, QEMU_OPTION_tb_size, \ 3150ad96090aSBlue Swirl "-tb-size n set TB size\n", QEMU_ARCH_ALL) 31515824d651Sblueswir1STEXI 315295d5f08bSStefan Weil@item -tb-size @var{n} 31536616b2adSStefan Weil@findex -tb-size 315495d5f08bSStefan WeilSet TB size. 31555824d651Sblueswir1ETEXI 31565824d651Sblueswir1 31575824d651Sblueswir1DEF("incoming", HAS_ARG, QEMU_OPTION_incoming, \ 3158ad96090aSBlue Swirl "-incoming p prepare for incoming migration, listen on port p\n", 3159ad96090aSBlue Swirl QEMU_ARCH_ALL) 31605824d651Sblueswir1STEXI 316195d5f08bSStefan Weil@item -incoming @var{port} 31626616b2adSStefan Weil@findex -incoming 316395d5f08bSStefan WeilPrepare for incoming migration, listen on @var{port}. 31645824d651Sblueswir1ETEXI 31655824d651Sblueswir1 3166d8c208ddSGerd HoffmannDEF("nodefaults", 0, QEMU_OPTION_nodefaults, \ 3167ad96090aSBlue Swirl "-nodefaults don't create default devices\n", QEMU_ARCH_ALL) 3168d8c208ddSGerd HoffmannSTEXI 31693dbf2c7fSStefan Weil@item -nodefaults 31706616b2adSStefan Weil@findex -nodefaults 317166c19bf1SMichal NovotnyDon't create default devices. Normally, QEMU sets the default devices like serial 317266c19bf1SMichal Novotnyport, parallel port, virtual console, monitor device, VGA adapter, floppy and 317366c19bf1SMichal NovotnyCD-ROM drive and others. The @code{-nodefaults} option will disable all those 317466c19bf1SMichal Novotnydefault devices. 3175d8c208ddSGerd HoffmannETEXI 3176d8c208ddSGerd Hoffmann 31775824d651Sblueswir1#ifndef _WIN32 31785824d651Sblueswir1DEF("chroot", HAS_ARG, QEMU_OPTION_chroot, \ 3179ad96090aSBlue Swirl "-chroot dir chroot to dir just before starting the VM\n", 3180ad96090aSBlue Swirl QEMU_ARCH_ALL) 31815824d651Sblueswir1#endif 31825824d651Sblueswir1STEXI 31834e257e5eSKevin Wolf@item -chroot @var{dir} 31846616b2adSStefan Weil@findex -chroot 31855824d651Sblueswir1Immediately before starting guest execution, chroot to the specified 31865824d651Sblueswir1directory. Especially useful in combination with -runas. 31875824d651Sblueswir1ETEXI 31885824d651Sblueswir1 31895824d651Sblueswir1#ifndef _WIN32 31905824d651Sblueswir1DEF("runas", HAS_ARG, QEMU_OPTION_runas, \ 3191ad96090aSBlue Swirl "-runas user change to user id user just before starting the VM\n", 3192ad96090aSBlue Swirl QEMU_ARCH_ALL) 31935824d651Sblueswir1#endif 31945824d651Sblueswir1STEXI 31954e257e5eSKevin Wolf@item -runas @var{user} 31966616b2adSStefan Weil@findex -runas 31975824d651Sblueswir1Immediately before starting guest execution, drop root privileges, switching 31985824d651Sblueswir1to the specified user. 31995824d651Sblueswir1ETEXI 32005824d651Sblueswir1 32015824d651Sblueswir1DEF("prom-env", HAS_ARG, QEMU_OPTION_prom_env, 32025824d651Sblueswir1 "-prom-env variable=value\n" 3203ad96090aSBlue Swirl " set OpenBIOS nvram variables\n", 3204ad96090aSBlue Swirl QEMU_ARCH_PPC | QEMU_ARCH_SPARC) 320595d5f08bSStefan WeilSTEXI 320695d5f08bSStefan Weil@item -prom-env @var{variable}=@var{value} 32076616b2adSStefan Weil@findex -prom-env 320895d5f08bSStefan WeilSet OpenBIOS nvram @var{variable} to given @var{value} (PPC, SPARC only). 320995d5f08bSStefan WeilETEXI 32105824d651Sblueswir1DEF("semihosting", 0, QEMU_OPTION_semihosting, 3211f7bbcfb5SMichael Walle "-semihosting semihosting mode\n", 3212f7bbcfb5SMichael Walle QEMU_ARCH_ARM | QEMU_ARCH_M68K | QEMU_ARCH_XTENSA | QEMU_ARCH_LM32) 321395d5f08bSStefan WeilSTEXI 321495d5f08bSStefan Weil@item -semihosting 32156616b2adSStefan Weil@findex -semihosting 32161ddeaa5dSMax FilippovSemihosting mode (ARM, M68K, Xtensa only). 321795d5f08bSStefan WeilETEXI 32185824d651Sblueswir1DEF("old-param", 0, QEMU_OPTION_old_param, 3219ad96090aSBlue Swirl "-old-param old param mode\n", QEMU_ARCH_ARM) 322095d5f08bSStefan WeilSTEXI 322195d5f08bSStefan Weil@item -old-param 32226616b2adSStefan Weil@findex -old-param (ARM) 322395d5f08bSStefan WeilOld param mode (ARM only). 322495d5f08bSStefan WeilETEXI 322595d5f08bSStefan Weil 32267d76ad4fSEduardo OtuboDEF("sandbox", HAS_ARG, QEMU_OPTION_sandbox, \ 32277d76ad4fSEduardo Otubo "-sandbox <arg> Enable seccomp mode 2 system call filter (default 'off').\n", 32287d76ad4fSEduardo Otubo QEMU_ARCH_ALL) 32297d76ad4fSEduardo OtuboSTEXI 32306265c43bSMarkus Armbruster@item -sandbox @var{arg} 32317d76ad4fSEduardo Otubo@findex -sandbox 32327d76ad4fSEduardo OtuboEnable Seccomp mode 2 system call filter. 'on' will enable syscall filtering and 'off' will 32337d76ad4fSEduardo Otubodisable it. The default is 'off'. 32347d76ad4fSEduardo OtuboETEXI 32357d76ad4fSEduardo Otubo 3236715a664aSGerd HoffmannDEF("readconfig", HAS_ARG, QEMU_OPTION_readconfig, 3237ad96090aSBlue Swirl "-readconfig <file>\n", QEMU_ARCH_ALL) 32383dbf2c7fSStefan WeilSTEXI 32393dbf2c7fSStefan Weil@item -readconfig @var{file} 32406616b2adSStefan Weil@findex -readconfig 3241ed24cfacSMichal NovotnyRead device configuration from @var{file}. This approach is useful when you want to spawn 3242ed24cfacSMichal NovotnyQEMU process with many command line options but you don't want to exceed the command line 3243ed24cfacSMichal Novotnycharacter limit. 32443dbf2c7fSStefan WeilETEXI 3245715a664aSGerd HoffmannDEF("writeconfig", HAS_ARG, QEMU_OPTION_writeconfig, 3246715a664aSGerd Hoffmann "-writeconfig <file>\n" 3247ad96090aSBlue Swirl " read/write config file\n", QEMU_ARCH_ALL) 32483dbf2c7fSStefan WeilSTEXI 32493dbf2c7fSStefan Weil@item -writeconfig @var{file} 32506616b2adSStefan Weil@findex -writeconfig 3251ed24cfacSMichal NovotnyWrite device configuration to @var{file}. The @var{file} can be either filename to save 3252ed24cfacSMichal Novotnycommand line and device configuration into file or dash @code{-}) character to print the 3253ed24cfacSMichal Novotnyoutput to stdout. This can be later used as input file for @code{-readconfig} option. 32543dbf2c7fSStefan WeilETEXI 3255292444cbSAnthony LiguoriDEF("nodefconfig", 0, QEMU_OPTION_nodefconfig, 3256292444cbSAnthony Liguori "-nodefconfig\n" 3257ad96090aSBlue Swirl " do not load default config files at startup\n", 3258ad96090aSBlue Swirl QEMU_ARCH_ALL) 3259292444cbSAnthony LiguoriSTEXI 3260292444cbSAnthony Liguori@item -nodefconfig 32616616b2adSStefan Weil@findex -nodefconfig 3262f29a5614SEduardo HabkostNormally QEMU loads configuration files from @var{sysconfdir} and @var{datadir} at startup. 3263f29a5614SEduardo HabkostThe @code{-nodefconfig} option will prevent QEMU from loading any of those config files. 3264f29a5614SEduardo HabkostETEXI 3265f29a5614SEduardo HabkostDEF("no-user-config", 0, QEMU_OPTION_nouserconfig, 3266f29a5614SEduardo Habkost "-no-user-config\n" 3267f29a5614SEduardo Habkost " do not load user-provided config files at startup\n", 3268f29a5614SEduardo Habkost QEMU_ARCH_ALL) 3269f29a5614SEduardo HabkostSTEXI 3270f29a5614SEduardo Habkost@item -no-user-config 3271f29a5614SEduardo Habkost@findex -no-user-config 3272f29a5614SEduardo HabkostThe @code{-no-user-config} option makes QEMU not load any of the user-provided 3273f29a5614SEduardo Habkostconfig files on @var{sysconfdir}, but won't make it skip the QEMU-provided config 3274f29a5614SEduardo Habkostfiles from @var{datadir}. 3275292444cbSAnthony LiguoriETEXI 3276ab6540d5SPrerna SaxenaDEF("trace", HAS_ARG, QEMU_OPTION_trace, 327723d15e86SLluís "-trace [events=<file>][,file=<file>]\n" 327823d15e86SLluís " specify tracing options\n", 3279ab6540d5SPrerna Saxena QEMU_ARCH_ALL) 3280ab6540d5SPrerna SaxenaSTEXI 328123d15e86SLluísHXCOMM This line is not accurate, as some sub-options are backend-specific but 328223d15e86SLluísHXCOMM HX does not support conditional compilation of text. 328323d15e86SLluís@item -trace [events=@var{file}][,file=@var{file}] 3284ab6540d5SPrerna Saxena@findex -trace 3285e4858974SLluís 328623d15e86SLluísSpecify tracing options. 328723d15e86SLluís 328823d15e86SLluís@table @option 328923d15e86SLluís@item events=@var{file} 329023d15e86SLluísImmediately enable events listed in @var{file}. 329123d15e86SLluísThe file must contain one event name (as listed in the @var{trace-events} file) 329223d15e86SLluísper line. 3293c1ba4e0bSStefan WeilThis option is only available if QEMU has been compiled with 3294c1ba4e0bSStefan Weileither @var{simple} or @var{stderr} tracing backend. 329523d15e86SLluís@item file=@var{file} 329623d15e86SLluísLog output traces to @var{file}. 329723d15e86SLluís 3298c1ba4e0bSStefan WeilThis option is only available if QEMU has been compiled with 3299c1ba4e0bSStefan Weilthe @var{simple} tracing backend. 330023d15e86SLluís@end table 3301ab6540d5SPrerna SaxenaETEXI 33023dbf2c7fSStefan Weil 330331e70d6cSMarkus ArmbrusterHXCOMM Internal use 330431e70d6cSMarkus ArmbrusterDEF("qtest", HAS_ARG, QEMU_OPTION_qtest, "", QEMU_ARCH_ALL) 330531e70d6cSMarkus ArmbrusterDEF("qtest-log", HAS_ARG, QEMU_OPTION_qtest_log, "", QEMU_ARCH_ALL) 3306c7f0f3b1SAnthony Liguori 33070f66998fSPaul Moore#ifdef __linux__ 33080f66998fSPaul MooreDEF("enable-fips", 0, QEMU_OPTION_enablefips, 33090f66998fSPaul Moore "-enable-fips enable FIPS 140-2 compliance\n", 33100f66998fSPaul Moore QEMU_ARCH_ALL) 33110f66998fSPaul Moore#endif 33120f66998fSPaul MooreSTEXI 33130f66998fSPaul Moore@item -enable-fips 33140f66998fSPaul Moore@findex -enable-fips 33150f66998fSPaul MooreEnable FIPS 140-2 compliance mode. 33160f66998fSPaul MooreETEXI 33170f66998fSPaul Moore 3318a0dac021SJan KiszkaHXCOMM Deprecated by -machine accel=tcg property 3319c6e88b3bSBruce RogersDEF("no-kvm", 0, QEMU_OPTION_no_kvm, "", QEMU_ARCH_I386) 3320a0dac021SJan Kiszka 3321c21fb4f8SJan KiszkaHXCOMM Deprecated by kvm-pit driver properties 3322c6e88b3bSBruce RogersDEF("no-kvm-pit-reinjection", 0, QEMU_OPTION_no_kvm_pit_reinjection, 3323c21fb4f8SJan Kiszka "", QEMU_ARCH_I386) 3324c21fb4f8SJan Kiszka 33254086bde8SJan KiszkaHXCOMM Deprecated (ignored) 3326c6e88b3bSBruce RogersDEF("no-kvm-pit", 0, QEMU_OPTION_no_kvm_pit, "", QEMU_ARCH_I386) 33274086bde8SJan Kiszka 3328e43d594eSJan KiszkaHXCOMM Deprecated by -machine kernel_irqchip=on|off property 3329c6e88b3bSBruce RogersDEF("no-kvm-irqchip", 0, QEMU_OPTION_no_kvm_irqchip, "", QEMU_ARCH_I386) 3330e43d594eSJan Kiszka 333188eed34aSJan KiszkaHXCOMM Deprecated (ignored) 333288eed34aSJan KiszkaDEF("tdf", 0, QEMU_OPTION_tdf,"", QEMU_ARCH_ALL) 333388eed34aSJan Kiszka 333468d98d3eSAnthony LiguoriDEF("object", HAS_ARG, QEMU_OPTION_object, 333568d98d3eSAnthony Liguori "-object TYPENAME[,PROP1=VALUE1,...]\n" 333668d98d3eSAnthony Liguori " create an new object of type TYPENAME setting properties\n" 333768d98d3eSAnthony Liguori " in the order they are specified. Note that the 'id'\n" 333868d98d3eSAnthony Liguori " property must be set. These objects are placed in the\n" 333968d98d3eSAnthony Liguori " '/objects' path.\n", 334068d98d3eSAnthony Liguori QEMU_ARCH_ALL) 33416265c43bSMarkus ArmbrusterSTEXI 33426265c43bSMarkus Armbruster@item -object @var{typename}[,@var{prop1}=@var{value1},...] 33436265c43bSMarkus Armbruster@findex -object 33446265c43bSMarkus ArmbrusterCreate an new object of type @var{typename} setting properties 33456265c43bSMarkus Armbrusterin the order they are specified. Note that the 'id' 33466265c43bSMarkus Armbrusterproperty must be set. These objects are placed in the 33476265c43bSMarkus Armbruster'/objects' path. 33486265c43bSMarkus ArmbrusterETEXI 334968d98d3eSAnthony Liguori 33505e2ac519SSeiji AguchiDEF("msg", HAS_ARG, QEMU_OPTION_msg, 33515e2ac519SSeiji Aguchi "-msg timestamp[=on|off]\n" 33525e2ac519SSeiji Aguchi " change the format of messages\n" 33535e2ac519SSeiji Aguchi " on|off controls leading timestamps (default:on)\n", 33545e2ac519SSeiji Aguchi QEMU_ARCH_ALL) 33555e2ac519SSeiji AguchiSTEXI 33565e2ac519SSeiji Aguchi@item -msg timestamp[=on|off] 33575e2ac519SSeiji Aguchi@findex -msg 33585e2ac519SSeiji Aguchiprepend a timestamp to each log message.(default:on) 33595e2ac519SSeiji AguchiETEXI 33605e2ac519SSeiji Aguchi 3361abfd9ce3SAmit ShahDEF("dump-vmstate", HAS_ARG, QEMU_OPTION_dump_vmstate, 3362abfd9ce3SAmit Shah "-dump-vmstate <file>\n" 3363abfd9ce3SAmit Shah " Output vmstate information in JSON format to file.\n" 3364abfd9ce3SAmit Shah " Use the scripts/vmstate-static-checker.py file to\n" 3365abfd9ce3SAmit Shah " check for possible regressions in migration code\n" 3366abfd9ce3SAmit Shah " by comparing two such vmstate dumps.", 3367abfd9ce3SAmit Shah QEMU_ARCH_ALL) 3368abfd9ce3SAmit ShahSTEXI 3369abfd9ce3SAmit Shah@item -dump-vmstate @var{file} 3370abfd9ce3SAmit Shah@findex -dump-vmstate 3371abfd9ce3SAmit ShahDump json-encoded vmstate information for current machine type to file 3372abfd9ce3SAmit Shahin @var{file} 3373abfd9ce3SAmit ShahETEXI 3374abfd9ce3SAmit Shah 33753dbf2c7fSStefan WeilHXCOMM This is the last statement. Insert new options before this line! 33763dbf2c7fSStefan WeilSTEXI 33773dbf2c7fSStefan Weil@end table 33783dbf2c7fSStefan WeilETEXI 3379