15824d651Sblueswir1HXCOMM Use DEFHEADING() to define headings in both help text and texi 25824d651Sblueswir1HXCOMM Text between STEXI and ETEXI are copied to texi version and 35824d651Sblueswir1HXCOMM discarded from C version 4ad96090aSBlue SwirlHXCOMM DEF(option, HAS_ARG/0, opt_enum, opt_help, arch_mask) is used to 5ad96090aSBlue SwirlHXCOMM construct option structures, enums and help message for specified 6ad96090aSBlue SwirlHXCOMM architectures. 75824d651Sblueswir1HXCOMM HXCOMM can be used for comments, discarded from both texi and C 85824d651Sblueswir1 95824d651Sblueswir1DEFHEADING(Standard options:) 105824d651Sblueswir1STEXI 115824d651Sblueswir1@table @option 125824d651Sblueswir1ETEXI 135824d651Sblueswir1 145824d651Sblueswir1DEF("help", 0, QEMU_OPTION_h, 15ad96090aSBlue Swirl "-h or -help display this help and exit\n", QEMU_ARCH_ALL) 165824d651Sblueswir1STEXI 175824d651Sblueswir1@item -h 186616b2adSStefan Weil@findex -h 195824d651Sblueswir1Display help and exit 205824d651Sblueswir1ETEXI 215824d651Sblueswir1 229bd7e6d9SpbrookDEF("version", 0, QEMU_OPTION_version, 23ad96090aSBlue Swirl "-version display version information and exit\n", QEMU_ARCH_ALL) 249bd7e6d9SpbrookSTEXI 259bd7e6d9Spbrook@item -version 266616b2adSStefan Weil@findex -version 279bd7e6d9SpbrookDisplay version information and exit 289bd7e6d9SpbrookETEXI 299bd7e6d9Spbrook 3080f52a66SJan KiszkaDEF("machine", HAS_ARG, QEMU_OPTION_machine, \ 3180f52a66SJan Kiszka "-machine [type=]name[,prop[=value][,...]]\n" 32585f6036SPeter Maydell " selects emulated machine ('-machine help' for list)\n" 3380f52a66SJan Kiszka " property accel=accel1[:accel2[:...]] selects accelerator\n" 346a48ffaaSJan Kiszka " supported accelerators are kvm, xen, tcg (default: tcg)\n" 3539d6960aSJan Kiszka " kernel_irqchip=on|off controls accelerated irqchip support\n" 36ddb97f1dSJason Baron " kvm_shadow_mem=size of KVM shadow MMU\n" 378490fc78SLuiz Capitulino " dump-guest-core=on|off include guest memory in a core dump (default=on)\n" 388490fc78SLuiz Capitulino " mem-merge=on|off controls memory merge support (default: on)\n", 3980f52a66SJan Kiszka QEMU_ARCH_ALL) 405824d651Sblueswir1STEXI 4180f52a66SJan Kiszka@item -machine [type=]@var{name}[,prop=@var{value}[,...]] 4280f52a66SJan Kiszka@findex -machine 43585f6036SPeter MaydellSelect the emulated machine by @var{name}. Use @code{-machine help} to list 4480f52a66SJan Kiszkaavailable machines. Supported machine properties are: 4580f52a66SJan Kiszka@table @option 4680f52a66SJan Kiszka@item accel=@var{accels1}[:@var{accels2}[:...]] 4780f52a66SJan KiszkaThis is used to enable an accelerator. Depending on the target architecture, 4880f52a66SJan Kiszkakvm, xen, or tcg can be available. By default, tcg is used. If there is more 4980f52a66SJan Kiszkathan one accelerator specified, the next one is used if the previous one fails 5080f52a66SJan Kiszkato initialize. 516a48ffaaSJan Kiszka@item kernel_irqchip=on|off 526a48ffaaSJan KiszkaEnables in-kernel irqchip support for the chosen accelerator when available. 5339d6960aSJan Kiszka@item kvm_shadow_mem=size 5439d6960aSJan KiszkaDefines the size of the KVM shadow MMU. 55ddb97f1dSJason Baron@item dump-guest-core=on|off 56ddb97f1dSJason BaronInclude guest memory in a core dump. The default is on. 578490fc78SLuiz Capitulino@item mem-merge=on|off 588490fc78SLuiz CapitulinoEnables or disables memory merge support. This feature, when supported by 598490fc78SLuiz Capitulinothe host, de-duplicates identical memory pages among VMs instances 608490fc78SLuiz Capitulino(enabled by default). 6180f52a66SJan Kiszka@end table 625824d651Sblueswir1ETEXI 635824d651Sblueswir1 6480f52a66SJan KiszkaHXCOMM Deprecated by -machine 6580f52a66SJan KiszkaDEF("M", HAS_ARG, QEMU_OPTION_M, "", QEMU_ARCH_ALL) 6680f52a66SJan Kiszka 675824d651Sblueswir1DEF("cpu", HAS_ARG, QEMU_OPTION_cpu, 68585f6036SPeter Maydell "-cpu cpu select CPU ('-cpu help' for list)\n", QEMU_ARCH_ALL) 695824d651Sblueswir1STEXI 705824d651Sblueswir1@item -cpu @var{model} 716616b2adSStefan Weil@findex -cpu 72585f6036SPeter MaydellSelect CPU model (@code{-cpu help} for list and additional feature selection) 735824d651Sblueswir1ETEXI 745824d651Sblueswir1 755824d651Sblueswir1DEF("smp", HAS_ARG, QEMU_OPTION_smp, 7612b7f57eSMichael Tokarev "-smp [cpus=]n[,maxcpus=cpus][,cores=cores][,threads=threads][,sockets=sockets]\n" 776be68d7eSJes Sorensen " set the number of CPUs to 'n' [default=1]\n" 786be68d7eSJes Sorensen " maxcpus= maximum number of total cpus, including\n" 79ca1a8a06SBruce Rogers " offline CPUs for hotplug, etc\n" 8058a04db1SAndre Przywara " cores= number of CPU cores on one socket\n" 8158a04db1SAndre Przywara " threads= number of threads on one CPU core\n" 82ad96090aSBlue Swirl " sockets= number of discrete sockets in the system\n", 83ad96090aSBlue Swirl QEMU_ARCH_ALL) 845824d651Sblueswir1STEXI 8512b7f57eSMichael Tokarev@item -smp [cpus=]@var{n}[,cores=@var{cores}][,threads=@var{threads}][,sockets=@var{sockets}][,maxcpus=@var{maxcpus}] 866616b2adSStefan Weil@findex -smp 875824d651Sblueswir1Simulate an SMP system with @var{n} CPUs. On the PC target, up to 255 885824d651Sblueswir1CPUs are supported. On Sparc32 target, Linux limits the number of usable CPUs 895824d651Sblueswir1to 4. 9058a04db1SAndre PrzywaraFor the PC target, the number of @var{cores} per socket, the number 9158a04db1SAndre Przywaraof @var{threads} per cores and the total number of @var{sockets} can be 9258a04db1SAndre Przywaraspecified. Missing values will be computed. If any on the three values is 9358a04db1SAndre Przywaragiven, the total number of CPUs @var{n} can be omitted. @var{maxcpus} 9458a04db1SAndre Przywaraspecifies the maximum number of hotpluggable CPUs. 955824d651Sblueswir1ETEXI 965824d651Sblueswir1 97268a362cSaliguoriDEF("numa", HAS_ARG, QEMU_OPTION_numa, 98ad96090aSBlue Swirl "-numa node[,mem=size][,cpus=cpu[-cpu]][,nodeid=node]\n", QEMU_ARCH_ALL) 99268a362cSaliguoriSTEXI 100268a362cSaliguori@item -numa @var{opts} 1016616b2adSStefan Weil@findex -numa 102268a362cSaliguoriSimulate a multi node NUMA system. If mem and cpus are omitted, resources 103268a362cSaliguoriare split equally. 104268a362cSaliguoriETEXI 105268a362cSaliguori 10610adb8beSMarkus ArmbrusterDEF("add-fd", HAS_ARG, QEMU_OPTION_add_fd, 10710adb8beSMarkus Armbruster "-add-fd fd=fd,set=set[,opaque=opaque]\n" 10810adb8beSMarkus Armbruster " Add 'fd' to fd 'set'\n", QEMU_ARCH_ALL) 10910adb8beSMarkus ArmbrusterSTEXI 11010adb8beSMarkus Armbruster@item -add-fd fd=@var{fd},set=@var{set}[,opaque=@var{opaque}] 11110adb8beSMarkus Armbruster@findex -add-fd 11210adb8beSMarkus Armbruster 11310adb8beSMarkus ArmbrusterAdd a file descriptor to an fd set. Valid options are: 11410adb8beSMarkus Armbruster 11510adb8beSMarkus Armbruster@table @option 11610adb8beSMarkus Armbruster@item fd=@var{fd} 11710adb8beSMarkus ArmbrusterThis option defines the file descriptor of which a duplicate is added to fd set. 11810adb8beSMarkus ArmbrusterThe file descriptor cannot be stdin, stdout, or stderr. 11910adb8beSMarkus Armbruster@item set=@var{set} 12010adb8beSMarkus ArmbrusterThis option defines the ID of the fd set to add the file descriptor to. 12110adb8beSMarkus Armbruster@item opaque=@var{opaque} 12210adb8beSMarkus ArmbrusterThis option defines a free-form string that can be used to describe @var{fd}. 12310adb8beSMarkus Armbruster@end table 12410adb8beSMarkus Armbruster 12510adb8beSMarkus ArmbrusterYou can open an image using pre-opened file descriptors from an fd set: 12610adb8beSMarkus Armbruster@example 12710adb8beSMarkus Armbrusterqemu-system-i386 12810adb8beSMarkus Armbruster-add-fd fd=3,set=2,opaque="rdwr:/path/to/file" 12910adb8beSMarkus Armbruster-add-fd fd=4,set=2,opaque="rdonly:/path/to/file" 13010adb8beSMarkus Armbruster-drive file=/dev/fdset/2,index=0,media=disk 13110adb8beSMarkus Armbruster@end example 13210adb8beSMarkus ArmbrusterETEXI 13310adb8beSMarkus Armbruster 13410adb8beSMarkus ArmbrusterDEF("set", HAS_ARG, QEMU_OPTION_set, 13510adb8beSMarkus Armbruster "-set group.id.arg=value\n" 13610adb8beSMarkus Armbruster " set <arg> parameter for item <id> of type <group>\n" 13710adb8beSMarkus Armbruster " i.e. -set drive.$id.file=/path/to/image\n", QEMU_ARCH_ALL) 13810adb8beSMarkus ArmbrusterSTEXI 13910adb8beSMarkus Armbruster@item -set @var{group}.@var{id}.@var{arg}=@var{value} 14010adb8beSMarkus Armbruster@findex -set 14110adb8beSMarkus ArmbrusterSet parameter @var{arg} for item @var{id} of type @var{group}\n" 14210adb8beSMarkus ArmbrusterETEXI 14310adb8beSMarkus Armbruster 14410adb8beSMarkus ArmbrusterDEF("global", HAS_ARG, QEMU_OPTION_global, 14510adb8beSMarkus Armbruster "-global driver.prop=value\n" 14610adb8beSMarkus Armbruster " set a global default for a driver property\n", 14710adb8beSMarkus Armbruster QEMU_ARCH_ALL) 14810adb8beSMarkus ArmbrusterSTEXI 14910adb8beSMarkus Armbruster@item -global @var{driver}.@var{prop}=@var{value} 15010adb8beSMarkus Armbruster@findex -global 15110adb8beSMarkus ArmbrusterSet default value of @var{driver}'s property @var{prop} to @var{value}, e.g.: 15210adb8beSMarkus Armbruster 15310adb8beSMarkus Armbruster@example 15410adb8beSMarkus Armbrusterqemu-system-i386 -global ide-drive.physical_block_size=4096 -drive file=file,if=ide,index=0,media=disk 15510adb8beSMarkus Armbruster@end example 15610adb8beSMarkus Armbruster 15710adb8beSMarkus ArmbrusterIn particular, you can use this to set driver properties for devices which are 15810adb8beSMarkus Armbrustercreated automatically by the machine model. To create a device which is not 15910adb8beSMarkus Armbrustercreated automatically and set properties on it, use -@option{device}. 16010adb8beSMarkus ArmbrusterETEXI 16110adb8beSMarkus Armbruster 16210adb8beSMarkus ArmbrusterDEF("boot", HAS_ARG, QEMU_OPTION_boot, 16310adb8beSMarkus Armbruster "-boot [order=drives][,once=drives][,menu=on|off]\n" 164c8a6ae8bSAmos Kong " [,splash=sp_name][,splash-time=sp_time][,reboot-timeout=rb_time][,strict=on|off]\n" 16510adb8beSMarkus Armbruster " 'drives': floppy (a), hard disk (c), CD-ROM (d), network (n)\n" 16610adb8beSMarkus Armbruster " 'sp_name': the file's name that would be passed to bios as logo picture, if menu=on\n" 16710adb8beSMarkus Armbruster " 'sp_time': the period that splash picture last if menu=on, unit is ms\n" 16810adb8beSMarkus Armbruster " 'rb_timeout': the timeout before guest reboot when boot failed, unit is ms\n", 16910adb8beSMarkus Armbruster QEMU_ARCH_ALL) 17010adb8beSMarkus ArmbrusterSTEXI 171c8a6ae8bSAmos Kong@item -boot [order=@var{drives}][,once=@var{drives}][,menu=on|off][,splash=@var{sp_name}][,splash-time=@var{sp_time}][,reboot-timeout=@var{rb_timeout}][,strict=on|off] 17210adb8beSMarkus Armbruster@findex -boot 17310adb8beSMarkus ArmbrusterSpecify boot order @var{drives} as a string of drive letters. Valid 17410adb8beSMarkus Armbrusterdrive letters depend on the target achitecture. The x86 PC uses: a, b 17510adb8beSMarkus Armbruster(floppy 1 and 2), c (first hard disk), d (first CD-ROM), n-p (Etherboot 17610adb8beSMarkus Armbrusterfrom network adapter 1-4), hard disk boot is the default. To apply a 17710adb8beSMarkus Armbrusterparticular boot order only on the first startup, specify it via 17810adb8beSMarkus Armbruster@option{once}. 17910adb8beSMarkus Armbruster 18010adb8beSMarkus ArmbrusterInteractive boot menus/prompts can be enabled via @option{menu=on} as far 18110adb8beSMarkus Armbrusteras firmware/BIOS supports them. The default is non-interactive boot. 18210adb8beSMarkus Armbruster 18310adb8beSMarkus ArmbrusterA splash picture could be passed to bios, enabling user to show it as logo, 18410adb8beSMarkus Armbrusterwhen option splash=@var{sp_name} is given and menu=on, If firmware/BIOS 18510adb8beSMarkus Armbrustersupports them. Currently Seabios for X86 system support it. 18610adb8beSMarkus Armbrusterlimitation: The splash file could be a jpeg file or a BMP file in 24 BPP 18710adb8beSMarkus Armbrusterformat(true color). The resolution should be supported by the SVGA mode, so 18810adb8beSMarkus Armbrusterthe recommended is 320x240, 640x480, 800x640. 18910adb8beSMarkus Armbruster 19010adb8beSMarkus ArmbrusterA timeout could be passed to bios, guest will pause for @var{rb_timeout} ms 19110adb8beSMarkus Armbrusterwhen boot failed, then reboot. If @var{rb_timeout} is '-1', guest will not 19210adb8beSMarkus Armbrusterreboot, qemu passes '-1' to bios by default. Currently Seabios for X86 19310adb8beSMarkus Armbrustersystem support it. 19410adb8beSMarkus Armbruster 195c8a6ae8bSAmos KongDo strict boot via @option{strict=on} as far as firmware/BIOS 196c8a6ae8bSAmos Kongsupports it. This only effects when boot priority is changed by 197c8a6ae8bSAmos Kongbootindex options. The default is non-strict boot. 198c8a6ae8bSAmos Kong 19910adb8beSMarkus Armbruster@example 20010adb8beSMarkus Armbruster# try to boot from network first, then from hard disk 20110adb8beSMarkus Armbrusterqemu-system-i386 -boot order=nc 20210adb8beSMarkus Armbruster# boot from CD-ROM first, switch back to default order after reboot 20310adb8beSMarkus Armbrusterqemu-system-i386 -boot once=d 20410adb8beSMarkus Armbruster# boot with a splash picture for 5 seconds. 20510adb8beSMarkus Armbrusterqemu-system-i386 -boot menu=on,splash=/root/boot.bmp,splash-time=5000 20610adb8beSMarkus Armbruster@end example 20710adb8beSMarkus Armbruster 20810adb8beSMarkus ArmbrusterNote: The legacy format '-boot @var{drives}' is still supported but its 20910adb8beSMarkus Armbrusteruse is discouraged as it may be removed from future versions. 21010adb8beSMarkus ArmbrusterETEXI 21110adb8beSMarkus Armbruster 21210adb8beSMarkus ArmbrusterDEF("m", HAS_ARG, QEMU_OPTION_m, 213*c270fb9eSIgor Mammedov "-m[emory] [size=]megs[,slots=n,maxmem=size]\n" 2146e1d3c1cSIgor Mammedov " configure guest RAM\n" 2156e1d3c1cSIgor Mammedov " size: initial amount of guest memory (default: " 216*c270fb9eSIgor Mammedov stringify(DEFAULT_RAM_SIZE) "MiB)\n" 217*c270fb9eSIgor Mammedov " slots: number of hotplug slots (default: none)\n" 218*c270fb9eSIgor Mammedov " maxmem: maximum amount of guest memory (default: none)\n", 2196e1d3c1cSIgor Mammedov QEMU_ARCH_ALL) 22010adb8beSMarkus ArmbrusterSTEXI 2216e1d3c1cSIgor Mammedov@item -m [size=]@var{megs} 22210adb8beSMarkus Armbruster@findex -m 22310adb8beSMarkus ArmbrusterSet virtual RAM size to @var{megs} megabytes. Default is 128 MiB. Optionally, 22410adb8beSMarkus Armbrustera suffix of ``M'' or ``G'' can be used to signify a value in megabytes or 225*c270fb9eSIgor Mammedovgigabytes respectively. Optional pair @var{slots}, @var{maxmem} could be used 226*c270fb9eSIgor Mammedovto set amount of hotluggable memory slots and possible maximum amount of memory. 22710adb8beSMarkus ArmbrusterETEXI 22810adb8beSMarkus Armbruster 22910adb8beSMarkus ArmbrusterDEF("mem-path", HAS_ARG, QEMU_OPTION_mempath, 23010adb8beSMarkus Armbruster "-mem-path FILE provide backing storage for guest RAM\n", QEMU_ARCH_ALL) 23110adb8beSMarkus ArmbrusterSTEXI 23210adb8beSMarkus Armbruster@item -mem-path @var{path} 23310adb8beSMarkus Armbruster@findex -mem-path 23410adb8beSMarkus ArmbrusterAllocate guest RAM from a temporarily created file in @var{path}. 23510adb8beSMarkus ArmbrusterETEXI 23610adb8beSMarkus Armbruster 23710adb8beSMarkus ArmbrusterDEF("mem-prealloc", 0, QEMU_OPTION_mem_prealloc, 23810adb8beSMarkus Armbruster "-mem-prealloc preallocate guest memory (use with -mem-path)\n", 23910adb8beSMarkus Armbruster QEMU_ARCH_ALL) 24010adb8beSMarkus ArmbrusterSTEXI 24110adb8beSMarkus Armbruster@item -mem-prealloc 24210adb8beSMarkus Armbruster@findex -mem-prealloc 24310adb8beSMarkus ArmbrusterPreallocate memory when using -mem-path. 24410adb8beSMarkus ArmbrusterETEXI 24510adb8beSMarkus Armbruster 24610adb8beSMarkus ArmbrusterDEF("k", HAS_ARG, QEMU_OPTION_k, 24710adb8beSMarkus Armbruster "-k language use keyboard layout (for example 'fr' for French)\n", 24810adb8beSMarkus Armbruster QEMU_ARCH_ALL) 24910adb8beSMarkus ArmbrusterSTEXI 25010adb8beSMarkus Armbruster@item -k @var{language} 25110adb8beSMarkus Armbruster@findex -k 25210adb8beSMarkus ArmbrusterUse keyboard layout @var{language} (for example @code{fr} for 25310adb8beSMarkus ArmbrusterFrench). This option is only needed where it is not easy to get raw PC 25410adb8beSMarkus Armbrusterkeycodes (e.g. on Macs, with some X11 servers or with a VNC 25510adb8beSMarkus Armbrusterdisplay). You don't normally need to use it on PC/Linux or PC/Windows 25610adb8beSMarkus Armbrusterhosts. 25710adb8beSMarkus Armbruster 25810adb8beSMarkus ArmbrusterThe available layouts are: 25910adb8beSMarkus Armbruster@example 26010adb8beSMarkus Armbrusterar de-ch es fo fr-ca hu ja mk no pt-br sv 26110adb8beSMarkus Armbrusterda en-gb et fr fr-ch is lt nl pl ru th 26210adb8beSMarkus Armbrusterde en-us fi fr-be hr it lv nl-be pt sl tr 26310adb8beSMarkus Armbruster@end example 26410adb8beSMarkus Armbruster 26510adb8beSMarkus ArmbrusterThe default is @code{en-us}. 26610adb8beSMarkus ArmbrusterETEXI 26710adb8beSMarkus Armbruster 26810adb8beSMarkus Armbruster 26910adb8beSMarkus ArmbrusterDEF("audio-help", 0, QEMU_OPTION_audio_help, 27010adb8beSMarkus Armbruster "-audio-help print list of audio drivers and their options\n", 27110adb8beSMarkus Armbruster QEMU_ARCH_ALL) 27210adb8beSMarkus ArmbrusterSTEXI 27310adb8beSMarkus Armbruster@item -audio-help 27410adb8beSMarkus Armbruster@findex -audio-help 27510adb8beSMarkus ArmbrusterWill show the audio subsystem help: list of drivers, tunable 27610adb8beSMarkus Armbrusterparameters. 27710adb8beSMarkus ArmbrusterETEXI 27810adb8beSMarkus Armbruster 27910adb8beSMarkus ArmbrusterDEF("soundhw", HAS_ARG, QEMU_OPTION_soundhw, 28010adb8beSMarkus Armbruster "-soundhw c1,... enable audio support\n" 28110adb8beSMarkus Armbruster " and only specified sound cards (comma separated list)\n" 28210adb8beSMarkus Armbruster " use '-soundhw help' to get the list of supported cards\n" 28310adb8beSMarkus Armbruster " use '-soundhw all' to enable all of them\n", QEMU_ARCH_ALL) 28410adb8beSMarkus ArmbrusterSTEXI 28510adb8beSMarkus Armbruster@item -soundhw @var{card1}[,@var{card2},...] or -soundhw all 28610adb8beSMarkus Armbruster@findex -soundhw 28710adb8beSMarkus ArmbrusterEnable audio and selected sound hardware. Use 'help' to print all 28810adb8beSMarkus Armbrusteravailable sound hardware. 28910adb8beSMarkus Armbruster 29010adb8beSMarkus Armbruster@example 29110adb8beSMarkus Armbrusterqemu-system-i386 -soundhw sb16,adlib disk.img 29210adb8beSMarkus Armbrusterqemu-system-i386 -soundhw es1370 disk.img 29310adb8beSMarkus Armbrusterqemu-system-i386 -soundhw ac97 disk.img 29410adb8beSMarkus Armbrusterqemu-system-i386 -soundhw hda disk.img 29510adb8beSMarkus Armbrusterqemu-system-i386 -soundhw all disk.img 29610adb8beSMarkus Armbrusterqemu-system-i386 -soundhw help 29710adb8beSMarkus Armbruster@end example 29810adb8beSMarkus Armbruster 29910adb8beSMarkus ArmbrusterNote that Linux's i810_audio OSS kernel (for AC97) module might 30010adb8beSMarkus Armbrusterrequire manually specifying clocking. 30110adb8beSMarkus Armbruster 30210adb8beSMarkus Armbruster@example 30310adb8beSMarkus Armbrustermodprobe i810_audio clocking=48000 30410adb8beSMarkus Armbruster@end example 30510adb8beSMarkus ArmbrusterETEXI 30610adb8beSMarkus Armbruster 30710adb8beSMarkus ArmbrusterDEF("balloon", HAS_ARG, QEMU_OPTION_balloon, 30810adb8beSMarkus Armbruster "-balloon none disable balloon device\n" 30910adb8beSMarkus Armbruster "-balloon virtio[,addr=str]\n" 31010adb8beSMarkus Armbruster " enable virtio balloon device (default)\n", QEMU_ARCH_ALL) 31110adb8beSMarkus ArmbrusterSTEXI 31210adb8beSMarkus Armbruster@item -balloon none 31310adb8beSMarkus Armbruster@findex -balloon 31410adb8beSMarkus ArmbrusterDisable balloon device. 31510adb8beSMarkus Armbruster@item -balloon virtio[,addr=@var{addr}] 31610adb8beSMarkus ArmbrusterEnable virtio balloon device (default), optionally with PCI address 31710adb8beSMarkus Armbruster@var{addr}. 31810adb8beSMarkus ArmbrusterETEXI 31910adb8beSMarkus Armbruster 32010adb8beSMarkus ArmbrusterDEF("device", HAS_ARG, QEMU_OPTION_device, 32110adb8beSMarkus Armbruster "-device driver[,prop[=value][,...]]\n" 32210adb8beSMarkus Armbruster " add device (based on driver)\n" 32310adb8beSMarkus Armbruster " prop=value,... sets driver properties\n" 32410adb8beSMarkus Armbruster " use '-device help' to print all possible drivers\n" 32510adb8beSMarkus Armbruster " use '-device driver,help' to print all possible properties\n", 32610adb8beSMarkus Armbruster QEMU_ARCH_ALL) 32710adb8beSMarkus ArmbrusterSTEXI 32810adb8beSMarkus Armbruster@item -device @var{driver}[,@var{prop}[=@var{value}][,...]] 32910adb8beSMarkus Armbruster@findex -device 33010adb8beSMarkus ArmbrusterAdd device @var{driver}. @var{prop}=@var{value} sets driver 33110adb8beSMarkus Armbrusterproperties. Valid properties depend on the driver. To get help on 33210adb8beSMarkus Armbrusterpossible drivers and properties, use @code{-device help} and 33310adb8beSMarkus Armbruster@code{-device @var{driver},help}. 33410adb8beSMarkus ArmbrusterETEXI 33510adb8beSMarkus Armbruster 33610adb8beSMarkus ArmbrusterDEF("name", HAS_ARG, QEMU_OPTION_name, 3378f480de0SDr. David Alan Gilbert "-name string1[,process=string2][,debug-threads=on|off]\n" 33810adb8beSMarkus Armbruster " set the name of the guest\n" 3398f480de0SDr. David Alan Gilbert " string1 sets the window title and string2 the process name (on Linux)\n" 3408f480de0SDr. David Alan Gilbert " When debug-threads is enabled, individual threads are given a separate name (on Linux)\n" 3418f480de0SDr. David Alan Gilbert " NOTE: The thread names are for debugging and not a stable API.\n", 34210adb8beSMarkus Armbruster QEMU_ARCH_ALL) 34310adb8beSMarkus ArmbrusterSTEXI 34410adb8beSMarkus Armbruster@item -name @var{name} 34510adb8beSMarkus Armbruster@findex -name 34610adb8beSMarkus ArmbrusterSets the @var{name} of the guest. 34710adb8beSMarkus ArmbrusterThis name will be displayed in the SDL window caption. 34810adb8beSMarkus ArmbrusterThe @var{name} will also be used for the VNC server. 34910adb8beSMarkus ArmbrusterAlso optionally set the top visible process name in Linux. 3508f480de0SDr. David Alan GilbertNaming of individual threads can also be enabled on Linux to aid debugging. 35110adb8beSMarkus ArmbrusterETEXI 35210adb8beSMarkus Armbruster 35310adb8beSMarkus ArmbrusterDEF("uuid", HAS_ARG, QEMU_OPTION_uuid, 35410adb8beSMarkus Armbruster "-uuid %08x-%04x-%04x-%04x-%012x\n" 35510adb8beSMarkus Armbruster " specify machine UUID\n", QEMU_ARCH_ALL) 35610adb8beSMarkus ArmbrusterSTEXI 35710adb8beSMarkus Armbruster@item -uuid @var{uuid} 35810adb8beSMarkus Armbruster@findex -uuid 35910adb8beSMarkus ArmbrusterSet system UUID. 36010adb8beSMarkus ArmbrusterETEXI 36110adb8beSMarkus Armbruster 36210adb8beSMarkus ArmbrusterSTEXI 36310adb8beSMarkus Armbruster@end table 36410adb8beSMarkus ArmbrusterETEXI 36510adb8beSMarkus ArmbrusterDEFHEADING() 36610adb8beSMarkus Armbruster 36710adb8beSMarkus ArmbrusterDEFHEADING(Block device options:) 36810adb8beSMarkus ArmbrusterSTEXI 36910adb8beSMarkus Armbruster@table @option 37010adb8beSMarkus ArmbrusterETEXI 37110adb8beSMarkus Armbruster 3725824d651Sblueswir1DEF("fda", HAS_ARG, QEMU_OPTION_fda, 373ad96090aSBlue Swirl "-fda/-fdb file use 'file' as floppy disk 0/1 image\n", QEMU_ARCH_ALL) 374ad96090aSBlue SwirlDEF("fdb", HAS_ARG, QEMU_OPTION_fdb, "", QEMU_ARCH_ALL) 3755824d651Sblueswir1STEXI 3765824d651Sblueswir1@item -fda @var{file} 3775824d651Sblueswir1@item -fdb @var{file} 3786616b2adSStefan Weil@findex -fda 3796616b2adSStefan Weil@findex -fdb 3805824d651Sblueswir1Use @var{file} as floppy disk 0/1 image (@pxref{disk_images}). You can 3815824d651Sblueswir1use the host floppy by using @file{/dev/fd0} as filename (@pxref{host_drives}). 3825824d651Sblueswir1ETEXI 3835824d651Sblueswir1 3845824d651Sblueswir1DEF("hda", HAS_ARG, QEMU_OPTION_hda, 385ad96090aSBlue Swirl "-hda/-hdb file use 'file' as IDE hard disk 0/1 image\n", QEMU_ARCH_ALL) 386ad96090aSBlue SwirlDEF("hdb", HAS_ARG, QEMU_OPTION_hdb, "", QEMU_ARCH_ALL) 3875824d651Sblueswir1DEF("hdc", HAS_ARG, QEMU_OPTION_hdc, 388ad96090aSBlue Swirl "-hdc/-hdd file use 'file' as IDE hard disk 2/3 image\n", QEMU_ARCH_ALL) 389ad96090aSBlue SwirlDEF("hdd", HAS_ARG, QEMU_OPTION_hdd, "", QEMU_ARCH_ALL) 3905824d651Sblueswir1STEXI 3915824d651Sblueswir1@item -hda @var{file} 3925824d651Sblueswir1@item -hdb @var{file} 3935824d651Sblueswir1@item -hdc @var{file} 3945824d651Sblueswir1@item -hdd @var{file} 3956616b2adSStefan Weil@findex -hda 3966616b2adSStefan Weil@findex -hdb 3976616b2adSStefan Weil@findex -hdc 3986616b2adSStefan Weil@findex -hdd 3995824d651Sblueswir1Use @var{file} as hard disk 0, 1, 2 or 3 image (@pxref{disk_images}). 4005824d651Sblueswir1ETEXI 4015824d651Sblueswir1 4025824d651Sblueswir1DEF("cdrom", HAS_ARG, QEMU_OPTION_cdrom, 403ad96090aSBlue Swirl "-cdrom file use 'file' as IDE cdrom image (cdrom is ide1 master)\n", 404ad96090aSBlue Swirl QEMU_ARCH_ALL) 4055824d651Sblueswir1STEXI 4065824d651Sblueswir1@item -cdrom @var{file} 4076616b2adSStefan Weil@findex -cdrom 4085824d651Sblueswir1Use @var{file} as CD-ROM image (you cannot use @option{-hdc} and 4095824d651Sblueswir1@option{-cdrom} at the same time). You can use the host CD-ROM by 4105824d651Sblueswir1using @file{/dev/cdrom} as filename (@pxref{host_drives}). 4115824d651Sblueswir1ETEXI 4125824d651Sblueswir1 4135824d651Sblueswir1DEF("drive", HAS_ARG, QEMU_OPTION_drive, 4145824d651Sblueswir1 "-drive [file=file][,if=type][,bus=n][,unit=m][,media=d][,index=i]\n" 4155824d651Sblueswir1 " [,cyls=c,heads=h,secs=s[,trans=t]][,snapshot=on|off]\n" 41692196b2fSStefan Hajnoczi " [,cache=writethrough|writeback|none|directsync|unsafe][,format=f]\n" 417d1db760dSStefan Hajnoczi " [,serial=s][,addr=A][,rerror=ignore|stop|report]\n" 418d1db760dSStefan Hajnoczi " [,werror=ignore|stop|report|enospc][,id=name][,aio=threads|native]\n" 419fb0490f6SStefan Hajnoczi " [,readonly=on|off][,copy-on-read=on|off]\n" 420465bee1dSPeter Lieven " [,detect-zeroes=on|off|unmap]\n" 4213e9fab69SBenoît Canet " [[,bps=b]|[[,bps_rd=r][,bps_wr=w]]]\n" 4223e9fab69SBenoît Canet " [[,iops=i]|[[,iops_rd=r][,iops_wr=w]]]\n" 4233e9fab69SBenoît Canet " [[,bps_max=bm]|[[,bps_rd_max=rm][,bps_wr_max=wm]]]\n" 4243e9fab69SBenoît Canet " [[,iops_max=im]|[[,iops_rd_max=irm][,iops_wr_max=iwm]]]\n" 4252024c1dfSBenoît Canet " [[,iops_size=is]]\n" 426ad96090aSBlue Swirl " use 'file' as a drive image\n", QEMU_ARCH_ALL) 4275824d651Sblueswir1STEXI 4285824d651Sblueswir1@item -drive @var{option}[,@var{option}[,@var{option}[,...]]] 4296616b2adSStefan Weil@findex -drive 4305824d651Sblueswir1 4315824d651Sblueswir1Define a new drive. Valid options are: 4325824d651Sblueswir1 433b3f046c2SKevin Wolf@table @option 4345824d651Sblueswir1@item file=@var{file} 4355824d651Sblueswir1This option defines which disk image (@pxref{disk_images}) to use with 4365824d651Sblueswir1this drive. If the filename contains comma, you must double it 4375824d651Sblueswir1(for instance, "file=my,,file" to use file "my,file"). 4380f5314a2SRonnie Sahlberg 4390f5314a2SRonnie SahlbergSpecial files such as iSCSI devices can be specified using protocol 4400f5314a2SRonnie Sahlbergspecific URLs. See the section for "Device URL Syntax" for more information. 4415824d651Sblueswir1@item if=@var{interface} 4425824d651Sblueswir1This option defines on which type on interface the drive is connected. 4435824d651Sblueswir1Available types are: ide, scsi, sd, mtd, floppy, pflash, virtio. 4445824d651Sblueswir1@item bus=@var{bus},unit=@var{unit} 4455824d651Sblueswir1These options define where is connected the drive by defining the bus number and 4465824d651Sblueswir1the unit id. 4475824d651Sblueswir1@item index=@var{index} 4485824d651Sblueswir1This option defines where is connected the drive by using an index in the list 4495824d651Sblueswir1of available connectors of a given interface type. 4505824d651Sblueswir1@item media=@var{media} 4515824d651Sblueswir1This option defines the type of the media: disk or cdrom. 4525824d651Sblueswir1@item cyls=@var{c},heads=@var{h},secs=@var{s}[,trans=@var{t}] 4535824d651Sblueswir1These options have the same definition as they have in @option{-hdachs}. 4545824d651Sblueswir1@item snapshot=@var{snapshot} 4559d85d557SMichael Tokarev@var{snapshot} is "on" or "off" and controls snapshot mode for the given drive 4569d85d557SMichael Tokarev(see @option{-snapshot}). 4575824d651Sblueswir1@item cache=@var{cache} 45892196b2fSStefan Hajnoczi@var{cache} is "none", "writeback", "unsafe", "directsync" or "writethrough" and controls how the host cache is used to access block data. 4595c6c3a6cSChristoph Hellwig@item aio=@var{aio} 4605c6c3a6cSChristoph Hellwig@var{aio} is "threads", or "native" and selects between pthread based disk I/O and native Linux AIO. 461a9384affSPaolo Bonzini@item discard=@var{discard} 462a9384affSPaolo 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. 4635824d651Sblueswir1@item format=@var{format} 4645824d651Sblueswir1Specify which disk @var{format} will be used rather than detecting 4655824d651Sblueswir1the format. Can be used to specifiy format=raw to avoid interpreting 4665824d651Sblueswir1an untrusted format header. 4675824d651Sblueswir1@item serial=@var{serial} 4685824d651Sblueswir1This option specifies the serial number to assign to the device. 469c2cc47a4SMarkus Armbruster@item addr=@var{addr} 470c2cc47a4SMarkus ArmbrusterSpecify the controller's PCI address (if=virtio only). 471ae73e591SLuiz Capitulino@item werror=@var{action},rerror=@var{action} 472ae73e591SLuiz CapitulinoSpecify which @var{action} to take on write and read errors. Valid actions are: 473ae73e591SLuiz Capitulino"ignore" (ignore the error and try to continue), "stop" (pause QEMU), 474ae73e591SLuiz Capitulino"report" (report the error to the guest), "enospc" (pause QEMU only if the 475ae73e591SLuiz Capitulinohost disk is full; report the error to the guest otherwise). 476ae73e591SLuiz CapitulinoThe default setting is @option{werror=enospc} and @option{rerror=report}. 477ae73e591SLuiz Capitulino@item readonly 478ae73e591SLuiz CapitulinoOpen drive @option{file} as read-only. Guest write attempts will fail. 479fb0490f6SStefan Hajnoczi@item copy-on-read=@var{copy-on-read} 480fb0490f6SStefan Hajnoczi@var{copy-on-read} is "on" or "off" and enables whether to copy read backing 481fb0490f6SStefan Hajnoczifile sectors into the image file. 482465bee1dSPeter Lieven@item detect-zeroes=@var{detect-zeroes} 483465bee1dSPeter Lieven@var{detect-zeroes} is "off", "on" or "unmap" and enables the automatic 484465bee1dSPeter Lievenconversion of plain zero writes by the OS to driver specific optimized 485465bee1dSPeter Lievenzero write commands. You may even choose "unmap" if @var{discard} is set 486465bee1dSPeter Lievento "unmap" to allow a zero write to be converted to an UNMAP operation. 4875824d651Sblueswir1@end table 4885824d651Sblueswir1 489a13e5e05SKevin WolfBy default, the @option{cache=writeback} mode is used. It will report data 490a13e5e05SKevin Wolfwrites as completed as soon as the data is present in the host page cache. 491a13e5e05SKevin WolfThis is safe as long as your guest OS makes sure to correctly flush disk caches 492a13e5e05SKevin Wolfwhere needed. If your guest OS does not handle volatile disk write caches 493a13e5e05SKevin Wolfcorrectly and your host crashes or loses power, then the guest may experience 494a13e5e05SKevin Wolfdata corruption. 4955824d651Sblueswir1 496a13e5e05SKevin WolfFor such guests, you should consider using @option{cache=writethrough}. This 497a13e5e05SKevin Wolfmeans that the host page cache will be used to read and write data, but write 498a13e5e05SKevin Wolfnotification will be sent to the guest only after QEMU has made sure to flush 499a13e5e05SKevin Wolfeach write to the disk. Be aware that this has a major impact on performance. 5005824d651Sblueswir1 501c304d317SAurelien JarnoThe host page cache can be avoided entirely with @option{cache=none}. This will 502a13e5e05SKevin Wolfattempt to do disk IO directly to the guest's memory. QEMU may still perform 503a13e5e05SKevin Wolfan internal copy of the data. Note that this is considered a writeback mode and 504a13e5e05SKevin Wolfthe guest OS must handle the disk write cache correctly in order to avoid data 505a13e5e05SKevin Wolfcorruption on host crashes. 5065824d651Sblueswir1 50792196b2fSStefan HajnocziThe host page cache can be avoided while only sending write notifications to 508a13e5e05SKevin Wolfthe guest when the data has been flushed to the disk using 509a13e5e05SKevin Wolf@option{cache=directsync}. 5105824d651Sblueswir1 511016f5cf6SAlexander GrafIn case you don't care about data integrity over host failures, use 512a13e5e05SKevin Wolf@option{cache=unsafe}. This option tells QEMU that it never needs to write any 513a13e5e05SKevin Wolfdata to the disk but can instead keep things in cache. If anything goes wrong, 514e7d81004SStefan Weillike your host losing power, the disk storage getting disconnected accidentally, 515a13e5e05SKevin Wolfetc. your image will most probably be rendered unusable. When using 516c3177288SAlexander Grafthe @option{-snapshot} option, unsafe caching is always used. 517016f5cf6SAlexander Graf 518fb0490f6SStefan HajnocziCopy-on-read avoids accessing the same backing file sectors repeatedly and is 519fb0490f6SStefan Hajnocziuseful when the backing file is over a slow network. By default copy-on-read 520fb0490f6SStefan Hajnocziis off. 521fb0490f6SStefan Hajnoczi 5225824d651Sblueswir1Instead of @option{-cdrom} you can use: 5235824d651Sblueswir1@example 5243804da9dSStefan Weilqemu-system-i386 -drive file=file,index=2,media=cdrom 5255824d651Sblueswir1@end example 5265824d651Sblueswir1 5275824d651Sblueswir1Instead of @option{-hda}, @option{-hdb}, @option{-hdc}, @option{-hdd}, you can 5285824d651Sblueswir1use: 5295824d651Sblueswir1@example 5303804da9dSStefan Weilqemu-system-i386 -drive file=file,index=0,media=disk 5313804da9dSStefan Weilqemu-system-i386 -drive file=file,index=1,media=disk 5323804da9dSStefan Weilqemu-system-i386 -drive file=file,index=2,media=disk 5333804da9dSStefan Weilqemu-system-i386 -drive file=file,index=3,media=disk 5345824d651Sblueswir1@end example 5355824d651Sblueswir1 536587ed6beSCorey BryantYou can open an image using pre-opened file descriptors from an fd set: 537587ed6beSCorey Bryant@example 538587ed6beSCorey Bryantqemu-system-i386 539587ed6beSCorey Bryant-add-fd fd=3,set=2,opaque="rdwr:/path/to/file" 540587ed6beSCorey Bryant-add-fd fd=4,set=2,opaque="rdonly:/path/to/file" 541587ed6beSCorey Bryant-drive file=/dev/fdset/2,index=0,media=disk 542587ed6beSCorey Bryant@end example 543587ed6beSCorey Bryant 5445824d651Sblueswir1You can connect a CDROM to the slave of ide0: 5455824d651Sblueswir1@example 5463804da9dSStefan Weilqemu-system-i386 -drive file=file,if=ide,index=1,media=cdrom 5475824d651Sblueswir1@end example 5485824d651Sblueswir1 5495824d651Sblueswir1If you don't specify the "file=" argument, you define an empty drive: 5505824d651Sblueswir1@example 5513804da9dSStefan Weilqemu-system-i386 -drive if=ide,index=1,media=cdrom 5525824d651Sblueswir1@end example 5535824d651Sblueswir1 5545824d651Sblueswir1You can connect a SCSI disk with unit ID 6 on the bus #0: 5555824d651Sblueswir1@example 5563804da9dSStefan Weilqemu-system-i386 -drive file=file,if=scsi,bus=0,unit=6 5575824d651Sblueswir1@end example 5585824d651Sblueswir1 5595824d651Sblueswir1Instead of @option{-fda}, @option{-fdb}, you can use: 5605824d651Sblueswir1@example 5613804da9dSStefan Weilqemu-system-i386 -drive file=file,index=0,if=floppy 5623804da9dSStefan Weilqemu-system-i386 -drive file=file,index=1,if=floppy 5635824d651Sblueswir1@end example 5645824d651Sblueswir1 5655824d651Sblueswir1By default, @var{interface} is "ide" and @var{index} is automatically 5665824d651Sblueswir1incremented: 5675824d651Sblueswir1@example 5683804da9dSStefan Weilqemu-system-i386 -drive file=a -drive file=b" 5695824d651Sblueswir1@end example 5705824d651Sblueswir1is interpreted like: 5715824d651Sblueswir1@example 5723804da9dSStefan Weilqemu-system-i386 -hda a -hdb b 5735824d651Sblueswir1@end example 5745824d651Sblueswir1ETEXI 5755824d651Sblueswir1 5765824d651Sblueswir1DEF("mtdblock", HAS_ARG, QEMU_OPTION_mtdblock, 577ad96090aSBlue Swirl "-mtdblock file use 'file' as on-board Flash memory image\n", 578ad96090aSBlue Swirl QEMU_ARCH_ALL) 5795824d651Sblueswir1STEXI 5804e257e5eSKevin Wolf@item -mtdblock @var{file} 5816616b2adSStefan Weil@findex -mtdblock 5824e257e5eSKevin WolfUse @var{file} as on-board Flash memory image. 5835824d651Sblueswir1ETEXI 5845824d651Sblueswir1 5855824d651Sblueswir1DEF("sd", HAS_ARG, QEMU_OPTION_sd, 586ad96090aSBlue Swirl "-sd file use 'file' as SecureDigital card image\n", QEMU_ARCH_ALL) 5875824d651Sblueswir1STEXI 5884e257e5eSKevin Wolf@item -sd @var{file} 5896616b2adSStefan Weil@findex -sd 5904e257e5eSKevin WolfUse @var{file} as SecureDigital card image. 5915824d651Sblueswir1ETEXI 5925824d651Sblueswir1 5935824d651Sblueswir1DEF("pflash", HAS_ARG, QEMU_OPTION_pflash, 594ad96090aSBlue Swirl "-pflash file use 'file' as a parallel flash image\n", QEMU_ARCH_ALL) 5955824d651Sblueswir1STEXI 5964e257e5eSKevin Wolf@item -pflash @var{file} 5976616b2adSStefan Weil@findex -pflash 5984e257e5eSKevin WolfUse @var{file} as a parallel flash image. 5995824d651Sblueswir1ETEXI 6005824d651Sblueswir1 6015824d651Sblueswir1DEF("snapshot", 0, QEMU_OPTION_snapshot, 602ad96090aSBlue Swirl "-snapshot write to temporary files instead of disk image files\n", 603ad96090aSBlue Swirl QEMU_ARCH_ALL) 6045824d651Sblueswir1STEXI 6055824d651Sblueswir1@item -snapshot 6066616b2adSStefan Weil@findex -snapshot 6075824d651Sblueswir1Write to temporary files instead of disk image files. In this case, 6085824d651Sblueswir1the raw disk image you use is not written back. You can however force 6095824d651Sblueswir1the write back by pressing @key{C-a s} (@pxref{disk_images}). 6105824d651Sblueswir1ETEXI 6115824d651Sblueswir1 61210adb8beSMarkus ArmbrusterDEF("hdachs", HAS_ARG, QEMU_OPTION_hdachs, \ 61310adb8beSMarkus Armbruster "-hdachs c,h,s[,t]\n" \ 61410adb8beSMarkus Armbruster " force hard disk 0 physical geometry and the optional BIOS\n" \ 61510adb8beSMarkus Armbruster " translation (t=none or lba) (usually QEMU can guess them)\n", 616ad96090aSBlue Swirl QEMU_ARCH_ALL) 617c902760fSMarcelo TosattiSTEXI 61810adb8beSMarkus Armbruster@item -hdachs @var{c},@var{h},@var{s},[,@var{t}] 61910adb8beSMarkus Armbruster@findex -hdachs 62010adb8beSMarkus ArmbrusterForce hard disk 0 physical geometry (1 <= @var{c} <= 16383, 1 <= 62110adb8beSMarkus Armbruster@var{h} <= 16, 1 <= @var{s} <= 63) and optionally force the BIOS 62210adb8beSMarkus Armbrustertranslation mode (@var{t}=none, lba or auto). Usually QEMU can guess 62310adb8beSMarkus Armbrusterall those parameters. This option is useful for old MS-DOS disk 62410adb8beSMarkus Armbrusterimages. 625c70a01e4SMarkus ArmbrusterETEXI 62674db920cSGautham R Shenoy 62774db920cSGautham R ShenoyDEF("fsdev", HAS_ARG, QEMU_OPTION_fsdev, 6282c30dd74SAneesh Kumar K.V "-fsdev fsdriver,id=id[,path=path,][security_model={mapped-xattr|mapped-file|passthrough|none}]\n" 62984a87cc4SM. Mohan Kumar " [,writeout=immediate][,readonly][,socket=socket|sock_fd=sock_fd]\n", 63074db920cSGautham R Shenoy QEMU_ARCH_ALL) 63174db920cSGautham R Shenoy 63274db920cSGautham R ShenoySTEXI 63374db920cSGautham R Shenoy 63484a87cc4SM. 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}] 63574db920cSGautham R Shenoy@findex -fsdev 6367c92a3d2SAneesh Kumar K.VDefine a new file system device. Valid options are: 6377c92a3d2SAneesh Kumar K.V@table @option 6387c92a3d2SAneesh Kumar K.V@item @var{fsdriver} 6397c92a3d2SAneesh Kumar K.VThis option specifies the fs driver backend to use. 640f67e3ffdSM. Mohan KumarCurrently "local", "handle" and "proxy" file system drivers are supported. 6417c92a3d2SAneesh Kumar K.V@item id=@var{id} 6427c92a3d2SAneesh Kumar K.VSpecifies identifier for this device 6437c92a3d2SAneesh Kumar K.V@item path=@var{path} 6447c92a3d2SAneesh Kumar K.VSpecifies the export path for the file system device. Files under 6457c92a3d2SAneesh Kumar K.Vthis path will be available to the 9p client on the guest. 6467c92a3d2SAneesh Kumar K.V@item security_model=@var{security_model} 6477c92a3d2SAneesh Kumar K.VSpecifies the security model to be used for this export path. 6482c30dd74SAneesh Kumar K.VSupported security models are "passthrough", "mapped-xattr", "mapped-file" and "none". 6497c92a3d2SAneesh Kumar K.VIn "passthrough" security model, files are stored using the same 650b65ee4faSStefan Weilcredentials as they are created on the guest. This requires QEMU 6512c30dd74SAneesh Kumar K.Vto run as root. In "mapped-xattr" security model, some of the file 6527c92a3d2SAneesh Kumar K.Vattributes like uid, gid, mode bits and link target are stored as 6532c30dd74SAneesh Kumar K.Vfile attributes. For "mapped-file" these attributes are stored in the 6542c30dd74SAneesh Kumar K.Vhidden .virtfs_metadata directory. Directories exported by this security model cannot 6557c92a3d2SAneesh Kumar K.Vinteract with other unix tools. "none" security model is same as 6567c92a3d2SAneesh Kumar K.Vpassthrough except the sever won't report failures if it fails to 657d9b36a6eSM. Mohan Kumarset file attributes like ownership. Security model is mandatory 658f67e3ffdSM. Mohan Kumaronly for local fsdriver. Other fsdrivers (like handle, proxy) don't take 659d9b36a6eSM. Mohan Kumarsecurity model as a parameter. 6607c92a3d2SAneesh Kumar K.V@item writeout=@var{writeout} 6617c92a3d2SAneesh Kumar K.VThis is an optional argument. The only supported value is "immediate". 6627c92a3d2SAneesh Kumar K.VThis means that host page cache will be used to read and write data but 6637c92a3d2SAneesh Kumar K.Vwrite notification will be sent to the guest only when the data has been 6647c92a3d2SAneesh Kumar K.Vreported as written by the storage subsystem. 6652c74c2cbSM. Mohan Kumar@item readonly 6662c74c2cbSM. Mohan KumarEnables exporting 9p share as a readonly mount for guests. By default 6672c74c2cbSM. Mohan Kumarread-write access is given. 66884a87cc4SM. Mohan Kumar@item socket=@var{socket} 66984a87cc4SM. Mohan KumarEnables proxy filesystem driver to use passed socket file for communicating 67084a87cc4SM. Mohan Kumarwith virtfs-proxy-helper 671f67e3ffdSM. Mohan Kumar@item sock_fd=@var{sock_fd} 672f67e3ffdSM. Mohan KumarEnables proxy filesystem driver to use passed socket descriptor for 673f67e3ffdSM. Mohan Kumarcommunicating with virtfs-proxy-helper. Usually a helper like libvirt 674f67e3ffdSM. Mohan Kumarwill create socketpair and pass one of the fds as sock_fd 67574db920cSGautham R Shenoy@end table 6767c92a3d2SAneesh Kumar K.V 6777c92a3d2SAneesh Kumar K.V-fsdev option is used along with -device driver "virtio-9p-pci". 6787c92a3d2SAneesh Kumar K.V@item -device virtio-9p-pci,fsdev=@var{id},mount_tag=@var{mount_tag} 6797c92a3d2SAneesh Kumar K.VOptions for virtio-9p-pci driver are: 6807c92a3d2SAneesh Kumar K.V@table @option 6817c92a3d2SAneesh Kumar K.V@item fsdev=@var{id} 6827c92a3d2SAneesh Kumar K.VSpecifies the id value specified along with -fsdev option 6837c92a3d2SAneesh Kumar K.V@item mount_tag=@var{mount_tag} 6847c92a3d2SAneesh Kumar K.VSpecifies the tag name to be used by the guest to mount this export point 6857c92a3d2SAneesh Kumar K.V@end table 6867c92a3d2SAneesh Kumar K.V 68774db920cSGautham R ShenoyETEXI 68874db920cSGautham R Shenoy 6893d54abc7SGautham R ShenoyDEF("virtfs", HAS_ARG, QEMU_OPTION_virtfs, 6902c30dd74SAneesh Kumar K.V "-virtfs local,path=path,mount_tag=tag,security_model=[mapped-xattr|mapped-file|passthrough|none]\n" 69184a87cc4SM. Mohan Kumar " [,writeout=immediate][,readonly][,socket=socket|sock_fd=sock_fd]\n", 6923d54abc7SGautham R Shenoy QEMU_ARCH_ALL) 6933d54abc7SGautham R Shenoy 6943d54abc7SGautham R ShenoySTEXI 6953d54abc7SGautham R Shenoy 69684a87cc4SM. 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}] 6973d54abc7SGautham R Shenoy@findex -virtfs 6983d54abc7SGautham R Shenoy 6997c92a3d2SAneesh Kumar K.VThe general form of a Virtual File system pass-through options are: 7007c92a3d2SAneesh Kumar K.V@table @option 7017c92a3d2SAneesh Kumar K.V@item @var{fsdriver} 7027c92a3d2SAneesh Kumar K.VThis option specifies the fs driver backend to use. 703f67e3ffdSM. Mohan KumarCurrently "local", "handle" and "proxy" file system drivers are supported. 7047c92a3d2SAneesh Kumar K.V@item id=@var{id} 7057c92a3d2SAneesh Kumar K.VSpecifies identifier for this device 7067c92a3d2SAneesh Kumar K.V@item path=@var{path} 7077c92a3d2SAneesh Kumar K.VSpecifies the export path for the file system device. Files under 7087c92a3d2SAneesh Kumar K.Vthis path will be available to the 9p client on the guest. 7097c92a3d2SAneesh Kumar K.V@item security_model=@var{security_model} 7107c92a3d2SAneesh Kumar K.VSpecifies the security model to be used for this export path. 7112c30dd74SAneesh Kumar K.VSupported security models are "passthrough", "mapped-xattr", "mapped-file" and "none". 7127c92a3d2SAneesh Kumar K.VIn "passthrough" security model, files are stored using the same 713b65ee4faSStefan Weilcredentials as they are created on the guest. This requires QEMU 7142c30dd74SAneesh Kumar K.Vto run as root. In "mapped-xattr" security model, some of the file 7157c92a3d2SAneesh Kumar K.Vattributes like uid, gid, mode bits and link target are stored as 7162c30dd74SAneesh Kumar K.Vfile attributes. For "mapped-file" these attributes are stored in the 7172c30dd74SAneesh Kumar K.Vhidden .virtfs_metadata directory. Directories exported by this security model cannot 7187c92a3d2SAneesh Kumar K.Vinteract with other unix tools. "none" security model is same as 7197c92a3d2SAneesh Kumar K.Vpassthrough except the sever won't report failures if it fails to 720d9b36a6eSM. Mohan Kumarset file attributes like ownership. Security model is mandatory only 721f67e3ffdSM. Mohan Kumarfor local fsdriver. Other fsdrivers (like handle, proxy) don't take security 722d9b36a6eSM. Mohan Kumarmodel as a parameter. 7237c92a3d2SAneesh Kumar K.V@item writeout=@var{writeout} 7247c92a3d2SAneesh Kumar K.VThis is an optional argument. The only supported value is "immediate". 7257c92a3d2SAneesh Kumar K.VThis means that host page cache will be used to read and write data but 7267c92a3d2SAneesh Kumar K.Vwrite notification will be sent to the guest only when the data has been 7277c92a3d2SAneesh Kumar K.Vreported as written by the storage subsystem. 7282c74c2cbSM. Mohan Kumar@item readonly 7292c74c2cbSM. Mohan KumarEnables exporting 9p share as a readonly mount for guests. By default 7302c74c2cbSM. Mohan Kumarread-write access is given. 73184a87cc4SM. Mohan Kumar@item socket=@var{socket} 73284a87cc4SM. Mohan KumarEnables proxy filesystem driver to use passed socket file for 73384a87cc4SM. Mohan Kumarcommunicating with virtfs-proxy-helper. Usually a helper like libvirt 73484a87cc4SM. Mohan Kumarwill create socketpair and pass one of the fds as sock_fd 735f67e3ffdSM. Mohan Kumar@item sock_fd 736f67e3ffdSM. Mohan KumarEnables proxy filesystem driver to use passed 'sock_fd' as the socket 737f67e3ffdSM. Mohan Kumardescriptor for interfacing with virtfs-proxy-helper 7383d54abc7SGautham R Shenoy@end table 7393d54abc7SGautham R ShenoyETEXI 7403d54abc7SGautham R Shenoy 7419db221aeSAneesh Kumar K.VDEF("virtfs_synth", 0, QEMU_OPTION_virtfs_synth, 7429db221aeSAneesh Kumar K.V "-virtfs_synth Create synthetic file system image\n", 7439db221aeSAneesh Kumar K.V QEMU_ARCH_ALL) 7449db221aeSAneesh Kumar K.VSTEXI 7459db221aeSAneesh Kumar K.V@item -virtfs_synth 7469db221aeSAneesh Kumar K.V@findex -virtfs_synth 7479db221aeSAneesh Kumar K.VCreate synthetic file system image 7489db221aeSAneesh Kumar K.VETEXI 7499db221aeSAneesh Kumar K.V 7505824d651Sblueswir1STEXI 7515824d651Sblueswir1@end table 7525824d651Sblueswir1ETEXI 7535824d651Sblueswir1DEFHEADING() 7545824d651Sblueswir1 75510adb8beSMarkus ArmbrusterDEFHEADING(USB options:) 75610adb8beSMarkus ArmbrusterSTEXI 75710adb8beSMarkus Armbruster@table @option 75810adb8beSMarkus ArmbrusterETEXI 75910adb8beSMarkus Armbruster 76010adb8beSMarkus ArmbrusterDEF("usb", 0, QEMU_OPTION_usb, 76110adb8beSMarkus Armbruster "-usb enable the USB driver (will be the default soon)\n", 76210adb8beSMarkus Armbruster QEMU_ARCH_ALL) 76310adb8beSMarkus ArmbrusterSTEXI 76410adb8beSMarkus Armbruster@item -usb 76510adb8beSMarkus Armbruster@findex -usb 76610adb8beSMarkus ArmbrusterEnable the USB driver (will be the default soon) 76710adb8beSMarkus ArmbrusterETEXI 76810adb8beSMarkus Armbruster 76910adb8beSMarkus ArmbrusterDEF("usbdevice", HAS_ARG, QEMU_OPTION_usbdevice, 77010adb8beSMarkus Armbruster "-usbdevice name add the host or guest USB device 'name'\n", 77110adb8beSMarkus Armbruster QEMU_ARCH_ALL) 77210adb8beSMarkus ArmbrusterSTEXI 77310adb8beSMarkus Armbruster 77410adb8beSMarkus Armbruster@item -usbdevice @var{devname} 77510adb8beSMarkus Armbruster@findex -usbdevice 77610adb8beSMarkus ArmbrusterAdd the USB device @var{devname}. @xref{usb_devices}. 77710adb8beSMarkus Armbruster 77810adb8beSMarkus Armbruster@table @option 77910adb8beSMarkus Armbruster 78010adb8beSMarkus Armbruster@item mouse 78110adb8beSMarkus ArmbrusterVirtual Mouse. This will override the PS/2 mouse emulation when activated. 78210adb8beSMarkus Armbruster 78310adb8beSMarkus Armbruster@item tablet 78410adb8beSMarkus ArmbrusterPointer device that uses absolute coordinates (like a touchscreen). This 78510adb8beSMarkus Armbrustermeans QEMU is able to report the mouse position without having to grab the 78610adb8beSMarkus Armbrustermouse. Also overrides the PS/2 mouse emulation when activated. 78710adb8beSMarkus Armbruster 78810adb8beSMarkus Armbruster@item disk:[format=@var{format}]:@var{file} 78910adb8beSMarkus ArmbrusterMass storage device based on file. The optional @var{format} argument 79010adb8beSMarkus Armbrusterwill be used rather than detecting the format. Can be used to specifiy 79110adb8beSMarkus Armbruster@code{format=raw} to avoid interpreting an untrusted format header. 79210adb8beSMarkus Armbruster 79310adb8beSMarkus Armbruster@item host:@var{bus}.@var{addr} 79410adb8beSMarkus ArmbrusterPass through the host device identified by @var{bus}.@var{addr} (Linux only). 79510adb8beSMarkus Armbruster 79610adb8beSMarkus Armbruster@item host:@var{vendor_id}:@var{product_id} 79710adb8beSMarkus ArmbrusterPass through the host device identified by @var{vendor_id}:@var{product_id} 79810adb8beSMarkus Armbruster(Linux only). 79910adb8beSMarkus Armbruster 80010adb8beSMarkus Armbruster@item serial:[vendorid=@var{vendor_id}][,productid=@var{product_id}]:@var{dev} 80110adb8beSMarkus ArmbrusterSerial converter to host character device @var{dev}, see @code{-serial} for the 80210adb8beSMarkus Armbrusteravailable devices. 80310adb8beSMarkus Armbruster 80410adb8beSMarkus Armbruster@item braille 80510adb8beSMarkus ArmbrusterBraille device. This will use BrlAPI to display the braille output on a real 80610adb8beSMarkus Armbrusteror fake device. 80710adb8beSMarkus Armbruster 80810adb8beSMarkus Armbruster@item net:@var{options} 80910adb8beSMarkus ArmbrusterNetwork adapter that supports CDC ethernet and RNDIS protocols. 81010adb8beSMarkus Armbruster 81110adb8beSMarkus Armbruster@end table 81210adb8beSMarkus ArmbrusterETEXI 81310adb8beSMarkus Armbruster 81410adb8beSMarkus ArmbrusterSTEXI 81510adb8beSMarkus Armbruster@end table 81610adb8beSMarkus ArmbrusterETEXI 81710adb8beSMarkus ArmbrusterDEFHEADING() 81810adb8beSMarkus Armbruster 8195824d651Sblueswir1DEFHEADING(Display options:) 8205824d651Sblueswir1STEXI 8215824d651Sblueswir1@table @option 8225824d651Sblueswir1ETEXI 8235824d651Sblueswir1 8241472a95bSJes SorensenDEF("display", HAS_ARG, QEMU_OPTION_display, 8251472a95bSJes Sorensen "-display sdl[,frame=on|off][,alt_grab=on|off][,ctrl_grab=on|off]\n" 8263264ff12SJes Sorensen " [,window_close=on|off]|curses|none|\n" 827881249c7SJan Kiszka " gtk[,grab_on_hover=on|off]|\n" 8283264ff12SJes Sorensen " vnc=<display>[,<optargs>]\n" 8291472a95bSJes Sorensen " select display type\n", QEMU_ARCH_ALL) 8301472a95bSJes SorensenSTEXI 8311472a95bSJes Sorensen@item -display @var{type} 8321472a95bSJes Sorensen@findex -display 8331472a95bSJes SorensenSelect type of display to use. This option is a replacement for the 8341472a95bSJes Sorensenold style -sdl/-curses/... options. Valid values for @var{type} are 8351472a95bSJes Sorensen@table @option 8361472a95bSJes Sorensen@item sdl 8371472a95bSJes SorensenDisplay video output via SDL (usually in a separate graphics 8381472a95bSJes Sorensenwindow; see the SDL documentation for other possibilities). 8391472a95bSJes Sorensen@item curses 8401472a95bSJes SorensenDisplay video output via curses. For graphics device models which 8411472a95bSJes Sorensensupport a text mode, QEMU can display this output using a 8421472a95bSJes Sorensencurses/ncurses interface. Nothing is displayed when the graphics 8431472a95bSJes Sorensendevice is in graphical mode or if the graphics device does not support 8441472a95bSJes Sorensena text mode. Generally only the VGA device models support text mode. 8454171d32eSJes Sorensen@item none 8464171d32eSJes SorensenDo not display video output. The guest will still see an emulated 8474171d32eSJes Sorensengraphics card, but its output will not be displayed to the QEMU 8484171d32eSJes Sorensenuser. This option differs from the -nographic option in that it 8494171d32eSJes Sorensenonly affects what is done with video output; -nographic also changes 8504171d32eSJes Sorensenthe destination of the serial and parallel port data. 851881249c7SJan Kiszka@item gtk 852881249c7SJan KiszkaDisplay video output in a GTK window. This interface provides drop-down 853881249c7SJan Kiszkamenus and other UI elements to configure and control the VM during 854881249c7SJan Kiszkaruntime. 8553264ff12SJes Sorensen@item vnc 8563264ff12SJes SorensenStart a VNC server on display <arg> 8571472a95bSJes Sorensen@end table 8581472a95bSJes SorensenETEXI 8591472a95bSJes Sorensen 8605824d651Sblueswir1DEF("nographic", 0, QEMU_OPTION_nographic, 861ad96090aSBlue Swirl "-nographic disable graphical output and redirect serial I/Os to console\n", 862ad96090aSBlue Swirl QEMU_ARCH_ALL) 8635824d651Sblueswir1STEXI 8645824d651Sblueswir1@item -nographic 8656616b2adSStefan Weil@findex -nographic 8665824d651Sblueswir1Normally, QEMU uses SDL to display the VGA output. With this option, 8675824d651Sblueswir1you can totally disable graphical output so that QEMU is a simple 8685824d651Sblueswir1command line application. The emulated serial port is redirected on 86902c4bdf1SPaolo Bonzinithe console and muxed with the monitor (unless redirected elsewhere 87002c4bdf1SPaolo Bonziniexplicitly). Therefore, you can still use QEMU to debug a Linux kernel 871b031f413SRamkumar Ramachandrawith a serial console. Use @key{C-a h} for help on switching between 872b031f413SRamkumar Ramachandrathe console and monitor. 8735824d651Sblueswir1ETEXI 8745824d651Sblueswir1 8755824d651Sblueswir1DEF("curses", 0, QEMU_OPTION_curses, 876ad96090aSBlue Swirl "-curses use a curses/ncurses interface instead of SDL\n", 877ad96090aSBlue Swirl QEMU_ARCH_ALL) 8785824d651Sblueswir1STEXI 8795824d651Sblueswir1@item -curses 880b8f490ebSMarkus Armbruster@findex -curses 8815824d651Sblueswir1Normally, QEMU uses SDL to display the VGA output. With this option, 8825824d651Sblueswir1QEMU can display the VGA output when in text mode using a 8835824d651Sblueswir1curses/ncurses interface. Nothing is displayed in graphical mode. 8845824d651Sblueswir1ETEXI 8855824d651Sblueswir1 8865824d651Sblueswir1DEF("no-frame", 0, QEMU_OPTION_no_frame, 887ad96090aSBlue Swirl "-no-frame open SDL window without a frame and window decorations\n", 888ad96090aSBlue Swirl QEMU_ARCH_ALL) 8895824d651Sblueswir1STEXI 8905824d651Sblueswir1@item -no-frame 8916616b2adSStefan Weil@findex -no-frame 8925824d651Sblueswir1Do not use decorations for SDL windows and start them using the whole 8935824d651Sblueswir1available screen space. This makes the using QEMU in a dedicated desktop 8945824d651Sblueswir1workspace more convenient. 8955824d651Sblueswir1ETEXI 8965824d651Sblueswir1 8975824d651Sblueswir1DEF("alt-grab", 0, QEMU_OPTION_alt_grab, 898ad96090aSBlue Swirl "-alt-grab use Ctrl-Alt-Shift to grab mouse (instead of Ctrl-Alt)\n", 899ad96090aSBlue Swirl QEMU_ARCH_ALL) 9005824d651Sblueswir1STEXI 9015824d651Sblueswir1@item -alt-grab 9026616b2adSStefan Weil@findex -alt-grab 903de1db2a1SBrad HardsUse Ctrl-Alt-Shift to grab mouse (instead of Ctrl-Alt). Note that this also 904de1db2a1SBrad Hardsaffects the special keys (for fullscreen, monitor-mode switching, etc). 9055824d651Sblueswir1ETEXI 9065824d651Sblueswir1 9070ca9f8a4SDustin KirklandDEF("ctrl-grab", 0, QEMU_OPTION_ctrl_grab, 908ad96090aSBlue Swirl "-ctrl-grab use Right-Ctrl to grab mouse (instead of Ctrl-Alt)\n", 909ad96090aSBlue Swirl QEMU_ARCH_ALL) 9100ca9f8a4SDustin KirklandSTEXI 9110ca9f8a4SDustin Kirkland@item -ctrl-grab 9126616b2adSStefan Weil@findex -ctrl-grab 913de1db2a1SBrad HardsUse Right-Ctrl to grab mouse (instead of Ctrl-Alt). Note that this also 914de1db2a1SBrad Hardsaffects the special keys (for fullscreen, monitor-mode switching, etc). 9150ca9f8a4SDustin KirklandETEXI 9160ca9f8a4SDustin Kirkland 9175824d651Sblueswir1DEF("no-quit", 0, QEMU_OPTION_no_quit, 918ad96090aSBlue Swirl "-no-quit disable SDL window close capability\n", QEMU_ARCH_ALL) 9195824d651Sblueswir1STEXI 9205824d651Sblueswir1@item -no-quit 9216616b2adSStefan Weil@findex -no-quit 9225824d651Sblueswir1Disable SDL window close capability. 9235824d651Sblueswir1ETEXI 9245824d651Sblueswir1 9255824d651Sblueswir1DEF("sdl", 0, QEMU_OPTION_sdl, 926ad96090aSBlue Swirl "-sdl enable SDL\n", QEMU_ARCH_ALL) 9275824d651Sblueswir1STEXI 9285824d651Sblueswir1@item -sdl 9296616b2adSStefan Weil@findex -sdl 9305824d651Sblueswir1Enable SDL. 9315824d651Sblueswir1ETEXI 9325824d651Sblueswir1 93329b0040bSGerd HoffmannDEF("spice", HAS_ARG, QEMU_OPTION_spice, 93427af7788SYonit Halperin "-spice [port=port][,tls-port=secured-port][,x509-dir=<dir>]\n" 93527af7788SYonit Halperin " [,x509-key-file=<file>][,x509-key-password=<file>]\n" 93627af7788SYonit Halperin " [,x509-cert-file=<file>][,x509-cacert-file=<file>]\n" 93727af7788SYonit Halperin " [,x509-dh-key-file=<file>][,addr=addr][,ipv4|ipv6]\n" 93827af7788SYonit Halperin " [,tls-ciphers=<list>]\n" 93927af7788SYonit Halperin " [,tls-channel=[main|display|cursor|inputs|record|playback]]\n" 94027af7788SYonit Halperin " [,plaintext-channel=[main|display|cursor|inputs|record|playback]]\n" 94127af7788SYonit Halperin " [,sasl][,password=<secret>][,disable-ticketing]\n" 94227af7788SYonit Halperin " [,image-compression=[auto_glz|auto_lz|quic|glz|lz|off]]\n" 94327af7788SYonit Halperin " [,jpeg-wan-compression=[auto|never|always]]\n" 94427af7788SYonit Halperin " [,zlib-glz-wan-compression=[auto|never|always]]\n" 94527af7788SYonit Halperin " [,streaming-video=[off|all|filter]][,disable-copy-paste]\n" 9465ad24e5fSHans de Goede " [,disable-agent-file-xfer][,agent-mouse=[on|off]]\n" 9475ad24e5fSHans de Goede " [,playback-compression=[on|off]][,seamless-migration=[on|off]]\n" 94827af7788SYonit Halperin " enable spice\n" 94927af7788SYonit Halperin " at least one of {port, tls-port} is mandatory\n", 95027af7788SYonit Halperin QEMU_ARCH_ALL) 95129b0040bSGerd HoffmannSTEXI 95229b0040bSGerd Hoffmann@item -spice @var{option}[,@var{option}[,...]] 95329b0040bSGerd Hoffmann@findex -spice 95429b0040bSGerd HoffmannEnable the spice remote desktop protocol. Valid options are 95529b0040bSGerd Hoffmann 95629b0040bSGerd Hoffmann@table @option 95729b0040bSGerd Hoffmann 95829b0040bSGerd Hoffmann@item port=<nr> 959c448e855SGerd HoffmannSet the TCP port spice is listening on for plaintext channels. 96029b0040bSGerd Hoffmann 961333b0eebSGerd Hoffmann@item addr=<addr> 962333b0eebSGerd HoffmannSet the IP address spice is listening on. Default is any address. 963333b0eebSGerd Hoffmann 964333b0eebSGerd Hoffmann@item ipv4 965333b0eebSGerd Hoffmann@item ipv6 966333b0eebSGerd HoffmannForce using the specified IP version. 967333b0eebSGerd Hoffmann 96829b0040bSGerd Hoffmann@item password=<secret> 96929b0040bSGerd HoffmannSet the password you need to authenticate. 97029b0040bSGerd Hoffmann 97148b3ed0aSMarc-André Lureau@item sasl 97248b3ed0aSMarc-André LureauRequire that the client use SASL to authenticate with the spice. 97348b3ed0aSMarc-André LureauThe exact choice of authentication method used is controlled from the 97448b3ed0aSMarc-André Lureausystem / user's SASL configuration file for the 'qemu' service. This 97548b3ed0aSMarc-André Lureauis typically found in /etc/sasl2/qemu.conf. If running QEMU as an 97648b3ed0aSMarc-André Lureauunprivileged user, an environment variable SASL_CONF_PATH can be used 97748b3ed0aSMarc-André Lureauto make it search alternate locations for the service config. 97848b3ed0aSMarc-André LureauWhile some SASL auth methods can also provide data encryption (eg GSSAPI), 97948b3ed0aSMarc-André Lureauit is recommended that SASL always be combined with the 'tls' and 98048b3ed0aSMarc-André Lureau'x509' settings to enable use of SSL and server certificates. This 98148b3ed0aSMarc-André Lureauensures a data encryption preventing compromise of authentication 98248b3ed0aSMarc-André Lureaucredentials. 98348b3ed0aSMarc-André Lureau 98429b0040bSGerd Hoffmann@item disable-ticketing 98529b0040bSGerd HoffmannAllow client connects without authentication. 98629b0040bSGerd Hoffmann 987d4970b07SHans de Goede@item disable-copy-paste 988d4970b07SHans de GoedeDisable copy paste between the client and the guest. 989d4970b07SHans de Goede 9905ad24e5fSHans de Goede@item disable-agent-file-xfer 9915ad24e5fSHans de GoedeDisable spice-vdagent based file-xfer between the client and the guest. 9925ad24e5fSHans de Goede 993c448e855SGerd Hoffmann@item tls-port=<nr> 994c448e855SGerd HoffmannSet the TCP port spice is listening on for encrypted channels. 995c448e855SGerd Hoffmann 996c448e855SGerd Hoffmann@item x509-dir=<dir> 997c448e855SGerd HoffmannSet the x509 file directory. Expects same filenames as -vnc $display,x509=$dir 998c448e855SGerd Hoffmann 999c448e855SGerd Hoffmann@item x509-key-file=<file> 1000c448e855SGerd Hoffmann@item x509-key-password=<file> 1001c448e855SGerd Hoffmann@item x509-cert-file=<file> 1002c448e855SGerd Hoffmann@item x509-cacert-file=<file> 1003c448e855SGerd Hoffmann@item x509-dh-key-file=<file> 1004c448e855SGerd HoffmannThe x509 file names can also be configured individually. 1005c448e855SGerd Hoffmann 1006c448e855SGerd Hoffmann@item tls-ciphers=<list> 1007c448e855SGerd HoffmannSpecify which ciphers to use. 1008c448e855SGerd Hoffmann 1009d70d6b31SAlon Levy@item tls-channel=[main|display|cursor|inputs|record|playback] 1010d70d6b31SAlon Levy@item plaintext-channel=[main|display|cursor|inputs|record|playback] 101117b6dea0SGerd HoffmannForce specific channel to be used with or without TLS encryption. The 101217b6dea0SGerd Hoffmannoptions can be specified multiple times to configure multiple 101317b6dea0SGerd Hoffmannchannels. The special name "default" can be used to set the default 101417b6dea0SGerd Hoffmannmode. For channels which are not explicitly forced into one mode the 101517b6dea0SGerd Hoffmannspice client is allowed to pick tls/plaintext as he pleases. 101617b6dea0SGerd Hoffmann 10179f04e09eSYonit Halperin@item image-compression=[auto_glz|auto_lz|quic|glz|lz|off] 10189f04e09eSYonit HalperinConfigure image compression (lossless). 10199f04e09eSYonit HalperinDefault is auto_glz. 10209f04e09eSYonit Halperin 10219f04e09eSYonit Halperin@item jpeg-wan-compression=[auto|never|always] 10229f04e09eSYonit Halperin@item zlib-glz-wan-compression=[auto|never|always] 10239f04e09eSYonit HalperinConfigure wan image compression (lossy for slow links). 10249f04e09eSYonit HalperinDefault is auto. 10259f04e09eSYonit Halperin 102684a23f25SGerd Hoffmann@item streaming-video=[off|all|filter] 102784a23f25SGerd HoffmannConfigure video stream detection. Default is filter. 102884a23f25SGerd Hoffmann 102984a23f25SGerd Hoffmann@item agent-mouse=[on|off] 103084a23f25SGerd HoffmannEnable/disable passing mouse events via vdagent. Default is on. 103184a23f25SGerd Hoffmann 103284a23f25SGerd Hoffmann@item playback-compression=[on|off] 103384a23f25SGerd HoffmannEnable/disable audio stream compression (using celt 0.5.1). Default is on. 103484a23f25SGerd Hoffmann 10358c957053SYonit Halperin@item seamless-migration=[on|off] 10368c957053SYonit HalperinEnable/disable spice seamless migration. Default is off. 10378c957053SYonit Halperin 103829b0040bSGerd Hoffmann@end table 103929b0040bSGerd HoffmannETEXI 104029b0040bSGerd Hoffmann 10415824d651Sblueswir1DEF("portrait", 0, QEMU_OPTION_portrait, 1042ad96090aSBlue Swirl "-portrait rotate graphical output 90 deg left (only PXA LCD)\n", 1043ad96090aSBlue Swirl QEMU_ARCH_ALL) 10445824d651Sblueswir1STEXI 10455824d651Sblueswir1@item -portrait 10466616b2adSStefan Weil@findex -portrait 10475824d651Sblueswir1Rotate graphical output 90 deg left (only PXA LCD). 10485824d651Sblueswir1ETEXI 10495824d651Sblueswir1 10509312805dSVasily KhoruzhickDEF("rotate", HAS_ARG, QEMU_OPTION_rotate, 10519312805dSVasily Khoruzhick "-rotate <deg> rotate graphical output some deg left (only PXA LCD)\n", 10529312805dSVasily Khoruzhick QEMU_ARCH_ALL) 10539312805dSVasily KhoruzhickSTEXI 10546265c43bSMarkus Armbruster@item -rotate @var{deg} 10559312805dSVasily Khoruzhick@findex -rotate 10569312805dSVasily KhoruzhickRotate graphical output some deg left (only PXA LCD). 10579312805dSVasily KhoruzhickETEXI 10589312805dSVasily Khoruzhick 10595824d651Sblueswir1DEF("vga", HAS_ARG, QEMU_OPTION_vga, 106033632788SMark Cave-Ayland "-vga [std|cirrus|vmware|qxl|xenfb|tcx|cg3|none]\n" 1061ad96090aSBlue Swirl " select video card type\n", QEMU_ARCH_ALL) 10625824d651Sblueswir1STEXI 1063e4558dcaSmalc@item -vga @var{type} 10646616b2adSStefan Weil@findex -vga 10655824d651Sblueswir1Select type of VGA card to emulate. Valid values for @var{type} are 1066b3f046c2SKevin Wolf@table @option 10675824d651Sblueswir1@item cirrus 10685824d651Sblueswir1Cirrus Logic GD5446 Video card. All Windows versions starting from 10695824d651Sblueswir1Windows 95 should recognize and use this graphic card. For optimal 10705824d651Sblueswir1performances, use 16 bit color depth in the guest and the host OS. 10715824d651Sblueswir1(This one is the default) 10725824d651Sblueswir1@item std 10735824d651Sblueswir1Standard VGA card with Bochs VBE extensions. If your guest OS 10745824d651Sblueswir1supports the VESA 2.0 VBE extensions (e.g. Windows XP) and if you want 10755824d651Sblueswir1to use high resolution modes (>= 1280x1024x16) then you should use 10765824d651Sblueswir1this option. 10775824d651Sblueswir1@item vmware 10785824d651Sblueswir1VMWare SVGA-II compatible adapter. Use it if you have sufficiently 10795824d651Sblueswir1recent XFree86/XOrg server or Windows guest with a driver for this 10805824d651Sblueswir1card. 1081a19cbfb3SGerd Hoffmann@item qxl 1082a19cbfb3SGerd HoffmannQXL paravirtual graphic card. It is VGA compatible (including VESA 1083a19cbfb3SGerd Hoffmann2.0 VBE support). Works best with qxl guest drivers installed though. 1084a19cbfb3SGerd HoffmannRecommended choice when using the spice protocol. 108533632788SMark Cave-Ayland@item tcx 108633632788SMark Cave-Ayland(sun4m only) Sun TCX framebuffer. This is the default framebuffer for 108733632788SMark Cave-Aylandsun4m machines and offers both 8-bit and 24-bit colour depths at a 108833632788SMark Cave-Aylandfixed resolution of 1024x768. 108933632788SMark Cave-Ayland@item cg3 109033632788SMark Cave-Ayland(sun4m only) Sun cgthree framebuffer. This is a simple 8-bit framebuffer 109133632788SMark Cave-Aylandfor sun4m machines available in both 1024x768 (OpenBIOS) and 1152x900 (OBP) 109233632788SMark Cave-Aylandresolutions aimed at people wishing to run older Solaris versions. 10935824d651Sblueswir1@item none 10945824d651Sblueswir1Disable VGA card. 10955824d651Sblueswir1@end table 10965824d651Sblueswir1ETEXI 10975824d651Sblueswir1 10985824d651Sblueswir1DEF("full-screen", 0, QEMU_OPTION_full_screen, 1099ad96090aSBlue Swirl "-full-screen start in full screen\n", QEMU_ARCH_ALL) 11005824d651Sblueswir1STEXI 11015824d651Sblueswir1@item -full-screen 11026616b2adSStefan Weil@findex -full-screen 11035824d651Sblueswir1Start in full screen. 11045824d651Sblueswir1ETEXI 11055824d651Sblueswir1 11065824d651Sblueswir1DEF("g", 1, QEMU_OPTION_g , 1107ad96090aSBlue Swirl "-g WxH[xDEPTH] Set the initial graphical resolution and depth\n", 1108ad96090aSBlue Swirl QEMU_ARCH_PPC | QEMU_ARCH_SPARC) 11095824d651Sblueswir1STEXI 111095d5f08bSStefan Weil@item -g @var{width}x@var{height}[x@var{depth}] 11116616b2adSStefan Weil@findex -g 111295d5f08bSStefan WeilSet the initial graphical resolution and depth (PPC, SPARC only). 11135824d651Sblueswir1ETEXI 11145824d651Sblueswir1 11155824d651Sblueswir1DEF("vnc", HAS_ARG, QEMU_OPTION_vnc , 1116ad96090aSBlue Swirl "-vnc display start a VNC server on display\n", QEMU_ARCH_ALL) 11175824d651Sblueswir1STEXI 11185824d651Sblueswir1@item -vnc @var{display}[,@var{option}[,@var{option}[,...]]] 11196616b2adSStefan Weil@findex -vnc 11205824d651Sblueswir1Normally, QEMU uses SDL to display the VGA output. With this option, 11215824d651Sblueswir1you can have QEMU listen on VNC display @var{display} and redirect the VGA 11225824d651Sblueswir1display over the VNC session. It is very useful to enable the usb 11235824d651Sblueswir1tablet device when using this option (option @option{-usbdevice 11245824d651Sblueswir1tablet}). When using the VNC display, you must use the @option{-k} 11255824d651Sblueswir1parameter to set the keyboard layout if you are not using en-us. Valid 11265824d651Sblueswir1syntax for the @var{display} is 11275824d651Sblueswir1 1128b3f046c2SKevin Wolf@table @option 11295824d651Sblueswir1 11305824d651Sblueswir1@item @var{host}:@var{d} 11315824d651Sblueswir1 11325824d651Sblueswir1TCP connections will only be allowed from @var{host} on display @var{d}. 11335824d651Sblueswir1By convention the TCP port is 5900+@var{d}. Optionally, @var{host} can 11345824d651Sblueswir1be omitted in which case the server will accept connections from any host. 11355824d651Sblueswir1 11364e257e5eSKevin Wolf@item unix:@var{path} 11375824d651Sblueswir1 11385824d651Sblueswir1Connections will be allowed over UNIX domain sockets where @var{path} is the 11395824d651Sblueswir1location of a unix socket to listen for connections on. 11405824d651Sblueswir1 11415824d651Sblueswir1@item none 11425824d651Sblueswir1 11435824d651Sblueswir1VNC is initialized but not started. The monitor @code{change} command 11445824d651Sblueswir1can be used to later start the VNC server. 11455824d651Sblueswir1 11465824d651Sblueswir1@end table 11475824d651Sblueswir1 11485824d651Sblueswir1Following the @var{display} value there may be one or more @var{option} flags 11495824d651Sblueswir1separated by commas. Valid options are 11505824d651Sblueswir1 1151b3f046c2SKevin Wolf@table @option 11525824d651Sblueswir1 11535824d651Sblueswir1@item reverse 11545824d651Sblueswir1 11555824d651Sblueswir1Connect to a listening VNC client via a ``reverse'' connection. The 11565824d651Sblueswir1client is specified by the @var{display}. For reverse network 11575824d651Sblueswir1connections (@var{host}:@var{d},@code{reverse}), the @var{d} argument 11585824d651Sblueswir1is a TCP port number, not a display number. 11595824d651Sblueswir1 11607536ee4bSTim Hardeck@item websocket 11617536ee4bSTim Hardeck 11627536ee4bSTim HardeckOpens an additional TCP listening port dedicated to VNC Websocket connections. 1163085d8134SPeter MaydellBy definition the Websocket port is 5700+@var{display}. If @var{host} is 11647536ee4bSTim Hardeckspecified connections will only be allowed from this host. 11657536ee4bSTim HardeckAs an alternative the Websocket port could be specified by using 11667536ee4bSTim Hardeck@code{websocket}=@var{port}. 11670057a0d5STim HardeckTLS encryption for the Websocket connection is supported if the required 11680057a0d5STim Hardeckcertificates are specified with the VNC option @option{x509}. 11697536ee4bSTim Hardeck 11705824d651Sblueswir1@item password 11715824d651Sblueswir1 11725824d651Sblueswir1Require that password based authentication is used for client connections. 117386ee5bc3SMichal Novotny 117486ee5bc3SMichal NovotnyThe password must be set separately using the @code{set_password} command in 117586ee5bc3SMichal Novotnythe @ref{pcsys_monitor}. The syntax to change your password is: 117686ee5bc3SMichal Novotny@code{set_password <protocol> <password>} where <protocol> could be either 117786ee5bc3SMichal Novotny"vnc" or "spice". 117886ee5bc3SMichal Novotny 117986ee5bc3SMichal NovotnyIf you would like to change <protocol> password expiration, you should use 118086ee5bc3SMichal Novotny@code{expire_password <protocol> <expiration-time>} where expiration time could 118186ee5bc3SMichal Novotnybe one of the following options: now, never, +seconds or UNIX time of 118286ee5bc3SMichal Novotnyexpiration, e.g. +60 to make password expire in 60 seconds, or 1335196800 118386ee5bc3SMichal Novotnyto make password expire on "Mon Apr 23 12:00:00 EDT 2012" (UNIX time for this 118486ee5bc3SMichal Novotnydate and time). 118586ee5bc3SMichal Novotny 118686ee5bc3SMichal NovotnyYou can also use keywords "now" or "never" for the expiration time to 118786ee5bc3SMichal Novotnyallow <protocol> password to expire immediately or never expire. 11885824d651Sblueswir1 11895824d651Sblueswir1@item tls 11905824d651Sblueswir1 11915824d651Sblueswir1Require that client use TLS when communicating with the VNC server. This 11925824d651Sblueswir1uses anonymous TLS credentials so is susceptible to a man-in-the-middle 11935824d651Sblueswir1attack. It is recommended that this option be combined with either the 11944e257e5eSKevin Wolf@option{x509} or @option{x509verify} options. 11955824d651Sblueswir1 11965824d651Sblueswir1@item x509=@var{/path/to/certificate/dir} 11975824d651Sblueswir1 11985824d651Sblueswir1Valid if @option{tls} is specified. Require that x509 credentials are used 11995824d651Sblueswir1for negotiating the TLS session. The server will send its x509 certificate 12005824d651Sblueswir1to the client. It is recommended that a password be set on the VNC server 12015824d651Sblueswir1to provide authentication of the client when this is used. The path following 12025824d651Sblueswir1this option specifies where the x509 certificates are to be loaded from. 12035824d651Sblueswir1See the @ref{vnc_security} section for details on generating certificates. 12045824d651Sblueswir1 12055824d651Sblueswir1@item x509verify=@var{/path/to/certificate/dir} 12065824d651Sblueswir1 12075824d651Sblueswir1Valid if @option{tls} is specified. Require that x509 credentials are used 12085824d651Sblueswir1for negotiating the TLS session. The server will send its x509 certificate 12095824d651Sblueswir1to the client, and request that the client send its own x509 certificate. 12105824d651Sblueswir1The server will validate the client's certificate against the CA certificate, 12115824d651Sblueswir1and reject clients when validation fails. If the certificate authority is 12125824d651Sblueswir1trusted, this is a sufficient authentication mechanism. You may still wish 12135824d651Sblueswir1to set a password on the VNC server as a second authentication layer. The 12145824d651Sblueswir1path following this option specifies where the x509 certificates are to 12155824d651Sblueswir1be loaded from. See the @ref{vnc_security} section for details on generating 12165824d651Sblueswir1certificates. 12175824d651Sblueswir1 12185824d651Sblueswir1@item sasl 12195824d651Sblueswir1 12205824d651Sblueswir1Require that the client use SASL to authenticate with the VNC server. 12215824d651Sblueswir1The exact choice of authentication method used is controlled from the 12225824d651Sblueswir1system / user's SASL configuration file for the 'qemu' service. This 12235824d651Sblueswir1is typically found in /etc/sasl2/qemu.conf. If running QEMU as an 12245824d651Sblueswir1unprivileged user, an environment variable SASL_CONF_PATH can be used 12255824d651Sblueswir1to make it search alternate locations for the service config. 12265824d651Sblueswir1While some SASL auth methods can also provide data encryption (eg GSSAPI), 12275824d651Sblueswir1it is recommended that SASL always be combined with the 'tls' and 12285824d651Sblueswir1'x509' settings to enable use of SSL and server certificates. This 12295824d651Sblueswir1ensures a data encryption preventing compromise of authentication 12305824d651Sblueswir1credentials. See the @ref{vnc_security} section for details on using 12315824d651Sblueswir1SASL authentication. 12325824d651Sblueswir1 12335824d651Sblueswir1@item acl 12345824d651Sblueswir1 12355824d651Sblueswir1Turn on access control lists for checking of the x509 client certificate 12365824d651Sblueswir1and SASL party. For x509 certs, the ACL check is made against the 12375824d651Sblueswir1certificate's distinguished name. This is something that looks like 12385824d651Sblueswir1@code{C=GB,O=ACME,L=Boston,CN=bob}. For SASL party, the ACL check is 12395824d651Sblueswir1made against the username, which depending on the SASL plugin, may 12405824d651Sblueswir1include a realm component, eg @code{bob} or @code{bob@@EXAMPLE.COM}. 12415824d651Sblueswir1When the @option{acl} flag is set, the initial access list will be 12425824d651Sblueswir1empty, with a @code{deny} policy. Thus no one will be allowed to 12435824d651Sblueswir1use the VNC server until the ACLs have been loaded. This can be 12445824d651Sblueswir1achieved using the @code{acl} monitor command. 12455824d651Sblueswir1 12466f9c78c1SCorentin Chary@item lossy 12476f9c78c1SCorentin Chary 12486f9c78c1SCorentin CharyEnable lossy compression methods (gradient, JPEG, ...). If this 12496f9c78c1SCorentin Charyoption is set, VNC client may receive lossy framebuffer updates 12506f9c78c1SCorentin Charydepending on its encoding settings. Enabling this option can save 12516f9c78c1SCorentin Charya lot of bandwidth at the expense of quality. 12526f9c78c1SCorentin Chary 125380e0c8c3SCorentin Chary@item non-adaptive 125480e0c8c3SCorentin Chary 125580e0c8c3SCorentin CharyDisable adaptive encodings. Adaptive encodings are enabled by default. 125680e0c8c3SCorentin CharyAn adaptive encoding will try to detect frequently updated screen regions, 125780e0c8c3SCorentin Charyand send updates in these regions using a lossy encoding (like JPEG). 125861cc8701SStefan WeilThis can be really helpful to save bandwidth when playing videos. Disabling 12599d85d557SMichael Tokarevadaptive encodings restores the original static behavior of encodings 126080e0c8c3SCorentin Charylike Tight. 126180e0c8c3SCorentin Chary 12628cf36489SGerd Hoffmann@item share=[allow-exclusive|force-shared|ignore] 12638cf36489SGerd Hoffmann 12648cf36489SGerd HoffmannSet display sharing policy. 'allow-exclusive' allows clients to ask 12658cf36489SGerd Hoffmannfor exclusive access. As suggested by the rfb spec this is 12668cf36489SGerd Hoffmannimplemented by dropping other connections. Connecting multiple 12678cf36489SGerd Hoffmannclients in parallel requires all clients asking for a shared session 12688cf36489SGerd Hoffmann(vncviewer: -shared switch). This is the default. 'force-shared' 12698cf36489SGerd Hoffmanndisables exclusive client access. Useful for shared desktop sessions, 12708cf36489SGerd Hoffmannwhere you don't want someone forgetting specify -shared disconnect 12718cf36489SGerd Hoffmanneverybody else. 'ignore' completely ignores the shared flag and 12728cf36489SGerd Hoffmannallows everybody connect unconditionally. Doesn't conform to the rfb 1273b65ee4faSStefan Weilspec but is traditional QEMU behavior. 12748cf36489SGerd Hoffmann 12755824d651Sblueswir1@end table 12765824d651Sblueswir1ETEXI 12775824d651Sblueswir1 12785824d651Sblueswir1STEXI 12795824d651Sblueswir1@end table 12805824d651Sblueswir1ETEXI 1281a3adb7adSMichael EllermanARCHHEADING(, QEMU_ARCH_I386) 12825824d651Sblueswir1 1283a3adb7adSMichael EllermanARCHHEADING(i386 target only:, QEMU_ARCH_I386) 12845824d651Sblueswir1STEXI 12855824d651Sblueswir1@table @option 12865824d651Sblueswir1ETEXI 12875824d651Sblueswir1 12885824d651Sblueswir1DEF("win2k-hack", 0, QEMU_OPTION_win2k_hack, 1289ad96090aSBlue Swirl "-win2k-hack use it when installing Windows 2000 to avoid a disk full bug\n", 1290ad96090aSBlue Swirl QEMU_ARCH_I386) 12915824d651Sblueswir1STEXI 12925824d651Sblueswir1@item -win2k-hack 12936616b2adSStefan Weil@findex -win2k-hack 12945824d651Sblueswir1Use it when installing Windows 2000 to avoid a disk full bug. After 12955824d651Sblueswir1Windows 2000 is installed, you no longer need this option (this option 12965824d651Sblueswir1slows down the IDE transfers). 12975824d651Sblueswir1ETEXI 12985824d651Sblueswir1 12991ed2fc1fSJan KiszkaHXCOMM Deprecated by -rtc 1300ad96090aSBlue SwirlDEF("rtc-td-hack", 0, QEMU_OPTION_rtc_td_hack, "", QEMU_ARCH_I386) 13015824d651Sblueswir1 13025824d651Sblueswir1DEF("no-fd-bootchk", 0, QEMU_OPTION_no_fd_bootchk, 1303ad96090aSBlue Swirl "-no-fd-bootchk disable boot signature checking for floppy disks\n", 1304ad96090aSBlue Swirl QEMU_ARCH_I386) 13055824d651Sblueswir1STEXI 13065824d651Sblueswir1@item -no-fd-bootchk 13076616b2adSStefan Weil@findex -no-fd-bootchk 13084eda32f5SMarkus ArmbrusterDisable boot signature checking for floppy disks in BIOS. May 13095824d651Sblueswir1be needed to boot from old floppy disks. 13105824d651Sblueswir1ETEXI 13115824d651Sblueswir1 13125824d651Sblueswir1DEF("no-acpi", 0, QEMU_OPTION_no_acpi, 1313ad96090aSBlue Swirl "-no-acpi disable ACPI\n", QEMU_ARCH_I386) 13145824d651Sblueswir1STEXI 13155824d651Sblueswir1@item -no-acpi 13166616b2adSStefan Weil@findex -no-acpi 13175824d651Sblueswir1Disable ACPI (Advanced Configuration and Power Interface) support. Use 13185824d651Sblueswir1it if your guest OS complains about ACPI problems (PC target machine 13195824d651Sblueswir1only). 13205824d651Sblueswir1ETEXI 13215824d651Sblueswir1 13225824d651Sblueswir1DEF("no-hpet", 0, QEMU_OPTION_no_hpet, 1323ad96090aSBlue Swirl "-no-hpet disable HPET\n", QEMU_ARCH_I386) 13245824d651Sblueswir1STEXI 13255824d651Sblueswir1@item -no-hpet 13266616b2adSStefan Weil@findex -no-hpet 13275824d651Sblueswir1Disable HPET support. 13285824d651Sblueswir1ETEXI 13295824d651Sblueswir1 13305824d651Sblueswir1DEF("acpitable", HAS_ARG, QEMU_OPTION_acpitable, 1331104bf02eSMichael 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" 1332ad96090aSBlue Swirl " ACPI table description\n", QEMU_ARCH_I386) 13335824d651Sblueswir1STEXI 13345824d651Sblueswir1@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}]...] 13356616b2adSStefan Weil@findex -acpitable 13365824d651Sblueswir1Add ACPI table with specified header fields and context from specified files. 1337104bf02eSMichael TokarevFor file=, take whole ACPI table from the specified files, including all 1338104bf02eSMichael TokarevACPI headers (possible overridden by other options). 1339104bf02eSMichael TokarevFor data=, only data 1340104bf02eSMichael Tokarevportion of the table is used, all header information is specified in the 1341104bf02eSMichael Tokarevcommand line. 13425824d651Sblueswir1ETEXI 13435824d651Sblueswir1 1344b6f6e3d3SaliguoriDEF("smbios", HAS_ARG, QEMU_OPTION_smbios, 1345b6f6e3d3Saliguori "-smbios file=binary\n" 1346ca1a8a06SBruce Rogers " load SMBIOS entry from binary file\n" 134784351843SGabriel L. Somlo "-smbios type=0[,vendor=str][,version=str][,date=str][,release=%d.%d][,uefi=on|off]\n" 1348ca1a8a06SBruce Rogers " specify SMBIOS type 0 fields\n" 1349b6f6e3d3Saliguori "-smbios type=1[,manufacturer=str][,product=str][,version=str][,serial=str]\n" 1350b6f6e3d3Saliguori " [,uuid=uuid][,sku=str][,family=str]\n" 1351ad96090aSBlue Swirl " specify SMBIOS type 1 fields\n", QEMU_ARCH_I386) 1352b6f6e3d3SaliguoriSTEXI 1353b6f6e3d3Saliguori@item -smbios file=@var{binary} 13546616b2adSStefan Weil@findex -smbios 1355b6f6e3d3SaliguoriLoad SMBIOS entry from binary file. 1356b6f6e3d3Saliguori 135784351843SGabriel L. Somlo@item -smbios type=0[,vendor=@var{str}][,version=@var{str}][,date=@var{str}][,release=@var{%d.%d}][,uefi=on|off] 1358b6f6e3d3SaliguoriSpecify SMBIOS type 0 fields 1359b6f6e3d3Saliguori 1360b6f6e3d3Saliguori@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}] 1361b6f6e3d3SaliguoriSpecify SMBIOS type 1 fields 1362b6f6e3d3SaliguoriETEXI 1363b6f6e3d3Saliguori 13645824d651Sblueswir1STEXI 13655824d651Sblueswir1@end table 13665824d651Sblueswir1ETEXI 1367c70a01e4SMarkus ArmbrusterDEFHEADING() 13685824d651Sblueswir1 13695824d651Sblueswir1DEFHEADING(Network options:) 13705824d651Sblueswir1STEXI 13715824d651Sblueswir1@table @option 13725824d651Sblueswir1ETEXI 13735824d651Sblueswir1 1374ad196a9dSJan KiszkaHXCOMM Legacy slirp options (now moved to -net user): 1375ad196a9dSJan Kiszka#ifdef CONFIG_SLIRP 1376ad96090aSBlue SwirlDEF("tftp", HAS_ARG, QEMU_OPTION_tftp, "", QEMU_ARCH_ALL) 1377ad96090aSBlue SwirlDEF("bootp", HAS_ARG, QEMU_OPTION_bootp, "", QEMU_ARCH_ALL) 1378ad96090aSBlue SwirlDEF("redir", HAS_ARG, QEMU_OPTION_redir, "", QEMU_ARCH_ALL) 1379ad196a9dSJan Kiszka#ifndef _WIN32 1380ad96090aSBlue SwirlDEF("smb", HAS_ARG, QEMU_OPTION_smb, "", QEMU_ARCH_ALL) 1381ad196a9dSJan Kiszka#endif 1382ad196a9dSJan Kiszka#endif 1383ad196a9dSJan Kiszka 1384bab7944cSBlue SwirlDEF("net", HAS_ARG, QEMU_OPTION_net, 1385ffe6370cSMichael S. Tsirkin "-net nic[,vlan=n][,macaddr=mac][,model=type][,name=str][,addr=str][,vectors=v]\n" 13865824d651Sblueswir1 " create a new Network Interface Card and connect it to VLAN 'n'\n" 13875824d651Sblueswir1#ifdef CONFIG_SLIRP 1388c54ed5bcSJan Kiszka "-net user[,vlan=n][,name=str][,net=addr[/mask]][,host=addr][,restrict=on|off]\n" 138963d2960bSKlaus Stengel " [,hostname=host][,dhcpstart=addr][,dns=addr][,dnssearch=domain][,tftp=dir]\n" 139063d2960bSKlaus Stengel " [,bootfile=f][,hostfwd=rule][,guestfwd=rule]" 1391ad196a9dSJan Kiszka#ifndef _WIN32 1392c92ef6a2SJan Kiszka "[,smb=dir[,smbserver=addr]]\n" 1393ad196a9dSJan Kiszka#endif 1394ad196a9dSJan Kiszka " connect the user mode network stack to VLAN 'n', configure its\n" 1395ad196a9dSJan Kiszka " DHCP server and enabled optional services\n" 13965824d651Sblueswir1#endif 13975824d651Sblueswir1#ifdef _WIN32 13985824d651Sblueswir1 "-net tap[,vlan=n][,name=str],ifname=name\n" 13995824d651Sblueswir1 " connect the host TAP network interface to VLAN 'n'\n" 14005824d651Sblueswir1#else 1401ec396014SJason 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" 1402a7c36ee4SCorey Bryant " connect the host TAP network interface to VLAN 'n'\n" 1403a7c36ee4SCorey Bryant " use network scripts 'file' (default=" DEFAULT_NETWORK_SCRIPT ")\n" 1404a7c36ee4SCorey Bryant " to configure it and 'dfile' (default=" DEFAULT_NETWORK_DOWN_SCRIPT ")\n" 1405a7c36ee4SCorey Bryant " to deconfigure it\n" 1406ca1a8a06SBruce Rogers " use '[down]script=no' to disable script execution\n" 1407a7c36ee4SCorey Bryant " use network helper 'helper' (default=" DEFAULT_BRIDGE_HELPER ") to\n" 1408a7c36ee4SCorey Bryant " configure it\n" 14095824d651Sblueswir1 " use 'fd=h' to connect to an already opened TAP interface\n" 14102ca81baaSJason Wang " use 'fds=x:y:...:z' to connect to already opened multiqueue capable TAP interfaces\n" 1411ca1a8a06SBruce Rogers " use 'sndbuf=nbytes' to limit the size of the send buffer (the\n" 1412f157ed20SMichael S. Tsirkin " default is disabled 'sndbuf=0' to enable flow control set 'sndbuf=1048576')\n" 1413ca1a8a06SBruce Rogers " use vnet_hdr=off to avoid enabling the IFF_VNET_HDR tap flag\n" 1414ca1a8a06SBruce Rogers " use vnet_hdr=on to make the lack of IFF_VNET_HDR support an error condition\n" 141582b0d80eSMichael S. Tsirkin " use vhost=on to enable experimental in kernel accelerator\n" 14165430a28fSmst@redhat.com " (only has effect for virtio guests which use MSIX)\n" 14175430a28fSmst@redhat.com " use vhostforce=on to force vhost on for non-MSIX virtio guests\n" 141882b0d80eSMichael S. Tsirkin " use 'vhostfd=h' to connect to an already opened vhost net device\n" 14192ca81baaSJason Wang " use 'vhostfds=x:y:...:z to connect to multiple already opened vhost net devices\n" 1420ec396014SJason Wang " use 'queues=n' to specify the number of queues to be created for multiqueue TAP\n" 1421a7c36ee4SCorey Bryant "-net bridge[,vlan=n][,name=str][,br=bridge][,helper=helper]\n" 1422a7c36ee4SCorey Bryant " connects a host TAP network interface to a host bridge device 'br'\n" 1423a7c36ee4SCorey Bryant " (default=" DEFAULT_BRIDGE_INTERFACE ") using the program 'helper'\n" 1424a7c36ee4SCorey Bryant " (default=" DEFAULT_BRIDGE_HELPER ")\n" 14250df0ff6dSMark McLoughlin#endif 14265824d651Sblueswir1 "-net socket[,vlan=n][,name=str][,fd=h][,listen=[host]:port][,connect=host:port]\n" 14275824d651Sblueswir1 " connect the vlan 'n' to another VLAN using a socket connection\n" 14283a75e74cSMike Ryan "-net socket[,vlan=n][,name=str][,fd=h][,mcast=maddr:port[,localaddr=addr]]\n" 14295824d651Sblueswir1 " connect the vlan 'n' to multicast maddr and port\n" 14303a75e74cSMike Ryan " use 'localaddr=addr' to specify the host address to send packets from\n" 14310e0e7facSBenjamin "-net socket[,vlan=n][,name=str][,fd=h][,udp=host:port][,localaddr=host:port]\n" 14320e0e7facSBenjamin " connect the vlan 'n' to another VLAN using an UDP tunnel\n" 14335824d651Sblueswir1#ifdef CONFIG_VDE 14345824d651Sblueswir1 "-net vde[,vlan=n][,name=str][,sock=socketpath][,port=n][,group=groupname][,mode=octalmode]\n" 14355824d651Sblueswir1 " connect the vlan 'n' to port 'n' of a vde switch running\n" 14365824d651Sblueswir1 " on host and listening for incoming connections on 'socketpath'.\n" 14375824d651Sblueswir1 " Use group 'groupname' and mode 'octalmode' to change default\n" 14385824d651Sblueswir1 " ownership and permissions for communication port.\n" 14395824d651Sblueswir1#endif 144058952137SVincenzo Maffione#ifdef CONFIG_NETMAP 144158952137SVincenzo Maffione "-net netmap,ifname=name[,devname=nmname]\n" 144258952137SVincenzo Maffione " attach to the existing netmap-enabled network interface 'name', or to a\n" 144358952137SVincenzo Maffione " VALE port (created on the fly) called 'name' ('nmname' is name of the \n" 144458952137SVincenzo Maffione " netmap device, defaults to '/dev/netmap')\n" 144558952137SVincenzo Maffione#endif 1446bb9ea79eSaliguori "-net dump[,vlan=n][,file=f][,len=n]\n" 1447bb9ea79eSaliguori " dump traffic on vlan 'n' to file 'f' (max n bytes per packet)\n" 1448ca1a8a06SBruce Rogers "-net none use it alone to have zero network devices. If no -net option\n" 1449ad96090aSBlue Swirl " is provided, the default is '-net nic -net user'\n", QEMU_ARCH_ALL) 1450a1ea458fSMark McLoughlinDEF("netdev", HAS_ARG, QEMU_OPTION_netdev, 1451a1ea458fSMark McLoughlin "-netdev [" 1452a1ea458fSMark McLoughlin#ifdef CONFIG_SLIRP 1453a1ea458fSMark McLoughlin "user|" 1454a1ea458fSMark McLoughlin#endif 1455a1ea458fSMark McLoughlin "tap|" 1456a7c36ee4SCorey Bryant "bridge|" 1457a1ea458fSMark McLoughlin#ifdef CONFIG_VDE 1458a1ea458fSMark McLoughlin "vde|" 1459a1ea458fSMark McLoughlin#endif 146058952137SVincenzo Maffione#ifdef CONFIG_NETMAP 146158952137SVincenzo Maffione "netmap|" 146258952137SVincenzo Maffione#endif 146340e8c26dSStefan Hajnoczi "socket|" 146440e8c26dSStefan Hajnoczi "hubport],id=str[,option][,option][,...]\n", QEMU_ARCH_ALL) 14655824d651Sblueswir1STEXI 1466ffe6370cSMichael S. Tsirkin@item -net nic[,vlan=@var{n}][,macaddr=@var{mac}][,model=@var{type}] [,name=@var{name}][,addr=@var{addr}][,vectors=@var{v}] 14676616b2adSStefan Weil@findex -net 14685824d651Sblueswir1Create a new Network Interface Card and connect it to VLAN @var{n} (@var{n} 14690d6b0b1dSAnthony Liguori= 0 is the default). The NIC is an e1000 by default on the PC 14705607c388SMarkus Armbrustertarget. Optionally, the MAC address can be changed to @var{mac}, the 14715607c388SMarkus Armbrusterdevice address set to @var{addr} (PCI cards only), 1472ffe6370cSMichael S. Tsirkinand a @var{name} can be assigned for use in monitor commands. 1473ffe6370cSMichael S. TsirkinOptionally, for PCI cards, you can specify the number @var{v} of MSI-X vectors 1474ffe6370cSMichael S. Tsirkinthat the card should have; this option currently only affects virtio cards; set 1475ffe6370cSMichael S. Tsirkin@var{v} = 0 to disable MSI-X. If no @option{-net} option is specified, a single 1476071c9394SStefan WeilNIC is created. QEMU can emulate several different models of network card. 14775824d651Sblueswir1Valid values for @var{type} are 1478ffe6370cSMichael S. Tsirkin@code{virtio}, @code{i82551}, @code{i82557b}, @code{i82559er}, 14795824d651Sblueswir1@code{ne2k_pci}, @code{ne2k_isa}, @code{pcnet}, @code{rtl8139}, 14805824d651Sblueswir1@code{e1000}, @code{smc91c111}, @code{lance} and @code{mcf_fec}. 1481585f6036SPeter MaydellNot all devices are supported on all targets. Use @code{-net nic,model=help} 14825824d651Sblueswir1for a list of available devices for your target. 14835824d651Sblueswir1 148408d12022SStefan Hajnoczi@item -netdev user,id=@var{id}[,@var{option}][,@var{option}][,...] 1485b8f490ebSMarkus Armbruster@findex -netdev 1486ad196a9dSJan Kiszka@item -net user[,@var{option}][,@var{option}][,...] 14875824d651Sblueswir1Use the user mode network stack which requires no administrator 1488ad196a9dSJan Kiszkaprivilege to run. Valid options are: 14895824d651Sblueswir1 1490b3f046c2SKevin Wolf@table @option 1491ad196a9dSJan Kiszka@item vlan=@var{n} 1492ad196a9dSJan KiszkaConnect user mode stack to VLAN @var{n} (@var{n} = 0 is the default). 1493ad196a9dSJan Kiszka 149408d12022SStefan Hajnoczi@item id=@var{id} 1495ad196a9dSJan Kiszka@item name=@var{name} 1496ad196a9dSJan KiszkaAssign symbolic name for use in monitor commands. 1497ad196a9dSJan Kiszka 1498c92ef6a2SJan Kiszka@item net=@var{addr}[/@var{mask}] 1499c92ef6a2SJan KiszkaSet IP network address the guest will see. Optionally specify the netmask, 1500c92ef6a2SJan Kiszkaeither in the form a.b.c.d or as number of valid top-most bits. Default is 1501b0b36e5dSBrad Hards10.0.2.0/24. 1502c92ef6a2SJan Kiszka 1503c92ef6a2SJan Kiszka@item host=@var{addr} 1504c92ef6a2SJan KiszkaSpecify the guest-visible address of the host. Default is the 2nd IP in the 1505c92ef6a2SJan Kiszkaguest network, i.e. x.x.x.2. 1506ad196a9dSJan Kiszka 1507c54ed5bcSJan Kiszka@item restrict=on|off 1508caef55edSBrad HardsIf this option is enabled, the guest will be isolated, i.e. it will not be 1509ad196a9dSJan Kiszkaable to contact the host and no guest IP packets will be routed over the host 1510caef55edSBrad Hardsto the outside. This option does not affect any explicitly set forwarding rules. 1511ad196a9dSJan Kiszka 1512ad196a9dSJan Kiszka@item hostname=@var{name} 151363d2960bSKlaus StengelSpecifies the client hostname reported by the built-in DHCP server. 1514ad196a9dSJan Kiszka 1515c92ef6a2SJan Kiszka@item dhcpstart=@var{addr} 1516c92ef6a2SJan KiszkaSpecify the first of the 16 IPs the built-in DHCP server can assign. Default 1517b0b36e5dSBrad Hardsis the 15th to 31st IP in the guest network, i.e. x.x.x.15 to x.x.x.31. 1518c92ef6a2SJan Kiszka 1519c92ef6a2SJan Kiszka@item dns=@var{addr} 1520c92ef6a2SJan KiszkaSpecify the guest-visible address of the virtual nameserver. The address must 1521c92ef6a2SJan Kiszkabe different from the host address. Default is the 3rd IP in the guest network, 1522c92ef6a2SJan Kiszkai.e. x.x.x.3. 1523c92ef6a2SJan Kiszka 152463d2960bSKlaus Stengel@item dnssearch=@var{domain} 152563d2960bSKlaus StengelProvides an entry for the domain-search list sent by the built-in 152663d2960bSKlaus StengelDHCP server. More than one domain suffix can be transmitted by specifying 152763d2960bSKlaus Stengelthis option multiple times. If supported, this will cause the guest to 152863d2960bSKlaus Stengelautomatically try to append the given domain suffix(es) in case a domain name 152963d2960bSKlaus Stengelcan not be resolved. 153063d2960bSKlaus Stengel 153163d2960bSKlaus StengelExample: 153263d2960bSKlaus Stengel@example 153363d2960bSKlaus Stengelqemu -net user,dnssearch=mgmt.example.org,dnssearch=example.org [...] 153463d2960bSKlaus Stengel@end example 153563d2960bSKlaus Stengel 1536ad196a9dSJan Kiszka@item tftp=@var{dir} 1537ad196a9dSJan KiszkaWhen using the user mode network stack, activate a built-in TFTP 1538ad196a9dSJan Kiszkaserver. The files in @var{dir} will be exposed as the root of a TFTP server. 1539ad196a9dSJan KiszkaThe TFTP client on the guest must be configured in binary mode (use the command 1540c92ef6a2SJan Kiszka@code{bin} of the Unix TFTP client). 1541ad196a9dSJan Kiszka 1542ad196a9dSJan Kiszka@item bootfile=@var{file} 1543ad196a9dSJan KiszkaWhen using the user mode network stack, broadcast @var{file} as the BOOTP 1544ad196a9dSJan Kiszkafilename. In conjunction with @option{tftp}, this can be used to network boot 1545ad196a9dSJan Kiszkaa guest from a local directory. 1546ad196a9dSJan Kiszka 1547ad196a9dSJan KiszkaExample (using pxelinux): 1548ad196a9dSJan Kiszka@example 15493804da9dSStefan Weilqemu-system-i386 -hda linux.img -boot n -net user,tftp=/path/to/tftp/files,bootfile=/pxelinux.0 1550ad196a9dSJan Kiszka@end example 1551ad196a9dSJan Kiszka 1552c92ef6a2SJan Kiszka@item smb=@var{dir}[,smbserver=@var{addr}] 1553ad196a9dSJan KiszkaWhen using the user mode network stack, activate a built-in SMB 1554ad196a9dSJan Kiszkaserver so that Windows OSes can access to the host files in @file{@var{dir}} 1555c92ef6a2SJan Kiszkatransparently. The IP address of the SMB server can be set to @var{addr}. By 1556c92ef6a2SJan Kiszkadefault the 4th IP in the guest network is used, i.e. x.x.x.4. 1557ad196a9dSJan Kiszka 1558ad196a9dSJan KiszkaIn the guest Windows OS, the line: 1559ad196a9dSJan Kiszka@example 1560ad196a9dSJan Kiszka10.0.2.4 smbserver 1561ad196a9dSJan Kiszka@end example 1562ad196a9dSJan Kiszkamust be added in the file @file{C:\WINDOWS\LMHOSTS} (for windows 9x/Me) 1563ad196a9dSJan Kiszkaor @file{C:\WINNT\SYSTEM32\DRIVERS\ETC\LMHOSTS} (Windows NT/2000). 1564ad196a9dSJan Kiszka 1565ad196a9dSJan KiszkaThen @file{@var{dir}} can be accessed in @file{\\smbserver\qemu}. 1566ad196a9dSJan Kiszka 1567e2d8830eSBradNote that a SAMBA server must be installed on the host OS. 1568e2d8830eSBradQEMU was tested successfully with smbd versions from Red Hat 9, 1569e2d8830eSBradFedora Core 3 and OpenSUSE 11.x. 1570ad196a9dSJan Kiszka 15713c6a0580SJan Kiszka@item hostfwd=[tcp|udp]:[@var{hostaddr}]:@var{hostport}-[@var{guestaddr}]:@var{guestport} 1572c92ef6a2SJan KiszkaRedirect incoming TCP or UDP connections to the host port @var{hostport} to 1573c92ef6a2SJan Kiszkathe guest IP address @var{guestaddr} on guest port @var{guestport}. If 1574c92ef6a2SJan Kiszka@var{guestaddr} is not specified, its value is x.x.x.15 (default first address 15753c6a0580SJan Kiszkagiven by the built-in DHCP server). By specifying @var{hostaddr}, the rule can 15763c6a0580SJan Kiszkabe bound to a specific host interface. If no connection type is set, TCP is 1577c92ef6a2SJan Kiszkaused. This option can be given multiple times. 1578ad196a9dSJan Kiszka 1579ad196a9dSJan KiszkaFor example, to redirect host X11 connection from screen 1 to guest 1580ad196a9dSJan Kiszkascreen 0, use the following: 1581ad196a9dSJan Kiszka 1582ad196a9dSJan Kiszka@example 1583ad196a9dSJan Kiszka# on the host 15843804da9dSStefan Weilqemu-system-i386 -net user,hostfwd=tcp:127.0.0.1:6001-:6000 [...] 1585ad196a9dSJan Kiszka# this host xterm should open in the guest X11 server 1586ad196a9dSJan Kiszkaxterm -display :1 1587ad196a9dSJan Kiszka@end example 1588ad196a9dSJan Kiszka 1589ad196a9dSJan KiszkaTo redirect telnet connections from host port 5555 to telnet port on 1590ad196a9dSJan Kiszkathe guest, use the following: 1591ad196a9dSJan Kiszka 1592ad196a9dSJan Kiszka@example 1593ad196a9dSJan Kiszka# on the host 15943804da9dSStefan Weilqemu-system-i386 -net user,hostfwd=tcp::5555-:23 [...] 1595ad196a9dSJan Kiszkatelnet localhost 5555 1596ad196a9dSJan Kiszka@end example 1597ad196a9dSJan Kiszka 1598ad196a9dSJan KiszkaThen when you use on the host @code{telnet localhost 5555}, you 1599ad196a9dSJan Kiszkaconnect to the guest telnet server. 1600ad196a9dSJan Kiszka 1601c92ef6a2SJan Kiszka@item guestfwd=[tcp]:@var{server}:@var{port}-@var{dev} 1602b412eb61SAlexander Graf@item guestfwd=[tcp]:@var{server}:@var{port}-@var{cmd:command} 16033c6a0580SJan KiszkaForward guest TCP connections to the IP address @var{server} on port @var{port} 1604b412eb61SAlexander Grafto the character device @var{dev} or to a program executed by @var{cmd:command} 1605b412eb61SAlexander Grafwhich gets spawned for each connection. This option can be given multiple times. 1606b412eb61SAlexander Graf 160743ffe61fSStefan WeilYou can either use a chardev directly and have that one used throughout QEMU's 1608b412eb61SAlexander Graflifetime, like in the following example: 1609b412eb61SAlexander Graf 1610b412eb61SAlexander Graf@example 1611b412eb61SAlexander Graf# open 10.10.1.1:4321 on bootup, connect 10.0.2.100:1234 to it whenever 1612b412eb61SAlexander Graf# the guest accesses it 1613b412eb61SAlexander Grafqemu -net user,guestfwd=tcp:10.0.2.100:1234-tcp:10.10.1.1:4321 [...] 1614b412eb61SAlexander Graf@end example 1615b412eb61SAlexander Graf 1616b412eb61SAlexander GrafOr you can execute a command on every TCP connection established by the guest, 161743ffe61fSStefan Weilso that QEMU behaves similar to an inetd process for that virtual server: 1618b412eb61SAlexander Graf 1619b412eb61SAlexander Graf@example 1620b412eb61SAlexander Graf# call "netcat 10.10.1.1 4321" on every TCP connection to 10.0.2.100:1234 1621b412eb61SAlexander Graf# and connect the TCP stream to its stdin/stdout 1622b412eb61SAlexander Grafqemu -net 'user,guestfwd=tcp:10.0.2.100:1234-cmd:netcat 10.10.1.1 4321' 1623b412eb61SAlexander Graf@end example 1624ad196a9dSJan Kiszka 1625ad196a9dSJan Kiszka@end table 1626ad196a9dSJan Kiszka 1627ad196a9dSJan KiszkaNote: Legacy stand-alone options -tftp, -bootp, -smb and -redir are still 1628ad196a9dSJan Kiszkaprocessed and applied to -net user. Mixing them with the new configuration 1629ad196a9dSJan Kiszkasyntax gives undefined results. Their use for new applications is discouraged 1630ad196a9dSJan Kiszkaas they will be removed from future versions. 16315824d651Sblueswir1 163208d12022SStefan Hajnoczi@item -netdev tap,id=@var{id}[,fd=@var{h}][,ifname=@var{name}][,script=@var{file}][,downscript=@var{dfile}][,helper=@var{helper}] 1633a7c36ee4SCorey 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}] 1634a7c36ee4SCorey BryantConnect the host TAP network interface @var{name} to VLAN @var{n}. 1635a7c36ee4SCorey Bryant 1636a7c36ee4SCorey BryantUse the network script @var{file} to configure it and the network script 16375824d651Sblueswir1@var{dfile} to deconfigure it. If @var{name} is not provided, the OS 1638a7c36ee4SCorey Bryantautomatically provides one. The default network configure script is 1639a7c36ee4SCorey Bryant@file{/etc/qemu-ifup} and the default network deconfigure script is 1640a7c36ee4SCorey Bryant@file{/etc/qemu-ifdown}. Use @option{script=no} or @option{downscript=no} 1641a7c36ee4SCorey Bryantto disable script execution. 1642a7c36ee4SCorey Bryant 1643a7c36ee4SCorey BryantIf running QEMU as an unprivileged user, use the network helper 1644a7c36ee4SCorey Bryant@var{helper} to configure the TAP interface. The default network 1645420508fbSAmos Konghelper executable is @file{/path/to/qemu-bridge-helper}. 1646a7c36ee4SCorey Bryant 1647a7c36ee4SCorey Bryant@option{fd}=@var{h} can be used to specify the handle of an already 1648a7c36ee4SCorey Bryantopened host TAP interface. 1649a7c36ee4SCorey Bryant 1650a7c36ee4SCorey BryantExamples: 16515824d651Sblueswir1 16525824d651Sblueswir1@example 1653a7c36ee4SCorey Bryant#launch a QEMU instance with the default network script 16543804da9dSStefan Weilqemu-system-i386 linux.img -net nic -net tap 16555824d651Sblueswir1@end example 16565824d651Sblueswir1 16575824d651Sblueswir1@example 1658a7c36ee4SCorey Bryant#launch a QEMU instance with two NICs, each one connected 1659a7c36ee4SCorey Bryant#to a TAP device 16603804da9dSStefan Weilqemu-system-i386 linux.img \ 16613804da9dSStefan Weil -net nic,vlan=0 -net tap,vlan=0,ifname=tap0 \ 16625824d651Sblueswir1 -net nic,vlan=1 -net tap,vlan=1,ifname=tap1 16635824d651Sblueswir1@end example 16645824d651Sblueswir1 1665a7c36ee4SCorey Bryant@example 1666a7c36ee4SCorey Bryant#launch a QEMU instance with the default network helper to 1667a7c36ee4SCorey Bryant#connect a TAP device to bridge br0 16683804da9dSStefan Weilqemu-system-i386 linux.img \ 1669420508fbSAmos Kong -net nic -net tap,"helper=/path/to/qemu-bridge-helper" 1670a7c36ee4SCorey Bryant@end example 1671a7c36ee4SCorey Bryant 167208d12022SStefan Hajnoczi@item -netdev bridge,id=@var{id}[,br=@var{bridge}][,helper=@var{helper}] 1673a7c36ee4SCorey Bryant@item -net bridge[,vlan=@var{n}][,name=@var{name}][,br=@var{bridge}][,helper=@var{helper}] 1674a7c36ee4SCorey BryantConnect a host TAP network interface to a host bridge device. 1675a7c36ee4SCorey Bryant 1676a7c36ee4SCorey BryantUse the network helper @var{helper} to configure the TAP interface and 1677a7c36ee4SCorey Bryantattach it to the bridge. The default network helper executable is 1678420508fbSAmos Kong@file{/path/to/qemu-bridge-helper} and the default bridge 1679a7c36ee4SCorey Bryantdevice is @file{br0}. 1680a7c36ee4SCorey Bryant 1681a7c36ee4SCorey BryantExamples: 1682a7c36ee4SCorey Bryant 1683a7c36ee4SCorey Bryant@example 1684a7c36ee4SCorey Bryant#launch a QEMU instance with the default network helper to 1685a7c36ee4SCorey Bryant#connect a TAP device to bridge br0 16863804da9dSStefan Weilqemu-system-i386 linux.img -net bridge -net nic,model=virtio 1687a7c36ee4SCorey Bryant@end example 1688a7c36ee4SCorey Bryant 1689a7c36ee4SCorey Bryant@example 1690a7c36ee4SCorey Bryant#launch a QEMU instance with the default network helper to 1691a7c36ee4SCorey Bryant#connect a TAP device to bridge qemubr0 16923804da9dSStefan Weilqemu-system-i386 linux.img -net bridge,br=qemubr0 -net nic,model=virtio 1693a7c36ee4SCorey Bryant@end example 1694a7c36ee4SCorey Bryant 169508d12022SStefan Hajnoczi@item -netdev socket,id=@var{id}[,fd=@var{h}][,listen=[@var{host}]:@var{port}][,connect=@var{host}:@var{port}] 16965824d651Sblueswir1@item -net socket[,vlan=@var{n}][,name=@var{name}][,fd=@var{h}] [,listen=[@var{host}]:@var{port}][,connect=@var{host}:@var{port}] 16975824d651Sblueswir1 16985824d651Sblueswir1Connect the VLAN @var{n} to a remote VLAN in another QEMU virtual 16995824d651Sblueswir1machine using a TCP socket connection. If @option{listen} is 17005824d651Sblueswir1specified, QEMU waits for incoming connections on @var{port} 17015824d651Sblueswir1(@var{host} is optional). @option{connect} is used to connect to 17025824d651Sblueswir1another QEMU instance using the @option{listen} option. @option{fd}=@var{h} 17035824d651Sblueswir1specifies an already opened TCP socket. 17045824d651Sblueswir1 17055824d651Sblueswir1Example: 17065824d651Sblueswir1@example 17075824d651Sblueswir1# launch a first QEMU instance 17083804da9dSStefan Weilqemu-system-i386 linux.img \ 17093804da9dSStefan Weil -net nic,macaddr=52:54:00:12:34:56 \ 17105824d651Sblueswir1 -net socket,listen=:1234 17115824d651Sblueswir1# connect the VLAN 0 of this instance to the VLAN 0 17125824d651Sblueswir1# of the first instance 17133804da9dSStefan Weilqemu-system-i386 linux.img \ 17143804da9dSStefan Weil -net nic,macaddr=52:54:00:12:34:57 \ 17155824d651Sblueswir1 -net socket,connect=127.0.0.1:1234 17165824d651Sblueswir1@end example 17175824d651Sblueswir1 171808d12022SStefan Hajnoczi@item -netdev socket,id=@var{id}[,fd=@var{h}][,mcast=@var{maddr}:@var{port}[,localaddr=@var{addr}]] 17193a75e74cSMike Ryan@item -net socket[,vlan=@var{n}][,name=@var{name}][,fd=@var{h}][,mcast=@var{maddr}:@var{port}[,localaddr=@var{addr}]] 17205824d651Sblueswir1 17215824d651Sblueswir1Create a VLAN @var{n} shared with another QEMU virtual 17225824d651Sblueswir1machines using a UDP multicast socket, effectively making a bus for 17235824d651Sblueswir1every QEMU with same multicast address @var{maddr} and @var{port}. 17245824d651Sblueswir1NOTES: 17255824d651Sblueswir1@enumerate 17265824d651Sblueswir1@item 17275824d651Sblueswir1Several QEMU can be running on different hosts and share same bus (assuming 17285824d651Sblueswir1correct multicast setup for these hosts). 17295824d651Sblueswir1@item 17305824d651Sblueswir1mcast support is compatible with User Mode Linux (argument @option{eth@var{N}=mcast}), see 17315824d651Sblueswir1@url{http://user-mode-linux.sf.net}. 17325824d651Sblueswir1@item 17335824d651Sblueswir1Use @option{fd=h} to specify an already opened UDP multicast socket. 17345824d651Sblueswir1@end enumerate 17355824d651Sblueswir1 17365824d651Sblueswir1Example: 17375824d651Sblueswir1@example 17385824d651Sblueswir1# launch one QEMU instance 17393804da9dSStefan Weilqemu-system-i386 linux.img \ 17403804da9dSStefan Weil -net nic,macaddr=52:54:00:12:34:56 \ 17415824d651Sblueswir1 -net socket,mcast=230.0.0.1:1234 17425824d651Sblueswir1# launch another QEMU instance on same "bus" 17433804da9dSStefan Weilqemu-system-i386 linux.img \ 17443804da9dSStefan Weil -net nic,macaddr=52:54:00:12:34:57 \ 17455824d651Sblueswir1 -net socket,mcast=230.0.0.1:1234 17465824d651Sblueswir1# launch yet another QEMU instance on same "bus" 17473804da9dSStefan Weilqemu-system-i386 linux.img \ 17483804da9dSStefan Weil -net nic,macaddr=52:54:00:12:34:58 \ 17495824d651Sblueswir1 -net socket,mcast=230.0.0.1:1234 17505824d651Sblueswir1@end example 17515824d651Sblueswir1 17525824d651Sblueswir1Example (User Mode Linux compat.): 17535824d651Sblueswir1@example 17545824d651Sblueswir1# launch QEMU instance (note mcast address selected 17555824d651Sblueswir1# is UML's default) 17563804da9dSStefan Weilqemu-system-i386 linux.img \ 17573804da9dSStefan Weil -net nic,macaddr=52:54:00:12:34:56 \ 17585824d651Sblueswir1 -net socket,mcast=239.192.168.1:1102 17595824d651Sblueswir1# launch UML 17605824d651Sblueswir1/path/to/linux ubd0=/path/to/root_fs eth0=mcast 17615824d651Sblueswir1@end example 17625824d651Sblueswir1 17633a75e74cSMike RyanExample (send packets from host's 1.2.3.4): 17643a75e74cSMike Ryan@example 17653804da9dSStefan Weilqemu-system-i386 linux.img \ 17663804da9dSStefan Weil -net nic,macaddr=52:54:00:12:34:56 \ 17673a75e74cSMike Ryan -net socket,mcast=239.192.168.1:1102,localaddr=1.2.3.4 17683a75e74cSMike Ryan@end example 17693a75e74cSMike Ryan 177008d12022SStefan Hajnoczi@item -netdev vde,id=@var{id}[,sock=@var{socketpath}][,port=@var{n}][,group=@var{groupname}][,mode=@var{octalmode}] 17715824d651Sblueswir1@item -net vde[,vlan=@var{n}][,name=@var{name}][,sock=@var{socketpath}] [,port=@var{n}][,group=@var{groupname}][,mode=@var{octalmode}] 17725824d651Sblueswir1Connect VLAN @var{n} to PORT @var{n} of a vde switch running on host and 17735824d651Sblueswir1listening for incoming connections on @var{socketpath}. Use GROUP @var{groupname} 17745824d651Sblueswir1and MODE @var{octalmode} to change default ownership and permissions for 1775c1ba4e0bSStefan Weilcommunication port. This option is only available if QEMU has been compiled 17765824d651Sblueswir1with vde support enabled. 17775824d651Sblueswir1 17785824d651Sblueswir1Example: 17795824d651Sblueswir1@example 17805824d651Sblueswir1# launch vde switch 17815824d651Sblueswir1vde_switch -F -sock /tmp/myswitch 17825824d651Sblueswir1# launch QEMU instance 17833804da9dSStefan Weilqemu-system-i386 linux.img -net nic -net vde,sock=/tmp/myswitch 17845824d651Sblueswir1@end example 17855824d651Sblueswir1 178640e8c26dSStefan Hajnoczi@item -netdev hubport,id=@var{id},hubid=@var{hubid} 178740e8c26dSStefan Hajnoczi 178840e8c26dSStefan HajnocziCreate a hub port on QEMU "vlan" @var{hubid}. 178940e8c26dSStefan Hajnoczi 179040e8c26dSStefan HajnocziThe hubport netdev lets you connect a NIC to a QEMU "vlan" instead of a single 179140e8c26dSStefan Hajnoczinetdev. @code{-net} and @code{-device} with parameter @option{vlan} create the 179240e8c26dSStefan Hajnoczirequired hub automatically. 179340e8c26dSStefan Hajnoczi 1794bb9ea79eSaliguori@item -net dump[,vlan=@var{n}][,file=@var{file}][,len=@var{len}] 1795bb9ea79eSaliguoriDump network traffic on VLAN @var{n} to file @var{file} (@file{qemu-vlan0.pcap} by default). 1796bb9ea79eSaliguoriAt most @var{len} bytes (64k by default) per packet are stored. The file format is 1797bb9ea79eSaliguorilibpcap, so it can be analyzed with tools such as tcpdump or Wireshark. 1798bb9ea79eSaliguori 17995824d651Sblueswir1@item -net none 18005824d651Sblueswir1Indicate that no network devices should be configured. It is used to 18015824d651Sblueswir1override the default configuration (@option{-net nic -net user}) which 18025824d651Sblueswir1is activated if no @option{-net} options are provided. 18035824d651Sblueswir1ETEXI 18045824d651Sblueswir1 1805c70a01e4SMarkus ArmbrusterSTEXI 1806c70a01e4SMarkus Armbruster@end table 1807c70a01e4SMarkus ArmbrusterETEXI 18087273a2dbSMatthew BoothDEFHEADING() 18097273a2dbSMatthew Booth 18107273a2dbSMatthew BoothDEFHEADING(Character device options:) 1811c70a01e4SMarkus ArmbrusterSTEXI 1812c70a01e4SMarkus Armbruster 1813c70a01e4SMarkus ArmbrusterThe general form of a character device option is: 1814c70a01e4SMarkus Armbruster@table @option 1815c70a01e4SMarkus ArmbrusterETEXI 18167273a2dbSMatthew Booth 18177273a2dbSMatthew BoothDEF("chardev", HAS_ARG, QEMU_OPTION_chardev, 181897331287SJan Kiszka "-chardev null,id=id[,mux=on|off]\n" 18197273a2dbSMatthew Booth "-chardev socket,id=id[,host=host],port=host[,to=to][,ipv4][,ipv6][,nodelay]\n" 182097331287SJan Kiszka " [,server][,nowait][,telnet][,mux=on|off] (tcp)\n" 182197331287SJan Kiszka "-chardev socket,id=id,path=path[,server][,nowait][,telnet],[mux=on|off] (unix)\n" 18227273a2dbSMatthew Booth "-chardev udp,id=id[,host=host],port=port[,localaddr=localaddr]\n" 182397331287SJan Kiszka " [,localport=localport][,ipv4][,ipv6][,mux=on|off]\n" 182497331287SJan Kiszka "-chardev msmouse,id=id[,mux=on|off]\n" 18257273a2dbSMatthew Booth "-chardev vc,id=id[[,width=width][,height=height]][[,cols=cols][,rows=rows]]\n" 182697331287SJan Kiszka " [,mux=on|off]\n" 18274f57378fSMarkus Armbruster "-chardev ringbuf,id=id[,size=size]\n" 182897331287SJan Kiszka "-chardev file,id=id,path=path[,mux=on|off]\n" 182997331287SJan Kiszka "-chardev pipe,id=id,path=path[,mux=on|off]\n" 18307273a2dbSMatthew Booth#ifdef _WIN32 183197331287SJan Kiszka "-chardev console,id=id[,mux=on|off]\n" 183297331287SJan Kiszka "-chardev serial,id=id,path=path[,mux=on|off]\n" 18337273a2dbSMatthew Booth#else 183497331287SJan Kiszka "-chardev pty,id=id[,mux=on|off]\n" 1835b7fdb3abSAurelien Jarno "-chardev stdio,id=id[,mux=on|off][,signal=on|off]\n" 18367273a2dbSMatthew Booth#endif 18377273a2dbSMatthew Booth#ifdef CONFIG_BRLAPI 183897331287SJan Kiszka "-chardev braille,id=id[,mux=on|off]\n" 18397273a2dbSMatthew Booth#endif 18407273a2dbSMatthew Booth#if defined(__linux__) || defined(__sun__) || defined(__FreeBSD__) \ 18417273a2dbSMatthew Booth || defined(__NetBSD__) || defined(__OpenBSD__) || defined(__DragonFly__) 1842d59044efSGerd Hoffmann "-chardev serial,id=id,path=path[,mux=on|off]\n" 184397331287SJan Kiszka "-chardev tty,id=id,path=path[,mux=on|off]\n" 18447273a2dbSMatthew Booth#endif 18457273a2dbSMatthew Booth#if defined(__linux__) || defined(__FreeBSD__) || defined(__DragonFly__) 184688a946d3SGerd Hoffmann "-chardev parallel,id=id,path=path[,mux=on|off]\n" 184797331287SJan Kiszka "-chardev parport,id=id,path=path[,mux=on|off]\n" 18487273a2dbSMatthew Booth#endif 1849cbcc6336SAlon Levy#if defined(CONFIG_SPICE) 1850cbcc6336SAlon Levy "-chardev spicevmc,id=id,name=name[,debug=debug]\n" 18515a49d3e9SMarc-André Lureau "-chardev spiceport,id=id,name=name[,debug=debug]\n" 1852cbcc6336SAlon Levy#endif 1853ad96090aSBlue Swirl , QEMU_ARCH_ALL 18547273a2dbSMatthew Booth) 18557273a2dbSMatthew Booth 18567273a2dbSMatthew BoothSTEXI 185797331287SJan Kiszka@item -chardev @var{backend} ,id=@var{id} [,mux=on|off] [,@var{options}] 18586616b2adSStefan Weil@findex -chardev 18597273a2dbSMatthew BoothBackend is one of: 18607273a2dbSMatthew Booth@option{null}, 18617273a2dbSMatthew Booth@option{socket}, 18627273a2dbSMatthew Booth@option{udp}, 18637273a2dbSMatthew Booth@option{msmouse}, 18647273a2dbSMatthew Booth@option{vc}, 18654f57378fSMarkus Armbruster@option{ringbuf}, 18667273a2dbSMatthew Booth@option{file}, 18677273a2dbSMatthew Booth@option{pipe}, 18687273a2dbSMatthew Booth@option{console}, 18697273a2dbSMatthew Booth@option{serial}, 18707273a2dbSMatthew Booth@option{pty}, 18717273a2dbSMatthew Booth@option{stdio}, 18727273a2dbSMatthew Booth@option{braille}, 18737273a2dbSMatthew Booth@option{tty}, 187488a946d3SGerd Hoffmann@option{parallel}, 1875cbcc6336SAlon Levy@option{parport}, 1876cbcc6336SAlon Levy@option{spicevmc}. 18775a49d3e9SMarc-André Lureau@option{spiceport}. 18787273a2dbSMatthew BoothThe specific backend will determine the applicable options. 18797273a2dbSMatthew Booth 18807273a2dbSMatthew BoothAll devices must have an id, which can be any string up to 127 characters long. 18817273a2dbSMatthew BoothIt is used to uniquely identify this device in other command line directives. 18827273a2dbSMatthew Booth 188397331287SJan KiszkaA character device may be used in multiplexing mode by multiple front-ends. 188497331287SJan KiszkaThe key sequence of @key{Control-a} and @key{c} will rotate the input focus 188597331287SJan Kiszkabetween attached front-ends. Specify @option{mux=on} to enable this mode. 188697331287SJan Kiszka 18877273a2dbSMatthew BoothOptions to each backend are described below. 18887273a2dbSMatthew Booth 18897273a2dbSMatthew Booth@item -chardev null ,id=@var{id} 18907273a2dbSMatthew BoothA void device. This device will not emit any data, and will drop any data it 18917273a2dbSMatthew Boothreceives. The null backend does not take any options. 18927273a2dbSMatthew Booth 18937273a2dbSMatthew Booth@item -chardev socket ,id=@var{id} [@var{TCP options} or @var{unix options}] [,server] [,nowait] [,telnet] 18947273a2dbSMatthew Booth 18957273a2dbSMatthew BoothCreate a two-way stream socket, which can be either a TCP or a unix socket. A 18967273a2dbSMatthew Boothunix socket will be created if @option{path} is specified. Behaviour is 18977273a2dbSMatthew Boothundefined if TCP options are specified for a unix socket. 18987273a2dbSMatthew Booth 18997273a2dbSMatthew Booth@option{server} specifies that the socket shall be a listening socket. 19007273a2dbSMatthew Booth 19017273a2dbSMatthew Booth@option{nowait} specifies that QEMU should not block waiting for a client to 19027273a2dbSMatthew Boothconnect to a listening socket. 19037273a2dbSMatthew Booth 19047273a2dbSMatthew Booth@option{telnet} specifies that traffic on the socket should interpret telnet 19057273a2dbSMatthew Boothescape sequences. 19067273a2dbSMatthew Booth 19077273a2dbSMatthew BoothTCP and unix socket options are given below: 19087273a2dbSMatthew Booth 19097273a2dbSMatthew Booth@table @option 19107273a2dbSMatthew Booth 19118d533561SAurelien Jarno@item TCP options: port=@var{port} [,host=@var{host}] [,to=@var{to}] [,ipv4] [,ipv6] [,nodelay] 19127273a2dbSMatthew Booth 19137273a2dbSMatthew Booth@option{host} for a listening socket specifies the local address to be bound. 19147273a2dbSMatthew BoothFor a connecting socket species the remote host to connect to. @option{host} is 19157273a2dbSMatthew Boothoptional for listening sockets. If not specified it defaults to @code{0.0.0.0}. 19167273a2dbSMatthew Booth 19177273a2dbSMatthew Booth@option{port} for a listening socket specifies the local port to be bound. For a 19187273a2dbSMatthew Boothconnecting socket specifies the port on the remote host to connect to. 19197273a2dbSMatthew Booth@option{port} can be given as either a port number or a service name. 19207273a2dbSMatthew Booth@option{port} is required. 19217273a2dbSMatthew Booth 19227273a2dbSMatthew Booth@option{to} is only relevant to listening sockets. If it is specified, and 19237273a2dbSMatthew Booth@option{port} cannot be bound, QEMU will attempt to bind to subsequent ports up 19247273a2dbSMatthew Boothto and including @option{to} until it succeeds. @option{to} must be specified 19257273a2dbSMatthew Boothas a port number. 19267273a2dbSMatthew Booth 19277273a2dbSMatthew Booth@option{ipv4} and @option{ipv6} specify that either IPv4 or IPv6 must be used. 19287273a2dbSMatthew BoothIf neither is specified the socket may use either protocol. 19297273a2dbSMatthew Booth 19307273a2dbSMatthew Booth@option{nodelay} disables the Nagle algorithm. 19317273a2dbSMatthew Booth 19327273a2dbSMatthew Booth@item unix options: path=@var{path} 19337273a2dbSMatthew Booth 19347273a2dbSMatthew Booth@option{path} specifies the local path of the unix socket. @option{path} is 19357273a2dbSMatthew Boothrequired. 19367273a2dbSMatthew Booth 19377273a2dbSMatthew Booth@end table 19387273a2dbSMatthew Booth 19397273a2dbSMatthew Booth@item -chardev udp ,id=@var{id} [,host=@var{host}] ,port=@var{port} [,localaddr=@var{localaddr}] [,localport=@var{localport}] [,ipv4] [,ipv6] 19407273a2dbSMatthew Booth 19417273a2dbSMatthew BoothSends all traffic from the guest to a remote host over UDP. 19427273a2dbSMatthew Booth 19437273a2dbSMatthew Booth@option{host} specifies the remote host to connect to. If not specified it 19447273a2dbSMatthew Boothdefaults to @code{localhost}. 19457273a2dbSMatthew Booth 19467273a2dbSMatthew Booth@option{port} specifies the port on the remote host to connect to. @option{port} 19477273a2dbSMatthew Boothis required. 19487273a2dbSMatthew Booth 19497273a2dbSMatthew Booth@option{localaddr} specifies the local address to bind to. If not specified it 19507273a2dbSMatthew Boothdefaults to @code{0.0.0.0}. 19517273a2dbSMatthew Booth 19527273a2dbSMatthew Booth@option{localport} specifies the local port to bind to. If not specified any 19537273a2dbSMatthew Boothavailable local port will be used. 19547273a2dbSMatthew Booth 19557273a2dbSMatthew Booth@option{ipv4} and @option{ipv6} specify that either IPv4 or IPv6 must be used. 19567273a2dbSMatthew BoothIf neither is specified the device may use either protocol. 19577273a2dbSMatthew Booth 19587273a2dbSMatthew Booth@item -chardev msmouse ,id=@var{id} 19597273a2dbSMatthew Booth 19607273a2dbSMatthew BoothForward QEMU's emulated msmouse events to the guest. @option{msmouse} does not 19617273a2dbSMatthew Boothtake any options. 19627273a2dbSMatthew Booth 19637273a2dbSMatthew Booth@item -chardev vc ,id=@var{id} [[,width=@var{width}] [,height=@var{height}]] [[,cols=@var{cols}] [,rows=@var{rows}]] 19647273a2dbSMatthew Booth 19657273a2dbSMatthew BoothConnect to a QEMU text console. @option{vc} may optionally be given a specific 19667273a2dbSMatthew Boothsize. 19677273a2dbSMatthew Booth 19687273a2dbSMatthew Booth@option{width} and @option{height} specify the width and height respectively of 19697273a2dbSMatthew Booththe console, in pixels. 19707273a2dbSMatthew Booth 19717273a2dbSMatthew Booth@option{cols} and @option{rows} specify that the console be sized to fit a text 19727273a2dbSMatthew Boothconsole with the given dimensions. 19737273a2dbSMatthew Booth 19744f57378fSMarkus Armbruster@item -chardev ringbuf ,id=@var{id} [,size=@var{size}] 197551767e7cSLei Li 19763949e594SMarkus ArmbrusterCreate a ring buffer with fixed size @option{size}. 19773949e594SMarkus Armbruster@var{size} must be a power of two, and defaults to @code{64K}). 197851767e7cSLei Li 19797273a2dbSMatthew Booth@item -chardev file ,id=@var{id} ,path=@var{path} 19807273a2dbSMatthew Booth 19817273a2dbSMatthew BoothLog all traffic received from the guest to a file. 19827273a2dbSMatthew Booth 19837273a2dbSMatthew Booth@option{path} specifies the path of the file to be opened. This file will be 19847273a2dbSMatthew Boothcreated if it does not already exist, and overwritten if it does. @option{path} 19857273a2dbSMatthew Boothis required. 19867273a2dbSMatthew Booth 19877273a2dbSMatthew Booth@item -chardev pipe ,id=@var{id} ,path=@var{path} 19887273a2dbSMatthew Booth 19897273a2dbSMatthew BoothCreate a two-way connection to the guest. The behaviour differs slightly between 19907273a2dbSMatthew BoothWindows hosts and other hosts: 19917273a2dbSMatthew Booth 19927273a2dbSMatthew BoothOn Windows, a single duplex pipe will be created at 19937273a2dbSMatthew Booth@file{\\.pipe\@option{path}}. 19947273a2dbSMatthew Booth 19957273a2dbSMatthew BoothOn other hosts, 2 pipes will be created called @file{@option{path}.in} and 19967273a2dbSMatthew Booth@file{@option{path}.out}. Data written to @file{@option{path}.in} will be 19977273a2dbSMatthew Boothreceived by the guest. Data written by the guest can be read from 19987273a2dbSMatthew Booth@file{@option{path}.out}. QEMU will not create these fifos, and requires them to 19997273a2dbSMatthew Boothbe present. 20007273a2dbSMatthew Booth 20017273a2dbSMatthew Booth@option{path} forms part of the pipe path as described above. @option{path} is 20027273a2dbSMatthew Boothrequired. 20037273a2dbSMatthew Booth 20047273a2dbSMatthew Booth@item -chardev console ,id=@var{id} 20057273a2dbSMatthew Booth 20067273a2dbSMatthew BoothSend traffic from the guest to QEMU's standard output. @option{console} does not 20077273a2dbSMatthew Boothtake any options. 20087273a2dbSMatthew Booth 20097273a2dbSMatthew Booth@option{console} is only available on Windows hosts. 20107273a2dbSMatthew Booth 20117273a2dbSMatthew Booth@item -chardev serial ,id=@var{id} ,path=@option{path} 20127273a2dbSMatthew Booth 20137273a2dbSMatthew BoothSend traffic from the guest to a serial device on the host. 20147273a2dbSMatthew Booth 2015d59044efSGerd HoffmannOn Unix hosts serial will actually accept any tty device, 2016d59044efSGerd Hoffmannnot only serial lines. 20177273a2dbSMatthew Booth 20187273a2dbSMatthew Booth@option{path} specifies the name of the serial device to open. 20197273a2dbSMatthew Booth 20207273a2dbSMatthew Booth@item -chardev pty ,id=@var{id} 20217273a2dbSMatthew Booth 20227273a2dbSMatthew BoothCreate a new pseudo-terminal on the host and connect to it. @option{pty} does 20237273a2dbSMatthew Boothnot take any options. 20247273a2dbSMatthew Booth 20257273a2dbSMatthew Booth@option{pty} is not available on Windows hosts. 20267273a2dbSMatthew Booth 2027b7fdb3abSAurelien Jarno@item -chardev stdio ,id=@var{id} [,signal=on|off] 2028b65ee4faSStefan WeilConnect to standard input and standard output of the QEMU process. 2029b7fdb3abSAurelien Jarno 2030b7fdb3abSAurelien Jarno@option{signal} controls if signals are enabled on the terminal, that includes 2031b7fdb3abSAurelien Jarnoexiting QEMU with the key sequence @key{Control-c}. This option is enabled by 2032b7fdb3abSAurelien Jarnodefault, use @option{signal=off} to disable it. 2033b7fdb3abSAurelien Jarno 2034b7fdb3abSAurelien Jarno@option{stdio} is not available on Windows hosts. 20357273a2dbSMatthew Booth 20367273a2dbSMatthew Booth@item -chardev braille ,id=@var{id} 20377273a2dbSMatthew Booth 20387273a2dbSMatthew BoothConnect to a local BrlAPI server. @option{braille} does not take any options. 20397273a2dbSMatthew Booth 20407273a2dbSMatthew Booth@item -chardev tty ,id=@var{id} ,path=@var{path} 20417273a2dbSMatthew Booth 20427273a2dbSMatthew Booth@option{tty} is only available on Linux, Sun, FreeBSD, NetBSD, OpenBSD and 2043d037d6bbSMarkus ArmbrusterDragonFlyBSD hosts. It is an alias for @option{serial}. 20447273a2dbSMatthew Booth 20457273a2dbSMatthew Booth@option{path} specifies the path to the tty. @option{path} is required. 20467273a2dbSMatthew Booth 204788a946d3SGerd Hoffmann@item -chardev parallel ,id=@var{id} ,path=@var{path} 20487273a2dbSMatthew Booth@item -chardev parport ,id=@var{id} ,path=@var{path} 20497273a2dbSMatthew Booth 205088a946d3SGerd Hoffmann@option{parallel} is only available on Linux, FreeBSD and DragonFlyBSD hosts. 20517273a2dbSMatthew Booth 20527273a2dbSMatthew BoothConnect to a local parallel port. 20537273a2dbSMatthew Booth 20547273a2dbSMatthew Booth@option{path} specifies the path to the parallel port device. @option{path} is 20557273a2dbSMatthew Boothrequired. 20567273a2dbSMatthew Booth 2057cbcc6336SAlon Levy@item -chardev spicevmc ,id=@var{id} ,debug=@var{debug}, name=@var{name} 2058cbcc6336SAlon Levy 20593a846906SStefan Hajnoczi@option{spicevmc} is only available when spice support is built in. 20603a846906SStefan Hajnoczi 2061cbcc6336SAlon Levy@option{debug} debug level for spicevmc 2062cbcc6336SAlon Levy 2063cbcc6336SAlon Levy@option{name} name of spice channel to connect to 2064cbcc6336SAlon Levy 2065cbcc6336SAlon LevyConnect to a spice virtual machine channel, such as vdiport. 2066cbcc6336SAlon Levy 20675a49d3e9SMarc-André Lureau@item -chardev spiceport ,id=@var{id} ,debug=@var{debug}, name=@var{name} 20685a49d3e9SMarc-André Lureau 20695a49d3e9SMarc-André Lureau@option{spiceport} is only available when spice support is built in. 20705a49d3e9SMarc-André Lureau 20715a49d3e9SMarc-André Lureau@option{debug} debug level for spicevmc 20725a49d3e9SMarc-André Lureau 20735a49d3e9SMarc-André Lureau@option{name} name of spice port to connect to 20745a49d3e9SMarc-André Lureau 20755a49d3e9SMarc-André LureauConnect to a spice port, allowing a Spice client to handle the traffic 20765a49d3e9SMarc-André Lureauidentified by a name (preferably a fqdn). 20777273a2dbSMatthew BoothETEXI 20787273a2dbSMatthew Booth 2079c70a01e4SMarkus ArmbrusterSTEXI 2080c70a01e4SMarkus Armbruster@end table 2081c70a01e4SMarkus ArmbrusterETEXI 20827273a2dbSMatthew BoothDEFHEADING() 20837273a2dbSMatthew Booth 20840f5314a2SRonnie SahlbergDEFHEADING(Device URL Syntax:) 2085c70a01e4SMarkus ArmbrusterSTEXI 20860f5314a2SRonnie Sahlberg 20870f5314a2SRonnie SahlbergIn addition to using normal file images for the emulated storage devices, 20880f5314a2SRonnie SahlbergQEMU can also use networked resources such as iSCSI devices. These are 20890f5314a2SRonnie Sahlbergspecified using a special URL syntax. 20900f5314a2SRonnie Sahlberg 20910f5314a2SRonnie Sahlberg@table @option 20920f5314a2SRonnie Sahlberg@item iSCSI 20930f5314a2SRonnie SahlbergiSCSI support allows QEMU to access iSCSI resources directly and use as 20940f5314a2SRonnie Sahlbergimages for the guest storage. Both disk and cdrom images are supported. 20950f5314a2SRonnie Sahlberg 20960f5314a2SRonnie SahlbergSyntax for specifying iSCSI LUNs is 20970f5314a2SRonnie Sahlberg``iscsi://<target-ip>[:<port>]/<target-iqn>/<lun>'' 20980f5314a2SRonnie Sahlberg 209931459f46SRonnie SahlbergBy default qemu will use the iSCSI initiator-name 210031459f46SRonnie Sahlberg'iqn.2008-11.org.linux-kvm[:<name>]' but this can also be set from the command 210131459f46SRonnie Sahlbergline or a configuration file. 210231459f46SRonnie Sahlberg 210331459f46SRonnie Sahlberg 21040f5314a2SRonnie SahlbergExample (without authentication): 21050f5314a2SRonnie Sahlberg@example 21063804da9dSStefan Weilqemu-system-i386 -iscsi initiator-name=iqn.2001-04.com.example:my-initiator \ 2107f9dadc98SRonnie Sahlberg -cdrom iscsi://192.0.2.1/iqn.2001-04.com.example/2 \ 2108f9dadc98SRonnie Sahlberg -drive file=iscsi://192.0.2.1/iqn.2001-04.com.example/1 21090f5314a2SRonnie Sahlberg@end example 21100f5314a2SRonnie Sahlberg 21110f5314a2SRonnie SahlbergExample (CHAP username/password via URL): 21120f5314a2SRonnie Sahlberg@example 21133804da9dSStefan Weilqemu-system-i386 -drive file=iscsi://user%password@@192.0.2.1/iqn.2001-04.com.example/1 21140f5314a2SRonnie Sahlberg@end example 21150f5314a2SRonnie Sahlberg 21160f5314a2SRonnie SahlbergExample (CHAP username/password via environment variables): 21170f5314a2SRonnie Sahlberg@example 21180f5314a2SRonnie SahlbergLIBISCSI_CHAP_USERNAME="user" \ 21190f5314a2SRonnie SahlbergLIBISCSI_CHAP_PASSWORD="password" \ 21203804da9dSStefan Weilqemu-system-i386 -drive file=iscsi://192.0.2.1/iqn.2001-04.com.example/1 21210f5314a2SRonnie Sahlberg@end example 21220f5314a2SRonnie Sahlberg 21230f5314a2SRonnie SahlbergiSCSI support is an optional feature of QEMU and only available when 21240f5314a2SRonnie Sahlbergcompiled and linked against libiscsi. 2125f9dadc98SRonnie SahlbergETEXI 2126f9dadc98SRonnie SahlbergDEF("iscsi", HAS_ARG, QEMU_OPTION_iscsi, 2127f9dadc98SRonnie Sahlberg "-iscsi [user=user][,password=password]\n" 2128f9dadc98SRonnie Sahlberg " [,header-digest=CRC32C|CR32C-NONE|NONE-CRC32C|NONE\n" 21292fe3798cSPaolo Bonzini " [,initiator-name=initiator-iqn][,id=target-iqn]\n" 2130f9dadc98SRonnie Sahlberg " iSCSI session parameters\n", QEMU_ARCH_ALL) 2131f9dadc98SRonnie SahlbergSTEXI 21320f5314a2SRonnie Sahlberg 213331459f46SRonnie SahlbergiSCSI parameters such as username and password can also be specified via 213431459f46SRonnie Sahlberga configuration file. See qemu-doc for more information and examples. 213531459f46SRonnie Sahlberg 213608ae330eSRonnie Sahlberg@item NBD 213708ae330eSRonnie SahlbergQEMU supports NBD (Network Block Devices) both using TCP protocol as well 213808ae330eSRonnie Sahlbergas Unix Domain Sockets. 213908ae330eSRonnie Sahlberg 214008ae330eSRonnie SahlbergSyntax for specifying a NBD device using TCP 214108ae330eSRonnie Sahlberg``nbd:<server-ip>:<port>[:exportname=<export>]'' 214208ae330eSRonnie Sahlberg 214308ae330eSRonnie SahlbergSyntax for specifying a NBD device using Unix Domain Sockets 214408ae330eSRonnie Sahlberg``nbd:unix:<domain-socket>[:exportname=<export>]'' 214508ae330eSRonnie Sahlberg 214608ae330eSRonnie Sahlberg 214708ae330eSRonnie SahlbergExample for TCP 214808ae330eSRonnie Sahlberg@example 21493804da9dSStefan Weilqemu-system-i386 --drive file=nbd:192.0.2.1:30000 215008ae330eSRonnie Sahlberg@end example 215108ae330eSRonnie Sahlberg 215208ae330eSRonnie SahlbergExample for Unix Domain Sockets 215308ae330eSRonnie Sahlberg@example 21543804da9dSStefan Weilqemu-system-i386 --drive file=nbd:unix:/tmp/nbd-socket 215508ae330eSRonnie Sahlberg@end example 215608ae330eSRonnie Sahlberg 21570a12ec87SRichard W.M. Jones@item SSH 21580a12ec87SRichard W.M. JonesQEMU supports SSH (Secure Shell) access to remote disks. 21590a12ec87SRichard W.M. Jones 21600a12ec87SRichard W.M. JonesExamples: 21610a12ec87SRichard W.M. Jones@example 21620a12ec87SRichard W.M. Jonesqemu-system-i386 -drive file=ssh://user@@host/path/to/disk.img 21630a12ec87SRichard W.M. Jonesqemu-system-i386 -drive file.driver=ssh,file.user=user,file.host=host,file.port=22,file.path=/path/to/disk.img 21640a12ec87SRichard W.M. Jones@end example 21650a12ec87SRichard W.M. Jones 21660a12ec87SRichard W.M. JonesCurrently authentication must be done using ssh-agent. Other 21670a12ec87SRichard W.M. Jonesauthentication methods may be supported in future. 21680a12ec87SRichard W.M. Jones 2169d9990228SRonnie Sahlberg@item Sheepdog 2170d9990228SRonnie SahlbergSheepdog is a distributed storage system for QEMU. 2171d9990228SRonnie SahlbergQEMU supports using either local sheepdog devices or remote networked 2172d9990228SRonnie Sahlbergdevices. 2173d9990228SRonnie Sahlberg 2174d9990228SRonnie SahlbergSyntax for specifying a sheepdog device 21755d6768e3SMORITA Kazutaka@example 21761b8bbb46SMORITA Kazutakasheepdog[+tcp|+unix]://[host:port]/vdiname[?socket=path][#snapid|#tag] 21775d6768e3SMORITA Kazutaka@end example 2178d9990228SRonnie Sahlberg 2179d9990228SRonnie SahlbergExample 2180d9990228SRonnie Sahlberg@example 21815d6768e3SMORITA Kazutakaqemu-system-i386 --drive file=sheepdog://192.0.2.1:30000/MyVirtualMachine 2182d9990228SRonnie Sahlberg@end example 2183d9990228SRonnie Sahlberg 2184d9990228SRonnie SahlbergSee also @url{http://http://www.osrg.net/sheepdog/}. 2185d9990228SRonnie Sahlberg 21868809e289SBharata B Rao@item GlusterFS 21878809e289SBharata B RaoGlusterFS is an user space distributed file system. 21888809e289SBharata B RaoQEMU supports the use of GlusterFS volumes for hosting VM disk images using 21898809e289SBharata B RaoTCP, Unix Domain Sockets and RDMA transport protocols. 21908809e289SBharata B Rao 21918809e289SBharata B RaoSyntax for specifying a VM disk image on GlusterFS volume is 21928809e289SBharata B Rao@example 21938809e289SBharata B Raogluster[+transport]://[server[:port]]/volname/image[?socket=...] 21948809e289SBharata B Rao@end example 21958809e289SBharata B Rao 21968809e289SBharata B Rao 21978809e289SBharata B RaoExample 21988809e289SBharata B Rao@example 2199db2d5ebaSLei Liqemu-system-x86_64 --drive file=gluster://192.0.2.1/testvol/a.img 22008809e289SBharata B Rao@end example 22018809e289SBharata B Rao 22028809e289SBharata B RaoSee also @url{http://www.gluster.org}. 22030a86cb73SMatthew Booth 22040a86cb73SMatthew Booth@item HTTP/HTTPS/FTP/FTPS/TFTP 22050a86cb73SMatthew BoothQEMU supports read-only access to files accessed over http(s), ftp(s) and tftp. 22060a86cb73SMatthew Booth 22070a86cb73SMatthew BoothSyntax using a single filename: 22080a86cb73SMatthew Booth@example 22090a86cb73SMatthew Booth<protocol>://[<username>[:<password>]@@]<host>/<path> 22100a86cb73SMatthew Booth@end example 22110a86cb73SMatthew Booth 22120a86cb73SMatthew Boothwhere: 22130a86cb73SMatthew Booth@table @option 22140a86cb73SMatthew Booth@item protocol 22150a86cb73SMatthew Booth'http', 'https', 'ftp', 'ftps', or 'tftp'. 22160a86cb73SMatthew Booth 22170a86cb73SMatthew Booth@item username 22180a86cb73SMatthew BoothOptional username for authentication to the remote server. 22190a86cb73SMatthew Booth 22200a86cb73SMatthew Booth@item password 22210a86cb73SMatthew BoothOptional password for authentication to the remote server. 22220a86cb73SMatthew Booth 22230a86cb73SMatthew Booth@item host 22240a86cb73SMatthew BoothAddress of the remote server. 22250a86cb73SMatthew Booth 22260a86cb73SMatthew Booth@item path 22270a86cb73SMatthew BoothPath on the remote server, including any query string. 22280a86cb73SMatthew Booth@end table 22290a86cb73SMatthew Booth 22300a86cb73SMatthew BoothThe following options are also supported: 22310a86cb73SMatthew Booth@table @option 22320a86cb73SMatthew Booth@item url 22330a86cb73SMatthew BoothThe full URL when passing options to the driver explicitly. 22340a86cb73SMatthew Booth 22350a86cb73SMatthew Booth@item readahead 22360a86cb73SMatthew BoothThe amount of data to read ahead with each range request to the remote server. 22370a86cb73SMatthew BoothThis value may optionally have the suffix 'T', 'G', 'M', 'K', 'k' or 'b'. If it 22380a86cb73SMatthew Boothdoes not have a suffix, it will be assumed to be in bytes. The value must be a 22390a86cb73SMatthew Boothmultiple of 512 bytes. It defaults to 256k. 22400a86cb73SMatthew Booth 22410a86cb73SMatthew Booth@item sslverify 22420a86cb73SMatthew BoothWhether to verify the remote server's certificate when connecting over SSL. It 22430a86cb73SMatthew Boothcan have the value 'on' or 'off'. It defaults to 'on'. 22440a86cb73SMatthew Booth@end table 22450a86cb73SMatthew Booth 22460a86cb73SMatthew BoothNote that when passing options to qemu explicitly, @option{driver} is the value 22470a86cb73SMatthew Boothof <protocol>. 22480a86cb73SMatthew Booth 22490a86cb73SMatthew BoothExample: boot from a remote Fedora 20 live ISO image 22500a86cb73SMatthew Booth@example 22510a86cb73SMatthew 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 22520a86cb73SMatthew Booth 22530a86cb73SMatthew 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 22540a86cb73SMatthew Booth@end example 22550a86cb73SMatthew Booth 22560a86cb73SMatthew BoothExample: boot from a remote Fedora 20 cloud image using a local overlay for 22570a86cb73SMatthew Boothwrites, copy-on-read, and a readahead of 64k 22580a86cb73SMatthew Booth@example 22590a86cb73SMatthew 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 22600a86cb73SMatthew Booth 22610a86cb73SMatthew Boothqemu-system-x86_64 -drive file=/tmp/Fedora-x86_64-20-20131211.1-sda.qcow2,copy-on-read=on 22620a86cb73SMatthew Booth@end example 22630a86cb73SMatthew Booth 22640a86cb73SMatthew BoothExample: boot from an image stored on a VMware vSphere server with a self-signed 22650a86cb73SMatthew Boothcertificate using a local overlay for writes and a readahead of 64k 22660a86cb73SMatthew Booth@example 22670a86cb73SMatthew Boothqemu-img create -f qcow2 -o backing_file='json:@{"file.driver":"https",, "file.url":"https://user:password@@vsphere.example.com/folder/test/test-flat.vmdk?dcPath=Datacenter&dsName=datastore1",, "file.sslverify":"off",, "file.readahead":"64k"@}' /tmp/test.qcow2 22680a86cb73SMatthew Booth 22690a86cb73SMatthew Boothqemu-system-x86_64 -drive file=/tmp/test.qcow2 22700a86cb73SMatthew Booth@end example 2271c70a01e4SMarkus ArmbrusterETEXI 2272c70a01e4SMarkus Armbruster 2273c70a01e4SMarkus ArmbrusterSTEXI 22740f5314a2SRonnie Sahlberg@end table 22750f5314a2SRonnie SahlbergETEXI 22760f5314a2SRonnie Sahlberg 22777273a2dbSMatthew BoothDEFHEADING(Bluetooth(R) options:) 2278c70a01e4SMarkus ArmbrusterSTEXI 2279c70a01e4SMarkus Armbruster@table @option 2280c70a01e4SMarkus ArmbrusterETEXI 22817273a2dbSMatthew Booth 22825824d651Sblueswir1DEF("bt", HAS_ARG, QEMU_OPTION_bt, \ 22835824d651Sblueswir1 "-bt hci,null dumb bluetooth HCI - doesn't respond to commands\n" \ 22845824d651Sblueswir1 "-bt hci,host[:id]\n" \ 22855824d651Sblueswir1 " use host's HCI with the given name\n" \ 22865824d651Sblueswir1 "-bt hci[,vlan=n]\n" \ 22875824d651Sblueswir1 " emulate a standard HCI in virtual scatternet 'n'\n" \ 22885824d651Sblueswir1 "-bt vhci[,vlan=n]\n" \ 22895824d651Sblueswir1 " add host computer to virtual scatternet 'n' using VHCI\n" \ 22905824d651Sblueswir1 "-bt device:dev[,vlan=n]\n" \ 2291ad96090aSBlue Swirl " emulate a bluetooth device 'dev' in scatternet 'n'\n", 2292ad96090aSBlue Swirl QEMU_ARCH_ALL) 22935824d651Sblueswir1STEXI 22945824d651Sblueswir1@item -bt hci[...] 22956616b2adSStefan Weil@findex -bt 22965824d651Sblueswir1Defines the function of the corresponding Bluetooth HCI. -bt options 22975824d651Sblueswir1are matched with the HCIs present in the chosen machine type. For 22985824d651Sblueswir1example when emulating a machine with only one HCI built into it, only 22995824d651Sblueswir1the first @code{-bt hci[...]} option is valid and defines the HCI's 23005824d651Sblueswir1logic. The Transport Layer is decided by the machine type. Currently 23015824d651Sblueswir1the machines @code{n800} and @code{n810} have one HCI and all other 23025824d651Sblueswir1machines have none. 23035824d651Sblueswir1 23045824d651Sblueswir1@anchor{bt-hcis} 23055824d651Sblueswir1The following three types are recognized: 23065824d651Sblueswir1 2307b3f046c2SKevin Wolf@table @option 23085824d651Sblueswir1@item -bt hci,null 23095824d651Sblueswir1(default) The corresponding Bluetooth HCI assumes no internal logic 23105824d651Sblueswir1and will not respond to any HCI commands or emit events. 23115824d651Sblueswir1 23125824d651Sblueswir1@item -bt hci,host[:@var{id}] 23135824d651Sblueswir1(@code{bluez} only) The corresponding HCI passes commands / events 23145824d651Sblueswir1to / from the physical HCI identified by the name @var{id} (default: 23155824d651Sblueswir1@code{hci0}) on the computer running QEMU. Only available on @code{bluez} 23165824d651Sblueswir1capable systems like Linux. 23175824d651Sblueswir1 23185824d651Sblueswir1@item -bt hci[,vlan=@var{n}] 23195824d651Sblueswir1Add a virtual, standard HCI that will participate in the Bluetooth 23205824d651Sblueswir1scatternet @var{n} (default @code{0}). Similarly to @option{-net} 23215824d651Sblueswir1VLANs, devices inside a bluetooth network @var{n} can only communicate 23225824d651Sblueswir1with other devices in the same network (scatternet). 23235824d651Sblueswir1@end table 23245824d651Sblueswir1 23255824d651Sblueswir1@item -bt vhci[,vlan=@var{n}] 23265824d651Sblueswir1(Linux-host only) Create a HCI in scatternet @var{n} (default 0) attached 23275824d651Sblueswir1to the host bluetooth stack instead of to the emulated target. This 23285824d651Sblueswir1allows the host and target machines to participate in a common scatternet 23295824d651Sblueswir1and communicate. Requires the Linux @code{vhci} driver installed. Can 23305824d651Sblueswir1be used as following: 23315824d651Sblueswir1 23325824d651Sblueswir1@example 23333804da9dSStefan Weilqemu-system-i386 [...OPTIONS...] -bt hci,vlan=5 -bt vhci,vlan=5 23345824d651Sblueswir1@end example 23355824d651Sblueswir1 23365824d651Sblueswir1@item -bt device:@var{dev}[,vlan=@var{n}] 23375824d651Sblueswir1Emulate a bluetooth device @var{dev} and place it in network @var{n} 23385824d651Sblueswir1(default @code{0}). QEMU can only emulate one type of bluetooth devices 23395824d651Sblueswir1currently: 23405824d651Sblueswir1 2341b3f046c2SKevin Wolf@table @option 23425824d651Sblueswir1@item keyboard 23435824d651Sblueswir1Virtual wireless keyboard implementing the HIDP bluetooth profile. 23445824d651Sblueswir1@end table 23455824d651Sblueswir1ETEXI 23465824d651Sblueswir1 2347c70a01e4SMarkus ArmbrusterSTEXI 2348c70a01e4SMarkus Armbruster@end table 2349c70a01e4SMarkus ArmbrusterETEXI 23505824d651Sblueswir1DEFHEADING() 23515824d651Sblueswir1 2352d1a0cf73SStefan Berger#ifdef CONFIG_TPM 2353d1a0cf73SStefan BergerDEFHEADING(TPM device options:) 2354d1a0cf73SStefan Berger 2355d1a0cf73SStefan BergerDEF("tpmdev", HAS_ARG, QEMU_OPTION_tpmdev, \ 235692dcc234SStefan Berger "-tpmdev passthrough,id=id[,path=path][,cancel-path=path]\n" 235792dcc234SStefan Berger " use path to provide path to a character device; default is /dev/tpm0\n" 235892dcc234SStefan Berger " use cancel-path to provide path to TPM's cancel sysfs entry; if\n" 235992dcc234SStefan Berger " not provided it will be searched for in /sys/class/misc/tpm?/device\n", 2360d1a0cf73SStefan Berger QEMU_ARCH_ALL) 2361d1a0cf73SStefan BergerSTEXI 2362d1a0cf73SStefan Berger 2363d1a0cf73SStefan BergerThe general form of a TPM device option is: 2364d1a0cf73SStefan Berger@table @option 2365d1a0cf73SStefan Berger 2366d1a0cf73SStefan Berger@item -tpmdev @var{backend} ,id=@var{id} [,@var{options}] 2367d1a0cf73SStefan Berger@findex -tpmdev 2368d1a0cf73SStefan BergerBackend type must be: 23694549a8b7SStefan Berger@option{passthrough}. 2370d1a0cf73SStefan Berger 2371d1a0cf73SStefan BergerThe specific backend type will determine the applicable options. 237228c4fa32SCorey BryantThe @code{-tpmdev} option creates the TPM backend and requires a 237328c4fa32SCorey Bryant@code{-device} option that specifies the TPM frontend interface model. 2374d1a0cf73SStefan Berger 2375d1a0cf73SStefan BergerOptions to each backend are described below. 2376d1a0cf73SStefan Berger 2377d1a0cf73SStefan BergerUse 'help' to print all available TPM backend types. 2378d1a0cf73SStefan Berger@example 2379d1a0cf73SStefan Bergerqemu -tpmdev help 2380d1a0cf73SStefan Berger@end example 2381d1a0cf73SStefan Berger 238292dcc234SStefan Berger@item -tpmdev passthrough, id=@var{id}, path=@var{path}, cancel-path=@var{cancel-path} 23834549a8b7SStefan Berger 23844549a8b7SStefan Berger(Linux-host only) Enable access to the host's TPM using the passthrough 23854549a8b7SStefan Bergerdriver. 23864549a8b7SStefan Berger 23874549a8b7SStefan Berger@option{path} specifies the path to the host's TPM device, i.e., on 23884549a8b7SStefan Bergera Linux host this would be @code{/dev/tpm0}. 23894549a8b7SStefan Berger@option{path} is optional and by default @code{/dev/tpm0} is used. 23904549a8b7SStefan Berger 239192dcc234SStefan Berger@option{cancel-path} specifies the path to the host TPM device's sysfs 239292dcc234SStefan Bergerentry allowing for cancellation of an ongoing TPM command. 239392dcc234SStefan Berger@option{cancel-path} is optional and by default QEMU will search for the 239492dcc234SStefan Bergersysfs entry to use. 239592dcc234SStefan Berger 23964549a8b7SStefan BergerSome notes about using the host's TPM with the passthrough driver: 23974549a8b7SStefan Berger 23984549a8b7SStefan BergerThe TPM device accessed by the passthrough driver must not be 23994549a8b7SStefan Bergerused by any other application on the host. 24004549a8b7SStefan Berger 24014549a8b7SStefan BergerSince the host's firmware (BIOS/UEFI) has already initialized the TPM, 24024549a8b7SStefan Bergerthe VM's firmware (BIOS/UEFI) will not be able to initialize the 24034549a8b7SStefan BergerTPM again and may therefore not show a TPM-specific menu that would 24044549a8b7SStefan Bergerotherwise allow the user to configure the TPM, e.g., allow the user to 24054549a8b7SStefan Bergerenable/disable or activate/deactivate the TPM. 24064549a8b7SStefan BergerFurther, if TPM ownership is released from within a VM then the host's TPM 24074549a8b7SStefan Bergerwill get disabled and deactivated. To enable and activate the 24084549a8b7SStefan BergerTPM again afterwards, the host has to be rebooted and the user is 24094549a8b7SStefan Bergerrequired to enter the firmware's menu to enable and activate the TPM. 24104549a8b7SStefan BergerIf the TPM is left disabled and/or deactivated most TPM commands will fail. 24114549a8b7SStefan Berger 24124549a8b7SStefan BergerTo create a passthrough TPM use the following two options: 24134549a8b7SStefan Berger@example 24144549a8b7SStefan Berger-tpmdev passthrough,id=tpm0 -device tpm-tis,tpmdev=tpm0 24154549a8b7SStefan Berger@end example 24164549a8b7SStefan BergerNote that the @code{-tpmdev} id is @code{tpm0} and is referenced by 24174549a8b7SStefan Berger@code{tpmdev=tpm0} in the device option. 24184549a8b7SStefan Berger 2419d1a0cf73SStefan Berger@end table 2420d1a0cf73SStefan Berger 2421d1a0cf73SStefan BergerETEXI 2422d1a0cf73SStefan Berger 2423d1a0cf73SStefan BergerDEFHEADING() 2424d1a0cf73SStefan Berger 2425d1a0cf73SStefan Berger#endif 2426d1a0cf73SStefan Berger 24277677f05dSAlexander GrafDEFHEADING(Linux/Multiboot boot specific:) 24285824d651Sblueswir1STEXI 24297677f05dSAlexander Graf 24307677f05dSAlexander GrafWhen using these options, you can use a given Linux or Multiboot 24317677f05dSAlexander Grafkernel without installing it in the disk image. It can be useful 24325824d651Sblueswir1for easier testing of various kernels. 24335824d651Sblueswir1 24345824d651Sblueswir1@table @option 24355824d651Sblueswir1ETEXI 24365824d651Sblueswir1 24375824d651Sblueswir1DEF("kernel", HAS_ARG, QEMU_OPTION_kernel, \ 2438ad96090aSBlue Swirl "-kernel bzImage use 'bzImage' as kernel image\n", QEMU_ARCH_ALL) 24395824d651Sblueswir1STEXI 24405824d651Sblueswir1@item -kernel @var{bzImage} 24416616b2adSStefan Weil@findex -kernel 24427677f05dSAlexander GrafUse @var{bzImage} as kernel image. The kernel can be either a Linux kernel 24437677f05dSAlexander Grafor in multiboot format. 24445824d651Sblueswir1ETEXI 24455824d651Sblueswir1 24465824d651Sblueswir1DEF("append", HAS_ARG, QEMU_OPTION_append, \ 2447ad96090aSBlue Swirl "-append cmdline use 'cmdline' as kernel command line\n", QEMU_ARCH_ALL) 24485824d651Sblueswir1STEXI 24495824d651Sblueswir1@item -append @var{cmdline} 24506616b2adSStefan Weil@findex -append 24515824d651Sblueswir1Use @var{cmdline} as kernel command line 24525824d651Sblueswir1ETEXI 24535824d651Sblueswir1 24545824d651Sblueswir1DEF("initrd", HAS_ARG, QEMU_OPTION_initrd, \ 2455ad96090aSBlue Swirl "-initrd file use 'file' as initial ram disk\n", QEMU_ARCH_ALL) 24565824d651Sblueswir1STEXI 24575824d651Sblueswir1@item -initrd @var{file} 24586616b2adSStefan Weil@findex -initrd 24595824d651Sblueswir1Use @var{file} as initial ram disk. 24607677f05dSAlexander Graf 24617677f05dSAlexander Graf@item -initrd "@var{file1} arg=foo,@var{file2}" 24627677f05dSAlexander Graf 24637677f05dSAlexander GrafThis syntax is only available with multiboot. 24647677f05dSAlexander Graf 24657677f05dSAlexander GrafUse @var{file1} and @var{file2} as modules and pass arg=foo as parameter to the 24667677f05dSAlexander Graffirst module. 24675824d651Sblueswir1ETEXI 24685824d651Sblueswir1 2469412beee6SGrant LikelyDEF("dtb", HAS_ARG, QEMU_OPTION_dtb, \ 2470379b5c7cSPeter A. G. Crosthwaite "-dtb file use 'file' as device tree image\n", QEMU_ARCH_ALL) 2471412beee6SGrant LikelySTEXI 2472412beee6SGrant Likely@item -dtb @var{file} 2473412beee6SGrant Likely@findex -dtb 2474412beee6SGrant LikelyUse @var{file} as a device tree binary (dtb) image and pass it to the kernel 2475412beee6SGrant Likelyon boot. 2476412beee6SGrant LikelyETEXI 2477412beee6SGrant Likely 24785824d651Sblueswir1STEXI 24795824d651Sblueswir1@end table 24805824d651Sblueswir1ETEXI 24815824d651Sblueswir1DEFHEADING() 24825824d651Sblueswir1 24835824d651Sblueswir1DEFHEADING(Debug/Expert options:) 24845824d651Sblueswir1STEXI 24855824d651Sblueswir1@table @option 24865824d651Sblueswir1ETEXI 24875824d651Sblueswir1 24885824d651Sblueswir1DEF("serial", HAS_ARG, QEMU_OPTION_serial, \ 2489ad96090aSBlue Swirl "-serial dev redirect the serial port to char device 'dev'\n", 2490ad96090aSBlue Swirl QEMU_ARCH_ALL) 24915824d651Sblueswir1STEXI 24925824d651Sblueswir1@item -serial @var{dev} 24936616b2adSStefan Weil@findex -serial 24945824d651Sblueswir1Redirect the virtual serial port to host character device 24955824d651Sblueswir1@var{dev}. The default device is @code{vc} in graphical mode and 24965824d651Sblueswir1@code{stdio} in non graphical mode. 24975824d651Sblueswir1 24985824d651Sblueswir1This option can be used several times to simulate up to 4 serial 24995824d651Sblueswir1ports. 25005824d651Sblueswir1 25015824d651Sblueswir1Use @code{-serial none} to disable all serial ports. 25025824d651Sblueswir1 25035824d651Sblueswir1Available character devices are: 2504b3f046c2SKevin Wolf@table @option 25054e257e5eSKevin Wolf@item vc[:@var{W}x@var{H}] 25065824d651Sblueswir1Virtual console. Optionally, a width and height can be given in pixel with 25075824d651Sblueswir1@example 25085824d651Sblueswir1vc:800x600 25095824d651Sblueswir1@end example 25105824d651Sblueswir1It is also possible to specify width or height in characters: 25115824d651Sblueswir1@example 25125824d651Sblueswir1vc:80Cx24C 25135824d651Sblueswir1@end example 25145824d651Sblueswir1@item pty 25155824d651Sblueswir1[Linux only] Pseudo TTY (a new PTY is automatically allocated) 25165824d651Sblueswir1@item none 25175824d651Sblueswir1No device is allocated. 25185824d651Sblueswir1@item null 25195824d651Sblueswir1void device 252088e020e5SIngo van Lil@item chardev:@var{id} 252188e020e5SIngo van LilUse a named character device defined with the @code{-chardev} option. 25225824d651Sblueswir1@item /dev/XXX 25235824d651Sblueswir1[Linux only] Use host tty, e.g. @file{/dev/ttyS0}. The host serial port 25245824d651Sblueswir1parameters are set according to the emulated ones. 25255824d651Sblueswir1@item /dev/parport@var{N} 25265824d651Sblueswir1[Linux only, parallel port only] Use host parallel port 25275824d651Sblueswir1@var{N}. Currently SPP and EPP parallel port features can be used. 25285824d651Sblueswir1@item file:@var{filename} 25295824d651Sblueswir1Write output to @var{filename}. No character can be read. 25305824d651Sblueswir1@item stdio 25315824d651Sblueswir1[Unix only] standard input/output 25325824d651Sblueswir1@item pipe:@var{filename} 25335824d651Sblueswir1name pipe @var{filename} 25345824d651Sblueswir1@item COM@var{n} 25355824d651Sblueswir1[Windows only] Use host serial port @var{n} 25365824d651Sblueswir1@item udp:[@var{remote_host}]:@var{remote_port}[@@[@var{src_ip}]:@var{src_port}] 25375824d651Sblueswir1This implements UDP Net Console. 25385824d651Sblueswir1When @var{remote_host} or @var{src_ip} are not specified 25395824d651Sblueswir1they default to @code{0.0.0.0}. 25405824d651Sblueswir1When not using a specified @var{src_port} a random port is automatically chosen. 25415824d651Sblueswir1 25425824d651Sblueswir1If you just want a simple readonly console you can use @code{netcat} or 2543b65ee4faSStefan Weil@code{nc}, by starting QEMU with: @code{-serial udp::4555} and nc as: 2544b65ee4faSStefan Weil@code{nc -u -l -p 4555}. Any time QEMU writes something to that port it 25455824d651Sblueswir1will appear in the netconsole session. 25465824d651Sblueswir1 25475824d651Sblueswir1If you plan to send characters back via netconsole or you want to stop 2548b65ee4faSStefan Weiland start QEMU a lot of times, you should have QEMU use the same 25495824d651Sblueswir1source port each time by using something like @code{-serial 2550b65ee4faSStefan Weiludp::4555@@:4556} to QEMU. Another approach is to use a patched 25515824d651Sblueswir1version of netcat which can listen to a TCP port and send and receive 25525824d651Sblueswir1characters via udp. If you have a patched version of netcat which 25535824d651Sblueswir1activates telnet remote echo and single char transfer, then you can 25545824d651Sblueswir1use the following options to step up a netcat redirector to allow 2555b65ee4faSStefan Weiltelnet on port 5555 to access the QEMU port. 25565824d651Sblueswir1@table @code 2557071c9394SStefan Weil@item QEMU Options: 25585824d651Sblueswir1-serial udp::4555@@:4556 25595824d651Sblueswir1@item netcat options: 25605824d651Sblueswir1-u -P 4555 -L 0.0.0.0:4556 -t -p 5555 -I -T 25615824d651Sblueswir1@item telnet options: 25625824d651Sblueswir1localhost 5555 25635824d651Sblueswir1@end table 25645824d651Sblueswir1 25655824d651Sblueswir1@item tcp:[@var{host}]:@var{port}[,@var{server}][,nowait][,nodelay] 25665824d651Sblueswir1The TCP Net Console has two modes of operation. It can send the serial 25675824d651Sblueswir1I/O to a location or wait for a connection from a location. By default 25685824d651Sblueswir1the TCP Net Console is sent to @var{host} at the @var{port}. If you use 25695824d651Sblueswir1the @var{server} option QEMU will wait for a client socket application 25705824d651Sblueswir1to connect to the port before continuing, unless the @code{nowait} 25715824d651Sblueswir1option was specified. The @code{nodelay} option disables the Nagle buffering 25725824d651Sblueswir1algorithm. If @var{host} is omitted, 0.0.0.0 is assumed. Only 25735824d651Sblueswir1one TCP connection at a time is accepted. You can use @code{telnet} to 25745824d651Sblueswir1connect to the corresponding character device. 25755824d651Sblueswir1@table @code 25765824d651Sblueswir1@item Example to send tcp console to 192.168.0.2 port 4444 25775824d651Sblueswir1-serial tcp:192.168.0.2:4444 25785824d651Sblueswir1@item Example to listen and wait on port 4444 for connection 25795824d651Sblueswir1-serial tcp::4444,server 25805824d651Sblueswir1@item Example to not wait and listen on ip 192.168.0.100 port 4444 25815824d651Sblueswir1-serial tcp:192.168.0.100:4444,server,nowait 25825824d651Sblueswir1@end table 25835824d651Sblueswir1 25845824d651Sblueswir1@item telnet:@var{host}:@var{port}[,server][,nowait][,nodelay] 25855824d651Sblueswir1The telnet protocol is used instead of raw tcp sockets. The options 25865824d651Sblueswir1work the same as if you had specified @code{-serial tcp}. The 25875824d651Sblueswir1difference is that the port acts like a telnet server or client using 25885824d651Sblueswir1telnet option negotiation. This will also allow you to send the 25895824d651Sblueswir1MAGIC_SYSRQ sequence if you use a telnet that supports sending the break 25905824d651Sblueswir1sequence. Typically in unix telnet you do it with Control-] and then 25915824d651Sblueswir1type "send break" followed by pressing the enter key. 25925824d651Sblueswir1 25935824d651Sblueswir1@item unix:@var{path}[,server][,nowait] 25945824d651Sblueswir1A unix domain socket is used instead of a tcp socket. The option works the 25955824d651Sblueswir1same as if you had specified @code{-serial tcp} except the unix domain socket 25965824d651Sblueswir1@var{path} is used for connections. 25975824d651Sblueswir1 25985824d651Sblueswir1@item mon:@var{dev_string} 25995824d651Sblueswir1This is a special option to allow the monitor to be multiplexed onto 26005824d651Sblueswir1another serial port. The monitor is accessed with key sequence of 260102c4bdf1SPaolo Bonzini@key{Control-a} and then pressing @key{c}. 26025824d651Sblueswir1@var{dev_string} should be any one of the serial devices specified 26035824d651Sblueswir1above. An example to multiplex the monitor onto a telnet server 26045824d651Sblueswir1listening on port 4444 would be: 26055824d651Sblueswir1@table @code 26065824d651Sblueswir1@item -serial mon:telnet::4444,server,nowait 26075824d651Sblueswir1@end table 2608be022d61SMichael TokarevWhen the monitor is multiplexed to stdio in this way, Ctrl+C will not terminate 260902c4bdf1SPaolo BonziniQEMU any more but will be passed to the guest instead. 26105824d651Sblueswir1 26115824d651Sblueswir1@item braille 26125824d651Sblueswir1Braille device. This will use BrlAPI to display the braille output on a real 26135824d651Sblueswir1or fake device. 26145824d651Sblueswir1 2615be8b28a9SKevin Wolf@item msmouse 2616be8b28a9SKevin WolfThree button serial mouse. Configure the guest to use Microsoft protocol. 26175824d651Sblueswir1@end table 26185824d651Sblueswir1ETEXI 26195824d651Sblueswir1 26205824d651Sblueswir1DEF("parallel", HAS_ARG, QEMU_OPTION_parallel, \ 2621ad96090aSBlue Swirl "-parallel dev redirect the parallel port to char device 'dev'\n", 2622ad96090aSBlue Swirl QEMU_ARCH_ALL) 26235824d651Sblueswir1STEXI 26245824d651Sblueswir1@item -parallel @var{dev} 26256616b2adSStefan Weil@findex -parallel 26265824d651Sblueswir1Redirect the virtual parallel port to host device @var{dev} (same 26275824d651Sblueswir1devices as the serial port). On Linux hosts, @file{/dev/parportN} can 26285824d651Sblueswir1be used to use hardware devices connected on the corresponding host 26295824d651Sblueswir1parallel port. 26305824d651Sblueswir1 26315824d651Sblueswir1This option can be used several times to simulate up to 3 parallel 26325824d651Sblueswir1ports. 26335824d651Sblueswir1 26345824d651Sblueswir1Use @code{-parallel none} to disable all parallel ports. 26355824d651Sblueswir1ETEXI 26365824d651Sblueswir1 26375824d651Sblueswir1DEF("monitor", HAS_ARG, QEMU_OPTION_monitor, \ 2638ad96090aSBlue Swirl "-monitor dev redirect the monitor to char device 'dev'\n", 2639ad96090aSBlue Swirl QEMU_ARCH_ALL) 26405824d651Sblueswir1STEXI 26414e307fc8SGerd Hoffmann@item -monitor @var{dev} 26426616b2adSStefan Weil@findex -monitor 26435824d651Sblueswir1Redirect the monitor to host device @var{dev} (same devices as the 26445824d651Sblueswir1serial port). 26455824d651Sblueswir1The default device is @code{vc} in graphical mode and @code{stdio} in 26465824d651Sblueswir1non graphical mode. 264770e098afSLuiz CapitulinoUse @code{-monitor none} to disable the default monitor. 26485824d651Sblueswir1ETEXI 26496ca5582dSGerd HoffmannDEF("qmp", HAS_ARG, QEMU_OPTION_qmp, \ 2650ad96090aSBlue Swirl "-qmp dev like -monitor but opens in 'control' mode\n", 2651ad96090aSBlue Swirl QEMU_ARCH_ALL) 265295d5f08bSStefan WeilSTEXI 265395d5f08bSStefan Weil@item -qmp @var{dev} 26546616b2adSStefan Weil@findex -qmp 265595d5f08bSStefan WeilLike -monitor but opens in 'control' mode. 265695d5f08bSStefan WeilETEXI 26575824d651Sblueswir1 265822a0e04bSGerd HoffmannDEF("mon", HAS_ARG, QEMU_OPTION_mon, \ 2659f17e4eaaSMichael Tokarev "-mon [chardev=]name[,mode=readline|control][,default]\n", QEMU_ARCH_ALL) 266022a0e04bSGerd HoffmannSTEXI 2661f17e4eaaSMichael Tokarev@item -mon [chardev=]name[,mode=readline|control][,default] 26626616b2adSStefan Weil@findex -mon 266322a0e04bSGerd HoffmannSetup monitor on chardev @var{name}. 266422a0e04bSGerd HoffmannETEXI 266522a0e04bSGerd Hoffmann 2666c9f398e5SH. Peter AnvinDEF("debugcon", HAS_ARG, QEMU_OPTION_debugcon, \ 2667ad96090aSBlue Swirl "-debugcon dev redirect the debug console to char device 'dev'\n", 2668ad96090aSBlue Swirl QEMU_ARCH_ALL) 2669c9f398e5SH. Peter AnvinSTEXI 2670c9f398e5SH. Peter Anvin@item -debugcon @var{dev} 26716616b2adSStefan Weil@findex -debugcon 2672c9f398e5SH. Peter AnvinRedirect the debug console to host device @var{dev} (same devices as the 2673c9f398e5SH. Peter Anvinserial port). The debug console is an I/O port which is typically port 2674c9f398e5SH. Peter Anvin0xe9; writing to that I/O port sends output to this device. 2675c9f398e5SH. Peter AnvinThe default device is @code{vc} in graphical mode and @code{stdio} in 2676c9f398e5SH. Peter Anvinnon graphical mode. 2677c9f398e5SH. Peter AnvinETEXI 2678c9f398e5SH. Peter Anvin 26795824d651Sblueswir1DEF("pidfile", HAS_ARG, QEMU_OPTION_pidfile, \ 2680ad96090aSBlue Swirl "-pidfile file write PID to 'file'\n", QEMU_ARCH_ALL) 26815824d651Sblueswir1STEXI 26825824d651Sblueswir1@item -pidfile @var{file} 26836616b2adSStefan Weil@findex -pidfile 26845824d651Sblueswir1Store the QEMU process PID in @var{file}. It is useful if you launch QEMU 26855824d651Sblueswir1from a script. 26865824d651Sblueswir1ETEXI 26875824d651Sblueswir1 26881b530a6dSaurel32DEF("singlestep", 0, QEMU_OPTION_singlestep, \ 2689ad96090aSBlue Swirl "-singlestep always run in singlestep mode\n", QEMU_ARCH_ALL) 26901b530a6dSaurel32STEXI 26911b530a6dSaurel32@item -singlestep 26926616b2adSStefan Weil@findex -singlestep 26931b530a6dSaurel32Run the emulation in single step mode. 26941b530a6dSaurel32ETEXI 26951b530a6dSaurel32 26965824d651Sblueswir1DEF("S", 0, QEMU_OPTION_S, \ 2697ad96090aSBlue Swirl "-S freeze CPU at startup (use 'c' to start execution)\n", 2698ad96090aSBlue Swirl QEMU_ARCH_ALL) 26995824d651Sblueswir1STEXI 27005824d651Sblueswir1@item -S 27016616b2adSStefan Weil@findex -S 27025824d651Sblueswir1Do not start CPU at startup (you must type 'c' in the monitor). 27035824d651Sblueswir1ETEXI 27045824d651Sblueswir1 2705888a6bc6SSatoru MoriyaDEF("realtime", HAS_ARG, QEMU_OPTION_realtime, 2706888a6bc6SSatoru Moriya "-realtime [mlock=on|off]\n" 2707888a6bc6SSatoru Moriya " run qemu with realtime features\n" 2708888a6bc6SSatoru Moriya " mlock=on|off controls mlock support (default: on)\n", 2709888a6bc6SSatoru Moriya QEMU_ARCH_ALL) 2710888a6bc6SSatoru MoriyaSTEXI 2711888a6bc6SSatoru Moriya@item -realtime mlock=on|off 2712888a6bc6SSatoru Moriya@findex -realtime 2713888a6bc6SSatoru MoriyaRun qemu with realtime features. 2714888a6bc6SSatoru Moriyamlocking qemu and guest memory can be enabled via @option{mlock=on} 2715888a6bc6SSatoru Moriya(enabled by default). 2716888a6bc6SSatoru MoriyaETEXI 2717888a6bc6SSatoru Moriya 271859030a8cSaliguoriDEF("gdb", HAS_ARG, QEMU_OPTION_gdb, \ 2719ad96090aSBlue Swirl "-gdb dev wait for gdb connection on 'dev'\n", QEMU_ARCH_ALL) 27205824d651Sblueswir1STEXI 272159030a8cSaliguori@item -gdb @var{dev} 27226616b2adSStefan Weil@findex -gdb 272359030a8cSaliguoriWait for gdb connection on device @var{dev} (@pxref{gdb_usage}). Typical 272459030a8cSaliguoriconnections will likely be TCP-based, but also UDP, pseudo TTY, or even 2725b65ee4faSStefan Weilstdio are reasonable use case. The latter is allowing to start QEMU from 272659030a8cSaliguoriwithin gdb and establish the connection via a pipe: 272759030a8cSaliguori@example 27283804da9dSStefan Weil(gdb) target remote | exec qemu-system-i386 -gdb stdio ... 272959030a8cSaliguori@end example 27305824d651Sblueswir1ETEXI 27315824d651Sblueswir1 273259030a8cSaliguoriDEF("s", 0, QEMU_OPTION_s, \ 2733ad96090aSBlue Swirl "-s shorthand for -gdb tcp::" DEFAULT_GDBSTUB_PORT "\n", 2734ad96090aSBlue Swirl QEMU_ARCH_ALL) 27355824d651Sblueswir1STEXI 273659030a8cSaliguori@item -s 27376616b2adSStefan Weil@findex -s 273859030a8cSaliguoriShorthand for -gdb tcp::1234, i.e. open a gdbserver on TCP port 1234 273959030a8cSaliguori(@pxref{gdb_usage}). 27405824d651Sblueswir1ETEXI 27415824d651Sblueswir1 27425824d651Sblueswir1DEF("d", HAS_ARG, QEMU_OPTION_d, \ 2743989b697dSPeter Maydell "-d item1,... enable logging of specified items (use '-d help' for a list of log items)\n", 2744ad96090aSBlue Swirl QEMU_ARCH_ALL) 27455824d651Sblueswir1STEXI 2746989b697dSPeter Maydell@item -d @var{item1}[,...] 27476616b2adSStefan Weil@findex -d 2748989b697dSPeter MaydellEnable logging of specified items. Use '-d help' for a list of log items. 27495824d651Sblueswir1ETEXI 27505824d651Sblueswir1 2751c235d738SMatthew FernandezDEF("D", HAS_ARG, QEMU_OPTION_D, \ 2752989b697dSPeter Maydell "-D logfile output log to logfile (default stderr)\n", 2753c235d738SMatthew Fernandez QEMU_ARCH_ALL) 2754c235d738SMatthew FernandezSTEXI 27558bd383b4SStefan Weil@item -D @var{logfile} 2756c235d738SMatthew Fernandez@findex -D 2757989b697dSPeter MaydellOutput log in @var{logfile} instead of to stderr 2758c235d738SMatthew FernandezETEXI 2759c235d738SMatthew Fernandez 27605824d651Sblueswir1DEF("L", HAS_ARG, QEMU_OPTION_L, \ 2761ad96090aSBlue Swirl "-L path set the directory for the BIOS, VGA BIOS and keymaps\n", 2762ad96090aSBlue Swirl QEMU_ARCH_ALL) 27635824d651Sblueswir1STEXI 27645824d651Sblueswir1@item -L @var{path} 27656616b2adSStefan Weil@findex -L 27665824d651Sblueswir1Set the directory for the BIOS, VGA BIOS and keymaps. 27675824d651Sblueswir1ETEXI 27685824d651Sblueswir1 27695824d651Sblueswir1DEF("bios", HAS_ARG, QEMU_OPTION_bios, \ 2770ad96090aSBlue Swirl "-bios file set the filename for the BIOS\n", QEMU_ARCH_ALL) 27715824d651Sblueswir1STEXI 27725824d651Sblueswir1@item -bios @var{file} 27736616b2adSStefan Weil@findex -bios 27745824d651Sblueswir1Set the filename for the BIOS. 27755824d651Sblueswir1ETEXI 27765824d651Sblueswir1 27775824d651Sblueswir1DEF("enable-kvm", 0, QEMU_OPTION_enable_kvm, \ 2778ad96090aSBlue Swirl "-enable-kvm enable KVM full virtualization support\n", QEMU_ARCH_ALL) 27795824d651Sblueswir1STEXI 27805824d651Sblueswir1@item -enable-kvm 27816616b2adSStefan Weil@findex -enable-kvm 27825824d651Sblueswir1Enable KVM full virtualization support. This option is only available 27835824d651Sblueswir1if KVM support is enabled when compiling. 27845824d651Sblueswir1ETEXI 27855824d651Sblueswir1 2786e37630caSaliguoriDEF("xen-domid", HAS_ARG, QEMU_OPTION_xen_domid, 2787ad96090aSBlue Swirl "-xen-domid id specify xen guest domain id\n", QEMU_ARCH_ALL) 2788e37630caSaliguoriDEF("xen-create", 0, QEMU_OPTION_xen_create, 2789e37630caSaliguori "-xen-create create domain using xen hypercalls, bypassing xend\n" 2790ad96090aSBlue Swirl " warning: should not be used when xend is in use\n", 2791ad96090aSBlue Swirl QEMU_ARCH_ALL) 2792e37630caSaliguoriDEF("xen-attach", 0, QEMU_OPTION_xen_attach, 2793e37630caSaliguori "-xen-attach attach to existing xen domain\n" 2794b65ee4faSStefan Weil " xend will use this when starting QEMU\n", 2795ad96090aSBlue Swirl QEMU_ARCH_ALL) 279695d5f08bSStefan WeilSTEXI 279795d5f08bSStefan Weil@item -xen-domid @var{id} 27986616b2adSStefan Weil@findex -xen-domid 279995d5f08bSStefan WeilSpecify xen guest domain @var{id} (XEN only). 280095d5f08bSStefan Weil@item -xen-create 28016616b2adSStefan Weil@findex -xen-create 280295d5f08bSStefan WeilCreate domain using xen hypercalls, bypassing xend. 280395d5f08bSStefan WeilWarning: should not be used when xend is in use (XEN only). 280495d5f08bSStefan Weil@item -xen-attach 28056616b2adSStefan Weil@findex -xen-attach 280695d5f08bSStefan WeilAttach to existing xen domain. 2807b65ee4faSStefan Weilxend will use this when starting QEMU (XEN only). 280895d5f08bSStefan WeilETEXI 2809e37630caSaliguori 28105824d651Sblueswir1DEF("no-reboot", 0, QEMU_OPTION_no_reboot, \ 2811ad96090aSBlue Swirl "-no-reboot exit instead of rebooting\n", QEMU_ARCH_ALL) 28125824d651Sblueswir1STEXI 28135824d651Sblueswir1@item -no-reboot 28146616b2adSStefan Weil@findex -no-reboot 28155824d651Sblueswir1Exit instead of rebooting. 28165824d651Sblueswir1ETEXI 28175824d651Sblueswir1 28185824d651Sblueswir1DEF("no-shutdown", 0, QEMU_OPTION_no_shutdown, \ 2819ad96090aSBlue Swirl "-no-shutdown stop before shutdown\n", QEMU_ARCH_ALL) 28205824d651Sblueswir1STEXI 28215824d651Sblueswir1@item -no-shutdown 28226616b2adSStefan Weil@findex -no-shutdown 28235824d651Sblueswir1Don't exit QEMU on guest shutdown, but instead only stop the emulation. 28245824d651Sblueswir1This allows for instance switching to monitor to commit changes to the 28255824d651Sblueswir1disk image. 28265824d651Sblueswir1ETEXI 28275824d651Sblueswir1 28285824d651Sblueswir1DEF("loadvm", HAS_ARG, QEMU_OPTION_loadvm, \ 28295824d651Sblueswir1 "-loadvm [tag|id]\n" \ 2830ad96090aSBlue Swirl " start right away with a saved state (loadvm in monitor)\n", 2831ad96090aSBlue Swirl QEMU_ARCH_ALL) 28325824d651Sblueswir1STEXI 28335824d651Sblueswir1@item -loadvm @var{file} 28346616b2adSStefan Weil@findex -loadvm 28355824d651Sblueswir1Start right away with a saved state (@code{loadvm} in monitor) 28365824d651Sblueswir1ETEXI 28375824d651Sblueswir1 28385824d651Sblueswir1#ifndef _WIN32 28395824d651Sblueswir1DEF("daemonize", 0, QEMU_OPTION_daemonize, \ 2840ad96090aSBlue Swirl "-daemonize daemonize QEMU after initializing\n", QEMU_ARCH_ALL) 28415824d651Sblueswir1#endif 28425824d651Sblueswir1STEXI 28435824d651Sblueswir1@item -daemonize 28446616b2adSStefan Weil@findex -daemonize 28455824d651Sblueswir1Daemonize the QEMU process after initialization. QEMU will not detach from 28465824d651Sblueswir1standard IO until it is ready to receive connections on any of its devices. 28475824d651Sblueswir1This option is a useful way for external programs to launch QEMU without having 28485824d651Sblueswir1to cope with initialization race conditions. 28495824d651Sblueswir1ETEXI 28505824d651Sblueswir1 28515824d651Sblueswir1DEF("option-rom", HAS_ARG, QEMU_OPTION_option_rom, \ 2852ad96090aSBlue Swirl "-option-rom rom load a file, rom, into the option ROM space\n", 2853ad96090aSBlue Swirl QEMU_ARCH_ALL) 28545824d651Sblueswir1STEXI 28555824d651Sblueswir1@item -option-rom @var{file} 28566616b2adSStefan Weil@findex -option-rom 28575824d651Sblueswir1Load the contents of @var{file} as an option ROM. 28585824d651Sblueswir1This option is useful to load things like EtherBoot. 28595824d651Sblueswir1ETEXI 28605824d651Sblueswir1 28615824d651Sblueswir1DEF("clock", HAS_ARG, QEMU_OPTION_clock, \ 28625824d651Sblueswir1 "-clock force the use of the given methods for timer alarm.\n" \ 2863585f6036SPeter Maydell " To see what timers are available use '-clock help'\n", 2864ad96090aSBlue Swirl QEMU_ARCH_ALL) 28655824d651Sblueswir1STEXI 28665824d651Sblueswir1@item -clock @var{method} 28676616b2adSStefan Weil@findex -clock 28685824d651Sblueswir1Force the use of the given methods for timer alarm. To see what timers 2869585f6036SPeter Maydellare available use @code{-clock help}. 28705824d651Sblueswir1ETEXI 28715824d651Sblueswir1 28721ed2fc1fSJan KiszkaHXCOMM Options deprecated by -rtc 2873ad96090aSBlue SwirlDEF("localtime", 0, QEMU_OPTION_localtime, "", QEMU_ARCH_ALL) 2874ad96090aSBlue SwirlDEF("startdate", HAS_ARG, QEMU_OPTION_startdate, "", QEMU_ARCH_ALL) 28755824d651Sblueswir1 28761ed2fc1fSJan KiszkaDEF("rtc", HAS_ARG, QEMU_OPTION_rtc, \ 287778808141SPaolo Bonzini "-rtc [base=utc|localtime|date][,clock=host|rt|vm][,driftfix=none|slew]\n" \ 2878ad96090aSBlue Swirl " set the RTC base and clock, enable drift fix for clock ticks (x86 only)\n", 2879ad96090aSBlue Swirl QEMU_ARCH_ALL) 28801ed2fc1fSJan Kiszka 28815824d651Sblueswir1STEXI 28825824d651Sblueswir1 28836875204cSJan Kiszka@item -rtc [base=utc|localtime|@var{date}][,clock=host|vm][,driftfix=none|slew] 28846616b2adSStefan Weil@findex -rtc 28851ed2fc1fSJan KiszkaSpecify @option{base} as @code{utc} or @code{localtime} to let the RTC start at the current 28861ed2fc1fSJan KiszkaUTC or local time, respectively. @code{localtime} is required for correct date in 28871ed2fc1fSJan KiszkaMS-DOS or Windows. To start at a specific point in time, provide @var{date} in the 28881ed2fc1fSJan Kiszkaformat @code{2006-06-17T16:01:21} or @code{2006-06-17}. The default base is UTC. 28891ed2fc1fSJan Kiszka 28909d85d557SMichael TokarevBy default the RTC is driven by the host system time. This allows using of the 28916875204cSJan KiszkaRTC as accurate reference clock inside the guest, specifically if the host 28926875204cSJan Kiszkatime is smoothly following an accurate external reference clock, e.g. via NTP. 289378808141SPaolo BonziniIf you want to isolate the guest time from the host, you can set @option{clock} 289478808141SPaolo Bonzinito @code{rt} instead. To even prevent it from progressing during suspension, 289578808141SPaolo Bonziniyou can set it to @code{vm}. 28966875204cSJan Kiszka 28971ed2fc1fSJan KiszkaEnable @option{driftfix} (i386 targets only) if you experience time drift problems, 28981ed2fc1fSJan Kiszkaspecifically with Windows' ACPI HAL. This option will try to figure out how 28991ed2fc1fSJan Kiszkamany timer interrupts were not processed by the Windows guest and will 29001ed2fc1fSJan Kiszkare-inject them. 29015824d651Sblueswir1ETEXI 29025824d651Sblueswir1 29035824d651Sblueswir1DEF("icount", HAS_ARG, QEMU_OPTION_icount, \ 29045824d651Sblueswir1 "-icount [N|auto]\n" \ 2905bc14ca24Saliguori " enable virtual instruction counter with 2^N clock ticks per\n" \ 2906ad96090aSBlue Swirl " instruction\n", QEMU_ARCH_ALL) 29075824d651Sblueswir1STEXI 29084e257e5eSKevin Wolf@item -icount [@var{N}|auto] 29096616b2adSStefan Weil@findex -icount 29105824d651Sblueswir1Enable virtual instruction counter. The virtual cpu will execute one 29114e257e5eSKevin Wolfinstruction every 2^@var{N} ns of virtual time. If @code{auto} is specified 29125824d651Sblueswir1then the virtual cpu speed will be automatically adjusted to keep virtual 29135824d651Sblueswir1time within a few seconds of real time. 29145824d651Sblueswir1 29155824d651Sblueswir1Note that while this option can give deterministic behavior, it does not 29165824d651Sblueswir1provide cycle accurate emulation. Modern CPUs contain superscalar out of 29175824d651Sblueswir1order cores with complex cache hierarchies. The number of instructions 29185824d651Sblueswir1executed often has little or no correlation with actual performance. 29195824d651Sblueswir1ETEXI 29205824d651Sblueswir1 29219dd986ccSRichard W.M. JonesDEF("watchdog", HAS_ARG, QEMU_OPTION_watchdog, \ 29229dd986ccSRichard W.M. Jones "-watchdog i6300esb|ib700\n" \ 2923ad96090aSBlue Swirl " enable virtual hardware watchdog [default=none]\n", 2924ad96090aSBlue Swirl QEMU_ARCH_ALL) 29259dd986ccSRichard W.M. JonesSTEXI 29269dd986ccSRichard W.M. Jones@item -watchdog @var{model} 29276616b2adSStefan Weil@findex -watchdog 29289dd986ccSRichard W.M. JonesCreate a virtual hardware watchdog device. Once enabled (by a guest 29299dd986ccSRichard W.M. Jonesaction), the watchdog must be periodically polled by an agent inside 29309dd986ccSRichard W.M. Jonesthe guest or else the guest will be restarted. 29319dd986ccSRichard W.M. Jones 29329dd986ccSRichard W.M. JonesThe @var{model} is the model of hardware watchdog to emulate. Choices 29339dd986ccSRichard W.M. Jonesfor model are: @code{ib700} (iBASE 700) which is a very simple ISA 29349dd986ccSRichard W.M. Joneswatchdog with a single timer, or @code{i6300esb} (Intel 6300ESB I/O 29359dd986ccSRichard W.M. Jonescontroller hub) which is a much more featureful PCI-based dual-timer 29369dd986ccSRichard W.M. Joneswatchdog. Choose a model for which your guest has drivers. 29379dd986ccSRichard W.M. Jones 2938585f6036SPeter MaydellUse @code{-watchdog help} to list available hardware models. Only one 29399dd986ccSRichard W.M. Joneswatchdog can be enabled for a guest. 29409dd986ccSRichard W.M. JonesETEXI 29419dd986ccSRichard W.M. Jones 29429dd986ccSRichard W.M. JonesDEF("watchdog-action", HAS_ARG, QEMU_OPTION_watchdog_action, \ 29439dd986ccSRichard W.M. Jones "-watchdog-action reset|shutdown|poweroff|pause|debug|none\n" \ 2944ad96090aSBlue Swirl " action when watchdog fires [default=reset]\n", 2945ad96090aSBlue Swirl QEMU_ARCH_ALL) 29469dd986ccSRichard W.M. JonesSTEXI 29479dd986ccSRichard W.M. Jones@item -watchdog-action @var{action} 2948b8f490ebSMarkus Armbruster@findex -watchdog-action 29499dd986ccSRichard W.M. Jones 29509dd986ccSRichard W.M. JonesThe @var{action} controls what QEMU will do when the watchdog timer 29519dd986ccSRichard W.M. Jonesexpires. 29529dd986ccSRichard W.M. JonesThe default is 29539dd986ccSRichard W.M. Jones@code{reset} (forcefully reset the guest). 29549dd986ccSRichard W.M. JonesOther possible actions are: 29559dd986ccSRichard W.M. Jones@code{shutdown} (attempt to gracefully shutdown the guest), 29569dd986ccSRichard W.M. Jones@code{poweroff} (forcefully poweroff the guest), 29579dd986ccSRichard W.M. Jones@code{pause} (pause the guest), 29589dd986ccSRichard W.M. Jones@code{debug} (print a debug message and continue), or 29599dd986ccSRichard W.M. Jones@code{none} (do nothing). 29609dd986ccSRichard W.M. Jones 29619dd986ccSRichard W.M. JonesNote that the @code{shutdown} action requires that the guest responds 29629dd986ccSRichard W.M. Jonesto ACPI signals, which it may not be able to do in the sort of 29639dd986ccSRichard W.M. Jonessituations where the watchdog would have expired, and thus 29649dd986ccSRichard W.M. Jones@code{-watchdog-action shutdown} is not recommended for production use. 29659dd986ccSRichard W.M. Jones 29669dd986ccSRichard W.M. JonesExamples: 29679dd986ccSRichard W.M. Jones 29689dd986ccSRichard W.M. Jones@table @code 29699dd986ccSRichard W.M. Jones@item -watchdog i6300esb -watchdog-action pause 29709dd986ccSRichard W.M. Jones@item -watchdog ib700 29719dd986ccSRichard W.M. Jones@end table 29729dd986ccSRichard W.M. JonesETEXI 29739dd986ccSRichard W.M. Jones 29745824d651Sblueswir1DEF("echr", HAS_ARG, QEMU_OPTION_echr, \ 2975ad96090aSBlue Swirl "-echr chr set terminal escape character instead of ctrl-a\n", 2976ad96090aSBlue Swirl QEMU_ARCH_ALL) 29775824d651Sblueswir1STEXI 29785824d651Sblueswir1 29794e257e5eSKevin Wolf@item -echr @var{numeric_ascii_value} 29806616b2adSStefan Weil@findex -echr 29815824d651Sblueswir1Change the escape character used for switching to the monitor when using 29825824d651Sblueswir1monitor and serial sharing. The default is @code{0x01} when using the 29835824d651Sblueswir1@code{-nographic} option. @code{0x01} is equal to pressing 29845824d651Sblueswir1@code{Control-a}. You can select a different character from the ascii 29855824d651Sblueswir1control keys where 1 through 26 map to Control-a through Control-z. For 29865824d651Sblueswir1instance you could use the either of the following to change the escape 29875824d651Sblueswir1character to Control-t. 29885824d651Sblueswir1@table @code 29895824d651Sblueswir1@item -echr 0x14 29905824d651Sblueswir1@item -echr 20 29915824d651Sblueswir1@end table 29925824d651Sblueswir1ETEXI 29935824d651Sblueswir1 29945824d651Sblueswir1DEF("virtioconsole", HAS_ARG, QEMU_OPTION_virtiocon, \ 29955824d651Sblueswir1 "-virtioconsole c\n" \ 2996ad96090aSBlue Swirl " set virtio console\n", QEMU_ARCH_ALL) 29975824d651Sblueswir1STEXI 29985824d651Sblueswir1@item -virtioconsole @var{c} 29996616b2adSStefan Weil@findex -virtioconsole 30005824d651Sblueswir1Set virtio console. 300198b19252SAmit Shah 300298b19252SAmit ShahThis option is maintained for backward compatibility. 300398b19252SAmit Shah 300498b19252SAmit ShahPlease use @code{-device virtconsole} for the new way of invocation. 30055824d651Sblueswir1ETEXI 30065824d651Sblueswir1 30075824d651Sblueswir1DEF("show-cursor", 0, QEMU_OPTION_show_cursor, \ 3008ad96090aSBlue Swirl "-show-cursor show cursor\n", QEMU_ARCH_ALL) 30095824d651Sblueswir1STEXI 301095d5f08bSStefan Weil@item -show-cursor 30116616b2adSStefan Weil@findex -show-cursor 301295d5f08bSStefan WeilShow cursor. 30135824d651Sblueswir1ETEXI 30145824d651Sblueswir1 30155824d651Sblueswir1DEF("tb-size", HAS_ARG, QEMU_OPTION_tb_size, \ 3016ad96090aSBlue Swirl "-tb-size n set TB size\n", QEMU_ARCH_ALL) 30175824d651Sblueswir1STEXI 301895d5f08bSStefan Weil@item -tb-size @var{n} 30196616b2adSStefan Weil@findex -tb-size 302095d5f08bSStefan WeilSet TB size. 30215824d651Sblueswir1ETEXI 30225824d651Sblueswir1 30235824d651Sblueswir1DEF("incoming", HAS_ARG, QEMU_OPTION_incoming, \ 3024ad96090aSBlue Swirl "-incoming p prepare for incoming migration, listen on port p\n", 3025ad96090aSBlue Swirl QEMU_ARCH_ALL) 30265824d651Sblueswir1STEXI 302795d5f08bSStefan Weil@item -incoming @var{port} 30286616b2adSStefan Weil@findex -incoming 302995d5f08bSStefan WeilPrepare for incoming migration, listen on @var{port}. 30305824d651Sblueswir1ETEXI 30315824d651Sblueswir1 3032d8c208ddSGerd HoffmannDEF("nodefaults", 0, QEMU_OPTION_nodefaults, \ 3033ad96090aSBlue Swirl "-nodefaults don't create default devices\n", QEMU_ARCH_ALL) 3034d8c208ddSGerd HoffmannSTEXI 30353dbf2c7fSStefan Weil@item -nodefaults 30366616b2adSStefan Weil@findex -nodefaults 303766c19bf1SMichal NovotnyDon't create default devices. Normally, QEMU sets the default devices like serial 303866c19bf1SMichal Novotnyport, parallel port, virtual console, monitor device, VGA adapter, floppy and 303966c19bf1SMichal NovotnyCD-ROM drive and others. The @code{-nodefaults} option will disable all those 304066c19bf1SMichal Novotnydefault devices. 3041d8c208ddSGerd HoffmannETEXI 3042d8c208ddSGerd Hoffmann 30435824d651Sblueswir1#ifndef _WIN32 30445824d651Sblueswir1DEF("chroot", HAS_ARG, QEMU_OPTION_chroot, \ 3045ad96090aSBlue Swirl "-chroot dir chroot to dir just before starting the VM\n", 3046ad96090aSBlue Swirl QEMU_ARCH_ALL) 30475824d651Sblueswir1#endif 30485824d651Sblueswir1STEXI 30494e257e5eSKevin Wolf@item -chroot @var{dir} 30506616b2adSStefan Weil@findex -chroot 30515824d651Sblueswir1Immediately before starting guest execution, chroot to the specified 30525824d651Sblueswir1directory. Especially useful in combination with -runas. 30535824d651Sblueswir1ETEXI 30545824d651Sblueswir1 30555824d651Sblueswir1#ifndef _WIN32 30565824d651Sblueswir1DEF("runas", HAS_ARG, QEMU_OPTION_runas, \ 3057ad96090aSBlue Swirl "-runas user change to user id user just before starting the VM\n", 3058ad96090aSBlue Swirl QEMU_ARCH_ALL) 30595824d651Sblueswir1#endif 30605824d651Sblueswir1STEXI 30614e257e5eSKevin Wolf@item -runas @var{user} 30626616b2adSStefan Weil@findex -runas 30635824d651Sblueswir1Immediately before starting guest execution, drop root privileges, switching 30645824d651Sblueswir1to the specified user. 30655824d651Sblueswir1ETEXI 30665824d651Sblueswir1 30675824d651Sblueswir1DEF("prom-env", HAS_ARG, QEMU_OPTION_prom_env, 30685824d651Sblueswir1 "-prom-env variable=value\n" 3069ad96090aSBlue Swirl " set OpenBIOS nvram variables\n", 3070ad96090aSBlue Swirl QEMU_ARCH_PPC | QEMU_ARCH_SPARC) 307195d5f08bSStefan WeilSTEXI 307295d5f08bSStefan Weil@item -prom-env @var{variable}=@var{value} 30736616b2adSStefan Weil@findex -prom-env 307495d5f08bSStefan WeilSet OpenBIOS nvram @var{variable} to given @var{value} (PPC, SPARC only). 307595d5f08bSStefan WeilETEXI 30765824d651Sblueswir1DEF("semihosting", 0, QEMU_OPTION_semihosting, 3077f7bbcfb5SMichael Walle "-semihosting semihosting mode\n", 3078f7bbcfb5SMichael Walle QEMU_ARCH_ARM | QEMU_ARCH_M68K | QEMU_ARCH_XTENSA | QEMU_ARCH_LM32) 307995d5f08bSStefan WeilSTEXI 308095d5f08bSStefan Weil@item -semihosting 30816616b2adSStefan Weil@findex -semihosting 30821ddeaa5dSMax FilippovSemihosting mode (ARM, M68K, Xtensa only). 308395d5f08bSStefan WeilETEXI 30845824d651Sblueswir1DEF("old-param", 0, QEMU_OPTION_old_param, 3085ad96090aSBlue Swirl "-old-param old param mode\n", QEMU_ARCH_ARM) 308695d5f08bSStefan WeilSTEXI 308795d5f08bSStefan Weil@item -old-param 30886616b2adSStefan Weil@findex -old-param (ARM) 308995d5f08bSStefan WeilOld param mode (ARM only). 309095d5f08bSStefan WeilETEXI 309195d5f08bSStefan Weil 30927d76ad4fSEduardo OtuboDEF("sandbox", HAS_ARG, QEMU_OPTION_sandbox, \ 30937d76ad4fSEduardo Otubo "-sandbox <arg> Enable seccomp mode 2 system call filter (default 'off').\n", 30947d76ad4fSEduardo Otubo QEMU_ARCH_ALL) 30957d76ad4fSEduardo OtuboSTEXI 30966265c43bSMarkus Armbruster@item -sandbox @var{arg} 30977d76ad4fSEduardo Otubo@findex -sandbox 30987d76ad4fSEduardo OtuboEnable Seccomp mode 2 system call filter. 'on' will enable syscall filtering and 'off' will 30997d76ad4fSEduardo Otubodisable it. The default is 'off'. 31007d76ad4fSEduardo OtuboETEXI 31017d76ad4fSEduardo Otubo 3102715a664aSGerd HoffmannDEF("readconfig", HAS_ARG, QEMU_OPTION_readconfig, 3103ad96090aSBlue Swirl "-readconfig <file>\n", QEMU_ARCH_ALL) 31043dbf2c7fSStefan WeilSTEXI 31053dbf2c7fSStefan Weil@item -readconfig @var{file} 31066616b2adSStefan Weil@findex -readconfig 3107ed24cfacSMichal NovotnyRead device configuration from @var{file}. This approach is useful when you want to spawn 3108ed24cfacSMichal NovotnyQEMU process with many command line options but you don't want to exceed the command line 3109ed24cfacSMichal Novotnycharacter limit. 31103dbf2c7fSStefan WeilETEXI 3111715a664aSGerd HoffmannDEF("writeconfig", HAS_ARG, QEMU_OPTION_writeconfig, 3112715a664aSGerd Hoffmann "-writeconfig <file>\n" 3113ad96090aSBlue Swirl " read/write config file\n", QEMU_ARCH_ALL) 31143dbf2c7fSStefan WeilSTEXI 31153dbf2c7fSStefan Weil@item -writeconfig @var{file} 31166616b2adSStefan Weil@findex -writeconfig 3117ed24cfacSMichal NovotnyWrite device configuration to @var{file}. The @var{file} can be either filename to save 3118ed24cfacSMichal Novotnycommand line and device configuration into file or dash @code{-}) character to print the 3119ed24cfacSMichal Novotnyoutput to stdout. This can be later used as input file for @code{-readconfig} option. 31203dbf2c7fSStefan WeilETEXI 3121292444cbSAnthony LiguoriDEF("nodefconfig", 0, QEMU_OPTION_nodefconfig, 3122292444cbSAnthony Liguori "-nodefconfig\n" 3123ad96090aSBlue Swirl " do not load default config files at startup\n", 3124ad96090aSBlue Swirl QEMU_ARCH_ALL) 3125292444cbSAnthony LiguoriSTEXI 3126292444cbSAnthony Liguori@item -nodefconfig 31276616b2adSStefan Weil@findex -nodefconfig 3128f29a5614SEduardo HabkostNormally QEMU loads configuration files from @var{sysconfdir} and @var{datadir} at startup. 3129f29a5614SEduardo HabkostThe @code{-nodefconfig} option will prevent QEMU from loading any of those config files. 3130f29a5614SEduardo HabkostETEXI 3131f29a5614SEduardo HabkostDEF("no-user-config", 0, QEMU_OPTION_nouserconfig, 3132f29a5614SEduardo Habkost "-no-user-config\n" 3133f29a5614SEduardo Habkost " do not load user-provided config files at startup\n", 3134f29a5614SEduardo Habkost QEMU_ARCH_ALL) 3135f29a5614SEduardo HabkostSTEXI 3136f29a5614SEduardo Habkost@item -no-user-config 3137f29a5614SEduardo Habkost@findex -no-user-config 3138f29a5614SEduardo HabkostThe @code{-no-user-config} option makes QEMU not load any of the user-provided 3139f29a5614SEduardo Habkostconfig files on @var{sysconfdir}, but won't make it skip the QEMU-provided config 3140f29a5614SEduardo Habkostfiles from @var{datadir}. 3141292444cbSAnthony LiguoriETEXI 3142ab6540d5SPrerna SaxenaDEF("trace", HAS_ARG, QEMU_OPTION_trace, 314323d15e86SLluís "-trace [events=<file>][,file=<file>]\n" 314423d15e86SLluís " specify tracing options\n", 3145ab6540d5SPrerna Saxena QEMU_ARCH_ALL) 3146ab6540d5SPrerna SaxenaSTEXI 314723d15e86SLluísHXCOMM This line is not accurate, as some sub-options are backend-specific but 314823d15e86SLluísHXCOMM HX does not support conditional compilation of text. 314923d15e86SLluís@item -trace [events=@var{file}][,file=@var{file}] 3150ab6540d5SPrerna Saxena@findex -trace 3151e4858974SLluís 315223d15e86SLluísSpecify tracing options. 315323d15e86SLluís 315423d15e86SLluís@table @option 315523d15e86SLluís@item events=@var{file} 315623d15e86SLluísImmediately enable events listed in @var{file}. 315723d15e86SLluísThe file must contain one event name (as listed in the @var{trace-events} file) 315823d15e86SLluísper line. 3159c1ba4e0bSStefan WeilThis option is only available if QEMU has been compiled with 3160c1ba4e0bSStefan Weileither @var{simple} or @var{stderr} tracing backend. 316123d15e86SLluís@item file=@var{file} 316223d15e86SLluísLog output traces to @var{file}. 316323d15e86SLluís 3164c1ba4e0bSStefan WeilThis option is only available if QEMU has been compiled with 3165c1ba4e0bSStefan Weilthe @var{simple} tracing backend. 316623d15e86SLluís@end table 3167ab6540d5SPrerna SaxenaETEXI 31683dbf2c7fSStefan Weil 316931e70d6cSMarkus ArmbrusterHXCOMM Internal use 317031e70d6cSMarkus ArmbrusterDEF("qtest", HAS_ARG, QEMU_OPTION_qtest, "", QEMU_ARCH_ALL) 317131e70d6cSMarkus ArmbrusterDEF("qtest-log", HAS_ARG, QEMU_OPTION_qtest_log, "", QEMU_ARCH_ALL) 3172c7f0f3b1SAnthony Liguori 31730f66998fSPaul Moore#ifdef __linux__ 31740f66998fSPaul MooreDEF("enable-fips", 0, QEMU_OPTION_enablefips, 31750f66998fSPaul Moore "-enable-fips enable FIPS 140-2 compliance\n", 31760f66998fSPaul Moore QEMU_ARCH_ALL) 31770f66998fSPaul Moore#endif 31780f66998fSPaul MooreSTEXI 31790f66998fSPaul Moore@item -enable-fips 31800f66998fSPaul Moore@findex -enable-fips 31810f66998fSPaul MooreEnable FIPS 140-2 compliance mode. 31820f66998fSPaul MooreETEXI 31830f66998fSPaul Moore 3184a0dac021SJan KiszkaHXCOMM Deprecated by -machine accel=tcg property 3185c6e88b3bSBruce RogersDEF("no-kvm", 0, QEMU_OPTION_no_kvm, "", QEMU_ARCH_I386) 3186a0dac021SJan Kiszka 3187c21fb4f8SJan KiszkaHXCOMM Deprecated by kvm-pit driver properties 3188c6e88b3bSBruce RogersDEF("no-kvm-pit-reinjection", 0, QEMU_OPTION_no_kvm_pit_reinjection, 3189c21fb4f8SJan Kiszka "", QEMU_ARCH_I386) 3190c21fb4f8SJan Kiszka 31914086bde8SJan KiszkaHXCOMM Deprecated (ignored) 3192c6e88b3bSBruce RogersDEF("no-kvm-pit", 0, QEMU_OPTION_no_kvm_pit, "", QEMU_ARCH_I386) 31934086bde8SJan Kiszka 3194e43d594eSJan KiszkaHXCOMM Deprecated by -machine kernel_irqchip=on|off property 3195c6e88b3bSBruce RogersDEF("no-kvm-irqchip", 0, QEMU_OPTION_no_kvm_irqchip, "", QEMU_ARCH_I386) 3196e43d594eSJan Kiszka 319788eed34aSJan KiszkaHXCOMM Deprecated (ignored) 319888eed34aSJan KiszkaDEF("tdf", 0, QEMU_OPTION_tdf,"", QEMU_ARCH_ALL) 319988eed34aSJan Kiszka 320068d98d3eSAnthony LiguoriDEF("object", HAS_ARG, QEMU_OPTION_object, 320168d98d3eSAnthony Liguori "-object TYPENAME[,PROP1=VALUE1,...]\n" 320268d98d3eSAnthony Liguori " create an new object of type TYPENAME setting properties\n" 320368d98d3eSAnthony Liguori " in the order they are specified. Note that the 'id'\n" 320468d98d3eSAnthony Liguori " property must be set. These objects are placed in the\n" 320568d98d3eSAnthony Liguori " '/objects' path.\n", 320668d98d3eSAnthony Liguori QEMU_ARCH_ALL) 32076265c43bSMarkus ArmbrusterSTEXI 32086265c43bSMarkus Armbruster@item -object @var{typename}[,@var{prop1}=@var{value1},...] 32096265c43bSMarkus Armbruster@findex -object 32106265c43bSMarkus ArmbrusterCreate an new object of type @var{typename} setting properties 32116265c43bSMarkus Armbrusterin the order they are specified. Note that the 'id' 32126265c43bSMarkus Armbrusterproperty must be set. These objects are placed in the 32136265c43bSMarkus Armbruster'/objects' path. 32146265c43bSMarkus ArmbrusterETEXI 321568d98d3eSAnthony Liguori 32165e2ac519SSeiji AguchiDEF("msg", HAS_ARG, QEMU_OPTION_msg, 32175e2ac519SSeiji Aguchi "-msg timestamp[=on|off]\n" 32185e2ac519SSeiji Aguchi " change the format of messages\n" 32195e2ac519SSeiji Aguchi " on|off controls leading timestamps (default:on)\n", 32205e2ac519SSeiji Aguchi QEMU_ARCH_ALL) 32215e2ac519SSeiji AguchiSTEXI 32225e2ac519SSeiji Aguchi@item -msg timestamp[=on|off] 32235e2ac519SSeiji Aguchi@findex -msg 32245e2ac519SSeiji Aguchiprepend a timestamp to each log message.(default:on) 32255e2ac519SSeiji AguchiETEXI 32265e2ac519SSeiji Aguchi 32273dbf2c7fSStefan WeilHXCOMM This is the last statement. Insert new options before this line! 32283dbf2c7fSStefan WeilSTEXI 32293dbf2c7fSStefan Weil@end table 32303dbf2c7fSStefan WeilETEXI 3231