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" 138fb0490f6SStefan Hajnoczi " [,readonly=on|off][,copy-on-read=on|off]\n" 1390563e191SZhi Yong Wu " [[,bps=b]|[[,bps_rd=r][,bps_wr=w]]][[,iops=i]|[[,iops_rd=r][,iops_wr=w]]\n" 140ad96090aSBlue Swirl " use 'file' as a drive image\n", QEMU_ARCH_ALL) 1415824d651Sblueswir1STEXI 1425824d651Sblueswir1@item -drive @var{option}[,@var{option}[,@var{option}[,...]]] 1436616b2adSStefan Weil@findex -drive 1445824d651Sblueswir1 1455824d651Sblueswir1Define a new drive. Valid options are: 1465824d651Sblueswir1 147b3f046c2SKevin Wolf@table @option 1485824d651Sblueswir1@item file=@var{file} 1495824d651Sblueswir1This option defines which disk image (@pxref{disk_images}) to use with 1505824d651Sblueswir1this drive. If the filename contains comma, you must double it 1515824d651Sblueswir1(for instance, "file=my,,file" to use file "my,file"). 1520f5314a2SRonnie Sahlberg 1530f5314a2SRonnie SahlbergSpecial files such as iSCSI devices can be specified using protocol 1540f5314a2SRonnie Sahlbergspecific URLs. See the section for "Device URL Syntax" for more information. 1555824d651Sblueswir1@item if=@var{interface} 1565824d651Sblueswir1This option defines on which type on interface the drive is connected. 1575824d651Sblueswir1Available types are: ide, scsi, sd, mtd, floppy, pflash, virtio. 1585824d651Sblueswir1@item bus=@var{bus},unit=@var{unit} 1595824d651Sblueswir1These options define where is connected the drive by defining the bus number and 1605824d651Sblueswir1the unit id. 1615824d651Sblueswir1@item index=@var{index} 1625824d651Sblueswir1This option defines where is connected the drive by using an index in the list 1635824d651Sblueswir1of available connectors of a given interface type. 1645824d651Sblueswir1@item media=@var{media} 1655824d651Sblueswir1This option defines the type of the media: disk or cdrom. 1665824d651Sblueswir1@item cyls=@var{c},heads=@var{h},secs=@var{s}[,trans=@var{t}] 1675824d651Sblueswir1These options have the same definition as they have in @option{-hdachs}. 1685824d651Sblueswir1@item snapshot=@var{snapshot} 1695824d651Sblueswir1@var{snapshot} is "on" or "off" and allows to enable snapshot for given drive (see @option{-snapshot}). 1705824d651Sblueswir1@item cache=@var{cache} 17192196b2fSStefan Hajnoczi@var{cache} is "none", "writeback", "unsafe", "directsync" or "writethrough" and controls how the host cache is used to access block data. 1725c6c3a6cSChristoph Hellwig@item aio=@var{aio} 1735c6c3a6cSChristoph Hellwig@var{aio} is "threads", or "native" and selects between pthread based disk I/O and native Linux AIO. 1745824d651Sblueswir1@item format=@var{format} 1755824d651Sblueswir1Specify which disk @var{format} will be used rather than detecting 1765824d651Sblueswir1the format. Can be used to specifiy format=raw to avoid interpreting 1775824d651Sblueswir1an untrusted format header. 1785824d651Sblueswir1@item serial=@var{serial} 1795824d651Sblueswir1This option specifies the serial number to assign to the device. 180c2cc47a4SMarkus Armbruster@item addr=@var{addr} 181c2cc47a4SMarkus ArmbrusterSpecify the controller's PCI address (if=virtio only). 182ae73e591SLuiz Capitulino@item werror=@var{action},rerror=@var{action} 183ae73e591SLuiz CapitulinoSpecify which @var{action} to take on write and read errors. Valid actions are: 184ae73e591SLuiz Capitulino"ignore" (ignore the error and try to continue), "stop" (pause QEMU), 185ae73e591SLuiz Capitulino"report" (report the error to the guest), "enospc" (pause QEMU only if the 186ae73e591SLuiz Capitulinohost disk is full; report the error to the guest otherwise). 187ae73e591SLuiz CapitulinoThe default setting is @option{werror=enospc} and @option{rerror=report}. 188ae73e591SLuiz Capitulino@item readonly 189ae73e591SLuiz CapitulinoOpen drive @option{file} as read-only. Guest write attempts will fail. 190fb0490f6SStefan Hajnoczi@item copy-on-read=@var{copy-on-read} 191fb0490f6SStefan Hajnoczi@var{copy-on-read} is "on" or "off" and enables whether to copy read backing 192fb0490f6SStefan Hajnoczifile sectors into the image file. 1935824d651Sblueswir1@end table 1945824d651Sblueswir1 1955824d651Sblueswir1By default, writethrough caching is used for all block device. This means that 1965824d651Sblueswir1the host page cache will be used to read and write data but write notification 1975824d651Sblueswir1will be sent to the guest only when the data has been reported as written by 1985824d651Sblueswir1the storage subsystem. 1995824d651Sblueswir1 2005824d651Sblueswir1Writeback caching will report data writes as completed as soon as the data is 2015824d651Sblueswir1present in the host page cache. This is safe as long as you trust your host. 2025824d651Sblueswir1If your host crashes or loses power, then the guest may experience data 203c3177288SAlexander Grafcorruption. 2045824d651Sblueswir1 205c304d317SAurelien JarnoThe host page cache can be avoided entirely with @option{cache=none}. This will 2065824d651Sblueswir1attempt to do disk IO directly to the guests memory. QEMU may still perform 2075824d651Sblueswir1an internal copy of the data. 2085824d651Sblueswir1 20992196b2fSStefan HajnocziThe host page cache can be avoided while only sending write notifications to 21092196b2fSStefan Hajnoczithe guest when the data has been reported as written by the storage subsystem 21192196b2fSStefan Hajnocziusing @option{cache=directsync}. 21292196b2fSStefan Hajnoczi 2135824d651Sblueswir1Some block drivers perform badly with @option{cache=writethrough}, most notably, 2145824d651Sblueswir1qcow2. If performance is more important than correctness, 2150aa217e4SKevin Wolf@option{cache=writeback} should be used with qcow2. 2165824d651Sblueswir1 217016f5cf6SAlexander GrafIn case you don't care about data integrity over host failures, use 218016f5cf6SAlexander Grafcache=unsafe. This option tells qemu that it never needs to write any data 219016f5cf6SAlexander Grafto the disk but can instead keeps things in cache. If anything goes wrong, 220e7d81004SStefan Weillike your host losing power, the disk storage getting disconnected accidentally, 221c3177288SAlexander Grafetc. you're image will most probably be rendered unusable. When using 222c3177288SAlexander Grafthe @option{-snapshot} option, unsafe caching is always used. 223016f5cf6SAlexander Graf 224fb0490f6SStefan HajnocziCopy-on-read avoids accessing the same backing file sectors repeatedly and is 225fb0490f6SStefan Hajnocziuseful when the backing file is over a slow network. By default copy-on-read 226fb0490f6SStefan Hajnocziis off. 227fb0490f6SStefan Hajnoczi 2285824d651Sblueswir1Instead of @option{-cdrom} you can use: 2295824d651Sblueswir1@example 2305824d651Sblueswir1qemu -drive file=file,index=2,media=cdrom 2315824d651Sblueswir1@end example 2325824d651Sblueswir1 2335824d651Sblueswir1Instead of @option{-hda}, @option{-hdb}, @option{-hdc}, @option{-hdd}, you can 2345824d651Sblueswir1use: 2355824d651Sblueswir1@example 2365824d651Sblueswir1qemu -drive file=file,index=0,media=disk 2375824d651Sblueswir1qemu -drive file=file,index=1,media=disk 2385824d651Sblueswir1qemu -drive file=file,index=2,media=disk 2395824d651Sblueswir1qemu -drive file=file,index=3,media=disk 2405824d651Sblueswir1@end example 2415824d651Sblueswir1 2425824d651Sblueswir1You can connect a CDROM to the slave of ide0: 2435824d651Sblueswir1@example 2445824d651Sblueswir1qemu -drive file=file,if=ide,index=1,media=cdrom 2455824d651Sblueswir1@end example 2465824d651Sblueswir1 2475824d651Sblueswir1If you don't specify the "file=" argument, you define an empty drive: 2485824d651Sblueswir1@example 2495824d651Sblueswir1qemu -drive if=ide,index=1,media=cdrom 2505824d651Sblueswir1@end example 2515824d651Sblueswir1 2525824d651Sblueswir1You can connect a SCSI disk with unit ID 6 on the bus #0: 2535824d651Sblueswir1@example 2545824d651Sblueswir1qemu -drive file=file,if=scsi,bus=0,unit=6 2555824d651Sblueswir1@end example 2565824d651Sblueswir1 2575824d651Sblueswir1Instead of @option{-fda}, @option{-fdb}, you can use: 2585824d651Sblueswir1@example 2595824d651Sblueswir1qemu -drive file=file,index=0,if=floppy 2605824d651Sblueswir1qemu -drive file=file,index=1,if=floppy 2615824d651Sblueswir1@end example 2625824d651Sblueswir1 2635824d651Sblueswir1By default, @var{interface} is "ide" and @var{index} is automatically 2645824d651Sblueswir1incremented: 2655824d651Sblueswir1@example 2665824d651Sblueswir1qemu -drive file=a -drive file=b" 2675824d651Sblueswir1@end example 2685824d651Sblueswir1is interpreted like: 2695824d651Sblueswir1@example 2705824d651Sblueswir1qemu -hda a -hdb b 2715824d651Sblueswir1@end example 2725824d651Sblueswir1ETEXI 2735824d651Sblueswir1 2746616b2adSStefan WeilDEF("set", HAS_ARG, QEMU_OPTION_set, 2756616b2adSStefan Weil "-set group.id.arg=value\n" 2766616b2adSStefan Weil " set <arg> parameter for item <id> of type <group>\n" 277ad96090aSBlue Swirl " i.e. -set drive.$id.file=/path/to/image\n", QEMU_ARCH_ALL) 2786616b2adSStefan WeilSTEXI 2796616b2adSStefan Weil@item -set 2806616b2adSStefan Weil@findex -set 2816616b2adSStefan WeilTODO 2826616b2adSStefan WeilETEXI 2836616b2adSStefan Weil 2846616b2adSStefan WeilDEF("global", HAS_ARG, QEMU_OPTION_global, 2856616b2adSStefan Weil "-global driver.property=value\n" 286ad96090aSBlue Swirl " set a global default for a driver property\n", 287ad96090aSBlue Swirl QEMU_ARCH_ALL) 2886616b2adSStefan WeilSTEXI 2896616b2adSStefan Weil@item -global 2906616b2adSStefan Weil@findex -global 2916616b2adSStefan WeilTODO 2926616b2adSStefan WeilETEXI 2936616b2adSStefan Weil 2945824d651Sblueswir1DEF("mtdblock", HAS_ARG, QEMU_OPTION_mtdblock, 295ad96090aSBlue Swirl "-mtdblock file use 'file' as on-board Flash memory image\n", 296ad96090aSBlue Swirl QEMU_ARCH_ALL) 2975824d651Sblueswir1STEXI 2984e257e5eSKevin Wolf@item -mtdblock @var{file} 2996616b2adSStefan Weil@findex -mtdblock 3004e257e5eSKevin WolfUse @var{file} as on-board Flash memory image. 3015824d651Sblueswir1ETEXI 3025824d651Sblueswir1 3035824d651Sblueswir1DEF("sd", HAS_ARG, QEMU_OPTION_sd, 304ad96090aSBlue Swirl "-sd file use 'file' as SecureDigital card image\n", QEMU_ARCH_ALL) 3055824d651Sblueswir1STEXI 3064e257e5eSKevin Wolf@item -sd @var{file} 3076616b2adSStefan Weil@findex -sd 3084e257e5eSKevin WolfUse @var{file} as SecureDigital card image. 3095824d651Sblueswir1ETEXI 3105824d651Sblueswir1 3115824d651Sblueswir1DEF("pflash", HAS_ARG, QEMU_OPTION_pflash, 312ad96090aSBlue Swirl "-pflash file use 'file' as a parallel flash image\n", QEMU_ARCH_ALL) 3135824d651Sblueswir1STEXI 3144e257e5eSKevin Wolf@item -pflash @var{file} 3156616b2adSStefan Weil@findex -pflash 3164e257e5eSKevin WolfUse @var{file} as a parallel flash image. 3175824d651Sblueswir1ETEXI 3185824d651Sblueswir1 3195824d651Sblueswir1DEF("boot", HAS_ARG, QEMU_OPTION_boot, 3202221dde5SJan Kiszka "-boot [order=drives][,once=drives][,menu=on|off]\n" 3213d3b8303Swayne " [,splash=sp_name][,splash-time=sp_time]\n" 3223d3b8303Swayne " 'drives': floppy (a), hard disk (c), CD-ROM (d), network (n)\n" 3233d3b8303Swayne " 'sp_name': the file's name that would be passed to bios as logo picture, if menu=on\n" 3243d3b8303Swayne " 'sp_time': the period that splash picture last if menu=on, unit is ms\n", 325ad96090aSBlue Swirl QEMU_ARCH_ALL) 3265824d651Sblueswir1STEXI 3273d3b8303Swayne@item -boot [order=@var{drives}][,once=@var{drives}][,menu=on|off][,splash=@var{sp_name}][,splash-time=@var{sp_time}] 3286616b2adSStefan Weil@findex -boot 3292221dde5SJan KiszkaSpecify boot order @var{drives} as a string of drive letters. Valid 3302221dde5SJan Kiszkadrive letters depend on the target achitecture. The x86 PC uses: a, b 3312221dde5SJan Kiszka(floppy 1 and 2), c (first hard disk), d (first CD-ROM), n-p (Etherboot 3322221dde5SJan Kiszkafrom network adapter 1-4), hard disk boot is the default. To apply a 3332221dde5SJan Kiszkaparticular boot order only on the first startup, specify it via 3342221dde5SJan Kiszka@option{once}. 3352221dde5SJan Kiszka 3362221dde5SJan KiszkaInteractive boot menus/prompts can be enabled via @option{menu=on} as far 3372221dde5SJan Kiszkaas firmware/BIOS supports them. The default is non-interactive boot. 3382221dde5SJan Kiszka 3393d3b8303SwayneA splash picture could be passed to bios, enabling user to show it as logo, 3403d3b8303Swaynewhen option splash=@var{sp_name} is given and menu=on, If firmware/BIOS 3413d3b8303Swaynesupports them. Currently Seabios for X86 system support it. 3423d3b8303Swaynelimitation: The splash file could be a jpeg file or a BMP file in 24 BPP 3433d3b8303Swayneformat(true color). The resolution should be supported by the SVGA mode, so 3443d3b8303Swaynethe recommended is 320x240, 640x480, 800x640. 3453d3b8303Swayne 3462221dde5SJan Kiszka@example 3472221dde5SJan Kiszka# try to boot from network first, then from hard disk 3482221dde5SJan Kiszkaqemu -boot order=nc 3492221dde5SJan Kiszka# boot from CD-ROM first, switch back to default order after reboot 3502221dde5SJan Kiszkaqemu -boot once=d 3513d3b8303Swayne# boot with a splash picture for 5 seconds. 3523d3b8303Swayneqemu -boot menu=on,splash=/root/boot.bmp,splash-time=5000 3532221dde5SJan Kiszka@end example 3542221dde5SJan Kiszka 3552221dde5SJan KiszkaNote: The legacy format '-boot @var{drives}' is still supported but its 3562221dde5SJan Kiszkause is discouraged as it may be removed from future versions. 3575824d651Sblueswir1ETEXI 3585824d651Sblueswir1 3595824d651Sblueswir1DEF("snapshot", 0, QEMU_OPTION_snapshot, 360ad96090aSBlue Swirl "-snapshot write to temporary files instead of disk image files\n", 361ad96090aSBlue Swirl QEMU_ARCH_ALL) 3625824d651Sblueswir1STEXI 3635824d651Sblueswir1@item -snapshot 3646616b2adSStefan Weil@findex -snapshot 3655824d651Sblueswir1Write to temporary files instead of disk image files. In this case, 3665824d651Sblueswir1the raw disk image you use is not written back. You can however force 3675824d651Sblueswir1the write back by pressing @key{C-a s} (@pxref{disk_images}). 3685824d651Sblueswir1ETEXI 3695824d651Sblueswir1 3705824d651Sblueswir1DEF("m", HAS_ARG, QEMU_OPTION_m, 371bec7c2d4SPaolo Bonzini "-m megs set virtual RAM size to megs MB [default=" 372ad96090aSBlue Swirl stringify(DEFAULT_RAM_SIZE) "]\n", QEMU_ARCH_ALL) 3735824d651Sblueswir1STEXI 3745824d651Sblueswir1@item -m @var{megs} 3756616b2adSStefan Weil@findex -m 3765824d651Sblueswir1Set virtual RAM size to @var{megs} megabytes. Default is 128 MiB. Optionally, 3775824d651Sblueswir1a suffix of ``M'' or ``G'' can be used to signify a value in megabytes or 3785824d651Sblueswir1gigabytes respectively. 3795824d651Sblueswir1ETEXI 3805824d651Sblueswir1 381c902760fSMarcelo TosattiDEF("mem-path", HAS_ARG, QEMU_OPTION_mempath, 382ad96090aSBlue Swirl "-mem-path FILE provide backing storage for guest RAM\n", QEMU_ARCH_ALL) 383c902760fSMarcelo TosattiSTEXI 384c902760fSMarcelo Tosatti@item -mem-path @var{path} 385c902760fSMarcelo TosattiAllocate guest RAM from a temporarily created file in @var{path}. 386c902760fSMarcelo TosattiETEXI 387c902760fSMarcelo Tosatti 388c902760fSMarcelo Tosatti#ifdef MAP_POPULATE 389c902760fSMarcelo TosattiDEF("mem-prealloc", 0, QEMU_OPTION_mem_prealloc, 390ad96090aSBlue Swirl "-mem-prealloc preallocate guest memory (use with -mem-path)\n", 391ad96090aSBlue Swirl QEMU_ARCH_ALL) 392c902760fSMarcelo TosattiSTEXI 393c902760fSMarcelo Tosatti@item -mem-prealloc 394c902760fSMarcelo TosattiPreallocate memory when using -mem-path. 395c902760fSMarcelo TosattiETEXI 396c902760fSMarcelo Tosatti#endif 397c902760fSMarcelo Tosatti 3985824d651Sblueswir1DEF("k", HAS_ARG, QEMU_OPTION_k, 399ad96090aSBlue Swirl "-k language use keyboard layout (for example 'fr' for French)\n", 400ad96090aSBlue Swirl QEMU_ARCH_ALL) 4015824d651Sblueswir1STEXI 4025824d651Sblueswir1@item -k @var{language} 4036616b2adSStefan Weil@findex -k 4045824d651Sblueswir1Use keyboard layout @var{language} (for example @code{fr} for 4055824d651Sblueswir1French). This option is only needed where it is not easy to get raw PC 4065824d651Sblueswir1keycodes (e.g. on Macs, with some X11 servers or with a VNC 4075824d651Sblueswir1display). You don't normally need to use it on PC/Linux or PC/Windows 4085824d651Sblueswir1hosts. 4095824d651Sblueswir1 4105824d651Sblueswir1The available layouts are: 4115824d651Sblueswir1@example 4125824d651Sblueswir1ar de-ch es fo fr-ca hu ja mk no pt-br sv 4135824d651Sblueswir1da en-gb et fr fr-ch is lt nl pl ru th 4145824d651Sblueswir1de en-us fi fr-be hr it lv nl-be pt sl tr 4155824d651Sblueswir1@end example 4165824d651Sblueswir1 4175824d651Sblueswir1The default is @code{en-us}. 4185824d651Sblueswir1ETEXI 4195824d651Sblueswir1 4205824d651Sblueswir1 4215824d651Sblueswir1DEF("audio-help", 0, QEMU_OPTION_audio_help, 422ad96090aSBlue Swirl "-audio-help print list of audio drivers and their options\n", 423ad96090aSBlue Swirl QEMU_ARCH_ALL) 4245824d651Sblueswir1STEXI 4255824d651Sblueswir1@item -audio-help 4266616b2adSStefan Weil@findex -audio-help 4275824d651Sblueswir1Will show the audio subsystem help: list of drivers, tunable 4285824d651Sblueswir1parameters. 4295824d651Sblueswir1ETEXI 4305824d651Sblueswir1 4315824d651Sblueswir1DEF("soundhw", HAS_ARG, QEMU_OPTION_soundhw, 4325824d651Sblueswir1 "-soundhw c1,... enable audio support\n" 4335824d651Sblueswir1 " and only specified sound cards (comma separated list)\n" 4345824d651Sblueswir1 " use -soundhw ? to get the list of supported cards\n" 435ad96090aSBlue Swirl " use -soundhw all to enable all of them\n", QEMU_ARCH_ALL) 4365824d651Sblueswir1STEXI 4375824d651Sblueswir1@item -soundhw @var{card1}[,@var{card2},...] or -soundhw all 4386616b2adSStefan Weil@findex -soundhw 4395824d651Sblueswir1Enable audio and selected sound hardware. Use ? to print all 4405824d651Sblueswir1available sound hardware. 4415824d651Sblueswir1 4425824d651Sblueswir1@example 4435824d651Sblueswir1qemu -soundhw sb16,adlib disk.img 4445824d651Sblueswir1qemu -soundhw es1370 disk.img 4455824d651Sblueswir1qemu -soundhw ac97 disk.img 4467d72e762SGerd Hoffmannqemu -soundhw hda disk.img 4475824d651Sblueswir1qemu -soundhw all disk.img 4485824d651Sblueswir1qemu -soundhw ? 4495824d651Sblueswir1@end example 4505824d651Sblueswir1 4515824d651Sblueswir1Note that Linux's i810_audio OSS kernel (for AC97) module might 4525824d651Sblueswir1require manually specifying clocking. 4535824d651Sblueswir1 4545824d651Sblueswir1@example 4555824d651Sblueswir1modprobe i810_audio clocking=48000 4565824d651Sblueswir1@end example 4575824d651Sblueswir1ETEXI 4585824d651Sblueswir1 459*b1746dddSMichael EllermanDEF("balloon", HAS_ARG, QEMU_OPTION_balloon, 460*b1746dddSMichael Ellerman "-balloon none disable balloon device\n" 461*b1746dddSMichael Ellerman "-balloon virtio[,addr=str]\n" 462*b1746dddSMichael Ellerman " enable virtio balloon device (default)\n", QEMU_ARCH_ALL) 463*b1746dddSMichael EllermanSTEXI 464*b1746dddSMichael Ellerman@item -balloon none 465*b1746dddSMichael Ellerman@findex -balloon 466*b1746dddSMichael EllermanDisable balloon device. 467*b1746dddSMichael Ellerman@item -balloon virtio[,addr=@var{addr}] 468*b1746dddSMichael EllermanEnable virtio balloon device (default), optionally with PCI address 469*b1746dddSMichael Ellerman@var{addr}. 470*b1746dddSMichael EllermanETEXI 471*b1746dddSMichael Ellerman 4725824d651Sblueswir1STEXI 4735824d651Sblueswir1@end table 4745824d651Sblueswir1ETEXI 4755824d651Sblueswir1 4765824d651Sblueswir1DEF("usb", 0, QEMU_OPTION_usb, 477ad96090aSBlue Swirl "-usb enable the USB driver (will be the default soon)\n", 478ad96090aSBlue Swirl QEMU_ARCH_ALL) 4795824d651Sblueswir1STEXI 4805824d651Sblueswir1USB options: 4815824d651Sblueswir1@table @option 4825824d651Sblueswir1 4835824d651Sblueswir1@item -usb 4846616b2adSStefan Weil@findex -usb 4855824d651Sblueswir1Enable the USB driver (will be the default soon) 4865824d651Sblueswir1ETEXI 4875824d651Sblueswir1 4885824d651Sblueswir1DEF("usbdevice", HAS_ARG, QEMU_OPTION_usbdevice, 489ad96090aSBlue Swirl "-usbdevice name add the host or guest USB device 'name'\n", 490ad96090aSBlue Swirl QEMU_ARCH_ALL) 4915824d651Sblueswir1STEXI 4925824d651Sblueswir1 4935824d651Sblueswir1@item -usbdevice @var{devname} 4946616b2adSStefan Weil@findex -usbdevice 4955824d651Sblueswir1Add the USB device @var{devname}. @xref{usb_devices}. 4965824d651Sblueswir1 497b3f046c2SKevin Wolf@table @option 4985824d651Sblueswir1 4995824d651Sblueswir1@item mouse 5005824d651Sblueswir1Virtual Mouse. This will override the PS/2 mouse emulation when activated. 5015824d651Sblueswir1 5025824d651Sblueswir1@item tablet 5035824d651Sblueswir1Pointer device that uses absolute coordinates (like a touchscreen). This 5045824d651Sblueswir1means qemu is able to report the mouse position without having to grab the 5055824d651Sblueswir1mouse. Also overrides the PS/2 mouse emulation when activated. 5065824d651Sblueswir1 5074e257e5eSKevin Wolf@item disk:[format=@var{format}]:@var{file} 5085824d651Sblueswir1Mass storage device based on file. The optional @var{format} argument 5095824d651Sblueswir1will be used rather than detecting the format. Can be used to specifiy 5104e257e5eSKevin Wolf@code{format=raw} to avoid interpreting an untrusted format header. 5115824d651Sblueswir1 5124e257e5eSKevin Wolf@item host:@var{bus}.@var{addr} 5134e257e5eSKevin WolfPass through the host device identified by @var{bus}.@var{addr} (Linux only). 5145824d651Sblueswir1 5154e257e5eSKevin Wolf@item host:@var{vendor_id}:@var{product_id} 5164e257e5eSKevin WolfPass through the host device identified by @var{vendor_id}:@var{product_id} 5174e257e5eSKevin Wolf(Linux only). 5185824d651Sblueswir1 5195824d651Sblueswir1@item serial:[vendorid=@var{vendor_id}][,productid=@var{product_id}]:@var{dev} 5205824d651Sblueswir1Serial converter to host character device @var{dev}, see @code{-serial} for the 5215824d651Sblueswir1available devices. 5225824d651Sblueswir1 5235824d651Sblueswir1@item braille 5245824d651Sblueswir1Braille device. This will use BrlAPI to display the braille output on a real 5255824d651Sblueswir1or fake device. 5265824d651Sblueswir1 5274e257e5eSKevin Wolf@item net:@var{options} 5285824d651Sblueswir1Network adapter that supports CDC ethernet and RNDIS protocols. 5295824d651Sblueswir1 5305824d651Sblueswir1@end table 5315824d651Sblueswir1ETEXI 5325824d651Sblueswir1 533bd3c948dSGerd HoffmannDEF("device", HAS_ARG, QEMU_OPTION_device, 53440ea285cSMarkus Armbruster "-device driver[,prop[=value][,...]]\n" 53540ea285cSMarkus Armbruster " add device (based on driver)\n" 53640ea285cSMarkus Armbruster " prop=value,... sets driver properties\n" 53769a319d1SStefan Weil " use -device ? to print all possible drivers\n" 5389848bbf1SMarkus Armbruster " use -device driver,? to print all possible properties\n", 539ad96090aSBlue Swirl QEMU_ARCH_ALL) 5403dbf2c7fSStefan WeilSTEXI 5419848bbf1SMarkus Armbruster@item -device @var{driver}[,@var{prop}[=@var{value}][,...]] 5426616b2adSStefan Weil@findex -device 5439848bbf1SMarkus ArmbrusterAdd device @var{driver}. @var{prop}=@var{value} sets driver 5449848bbf1SMarkus Armbrusterproperties. Valid properties depend on the driver. To get help on 5459848bbf1SMarkus Armbrusterpossible drivers and properties, use @code{-device ?} and 5469848bbf1SMarkus Armbruster@code{-device @var{driver},?}. 5473dbf2c7fSStefan WeilETEXI 5483dbf2c7fSStefan Weil 5497c92a3d2SAneesh Kumar K.VDEFHEADING() 5507c92a3d2SAneesh Kumar K.V 55174db920cSGautham R ShenoyDEFHEADING(File system options:) 55274db920cSGautham R Shenoy 55374db920cSGautham R ShenoyDEF("fsdev", HAS_ARG, QEMU_OPTION_fsdev, 554d9b36a6eSM. Mohan Kumar "-fsdev fsdriver,id=id,path=path,[security_model={mapped|passthrough|none}]\n" 5552c74c2cbSM. Mohan Kumar " [,writeout=immediate][,readonly]\n", 55674db920cSGautham R Shenoy QEMU_ARCH_ALL) 55774db920cSGautham R Shenoy 55874db920cSGautham R ShenoySTEXI 55974db920cSGautham R Shenoy 5602c74c2cbSM. Mohan Kumar@item -fsdev @var{fsdriver},id=@var{id},path=@var{path},[security_model=@var{security_model}][,writeout=@var{writeout}][,readonly] 56174db920cSGautham R Shenoy@findex -fsdev 5627c92a3d2SAneesh Kumar K.VDefine a new file system device. Valid options are: 5637c92a3d2SAneesh Kumar K.V@table @option 5647c92a3d2SAneesh Kumar K.V@item @var{fsdriver} 5657c92a3d2SAneesh Kumar K.VThis option specifies the fs driver backend to use. 5667c92a3d2SAneesh Kumar K.VCurrently "local" and "handle" file system drivers are supported. 5677c92a3d2SAneesh Kumar K.V@item id=@var{id} 5687c92a3d2SAneesh Kumar K.VSpecifies identifier for this device 5697c92a3d2SAneesh Kumar K.V@item path=@var{path} 5707c92a3d2SAneesh Kumar K.VSpecifies the export path for the file system device. Files under 5717c92a3d2SAneesh Kumar K.Vthis path will be available to the 9p client on the guest. 5727c92a3d2SAneesh Kumar K.V@item security_model=@var{security_model} 5737c92a3d2SAneesh Kumar K.VSpecifies the security model to be used for this export path. 5747c92a3d2SAneesh Kumar K.VSupported security models are "passthrough", "mapped" and "none". 5757c92a3d2SAneesh Kumar K.VIn "passthrough" security model, files are stored using the same 5767c92a3d2SAneesh Kumar K.Vcredentials as they are created on the guest. This requires qemu 5777c92a3d2SAneesh Kumar K.Vto run as root. In "mapped" security model, some of the file 5787c92a3d2SAneesh Kumar K.Vattributes like uid, gid, mode bits and link target are stored as 5797c92a3d2SAneesh Kumar K.Vfile attributes. Directories exported by this security model cannot 5807c92a3d2SAneesh Kumar K.Vinteract with other unix tools. "none" security model is same as 5817c92a3d2SAneesh Kumar K.Vpassthrough except the sever won't report failures if it fails to 582d9b36a6eSM. Mohan Kumarset file attributes like ownership. Security model is mandatory 583d9b36a6eSM. Mohan Kumaronly for local fsdriver. Other fsdrivers (like handle) don't take 584d9b36a6eSM. Mohan Kumarsecurity model as a parameter. 5857c92a3d2SAneesh Kumar K.V@item writeout=@var{writeout} 5867c92a3d2SAneesh Kumar K.VThis is an optional argument. The only supported value is "immediate". 5877c92a3d2SAneesh Kumar K.VThis means that host page cache will be used to read and write data but 5887c92a3d2SAneesh Kumar K.Vwrite notification will be sent to the guest only when the data has been 5897c92a3d2SAneesh Kumar K.Vreported as written by the storage subsystem. 5902c74c2cbSM. Mohan Kumar@item readonly 5912c74c2cbSM. Mohan KumarEnables exporting 9p share as a readonly mount for guests. By default 5922c74c2cbSM. Mohan Kumarread-write access is given. 59374db920cSGautham R Shenoy@end table 5947c92a3d2SAneesh Kumar K.V 5957c92a3d2SAneesh Kumar K.V-fsdev option is used along with -device driver "virtio-9p-pci". 5967c92a3d2SAneesh Kumar K.V@item -device virtio-9p-pci,fsdev=@var{id},mount_tag=@var{mount_tag} 5977c92a3d2SAneesh Kumar K.VOptions for virtio-9p-pci driver are: 5987c92a3d2SAneesh Kumar K.V@table @option 5997c92a3d2SAneesh Kumar K.V@item fsdev=@var{id} 6007c92a3d2SAneesh Kumar K.VSpecifies the id value specified along with -fsdev option 6017c92a3d2SAneesh Kumar K.V@item mount_tag=@var{mount_tag} 6027c92a3d2SAneesh Kumar K.VSpecifies the tag name to be used by the guest to mount this export point 6037c92a3d2SAneesh Kumar K.V@end table 6047c92a3d2SAneesh Kumar K.V 60574db920cSGautham R ShenoyETEXI 60674db920cSGautham R Shenoy 6077c92a3d2SAneesh Kumar K.VDEFHEADING() 6087c92a3d2SAneesh Kumar K.V 6093d54abc7SGautham R ShenoyDEFHEADING(Virtual File system pass-through options:) 6103d54abc7SGautham R Shenoy 6113d54abc7SGautham R ShenoyDEF("virtfs", HAS_ARG, QEMU_OPTION_virtfs, 612d3ab98e6SAneesh Kumar K.V "-virtfs local,path=path,mount_tag=tag,security_model=[mapped|passthrough|none]\n" 6132c74c2cbSM. Mohan Kumar " [,writeout=immediate][,readonly]\n", 6143d54abc7SGautham R Shenoy QEMU_ARCH_ALL) 6153d54abc7SGautham R Shenoy 6163d54abc7SGautham R ShenoySTEXI 6173d54abc7SGautham R Shenoy 6182c74c2cbSM. Mohan Kumar@item -virtfs @var{fsdriver},path=@var{path},mount_tag=@var{mount_tag},security_model=@var{security_model}[,writeout=@var{writeout}][,readonly] 6193d54abc7SGautham R Shenoy@findex -virtfs 6203d54abc7SGautham R Shenoy 6217c92a3d2SAneesh Kumar K.VThe general form of a Virtual File system pass-through options are: 6227c92a3d2SAneesh Kumar K.V@table @option 6237c92a3d2SAneesh Kumar K.V@item @var{fsdriver} 6247c92a3d2SAneesh Kumar K.VThis option specifies the fs driver backend to use. 6257c92a3d2SAneesh Kumar K.VCurrently "local" and "handle" file system drivers are supported. 6267c92a3d2SAneesh Kumar K.V@item id=@var{id} 6277c92a3d2SAneesh Kumar K.VSpecifies identifier for this device 6287c92a3d2SAneesh Kumar K.V@item path=@var{path} 6297c92a3d2SAneesh Kumar K.VSpecifies the export path for the file system device. Files under 6307c92a3d2SAneesh Kumar K.Vthis path will be available to the 9p client on the guest. 6317c92a3d2SAneesh Kumar K.V@item security_model=@var{security_model} 6327c92a3d2SAneesh Kumar K.VSpecifies the security model to be used for this export path. 6337c92a3d2SAneesh Kumar K.VSupported security models are "passthrough", "mapped" and "none". 6347c92a3d2SAneesh Kumar K.VIn "passthrough" security model, files are stored using the same 6357c92a3d2SAneesh Kumar K.Vcredentials as they are created on the guest. This requires qemu 6367c92a3d2SAneesh Kumar K.Vto run as root. In "mapped" security model, some of the file 6377c92a3d2SAneesh Kumar K.Vattributes like uid, gid, mode bits and link target are stored as 6387c92a3d2SAneesh Kumar K.Vfile attributes. Directories exported by this security model cannot 6397c92a3d2SAneesh Kumar K.Vinteract with other unix tools. "none" security model is same as 6407c92a3d2SAneesh Kumar K.Vpassthrough except the sever won't report failures if it fails to 641d9b36a6eSM. Mohan Kumarset file attributes like ownership. Security model is mandatory only 642d9b36a6eSM. Mohan Kumarfor local fsdriver. Other fsdrivers (like handle) don't take security 643d9b36a6eSM. Mohan Kumarmodel as a parameter. 6447c92a3d2SAneesh Kumar K.V@item writeout=@var{writeout} 6457c92a3d2SAneesh Kumar K.VThis is an optional argument. The only supported value is "immediate". 6467c92a3d2SAneesh Kumar K.VThis means that host page cache will be used to read and write data but 6477c92a3d2SAneesh Kumar K.Vwrite notification will be sent to the guest only when the data has been 6487c92a3d2SAneesh Kumar K.Vreported as written by the storage subsystem. 6492c74c2cbSM. Mohan Kumar@item readonly 6502c74c2cbSM. Mohan KumarEnables exporting 9p share as a readonly mount for guests. By default 6512c74c2cbSM. Mohan Kumarread-write access is given. 6523d54abc7SGautham R Shenoy@end table 6533d54abc7SGautham R ShenoyETEXI 6543d54abc7SGautham R Shenoy 6559db221aeSAneesh Kumar K.VDEF("virtfs_synth", 0, QEMU_OPTION_virtfs_synth, 6569db221aeSAneesh Kumar K.V "-virtfs_synth Create synthetic file system image\n", 6579db221aeSAneesh Kumar K.V QEMU_ARCH_ALL) 6589db221aeSAneesh Kumar K.VSTEXI 6599db221aeSAneesh Kumar K.V@item -virtfs_synth 6609db221aeSAneesh Kumar K.V@findex -virtfs_synth 6619db221aeSAneesh Kumar K.VCreate synthetic file system image 6629db221aeSAneesh Kumar K.VETEXI 6639db221aeSAneesh Kumar K.V 66474db920cSGautham R ShenoyDEFHEADING() 66574db920cSGautham R Shenoy 6665824d651Sblueswir1DEF("name", HAS_ARG, QEMU_OPTION_name, 667ca1a8a06SBruce Rogers "-name string1[,process=string2]\n" 668ca1a8a06SBruce Rogers " set the name of the guest\n" 669ad96090aSBlue Swirl " string1 sets the window title and string2 the process name (on Linux)\n", 670ad96090aSBlue Swirl QEMU_ARCH_ALL) 6715824d651Sblueswir1STEXI 6725824d651Sblueswir1@item -name @var{name} 6736616b2adSStefan Weil@findex -name 6745824d651Sblueswir1Sets the @var{name} of the guest. 6755824d651Sblueswir1This name will be displayed in the SDL window caption. 6765824d651Sblueswir1The @var{name} will also be used for the VNC server. 6771889465aSAndi KleenAlso optionally set the top visible process name in Linux. 6785824d651Sblueswir1ETEXI 6795824d651Sblueswir1 6805824d651Sblueswir1DEF("uuid", HAS_ARG, QEMU_OPTION_uuid, 681e8105ebbSPaolo Bonzini "-uuid %08x-%04x-%04x-%04x-%012x\n" 682ad96090aSBlue Swirl " specify machine UUID\n", QEMU_ARCH_ALL) 6835824d651Sblueswir1STEXI 6845824d651Sblueswir1@item -uuid @var{uuid} 6856616b2adSStefan Weil@findex -uuid 6865824d651Sblueswir1Set system UUID. 6875824d651Sblueswir1ETEXI 6885824d651Sblueswir1 6895824d651Sblueswir1STEXI 6905824d651Sblueswir1@end table 6915824d651Sblueswir1ETEXI 6925824d651Sblueswir1 6935824d651Sblueswir1DEFHEADING() 6945824d651Sblueswir1 6955824d651Sblueswir1DEFHEADING(Display options:) 6965824d651Sblueswir1 6975824d651Sblueswir1STEXI 6985824d651Sblueswir1@table @option 6995824d651Sblueswir1ETEXI 7005824d651Sblueswir1 7011472a95bSJes SorensenDEF("display", HAS_ARG, QEMU_OPTION_display, 7021472a95bSJes Sorensen "-display sdl[,frame=on|off][,alt_grab=on|off][,ctrl_grab=on|off]\n" 7033264ff12SJes Sorensen " [,window_close=on|off]|curses|none|\n" 7043264ff12SJes Sorensen " vnc=<display>[,<optargs>]\n" 7051472a95bSJes Sorensen " select display type\n", QEMU_ARCH_ALL) 7061472a95bSJes SorensenSTEXI 7071472a95bSJes Sorensen@item -display @var{type} 7081472a95bSJes Sorensen@findex -display 7091472a95bSJes SorensenSelect type of display to use. This option is a replacement for the 7101472a95bSJes Sorensenold style -sdl/-curses/... options. Valid values for @var{type} are 7111472a95bSJes Sorensen@table @option 7121472a95bSJes Sorensen@item sdl 7131472a95bSJes SorensenDisplay video output via SDL (usually in a separate graphics 7141472a95bSJes Sorensenwindow; see the SDL documentation for other possibilities). 7151472a95bSJes Sorensen@item curses 7161472a95bSJes SorensenDisplay video output via curses. For graphics device models which 7171472a95bSJes Sorensensupport a text mode, QEMU can display this output using a 7181472a95bSJes Sorensencurses/ncurses interface. Nothing is displayed when the graphics 7191472a95bSJes Sorensendevice is in graphical mode or if the graphics device does not support 7201472a95bSJes Sorensena text mode. Generally only the VGA device models support text mode. 7214171d32eSJes Sorensen@item none 7224171d32eSJes SorensenDo not display video output. The guest will still see an emulated 7234171d32eSJes Sorensengraphics card, but its output will not be displayed to the QEMU 7244171d32eSJes Sorensenuser. This option differs from the -nographic option in that it 7254171d32eSJes Sorensenonly affects what is done with video output; -nographic also changes 7264171d32eSJes Sorensenthe destination of the serial and parallel port data. 7273264ff12SJes Sorensen@item vnc 7283264ff12SJes SorensenStart a VNC server on display <arg> 7291472a95bSJes Sorensen@end table 7301472a95bSJes SorensenETEXI 7311472a95bSJes Sorensen 7325824d651Sblueswir1DEF("nographic", 0, QEMU_OPTION_nographic, 733ad96090aSBlue Swirl "-nographic disable graphical output and redirect serial I/Os to console\n", 734ad96090aSBlue Swirl QEMU_ARCH_ALL) 7355824d651Sblueswir1STEXI 7365824d651Sblueswir1@item -nographic 7376616b2adSStefan Weil@findex -nographic 7385824d651Sblueswir1Normally, QEMU uses SDL to display the VGA output. With this option, 7395824d651Sblueswir1you can totally disable graphical output so that QEMU is a simple 7405824d651Sblueswir1command line application. The emulated serial port is redirected on 7415824d651Sblueswir1the console. Therefore, you can still use QEMU to debug a Linux kernel 7425824d651Sblueswir1with a serial console. 7435824d651Sblueswir1ETEXI 7445824d651Sblueswir1 7455824d651Sblueswir1DEF("curses", 0, QEMU_OPTION_curses, 746ad96090aSBlue Swirl "-curses use a curses/ncurses interface instead of SDL\n", 747ad96090aSBlue Swirl QEMU_ARCH_ALL) 7485824d651Sblueswir1STEXI 7495824d651Sblueswir1@item -curses 7506616b2adSStefan Weil@findex curses 7515824d651Sblueswir1Normally, QEMU uses SDL to display the VGA output. With this option, 7525824d651Sblueswir1QEMU can display the VGA output when in text mode using a 7535824d651Sblueswir1curses/ncurses interface. Nothing is displayed in graphical mode. 7545824d651Sblueswir1ETEXI 7555824d651Sblueswir1 7565824d651Sblueswir1DEF("no-frame", 0, QEMU_OPTION_no_frame, 757ad96090aSBlue Swirl "-no-frame open SDL window without a frame and window decorations\n", 758ad96090aSBlue Swirl QEMU_ARCH_ALL) 7595824d651Sblueswir1STEXI 7605824d651Sblueswir1@item -no-frame 7616616b2adSStefan Weil@findex -no-frame 7625824d651Sblueswir1Do not use decorations for SDL windows and start them using the whole 7635824d651Sblueswir1available screen space. This makes the using QEMU in a dedicated desktop 7645824d651Sblueswir1workspace more convenient. 7655824d651Sblueswir1ETEXI 7665824d651Sblueswir1 7675824d651Sblueswir1DEF("alt-grab", 0, QEMU_OPTION_alt_grab, 768ad96090aSBlue Swirl "-alt-grab use Ctrl-Alt-Shift to grab mouse (instead of Ctrl-Alt)\n", 769ad96090aSBlue Swirl QEMU_ARCH_ALL) 7705824d651Sblueswir1STEXI 7715824d651Sblueswir1@item -alt-grab 7726616b2adSStefan Weil@findex -alt-grab 773de1db2a1SBrad HardsUse Ctrl-Alt-Shift to grab mouse (instead of Ctrl-Alt). Note that this also 774de1db2a1SBrad Hardsaffects the special keys (for fullscreen, monitor-mode switching, etc). 7755824d651Sblueswir1ETEXI 7765824d651Sblueswir1 7770ca9f8a4SDustin KirklandDEF("ctrl-grab", 0, QEMU_OPTION_ctrl_grab, 778ad96090aSBlue Swirl "-ctrl-grab use Right-Ctrl to grab mouse (instead of Ctrl-Alt)\n", 779ad96090aSBlue Swirl QEMU_ARCH_ALL) 7800ca9f8a4SDustin KirklandSTEXI 7810ca9f8a4SDustin Kirkland@item -ctrl-grab 7826616b2adSStefan Weil@findex -ctrl-grab 783de1db2a1SBrad HardsUse Right-Ctrl to grab mouse (instead of Ctrl-Alt). Note that this also 784de1db2a1SBrad Hardsaffects the special keys (for fullscreen, monitor-mode switching, etc). 7850ca9f8a4SDustin KirklandETEXI 7860ca9f8a4SDustin Kirkland 7875824d651Sblueswir1DEF("no-quit", 0, QEMU_OPTION_no_quit, 788ad96090aSBlue Swirl "-no-quit disable SDL window close capability\n", QEMU_ARCH_ALL) 7895824d651Sblueswir1STEXI 7905824d651Sblueswir1@item -no-quit 7916616b2adSStefan Weil@findex -no-quit 7925824d651Sblueswir1Disable SDL window close capability. 7935824d651Sblueswir1ETEXI 7945824d651Sblueswir1 7955824d651Sblueswir1DEF("sdl", 0, QEMU_OPTION_sdl, 796ad96090aSBlue Swirl "-sdl enable SDL\n", QEMU_ARCH_ALL) 7975824d651Sblueswir1STEXI 7985824d651Sblueswir1@item -sdl 7996616b2adSStefan Weil@findex -sdl 8005824d651Sblueswir1Enable SDL. 8015824d651Sblueswir1ETEXI 8025824d651Sblueswir1 80329b0040bSGerd HoffmannDEF("spice", HAS_ARG, QEMU_OPTION_spice, 80429b0040bSGerd Hoffmann "-spice <args> enable spice\n", QEMU_ARCH_ALL) 80529b0040bSGerd HoffmannSTEXI 80629b0040bSGerd Hoffmann@item -spice @var{option}[,@var{option}[,...]] 80729b0040bSGerd Hoffmann@findex -spice 80829b0040bSGerd HoffmannEnable the spice remote desktop protocol. Valid options are 80929b0040bSGerd Hoffmann 81029b0040bSGerd Hoffmann@table @option 81129b0040bSGerd Hoffmann 81229b0040bSGerd Hoffmann@item port=<nr> 813c448e855SGerd HoffmannSet the TCP port spice is listening on for plaintext channels. 81429b0040bSGerd Hoffmann 815333b0eebSGerd Hoffmann@item addr=<addr> 816333b0eebSGerd HoffmannSet the IP address spice is listening on. Default is any address. 817333b0eebSGerd Hoffmann 818333b0eebSGerd Hoffmann@item ipv4 819333b0eebSGerd Hoffmann@item ipv6 820333b0eebSGerd HoffmannForce using the specified IP version. 821333b0eebSGerd Hoffmann 82229b0040bSGerd Hoffmann@item password=<secret> 82329b0040bSGerd HoffmannSet the password you need to authenticate. 82429b0040bSGerd Hoffmann 82548b3ed0aSMarc-André Lureau@item sasl 82648b3ed0aSMarc-André LureauRequire that the client use SASL to authenticate with the spice. 82748b3ed0aSMarc-André LureauThe exact choice of authentication method used is controlled from the 82848b3ed0aSMarc-André Lureausystem / user's SASL configuration file for the 'qemu' service. This 82948b3ed0aSMarc-André Lureauis typically found in /etc/sasl2/qemu.conf. If running QEMU as an 83048b3ed0aSMarc-André Lureauunprivileged user, an environment variable SASL_CONF_PATH can be used 83148b3ed0aSMarc-André Lureauto make it search alternate locations for the service config. 83248b3ed0aSMarc-André LureauWhile some SASL auth methods can also provide data encryption (eg GSSAPI), 83348b3ed0aSMarc-André Lureauit is recommended that SASL always be combined with the 'tls' and 83448b3ed0aSMarc-André Lureau'x509' settings to enable use of SSL and server certificates. This 83548b3ed0aSMarc-André Lureauensures a data encryption preventing compromise of authentication 83648b3ed0aSMarc-André Lureaucredentials. 83748b3ed0aSMarc-André Lureau 83829b0040bSGerd Hoffmann@item disable-ticketing 83929b0040bSGerd HoffmannAllow client connects without authentication. 84029b0040bSGerd Hoffmann 841d4970b07SHans de Goede@item disable-copy-paste 842d4970b07SHans de GoedeDisable copy paste between the client and the guest. 843d4970b07SHans de Goede 844c448e855SGerd Hoffmann@item tls-port=<nr> 845c448e855SGerd HoffmannSet the TCP port spice is listening on for encrypted channels. 846c448e855SGerd Hoffmann 847c448e855SGerd Hoffmann@item x509-dir=<dir> 848c448e855SGerd HoffmannSet the x509 file directory. Expects same filenames as -vnc $display,x509=$dir 849c448e855SGerd Hoffmann 850c448e855SGerd Hoffmann@item x509-key-file=<file> 851c448e855SGerd Hoffmann@item x509-key-password=<file> 852c448e855SGerd Hoffmann@item x509-cert-file=<file> 853c448e855SGerd Hoffmann@item x509-cacert-file=<file> 854c448e855SGerd Hoffmann@item x509-dh-key-file=<file> 855c448e855SGerd HoffmannThe x509 file names can also be configured individually. 856c448e855SGerd Hoffmann 857c448e855SGerd Hoffmann@item tls-ciphers=<list> 858c448e855SGerd HoffmannSpecify which ciphers to use. 859c448e855SGerd Hoffmann 86017b6dea0SGerd Hoffmann@item tls-channel=[main|display|inputs|record|playback|tunnel] 86117b6dea0SGerd Hoffmann@item plaintext-channel=[main|display|inputs|record|playback|tunnel] 86217b6dea0SGerd HoffmannForce specific channel to be used with or without TLS encryption. The 86317b6dea0SGerd Hoffmannoptions can be specified multiple times to configure multiple 86417b6dea0SGerd Hoffmannchannels. The special name "default" can be used to set the default 86517b6dea0SGerd Hoffmannmode. For channels which are not explicitly forced into one mode the 86617b6dea0SGerd Hoffmannspice client is allowed to pick tls/plaintext as he pleases. 86717b6dea0SGerd Hoffmann 8689f04e09eSYonit Halperin@item image-compression=[auto_glz|auto_lz|quic|glz|lz|off] 8699f04e09eSYonit HalperinConfigure image compression (lossless). 8709f04e09eSYonit HalperinDefault is auto_glz. 8719f04e09eSYonit Halperin 8729f04e09eSYonit Halperin@item jpeg-wan-compression=[auto|never|always] 8739f04e09eSYonit Halperin@item zlib-glz-wan-compression=[auto|never|always] 8749f04e09eSYonit HalperinConfigure wan image compression (lossy for slow links). 8759f04e09eSYonit HalperinDefault is auto. 8769f04e09eSYonit Halperin 87784a23f25SGerd Hoffmann@item streaming-video=[off|all|filter] 87884a23f25SGerd HoffmannConfigure video stream detection. Default is filter. 87984a23f25SGerd Hoffmann 88084a23f25SGerd Hoffmann@item agent-mouse=[on|off] 88184a23f25SGerd HoffmannEnable/disable passing mouse events via vdagent. Default is on. 88284a23f25SGerd Hoffmann 88384a23f25SGerd Hoffmann@item playback-compression=[on|off] 88484a23f25SGerd HoffmannEnable/disable audio stream compression (using celt 0.5.1). Default is on. 88584a23f25SGerd Hoffmann 88629b0040bSGerd Hoffmann@end table 88729b0040bSGerd HoffmannETEXI 88829b0040bSGerd Hoffmann 8895824d651Sblueswir1DEF("portrait", 0, QEMU_OPTION_portrait, 890ad96090aSBlue Swirl "-portrait rotate graphical output 90 deg left (only PXA LCD)\n", 891ad96090aSBlue Swirl QEMU_ARCH_ALL) 8925824d651Sblueswir1STEXI 8935824d651Sblueswir1@item -portrait 8946616b2adSStefan Weil@findex -portrait 8955824d651Sblueswir1Rotate graphical output 90 deg left (only PXA LCD). 8965824d651Sblueswir1ETEXI 8975824d651Sblueswir1 8989312805dSVasily KhoruzhickDEF("rotate", HAS_ARG, QEMU_OPTION_rotate, 8999312805dSVasily Khoruzhick "-rotate <deg> rotate graphical output some deg left (only PXA LCD)\n", 9009312805dSVasily Khoruzhick QEMU_ARCH_ALL) 9019312805dSVasily KhoruzhickSTEXI 9029312805dSVasily Khoruzhick@item -rotate 9039312805dSVasily Khoruzhick@findex -rotate 9049312805dSVasily KhoruzhickRotate graphical output some deg left (only PXA LCD). 9059312805dSVasily KhoruzhickETEXI 9069312805dSVasily Khoruzhick 9075824d651Sblueswir1DEF("vga", HAS_ARG, QEMU_OPTION_vga, 908a19cbfb3SGerd Hoffmann "-vga [std|cirrus|vmware|qxl|xenfb|none]\n" 909ad96090aSBlue Swirl " select video card type\n", QEMU_ARCH_ALL) 9105824d651Sblueswir1STEXI 9115824d651Sblueswir1@item -vga @var{type} 9126616b2adSStefan Weil@findex -vga 9135824d651Sblueswir1Select type of VGA card to emulate. Valid values for @var{type} are 914b3f046c2SKevin Wolf@table @option 9155824d651Sblueswir1@item cirrus 9165824d651Sblueswir1Cirrus Logic GD5446 Video card. All Windows versions starting from 9175824d651Sblueswir1Windows 95 should recognize and use this graphic card. For optimal 9185824d651Sblueswir1performances, use 16 bit color depth in the guest and the host OS. 9195824d651Sblueswir1(This one is the default) 9205824d651Sblueswir1@item std 9215824d651Sblueswir1Standard VGA card with Bochs VBE extensions. If your guest OS 9225824d651Sblueswir1supports the VESA 2.0 VBE extensions (e.g. Windows XP) and if you want 9235824d651Sblueswir1to use high resolution modes (>= 1280x1024x16) then you should use 9245824d651Sblueswir1this option. 9255824d651Sblueswir1@item vmware 9265824d651Sblueswir1VMWare SVGA-II compatible adapter. Use it if you have sufficiently 9275824d651Sblueswir1recent XFree86/XOrg server or Windows guest with a driver for this 9285824d651Sblueswir1card. 929a19cbfb3SGerd Hoffmann@item qxl 930a19cbfb3SGerd HoffmannQXL paravirtual graphic card. It is VGA compatible (including VESA 931a19cbfb3SGerd Hoffmann2.0 VBE support). Works best with qxl guest drivers installed though. 932a19cbfb3SGerd HoffmannRecommended choice when using the spice protocol. 9335824d651Sblueswir1@item none 9345824d651Sblueswir1Disable VGA card. 9355824d651Sblueswir1@end table 9365824d651Sblueswir1ETEXI 9375824d651Sblueswir1 9385824d651Sblueswir1DEF("full-screen", 0, QEMU_OPTION_full_screen, 939ad96090aSBlue Swirl "-full-screen start in full screen\n", QEMU_ARCH_ALL) 9405824d651Sblueswir1STEXI 9415824d651Sblueswir1@item -full-screen 9426616b2adSStefan Weil@findex -full-screen 9435824d651Sblueswir1Start in full screen. 9445824d651Sblueswir1ETEXI 9455824d651Sblueswir1 9465824d651Sblueswir1DEF("g", 1, QEMU_OPTION_g , 947ad96090aSBlue Swirl "-g WxH[xDEPTH] Set the initial graphical resolution and depth\n", 948ad96090aSBlue Swirl QEMU_ARCH_PPC | QEMU_ARCH_SPARC) 9495824d651Sblueswir1STEXI 95095d5f08bSStefan Weil@item -g @var{width}x@var{height}[x@var{depth}] 9516616b2adSStefan Weil@findex -g 95295d5f08bSStefan WeilSet the initial graphical resolution and depth (PPC, SPARC only). 9535824d651Sblueswir1ETEXI 9545824d651Sblueswir1 9555824d651Sblueswir1DEF("vnc", HAS_ARG, QEMU_OPTION_vnc , 956ad96090aSBlue Swirl "-vnc display start a VNC server on display\n", QEMU_ARCH_ALL) 9575824d651Sblueswir1STEXI 9585824d651Sblueswir1@item -vnc @var{display}[,@var{option}[,@var{option}[,...]]] 9596616b2adSStefan Weil@findex -vnc 9605824d651Sblueswir1Normally, QEMU uses SDL to display the VGA output. With this option, 9615824d651Sblueswir1you can have QEMU listen on VNC display @var{display} and redirect the VGA 9625824d651Sblueswir1display over the VNC session. It is very useful to enable the usb 9635824d651Sblueswir1tablet device when using this option (option @option{-usbdevice 9645824d651Sblueswir1tablet}). When using the VNC display, you must use the @option{-k} 9655824d651Sblueswir1parameter to set the keyboard layout if you are not using en-us. Valid 9665824d651Sblueswir1syntax for the @var{display} is 9675824d651Sblueswir1 968b3f046c2SKevin Wolf@table @option 9695824d651Sblueswir1 9705824d651Sblueswir1@item @var{host}:@var{d} 9715824d651Sblueswir1 9725824d651Sblueswir1TCP connections will only be allowed from @var{host} on display @var{d}. 9735824d651Sblueswir1By convention the TCP port is 5900+@var{d}. Optionally, @var{host} can 9745824d651Sblueswir1be omitted in which case the server will accept connections from any host. 9755824d651Sblueswir1 9764e257e5eSKevin Wolf@item unix:@var{path} 9775824d651Sblueswir1 9785824d651Sblueswir1Connections will be allowed over UNIX domain sockets where @var{path} is the 9795824d651Sblueswir1location of a unix socket to listen for connections on. 9805824d651Sblueswir1 9815824d651Sblueswir1@item none 9825824d651Sblueswir1 9835824d651Sblueswir1VNC is initialized but not started. The monitor @code{change} command 9845824d651Sblueswir1can be used to later start the VNC server. 9855824d651Sblueswir1 9865824d651Sblueswir1@end table 9875824d651Sblueswir1 9885824d651Sblueswir1Following the @var{display} value there may be one or more @var{option} flags 9895824d651Sblueswir1separated by commas. Valid options are 9905824d651Sblueswir1 991b3f046c2SKevin Wolf@table @option 9925824d651Sblueswir1 9935824d651Sblueswir1@item reverse 9945824d651Sblueswir1 9955824d651Sblueswir1Connect to a listening VNC client via a ``reverse'' connection. The 9965824d651Sblueswir1client is specified by the @var{display}. For reverse network 9975824d651Sblueswir1connections (@var{host}:@var{d},@code{reverse}), the @var{d} argument 9985824d651Sblueswir1is a TCP port number, not a display number. 9995824d651Sblueswir1 10005824d651Sblueswir1@item password 10015824d651Sblueswir1 10025824d651Sblueswir1Require that password based authentication is used for client connections. 10035824d651Sblueswir1The password must be set separately using the @code{change} command in the 10045824d651Sblueswir1@ref{pcsys_monitor} 10055824d651Sblueswir1 10065824d651Sblueswir1@item tls 10075824d651Sblueswir1 10085824d651Sblueswir1Require that client use TLS when communicating with the VNC server. This 10095824d651Sblueswir1uses anonymous TLS credentials so is susceptible to a man-in-the-middle 10105824d651Sblueswir1attack. It is recommended that this option be combined with either the 10114e257e5eSKevin Wolf@option{x509} or @option{x509verify} options. 10125824d651Sblueswir1 10135824d651Sblueswir1@item x509=@var{/path/to/certificate/dir} 10145824d651Sblueswir1 10155824d651Sblueswir1Valid if @option{tls} is specified. Require that x509 credentials are used 10165824d651Sblueswir1for negotiating the TLS session. The server will send its x509 certificate 10175824d651Sblueswir1to the client. It is recommended that a password be set on the VNC server 10185824d651Sblueswir1to provide authentication of the client when this is used. The path following 10195824d651Sblueswir1this option specifies where the x509 certificates are to be loaded from. 10205824d651Sblueswir1See the @ref{vnc_security} section for details on generating certificates. 10215824d651Sblueswir1 10225824d651Sblueswir1@item x509verify=@var{/path/to/certificate/dir} 10235824d651Sblueswir1 10245824d651Sblueswir1Valid if @option{tls} is specified. Require that x509 credentials are used 10255824d651Sblueswir1for negotiating the TLS session. The server will send its x509 certificate 10265824d651Sblueswir1to the client, and request that the client send its own x509 certificate. 10275824d651Sblueswir1The server will validate the client's certificate against the CA certificate, 10285824d651Sblueswir1and reject clients when validation fails. If the certificate authority is 10295824d651Sblueswir1trusted, this is a sufficient authentication mechanism. You may still wish 10305824d651Sblueswir1to set a password on the VNC server as a second authentication layer. The 10315824d651Sblueswir1path following this option specifies where the x509 certificates are to 10325824d651Sblueswir1be loaded from. See the @ref{vnc_security} section for details on generating 10335824d651Sblueswir1certificates. 10345824d651Sblueswir1 10355824d651Sblueswir1@item sasl 10365824d651Sblueswir1 10375824d651Sblueswir1Require that the client use SASL to authenticate with the VNC server. 10385824d651Sblueswir1The exact choice of authentication method used is controlled from the 10395824d651Sblueswir1system / user's SASL configuration file for the 'qemu' service. This 10405824d651Sblueswir1is typically found in /etc/sasl2/qemu.conf. If running QEMU as an 10415824d651Sblueswir1unprivileged user, an environment variable SASL_CONF_PATH can be used 10425824d651Sblueswir1to make it search alternate locations for the service config. 10435824d651Sblueswir1While some SASL auth methods can also provide data encryption (eg GSSAPI), 10445824d651Sblueswir1it is recommended that SASL always be combined with the 'tls' and 10455824d651Sblueswir1'x509' settings to enable use of SSL and server certificates. This 10465824d651Sblueswir1ensures a data encryption preventing compromise of authentication 10475824d651Sblueswir1credentials. See the @ref{vnc_security} section for details on using 10485824d651Sblueswir1SASL authentication. 10495824d651Sblueswir1 10505824d651Sblueswir1@item acl 10515824d651Sblueswir1 10525824d651Sblueswir1Turn on access control lists for checking of the x509 client certificate 10535824d651Sblueswir1and SASL party. For x509 certs, the ACL check is made against the 10545824d651Sblueswir1certificate's distinguished name. This is something that looks like 10555824d651Sblueswir1@code{C=GB,O=ACME,L=Boston,CN=bob}. For SASL party, the ACL check is 10565824d651Sblueswir1made against the username, which depending on the SASL plugin, may 10575824d651Sblueswir1include a realm component, eg @code{bob} or @code{bob@@EXAMPLE.COM}. 10585824d651Sblueswir1When the @option{acl} flag is set, the initial access list will be 10595824d651Sblueswir1empty, with a @code{deny} policy. Thus no one will be allowed to 10605824d651Sblueswir1use the VNC server until the ACLs have been loaded. This can be 10615824d651Sblueswir1achieved using the @code{acl} monitor command. 10625824d651Sblueswir1 10636f9c78c1SCorentin Chary@item lossy 10646f9c78c1SCorentin Chary 10656f9c78c1SCorentin CharyEnable lossy compression methods (gradient, JPEG, ...). If this 10666f9c78c1SCorentin Charyoption is set, VNC client may receive lossy framebuffer updates 10676f9c78c1SCorentin Charydepending on its encoding settings. Enabling this option can save 10686f9c78c1SCorentin Charya lot of bandwidth at the expense of quality. 10696f9c78c1SCorentin Chary 107080e0c8c3SCorentin Chary@item non-adaptive 107180e0c8c3SCorentin Chary 107280e0c8c3SCorentin CharyDisable adaptive encodings. Adaptive encodings are enabled by default. 107380e0c8c3SCorentin CharyAn adaptive encoding will try to detect frequently updated screen regions, 107480e0c8c3SCorentin Charyand send updates in these regions using a lossy encoding (like JPEG). 107561cc8701SStefan WeilThis can be really helpful to save bandwidth when playing videos. Disabling 107661cc8701SStefan Weiladaptive encodings allows to restore the original static behavior of encodings 107780e0c8c3SCorentin Charylike Tight. 107880e0c8c3SCorentin Chary 10795824d651Sblueswir1@end table 10805824d651Sblueswir1ETEXI 10815824d651Sblueswir1 10825824d651Sblueswir1STEXI 10835824d651Sblueswir1@end table 10845824d651Sblueswir1ETEXI 10855824d651Sblueswir1 1086a3adb7adSMichael EllermanARCHHEADING(, QEMU_ARCH_I386) 10875824d651Sblueswir1 1088a3adb7adSMichael EllermanARCHHEADING(i386 target only:, QEMU_ARCH_I386) 10895824d651Sblueswir1STEXI 10905824d651Sblueswir1@table @option 10915824d651Sblueswir1ETEXI 10925824d651Sblueswir1 10935824d651Sblueswir1DEF("win2k-hack", 0, QEMU_OPTION_win2k_hack, 1094ad96090aSBlue Swirl "-win2k-hack use it when installing Windows 2000 to avoid a disk full bug\n", 1095ad96090aSBlue Swirl QEMU_ARCH_I386) 10965824d651Sblueswir1STEXI 10975824d651Sblueswir1@item -win2k-hack 10986616b2adSStefan Weil@findex -win2k-hack 10995824d651Sblueswir1Use it when installing Windows 2000 to avoid a disk full bug. After 11005824d651Sblueswir1Windows 2000 is installed, you no longer need this option (this option 11015824d651Sblueswir1slows down the IDE transfers). 11025824d651Sblueswir1ETEXI 11035824d651Sblueswir1 11041ed2fc1fSJan KiszkaHXCOMM Deprecated by -rtc 1105ad96090aSBlue SwirlDEF("rtc-td-hack", 0, QEMU_OPTION_rtc_td_hack, "", QEMU_ARCH_I386) 11065824d651Sblueswir1 11075824d651Sblueswir1DEF("no-fd-bootchk", 0, QEMU_OPTION_no_fd_bootchk, 1108ad96090aSBlue Swirl "-no-fd-bootchk disable boot signature checking for floppy disks\n", 1109ad96090aSBlue Swirl QEMU_ARCH_I386) 11105824d651Sblueswir1STEXI 11115824d651Sblueswir1@item -no-fd-bootchk 11126616b2adSStefan Weil@findex -no-fd-bootchk 11135824d651Sblueswir1Disable boot signature checking for floppy disks in Bochs BIOS. It may 11145824d651Sblueswir1be needed to boot from old floppy disks. 11156616b2adSStefan WeilTODO: check reference to Bochs BIOS. 11165824d651Sblueswir1ETEXI 11175824d651Sblueswir1 11185824d651Sblueswir1DEF("no-acpi", 0, QEMU_OPTION_no_acpi, 1119ad96090aSBlue Swirl "-no-acpi disable ACPI\n", QEMU_ARCH_I386) 11205824d651Sblueswir1STEXI 11215824d651Sblueswir1@item -no-acpi 11226616b2adSStefan Weil@findex -no-acpi 11235824d651Sblueswir1Disable ACPI (Advanced Configuration and Power Interface) support. Use 11245824d651Sblueswir1it if your guest OS complains about ACPI problems (PC target machine 11255824d651Sblueswir1only). 11265824d651Sblueswir1ETEXI 11275824d651Sblueswir1 11285824d651Sblueswir1DEF("no-hpet", 0, QEMU_OPTION_no_hpet, 1129ad96090aSBlue Swirl "-no-hpet disable HPET\n", QEMU_ARCH_I386) 11305824d651Sblueswir1STEXI 11315824d651Sblueswir1@item -no-hpet 11326616b2adSStefan Weil@findex -no-hpet 11335824d651Sblueswir1Disable HPET support. 11345824d651Sblueswir1ETEXI 11355824d651Sblueswir1 11365824d651Sblueswir1DEF("acpitable", HAS_ARG, QEMU_OPTION_acpitable, 1137104bf02eSMichael 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" 1138ad96090aSBlue Swirl " ACPI table description\n", QEMU_ARCH_I386) 11395824d651Sblueswir1STEXI 11405824d651Sblueswir1@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}]...] 11416616b2adSStefan Weil@findex -acpitable 11425824d651Sblueswir1Add ACPI table with specified header fields and context from specified files. 1143104bf02eSMichael TokarevFor file=, take whole ACPI table from the specified files, including all 1144104bf02eSMichael TokarevACPI headers (possible overridden by other options). 1145104bf02eSMichael TokarevFor data=, only data 1146104bf02eSMichael Tokarevportion of the table is used, all header information is specified in the 1147104bf02eSMichael Tokarevcommand line. 11485824d651Sblueswir1ETEXI 11495824d651Sblueswir1 1150b6f6e3d3SaliguoriDEF("smbios", HAS_ARG, QEMU_OPTION_smbios, 1151b6f6e3d3Saliguori "-smbios file=binary\n" 1152ca1a8a06SBruce Rogers " load SMBIOS entry from binary file\n" 1153e8105ebbSPaolo Bonzini "-smbios type=0[,vendor=str][,version=str][,date=str][,release=%d.%d]\n" 1154ca1a8a06SBruce Rogers " specify SMBIOS type 0 fields\n" 1155b6f6e3d3Saliguori "-smbios type=1[,manufacturer=str][,product=str][,version=str][,serial=str]\n" 1156b6f6e3d3Saliguori " [,uuid=uuid][,sku=str][,family=str]\n" 1157ad96090aSBlue Swirl " specify SMBIOS type 1 fields\n", QEMU_ARCH_I386) 1158b6f6e3d3SaliguoriSTEXI 1159b6f6e3d3Saliguori@item -smbios file=@var{binary} 11606616b2adSStefan Weil@findex -smbios 1161b6f6e3d3SaliguoriLoad SMBIOS entry from binary file. 1162b6f6e3d3Saliguori 1163b6f6e3d3Saliguori@item -smbios type=0[,vendor=@var{str}][,version=@var{str}][,date=@var{str}][,release=@var{%d.%d}] 11646616b2adSStefan Weil@findex -smbios 1165b6f6e3d3SaliguoriSpecify SMBIOS type 0 fields 1166b6f6e3d3Saliguori 1167b6f6e3d3Saliguori@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}] 1168b6f6e3d3SaliguoriSpecify SMBIOS type 1 fields 1169b6f6e3d3SaliguoriETEXI 1170b6f6e3d3Saliguori 11715824d651Sblueswir1DEFHEADING() 11725824d651Sblueswir1STEXI 11735824d651Sblueswir1@end table 11745824d651Sblueswir1ETEXI 11755824d651Sblueswir1 11765824d651Sblueswir1DEFHEADING(Network options:) 11775824d651Sblueswir1STEXI 11785824d651Sblueswir1@table @option 11795824d651Sblueswir1ETEXI 11805824d651Sblueswir1 1181ad196a9dSJan KiszkaHXCOMM Legacy slirp options (now moved to -net user): 1182ad196a9dSJan Kiszka#ifdef CONFIG_SLIRP 1183ad96090aSBlue SwirlDEF("tftp", HAS_ARG, QEMU_OPTION_tftp, "", QEMU_ARCH_ALL) 1184ad96090aSBlue SwirlDEF("bootp", HAS_ARG, QEMU_OPTION_bootp, "", QEMU_ARCH_ALL) 1185ad96090aSBlue SwirlDEF("redir", HAS_ARG, QEMU_OPTION_redir, "", QEMU_ARCH_ALL) 1186ad196a9dSJan Kiszka#ifndef _WIN32 1187ad96090aSBlue SwirlDEF("smb", HAS_ARG, QEMU_OPTION_smb, "", QEMU_ARCH_ALL) 1188ad196a9dSJan Kiszka#endif 1189ad196a9dSJan Kiszka#endif 1190ad196a9dSJan Kiszka 1191bab7944cSBlue SwirlDEF("net", HAS_ARG, QEMU_OPTION_net, 1192ffe6370cSMichael S. Tsirkin "-net nic[,vlan=n][,macaddr=mac][,model=type][,name=str][,addr=str][,vectors=v]\n" 11935824d651Sblueswir1 " create a new Network Interface Card and connect it to VLAN 'n'\n" 11945824d651Sblueswir1#ifdef CONFIG_SLIRP 1195c54ed5bcSJan Kiszka "-net user[,vlan=n][,name=str][,net=addr[/mask]][,host=addr][,restrict=on|off]\n" 1196c92ef6a2SJan Kiszka " [,hostname=host][,dhcpstart=addr][,dns=addr][,tftp=dir][,bootfile=f]\n" 1197c92ef6a2SJan Kiszka " [,hostfwd=rule][,guestfwd=rule]" 1198ad196a9dSJan Kiszka#ifndef _WIN32 1199c92ef6a2SJan Kiszka "[,smb=dir[,smbserver=addr]]\n" 1200ad196a9dSJan Kiszka#endif 1201ad196a9dSJan Kiszka " connect the user mode network stack to VLAN 'n', configure its\n" 1202ad196a9dSJan Kiszka " DHCP server and enabled optional services\n" 12035824d651Sblueswir1#endif 12045824d651Sblueswir1#ifdef _WIN32 12055824d651Sblueswir1 "-net tap[,vlan=n][,name=str],ifname=name\n" 12065824d651Sblueswir1 " connect the host TAP network interface to VLAN 'n'\n" 12075824d651Sblueswir1#else 12085430a28fSmst@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" 12095824d651Sblueswir1 " connect the host TAP network interface to VLAN 'n' and use the\n" 1210bec7c2d4SPaolo Bonzini " network scripts 'file' (default=" DEFAULT_NETWORK_SCRIPT ")\n" 1211bec7c2d4SPaolo Bonzini " and 'dfile' (default=" DEFAULT_NETWORK_DOWN_SCRIPT ")\n" 1212ca1a8a06SBruce Rogers " use '[down]script=no' to disable script execution\n" 12135824d651Sblueswir1 " use 'fd=h' to connect to an already opened TAP interface\n" 1214ca1a8a06SBruce Rogers " use 'sndbuf=nbytes' to limit the size of the send buffer (the\n" 1215f157ed20SMichael S. Tsirkin " default is disabled 'sndbuf=0' to enable flow control set 'sndbuf=1048576')\n" 1216ca1a8a06SBruce Rogers " use vnet_hdr=off to avoid enabling the IFF_VNET_HDR tap flag\n" 1217ca1a8a06SBruce Rogers " use vnet_hdr=on to make the lack of IFF_VNET_HDR support an error condition\n" 121882b0d80eSMichael S. Tsirkin " use vhost=on to enable experimental in kernel accelerator\n" 12195430a28fSmst@redhat.com " (only has effect for virtio guests which use MSIX)\n" 12205430a28fSmst@redhat.com " use vhostforce=on to force vhost on for non-MSIX virtio guests\n" 122182b0d80eSMichael S. Tsirkin " use 'vhostfd=h' to connect to an already opened vhost net device\n" 12220df0ff6dSMark McLoughlin#endif 12235824d651Sblueswir1 "-net socket[,vlan=n][,name=str][,fd=h][,listen=[host]:port][,connect=host:port]\n" 12245824d651Sblueswir1 " connect the vlan 'n' to another VLAN using a socket connection\n" 12253a75e74cSMike Ryan "-net socket[,vlan=n][,name=str][,fd=h][,mcast=maddr:port[,localaddr=addr]]\n" 12265824d651Sblueswir1 " connect the vlan 'n' to multicast maddr and port\n" 12273a75e74cSMike Ryan " use 'localaddr=addr' to specify the host address to send packets from\n" 12285824d651Sblueswir1#ifdef CONFIG_VDE 12295824d651Sblueswir1 "-net vde[,vlan=n][,name=str][,sock=socketpath][,port=n][,group=groupname][,mode=octalmode]\n" 12305824d651Sblueswir1 " connect the vlan 'n' to port 'n' of a vde switch running\n" 12315824d651Sblueswir1 " on host and listening for incoming connections on 'socketpath'.\n" 12325824d651Sblueswir1 " Use group 'groupname' and mode 'octalmode' to change default\n" 12335824d651Sblueswir1 " ownership and permissions for communication port.\n" 12345824d651Sblueswir1#endif 1235bb9ea79eSaliguori "-net dump[,vlan=n][,file=f][,len=n]\n" 1236bb9ea79eSaliguori " dump traffic on vlan 'n' to file 'f' (max n bytes per packet)\n" 1237ca1a8a06SBruce Rogers "-net none use it alone to have zero network devices. If no -net option\n" 1238ad96090aSBlue Swirl " is provided, the default is '-net nic -net user'\n", QEMU_ARCH_ALL) 1239a1ea458fSMark McLoughlinDEF("netdev", HAS_ARG, QEMU_OPTION_netdev, 1240a1ea458fSMark McLoughlin "-netdev [" 1241a1ea458fSMark McLoughlin#ifdef CONFIG_SLIRP 1242a1ea458fSMark McLoughlin "user|" 1243a1ea458fSMark McLoughlin#endif 1244a1ea458fSMark McLoughlin "tap|" 1245a1ea458fSMark McLoughlin#ifdef CONFIG_VDE 1246a1ea458fSMark McLoughlin "vde|" 1247a1ea458fSMark McLoughlin#endif 1248ad96090aSBlue Swirl "socket],id=str[,option][,option][,...]\n", QEMU_ARCH_ALL) 12495824d651Sblueswir1STEXI 1250ffe6370cSMichael S. Tsirkin@item -net nic[,vlan=@var{n}][,macaddr=@var{mac}][,model=@var{type}] [,name=@var{name}][,addr=@var{addr}][,vectors=@var{v}] 12516616b2adSStefan Weil@findex -net 12525824d651Sblueswir1Create a new Network Interface Card and connect it to VLAN @var{n} (@var{n} 12530d6b0b1dSAnthony Liguori= 0 is the default). The NIC is an e1000 by default on the PC 12545607c388SMarkus Armbrustertarget. Optionally, the MAC address can be changed to @var{mac}, the 12555607c388SMarkus Armbrusterdevice address set to @var{addr} (PCI cards only), 1256ffe6370cSMichael S. Tsirkinand a @var{name} can be assigned for use in monitor commands. 1257ffe6370cSMichael S. TsirkinOptionally, for PCI cards, you can specify the number @var{v} of MSI-X vectors 1258ffe6370cSMichael S. Tsirkinthat the card should have; this option currently only affects virtio cards; set 1259ffe6370cSMichael S. Tsirkin@var{v} = 0 to disable MSI-X. If no @option{-net} option is specified, a single 1260ffe6370cSMichael S. TsirkinNIC is created. Qemu can emulate several different models of network card. 12615824d651Sblueswir1Valid values for @var{type} are 1262ffe6370cSMichael S. Tsirkin@code{virtio}, @code{i82551}, @code{i82557b}, @code{i82559er}, 12635824d651Sblueswir1@code{ne2k_pci}, @code{ne2k_isa}, @code{pcnet}, @code{rtl8139}, 12645824d651Sblueswir1@code{e1000}, @code{smc91c111}, @code{lance} and @code{mcf_fec}. 12655824d651Sblueswir1Not all devices are supported on all targets. Use -net nic,model=? 12665824d651Sblueswir1for a list of available devices for your target. 12675824d651Sblueswir1 1268ad196a9dSJan Kiszka@item -net user[,@var{option}][,@var{option}][,...] 12695824d651Sblueswir1Use the user mode network stack which requires no administrator 1270ad196a9dSJan Kiszkaprivilege to run. Valid options are: 12715824d651Sblueswir1 1272b3f046c2SKevin Wolf@table @option 1273ad196a9dSJan Kiszka@item vlan=@var{n} 1274ad196a9dSJan KiszkaConnect user mode stack to VLAN @var{n} (@var{n} = 0 is the default). 1275ad196a9dSJan Kiszka 1276ad196a9dSJan Kiszka@item name=@var{name} 1277ad196a9dSJan KiszkaAssign symbolic name for use in monitor commands. 1278ad196a9dSJan Kiszka 1279c92ef6a2SJan Kiszka@item net=@var{addr}[/@var{mask}] 1280c92ef6a2SJan KiszkaSet IP network address the guest will see. Optionally specify the netmask, 1281c92ef6a2SJan Kiszkaeither in the form a.b.c.d or as number of valid top-most bits. Default is 1282b0b36e5dSBrad Hards10.0.2.0/24. 1283c92ef6a2SJan Kiszka 1284c92ef6a2SJan Kiszka@item host=@var{addr} 1285c92ef6a2SJan KiszkaSpecify the guest-visible address of the host. Default is the 2nd IP in the 1286c92ef6a2SJan Kiszkaguest network, i.e. x.x.x.2. 1287ad196a9dSJan Kiszka 1288c54ed5bcSJan Kiszka@item restrict=on|off 1289caef55edSBrad HardsIf this option is enabled, the guest will be isolated, i.e. it will not be 1290ad196a9dSJan Kiszkaable to contact the host and no guest IP packets will be routed over the host 1291caef55edSBrad Hardsto the outside. This option does not affect any explicitly set forwarding rules. 1292ad196a9dSJan Kiszka 1293ad196a9dSJan Kiszka@item hostname=@var{name} 1294ad196a9dSJan KiszkaSpecifies the client hostname reported by the builtin DHCP server. 1295ad196a9dSJan Kiszka 1296c92ef6a2SJan Kiszka@item dhcpstart=@var{addr} 1297c92ef6a2SJan KiszkaSpecify the first of the 16 IPs the built-in DHCP server can assign. Default 1298b0b36e5dSBrad Hardsis the 15th to 31st IP in the guest network, i.e. x.x.x.15 to x.x.x.31. 1299c92ef6a2SJan Kiszka 1300c92ef6a2SJan Kiszka@item dns=@var{addr} 1301c92ef6a2SJan KiszkaSpecify the guest-visible address of the virtual nameserver. The address must 1302c92ef6a2SJan Kiszkabe different from the host address. Default is the 3rd IP in the guest network, 1303c92ef6a2SJan Kiszkai.e. x.x.x.3. 1304c92ef6a2SJan Kiszka 1305ad196a9dSJan Kiszka@item tftp=@var{dir} 1306ad196a9dSJan KiszkaWhen using the user mode network stack, activate a built-in TFTP 1307ad196a9dSJan Kiszkaserver. The files in @var{dir} will be exposed as the root of a TFTP server. 1308ad196a9dSJan KiszkaThe TFTP client on the guest must be configured in binary mode (use the command 1309c92ef6a2SJan Kiszka@code{bin} of the Unix TFTP client). 1310ad196a9dSJan Kiszka 1311ad196a9dSJan Kiszka@item bootfile=@var{file} 1312ad196a9dSJan KiszkaWhen using the user mode network stack, broadcast @var{file} as the BOOTP 1313ad196a9dSJan Kiszkafilename. In conjunction with @option{tftp}, this can be used to network boot 1314ad196a9dSJan Kiszkaa guest from a local directory. 1315ad196a9dSJan Kiszka 1316ad196a9dSJan KiszkaExample (using pxelinux): 1317ad196a9dSJan Kiszka@example 1318ad196a9dSJan Kiszkaqemu -hda linux.img -boot n -net user,tftp=/path/to/tftp/files,bootfile=/pxelinux.0 1319ad196a9dSJan Kiszka@end example 1320ad196a9dSJan Kiszka 1321c92ef6a2SJan Kiszka@item smb=@var{dir}[,smbserver=@var{addr}] 1322ad196a9dSJan KiszkaWhen using the user mode network stack, activate a built-in SMB 1323ad196a9dSJan Kiszkaserver so that Windows OSes can access to the host files in @file{@var{dir}} 1324c92ef6a2SJan Kiszkatransparently. The IP address of the SMB server can be set to @var{addr}. By 1325c92ef6a2SJan Kiszkadefault the 4th IP in the guest network is used, i.e. x.x.x.4. 1326ad196a9dSJan Kiszka 1327ad196a9dSJan KiszkaIn the guest Windows OS, the line: 1328ad196a9dSJan Kiszka@example 1329ad196a9dSJan Kiszka10.0.2.4 smbserver 1330ad196a9dSJan Kiszka@end example 1331ad196a9dSJan Kiszkamust be added in the file @file{C:\WINDOWS\LMHOSTS} (for windows 9x/Me) 1332ad196a9dSJan Kiszkaor @file{C:\WINNT\SYSTEM32\DRIVERS\ETC\LMHOSTS} (Windows NT/2000). 1333ad196a9dSJan Kiszka 1334ad196a9dSJan KiszkaThen @file{@var{dir}} can be accessed in @file{\\smbserver\qemu}. 1335ad196a9dSJan Kiszka 1336e2d8830eSBradNote that a SAMBA server must be installed on the host OS. 1337e2d8830eSBradQEMU was tested successfully with smbd versions from Red Hat 9, 1338e2d8830eSBradFedora Core 3 and OpenSUSE 11.x. 1339ad196a9dSJan Kiszka 13403c6a0580SJan Kiszka@item hostfwd=[tcp|udp]:[@var{hostaddr}]:@var{hostport}-[@var{guestaddr}]:@var{guestport} 1341c92ef6a2SJan KiszkaRedirect incoming TCP or UDP connections to the host port @var{hostport} to 1342c92ef6a2SJan Kiszkathe guest IP address @var{guestaddr} on guest port @var{guestport}. If 1343c92ef6a2SJan Kiszka@var{guestaddr} is not specified, its value is x.x.x.15 (default first address 13443c6a0580SJan Kiszkagiven by the built-in DHCP server). By specifying @var{hostaddr}, the rule can 13453c6a0580SJan Kiszkabe bound to a specific host interface. If no connection type is set, TCP is 1346c92ef6a2SJan Kiszkaused. This option can be given multiple times. 1347ad196a9dSJan Kiszka 1348ad196a9dSJan KiszkaFor example, to redirect host X11 connection from screen 1 to guest 1349ad196a9dSJan Kiszkascreen 0, use the following: 1350ad196a9dSJan Kiszka 1351ad196a9dSJan Kiszka@example 1352ad196a9dSJan Kiszka# on the host 13533c6a0580SJan Kiszkaqemu -net user,hostfwd=tcp:127.0.0.1:6001-:6000 [...] 1354ad196a9dSJan Kiszka# this host xterm should open in the guest X11 server 1355ad196a9dSJan Kiszkaxterm -display :1 1356ad196a9dSJan Kiszka@end example 1357ad196a9dSJan Kiszka 1358ad196a9dSJan KiszkaTo redirect telnet connections from host port 5555 to telnet port on 1359ad196a9dSJan Kiszkathe guest, use the following: 1360ad196a9dSJan Kiszka 1361ad196a9dSJan Kiszka@example 1362ad196a9dSJan Kiszka# on the host 1363aa375206SAurelien Jarnoqemu -net user,hostfwd=tcp::5555-:23 [...] 1364ad196a9dSJan Kiszkatelnet localhost 5555 1365ad196a9dSJan Kiszka@end example 1366ad196a9dSJan Kiszka 1367ad196a9dSJan KiszkaThen when you use on the host @code{telnet localhost 5555}, you 1368ad196a9dSJan Kiszkaconnect to the guest telnet server. 1369ad196a9dSJan Kiszka 1370c92ef6a2SJan Kiszka@item guestfwd=[tcp]:@var{server}:@var{port}-@var{dev} 13713c6a0580SJan KiszkaForward guest TCP connections to the IP address @var{server} on port @var{port} 13723c6a0580SJan Kiszkato the character device @var{dev}. This option can be given multiple times. 1373ad196a9dSJan Kiszka 1374ad196a9dSJan Kiszka@end table 1375ad196a9dSJan Kiszka 1376ad196a9dSJan KiszkaNote: Legacy stand-alone options -tftp, -bootp, -smb and -redir are still 1377ad196a9dSJan Kiszkaprocessed and applied to -net user. Mixing them with the new configuration 1378ad196a9dSJan Kiszkasyntax gives undefined results. Their use for new applications is discouraged 1379ad196a9dSJan Kiszkaas they will be removed from future versions. 13805824d651Sblueswir1 13815824d651Sblueswir1@item -net tap[,vlan=@var{n}][,name=@var{name}][,fd=@var{h}][,ifname=@var{name}] [,script=@var{file}][,downscript=@var{dfile}] 13825824d651Sblueswir1Connect the host TAP network interface @var{name} to VLAN @var{n}, use 13835824d651Sblueswir1the network script @var{file} to configure it and the network script 13845824d651Sblueswir1@var{dfile} to deconfigure it. If @var{name} is not provided, the OS 13855824d651Sblueswir1automatically provides one. @option{fd}=@var{h} can be used to specify 13865824d651Sblueswir1the handle of an already opened host TAP interface. The default network 13875824d651Sblueswir1configure script is @file{/etc/qemu-ifup} and the default network 13885824d651Sblueswir1deconfigure script is @file{/etc/qemu-ifdown}. Use @option{script=no} 13895824d651Sblueswir1or @option{downscript=no} to disable script execution. Example: 13905824d651Sblueswir1 13915824d651Sblueswir1@example 13925824d651Sblueswir1qemu linux.img -net nic -net tap 13935824d651Sblueswir1@end example 13945824d651Sblueswir1 13955824d651Sblueswir1More complicated example (two NICs, each one connected to a TAP device) 13965824d651Sblueswir1@example 13975824d651Sblueswir1qemu linux.img -net nic,vlan=0 -net tap,vlan=0,ifname=tap0 \ 13985824d651Sblueswir1 -net nic,vlan=1 -net tap,vlan=1,ifname=tap1 13995824d651Sblueswir1@end example 14005824d651Sblueswir1 14015824d651Sblueswir1@item -net socket[,vlan=@var{n}][,name=@var{name}][,fd=@var{h}] [,listen=[@var{host}]:@var{port}][,connect=@var{host}:@var{port}] 14025824d651Sblueswir1 14035824d651Sblueswir1Connect the VLAN @var{n} to a remote VLAN in another QEMU virtual 14045824d651Sblueswir1machine using a TCP socket connection. If @option{listen} is 14055824d651Sblueswir1specified, QEMU waits for incoming connections on @var{port} 14065824d651Sblueswir1(@var{host} is optional). @option{connect} is used to connect to 14075824d651Sblueswir1another QEMU instance using the @option{listen} option. @option{fd}=@var{h} 14085824d651Sblueswir1specifies an already opened TCP socket. 14095824d651Sblueswir1 14105824d651Sblueswir1Example: 14115824d651Sblueswir1@example 14125824d651Sblueswir1# launch a first QEMU instance 14135824d651Sblueswir1qemu linux.img -net nic,macaddr=52:54:00:12:34:56 \ 14145824d651Sblueswir1 -net socket,listen=:1234 14155824d651Sblueswir1# connect the VLAN 0 of this instance to the VLAN 0 14165824d651Sblueswir1# of the first instance 14175824d651Sblueswir1qemu linux.img -net nic,macaddr=52:54:00:12:34:57 \ 14185824d651Sblueswir1 -net socket,connect=127.0.0.1:1234 14195824d651Sblueswir1@end example 14205824d651Sblueswir1 14213a75e74cSMike Ryan@item -net socket[,vlan=@var{n}][,name=@var{name}][,fd=@var{h}][,mcast=@var{maddr}:@var{port}[,localaddr=@var{addr}]] 14225824d651Sblueswir1 14235824d651Sblueswir1Create a VLAN @var{n} shared with another QEMU virtual 14245824d651Sblueswir1machines using a UDP multicast socket, effectively making a bus for 14255824d651Sblueswir1every QEMU with same multicast address @var{maddr} and @var{port}. 14265824d651Sblueswir1NOTES: 14275824d651Sblueswir1@enumerate 14285824d651Sblueswir1@item 14295824d651Sblueswir1Several QEMU can be running on different hosts and share same bus (assuming 14305824d651Sblueswir1correct multicast setup for these hosts). 14315824d651Sblueswir1@item 14325824d651Sblueswir1mcast support is compatible with User Mode Linux (argument @option{eth@var{N}=mcast}), see 14335824d651Sblueswir1@url{http://user-mode-linux.sf.net}. 14345824d651Sblueswir1@item 14355824d651Sblueswir1Use @option{fd=h} to specify an already opened UDP multicast socket. 14365824d651Sblueswir1@end enumerate 14375824d651Sblueswir1 14385824d651Sblueswir1Example: 14395824d651Sblueswir1@example 14405824d651Sblueswir1# launch one QEMU instance 14415824d651Sblueswir1qemu linux.img -net nic,macaddr=52:54:00:12:34:56 \ 14425824d651Sblueswir1 -net socket,mcast=230.0.0.1:1234 14435824d651Sblueswir1# launch another QEMU instance on same "bus" 14445824d651Sblueswir1qemu linux.img -net nic,macaddr=52:54:00:12:34:57 \ 14455824d651Sblueswir1 -net socket,mcast=230.0.0.1:1234 14465824d651Sblueswir1# launch yet another QEMU instance on same "bus" 14475824d651Sblueswir1qemu linux.img -net nic,macaddr=52:54:00:12:34:58 \ 14485824d651Sblueswir1 -net socket,mcast=230.0.0.1:1234 14495824d651Sblueswir1@end example 14505824d651Sblueswir1 14515824d651Sblueswir1Example (User Mode Linux compat.): 14525824d651Sblueswir1@example 14535824d651Sblueswir1# launch QEMU instance (note mcast address selected 14545824d651Sblueswir1# is UML's default) 14555824d651Sblueswir1qemu linux.img -net nic,macaddr=52:54:00:12:34:56 \ 14565824d651Sblueswir1 -net socket,mcast=239.192.168.1:1102 14575824d651Sblueswir1# launch UML 14585824d651Sblueswir1/path/to/linux ubd0=/path/to/root_fs eth0=mcast 14595824d651Sblueswir1@end example 14605824d651Sblueswir1 14613a75e74cSMike RyanExample (send packets from host's 1.2.3.4): 14623a75e74cSMike Ryan@example 14633a75e74cSMike Ryanqemu linux.img -net nic,macaddr=52:54:00:12:34:56 \ 14643a75e74cSMike Ryan -net socket,mcast=239.192.168.1:1102,localaddr=1.2.3.4 14653a75e74cSMike Ryan@end example 14663a75e74cSMike Ryan 14675824d651Sblueswir1@item -net vde[,vlan=@var{n}][,name=@var{name}][,sock=@var{socketpath}] [,port=@var{n}][,group=@var{groupname}][,mode=@var{octalmode}] 14685824d651Sblueswir1Connect VLAN @var{n} to PORT @var{n} of a vde switch running on host and 14695824d651Sblueswir1listening for incoming connections on @var{socketpath}. Use GROUP @var{groupname} 14705824d651Sblueswir1and MODE @var{octalmode} to change default ownership and permissions for 1471c1ba4e0bSStefan Weilcommunication port. This option is only available if QEMU has been compiled 14725824d651Sblueswir1with vde support enabled. 14735824d651Sblueswir1 14745824d651Sblueswir1Example: 14755824d651Sblueswir1@example 14765824d651Sblueswir1# launch vde switch 14775824d651Sblueswir1vde_switch -F -sock /tmp/myswitch 14785824d651Sblueswir1# launch QEMU instance 14795824d651Sblueswir1qemu linux.img -net nic -net vde,sock=/tmp/myswitch 14805824d651Sblueswir1@end example 14815824d651Sblueswir1 1482bb9ea79eSaliguori@item -net dump[,vlan=@var{n}][,file=@var{file}][,len=@var{len}] 1483bb9ea79eSaliguoriDump network traffic on VLAN @var{n} to file @var{file} (@file{qemu-vlan0.pcap} by default). 1484bb9ea79eSaliguoriAt most @var{len} bytes (64k by default) per packet are stored. The file format is 1485bb9ea79eSaliguorilibpcap, so it can be analyzed with tools such as tcpdump or Wireshark. 1486bb9ea79eSaliguori 14875824d651Sblueswir1@item -net none 14885824d651Sblueswir1Indicate that no network devices should be configured. It is used to 14895824d651Sblueswir1override the default configuration (@option{-net nic -net user}) which 14905824d651Sblueswir1is activated if no @option{-net} options are provided. 14915824d651Sblueswir1 14925824d651Sblueswir1@end table 14935824d651Sblueswir1ETEXI 14945824d651Sblueswir1 14957273a2dbSMatthew BoothDEFHEADING() 14967273a2dbSMatthew Booth 14977273a2dbSMatthew BoothDEFHEADING(Character device options:) 14987273a2dbSMatthew Booth 14997273a2dbSMatthew BoothDEF("chardev", HAS_ARG, QEMU_OPTION_chardev, 150097331287SJan Kiszka "-chardev null,id=id[,mux=on|off]\n" 15017273a2dbSMatthew Booth "-chardev socket,id=id[,host=host],port=host[,to=to][,ipv4][,ipv6][,nodelay]\n" 150297331287SJan Kiszka " [,server][,nowait][,telnet][,mux=on|off] (tcp)\n" 150397331287SJan Kiszka "-chardev socket,id=id,path=path[,server][,nowait][,telnet],[mux=on|off] (unix)\n" 15047273a2dbSMatthew Booth "-chardev udp,id=id[,host=host],port=port[,localaddr=localaddr]\n" 150597331287SJan Kiszka " [,localport=localport][,ipv4][,ipv6][,mux=on|off]\n" 150697331287SJan Kiszka "-chardev msmouse,id=id[,mux=on|off]\n" 15077273a2dbSMatthew Booth "-chardev vc,id=id[[,width=width][,height=height]][[,cols=cols][,rows=rows]]\n" 150897331287SJan Kiszka " [,mux=on|off]\n" 150997331287SJan Kiszka "-chardev file,id=id,path=path[,mux=on|off]\n" 151097331287SJan Kiszka "-chardev pipe,id=id,path=path[,mux=on|off]\n" 15117273a2dbSMatthew Booth#ifdef _WIN32 151297331287SJan Kiszka "-chardev console,id=id[,mux=on|off]\n" 151397331287SJan Kiszka "-chardev serial,id=id,path=path[,mux=on|off]\n" 15147273a2dbSMatthew Booth#else 151597331287SJan Kiszka "-chardev pty,id=id[,mux=on|off]\n" 1516b7fdb3abSAurelien Jarno "-chardev stdio,id=id[,mux=on|off][,signal=on|off]\n" 15177273a2dbSMatthew Booth#endif 15187273a2dbSMatthew Booth#ifdef CONFIG_BRLAPI 151997331287SJan Kiszka "-chardev braille,id=id[,mux=on|off]\n" 15207273a2dbSMatthew Booth#endif 15217273a2dbSMatthew Booth#if defined(__linux__) || defined(__sun__) || defined(__FreeBSD__) \ 15227273a2dbSMatthew Booth || defined(__NetBSD__) || defined(__OpenBSD__) || defined(__DragonFly__) 152397331287SJan Kiszka "-chardev tty,id=id,path=path[,mux=on|off]\n" 15247273a2dbSMatthew Booth#endif 15257273a2dbSMatthew Booth#if defined(__linux__) || defined(__FreeBSD__) || defined(__DragonFly__) 152697331287SJan Kiszka "-chardev parport,id=id,path=path[,mux=on|off]\n" 15277273a2dbSMatthew Booth#endif 1528cbcc6336SAlon Levy#if defined(CONFIG_SPICE) 1529cbcc6336SAlon Levy "-chardev spicevmc,id=id,name=name[,debug=debug]\n" 1530cbcc6336SAlon Levy#endif 1531ad96090aSBlue Swirl , QEMU_ARCH_ALL 15327273a2dbSMatthew Booth) 15337273a2dbSMatthew Booth 15347273a2dbSMatthew BoothSTEXI 15357273a2dbSMatthew Booth 15367273a2dbSMatthew BoothThe general form of a character device option is: 15377273a2dbSMatthew Booth@table @option 15387273a2dbSMatthew Booth 153997331287SJan Kiszka@item -chardev @var{backend} ,id=@var{id} [,mux=on|off] [,@var{options}] 15406616b2adSStefan Weil@findex -chardev 15417273a2dbSMatthew BoothBackend is one of: 15427273a2dbSMatthew Booth@option{null}, 15437273a2dbSMatthew Booth@option{socket}, 15447273a2dbSMatthew Booth@option{udp}, 15457273a2dbSMatthew Booth@option{msmouse}, 15467273a2dbSMatthew Booth@option{vc}, 15477273a2dbSMatthew Booth@option{file}, 15487273a2dbSMatthew Booth@option{pipe}, 15497273a2dbSMatthew Booth@option{console}, 15507273a2dbSMatthew Booth@option{serial}, 15517273a2dbSMatthew Booth@option{pty}, 15527273a2dbSMatthew Booth@option{stdio}, 15537273a2dbSMatthew Booth@option{braille}, 15547273a2dbSMatthew Booth@option{tty}, 1555cbcc6336SAlon Levy@option{parport}, 1556cbcc6336SAlon Levy@option{spicevmc}. 15577273a2dbSMatthew BoothThe specific backend will determine the applicable options. 15587273a2dbSMatthew Booth 15597273a2dbSMatthew BoothAll devices must have an id, which can be any string up to 127 characters long. 15607273a2dbSMatthew BoothIt is used to uniquely identify this device in other command line directives. 15617273a2dbSMatthew Booth 156297331287SJan KiszkaA character device may be used in multiplexing mode by multiple front-ends. 156397331287SJan KiszkaThe key sequence of @key{Control-a} and @key{c} will rotate the input focus 156497331287SJan Kiszkabetween attached front-ends. Specify @option{mux=on} to enable this mode. 156597331287SJan Kiszka 15667273a2dbSMatthew BoothOptions to each backend are described below. 15677273a2dbSMatthew Booth 15687273a2dbSMatthew Booth@item -chardev null ,id=@var{id} 15697273a2dbSMatthew BoothA void device. This device will not emit any data, and will drop any data it 15707273a2dbSMatthew Boothreceives. The null backend does not take any options. 15717273a2dbSMatthew Booth 15727273a2dbSMatthew Booth@item -chardev socket ,id=@var{id} [@var{TCP options} or @var{unix options}] [,server] [,nowait] [,telnet] 15737273a2dbSMatthew Booth 15747273a2dbSMatthew BoothCreate a two-way stream socket, which can be either a TCP or a unix socket. A 15757273a2dbSMatthew Boothunix socket will be created if @option{path} is specified. Behaviour is 15767273a2dbSMatthew Boothundefined if TCP options are specified for a unix socket. 15777273a2dbSMatthew Booth 15787273a2dbSMatthew Booth@option{server} specifies that the socket shall be a listening socket. 15797273a2dbSMatthew Booth 15807273a2dbSMatthew Booth@option{nowait} specifies that QEMU should not block waiting for a client to 15817273a2dbSMatthew Boothconnect to a listening socket. 15827273a2dbSMatthew Booth 15837273a2dbSMatthew Booth@option{telnet} specifies that traffic on the socket should interpret telnet 15847273a2dbSMatthew Boothescape sequences. 15857273a2dbSMatthew Booth 15867273a2dbSMatthew BoothTCP and unix socket options are given below: 15877273a2dbSMatthew Booth 15887273a2dbSMatthew Booth@table @option 15897273a2dbSMatthew Booth 15908d533561SAurelien Jarno@item TCP options: port=@var{port} [,host=@var{host}] [,to=@var{to}] [,ipv4] [,ipv6] [,nodelay] 15917273a2dbSMatthew Booth 15927273a2dbSMatthew Booth@option{host} for a listening socket specifies the local address to be bound. 15937273a2dbSMatthew BoothFor a connecting socket species the remote host to connect to. @option{host} is 15947273a2dbSMatthew Boothoptional for listening sockets. If not specified it defaults to @code{0.0.0.0}. 15957273a2dbSMatthew Booth 15967273a2dbSMatthew Booth@option{port} for a listening socket specifies the local port to be bound. For a 15977273a2dbSMatthew Boothconnecting socket specifies the port on the remote host to connect to. 15987273a2dbSMatthew Booth@option{port} can be given as either a port number or a service name. 15997273a2dbSMatthew Booth@option{port} is required. 16007273a2dbSMatthew Booth 16017273a2dbSMatthew Booth@option{to} is only relevant to listening sockets. If it is specified, and 16027273a2dbSMatthew Booth@option{port} cannot be bound, QEMU will attempt to bind to subsequent ports up 16037273a2dbSMatthew Boothto and including @option{to} until it succeeds. @option{to} must be specified 16047273a2dbSMatthew Boothas a port number. 16057273a2dbSMatthew Booth 16067273a2dbSMatthew Booth@option{ipv4} and @option{ipv6} specify that either IPv4 or IPv6 must be used. 16077273a2dbSMatthew BoothIf neither is specified the socket may use either protocol. 16087273a2dbSMatthew Booth 16097273a2dbSMatthew Booth@option{nodelay} disables the Nagle algorithm. 16107273a2dbSMatthew Booth 16117273a2dbSMatthew Booth@item unix options: path=@var{path} 16127273a2dbSMatthew Booth 16137273a2dbSMatthew Booth@option{path} specifies the local path of the unix socket. @option{path} is 16147273a2dbSMatthew Boothrequired. 16157273a2dbSMatthew Booth 16167273a2dbSMatthew Booth@end table 16177273a2dbSMatthew Booth 16187273a2dbSMatthew Booth@item -chardev udp ,id=@var{id} [,host=@var{host}] ,port=@var{port} [,localaddr=@var{localaddr}] [,localport=@var{localport}] [,ipv4] [,ipv6] 16197273a2dbSMatthew Booth 16207273a2dbSMatthew BoothSends all traffic from the guest to a remote host over UDP. 16217273a2dbSMatthew Booth 16227273a2dbSMatthew Booth@option{host} specifies the remote host to connect to. If not specified it 16237273a2dbSMatthew Boothdefaults to @code{localhost}. 16247273a2dbSMatthew Booth 16257273a2dbSMatthew Booth@option{port} specifies the port on the remote host to connect to. @option{port} 16267273a2dbSMatthew Boothis required. 16277273a2dbSMatthew Booth 16287273a2dbSMatthew Booth@option{localaddr} specifies the local address to bind to. If not specified it 16297273a2dbSMatthew Boothdefaults to @code{0.0.0.0}. 16307273a2dbSMatthew Booth 16317273a2dbSMatthew Booth@option{localport} specifies the local port to bind to. If not specified any 16327273a2dbSMatthew Boothavailable local port will be used. 16337273a2dbSMatthew Booth 16347273a2dbSMatthew Booth@option{ipv4} and @option{ipv6} specify that either IPv4 or IPv6 must be used. 16357273a2dbSMatthew BoothIf neither is specified the device may use either protocol. 16367273a2dbSMatthew Booth 16377273a2dbSMatthew Booth@item -chardev msmouse ,id=@var{id} 16387273a2dbSMatthew Booth 16397273a2dbSMatthew BoothForward QEMU's emulated msmouse events to the guest. @option{msmouse} does not 16407273a2dbSMatthew Boothtake any options. 16417273a2dbSMatthew Booth 16427273a2dbSMatthew Booth@item -chardev vc ,id=@var{id} [[,width=@var{width}] [,height=@var{height}]] [[,cols=@var{cols}] [,rows=@var{rows}]] 16437273a2dbSMatthew Booth 16447273a2dbSMatthew BoothConnect to a QEMU text console. @option{vc} may optionally be given a specific 16457273a2dbSMatthew Boothsize. 16467273a2dbSMatthew Booth 16477273a2dbSMatthew Booth@option{width} and @option{height} specify the width and height respectively of 16487273a2dbSMatthew Booththe console, in pixels. 16497273a2dbSMatthew Booth 16507273a2dbSMatthew Booth@option{cols} and @option{rows} specify that the console be sized to fit a text 16517273a2dbSMatthew Boothconsole with the given dimensions. 16527273a2dbSMatthew Booth 16537273a2dbSMatthew Booth@item -chardev file ,id=@var{id} ,path=@var{path} 16547273a2dbSMatthew Booth 16557273a2dbSMatthew BoothLog all traffic received from the guest to a file. 16567273a2dbSMatthew Booth 16577273a2dbSMatthew Booth@option{path} specifies the path of the file to be opened. This file will be 16587273a2dbSMatthew Boothcreated if it does not already exist, and overwritten if it does. @option{path} 16597273a2dbSMatthew Boothis required. 16607273a2dbSMatthew Booth 16617273a2dbSMatthew Booth@item -chardev pipe ,id=@var{id} ,path=@var{path} 16627273a2dbSMatthew Booth 16637273a2dbSMatthew BoothCreate a two-way connection to the guest. The behaviour differs slightly between 16647273a2dbSMatthew BoothWindows hosts and other hosts: 16657273a2dbSMatthew Booth 16667273a2dbSMatthew BoothOn Windows, a single duplex pipe will be created at 16677273a2dbSMatthew Booth@file{\\.pipe\@option{path}}. 16687273a2dbSMatthew Booth 16697273a2dbSMatthew BoothOn other hosts, 2 pipes will be created called @file{@option{path}.in} and 16707273a2dbSMatthew Booth@file{@option{path}.out}. Data written to @file{@option{path}.in} will be 16717273a2dbSMatthew Boothreceived by the guest. Data written by the guest can be read from 16727273a2dbSMatthew Booth@file{@option{path}.out}. QEMU will not create these fifos, and requires them to 16737273a2dbSMatthew Boothbe present. 16747273a2dbSMatthew Booth 16757273a2dbSMatthew Booth@option{path} forms part of the pipe path as described above. @option{path} is 16767273a2dbSMatthew Boothrequired. 16777273a2dbSMatthew Booth 16787273a2dbSMatthew Booth@item -chardev console ,id=@var{id} 16797273a2dbSMatthew Booth 16807273a2dbSMatthew BoothSend traffic from the guest to QEMU's standard output. @option{console} does not 16817273a2dbSMatthew Boothtake any options. 16827273a2dbSMatthew Booth 16837273a2dbSMatthew Booth@option{console} is only available on Windows hosts. 16847273a2dbSMatthew Booth 16857273a2dbSMatthew Booth@item -chardev serial ,id=@var{id} ,path=@option{path} 16867273a2dbSMatthew Booth 16877273a2dbSMatthew BoothSend traffic from the guest to a serial device on the host. 16887273a2dbSMatthew Booth 16897273a2dbSMatthew Booth@option{serial} is 16907273a2dbSMatthew Boothonly available on Windows hosts. 16917273a2dbSMatthew Booth 16927273a2dbSMatthew Booth@option{path} specifies the name of the serial device to open. 16937273a2dbSMatthew Booth 16947273a2dbSMatthew Booth@item -chardev pty ,id=@var{id} 16957273a2dbSMatthew Booth 16967273a2dbSMatthew BoothCreate a new pseudo-terminal on the host and connect to it. @option{pty} does 16977273a2dbSMatthew Boothnot take any options. 16987273a2dbSMatthew Booth 16997273a2dbSMatthew Booth@option{pty} is not available on Windows hosts. 17007273a2dbSMatthew Booth 1701b7fdb3abSAurelien Jarno@item -chardev stdio ,id=@var{id} [,signal=on|off] 17027273a2dbSMatthew BoothConnect to standard input and standard output of the qemu process. 1703b7fdb3abSAurelien Jarno 1704b7fdb3abSAurelien Jarno@option{signal} controls if signals are enabled on the terminal, that includes 1705b7fdb3abSAurelien Jarnoexiting QEMU with the key sequence @key{Control-c}. This option is enabled by 1706b7fdb3abSAurelien Jarnodefault, use @option{signal=off} to disable it. 1707b7fdb3abSAurelien Jarno 1708b7fdb3abSAurelien Jarno@option{stdio} is not available on Windows hosts. 17097273a2dbSMatthew Booth 17107273a2dbSMatthew Booth@item -chardev braille ,id=@var{id} 17117273a2dbSMatthew Booth 17127273a2dbSMatthew BoothConnect to a local BrlAPI server. @option{braille} does not take any options. 17137273a2dbSMatthew Booth 17147273a2dbSMatthew Booth@item -chardev tty ,id=@var{id} ,path=@var{path} 17157273a2dbSMatthew Booth 17167273a2dbSMatthew BoothConnect to a local tty device. 17177273a2dbSMatthew Booth 17187273a2dbSMatthew Booth@option{tty} is only available on Linux, Sun, FreeBSD, NetBSD, OpenBSD and 17197273a2dbSMatthew BoothDragonFlyBSD hosts. 17207273a2dbSMatthew Booth 17217273a2dbSMatthew Booth@option{path} specifies the path to the tty. @option{path} is required. 17227273a2dbSMatthew Booth 17237273a2dbSMatthew Booth@item -chardev parport ,id=@var{id} ,path=@var{path} 17247273a2dbSMatthew Booth 17257273a2dbSMatthew Booth@option{parport} is only available on Linux, FreeBSD and DragonFlyBSD hosts. 17267273a2dbSMatthew Booth 17277273a2dbSMatthew BoothConnect to a local parallel port. 17287273a2dbSMatthew Booth 17297273a2dbSMatthew Booth@option{path} specifies the path to the parallel port device. @option{path} is 17307273a2dbSMatthew Boothrequired. 17317273a2dbSMatthew Booth 1732cbcc6336SAlon Levy@item -chardev spicevmc ,id=@var{id} ,debug=@var{debug}, name=@var{name} 1733cbcc6336SAlon Levy 17343a846906SStefan Hajnoczi@option{spicevmc} is only available when spice support is built in. 17353a846906SStefan Hajnoczi 1736cbcc6336SAlon Levy@option{debug} debug level for spicevmc 1737cbcc6336SAlon Levy 1738cbcc6336SAlon Levy@option{name} name of spice channel to connect to 1739cbcc6336SAlon Levy 1740cbcc6336SAlon LevyConnect to a spice virtual machine channel, such as vdiport. 1741cbcc6336SAlon Levy 17427273a2dbSMatthew Booth@end table 17437273a2dbSMatthew BoothETEXI 17447273a2dbSMatthew Booth 17457273a2dbSMatthew BoothDEFHEADING() 17467273a2dbSMatthew Booth 17470f5314a2SRonnie SahlbergSTEXI 17480f5314a2SRonnie SahlbergDEFHEADING(Device URL Syntax:) 17490f5314a2SRonnie Sahlberg 17500f5314a2SRonnie SahlbergIn addition to using normal file images for the emulated storage devices, 17510f5314a2SRonnie SahlbergQEMU can also use networked resources such as iSCSI devices. These are 17520f5314a2SRonnie Sahlbergspecified using a special URL syntax. 17530f5314a2SRonnie Sahlberg 17540f5314a2SRonnie Sahlberg@table @option 17550f5314a2SRonnie Sahlberg@item iSCSI 17560f5314a2SRonnie SahlbergiSCSI support allows QEMU to access iSCSI resources directly and use as 17570f5314a2SRonnie Sahlbergimages for the guest storage. Both disk and cdrom images are supported. 17580f5314a2SRonnie Sahlberg 17590f5314a2SRonnie SahlbergSyntax for specifying iSCSI LUNs is 17600f5314a2SRonnie Sahlberg``iscsi://<target-ip>[:<port>]/<target-iqn>/<lun>'' 17610f5314a2SRonnie Sahlberg 17620f5314a2SRonnie SahlbergExample (without authentication): 17630f5314a2SRonnie Sahlberg@example 17640f5314a2SRonnie Sahlbergqemu -cdrom iscsi://192.0.2.1/iqn.2001-04.com.example/2 \ 17650f5314a2SRonnie Sahlberg--drive file=iscsi://192.0.2.1/iqn.2001-04.com.example/1 17660f5314a2SRonnie Sahlberg@end example 17670f5314a2SRonnie Sahlberg 17680f5314a2SRonnie SahlbergExample (CHAP username/password via URL): 17690f5314a2SRonnie Sahlberg@example 17700f5314a2SRonnie Sahlbergqemu --drive file=iscsi://user%password@@192.0.2.1/iqn.2001-04.com.example/1 17710f5314a2SRonnie Sahlberg@end example 17720f5314a2SRonnie Sahlberg 17730f5314a2SRonnie SahlbergExample (CHAP username/password via environment variables): 17740f5314a2SRonnie Sahlberg@example 17750f5314a2SRonnie SahlbergLIBISCSI_CHAP_USERNAME="user" \ 17760f5314a2SRonnie SahlbergLIBISCSI_CHAP_PASSWORD="password" \ 17770f5314a2SRonnie Sahlbergqemu --drive file=iscsi://192.0.2.1/iqn.2001-04.com.example/1 17780f5314a2SRonnie Sahlberg@end example 17790f5314a2SRonnie Sahlberg 17800f5314a2SRonnie SahlbergiSCSI support is an optional feature of QEMU and only available when 17810f5314a2SRonnie Sahlbergcompiled and linked against libiscsi. 17820f5314a2SRonnie Sahlberg 178308ae330eSRonnie Sahlberg@item NBD 178408ae330eSRonnie SahlbergQEMU supports NBD (Network Block Devices) both using TCP protocol as well 178508ae330eSRonnie Sahlbergas Unix Domain Sockets. 178608ae330eSRonnie Sahlberg 178708ae330eSRonnie SahlbergSyntax for specifying a NBD device using TCP 178808ae330eSRonnie Sahlberg``nbd:<server-ip>:<port>[:exportname=<export>]'' 178908ae330eSRonnie Sahlberg 179008ae330eSRonnie SahlbergSyntax for specifying a NBD device using Unix Domain Sockets 179108ae330eSRonnie Sahlberg``nbd:unix:<domain-socket>[:exportname=<export>]'' 179208ae330eSRonnie Sahlberg 179308ae330eSRonnie Sahlberg 179408ae330eSRonnie SahlbergExample for TCP 179508ae330eSRonnie Sahlberg@example 179608ae330eSRonnie Sahlbergqemu --drive file=nbd:192.0.2.1:30000 179708ae330eSRonnie Sahlberg@end example 179808ae330eSRonnie Sahlberg 179908ae330eSRonnie SahlbergExample for Unix Domain Sockets 180008ae330eSRonnie Sahlberg@example 180108ae330eSRonnie Sahlbergqemu --drive file=nbd:unix:/tmp/nbd-socket 180208ae330eSRonnie Sahlberg@end example 180308ae330eSRonnie Sahlberg 1804d9990228SRonnie Sahlberg@item Sheepdog 1805d9990228SRonnie SahlbergSheepdog is a distributed storage system for QEMU. 1806d9990228SRonnie SahlbergQEMU supports using either local sheepdog devices or remote networked 1807d9990228SRonnie Sahlbergdevices. 1808d9990228SRonnie Sahlberg 1809d9990228SRonnie SahlbergSyntax for specifying a sheepdog device 1810d9990228SRonnie Sahlberg@table @list 1811d9990228SRonnie Sahlberg``sheepdog:<vdiname>'' 1812d9990228SRonnie Sahlberg 1813d9990228SRonnie Sahlberg``sheepdog:<vdiname>:<snapid>'' 1814d9990228SRonnie Sahlberg 1815d9990228SRonnie Sahlberg``sheepdog:<vdiname>:<tag>'' 1816d9990228SRonnie Sahlberg 1817d9990228SRonnie Sahlberg``sheepdog:<host>:<port>:<vdiname>'' 1818d9990228SRonnie Sahlberg 1819d9990228SRonnie Sahlberg``sheepdog:<host>:<port>:<vdiname>:<snapid>'' 1820d9990228SRonnie Sahlberg 1821d9990228SRonnie Sahlberg``sheepdog:<host>:<port>:<vdiname>:<tag>'' 1822d9990228SRonnie Sahlberg@end table 1823d9990228SRonnie Sahlberg 1824d9990228SRonnie SahlbergExample 1825d9990228SRonnie Sahlberg@example 1826d9990228SRonnie Sahlbergqemu --drive file=sheepdog:192.0.2.1:30000:MyVirtualMachine 1827d9990228SRonnie Sahlberg@end example 1828d9990228SRonnie Sahlberg 1829d9990228SRonnie SahlbergSee also @url{http://http://www.osrg.net/sheepdog/}. 1830d9990228SRonnie Sahlberg 18310f5314a2SRonnie Sahlberg@end table 18320f5314a2SRonnie SahlbergETEXI 18330f5314a2SRonnie Sahlberg 18347273a2dbSMatthew BoothDEFHEADING(Bluetooth(R) options:) 18357273a2dbSMatthew Booth 18365824d651Sblueswir1DEF("bt", HAS_ARG, QEMU_OPTION_bt, \ 18375824d651Sblueswir1 "-bt hci,null dumb bluetooth HCI - doesn't respond to commands\n" \ 18385824d651Sblueswir1 "-bt hci,host[:id]\n" \ 18395824d651Sblueswir1 " use host's HCI with the given name\n" \ 18405824d651Sblueswir1 "-bt hci[,vlan=n]\n" \ 18415824d651Sblueswir1 " emulate a standard HCI in virtual scatternet 'n'\n" \ 18425824d651Sblueswir1 "-bt vhci[,vlan=n]\n" \ 18435824d651Sblueswir1 " add host computer to virtual scatternet 'n' using VHCI\n" \ 18445824d651Sblueswir1 "-bt device:dev[,vlan=n]\n" \ 1845ad96090aSBlue Swirl " emulate a bluetooth device 'dev' in scatternet 'n'\n", 1846ad96090aSBlue Swirl QEMU_ARCH_ALL) 18475824d651Sblueswir1STEXI 18485824d651Sblueswir1@table @option 18495824d651Sblueswir1 18505824d651Sblueswir1@item -bt hci[...] 18516616b2adSStefan Weil@findex -bt 18525824d651Sblueswir1Defines the function of the corresponding Bluetooth HCI. -bt options 18535824d651Sblueswir1are matched with the HCIs present in the chosen machine type. For 18545824d651Sblueswir1example when emulating a machine with only one HCI built into it, only 18555824d651Sblueswir1the first @code{-bt hci[...]} option is valid and defines the HCI's 18565824d651Sblueswir1logic. The Transport Layer is decided by the machine type. Currently 18575824d651Sblueswir1the machines @code{n800} and @code{n810} have one HCI and all other 18585824d651Sblueswir1machines have none. 18595824d651Sblueswir1 18605824d651Sblueswir1@anchor{bt-hcis} 18615824d651Sblueswir1The following three types are recognized: 18625824d651Sblueswir1 1863b3f046c2SKevin Wolf@table @option 18645824d651Sblueswir1@item -bt hci,null 18655824d651Sblueswir1(default) The corresponding Bluetooth HCI assumes no internal logic 18665824d651Sblueswir1and will not respond to any HCI commands or emit events. 18675824d651Sblueswir1 18685824d651Sblueswir1@item -bt hci,host[:@var{id}] 18695824d651Sblueswir1(@code{bluez} only) The corresponding HCI passes commands / events 18705824d651Sblueswir1to / from the physical HCI identified by the name @var{id} (default: 18715824d651Sblueswir1@code{hci0}) on the computer running QEMU. Only available on @code{bluez} 18725824d651Sblueswir1capable systems like Linux. 18735824d651Sblueswir1 18745824d651Sblueswir1@item -bt hci[,vlan=@var{n}] 18755824d651Sblueswir1Add a virtual, standard HCI that will participate in the Bluetooth 18765824d651Sblueswir1scatternet @var{n} (default @code{0}). Similarly to @option{-net} 18775824d651Sblueswir1VLANs, devices inside a bluetooth network @var{n} can only communicate 18785824d651Sblueswir1with other devices in the same network (scatternet). 18795824d651Sblueswir1@end table 18805824d651Sblueswir1 18815824d651Sblueswir1@item -bt vhci[,vlan=@var{n}] 18825824d651Sblueswir1(Linux-host only) Create a HCI in scatternet @var{n} (default 0) attached 18835824d651Sblueswir1to the host bluetooth stack instead of to the emulated target. This 18845824d651Sblueswir1allows the host and target machines to participate in a common scatternet 18855824d651Sblueswir1and communicate. Requires the Linux @code{vhci} driver installed. Can 18865824d651Sblueswir1be used as following: 18875824d651Sblueswir1 18885824d651Sblueswir1@example 18895824d651Sblueswir1qemu [...OPTIONS...] -bt hci,vlan=5 -bt vhci,vlan=5 18905824d651Sblueswir1@end example 18915824d651Sblueswir1 18925824d651Sblueswir1@item -bt device:@var{dev}[,vlan=@var{n}] 18935824d651Sblueswir1Emulate a bluetooth device @var{dev} and place it in network @var{n} 18945824d651Sblueswir1(default @code{0}). QEMU can only emulate one type of bluetooth devices 18955824d651Sblueswir1currently: 18965824d651Sblueswir1 1897b3f046c2SKevin Wolf@table @option 18985824d651Sblueswir1@item keyboard 18995824d651Sblueswir1Virtual wireless keyboard implementing the HIDP bluetooth profile. 19005824d651Sblueswir1@end table 19015824d651Sblueswir1@end table 19025824d651Sblueswir1ETEXI 19035824d651Sblueswir1 19045824d651Sblueswir1DEFHEADING() 19055824d651Sblueswir1 19067677f05dSAlexander GrafDEFHEADING(Linux/Multiboot boot specific:) 19075824d651Sblueswir1STEXI 19087677f05dSAlexander Graf 19097677f05dSAlexander GrafWhen using these options, you can use a given Linux or Multiboot 19107677f05dSAlexander Grafkernel without installing it in the disk image. It can be useful 19115824d651Sblueswir1for easier testing of various kernels. 19125824d651Sblueswir1 19135824d651Sblueswir1@table @option 19145824d651Sblueswir1ETEXI 19155824d651Sblueswir1 19165824d651Sblueswir1DEF("kernel", HAS_ARG, QEMU_OPTION_kernel, \ 1917ad96090aSBlue Swirl "-kernel bzImage use 'bzImage' as kernel image\n", QEMU_ARCH_ALL) 19185824d651Sblueswir1STEXI 19195824d651Sblueswir1@item -kernel @var{bzImage} 19206616b2adSStefan Weil@findex -kernel 19217677f05dSAlexander GrafUse @var{bzImage} as kernel image. The kernel can be either a Linux kernel 19227677f05dSAlexander Grafor in multiboot format. 19235824d651Sblueswir1ETEXI 19245824d651Sblueswir1 19255824d651Sblueswir1DEF("append", HAS_ARG, QEMU_OPTION_append, \ 1926ad96090aSBlue Swirl "-append cmdline use 'cmdline' as kernel command line\n", QEMU_ARCH_ALL) 19275824d651Sblueswir1STEXI 19285824d651Sblueswir1@item -append @var{cmdline} 19296616b2adSStefan Weil@findex -append 19305824d651Sblueswir1Use @var{cmdline} as kernel command line 19315824d651Sblueswir1ETEXI 19325824d651Sblueswir1 19335824d651Sblueswir1DEF("initrd", HAS_ARG, QEMU_OPTION_initrd, \ 1934ad96090aSBlue Swirl "-initrd file use 'file' as initial ram disk\n", QEMU_ARCH_ALL) 19355824d651Sblueswir1STEXI 19365824d651Sblueswir1@item -initrd @var{file} 19376616b2adSStefan Weil@findex -initrd 19385824d651Sblueswir1Use @var{file} as initial ram disk. 19397677f05dSAlexander Graf 19407677f05dSAlexander Graf@item -initrd "@var{file1} arg=foo,@var{file2}" 19417677f05dSAlexander Graf 19427677f05dSAlexander GrafThis syntax is only available with multiboot. 19437677f05dSAlexander Graf 19447677f05dSAlexander GrafUse @var{file1} and @var{file2} as modules and pass arg=foo as parameter to the 19457677f05dSAlexander Graffirst module. 19465824d651Sblueswir1ETEXI 19475824d651Sblueswir1 19485824d651Sblueswir1STEXI 19495824d651Sblueswir1@end table 19505824d651Sblueswir1ETEXI 19515824d651Sblueswir1 19525824d651Sblueswir1DEFHEADING() 19535824d651Sblueswir1 19545824d651Sblueswir1DEFHEADING(Debug/Expert options:) 19555824d651Sblueswir1 19565824d651Sblueswir1STEXI 19575824d651Sblueswir1@table @option 19585824d651Sblueswir1ETEXI 19595824d651Sblueswir1 19605824d651Sblueswir1DEF("serial", HAS_ARG, QEMU_OPTION_serial, \ 1961ad96090aSBlue Swirl "-serial dev redirect the serial port to char device 'dev'\n", 1962ad96090aSBlue Swirl QEMU_ARCH_ALL) 19635824d651Sblueswir1STEXI 19645824d651Sblueswir1@item -serial @var{dev} 19656616b2adSStefan Weil@findex -serial 19665824d651Sblueswir1Redirect the virtual serial port to host character device 19675824d651Sblueswir1@var{dev}. The default device is @code{vc} in graphical mode and 19685824d651Sblueswir1@code{stdio} in non graphical mode. 19695824d651Sblueswir1 19705824d651Sblueswir1This option can be used several times to simulate up to 4 serial 19715824d651Sblueswir1ports. 19725824d651Sblueswir1 19735824d651Sblueswir1Use @code{-serial none} to disable all serial ports. 19745824d651Sblueswir1 19755824d651Sblueswir1Available character devices are: 1976b3f046c2SKevin Wolf@table @option 19774e257e5eSKevin Wolf@item vc[:@var{W}x@var{H}] 19785824d651Sblueswir1Virtual console. Optionally, a width and height can be given in pixel with 19795824d651Sblueswir1@example 19805824d651Sblueswir1vc:800x600 19815824d651Sblueswir1@end example 19825824d651Sblueswir1It is also possible to specify width or height in characters: 19835824d651Sblueswir1@example 19845824d651Sblueswir1vc:80Cx24C 19855824d651Sblueswir1@end example 19865824d651Sblueswir1@item pty 19875824d651Sblueswir1[Linux only] Pseudo TTY (a new PTY is automatically allocated) 19885824d651Sblueswir1@item none 19895824d651Sblueswir1No device is allocated. 19905824d651Sblueswir1@item null 19915824d651Sblueswir1void device 19925824d651Sblueswir1@item /dev/XXX 19935824d651Sblueswir1[Linux only] Use host tty, e.g. @file{/dev/ttyS0}. The host serial port 19945824d651Sblueswir1parameters are set according to the emulated ones. 19955824d651Sblueswir1@item /dev/parport@var{N} 19965824d651Sblueswir1[Linux only, parallel port only] Use host parallel port 19975824d651Sblueswir1@var{N}. Currently SPP and EPP parallel port features can be used. 19985824d651Sblueswir1@item file:@var{filename} 19995824d651Sblueswir1Write output to @var{filename}. No character can be read. 20005824d651Sblueswir1@item stdio 20015824d651Sblueswir1[Unix only] standard input/output 20025824d651Sblueswir1@item pipe:@var{filename} 20035824d651Sblueswir1name pipe @var{filename} 20045824d651Sblueswir1@item COM@var{n} 20055824d651Sblueswir1[Windows only] Use host serial port @var{n} 20065824d651Sblueswir1@item udp:[@var{remote_host}]:@var{remote_port}[@@[@var{src_ip}]:@var{src_port}] 20075824d651Sblueswir1This implements UDP Net Console. 20085824d651Sblueswir1When @var{remote_host} or @var{src_ip} are not specified 20095824d651Sblueswir1they default to @code{0.0.0.0}. 20105824d651Sblueswir1When not using a specified @var{src_port} a random port is automatically chosen. 20115824d651Sblueswir1 20125824d651Sblueswir1If you just want a simple readonly console you can use @code{netcat} or 20135824d651Sblueswir1@code{nc}, by starting qemu with: @code{-serial udp::4555} and nc as: 20145824d651Sblueswir1@code{nc -u -l -p 4555}. Any time qemu writes something to that port it 20155824d651Sblueswir1will appear in the netconsole session. 20165824d651Sblueswir1 20175824d651Sblueswir1If you plan to send characters back via netconsole or you want to stop 20185824d651Sblueswir1and start qemu a lot of times, you should have qemu use the same 20195824d651Sblueswir1source port each time by using something like @code{-serial 20205824d651Sblueswir1udp::4555@@:4556} to qemu. Another approach is to use a patched 20215824d651Sblueswir1version of netcat which can listen to a TCP port and send and receive 20225824d651Sblueswir1characters via udp. If you have a patched version of netcat which 20235824d651Sblueswir1activates telnet remote echo and single char transfer, then you can 20245824d651Sblueswir1use the following options to step up a netcat redirector to allow 20255824d651Sblueswir1telnet on port 5555 to access the qemu port. 20265824d651Sblueswir1@table @code 20275824d651Sblueswir1@item Qemu Options: 20285824d651Sblueswir1-serial udp::4555@@:4556 20295824d651Sblueswir1@item netcat options: 20305824d651Sblueswir1-u -P 4555 -L 0.0.0.0:4556 -t -p 5555 -I -T 20315824d651Sblueswir1@item telnet options: 20325824d651Sblueswir1localhost 5555 20335824d651Sblueswir1@end table 20345824d651Sblueswir1 20355824d651Sblueswir1@item tcp:[@var{host}]:@var{port}[,@var{server}][,nowait][,nodelay] 20365824d651Sblueswir1The TCP Net Console has two modes of operation. It can send the serial 20375824d651Sblueswir1I/O to a location or wait for a connection from a location. By default 20385824d651Sblueswir1the TCP Net Console is sent to @var{host} at the @var{port}. If you use 20395824d651Sblueswir1the @var{server} option QEMU will wait for a client socket application 20405824d651Sblueswir1to connect to the port before continuing, unless the @code{nowait} 20415824d651Sblueswir1option was specified. The @code{nodelay} option disables the Nagle buffering 20425824d651Sblueswir1algorithm. If @var{host} is omitted, 0.0.0.0 is assumed. Only 20435824d651Sblueswir1one TCP connection at a time is accepted. You can use @code{telnet} to 20445824d651Sblueswir1connect to the corresponding character device. 20455824d651Sblueswir1@table @code 20465824d651Sblueswir1@item Example to send tcp console to 192.168.0.2 port 4444 20475824d651Sblueswir1-serial tcp:192.168.0.2:4444 20485824d651Sblueswir1@item Example to listen and wait on port 4444 for connection 20495824d651Sblueswir1-serial tcp::4444,server 20505824d651Sblueswir1@item Example to not wait and listen on ip 192.168.0.100 port 4444 20515824d651Sblueswir1-serial tcp:192.168.0.100:4444,server,nowait 20525824d651Sblueswir1@end table 20535824d651Sblueswir1 20545824d651Sblueswir1@item telnet:@var{host}:@var{port}[,server][,nowait][,nodelay] 20555824d651Sblueswir1The telnet protocol is used instead of raw tcp sockets. The options 20565824d651Sblueswir1work the same as if you had specified @code{-serial tcp}. The 20575824d651Sblueswir1difference is that the port acts like a telnet server or client using 20585824d651Sblueswir1telnet option negotiation. This will also allow you to send the 20595824d651Sblueswir1MAGIC_SYSRQ sequence if you use a telnet that supports sending the break 20605824d651Sblueswir1sequence. Typically in unix telnet you do it with Control-] and then 20615824d651Sblueswir1type "send break" followed by pressing the enter key. 20625824d651Sblueswir1 20635824d651Sblueswir1@item unix:@var{path}[,server][,nowait] 20645824d651Sblueswir1A unix domain socket is used instead of a tcp socket. The option works the 20655824d651Sblueswir1same as if you had specified @code{-serial tcp} except the unix domain socket 20665824d651Sblueswir1@var{path} is used for connections. 20675824d651Sblueswir1 20685824d651Sblueswir1@item mon:@var{dev_string} 20695824d651Sblueswir1This is a special option to allow the monitor to be multiplexed onto 20705824d651Sblueswir1another serial port. The monitor is accessed with key sequence of 20715824d651Sblueswir1@key{Control-a} and then pressing @key{c}. See monitor access 20725824d651Sblueswir1@ref{pcsys_keys} in the -nographic section for more keys. 20735824d651Sblueswir1@var{dev_string} should be any one of the serial devices specified 20745824d651Sblueswir1above. An example to multiplex the monitor onto a telnet server 20755824d651Sblueswir1listening on port 4444 would be: 20765824d651Sblueswir1@table @code 20775824d651Sblueswir1@item -serial mon:telnet::4444,server,nowait 20785824d651Sblueswir1@end table 20795824d651Sblueswir1 20805824d651Sblueswir1@item braille 20815824d651Sblueswir1Braille device. This will use BrlAPI to display the braille output on a real 20825824d651Sblueswir1or fake device. 20835824d651Sblueswir1 2084be8b28a9SKevin Wolf@item msmouse 2085be8b28a9SKevin WolfThree button serial mouse. Configure the guest to use Microsoft protocol. 20865824d651Sblueswir1@end table 20875824d651Sblueswir1ETEXI 20885824d651Sblueswir1 20895824d651Sblueswir1DEF("parallel", HAS_ARG, QEMU_OPTION_parallel, \ 2090ad96090aSBlue Swirl "-parallel dev redirect the parallel port to char device 'dev'\n", 2091ad96090aSBlue Swirl QEMU_ARCH_ALL) 20925824d651Sblueswir1STEXI 20935824d651Sblueswir1@item -parallel @var{dev} 20946616b2adSStefan Weil@findex -parallel 20955824d651Sblueswir1Redirect the virtual parallel port to host device @var{dev} (same 20965824d651Sblueswir1devices as the serial port). On Linux hosts, @file{/dev/parportN} can 20975824d651Sblueswir1be used to use hardware devices connected on the corresponding host 20985824d651Sblueswir1parallel port. 20995824d651Sblueswir1 21005824d651Sblueswir1This option can be used several times to simulate up to 3 parallel 21015824d651Sblueswir1ports. 21025824d651Sblueswir1 21035824d651Sblueswir1Use @code{-parallel none} to disable all parallel ports. 21045824d651Sblueswir1ETEXI 21055824d651Sblueswir1 21065824d651Sblueswir1DEF("monitor", HAS_ARG, QEMU_OPTION_monitor, \ 2107ad96090aSBlue Swirl "-monitor dev redirect the monitor to char device 'dev'\n", 2108ad96090aSBlue Swirl QEMU_ARCH_ALL) 21095824d651Sblueswir1STEXI 21104e307fc8SGerd Hoffmann@item -monitor @var{dev} 21116616b2adSStefan Weil@findex -monitor 21125824d651Sblueswir1Redirect the monitor to host device @var{dev} (same devices as the 21135824d651Sblueswir1serial port). 21145824d651Sblueswir1The default device is @code{vc} in graphical mode and @code{stdio} in 21155824d651Sblueswir1non graphical mode. 21165824d651Sblueswir1ETEXI 21176ca5582dSGerd HoffmannDEF("qmp", HAS_ARG, QEMU_OPTION_qmp, \ 2118ad96090aSBlue Swirl "-qmp dev like -monitor but opens in 'control' mode\n", 2119ad96090aSBlue Swirl QEMU_ARCH_ALL) 212095d5f08bSStefan WeilSTEXI 212195d5f08bSStefan Weil@item -qmp @var{dev} 21226616b2adSStefan Weil@findex -qmp 212395d5f08bSStefan WeilLike -monitor but opens in 'control' mode. 212495d5f08bSStefan WeilETEXI 21255824d651Sblueswir1 212622a0e04bSGerd HoffmannDEF("mon", HAS_ARG, QEMU_OPTION_mon, \ 2127ad96090aSBlue Swirl "-mon chardev=[name][,mode=readline|control][,default]\n", QEMU_ARCH_ALL) 212822a0e04bSGerd HoffmannSTEXI 212922a0e04bSGerd Hoffmann@item -mon chardev=[name][,mode=readline|control][,default] 21306616b2adSStefan Weil@findex -mon 213122a0e04bSGerd HoffmannSetup monitor on chardev @var{name}. 213222a0e04bSGerd HoffmannETEXI 213322a0e04bSGerd Hoffmann 2134c9f398e5SH. Peter AnvinDEF("debugcon", HAS_ARG, QEMU_OPTION_debugcon, \ 2135ad96090aSBlue Swirl "-debugcon dev redirect the debug console to char device 'dev'\n", 2136ad96090aSBlue Swirl QEMU_ARCH_ALL) 2137c9f398e5SH. Peter AnvinSTEXI 2138c9f398e5SH. Peter Anvin@item -debugcon @var{dev} 21396616b2adSStefan Weil@findex -debugcon 2140c9f398e5SH. Peter AnvinRedirect the debug console to host device @var{dev} (same devices as the 2141c9f398e5SH. Peter Anvinserial port). The debug console is an I/O port which is typically port 2142c9f398e5SH. Peter Anvin0xe9; writing to that I/O port sends output to this device. 2143c9f398e5SH. Peter AnvinThe default device is @code{vc} in graphical mode and @code{stdio} in 2144c9f398e5SH. Peter Anvinnon graphical mode. 2145c9f398e5SH. Peter AnvinETEXI 2146c9f398e5SH. Peter Anvin 21475824d651Sblueswir1DEF("pidfile", HAS_ARG, QEMU_OPTION_pidfile, \ 2148ad96090aSBlue Swirl "-pidfile file write PID to 'file'\n", QEMU_ARCH_ALL) 21495824d651Sblueswir1STEXI 21505824d651Sblueswir1@item -pidfile @var{file} 21516616b2adSStefan Weil@findex -pidfile 21525824d651Sblueswir1Store the QEMU process PID in @var{file}. It is useful if you launch QEMU 21535824d651Sblueswir1from a script. 21545824d651Sblueswir1ETEXI 21555824d651Sblueswir1 21561b530a6dSaurel32DEF("singlestep", 0, QEMU_OPTION_singlestep, \ 2157ad96090aSBlue Swirl "-singlestep always run in singlestep mode\n", QEMU_ARCH_ALL) 21581b530a6dSaurel32STEXI 21591b530a6dSaurel32@item -singlestep 21606616b2adSStefan Weil@findex -singlestep 21611b530a6dSaurel32Run the emulation in single step mode. 21621b530a6dSaurel32ETEXI 21631b530a6dSaurel32 21645824d651Sblueswir1DEF("S", 0, QEMU_OPTION_S, \ 2165ad96090aSBlue Swirl "-S freeze CPU at startup (use 'c' to start execution)\n", 2166ad96090aSBlue Swirl QEMU_ARCH_ALL) 21675824d651Sblueswir1STEXI 21685824d651Sblueswir1@item -S 21696616b2adSStefan Weil@findex -S 21705824d651Sblueswir1Do not start CPU at startup (you must type 'c' in the monitor). 21715824d651Sblueswir1ETEXI 21725824d651Sblueswir1 217359030a8cSaliguoriDEF("gdb", HAS_ARG, QEMU_OPTION_gdb, \ 2174ad96090aSBlue Swirl "-gdb dev wait for gdb connection on 'dev'\n", QEMU_ARCH_ALL) 21755824d651Sblueswir1STEXI 217659030a8cSaliguori@item -gdb @var{dev} 21776616b2adSStefan Weil@findex -gdb 217859030a8cSaliguoriWait for gdb connection on device @var{dev} (@pxref{gdb_usage}). Typical 217959030a8cSaliguoriconnections will likely be TCP-based, but also UDP, pseudo TTY, or even 218059030a8cSaliguoristdio are reasonable use case. The latter is allowing to start qemu from 218159030a8cSaliguoriwithin gdb and establish the connection via a pipe: 218259030a8cSaliguori@example 218359030a8cSaliguori(gdb) target remote | exec qemu -gdb stdio ... 218459030a8cSaliguori@end example 21855824d651Sblueswir1ETEXI 21865824d651Sblueswir1 218759030a8cSaliguoriDEF("s", 0, QEMU_OPTION_s, \ 2188ad96090aSBlue Swirl "-s shorthand for -gdb tcp::" DEFAULT_GDBSTUB_PORT "\n", 2189ad96090aSBlue Swirl QEMU_ARCH_ALL) 21905824d651Sblueswir1STEXI 219159030a8cSaliguori@item -s 21926616b2adSStefan Weil@findex -s 219359030a8cSaliguoriShorthand for -gdb tcp::1234, i.e. open a gdbserver on TCP port 1234 219459030a8cSaliguori(@pxref{gdb_usage}). 21955824d651Sblueswir1ETEXI 21965824d651Sblueswir1 21975824d651Sblueswir1DEF("d", HAS_ARG, QEMU_OPTION_d, \ 2198ad96090aSBlue Swirl "-d item1,... output log to /tmp/qemu.log (use -d ? for a list of log items)\n", 2199ad96090aSBlue Swirl QEMU_ARCH_ALL) 22005824d651Sblueswir1STEXI 22015824d651Sblueswir1@item -d 22026616b2adSStefan Weil@findex -d 22035824d651Sblueswir1Output log in /tmp/qemu.log 22045824d651Sblueswir1ETEXI 22055824d651Sblueswir1 2206c235d738SMatthew FernandezDEF("D", HAS_ARG, QEMU_OPTION_D, \ 2207c235d738SMatthew Fernandez "-D logfile output log to logfile (instead of the default /tmp/qemu.log)\n", 2208c235d738SMatthew Fernandez QEMU_ARCH_ALL) 2209c235d738SMatthew FernandezSTEXI 2210c235d738SMatthew Fernandez@item -D 2211c235d738SMatthew Fernandez@findex -D 2212c235d738SMatthew FernandezOutput log in logfile instead of /tmp/qemu.log 2213c235d738SMatthew FernandezETEXI 2214c235d738SMatthew Fernandez 22155824d651Sblueswir1DEF("hdachs", HAS_ARG, QEMU_OPTION_hdachs, \ 22165824d651Sblueswir1 "-hdachs c,h,s[,t]\n" \ 22175824d651Sblueswir1 " force hard disk 0 physical geometry and the optional BIOS\n" \ 2218ad96090aSBlue Swirl " translation (t=none or lba) (usually qemu can guess them)\n", 2219ad96090aSBlue Swirl QEMU_ARCH_ALL) 22205824d651Sblueswir1STEXI 22215824d651Sblueswir1@item -hdachs @var{c},@var{h},@var{s},[,@var{t}] 22226616b2adSStefan Weil@findex -hdachs 22235824d651Sblueswir1Force hard disk 0 physical geometry (1 <= @var{c} <= 16383, 1 <= 22245824d651Sblueswir1@var{h} <= 16, 1 <= @var{s} <= 63) and optionally force the BIOS 22255824d651Sblueswir1translation mode (@var{t}=none, lba or auto). Usually QEMU can guess 22265824d651Sblueswir1all those parameters. This option is useful for old MS-DOS disk 22275824d651Sblueswir1images. 22285824d651Sblueswir1ETEXI 22295824d651Sblueswir1 22305824d651Sblueswir1DEF("L", HAS_ARG, QEMU_OPTION_L, \ 2231ad96090aSBlue Swirl "-L path set the directory for the BIOS, VGA BIOS and keymaps\n", 2232ad96090aSBlue Swirl QEMU_ARCH_ALL) 22335824d651Sblueswir1STEXI 22345824d651Sblueswir1@item -L @var{path} 22356616b2adSStefan Weil@findex -L 22365824d651Sblueswir1Set the directory for the BIOS, VGA BIOS and keymaps. 22375824d651Sblueswir1ETEXI 22385824d651Sblueswir1 22395824d651Sblueswir1DEF("bios", HAS_ARG, QEMU_OPTION_bios, \ 2240ad96090aSBlue Swirl "-bios file set the filename for the BIOS\n", QEMU_ARCH_ALL) 22415824d651Sblueswir1STEXI 22425824d651Sblueswir1@item -bios @var{file} 22436616b2adSStefan Weil@findex -bios 22445824d651Sblueswir1Set the filename for the BIOS. 22455824d651Sblueswir1ETEXI 22465824d651Sblueswir1 22475824d651Sblueswir1DEF("enable-kvm", 0, QEMU_OPTION_enable_kvm, \ 2248ad96090aSBlue Swirl "-enable-kvm enable KVM full virtualization support\n", QEMU_ARCH_ALL) 22495824d651Sblueswir1STEXI 22505824d651Sblueswir1@item -enable-kvm 22516616b2adSStefan Weil@findex -enable-kvm 22525824d651Sblueswir1Enable KVM full virtualization support. This option is only available 22535824d651Sblueswir1if KVM support is enabled when compiling. 22545824d651Sblueswir1ETEXI 22555824d651Sblueswir1 2256e37630caSaliguoriDEF("xen-domid", HAS_ARG, QEMU_OPTION_xen_domid, 2257ad96090aSBlue Swirl "-xen-domid id specify xen guest domain id\n", QEMU_ARCH_ALL) 2258e37630caSaliguoriDEF("xen-create", 0, QEMU_OPTION_xen_create, 2259e37630caSaliguori "-xen-create create domain using xen hypercalls, bypassing xend\n" 2260ad96090aSBlue Swirl " warning: should not be used when xend is in use\n", 2261ad96090aSBlue Swirl QEMU_ARCH_ALL) 2262e37630caSaliguoriDEF("xen-attach", 0, QEMU_OPTION_xen_attach, 2263e37630caSaliguori "-xen-attach attach to existing xen domain\n" 2264ad96090aSBlue Swirl " xend will use this when starting qemu\n", 2265ad96090aSBlue Swirl QEMU_ARCH_ALL) 226695d5f08bSStefan WeilSTEXI 226795d5f08bSStefan Weil@item -xen-domid @var{id} 22686616b2adSStefan Weil@findex -xen-domid 226995d5f08bSStefan WeilSpecify xen guest domain @var{id} (XEN only). 227095d5f08bSStefan Weil@item -xen-create 22716616b2adSStefan Weil@findex -xen-create 227295d5f08bSStefan WeilCreate domain using xen hypercalls, bypassing xend. 227395d5f08bSStefan WeilWarning: should not be used when xend is in use (XEN only). 227495d5f08bSStefan Weil@item -xen-attach 22756616b2adSStefan Weil@findex -xen-attach 227695d5f08bSStefan WeilAttach to existing xen domain. 227795d5f08bSStefan Weilxend will use this when starting qemu (XEN only). 227895d5f08bSStefan WeilETEXI 2279e37630caSaliguori 22805824d651Sblueswir1DEF("no-reboot", 0, QEMU_OPTION_no_reboot, \ 2281ad96090aSBlue Swirl "-no-reboot exit instead of rebooting\n", QEMU_ARCH_ALL) 22825824d651Sblueswir1STEXI 22835824d651Sblueswir1@item -no-reboot 22846616b2adSStefan Weil@findex -no-reboot 22855824d651Sblueswir1Exit instead of rebooting. 22865824d651Sblueswir1ETEXI 22875824d651Sblueswir1 22885824d651Sblueswir1DEF("no-shutdown", 0, QEMU_OPTION_no_shutdown, \ 2289ad96090aSBlue Swirl "-no-shutdown stop before shutdown\n", QEMU_ARCH_ALL) 22905824d651Sblueswir1STEXI 22915824d651Sblueswir1@item -no-shutdown 22926616b2adSStefan Weil@findex -no-shutdown 22935824d651Sblueswir1Don't exit QEMU on guest shutdown, but instead only stop the emulation. 22945824d651Sblueswir1This allows for instance switching to monitor to commit changes to the 22955824d651Sblueswir1disk image. 22965824d651Sblueswir1ETEXI 22975824d651Sblueswir1 22985824d651Sblueswir1DEF("loadvm", HAS_ARG, QEMU_OPTION_loadvm, \ 22995824d651Sblueswir1 "-loadvm [tag|id]\n" \ 2300ad96090aSBlue Swirl " start right away with a saved state (loadvm in monitor)\n", 2301ad96090aSBlue Swirl QEMU_ARCH_ALL) 23025824d651Sblueswir1STEXI 23035824d651Sblueswir1@item -loadvm @var{file} 23046616b2adSStefan Weil@findex -loadvm 23055824d651Sblueswir1Start right away with a saved state (@code{loadvm} in monitor) 23065824d651Sblueswir1ETEXI 23075824d651Sblueswir1 23085824d651Sblueswir1#ifndef _WIN32 23095824d651Sblueswir1DEF("daemonize", 0, QEMU_OPTION_daemonize, \ 2310ad96090aSBlue Swirl "-daemonize daemonize QEMU after initializing\n", QEMU_ARCH_ALL) 23115824d651Sblueswir1#endif 23125824d651Sblueswir1STEXI 23135824d651Sblueswir1@item -daemonize 23146616b2adSStefan Weil@findex -daemonize 23155824d651Sblueswir1Daemonize the QEMU process after initialization. QEMU will not detach from 23165824d651Sblueswir1standard IO until it is ready to receive connections on any of its devices. 23175824d651Sblueswir1This option is a useful way for external programs to launch QEMU without having 23185824d651Sblueswir1to cope with initialization race conditions. 23195824d651Sblueswir1ETEXI 23205824d651Sblueswir1 23215824d651Sblueswir1DEF("option-rom", HAS_ARG, QEMU_OPTION_option_rom, \ 2322ad96090aSBlue Swirl "-option-rom rom load a file, rom, into the option ROM space\n", 2323ad96090aSBlue Swirl QEMU_ARCH_ALL) 23245824d651Sblueswir1STEXI 23255824d651Sblueswir1@item -option-rom @var{file} 23266616b2adSStefan Weil@findex -option-rom 23275824d651Sblueswir1Load the contents of @var{file} as an option ROM. 23285824d651Sblueswir1This option is useful to load things like EtherBoot. 23295824d651Sblueswir1ETEXI 23305824d651Sblueswir1 23315824d651Sblueswir1DEF("clock", HAS_ARG, QEMU_OPTION_clock, \ 23325824d651Sblueswir1 "-clock force the use of the given methods for timer alarm.\n" \ 2333ad96090aSBlue Swirl " To see what timers are available use -clock ?\n", 2334ad96090aSBlue Swirl QEMU_ARCH_ALL) 23355824d651Sblueswir1STEXI 23365824d651Sblueswir1@item -clock @var{method} 23376616b2adSStefan Weil@findex -clock 23385824d651Sblueswir1Force the use of the given methods for timer alarm. To see what timers 23395824d651Sblueswir1are available use -clock ?. 23405824d651Sblueswir1ETEXI 23415824d651Sblueswir1 23421ed2fc1fSJan KiszkaHXCOMM Options deprecated by -rtc 2343ad96090aSBlue SwirlDEF("localtime", 0, QEMU_OPTION_localtime, "", QEMU_ARCH_ALL) 2344ad96090aSBlue SwirlDEF("startdate", HAS_ARG, QEMU_OPTION_startdate, "", QEMU_ARCH_ALL) 23455824d651Sblueswir1 23461ed2fc1fSJan KiszkaDEF("rtc", HAS_ARG, QEMU_OPTION_rtc, \ 23476875204cSJan Kiszka "-rtc [base=utc|localtime|date][,clock=host|vm][,driftfix=none|slew]\n" \ 2348ad96090aSBlue Swirl " set the RTC base and clock, enable drift fix for clock ticks (x86 only)\n", 2349ad96090aSBlue Swirl QEMU_ARCH_ALL) 23501ed2fc1fSJan Kiszka 23515824d651Sblueswir1STEXI 23525824d651Sblueswir1 23536875204cSJan Kiszka@item -rtc [base=utc|localtime|@var{date}][,clock=host|vm][,driftfix=none|slew] 23546616b2adSStefan Weil@findex -rtc 23551ed2fc1fSJan KiszkaSpecify @option{base} as @code{utc} or @code{localtime} to let the RTC start at the current 23561ed2fc1fSJan KiszkaUTC or local time, respectively. @code{localtime} is required for correct date in 23571ed2fc1fSJan KiszkaMS-DOS or Windows. To start at a specific point in time, provide @var{date} in the 23581ed2fc1fSJan Kiszkaformat @code{2006-06-17T16:01:21} or @code{2006-06-17}. The default base is UTC. 23591ed2fc1fSJan Kiszka 23606875204cSJan KiszkaBy default the RTC is driven by the host system time. This allows to use the 23616875204cSJan KiszkaRTC as accurate reference clock inside the guest, specifically if the host 23626875204cSJan Kiszkatime is smoothly following an accurate external reference clock, e.g. via NTP. 23636875204cSJan KiszkaIf you want to isolate the guest time from the host, even prevent it from 23646875204cSJan Kiszkaprogressing during suspension, you can set @option{clock} to @code{vm} instead. 23656875204cSJan Kiszka 23661ed2fc1fSJan KiszkaEnable @option{driftfix} (i386 targets only) if you experience time drift problems, 23671ed2fc1fSJan Kiszkaspecifically with Windows' ACPI HAL. This option will try to figure out how 23681ed2fc1fSJan Kiszkamany timer interrupts were not processed by the Windows guest and will 23691ed2fc1fSJan Kiszkare-inject them. 23705824d651Sblueswir1ETEXI 23715824d651Sblueswir1 23725824d651Sblueswir1DEF("icount", HAS_ARG, QEMU_OPTION_icount, \ 23735824d651Sblueswir1 "-icount [N|auto]\n" \ 2374bc14ca24Saliguori " enable virtual instruction counter with 2^N clock ticks per\n" \ 2375ad96090aSBlue Swirl " instruction\n", QEMU_ARCH_ALL) 23765824d651Sblueswir1STEXI 23774e257e5eSKevin Wolf@item -icount [@var{N}|auto] 23786616b2adSStefan Weil@findex -icount 23795824d651Sblueswir1Enable virtual instruction counter. The virtual cpu will execute one 23804e257e5eSKevin Wolfinstruction every 2^@var{N} ns of virtual time. If @code{auto} is specified 23815824d651Sblueswir1then the virtual cpu speed will be automatically adjusted to keep virtual 23825824d651Sblueswir1time within a few seconds of real time. 23835824d651Sblueswir1 23845824d651Sblueswir1Note that while this option can give deterministic behavior, it does not 23855824d651Sblueswir1provide cycle accurate emulation. Modern CPUs contain superscalar out of 23865824d651Sblueswir1order cores with complex cache hierarchies. The number of instructions 23875824d651Sblueswir1executed often has little or no correlation with actual performance. 23885824d651Sblueswir1ETEXI 23895824d651Sblueswir1 23909dd986ccSRichard W.M. JonesDEF("watchdog", HAS_ARG, QEMU_OPTION_watchdog, \ 23919dd986ccSRichard W.M. Jones "-watchdog i6300esb|ib700\n" \ 2392ad96090aSBlue Swirl " enable virtual hardware watchdog [default=none]\n", 2393ad96090aSBlue Swirl QEMU_ARCH_ALL) 23949dd986ccSRichard W.M. JonesSTEXI 23959dd986ccSRichard W.M. Jones@item -watchdog @var{model} 23966616b2adSStefan Weil@findex -watchdog 23979dd986ccSRichard W.M. JonesCreate a virtual hardware watchdog device. Once enabled (by a guest 23989dd986ccSRichard W.M. Jonesaction), the watchdog must be periodically polled by an agent inside 23999dd986ccSRichard W.M. Jonesthe guest or else the guest will be restarted. 24009dd986ccSRichard W.M. Jones 24019dd986ccSRichard W.M. JonesThe @var{model} is the model of hardware watchdog to emulate. Choices 24029dd986ccSRichard W.M. Jonesfor model are: @code{ib700} (iBASE 700) which is a very simple ISA 24039dd986ccSRichard W.M. Joneswatchdog with a single timer, or @code{i6300esb} (Intel 6300ESB I/O 24049dd986ccSRichard W.M. Jonescontroller hub) which is a much more featureful PCI-based dual-timer 24059dd986ccSRichard W.M. Joneswatchdog. Choose a model for which your guest has drivers. 24069dd986ccSRichard W.M. Jones 24079dd986ccSRichard W.M. JonesUse @code{-watchdog ?} to list available hardware models. Only one 24089dd986ccSRichard W.M. Joneswatchdog can be enabled for a guest. 24099dd986ccSRichard W.M. JonesETEXI 24109dd986ccSRichard W.M. Jones 24119dd986ccSRichard W.M. JonesDEF("watchdog-action", HAS_ARG, QEMU_OPTION_watchdog_action, \ 24129dd986ccSRichard W.M. Jones "-watchdog-action reset|shutdown|poweroff|pause|debug|none\n" \ 2413ad96090aSBlue Swirl " action when watchdog fires [default=reset]\n", 2414ad96090aSBlue Swirl QEMU_ARCH_ALL) 24159dd986ccSRichard W.M. JonesSTEXI 24169dd986ccSRichard W.M. Jones@item -watchdog-action @var{action} 24179dd986ccSRichard W.M. Jones 24189dd986ccSRichard W.M. JonesThe @var{action} controls what QEMU will do when the watchdog timer 24199dd986ccSRichard W.M. Jonesexpires. 24209dd986ccSRichard W.M. JonesThe default is 24219dd986ccSRichard W.M. Jones@code{reset} (forcefully reset the guest). 24229dd986ccSRichard W.M. JonesOther possible actions are: 24239dd986ccSRichard W.M. Jones@code{shutdown} (attempt to gracefully shutdown the guest), 24249dd986ccSRichard W.M. Jones@code{poweroff} (forcefully poweroff the guest), 24259dd986ccSRichard W.M. Jones@code{pause} (pause the guest), 24269dd986ccSRichard W.M. Jones@code{debug} (print a debug message and continue), or 24279dd986ccSRichard W.M. Jones@code{none} (do nothing). 24289dd986ccSRichard W.M. Jones 24299dd986ccSRichard W.M. JonesNote that the @code{shutdown} action requires that the guest responds 24309dd986ccSRichard W.M. Jonesto ACPI signals, which it may not be able to do in the sort of 24319dd986ccSRichard W.M. Jonessituations where the watchdog would have expired, and thus 24329dd986ccSRichard W.M. Jones@code{-watchdog-action shutdown} is not recommended for production use. 24339dd986ccSRichard W.M. Jones 24349dd986ccSRichard W.M. JonesExamples: 24359dd986ccSRichard W.M. Jones 24369dd986ccSRichard W.M. Jones@table @code 24379dd986ccSRichard W.M. Jones@item -watchdog i6300esb -watchdog-action pause 24389dd986ccSRichard W.M. Jones@item -watchdog ib700 24399dd986ccSRichard W.M. Jones@end table 24409dd986ccSRichard W.M. JonesETEXI 24419dd986ccSRichard W.M. Jones 24425824d651Sblueswir1DEF("echr", HAS_ARG, QEMU_OPTION_echr, \ 2443ad96090aSBlue Swirl "-echr chr set terminal escape character instead of ctrl-a\n", 2444ad96090aSBlue Swirl QEMU_ARCH_ALL) 24455824d651Sblueswir1STEXI 24465824d651Sblueswir1 24474e257e5eSKevin Wolf@item -echr @var{numeric_ascii_value} 24486616b2adSStefan Weil@findex -echr 24495824d651Sblueswir1Change the escape character used for switching to the monitor when using 24505824d651Sblueswir1monitor and serial sharing. The default is @code{0x01} when using the 24515824d651Sblueswir1@code{-nographic} option. @code{0x01} is equal to pressing 24525824d651Sblueswir1@code{Control-a}. You can select a different character from the ascii 24535824d651Sblueswir1control keys where 1 through 26 map to Control-a through Control-z. For 24545824d651Sblueswir1instance you could use the either of the following to change the escape 24555824d651Sblueswir1character to Control-t. 24565824d651Sblueswir1@table @code 24575824d651Sblueswir1@item -echr 0x14 24585824d651Sblueswir1@item -echr 20 24595824d651Sblueswir1@end table 24605824d651Sblueswir1ETEXI 24615824d651Sblueswir1 24625824d651Sblueswir1DEF("virtioconsole", HAS_ARG, QEMU_OPTION_virtiocon, \ 24635824d651Sblueswir1 "-virtioconsole c\n" \ 2464ad96090aSBlue Swirl " set virtio console\n", QEMU_ARCH_ALL) 24655824d651Sblueswir1STEXI 24665824d651Sblueswir1@item -virtioconsole @var{c} 24676616b2adSStefan Weil@findex -virtioconsole 24685824d651Sblueswir1Set virtio console. 246998b19252SAmit Shah 247098b19252SAmit ShahThis option is maintained for backward compatibility. 247198b19252SAmit Shah 247298b19252SAmit ShahPlease use @code{-device virtconsole} for the new way of invocation. 24735824d651Sblueswir1ETEXI 24745824d651Sblueswir1 24755824d651Sblueswir1DEF("show-cursor", 0, QEMU_OPTION_show_cursor, \ 2476ad96090aSBlue Swirl "-show-cursor show cursor\n", QEMU_ARCH_ALL) 24775824d651Sblueswir1STEXI 247895d5f08bSStefan Weil@item -show-cursor 24796616b2adSStefan Weil@findex -show-cursor 248095d5f08bSStefan WeilShow cursor. 24815824d651Sblueswir1ETEXI 24825824d651Sblueswir1 24835824d651Sblueswir1DEF("tb-size", HAS_ARG, QEMU_OPTION_tb_size, \ 2484ad96090aSBlue Swirl "-tb-size n set TB size\n", QEMU_ARCH_ALL) 24855824d651Sblueswir1STEXI 248695d5f08bSStefan Weil@item -tb-size @var{n} 24876616b2adSStefan Weil@findex -tb-size 248895d5f08bSStefan WeilSet TB size. 24895824d651Sblueswir1ETEXI 24905824d651Sblueswir1 24915824d651Sblueswir1DEF("incoming", HAS_ARG, QEMU_OPTION_incoming, \ 2492ad96090aSBlue Swirl "-incoming p prepare for incoming migration, listen on port p\n", 2493ad96090aSBlue Swirl QEMU_ARCH_ALL) 24945824d651Sblueswir1STEXI 249595d5f08bSStefan Weil@item -incoming @var{port} 24966616b2adSStefan Weil@findex -incoming 249795d5f08bSStefan WeilPrepare for incoming migration, listen on @var{port}. 24985824d651Sblueswir1ETEXI 24995824d651Sblueswir1 2500d8c208ddSGerd HoffmannDEF("nodefaults", 0, QEMU_OPTION_nodefaults, \ 2501ad96090aSBlue Swirl "-nodefaults don't create default devices\n", QEMU_ARCH_ALL) 2502d8c208ddSGerd HoffmannSTEXI 25033dbf2c7fSStefan Weil@item -nodefaults 25046616b2adSStefan Weil@findex -nodefaults 25053dbf2c7fSStefan WeilDon't create default devices. 2506d8c208ddSGerd HoffmannETEXI 2507d8c208ddSGerd Hoffmann 25085824d651Sblueswir1#ifndef _WIN32 25095824d651Sblueswir1DEF("chroot", HAS_ARG, QEMU_OPTION_chroot, \ 2510ad96090aSBlue Swirl "-chroot dir chroot to dir just before starting the VM\n", 2511ad96090aSBlue Swirl QEMU_ARCH_ALL) 25125824d651Sblueswir1#endif 25135824d651Sblueswir1STEXI 25144e257e5eSKevin Wolf@item -chroot @var{dir} 25156616b2adSStefan Weil@findex -chroot 25165824d651Sblueswir1Immediately before starting guest execution, chroot to the specified 25175824d651Sblueswir1directory. Especially useful in combination with -runas. 25185824d651Sblueswir1ETEXI 25195824d651Sblueswir1 25205824d651Sblueswir1#ifndef _WIN32 25215824d651Sblueswir1DEF("runas", HAS_ARG, QEMU_OPTION_runas, \ 2522ad96090aSBlue Swirl "-runas user change to user id user just before starting the VM\n", 2523ad96090aSBlue Swirl QEMU_ARCH_ALL) 25245824d651Sblueswir1#endif 25255824d651Sblueswir1STEXI 25264e257e5eSKevin Wolf@item -runas @var{user} 25276616b2adSStefan Weil@findex -runas 25285824d651Sblueswir1Immediately before starting guest execution, drop root privileges, switching 25295824d651Sblueswir1to the specified user. 25305824d651Sblueswir1ETEXI 25315824d651Sblueswir1 25325824d651Sblueswir1DEF("prom-env", HAS_ARG, QEMU_OPTION_prom_env, 25335824d651Sblueswir1 "-prom-env variable=value\n" 2534ad96090aSBlue Swirl " set OpenBIOS nvram variables\n", 2535ad96090aSBlue Swirl QEMU_ARCH_PPC | QEMU_ARCH_SPARC) 253695d5f08bSStefan WeilSTEXI 253795d5f08bSStefan Weil@item -prom-env @var{variable}=@var{value} 25386616b2adSStefan Weil@findex -prom-env 253995d5f08bSStefan WeilSet OpenBIOS nvram @var{variable} to given @var{value} (PPC, SPARC only). 254095d5f08bSStefan WeilETEXI 25415824d651Sblueswir1DEF("semihosting", 0, QEMU_OPTION_semihosting, 25421ddeaa5dSMax Filippov "-semihosting semihosting mode\n", QEMU_ARCH_ARM | QEMU_ARCH_M68K | QEMU_ARCH_XTENSA) 254395d5f08bSStefan WeilSTEXI 254495d5f08bSStefan Weil@item -semihosting 25456616b2adSStefan Weil@findex -semihosting 25461ddeaa5dSMax FilippovSemihosting mode (ARM, M68K, Xtensa only). 254795d5f08bSStefan WeilETEXI 25485824d651Sblueswir1DEF("old-param", 0, QEMU_OPTION_old_param, 2549ad96090aSBlue Swirl "-old-param old param mode\n", QEMU_ARCH_ARM) 255095d5f08bSStefan WeilSTEXI 255195d5f08bSStefan Weil@item -old-param 25526616b2adSStefan Weil@findex -old-param (ARM) 255395d5f08bSStefan WeilOld param mode (ARM only). 255495d5f08bSStefan WeilETEXI 255595d5f08bSStefan Weil 2556715a664aSGerd HoffmannDEF("readconfig", HAS_ARG, QEMU_OPTION_readconfig, 2557ad96090aSBlue Swirl "-readconfig <file>\n", QEMU_ARCH_ALL) 25583dbf2c7fSStefan WeilSTEXI 25593dbf2c7fSStefan Weil@item -readconfig @var{file} 25606616b2adSStefan Weil@findex -readconfig 25613dbf2c7fSStefan WeilRead device configuration from @var{file}. 25623dbf2c7fSStefan WeilETEXI 2563715a664aSGerd HoffmannDEF("writeconfig", HAS_ARG, QEMU_OPTION_writeconfig, 2564715a664aSGerd Hoffmann "-writeconfig <file>\n" 2565ad96090aSBlue Swirl " read/write config file\n", QEMU_ARCH_ALL) 25663dbf2c7fSStefan WeilSTEXI 25673dbf2c7fSStefan Weil@item -writeconfig @var{file} 25686616b2adSStefan Weil@findex -writeconfig 25693dbf2c7fSStefan WeilWrite device configuration to @var{file}. 25703dbf2c7fSStefan WeilETEXI 2571292444cbSAnthony LiguoriDEF("nodefconfig", 0, QEMU_OPTION_nodefconfig, 2572292444cbSAnthony Liguori "-nodefconfig\n" 2573ad96090aSBlue Swirl " do not load default config files at startup\n", 2574ad96090aSBlue Swirl QEMU_ARCH_ALL) 2575292444cbSAnthony LiguoriSTEXI 2576292444cbSAnthony Liguori@item -nodefconfig 25776616b2adSStefan Weil@findex -nodefconfig 2578292444cbSAnthony LiguoriNormally QEMU loads a configuration file from @var{sysconfdir}/qemu.conf and 2579292444cbSAnthony Liguori@var{sysconfdir}/target-@var{ARCH}.conf on startup. The @code{-nodefconfig} 2580292444cbSAnthony Liguorioption will prevent QEMU from loading these configuration files at startup. 2581292444cbSAnthony LiguoriETEXI 2582ab6540d5SPrerna SaxenaDEF("trace", HAS_ARG, QEMU_OPTION_trace, 258323d15e86SLluís "-trace [events=<file>][,file=<file>]\n" 258423d15e86SLluís " specify tracing options\n", 2585ab6540d5SPrerna Saxena QEMU_ARCH_ALL) 2586ab6540d5SPrerna SaxenaSTEXI 258723d15e86SLluísHXCOMM This line is not accurate, as some sub-options are backend-specific but 258823d15e86SLluísHXCOMM HX does not support conditional compilation of text. 258923d15e86SLluís@item -trace [events=@var{file}][,file=@var{file}] 2590ab6540d5SPrerna Saxena@findex -trace 2591e4858974SLluís 259223d15e86SLluísSpecify tracing options. 259323d15e86SLluís 259423d15e86SLluís@table @option 259523d15e86SLluís@item events=@var{file} 259623d15e86SLluísImmediately enable events listed in @var{file}. 259723d15e86SLluísThe file must contain one event name (as listed in the @var{trace-events} file) 259823d15e86SLluísper line. 2599c1ba4e0bSStefan WeilThis option is only available if QEMU has been compiled with 2600c1ba4e0bSStefan Weileither @var{simple} or @var{stderr} tracing backend. 260123d15e86SLluís@item file=@var{file} 260223d15e86SLluísLog output traces to @var{file}. 260323d15e86SLluís 2604c1ba4e0bSStefan WeilThis option is only available if QEMU has been compiled with 2605c1ba4e0bSStefan Weilthe @var{simple} tracing backend. 260623d15e86SLluís@end table 2607ab6540d5SPrerna SaxenaETEXI 26083dbf2c7fSStefan Weil 26093dbf2c7fSStefan WeilHXCOMM This is the last statement. Insert new options before this line! 26103dbf2c7fSStefan WeilSTEXI 26113dbf2c7fSStefan Weil@end table 26123dbf2c7fSStefan WeilETEXI 2613