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, 7658a04db1SAndre Przywara "-smp 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 8558a04db1SAndre Przywara@item -smp @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, 21310adb8beSMarkus Armbruster "-m megs set virtual RAM size to megs MB [default=" 21410adb8beSMarkus Armbruster stringify(DEFAULT_RAM_SIZE) "]\n", QEMU_ARCH_ALL) 21510adb8beSMarkus ArmbrusterSTEXI 21610adb8beSMarkus Armbruster@item -m @var{megs} 21710adb8beSMarkus Armbruster@findex -m 21810adb8beSMarkus ArmbrusterSet virtual RAM size to @var{megs} megabytes. Default is 128 MiB. Optionally, 21910adb8beSMarkus Armbrustera suffix of ``M'' or ``G'' can be used to signify a value in megabytes or 22010adb8beSMarkus Armbrustergigabytes respectively. 22110adb8beSMarkus ArmbrusterETEXI 22210adb8beSMarkus Armbruster 22310adb8beSMarkus ArmbrusterDEF("mem-path", HAS_ARG, QEMU_OPTION_mempath, 22410adb8beSMarkus Armbruster "-mem-path FILE provide backing storage for guest RAM\n", QEMU_ARCH_ALL) 22510adb8beSMarkus ArmbrusterSTEXI 22610adb8beSMarkus Armbruster@item -mem-path @var{path} 22710adb8beSMarkus Armbruster@findex -mem-path 22810adb8beSMarkus ArmbrusterAllocate guest RAM from a temporarily created file in @var{path}. 22910adb8beSMarkus ArmbrusterETEXI 23010adb8beSMarkus Armbruster 23110adb8beSMarkus Armbruster#ifdef MAP_POPULATE 23210adb8beSMarkus ArmbrusterDEF("mem-prealloc", 0, QEMU_OPTION_mem_prealloc, 23310adb8beSMarkus Armbruster "-mem-prealloc preallocate guest memory (use with -mem-path)\n", 23410adb8beSMarkus Armbruster QEMU_ARCH_ALL) 23510adb8beSMarkus ArmbrusterSTEXI 23610adb8beSMarkus Armbruster@item -mem-prealloc 23710adb8beSMarkus Armbruster@findex -mem-prealloc 23810adb8beSMarkus ArmbrusterPreallocate memory when using -mem-path. 23910adb8beSMarkus ArmbrusterETEXI 24010adb8beSMarkus Armbruster#endif 24110adb8beSMarkus Armbruster 24210adb8beSMarkus ArmbrusterDEF("k", HAS_ARG, QEMU_OPTION_k, 24310adb8beSMarkus Armbruster "-k language use keyboard layout (for example 'fr' for French)\n", 24410adb8beSMarkus Armbruster QEMU_ARCH_ALL) 24510adb8beSMarkus ArmbrusterSTEXI 24610adb8beSMarkus Armbruster@item -k @var{language} 24710adb8beSMarkus Armbruster@findex -k 24810adb8beSMarkus ArmbrusterUse keyboard layout @var{language} (for example @code{fr} for 24910adb8beSMarkus ArmbrusterFrench). This option is only needed where it is not easy to get raw PC 25010adb8beSMarkus Armbrusterkeycodes (e.g. on Macs, with some X11 servers or with a VNC 25110adb8beSMarkus Armbrusterdisplay). You don't normally need to use it on PC/Linux or PC/Windows 25210adb8beSMarkus Armbrusterhosts. 25310adb8beSMarkus Armbruster 25410adb8beSMarkus ArmbrusterThe available layouts are: 25510adb8beSMarkus Armbruster@example 25610adb8beSMarkus Armbrusterar de-ch es fo fr-ca hu ja mk no pt-br sv 25710adb8beSMarkus Armbrusterda en-gb et fr fr-ch is lt nl pl ru th 25810adb8beSMarkus Armbrusterde en-us fi fr-be hr it lv nl-be pt sl tr 25910adb8beSMarkus Armbruster@end example 26010adb8beSMarkus Armbruster 26110adb8beSMarkus ArmbrusterThe default is @code{en-us}. 26210adb8beSMarkus ArmbrusterETEXI 26310adb8beSMarkus Armbruster 26410adb8beSMarkus Armbruster 26510adb8beSMarkus ArmbrusterDEF("audio-help", 0, QEMU_OPTION_audio_help, 26610adb8beSMarkus Armbruster "-audio-help print list of audio drivers and their options\n", 26710adb8beSMarkus Armbruster QEMU_ARCH_ALL) 26810adb8beSMarkus ArmbrusterSTEXI 26910adb8beSMarkus Armbruster@item -audio-help 27010adb8beSMarkus Armbruster@findex -audio-help 27110adb8beSMarkus ArmbrusterWill show the audio subsystem help: list of drivers, tunable 27210adb8beSMarkus Armbrusterparameters. 27310adb8beSMarkus ArmbrusterETEXI 27410adb8beSMarkus Armbruster 27510adb8beSMarkus ArmbrusterDEF("soundhw", HAS_ARG, QEMU_OPTION_soundhw, 27610adb8beSMarkus Armbruster "-soundhw c1,... enable audio support\n" 27710adb8beSMarkus Armbruster " and only specified sound cards (comma separated list)\n" 27810adb8beSMarkus Armbruster " use '-soundhw help' to get the list of supported cards\n" 27910adb8beSMarkus Armbruster " use '-soundhw all' to enable all of them\n", QEMU_ARCH_ALL) 28010adb8beSMarkus ArmbrusterSTEXI 28110adb8beSMarkus Armbruster@item -soundhw @var{card1}[,@var{card2},...] or -soundhw all 28210adb8beSMarkus Armbruster@findex -soundhw 28310adb8beSMarkus ArmbrusterEnable audio and selected sound hardware. Use 'help' to print all 28410adb8beSMarkus Armbrusteravailable sound hardware. 28510adb8beSMarkus Armbruster 28610adb8beSMarkus Armbruster@example 28710adb8beSMarkus Armbrusterqemu-system-i386 -soundhw sb16,adlib disk.img 28810adb8beSMarkus Armbrusterqemu-system-i386 -soundhw es1370 disk.img 28910adb8beSMarkus Armbrusterqemu-system-i386 -soundhw ac97 disk.img 29010adb8beSMarkus Armbrusterqemu-system-i386 -soundhw hda disk.img 29110adb8beSMarkus Armbrusterqemu-system-i386 -soundhw all disk.img 29210adb8beSMarkus Armbrusterqemu-system-i386 -soundhw help 29310adb8beSMarkus Armbruster@end example 29410adb8beSMarkus Armbruster 29510adb8beSMarkus ArmbrusterNote that Linux's i810_audio OSS kernel (for AC97) module might 29610adb8beSMarkus Armbrusterrequire manually specifying clocking. 29710adb8beSMarkus Armbruster 29810adb8beSMarkus Armbruster@example 29910adb8beSMarkus Armbrustermodprobe i810_audio clocking=48000 30010adb8beSMarkus Armbruster@end example 30110adb8beSMarkus ArmbrusterETEXI 30210adb8beSMarkus Armbruster 30310adb8beSMarkus ArmbrusterDEF("balloon", HAS_ARG, QEMU_OPTION_balloon, 30410adb8beSMarkus Armbruster "-balloon none disable balloon device\n" 30510adb8beSMarkus Armbruster "-balloon virtio[,addr=str]\n" 30610adb8beSMarkus Armbruster " enable virtio balloon device (default)\n", QEMU_ARCH_ALL) 30710adb8beSMarkus ArmbrusterSTEXI 30810adb8beSMarkus Armbruster@item -balloon none 30910adb8beSMarkus Armbruster@findex -balloon 31010adb8beSMarkus ArmbrusterDisable balloon device. 31110adb8beSMarkus Armbruster@item -balloon virtio[,addr=@var{addr}] 31210adb8beSMarkus ArmbrusterEnable virtio balloon device (default), optionally with PCI address 31310adb8beSMarkus Armbruster@var{addr}. 31410adb8beSMarkus ArmbrusterETEXI 31510adb8beSMarkus Armbruster 31610adb8beSMarkus ArmbrusterDEF("device", HAS_ARG, QEMU_OPTION_device, 31710adb8beSMarkus Armbruster "-device driver[,prop[=value][,...]]\n" 31810adb8beSMarkus Armbruster " add device (based on driver)\n" 31910adb8beSMarkus Armbruster " prop=value,... sets driver properties\n" 32010adb8beSMarkus Armbruster " use '-device help' to print all possible drivers\n" 32110adb8beSMarkus Armbruster " use '-device driver,help' to print all possible properties\n", 32210adb8beSMarkus Armbruster QEMU_ARCH_ALL) 32310adb8beSMarkus ArmbrusterSTEXI 32410adb8beSMarkus Armbruster@item -device @var{driver}[,@var{prop}[=@var{value}][,...]] 32510adb8beSMarkus Armbruster@findex -device 32610adb8beSMarkus ArmbrusterAdd device @var{driver}. @var{prop}=@var{value} sets driver 32710adb8beSMarkus Armbrusterproperties. Valid properties depend on the driver. To get help on 32810adb8beSMarkus Armbrusterpossible drivers and properties, use @code{-device help} and 32910adb8beSMarkus Armbruster@code{-device @var{driver},help}. 33010adb8beSMarkus ArmbrusterETEXI 33110adb8beSMarkus Armbruster 33210adb8beSMarkus ArmbrusterDEF("name", HAS_ARG, QEMU_OPTION_name, 33310adb8beSMarkus Armbruster "-name string1[,process=string2]\n" 33410adb8beSMarkus Armbruster " set the name of the guest\n" 33510adb8beSMarkus Armbruster " string1 sets the window title and string2 the process name (on Linux)\n", 33610adb8beSMarkus Armbruster QEMU_ARCH_ALL) 33710adb8beSMarkus ArmbrusterSTEXI 33810adb8beSMarkus Armbruster@item -name @var{name} 33910adb8beSMarkus Armbruster@findex -name 34010adb8beSMarkus ArmbrusterSets the @var{name} of the guest. 34110adb8beSMarkus ArmbrusterThis name will be displayed in the SDL window caption. 34210adb8beSMarkus ArmbrusterThe @var{name} will also be used for the VNC server. 34310adb8beSMarkus ArmbrusterAlso optionally set the top visible process name in Linux. 34410adb8beSMarkus ArmbrusterETEXI 34510adb8beSMarkus Armbruster 34610adb8beSMarkus ArmbrusterDEF("uuid", HAS_ARG, QEMU_OPTION_uuid, 34710adb8beSMarkus Armbruster "-uuid %08x-%04x-%04x-%04x-%012x\n" 34810adb8beSMarkus Armbruster " specify machine UUID\n", QEMU_ARCH_ALL) 34910adb8beSMarkus ArmbrusterSTEXI 35010adb8beSMarkus Armbruster@item -uuid @var{uuid} 35110adb8beSMarkus Armbruster@findex -uuid 35210adb8beSMarkus ArmbrusterSet system UUID. 35310adb8beSMarkus ArmbrusterETEXI 35410adb8beSMarkus Armbruster 35510adb8beSMarkus ArmbrusterSTEXI 35610adb8beSMarkus Armbruster@end table 35710adb8beSMarkus ArmbrusterETEXI 35810adb8beSMarkus ArmbrusterDEFHEADING() 35910adb8beSMarkus Armbruster 36010adb8beSMarkus ArmbrusterDEFHEADING(Block device options:) 36110adb8beSMarkus ArmbrusterSTEXI 36210adb8beSMarkus Armbruster@table @option 36310adb8beSMarkus ArmbrusterETEXI 36410adb8beSMarkus Armbruster 3655824d651Sblueswir1DEF("fda", HAS_ARG, QEMU_OPTION_fda, 366ad96090aSBlue Swirl "-fda/-fdb file use 'file' as floppy disk 0/1 image\n", QEMU_ARCH_ALL) 367ad96090aSBlue SwirlDEF("fdb", HAS_ARG, QEMU_OPTION_fdb, "", QEMU_ARCH_ALL) 3685824d651Sblueswir1STEXI 3695824d651Sblueswir1@item -fda @var{file} 3705824d651Sblueswir1@item -fdb @var{file} 3716616b2adSStefan Weil@findex -fda 3726616b2adSStefan Weil@findex -fdb 3735824d651Sblueswir1Use @var{file} as floppy disk 0/1 image (@pxref{disk_images}). You can 3745824d651Sblueswir1use the host floppy by using @file{/dev/fd0} as filename (@pxref{host_drives}). 3755824d651Sblueswir1ETEXI 3765824d651Sblueswir1 3775824d651Sblueswir1DEF("hda", HAS_ARG, QEMU_OPTION_hda, 378ad96090aSBlue Swirl "-hda/-hdb file use 'file' as IDE hard disk 0/1 image\n", QEMU_ARCH_ALL) 379ad96090aSBlue SwirlDEF("hdb", HAS_ARG, QEMU_OPTION_hdb, "", QEMU_ARCH_ALL) 3805824d651Sblueswir1DEF("hdc", HAS_ARG, QEMU_OPTION_hdc, 381ad96090aSBlue Swirl "-hdc/-hdd file use 'file' as IDE hard disk 2/3 image\n", QEMU_ARCH_ALL) 382ad96090aSBlue SwirlDEF("hdd", HAS_ARG, QEMU_OPTION_hdd, "", QEMU_ARCH_ALL) 3835824d651Sblueswir1STEXI 3845824d651Sblueswir1@item -hda @var{file} 3855824d651Sblueswir1@item -hdb @var{file} 3865824d651Sblueswir1@item -hdc @var{file} 3875824d651Sblueswir1@item -hdd @var{file} 3886616b2adSStefan Weil@findex -hda 3896616b2adSStefan Weil@findex -hdb 3906616b2adSStefan Weil@findex -hdc 3916616b2adSStefan Weil@findex -hdd 3925824d651Sblueswir1Use @var{file} as hard disk 0, 1, 2 or 3 image (@pxref{disk_images}). 3935824d651Sblueswir1ETEXI 3945824d651Sblueswir1 3955824d651Sblueswir1DEF("cdrom", HAS_ARG, QEMU_OPTION_cdrom, 396ad96090aSBlue Swirl "-cdrom file use 'file' as IDE cdrom image (cdrom is ide1 master)\n", 397ad96090aSBlue Swirl QEMU_ARCH_ALL) 3985824d651Sblueswir1STEXI 3995824d651Sblueswir1@item -cdrom @var{file} 4006616b2adSStefan Weil@findex -cdrom 4015824d651Sblueswir1Use @var{file} as CD-ROM image (you cannot use @option{-hdc} and 4025824d651Sblueswir1@option{-cdrom} at the same time). You can use the host CD-ROM by 4035824d651Sblueswir1using @file{/dev/cdrom} as filename (@pxref{host_drives}). 4045824d651Sblueswir1ETEXI 4055824d651Sblueswir1 4065824d651Sblueswir1DEF("drive", HAS_ARG, QEMU_OPTION_drive, 4075824d651Sblueswir1 "-drive [file=file][,if=type][,bus=n][,unit=m][,media=d][,index=i]\n" 4085824d651Sblueswir1 " [,cyls=c,heads=h,secs=s[,trans=t]][,snapshot=on|off]\n" 40992196b2fSStefan Hajnoczi " [,cache=writethrough|writeback|none|directsync|unsafe][,format=f]\n" 410016f5cf6SAlexander Graf " [,serial=s][,addr=A][,id=name][,aio=threads|native]\n" 411fb0490f6SStefan Hajnoczi " [,readonly=on|off][,copy-on-read=on|off]\n" 4120563e191SZhi Yong Wu " [[,bps=b]|[[,bps_rd=r][,bps_wr=w]]][[,iops=i]|[[,iops_rd=r][,iops_wr=w]]\n" 413ad96090aSBlue Swirl " use 'file' as a drive image\n", QEMU_ARCH_ALL) 4145824d651Sblueswir1STEXI 4155824d651Sblueswir1@item -drive @var{option}[,@var{option}[,@var{option}[,...]]] 4166616b2adSStefan Weil@findex -drive 4175824d651Sblueswir1 4185824d651Sblueswir1Define a new drive. Valid options are: 4195824d651Sblueswir1 420b3f046c2SKevin Wolf@table @option 4215824d651Sblueswir1@item file=@var{file} 4225824d651Sblueswir1This option defines which disk image (@pxref{disk_images}) to use with 4235824d651Sblueswir1this drive. If the filename contains comma, you must double it 4245824d651Sblueswir1(for instance, "file=my,,file" to use file "my,file"). 4250f5314a2SRonnie Sahlberg 4260f5314a2SRonnie SahlbergSpecial files such as iSCSI devices can be specified using protocol 4270f5314a2SRonnie Sahlbergspecific URLs. See the section for "Device URL Syntax" for more information. 4285824d651Sblueswir1@item if=@var{interface} 4295824d651Sblueswir1This option defines on which type on interface the drive is connected. 4305824d651Sblueswir1Available types are: ide, scsi, sd, mtd, floppy, pflash, virtio. 4315824d651Sblueswir1@item bus=@var{bus},unit=@var{unit} 4325824d651Sblueswir1These options define where is connected the drive by defining the bus number and 4335824d651Sblueswir1the unit id. 4345824d651Sblueswir1@item index=@var{index} 4355824d651Sblueswir1This option defines where is connected the drive by using an index in the list 4365824d651Sblueswir1of available connectors of a given interface type. 4375824d651Sblueswir1@item media=@var{media} 4385824d651Sblueswir1This option defines the type of the media: disk or cdrom. 4395824d651Sblueswir1@item cyls=@var{c},heads=@var{h},secs=@var{s}[,trans=@var{t}] 4405824d651Sblueswir1These options have the same definition as they have in @option{-hdachs}. 4415824d651Sblueswir1@item snapshot=@var{snapshot} 4425824d651Sblueswir1@var{snapshot} is "on" or "off" and allows to enable snapshot for given drive (see @option{-snapshot}). 4435824d651Sblueswir1@item cache=@var{cache} 44492196b2fSStefan Hajnoczi@var{cache} is "none", "writeback", "unsafe", "directsync" or "writethrough" and controls how the host cache is used to access block data. 4455c6c3a6cSChristoph Hellwig@item aio=@var{aio} 4465c6c3a6cSChristoph Hellwig@var{aio} is "threads", or "native" and selects between pthread based disk I/O and native Linux AIO. 447a9384affSPaolo Bonzini@item discard=@var{discard} 448a9384affSPaolo 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. 4495824d651Sblueswir1@item format=@var{format} 4505824d651Sblueswir1Specify which disk @var{format} will be used rather than detecting 4515824d651Sblueswir1the format. Can be used to specifiy format=raw to avoid interpreting 4525824d651Sblueswir1an untrusted format header. 4535824d651Sblueswir1@item serial=@var{serial} 4545824d651Sblueswir1This option specifies the serial number to assign to the device. 455c2cc47a4SMarkus Armbruster@item addr=@var{addr} 456c2cc47a4SMarkus ArmbrusterSpecify the controller's PCI address (if=virtio only). 457ae73e591SLuiz Capitulino@item werror=@var{action},rerror=@var{action} 458ae73e591SLuiz CapitulinoSpecify which @var{action} to take on write and read errors. Valid actions are: 459ae73e591SLuiz Capitulino"ignore" (ignore the error and try to continue), "stop" (pause QEMU), 460ae73e591SLuiz Capitulino"report" (report the error to the guest), "enospc" (pause QEMU only if the 461ae73e591SLuiz Capitulinohost disk is full; report the error to the guest otherwise). 462ae73e591SLuiz CapitulinoThe default setting is @option{werror=enospc} and @option{rerror=report}. 463ae73e591SLuiz Capitulino@item readonly 464ae73e591SLuiz CapitulinoOpen drive @option{file} as read-only. Guest write attempts will fail. 465fb0490f6SStefan Hajnoczi@item copy-on-read=@var{copy-on-read} 466fb0490f6SStefan Hajnoczi@var{copy-on-read} is "on" or "off" and enables whether to copy read backing 467fb0490f6SStefan Hajnoczifile sectors into the image file. 4685824d651Sblueswir1@end table 4695824d651Sblueswir1 470a13e5e05SKevin WolfBy default, the @option{cache=writeback} mode is used. It will report data 471a13e5e05SKevin Wolfwrites as completed as soon as the data is present in the host page cache. 472a13e5e05SKevin WolfThis is safe as long as your guest OS makes sure to correctly flush disk caches 473a13e5e05SKevin Wolfwhere needed. If your guest OS does not handle volatile disk write caches 474a13e5e05SKevin Wolfcorrectly and your host crashes or loses power, then the guest may experience 475a13e5e05SKevin Wolfdata corruption. 4765824d651Sblueswir1 477a13e5e05SKevin WolfFor such guests, you should consider using @option{cache=writethrough}. This 478a13e5e05SKevin Wolfmeans that the host page cache will be used to read and write data, but write 479a13e5e05SKevin Wolfnotification will be sent to the guest only after QEMU has made sure to flush 480a13e5e05SKevin Wolfeach write to the disk. Be aware that this has a major impact on performance. 4815824d651Sblueswir1 482c304d317SAurelien JarnoThe host page cache can be avoided entirely with @option{cache=none}. This will 483a13e5e05SKevin Wolfattempt to do disk IO directly to the guest's memory. QEMU may still perform 484a13e5e05SKevin Wolfan internal copy of the data. Note that this is considered a writeback mode and 485a13e5e05SKevin Wolfthe guest OS must handle the disk write cache correctly in order to avoid data 486a13e5e05SKevin Wolfcorruption on host crashes. 4875824d651Sblueswir1 48892196b2fSStefan HajnocziThe host page cache can be avoided while only sending write notifications to 489a13e5e05SKevin Wolfthe guest when the data has been flushed to the disk using 490a13e5e05SKevin Wolf@option{cache=directsync}. 4915824d651Sblueswir1 492016f5cf6SAlexander GrafIn case you don't care about data integrity over host failures, use 493a13e5e05SKevin Wolf@option{cache=unsafe}. This option tells QEMU that it never needs to write any 494a13e5e05SKevin Wolfdata to the disk but can instead keep things in cache. If anything goes wrong, 495e7d81004SStefan Weillike your host losing power, the disk storage getting disconnected accidentally, 496a13e5e05SKevin Wolfetc. your image will most probably be rendered unusable. When using 497c3177288SAlexander Grafthe @option{-snapshot} option, unsafe caching is always used. 498016f5cf6SAlexander Graf 499fb0490f6SStefan HajnocziCopy-on-read avoids accessing the same backing file sectors repeatedly and is 500fb0490f6SStefan Hajnocziuseful when the backing file is over a slow network. By default copy-on-read 501fb0490f6SStefan Hajnocziis off. 502fb0490f6SStefan Hajnoczi 5035824d651Sblueswir1Instead of @option{-cdrom} you can use: 5045824d651Sblueswir1@example 5053804da9dSStefan Weilqemu-system-i386 -drive file=file,index=2,media=cdrom 5065824d651Sblueswir1@end example 5075824d651Sblueswir1 5085824d651Sblueswir1Instead of @option{-hda}, @option{-hdb}, @option{-hdc}, @option{-hdd}, you can 5095824d651Sblueswir1use: 5105824d651Sblueswir1@example 5113804da9dSStefan Weilqemu-system-i386 -drive file=file,index=0,media=disk 5123804da9dSStefan Weilqemu-system-i386 -drive file=file,index=1,media=disk 5133804da9dSStefan Weilqemu-system-i386 -drive file=file,index=2,media=disk 5143804da9dSStefan Weilqemu-system-i386 -drive file=file,index=3,media=disk 5155824d651Sblueswir1@end example 5165824d651Sblueswir1 517587ed6beSCorey BryantYou can open an image using pre-opened file descriptors from an fd set: 518587ed6beSCorey Bryant@example 519587ed6beSCorey Bryantqemu-system-i386 520587ed6beSCorey Bryant-add-fd fd=3,set=2,opaque="rdwr:/path/to/file" 521587ed6beSCorey Bryant-add-fd fd=4,set=2,opaque="rdonly:/path/to/file" 522587ed6beSCorey Bryant-drive file=/dev/fdset/2,index=0,media=disk 523587ed6beSCorey Bryant@end example 524587ed6beSCorey Bryant 5255824d651Sblueswir1You can connect a CDROM to the slave of ide0: 5265824d651Sblueswir1@example 5273804da9dSStefan Weilqemu-system-i386 -drive file=file,if=ide,index=1,media=cdrom 5285824d651Sblueswir1@end example 5295824d651Sblueswir1 5305824d651Sblueswir1If you don't specify the "file=" argument, you define an empty drive: 5315824d651Sblueswir1@example 5323804da9dSStefan Weilqemu-system-i386 -drive if=ide,index=1,media=cdrom 5335824d651Sblueswir1@end example 5345824d651Sblueswir1 5355824d651Sblueswir1You can connect a SCSI disk with unit ID 6 on the bus #0: 5365824d651Sblueswir1@example 5373804da9dSStefan Weilqemu-system-i386 -drive file=file,if=scsi,bus=0,unit=6 5385824d651Sblueswir1@end example 5395824d651Sblueswir1 5405824d651Sblueswir1Instead of @option{-fda}, @option{-fdb}, you can use: 5415824d651Sblueswir1@example 5423804da9dSStefan Weilqemu-system-i386 -drive file=file,index=0,if=floppy 5433804da9dSStefan Weilqemu-system-i386 -drive file=file,index=1,if=floppy 5445824d651Sblueswir1@end example 5455824d651Sblueswir1 5465824d651Sblueswir1By default, @var{interface} is "ide" and @var{index} is automatically 5475824d651Sblueswir1incremented: 5485824d651Sblueswir1@example 5493804da9dSStefan Weilqemu-system-i386 -drive file=a -drive file=b" 5505824d651Sblueswir1@end example 5515824d651Sblueswir1is interpreted like: 5525824d651Sblueswir1@example 5533804da9dSStefan Weilqemu-system-i386 -hda a -hdb b 5545824d651Sblueswir1@end example 5555824d651Sblueswir1ETEXI 5565824d651Sblueswir1 5575824d651Sblueswir1DEF("mtdblock", HAS_ARG, QEMU_OPTION_mtdblock, 558ad96090aSBlue Swirl "-mtdblock file use 'file' as on-board Flash memory image\n", 559ad96090aSBlue Swirl QEMU_ARCH_ALL) 5605824d651Sblueswir1STEXI 5614e257e5eSKevin Wolf@item -mtdblock @var{file} 5626616b2adSStefan Weil@findex -mtdblock 5634e257e5eSKevin WolfUse @var{file} as on-board Flash memory image. 5645824d651Sblueswir1ETEXI 5655824d651Sblueswir1 5665824d651Sblueswir1DEF("sd", HAS_ARG, QEMU_OPTION_sd, 567ad96090aSBlue Swirl "-sd file use 'file' as SecureDigital card image\n", QEMU_ARCH_ALL) 5685824d651Sblueswir1STEXI 5694e257e5eSKevin Wolf@item -sd @var{file} 5706616b2adSStefan Weil@findex -sd 5714e257e5eSKevin WolfUse @var{file} as SecureDigital card image. 5725824d651Sblueswir1ETEXI 5735824d651Sblueswir1 5745824d651Sblueswir1DEF("pflash", HAS_ARG, QEMU_OPTION_pflash, 575ad96090aSBlue Swirl "-pflash file use 'file' as a parallel flash image\n", QEMU_ARCH_ALL) 5765824d651Sblueswir1STEXI 5774e257e5eSKevin Wolf@item -pflash @var{file} 5786616b2adSStefan Weil@findex -pflash 5794e257e5eSKevin WolfUse @var{file} as a parallel flash image. 5805824d651Sblueswir1ETEXI 5815824d651Sblueswir1 5825824d651Sblueswir1DEF("snapshot", 0, QEMU_OPTION_snapshot, 583ad96090aSBlue Swirl "-snapshot write to temporary files instead of disk image files\n", 584ad96090aSBlue Swirl QEMU_ARCH_ALL) 5855824d651Sblueswir1STEXI 5865824d651Sblueswir1@item -snapshot 5876616b2adSStefan Weil@findex -snapshot 5885824d651Sblueswir1Write to temporary files instead of disk image files. In this case, 5895824d651Sblueswir1the raw disk image you use is not written back. You can however force 5905824d651Sblueswir1the write back by pressing @key{C-a s} (@pxref{disk_images}). 5915824d651Sblueswir1ETEXI 5925824d651Sblueswir1 59310adb8beSMarkus ArmbrusterDEF("hdachs", HAS_ARG, QEMU_OPTION_hdachs, \ 59410adb8beSMarkus Armbruster "-hdachs c,h,s[,t]\n" \ 59510adb8beSMarkus Armbruster " force hard disk 0 physical geometry and the optional BIOS\n" \ 59610adb8beSMarkus Armbruster " translation (t=none or lba) (usually QEMU can guess them)\n", 597ad96090aSBlue Swirl QEMU_ARCH_ALL) 598c902760fSMarcelo TosattiSTEXI 59910adb8beSMarkus Armbruster@item -hdachs @var{c},@var{h},@var{s},[,@var{t}] 60010adb8beSMarkus Armbruster@findex -hdachs 60110adb8beSMarkus ArmbrusterForce hard disk 0 physical geometry (1 <= @var{c} <= 16383, 1 <= 60210adb8beSMarkus Armbruster@var{h} <= 16, 1 <= @var{s} <= 63) and optionally force the BIOS 60310adb8beSMarkus Armbrustertranslation mode (@var{t}=none, lba or auto). Usually QEMU can guess 60410adb8beSMarkus Armbrusterall those parameters. This option is useful for old MS-DOS disk 60510adb8beSMarkus Armbrusterimages. 606c70a01e4SMarkus ArmbrusterETEXI 60774db920cSGautham R Shenoy 60874db920cSGautham R ShenoyDEF("fsdev", HAS_ARG, QEMU_OPTION_fsdev, 6092c30dd74SAneesh Kumar K.V "-fsdev fsdriver,id=id[,path=path,][security_model={mapped-xattr|mapped-file|passthrough|none}]\n" 61084a87cc4SM. Mohan Kumar " [,writeout=immediate][,readonly][,socket=socket|sock_fd=sock_fd]\n", 61174db920cSGautham R Shenoy QEMU_ARCH_ALL) 61274db920cSGautham R Shenoy 61374db920cSGautham R ShenoySTEXI 61474db920cSGautham R Shenoy 61584a87cc4SM. 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}] 61674db920cSGautham R Shenoy@findex -fsdev 6177c92a3d2SAneesh Kumar K.VDefine a new file system device. Valid options are: 6187c92a3d2SAneesh Kumar K.V@table @option 6197c92a3d2SAneesh Kumar K.V@item @var{fsdriver} 6207c92a3d2SAneesh Kumar K.VThis option specifies the fs driver backend to use. 621f67e3ffdSM. Mohan KumarCurrently "local", "handle" and "proxy" file system drivers are supported. 6227c92a3d2SAneesh Kumar K.V@item id=@var{id} 6237c92a3d2SAneesh Kumar K.VSpecifies identifier for this device 6247c92a3d2SAneesh Kumar K.V@item path=@var{path} 6257c92a3d2SAneesh Kumar K.VSpecifies the export path for the file system device. Files under 6267c92a3d2SAneesh Kumar K.Vthis path will be available to the 9p client on the guest. 6277c92a3d2SAneesh Kumar K.V@item security_model=@var{security_model} 6287c92a3d2SAneesh Kumar K.VSpecifies the security model to be used for this export path. 6292c30dd74SAneesh Kumar K.VSupported security models are "passthrough", "mapped-xattr", "mapped-file" and "none". 6307c92a3d2SAneesh Kumar K.VIn "passthrough" security model, files are stored using the same 631b65ee4faSStefan Weilcredentials as they are created on the guest. This requires QEMU 6322c30dd74SAneesh Kumar K.Vto run as root. In "mapped-xattr" security model, some of the file 6337c92a3d2SAneesh Kumar K.Vattributes like uid, gid, mode bits and link target are stored as 6342c30dd74SAneesh Kumar K.Vfile attributes. For "mapped-file" these attributes are stored in the 6352c30dd74SAneesh Kumar K.Vhidden .virtfs_metadata directory. Directories exported by this security model cannot 6367c92a3d2SAneesh Kumar K.Vinteract with other unix tools. "none" security model is same as 6377c92a3d2SAneesh Kumar K.Vpassthrough except the sever won't report failures if it fails to 638d9b36a6eSM. Mohan Kumarset file attributes like ownership. Security model is mandatory 639f67e3ffdSM. Mohan Kumaronly for local fsdriver. Other fsdrivers (like handle, proxy) don't take 640d9b36a6eSM. Mohan Kumarsecurity model as a parameter. 6417c92a3d2SAneesh Kumar K.V@item writeout=@var{writeout} 6427c92a3d2SAneesh Kumar K.VThis is an optional argument. The only supported value is "immediate". 6437c92a3d2SAneesh Kumar K.VThis means that host page cache will be used to read and write data but 6447c92a3d2SAneesh Kumar K.Vwrite notification will be sent to the guest only when the data has been 6457c92a3d2SAneesh Kumar K.Vreported as written by the storage subsystem. 6462c74c2cbSM. Mohan Kumar@item readonly 6472c74c2cbSM. Mohan KumarEnables exporting 9p share as a readonly mount for guests. By default 6482c74c2cbSM. Mohan Kumarread-write access is given. 64984a87cc4SM. Mohan Kumar@item socket=@var{socket} 65084a87cc4SM. Mohan KumarEnables proxy filesystem driver to use passed socket file for communicating 65184a87cc4SM. Mohan Kumarwith virtfs-proxy-helper 652f67e3ffdSM. Mohan Kumar@item sock_fd=@var{sock_fd} 653f67e3ffdSM. Mohan KumarEnables proxy filesystem driver to use passed socket descriptor for 654f67e3ffdSM. Mohan Kumarcommunicating with virtfs-proxy-helper. Usually a helper like libvirt 655f67e3ffdSM. Mohan Kumarwill create socketpair and pass one of the fds as sock_fd 65674db920cSGautham R Shenoy@end table 6577c92a3d2SAneesh Kumar K.V 6587c92a3d2SAneesh Kumar K.V-fsdev option is used along with -device driver "virtio-9p-pci". 6597c92a3d2SAneesh Kumar K.V@item -device virtio-9p-pci,fsdev=@var{id},mount_tag=@var{mount_tag} 6607c92a3d2SAneesh Kumar K.VOptions for virtio-9p-pci driver are: 6617c92a3d2SAneesh Kumar K.V@table @option 6627c92a3d2SAneesh Kumar K.V@item fsdev=@var{id} 6637c92a3d2SAneesh Kumar K.VSpecifies the id value specified along with -fsdev option 6647c92a3d2SAneesh Kumar K.V@item mount_tag=@var{mount_tag} 6657c92a3d2SAneesh Kumar K.VSpecifies the tag name to be used by the guest to mount this export point 6667c92a3d2SAneesh Kumar K.V@end table 6677c92a3d2SAneesh Kumar K.V 66874db920cSGautham R ShenoyETEXI 66974db920cSGautham R Shenoy 6703d54abc7SGautham R ShenoyDEF("virtfs", HAS_ARG, QEMU_OPTION_virtfs, 6712c30dd74SAneesh Kumar K.V "-virtfs local,path=path,mount_tag=tag,security_model=[mapped-xattr|mapped-file|passthrough|none]\n" 67284a87cc4SM. Mohan Kumar " [,writeout=immediate][,readonly][,socket=socket|sock_fd=sock_fd]\n", 6733d54abc7SGautham R Shenoy QEMU_ARCH_ALL) 6743d54abc7SGautham R Shenoy 6753d54abc7SGautham R ShenoySTEXI 6763d54abc7SGautham R Shenoy 67784a87cc4SM. 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}] 6783d54abc7SGautham R Shenoy@findex -virtfs 6793d54abc7SGautham R Shenoy 6807c92a3d2SAneesh Kumar K.VThe general form of a Virtual File system pass-through options are: 6817c92a3d2SAneesh Kumar K.V@table @option 6827c92a3d2SAneesh Kumar K.V@item @var{fsdriver} 6837c92a3d2SAneesh Kumar K.VThis option specifies the fs driver backend to use. 684f67e3ffdSM. Mohan KumarCurrently "local", "handle" and "proxy" file system drivers are supported. 6857c92a3d2SAneesh Kumar K.V@item id=@var{id} 6867c92a3d2SAneesh Kumar K.VSpecifies identifier for this device 6877c92a3d2SAneesh Kumar K.V@item path=@var{path} 6887c92a3d2SAneesh Kumar K.VSpecifies the export path for the file system device. Files under 6897c92a3d2SAneesh Kumar K.Vthis path will be available to the 9p client on the guest. 6907c92a3d2SAneesh Kumar K.V@item security_model=@var{security_model} 6917c92a3d2SAneesh Kumar K.VSpecifies the security model to be used for this export path. 6922c30dd74SAneesh Kumar K.VSupported security models are "passthrough", "mapped-xattr", "mapped-file" and "none". 6937c92a3d2SAneesh Kumar K.VIn "passthrough" security model, files are stored using the same 694b65ee4faSStefan Weilcredentials as they are created on the guest. This requires QEMU 6952c30dd74SAneesh Kumar K.Vto run as root. In "mapped-xattr" security model, some of the file 6967c92a3d2SAneesh Kumar K.Vattributes like uid, gid, mode bits and link target are stored as 6972c30dd74SAneesh Kumar K.Vfile attributes. For "mapped-file" these attributes are stored in the 6982c30dd74SAneesh Kumar K.Vhidden .virtfs_metadata directory. Directories exported by this security model cannot 6997c92a3d2SAneesh Kumar K.Vinteract with other unix tools. "none" security model is same as 7007c92a3d2SAneesh Kumar K.Vpassthrough except the sever won't report failures if it fails to 701d9b36a6eSM. Mohan Kumarset file attributes like ownership. Security model is mandatory only 702f67e3ffdSM. Mohan Kumarfor local fsdriver. Other fsdrivers (like handle, proxy) don't take security 703d9b36a6eSM. Mohan Kumarmodel as a parameter. 7047c92a3d2SAneesh Kumar K.V@item writeout=@var{writeout} 7057c92a3d2SAneesh Kumar K.VThis is an optional argument. The only supported value is "immediate". 7067c92a3d2SAneesh Kumar K.VThis means that host page cache will be used to read and write data but 7077c92a3d2SAneesh Kumar K.Vwrite notification will be sent to the guest only when the data has been 7087c92a3d2SAneesh Kumar K.Vreported as written by the storage subsystem. 7092c74c2cbSM. Mohan Kumar@item readonly 7102c74c2cbSM. Mohan KumarEnables exporting 9p share as a readonly mount for guests. By default 7112c74c2cbSM. Mohan Kumarread-write access is given. 71284a87cc4SM. Mohan Kumar@item socket=@var{socket} 71384a87cc4SM. Mohan KumarEnables proxy filesystem driver to use passed socket file for 71484a87cc4SM. Mohan Kumarcommunicating with virtfs-proxy-helper. Usually a helper like libvirt 71584a87cc4SM. Mohan Kumarwill create socketpair and pass one of the fds as sock_fd 716f67e3ffdSM. Mohan Kumar@item sock_fd 717f67e3ffdSM. Mohan KumarEnables proxy filesystem driver to use passed 'sock_fd' as the socket 718f67e3ffdSM. Mohan Kumardescriptor for interfacing with virtfs-proxy-helper 7193d54abc7SGautham R Shenoy@end table 7203d54abc7SGautham R ShenoyETEXI 7213d54abc7SGautham R Shenoy 7229db221aeSAneesh Kumar K.VDEF("virtfs_synth", 0, QEMU_OPTION_virtfs_synth, 7239db221aeSAneesh Kumar K.V "-virtfs_synth Create synthetic file system image\n", 7249db221aeSAneesh Kumar K.V QEMU_ARCH_ALL) 7259db221aeSAneesh Kumar K.VSTEXI 7269db221aeSAneesh Kumar K.V@item -virtfs_synth 7279db221aeSAneesh Kumar K.V@findex -virtfs_synth 7289db221aeSAneesh Kumar K.VCreate synthetic file system image 7299db221aeSAneesh Kumar K.VETEXI 7309db221aeSAneesh Kumar K.V 7315824d651Sblueswir1STEXI 7325824d651Sblueswir1@end table 7335824d651Sblueswir1ETEXI 7345824d651Sblueswir1DEFHEADING() 7355824d651Sblueswir1 73610adb8beSMarkus ArmbrusterDEFHEADING(USB options:) 73710adb8beSMarkus ArmbrusterSTEXI 73810adb8beSMarkus Armbruster@table @option 73910adb8beSMarkus ArmbrusterETEXI 74010adb8beSMarkus Armbruster 74110adb8beSMarkus ArmbrusterDEF("usb", 0, QEMU_OPTION_usb, 74210adb8beSMarkus Armbruster "-usb enable the USB driver (will be the default soon)\n", 74310adb8beSMarkus Armbruster QEMU_ARCH_ALL) 74410adb8beSMarkus ArmbrusterSTEXI 74510adb8beSMarkus Armbruster@item -usb 74610adb8beSMarkus Armbruster@findex -usb 74710adb8beSMarkus ArmbrusterEnable the USB driver (will be the default soon) 74810adb8beSMarkus ArmbrusterETEXI 74910adb8beSMarkus Armbruster 75010adb8beSMarkus ArmbrusterDEF("usbdevice", HAS_ARG, QEMU_OPTION_usbdevice, 75110adb8beSMarkus Armbruster "-usbdevice name add the host or guest USB device 'name'\n", 75210adb8beSMarkus Armbruster QEMU_ARCH_ALL) 75310adb8beSMarkus ArmbrusterSTEXI 75410adb8beSMarkus Armbruster 75510adb8beSMarkus Armbruster@item -usbdevice @var{devname} 75610adb8beSMarkus Armbruster@findex -usbdevice 75710adb8beSMarkus ArmbrusterAdd the USB device @var{devname}. @xref{usb_devices}. 75810adb8beSMarkus Armbruster 75910adb8beSMarkus Armbruster@table @option 76010adb8beSMarkus Armbruster 76110adb8beSMarkus Armbruster@item mouse 76210adb8beSMarkus ArmbrusterVirtual Mouse. This will override the PS/2 mouse emulation when activated. 76310adb8beSMarkus Armbruster 76410adb8beSMarkus Armbruster@item tablet 76510adb8beSMarkus ArmbrusterPointer device that uses absolute coordinates (like a touchscreen). This 76610adb8beSMarkus Armbrustermeans QEMU is able to report the mouse position without having to grab the 76710adb8beSMarkus Armbrustermouse. Also overrides the PS/2 mouse emulation when activated. 76810adb8beSMarkus Armbruster 76910adb8beSMarkus Armbruster@item disk:[format=@var{format}]:@var{file} 77010adb8beSMarkus ArmbrusterMass storage device based on file. The optional @var{format} argument 77110adb8beSMarkus Armbrusterwill be used rather than detecting the format. Can be used to specifiy 77210adb8beSMarkus Armbruster@code{format=raw} to avoid interpreting an untrusted format header. 77310adb8beSMarkus Armbruster 77410adb8beSMarkus Armbruster@item host:@var{bus}.@var{addr} 77510adb8beSMarkus ArmbrusterPass through the host device identified by @var{bus}.@var{addr} (Linux only). 77610adb8beSMarkus Armbruster 77710adb8beSMarkus Armbruster@item host:@var{vendor_id}:@var{product_id} 77810adb8beSMarkus ArmbrusterPass through the host device identified by @var{vendor_id}:@var{product_id} 77910adb8beSMarkus Armbruster(Linux only). 78010adb8beSMarkus Armbruster 78110adb8beSMarkus Armbruster@item serial:[vendorid=@var{vendor_id}][,productid=@var{product_id}]:@var{dev} 78210adb8beSMarkus ArmbrusterSerial converter to host character device @var{dev}, see @code{-serial} for the 78310adb8beSMarkus Armbrusteravailable devices. 78410adb8beSMarkus Armbruster 78510adb8beSMarkus Armbruster@item braille 78610adb8beSMarkus ArmbrusterBraille device. This will use BrlAPI to display the braille output on a real 78710adb8beSMarkus Armbrusteror fake device. 78810adb8beSMarkus Armbruster 78910adb8beSMarkus Armbruster@item net:@var{options} 79010adb8beSMarkus ArmbrusterNetwork adapter that supports CDC ethernet and RNDIS protocols. 79110adb8beSMarkus Armbruster 79210adb8beSMarkus Armbruster@end table 79310adb8beSMarkus ArmbrusterETEXI 79410adb8beSMarkus Armbruster 79510adb8beSMarkus ArmbrusterSTEXI 79610adb8beSMarkus Armbruster@end table 79710adb8beSMarkus ArmbrusterETEXI 79810adb8beSMarkus ArmbrusterDEFHEADING() 79910adb8beSMarkus Armbruster 8005824d651Sblueswir1DEFHEADING(Display options:) 8015824d651Sblueswir1STEXI 8025824d651Sblueswir1@table @option 8035824d651Sblueswir1ETEXI 8045824d651Sblueswir1 8051472a95bSJes SorensenDEF("display", HAS_ARG, QEMU_OPTION_display, 8061472a95bSJes Sorensen "-display sdl[,frame=on|off][,alt_grab=on|off][,ctrl_grab=on|off]\n" 8073264ff12SJes Sorensen " [,window_close=on|off]|curses|none|\n" 8083264ff12SJes Sorensen " vnc=<display>[,<optargs>]\n" 8091472a95bSJes Sorensen " select display type\n", QEMU_ARCH_ALL) 8101472a95bSJes SorensenSTEXI 8111472a95bSJes Sorensen@item -display @var{type} 8121472a95bSJes Sorensen@findex -display 8131472a95bSJes SorensenSelect type of display to use. This option is a replacement for the 8141472a95bSJes Sorensenold style -sdl/-curses/... options. Valid values for @var{type} are 8151472a95bSJes Sorensen@table @option 8161472a95bSJes Sorensen@item sdl 8171472a95bSJes SorensenDisplay video output via SDL (usually in a separate graphics 8181472a95bSJes Sorensenwindow; see the SDL documentation for other possibilities). 8191472a95bSJes Sorensen@item curses 8201472a95bSJes SorensenDisplay video output via curses. For graphics device models which 8211472a95bSJes Sorensensupport a text mode, QEMU can display this output using a 8221472a95bSJes Sorensencurses/ncurses interface. Nothing is displayed when the graphics 8231472a95bSJes Sorensendevice is in graphical mode or if the graphics device does not support 8241472a95bSJes Sorensena text mode. Generally only the VGA device models support text mode. 8254171d32eSJes Sorensen@item none 8264171d32eSJes SorensenDo not display video output. The guest will still see an emulated 8274171d32eSJes Sorensengraphics card, but its output will not be displayed to the QEMU 8284171d32eSJes Sorensenuser. This option differs from the -nographic option in that it 8294171d32eSJes Sorensenonly affects what is done with video output; -nographic also changes 8304171d32eSJes Sorensenthe destination of the serial and parallel port data. 8313264ff12SJes Sorensen@item vnc 8323264ff12SJes SorensenStart a VNC server on display <arg> 8331472a95bSJes Sorensen@end table 8341472a95bSJes SorensenETEXI 8351472a95bSJes Sorensen 8365824d651Sblueswir1DEF("nographic", 0, QEMU_OPTION_nographic, 837ad96090aSBlue Swirl "-nographic disable graphical output and redirect serial I/Os to console\n", 838ad96090aSBlue Swirl QEMU_ARCH_ALL) 8395824d651Sblueswir1STEXI 8405824d651Sblueswir1@item -nographic 8416616b2adSStefan Weil@findex -nographic 8425824d651Sblueswir1Normally, QEMU uses SDL to display the VGA output. With this option, 8435824d651Sblueswir1you can totally disable graphical output so that QEMU is a simple 8445824d651Sblueswir1command line application. The emulated serial port is redirected on 8455824d651Sblueswir1the console. Therefore, you can still use QEMU to debug a Linux kernel 8465824d651Sblueswir1with a serial console. 8475824d651Sblueswir1ETEXI 8485824d651Sblueswir1 8495824d651Sblueswir1DEF("curses", 0, QEMU_OPTION_curses, 850ad96090aSBlue Swirl "-curses use a curses/ncurses interface instead of SDL\n", 851ad96090aSBlue Swirl QEMU_ARCH_ALL) 8525824d651Sblueswir1STEXI 8535824d651Sblueswir1@item -curses 854b8f490ebSMarkus Armbruster@findex -curses 8555824d651Sblueswir1Normally, QEMU uses SDL to display the VGA output. With this option, 8565824d651Sblueswir1QEMU can display the VGA output when in text mode using a 8575824d651Sblueswir1curses/ncurses interface. Nothing is displayed in graphical mode. 8585824d651Sblueswir1ETEXI 8595824d651Sblueswir1 8605824d651Sblueswir1DEF("no-frame", 0, QEMU_OPTION_no_frame, 861ad96090aSBlue Swirl "-no-frame open SDL window without a frame and window decorations\n", 862ad96090aSBlue Swirl QEMU_ARCH_ALL) 8635824d651Sblueswir1STEXI 8645824d651Sblueswir1@item -no-frame 8656616b2adSStefan Weil@findex -no-frame 8665824d651Sblueswir1Do not use decorations for SDL windows and start them using the whole 8675824d651Sblueswir1available screen space. This makes the using QEMU in a dedicated desktop 8685824d651Sblueswir1workspace more convenient. 8695824d651Sblueswir1ETEXI 8705824d651Sblueswir1 8715824d651Sblueswir1DEF("alt-grab", 0, QEMU_OPTION_alt_grab, 872ad96090aSBlue Swirl "-alt-grab use Ctrl-Alt-Shift to grab mouse (instead of Ctrl-Alt)\n", 873ad96090aSBlue Swirl QEMU_ARCH_ALL) 8745824d651Sblueswir1STEXI 8755824d651Sblueswir1@item -alt-grab 8766616b2adSStefan Weil@findex -alt-grab 877de1db2a1SBrad HardsUse Ctrl-Alt-Shift to grab mouse (instead of Ctrl-Alt). Note that this also 878de1db2a1SBrad Hardsaffects the special keys (for fullscreen, monitor-mode switching, etc). 8795824d651Sblueswir1ETEXI 8805824d651Sblueswir1 8810ca9f8a4SDustin KirklandDEF("ctrl-grab", 0, QEMU_OPTION_ctrl_grab, 882ad96090aSBlue Swirl "-ctrl-grab use Right-Ctrl to grab mouse (instead of Ctrl-Alt)\n", 883ad96090aSBlue Swirl QEMU_ARCH_ALL) 8840ca9f8a4SDustin KirklandSTEXI 8850ca9f8a4SDustin Kirkland@item -ctrl-grab 8866616b2adSStefan Weil@findex -ctrl-grab 887de1db2a1SBrad HardsUse Right-Ctrl to grab mouse (instead of Ctrl-Alt). Note that this also 888de1db2a1SBrad Hardsaffects the special keys (for fullscreen, monitor-mode switching, etc). 8890ca9f8a4SDustin KirklandETEXI 8900ca9f8a4SDustin Kirkland 8915824d651Sblueswir1DEF("no-quit", 0, QEMU_OPTION_no_quit, 892ad96090aSBlue Swirl "-no-quit disable SDL window close capability\n", QEMU_ARCH_ALL) 8935824d651Sblueswir1STEXI 8945824d651Sblueswir1@item -no-quit 8956616b2adSStefan Weil@findex -no-quit 8965824d651Sblueswir1Disable SDL window close capability. 8975824d651Sblueswir1ETEXI 8985824d651Sblueswir1 8995824d651Sblueswir1DEF("sdl", 0, QEMU_OPTION_sdl, 900ad96090aSBlue Swirl "-sdl enable SDL\n", QEMU_ARCH_ALL) 9015824d651Sblueswir1STEXI 9025824d651Sblueswir1@item -sdl 9036616b2adSStefan Weil@findex -sdl 9045824d651Sblueswir1Enable SDL. 9055824d651Sblueswir1ETEXI 9065824d651Sblueswir1 90729b0040bSGerd HoffmannDEF("spice", HAS_ARG, QEMU_OPTION_spice, 90827af7788SYonit Halperin "-spice [port=port][,tls-port=secured-port][,x509-dir=<dir>]\n" 90927af7788SYonit Halperin " [,x509-key-file=<file>][,x509-key-password=<file>]\n" 91027af7788SYonit Halperin " [,x509-cert-file=<file>][,x509-cacert-file=<file>]\n" 91127af7788SYonit Halperin " [,x509-dh-key-file=<file>][,addr=addr][,ipv4|ipv6]\n" 91227af7788SYonit Halperin " [,tls-ciphers=<list>]\n" 91327af7788SYonit Halperin " [,tls-channel=[main|display|cursor|inputs|record|playback]]\n" 91427af7788SYonit Halperin " [,plaintext-channel=[main|display|cursor|inputs|record|playback]]\n" 91527af7788SYonit Halperin " [,sasl][,password=<secret>][,disable-ticketing]\n" 91627af7788SYonit Halperin " [,image-compression=[auto_glz|auto_lz|quic|glz|lz|off]]\n" 91727af7788SYonit Halperin " [,jpeg-wan-compression=[auto|never|always]]\n" 91827af7788SYonit Halperin " [,zlib-glz-wan-compression=[auto|never|always]]\n" 91927af7788SYonit Halperin " [,streaming-video=[off|all|filter]][,disable-copy-paste]\n" 92027af7788SYonit Halperin " [,agent-mouse=[on|off]][,playback-compression=[on|off]]\n" 92127af7788SYonit Halperin " [,seamless-migration=[on|off]]\n" 92227af7788SYonit Halperin " enable spice\n" 92327af7788SYonit Halperin " at least one of {port, tls-port} is mandatory\n", 92427af7788SYonit Halperin QEMU_ARCH_ALL) 92529b0040bSGerd HoffmannSTEXI 92629b0040bSGerd Hoffmann@item -spice @var{option}[,@var{option}[,...]] 92729b0040bSGerd Hoffmann@findex -spice 92829b0040bSGerd HoffmannEnable the spice remote desktop protocol. Valid options are 92929b0040bSGerd Hoffmann 93029b0040bSGerd Hoffmann@table @option 93129b0040bSGerd Hoffmann 93229b0040bSGerd Hoffmann@item port=<nr> 933c448e855SGerd HoffmannSet the TCP port spice is listening on for plaintext channels. 93429b0040bSGerd Hoffmann 935333b0eebSGerd Hoffmann@item addr=<addr> 936333b0eebSGerd HoffmannSet the IP address spice is listening on. Default is any address. 937333b0eebSGerd Hoffmann 938333b0eebSGerd Hoffmann@item ipv4 939333b0eebSGerd Hoffmann@item ipv6 940333b0eebSGerd HoffmannForce using the specified IP version. 941333b0eebSGerd Hoffmann 94229b0040bSGerd Hoffmann@item password=<secret> 94329b0040bSGerd HoffmannSet the password you need to authenticate. 94429b0040bSGerd Hoffmann 94548b3ed0aSMarc-André Lureau@item sasl 94648b3ed0aSMarc-André LureauRequire that the client use SASL to authenticate with the spice. 94748b3ed0aSMarc-André LureauThe exact choice of authentication method used is controlled from the 94848b3ed0aSMarc-André Lureausystem / user's SASL configuration file for the 'qemu' service. This 94948b3ed0aSMarc-André Lureauis typically found in /etc/sasl2/qemu.conf. If running QEMU as an 95048b3ed0aSMarc-André Lureauunprivileged user, an environment variable SASL_CONF_PATH can be used 95148b3ed0aSMarc-André Lureauto make it search alternate locations for the service config. 95248b3ed0aSMarc-André LureauWhile some SASL auth methods can also provide data encryption (eg GSSAPI), 95348b3ed0aSMarc-André Lureauit is recommended that SASL always be combined with the 'tls' and 95448b3ed0aSMarc-André Lureau'x509' settings to enable use of SSL and server certificates. This 95548b3ed0aSMarc-André Lureauensures a data encryption preventing compromise of authentication 95648b3ed0aSMarc-André Lureaucredentials. 95748b3ed0aSMarc-André Lureau 95829b0040bSGerd Hoffmann@item disable-ticketing 95929b0040bSGerd HoffmannAllow client connects without authentication. 96029b0040bSGerd Hoffmann 961d4970b07SHans de Goede@item disable-copy-paste 962d4970b07SHans de GoedeDisable copy paste between the client and the guest. 963d4970b07SHans de Goede 964c448e855SGerd Hoffmann@item tls-port=<nr> 965c448e855SGerd HoffmannSet the TCP port spice is listening on for encrypted channels. 966c448e855SGerd Hoffmann 967c448e855SGerd Hoffmann@item x509-dir=<dir> 968c448e855SGerd HoffmannSet the x509 file directory. Expects same filenames as -vnc $display,x509=$dir 969c448e855SGerd Hoffmann 970c448e855SGerd Hoffmann@item x509-key-file=<file> 971c448e855SGerd Hoffmann@item x509-key-password=<file> 972c448e855SGerd Hoffmann@item x509-cert-file=<file> 973c448e855SGerd Hoffmann@item x509-cacert-file=<file> 974c448e855SGerd Hoffmann@item x509-dh-key-file=<file> 975c448e855SGerd HoffmannThe x509 file names can also be configured individually. 976c448e855SGerd Hoffmann 977c448e855SGerd Hoffmann@item tls-ciphers=<list> 978c448e855SGerd HoffmannSpecify which ciphers to use. 979c448e855SGerd Hoffmann 980d70d6b31SAlon Levy@item tls-channel=[main|display|cursor|inputs|record|playback] 981d70d6b31SAlon Levy@item plaintext-channel=[main|display|cursor|inputs|record|playback] 98217b6dea0SGerd HoffmannForce specific channel to be used with or without TLS encryption. The 98317b6dea0SGerd Hoffmannoptions can be specified multiple times to configure multiple 98417b6dea0SGerd Hoffmannchannels. The special name "default" can be used to set the default 98517b6dea0SGerd Hoffmannmode. For channels which are not explicitly forced into one mode the 98617b6dea0SGerd Hoffmannspice client is allowed to pick tls/plaintext as he pleases. 98717b6dea0SGerd Hoffmann 9889f04e09eSYonit Halperin@item image-compression=[auto_glz|auto_lz|quic|glz|lz|off] 9899f04e09eSYonit HalperinConfigure image compression (lossless). 9909f04e09eSYonit HalperinDefault is auto_glz. 9919f04e09eSYonit Halperin 9929f04e09eSYonit Halperin@item jpeg-wan-compression=[auto|never|always] 9939f04e09eSYonit Halperin@item zlib-glz-wan-compression=[auto|never|always] 9949f04e09eSYonit HalperinConfigure wan image compression (lossy for slow links). 9959f04e09eSYonit HalperinDefault is auto. 9969f04e09eSYonit Halperin 99784a23f25SGerd Hoffmann@item streaming-video=[off|all|filter] 99884a23f25SGerd HoffmannConfigure video stream detection. Default is filter. 99984a23f25SGerd Hoffmann 100084a23f25SGerd Hoffmann@item agent-mouse=[on|off] 100184a23f25SGerd HoffmannEnable/disable passing mouse events via vdagent. Default is on. 100284a23f25SGerd Hoffmann 100384a23f25SGerd Hoffmann@item playback-compression=[on|off] 100484a23f25SGerd HoffmannEnable/disable audio stream compression (using celt 0.5.1). Default is on. 100584a23f25SGerd Hoffmann 10068c957053SYonit Halperin@item seamless-migration=[on|off] 10078c957053SYonit HalperinEnable/disable spice seamless migration. Default is off. 10088c957053SYonit Halperin 100929b0040bSGerd Hoffmann@end table 101029b0040bSGerd HoffmannETEXI 101129b0040bSGerd Hoffmann 10125824d651Sblueswir1DEF("portrait", 0, QEMU_OPTION_portrait, 1013ad96090aSBlue Swirl "-portrait rotate graphical output 90 deg left (only PXA LCD)\n", 1014ad96090aSBlue Swirl QEMU_ARCH_ALL) 10155824d651Sblueswir1STEXI 10165824d651Sblueswir1@item -portrait 10176616b2adSStefan Weil@findex -portrait 10185824d651Sblueswir1Rotate graphical output 90 deg left (only PXA LCD). 10195824d651Sblueswir1ETEXI 10205824d651Sblueswir1 10219312805dSVasily KhoruzhickDEF("rotate", HAS_ARG, QEMU_OPTION_rotate, 10229312805dSVasily Khoruzhick "-rotate <deg> rotate graphical output some deg left (only PXA LCD)\n", 10239312805dSVasily Khoruzhick QEMU_ARCH_ALL) 10249312805dSVasily KhoruzhickSTEXI 10256265c43bSMarkus Armbruster@item -rotate @var{deg} 10269312805dSVasily Khoruzhick@findex -rotate 10279312805dSVasily KhoruzhickRotate graphical output some deg left (only PXA LCD). 10289312805dSVasily KhoruzhickETEXI 10299312805dSVasily Khoruzhick 10305824d651Sblueswir1DEF("vga", HAS_ARG, QEMU_OPTION_vga, 1031a19cbfb3SGerd Hoffmann "-vga [std|cirrus|vmware|qxl|xenfb|none]\n" 1032ad96090aSBlue Swirl " select video card type\n", QEMU_ARCH_ALL) 10335824d651Sblueswir1STEXI 1034e4558dcaSmalc@item -vga @var{type} 10356616b2adSStefan Weil@findex -vga 10365824d651Sblueswir1Select type of VGA card to emulate. Valid values for @var{type} are 1037b3f046c2SKevin Wolf@table @option 10385824d651Sblueswir1@item cirrus 10395824d651Sblueswir1Cirrus Logic GD5446 Video card. All Windows versions starting from 10405824d651Sblueswir1Windows 95 should recognize and use this graphic card. For optimal 10415824d651Sblueswir1performances, use 16 bit color depth in the guest and the host OS. 10425824d651Sblueswir1(This one is the default) 10435824d651Sblueswir1@item std 10445824d651Sblueswir1Standard VGA card with Bochs VBE extensions. If your guest OS 10455824d651Sblueswir1supports the VESA 2.0 VBE extensions (e.g. Windows XP) and if you want 10465824d651Sblueswir1to use high resolution modes (>= 1280x1024x16) then you should use 10475824d651Sblueswir1this option. 10485824d651Sblueswir1@item vmware 10495824d651Sblueswir1VMWare SVGA-II compatible adapter. Use it if you have sufficiently 10505824d651Sblueswir1recent XFree86/XOrg server or Windows guest with a driver for this 10515824d651Sblueswir1card. 1052a19cbfb3SGerd Hoffmann@item qxl 1053a19cbfb3SGerd HoffmannQXL paravirtual graphic card. It is VGA compatible (including VESA 1054a19cbfb3SGerd Hoffmann2.0 VBE support). Works best with qxl guest drivers installed though. 1055a19cbfb3SGerd HoffmannRecommended choice when using the spice protocol. 10565824d651Sblueswir1@item none 10575824d651Sblueswir1Disable VGA card. 10585824d651Sblueswir1@end table 10595824d651Sblueswir1ETEXI 10605824d651Sblueswir1 10615824d651Sblueswir1DEF("full-screen", 0, QEMU_OPTION_full_screen, 1062ad96090aSBlue Swirl "-full-screen start in full screen\n", QEMU_ARCH_ALL) 10635824d651Sblueswir1STEXI 10645824d651Sblueswir1@item -full-screen 10656616b2adSStefan Weil@findex -full-screen 10665824d651Sblueswir1Start in full screen. 10675824d651Sblueswir1ETEXI 10685824d651Sblueswir1 10695824d651Sblueswir1DEF("g", 1, QEMU_OPTION_g , 1070ad96090aSBlue Swirl "-g WxH[xDEPTH] Set the initial graphical resolution and depth\n", 1071ad96090aSBlue Swirl QEMU_ARCH_PPC | QEMU_ARCH_SPARC) 10725824d651Sblueswir1STEXI 107395d5f08bSStefan Weil@item -g @var{width}x@var{height}[x@var{depth}] 10746616b2adSStefan Weil@findex -g 107595d5f08bSStefan WeilSet the initial graphical resolution and depth (PPC, SPARC only). 10765824d651Sblueswir1ETEXI 10775824d651Sblueswir1 10785824d651Sblueswir1DEF("vnc", HAS_ARG, QEMU_OPTION_vnc , 1079ad96090aSBlue Swirl "-vnc display start a VNC server on display\n", QEMU_ARCH_ALL) 10805824d651Sblueswir1STEXI 10815824d651Sblueswir1@item -vnc @var{display}[,@var{option}[,@var{option}[,...]]] 10826616b2adSStefan Weil@findex -vnc 10835824d651Sblueswir1Normally, QEMU uses SDL to display the VGA output. With this option, 10845824d651Sblueswir1you can have QEMU listen on VNC display @var{display} and redirect the VGA 10855824d651Sblueswir1display over the VNC session. It is very useful to enable the usb 10865824d651Sblueswir1tablet device when using this option (option @option{-usbdevice 10875824d651Sblueswir1tablet}). When using the VNC display, you must use the @option{-k} 10885824d651Sblueswir1parameter to set the keyboard layout if you are not using en-us. Valid 10895824d651Sblueswir1syntax for the @var{display} is 10905824d651Sblueswir1 1091b3f046c2SKevin Wolf@table @option 10925824d651Sblueswir1 10935824d651Sblueswir1@item @var{host}:@var{d} 10945824d651Sblueswir1 10955824d651Sblueswir1TCP connections will only be allowed from @var{host} on display @var{d}. 10965824d651Sblueswir1By convention the TCP port is 5900+@var{d}. Optionally, @var{host} can 10975824d651Sblueswir1be omitted in which case the server will accept connections from any host. 10985824d651Sblueswir1 10994e257e5eSKevin Wolf@item unix:@var{path} 11005824d651Sblueswir1 11015824d651Sblueswir1Connections will be allowed over UNIX domain sockets where @var{path} is the 11025824d651Sblueswir1location of a unix socket to listen for connections on. 11035824d651Sblueswir1 11045824d651Sblueswir1@item none 11055824d651Sblueswir1 11065824d651Sblueswir1VNC is initialized but not started. The monitor @code{change} command 11075824d651Sblueswir1can be used to later start the VNC server. 11085824d651Sblueswir1 11095824d651Sblueswir1@end table 11105824d651Sblueswir1 11115824d651Sblueswir1Following the @var{display} value there may be one or more @var{option} flags 11125824d651Sblueswir1separated by commas. Valid options are 11135824d651Sblueswir1 1114b3f046c2SKevin Wolf@table @option 11155824d651Sblueswir1 11165824d651Sblueswir1@item reverse 11175824d651Sblueswir1 11185824d651Sblueswir1Connect to a listening VNC client via a ``reverse'' connection. The 11195824d651Sblueswir1client is specified by the @var{display}. For reverse network 11205824d651Sblueswir1connections (@var{host}:@var{d},@code{reverse}), the @var{d} argument 11215824d651Sblueswir1is a TCP port number, not a display number. 11225824d651Sblueswir1 11237536ee4bSTim Hardeck@item websocket 11247536ee4bSTim Hardeck 11257536ee4bSTim HardeckOpens an additional TCP listening port dedicated to VNC Websocket connections. 1126*085d8134SPeter MaydellBy definition the Websocket port is 5700+@var{display}. If @var{host} is 11277536ee4bSTim Hardeckspecified connections will only be allowed from this host. 11287536ee4bSTim HardeckAs an alternative the Websocket port could be specified by using 11297536ee4bSTim Hardeck@code{websocket}=@var{port}. 11307536ee4bSTim Hardeck 11315824d651Sblueswir1@item password 11325824d651Sblueswir1 11335824d651Sblueswir1Require that password based authentication is used for client connections. 113486ee5bc3SMichal Novotny 113586ee5bc3SMichal NovotnyThe password must be set separately using the @code{set_password} command in 113686ee5bc3SMichal Novotnythe @ref{pcsys_monitor}. The syntax to change your password is: 113786ee5bc3SMichal Novotny@code{set_password <protocol> <password>} where <protocol> could be either 113886ee5bc3SMichal Novotny"vnc" or "spice". 113986ee5bc3SMichal Novotny 114086ee5bc3SMichal NovotnyIf you would like to change <protocol> password expiration, you should use 114186ee5bc3SMichal Novotny@code{expire_password <protocol> <expiration-time>} where expiration time could 114286ee5bc3SMichal Novotnybe one of the following options: now, never, +seconds or UNIX time of 114386ee5bc3SMichal Novotnyexpiration, e.g. +60 to make password expire in 60 seconds, or 1335196800 114486ee5bc3SMichal Novotnyto make password expire on "Mon Apr 23 12:00:00 EDT 2012" (UNIX time for this 114586ee5bc3SMichal Novotnydate and time). 114686ee5bc3SMichal Novotny 114786ee5bc3SMichal NovotnyYou can also use keywords "now" or "never" for the expiration time to 114886ee5bc3SMichal Novotnyallow <protocol> password to expire immediately or never expire. 11495824d651Sblueswir1 11505824d651Sblueswir1@item tls 11515824d651Sblueswir1 11525824d651Sblueswir1Require that client use TLS when communicating with the VNC server. This 11535824d651Sblueswir1uses anonymous TLS credentials so is susceptible to a man-in-the-middle 11545824d651Sblueswir1attack. It is recommended that this option be combined with either the 11554e257e5eSKevin Wolf@option{x509} or @option{x509verify} options. 11565824d651Sblueswir1 11575824d651Sblueswir1@item x509=@var{/path/to/certificate/dir} 11585824d651Sblueswir1 11595824d651Sblueswir1Valid if @option{tls} is specified. Require that x509 credentials are used 11605824d651Sblueswir1for negotiating the TLS session. The server will send its x509 certificate 11615824d651Sblueswir1to the client. It is recommended that a password be set on the VNC server 11625824d651Sblueswir1to provide authentication of the client when this is used. The path following 11635824d651Sblueswir1this option specifies where the x509 certificates are to be loaded from. 11645824d651Sblueswir1See the @ref{vnc_security} section for details on generating certificates. 11655824d651Sblueswir1 11665824d651Sblueswir1@item x509verify=@var{/path/to/certificate/dir} 11675824d651Sblueswir1 11685824d651Sblueswir1Valid if @option{tls} is specified. Require that x509 credentials are used 11695824d651Sblueswir1for negotiating the TLS session. The server will send its x509 certificate 11705824d651Sblueswir1to the client, and request that the client send its own x509 certificate. 11715824d651Sblueswir1The server will validate the client's certificate against the CA certificate, 11725824d651Sblueswir1and reject clients when validation fails. If the certificate authority is 11735824d651Sblueswir1trusted, this is a sufficient authentication mechanism. You may still wish 11745824d651Sblueswir1to set a password on the VNC server as a second authentication layer. The 11755824d651Sblueswir1path following this option specifies where the x509 certificates are to 11765824d651Sblueswir1be loaded from. See the @ref{vnc_security} section for details on generating 11775824d651Sblueswir1certificates. 11785824d651Sblueswir1 11795824d651Sblueswir1@item sasl 11805824d651Sblueswir1 11815824d651Sblueswir1Require that the client use SASL to authenticate with the VNC server. 11825824d651Sblueswir1The exact choice of authentication method used is controlled from the 11835824d651Sblueswir1system / user's SASL configuration file for the 'qemu' service. This 11845824d651Sblueswir1is typically found in /etc/sasl2/qemu.conf. If running QEMU as an 11855824d651Sblueswir1unprivileged user, an environment variable SASL_CONF_PATH can be used 11865824d651Sblueswir1to make it search alternate locations for the service config. 11875824d651Sblueswir1While some SASL auth methods can also provide data encryption (eg GSSAPI), 11885824d651Sblueswir1it is recommended that SASL always be combined with the 'tls' and 11895824d651Sblueswir1'x509' settings to enable use of SSL and server certificates. This 11905824d651Sblueswir1ensures a data encryption preventing compromise of authentication 11915824d651Sblueswir1credentials. See the @ref{vnc_security} section for details on using 11925824d651Sblueswir1SASL authentication. 11935824d651Sblueswir1 11945824d651Sblueswir1@item acl 11955824d651Sblueswir1 11965824d651Sblueswir1Turn on access control lists for checking of the x509 client certificate 11975824d651Sblueswir1and SASL party. For x509 certs, the ACL check is made against the 11985824d651Sblueswir1certificate's distinguished name. This is something that looks like 11995824d651Sblueswir1@code{C=GB,O=ACME,L=Boston,CN=bob}. For SASL party, the ACL check is 12005824d651Sblueswir1made against the username, which depending on the SASL plugin, may 12015824d651Sblueswir1include a realm component, eg @code{bob} or @code{bob@@EXAMPLE.COM}. 12025824d651Sblueswir1When the @option{acl} flag is set, the initial access list will be 12035824d651Sblueswir1empty, with a @code{deny} policy. Thus no one will be allowed to 12045824d651Sblueswir1use the VNC server until the ACLs have been loaded. This can be 12055824d651Sblueswir1achieved using the @code{acl} monitor command. 12065824d651Sblueswir1 12076f9c78c1SCorentin Chary@item lossy 12086f9c78c1SCorentin Chary 12096f9c78c1SCorentin CharyEnable lossy compression methods (gradient, JPEG, ...). If this 12106f9c78c1SCorentin Charyoption is set, VNC client may receive lossy framebuffer updates 12116f9c78c1SCorentin Charydepending on its encoding settings. Enabling this option can save 12126f9c78c1SCorentin Charya lot of bandwidth at the expense of quality. 12136f9c78c1SCorentin Chary 121480e0c8c3SCorentin Chary@item non-adaptive 121580e0c8c3SCorentin Chary 121680e0c8c3SCorentin CharyDisable adaptive encodings. Adaptive encodings are enabled by default. 121780e0c8c3SCorentin CharyAn adaptive encoding will try to detect frequently updated screen regions, 121880e0c8c3SCorentin Charyand send updates in these regions using a lossy encoding (like JPEG). 121961cc8701SStefan WeilThis can be really helpful to save bandwidth when playing videos. Disabling 122061cc8701SStefan Weiladaptive encodings allows to restore the original static behavior of encodings 122180e0c8c3SCorentin Charylike Tight. 122280e0c8c3SCorentin Chary 12238cf36489SGerd Hoffmann@item share=[allow-exclusive|force-shared|ignore] 12248cf36489SGerd Hoffmann 12258cf36489SGerd HoffmannSet display sharing policy. 'allow-exclusive' allows clients to ask 12268cf36489SGerd Hoffmannfor exclusive access. As suggested by the rfb spec this is 12278cf36489SGerd Hoffmannimplemented by dropping other connections. Connecting multiple 12288cf36489SGerd Hoffmannclients in parallel requires all clients asking for a shared session 12298cf36489SGerd Hoffmann(vncviewer: -shared switch). This is the default. 'force-shared' 12308cf36489SGerd Hoffmanndisables exclusive client access. Useful for shared desktop sessions, 12318cf36489SGerd Hoffmannwhere you don't want someone forgetting specify -shared disconnect 12328cf36489SGerd Hoffmanneverybody else. 'ignore' completely ignores the shared flag and 12338cf36489SGerd Hoffmannallows everybody connect unconditionally. Doesn't conform to the rfb 1234b65ee4faSStefan Weilspec but is traditional QEMU behavior. 12358cf36489SGerd Hoffmann 12365824d651Sblueswir1@end table 12375824d651Sblueswir1ETEXI 12385824d651Sblueswir1 12395824d651Sblueswir1STEXI 12405824d651Sblueswir1@end table 12415824d651Sblueswir1ETEXI 1242a3adb7adSMichael EllermanARCHHEADING(, QEMU_ARCH_I386) 12435824d651Sblueswir1 1244a3adb7adSMichael EllermanARCHHEADING(i386 target only:, QEMU_ARCH_I386) 12455824d651Sblueswir1STEXI 12465824d651Sblueswir1@table @option 12475824d651Sblueswir1ETEXI 12485824d651Sblueswir1 12495824d651Sblueswir1DEF("win2k-hack", 0, QEMU_OPTION_win2k_hack, 1250ad96090aSBlue Swirl "-win2k-hack use it when installing Windows 2000 to avoid a disk full bug\n", 1251ad96090aSBlue Swirl QEMU_ARCH_I386) 12525824d651Sblueswir1STEXI 12535824d651Sblueswir1@item -win2k-hack 12546616b2adSStefan Weil@findex -win2k-hack 12555824d651Sblueswir1Use it when installing Windows 2000 to avoid a disk full bug. After 12565824d651Sblueswir1Windows 2000 is installed, you no longer need this option (this option 12575824d651Sblueswir1slows down the IDE transfers). 12585824d651Sblueswir1ETEXI 12595824d651Sblueswir1 12601ed2fc1fSJan KiszkaHXCOMM Deprecated by -rtc 1261ad96090aSBlue SwirlDEF("rtc-td-hack", 0, QEMU_OPTION_rtc_td_hack, "", QEMU_ARCH_I386) 12625824d651Sblueswir1 12635824d651Sblueswir1DEF("no-fd-bootchk", 0, QEMU_OPTION_no_fd_bootchk, 1264ad96090aSBlue Swirl "-no-fd-bootchk disable boot signature checking for floppy disks\n", 1265ad96090aSBlue Swirl QEMU_ARCH_I386) 12665824d651Sblueswir1STEXI 12675824d651Sblueswir1@item -no-fd-bootchk 12686616b2adSStefan Weil@findex -no-fd-bootchk 12695824d651Sblueswir1Disable boot signature checking for floppy disks in Bochs BIOS. It may 12705824d651Sblueswir1be needed to boot from old floppy disks. 12716616b2adSStefan WeilTODO: check reference to Bochs BIOS. 12725824d651Sblueswir1ETEXI 12735824d651Sblueswir1 12745824d651Sblueswir1DEF("no-acpi", 0, QEMU_OPTION_no_acpi, 1275ad96090aSBlue Swirl "-no-acpi disable ACPI\n", QEMU_ARCH_I386) 12765824d651Sblueswir1STEXI 12775824d651Sblueswir1@item -no-acpi 12786616b2adSStefan Weil@findex -no-acpi 12795824d651Sblueswir1Disable ACPI (Advanced Configuration and Power Interface) support. Use 12805824d651Sblueswir1it if your guest OS complains about ACPI problems (PC target machine 12815824d651Sblueswir1only). 12825824d651Sblueswir1ETEXI 12835824d651Sblueswir1 12845824d651Sblueswir1DEF("no-hpet", 0, QEMU_OPTION_no_hpet, 1285ad96090aSBlue Swirl "-no-hpet disable HPET\n", QEMU_ARCH_I386) 12865824d651Sblueswir1STEXI 12875824d651Sblueswir1@item -no-hpet 12886616b2adSStefan Weil@findex -no-hpet 12895824d651Sblueswir1Disable HPET support. 12905824d651Sblueswir1ETEXI 12915824d651Sblueswir1 12925824d651Sblueswir1DEF("acpitable", HAS_ARG, QEMU_OPTION_acpitable, 1293104bf02eSMichael 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" 1294ad96090aSBlue Swirl " ACPI table description\n", QEMU_ARCH_I386) 12955824d651Sblueswir1STEXI 12965824d651Sblueswir1@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}]...] 12976616b2adSStefan Weil@findex -acpitable 12985824d651Sblueswir1Add ACPI table with specified header fields and context from specified files. 1299104bf02eSMichael TokarevFor file=, take whole ACPI table from the specified files, including all 1300104bf02eSMichael TokarevACPI headers (possible overridden by other options). 1301104bf02eSMichael TokarevFor data=, only data 1302104bf02eSMichael Tokarevportion of the table is used, all header information is specified in the 1303104bf02eSMichael Tokarevcommand line. 13045824d651Sblueswir1ETEXI 13055824d651Sblueswir1 1306b6f6e3d3SaliguoriDEF("smbios", HAS_ARG, QEMU_OPTION_smbios, 1307b6f6e3d3Saliguori "-smbios file=binary\n" 1308ca1a8a06SBruce Rogers " load SMBIOS entry from binary file\n" 1309e8105ebbSPaolo Bonzini "-smbios type=0[,vendor=str][,version=str][,date=str][,release=%d.%d]\n" 1310ca1a8a06SBruce Rogers " specify SMBIOS type 0 fields\n" 1311b6f6e3d3Saliguori "-smbios type=1[,manufacturer=str][,product=str][,version=str][,serial=str]\n" 1312b6f6e3d3Saliguori " [,uuid=uuid][,sku=str][,family=str]\n" 1313ad96090aSBlue Swirl " specify SMBIOS type 1 fields\n", QEMU_ARCH_I386) 1314b6f6e3d3SaliguoriSTEXI 1315b6f6e3d3Saliguori@item -smbios file=@var{binary} 13166616b2adSStefan Weil@findex -smbios 1317b6f6e3d3SaliguoriLoad SMBIOS entry from binary file. 1318b6f6e3d3Saliguori 1319b6f6e3d3Saliguori@item -smbios type=0[,vendor=@var{str}][,version=@var{str}][,date=@var{str}][,release=@var{%d.%d}] 1320b6f6e3d3SaliguoriSpecify SMBIOS type 0 fields 1321b6f6e3d3Saliguori 1322b6f6e3d3Saliguori@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}] 1323b6f6e3d3SaliguoriSpecify SMBIOS type 1 fields 1324b6f6e3d3SaliguoriETEXI 1325b6f6e3d3Saliguori 13265824d651Sblueswir1STEXI 13275824d651Sblueswir1@end table 13285824d651Sblueswir1ETEXI 1329c70a01e4SMarkus ArmbrusterDEFHEADING() 13305824d651Sblueswir1 13315824d651Sblueswir1DEFHEADING(Network options:) 13325824d651Sblueswir1STEXI 13335824d651Sblueswir1@table @option 13345824d651Sblueswir1ETEXI 13355824d651Sblueswir1 1336ad196a9dSJan KiszkaHXCOMM Legacy slirp options (now moved to -net user): 1337ad196a9dSJan Kiszka#ifdef CONFIG_SLIRP 1338ad96090aSBlue SwirlDEF("tftp", HAS_ARG, QEMU_OPTION_tftp, "", QEMU_ARCH_ALL) 1339ad96090aSBlue SwirlDEF("bootp", HAS_ARG, QEMU_OPTION_bootp, "", QEMU_ARCH_ALL) 1340ad96090aSBlue SwirlDEF("redir", HAS_ARG, QEMU_OPTION_redir, "", QEMU_ARCH_ALL) 1341ad196a9dSJan Kiszka#ifndef _WIN32 1342ad96090aSBlue SwirlDEF("smb", HAS_ARG, QEMU_OPTION_smb, "", QEMU_ARCH_ALL) 1343ad196a9dSJan Kiszka#endif 1344ad196a9dSJan Kiszka#endif 1345ad196a9dSJan Kiszka 1346bab7944cSBlue SwirlDEF("net", HAS_ARG, QEMU_OPTION_net, 1347ffe6370cSMichael S. Tsirkin "-net nic[,vlan=n][,macaddr=mac][,model=type][,name=str][,addr=str][,vectors=v]\n" 13485824d651Sblueswir1 " create a new Network Interface Card and connect it to VLAN 'n'\n" 13495824d651Sblueswir1#ifdef CONFIG_SLIRP 1350c54ed5bcSJan Kiszka "-net user[,vlan=n][,name=str][,net=addr[/mask]][,host=addr][,restrict=on|off]\n" 135163d2960bSKlaus Stengel " [,hostname=host][,dhcpstart=addr][,dns=addr][,dnssearch=domain][,tftp=dir]\n" 135263d2960bSKlaus Stengel " [,bootfile=f][,hostfwd=rule][,guestfwd=rule]" 1353ad196a9dSJan Kiszka#ifndef _WIN32 1354c92ef6a2SJan Kiszka "[,smb=dir[,smbserver=addr]]\n" 1355ad196a9dSJan Kiszka#endif 1356ad196a9dSJan Kiszka " connect the user mode network stack to VLAN 'n', configure its\n" 1357ad196a9dSJan Kiszka " DHCP server and enabled optional services\n" 13585824d651Sblueswir1#endif 13595824d651Sblueswir1#ifdef _WIN32 13605824d651Sblueswir1 "-net tap[,vlan=n][,name=str],ifname=name\n" 13615824d651Sblueswir1 " connect the host TAP network interface to VLAN 'n'\n" 13625824d651Sblueswir1#else 13632ca81baaSJason 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]\n" 1364a7c36ee4SCorey Bryant " connect the host TAP network interface to VLAN 'n'\n" 1365a7c36ee4SCorey Bryant " use network scripts 'file' (default=" DEFAULT_NETWORK_SCRIPT ")\n" 1366a7c36ee4SCorey Bryant " to configure it and 'dfile' (default=" DEFAULT_NETWORK_DOWN_SCRIPT ")\n" 1367a7c36ee4SCorey Bryant " to deconfigure it\n" 1368ca1a8a06SBruce Rogers " use '[down]script=no' to disable script execution\n" 1369a7c36ee4SCorey Bryant " use network helper 'helper' (default=" DEFAULT_BRIDGE_HELPER ") to\n" 1370a7c36ee4SCorey Bryant " configure it\n" 13715824d651Sblueswir1 " use 'fd=h' to connect to an already opened TAP interface\n" 13722ca81baaSJason Wang " use 'fds=x:y:...:z' to connect to already opened multiqueue capable TAP interfaces\n" 1373ca1a8a06SBruce Rogers " use 'sndbuf=nbytes' to limit the size of the send buffer (the\n" 1374f157ed20SMichael S. Tsirkin " default is disabled 'sndbuf=0' to enable flow control set 'sndbuf=1048576')\n" 1375ca1a8a06SBruce Rogers " use vnet_hdr=off to avoid enabling the IFF_VNET_HDR tap flag\n" 1376ca1a8a06SBruce Rogers " use vnet_hdr=on to make the lack of IFF_VNET_HDR support an error condition\n" 137782b0d80eSMichael S. Tsirkin " use vhost=on to enable experimental in kernel accelerator\n" 13785430a28fSmst@redhat.com " (only has effect for virtio guests which use MSIX)\n" 13795430a28fSmst@redhat.com " use vhostforce=on to force vhost on for non-MSIX virtio guests\n" 138082b0d80eSMichael S. Tsirkin " use 'vhostfd=h' to connect to an already opened vhost net device\n" 13812ca81baaSJason Wang " use 'vhostfds=x:y:...:z to connect to multiple already opened vhost net devices\n" 1382a7c36ee4SCorey Bryant "-net bridge[,vlan=n][,name=str][,br=bridge][,helper=helper]\n" 1383a7c36ee4SCorey Bryant " connects a host TAP network interface to a host bridge device 'br'\n" 1384a7c36ee4SCorey Bryant " (default=" DEFAULT_BRIDGE_INTERFACE ") using the program 'helper'\n" 1385a7c36ee4SCorey Bryant " (default=" DEFAULT_BRIDGE_HELPER ")\n" 13860df0ff6dSMark McLoughlin#endif 13875824d651Sblueswir1 "-net socket[,vlan=n][,name=str][,fd=h][,listen=[host]:port][,connect=host:port]\n" 13885824d651Sblueswir1 " connect the vlan 'n' to another VLAN using a socket connection\n" 13893a75e74cSMike Ryan "-net socket[,vlan=n][,name=str][,fd=h][,mcast=maddr:port[,localaddr=addr]]\n" 13905824d651Sblueswir1 " connect the vlan 'n' to multicast maddr and port\n" 13913a75e74cSMike Ryan " use 'localaddr=addr' to specify the host address to send packets from\n" 13920e0e7facSBenjamin "-net socket[,vlan=n][,name=str][,fd=h][,udp=host:port][,localaddr=host:port]\n" 13930e0e7facSBenjamin " connect the vlan 'n' to another VLAN using an UDP tunnel\n" 13945824d651Sblueswir1#ifdef CONFIG_VDE 13955824d651Sblueswir1 "-net vde[,vlan=n][,name=str][,sock=socketpath][,port=n][,group=groupname][,mode=octalmode]\n" 13965824d651Sblueswir1 " connect the vlan 'n' to port 'n' of a vde switch running\n" 13975824d651Sblueswir1 " on host and listening for incoming connections on 'socketpath'.\n" 13985824d651Sblueswir1 " Use group 'groupname' and mode 'octalmode' to change default\n" 13995824d651Sblueswir1 " ownership and permissions for communication port.\n" 14005824d651Sblueswir1#endif 1401bb9ea79eSaliguori "-net dump[,vlan=n][,file=f][,len=n]\n" 1402bb9ea79eSaliguori " dump traffic on vlan 'n' to file 'f' (max n bytes per packet)\n" 1403ca1a8a06SBruce Rogers "-net none use it alone to have zero network devices. If no -net option\n" 1404ad96090aSBlue Swirl " is provided, the default is '-net nic -net user'\n", QEMU_ARCH_ALL) 1405a1ea458fSMark McLoughlinDEF("netdev", HAS_ARG, QEMU_OPTION_netdev, 1406a1ea458fSMark McLoughlin "-netdev [" 1407a1ea458fSMark McLoughlin#ifdef CONFIG_SLIRP 1408a1ea458fSMark McLoughlin "user|" 1409a1ea458fSMark McLoughlin#endif 1410a1ea458fSMark McLoughlin "tap|" 1411a7c36ee4SCorey Bryant "bridge|" 1412a1ea458fSMark McLoughlin#ifdef CONFIG_VDE 1413a1ea458fSMark McLoughlin "vde|" 1414a1ea458fSMark McLoughlin#endif 141540e8c26dSStefan Hajnoczi "socket|" 141640e8c26dSStefan Hajnoczi "hubport],id=str[,option][,option][,...]\n", QEMU_ARCH_ALL) 14175824d651Sblueswir1STEXI 1418ffe6370cSMichael S. Tsirkin@item -net nic[,vlan=@var{n}][,macaddr=@var{mac}][,model=@var{type}] [,name=@var{name}][,addr=@var{addr}][,vectors=@var{v}] 14196616b2adSStefan Weil@findex -net 14205824d651Sblueswir1Create a new Network Interface Card and connect it to VLAN @var{n} (@var{n} 14210d6b0b1dSAnthony Liguori= 0 is the default). The NIC is an e1000 by default on the PC 14225607c388SMarkus Armbrustertarget. Optionally, the MAC address can be changed to @var{mac}, the 14235607c388SMarkus Armbrusterdevice address set to @var{addr} (PCI cards only), 1424ffe6370cSMichael S. Tsirkinand a @var{name} can be assigned for use in monitor commands. 1425ffe6370cSMichael S. TsirkinOptionally, for PCI cards, you can specify the number @var{v} of MSI-X vectors 1426ffe6370cSMichael S. Tsirkinthat the card should have; this option currently only affects virtio cards; set 1427ffe6370cSMichael S. Tsirkin@var{v} = 0 to disable MSI-X. If no @option{-net} option is specified, a single 1428071c9394SStefan WeilNIC is created. QEMU can emulate several different models of network card. 14295824d651Sblueswir1Valid values for @var{type} are 1430ffe6370cSMichael S. Tsirkin@code{virtio}, @code{i82551}, @code{i82557b}, @code{i82559er}, 14315824d651Sblueswir1@code{ne2k_pci}, @code{ne2k_isa}, @code{pcnet}, @code{rtl8139}, 14325824d651Sblueswir1@code{e1000}, @code{smc91c111}, @code{lance} and @code{mcf_fec}. 1433585f6036SPeter MaydellNot all devices are supported on all targets. Use @code{-net nic,model=help} 14345824d651Sblueswir1for a list of available devices for your target. 14355824d651Sblueswir1 143608d12022SStefan Hajnoczi@item -netdev user,id=@var{id}[,@var{option}][,@var{option}][,...] 1437b8f490ebSMarkus Armbruster@findex -netdev 1438ad196a9dSJan Kiszka@item -net user[,@var{option}][,@var{option}][,...] 14395824d651Sblueswir1Use the user mode network stack which requires no administrator 1440ad196a9dSJan Kiszkaprivilege to run. Valid options are: 14415824d651Sblueswir1 1442b3f046c2SKevin Wolf@table @option 1443ad196a9dSJan Kiszka@item vlan=@var{n} 1444ad196a9dSJan KiszkaConnect user mode stack to VLAN @var{n} (@var{n} = 0 is the default). 1445ad196a9dSJan Kiszka 144608d12022SStefan Hajnoczi@item id=@var{id} 1447ad196a9dSJan Kiszka@item name=@var{name} 1448ad196a9dSJan KiszkaAssign symbolic name for use in monitor commands. 1449ad196a9dSJan Kiszka 1450c92ef6a2SJan Kiszka@item net=@var{addr}[/@var{mask}] 1451c92ef6a2SJan KiszkaSet IP network address the guest will see. Optionally specify the netmask, 1452c92ef6a2SJan Kiszkaeither in the form a.b.c.d or as number of valid top-most bits. Default is 1453b0b36e5dSBrad Hards10.0.2.0/24. 1454c92ef6a2SJan Kiszka 1455c92ef6a2SJan Kiszka@item host=@var{addr} 1456c92ef6a2SJan KiszkaSpecify the guest-visible address of the host. Default is the 2nd IP in the 1457c92ef6a2SJan Kiszkaguest network, i.e. x.x.x.2. 1458ad196a9dSJan Kiszka 1459c54ed5bcSJan Kiszka@item restrict=on|off 1460caef55edSBrad HardsIf this option is enabled, the guest will be isolated, i.e. it will not be 1461ad196a9dSJan Kiszkaable to contact the host and no guest IP packets will be routed over the host 1462caef55edSBrad Hardsto the outside. This option does not affect any explicitly set forwarding rules. 1463ad196a9dSJan Kiszka 1464ad196a9dSJan Kiszka@item hostname=@var{name} 146563d2960bSKlaus StengelSpecifies the client hostname reported by the built-in DHCP server. 1466ad196a9dSJan Kiszka 1467c92ef6a2SJan Kiszka@item dhcpstart=@var{addr} 1468c92ef6a2SJan KiszkaSpecify the first of the 16 IPs the built-in DHCP server can assign. Default 1469b0b36e5dSBrad Hardsis the 15th to 31st IP in the guest network, i.e. x.x.x.15 to x.x.x.31. 1470c92ef6a2SJan Kiszka 1471c92ef6a2SJan Kiszka@item dns=@var{addr} 1472c92ef6a2SJan KiszkaSpecify the guest-visible address of the virtual nameserver. The address must 1473c92ef6a2SJan Kiszkabe different from the host address. Default is the 3rd IP in the guest network, 1474c92ef6a2SJan Kiszkai.e. x.x.x.3. 1475c92ef6a2SJan Kiszka 147663d2960bSKlaus Stengel@item dnssearch=@var{domain} 147763d2960bSKlaus StengelProvides an entry for the domain-search list sent by the built-in 147863d2960bSKlaus StengelDHCP server. More than one domain suffix can be transmitted by specifying 147963d2960bSKlaus Stengelthis option multiple times. If supported, this will cause the guest to 148063d2960bSKlaus Stengelautomatically try to append the given domain suffix(es) in case a domain name 148163d2960bSKlaus Stengelcan not be resolved. 148263d2960bSKlaus Stengel 148363d2960bSKlaus StengelExample: 148463d2960bSKlaus Stengel@example 148563d2960bSKlaus Stengelqemu -net user,dnssearch=mgmt.example.org,dnssearch=example.org [...] 148663d2960bSKlaus Stengel@end example 148763d2960bSKlaus Stengel 1488ad196a9dSJan Kiszka@item tftp=@var{dir} 1489ad196a9dSJan KiszkaWhen using the user mode network stack, activate a built-in TFTP 1490ad196a9dSJan Kiszkaserver. The files in @var{dir} will be exposed as the root of a TFTP server. 1491ad196a9dSJan KiszkaThe TFTP client on the guest must be configured in binary mode (use the command 1492c92ef6a2SJan Kiszka@code{bin} of the Unix TFTP client). 1493ad196a9dSJan Kiszka 1494ad196a9dSJan Kiszka@item bootfile=@var{file} 1495ad196a9dSJan KiszkaWhen using the user mode network stack, broadcast @var{file} as the BOOTP 1496ad196a9dSJan Kiszkafilename. In conjunction with @option{tftp}, this can be used to network boot 1497ad196a9dSJan Kiszkaa guest from a local directory. 1498ad196a9dSJan Kiszka 1499ad196a9dSJan KiszkaExample (using pxelinux): 1500ad196a9dSJan Kiszka@example 15013804da9dSStefan Weilqemu-system-i386 -hda linux.img -boot n -net user,tftp=/path/to/tftp/files,bootfile=/pxelinux.0 1502ad196a9dSJan Kiszka@end example 1503ad196a9dSJan Kiszka 1504c92ef6a2SJan Kiszka@item smb=@var{dir}[,smbserver=@var{addr}] 1505ad196a9dSJan KiszkaWhen using the user mode network stack, activate a built-in SMB 1506ad196a9dSJan Kiszkaserver so that Windows OSes can access to the host files in @file{@var{dir}} 1507c92ef6a2SJan Kiszkatransparently. The IP address of the SMB server can be set to @var{addr}. By 1508c92ef6a2SJan Kiszkadefault the 4th IP in the guest network is used, i.e. x.x.x.4. 1509ad196a9dSJan Kiszka 1510ad196a9dSJan KiszkaIn the guest Windows OS, the line: 1511ad196a9dSJan Kiszka@example 1512ad196a9dSJan Kiszka10.0.2.4 smbserver 1513ad196a9dSJan Kiszka@end example 1514ad196a9dSJan Kiszkamust be added in the file @file{C:\WINDOWS\LMHOSTS} (for windows 9x/Me) 1515ad196a9dSJan Kiszkaor @file{C:\WINNT\SYSTEM32\DRIVERS\ETC\LMHOSTS} (Windows NT/2000). 1516ad196a9dSJan Kiszka 1517ad196a9dSJan KiszkaThen @file{@var{dir}} can be accessed in @file{\\smbserver\qemu}. 1518ad196a9dSJan Kiszka 1519e2d8830eSBradNote that a SAMBA server must be installed on the host OS. 1520e2d8830eSBradQEMU was tested successfully with smbd versions from Red Hat 9, 1521e2d8830eSBradFedora Core 3 and OpenSUSE 11.x. 1522ad196a9dSJan Kiszka 15233c6a0580SJan Kiszka@item hostfwd=[tcp|udp]:[@var{hostaddr}]:@var{hostport}-[@var{guestaddr}]:@var{guestport} 1524c92ef6a2SJan KiszkaRedirect incoming TCP or UDP connections to the host port @var{hostport} to 1525c92ef6a2SJan Kiszkathe guest IP address @var{guestaddr} on guest port @var{guestport}. If 1526c92ef6a2SJan Kiszka@var{guestaddr} is not specified, its value is x.x.x.15 (default first address 15273c6a0580SJan Kiszkagiven by the built-in DHCP server). By specifying @var{hostaddr}, the rule can 15283c6a0580SJan Kiszkabe bound to a specific host interface. If no connection type is set, TCP is 1529c92ef6a2SJan Kiszkaused. This option can be given multiple times. 1530ad196a9dSJan Kiszka 1531ad196a9dSJan KiszkaFor example, to redirect host X11 connection from screen 1 to guest 1532ad196a9dSJan Kiszkascreen 0, use the following: 1533ad196a9dSJan Kiszka 1534ad196a9dSJan Kiszka@example 1535ad196a9dSJan Kiszka# on the host 15363804da9dSStefan Weilqemu-system-i386 -net user,hostfwd=tcp:127.0.0.1:6001-:6000 [...] 1537ad196a9dSJan Kiszka# this host xterm should open in the guest X11 server 1538ad196a9dSJan Kiszkaxterm -display :1 1539ad196a9dSJan Kiszka@end example 1540ad196a9dSJan Kiszka 1541ad196a9dSJan KiszkaTo redirect telnet connections from host port 5555 to telnet port on 1542ad196a9dSJan Kiszkathe guest, use the following: 1543ad196a9dSJan Kiszka 1544ad196a9dSJan Kiszka@example 1545ad196a9dSJan Kiszka# on the host 15463804da9dSStefan Weilqemu-system-i386 -net user,hostfwd=tcp::5555-:23 [...] 1547ad196a9dSJan Kiszkatelnet localhost 5555 1548ad196a9dSJan Kiszka@end example 1549ad196a9dSJan Kiszka 1550ad196a9dSJan KiszkaThen when you use on the host @code{telnet localhost 5555}, you 1551ad196a9dSJan Kiszkaconnect to the guest telnet server. 1552ad196a9dSJan Kiszka 1553c92ef6a2SJan Kiszka@item guestfwd=[tcp]:@var{server}:@var{port}-@var{dev} 1554b412eb61SAlexander Graf@item guestfwd=[tcp]:@var{server}:@var{port}-@var{cmd:command} 15553c6a0580SJan KiszkaForward guest TCP connections to the IP address @var{server} on port @var{port} 1556b412eb61SAlexander Grafto the character device @var{dev} or to a program executed by @var{cmd:command} 1557b412eb61SAlexander Grafwhich gets spawned for each connection. This option can be given multiple times. 1558b412eb61SAlexander Graf 155943ffe61fSStefan WeilYou can either use a chardev directly and have that one used throughout QEMU's 1560b412eb61SAlexander Graflifetime, like in the following example: 1561b412eb61SAlexander Graf 1562b412eb61SAlexander Graf@example 1563b412eb61SAlexander Graf# open 10.10.1.1:4321 on bootup, connect 10.0.2.100:1234 to it whenever 1564b412eb61SAlexander Graf# the guest accesses it 1565b412eb61SAlexander Grafqemu -net user,guestfwd=tcp:10.0.2.100:1234-tcp:10.10.1.1:4321 [...] 1566b412eb61SAlexander Graf@end example 1567b412eb61SAlexander Graf 1568b412eb61SAlexander GrafOr you can execute a command on every TCP connection established by the guest, 156943ffe61fSStefan Weilso that QEMU behaves similar to an inetd process for that virtual server: 1570b412eb61SAlexander Graf 1571b412eb61SAlexander Graf@example 1572b412eb61SAlexander Graf# call "netcat 10.10.1.1 4321" on every TCP connection to 10.0.2.100:1234 1573b412eb61SAlexander Graf# and connect the TCP stream to its stdin/stdout 1574b412eb61SAlexander Grafqemu -net 'user,guestfwd=tcp:10.0.2.100:1234-cmd:netcat 10.10.1.1 4321' 1575b412eb61SAlexander Graf@end example 1576ad196a9dSJan Kiszka 1577ad196a9dSJan Kiszka@end table 1578ad196a9dSJan Kiszka 1579ad196a9dSJan KiszkaNote: Legacy stand-alone options -tftp, -bootp, -smb and -redir are still 1580ad196a9dSJan Kiszkaprocessed and applied to -net user. Mixing them with the new configuration 1581ad196a9dSJan Kiszkasyntax gives undefined results. Their use for new applications is discouraged 1582ad196a9dSJan Kiszkaas they will be removed from future versions. 15835824d651Sblueswir1 158408d12022SStefan Hajnoczi@item -netdev tap,id=@var{id}[,fd=@var{h}][,ifname=@var{name}][,script=@var{file}][,downscript=@var{dfile}][,helper=@var{helper}] 1585a7c36ee4SCorey 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}] 1586a7c36ee4SCorey BryantConnect the host TAP network interface @var{name} to VLAN @var{n}. 1587a7c36ee4SCorey Bryant 1588a7c36ee4SCorey BryantUse the network script @var{file} to configure it and the network script 15895824d651Sblueswir1@var{dfile} to deconfigure it. If @var{name} is not provided, the OS 1590a7c36ee4SCorey Bryantautomatically provides one. The default network configure script is 1591a7c36ee4SCorey Bryant@file{/etc/qemu-ifup} and the default network deconfigure script is 1592a7c36ee4SCorey Bryant@file{/etc/qemu-ifdown}. Use @option{script=no} or @option{downscript=no} 1593a7c36ee4SCorey Bryantto disable script execution. 1594a7c36ee4SCorey Bryant 1595a7c36ee4SCorey BryantIf running QEMU as an unprivileged user, use the network helper 1596a7c36ee4SCorey Bryant@var{helper} to configure the TAP interface. The default network 1597a7c36ee4SCorey Bryanthelper executable is @file{/usr/local/libexec/qemu-bridge-helper}. 1598a7c36ee4SCorey Bryant 1599a7c36ee4SCorey Bryant@option{fd}=@var{h} can be used to specify the handle of an already 1600a7c36ee4SCorey Bryantopened host TAP interface. 1601a7c36ee4SCorey Bryant 1602a7c36ee4SCorey BryantExamples: 16035824d651Sblueswir1 16045824d651Sblueswir1@example 1605a7c36ee4SCorey Bryant#launch a QEMU instance with the default network script 16063804da9dSStefan Weilqemu-system-i386 linux.img -net nic -net tap 16075824d651Sblueswir1@end example 16085824d651Sblueswir1 16095824d651Sblueswir1@example 1610a7c36ee4SCorey Bryant#launch a QEMU instance with two NICs, each one connected 1611a7c36ee4SCorey Bryant#to a TAP device 16123804da9dSStefan Weilqemu-system-i386 linux.img \ 16133804da9dSStefan Weil -net nic,vlan=0 -net tap,vlan=0,ifname=tap0 \ 16145824d651Sblueswir1 -net nic,vlan=1 -net tap,vlan=1,ifname=tap1 16155824d651Sblueswir1@end example 16165824d651Sblueswir1 1617a7c36ee4SCorey Bryant@example 1618a7c36ee4SCorey Bryant#launch a QEMU instance with the default network helper to 1619a7c36ee4SCorey Bryant#connect a TAP device to bridge br0 16203804da9dSStefan Weilqemu-system-i386 linux.img \ 16213804da9dSStefan Weil -net nic -net tap,"helper=/usr/local/libexec/qemu-bridge-helper" 1622a7c36ee4SCorey Bryant@end example 1623a7c36ee4SCorey Bryant 162408d12022SStefan Hajnoczi@item -netdev bridge,id=@var{id}[,br=@var{bridge}][,helper=@var{helper}] 1625a7c36ee4SCorey Bryant@item -net bridge[,vlan=@var{n}][,name=@var{name}][,br=@var{bridge}][,helper=@var{helper}] 1626a7c36ee4SCorey BryantConnect a host TAP network interface to a host bridge device. 1627a7c36ee4SCorey Bryant 1628a7c36ee4SCorey BryantUse the network helper @var{helper} to configure the TAP interface and 1629a7c36ee4SCorey Bryantattach it to the bridge. The default network helper executable is 1630a7c36ee4SCorey Bryant@file{/usr/local/libexec/qemu-bridge-helper} and the default bridge 1631a7c36ee4SCorey Bryantdevice is @file{br0}. 1632a7c36ee4SCorey Bryant 1633a7c36ee4SCorey BryantExamples: 1634a7c36ee4SCorey Bryant 1635a7c36ee4SCorey Bryant@example 1636a7c36ee4SCorey Bryant#launch a QEMU instance with the default network helper to 1637a7c36ee4SCorey Bryant#connect a TAP device to bridge br0 16383804da9dSStefan Weilqemu-system-i386 linux.img -net bridge -net nic,model=virtio 1639a7c36ee4SCorey Bryant@end example 1640a7c36ee4SCorey Bryant 1641a7c36ee4SCorey Bryant@example 1642a7c36ee4SCorey Bryant#launch a QEMU instance with the default network helper to 1643a7c36ee4SCorey Bryant#connect a TAP device to bridge qemubr0 16443804da9dSStefan Weilqemu-system-i386 linux.img -net bridge,br=qemubr0 -net nic,model=virtio 1645a7c36ee4SCorey Bryant@end example 1646a7c36ee4SCorey Bryant 164708d12022SStefan Hajnoczi@item -netdev socket,id=@var{id}[,fd=@var{h}][,listen=[@var{host}]:@var{port}][,connect=@var{host}:@var{port}] 16485824d651Sblueswir1@item -net socket[,vlan=@var{n}][,name=@var{name}][,fd=@var{h}] [,listen=[@var{host}]:@var{port}][,connect=@var{host}:@var{port}] 16495824d651Sblueswir1 16505824d651Sblueswir1Connect the VLAN @var{n} to a remote VLAN in another QEMU virtual 16515824d651Sblueswir1machine using a TCP socket connection. If @option{listen} is 16525824d651Sblueswir1specified, QEMU waits for incoming connections on @var{port} 16535824d651Sblueswir1(@var{host} is optional). @option{connect} is used to connect to 16545824d651Sblueswir1another QEMU instance using the @option{listen} option. @option{fd}=@var{h} 16555824d651Sblueswir1specifies an already opened TCP socket. 16565824d651Sblueswir1 16575824d651Sblueswir1Example: 16585824d651Sblueswir1@example 16595824d651Sblueswir1# launch a first QEMU instance 16603804da9dSStefan Weilqemu-system-i386 linux.img \ 16613804da9dSStefan Weil -net nic,macaddr=52:54:00:12:34:56 \ 16625824d651Sblueswir1 -net socket,listen=:1234 16635824d651Sblueswir1# connect the VLAN 0 of this instance to the VLAN 0 16645824d651Sblueswir1# of the first instance 16653804da9dSStefan Weilqemu-system-i386 linux.img \ 16663804da9dSStefan Weil -net nic,macaddr=52:54:00:12:34:57 \ 16675824d651Sblueswir1 -net socket,connect=127.0.0.1:1234 16685824d651Sblueswir1@end example 16695824d651Sblueswir1 167008d12022SStefan Hajnoczi@item -netdev socket,id=@var{id}[,fd=@var{h}][,mcast=@var{maddr}:@var{port}[,localaddr=@var{addr}]] 16713a75e74cSMike Ryan@item -net socket[,vlan=@var{n}][,name=@var{name}][,fd=@var{h}][,mcast=@var{maddr}:@var{port}[,localaddr=@var{addr}]] 16725824d651Sblueswir1 16735824d651Sblueswir1Create a VLAN @var{n} shared with another QEMU virtual 16745824d651Sblueswir1machines using a UDP multicast socket, effectively making a bus for 16755824d651Sblueswir1every QEMU with same multicast address @var{maddr} and @var{port}. 16765824d651Sblueswir1NOTES: 16775824d651Sblueswir1@enumerate 16785824d651Sblueswir1@item 16795824d651Sblueswir1Several QEMU can be running on different hosts and share same bus (assuming 16805824d651Sblueswir1correct multicast setup for these hosts). 16815824d651Sblueswir1@item 16825824d651Sblueswir1mcast support is compatible with User Mode Linux (argument @option{eth@var{N}=mcast}), see 16835824d651Sblueswir1@url{http://user-mode-linux.sf.net}. 16845824d651Sblueswir1@item 16855824d651Sblueswir1Use @option{fd=h} to specify an already opened UDP multicast socket. 16865824d651Sblueswir1@end enumerate 16875824d651Sblueswir1 16885824d651Sblueswir1Example: 16895824d651Sblueswir1@example 16905824d651Sblueswir1# launch one QEMU instance 16913804da9dSStefan Weilqemu-system-i386 linux.img \ 16923804da9dSStefan Weil -net nic,macaddr=52:54:00:12:34:56 \ 16935824d651Sblueswir1 -net socket,mcast=230.0.0.1:1234 16945824d651Sblueswir1# launch another QEMU instance on same "bus" 16953804da9dSStefan Weilqemu-system-i386 linux.img \ 16963804da9dSStefan Weil -net nic,macaddr=52:54:00:12:34:57 \ 16975824d651Sblueswir1 -net socket,mcast=230.0.0.1:1234 16985824d651Sblueswir1# launch yet another QEMU instance on same "bus" 16993804da9dSStefan Weilqemu-system-i386 linux.img \ 17003804da9dSStefan Weil -net nic,macaddr=52:54:00:12:34:58 \ 17015824d651Sblueswir1 -net socket,mcast=230.0.0.1:1234 17025824d651Sblueswir1@end example 17035824d651Sblueswir1 17045824d651Sblueswir1Example (User Mode Linux compat.): 17055824d651Sblueswir1@example 17065824d651Sblueswir1# launch QEMU instance (note mcast address selected 17075824d651Sblueswir1# is UML's default) 17083804da9dSStefan Weilqemu-system-i386 linux.img \ 17093804da9dSStefan Weil -net nic,macaddr=52:54:00:12:34:56 \ 17105824d651Sblueswir1 -net socket,mcast=239.192.168.1:1102 17115824d651Sblueswir1# launch UML 17125824d651Sblueswir1/path/to/linux ubd0=/path/to/root_fs eth0=mcast 17135824d651Sblueswir1@end example 17145824d651Sblueswir1 17153a75e74cSMike RyanExample (send packets from host's 1.2.3.4): 17163a75e74cSMike Ryan@example 17173804da9dSStefan Weilqemu-system-i386 linux.img \ 17183804da9dSStefan Weil -net nic,macaddr=52:54:00:12:34:56 \ 17193a75e74cSMike Ryan -net socket,mcast=239.192.168.1:1102,localaddr=1.2.3.4 17203a75e74cSMike Ryan@end example 17213a75e74cSMike Ryan 172208d12022SStefan Hajnoczi@item -netdev vde,id=@var{id}[,sock=@var{socketpath}][,port=@var{n}][,group=@var{groupname}][,mode=@var{octalmode}] 17235824d651Sblueswir1@item -net vde[,vlan=@var{n}][,name=@var{name}][,sock=@var{socketpath}] [,port=@var{n}][,group=@var{groupname}][,mode=@var{octalmode}] 17245824d651Sblueswir1Connect VLAN @var{n} to PORT @var{n} of a vde switch running on host and 17255824d651Sblueswir1listening for incoming connections on @var{socketpath}. Use GROUP @var{groupname} 17265824d651Sblueswir1and MODE @var{octalmode} to change default ownership and permissions for 1727c1ba4e0bSStefan Weilcommunication port. This option is only available if QEMU has been compiled 17285824d651Sblueswir1with vde support enabled. 17295824d651Sblueswir1 17305824d651Sblueswir1Example: 17315824d651Sblueswir1@example 17325824d651Sblueswir1# launch vde switch 17335824d651Sblueswir1vde_switch -F -sock /tmp/myswitch 17345824d651Sblueswir1# launch QEMU instance 17353804da9dSStefan Weilqemu-system-i386 linux.img -net nic -net vde,sock=/tmp/myswitch 17365824d651Sblueswir1@end example 17375824d651Sblueswir1 173840e8c26dSStefan Hajnoczi@item -netdev hubport,id=@var{id},hubid=@var{hubid} 173940e8c26dSStefan Hajnoczi 174040e8c26dSStefan HajnocziCreate a hub port on QEMU "vlan" @var{hubid}. 174140e8c26dSStefan Hajnoczi 174240e8c26dSStefan HajnocziThe hubport netdev lets you connect a NIC to a QEMU "vlan" instead of a single 174340e8c26dSStefan Hajnoczinetdev. @code{-net} and @code{-device} with parameter @option{vlan} create the 174440e8c26dSStefan Hajnoczirequired hub automatically. 174540e8c26dSStefan Hajnoczi 1746bb9ea79eSaliguori@item -net dump[,vlan=@var{n}][,file=@var{file}][,len=@var{len}] 1747bb9ea79eSaliguoriDump network traffic on VLAN @var{n} to file @var{file} (@file{qemu-vlan0.pcap} by default). 1748bb9ea79eSaliguoriAt most @var{len} bytes (64k by default) per packet are stored. The file format is 1749bb9ea79eSaliguorilibpcap, so it can be analyzed with tools such as tcpdump or Wireshark. 1750bb9ea79eSaliguori 17515824d651Sblueswir1@item -net none 17525824d651Sblueswir1Indicate that no network devices should be configured. It is used to 17535824d651Sblueswir1override the default configuration (@option{-net nic -net user}) which 17545824d651Sblueswir1is activated if no @option{-net} options are provided. 17555824d651Sblueswir1ETEXI 17565824d651Sblueswir1 1757c70a01e4SMarkus ArmbrusterSTEXI 1758c70a01e4SMarkus Armbruster@end table 1759c70a01e4SMarkus ArmbrusterETEXI 17607273a2dbSMatthew BoothDEFHEADING() 17617273a2dbSMatthew Booth 17627273a2dbSMatthew BoothDEFHEADING(Character device options:) 1763c70a01e4SMarkus ArmbrusterSTEXI 1764c70a01e4SMarkus Armbruster 1765c70a01e4SMarkus ArmbrusterThe general form of a character device option is: 1766c70a01e4SMarkus Armbruster@table @option 1767c70a01e4SMarkus ArmbrusterETEXI 17687273a2dbSMatthew Booth 17697273a2dbSMatthew BoothDEF("chardev", HAS_ARG, QEMU_OPTION_chardev, 177097331287SJan Kiszka "-chardev null,id=id[,mux=on|off]\n" 17717273a2dbSMatthew Booth "-chardev socket,id=id[,host=host],port=host[,to=to][,ipv4][,ipv6][,nodelay]\n" 177297331287SJan Kiszka " [,server][,nowait][,telnet][,mux=on|off] (tcp)\n" 177397331287SJan Kiszka "-chardev socket,id=id,path=path[,server][,nowait][,telnet],[mux=on|off] (unix)\n" 17747273a2dbSMatthew Booth "-chardev udp,id=id[,host=host],port=port[,localaddr=localaddr]\n" 177597331287SJan Kiszka " [,localport=localport][,ipv4][,ipv6][,mux=on|off]\n" 177697331287SJan Kiszka "-chardev msmouse,id=id[,mux=on|off]\n" 17777273a2dbSMatthew Booth "-chardev vc,id=id[[,width=width][,height=height]][[,cols=cols][,rows=rows]]\n" 177897331287SJan Kiszka " [,mux=on|off]\n" 17793949e594SMarkus Armbruster "-chardev ringbuf,id=id[,size=size]\n" 178097331287SJan Kiszka "-chardev file,id=id,path=path[,mux=on|off]\n" 178197331287SJan Kiszka "-chardev pipe,id=id,path=path[,mux=on|off]\n" 17827273a2dbSMatthew Booth#ifdef _WIN32 178397331287SJan Kiszka "-chardev console,id=id[,mux=on|off]\n" 178497331287SJan Kiszka "-chardev serial,id=id,path=path[,mux=on|off]\n" 17857273a2dbSMatthew Booth#else 178697331287SJan Kiszka "-chardev pty,id=id[,mux=on|off]\n" 1787b7fdb3abSAurelien Jarno "-chardev stdio,id=id[,mux=on|off][,signal=on|off]\n" 17887273a2dbSMatthew Booth#endif 17897273a2dbSMatthew Booth#ifdef CONFIG_BRLAPI 179097331287SJan Kiszka "-chardev braille,id=id[,mux=on|off]\n" 17917273a2dbSMatthew Booth#endif 17927273a2dbSMatthew Booth#if defined(__linux__) || defined(__sun__) || defined(__FreeBSD__) \ 17937273a2dbSMatthew Booth || defined(__NetBSD__) || defined(__OpenBSD__) || defined(__DragonFly__) 1794d59044efSGerd Hoffmann "-chardev serial,id=id,path=path[,mux=on|off]\n" 179597331287SJan Kiszka "-chardev tty,id=id,path=path[,mux=on|off]\n" 17967273a2dbSMatthew Booth#endif 17977273a2dbSMatthew Booth#if defined(__linux__) || defined(__FreeBSD__) || defined(__DragonFly__) 179888a946d3SGerd Hoffmann "-chardev parallel,id=id,path=path[,mux=on|off]\n" 179997331287SJan Kiszka "-chardev parport,id=id,path=path[,mux=on|off]\n" 18007273a2dbSMatthew Booth#endif 1801cbcc6336SAlon Levy#if defined(CONFIG_SPICE) 1802cbcc6336SAlon Levy "-chardev spicevmc,id=id,name=name[,debug=debug]\n" 18035a49d3e9SMarc-André Lureau "-chardev spiceport,id=id,name=name[,debug=debug]\n" 1804cbcc6336SAlon Levy#endif 1805ad96090aSBlue Swirl , QEMU_ARCH_ALL 18067273a2dbSMatthew Booth) 18077273a2dbSMatthew Booth 18087273a2dbSMatthew BoothSTEXI 180997331287SJan Kiszka@item -chardev @var{backend} ,id=@var{id} [,mux=on|off] [,@var{options}] 18106616b2adSStefan Weil@findex -chardev 18117273a2dbSMatthew BoothBackend is one of: 18127273a2dbSMatthew Booth@option{null}, 18137273a2dbSMatthew Booth@option{socket}, 18147273a2dbSMatthew Booth@option{udp}, 18157273a2dbSMatthew Booth@option{msmouse}, 18167273a2dbSMatthew Booth@option{vc}, 18173949e594SMarkus Armbruster@option{ringbuf}, 18187273a2dbSMatthew Booth@option{file}, 18197273a2dbSMatthew Booth@option{pipe}, 18207273a2dbSMatthew Booth@option{console}, 18217273a2dbSMatthew Booth@option{serial}, 18227273a2dbSMatthew Booth@option{pty}, 18237273a2dbSMatthew Booth@option{stdio}, 18247273a2dbSMatthew Booth@option{braille}, 18257273a2dbSMatthew Booth@option{tty}, 182688a946d3SGerd Hoffmann@option{parallel}, 1827cbcc6336SAlon Levy@option{parport}, 1828cbcc6336SAlon Levy@option{spicevmc}. 18295a49d3e9SMarc-André Lureau@option{spiceport}. 18307273a2dbSMatthew BoothThe specific backend will determine the applicable options. 18317273a2dbSMatthew Booth 18327273a2dbSMatthew BoothAll devices must have an id, which can be any string up to 127 characters long. 18337273a2dbSMatthew BoothIt is used to uniquely identify this device in other command line directives. 18347273a2dbSMatthew Booth 183597331287SJan KiszkaA character device may be used in multiplexing mode by multiple front-ends. 183697331287SJan KiszkaThe key sequence of @key{Control-a} and @key{c} will rotate the input focus 183797331287SJan Kiszkabetween attached front-ends. Specify @option{mux=on} to enable this mode. 183897331287SJan Kiszka 18397273a2dbSMatthew BoothOptions to each backend are described below. 18407273a2dbSMatthew Booth 18417273a2dbSMatthew Booth@item -chardev null ,id=@var{id} 18427273a2dbSMatthew BoothA void device. This device will not emit any data, and will drop any data it 18437273a2dbSMatthew Boothreceives. The null backend does not take any options. 18447273a2dbSMatthew Booth 18457273a2dbSMatthew Booth@item -chardev socket ,id=@var{id} [@var{TCP options} or @var{unix options}] [,server] [,nowait] [,telnet] 18467273a2dbSMatthew Booth 18477273a2dbSMatthew BoothCreate a two-way stream socket, which can be either a TCP or a unix socket. A 18487273a2dbSMatthew Boothunix socket will be created if @option{path} is specified. Behaviour is 18497273a2dbSMatthew Boothundefined if TCP options are specified for a unix socket. 18507273a2dbSMatthew Booth 18517273a2dbSMatthew Booth@option{server} specifies that the socket shall be a listening socket. 18527273a2dbSMatthew Booth 18537273a2dbSMatthew Booth@option{nowait} specifies that QEMU should not block waiting for a client to 18547273a2dbSMatthew Boothconnect to a listening socket. 18557273a2dbSMatthew Booth 18567273a2dbSMatthew Booth@option{telnet} specifies that traffic on the socket should interpret telnet 18577273a2dbSMatthew Boothescape sequences. 18587273a2dbSMatthew Booth 18597273a2dbSMatthew BoothTCP and unix socket options are given below: 18607273a2dbSMatthew Booth 18617273a2dbSMatthew Booth@table @option 18627273a2dbSMatthew Booth 18638d533561SAurelien Jarno@item TCP options: port=@var{port} [,host=@var{host}] [,to=@var{to}] [,ipv4] [,ipv6] [,nodelay] 18647273a2dbSMatthew Booth 18657273a2dbSMatthew Booth@option{host} for a listening socket specifies the local address to be bound. 18667273a2dbSMatthew BoothFor a connecting socket species the remote host to connect to. @option{host} is 18677273a2dbSMatthew Boothoptional for listening sockets. If not specified it defaults to @code{0.0.0.0}. 18687273a2dbSMatthew Booth 18697273a2dbSMatthew Booth@option{port} for a listening socket specifies the local port to be bound. For a 18707273a2dbSMatthew Boothconnecting socket specifies the port on the remote host to connect to. 18717273a2dbSMatthew Booth@option{port} can be given as either a port number or a service name. 18727273a2dbSMatthew Booth@option{port} is required. 18737273a2dbSMatthew Booth 18747273a2dbSMatthew Booth@option{to} is only relevant to listening sockets. If it is specified, and 18757273a2dbSMatthew Booth@option{port} cannot be bound, QEMU will attempt to bind to subsequent ports up 18767273a2dbSMatthew Boothto and including @option{to} until it succeeds. @option{to} must be specified 18777273a2dbSMatthew Boothas a port number. 18787273a2dbSMatthew Booth 18797273a2dbSMatthew Booth@option{ipv4} and @option{ipv6} specify that either IPv4 or IPv6 must be used. 18807273a2dbSMatthew BoothIf neither is specified the socket may use either protocol. 18817273a2dbSMatthew Booth 18827273a2dbSMatthew Booth@option{nodelay} disables the Nagle algorithm. 18837273a2dbSMatthew Booth 18847273a2dbSMatthew Booth@item unix options: path=@var{path} 18857273a2dbSMatthew Booth 18867273a2dbSMatthew Booth@option{path} specifies the local path of the unix socket. @option{path} is 18877273a2dbSMatthew Boothrequired. 18887273a2dbSMatthew Booth 18897273a2dbSMatthew Booth@end table 18907273a2dbSMatthew Booth 18917273a2dbSMatthew Booth@item -chardev udp ,id=@var{id} [,host=@var{host}] ,port=@var{port} [,localaddr=@var{localaddr}] [,localport=@var{localport}] [,ipv4] [,ipv6] 18927273a2dbSMatthew Booth 18937273a2dbSMatthew BoothSends all traffic from the guest to a remote host over UDP. 18947273a2dbSMatthew Booth 18957273a2dbSMatthew Booth@option{host} specifies the remote host to connect to. If not specified it 18967273a2dbSMatthew Boothdefaults to @code{localhost}. 18977273a2dbSMatthew Booth 18987273a2dbSMatthew Booth@option{port} specifies the port on the remote host to connect to. @option{port} 18997273a2dbSMatthew Boothis required. 19007273a2dbSMatthew Booth 19017273a2dbSMatthew Booth@option{localaddr} specifies the local address to bind to. If not specified it 19027273a2dbSMatthew Boothdefaults to @code{0.0.0.0}. 19037273a2dbSMatthew Booth 19047273a2dbSMatthew Booth@option{localport} specifies the local port to bind to. If not specified any 19057273a2dbSMatthew Boothavailable local port will be used. 19067273a2dbSMatthew Booth 19077273a2dbSMatthew Booth@option{ipv4} and @option{ipv6} specify that either IPv4 or IPv6 must be used. 19087273a2dbSMatthew BoothIf neither is specified the device may use either protocol. 19097273a2dbSMatthew Booth 19107273a2dbSMatthew Booth@item -chardev msmouse ,id=@var{id} 19117273a2dbSMatthew Booth 19127273a2dbSMatthew BoothForward QEMU's emulated msmouse events to the guest. @option{msmouse} does not 19137273a2dbSMatthew Boothtake any options. 19147273a2dbSMatthew Booth 19157273a2dbSMatthew Booth@item -chardev vc ,id=@var{id} [[,width=@var{width}] [,height=@var{height}]] [[,cols=@var{cols}] [,rows=@var{rows}]] 19167273a2dbSMatthew Booth 19177273a2dbSMatthew BoothConnect to a QEMU text console. @option{vc} may optionally be given a specific 19187273a2dbSMatthew Boothsize. 19197273a2dbSMatthew Booth 19207273a2dbSMatthew Booth@option{width} and @option{height} specify the width and height respectively of 19217273a2dbSMatthew Booththe console, in pixels. 19227273a2dbSMatthew Booth 19237273a2dbSMatthew Booth@option{cols} and @option{rows} specify that the console be sized to fit a text 19247273a2dbSMatthew Boothconsole with the given dimensions. 19257273a2dbSMatthew Booth 19263949e594SMarkus Armbruster@item -chardev ringbuf ,id=@var{id} [,size=@var{size}] 192751767e7cSLei Li 19283949e594SMarkus ArmbrusterCreate a ring buffer with fixed size @option{size}. 19293949e594SMarkus Armbruster@var{size} must be a power of two, and defaults to @code{64K}). 193051767e7cSLei Li 19317273a2dbSMatthew Booth@item -chardev file ,id=@var{id} ,path=@var{path} 19327273a2dbSMatthew Booth 19337273a2dbSMatthew BoothLog all traffic received from the guest to a file. 19347273a2dbSMatthew Booth 19357273a2dbSMatthew Booth@option{path} specifies the path of the file to be opened. This file will be 19367273a2dbSMatthew Boothcreated if it does not already exist, and overwritten if it does. @option{path} 19377273a2dbSMatthew Boothis required. 19387273a2dbSMatthew Booth 19397273a2dbSMatthew Booth@item -chardev pipe ,id=@var{id} ,path=@var{path} 19407273a2dbSMatthew Booth 19417273a2dbSMatthew BoothCreate a two-way connection to the guest. The behaviour differs slightly between 19427273a2dbSMatthew BoothWindows hosts and other hosts: 19437273a2dbSMatthew Booth 19447273a2dbSMatthew BoothOn Windows, a single duplex pipe will be created at 19457273a2dbSMatthew Booth@file{\\.pipe\@option{path}}. 19467273a2dbSMatthew Booth 19477273a2dbSMatthew BoothOn other hosts, 2 pipes will be created called @file{@option{path}.in} and 19487273a2dbSMatthew Booth@file{@option{path}.out}. Data written to @file{@option{path}.in} will be 19497273a2dbSMatthew Boothreceived by the guest. Data written by the guest can be read from 19507273a2dbSMatthew Booth@file{@option{path}.out}. QEMU will not create these fifos, and requires them to 19517273a2dbSMatthew Boothbe present. 19527273a2dbSMatthew Booth 19537273a2dbSMatthew Booth@option{path} forms part of the pipe path as described above. @option{path} is 19547273a2dbSMatthew Boothrequired. 19557273a2dbSMatthew Booth 19567273a2dbSMatthew Booth@item -chardev console ,id=@var{id} 19577273a2dbSMatthew Booth 19587273a2dbSMatthew BoothSend traffic from the guest to QEMU's standard output. @option{console} does not 19597273a2dbSMatthew Boothtake any options. 19607273a2dbSMatthew Booth 19617273a2dbSMatthew Booth@option{console} is only available on Windows hosts. 19627273a2dbSMatthew Booth 19637273a2dbSMatthew Booth@item -chardev serial ,id=@var{id} ,path=@option{path} 19647273a2dbSMatthew Booth 19657273a2dbSMatthew BoothSend traffic from the guest to a serial device on the host. 19667273a2dbSMatthew Booth 1967d59044efSGerd HoffmannOn Unix hosts serial will actually accept any tty device, 1968d59044efSGerd Hoffmannnot only serial lines. 19697273a2dbSMatthew Booth 19707273a2dbSMatthew Booth@option{path} specifies the name of the serial device to open. 19717273a2dbSMatthew Booth 19727273a2dbSMatthew Booth@item -chardev pty ,id=@var{id} 19737273a2dbSMatthew Booth 19747273a2dbSMatthew BoothCreate a new pseudo-terminal on the host and connect to it. @option{pty} does 19757273a2dbSMatthew Boothnot take any options. 19767273a2dbSMatthew Booth 19777273a2dbSMatthew Booth@option{pty} is not available on Windows hosts. 19787273a2dbSMatthew Booth 1979b7fdb3abSAurelien Jarno@item -chardev stdio ,id=@var{id} [,signal=on|off] 1980b65ee4faSStefan WeilConnect to standard input and standard output of the QEMU process. 1981b7fdb3abSAurelien Jarno 1982b7fdb3abSAurelien Jarno@option{signal} controls if signals are enabled on the terminal, that includes 1983b7fdb3abSAurelien Jarnoexiting QEMU with the key sequence @key{Control-c}. This option is enabled by 1984b7fdb3abSAurelien Jarnodefault, use @option{signal=off} to disable it. 1985b7fdb3abSAurelien Jarno 1986b7fdb3abSAurelien Jarno@option{stdio} is not available on Windows hosts. 19877273a2dbSMatthew Booth 19887273a2dbSMatthew Booth@item -chardev braille ,id=@var{id} 19897273a2dbSMatthew Booth 19907273a2dbSMatthew BoothConnect to a local BrlAPI server. @option{braille} does not take any options. 19917273a2dbSMatthew Booth 19927273a2dbSMatthew Booth@item -chardev tty ,id=@var{id} ,path=@var{path} 19937273a2dbSMatthew Booth 19947273a2dbSMatthew Booth@option{tty} is only available on Linux, Sun, FreeBSD, NetBSD, OpenBSD and 1995d037d6bbSMarkus ArmbrusterDragonFlyBSD hosts. It is an alias for @option{serial}. 19967273a2dbSMatthew Booth 19977273a2dbSMatthew Booth@option{path} specifies the path to the tty. @option{path} is required. 19987273a2dbSMatthew Booth 199988a946d3SGerd Hoffmann@item -chardev parallel ,id=@var{id} ,path=@var{path} 20007273a2dbSMatthew Booth@item -chardev parport ,id=@var{id} ,path=@var{path} 20017273a2dbSMatthew Booth 200288a946d3SGerd Hoffmann@option{parallel} is only available on Linux, FreeBSD and DragonFlyBSD hosts. 20037273a2dbSMatthew Booth 20047273a2dbSMatthew BoothConnect to a local parallel port. 20057273a2dbSMatthew Booth 20067273a2dbSMatthew Booth@option{path} specifies the path to the parallel port device. @option{path} is 20077273a2dbSMatthew Boothrequired. 20087273a2dbSMatthew Booth 2009cbcc6336SAlon Levy@item -chardev spicevmc ,id=@var{id} ,debug=@var{debug}, name=@var{name} 2010cbcc6336SAlon Levy 20113a846906SStefan Hajnoczi@option{spicevmc} is only available when spice support is built in. 20123a846906SStefan Hajnoczi 2013cbcc6336SAlon Levy@option{debug} debug level for spicevmc 2014cbcc6336SAlon Levy 2015cbcc6336SAlon Levy@option{name} name of spice channel to connect to 2016cbcc6336SAlon Levy 2017cbcc6336SAlon LevyConnect to a spice virtual machine channel, such as vdiport. 2018cbcc6336SAlon Levy 20195a49d3e9SMarc-André Lureau@item -chardev spiceport ,id=@var{id} ,debug=@var{debug}, name=@var{name} 20205a49d3e9SMarc-André Lureau 20215a49d3e9SMarc-André Lureau@option{spiceport} is only available when spice support is built in. 20225a49d3e9SMarc-André Lureau 20235a49d3e9SMarc-André Lureau@option{debug} debug level for spicevmc 20245a49d3e9SMarc-André Lureau 20255a49d3e9SMarc-André Lureau@option{name} name of spice port to connect to 20265a49d3e9SMarc-André Lureau 20275a49d3e9SMarc-André LureauConnect to a spice port, allowing a Spice client to handle the traffic 20285a49d3e9SMarc-André Lureauidentified by a name (preferably a fqdn). 20297273a2dbSMatthew BoothETEXI 20307273a2dbSMatthew Booth 2031c70a01e4SMarkus ArmbrusterSTEXI 2032c70a01e4SMarkus Armbruster@end table 2033c70a01e4SMarkus ArmbrusterETEXI 20347273a2dbSMatthew BoothDEFHEADING() 20357273a2dbSMatthew Booth 20360f5314a2SRonnie SahlbergDEFHEADING(Device URL Syntax:) 2037c70a01e4SMarkus ArmbrusterSTEXI 20380f5314a2SRonnie Sahlberg 20390f5314a2SRonnie SahlbergIn addition to using normal file images for the emulated storage devices, 20400f5314a2SRonnie SahlbergQEMU can also use networked resources such as iSCSI devices. These are 20410f5314a2SRonnie Sahlbergspecified using a special URL syntax. 20420f5314a2SRonnie Sahlberg 20430f5314a2SRonnie Sahlberg@table @option 20440f5314a2SRonnie Sahlberg@item iSCSI 20450f5314a2SRonnie SahlbergiSCSI support allows QEMU to access iSCSI resources directly and use as 20460f5314a2SRonnie Sahlbergimages for the guest storage. Both disk and cdrom images are supported. 20470f5314a2SRonnie Sahlberg 20480f5314a2SRonnie SahlbergSyntax for specifying iSCSI LUNs is 20490f5314a2SRonnie Sahlberg``iscsi://<target-ip>[:<port>]/<target-iqn>/<lun>'' 20500f5314a2SRonnie Sahlberg 205131459f46SRonnie SahlbergBy default qemu will use the iSCSI initiator-name 205231459f46SRonnie Sahlberg'iqn.2008-11.org.linux-kvm[:<name>]' but this can also be set from the command 205331459f46SRonnie Sahlbergline or a configuration file. 205431459f46SRonnie Sahlberg 205531459f46SRonnie Sahlberg 20560f5314a2SRonnie SahlbergExample (without authentication): 20570f5314a2SRonnie Sahlberg@example 20583804da9dSStefan Weilqemu-system-i386 -iscsi initiator-name=iqn.2001-04.com.example:my-initiator \ 2059f9dadc98SRonnie Sahlberg -cdrom iscsi://192.0.2.1/iqn.2001-04.com.example/2 \ 2060f9dadc98SRonnie Sahlberg -drive file=iscsi://192.0.2.1/iqn.2001-04.com.example/1 20610f5314a2SRonnie Sahlberg@end example 20620f5314a2SRonnie Sahlberg 20630f5314a2SRonnie SahlbergExample (CHAP username/password via URL): 20640f5314a2SRonnie Sahlberg@example 20653804da9dSStefan Weilqemu-system-i386 -drive file=iscsi://user%password@@192.0.2.1/iqn.2001-04.com.example/1 20660f5314a2SRonnie Sahlberg@end example 20670f5314a2SRonnie Sahlberg 20680f5314a2SRonnie SahlbergExample (CHAP username/password via environment variables): 20690f5314a2SRonnie Sahlberg@example 20700f5314a2SRonnie SahlbergLIBISCSI_CHAP_USERNAME="user" \ 20710f5314a2SRonnie SahlbergLIBISCSI_CHAP_PASSWORD="password" \ 20723804da9dSStefan Weilqemu-system-i386 -drive file=iscsi://192.0.2.1/iqn.2001-04.com.example/1 20730f5314a2SRonnie Sahlberg@end example 20740f5314a2SRonnie Sahlberg 20750f5314a2SRonnie SahlbergiSCSI support is an optional feature of QEMU and only available when 20760f5314a2SRonnie Sahlbergcompiled and linked against libiscsi. 2077f9dadc98SRonnie SahlbergETEXI 2078f9dadc98SRonnie SahlbergDEF("iscsi", HAS_ARG, QEMU_OPTION_iscsi, 2079f9dadc98SRonnie Sahlberg "-iscsi [user=user][,password=password]\n" 2080f9dadc98SRonnie Sahlberg " [,header-digest=CRC32C|CR32C-NONE|NONE-CRC32C|NONE\n" 2081f9dadc98SRonnie Sahlberg " [,initiator-name=iqn]\n" 2082f9dadc98SRonnie Sahlberg " iSCSI session parameters\n", QEMU_ARCH_ALL) 2083f9dadc98SRonnie SahlbergSTEXI 20840f5314a2SRonnie Sahlberg 208531459f46SRonnie SahlbergiSCSI parameters such as username and password can also be specified via 208631459f46SRonnie Sahlberga configuration file. See qemu-doc for more information and examples. 208731459f46SRonnie Sahlberg 208808ae330eSRonnie Sahlberg@item NBD 208908ae330eSRonnie SahlbergQEMU supports NBD (Network Block Devices) both using TCP protocol as well 209008ae330eSRonnie Sahlbergas Unix Domain Sockets. 209108ae330eSRonnie Sahlberg 209208ae330eSRonnie SahlbergSyntax for specifying a NBD device using TCP 209308ae330eSRonnie Sahlberg``nbd:<server-ip>:<port>[:exportname=<export>]'' 209408ae330eSRonnie Sahlberg 209508ae330eSRonnie SahlbergSyntax for specifying a NBD device using Unix Domain Sockets 209608ae330eSRonnie Sahlberg``nbd:unix:<domain-socket>[:exportname=<export>]'' 209708ae330eSRonnie Sahlberg 209808ae330eSRonnie Sahlberg 209908ae330eSRonnie SahlbergExample for TCP 210008ae330eSRonnie Sahlberg@example 21013804da9dSStefan Weilqemu-system-i386 --drive file=nbd:192.0.2.1:30000 210208ae330eSRonnie Sahlberg@end example 210308ae330eSRonnie Sahlberg 210408ae330eSRonnie SahlbergExample for Unix Domain Sockets 210508ae330eSRonnie Sahlberg@example 21063804da9dSStefan Weilqemu-system-i386 --drive file=nbd:unix:/tmp/nbd-socket 210708ae330eSRonnie Sahlberg@end example 210808ae330eSRonnie Sahlberg 2109d9990228SRonnie Sahlberg@item Sheepdog 2110d9990228SRonnie SahlbergSheepdog is a distributed storage system for QEMU. 2111d9990228SRonnie SahlbergQEMU supports using either local sheepdog devices or remote networked 2112d9990228SRonnie Sahlbergdevices. 2113d9990228SRonnie Sahlberg 2114d9990228SRonnie SahlbergSyntax for specifying a sheepdog device 21155d6768e3SMORITA Kazutaka@example 21161b8bbb46SMORITA Kazutakasheepdog[+tcp|+unix]://[host:port]/vdiname[?socket=path][#snapid|#tag] 21175d6768e3SMORITA Kazutaka@end example 2118d9990228SRonnie Sahlberg 2119d9990228SRonnie SahlbergExample 2120d9990228SRonnie Sahlberg@example 21215d6768e3SMORITA Kazutakaqemu-system-i386 --drive file=sheepdog://192.0.2.1:30000/MyVirtualMachine 2122d9990228SRonnie Sahlberg@end example 2123d9990228SRonnie Sahlberg 2124d9990228SRonnie SahlbergSee also @url{http://http://www.osrg.net/sheepdog/}. 2125d9990228SRonnie Sahlberg 21268809e289SBharata B Rao@item GlusterFS 21278809e289SBharata B RaoGlusterFS is an user space distributed file system. 21288809e289SBharata B RaoQEMU supports the use of GlusterFS volumes for hosting VM disk images using 21298809e289SBharata B RaoTCP, Unix Domain Sockets and RDMA transport protocols. 21308809e289SBharata B Rao 21318809e289SBharata B RaoSyntax for specifying a VM disk image on GlusterFS volume is 21328809e289SBharata B Rao@example 21338809e289SBharata B Raogluster[+transport]://[server[:port]]/volname/image[?socket=...] 21348809e289SBharata B Rao@end example 21358809e289SBharata B Rao 21368809e289SBharata B Rao 21378809e289SBharata B RaoExample 21388809e289SBharata B Rao@example 2139db2d5ebaSLei Liqemu-system-x86_64 --drive file=gluster://192.0.2.1/testvol/a.img 21408809e289SBharata B Rao@end example 21418809e289SBharata B Rao 21428809e289SBharata B RaoSee also @url{http://www.gluster.org}. 2143c70a01e4SMarkus ArmbrusterETEXI 2144c70a01e4SMarkus Armbruster 2145c70a01e4SMarkus ArmbrusterSTEXI 21460f5314a2SRonnie Sahlberg@end table 21470f5314a2SRonnie SahlbergETEXI 21480f5314a2SRonnie Sahlberg 21497273a2dbSMatthew BoothDEFHEADING(Bluetooth(R) options:) 2150c70a01e4SMarkus ArmbrusterSTEXI 2151c70a01e4SMarkus Armbruster@table @option 2152c70a01e4SMarkus ArmbrusterETEXI 21537273a2dbSMatthew Booth 21545824d651Sblueswir1DEF("bt", HAS_ARG, QEMU_OPTION_bt, \ 21555824d651Sblueswir1 "-bt hci,null dumb bluetooth HCI - doesn't respond to commands\n" \ 21565824d651Sblueswir1 "-bt hci,host[:id]\n" \ 21575824d651Sblueswir1 " use host's HCI with the given name\n" \ 21585824d651Sblueswir1 "-bt hci[,vlan=n]\n" \ 21595824d651Sblueswir1 " emulate a standard HCI in virtual scatternet 'n'\n" \ 21605824d651Sblueswir1 "-bt vhci[,vlan=n]\n" \ 21615824d651Sblueswir1 " add host computer to virtual scatternet 'n' using VHCI\n" \ 21625824d651Sblueswir1 "-bt device:dev[,vlan=n]\n" \ 2163ad96090aSBlue Swirl " emulate a bluetooth device 'dev' in scatternet 'n'\n", 2164ad96090aSBlue Swirl QEMU_ARCH_ALL) 21655824d651Sblueswir1STEXI 21665824d651Sblueswir1@item -bt hci[...] 21676616b2adSStefan Weil@findex -bt 21685824d651Sblueswir1Defines the function of the corresponding Bluetooth HCI. -bt options 21695824d651Sblueswir1are matched with the HCIs present in the chosen machine type. For 21705824d651Sblueswir1example when emulating a machine with only one HCI built into it, only 21715824d651Sblueswir1the first @code{-bt hci[...]} option is valid and defines the HCI's 21725824d651Sblueswir1logic. The Transport Layer is decided by the machine type. Currently 21735824d651Sblueswir1the machines @code{n800} and @code{n810} have one HCI and all other 21745824d651Sblueswir1machines have none. 21755824d651Sblueswir1 21765824d651Sblueswir1@anchor{bt-hcis} 21775824d651Sblueswir1The following three types are recognized: 21785824d651Sblueswir1 2179b3f046c2SKevin Wolf@table @option 21805824d651Sblueswir1@item -bt hci,null 21815824d651Sblueswir1(default) The corresponding Bluetooth HCI assumes no internal logic 21825824d651Sblueswir1and will not respond to any HCI commands or emit events. 21835824d651Sblueswir1 21845824d651Sblueswir1@item -bt hci,host[:@var{id}] 21855824d651Sblueswir1(@code{bluez} only) The corresponding HCI passes commands / events 21865824d651Sblueswir1to / from the physical HCI identified by the name @var{id} (default: 21875824d651Sblueswir1@code{hci0}) on the computer running QEMU. Only available on @code{bluez} 21885824d651Sblueswir1capable systems like Linux. 21895824d651Sblueswir1 21905824d651Sblueswir1@item -bt hci[,vlan=@var{n}] 21915824d651Sblueswir1Add a virtual, standard HCI that will participate in the Bluetooth 21925824d651Sblueswir1scatternet @var{n} (default @code{0}). Similarly to @option{-net} 21935824d651Sblueswir1VLANs, devices inside a bluetooth network @var{n} can only communicate 21945824d651Sblueswir1with other devices in the same network (scatternet). 21955824d651Sblueswir1@end table 21965824d651Sblueswir1 21975824d651Sblueswir1@item -bt vhci[,vlan=@var{n}] 21985824d651Sblueswir1(Linux-host only) Create a HCI in scatternet @var{n} (default 0) attached 21995824d651Sblueswir1to the host bluetooth stack instead of to the emulated target. This 22005824d651Sblueswir1allows the host and target machines to participate in a common scatternet 22015824d651Sblueswir1and communicate. Requires the Linux @code{vhci} driver installed. Can 22025824d651Sblueswir1be used as following: 22035824d651Sblueswir1 22045824d651Sblueswir1@example 22053804da9dSStefan Weilqemu-system-i386 [...OPTIONS...] -bt hci,vlan=5 -bt vhci,vlan=5 22065824d651Sblueswir1@end example 22075824d651Sblueswir1 22085824d651Sblueswir1@item -bt device:@var{dev}[,vlan=@var{n}] 22095824d651Sblueswir1Emulate a bluetooth device @var{dev} and place it in network @var{n} 22105824d651Sblueswir1(default @code{0}). QEMU can only emulate one type of bluetooth devices 22115824d651Sblueswir1currently: 22125824d651Sblueswir1 2213b3f046c2SKevin Wolf@table @option 22145824d651Sblueswir1@item keyboard 22155824d651Sblueswir1Virtual wireless keyboard implementing the HIDP bluetooth profile. 22165824d651Sblueswir1@end table 22175824d651Sblueswir1ETEXI 22185824d651Sblueswir1 2219c70a01e4SMarkus ArmbrusterSTEXI 2220c70a01e4SMarkus Armbruster@end table 2221c70a01e4SMarkus ArmbrusterETEXI 22225824d651Sblueswir1DEFHEADING() 22235824d651Sblueswir1 2224d1a0cf73SStefan Berger#ifdef CONFIG_TPM 2225d1a0cf73SStefan BergerDEFHEADING(TPM device options:) 2226d1a0cf73SStefan Berger 2227d1a0cf73SStefan BergerDEF("tpmdev", HAS_ARG, QEMU_OPTION_tpmdev, \ 222892dcc234SStefan Berger "-tpmdev passthrough,id=id[,path=path][,cancel-path=path]\n" 222992dcc234SStefan Berger " use path to provide path to a character device; default is /dev/tpm0\n" 223092dcc234SStefan Berger " use cancel-path to provide path to TPM's cancel sysfs entry; if\n" 223192dcc234SStefan Berger " not provided it will be searched for in /sys/class/misc/tpm?/device\n", 2232d1a0cf73SStefan Berger QEMU_ARCH_ALL) 2233d1a0cf73SStefan BergerSTEXI 2234d1a0cf73SStefan Berger 2235d1a0cf73SStefan BergerThe general form of a TPM device option is: 2236d1a0cf73SStefan Berger@table @option 2237d1a0cf73SStefan Berger 2238d1a0cf73SStefan Berger@item -tpmdev @var{backend} ,id=@var{id} [,@var{options}] 2239d1a0cf73SStefan Berger@findex -tpmdev 2240d1a0cf73SStefan BergerBackend type must be: 22414549a8b7SStefan Berger@option{passthrough}. 2242d1a0cf73SStefan Berger 2243d1a0cf73SStefan BergerThe specific backend type will determine the applicable options. 2244d1a0cf73SStefan BergerThe @code{-tpmdev} option requires a @code{-device} option. 2245d1a0cf73SStefan Berger 2246d1a0cf73SStefan BergerOptions to each backend are described below. 2247d1a0cf73SStefan Berger 2248d1a0cf73SStefan BergerUse 'help' to print all available TPM backend types. 2249d1a0cf73SStefan Berger@example 2250d1a0cf73SStefan Bergerqemu -tpmdev help 2251d1a0cf73SStefan Berger@end example 2252d1a0cf73SStefan Berger 225392dcc234SStefan Berger@item -tpmdev passthrough, id=@var{id}, path=@var{path}, cancel-path=@var{cancel-path} 22544549a8b7SStefan Berger 22554549a8b7SStefan Berger(Linux-host only) Enable access to the host's TPM using the passthrough 22564549a8b7SStefan Bergerdriver. 22574549a8b7SStefan Berger 22584549a8b7SStefan Berger@option{path} specifies the path to the host's TPM device, i.e., on 22594549a8b7SStefan Bergera Linux host this would be @code{/dev/tpm0}. 22604549a8b7SStefan Berger@option{path} is optional and by default @code{/dev/tpm0} is used. 22614549a8b7SStefan Berger 226292dcc234SStefan Berger@option{cancel-path} specifies the path to the host TPM device's sysfs 226392dcc234SStefan Bergerentry allowing for cancellation of an ongoing TPM command. 226492dcc234SStefan Berger@option{cancel-path} is optional and by default QEMU will search for the 226592dcc234SStefan Bergersysfs entry to use. 226692dcc234SStefan Berger 22674549a8b7SStefan BergerSome notes about using the host's TPM with the passthrough driver: 22684549a8b7SStefan Berger 22694549a8b7SStefan BergerThe TPM device accessed by the passthrough driver must not be 22704549a8b7SStefan Bergerused by any other application on the host. 22714549a8b7SStefan Berger 22724549a8b7SStefan BergerSince the host's firmware (BIOS/UEFI) has already initialized the TPM, 22734549a8b7SStefan Bergerthe VM's firmware (BIOS/UEFI) will not be able to initialize the 22744549a8b7SStefan BergerTPM again and may therefore not show a TPM-specific menu that would 22754549a8b7SStefan Bergerotherwise allow the user to configure the TPM, e.g., allow the user to 22764549a8b7SStefan Bergerenable/disable or activate/deactivate the TPM. 22774549a8b7SStefan BergerFurther, if TPM ownership is released from within a VM then the host's TPM 22784549a8b7SStefan Bergerwill get disabled and deactivated. To enable and activate the 22794549a8b7SStefan BergerTPM again afterwards, the host has to be rebooted and the user is 22804549a8b7SStefan Bergerrequired to enter the firmware's menu to enable and activate the TPM. 22814549a8b7SStefan BergerIf the TPM is left disabled and/or deactivated most TPM commands will fail. 22824549a8b7SStefan Berger 22834549a8b7SStefan BergerTo create a passthrough TPM use the following two options: 22844549a8b7SStefan Berger@example 22854549a8b7SStefan Berger-tpmdev passthrough,id=tpm0 -device tpm-tis,tpmdev=tpm0 22864549a8b7SStefan Berger@end example 22874549a8b7SStefan BergerNote that the @code{-tpmdev} id is @code{tpm0} and is referenced by 22884549a8b7SStefan Berger@code{tpmdev=tpm0} in the device option. 22894549a8b7SStefan Berger 2290d1a0cf73SStefan Berger@end table 2291d1a0cf73SStefan Berger 2292d1a0cf73SStefan BergerETEXI 2293d1a0cf73SStefan Berger 2294d1a0cf73SStefan BergerDEFHEADING() 2295d1a0cf73SStefan Berger 2296d1a0cf73SStefan Berger#endif 2297d1a0cf73SStefan Berger 22987677f05dSAlexander GrafDEFHEADING(Linux/Multiboot boot specific:) 22995824d651Sblueswir1STEXI 23007677f05dSAlexander Graf 23017677f05dSAlexander GrafWhen using these options, you can use a given Linux or Multiboot 23027677f05dSAlexander Grafkernel without installing it in the disk image. It can be useful 23035824d651Sblueswir1for easier testing of various kernels. 23045824d651Sblueswir1 23055824d651Sblueswir1@table @option 23065824d651Sblueswir1ETEXI 23075824d651Sblueswir1 23085824d651Sblueswir1DEF("kernel", HAS_ARG, QEMU_OPTION_kernel, \ 2309ad96090aSBlue Swirl "-kernel bzImage use 'bzImage' as kernel image\n", QEMU_ARCH_ALL) 23105824d651Sblueswir1STEXI 23115824d651Sblueswir1@item -kernel @var{bzImage} 23126616b2adSStefan Weil@findex -kernel 23137677f05dSAlexander GrafUse @var{bzImage} as kernel image. The kernel can be either a Linux kernel 23147677f05dSAlexander Grafor in multiboot format. 23155824d651Sblueswir1ETEXI 23165824d651Sblueswir1 23175824d651Sblueswir1DEF("append", HAS_ARG, QEMU_OPTION_append, \ 2318ad96090aSBlue Swirl "-append cmdline use 'cmdline' as kernel command line\n", QEMU_ARCH_ALL) 23195824d651Sblueswir1STEXI 23205824d651Sblueswir1@item -append @var{cmdline} 23216616b2adSStefan Weil@findex -append 23225824d651Sblueswir1Use @var{cmdline} as kernel command line 23235824d651Sblueswir1ETEXI 23245824d651Sblueswir1 23255824d651Sblueswir1DEF("initrd", HAS_ARG, QEMU_OPTION_initrd, \ 2326ad96090aSBlue Swirl "-initrd file use 'file' as initial ram disk\n", QEMU_ARCH_ALL) 23275824d651Sblueswir1STEXI 23285824d651Sblueswir1@item -initrd @var{file} 23296616b2adSStefan Weil@findex -initrd 23305824d651Sblueswir1Use @var{file} as initial ram disk. 23317677f05dSAlexander Graf 23327677f05dSAlexander Graf@item -initrd "@var{file1} arg=foo,@var{file2}" 23337677f05dSAlexander Graf 23347677f05dSAlexander GrafThis syntax is only available with multiboot. 23357677f05dSAlexander Graf 23367677f05dSAlexander GrafUse @var{file1} and @var{file2} as modules and pass arg=foo as parameter to the 23377677f05dSAlexander Graffirst module. 23385824d651Sblueswir1ETEXI 23395824d651Sblueswir1 2340412beee6SGrant LikelyDEF("dtb", HAS_ARG, QEMU_OPTION_dtb, \ 2341379b5c7cSPeter A. G. Crosthwaite "-dtb file use 'file' as device tree image\n", QEMU_ARCH_ALL) 2342412beee6SGrant LikelySTEXI 2343412beee6SGrant Likely@item -dtb @var{file} 2344412beee6SGrant Likely@findex -dtb 2345412beee6SGrant LikelyUse @var{file} as a device tree binary (dtb) image and pass it to the kernel 2346412beee6SGrant Likelyon boot. 2347412beee6SGrant LikelyETEXI 2348412beee6SGrant Likely 23495824d651Sblueswir1STEXI 23505824d651Sblueswir1@end table 23515824d651Sblueswir1ETEXI 23525824d651Sblueswir1DEFHEADING() 23535824d651Sblueswir1 23545824d651Sblueswir1DEFHEADING(Debug/Expert options:) 23555824d651Sblueswir1STEXI 23565824d651Sblueswir1@table @option 23575824d651Sblueswir1ETEXI 23585824d651Sblueswir1 23595824d651Sblueswir1DEF("serial", HAS_ARG, QEMU_OPTION_serial, \ 2360ad96090aSBlue Swirl "-serial dev redirect the serial port to char device 'dev'\n", 2361ad96090aSBlue Swirl QEMU_ARCH_ALL) 23625824d651Sblueswir1STEXI 23635824d651Sblueswir1@item -serial @var{dev} 23646616b2adSStefan Weil@findex -serial 23655824d651Sblueswir1Redirect the virtual serial port to host character device 23665824d651Sblueswir1@var{dev}. The default device is @code{vc} in graphical mode and 23675824d651Sblueswir1@code{stdio} in non graphical mode. 23685824d651Sblueswir1 23695824d651Sblueswir1This option can be used several times to simulate up to 4 serial 23705824d651Sblueswir1ports. 23715824d651Sblueswir1 23725824d651Sblueswir1Use @code{-serial none} to disable all serial ports. 23735824d651Sblueswir1 23745824d651Sblueswir1Available character devices are: 2375b3f046c2SKevin Wolf@table @option 23764e257e5eSKevin Wolf@item vc[:@var{W}x@var{H}] 23775824d651Sblueswir1Virtual console. Optionally, a width and height can be given in pixel with 23785824d651Sblueswir1@example 23795824d651Sblueswir1vc:800x600 23805824d651Sblueswir1@end example 23815824d651Sblueswir1It is also possible to specify width or height in characters: 23825824d651Sblueswir1@example 23835824d651Sblueswir1vc:80Cx24C 23845824d651Sblueswir1@end example 23855824d651Sblueswir1@item pty 23865824d651Sblueswir1[Linux only] Pseudo TTY (a new PTY is automatically allocated) 23875824d651Sblueswir1@item none 23885824d651Sblueswir1No device is allocated. 23895824d651Sblueswir1@item null 23905824d651Sblueswir1void device 23915824d651Sblueswir1@item /dev/XXX 23925824d651Sblueswir1[Linux only] Use host tty, e.g. @file{/dev/ttyS0}. The host serial port 23935824d651Sblueswir1parameters are set according to the emulated ones. 23945824d651Sblueswir1@item /dev/parport@var{N} 23955824d651Sblueswir1[Linux only, parallel port only] Use host parallel port 23965824d651Sblueswir1@var{N}. Currently SPP and EPP parallel port features can be used. 23975824d651Sblueswir1@item file:@var{filename} 23985824d651Sblueswir1Write output to @var{filename}. No character can be read. 23995824d651Sblueswir1@item stdio 24005824d651Sblueswir1[Unix only] standard input/output 24015824d651Sblueswir1@item pipe:@var{filename} 24025824d651Sblueswir1name pipe @var{filename} 24035824d651Sblueswir1@item COM@var{n} 24045824d651Sblueswir1[Windows only] Use host serial port @var{n} 24055824d651Sblueswir1@item udp:[@var{remote_host}]:@var{remote_port}[@@[@var{src_ip}]:@var{src_port}] 24065824d651Sblueswir1This implements UDP Net Console. 24075824d651Sblueswir1When @var{remote_host} or @var{src_ip} are not specified 24085824d651Sblueswir1they default to @code{0.0.0.0}. 24095824d651Sblueswir1When not using a specified @var{src_port} a random port is automatically chosen. 24105824d651Sblueswir1 24115824d651Sblueswir1If you just want a simple readonly console you can use @code{netcat} or 2412b65ee4faSStefan Weil@code{nc}, by starting QEMU with: @code{-serial udp::4555} and nc as: 2413b65ee4faSStefan Weil@code{nc -u -l -p 4555}. Any time QEMU writes something to that port it 24145824d651Sblueswir1will appear in the netconsole session. 24155824d651Sblueswir1 24165824d651Sblueswir1If you plan to send characters back via netconsole or you want to stop 2417b65ee4faSStefan Weiland start QEMU a lot of times, you should have QEMU use the same 24185824d651Sblueswir1source port each time by using something like @code{-serial 2419b65ee4faSStefan Weiludp::4555@@:4556} to QEMU. Another approach is to use a patched 24205824d651Sblueswir1version of netcat which can listen to a TCP port and send and receive 24215824d651Sblueswir1characters via udp. If you have a patched version of netcat which 24225824d651Sblueswir1activates telnet remote echo and single char transfer, then you can 24235824d651Sblueswir1use the following options to step up a netcat redirector to allow 2424b65ee4faSStefan Weiltelnet on port 5555 to access the QEMU port. 24255824d651Sblueswir1@table @code 2426071c9394SStefan Weil@item QEMU Options: 24275824d651Sblueswir1-serial udp::4555@@:4556 24285824d651Sblueswir1@item netcat options: 24295824d651Sblueswir1-u -P 4555 -L 0.0.0.0:4556 -t -p 5555 -I -T 24305824d651Sblueswir1@item telnet options: 24315824d651Sblueswir1localhost 5555 24325824d651Sblueswir1@end table 24335824d651Sblueswir1 24345824d651Sblueswir1@item tcp:[@var{host}]:@var{port}[,@var{server}][,nowait][,nodelay] 24355824d651Sblueswir1The TCP Net Console has two modes of operation. It can send the serial 24365824d651Sblueswir1I/O to a location or wait for a connection from a location. By default 24375824d651Sblueswir1the TCP Net Console is sent to @var{host} at the @var{port}. If you use 24385824d651Sblueswir1the @var{server} option QEMU will wait for a client socket application 24395824d651Sblueswir1to connect to the port before continuing, unless the @code{nowait} 24405824d651Sblueswir1option was specified. The @code{nodelay} option disables the Nagle buffering 24415824d651Sblueswir1algorithm. If @var{host} is omitted, 0.0.0.0 is assumed. Only 24425824d651Sblueswir1one TCP connection at a time is accepted. You can use @code{telnet} to 24435824d651Sblueswir1connect to the corresponding character device. 24445824d651Sblueswir1@table @code 24455824d651Sblueswir1@item Example to send tcp console to 192.168.0.2 port 4444 24465824d651Sblueswir1-serial tcp:192.168.0.2:4444 24475824d651Sblueswir1@item Example to listen and wait on port 4444 for connection 24485824d651Sblueswir1-serial tcp::4444,server 24495824d651Sblueswir1@item Example to not wait and listen on ip 192.168.0.100 port 4444 24505824d651Sblueswir1-serial tcp:192.168.0.100:4444,server,nowait 24515824d651Sblueswir1@end table 24525824d651Sblueswir1 24535824d651Sblueswir1@item telnet:@var{host}:@var{port}[,server][,nowait][,nodelay] 24545824d651Sblueswir1The telnet protocol is used instead of raw tcp sockets. The options 24555824d651Sblueswir1work the same as if you had specified @code{-serial tcp}. The 24565824d651Sblueswir1difference is that the port acts like a telnet server or client using 24575824d651Sblueswir1telnet option negotiation. This will also allow you to send the 24585824d651Sblueswir1MAGIC_SYSRQ sequence if you use a telnet that supports sending the break 24595824d651Sblueswir1sequence. Typically in unix telnet you do it with Control-] and then 24605824d651Sblueswir1type "send break" followed by pressing the enter key. 24615824d651Sblueswir1 24625824d651Sblueswir1@item unix:@var{path}[,server][,nowait] 24635824d651Sblueswir1A unix domain socket is used instead of a tcp socket. The option works the 24645824d651Sblueswir1same as if you had specified @code{-serial tcp} except the unix domain socket 24655824d651Sblueswir1@var{path} is used for connections. 24665824d651Sblueswir1 24675824d651Sblueswir1@item mon:@var{dev_string} 24685824d651Sblueswir1This is a special option to allow the monitor to be multiplexed onto 24695824d651Sblueswir1another serial port. The monitor is accessed with key sequence of 24705824d651Sblueswir1@key{Control-a} and then pressing @key{c}. See monitor access 24715824d651Sblueswir1@ref{pcsys_keys} in the -nographic section for more keys. 24725824d651Sblueswir1@var{dev_string} should be any one of the serial devices specified 24735824d651Sblueswir1above. An example to multiplex the monitor onto a telnet server 24745824d651Sblueswir1listening on port 4444 would be: 24755824d651Sblueswir1@table @code 24765824d651Sblueswir1@item -serial mon:telnet::4444,server,nowait 24775824d651Sblueswir1@end table 24785824d651Sblueswir1 24795824d651Sblueswir1@item braille 24805824d651Sblueswir1Braille device. This will use BrlAPI to display the braille output on a real 24815824d651Sblueswir1or fake device. 24825824d651Sblueswir1 2483be8b28a9SKevin Wolf@item msmouse 2484be8b28a9SKevin WolfThree button serial mouse. Configure the guest to use Microsoft protocol. 24855824d651Sblueswir1@end table 24865824d651Sblueswir1ETEXI 24875824d651Sblueswir1 24885824d651Sblueswir1DEF("parallel", HAS_ARG, QEMU_OPTION_parallel, \ 2489ad96090aSBlue Swirl "-parallel dev redirect the parallel port to char device 'dev'\n", 2490ad96090aSBlue Swirl QEMU_ARCH_ALL) 24915824d651Sblueswir1STEXI 24925824d651Sblueswir1@item -parallel @var{dev} 24936616b2adSStefan Weil@findex -parallel 24945824d651Sblueswir1Redirect the virtual parallel port to host device @var{dev} (same 24955824d651Sblueswir1devices as the serial port). On Linux hosts, @file{/dev/parportN} can 24965824d651Sblueswir1be used to use hardware devices connected on the corresponding host 24975824d651Sblueswir1parallel port. 24985824d651Sblueswir1 24995824d651Sblueswir1This option can be used several times to simulate up to 3 parallel 25005824d651Sblueswir1ports. 25015824d651Sblueswir1 25025824d651Sblueswir1Use @code{-parallel none} to disable all parallel ports. 25035824d651Sblueswir1ETEXI 25045824d651Sblueswir1 25055824d651Sblueswir1DEF("monitor", HAS_ARG, QEMU_OPTION_monitor, \ 2506ad96090aSBlue Swirl "-monitor dev redirect the monitor to char device 'dev'\n", 2507ad96090aSBlue Swirl QEMU_ARCH_ALL) 25085824d651Sblueswir1STEXI 25094e307fc8SGerd Hoffmann@item -monitor @var{dev} 25106616b2adSStefan Weil@findex -monitor 25115824d651Sblueswir1Redirect the monitor to host device @var{dev} (same devices as the 25125824d651Sblueswir1serial port). 25135824d651Sblueswir1The default device is @code{vc} in graphical mode and @code{stdio} in 25145824d651Sblueswir1non graphical mode. 25155824d651Sblueswir1ETEXI 25166ca5582dSGerd HoffmannDEF("qmp", HAS_ARG, QEMU_OPTION_qmp, \ 2517ad96090aSBlue Swirl "-qmp dev like -monitor but opens in 'control' mode\n", 2518ad96090aSBlue Swirl QEMU_ARCH_ALL) 251995d5f08bSStefan WeilSTEXI 252095d5f08bSStefan Weil@item -qmp @var{dev} 25216616b2adSStefan Weil@findex -qmp 252295d5f08bSStefan WeilLike -monitor but opens in 'control' mode. 252395d5f08bSStefan WeilETEXI 25245824d651Sblueswir1 252522a0e04bSGerd HoffmannDEF("mon", HAS_ARG, QEMU_OPTION_mon, \ 2526ad96090aSBlue Swirl "-mon chardev=[name][,mode=readline|control][,default]\n", QEMU_ARCH_ALL) 252722a0e04bSGerd HoffmannSTEXI 252822a0e04bSGerd Hoffmann@item -mon chardev=[name][,mode=readline|control][,default] 25296616b2adSStefan Weil@findex -mon 253022a0e04bSGerd HoffmannSetup monitor on chardev @var{name}. 253122a0e04bSGerd HoffmannETEXI 253222a0e04bSGerd Hoffmann 2533c9f398e5SH. Peter AnvinDEF("debugcon", HAS_ARG, QEMU_OPTION_debugcon, \ 2534ad96090aSBlue Swirl "-debugcon dev redirect the debug console to char device 'dev'\n", 2535ad96090aSBlue Swirl QEMU_ARCH_ALL) 2536c9f398e5SH. Peter AnvinSTEXI 2537c9f398e5SH. Peter Anvin@item -debugcon @var{dev} 25386616b2adSStefan Weil@findex -debugcon 2539c9f398e5SH. Peter AnvinRedirect the debug console to host device @var{dev} (same devices as the 2540c9f398e5SH. Peter Anvinserial port). The debug console is an I/O port which is typically port 2541c9f398e5SH. Peter Anvin0xe9; writing to that I/O port sends output to this device. 2542c9f398e5SH. Peter AnvinThe default device is @code{vc} in graphical mode and @code{stdio} in 2543c9f398e5SH. Peter Anvinnon graphical mode. 2544c9f398e5SH. Peter AnvinETEXI 2545c9f398e5SH. Peter Anvin 25465824d651Sblueswir1DEF("pidfile", HAS_ARG, QEMU_OPTION_pidfile, \ 2547ad96090aSBlue Swirl "-pidfile file write PID to 'file'\n", QEMU_ARCH_ALL) 25485824d651Sblueswir1STEXI 25495824d651Sblueswir1@item -pidfile @var{file} 25506616b2adSStefan Weil@findex -pidfile 25515824d651Sblueswir1Store the QEMU process PID in @var{file}. It is useful if you launch QEMU 25525824d651Sblueswir1from a script. 25535824d651Sblueswir1ETEXI 25545824d651Sblueswir1 25551b530a6dSaurel32DEF("singlestep", 0, QEMU_OPTION_singlestep, \ 2556ad96090aSBlue Swirl "-singlestep always run in singlestep mode\n", QEMU_ARCH_ALL) 25571b530a6dSaurel32STEXI 25581b530a6dSaurel32@item -singlestep 25596616b2adSStefan Weil@findex -singlestep 25601b530a6dSaurel32Run the emulation in single step mode. 25611b530a6dSaurel32ETEXI 25621b530a6dSaurel32 25635824d651Sblueswir1DEF("S", 0, QEMU_OPTION_S, \ 2564ad96090aSBlue Swirl "-S freeze CPU at startup (use 'c' to start execution)\n", 2565ad96090aSBlue Swirl QEMU_ARCH_ALL) 25665824d651Sblueswir1STEXI 25675824d651Sblueswir1@item -S 25686616b2adSStefan Weil@findex -S 25695824d651Sblueswir1Do not start CPU at startup (you must type 'c' in the monitor). 25705824d651Sblueswir1ETEXI 25715824d651Sblueswir1 257259030a8cSaliguoriDEF("gdb", HAS_ARG, QEMU_OPTION_gdb, \ 2573ad96090aSBlue Swirl "-gdb dev wait for gdb connection on 'dev'\n", QEMU_ARCH_ALL) 25745824d651Sblueswir1STEXI 257559030a8cSaliguori@item -gdb @var{dev} 25766616b2adSStefan Weil@findex -gdb 257759030a8cSaliguoriWait for gdb connection on device @var{dev} (@pxref{gdb_usage}). Typical 257859030a8cSaliguoriconnections will likely be TCP-based, but also UDP, pseudo TTY, or even 2579b65ee4faSStefan Weilstdio are reasonable use case. The latter is allowing to start QEMU from 258059030a8cSaliguoriwithin gdb and establish the connection via a pipe: 258159030a8cSaliguori@example 25823804da9dSStefan Weil(gdb) target remote | exec qemu-system-i386 -gdb stdio ... 258359030a8cSaliguori@end example 25845824d651Sblueswir1ETEXI 25855824d651Sblueswir1 258659030a8cSaliguoriDEF("s", 0, QEMU_OPTION_s, \ 2587ad96090aSBlue Swirl "-s shorthand for -gdb tcp::" DEFAULT_GDBSTUB_PORT "\n", 2588ad96090aSBlue Swirl QEMU_ARCH_ALL) 25895824d651Sblueswir1STEXI 259059030a8cSaliguori@item -s 25916616b2adSStefan Weil@findex -s 259259030a8cSaliguoriShorthand for -gdb tcp::1234, i.e. open a gdbserver on TCP port 1234 259359030a8cSaliguori(@pxref{gdb_usage}). 25945824d651Sblueswir1ETEXI 25955824d651Sblueswir1 25965824d651Sblueswir1DEF("d", HAS_ARG, QEMU_OPTION_d, \ 2597989b697dSPeter Maydell "-d item1,... enable logging of specified items (use '-d help' for a list of log items)\n", 2598ad96090aSBlue Swirl QEMU_ARCH_ALL) 25995824d651Sblueswir1STEXI 2600989b697dSPeter Maydell@item -d @var{item1}[,...] 26016616b2adSStefan Weil@findex -d 2602989b697dSPeter MaydellEnable logging of specified items. Use '-d help' for a list of log items. 26035824d651Sblueswir1ETEXI 26045824d651Sblueswir1 2605c235d738SMatthew FernandezDEF("D", HAS_ARG, QEMU_OPTION_D, \ 2606989b697dSPeter Maydell "-D logfile output log to logfile (default stderr)\n", 2607c235d738SMatthew Fernandez QEMU_ARCH_ALL) 2608c235d738SMatthew FernandezSTEXI 26098bd383b4SStefan Weil@item -D @var{logfile} 2610c235d738SMatthew Fernandez@findex -D 2611989b697dSPeter MaydellOutput log in @var{logfile} instead of to stderr 2612c235d738SMatthew FernandezETEXI 2613c235d738SMatthew Fernandez 26145824d651Sblueswir1DEF("L", HAS_ARG, QEMU_OPTION_L, \ 2615ad96090aSBlue Swirl "-L path set the directory for the BIOS, VGA BIOS and keymaps\n", 2616ad96090aSBlue Swirl QEMU_ARCH_ALL) 26175824d651Sblueswir1STEXI 26185824d651Sblueswir1@item -L @var{path} 26196616b2adSStefan Weil@findex -L 26205824d651Sblueswir1Set the directory for the BIOS, VGA BIOS and keymaps. 26215824d651Sblueswir1ETEXI 26225824d651Sblueswir1 26235824d651Sblueswir1DEF("bios", HAS_ARG, QEMU_OPTION_bios, \ 2624ad96090aSBlue Swirl "-bios file set the filename for the BIOS\n", QEMU_ARCH_ALL) 26255824d651Sblueswir1STEXI 26265824d651Sblueswir1@item -bios @var{file} 26276616b2adSStefan Weil@findex -bios 26285824d651Sblueswir1Set the filename for the BIOS. 26295824d651Sblueswir1ETEXI 26305824d651Sblueswir1 26315824d651Sblueswir1DEF("enable-kvm", 0, QEMU_OPTION_enable_kvm, \ 2632ad96090aSBlue Swirl "-enable-kvm enable KVM full virtualization support\n", QEMU_ARCH_ALL) 26335824d651Sblueswir1STEXI 26345824d651Sblueswir1@item -enable-kvm 26356616b2adSStefan Weil@findex -enable-kvm 26365824d651Sblueswir1Enable KVM full virtualization support. This option is only available 26375824d651Sblueswir1if KVM support is enabled when compiling. 26385824d651Sblueswir1ETEXI 26395824d651Sblueswir1 2640e37630caSaliguoriDEF("xen-domid", HAS_ARG, QEMU_OPTION_xen_domid, 2641ad96090aSBlue Swirl "-xen-domid id specify xen guest domain id\n", QEMU_ARCH_ALL) 2642e37630caSaliguoriDEF("xen-create", 0, QEMU_OPTION_xen_create, 2643e37630caSaliguori "-xen-create create domain using xen hypercalls, bypassing xend\n" 2644ad96090aSBlue Swirl " warning: should not be used when xend is in use\n", 2645ad96090aSBlue Swirl QEMU_ARCH_ALL) 2646e37630caSaliguoriDEF("xen-attach", 0, QEMU_OPTION_xen_attach, 2647e37630caSaliguori "-xen-attach attach to existing xen domain\n" 2648b65ee4faSStefan Weil " xend will use this when starting QEMU\n", 2649ad96090aSBlue Swirl QEMU_ARCH_ALL) 265095d5f08bSStefan WeilSTEXI 265195d5f08bSStefan Weil@item -xen-domid @var{id} 26526616b2adSStefan Weil@findex -xen-domid 265395d5f08bSStefan WeilSpecify xen guest domain @var{id} (XEN only). 265495d5f08bSStefan Weil@item -xen-create 26556616b2adSStefan Weil@findex -xen-create 265695d5f08bSStefan WeilCreate domain using xen hypercalls, bypassing xend. 265795d5f08bSStefan WeilWarning: should not be used when xend is in use (XEN only). 265895d5f08bSStefan Weil@item -xen-attach 26596616b2adSStefan Weil@findex -xen-attach 266095d5f08bSStefan WeilAttach to existing xen domain. 2661b65ee4faSStefan Weilxend will use this when starting QEMU (XEN only). 266295d5f08bSStefan WeilETEXI 2663e37630caSaliguori 26645824d651Sblueswir1DEF("no-reboot", 0, QEMU_OPTION_no_reboot, \ 2665ad96090aSBlue Swirl "-no-reboot exit instead of rebooting\n", QEMU_ARCH_ALL) 26665824d651Sblueswir1STEXI 26675824d651Sblueswir1@item -no-reboot 26686616b2adSStefan Weil@findex -no-reboot 26695824d651Sblueswir1Exit instead of rebooting. 26705824d651Sblueswir1ETEXI 26715824d651Sblueswir1 26725824d651Sblueswir1DEF("no-shutdown", 0, QEMU_OPTION_no_shutdown, \ 2673ad96090aSBlue Swirl "-no-shutdown stop before shutdown\n", QEMU_ARCH_ALL) 26745824d651Sblueswir1STEXI 26755824d651Sblueswir1@item -no-shutdown 26766616b2adSStefan Weil@findex -no-shutdown 26775824d651Sblueswir1Don't exit QEMU on guest shutdown, but instead only stop the emulation. 26785824d651Sblueswir1This allows for instance switching to monitor to commit changes to the 26795824d651Sblueswir1disk image. 26805824d651Sblueswir1ETEXI 26815824d651Sblueswir1 26825824d651Sblueswir1DEF("loadvm", HAS_ARG, QEMU_OPTION_loadvm, \ 26835824d651Sblueswir1 "-loadvm [tag|id]\n" \ 2684ad96090aSBlue Swirl " start right away with a saved state (loadvm in monitor)\n", 2685ad96090aSBlue Swirl QEMU_ARCH_ALL) 26865824d651Sblueswir1STEXI 26875824d651Sblueswir1@item -loadvm @var{file} 26886616b2adSStefan Weil@findex -loadvm 26895824d651Sblueswir1Start right away with a saved state (@code{loadvm} in monitor) 26905824d651Sblueswir1ETEXI 26915824d651Sblueswir1 26925824d651Sblueswir1#ifndef _WIN32 26935824d651Sblueswir1DEF("daemonize", 0, QEMU_OPTION_daemonize, \ 2694ad96090aSBlue Swirl "-daemonize daemonize QEMU after initializing\n", QEMU_ARCH_ALL) 26955824d651Sblueswir1#endif 26965824d651Sblueswir1STEXI 26975824d651Sblueswir1@item -daemonize 26986616b2adSStefan Weil@findex -daemonize 26995824d651Sblueswir1Daemonize the QEMU process after initialization. QEMU will not detach from 27005824d651Sblueswir1standard IO until it is ready to receive connections on any of its devices. 27015824d651Sblueswir1This option is a useful way for external programs to launch QEMU without having 27025824d651Sblueswir1to cope with initialization race conditions. 27035824d651Sblueswir1ETEXI 27045824d651Sblueswir1 27055824d651Sblueswir1DEF("option-rom", HAS_ARG, QEMU_OPTION_option_rom, \ 2706ad96090aSBlue Swirl "-option-rom rom load a file, rom, into the option ROM space\n", 2707ad96090aSBlue Swirl QEMU_ARCH_ALL) 27085824d651Sblueswir1STEXI 27095824d651Sblueswir1@item -option-rom @var{file} 27106616b2adSStefan Weil@findex -option-rom 27115824d651Sblueswir1Load the contents of @var{file} as an option ROM. 27125824d651Sblueswir1This option is useful to load things like EtherBoot. 27135824d651Sblueswir1ETEXI 27145824d651Sblueswir1 27155824d651Sblueswir1DEF("clock", HAS_ARG, QEMU_OPTION_clock, \ 27165824d651Sblueswir1 "-clock force the use of the given methods for timer alarm.\n" \ 2717585f6036SPeter Maydell " To see what timers are available use '-clock help'\n", 2718ad96090aSBlue Swirl QEMU_ARCH_ALL) 27195824d651Sblueswir1STEXI 27205824d651Sblueswir1@item -clock @var{method} 27216616b2adSStefan Weil@findex -clock 27225824d651Sblueswir1Force the use of the given methods for timer alarm. To see what timers 2723585f6036SPeter Maydellare available use @code{-clock help}. 27245824d651Sblueswir1ETEXI 27255824d651Sblueswir1 27261ed2fc1fSJan KiszkaHXCOMM Options deprecated by -rtc 2727ad96090aSBlue SwirlDEF("localtime", 0, QEMU_OPTION_localtime, "", QEMU_ARCH_ALL) 2728ad96090aSBlue SwirlDEF("startdate", HAS_ARG, QEMU_OPTION_startdate, "", QEMU_ARCH_ALL) 27295824d651Sblueswir1 27301ed2fc1fSJan KiszkaDEF("rtc", HAS_ARG, QEMU_OPTION_rtc, \ 273178808141SPaolo Bonzini "-rtc [base=utc|localtime|date][,clock=host|rt|vm][,driftfix=none|slew]\n" \ 2732ad96090aSBlue Swirl " set the RTC base and clock, enable drift fix for clock ticks (x86 only)\n", 2733ad96090aSBlue Swirl QEMU_ARCH_ALL) 27341ed2fc1fSJan Kiszka 27355824d651Sblueswir1STEXI 27365824d651Sblueswir1 27376875204cSJan Kiszka@item -rtc [base=utc|localtime|@var{date}][,clock=host|vm][,driftfix=none|slew] 27386616b2adSStefan Weil@findex -rtc 27391ed2fc1fSJan KiszkaSpecify @option{base} as @code{utc} or @code{localtime} to let the RTC start at the current 27401ed2fc1fSJan KiszkaUTC or local time, respectively. @code{localtime} is required for correct date in 27411ed2fc1fSJan KiszkaMS-DOS or Windows. To start at a specific point in time, provide @var{date} in the 27421ed2fc1fSJan Kiszkaformat @code{2006-06-17T16:01:21} or @code{2006-06-17}. The default base is UTC. 27431ed2fc1fSJan Kiszka 27446875204cSJan KiszkaBy default the RTC is driven by the host system time. This allows to use the 27456875204cSJan KiszkaRTC as accurate reference clock inside the guest, specifically if the host 27466875204cSJan Kiszkatime is smoothly following an accurate external reference clock, e.g. via NTP. 274778808141SPaolo BonziniIf you want to isolate the guest time from the host, you can set @option{clock} 274878808141SPaolo Bonzinito @code{rt} instead. To even prevent it from progressing during suspension, 274978808141SPaolo Bonziniyou can set it to @code{vm}. 27506875204cSJan Kiszka 27511ed2fc1fSJan KiszkaEnable @option{driftfix} (i386 targets only) if you experience time drift problems, 27521ed2fc1fSJan Kiszkaspecifically with Windows' ACPI HAL. This option will try to figure out how 27531ed2fc1fSJan Kiszkamany timer interrupts were not processed by the Windows guest and will 27541ed2fc1fSJan Kiszkare-inject them. 27555824d651Sblueswir1ETEXI 27565824d651Sblueswir1 27575824d651Sblueswir1DEF("icount", HAS_ARG, QEMU_OPTION_icount, \ 27585824d651Sblueswir1 "-icount [N|auto]\n" \ 2759bc14ca24Saliguori " enable virtual instruction counter with 2^N clock ticks per\n" \ 2760ad96090aSBlue Swirl " instruction\n", QEMU_ARCH_ALL) 27615824d651Sblueswir1STEXI 27624e257e5eSKevin Wolf@item -icount [@var{N}|auto] 27636616b2adSStefan Weil@findex -icount 27645824d651Sblueswir1Enable virtual instruction counter. The virtual cpu will execute one 27654e257e5eSKevin Wolfinstruction every 2^@var{N} ns of virtual time. If @code{auto} is specified 27665824d651Sblueswir1then the virtual cpu speed will be automatically adjusted to keep virtual 27675824d651Sblueswir1time within a few seconds of real time. 27685824d651Sblueswir1 27695824d651Sblueswir1Note that while this option can give deterministic behavior, it does not 27705824d651Sblueswir1provide cycle accurate emulation. Modern CPUs contain superscalar out of 27715824d651Sblueswir1order cores with complex cache hierarchies. The number of instructions 27725824d651Sblueswir1executed often has little or no correlation with actual performance. 27735824d651Sblueswir1ETEXI 27745824d651Sblueswir1 27759dd986ccSRichard W.M. JonesDEF("watchdog", HAS_ARG, QEMU_OPTION_watchdog, \ 27769dd986ccSRichard W.M. Jones "-watchdog i6300esb|ib700\n" \ 2777ad96090aSBlue Swirl " enable virtual hardware watchdog [default=none]\n", 2778ad96090aSBlue Swirl QEMU_ARCH_ALL) 27799dd986ccSRichard W.M. JonesSTEXI 27809dd986ccSRichard W.M. Jones@item -watchdog @var{model} 27816616b2adSStefan Weil@findex -watchdog 27829dd986ccSRichard W.M. JonesCreate a virtual hardware watchdog device. Once enabled (by a guest 27839dd986ccSRichard W.M. Jonesaction), the watchdog must be periodically polled by an agent inside 27849dd986ccSRichard W.M. Jonesthe guest or else the guest will be restarted. 27859dd986ccSRichard W.M. Jones 27869dd986ccSRichard W.M. JonesThe @var{model} is the model of hardware watchdog to emulate. Choices 27879dd986ccSRichard W.M. Jonesfor model are: @code{ib700} (iBASE 700) which is a very simple ISA 27889dd986ccSRichard W.M. Joneswatchdog with a single timer, or @code{i6300esb} (Intel 6300ESB I/O 27899dd986ccSRichard W.M. Jonescontroller hub) which is a much more featureful PCI-based dual-timer 27909dd986ccSRichard W.M. Joneswatchdog. Choose a model for which your guest has drivers. 27919dd986ccSRichard W.M. Jones 2792585f6036SPeter MaydellUse @code{-watchdog help} to list available hardware models. Only one 27939dd986ccSRichard W.M. Joneswatchdog can be enabled for a guest. 27949dd986ccSRichard W.M. JonesETEXI 27959dd986ccSRichard W.M. Jones 27969dd986ccSRichard W.M. JonesDEF("watchdog-action", HAS_ARG, QEMU_OPTION_watchdog_action, \ 27979dd986ccSRichard W.M. Jones "-watchdog-action reset|shutdown|poweroff|pause|debug|none\n" \ 2798ad96090aSBlue Swirl " action when watchdog fires [default=reset]\n", 2799ad96090aSBlue Swirl QEMU_ARCH_ALL) 28009dd986ccSRichard W.M. JonesSTEXI 28019dd986ccSRichard W.M. Jones@item -watchdog-action @var{action} 2802b8f490ebSMarkus Armbruster@findex -watchdog-action 28039dd986ccSRichard W.M. Jones 28049dd986ccSRichard W.M. JonesThe @var{action} controls what QEMU will do when the watchdog timer 28059dd986ccSRichard W.M. Jonesexpires. 28069dd986ccSRichard W.M. JonesThe default is 28079dd986ccSRichard W.M. Jones@code{reset} (forcefully reset the guest). 28089dd986ccSRichard W.M. JonesOther possible actions are: 28099dd986ccSRichard W.M. Jones@code{shutdown} (attempt to gracefully shutdown the guest), 28109dd986ccSRichard W.M. Jones@code{poweroff} (forcefully poweroff the guest), 28119dd986ccSRichard W.M. Jones@code{pause} (pause the guest), 28129dd986ccSRichard W.M. Jones@code{debug} (print a debug message and continue), or 28139dd986ccSRichard W.M. Jones@code{none} (do nothing). 28149dd986ccSRichard W.M. Jones 28159dd986ccSRichard W.M. JonesNote that the @code{shutdown} action requires that the guest responds 28169dd986ccSRichard W.M. Jonesto ACPI signals, which it may not be able to do in the sort of 28179dd986ccSRichard W.M. Jonessituations where the watchdog would have expired, and thus 28189dd986ccSRichard W.M. Jones@code{-watchdog-action shutdown} is not recommended for production use. 28199dd986ccSRichard W.M. Jones 28209dd986ccSRichard W.M. JonesExamples: 28219dd986ccSRichard W.M. Jones 28229dd986ccSRichard W.M. Jones@table @code 28239dd986ccSRichard W.M. Jones@item -watchdog i6300esb -watchdog-action pause 28249dd986ccSRichard W.M. Jones@item -watchdog ib700 28259dd986ccSRichard W.M. Jones@end table 28269dd986ccSRichard W.M. JonesETEXI 28279dd986ccSRichard W.M. Jones 28285824d651Sblueswir1DEF("echr", HAS_ARG, QEMU_OPTION_echr, \ 2829ad96090aSBlue Swirl "-echr chr set terminal escape character instead of ctrl-a\n", 2830ad96090aSBlue Swirl QEMU_ARCH_ALL) 28315824d651Sblueswir1STEXI 28325824d651Sblueswir1 28334e257e5eSKevin Wolf@item -echr @var{numeric_ascii_value} 28346616b2adSStefan Weil@findex -echr 28355824d651Sblueswir1Change the escape character used for switching to the monitor when using 28365824d651Sblueswir1monitor and serial sharing. The default is @code{0x01} when using the 28375824d651Sblueswir1@code{-nographic} option. @code{0x01} is equal to pressing 28385824d651Sblueswir1@code{Control-a}. You can select a different character from the ascii 28395824d651Sblueswir1control keys where 1 through 26 map to Control-a through Control-z. For 28405824d651Sblueswir1instance you could use the either of the following to change the escape 28415824d651Sblueswir1character to Control-t. 28425824d651Sblueswir1@table @code 28435824d651Sblueswir1@item -echr 0x14 28445824d651Sblueswir1@item -echr 20 28455824d651Sblueswir1@end table 28465824d651Sblueswir1ETEXI 28475824d651Sblueswir1 28485824d651Sblueswir1DEF("virtioconsole", HAS_ARG, QEMU_OPTION_virtiocon, \ 28495824d651Sblueswir1 "-virtioconsole c\n" \ 2850ad96090aSBlue Swirl " set virtio console\n", QEMU_ARCH_ALL) 28515824d651Sblueswir1STEXI 28525824d651Sblueswir1@item -virtioconsole @var{c} 28536616b2adSStefan Weil@findex -virtioconsole 28545824d651Sblueswir1Set virtio console. 285598b19252SAmit Shah 285698b19252SAmit ShahThis option is maintained for backward compatibility. 285798b19252SAmit Shah 285898b19252SAmit ShahPlease use @code{-device virtconsole} for the new way of invocation. 28595824d651Sblueswir1ETEXI 28605824d651Sblueswir1 28615824d651Sblueswir1DEF("show-cursor", 0, QEMU_OPTION_show_cursor, \ 2862ad96090aSBlue Swirl "-show-cursor show cursor\n", QEMU_ARCH_ALL) 28635824d651Sblueswir1STEXI 286495d5f08bSStefan Weil@item -show-cursor 28656616b2adSStefan Weil@findex -show-cursor 286695d5f08bSStefan WeilShow cursor. 28675824d651Sblueswir1ETEXI 28685824d651Sblueswir1 28695824d651Sblueswir1DEF("tb-size", HAS_ARG, QEMU_OPTION_tb_size, \ 2870ad96090aSBlue Swirl "-tb-size n set TB size\n", QEMU_ARCH_ALL) 28715824d651Sblueswir1STEXI 287295d5f08bSStefan Weil@item -tb-size @var{n} 28736616b2adSStefan Weil@findex -tb-size 287495d5f08bSStefan WeilSet TB size. 28755824d651Sblueswir1ETEXI 28765824d651Sblueswir1 28775824d651Sblueswir1DEF("incoming", HAS_ARG, QEMU_OPTION_incoming, \ 2878ad96090aSBlue Swirl "-incoming p prepare for incoming migration, listen on port p\n", 2879ad96090aSBlue Swirl QEMU_ARCH_ALL) 28805824d651Sblueswir1STEXI 288195d5f08bSStefan Weil@item -incoming @var{port} 28826616b2adSStefan Weil@findex -incoming 288395d5f08bSStefan WeilPrepare for incoming migration, listen on @var{port}. 28845824d651Sblueswir1ETEXI 28855824d651Sblueswir1 2886d8c208ddSGerd HoffmannDEF("nodefaults", 0, QEMU_OPTION_nodefaults, \ 2887ad96090aSBlue Swirl "-nodefaults don't create default devices\n", QEMU_ARCH_ALL) 2888d8c208ddSGerd HoffmannSTEXI 28893dbf2c7fSStefan Weil@item -nodefaults 28906616b2adSStefan Weil@findex -nodefaults 289166c19bf1SMichal NovotnyDon't create default devices. Normally, QEMU sets the default devices like serial 289266c19bf1SMichal Novotnyport, parallel port, virtual console, monitor device, VGA adapter, floppy and 289366c19bf1SMichal NovotnyCD-ROM drive and others. The @code{-nodefaults} option will disable all those 289466c19bf1SMichal Novotnydefault devices. 2895d8c208ddSGerd HoffmannETEXI 2896d8c208ddSGerd Hoffmann 28975824d651Sblueswir1#ifndef _WIN32 28985824d651Sblueswir1DEF("chroot", HAS_ARG, QEMU_OPTION_chroot, \ 2899ad96090aSBlue Swirl "-chroot dir chroot to dir just before starting the VM\n", 2900ad96090aSBlue Swirl QEMU_ARCH_ALL) 29015824d651Sblueswir1#endif 29025824d651Sblueswir1STEXI 29034e257e5eSKevin Wolf@item -chroot @var{dir} 29046616b2adSStefan Weil@findex -chroot 29055824d651Sblueswir1Immediately before starting guest execution, chroot to the specified 29065824d651Sblueswir1directory. Especially useful in combination with -runas. 29075824d651Sblueswir1ETEXI 29085824d651Sblueswir1 29095824d651Sblueswir1#ifndef _WIN32 29105824d651Sblueswir1DEF("runas", HAS_ARG, QEMU_OPTION_runas, \ 2911ad96090aSBlue Swirl "-runas user change to user id user just before starting the VM\n", 2912ad96090aSBlue Swirl QEMU_ARCH_ALL) 29135824d651Sblueswir1#endif 29145824d651Sblueswir1STEXI 29154e257e5eSKevin Wolf@item -runas @var{user} 29166616b2adSStefan Weil@findex -runas 29175824d651Sblueswir1Immediately before starting guest execution, drop root privileges, switching 29185824d651Sblueswir1to the specified user. 29195824d651Sblueswir1ETEXI 29205824d651Sblueswir1 29215824d651Sblueswir1DEF("prom-env", HAS_ARG, QEMU_OPTION_prom_env, 29225824d651Sblueswir1 "-prom-env variable=value\n" 2923ad96090aSBlue Swirl " set OpenBIOS nvram variables\n", 2924ad96090aSBlue Swirl QEMU_ARCH_PPC | QEMU_ARCH_SPARC) 292595d5f08bSStefan WeilSTEXI 292695d5f08bSStefan Weil@item -prom-env @var{variable}=@var{value} 29276616b2adSStefan Weil@findex -prom-env 292895d5f08bSStefan WeilSet OpenBIOS nvram @var{variable} to given @var{value} (PPC, SPARC only). 292995d5f08bSStefan WeilETEXI 29305824d651Sblueswir1DEF("semihosting", 0, QEMU_OPTION_semihosting, 29311ddeaa5dSMax Filippov "-semihosting semihosting mode\n", QEMU_ARCH_ARM | QEMU_ARCH_M68K | QEMU_ARCH_XTENSA) 293295d5f08bSStefan WeilSTEXI 293395d5f08bSStefan Weil@item -semihosting 29346616b2adSStefan Weil@findex -semihosting 29351ddeaa5dSMax FilippovSemihosting mode (ARM, M68K, Xtensa only). 293695d5f08bSStefan WeilETEXI 29375824d651Sblueswir1DEF("old-param", 0, QEMU_OPTION_old_param, 2938ad96090aSBlue Swirl "-old-param old param mode\n", QEMU_ARCH_ARM) 293995d5f08bSStefan WeilSTEXI 294095d5f08bSStefan Weil@item -old-param 29416616b2adSStefan Weil@findex -old-param (ARM) 294295d5f08bSStefan WeilOld param mode (ARM only). 294395d5f08bSStefan WeilETEXI 294495d5f08bSStefan Weil 29457d76ad4fSEduardo OtuboDEF("sandbox", HAS_ARG, QEMU_OPTION_sandbox, \ 29467d76ad4fSEduardo Otubo "-sandbox <arg> Enable seccomp mode 2 system call filter (default 'off').\n", 29477d76ad4fSEduardo Otubo QEMU_ARCH_ALL) 29487d76ad4fSEduardo OtuboSTEXI 29496265c43bSMarkus Armbruster@item -sandbox @var{arg} 29507d76ad4fSEduardo Otubo@findex -sandbox 29517d76ad4fSEduardo OtuboEnable Seccomp mode 2 system call filter. 'on' will enable syscall filtering and 'off' will 29527d76ad4fSEduardo Otubodisable it. The default is 'off'. 29537d76ad4fSEduardo OtuboETEXI 29547d76ad4fSEduardo Otubo 2955715a664aSGerd HoffmannDEF("readconfig", HAS_ARG, QEMU_OPTION_readconfig, 2956ad96090aSBlue Swirl "-readconfig <file>\n", QEMU_ARCH_ALL) 29573dbf2c7fSStefan WeilSTEXI 29583dbf2c7fSStefan Weil@item -readconfig @var{file} 29596616b2adSStefan Weil@findex -readconfig 2960ed24cfacSMichal NovotnyRead device configuration from @var{file}. This approach is useful when you want to spawn 2961ed24cfacSMichal NovotnyQEMU process with many command line options but you don't want to exceed the command line 2962ed24cfacSMichal Novotnycharacter limit. 29633dbf2c7fSStefan WeilETEXI 2964715a664aSGerd HoffmannDEF("writeconfig", HAS_ARG, QEMU_OPTION_writeconfig, 2965715a664aSGerd Hoffmann "-writeconfig <file>\n" 2966ad96090aSBlue Swirl " read/write config file\n", QEMU_ARCH_ALL) 29673dbf2c7fSStefan WeilSTEXI 29683dbf2c7fSStefan Weil@item -writeconfig @var{file} 29696616b2adSStefan Weil@findex -writeconfig 2970ed24cfacSMichal NovotnyWrite device configuration to @var{file}. The @var{file} can be either filename to save 2971ed24cfacSMichal Novotnycommand line and device configuration into file or dash @code{-}) character to print the 2972ed24cfacSMichal Novotnyoutput to stdout. This can be later used as input file for @code{-readconfig} option. 29733dbf2c7fSStefan WeilETEXI 2974292444cbSAnthony LiguoriDEF("nodefconfig", 0, QEMU_OPTION_nodefconfig, 2975292444cbSAnthony Liguori "-nodefconfig\n" 2976ad96090aSBlue Swirl " do not load default config files at startup\n", 2977ad96090aSBlue Swirl QEMU_ARCH_ALL) 2978292444cbSAnthony LiguoriSTEXI 2979292444cbSAnthony Liguori@item -nodefconfig 29806616b2adSStefan Weil@findex -nodefconfig 2981f29a5614SEduardo HabkostNormally QEMU loads configuration files from @var{sysconfdir} and @var{datadir} at startup. 2982f29a5614SEduardo HabkostThe @code{-nodefconfig} option will prevent QEMU from loading any of those config files. 2983f29a5614SEduardo HabkostETEXI 2984f29a5614SEduardo HabkostDEF("no-user-config", 0, QEMU_OPTION_nouserconfig, 2985f29a5614SEduardo Habkost "-no-user-config\n" 2986f29a5614SEduardo Habkost " do not load user-provided config files at startup\n", 2987f29a5614SEduardo Habkost QEMU_ARCH_ALL) 2988f29a5614SEduardo HabkostSTEXI 2989f29a5614SEduardo Habkost@item -no-user-config 2990f29a5614SEduardo Habkost@findex -no-user-config 2991f29a5614SEduardo HabkostThe @code{-no-user-config} option makes QEMU not load any of the user-provided 2992f29a5614SEduardo Habkostconfig files on @var{sysconfdir}, but won't make it skip the QEMU-provided config 2993f29a5614SEduardo Habkostfiles from @var{datadir}. 2994292444cbSAnthony LiguoriETEXI 2995ab6540d5SPrerna SaxenaDEF("trace", HAS_ARG, QEMU_OPTION_trace, 299623d15e86SLluís "-trace [events=<file>][,file=<file>]\n" 299723d15e86SLluís " specify tracing options\n", 2998ab6540d5SPrerna Saxena QEMU_ARCH_ALL) 2999ab6540d5SPrerna SaxenaSTEXI 300023d15e86SLluísHXCOMM This line is not accurate, as some sub-options are backend-specific but 300123d15e86SLluísHXCOMM HX does not support conditional compilation of text. 300223d15e86SLluís@item -trace [events=@var{file}][,file=@var{file}] 3003ab6540d5SPrerna Saxena@findex -trace 3004e4858974SLluís 300523d15e86SLluísSpecify tracing options. 300623d15e86SLluís 300723d15e86SLluís@table @option 300823d15e86SLluís@item events=@var{file} 300923d15e86SLluísImmediately enable events listed in @var{file}. 301023d15e86SLluísThe file must contain one event name (as listed in the @var{trace-events} file) 301123d15e86SLluísper line. 3012c1ba4e0bSStefan WeilThis option is only available if QEMU has been compiled with 3013c1ba4e0bSStefan Weileither @var{simple} or @var{stderr} tracing backend. 301423d15e86SLluís@item file=@var{file} 301523d15e86SLluísLog output traces to @var{file}. 301623d15e86SLluís 3017c1ba4e0bSStefan WeilThis option is only available if QEMU has been compiled with 3018c1ba4e0bSStefan Weilthe @var{simple} tracing backend. 301923d15e86SLluís@end table 3020ab6540d5SPrerna SaxenaETEXI 30213dbf2c7fSStefan Weil 302231e70d6cSMarkus ArmbrusterHXCOMM Internal use 302331e70d6cSMarkus ArmbrusterDEF("qtest", HAS_ARG, QEMU_OPTION_qtest, "", QEMU_ARCH_ALL) 302431e70d6cSMarkus ArmbrusterDEF("qtest-log", HAS_ARG, QEMU_OPTION_qtest_log, "", QEMU_ARCH_ALL) 3025c7f0f3b1SAnthony Liguori 30260f66998fSPaul Moore#ifdef __linux__ 30270f66998fSPaul MooreDEF("enable-fips", 0, QEMU_OPTION_enablefips, 30280f66998fSPaul Moore "-enable-fips enable FIPS 140-2 compliance\n", 30290f66998fSPaul Moore QEMU_ARCH_ALL) 30300f66998fSPaul Moore#endif 30310f66998fSPaul MooreSTEXI 30320f66998fSPaul Moore@item -enable-fips 30330f66998fSPaul Moore@findex -enable-fips 30340f66998fSPaul MooreEnable FIPS 140-2 compliance mode. 30350f66998fSPaul MooreETEXI 30360f66998fSPaul Moore 3037a0dac021SJan KiszkaHXCOMM Deprecated by -machine accel=tcg property 3038c6e88b3bSBruce RogersDEF("no-kvm", 0, QEMU_OPTION_no_kvm, "", QEMU_ARCH_I386) 3039a0dac021SJan Kiszka 3040c21fb4f8SJan KiszkaHXCOMM Deprecated by kvm-pit driver properties 3041c6e88b3bSBruce RogersDEF("no-kvm-pit-reinjection", 0, QEMU_OPTION_no_kvm_pit_reinjection, 3042c21fb4f8SJan Kiszka "", QEMU_ARCH_I386) 3043c21fb4f8SJan Kiszka 30444086bde8SJan KiszkaHXCOMM Deprecated (ignored) 3045c6e88b3bSBruce RogersDEF("no-kvm-pit", 0, QEMU_OPTION_no_kvm_pit, "", QEMU_ARCH_I386) 30464086bde8SJan Kiszka 3047e43d594eSJan KiszkaHXCOMM Deprecated by -machine kernel_irqchip=on|off property 3048c6e88b3bSBruce RogersDEF("no-kvm-irqchip", 0, QEMU_OPTION_no_kvm_irqchip, "", QEMU_ARCH_I386) 3049e43d594eSJan Kiszka 305088eed34aSJan KiszkaHXCOMM Deprecated (ignored) 305188eed34aSJan KiszkaDEF("tdf", 0, QEMU_OPTION_tdf,"", QEMU_ARCH_ALL) 305288eed34aSJan Kiszka 305368d98d3eSAnthony LiguoriDEF("object", HAS_ARG, QEMU_OPTION_object, 305468d98d3eSAnthony Liguori "-object TYPENAME[,PROP1=VALUE1,...]\n" 305568d98d3eSAnthony Liguori " create an new object of type TYPENAME setting properties\n" 305668d98d3eSAnthony Liguori " in the order they are specified. Note that the 'id'\n" 305768d98d3eSAnthony Liguori " property must be set. These objects are placed in the\n" 305868d98d3eSAnthony Liguori " '/objects' path.\n", 305968d98d3eSAnthony Liguori QEMU_ARCH_ALL) 30606265c43bSMarkus ArmbrusterSTEXI 30616265c43bSMarkus Armbruster@item -object @var{typename}[,@var{prop1}=@var{value1},...] 30626265c43bSMarkus Armbruster@findex -object 30636265c43bSMarkus ArmbrusterCreate an new object of type @var{typename} setting properties 30646265c43bSMarkus Armbrusterin the order they are specified. Note that the 'id' 30656265c43bSMarkus Armbrusterproperty must be set. These objects are placed in the 30666265c43bSMarkus Armbruster'/objects' path. 30676265c43bSMarkus ArmbrusterETEXI 306868d98d3eSAnthony Liguori 30693dbf2c7fSStefan WeilHXCOMM This is the last statement. Insert new options before this line! 30703dbf2c7fSStefan WeilSTEXI 30713dbf2c7fSStefan Weil@end table 30723dbf2c7fSStefan WeilETEXI 3073