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 665de1db2a1SBrad HardsUse Ctrl-Alt-Shift to grab mouse (instead of Ctrl-Alt). Note that this also 666de1db2a1SBrad Hardsaffects the special keys (for fullscreen, monitor-mode switching, etc). 6675824d651Sblueswir1ETEXI 6685824d651Sblueswir1 6690ca9f8a4SDustin KirklandDEF("ctrl-grab", 0, QEMU_OPTION_ctrl_grab, 670ad96090aSBlue Swirl "-ctrl-grab use Right-Ctrl to grab mouse (instead of Ctrl-Alt)\n", 671ad96090aSBlue Swirl QEMU_ARCH_ALL) 6720ca9f8a4SDustin KirklandSTEXI 6730ca9f8a4SDustin Kirkland@item -ctrl-grab 6746616b2adSStefan Weil@findex -ctrl-grab 675de1db2a1SBrad HardsUse Right-Ctrl to grab mouse (instead of Ctrl-Alt). Note that this also 676de1db2a1SBrad Hardsaffects the special keys (for fullscreen, monitor-mode switching, etc). 6770ca9f8a4SDustin KirklandETEXI 6780ca9f8a4SDustin Kirkland 6795824d651Sblueswir1DEF("no-quit", 0, QEMU_OPTION_no_quit, 680ad96090aSBlue Swirl "-no-quit disable SDL window close capability\n", QEMU_ARCH_ALL) 6815824d651Sblueswir1STEXI 6825824d651Sblueswir1@item -no-quit 6836616b2adSStefan Weil@findex -no-quit 6845824d651Sblueswir1Disable SDL window close capability. 6855824d651Sblueswir1ETEXI 6865824d651Sblueswir1 6875824d651Sblueswir1DEF("sdl", 0, QEMU_OPTION_sdl, 688ad96090aSBlue Swirl "-sdl enable SDL\n", QEMU_ARCH_ALL) 6895824d651Sblueswir1STEXI 6905824d651Sblueswir1@item -sdl 6916616b2adSStefan Weil@findex -sdl 6925824d651Sblueswir1Enable SDL. 6935824d651Sblueswir1ETEXI 6945824d651Sblueswir1 69529b0040bSGerd HoffmannDEF("spice", HAS_ARG, QEMU_OPTION_spice, 69629b0040bSGerd Hoffmann "-spice <args> enable spice\n", QEMU_ARCH_ALL) 69729b0040bSGerd HoffmannSTEXI 69829b0040bSGerd Hoffmann@item -spice @var{option}[,@var{option}[,...]] 69929b0040bSGerd Hoffmann@findex -spice 70029b0040bSGerd HoffmannEnable the spice remote desktop protocol. Valid options are 70129b0040bSGerd Hoffmann 70229b0040bSGerd Hoffmann@table @option 70329b0040bSGerd Hoffmann 70429b0040bSGerd Hoffmann@item port=<nr> 705c448e855SGerd HoffmannSet the TCP port spice is listening on for plaintext channels. 70629b0040bSGerd Hoffmann 707333b0eebSGerd Hoffmann@item addr=<addr> 708333b0eebSGerd HoffmannSet the IP address spice is listening on. Default is any address. 709333b0eebSGerd Hoffmann 710333b0eebSGerd Hoffmann@item ipv4 711333b0eebSGerd Hoffmann@item ipv6 712333b0eebSGerd HoffmannForce using the specified IP version. 713333b0eebSGerd Hoffmann 71429b0040bSGerd Hoffmann@item password=<secret> 71529b0040bSGerd HoffmannSet the password you need to authenticate. 71629b0040bSGerd Hoffmann 71748b3ed0aSMarc-André Lureau@item sasl 71848b3ed0aSMarc-André LureauRequire that the client use SASL to authenticate with the spice. 71948b3ed0aSMarc-André LureauThe exact choice of authentication method used is controlled from the 72048b3ed0aSMarc-André Lureausystem / user's SASL configuration file for the 'qemu' service. This 72148b3ed0aSMarc-André Lureauis typically found in /etc/sasl2/qemu.conf. If running QEMU as an 72248b3ed0aSMarc-André Lureauunprivileged user, an environment variable SASL_CONF_PATH can be used 72348b3ed0aSMarc-André Lureauto make it search alternate locations for the service config. 72448b3ed0aSMarc-André LureauWhile some SASL auth methods can also provide data encryption (eg GSSAPI), 72548b3ed0aSMarc-André Lureauit is recommended that SASL always be combined with the 'tls' and 72648b3ed0aSMarc-André Lureau'x509' settings to enable use of SSL and server certificates. This 72748b3ed0aSMarc-André Lureauensures a data encryption preventing compromise of authentication 72848b3ed0aSMarc-André Lureaucredentials. 72948b3ed0aSMarc-André Lureau 73029b0040bSGerd Hoffmann@item disable-ticketing 73129b0040bSGerd HoffmannAllow client connects without authentication. 73229b0040bSGerd Hoffmann 733d4970b07SHans de Goede@item disable-copy-paste 734d4970b07SHans de GoedeDisable copy paste between the client and the guest. 735d4970b07SHans de Goede 736c448e855SGerd Hoffmann@item tls-port=<nr> 737c448e855SGerd HoffmannSet the TCP port spice is listening on for encrypted channels. 738c448e855SGerd Hoffmann 739c448e855SGerd Hoffmann@item x509-dir=<dir> 740c448e855SGerd HoffmannSet the x509 file directory. Expects same filenames as -vnc $display,x509=$dir 741c448e855SGerd Hoffmann 742c448e855SGerd Hoffmann@item x509-key-file=<file> 743c448e855SGerd Hoffmann@item x509-key-password=<file> 744c448e855SGerd Hoffmann@item x509-cert-file=<file> 745c448e855SGerd Hoffmann@item x509-cacert-file=<file> 746c448e855SGerd Hoffmann@item x509-dh-key-file=<file> 747c448e855SGerd HoffmannThe x509 file names can also be configured individually. 748c448e855SGerd Hoffmann 749c448e855SGerd Hoffmann@item tls-ciphers=<list> 750c448e855SGerd HoffmannSpecify which ciphers to use. 751c448e855SGerd Hoffmann 75217b6dea0SGerd Hoffmann@item tls-channel=[main|display|inputs|record|playback|tunnel] 75317b6dea0SGerd Hoffmann@item plaintext-channel=[main|display|inputs|record|playback|tunnel] 75417b6dea0SGerd HoffmannForce specific channel to be used with or without TLS encryption. The 75517b6dea0SGerd Hoffmannoptions can be specified multiple times to configure multiple 75617b6dea0SGerd Hoffmannchannels. The special name "default" can be used to set the default 75717b6dea0SGerd Hoffmannmode. For channels which are not explicitly forced into one mode the 75817b6dea0SGerd Hoffmannspice client is allowed to pick tls/plaintext as he pleases. 75917b6dea0SGerd Hoffmann 7609f04e09eSYonit Halperin@item image-compression=[auto_glz|auto_lz|quic|glz|lz|off] 7619f04e09eSYonit HalperinConfigure image compression (lossless). 7629f04e09eSYonit HalperinDefault is auto_glz. 7639f04e09eSYonit Halperin 7649f04e09eSYonit Halperin@item jpeg-wan-compression=[auto|never|always] 7659f04e09eSYonit Halperin@item zlib-glz-wan-compression=[auto|never|always] 7669f04e09eSYonit HalperinConfigure wan image compression (lossy for slow links). 7679f04e09eSYonit HalperinDefault is auto. 7689f04e09eSYonit Halperin 76984a23f25SGerd Hoffmann@item streaming-video=[off|all|filter] 77084a23f25SGerd HoffmannConfigure video stream detection. Default is filter. 77184a23f25SGerd Hoffmann 77284a23f25SGerd Hoffmann@item agent-mouse=[on|off] 77384a23f25SGerd HoffmannEnable/disable passing mouse events via vdagent. Default is on. 77484a23f25SGerd Hoffmann 77584a23f25SGerd Hoffmann@item playback-compression=[on|off] 77684a23f25SGerd HoffmannEnable/disable audio stream compression (using celt 0.5.1). Default is on. 77784a23f25SGerd Hoffmann 77829b0040bSGerd Hoffmann@end table 77929b0040bSGerd HoffmannETEXI 78029b0040bSGerd Hoffmann 7815824d651Sblueswir1DEF("portrait", 0, QEMU_OPTION_portrait, 782ad96090aSBlue Swirl "-portrait rotate graphical output 90 deg left (only PXA LCD)\n", 783ad96090aSBlue Swirl QEMU_ARCH_ALL) 7845824d651Sblueswir1STEXI 7855824d651Sblueswir1@item -portrait 7866616b2adSStefan Weil@findex -portrait 7875824d651Sblueswir1Rotate graphical output 90 deg left (only PXA LCD). 7885824d651Sblueswir1ETEXI 7895824d651Sblueswir1 7905824d651Sblueswir1DEF("vga", HAS_ARG, QEMU_OPTION_vga, 791a19cbfb3SGerd Hoffmann "-vga [std|cirrus|vmware|qxl|xenfb|none]\n" 792ad96090aSBlue Swirl " select video card type\n", QEMU_ARCH_ALL) 7935824d651Sblueswir1STEXI 7945824d651Sblueswir1@item -vga @var{type} 7956616b2adSStefan Weil@findex -vga 7965824d651Sblueswir1Select type of VGA card to emulate. Valid values for @var{type} are 797b3f046c2SKevin Wolf@table @option 7985824d651Sblueswir1@item cirrus 7995824d651Sblueswir1Cirrus Logic GD5446 Video card. All Windows versions starting from 8005824d651Sblueswir1Windows 95 should recognize and use this graphic card. For optimal 8015824d651Sblueswir1performances, use 16 bit color depth in the guest and the host OS. 8025824d651Sblueswir1(This one is the default) 8035824d651Sblueswir1@item std 8045824d651Sblueswir1Standard VGA card with Bochs VBE extensions. If your guest OS 8055824d651Sblueswir1supports the VESA 2.0 VBE extensions (e.g. Windows XP) and if you want 8065824d651Sblueswir1to use high resolution modes (>= 1280x1024x16) then you should use 8075824d651Sblueswir1this option. 8085824d651Sblueswir1@item vmware 8095824d651Sblueswir1VMWare SVGA-II compatible adapter. Use it if you have sufficiently 8105824d651Sblueswir1recent XFree86/XOrg server or Windows guest with a driver for this 8115824d651Sblueswir1card. 812a19cbfb3SGerd Hoffmann@item qxl 813a19cbfb3SGerd HoffmannQXL paravirtual graphic card. It is VGA compatible (including VESA 814a19cbfb3SGerd Hoffmann2.0 VBE support). Works best with qxl guest drivers installed though. 815a19cbfb3SGerd HoffmannRecommended choice when using the spice protocol. 8165824d651Sblueswir1@item none 8175824d651Sblueswir1Disable VGA card. 8185824d651Sblueswir1@end table 8195824d651Sblueswir1ETEXI 8205824d651Sblueswir1 8215824d651Sblueswir1DEF("full-screen", 0, QEMU_OPTION_full_screen, 822ad96090aSBlue Swirl "-full-screen start in full screen\n", QEMU_ARCH_ALL) 8235824d651Sblueswir1STEXI 8245824d651Sblueswir1@item -full-screen 8256616b2adSStefan Weil@findex -full-screen 8265824d651Sblueswir1Start in full screen. 8275824d651Sblueswir1ETEXI 8285824d651Sblueswir1 8295824d651Sblueswir1DEF("g", 1, QEMU_OPTION_g , 830ad96090aSBlue Swirl "-g WxH[xDEPTH] Set the initial graphical resolution and depth\n", 831ad96090aSBlue Swirl QEMU_ARCH_PPC | QEMU_ARCH_SPARC) 8325824d651Sblueswir1STEXI 83395d5f08bSStefan Weil@item -g @var{width}x@var{height}[x@var{depth}] 8346616b2adSStefan Weil@findex -g 83595d5f08bSStefan WeilSet the initial graphical resolution and depth (PPC, SPARC only). 8365824d651Sblueswir1ETEXI 8375824d651Sblueswir1 8385824d651Sblueswir1DEF("vnc", HAS_ARG, QEMU_OPTION_vnc , 839ad96090aSBlue Swirl "-vnc display start a VNC server on display\n", QEMU_ARCH_ALL) 8405824d651Sblueswir1STEXI 8415824d651Sblueswir1@item -vnc @var{display}[,@var{option}[,@var{option}[,...]]] 8426616b2adSStefan Weil@findex -vnc 8435824d651Sblueswir1Normally, QEMU uses SDL to display the VGA output. With this option, 8445824d651Sblueswir1you can have QEMU listen on VNC display @var{display} and redirect the VGA 8455824d651Sblueswir1display over the VNC session. It is very useful to enable the usb 8465824d651Sblueswir1tablet device when using this option (option @option{-usbdevice 8475824d651Sblueswir1tablet}). When using the VNC display, you must use the @option{-k} 8485824d651Sblueswir1parameter to set the keyboard layout if you are not using en-us. Valid 8495824d651Sblueswir1syntax for the @var{display} is 8505824d651Sblueswir1 851b3f046c2SKevin Wolf@table @option 8525824d651Sblueswir1 8535824d651Sblueswir1@item @var{host}:@var{d} 8545824d651Sblueswir1 8555824d651Sblueswir1TCP connections will only be allowed from @var{host} on display @var{d}. 8565824d651Sblueswir1By convention the TCP port is 5900+@var{d}. Optionally, @var{host} can 8575824d651Sblueswir1be omitted in which case the server will accept connections from any host. 8585824d651Sblueswir1 8594e257e5eSKevin Wolf@item unix:@var{path} 8605824d651Sblueswir1 8615824d651Sblueswir1Connections will be allowed over UNIX domain sockets where @var{path} is the 8625824d651Sblueswir1location of a unix socket to listen for connections on. 8635824d651Sblueswir1 8645824d651Sblueswir1@item none 8655824d651Sblueswir1 8665824d651Sblueswir1VNC is initialized but not started. The monitor @code{change} command 8675824d651Sblueswir1can be used to later start the VNC server. 8685824d651Sblueswir1 8695824d651Sblueswir1@end table 8705824d651Sblueswir1 8715824d651Sblueswir1Following the @var{display} value there may be one or more @var{option} flags 8725824d651Sblueswir1separated by commas. Valid options are 8735824d651Sblueswir1 874b3f046c2SKevin Wolf@table @option 8755824d651Sblueswir1 8765824d651Sblueswir1@item reverse 8775824d651Sblueswir1 8785824d651Sblueswir1Connect to a listening VNC client via a ``reverse'' connection. The 8795824d651Sblueswir1client is specified by the @var{display}. For reverse network 8805824d651Sblueswir1connections (@var{host}:@var{d},@code{reverse}), the @var{d} argument 8815824d651Sblueswir1is a TCP port number, not a display number. 8825824d651Sblueswir1 8835824d651Sblueswir1@item password 8845824d651Sblueswir1 8855824d651Sblueswir1Require that password based authentication is used for client connections. 8865824d651Sblueswir1The password must be set separately using the @code{change} command in the 8875824d651Sblueswir1@ref{pcsys_monitor} 8885824d651Sblueswir1 8895824d651Sblueswir1@item tls 8905824d651Sblueswir1 8915824d651Sblueswir1Require that client use TLS when communicating with the VNC server. This 8925824d651Sblueswir1uses anonymous TLS credentials so is susceptible to a man-in-the-middle 8935824d651Sblueswir1attack. It is recommended that this option be combined with either the 8944e257e5eSKevin Wolf@option{x509} or @option{x509verify} options. 8955824d651Sblueswir1 8965824d651Sblueswir1@item x509=@var{/path/to/certificate/dir} 8975824d651Sblueswir1 8985824d651Sblueswir1Valid if @option{tls} is specified. Require that x509 credentials are used 8995824d651Sblueswir1for negotiating the TLS session. The server will send its x509 certificate 9005824d651Sblueswir1to the client. It is recommended that a password be set on the VNC server 9015824d651Sblueswir1to provide authentication of the client when this is used. The path following 9025824d651Sblueswir1this option specifies where the x509 certificates are to be loaded from. 9035824d651Sblueswir1See the @ref{vnc_security} section for details on generating certificates. 9045824d651Sblueswir1 9055824d651Sblueswir1@item x509verify=@var{/path/to/certificate/dir} 9065824d651Sblueswir1 9075824d651Sblueswir1Valid if @option{tls} is specified. Require that x509 credentials are used 9085824d651Sblueswir1for negotiating the TLS session. The server will send its x509 certificate 9095824d651Sblueswir1to the client, and request that the client send its own x509 certificate. 9105824d651Sblueswir1The server will validate the client's certificate against the CA certificate, 9115824d651Sblueswir1and reject clients when validation fails. If the certificate authority is 9125824d651Sblueswir1trusted, this is a sufficient authentication mechanism. You may still wish 9135824d651Sblueswir1to set a password on the VNC server as a second authentication layer. The 9145824d651Sblueswir1path following this option specifies where the x509 certificates are to 9155824d651Sblueswir1be loaded from. See the @ref{vnc_security} section for details on generating 9165824d651Sblueswir1certificates. 9175824d651Sblueswir1 9185824d651Sblueswir1@item sasl 9195824d651Sblueswir1 9205824d651Sblueswir1Require that the client use SASL to authenticate with the VNC server. 9215824d651Sblueswir1The exact choice of authentication method used is controlled from the 9225824d651Sblueswir1system / user's SASL configuration file for the 'qemu' service. This 9235824d651Sblueswir1is typically found in /etc/sasl2/qemu.conf. If running QEMU as an 9245824d651Sblueswir1unprivileged user, an environment variable SASL_CONF_PATH can be used 9255824d651Sblueswir1to make it search alternate locations for the service config. 9265824d651Sblueswir1While some SASL auth methods can also provide data encryption (eg GSSAPI), 9275824d651Sblueswir1it is recommended that SASL always be combined with the 'tls' and 9285824d651Sblueswir1'x509' settings to enable use of SSL and server certificates. This 9295824d651Sblueswir1ensures a data encryption preventing compromise of authentication 9305824d651Sblueswir1credentials. See the @ref{vnc_security} section for details on using 9315824d651Sblueswir1SASL authentication. 9325824d651Sblueswir1 9335824d651Sblueswir1@item acl 9345824d651Sblueswir1 9355824d651Sblueswir1Turn on access control lists for checking of the x509 client certificate 9365824d651Sblueswir1and SASL party. For x509 certs, the ACL check is made against the 9375824d651Sblueswir1certificate's distinguished name. This is something that looks like 9385824d651Sblueswir1@code{C=GB,O=ACME,L=Boston,CN=bob}. For SASL party, the ACL check is 9395824d651Sblueswir1made against the username, which depending on the SASL plugin, may 9405824d651Sblueswir1include a realm component, eg @code{bob} or @code{bob@@EXAMPLE.COM}. 9415824d651Sblueswir1When the @option{acl} flag is set, the initial access list will be 9425824d651Sblueswir1empty, with a @code{deny} policy. Thus no one will be allowed to 9435824d651Sblueswir1use the VNC server until the ACLs have been loaded. This can be 9445824d651Sblueswir1achieved using the @code{acl} monitor command. 9455824d651Sblueswir1 9466f9c78c1SCorentin Chary@item lossy 9476f9c78c1SCorentin Chary 9486f9c78c1SCorentin CharyEnable lossy compression methods (gradient, JPEG, ...). If this 9496f9c78c1SCorentin Charyoption is set, VNC client may receive lossy framebuffer updates 9506f9c78c1SCorentin Charydepending on its encoding settings. Enabling this option can save 9516f9c78c1SCorentin Charya lot of bandwidth at the expense of quality. 9526f9c78c1SCorentin Chary 95380e0c8c3SCorentin Chary@item non-adaptive 95480e0c8c3SCorentin Chary 95580e0c8c3SCorentin CharyDisable adaptive encodings. Adaptive encodings are enabled by default. 95680e0c8c3SCorentin CharyAn adaptive encoding will try to detect frequently updated screen regions, 95780e0c8c3SCorentin Charyand send updates in these regions using a lossy encoding (like JPEG). 95861cc8701SStefan WeilThis can be really helpful to save bandwidth when playing videos. Disabling 95961cc8701SStefan Weiladaptive encodings allows to restore the original static behavior of encodings 96080e0c8c3SCorentin Charylike Tight. 96180e0c8c3SCorentin Chary 9625824d651Sblueswir1@end table 9635824d651Sblueswir1ETEXI 9645824d651Sblueswir1 9655824d651Sblueswir1STEXI 9665824d651Sblueswir1@end table 9675824d651Sblueswir1ETEXI 9685824d651Sblueswir1 9695824d651Sblueswir1DEFHEADING() 9705824d651Sblueswir1 9715824d651Sblueswir1DEFHEADING(i386 target only:) 9725824d651Sblueswir1STEXI 9735824d651Sblueswir1@table @option 9745824d651Sblueswir1ETEXI 9755824d651Sblueswir1 9765824d651Sblueswir1DEF("win2k-hack", 0, QEMU_OPTION_win2k_hack, 977ad96090aSBlue Swirl "-win2k-hack use it when installing Windows 2000 to avoid a disk full bug\n", 978ad96090aSBlue Swirl QEMU_ARCH_I386) 9795824d651Sblueswir1STEXI 9805824d651Sblueswir1@item -win2k-hack 9816616b2adSStefan Weil@findex -win2k-hack 9825824d651Sblueswir1Use it when installing Windows 2000 to avoid a disk full bug. After 9835824d651Sblueswir1Windows 2000 is installed, you no longer need this option (this option 9845824d651Sblueswir1slows down the IDE transfers). 9855824d651Sblueswir1ETEXI 9865824d651Sblueswir1 9871ed2fc1fSJan KiszkaHXCOMM Deprecated by -rtc 988ad96090aSBlue SwirlDEF("rtc-td-hack", 0, QEMU_OPTION_rtc_td_hack, "", QEMU_ARCH_I386) 9895824d651Sblueswir1 9905824d651Sblueswir1DEF("no-fd-bootchk", 0, QEMU_OPTION_no_fd_bootchk, 991ad96090aSBlue Swirl "-no-fd-bootchk disable boot signature checking for floppy disks\n", 992ad96090aSBlue Swirl QEMU_ARCH_I386) 9935824d651Sblueswir1STEXI 9945824d651Sblueswir1@item -no-fd-bootchk 9956616b2adSStefan Weil@findex -no-fd-bootchk 9965824d651Sblueswir1Disable boot signature checking for floppy disks in Bochs BIOS. It may 9975824d651Sblueswir1be needed to boot from old floppy disks. 9986616b2adSStefan WeilTODO: check reference to Bochs BIOS. 9995824d651Sblueswir1ETEXI 10005824d651Sblueswir1 10015824d651Sblueswir1DEF("no-acpi", 0, QEMU_OPTION_no_acpi, 1002ad96090aSBlue Swirl "-no-acpi disable ACPI\n", QEMU_ARCH_I386) 10035824d651Sblueswir1STEXI 10045824d651Sblueswir1@item -no-acpi 10056616b2adSStefan Weil@findex -no-acpi 10065824d651Sblueswir1Disable ACPI (Advanced Configuration and Power Interface) support. Use 10075824d651Sblueswir1it if your guest OS complains about ACPI problems (PC target machine 10085824d651Sblueswir1only). 10095824d651Sblueswir1ETEXI 10105824d651Sblueswir1 10115824d651Sblueswir1DEF("no-hpet", 0, QEMU_OPTION_no_hpet, 1012ad96090aSBlue Swirl "-no-hpet disable HPET\n", QEMU_ARCH_I386) 10135824d651Sblueswir1STEXI 10145824d651Sblueswir1@item -no-hpet 10156616b2adSStefan Weil@findex -no-hpet 10165824d651Sblueswir1Disable HPET support. 10175824d651Sblueswir1ETEXI 10185824d651Sblueswir1 10197d4c3d53SMarkus ArmbrusterDEF("balloon", HAS_ARG, QEMU_OPTION_balloon, 10207d4c3d53SMarkus Armbruster "-balloon none disable balloon device\n" 10217d4c3d53SMarkus Armbruster "-balloon virtio[,addr=str]\n" 1022ad96090aSBlue Swirl " enable virtio balloon device (default)\n", QEMU_ARCH_ALL) 1023df97b920SEduardo HabkostSTEXI 10247d4c3d53SMarkus Armbruster@item -balloon none 10256616b2adSStefan Weil@findex -balloon 10267d4c3d53SMarkus ArmbrusterDisable balloon device. 10277d4c3d53SMarkus Armbruster@item -balloon virtio[,addr=@var{addr}] 10287d4c3d53SMarkus ArmbrusterEnable virtio balloon device (default), optionally with PCI address 10297d4c3d53SMarkus Armbruster@var{addr}. 1030df97b920SEduardo HabkostETEXI 1031df97b920SEduardo Habkost 10325824d651Sblueswir1DEF("acpitable", HAS_ARG, QEMU_OPTION_acpitable, 10335824d651Sblueswir1 "-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" 1034ad96090aSBlue Swirl " ACPI table description\n", QEMU_ARCH_I386) 10355824d651Sblueswir1STEXI 10365824d651Sblueswir1@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}]...] 10376616b2adSStefan Weil@findex -acpitable 10385824d651Sblueswir1Add ACPI table with specified header fields and context from specified files. 10395824d651Sblueswir1ETEXI 10405824d651Sblueswir1 1041b6f6e3d3SaliguoriDEF("smbios", HAS_ARG, QEMU_OPTION_smbios, 1042b6f6e3d3Saliguori "-smbios file=binary\n" 1043ca1a8a06SBruce Rogers " load SMBIOS entry from binary file\n" 1044e8105ebbSPaolo Bonzini "-smbios type=0[,vendor=str][,version=str][,date=str][,release=%d.%d]\n" 1045ca1a8a06SBruce Rogers " specify SMBIOS type 0 fields\n" 1046b6f6e3d3Saliguori "-smbios type=1[,manufacturer=str][,product=str][,version=str][,serial=str]\n" 1047b6f6e3d3Saliguori " [,uuid=uuid][,sku=str][,family=str]\n" 1048ad96090aSBlue Swirl " specify SMBIOS type 1 fields\n", QEMU_ARCH_I386) 1049b6f6e3d3SaliguoriSTEXI 1050b6f6e3d3Saliguori@item -smbios file=@var{binary} 10516616b2adSStefan Weil@findex -smbios 1052b6f6e3d3SaliguoriLoad SMBIOS entry from binary file. 1053b6f6e3d3Saliguori 1054b6f6e3d3Saliguori@item -smbios type=0[,vendor=@var{str}][,version=@var{str}][,date=@var{str}][,release=@var{%d.%d}] 10556616b2adSStefan Weil@findex -smbios 1056b6f6e3d3SaliguoriSpecify SMBIOS type 0 fields 1057b6f6e3d3Saliguori 1058b6f6e3d3Saliguori@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}] 1059b6f6e3d3SaliguoriSpecify SMBIOS type 1 fields 1060b6f6e3d3SaliguoriETEXI 1061b6f6e3d3Saliguori 10625824d651Sblueswir1DEFHEADING() 10635824d651Sblueswir1STEXI 10645824d651Sblueswir1@end table 10655824d651Sblueswir1ETEXI 10665824d651Sblueswir1 10675824d651Sblueswir1DEFHEADING(Network options:) 10685824d651Sblueswir1STEXI 10695824d651Sblueswir1@table @option 10705824d651Sblueswir1ETEXI 10715824d651Sblueswir1 1072ad196a9dSJan KiszkaHXCOMM Legacy slirp options (now moved to -net user): 1073ad196a9dSJan Kiszka#ifdef CONFIG_SLIRP 1074ad96090aSBlue SwirlDEF("tftp", HAS_ARG, QEMU_OPTION_tftp, "", QEMU_ARCH_ALL) 1075ad96090aSBlue SwirlDEF("bootp", HAS_ARG, QEMU_OPTION_bootp, "", QEMU_ARCH_ALL) 1076ad96090aSBlue SwirlDEF("redir", HAS_ARG, QEMU_OPTION_redir, "", QEMU_ARCH_ALL) 1077ad196a9dSJan Kiszka#ifndef _WIN32 1078ad96090aSBlue SwirlDEF("smb", HAS_ARG, QEMU_OPTION_smb, "", QEMU_ARCH_ALL) 1079ad196a9dSJan Kiszka#endif 1080ad196a9dSJan Kiszka#endif 1081ad196a9dSJan Kiszka 1082bab7944cSBlue SwirlDEF("net", HAS_ARG, QEMU_OPTION_net, 1083ffe6370cSMichael S. Tsirkin "-net nic[,vlan=n][,macaddr=mac][,model=type][,name=str][,addr=str][,vectors=v]\n" 10845824d651Sblueswir1 " create a new Network Interface Card and connect it to VLAN 'n'\n" 10855824d651Sblueswir1#ifdef CONFIG_SLIRP 1086c92ef6a2SJan Kiszka "-net user[,vlan=n][,name=str][,net=addr[/mask]][,host=addr][,restrict=y|n]\n" 1087c92ef6a2SJan Kiszka " [,hostname=host][,dhcpstart=addr][,dns=addr][,tftp=dir][,bootfile=f]\n" 1088c92ef6a2SJan Kiszka " [,hostfwd=rule][,guestfwd=rule]" 1089ad196a9dSJan Kiszka#ifndef _WIN32 1090c92ef6a2SJan Kiszka "[,smb=dir[,smbserver=addr]]\n" 1091ad196a9dSJan Kiszka#endif 1092ad196a9dSJan Kiszka " connect the user mode network stack to VLAN 'n', configure its\n" 1093ad196a9dSJan Kiszka " DHCP server and enabled optional services\n" 10945824d651Sblueswir1#endif 10955824d651Sblueswir1#ifdef _WIN32 10965824d651Sblueswir1 "-net tap[,vlan=n][,name=str],ifname=name\n" 10975824d651Sblueswir1 " connect the host TAP network interface to VLAN 'n'\n" 10985824d651Sblueswir1#else 10995430a28fSmst@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" 11005824d651Sblueswir1 " connect the host TAP network interface to VLAN 'n' and use the\n" 1101bec7c2d4SPaolo Bonzini " network scripts 'file' (default=" DEFAULT_NETWORK_SCRIPT ")\n" 1102bec7c2d4SPaolo Bonzini " and 'dfile' (default=" DEFAULT_NETWORK_DOWN_SCRIPT ")\n" 1103ca1a8a06SBruce Rogers " use '[down]script=no' to disable script execution\n" 11045824d651Sblueswir1 " use 'fd=h' to connect to an already opened TAP interface\n" 1105ca1a8a06SBruce Rogers " use 'sndbuf=nbytes' to limit the size of the send buffer (the\n" 1106f157ed20SMichael S. Tsirkin " default is disabled 'sndbuf=0' to enable flow control set 'sndbuf=1048576')\n" 1107ca1a8a06SBruce Rogers " use vnet_hdr=off to avoid enabling the IFF_VNET_HDR tap flag\n" 1108ca1a8a06SBruce Rogers " use vnet_hdr=on to make the lack of IFF_VNET_HDR support an error condition\n" 110982b0d80eSMichael S. Tsirkin " use vhost=on to enable experimental in kernel accelerator\n" 11105430a28fSmst@redhat.com " (only has effect for virtio guests which use MSIX)\n" 11115430a28fSmst@redhat.com " use vhostforce=on to force vhost on for non-MSIX virtio guests\n" 111282b0d80eSMichael S. Tsirkin " use 'vhostfd=h' to connect to an already opened vhost net device\n" 11130df0ff6dSMark McLoughlin#endif 11145824d651Sblueswir1 "-net socket[,vlan=n][,name=str][,fd=h][,listen=[host]:port][,connect=host:port]\n" 11155824d651Sblueswir1 " connect the vlan 'n' to another VLAN using a socket connection\n" 11163a75e74cSMike Ryan "-net socket[,vlan=n][,name=str][,fd=h][,mcast=maddr:port[,localaddr=addr]]\n" 11175824d651Sblueswir1 " connect the vlan 'n' to multicast maddr and port\n" 11183a75e74cSMike Ryan " use 'localaddr=addr' to specify the host address to send packets from\n" 11195824d651Sblueswir1#ifdef CONFIG_VDE 11205824d651Sblueswir1 "-net vde[,vlan=n][,name=str][,sock=socketpath][,port=n][,group=groupname][,mode=octalmode]\n" 11215824d651Sblueswir1 " connect the vlan 'n' to port 'n' of a vde switch running\n" 11225824d651Sblueswir1 " on host and listening for incoming connections on 'socketpath'.\n" 11235824d651Sblueswir1 " Use group 'groupname' and mode 'octalmode' to change default\n" 11245824d651Sblueswir1 " ownership and permissions for communication port.\n" 11255824d651Sblueswir1#endif 1126bb9ea79eSaliguori "-net dump[,vlan=n][,file=f][,len=n]\n" 1127bb9ea79eSaliguori " dump traffic on vlan 'n' to file 'f' (max n bytes per packet)\n" 1128ca1a8a06SBruce Rogers "-net none use it alone to have zero network devices. If no -net option\n" 1129ad96090aSBlue Swirl " is provided, the default is '-net nic -net user'\n", QEMU_ARCH_ALL) 1130a1ea458fSMark McLoughlinDEF("netdev", HAS_ARG, QEMU_OPTION_netdev, 1131a1ea458fSMark McLoughlin "-netdev [" 1132a1ea458fSMark McLoughlin#ifdef CONFIG_SLIRP 1133a1ea458fSMark McLoughlin "user|" 1134a1ea458fSMark McLoughlin#endif 1135a1ea458fSMark McLoughlin "tap|" 1136a1ea458fSMark McLoughlin#ifdef CONFIG_VDE 1137a1ea458fSMark McLoughlin "vde|" 1138a1ea458fSMark McLoughlin#endif 1139ad96090aSBlue Swirl "socket],id=str[,option][,option][,...]\n", QEMU_ARCH_ALL) 11405824d651Sblueswir1STEXI 1141ffe6370cSMichael S. Tsirkin@item -net nic[,vlan=@var{n}][,macaddr=@var{mac}][,model=@var{type}] [,name=@var{name}][,addr=@var{addr}][,vectors=@var{v}] 11426616b2adSStefan Weil@findex -net 11435824d651Sblueswir1Create a new Network Interface Card and connect it to VLAN @var{n} (@var{n} 11440d6b0b1dSAnthony Liguori= 0 is the default). The NIC is an e1000 by default on the PC 11455607c388SMarkus Armbrustertarget. Optionally, the MAC address can be changed to @var{mac}, the 11465607c388SMarkus Armbrusterdevice address set to @var{addr} (PCI cards only), 1147ffe6370cSMichael S. Tsirkinand a @var{name} can be assigned for use in monitor commands. 1148ffe6370cSMichael S. TsirkinOptionally, for PCI cards, you can specify the number @var{v} of MSI-X vectors 1149ffe6370cSMichael S. Tsirkinthat the card should have; this option currently only affects virtio cards; set 1150ffe6370cSMichael S. Tsirkin@var{v} = 0 to disable MSI-X. If no @option{-net} option is specified, a single 1151ffe6370cSMichael S. TsirkinNIC is created. Qemu can emulate several different models of network card. 11525824d651Sblueswir1Valid values for @var{type} are 1153ffe6370cSMichael S. Tsirkin@code{virtio}, @code{i82551}, @code{i82557b}, @code{i82559er}, 11545824d651Sblueswir1@code{ne2k_pci}, @code{ne2k_isa}, @code{pcnet}, @code{rtl8139}, 11555824d651Sblueswir1@code{e1000}, @code{smc91c111}, @code{lance} and @code{mcf_fec}. 11565824d651Sblueswir1Not all devices are supported on all targets. Use -net nic,model=? 11575824d651Sblueswir1for a list of available devices for your target. 11585824d651Sblueswir1 1159ad196a9dSJan Kiszka@item -net user[,@var{option}][,@var{option}][,...] 11605824d651Sblueswir1Use the user mode network stack which requires no administrator 1161ad196a9dSJan Kiszkaprivilege to run. Valid options are: 11625824d651Sblueswir1 1163b3f046c2SKevin Wolf@table @option 1164ad196a9dSJan Kiszka@item vlan=@var{n} 1165ad196a9dSJan KiszkaConnect user mode stack to VLAN @var{n} (@var{n} = 0 is the default). 1166ad196a9dSJan Kiszka 1167ad196a9dSJan Kiszka@item name=@var{name} 1168ad196a9dSJan KiszkaAssign symbolic name for use in monitor commands. 1169ad196a9dSJan Kiszka 1170c92ef6a2SJan Kiszka@item net=@var{addr}[/@var{mask}] 1171c92ef6a2SJan KiszkaSet IP network address the guest will see. Optionally specify the netmask, 1172c92ef6a2SJan Kiszkaeither in the form a.b.c.d or as number of valid top-most bits. Default is 1173b0b36e5dSBrad Hards10.0.2.0/24. 1174c92ef6a2SJan Kiszka 1175c92ef6a2SJan Kiszka@item host=@var{addr} 1176c92ef6a2SJan KiszkaSpecify the guest-visible address of the host. Default is the 2nd IP in the 1177c92ef6a2SJan Kiszkaguest network, i.e. x.x.x.2. 1178ad196a9dSJan Kiszka 1179ad196a9dSJan Kiszka@item restrict=y|yes|n|no 1180caef55edSBrad HardsIf this option is enabled, the guest will be isolated, i.e. it will not be 1181ad196a9dSJan Kiszkaable to contact the host and no guest IP packets will be routed over the host 1182caef55edSBrad Hardsto the outside. This option does not affect any explicitly set forwarding rules. 1183ad196a9dSJan Kiszka 1184ad196a9dSJan Kiszka@item hostname=@var{name} 1185ad196a9dSJan KiszkaSpecifies the client hostname reported by the builtin DHCP server. 1186ad196a9dSJan Kiszka 1187c92ef6a2SJan Kiszka@item dhcpstart=@var{addr} 1188c92ef6a2SJan KiszkaSpecify the first of the 16 IPs the built-in DHCP server can assign. Default 1189b0b36e5dSBrad Hardsis the 15th to 31st IP in the guest network, i.e. x.x.x.15 to x.x.x.31. 1190c92ef6a2SJan Kiszka 1191c92ef6a2SJan Kiszka@item dns=@var{addr} 1192c92ef6a2SJan KiszkaSpecify the guest-visible address of the virtual nameserver. The address must 1193c92ef6a2SJan Kiszkabe different from the host address. Default is the 3rd IP in the guest network, 1194c92ef6a2SJan Kiszkai.e. x.x.x.3. 1195c92ef6a2SJan Kiszka 1196ad196a9dSJan Kiszka@item tftp=@var{dir} 1197ad196a9dSJan KiszkaWhen using the user mode network stack, activate a built-in TFTP 1198ad196a9dSJan Kiszkaserver. The files in @var{dir} will be exposed as the root of a TFTP server. 1199ad196a9dSJan KiszkaThe TFTP client on the guest must be configured in binary mode (use the command 1200c92ef6a2SJan Kiszka@code{bin} of the Unix TFTP client). 1201ad196a9dSJan Kiszka 1202ad196a9dSJan Kiszka@item bootfile=@var{file} 1203ad196a9dSJan KiszkaWhen using the user mode network stack, broadcast @var{file} as the BOOTP 1204ad196a9dSJan Kiszkafilename. In conjunction with @option{tftp}, this can be used to network boot 1205ad196a9dSJan Kiszkaa guest from a local directory. 1206ad196a9dSJan Kiszka 1207ad196a9dSJan KiszkaExample (using pxelinux): 1208ad196a9dSJan Kiszka@example 1209ad196a9dSJan Kiszkaqemu -hda linux.img -boot n -net user,tftp=/path/to/tftp/files,bootfile=/pxelinux.0 1210ad196a9dSJan Kiszka@end example 1211ad196a9dSJan Kiszka 1212c92ef6a2SJan Kiszka@item smb=@var{dir}[,smbserver=@var{addr}] 1213ad196a9dSJan KiszkaWhen using the user mode network stack, activate a built-in SMB 1214ad196a9dSJan Kiszkaserver so that Windows OSes can access to the host files in @file{@var{dir}} 1215c92ef6a2SJan Kiszkatransparently. The IP address of the SMB server can be set to @var{addr}. By 1216c92ef6a2SJan Kiszkadefault the 4th IP in the guest network is used, i.e. x.x.x.4. 1217ad196a9dSJan Kiszka 1218ad196a9dSJan KiszkaIn the guest Windows OS, the line: 1219ad196a9dSJan Kiszka@example 1220ad196a9dSJan Kiszka10.0.2.4 smbserver 1221ad196a9dSJan Kiszka@end example 1222ad196a9dSJan Kiszkamust be added in the file @file{C:\WINDOWS\LMHOSTS} (for windows 9x/Me) 1223ad196a9dSJan Kiszkaor @file{C:\WINNT\SYSTEM32\DRIVERS\ETC\LMHOSTS} (Windows NT/2000). 1224ad196a9dSJan Kiszka 1225ad196a9dSJan KiszkaThen @file{@var{dir}} can be accessed in @file{\\smbserver\qemu}. 1226ad196a9dSJan Kiszka 1227ad196a9dSJan KiszkaNote that a SAMBA server must be installed on the host OS in 1228ad196a9dSJan Kiszka@file{/usr/sbin/smbd}. QEMU was tested successfully with smbd versions from 1229ad196a9dSJan KiszkaRed Hat 9, Fedora Core 3 and OpenSUSE 11.x. 1230ad196a9dSJan Kiszka 12313c6a0580SJan Kiszka@item hostfwd=[tcp|udp]:[@var{hostaddr}]:@var{hostport}-[@var{guestaddr}]:@var{guestport} 1232c92ef6a2SJan KiszkaRedirect incoming TCP or UDP connections to the host port @var{hostport} to 1233c92ef6a2SJan Kiszkathe guest IP address @var{guestaddr} on guest port @var{guestport}. If 1234c92ef6a2SJan Kiszka@var{guestaddr} is not specified, its value is x.x.x.15 (default first address 12353c6a0580SJan Kiszkagiven by the built-in DHCP server). By specifying @var{hostaddr}, the rule can 12363c6a0580SJan Kiszkabe bound to a specific host interface. If no connection type is set, TCP is 1237c92ef6a2SJan Kiszkaused. This option can be given multiple times. 1238ad196a9dSJan Kiszka 1239ad196a9dSJan KiszkaFor example, to redirect host X11 connection from screen 1 to guest 1240ad196a9dSJan Kiszkascreen 0, use the following: 1241ad196a9dSJan Kiszka 1242ad196a9dSJan Kiszka@example 1243ad196a9dSJan Kiszka# on the host 12443c6a0580SJan Kiszkaqemu -net user,hostfwd=tcp:127.0.0.1:6001-:6000 [...] 1245ad196a9dSJan Kiszka# this host xterm should open in the guest X11 server 1246ad196a9dSJan Kiszkaxterm -display :1 1247ad196a9dSJan Kiszka@end example 1248ad196a9dSJan Kiszka 1249ad196a9dSJan KiszkaTo redirect telnet connections from host port 5555 to telnet port on 1250ad196a9dSJan Kiszkathe guest, use the following: 1251ad196a9dSJan Kiszka 1252ad196a9dSJan Kiszka@example 1253ad196a9dSJan Kiszka# on the host 1254aa375206SAurelien Jarnoqemu -net user,hostfwd=tcp::5555-:23 [...] 1255ad196a9dSJan Kiszkatelnet localhost 5555 1256ad196a9dSJan Kiszka@end example 1257ad196a9dSJan Kiszka 1258ad196a9dSJan KiszkaThen when you use on the host @code{telnet localhost 5555}, you 1259ad196a9dSJan Kiszkaconnect to the guest telnet server. 1260ad196a9dSJan Kiszka 1261c92ef6a2SJan Kiszka@item guestfwd=[tcp]:@var{server}:@var{port}-@var{dev} 12623c6a0580SJan KiszkaForward guest TCP connections to the IP address @var{server} on port @var{port} 12633c6a0580SJan Kiszkato the character device @var{dev}. This option can be given multiple times. 1264ad196a9dSJan Kiszka 1265ad196a9dSJan Kiszka@end table 1266ad196a9dSJan Kiszka 1267ad196a9dSJan KiszkaNote: Legacy stand-alone options -tftp, -bootp, -smb and -redir are still 1268ad196a9dSJan Kiszkaprocessed and applied to -net user. Mixing them with the new configuration 1269ad196a9dSJan Kiszkasyntax gives undefined results. Their use for new applications is discouraged 1270ad196a9dSJan Kiszkaas they will be removed from future versions. 12715824d651Sblueswir1 12725824d651Sblueswir1@item -net tap[,vlan=@var{n}][,name=@var{name}][,fd=@var{h}][,ifname=@var{name}] [,script=@var{file}][,downscript=@var{dfile}] 12735824d651Sblueswir1Connect the host TAP network interface @var{name} to VLAN @var{n}, use 12745824d651Sblueswir1the network script @var{file} to configure it and the network script 12755824d651Sblueswir1@var{dfile} to deconfigure it. If @var{name} is not provided, the OS 12765824d651Sblueswir1automatically provides one. @option{fd}=@var{h} can be used to specify 12775824d651Sblueswir1the handle of an already opened host TAP interface. The default network 12785824d651Sblueswir1configure script is @file{/etc/qemu-ifup} and the default network 12795824d651Sblueswir1deconfigure script is @file{/etc/qemu-ifdown}. Use @option{script=no} 12805824d651Sblueswir1or @option{downscript=no} to disable script execution. Example: 12815824d651Sblueswir1 12825824d651Sblueswir1@example 12835824d651Sblueswir1qemu linux.img -net nic -net tap 12845824d651Sblueswir1@end example 12855824d651Sblueswir1 12865824d651Sblueswir1More complicated example (two NICs, each one connected to a TAP device) 12875824d651Sblueswir1@example 12885824d651Sblueswir1qemu linux.img -net nic,vlan=0 -net tap,vlan=0,ifname=tap0 \ 12895824d651Sblueswir1 -net nic,vlan=1 -net tap,vlan=1,ifname=tap1 12905824d651Sblueswir1@end example 12915824d651Sblueswir1 12925824d651Sblueswir1@item -net socket[,vlan=@var{n}][,name=@var{name}][,fd=@var{h}] [,listen=[@var{host}]:@var{port}][,connect=@var{host}:@var{port}] 12935824d651Sblueswir1 12945824d651Sblueswir1Connect the VLAN @var{n} to a remote VLAN in another QEMU virtual 12955824d651Sblueswir1machine using a TCP socket connection. If @option{listen} is 12965824d651Sblueswir1specified, QEMU waits for incoming connections on @var{port} 12975824d651Sblueswir1(@var{host} is optional). @option{connect} is used to connect to 12985824d651Sblueswir1another QEMU instance using the @option{listen} option. @option{fd}=@var{h} 12995824d651Sblueswir1specifies an already opened TCP socket. 13005824d651Sblueswir1 13015824d651Sblueswir1Example: 13025824d651Sblueswir1@example 13035824d651Sblueswir1# launch a first QEMU instance 13045824d651Sblueswir1qemu linux.img -net nic,macaddr=52:54:00:12:34:56 \ 13055824d651Sblueswir1 -net socket,listen=:1234 13065824d651Sblueswir1# connect the VLAN 0 of this instance to the VLAN 0 13075824d651Sblueswir1# of the first instance 13085824d651Sblueswir1qemu linux.img -net nic,macaddr=52:54:00:12:34:57 \ 13095824d651Sblueswir1 -net socket,connect=127.0.0.1:1234 13105824d651Sblueswir1@end example 13115824d651Sblueswir1 13123a75e74cSMike Ryan@item -net socket[,vlan=@var{n}][,name=@var{name}][,fd=@var{h}][,mcast=@var{maddr}:@var{port}[,localaddr=@var{addr}]] 13135824d651Sblueswir1 13145824d651Sblueswir1Create a VLAN @var{n} shared with another QEMU virtual 13155824d651Sblueswir1machines using a UDP multicast socket, effectively making a bus for 13165824d651Sblueswir1every QEMU with same multicast address @var{maddr} and @var{port}. 13175824d651Sblueswir1NOTES: 13185824d651Sblueswir1@enumerate 13195824d651Sblueswir1@item 13205824d651Sblueswir1Several QEMU can be running on different hosts and share same bus (assuming 13215824d651Sblueswir1correct multicast setup for these hosts). 13225824d651Sblueswir1@item 13235824d651Sblueswir1mcast support is compatible with User Mode Linux (argument @option{eth@var{N}=mcast}), see 13245824d651Sblueswir1@url{http://user-mode-linux.sf.net}. 13255824d651Sblueswir1@item 13265824d651Sblueswir1Use @option{fd=h} to specify an already opened UDP multicast socket. 13275824d651Sblueswir1@end enumerate 13285824d651Sblueswir1 13295824d651Sblueswir1Example: 13305824d651Sblueswir1@example 13315824d651Sblueswir1# launch one QEMU instance 13325824d651Sblueswir1qemu linux.img -net nic,macaddr=52:54:00:12:34:56 \ 13335824d651Sblueswir1 -net socket,mcast=230.0.0.1:1234 13345824d651Sblueswir1# launch another QEMU instance on same "bus" 13355824d651Sblueswir1qemu linux.img -net nic,macaddr=52:54:00:12:34:57 \ 13365824d651Sblueswir1 -net socket,mcast=230.0.0.1:1234 13375824d651Sblueswir1# launch yet another QEMU instance on same "bus" 13385824d651Sblueswir1qemu linux.img -net nic,macaddr=52:54:00:12:34:58 \ 13395824d651Sblueswir1 -net socket,mcast=230.0.0.1:1234 13405824d651Sblueswir1@end example 13415824d651Sblueswir1 13425824d651Sblueswir1Example (User Mode Linux compat.): 13435824d651Sblueswir1@example 13445824d651Sblueswir1# launch QEMU instance (note mcast address selected 13455824d651Sblueswir1# is UML's default) 13465824d651Sblueswir1qemu linux.img -net nic,macaddr=52:54:00:12:34:56 \ 13475824d651Sblueswir1 -net socket,mcast=239.192.168.1:1102 13485824d651Sblueswir1# launch UML 13495824d651Sblueswir1/path/to/linux ubd0=/path/to/root_fs eth0=mcast 13505824d651Sblueswir1@end example 13515824d651Sblueswir1 13523a75e74cSMike RyanExample (send packets from host's 1.2.3.4): 13533a75e74cSMike Ryan@example 13543a75e74cSMike Ryanqemu linux.img -net nic,macaddr=52:54:00:12:34:56 \ 13553a75e74cSMike Ryan -net socket,mcast=239.192.168.1:1102,localaddr=1.2.3.4 13563a75e74cSMike Ryan@end example 13573a75e74cSMike Ryan 13585824d651Sblueswir1@item -net vde[,vlan=@var{n}][,name=@var{name}][,sock=@var{socketpath}] [,port=@var{n}][,group=@var{groupname}][,mode=@var{octalmode}] 13595824d651Sblueswir1Connect VLAN @var{n} to PORT @var{n} of a vde switch running on host and 13605824d651Sblueswir1listening for incoming connections on @var{socketpath}. Use GROUP @var{groupname} 13615824d651Sblueswir1and MODE @var{octalmode} to change default ownership and permissions for 13625824d651Sblueswir1communication port. This option is available only if QEMU has been compiled 13635824d651Sblueswir1with vde support enabled. 13645824d651Sblueswir1 13655824d651Sblueswir1Example: 13665824d651Sblueswir1@example 13675824d651Sblueswir1# launch vde switch 13685824d651Sblueswir1vde_switch -F -sock /tmp/myswitch 13695824d651Sblueswir1# launch QEMU instance 13705824d651Sblueswir1qemu linux.img -net nic -net vde,sock=/tmp/myswitch 13715824d651Sblueswir1@end example 13725824d651Sblueswir1 1373bb9ea79eSaliguori@item -net dump[,vlan=@var{n}][,file=@var{file}][,len=@var{len}] 1374bb9ea79eSaliguoriDump network traffic on VLAN @var{n} to file @var{file} (@file{qemu-vlan0.pcap} by default). 1375bb9ea79eSaliguoriAt most @var{len} bytes (64k by default) per packet are stored. The file format is 1376bb9ea79eSaliguorilibpcap, so it can be analyzed with tools such as tcpdump or Wireshark. 1377bb9ea79eSaliguori 13785824d651Sblueswir1@item -net none 13795824d651Sblueswir1Indicate that no network devices should be configured. It is used to 13805824d651Sblueswir1override the default configuration (@option{-net nic -net user}) which 13815824d651Sblueswir1is activated if no @option{-net} options are provided. 13825824d651Sblueswir1 13835824d651Sblueswir1@end table 13845824d651Sblueswir1ETEXI 13855824d651Sblueswir1 13867273a2dbSMatthew BoothDEFHEADING() 13877273a2dbSMatthew Booth 13887273a2dbSMatthew BoothDEFHEADING(Character device options:) 13897273a2dbSMatthew Booth 13907273a2dbSMatthew BoothDEF("chardev", HAS_ARG, QEMU_OPTION_chardev, 139197331287SJan Kiszka "-chardev null,id=id[,mux=on|off]\n" 13927273a2dbSMatthew Booth "-chardev socket,id=id[,host=host],port=host[,to=to][,ipv4][,ipv6][,nodelay]\n" 139397331287SJan Kiszka " [,server][,nowait][,telnet][,mux=on|off] (tcp)\n" 139497331287SJan Kiszka "-chardev socket,id=id,path=path[,server][,nowait][,telnet],[mux=on|off] (unix)\n" 13957273a2dbSMatthew Booth "-chardev udp,id=id[,host=host],port=port[,localaddr=localaddr]\n" 139697331287SJan Kiszka " [,localport=localport][,ipv4][,ipv6][,mux=on|off]\n" 139797331287SJan Kiszka "-chardev msmouse,id=id[,mux=on|off]\n" 13987273a2dbSMatthew Booth "-chardev vc,id=id[[,width=width][,height=height]][[,cols=cols][,rows=rows]]\n" 139997331287SJan Kiszka " [,mux=on|off]\n" 140097331287SJan Kiszka "-chardev file,id=id,path=path[,mux=on|off]\n" 140197331287SJan Kiszka "-chardev pipe,id=id,path=path[,mux=on|off]\n" 14027273a2dbSMatthew Booth#ifdef _WIN32 140397331287SJan Kiszka "-chardev console,id=id[,mux=on|off]\n" 140497331287SJan Kiszka "-chardev serial,id=id,path=path[,mux=on|off]\n" 14057273a2dbSMatthew Booth#else 140697331287SJan Kiszka "-chardev pty,id=id[,mux=on|off]\n" 1407b7fdb3abSAurelien Jarno "-chardev stdio,id=id[,mux=on|off][,signal=on|off]\n" 14087273a2dbSMatthew Booth#endif 14097273a2dbSMatthew Booth#ifdef CONFIG_BRLAPI 141097331287SJan Kiszka "-chardev braille,id=id[,mux=on|off]\n" 14117273a2dbSMatthew Booth#endif 14127273a2dbSMatthew Booth#if defined(__linux__) || defined(__sun__) || defined(__FreeBSD__) \ 14137273a2dbSMatthew Booth || defined(__NetBSD__) || defined(__OpenBSD__) || defined(__DragonFly__) 141497331287SJan Kiszka "-chardev tty,id=id,path=path[,mux=on|off]\n" 14157273a2dbSMatthew Booth#endif 14167273a2dbSMatthew Booth#if defined(__linux__) || defined(__FreeBSD__) || defined(__DragonFly__) 141797331287SJan Kiszka "-chardev parport,id=id,path=path[,mux=on|off]\n" 14187273a2dbSMatthew Booth#endif 1419cbcc6336SAlon Levy#if defined(CONFIG_SPICE) 1420cbcc6336SAlon Levy "-chardev spicevmc,id=id,name=name[,debug=debug]\n" 1421cbcc6336SAlon Levy#endif 1422ad96090aSBlue Swirl , QEMU_ARCH_ALL 14237273a2dbSMatthew Booth) 14247273a2dbSMatthew Booth 14257273a2dbSMatthew BoothSTEXI 14267273a2dbSMatthew Booth 14277273a2dbSMatthew BoothThe general form of a character device option is: 14287273a2dbSMatthew Booth@table @option 14297273a2dbSMatthew Booth 143097331287SJan Kiszka@item -chardev @var{backend} ,id=@var{id} [,mux=on|off] [,@var{options}] 14316616b2adSStefan Weil@findex -chardev 14327273a2dbSMatthew BoothBackend is one of: 14337273a2dbSMatthew Booth@option{null}, 14347273a2dbSMatthew Booth@option{socket}, 14357273a2dbSMatthew Booth@option{udp}, 14367273a2dbSMatthew Booth@option{msmouse}, 14377273a2dbSMatthew Booth@option{vc}, 14387273a2dbSMatthew Booth@option{file}, 14397273a2dbSMatthew Booth@option{pipe}, 14407273a2dbSMatthew Booth@option{console}, 14417273a2dbSMatthew Booth@option{serial}, 14427273a2dbSMatthew Booth@option{pty}, 14437273a2dbSMatthew Booth@option{stdio}, 14447273a2dbSMatthew Booth@option{braille}, 14457273a2dbSMatthew Booth@option{tty}, 1446cbcc6336SAlon Levy@option{parport}, 1447cbcc6336SAlon Levy@option{spicevmc}. 14487273a2dbSMatthew BoothThe specific backend will determine the applicable options. 14497273a2dbSMatthew Booth 14507273a2dbSMatthew BoothAll devices must have an id, which can be any string up to 127 characters long. 14517273a2dbSMatthew BoothIt is used to uniquely identify this device in other command line directives. 14527273a2dbSMatthew Booth 145397331287SJan KiszkaA character device may be used in multiplexing mode by multiple front-ends. 145497331287SJan KiszkaThe key sequence of @key{Control-a} and @key{c} will rotate the input focus 145597331287SJan Kiszkabetween attached front-ends. Specify @option{mux=on} to enable this mode. 145697331287SJan Kiszka 14577273a2dbSMatthew BoothOptions to each backend are described below. 14587273a2dbSMatthew Booth 14597273a2dbSMatthew Booth@item -chardev null ,id=@var{id} 14607273a2dbSMatthew BoothA void device. This device will not emit any data, and will drop any data it 14617273a2dbSMatthew Boothreceives. The null backend does not take any options. 14627273a2dbSMatthew Booth 14637273a2dbSMatthew Booth@item -chardev socket ,id=@var{id} [@var{TCP options} or @var{unix options}] [,server] [,nowait] [,telnet] 14647273a2dbSMatthew Booth 14657273a2dbSMatthew BoothCreate a two-way stream socket, which can be either a TCP or a unix socket. A 14667273a2dbSMatthew Boothunix socket will be created if @option{path} is specified. Behaviour is 14677273a2dbSMatthew Boothundefined if TCP options are specified for a unix socket. 14687273a2dbSMatthew Booth 14697273a2dbSMatthew Booth@option{server} specifies that the socket shall be a listening socket. 14707273a2dbSMatthew Booth 14717273a2dbSMatthew Booth@option{nowait} specifies that QEMU should not block waiting for a client to 14727273a2dbSMatthew Boothconnect to a listening socket. 14737273a2dbSMatthew Booth 14747273a2dbSMatthew Booth@option{telnet} specifies that traffic on the socket should interpret telnet 14757273a2dbSMatthew Boothescape sequences. 14767273a2dbSMatthew Booth 14777273a2dbSMatthew BoothTCP and unix socket options are given below: 14787273a2dbSMatthew Booth 14797273a2dbSMatthew Booth@table @option 14807273a2dbSMatthew Booth 14818d533561SAurelien Jarno@item TCP options: port=@var{port} [,host=@var{host}] [,to=@var{to}] [,ipv4] [,ipv6] [,nodelay] 14827273a2dbSMatthew Booth 14837273a2dbSMatthew Booth@option{host} for a listening socket specifies the local address to be bound. 14847273a2dbSMatthew BoothFor a connecting socket species the remote host to connect to. @option{host} is 14857273a2dbSMatthew Boothoptional for listening sockets. If not specified it defaults to @code{0.0.0.0}. 14867273a2dbSMatthew Booth 14877273a2dbSMatthew Booth@option{port} for a listening socket specifies the local port to be bound. For a 14887273a2dbSMatthew Boothconnecting socket specifies the port on the remote host to connect to. 14897273a2dbSMatthew Booth@option{port} can be given as either a port number or a service name. 14907273a2dbSMatthew Booth@option{port} is required. 14917273a2dbSMatthew Booth 14927273a2dbSMatthew Booth@option{to} is only relevant to listening sockets. If it is specified, and 14937273a2dbSMatthew Booth@option{port} cannot be bound, QEMU will attempt to bind to subsequent ports up 14947273a2dbSMatthew Boothto and including @option{to} until it succeeds. @option{to} must be specified 14957273a2dbSMatthew Boothas a port number. 14967273a2dbSMatthew Booth 14977273a2dbSMatthew Booth@option{ipv4} and @option{ipv6} specify that either IPv4 or IPv6 must be used. 14987273a2dbSMatthew BoothIf neither is specified the socket may use either protocol. 14997273a2dbSMatthew Booth 15007273a2dbSMatthew Booth@option{nodelay} disables the Nagle algorithm. 15017273a2dbSMatthew Booth 15027273a2dbSMatthew Booth@item unix options: path=@var{path} 15037273a2dbSMatthew Booth 15047273a2dbSMatthew Booth@option{path} specifies the local path of the unix socket. @option{path} is 15057273a2dbSMatthew Boothrequired. 15067273a2dbSMatthew Booth 15077273a2dbSMatthew Booth@end table 15087273a2dbSMatthew Booth 15097273a2dbSMatthew Booth@item -chardev udp ,id=@var{id} [,host=@var{host}] ,port=@var{port} [,localaddr=@var{localaddr}] [,localport=@var{localport}] [,ipv4] [,ipv6] 15107273a2dbSMatthew Booth 15117273a2dbSMatthew BoothSends all traffic from the guest to a remote host over UDP. 15127273a2dbSMatthew Booth 15137273a2dbSMatthew Booth@option{host} specifies the remote host to connect to. If not specified it 15147273a2dbSMatthew Boothdefaults to @code{localhost}. 15157273a2dbSMatthew Booth 15167273a2dbSMatthew Booth@option{port} specifies the port on the remote host to connect to. @option{port} 15177273a2dbSMatthew Boothis required. 15187273a2dbSMatthew Booth 15197273a2dbSMatthew Booth@option{localaddr} specifies the local address to bind to. If not specified it 15207273a2dbSMatthew Boothdefaults to @code{0.0.0.0}. 15217273a2dbSMatthew Booth 15227273a2dbSMatthew Booth@option{localport} specifies the local port to bind to. If not specified any 15237273a2dbSMatthew Boothavailable local port will be used. 15247273a2dbSMatthew Booth 15257273a2dbSMatthew Booth@option{ipv4} and @option{ipv6} specify that either IPv4 or IPv6 must be used. 15267273a2dbSMatthew BoothIf neither is specified the device may use either protocol. 15277273a2dbSMatthew Booth 15287273a2dbSMatthew Booth@item -chardev msmouse ,id=@var{id} 15297273a2dbSMatthew Booth 15307273a2dbSMatthew BoothForward QEMU's emulated msmouse events to the guest. @option{msmouse} does not 15317273a2dbSMatthew Boothtake any options. 15327273a2dbSMatthew Booth 15337273a2dbSMatthew Booth@item -chardev vc ,id=@var{id} [[,width=@var{width}] [,height=@var{height}]] [[,cols=@var{cols}] [,rows=@var{rows}]] 15347273a2dbSMatthew Booth 15357273a2dbSMatthew BoothConnect to a QEMU text console. @option{vc} may optionally be given a specific 15367273a2dbSMatthew Boothsize. 15377273a2dbSMatthew Booth 15387273a2dbSMatthew Booth@option{width} and @option{height} specify the width and height respectively of 15397273a2dbSMatthew Booththe console, in pixels. 15407273a2dbSMatthew Booth 15417273a2dbSMatthew Booth@option{cols} and @option{rows} specify that the console be sized to fit a text 15427273a2dbSMatthew Boothconsole with the given dimensions. 15437273a2dbSMatthew Booth 15447273a2dbSMatthew Booth@item -chardev file ,id=@var{id} ,path=@var{path} 15457273a2dbSMatthew Booth 15467273a2dbSMatthew BoothLog all traffic received from the guest to a file. 15477273a2dbSMatthew Booth 15487273a2dbSMatthew Booth@option{path} specifies the path of the file to be opened. This file will be 15497273a2dbSMatthew Boothcreated if it does not already exist, and overwritten if it does. @option{path} 15507273a2dbSMatthew Boothis required. 15517273a2dbSMatthew Booth 15527273a2dbSMatthew Booth@item -chardev pipe ,id=@var{id} ,path=@var{path} 15537273a2dbSMatthew Booth 15547273a2dbSMatthew BoothCreate a two-way connection to the guest. The behaviour differs slightly between 15557273a2dbSMatthew BoothWindows hosts and other hosts: 15567273a2dbSMatthew Booth 15577273a2dbSMatthew BoothOn Windows, a single duplex pipe will be created at 15587273a2dbSMatthew Booth@file{\\.pipe\@option{path}}. 15597273a2dbSMatthew Booth 15607273a2dbSMatthew BoothOn other hosts, 2 pipes will be created called @file{@option{path}.in} and 15617273a2dbSMatthew Booth@file{@option{path}.out}. Data written to @file{@option{path}.in} will be 15627273a2dbSMatthew Boothreceived by the guest. Data written by the guest can be read from 15637273a2dbSMatthew Booth@file{@option{path}.out}. QEMU will not create these fifos, and requires them to 15647273a2dbSMatthew Boothbe present. 15657273a2dbSMatthew Booth 15667273a2dbSMatthew Booth@option{path} forms part of the pipe path as described above. @option{path} is 15677273a2dbSMatthew Boothrequired. 15687273a2dbSMatthew Booth 15697273a2dbSMatthew Booth@item -chardev console ,id=@var{id} 15707273a2dbSMatthew Booth 15717273a2dbSMatthew BoothSend traffic from the guest to QEMU's standard output. @option{console} does not 15727273a2dbSMatthew Boothtake any options. 15737273a2dbSMatthew Booth 15747273a2dbSMatthew Booth@option{console} is only available on Windows hosts. 15757273a2dbSMatthew Booth 15767273a2dbSMatthew Booth@item -chardev serial ,id=@var{id} ,path=@option{path} 15777273a2dbSMatthew Booth 15787273a2dbSMatthew BoothSend traffic from the guest to a serial device on the host. 15797273a2dbSMatthew Booth 15807273a2dbSMatthew Booth@option{serial} is 15817273a2dbSMatthew Boothonly available on Windows hosts. 15827273a2dbSMatthew Booth 15837273a2dbSMatthew Booth@option{path} specifies the name of the serial device to open. 15847273a2dbSMatthew Booth 15857273a2dbSMatthew Booth@item -chardev pty ,id=@var{id} 15867273a2dbSMatthew Booth 15877273a2dbSMatthew BoothCreate a new pseudo-terminal on the host and connect to it. @option{pty} does 15887273a2dbSMatthew Boothnot take any options. 15897273a2dbSMatthew Booth 15907273a2dbSMatthew Booth@option{pty} is not available on Windows hosts. 15917273a2dbSMatthew Booth 1592b7fdb3abSAurelien Jarno@item -chardev stdio ,id=@var{id} [,signal=on|off] 15937273a2dbSMatthew BoothConnect to standard input and standard output of the qemu process. 1594b7fdb3abSAurelien Jarno 1595b7fdb3abSAurelien Jarno@option{signal} controls if signals are enabled on the terminal, that includes 1596b7fdb3abSAurelien Jarnoexiting QEMU with the key sequence @key{Control-c}. This option is enabled by 1597b7fdb3abSAurelien Jarnodefault, use @option{signal=off} to disable it. 1598b7fdb3abSAurelien Jarno 1599b7fdb3abSAurelien Jarno@option{stdio} is not available on Windows hosts. 16007273a2dbSMatthew Booth 16017273a2dbSMatthew Booth@item -chardev braille ,id=@var{id} 16027273a2dbSMatthew Booth 16037273a2dbSMatthew BoothConnect to a local BrlAPI server. @option{braille} does not take any options. 16047273a2dbSMatthew Booth 16057273a2dbSMatthew Booth@item -chardev tty ,id=@var{id} ,path=@var{path} 16067273a2dbSMatthew Booth 16077273a2dbSMatthew BoothConnect to a local tty device. 16087273a2dbSMatthew Booth 16097273a2dbSMatthew Booth@option{tty} is only available on Linux, Sun, FreeBSD, NetBSD, OpenBSD and 16107273a2dbSMatthew BoothDragonFlyBSD hosts. 16117273a2dbSMatthew Booth 16127273a2dbSMatthew Booth@option{path} specifies the path to the tty. @option{path} is required. 16137273a2dbSMatthew Booth 16147273a2dbSMatthew Booth@item -chardev parport ,id=@var{id} ,path=@var{path} 16157273a2dbSMatthew Booth 16167273a2dbSMatthew Booth@option{parport} is only available on Linux, FreeBSD and DragonFlyBSD hosts. 16177273a2dbSMatthew Booth 16187273a2dbSMatthew BoothConnect to a local parallel port. 16197273a2dbSMatthew Booth 16207273a2dbSMatthew Booth@option{path} specifies the path to the parallel port device. @option{path} is 16217273a2dbSMatthew Boothrequired. 16227273a2dbSMatthew Booth 1623cbcc6336SAlon Levy#if defined(CONFIG_SPICE) 1624cbcc6336SAlon Levy@item -chardev spicevmc ,id=@var{id} ,debug=@var{debug}, name=@var{name} 1625cbcc6336SAlon Levy 1626cbcc6336SAlon Levy@option{debug} debug level for spicevmc 1627cbcc6336SAlon Levy 1628cbcc6336SAlon Levy@option{name} name of spice channel to connect to 1629cbcc6336SAlon Levy 1630cbcc6336SAlon LevyConnect to a spice virtual machine channel, such as vdiport. 1631cbcc6336SAlon Levy#endif 1632cbcc6336SAlon Levy 16337273a2dbSMatthew Booth@end table 16347273a2dbSMatthew BoothETEXI 16357273a2dbSMatthew Booth 16367273a2dbSMatthew BoothDEFHEADING() 16377273a2dbSMatthew Booth 16387273a2dbSMatthew BoothDEFHEADING(Bluetooth(R) options:) 16397273a2dbSMatthew Booth 16405824d651Sblueswir1DEF("bt", HAS_ARG, QEMU_OPTION_bt, \ 16415824d651Sblueswir1 "-bt hci,null dumb bluetooth HCI - doesn't respond to commands\n" \ 16425824d651Sblueswir1 "-bt hci,host[:id]\n" \ 16435824d651Sblueswir1 " use host's HCI with the given name\n" \ 16445824d651Sblueswir1 "-bt hci[,vlan=n]\n" \ 16455824d651Sblueswir1 " emulate a standard HCI in virtual scatternet 'n'\n" \ 16465824d651Sblueswir1 "-bt vhci[,vlan=n]\n" \ 16475824d651Sblueswir1 " add host computer to virtual scatternet 'n' using VHCI\n" \ 16485824d651Sblueswir1 "-bt device:dev[,vlan=n]\n" \ 1649ad96090aSBlue Swirl " emulate a bluetooth device 'dev' in scatternet 'n'\n", 1650ad96090aSBlue Swirl QEMU_ARCH_ALL) 16515824d651Sblueswir1STEXI 16525824d651Sblueswir1@table @option 16535824d651Sblueswir1 16545824d651Sblueswir1@item -bt hci[...] 16556616b2adSStefan Weil@findex -bt 16565824d651Sblueswir1Defines the function of the corresponding Bluetooth HCI. -bt options 16575824d651Sblueswir1are matched with the HCIs present in the chosen machine type. For 16585824d651Sblueswir1example when emulating a machine with only one HCI built into it, only 16595824d651Sblueswir1the first @code{-bt hci[...]} option is valid and defines the HCI's 16605824d651Sblueswir1logic. The Transport Layer is decided by the machine type. Currently 16615824d651Sblueswir1the machines @code{n800} and @code{n810} have one HCI and all other 16625824d651Sblueswir1machines have none. 16635824d651Sblueswir1 16645824d651Sblueswir1@anchor{bt-hcis} 16655824d651Sblueswir1The following three types are recognized: 16665824d651Sblueswir1 1667b3f046c2SKevin Wolf@table @option 16685824d651Sblueswir1@item -bt hci,null 16695824d651Sblueswir1(default) The corresponding Bluetooth HCI assumes no internal logic 16705824d651Sblueswir1and will not respond to any HCI commands or emit events. 16715824d651Sblueswir1 16725824d651Sblueswir1@item -bt hci,host[:@var{id}] 16735824d651Sblueswir1(@code{bluez} only) The corresponding HCI passes commands / events 16745824d651Sblueswir1to / from the physical HCI identified by the name @var{id} (default: 16755824d651Sblueswir1@code{hci0}) on the computer running QEMU. Only available on @code{bluez} 16765824d651Sblueswir1capable systems like Linux. 16775824d651Sblueswir1 16785824d651Sblueswir1@item -bt hci[,vlan=@var{n}] 16795824d651Sblueswir1Add a virtual, standard HCI that will participate in the Bluetooth 16805824d651Sblueswir1scatternet @var{n} (default @code{0}). Similarly to @option{-net} 16815824d651Sblueswir1VLANs, devices inside a bluetooth network @var{n} can only communicate 16825824d651Sblueswir1with other devices in the same network (scatternet). 16835824d651Sblueswir1@end table 16845824d651Sblueswir1 16855824d651Sblueswir1@item -bt vhci[,vlan=@var{n}] 16865824d651Sblueswir1(Linux-host only) Create a HCI in scatternet @var{n} (default 0) attached 16875824d651Sblueswir1to the host bluetooth stack instead of to the emulated target. This 16885824d651Sblueswir1allows the host and target machines to participate in a common scatternet 16895824d651Sblueswir1and communicate. Requires the Linux @code{vhci} driver installed. Can 16905824d651Sblueswir1be used as following: 16915824d651Sblueswir1 16925824d651Sblueswir1@example 16935824d651Sblueswir1qemu [...OPTIONS...] -bt hci,vlan=5 -bt vhci,vlan=5 16945824d651Sblueswir1@end example 16955824d651Sblueswir1 16965824d651Sblueswir1@item -bt device:@var{dev}[,vlan=@var{n}] 16975824d651Sblueswir1Emulate a bluetooth device @var{dev} and place it in network @var{n} 16985824d651Sblueswir1(default @code{0}). QEMU can only emulate one type of bluetooth devices 16995824d651Sblueswir1currently: 17005824d651Sblueswir1 1701b3f046c2SKevin Wolf@table @option 17025824d651Sblueswir1@item keyboard 17035824d651Sblueswir1Virtual wireless keyboard implementing the HIDP bluetooth profile. 17045824d651Sblueswir1@end table 17055824d651Sblueswir1@end table 17065824d651Sblueswir1ETEXI 17075824d651Sblueswir1 17085824d651Sblueswir1DEFHEADING() 17095824d651Sblueswir1 17107677f05dSAlexander GrafDEFHEADING(Linux/Multiboot boot specific:) 17115824d651Sblueswir1STEXI 17127677f05dSAlexander Graf 17137677f05dSAlexander GrafWhen using these options, you can use a given Linux or Multiboot 17147677f05dSAlexander Grafkernel without installing it in the disk image. It can be useful 17155824d651Sblueswir1for easier testing of various kernels. 17165824d651Sblueswir1 17175824d651Sblueswir1@table @option 17185824d651Sblueswir1ETEXI 17195824d651Sblueswir1 17205824d651Sblueswir1DEF("kernel", HAS_ARG, QEMU_OPTION_kernel, \ 1721ad96090aSBlue Swirl "-kernel bzImage use 'bzImage' as kernel image\n", QEMU_ARCH_ALL) 17225824d651Sblueswir1STEXI 17235824d651Sblueswir1@item -kernel @var{bzImage} 17246616b2adSStefan Weil@findex -kernel 17257677f05dSAlexander GrafUse @var{bzImage} as kernel image. The kernel can be either a Linux kernel 17267677f05dSAlexander Grafor in multiboot format. 17275824d651Sblueswir1ETEXI 17285824d651Sblueswir1 17295824d651Sblueswir1DEF("append", HAS_ARG, QEMU_OPTION_append, \ 1730ad96090aSBlue Swirl "-append cmdline use 'cmdline' as kernel command line\n", QEMU_ARCH_ALL) 17315824d651Sblueswir1STEXI 17325824d651Sblueswir1@item -append @var{cmdline} 17336616b2adSStefan Weil@findex -append 17345824d651Sblueswir1Use @var{cmdline} as kernel command line 17355824d651Sblueswir1ETEXI 17365824d651Sblueswir1 17375824d651Sblueswir1DEF("initrd", HAS_ARG, QEMU_OPTION_initrd, \ 1738ad96090aSBlue Swirl "-initrd file use 'file' as initial ram disk\n", QEMU_ARCH_ALL) 17395824d651Sblueswir1STEXI 17405824d651Sblueswir1@item -initrd @var{file} 17416616b2adSStefan Weil@findex -initrd 17425824d651Sblueswir1Use @var{file} as initial ram disk. 17437677f05dSAlexander Graf 17447677f05dSAlexander Graf@item -initrd "@var{file1} arg=foo,@var{file2}" 17457677f05dSAlexander Graf 17467677f05dSAlexander GrafThis syntax is only available with multiboot. 17477677f05dSAlexander Graf 17487677f05dSAlexander GrafUse @var{file1} and @var{file2} as modules and pass arg=foo as parameter to the 17497677f05dSAlexander Graffirst module. 17505824d651Sblueswir1ETEXI 17515824d651Sblueswir1 17525824d651Sblueswir1STEXI 17535824d651Sblueswir1@end table 17545824d651Sblueswir1ETEXI 17555824d651Sblueswir1 17565824d651Sblueswir1DEFHEADING() 17575824d651Sblueswir1 17585824d651Sblueswir1DEFHEADING(Debug/Expert options:) 17595824d651Sblueswir1 17605824d651Sblueswir1STEXI 17615824d651Sblueswir1@table @option 17625824d651Sblueswir1ETEXI 17635824d651Sblueswir1 17645824d651Sblueswir1DEF("serial", HAS_ARG, QEMU_OPTION_serial, \ 1765ad96090aSBlue Swirl "-serial dev redirect the serial port to char device 'dev'\n", 1766ad96090aSBlue Swirl QEMU_ARCH_ALL) 17675824d651Sblueswir1STEXI 17685824d651Sblueswir1@item -serial @var{dev} 17696616b2adSStefan Weil@findex -serial 17705824d651Sblueswir1Redirect the virtual serial port to host character device 17715824d651Sblueswir1@var{dev}. The default device is @code{vc} in graphical mode and 17725824d651Sblueswir1@code{stdio} in non graphical mode. 17735824d651Sblueswir1 17745824d651Sblueswir1This option can be used several times to simulate up to 4 serial 17755824d651Sblueswir1ports. 17765824d651Sblueswir1 17775824d651Sblueswir1Use @code{-serial none} to disable all serial ports. 17785824d651Sblueswir1 17795824d651Sblueswir1Available character devices are: 1780b3f046c2SKevin Wolf@table @option 17814e257e5eSKevin Wolf@item vc[:@var{W}x@var{H}] 17825824d651Sblueswir1Virtual console. Optionally, a width and height can be given in pixel with 17835824d651Sblueswir1@example 17845824d651Sblueswir1vc:800x600 17855824d651Sblueswir1@end example 17865824d651Sblueswir1It is also possible to specify width or height in characters: 17875824d651Sblueswir1@example 17885824d651Sblueswir1vc:80Cx24C 17895824d651Sblueswir1@end example 17905824d651Sblueswir1@item pty 17915824d651Sblueswir1[Linux only] Pseudo TTY (a new PTY is automatically allocated) 17925824d651Sblueswir1@item none 17935824d651Sblueswir1No device is allocated. 17945824d651Sblueswir1@item null 17955824d651Sblueswir1void device 17965824d651Sblueswir1@item /dev/XXX 17975824d651Sblueswir1[Linux only] Use host tty, e.g. @file{/dev/ttyS0}. The host serial port 17985824d651Sblueswir1parameters are set according to the emulated ones. 17995824d651Sblueswir1@item /dev/parport@var{N} 18005824d651Sblueswir1[Linux only, parallel port only] Use host parallel port 18015824d651Sblueswir1@var{N}. Currently SPP and EPP parallel port features can be used. 18025824d651Sblueswir1@item file:@var{filename} 18035824d651Sblueswir1Write output to @var{filename}. No character can be read. 18045824d651Sblueswir1@item stdio 18055824d651Sblueswir1[Unix only] standard input/output 18065824d651Sblueswir1@item pipe:@var{filename} 18075824d651Sblueswir1name pipe @var{filename} 18085824d651Sblueswir1@item COM@var{n} 18095824d651Sblueswir1[Windows only] Use host serial port @var{n} 18105824d651Sblueswir1@item udp:[@var{remote_host}]:@var{remote_port}[@@[@var{src_ip}]:@var{src_port}] 18115824d651Sblueswir1This implements UDP Net Console. 18125824d651Sblueswir1When @var{remote_host} or @var{src_ip} are not specified 18135824d651Sblueswir1they default to @code{0.0.0.0}. 18145824d651Sblueswir1When not using a specified @var{src_port} a random port is automatically chosen. 18155824d651Sblueswir1 18165824d651Sblueswir1If you just want a simple readonly console you can use @code{netcat} or 18175824d651Sblueswir1@code{nc}, by starting qemu with: @code{-serial udp::4555} and nc as: 18185824d651Sblueswir1@code{nc -u -l -p 4555}. Any time qemu writes something to that port it 18195824d651Sblueswir1will appear in the netconsole session. 18205824d651Sblueswir1 18215824d651Sblueswir1If you plan to send characters back via netconsole or you want to stop 18225824d651Sblueswir1and start qemu a lot of times, you should have qemu use the same 18235824d651Sblueswir1source port each time by using something like @code{-serial 18245824d651Sblueswir1udp::4555@@:4556} to qemu. Another approach is to use a patched 18255824d651Sblueswir1version of netcat which can listen to a TCP port and send and receive 18265824d651Sblueswir1characters via udp. If you have a patched version of netcat which 18275824d651Sblueswir1activates telnet remote echo and single char transfer, then you can 18285824d651Sblueswir1use the following options to step up a netcat redirector to allow 18295824d651Sblueswir1telnet on port 5555 to access the qemu port. 18305824d651Sblueswir1@table @code 18315824d651Sblueswir1@item Qemu Options: 18325824d651Sblueswir1-serial udp::4555@@:4556 18335824d651Sblueswir1@item netcat options: 18345824d651Sblueswir1-u -P 4555 -L 0.0.0.0:4556 -t -p 5555 -I -T 18355824d651Sblueswir1@item telnet options: 18365824d651Sblueswir1localhost 5555 18375824d651Sblueswir1@end table 18385824d651Sblueswir1 18395824d651Sblueswir1@item tcp:[@var{host}]:@var{port}[,@var{server}][,nowait][,nodelay] 18405824d651Sblueswir1The TCP Net Console has two modes of operation. It can send the serial 18415824d651Sblueswir1I/O to a location or wait for a connection from a location. By default 18425824d651Sblueswir1the TCP Net Console is sent to @var{host} at the @var{port}. If you use 18435824d651Sblueswir1the @var{server} option QEMU will wait for a client socket application 18445824d651Sblueswir1to connect to the port before continuing, unless the @code{nowait} 18455824d651Sblueswir1option was specified. The @code{nodelay} option disables the Nagle buffering 18465824d651Sblueswir1algorithm. If @var{host} is omitted, 0.0.0.0 is assumed. Only 18475824d651Sblueswir1one TCP connection at a time is accepted. You can use @code{telnet} to 18485824d651Sblueswir1connect to the corresponding character device. 18495824d651Sblueswir1@table @code 18505824d651Sblueswir1@item Example to send tcp console to 192.168.0.2 port 4444 18515824d651Sblueswir1-serial tcp:192.168.0.2:4444 18525824d651Sblueswir1@item Example to listen and wait on port 4444 for connection 18535824d651Sblueswir1-serial tcp::4444,server 18545824d651Sblueswir1@item Example to not wait and listen on ip 192.168.0.100 port 4444 18555824d651Sblueswir1-serial tcp:192.168.0.100:4444,server,nowait 18565824d651Sblueswir1@end table 18575824d651Sblueswir1 18585824d651Sblueswir1@item telnet:@var{host}:@var{port}[,server][,nowait][,nodelay] 18595824d651Sblueswir1The telnet protocol is used instead of raw tcp sockets. The options 18605824d651Sblueswir1work the same as if you had specified @code{-serial tcp}. The 18615824d651Sblueswir1difference is that the port acts like a telnet server or client using 18625824d651Sblueswir1telnet option negotiation. This will also allow you to send the 18635824d651Sblueswir1MAGIC_SYSRQ sequence if you use a telnet that supports sending the break 18645824d651Sblueswir1sequence. Typically in unix telnet you do it with Control-] and then 18655824d651Sblueswir1type "send break" followed by pressing the enter key. 18665824d651Sblueswir1 18675824d651Sblueswir1@item unix:@var{path}[,server][,nowait] 18685824d651Sblueswir1A unix domain socket is used instead of a tcp socket. The option works the 18695824d651Sblueswir1same as if you had specified @code{-serial tcp} except the unix domain socket 18705824d651Sblueswir1@var{path} is used for connections. 18715824d651Sblueswir1 18725824d651Sblueswir1@item mon:@var{dev_string} 18735824d651Sblueswir1This is a special option to allow the monitor to be multiplexed onto 18745824d651Sblueswir1another serial port. The monitor is accessed with key sequence of 18755824d651Sblueswir1@key{Control-a} and then pressing @key{c}. See monitor access 18765824d651Sblueswir1@ref{pcsys_keys} in the -nographic section for more keys. 18775824d651Sblueswir1@var{dev_string} should be any one of the serial devices specified 18785824d651Sblueswir1above. An example to multiplex the monitor onto a telnet server 18795824d651Sblueswir1listening on port 4444 would be: 18805824d651Sblueswir1@table @code 18815824d651Sblueswir1@item -serial mon:telnet::4444,server,nowait 18825824d651Sblueswir1@end table 18835824d651Sblueswir1 18845824d651Sblueswir1@item braille 18855824d651Sblueswir1Braille device. This will use BrlAPI to display the braille output on a real 18865824d651Sblueswir1or fake device. 18875824d651Sblueswir1 1888be8b28a9SKevin Wolf@item msmouse 1889be8b28a9SKevin WolfThree button serial mouse. Configure the guest to use Microsoft protocol. 18905824d651Sblueswir1@end table 18915824d651Sblueswir1ETEXI 18925824d651Sblueswir1 18935824d651Sblueswir1DEF("parallel", HAS_ARG, QEMU_OPTION_parallel, \ 1894ad96090aSBlue Swirl "-parallel dev redirect the parallel port to char device 'dev'\n", 1895ad96090aSBlue Swirl QEMU_ARCH_ALL) 18965824d651Sblueswir1STEXI 18975824d651Sblueswir1@item -parallel @var{dev} 18986616b2adSStefan Weil@findex -parallel 18995824d651Sblueswir1Redirect the virtual parallel port to host device @var{dev} (same 19005824d651Sblueswir1devices as the serial port). On Linux hosts, @file{/dev/parportN} can 19015824d651Sblueswir1be used to use hardware devices connected on the corresponding host 19025824d651Sblueswir1parallel port. 19035824d651Sblueswir1 19045824d651Sblueswir1This option can be used several times to simulate up to 3 parallel 19055824d651Sblueswir1ports. 19065824d651Sblueswir1 19075824d651Sblueswir1Use @code{-parallel none} to disable all parallel ports. 19085824d651Sblueswir1ETEXI 19095824d651Sblueswir1 19105824d651Sblueswir1DEF("monitor", HAS_ARG, QEMU_OPTION_monitor, \ 1911ad96090aSBlue Swirl "-monitor dev redirect the monitor to char device 'dev'\n", 1912ad96090aSBlue Swirl QEMU_ARCH_ALL) 19135824d651Sblueswir1STEXI 19144e307fc8SGerd Hoffmann@item -monitor @var{dev} 19156616b2adSStefan Weil@findex -monitor 19165824d651Sblueswir1Redirect the monitor to host device @var{dev} (same devices as the 19175824d651Sblueswir1serial port). 19185824d651Sblueswir1The default device is @code{vc} in graphical mode and @code{stdio} in 19195824d651Sblueswir1non graphical mode. 19205824d651Sblueswir1ETEXI 19216ca5582dSGerd HoffmannDEF("qmp", HAS_ARG, QEMU_OPTION_qmp, \ 1922ad96090aSBlue Swirl "-qmp dev like -monitor but opens in 'control' mode\n", 1923ad96090aSBlue Swirl QEMU_ARCH_ALL) 192495d5f08bSStefan WeilSTEXI 192595d5f08bSStefan Weil@item -qmp @var{dev} 19266616b2adSStefan Weil@findex -qmp 192795d5f08bSStefan WeilLike -monitor but opens in 'control' mode. 192895d5f08bSStefan WeilETEXI 19295824d651Sblueswir1 193022a0e04bSGerd HoffmannDEF("mon", HAS_ARG, QEMU_OPTION_mon, \ 1931ad96090aSBlue Swirl "-mon chardev=[name][,mode=readline|control][,default]\n", QEMU_ARCH_ALL) 193222a0e04bSGerd HoffmannSTEXI 193322a0e04bSGerd Hoffmann@item -mon chardev=[name][,mode=readline|control][,default] 19346616b2adSStefan Weil@findex -mon 193522a0e04bSGerd HoffmannSetup monitor on chardev @var{name}. 193622a0e04bSGerd HoffmannETEXI 193722a0e04bSGerd Hoffmann 1938c9f398e5SH. Peter AnvinDEF("debugcon", HAS_ARG, QEMU_OPTION_debugcon, \ 1939ad96090aSBlue Swirl "-debugcon dev redirect the debug console to char device 'dev'\n", 1940ad96090aSBlue Swirl QEMU_ARCH_ALL) 1941c9f398e5SH. Peter AnvinSTEXI 1942c9f398e5SH. Peter Anvin@item -debugcon @var{dev} 19436616b2adSStefan Weil@findex -debugcon 1944c9f398e5SH. Peter AnvinRedirect the debug console to host device @var{dev} (same devices as the 1945c9f398e5SH. Peter Anvinserial port). The debug console is an I/O port which is typically port 1946c9f398e5SH. Peter Anvin0xe9; writing to that I/O port sends output to this device. 1947c9f398e5SH. Peter AnvinThe default device is @code{vc} in graphical mode and @code{stdio} in 1948c9f398e5SH. Peter Anvinnon graphical mode. 1949c9f398e5SH. Peter AnvinETEXI 1950c9f398e5SH. Peter Anvin 19515824d651Sblueswir1DEF("pidfile", HAS_ARG, QEMU_OPTION_pidfile, \ 1952ad96090aSBlue Swirl "-pidfile file write PID to 'file'\n", QEMU_ARCH_ALL) 19535824d651Sblueswir1STEXI 19545824d651Sblueswir1@item -pidfile @var{file} 19556616b2adSStefan Weil@findex -pidfile 19565824d651Sblueswir1Store the QEMU process PID in @var{file}. It is useful if you launch QEMU 19575824d651Sblueswir1from a script. 19585824d651Sblueswir1ETEXI 19595824d651Sblueswir1 19601b530a6dSaurel32DEF("singlestep", 0, QEMU_OPTION_singlestep, \ 1961ad96090aSBlue Swirl "-singlestep always run in singlestep mode\n", QEMU_ARCH_ALL) 19621b530a6dSaurel32STEXI 19631b530a6dSaurel32@item -singlestep 19646616b2adSStefan Weil@findex -singlestep 19651b530a6dSaurel32Run the emulation in single step mode. 19661b530a6dSaurel32ETEXI 19671b530a6dSaurel32 19685824d651Sblueswir1DEF("S", 0, QEMU_OPTION_S, \ 1969ad96090aSBlue Swirl "-S freeze CPU at startup (use 'c' to start execution)\n", 1970ad96090aSBlue Swirl QEMU_ARCH_ALL) 19715824d651Sblueswir1STEXI 19725824d651Sblueswir1@item -S 19736616b2adSStefan Weil@findex -S 19745824d651Sblueswir1Do not start CPU at startup (you must type 'c' in the monitor). 19755824d651Sblueswir1ETEXI 19765824d651Sblueswir1 197759030a8cSaliguoriDEF("gdb", HAS_ARG, QEMU_OPTION_gdb, \ 1978ad96090aSBlue Swirl "-gdb dev wait for gdb connection on 'dev'\n", QEMU_ARCH_ALL) 19795824d651Sblueswir1STEXI 198059030a8cSaliguori@item -gdb @var{dev} 19816616b2adSStefan Weil@findex -gdb 198259030a8cSaliguoriWait for gdb connection on device @var{dev} (@pxref{gdb_usage}). Typical 198359030a8cSaliguoriconnections will likely be TCP-based, but also UDP, pseudo TTY, or even 198459030a8cSaliguoristdio are reasonable use case. The latter is allowing to start qemu from 198559030a8cSaliguoriwithin gdb and establish the connection via a pipe: 198659030a8cSaliguori@example 198759030a8cSaliguori(gdb) target remote | exec qemu -gdb stdio ... 198859030a8cSaliguori@end example 19895824d651Sblueswir1ETEXI 19905824d651Sblueswir1 199159030a8cSaliguoriDEF("s", 0, QEMU_OPTION_s, \ 1992ad96090aSBlue Swirl "-s shorthand for -gdb tcp::" DEFAULT_GDBSTUB_PORT "\n", 1993ad96090aSBlue Swirl QEMU_ARCH_ALL) 19945824d651Sblueswir1STEXI 199559030a8cSaliguori@item -s 19966616b2adSStefan Weil@findex -s 199759030a8cSaliguoriShorthand for -gdb tcp::1234, i.e. open a gdbserver on TCP port 1234 199859030a8cSaliguori(@pxref{gdb_usage}). 19995824d651Sblueswir1ETEXI 20005824d651Sblueswir1 20015824d651Sblueswir1DEF("d", HAS_ARG, QEMU_OPTION_d, \ 2002ad96090aSBlue Swirl "-d item1,... output log to /tmp/qemu.log (use -d ? for a list of log items)\n", 2003ad96090aSBlue Swirl QEMU_ARCH_ALL) 20045824d651Sblueswir1STEXI 20055824d651Sblueswir1@item -d 20066616b2adSStefan Weil@findex -d 20075824d651Sblueswir1Output log in /tmp/qemu.log 20085824d651Sblueswir1ETEXI 20095824d651Sblueswir1 2010*c235d738SMatthew FernandezDEF("D", HAS_ARG, QEMU_OPTION_D, \ 2011*c235d738SMatthew Fernandez "-D logfile output log to logfile (instead of the default /tmp/qemu.log)\n", 2012*c235d738SMatthew Fernandez QEMU_ARCH_ALL) 2013*c235d738SMatthew FernandezSTEXI 2014*c235d738SMatthew Fernandez@item -D 2015*c235d738SMatthew Fernandez@findex -D 2016*c235d738SMatthew FernandezOutput log in logfile instead of /tmp/qemu.log 2017*c235d738SMatthew FernandezETEXI 2018*c235d738SMatthew Fernandez 20195824d651Sblueswir1DEF("hdachs", HAS_ARG, QEMU_OPTION_hdachs, \ 20205824d651Sblueswir1 "-hdachs c,h,s[,t]\n" \ 20215824d651Sblueswir1 " force hard disk 0 physical geometry and the optional BIOS\n" \ 2022ad96090aSBlue Swirl " translation (t=none or lba) (usually qemu can guess them)\n", 2023ad96090aSBlue Swirl QEMU_ARCH_ALL) 20245824d651Sblueswir1STEXI 20255824d651Sblueswir1@item -hdachs @var{c},@var{h},@var{s},[,@var{t}] 20266616b2adSStefan Weil@findex -hdachs 20275824d651Sblueswir1Force hard disk 0 physical geometry (1 <= @var{c} <= 16383, 1 <= 20285824d651Sblueswir1@var{h} <= 16, 1 <= @var{s} <= 63) and optionally force the BIOS 20295824d651Sblueswir1translation mode (@var{t}=none, lba or auto). Usually QEMU can guess 20305824d651Sblueswir1all those parameters. This option is useful for old MS-DOS disk 20315824d651Sblueswir1images. 20325824d651Sblueswir1ETEXI 20335824d651Sblueswir1 20345824d651Sblueswir1DEF("L", HAS_ARG, QEMU_OPTION_L, \ 2035ad96090aSBlue Swirl "-L path set the directory for the BIOS, VGA BIOS and keymaps\n", 2036ad96090aSBlue Swirl QEMU_ARCH_ALL) 20375824d651Sblueswir1STEXI 20385824d651Sblueswir1@item -L @var{path} 20396616b2adSStefan Weil@findex -L 20405824d651Sblueswir1Set the directory for the BIOS, VGA BIOS and keymaps. 20415824d651Sblueswir1ETEXI 20425824d651Sblueswir1 20435824d651Sblueswir1DEF("bios", HAS_ARG, QEMU_OPTION_bios, \ 2044ad96090aSBlue Swirl "-bios file set the filename for the BIOS\n", QEMU_ARCH_ALL) 20455824d651Sblueswir1STEXI 20465824d651Sblueswir1@item -bios @var{file} 20476616b2adSStefan Weil@findex -bios 20485824d651Sblueswir1Set the filename for the BIOS. 20495824d651Sblueswir1ETEXI 20505824d651Sblueswir1 20515824d651Sblueswir1DEF("enable-kvm", 0, QEMU_OPTION_enable_kvm, \ 2052ad96090aSBlue Swirl "-enable-kvm enable KVM full virtualization support\n", QEMU_ARCH_ALL) 20535824d651Sblueswir1STEXI 20545824d651Sblueswir1@item -enable-kvm 20556616b2adSStefan Weil@findex -enable-kvm 20565824d651Sblueswir1Enable KVM full virtualization support. This option is only available 20575824d651Sblueswir1if KVM support is enabled when compiling. 20585824d651Sblueswir1ETEXI 20595824d651Sblueswir1 2060303d4e86SAnthony PERARDDEF("machine", HAS_ARG, QEMU_OPTION_machine, \ 2061303d4e86SAnthony PERARD "-machine accel=accel1[:accel2] use an accelerator (kvm,xen,tcg), default is tcg\n", QEMU_ARCH_ALL) 2062303d4e86SAnthony PERARDSTEXI 2063303d4e86SAnthony PERARD@item -machine accel=@var{accels} 2064303d4e86SAnthony PERARD@findex -machine 2065303d4e86SAnthony PERARDThis is use to enable an accelerator, in kvm,xen,tcg. 2066303d4e86SAnthony PERARDBy default, it use only tcg. If there a more than one accelerator 2067303d4e86SAnthony PERARDspecified, the next one is used if the first don't work. 2068303d4e86SAnthony PERARDETEXI 2069303d4e86SAnthony PERARD 2070e37630caSaliguoriDEF("xen-domid", HAS_ARG, QEMU_OPTION_xen_domid, 2071ad96090aSBlue Swirl "-xen-domid id specify xen guest domain id\n", QEMU_ARCH_ALL) 2072e37630caSaliguoriDEF("xen-create", 0, QEMU_OPTION_xen_create, 2073e37630caSaliguori "-xen-create create domain using xen hypercalls, bypassing xend\n" 2074ad96090aSBlue Swirl " warning: should not be used when xend is in use\n", 2075ad96090aSBlue Swirl QEMU_ARCH_ALL) 2076e37630caSaliguoriDEF("xen-attach", 0, QEMU_OPTION_xen_attach, 2077e37630caSaliguori "-xen-attach attach to existing xen domain\n" 2078ad96090aSBlue Swirl " xend will use this when starting qemu\n", 2079ad96090aSBlue Swirl QEMU_ARCH_ALL) 208095d5f08bSStefan WeilSTEXI 208195d5f08bSStefan Weil@item -xen-domid @var{id} 20826616b2adSStefan Weil@findex -xen-domid 208395d5f08bSStefan WeilSpecify xen guest domain @var{id} (XEN only). 208495d5f08bSStefan Weil@item -xen-create 20856616b2adSStefan Weil@findex -xen-create 208695d5f08bSStefan WeilCreate domain using xen hypercalls, bypassing xend. 208795d5f08bSStefan WeilWarning: should not be used when xend is in use (XEN only). 208895d5f08bSStefan Weil@item -xen-attach 20896616b2adSStefan Weil@findex -xen-attach 209095d5f08bSStefan WeilAttach to existing xen domain. 209195d5f08bSStefan Weilxend will use this when starting qemu (XEN only). 209295d5f08bSStefan WeilETEXI 2093e37630caSaliguori 20945824d651Sblueswir1DEF("no-reboot", 0, QEMU_OPTION_no_reboot, \ 2095ad96090aSBlue Swirl "-no-reboot exit instead of rebooting\n", QEMU_ARCH_ALL) 20965824d651Sblueswir1STEXI 20975824d651Sblueswir1@item -no-reboot 20986616b2adSStefan Weil@findex -no-reboot 20995824d651Sblueswir1Exit instead of rebooting. 21005824d651Sblueswir1ETEXI 21015824d651Sblueswir1 21025824d651Sblueswir1DEF("no-shutdown", 0, QEMU_OPTION_no_shutdown, \ 2103ad96090aSBlue Swirl "-no-shutdown stop before shutdown\n", QEMU_ARCH_ALL) 21045824d651Sblueswir1STEXI 21055824d651Sblueswir1@item -no-shutdown 21066616b2adSStefan Weil@findex -no-shutdown 21075824d651Sblueswir1Don't exit QEMU on guest shutdown, but instead only stop the emulation. 21085824d651Sblueswir1This allows for instance switching to monitor to commit changes to the 21095824d651Sblueswir1disk image. 21105824d651Sblueswir1ETEXI 21115824d651Sblueswir1 21125824d651Sblueswir1DEF("loadvm", HAS_ARG, QEMU_OPTION_loadvm, \ 21135824d651Sblueswir1 "-loadvm [tag|id]\n" \ 2114ad96090aSBlue Swirl " start right away with a saved state (loadvm in monitor)\n", 2115ad96090aSBlue Swirl QEMU_ARCH_ALL) 21165824d651Sblueswir1STEXI 21175824d651Sblueswir1@item -loadvm @var{file} 21186616b2adSStefan Weil@findex -loadvm 21195824d651Sblueswir1Start right away with a saved state (@code{loadvm} in monitor) 21205824d651Sblueswir1ETEXI 21215824d651Sblueswir1 21225824d651Sblueswir1#ifndef _WIN32 21235824d651Sblueswir1DEF("daemonize", 0, QEMU_OPTION_daemonize, \ 2124ad96090aSBlue Swirl "-daemonize daemonize QEMU after initializing\n", QEMU_ARCH_ALL) 21255824d651Sblueswir1#endif 21265824d651Sblueswir1STEXI 21275824d651Sblueswir1@item -daemonize 21286616b2adSStefan Weil@findex -daemonize 21295824d651Sblueswir1Daemonize the QEMU process after initialization. QEMU will not detach from 21305824d651Sblueswir1standard IO until it is ready to receive connections on any of its devices. 21315824d651Sblueswir1This option is a useful way for external programs to launch QEMU without having 21325824d651Sblueswir1to cope with initialization race conditions. 21335824d651Sblueswir1ETEXI 21345824d651Sblueswir1 21355824d651Sblueswir1DEF("option-rom", HAS_ARG, QEMU_OPTION_option_rom, \ 2136ad96090aSBlue Swirl "-option-rom rom load a file, rom, into the option ROM space\n", 2137ad96090aSBlue Swirl QEMU_ARCH_ALL) 21385824d651Sblueswir1STEXI 21395824d651Sblueswir1@item -option-rom @var{file} 21406616b2adSStefan Weil@findex -option-rom 21415824d651Sblueswir1Load the contents of @var{file} as an option ROM. 21425824d651Sblueswir1This option is useful to load things like EtherBoot. 21435824d651Sblueswir1ETEXI 21445824d651Sblueswir1 21455824d651Sblueswir1DEF("clock", HAS_ARG, QEMU_OPTION_clock, \ 21465824d651Sblueswir1 "-clock force the use of the given methods for timer alarm.\n" \ 2147ad96090aSBlue Swirl " To see what timers are available use -clock ?\n", 2148ad96090aSBlue Swirl QEMU_ARCH_ALL) 21495824d651Sblueswir1STEXI 21505824d651Sblueswir1@item -clock @var{method} 21516616b2adSStefan Weil@findex -clock 21525824d651Sblueswir1Force the use of the given methods for timer alarm. To see what timers 21535824d651Sblueswir1are available use -clock ?. 21545824d651Sblueswir1ETEXI 21555824d651Sblueswir1 21561ed2fc1fSJan KiszkaHXCOMM Options deprecated by -rtc 2157ad96090aSBlue SwirlDEF("localtime", 0, QEMU_OPTION_localtime, "", QEMU_ARCH_ALL) 2158ad96090aSBlue SwirlDEF("startdate", HAS_ARG, QEMU_OPTION_startdate, "", QEMU_ARCH_ALL) 21595824d651Sblueswir1 21601ed2fc1fSJan KiszkaDEF("rtc", HAS_ARG, QEMU_OPTION_rtc, \ 21616875204cSJan Kiszka "-rtc [base=utc|localtime|date][,clock=host|vm][,driftfix=none|slew]\n" \ 2162ad96090aSBlue Swirl " set the RTC base and clock, enable drift fix for clock ticks (x86 only)\n", 2163ad96090aSBlue Swirl QEMU_ARCH_ALL) 21641ed2fc1fSJan Kiszka 21655824d651Sblueswir1STEXI 21665824d651Sblueswir1 21676875204cSJan Kiszka@item -rtc [base=utc|localtime|@var{date}][,clock=host|vm][,driftfix=none|slew] 21686616b2adSStefan Weil@findex -rtc 21691ed2fc1fSJan KiszkaSpecify @option{base} as @code{utc} or @code{localtime} to let the RTC start at the current 21701ed2fc1fSJan KiszkaUTC or local time, respectively. @code{localtime} is required for correct date in 21711ed2fc1fSJan KiszkaMS-DOS or Windows. To start at a specific point in time, provide @var{date} in the 21721ed2fc1fSJan Kiszkaformat @code{2006-06-17T16:01:21} or @code{2006-06-17}. The default base is UTC. 21731ed2fc1fSJan Kiszka 21746875204cSJan KiszkaBy default the RTC is driven by the host system time. This allows to use the 21756875204cSJan KiszkaRTC as accurate reference clock inside the guest, specifically if the host 21766875204cSJan Kiszkatime is smoothly following an accurate external reference clock, e.g. via NTP. 21776875204cSJan KiszkaIf you want to isolate the guest time from the host, even prevent it from 21786875204cSJan Kiszkaprogressing during suspension, you can set @option{clock} to @code{vm} instead. 21796875204cSJan Kiszka 21801ed2fc1fSJan KiszkaEnable @option{driftfix} (i386 targets only) if you experience time drift problems, 21811ed2fc1fSJan Kiszkaspecifically with Windows' ACPI HAL. This option will try to figure out how 21821ed2fc1fSJan Kiszkamany timer interrupts were not processed by the Windows guest and will 21831ed2fc1fSJan Kiszkare-inject them. 21845824d651Sblueswir1ETEXI 21855824d651Sblueswir1 21865824d651Sblueswir1DEF("icount", HAS_ARG, QEMU_OPTION_icount, \ 21875824d651Sblueswir1 "-icount [N|auto]\n" \ 2188bc14ca24Saliguori " enable virtual instruction counter with 2^N clock ticks per\n" \ 2189ad96090aSBlue Swirl " instruction\n", QEMU_ARCH_ALL) 21905824d651Sblueswir1STEXI 21914e257e5eSKevin Wolf@item -icount [@var{N}|auto] 21926616b2adSStefan Weil@findex -icount 21935824d651Sblueswir1Enable virtual instruction counter. The virtual cpu will execute one 21944e257e5eSKevin Wolfinstruction every 2^@var{N} ns of virtual time. If @code{auto} is specified 21955824d651Sblueswir1then the virtual cpu speed will be automatically adjusted to keep virtual 21965824d651Sblueswir1time within a few seconds of real time. 21975824d651Sblueswir1 21985824d651Sblueswir1Note that while this option can give deterministic behavior, it does not 21995824d651Sblueswir1provide cycle accurate emulation. Modern CPUs contain superscalar out of 22005824d651Sblueswir1order cores with complex cache hierarchies. The number of instructions 22015824d651Sblueswir1executed often has little or no correlation with actual performance. 22025824d651Sblueswir1ETEXI 22035824d651Sblueswir1 22049dd986ccSRichard W.M. JonesDEF("watchdog", HAS_ARG, QEMU_OPTION_watchdog, \ 22059dd986ccSRichard W.M. Jones "-watchdog i6300esb|ib700\n" \ 2206ad96090aSBlue Swirl " enable virtual hardware watchdog [default=none]\n", 2207ad96090aSBlue Swirl QEMU_ARCH_ALL) 22089dd986ccSRichard W.M. JonesSTEXI 22099dd986ccSRichard W.M. Jones@item -watchdog @var{model} 22106616b2adSStefan Weil@findex -watchdog 22119dd986ccSRichard W.M. JonesCreate a virtual hardware watchdog device. Once enabled (by a guest 22129dd986ccSRichard W.M. Jonesaction), the watchdog must be periodically polled by an agent inside 22139dd986ccSRichard W.M. Jonesthe guest or else the guest will be restarted. 22149dd986ccSRichard W.M. Jones 22159dd986ccSRichard W.M. JonesThe @var{model} is the model of hardware watchdog to emulate. Choices 22169dd986ccSRichard W.M. Jonesfor model are: @code{ib700} (iBASE 700) which is a very simple ISA 22179dd986ccSRichard W.M. Joneswatchdog with a single timer, or @code{i6300esb} (Intel 6300ESB I/O 22189dd986ccSRichard W.M. Jonescontroller hub) which is a much more featureful PCI-based dual-timer 22199dd986ccSRichard W.M. Joneswatchdog. Choose a model for which your guest has drivers. 22209dd986ccSRichard W.M. Jones 22219dd986ccSRichard W.M. JonesUse @code{-watchdog ?} to list available hardware models. Only one 22229dd986ccSRichard W.M. Joneswatchdog can be enabled for a guest. 22239dd986ccSRichard W.M. JonesETEXI 22249dd986ccSRichard W.M. Jones 22259dd986ccSRichard W.M. JonesDEF("watchdog-action", HAS_ARG, QEMU_OPTION_watchdog_action, \ 22269dd986ccSRichard W.M. Jones "-watchdog-action reset|shutdown|poweroff|pause|debug|none\n" \ 2227ad96090aSBlue Swirl " action when watchdog fires [default=reset]\n", 2228ad96090aSBlue Swirl QEMU_ARCH_ALL) 22299dd986ccSRichard W.M. JonesSTEXI 22309dd986ccSRichard W.M. Jones@item -watchdog-action @var{action} 22319dd986ccSRichard W.M. Jones 22329dd986ccSRichard W.M. JonesThe @var{action} controls what QEMU will do when the watchdog timer 22339dd986ccSRichard W.M. Jonesexpires. 22349dd986ccSRichard W.M. JonesThe default is 22359dd986ccSRichard W.M. Jones@code{reset} (forcefully reset the guest). 22369dd986ccSRichard W.M. JonesOther possible actions are: 22379dd986ccSRichard W.M. Jones@code{shutdown} (attempt to gracefully shutdown the guest), 22389dd986ccSRichard W.M. Jones@code{poweroff} (forcefully poweroff the guest), 22399dd986ccSRichard W.M. Jones@code{pause} (pause the guest), 22409dd986ccSRichard W.M. Jones@code{debug} (print a debug message and continue), or 22419dd986ccSRichard W.M. Jones@code{none} (do nothing). 22429dd986ccSRichard W.M. Jones 22439dd986ccSRichard W.M. JonesNote that the @code{shutdown} action requires that the guest responds 22449dd986ccSRichard W.M. Jonesto ACPI signals, which it may not be able to do in the sort of 22459dd986ccSRichard W.M. Jonessituations where the watchdog would have expired, and thus 22469dd986ccSRichard W.M. Jones@code{-watchdog-action shutdown} is not recommended for production use. 22479dd986ccSRichard W.M. Jones 22489dd986ccSRichard W.M. JonesExamples: 22499dd986ccSRichard W.M. Jones 22509dd986ccSRichard W.M. Jones@table @code 22519dd986ccSRichard W.M. Jones@item -watchdog i6300esb -watchdog-action pause 22529dd986ccSRichard W.M. Jones@item -watchdog ib700 22539dd986ccSRichard W.M. Jones@end table 22549dd986ccSRichard W.M. JonesETEXI 22559dd986ccSRichard W.M. Jones 22565824d651Sblueswir1DEF("echr", HAS_ARG, QEMU_OPTION_echr, \ 2257ad96090aSBlue Swirl "-echr chr set terminal escape character instead of ctrl-a\n", 2258ad96090aSBlue Swirl QEMU_ARCH_ALL) 22595824d651Sblueswir1STEXI 22605824d651Sblueswir1 22614e257e5eSKevin Wolf@item -echr @var{numeric_ascii_value} 22626616b2adSStefan Weil@findex -echr 22635824d651Sblueswir1Change the escape character used for switching to the monitor when using 22645824d651Sblueswir1monitor and serial sharing. The default is @code{0x01} when using the 22655824d651Sblueswir1@code{-nographic} option. @code{0x01} is equal to pressing 22665824d651Sblueswir1@code{Control-a}. You can select a different character from the ascii 22675824d651Sblueswir1control keys where 1 through 26 map to Control-a through Control-z. For 22685824d651Sblueswir1instance you could use the either of the following to change the escape 22695824d651Sblueswir1character to Control-t. 22705824d651Sblueswir1@table @code 22715824d651Sblueswir1@item -echr 0x14 22725824d651Sblueswir1@item -echr 20 22735824d651Sblueswir1@end table 22745824d651Sblueswir1ETEXI 22755824d651Sblueswir1 22765824d651Sblueswir1DEF("virtioconsole", HAS_ARG, QEMU_OPTION_virtiocon, \ 22775824d651Sblueswir1 "-virtioconsole c\n" \ 2278ad96090aSBlue Swirl " set virtio console\n", QEMU_ARCH_ALL) 22795824d651Sblueswir1STEXI 22805824d651Sblueswir1@item -virtioconsole @var{c} 22816616b2adSStefan Weil@findex -virtioconsole 22825824d651Sblueswir1Set virtio console. 228398b19252SAmit Shah 228498b19252SAmit ShahThis option is maintained for backward compatibility. 228598b19252SAmit Shah 228698b19252SAmit ShahPlease use @code{-device virtconsole} for the new way of invocation. 22875824d651Sblueswir1ETEXI 22885824d651Sblueswir1 22895824d651Sblueswir1DEF("show-cursor", 0, QEMU_OPTION_show_cursor, \ 2290ad96090aSBlue Swirl "-show-cursor show cursor\n", QEMU_ARCH_ALL) 22915824d651Sblueswir1STEXI 229295d5f08bSStefan Weil@item -show-cursor 22936616b2adSStefan Weil@findex -show-cursor 229495d5f08bSStefan WeilShow cursor. 22955824d651Sblueswir1ETEXI 22965824d651Sblueswir1 22975824d651Sblueswir1DEF("tb-size", HAS_ARG, QEMU_OPTION_tb_size, \ 2298ad96090aSBlue Swirl "-tb-size n set TB size\n", QEMU_ARCH_ALL) 22995824d651Sblueswir1STEXI 230095d5f08bSStefan Weil@item -tb-size @var{n} 23016616b2adSStefan Weil@findex -tb-size 230295d5f08bSStefan WeilSet TB size. 23035824d651Sblueswir1ETEXI 23045824d651Sblueswir1 23055824d651Sblueswir1DEF("incoming", HAS_ARG, QEMU_OPTION_incoming, \ 2306ad96090aSBlue Swirl "-incoming p prepare for incoming migration, listen on port p\n", 2307ad96090aSBlue Swirl QEMU_ARCH_ALL) 23085824d651Sblueswir1STEXI 230995d5f08bSStefan Weil@item -incoming @var{port} 23106616b2adSStefan Weil@findex -incoming 231195d5f08bSStefan WeilPrepare for incoming migration, listen on @var{port}. 23125824d651Sblueswir1ETEXI 23135824d651Sblueswir1 2314d8c208ddSGerd HoffmannDEF("nodefaults", 0, QEMU_OPTION_nodefaults, \ 2315ad96090aSBlue Swirl "-nodefaults don't create default devices\n", QEMU_ARCH_ALL) 2316d8c208ddSGerd HoffmannSTEXI 23173dbf2c7fSStefan Weil@item -nodefaults 23186616b2adSStefan Weil@findex -nodefaults 23193dbf2c7fSStefan WeilDon't create default devices. 2320d8c208ddSGerd HoffmannETEXI 2321d8c208ddSGerd Hoffmann 23225824d651Sblueswir1#ifndef _WIN32 23235824d651Sblueswir1DEF("chroot", HAS_ARG, QEMU_OPTION_chroot, \ 2324ad96090aSBlue Swirl "-chroot dir chroot to dir just before starting the VM\n", 2325ad96090aSBlue Swirl QEMU_ARCH_ALL) 23265824d651Sblueswir1#endif 23275824d651Sblueswir1STEXI 23284e257e5eSKevin Wolf@item -chroot @var{dir} 23296616b2adSStefan Weil@findex -chroot 23305824d651Sblueswir1Immediately before starting guest execution, chroot to the specified 23315824d651Sblueswir1directory. Especially useful in combination with -runas. 23325824d651Sblueswir1ETEXI 23335824d651Sblueswir1 23345824d651Sblueswir1#ifndef _WIN32 23355824d651Sblueswir1DEF("runas", HAS_ARG, QEMU_OPTION_runas, \ 2336ad96090aSBlue Swirl "-runas user change to user id user just before starting the VM\n", 2337ad96090aSBlue Swirl QEMU_ARCH_ALL) 23385824d651Sblueswir1#endif 23395824d651Sblueswir1STEXI 23404e257e5eSKevin Wolf@item -runas @var{user} 23416616b2adSStefan Weil@findex -runas 23425824d651Sblueswir1Immediately before starting guest execution, drop root privileges, switching 23435824d651Sblueswir1to the specified user. 23445824d651Sblueswir1ETEXI 23455824d651Sblueswir1 23465824d651Sblueswir1DEF("prom-env", HAS_ARG, QEMU_OPTION_prom_env, 23475824d651Sblueswir1 "-prom-env variable=value\n" 2348ad96090aSBlue Swirl " set OpenBIOS nvram variables\n", 2349ad96090aSBlue Swirl QEMU_ARCH_PPC | QEMU_ARCH_SPARC) 235095d5f08bSStefan WeilSTEXI 235195d5f08bSStefan Weil@item -prom-env @var{variable}=@var{value} 23526616b2adSStefan Weil@findex -prom-env 235395d5f08bSStefan WeilSet OpenBIOS nvram @var{variable} to given @var{value} (PPC, SPARC only). 235495d5f08bSStefan WeilETEXI 23555824d651Sblueswir1DEF("semihosting", 0, QEMU_OPTION_semihosting, 2356ad96090aSBlue Swirl "-semihosting semihosting mode\n", QEMU_ARCH_ARM | QEMU_ARCH_M68K) 235795d5f08bSStefan WeilSTEXI 235895d5f08bSStefan Weil@item -semihosting 23596616b2adSStefan Weil@findex -semihosting 236095d5f08bSStefan WeilSemihosting mode (ARM, M68K only). 236195d5f08bSStefan WeilETEXI 23625824d651Sblueswir1DEF("old-param", 0, QEMU_OPTION_old_param, 2363ad96090aSBlue Swirl "-old-param old param mode\n", QEMU_ARCH_ARM) 236495d5f08bSStefan WeilSTEXI 236595d5f08bSStefan Weil@item -old-param 23666616b2adSStefan Weil@findex -old-param (ARM) 236795d5f08bSStefan WeilOld param mode (ARM only). 236895d5f08bSStefan WeilETEXI 236995d5f08bSStefan Weil 2370715a664aSGerd HoffmannDEF("readconfig", HAS_ARG, QEMU_OPTION_readconfig, 2371ad96090aSBlue Swirl "-readconfig <file>\n", QEMU_ARCH_ALL) 23723dbf2c7fSStefan WeilSTEXI 23733dbf2c7fSStefan Weil@item -readconfig @var{file} 23746616b2adSStefan Weil@findex -readconfig 23753dbf2c7fSStefan WeilRead device configuration from @var{file}. 23763dbf2c7fSStefan WeilETEXI 2377715a664aSGerd HoffmannDEF("writeconfig", HAS_ARG, QEMU_OPTION_writeconfig, 2378715a664aSGerd Hoffmann "-writeconfig <file>\n" 2379ad96090aSBlue Swirl " read/write config file\n", QEMU_ARCH_ALL) 23803dbf2c7fSStefan WeilSTEXI 23813dbf2c7fSStefan Weil@item -writeconfig @var{file} 23826616b2adSStefan Weil@findex -writeconfig 23833dbf2c7fSStefan WeilWrite device configuration to @var{file}. 23843dbf2c7fSStefan WeilETEXI 2385292444cbSAnthony LiguoriDEF("nodefconfig", 0, QEMU_OPTION_nodefconfig, 2386292444cbSAnthony Liguori "-nodefconfig\n" 2387ad96090aSBlue Swirl " do not load default config files at startup\n", 2388ad96090aSBlue Swirl QEMU_ARCH_ALL) 2389292444cbSAnthony LiguoriSTEXI 2390292444cbSAnthony Liguori@item -nodefconfig 23916616b2adSStefan Weil@findex -nodefconfig 2392292444cbSAnthony LiguoriNormally QEMU loads a configuration file from @var{sysconfdir}/qemu.conf and 2393292444cbSAnthony Liguori@var{sysconfdir}/target-@var{ARCH}.conf on startup. The @code{-nodefconfig} 2394292444cbSAnthony Liguorioption will prevent QEMU from loading these configuration files at startup. 2395292444cbSAnthony LiguoriETEXI 2396ab6540d5SPrerna Saxena#ifdef CONFIG_SIMPLE_TRACE 2397ab6540d5SPrerna SaxenaDEF("trace", HAS_ARG, QEMU_OPTION_trace, 2398ab6540d5SPrerna Saxena "-trace\n" 2399ab6540d5SPrerna Saxena " Specify a trace file to log traces to\n", 2400ab6540d5SPrerna Saxena QEMU_ARCH_ALL) 2401ab6540d5SPrerna SaxenaSTEXI 2402ab6540d5SPrerna Saxena@item -trace 2403ab6540d5SPrerna Saxena@findex -trace 2404ab6540d5SPrerna SaxenaSpecify a trace file to log output traces to. 2405ab6540d5SPrerna SaxenaETEXI 2406ab6540d5SPrerna Saxena#endif 24073dbf2c7fSStefan Weil 24083dbf2c7fSStefan WeilHXCOMM This is the last statement. Insert new options before this line! 24093dbf2c7fSStefan WeilSTEXI 24103dbf2c7fSStefan Weil@end table 24113dbf2c7fSStefan WeilETEXI 2412