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" 13692196b2fSStefan 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} 16792196b2fSStefan 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 20292196b2fSStefan HajnocziThe host page cache can be avoided while only sending write notifications to 20392196b2fSStefan Hajnoczithe guest when the data has been reported as written by the storage subsystem 20492196b2fSStefan Hajnocziusing @option{cache=directsync}. 20592196b2fSStefan 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 5257c92a3d2SAneesh Kumar K.VDEFHEADING() 5267c92a3d2SAneesh Kumar K.V 52774db920cSGautham R ShenoyDEFHEADING(File system options:) 52874db920cSGautham R Shenoy 52974db920cSGautham R ShenoyDEF("fsdev", HAS_ARG, QEMU_OPTION_fsdev, 530d9b36a6eSM. Mohan Kumar "-fsdev fsdriver,id=id,path=path,[security_model={mapped|passthrough|none}]\n" 531*2c74c2cbSM. Mohan Kumar " [,writeout=immediate][,readonly]\n", 53274db920cSGautham R Shenoy QEMU_ARCH_ALL) 53374db920cSGautham R Shenoy 53474db920cSGautham R ShenoySTEXI 53574db920cSGautham R Shenoy 536*2c74c2cbSM. Mohan Kumar@item -fsdev @var{fsdriver},id=@var{id},path=@var{path},[security_model=@var{security_model}][,writeout=@var{writeout}][,readonly] 53774db920cSGautham R Shenoy@findex -fsdev 5387c92a3d2SAneesh Kumar K.VDefine a new file system device. Valid options are: 5397c92a3d2SAneesh Kumar K.V@table @option 5407c92a3d2SAneesh Kumar K.V@item @var{fsdriver} 5417c92a3d2SAneesh Kumar K.VThis option specifies the fs driver backend to use. 5427c92a3d2SAneesh Kumar K.VCurrently "local" and "handle" file system drivers are supported. 5437c92a3d2SAneesh Kumar K.V@item id=@var{id} 5447c92a3d2SAneesh Kumar K.VSpecifies identifier for this device 5457c92a3d2SAneesh Kumar K.V@item path=@var{path} 5467c92a3d2SAneesh Kumar K.VSpecifies the export path for the file system device. Files under 5477c92a3d2SAneesh Kumar K.Vthis path will be available to the 9p client on the guest. 5487c92a3d2SAneesh Kumar K.V@item security_model=@var{security_model} 5497c92a3d2SAneesh Kumar K.VSpecifies the security model to be used for this export path. 5507c92a3d2SAneesh Kumar K.VSupported security models are "passthrough", "mapped" and "none". 5517c92a3d2SAneesh Kumar K.VIn "passthrough" security model, files are stored using the same 5527c92a3d2SAneesh Kumar K.Vcredentials as they are created on the guest. This requires qemu 5537c92a3d2SAneesh Kumar K.Vto run as root. In "mapped" security model, some of the file 5547c92a3d2SAneesh Kumar K.Vattributes like uid, gid, mode bits and link target are stored as 5557c92a3d2SAneesh Kumar K.Vfile attributes. Directories exported by this security model cannot 5567c92a3d2SAneesh Kumar K.Vinteract with other unix tools. "none" security model is same as 5577c92a3d2SAneesh Kumar K.Vpassthrough except the sever won't report failures if it fails to 558d9b36a6eSM. Mohan Kumarset file attributes like ownership. Security model is mandatory 559d9b36a6eSM. Mohan Kumaronly for local fsdriver. Other fsdrivers (like handle) don't take 560d9b36a6eSM. Mohan Kumarsecurity model as a parameter. 5617c92a3d2SAneesh Kumar K.V@item writeout=@var{writeout} 5627c92a3d2SAneesh Kumar K.VThis is an optional argument. The only supported value is "immediate". 5637c92a3d2SAneesh Kumar K.VThis means that host page cache will be used to read and write data but 5647c92a3d2SAneesh Kumar K.Vwrite notification will be sent to the guest only when the data has been 5657c92a3d2SAneesh Kumar K.Vreported as written by the storage subsystem. 566*2c74c2cbSM. Mohan Kumar@item readonly 567*2c74c2cbSM. Mohan KumarEnables exporting 9p share as a readonly mount for guests. By default 568*2c74c2cbSM. Mohan Kumarread-write access is given. 56974db920cSGautham R Shenoy@end table 5707c92a3d2SAneesh Kumar K.V 5717c92a3d2SAneesh Kumar K.V-fsdev option is used along with -device driver "virtio-9p-pci". 5727c92a3d2SAneesh Kumar K.V@item -device virtio-9p-pci,fsdev=@var{id},mount_tag=@var{mount_tag} 5737c92a3d2SAneesh Kumar K.VOptions for virtio-9p-pci driver are: 5747c92a3d2SAneesh Kumar K.V@table @option 5757c92a3d2SAneesh Kumar K.V@item fsdev=@var{id} 5767c92a3d2SAneesh Kumar K.VSpecifies the id value specified along with -fsdev option 5777c92a3d2SAneesh Kumar K.V@item mount_tag=@var{mount_tag} 5787c92a3d2SAneesh Kumar K.VSpecifies the tag name to be used by the guest to mount this export point 5797c92a3d2SAneesh Kumar K.V@end table 5807c92a3d2SAneesh Kumar K.V 58174db920cSGautham R ShenoyETEXI 58274db920cSGautham R Shenoy 5837c92a3d2SAneesh Kumar K.VDEFHEADING() 5847c92a3d2SAneesh Kumar K.V 5853d54abc7SGautham R ShenoyDEFHEADING(Virtual File system pass-through options:) 5863d54abc7SGautham R Shenoy 5873d54abc7SGautham R ShenoyDEF("virtfs", HAS_ARG, QEMU_OPTION_virtfs, 588d3ab98e6SAneesh Kumar K.V "-virtfs local,path=path,mount_tag=tag,security_model=[mapped|passthrough|none]\n" 589*2c74c2cbSM. Mohan Kumar " [,writeout=immediate][,readonly]\n", 5903d54abc7SGautham R Shenoy QEMU_ARCH_ALL) 5913d54abc7SGautham R Shenoy 5923d54abc7SGautham R ShenoySTEXI 5933d54abc7SGautham R Shenoy 594*2c74c2cbSM. Mohan Kumar@item -virtfs @var{fsdriver},path=@var{path},mount_tag=@var{mount_tag},security_model=@var{security_model}[,writeout=@var{writeout}][,readonly] 5953d54abc7SGautham R Shenoy@findex -virtfs 5963d54abc7SGautham R Shenoy 5977c92a3d2SAneesh Kumar K.VThe general form of a Virtual File system pass-through options are: 5987c92a3d2SAneesh Kumar K.V@table @option 5997c92a3d2SAneesh Kumar K.V@item @var{fsdriver} 6007c92a3d2SAneesh Kumar K.VThis option specifies the fs driver backend to use. 6017c92a3d2SAneesh Kumar K.VCurrently "local" and "handle" file system drivers are supported. 6027c92a3d2SAneesh Kumar K.V@item id=@var{id} 6037c92a3d2SAneesh Kumar K.VSpecifies identifier for this device 6047c92a3d2SAneesh Kumar K.V@item path=@var{path} 6057c92a3d2SAneesh Kumar K.VSpecifies the export path for the file system device. Files under 6067c92a3d2SAneesh Kumar K.Vthis path will be available to the 9p client on the guest. 6077c92a3d2SAneesh Kumar K.V@item security_model=@var{security_model} 6087c92a3d2SAneesh Kumar K.VSpecifies the security model to be used for this export path. 6097c92a3d2SAneesh Kumar K.VSupported security models are "passthrough", "mapped" and "none". 6107c92a3d2SAneesh Kumar K.VIn "passthrough" security model, files are stored using the same 6117c92a3d2SAneesh Kumar K.Vcredentials as they are created on the guest. This requires qemu 6127c92a3d2SAneesh Kumar K.Vto run as root. In "mapped" security model, some of the file 6137c92a3d2SAneesh Kumar K.Vattributes like uid, gid, mode bits and link target are stored as 6147c92a3d2SAneesh Kumar K.Vfile attributes. Directories exported by this security model cannot 6157c92a3d2SAneesh Kumar K.Vinteract with other unix tools. "none" security model is same as 6167c92a3d2SAneesh Kumar K.Vpassthrough except the sever won't report failures if it fails to 617d9b36a6eSM. Mohan Kumarset file attributes like ownership. Security model is mandatory only 618d9b36a6eSM. Mohan Kumarfor local fsdriver. Other fsdrivers (like handle) don't take security 619d9b36a6eSM. Mohan Kumarmodel as a parameter. 6207c92a3d2SAneesh Kumar K.V@item writeout=@var{writeout} 6217c92a3d2SAneesh Kumar K.VThis is an optional argument. The only supported value is "immediate". 6227c92a3d2SAneesh Kumar K.VThis means that host page cache will be used to read and write data but 6237c92a3d2SAneesh Kumar K.Vwrite notification will be sent to the guest only when the data has been 6247c92a3d2SAneesh Kumar K.Vreported as written by the storage subsystem. 625*2c74c2cbSM. Mohan Kumar@item readonly 626*2c74c2cbSM. Mohan KumarEnables exporting 9p share as a readonly mount for guests. By default 627*2c74c2cbSM. Mohan Kumarread-write access is given. 6283d54abc7SGautham R Shenoy@end table 6293d54abc7SGautham R ShenoyETEXI 6303d54abc7SGautham R Shenoy 63174db920cSGautham R ShenoyDEFHEADING() 63274db920cSGautham R Shenoy 6335824d651Sblueswir1DEF("name", HAS_ARG, QEMU_OPTION_name, 634ca1a8a06SBruce Rogers "-name string1[,process=string2]\n" 635ca1a8a06SBruce Rogers " set the name of the guest\n" 636ad96090aSBlue Swirl " string1 sets the window title and string2 the process name (on Linux)\n", 637ad96090aSBlue Swirl QEMU_ARCH_ALL) 6385824d651Sblueswir1STEXI 6395824d651Sblueswir1@item -name @var{name} 6406616b2adSStefan Weil@findex -name 6415824d651Sblueswir1Sets the @var{name} of the guest. 6425824d651Sblueswir1This name will be displayed in the SDL window caption. 6435824d651Sblueswir1The @var{name} will also be used for the VNC server. 6441889465aSAndi KleenAlso optionally set the top visible process name in Linux. 6455824d651Sblueswir1ETEXI 6465824d651Sblueswir1 6475824d651Sblueswir1DEF("uuid", HAS_ARG, QEMU_OPTION_uuid, 648e8105ebbSPaolo Bonzini "-uuid %08x-%04x-%04x-%04x-%012x\n" 649ad96090aSBlue Swirl " specify machine UUID\n", QEMU_ARCH_ALL) 6505824d651Sblueswir1STEXI 6515824d651Sblueswir1@item -uuid @var{uuid} 6526616b2adSStefan Weil@findex -uuid 6535824d651Sblueswir1Set system UUID. 6545824d651Sblueswir1ETEXI 6555824d651Sblueswir1 6565824d651Sblueswir1STEXI 6575824d651Sblueswir1@end table 6585824d651Sblueswir1ETEXI 6595824d651Sblueswir1 6605824d651Sblueswir1DEFHEADING() 6615824d651Sblueswir1 6625824d651Sblueswir1DEFHEADING(Display options:) 6635824d651Sblueswir1 6645824d651Sblueswir1STEXI 6655824d651Sblueswir1@table @option 6665824d651Sblueswir1ETEXI 6675824d651Sblueswir1 6681472a95bSJes SorensenDEF("display", HAS_ARG, QEMU_OPTION_display, 6691472a95bSJes Sorensen "-display sdl[,frame=on|off][,alt_grab=on|off][,ctrl_grab=on|off]\n" 6703264ff12SJes Sorensen " [,window_close=on|off]|curses|none|\n" 6713264ff12SJes Sorensen " vnc=<display>[,<optargs>]\n" 6721472a95bSJes Sorensen " select display type\n", QEMU_ARCH_ALL) 6731472a95bSJes SorensenSTEXI 6741472a95bSJes Sorensen@item -display @var{type} 6751472a95bSJes Sorensen@findex -display 6761472a95bSJes SorensenSelect type of display to use. This option is a replacement for the 6771472a95bSJes Sorensenold style -sdl/-curses/... options. Valid values for @var{type} are 6781472a95bSJes Sorensen@table @option 6791472a95bSJes Sorensen@item sdl 6801472a95bSJes SorensenDisplay video output via SDL (usually in a separate graphics 6811472a95bSJes Sorensenwindow; see the SDL documentation for other possibilities). 6821472a95bSJes Sorensen@item curses 6831472a95bSJes SorensenDisplay video output via curses. For graphics device models which 6841472a95bSJes Sorensensupport a text mode, QEMU can display this output using a 6851472a95bSJes Sorensencurses/ncurses interface. Nothing is displayed when the graphics 6861472a95bSJes Sorensendevice is in graphical mode or if the graphics device does not support 6871472a95bSJes Sorensena text mode. Generally only the VGA device models support text mode. 6884171d32eSJes Sorensen@item none 6894171d32eSJes SorensenDo not display video output. The guest will still see an emulated 6904171d32eSJes Sorensengraphics card, but its output will not be displayed to the QEMU 6914171d32eSJes Sorensenuser. This option differs from the -nographic option in that it 6924171d32eSJes Sorensenonly affects what is done with video output; -nographic also changes 6934171d32eSJes Sorensenthe destination of the serial and parallel port data. 6943264ff12SJes Sorensen@item vnc 6953264ff12SJes SorensenStart a VNC server on display <arg> 6961472a95bSJes Sorensen@end table 6971472a95bSJes SorensenETEXI 6981472a95bSJes Sorensen 6995824d651Sblueswir1DEF("nographic", 0, QEMU_OPTION_nographic, 700ad96090aSBlue Swirl "-nographic disable graphical output and redirect serial I/Os to console\n", 701ad96090aSBlue Swirl QEMU_ARCH_ALL) 7025824d651Sblueswir1STEXI 7035824d651Sblueswir1@item -nographic 7046616b2adSStefan Weil@findex -nographic 7055824d651Sblueswir1Normally, QEMU uses SDL to display the VGA output. With this option, 7065824d651Sblueswir1you can totally disable graphical output so that QEMU is a simple 7075824d651Sblueswir1command line application. The emulated serial port is redirected on 7085824d651Sblueswir1the console. Therefore, you can still use QEMU to debug a Linux kernel 7095824d651Sblueswir1with a serial console. 7105824d651Sblueswir1ETEXI 7115824d651Sblueswir1 7125824d651Sblueswir1DEF("curses", 0, QEMU_OPTION_curses, 713ad96090aSBlue Swirl "-curses use a curses/ncurses interface instead of SDL\n", 714ad96090aSBlue Swirl QEMU_ARCH_ALL) 7155824d651Sblueswir1STEXI 7165824d651Sblueswir1@item -curses 7176616b2adSStefan Weil@findex curses 7185824d651Sblueswir1Normally, QEMU uses SDL to display the VGA output. With this option, 7195824d651Sblueswir1QEMU can display the VGA output when in text mode using a 7205824d651Sblueswir1curses/ncurses interface. Nothing is displayed in graphical mode. 7215824d651Sblueswir1ETEXI 7225824d651Sblueswir1 7235824d651Sblueswir1DEF("no-frame", 0, QEMU_OPTION_no_frame, 724ad96090aSBlue Swirl "-no-frame open SDL window without a frame and window decorations\n", 725ad96090aSBlue Swirl QEMU_ARCH_ALL) 7265824d651Sblueswir1STEXI 7275824d651Sblueswir1@item -no-frame 7286616b2adSStefan Weil@findex -no-frame 7295824d651Sblueswir1Do not use decorations for SDL windows and start them using the whole 7305824d651Sblueswir1available screen space. This makes the using QEMU in a dedicated desktop 7315824d651Sblueswir1workspace more convenient. 7325824d651Sblueswir1ETEXI 7335824d651Sblueswir1 7345824d651Sblueswir1DEF("alt-grab", 0, QEMU_OPTION_alt_grab, 735ad96090aSBlue Swirl "-alt-grab use Ctrl-Alt-Shift to grab mouse (instead of Ctrl-Alt)\n", 736ad96090aSBlue Swirl QEMU_ARCH_ALL) 7375824d651Sblueswir1STEXI 7385824d651Sblueswir1@item -alt-grab 7396616b2adSStefan Weil@findex -alt-grab 740de1db2a1SBrad HardsUse Ctrl-Alt-Shift to grab mouse (instead of Ctrl-Alt). Note that this also 741de1db2a1SBrad Hardsaffects the special keys (for fullscreen, monitor-mode switching, etc). 7425824d651Sblueswir1ETEXI 7435824d651Sblueswir1 7440ca9f8a4SDustin KirklandDEF("ctrl-grab", 0, QEMU_OPTION_ctrl_grab, 745ad96090aSBlue Swirl "-ctrl-grab use Right-Ctrl to grab mouse (instead of Ctrl-Alt)\n", 746ad96090aSBlue Swirl QEMU_ARCH_ALL) 7470ca9f8a4SDustin KirklandSTEXI 7480ca9f8a4SDustin Kirkland@item -ctrl-grab 7496616b2adSStefan Weil@findex -ctrl-grab 750de1db2a1SBrad HardsUse Right-Ctrl to grab mouse (instead of Ctrl-Alt). Note that this also 751de1db2a1SBrad Hardsaffects the special keys (for fullscreen, monitor-mode switching, etc). 7520ca9f8a4SDustin KirklandETEXI 7530ca9f8a4SDustin Kirkland 7545824d651Sblueswir1DEF("no-quit", 0, QEMU_OPTION_no_quit, 755ad96090aSBlue Swirl "-no-quit disable SDL window close capability\n", QEMU_ARCH_ALL) 7565824d651Sblueswir1STEXI 7575824d651Sblueswir1@item -no-quit 7586616b2adSStefan Weil@findex -no-quit 7595824d651Sblueswir1Disable SDL window close capability. 7605824d651Sblueswir1ETEXI 7615824d651Sblueswir1 7625824d651Sblueswir1DEF("sdl", 0, QEMU_OPTION_sdl, 763ad96090aSBlue Swirl "-sdl enable SDL\n", QEMU_ARCH_ALL) 7645824d651Sblueswir1STEXI 7655824d651Sblueswir1@item -sdl 7666616b2adSStefan Weil@findex -sdl 7675824d651Sblueswir1Enable SDL. 7685824d651Sblueswir1ETEXI 7695824d651Sblueswir1 77029b0040bSGerd HoffmannDEF("spice", HAS_ARG, QEMU_OPTION_spice, 77129b0040bSGerd Hoffmann "-spice <args> enable spice\n", QEMU_ARCH_ALL) 77229b0040bSGerd HoffmannSTEXI 77329b0040bSGerd Hoffmann@item -spice @var{option}[,@var{option}[,...]] 77429b0040bSGerd Hoffmann@findex -spice 77529b0040bSGerd HoffmannEnable the spice remote desktop protocol. Valid options are 77629b0040bSGerd Hoffmann 77729b0040bSGerd Hoffmann@table @option 77829b0040bSGerd Hoffmann 77929b0040bSGerd Hoffmann@item port=<nr> 780c448e855SGerd HoffmannSet the TCP port spice is listening on for plaintext channels. 78129b0040bSGerd Hoffmann 782333b0eebSGerd Hoffmann@item addr=<addr> 783333b0eebSGerd HoffmannSet the IP address spice is listening on. Default is any address. 784333b0eebSGerd Hoffmann 785333b0eebSGerd Hoffmann@item ipv4 786333b0eebSGerd Hoffmann@item ipv6 787333b0eebSGerd HoffmannForce using the specified IP version. 788333b0eebSGerd Hoffmann 78929b0040bSGerd Hoffmann@item password=<secret> 79029b0040bSGerd HoffmannSet the password you need to authenticate. 79129b0040bSGerd Hoffmann 79248b3ed0aSMarc-André Lureau@item sasl 79348b3ed0aSMarc-André LureauRequire that the client use SASL to authenticate with the spice. 79448b3ed0aSMarc-André LureauThe exact choice of authentication method used is controlled from the 79548b3ed0aSMarc-André Lureausystem / user's SASL configuration file for the 'qemu' service. This 79648b3ed0aSMarc-André Lureauis typically found in /etc/sasl2/qemu.conf. If running QEMU as an 79748b3ed0aSMarc-André Lureauunprivileged user, an environment variable SASL_CONF_PATH can be used 79848b3ed0aSMarc-André Lureauto make it search alternate locations for the service config. 79948b3ed0aSMarc-André LureauWhile some SASL auth methods can also provide data encryption (eg GSSAPI), 80048b3ed0aSMarc-André Lureauit is recommended that SASL always be combined with the 'tls' and 80148b3ed0aSMarc-André Lureau'x509' settings to enable use of SSL and server certificates. This 80248b3ed0aSMarc-André Lureauensures a data encryption preventing compromise of authentication 80348b3ed0aSMarc-André Lureaucredentials. 80448b3ed0aSMarc-André Lureau 80529b0040bSGerd Hoffmann@item disable-ticketing 80629b0040bSGerd HoffmannAllow client connects without authentication. 80729b0040bSGerd Hoffmann 808d4970b07SHans de Goede@item disable-copy-paste 809d4970b07SHans de GoedeDisable copy paste between the client and the guest. 810d4970b07SHans de Goede 811c448e855SGerd Hoffmann@item tls-port=<nr> 812c448e855SGerd HoffmannSet the TCP port spice is listening on for encrypted channels. 813c448e855SGerd Hoffmann 814c448e855SGerd Hoffmann@item x509-dir=<dir> 815c448e855SGerd HoffmannSet the x509 file directory. Expects same filenames as -vnc $display,x509=$dir 816c448e855SGerd Hoffmann 817c448e855SGerd Hoffmann@item x509-key-file=<file> 818c448e855SGerd Hoffmann@item x509-key-password=<file> 819c448e855SGerd Hoffmann@item x509-cert-file=<file> 820c448e855SGerd Hoffmann@item x509-cacert-file=<file> 821c448e855SGerd Hoffmann@item x509-dh-key-file=<file> 822c448e855SGerd HoffmannThe x509 file names can also be configured individually. 823c448e855SGerd Hoffmann 824c448e855SGerd Hoffmann@item tls-ciphers=<list> 825c448e855SGerd HoffmannSpecify which ciphers to use. 826c448e855SGerd Hoffmann 82717b6dea0SGerd Hoffmann@item tls-channel=[main|display|inputs|record|playback|tunnel] 82817b6dea0SGerd Hoffmann@item plaintext-channel=[main|display|inputs|record|playback|tunnel] 82917b6dea0SGerd HoffmannForce specific channel to be used with or without TLS encryption. The 83017b6dea0SGerd Hoffmannoptions can be specified multiple times to configure multiple 83117b6dea0SGerd Hoffmannchannels. The special name "default" can be used to set the default 83217b6dea0SGerd Hoffmannmode. For channels which are not explicitly forced into one mode the 83317b6dea0SGerd Hoffmannspice client is allowed to pick tls/plaintext as he pleases. 83417b6dea0SGerd Hoffmann 8359f04e09eSYonit Halperin@item image-compression=[auto_glz|auto_lz|quic|glz|lz|off] 8369f04e09eSYonit HalperinConfigure image compression (lossless). 8379f04e09eSYonit HalperinDefault is auto_glz. 8389f04e09eSYonit Halperin 8399f04e09eSYonit Halperin@item jpeg-wan-compression=[auto|never|always] 8409f04e09eSYonit Halperin@item zlib-glz-wan-compression=[auto|never|always] 8419f04e09eSYonit HalperinConfigure wan image compression (lossy for slow links). 8429f04e09eSYonit HalperinDefault is auto. 8439f04e09eSYonit Halperin 84484a23f25SGerd Hoffmann@item streaming-video=[off|all|filter] 84584a23f25SGerd HoffmannConfigure video stream detection. Default is filter. 84684a23f25SGerd Hoffmann 84784a23f25SGerd Hoffmann@item agent-mouse=[on|off] 84884a23f25SGerd HoffmannEnable/disable passing mouse events via vdagent. Default is on. 84984a23f25SGerd Hoffmann 85084a23f25SGerd Hoffmann@item playback-compression=[on|off] 85184a23f25SGerd HoffmannEnable/disable audio stream compression (using celt 0.5.1). Default is on. 85284a23f25SGerd Hoffmann 85329b0040bSGerd Hoffmann@end table 85429b0040bSGerd HoffmannETEXI 85529b0040bSGerd Hoffmann 8565824d651Sblueswir1DEF("portrait", 0, QEMU_OPTION_portrait, 857ad96090aSBlue Swirl "-portrait rotate graphical output 90 deg left (only PXA LCD)\n", 858ad96090aSBlue Swirl QEMU_ARCH_ALL) 8595824d651Sblueswir1STEXI 8605824d651Sblueswir1@item -portrait 8616616b2adSStefan Weil@findex -portrait 8625824d651Sblueswir1Rotate graphical output 90 deg left (only PXA LCD). 8635824d651Sblueswir1ETEXI 8645824d651Sblueswir1 8659312805dSVasily KhoruzhickDEF("rotate", HAS_ARG, QEMU_OPTION_rotate, 8669312805dSVasily Khoruzhick "-rotate <deg> rotate graphical output some deg left (only PXA LCD)\n", 8679312805dSVasily Khoruzhick QEMU_ARCH_ALL) 8689312805dSVasily KhoruzhickSTEXI 8699312805dSVasily Khoruzhick@item -rotate 8709312805dSVasily Khoruzhick@findex -rotate 8719312805dSVasily KhoruzhickRotate graphical output some deg left (only PXA LCD). 8729312805dSVasily KhoruzhickETEXI 8739312805dSVasily Khoruzhick 8745824d651Sblueswir1DEF("vga", HAS_ARG, QEMU_OPTION_vga, 875a19cbfb3SGerd Hoffmann "-vga [std|cirrus|vmware|qxl|xenfb|none]\n" 876ad96090aSBlue Swirl " select video card type\n", QEMU_ARCH_ALL) 8775824d651Sblueswir1STEXI 8785824d651Sblueswir1@item -vga @var{type} 8796616b2adSStefan Weil@findex -vga 8805824d651Sblueswir1Select type of VGA card to emulate. Valid values for @var{type} are 881b3f046c2SKevin Wolf@table @option 8825824d651Sblueswir1@item cirrus 8835824d651Sblueswir1Cirrus Logic GD5446 Video card. All Windows versions starting from 8845824d651Sblueswir1Windows 95 should recognize and use this graphic card. For optimal 8855824d651Sblueswir1performances, use 16 bit color depth in the guest and the host OS. 8865824d651Sblueswir1(This one is the default) 8875824d651Sblueswir1@item std 8885824d651Sblueswir1Standard VGA card with Bochs VBE extensions. If your guest OS 8895824d651Sblueswir1supports the VESA 2.0 VBE extensions (e.g. Windows XP) and if you want 8905824d651Sblueswir1to use high resolution modes (>= 1280x1024x16) then you should use 8915824d651Sblueswir1this option. 8925824d651Sblueswir1@item vmware 8935824d651Sblueswir1VMWare SVGA-II compatible adapter. Use it if you have sufficiently 8945824d651Sblueswir1recent XFree86/XOrg server or Windows guest with a driver for this 8955824d651Sblueswir1card. 896a19cbfb3SGerd Hoffmann@item qxl 897a19cbfb3SGerd HoffmannQXL paravirtual graphic card. It is VGA compatible (including VESA 898a19cbfb3SGerd Hoffmann2.0 VBE support). Works best with qxl guest drivers installed though. 899a19cbfb3SGerd HoffmannRecommended choice when using the spice protocol. 9005824d651Sblueswir1@item none 9015824d651Sblueswir1Disable VGA card. 9025824d651Sblueswir1@end table 9035824d651Sblueswir1ETEXI 9045824d651Sblueswir1 9055824d651Sblueswir1DEF("full-screen", 0, QEMU_OPTION_full_screen, 906ad96090aSBlue Swirl "-full-screen start in full screen\n", QEMU_ARCH_ALL) 9075824d651Sblueswir1STEXI 9085824d651Sblueswir1@item -full-screen 9096616b2adSStefan Weil@findex -full-screen 9105824d651Sblueswir1Start in full screen. 9115824d651Sblueswir1ETEXI 9125824d651Sblueswir1 9135824d651Sblueswir1DEF("g", 1, QEMU_OPTION_g , 914ad96090aSBlue Swirl "-g WxH[xDEPTH] Set the initial graphical resolution and depth\n", 915ad96090aSBlue Swirl QEMU_ARCH_PPC | QEMU_ARCH_SPARC) 9165824d651Sblueswir1STEXI 91795d5f08bSStefan Weil@item -g @var{width}x@var{height}[x@var{depth}] 9186616b2adSStefan Weil@findex -g 91995d5f08bSStefan WeilSet the initial graphical resolution and depth (PPC, SPARC only). 9205824d651Sblueswir1ETEXI 9215824d651Sblueswir1 9225824d651Sblueswir1DEF("vnc", HAS_ARG, QEMU_OPTION_vnc , 923ad96090aSBlue Swirl "-vnc display start a VNC server on display\n", QEMU_ARCH_ALL) 9245824d651Sblueswir1STEXI 9255824d651Sblueswir1@item -vnc @var{display}[,@var{option}[,@var{option}[,...]]] 9266616b2adSStefan Weil@findex -vnc 9275824d651Sblueswir1Normally, QEMU uses SDL to display the VGA output. With this option, 9285824d651Sblueswir1you can have QEMU listen on VNC display @var{display} and redirect the VGA 9295824d651Sblueswir1display over the VNC session. It is very useful to enable the usb 9305824d651Sblueswir1tablet device when using this option (option @option{-usbdevice 9315824d651Sblueswir1tablet}). When using the VNC display, you must use the @option{-k} 9325824d651Sblueswir1parameter to set the keyboard layout if you are not using en-us. Valid 9335824d651Sblueswir1syntax for the @var{display} is 9345824d651Sblueswir1 935b3f046c2SKevin Wolf@table @option 9365824d651Sblueswir1 9375824d651Sblueswir1@item @var{host}:@var{d} 9385824d651Sblueswir1 9395824d651Sblueswir1TCP connections will only be allowed from @var{host} on display @var{d}. 9405824d651Sblueswir1By convention the TCP port is 5900+@var{d}. Optionally, @var{host} can 9415824d651Sblueswir1be omitted in which case the server will accept connections from any host. 9425824d651Sblueswir1 9434e257e5eSKevin Wolf@item unix:@var{path} 9445824d651Sblueswir1 9455824d651Sblueswir1Connections will be allowed over UNIX domain sockets where @var{path} is the 9465824d651Sblueswir1location of a unix socket to listen for connections on. 9475824d651Sblueswir1 9485824d651Sblueswir1@item none 9495824d651Sblueswir1 9505824d651Sblueswir1VNC is initialized but not started. The monitor @code{change} command 9515824d651Sblueswir1can be used to later start the VNC server. 9525824d651Sblueswir1 9535824d651Sblueswir1@end table 9545824d651Sblueswir1 9555824d651Sblueswir1Following the @var{display} value there may be one or more @var{option} flags 9565824d651Sblueswir1separated by commas. Valid options are 9575824d651Sblueswir1 958b3f046c2SKevin Wolf@table @option 9595824d651Sblueswir1 9605824d651Sblueswir1@item reverse 9615824d651Sblueswir1 9625824d651Sblueswir1Connect to a listening VNC client via a ``reverse'' connection. The 9635824d651Sblueswir1client is specified by the @var{display}. For reverse network 9645824d651Sblueswir1connections (@var{host}:@var{d},@code{reverse}), the @var{d} argument 9655824d651Sblueswir1is a TCP port number, not a display number. 9665824d651Sblueswir1 9675824d651Sblueswir1@item password 9685824d651Sblueswir1 9695824d651Sblueswir1Require that password based authentication is used for client connections. 9705824d651Sblueswir1The password must be set separately using the @code{change} command in the 9715824d651Sblueswir1@ref{pcsys_monitor} 9725824d651Sblueswir1 9735824d651Sblueswir1@item tls 9745824d651Sblueswir1 9755824d651Sblueswir1Require that client use TLS when communicating with the VNC server. This 9765824d651Sblueswir1uses anonymous TLS credentials so is susceptible to a man-in-the-middle 9775824d651Sblueswir1attack. It is recommended that this option be combined with either the 9784e257e5eSKevin Wolf@option{x509} or @option{x509verify} options. 9795824d651Sblueswir1 9805824d651Sblueswir1@item x509=@var{/path/to/certificate/dir} 9815824d651Sblueswir1 9825824d651Sblueswir1Valid if @option{tls} is specified. Require that x509 credentials are used 9835824d651Sblueswir1for negotiating the TLS session. The server will send its x509 certificate 9845824d651Sblueswir1to the client. It is recommended that a password be set on the VNC server 9855824d651Sblueswir1to provide authentication of the client when this is used. The path following 9865824d651Sblueswir1this option specifies where the x509 certificates are to be loaded from. 9875824d651Sblueswir1See the @ref{vnc_security} section for details on generating certificates. 9885824d651Sblueswir1 9895824d651Sblueswir1@item x509verify=@var{/path/to/certificate/dir} 9905824d651Sblueswir1 9915824d651Sblueswir1Valid if @option{tls} is specified. Require that x509 credentials are used 9925824d651Sblueswir1for negotiating the TLS session. The server will send its x509 certificate 9935824d651Sblueswir1to the client, and request that the client send its own x509 certificate. 9945824d651Sblueswir1The server will validate the client's certificate against the CA certificate, 9955824d651Sblueswir1and reject clients when validation fails. If the certificate authority is 9965824d651Sblueswir1trusted, this is a sufficient authentication mechanism. You may still wish 9975824d651Sblueswir1to set a password on the VNC server as a second authentication layer. The 9985824d651Sblueswir1path following this option specifies where the x509 certificates are to 9995824d651Sblueswir1be loaded from. See the @ref{vnc_security} section for details on generating 10005824d651Sblueswir1certificates. 10015824d651Sblueswir1 10025824d651Sblueswir1@item sasl 10035824d651Sblueswir1 10045824d651Sblueswir1Require that the client use SASL to authenticate with the VNC server. 10055824d651Sblueswir1The exact choice of authentication method used is controlled from the 10065824d651Sblueswir1system / user's SASL configuration file for the 'qemu' service. This 10075824d651Sblueswir1is typically found in /etc/sasl2/qemu.conf. If running QEMU as an 10085824d651Sblueswir1unprivileged user, an environment variable SASL_CONF_PATH can be used 10095824d651Sblueswir1to make it search alternate locations for the service config. 10105824d651Sblueswir1While some SASL auth methods can also provide data encryption (eg GSSAPI), 10115824d651Sblueswir1it is recommended that SASL always be combined with the 'tls' and 10125824d651Sblueswir1'x509' settings to enable use of SSL and server certificates. This 10135824d651Sblueswir1ensures a data encryption preventing compromise of authentication 10145824d651Sblueswir1credentials. See the @ref{vnc_security} section for details on using 10155824d651Sblueswir1SASL authentication. 10165824d651Sblueswir1 10175824d651Sblueswir1@item acl 10185824d651Sblueswir1 10195824d651Sblueswir1Turn on access control lists for checking of the x509 client certificate 10205824d651Sblueswir1and SASL party. For x509 certs, the ACL check is made against the 10215824d651Sblueswir1certificate's distinguished name. This is something that looks like 10225824d651Sblueswir1@code{C=GB,O=ACME,L=Boston,CN=bob}. For SASL party, the ACL check is 10235824d651Sblueswir1made against the username, which depending on the SASL plugin, may 10245824d651Sblueswir1include a realm component, eg @code{bob} or @code{bob@@EXAMPLE.COM}. 10255824d651Sblueswir1When the @option{acl} flag is set, the initial access list will be 10265824d651Sblueswir1empty, with a @code{deny} policy. Thus no one will be allowed to 10275824d651Sblueswir1use the VNC server until the ACLs have been loaded. This can be 10285824d651Sblueswir1achieved using the @code{acl} monitor command. 10295824d651Sblueswir1 10306f9c78c1SCorentin Chary@item lossy 10316f9c78c1SCorentin Chary 10326f9c78c1SCorentin CharyEnable lossy compression methods (gradient, JPEG, ...). If this 10336f9c78c1SCorentin Charyoption is set, VNC client may receive lossy framebuffer updates 10346f9c78c1SCorentin Charydepending on its encoding settings. Enabling this option can save 10356f9c78c1SCorentin Charya lot of bandwidth at the expense of quality. 10366f9c78c1SCorentin Chary 103780e0c8c3SCorentin Chary@item non-adaptive 103880e0c8c3SCorentin Chary 103980e0c8c3SCorentin CharyDisable adaptive encodings. Adaptive encodings are enabled by default. 104080e0c8c3SCorentin CharyAn adaptive encoding will try to detect frequently updated screen regions, 104180e0c8c3SCorentin Charyand send updates in these regions using a lossy encoding (like JPEG). 104261cc8701SStefan WeilThis can be really helpful to save bandwidth when playing videos. Disabling 104361cc8701SStefan Weiladaptive encodings allows to restore the original static behavior of encodings 104480e0c8c3SCorentin Charylike Tight. 104580e0c8c3SCorentin Chary 10465824d651Sblueswir1@end table 10475824d651Sblueswir1ETEXI 10485824d651Sblueswir1 10495824d651Sblueswir1STEXI 10505824d651Sblueswir1@end table 10515824d651Sblueswir1ETEXI 10525824d651Sblueswir1 10535824d651Sblueswir1DEFHEADING() 10545824d651Sblueswir1 10555824d651Sblueswir1DEFHEADING(i386 target only:) 10565824d651Sblueswir1STEXI 10575824d651Sblueswir1@table @option 10585824d651Sblueswir1ETEXI 10595824d651Sblueswir1 10605824d651Sblueswir1DEF("win2k-hack", 0, QEMU_OPTION_win2k_hack, 1061ad96090aSBlue Swirl "-win2k-hack use it when installing Windows 2000 to avoid a disk full bug\n", 1062ad96090aSBlue Swirl QEMU_ARCH_I386) 10635824d651Sblueswir1STEXI 10645824d651Sblueswir1@item -win2k-hack 10656616b2adSStefan Weil@findex -win2k-hack 10665824d651Sblueswir1Use it when installing Windows 2000 to avoid a disk full bug. After 10675824d651Sblueswir1Windows 2000 is installed, you no longer need this option (this option 10685824d651Sblueswir1slows down the IDE transfers). 10695824d651Sblueswir1ETEXI 10705824d651Sblueswir1 10711ed2fc1fSJan KiszkaHXCOMM Deprecated by -rtc 1072ad96090aSBlue SwirlDEF("rtc-td-hack", 0, QEMU_OPTION_rtc_td_hack, "", QEMU_ARCH_I386) 10735824d651Sblueswir1 10745824d651Sblueswir1DEF("no-fd-bootchk", 0, QEMU_OPTION_no_fd_bootchk, 1075ad96090aSBlue Swirl "-no-fd-bootchk disable boot signature checking for floppy disks\n", 1076ad96090aSBlue Swirl QEMU_ARCH_I386) 10775824d651Sblueswir1STEXI 10785824d651Sblueswir1@item -no-fd-bootchk 10796616b2adSStefan Weil@findex -no-fd-bootchk 10805824d651Sblueswir1Disable boot signature checking for floppy disks in Bochs BIOS. It may 10815824d651Sblueswir1be needed to boot from old floppy disks. 10826616b2adSStefan WeilTODO: check reference to Bochs BIOS. 10835824d651Sblueswir1ETEXI 10845824d651Sblueswir1 10855824d651Sblueswir1DEF("no-acpi", 0, QEMU_OPTION_no_acpi, 1086ad96090aSBlue Swirl "-no-acpi disable ACPI\n", QEMU_ARCH_I386) 10875824d651Sblueswir1STEXI 10885824d651Sblueswir1@item -no-acpi 10896616b2adSStefan Weil@findex -no-acpi 10905824d651Sblueswir1Disable ACPI (Advanced Configuration and Power Interface) support. Use 10915824d651Sblueswir1it if your guest OS complains about ACPI problems (PC target machine 10925824d651Sblueswir1only). 10935824d651Sblueswir1ETEXI 10945824d651Sblueswir1 10955824d651Sblueswir1DEF("no-hpet", 0, QEMU_OPTION_no_hpet, 1096ad96090aSBlue Swirl "-no-hpet disable HPET\n", QEMU_ARCH_I386) 10975824d651Sblueswir1STEXI 10985824d651Sblueswir1@item -no-hpet 10996616b2adSStefan Weil@findex -no-hpet 11005824d651Sblueswir1Disable HPET support. 11015824d651Sblueswir1ETEXI 11025824d651Sblueswir1 11037d4c3d53SMarkus ArmbrusterDEF("balloon", HAS_ARG, QEMU_OPTION_balloon, 11047d4c3d53SMarkus Armbruster "-balloon none disable balloon device\n" 11057d4c3d53SMarkus Armbruster "-balloon virtio[,addr=str]\n" 1106ad96090aSBlue Swirl " enable virtio balloon device (default)\n", QEMU_ARCH_ALL) 1107df97b920SEduardo HabkostSTEXI 11087d4c3d53SMarkus Armbruster@item -balloon none 11096616b2adSStefan Weil@findex -balloon 11107d4c3d53SMarkus ArmbrusterDisable balloon device. 11117d4c3d53SMarkus Armbruster@item -balloon virtio[,addr=@var{addr}] 11127d4c3d53SMarkus ArmbrusterEnable virtio balloon device (default), optionally with PCI address 11137d4c3d53SMarkus Armbruster@var{addr}. 1114df97b920SEduardo HabkostETEXI 1115df97b920SEduardo Habkost 11165824d651Sblueswir1DEF("acpitable", HAS_ARG, QEMU_OPTION_acpitable, 1117104bf02eSMichael 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" 1118ad96090aSBlue Swirl " ACPI table description\n", QEMU_ARCH_I386) 11195824d651Sblueswir1STEXI 11205824d651Sblueswir1@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}]...] 11216616b2adSStefan Weil@findex -acpitable 11225824d651Sblueswir1Add ACPI table with specified header fields and context from specified files. 1123104bf02eSMichael TokarevFor file=, take whole ACPI table from the specified files, including all 1124104bf02eSMichael TokarevACPI headers (possible overridden by other options). 1125104bf02eSMichael TokarevFor data=, only data 1126104bf02eSMichael Tokarevportion of the table is used, all header information is specified in the 1127104bf02eSMichael Tokarevcommand line. 11285824d651Sblueswir1ETEXI 11295824d651Sblueswir1 1130b6f6e3d3SaliguoriDEF("smbios", HAS_ARG, QEMU_OPTION_smbios, 1131b6f6e3d3Saliguori "-smbios file=binary\n" 1132ca1a8a06SBruce Rogers " load SMBIOS entry from binary file\n" 1133e8105ebbSPaolo Bonzini "-smbios type=0[,vendor=str][,version=str][,date=str][,release=%d.%d]\n" 1134ca1a8a06SBruce Rogers " specify SMBIOS type 0 fields\n" 1135b6f6e3d3Saliguori "-smbios type=1[,manufacturer=str][,product=str][,version=str][,serial=str]\n" 1136b6f6e3d3Saliguori " [,uuid=uuid][,sku=str][,family=str]\n" 1137ad96090aSBlue Swirl " specify SMBIOS type 1 fields\n", QEMU_ARCH_I386) 1138b6f6e3d3SaliguoriSTEXI 1139b6f6e3d3Saliguori@item -smbios file=@var{binary} 11406616b2adSStefan Weil@findex -smbios 1141b6f6e3d3SaliguoriLoad SMBIOS entry from binary file. 1142b6f6e3d3Saliguori 1143b6f6e3d3Saliguori@item -smbios type=0[,vendor=@var{str}][,version=@var{str}][,date=@var{str}][,release=@var{%d.%d}] 11446616b2adSStefan Weil@findex -smbios 1145b6f6e3d3SaliguoriSpecify SMBIOS type 0 fields 1146b6f6e3d3Saliguori 1147b6f6e3d3Saliguori@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}] 1148b6f6e3d3SaliguoriSpecify SMBIOS type 1 fields 1149b6f6e3d3SaliguoriETEXI 1150b6f6e3d3Saliguori 11515824d651Sblueswir1DEFHEADING() 11525824d651Sblueswir1STEXI 11535824d651Sblueswir1@end table 11545824d651Sblueswir1ETEXI 11555824d651Sblueswir1 11565824d651Sblueswir1DEFHEADING(Network options:) 11575824d651Sblueswir1STEXI 11585824d651Sblueswir1@table @option 11595824d651Sblueswir1ETEXI 11605824d651Sblueswir1 1161ad196a9dSJan KiszkaHXCOMM Legacy slirp options (now moved to -net user): 1162ad196a9dSJan Kiszka#ifdef CONFIG_SLIRP 1163ad96090aSBlue SwirlDEF("tftp", HAS_ARG, QEMU_OPTION_tftp, "", QEMU_ARCH_ALL) 1164ad96090aSBlue SwirlDEF("bootp", HAS_ARG, QEMU_OPTION_bootp, "", QEMU_ARCH_ALL) 1165ad96090aSBlue SwirlDEF("redir", HAS_ARG, QEMU_OPTION_redir, "", QEMU_ARCH_ALL) 1166ad196a9dSJan Kiszka#ifndef _WIN32 1167ad96090aSBlue SwirlDEF("smb", HAS_ARG, QEMU_OPTION_smb, "", QEMU_ARCH_ALL) 1168ad196a9dSJan Kiszka#endif 1169ad196a9dSJan Kiszka#endif 1170ad196a9dSJan Kiszka 1171bab7944cSBlue SwirlDEF("net", HAS_ARG, QEMU_OPTION_net, 1172ffe6370cSMichael S. Tsirkin "-net nic[,vlan=n][,macaddr=mac][,model=type][,name=str][,addr=str][,vectors=v]\n" 11735824d651Sblueswir1 " create a new Network Interface Card and connect it to VLAN 'n'\n" 11745824d651Sblueswir1#ifdef CONFIG_SLIRP 1175c54ed5bcSJan Kiszka "-net user[,vlan=n][,name=str][,net=addr[/mask]][,host=addr][,restrict=on|off]\n" 1176c92ef6a2SJan Kiszka " [,hostname=host][,dhcpstart=addr][,dns=addr][,tftp=dir][,bootfile=f]\n" 1177c92ef6a2SJan Kiszka " [,hostfwd=rule][,guestfwd=rule]" 1178ad196a9dSJan Kiszka#ifndef _WIN32 1179c92ef6a2SJan Kiszka "[,smb=dir[,smbserver=addr]]\n" 1180ad196a9dSJan Kiszka#endif 1181ad196a9dSJan Kiszka " connect the user mode network stack to VLAN 'n', configure its\n" 1182ad196a9dSJan Kiszka " DHCP server and enabled optional services\n" 11835824d651Sblueswir1#endif 11845824d651Sblueswir1#ifdef _WIN32 11855824d651Sblueswir1 "-net tap[,vlan=n][,name=str],ifname=name\n" 11865824d651Sblueswir1 " connect the host TAP network interface to VLAN 'n'\n" 11875824d651Sblueswir1#else 11885430a28fSmst@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" 11895824d651Sblueswir1 " connect the host TAP network interface to VLAN 'n' and use the\n" 1190bec7c2d4SPaolo Bonzini " network scripts 'file' (default=" DEFAULT_NETWORK_SCRIPT ")\n" 1191bec7c2d4SPaolo Bonzini " and 'dfile' (default=" DEFAULT_NETWORK_DOWN_SCRIPT ")\n" 1192ca1a8a06SBruce Rogers " use '[down]script=no' to disable script execution\n" 11935824d651Sblueswir1 " use 'fd=h' to connect to an already opened TAP interface\n" 1194ca1a8a06SBruce Rogers " use 'sndbuf=nbytes' to limit the size of the send buffer (the\n" 1195f157ed20SMichael S. Tsirkin " default is disabled 'sndbuf=0' to enable flow control set 'sndbuf=1048576')\n" 1196ca1a8a06SBruce Rogers " use vnet_hdr=off to avoid enabling the IFF_VNET_HDR tap flag\n" 1197ca1a8a06SBruce Rogers " use vnet_hdr=on to make the lack of IFF_VNET_HDR support an error condition\n" 119882b0d80eSMichael S. Tsirkin " use vhost=on to enable experimental in kernel accelerator\n" 11995430a28fSmst@redhat.com " (only has effect for virtio guests which use MSIX)\n" 12005430a28fSmst@redhat.com " use vhostforce=on to force vhost on for non-MSIX virtio guests\n" 120182b0d80eSMichael S. Tsirkin " use 'vhostfd=h' to connect to an already opened vhost net device\n" 12020df0ff6dSMark McLoughlin#endif 12035824d651Sblueswir1 "-net socket[,vlan=n][,name=str][,fd=h][,listen=[host]:port][,connect=host:port]\n" 12045824d651Sblueswir1 " connect the vlan 'n' to another VLAN using a socket connection\n" 12053a75e74cSMike Ryan "-net socket[,vlan=n][,name=str][,fd=h][,mcast=maddr:port[,localaddr=addr]]\n" 12065824d651Sblueswir1 " connect the vlan 'n' to multicast maddr and port\n" 12073a75e74cSMike Ryan " use 'localaddr=addr' to specify the host address to send packets from\n" 12085824d651Sblueswir1#ifdef CONFIG_VDE 12095824d651Sblueswir1 "-net vde[,vlan=n][,name=str][,sock=socketpath][,port=n][,group=groupname][,mode=octalmode]\n" 12105824d651Sblueswir1 " connect the vlan 'n' to port 'n' of a vde switch running\n" 12115824d651Sblueswir1 " on host and listening for incoming connections on 'socketpath'.\n" 12125824d651Sblueswir1 " Use group 'groupname' and mode 'octalmode' to change default\n" 12135824d651Sblueswir1 " ownership and permissions for communication port.\n" 12145824d651Sblueswir1#endif 1215bb9ea79eSaliguori "-net dump[,vlan=n][,file=f][,len=n]\n" 1216bb9ea79eSaliguori " dump traffic on vlan 'n' to file 'f' (max n bytes per packet)\n" 1217ca1a8a06SBruce Rogers "-net none use it alone to have zero network devices. If no -net option\n" 1218ad96090aSBlue Swirl " is provided, the default is '-net nic -net user'\n", QEMU_ARCH_ALL) 1219a1ea458fSMark McLoughlinDEF("netdev", HAS_ARG, QEMU_OPTION_netdev, 1220a1ea458fSMark McLoughlin "-netdev [" 1221a1ea458fSMark McLoughlin#ifdef CONFIG_SLIRP 1222a1ea458fSMark McLoughlin "user|" 1223a1ea458fSMark McLoughlin#endif 1224a1ea458fSMark McLoughlin "tap|" 1225a1ea458fSMark McLoughlin#ifdef CONFIG_VDE 1226a1ea458fSMark McLoughlin "vde|" 1227a1ea458fSMark McLoughlin#endif 1228ad96090aSBlue Swirl "socket],id=str[,option][,option][,...]\n", QEMU_ARCH_ALL) 12295824d651Sblueswir1STEXI 1230ffe6370cSMichael S. Tsirkin@item -net nic[,vlan=@var{n}][,macaddr=@var{mac}][,model=@var{type}] [,name=@var{name}][,addr=@var{addr}][,vectors=@var{v}] 12316616b2adSStefan Weil@findex -net 12325824d651Sblueswir1Create a new Network Interface Card and connect it to VLAN @var{n} (@var{n} 12330d6b0b1dSAnthony Liguori= 0 is the default). The NIC is an e1000 by default on the PC 12345607c388SMarkus Armbrustertarget. Optionally, the MAC address can be changed to @var{mac}, the 12355607c388SMarkus Armbrusterdevice address set to @var{addr} (PCI cards only), 1236ffe6370cSMichael S. Tsirkinand a @var{name} can be assigned for use in monitor commands. 1237ffe6370cSMichael S. TsirkinOptionally, for PCI cards, you can specify the number @var{v} of MSI-X vectors 1238ffe6370cSMichael S. Tsirkinthat the card should have; this option currently only affects virtio cards; set 1239ffe6370cSMichael S. Tsirkin@var{v} = 0 to disable MSI-X. If no @option{-net} option is specified, a single 1240ffe6370cSMichael S. TsirkinNIC is created. Qemu can emulate several different models of network card. 12415824d651Sblueswir1Valid values for @var{type} are 1242ffe6370cSMichael S. Tsirkin@code{virtio}, @code{i82551}, @code{i82557b}, @code{i82559er}, 12435824d651Sblueswir1@code{ne2k_pci}, @code{ne2k_isa}, @code{pcnet}, @code{rtl8139}, 12445824d651Sblueswir1@code{e1000}, @code{smc91c111}, @code{lance} and @code{mcf_fec}. 12455824d651Sblueswir1Not all devices are supported on all targets. Use -net nic,model=? 12465824d651Sblueswir1for a list of available devices for your target. 12475824d651Sblueswir1 1248ad196a9dSJan Kiszka@item -net user[,@var{option}][,@var{option}][,...] 12495824d651Sblueswir1Use the user mode network stack which requires no administrator 1250ad196a9dSJan Kiszkaprivilege to run. Valid options are: 12515824d651Sblueswir1 1252b3f046c2SKevin Wolf@table @option 1253ad196a9dSJan Kiszka@item vlan=@var{n} 1254ad196a9dSJan KiszkaConnect user mode stack to VLAN @var{n} (@var{n} = 0 is the default). 1255ad196a9dSJan Kiszka 1256ad196a9dSJan Kiszka@item name=@var{name} 1257ad196a9dSJan KiszkaAssign symbolic name for use in monitor commands. 1258ad196a9dSJan Kiszka 1259c92ef6a2SJan Kiszka@item net=@var{addr}[/@var{mask}] 1260c92ef6a2SJan KiszkaSet IP network address the guest will see. Optionally specify the netmask, 1261c92ef6a2SJan Kiszkaeither in the form a.b.c.d or as number of valid top-most bits. Default is 1262b0b36e5dSBrad Hards10.0.2.0/24. 1263c92ef6a2SJan Kiszka 1264c92ef6a2SJan Kiszka@item host=@var{addr} 1265c92ef6a2SJan KiszkaSpecify the guest-visible address of the host. Default is the 2nd IP in the 1266c92ef6a2SJan Kiszkaguest network, i.e. x.x.x.2. 1267ad196a9dSJan Kiszka 1268c54ed5bcSJan Kiszka@item restrict=on|off 1269caef55edSBrad HardsIf this option is enabled, the guest will be isolated, i.e. it will not be 1270ad196a9dSJan Kiszkaable to contact the host and no guest IP packets will be routed over the host 1271caef55edSBrad Hardsto the outside. This option does not affect any explicitly set forwarding rules. 1272ad196a9dSJan Kiszka 1273ad196a9dSJan Kiszka@item hostname=@var{name} 1274ad196a9dSJan KiszkaSpecifies the client hostname reported by the builtin DHCP server. 1275ad196a9dSJan Kiszka 1276c92ef6a2SJan Kiszka@item dhcpstart=@var{addr} 1277c92ef6a2SJan KiszkaSpecify the first of the 16 IPs the built-in DHCP server can assign. Default 1278b0b36e5dSBrad Hardsis the 15th to 31st IP in the guest network, i.e. x.x.x.15 to x.x.x.31. 1279c92ef6a2SJan Kiszka 1280c92ef6a2SJan Kiszka@item dns=@var{addr} 1281c92ef6a2SJan KiszkaSpecify the guest-visible address of the virtual nameserver. The address must 1282c92ef6a2SJan Kiszkabe different from the host address. Default is the 3rd IP in the guest network, 1283c92ef6a2SJan Kiszkai.e. x.x.x.3. 1284c92ef6a2SJan Kiszka 1285ad196a9dSJan Kiszka@item tftp=@var{dir} 1286ad196a9dSJan KiszkaWhen using the user mode network stack, activate a built-in TFTP 1287ad196a9dSJan Kiszkaserver. The files in @var{dir} will be exposed as the root of a TFTP server. 1288ad196a9dSJan KiszkaThe TFTP client on the guest must be configured in binary mode (use the command 1289c92ef6a2SJan Kiszka@code{bin} of the Unix TFTP client). 1290ad196a9dSJan Kiszka 1291ad196a9dSJan Kiszka@item bootfile=@var{file} 1292ad196a9dSJan KiszkaWhen using the user mode network stack, broadcast @var{file} as the BOOTP 1293ad196a9dSJan Kiszkafilename. In conjunction with @option{tftp}, this can be used to network boot 1294ad196a9dSJan Kiszkaa guest from a local directory. 1295ad196a9dSJan Kiszka 1296ad196a9dSJan KiszkaExample (using pxelinux): 1297ad196a9dSJan Kiszka@example 1298ad196a9dSJan Kiszkaqemu -hda linux.img -boot n -net user,tftp=/path/to/tftp/files,bootfile=/pxelinux.0 1299ad196a9dSJan Kiszka@end example 1300ad196a9dSJan Kiszka 1301c92ef6a2SJan Kiszka@item smb=@var{dir}[,smbserver=@var{addr}] 1302ad196a9dSJan KiszkaWhen using the user mode network stack, activate a built-in SMB 1303ad196a9dSJan Kiszkaserver so that Windows OSes can access to the host files in @file{@var{dir}} 1304c92ef6a2SJan Kiszkatransparently. The IP address of the SMB server can be set to @var{addr}. By 1305c92ef6a2SJan Kiszkadefault the 4th IP in the guest network is used, i.e. x.x.x.4. 1306ad196a9dSJan Kiszka 1307ad196a9dSJan KiszkaIn the guest Windows OS, the line: 1308ad196a9dSJan Kiszka@example 1309ad196a9dSJan Kiszka10.0.2.4 smbserver 1310ad196a9dSJan Kiszka@end example 1311ad196a9dSJan Kiszkamust be added in the file @file{C:\WINDOWS\LMHOSTS} (for windows 9x/Me) 1312ad196a9dSJan Kiszkaor @file{C:\WINNT\SYSTEM32\DRIVERS\ETC\LMHOSTS} (Windows NT/2000). 1313ad196a9dSJan Kiszka 1314ad196a9dSJan KiszkaThen @file{@var{dir}} can be accessed in @file{\\smbserver\qemu}. 1315ad196a9dSJan Kiszka 1316e2d8830eSBradNote that a SAMBA server must be installed on the host OS. 1317e2d8830eSBradQEMU was tested successfully with smbd versions from Red Hat 9, 1318e2d8830eSBradFedora Core 3 and OpenSUSE 11.x. 1319ad196a9dSJan Kiszka 13203c6a0580SJan Kiszka@item hostfwd=[tcp|udp]:[@var{hostaddr}]:@var{hostport}-[@var{guestaddr}]:@var{guestport} 1321c92ef6a2SJan KiszkaRedirect incoming TCP or UDP connections to the host port @var{hostport} to 1322c92ef6a2SJan Kiszkathe guest IP address @var{guestaddr} on guest port @var{guestport}. If 1323c92ef6a2SJan Kiszka@var{guestaddr} is not specified, its value is x.x.x.15 (default first address 13243c6a0580SJan Kiszkagiven by the built-in DHCP server). By specifying @var{hostaddr}, the rule can 13253c6a0580SJan Kiszkabe bound to a specific host interface. If no connection type is set, TCP is 1326c92ef6a2SJan Kiszkaused. This option can be given multiple times. 1327ad196a9dSJan Kiszka 1328ad196a9dSJan KiszkaFor example, to redirect host X11 connection from screen 1 to guest 1329ad196a9dSJan Kiszkascreen 0, use the following: 1330ad196a9dSJan Kiszka 1331ad196a9dSJan Kiszka@example 1332ad196a9dSJan Kiszka# on the host 13333c6a0580SJan Kiszkaqemu -net user,hostfwd=tcp:127.0.0.1:6001-:6000 [...] 1334ad196a9dSJan Kiszka# this host xterm should open in the guest X11 server 1335ad196a9dSJan Kiszkaxterm -display :1 1336ad196a9dSJan Kiszka@end example 1337ad196a9dSJan Kiszka 1338ad196a9dSJan KiszkaTo redirect telnet connections from host port 5555 to telnet port on 1339ad196a9dSJan Kiszkathe guest, use the following: 1340ad196a9dSJan Kiszka 1341ad196a9dSJan Kiszka@example 1342ad196a9dSJan Kiszka# on the host 1343aa375206SAurelien Jarnoqemu -net user,hostfwd=tcp::5555-:23 [...] 1344ad196a9dSJan Kiszkatelnet localhost 5555 1345ad196a9dSJan Kiszka@end example 1346ad196a9dSJan Kiszka 1347ad196a9dSJan KiszkaThen when you use on the host @code{telnet localhost 5555}, you 1348ad196a9dSJan Kiszkaconnect to the guest telnet server. 1349ad196a9dSJan Kiszka 1350c92ef6a2SJan Kiszka@item guestfwd=[tcp]:@var{server}:@var{port}-@var{dev} 13513c6a0580SJan KiszkaForward guest TCP connections to the IP address @var{server} on port @var{port} 13523c6a0580SJan Kiszkato the character device @var{dev}. This option can be given multiple times. 1353ad196a9dSJan Kiszka 1354ad196a9dSJan Kiszka@end table 1355ad196a9dSJan Kiszka 1356ad196a9dSJan KiszkaNote: Legacy stand-alone options -tftp, -bootp, -smb and -redir are still 1357ad196a9dSJan Kiszkaprocessed and applied to -net user. Mixing them with the new configuration 1358ad196a9dSJan Kiszkasyntax gives undefined results. Their use for new applications is discouraged 1359ad196a9dSJan Kiszkaas they will be removed from future versions. 13605824d651Sblueswir1 13615824d651Sblueswir1@item -net tap[,vlan=@var{n}][,name=@var{name}][,fd=@var{h}][,ifname=@var{name}] [,script=@var{file}][,downscript=@var{dfile}] 13625824d651Sblueswir1Connect the host TAP network interface @var{name} to VLAN @var{n}, use 13635824d651Sblueswir1the network script @var{file} to configure it and the network script 13645824d651Sblueswir1@var{dfile} to deconfigure it. If @var{name} is not provided, the OS 13655824d651Sblueswir1automatically provides one. @option{fd}=@var{h} can be used to specify 13665824d651Sblueswir1the handle of an already opened host TAP interface. The default network 13675824d651Sblueswir1configure script is @file{/etc/qemu-ifup} and the default network 13685824d651Sblueswir1deconfigure script is @file{/etc/qemu-ifdown}. Use @option{script=no} 13695824d651Sblueswir1or @option{downscript=no} to disable script execution. Example: 13705824d651Sblueswir1 13715824d651Sblueswir1@example 13725824d651Sblueswir1qemu linux.img -net nic -net tap 13735824d651Sblueswir1@end example 13745824d651Sblueswir1 13755824d651Sblueswir1More complicated example (two NICs, each one connected to a TAP device) 13765824d651Sblueswir1@example 13775824d651Sblueswir1qemu linux.img -net nic,vlan=0 -net tap,vlan=0,ifname=tap0 \ 13785824d651Sblueswir1 -net nic,vlan=1 -net tap,vlan=1,ifname=tap1 13795824d651Sblueswir1@end example 13805824d651Sblueswir1 13815824d651Sblueswir1@item -net socket[,vlan=@var{n}][,name=@var{name}][,fd=@var{h}] [,listen=[@var{host}]:@var{port}][,connect=@var{host}:@var{port}] 13825824d651Sblueswir1 13835824d651Sblueswir1Connect the VLAN @var{n} to a remote VLAN in another QEMU virtual 13845824d651Sblueswir1machine using a TCP socket connection. If @option{listen} is 13855824d651Sblueswir1specified, QEMU waits for incoming connections on @var{port} 13865824d651Sblueswir1(@var{host} is optional). @option{connect} is used to connect to 13875824d651Sblueswir1another QEMU instance using the @option{listen} option. @option{fd}=@var{h} 13885824d651Sblueswir1specifies an already opened TCP socket. 13895824d651Sblueswir1 13905824d651Sblueswir1Example: 13915824d651Sblueswir1@example 13925824d651Sblueswir1# launch a first QEMU instance 13935824d651Sblueswir1qemu linux.img -net nic,macaddr=52:54:00:12:34:56 \ 13945824d651Sblueswir1 -net socket,listen=:1234 13955824d651Sblueswir1# connect the VLAN 0 of this instance to the VLAN 0 13965824d651Sblueswir1# of the first instance 13975824d651Sblueswir1qemu linux.img -net nic,macaddr=52:54:00:12:34:57 \ 13985824d651Sblueswir1 -net socket,connect=127.0.0.1:1234 13995824d651Sblueswir1@end example 14005824d651Sblueswir1 14013a75e74cSMike Ryan@item -net socket[,vlan=@var{n}][,name=@var{name}][,fd=@var{h}][,mcast=@var{maddr}:@var{port}[,localaddr=@var{addr}]] 14025824d651Sblueswir1 14035824d651Sblueswir1Create a VLAN @var{n} shared with another QEMU virtual 14045824d651Sblueswir1machines using a UDP multicast socket, effectively making a bus for 14055824d651Sblueswir1every QEMU with same multicast address @var{maddr} and @var{port}. 14065824d651Sblueswir1NOTES: 14075824d651Sblueswir1@enumerate 14085824d651Sblueswir1@item 14095824d651Sblueswir1Several QEMU can be running on different hosts and share same bus (assuming 14105824d651Sblueswir1correct multicast setup for these hosts). 14115824d651Sblueswir1@item 14125824d651Sblueswir1mcast support is compatible with User Mode Linux (argument @option{eth@var{N}=mcast}), see 14135824d651Sblueswir1@url{http://user-mode-linux.sf.net}. 14145824d651Sblueswir1@item 14155824d651Sblueswir1Use @option{fd=h} to specify an already opened UDP multicast socket. 14165824d651Sblueswir1@end enumerate 14175824d651Sblueswir1 14185824d651Sblueswir1Example: 14195824d651Sblueswir1@example 14205824d651Sblueswir1# launch one QEMU instance 14215824d651Sblueswir1qemu linux.img -net nic,macaddr=52:54:00:12:34:56 \ 14225824d651Sblueswir1 -net socket,mcast=230.0.0.1:1234 14235824d651Sblueswir1# launch another QEMU instance on same "bus" 14245824d651Sblueswir1qemu linux.img -net nic,macaddr=52:54:00:12:34:57 \ 14255824d651Sblueswir1 -net socket,mcast=230.0.0.1:1234 14265824d651Sblueswir1# launch yet another QEMU instance on same "bus" 14275824d651Sblueswir1qemu linux.img -net nic,macaddr=52:54:00:12:34:58 \ 14285824d651Sblueswir1 -net socket,mcast=230.0.0.1:1234 14295824d651Sblueswir1@end example 14305824d651Sblueswir1 14315824d651Sblueswir1Example (User Mode Linux compat.): 14325824d651Sblueswir1@example 14335824d651Sblueswir1# launch QEMU instance (note mcast address selected 14345824d651Sblueswir1# is UML's default) 14355824d651Sblueswir1qemu linux.img -net nic,macaddr=52:54:00:12:34:56 \ 14365824d651Sblueswir1 -net socket,mcast=239.192.168.1:1102 14375824d651Sblueswir1# launch UML 14385824d651Sblueswir1/path/to/linux ubd0=/path/to/root_fs eth0=mcast 14395824d651Sblueswir1@end example 14405824d651Sblueswir1 14413a75e74cSMike RyanExample (send packets from host's 1.2.3.4): 14423a75e74cSMike Ryan@example 14433a75e74cSMike Ryanqemu linux.img -net nic,macaddr=52:54:00:12:34:56 \ 14443a75e74cSMike Ryan -net socket,mcast=239.192.168.1:1102,localaddr=1.2.3.4 14453a75e74cSMike Ryan@end example 14463a75e74cSMike Ryan 14475824d651Sblueswir1@item -net vde[,vlan=@var{n}][,name=@var{name}][,sock=@var{socketpath}] [,port=@var{n}][,group=@var{groupname}][,mode=@var{octalmode}] 14485824d651Sblueswir1Connect VLAN @var{n} to PORT @var{n} of a vde switch running on host and 14495824d651Sblueswir1listening for incoming connections on @var{socketpath}. Use GROUP @var{groupname} 14505824d651Sblueswir1and MODE @var{octalmode} to change default ownership and permissions for 1451c1ba4e0bSStefan Weilcommunication port. This option is only available if QEMU has been compiled 14525824d651Sblueswir1with vde support enabled. 14535824d651Sblueswir1 14545824d651Sblueswir1Example: 14555824d651Sblueswir1@example 14565824d651Sblueswir1# launch vde switch 14575824d651Sblueswir1vde_switch -F -sock /tmp/myswitch 14585824d651Sblueswir1# launch QEMU instance 14595824d651Sblueswir1qemu linux.img -net nic -net vde,sock=/tmp/myswitch 14605824d651Sblueswir1@end example 14615824d651Sblueswir1 1462bb9ea79eSaliguori@item -net dump[,vlan=@var{n}][,file=@var{file}][,len=@var{len}] 1463bb9ea79eSaliguoriDump network traffic on VLAN @var{n} to file @var{file} (@file{qemu-vlan0.pcap} by default). 1464bb9ea79eSaliguoriAt most @var{len} bytes (64k by default) per packet are stored. The file format is 1465bb9ea79eSaliguorilibpcap, so it can be analyzed with tools such as tcpdump or Wireshark. 1466bb9ea79eSaliguori 14675824d651Sblueswir1@item -net none 14685824d651Sblueswir1Indicate that no network devices should be configured. It is used to 14695824d651Sblueswir1override the default configuration (@option{-net nic -net user}) which 14705824d651Sblueswir1is activated if no @option{-net} options are provided. 14715824d651Sblueswir1 14725824d651Sblueswir1@end table 14735824d651Sblueswir1ETEXI 14745824d651Sblueswir1 14757273a2dbSMatthew BoothDEFHEADING() 14767273a2dbSMatthew Booth 14777273a2dbSMatthew BoothDEFHEADING(Character device options:) 14787273a2dbSMatthew Booth 14797273a2dbSMatthew BoothDEF("chardev", HAS_ARG, QEMU_OPTION_chardev, 148097331287SJan Kiszka "-chardev null,id=id[,mux=on|off]\n" 14817273a2dbSMatthew Booth "-chardev socket,id=id[,host=host],port=host[,to=to][,ipv4][,ipv6][,nodelay]\n" 148297331287SJan Kiszka " [,server][,nowait][,telnet][,mux=on|off] (tcp)\n" 148397331287SJan Kiszka "-chardev socket,id=id,path=path[,server][,nowait][,telnet],[mux=on|off] (unix)\n" 14847273a2dbSMatthew Booth "-chardev udp,id=id[,host=host],port=port[,localaddr=localaddr]\n" 148597331287SJan Kiszka " [,localport=localport][,ipv4][,ipv6][,mux=on|off]\n" 148697331287SJan Kiszka "-chardev msmouse,id=id[,mux=on|off]\n" 14877273a2dbSMatthew Booth "-chardev vc,id=id[[,width=width][,height=height]][[,cols=cols][,rows=rows]]\n" 148897331287SJan Kiszka " [,mux=on|off]\n" 148997331287SJan Kiszka "-chardev file,id=id,path=path[,mux=on|off]\n" 149097331287SJan Kiszka "-chardev pipe,id=id,path=path[,mux=on|off]\n" 14917273a2dbSMatthew Booth#ifdef _WIN32 149297331287SJan Kiszka "-chardev console,id=id[,mux=on|off]\n" 149397331287SJan Kiszka "-chardev serial,id=id,path=path[,mux=on|off]\n" 14947273a2dbSMatthew Booth#else 149597331287SJan Kiszka "-chardev pty,id=id[,mux=on|off]\n" 1496b7fdb3abSAurelien Jarno "-chardev stdio,id=id[,mux=on|off][,signal=on|off]\n" 14977273a2dbSMatthew Booth#endif 14987273a2dbSMatthew Booth#ifdef CONFIG_BRLAPI 149997331287SJan Kiszka "-chardev braille,id=id[,mux=on|off]\n" 15007273a2dbSMatthew Booth#endif 15017273a2dbSMatthew Booth#if defined(__linux__) || defined(__sun__) || defined(__FreeBSD__) \ 15027273a2dbSMatthew Booth || defined(__NetBSD__) || defined(__OpenBSD__) || defined(__DragonFly__) 150397331287SJan Kiszka "-chardev tty,id=id,path=path[,mux=on|off]\n" 15047273a2dbSMatthew Booth#endif 15057273a2dbSMatthew Booth#if defined(__linux__) || defined(__FreeBSD__) || defined(__DragonFly__) 150697331287SJan Kiszka "-chardev parport,id=id,path=path[,mux=on|off]\n" 15077273a2dbSMatthew Booth#endif 1508cbcc6336SAlon Levy#if defined(CONFIG_SPICE) 1509cbcc6336SAlon Levy "-chardev spicevmc,id=id,name=name[,debug=debug]\n" 1510cbcc6336SAlon Levy#endif 1511ad96090aSBlue Swirl , QEMU_ARCH_ALL 15127273a2dbSMatthew Booth) 15137273a2dbSMatthew Booth 15147273a2dbSMatthew BoothSTEXI 15157273a2dbSMatthew Booth 15167273a2dbSMatthew BoothThe general form of a character device option is: 15177273a2dbSMatthew Booth@table @option 15187273a2dbSMatthew Booth 151997331287SJan Kiszka@item -chardev @var{backend} ,id=@var{id} [,mux=on|off] [,@var{options}] 15206616b2adSStefan Weil@findex -chardev 15217273a2dbSMatthew BoothBackend is one of: 15227273a2dbSMatthew Booth@option{null}, 15237273a2dbSMatthew Booth@option{socket}, 15247273a2dbSMatthew Booth@option{udp}, 15257273a2dbSMatthew Booth@option{msmouse}, 15267273a2dbSMatthew Booth@option{vc}, 15277273a2dbSMatthew Booth@option{file}, 15287273a2dbSMatthew Booth@option{pipe}, 15297273a2dbSMatthew Booth@option{console}, 15307273a2dbSMatthew Booth@option{serial}, 15317273a2dbSMatthew Booth@option{pty}, 15327273a2dbSMatthew Booth@option{stdio}, 15337273a2dbSMatthew Booth@option{braille}, 15347273a2dbSMatthew Booth@option{tty}, 1535cbcc6336SAlon Levy@option{parport}, 1536cbcc6336SAlon Levy@option{spicevmc}. 15377273a2dbSMatthew BoothThe specific backend will determine the applicable options. 15387273a2dbSMatthew Booth 15397273a2dbSMatthew BoothAll devices must have an id, which can be any string up to 127 characters long. 15407273a2dbSMatthew BoothIt is used to uniquely identify this device in other command line directives. 15417273a2dbSMatthew Booth 154297331287SJan KiszkaA character device may be used in multiplexing mode by multiple front-ends. 154397331287SJan KiszkaThe key sequence of @key{Control-a} and @key{c} will rotate the input focus 154497331287SJan Kiszkabetween attached front-ends. Specify @option{mux=on} to enable this mode. 154597331287SJan Kiszka 15467273a2dbSMatthew BoothOptions to each backend are described below. 15477273a2dbSMatthew Booth 15487273a2dbSMatthew Booth@item -chardev null ,id=@var{id} 15497273a2dbSMatthew BoothA void device. This device will not emit any data, and will drop any data it 15507273a2dbSMatthew Boothreceives. The null backend does not take any options. 15517273a2dbSMatthew Booth 15527273a2dbSMatthew Booth@item -chardev socket ,id=@var{id} [@var{TCP options} or @var{unix options}] [,server] [,nowait] [,telnet] 15537273a2dbSMatthew Booth 15547273a2dbSMatthew BoothCreate a two-way stream socket, which can be either a TCP or a unix socket. A 15557273a2dbSMatthew Boothunix socket will be created if @option{path} is specified. Behaviour is 15567273a2dbSMatthew Boothundefined if TCP options are specified for a unix socket. 15577273a2dbSMatthew Booth 15587273a2dbSMatthew Booth@option{server} specifies that the socket shall be a listening socket. 15597273a2dbSMatthew Booth 15607273a2dbSMatthew Booth@option{nowait} specifies that QEMU should not block waiting for a client to 15617273a2dbSMatthew Boothconnect to a listening socket. 15627273a2dbSMatthew Booth 15637273a2dbSMatthew Booth@option{telnet} specifies that traffic on the socket should interpret telnet 15647273a2dbSMatthew Boothescape sequences. 15657273a2dbSMatthew Booth 15667273a2dbSMatthew BoothTCP and unix socket options are given below: 15677273a2dbSMatthew Booth 15687273a2dbSMatthew Booth@table @option 15697273a2dbSMatthew Booth 15708d533561SAurelien Jarno@item TCP options: port=@var{port} [,host=@var{host}] [,to=@var{to}] [,ipv4] [,ipv6] [,nodelay] 15717273a2dbSMatthew Booth 15727273a2dbSMatthew Booth@option{host} for a listening socket specifies the local address to be bound. 15737273a2dbSMatthew BoothFor a connecting socket species the remote host to connect to. @option{host} is 15747273a2dbSMatthew Boothoptional for listening sockets. If not specified it defaults to @code{0.0.0.0}. 15757273a2dbSMatthew Booth 15767273a2dbSMatthew Booth@option{port} for a listening socket specifies the local port to be bound. For a 15777273a2dbSMatthew Boothconnecting socket specifies the port on the remote host to connect to. 15787273a2dbSMatthew Booth@option{port} can be given as either a port number or a service name. 15797273a2dbSMatthew Booth@option{port} is required. 15807273a2dbSMatthew Booth 15817273a2dbSMatthew Booth@option{to} is only relevant to listening sockets. If it is specified, and 15827273a2dbSMatthew Booth@option{port} cannot be bound, QEMU will attempt to bind to subsequent ports up 15837273a2dbSMatthew Boothto and including @option{to} until it succeeds. @option{to} must be specified 15847273a2dbSMatthew Boothas a port number. 15857273a2dbSMatthew Booth 15867273a2dbSMatthew Booth@option{ipv4} and @option{ipv6} specify that either IPv4 or IPv6 must be used. 15877273a2dbSMatthew BoothIf neither is specified the socket may use either protocol. 15887273a2dbSMatthew Booth 15897273a2dbSMatthew Booth@option{nodelay} disables the Nagle algorithm. 15907273a2dbSMatthew Booth 15917273a2dbSMatthew Booth@item unix options: path=@var{path} 15927273a2dbSMatthew Booth 15937273a2dbSMatthew Booth@option{path} specifies the local path of the unix socket. @option{path} is 15947273a2dbSMatthew Boothrequired. 15957273a2dbSMatthew Booth 15967273a2dbSMatthew Booth@end table 15977273a2dbSMatthew Booth 15987273a2dbSMatthew Booth@item -chardev udp ,id=@var{id} [,host=@var{host}] ,port=@var{port} [,localaddr=@var{localaddr}] [,localport=@var{localport}] [,ipv4] [,ipv6] 15997273a2dbSMatthew Booth 16007273a2dbSMatthew BoothSends all traffic from the guest to a remote host over UDP. 16017273a2dbSMatthew Booth 16027273a2dbSMatthew Booth@option{host} specifies the remote host to connect to. If not specified it 16037273a2dbSMatthew Boothdefaults to @code{localhost}. 16047273a2dbSMatthew Booth 16057273a2dbSMatthew Booth@option{port} specifies the port on the remote host to connect to. @option{port} 16067273a2dbSMatthew Boothis required. 16077273a2dbSMatthew Booth 16087273a2dbSMatthew Booth@option{localaddr} specifies the local address to bind to. If not specified it 16097273a2dbSMatthew Boothdefaults to @code{0.0.0.0}. 16107273a2dbSMatthew Booth 16117273a2dbSMatthew Booth@option{localport} specifies the local port to bind to. If not specified any 16127273a2dbSMatthew Boothavailable local port will be used. 16137273a2dbSMatthew Booth 16147273a2dbSMatthew Booth@option{ipv4} and @option{ipv6} specify that either IPv4 or IPv6 must be used. 16157273a2dbSMatthew BoothIf neither is specified the device may use either protocol. 16167273a2dbSMatthew Booth 16177273a2dbSMatthew Booth@item -chardev msmouse ,id=@var{id} 16187273a2dbSMatthew Booth 16197273a2dbSMatthew BoothForward QEMU's emulated msmouse events to the guest. @option{msmouse} does not 16207273a2dbSMatthew Boothtake any options. 16217273a2dbSMatthew Booth 16227273a2dbSMatthew Booth@item -chardev vc ,id=@var{id} [[,width=@var{width}] [,height=@var{height}]] [[,cols=@var{cols}] [,rows=@var{rows}]] 16237273a2dbSMatthew Booth 16247273a2dbSMatthew BoothConnect to a QEMU text console. @option{vc} may optionally be given a specific 16257273a2dbSMatthew Boothsize. 16267273a2dbSMatthew Booth 16277273a2dbSMatthew Booth@option{width} and @option{height} specify the width and height respectively of 16287273a2dbSMatthew Booththe console, in pixels. 16297273a2dbSMatthew Booth 16307273a2dbSMatthew Booth@option{cols} and @option{rows} specify that the console be sized to fit a text 16317273a2dbSMatthew Boothconsole with the given dimensions. 16327273a2dbSMatthew Booth 16337273a2dbSMatthew Booth@item -chardev file ,id=@var{id} ,path=@var{path} 16347273a2dbSMatthew Booth 16357273a2dbSMatthew BoothLog all traffic received from the guest to a file. 16367273a2dbSMatthew Booth 16377273a2dbSMatthew Booth@option{path} specifies the path of the file to be opened. This file will be 16387273a2dbSMatthew Boothcreated if it does not already exist, and overwritten if it does. @option{path} 16397273a2dbSMatthew Boothis required. 16407273a2dbSMatthew Booth 16417273a2dbSMatthew Booth@item -chardev pipe ,id=@var{id} ,path=@var{path} 16427273a2dbSMatthew Booth 16437273a2dbSMatthew BoothCreate a two-way connection to the guest. The behaviour differs slightly between 16447273a2dbSMatthew BoothWindows hosts and other hosts: 16457273a2dbSMatthew Booth 16467273a2dbSMatthew BoothOn Windows, a single duplex pipe will be created at 16477273a2dbSMatthew Booth@file{\\.pipe\@option{path}}. 16487273a2dbSMatthew Booth 16497273a2dbSMatthew BoothOn other hosts, 2 pipes will be created called @file{@option{path}.in} and 16507273a2dbSMatthew Booth@file{@option{path}.out}. Data written to @file{@option{path}.in} will be 16517273a2dbSMatthew Boothreceived by the guest. Data written by the guest can be read from 16527273a2dbSMatthew Booth@file{@option{path}.out}. QEMU will not create these fifos, and requires them to 16537273a2dbSMatthew Boothbe present. 16547273a2dbSMatthew Booth 16557273a2dbSMatthew Booth@option{path} forms part of the pipe path as described above. @option{path} is 16567273a2dbSMatthew Boothrequired. 16577273a2dbSMatthew Booth 16587273a2dbSMatthew Booth@item -chardev console ,id=@var{id} 16597273a2dbSMatthew Booth 16607273a2dbSMatthew BoothSend traffic from the guest to QEMU's standard output. @option{console} does not 16617273a2dbSMatthew Boothtake any options. 16627273a2dbSMatthew Booth 16637273a2dbSMatthew Booth@option{console} is only available on Windows hosts. 16647273a2dbSMatthew Booth 16657273a2dbSMatthew Booth@item -chardev serial ,id=@var{id} ,path=@option{path} 16667273a2dbSMatthew Booth 16677273a2dbSMatthew BoothSend traffic from the guest to a serial device on the host. 16687273a2dbSMatthew Booth 16697273a2dbSMatthew Booth@option{serial} is 16707273a2dbSMatthew Boothonly available on Windows hosts. 16717273a2dbSMatthew Booth 16727273a2dbSMatthew Booth@option{path} specifies the name of the serial device to open. 16737273a2dbSMatthew Booth 16747273a2dbSMatthew Booth@item -chardev pty ,id=@var{id} 16757273a2dbSMatthew Booth 16767273a2dbSMatthew BoothCreate a new pseudo-terminal on the host and connect to it. @option{pty} does 16777273a2dbSMatthew Boothnot take any options. 16787273a2dbSMatthew Booth 16797273a2dbSMatthew Booth@option{pty} is not available on Windows hosts. 16807273a2dbSMatthew Booth 1681b7fdb3abSAurelien Jarno@item -chardev stdio ,id=@var{id} [,signal=on|off] 16827273a2dbSMatthew BoothConnect to standard input and standard output of the qemu process. 1683b7fdb3abSAurelien Jarno 1684b7fdb3abSAurelien Jarno@option{signal} controls if signals are enabled on the terminal, that includes 1685b7fdb3abSAurelien Jarnoexiting QEMU with the key sequence @key{Control-c}. This option is enabled by 1686b7fdb3abSAurelien Jarnodefault, use @option{signal=off} to disable it. 1687b7fdb3abSAurelien Jarno 1688b7fdb3abSAurelien Jarno@option{stdio} is not available on Windows hosts. 16897273a2dbSMatthew Booth 16907273a2dbSMatthew Booth@item -chardev braille ,id=@var{id} 16917273a2dbSMatthew Booth 16927273a2dbSMatthew BoothConnect to a local BrlAPI server. @option{braille} does not take any options. 16937273a2dbSMatthew Booth 16947273a2dbSMatthew Booth@item -chardev tty ,id=@var{id} ,path=@var{path} 16957273a2dbSMatthew Booth 16967273a2dbSMatthew BoothConnect to a local tty device. 16977273a2dbSMatthew Booth 16987273a2dbSMatthew Booth@option{tty} is only available on Linux, Sun, FreeBSD, NetBSD, OpenBSD and 16997273a2dbSMatthew BoothDragonFlyBSD hosts. 17007273a2dbSMatthew Booth 17017273a2dbSMatthew Booth@option{path} specifies the path to the tty. @option{path} is required. 17027273a2dbSMatthew Booth 17037273a2dbSMatthew Booth@item -chardev parport ,id=@var{id} ,path=@var{path} 17047273a2dbSMatthew Booth 17057273a2dbSMatthew Booth@option{parport} is only available on Linux, FreeBSD and DragonFlyBSD hosts. 17067273a2dbSMatthew Booth 17077273a2dbSMatthew BoothConnect to a local parallel port. 17087273a2dbSMatthew Booth 17097273a2dbSMatthew Booth@option{path} specifies the path to the parallel port device. @option{path} is 17107273a2dbSMatthew Boothrequired. 17117273a2dbSMatthew Booth 1712cbcc6336SAlon Levy@item -chardev spicevmc ,id=@var{id} ,debug=@var{debug}, name=@var{name} 1713cbcc6336SAlon Levy 17143a846906SStefan Hajnoczi@option{spicevmc} is only available when spice support is built in. 17153a846906SStefan Hajnoczi 1716cbcc6336SAlon Levy@option{debug} debug level for spicevmc 1717cbcc6336SAlon Levy 1718cbcc6336SAlon Levy@option{name} name of spice channel to connect to 1719cbcc6336SAlon Levy 1720cbcc6336SAlon LevyConnect to a spice virtual machine channel, such as vdiport. 1721cbcc6336SAlon Levy 17227273a2dbSMatthew Booth@end table 17237273a2dbSMatthew BoothETEXI 17247273a2dbSMatthew Booth 17257273a2dbSMatthew BoothDEFHEADING() 17267273a2dbSMatthew Booth 17277273a2dbSMatthew BoothDEFHEADING(Bluetooth(R) options:) 17287273a2dbSMatthew Booth 17295824d651Sblueswir1DEF("bt", HAS_ARG, QEMU_OPTION_bt, \ 17305824d651Sblueswir1 "-bt hci,null dumb bluetooth HCI - doesn't respond to commands\n" \ 17315824d651Sblueswir1 "-bt hci,host[:id]\n" \ 17325824d651Sblueswir1 " use host's HCI with the given name\n" \ 17335824d651Sblueswir1 "-bt hci[,vlan=n]\n" \ 17345824d651Sblueswir1 " emulate a standard HCI in virtual scatternet 'n'\n" \ 17355824d651Sblueswir1 "-bt vhci[,vlan=n]\n" \ 17365824d651Sblueswir1 " add host computer to virtual scatternet 'n' using VHCI\n" \ 17375824d651Sblueswir1 "-bt device:dev[,vlan=n]\n" \ 1738ad96090aSBlue Swirl " emulate a bluetooth device 'dev' in scatternet 'n'\n", 1739ad96090aSBlue Swirl QEMU_ARCH_ALL) 17405824d651Sblueswir1STEXI 17415824d651Sblueswir1@table @option 17425824d651Sblueswir1 17435824d651Sblueswir1@item -bt hci[...] 17446616b2adSStefan Weil@findex -bt 17455824d651Sblueswir1Defines the function of the corresponding Bluetooth HCI. -bt options 17465824d651Sblueswir1are matched with the HCIs present in the chosen machine type. For 17475824d651Sblueswir1example when emulating a machine with only one HCI built into it, only 17485824d651Sblueswir1the first @code{-bt hci[...]} option is valid and defines the HCI's 17495824d651Sblueswir1logic. The Transport Layer is decided by the machine type. Currently 17505824d651Sblueswir1the machines @code{n800} and @code{n810} have one HCI and all other 17515824d651Sblueswir1machines have none. 17525824d651Sblueswir1 17535824d651Sblueswir1@anchor{bt-hcis} 17545824d651Sblueswir1The following three types are recognized: 17555824d651Sblueswir1 1756b3f046c2SKevin Wolf@table @option 17575824d651Sblueswir1@item -bt hci,null 17585824d651Sblueswir1(default) The corresponding Bluetooth HCI assumes no internal logic 17595824d651Sblueswir1and will not respond to any HCI commands or emit events. 17605824d651Sblueswir1 17615824d651Sblueswir1@item -bt hci,host[:@var{id}] 17625824d651Sblueswir1(@code{bluez} only) The corresponding HCI passes commands / events 17635824d651Sblueswir1to / from the physical HCI identified by the name @var{id} (default: 17645824d651Sblueswir1@code{hci0}) on the computer running QEMU. Only available on @code{bluez} 17655824d651Sblueswir1capable systems like Linux. 17665824d651Sblueswir1 17675824d651Sblueswir1@item -bt hci[,vlan=@var{n}] 17685824d651Sblueswir1Add a virtual, standard HCI that will participate in the Bluetooth 17695824d651Sblueswir1scatternet @var{n} (default @code{0}). Similarly to @option{-net} 17705824d651Sblueswir1VLANs, devices inside a bluetooth network @var{n} can only communicate 17715824d651Sblueswir1with other devices in the same network (scatternet). 17725824d651Sblueswir1@end table 17735824d651Sblueswir1 17745824d651Sblueswir1@item -bt vhci[,vlan=@var{n}] 17755824d651Sblueswir1(Linux-host only) Create a HCI in scatternet @var{n} (default 0) attached 17765824d651Sblueswir1to the host bluetooth stack instead of to the emulated target. This 17775824d651Sblueswir1allows the host and target machines to participate in a common scatternet 17785824d651Sblueswir1and communicate. Requires the Linux @code{vhci} driver installed. Can 17795824d651Sblueswir1be used as following: 17805824d651Sblueswir1 17815824d651Sblueswir1@example 17825824d651Sblueswir1qemu [...OPTIONS...] -bt hci,vlan=5 -bt vhci,vlan=5 17835824d651Sblueswir1@end example 17845824d651Sblueswir1 17855824d651Sblueswir1@item -bt device:@var{dev}[,vlan=@var{n}] 17865824d651Sblueswir1Emulate a bluetooth device @var{dev} and place it in network @var{n} 17875824d651Sblueswir1(default @code{0}). QEMU can only emulate one type of bluetooth devices 17885824d651Sblueswir1currently: 17895824d651Sblueswir1 1790b3f046c2SKevin Wolf@table @option 17915824d651Sblueswir1@item keyboard 17925824d651Sblueswir1Virtual wireless keyboard implementing the HIDP bluetooth profile. 17935824d651Sblueswir1@end table 17945824d651Sblueswir1@end table 17955824d651Sblueswir1ETEXI 17965824d651Sblueswir1 17975824d651Sblueswir1DEFHEADING() 17985824d651Sblueswir1 17997677f05dSAlexander GrafDEFHEADING(Linux/Multiboot boot specific:) 18005824d651Sblueswir1STEXI 18017677f05dSAlexander Graf 18027677f05dSAlexander GrafWhen using these options, you can use a given Linux or Multiboot 18037677f05dSAlexander Grafkernel without installing it in the disk image. It can be useful 18045824d651Sblueswir1for easier testing of various kernels. 18055824d651Sblueswir1 18065824d651Sblueswir1@table @option 18075824d651Sblueswir1ETEXI 18085824d651Sblueswir1 18095824d651Sblueswir1DEF("kernel", HAS_ARG, QEMU_OPTION_kernel, \ 1810ad96090aSBlue Swirl "-kernel bzImage use 'bzImage' as kernel image\n", QEMU_ARCH_ALL) 18115824d651Sblueswir1STEXI 18125824d651Sblueswir1@item -kernel @var{bzImage} 18136616b2adSStefan Weil@findex -kernel 18147677f05dSAlexander GrafUse @var{bzImage} as kernel image. The kernel can be either a Linux kernel 18157677f05dSAlexander Grafor in multiboot format. 18165824d651Sblueswir1ETEXI 18175824d651Sblueswir1 18185824d651Sblueswir1DEF("append", HAS_ARG, QEMU_OPTION_append, \ 1819ad96090aSBlue Swirl "-append cmdline use 'cmdline' as kernel command line\n", QEMU_ARCH_ALL) 18205824d651Sblueswir1STEXI 18215824d651Sblueswir1@item -append @var{cmdline} 18226616b2adSStefan Weil@findex -append 18235824d651Sblueswir1Use @var{cmdline} as kernel command line 18245824d651Sblueswir1ETEXI 18255824d651Sblueswir1 18265824d651Sblueswir1DEF("initrd", HAS_ARG, QEMU_OPTION_initrd, \ 1827ad96090aSBlue Swirl "-initrd file use 'file' as initial ram disk\n", QEMU_ARCH_ALL) 18285824d651Sblueswir1STEXI 18295824d651Sblueswir1@item -initrd @var{file} 18306616b2adSStefan Weil@findex -initrd 18315824d651Sblueswir1Use @var{file} as initial ram disk. 18327677f05dSAlexander Graf 18337677f05dSAlexander Graf@item -initrd "@var{file1} arg=foo,@var{file2}" 18347677f05dSAlexander Graf 18357677f05dSAlexander GrafThis syntax is only available with multiboot. 18367677f05dSAlexander Graf 18377677f05dSAlexander GrafUse @var{file1} and @var{file2} as modules and pass arg=foo as parameter to the 18387677f05dSAlexander Graffirst module. 18395824d651Sblueswir1ETEXI 18405824d651Sblueswir1 18415824d651Sblueswir1STEXI 18425824d651Sblueswir1@end table 18435824d651Sblueswir1ETEXI 18445824d651Sblueswir1 18455824d651Sblueswir1DEFHEADING() 18465824d651Sblueswir1 18475824d651Sblueswir1DEFHEADING(Debug/Expert options:) 18485824d651Sblueswir1 18495824d651Sblueswir1STEXI 18505824d651Sblueswir1@table @option 18515824d651Sblueswir1ETEXI 18525824d651Sblueswir1 18535824d651Sblueswir1DEF("serial", HAS_ARG, QEMU_OPTION_serial, \ 1854ad96090aSBlue Swirl "-serial dev redirect the serial port to char device 'dev'\n", 1855ad96090aSBlue Swirl QEMU_ARCH_ALL) 18565824d651Sblueswir1STEXI 18575824d651Sblueswir1@item -serial @var{dev} 18586616b2adSStefan Weil@findex -serial 18595824d651Sblueswir1Redirect the virtual serial port to host character device 18605824d651Sblueswir1@var{dev}. The default device is @code{vc} in graphical mode and 18615824d651Sblueswir1@code{stdio} in non graphical mode. 18625824d651Sblueswir1 18635824d651Sblueswir1This option can be used several times to simulate up to 4 serial 18645824d651Sblueswir1ports. 18655824d651Sblueswir1 18665824d651Sblueswir1Use @code{-serial none} to disable all serial ports. 18675824d651Sblueswir1 18685824d651Sblueswir1Available character devices are: 1869b3f046c2SKevin Wolf@table @option 18704e257e5eSKevin Wolf@item vc[:@var{W}x@var{H}] 18715824d651Sblueswir1Virtual console. Optionally, a width and height can be given in pixel with 18725824d651Sblueswir1@example 18735824d651Sblueswir1vc:800x600 18745824d651Sblueswir1@end example 18755824d651Sblueswir1It is also possible to specify width or height in characters: 18765824d651Sblueswir1@example 18775824d651Sblueswir1vc:80Cx24C 18785824d651Sblueswir1@end example 18795824d651Sblueswir1@item pty 18805824d651Sblueswir1[Linux only] Pseudo TTY (a new PTY is automatically allocated) 18815824d651Sblueswir1@item none 18825824d651Sblueswir1No device is allocated. 18835824d651Sblueswir1@item null 18845824d651Sblueswir1void device 18855824d651Sblueswir1@item /dev/XXX 18865824d651Sblueswir1[Linux only] Use host tty, e.g. @file{/dev/ttyS0}. The host serial port 18875824d651Sblueswir1parameters are set according to the emulated ones. 18885824d651Sblueswir1@item /dev/parport@var{N} 18895824d651Sblueswir1[Linux only, parallel port only] Use host parallel port 18905824d651Sblueswir1@var{N}. Currently SPP and EPP parallel port features can be used. 18915824d651Sblueswir1@item file:@var{filename} 18925824d651Sblueswir1Write output to @var{filename}. No character can be read. 18935824d651Sblueswir1@item stdio 18945824d651Sblueswir1[Unix only] standard input/output 18955824d651Sblueswir1@item pipe:@var{filename} 18965824d651Sblueswir1name pipe @var{filename} 18975824d651Sblueswir1@item COM@var{n} 18985824d651Sblueswir1[Windows only] Use host serial port @var{n} 18995824d651Sblueswir1@item udp:[@var{remote_host}]:@var{remote_port}[@@[@var{src_ip}]:@var{src_port}] 19005824d651Sblueswir1This implements UDP Net Console. 19015824d651Sblueswir1When @var{remote_host} or @var{src_ip} are not specified 19025824d651Sblueswir1they default to @code{0.0.0.0}. 19035824d651Sblueswir1When not using a specified @var{src_port} a random port is automatically chosen. 19045824d651Sblueswir1 19055824d651Sblueswir1If you just want a simple readonly console you can use @code{netcat} or 19065824d651Sblueswir1@code{nc}, by starting qemu with: @code{-serial udp::4555} and nc as: 19075824d651Sblueswir1@code{nc -u -l -p 4555}. Any time qemu writes something to that port it 19085824d651Sblueswir1will appear in the netconsole session. 19095824d651Sblueswir1 19105824d651Sblueswir1If you plan to send characters back via netconsole or you want to stop 19115824d651Sblueswir1and start qemu a lot of times, you should have qemu use the same 19125824d651Sblueswir1source port each time by using something like @code{-serial 19135824d651Sblueswir1udp::4555@@:4556} to qemu. Another approach is to use a patched 19145824d651Sblueswir1version of netcat which can listen to a TCP port and send and receive 19155824d651Sblueswir1characters via udp. If you have a patched version of netcat which 19165824d651Sblueswir1activates telnet remote echo and single char transfer, then you can 19175824d651Sblueswir1use the following options to step up a netcat redirector to allow 19185824d651Sblueswir1telnet on port 5555 to access the qemu port. 19195824d651Sblueswir1@table @code 19205824d651Sblueswir1@item Qemu Options: 19215824d651Sblueswir1-serial udp::4555@@:4556 19225824d651Sblueswir1@item netcat options: 19235824d651Sblueswir1-u -P 4555 -L 0.0.0.0:4556 -t -p 5555 -I -T 19245824d651Sblueswir1@item telnet options: 19255824d651Sblueswir1localhost 5555 19265824d651Sblueswir1@end table 19275824d651Sblueswir1 19285824d651Sblueswir1@item tcp:[@var{host}]:@var{port}[,@var{server}][,nowait][,nodelay] 19295824d651Sblueswir1The TCP Net Console has two modes of operation. It can send the serial 19305824d651Sblueswir1I/O to a location or wait for a connection from a location. By default 19315824d651Sblueswir1the TCP Net Console is sent to @var{host} at the @var{port}. If you use 19325824d651Sblueswir1the @var{server} option QEMU will wait for a client socket application 19335824d651Sblueswir1to connect to the port before continuing, unless the @code{nowait} 19345824d651Sblueswir1option was specified. The @code{nodelay} option disables the Nagle buffering 19355824d651Sblueswir1algorithm. If @var{host} is omitted, 0.0.0.0 is assumed. Only 19365824d651Sblueswir1one TCP connection at a time is accepted. You can use @code{telnet} to 19375824d651Sblueswir1connect to the corresponding character device. 19385824d651Sblueswir1@table @code 19395824d651Sblueswir1@item Example to send tcp console to 192.168.0.2 port 4444 19405824d651Sblueswir1-serial tcp:192.168.0.2:4444 19415824d651Sblueswir1@item Example to listen and wait on port 4444 for connection 19425824d651Sblueswir1-serial tcp::4444,server 19435824d651Sblueswir1@item Example to not wait and listen on ip 192.168.0.100 port 4444 19445824d651Sblueswir1-serial tcp:192.168.0.100:4444,server,nowait 19455824d651Sblueswir1@end table 19465824d651Sblueswir1 19475824d651Sblueswir1@item telnet:@var{host}:@var{port}[,server][,nowait][,nodelay] 19485824d651Sblueswir1The telnet protocol is used instead of raw tcp sockets. The options 19495824d651Sblueswir1work the same as if you had specified @code{-serial tcp}. The 19505824d651Sblueswir1difference is that the port acts like a telnet server or client using 19515824d651Sblueswir1telnet option negotiation. This will also allow you to send the 19525824d651Sblueswir1MAGIC_SYSRQ sequence if you use a telnet that supports sending the break 19535824d651Sblueswir1sequence. Typically in unix telnet you do it with Control-] and then 19545824d651Sblueswir1type "send break" followed by pressing the enter key. 19555824d651Sblueswir1 19565824d651Sblueswir1@item unix:@var{path}[,server][,nowait] 19575824d651Sblueswir1A unix domain socket is used instead of a tcp socket. The option works the 19585824d651Sblueswir1same as if you had specified @code{-serial tcp} except the unix domain socket 19595824d651Sblueswir1@var{path} is used for connections. 19605824d651Sblueswir1 19615824d651Sblueswir1@item mon:@var{dev_string} 19625824d651Sblueswir1This is a special option to allow the monitor to be multiplexed onto 19635824d651Sblueswir1another serial port. The monitor is accessed with key sequence of 19645824d651Sblueswir1@key{Control-a} and then pressing @key{c}. See monitor access 19655824d651Sblueswir1@ref{pcsys_keys} in the -nographic section for more keys. 19665824d651Sblueswir1@var{dev_string} should be any one of the serial devices specified 19675824d651Sblueswir1above. An example to multiplex the monitor onto a telnet server 19685824d651Sblueswir1listening on port 4444 would be: 19695824d651Sblueswir1@table @code 19705824d651Sblueswir1@item -serial mon:telnet::4444,server,nowait 19715824d651Sblueswir1@end table 19725824d651Sblueswir1 19735824d651Sblueswir1@item braille 19745824d651Sblueswir1Braille device. This will use BrlAPI to display the braille output on a real 19755824d651Sblueswir1or fake device. 19765824d651Sblueswir1 1977be8b28a9SKevin Wolf@item msmouse 1978be8b28a9SKevin WolfThree button serial mouse. Configure the guest to use Microsoft protocol. 19795824d651Sblueswir1@end table 19805824d651Sblueswir1ETEXI 19815824d651Sblueswir1 19825824d651Sblueswir1DEF("parallel", HAS_ARG, QEMU_OPTION_parallel, \ 1983ad96090aSBlue Swirl "-parallel dev redirect the parallel port to char device 'dev'\n", 1984ad96090aSBlue Swirl QEMU_ARCH_ALL) 19855824d651Sblueswir1STEXI 19865824d651Sblueswir1@item -parallel @var{dev} 19876616b2adSStefan Weil@findex -parallel 19885824d651Sblueswir1Redirect the virtual parallel port to host device @var{dev} (same 19895824d651Sblueswir1devices as the serial port). On Linux hosts, @file{/dev/parportN} can 19905824d651Sblueswir1be used to use hardware devices connected on the corresponding host 19915824d651Sblueswir1parallel port. 19925824d651Sblueswir1 19935824d651Sblueswir1This option can be used several times to simulate up to 3 parallel 19945824d651Sblueswir1ports. 19955824d651Sblueswir1 19965824d651Sblueswir1Use @code{-parallel none} to disable all parallel ports. 19975824d651Sblueswir1ETEXI 19985824d651Sblueswir1 19995824d651Sblueswir1DEF("monitor", HAS_ARG, QEMU_OPTION_monitor, \ 2000ad96090aSBlue Swirl "-monitor dev redirect the monitor to char device 'dev'\n", 2001ad96090aSBlue Swirl QEMU_ARCH_ALL) 20025824d651Sblueswir1STEXI 20034e307fc8SGerd Hoffmann@item -monitor @var{dev} 20046616b2adSStefan Weil@findex -monitor 20055824d651Sblueswir1Redirect the monitor to host device @var{dev} (same devices as the 20065824d651Sblueswir1serial port). 20075824d651Sblueswir1The default device is @code{vc} in graphical mode and @code{stdio} in 20085824d651Sblueswir1non graphical mode. 20095824d651Sblueswir1ETEXI 20106ca5582dSGerd HoffmannDEF("qmp", HAS_ARG, QEMU_OPTION_qmp, \ 2011ad96090aSBlue Swirl "-qmp dev like -monitor but opens in 'control' mode\n", 2012ad96090aSBlue Swirl QEMU_ARCH_ALL) 201395d5f08bSStefan WeilSTEXI 201495d5f08bSStefan Weil@item -qmp @var{dev} 20156616b2adSStefan Weil@findex -qmp 201695d5f08bSStefan WeilLike -monitor but opens in 'control' mode. 201795d5f08bSStefan WeilETEXI 20185824d651Sblueswir1 201922a0e04bSGerd HoffmannDEF("mon", HAS_ARG, QEMU_OPTION_mon, \ 2020ad96090aSBlue Swirl "-mon chardev=[name][,mode=readline|control][,default]\n", QEMU_ARCH_ALL) 202122a0e04bSGerd HoffmannSTEXI 202222a0e04bSGerd Hoffmann@item -mon chardev=[name][,mode=readline|control][,default] 20236616b2adSStefan Weil@findex -mon 202422a0e04bSGerd HoffmannSetup monitor on chardev @var{name}. 202522a0e04bSGerd HoffmannETEXI 202622a0e04bSGerd Hoffmann 2027c9f398e5SH. Peter AnvinDEF("debugcon", HAS_ARG, QEMU_OPTION_debugcon, \ 2028ad96090aSBlue Swirl "-debugcon dev redirect the debug console to char device 'dev'\n", 2029ad96090aSBlue Swirl QEMU_ARCH_ALL) 2030c9f398e5SH. Peter AnvinSTEXI 2031c9f398e5SH. Peter Anvin@item -debugcon @var{dev} 20326616b2adSStefan Weil@findex -debugcon 2033c9f398e5SH. Peter AnvinRedirect the debug console to host device @var{dev} (same devices as the 2034c9f398e5SH. Peter Anvinserial port). The debug console is an I/O port which is typically port 2035c9f398e5SH. Peter Anvin0xe9; writing to that I/O port sends output to this device. 2036c9f398e5SH. Peter AnvinThe default device is @code{vc} in graphical mode and @code{stdio} in 2037c9f398e5SH. Peter Anvinnon graphical mode. 2038c9f398e5SH. Peter AnvinETEXI 2039c9f398e5SH. Peter Anvin 20405824d651Sblueswir1DEF("pidfile", HAS_ARG, QEMU_OPTION_pidfile, \ 2041ad96090aSBlue Swirl "-pidfile file write PID to 'file'\n", QEMU_ARCH_ALL) 20425824d651Sblueswir1STEXI 20435824d651Sblueswir1@item -pidfile @var{file} 20446616b2adSStefan Weil@findex -pidfile 20455824d651Sblueswir1Store the QEMU process PID in @var{file}. It is useful if you launch QEMU 20465824d651Sblueswir1from a script. 20475824d651Sblueswir1ETEXI 20485824d651Sblueswir1 20491b530a6dSaurel32DEF("singlestep", 0, QEMU_OPTION_singlestep, \ 2050ad96090aSBlue Swirl "-singlestep always run in singlestep mode\n", QEMU_ARCH_ALL) 20511b530a6dSaurel32STEXI 20521b530a6dSaurel32@item -singlestep 20536616b2adSStefan Weil@findex -singlestep 20541b530a6dSaurel32Run the emulation in single step mode. 20551b530a6dSaurel32ETEXI 20561b530a6dSaurel32 20575824d651Sblueswir1DEF("S", 0, QEMU_OPTION_S, \ 2058ad96090aSBlue Swirl "-S freeze CPU at startup (use 'c' to start execution)\n", 2059ad96090aSBlue Swirl QEMU_ARCH_ALL) 20605824d651Sblueswir1STEXI 20615824d651Sblueswir1@item -S 20626616b2adSStefan Weil@findex -S 20635824d651Sblueswir1Do not start CPU at startup (you must type 'c' in the monitor). 20645824d651Sblueswir1ETEXI 20655824d651Sblueswir1 206659030a8cSaliguoriDEF("gdb", HAS_ARG, QEMU_OPTION_gdb, \ 2067ad96090aSBlue Swirl "-gdb dev wait for gdb connection on 'dev'\n", QEMU_ARCH_ALL) 20685824d651Sblueswir1STEXI 206959030a8cSaliguori@item -gdb @var{dev} 20706616b2adSStefan Weil@findex -gdb 207159030a8cSaliguoriWait for gdb connection on device @var{dev} (@pxref{gdb_usage}). Typical 207259030a8cSaliguoriconnections will likely be TCP-based, but also UDP, pseudo TTY, or even 207359030a8cSaliguoristdio are reasonable use case. The latter is allowing to start qemu from 207459030a8cSaliguoriwithin gdb and establish the connection via a pipe: 207559030a8cSaliguori@example 207659030a8cSaliguori(gdb) target remote | exec qemu -gdb stdio ... 207759030a8cSaliguori@end example 20785824d651Sblueswir1ETEXI 20795824d651Sblueswir1 208059030a8cSaliguoriDEF("s", 0, QEMU_OPTION_s, \ 2081ad96090aSBlue Swirl "-s shorthand for -gdb tcp::" DEFAULT_GDBSTUB_PORT "\n", 2082ad96090aSBlue Swirl QEMU_ARCH_ALL) 20835824d651Sblueswir1STEXI 208459030a8cSaliguori@item -s 20856616b2adSStefan Weil@findex -s 208659030a8cSaliguoriShorthand for -gdb tcp::1234, i.e. open a gdbserver on TCP port 1234 208759030a8cSaliguori(@pxref{gdb_usage}). 20885824d651Sblueswir1ETEXI 20895824d651Sblueswir1 20905824d651Sblueswir1DEF("d", HAS_ARG, QEMU_OPTION_d, \ 2091ad96090aSBlue Swirl "-d item1,... output log to /tmp/qemu.log (use -d ? for a list of log items)\n", 2092ad96090aSBlue Swirl QEMU_ARCH_ALL) 20935824d651Sblueswir1STEXI 20945824d651Sblueswir1@item -d 20956616b2adSStefan Weil@findex -d 20965824d651Sblueswir1Output log in /tmp/qemu.log 20975824d651Sblueswir1ETEXI 20985824d651Sblueswir1 2099c235d738SMatthew FernandezDEF("D", HAS_ARG, QEMU_OPTION_D, \ 2100c235d738SMatthew Fernandez "-D logfile output log to logfile (instead of the default /tmp/qemu.log)\n", 2101c235d738SMatthew Fernandez QEMU_ARCH_ALL) 2102c235d738SMatthew FernandezSTEXI 2103c235d738SMatthew Fernandez@item -D 2104c235d738SMatthew Fernandez@findex -D 2105c235d738SMatthew FernandezOutput log in logfile instead of /tmp/qemu.log 2106c235d738SMatthew FernandezETEXI 2107c235d738SMatthew Fernandez 21085824d651Sblueswir1DEF("hdachs", HAS_ARG, QEMU_OPTION_hdachs, \ 21095824d651Sblueswir1 "-hdachs c,h,s[,t]\n" \ 21105824d651Sblueswir1 " force hard disk 0 physical geometry and the optional BIOS\n" \ 2111ad96090aSBlue Swirl " translation (t=none or lba) (usually qemu can guess them)\n", 2112ad96090aSBlue Swirl QEMU_ARCH_ALL) 21135824d651Sblueswir1STEXI 21145824d651Sblueswir1@item -hdachs @var{c},@var{h},@var{s},[,@var{t}] 21156616b2adSStefan Weil@findex -hdachs 21165824d651Sblueswir1Force hard disk 0 physical geometry (1 <= @var{c} <= 16383, 1 <= 21175824d651Sblueswir1@var{h} <= 16, 1 <= @var{s} <= 63) and optionally force the BIOS 21185824d651Sblueswir1translation mode (@var{t}=none, lba or auto). Usually QEMU can guess 21195824d651Sblueswir1all those parameters. This option is useful for old MS-DOS disk 21205824d651Sblueswir1images. 21215824d651Sblueswir1ETEXI 21225824d651Sblueswir1 21235824d651Sblueswir1DEF("L", HAS_ARG, QEMU_OPTION_L, \ 2124ad96090aSBlue Swirl "-L path set the directory for the BIOS, VGA BIOS and keymaps\n", 2125ad96090aSBlue Swirl QEMU_ARCH_ALL) 21265824d651Sblueswir1STEXI 21275824d651Sblueswir1@item -L @var{path} 21286616b2adSStefan Weil@findex -L 21295824d651Sblueswir1Set the directory for the BIOS, VGA BIOS and keymaps. 21305824d651Sblueswir1ETEXI 21315824d651Sblueswir1 21325824d651Sblueswir1DEF("bios", HAS_ARG, QEMU_OPTION_bios, \ 2133ad96090aSBlue Swirl "-bios file set the filename for the BIOS\n", QEMU_ARCH_ALL) 21345824d651Sblueswir1STEXI 21355824d651Sblueswir1@item -bios @var{file} 21366616b2adSStefan Weil@findex -bios 21375824d651Sblueswir1Set the filename for the BIOS. 21385824d651Sblueswir1ETEXI 21395824d651Sblueswir1 21405824d651Sblueswir1DEF("enable-kvm", 0, QEMU_OPTION_enable_kvm, \ 2141ad96090aSBlue Swirl "-enable-kvm enable KVM full virtualization support\n", QEMU_ARCH_ALL) 21425824d651Sblueswir1STEXI 21435824d651Sblueswir1@item -enable-kvm 21446616b2adSStefan Weil@findex -enable-kvm 21455824d651Sblueswir1Enable KVM full virtualization support. This option is only available 21465824d651Sblueswir1if KVM support is enabled when compiling. 21475824d651Sblueswir1ETEXI 21485824d651Sblueswir1 2149e37630caSaliguoriDEF("xen-domid", HAS_ARG, QEMU_OPTION_xen_domid, 2150ad96090aSBlue Swirl "-xen-domid id specify xen guest domain id\n", QEMU_ARCH_ALL) 2151e37630caSaliguoriDEF("xen-create", 0, QEMU_OPTION_xen_create, 2152e37630caSaliguori "-xen-create create domain using xen hypercalls, bypassing xend\n" 2153ad96090aSBlue Swirl " warning: should not be used when xend is in use\n", 2154ad96090aSBlue Swirl QEMU_ARCH_ALL) 2155e37630caSaliguoriDEF("xen-attach", 0, QEMU_OPTION_xen_attach, 2156e37630caSaliguori "-xen-attach attach to existing xen domain\n" 2157ad96090aSBlue Swirl " xend will use this when starting qemu\n", 2158ad96090aSBlue Swirl QEMU_ARCH_ALL) 215995d5f08bSStefan WeilSTEXI 216095d5f08bSStefan Weil@item -xen-domid @var{id} 21616616b2adSStefan Weil@findex -xen-domid 216295d5f08bSStefan WeilSpecify xen guest domain @var{id} (XEN only). 216395d5f08bSStefan Weil@item -xen-create 21646616b2adSStefan Weil@findex -xen-create 216595d5f08bSStefan WeilCreate domain using xen hypercalls, bypassing xend. 216695d5f08bSStefan WeilWarning: should not be used when xend is in use (XEN only). 216795d5f08bSStefan Weil@item -xen-attach 21686616b2adSStefan Weil@findex -xen-attach 216995d5f08bSStefan WeilAttach to existing xen domain. 217095d5f08bSStefan Weilxend will use this when starting qemu (XEN only). 217195d5f08bSStefan WeilETEXI 2172e37630caSaliguori 21735824d651Sblueswir1DEF("no-reboot", 0, QEMU_OPTION_no_reboot, \ 2174ad96090aSBlue Swirl "-no-reboot exit instead of rebooting\n", QEMU_ARCH_ALL) 21755824d651Sblueswir1STEXI 21765824d651Sblueswir1@item -no-reboot 21776616b2adSStefan Weil@findex -no-reboot 21785824d651Sblueswir1Exit instead of rebooting. 21795824d651Sblueswir1ETEXI 21805824d651Sblueswir1 21815824d651Sblueswir1DEF("no-shutdown", 0, QEMU_OPTION_no_shutdown, \ 2182ad96090aSBlue Swirl "-no-shutdown stop before shutdown\n", QEMU_ARCH_ALL) 21835824d651Sblueswir1STEXI 21845824d651Sblueswir1@item -no-shutdown 21856616b2adSStefan Weil@findex -no-shutdown 21865824d651Sblueswir1Don't exit QEMU on guest shutdown, but instead only stop the emulation. 21875824d651Sblueswir1This allows for instance switching to monitor to commit changes to the 21885824d651Sblueswir1disk image. 21895824d651Sblueswir1ETEXI 21905824d651Sblueswir1 21915824d651Sblueswir1DEF("loadvm", HAS_ARG, QEMU_OPTION_loadvm, \ 21925824d651Sblueswir1 "-loadvm [tag|id]\n" \ 2193ad96090aSBlue Swirl " start right away with a saved state (loadvm in monitor)\n", 2194ad96090aSBlue Swirl QEMU_ARCH_ALL) 21955824d651Sblueswir1STEXI 21965824d651Sblueswir1@item -loadvm @var{file} 21976616b2adSStefan Weil@findex -loadvm 21985824d651Sblueswir1Start right away with a saved state (@code{loadvm} in monitor) 21995824d651Sblueswir1ETEXI 22005824d651Sblueswir1 22015824d651Sblueswir1#ifndef _WIN32 22025824d651Sblueswir1DEF("daemonize", 0, QEMU_OPTION_daemonize, \ 2203ad96090aSBlue Swirl "-daemonize daemonize QEMU after initializing\n", QEMU_ARCH_ALL) 22045824d651Sblueswir1#endif 22055824d651Sblueswir1STEXI 22065824d651Sblueswir1@item -daemonize 22076616b2adSStefan Weil@findex -daemonize 22085824d651Sblueswir1Daemonize the QEMU process after initialization. QEMU will not detach from 22095824d651Sblueswir1standard IO until it is ready to receive connections on any of its devices. 22105824d651Sblueswir1This option is a useful way for external programs to launch QEMU without having 22115824d651Sblueswir1to cope with initialization race conditions. 22125824d651Sblueswir1ETEXI 22135824d651Sblueswir1 22145824d651Sblueswir1DEF("option-rom", HAS_ARG, QEMU_OPTION_option_rom, \ 2215ad96090aSBlue Swirl "-option-rom rom load a file, rom, into the option ROM space\n", 2216ad96090aSBlue Swirl QEMU_ARCH_ALL) 22175824d651Sblueswir1STEXI 22185824d651Sblueswir1@item -option-rom @var{file} 22196616b2adSStefan Weil@findex -option-rom 22205824d651Sblueswir1Load the contents of @var{file} as an option ROM. 22215824d651Sblueswir1This option is useful to load things like EtherBoot. 22225824d651Sblueswir1ETEXI 22235824d651Sblueswir1 22245824d651Sblueswir1DEF("clock", HAS_ARG, QEMU_OPTION_clock, \ 22255824d651Sblueswir1 "-clock force the use of the given methods for timer alarm.\n" \ 2226ad96090aSBlue Swirl " To see what timers are available use -clock ?\n", 2227ad96090aSBlue Swirl QEMU_ARCH_ALL) 22285824d651Sblueswir1STEXI 22295824d651Sblueswir1@item -clock @var{method} 22306616b2adSStefan Weil@findex -clock 22315824d651Sblueswir1Force the use of the given methods for timer alarm. To see what timers 22325824d651Sblueswir1are available use -clock ?. 22335824d651Sblueswir1ETEXI 22345824d651Sblueswir1 22351ed2fc1fSJan KiszkaHXCOMM Options deprecated by -rtc 2236ad96090aSBlue SwirlDEF("localtime", 0, QEMU_OPTION_localtime, "", QEMU_ARCH_ALL) 2237ad96090aSBlue SwirlDEF("startdate", HAS_ARG, QEMU_OPTION_startdate, "", QEMU_ARCH_ALL) 22385824d651Sblueswir1 22391ed2fc1fSJan KiszkaDEF("rtc", HAS_ARG, QEMU_OPTION_rtc, \ 22406875204cSJan Kiszka "-rtc [base=utc|localtime|date][,clock=host|vm][,driftfix=none|slew]\n" \ 2241ad96090aSBlue Swirl " set the RTC base and clock, enable drift fix for clock ticks (x86 only)\n", 2242ad96090aSBlue Swirl QEMU_ARCH_ALL) 22431ed2fc1fSJan Kiszka 22445824d651Sblueswir1STEXI 22455824d651Sblueswir1 22466875204cSJan Kiszka@item -rtc [base=utc|localtime|@var{date}][,clock=host|vm][,driftfix=none|slew] 22476616b2adSStefan Weil@findex -rtc 22481ed2fc1fSJan KiszkaSpecify @option{base} as @code{utc} or @code{localtime} to let the RTC start at the current 22491ed2fc1fSJan KiszkaUTC or local time, respectively. @code{localtime} is required for correct date in 22501ed2fc1fSJan KiszkaMS-DOS or Windows. To start at a specific point in time, provide @var{date} in the 22511ed2fc1fSJan Kiszkaformat @code{2006-06-17T16:01:21} or @code{2006-06-17}. The default base is UTC. 22521ed2fc1fSJan Kiszka 22536875204cSJan KiszkaBy default the RTC is driven by the host system time. This allows to use the 22546875204cSJan KiszkaRTC as accurate reference clock inside the guest, specifically if the host 22556875204cSJan Kiszkatime is smoothly following an accurate external reference clock, e.g. via NTP. 22566875204cSJan KiszkaIf you want to isolate the guest time from the host, even prevent it from 22576875204cSJan Kiszkaprogressing during suspension, you can set @option{clock} to @code{vm} instead. 22586875204cSJan Kiszka 22591ed2fc1fSJan KiszkaEnable @option{driftfix} (i386 targets only) if you experience time drift problems, 22601ed2fc1fSJan Kiszkaspecifically with Windows' ACPI HAL. This option will try to figure out how 22611ed2fc1fSJan Kiszkamany timer interrupts were not processed by the Windows guest and will 22621ed2fc1fSJan Kiszkare-inject them. 22635824d651Sblueswir1ETEXI 22645824d651Sblueswir1 22655824d651Sblueswir1DEF("icount", HAS_ARG, QEMU_OPTION_icount, \ 22665824d651Sblueswir1 "-icount [N|auto]\n" \ 2267bc14ca24Saliguori " enable virtual instruction counter with 2^N clock ticks per\n" \ 2268ad96090aSBlue Swirl " instruction\n", QEMU_ARCH_ALL) 22695824d651Sblueswir1STEXI 22704e257e5eSKevin Wolf@item -icount [@var{N}|auto] 22716616b2adSStefan Weil@findex -icount 22725824d651Sblueswir1Enable virtual instruction counter. The virtual cpu will execute one 22734e257e5eSKevin Wolfinstruction every 2^@var{N} ns of virtual time. If @code{auto} is specified 22745824d651Sblueswir1then the virtual cpu speed will be automatically adjusted to keep virtual 22755824d651Sblueswir1time within a few seconds of real time. 22765824d651Sblueswir1 22775824d651Sblueswir1Note that while this option can give deterministic behavior, it does not 22785824d651Sblueswir1provide cycle accurate emulation. Modern CPUs contain superscalar out of 22795824d651Sblueswir1order cores with complex cache hierarchies. The number of instructions 22805824d651Sblueswir1executed often has little or no correlation with actual performance. 22815824d651Sblueswir1ETEXI 22825824d651Sblueswir1 22839dd986ccSRichard W.M. JonesDEF("watchdog", HAS_ARG, QEMU_OPTION_watchdog, \ 22849dd986ccSRichard W.M. Jones "-watchdog i6300esb|ib700\n" \ 2285ad96090aSBlue Swirl " enable virtual hardware watchdog [default=none]\n", 2286ad96090aSBlue Swirl QEMU_ARCH_ALL) 22879dd986ccSRichard W.M. JonesSTEXI 22889dd986ccSRichard W.M. Jones@item -watchdog @var{model} 22896616b2adSStefan Weil@findex -watchdog 22909dd986ccSRichard W.M. JonesCreate a virtual hardware watchdog device. Once enabled (by a guest 22919dd986ccSRichard W.M. Jonesaction), the watchdog must be periodically polled by an agent inside 22929dd986ccSRichard W.M. Jonesthe guest or else the guest will be restarted. 22939dd986ccSRichard W.M. Jones 22949dd986ccSRichard W.M. JonesThe @var{model} is the model of hardware watchdog to emulate. Choices 22959dd986ccSRichard W.M. Jonesfor model are: @code{ib700} (iBASE 700) which is a very simple ISA 22969dd986ccSRichard W.M. Joneswatchdog with a single timer, or @code{i6300esb} (Intel 6300ESB I/O 22979dd986ccSRichard W.M. Jonescontroller hub) which is a much more featureful PCI-based dual-timer 22989dd986ccSRichard W.M. Joneswatchdog. Choose a model for which your guest has drivers. 22999dd986ccSRichard W.M. Jones 23009dd986ccSRichard W.M. JonesUse @code{-watchdog ?} to list available hardware models. Only one 23019dd986ccSRichard W.M. Joneswatchdog can be enabled for a guest. 23029dd986ccSRichard W.M. JonesETEXI 23039dd986ccSRichard W.M. Jones 23049dd986ccSRichard W.M. JonesDEF("watchdog-action", HAS_ARG, QEMU_OPTION_watchdog_action, \ 23059dd986ccSRichard W.M. Jones "-watchdog-action reset|shutdown|poweroff|pause|debug|none\n" \ 2306ad96090aSBlue Swirl " action when watchdog fires [default=reset]\n", 2307ad96090aSBlue Swirl QEMU_ARCH_ALL) 23089dd986ccSRichard W.M. JonesSTEXI 23099dd986ccSRichard W.M. Jones@item -watchdog-action @var{action} 23109dd986ccSRichard W.M. Jones 23119dd986ccSRichard W.M. JonesThe @var{action} controls what QEMU will do when the watchdog timer 23129dd986ccSRichard W.M. Jonesexpires. 23139dd986ccSRichard W.M. JonesThe default is 23149dd986ccSRichard W.M. Jones@code{reset} (forcefully reset the guest). 23159dd986ccSRichard W.M. JonesOther possible actions are: 23169dd986ccSRichard W.M. Jones@code{shutdown} (attempt to gracefully shutdown the guest), 23179dd986ccSRichard W.M. Jones@code{poweroff} (forcefully poweroff the guest), 23189dd986ccSRichard W.M. Jones@code{pause} (pause the guest), 23199dd986ccSRichard W.M. Jones@code{debug} (print a debug message and continue), or 23209dd986ccSRichard W.M. Jones@code{none} (do nothing). 23219dd986ccSRichard W.M. Jones 23229dd986ccSRichard W.M. JonesNote that the @code{shutdown} action requires that the guest responds 23239dd986ccSRichard W.M. Jonesto ACPI signals, which it may not be able to do in the sort of 23249dd986ccSRichard W.M. Jonessituations where the watchdog would have expired, and thus 23259dd986ccSRichard W.M. Jones@code{-watchdog-action shutdown} is not recommended for production use. 23269dd986ccSRichard W.M. Jones 23279dd986ccSRichard W.M. JonesExamples: 23289dd986ccSRichard W.M. Jones 23299dd986ccSRichard W.M. Jones@table @code 23309dd986ccSRichard W.M. Jones@item -watchdog i6300esb -watchdog-action pause 23319dd986ccSRichard W.M. Jones@item -watchdog ib700 23329dd986ccSRichard W.M. Jones@end table 23339dd986ccSRichard W.M. JonesETEXI 23349dd986ccSRichard W.M. Jones 23355824d651Sblueswir1DEF("echr", HAS_ARG, QEMU_OPTION_echr, \ 2336ad96090aSBlue Swirl "-echr chr set terminal escape character instead of ctrl-a\n", 2337ad96090aSBlue Swirl QEMU_ARCH_ALL) 23385824d651Sblueswir1STEXI 23395824d651Sblueswir1 23404e257e5eSKevin Wolf@item -echr @var{numeric_ascii_value} 23416616b2adSStefan Weil@findex -echr 23425824d651Sblueswir1Change the escape character used for switching to the monitor when using 23435824d651Sblueswir1monitor and serial sharing. The default is @code{0x01} when using the 23445824d651Sblueswir1@code{-nographic} option. @code{0x01} is equal to pressing 23455824d651Sblueswir1@code{Control-a}. You can select a different character from the ascii 23465824d651Sblueswir1control keys where 1 through 26 map to Control-a through Control-z. For 23475824d651Sblueswir1instance you could use the either of the following to change the escape 23485824d651Sblueswir1character to Control-t. 23495824d651Sblueswir1@table @code 23505824d651Sblueswir1@item -echr 0x14 23515824d651Sblueswir1@item -echr 20 23525824d651Sblueswir1@end table 23535824d651Sblueswir1ETEXI 23545824d651Sblueswir1 23555824d651Sblueswir1DEF("virtioconsole", HAS_ARG, QEMU_OPTION_virtiocon, \ 23565824d651Sblueswir1 "-virtioconsole c\n" \ 2357ad96090aSBlue Swirl " set virtio console\n", QEMU_ARCH_ALL) 23585824d651Sblueswir1STEXI 23595824d651Sblueswir1@item -virtioconsole @var{c} 23606616b2adSStefan Weil@findex -virtioconsole 23615824d651Sblueswir1Set virtio console. 236298b19252SAmit Shah 236398b19252SAmit ShahThis option is maintained for backward compatibility. 236498b19252SAmit Shah 236598b19252SAmit ShahPlease use @code{-device virtconsole} for the new way of invocation. 23665824d651Sblueswir1ETEXI 23675824d651Sblueswir1 23685824d651Sblueswir1DEF("show-cursor", 0, QEMU_OPTION_show_cursor, \ 2369ad96090aSBlue Swirl "-show-cursor show cursor\n", QEMU_ARCH_ALL) 23705824d651Sblueswir1STEXI 237195d5f08bSStefan Weil@item -show-cursor 23726616b2adSStefan Weil@findex -show-cursor 237395d5f08bSStefan WeilShow cursor. 23745824d651Sblueswir1ETEXI 23755824d651Sblueswir1 23765824d651Sblueswir1DEF("tb-size", HAS_ARG, QEMU_OPTION_tb_size, \ 2377ad96090aSBlue Swirl "-tb-size n set TB size\n", QEMU_ARCH_ALL) 23785824d651Sblueswir1STEXI 237995d5f08bSStefan Weil@item -tb-size @var{n} 23806616b2adSStefan Weil@findex -tb-size 238195d5f08bSStefan WeilSet TB size. 23825824d651Sblueswir1ETEXI 23835824d651Sblueswir1 23845824d651Sblueswir1DEF("incoming", HAS_ARG, QEMU_OPTION_incoming, \ 2385ad96090aSBlue Swirl "-incoming p prepare for incoming migration, listen on port p\n", 2386ad96090aSBlue Swirl QEMU_ARCH_ALL) 23875824d651Sblueswir1STEXI 238895d5f08bSStefan Weil@item -incoming @var{port} 23896616b2adSStefan Weil@findex -incoming 239095d5f08bSStefan WeilPrepare for incoming migration, listen on @var{port}. 23915824d651Sblueswir1ETEXI 23925824d651Sblueswir1 2393d8c208ddSGerd HoffmannDEF("nodefaults", 0, QEMU_OPTION_nodefaults, \ 2394ad96090aSBlue Swirl "-nodefaults don't create default devices\n", QEMU_ARCH_ALL) 2395d8c208ddSGerd HoffmannSTEXI 23963dbf2c7fSStefan Weil@item -nodefaults 23976616b2adSStefan Weil@findex -nodefaults 23983dbf2c7fSStefan WeilDon't create default devices. 2399d8c208ddSGerd HoffmannETEXI 2400d8c208ddSGerd Hoffmann 24015824d651Sblueswir1#ifndef _WIN32 24025824d651Sblueswir1DEF("chroot", HAS_ARG, QEMU_OPTION_chroot, \ 2403ad96090aSBlue Swirl "-chroot dir chroot to dir just before starting the VM\n", 2404ad96090aSBlue Swirl QEMU_ARCH_ALL) 24055824d651Sblueswir1#endif 24065824d651Sblueswir1STEXI 24074e257e5eSKevin Wolf@item -chroot @var{dir} 24086616b2adSStefan Weil@findex -chroot 24095824d651Sblueswir1Immediately before starting guest execution, chroot to the specified 24105824d651Sblueswir1directory. Especially useful in combination with -runas. 24115824d651Sblueswir1ETEXI 24125824d651Sblueswir1 24135824d651Sblueswir1#ifndef _WIN32 24145824d651Sblueswir1DEF("runas", HAS_ARG, QEMU_OPTION_runas, \ 2415ad96090aSBlue Swirl "-runas user change to user id user just before starting the VM\n", 2416ad96090aSBlue Swirl QEMU_ARCH_ALL) 24175824d651Sblueswir1#endif 24185824d651Sblueswir1STEXI 24194e257e5eSKevin Wolf@item -runas @var{user} 24206616b2adSStefan Weil@findex -runas 24215824d651Sblueswir1Immediately before starting guest execution, drop root privileges, switching 24225824d651Sblueswir1to the specified user. 24235824d651Sblueswir1ETEXI 24245824d651Sblueswir1 24255824d651Sblueswir1DEF("prom-env", HAS_ARG, QEMU_OPTION_prom_env, 24265824d651Sblueswir1 "-prom-env variable=value\n" 2427ad96090aSBlue Swirl " set OpenBIOS nvram variables\n", 2428ad96090aSBlue Swirl QEMU_ARCH_PPC | QEMU_ARCH_SPARC) 242995d5f08bSStefan WeilSTEXI 243095d5f08bSStefan Weil@item -prom-env @var{variable}=@var{value} 24316616b2adSStefan Weil@findex -prom-env 243295d5f08bSStefan WeilSet OpenBIOS nvram @var{variable} to given @var{value} (PPC, SPARC only). 243395d5f08bSStefan WeilETEXI 24345824d651Sblueswir1DEF("semihosting", 0, QEMU_OPTION_semihosting, 24351ddeaa5dSMax Filippov "-semihosting semihosting mode\n", QEMU_ARCH_ARM | QEMU_ARCH_M68K | QEMU_ARCH_XTENSA) 243695d5f08bSStefan WeilSTEXI 243795d5f08bSStefan Weil@item -semihosting 24386616b2adSStefan Weil@findex -semihosting 24391ddeaa5dSMax FilippovSemihosting mode (ARM, M68K, Xtensa only). 244095d5f08bSStefan WeilETEXI 24415824d651Sblueswir1DEF("old-param", 0, QEMU_OPTION_old_param, 2442ad96090aSBlue Swirl "-old-param old param mode\n", QEMU_ARCH_ARM) 244395d5f08bSStefan WeilSTEXI 244495d5f08bSStefan Weil@item -old-param 24456616b2adSStefan Weil@findex -old-param (ARM) 244695d5f08bSStefan WeilOld param mode (ARM only). 244795d5f08bSStefan WeilETEXI 244895d5f08bSStefan Weil 2449715a664aSGerd HoffmannDEF("readconfig", HAS_ARG, QEMU_OPTION_readconfig, 2450ad96090aSBlue Swirl "-readconfig <file>\n", QEMU_ARCH_ALL) 24513dbf2c7fSStefan WeilSTEXI 24523dbf2c7fSStefan Weil@item -readconfig @var{file} 24536616b2adSStefan Weil@findex -readconfig 24543dbf2c7fSStefan WeilRead device configuration from @var{file}. 24553dbf2c7fSStefan WeilETEXI 2456715a664aSGerd HoffmannDEF("writeconfig", HAS_ARG, QEMU_OPTION_writeconfig, 2457715a664aSGerd Hoffmann "-writeconfig <file>\n" 2458ad96090aSBlue Swirl " read/write config file\n", QEMU_ARCH_ALL) 24593dbf2c7fSStefan WeilSTEXI 24603dbf2c7fSStefan Weil@item -writeconfig @var{file} 24616616b2adSStefan Weil@findex -writeconfig 24623dbf2c7fSStefan WeilWrite device configuration to @var{file}. 24633dbf2c7fSStefan WeilETEXI 2464292444cbSAnthony LiguoriDEF("nodefconfig", 0, QEMU_OPTION_nodefconfig, 2465292444cbSAnthony Liguori "-nodefconfig\n" 2466ad96090aSBlue Swirl " do not load default config files at startup\n", 2467ad96090aSBlue Swirl QEMU_ARCH_ALL) 2468292444cbSAnthony LiguoriSTEXI 2469292444cbSAnthony Liguori@item -nodefconfig 24706616b2adSStefan Weil@findex -nodefconfig 2471292444cbSAnthony LiguoriNormally QEMU loads a configuration file from @var{sysconfdir}/qemu.conf and 2472292444cbSAnthony Liguori@var{sysconfdir}/target-@var{ARCH}.conf on startup. The @code{-nodefconfig} 2473292444cbSAnthony Liguorioption will prevent QEMU from loading these configuration files at startup. 2474292444cbSAnthony LiguoriETEXI 2475ab6540d5SPrerna SaxenaDEF("trace", HAS_ARG, QEMU_OPTION_trace, 247623d15e86SLluís "-trace [events=<file>][,file=<file>]\n" 247723d15e86SLluís " specify tracing options\n", 2478ab6540d5SPrerna Saxena QEMU_ARCH_ALL) 2479ab6540d5SPrerna SaxenaSTEXI 248023d15e86SLluísHXCOMM This line is not accurate, as some sub-options are backend-specific but 248123d15e86SLluísHXCOMM HX does not support conditional compilation of text. 248223d15e86SLluís@item -trace [events=@var{file}][,file=@var{file}] 2483ab6540d5SPrerna Saxena@findex -trace 2484e4858974SLluís 248523d15e86SLluísSpecify tracing options. 248623d15e86SLluís 248723d15e86SLluís@table @option 248823d15e86SLluís@item events=@var{file} 248923d15e86SLluísImmediately enable events listed in @var{file}. 249023d15e86SLluísThe file must contain one event name (as listed in the @var{trace-events} file) 249123d15e86SLluísper line. 2492c1ba4e0bSStefan WeilThis option is only available if QEMU has been compiled with 2493c1ba4e0bSStefan Weileither @var{simple} or @var{stderr} tracing backend. 249423d15e86SLluís@item file=@var{file} 249523d15e86SLluísLog output traces to @var{file}. 249623d15e86SLluís 2497c1ba4e0bSStefan WeilThis option is only available if QEMU has been compiled with 2498c1ba4e0bSStefan Weilthe @var{simple} tracing backend. 249923d15e86SLluís@end table 2500ab6540d5SPrerna SaxenaETEXI 25013dbf2c7fSStefan Weil 25023dbf2c7fSStefan WeilHXCOMM This is the last statement. Insert new options before this line! 25033dbf2c7fSStefan WeilSTEXI 25043dbf2c7fSStefan Weil@end table 25053dbf2c7fSStefan WeilETEXI 2506