15824d651Sblueswir1HXCOMM Use DEFHEADING() to define headings in both help text and texi 25824d651Sblueswir1HXCOMM Text between STEXI and ETEXI are copied to texi version and 35824d651Sblueswir1HXCOMM discarded from C version 4ad96090aSBlue SwirlHXCOMM DEF(option, HAS_ARG/0, opt_enum, opt_help, arch_mask) is used to 5ad96090aSBlue SwirlHXCOMM construct option structures, enums and help message for specified 6ad96090aSBlue SwirlHXCOMM architectures. 75824d651Sblueswir1HXCOMM HXCOMM can be used for comments, discarded from both texi and C 85824d651Sblueswir1 95824d651Sblueswir1DEFHEADING(Standard options:) 105824d651Sblueswir1STEXI 115824d651Sblueswir1@table @option 125824d651Sblueswir1ETEXI 135824d651Sblueswir1 145824d651Sblueswir1DEF("help", 0, QEMU_OPTION_h, 15ad96090aSBlue Swirl "-h or -help display this help and exit\n", QEMU_ARCH_ALL) 165824d651Sblueswir1STEXI 175824d651Sblueswir1@item -h 186616b2adSStefan Weil@findex -h 195824d651Sblueswir1Display help and exit 205824d651Sblueswir1ETEXI 215824d651Sblueswir1 229bd7e6d9SpbrookDEF("version", 0, QEMU_OPTION_version, 23ad96090aSBlue Swirl "-version display version information and exit\n", QEMU_ARCH_ALL) 249bd7e6d9SpbrookSTEXI 259bd7e6d9Spbrook@item -version 266616b2adSStefan Weil@findex -version 279bd7e6d9SpbrookDisplay version information and exit 289bd7e6d9SpbrookETEXI 299bd7e6d9Spbrook 3080f52a66SJan KiszkaDEF("machine", HAS_ARG, QEMU_OPTION_machine, \ 3180f52a66SJan Kiszka "-machine [type=]name[,prop[=value][,...]]\n" 32585f6036SPeter Maydell " selects emulated machine ('-machine help' for list)\n" 3380f52a66SJan Kiszka " property accel=accel1[:accel2[:...]] selects accelerator\n" 346a48ffaaSJan Kiszka " supported accelerators are kvm, xen, tcg (default: tcg)\n" 3539d6960aSJan Kiszka " kernel_irqchip=on|off controls accelerated irqchip support\n" 36ddb97f1dSJason Baron " kvm_shadow_mem=size of KVM shadow MMU\n" 378490fc78SLuiz Capitulino " dump-guest-core=on|off include guest memory in a core dump (default=on)\n" 388490fc78SLuiz Capitulino " mem-merge=on|off controls memory merge support (default: on)\n", 3980f52a66SJan Kiszka QEMU_ARCH_ALL) 405824d651Sblueswir1STEXI 4180f52a66SJan Kiszka@item -machine [type=]@var{name}[,prop=@var{value}[,...]] 4280f52a66SJan Kiszka@findex -machine 43585f6036SPeter MaydellSelect the emulated machine by @var{name}. Use @code{-machine help} to list 4480f52a66SJan Kiszkaavailable machines. Supported machine properties are: 4580f52a66SJan Kiszka@table @option 4680f52a66SJan Kiszka@item accel=@var{accels1}[:@var{accels2}[:...]] 4780f52a66SJan KiszkaThis is used to enable an accelerator. Depending on the target architecture, 4880f52a66SJan Kiszkakvm, xen, or tcg can be available. By default, tcg is used. If there is more 4980f52a66SJan Kiszkathan one accelerator specified, the next one is used if the previous one fails 5080f52a66SJan Kiszkato initialize. 516a48ffaaSJan Kiszka@item kernel_irqchip=on|off 526a48ffaaSJan KiszkaEnables in-kernel irqchip support for the chosen accelerator when available. 5339d6960aSJan Kiszka@item kvm_shadow_mem=size 5439d6960aSJan KiszkaDefines the size of the KVM shadow MMU. 55ddb97f1dSJason Baron@item dump-guest-core=on|off 56ddb97f1dSJason BaronInclude guest memory in a core dump. The default is on. 578490fc78SLuiz Capitulino@item mem-merge=on|off 588490fc78SLuiz CapitulinoEnables or disables memory merge support. This feature, when supported by 598490fc78SLuiz Capitulinothe host, de-duplicates identical memory pages among VMs instances 608490fc78SLuiz Capitulino(enabled by default). 6180f52a66SJan Kiszka@end table 625824d651Sblueswir1ETEXI 635824d651Sblueswir1 6480f52a66SJan KiszkaHXCOMM Deprecated by -machine 6580f52a66SJan KiszkaDEF("M", HAS_ARG, QEMU_OPTION_M, "", QEMU_ARCH_ALL) 6680f52a66SJan Kiszka 675824d651Sblueswir1DEF("cpu", HAS_ARG, QEMU_OPTION_cpu, 68585f6036SPeter Maydell "-cpu cpu select CPU ('-cpu help' for list)\n", QEMU_ARCH_ALL) 695824d651Sblueswir1STEXI 705824d651Sblueswir1@item -cpu @var{model} 716616b2adSStefan Weil@findex -cpu 72585f6036SPeter MaydellSelect CPU model (@code{-cpu help} for list and additional feature selection) 735824d651Sblueswir1ETEXI 745824d651Sblueswir1 755824d651Sblueswir1DEF("smp", HAS_ARG, QEMU_OPTION_smp, 7612b7f57eSMichael Tokarev "-smp [cpus=]n[,maxcpus=cpus][,cores=cores][,threads=threads][,sockets=sockets]\n" 776be68d7eSJes Sorensen " set the number of CPUs to 'n' [default=1]\n" 786be68d7eSJes Sorensen " maxcpus= maximum number of total cpus, including\n" 79ca1a8a06SBruce Rogers " offline CPUs for hotplug, etc\n" 8058a04db1SAndre Przywara " cores= number of CPU cores on one socket\n" 8158a04db1SAndre Przywara " threads= number of threads on one CPU core\n" 82ad96090aSBlue Swirl " sockets= number of discrete sockets in the system\n", 83ad96090aSBlue Swirl QEMU_ARCH_ALL) 845824d651Sblueswir1STEXI 8512b7f57eSMichael Tokarev@item -smp [cpus=]@var{n}[,cores=@var{cores}][,threads=@var{threads}][,sockets=@var{sockets}][,maxcpus=@var{maxcpus}] 866616b2adSStefan Weil@findex -smp 875824d651Sblueswir1Simulate an SMP system with @var{n} CPUs. On the PC target, up to 255 885824d651Sblueswir1CPUs are supported. On Sparc32 target, Linux limits the number of usable CPUs 895824d651Sblueswir1to 4. 9058a04db1SAndre PrzywaraFor the PC target, the number of @var{cores} per socket, the number 9158a04db1SAndre Przywaraof @var{threads} per cores and the total number of @var{sockets} can be 9258a04db1SAndre Przywaraspecified. Missing values will be computed. If any on the three values is 9358a04db1SAndre Przywaragiven, the total number of CPUs @var{n} can be omitted. @var{maxcpus} 9458a04db1SAndre Przywaraspecifies the maximum number of hotpluggable CPUs. 955824d651Sblueswir1ETEXI 965824d651Sblueswir1 97268a362cSaliguoriDEF("numa", HAS_ARG, QEMU_OPTION_numa, 98ad96090aSBlue Swirl "-numa node[,mem=size][,cpus=cpu[-cpu]][,nodeid=node]\n", QEMU_ARCH_ALL) 99268a362cSaliguoriSTEXI 100268a362cSaliguori@item -numa @var{opts} 1016616b2adSStefan Weil@findex -numa 102268a362cSaliguoriSimulate a multi node NUMA system. If mem and cpus are omitted, resources 103268a362cSaliguoriare split equally. 104268a362cSaliguoriETEXI 105268a362cSaliguori 10610adb8beSMarkus ArmbrusterDEF("add-fd", HAS_ARG, QEMU_OPTION_add_fd, 10710adb8beSMarkus Armbruster "-add-fd fd=fd,set=set[,opaque=opaque]\n" 10810adb8beSMarkus Armbruster " Add 'fd' to fd 'set'\n", QEMU_ARCH_ALL) 10910adb8beSMarkus ArmbrusterSTEXI 11010adb8beSMarkus Armbruster@item -add-fd fd=@var{fd},set=@var{set}[,opaque=@var{opaque}] 11110adb8beSMarkus Armbruster@findex -add-fd 11210adb8beSMarkus Armbruster 11310adb8beSMarkus ArmbrusterAdd a file descriptor to an fd set. Valid options are: 11410adb8beSMarkus Armbruster 11510adb8beSMarkus Armbruster@table @option 11610adb8beSMarkus Armbruster@item fd=@var{fd} 11710adb8beSMarkus ArmbrusterThis option defines the file descriptor of which a duplicate is added to fd set. 11810adb8beSMarkus ArmbrusterThe file descriptor cannot be stdin, stdout, or stderr. 11910adb8beSMarkus Armbruster@item set=@var{set} 12010adb8beSMarkus ArmbrusterThis option defines the ID of the fd set to add the file descriptor to. 12110adb8beSMarkus Armbruster@item opaque=@var{opaque} 12210adb8beSMarkus ArmbrusterThis option defines a free-form string that can be used to describe @var{fd}. 12310adb8beSMarkus Armbruster@end table 12410adb8beSMarkus Armbruster 12510adb8beSMarkus ArmbrusterYou can open an image using pre-opened file descriptors from an fd set: 12610adb8beSMarkus Armbruster@example 12710adb8beSMarkus Armbrusterqemu-system-i386 12810adb8beSMarkus Armbruster-add-fd fd=3,set=2,opaque="rdwr:/path/to/file" 12910adb8beSMarkus Armbruster-add-fd fd=4,set=2,opaque="rdonly:/path/to/file" 13010adb8beSMarkus Armbruster-drive file=/dev/fdset/2,index=0,media=disk 13110adb8beSMarkus Armbruster@end example 13210adb8beSMarkus ArmbrusterETEXI 13310adb8beSMarkus Armbruster 13410adb8beSMarkus ArmbrusterDEF("set", HAS_ARG, QEMU_OPTION_set, 13510adb8beSMarkus Armbruster "-set group.id.arg=value\n" 13610adb8beSMarkus Armbruster " set <arg> parameter for item <id> of type <group>\n" 13710adb8beSMarkus Armbruster " i.e. -set drive.$id.file=/path/to/image\n", QEMU_ARCH_ALL) 13810adb8beSMarkus ArmbrusterSTEXI 13910adb8beSMarkus Armbruster@item -set @var{group}.@var{id}.@var{arg}=@var{value} 14010adb8beSMarkus Armbruster@findex -set 14110adb8beSMarkus ArmbrusterSet parameter @var{arg} for item @var{id} of type @var{group}\n" 14210adb8beSMarkus ArmbrusterETEXI 14310adb8beSMarkus Armbruster 14410adb8beSMarkus ArmbrusterDEF("global", HAS_ARG, QEMU_OPTION_global, 14510adb8beSMarkus Armbruster "-global driver.prop=value\n" 14610adb8beSMarkus Armbruster " set a global default for a driver property\n", 14710adb8beSMarkus Armbruster QEMU_ARCH_ALL) 14810adb8beSMarkus ArmbrusterSTEXI 14910adb8beSMarkus Armbruster@item -global @var{driver}.@var{prop}=@var{value} 15010adb8beSMarkus Armbruster@findex -global 15110adb8beSMarkus ArmbrusterSet default value of @var{driver}'s property @var{prop} to @var{value}, e.g.: 15210adb8beSMarkus Armbruster 15310adb8beSMarkus Armbruster@example 15410adb8beSMarkus Armbrusterqemu-system-i386 -global ide-drive.physical_block_size=4096 -drive file=file,if=ide,index=0,media=disk 15510adb8beSMarkus Armbruster@end example 15610adb8beSMarkus Armbruster 15710adb8beSMarkus ArmbrusterIn particular, you can use this to set driver properties for devices which are 15810adb8beSMarkus Armbrustercreated automatically by the machine model. To create a device which is not 15910adb8beSMarkus Armbrustercreated automatically and set properties on it, use -@option{device}. 16010adb8beSMarkus ArmbrusterETEXI 16110adb8beSMarkus Armbruster 16210adb8beSMarkus ArmbrusterDEF("boot", HAS_ARG, QEMU_OPTION_boot, 16310adb8beSMarkus Armbruster "-boot [order=drives][,once=drives][,menu=on|off]\n" 164c8a6ae8bSAmos Kong " [,splash=sp_name][,splash-time=sp_time][,reboot-timeout=rb_time][,strict=on|off]\n" 16510adb8beSMarkus Armbruster " 'drives': floppy (a), hard disk (c), CD-ROM (d), network (n)\n" 16610adb8beSMarkus Armbruster " 'sp_name': the file's name that would be passed to bios as logo picture, if menu=on\n" 16710adb8beSMarkus Armbruster " 'sp_time': the period that splash picture last if menu=on, unit is ms\n" 16810adb8beSMarkus Armbruster " 'rb_timeout': the timeout before guest reboot when boot failed, unit is ms\n", 16910adb8beSMarkus Armbruster QEMU_ARCH_ALL) 17010adb8beSMarkus ArmbrusterSTEXI 171c8a6ae8bSAmos Kong@item -boot [order=@var{drives}][,once=@var{drives}][,menu=on|off][,splash=@var{sp_name}][,splash-time=@var{sp_time}][,reboot-timeout=@var{rb_timeout}][,strict=on|off] 17210adb8beSMarkus Armbruster@findex -boot 17310adb8beSMarkus ArmbrusterSpecify boot order @var{drives} as a string of drive letters. Valid 17410adb8beSMarkus Armbrusterdrive letters depend on the target achitecture. The x86 PC uses: a, b 17510adb8beSMarkus Armbruster(floppy 1 and 2), c (first hard disk), d (first CD-ROM), n-p (Etherboot 17610adb8beSMarkus Armbrusterfrom network adapter 1-4), hard disk boot is the default. To apply a 17710adb8beSMarkus Armbrusterparticular boot order only on the first startup, specify it via 17810adb8beSMarkus Armbruster@option{once}. 17910adb8beSMarkus Armbruster 18010adb8beSMarkus ArmbrusterInteractive boot menus/prompts can be enabled via @option{menu=on} as far 18110adb8beSMarkus Armbrusteras firmware/BIOS supports them. The default is non-interactive boot. 18210adb8beSMarkus Armbruster 18310adb8beSMarkus ArmbrusterA splash picture could be passed to bios, enabling user to show it as logo, 18410adb8beSMarkus Armbrusterwhen option splash=@var{sp_name} is given and menu=on, If firmware/BIOS 18510adb8beSMarkus Armbrustersupports them. Currently Seabios for X86 system support it. 18610adb8beSMarkus Armbrusterlimitation: The splash file could be a jpeg file or a BMP file in 24 BPP 18710adb8beSMarkus Armbrusterformat(true color). The resolution should be supported by the SVGA mode, so 18810adb8beSMarkus Armbrusterthe recommended is 320x240, 640x480, 800x640. 18910adb8beSMarkus Armbruster 19010adb8beSMarkus ArmbrusterA timeout could be passed to bios, guest will pause for @var{rb_timeout} ms 19110adb8beSMarkus Armbrusterwhen boot failed, then reboot. If @var{rb_timeout} is '-1', guest will not 19210adb8beSMarkus Armbrusterreboot, qemu passes '-1' to bios by default. Currently Seabios for X86 19310adb8beSMarkus Armbrustersystem support it. 19410adb8beSMarkus Armbruster 195c8a6ae8bSAmos KongDo strict boot via @option{strict=on} as far as firmware/BIOS 196c8a6ae8bSAmos Kongsupports it. This only effects when boot priority is changed by 197c8a6ae8bSAmos Kongbootindex options. The default is non-strict boot. 198c8a6ae8bSAmos Kong 19910adb8beSMarkus Armbruster@example 20010adb8beSMarkus Armbruster# try to boot from network first, then from hard disk 20110adb8beSMarkus Armbrusterqemu-system-i386 -boot order=nc 20210adb8beSMarkus Armbruster# boot from CD-ROM first, switch back to default order after reboot 20310adb8beSMarkus Armbrusterqemu-system-i386 -boot once=d 20410adb8beSMarkus Armbruster# boot with a splash picture for 5 seconds. 20510adb8beSMarkus Armbrusterqemu-system-i386 -boot menu=on,splash=/root/boot.bmp,splash-time=5000 20610adb8beSMarkus Armbruster@end example 20710adb8beSMarkus Armbruster 20810adb8beSMarkus ArmbrusterNote: The legacy format '-boot @var{drives}' is still supported but its 20910adb8beSMarkus Armbrusteruse is discouraged as it may be removed from future versions. 21010adb8beSMarkus ArmbrusterETEXI 21110adb8beSMarkus Armbruster 21210adb8beSMarkus ArmbrusterDEF("m", HAS_ARG, QEMU_OPTION_m, 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 ArmbrusterDEF("mem-prealloc", 0, QEMU_OPTION_mem_prealloc, 23210adb8beSMarkus Armbruster "-mem-prealloc preallocate guest memory (use with -mem-path)\n", 23310adb8beSMarkus Armbruster QEMU_ARCH_ALL) 23410adb8beSMarkus ArmbrusterSTEXI 23510adb8beSMarkus Armbruster@item -mem-prealloc 23610adb8beSMarkus Armbruster@findex -mem-prealloc 23710adb8beSMarkus ArmbrusterPreallocate memory when using -mem-path. 23810adb8beSMarkus ArmbrusterETEXI 23910adb8beSMarkus Armbruster 24010adb8beSMarkus ArmbrusterDEF("k", HAS_ARG, QEMU_OPTION_k, 24110adb8beSMarkus Armbruster "-k language use keyboard layout (for example 'fr' for French)\n", 24210adb8beSMarkus Armbruster QEMU_ARCH_ALL) 24310adb8beSMarkus ArmbrusterSTEXI 24410adb8beSMarkus Armbruster@item -k @var{language} 24510adb8beSMarkus Armbruster@findex -k 24610adb8beSMarkus ArmbrusterUse keyboard layout @var{language} (for example @code{fr} for 24710adb8beSMarkus ArmbrusterFrench). This option is only needed where it is not easy to get raw PC 24810adb8beSMarkus Armbrusterkeycodes (e.g. on Macs, with some X11 servers or with a VNC 24910adb8beSMarkus Armbrusterdisplay). You don't normally need to use it on PC/Linux or PC/Windows 25010adb8beSMarkus Armbrusterhosts. 25110adb8beSMarkus Armbruster 25210adb8beSMarkus ArmbrusterThe available layouts are: 25310adb8beSMarkus Armbruster@example 25410adb8beSMarkus Armbrusterar de-ch es fo fr-ca hu ja mk no pt-br sv 25510adb8beSMarkus Armbrusterda en-gb et fr fr-ch is lt nl pl ru th 25610adb8beSMarkus Armbrusterde en-us fi fr-be hr it lv nl-be pt sl tr 25710adb8beSMarkus Armbruster@end example 25810adb8beSMarkus Armbruster 25910adb8beSMarkus ArmbrusterThe default is @code{en-us}. 26010adb8beSMarkus ArmbrusterETEXI 26110adb8beSMarkus Armbruster 26210adb8beSMarkus Armbruster 26310adb8beSMarkus ArmbrusterDEF("audio-help", 0, QEMU_OPTION_audio_help, 26410adb8beSMarkus Armbruster "-audio-help print list of audio drivers and their options\n", 26510adb8beSMarkus Armbruster QEMU_ARCH_ALL) 26610adb8beSMarkus ArmbrusterSTEXI 26710adb8beSMarkus Armbruster@item -audio-help 26810adb8beSMarkus Armbruster@findex -audio-help 26910adb8beSMarkus ArmbrusterWill show the audio subsystem help: list of drivers, tunable 27010adb8beSMarkus Armbrusterparameters. 27110adb8beSMarkus ArmbrusterETEXI 27210adb8beSMarkus Armbruster 27310adb8beSMarkus ArmbrusterDEF("soundhw", HAS_ARG, QEMU_OPTION_soundhw, 27410adb8beSMarkus Armbruster "-soundhw c1,... enable audio support\n" 27510adb8beSMarkus Armbruster " and only specified sound cards (comma separated list)\n" 27610adb8beSMarkus Armbruster " use '-soundhw help' to get the list of supported cards\n" 27710adb8beSMarkus Armbruster " use '-soundhw all' to enable all of them\n", QEMU_ARCH_ALL) 27810adb8beSMarkus ArmbrusterSTEXI 27910adb8beSMarkus Armbruster@item -soundhw @var{card1}[,@var{card2},...] or -soundhw all 28010adb8beSMarkus Armbruster@findex -soundhw 28110adb8beSMarkus ArmbrusterEnable audio and selected sound hardware. Use 'help' to print all 28210adb8beSMarkus Armbrusteravailable sound hardware. 28310adb8beSMarkus Armbruster 28410adb8beSMarkus Armbruster@example 28510adb8beSMarkus Armbrusterqemu-system-i386 -soundhw sb16,adlib disk.img 28610adb8beSMarkus Armbrusterqemu-system-i386 -soundhw es1370 disk.img 28710adb8beSMarkus Armbrusterqemu-system-i386 -soundhw ac97 disk.img 28810adb8beSMarkus Armbrusterqemu-system-i386 -soundhw hda disk.img 28910adb8beSMarkus Armbrusterqemu-system-i386 -soundhw all disk.img 29010adb8beSMarkus Armbrusterqemu-system-i386 -soundhw help 29110adb8beSMarkus Armbruster@end example 29210adb8beSMarkus Armbruster 29310adb8beSMarkus ArmbrusterNote that Linux's i810_audio OSS kernel (for AC97) module might 29410adb8beSMarkus Armbrusterrequire manually specifying clocking. 29510adb8beSMarkus Armbruster 29610adb8beSMarkus Armbruster@example 29710adb8beSMarkus Armbrustermodprobe i810_audio clocking=48000 29810adb8beSMarkus Armbruster@end example 29910adb8beSMarkus ArmbrusterETEXI 30010adb8beSMarkus Armbruster 30110adb8beSMarkus ArmbrusterDEF("balloon", HAS_ARG, QEMU_OPTION_balloon, 30210adb8beSMarkus Armbruster "-balloon none disable balloon device\n" 30310adb8beSMarkus Armbruster "-balloon virtio[,addr=str]\n" 30410adb8beSMarkus Armbruster " enable virtio balloon device (default)\n", QEMU_ARCH_ALL) 30510adb8beSMarkus ArmbrusterSTEXI 30610adb8beSMarkus Armbruster@item -balloon none 30710adb8beSMarkus Armbruster@findex -balloon 30810adb8beSMarkus ArmbrusterDisable balloon device. 30910adb8beSMarkus Armbruster@item -balloon virtio[,addr=@var{addr}] 31010adb8beSMarkus ArmbrusterEnable virtio balloon device (default), optionally with PCI address 31110adb8beSMarkus Armbruster@var{addr}. 31210adb8beSMarkus ArmbrusterETEXI 31310adb8beSMarkus Armbruster 31410adb8beSMarkus ArmbrusterDEF("device", HAS_ARG, QEMU_OPTION_device, 31510adb8beSMarkus Armbruster "-device driver[,prop[=value][,...]]\n" 31610adb8beSMarkus Armbruster " add device (based on driver)\n" 31710adb8beSMarkus Armbruster " prop=value,... sets driver properties\n" 31810adb8beSMarkus Armbruster " use '-device help' to print all possible drivers\n" 31910adb8beSMarkus Armbruster " use '-device driver,help' to print all possible properties\n", 32010adb8beSMarkus Armbruster QEMU_ARCH_ALL) 32110adb8beSMarkus ArmbrusterSTEXI 32210adb8beSMarkus Armbruster@item -device @var{driver}[,@var{prop}[=@var{value}][,...]] 32310adb8beSMarkus Armbruster@findex -device 32410adb8beSMarkus ArmbrusterAdd device @var{driver}. @var{prop}=@var{value} sets driver 32510adb8beSMarkus Armbrusterproperties. Valid properties depend on the driver. To get help on 32610adb8beSMarkus Armbrusterpossible drivers and properties, use @code{-device help} and 32710adb8beSMarkus Armbruster@code{-device @var{driver},help}. 32810adb8beSMarkus ArmbrusterETEXI 32910adb8beSMarkus Armbruster 33010adb8beSMarkus ArmbrusterDEF("name", HAS_ARG, QEMU_OPTION_name, 3318f480de0SDr. David Alan Gilbert "-name string1[,process=string2][,debug-threads=on|off]\n" 33210adb8beSMarkus Armbruster " set the name of the guest\n" 3338f480de0SDr. David Alan Gilbert " string1 sets the window title and string2 the process name (on Linux)\n" 3348f480de0SDr. David Alan Gilbert " When debug-threads is enabled, individual threads are given a separate name (on Linux)\n" 3358f480de0SDr. David Alan Gilbert " NOTE: The thread names are for debugging and not a stable API.\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. 3448f480de0SDr. David Alan GilbertNaming of individual threads can also be enabled on Linux to aid debugging. 34510adb8beSMarkus ArmbrusterETEXI 34610adb8beSMarkus Armbruster 34710adb8beSMarkus ArmbrusterDEF("uuid", HAS_ARG, QEMU_OPTION_uuid, 34810adb8beSMarkus Armbruster "-uuid %08x-%04x-%04x-%04x-%012x\n" 34910adb8beSMarkus Armbruster " specify machine UUID\n", QEMU_ARCH_ALL) 35010adb8beSMarkus ArmbrusterSTEXI 35110adb8beSMarkus Armbruster@item -uuid @var{uuid} 35210adb8beSMarkus Armbruster@findex -uuid 35310adb8beSMarkus ArmbrusterSet system UUID. 35410adb8beSMarkus ArmbrusterETEXI 35510adb8beSMarkus Armbruster 35610adb8beSMarkus ArmbrusterSTEXI 35710adb8beSMarkus Armbruster@end table 35810adb8beSMarkus ArmbrusterETEXI 35910adb8beSMarkus ArmbrusterDEFHEADING() 36010adb8beSMarkus Armbruster 36110adb8beSMarkus ArmbrusterDEFHEADING(Block device options:) 36210adb8beSMarkus ArmbrusterSTEXI 36310adb8beSMarkus Armbruster@table @option 36410adb8beSMarkus ArmbrusterETEXI 36510adb8beSMarkus Armbruster 3665824d651Sblueswir1DEF("fda", HAS_ARG, QEMU_OPTION_fda, 367ad96090aSBlue Swirl "-fda/-fdb file use 'file' as floppy disk 0/1 image\n", QEMU_ARCH_ALL) 368ad96090aSBlue SwirlDEF("fdb", HAS_ARG, QEMU_OPTION_fdb, "", QEMU_ARCH_ALL) 3695824d651Sblueswir1STEXI 3705824d651Sblueswir1@item -fda @var{file} 3715824d651Sblueswir1@item -fdb @var{file} 3726616b2adSStefan Weil@findex -fda 3736616b2adSStefan Weil@findex -fdb 3745824d651Sblueswir1Use @var{file} as floppy disk 0/1 image (@pxref{disk_images}). You can 3755824d651Sblueswir1use the host floppy by using @file{/dev/fd0} as filename (@pxref{host_drives}). 3765824d651Sblueswir1ETEXI 3775824d651Sblueswir1 3785824d651Sblueswir1DEF("hda", HAS_ARG, QEMU_OPTION_hda, 379ad96090aSBlue Swirl "-hda/-hdb file use 'file' as IDE hard disk 0/1 image\n", QEMU_ARCH_ALL) 380ad96090aSBlue SwirlDEF("hdb", HAS_ARG, QEMU_OPTION_hdb, "", QEMU_ARCH_ALL) 3815824d651Sblueswir1DEF("hdc", HAS_ARG, QEMU_OPTION_hdc, 382ad96090aSBlue Swirl "-hdc/-hdd file use 'file' as IDE hard disk 2/3 image\n", QEMU_ARCH_ALL) 383ad96090aSBlue SwirlDEF("hdd", HAS_ARG, QEMU_OPTION_hdd, "", QEMU_ARCH_ALL) 3845824d651Sblueswir1STEXI 3855824d651Sblueswir1@item -hda @var{file} 3865824d651Sblueswir1@item -hdb @var{file} 3875824d651Sblueswir1@item -hdc @var{file} 3885824d651Sblueswir1@item -hdd @var{file} 3896616b2adSStefan Weil@findex -hda 3906616b2adSStefan Weil@findex -hdb 3916616b2adSStefan Weil@findex -hdc 3926616b2adSStefan Weil@findex -hdd 3935824d651Sblueswir1Use @var{file} as hard disk 0, 1, 2 or 3 image (@pxref{disk_images}). 3945824d651Sblueswir1ETEXI 3955824d651Sblueswir1 3965824d651Sblueswir1DEF("cdrom", HAS_ARG, QEMU_OPTION_cdrom, 397ad96090aSBlue Swirl "-cdrom file use 'file' as IDE cdrom image (cdrom is ide1 master)\n", 398ad96090aSBlue Swirl QEMU_ARCH_ALL) 3995824d651Sblueswir1STEXI 4005824d651Sblueswir1@item -cdrom @var{file} 4016616b2adSStefan Weil@findex -cdrom 4025824d651Sblueswir1Use @var{file} as CD-ROM image (you cannot use @option{-hdc} and 4035824d651Sblueswir1@option{-cdrom} at the same time). You can use the host CD-ROM by 4045824d651Sblueswir1using @file{/dev/cdrom} as filename (@pxref{host_drives}). 4055824d651Sblueswir1ETEXI 4065824d651Sblueswir1 4075824d651Sblueswir1DEF("drive", HAS_ARG, QEMU_OPTION_drive, 4085824d651Sblueswir1 "-drive [file=file][,if=type][,bus=n][,unit=m][,media=d][,index=i]\n" 4095824d651Sblueswir1 " [,cyls=c,heads=h,secs=s[,trans=t]][,snapshot=on|off]\n" 41092196b2fSStefan Hajnoczi " [,cache=writethrough|writeback|none|directsync|unsafe][,format=f]\n" 411*d1db760dSStefan Hajnoczi " [,serial=s][,addr=A][,rerror=ignore|stop|report]\n" 412*d1db760dSStefan Hajnoczi " [,werror=ignore|stop|report|enospc][,id=name][,aio=threads|native]\n" 413fb0490f6SStefan Hajnoczi " [,readonly=on|off][,copy-on-read=on|off]\n" 4143e9fab69SBenoît Canet " [[,bps=b]|[[,bps_rd=r][,bps_wr=w]]]\n" 4153e9fab69SBenoît Canet " [[,iops=i]|[[,iops_rd=r][,iops_wr=w]]]\n" 4163e9fab69SBenoît Canet " [[,bps_max=bm]|[[,bps_rd_max=rm][,bps_wr_max=wm]]]\n" 4173e9fab69SBenoît Canet " [[,iops_max=im]|[[,iops_rd_max=irm][,iops_wr_max=iwm]]]\n" 4182024c1dfSBenoît Canet " [[,iops_size=is]]\n" 419ad96090aSBlue Swirl " use 'file' as a drive image\n", QEMU_ARCH_ALL) 4205824d651Sblueswir1STEXI 4215824d651Sblueswir1@item -drive @var{option}[,@var{option}[,@var{option}[,...]]] 4226616b2adSStefan Weil@findex -drive 4235824d651Sblueswir1 4245824d651Sblueswir1Define a new drive. Valid options are: 4255824d651Sblueswir1 426b3f046c2SKevin Wolf@table @option 4275824d651Sblueswir1@item file=@var{file} 4285824d651Sblueswir1This option defines which disk image (@pxref{disk_images}) to use with 4295824d651Sblueswir1this drive. If the filename contains comma, you must double it 4305824d651Sblueswir1(for instance, "file=my,,file" to use file "my,file"). 4310f5314a2SRonnie Sahlberg 4320f5314a2SRonnie SahlbergSpecial files such as iSCSI devices can be specified using protocol 4330f5314a2SRonnie Sahlbergspecific URLs. See the section for "Device URL Syntax" for more information. 4345824d651Sblueswir1@item if=@var{interface} 4355824d651Sblueswir1This option defines on which type on interface the drive is connected. 4365824d651Sblueswir1Available types are: ide, scsi, sd, mtd, floppy, pflash, virtio. 4375824d651Sblueswir1@item bus=@var{bus},unit=@var{unit} 4385824d651Sblueswir1These options define where is connected the drive by defining the bus number and 4395824d651Sblueswir1the unit id. 4405824d651Sblueswir1@item index=@var{index} 4415824d651Sblueswir1This option defines where is connected the drive by using an index in the list 4425824d651Sblueswir1of available connectors of a given interface type. 4435824d651Sblueswir1@item media=@var{media} 4445824d651Sblueswir1This option defines the type of the media: disk or cdrom. 4455824d651Sblueswir1@item cyls=@var{c},heads=@var{h},secs=@var{s}[,trans=@var{t}] 4465824d651Sblueswir1These options have the same definition as they have in @option{-hdachs}. 4475824d651Sblueswir1@item snapshot=@var{snapshot} 4489d85d557SMichael Tokarev@var{snapshot} is "on" or "off" and controls snapshot mode for the given drive 4499d85d557SMichael Tokarev(see @option{-snapshot}). 4505824d651Sblueswir1@item cache=@var{cache} 45192196b2fSStefan Hajnoczi@var{cache} is "none", "writeback", "unsafe", "directsync" or "writethrough" and controls how the host cache is used to access block data. 4525c6c3a6cSChristoph Hellwig@item aio=@var{aio} 4535c6c3a6cSChristoph Hellwig@var{aio} is "threads", or "native" and selects between pthread based disk I/O and native Linux AIO. 454a9384affSPaolo Bonzini@item discard=@var{discard} 455a9384affSPaolo 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. 4565824d651Sblueswir1@item format=@var{format} 4575824d651Sblueswir1Specify which disk @var{format} will be used rather than detecting 4585824d651Sblueswir1the format. Can be used to specifiy format=raw to avoid interpreting 4595824d651Sblueswir1an untrusted format header. 4605824d651Sblueswir1@item serial=@var{serial} 4615824d651Sblueswir1This option specifies the serial number to assign to the device. 462c2cc47a4SMarkus Armbruster@item addr=@var{addr} 463c2cc47a4SMarkus ArmbrusterSpecify the controller's PCI address (if=virtio only). 464ae73e591SLuiz Capitulino@item werror=@var{action},rerror=@var{action} 465ae73e591SLuiz CapitulinoSpecify which @var{action} to take on write and read errors. Valid actions are: 466ae73e591SLuiz Capitulino"ignore" (ignore the error and try to continue), "stop" (pause QEMU), 467ae73e591SLuiz Capitulino"report" (report the error to the guest), "enospc" (pause QEMU only if the 468ae73e591SLuiz Capitulinohost disk is full; report the error to the guest otherwise). 469ae73e591SLuiz CapitulinoThe default setting is @option{werror=enospc} and @option{rerror=report}. 470ae73e591SLuiz Capitulino@item readonly 471ae73e591SLuiz CapitulinoOpen drive @option{file} as read-only. Guest write attempts will fail. 472fb0490f6SStefan Hajnoczi@item copy-on-read=@var{copy-on-read} 473fb0490f6SStefan Hajnoczi@var{copy-on-read} is "on" or "off" and enables whether to copy read backing 474fb0490f6SStefan Hajnoczifile sectors into the image file. 4755824d651Sblueswir1@end table 4765824d651Sblueswir1 477a13e5e05SKevin WolfBy default, the @option{cache=writeback} mode is used. It will report data 478a13e5e05SKevin Wolfwrites as completed as soon as the data is present in the host page cache. 479a13e5e05SKevin WolfThis is safe as long as your guest OS makes sure to correctly flush disk caches 480a13e5e05SKevin Wolfwhere needed. If your guest OS does not handle volatile disk write caches 481a13e5e05SKevin Wolfcorrectly and your host crashes or loses power, then the guest may experience 482a13e5e05SKevin Wolfdata corruption. 4835824d651Sblueswir1 484a13e5e05SKevin WolfFor such guests, you should consider using @option{cache=writethrough}. This 485a13e5e05SKevin Wolfmeans that the host page cache will be used to read and write data, but write 486a13e5e05SKevin Wolfnotification will be sent to the guest only after QEMU has made sure to flush 487a13e5e05SKevin Wolfeach write to the disk. Be aware that this has a major impact on performance. 4885824d651Sblueswir1 489c304d317SAurelien JarnoThe host page cache can be avoided entirely with @option{cache=none}. This will 490a13e5e05SKevin Wolfattempt to do disk IO directly to the guest's memory. QEMU may still perform 491a13e5e05SKevin Wolfan internal copy of the data. Note that this is considered a writeback mode and 492a13e5e05SKevin Wolfthe guest OS must handle the disk write cache correctly in order to avoid data 493a13e5e05SKevin Wolfcorruption on host crashes. 4945824d651Sblueswir1 49592196b2fSStefan HajnocziThe host page cache can be avoided while only sending write notifications to 496a13e5e05SKevin Wolfthe guest when the data has been flushed to the disk using 497a13e5e05SKevin Wolf@option{cache=directsync}. 4985824d651Sblueswir1 499016f5cf6SAlexander GrafIn case you don't care about data integrity over host failures, use 500a13e5e05SKevin Wolf@option{cache=unsafe}. This option tells QEMU that it never needs to write any 501a13e5e05SKevin Wolfdata to the disk but can instead keep things in cache. If anything goes wrong, 502e7d81004SStefan Weillike your host losing power, the disk storage getting disconnected accidentally, 503a13e5e05SKevin Wolfetc. your image will most probably be rendered unusable. When using 504c3177288SAlexander Grafthe @option{-snapshot} option, unsafe caching is always used. 505016f5cf6SAlexander Graf 506fb0490f6SStefan HajnocziCopy-on-read avoids accessing the same backing file sectors repeatedly and is 507fb0490f6SStefan Hajnocziuseful when the backing file is over a slow network. By default copy-on-read 508fb0490f6SStefan Hajnocziis off. 509fb0490f6SStefan Hajnoczi 5105824d651Sblueswir1Instead of @option{-cdrom} you can use: 5115824d651Sblueswir1@example 5123804da9dSStefan Weilqemu-system-i386 -drive file=file,index=2,media=cdrom 5135824d651Sblueswir1@end example 5145824d651Sblueswir1 5155824d651Sblueswir1Instead of @option{-hda}, @option{-hdb}, @option{-hdc}, @option{-hdd}, you can 5165824d651Sblueswir1use: 5175824d651Sblueswir1@example 5183804da9dSStefan Weilqemu-system-i386 -drive file=file,index=0,media=disk 5193804da9dSStefan Weilqemu-system-i386 -drive file=file,index=1,media=disk 5203804da9dSStefan Weilqemu-system-i386 -drive file=file,index=2,media=disk 5213804da9dSStefan Weilqemu-system-i386 -drive file=file,index=3,media=disk 5225824d651Sblueswir1@end example 5235824d651Sblueswir1 524587ed6beSCorey BryantYou can open an image using pre-opened file descriptors from an fd set: 525587ed6beSCorey Bryant@example 526587ed6beSCorey Bryantqemu-system-i386 527587ed6beSCorey Bryant-add-fd fd=3,set=2,opaque="rdwr:/path/to/file" 528587ed6beSCorey Bryant-add-fd fd=4,set=2,opaque="rdonly:/path/to/file" 529587ed6beSCorey Bryant-drive file=/dev/fdset/2,index=0,media=disk 530587ed6beSCorey Bryant@end example 531587ed6beSCorey Bryant 5325824d651Sblueswir1You can connect a CDROM to the slave of ide0: 5335824d651Sblueswir1@example 5343804da9dSStefan Weilqemu-system-i386 -drive file=file,if=ide,index=1,media=cdrom 5355824d651Sblueswir1@end example 5365824d651Sblueswir1 5375824d651Sblueswir1If you don't specify the "file=" argument, you define an empty drive: 5385824d651Sblueswir1@example 5393804da9dSStefan Weilqemu-system-i386 -drive if=ide,index=1,media=cdrom 5405824d651Sblueswir1@end example 5415824d651Sblueswir1 5425824d651Sblueswir1You can connect a SCSI disk with unit ID 6 on the bus #0: 5435824d651Sblueswir1@example 5443804da9dSStefan Weilqemu-system-i386 -drive file=file,if=scsi,bus=0,unit=6 5455824d651Sblueswir1@end example 5465824d651Sblueswir1 5475824d651Sblueswir1Instead of @option{-fda}, @option{-fdb}, you can use: 5485824d651Sblueswir1@example 5493804da9dSStefan Weilqemu-system-i386 -drive file=file,index=0,if=floppy 5503804da9dSStefan Weilqemu-system-i386 -drive file=file,index=1,if=floppy 5515824d651Sblueswir1@end example 5525824d651Sblueswir1 5535824d651Sblueswir1By default, @var{interface} is "ide" and @var{index} is automatically 5545824d651Sblueswir1incremented: 5555824d651Sblueswir1@example 5563804da9dSStefan Weilqemu-system-i386 -drive file=a -drive file=b" 5575824d651Sblueswir1@end example 5585824d651Sblueswir1is interpreted like: 5595824d651Sblueswir1@example 5603804da9dSStefan Weilqemu-system-i386 -hda a -hdb b 5615824d651Sblueswir1@end example 5625824d651Sblueswir1ETEXI 5635824d651Sblueswir1 5645824d651Sblueswir1DEF("mtdblock", HAS_ARG, QEMU_OPTION_mtdblock, 565ad96090aSBlue Swirl "-mtdblock file use 'file' as on-board Flash memory image\n", 566ad96090aSBlue Swirl QEMU_ARCH_ALL) 5675824d651Sblueswir1STEXI 5684e257e5eSKevin Wolf@item -mtdblock @var{file} 5696616b2adSStefan Weil@findex -mtdblock 5704e257e5eSKevin WolfUse @var{file} as on-board Flash memory image. 5715824d651Sblueswir1ETEXI 5725824d651Sblueswir1 5735824d651Sblueswir1DEF("sd", HAS_ARG, QEMU_OPTION_sd, 574ad96090aSBlue Swirl "-sd file use 'file' as SecureDigital card image\n", QEMU_ARCH_ALL) 5755824d651Sblueswir1STEXI 5764e257e5eSKevin Wolf@item -sd @var{file} 5776616b2adSStefan Weil@findex -sd 5784e257e5eSKevin WolfUse @var{file} as SecureDigital card image. 5795824d651Sblueswir1ETEXI 5805824d651Sblueswir1 5815824d651Sblueswir1DEF("pflash", HAS_ARG, QEMU_OPTION_pflash, 582ad96090aSBlue Swirl "-pflash file use 'file' as a parallel flash image\n", QEMU_ARCH_ALL) 5835824d651Sblueswir1STEXI 5844e257e5eSKevin Wolf@item -pflash @var{file} 5856616b2adSStefan Weil@findex -pflash 5864e257e5eSKevin WolfUse @var{file} as a parallel flash image. 5875824d651Sblueswir1ETEXI 5885824d651Sblueswir1 5895824d651Sblueswir1DEF("snapshot", 0, QEMU_OPTION_snapshot, 590ad96090aSBlue Swirl "-snapshot write to temporary files instead of disk image files\n", 591ad96090aSBlue Swirl QEMU_ARCH_ALL) 5925824d651Sblueswir1STEXI 5935824d651Sblueswir1@item -snapshot 5946616b2adSStefan Weil@findex -snapshot 5955824d651Sblueswir1Write to temporary files instead of disk image files. In this case, 5965824d651Sblueswir1the raw disk image you use is not written back. You can however force 5975824d651Sblueswir1the write back by pressing @key{C-a s} (@pxref{disk_images}). 5985824d651Sblueswir1ETEXI 5995824d651Sblueswir1 60010adb8beSMarkus ArmbrusterDEF("hdachs", HAS_ARG, QEMU_OPTION_hdachs, \ 60110adb8beSMarkus Armbruster "-hdachs c,h,s[,t]\n" \ 60210adb8beSMarkus Armbruster " force hard disk 0 physical geometry and the optional BIOS\n" \ 60310adb8beSMarkus Armbruster " translation (t=none or lba) (usually QEMU can guess them)\n", 604ad96090aSBlue Swirl QEMU_ARCH_ALL) 605c902760fSMarcelo TosattiSTEXI 60610adb8beSMarkus Armbruster@item -hdachs @var{c},@var{h},@var{s},[,@var{t}] 60710adb8beSMarkus Armbruster@findex -hdachs 60810adb8beSMarkus ArmbrusterForce hard disk 0 physical geometry (1 <= @var{c} <= 16383, 1 <= 60910adb8beSMarkus Armbruster@var{h} <= 16, 1 <= @var{s} <= 63) and optionally force the BIOS 61010adb8beSMarkus Armbrustertranslation mode (@var{t}=none, lba or auto). Usually QEMU can guess 61110adb8beSMarkus Armbrusterall those parameters. This option is useful for old MS-DOS disk 61210adb8beSMarkus Armbrusterimages. 613c70a01e4SMarkus ArmbrusterETEXI 61474db920cSGautham R Shenoy 61574db920cSGautham R ShenoyDEF("fsdev", HAS_ARG, QEMU_OPTION_fsdev, 6162c30dd74SAneesh Kumar K.V "-fsdev fsdriver,id=id[,path=path,][security_model={mapped-xattr|mapped-file|passthrough|none}]\n" 61784a87cc4SM. Mohan Kumar " [,writeout=immediate][,readonly][,socket=socket|sock_fd=sock_fd]\n", 61874db920cSGautham R Shenoy QEMU_ARCH_ALL) 61974db920cSGautham R Shenoy 62074db920cSGautham R ShenoySTEXI 62174db920cSGautham R Shenoy 62284a87cc4SM. 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}] 62374db920cSGautham R Shenoy@findex -fsdev 6247c92a3d2SAneesh Kumar K.VDefine a new file system device. Valid options are: 6257c92a3d2SAneesh Kumar K.V@table @option 6267c92a3d2SAneesh Kumar K.V@item @var{fsdriver} 6277c92a3d2SAneesh Kumar K.VThis option specifies the fs driver backend to use. 628f67e3ffdSM. Mohan KumarCurrently "local", "handle" and "proxy" file system drivers are supported. 6297c92a3d2SAneesh Kumar K.V@item id=@var{id} 6307c92a3d2SAneesh Kumar K.VSpecifies identifier for this device 6317c92a3d2SAneesh Kumar K.V@item path=@var{path} 6327c92a3d2SAneesh Kumar K.VSpecifies the export path for the file system device. Files under 6337c92a3d2SAneesh Kumar K.Vthis path will be available to the 9p client on the guest. 6347c92a3d2SAneesh Kumar K.V@item security_model=@var{security_model} 6357c92a3d2SAneesh Kumar K.VSpecifies the security model to be used for this export path. 6362c30dd74SAneesh Kumar K.VSupported security models are "passthrough", "mapped-xattr", "mapped-file" and "none". 6377c92a3d2SAneesh Kumar K.VIn "passthrough" security model, files are stored using the same 638b65ee4faSStefan Weilcredentials as they are created on the guest. This requires QEMU 6392c30dd74SAneesh Kumar K.Vto run as root. In "mapped-xattr" security model, some of the file 6407c92a3d2SAneesh Kumar K.Vattributes like uid, gid, mode bits and link target are stored as 6412c30dd74SAneesh Kumar K.Vfile attributes. For "mapped-file" these attributes are stored in the 6422c30dd74SAneesh Kumar K.Vhidden .virtfs_metadata directory. Directories exported by this security model cannot 6437c92a3d2SAneesh Kumar K.Vinteract with other unix tools. "none" security model is same as 6447c92a3d2SAneesh Kumar K.Vpassthrough except the sever won't report failures if it fails to 645d9b36a6eSM. Mohan Kumarset file attributes like ownership. Security model is mandatory 646f67e3ffdSM. Mohan Kumaronly for local fsdriver. Other fsdrivers (like handle, proxy) don't take 647d9b36a6eSM. Mohan Kumarsecurity model as a parameter. 6487c92a3d2SAneesh Kumar K.V@item writeout=@var{writeout} 6497c92a3d2SAneesh Kumar K.VThis is an optional argument. The only supported value is "immediate". 6507c92a3d2SAneesh Kumar K.VThis means that host page cache will be used to read and write data but 6517c92a3d2SAneesh Kumar K.Vwrite notification will be sent to the guest only when the data has been 6527c92a3d2SAneesh Kumar K.Vreported as written by the storage subsystem. 6532c74c2cbSM. Mohan Kumar@item readonly 6542c74c2cbSM. Mohan KumarEnables exporting 9p share as a readonly mount for guests. By default 6552c74c2cbSM. Mohan Kumarread-write access is given. 65684a87cc4SM. Mohan Kumar@item socket=@var{socket} 65784a87cc4SM. Mohan KumarEnables proxy filesystem driver to use passed socket file for communicating 65884a87cc4SM. Mohan Kumarwith virtfs-proxy-helper 659f67e3ffdSM. Mohan Kumar@item sock_fd=@var{sock_fd} 660f67e3ffdSM. Mohan KumarEnables proxy filesystem driver to use passed socket descriptor for 661f67e3ffdSM. Mohan Kumarcommunicating with virtfs-proxy-helper. Usually a helper like libvirt 662f67e3ffdSM. Mohan Kumarwill create socketpair and pass one of the fds as sock_fd 66374db920cSGautham R Shenoy@end table 6647c92a3d2SAneesh Kumar K.V 6657c92a3d2SAneesh Kumar K.V-fsdev option is used along with -device driver "virtio-9p-pci". 6667c92a3d2SAneesh Kumar K.V@item -device virtio-9p-pci,fsdev=@var{id},mount_tag=@var{mount_tag} 6677c92a3d2SAneesh Kumar K.VOptions for virtio-9p-pci driver are: 6687c92a3d2SAneesh Kumar K.V@table @option 6697c92a3d2SAneesh Kumar K.V@item fsdev=@var{id} 6707c92a3d2SAneesh Kumar K.VSpecifies the id value specified along with -fsdev option 6717c92a3d2SAneesh Kumar K.V@item mount_tag=@var{mount_tag} 6727c92a3d2SAneesh Kumar K.VSpecifies the tag name to be used by the guest to mount this export point 6737c92a3d2SAneesh Kumar K.V@end table 6747c92a3d2SAneesh Kumar K.V 67574db920cSGautham R ShenoyETEXI 67674db920cSGautham R Shenoy 6773d54abc7SGautham R ShenoyDEF("virtfs", HAS_ARG, QEMU_OPTION_virtfs, 6782c30dd74SAneesh Kumar K.V "-virtfs local,path=path,mount_tag=tag,security_model=[mapped-xattr|mapped-file|passthrough|none]\n" 67984a87cc4SM. Mohan Kumar " [,writeout=immediate][,readonly][,socket=socket|sock_fd=sock_fd]\n", 6803d54abc7SGautham R Shenoy QEMU_ARCH_ALL) 6813d54abc7SGautham R Shenoy 6823d54abc7SGautham R ShenoySTEXI 6833d54abc7SGautham R Shenoy 68484a87cc4SM. 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}] 6853d54abc7SGautham R Shenoy@findex -virtfs 6863d54abc7SGautham R Shenoy 6877c92a3d2SAneesh Kumar K.VThe general form of a Virtual File system pass-through options are: 6887c92a3d2SAneesh Kumar K.V@table @option 6897c92a3d2SAneesh Kumar K.V@item @var{fsdriver} 6907c92a3d2SAneesh Kumar K.VThis option specifies the fs driver backend to use. 691f67e3ffdSM. Mohan KumarCurrently "local", "handle" and "proxy" file system drivers are supported. 6927c92a3d2SAneesh Kumar K.V@item id=@var{id} 6937c92a3d2SAneesh Kumar K.VSpecifies identifier for this device 6947c92a3d2SAneesh Kumar K.V@item path=@var{path} 6957c92a3d2SAneesh Kumar K.VSpecifies the export path for the file system device. Files under 6967c92a3d2SAneesh Kumar K.Vthis path will be available to the 9p client on the guest. 6977c92a3d2SAneesh Kumar K.V@item security_model=@var{security_model} 6987c92a3d2SAneesh Kumar K.VSpecifies the security model to be used for this export path. 6992c30dd74SAneesh Kumar K.VSupported security models are "passthrough", "mapped-xattr", "mapped-file" and "none". 7007c92a3d2SAneesh Kumar K.VIn "passthrough" security model, files are stored using the same 701b65ee4faSStefan Weilcredentials as they are created on the guest. This requires QEMU 7022c30dd74SAneesh Kumar K.Vto run as root. In "mapped-xattr" security model, some of the file 7037c92a3d2SAneesh Kumar K.Vattributes like uid, gid, mode bits and link target are stored as 7042c30dd74SAneesh Kumar K.Vfile attributes. For "mapped-file" these attributes are stored in the 7052c30dd74SAneesh Kumar K.Vhidden .virtfs_metadata directory. Directories exported by this security model cannot 7067c92a3d2SAneesh Kumar K.Vinteract with other unix tools. "none" security model is same as 7077c92a3d2SAneesh Kumar K.Vpassthrough except the sever won't report failures if it fails to 708d9b36a6eSM. Mohan Kumarset file attributes like ownership. Security model is mandatory only 709f67e3ffdSM. Mohan Kumarfor local fsdriver. Other fsdrivers (like handle, proxy) don't take security 710d9b36a6eSM. Mohan Kumarmodel as a parameter. 7117c92a3d2SAneesh Kumar K.V@item writeout=@var{writeout} 7127c92a3d2SAneesh Kumar K.VThis is an optional argument. The only supported value is "immediate". 7137c92a3d2SAneesh Kumar K.VThis means that host page cache will be used to read and write data but 7147c92a3d2SAneesh Kumar K.Vwrite notification will be sent to the guest only when the data has been 7157c92a3d2SAneesh Kumar K.Vreported as written by the storage subsystem. 7162c74c2cbSM. Mohan Kumar@item readonly 7172c74c2cbSM. Mohan KumarEnables exporting 9p share as a readonly mount for guests. By default 7182c74c2cbSM. Mohan Kumarread-write access is given. 71984a87cc4SM. Mohan Kumar@item socket=@var{socket} 72084a87cc4SM. Mohan KumarEnables proxy filesystem driver to use passed socket file for 72184a87cc4SM. Mohan Kumarcommunicating with virtfs-proxy-helper. Usually a helper like libvirt 72284a87cc4SM. Mohan Kumarwill create socketpair and pass one of the fds as sock_fd 723f67e3ffdSM. Mohan Kumar@item sock_fd 724f67e3ffdSM. Mohan KumarEnables proxy filesystem driver to use passed 'sock_fd' as the socket 725f67e3ffdSM. Mohan Kumardescriptor for interfacing with virtfs-proxy-helper 7263d54abc7SGautham R Shenoy@end table 7273d54abc7SGautham R ShenoyETEXI 7283d54abc7SGautham R Shenoy 7299db221aeSAneesh Kumar K.VDEF("virtfs_synth", 0, QEMU_OPTION_virtfs_synth, 7309db221aeSAneesh Kumar K.V "-virtfs_synth Create synthetic file system image\n", 7319db221aeSAneesh Kumar K.V QEMU_ARCH_ALL) 7329db221aeSAneesh Kumar K.VSTEXI 7339db221aeSAneesh Kumar K.V@item -virtfs_synth 7349db221aeSAneesh Kumar K.V@findex -virtfs_synth 7359db221aeSAneesh Kumar K.VCreate synthetic file system image 7369db221aeSAneesh Kumar K.VETEXI 7379db221aeSAneesh Kumar K.V 7385824d651Sblueswir1STEXI 7395824d651Sblueswir1@end table 7405824d651Sblueswir1ETEXI 7415824d651Sblueswir1DEFHEADING() 7425824d651Sblueswir1 74310adb8beSMarkus ArmbrusterDEFHEADING(USB options:) 74410adb8beSMarkus ArmbrusterSTEXI 74510adb8beSMarkus Armbruster@table @option 74610adb8beSMarkus ArmbrusterETEXI 74710adb8beSMarkus Armbruster 74810adb8beSMarkus ArmbrusterDEF("usb", 0, QEMU_OPTION_usb, 74910adb8beSMarkus Armbruster "-usb enable the USB driver (will be the default soon)\n", 75010adb8beSMarkus Armbruster QEMU_ARCH_ALL) 75110adb8beSMarkus ArmbrusterSTEXI 75210adb8beSMarkus Armbruster@item -usb 75310adb8beSMarkus Armbruster@findex -usb 75410adb8beSMarkus ArmbrusterEnable the USB driver (will be the default soon) 75510adb8beSMarkus ArmbrusterETEXI 75610adb8beSMarkus Armbruster 75710adb8beSMarkus ArmbrusterDEF("usbdevice", HAS_ARG, QEMU_OPTION_usbdevice, 75810adb8beSMarkus Armbruster "-usbdevice name add the host or guest USB device 'name'\n", 75910adb8beSMarkus Armbruster QEMU_ARCH_ALL) 76010adb8beSMarkus ArmbrusterSTEXI 76110adb8beSMarkus Armbruster 76210adb8beSMarkus Armbruster@item -usbdevice @var{devname} 76310adb8beSMarkus Armbruster@findex -usbdevice 76410adb8beSMarkus ArmbrusterAdd the USB device @var{devname}. @xref{usb_devices}. 76510adb8beSMarkus Armbruster 76610adb8beSMarkus Armbruster@table @option 76710adb8beSMarkus Armbruster 76810adb8beSMarkus Armbruster@item mouse 76910adb8beSMarkus ArmbrusterVirtual Mouse. This will override the PS/2 mouse emulation when activated. 77010adb8beSMarkus Armbruster 77110adb8beSMarkus Armbruster@item tablet 77210adb8beSMarkus ArmbrusterPointer device that uses absolute coordinates (like a touchscreen). This 77310adb8beSMarkus Armbrustermeans QEMU is able to report the mouse position without having to grab the 77410adb8beSMarkus Armbrustermouse. Also overrides the PS/2 mouse emulation when activated. 77510adb8beSMarkus Armbruster 77610adb8beSMarkus Armbruster@item disk:[format=@var{format}]:@var{file} 77710adb8beSMarkus ArmbrusterMass storage device based on file. The optional @var{format} argument 77810adb8beSMarkus Armbrusterwill be used rather than detecting the format. Can be used to specifiy 77910adb8beSMarkus Armbruster@code{format=raw} to avoid interpreting an untrusted format header. 78010adb8beSMarkus Armbruster 78110adb8beSMarkus Armbruster@item host:@var{bus}.@var{addr} 78210adb8beSMarkus ArmbrusterPass through the host device identified by @var{bus}.@var{addr} (Linux only). 78310adb8beSMarkus Armbruster 78410adb8beSMarkus Armbruster@item host:@var{vendor_id}:@var{product_id} 78510adb8beSMarkus ArmbrusterPass through the host device identified by @var{vendor_id}:@var{product_id} 78610adb8beSMarkus Armbruster(Linux only). 78710adb8beSMarkus Armbruster 78810adb8beSMarkus Armbruster@item serial:[vendorid=@var{vendor_id}][,productid=@var{product_id}]:@var{dev} 78910adb8beSMarkus ArmbrusterSerial converter to host character device @var{dev}, see @code{-serial} for the 79010adb8beSMarkus Armbrusteravailable devices. 79110adb8beSMarkus Armbruster 79210adb8beSMarkus Armbruster@item braille 79310adb8beSMarkus ArmbrusterBraille device. This will use BrlAPI to display the braille output on a real 79410adb8beSMarkus Armbrusteror fake device. 79510adb8beSMarkus Armbruster 79610adb8beSMarkus Armbruster@item net:@var{options} 79710adb8beSMarkus ArmbrusterNetwork adapter that supports CDC ethernet and RNDIS protocols. 79810adb8beSMarkus Armbruster 79910adb8beSMarkus Armbruster@end table 80010adb8beSMarkus ArmbrusterETEXI 80110adb8beSMarkus Armbruster 80210adb8beSMarkus ArmbrusterSTEXI 80310adb8beSMarkus Armbruster@end table 80410adb8beSMarkus ArmbrusterETEXI 80510adb8beSMarkus ArmbrusterDEFHEADING() 80610adb8beSMarkus Armbruster 8075824d651Sblueswir1DEFHEADING(Display options:) 8085824d651Sblueswir1STEXI 8095824d651Sblueswir1@table @option 8105824d651Sblueswir1ETEXI 8115824d651Sblueswir1 8121472a95bSJes SorensenDEF("display", HAS_ARG, QEMU_OPTION_display, 8131472a95bSJes Sorensen "-display sdl[,frame=on|off][,alt_grab=on|off][,ctrl_grab=on|off]\n" 8143264ff12SJes Sorensen " [,window_close=on|off]|curses|none|\n" 815881249c7SJan Kiszka " gtk[,grab_on_hover=on|off]|\n" 8163264ff12SJes Sorensen " vnc=<display>[,<optargs>]\n" 8171472a95bSJes Sorensen " select display type\n", QEMU_ARCH_ALL) 8181472a95bSJes SorensenSTEXI 8191472a95bSJes Sorensen@item -display @var{type} 8201472a95bSJes Sorensen@findex -display 8211472a95bSJes SorensenSelect type of display to use. This option is a replacement for the 8221472a95bSJes Sorensenold style -sdl/-curses/... options. Valid values for @var{type} are 8231472a95bSJes Sorensen@table @option 8241472a95bSJes Sorensen@item sdl 8251472a95bSJes SorensenDisplay video output via SDL (usually in a separate graphics 8261472a95bSJes Sorensenwindow; see the SDL documentation for other possibilities). 8271472a95bSJes Sorensen@item curses 8281472a95bSJes SorensenDisplay video output via curses. For graphics device models which 8291472a95bSJes Sorensensupport a text mode, QEMU can display this output using a 8301472a95bSJes Sorensencurses/ncurses interface. Nothing is displayed when the graphics 8311472a95bSJes Sorensendevice is in graphical mode or if the graphics device does not support 8321472a95bSJes Sorensena text mode. Generally only the VGA device models support text mode. 8334171d32eSJes Sorensen@item none 8344171d32eSJes SorensenDo not display video output. The guest will still see an emulated 8354171d32eSJes Sorensengraphics card, but its output will not be displayed to the QEMU 8364171d32eSJes Sorensenuser. This option differs from the -nographic option in that it 8374171d32eSJes Sorensenonly affects what is done with video output; -nographic also changes 8384171d32eSJes Sorensenthe destination of the serial and parallel port data. 839881249c7SJan Kiszka@item gtk 840881249c7SJan KiszkaDisplay video output in a GTK window. This interface provides drop-down 841881249c7SJan Kiszkamenus and other UI elements to configure and control the VM during 842881249c7SJan Kiszkaruntime. 8433264ff12SJes Sorensen@item vnc 8443264ff12SJes SorensenStart a VNC server on display <arg> 8451472a95bSJes Sorensen@end table 8461472a95bSJes SorensenETEXI 8471472a95bSJes Sorensen 8485824d651Sblueswir1DEF("nographic", 0, QEMU_OPTION_nographic, 849ad96090aSBlue Swirl "-nographic disable graphical output and redirect serial I/Os to console\n", 850ad96090aSBlue Swirl QEMU_ARCH_ALL) 8515824d651Sblueswir1STEXI 8525824d651Sblueswir1@item -nographic 8536616b2adSStefan Weil@findex -nographic 8545824d651Sblueswir1Normally, QEMU uses SDL to display the VGA output. With this option, 8555824d651Sblueswir1you can totally disable graphical output so that QEMU is a simple 8565824d651Sblueswir1command line application. The emulated serial port is redirected on 85702c4bdf1SPaolo Bonzinithe console and muxed with the monitor (unless redirected elsewhere 85802c4bdf1SPaolo Bonziniexplicitly). Therefore, you can still use QEMU to debug a Linux kernel 859b031f413SRamkumar Ramachandrawith a serial console. Use @key{C-a h} for help on switching between 860b031f413SRamkumar Ramachandrathe console and monitor. 8615824d651Sblueswir1ETEXI 8625824d651Sblueswir1 8635824d651Sblueswir1DEF("curses", 0, QEMU_OPTION_curses, 864ad96090aSBlue Swirl "-curses use a curses/ncurses interface instead of SDL\n", 865ad96090aSBlue Swirl QEMU_ARCH_ALL) 8665824d651Sblueswir1STEXI 8675824d651Sblueswir1@item -curses 868b8f490ebSMarkus Armbruster@findex -curses 8695824d651Sblueswir1Normally, QEMU uses SDL to display the VGA output. With this option, 8705824d651Sblueswir1QEMU can display the VGA output when in text mode using a 8715824d651Sblueswir1curses/ncurses interface. Nothing is displayed in graphical mode. 8725824d651Sblueswir1ETEXI 8735824d651Sblueswir1 8745824d651Sblueswir1DEF("no-frame", 0, QEMU_OPTION_no_frame, 875ad96090aSBlue Swirl "-no-frame open SDL window without a frame and window decorations\n", 876ad96090aSBlue Swirl QEMU_ARCH_ALL) 8775824d651Sblueswir1STEXI 8785824d651Sblueswir1@item -no-frame 8796616b2adSStefan Weil@findex -no-frame 8805824d651Sblueswir1Do not use decorations for SDL windows and start them using the whole 8815824d651Sblueswir1available screen space. This makes the using QEMU in a dedicated desktop 8825824d651Sblueswir1workspace more convenient. 8835824d651Sblueswir1ETEXI 8845824d651Sblueswir1 8855824d651Sblueswir1DEF("alt-grab", 0, QEMU_OPTION_alt_grab, 886ad96090aSBlue Swirl "-alt-grab use Ctrl-Alt-Shift to grab mouse (instead of Ctrl-Alt)\n", 887ad96090aSBlue Swirl QEMU_ARCH_ALL) 8885824d651Sblueswir1STEXI 8895824d651Sblueswir1@item -alt-grab 8906616b2adSStefan Weil@findex -alt-grab 891de1db2a1SBrad HardsUse Ctrl-Alt-Shift to grab mouse (instead of Ctrl-Alt). Note that this also 892de1db2a1SBrad Hardsaffects the special keys (for fullscreen, monitor-mode switching, etc). 8935824d651Sblueswir1ETEXI 8945824d651Sblueswir1 8950ca9f8a4SDustin KirklandDEF("ctrl-grab", 0, QEMU_OPTION_ctrl_grab, 896ad96090aSBlue Swirl "-ctrl-grab use Right-Ctrl to grab mouse (instead of Ctrl-Alt)\n", 897ad96090aSBlue Swirl QEMU_ARCH_ALL) 8980ca9f8a4SDustin KirklandSTEXI 8990ca9f8a4SDustin Kirkland@item -ctrl-grab 9006616b2adSStefan Weil@findex -ctrl-grab 901de1db2a1SBrad HardsUse Right-Ctrl to grab mouse (instead of Ctrl-Alt). Note that this also 902de1db2a1SBrad Hardsaffects the special keys (for fullscreen, monitor-mode switching, etc). 9030ca9f8a4SDustin KirklandETEXI 9040ca9f8a4SDustin Kirkland 9055824d651Sblueswir1DEF("no-quit", 0, QEMU_OPTION_no_quit, 906ad96090aSBlue Swirl "-no-quit disable SDL window close capability\n", QEMU_ARCH_ALL) 9075824d651Sblueswir1STEXI 9085824d651Sblueswir1@item -no-quit 9096616b2adSStefan Weil@findex -no-quit 9105824d651Sblueswir1Disable SDL window close capability. 9115824d651Sblueswir1ETEXI 9125824d651Sblueswir1 9135824d651Sblueswir1DEF("sdl", 0, QEMU_OPTION_sdl, 914ad96090aSBlue Swirl "-sdl enable SDL\n", QEMU_ARCH_ALL) 9155824d651Sblueswir1STEXI 9165824d651Sblueswir1@item -sdl 9176616b2adSStefan Weil@findex -sdl 9185824d651Sblueswir1Enable SDL. 9195824d651Sblueswir1ETEXI 9205824d651Sblueswir1 92129b0040bSGerd HoffmannDEF("spice", HAS_ARG, QEMU_OPTION_spice, 92227af7788SYonit Halperin "-spice [port=port][,tls-port=secured-port][,x509-dir=<dir>]\n" 92327af7788SYonit Halperin " [,x509-key-file=<file>][,x509-key-password=<file>]\n" 92427af7788SYonit Halperin " [,x509-cert-file=<file>][,x509-cacert-file=<file>]\n" 92527af7788SYonit Halperin " [,x509-dh-key-file=<file>][,addr=addr][,ipv4|ipv6]\n" 92627af7788SYonit Halperin " [,tls-ciphers=<list>]\n" 92727af7788SYonit Halperin " [,tls-channel=[main|display|cursor|inputs|record|playback]]\n" 92827af7788SYonit Halperin " [,plaintext-channel=[main|display|cursor|inputs|record|playback]]\n" 92927af7788SYonit Halperin " [,sasl][,password=<secret>][,disable-ticketing]\n" 93027af7788SYonit Halperin " [,image-compression=[auto_glz|auto_lz|quic|glz|lz|off]]\n" 93127af7788SYonit Halperin " [,jpeg-wan-compression=[auto|never|always]]\n" 93227af7788SYonit Halperin " [,zlib-glz-wan-compression=[auto|never|always]]\n" 93327af7788SYonit Halperin " [,streaming-video=[off|all|filter]][,disable-copy-paste]\n" 9345ad24e5fSHans de Goede " [,disable-agent-file-xfer][,agent-mouse=[on|off]]\n" 9355ad24e5fSHans de Goede " [,playback-compression=[on|off]][,seamless-migration=[on|off]]\n" 93627af7788SYonit Halperin " enable spice\n" 93727af7788SYonit Halperin " at least one of {port, tls-port} is mandatory\n", 93827af7788SYonit Halperin QEMU_ARCH_ALL) 93929b0040bSGerd HoffmannSTEXI 94029b0040bSGerd Hoffmann@item -spice @var{option}[,@var{option}[,...]] 94129b0040bSGerd Hoffmann@findex -spice 94229b0040bSGerd HoffmannEnable the spice remote desktop protocol. Valid options are 94329b0040bSGerd Hoffmann 94429b0040bSGerd Hoffmann@table @option 94529b0040bSGerd Hoffmann 94629b0040bSGerd Hoffmann@item port=<nr> 947c448e855SGerd HoffmannSet the TCP port spice is listening on for plaintext channels. 94829b0040bSGerd Hoffmann 949333b0eebSGerd Hoffmann@item addr=<addr> 950333b0eebSGerd HoffmannSet the IP address spice is listening on. Default is any address. 951333b0eebSGerd Hoffmann 952333b0eebSGerd Hoffmann@item ipv4 953333b0eebSGerd Hoffmann@item ipv6 954333b0eebSGerd HoffmannForce using the specified IP version. 955333b0eebSGerd Hoffmann 95629b0040bSGerd Hoffmann@item password=<secret> 95729b0040bSGerd HoffmannSet the password you need to authenticate. 95829b0040bSGerd Hoffmann 95948b3ed0aSMarc-André Lureau@item sasl 96048b3ed0aSMarc-André LureauRequire that the client use SASL to authenticate with the spice. 96148b3ed0aSMarc-André LureauThe exact choice of authentication method used is controlled from the 96248b3ed0aSMarc-André Lureausystem / user's SASL configuration file for the 'qemu' service. This 96348b3ed0aSMarc-André Lureauis typically found in /etc/sasl2/qemu.conf. If running QEMU as an 96448b3ed0aSMarc-André Lureauunprivileged user, an environment variable SASL_CONF_PATH can be used 96548b3ed0aSMarc-André Lureauto make it search alternate locations for the service config. 96648b3ed0aSMarc-André LureauWhile some SASL auth methods can also provide data encryption (eg GSSAPI), 96748b3ed0aSMarc-André Lureauit is recommended that SASL always be combined with the 'tls' and 96848b3ed0aSMarc-André Lureau'x509' settings to enable use of SSL and server certificates. This 96948b3ed0aSMarc-André Lureauensures a data encryption preventing compromise of authentication 97048b3ed0aSMarc-André Lureaucredentials. 97148b3ed0aSMarc-André Lureau 97229b0040bSGerd Hoffmann@item disable-ticketing 97329b0040bSGerd HoffmannAllow client connects without authentication. 97429b0040bSGerd Hoffmann 975d4970b07SHans de Goede@item disable-copy-paste 976d4970b07SHans de GoedeDisable copy paste between the client and the guest. 977d4970b07SHans de Goede 9785ad24e5fSHans de Goede@item disable-agent-file-xfer 9795ad24e5fSHans de GoedeDisable spice-vdagent based file-xfer between the client and the guest. 9805ad24e5fSHans de Goede 981c448e855SGerd Hoffmann@item tls-port=<nr> 982c448e855SGerd HoffmannSet the TCP port spice is listening on for encrypted channels. 983c448e855SGerd Hoffmann 984c448e855SGerd Hoffmann@item x509-dir=<dir> 985c448e855SGerd HoffmannSet the x509 file directory. Expects same filenames as -vnc $display,x509=$dir 986c448e855SGerd Hoffmann 987c448e855SGerd Hoffmann@item x509-key-file=<file> 988c448e855SGerd Hoffmann@item x509-key-password=<file> 989c448e855SGerd Hoffmann@item x509-cert-file=<file> 990c448e855SGerd Hoffmann@item x509-cacert-file=<file> 991c448e855SGerd Hoffmann@item x509-dh-key-file=<file> 992c448e855SGerd HoffmannThe x509 file names can also be configured individually. 993c448e855SGerd Hoffmann 994c448e855SGerd Hoffmann@item tls-ciphers=<list> 995c448e855SGerd HoffmannSpecify which ciphers to use. 996c448e855SGerd Hoffmann 997d70d6b31SAlon Levy@item tls-channel=[main|display|cursor|inputs|record|playback] 998d70d6b31SAlon Levy@item plaintext-channel=[main|display|cursor|inputs|record|playback] 99917b6dea0SGerd HoffmannForce specific channel to be used with or without TLS encryption. The 100017b6dea0SGerd Hoffmannoptions can be specified multiple times to configure multiple 100117b6dea0SGerd Hoffmannchannels. The special name "default" can be used to set the default 100217b6dea0SGerd Hoffmannmode. For channels which are not explicitly forced into one mode the 100317b6dea0SGerd Hoffmannspice client is allowed to pick tls/plaintext as he pleases. 100417b6dea0SGerd Hoffmann 10059f04e09eSYonit Halperin@item image-compression=[auto_glz|auto_lz|quic|glz|lz|off] 10069f04e09eSYonit HalperinConfigure image compression (lossless). 10079f04e09eSYonit HalperinDefault is auto_glz. 10089f04e09eSYonit Halperin 10099f04e09eSYonit Halperin@item jpeg-wan-compression=[auto|never|always] 10109f04e09eSYonit Halperin@item zlib-glz-wan-compression=[auto|never|always] 10119f04e09eSYonit HalperinConfigure wan image compression (lossy for slow links). 10129f04e09eSYonit HalperinDefault is auto. 10139f04e09eSYonit Halperin 101484a23f25SGerd Hoffmann@item streaming-video=[off|all|filter] 101584a23f25SGerd HoffmannConfigure video stream detection. Default is filter. 101684a23f25SGerd Hoffmann 101784a23f25SGerd Hoffmann@item agent-mouse=[on|off] 101884a23f25SGerd HoffmannEnable/disable passing mouse events via vdagent. Default is on. 101984a23f25SGerd Hoffmann 102084a23f25SGerd Hoffmann@item playback-compression=[on|off] 102184a23f25SGerd HoffmannEnable/disable audio stream compression (using celt 0.5.1). Default is on. 102284a23f25SGerd Hoffmann 10238c957053SYonit Halperin@item seamless-migration=[on|off] 10248c957053SYonit HalperinEnable/disable spice seamless migration. Default is off. 10258c957053SYonit Halperin 102629b0040bSGerd Hoffmann@end table 102729b0040bSGerd HoffmannETEXI 102829b0040bSGerd Hoffmann 10295824d651Sblueswir1DEF("portrait", 0, QEMU_OPTION_portrait, 1030ad96090aSBlue Swirl "-portrait rotate graphical output 90 deg left (only PXA LCD)\n", 1031ad96090aSBlue Swirl QEMU_ARCH_ALL) 10325824d651Sblueswir1STEXI 10335824d651Sblueswir1@item -portrait 10346616b2adSStefan Weil@findex -portrait 10355824d651Sblueswir1Rotate graphical output 90 deg left (only PXA LCD). 10365824d651Sblueswir1ETEXI 10375824d651Sblueswir1 10389312805dSVasily KhoruzhickDEF("rotate", HAS_ARG, QEMU_OPTION_rotate, 10399312805dSVasily Khoruzhick "-rotate <deg> rotate graphical output some deg left (only PXA LCD)\n", 10409312805dSVasily Khoruzhick QEMU_ARCH_ALL) 10419312805dSVasily KhoruzhickSTEXI 10426265c43bSMarkus Armbruster@item -rotate @var{deg} 10439312805dSVasily Khoruzhick@findex -rotate 10449312805dSVasily KhoruzhickRotate graphical output some deg left (only PXA LCD). 10459312805dSVasily KhoruzhickETEXI 10469312805dSVasily Khoruzhick 10475824d651Sblueswir1DEF("vga", HAS_ARG, QEMU_OPTION_vga, 104833632788SMark Cave-Ayland "-vga [std|cirrus|vmware|qxl|xenfb|tcx|cg3|none]\n" 1049ad96090aSBlue Swirl " select video card type\n", QEMU_ARCH_ALL) 10505824d651Sblueswir1STEXI 1051e4558dcaSmalc@item -vga @var{type} 10526616b2adSStefan Weil@findex -vga 10535824d651Sblueswir1Select type of VGA card to emulate. Valid values for @var{type} are 1054b3f046c2SKevin Wolf@table @option 10555824d651Sblueswir1@item cirrus 10565824d651Sblueswir1Cirrus Logic GD5446 Video card. All Windows versions starting from 10575824d651Sblueswir1Windows 95 should recognize and use this graphic card. For optimal 10585824d651Sblueswir1performances, use 16 bit color depth in the guest and the host OS. 10595824d651Sblueswir1(This one is the default) 10605824d651Sblueswir1@item std 10615824d651Sblueswir1Standard VGA card with Bochs VBE extensions. If your guest OS 10625824d651Sblueswir1supports the VESA 2.0 VBE extensions (e.g. Windows XP) and if you want 10635824d651Sblueswir1to use high resolution modes (>= 1280x1024x16) then you should use 10645824d651Sblueswir1this option. 10655824d651Sblueswir1@item vmware 10665824d651Sblueswir1VMWare SVGA-II compatible adapter. Use it if you have sufficiently 10675824d651Sblueswir1recent XFree86/XOrg server or Windows guest with a driver for this 10685824d651Sblueswir1card. 1069a19cbfb3SGerd Hoffmann@item qxl 1070a19cbfb3SGerd HoffmannQXL paravirtual graphic card. It is VGA compatible (including VESA 1071a19cbfb3SGerd Hoffmann2.0 VBE support). Works best with qxl guest drivers installed though. 1072a19cbfb3SGerd HoffmannRecommended choice when using the spice protocol. 107333632788SMark Cave-Ayland@item tcx 107433632788SMark Cave-Ayland(sun4m only) Sun TCX framebuffer. This is the default framebuffer for 107533632788SMark Cave-Aylandsun4m machines and offers both 8-bit and 24-bit colour depths at a 107633632788SMark Cave-Aylandfixed resolution of 1024x768. 107733632788SMark Cave-Ayland@item cg3 107833632788SMark Cave-Ayland(sun4m only) Sun cgthree framebuffer. This is a simple 8-bit framebuffer 107933632788SMark Cave-Aylandfor sun4m machines available in both 1024x768 (OpenBIOS) and 1152x900 (OBP) 108033632788SMark Cave-Aylandresolutions aimed at people wishing to run older Solaris versions. 10815824d651Sblueswir1@item none 10825824d651Sblueswir1Disable VGA card. 10835824d651Sblueswir1@end table 10845824d651Sblueswir1ETEXI 10855824d651Sblueswir1 10865824d651Sblueswir1DEF("full-screen", 0, QEMU_OPTION_full_screen, 1087ad96090aSBlue Swirl "-full-screen start in full screen\n", QEMU_ARCH_ALL) 10885824d651Sblueswir1STEXI 10895824d651Sblueswir1@item -full-screen 10906616b2adSStefan Weil@findex -full-screen 10915824d651Sblueswir1Start in full screen. 10925824d651Sblueswir1ETEXI 10935824d651Sblueswir1 10945824d651Sblueswir1DEF("g", 1, QEMU_OPTION_g , 1095ad96090aSBlue Swirl "-g WxH[xDEPTH] Set the initial graphical resolution and depth\n", 1096ad96090aSBlue Swirl QEMU_ARCH_PPC | QEMU_ARCH_SPARC) 10975824d651Sblueswir1STEXI 109895d5f08bSStefan Weil@item -g @var{width}x@var{height}[x@var{depth}] 10996616b2adSStefan Weil@findex -g 110095d5f08bSStefan WeilSet the initial graphical resolution and depth (PPC, SPARC only). 11015824d651Sblueswir1ETEXI 11025824d651Sblueswir1 11035824d651Sblueswir1DEF("vnc", HAS_ARG, QEMU_OPTION_vnc , 1104ad96090aSBlue Swirl "-vnc display start a VNC server on display\n", QEMU_ARCH_ALL) 11055824d651Sblueswir1STEXI 11065824d651Sblueswir1@item -vnc @var{display}[,@var{option}[,@var{option}[,...]]] 11076616b2adSStefan Weil@findex -vnc 11085824d651Sblueswir1Normally, QEMU uses SDL to display the VGA output. With this option, 11095824d651Sblueswir1you can have QEMU listen on VNC display @var{display} and redirect the VGA 11105824d651Sblueswir1display over the VNC session. It is very useful to enable the usb 11115824d651Sblueswir1tablet device when using this option (option @option{-usbdevice 11125824d651Sblueswir1tablet}). When using the VNC display, you must use the @option{-k} 11135824d651Sblueswir1parameter to set the keyboard layout if you are not using en-us. Valid 11145824d651Sblueswir1syntax for the @var{display} is 11155824d651Sblueswir1 1116b3f046c2SKevin Wolf@table @option 11175824d651Sblueswir1 11185824d651Sblueswir1@item @var{host}:@var{d} 11195824d651Sblueswir1 11205824d651Sblueswir1TCP connections will only be allowed from @var{host} on display @var{d}. 11215824d651Sblueswir1By convention the TCP port is 5900+@var{d}. Optionally, @var{host} can 11225824d651Sblueswir1be omitted in which case the server will accept connections from any host. 11235824d651Sblueswir1 11244e257e5eSKevin Wolf@item unix:@var{path} 11255824d651Sblueswir1 11265824d651Sblueswir1Connections will be allowed over UNIX domain sockets where @var{path} is the 11275824d651Sblueswir1location of a unix socket to listen for connections on. 11285824d651Sblueswir1 11295824d651Sblueswir1@item none 11305824d651Sblueswir1 11315824d651Sblueswir1VNC is initialized but not started. The monitor @code{change} command 11325824d651Sblueswir1can be used to later start the VNC server. 11335824d651Sblueswir1 11345824d651Sblueswir1@end table 11355824d651Sblueswir1 11365824d651Sblueswir1Following the @var{display} value there may be one or more @var{option} flags 11375824d651Sblueswir1separated by commas. Valid options are 11385824d651Sblueswir1 1139b3f046c2SKevin Wolf@table @option 11405824d651Sblueswir1 11415824d651Sblueswir1@item reverse 11425824d651Sblueswir1 11435824d651Sblueswir1Connect to a listening VNC client via a ``reverse'' connection. The 11445824d651Sblueswir1client is specified by the @var{display}. For reverse network 11455824d651Sblueswir1connections (@var{host}:@var{d},@code{reverse}), the @var{d} argument 11465824d651Sblueswir1is a TCP port number, not a display number. 11475824d651Sblueswir1 11487536ee4bSTim Hardeck@item websocket 11497536ee4bSTim Hardeck 11507536ee4bSTim HardeckOpens an additional TCP listening port dedicated to VNC Websocket connections. 1151085d8134SPeter MaydellBy definition the Websocket port is 5700+@var{display}. If @var{host} is 11527536ee4bSTim Hardeckspecified connections will only be allowed from this host. 11537536ee4bSTim HardeckAs an alternative the Websocket port could be specified by using 11547536ee4bSTim Hardeck@code{websocket}=@var{port}. 11550057a0d5STim HardeckTLS encryption for the Websocket connection is supported if the required 11560057a0d5STim Hardeckcertificates are specified with the VNC option @option{x509}. 11577536ee4bSTim Hardeck 11585824d651Sblueswir1@item password 11595824d651Sblueswir1 11605824d651Sblueswir1Require that password based authentication is used for client connections. 116186ee5bc3SMichal Novotny 116286ee5bc3SMichal NovotnyThe password must be set separately using the @code{set_password} command in 116386ee5bc3SMichal Novotnythe @ref{pcsys_monitor}. The syntax to change your password is: 116486ee5bc3SMichal Novotny@code{set_password <protocol> <password>} where <protocol> could be either 116586ee5bc3SMichal Novotny"vnc" or "spice". 116686ee5bc3SMichal Novotny 116786ee5bc3SMichal NovotnyIf you would like to change <protocol> password expiration, you should use 116886ee5bc3SMichal Novotny@code{expire_password <protocol> <expiration-time>} where expiration time could 116986ee5bc3SMichal Novotnybe one of the following options: now, never, +seconds or UNIX time of 117086ee5bc3SMichal Novotnyexpiration, e.g. +60 to make password expire in 60 seconds, or 1335196800 117186ee5bc3SMichal Novotnyto make password expire on "Mon Apr 23 12:00:00 EDT 2012" (UNIX time for this 117286ee5bc3SMichal Novotnydate and time). 117386ee5bc3SMichal Novotny 117486ee5bc3SMichal NovotnyYou can also use keywords "now" or "never" for the expiration time to 117586ee5bc3SMichal Novotnyallow <protocol> password to expire immediately or never expire. 11765824d651Sblueswir1 11775824d651Sblueswir1@item tls 11785824d651Sblueswir1 11795824d651Sblueswir1Require that client use TLS when communicating with the VNC server. This 11805824d651Sblueswir1uses anonymous TLS credentials so is susceptible to a man-in-the-middle 11815824d651Sblueswir1attack. It is recommended that this option be combined with either the 11824e257e5eSKevin Wolf@option{x509} or @option{x509verify} options. 11835824d651Sblueswir1 11845824d651Sblueswir1@item x509=@var{/path/to/certificate/dir} 11855824d651Sblueswir1 11865824d651Sblueswir1Valid if @option{tls} is specified. Require that x509 credentials are used 11875824d651Sblueswir1for negotiating the TLS session. The server will send its x509 certificate 11885824d651Sblueswir1to the client. It is recommended that a password be set on the VNC server 11895824d651Sblueswir1to provide authentication of the client when this is used. The path following 11905824d651Sblueswir1this option specifies where the x509 certificates are to be loaded from. 11915824d651Sblueswir1See the @ref{vnc_security} section for details on generating certificates. 11925824d651Sblueswir1 11935824d651Sblueswir1@item x509verify=@var{/path/to/certificate/dir} 11945824d651Sblueswir1 11955824d651Sblueswir1Valid if @option{tls} is specified. Require that x509 credentials are used 11965824d651Sblueswir1for negotiating the TLS session. The server will send its x509 certificate 11975824d651Sblueswir1to the client, and request that the client send its own x509 certificate. 11985824d651Sblueswir1The server will validate the client's certificate against the CA certificate, 11995824d651Sblueswir1and reject clients when validation fails. If the certificate authority is 12005824d651Sblueswir1trusted, this is a sufficient authentication mechanism. You may still wish 12015824d651Sblueswir1to set a password on the VNC server as a second authentication layer. The 12025824d651Sblueswir1path following this option specifies where the x509 certificates are to 12035824d651Sblueswir1be loaded from. See the @ref{vnc_security} section for details on generating 12045824d651Sblueswir1certificates. 12055824d651Sblueswir1 12065824d651Sblueswir1@item sasl 12075824d651Sblueswir1 12085824d651Sblueswir1Require that the client use SASL to authenticate with the VNC server. 12095824d651Sblueswir1The exact choice of authentication method used is controlled from the 12105824d651Sblueswir1system / user's SASL configuration file for the 'qemu' service. This 12115824d651Sblueswir1is typically found in /etc/sasl2/qemu.conf. If running QEMU as an 12125824d651Sblueswir1unprivileged user, an environment variable SASL_CONF_PATH can be used 12135824d651Sblueswir1to make it search alternate locations for the service config. 12145824d651Sblueswir1While some SASL auth methods can also provide data encryption (eg GSSAPI), 12155824d651Sblueswir1it is recommended that SASL always be combined with the 'tls' and 12165824d651Sblueswir1'x509' settings to enable use of SSL and server certificates. This 12175824d651Sblueswir1ensures a data encryption preventing compromise of authentication 12185824d651Sblueswir1credentials. See the @ref{vnc_security} section for details on using 12195824d651Sblueswir1SASL authentication. 12205824d651Sblueswir1 12215824d651Sblueswir1@item acl 12225824d651Sblueswir1 12235824d651Sblueswir1Turn on access control lists for checking of the x509 client certificate 12245824d651Sblueswir1and SASL party. For x509 certs, the ACL check is made against the 12255824d651Sblueswir1certificate's distinguished name. This is something that looks like 12265824d651Sblueswir1@code{C=GB,O=ACME,L=Boston,CN=bob}. For SASL party, the ACL check is 12275824d651Sblueswir1made against the username, which depending on the SASL plugin, may 12285824d651Sblueswir1include a realm component, eg @code{bob} or @code{bob@@EXAMPLE.COM}. 12295824d651Sblueswir1When the @option{acl} flag is set, the initial access list will be 12305824d651Sblueswir1empty, with a @code{deny} policy. Thus no one will be allowed to 12315824d651Sblueswir1use the VNC server until the ACLs have been loaded. This can be 12325824d651Sblueswir1achieved using the @code{acl} monitor command. 12335824d651Sblueswir1 12346f9c78c1SCorentin Chary@item lossy 12356f9c78c1SCorentin Chary 12366f9c78c1SCorentin CharyEnable lossy compression methods (gradient, JPEG, ...). If this 12376f9c78c1SCorentin Charyoption is set, VNC client may receive lossy framebuffer updates 12386f9c78c1SCorentin Charydepending on its encoding settings. Enabling this option can save 12396f9c78c1SCorentin Charya lot of bandwidth at the expense of quality. 12406f9c78c1SCorentin Chary 124180e0c8c3SCorentin Chary@item non-adaptive 124280e0c8c3SCorentin Chary 124380e0c8c3SCorentin CharyDisable adaptive encodings. Adaptive encodings are enabled by default. 124480e0c8c3SCorentin CharyAn adaptive encoding will try to detect frequently updated screen regions, 124580e0c8c3SCorentin Charyand send updates in these regions using a lossy encoding (like JPEG). 124661cc8701SStefan WeilThis can be really helpful to save bandwidth when playing videos. Disabling 12479d85d557SMichael Tokarevadaptive encodings restores the original static behavior of encodings 124880e0c8c3SCorentin Charylike Tight. 124980e0c8c3SCorentin Chary 12508cf36489SGerd Hoffmann@item share=[allow-exclusive|force-shared|ignore] 12518cf36489SGerd Hoffmann 12528cf36489SGerd HoffmannSet display sharing policy. 'allow-exclusive' allows clients to ask 12538cf36489SGerd Hoffmannfor exclusive access. As suggested by the rfb spec this is 12548cf36489SGerd Hoffmannimplemented by dropping other connections. Connecting multiple 12558cf36489SGerd Hoffmannclients in parallel requires all clients asking for a shared session 12568cf36489SGerd Hoffmann(vncviewer: -shared switch). This is the default. 'force-shared' 12578cf36489SGerd Hoffmanndisables exclusive client access. Useful for shared desktop sessions, 12588cf36489SGerd Hoffmannwhere you don't want someone forgetting specify -shared disconnect 12598cf36489SGerd Hoffmanneverybody else. 'ignore' completely ignores the shared flag and 12608cf36489SGerd Hoffmannallows everybody connect unconditionally. Doesn't conform to the rfb 1261b65ee4faSStefan Weilspec but is traditional QEMU behavior. 12628cf36489SGerd Hoffmann 12635824d651Sblueswir1@end table 12645824d651Sblueswir1ETEXI 12655824d651Sblueswir1 12665824d651Sblueswir1STEXI 12675824d651Sblueswir1@end table 12685824d651Sblueswir1ETEXI 1269a3adb7adSMichael EllermanARCHHEADING(, QEMU_ARCH_I386) 12705824d651Sblueswir1 1271a3adb7adSMichael EllermanARCHHEADING(i386 target only:, QEMU_ARCH_I386) 12725824d651Sblueswir1STEXI 12735824d651Sblueswir1@table @option 12745824d651Sblueswir1ETEXI 12755824d651Sblueswir1 12765824d651Sblueswir1DEF("win2k-hack", 0, QEMU_OPTION_win2k_hack, 1277ad96090aSBlue Swirl "-win2k-hack use it when installing Windows 2000 to avoid a disk full bug\n", 1278ad96090aSBlue Swirl QEMU_ARCH_I386) 12795824d651Sblueswir1STEXI 12805824d651Sblueswir1@item -win2k-hack 12816616b2adSStefan Weil@findex -win2k-hack 12825824d651Sblueswir1Use it when installing Windows 2000 to avoid a disk full bug. After 12835824d651Sblueswir1Windows 2000 is installed, you no longer need this option (this option 12845824d651Sblueswir1slows down the IDE transfers). 12855824d651Sblueswir1ETEXI 12865824d651Sblueswir1 12871ed2fc1fSJan KiszkaHXCOMM Deprecated by -rtc 1288ad96090aSBlue SwirlDEF("rtc-td-hack", 0, QEMU_OPTION_rtc_td_hack, "", QEMU_ARCH_I386) 12895824d651Sblueswir1 12905824d651Sblueswir1DEF("no-fd-bootchk", 0, QEMU_OPTION_no_fd_bootchk, 1291ad96090aSBlue Swirl "-no-fd-bootchk disable boot signature checking for floppy disks\n", 1292ad96090aSBlue Swirl QEMU_ARCH_I386) 12935824d651Sblueswir1STEXI 12945824d651Sblueswir1@item -no-fd-bootchk 12956616b2adSStefan Weil@findex -no-fd-bootchk 12964eda32f5SMarkus ArmbrusterDisable boot signature checking for floppy disks in BIOS. May 12975824d651Sblueswir1be needed to boot from old floppy disks. 12985824d651Sblueswir1ETEXI 12995824d651Sblueswir1 13005824d651Sblueswir1DEF("no-acpi", 0, QEMU_OPTION_no_acpi, 1301ad96090aSBlue Swirl "-no-acpi disable ACPI\n", QEMU_ARCH_I386) 13025824d651Sblueswir1STEXI 13035824d651Sblueswir1@item -no-acpi 13046616b2adSStefan Weil@findex -no-acpi 13055824d651Sblueswir1Disable ACPI (Advanced Configuration and Power Interface) support. Use 13065824d651Sblueswir1it if your guest OS complains about ACPI problems (PC target machine 13075824d651Sblueswir1only). 13085824d651Sblueswir1ETEXI 13095824d651Sblueswir1 13105824d651Sblueswir1DEF("no-hpet", 0, QEMU_OPTION_no_hpet, 1311ad96090aSBlue Swirl "-no-hpet disable HPET\n", QEMU_ARCH_I386) 13125824d651Sblueswir1STEXI 13135824d651Sblueswir1@item -no-hpet 13146616b2adSStefan Weil@findex -no-hpet 13155824d651Sblueswir1Disable HPET support. 13165824d651Sblueswir1ETEXI 13175824d651Sblueswir1 13185824d651Sblueswir1DEF("acpitable", HAS_ARG, QEMU_OPTION_acpitable, 1319104bf02eSMichael 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" 1320ad96090aSBlue Swirl " ACPI table description\n", QEMU_ARCH_I386) 13215824d651Sblueswir1STEXI 13225824d651Sblueswir1@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}]...] 13236616b2adSStefan Weil@findex -acpitable 13245824d651Sblueswir1Add ACPI table with specified header fields and context from specified files. 1325104bf02eSMichael TokarevFor file=, take whole ACPI table from the specified files, including all 1326104bf02eSMichael TokarevACPI headers (possible overridden by other options). 1327104bf02eSMichael TokarevFor data=, only data 1328104bf02eSMichael Tokarevportion of the table is used, all header information is specified in the 1329104bf02eSMichael Tokarevcommand line. 13305824d651Sblueswir1ETEXI 13315824d651Sblueswir1 1332b6f6e3d3SaliguoriDEF("smbios", HAS_ARG, QEMU_OPTION_smbios, 1333b6f6e3d3Saliguori "-smbios file=binary\n" 1334ca1a8a06SBruce Rogers " load SMBIOS entry from binary file\n" 1335e8105ebbSPaolo Bonzini "-smbios type=0[,vendor=str][,version=str][,date=str][,release=%d.%d]\n" 1336ca1a8a06SBruce Rogers " specify SMBIOS type 0 fields\n" 1337b6f6e3d3Saliguori "-smbios type=1[,manufacturer=str][,product=str][,version=str][,serial=str]\n" 1338b6f6e3d3Saliguori " [,uuid=uuid][,sku=str][,family=str]\n" 1339ad96090aSBlue Swirl " specify SMBIOS type 1 fields\n", QEMU_ARCH_I386) 1340b6f6e3d3SaliguoriSTEXI 1341b6f6e3d3Saliguori@item -smbios file=@var{binary} 13426616b2adSStefan Weil@findex -smbios 1343b6f6e3d3SaliguoriLoad SMBIOS entry from binary file. 1344b6f6e3d3Saliguori 1345b6f6e3d3Saliguori@item -smbios type=0[,vendor=@var{str}][,version=@var{str}][,date=@var{str}][,release=@var{%d.%d}] 1346b6f6e3d3SaliguoriSpecify SMBIOS type 0 fields 1347b6f6e3d3Saliguori 1348b6f6e3d3Saliguori@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}] 1349b6f6e3d3SaliguoriSpecify SMBIOS type 1 fields 1350b6f6e3d3SaliguoriETEXI 1351b6f6e3d3Saliguori 13525824d651Sblueswir1STEXI 13535824d651Sblueswir1@end table 13545824d651Sblueswir1ETEXI 1355c70a01e4SMarkus ArmbrusterDEFHEADING() 13565824d651Sblueswir1 13575824d651Sblueswir1DEFHEADING(Network options:) 13585824d651Sblueswir1STEXI 13595824d651Sblueswir1@table @option 13605824d651Sblueswir1ETEXI 13615824d651Sblueswir1 1362ad196a9dSJan KiszkaHXCOMM Legacy slirp options (now moved to -net user): 1363ad196a9dSJan Kiszka#ifdef CONFIG_SLIRP 1364ad96090aSBlue SwirlDEF("tftp", HAS_ARG, QEMU_OPTION_tftp, "", QEMU_ARCH_ALL) 1365ad96090aSBlue SwirlDEF("bootp", HAS_ARG, QEMU_OPTION_bootp, "", QEMU_ARCH_ALL) 1366ad96090aSBlue SwirlDEF("redir", HAS_ARG, QEMU_OPTION_redir, "", QEMU_ARCH_ALL) 1367ad196a9dSJan Kiszka#ifndef _WIN32 1368ad96090aSBlue SwirlDEF("smb", HAS_ARG, QEMU_OPTION_smb, "", QEMU_ARCH_ALL) 1369ad196a9dSJan Kiszka#endif 1370ad196a9dSJan Kiszka#endif 1371ad196a9dSJan Kiszka 1372bab7944cSBlue SwirlDEF("net", HAS_ARG, QEMU_OPTION_net, 1373ffe6370cSMichael S. Tsirkin "-net nic[,vlan=n][,macaddr=mac][,model=type][,name=str][,addr=str][,vectors=v]\n" 13745824d651Sblueswir1 " create a new Network Interface Card and connect it to VLAN 'n'\n" 13755824d651Sblueswir1#ifdef CONFIG_SLIRP 1376c54ed5bcSJan Kiszka "-net user[,vlan=n][,name=str][,net=addr[/mask]][,host=addr][,restrict=on|off]\n" 137763d2960bSKlaus Stengel " [,hostname=host][,dhcpstart=addr][,dns=addr][,dnssearch=domain][,tftp=dir]\n" 137863d2960bSKlaus Stengel " [,bootfile=f][,hostfwd=rule][,guestfwd=rule]" 1379ad196a9dSJan Kiszka#ifndef _WIN32 1380c92ef6a2SJan Kiszka "[,smb=dir[,smbserver=addr]]\n" 1381ad196a9dSJan Kiszka#endif 1382ad196a9dSJan Kiszka " connect the user mode network stack to VLAN 'n', configure its\n" 1383ad196a9dSJan Kiszka " DHCP server and enabled optional services\n" 13845824d651Sblueswir1#endif 13855824d651Sblueswir1#ifdef _WIN32 13865824d651Sblueswir1 "-net tap[,vlan=n][,name=str],ifname=name\n" 13875824d651Sblueswir1 " connect the host TAP network interface to VLAN 'n'\n" 13885824d651Sblueswir1#else 1389ec396014SJason Wang "-net tap[,vlan=n][,name=str][,fd=h][,fds=x:y:...:z][,ifname=name][,script=file][,downscript=dfile][,helper=helper][,sndbuf=nbytes][,vnet_hdr=on|off][,vhost=on|off][,vhostfd=h][,vhostfds=x:y:...:z][,vhostforce=on|off][,queues=n]\n" 1390a7c36ee4SCorey Bryant " connect the host TAP network interface to VLAN 'n'\n" 1391a7c36ee4SCorey Bryant " use network scripts 'file' (default=" DEFAULT_NETWORK_SCRIPT ")\n" 1392a7c36ee4SCorey Bryant " to configure it and 'dfile' (default=" DEFAULT_NETWORK_DOWN_SCRIPT ")\n" 1393a7c36ee4SCorey Bryant " to deconfigure it\n" 1394ca1a8a06SBruce Rogers " use '[down]script=no' to disable script execution\n" 1395a7c36ee4SCorey Bryant " use network helper 'helper' (default=" DEFAULT_BRIDGE_HELPER ") to\n" 1396a7c36ee4SCorey Bryant " configure it\n" 13975824d651Sblueswir1 " use 'fd=h' to connect to an already opened TAP interface\n" 13982ca81baaSJason Wang " use 'fds=x:y:...:z' to connect to already opened multiqueue capable TAP interfaces\n" 1399ca1a8a06SBruce Rogers " use 'sndbuf=nbytes' to limit the size of the send buffer (the\n" 1400f157ed20SMichael S. Tsirkin " default is disabled 'sndbuf=0' to enable flow control set 'sndbuf=1048576')\n" 1401ca1a8a06SBruce Rogers " use vnet_hdr=off to avoid enabling the IFF_VNET_HDR tap flag\n" 1402ca1a8a06SBruce Rogers " use vnet_hdr=on to make the lack of IFF_VNET_HDR support an error condition\n" 140382b0d80eSMichael S. Tsirkin " use vhost=on to enable experimental in kernel accelerator\n" 14045430a28fSmst@redhat.com " (only has effect for virtio guests which use MSIX)\n" 14055430a28fSmst@redhat.com " use vhostforce=on to force vhost on for non-MSIX virtio guests\n" 140682b0d80eSMichael S. Tsirkin " use 'vhostfd=h' to connect to an already opened vhost net device\n" 14072ca81baaSJason Wang " use 'vhostfds=x:y:...:z to connect to multiple already opened vhost net devices\n" 1408ec396014SJason Wang " use 'queues=n' to specify the number of queues to be created for multiqueue TAP\n" 1409a7c36ee4SCorey Bryant "-net bridge[,vlan=n][,name=str][,br=bridge][,helper=helper]\n" 1410a7c36ee4SCorey Bryant " connects a host TAP network interface to a host bridge device 'br'\n" 1411a7c36ee4SCorey Bryant " (default=" DEFAULT_BRIDGE_INTERFACE ") using the program 'helper'\n" 1412a7c36ee4SCorey Bryant " (default=" DEFAULT_BRIDGE_HELPER ")\n" 14130df0ff6dSMark McLoughlin#endif 14145824d651Sblueswir1 "-net socket[,vlan=n][,name=str][,fd=h][,listen=[host]:port][,connect=host:port]\n" 14155824d651Sblueswir1 " connect the vlan 'n' to another VLAN using a socket connection\n" 14163a75e74cSMike Ryan "-net socket[,vlan=n][,name=str][,fd=h][,mcast=maddr:port[,localaddr=addr]]\n" 14175824d651Sblueswir1 " connect the vlan 'n' to multicast maddr and port\n" 14183a75e74cSMike Ryan " use 'localaddr=addr' to specify the host address to send packets from\n" 14190e0e7facSBenjamin "-net socket[,vlan=n][,name=str][,fd=h][,udp=host:port][,localaddr=host:port]\n" 14200e0e7facSBenjamin " connect the vlan 'n' to another VLAN using an UDP tunnel\n" 14215824d651Sblueswir1#ifdef CONFIG_VDE 14225824d651Sblueswir1 "-net vde[,vlan=n][,name=str][,sock=socketpath][,port=n][,group=groupname][,mode=octalmode]\n" 14235824d651Sblueswir1 " connect the vlan 'n' to port 'n' of a vde switch running\n" 14245824d651Sblueswir1 " on host and listening for incoming connections on 'socketpath'.\n" 14255824d651Sblueswir1 " Use group 'groupname' and mode 'octalmode' to change default\n" 14265824d651Sblueswir1 " ownership and permissions for communication port.\n" 14275824d651Sblueswir1#endif 142858952137SVincenzo Maffione#ifdef CONFIG_NETMAP 142958952137SVincenzo Maffione "-net netmap,ifname=name[,devname=nmname]\n" 143058952137SVincenzo Maffione " attach to the existing netmap-enabled network interface 'name', or to a\n" 143158952137SVincenzo Maffione " VALE port (created on the fly) called 'name' ('nmname' is name of the \n" 143258952137SVincenzo Maffione " netmap device, defaults to '/dev/netmap')\n" 143358952137SVincenzo Maffione#endif 1434bb9ea79eSaliguori "-net dump[,vlan=n][,file=f][,len=n]\n" 1435bb9ea79eSaliguori " dump traffic on vlan 'n' to file 'f' (max n bytes per packet)\n" 1436ca1a8a06SBruce Rogers "-net none use it alone to have zero network devices. If no -net option\n" 1437ad96090aSBlue Swirl " is provided, the default is '-net nic -net user'\n", QEMU_ARCH_ALL) 1438a1ea458fSMark McLoughlinDEF("netdev", HAS_ARG, QEMU_OPTION_netdev, 1439a1ea458fSMark McLoughlin "-netdev [" 1440a1ea458fSMark McLoughlin#ifdef CONFIG_SLIRP 1441a1ea458fSMark McLoughlin "user|" 1442a1ea458fSMark McLoughlin#endif 1443a1ea458fSMark McLoughlin "tap|" 1444a7c36ee4SCorey Bryant "bridge|" 1445a1ea458fSMark McLoughlin#ifdef CONFIG_VDE 1446a1ea458fSMark McLoughlin "vde|" 1447a1ea458fSMark McLoughlin#endif 144858952137SVincenzo Maffione#ifdef CONFIG_NETMAP 144958952137SVincenzo Maffione "netmap|" 145058952137SVincenzo Maffione#endif 145140e8c26dSStefan Hajnoczi "socket|" 145240e8c26dSStefan Hajnoczi "hubport],id=str[,option][,option][,...]\n", QEMU_ARCH_ALL) 14535824d651Sblueswir1STEXI 1454ffe6370cSMichael S. Tsirkin@item -net nic[,vlan=@var{n}][,macaddr=@var{mac}][,model=@var{type}] [,name=@var{name}][,addr=@var{addr}][,vectors=@var{v}] 14556616b2adSStefan Weil@findex -net 14565824d651Sblueswir1Create a new Network Interface Card and connect it to VLAN @var{n} (@var{n} 14570d6b0b1dSAnthony Liguori= 0 is the default). The NIC is an e1000 by default on the PC 14585607c388SMarkus Armbrustertarget. Optionally, the MAC address can be changed to @var{mac}, the 14595607c388SMarkus Armbrusterdevice address set to @var{addr} (PCI cards only), 1460ffe6370cSMichael S. Tsirkinand a @var{name} can be assigned for use in monitor commands. 1461ffe6370cSMichael S. TsirkinOptionally, for PCI cards, you can specify the number @var{v} of MSI-X vectors 1462ffe6370cSMichael S. Tsirkinthat the card should have; this option currently only affects virtio cards; set 1463ffe6370cSMichael S. Tsirkin@var{v} = 0 to disable MSI-X. If no @option{-net} option is specified, a single 1464071c9394SStefan WeilNIC is created. QEMU can emulate several different models of network card. 14655824d651Sblueswir1Valid values for @var{type} are 1466ffe6370cSMichael S. Tsirkin@code{virtio}, @code{i82551}, @code{i82557b}, @code{i82559er}, 14675824d651Sblueswir1@code{ne2k_pci}, @code{ne2k_isa}, @code{pcnet}, @code{rtl8139}, 14685824d651Sblueswir1@code{e1000}, @code{smc91c111}, @code{lance} and @code{mcf_fec}. 1469585f6036SPeter MaydellNot all devices are supported on all targets. Use @code{-net nic,model=help} 14705824d651Sblueswir1for a list of available devices for your target. 14715824d651Sblueswir1 147208d12022SStefan Hajnoczi@item -netdev user,id=@var{id}[,@var{option}][,@var{option}][,...] 1473b8f490ebSMarkus Armbruster@findex -netdev 1474ad196a9dSJan Kiszka@item -net user[,@var{option}][,@var{option}][,...] 14755824d651Sblueswir1Use the user mode network stack which requires no administrator 1476ad196a9dSJan Kiszkaprivilege to run. Valid options are: 14775824d651Sblueswir1 1478b3f046c2SKevin Wolf@table @option 1479ad196a9dSJan Kiszka@item vlan=@var{n} 1480ad196a9dSJan KiszkaConnect user mode stack to VLAN @var{n} (@var{n} = 0 is the default). 1481ad196a9dSJan Kiszka 148208d12022SStefan Hajnoczi@item id=@var{id} 1483ad196a9dSJan Kiszka@item name=@var{name} 1484ad196a9dSJan KiszkaAssign symbolic name for use in monitor commands. 1485ad196a9dSJan Kiszka 1486c92ef6a2SJan Kiszka@item net=@var{addr}[/@var{mask}] 1487c92ef6a2SJan KiszkaSet IP network address the guest will see. Optionally specify the netmask, 1488c92ef6a2SJan Kiszkaeither in the form a.b.c.d or as number of valid top-most bits. Default is 1489b0b36e5dSBrad Hards10.0.2.0/24. 1490c92ef6a2SJan Kiszka 1491c92ef6a2SJan Kiszka@item host=@var{addr} 1492c92ef6a2SJan KiszkaSpecify the guest-visible address of the host. Default is the 2nd IP in the 1493c92ef6a2SJan Kiszkaguest network, i.e. x.x.x.2. 1494ad196a9dSJan Kiszka 1495c54ed5bcSJan Kiszka@item restrict=on|off 1496caef55edSBrad HardsIf this option is enabled, the guest will be isolated, i.e. it will not be 1497ad196a9dSJan Kiszkaable to contact the host and no guest IP packets will be routed over the host 1498caef55edSBrad Hardsto the outside. This option does not affect any explicitly set forwarding rules. 1499ad196a9dSJan Kiszka 1500ad196a9dSJan Kiszka@item hostname=@var{name} 150163d2960bSKlaus StengelSpecifies the client hostname reported by the built-in DHCP server. 1502ad196a9dSJan Kiszka 1503c92ef6a2SJan Kiszka@item dhcpstart=@var{addr} 1504c92ef6a2SJan KiszkaSpecify the first of the 16 IPs the built-in DHCP server can assign. Default 1505b0b36e5dSBrad Hardsis the 15th to 31st IP in the guest network, i.e. x.x.x.15 to x.x.x.31. 1506c92ef6a2SJan Kiszka 1507c92ef6a2SJan Kiszka@item dns=@var{addr} 1508c92ef6a2SJan KiszkaSpecify the guest-visible address of the virtual nameserver. The address must 1509c92ef6a2SJan Kiszkabe different from the host address. Default is the 3rd IP in the guest network, 1510c92ef6a2SJan Kiszkai.e. x.x.x.3. 1511c92ef6a2SJan Kiszka 151263d2960bSKlaus Stengel@item dnssearch=@var{domain} 151363d2960bSKlaus StengelProvides an entry for the domain-search list sent by the built-in 151463d2960bSKlaus StengelDHCP server. More than one domain suffix can be transmitted by specifying 151563d2960bSKlaus Stengelthis option multiple times. If supported, this will cause the guest to 151663d2960bSKlaus Stengelautomatically try to append the given domain suffix(es) in case a domain name 151763d2960bSKlaus Stengelcan not be resolved. 151863d2960bSKlaus Stengel 151963d2960bSKlaus StengelExample: 152063d2960bSKlaus Stengel@example 152163d2960bSKlaus Stengelqemu -net user,dnssearch=mgmt.example.org,dnssearch=example.org [...] 152263d2960bSKlaus Stengel@end example 152363d2960bSKlaus Stengel 1524ad196a9dSJan Kiszka@item tftp=@var{dir} 1525ad196a9dSJan KiszkaWhen using the user mode network stack, activate a built-in TFTP 1526ad196a9dSJan Kiszkaserver. The files in @var{dir} will be exposed as the root of a TFTP server. 1527ad196a9dSJan KiszkaThe TFTP client on the guest must be configured in binary mode (use the command 1528c92ef6a2SJan Kiszka@code{bin} of the Unix TFTP client). 1529ad196a9dSJan Kiszka 1530ad196a9dSJan Kiszka@item bootfile=@var{file} 1531ad196a9dSJan KiszkaWhen using the user mode network stack, broadcast @var{file} as the BOOTP 1532ad196a9dSJan Kiszkafilename. In conjunction with @option{tftp}, this can be used to network boot 1533ad196a9dSJan Kiszkaa guest from a local directory. 1534ad196a9dSJan Kiszka 1535ad196a9dSJan KiszkaExample (using pxelinux): 1536ad196a9dSJan Kiszka@example 15373804da9dSStefan Weilqemu-system-i386 -hda linux.img -boot n -net user,tftp=/path/to/tftp/files,bootfile=/pxelinux.0 1538ad196a9dSJan Kiszka@end example 1539ad196a9dSJan Kiszka 1540c92ef6a2SJan Kiszka@item smb=@var{dir}[,smbserver=@var{addr}] 1541ad196a9dSJan KiszkaWhen using the user mode network stack, activate a built-in SMB 1542ad196a9dSJan Kiszkaserver so that Windows OSes can access to the host files in @file{@var{dir}} 1543c92ef6a2SJan Kiszkatransparently. The IP address of the SMB server can be set to @var{addr}. By 1544c92ef6a2SJan Kiszkadefault the 4th IP in the guest network is used, i.e. x.x.x.4. 1545ad196a9dSJan Kiszka 1546ad196a9dSJan KiszkaIn the guest Windows OS, the line: 1547ad196a9dSJan Kiszka@example 1548ad196a9dSJan Kiszka10.0.2.4 smbserver 1549ad196a9dSJan Kiszka@end example 1550ad196a9dSJan Kiszkamust be added in the file @file{C:\WINDOWS\LMHOSTS} (for windows 9x/Me) 1551ad196a9dSJan Kiszkaor @file{C:\WINNT\SYSTEM32\DRIVERS\ETC\LMHOSTS} (Windows NT/2000). 1552ad196a9dSJan Kiszka 1553ad196a9dSJan KiszkaThen @file{@var{dir}} can be accessed in @file{\\smbserver\qemu}. 1554ad196a9dSJan Kiszka 1555e2d8830eSBradNote that a SAMBA server must be installed on the host OS. 1556e2d8830eSBradQEMU was tested successfully with smbd versions from Red Hat 9, 1557e2d8830eSBradFedora Core 3 and OpenSUSE 11.x. 1558ad196a9dSJan Kiszka 15593c6a0580SJan Kiszka@item hostfwd=[tcp|udp]:[@var{hostaddr}]:@var{hostport}-[@var{guestaddr}]:@var{guestport} 1560c92ef6a2SJan KiszkaRedirect incoming TCP or UDP connections to the host port @var{hostport} to 1561c92ef6a2SJan Kiszkathe guest IP address @var{guestaddr} on guest port @var{guestport}. If 1562c92ef6a2SJan Kiszka@var{guestaddr} is not specified, its value is x.x.x.15 (default first address 15633c6a0580SJan Kiszkagiven by the built-in DHCP server). By specifying @var{hostaddr}, the rule can 15643c6a0580SJan Kiszkabe bound to a specific host interface. If no connection type is set, TCP is 1565c92ef6a2SJan Kiszkaused. This option can be given multiple times. 1566ad196a9dSJan Kiszka 1567ad196a9dSJan KiszkaFor example, to redirect host X11 connection from screen 1 to guest 1568ad196a9dSJan Kiszkascreen 0, use the following: 1569ad196a9dSJan Kiszka 1570ad196a9dSJan Kiszka@example 1571ad196a9dSJan Kiszka# on the host 15723804da9dSStefan Weilqemu-system-i386 -net user,hostfwd=tcp:127.0.0.1:6001-:6000 [...] 1573ad196a9dSJan Kiszka# this host xterm should open in the guest X11 server 1574ad196a9dSJan Kiszkaxterm -display :1 1575ad196a9dSJan Kiszka@end example 1576ad196a9dSJan Kiszka 1577ad196a9dSJan KiszkaTo redirect telnet connections from host port 5555 to telnet port on 1578ad196a9dSJan Kiszkathe guest, use the following: 1579ad196a9dSJan Kiszka 1580ad196a9dSJan Kiszka@example 1581ad196a9dSJan Kiszka# on the host 15823804da9dSStefan Weilqemu-system-i386 -net user,hostfwd=tcp::5555-:23 [...] 1583ad196a9dSJan Kiszkatelnet localhost 5555 1584ad196a9dSJan Kiszka@end example 1585ad196a9dSJan Kiszka 1586ad196a9dSJan KiszkaThen when you use on the host @code{telnet localhost 5555}, you 1587ad196a9dSJan Kiszkaconnect to the guest telnet server. 1588ad196a9dSJan Kiszka 1589c92ef6a2SJan Kiszka@item guestfwd=[tcp]:@var{server}:@var{port}-@var{dev} 1590b412eb61SAlexander Graf@item guestfwd=[tcp]:@var{server}:@var{port}-@var{cmd:command} 15913c6a0580SJan KiszkaForward guest TCP connections to the IP address @var{server} on port @var{port} 1592b412eb61SAlexander Grafto the character device @var{dev} or to a program executed by @var{cmd:command} 1593b412eb61SAlexander Grafwhich gets spawned for each connection. This option can be given multiple times. 1594b412eb61SAlexander Graf 159543ffe61fSStefan WeilYou can either use a chardev directly and have that one used throughout QEMU's 1596b412eb61SAlexander Graflifetime, like in the following example: 1597b412eb61SAlexander Graf 1598b412eb61SAlexander Graf@example 1599b412eb61SAlexander Graf# open 10.10.1.1:4321 on bootup, connect 10.0.2.100:1234 to it whenever 1600b412eb61SAlexander Graf# the guest accesses it 1601b412eb61SAlexander Grafqemu -net user,guestfwd=tcp:10.0.2.100:1234-tcp:10.10.1.1:4321 [...] 1602b412eb61SAlexander Graf@end example 1603b412eb61SAlexander Graf 1604b412eb61SAlexander GrafOr you can execute a command on every TCP connection established by the guest, 160543ffe61fSStefan Weilso that QEMU behaves similar to an inetd process for that virtual server: 1606b412eb61SAlexander Graf 1607b412eb61SAlexander Graf@example 1608b412eb61SAlexander Graf# call "netcat 10.10.1.1 4321" on every TCP connection to 10.0.2.100:1234 1609b412eb61SAlexander Graf# and connect the TCP stream to its stdin/stdout 1610b412eb61SAlexander Grafqemu -net 'user,guestfwd=tcp:10.0.2.100:1234-cmd:netcat 10.10.1.1 4321' 1611b412eb61SAlexander Graf@end example 1612ad196a9dSJan Kiszka 1613ad196a9dSJan Kiszka@end table 1614ad196a9dSJan Kiszka 1615ad196a9dSJan KiszkaNote: Legacy stand-alone options -tftp, -bootp, -smb and -redir are still 1616ad196a9dSJan Kiszkaprocessed and applied to -net user. Mixing them with the new configuration 1617ad196a9dSJan Kiszkasyntax gives undefined results. Their use for new applications is discouraged 1618ad196a9dSJan Kiszkaas they will be removed from future versions. 16195824d651Sblueswir1 162008d12022SStefan Hajnoczi@item -netdev tap,id=@var{id}[,fd=@var{h}][,ifname=@var{name}][,script=@var{file}][,downscript=@var{dfile}][,helper=@var{helper}] 1621a7c36ee4SCorey 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}] 1622a7c36ee4SCorey BryantConnect the host TAP network interface @var{name} to VLAN @var{n}. 1623a7c36ee4SCorey Bryant 1624a7c36ee4SCorey BryantUse the network script @var{file} to configure it and the network script 16255824d651Sblueswir1@var{dfile} to deconfigure it. If @var{name} is not provided, the OS 1626a7c36ee4SCorey Bryantautomatically provides one. The default network configure script is 1627a7c36ee4SCorey Bryant@file{/etc/qemu-ifup} and the default network deconfigure script is 1628a7c36ee4SCorey Bryant@file{/etc/qemu-ifdown}. Use @option{script=no} or @option{downscript=no} 1629a7c36ee4SCorey Bryantto disable script execution. 1630a7c36ee4SCorey Bryant 1631a7c36ee4SCorey BryantIf running QEMU as an unprivileged user, use the network helper 1632a7c36ee4SCorey Bryant@var{helper} to configure the TAP interface. The default network 1633420508fbSAmos Konghelper executable is @file{/path/to/qemu-bridge-helper}. 1634a7c36ee4SCorey Bryant 1635a7c36ee4SCorey Bryant@option{fd}=@var{h} can be used to specify the handle of an already 1636a7c36ee4SCorey Bryantopened host TAP interface. 1637a7c36ee4SCorey Bryant 1638a7c36ee4SCorey BryantExamples: 16395824d651Sblueswir1 16405824d651Sblueswir1@example 1641a7c36ee4SCorey Bryant#launch a QEMU instance with the default network script 16423804da9dSStefan Weilqemu-system-i386 linux.img -net nic -net tap 16435824d651Sblueswir1@end example 16445824d651Sblueswir1 16455824d651Sblueswir1@example 1646a7c36ee4SCorey Bryant#launch a QEMU instance with two NICs, each one connected 1647a7c36ee4SCorey Bryant#to a TAP device 16483804da9dSStefan Weilqemu-system-i386 linux.img \ 16493804da9dSStefan Weil -net nic,vlan=0 -net tap,vlan=0,ifname=tap0 \ 16505824d651Sblueswir1 -net nic,vlan=1 -net tap,vlan=1,ifname=tap1 16515824d651Sblueswir1@end example 16525824d651Sblueswir1 1653a7c36ee4SCorey Bryant@example 1654a7c36ee4SCorey Bryant#launch a QEMU instance with the default network helper to 1655a7c36ee4SCorey Bryant#connect a TAP device to bridge br0 16563804da9dSStefan Weilqemu-system-i386 linux.img \ 1657420508fbSAmos Kong -net nic -net tap,"helper=/path/to/qemu-bridge-helper" 1658a7c36ee4SCorey Bryant@end example 1659a7c36ee4SCorey Bryant 166008d12022SStefan Hajnoczi@item -netdev bridge,id=@var{id}[,br=@var{bridge}][,helper=@var{helper}] 1661a7c36ee4SCorey Bryant@item -net bridge[,vlan=@var{n}][,name=@var{name}][,br=@var{bridge}][,helper=@var{helper}] 1662a7c36ee4SCorey BryantConnect a host TAP network interface to a host bridge device. 1663a7c36ee4SCorey Bryant 1664a7c36ee4SCorey BryantUse the network helper @var{helper} to configure the TAP interface and 1665a7c36ee4SCorey Bryantattach it to the bridge. The default network helper executable is 1666420508fbSAmos Kong@file{/path/to/qemu-bridge-helper} and the default bridge 1667a7c36ee4SCorey Bryantdevice is @file{br0}. 1668a7c36ee4SCorey Bryant 1669a7c36ee4SCorey BryantExamples: 1670a7c36ee4SCorey Bryant 1671a7c36ee4SCorey Bryant@example 1672a7c36ee4SCorey Bryant#launch a QEMU instance with the default network helper to 1673a7c36ee4SCorey Bryant#connect a TAP device to bridge br0 16743804da9dSStefan Weilqemu-system-i386 linux.img -net bridge -net nic,model=virtio 1675a7c36ee4SCorey Bryant@end example 1676a7c36ee4SCorey Bryant 1677a7c36ee4SCorey Bryant@example 1678a7c36ee4SCorey Bryant#launch a QEMU instance with the default network helper to 1679a7c36ee4SCorey Bryant#connect a TAP device to bridge qemubr0 16803804da9dSStefan Weilqemu-system-i386 linux.img -net bridge,br=qemubr0 -net nic,model=virtio 1681a7c36ee4SCorey Bryant@end example 1682a7c36ee4SCorey Bryant 168308d12022SStefan Hajnoczi@item -netdev socket,id=@var{id}[,fd=@var{h}][,listen=[@var{host}]:@var{port}][,connect=@var{host}:@var{port}] 16845824d651Sblueswir1@item -net socket[,vlan=@var{n}][,name=@var{name}][,fd=@var{h}] [,listen=[@var{host}]:@var{port}][,connect=@var{host}:@var{port}] 16855824d651Sblueswir1 16865824d651Sblueswir1Connect the VLAN @var{n} to a remote VLAN in another QEMU virtual 16875824d651Sblueswir1machine using a TCP socket connection. If @option{listen} is 16885824d651Sblueswir1specified, QEMU waits for incoming connections on @var{port} 16895824d651Sblueswir1(@var{host} is optional). @option{connect} is used to connect to 16905824d651Sblueswir1another QEMU instance using the @option{listen} option. @option{fd}=@var{h} 16915824d651Sblueswir1specifies an already opened TCP socket. 16925824d651Sblueswir1 16935824d651Sblueswir1Example: 16945824d651Sblueswir1@example 16955824d651Sblueswir1# launch a first QEMU instance 16963804da9dSStefan Weilqemu-system-i386 linux.img \ 16973804da9dSStefan Weil -net nic,macaddr=52:54:00:12:34:56 \ 16985824d651Sblueswir1 -net socket,listen=:1234 16995824d651Sblueswir1# connect the VLAN 0 of this instance to the VLAN 0 17005824d651Sblueswir1# of the first instance 17013804da9dSStefan Weilqemu-system-i386 linux.img \ 17023804da9dSStefan Weil -net nic,macaddr=52:54:00:12:34:57 \ 17035824d651Sblueswir1 -net socket,connect=127.0.0.1:1234 17045824d651Sblueswir1@end example 17055824d651Sblueswir1 170608d12022SStefan Hajnoczi@item -netdev socket,id=@var{id}[,fd=@var{h}][,mcast=@var{maddr}:@var{port}[,localaddr=@var{addr}]] 17073a75e74cSMike Ryan@item -net socket[,vlan=@var{n}][,name=@var{name}][,fd=@var{h}][,mcast=@var{maddr}:@var{port}[,localaddr=@var{addr}]] 17085824d651Sblueswir1 17095824d651Sblueswir1Create a VLAN @var{n} shared with another QEMU virtual 17105824d651Sblueswir1machines using a UDP multicast socket, effectively making a bus for 17115824d651Sblueswir1every QEMU with same multicast address @var{maddr} and @var{port}. 17125824d651Sblueswir1NOTES: 17135824d651Sblueswir1@enumerate 17145824d651Sblueswir1@item 17155824d651Sblueswir1Several QEMU can be running on different hosts and share same bus (assuming 17165824d651Sblueswir1correct multicast setup for these hosts). 17175824d651Sblueswir1@item 17185824d651Sblueswir1mcast support is compatible with User Mode Linux (argument @option{eth@var{N}=mcast}), see 17195824d651Sblueswir1@url{http://user-mode-linux.sf.net}. 17205824d651Sblueswir1@item 17215824d651Sblueswir1Use @option{fd=h} to specify an already opened UDP multicast socket. 17225824d651Sblueswir1@end enumerate 17235824d651Sblueswir1 17245824d651Sblueswir1Example: 17255824d651Sblueswir1@example 17265824d651Sblueswir1# launch one QEMU instance 17273804da9dSStefan Weilqemu-system-i386 linux.img \ 17283804da9dSStefan Weil -net nic,macaddr=52:54:00:12:34:56 \ 17295824d651Sblueswir1 -net socket,mcast=230.0.0.1:1234 17305824d651Sblueswir1# launch another QEMU instance on same "bus" 17313804da9dSStefan Weilqemu-system-i386 linux.img \ 17323804da9dSStefan Weil -net nic,macaddr=52:54:00:12:34:57 \ 17335824d651Sblueswir1 -net socket,mcast=230.0.0.1:1234 17345824d651Sblueswir1# launch yet another QEMU instance on same "bus" 17353804da9dSStefan Weilqemu-system-i386 linux.img \ 17363804da9dSStefan Weil -net nic,macaddr=52:54:00:12:34:58 \ 17375824d651Sblueswir1 -net socket,mcast=230.0.0.1:1234 17385824d651Sblueswir1@end example 17395824d651Sblueswir1 17405824d651Sblueswir1Example (User Mode Linux compat.): 17415824d651Sblueswir1@example 17425824d651Sblueswir1# launch QEMU instance (note mcast address selected 17435824d651Sblueswir1# is UML's default) 17443804da9dSStefan Weilqemu-system-i386 linux.img \ 17453804da9dSStefan Weil -net nic,macaddr=52:54:00:12:34:56 \ 17465824d651Sblueswir1 -net socket,mcast=239.192.168.1:1102 17475824d651Sblueswir1# launch UML 17485824d651Sblueswir1/path/to/linux ubd0=/path/to/root_fs eth0=mcast 17495824d651Sblueswir1@end example 17505824d651Sblueswir1 17513a75e74cSMike RyanExample (send packets from host's 1.2.3.4): 17523a75e74cSMike Ryan@example 17533804da9dSStefan Weilqemu-system-i386 linux.img \ 17543804da9dSStefan Weil -net nic,macaddr=52:54:00:12:34:56 \ 17553a75e74cSMike Ryan -net socket,mcast=239.192.168.1:1102,localaddr=1.2.3.4 17563a75e74cSMike Ryan@end example 17573a75e74cSMike Ryan 175808d12022SStefan Hajnoczi@item -netdev vde,id=@var{id}[,sock=@var{socketpath}][,port=@var{n}][,group=@var{groupname}][,mode=@var{octalmode}] 17595824d651Sblueswir1@item -net vde[,vlan=@var{n}][,name=@var{name}][,sock=@var{socketpath}] [,port=@var{n}][,group=@var{groupname}][,mode=@var{octalmode}] 17605824d651Sblueswir1Connect VLAN @var{n} to PORT @var{n} of a vde switch running on host and 17615824d651Sblueswir1listening for incoming connections on @var{socketpath}. Use GROUP @var{groupname} 17625824d651Sblueswir1and MODE @var{octalmode} to change default ownership and permissions for 1763c1ba4e0bSStefan Weilcommunication port. This option is only available if QEMU has been compiled 17645824d651Sblueswir1with vde support enabled. 17655824d651Sblueswir1 17665824d651Sblueswir1Example: 17675824d651Sblueswir1@example 17685824d651Sblueswir1# launch vde switch 17695824d651Sblueswir1vde_switch -F -sock /tmp/myswitch 17705824d651Sblueswir1# launch QEMU instance 17713804da9dSStefan Weilqemu-system-i386 linux.img -net nic -net vde,sock=/tmp/myswitch 17725824d651Sblueswir1@end example 17735824d651Sblueswir1 177440e8c26dSStefan Hajnoczi@item -netdev hubport,id=@var{id},hubid=@var{hubid} 177540e8c26dSStefan Hajnoczi 177640e8c26dSStefan HajnocziCreate a hub port on QEMU "vlan" @var{hubid}. 177740e8c26dSStefan Hajnoczi 177840e8c26dSStefan HajnocziThe hubport netdev lets you connect a NIC to a QEMU "vlan" instead of a single 177940e8c26dSStefan Hajnoczinetdev. @code{-net} and @code{-device} with parameter @option{vlan} create the 178040e8c26dSStefan Hajnoczirequired hub automatically. 178140e8c26dSStefan Hajnoczi 1782bb9ea79eSaliguori@item -net dump[,vlan=@var{n}][,file=@var{file}][,len=@var{len}] 1783bb9ea79eSaliguoriDump network traffic on VLAN @var{n} to file @var{file} (@file{qemu-vlan0.pcap} by default). 1784bb9ea79eSaliguoriAt most @var{len} bytes (64k by default) per packet are stored. The file format is 1785bb9ea79eSaliguorilibpcap, so it can be analyzed with tools such as tcpdump or Wireshark. 1786bb9ea79eSaliguori 17875824d651Sblueswir1@item -net none 17885824d651Sblueswir1Indicate that no network devices should be configured. It is used to 17895824d651Sblueswir1override the default configuration (@option{-net nic -net user}) which 17905824d651Sblueswir1is activated if no @option{-net} options are provided. 17915824d651Sblueswir1ETEXI 17925824d651Sblueswir1 1793c70a01e4SMarkus ArmbrusterSTEXI 1794c70a01e4SMarkus Armbruster@end table 1795c70a01e4SMarkus ArmbrusterETEXI 17967273a2dbSMatthew BoothDEFHEADING() 17977273a2dbSMatthew Booth 17987273a2dbSMatthew BoothDEFHEADING(Character device options:) 1799c70a01e4SMarkus ArmbrusterSTEXI 1800c70a01e4SMarkus Armbruster 1801c70a01e4SMarkus ArmbrusterThe general form of a character device option is: 1802c70a01e4SMarkus Armbruster@table @option 1803c70a01e4SMarkus ArmbrusterETEXI 18047273a2dbSMatthew Booth 18057273a2dbSMatthew BoothDEF("chardev", HAS_ARG, QEMU_OPTION_chardev, 180697331287SJan Kiszka "-chardev null,id=id[,mux=on|off]\n" 18077273a2dbSMatthew Booth "-chardev socket,id=id[,host=host],port=host[,to=to][,ipv4][,ipv6][,nodelay]\n" 180897331287SJan Kiszka " [,server][,nowait][,telnet][,mux=on|off] (tcp)\n" 180997331287SJan Kiszka "-chardev socket,id=id,path=path[,server][,nowait][,telnet],[mux=on|off] (unix)\n" 18107273a2dbSMatthew Booth "-chardev udp,id=id[,host=host],port=port[,localaddr=localaddr]\n" 181197331287SJan Kiszka " [,localport=localport][,ipv4][,ipv6][,mux=on|off]\n" 181297331287SJan Kiszka "-chardev msmouse,id=id[,mux=on|off]\n" 18137273a2dbSMatthew Booth "-chardev vc,id=id[[,width=width][,height=height]][[,cols=cols][,rows=rows]]\n" 181497331287SJan Kiszka " [,mux=on|off]\n" 18154f57378fSMarkus Armbruster "-chardev ringbuf,id=id[,size=size]\n" 181697331287SJan Kiszka "-chardev file,id=id,path=path[,mux=on|off]\n" 181797331287SJan Kiszka "-chardev pipe,id=id,path=path[,mux=on|off]\n" 18187273a2dbSMatthew Booth#ifdef _WIN32 181997331287SJan Kiszka "-chardev console,id=id[,mux=on|off]\n" 182097331287SJan Kiszka "-chardev serial,id=id,path=path[,mux=on|off]\n" 18217273a2dbSMatthew Booth#else 182297331287SJan Kiszka "-chardev pty,id=id[,mux=on|off]\n" 1823b7fdb3abSAurelien Jarno "-chardev stdio,id=id[,mux=on|off][,signal=on|off]\n" 18247273a2dbSMatthew Booth#endif 18257273a2dbSMatthew Booth#ifdef CONFIG_BRLAPI 182697331287SJan Kiszka "-chardev braille,id=id[,mux=on|off]\n" 18277273a2dbSMatthew Booth#endif 18287273a2dbSMatthew Booth#if defined(__linux__) || defined(__sun__) || defined(__FreeBSD__) \ 18297273a2dbSMatthew Booth || defined(__NetBSD__) || defined(__OpenBSD__) || defined(__DragonFly__) 1830d59044efSGerd Hoffmann "-chardev serial,id=id,path=path[,mux=on|off]\n" 183197331287SJan Kiszka "-chardev tty,id=id,path=path[,mux=on|off]\n" 18327273a2dbSMatthew Booth#endif 18337273a2dbSMatthew Booth#if defined(__linux__) || defined(__FreeBSD__) || defined(__DragonFly__) 183488a946d3SGerd Hoffmann "-chardev parallel,id=id,path=path[,mux=on|off]\n" 183597331287SJan Kiszka "-chardev parport,id=id,path=path[,mux=on|off]\n" 18367273a2dbSMatthew Booth#endif 1837cbcc6336SAlon Levy#if defined(CONFIG_SPICE) 1838cbcc6336SAlon Levy "-chardev spicevmc,id=id,name=name[,debug=debug]\n" 18395a49d3e9SMarc-André Lureau "-chardev spiceport,id=id,name=name[,debug=debug]\n" 1840cbcc6336SAlon Levy#endif 1841ad96090aSBlue Swirl , QEMU_ARCH_ALL 18427273a2dbSMatthew Booth) 18437273a2dbSMatthew Booth 18447273a2dbSMatthew BoothSTEXI 184597331287SJan Kiszka@item -chardev @var{backend} ,id=@var{id} [,mux=on|off] [,@var{options}] 18466616b2adSStefan Weil@findex -chardev 18477273a2dbSMatthew BoothBackend is one of: 18487273a2dbSMatthew Booth@option{null}, 18497273a2dbSMatthew Booth@option{socket}, 18507273a2dbSMatthew Booth@option{udp}, 18517273a2dbSMatthew Booth@option{msmouse}, 18527273a2dbSMatthew Booth@option{vc}, 18534f57378fSMarkus Armbruster@option{ringbuf}, 18547273a2dbSMatthew Booth@option{file}, 18557273a2dbSMatthew Booth@option{pipe}, 18567273a2dbSMatthew Booth@option{console}, 18577273a2dbSMatthew Booth@option{serial}, 18587273a2dbSMatthew Booth@option{pty}, 18597273a2dbSMatthew Booth@option{stdio}, 18607273a2dbSMatthew Booth@option{braille}, 18617273a2dbSMatthew Booth@option{tty}, 186288a946d3SGerd Hoffmann@option{parallel}, 1863cbcc6336SAlon Levy@option{parport}, 1864cbcc6336SAlon Levy@option{spicevmc}. 18655a49d3e9SMarc-André Lureau@option{spiceport}. 18667273a2dbSMatthew BoothThe specific backend will determine the applicable options. 18677273a2dbSMatthew Booth 18687273a2dbSMatthew BoothAll devices must have an id, which can be any string up to 127 characters long. 18697273a2dbSMatthew BoothIt is used to uniquely identify this device in other command line directives. 18707273a2dbSMatthew Booth 187197331287SJan KiszkaA character device may be used in multiplexing mode by multiple front-ends. 187297331287SJan KiszkaThe key sequence of @key{Control-a} and @key{c} will rotate the input focus 187397331287SJan Kiszkabetween attached front-ends. Specify @option{mux=on} to enable this mode. 187497331287SJan Kiszka 18757273a2dbSMatthew BoothOptions to each backend are described below. 18767273a2dbSMatthew Booth 18777273a2dbSMatthew Booth@item -chardev null ,id=@var{id} 18787273a2dbSMatthew BoothA void device. This device will not emit any data, and will drop any data it 18797273a2dbSMatthew Boothreceives. The null backend does not take any options. 18807273a2dbSMatthew Booth 18817273a2dbSMatthew Booth@item -chardev socket ,id=@var{id} [@var{TCP options} or @var{unix options}] [,server] [,nowait] [,telnet] 18827273a2dbSMatthew Booth 18837273a2dbSMatthew BoothCreate a two-way stream socket, which can be either a TCP or a unix socket. A 18847273a2dbSMatthew Boothunix socket will be created if @option{path} is specified. Behaviour is 18857273a2dbSMatthew Boothundefined if TCP options are specified for a unix socket. 18867273a2dbSMatthew Booth 18877273a2dbSMatthew Booth@option{server} specifies that the socket shall be a listening socket. 18887273a2dbSMatthew Booth 18897273a2dbSMatthew Booth@option{nowait} specifies that QEMU should not block waiting for a client to 18907273a2dbSMatthew Boothconnect to a listening socket. 18917273a2dbSMatthew Booth 18927273a2dbSMatthew Booth@option{telnet} specifies that traffic on the socket should interpret telnet 18937273a2dbSMatthew Boothescape sequences. 18947273a2dbSMatthew Booth 18957273a2dbSMatthew BoothTCP and unix socket options are given below: 18967273a2dbSMatthew Booth 18977273a2dbSMatthew Booth@table @option 18987273a2dbSMatthew Booth 18998d533561SAurelien Jarno@item TCP options: port=@var{port} [,host=@var{host}] [,to=@var{to}] [,ipv4] [,ipv6] [,nodelay] 19007273a2dbSMatthew Booth 19017273a2dbSMatthew Booth@option{host} for a listening socket specifies the local address to be bound. 19027273a2dbSMatthew BoothFor a connecting socket species the remote host to connect to. @option{host} is 19037273a2dbSMatthew Boothoptional for listening sockets. If not specified it defaults to @code{0.0.0.0}. 19047273a2dbSMatthew Booth 19057273a2dbSMatthew Booth@option{port} for a listening socket specifies the local port to be bound. For a 19067273a2dbSMatthew Boothconnecting socket specifies the port on the remote host to connect to. 19077273a2dbSMatthew Booth@option{port} can be given as either a port number or a service name. 19087273a2dbSMatthew Booth@option{port} is required. 19097273a2dbSMatthew Booth 19107273a2dbSMatthew Booth@option{to} is only relevant to listening sockets. If it is specified, and 19117273a2dbSMatthew Booth@option{port} cannot be bound, QEMU will attempt to bind to subsequent ports up 19127273a2dbSMatthew Boothto and including @option{to} until it succeeds. @option{to} must be specified 19137273a2dbSMatthew Boothas a port number. 19147273a2dbSMatthew Booth 19157273a2dbSMatthew Booth@option{ipv4} and @option{ipv6} specify that either IPv4 or IPv6 must be used. 19167273a2dbSMatthew BoothIf neither is specified the socket may use either protocol. 19177273a2dbSMatthew Booth 19187273a2dbSMatthew Booth@option{nodelay} disables the Nagle algorithm. 19197273a2dbSMatthew Booth 19207273a2dbSMatthew Booth@item unix options: path=@var{path} 19217273a2dbSMatthew Booth 19227273a2dbSMatthew Booth@option{path} specifies the local path of the unix socket. @option{path} is 19237273a2dbSMatthew Boothrequired. 19247273a2dbSMatthew Booth 19257273a2dbSMatthew Booth@end table 19267273a2dbSMatthew Booth 19277273a2dbSMatthew Booth@item -chardev udp ,id=@var{id} [,host=@var{host}] ,port=@var{port} [,localaddr=@var{localaddr}] [,localport=@var{localport}] [,ipv4] [,ipv6] 19287273a2dbSMatthew Booth 19297273a2dbSMatthew BoothSends all traffic from the guest to a remote host over UDP. 19307273a2dbSMatthew Booth 19317273a2dbSMatthew Booth@option{host} specifies the remote host to connect to. If not specified it 19327273a2dbSMatthew Boothdefaults to @code{localhost}. 19337273a2dbSMatthew Booth 19347273a2dbSMatthew Booth@option{port} specifies the port on the remote host to connect to. @option{port} 19357273a2dbSMatthew Boothis required. 19367273a2dbSMatthew Booth 19377273a2dbSMatthew Booth@option{localaddr} specifies the local address to bind to. If not specified it 19387273a2dbSMatthew Boothdefaults to @code{0.0.0.0}. 19397273a2dbSMatthew Booth 19407273a2dbSMatthew Booth@option{localport} specifies the local port to bind to. If not specified any 19417273a2dbSMatthew Boothavailable local port will be used. 19427273a2dbSMatthew Booth 19437273a2dbSMatthew Booth@option{ipv4} and @option{ipv6} specify that either IPv4 or IPv6 must be used. 19447273a2dbSMatthew BoothIf neither is specified the device may use either protocol. 19457273a2dbSMatthew Booth 19467273a2dbSMatthew Booth@item -chardev msmouse ,id=@var{id} 19477273a2dbSMatthew Booth 19487273a2dbSMatthew BoothForward QEMU's emulated msmouse events to the guest. @option{msmouse} does not 19497273a2dbSMatthew Boothtake any options. 19507273a2dbSMatthew Booth 19517273a2dbSMatthew Booth@item -chardev vc ,id=@var{id} [[,width=@var{width}] [,height=@var{height}]] [[,cols=@var{cols}] [,rows=@var{rows}]] 19527273a2dbSMatthew Booth 19537273a2dbSMatthew BoothConnect to a QEMU text console. @option{vc} may optionally be given a specific 19547273a2dbSMatthew Boothsize. 19557273a2dbSMatthew Booth 19567273a2dbSMatthew Booth@option{width} and @option{height} specify the width and height respectively of 19577273a2dbSMatthew Booththe console, in pixels. 19587273a2dbSMatthew Booth 19597273a2dbSMatthew Booth@option{cols} and @option{rows} specify that the console be sized to fit a text 19607273a2dbSMatthew Boothconsole with the given dimensions. 19617273a2dbSMatthew Booth 19624f57378fSMarkus Armbruster@item -chardev ringbuf ,id=@var{id} [,size=@var{size}] 196351767e7cSLei Li 19643949e594SMarkus ArmbrusterCreate a ring buffer with fixed size @option{size}. 19653949e594SMarkus Armbruster@var{size} must be a power of two, and defaults to @code{64K}). 196651767e7cSLei Li 19677273a2dbSMatthew Booth@item -chardev file ,id=@var{id} ,path=@var{path} 19687273a2dbSMatthew Booth 19697273a2dbSMatthew BoothLog all traffic received from the guest to a file. 19707273a2dbSMatthew Booth 19717273a2dbSMatthew Booth@option{path} specifies the path of the file to be opened. This file will be 19727273a2dbSMatthew Boothcreated if it does not already exist, and overwritten if it does. @option{path} 19737273a2dbSMatthew Boothis required. 19747273a2dbSMatthew Booth 19757273a2dbSMatthew Booth@item -chardev pipe ,id=@var{id} ,path=@var{path} 19767273a2dbSMatthew Booth 19777273a2dbSMatthew BoothCreate a two-way connection to the guest. The behaviour differs slightly between 19787273a2dbSMatthew BoothWindows hosts and other hosts: 19797273a2dbSMatthew Booth 19807273a2dbSMatthew BoothOn Windows, a single duplex pipe will be created at 19817273a2dbSMatthew Booth@file{\\.pipe\@option{path}}. 19827273a2dbSMatthew Booth 19837273a2dbSMatthew BoothOn other hosts, 2 pipes will be created called @file{@option{path}.in} and 19847273a2dbSMatthew Booth@file{@option{path}.out}. Data written to @file{@option{path}.in} will be 19857273a2dbSMatthew Boothreceived by the guest. Data written by the guest can be read from 19867273a2dbSMatthew Booth@file{@option{path}.out}. QEMU will not create these fifos, and requires them to 19877273a2dbSMatthew Boothbe present. 19887273a2dbSMatthew Booth 19897273a2dbSMatthew Booth@option{path} forms part of the pipe path as described above. @option{path} is 19907273a2dbSMatthew Boothrequired. 19917273a2dbSMatthew Booth 19927273a2dbSMatthew Booth@item -chardev console ,id=@var{id} 19937273a2dbSMatthew Booth 19947273a2dbSMatthew BoothSend traffic from the guest to QEMU's standard output. @option{console} does not 19957273a2dbSMatthew Boothtake any options. 19967273a2dbSMatthew Booth 19977273a2dbSMatthew Booth@option{console} is only available on Windows hosts. 19987273a2dbSMatthew Booth 19997273a2dbSMatthew Booth@item -chardev serial ,id=@var{id} ,path=@option{path} 20007273a2dbSMatthew Booth 20017273a2dbSMatthew BoothSend traffic from the guest to a serial device on the host. 20027273a2dbSMatthew Booth 2003d59044efSGerd HoffmannOn Unix hosts serial will actually accept any tty device, 2004d59044efSGerd Hoffmannnot only serial lines. 20057273a2dbSMatthew Booth 20067273a2dbSMatthew Booth@option{path} specifies the name of the serial device to open. 20077273a2dbSMatthew Booth 20087273a2dbSMatthew Booth@item -chardev pty ,id=@var{id} 20097273a2dbSMatthew Booth 20107273a2dbSMatthew BoothCreate a new pseudo-terminal on the host and connect to it. @option{pty} does 20117273a2dbSMatthew Boothnot take any options. 20127273a2dbSMatthew Booth 20137273a2dbSMatthew Booth@option{pty} is not available on Windows hosts. 20147273a2dbSMatthew Booth 2015b7fdb3abSAurelien Jarno@item -chardev stdio ,id=@var{id} [,signal=on|off] 2016b65ee4faSStefan WeilConnect to standard input and standard output of the QEMU process. 2017b7fdb3abSAurelien Jarno 2018b7fdb3abSAurelien Jarno@option{signal} controls if signals are enabled on the terminal, that includes 2019b7fdb3abSAurelien Jarnoexiting QEMU with the key sequence @key{Control-c}. This option is enabled by 2020b7fdb3abSAurelien Jarnodefault, use @option{signal=off} to disable it. 2021b7fdb3abSAurelien Jarno 2022b7fdb3abSAurelien Jarno@option{stdio} is not available on Windows hosts. 20237273a2dbSMatthew Booth 20247273a2dbSMatthew Booth@item -chardev braille ,id=@var{id} 20257273a2dbSMatthew Booth 20267273a2dbSMatthew BoothConnect to a local BrlAPI server. @option{braille} does not take any options. 20277273a2dbSMatthew Booth 20287273a2dbSMatthew Booth@item -chardev tty ,id=@var{id} ,path=@var{path} 20297273a2dbSMatthew Booth 20307273a2dbSMatthew Booth@option{tty} is only available on Linux, Sun, FreeBSD, NetBSD, OpenBSD and 2031d037d6bbSMarkus ArmbrusterDragonFlyBSD hosts. It is an alias for @option{serial}. 20327273a2dbSMatthew Booth 20337273a2dbSMatthew Booth@option{path} specifies the path to the tty. @option{path} is required. 20347273a2dbSMatthew Booth 203588a946d3SGerd Hoffmann@item -chardev parallel ,id=@var{id} ,path=@var{path} 20367273a2dbSMatthew Booth@item -chardev parport ,id=@var{id} ,path=@var{path} 20377273a2dbSMatthew Booth 203888a946d3SGerd Hoffmann@option{parallel} is only available on Linux, FreeBSD and DragonFlyBSD hosts. 20397273a2dbSMatthew Booth 20407273a2dbSMatthew BoothConnect to a local parallel port. 20417273a2dbSMatthew Booth 20427273a2dbSMatthew Booth@option{path} specifies the path to the parallel port device. @option{path} is 20437273a2dbSMatthew Boothrequired. 20447273a2dbSMatthew Booth 2045cbcc6336SAlon Levy@item -chardev spicevmc ,id=@var{id} ,debug=@var{debug}, name=@var{name} 2046cbcc6336SAlon Levy 20473a846906SStefan Hajnoczi@option{spicevmc} is only available when spice support is built in. 20483a846906SStefan Hajnoczi 2049cbcc6336SAlon Levy@option{debug} debug level for spicevmc 2050cbcc6336SAlon Levy 2051cbcc6336SAlon Levy@option{name} name of spice channel to connect to 2052cbcc6336SAlon Levy 2053cbcc6336SAlon LevyConnect to a spice virtual machine channel, such as vdiport. 2054cbcc6336SAlon Levy 20555a49d3e9SMarc-André Lureau@item -chardev spiceport ,id=@var{id} ,debug=@var{debug}, name=@var{name} 20565a49d3e9SMarc-André Lureau 20575a49d3e9SMarc-André Lureau@option{spiceport} is only available when spice support is built in. 20585a49d3e9SMarc-André Lureau 20595a49d3e9SMarc-André Lureau@option{debug} debug level for spicevmc 20605a49d3e9SMarc-André Lureau 20615a49d3e9SMarc-André Lureau@option{name} name of spice port to connect to 20625a49d3e9SMarc-André Lureau 20635a49d3e9SMarc-André LureauConnect to a spice port, allowing a Spice client to handle the traffic 20645a49d3e9SMarc-André Lureauidentified by a name (preferably a fqdn). 20657273a2dbSMatthew BoothETEXI 20667273a2dbSMatthew Booth 2067c70a01e4SMarkus ArmbrusterSTEXI 2068c70a01e4SMarkus Armbruster@end table 2069c70a01e4SMarkus ArmbrusterETEXI 20707273a2dbSMatthew BoothDEFHEADING() 20717273a2dbSMatthew Booth 20720f5314a2SRonnie SahlbergDEFHEADING(Device URL Syntax:) 2073c70a01e4SMarkus ArmbrusterSTEXI 20740f5314a2SRonnie Sahlberg 20750f5314a2SRonnie SahlbergIn addition to using normal file images for the emulated storage devices, 20760f5314a2SRonnie SahlbergQEMU can also use networked resources such as iSCSI devices. These are 20770f5314a2SRonnie Sahlbergspecified using a special URL syntax. 20780f5314a2SRonnie Sahlberg 20790f5314a2SRonnie Sahlberg@table @option 20800f5314a2SRonnie Sahlberg@item iSCSI 20810f5314a2SRonnie SahlbergiSCSI support allows QEMU to access iSCSI resources directly and use as 20820f5314a2SRonnie Sahlbergimages for the guest storage. Both disk and cdrom images are supported. 20830f5314a2SRonnie Sahlberg 20840f5314a2SRonnie SahlbergSyntax for specifying iSCSI LUNs is 20850f5314a2SRonnie Sahlberg``iscsi://<target-ip>[:<port>]/<target-iqn>/<lun>'' 20860f5314a2SRonnie Sahlberg 208731459f46SRonnie SahlbergBy default qemu will use the iSCSI initiator-name 208831459f46SRonnie Sahlberg'iqn.2008-11.org.linux-kvm[:<name>]' but this can also be set from the command 208931459f46SRonnie Sahlbergline or a configuration file. 209031459f46SRonnie Sahlberg 209131459f46SRonnie Sahlberg 20920f5314a2SRonnie SahlbergExample (without authentication): 20930f5314a2SRonnie Sahlberg@example 20943804da9dSStefan Weilqemu-system-i386 -iscsi initiator-name=iqn.2001-04.com.example:my-initiator \ 2095f9dadc98SRonnie Sahlberg -cdrom iscsi://192.0.2.1/iqn.2001-04.com.example/2 \ 2096f9dadc98SRonnie Sahlberg -drive file=iscsi://192.0.2.1/iqn.2001-04.com.example/1 20970f5314a2SRonnie Sahlberg@end example 20980f5314a2SRonnie Sahlberg 20990f5314a2SRonnie SahlbergExample (CHAP username/password via URL): 21000f5314a2SRonnie Sahlberg@example 21013804da9dSStefan Weilqemu-system-i386 -drive file=iscsi://user%password@@192.0.2.1/iqn.2001-04.com.example/1 21020f5314a2SRonnie Sahlberg@end example 21030f5314a2SRonnie Sahlberg 21040f5314a2SRonnie SahlbergExample (CHAP username/password via environment variables): 21050f5314a2SRonnie Sahlberg@example 21060f5314a2SRonnie SahlbergLIBISCSI_CHAP_USERNAME="user" \ 21070f5314a2SRonnie SahlbergLIBISCSI_CHAP_PASSWORD="password" \ 21083804da9dSStefan Weilqemu-system-i386 -drive file=iscsi://192.0.2.1/iqn.2001-04.com.example/1 21090f5314a2SRonnie Sahlberg@end example 21100f5314a2SRonnie Sahlberg 21110f5314a2SRonnie SahlbergiSCSI support is an optional feature of QEMU and only available when 21120f5314a2SRonnie Sahlbergcompiled and linked against libiscsi. 2113f9dadc98SRonnie SahlbergETEXI 2114f9dadc98SRonnie SahlbergDEF("iscsi", HAS_ARG, QEMU_OPTION_iscsi, 2115f9dadc98SRonnie Sahlberg "-iscsi [user=user][,password=password]\n" 2116f9dadc98SRonnie Sahlberg " [,header-digest=CRC32C|CR32C-NONE|NONE-CRC32C|NONE\n" 21172fe3798cSPaolo Bonzini " [,initiator-name=initiator-iqn][,id=target-iqn]\n" 2118f9dadc98SRonnie Sahlberg " iSCSI session parameters\n", QEMU_ARCH_ALL) 2119f9dadc98SRonnie SahlbergSTEXI 21200f5314a2SRonnie Sahlberg 212131459f46SRonnie SahlbergiSCSI parameters such as username and password can also be specified via 212231459f46SRonnie Sahlberga configuration file. See qemu-doc for more information and examples. 212331459f46SRonnie Sahlberg 212408ae330eSRonnie Sahlberg@item NBD 212508ae330eSRonnie SahlbergQEMU supports NBD (Network Block Devices) both using TCP protocol as well 212608ae330eSRonnie Sahlbergas Unix Domain Sockets. 212708ae330eSRonnie Sahlberg 212808ae330eSRonnie SahlbergSyntax for specifying a NBD device using TCP 212908ae330eSRonnie Sahlberg``nbd:<server-ip>:<port>[:exportname=<export>]'' 213008ae330eSRonnie Sahlberg 213108ae330eSRonnie SahlbergSyntax for specifying a NBD device using Unix Domain Sockets 213208ae330eSRonnie Sahlberg``nbd:unix:<domain-socket>[:exportname=<export>]'' 213308ae330eSRonnie Sahlberg 213408ae330eSRonnie Sahlberg 213508ae330eSRonnie SahlbergExample for TCP 213608ae330eSRonnie Sahlberg@example 21373804da9dSStefan Weilqemu-system-i386 --drive file=nbd:192.0.2.1:30000 213808ae330eSRonnie Sahlberg@end example 213908ae330eSRonnie Sahlberg 214008ae330eSRonnie SahlbergExample for Unix Domain Sockets 214108ae330eSRonnie Sahlberg@example 21423804da9dSStefan Weilqemu-system-i386 --drive file=nbd:unix:/tmp/nbd-socket 214308ae330eSRonnie Sahlberg@end example 214408ae330eSRonnie Sahlberg 21450a12ec87SRichard W.M. Jones@item SSH 21460a12ec87SRichard W.M. JonesQEMU supports SSH (Secure Shell) access to remote disks. 21470a12ec87SRichard W.M. Jones 21480a12ec87SRichard W.M. JonesExamples: 21490a12ec87SRichard W.M. Jones@example 21500a12ec87SRichard W.M. Jonesqemu-system-i386 -drive file=ssh://user@@host/path/to/disk.img 21510a12ec87SRichard W.M. Jonesqemu-system-i386 -drive file.driver=ssh,file.user=user,file.host=host,file.port=22,file.path=/path/to/disk.img 21520a12ec87SRichard W.M. Jones@end example 21530a12ec87SRichard W.M. Jones 21540a12ec87SRichard W.M. JonesCurrently authentication must be done using ssh-agent. Other 21550a12ec87SRichard W.M. Jonesauthentication methods may be supported in future. 21560a12ec87SRichard W.M. Jones 2157d9990228SRonnie Sahlberg@item Sheepdog 2158d9990228SRonnie SahlbergSheepdog is a distributed storage system for QEMU. 2159d9990228SRonnie SahlbergQEMU supports using either local sheepdog devices or remote networked 2160d9990228SRonnie Sahlbergdevices. 2161d9990228SRonnie Sahlberg 2162d9990228SRonnie SahlbergSyntax for specifying a sheepdog device 21635d6768e3SMORITA Kazutaka@example 21641b8bbb46SMORITA Kazutakasheepdog[+tcp|+unix]://[host:port]/vdiname[?socket=path][#snapid|#tag] 21655d6768e3SMORITA Kazutaka@end example 2166d9990228SRonnie Sahlberg 2167d9990228SRonnie SahlbergExample 2168d9990228SRonnie Sahlberg@example 21695d6768e3SMORITA Kazutakaqemu-system-i386 --drive file=sheepdog://192.0.2.1:30000/MyVirtualMachine 2170d9990228SRonnie Sahlberg@end example 2171d9990228SRonnie Sahlberg 2172d9990228SRonnie SahlbergSee also @url{http://http://www.osrg.net/sheepdog/}. 2173d9990228SRonnie Sahlberg 21748809e289SBharata B Rao@item GlusterFS 21758809e289SBharata B RaoGlusterFS is an user space distributed file system. 21768809e289SBharata B RaoQEMU supports the use of GlusterFS volumes for hosting VM disk images using 21778809e289SBharata B RaoTCP, Unix Domain Sockets and RDMA transport protocols. 21788809e289SBharata B Rao 21798809e289SBharata B RaoSyntax for specifying a VM disk image on GlusterFS volume is 21808809e289SBharata B Rao@example 21818809e289SBharata B Raogluster[+transport]://[server[:port]]/volname/image[?socket=...] 21828809e289SBharata B Rao@end example 21838809e289SBharata B Rao 21848809e289SBharata B Rao 21858809e289SBharata B RaoExample 21868809e289SBharata B Rao@example 2187db2d5ebaSLei Liqemu-system-x86_64 --drive file=gluster://192.0.2.1/testvol/a.img 21888809e289SBharata B Rao@end example 21898809e289SBharata B Rao 21908809e289SBharata B RaoSee also @url{http://www.gluster.org}. 2191c70a01e4SMarkus ArmbrusterETEXI 2192c70a01e4SMarkus Armbruster 2193c70a01e4SMarkus ArmbrusterSTEXI 21940f5314a2SRonnie Sahlberg@end table 21950f5314a2SRonnie SahlbergETEXI 21960f5314a2SRonnie Sahlberg 21977273a2dbSMatthew BoothDEFHEADING(Bluetooth(R) options:) 2198c70a01e4SMarkus ArmbrusterSTEXI 2199c70a01e4SMarkus Armbruster@table @option 2200c70a01e4SMarkus ArmbrusterETEXI 22017273a2dbSMatthew Booth 22025824d651Sblueswir1DEF("bt", HAS_ARG, QEMU_OPTION_bt, \ 22035824d651Sblueswir1 "-bt hci,null dumb bluetooth HCI - doesn't respond to commands\n" \ 22045824d651Sblueswir1 "-bt hci,host[:id]\n" \ 22055824d651Sblueswir1 " use host's HCI with the given name\n" \ 22065824d651Sblueswir1 "-bt hci[,vlan=n]\n" \ 22075824d651Sblueswir1 " emulate a standard HCI in virtual scatternet 'n'\n" \ 22085824d651Sblueswir1 "-bt vhci[,vlan=n]\n" \ 22095824d651Sblueswir1 " add host computer to virtual scatternet 'n' using VHCI\n" \ 22105824d651Sblueswir1 "-bt device:dev[,vlan=n]\n" \ 2211ad96090aSBlue Swirl " emulate a bluetooth device 'dev' in scatternet 'n'\n", 2212ad96090aSBlue Swirl QEMU_ARCH_ALL) 22135824d651Sblueswir1STEXI 22145824d651Sblueswir1@item -bt hci[...] 22156616b2adSStefan Weil@findex -bt 22165824d651Sblueswir1Defines the function of the corresponding Bluetooth HCI. -bt options 22175824d651Sblueswir1are matched with the HCIs present in the chosen machine type. For 22185824d651Sblueswir1example when emulating a machine with only one HCI built into it, only 22195824d651Sblueswir1the first @code{-bt hci[...]} option is valid and defines the HCI's 22205824d651Sblueswir1logic. The Transport Layer is decided by the machine type. Currently 22215824d651Sblueswir1the machines @code{n800} and @code{n810} have one HCI and all other 22225824d651Sblueswir1machines have none. 22235824d651Sblueswir1 22245824d651Sblueswir1@anchor{bt-hcis} 22255824d651Sblueswir1The following three types are recognized: 22265824d651Sblueswir1 2227b3f046c2SKevin Wolf@table @option 22285824d651Sblueswir1@item -bt hci,null 22295824d651Sblueswir1(default) The corresponding Bluetooth HCI assumes no internal logic 22305824d651Sblueswir1and will not respond to any HCI commands or emit events. 22315824d651Sblueswir1 22325824d651Sblueswir1@item -bt hci,host[:@var{id}] 22335824d651Sblueswir1(@code{bluez} only) The corresponding HCI passes commands / events 22345824d651Sblueswir1to / from the physical HCI identified by the name @var{id} (default: 22355824d651Sblueswir1@code{hci0}) on the computer running QEMU. Only available on @code{bluez} 22365824d651Sblueswir1capable systems like Linux. 22375824d651Sblueswir1 22385824d651Sblueswir1@item -bt hci[,vlan=@var{n}] 22395824d651Sblueswir1Add a virtual, standard HCI that will participate in the Bluetooth 22405824d651Sblueswir1scatternet @var{n} (default @code{0}). Similarly to @option{-net} 22415824d651Sblueswir1VLANs, devices inside a bluetooth network @var{n} can only communicate 22425824d651Sblueswir1with other devices in the same network (scatternet). 22435824d651Sblueswir1@end table 22445824d651Sblueswir1 22455824d651Sblueswir1@item -bt vhci[,vlan=@var{n}] 22465824d651Sblueswir1(Linux-host only) Create a HCI in scatternet @var{n} (default 0) attached 22475824d651Sblueswir1to the host bluetooth stack instead of to the emulated target. This 22485824d651Sblueswir1allows the host and target machines to participate in a common scatternet 22495824d651Sblueswir1and communicate. Requires the Linux @code{vhci} driver installed. Can 22505824d651Sblueswir1be used as following: 22515824d651Sblueswir1 22525824d651Sblueswir1@example 22533804da9dSStefan Weilqemu-system-i386 [...OPTIONS...] -bt hci,vlan=5 -bt vhci,vlan=5 22545824d651Sblueswir1@end example 22555824d651Sblueswir1 22565824d651Sblueswir1@item -bt device:@var{dev}[,vlan=@var{n}] 22575824d651Sblueswir1Emulate a bluetooth device @var{dev} and place it in network @var{n} 22585824d651Sblueswir1(default @code{0}). QEMU can only emulate one type of bluetooth devices 22595824d651Sblueswir1currently: 22605824d651Sblueswir1 2261b3f046c2SKevin Wolf@table @option 22625824d651Sblueswir1@item keyboard 22635824d651Sblueswir1Virtual wireless keyboard implementing the HIDP bluetooth profile. 22645824d651Sblueswir1@end table 22655824d651Sblueswir1ETEXI 22665824d651Sblueswir1 2267c70a01e4SMarkus ArmbrusterSTEXI 2268c70a01e4SMarkus Armbruster@end table 2269c70a01e4SMarkus ArmbrusterETEXI 22705824d651Sblueswir1DEFHEADING() 22715824d651Sblueswir1 2272d1a0cf73SStefan Berger#ifdef CONFIG_TPM 2273d1a0cf73SStefan BergerDEFHEADING(TPM device options:) 2274d1a0cf73SStefan Berger 2275d1a0cf73SStefan BergerDEF("tpmdev", HAS_ARG, QEMU_OPTION_tpmdev, \ 227692dcc234SStefan Berger "-tpmdev passthrough,id=id[,path=path][,cancel-path=path]\n" 227792dcc234SStefan Berger " use path to provide path to a character device; default is /dev/tpm0\n" 227892dcc234SStefan Berger " use cancel-path to provide path to TPM's cancel sysfs entry; if\n" 227992dcc234SStefan Berger " not provided it will be searched for in /sys/class/misc/tpm?/device\n", 2280d1a0cf73SStefan Berger QEMU_ARCH_ALL) 2281d1a0cf73SStefan BergerSTEXI 2282d1a0cf73SStefan Berger 2283d1a0cf73SStefan BergerThe general form of a TPM device option is: 2284d1a0cf73SStefan Berger@table @option 2285d1a0cf73SStefan Berger 2286d1a0cf73SStefan Berger@item -tpmdev @var{backend} ,id=@var{id} [,@var{options}] 2287d1a0cf73SStefan Berger@findex -tpmdev 2288d1a0cf73SStefan BergerBackend type must be: 22894549a8b7SStefan Berger@option{passthrough}. 2290d1a0cf73SStefan Berger 2291d1a0cf73SStefan BergerThe specific backend type will determine the applicable options. 229228c4fa32SCorey BryantThe @code{-tpmdev} option creates the TPM backend and requires a 229328c4fa32SCorey Bryant@code{-device} option that specifies the TPM frontend interface model. 2294d1a0cf73SStefan Berger 2295d1a0cf73SStefan BergerOptions to each backend are described below. 2296d1a0cf73SStefan Berger 2297d1a0cf73SStefan BergerUse 'help' to print all available TPM backend types. 2298d1a0cf73SStefan Berger@example 2299d1a0cf73SStefan Bergerqemu -tpmdev help 2300d1a0cf73SStefan Berger@end example 2301d1a0cf73SStefan Berger 230292dcc234SStefan Berger@item -tpmdev passthrough, id=@var{id}, path=@var{path}, cancel-path=@var{cancel-path} 23034549a8b7SStefan Berger 23044549a8b7SStefan Berger(Linux-host only) Enable access to the host's TPM using the passthrough 23054549a8b7SStefan Bergerdriver. 23064549a8b7SStefan Berger 23074549a8b7SStefan Berger@option{path} specifies the path to the host's TPM device, i.e., on 23084549a8b7SStefan Bergera Linux host this would be @code{/dev/tpm0}. 23094549a8b7SStefan Berger@option{path} is optional and by default @code{/dev/tpm0} is used. 23104549a8b7SStefan Berger 231192dcc234SStefan Berger@option{cancel-path} specifies the path to the host TPM device's sysfs 231292dcc234SStefan Bergerentry allowing for cancellation of an ongoing TPM command. 231392dcc234SStefan Berger@option{cancel-path} is optional and by default QEMU will search for the 231492dcc234SStefan Bergersysfs entry to use. 231592dcc234SStefan Berger 23164549a8b7SStefan BergerSome notes about using the host's TPM with the passthrough driver: 23174549a8b7SStefan Berger 23184549a8b7SStefan BergerThe TPM device accessed by the passthrough driver must not be 23194549a8b7SStefan Bergerused by any other application on the host. 23204549a8b7SStefan Berger 23214549a8b7SStefan BergerSince the host's firmware (BIOS/UEFI) has already initialized the TPM, 23224549a8b7SStefan Bergerthe VM's firmware (BIOS/UEFI) will not be able to initialize the 23234549a8b7SStefan BergerTPM again and may therefore not show a TPM-specific menu that would 23244549a8b7SStefan Bergerotherwise allow the user to configure the TPM, e.g., allow the user to 23254549a8b7SStefan Bergerenable/disable or activate/deactivate the TPM. 23264549a8b7SStefan BergerFurther, if TPM ownership is released from within a VM then the host's TPM 23274549a8b7SStefan Bergerwill get disabled and deactivated. To enable and activate the 23284549a8b7SStefan BergerTPM again afterwards, the host has to be rebooted and the user is 23294549a8b7SStefan Bergerrequired to enter the firmware's menu to enable and activate the TPM. 23304549a8b7SStefan BergerIf the TPM is left disabled and/or deactivated most TPM commands will fail. 23314549a8b7SStefan Berger 23324549a8b7SStefan BergerTo create a passthrough TPM use the following two options: 23334549a8b7SStefan Berger@example 23344549a8b7SStefan Berger-tpmdev passthrough,id=tpm0 -device tpm-tis,tpmdev=tpm0 23354549a8b7SStefan Berger@end example 23364549a8b7SStefan BergerNote that the @code{-tpmdev} id is @code{tpm0} and is referenced by 23374549a8b7SStefan Berger@code{tpmdev=tpm0} in the device option. 23384549a8b7SStefan Berger 2339d1a0cf73SStefan Berger@end table 2340d1a0cf73SStefan Berger 2341d1a0cf73SStefan BergerETEXI 2342d1a0cf73SStefan Berger 2343d1a0cf73SStefan BergerDEFHEADING() 2344d1a0cf73SStefan Berger 2345d1a0cf73SStefan Berger#endif 2346d1a0cf73SStefan Berger 23477677f05dSAlexander GrafDEFHEADING(Linux/Multiboot boot specific:) 23485824d651Sblueswir1STEXI 23497677f05dSAlexander Graf 23507677f05dSAlexander GrafWhen using these options, you can use a given Linux or Multiboot 23517677f05dSAlexander Grafkernel without installing it in the disk image. It can be useful 23525824d651Sblueswir1for easier testing of various kernels. 23535824d651Sblueswir1 23545824d651Sblueswir1@table @option 23555824d651Sblueswir1ETEXI 23565824d651Sblueswir1 23575824d651Sblueswir1DEF("kernel", HAS_ARG, QEMU_OPTION_kernel, \ 2358ad96090aSBlue Swirl "-kernel bzImage use 'bzImage' as kernel image\n", QEMU_ARCH_ALL) 23595824d651Sblueswir1STEXI 23605824d651Sblueswir1@item -kernel @var{bzImage} 23616616b2adSStefan Weil@findex -kernel 23627677f05dSAlexander GrafUse @var{bzImage} as kernel image. The kernel can be either a Linux kernel 23637677f05dSAlexander Grafor in multiboot format. 23645824d651Sblueswir1ETEXI 23655824d651Sblueswir1 23665824d651Sblueswir1DEF("append", HAS_ARG, QEMU_OPTION_append, \ 2367ad96090aSBlue Swirl "-append cmdline use 'cmdline' as kernel command line\n", QEMU_ARCH_ALL) 23685824d651Sblueswir1STEXI 23695824d651Sblueswir1@item -append @var{cmdline} 23706616b2adSStefan Weil@findex -append 23715824d651Sblueswir1Use @var{cmdline} as kernel command line 23725824d651Sblueswir1ETEXI 23735824d651Sblueswir1 23745824d651Sblueswir1DEF("initrd", HAS_ARG, QEMU_OPTION_initrd, \ 2375ad96090aSBlue Swirl "-initrd file use 'file' as initial ram disk\n", QEMU_ARCH_ALL) 23765824d651Sblueswir1STEXI 23775824d651Sblueswir1@item -initrd @var{file} 23786616b2adSStefan Weil@findex -initrd 23795824d651Sblueswir1Use @var{file} as initial ram disk. 23807677f05dSAlexander Graf 23817677f05dSAlexander Graf@item -initrd "@var{file1} arg=foo,@var{file2}" 23827677f05dSAlexander Graf 23837677f05dSAlexander GrafThis syntax is only available with multiboot. 23847677f05dSAlexander Graf 23857677f05dSAlexander GrafUse @var{file1} and @var{file2} as modules and pass arg=foo as parameter to the 23867677f05dSAlexander Graffirst module. 23875824d651Sblueswir1ETEXI 23885824d651Sblueswir1 2389412beee6SGrant LikelyDEF("dtb", HAS_ARG, QEMU_OPTION_dtb, \ 2390379b5c7cSPeter A. G. Crosthwaite "-dtb file use 'file' as device tree image\n", QEMU_ARCH_ALL) 2391412beee6SGrant LikelySTEXI 2392412beee6SGrant Likely@item -dtb @var{file} 2393412beee6SGrant Likely@findex -dtb 2394412beee6SGrant LikelyUse @var{file} as a device tree binary (dtb) image and pass it to the kernel 2395412beee6SGrant Likelyon boot. 2396412beee6SGrant LikelyETEXI 2397412beee6SGrant Likely 23985824d651Sblueswir1STEXI 23995824d651Sblueswir1@end table 24005824d651Sblueswir1ETEXI 24015824d651Sblueswir1DEFHEADING() 24025824d651Sblueswir1 24035824d651Sblueswir1DEFHEADING(Debug/Expert options:) 24045824d651Sblueswir1STEXI 24055824d651Sblueswir1@table @option 24065824d651Sblueswir1ETEXI 24075824d651Sblueswir1 24085824d651Sblueswir1DEF("serial", HAS_ARG, QEMU_OPTION_serial, \ 2409ad96090aSBlue Swirl "-serial dev redirect the serial port to char device 'dev'\n", 2410ad96090aSBlue Swirl QEMU_ARCH_ALL) 24115824d651Sblueswir1STEXI 24125824d651Sblueswir1@item -serial @var{dev} 24136616b2adSStefan Weil@findex -serial 24145824d651Sblueswir1Redirect the virtual serial port to host character device 24155824d651Sblueswir1@var{dev}. The default device is @code{vc} in graphical mode and 24165824d651Sblueswir1@code{stdio} in non graphical mode. 24175824d651Sblueswir1 24185824d651Sblueswir1This option can be used several times to simulate up to 4 serial 24195824d651Sblueswir1ports. 24205824d651Sblueswir1 24215824d651Sblueswir1Use @code{-serial none} to disable all serial ports. 24225824d651Sblueswir1 24235824d651Sblueswir1Available character devices are: 2424b3f046c2SKevin Wolf@table @option 24254e257e5eSKevin Wolf@item vc[:@var{W}x@var{H}] 24265824d651Sblueswir1Virtual console. Optionally, a width and height can be given in pixel with 24275824d651Sblueswir1@example 24285824d651Sblueswir1vc:800x600 24295824d651Sblueswir1@end example 24305824d651Sblueswir1It is also possible to specify width or height in characters: 24315824d651Sblueswir1@example 24325824d651Sblueswir1vc:80Cx24C 24335824d651Sblueswir1@end example 24345824d651Sblueswir1@item pty 24355824d651Sblueswir1[Linux only] Pseudo TTY (a new PTY is automatically allocated) 24365824d651Sblueswir1@item none 24375824d651Sblueswir1No device is allocated. 24385824d651Sblueswir1@item null 24395824d651Sblueswir1void device 244088e020e5SIngo van Lil@item chardev:@var{id} 244188e020e5SIngo van LilUse a named character device defined with the @code{-chardev} option. 24425824d651Sblueswir1@item /dev/XXX 24435824d651Sblueswir1[Linux only] Use host tty, e.g. @file{/dev/ttyS0}. The host serial port 24445824d651Sblueswir1parameters are set according to the emulated ones. 24455824d651Sblueswir1@item /dev/parport@var{N} 24465824d651Sblueswir1[Linux only, parallel port only] Use host parallel port 24475824d651Sblueswir1@var{N}. Currently SPP and EPP parallel port features can be used. 24485824d651Sblueswir1@item file:@var{filename} 24495824d651Sblueswir1Write output to @var{filename}. No character can be read. 24505824d651Sblueswir1@item stdio 24515824d651Sblueswir1[Unix only] standard input/output 24525824d651Sblueswir1@item pipe:@var{filename} 24535824d651Sblueswir1name pipe @var{filename} 24545824d651Sblueswir1@item COM@var{n} 24555824d651Sblueswir1[Windows only] Use host serial port @var{n} 24565824d651Sblueswir1@item udp:[@var{remote_host}]:@var{remote_port}[@@[@var{src_ip}]:@var{src_port}] 24575824d651Sblueswir1This implements UDP Net Console. 24585824d651Sblueswir1When @var{remote_host} or @var{src_ip} are not specified 24595824d651Sblueswir1they default to @code{0.0.0.0}. 24605824d651Sblueswir1When not using a specified @var{src_port} a random port is automatically chosen. 24615824d651Sblueswir1 24625824d651Sblueswir1If you just want a simple readonly console you can use @code{netcat} or 2463b65ee4faSStefan Weil@code{nc}, by starting QEMU with: @code{-serial udp::4555} and nc as: 2464b65ee4faSStefan Weil@code{nc -u -l -p 4555}. Any time QEMU writes something to that port it 24655824d651Sblueswir1will appear in the netconsole session. 24665824d651Sblueswir1 24675824d651Sblueswir1If you plan to send characters back via netconsole or you want to stop 2468b65ee4faSStefan Weiland start QEMU a lot of times, you should have QEMU use the same 24695824d651Sblueswir1source port each time by using something like @code{-serial 2470b65ee4faSStefan Weiludp::4555@@:4556} to QEMU. Another approach is to use a patched 24715824d651Sblueswir1version of netcat which can listen to a TCP port and send and receive 24725824d651Sblueswir1characters via udp. If you have a patched version of netcat which 24735824d651Sblueswir1activates telnet remote echo and single char transfer, then you can 24745824d651Sblueswir1use the following options to step up a netcat redirector to allow 2475b65ee4faSStefan Weiltelnet on port 5555 to access the QEMU port. 24765824d651Sblueswir1@table @code 2477071c9394SStefan Weil@item QEMU Options: 24785824d651Sblueswir1-serial udp::4555@@:4556 24795824d651Sblueswir1@item netcat options: 24805824d651Sblueswir1-u -P 4555 -L 0.0.0.0:4556 -t -p 5555 -I -T 24815824d651Sblueswir1@item telnet options: 24825824d651Sblueswir1localhost 5555 24835824d651Sblueswir1@end table 24845824d651Sblueswir1 24855824d651Sblueswir1@item tcp:[@var{host}]:@var{port}[,@var{server}][,nowait][,nodelay] 24865824d651Sblueswir1The TCP Net Console has two modes of operation. It can send the serial 24875824d651Sblueswir1I/O to a location or wait for a connection from a location. By default 24885824d651Sblueswir1the TCP Net Console is sent to @var{host} at the @var{port}. If you use 24895824d651Sblueswir1the @var{server} option QEMU will wait for a client socket application 24905824d651Sblueswir1to connect to the port before continuing, unless the @code{nowait} 24915824d651Sblueswir1option was specified. The @code{nodelay} option disables the Nagle buffering 24925824d651Sblueswir1algorithm. If @var{host} is omitted, 0.0.0.0 is assumed. Only 24935824d651Sblueswir1one TCP connection at a time is accepted. You can use @code{telnet} to 24945824d651Sblueswir1connect to the corresponding character device. 24955824d651Sblueswir1@table @code 24965824d651Sblueswir1@item Example to send tcp console to 192.168.0.2 port 4444 24975824d651Sblueswir1-serial tcp:192.168.0.2:4444 24985824d651Sblueswir1@item Example to listen and wait on port 4444 for connection 24995824d651Sblueswir1-serial tcp::4444,server 25005824d651Sblueswir1@item Example to not wait and listen on ip 192.168.0.100 port 4444 25015824d651Sblueswir1-serial tcp:192.168.0.100:4444,server,nowait 25025824d651Sblueswir1@end table 25035824d651Sblueswir1 25045824d651Sblueswir1@item telnet:@var{host}:@var{port}[,server][,nowait][,nodelay] 25055824d651Sblueswir1The telnet protocol is used instead of raw tcp sockets. The options 25065824d651Sblueswir1work the same as if you had specified @code{-serial tcp}. The 25075824d651Sblueswir1difference is that the port acts like a telnet server or client using 25085824d651Sblueswir1telnet option negotiation. This will also allow you to send the 25095824d651Sblueswir1MAGIC_SYSRQ sequence if you use a telnet that supports sending the break 25105824d651Sblueswir1sequence. Typically in unix telnet you do it with Control-] and then 25115824d651Sblueswir1type "send break" followed by pressing the enter key. 25125824d651Sblueswir1 25135824d651Sblueswir1@item unix:@var{path}[,server][,nowait] 25145824d651Sblueswir1A unix domain socket is used instead of a tcp socket. The option works the 25155824d651Sblueswir1same as if you had specified @code{-serial tcp} except the unix domain socket 25165824d651Sblueswir1@var{path} is used for connections. 25175824d651Sblueswir1 25185824d651Sblueswir1@item mon:@var{dev_string} 25195824d651Sblueswir1This is a special option to allow the monitor to be multiplexed onto 25205824d651Sblueswir1another serial port. The monitor is accessed with key sequence of 252102c4bdf1SPaolo Bonzini@key{Control-a} and then pressing @key{c}. 25225824d651Sblueswir1@var{dev_string} should be any one of the serial devices specified 25235824d651Sblueswir1above. An example to multiplex the monitor onto a telnet server 25245824d651Sblueswir1listening on port 4444 would be: 25255824d651Sblueswir1@table @code 25265824d651Sblueswir1@item -serial mon:telnet::4444,server,nowait 25275824d651Sblueswir1@end table 2528be022d61SMichael TokarevWhen the monitor is multiplexed to stdio in this way, Ctrl+C will not terminate 252902c4bdf1SPaolo BonziniQEMU any more but will be passed to the guest instead. 25305824d651Sblueswir1 25315824d651Sblueswir1@item braille 25325824d651Sblueswir1Braille device. This will use BrlAPI to display the braille output on a real 25335824d651Sblueswir1or fake device. 25345824d651Sblueswir1 2535be8b28a9SKevin Wolf@item msmouse 2536be8b28a9SKevin WolfThree button serial mouse. Configure the guest to use Microsoft protocol. 25375824d651Sblueswir1@end table 25385824d651Sblueswir1ETEXI 25395824d651Sblueswir1 25405824d651Sblueswir1DEF("parallel", HAS_ARG, QEMU_OPTION_parallel, \ 2541ad96090aSBlue Swirl "-parallel dev redirect the parallel port to char device 'dev'\n", 2542ad96090aSBlue Swirl QEMU_ARCH_ALL) 25435824d651Sblueswir1STEXI 25445824d651Sblueswir1@item -parallel @var{dev} 25456616b2adSStefan Weil@findex -parallel 25465824d651Sblueswir1Redirect the virtual parallel port to host device @var{dev} (same 25475824d651Sblueswir1devices as the serial port). On Linux hosts, @file{/dev/parportN} can 25485824d651Sblueswir1be used to use hardware devices connected on the corresponding host 25495824d651Sblueswir1parallel port. 25505824d651Sblueswir1 25515824d651Sblueswir1This option can be used several times to simulate up to 3 parallel 25525824d651Sblueswir1ports. 25535824d651Sblueswir1 25545824d651Sblueswir1Use @code{-parallel none} to disable all parallel ports. 25555824d651Sblueswir1ETEXI 25565824d651Sblueswir1 25575824d651Sblueswir1DEF("monitor", HAS_ARG, QEMU_OPTION_monitor, \ 2558ad96090aSBlue Swirl "-monitor dev redirect the monitor to char device 'dev'\n", 2559ad96090aSBlue Swirl QEMU_ARCH_ALL) 25605824d651Sblueswir1STEXI 25614e307fc8SGerd Hoffmann@item -monitor @var{dev} 25626616b2adSStefan Weil@findex -monitor 25635824d651Sblueswir1Redirect the monitor to host device @var{dev} (same devices as the 25645824d651Sblueswir1serial port). 25655824d651Sblueswir1The default device is @code{vc} in graphical mode and @code{stdio} in 25665824d651Sblueswir1non graphical mode. 256770e098afSLuiz CapitulinoUse @code{-monitor none} to disable the default monitor. 25685824d651Sblueswir1ETEXI 25696ca5582dSGerd HoffmannDEF("qmp", HAS_ARG, QEMU_OPTION_qmp, \ 2570ad96090aSBlue Swirl "-qmp dev like -monitor but opens in 'control' mode\n", 2571ad96090aSBlue Swirl QEMU_ARCH_ALL) 257295d5f08bSStefan WeilSTEXI 257395d5f08bSStefan Weil@item -qmp @var{dev} 25746616b2adSStefan Weil@findex -qmp 257595d5f08bSStefan WeilLike -monitor but opens in 'control' mode. 257695d5f08bSStefan WeilETEXI 25775824d651Sblueswir1 257822a0e04bSGerd HoffmannDEF("mon", HAS_ARG, QEMU_OPTION_mon, \ 2579f17e4eaaSMichael Tokarev "-mon [chardev=]name[,mode=readline|control][,default]\n", QEMU_ARCH_ALL) 258022a0e04bSGerd HoffmannSTEXI 2581f17e4eaaSMichael Tokarev@item -mon [chardev=]name[,mode=readline|control][,default] 25826616b2adSStefan Weil@findex -mon 258322a0e04bSGerd HoffmannSetup monitor on chardev @var{name}. 258422a0e04bSGerd HoffmannETEXI 258522a0e04bSGerd Hoffmann 2586c9f398e5SH. Peter AnvinDEF("debugcon", HAS_ARG, QEMU_OPTION_debugcon, \ 2587ad96090aSBlue Swirl "-debugcon dev redirect the debug console to char device 'dev'\n", 2588ad96090aSBlue Swirl QEMU_ARCH_ALL) 2589c9f398e5SH. Peter AnvinSTEXI 2590c9f398e5SH. Peter Anvin@item -debugcon @var{dev} 25916616b2adSStefan Weil@findex -debugcon 2592c9f398e5SH. Peter AnvinRedirect the debug console to host device @var{dev} (same devices as the 2593c9f398e5SH. Peter Anvinserial port). The debug console is an I/O port which is typically port 2594c9f398e5SH. Peter Anvin0xe9; writing to that I/O port sends output to this device. 2595c9f398e5SH. Peter AnvinThe default device is @code{vc} in graphical mode and @code{stdio} in 2596c9f398e5SH. Peter Anvinnon graphical mode. 2597c9f398e5SH. Peter AnvinETEXI 2598c9f398e5SH. Peter Anvin 25995824d651Sblueswir1DEF("pidfile", HAS_ARG, QEMU_OPTION_pidfile, \ 2600ad96090aSBlue Swirl "-pidfile file write PID to 'file'\n", QEMU_ARCH_ALL) 26015824d651Sblueswir1STEXI 26025824d651Sblueswir1@item -pidfile @var{file} 26036616b2adSStefan Weil@findex -pidfile 26045824d651Sblueswir1Store the QEMU process PID in @var{file}. It is useful if you launch QEMU 26055824d651Sblueswir1from a script. 26065824d651Sblueswir1ETEXI 26075824d651Sblueswir1 26081b530a6dSaurel32DEF("singlestep", 0, QEMU_OPTION_singlestep, \ 2609ad96090aSBlue Swirl "-singlestep always run in singlestep mode\n", QEMU_ARCH_ALL) 26101b530a6dSaurel32STEXI 26111b530a6dSaurel32@item -singlestep 26126616b2adSStefan Weil@findex -singlestep 26131b530a6dSaurel32Run the emulation in single step mode. 26141b530a6dSaurel32ETEXI 26151b530a6dSaurel32 26165824d651Sblueswir1DEF("S", 0, QEMU_OPTION_S, \ 2617ad96090aSBlue Swirl "-S freeze CPU at startup (use 'c' to start execution)\n", 2618ad96090aSBlue Swirl QEMU_ARCH_ALL) 26195824d651Sblueswir1STEXI 26205824d651Sblueswir1@item -S 26216616b2adSStefan Weil@findex -S 26225824d651Sblueswir1Do not start CPU at startup (you must type 'c' in the monitor). 26235824d651Sblueswir1ETEXI 26245824d651Sblueswir1 2625888a6bc6SSatoru MoriyaDEF("realtime", HAS_ARG, QEMU_OPTION_realtime, 2626888a6bc6SSatoru Moriya "-realtime [mlock=on|off]\n" 2627888a6bc6SSatoru Moriya " run qemu with realtime features\n" 2628888a6bc6SSatoru Moriya " mlock=on|off controls mlock support (default: on)\n", 2629888a6bc6SSatoru Moriya QEMU_ARCH_ALL) 2630888a6bc6SSatoru MoriyaSTEXI 2631888a6bc6SSatoru Moriya@item -realtime mlock=on|off 2632888a6bc6SSatoru Moriya@findex -realtime 2633888a6bc6SSatoru MoriyaRun qemu with realtime features. 2634888a6bc6SSatoru Moriyamlocking qemu and guest memory can be enabled via @option{mlock=on} 2635888a6bc6SSatoru Moriya(enabled by default). 2636888a6bc6SSatoru MoriyaETEXI 2637888a6bc6SSatoru Moriya 263859030a8cSaliguoriDEF("gdb", HAS_ARG, QEMU_OPTION_gdb, \ 2639ad96090aSBlue Swirl "-gdb dev wait for gdb connection on 'dev'\n", QEMU_ARCH_ALL) 26405824d651Sblueswir1STEXI 264159030a8cSaliguori@item -gdb @var{dev} 26426616b2adSStefan Weil@findex -gdb 264359030a8cSaliguoriWait for gdb connection on device @var{dev} (@pxref{gdb_usage}). Typical 264459030a8cSaliguoriconnections will likely be TCP-based, but also UDP, pseudo TTY, or even 2645b65ee4faSStefan Weilstdio are reasonable use case. The latter is allowing to start QEMU from 264659030a8cSaliguoriwithin gdb and establish the connection via a pipe: 264759030a8cSaliguori@example 26483804da9dSStefan Weil(gdb) target remote | exec qemu-system-i386 -gdb stdio ... 264959030a8cSaliguori@end example 26505824d651Sblueswir1ETEXI 26515824d651Sblueswir1 265259030a8cSaliguoriDEF("s", 0, QEMU_OPTION_s, \ 2653ad96090aSBlue Swirl "-s shorthand for -gdb tcp::" DEFAULT_GDBSTUB_PORT "\n", 2654ad96090aSBlue Swirl QEMU_ARCH_ALL) 26555824d651Sblueswir1STEXI 265659030a8cSaliguori@item -s 26576616b2adSStefan Weil@findex -s 265859030a8cSaliguoriShorthand for -gdb tcp::1234, i.e. open a gdbserver on TCP port 1234 265959030a8cSaliguori(@pxref{gdb_usage}). 26605824d651Sblueswir1ETEXI 26615824d651Sblueswir1 26625824d651Sblueswir1DEF("d", HAS_ARG, QEMU_OPTION_d, \ 2663989b697dSPeter Maydell "-d item1,... enable logging of specified items (use '-d help' for a list of log items)\n", 2664ad96090aSBlue Swirl QEMU_ARCH_ALL) 26655824d651Sblueswir1STEXI 2666989b697dSPeter Maydell@item -d @var{item1}[,...] 26676616b2adSStefan Weil@findex -d 2668989b697dSPeter MaydellEnable logging of specified items. Use '-d help' for a list of log items. 26695824d651Sblueswir1ETEXI 26705824d651Sblueswir1 2671c235d738SMatthew FernandezDEF("D", HAS_ARG, QEMU_OPTION_D, \ 2672989b697dSPeter Maydell "-D logfile output log to logfile (default stderr)\n", 2673c235d738SMatthew Fernandez QEMU_ARCH_ALL) 2674c235d738SMatthew FernandezSTEXI 26758bd383b4SStefan Weil@item -D @var{logfile} 2676c235d738SMatthew Fernandez@findex -D 2677989b697dSPeter MaydellOutput log in @var{logfile} instead of to stderr 2678c235d738SMatthew FernandezETEXI 2679c235d738SMatthew Fernandez 26805824d651Sblueswir1DEF("L", HAS_ARG, QEMU_OPTION_L, \ 2681ad96090aSBlue Swirl "-L path set the directory for the BIOS, VGA BIOS and keymaps\n", 2682ad96090aSBlue Swirl QEMU_ARCH_ALL) 26835824d651Sblueswir1STEXI 26845824d651Sblueswir1@item -L @var{path} 26856616b2adSStefan Weil@findex -L 26865824d651Sblueswir1Set the directory for the BIOS, VGA BIOS and keymaps. 26875824d651Sblueswir1ETEXI 26885824d651Sblueswir1 26895824d651Sblueswir1DEF("bios", HAS_ARG, QEMU_OPTION_bios, \ 2690ad96090aSBlue Swirl "-bios file set the filename for the BIOS\n", QEMU_ARCH_ALL) 26915824d651Sblueswir1STEXI 26925824d651Sblueswir1@item -bios @var{file} 26936616b2adSStefan Weil@findex -bios 26945824d651Sblueswir1Set the filename for the BIOS. 26955824d651Sblueswir1ETEXI 26965824d651Sblueswir1 26975824d651Sblueswir1DEF("enable-kvm", 0, QEMU_OPTION_enable_kvm, \ 2698ad96090aSBlue Swirl "-enable-kvm enable KVM full virtualization support\n", QEMU_ARCH_ALL) 26995824d651Sblueswir1STEXI 27005824d651Sblueswir1@item -enable-kvm 27016616b2adSStefan Weil@findex -enable-kvm 27025824d651Sblueswir1Enable KVM full virtualization support. This option is only available 27035824d651Sblueswir1if KVM support is enabled when compiling. 27045824d651Sblueswir1ETEXI 27055824d651Sblueswir1 2706e37630caSaliguoriDEF("xen-domid", HAS_ARG, QEMU_OPTION_xen_domid, 2707ad96090aSBlue Swirl "-xen-domid id specify xen guest domain id\n", QEMU_ARCH_ALL) 2708e37630caSaliguoriDEF("xen-create", 0, QEMU_OPTION_xen_create, 2709e37630caSaliguori "-xen-create create domain using xen hypercalls, bypassing xend\n" 2710ad96090aSBlue Swirl " warning: should not be used when xend is in use\n", 2711ad96090aSBlue Swirl QEMU_ARCH_ALL) 2712e37630caSaliguoriDEF("xen-attach", 0, QEMU_OPTION_xen_attach, 2713e37630caSaliguori "-xen-attach attach to existing xen domain\n" 2714b65ee4faSStefan Weil " xend will use this when starting QEMU\n", 2715ad96090aSBlue Swirl QEMU_ARCH_ALL) 271695d5f08bSStefan WeilSTEXI 271795d5f08bSStefan Weil@item -xen-domid @var{id} 27186616b2adSStefan Weil@findex -xen-domid 271995d5f08bSStefan WeilSpecify xen guest domain @var{id} (XEN only). 272095d5f08bSStefan Weil@item -xen-create 27216616b2adSStefan Weil@findex -xen-create 272295d5f08bSStefan WeilCreate domain using xen hypercalls, bypassing xend. 272395d5f08bSStefan WeilWarning: should not be used when xend is in use (XEN only). 272495d5f08bSStefan Weil@item -xen-attach 27256616b2adSStefan Weil@findex -xen-attach 272695d5f08bSStefan WeilAttach to existing xen domain. 2727b65ee4faSStefan Weilxend will use this when starting QEMU (XEN only). 272895d5f08bSStefan WeilETEXI 2729e37630caSaliguori 27305824d651Sblueswir1DEF("no-reboot", 0, QEMU_OPTION_no_reboot, \ 2731ad96090aSBlue Swirl "-no-reboot exit instead of rebooting\n", QEMU_ARCH_ALL) 27325824d651Sblueswir1STEXI 27335824d651Sblueswir1@item -no-reboot 27346616b2adSStefan Weil@findex -no-reboot 27355824d651Sblueswir1Exit instead of rebooting. 27365824d651Sblueswir1ETEXI 27375824d651Sblueswir1 27385824d651Sblueswir1DEF("no-shutdown", 0, QEMU_OPTION_no_shutdown, \ 2739ad96090aSBlue Swirl "-no-shutdown stop before shutdown\n", QEMU_ARCH_ALL) 27405824d651Sblueswir1STEXI 27415824d651Sblueswir1@item -no-shutdown 27426616b2adSStefan Weil@findex -no-shutdown 27435824d651Sblueswir1Don't exit QEMU on guest shutdown, but instead only stop the emulation. 27445824d651Sblueswir1This allows for instance switching to monitor to commit changes to the 27455824d651Sblueswir1disk image. 27465824d651Sblueswir1ETEXI 27475824d651Sblueswir1 27485824d651Sblueswir1DEF("loadvm", HAS_ARG, QEMU_OPTION_loadvm, \ 27495824d651Sblueswir1 "-loadvm [tag|id]\n" \ 2750ad96090aSBlue Swirl " start right away with a saved state (loadvm in monitor)\n", 2751ad96090aSBlue Swirl QEMU_ARCH_ALL) 27525824d651Sblueswir1STEXI 27535824d651Sblueswir1@item -loadvm @var{file} 27546616b2adSStefan Weil@findex -loadvm 27555824d651Sblueswir1Start right away with a saved state (@code{loadvm} in monitor) 27565824d651Sblueswir1ETEXI 27575824d651Sblueswir1 27585824d651Sblueswir1#ifndef _WIN32 27595824d651Sblueswir1DEF("daemonize", 0, QEMU_OPTION_daemonize, \ 2760ad96090aSBlue Swirl "-daemonize daemonize QEMU after initializing\n", QEMU_ARCH_ALL) 27615824d651Sblueswir1#endif 27625824d651Sblueswir1STEXI 27635824d651Sblueswir1@item -daemonize 27646616b2adSStefan Weil@findex -daemonize 27655824d651Sblueswir1Daemonize the QEMU process after initialization. QEMU will not detach from 27665824d651Sblueswir1standard IO until it is ready to receive connections on any of its devices. 27675824d651Sblueswir1This option is a useful way for external programs to launch QEMU without having 27685824d651Sblueswir1to cope with initialization race conditions. 27695824d651Sblueswir1ETEXI 27705824d651Sblueswir1 27715824d651Sblueswir1DEF("option-rom", HAS_ARG, QEMU_OPTION_option_rom, \ 2772ad96090aSBlue Swirl "-option-rom rom load a file, rom, into the option ROM space\n", 2773ad96090aSBlue Swirl QEMU_ARCH_ALL) 27745824d651Sblueswir1STEXI 27755824d651Sblueswir1@item -option-rom @var{file} 27766616b2adSStefan Weil@findex -option-rom 27775824d651Sblueswir1Load the contents of @var{file} as an option ROM. 27785824d651Sblueswir1This option is useful to load things like EtherBoot. 27795824d651Sblueswir1ETEXI 27805824d651Sblueswir1 27815824d651Sblueswir1DEF("clock", HAS_ARG, QEMU_OPTION_clock, \ 27825824d651Sblueswir1 "-clock force the use of the given methods for timer alarm.\n" \ 2783585f6036SPeter Maydell " To see what timers are available use '-clock help'\n", 2784ad96090aSBlue Swirl QEMU_ARCH_ALL) 27855824d651Sblueswir1STEXI 27865824d651Sblueswir1@item -clock @var{method} 27876616b2adSStefan Weil@findex -clock 27885824d651Sblueswir1Force the use of the given methods for timer alarm. To see what timers 2789585f6036SPeter Maydellare available use @code{-clock help}. 27905824d651Sblueswir1ETEXI 27915824d651Sblueswir1 27921ed2fc1fSJan KiszkaHXCOMM Options deprecated by -rtc 2793ad96090aSBlue SwirlDEF("localtime", 0, QEMU_OPTION_localtime, "", QEMU_ARCH_ALL) 2794ad96090aSBlue SwirlDEF("startdate", HAS_ARG, QEMU_OPTION_startdate, "", QEMU_ARCH_ALL) 27955824d651Sblueswir1 27961ed2fc1fSJan KiszkaDEF("rtc", HAS_ARG, QEMU_OPTION_rtc, \ 279778808141SPaolo Bonzini "-rtc [base=utc|localtime|date][,clock=host|rt|vm][,driftfix=none|slew]\n" \ 2798ad96090aSBlue Swirl " set the RTC base and clock, enable drift fix for clock ticks (x86 only)\n", 2799ad96090aSBlue Swirl QEMU_ARCH_ALL) 28001ed2fc1fSJan Kiszka 28015824d651Sblueswir1STEXI 28025824d651Sblueswir1 28036875204cSJan Kiszka@item -rtc [base=utc|localtime|@var{date}][,clock=host|vm][,driftfix=none|slew] 28046616b2adSStefan Weil@findex -rtc 28051ed2fc1fSJan KiszkaSpecify @option{base} as @code{utc} or @code{localtime} to let the RTC start at the current 28061ed2fc1fSJan KiszkaUTC or local time, respectively. @code{localtime} is required for correct date in 28071ed2fc1fSJan KiszkaMS-DOS or Windows. To start at a specific point in time, provide @var{date} in the 28081ed2fc1fSJan Kiszkaformat @code{2006-06-17T16:01:21} or @code{2006-06-17}. The default base is UTC. 28091ed2fc1fSJan Kiszka 28109d85d557SMichael TokarevBy default the RTC is driven by the host system time. This allows using of the 28116875204cSJan KiszkaRTC as accurate reference clock inside the guest, specifically if the host 28126875204cSJan Kiszkatime is smoothly following an accurate external reference clock, e.g. via NTP. 281378808141SPaolo BonziniIf you want to isolate the guest time from the host, you can set @option{clock} 281478808141SPaolo Bonzinito @code{rt} instead. To even prevent it from progressing during suspension, 281578808141SPaolo Bonziniyou can set it to @code{vm}. 28166875204cSJan Kiszka 28171ed2fc1fSJan KiszkaEnable @option{driftfix} (i386 targets only) if you experience time drift problems, 28181ed2fc1fSJan Kiszkaspecifically with Windows' ACPI HAL. This option will try to figure out how 28191ed2fc1fSJan Kiszkamany timer interrupts were not processed by the Windows guest and will 28201ed2fc1fSJan Kiszkare-inject them. 28215824d651Sblueswir1ETEXI 28225824d651Sblueswir1 28235824d651Sblueswir1DEF("icount", HAS_ARG, QEMU_OPTION_icount, \ 28245824d651Sblueswir1 "-icount [N|auto]\n" \ 2825bc14ca24Saliguori " enable virtual instruction counter with 2^N clock ticks per\n" \ 2826ad96090aSBlue Swirl " instruction\n", QEMU_ARCH_ALL) 28275824d651Sblueswir1STEXI 28284e257e5eSKevin Wolf@item -icount [@var{N}|auto] 28296616b2adSStefan Weil@findex -icount 28305824d651Sblueswir1Enable virtual instruction counter. The virtual cpu will execute one 28314e257e5eSKevin Wolfinstruction every 2^@var{N} ns of virtual time. If @code{auto} is specified 28325824d651Sblueswir1then the virtual cpu speed will be automatically adjusted to keep virtual 28335824d651Sblueswir1time within a few seconds of real time. 28345824d651Sblueswir1 28355824d651Sblueswir1Note that while this option can give deterministic behavior, it does not 28365824d651Sblueswir1provide cycle accurate emulation. Modern CPUs contain superscalar out of 28375824d651Sblueswir1order cores with complex cache hierarchies. The number of instructions 28385824d651Sblueswir1executed often has little or no correlation with actual performance. 28395824d651Sblueswir1ETEXI 28405824d651Sblueswir1 28419dd986ccSRichard W.M. JonesDEF("watchdog", HAS_ARG, QEMU_OPTION_watchdog, \ 28429dd986ccSRichard W.M. Jones "-watchdog i6300esb|ib700\n" \ 2843ad96090aSBlue Swirl " enable virtual hardware watchdog [default=none]\n", 2844ad96090aSBlue Swirl QEMU_ARCH_ALL) 28459dd986ccSRichard W.M. JonesSTEXI 28469dd986ccSRichard W.M. Jones@item -watchdog @var{model} 28476616b2adSStefan Weil@findex -watchdog 28489dd986ccSRichard W.M. JonesCreate a virtual hardware watchdog device. Once enabled (by a guest 28499dd986ccSRichard W.M. Jonesaction), the watchdog must be periodically polled by an agent inside 28509dd986ccSRichard W.M. Jonesthe guest or else the guest will be restarted. 28519dd986ccSRichard W.M. Jones 28529dd986ccSRichard W.M. JonesThe @var{model} is the model of hardware watchdog to emulate. Choices 28539dd986ccSRichard W.M. Jonesfor model are: @code{ib700} (iBASE 700) which is a very simple ISA 28549dd986ccSRichard W.M. Joneswatchdog with a single timer, or @code{i6300esb} (Intel 6300ESB I/O 28559dd986ccSRichard W.M. Jonescontroller hub) which is a much more featureful PCI-based dual-timer 28569dd986ccSRichard W.M. Joneswatchdog. Choose a model for which your guest has drivers. 28579dd986ccSRichard W.M. Jones 2858585f6036SPeter MaydellUse @code{-watchdog help} to list available hardware models. Only one 28599dd986ccSRichard W.M. Joneswatchdog can be enabled for a guest. 28609dd986ccSRichard W.M. JonesETEXI 28619dd986ccSRichard W.M. Jones 28629dd986ccSRichard W.M. JonesDEF("watchdog-action", HAS_ARG, QEMU_OPTION_watchdog_action, \ 28639dd986ccSRichard W.M. Jones "-watchdog-action reset|shutdown|poweroff|pause|debug|none\n" \ 2864ad96090aSBlue Swirl " action when watchdog fires [default=reset]\n", 2865ad96090aSBlue Swirl QEMU_ARCH_ALL) 28669dd986ccSRichard W.M. JonesSTEXI 28679dd986ccSRichard W.M. Jones@item -watchdog-action @var{action} 2868b8f490ebSMarkus Armbruster@findex -watchdog-action 28699dd986ccSRichard W.M. Jones 28709dd986ccSRichard W.M. JonesThe @var{action} controls what QEMU will do when the watchdog timer 28719dd986ccSRichard W.M. Jonesexpires. 28729dd986ccSRichard W.M. JonesThe default is 28739dd986ccSRichard W.M. Jones@code{reset} (forcefully reset the guest). 28749dd986ccSRichard W.M. JonesOther possible actions are: 28759dd986ccSRichard W.M. Jones@code{shutdown} (attempt to gracefully shutdown the guest), 28769dd986ccSRichard W.M. Jones@code{poweroff} (forcefully poweroff the guest), 28779dd986ccSRichard W.M. Jones@code{pause} (pause the guest), 28789dd986ccSRichard W.M. Jones@code{debug} (print a debug message and continue), or 28799dd986ccSRichard W.M. Jones@code{none} (do nothing). 28809dd986ccSRichard W.M. Jones 28819dd986ccSRichard W.M. JonesNote that the @code{shutdown} action requires that the guest responds 28829dd986ccSRichard W.M. Jonesto ACPI signals, which it may not be able to do in the sort of 28839dd986ccSRichard W.M. Jonessituations where the watchdog would have expired, and thus 28849dd986ccSRichard W.M. Jones@code{-watchdog-action shutdown} is not recommended for production use. 28859dd986ccSRichard W.M. Jones 28869dd986ccSRichard W.M. JonesExamples: 28879dd986ccSRichard W.M. Jones 28889dd986ccSRichard W.M. Jones@table @code 28899dd986ccSRichard W.M. Jones@item -watchdog i6300esb -watchdog-action pause 28909dd986ccSRichard W.M. Jones@item -watchdog ib700 28919dd986ccSRichard W.M. Jones@end table 28929dd986ccSRichard W.M. JonesETEXI 28939dd986ccSRichard W.M. Jones 28945824d651Sblueswir1DEF("echr", HAS_ARG, QEMU_OPTION_echr, \ 2895ad96090aSBlue Swirl "-echr chr set terminal escape character instead of ctrl-a\n", 2896ad96090aSBlue Swirl QEMU_ARCH_ALL) 28975824d651Sblueswir1STEXI 28985824d651Sblueswir1 28994e257e5eSKevin Wolf@item -echr @var{numeric_ascii_value} 29006616b2adSStefan Weil@findex -echr 29015824d651Sblueswir1Change the escape character used for switching to the monitor when using 29025824d651Sblueswir1monitor and serial sharing. The default is @code{0x01} when using the 29035824d651Sblueswir1@code{-nographic} option. @code{0x01} is equal to pressing 29045824d651Sblueswir1@code{Control-a}. You can select a different character from the ascii 29055824d651Sblueswir1control keys where 1 through 26 map to Control-a through Control-z. For 29065824d651Sblueswir1instance you could use the either of the following to change the escape 29075824d651Sblueswir1character to Control-t. 29085824d651Sblueswir1@table @code 29095824d651Sblueswir1@item -echr 0x14 29105824d651Sblueswir1@item -echr 20 29115824d651Sblueswir1@end table 29125824d651Sblueswir1ETEXI 29135824d651Sblueswir1 29145824d651Sblueswir1DEF("virtioconsole", HAS_ARG, QEMU_OPTION_virtiocon, \ 29155824d651Sblueswir1 "-virtioconsole c\n" \ 2916ad96090aSBlue Swirl " set virtio console\n", QEMU_ARCH_ALL) 29175824d651Sblueswir1STEXI 29185824d651Sblueswir1@item -virtioconsole @var{c} 29196616b2adSStefan Weil@findex -virtioconsole 29205824d651Sblueswir1Set virtio console. 292198b19252SAmit Shah 292298b19252SAmit ShahThis option is maintained for backward compatibility. 292398b19252SAmit Shah 292498b19252SAmit ShahPlease use @code{-device virtconsole} for the new way of invocation. 29255824d651Sblueswir1ETEXI 29265824d651Sblueswir1 29275824d651Sblueswir1DEF("show-cursor", 0, QEMU_OPTION_show_cursor, \ 2928ad96090aSBlue Swirl "-show-cursor show cursor\n", QEMU_ARCH_ALL) 29295824d651Sblueswir1STEXI 293095d5f08bSStefan Weil@item -show-cursor 29316616b2adSStefan Weil@findex -show-cursor 293295d5f08bSStefan WeilShow cursor. 29335824d651Sblueswir1ETEXI 29345824d651Sblueswir1 29355824d651Sblueswir1DEF("tb-size", HAS_ARG, QEMU_OPTION_tb_size, \ 2936ad96090aSBlue Swirl "-tb-size n set TB size\n", QEMU_ARCH_ALL) 29375824d651Sblueswir1STEXI 293895d5f08bSStefan Weil@item -tb-size @var{n} 29396616b2adSStefan Weil@findex -tb-size 294095d5f08bSStefan WeilSet TB size. 29415824d651Sblueswir1ETEXI 29425824d651Sblueswir1 29435824d651Sblueswir1DEF("incoming", HAS_ARG, QEMU_OPTION_incoming, \ 2944ad96090aSBlue Swirl "-incoming p prepare for incoming migration, listen on port p\n", 2945ad96090aSBlue Swirl QEMU_ARCH_ALL) 29465824d651Sblueswir1STEXI 294795d5f08bSStefan Weil@item -incoming @var{port} 29486616b2adSStefan Weil@findex -incoming 294995d5f08bSStefan WeilPrepare for incoming migration, listen on @var{port}. 29505824d651Sblueswir1ETEXI 29515824d651Sblueswir1 2952d8c208ddSGerd HoffmannDEF("nodefaults", 0, QEMU_OPTION_nodefaults, \ 2953ad96090aSBlue Swirl "-nodefaults don't create default devices\n", QEMU_ARCH_ALL) 2954d8c208ddSGerd HoffmannSTEXI 29553dbf2c7fSStefan Weil@item -nodefaults 29566616b2adSStefan Weil@findex -nodefaults 295766c19bf1SMichal NovotnyDon't create default devices. Normally, QEMU sets the default devices like serial 295866c19bf1SMichal Novotnyport, parallel port, virtual console, monitor device, VGA adapter, floppy and 295966c19bf1SMichal NovotnyCD-ROM drive and others. The @code{-nodefaults} option will disable all those 296066c19bf1SMichal Novotnydefault devices. 2961d8c208ddSGerd HoffmannETEXI 2962d8c208ddSGerd Hoffmann 29635824d651Sblueswir1#ifndef _WIN32 29645824d651Sblueswir1DEF("chroot", HAS_ARG, QEMU_OPTION_chroot, \ 2965ad96090aSBlue Swirl "-chroot dir chroot to dir just before starting the VM\n", 2966ad96090aSBlue Swirl QEMU_ARCH_ALL) 29675824d651Sblueswir1#endif 29685824d651Sblueswir1STEXI 29694e257e5eSKevin Wolf@item -chroot @var{dir} 29706616b2adSStefan Weil@findex -chroot 29715824d651Sblueswir1Immediately before starting guest execution, chroot to the specified 29725824d651Sblueswir1directory. Especially useful in combination with -runas. 29735824d651Sblueswir1ETEXI 29745824d651Sblueswir1 29755824d651Sblueswir1#ifndef _WIN32 29765824d651Sblueswir1DEF("runas", HAS_ARG, QEMU_OPTION_runas, \ 2977ad96090aSBlue Swirl "-runas user change to user id user just before starting the VM\n", 2978ad96090aSBlue Swirl QEMU_ARCH_ALL) 29795824d651Sblueswir1#endif 29805824d651Sblueswir1STEXI 29814e257e5eSKevin Wolf@item -runas @var{user} 29826616b2adSStefan Weil@findex -runas 29835824d651Sblueswir1Immediately before starting guest execution, drop root privileges, switching 29845824d651Sblueswir1to the specified user. 29855824d651Sblueswir1ETEXI 29865824d651Sblueswir1 29875824d651Sblueswir1DEF("prom-env", HAS_ARG, QEMU_OPTION_prom_env, 29885824d651Sblueswir1 "-prom-env variable=value\n" 2989ad96090aSBlue Swirl " set OpenBIOS nvram variables\n", 2990ad96090aSBlue Swirl QEMU_ARCH_PPC | QEMU_ARCH_SPARC) 299195d5f08bSStefan WeilSTEXI 299295d5f08bSStefan Weil@item -prom-env @var{variable}=@var{value} 29936616b2adSStefan Weil@findex -prom-env 299495d5f08bSStefan WeilSet OpenBIOS nvram @var{variable} to given @var{value} (PPC, SPARC only). 299595d5f08bSStefan WeilETEXI 29965824d651Sblueswir1DEF("semihosting", 0, QEMU_OPTION_semihosting, 29971ddeaa5dSMax Filippov "-semihosting semihosting mode\n", QEMU_ARCH_ARM | QEMU_ARCH_M68K | QEMU_ARCH_XTENSA) 299895d5f08bSStefan WeilSTEXI 299995d5f08bSStefan Weil@item -semihosting 30006616b2adSStefan Weil@findex -semihosting 30011ddeaa5dSMax FilippovSemihosting mode (ARM, M68K, Xtensa only). 300295d5f08bSStefan WeilETEXI 30035824d651Sblueswir1DEF("old-param", 0, QEMU_OPTION_old_param, 3004ad96090aSBlue Swirl "-old-param old param mode\n", QEMU_ARCH_ARM) 300595d5f08bSStefan WeilSTEXI 300695d5f08bSStefan Weil@item -old-param 30076616b2adSStefan Weil@findex -old-param (ARM) 300895d5f08bSStefan WeilOld param mode (ARM only). 300995d5f08bSStefan WeilETEXI 301095d5f08bSStefan Weil 30117d76ad4fSEduardo OtuboDEF("sandbox", HAS_ARG, QEMU_OPTION_sandbox, \ 30127d76ad4fSEduardo Otubo "-sandbox <arg> Enable seccomp mode 2 system call filter (default 'off').\n", 30137d76ad4fSEduardo Otubo QEMU_ARCH_ALL) 30147d76ad4fSEduardo OtuboSTEXI 30156265c43bSMarkus Armbruster@item -sandbox @var{arg} 30167d76ad4fSEduardo Otubo@findex -sandbox 30177d76ad4fSEduardo OtuboEnable Seccomp mode 2 system call filter. 'on' will enable syscall filtering and 'off' will 30187d76ad4fSEduardo Otubodisable it. The default is 'off'. 30197d76ad4fSEduardo OtuboETEXI 30207d76ad4fSEduardo Otubo 3021715a664aSGerd HoffmannDEF("readconfig", HAS_ARG, QEMU_OPTION_readconfig, 3022ad96090aSBlue Swirl "-readconfig <file>\n", QEMU_ARCH_ALL) 30233dbf2c7fSStefan WeilSTEXI 30243dbf2c7fSStefan Weil@item -readconfig @var{file} 30256616b2adSStefan Weil@findex -readconfig 3026ed24cfacSMichal NovotnyRead device configuration from @var{file}. This approach is useful when you want to spawn 3027ed24cfacSMichal NovotnyQEMU process with many command line options but you don't want to exceed the command line 3028ed24cfacSMichal Novotnycharacter limit. 30293dbf2c7fSStefan WeilETEXI 3030715a664aSGerd HoffmannDEF("writeconfig", HAS_ARG, QEMU_OPTION_writeconfig, 3031715a664aSGerd Hoffmann "-writeconfig <file>\n" 3032ad96090aSBlue Swirl " read/write config file\n", QEMU_ARCH_ALL) 30333dbf2c7fSStefan WeilSTEXI 30343dbf2c7fSStefan Weil@item -writeconfig @var{file} 30356616b2adSStefan Weil@findex -writeconfig 3036ed24cfacSMichal NovotnyWrite device configuration to @var{file}. The @var{file} can be either filename to save 3037ed24cfacSMichal Novotnycommand line and device configuration into file or dash @code{-}) character to print the 3038ed24cfacSMichal Novotnyoutput to stdout. This can be later used as input file for @code{-readconfig} option. 30393dbf2c7fSStefan WeilETEXI 3040292444cbSAnthony LiguoriDEF("nodefconfig", 0, QEMU_OPTION_nodefconfig, 3041292444cbSAnthony Liguori "-nodefconfig\n" 3042ad96090aSBlue Swirl " do not load default config files at startup\n", 3043ad96090aSBlue Swirl QEMU_ARCH_ALL) 3044292444cbSAnthony LiguoriSTEXI 3045292444cbSAnthony Liguori@item -nodefconfig 30466616b2adSStefan Weil@findex -nodefconfig 3047f29a5614SEduardo HabkostNormally QEMU loads configuration files from @var{sysconfdir} and @var{datadir} at startup. 3048f29a5614SEduardo HabkostThe @code{-nodefconfig} option will prevent QEMU from loading any of those config files. 3049f29a5614SEduardo HabkostETEXI 3050f29a5614SEduardo HabkostDEF("no-user-config", 0, QEMU_OPTION_nouserconfig, 3051f29a5614SEduardo Habkost "-no-user-config\n" 3052f29a5614SEduardo Habkost " do not load user-provided config files at startup\n", 3053f29a5614SEduardo Habkost QEMU_ARCH_ALL) 3054f29a5614SEduardo HabkostSTEXI 3055f29a5614SEduardo Habkost@item -no-user-config 3056f29a5614SEduardo Habkost@findex -no-user-config 3057f29a5614SEduardo HabkostThe @code{-no-user-config} option makes QEMU not load any of the user-provided 3058f29a5614SEduardo Habkostconfig files on @var{sysconfdir}, but won't make it skip the QEMU-provided config 3059f29a5614SEduardo Habkostfiles from @var{datadir}. 3060292444cbSAnthony LiguoriETEXI 3061ab6540d5SPrerna SaxenaDEF("trace", HAS_ARG, QEMU_OPTION_trace, 306223d15e86SLluís "-trace [events=<file>][,file=<file>]\n" 306323d15e86SLluís " specify tracing options\n", 3064ab6540d5SPrerna Saxena QEMU_ARCH_ALL) 3065ab6540d5SPrerna SaxenaSTEXI 306623d15e86SLluísHXCOMM This line is not accurate, as some sub-options are backend-specific but 306723d15e86SLluísHXCOMM HX does not support conditional compilation of text. 306823d15e86SLluís@item -trace [events=@var{file}][,file=@var{file}] 3069ab6540d5SPrerna Saxena@findex -trace 3070e4858974SLluís 307123d15e86SLluísSpecify tracing options. 307223d15e86SLluís 307323d15e86SLluís@table @option 307423d15e86SLluís@item events=@var{file} 307523d15e86SLluísImmediately enable events listed in @var{file}. 307623d15e86SLluísThe file must contain one event name (as listed in the @var{trace-events} file) 307723d15e86SLluísper line. 3078c1ba4e0bSStefan WeilThis option is only available if QEMU has been compiled with 3079c1ba4e0bSStefan Weileither @var{simple} or @var{stderr} tracing backend. 308023d15e86SLluís@item file=@var{file} 308123d15e86SLluísLog output traces to @var{file}. 308223d15e86SLluís 3083c1ba4e0bSStefan WeilThis option is only available if QEMU has been compiled with 3084c1ba4e0bSStefan Weilthe @var{simple} tracing backend. 308523d15e86SLluís@end table 3086ab6540d5SPrerna SaxenaETEXI 30873dbf2c7fSStefan Weil 308831e70d6cSMarkus ArmbrusterHXCOMM Internal use 308931e70d6cSMarkus ArmbrusterDEF("qtest", HAS_ARG, QEMU_OPTION_qtest, "", QEMU_ARCH_ALL) 309031e70d6cSMarkus ArmbrusterDEF("qtest-log", HAS_ARG, QEMU_OPTION_qtest_log, "", QEMU_ARCH_ALL) 3091c7f0f3b1SAnthony Liguori 30920f66998fSPaul Moore#ifdef __linux__ 30930f66998fSPaul MooreDEF("enable-fips", 0, QEMU_OPTION_enablefips, 30940f66998fSPaul Moore "-enable-fips enable FIPS 140-2 compliance\n", 30950f66998fSPaul Moore QEMU_ARCH_ALL) 30960f66998fSPaul Moore#endif 30970f66998fSPaul MooreSTEXI 30980f66998fSPaul Moore@item -enable-fips 30990f66998fSPaul Moore@findex -enable-fips 31000f66998fSPaul MooreEnable FIPS 140-2 compliance mode. 31010f66998fSPaul MooreETEXI 31020f66998fSPaul Moore 3103a0dac021SJan KiszkaHXCOMM Deprecated by -machine accel=tcg property 3104c6e88b3bSBruce RogersDEF("no-kvm", 0, QEMU_OPTION_no_kvm, "", QEMU_ARCH_I386) 3105a0dac021SJan Kiszka 3106c21fb4f8SJan KiszkaHXCOMM Deprecated by kvm-pit driver properties 3107c6e88b3bSBruce RogersDEF("no-kvm-pit-reinjection", 0, QEMU_OPTION_no_kvm_pit_reinjection, 3108c21fb4f8SJan Kiszka "", QEMU_ARCH_I386) 3109c21fb4f8SJan Kiszka 31104086bde8SJan KiszkaHXCOMM Deprecated (ignored) 3111c6e88b3bSBruce RogersDEF("no-kvm-pit", 0, QEMU_OPTION_no_kvm_pit, "", QEMU_ARCH_I386) 31124086bde8SJan Kiszka 3113e43d594eSJan KiszkaHXCOMM Deprecated by -machine kernel_irqchip=on|off property 3114c6e88b3bSBruce RogersDEF("no-kvm-irqchip", 0, QEMU_OPTION_no_kvm_irqchip, "", QEMU_ARCH_I386) 3115e43d594eSJan Kiszka 311688eed34aSJan KiszkaHXCOMM Deprecated (ignored) 311788eed34aSJan KiszkaDEF("tdf", 0, QEMU_OPTION_tdf,"", QEMU_ARCH_ALL) 311888eed34aSJan Kiszka 311968d98d3eSAnthony LiguoriDEF("object", HAS_ARG, QEMU_OPTION_object, 312068d98d3eSAnthony Liguori "-object TYPENAME[,PROP1=VALUE1,...]\n" 312168d98d3eSAnthony Liguori " create an new object of type TYPENAME setting properties\n" 312268d98d3eSAnthony Liguori " in the order they are specified. Note that the 'id'\n" 312368d98d3eSAnthony Liguori " property must be set. These objects are placed in the\n" 312468d98d3eSAnthony Liguori " '/objects' path.\n", 312568d98d3eSAnthony Liguori QEMU_ARCH_ALL) 31266265c43bSMarkus ArmbrusterSTEXI 31276265c43bSMarkus Armbruster@item -object @var{typename}[,@var{prop1}=@var{value1},...] 31286265c43bSMarkus Armbruster@findex -object 31296265c43bSMarkus ArmbrusterCreate an new object of type @var{typename} setting properties 31306265c43bSMarkus Armbrusterin the order they are specified. Note that the 'id' 31316265c43bSMarkus Armbrusterproperty must be set. These objects are placed in the 31326265c43bSMarkus Armbruster'/objects' path. 31336265c43bSMarkus ArmbrusterETEXI 313468d98d3eSAnthony Liguori 31355e2ac519SSeiji AguchiDEF("msg", HAS_ARG, QEMU_OPTION_msg, 31365e2ac519SSeiji Aguchi "-msg timestamp[=on|off]\n" 31375e2ac519SSeiji Aguchi " change the format of messages\n" 31385e2ac519SSeiji Aguchi " on|off controls leading timestamps (default:on)\n", 31395e2ac519SSeiji Aguchi QEMU_ARCH_ALL) 31405e2ac519SSeiji AguchiSTEXI 31415e2ac519SSeiji Aguchi@item -msg timestamp[=on|off] 31425e2ac519SSeiji Aguchi@findex -msg 31435e2ac519SSeiji Aguchiprepend a timestamp to each log message.(default:on) 31445e2ac519SSeiji AguchiETEXI 31455e2ac519SSeiji Aguchi 31463dbf2c7fSStefan WeilHXCOMM This is the last statement. Insert new options before this line! 31473dbf2c7fSStefan WeilSTEXI 31483dbf2c7fSStefan Weil@end table 31493dbf2c7fSStefan WeilETEXI 3150