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 305824d651Sblueswir1DEF("M", HAS_ARG, QEMU_OPTION_M, 31ad96090aSBlue Swirl "-M machine select emulated machine (-M ? for list)\n", QEMU_ARCH_ALL) 325824d651Sblueswir1STEXI 335824d651Sblueswir1@item -M @var{machine} 346616b2adSStefan Weil@findex -M 355824d651Sblueswir1Select the emulated @var{machine} (@code{-M ?} for list) 365824d651Sblueswir1ETEXI 375824d651Sblueswir1 385824d651Sblueswir1DEF("cpu", HAS_ARG, QEMU_OPTION_cpu, 39ad96090aSBlue Swirl "-cpu cpu select CPU (-cpu ? for list)\n", QEMU_ARCH_ALL) 405824d651Sblueswir1STEXI 415824d651Sblueswir1@item -cpu @var{model} 426616b2adSStefan Weil@findex -cpu 435824d651Sblueswir1Select CPU model (-cpu ? for list and additional feature selection) 445824d651Sblueswir1ETEXI 455824d651Sblueswir1 465824d651Sblueswir1DEF("smp", HAS_ARG, QEMU_OPTION_smp, 4758a04db1SAndre Przywara "-smp n[,maxcpus=cpus][,cores=cores][,threads=threads][,sockets=sockets]\n" 486be68d7eSJes Sorensen " set the number of CPUs to 'n' [default=1]\n" 496be68d7eSJes Sorensen " maxcpus= maximum number of total cpus, including\n" 50ca1a8a06SBruce Rogers " offline CPUs for hotplug, etc\n" 5158a04db1SAndre Przywara " cores= number of CPU cores on one socket\n" 5258a04db1SAndre Przywara " threads= number of threads on one CPU core\n" 53ad96090aSBlue Swirl " sockets= number of discrete sockets in the system\n", 54ad96090aSBlue Swirl QEMU_ARCH_ALL) 555824d651Sblueswir1STEXI 5658a04db1SAndre Przywara@item -smp @var{n}[,cores=@var{cores}][,threads=@var{threads}][,sockets=@var{sockets}][,maxcpus=@var{maxcpus}] 576616b2adSStefan Weil@findex -smp 585824d651Sblueswir1Simulate an SMP system with @var{n} CPUs. On the PC target, up to 255 595824d651Sblueswir1CPUs are supported. On Sparc32 target, Linux limits the number of usable CPUs 605824d651Sblueswir1to 4. 6158a04db1SAndre PrzywaraFor the PC target, the number of @var{cores} per socket, the number 6258a04db1SAndre Przywaraof @var{threads} per cores and the total number of @var{sockets} can be 6358a04db1SAndre Przywaraspecified. Missing values will be computed. If any on the three values is 6458a04db1SAndre Przywaragiven, the total number of CPUs @var{n} can be omitted. @var{maxcpus} 6558a04db1SAndre Przywaraspecifies the maximum number of hotpluggable CPUs. 665824d651Sblueswir1ETEXI 675824d651Sblueswir1 68268a362cSaliguoriDEF("numa", HAS_ARG, QEMU_OPTION_numa, 69ad96090aSBlue Swirl "-numa node[,mem=size][,cpus=cpu[-cpu]][,nodeid=node]\n", QEMU_ARCH_ALL) 70268a362cSaliguoriSTEXI 71268a362cSaliguori@item -numa @var{opts} 726616b2adSStefan Weil@findex -numa 73268a362cSaliguoriSimulate a multi node NUMA system. If mem and cpus are omitted, resources 74268a362cSaliguoriare split equally. 75268a362cSaliguoriETEXI 76268a362cSaliguori 775824d651Sblueswir1DEF("fda", HAS_ARG, QEMU_OPTION_fda, 78ad96090aSBlue Swirl "-fda/-fdb file use 'file' as floppy disk 0/1 image\n", QEMU_ARCH_ALL) 79ad96090aSBlue SwirlDEF("fdb", HAS_ARG, QEMU_OPTION_fdb, "", QEMU_ARCH_ALL) 805824d651Sblueswir1STEXI 815824d651Sblueswir1@item -fda @var{file} 825824d651Sblueswir1@item -fdb @var{file} 836616b2adSStefan Weil@findex -fda 846616b2adSStefan Weil@findex -fdb 855824d651Sblueswir1Use @var{file} as floppy disk 0/1 image (@pxref{disk_images}). You can 865824d651Sblueswir1use the host floppy by using @file{/dev/fd0} as filename (@pxref{host_drives}). 875824d651Sblueswir1ETEXI 885824d651Sblueswir1 895824d651Sblueswir1DEF("hda", HAS_ARG, QEMU_OPTION_hda, 90ad96090aSBlue Swirl "-hda/-hdb file use 'file' as IDE hard disk 0/1 image\n", QEMU_ARCH_ALL) 91ad96090aSBlue SwirlDEF("hdb", HAS_ARG, QEMU_OPTION_hdb, "", QEMU_ARCH_ALL) 925824d651Sblueswir1DEF("hdc", HAS_ARG, QEMU_OPTION_hdc, 93ad96090aSBlue Swirl "-hdc/-hdd file use 'file' as IDE hard disk 2/3 image\n", QEMU_ARCH_ALL) 94ad96090aSBlue SwirlDEF("hdd", HAS_ARG, QEMU_OPTION_hdd, "", QEMU_ARCH_ALL) 955824d651Sblueswir1STEXI 965824d651Sblueswir1@item -hda @var{file} 975824d651Sblueswir1@item -hdb @var{file} 985824d651Sblueswir1@item -hdc @var{file} 995824d651Sblueswir1@item -hdd @var{file} 1006616b2adSStefan Weil@findex -hda 1016616b2adSStefan Weil@findex -hdb 1026616b2adSStefan Weil@findex -hdc 1036616b2adSStefan Weil@findex -hdd 1045824d651Sblueswir1Use @var{file} as hard disk 0, 1, 2 or 3 image (@pxref{disk_images}). 1055824d651Sblueswir1ETEXI 1065824d651Sblueswir1 1075824d651Sblueswir1DEF("cdrom", HAS_ARG, QEMU_OPTION_cdrom, 108ad96090aSBlue Swirl "-cdrom file use 'file' as IDE cdrom image (cdrom is ide1 master)\n", 109ad96090aSBlue Swirl QEMU_ARCH_ALL) 1105824d651Sblueswir1STEXI 1115824d651Sblueswir1@item -cdrom @var{file} 1126616b2adSStefan Weil@findex -cdrom 1135824d651Sblueswir1Use @var{file} as CD-ROM image (you cannot use @option{-hdc} and 1145824d651Sblueswir1@option{-cdrom} at the same time). You can use the host CD-ROM by 1155824d651Sblueswir1using @file{/dev/cdrom} as filename (@pxref{host_drives}). 1165824d651Sblueswir1ETEXI 1175824d651Sblueswir1 1185824d651Sblueswir1DEF("drive", HAS_ARG, QEMU_OPTION_drive, 1195824d651Sblueswir1 "-drive [file=file][,if=type][,bus=n][,unit=m][,media=d][,index=i]\n" 1205824d651Sblueswir1 " [,cyls=c,heads=h,secs=s[,trans=t]][,snapshot=on|off]\n" 1216c6b6ba2SBruce Rogers " [,cache=writethrough|writeback|none|unsafe][,format=f]\n" 122016f5cf6SAlexander Graf " [,serial=s][,addr=A][,id=name][,aio=threads|native]\n" 123016f5cf6SAlexander Graf " [,readonly=on|off]\n" 124ad96090aSBlue Swirl " use 'file' as a drive image\n", QEMU_ARCH_ALL) 1255824d651Sblueswir1STEXI 1265824d651Sblueswir1@item -drive @var{option}[,@var{option}[,@var{option}[,...]]] 1276616b2adSStefan Weil@findex -drive 1285824d651Sblueswir1 1295824d651Sblueswir1Define a new drive. Valid options are: 1305824d651Sblueswir1 131b3f046c2SKevin Wolf@table @option 1325824d651Sblueswir1@item file=@var{file} 1335824d651Sblueswir1This option defines which disk image (@pxref{disk_images}) to use with 1345824d651Sblueswir1this drive. If the filename contains comma, you must double it 1355824d651Sblueswir1(for instance, "file=my,,file" to use file "my,file"). 1365824d651Sblueswir1@item if=@var{interface} 1375824d651Sblueswir1This option defines on which type on interface the drive is connected. 1385824d651Sblueswir1Available types are: ide, scsi, sd, mtd, floppy, pflash, virtio. 1395824d651Sblueswir1@item bus=@var{bus},unit=@var{unit} 1405824d651Sblueswir1These options define where is connected the drive by defining the bus number and 1415824d651Sblueswir1the unit id. 1425824d651Sblueswir1@item index=@var{index} 1435824d651Sblueswir1This option defines where is connected the drive by using an index in the list 1445824d651Sblueswir1of available connectors of a given interface type. 1455824d651Sblueswir1@item media=@var{media} 1465824d651Sblueswir1This option defines the type of the media: disk or cdrom. 1475824d651Sblueswir1@item cyls=@var{c},heads=@var{h},secs=@var{s}[,trans=@var{t}] 1485824d651Sblueswir1These options have the same definition as they have in @option{-hdachs}. 1495824d651Sblueswir1@item snapshot=@var{snapshot} 1505824d651Sblueswir1@var{snapshot} is "on" or "off" and allows to enable snapshot for given drive (see @option{-snapshot}). 1515824d651Sblueswir1@item cache=@var{cache} 152016f5cf6SAlexander Graf@var{cache} is "none", "writeback", "unsafe", or "writethrough" and controls how the host cache is used to access block data. 1535c6c3a6cSChristoph Hellwig@item aio=@var{aio} 1545c6c3a6cSChristoph Hellwig@var{aio} is "threads", or "native" and selects between pthread based disk I/O and native Linux AIO. 1555824d651Sblueswir1@item format=@var{format} 1565824d651Sblueswir1Specify which disk @var{format} will be used rather than detecting 1575824d651Sblueswir1the format. Can be used to specifiy format=raw to avoid interpreting 1585824d651Sblueswir1an untrusted format header. 1595824d651Sblueswir1@item serial=@var{serial} 1605824d651Sblueswir1This option specifies the serial number to assign to the device. 161c2cc47a4SMarkus Armbruster@item addr=@var{addr} 162c2cc47a4SMarkus ArmbrusterSpecify the controller's PCI address (if=virtio only). 1635824d651Sblueswir1@end table 1645824d651Sblueswir1 1655824d651Sblueswir1By default, writethrough caching is used for all block device. This means that 1665824d651Sblueswir1the host page cache will be used to read and write data but write notification 1675824d651Sblueswir1will be sent to the guest only when the data has been reported as written by 1685824d651Sblueswir1the storage subsystem. 1695824d651Sblueswir1 1705824d651Sblueswir1Writeback caching will report data writes as completed as soon as the data is 1715824d651Sblueswir1present in the host page cache. This is safe as long as you trust your host. 1725824d651Sblueswir1If your host crashes or loses power, then the guest may experience data 173c3177288SAlexander Grafcorruption. 1745824d651Sblueswir1 175c304d317SAurelien JarnoThe host page cache can be avoided entirely with @option{cache=none}. This will 1765824d651Sblueswir1attempt to do disk IO directly to the guests memory. QEMU may still perform 1775824d651Sblueswir1an internal copy of the data. 1785824d651Sblueswir1 1795824d651Sblueswir1Some block drivers perform badly with @option{cache=writethrough}, most notably, 1805824d651Sblueswir1qcow2. If performance is more important than correctness, 1810aa217e4SKevin Wolf@option{cache=writeback} should be used with qcow2. 1825824d651Sblueswir1 183016f5cf6SAlexander GrafIn case you don't care about data integrity over host failures, use 184016f5cf6SAlexander Grafcache=unsafe. This option tells qemu that it never needs to write any data 185016f5cf6SAlexander Grafto the disk but can instead keeps things in cache. If anything goes wrong, 186016f5cf6SAlexander Graflike your host losing power, the disk storage getting disconnected accidently, 187c3177288SAlexander Grafetc. you're image will most probably be rendered unusable. When using 188c3177288SAlexander Grafthe @option{-snapshot} option, unsafe caching is always used. 189016f5cf6SAlexander Graf 1905824d651Sblueswir1Instead of @option{-cdrom} you can use: 1915824d651Sblueswir1@example 1925824d651Sblueswir1qemu -drive file=file,index=2,media=cdrom 1935824d651Sblueswir1@end example 1945824d651Sblueswir1 1955824d651Sblueswir1Instead of @option{-hda}, @option{-hdb}, @option{-hdc}, @option{-hdd}, you can 1965824d651Sblueswir1use: 1975824d651Sblueswir1@example 1985824d651Sblueswir1qemu -drive file=file,index=0,media=disk 1995824d651Sblueswir1qemu -drive file=file,index=1,media=disk 2005824d651Sblueswir1qemu -drive file=file,index=2,media=disk 2015824d651Sblueswir1qemu -drive file=file,index=3,media=disk 2025824d651Sblueswir1@end example 2035824d651Sblueswir1 2045824d651Sblueswir1You can connect a CDROM to the slave of ide0: 2055824d651Sblueswir1@example 2065824d651Sblueswir1qemu -drive file=file,if=ide,index=1,media=cdrom 2075824d651Sblueswir1@end example 2085824d651Sblueswir1 2095824d651Sblueswir1If you don't specify the "file=" argument, you define an empty drive: 2105824d651Sblueswir1@example 2115824d651Sblueswir1qemu -drive if=ide,index=1,media=cdrom 2125824d651Sblueswir1@end example 2135824d651Sblueswir1 2145824d651Sblueswir1You can connect a SCSI disk with unit ID 6 on the bus #0: 2155824d651Sblueswir1@example 2165824d651Sblueswir1qemu -drive file=file,if=scsi,bus=0,unit=6 2175824d651Sblueswir1@end example 2185824d651Sblueswir1 2195824d651Sblueswir1Instead of @option{-fda}, @option{-fdb}, you can use: 2205824d651Sblueswir1@example 2215824d651Sblueswir1qemu -drive file=file,index=0,if=floppy 2225824d651Sblueswir1qemu -drive file=file,index=1,if=floppy 2235824d651Sblueswir1@end example 2245824d651Sblueswir1 2255824d651Sblueswir1By default, @var{interface} is "ide" and @var{index} is automatically 2265824d651Sblueswir1incremented: 2275824d651Sblueswir1@example 2285824d651Sblueswir1qemu -drive file=a -drive file=b" 2295824d651Sblueswir1@end example 2305824d651Sblueswir1is interpreted like: 2315824d651Sblueswir1@example 2325824d651Sblueswir1qemu -hda a -hdb b 2335824d651Sblueswir1@end example 2345824d651Sblueswir1ETEXI 2355824d651Sblueswir1 2366616b2adSStefan WeilDEF("set", HAS_ARG, QEMU_OPTION_set, 2376616b2adSStefan Weil "-set group.id.arg=value\n" 2386616b2adSStefan Weil " set <arg> parameter for item <id> of type <group>\n" 239ad96090aSBlue Swirl " i.e. -set drive.$id.file=/path/to/image\n", QEMU_ARCH_ALL) 2406616b2adSStefan WeilSTEXI 2416616b2adSStefan Weil@item -set 2426616b2adSStefan Weil@findex -set 2436616b2adSStefan WeilTODO 2446616b2adSStefan WeilETEXI 2456616b2adSStefan Weil 2466616b2adSStefan WeilDEF("global", HAS_ARG, QEMU_OPTION_global, 2476616b2adSStefan Weil "-global driver.property=value\n" 248ad96090aSBlue Swirl " set a global default for a driver property\n", 249ad96090aSBlue Swirl QEMU_ARCH_ALL) 2506616b2adSStefan WeilSTEXI 2516616b2adSStefan Weil@item -global 2526616b2adSStefan Weil@findex -global 2536616b2adSStefan WeilTODO 2546616b2adSStefan WeilETEXI 2556616b2adSStefan Weil 2565824d651Sblueswir1DEF("mtdblock", HAS_ARG, QEMU_OPTION_mtdblock, 257ad96090aSBlue Swirl "-mtdblock file use 'file' as on-board Flash memory image\n", 258ad96090aSBlue Swirl QEMU_ARCH_ALL) 2595824d651Sblueswir1STEXI 2604e257e5eSKevin Wolf@item -mtdblock @var{file} 2616616b2adSStefan Weil@findex -mtdblock 2624e257e5eSKevin WolfUse @var{file} as on-board Flash memory image. 2635824d651Sblueswir1ETEXI 2645824d651Sblueswir1 2655824d651Sblueswir1DEF("sd", HAS_ARG, QEMU_OPTION_sd, 266ad96090aSBlue Swirl "-sd file use 'file' as SecureDigital card image\n", QEMU_ARCH_ALL) 2675824d651Sblueswir1STEXI 2684e257e5eSKevin Wolf@item -sd @var{file} 2696616b2adSStefan Weil@findex -sd 2704e257e5eSKevin WolfUse @var{file} as SecureDigital card image. 2715824d651Sblueswir1ETEXI 2725824d651Sblueswir1 2735824d651Sblueswir1DEF("pflash", HAS_ARG, QEMU_OPTION_pflash, 274ad96090aSBlue Swirl "-pflash file use 'file' as a parallel flash image\n", QEMU_ARCH_ALL) 2755824d651Sblueswir1STEXI 2764e257e5eSKevin Wolf@item -pflash @var{file} 2776616b2adSStefan Weil@findex -pflash 2784e257e5eSKevin WolfUse @var{file} as a parallel flash image. 2795824d651Sblueswir1ETEXI 2805824d651Sblueswir1 2815824d651Sblueswir1DEF("boot", HAS_ARG, QEMU_OPTION_boot, 2822221dde5SJan Kiszka "-boot [order=drives][,once=drives][,menu=on|off]\n" 283ad96090aSBlue Swirl " 'drives': floppy (a), hard disk (c), CD-ROM (d), network (n)\n", 284ad96090aSBlue Swirl QEMU_ARCH_ALL) 2855824d651Sblueswir1STEXI 2862221dde5SJan Kiszka@item -boot [order=@var{drives}][,once=@var{drives}][,menu=on|off] 2876616b2adSStefan Weil@findex -boot 2882221dde5SJan KiszkaSpecify boot order @var{drives} as a string of drive letters. Valid 2892221dde5SJan Kiszkadrive letters depend on the target achitecture. The x86 PC uses: a, b 2902221dde5SJan Kiszka(floppy 1 and 2), c (first hard disk), d (first CD-ROM), n-p (Etherboot 2912221dde5SJan Kiszkafrom network adapter 1-4), hard disk boot is the default. To apply a 2922221dde5SJan Kiszkaparticular boot order only on the first startup, specify it via 2932221dde5SJan Kiszka@option{once}. 2942221dde5SJan Kiszka 2952221dde5SJan KiszkaInteractive boot menus/prompts can be enabled via @option{menu=on} as far 2962221dde5SJan Kiszkaas firmware/BIOS supports them. The default is non-interactive boot. 2972221dde5SJan Kiszka 2982221dde5SJan Kiszka@example 2992221dde5SJan Kiszka# try to boot from network first, then from hard disk 3002221dde5SJan Kiszkaqemu -boot order=nc 3012221dde5SJan Kiszka# boot from CD-ROM first, switch back to default order after reboot 3022221dde5SJan Kiszkaqemu -boot once=d 3032221dde5SJan Kiszka@end example 3042221dde5SJan Kiszka 3052221dde5SJan KiszkaNote: The legacy format '-boot @var{drives}' is still supported but its 3062221dde5SJan Kiszkause is discouraged as it may be removed from future versions. 3075824d651Sblueswir1ETEXI 3085824d651Sblueswir1 3095824d651Sblueswir1DEF("snapshot", 0, QEMU_OPTION_snapshot, 310ad96090aSBlue Swirl "-snapshot write to temporary files instead of disk image files\n", 311ad96090aSBlue Swirl QEMU_ARCH_ALL) 3125824d651Sblueswir1STEXI 3135824d651Sblueswir1@item -snapshot 3146616b2adSStefan Weil@findex -snapshot 3155824d651Sblueswir1Write to temporary files instead of disk image files. In this case, 3165824d651Sblueswir1the raw disk image you use is not written back. You can however force 3175824d651Sblueswir1the write back by pressing @key{C-a s} (@pxref{disk_images}). 3185824d651Sblueswir1ETEXI 3195824d651Sblueswir1 3205824d651Sblueswir1DEF("m", HAS_ARG, QEMU_OPTION_m, 321bec7c2d4SPaolo Bonzini "-m megs set virtual RAM size to megs MB [default=" 322ad96090aSBlue Swirl stringify(DEFAULT_RAM_SIZE) "]\n", QEMU_ARCH_ALL) 3235824d651Sblueswir1STEXI 3245824d651Sblueswir1@item -m @var{megs} 3256616b2adSStefan Weil@findex -m 3265824d651Sblueswir1Set virtual RAM size to @var{megs} megabytes. Default is 128 MiB. Optionally, 3275824d651Sblueswir1a suffix of ``M'' or ``G'' can be used to signify a value in megabytes or 3285824d651Sblueswir1gigabytes respectively. 3295824d651Sblueswir1ETEXI 3305824d651Sblueswir1 331c902760fSMarcelo TosattiDEF("mem-path", HAS_ARG, QEMU_OPTION_mempath, 332ad96090aSBlue Swirl "-mem-path FILE provide backing storage for guest RAM\n", QEMU_ARCH_ALL) 333c902760fSMarcelo TosattiSTEXI 334c902760fSMarcelo Tosatti@item -mem-path @var{path} 335c902760fSMarcelo TosattiAllocate guest RAM from a temporarily created file in @var{path}. 336c902760fSMarcelo TosattiETEXI 337c902760fSMarcelo Tosatti 338c902760fSMarcelo Tosatti#ifdef MAP_POPULATE 339c902760fSMarcelo TosattiDEF("mem-prealloc", 0, QEMU_OPTION_mem_prealloc, 340ad96090aSBlue Swirl "-mem-prealloc preallocate guest memory (use with -mem-path)\n", 341ad96090aSBlue Swirl QEMU_ARCH_ALL) 342c902760fSMarcelo TosattiSTEXI 343c902760fSMarcelo Tosatti@item -mem-prealloc 344c902760fSMarcelo TosattiPreallocate memory when using -mem-path. 345c902760fSMarcelo TosattiETEXI 346c902760fSMarcelo Tosatti#endif 347c902760fSMarcelo Tosatti 3485824d651Sblueswir1DEF("k", HAS_ARG, QEMU_OPTION_k, 349ad96090aSBlue Swirl "-k language use keyboard layout (for example 'fr' for French)\n", 350ad96090aSBlue Swirl QEMU_ARCH_ALL) 3515824d651Sblueswir1STEXI 3525824d651Sblueswir1@item -k @var{language} 3536616b2adSStefan Weil@findex -k 3545824d651Sblueswir1Use keyboard layout @var{language} (for example @code{fr} for 3555824d651Sblueswir1French). This option is only needed where it is not easy to get raw PC 3565824d651Sblueswir1keycodes (e.g. on Macs, with some X11 servers or with a VNC 3575824d651Sblueswir1display). You don't normally need to use it on PC/Linux or PC/Windows 3585824d651Sblueswir1hosts. 3595824d651Sblueswir1 3605824d651Sblueswir1The available layouts are: 3615824d651Sblueswir1@example 3625824d651Sblueswir1ar de-ch es fo fr-ca hu ja mk no pt-br sv 3635824d651Sblueswir1da en-gb et fr fr-ch is lt nl pl ru th 3645824d651Sblueswir1de en-us fi fr-be hr it lv nl-be pt sl tr 3655824d651Sblueswir1@end example 3665824d651Sblueswir1 3675824d651Sblueswir1The default is @code{en-us}. 3685824d651Sblueswir1ETEXI 3695824d651Sblueswir1 3705824d651Sblueswir1 3715824d651Sblueswir1DEF("audio-help", 0, QEMU_OPTION_audio_help, 372ad96090aSBlue Swirl "-audio-help print list of audio drivers and their options\n", 373ad96090aSBlue Swirl QEMU_ARCH_ALL) 3745824d651Sblueswir1STEXI 3755824d651Sblueswir1@item -audio-help 3766616b2adSStefan Weil@findex -audio-help 3775824d651Sblueswir1Will show the audio subsystem help: list of drivers, tunable 3785824d651Sblueswir1parameters. 3795824d651Sblueswir1ETEXI 3805824d651Sblueswir1 3815824d651Sblueswir1DEF("soundhw", HAS_ARG, QEMU_OPTION_soundhw, 3825824d651Sblueswir1 "-soundhw c1,... enable audio support\n" 3835824d651Sblueswir1 " and only specified sound cards (comma separated list)\n" 3845824d651Sblueswir1 " use -soundhw ? to get the list of supported cards\n" 385ad96090aSBlue Swirl " use -soundhw all to enable all of them\n", QEMU_ARCH_ALL) 3865824d651Sblueswir1STEXI 3875824d651Sblueswir1@item -soundhw @var{card1}[,@var{card2},...] or -soundhw all 3886616b2adSStefan Weil@findex -soundhw 3895824d651Sblueswir1Enable audio and selected sound hardware. Use ? to print all 3905824d651Sblueswir1available sound hardware. 3915824d651Sblueswir1 3925824d651Sblueswir1@example 3935824d651Sblueswir1qemu -soundhw sb16,adlib disk.img 3945824d651Sblueswir1qemu -soundhw es1370 disk.img 3955824d651Sblueswir1qemu -soundhw ac97 disk.img 3967d72e762SGerd Hoffmannqemu -soundhw hda disk.img 3975824d651Sblueswir1qemu -soundhw all disk.img 3985824d651Sblueswir1qemu -soundhw ? 3995824d651Sblueswir1@end example 4005824d651Sblueswir1 4015824d651Sblueswir1Note that Linux's i810_audio OSS kernel (for AC97) module might 4025824d651Sblueswir1require manually specifying clocking. 4035824d651Sblueswir1 4045824d651Sblueswir1@example 4055824d651Sblueswir1modprobe i810_audio clocking=48000 4065824d651Sblueswir1@end example 4075824d651Sblueswir1ETEXI 4085824d651Sblueswir1 4095824d651Sblueswir1STEXI 4105824d651Sblueswir1@end table 4115824d651Sblueswir1ETEXI 4125824d651Sblueswir1 4135824d651Sblueswir1DEF("usb", 0, QEMU_OPTION_usb, 414ad96090aSBlue Swirl "-usb enable the USB driver (will be the default soon)\n", 415ad96090aSBlue Swirl QEMU_ARCH_ALL) 4165824d651Sblueswir1STEXI 4175824d651Sblueswir1USB options: 4185824d651Sblueswir1@table @option 4195824d651Sblueswir1 4205824d651Sblueswir1@item -usb 4216616b2adSStefan Weil@findex -usb 4225824d651Sblueswir1Enable the USB driver (will be the default soon) 4235824d651Sblueswir1ETEXI 4245824d651Sblueswir1 4255824d651Sblueswir1DEF("usbdevice", HAS_ARG, QEMU_OPTION_usbdevice, 426ad96090aSBlue Swirl "-usbdevice name add the host or guest USB device 'name'\n", 427ad96090aSBlue Swirl QEMU_ARCH_ALL) 4285824d651Sblueswir1STEXI 4295824d651Sblueswir1 4305824d651Sblueswir1@item -usbdevice @var{devname} 4316616b2adSStefan Weil@findex -usbdevice 4325824d651Sblueswir1Add the USB device @var{devname}. @xref{usb_devices}. 4335824d651Sblueswir1 434b3f046c2SKevin Wolf@table @option 4355824d651Sblueswir1 4365824d651Sblueswir1@item mouse 4375824d651Sblueswir1Virtual Mouse. This will override the PS/2 mouse emulation when activated. 4385824d651Sblueswir1 4395824d651Sblueswir1@item tablet 4405824d651Sblueswir1Pointer device that uses absolute coordinates (like a touchscreen). This 4415824d651Sblueswir1means qemu is able to report the mouse position without having to grab the 4425824d651Sblueswir1mouse. Also overrides the PS/2 mouse emulation when activated. 4435824d651Sblueswir1 4444e257e5eSKevin Wolf@item disk:[format=@var{format}]:@var{file} 4455824d651Sblueswir1Mass storage device based on file. The optional @var{format} argument 4465824d651Sblueswir1will be used rather than detecting the format. Can be used to specifiy 4474e257e5eSKevin Wolf@code{format=raw} to avoid interpreting an untrusted format header. 4485824d651Sblueswir1 4494e257e5eSKevin Wolf@item host:@var{bus}.@var{addr} 4504e257e5eSKevin WolfPass through the host device identified by @var{bus}.@var{addr} (Linux only). 4515824d651Sblueswir1 4524e257e5eSKevin Wolf@item host:@var{vendor_id}:@var{product_id} 4534e257e5eSKevin WolfPass through the host device identified by @var{vendor_id}:@var{product_id} 4544e257e5eSKevin Wolf(Linux only). 4555824d651Sblueswir1 4565824d651Sblueswir1@item serial:[vendorid=@var{vendor_id}][,productid=@var{product_id}]:@var{dev} 4575824d651Sblueswir1Serial converter to host character device @var{dev}, see @code{-serial} for the 4585824d651Sblueswir1available devices. 4595824d651Sblueswir1 4605824d651Sblueswir1@item braille 4615824d651Sblueswir1Braille device. This will use BrlAPI to display the braille output on a real 4625824d651Sblueswir1or fake device. 4635824d651Sblueswir1 4644e257e5eSKevin Wolf@item net:@var{options} 4655824d651Sblueswir1Network adapter that supports CDC ethernet and RNDIS protocols. 4665824d651Sblueswir1 4675824d651Sblueswir1@end table 4685824d651Sblueswir1ETEXI 4695824d651Sblueswir1 470bd3c948dSGerd HoffmannDEF("device", HAS_ARG, QEMU_OPTION_device, 47140ea285cSMarkus Armbruster "-device driver[,prop[=value][,...]]\n" 47240ea285cSMarkus Armbruster " add device (based on driver)\n" 47340ea285cSMarkus Armbruster " prop=value,... sets driver properties\n" 47469a319d1SStefan Weil " use -device ? to print all possible drivers\n" 4759848bbf1SMarkus Armbruster " use -device driver,? to print all possible properties\n", 476ad96090aSBlue Swirl QEMU_ARCH_ALL) 4773dbf2c7fSStefan WeilSTEXI 4789848bbf1SMarkus Armbruster@item -device @var{driver}[,@var{prop}[=@var{value}][,...]] 4796616b2adSStefan Weil@findex -device 4809848bbf1SMarkus ArmbrusterAdd device @var{driver}. @var{prop}=@var{value} sets driver 4819848bbf1SMarkus Armbrusterproperties. Valid properties depend on the driver. To get help on 4829848bbf1SMarkus Armbrusterpossible drivers and properties, use @code{-device ?} and 4839848bbf1SMarkus Armbruster@code{-device @var{driver},?}. 4843dbf2c7fSStefan WeilETEXI 4853dbf2c7fSStefan Weil 48674db920cSGautham R ShenoyDEFHEADING(File system options:) 48774db920cSGautham R Shenoy 48874db920cSGautham R ShenoyDEF("fsdev", HAS_ARG, QEMU_OPTION_fsdev, 48912848bfcSAneesh Kumar K.V "-fsdev local,id=id,path=path,security_model=[mapped|passthrough|none]\n", 49074db920cSGautham R Shenoy QEMU_ARCH_ALL) 49174db920cSGautham R Shenoy 49274db920cSGautham R ShenoySTEXI 49374db920cSGautham R Shenoy 49474db920cSGautham R ShenoyThe general form of a File system device option is: 49574db920cSGautham R Shenoy@table @option 49674db920cSGautham R Shenoy 49774db920cSGautham R Shenoy@item -fsdev @var{fstype} ,id=@var{id} [,@var{options}] 49874db920cSGautham R Shenoy@findex -fsdev 49974db920cSGautham R ShenoyFstype is one of: 50074db920cSGautham R Shenoy@option{local}, 50174db920cSGautham R ShenoyThe specific Fstype will determine the applicable options. 50274db920cSGautham R Shenoy 50374db920cSGautham R ShenoyOptions to each backend are described below. 50474db920cSGautham R Shenoy 5059ce56db6SVenkateswararao Jujjuri (JV)@item -fsdev local ,id=@var{id} ,path=@var{path} ,security_model=@var{security_model} 50674db920cSGautham R Shenoy 50774db920cSGautham R ShenoyCreate a file-system-"device" for local-filesystem. 50874db920cSGautham R Shenoy 50974db920cSGautham R Shenoy@option{local} is only available on Linux. 51074db920cSGautham R Shenoy 51174db920cSGautham R Shenoy@option{path} specifies the path to be exported. @option{path} is required. 51274db920cSGautham R Shenoy 5139ce56db6SVenkateswararao Jujjuri (JV)@option{security_model} specifies the security model to be followed. 5149ce56db6SVenkateswararao Jujjuri (JV)@option{security_model} is required. 5159ce56db6SVenkateswararao Jujjuri (JV) 51674db920cSGautham R Shenoy@end table 51774db920cSGautham R ShenoyETEXI 51874db920cSGautham R Shenoy 5193d54abc7SGautham R ShenoyDEFHEADING(Virtual File system pass-through options:) 5203d54abc7SGautham R Shenoy 5213d54abc7SGautham R ShenoyDEF("virtfs", HAS_ARG, QEMU_OPTION_virtfs, 52212848bfcSAneesh Kumar K.V "-virtfs local,path=path,mount_tag=tag,security_model=[mapped|passthrough|none]\n", 5233d54abc7SGautham R Shenoy QEMU_ARCH_ALL) 5243d54abc7SGautham R Shenoy 5253d54abc7SGautham R ShenoySTEXI 5263d54abc7SGautham R Shenoy 5273d54abc7SGautham R ShenoyThe general form of a Virtual File system pass-through option is: 5283d54abc7SGautham R Shenoy@table @option 5293d54abc7SGautham R Shenoy 5303d54abc7SGautham R Shenoy@item -virtfs @var{fstype} [,@var{options}] 5313d54abc7SGautham R Shenoy@findex -virtfs 5323d54abc7SGautham R ShenoyFstype is one of: 5333d54abc7SGautham R Shenoy@option{local}, 5343d54abc7SGautham R ShenoyThe specific Fstype will determine the applicable options. 5353d54abc7SGautham R Shenoy 5363d54abc7SGautham R ShenoyOptions to each backend are described below. 5373d54abc7SGautham R Shenoy 5389ce56db6SVenkateswararao Jujjuri (JV)@item -virtfs local ,path=@var{path} ,mount_tag=@var{mount_tag} ,security_model=@var{security_model} 5393d54abc7SGautham R Shenoy 5403d54abc7SGautham R ShenoyCreate a Virtual file-system-pass through for local-filesystem. 5413d54abc7SGautham R Shenoy 5423d54abc7SGautham R Shenoy@option{local} is only available on Linux. 5433d54abc7SGautham R Shenoy 5443d54abc7SGautham R Shenoy@option{path} specifies the path to be exported. @option{path} is required. 5453d54abc7SGautham R Shenoy 5469ce56db6SVenkateswararao Jujjuri (JV)@option{security_model} specifies the security model to be followed. 5479ce56db6SVenkateswararao Jujjuri (JV)@option{security_model} is required. 5489ce56db6SVenkateswararao Jujjuri (JV) 5499ce56db6SVenkateswararao Jujjuri (JV) 5503d54abc7SGautham R Shenoy@option{mount_tag} specifies the tag with which the exported file is mounted. 5513d54abc7SGautham R Shenoy@option{mount_tag} is required. 5523d54abc7SGautham R Shenoy 5533d54abc7SGautham R Shenoy@end table 5543d54abc7SGautham R ShenoyETEXI 5553d54abc7SGautham R Shenoy 55674db920cSGautham R ShenoyDEFHEADING() 55774db920cSGautham R Shenoy 5585824d651Sblueswir1DEF("name", HAS_ARG, QEMU_OPTION_name, 559ca1a8a06SBruce Rogers "-name string1[,process=string2]\n" 560ca1a8a06SBruce Rogers " set the name of the guest\n" 561ad96090aSBlue Swirl " string1 sets the window title and string2 the process name (on Linux)\n", 562ad96090aSBlue Swirl QEMU_ARCH_ALL) 5635824d651Sblueswir1STEXI 5645824d651Sblueswir1@item -name @var{name} 5656616b2adSStefan Weil@findex -name 5665824d651Sblueswir1Sets the @var{name} of the guest. 5675824d651Sblueswir1This name will be displayed in the SDL window caption. 5685824d651Sblueswir1The @var{name} will also be used for the VNC server. 5691889465aSAndi KleenAlso optionally set the top visible process name in Linux. 5705824d651Sblueswir1ETEXI 5715824d651Sblueswir1 5725824d651Sblueswir1DEF("uuid", HAS_ARG, QEMU_OPTION_uuid, 573e8105ebbSPaolo Bonzini "-uuid %08x-%04x-%04x-%04x-%012x\n" 574ad96090aSBlue Swirl " specify machine UUID\n", QEMU_ARCH_ALL) 5755824d651Sblueswir1STEXI 5765824d651Sblueswir1@item -uuid @var{uuid} 5776616b2adSStefan Weil@findex -uuid 5785824d651Sblueswir1Set system UUID. 5795824d651Sblueswir1ETEXI 5805824d651Sblueswir1 5815824d651Sblueswir1STEXI 5825824d651Sblueswir1@end table 5835824d651Sblueswir1ETEXI 5845824d651Sblueswir1 5855824d651Sblueswir1DEFHEADING() 5865824d651Sblueswir1 5875824d651Sblueswir1DEFHEADING(Display options:) 5885824d651Sblueswir1 5895824d651Sblueswir1STEXI 5905824d651Sblueswir1@table @option 5915824d651Sblueswir1ETEXI 5925824d651Sblueswir1 5931472a95bSJes SorensenDEF("display", HAS_ARG, QEMU_OPTION_display, 5941472a95bSJes Sorensen "-display sdl[,frame=on|off][,alt_grab=on|off][,ctrl_grab=on|off]\n" 5953264ff12SJes Sorensen " [,window_close=on|off]|curses|none|\n" 5963264ff12SJes Sorensen " vnc=<display>[,<optargs>]\n" 5971472a95bSJes Sorensen " select display type\n", QEMU_ARCH_ALL) 5981472a95bSJes SorensenSTEXI 5991472a95bSJes Sorensen@item -display @var{type} 6001472a95bSJes Sorensen@findex -display 6011472a95bSJes SorensenSelect type of display to use. This option is a replacement for the 6021472a95bSJes Sorensenold style -sdl/-curses/... options. Valid values for @var{type} are 6031472a95bSJes Sorensen@table @option 6041472a95bSJes Sorensen@item sdl 6051472a95bSJes SorensenDisplay video output via SDL (usually in a separate graphics 6061472a95bSJes Sorensenwindow; see the SDL documentation for other possibilities). 6071472a95bSJes Sorensen@item curses 6081472a95bSJes SorensenDisplay video output via curses. For graphics device models which 6091472a95bSJes Sorensensupport a text mode, QEMU can display this output using a 6101472a95bSJes Sorensencurses/ncurses interface. Nothing is displayed when the graphics 6111472a95bSJes Sorensendevice is in graphical mode or if the graphics device does not support 6121472a95bSJes Sorensena text mode. Generally only the VGA device models support text mode. 6134171d32eSJes Sorensen@item none 6144171d32eSJes SorensenDo not display video output. The guest will still see an emulated 6154171d32eSJes Sorensengraphics card, but its output will not be displayed to the QEMU 6164171d32eSJes Sorensenuser. This option differs from the -nographic option in that it 6174171d32eSJes Sorensenonly affects what is done with video output; -nographic also changes 6184171d32eSJes Sorensenthe destination of the serial and parallel port data. 6193264ff12SJes Sorensen@item vnc 6203264ff12SJes SorensenStart a VNC server on display <arg> 6211472a95bSJes Sorensen@end table 6221472a95bSJes SorensenETEXI 6231472a95bSJes Sorensen 6245824d651Sblueswir1DEF("nographic", 0, QEMU_OPTION_nographic, 625ad96090aSBlue Swirl "-nographic disable graphical output and redirect serial I/Os to console\n", 626ad96090aSBlue Swirl QEMU_ARCH_ALL) 6275824d651Sblueswir1STEXI 6285824d651Sblueswir1@item -nographic 6296616b2adSStefan Weil@findex -nographic 6305824d651Sblueswir1Normally, QEMU uses SDL to display the VGA output. With this option, 6315824d651Sblueswir1you can totally disable graphical output so that QEMU is a simple 6325824d651Sblueswir1command line application. The emulated serial port is redirected on 6335824d651Sblueswir1the console. Therefore, you can still use QEMU to debug a Linux kernel 6345824d651Sblueswir1with a serial console. 6355824d651Sblueswir1ETEXI 6365824d651Sblueswir1 6375824d651Sblueswir1DEF("curses", 0, QEMU_OPTION_curses, 638ad96090aSBlue Swirl "-curses use a curses/ncurses interface instead of SDL\n", 639ad96090aSBlue Swirl QEMU_ARCH_ALL) 6405824d651Sblueswir1STEXI 6415824d651Sblueswir1@item -curses 6426616b2adSStefan Weil@findex curses 6435824d651Sblueswir1Normally, QEMU uses SDL to display the VGA output. With this option, 6445824d651Sblueswir1QEMU can display the VGA output when in text mode using a 6455824d651Sblueswir1curses/ncurses interface. Nothing is displayed in graphical mode. 6465824d651Sblueswir1ETEXI 6475824d651Sblueswir1 6485824d651Sblueswir1DEF("no-frame", 0, QEMU_OPTION_no_frame, 649ad96090aSBlue Swirl "-no-frame open SDL window without a frame and window decorations\n", 650ad96090aSBlue Swirl QEMU_ARCH_ALL) 6515824d651Sblueswir1STEXI 6525824d651Sblueswir1@item -no-frame 6536616b2adSStefan Weil@findex -no-frame 6545824d651Sblueswir1Do not use decorations for SDL windows and start them using the whole 6555824d651Sblueswir1available screen space. This makes the using QEMU in a dedicated desktop 6565824d651Sblueswir1workspace more convenient. 6575824d651Sblueswir1ETEXI 6585824d651Sblueswir1 6595824d651Sblueswir1DEF("alt-grab", 0, QEMU_OPTION_alt_grab, 660ad96090aSBlue Swirl "-alt-grab use Ctrl-Alt-Shift to grab mouse (instead of Ctrl-Alt)\n", 661ad96090aSBlue Swirl QEMU_ARCH_ALL) 6625824d651Sblueswir1STEXI 6635824d651Sblueswir1@item -alt-grab 6646616b2adSStefan Weil@findex -alt-grab 6655824d651Sblueswir1Use Ctrl-Alt-Shift to grab mouse (instead of Ctrl-Alt). 6665824d651Sblueswir1ETEXI 6675824d651Sblueswir1 6680ca9f8a4SDustin KirklandDEF("ctrl-grab", 0, QEMU_OPTION_ctrl_grab, 669ad96090aSBlue Swirl "-ctrl-grab use Right-Ctrl to grab mouse (instead of Ctrl-Alt)\n", 670ad96090aSBlue Swirl QEMU_ARCH_ALL) 6710ca9f8a4SDustin KirklandSTEXI 6720ca9f8a4SDustin Kirkland@item -ctrl-grab 6736616b2adSStefan Weil@findex -ctrl-grab 6740ca9f8a4SDustin KirklandUse Right-Ctrl to grab mouse (instead of Ctrl-Alt). 6750ca9f8a4SDustin KirklandETEXI 6760ca9f8a4SDustin Kirkland 6775824d651Sblueswir1DEF("no-quit", 0, QEMU_OPTION_no_quit, 678ad96090aSBlue Swirl "-no-quit disable SDL window close capability\n", QEMU_ARCH_ALL) 6795824d651Sblueswir1STEXI 6805824d651Sblueswir1@item -no-quit 6816616b2adSStefan Weil@findex -no-quit 6825824d651Sblueswir1Disable SDL window close capability. 6835824d651Sblueswir1ETEXI 6845824d651Sblueswir1 6855824d651Sblueswir1DEF("sdl", 0, QEMU_OPTION_sdl, 686ad96090aSBlue Swirl "-sdl enable SDL\n", QEMU_ARCH_ALL) 6875824d651Sblueswir1STEXI 6885824d651Sblueswir1@item -sdl 6896616b2adSStefan Weil@findex -sdl 6905824d651Sblueswir1Enable SDL. 6915824d651Sblueswir1ETEXI 6925824d651Sblueswir1 69329b0040bSGerd HoffmannDEF("spice", HAS_ARG, QEMU_OPTION_spice, 69429b0040bSGerd Hoffmann "-spice <args> enable spice\n", QEMU_ARCH_ALL) 69529b0040bSGerd HoffmannSTEXI 69629b0040bSGerd Hoffmann@item -spice @var{option}[,@var{option}[,...]] 69729b0040bSGerd Hoffmann@findex -spice 69829b0040bSGerd HoffmannEnable the spice remote desktop protocol. Valid options are 69929b0040bSGerd Hoffmann 70029b0040bSGerd Hoffmann@table @option 70129b0040bSGerd Hoffmann 70229b0040bSGerd Hoffmann@item port=<nr> 703c448e855SGerd HoffmannSet the TCP port spice is listening on for plaintext channels. 70429b0040bSGerd Hoffmann 705333b0eebSGerd Hoffmann@item addr=<addr> 706333b0eebSGerd HoffmannSet the IP address spice is listening on. Default is any address. 707333b0eebSGerd Hoffmann 708333b0eebSGerd Hoffmann@item ipv4 709333b0eebSGerd Hoffmann@item ipv6 710333b0eebSGerd HoffmannForce using the specified IP version. 711333b0eebSGerd Hoffmann 71229b0040bSGerd Hoffmann@item password=<secret> 71329b0040bSGerd HoffmannSet the password you need to authenticate. 71429b0040bSGerd Hoffmann 71529b0040bSGerd Hoffmann@item disable-ticketing 71629b0040bSGerd HoffmannAllow client connects without authentication. 71729b0040bSGerd Hoffmann 718c448e855SGerd Hoffmann@item tls-port=<nr> 719c448e855SGerd HoffmannSet the TCP port spice is listening on for encrypted channels. 720c448e855SGerd Hoffmann 721c448e855SGerd Hoffmann@item x509-dir=<dir> 722c448e855SGerd HoffmannSet the x509 file directory. Expects same filenames as -vnc $display,x509=$dir 723c448e855SGerd Hoffmann 724c448e855SGerd Hoffmann@item x509-key-file=<file> 725c448e855SGerd Hoffmann@item x509-key-password=<file> 726c448e855SGerd Hoffmann@item x509-cert-file=<file> 727c448e855SGerd Hoffmann@item x509-cacert-file=<file> 728c448e855SGerd Hoffmann@item x509-dh-key-file=<file> 729c448e855SGerd HoffmannThe x509 file names can also be configured individually. 730c448e855SGerd Hoffmann 731c448e855SGerd Hoffmann@item tls-ciphers=<list> 732c448e855SGerd HoffmannSpecify which ciphers to use. 733c448e855SGerd Hoffmann 73417b6dea0SGerd Hoffmann@item tls-channel=[main|display|inputs|record|playback|tunnel] 73517b6dea0SGerd Hoffmann@item plaintext-channel=[main|display|inputs|record|playback|tunnel] 73617b6dea0SGerd HoffmannForce specific channel to be used with or without TLS encryption. The 73717b6dea0SGerd Hoffmannoptions can be specified multiple times to configure multiple 73817b6dea0SGerd Hoffmannchannels. The special name "default" can be used to set the default 73917b6dea0SGerd Hoffmannmode. For channels which are not explicitly forced into one mode the 74017b6dea0SGerd Hoffmannspice client is allowed to pick tls/plaintext as he pleases. 74117b6dea0SGerd Hoffmann 7429f04e09eSYonit Halperin@item image-compression=[auto_glz|auto_lz|quic|glz|lz|off] 7439f04e09eSYonit HalperinConfigure image compression (lossless). 7449f04e09eSYonit HalperinDefault is auto_glz. 7459f04e09eSYonit Halperin 7469f04e09eSYonit Halperin@item jpeg-wan-compression=[auto|never|always] 7479f04e09eSYonit Halperin@item zlib-glz-wan-compression=[auto|never|always] 7489f04e09eSYonit HalperinConfigure wan image compression (lossy for slow links). 7499f04e09eSYonit HalperinDefault is auto. 7509f04e09eSYonit Halperin 75184a23f25SGerd Hoffmann@item streaming-video=[off|all|filter] 75284a23f25SGerd HoffmannConfigure video stream detection. Default is filter. 75384a23f25SGerd Hoffmann 75484a23f25SGerd Hoffmann@item agent-mouse=[on|off] 75584a23f25SGerd HoffmannEnable/disable passing mouse events via vdagent. Default is on. 75684a23f25SGerd Hoffmann 75784a23f25SGerd Hoffmann@item playback-compression=[on|off] 75884a23f25SGerd HoffmannEnable/disable audio stream compression (using celt 0.5.1). Default is on. 75984a23f25SGerd Hoffmann 76029b0040bSGerd Hoffmann@end table 76129b0040bSGerd HoffmannETEXI 76229b0040bSGerd Hoffmann 7635824d651Sblueswir1DEF("portrait", 0, QEMU_OPTION_portrait, 764ad96090aSBlue Swirl "-portrait rotate graphical output 90 deg left (only PXA LCD)\n", 765ad96090aSBlue Swirl QEMU_ARCH_ALL) 7665824d651Sblueswir1STEXI 7675824d651Sblueswir1@item -portrait 7686616b2adSStefan Weil@findex -portrait 7695824d651Sblueswir1Rotate graphical output 90 deg left (only PXA LCD). 7705824d651Sblueswir1ETEXI 7715824d651Sblueswir1 7725824d651Sblueswir1DEF("vga", HAS_ARG, QEMU_OPTION_vga, 773a19cbfb3SGerd Hoffmann "-vga [std|cirrus|vmware|qxl|xenfb|none]\n" 774ad96090aSBlue Swirl " select video card type\n", QEMU_ARCH_ALL) 7755824d651Sblueswir1STEXI 7765824d651Sblueswir1@item -vga @var{type} 7776616b2adSStefan Weil@findex -vga 7785824d651Sblueswir1Select type of VGA card to emulate. Valid values for @var{type} are 779b3f046c2SKevin Wolf@table @option 7805824d651Sblueswir1@item cirrus 7815824d651Sblueswir1Cirrus Logic GD5446 Video card. All Windows versions starting from 7825824d651Sblueswir1Windows 95 should recognize and use this graphic card. For optimal 7835824d651Sblueswir1performances, use 16 bit color depth in the guest and the host OS. 7845824d651Sblueswir1(This one is the default) 7855824d651Sblueswir1@item std 7865824d651Sblueswir1Standard VGA card with Bochs VBE extensions. If your guest OS 7875824d651Sblueswir1supports the VESA 2.0 VBE extensions (e.g. Windows XP) and if you want 7885824d651Sblueswir1to use high resolution modes (>= 1280x1024x16) then you should use 7895824d651Sblueswir1this option. 7905824d651Sblueswir1@item vmware 7915824d651Sblueswir1VMWare SVGA-II compatible adapter. Use it if you have sufficiently 7925824d651Sblueswir1recent XFree86/XOrg server or Windows guest with a driver for this 7935824d651Sblueswir1card. 794a19cbfb3SGerd Hoffmann@item qxl 795a19cbfb3SGerd HoffmannQXL paravirtual graphic card. It is VGA compatible (including VESA 796a19cbfb3SGerd Hoffmann2.0 VBE support). Works best with qxl guest drivers installed though. 797a19cbfb3SGerd HoffmannRecommended choice when using the spice protocol. 7985824d651Sblueswir1@item none 7995824d651Sblueswir1Disable VGA card. 8005824d651Sblueswir1@end table 8015824d651Sblueswir1ETEXI 8025824d651Sblueswir1 8035824d651Sblueswir1DEF("full-screen", 0, QEMU_OPTION_full_screen, 804ad96090aSBlue Swirl "-full-screen start in full screen\n", QEMU_ARCH_ALL) 8055824d651Sblueswir1STEXI 8065824d651Sblueswir1@item -full-screen 8076616b2adSStefan Weil@findex -full-screen 8085824d651Sblueswir1Start in full screen. 8095824d651Sblueswir1ETEXI 8105824d651Sblueswir1 8115824d651Sblueswir1DEF("g", 1, QEMU_OPTION_g , 812ad96090aSBlue Swirl "-g WxH[xDEPTH] Set the initial graphical resolution and depth\n", 813ad96090aSBlue Swirl QEMU_ARCH_PPC | QEMU_ARCH_SPARC) 8145824d651Sblueswir1STEXI 81595d5f08bSStefan Weil@item -g @var{width}x@var{height}[x@var{depth}] 8166616b2adSStefan Weil@findex -g 81795d5f08bSStefan WeilSet the initial graphical resolution and depth (PPC, SPARC only). 8185824d651Sblueswir1ETEXI 8195824d651Sblueswir1 8205824d651Sblueswir1DEF("vnc", HAS_ARG, QEMU_OPTION_vnc , 821ad96090aSBlue Swirl "-vnc display start a VNC server on display\n", QEMU_ARCH_ALL) 8225824d651Sblueswir1STEXI 8235824d651Sblueswir1@item -vnc @var{display}[,@var{option}[,@var{option}[,...]]] 8246616b2adSStefan Weil@findex -vnc 8255824d651Sblueswir1Normally, QEMU uses SDL to display the VGA output. With this option, 8265824d651Sblueswir1you can have QEMU listen on VNC display @var{display} and redirect the VGA 8275824d651Sblueswir1display over the VNC session. It is very useful to enable the usb 8285824d651Sblueswir1tablet device when using this option (option @option{-usbdevice 8295824d651Sblueswir1tablet}). When using the VNC display, you must use the @option{-k} 8305824d651Sblueswir1parameter to set the keyboard layout if you are not using en-us. Valid 8315824d651Sblueswir1syntax for the @var{display} is 8325824d651Sblueswir1 833b3f046c2SKevin Wolf@table @option 8345824d651Sblueswir1 8355824d651Sblueswir1@item @var{host}:@var{d} 8365824d651Sblueswir1 8375824d651Sblueswir1TCP connections will only be allowed from @var{host} on display @var{d}. 8385824d651Sblueswir1By convention the TCP port is 5900+@var{d}. Optionally, @var{host} can 8395824d651Sblueswir1be omitted in which case the server will accept connections from any host. 8405824d651Sblueswir1 8414e257e5eSKevin Wolf@item unix:@var{path} 8425824d651Sblueswir1 8435824d651Sblueswir1Connections will be allowed over UNIX domain sockets where @var{path} is the 8445824d651Sblueswir1location of a unix socket to listen for connections on. 8455824d651Sblueswir1 8465824d651Sblueswir1@item none 8475824d651Sblueswir1 8485824d651Sblueswir1VNC is initialized but not started. The monitor @code{change} command 8495824d651Sblueswir1can be used to later start the VNC server. 8505824d651Sblueswir1 8515824d651Sblueswir1@end table 8525824d651Sblueswir1 8535824d651Sblueswir1Following the @var{display} value there may be one or more @var{option} flags 8545824d651Sblueswir1separated by commas. Valid options are 8555824d651Sblueswir1 856b3f046c2SKevin Wolf@table @option 8575824d651Sblueswir1 8585824d651Sblueswir1@item reverse 8595824d651Sblueswir1 8605824d651Sblueswir1Connect to a listening VNC client via a ``reverse'' connection. The 8615824d651Sblueswir1client is specified by the @var{display}. For reverse network 8625824d651Sblueswir1connections (@var{host}:@var{d},@code{reverse}), the @var{d} argument 8635824d651Sblueswir1is a TCP port number, not a display number. 8645824d651Sblueswir1 8655824d651Sblueswir1@item password 8665824d651Sblueswir1 8675824d651Sblueswir1Require that password based authentication is used for client connections. 8685824d651Sblueswir1The password must be set separately using the @code{change} command in the 8695824d651Sblueswir1@ref{pcsys_monitor} 8705824d651Sblueswir1 8715824d651Sblueswir1@item tls 8725824d651Sblueswir1 8735824d651Sblueswir1Require that client use TLS when communicating with the VNC server. This 8745824d651Sblueswir1uses anonymous TLS credentials so is susceptible to a man-in-the-middle 8755824d651Sblueswir1attack. It is recommended that this option be combined with either the 8764e257e5eSKevin Wolf@option{x509} or @option{x509verify} options. 8775824d651Sblueswir1 8785824d651Sblueswir1@item x509=@var{/path/to/certificate/dir} 8795824d651Sblueswir1 8805824d651Sblueswir1Valid if @option{tls} is specified. Require that x509 credentials are used 8815824d651Sblueswir1for negotiating the TLS session. The server will send its x509 certificate 8825824d651Sblueswir1to the client. It is recommended that a password be set on the VNC server 8835824d651Sblueswir1to provide authentication of the client when this is used. The path following 8845824d651Sblueswir1this option specifies where the x509 certificates are to be loaded from. 8855824d651Sblueswir1See the @ref{vnc_security} section for details on generating certificates. 8865824d651Sblueswir1 8875824d651Sblueswir1@item x509verify=@var{/path/to/certificate/dir} 8885824d651Sblueswir1 8895824d651Sblueswir1Valid if @option{tls} is specified. Require that x509 credentials are used 8905824d651Sblueswir1for negotiating the TLS session. The server will send its x509 certificate 8915824d651Sblueswir1to the client, and request that the client send its own x509 certificate. 8925824d651Sblueswir1The server will validate the client's certificate against the CA certificate, 8935824d651Sblueswir1and reject clients when validation fails. If the certificate authority is 8945824d651Sblueswir1trusted, this is a sufficient authentication mechanism. You may still wish 8955824d651Sblueswir1to set a password on the VNC server as a second authentication layer. The 8965824d651Sblueswir1path following this option specifies where the x509 certificates are to 8975824d651Sblueswir1be loaded from. See the @ref{vnc_security} section for details on generating 8985824d651Sblueswir1certificates. 8995824d651Sblueswir1 9005824d651Sblueswir1@item sasl 9015824d651Sblueswir1 9025824d651Sblueswir1Require that the client use SASL to authenticate with the VNC server. 9035824d651Sblueswir1The exact choice of authentication method used is controlled from the 9045824d651Sblueswir1system / user's SASL configuration file for the 'qemu' service. This 9055824d651Sblueswir1is typically found in /etc/sasl2/qemu.conf. If running QEMU as an 9065824d651Sblueswir1unprivileged user, an environment variable SASL_CONF_PATH can be used 9075824d651Sblueswir1to make it search alternate locations for the service config. 9085824d651Sblueswir1While some SASL auth methods can also provide data encryption (eg GSSAPI), 9095824d651Sblueswir1it is recommended that SASL always be combined with the 'tls' and 9105824d651Sblueswir1'x509' settings to enable use of SSL and server certificates. This 9115824d651Sblueswir1ensures a data encryption preventing compromise of authentication 9125824d651Sblueswir1credentials. See the @ref{vnc_security} section for details on using 9135824d651Sblueswir1SASL authentication. 9145824d651Sblueswir1 9155824d651Sblueswir1@item acl 9165824d651Sblueswir1 9175824d651Sblueswir1Turn on access control lists for checking of the x509 client certificate 9185824d651Sblueswir1and SASL party. For x509 certs, the ACL check is made against the 9195824d651Sblueswir1certificate's distinguished name. This is something that looks like 9205824d651Sblueswir1@code{C=GB,O=ACME,L=Boston,CN=bob}. For SASL party, the ACL check is 9215824d651Sblueswir1made against the username, which depending on the SASL plugin, may 9225824d651Sblueswir1include a realm component, eg @code{bob} or @code{bob@@EXAMPLE.COM}. 9235824d651Sblueswir1When the @option{acl} flag is set, the initial access list will be 9245824d651Sblueswir1empty, with a @code{deny} policy. Thus no one will be allowed to 9255824d651Sblueswir1use the VNC server until the ACLs have been loaded. This can be 9265824d651Sblueswir1achieved using the @code{acl} monitor command. 9275824d651Sblueswir1 9286f9c78c1SCorentin Chary@item lossy 9296f9c78c1SCorentin Chary 9306f9c78c1SCorentin CharyEnable lossy compression methods (gradient, JPEG, ...). If this 9316f9c78c1SCorentin Charyoption is set, VNC client may receive lossy framebuffer updates 9326f9c78c1SCorentin Charydepending on its encoding settings. Enabling this option can save 9336f9c78c1SCorentin Charya lot of bandwidth at the expense of quality. 9346f9c78c1SCorentin Chary 93580e0c8c3SCorentin Chary@item non-adaptive 93680e0c8c3SCorentin Chary 93780e0c8c3SCorentin CharyDisable adaptive encodings. Adaptive encodings are enabled by default. 93880e0c8c3SCorentin CharyAn adaptive encoding will try to detect frequently updated screen regions, 93980e0c8c3SCorentin Charyand send updates in these regions using a lossy encoding (like JPEG). 94061cc8701SStefan WeilThis can be really helpful to save bandwidth when playing videos. Disabling 94161cc8701SStefan Weiladaptive encodings allows to restore the original static behavior of encodings 94280e0c8c3SCorentin Charylike Tight. 94380e0c8c3SCorentin Chary 9445824d651Sblueswir1@end table 9455824d651Sblueswir1ETEXI 9465824d651Sblueswir1 9475824d651Sblueswir1STEXI 9485824d651Sblueswir1@end table 9495824d651Sblueswir1ETEXI 9505824d651Sblueswir1 9515824d651Sblueswir1DEFHEADING() 9525824d651Sblueswir1 9535824d651Sblueswir1DEFHEADING(i386 target only:) 9545824d651Sblueswir1STEXI 9555824d651Sblueswir1@table @option 9565824d651Sblueswir1ETEXI 9575824d651Sblueswir1 9585824d651Sblueswir1DEF("win2k-hack", 0, QEMU_OPTION_win2k_hack, 959ad96090aSBlue Swirl "-win2k-hack use it when installing Windows 2000 to avoid a disk full bug\n", 960ad96090aSBlue Swirl QEMU_ARCH_I386) 9615824d651Sblueswir1STEXI 9625824d651Sblueswir1@item -win2k-hack 9636616b2adSStefan Weil@findex -win2k-hack 9645824d651Sblueswir1Use it when installing Windows 2000 to avoid a disk full bug. After 9655824d651Sblueswir1Windows 2000 is installed, you no longer need this option (this option 9665824d651Sblueswir1slows down the IDE transfers). 9675824d651Sblueswir1ETEXI 9685824d651Sblueswir1 9691ed2fc1fSJan KiszkaHXCOMM Deprecated by -rtc 970ad96090aSBlue SwirlDEF("rtc-td-hack", 0, QEMU_OPTION_rtc_td_hack, "", QEMU_ARCH_I386) 9715824d651Sblueswir1 9725824d651Sblueswir1DEF("no-fd-bootchk", 0, QEMU_OPTION_no_fd_bootchk, 973ad96090aSBlue Swirl "-no-fd-bootchk disable boot signature checking for floppy disks\n", 974ad96090aSBlue Swirl QEMU_ARCH_I386) 9755824d651Sblueswir1STEXI 9765824d651Sblueswir1@item -no-fd-bootchk 9776616b2adSStefan Weil@findex -no-fd-bootchk 9785824d651Sblueswir1Disable boot signature checking for floppy disks in Bochs BIOS. It may 9795824d651Sblueswir1be needed to boot from old floppy disks. 9806616b2adSStefan WeilTODO: check reference to Bochs BIOS. 9815824d651Sblueswir1ETEXI 9825824d651Sblueswir1 9835824d651Sblueswir1DEF("no-acpi", 0, QEMU_OPTION_no_acpi, 984ad96090aSBlue Swirl "-no-acpi disable ACPI\n", QEMU_ARCH_I386) 9855824d651Sblueswir1STEXI 9865824d651Sblueswir1@item -no-acpi 9876616b2adSStefan Weil@findex -no-acpi 9885824d651Sblueswir1Disable ACPI (Advanced Configuration and Power Interface) support. Use 9895824d651Sblueswir1it if your guest OS complains about ACPI problems (PC target machine 9905824d651Sblueswir1only). 9915824d651Sblueswir1ETEXI 9925824d651Sblueswir1 9935824d651Sblueswir1DEF("no-hpet", 0, QEMU_OPTION_no_hpet, 994ad96090aSBlue Swirl "-no-hpet disable HPET\n", QEMU_ARCH_I386) 9955824d651Sblueswir1STEXI 9965824d651Sblueswir1@item -no-hpet 9976616b2adSStefan Weil@findex -no-hpet 9985824d651Sblueswir1Disable HPET support. 9995824d651Sblueswir1ETEXI 10005824d651Sblueswir1 10017d4c3d53SMarkus ArmbrusterDEF("balloon", HAS_ARG, QEMU_OPTION_balloon, 10027d4c3d53SMarkus Armbruster "-balloon none disable balloon device\n" 10037d4c3d53SMarkus Armbruster "-balloon virtio[,addr=str]\n" 1004ad96090aSBlue Swirl " enable virtio balloon device (default)\n", QEMU_ARCH_ALL) 1005df97b920SEduardo HabkostSTEXI 10067d4c3d53SMarkus Armbruster@item -balloon none 10076616b2adSStefan Weil@findex -balloon 10087d4c3d53SMarkus ArmbrusterDisable balloon device. 10097d4c3d53SMarkus Armbruster@item -balloon virtio[,addr=@var{addr}] 10107d4c3d53SMarkus ArmbrusterEnable virtio balloon device (default), optionally with PCI address 10117d4c3d53SMarkus Armbruster@var{addr}. 1012df97b920SEduardo HabkostETEXI 1013df97b920SEduardo Habkost 10145824d651Sblueswir1DEF("acpitable", HAS_ARG, QEMU_OPTION_acpitable, 10155824d651Sblueswir1 "-acpitable [sig=str][,rev=n][,oem_id=str][,oem_table_id=str][,oem_rev=n][,asl_compiler_id=str][,asl_compiler_rev=n][,data=file1[:file2]...]\n" 1016ad96090aSBlue Swirl " ACPI table description\n", QEMU_ARCH_I386) 10175824d651Sblueswir1STEXI 10185824d651Sblueswir1@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}]...] 10196616b2adSStefan Weil@findex -acpitable 10205824d651Sblueswir1Add ACPI table with specified header fields and context from specified files. 10215824d651Sblueswir1ETEXI 10225824d651Sblueswir1 1023b6f6e3d3SaliguoriDEF("smbios", HAS_ARG, QEMU_OPTION_smbios, 1024b6f6e3d3Saliguori "-smbios file=binary\n" 1025ca1a8a06SBruce Rogers " load SMBIOS entry from binary file\n" 1026e8105ebbSPaolo Bonzini "-smbios type=0[,vendor=str][,version=str][,date=str][,release=%d.%d]\n" 1027ca1a8a06SBruce Rogers " specify SMBIOS type 0 fields\n" 1028b6f6e3d3Saliguori "-smbios type=1[,manufacturer=str][,product=str][,version=str][,serial=str]\n" 1029b6f6e3d3Saliguori " [,uuid=uuid][,sku=str][,family=str]\n" 1030ad96090aSBlue Swirl " specify SMBIOS type 1 fields\n", QEMU_ARCH_I386) 1031b6f6e3d3SaliguoriSTEXI 1032b6f6e3d3Saliguori@item -smbios file=@var{binary} 10336616b2adSStefan Weil@findex -smbios 1034b6f6e3d3SaliguoriLoad SMBIOS entry from binary file. 1035b6f6e3d3Saliguori 1036b6f6e3d3Saliguori@item -smbios type=0[,vendor=@var{str}][,version=@var{str}][,date=@var{str}][,release=@var{%d.%d}] 10376616b2adSStefan Weil@findex -smbios 1038b6f6e3d3SaliguoriSpecify SMBIOS type 0 fields 1039b6f6e3d3Saliguori 1040b6f6e3d3Saliguori@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}] 1041b6f6e3d3SaliguoriSpecify SMBIOS type 1 fields 1042b6f6e3d3SaliguoriETEXI 1043b6f6e3d3Saliguori 10445824d651Sblueswir1DEFHEADING() 10455824d651Sblueswir1STEXI 10465824d651Sblueswir1@end table 10475824d651Sblueswir1ETEXI 10485824d651Sblueswir1 10495824d651Sblueswir1DEFHEADING(Network options:) 10505824d651Sblueswir1STEXI 10515824d651Sblueswir1@table @option 10525824d651Sblueswir1ETEXI 10535824d651Sblueswir1 1054ad196a9dSJan KiszkaHXCOMM Legacy slirp options (now moved to -net user): 1055ad196a9dSJan Kiszka#ifdef CONFIG_SLIRP 1056ad96090aSBlue SwirlDEF("tftp", HAS_ARG, QEMU_OPTION_tftp, "", QEMU_ARCH_ALL) 1057ad96090aSBlue SwirlDEF("bootp", HAS_ARG, QEMU_OPTION_bootp, "", QEMU_ARCH_ALL) 1058ad96090aSBlue SwirlDEF("redir", HAS_ARG, QEMU_OPTION_redir, "", QEMU_ARCH_ALL) 1059ad196a9dSJan Kiszka#ifndef _WIN32 1060ad96090aSBlue SwirlDEF("smb", HAS_ARG, QEMU_OPTION_smb, "", QEMU_ARCH_ALL) 1061ad196a9dSJan Kiszka#endif 1062ad196a9dSJan Kiszka#endif 1063ad196a9dSJan Kiszka 1064bab7944cSBlue SwirlDEF("net", HAS_ARG, QEMU_OPTION_net, 1065ffe6370cSMichael S. Tsirkin "-net nic[,vlan=n][,macaddr=mac][,model=type][,name=str][,addr=str][,vectors=v]\n" 10665824d651Sblueswir1 " create a new Network Interface Card and connect it to VLAN 'n'\n" 10675824d651Sblueswir1#ifdef CONFIG_SLIRP 1068c92ef6a2SJan Kiszka "-net user[,vlan=n][,name=str][,net=addr[/mask]][,host=addr][,restrict=y|n]\n" 1069c92ef6a2SJan Kiszka " [,hostname=host][,dhcpstart=addr][,dns=addr][,tftp=dir][,bootfile=f]\n" 1070c92ef6a2SJan Kiszka " [,hostfwd=rule][,guestfwd=rule]" 1071ad196a9dSJan Kiszka#ifndef _WIN32 1072c92ef6a2SJan Kiszka "[,smb=dir[,smbserver=addr]]\n" 1073ad196a9dSJan Kiszka#endif 1074ad196a9dSJan Kiszka " connect the user mode network stack to VLAN 'n', configure its\n" 1075ad196a9dSJan Kiszka " DHCP server and enabled optional services\n" 10765824d651Sblueswir1#endif 10775824d651Sblueswir1#ifdef _WIN32 10785824d651Sblueswir1 "-net tap[,vlan=n][,name=str],ifname=name\n" 10795824d651Sblueswir1 " connect the host TAP network interface to VLAN 'n'\n" 10805824d651Sblueswir1#else 10815430a28fSmst@redhat.com "-net tap[,vlan=n][,name=str][,fd=h][,ifname=name][,script=file][,downscript=dfile][,sndbuf=nbytes][,vnet_hdr=on|off][,vhost=on|off][,vhostfd=h][,vhostforce=on|off]\n" 10825824d651Sblueswir1 " connect the host TAP network interface to VLAN 'n' and use the\n" 1083bec7c2d4SPaolo Bonzini " network scripts 'file' (default=" DEFAULT_NETWORK_SCRIPT ")\n" 1084bec7c2d4SPaolo Bonzini " and 'dfile' (default=" DEFAULT_NETWORK_DOWN_SCRIPT ")\n" 1085ca1a8a06SBruce Rogers " use '[down]script=no' to disable script execution\n" 10865824d651Sblueswir1 " use 'fd=h' to connect to an already opened TAP interface\n" 1087ca1a8a06SBruce Rogers " use 'sndbuf=nbytes' to limit the size of the send buffer (the\n" 1088f157ed20SMichael S. Tsirkin " default is disabled 'sndbuf=0' to enable flow control set 'sndbuf=1048576')\n" 1089ca1a8a06SBruce Rogers " use vnet_hdr=off to avoid enabling the IFF_VNET_HDR tap flag\n" 1090ca1a8a06SBruce Rogers " use vnet_hdr=on to make the lack of IFF_VNET_HDR support an error condition\n" 109182b0d80eSMichael S. Tsirkin " use vhost=on to enable experimental in kernel accelerator\n" 10925430a28fSmst@redhat.com " (only has effect for virtio guests which use MSIX)\n" 10935430a28fSmst@redhat.com " use vhostforce=on to force vhost on for non-MSIX virtio guests\n" 109482b0d80eSMichael S. Tsirkin " use 'vhostfd=h' to connect to an already opened vhost net device\n" 10950df0ff6dSMark McLoughlin#endif 10965824d651Sblueswir1 "-net socket[,vlan=n][,name=str][,fd=h][,listen=[host]:port][,connect=host:port]\n" 10975824d651Sblueswir1 " connect the vlan 'n' to another VLAN using a socket connection\n" 10983a75e74cSMike Ryan "-net socket[,vlan=n][,name=str][,fd=h][,mcast=maddr:port[,localaddr=addr]]\n" 10995824d651Sblueswir1 " connect the vlan 'n' to multicast maddr and port\n" 11003a75e74cSMike Ryan " use 'localaddr=addr' to specify the host address to send packets from\n" 11015824d651Sblueswir1#ifdef CONFIG_VDE 11025824d651Sblueswir1 "-net vde[,vlan=n][,name=str][,sock=socketpath][,port=n][,group=groupname][,mode=octalmode]\n" 11035824d651Sblueswir1 " connect the vlan 'n' to port 'n' of a vde switch running\n" 11045824d651Sblueswir1 " on host and listening for incoming connections on 'socketpath'.\n" 11055824d651Sblueswir1 " Use group 'groupname' and mode 'octalmode' to change default\n" 11065824d651Sblueswir1 " ownership and permissions for communication port.\n" 11075824d651Sblueswir1#endif 1108bb9ea79eSaliguori "-net dump[,vlan=n][,file=f][,len=n]\n" 1109bb9ea79eSaliguori " dump traffic on vlan 'n' to file 'f' (max n bytes per packet)\n" 1110ca1a8a06SBruce Rogers "-net none use it alone to have zero network devices. If no -net option\n" 1111ad96090aSBlue Swirl " is provided, the default is '-net nic -net user'\n", QEMU_ARCH_ALL) 1112a1ea458fSMark McLoughlinDEF("netdev", HAS_ARG, QEMU_OPTION_netdev, 1113a1ea458fSMark McLoughlin "-netdev [" 1114a1ea458fSMark McLoughlin#ifdef CONFIG_SLIRP 1115a1ea458fSMark McLoughlin "user|" 1116a1ea458fSMark McLoughlin#endif 1117a1ea458fSMark McLoughlin "tap|" 1118a1ea458fSMark McLoughlin#ifdef CONFIG_VDE 1119a1ea458fSMark McLoughlin "vde|" 1120a1ea458fSMark McLoughlin#endif 1121ad96090aSBlue Swirl "socket],id=str[,option][,option][,...]\n", QEMU_ARCH_ALL) 11225824d651Sblueswir1STEXI 1123ffe6370cSMichael S. Tsirkin@item -net nic[,vlan=@var{n}][,macaddr=@var{mac}][,model=@var{type}] [,name=@var{name}][,addr=@var{addr}][,vectors=@var{v}] 11246616b2adSStefan Weil@findex -net 11255824d651Sblueswir1Create a new Network Interface Card and connect it to VLAN @var{n} (@var{n} 11260d6b0b1dSAnthony Liguori= 0 is the default). The NIC is an e1000 by default on the PC 11275607c388SMarkus Armbrustertarget. Optionally, the MAC address can be changed to @var{mac}, the 11285607c388SMarkus Armbrusterdevice address set to @var{addr} (PCI cards only), 1129ffe6370cSMichael S. Tsirkinand a @var{name} can be assigned for use in monitor commands. 1130ffe6370cSMichael S. TsirkinOptionally, for PCI cards, you can specify the number @var{v} of MSI-X vectors 1131ffe6370cSMichael S. Tsirkinthat the card should have; this option currently only affects virtio cards; set 1132ffe6370cSMichael S. Tsirkin@var{v} = 0 to disable MSI-X. If no @option{-net} option is specified, a single 1133ffe6370cSMichael S. TsirkinNIC is created. Qemu can emulate several different models of network card. 11345824d651Sblueswir1Valid values for @var{type} are 1135ffe6370cSMichael S. Tsirkin@code{virtio}, @code{i82551}, @code{i82557b}, @code{i82559er}, 11365824d651Sblueswir1@code{ne2k_pci}, @code{ne2k_isa}, @code{pcnet}, @code{rtl8139}, 11375824d651Sblueswir1@code{e1000}, @code{smc91c111}, @code{lance} and @code{mcf_fec}. 11385824d651Sblueswir1Not all devices are supported on all targets. Use -net nic,model=? 11395824d651Sblueswir1for a list of available devices for your target. 11405824d651Sblueswir1 1141ad196a9dSJan Kiszka@item -net user[,@var{option}][,@var{option}][,...] 11425824d651Sblueswir1Use the user mode network stack which requires no administrator 1143ad196a9dSJan Kiszkaprivilege to run. Valid options are: 11445824d651Sblueswir1 1145b3f046c2SKevin Wolf@table @option 1146ad196a9dSJan Kiszka@item vlan=@var{n} 1147ad196a9dSJan KiszkaConnect user mode stack to VLAN @var{n} (@var{n} = 0 is the default). 1148ad196a9dSJan Kiszka 1149ad196a9dSJan Kiszka@item name=@var{name} 1150ad196a9dSJan KiszkaAssign symbolic name for use in monitor commands. 1151ad196a9dSJan Kiszka 1152c92ef6a2SJan Kiszka@item net=@var{addr}[/@var{mask}] 1153c92ef6a2SJan KiszkaSet IP network address the guest will see. Optionally specify the netmask, 1154c92ef6a2SJan Kiszkaeither in the form a.b.c.d or as number of valid top-most bits. Default is 1155b0b36e5dSBrad Hards10.0.2.0/24. 1156c92ef6a2SJan Kiszka 1157c92ef6a2SJan Kiszka@item host=@var{addr} 1158c92ef6a2SJan KiszkaSpecify the guest-visible address of the host. Default is the 2nd IP in the 1159c92ef6a2SJan Kiszkaguest network, i.e. x.x.x.2. 1160ad196a9dSJan Kiszka 1161ad196a9dSJan Kiszka@item restrict=y|yes|n|no 1162ad196a9dSJan KiszkaIf this options is enabled, the guest will be isolated, i.e. it will not be 1163ad196a9dSJan Kiszkaable to contact the host and no guest IP packets will be routed over the host 1164ad196a9dSJan Kiszkato the outside. This option does not affect explicitly set forwarding rule. 1165ad196a9dSJan Kiszka 1166ad196a9dSJan Kiszka@item hostname=@var{name} 1167ad196a9dSJan KiszkaSpecifies the client hostname reported by the builtin DHCP server. 1168ad196a9dSJan Kiszka 1169c92ef6a2SJan Kiszka@item dhcpstart=@var{addr} 1170c92ef6a2SJan KiszkaSpecify the first of the 16 IPs the built-in DHCP server can assign. Default 1171b0b36e5dSBrad Hardsis the 15th to 31st IP in the guest network, i.e. x.x.x.15 to x.x.x.31. 1172c92ef6a2SJan Kiszka 1173c92ef6a2SJan Kiszka@item dns=@var{addr} 1174c92ef6a2SJan KiszkaSpecify the guest-visible address of the virtual nameserver. The address must 1175c92ef6a2SJan Kiszkabe different from the host address. Default is the 3rd IP in the guest network, 1176c92ef6a2SJan Kiszkai.e. x.x.x.3. 1177c92ef6a2SJan Kiszka 1178ad196a9dSJan Kiszka@item tftp=@var{dir} 1179ad196a9dSJan KiszkaWhen using the user mode network stack, activate a built-in TFTP 1180ad196a9dSJan Kiszkaserver. The files in @var{dir} will be exposed as the root of a TFTP server. 1181ad196a9dSJan KiszkaThe TFTP client on the guest must be configured in binary mode (use the command 1182c92ef6a2SJan Kiszka@code{bin} of the Unix TFTP client). 1183ad196a9dSJan Kiszka 1184ad196a9dSJan Kiszka@item bootfile=@var{file} 1185ad196a9dSJan KiszkaWhen using the user mode network stack, broadcast @var{file} as the BOOTP 1186ad196a9dSJan Kiszkafilename. In conjunction with @option{tftp}, this can be used to network boot 1187ad196a9dSJan Kiszkaa guest from a local directory. 1188ad196a9dSJan Kiszka 1189ad196a9dSJan KiszkaExample (using pxelinux): 1190ad196a9dSJan Kiszka@example 1191ad196a9dSJan Kiszkaqemu -hda linux.img -boot n -net user,tftp=/path/to/tftp/files,bootfile=/pxelinux.0 1192ad196a9dSJan Kiszka@end example 1193ad196a9dSJan Kiszka 1194c92ef6a2SJan Kiszka@item smb=@var{dir}[,smbserver=@var{addr}] 1195ad196a9dSJan KiszkaWhen using the user mode network stack, activate a built-in SMB 1196ad196a9dSJan Kiszkaserver so that Windows OSes can access to the host files in @file{@var{dir}} 1197c92ef6a2SJan Kiszkatransparently. The IP address of the SMB server can be set to @var{addr}. By 1198c92ef6a2SJan Kiszkadefault the 4th IP in the guest network is used, i.e. x.x.x.4. 1199ad196a9dSJan Kiszka 1200ad196a9dSJan KiszkaIn the guest Windows OS, the line: 1201ad196a9dSJan Kiszka@example 1202ad196a9dSJan Kiszka10.0.2.4 smbserver 1203ad196a9dSJan Kiszka@end example 1204ad196a9dSJan Kiszkamust be added in the file @file{C:\WINDOWS\LMHOSTS} (for windows 9x/Me) 1205ad196a9dSJan Kiszkaor @file{C:\WINNT\SYSTEM32\DRIVERS\ETC\LMHOSTS} (Windows NT/2000). 1206ad196a9dSJan Kiszka 1207ad196a9dSJan KiszkaThen @file{@var{dir}} can be accessed in @file{\\smbserver\qemu}. 1208ad196a9dSJan Kiszka 1209ad196a9dSJan KiszkaNote that a SAMBA server must be installed on the host OS in 1210ad196a9dSJan Kiszka@file{/usr/sbin/smbd}. QEMU was tested successfully with smbd versions from 1211ad196a9dSJan KiszkaRed Hat 9, Fedora Core 3 and OpenSUSE 11.x. 1212ad196a9dSJan Kiszka 12133c6a0580SJan Kiszka@item hostfwd=[tcp|udp]:[@var{hostaddr}]:@var{hostport}-[@var{guestaddr}]:@var{guestport} 1214c92ef6a2SJan KiszkaRedirect incoming TCP or UDP connections to the host port @var{hostport} to 1215c92ef6a2SJan Kiszkathe guest IP address @var{guestaddr} on guest port @var{guestport}. If 1216c92ef6a2SJan Kiszka@var{guestaddr} is not specified, its value is x.x.x.15 (default first address 12173c6a0580SJan Kiszkagiven by the built-in DHCP server). By specifying @var{hostaddr}, the rule can 12183c6a0580SJan Kiszkabe bound to a specific host interface. If no connection type is set, TCP is 1219c92ef6a2SJan Kiszkaused. This option can be given multiple times. 1220ad196a9dSJan Kiszka 1221ad196a9dSJan KiszkaFor example, to redirect host X11 connection from screen 1 to guest 1222ad196a9dSJan Kiszkascreen 0, use the following: 1223ad196a9dSJan Kiszka 1224ad196a9dSJan Kiszka@example 1225ad196a9dSJan Kiszka# on the host 12263c6a0580SJan Kiszkaqemu -net user,hostfwd=tcp:127.0.0.1:6001-:6000 [...] 1227ad196a9dSJan Kiszka# this host xterm should open in the guest X11 server 1228ad196a9dSJan Kiszkaxterm -display :1 1229ad196a9dSJan Kiszka@end example 1230ad196a9dSJan Kiszka 1231ad196a9dSJan KiszkaTo redirect telnet connections from host port 5555 to telnet port on 1232ad196a9dSJan Kiszkathe guest, use the following: 1233ad196a9dSJan Kiszka 1234ad196a9dSJan Kiszka@example 1235ad196a9dSJan Kiszka# on the host 1236aa375206SAurelien Jarnoqemu -net user,hostfwd=tcp::5555-:23 [...] 1237ad196a9dSJan Kiszkatelnet localhost 5555 1238ad196a9dSJan Kiszka@end example 1239ad196a9dSJan Kiszka 1240ad196a9dSJan KiszkaThen when you use on the host @code{telnet localhost 5555}, you 1241ad196a9dSJan Kiszkaconnect to the guest telnet server. 1242ad196a9dSJan Kiszka 1243c92ef6a2SJan Kiszka@item guestfwd=[tcp]:@var{server}:@var{port}-@var{dev} 12443c6a0580SJan KiszkaForward guest TCP connections to the IP address @var{server} on port @var{port} 12453c6a0580SJan Kiszkato the character device @var{dev}. This option can be given multiple times. 1246ad196a9dSJan Kiszka 1247ad196a9dSJan Kiszka@end table 1248ad196a9dSJan Kiszka 1249ad196a9dSJan KiszkaNote: Legacy stand-alone options -tftp, -bootp, -smb and -redir are still 1250ad196a9dSJan Kiszkaprocessed and applied to -net user. Mixing them with the new configuration 1251ad196a9dSJan Kiszkasyntax gives undefined results. Their use for new applications is discouraged 1252ad196a9dSJan Kiszkaas they will be removed from future versions. 12535824d651Sblueswir1 12545824d651Sblueswir1@item -net tap[,vlan=@var{n}][,name=@var{name}][,fd=@var{h}][,ifname=@var{name}] [,script=@var{file}][,downscript=@var{dfile}] 12555824d651Sblueswir1Connect the host TAP network interface @var{name} to VLAN @var{n}, use 12565824d651Sblueswir1the network script @var{file} to configure it and the network script 12575824d651Sblueswir1@var{dfile} to deconfigure it. If @var{name} is not provided, the OS 12585824d651Sblueswir1automatically provides one. @option{fd}=@var{h} can be used to specify 12595824d651Sblueswir1the handle of an already opened host TAP interface. The default network 12605824d651Sblueswir1configure script is @file{/etc/qemu-ifup} and the default network 12615824d651Sblueswir1deconfigure script is @file{/etc/qemu-ifdown}. Use @option{script=no} 12625824d651Sblueswir1or @option{downscript=no} to disable script execution. Example: 12635824d651Sblueswir1 12645824d651Sblueswir1@example 12655824d651Sblueswir1qemu linux.img -net nic -net tap 12665824d651Sblueswir1@end example 12675824d651Sblueswir1 12685824d651Sblueswir1More complicated example (two NICs, each one connected to a TAP device) 12695824d651Sblueswir1@example 12705824d651Sblueswir1qemu linux.img -net nic,vlan=0 -net tap,vlan=0,ifname=tap0 \ 12715824d651Sblueswir1 -net nic,vlan=1 -net tap,vlan=1,ifname=tap1 12725824d651Sblueswir1@end example 12735824d651Sblueswir1 12745824d651Sblueswir1@item -net socket[,vlan=@var{n}][,name=@var{name}][,fd=@var{h}] [,listen=[@var{host}]:@var{port}][,connect=@var{host}:@var{port}] 12755824d651Sblueswir1 12765824d651Sblueswir1Connect the VLAN @var{n} to a remote VLAN in another QEMU virtual 12775824d651Sblueswir1machine using a TCP socket connection. If @option{listen} is 12785824d651Sblueswir1specified, QEMU waits for incoming connections on @var{port} 12795824d651Sblueswir1(@var{host} is optional). @option{connect} is used to connect to 12805824d651Sblueswir1another QEMU instance using the @option{listen} option. @option{fd}=@var{h} 12815824d651Sblueswir1specifies an already opened TCP socket. 12825824d651Sblueswir1 12835824d651Sblueswir1Example: 12845824d651Sblueswir1@example 12855824d651Sblueswir1# launch a first QEMU instance 12865824d651Sblueswir1qemu linux.img -net nic,macaddr=52:54:00:12:34:56 \ 12875824d651Sblueswir1 -net socket,listen=:1234 12885824d651Sblueswir1# connect the VLAN 0 of this instance to the VLAN 0 12895824d651Sblueswir1# of the first instance 12905824d651Sblueswir1qemu linux.img -net nic,macaddr=52:54:00:12:34:57 \ 12915824d651Sblueswir1 -net socket,connect=127.0.0.1:1234 12925824d651Sblueswir1@end example 12935824d651Sblueswir1 12943a75e74cSMike Ryan@item -net socket[,vlan=@var{n}][,name=@var{name}][,fd=@var{h}][,mcast=@var{maddr}:@var{port}[,localaddr=@var{addr}]] 12955824d651Sblueswir1 12965824d651Sblueswir1Create a VLAN @var{n} shared with another QEMU virtual 12975824d651Sblueswir1machines using a UDP multicast socket, effectively making a bus for 12985824d651Sblueswir1every QEMU with same multicast address @var{maddr} and @var{port}. 12995824d651Sblueswir1NOTES: 13005824d651Sblueswir1@enumerate 13015824d651Sblueswir1@item 13025824d651Sblueswir1Several QEMU can be running on different hosts and share same bus (assuming 13035824d651Sblueswir1correct multicast setup for these hosts). 13045824d651Sblueswir1@item 13055824d651Sblueswir1mcast support is compatible with User Mode Linux (argument @option{eth@var{N}=mcast}), see 13065824d651Sblueswir1@url{http://user-mode-linux.sf.net}. 13075824d651Sblueswir1@item 13085824d651Sblueswir1Use @option{fd=h} to specify an already opened UDP multicast socket. 13095824d651Sblueswir1@end enumerate 13105824d651Sblueswir1 13115824d651Sblueswir1Example: 13125824d651Sblueswir1@example 13135824d651Sblueswir1# launch one QEMU instance 13145824d651Sblueswir1qemu linux.img -net nic,macaddr=52:54:00:12:34:56 \ 13155824d651Sblueswir1 -net socket,mcast=230.0.0.1:1234 13165824d651Sblueswir1# launch another QEMU instance on same "bus" 13175824d651Sblueswir1qemu linux.img -net nic,macaddr=52:54:00:12:34:57 \ 13185824d651Sblueswir1 -net socket,mcast=230.0.0.1:1234 13195824d651Sblueswir1# launch yet another QEMU instance on same "bus" 13205824d651Sblueswir1qemu linux.img -net nic,macaddr=52:54:00:12:34:58 \ 13215824d651Sblueswir1 -net socket,mcast=230.0.0.1:1234 13225824d651Sblueswir1@end example 13235824d651Sblueswir1 13245824d651Sblueswir1Example (User Mode Linux compat.): 13255824d651Sblueswir1@example 13265824d651Sblueswir1# launch QEMU instance (note mcast address selected 13275824d651Sblueswir1# is UML's default) 13285824d651Sblueswir1qemu linux.img -net nic,macaddr=52:54:00:12:34:56 \ 13295824d651Sblueswir1 -net socket,mcast=239.192.168.1:1102 13305824d651Sblueswir1# launch UML 13315824d651Sblueswir1/path/to/linux ubd0=/path/to/root_fs eth0=mcast 13325824d651Sblueswir1@end example 13335824d651Sblueswir1 13343a75e74cSMike RyanExample (send packets from host's 1.2.3.4): 13353a75e74cSMike Ryan@example 13363a75e74cSMike Ryanqemu linux.img -net nic,macaddr=52:54:00:12:34:56 \ 13373a75e74cSMike Ryan -net socket,mcast=239.192.168.1:1102,localaddr=1.2.3.4 13383a75e74cSMike Ryan@end example 13393a75e74cSMike Ryan 13405824d651Sblueswir1@item -net vde[,vlan=@var{n}][,name=@var{name}][,sock=@var{socketpath}] [,port=@var{n}][,group=@var{groupname}][,mode=@var{octalmode}] 13415824d651Sblueswir1Connect VLAN @var{n} to PORT @var{n} of a vde switch running on host and 13425824d651Sblueswir1listening for incoming connections on @var{socketpath}. Use GROUP @var{groupname} 13435824d651Sblueswir1and MODE @var{octalmode} to change default ownership and permissions for 13445824d651Sblueswir1communication port. This option is available only if QEMU has been compiled 13455824d651Sblueswir1with vde support enabled. 13465824d651Sblueswir1 13475824d651Sblueswir1Example: 13485824d651Sblueswir1@example 13495824d651Sblueswir1# launch vde switch 13505824d651Sblueswir1vde_switch -F -sock /tmp/myswitch 13515824d651Sblueswir1# launch QEMU instance 13525824d651Sblueswir1qemu linux.img -net nic -net vde,sock=/tmp/myswitch 13535824d651Sblueswir1@end example 13545824d651Sblueswir1 1355bb9ea79eSaliguori@item -net dump[,vlan=@var{n}][,file=@var{file}][,len=@var{len}] 1356bb9ea79eSaliguoriDump network traffic on VLAN @var{n} to file @var{file} (@file{qemu-vlan0.pcap} by default). 1357bb9ea79eSaliguoriAt most @var{len} bytes (64k by default) per packet are stored. The file format is 1358bb9ea79eSaliguorilibpcap, so it can be analyzed with tools such as tcpdump or Wireshark. 1359bb9ea79eSaliguori 13605824d651Sblueswir1@item -net none 13615824d651Sblueswir1Indicate that no network devices should be configured. It is used to 13625824d651Sblueswir1override the default configuration (@option{-net nic -net user}) which 13635824d651Sblueswir1is activated if no @option{-net} options are provided. 13645824d651Sblueswir1 13655824d651Sblueswir1@end table 13665824d651Sblueswir1ETEXI 13675824d651Sblueswir1 13687273a2dbSMatthew BoothDEFHEADING() 13697273a2dbSMatthew Booth 13707273a2dbSMatthew BoothDEFHEADING(Character device options:) 13717273a2dbSMatthew Booth 13727273a2dbSMatthew BoothDEF("chardev", HAS_ARG, QEMU_OPTION_chardev, 137397331287SJan Kiszka "-chardev null,id=id[,mux=on|off]\n" 13747273a2dbSMatthew Booth "-chardev socket,id=id[,host=host],port=host[,to=to][,ipv4][,ipv6][,nodelay]\n" 137597331287SJan Kiszka " [,server][,nowait][,telnet][,mux=on|off] (tcp)\n" 137697331287SJan Kiszka "-chardev socket,id=id,path=path[,server][,nowait][,telnet],[mux=on|off] (unix)\n" 13777273a2dbSMatthew Booth "-chardev udp,id=id[,host=host],port=port[,localaddr=localaddr]\n" 137897331287SJan Kiszka " [,localport=localport][,ipv4][,ipv6][,mux=on|off]\n" 137997331287SJan Kiszka "-chardev msmouse,id=id[,mux=on|off]\n" 13807273a2dbSMatthew Booth "-chardev vc,id=id[[,width=width][,height=height]][[,cols=cols][,rows=rows]]\n" 138197331287SJan Kiszka " [,mux=on|off]\n" 138297331287SJan Kiszka "-chardev file,id=id,path=path[,mux=on|off]\n" 138397331287SJan Kiszka "-chardev pipe,id=id,path=path[,mux=on|off]\n" 13847273a2dbSMatthew Booth#ifdef _WIN32 138597331287SJan Kiszka "-chardev console,id=id[,mux=on|off]\n" 138697331287SJan Kiszka "-chardev serial,id=id,path=path[,mux=on|off]\n" 13877273a2dbSMatthew Booth#else 138897331287SJan Kiszka "-chardev pty,id=id[,mux=on|off]\n" 1389b7fdb3abSAurelien Jarno "-chardev stdio,id=id[,mux=on|off][,signal=on|off]\n" 13907273a2dbSMatthew Booth#endif 13917273a2dbSMatthew Booth#ifdef CONFIG_BRLAPI 139297331287SJan Kiszka "-chardev braille,id=id[,mux=on|off]\n" 13937273a2dbSMatthew Booth#endif 13947273a2dbSMatthew Booth#if defined(__linux__) || defined(__sun__) || defined(__FreeBSD__) \ 13957273a2dbSMatthew Booth || defined(__NetBSD__) || defined(__OpenBSD__) || defined(__DragonFly__) 139697331287SJan Kiszka "-chardev tty,id=id,path=path[,mux=on|off]\n" 13977273a2dbSMatthew Booth#endif 13987273a2dbSMatthew Booth#if defined(__linux__) || defined(__FreeBSD__) || defined(__DragonFly__) 139997331287SJan Kiszka "-chardev parport,id=id,path=path[,mux=on|off]\n" 14007273a2dbSMatthew Booth#endif 1401cbcc6336SAlon Levy#if defined(CONFIG_SPICE) 1402cbcc6336SAlon Levy "-chardev spicevmc,id=id,name=name[,debug=debug]\n" 1403cbcc6336SAlon Levy#endif 1404ad96090aSBlue Swirl , QEMU_ARCH_ALL 14057273a2dbSMatthew Booth) 14067273a2dbSMatthew Booth 14077273a2dbSMatthew BoothSTEXI 14087273a2dbSMatthew Booth 14097273a2dbSMatthew BoothThe general form of a character device option is: 14107273a2dbSMatthew Booth@table @option 14117273a2dbSMatthew Booth 141297331287SJan Kiszka@item -chardev @var{backend} ,id=@var{id} [,mux=on|off] [,@var{options}] 14136616b2adSStefan Weil@findex -chardev 14147273a2dbSMatthew BoothBackend is one of: 14157273a2dbSMatthew Booth@option{null}, 14167273a2dbSMatthew Booth@option{socket}, 14177273a2dbSMatthew Booth@option{udp}, 14187273a2dbSMatthew Booth@option{msmouse}, 14197273a2dbSMatthew Booth@option{vc}, 14207273a2dbSMatthew Booth@option{file}, 14217273a2dbSMatthew Booth@option{pipe}, 14227273a2dbSMatthew Booth@option{console}, 14237273a2dbSMatthew Booth@option{serial}, 14247273a2dbSMatthew Booth@option{pty}, 14257273a2dbSMatthew Booth@option{stdio}, 14267273a2dbSMatthew Booth@option{braille}, 14277273a2dbSMatthew Booth@option{tty}, 1428cbcc6336SAlon Levy@option{parport}, 1429cbcc6336SAlon Levy@option{spicevmc}. 14307273a2dbSMatthew BoothThe specific backend will determine the applicable options. 14317273a2dbSMatthew Booth 14327273a2dbSMatthew BoothAll devices must have an id, which can be any string up to 127 characters long. 14337273a2dbSMatthew BoothIt is used to uniquely identify this device in other command line directives. 14347273a2dbSMatthew Booth 143597331287SJan KiszkaA character device may be used in multiplexing mode by multiple front-ends. 143697331287SJan KiszkaThe key sequence of @key{Control-a} and @key{c} will rotate the input focus 143797331287SJan Kiszkabetween attached front-ends. Specify @option{mux=on} to enable this mode. 143897331287SJan Kiszka 14397273a2dbSMatthew BoothOptions to each backend are described below. 14407273a2dbSMatthew Booth 14417273a2dbSMatthew Booth@item -chardev null ,id=@var{id} 14427273a2dbSMatthew BoothA void device. This device will not emit any data, and will drop any data it 14437273a2dbSMatthew Boothreceives. The null backend does not take any options. 14447273a2dbSMatthew Booth 14457273a2dbSMatthew Booth@item -chardev socket ,id=@var{id} [@var{TCP options} or @var{unix options}] [,server] [,nowait] [,telnet] 14467273a2dbSMatthew Booth 14477273a2dbSMatthew BoothCreate a two-way stream socket, which can be either a TCP or a unix socket. A 14487273a2dbSMatthew Boothunix socket will be created if @option{path} is specified. Behaviour is 14497273a2dbSMatthew Boothundefined if TCP options are specified for a unix socket. 14507273a2dbSMatthew Booth 14517273a2dbSMatthew Booth@option{server} specifies that the socket shall be a listening socket. 14527273a2dbSMatthew Booth 14537273a2dbSMatthew Booth@option{nowait} specifies that QEMU should not block waiting for a client to 14547273a2dbSMatthew Boothconnect to a listening socket. 14557273a2dbSMatthew Booth 14567273a2dbSMatthew Booth@option{telnet} specifies that traffic on the socket should interpret telnet 14577273a2dbSMatthew Boothescape sequences. 14587273a2dbSMatthew Booth 14597273a2dbSMatthew BoothTCP and unix socket options are given below: 14607273a2dbSMatthew Booth 14617273a2dbSMatthew Booth@table @option 14627273a2dbSMatthew Booth 14638d533561SAurelien Jarno@item TCP options: port=@var{port} [,host=@var{host}] [,to=@var{to}] [,ipv4] [,ipv6] [,nodelay] 14647273a2dbSMatthew Booth 14657273a2dbSMatthew Booth@option{host} for a listening socket specifies the local address to be bound. 14667273a2dbSMatthew BoothFor a connecting socket species the remote host to connect to. @option{host} is 14677273a2dbSMatthew Boothoptional for listening sockets. If not specified it defaults to @code{0.0.0.0}. 14687273a2dbSMatthew Booth 14697273a2dbSMatthew Booth@option{port} for a listening socket specifies the local port to be bound. For a 14707273a2dbSMatthew Boothconnecting socket specifies the port on the remote host to connect to. 14717273a2dbSMatthew Booth@option{port} can be given as either a port number or a service name. 14727273a2dbSMatthew Booth@option{port} is required. 14737273a2dbSMatthew Booth 14747273a2dbSMatthew Booth@option{to} is only relevant to listening sockets. If it is specified, and 14757273a2dbSMatthew Booth@option{port} cannot be bound, QEMU will attempt to bind to subsequent ports up 14767273a2dbSMatthew Boothto and including @option{to} until it succeeds. @option{to} must be specified 14777273a2dbSMatthew Boothas a port number. 14787273a2dbSMatthew Booth 14797273a2dbSMatthew Booth@option{ipv4} and @option{ipv6} specify that either IPv4 or IPv6 must be used. 14807273a2dbSMatthew BoothIf neither is specified the socket may use either protocol. 14817273a2dbSMatthew Booth 14827273a2dbSMatthew Booth@option{nodelay} disables the Nagle algorithm. 14837273a2dbSMatthew Booth 14847273a2dbSMatthew Booth@item unix options: path=@var{path} 14857273a2dbSMatthew Booth 14867273a2dbSMatthew Booth@option{path} specifies the local path of the unix socket. @option{path} is 14877273a2dbSMatthew Boothrequired. 14887273a2dbSMatthew Booth 14897273a2dbSMatthew Booth@end table 14907273a2dbSMatthew Booth 14917273a2dbSMatthew Booth@item -chardev udp ,id=@var{id} [,host=@var{host}] ,port=@var{port} [,localaddr=@var{localaddr}] [,localport=@var{localport}] [,ipv4] [,ipv6] 14927273a2dbSMatthew Booth 14937273a2dbSMatthew BoothSends all traffic from the guest to a remote host over UDP. 14947273a2dbSMatthew Booth 14957273a2dbSMatthew Booth@option{host} specifies the remote host to connect to. If not specified it 14967273a2dbSMatthew Boothdefaults to @code{localhost}. 14977273a2dbSMatthew Booth 14987273a2dbSMatthew Booth@option{port} specifies the port on the remote host to connect to. @option{port} 14997273a2dbSMatthew Boothis required. 15007273a2dbSMatthew Booth 15017273a2dbSMatthew Booth@option{localaddr} specifies the local address to bind to. If not specified it 15027273a2dbSMatthew Boothdefaults to @code{0.0.0.0}. 15037273a2dbSMatthew Booth 15047273a2dbSMatthew Booth@option{localport} specifies the local port to bind to. If not specified any 15057273a2dbSMatthew Boothavailable local port will be used. 15067273a2dbSMatthew Booth 15077273a2dbSMatthew Booth@option{ipv4} and @option{ipv6} specify that either IPv4 or IPv6 must be used. 15087273a2dbSMatthew BoothIf neither is specified the device may use either protocol. 15097273a2dbSMatthew Booth 15107273a2dbSMatthew Booth@item -chardev msmouse ,id=@var{id} 15117273a2dbSMatthew Booth 15127273a2dbSMatthew BoothForward QEMU's emulated msmouse events to the guest. @option{msmouse} does not 15137273a2dbSMatthew Boothtake any options. 15147273a2dbSMatthew Booth 15157273a2dbSMatthew Booth@item -chardev vc ,id=@var{id} [[,width=@var{width}] [,height=@var{height}]] [[,cols=@var{cols}] [,rows=@var{rows}]] 15167273a2dbSMatthew Booth 15177273a2dbSMatthew BoothConnect to a QEMU text console. @option{vc} may optionally be given a specific 15187273a2dbSMatthew Boothsize. 15197273a2dbSMatthew Booth 15207273a2dbSMatthew Booth@option{width} and @option{height} specify the width and height respectively of 15217273a2dbSMatthew Booththe console, in pixels. 15227273a2dbSMatthew Booth 15237273a2dbSMatthew Booth@option{cols} and @option{rows} specify that the console be sized to fit a text 15247273a2dbSMatthew Boothconsole with the given dimensions. 15257273a2dbSMatthew Booth 15267273a2dbSMatthew Booth@item -chardev file ,id=@var{id} ,path=@var{path} 15277273a2dbSMatthew Booth 15287273a2dbSMatthew BoothLog all traffic received from the guest to a file. 15297273a2dbSMatthew Booth 15307273a2dbSMatthew Booth@option{path} specifies the path of the file to be opened. This file will be 15317273a2dbSMatthew Boothcreated if it does not already exist, and overwritten if it does. @option{path} 15327273a2dbSMatthew Boothis required. 15337273a2dbSMatthew Booth 15347273a2dbSMatthew Booth@item -chardev pipe ,id=@var{id} ,path=@var{path} 15357273a2dbSMatthew Booth 15367273a2dbSMatthew BoothCreate a two-way connection to the guest. The behaviour differs slightly between 15377273a2dbSMatthew BoothWindows hosts and other hosts: 15387273a2dbSMatthew Booth 15397273a2dbSMatthew BoothOn Windows, a single duplex pipe will be created at 15407273a2dbSMatthew Booth@file{\\.pipe\@option{path}}. 15417273a2dbSMatthew Booth 15427273a2dbSMatthew BoothOn other hosts, 2 pipes will be created called @file{@option{path}.in} and 15437273a2dbSMatthew Booth@file{@option{path}.out}. Data written to @file{@option{path}.in} will be 15447273a2dbSMatthew Boothreceived by the guest. Data written by the guest can be read from 15457273a2dbSMatthew Booth@file{@option{path}.out}. QEMU will not create these fifos, and requires them to 15467273a2dbSMatthew Boothbe present. 15477273a2dbSMatthew Booth 15487273a2dbSMatthew Booth@option{path} forms part of the pipe path as described above. @option{path} is 15497273a2dbSMatthew Boothrequired. 15507273a2dbSMatthew Booth 15517273a2dbSMatthew Booth@item -chardev console ,id=@var{id} 15527273a2dbSMatthew Booth 15537273a2dbSMatthew BoothSend traffic from the guest to QEMU's standard output. @option{console} does not 15547273a2dbSMatthew Boothtake any options. 15557273a2dbSMatthew Booth 15567273a2dbSMatthew Booth@option{console} is only available on Windows hosts. 15577273a2dbSMatthew Booth 15587273a2dbSMatthew Booth@item -chardev serial ,id=@var{id} ,path=@option{path} 15597273a2dbSMatthew Booth 15607273a2dbSMatthew BoothSend traffic from the guest to a serial device on the host. 15617273a2dbSMatthew Booth 15627273a2dbSMatthew Booth@option{serial} is 15637273a2dbSMatthew Boothonly available on Windows hosts. 15647273a2dbSMatthew Booth 15657273a2dbSMatthew Booth@option{path} specifies the name of the serial device to open. 15667273a2dbSMatthew Booth 15677273a2dbSMatthew Booth@item -chardev pty ,id=@var{id} 15687273a2dbSMatthew Booth 15697273a2dbSMatthew BoothCreate a new pseudo-terminal on the host and connect to it. @option{pty} does 15707273a2dbSMatthew Boothnot take any options. 15717273a2dbSMatthew Booth 15727273a2dbSMatthew Booth@option{pty} is not available on Windows hosts. 15737273a2dbSMatthew Booth 1574b7fdb3abSAurelien Jarno@item -chardev stdio ,id=@var{id} [,signal=on|off] 15757273a2dbSMatthew BoothConnect to standard input and standard output of the qemu process. 1576b7fdb3abSAurelien Jarno 1577b7fdb3abSAurelien Jarno@option{signal} controls if signals are enabled on the terminal, that includes 1578b7fdb3abSAurelien Jarnoexiting QEMU with the key sequence @key{Control-c}. This option is enabled by 1579b7fdb3abSAurelien Jarnodefault, use @option{signal=off} to disable it. 1580b7fdb3abSAurelien Jarno 1581b7fdb3abSAurelien Jarno@option{stdio} is not available on Windows hosts. 15827273a2dbSMatthew Booth 15837273a2dbSMatthew Booth@item -chardev braille ,id=@var{id} 15847273a2dbSMatthew Booth 15857273a2dbSMatthew BoothConnect to a local BrlAPI server. @option{braille} does not take any options. 15867273a2dbSMatthew Booth 15877273a2dbSMatthew Booth@item -chardev tty ,id=@var{id} ,path=@var{path} 15887273a2dbSMatthew Booth 15897273a2dbSMatthew BoothConnect to a local tty device. 15907273a2dbSMatthew Booth 15917273a2dbSMatthew Booth@option{tty} is only available on Linux, Sun, FreeBSD, NetBSD, OpenBSD and 15927273a2dbSMatthew BoothDragonFlyBSD hosts. 15937273a2dbSMatthew Booth 15947273a2dbSMatthew Booth@option{path} specifies the path to the tty. @option{path} is required. 15957273a2dbSMatthew Booth 15967273a2dbSMatthew Booth@item -chardev parport ,id=@var{id} ,path=@var{path} 15977273a2dbSMatthew Booth 15987273a2dbSMatthew Booth@option{parport} is only available on Linux, FreeBSD and DragonFlyBSD hosts. 15997273a2dbSMatthew Booth 16007273a2dbSMatthew BoothConnect to a local parallel port. 16017273a2dbSMatthew Booth 16027273a2dbSMatthew Booth@option{path} specifies the path to the parallel port device. @option{path} is 16037273a2dbSMatthew Boothrequired. 16047273a2dbSMatthew Booth 1605cbcc6336SAlon Levy#if defined(CONFIG_SPICE) 1606cbcc6336SAlon Levy@item -chardev spicevmc ,id=@var{id} ,debug=@var{debug}, name=@var{name} 1607cbcc6336SAlon Levy 1608cbcc6336SAlon Levy@option{debug} debug level for spicevmc 1609cbcc6336SAlon Levy 1610cbcc6336SAlon Levy@option{name} name of spice channel to connect to 1611cbcc6336SAlon Levy 1612cbcc6336SAlon LevyConnect to a spice virtual machine channel, such as vdiport. 1613cbcc6336SAlon Levy#endif 1614cbcc6336SAlon Levy 16157273a2dbSMatthew Booth@end table 16167273a2dbSMatthew BoothETEXI 16177273a2dbSMatthew Booth 16187273a2dbSMatthew BoothDEFHEADING() 16197273a2dbSMatthew Booth 16207273a2dbSMatthew BoothDEFHEADING(Bluetooth(R) options:) 16217273a2dbSMatthew Booth 16225824d651Sblueswir1DEF("bt", HAS_ARG, QEMU_OPTION_bt, \ 16235824d651Sblueswir1 "-bt hci,null dumb bluetooth HCI - doesn't respond to commands\n" \ 16245824d651Sblueswir1 "-bt hci,host[:id]\n" \ 16255824d651Sblueswir1 " use host's HCI with the given name\n" \ 16265824d651Sblueswir1 "-bt hci[,vlan=n]\n" \ 16275824d651Sblueswir1 " emulate a standard HCI in virtual scatternet 'n'\n" \ 16285824d651Sblueswir1 "-bt vhci[,vlan=n]\n" \ 16295824d651Sblueswir1 " add host computer to virtual scatternet 'n' using VHCI\n" \ 16305824d651Sblueswir1 "-bt device:dev[,vlan=n]\n" \ 1631ad96090aSBlue Swirl " emulate a bluetooth device 'dev' in scatternet 'n'\n", 1632ad96090aSBlue Swirl QEMU_ARCH_ALL) 16335824d651Sblueswir1STEXI 16345824d651Sblueswir1@table @option 16355824d651Sblueswir1 16365824d651Sblueswir1@item -bt hci[...] 16376616b2adSStefan Weil@findex -bt 16385824d651Sblueswir1Defines the function of the corresponding Bluetooth HCI. -bt options 16395824d651Sblueswir1are matched with the HCIs present in the chosen machine type. For 16405824d651Sblueswir1example when emulating a machine with only one HCI built into it, only 16415824d651Sblueswir1the first @code{-bt hci[...]} option is valid and defines the HCI's 16425824d651Sblueswir1logic. The Transport Layer is decided by the machine type. Currently 16435824d651Sblueswir1the machines @code{n800} and @code{n810} have one HCI and all other 16445824d651Sblueswir1machines have none. 16455824d651Sblueswir1 16465824d651Sblueswir1@anchor{bt-hcis} 16475824d651Sblueswir1The following three types are recognized: 16485824d651Sblueswir1 1649b3f046c2SKevin Wolf@table @option 16505824d651Sblueswir1@item -bt hci,null 16515824d651Sblueswir1(default) The corresponding Bluetooth HCI assumes no internal logic 16525824d651Sblueswir1and will not respond to any HCI commands or emit events. 16535824d651Sblueswir1 16545824d651Sblueswir1@item -bt hci,host[:@var{id}] 16555824d651Sblueswir1(@code{bluez} only) The corresponding HCI passes commands / events 16565824d651Sblueswir1to / from the physical HCI identified by the name @var{id} (default: 16575824d651Sblueswir1@code{hci0}) on the computer running QEMU. Only available on @code{bluez} 16585824d651Sblueswir1capable systems like Linux. 16595824d651Sblueswir1 16605824d651Sblueswir1@item -bt hci[,vlan=@var{n}] 16615824d651Sblueswir1Add a virtual, standard HCI that will participate in the Bluetooth 16625824d651Sblueswir1scatternet @var{n} (default @code{0}). Similarly to @option{-net} 16635824d651Sblueswir1VLANs, devices inside a bluetooth network @var{n} can only communicate 16645824d651Sblueswir1with other devices in the same network (scatternet). 16655824d651Sblueswir1@end table 16665824d651Sblueswir1 16675824d651Sblueswir1@item -bt vhci[,vlan=@var{n}] 16685824d651Sblueswir1(Linux-host only) Create a HCI in scatternet @var{n} (default 0) attached 16695824d651Sblueswir1to the host bluetooth stack instead of to the emulated target. This 16705824d651Sblueswir1allows the host and target machines to participate in a common scatternet 16715824d651Sblueswir1and communicate. Requires the Linux @code{vhci} driver installed. Can 16725824d651Sblueswir1be used as following: 16735824d651Sblueswir1 16745824d651Sblueswir1@example 16755824d651Sblueswir1qemu [...OPTIONS...] -bt hci,vlan=5 -bt vhci,vlan=5 16765824d651Sblueswir1@end example 16775824d651Sblueswir1 16785824d651Sblueswir1@item -bt device:@var{dev}[,vlan=@var{n}] 16795824d651Sblueswir1Emulate a bluetooth device @var{dev} and place it in network @var{n} 16805824d651Sblueswir1(default @code{0}). QEMU can only emulate one type of bluetooth devices 16815824d651Sblueswir1currently: 16825824d651Sblueswir1 1683b3f046c2SKevin Wolf@table @option 16845824d651Sblueswir1@item keyboard 16855824d651Sblueswir1Virtual wireless keyboard implementing the HIDP bluetooth profile. 16865824d651Sblueswir1@end table 16875824d651Sblueswir1@end table 16885824d651Sblueswir1ETEXI 16895824d651Sblueswir1 16905824d651Sblueswir1DEFHEADING() 16915824d651Sblueswir1 16927677f05dSAlexander GrafDEFHEADING(Linux/Multiboot boot specific:) 16935824d651Sblueswir1STEXI 16947677f05dSAlexander Graf 16957677f05dSAlexander GrafWhen using these options, you can use a given Linux or Multiboot 16967677f05dSAlexander Grafkernel without installing it in the disk image. It can be useful 16975824d651Sblueswir1for easier testing of various kernels. 16985824d651Sblueswir1 16995824d651Sblueswir1@table @option 17005824d651Sblueswir1ETEXI 17015824d651Sblueswir1 17025824d651Sblueswir1DEF("kernel", HAS_ARG, QEMU_OPTION_kernel, \ 1703ad96090aSBlue Swirl "-kernel bzImage use 'bzImage' as kernel image\n", QEMU_ARCH_ALL) 17045824d651Sblueswir1STEXI 17055824d651Sblueswir1@item -kernel @var{bzImage} 17066616b2adSStefan Weil@findex -kernel 17077677f05dSAlexander GrafUse @var{bzImage} as kernel image. The kernel can be either a Linux kernel 17087677f05dSAlexander Grafor in multiboot format. 17095824d651Sblueswir1ETEXI 17105824d651Sblueswir1 17115824d651Sblueswir1DEF("append", HAS_ARG, QEMU_OPTION_append, \ 1712ad96090aSBlue Swirl "-append cmdline use 'cmdline' as kernel command line\n", QEMU_ARCH_ALL) 17135824d651Sblueswir1STEXI 17145824d651Sblueswir1@item -append @var{cmdline} 17156616b2adSStefan Weil@findex -append 17165824d651Sblueswir1Use @var{cmdline} as kernel command line 17175824d651Sblueswir1ETEXI 17185824d651Sblueswir1 17195824d651Sblueswir1DEF("initrd", HAS_ARG, QEMU_OPTION_initrd, \ 1720ad96090aSBlue Swirl "-initrd file use 'file' as initial ram disk\n", QEMU_ARCH_ALL) 17215824d651Sblueswir1STEXI 17225824d651Sblueswir1@item -initrd @var{file} 17236616b2adSStefan Weil@findex -initrd 17245824d651Sblueswir1Use @var{file} as initial ram disk. 17257677f05dSAlexander Graf 17267677f05dSAlexander Graf@item -initrd "@var{file1} arg=foo,@var{file2}" 17277677f05dSAlexander Graf 17287677f05dSAlexander GrafThis syntax is only available with multiboot. 17297677f05dSAlexander Graf 17307677f05dSAlexander GrafUse @var{file1} and @var{file2} as modules and pass arg=foo as parameter to the 17317677f05dSAlexander Graffirst module. 17325824d651Sblueswir1ETEXI 17335824d651Sblueswir1 17345824d651Sblueswir1STEXI 17355824d651Sblueswir1@end table 17365824d651Sblueswir1ETEXI 17375824d651Sblueswir1 17385824d651Sblueswir1DEFHEADING() 17395824d651Sblueswir1 17405824d651Sblueswir1DEFHEADING(Debug/Expert options:) 17415824d651Sblueswir1 17425824d651Sblueswir1STEXI 17435824d651Sblueswir1@table @option 17445824d651Sblueswir1ETEXI 17455824d651Sblueswir1 17465824d651Sblueswir1DEF("serial", HAS_ARG, QEMU_OPTION_serial, \ 1747ad96090aSBlue Swirl "-serial dev redirect the serial port to char device 'dev'\n", 1748ad96090aSBlue Swirl QEMU_ARCH_ALL) 17495824d651Sblueswir1STEXI 17505824d651Sblueswir1@item -serial @var{dev} 17516616b2adSStefan Weil@findex -serial 17525824d651Sblueswir1Redirect the virtual serial port to host character device 17535824d651Sblueswir1@var{dev}. The default device is @code{vc} in graphical mode and 17545824d651Sblueswir1@code{stdio} in non graphical mode. 17555824d651Sblueswir1 17565824d651Sblueswir1This option can be used several times to simulate up to 4 serial 17575824d651Sblueswir1ports. 17585824d651Sblueswir1 17595824d651Sblueswir1Use @code{-serial none} to disable all serial ports. 17605824d651Sblueswir1 17615824d651Sblueswir1Available character devices are: 1762b3f046c2SKevin Wolf@table @option 17634e257e5eSKevin Wolf@item vc[:@var{W}x@var{H}] 17645824d651Sblueswir1Virtual console. Optionally, a width and height can be given in pixel with 17655824d651Sblueswir1@example 17665824d651Sblueswir1vc:800x600 17675824d651Sblueswir1@end example 17685824d651Sblueswir1It is also possible to specify width or height in characters: 17695824d651Sblueswir1@example 17705824d651Sblueswir1vc:80Cx24C 17715824d651Sblueswir1@end example 17725824d651Sblueswir1@item pty 17735824d651Sblueswir1[Linux only] Pseudo TTY (a new PTY is automatically allocated) 17745824d651Sblueswir1@item none 17755824d651Sblueswir1No device is allocated. 17765824d651Sblueswir1@item null 17775824d651Sblueswir1void device 17785824d651Sblueswir1@item /dev/XXX 17795824d651Sblueswir1[Linux only] Use host tty, e.g. @file{/dev/ttyS0}. The host serial port 17805824d651Sblueswir1parameters are set according to the emulated ones. 17815824d651Sblueswir1@item /dev/parport@var{N} 17825824d651Sblueswir1[Linux only, parallel port only] Use host parallel port 17835824d651Sblueswir1@var{N}. Currently SPP and EPP parallel port features can be used. 17845824d651Sblueswir1@item file:@var{filename} 17855824d651Sblueswir1Write output to @var{filename}. No character can be read. 17865824d651Sblueswir1@item stdio 17875824d651Sblueswir1[Unix only] standard input/output 17885824d651Sblueswir1@item pipe:@var{filename} 17895824d651Sblueswir1name pipe @var{filename} 17905824d651Sblueswir1@item COM@var{n} 17915824d651Sblueswir1[Windows only] Use host serial port @var{n} 17925824d651Sblueswir1@item udp:[@var{remote_host}]:@var{remote_port}[@@[@var{src_ip}]:@var{src_port}] 17935824d651Sblueswir1This implements UDP Net Console. 17945824d651Sblueswir1When @var{remote_host} or @var{src_ip} are not specified 17955824d651Sblueswir1they default to @code{0.0.0.0}. 17965824d651Sblueswir1When not using a specified @var{src_port} a random port is automatically chosen. 17975824d651Sblueswir1 17985824d651Sblueswir1If you just want a simple readonly console you can use @code{netcat} or 17995824d651Sblueswir1@code{nc}, by starting qemu with: @code{-serial udp::4555} and nc as: 18005824d651Sblueswir1@code{nc -u -l -p 4555}. Any time qemu writes something to that port it 18015824d651Sblueswir1will appear in the netconsole session. 18025824d651Sblueswir1 18035824d651Sblueswir1If you plan to send characters back via netconsole or you want to stop 18045824d651Sblueswir1and start qemu a lot of times, you should have qemu use the same 18055824d651Sblueswir1source port each time by using something like @code{-serial 18065824d651Sblueswir1udp::4555@@:4556} to qemu. Another approach is to use a patched 18075824d651Sblueswir1version of netcat which can listen to a TCP port and send and receive 18085824d651Sblueswir1characters via udp. If you have a patched version of netcat which 18095824d651Sblueswir1activates telnet remote echo and single char transfer, then you can 18105824d651Sblueswir1use the following options to step up a netcat redirector to allow 18115824d651Sblueswir1telnet on port 5555 to access the qemu port. 18125824d651Sblueswir1@table @code 18135824d651Sblueswir1@item Qemu Options: 18145824d651Sblueswir1-serial udp::4555@@:4556 18155824d651Sblueswir1@item netcat options: 18165824d651Sblueswir1-u -P 4555 -L 0.0.0.0:4556 -t -p 5555 -I -T 18175824d651Sblueswir1@item telnet options: 18185824d651Sblueswir1localhost 5555 18195824d651Sblueswir1@end table 18205824d651Sblueswir1 18215824d651Sblueswir1@item tcp:[@var{host}]:@var{port}[,@var{server}][,nowait][,nodelay] 18225824d651Sblueswir1The TCP Net Console has two modes of operation. It can send the serial 18235824d651Sblueswir1I/O to a location or wait for a connection from a location. By default 18245824d651Sblueswir1the TCP Net Console is sent to @var{host} at the @var{port}. If you use 18255824d651Sblueswir1the @var{server} option QEMU will wait for a client socket application 18265824d651Sblueswir1to connect to the port before continuing, unless the @code{nowait} 18275824d651Sblueswir1option was specified. The @code{nodelay} option disables the Nagle buffering 18285824d651Sblueswir1algorithm. If @var{host} is omitted, 0.0.0.0 is assumed. Only 18295824d651Sblueswir1one TCP connection at a time is accepted. You can use @code{telnet} to 18305824d651Sblueswir1connect to the corresponding character device. 18315824d651Sblueswir1@table @code 18325824d651Sblueswir1@item Example to send tcp console to 192.168.0.2 port 4444 18335824d651Sblueswir1-serial tcp:192.168.0.2:4444 18345824d651Sblueswir1@item Example to listen and wait on port 4444 for connection 18355824d651Sblueswir1-serial tcp::4444,server 18365824d651Sblueswir1@item Example to not wait and listen on ip 192.168.0.100 port 4444 18375824d651Sblueswir1-serial tcp:192.168.0.100:4444,server,nowait 18385824d651Sblueswir1@end table 18395824d651Sblueswir1 18405824d651Sblueswir1@item telnet:@var{host}:@var{port}[,server][,nowait][,nodelay] 18415824d651Sblueswir1The telnet protocol is used instead of raw tcp sockets. The options 18425824d651Sblueswir1work the same as if you had specified @code{-serial tcp}. The 18435824d651Sblueswir1difference is that the port acts like a telnet server or client using 18445824d651Sblueswir1telnet option negotiation. This will also allow you to send the 18455824d651Sblueswir1MAGIC_SYSRQ sequence if you use a telnet that supports sending the break 18465824d651Sblueswir1sequence. Typically in unix telnet you do it with Control-] and then 18475824d651Sblueswir1type "send break" followed by pressing the enter key. 18485824d651Sblueswir1 18495824d651Sblueswir1@item unix:@var{path}[,server][,nowait] 18505824d651Sblueswir1A unix domain socket is used instead of a tcp socket. The option works the 18515824d651Sblueswir1same as if you had specified @code{-serial tcp} except the unix domain socket 18525824d651Sblueswir1@var{path} is used for connections. 18535824d651Sblueswir1 18545824d651Sblueswir1@item mon:@var{dev_string} 18555824d651Sblueswir1This is a special option to allow the monitor to be multiplexed onto 18565824d651Sblueswir1another serial port. The monitor is accessed with key sequence of 18575824d651Sblueswir1@key{Control-a} and then pressing @key{c}. See monitor access 18585824d651Sblueswir1@ref{pcsys_keys} in the -nographic section for more keys. 18595824d651Sblueswir1@var{dev_string} should be any one of the serial devices specified 18605824d651Sblueswir1above. An example to multiplex the monitor onto a telnet server 18615824d651Sblueswir1listening on port 4444 would be: 18625824d651Sblueswir1@table @code 18635824d651Sblueswir1@item -serial mon:telnet::4444,server,nowait 18645824d651Sblueswir1@end table 18655824d651Sblueswir1 18665824d651Sblueswir1@item braille 18675824d651Sblueswir1Braille device. This will use BrlAPI to display the braille output on a real 18685824d651Sblueswir1or fake device. 18695824d651Sblueswir1 1870be8b28a9SKevin Wolf@item msmouse 1871be8b28a9SKevin WolfThree button serial mouse. Configure the guest to use Microsoft protocol. 18725824d651Sblueswir1@end table 18735824d651Sblueswir1ETEXI 18745824d651Sblueswir1 18755824d651Sblueswir1DEF("parallel", HAS_ARG, QEMU_OPTION_parallel, \ 1876ad96090aSBlue Swirl "-parallel dev redirect the parallel port to char device 'dev'\n", 1877ad96090aSBlue Swirl QEMU_ARCH_ALL) 18785824d651Sblueswir1STEXI 18795824d651Sblueswir1@item -parallel @var{dev} 18806616b2adSStefan Weil@findex -parallel 18815824d651Sblueswir1Redirect the virtual parallel port to host device @var{dev} (same 18825824d651Sblueswir1devices as the serial port). On Linux hosts, @file{/dev/parportN} can 18835824d651Sblueswir1be used to use hardware devices connected on the corresponding host 18845824d651Sblueswir1parallel port. 18855824d651Sblueswir1 18865824d651Sblueswir1This option can be used several times to simulate up to 3 parallel 18875824d651Sblueswir1ports. 18885824d651Sblueswir1 18895824d651Sblueswir1Use @code{-parallel none} to disable all parallel ports. 18905824d651Sblueswir1ETEXI 18915824d651Sblueswir1 18925824d651Sblueswir1DEF("monitor", HAS_ARG, QEMU_OPTION_monitor, \ 1893ad96090aSBlue Swirl "-monitor dev redirect the monitor to char device 'dev'\n", 1894ad96090aSBlue Swirl QEMU_ARCH_ALL) 18955824d651Sblueswir1STEXI 18964e307fc8SGerd Hoffmann@item -monitor @var{dev} 18976616b2adSStefan Weil@findex -monitor 18985824d651Sblueswir1Redirect the monitor to host device @var{dev} (same devices as the 18995824d651Sblueswir1serial port). 19005824d651Sblueswir1The default device is @code{vc} in graphical mode and @code{stdio} in 19015824d651Sblueswir1non graphical mode. 19025824d651Sblueswir1ETEXI 19036ca5582dSGerd HoffmannDEF("qmp", HAS_ARG, QEMU_OPTION_qmp, \ 1904ad96090aSBlue Swirl "-qmp dev like -monitor but opens in 'control' mode\n", 1905ad96090aSBlue Swirl QEMU_ARCH_ALL) 190695d5f08bSStefan WeilSTEXI 190795d5f08bSStefan Weil@item -qmp @var{dev} 19086616b2adSStefan Weil@findex -qmp 190995d5f08bSStefan WeilLike -monitor but opens in 'control' mode. 191095d5f08bSStefan WeilETEXI 19115824d651Sblueswir1 191222a0e04bSGerd HoffmannDEF("mon", HAS_ARG, QEMU_OPTION_mon, \ 1913ad96090aSBlue Swirl "-mon chardev=[name][,mode=readline|control][,default]\n", QEMU_ARCH_ALL) 191422a0e04bSGerd HoffmannSTEXI 191522a0e04bSGerd Hoffmann@item -mon chardev=[name][,mode=readline|control][,default] 19166616b2adSStefan Weil@findex -mon 191722a0e04bSGerd HoffmannSetup monitor on chardev @var{name}. 191822a0e04bSGerd HoffmannETEXI 191922a0e04bSGerd Hoffmann 1920c9f398e5SH. Peter AnvinDEF("debugcon", HAS_ARG, QEMU_OPTION_debugcon, \ 1921ad96090aSBlue Swirl "-debugcon dev redirect the debug console to char device 'dev'\n", 1922ad96090aSBlue Swirl QEMU_ARCH_ALL) 1923c9f398e5SH. Peter AnvinSTEXI 1924c9f398e5SH. Peter Anvin@item -debugcon @var{dev} 19256616b2adSStefan Weil@findex -debugcon 1926c9f398e5SH. Peter AnvinRedirect the debug console to host device @var{dev} (same devices as the 1927c9f398e5SH. Peter Anvinserial port). The debug console is an I/O port which is typically port 1928c9f398e5SH. Peter Anvin0xe9; writing to that I/O port sends output to this device. 1929c9f398e5SH. Peter AnvinThe default device is @code{vc} in graphical mode and @code{stdio} in 1930c9f398e5SH. Peter Anvinnon graphical mode. 1931c9f398e5SH. Peter AnvinETEXI 1932c9f398e5SH. Peter Anvin 19335824d651Sblueswir1DEF("pidfile", HAS_ARG, QEMU_OPTION_pidfile, \ 1934ad96090aSBlue Swirl "-pidfile file write PID to 'file'\n", QEMU_ARCH_ALL) 19355824d651Sblueswir1STEXI 19365824d651Sblueswir1@item -pidfile @var{file} 19376616b2adSStefan Weil@findex -pidfile 19385824d651Sblueswir1Store the QEMU process PID in @var{file}. It is useful if you launch QEMU 19395824d651Sblueswir1from a script. 19405824d651Sblueswir1ETEXI 19415824d651Sblueswir1 19421b530a6dSaurel32DEF("singlestep", 0, QEMU_OPTION_singlestep, \ 1943ad96090aSBlue Swirl "-singlestep always run in singlestep mode\n", QEMU_ARCH_ALL) 19441b530a6dSaurel32STEXI 19451b530a6dSaurel32@item -singlestep 19466616b2adSStefan Weil@findex -singlestep 19471b530a6dSaurel32Run the emulation in single step mode. 19481b530a6dSaurel32ETEXI 19491b530a6dSaurel32 19505824d651Sblueswir1DEF("S", 0, QEMU_OPTION_S, \ 1951ad96090aSBlue Swirl "-S freeze CPU at startup (use 'c' to start execution)\n", 1952ad96090aSBlue Swirl QEMU_ARCH_ALL) 19535824d651Sblueswir1STEXI 19545824d651Sblueswir1@item -S 19556616b2adSStefan Weil@findex -S 19565824d651Sblueswir1Do not start CPU at startup (you must type 'c' in the monitor). 19575824d651Sblueswir1ETEXI 19585824d651Sblueswir1 195959030a8cSaliguoriDEF("gdb", HAS_ARG, QEMU_OPTION_gdb, \ 1960ad96090aSBlue Swirl "-gdb dev wait for gdb connection on 'dev'\n", QEMU_ARCH_ALL) 19615824d651Sblueswir1STEXI 196259030a8cSaliguori@item -gdb @var{dev} 19636616b2adSStefan Weil@findex -gdb 196459030a8cSaliguoriWait for gdb connection on device @var{dev} (@pxref{gdb_usage}). Typical 196559030a8cSaliguoriconnections will likely be TCP-based, but also UDP, pseudo TTY, or even 196659030a8cSaliguoristdio are reasonable use case. The latter is allowing to start qemu from 196759030a8cSaliguoriwithin gdb and establish the connection via a pipe: 196859030a8cSaliguori@example 196959030a8cSaliguori(gdb) target remote | exec qemu -gdb stdio ... 197059030a8cSaliguori@end example 19715824d651Sblueswir1ETEXI 19725824d651Sblueswir1 197359030a8cSaliguoriDEF("s", 0, QEMU_OPTION_s, \ 1974ad96090aSBlue Swirl "-s shorthand for -gdb tcp::" DEFAULT_GDBSTUB_PORT "\n", 1975ad96090aSBlue Swirl QEMU_ARCH_ALL) 19765824d651Sblueswir1STEXI 197759030a8cSaliguori@item -s 19786616b2adSStefan Weil@findex -s 197959030a8cSaliguoriShorthand for -gdb tcp::1234, i.e. open a gdbserver on TCP port 1234 198059030a8cSaliguori(@pxref{gdb_usage}). 19815824d651Sblueswir1ETEXI 19825824d651Sblueswir1 19835824d651Sblueswir1DEF("d", HAS_ARG, QEMU_OPTION_d, \ 1984ad96090aSBlue Swirl "-d item1,... output log to /tmp/qemu.log (use -d ? for a list of log items)\n", 1985ad96090aSBlue Swirl QEMU_ARCH_ALL) 19865824d651Sblueswir1STEXI 19875824d651Sblueswir1@item -d 19886616b2adSStefan Weil@findex -d 19895824d651Sblueswir1Output log in /tmp/qemu.log 19905824d651Sblueswir1ETEXI 19915824d651Sblueswir1 19925824d651Sblueswir1DEF("hdachs", HAS_ARG, QEMU_OPTION_hdachs, \ 19935824d651Sblueswir1 "-hdachs c,h,s[,t]\n" \ 19945824d651Sblueswir1 " force hard disk 0 physical geometry and the optional BIOS\n" \ 1995ad96090aSBlue Swirl " translation (t=none or lba) (usually qemu can guess them)\n", 1996ad96090aSBlue Swirl QEMU_ARCH_ALL) 19975824d651Sblueswir1STEXI 19985824d651Sblueswir1@item -hdachs @var{c},@var{h},@var{s},[,@var{t}] 19996616b2adSStefan Weil@findex -hdachs 20005824d651Sblueswir1Force hard disk 0 physical geometry (1 <= @var{c} <= 16383, 1 <= 20015824d651Sblueswir1@var{h} <= 16, 1 <= @var{s} <= 63) and optionally force the BIOS 20025824d651Sblueswir1translation mode (@var{t}=none, lba or auto). Usually QEMU can guess 20035824d651Sblueswir1all those parameters. This option is useful for old MS-DOS disk 20045824d651Sblueswir1images. 20055824d651Sblueswir1ETEXI 20065824d651Sblueswir1 20075824d651Sblueswir1DEF("L", HAS_ARG, QEMU_OPTION_L, \ 2008ad96090aSBlue Swirl "-L path set the directory for the BIOS, VGA BIOS and keymaps\n", 2009ad96090aSBlue Swirl QEMU_ARCH_ALL) 20105824d651Sblueswir1STEXI 20115824d651Sblueswir1@item -L @var{path} 20126616b2adSStefan Weil@findex -L 20135824d651Sblueswir1Set the directory for the BIOS, VGA BIOS and keymaps. 20145824d651Sblueswir1ETEXI 20155824d651Sblueswir1 20165824d651Sblueswir1DEF("bios", HAS_ARG, QEMU_OPTION_bios, \ 2017ad96090aSBlue Swirl "-bios file set the filename for the BIOS\n", QEMU_ARCH_ALL) 20185824d651Sblueswir1STEXI 20195824d651Sblueswir1@item -bios @var{file} 20206616b2adSStefan Weil@findex -bios 20215824d651Sblueswir1Set the filename for the BIOS. 20225824d651Sblueswir1ETEXI 20235824d651Sblueswir1 20245824d651Sblueswir1DEF("enable-kvm", 0, QEMU_OPTION_enable_kvm, \ 2025ad96090aSBlue Swirl "-enable-kvm enable KVM full virtualization support\n", QEMU_ARCH_ALL) 20265824d651Sblueswir1STEXI 20275824d651Sblueswir1@item -enable-kvm 20286616b2adSStefan Weil@findex -enable-kvm 20295824d651Sblueswir1Enable KVM full virtualization support. This option is only available 20305824d651Sblueswir1if KVM support is enabled when compiling. 20315824d651Sblueswir1ETEXI 20325824d651Sblueswir1 2033*303d4e86SAnthony PERARDDEF("machine", HAS_ARG, QEMU_OPTION_machine, \ 2034*303d4e86SAnthony PERARD "-machine accel=accel1[:accel2] use an accelerator (kvm,xen,tcg), default is tcg\n", QEMU_ARCH_ALL) 2035*303d4e86SAnthony PERARDSTEXI 2036*303d4e86SAnthony PERARD@item -machine accel=@var{accels} 2037*303d4e86SAnthony PERARD@findex -machine 2038*303d4e86SAnthony PERARDThis is use to enable an accelerator, in kvm,xen,tcg. 2039*303d4e86SAnthony PERARDBy default, it use only tcg. If there a more than one accelerator 2040*303d4e86SAnthony PERARDspecified, the next one is used if the first don't work. 2041*303d4e86SAnthony PERARDETEXI 2042*303d4e86SAnthony PERARD 2043e37630caSaliguoriDEF("xen-domid", HAS_ARG, QEMU_OPTION_xen_domid, 2044ad96090aSBlue Swirl "-xen-domid id specify xen guest domain id\n", QEMU_ARCH_ALL) 2045e37630caSaliguoriDEF("xen-create", 0, QEMU_OPTION_xen_create, 2046e37630caSaliguori "-xen-create create domain using xen hypercalls, bypassing xend\n" 2047ad96090aSBlue Swirl " warning: should not be used when xend is in use\n", 2048ad96090aSBlue Swirl QEMU_ARCH_ALL) 2049e37630caSaliguoriDEF("xen-attach", 0, QEMU_OPTION_xen_attach, 2050e37630caSaliguori "-xen-attach attach to existing xen domain\n" 2051ad96090aSBlue Swirl " xend will use this when starting qemu\n", 2052ad96090aSBlue Swirl QEMU_ARCH_ALL) 205395d5f08bSStefan WeilSTEXI 205495d5f08bSStefan Weil@item -xen-domid @var{id} 20556616b2adSStefan Weil@findex -xen-domid 205695d5f08bSStefan WeilSpecify xen guest domain @var{id} (XEN only). 205795d5f08bSStefan Weil@item -xen-create 20586616b2adSStefan Weil@findex -xen-create 205995d5f08bSStefan WeilCreate domain using xen hypercalls, bypassing xend. 206095d5f08bSStefan WeilWarning: should not be used when xend is in use (XEN only). 206195d5f08bSStefan Weil@item -xen-attach 20626616b2adSStefan Weil@findex -xen-attach 206395d5f08bSStefan WeilAttach to existing xen domain. 206495d5f08bSStefan Weilxend will use this when starting qemu (XEN only). 206595d5f08bSStefan WeilETEXI 2066e37630caSaliguori 20675824d651Sblueswir1DEF("no-reboot", 0, QEMU_OPTION_no_reboot, \ 2068ad96090aSBlue Swirl "-no-reboot exit instead of rebooting\n", QEMU_ARCH_ALL) 20695824d651Sblueswir1STEXI 20705824d651Sblueswir1@item -no-reboot 20716616b2adSStefan Weil@findex -no-reboot 20725824d651Sblueswir1Exit instead of rebooting. 20735824d651Sblueswir1ETEXI 20745824d651Sblueswir1 20755824d651Sblueswir1DEF("no-shutdown", 0, QEMU_OPTION_no_shutdown, \ 2076ad96090aSBlue Swirl "-no-shutdown stop before shutdown\n", QEMU_ARCH_ALL) 20775824d651Sblueswir1STEXI 20785824d651Sblueswir1@item -no-shutdown 20796616b2adSStefan Weil@findex -no-shutdown 20805824d651Sblueswir1Don't exit QEMU on guest shutdown, but instead only stop the emulation. 20815824d651Sblueswir1This allows for instance switching to monitor to commit changes to the 20825824d651Sblueswir1disk image. 20835824d651Sblueswir1ETEXI 20845824d651Sblueswir1 20855824d651Sblueswir1DEF("loadvm", HAS_ARG, QEMU_OPTION_loadvm, \ 20865824d651Sblueswir1 "-loadvm [tag|id]\n" \ 2087ad96090aSBlue Swirl " start right away with a saved state (loadvm in monitor)\n", 2088ad96090aSBlue Swirl QEMU_ARCH_ALL) 20895824d651Sblueswir1STEXI 20905824d651Sblueswir1@item -loadvm @var{file} 20916616b2adSStefan Weil@findex -loadvm 20925824d651Sblueswir1Start right away with a saved state (@code{loadvm} in monitor) 20935824d651Sblueswir1ETEXI 20945824d651Sblueswir1 20955824d651Sblueswir1#ifndef _WIN32 20965824d651Sblueswir1DEF("daemonize", 0, QEMU_OPTION_daemonize, \ 2097ad96090aSBlue Swirl "-daemonize daemonize QEMU after initializing\n", QEMU_ARCH_ALL) 20985824d651Sblueswir1#endif 20995824d651Sblueswir1STEXI 21005824d651Sblueswir1@item -daemonize 21016616b2adSStefan Weil@findex -daemonize 21025824d651Sblueswir1Daemonize the QEMU process after initialization. QEMU will not detach from 21035824d651Sblueswir1standard IO until it is ready to receive connections on any of its devices. 21045824d651Sblueswir1This option is a useful way for external programs to launch QEMU without having 21055824d651Sblueswir1to cope with initialization race conditions. 21065824d651Sblueswir1ETEXI 21075824d651Sblueswir1 21085824d651Sblueswir1DEF("option-rom", HAS_ARG, QEMU_OPTION_option_rom, \ 2109ad96090aSBlue Swirl "-option-rom rom load a file, rom, into the option ROM space\n", 2110ad96090aSBlue Swirl QEMU_ARCH_ALL) 21115824d651Sblueswir1STEXI 21125824d651Sblueswir1@item -option-rom @var{file} 21136616b2adSStefan Weil@findex -option-rom 21145824d651Sblueswir1Load the contents of @var{file} as an option ROM. 21155824d651Sblueswir1This option is useful to load things like EtherBoot. 21165824d651Sblueswir1ETEXI 21175824d651Sblueswir1 21185824d651Sblueswir1DEF("clock", HAS_ARG, QEMU_OPTION_clock, \ 21195824d651Sblueswir1 "-clock force the use of the given methods for timer alarm.\n" \ 2120ad96090aSBlue Swirl " To see what timers are available use -clock ?\n", 2121ad96090aSBlue Swirl QEMU_ARCH_ALL) 21225824d651Sblueswir1STEXI 21235824d651Sblueswir1@item -clock @var{method} 21246616b2adSStefan Weil@findex -clock 21255824d651Sblueswir1Force the use of the given methods for timer alarm. To see what timers 21265824d651Sblueswir1are available use -clock ?. 21275824d651Sblueswir1ETEXI 21285824d651Sblueswir1 21291ed2fc1fSJan KiszkaHXCOMM Options deprecated by -rtc 2130ad96090aSBlue SwirlDEF("localtime", 0, QEMU_OPTION_localtime, "", QEMU_ARCH_ALL) 2131ad96090aSBlue SwirlDEF("startdate", HAS_ARG, QEMU_OPTION_startdate, "", QEMU_ARCH_ALL) 21325824d651Sblueswir1 21331ed2fc1fSJan KiszkaDEF("rtc", HAS_ARG, QEMU_OPTION_rtc, \ 21346875204cSJan Kiszka "-rtc [base=utc|localtime|date][,clock=host|vm][,driftfix=none|slew]\n" \ 2135ad96090aSBlue Swirl " set the RTC base and clock, enable drift fix for clock ticks (x86 only)\n", 2136ad96090aSBlue Swirl QEMU_ARCH_ALL) 21371ed2fc1fSJan Kiszka 21385824d651Sblueswir1STEXI 21395824d651Sblueswir1 21406875204cSJan Kiszka@item -rtc [base=utc|localtime|@var{date}][,clock=host|vm][,driftfix=none|slew] 21416616b2adSStefan Weil@findex -rtc 21421ed2fc1fSJan KiszkaSpecify @option{base} as @code{utc} or @code{localtime} to let the RTC start at the current 21431ed2fc1fSJan KiszkaUTC or local time, respectively. @code{localtime} is required for correct date in 21441ed2fc1fSJan KiszkaMS-DOS or Windows. To start at a specific point in time, provide @var{date} in the 21451ed2fc1fSJan Kiszkaformat @code{2006-06-17T16:01:21} or @code{2006-06-17}. The default base is UTC. 21461ed2fc1fSJan Kiszka 21476875204cSJan KiszkaBy default the RTC is driven by the host system time. This allows to use the 21486875204cSJan KiszkaRTC as accurate reference clock inside the guest, specifically if the host 21496875204cSJan Kiszkatime is smoothly following an accurate external reference clock, e.g. via NTP. 21506875204cSJan KiszkaIf you want to isolate the guest time from the host, even prevent it from 21516875204cSJan Kiszkaprogressing during suspension, you can set @option{clock} to @code{vm} instead. 21526875204cSJan Kiszka 21531ed2fc1fSJan KiszkaEnable @option{driftfix} (i386 targets only) if you experience time drift problems, 21541ed2fc1fSJan Kiszkaspecifically with Windows' ACPI HAL. This option will try to figure out how 21551ed2fc1fSJan Kiszkamany timer interrupts were not processed by the Windows guest and will 21561ed2fc1fSJan Kiszkare-inject them. 21575824d651Sblueswir1ETEXI 21585824d651Sblueswir1 21595824d651Sblueswir1DEF("icount", HAS_ARG, QEMU_OPTION_icount, \ 21605824d651Sblueswir1 "-icount [N|auto]\n" \ 2161bc14ca24Saliguori " enable virtual instruction counter with 2^N clock ticks per\n" \ 2162ad96090aSBlue Swirl " instruction\n", QEMU_ARCH_ALL) 21635824d651Sblueswir1STEXI 21644e257e5eSKevin Wolf@item -icount [@var{N}|auto] 21656616b2adSStefan Weil@findex -icount 21665824d651Sblueswir1Enable virtual instruction counter. The virtual cpu will execute one 21674e257e5eSKevin Wolfinstruction every 2^@var{N} ns of virtual time. If @code{auto} is specified 21685824d651Sblueswir1then the virtual cpu speed will be automatically adjusted to keep virtual 21695824d651Sblueswir1time within a few seconds of real time. 21705824d651Sblueswir1 21715824d651Sblueswir1Note that while this option can give deterministic behavior, it does not 21725824d651Sblueswir1provide cycle accurate emulation. Modern CPUs contain superscalar out of 21735824d651Sblueswir1order cores with complex cache hierarchies. The number of instructions 21745824d651Sblueswir1executed often has little or no correlation with actual performance. 21755824d651Sblueswir1ETEXI 21765824d651Sblueswir1 21779dd986ccSRichard W.M. JonesDEF("watchdog", HAS_ARG, QEMU_OPTION_watchdog, \ 21789dd986ccSRichard W.M. Jones "-watchdog i6300esb|ib700\n" \ 2179ad96090aSBlue Swirl " enable virtual hardware watchdog [default=none]\n", 2180ad96090aSBlue Swirl QEMU_ARCH_ALL) 21819dd986ccSRichard W.M. JonesSTEXI 21829dd986ccSRichard W.M. Jones@item -watchdog @var{model} 21836616b2adSStefan Weil@findex -watchdog 21849dd986ccSRichard W.M. JonesCreate a virtual hardware watchdog device. Once enabled (by a guest 21859dd986ccSRichard W.M. Jonesaction), the watchdog must be periodically polled by an agent inside 21869dd986ccSRichard W.M. Jonesthe guest or else the guest will be restarted. 21879dd986ccSRichard W.M. Jones 21889dd986ccSRichard W.M. JonesThe @var{model} is the model of hardware watchdog to emulate. Choices 21899dd986ccSRichard W.M. Jonesfor model are: @code{ib700} (iBASE 700) which is a very simple ISA 21909dd986ccSRichard W.M. Joneswatchdog with a single timer, or @code{i6300esb} (Intel 6300ESB I/O 21919dd986ccSRichard W.M. Jonescontroller hub) which is a much more featureful PCI-based dual-timer 21929dd986ccSRichard W.M. Joneswatchdog. Choose a model for which your guest has drivers. 21939dd986ccSRichard W.M. Jones 21949dd986ccSRichard W.M. JonesUse @code{-watchdog ?} to list available hardware models. Only one 21959dd986ccSRichard W.M. Joneswatchdog can be enabled for a guest. 21969dd986ccSRichard W.M. JonesETEXI 21979dd986ccSRichard W.M. Jones 21989dd986ccSRichard W.M. JonesDEF("watchdog-action", HAS_ARG, QEMU_OPTION_watchdog_action, \ 21999dd986ccSRichard W.M. Jones "-watchdog-action reset|shutdown|poweroff|pause|debug|none\n" \ 2200ad96090aSBlue Swirl " action when watchdog fires [default=reset]\n", 2201ad96090aSBlue Swirl QEMU_ARCH_ALL) 22029dd986ccSRichard W.M. JonesSTEXI 22039dd986ccSRichard W.M. Jones@item -watchdog-action @var{action} 22049dd986ccSRichard W.M. Jones 22059dd986ccSRichard W.M. JonesThe @var{action} controls what QEMU will do when the watchdog timer 22069dd986ccSRichard W.M. Jonesexpires. 22079dd986ccSRichard W.M. JonesThe default is 22089dd986ccSRichard W.M. Jones@code{reset} (forcefully reset the guest). 22099dd986ccSRichard W.M. JonesOther possible actions are: 22109dd986ccSRichard W.M. Jones@code{shutdown} (attempt to gracefully shutdown the guest), 22119dd986ccSRichard W.M. Jones@code{poweroff} (forcefully poweroff the guest), 22129dd986ccSRichard W.M. Jones@code{pause} (pause the guest), 22139dd986ccSRichard W.M. Jones@code{debug} (print a debug message and continue), or 22149dd986ccSRichard W.M. Jones@code{none} (do nothing). 22159dd986ccSRichard W.M. Jones 22169dd986ccSRichard W.M. JonesNote that the @code{shutdown} action requires that the guest responds 22179dd986ccSRichard W.M. Jonesto ACPI signals, which it may not be able to do in the sort of 22189dd986ccSRichard W.M. Jonessituations where the watchdog would have expired, and thus 22199dd986ccSRichard W.M. Jones@code{-watchdog-action shutdown} is not recommended for production use. 22209dd986ccSRichard W.M. Jones 22219dd986ccSRichard W.M. JonesExamples: 22229dd986ccSRichard W.M. Jones 22239dd986ccSRichard W.M. Jones@table @code 22249dd986ccSRichard W.M. Jones@item -watchdog i6300esb -watchdog-action pause 22259dd986ccSRichard W.M. Jones@item -watchdog ib700 22269dd986ccSRichard W.M. Jones@end table 22279dd986ccSRichard W.M. JonesETEXI 22289dd986ccSRichard W.M. Jones 22295824d651Sblueswir1DEF("echr", HAS_ARG, QEMU_OPTION_echr, \ 2230ad96090aSBlue Swirl "-echr chr set terminal escape character instead of ctrl-a\n", 2231ad96090aSBlue Swirl QEMU_ARCH_ALL) 22325824d651Sblueswir1STEXI 22335824d651Sblueswir1 22344e257e5eSKevin Wolf@item -echr @var{numeric_ascii_value} 22356616b2adSStefan Weil@findex -echr 22365824d651Sblueswir1Change the escape character used for switching to the monitor when using 22375824d651Sblueswir1monitor and serial sharing. The default is @code{0x01} when using the 22385824d651Sblueswir1@code{-nographic} option. @code{0x01} is equal to pressing 22395824d651Sblueswir1@code{Control-a}. You can select a different character from the ascii 22405824d651Sblueswir1control keys where 1 through 26 map to Control-a through Control-z. For 22415824d651Sblueswir1instance you could use the either of the following to change the escape 22425824d651Sblueswir1character to Control-t. 22435824d651Sblueswir1@table @code 22445824d651Sblueswir1@item -echr 0x14 22455824d651Sblueswir1@item -echr 20 22465824d651Sblueswir1@end table 22475824d651Sblueswir1ETEXI 22485824d651Sblueswir1 22495824d651Sblueswir1DEF("virtioconsole", HAS_ARG, QEMU_OPTION_virtiocon, \ 22505824d651Sblueswir1 "-virtioconsole c\n" \ 2251ad96090aSBlue Swirl " set virtio console\n", QEMU_ARCH_ALL) 22525824d651Sblueswir1STEXI 22535824d651Sblueswir1@item -virtioconsole @var{c} 22546616b2adSStefan Weil@findex -virtioconsole 22555824d651Sblueswir1Set virtio console. 225698b19252SAmit Shah 225798b19252SAmit ShahThis option is maintained for backward compatibility. 225898b19252SAmit Shah 225998b19252SAmit ShahPlease use @code{-device virtconsole} for the new way of invocation. 22605824d651Sblueswir1ETEXI 22615824d651Sblueswir1 22625824d651Sblueswir1DEF("show-cursor", 0, QEMU_OPTION_show_cursor, \ 2263ad96090aSBlue Swirl "-show-cursor show cursor\n", QEMU_ARCH_ALL) 22645824d651Sblueswir1STEXI 226595d5f08bSStefan Weil@item -show-cursor 22666616b2adSStefan Weil@findex -show-cursor 226795d5f08bSStefan WeilShow cursor. 22685824d651Sblueswir1ETEXI 22695824d651Sblueswir1 22705824d651Sblueswir1DEF("tb-size", HAS_ARG, QEMU_OPTION_tb_size, \ 2271ad96090aSBlue Swirl "-tb-size n set TB size\n", QEMU_ARCH_ALL) 22725824d651Sblueswir1STEXI 227395d5f08bSStefan Weil@item -tb-size @var{n} 22746616b2adSStefan Weil@findex -tb-size 227595d5f08bSStefan WeilSet TB size. 22765824d651Sblueswir1ETEXI 22775824d651Sblueswir1 22785824d651Sblueswir1DEF("incoming", HAS_ARG, QEMU_OPTION_incoming, \ 2279ad96090aSBlue Swirl "-incoming p prepare for incoming migration, listen on port p\n", 2280ad96090aSBlue Swirl QEMU_ARCH_ALL) 22815824d651Sblueswir1STEXI 228295d5f08bSStefan Weil@item -incoming @var{port} 22836616b2adSStefan Weil@findex -incoming 228495d5f08bSStefan WeilPrepare for incoming migration, listen on @var{port}. 22855824d651Sblueswir1ETEXI 22865824d651Sblueswir1 2287d8c208ddSGerd HoffmannDEF("nodefaults", 0, QEMU_OPTION_nodefaults, \ 2288ad96090aSBlue Swirl "-nodefaults don't create default devices\n", QEMU_ARCH_ALL) 2289d8c208ddSGerd HoffmannSTEXI 22903dbf2c7fSStefan Weil@item -nodefaults 22916616b2adSStefan Weil@findex -nodefaults 22923dbf2c7fSStefan WeilDon't create default devices. 2293d8c208ddSGerd HoffmannETEXI 2294d8c208ddSGerd Hoffmann 22955824d651Sblueswir1#ifndef _WIN32 22965824d651Sblueswir1DEF("chroot", HAS_ARG, QEMU_OPTION_chroot, \ 2297ad96090aSBlue Swirl "-chroot dir chroot to dir just before starting the VM\n", 2298ad96090aSBlue Swirl QEMU_ARCH_ALL) 22995824d651Sblueswir1#endif 23005824d651Sblueswir1STEXI 23014e257e5eSKevin Wolf@item -chroot @var{dir} 23026616b2adSStefan Weil@findex -chroot 23035824d651Sblueswir1Immediately before starting guest execution, chroot to the specified 23045824d651Sblueswir1directory. Especially useful in combination with -runas. 23055824d651Sblueswir1ETEXI 23065824d651Sblueswir1 23075824d651Sblueswir1#ifndef _WIN32 23085824d651Sblueswir1DEF("runas", HAS_ARG, QEMU_OPTION_runas, \ 2309ad96090aSBlue Swirl "-runas user change to user id user just before starting the VM\n", 2310ad96090aSBlue Swirl QEMU_ARCH_ALL) 23115824d651Sblueswir1#endif 23125824d651Sblueswir1STEXI 23134e257e5eSKevin Wolf@item -runas @var{user} 23146616b2adSStefan Weil@findex -runas 23155824d651Sblueswir1Immediately before starting guest execution, drop root privileges, switching 23165824d651Sblueswir1to the specified user. 23175824d651Sblueswir1ETEXI 23185824d651Sblueswir1 23195824d651Sblueswir1DEF("prom-env", HAS_ARG, QEMU_OPTION_prom_env, 23205824d651Sblueswir1 "-prom-env variable=value\n" 2321ad96090aSBlue Swirl " set OpenBIOS nvram variables\n", 2322ad96090aSBlue Swirl QEMU_ARCH_PPC | QEMU_ARCH_SPARC) 232395d5f08bSStefan WeilSTEXI 232495d5f08bSStefan Weil@item -prom-env @var{variable}=@var{value} 23256616b2adSStefan Weil@findex -prom-env 232695d5f08bSStefan WeilSet OpenBIOS nvram @var{variable} to given @var{value} (PPC, SPARC only). 232795d5f08bSStefan WeilETEXI 23285824d651Sblueswir1DEF("semihosting", 0, QEMU_OPTION_semihosting, 2329ad96090aSBlue Swirl "-semihosting semihosting mode\n", QEMU_ARCH_ARM | QEMU_ARCH_M68K) 233095d5f08bSStefan WeilSTEXI 233195d5f08bSStefan Weil@item -semihosting 23326616b2adSStefan Weil@findex -semihosting 233395d5f08bSStefan WeilSemihosting mode (ARM, M68K only). 233495d5f08bSStefan WeilETEXI 23355824d651Sblueswir1DEF("old-param", 0, QEMU_OPTION_old_param, 2336ad96090aSBlue Swirl "-old-param old param mode\n", QEMU_ARCH_ARM) 233795d5f08bSStefan WeilSTEXI 233895d5f08bSStefan Weil@item -old-param 23396616b2adSStefan Weil@findex -old-param (ARM) 234095d5f08bSStefan WeilOld param mode (ARM only). 234195d5f08bSStefan WeilETEXI 234295d5f08bSStefan Weil 2343715a664aSGerd HoffmannDEF("readconfig", HAS_ARG, QEMU_OPTION_readconfig, 2344ad96090aSBlue Swirl "-readconfig <file>\n", QEMU_ARCH_ALL) 23453dbf2c7fSStefan WeilSTEXI 23463dbf2c7fSStefan Weil@item -readconfig @var{file} 23476616b2adSStefan Weil@findex -readconfig 23483dbf2c7fSStefan WeilRead device configuration from @var{file}. 23493dbf2c7fSStefan WeilETEXI 2350715a664aSGerd HoffmannDEF("writeconfig", HAS_ARG, QEMU_OPTION_writeconfig, 2351715a664aSGerd Hoffmann "-writeconfig <file>\n" 2352ad96090aSBlue Swirl " read/write config file\n", QEMU_ARCH_ALL) 23533dbf2c7fSStefan WeilSTEXI 23543dbf2c7fSStefan Weil@item -writeconfig @var{file} 23556616b2adSStefan Weil@findex -writeconfig 23563dbf2c7fSStefan WeilWrite device configuration to @var{file}. 23573dbf2c7fSStefan WeilETEXI 2358292444cbSAnthony LiguoriDEF("nodefconfig", 0, QEMU_OPTION_nodefconfig, 2359292444cbSAnthony Liguori "-nodefconfig\n" 2360ad96090aSBlue Swirl " do not load default config files at startup\n", 2361ad96090aSBlue Swirl QEMU_ARCH_ALL) 2362292444cbSAnthony LiguoriSTEXI 2363292444cbSAnthony Liguori@item -nodefconfig 23646616b2adSStefan Weil@findex -nodefconfig 2365292444cbSAnthony LiguoriNormally QEMU loads a configuration file from @var{sysconfdir}/qemu.conf and 2366292444cbSAnthony Liguori@var{sysconfdir}/target-@var{ARCH}.conf on startup. The @code{-nodefconfig} 2367292444cbSAnthony Liguorioption will prevent QEMU from loading these configuration files at startup. 2368292444cbSAnthony LiguoriETEXI 2369ab6540d5SPrerna Saxena#ifdef CONFIG_SIMPLE_TRACE 2370ab6540d5SPrerna SaxenaDEF("trace", HAS_ARG, QEMU_OPTION_trace, 2371ab6540d5SPrerna Saxena "-trace\n" 2372ab6540d5SPrerna Saxena " Specify a trace file to log traces to\n", 2373ab6540d5SPrerna Saxena QEMU_ARCH_ALL) 2374ab6540d5SPrerna SaxenaSTEXI 2375ab6540d5SPrerna Saxena@item -trace 2376ab6540d5SPrerna Saxena@findex -trace 2377ab6540d5SPrerna SaxenaSpecify a trace file to log output traces to. 2378ab6540d5SPrerna SaxenaETEXI 2379ab6540d5SPrerna Saxena#endif 23803dbf2c7fSStefan Weil 23813dbf2c7fSStefan WeilHXCOMM This is the last statement. Insert new options before this line! 23823dbf2c7fSStefan WeilSTEXI 23833dbf2c7fSStefan Weil@end table 23843dbf2c7fSStefan WeilETEXI 2385