15824d651Sblueswir1HXCOMM Use DEFHEADING() to define headings in both help text and texi 25824d651Sblueswir1HXCOMM Text between STEXI and ETEXI are copied to texi version and 35824d651Sblueswir1HXCOMM discarded from C version 4ad96090aSBlue SwirlHXCOMM DEF(option, HAS_ARG/0, opt_enum, opt_help, arch_mask) is used to 5ad96090aSBlue SwirlHXCOMM construct option structures, enums and help message for specified 6ad96090aSBlue SwirlHXCOMM architectures. 75824d651Sblueswir1HXCOMM HXCOMM can be used for comments, discarded from both texi and C 85824d651Sblueswir1 95824d651Sblueswir1DEFHEADING(Standard options:) 105824d651Sblueswir1STEXI 115824d651Sblueswir1@table @option 125824d651Sblueswir1ETEXI 135824d651Sblueswir1 145824d651Sblueswir1DEF("help", 0, QEMU_OPTION_h, 15ad96090aSBlue Swirl "-h or -help display this help and exit\n", QEMU_ARCH_ALL) 165824d651Sblueswir1STEXI 175824d651Sblueswir1@item -h 186616b2adSStefan Weil@findex -h 195824d651Sblueswir1Display help and exit 205824d651Sblueswir1ETEXI 215824d651Sblueswir1 229bd7e6d9SpbrookDEF("version", 0, QEMU_OPTION_version, 23ad96090aSBlue Swirl "-version display version information and exit\n", QEMU_ARCH_ALL) 249bd7e6d9SpbrookSTEXI 259bd7e6d9Spbrook@item -version 266616b2adSStefan Weil@findex -version 279bd7e6d9SpbrookDisplay version information and exit 289bd7e6d9SpbrookETEXI 299bd7e6d9Spbrook 3080f52a66SJan KiszkaDEF("machine", HAS_ARG, QEMU_OPTION_machine, \ 3180f52a66SJan Kiszka "-machine [type=]name[,prop[=value][,...]]\n" 3280f52a66SJan Kiszka " selects emulated machine (-machine ? for list)\n" 3380f52a66SJan Kiszka " property accel=accel1[:accel2[:...]] selects accelerator\n" 3480f52a66SJan Kiszka " supported accelerators are kvm, xen, tcg (default: tcg)\n", 3580f52a66SJan Kiszka QEMU_ARCH_ALL) 365824d651Sblueswir1STEXI 3780f52a66SJan Kiszka@item -machine [type=]@var{name}[,prop=@var{value}[,...]] 3880f52a66SJan Kiszka@findex -machine 3980f52a66SJan KiszkaSelect the emulated machine by @var{name}. Use @code{-machine ?} to list 4080f52a66SJan Kiszkaavailable machines. Supported machine properties are: 4180f52a66SJan Kiszka@table @option 4280f52a66SJan Kiszka@item accel=@var{accels1}[:@var{accels2}[:...]] 4380f52a66SJan KiszkaThis is used to enable an accelerator. Depending on the target architecture, 4480f52a66SJan Kiszkakvm, xen, or tcg can be available. By default, tcg is used. If there is more 4580f52a66SJan Kiszkathan one accelerator specified, the next one is used if the previous one fails 4680f52a66SJan Kiszkato initialize. 4780f52a66SJan Kiszka@end table 485824d651Sblueswir1ETEXI 495824d651Sblueswir1 5080f52a66SJan KiszkaHXCOMM Deprecated by -machine 5180f52a66SJan KiszkaDEF("M", HAS_ARG, QEMU_OPTION_M, "", QEMU_ARCH_ALL) 5280f52a66SJan Kiszka 535824d651Sblueswir1DEF("cpu", HAS_ARG, QEMU_OPTION_cpu, 54ad96090aSBlue Swirl "-cpu cpu select CPU (-cpu ? for list)\n", QEMU_ARCH_ALL) 555824d651Sblueswir1STEXI 565824d651Sblueswir1@item -cpu @var{model} 576616b2adSStefan Weil@findex -cpu 585824d651Sblueswir1Select CPU model (-cpu ? for list and additional feature selection) 595824d651Sblueswir1ETEXI 605824d651Sblueswir1 615824d651Sblueswir1DEF("smp", HAS_ARG, QEMU_OPTION_smp, 6258a04db1SAndre Przywara "-smp n[,maxcpus=cpus][,cores=cores][,threads=threads][,sockets=sockets]\n" 636be68d7eSJes Sorensen " set the number of CPUs to 'n' [default=1]\n" 646be68d7eSJes Sorensen " maxcpus= maximum number of total cpus, including\n" 65ca1a8a06SBruce Rogers " offline CPUs for hotplug, etc\n" 6658a04db1SAndre Przywara " cores= number of CPU cores on one socket\n" 6758a04db1SAndre Przywara " threads= number of threads on one CPU core\n" 68ad96090aSBlue Swirl " sockets= number of discrete sockets in the system\n", 69ad96090aSBlue Swirl QEMU_ARCH_ALL) 705824d651Sblueswir1STEXI 7158a04db1SAndre Przywara@item -smp @var{n}[,cores=@var{cores}][,threads=@var{threads}][,sockets=@var{sockets}][,maxcpus=@var{maxcpus}] 726616b2adSStefan Weil@findex -smp 735824d651Sblueswir1Simulate an SMP system with @var{n} CPUs. On the PC target, up to 255 745824d651Sblueswir1CPUs are supported. On Sparc32 target, Linux limits the number of usable CPUs 755824d651Sblueswir1to 4. 7658a04db1SAndre PrzywaraFor the PC target, the number of @var{cores} per socket, the number 7758a04db1SAndre Przywaraof @var{threads} per cores and the total number of @var{sockets} can be 7858a04db1SAndre Przywaraspecified. Missing values will be computed. If any on the three values is 7958a04db1SAndre Przywaragiven, the total number of CPUs @var{n} can be omitted. @var{maxcpus} 8058a04db1SAndre Przywaraspecifies the maximum number of hotpluggable CPUs. 815824d651Sblueswir1ETEXI 825824d651Sblueswir1 83268a362cSaliguoriDEF("numa", HAS_ARG, QEMU_OPTION_numa, 84ad96090aSBlue Swirl "-numa node[,mem=size][,cpus=cpu[-cpu]][,nodeid=node]\n", QEMU_ARCH_ALL) 85268a362cSaliguoriSTEXI 86268a362cSaliguori@item -numa @var{opts} 876616b2adSStefan Weil@findex -numa 88268a362cSaliguoriSimulate a multi node NUMA system. If mem and cpus are omitted, resources 89268a362cSaliguoriare split equally. 90268a362cSaliguoriETEXI 91268a362cSaliguori 925824d651Sblueswir1DEF("fda", HAS_ARG, QEMU_OPTION_fda, 93ad96090aSBlue Swirl "-fda/-fdb file use 'file' as floppy disk 0/1 image\n", QEMU_ARCH_ALL) 94ad96090aSBlue SwirlDEF("fdb", HAS_ARG, QEMU_OPTION_fdb, "", QEMU_ARCH_ALL) 955824d651Sblueswir1STEXI 965824d651Sblueswir1@item -fda @var{file} 975824d651Sblueswir1@item -fdb @var{file} 986616b2adSStefan Weil@findex -fda 996616b2adSStefan Weil@findex -fdb 1005824d651Sblueswir1Use @var{file} as floppy disk 0/1 image (@pxref{disk_images}). You can 1015824d651Sblueswir1use the host floppy by using @file{/dev/fd0} as filename (@pxref{host_drives}). 1025824d651Sblueswir1ETEXI 1035824d651Sblueswir1 1045824d651Sblueswir1DEF("hda", HAS_ARG, QEMU_OPTION_hda, 105ad96090aSBlue Swirl "-hda/-hdb file use 'file' as IDE hard disk 0/1 image\n", QEMU_ARCH_ALL) 106ad96090aSBlue SwirlDEF("hdb", HAS_ARG, QEMU_OPTION_hdb, "", QEMU_ARCH_ALL) 1075824d651Sblueswir1DEF("hdc", HAS_ARG, QEMU_OPTION_hdc, 108ad96090aSBlue Swirl "-hdc/-hdd file use 'file' as IDE hard disk 2/3 image\n", QEMU_ARCH_ALL) 109ad96090aSBlue SwirlDEF("hdd", HAS_ARG, QEMU_OPTION_hdd, "", QEMU_ARCH_ALL) 1105824d651Sblueswir1STEXI 1115824d651Sblueswir1@item -hda @var{file} 1125824d651Sblueswir1@item -hdb @var{file} 1135824d651Sblueswir1@item -hdc @var{file} 1145824d651Sblueswir1@item -hdd @var{file} 1156616b2adSStefan Weil@findex -hda 1166616b2adSStefan Weil@findex -hdb 1176616b2adSStefan Weil@findex -hdc 1186616b2adSStefan Weil@findex -hdd 1195824d651Sblueswir1Use @var{file} as hard disk 0, 1, 2 or 3 image (@pxref{disk_images}). 1205824d651Sblueswir1ETEXI 1215824d651Sblueswir1 1225824d651Sblueswir1DEF("cdrom", HAS_ARG, QEMU_OPTION_cdrom, 123ad96090aSBlue Swirl "-cdrom file use 'file' as IDE cdrom image (cdrom is ide1 master)\n", 124ad96090aSBlue Swirl QEMU_ARCH_ALL) 1255824d651Sblueswir1STEXI 1265824d651Sblueswir1@item -cdrom @var{file} 1276616b2adSStefan Weil@findex -cdrom 1285824d651Sblueswir1Use @var{file} as CD-ROM image (you cannot use @option{-hdc} and 1295824d651Sblueswir1@option{-cdrom} at the same time). You can use the host CD-ROM by 1305824d651Sblueswir1using @file{/dev/cdrom} as filename (@pxref{host_drives}). 1315824d651Sblueswir1ETEXI 1325824d651Sblueswir1 1335824d651Sblueswir1DEF("drive", HAS_ARG, QEMU_OPTION_drive, 1345824d651Sblueswir1 "-drive [file=file][,if=type][,bus=n][,unit=m][,media=d][,index=i]\n" 1355824d651Sblueswir1 " [,cyls=c,heads=h,secs=s[,trans=t]][,snapshot=on|off]\n" 136*92196b2fSStefan Hajnoczi " [,cache=writethrough|writeback|none|directsync|unsafe][,format=f]\n" 137016f5cf6SAlexander Graf " [,serial=s][,addr=A][,id=name][,aio=threads|native]\n" 138016f5cf6SAlexander Graf " [,readonly=on|off]\n" 139ad96090aSBlue Swirl " use 'file' as a drive image\n", QEMU_ARCH_ALL) 1405824d651Sblueswir1STEXI 1415824d651Sblueswir1@item -drive @var{option}[,@var{option}[,@var{option}[,...]]] 1426616b2adSStefan Weil@findex -drive 1435824d651Sblueswir1 1445824d651Sblueswir1Define a new drive. Valid options are: 1455824d651Sblueswir1 146b3f046c2SKevin Wolf@table @option 1475824d651Sblueswir1@item file=@var{file} 1485824d651Sblueswir1This option defines which disk image (@pxref{disk_images}) to use with 1495824d651Sblueswir1this drive. If the filename contains comma, you must double it 1505824d651Sblueswir1(for instance, "file=my,,file" to use file "my,file"). 1515824d651Sblueswir1@item if=@var{interface} 1525824d651Sblueswir1This option defines on which type on interface the drive is connected. 1535824d651Sblueswir1Available types are: ide, scsi, sd, mtd, floppy, pflash, virtio. 1545824d651Sblueswir1@item bus=@var{bus},unit=@var{unit} 1555824d651Sblueswir1These options define where is connected the drive by defining the bus number and 1565824d651Sblueswir1the unit id. 1575824d651Sblueswir1@item index=@var{index} 1585824d651Sblueswir1This option defines where is connected the drive by using an index in the list 1595824d651Sblueswir1of available connectors of a given interface type. 1605824d651Sblueswir1@item media=@var{media} 1615824d651Sblueswir1This option defines the type of the media: disk or cdrom. 1625824d651Sblueswir1@item cyls=@var{c},heads=@var{h},secs=@var{s}[,trans=@var{t}] 1635824d651Sblueswir1These options have the same definition as they have in @option{-hdachs}. 1645824d651Sblueswir1@item snapshot=@var{snapshot} 1655824d651Sblueswir1@var{snapshot} is "on" or "off" and allows to enable snapshot for given drive (see @option{-snapshot}). 1665824d651Sblueswir1@item cache=@var{cache} 167*92196b2fSStefan Hajnoczi@var{cache} is "none", "writeback", "unsafe", "directsync" or "writethrough" and controls how the host cache is used to access block data. 1685c6c3a6cSChristoph Hellwig@item aio=@var{aio} 1695c6c3a6cSChristoph Hellwig@var{aio} is "threads", or "native" and selects between pthread based disk I/O and native Linux AIO. 1705824d651Sblueswir1@item format=@var{format} 1715824d651Sblueswir1Specify which disk @var{format} will be used rather than detecting 1725824d651Sblueswir1the format. Can be used to specifiy format=raw to avoid interpreting 1735824d651Sblueswir1an untrusted format header. 1745824d651Sblueswir1@item serial=@var{serial} 1755824d651Sblueswir1This option specifies the serial number to assign to the device. 176c2cc47a4SMarkus Armbruster@item addr=@var{addr} 177c2cc47a4SMarkus ArmbrusterSpecify the controller's PCI address (if=virtio only). 178ae73e591SLuiz Capitulino@item werror=@var{action},rerror=@var{action} 179ae73e591SLuiz CapitulinoSpecify which @var{action} to take on write and read errors. Valid actions are: 180ae73e591SLuiz Capitulino"ignore" (ignore the error and try to continue), "stop" (pause QEMU), 181ae73e591SLuiz Capitulino"report" (report the error to the guest), "enospc" (pause QEMU only if the 182ae73e591SLuiz Capitulinohost disk is full; report the error to the guest otherwise). 183ae73e591SLuiz CapitulinoThe default setting is @option{werror=enospc} and @option{rerror=report}. 184ae73e591SLuiz Capitulino@item readonly 185ae73e591SLuiz CapitulinoOpen drive @option{file} as read-only. Guest write attempts will fail. 1865824d651Sblueswir1@end table 1875824d651Sblueswir1 1885824d651Sblueswir1By default, writethrough caching is used for all block device. This means that 1895824d651Sblueswir1the host page cache will be used to read and write data but write notification 1905824d651Sblueswir1will be sent to the guest only when the data has been reported as written by 1915824d651Sblueswir1the storage subsystem. 1925824d651Sblueswir1 1935824d651Sblueswir1Writeback caching will report data writes as completed as soon as the data is 1945824d651Sblueswir1present in the host page cache. This is safe as long as you trust your host. 1955824d651Sblueswir1If your host crashes or loses power, then the guest may experience data 196c3177288SAlexander Grafcorruption. 1975824d651Sblueswir1 198c304d317SAurelien JarnoThe host page cache can be avoided entirely with @option{cache=none}. This will 1995824d651Sblueswir1attempt to do disk IO directly to the guests memory. QEMU may still perform 2005824d651Sblueswir1an internal copy of the data. 2015824d651Sblueswir1 202*92196b2fSStefan HajnocziThe host page cache can be avoided while only sending write notifications to 203*92196b2fSStefan Hajnoczithe guest when the data has been reported as written by the storage subsystem 204*92196b2fSStefan Hajnocziusing @option{cache=directsync}. 205*92196b2fSStefan Hajnoczi 2065824d651Sblueswir1Some block drivers perform badly with @option{cache=writethrough}, most notably, 2075824d651Sblueswir1qcow2. If performance is more important than correctness, 2080aa217e4SKevin Wolf@option{cache=writeback} should be used with qcow2. 2095824d651Sblueswir1 210016f5cf6SAlexander GrafIn case you don't care about data integrity over host failures, use 211016f5cf6SAlexander Grafcache=unsafe. This option tells qemu that it never needs to write any data 212016f5cf6SAlexander Grafto the disk but can instead keeps things in cache. If anything goes wrong, 213016f5cf6SAlexander Graflike your host losing power, the disk storage getting disconnected accidently, 214c3177288SAlexander Grafetc. you're image will most probably be rendered unusable. When using 215c3177288SAlexander Grafthe @option{-snapshot} option, unsafe caching is always used. 216016f5cf6SAlexander Graf 2175824d651Sblueswir1Instead of @option{-cdrom} you can use: 2185824d651Sblueswir1@example 2195824d651Sblueswir1qemu -drive file=file,index=2,media=cdrom 2205824d651Sblueswir1@end example 2215824d651Sblueswir1 2225824d651Sblueswir1Instead of @option{-hda}, @option{-hdb}, @option{-hdc}, @option{-hdd}, you can 2235824d651Sblueswir1use: 2245824d651Sblueswir1@example 2255824d651Sblueswir1qemu -drive file=file,index=0,media=disk 2265824d651Sblueswir1qemu -drive file=file,index=1,media=disk 2275824d651Sblueswir1qemu -drive file=file,index=2,media=disk 2285824d651Sblueswir1qemu -drive file=file,index=3,media=disk 2295824d651Sblueswir1@end example 2305824d651Sblueswir1 2315824d651Sblueswir1You can connect a CDROM to the slave of ide0: 2325824d651Sblueswir1@example 2335824d651Sblueswir1qemu -drive file=file,if=ide,index=1,media=cdrom 2345824d651Sblueswir1@end example 2355824d651Sblueswir1 2365824d651Sblueswir1If you don't specify the "file=" argument, you define an empty drive: 2375824d651Sblueswir1@example 2385824d651Sblueswir1qemu -drive if=ide,index=1,media=cdrom 2395824d651Sblueswir1@end example 2405824d651Sblueswir1 2415824d651Sblueswir1You can connect a SCSI disk with unit ID 6 on the bus #0: 2425824d651Sblueswir1@example 2435824d651Sblueswir1qemu -drive file=file,if=scsi,bus=0,unit=6 2445824d651Sblueswir1@end example 2455824d651Sblueswir1 2465824d651Sblueswir1Instead of @option{-fda}, @option{-fdb}, you can use: 2475824d651Sblueswir1@example 2485824d651Sblueswir1qemu -drive file=file,index=0,if=floppy 2495824d651Sblueswir1qemu -drive file=file,index=1,if=floppy 2505824d651Sblueswir1@end example 2515824d651Sblueswir1 2525824d651Sblueswir1By default, @var{interface} is "ide" and @var{index} is automatically 2535824d651Sblueswir1incremented: 2545824d651Sblueswir1@example 2555824d651Sblueswir1qemu -drive file=a -drive file=b" 2565824d651Sblueswir1@end example 2575824d651Sblueswir1is interpreted like: 2585824d651Sblueswir1@example 2595824d651Sblueswir1qemu -hda a -hdb b 2605824d651Sblueswir1@end example 2615824d651Sblueswir1ETEXI 2625824d651Sblueswir1 2636616b2adSStefan WeilDEF("set", HAS_ARG, QEMU_OPTION_set, 2646616b2adSStefan Weil "-set group.id.arg=value\n" 2656616b2adSStefan Weil " set <arg> parameter for item <id> of type <group>\n" 266ad96090aSBlue Swirl " i.e. -set drive.$id.file=/path/to/image\n", QEMU_ARCH_ALL) 2676616b2adSStefan WeilSTEXI 2686616b2adSStefan Weil@item -set 2696616b2adSStefan Weil@findex -set 2706616b2adSStefan WeilTODO 2716616b2adSStefan WeilETEXI 2726616b2adSStefan Weil 2736616b2adSStefan WeilDEF("global", HAS_ARG, QEMU_OPTION_global, 2746616b2adSStefan Weil "-global driver.property=value\n" 275ad96090aSBlue Swirl " set a global default for a driver property\n", 276ad96090aSBlue Swirl QEMU_ARCH_ALL) 2776616b2adSStefan WeilSTEXI 2786616b2adSStefan Weil@item -global 2796616b2adSStefan Weil@findex -global 2806616b2adSStefan WeilTODO 2816616b2adSStefan WeilETEXI 2826616b2adSStefan Weil 2835824d651Sblueswir1DEF("mtdblock", HAS_ARG, QEMU_OPTION_mtdblock, 284ad96090aSBlue Swirl "-mtdblock file use 'file' as on-board Flash memory image\n", 285ad96090aSBlue Swirl QEMU_ARCH_ALL) 2865824d651Sblueswir1STEXI 2874e257e5eSKevin Wolf@item -mtdblock @var{file} 2886616b2adSStefan Weil@findex -mtdblock 2894e257e5eSKevin WolfUse @var{file} as on-board Flash memory image. 2905824d651Sblueswir1ETEXI 2915824d651Sblueswir1 2925824d651Sblueswir1DEF("sd", HAS_ARG, QEMU_OPTION_sd, 293ad96090aSBlue Swirl "-sd file use 'file' as SecureDigital card image\n", QEMU_ARCH_ALL) 2945824d651Sblueswir1STEXI 2954e257e5eSKevin Wolf@item -sd @var{file} 2966616b2adSStefan Weil@findex -sd 2974e257e5eSKevin WolfUse @var{file} as SecureDigital card image. 2985824d651Sblueswir1ETEXI 2995824d651Sblueswir1 3005824d651Sblueswir1DEF("pflash", HAS_ARG, QEMU_OPTION_pflash, 301ad96090aSBlue Swirl "-pflash file use 'file' as a parallel flash image\n", QEMU_ARCH_ALL) 3025824d651Sblueswir1STEXI 3034e257e5eSKevin Wolf@item -pflash @var{file} 3046616b2adSStefan Weil@findex -pflash 3054e257e5eSKevin WolfUse @var{file} as a parallel flash image. 3065824d651Sblueswir1ETEXI 3075824d651Sblueswir1 3085824d651Sblueswir1DEF("boot", HAS_ARG, QEMU_OPTION_boot, 3092221dde5SJan Kiszka "-boot [order=drives][,once=drives][,menu=on|off]\n" 3103d3b8303Swayne " [,splash=sp_name][,splash-time=sp_time]\n" 3113d3b8303Swayne " 'drives': floppy (a), hard disk (c), CD-ROM (d), network (n)\n" 3123d3b8303Swayne " 'sp_name': the file's name that would be passed to bios as logo picture, if menu=on\n" 3133d3b8303Swayne " 'sp_time': the period that splash picture last if menu=on, unit is ms\n", 314ad96090aSBlue Swirl QEMU_ARCH_ALL) 3155824d651Sblueswir1STEXI 3163d3b8303Swayne@item -boot [order=@var{drives}][,once=@var{drives}][,menu=on|off][,splash=@var{sp_name}][,splash-time=@var{sp_time}] 3176616b2adSStefan Weil@findex -boot 3182221dde5SJan KiszkaSpecify boot order @var{drives} as a string of drive letters. Valid 3192221dde5SJan Kiszkadrive letters depend on the target achitecture. The x86 PC uses: a, b 3202221dde5SJan Kiszka(floppy 1 and 2), c (first hard disk), d (first CD-ROM), n-p (Etherboot 3212221dde5SJan Kiszkafrom network adapter 1-4), hard disk boot is the default. To apply a 3222221dde5SJan Kiszkaparticular boot order only on the first startup, specify it via 3232221dde5SJan Kiszka@option{once}. 3242221dde5SJan Kiszka 3252221dde5SJan KiszkaInteractive boot menus/prompts can be enabled via @option{menu=on} as far 3262221dde5SJan Kiszkaas firmware/BIOS supports them. The default is non-interactive boot. 3272221dde5SJan Kiszka 3283d3b8303SwayneA splash picture could be passed to bios, enabling user to show it as logo, 3293d3b8303Swaynewhen option splash=@var{sp_name} is given and menu=on, If firmware/BIOS 3303d3b8303Swaynesupports them. Currently Seabios for X86 system support it. 3313d3b8303Swaynelimitation: The splash file could be a jpeg file or a BMP file in 24 BPP 3323d3b8303Swayneformat(true color). The resolution should be supported by the SVGA mode, so 3333d3b8303Swaynethe recommended is 320x240, 640x480, 800x640. 3343d3b8303Swayne 3352221dde5SJan Kiszka@example 3362221dde5SJan Kiszka# try to boot from network first, then from hard disk 3372221dde5SJan Kiszkaqemu -boot order=nc 3382221dde5SJan Kiszka# boot from CD-ROM first, switch back to default order after reboot 3392221dde5SJan Kiszkaqemu -boot once=d 3403d3b8303Swayne# boot with a splash picture for 5 seconds. 3413d3b8303Swayneqemu -boot menu=on,splash=/root/boot.bmp,splash-time=5000 3422221dde5SJan Kiszka@end example 3432221dde5SJan Kiszka 3442221dde5SJan KiszkaNote: The legacy format '-boot @var{drives}' is still supported but its 3452221dde5SJan Kiszkause is discouraged as it may be removed from future versions. 3465824d651Sblueswir1ETEXI 3475824d651Sblueswir1 3485824d651Sblueswir1DEF("snapshot", 0, QEMU_OPTION_snapshot, 349ad96090aSBlue Swirl "-snapshot write to temporary files instead of disk image files\n", 350ad96090aSBlue Swirl QEMU_ARCH_ALL) 3515824d651Sblueswir1STEXI 3525824d651Sblueswir1@item -snapshot 3536616b2adSStefan Weil@findex -snapshot 3545824d651Sblueswir1Write to temporary files instead of disk image files. In this case, 3555824d651Sblueswir1the raw disk image you use is not written back. You can however force 3565824d651Sblueswir1the write back by pressing @key{C-a s} (@pxref{disk_images}). 3575824d651Sblueswir1ETEXI 3585824d651Sblueswir1 3595824d651Sblueswir1DEF("m", HAS_ARG, QEMU_OPTION_m, 360bec7c2d4SPaolo Bonzini "-m megs set virtual RAM size to megs MB [default=" 361ad96090aSBlue Swirl stringify(DEFAULT_RAM_SIZE) "]\n", QEMU_ARCH_ALL) 3625824d651Sblueswir1STEXI 3635824d651Sblueswir1@item -m @var{megs} 3646616b2adSStefan Weil@findex -m 3655824d651Sblueswir1Set virtual RAM size to @var{megs} megabytes. Default is 128 MiB. Optionally, 3665824d651Sblueswir1a suffix of ``M'' or ``G'' can be used to signify a value in megabytes or 3675824d651Sblueswir1gigabytes respectively. 3685824d651Sblueswir1ETEXI 3695824d651Sblueswir1 370c902760fSMarcelo TosattiDEF("mem-path", HAS_ARG, QEMU_OPTION_mempath, 371ad96090aSBlue Swirl "-mem-path FILE provide backing storage for guest RAM\n", QEMU_ARCH_ALL) 372c902760fSMarcelo TosattiSTEXI 373c902760fSMarcelo Tosatti@item -mem-path @var{path} 374c902760fSMarcelo TosattiAllocate guest RAM from a temporarily created file in @var{path}. 375c902760fSMarcelo TosattiETEXI 376c902760fSMarcelo Tosatti 377c902760fSMarcelo Tosatti#ifdef MAP_POPULATE 378c902760fSMarcelo TosattiDEF("mem-prealloc", 0, QEMU_OPTION_mem_prealloc, 379ad96090aSBlue Swirl "-mem-prealloc preallocate guest memory (use with -mem-path)\n", 380ad96090aSBlue Swirl QEMU_ARCH_ALL) 381c902760fSMarcelo TosattiSTEXI 382c902760fSMarcelo Tosatti@item -mem-prealloc 383c902760fSMarcelo TosattiPreallocate memory when using -mem-path. 384c902760fSMarcelo TosattiETEXI 385c902760fSMarcelo Tosatti#endif 386c902760fSMarcelo Tosatti 3875824d651Sblueswir1DEF("k", HAS_ARG, QEMU_OPTION_k, 388ad96090aSBlue Swirl "-k language use keyboard layout (for example 'fr' for French)\n", 389ad96090aSBlue Swirl QEMU_ARCH_ALL) 3905824d651Sblueswir1STEXI 3915824d651Sblueswir1@item -k @var{language} 3926616b2adSStefan Weil@findex -k 3935824d651Sblueswir1Use keyboard layout @var{language} (for example @code{fr} for 3945824d651Sblueswir1French). This option is only needed where it is not easy to get raw PC 3955824d651Sblueswir1keycodes (e.g. on Macs, with some X11 servers or with a VNC 3965824d651Sblueswir1display). You don't normally need to use it on PC/Linux or PC/Windows 3975824d651Sblueswir1hosts. 3985824d651Sblueswir1 3995824d651Sblueswir1The available layouts are: 4005824d651Sblueswir1@example 4015824d651Sblueswir1ar de-ch es fo fr-ca hu ja mk no pt-br sv 4025824d651Sblueswir1da en-gb et fr fr-ch is lt nl pl ru th 4035824d651Sblueswir1de en-us fi fr-be hr it lv nl-be pt sl tr 4045824d651Sblueswir1@end example 4055824d651Sblueswir1 4065824d651Sblueswir1The default is @code{en-us}. 4075824d651Sblueswir1ETEXI 4085824d651Sblueswir1 4095824d651Sblueswir1 4105824d651Sblueswir1DEF("audio-help", 0, QEMU_OPTION_audio_help, 411ad96090aSBlue Swirl "-audio-help print list of audio drivers and their options\n", 412ad96090aSBlue Swirl QEMU_ARCH_ALL) 4135824d651Sblueswir1STEXI 4145824d651Sblueswir1@item -audio-help 4156616b2adSStefan Weil@findex -audio-help 4165824d651Sblueswir1Will show the audio subsystem help: list of drivers, tunable 4175824d651Sblueswir1parameters. 4185824d651Sblueswir1ETEXI 4195824d651Sblueswir1 4205824d651Sblueswir1DEF("soundhw", HAS_ARG, QEMU_OPTION_soundhw, 4215824d651Sblueswir1 "-soundhw c1,... enable audio support\n" 4225824d651Sblueswir1 " and only specified sound cards (comma separated list)\n" 4235824d651Sblueswir1 " use -soundhw ? to get the list of supported cards\n" 424ad96090aSBlue Swirl " use -soundhw all to enable all of them\n", QEMU_ARCH_ALL) 4255824d651Sblueswir1STEXI 4265824d651Sblueswir1@item -soundhw @var{card1}[,@var{card2},...] or -soundhw all 4276616b2adSStefan Weil@findex -soundhw 4285824d651Sblueswir1Enable audio and selected sound hardware. Use ? to print all 4295824d651Sblueswir1available sound hardware. 4305824d651Sblueswir1 4315824d651Sblueswir1@example 4325824d651Sblueswir1qemu -soundhw sb16,adlib disk.img 4335824d651Sblueswir1qemu -soundhw es1370 disk.img 4345824d651Sblueswir1qemu -soundhw ac97 disk.img 4357d72e762SGerd Hoffmannqemu -soundhw hda disk.img 4365824d651Sblueswir1qemu -soundhw all disk.img 4375824d651Sblueswir1qemu -soundhw ? 4385824d651Sblueswir1@end example 4395824d651Sblueswir1 4405824d651Sblueswir1Note that Linux's i810_audio OSS kernel (for AC97) module might 4415824d651Sblueswir1require manually specifying clocking. 4425824d651Sblueswir1 4435824d651Sblueswir1@example 4445824d651Sblueswir1modprobe i810_audio clocking=48000 4455824d651Sblueswir1@end example 4465824d651Sblueswir1ETEXI 4475824d651Sblueswir1 4485824d651Sblueswir1STEXI 4495824d651Sblueswir1@end table 4505824d651Sblueswir1ETEXI 4515824d651Sblueswir1 4525824d651Sblueswir1DEF("usb", 0, QEMU_OPTION_usb, 453ad96090aSBlue Swirl "-usb enable the USB driver (will be the default soon)\n", 454ad96090aSBlue Swirl QEMU_ARCH_ALL) 4555824d651Sblueswir1STEXI 4565824d651Sblueswir1USB options: 4575824d651Sblueswir1@table @option 4585824d651Sblueswir1 4595824d651Sblueswir1@item -usb 4606616b2adSStefan Weil@findex -usb 4615824d651Sblueswir1Enable the USB driver (will be the default soon) 4625824d651Sblueswir1ETEXI 4635824d651Sblueswir1 4645824d651Sblueswir1DEF("usbdevice", HAS_ARG, QEMU_OPTION_usbdevice, 465ad96090aSBlue Swirl "-usbdevice name add the host or guest USB device 'name'\n", 466ad96090aSBlue Swirl QEMU_ARCH_ALL) 4675824d651Sblueswir1STEXI 4685824d651Sblueswir1 4695824d651Sblueswir1@item -usbdevice @var{devname} 4706616b2adSStefan Weil@findex -usbdevice 4715824d651Sblueswir1Add the USB device @var{devname}. @xref{usb_devices}. 4725824d651Sblueswir1 473b3f046c2SKevin Wolf@table @option 4745824d651Sblueswir1 4755824d651Sblueswir1@item mouse 4765824d651Sblueswir1Virtual Mouse. This will override the PS/2 mouse emulation when activated. 4775824d651Sblueswir1 4785824d651Sblueswir1@item tablet 4795824d651Sblueswir1Pointer device that uses absolute coordinates (like a touchscreen). This 4805824d651Sblueswir1means qemu is able to report the mouse position without having to grab the 4815824d651Sblueswir1mouse. Also overrides the PS/2 mouse emulation when activated. 4825824d651Sblueswir1 4834e257e5eSKevin Wolf@item disk:[format=@var{format}]:@var{file} 4845824d651Sblueswir1Mass storage device based on file. The optional @var{format} argument 4855824d651Sblueswir1will be used rather than detecting the format. Can be used to specifiy 4864e257e5eSKevin Wolf@code{format=raw} to avoid interpreting an untrusted format header. 4875824d651Sblueswir1 4884e257e5eSKevin Wolf@item host:@var{bus}.@var{addr} 4894e257e5eSKevin WolfPass through the host device identified by @var{bus}.@var{addr} (Linux only). 4905824d651Sblueswir1 4914e257e5eSKevin Wolf@item host:@var{vendor_id}:@var{product_id} 4924e257e5eSKevin WolfPass through the host device identified by @var{vendor_id}:@var{product_id} 4934e257e5eSKevin Wolf(Linux only). 4945824d651Sblueswir1 4955824d651Sblueswir1@item serial:[vendorid=@var{vendor_id}][,productid=@var{product_id}]:@var{dev} 4965824d651Sblueswir1Serial converter to host character device @var{dev}, see @code{-serial} for the 4975824d651Sblueswir1available devices. 4985824d651Sblueswir1 4995824d651Sblueswir1@item braille 5005824d651Sblueswir1Braille device. This will use BrlAPI to display the braille output on a real 5015824d651Sblueswir1or fake device. 5025824d651Sblueswir1 5034e257e5eSKevin Wolf@item net:@var{options} 5045824d651Sblueswir1Network adapter that supports CDC ethernet and RNDIS protocols. 5055824d651Sblueswir1 5065824d651Sblueswir1@end table 5075824d651Sblueswir1ETEXI 5085824d651Sblueswir1 509bd3c948dSGerd HoffmannDEF("device", HAS_ARG, QEMU_OPTION_device, 51040ea285cSMarkus Armbruster "-device driver[,prop[=value][,...]]\n" 51140ea285cSMarkus Armbruster " add device (based on driver)\n" 51240ea285cSMarkus Armbruster " prop=value,... sets driver properties\n" 51369a319d1SStefan Weil " use -device ? to print all possible drivers\n" 5149848bbf1SMarkus Armbruster " use -device driver,? to print all possible properties\n", 515ad96090aSBlue Swirl QEMU_ARCH_ALL) 5163dbf2c7fSStefan WeilSTEXI 5179848bbf1SMarkus Armbruster@item -device @var{driver}[,@var{prop}[=@var{value}][,...]] 5186616b2adSStefan Weil@findex -device 5199848bbf1SMarkus ArmbrusterAdd device @var{driver}. @var{prop}=@var{value} sets driver 5209848bbf1SMarkus Armbrusterproperties. Valid properties depend on the driver. To get help on 5219848bbf1SMarkus Armbrusterpossible drivers and properties, use @code{-device ?} and 5229848bbf1SMarkus Armbruster@code{-device @var{driver},?}. 5233dbf2c7fSStefan WeilETEXI 5243dbf2c7fSStefan Weil 52574db920cSGautham R ShenoyDEFHEADING(File system options:) 52674db920cSGautham R Shenoy 52774db920cSGautham R ShenoyDEF("fsdev", HAS_ARG, QEMU_OPTION_fsdev, 52812848bfcSAneesh Kumar K.V "-fsdev local,id=id,path=path,security_model=[mapped|passthrough|none]\n", 52974db920cSGautham R Shenoy QEMU_ARCH_ALL) 53074db920cSGautham R Shenoy 53174db920cSGautham R ShenoySTEXI 53274db920cSGautham R Shenoy 53374db920cSGautham R ShenoyThe general form of a File system device option is: 53474db920cSGautham R Shenoy@table @option 53574db920cSGautham R Shenoy 53674db920cSGautham R Shenoy@item -fsdev @var{fstype} ,id=@var{id} [,@var{options}] 53774db920cSGautham R Shenoy@findex -fsdev 53874db920cSGautham R ShenoyFstype is one of: 53974db920cSGautham R Shenoy@option{local}, 54074db920cSGautham R ShenoyThe specific Fstype will determine the applicable options. 54174db920cSGautham R Shenoy 54274db920cSGautham R ShenoyOptions to each backend are described below. 54374db920cSGautham R Shenoy 5449ce56db6SVenkateswararao Jujjuri (JV)@item -fsdev local ,id=@var{id} ,path=@var{path} ,security_model=@var{security_model} 54574db920cSGautham R Shenoy 54674db920cSGautham R ShenoyCreate a file-system-"device" for local-filesystem. 54774db920cSGautham R Shenoy 54874db920cSGautham R Shenoy@option{local} is only available on Linux. 54974db920cSGautham R Shenoy 55074db920cSGautham R Shenoy@option{path} specifies the path to be exported. @option{path} is required. 55174db920cSGautham R Shenoy 5529ce56db6SVenkateswararao Jujjuri (JV)@option{security_model} specifies the security model to be followed. 5539ce56db6SVenkateswararao Jujjuri (JV)@option{security_model} is required. 5549ce56db6SVenkateswararao Jujjuri (JV) 55574db920cSGautham R Shenoy@end table 55674db920cSGautham R ShenoyETEXI 55774db920cSGautham R Shenoy 5583d54abc7SGautham R ShenoyDEFHEADING(Virtual File system pass-through options:) 5593d54abc7SGautham R Shenoy 5603d54abc7SGautham R ShenoyDEF("virtfs", HAS_ARG, QEMU_OPTION_virtfs, 56112848bfcSAneesh Kumar K.V "-virtfs local,path=path,mount_tag=tag,security_model=[mapped|passthrough|none]\n", 5623d54abc7SGautham R Shenoy QEMU_ARCH_ALL) 5633d54abc7SGautham R Shenoy 5643d54abc7SGautham R ShenoySTEXI 5653d54abc7SGautham R Shenoy 5663d54abc7SGautham R ShenoyThe general form of a Virtual File system pass-through option is: 5673d54abc7SGautham R Shenoy@table @option 5683d54abc7SGautham R Shenoy 5693d54abc7SGautham R Shenoy@item -virtfs @var{fstype} [,@var{options}] 5703d54abc7SGautham R Shenoy@findex -virtfs 5713d54abc7SGautham R ShenoyFstype is one of: 5723d54abc7SGautham R Shenoy@option{local}, 5733d54abc7SGautham R ShenoyThe specific Fstype will determine the applicable options. 5743d54abc7SGautham R Shenoy 5753d54abc7SGautham R ShenoyOptions to each backend are described below. 5763d54abc7SGautham R Shenoy 5779ce56db6SVenkateswararao Jujjuri (JV)@item -virtfs local ,path=@var{path} ,mount_tag=@var{mount_tag} ,security_model=@var{security_model} 5783d54abc7SGautham R Shenoy 5793d54abc7SGautham R ShenoyCreate a Virtual file-system-pass through for local-filesystem. 5803d54abc7SGautham R Shenoy 5813d54abc7SGautham R Shenoy@option{local} is only available on Linux. 5823d54abc7SGautham R Shenoy 5833d54abc7SGautham R Shenoy@option{path} specifies the path to be exported. @option{path} is required. 5843d54abc7SGautham R Shenoy 5859ce56db6SVenkateswararao Jujjuri (JV)@option{security_model} specifies the security model to be followed. 5869ce56db6SVenkateswararao Jujjuri (JV)@option{security_model} is required. 5879ce56db6SVenkateswararao Jujjuri (JV) 5889ce56db6SVenkateswararao Jujjuri (JV) 5893d54abc7SGautham R Shenoy@option{mount_tag} specifies the tag with which the exported file is mounted. 5903d54abc7SGautham R Shenoy@option{mount_tag} is required. 5913d54abc7SGautham R Shenoy 5923d54abc7SGautham R Shenoy@end table 5933d54abc7SGautham R ShenoyETEXI 5943d54abc7SGautham R Shenoy 59574db920cSGautham R ShenoyDEFHEADING() 59674db920cSGautham R Shenoy 5975824d651Sblueswir1DEF("name", HAS_ARG, QEMU_OPTION_name, 598ca1a8a06SBruce Rogers "-name string1[,process=string2]\n" 599ca1a8a06SBruce Rogers " set the name of the guest\n" 600ad96090aSBlue Swirl " string1 sets the window title and string2 the process name (on Linux)\n", 601ad96090aSBlue Swirl QEMU_ARCH_ALL) 6025824d651Sblueswir1STEXI 6035824d651Sblueswir1@item -name @var{name} 6046616b2adSStefan Weil@findex -name 6055824d651Sblueswir1Sets the @var{name} of the guest. 6065824d651Sblueswir1This name will be displayed in the SDL window caption. 6075824d651Sblueswir1The @var{name} will also be used for the VNC server. 6081889465aSAndi KleenAlso optionally set the top visible process name in Linux. 6095824d651Sblueswir1ETEXI 6105824d651Sblueswir1 6115824d651Sblueswir1DEF("uuid", HAS_ARG, QEMU_OPTION_uuid, 612e8105ebbSPaolo Bonzini "-uuid %08x-%04x-%04x-%04x-%012x\n" 613ad96090aSBlue Swirl " specify machine UUID\n", QEMU_ARCH_ALL) 6145824d651Sblueswir1STEXI 6155824d651Sblueswir1@item -uuid @var{uuid} 6166616b2adSStefan Weil@findex -uuid 6175824d651Sblueswir1Set system UUID. 6185824d651Sblueswir1ETEXI 6195824d651Sblueswir1 6205824d651Sblueswir1STEXI 6215824d651Sblueswir1@end table 6225824d651Sblueswir1ETEXI 6235824d651Sblueswir1 6245824d651Sblueswir1DEFHEADING() 6255824d651Sblueswir1 6265824d651Sblueswir1DEFHEADING(Display options:) 6275824d651Sblueswir1 6285824d651Sblueswir1STEXI 6295824d651Sblueswir1@table @option 6305824d651Sblueswir1ETEXI 6315824d651Sblueswir1 6321472a95bSJes SorensenDEF("display", HAS_ARG, QEMU_OPTION_display, 6331472a95bSJes Sorensen "-display sdl[,frame=on|off][,alt_grab=on|off][,ctrl_grab=on|off]\n" 6343264ff12SJes Sorensen " [,window_close=on|off]|curses|none|\n" 6353264ff12SJes Sorensen " vnc=<display>[,<optargs>]\n" 6361472a95bSJes Sorensen " select display type\n", QEMU_ARCH_ALL) 6371472a95bSJes SorensenSTEXI 6381472a95bSJes Sorensen@item -display @var{type} 6391472a95bSJes Sorensen@findex -display 6401472a95bSJes SorensenSelect type of display to use. This option is a replacement for the 6411472a95bSJes Sorensenold style -sdl/-curses/... options. Valid values for @var{type} are 6421472a95bSJes Sorensen@table @option 6431472a95bSJes Sorensen@item sdl 6441472a95bSJes SorensenDisplay video output via SDL (usually in a separate graphics 6451472a95bSJes Sorensenwindow; see the SDL documentation for other possibilities). 6461472a95bSJes Sorensen@item curses 6471472a95bSJes SorensenDisplay video output via curses. For graphics device models which 6481472a95bSJes Sorensensupport a text mode, QEMU can display this output using a 6491472a95bSJes Sorensencurses/ncurses interface. Nothing is displayed when the graphics 6501472a95bSJes Sorensendevice is in graphical mode or if the graphics device does not support 6511472a95bSJes Sorensena text mode. Generally only the VGA device models support text mode. 6524171d32eSJes Sorensen@item none 6534171d32eSJes SorensenDo not display video output. The guest will still see an emulated 6544171d32eSJes Sorensengraphics card, but its output will not be displayed to the QEMU 6554171d32eSJes Sorensenuser. This option differs from the -nographic option in that it 6564171d32eSJes Sorensenonly affects what is done with video output; -nographic also changes 6574171d32eSJes Sorensenthe destination of the serial and parallel port data. 6583264ff12SJes Sorensen@item vnc 6593264ff12SJes SorensenStart a VNC server on display <arg> 6601472a95bSJes Sorensen@end table 6611472a95bSJes SorensenETEXI 6621472a95bSJes Sorensen 6635824d651Sblueswir1DEF("nographic", 0, QEMU_OPTION_nographic, 664ad96090aSBlue Swirl "-nographic disable graphical output and redirect serial I/Os to console\n", 665ad96090aSBlue Swirl QEMU_ARCH_ALL) 6665824d651Sblueswir1STEXI 6675824d651Sblueswir1@item -nographic 6686616b2adSStefan Weil@findex -nographic 6695824d651Sblueswir1Normally, QEMU uses SDL to display the VGA output. With this option, 6705824d651Sblueswir1you can totally disable graphical output so that QEMU is a simple 6715824d651Sblueswir1command line application. The emulated serial port is redirected on 6725824d651Sblueswir1the console. Therefore, you can still use QEMU to debug a Linux kernel 6735824d651Sblueswir1with a serial console. 6745824d651Sblueswir1ETEXI 6755824d651Sblueswir1 6765824d651Sblueswir1DEF("curses", 0, QEMU_OPTION_curses, 677ad96090aSBlue Swirl "-curses use a curses/ncurses interface instead of SDL\n", 678ad96090aSBlue Swirl QEMU_ARCH_ALL) 6795824d651Sblueswir1STEXI 6805824d651Sblueswir1@item -curses 6816616b2adSStefan Weil@findex curses 6825824d651Sblueswir1Normally, QEMU uses SDL to display the VGA output. With this option, 6835824d651Sblueswir1QEMU can display the VGA output when in text mode using a 6845824d651Sblueswir1curses/ncurses interface. Nothing is displayed in graphical mode. 6855824d651Sblueswir1ETEXI 6865824d651Sblueswir1 6875824d651Sblueswir1DEF("no-frame", 0, QEMU_OPTION_no_frame, 688ad96090aSBlue Swirl "-no-frame open SDL window without a frame and window decorations\n", 689ad96090aSBlue Swirl QEMU_ARCH_ALL) 6905824d651Sblueswir1STEXI 6915824d651Sblueswir1@item -no-frame 6926616b2adSStefan Weil@findex -no-frame 6935824d651Sblueswir1Do not use decorations for SDL windows and start them using the whole 6945824d651Sblueswir1available screen space. This makes the using QEMU in a dedicated desktop 6955824d651Sblueswir1workspace more convenient. 6965824d651Sblueswir1ETEXI 6975824d651Sblueswir1 6985824d651Sblueswir1DEF("alt-grab", 0, QEMU_OPTION_alt_grab, 699ad96090aSBlue Swirl "-alt-grab use Ctrl-Alt-Shift to grab mouse (instead of Ctrl-Alt)\n", 700ad96090aSBlue Swirl QEMU_ARCH_ALL) 7015824d651Sblueswir1STEXI 7025824d651Sblueswir1@item -alt-grab 7036616b2adSStefan Weil@findex -alt-grab 704de1db2a1SBrad HardsUse Ctrl-Alt-Shift to grab mouse (instead of Ctrl-Alt). Note that this also 705de1db2a1SBrad Hardsaffects the special keys (for fullscreen, monitor-mode switching, etc). 7065824d651Sblueswir1ETEXI 7075824d651Sblueswir1 7080ca9f8a4SDustin KirklandDEF("ctrl-grab", 0, QEMU_OPTION_ctrl_grab, 709ad96090aSBlue Swirl "-ctrl-grab use Right-Ctrl to grab mouse (instead of Ctrl-Alt)\n", 710ad96090aSBlue Swirl QEMU_ARCH_ALL) 7110ca9f8a4SDustin KirklandSTEXI 7120ca9f8a4SDustin Kirkland@item -ctrl-grab 7136616b2adSStefan Weil@findex -ctrl-grab 714de1db2a1SBrad HardsUse Right-Ctrl to grab mouse (instead of Ctrl-Alt). Note that this also 715de1db2a1SBrad Hardsaffects the special keys (for fullscreen, monitor-mode switching, etc). 7160ca9f8a4SDustin KirklandETEXI 7170ca9f8a4SDustin Kirkland 7185824d651Sblueswir1DEF("no-quit", 0, QEMU_OPTION_no_quit, 719ad96090aSBlue Swirl "-no-quit disable SDL window close capability\n", QEMU_ARCH_ALL) 7205824d651Sblueswir1STEXI 7215824d651Sblueswir1@item -no-quit 7226616b2adSStefan Weil@findex -no-quit 7235824d651Sblueswir1Disable SDL window close capability. 7245824d651Sblueswir1ETEXI 7255824d651Sblueswir1 7265824d651Sblueswir1DEF("sdl", 0, QEMU_OPTION_sdl, 727ad96090aSBlue Swirl "-sdl enable SDL\n", QEMU_ARCH_ALL) 7285824d651Sblueswir1STEXI 7295824d651Sblueswir1@item -sdl 7306616b2adSStefan Weil@findex -sdl 7315824d651Sblueswir1Enable SDL. 7325824d651Sblueswir1ETEXI 7335824d651Sblueswir1 73429b0040bSGerd HoffmannDEF("spice", HAS_ARG, QEMU_OPTION_spice, 73529b0040bSGerd Hoffmann "-spice <args> enable spice\n", QEMU_ARCH_ALL) 73629b0040bSGerd HoffmannSTEXI 73729b0040bSGerd Hoffmann@item -spice @var{option}[,@var{option}[,...]] 73829b0040bSGerd Hoffmann@findex -spice 73929b0040bSGerd HoffmannEnable the spice remote desktop protocol. Valid options are 74029b0040bSGerd Hoffmann 74129b0040bSGerd Hoffmann@table @option 74229b0040bSGerd Hoffmann 74329b0040bSGerd Hoffmann@item port=<nr> 744c448e855SGerd HoffmannSet the TCP port spice is listening on for plaintext channels. 74529b0040bSGerd Hoffmann 746333b0eebSGerd Hoffmann@item addr=<addr> 747333b0eebSGerd HoffmannSet the IP address spice is listening on. Default is any address. 748333b0eebSGerd Hoffmann 749333b0eebSGerd Hoffmann@item ipv4 750333b0eebSGerd Hoffmann@item ipv6 751333b0eebSGerd HoffmannForce using the specified IP version. 752333b0eebSGerd Hoffmann 75329b0040bSGerd Hoffmann@item password=<secret> 75429b0040bSGerd HoffmannSet the password you need to authenticate. 75529b0040bSGerd Hoffmann 75648b3ed0aSMarc-André Lureau@item sasl 75748b3ed0aSMarc-André LureauRequire that the client use SASL to authenticate with the spice. 75848b3ed0aSMarc-André LureauThe exact choice of authentication method used is controlled from the 75948b3ed0aSMarc-André Lureausystem / user's SASL configuration file for the 'qemu' service. This 76048b3ed0aSMarc-André Lureauis typically found in /etc/sasl2/qemu.conf. If running QEMU as an 76148b3ed0aSMarc-André Lureauunprivileged user, an environment variable SASL_CONF_PATH can be used 76248b3ed0aSMarc-André Lureauto make it search alternate locations for the service config. 76348b3ed0aSMarc-André LureauWhile some SASL auth methods can also provide data encryption (eg GSSAPI), 76448b3ed0aSMarc-André Lureauit is recommended that SASL always be combined with the 'tls' and 76548b3ed0aSMarc-André Lureau'x509' settings to enable use of SSL and server certificates. This 76648b3ed0aSMarc-André Lureauensures a data encryption preventing compromise of authentication 76748b3ed0aSMarc-André Lureaucredentials. 76848b3ed0aSMarc-André Lureau 76929b0040bSGerd Hoffmann@item disable-ticketing 77029b0040bSGerd HoffmannAllow client connects without authentication. 77129b0040bSGerd Hoffmann 772d4970b07SHans de Goede@item disable-copy-paste 773d4970b07SHans de GoedeDisable copy paste between the client and the guest. 774d4970b07SHans de Goede 775c448e855SGerd Hoffmann@item tls-port=<nr> 776c448e855SGerd HoffmannSet the TCP port spice is listening on for encrypted channels. 777c448e855SGerd Hoffmann 778c448e855SGerd Hoffmann@item x509-dir=<dir> 779c448e855SGerd HoffmannSet the x509 file directory. Expects same filenames as -vnc $display,x509=$dir 780c448e855SGerd Hoffmann 781c448e855SGerd Hoffmann@item x509-key-file=<file> 782c448e855SGerd Hoffmann@item x509-key-password=<file> 783c448e855SGerd Hoffmann@item x509-cert-file=<file> 784c448e855SGerd Hoffmann@item x509-cacert-file=<file> 785c448e855SGerd Hoffmann@item x509-dh-key-file=<file> 786c448e855SGerd HoffmannThe x509 file names can also be configured individually. 787c448e855SGerd Hoffmann 788c448e855SGerd Hoffmann@item tls-ciphers=<list> 789c448e855SGerd HoffmannSpecify which ciphers to use. 790c448e855SGerd Hoffmann 79117b6dea0SGerd Hoffmann@item tls-channel=[main|display|inputs|record|playback|tunnel] 79217b6dea0SGerd Hoffmann@item plaintext-channel=[main|display|inputs|record|playback|tunnel] 79317b6dea0SGerd HoffmannForce specific channel to be used with or without TLS encryption. The 79417b6dea0SGerd Hoffmannoptions can be specified multiple times to configure multiple 79517b6dea0SGerd Hoffmannchannels. The special name "default" can be used to set the default 79617b6dea0SGerd Hoffmannmode. For channels which are not explicitly forced into one mode the 79717b6dea0SGerd Hoffmannspice client is allowed to pick tls/plaintext as he pleases. 79817b6dea0SGerd Hoffmann 7999f04e09eSYonit Halperin@item image-compression=[auto_glz|auto_lz|quic|glz|lz|off] 8009f04e09eSYonit HalperinConfigure image compression (lossless). 8019f04e09eSYonit HalperinDefault is auto_glz. 8029f04e09eSYonit Halperin 8039f04e09eSYonit Halperin@item jpeg-wan-compression=[auto|never|always] 8049f04e09eSYonit Halperin@item zlib-glz-wan-compression=[auto|never|always] 8059f04e09eSYonit HalperinConfigure wan image compression (lossy for slow links). 8069f04e09eSYonit HalperinDefault is auto. 8079f04e09eSYonit Halperin 80884a23f25SGerd Hoffmann@item streaming-video=[off|all|filter] 80984a23f25SGerd HoffmannConfigure video stream detection. Default is filter. 81084a23f25SGerd Hoffmann 81184a23f25SGerd Hoffmann@item agent-mouse=[on|off] 81284a23f25SGerd HoffmannEnable/disable passing mouse events via vdagent. Default is on. 81384a23f25SGerd Hoffmann 81484a23f25SGerd Hoffmann@item playback-compression=[on|off] 81584a23f25SGerd HoffmannEnable/disable audio stream compression (using celt 0.5.1). Default is on. 81684a23f25SGerd Hoffmann 81729b0040bSGerd Hoffmann@end table 81829b0040bSGerd HoffmannETEXI 81929b0040bSGerd Hoffmann 8205824d651Sblueswir1DEF("portrait", 0, QEMU_OPTION_portrait, 821ad96090aSBlue Swirl "-portrait rotate graphical output 90 deg left (only PXA LCD)\n", 822ad96090aSBlue Swirl QEMU_ARCH_ALL) 8235824d651Sblueswir1STEXI 8245824d651Sblueswir1@item -portrait 8256616b2adSStefan Weil@findex -portrait 8265824d651Sblueswir1Rotate graphical output 90 deg left (only PXA LCD). 8275824d651Sblueswir1ETEXI 8285824d651Sblueswir1 8299312805dSVasily KhoruzhickDEF("rotate", HAS_ARG, QEMU_OPTION_rotate, 8309312805dSVasily Khoruzhick "-rotate <deg> rotate graphical output some deg left (only PXA LCD)\n", 8319312805dSVasily Khoruzhick QEMU_ARCH_ALL) 8329312805dSVasily KhoruzhickSTEXI 8339312805dSVasily Khoruzhick@item -rotate 8349312805dSVasily Khoruzhick@findex -rotate 8359312805dSVasily KhoruzhickRotate graphical output some deg left (only PXA LCD). 8369312805dSVasily KhoruzhickETEXI 8379312805dSVasily Khoruzhick 8385824d651Sblueswir1DEF("vga", HAS_ARG, QEMU_OPTION_vga, 839a19cbfb3SGerd Hoffmann "-vga [std|cirrus|vmware|qxl|xenfb|none]\n" 840ad96090aSBlue Swirl " select video card type\n", QEMU_ARCH_ALL) 8415824d651Sblueswir1STEXI 8425824d651Sblueswir1@item -vga @var{type} 8436616b2adSStefan Weil@findex -vga 8445824d651Sblueswir1Select type of VGA card to emulate. Valid values for @var{type} are 845b3f046c2SKevin Wolf@table @option 8465824d651Sblueswir1@item cirrus 8475824d651Sblueswir1Cirrus Logic GD5446 Video card. All Windows versions starting from 8485824d651Sblueswir1Windows 95 should recognize and use this graphic card. For optimal 8495824d651Sblueswir1performances, use 16 bit color depth in the guest and the host OS. 8505824d651Sblueswir1(This one is the default) 8515824d651Sblueswir1@item std 8525824d651Sblueswir1Standard VGA card with Bochs VBE extensions. If your guest OS 8535824d651Sblueswir1supports the VESA 2.0 VBE extensions (e.g. Windows XP) and if you want 8545824d651Sblueswir1to use high resolution modes (>= 1280x1024x16) then you should use 8555824d651Sblueswir1this option. 8565824d651Sblueswir1@item vmware 8575824d651Sblueswir1VMWare SVGA-II compatible adapter. Use it if you have sufficiently 8585824d651Sblueswir1recent XFree86/XOrg server or Windows guest with a driver for this 8595824d651Sblueswir1card. 860a19cbfb3SGerd Hoffmann@item qxl 861a19cbfb3SGerd HoffmannQXL paravirtual graphic card. It is VGA compatible (including VESA 862a19cbfb3SGerd Hoffmann2.0 VBE support). Works best with qxl guest drivers installed though. 863a19cbfb3SGerd HoffmannRecommended choice when using the spice protocol. 8645824d651Sblueswir1@item none 8655824d651Sblueswir1Disable VGA card. 8665824d651Sblueswir1@end table 8675824d651Sblueswir1ETEXI 8685824d651Sblueswir1 8695824d651Sblueswir1DEF("full-screen", 0, QEMU_OPTION_full_screen, 870ad96090aSBlue Swirl "-full-screen start in full screen\n", QEMU_ARCH_ALL) 8715824d651Sblueswir1STEXI 8725824d651Sblueswir1@item -full-screen 8736616b2adSStefan Weil@findex -full-screen 8745824d651Sblueswir1Start in full screen. 8755824d651Sblueswir1ETEXI 8765824d651Sblueswir1 8775824d651Sblueswir1DEF("g", 1, QEMU_OPTION_g , 878ad96090aSBlue Swirl "-g WxH[xDEPTH] Set the initial graphical resolution and depth\n", 879ad96090aSBlue Swirl QEMU_ARCH_PPC | QEMU_ARCH_SPARC) 8805824d651Sblueswir1STEXI 88195d5f08bSStefan Weil@item -g @var{width}x@var{height}[x@var{depth}] 8826616b2adSStefan Weil@findex -g 88395d5f08bSStefan WeilSet the initial graphical resolution and depth (PPC, SPARC only). 8845824d651Sblueswir1ETEXI 8855824d651Sblueswir1 8865824d651Sblueswir1DEF("vnc", HAS_ARG, QEMU_OPTION_vnc , 887ad96090aSBlue Swirl "-vnc display start a VNC server on display\n", QEMU_ARCH_ALL) 8885824d651Sblueswir1STEXI 8895824d651Sblueswir1@item -vnc @var{display}[,@var{option}[,@var{option}[,...]]] 8906616b2adSStefan Weil@findex -vnc 8915824d651Sblueswir1Normally, QEMU uses SDL to display the VGA output. With this option, 8925824d651Sblueswir1you can have QEMU listen on VNC display @var{display} and redirect the VGA 8935824d651Sblueswir1display over the VNC session. It is very useful to enable the usb 8945824d651Sblueswir1tablet device when using this option (option @option{-usbdevice 8955824d651Sblueswir1tablet}). When using the VNC display, you must use the @option{-k} 8965824d651Sblueswir1parameter to set the keyboard layout if you are not using en-us. Valid 8975824d651Sblueswir1syntax for the @var{display} is 8985824d651Sblueswir1 899b3f046c2SKevin Wolf@table @option 9005824d651Sblueswir1 9015824d651Sblueswir1@item @var{host}:@var{d} 9025824d651Sblueswir1 9035824d651Sblueswir1TCP connections will only be allowed from @var{host} on display @var{d}. 9045824d651Sblueswir1By convention the TCP port is 5900+@var{d}. Optionally, @var{host} can 9055824d651Sblueswir1be omitted in which case the server will accept connections from any host. 9065824d651Sblueswir1 9074e257e5eSKevin Wolf@item unix:@var{path} 9085824d651Sblueswir1 9095824d651Sblueswir1Connections will be allowed over UNIX domain sockets where @var{path} is the 9105824d651Sblueswir1location of a unix socket to listen for connections on. 9115824d651Sblueswir1 9125824d651Sblueswir1@item none 9135824d651Sblueswir1 9145824d651Sblueswir1VNC is initialized but not started. The monitor @code{change} command 9155824d651Sblueswir1can be used to later start the VNC server. 9165824d651Sblueswir1 9175824d651Sblueswir1@end table 9185824d651Sblueswir1 9195824d651Sblueswir1Following the @var{display} value there may be one or more @var{option} flags 9205824d651Sblueswir1separated by commas. Valid options are 9215824d651Sblueswir1 922b3f046c2SKevin Wolf@table @option 9235824d651Sblueswir1 9245824d651Sblueswir1@item reverse 9255824d651Sblueswir1 9265824d651Sblueswir1Connect to a listening VNC client via a ``reverse'' connection. The 9275824d651Sblueswir1client is specified by the @var{display}. For reverse network 9285824d651Sblueswir1connections (@var{host}:@var{d},@code{reverse}), the @var{d} argument 9295824d651Sblueswir1is a TCP port number, not a display number. 9305824d651Sblueswir1 9315824d651Sblueswir1@item password 9325824d651Sblueswir1 9335824d651Sblueswir1Require that password based authentication is used for client connections. 9345824d651Sblueswir1The password must be set separately using the @code{change} command in the 9355824d651Sblueswir1@ref{pcsys_monitor} 9365824d651Sblueswir1 9375824d651Sblueswir1@item tls 9385824d651Sblueswir1 9395824d651Sblueswir1Require that client use TLS when communicating with the VNC server. This 9405824d651Sblueswir1uses anonymous TLS credentials so is susceptible to a man-in-the-middle 9415824d651Sblueswir1attack. It is recommended that this option be combined with either the 9424e257e5eSKevin Wolf@option{x509} or @option{x509verify} options. 9435824d651Sblueswir1 9445824d651Sblueswir1@item x509=@var{/path/to/certificate/dir} 9455824d651Sblueswir1 9465824d651Sblueswir1Valid if @option{tls} is specified. Require that x509 credentials are used 9475824d651Sblueswir1for negotiating the TLS session. The server will send its x509 certificate 9485824d651Sblueswir1to the client. It is recommended that a password be set on the VNC server 9495824d651Sblueswir1to provide authentication of the client when this is used. The path following 9505824d651Sblueswir1this option specifies where the x509 certificates are to be loaded from. 9515824d651Sblueswir1See the @ref{vnc_security} section for details on generating certificates. 9525824d651Sblueswir1 9535824d651Sblueswir1@item x509verify=@var{/path/to/certificate/dir} 9545824d651Sblueswir1 9555824d651Sblueswir1Valid if @option{tls} is specified. Require that x509 credentials are used 9565824d651Sblueswir1for negotiating the TLS session. The server will send its x509 certificate 9575824d651Sblueswir1to the client, and request that the client send its own x509 certificate. 9585824d651Sblueswir1The server will validate the client's certificate against the CA certificate, 9595824d651Sblueswir1and reject clients when validation fails. If the certificate authority is 9605824d651Sblueswir1trusted, this is a sufficient authentication mechanism. You may still wish 9615824d651Sblueswir1to set a password on the VNC server as a second authentication layer. The 9625824d651Sblueswir1path following this option specifies where the x509 certificates are to 9635824d651Sblueswir1be loaded from. See the @ref{vnc_security} section for details on generating 9645824d651Sblueswir1certificates. 9655824d651Sblueswir1 9665824d651Sblueswir1@item sasl 9675824d651Sblueswir1 9685824d651Sblueswir1Require that the client use SASL to authenticate with the VNC server. 9695824d651Sblueswir1The exact choice of authentication method used is controlled from the 9705824d651Sblueswir1system / user's SASL configuration file for the 'qemu' service. This 9715824d651Sblueswir1is typically found in /etc/sasl2/qemu.conf. If running QEMU as an 9725824d651Sblueswir1unprivileged user, an environment variable SASL_CONF_PATH can be used 9735824d651Sblueswir1to make it search alternate locations for the service config. 9745824d651Sblueswir1While some SASL auth methods can also provide data encryption (eg GSSAPI), 9755824d651Sblueswir1it is recommended that SASL always be combined with the 'tls' and 9765824d651Sblueswir1'x509' settings to enable use of SSL and server certificates. This 9775824d651Sblueswir1ensures a data encryption preventing compromise of authentication 9785824d651Sblueswir1credentials. See the @ref{vnc_security} section for details on using 9795824d651Sblueswir1SASL authentication. 9805824d651Sblueswir1 9815824d651Sblueswir1@item acl 9825824d651Sblueswir1 9835824d651Sblueswir1Turn on access control lists for checking of the x509 client certificate 9845824d651Sblueswir1and SASL party. For x509 certs, the ACL check is made against the 9855824d651Sblueswir1certificate's distinguished name. This is something that looks like 9865824d651Sblueswir1@code{C=GB,O=ACME,L=Boston,CN=bob}. For SASL party, the ACL check is 9875824d651Sblueswir1made against the username, which depending on the SASL plugin, may 9885824d651Sblueswir1include a realm component, eg @code{bob} or @code{bob@@EXAMPLE.COM}. 9895824d651Sblueswir1When the @option{acl} flag is set, the initial access list will be 9905824d651Sblueswir1empty, with a @code{deny} policy. Thus no one will be allowed to 9915824d651Sblueswir1use the VNC server until the ACLs have been loaded. This can be 9925824d651Sblueswir1achieved using the @code{acl} monitor command. 9935824d651Sblueswir1 9946f9c78c1SCorentin Chary@item lossy 9956f9c78c1SCorentin Chary 9966f9c78c1SCorentin CharyEnable lossy compression methods (gradient, JPEG, ...). If this 9976f9c78c1SCorentin Charyoption is set, VNC client may receive lossy framebuffer updates 9986f9c78c1SCorentin Charydepending on its encoding settings. Enabling this option can save 9996f9c78c1SCorentin Charya lot of bandwidth at the expense of quality. 10006f9c78c1SCorentin Chary 100180e0c8c3SCorentin Chary@item non-adaptive 100280e0c8c3SCorentin Chary 100380e0c8c3SCorentin CharyDisable adaptive encodings. Adaptive encodings are enabled by default. 100480e0c8c3SCorentin CharyAn adaptive encoding will try to detect frequently updated screen regions, 100580e0c8c3SCorentin Charyand send updates in these regions using a lossy encoding (like JPEG). 100661cc8701SStefan WeilThis can be really helpful to save bandwidth when playing videos. Disabling 100761cc8701SStefan Weiladaptive encodings allows to restore the original static behavior of encodings 100880e0c8c3SCorentin Charylike Tight. 100980e0c8c3SCorentin Chary 10105824d651Sblueswir1@end table 10115824d651Sblueswir1ETEXI 10125824d651Sblueswir1 10135824d651Sblueswir1STEXI 10145824d651Sblueswir1@end table 10155824d651Sblueswir1ETEXI 10165824d651Sblueswir1 10175824d651Sblueswir1DEFHEADING() 10185824d651Sblueswir1 10195824d651Sblueswir1DEFHEADING(i386 target only:) 10205824d651Sblueswir1STEXI 10215824d651Sblueswir1@table @option 10225824d651Sblueswir1ETEXI 10235824d651Sblueswir1 10245824d651Sblueswir1DEF("win2k-hack", 0, QEMU_OPTION_win2k_hack, 1025ad96090aSBlue Swirl "-win2k-hack use it when installing Windows 2000 to avoid a disk full bug\n", 1026ad96090aSBlue Swirl QEMU_ARCH_I386) 10275824d651Sblueswir1STEXI 10285824d651Sblueswir1@item -win2k-hack 10296616b2adSStefan Weil@findex -win2k-hack 10305824d651Sblueswir1Use it when installing Windows 2000 to avoid a disk full bug. After 10315824d651Sblueswir1Windows 2000 is installed, you no longer need this option (this option 10325824d651Sblueswir1slows down the IDE transfers). 10335824d651Sblueswir1ETEXI 10345824d651Sblueswir1 10351ed2fc1fSJan KiszkaHXCOMM Deprecated by -rtc 1036ad96090aSBlue SwirlDEF("rtc-td-hack", 0, QEMU_OPTION_rtc_td_hack, "", QEMU_ARCH_I386) 10375824d651Sblueswir1 10385824d651Sblueswir1DEF("no-fd-bootchk", 0, QEMU_OPTION_no_fd_bootchk, 1039ad96090aSBlue Swirl "-no-fd-bootchk disable boot signature checking for floppy disks\n", 1040ad96090aSBlue Swirl QEMU_ARCH_I386) 10415824d651Sblueswir1STEXI 10425824d651Sblueswir1@item -no-fd-bootchk 10436616b2adSStefan Weil@findex -no-fd-bootchk 10445824d651Sblueswir1Disable boot signature checking for floppy disks in Bochs BIOS. It may 10455824d651Sblueswir1be needed to boot from old floppy disks. 10466616b2adSStefan WeilTODO: check reference to Bochs BIOS. 10475824d651Sblueswir1ETEXI 10485824d651Sblueswir1 10495824d651Sblueswir1DEF("no-acpi", 0, QEMU_OPTION_no_acpi, 1050ad96090aSBlue Swirl "-no-acpi disable ACPI\n", QEMU_ARCH_I386) 10515824d651Sblueswir1STEXI 10525824d651Sblueswir1@item -no-acpi 10536616b2adSStefan Weil@findex -no-acpi 10545824d651Sblueswir1Disable ACPI (Advanced Configuration and Power Interface) support. Use 10555824d651Sblueswir1it if your guest OS complains about ACPI problems (PC target machine 10565824d651Sblueswir1only). 10575824d651Sblueswir1ETEXI 10585824d651Sblueswir1 10595824d651Sblueswir1DEF("no-hpet", 0, QEMU_OPTION_no_hpet, 1060ad96090aSBlue Swirl "-no-hpet disable HPET\n", QEMU_ARCH_I386) 10615824d651Sblueswir1STEXI 10625824d651Sblueswir1@item -no-hpet 10636616b2adSStefan Weil@findex -no-hpet 10645824d651Sblueswir1Disable HPET support. 10655824d651Sblueswir1ETEXI 10665824d651Sblueswir1 10677d4c3d53SMarkus ArmbrusterDEF("balloon", HAS_ARG, QEMU_OPTION_balloon, 10687d4c3d53SMarkus Armbruster "-balloon none disable balloon device\n" 10697d4c3d53SMarkus Armbruster "-balloon virtio[,addr=str]\n" 1070ad96090aSBlue Swirl " enable virtio balloon device (default)\n", QEMU_ARCH_ALL) 1071df97b920SEduardo HabkostSTEXI 10727d4c3d53SMarkus Armbruster@item -balloon none 10736616b2adSStefan Weil@findex -balloon 10747d4c3d53SMarkus ArmbrusterDisable balloon device. 10757d4c3d53SMarkus Armbruster@item -balloon virtio[,addr=@var{addr}] 10767d4c3d53SMarkus ArmbrusterEnable virtio balloon device (default), optionally with PCI address 10777d4c3d53SMarkus Armbruster@var{addr}. 1078df97b920SEduardo HabkostETEXI 1079df97b920SEduardo Habkost 10805824d651Sblueswir1DEF("acpitable", HAS_ARG, QEMU_OPTION_acpitable, 1081104bf02eSMichael Tokarev "-acpitable [sig=str][,rev=n][,oem_id=str][,oem_table_id=str][,oem_rev=n][,asl_compiler_id=str][,asl_compiler_rev=n][,{data|file}=file1[:file2]...]\n" 1082ad96090aSBlue Swirl " ACPI table description\n", QEMU_ARCH_I386) 10835824d651Sblueswir1STEXI 10845824d651Sblueswir1@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}]...] 10856616b2adSStefan Weil@findex -acpitable 10865824d651Sblueswir1Add ACPI table with specified header fields and context from specified files. 1087104bf02eSMichael TokarevFor file=, take whole ACPI table from the specified files, including all 1088104bf02eSMichael TokarevACPI headers (possible overridden by other options). 1089104bf02eSMichael TokarevFor data=, only data 1090104bf02eSMichael Tokarevportion of the table is used, all header information is specified in the 1091104bf02eSMichael Tokarevcommand line. 10925824d651Sblueswir1ETEXI 10935824d651Sblueswir1 1094b6f6e3d3SaliguoriDEF("smbios", HAS_ARG, QEMU_OPTION_smbios, 1095b6f6e3d3Saliguori "-smbios file=binary\n" 1096ca1a8a06SBruce Rogers " load SMBIOS entry from binary file\n" 1097e8105ebbSPaolo Bonzini "-smbios type=0[,vendor=str][,version=str][,date=str][,release=%d.%d]\n" 1098ca1a8a06SBruce Rogers " specify SMBIOS type 0 fields\n" 1099b6f6e3d3Saliguori "-smbios type=1[,manufacturer=str][,product=str][,version=str][,serial=str]\n" 1100b6f6e3d3Saliguori " [,uuid=uuid][,sku=str][,family=str]\n" 1101ad96090aSBlue Swirl " specify SMBIOS type 1 fields\n", QEMU_ARCH_I386) 1102b6f6e3d3SaliguoriSTEXI 1103b6f6e3d3Saliguori@item -smbios file=@var{binary} 11046616b2adSStefan Weil@findex -smbios 1105b6f6e3d3SaliguoriLoad SMBIOS entry from binary file. 1106b6f6e3d3Saliguori 1107b6f6e3d3Saliguori@item -smbios type=0[,vendor=@var{str}][,version=@var{str}][,date=@var{str}][,release=@var{%d.%d}] 11086616b2adSStefan Weil@findex -smbios 1109b6f6e3d3SaliguoriSpecify SMBIOS type 0 fields 1110b6f6e3d3Saliguori 1111b6f6e3d3Saliguori@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}] 1112b6f6e3d3SaliguoriSpecify SMBIOS type 1 fields 1113b6f6e3d3SaliguoriETEXI 1114b6f6e3d3Saliguori 11155824d651Sblueswir1DEFHEADING() 11165824d651Sblueswir1STEXI 11175824d651Sblueswir1@end table 11185824d651Sblueswir1ETEXI 11195824d651Sblueswir1 11205824d651Sblueswir1DEFHEADING(Network options:) 11215824d651Sblueswir1STEXI 11225824d651Sblueswir1@table @option 11235824d651Sblueswir1ETEXI 11245824d651Sblueswir1 1125ad196a9dSJan KiszkaHXCOMM Legacy slirp options (now moved to -net user): 1126ad196a9dSJan Kiszka#ifdef CONFIG_SLIRP 1127ad96090aSBlue SwirlDEF("tftp", HAS_ARG, QEMU_OPTION_tftp, "", QEMU_ARCH_ALL) 1128ad96090aSBlue SwirlDEF("bootp", HAS_ARG, QEMU_OPTION_bootp, "", QEMU_ARCH_ALL) 1129ad96090aSBlue SwirlDEF("redir", HAS_ARG, QEMU_OPTION_redir, "", QEMU_ARCH_ALL) 1130ad196a9dSJan Kiszka#ifndef _WIN32 1131ad96090aSBlue SwirlDEF("smb", HAS_ARG, QEMU_OPTION_smb, "", QEMU_ARCH_ALL) 1132ad196a9dSJan Kiszka#endif 1133ad196a9dSJan Kiszka#endif 1134ad196a9dSJan Kiszka 1135bab7944cSBlue SwirlDEF("net", HAS_ARG, QEMU_OPTION_net, 1136ffe6370cSMichael S. Tsirkin "-net nic[,vlan=n][,macaddr=mac][,model=type][,name=str][,addr=str][,vectors=v]\n" 11375824d651Sblueswir1 " create a new Network Interface Card and connect it to VLAN 'n'\n" 11385824d651Sblueswir1#ifdef CONFIG_SLIRP 1139c54ed5bcSJan Kiszka "-net user[,vlan=n][,name=str][,net=addr[/mask]][,host=addr][,restrict=on|off]\n" 1140c92ef6a2SJan Kiszka " [,hostname=host][,dhcpstart=addr][,dns=addr][,tftp=dir][,bootfile=f]\n" 1141c92ef6a2SJan Kiszka " [,hostfwd=rule][,guestfwd=rule]" 1142ad196a9dSJan Kiszka#ifndef _WIN32 1143c92ef6a2SJan Kiszka "[,smb=dir[,smbserver=addr]]\n" 1144ad196a9dSJan Kiszka#endif 1145ad196a9dSJan Kiszka " connect the user mode network stack to VLAN 'n', configure its\n" 1146ad196a9dSJan Kiszka " DHCP server and enabled optional services\n" 11475824d651Sblueswir1#endif 11485824d651Sblueswir1#ifdef _WIN32 11495824d651Sblueswir1 "-net tap[,vlan=n][,name=str],ifname=name\n" 11505824d651Sblueswir1 " connect the host TAP network interface to VLAN 'n'\n" 11515824d651Sblueswir1#else 11525430a28fSmst@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" 11535824d651Sblueswir1 " connect the host TAP network interface to VLAN 'n' and use the\n" 1154bec7c2d4SPaolo Bonzini " network scripts 'file' (default=" DEFAULT_NETWORK_SCRIPT ")\n" 1155bec7c2d4SPaolo Bonzini " and 'dfile' (default=" DEFAULT_NETWORK_DOWN_SCRIPT ")\n" 1156ca1a8a06SBruce Rogers " use '[down]script=no' to disable script execution\n" 11575824d651Sblueswir1 " use 'fd=h' to connect to an already opened TAP interface\n" 1158ca1a8a06SBruce Rogers " use 'sndbuf=nbytes' to limit the size of the send buffer (the\n" 1159f157ed20SMichael S. Tsirkin " default is disabled 'sndbuf=0' to enable flow control set 'sndbuf=1048576')\n" 1160ca1a8a06SBruce Rogers " use vnet_hdr=off to avoid enabling the IFF_VNET_HDR tap flag\n" 1161ca1a8a06SBruce Rogers " use vnet_hdr=on to make the lack of IFF_VNET_HDR support an error condition\n" 116282b0d80eSMichael S. Tsirkin " use vhost=on to enable experimental in kernel accelerator\n" 11635430a28fSmst@redhat.com " (only has effect for virtio guests which use MSIX)\n" 11645430a28fSmst@redhat.com " use vhostforce=on to force vhost on for non-MSIX virtio guests\n" 116582b0d80eSMichael S. Tsirkin " use 'vhostfd=h' to connect to an already opened vhost net device\n" 11660df0ff6dSMark McLoughlin#endif 11675824d651Sblueswir1 "-net socket[,vlan=n][,name=str][,fd=h][,listen=[host]:port][,connect=host:port]\n" 11685824d651Sblueswir1 " connect the vlan 'n' to another VLAN using a socket connection\n" 11693a75e74cSMike Ryan "-net socket[,vlan=n][,name=str][,fd=h][,mcast=maddr:port[,localaddr=addr]]\n" 11705824d651Sblueswir1 " connect the vlan 'n' to multicast maddr and port\n" 11713a75e74cSMike Ryan " use 'localaddr=addr' to specify the host address to send packets from\n" 11725824d651Sblueswir1#ifdef CONFIG_VDE 11735824d651Sblueswir1 "-net vde[,vlan=n][,name=str][,sock=socketpath][,port=n][,group=groupname][,mode=octalmode]\n" 11745824d651Sblueswir1 " connect the vlan 'n' to port 'n' of a vde switch running\n" 11755824d651Sblueswir1 " on host and listening for incoming connections on 'socketpath'.\n" 11765824d651Sblueswir1 " Use group 'groupname' and mode 'octalmode' to change default\n" 11775824d651Sblueswir1 " ownership and permissions for communication port.\n" 11785824d651Sblueswir1#endif 1179bb9ea79eSaliguori "-net dump[,vlan=n][,file=f][,len=n]\n" 1180bb9ea79eSaliguori " dump traffic on vlan 'n' to file 'f' (max n bytes per packet)\n" 1181ca1a8a06SBruce Rogers "-net none use it alone to have zero network devices. If no -net option\n" 1182ad96090aSBlue Swirl " is provided, the default is '-net nic -net user'\n", QEMU_ARCH_ALL) 1183a1ea458fSMark McLoughlinDEF("netdev", HAS_ARG, QEMU_OPTION_netdev, 1184a1ea458fSMark McLoughlin "-netdev [" 1185a1ea458fSMark McLoughlin#ifdef CONFIG_SLIRP 1186a1ea458fSMark McLoughlin "user|" 1187a1ea458fSMark McLoughlin#endif 1188a1ea458fSMark McLoughlin "tap|" 1189a1ea458fSMark McLoughlin#ifdef CONFIG_VDE 1190a1ea458fSMark McLoughlin "vde|" 1191a1ea458fSMark McLoughlin#endif 1192ad96090aSBlue Swirl "socket],id=str[,option][,option][,...]\n", QEMU_ARCH_ALL) 11935824d651Sblueswir1STEXI 1194ffe6370cSMichael S. Tsirkin@item -net nic[,vlan=@var{n}][,macaddr=@var{mac}][,model=@var{type}] [,name=@var{name}][,addr=@var{addr}][,vectors=@var{v}] 11956616b2adSStefan Weil@findex -net 11965824d651Sblueswir1Create a new Network Interface Card and connect it to VLAN @var{n} (@var{n} 11970d6b0b1dSAnthony Liguori= 0 is the default). The NIC is an e1000 by default on the PC 11985607c388SMarkus Armbrustertarget. Optionally, the MAC address can be changed to @var{mac}, the 11995607c388SMarkus Armbrusterdevice address set to @var{addr} (PCI cards only), 1200ffe6370cSMichael S. Tsirkinand a @var{name} can be assigned for use in monitor commands. 1201ffe6370cSMichael S. TsirkinOptionally, for PCI cards, you can specify the number @var{v} of MSI-X vectors 1202ffe6370cSMichael S. Tsirkinthat the card should have; this option currently only affects virtio cards; set 1203ffe6370cSMichael S. Tsirkin@var{v} = 0 to disable MSI-X. If no @option{-net} option is specified, a single 1204ffe6370cSMichael S. TsirkinNIC is created. Qemu can emulate several different models of network card. 12055824d651Sblueswir1Valid values for @var{type} are 1206ffe6370cSMichael S. Tsirkin@code{virtio}, @code{i82551}, @code{i82557b}, @code{i82559er}, 12075824d651Sblueswir1@code{ne2k_pci}, @code{ne2k_isa}, @code{pcnet}, @code{rtl8139}, 12085824d651Sblueswir1@code{e1000}, @code{smc91c111}, @code{lance} and @code{mcf_fec}. 12095824d651Sblueswir1Not all devices are supported on all targets. Use -net nic,model=? 12105824d651Sblueswir1for a list of available devices for your target. 12115824d651Sblueswir1 1212ad196a9dSJan Kiszka@item -net user[,@var{option}][,@var{option}][,...] 12135824d651Sblueswir1Use the user mode network stack which requires no administrator 1214ad196a9dSJan Kiszkaprivilege to run. Valid options are: 12155824d651Sblueswir1 1216b3f046c2SKevin Wolf@table @option 1217ad196a9dSJan Kiszka@item vlan=@var{n} 1218ad196a9dSJan KiszkaConnect user mode stack to VLAN @var{n} (@var{n} = 0 is the default). 1219ad196a9dSJan Kiszka 1220ad196a9dSJan Kiszka@item name=@var{name} 1221ad196a9dSJan KiszkaAssign symbolic name for use in monitor commands. 1222ad196a9dSJan Kiszka 1223c92ef6a2SJan Kiszka@item net=@var{addr}[/@var{mask}] 1224c92ef6a2SJan KiszkaSet IP network address the guest will see. Optionally specify the netmask, 1225c92ef6a2SJan Kiszkaeither in the form a.b.c.d or as number of valid top-most bits. Default is 1226b0b36e5dSBrad Hards10.0.2.0/24. 1227c92ef6a2SJan Kiszka 1228c92ef6a2SJan Kiszka@item host=@var{addr} 1229c92ef6a2SJan KiszkaSpecify the guest-visible address of the host. Default is the 2nd IP in the 1230c92ef6a2SJan Kiszkaguest network, i.e. x.x.x.2. 1231ad196a9dSJan Kiszka 1232c54ed5bcSJan Kiszka@item restrict=on|off 1233caef55edSBrad HardsIf this option is enabled, the guest will be isolated, i.e. it will not be 1234ad196a9dSJan Kiszkaable to contact the host and no guest IP packets will be routed over the host 1235caef55edSBrad Hardsto the outside. This option does not affect any explicitly set forwarding rules. 1236ad196a9dSJan Kiszka 1237ad196a9dSJan Kiszka@item hostname=@var{name} 1238ad196a9dSJan KiszkaSpecifies the client hostname reported by the builtin DHCP server. 1239ad196a9dSJan Kiszka 1240c92ef6a2SJan Kiszka@item dhcpstart=@var{addr} 1241c92ef6a2SJan KiszkaSpecify the first of the 16 IPs the built-in DHCP server can assign. Default 1242b0b36e5dSBrad Hardsis the 15th to 31st IP in the guest network, i.e. x.x.x.15 to x.x.x.31. 1243c92ef6a2SJan Kiszka 1244c92ef6a2SJan Kiszka@item dns=@var{addr} 1245c92ef6a2SJan KiszkaSpecify the guest-visible address of the virtual nameserver. The address must 1246c92ef6a2SJan Kiszkabe different from the host address. Default is the 3rd IP in the guest network, 1247c92ef6a2SJan Kiszkai.e. x.x.x.3. 1248c92ef6a2SJan Kiszka 1249ad196a9dSJan Kiszka@item tftp=@var{dir} 1250ad196a9dSJan KiszkaWhen using the user mode network stack, activate a built-in TFTP 1251ad196a9dSJan Kiszkaserver. The files in @var{dir} will be exposed as the root of a TFTP server. 1252ad196a9dSJan KiszkaThe TFTP client on the guest must be configured in binary mode (use the command 1253c92ef6a2SJan Kiszka@code{bin} of the Unix TFTP client). 1254ad196a9dSJan Kiszka 1255ad196a9dSJan Kiszka@item bootfile=@var{file} 1256ad196a9dSJan KiszkaWhen using the user mode network stack, broadcast @var{file} as the BOOTP 1257ad196a9dSJan Kiszkafilename. In conjunction with @option{tftp}, this can be used to network boot 1258ad196a9dSJan Kiszkaa guest from a local directory. 1259ad196a9dSJan Kiszka 1260ad196a9dSJan KiszkaExample (using pxelinux): 1261ad196a9dSJan Kiszka@example 1262ad196a9dSJan Kiszkaqemu -hda linux.img -boot n -net user,tftp=/path/to/tftp/files,bootfile=/pxelinux.0 1263ad196a9dSJan Kiszka@end example 1264ad196a9dSJan Kiszka 1265c92ef6a2SJan Kiszka@item smb=@var{dir}[,smbserver=@var{addr}] 1266ad196a9dSJan KiszkaWhen using the user mode network stack, activate a built-in SMB 1267ad196a9dSJan Kiszkaserver so that Windows OSes can access to the host files in @file{@var{dir}} 1268c92ef6a2SJan Kiszkatransparently. The IP address of the SMB server can be set to @var{addr}. By 1269c92ef6a2SJan Kiszkadefault the 4th IP in the guest network is used, i.e. x.x.x.4. 1270ad196a9dSJan Kiszka 1271ad196a9dSJan KiszkaIn the guest Windows OS, the line: 1272ad196a9dSJan Kiszka@example 1273ad196a9dSJan Kiszka10.0.2.4 smbserver 1274ad196a9dSJan Kiszka@end example 1275ad196a9dSJan Kiszkamust be added in the file @file{C:\WINDOWS\LMHOSTS} (for windows 9x/Me) 1276ad196a9dSJan Kiszkaor @file{C:\WINNT\SYSTEM32\DRIVERS\ETC\LMHOSTS} (Windows NT/2000). 1277ad196a9dSJan Kiszka 1278ad196a9dSJan KiszkaThen @file{@var{dir}} can be accessed in @file{\\smbserver\qemu}. 1279ad196a9dSJan Kiszka 1280ad196a9dSJan KiszkaNote that a SAMBA server must be installed on the host OS in 1281ad196a9dSJan Kiszka@file{/usr/sbin/smbd}. QEMU was tested successfully with smbd versions from 1282ad196a9dSJan KiszkaRed Hat 9, Fedora Core 3 and OpenSUSE 11.x. 1283ad196a9dSJan Kiszka 12843c6a0580SJan Kiszka@item hostfwd=[tcp|udp]:[@var{hostaddr}]:@var{hostport}-[@var{guestaddr}]:@var{guestport} 1285c92ef6a2SJan KiszkaRedirect incoming TCP or UDP connections to the host port @var{hostport} to 1286c92ef6a2SJan Kiszkathe guest IP address @var{guestaddr} on guest port @var{guestport}. If 1287c92ef6a2SJan Kiszka@var{guestaddr} is not specified, its value is x.x.x.15 (default first address 12883c6a0580SJan Kiszkagiven by the built-in DHCP server). By specifying @var{hostaddr}, the rule can 12893c6a0580SJan Kiszkabe bound to a specific host interface. If no connection type is set, TCP is 1290c92ef6a2SJan Kiszkaused. This option can be given multiple times. 1291ad196a9dSJan Kiszka 1292ad196a9dSJan KiszkaFor example, to redirect host X11 connection from screen 1 to guest 1293ad196a9dSJan Kiszkascreen 0, use the following: 1294ad196a9dSJan Kiszka 1295ad196a9dSJan Kiszka@example 1296ad196a9dSJan Kiszka# on the host 12973c6a0580SJan Kiszkaqemu -net user,hostfwd=tcp:127.0.0.1:6001-:6000 [...] 1298ad196a9dSJan Kiszka# this host xterm should open in the guest X11 server 1299ad196a9dSJan Kiszkaxterm -display :1 1300ad196a9dSJan Kiszka@end example 1301ad196a9dSJan Kiszka 1302ad196a9dSJan KiszkaTo redirect telnet connections from host port 5555 to telnet port on 1303ad196a9dSJan Kiszkathe guest, use the following: 1304ad196a9dSJan Kiszka 1305ad196a9dSJan Kiszka@example 1306ad196a9dSJan Kiszka# on the host 1307aa375206SAurelien Jarnoqemu -net user,hostfwd=tcp::5555-:23 [...] 1308ad196a9dSJan Kiszkatelnet localhost 5555 1309ad196a9dSJan Kiszka@end example 1310ad196a9dSJan Kiszka 1311ad196a9dSJan KiszkaThen when you use on the host @code{telnet localhost 5555}, you 1312ad196a9dSJan Kiszkaconnect to the guest telnet server. 1313ad196a9dSJan Kiszka 1314c92ef6a2SJan Kiszka@item guestfwd=[tcp]:@var{server}:@var{port}-@var{dev} 13153c6a0580SJan KiszkaForward guest TCP connections to the IP address @var{server} on port @var{port} 13163c6a0580SJan Kiszkato the character device @var{dev}. This option can be given multiple times. 1317ad196a9dSJan Kiszka 1318ad196a9dSJan Kiszka@end table 1319ad196a9dSJan Kiszka 1320ad196a9dSJan KiszkaNote: Legacy stand-alone options -tftp, -bootp, -smb and -redir are still 1321ad196a9dSJan Kiszkaprocessed and applied to -net user. Mixing them with the new configuration 1322ad196a9dSJan Kiszkasyntax gives undefined results. Their use for new applications is discouraged 1323ad196a9dSJan Kiszkaas they will be removed from future versions. 13245824d651Sblueswir1 13255824d651Sblueswir1@item -net tap[,vlan=@var{n}][,name=@var{name}][,fd=@var{h}][,ifname=@var{name}] [,script=@var{file}][,downscript=@var{dfile}] 13265824d651Sblueswir1Connect the host TAP network interface @var{name} to VLAN @var{n}, use 13275824d651Sblueswir1the network script @var{file} to configure it and the network script 13285824d651Sblueswir1@var{dfile} to deconfigure it. If @var{name} is not provided, the OS 13295824d651Sblueswir1automatically provides one. @option{fd}=@var{h} can be used to specify 13305824d651Sblueswir1the handle of an already opened host TAP interface. The default network 13315824d651Sblueswir1configure script is @file{/etc/qemu-ifup} and the default network 13325824d651Sblueswir1deconfigure script is @file{/etc/qemu-ifdown}. Use @option{script=no} 13335824d651Sblueswir1or @option{downscript=no} to disable script execution. Example: 13345824d651Sblueswir1 13355824d651Sblueswir1@example 13365824d651Sblueswir1qemu linux.img -net nic -net tap 13375824d651Sblueswir1@end example 13385824d651Sblueswir1 13395824d651Sblueswir1More complicated example (two NICs, each one connected to a TAP device) 13405824d651Sblueswir1@example 13415824d651Sblueswir1qemu linux.img -net nic,vlan=0 -net tap,vlan=0,ifname=tap0 \ 13425824d651Sblueswir1 -net nic,vlan=1 -net tap,vlan=1,ifname=tap1 13435824d651Sblueswir1@end example 13445824d651Sblueswir1 13455824d651Sblueswir1@item -net socket[,vlan=@var{n}][,name=@var{name}][,fd=@var{h}] [,listen=[@var{host}]:@var{port}][,connect=@var{host}:@var{port}] 13465824d651Sblueswir1 13475824d651Sblueswir1Connect the VLAN @var{n} to a remote VLAN in another QEMU virtual 13485824d651Sblueswir1machine using a TCP socket connection. If @option{listen} is 13495824d651Sblueswir1specified, QEMU waits for incoming connections on @var{port} 13505824d651Sblueswir1(@var{host} is optional). @option{connect} is used to connect to 13515824d651Sblueswir1another QEMU instance using the @option{listen} option. @option{fd}=@var{h} 13525824d651Sblueswir1specifies an already opened TCP socket. 13535824d651Sblueswir1 13545824d651Sblueswir1Example: 13555824d651Sblueswir1@example 13565824d651Sblueswir1# launch a first QEMU instance 13575824d651Sblueswir1qemu linux.img -net nic,macaddr=52:54:00:12:34:56 \ 13585824d651Sblueswir1 -net socket,listen=:1234 13595824d651Sblueswir1# connect the VLAN 0 of this instance to the VLAN 0 13605824d651Sblueswir1# of the first instance 13615824d651Sblueswir1qemu linux.img -net nic,macaddr=52:54:00:12:34:57 \ 13625824d651Sblueswir1 -net socket,connect=127.0.0.1:1234 13635824d651Sblueswir1@end example 13645824d651Sblueswir1 13653a75e74cSMike Ryan@item -net socket[,vlan=@var{n}][,name=@var{name}][,fd=@var{h}][,mcast=@var{maddr}:@var{port}[,localaddr=@var{addr}]] 13665824d651Sblueswir1 13675824d651Sblueswir1Create a VLAN @var{n} shared with another QEMU virtual 13685824d651Sblueswir1machines using a UDP multicast socket, effectively making a bus for 13695824d651Sblueswir1every QEMU with same multicast address @var{maddr} and @var{port}. 13705824d651Sblueswir1NOTES: 13715824d651Sblueswir1@enumerate 13725824d651Sblueswir1@item 13735824d651Sblueswir1Several QEMU can be running on different hosts and share same bus (assuming 13745824d651Sblueswir1correct multicast setup for these hosts). 13755824d651Sblueswir1@item 13765824d651Sblueswir1mcast support is compatible with User Mode Linux (argument @option{eth@var{N}=mcast}), see 13775824d651Sblueswir1@url{http://user-mode-linux.sf.net}. 13785824d651Sblueswir1@item 13795824d651Sblueswir1Use @option{fd=h} to specify an already opened UDP multicast socket. 13805824d651Sblueswir1@end enumerate 13815824d651Sblueswir1 13825824d651Sblueswir1Example: 13835824d651Sblueswir1@example 13845824d651Sblueswir1# launch one QEMU instance 13855824d651Sblueswir1qemu linux.img -net nic,macaddr=52:54:00:12:34:56 \ 13865824d651Sblueswir1 -net socket,mcast=230.0.0.1:1234 13875824d651Sblueswir1# launch another QEMU instance on same "bus" 13885824d651Sblueswir1qemu linux.img -net nic,macaddr=52:54:00:12:34:57 \ 13895824d651Sblueswir1 -net socket,mcast=230.0.0.1:1234 13905824d651Sblueswir1# launch yet another QEMU instance on same "bus" 13915824d651Sblueswir1qemu linux.img -net nic,macaddr=52:54:00:12:34:58 \ 13925824d651Sblueswir1 -net socket,mcast=230.0.0.1:1234 13935824d651Sblueswir1@end example 13945824d651Sblueswir1 13955824d651Sblueswir1Example (User Mode Linux compat.): 13965824d651Sblueswir1@example 13975824d651Sblueswir1# launch QEMU instance (note mcast address selected 13985824d651Sblueswir1# is UML's default) 13995824d651Sblueswir1qemu linux.img -net nic,macaddr=52:54:00:12:34:56 \ 14005824d651Sblueswir1 -net socket,mcast=239.192.168.1:1102 14015824d651Sblueswir1# launch UML 14025824d651Sblueswir1/path/to/linux ubd0=/path/to/root_fs eth0=mcast 14035824d651Sblueswir1@end example 14045824d651Sblueswir1 14053a75e74cSMike RyanExample (send packets from host's 1.2.3.4): 14063a75e74cSMike Ryan@example 14073a75e74cSMike Ryanqemu linux.img -net nic,macaddr=52:54:00:12:34:56 \ 14083a75e74cSMike Ryan -net socket,mcast=239.192.168.1:1102,localaddr=1.2.3.4 14093a75e74cSMike Ryan@end example 14103a75e74cSMike Ryan 14115824d651Sblueswir1@item -net vde[,vlan=@var{n}][,name=@var{name}][,sock=@var{socketpath}] [,port=@var{n}][,group=@var{groupname}][,mode=@var{octalmode}] 14125824d651Sblueswir1Connect VLAN @var{n} to PORT @var{n} of a vde switch running on host and 14135824d651Sblueswir1listening for incoming connections on @var{socketpath}. Use GROUP @var{groupname} 14145824d651Sblueswir1and MODE @var{octalmode} to change default ownership and permissions for 14155824d651Sblueswir1communication port. This option is available only if QEMU has been compiled 14165824d651Sblueswir1with vde support enabled. 14175824d651Sblueswir1 14185824d651Sblueswir1Example: 14195824d651Sblueswir1@example 14205824d651Sblueswir1# launch vde switch 14215824d651Sblueswir1vde_switch -F -sock /tmp/myswitch 14225824d651Sblueswir1# launch QEMU instance 14235824d651Sblueswir1qemu linux.img -net nic -net vde,sock=/tmp/myswitch 14245824d651Sblueswir1@end example 14255824d651Sblueswir1 1426bb9ea79eSaliguori@item -net dump[,vlan=@var{n}][,file=@var{file}][,len=@var{len}] 1427bb9ea79eSaliguoriDump network traffic on VLAN @var{n} to file @var{file} (@file{qemu-vlan0.pcap} by default). 1428bb9ea79eSaliguoriAt most @var{len} bytes (64k by default) per packet are stored. The file format is 1429bb9ea79eSaliguorilibpcap, so it can be analyzed with tools such as tcpdump or Wireshark. 1430bb9ea79eSaliguori 14315824d651Sblueswir1@item -net none 14325824d651Sblueswir1Indicate that no network devices should be configured. It is used to 14335824d651Sblueswir1override the default configuration (@option{-net nic -net user}) which 14345824d651Sblueswir1is activated if no @option{-net} options are provided. 14355824d651Sblueswir1 14365824d651Sblueswir1@end table 14375824d651Sblueswir1ETEXI 14385824d651Sblueswir1 14397273a2dbSMatthew BoothDEFHEADING() 14407273a2dbSMatthew Booth 14417273a2dbSMatthew BoothDEFHEADING(Character device options:) 14427273a2dbSMatthew Booth 14437273a2dbSMatthew BoothDEF("chardev", HAS_ARG, QEMU_OPTION_chardev, 144497331287SJan Kiszka "-chardev null,id=id[,mux=on|off]\n" 14457273a2dbSMatthew Booth "-chardev socket,id=id[,host=host],port=host[,to=to][,ipv4][,ipv6][,nodelay]\n" 144697331287SJan Kiszka " [,server][,nowait][,telnet][,mux=on|off] (tcp)\n" 144797331287SJan Kiszka "-chardev socket,id=id,path=path[,server][,nowait][,telnet],[mux=on|off] (unix)\n" 14487273a2dbSMatthew Booth "-chardev udp,id=id[,host=host],port=port[,localaddr=localaddr]\n" 144997331287SJan Kiszka " [,localport=localport][,ipv4][,ipv6][,mux=on|off]\n" 145097331287SJan Kiszka "-chardev msmouse,id=id[,mux=on|off]\n" 14517273a2dbSMatthew Booth "-chardev vc,id=id[[,width=width][,height=height]][[,cols=cols][,rows=rows]]\n" 145297331287SJan Kiszka " [,mux=on|off]\n" 145397331287SJan Kiszka "-chardev file,id=id,path=path[,mux=on|off]\n" 145497331287SJan Kiszka "-chardev pipe,id=id,path=path[,mux=on|off]\n" 14557273a2dbSMatthew Booth#ifdef _WIN32 145697331287SJan Kiszka "-chardev console,id=id[,mux=on|off]\n" 145797331287SJan Kiszka "-chardev serial,id=id,path=path[,mux=on|off]\n" 14587273a2dbSMatthew Booth#else 145997331287SJan Kiszka "-chardev pty,id=id[,mux=on|off]\n" 1460b7fdb3abSAurelien Jarno "-chardev stdio,id=id[,mux=on|off][,signal=on|off]\n" 14617273a2dbSMatthew Booth#endif 14627273a2dbSMatthew Booth#ifdef CONFIG_BRLAPI 146397331287SJan Kiszka "-chardev braille,id=id[,mux=on|off]\n" 14647273a2dbSMatthew Booth#endif 14657273a2dbSMatthew Booth#if defined(__linux__) || defined(__sun__) || defined(__FreeBSD__) \ 14667273a2dbSMatthew Booth || defined(__NetBSD__) || defined(__OpenBSD__) || defined(__DragonFly__) 146797331287SJan Kiszka "-chardev tty,id=id,path=path[,mux=on|off]\n" 14687273a2dbSMatthew Booth#endif 14697273a2dbSMatthew Booth#if defined(__linux__) || defined(__FreeBSD__) || defined(__DragonFly__) 147097331287SJan Kiszka "-chardev parport,id=id,path=path[,mux=on|off]\n" 14717273a2dbSMatthew Booth#endif 1472cbcc6336SAlon Levy#if defined(CONFIG_SPICE) 1473cbcc6336SAlon Levy "-chardev spicevmc,id=id,name=name[,debug=debug]\n" 1474cbcc6336SAlon Levy#endif 1475ad96090aSBlue Swirl , QEMU_ARCH_ALL 14767273a2dbSMatthew Booth) 14777273a2dbSMatthew Booth 14787273a2dbSMatthew BoothSTEXI 14797273a2dbSMatthew Booth 14807273a2dbSMatthew BoothThe general form of a character device option is: 14817273a2dbSMatthew Booth@table @option 14827273a2dbSMatthew Booth 148397331287SJan Kiszka@item -chardev @var{backend} ,id=@var{id} [,mux=on|off] [,@var{options}] 14846616b2adSStefan Weil@findex -chardev 14857273a2dbSMatthew BoothBackend is one of: 14867273a2dbSMatthew Booth@option{null}, 14877273a2dbSMatthew Booth@option{socket}, 14887273a2dbSMatthew Booth@option{udp}, 14897273a2dbSMatthew Booth@option{msmouse}, 14907273a2dbSMatthew Booth@option{vc}, 14917273a2dbSMatthew Booth@option{file}, 14927273a2dbSMatthew Booth@option{pipe}, 14937273a2dbSMatthew Booth@option{console}, 14947273a2dbSMatthew Booth@option{serial}, 14957273a2dbSMatthew Booth@option{pty}, 14967273a2dbSMatthew Booth@option{stdio}, 14977273a2dbSMatthew Booth@option{braille}, 14987273a2dbSMatthew Booth@option{tty}, 1499cbcc6336SAlon Levy@option{parport}, 1500cbcc6336SAlon Levy@option{spicevmc}. 15017273a2dbSMatthew BoothThe specific backend will determine the applicable options. 15027273a2dbSMatthew Booth 15037273a2dbSMatthew BoothAll devices must have an id, which can be any string up to 127 characters long. 15047273a2dbSMatthew BoothIt is used to uniquely identify this device in other command line directives. 15057273a2dbSMatthew Booth 150697331287SJan KiszkaA character device may be used in multiplexing mode by multiple front-ends. 150797331287SJan KiszkaThe key sequence of @key{Control-a} and @key{c} will rotate the input focus 150897331287SJan Kiszkabetween attached front-ends. Specify @option{mux=on} to enable this mode. 150997331287SJan Kiszka 15107273a2dbSMatthew BoothOptions to each backend are described below. 15117273a2dbSMatthew Booth 15127273a2dbSMatthew Booth@item -chardev null ,id=@var{id} 15137273a2dbSMatthew BoothA void device. This device will not emit any data, and will drop any data it 15147273a2dbSMatthew Boothreceives. The null backend does not take any options. 15157273a2dbSMatthew Booth 15167273a2dbSMatthew Booth@item -chardev socket ,id=@var{id} [@var{TCP options} or @var{unix options}] [,server] [,nowait] [,telnet] 15177273a2dbSMatthew Booth 15187273a2dbSMatthew BoothCreate a two-way stream socket, which can be either a TCP or a unix socket. A 15197273a2dbSMatthew Boothunix socket will be created if @option{path} is specified. Behaviour is 15207273a2dbSMatthew Boothundefined if TCP options are specified for a unix socket. 15217273a2dbSMatthew Booth 15227273a2dbSMatthew Booth@option{server} specifies that the socket shall be a listening socket. 15237273a2dbSMatthew Booth 15247273a2dbSMatthew Booth@option{nowait} specifies that QEMU should not block waiting for a client to 15257273a2dbSMatthew Boothconnect to a listening socket. 15267273a2dbSMatthew Booth 15277273a2dbSMatthew Booth@option{telnet} specifies that traffic on the socket should interpret telnet 15287273a2dbSMatthew Boothescape sequences. 15297273a2dbSMatthew Booth 15307273a2dbSMatthew BoothTCP and unix socket options are given below: 15317273a2dbSMatthew Booth 15327273a2dbSMatthew Booth@table @option 15337273a2dbSMatthew Booth 15348d533561SAurelien Jarno@item TCP options: port=@var{port} [,host=@var{host}] [,to=@var{to}] [,ipv4] [,ipv6] [,nodelay] 15357273a2dbSMatthew Booth 15367273a2dbSMatthew Booth@option{host} for a listening socket specifies the local address to be bound. 15377273a2dbSMatthew BoothFor a connecting socket species the remote host to connect to. @option{host} is 15387273a2dbSMatthew Boothoptional for listening sockets. If not specified it defaults to @code{0.0.0.0}. 15397273a2dbSMatthew Booth 15407273a2dbSMatthew Booth@option{port} for a listening socket specifies the local port to be bound. For a 15417273a2dbSMatthew Boothconnecting socket specifies the port on the remote host to connect to. 15427273a2dbSMatthew Booth@option{port} can be given as either a port number or a service name. 15437273a2dbSMatthew Booth@option{port} is required. 15447273a2dbSMatthew Booth 15457273a2dbSMatthew Booth@option{to} is only relevant to listening sockets. If it is specified, and 15467273a2dbSMatthew Booth@option{port} cannot be bound, QEMU will attempt to bind to subsequent ports up 15477273a2dbSMatthew Boothto and including @option{to} until it succeeds. @option{to} must be specified 15487273a2dbSMatthew Boothas a port number. 15497273a2dbSMatthew Booth 15507273a2dbSMatthew Booth@option{ipv4} and @option{ipv6} specify that either IPv4 or IPv6 must be used. 15517273a2dbSMatthew BoothIf neither is specified the socket may use either protocol. 15527273a2dbSMatthew Booth 15537273a2dbSMatthew Booth@option{nodelay} disables the Nagle algorithm. 15547273a2dbSMatthew Booth 15557273a2dbSMatthew Booth@item unix options: path=@var{path} 15567273a2dbSMatthew Booth 15577273a2dbSMatthew Booth@option{path} specifies the local path of the unix socket. @option{path} is 15587273a2dbSMatthew Boothrequired. 15597273a2dbSMatthew Booth 15607273a2dbSMatthew Booth@end table 15617273a2dbSMatthew Booth 15627273a2dbSMatthew Booth@item -chardev udp ,id=@var{id} [,host=@var{host}] ,port=@var{port} [,localaddr=@var{localaddr}] [,localport=@var{localport}] [,ipv4] [,ipv6] 15637273a2dbSMatthew Booth 15647273a2dbSMatthew BoothSends all traffic from the guest to a remote host over UDP. 15657273a2dbSMatthew Booth 15667273a2dbSMatthew Booth@option{host} specifies the remote host to connect to. If not specified it 15677273a2dbSMatthew Boothdefaults to @code{localhost}. 15687273a2dbSMatthew Booth 15697273a2dbSMatthew Booth@option{port} specifies the port on the remote host to connect to. @option{port} 15707273a2dbSMatthew Boothis required. 15717273a2dbSMatthew Booth 15727273a2dbSMatthew Booth@option{localaddr} specifies the local address to bind to. If not specified it 15737273a2dbSMatthew Boothdefaults to @code{0.0.0.0}. 15747273a2dbSMatthew Booth 15757273a2dbSMatthew Booth@option{localport} specifies the local port to bind to. If not specified any 15767273a2dbSMatthew Boothavailable local port will be used. 15777273a2dbSMatthew Booth 15787273a2dbSMatthew Booth@option{ipv4} and @option{ipv6} specify that either IPv4 or IPv6 must be used. 15797273a2dbSMatthew BoothIf neither is specified the device may use either protocol. 15807273a2dbSMatthew Booth 15817273a2dbSMatthew Booth@item -chardev msmouse ,id=@var{id} 15827273a2dbSMatthew Booth 15837273a2dbSMatthew BoothForward QEMU's emulated msmouse events to the guest. @option{msmouse} does not 15847273a2dbSMatthew Boothtake any options. 15857273a2dbSMatthew Booth 15867273a2dbSMatthew Booth@item -chardev vc ,id=@var{id} [[,width=@var{width}] [,height=@var{height}]] [[,cols=@var{cols}] [,rows=@var{rows}]] 15877273a2dbSMatthew Booth 15887273a2dbSMatthew BoothConnect to a QEMU text console. @option{vc} may optionally be given a specific 15897273a2dbSMatthew Boothsize. 15907273a2dbSMatthew Booth 15917273a2dbSMatthew Booth@option{width} and @option{height} specify the width and height respectively of 15927273a2dbSMatthew Booththe console, in pixels. 15937273a2dbSMatthew Booth 15947273a2dbSMatthew Booth@option{cols} and @option{rows} specify that the console be sized to fit a text 15957273a2dbSMatthew Boothconsole with the given dimensions. 15967273a2dbSMatthew Booth 15977273a2dbSMatthew Booth@item -chardev file ,id=@var{id} ,path=@var{path} 15987273a2dbSMatthew Booth 15997273a2dbSMatthew BoothLog all traffic received from the guest to a file. 16007273a2dbSMatthew Booth 16017273a2dbSMatthew Booth@option{path} specifies the path of the file to be opened. This file will be 16027273a2dbSMatthew Boothcreated if it does not already exist, and overwritten if it does. @option{path} 16037273a2dbSMatthew Boothis required. 16047273a2dbSMatthew Booth 16057273a2dbSMatthew Booth@item -chardev pipe ,id=@var{id} ,path=@var{path} 16067273a2dbSMatthew Booth 16077273a2dbSMatthew BoothCreate a two-way connection to the guest. The behaviour differs slightly between 16087273a2dbSMatthew BoothWindows hosts and other hosts: 16097273a2dbSMatthew Booth 16107273a2dbSMatthew BoothOn Windows, a single duplex pipe will be created at 16117273a2dbSMatthew Booth@file{\\.pipe\@option{path}}. 16127273a2dbSMatthew Booth 16137273a2dbSMatthew BoothOn other hosts, 2 pipes will be created called @file{@option{path}.in} and 16147273a2dbSMatthew Booth@file{@option{path}.out}. Data written to @file{@option{path}.in} will be 16157273a2dbSMatthew Boothreceived by the guest. Data written by the guest can be read from 16167273a2dbSMatthew Booth@file{@option{path}.out}. QEMU will not create these fifos, and requires them to 16177273a2dbSMatthew Boothbe present. 16187273a2dbSMatthew Booth 16197273a2dbSMatthew Booth@option{path} forms part of the pipe path as described above. @option{path} is 16207273a2dbSMatthew Boothrequired. 16217273a2dbSMatthew Booth 16227273a2dbSMatthew Booth@item -chardev console ,id=@var{id} 16237273a2dbSMatthew Booth 16247273a2dbSMatthew BoothSend traffic from the guest to QEMU's standard output. @option{console} does not 16257273a2dbSMatthew Boothtake any options. 16267273a2dbSMatthew Booth 16277273a2dbSMatthew Booth@option{console} is only available on Windows hosts. 16287273a2dbSMatthew Booth 16297273a2dbSMatthew Booth@item -chardev serial ,id=@var{id} ,path=@option{path} 16307273a2dbSMatthew Booth 16317273a2dbSMatthew BoothSend traffic from the guest to a serial device on the host. 16327273a2dbSMatthew Booth 16337273a2dbSMatthew Booth@option{serial} is 16347273a2dbSMatthew Boothonly available on Windows hosts. 16357273a2dbSMatthew Booth 16367273a2dbSMatthew Booth@option{path} specifies the name of the serial device to open. 16377273a2dbSMatthew Booth 16387273a2dbSMatthew Booth@item -chardev pty ,id=@var{id} 16397273a2dbSMatthew Booth 16407273a2dbSMatthew BoothCreate a new pseudo-terminal on the host and connect to it. @option{pty} does 16417273a2dbSMatthew Boothnot take any options. 16427273a2dbSMatthew Booth 16437273a2dbSMatthew Booth@option{pty} is not available on Windows hosts. 16447273a2dbSMatthew Booth 1645b7fdb3abSAurelien Jarno@item -chardev stdio ,id=@var{id} [,signal=on|off] 16467273a2dbSMatthew BoothConnect to standard input and standard output of the qemu process. 1647b7fdb3abSAurelien Jarno 1648b7fdb3abSAurelien Jarno@option{signal} controls if signals are enabled on the terminal, that includes 1649b7fdb3abSAurelien Jarnoexiting QEMU with the key sequence @key{Control-c}. This option is enabled by 1650b7fdb3abSAurelien Jarnodefault, use @option{signal=off} to disable it. 1651b7fdb3abSAurelien Jarno 1652b7fdb3abSAurelien Jarno@option{stdio} is not available on Windows hosts. 16537273a2dbSMatthew Booth 16547273a2dbSMatthew Booth@item -chardev braille ,id=@var{id} 16557273a2dbSMatthew Booth 16567273a2dbSMatthew BoothConnect to a local BrlAPI server. @option{braille} does not take any options. 16577273a2dbSMatthew Booth 16587273a2dbSMatthew Booth@item -chardev tty ,id=@var{id} ,path=@var{path} 16597273a2dbSMatthew Booth 16607273a2dbSMatthew BoothConnect to a local tty device. 16617273a2dbSMatthew Booth 16627273a2dbSMatthew Booth@option{tty} is only available on Linux, Sun, FreeBSD, NetBSD, OpenBSD and 16637273a2dbSMatthew BoothDragonFlyBSD hosts. 16647273a2dbSMatthew Booth 16657273a2dbSMatthew Booth@option{path} specifies the path to the tty. @option{path} is required. 16667273a2dbSMatthew Booth 16677273a2dbSMatthew Booth@item -chardev parport ,id=@var{id} ,path=@var{path} 16687273a2dbSMatthew Booth 16697273a2dbSMatthew Booth@option{parport} is only available on Linux, FreeBSD and DragonFlyBSD hosts. 16707273a2dbSMatthew Booth 16717273a2dbSMatthew BoothConnect to a local parallel port. 16727273a2dbSMatthew Booth 16737273a2dbSMatthew Booth@option{path} specifies the path to the parallel port device. @option{path} is 16747273a2dbSMatthew Boothrequired. 16757273a2dbSMatthew Booth 1676cbcc6336SAlon Levy#if defined(CONFIG_SPICE) 1677cbcc6336SAlon Levy@item -chardev spicevmc ,id=@var{id} ,debug=@var{debug}, name=@var{name} 1678cbcc6336SAlon Levy 1679cbcc6336SAlon Levy@option{debug} debug level for spicevmc 1680cbcc6336SAlon Levy 1681cbcc6336SAlon Levy@option{name} name of spice channel to connect to 1682cbcc6336SAlon Levy 1683cbcc6336SAlon LevyConnect to a spice virtual machine channel, such as vdiport. 1684cbcc6336SAlon Levy#endif 1685cbcc6336SAlon Levy 16867273a2dbSMatthew Booth@end table 16877273a2dbSMatthew BoothETEXI 16887273a2dbSMatthew Booth 16897273a2dbSMatthew BoothDEFHEADING() 16907273a2dbSMatthew Booth 16917273a2dbSMatthew BoothDEFHEADING(Bluetooth(R) options:) 16927273a2dbSMatthew Booth 16935824d651Sblueswir1DEF("bt", HAS_ARG, QEMU_OPTION_bt, \ 16945824d651Sblueswir1 "-bt hci,null dumb bluetooth HCI - doesn't respond to commands\n" \ 16955824d651Sblueswir1 "-bt hci,host[:id]\n" \ 16965824d651Sblueswir1 " use host's HCI with the given name\n" \ 16975824d651Sblueswir1 "-bt hci[,vlan=n]\n" \ 16985824d651Sblueswir1 " emulate a standard HCI in virtual scatternet 'n'\n" \ 16995824d651Sblueswir1 "-bt vhci[,vlan=n]\n" \ 17005824d651Sblueswir1 " add host computer to virtual scatternet 'n' using VHCI\n" \ 17015824d651Sblueswir1 "-bt device:dev[,vlan=n]\n" \ 1702ad96090aSBlue Swirl " emulate a bluetooth device 'dev' in scatternet 'n'\n", 1703ad96090aSBlue Swirl QEMU_ARCH_ALL) 17045824d651Sblueswir1STEXI 17055824d651Sblueswir1@table @option 17065824d651Sblueswir1 17075824d651Sblueswir1@item -bt hci[...] 17086616b2adSStefan Weil@findex -bt 17095824d651Sblueswir1Defines the function of the corresponding Bluetooth HCI. -bt options 17105824d651Sblueswir1are matched with the HCIs present in the chosen machine type. For 17115824d651Sblueswir1example when emulating a machine with only one HCI built into it, only 17125824d651Sblueswir1the first @code{-bt hci[...]} option is valid and defines the HCI's 17135824d651Sblueswir1logic. The Transport Layer is decided by the machine type. Currently 17145824d651Sblueswir1the machines @code{n800} and @code{n810} have one HCI and all other 17155824d651Sblueswir1machines have none. 17165824d651Sblueswir1 17175824d651Sblueswir1@anchor{bt-hcis} 17185824d651Sblueswir1The following three types are recognized: 17195824d651Sblueswir1 1720b3f046c2SKevin Wolf@table @option 17215824d651Sblueswir1@item -bt hci,null 17225824d651Sblueswir1(default) The corresponding Bluetooth HCI assumes no internal logic 17235824d651Sblueswir1and will not respond to any HCI commands or emit events. 17245824d651Sblueswir1 17255824d651Sblueswir1@item -bt hci,host[:@var{id}] 17265824d651Sblueswir1(@code{bluez} only) The corresponding HCI passes commands / events 17275824d651Sblueswir1to / from the physical HCI identified by the name @var{id} (default: 17285824d651Sblueswir1@code{hci0}) on the computer running QEMU. Only available on @code{bluez} 17295824d651Sblueswir1capable systems like Linux. 17305824d651Sblueswir1 17315824d651Sblueswir1@item -bt hci[,vlan=@var{n}] 17325824d651Sblueswir1Add a virtual, standard HCI that will participate in the Bluetooth 17335824d651Sblueswir1scatternet @var{n} (default @code{0}). Similarly to @option{-net} 17345824d651Sblueswir1VLANs, devices inside a bluetooth network @var{n} can only communicate 17355824d651Sblueswir1with other devices in the same network (scatternet). 17365824d651Sblueswir1@end table 17375824d651Sblueswir1 17385824d651Sblueswir1@item -bt vhci[,vlan=@var{n}] 17395824d651Sblueswir1(Linux-host only) Create a HCI in scatternet @var{n} (default 0) attached 17405824d651Sblueswir1to the host bluetooth stack instead of to the emulated target. This 17415824d651Sblueswir1allows the host and target machines to participate in a common scatternet 17425824d651Sblueswir1and communicate. Requires the Linux @code{vhci} driver installed. Can 17435824d651Sblueswir1be used as following: 17445824d651Sblueswir1 17455824d651Sblueswir1@example 17465824d651Sblueswir1qemu [...OPTIONS...] -bt hci,vlan=5 -bt vhci,vlan=5 17475824d651Sblueswir1@end example 17485824d651Sblueswir1 17495824d651Sblueswir1@item -bt device:@var{dev}[,vlan=@var{n}] 17505824d651Sblueswir1Emulate a bluetooth device @var{dev} and place it in network @var{n} 17515824d651Sblueswir1(default @code{0}). QEMU can only emulate one type of bluetooth devices 17525824d651Sblueswir1currently: 17535824d651Sblueswir1 1754b3f046c2SKevin Wolf@table @option 17555824d651Sblueswir1@item keyboard 17565824d651Sblueswir1Virtual wireless keyboard implementing the HIDP bluetooth profile. 17575824d651Sblueswir1@end table 17585824d651Sblueswir1@end table 17595824d651Sblueswir1ETEXI 17605824d651Sblueswir1 17615824d651Sblueswir1DEFHEADING() 17625824d651Sblueswir1 17637677f05dSAlexander GrafDEFHEADING(Linux/Multiboot boot specific:) 17645824d651Sblueswir1STEXI 17657677f05dSAlexander Graf 17667677f05dSAlexander GrafWhen using these options, you can use a given Linux or Multiboot 17677677f05dSAlexander Grafkernel without installing it in the disk image. It can be useful 17685824d651Sblueswir1for easier testing of various kernels. 17695824d651Sblueswir1 17705824d651Sblueswir1@table @option 17715824d651Sblueswir1ETEXI 17725824d651Sblueswir1 17735824d651Sblueswir1DEF("kernel", HAS_ARG, QEMU_OPTION_kernel, \ 1774ad96090aSBlue Swirl "-kernel bzImage use 'bzImage' as kernel image\n", QEMU_ARCH_ALL) 17755824d651Sblueswir1STEXI 17765824d651Sblueswir1@item -kernel @var{bzImage} 17776616b2adSStefan Weil@findex -kernel 17787677f05dSAlexander GrafUse @var{bzImage} as kernel image. The kernel can be either a Linux kernel 17797677f05dSAlexander Grafor in multiboot format. 17805824d651Sblueswir1ETEXI 17815824d651Sblueswir1 17825824d651Sblueswir1DEF("append", HAS_ARG, QEMU_OPTION_append, \ 1783ad96090aSBlue Swirl "-append cmdline use 'cmdline' as kernel command line\n", QEMU_ARCH_ALL) 17845824d651Sblueswir1STEXI 17855824d651Sblueswir1@item -append @var{cmdline} 17866616b2adSStefan Weil@findex -append 17875824d651Sblueswir1Use @var{cmdline} as kernel command line 17885824d651Sblueswir1ETEXI 17895824d651Sblueswir1 17905824d651Sblueswir1DEF("initrd", HAS_ARG, QEMU_OPTION_initrd, \ 1791ad96090aSBlue Swirl "-initrd file use 'file' as initial ram disk\n", QEMU_ARCH_ALL) 17925824d651Sblueswir1STEXI 17935824d651Sblueswir1@item -initrd @var{file} 17946616b2adSStefan Weil@findex -initrd 17955824d651Sblueswir1Use @var{file} as initial ram disk. 17967677f05dSAlexander Graf 17977677f05dSAlexander Graf@item -initrd "@var{file1} arg=foo,@var{file2}" 17987677f05dSAlexander Graf 17997677f05dSAlexander GrafThis syntax is only available with multiboot. 18007677f05dSAlexander Graf 18017677f05dSAlexander GrafUse @var{file1} and @var{file2} as modules and pass arg=foo as parameter to the 18027677f05dSAlexander Graffirst module. 18035824d651Sblueswir1ETEXI 18045824d651Sblueswir1 18055824d651Sblueswir1STEXI 18065824d651Sblueswir1@end table 18075824d651Sblueswir1ETEXI 18085824d651Sblueswir1 18095824d651Sblueswir1DEFHEADING() 18105824d651Sblueswir1 18115824d651Sblueswir1DEFHEADING(Debug/Expert options:) 18125824d651Sblueswir1 18135824d651Sblueswir1STEXI 18145824d651Sblueswir1@table @option 18155824d651Sblueswir1ETEXI 18165824d651Sblueswir1 18175824d651Sblueswir1DEF("serial", HAS_ARG, QEMU_OPTION_serial, \ 1818ad96090aSBlue Swirl "-serial dev redirect the serial port to char device 'dev'\n", 1819ad96090aSBlue Swirl QEMU_ARCH_ALL) 18205824d651Sblueswir1STEXI 18215824d651Sblueswir1@item -serial @var{dev} 18226616b2adSStefan Weil@findex -serial 18235824d651Sblueswir1Redirect the virtual serial port to host character device 18245824d651Sblueswir1@var{dev}. The default device is @code{vc} in graphical mode and 18255824d651Sblueswir1@code{stdio} in non graphical mode. 18265824d651Sblueswir1 18275824d651Sblueswir1This option can be used several times to simulate up to 4 serial 18285824d651Sblueswir1ports. 18295824d651Sblueswir1 18305824d651Sblueswir1Use @code{-serial none} to disable all serial ports. 18315824d651Sblueswir1 18325824d651Sblueswir1Available character devices are: 1833b3f046c2SKevin Wolf@table @option 18344e257e5eSKevin Wolf@item vc[:@var{W}x@var{H}] 18355824d651Sblueswir1Virtual console. Optionally, a width and height can be given in pixel with 18365824d651Sblueswir1@example 18375824d651Sblueswir1vc:800x600 18385824d651Sblueswir1@end example 18395824d651Sblueswir1It is also possible to specify width or height in characters: 18405824d651Sblueswir1@example 18415824d651Sblueswir1vc:80Cx24C 18425824d651Sblueswir1@end example 18435824d651Sblueswir1@item pty 18445824d651Sblueswir1[Linux only] Pseudo TTY (a new PTY is automatically allocated) 18455824d651Sblueswir1@item none 18465824d651Sblueswir1No device is allocated. 18475824d651Sblueswir1@item null 18485824d651Sblueswir1void device 18495824d651Sblueswir1@item /dev/XXX 18505824d651Sblueswir1[Linux only] Use host tty, e.g. @file{/dev/ttyS0}. The host serial port 18515824d651Sblueswir1parameters are set according to the emulated ones. 18525824d651Sblueswir1@item /dev/parport@var{N} 18535824d651Sblueswir1[Linux only, parallel port only] Use host parallel port 18545824d651Sblueswir1@var{N}. Currently SPP and EPP parallel port features can be used. 18555824d651Sblueswir1@item file:@var{filename} 18565824d651Sblueswir1Write output to @var{filename}. No character can be read. 18575824d651Sblueswir1@item stdio 18585824d651Sblueswir1[Unix only] standard input/output 18595824d651Sblueswir1@item pipe:@var{filename} 18605824d651Sblueswir1name pipe @var{filename} 18615824d651Sblueswir1@item COM@var{n} 18625824d651Sblueswir1[Windows only] Use host serial port @var{n} 18635824d651Sblueswir1@item udp:[@var{remote_host}]:@var{remote_port}[@@[@var{src_ip}]:@var{src_port}] 18645824d651Sblueswir1This implements UDP Net Console. 18655824d651Sblueswir1When @var{remote_host} or @var{src_ip} are not specified 18665824d651Sblueswir1they default to @code{0.0.0.0}. 18675824d651Sblueswir1When not using a specified @var{src_port} a random port is automatically chosen. 18685824d651Sblueswir1 18695824d651Sblueswir1If you just want a simple readonly console you can use @code{netcat} or 18705824d651Sblueswir1@code{nc}, by starting qemu with: @code{-serial udp::4555} and nc as: 18715824d651Sblueswir1@code{nc -u -l -p 4555}. Any time qemu writes something to that port it 18725824d651Sblueswir1will appear in the netconsole session. 18735824d651Sblueswir1 18745824d651Sblueswir1If you plan to send characters back via netconsole or you want to stop 18755824d651Sblueswir1and start qemu a lot of times, you should have qemu use the same 18765824d651Sblueswir1source port each time by using something like @code{-serial 18775824d651Sblueswir1udp::4555@@:4556} to qemu. Another approach is to use a patched 18785824d651Sblueswir1version of netcat which can listen to a TCP port and send and receive 18795824d651Sblueswir1characters via udp. If you have a patched version of netcat which 18805824d651Sblueswir1activates telnet remote echo and single char transfer, then you can 18815824d651Sblueswir1use the following options to step up a netcat redirector to allow 18825824d651Sblueswir1telnet on port 5555 to access the qemu port. 18835824d651Sblueswir1@table @code 18845824d651Sblueswir1@item Qemu Options: 18855824d651Sblueswir1-serial udp::4555@@:4556 18865824d651Sblueswir1@item netcat options: 18875824d651Sblueswir1-u -P 4555 -L 0.0.0.0:4556 -t -p 5555 -I -T 18885824d651Sblueswir1@item telnet options: 18895824d651Sblueswir1localhost 5555 18905824d651Sblueswir1@end table 18915824d651Sblueswir1 18925824d651Sblueswir1@item tcp:[@var{host}]:@var{port}[,@var{server}][,nowait][,nodelay] 18935824d651Sblueswir1The TCP Net Console has two modes of operation. It can send the serial 18945824d651Sblueswir1I/O to a location or wait for a connection from a location. By default 18955824d651Sblueswir1the TCP Net Console is sent to @var{host} at the @var{port}. If you use 18965824d651Sblueswir1the @var{server} option QEMU will wait for a client socket application 18975824d651Sblueswir1to connect to the port before continuing, unless the @code{nowait} 18985824d651Sblueswir1option was specified. The @code{nodelay} option disables the Nagle buffering 18995824d651Sblueswir1algorithm. If @var{host} is omitted, 0.0.0.0 is assumed. Only 19005824d651Sblueswir1one TCP connection at a time is accepted. You can use @code{telnet} to 19015824d651Sblueswir1connect to the corresponding character device. 19025824d651Sblueswir1@table @code 19035824d651Sblueswir1@item Example to send tcp console to 192.168.0.2 port 4444 19045824d651Sblueswir1-serial tcp:192.168.0.2:4444 19055824d651Sblueswir1@item Example to listen and wait on port 4444 for connection 19065824d651Sblueswir1-serial tcp::4444,server 19075824d651Sblueswir1@item Example to not wait and listen on ip 192.168.0.100 port 4444 19085824d651Sblueswir1-serial tcp:192.168.0.100:4444,server,nowait 19095824d651Sblueswir1@end table 19105824d651Sblueswir1 19115824d651Sblueswir1@item telnet:@var{host}:@var{port}[,server][,nowait][,nodelay] 19125824d651Sblueswir1The telnet protocol is used instead of raw tcp sockets. The options 19135824d651Sblueswir1work the same as if you had specified @code{-serial tcp}. The 19145824d651Sblueswir1difference is that the port acts like a telnet server or client using 19155824d651Sblueswir1telnet option negotiation. This will also allow you to send the 19165824d651Sblueswir1MAGIC_SYSRQ sequence if you use a telnet that supports sending the break 19175824d651Sblueswir1sequence. Typically in unix telnet you do it with Control-] and then 19185824d651Sblueswir1type "send break" followed by pressing the enter key. 19195824d651Sblueswir1 19205824d651Sblueswir1@item unix:@var{path}[,server][,nowait] 19215824d651Sblueswir1A unix domain socket is used instead of a tcp socket. The option works the 19225824d651Sblueswir1same as if you had specified @code{-serial tcp} except the unix domain socket 19235824d651Sblueswir1@var{path} is used for connections. 19245824d651Sblueswir1 19255824d651Sblueswir1@item mon:@var{dev_string} 19265824d651Sblueswir1This is a special option to allow the monitor to be multiplexed onto 19275824d651Sblueswir1another serial port. The monitor is accessed with key sequence of 19285824d651Sblueswir1@key{Control-a} and then pressing @key{c}. See monitor access 19295824d651Sblueswir1@ref{pcsys_keys} in the -nographic section for more keys. 19305824d651Sblueswir1@var{dev_string} should be any one of the serial devices specified 19315824d651Sblueswir1above. An example to multiplex the monitor onto a telnet server 19325824d651Sblueswir1listening on port 4444 would be: 19335824d651Sblueswir1@table @code 19345824d651Sblueswir1@item -serial mon:telnet::4444,server,nowait 19355824d651Sblueswir1@end table 19365824d651Sblueswir1 19375824d651Sblueswir1@item braille 19385824d651Sblueswir1Braille device. This will use BrlAPI to display the braille output on a real 19395824d651Sblueswir1or fake device. 19405824d651Sblueswir1 1941be8b28a9SKevin Wolf@item msmouse 1942be8b28a9SKevin WolfThree button serial mouse. Configure the guest to use Microsoft protocol. 19435824d651Sblueswir1@end table 19445824d651Sblueswir1ETEXI 19455824d651Sblueswir1 19465824d651Sblueswir1DEF("parallel", HAS_ARG, QEMU_OPTION_parallel, \ 1947ad96090aSBlue Swirl "-parallel dev redirect the parallel port to char device 'dev'\n", 1948ad96090aSBlue Swirl QEMU_ARCH_ALL) 19495824d651Sblueswir1STEXI 19505824d651Sblueswir1@item -parallel @var{dev} 19516616b2adSStefan Weil@findex -parallel 19525824d651Sblueswir1Redirect the virtual parallel port to host device @var{dev} (same 19535824d651Sblueswir1devices as the serial port). On Linux hosts, @file{/dev/parportN} can 19545824d651Sblueswir1be used to use hardware devices connected on the corresponding host 19555824d651Sblueswir1parallel port. 19565824d651Sblueswir1 19575824d651Sblueswir1This option can be used several times to simulate up to 3 parallel 19585824d651Sblueswir1ports. 19595824d651Sblueswir1 19605824d651Sblueswir1Use @code{-parallel none} to disable all parallel ports. 19615824d651Sblueswir1ETEXI 19625824d651Sblueswir1 19635824d651Sblueswir1DEF("monitor", HAS_ARG, QEMU_OPTION_monitor, \ 1964ad96090aSBlue Swirl "-monitor dev redirect the monitor to char device 'dev'\n", 1965ad96090aSBlue Swirl QEMU_ARCH_ALL) 19665824d651Sblueswir1STEXI 19674e307fc8SGerd Hoffmann@item -monitor @var{dev} 19686616b2adSStefan Weil@findex -monitor 19695824d651Sblueswir1Redirect the monitor to host device @var{dev} (same devices as the 19705824d651Sblueswir1serial port). 19715824d651Sblueswir1The default device is @code{vc} in graphical mode and @code{stdio} in 19725824d651Sblueswir1non graphical mode. 19735824d651Sblueswir1ETEXI 19746ca5582dSGerd HoffmannDEF("qmp", HAS_ARG, QEMU_OPTION_qmp, \ 1975ad96090aSBlue Swirl "-qmp dev like -monitor but opens in 'control' mode\n", 1976ad96090aSBlue Swirl QEMU_ARCH_ALL) 197795d5f08bSStefan WeilSTEXI 197895d5f08bSStefan Weil@item -qmp @var{dev} 19796616b2adSStefan Weil@findex -qmp 198095d5f08bSStefan WeilLike -monitor but opens in 'control' mode. 198195d5f08bSStefan WeilETEXI 19825824d651Sblueswir1 198322a0e04bSGerd HoffmannDEF("mon", HAS_ARG, QEMU_OPTION_mon, \ 1984ad96090aSBlue Swirl "-mon chardev=[name][,mode=readline|control][,default]\n", QEMU_ARCH_ALL) 198522a0e04bSGerd HoffmannSTEXI 198622a0e04bSGerd Hoffmann@item -mon chardev=[name][,mode=readline|control][,default] 19876616b2adSStefan Weil@findex -mon 198822a0e04bSGerd HoffmannSetup monitor on chardev @var{name}. 198922a0e04bSGerd HoffmannETEXI 199022a0e04bSGerd Hoffmann 1991c9f398e5SH. Peter AnvinDEF("debugcon", HAS_ARG, QEMU_OPTION_debugcon, \ 1992ad96090aSBlue Swirl "-debugcon dev redirect the debug console to char device 'dev'\n", 1993ad96090aSBlue Swirl QEMU_ARCH_ALL) 1994c9f398e5SH. Peter AnvinSTEXI 1995c9f398e5SH. Peter Anvin@item -debugcon @var{dev} 19966616b2adSStefan Weil@findex -debugcon 1997c9f398e5SH. Peter AnvinRedirect the debug console to host device @var{dev} (same devices as the 1998c9f398e5SH. Peter Anvinserial port). The debug console is an I/O port which is typically port 1999c9f398e5SH. Peter Anvin0xe9; writing to that I/O port sends output to this device. 2000c9f398e5SH. Peter AnvinThe default device is @code{vc} in graphical mode and @code{stdio} in 2001c9f398e5SH. Peter Anvinnon graphical mode. 2002c9f398e5SH. Peter AnvinETEXI 2003c9f398e5SH. Peter Anvin 20045824d651Sblueswir1DEF("pidfile", HAS_ARG, QEMU_OPTION_pidfile, \ 2005ad96090aSBlue Swirl "-pidfile file write PID to 'file'\n", QEMU_ARCH_ALL) 20065824d651Sblueswir1STEXI 20075824d651Sblueswir1@item -pidfile @var{file} 20086616b2adSStefan Weil@findex -pidfile 20095824d651Sblueswir1Store the QEMU process PID in @var{file}. It is useful if you launch QEMU 20105824d651Sblueswir1from a script. 20115824d651Sblueswir1ETEXI 20125824d651Sblueswir1 20131b530a6dSaurel32DEF("singlestep", 0, QEMU_OPTION_singlestep, \ 2014ad96090aSBlue Swirl "-singlestep always run in singlestep mode\n", QEMU_ARCH_ALL) 20151b530a6dSaurel32STEXI 20161b530a6dSaurel32@item -singlestep 20176616b2adSStefan Weil@findex -singlestep 20181b530a6dSaurel32Run the emulation in single step mode. 20191b530a6dSaurel32ETEXI 20201b530a6dSaurel32 20215824d651Sblueswir1DEF("S", 0, QEMU_OPTION_S, \ 2022ad96090aSBlue Swirl "-S freeze CPU at startup (use 'c' to start execution)\n", 2023ad96090aSBlue Swirl QEMU_ARCH_ALL) 20245824d651Sblueswir1STEXI 20255824d651Sblueswir1@item -S 20266616b2adSStefan Weil@findex -S 20275824d651Sblueswir1Do not start CPU at startup (you must type 'c' in the monitor). 20285824d651Sblueswir1ETEXI 20295824d651Sblueswir1 203059030a8cSaliguoriDEF("gdb", HAS_ARG, QEMU_OPTION_gdb, \ 2031ad96090aSBlue Swirl "-gdb dev wait for gdb connection on 'dev'\n", QEMU_ARCH_ALL) 20325824d651Sblueswir1STEXI 203359030a8cSaliguori@item -gdb @var{dev} 20346616b2adSStefan Weil@findex -gdb 203559030a8cSaliguoriWait for gdb connection on device @var{dev} (@pxref{gdb_usage}). Typical 203659030a8cSaliguoriconnections will likely be TCP-based, but also UDP, pseudo TTY, or even 203759030a8cSaliguoristdio are reasonable use case. The latter is allowing to start qemu from 203859030a8cSaliguoriwithin gdb and establish the connection via a pipe: 203959030a8cSaliguori@example 204059030a8cSaliguori(gdb) target remote | exec qemu -gdb stdio ... 204159030a8cSaliguori@end example 20425824d651Sblueswir1ETEXI 20435824d651Sblueswir1 204459030a8cSaliguoriDEF("s", 0, QEMU_OPTION_s, \ 2045ad96090aSBlue Swirl "-s shorthand for -gdb tcp::" DEFAULT_GDBSTUB_PORT "\n", 2046ad96090aSBlue Swirl QEMU_ARCH_ALL) 20475824d651Sblueswir1STEXI 204859030a8cSaliguori@item -s 20496616b2adSStefan Weil@findex -s 205059030a8cSaliguoriShorthand for -gdb tcp::1234, i.e. open a gdbserver on TCP port 1234 205159030a8cSaliguori(@pxref{gdb_usage}). 20525824d651Sblueswir1ETEXI 20535824d651Sblueswir1 20545824d651Sblueswir1DEF("d", HAS_ARG, QEMU_OPTION_d, \ 2055ad96090aSBlue Swirl "-d item1,... output log to /tmp/qemu.log (use -d ? for a list of log items)\n", 2056ad96090aSBlue Swirl QEMU_ARCH_ALL) 20575824d651Sblueswir1STEXI 20585824d651Sblueswir1@item -d 20596616b2adSStefan Weil@findex -d 20605824d651Sblueswir1Output log in /tmp/qemu.log 20615824d651Sblueswir1ETEXI 20625824d651Sblueswir1 2063c235d738SMatthew FernandezDEF("D", HAS_ARG, QEMU_OPTION_D, \ 2064c235d738SMatthew Fernandez "-D logfile output log to logfile (instead of the default /tmp/qemu.log)\n", 2065c235d738SMatthew Fernandez QEMU_ARCH_ALL) 2066c235d738SMatthew FernandezSTEXI 2067c235d738SMatthew Fernandez@item -D 2068c235d738SMatthew Fernandez@findex -D 2069c235d738SMatthew FernandezOutput log in logfile instead of /tmp/qemu.log 2070c235d738SMatthew FernandezETEXI 2071c235d738SMatthew Fernandez 20725824d651Sblueswir1DEF("hdachs", HAS_ARG, QEMU_OPTION_hdachs, \ 20735824d651Sblueswir1 "-hdachs c,h,s[,t]\n" \ 20745824d651Sblueswir1 " force hard disk 0 physical geometry and the optional BIOS\n" \ 2075ad96090aSBlue Swirl " translation (t=none or lba) (usually qemu can guess them)\n", 2076ad96090aSBlue Swirl QEMU_ARCH_ALL) 20775824d651Sblueswir1STEXI 20785824d651Sblueswir1@item -hdachs @var{c},@var{h},@var{s},[,@var{t}] 20796616b2adSStefan Weil@findex -hdachs 20805824d651Sblueswir1Force hard disk 0 physical geometry (1 <= @var{c} <= 16383, 1 <= 20815824d651Sblueswir1@var{h} <= 16, 1 <= @var{s} <= 63) and optionally force the BIOS 20825824d651Sblueswir1translation mode (@var{t}=none, lba or auto). Usually QEMU can guess 20835824d651Sblueswir1all those parameters. This option is useful for old MS-DOS disk 20845824d651Sblueswir1images. 20855824d651Sblueswir1ETEXI 20865824d651Sblueswir1 20875824d651Sblueswir1DEF("L", HAS_ARG, QEMU_OPTION_L, \ 2088ad96090aSBlue Swirl "-L path set the directory for the BIOS, VGA BIOS and keymaps\n", 2089ad96090aSBlue Swirl QEMU_ARCH_ALL) 20905824d651Sblueswir1STEXI 20915824d651Sblueswir1@item -L @var{path} 20926616b2adSStefan Weil@findex -L 20935824d651Sblueswir1Set the directory for the BIOS, VGA BIOS and keymaps. 20945824d651Sblueswir1ETEXI 20955824d651Sblueswir1 20965824d651Sblueswir1DEF("bios", HAS_ARG, QEMU_OPTION_bios, \ 2097ad96090aSBlue Swirl "-bios file set the filename for the BIOS\n", QEMU_ARCH_ALL) 20985824d651Sblueswir1STEXI 20995824d651Sblueswir1@item -bios @var{file} 21006616b2adSStefan Weil@findex -bios 21015824d651Sblueswir1Set the filename for the BIOS. 21025824d651Sblueswir1ETEXI 21035824d651Sblueswir1 21045824d651Sblueswir1DEF("enable-kvm", 0, QEMU_OPTION_enable_kvm, \ 2105ad96090aSBlue Swirl "-enable-kvm enable KVM full virtualization support\n", QEMU_ARCH_ALL) 21065824d651Sblueswir1STEXI 21075824d651Sblueswir1@item -enable-kvm 21086616b2adSStefan Weil@findex -enable-kvm 21095824d651Sblueswir1Enable KVM full virtualization support. This option is only available 21105824d651Sblueswir1if KVM support is enabled when compiling. 21115824d651Sblueswir1ETEXI 21125824d651Sblueswir1 2113e37630caSaliguoriDEF("xen-domid", HAS_ARG, QEMU_OPTION_xen_domid, 2114ad96090aSBlue Swirl "-xen-domid id specify xen guest domain id\n", QEMU_ARCH_ALL) 2115e37630caSaliguoriDEF("xen-create", 0, QEMU_OPTION_xen_create, 2116e37630caSaliguori "-xen-create create domain using xen hypercalls, bypassing xend\n" 2117ad96090aSBlue Swirl " warning: should not be used when xend is in use\n", 2118ad96090aSBlue Swirl QEMU_ARCH_ALL) 2119e37630caSaliguoriDEF("xen-attach", 0, QEMU_OPTION_xen_attach, 2120e37630caSaliguori "-xen-attach attach to existing xen domain\n" 2121ad96090aSBlue Swirl " xend will use this when starting qemu\n", 2122ad96090aSBlue Swirl QEMU_ARCH_ALL) 212395d5f08bSStefan WeilSTEXI 212495d5f08bSStefan Weil@item -xen-domid @var{id} 21256616b2adSStefan Weil@findex -xen-domid 212695d5f08bSStefan WeilSpecify xen guest domain @var{id} (XEN only). 212795d5f08bSStefan Weil@item -xen-create 21286616b2adSStefan Weil@findex -xen-create 212995d5f08bSStefan WeilCreate domain using xen hypercalls, bypassing xend. 213095d5f08bSStefan WeilWarning: should not be used when xend is in use (XEN only). 213195d5f08bSStefan Weil@item -xen-attach 21326616b2adSStefan Weil@findex -xen-attach 213395d5f08bSStefan WeilAttach to existing xen domain. 213495d5f08bSStefan Weilxend will use this when starting qemu (XEN only). 213595d5f08bSStefan WeilETEXI 2136e37630caSaliguori 21375824d651Sblueswir1DEF("no-reboot", 0, QEMU_OPTION_no_reboot, \ 2138ad96090aSBlue Swirl "-no-reboot exit instead of rebooting\n", QEMU_ARCH_ALL) 21395824d651Sblueswir1STEXI 21405824d651Sblueswir1@item -no-reboot 21416616b2adSStefan Weil@findex -no-reboot 21425824d651Sblueswir1Exit instead of rebooting. 21435824d651Sblueswir1ETEXI 21445824d651Sblueswir1 21455824d651Sblueswir1DEF("no-shutdown", 0, QEMU_OPTION_no_shutdown, \ 2146ad96090aSBlue Swirl "-no-shutdown stop before shutdown\n", QEMU_ARCH_ALL) 21475824d651Sblueswir1STEXI 21485824d651Sblueswir1@item -no-shutdown 21496616b2adSStefan Weil@findex -no-shutdown 21505824d651Sblueswir1Don't exit QEMU on guest shutdown, but instead only stop the emulation. 21515824d651Sblueswir1This allows for instance switching to monitor to commit changes to the 21525824d651Sblueswir1disk image. 21535824d651Sblueswir1ETEXI 21545824d651Sblueswir1 21555824d651Sblueswir1DEF("loadvm", HAS_ARG, QEMU_OPTION_loadvm, \ 21565824d651Sblueswir1 "-loadvm [tag|id]\n" \ 2157ad96090aSBlue Swirl " start right away with a saved state (loadvm in monitor)\n", 2158ad96090aSBlue Swirl QEMU_ARCH_ALL) 21595824d651Sblueswir1STEXI 21605824d651Sblueswir1@item -loadvm @var{file} 21616616b2adSStefan Weil@findex -loadvm 21625824d651Sblueswir1Start right away with a saved state (@code{loadvm} in monitor) 21635824d651Sblueswir1ETEXI 21645824d651Sblueswir1 21655824d651Sblueswir1#ifndef _WIN32 21665824d651Sblueswir1DEF("daemonize", 0, QEMU_OPTION_daemonize, \ 2167ad96090aSBlue Swirl "-daemonize daemonize QEMU after initializing\n", QEMU_ARCH_ALL) 21685824d651Sblueswir1#endif 21695824d651Sblueswir1STEXI 21705824d651Sblueswir1@item -daemonize 21716616b2adSStefan Weil@findex -daemonize 21725824d651Sblueswir1Daemonize the QEMU process after initialization. QEMU will not detach from 21735824d651Sblueswir1standard IO until it is ready to receive connections on any of its devices. 21745824d651Sblueswir1This option is a useful way for external programs to launch QEMU without having 21755824d651Sblueswir1to cope with initialization race conditions. 21765824d651Sblueswir1ETEXI 21775824d651Sblueswir1 21785824d651Sblueswir1DEF("option-rom", HAS_ARG, QEMU_OPTION_option_rom, \ 2179ad96090aSBlue Swirl "-option-rom rom load a file, rom, into the option ROM space\n", 2180ad96090aSBlue Swirl QEMU_ARCH_ALL) 21815824d651Sblueswir1STEXI 21825824d651Sblueswir1@item -option-rom @var{file} 21836616b2adSStefan Weil@findex -option-rom 21845824d651Sblueswir1Load the contents of @var{file} as an option ROM. 21855824d651Sblueswir1This option is useful to load things like EtherBoot. 21865824d651Sblueswir1ETEXI 21875824d651Sblueswir1 21885824d651Sblueswir1DEF("clock", HAS_ARG, QEMU_OPTION_clock, \ 21895824d651Sblueswir1 "-clock force the use of the given methods for timer alarm.\n" \ 2190ad96090aSBlue Swirl " To see what timers are available use -clock ?\n", 2191ad96090aSBlue Swirl QEMU_ARCH_ALL) 21925824d651Sblueswir1STEXI 21935824d651Sblueswir1@item -clock @var{method} 21946616b2adSStefan Weil@findex -clock 21955824d651Sblueswir1Force the use of the given methods for timer alarm. To see what timers 21965824d651Sblueswir1are available use -clock ?. 21975824d651Sblueswir1ETEXI 21985824d651Sblueswir1 21991ed2fc1fSJan KiszkaHXCOMM Options deprecated by -rtc 2200ad96090aSBlue SwirlDEF("localtime", 0, QEMU_OPTION_localtime, "", QEMU_ARCH_ALL) 2201ad96090aSBlue SwirlDEF("startdate", HAS_ARG, QEMU_OPTION_startdate, "", QEMU_ARCH_ALL) 22025824d651Sblueswir1 22031ed2fc1fSJan KiszkaDEF("rtc", HAS_ARG, QEMU_OPTION_rtc, \ 22046875204cSJan Kiszka "-rtc [base=utc|localtime|date][,clock=host|vm][,driftfix=none|slew]\n" \ 2205ad96090aSBlue Swirl " set the RTC base and clock, enable drift fix for clock ticks (x86 only)\n", 2206ad96090aSBlue Swirl QEMU_ARCH_ALL) 22071ed2fc1fSJan Kiszka 22085824d651Sblueswir1STEXI 22095824d651Sblueswir1 22106875204cSJan Kiszka@item -rtc [base=utc|localtime|@var{date}][,clock=host|vm][,driftfix=none|slew] 22116616b2adSStefan Weil@findex -rtc 22121ed2fc1fSJan KiszkaSpecify @option{base} as @code{utc} or @code{localtime} to let the RTC start at the current 22131ed2fc1fSJan KiszkaUTC or local time, respectively. @code{localtime} is required for correct date in 22141ed2fc1fSJan KiszkaMS-DOS or Windows. To start at a specific point in time, provide @var{date} in the 22151ed2fc1fSJan Kiszkaformat @code{2006-06-17T16:01:21} or @code{2006-06-17}. The default base is UTC. 22161ed2fc1fSJan Kiszka 22176875204cSJan KiszkaBy default the RTC is driven by the host system time. This allows to use the 22186875204cSJan KiszkaRTC as accurate reference clock inside the guest, specifically if the host 22196875204cSJan Kiszkatime is smoothly following an accurate external reference clock, e.g. via NTP. 22206875204cSJan KiszkaIf you want to isolate the guest time from the host, even prevent it from 22216875204cSJan Kiszkaprogressing during suspension, you can set @option{clock} to @code{vm} instead. 22226875204cSJan Kiszka 22231ed2fc1fSJan KiszkaEnable @option{driftfix} (i386 targets only) if you experience time drift problems, 22241ed2fc1fSJan Kiszkaspecifically with Windows' ACPI HAL. This option will try to figure out how 22251ed2fc1fSJan Kiszkamany timer interrupts were not processed by the Windows guest and will 22261ed2fc1fSJan Kiszkare-inject them. 22275824d651Sblueswir1ETEXI 22285824d651Sblueswir1 22295824d651Sblueswir1DEF("icount", HAS_ARG, QEMU_OPTION_icount, \ 22305824d651Sblueswir1 "-icount [N|auto]\n" \ 2231bc14ca24Saliguori " enable virtual instruction counter with 2^N clock ticks per\n" \ 2232ad96090aSBlue Swirl " instruction\n", QEMU_ARCH_ALL) 22335824d651Sblueswir1STEXI 22344e257e5eSKevin Wolf@item -icount [@var{N}|auto] 22356616b2adSStefan Weil@findex -icount 22365824d651Sblueswir1Enable virtual instruction counter. The virtual cpu will execute one 22374e257e5eSKevin Wolfinstruction every 2^@var{N} ns of virtual time. If @code{auto} is specified 22385824d651Sblueswir1then the virtual cpu speed will be automatically adjusted to keep virtual 22395824d651Sblueswir1time within a few seconds of real time. 22405824d651Sblueswir1 22415824d651Sblueswir1Note that while this option can give deterministic behavior, it does not 22425824d651Sblueswir1provide cycle accurate emulation. Modern CPUs contain superscalar out of 22435824d651Sblueswir1order cores with complex cache hierarchies. The number of instructions 22445824d651Sblueswir1executed often has little or no correlation with actual performance. 22455824d651Sblueswir1ETEXI 22465824d651Sblueswir1 22479dd986ccSRichard W.M. JonesDEF("watchdog", HAS_ARG, QEMU_OPTION_watchdog, \ 22489dd986ccSRichard W.M. Jones "-watchdog i6300esb|ib700\n" \ 2249ad96090aSBlue Swirl " enable virtual hardware watchdog [default=none]\n", 2250ad96090aSBlue Swirl QEMU_ARCH_ALL) 22519dd986ccSRichard W.M. JonesSTEXI 22529dd986ccSRichard W.M. Jones@item -watchdog @var{model} 22536616b2adSStefan Weil@findex -watchdog 22549dd986ccSRichard W.M. JonesCreate a virtual hardware watchdog device. Once enabled (by a guest 22559dd986ccSRichard W.M. Jonesaction), the watchdog must be periodically polled by an agent inside 22569dd986ccSRichard W.M. Jonesthe guest or else the guest will be restarted. 22579dd986ccSRichard W.M. Jones 22589dd986ccSRichard W.M. JonesThe @var{model} is the model of hardware watchdog to emulate. Choices 22599dd986ccSRichard W.M. Jonesfor model are: @code{ib700} (iBASE 700) which is a very simple ISA 22609dd986ccSRichard W.M. Joneswatchdog with a single timer, or @code{i6300esb} (Intel 6300ESB I/O 22619dd986ccSRichard W.M. Jonescontroller hub) which is a much more featureful PCI-based dual-timer 22629dd986ccSRichard W.M. Joneswatchdog. Choose a model for which your guest has drivers. 22639dd986ccSRichard W.M. Jones 22649dd986ccSRichard W.M. JonesUse @code{-watchdog ?} to list available hardware models. Only one 22659dd986ccSRichard W.M. Joneswatchdog can be enabled for a guest. 22669dd986ccSRichard W.M. JonesETEXI 22679dd986ccSRichard W.M. Jones 22689dd986ccSRichard W.M. JonesDEF("watchdog-action", HAS_ARG, QEMU_OPTION_watchdog_action, \ 22699dd986ccSRichard W.M. Jones "-watchdog-action reset|shutdown|poweroff|pause|debug|none\n" \ 2270ad96090aSBlue Swirl " action when watchdog fires [default=reset]\n", 2271ad96090aSBlue Swirl QEMU_ARCH_ALL) 22729dd986ccSRichard W.M. JonesSTEXI 22739dd986ccSRichard W.M. Jones@item -watchdog-action @var{action} 22749dd986ccSRichard W.M. Jones 22759dd986ccSRichard W.M. JonesThe @var{action} controls what QEMU will do when the watchdog timer 22769dd986ccSRichard W.M. Jonesexpires. 22779dd986ccSRichard W.M. JonesThe default is 22789dd986ccSRichard W.M. Jones@code{reset} (forcefully reset the guest). 22799dd986ccSRichard W.M. JonesOther possible actions are: 22809dd986ccSRichard W.M. Jones@code{shutdown} (attempt to gracefully shutdown the guest), 22819dd986ccSRichard W.M. Jones@code{poweroff} (forcefully poweroff the guest), 22829dd986ccSRichard W.M. Jones@code{pause} (pause the guest), 22839dd986ccSRichard W.M. Jones@code{debug} (print a debug message and continue), or 22849dd986ccSRichard W.M. Jones@code{none} (do nothing). 22859dd986ccSRichard W.M. Jones 22869dd986ccSRichard W.M. JonesNote that the @code{shutdown} action requires that the guest responds 22879dd986ccSRichard W.M. Jonesto ACPI signals, which it may not be able to do in the sort of 22889dd986ccSRichard W.M. Jonessituations where the watchdog would have expired, and thus 22899dd986ccSRichard W.M. Jones@code{-watchdog-action shutdown} is not recommended for production use. 22909dd986ccSRichard W.M. Jones 22919dd986ccSRichard W.M. JonesExamples: 22929dd986ccSRichard W.M. Jones 22939dd986ccSRichard W.M. Jones@table @code 22949dd986ccSRichard W.M. Jones@item -watchdog i6300esb -watchdog-action pause 22959dd986ccSRichard W.M. Jones@item -watchdog ib700 22969dd986ccSRichard W.M. Jones@end table 22979dd986ccSRichard W.M. JonesETEXI 22989dd986ccSRichard W.M. Jones 22995824d651Sblueswir1DEF("echr", HAS_ARG, QEMU_OPTION_echr, \ 2300ad96090aSBlue Swirl "-echr chr set terminal escape character instead of ctrl-a\n", 2301ad96090aSBlue Swirl QEMU_ARCH_ALL) 23025824d651Sblueswir1STEXI 23035824d651Sblueswir1 23044e257e5eSKevin Wolf@item -echr @var{numeric_ascii_value} 23056616b2adSStefan Weil@findex -echr 23065824d651Sblueswir1Change the escape character used for switching to the monitor when using 23075824d651Sblueswir1monitor and serial sharing. The default is @code{0x01} when using the 23085824d651Sblueswir1@code{-nographic} option. @code{0x01} is equal to pressing 23095824d651Sblueswir1@code{Control-a}. You can select a different character from the ascii 23105824d651Sblueswir1control keys where 1 through 26 map to Control-a through Control-z. For 23115824d651Sblueswir1instance you could use the either of the following to change the escape 23125824d651Sblueswir1character to Control-t. 23135824d651Sblueswir1@table @code 23145824d651Sblueswir1@item -echr 0x14 23155824d651Sblueswir1@item -echr 20 23165824d651Sblueswir1@end table 23175824d651Sblueswir1ETEXI 23185824d651Sblueswir1 23195824d651Sblueswir1DEF("virtioconsole", HAS_ARG, QEMU_OPTION_virtiocon, \ 23205824d651Sblueswir1 "-virtioconsole c\n" \ 2321ad96090aSBlue Swirl " set virtio console\n", QEMU_ARCH_ALL) 23225824d651Sblueswir1STEXI 23235824d651Sblueswir1@item -virtioconsole @var{c} 23246616b2adSStefan Weil@findex -virtioconsole 23255824d651Sblueswir1Set virtio console. 232698b19252SAmit Shah 232798b19252SAmit ShahThis option is maintained for backward compatibility. 232898b19252SAmit Shah 232998b19252SAmit ShahPlease use @code{-device virtconsole} for the new way of invocation. 23305824d651Sblueswir1ETEXI 23315824d651Sblueswir1 23325824d651Sblueswir1DEF("show-cursor", 0, QEMU_OPTION_show_cursor, \ 2333ad96090aSBlue Swirl "-show-cursor show cursor\n", QEMU_ARCH_ALL) 23345824d651Sblueswir1STEXI 233595d5f08bSStefan Weil@item -show-cursor 23366616b2adSStefan Weil@findex -show-cursor 233795d5f08bSStefan WeilShow cursor. 23385824d651Sblueswir1ETEXI 23395824d651Sblueswir1 23405824d651Sblueswir1DEF("tb-size", HAS_ARG, QEMU_OPTION_tb_size, \ 2341ad96090aSBlue Swirl "-tb-size n set TB size\n", QEMU_ARCH_ALL) 23425824d651Sblueswir1STEXI 234395d5f08bSStefan Weil@item -tb-size @var{n} 23446616b2adSStefan Weil@findex -tb-size 234595d5f08bSStefan WeilSet TB size. 23465824d651Sblueswir1ETEXI 23475824d651Sblueswir1 23485824d651Sblueswir1DEF("incoming", HAS_ARG, QEMU_OPTION_incoming, \ 2349ad96090aSBlue Swirl "-incoming p prepare for incoming migration, listen on port p\n", 2350ad96090aSBlue Swirl QEMU_ARCH_ALL) 23515824d651Sblueswir1STEXI 235295d5f08bSStefan Weil@item -incoming @var{port} 23536616b2adSStefan Weil@findex -incoming 235495d5f08bSStefan WeilPrepare for incoming migration, listen on @var{port}. 23555824d651Sblueswir1ETEXI 23565824d651Sblueswir1 2357d8c208ddSGerd HoffmannDEF("nodefaults", 0, QEMU_OPTION_nodefaults, \ 2358ad96090aSBlue Swirl "-nodefaults don't create default devices\n", QEMU_ARCH_ALL) 2359d8c208ddSGerd HoffmannSTEXI 23603dbf2c7fSStefan Weil@item -nodefaults 23616616b2adSStefan Weil@findex -nodefaults 23623dbf2c7fSStefan WeilDon't create default devices. 2363d8c208ddSGerd HoffmannETEXI 2364d8c208ddSGerd Hoffmann 23655824d651Sblueswir1#ifndef _WIN32 23665824d651Sblueswir1DEF("chroot", HAS_ARG, QEMU_OPTION_chroot, \ 2367ad96090aSBlue Swirl "-chroot dir chroot to dir just before starting the VM\n", 2368ad96090aSBlue Swirl QEMU_ARCH_ALL) 23695824d651Sblueswir1#endif 23705824d651Sblueswir1STEXI 23714e257e5eSKevin Wolf@item -chroot @var{dir} 23726616b2adSStefan Weil@findex -chroot 23735824d651Sblueswir1Immediately before starting guest execution, chroot to the specified 23745824d651Sblueswir1directory. Especially useful in combination with -runas. 23755824d651Sblueswir1ETEXI 23765824d651Sblueswir1 23775824d651Sblueswir1#ifndef _WIN32 23785824d651Sblueswir1DEF("runas", HAS_ARG, QEMU_OPTION_runas, \ 2379ad96090aSBlue Swirl "-runas user change to user id user just before starting the VM\n", 2380ad96090aSBlue Swirl QEMU_ARCH_ALL) 23815824d651Sblueswir1#endif 23825824d651Sblueswir1STEXI 23834e257e5eSKevin Wolf@item -runas @var{user} 23846616b2adSStefan Weil@findex -runas 23855824d651Sblueswir1Immediately before starting guest execution, drop root privileges, switching 23865824d651Sblueswir1to the specified user. 23875824d651Sblueswir1ETEXI 23885824d651Sblueswir1 23895824d651Sblueswir1DEF("prom-env", HAS_ARG, QEMU_OPTION_prom_env, 23905824d651Sblueswir1 "-prom-env variable=value\n" 2391ad96090aSBlue Swirl " set OpenBIOS nvram variables\n", 2392ad96090aSBlue Swirl QEMU_ARCH_PPC | QEMU_ARCH_SPARC) 239395d5f08bSStefan WeilSTEXI 239495d5f08bSStefan Weil@item -prom-env @var{variable}=@var{value} 23956616b2adSStefan Weil@findex -prom-env 239695d5f08bSStefan WeilSet OpenBIOS nvram @var{variable} to given @var{value} (PPC, SPARC only). 239795d5f08bSStefan WeilETEXI 23985824d651Sblueswir1DEF("semihosting", 0, QEMU_OPTION_semihosting, 2399ad96090aSBlue Swirl "-semihosting semihosting mode\n", QEMU_ARCH_ARM | QEMU_ARCH_M68K) 240095d5f08bSStefan WeilSTEXI 240195d5f08bSStefan Weil@item -semihosting 24026616b2adSStefan Weil@findex -semihosting 240395d5f08bSStefan WeilSemihosting mode (ARM, M68K only). 240495d5f08bSStefan WeilETEXI 24055824d651Sblueswir1DEF("old-param", 0, QEMU_OPTION_old_param, 2406ad96090aSBlue Swirl "-old-param old param mode\n", QEMU_ARCH_ARM) 240795d5f08bSStefan WeilSTEXI 240895d5f08bSStefan Weil@item -old-param 24096616b2adSStefan Weil@findex -old-param (ARM) 241095d5f08bSStefan WeilOld param mode (ARM only). 241195d5f08bSStefan WeilETEXI 241295d5f08bSStefan Weil 2413715a664aSGerd HoffmannDEF("readconfig", HAS_ARG, QEMU_OPTION_readconfig, 2414ad96090aSBlue Swirl "-readconfig <file>\n", QEMU_ARCH_ALL) 24153dbf2c7fSStefan WeilSTEXI 24163dbf2c7fSStefan Weil@item -readconfig @var{file} 24176616b2adSStefan Weil@findex -readconfig 24183dbf2c7fSStefan WeilRead device configuration from @var{file}. 24193dbf2c7fSStefan WeilETEXI 2420715a664aSGerd HoffmannDEF("writeconfig", HAS_ARG, QEMU_OPTION_writeconfig, 2421715a664aSGerd Hoffmann "-writeconfig <file>\n" 2422ad96090aSBlue Swirl " read/write config file\n", QEMU_ARCH_ALL) 24233dbf2c7fSStefan WeilSTEXI 24243dbf2c7fSStefan Weil@item -writeconfig @var{file} 24256616b2adSStefan Weil@findex -writeconfig 24263dbf2c7fSStefan WeilWrite device configuration to @var{file}. 24273dbf2c7fSStefan WeilETEXI 2428292444cbSAnthony LiguoriDEF("nodefconfig", 0, QEMU_OPTION_nodefconfig, 2429292444cbSAnthony Liguori "-nodefconfig\n" 2430ad96090aSBlue Swirl " do not load default config files at startup\n", 2431ad96090aSBlue Swirl QEMU_ARCH_ALL) 2432292444cbSAnthony LiguoriSTEXI 2433292444cbSAnthony Liguori@item -nodefconfig 24346616b2adSStefan Weil@findex -nodefconfig 2435292444cbSAnthony LiguoriNormally QEMU loads a configuration file from @var{sysconfdir}/qemu.conf and 2436292444cbSAnthony Liguori@var{sysconfdir}/target-@var{ARCH}.conf on startup. The @code{-nodefconfig} 2437292444cbSAnthony Liguorioption will prevent QEMU from loading these configuration files at startup. 2438292444cbSAnthony LiguoriETEXI 2439ab6540d5SPrerna Saxena#ifdef CONFIG_SIMPLE_TRACE 2440ab6540d5SPrerna SaxenaDEF("trace", HAS_ARG, QEMU_OPTION_trace, 2441ab6540d5SPrerna Saxena "-trace\n" 2442ab6540d5SPrerna Saxena " Specify a trace file to log traces to\n", 2443ab6540d5SPrerna Saxena QEMU_ARCH_ALL) 2444ab6540d5SPrerna SaxenaSTEXI 2445ab6540d5SPrerna Saxena@item -trace 2446ab6540d5SPrerna Saxena@findex -trace 2447ab6540d5SPrerna SaxenaSpecify a trace file to log output traces to. 2448ab6540d5SPrerna SaxenaETEXI 2449ab6540d5SPrerna Saxena#endif 24503dbf2c7fSStefan Weil 24513dbf2c7fSStefan WeilHXCOMM This is the last statement. Insert new options before this line! 24523dbf2c7fSStefan WeilSTEXI 24533dbf2c7fSStefan Weil@end table 24543dbf2c7fSStefan WeilETEXI 2455