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 9c8057f95SPeter MaydellHXCOMM TODO : when we are able to change -help output without breaking 10c8057f95SPeter MaydellHXCOMM libvirt we should update the help options which refer to -cpu ?, 11c8057f95SPeter MaydellHXCOMM -driver ?, etc to use the preferred -cpu help etc instead. 12c8057f95SPeter Maydell 135824d651Sblueswir1DEFHEADING(Standard options:) 145824d651Sblueswir1STEXI 155824d651Sblueswir1@table @option 165824d651Sblueswir1ETEXI 175824d651Sblueswir1 185824d651Sblueswir1DEF("help", 0, QEMU_OPTION_h, 19ad96090aSBlue Swirl "-h or -help display this help and exit\n", QEMU_ARCH_ALL) 205824d651Sblueswir1STEXI 215824d651Sblueswir1@item -h 226616b2adSStefan Weil@findex -h 235824d651Sblueswir1Display help and exit 245824d651Sblueswir1ETEXI 255824d651Sblueswir1 269bd7e6d9SpbrookDEF("version", 0, QEMU_OPTION_version, 27ad96090aSBlue Swirl "-version display version information and exit\n", QEMU_ARCH_ALL) 289bd7e6d9SpbrookSTEXI 299bd7e6d9Spbrook@item -version 306616b2adSStefan Weil@findex -version 319bd7e6d9SpbrookDisplay version information and exit 329bd7e6d9SpbrookETEXI 339bd7e6d9Spbrook 3480f52a66SJan KiszkaDEF("machine", HAS_ARG, QEMU_OPTION_machine, \ 3580f52a66SJan Kiszka "-machine [type=]name[,prop[=value][,...]]\n" 3680f52a66SJan Kiszka " selects emulated machine (-machine ? for list)\n" 3780f52a66SJan Kiszka " property accel=accel1[:accel2[:...]] selects accelerator\n" 386a48ffaaSJan Kiszka " supported accelerators are kvm, xen, tcg (default: tcg)\n" 3939d6960aSJan Kiszka " kernel_irqchip=on|off controls accelerated irqchip support\n" 40ddb97f1dSJason Baron " kvm_shadow_mem=size of KVM shadow MMU\n" 41*8490fc78SLuiz Capitulino " dump-guest-core=on|off include guest memory in a core dump (default=on)\n" 42*8490fc78SLuiz Capitulino " mem-merge=on|off controls memory merge support (default: on)\n", 4380f52a66SJan Kiszka QEMU_ARCH_ALL) 445824d651Sblueswir1STEXI 4580f52a66SJan Kiszka@item -machine [type=]@var{name}[,prop=@var{value}[,...]] 4680f52a66SJan Kiszka@findex -machine 4780f52a66SJan KiszkaSelect the emulated machine by @var{name}. Use @code{-machine ?} to list 4880f52a66SJan Kiszkaavailable machines. Supported machine properties are: 4980f52a66SJan Kiszka@table @option 5080f52a66SJan Kiszka@item accel=@var{accels1}[:@var{accels2}[:...]] 5180f52a66SJan KiszkaThis is used to enable an accelerator. Depending on the target architecture, 5280f52a66SJan Kiszkakvm, xen, or tcg can be available. By default, tcg is used. If there is more 5380f52a66SJan Kiszkathan one accelerator specified, the next one is used if the previous one fails 5480f52a66SJan Kiszkato initialize. 556a48ffaaSJan Kiszka@item kernel_irqchip=on|off 566a48ffaaSJan KiszkaEnables in-kernel irqchip support for the chosen accelerator when available. 5739d6960aSJan Kiszka@item kvm_shadow_mem=size 5839d6960aSJan KiszkaDefines the size of the KVM shadow MMU. 59ddb97f1dSJason Baron@item dump-guest-core=on|off 60ddb97f1dSJason BaronInclude guest memory in a core dump. The default is on. 61*8490fc78SLuiz Capitulino@item mem-merge=on|off 62*8490fc78SLuiz CapitulinoEnables or disables memory merge support. This feature, when supported by 63*8490fc78SLuiz Capitulinothe host, de-duplicates identical memory pages among VMs instances 64*8490fc78SLuiz Capitulino(enabled by default). 6580f52a66SJan Kiszka@end table 665824d651Sblueswir1ETEXI 675824d651Sblueswir1 6880f52a66SJan KiszkaHXCOMM Deprecated by -machine 6980f52a66SJan KiszkaDEF("M", HAS_ARG, QEMU_OPTION_M, "", QEMU_ARCH_ALL) 7080f52a66SJan Kiszka 715824d651Sblueswir1DEF("cpu", HAS_ARG, QEMU_OPTION_cpu, 72ad96090aSBlue Swirl "-cpu cpu select CPU (-cpu ? for list)\n", QEMU_ARCH_ALL) 735824d651Sblueswir1STEXI 745824d651Sblueswir1@item -cpu @var{model} 756616b2adSStefan Weil@findex -cpu 765824d651Sblueswir1Select CPU model (-cpu ? for list and additional feature selection) 775824d651Sblueswir1ETEXI 785824d651Sblueswir1 795824d651Sblueswir1DEF("smp", HAS_ARG, QEMU_OPTION_smp, 8058a04db1SAndre Przywara "-smp n[,maxcpus=cpus][,cores=cores][,threads=threads][,sockets=sockets]\n" 816be68d7eSJes Sorensen " set the number of CPUs to 'n' [default=1]\n" 826be68d7eSJes Sorensen " maxcpus= maximum number of total cpus, including\n" 83ca1a8a06SBruce Rogers " offline CPUs for hotplug, etc\n" 8458a04db1SAndre Przywara " cores= number of CPU cores on one socket\n" 8558a04db1SAndre Przywara " threads= number of threads on one CPU core\n" 86ad96090aSBlue Swirl " sockets= number of discrete sockets in the system\n", 87ad96090aSBlue Swirl QEMU_ARCH_ALL) 885824d651Sblueswir1STEXI 8958a04db1SAndre Przywara@item -smp @var{n}[,cores=@var{cores}][,threads=@var{threads}][,sockets=@var{sockets}][,maxcpus=@var{maxcpus}] 906616b2adSStefan Weil@findex -smp 915824d651Sblueswir1Simulate an SMP system with @var{n} CPUs. On the PC target, up to 255 925824d651Sblueswir1CPUs are supported. On Sparc32 target, Linux limits the number of usable CPUs 935824d651Sblueswir1to 4. 9458a04db1SAndre PrzywaraFor the PC target, the number of @var{cores} per socket, the number 9558a04db1SAndre Przywaraof @var{threads} per cores and the total number of @var{sockets} can be 9658a04db1SAndre Przywaraspecified. Missing values will be computed. If any on the three values is 9758a04db1SAndre Przywaragiven, the total number of CPUs @var{n} can be omitted. @var{maxcpus} 9858a04db1SAndre Przywaraspecifies the maximum number of hotpluggable CPUs. 995824d651Sblueswir1ETEXI 1005824d651Sblueswir1 101268a362cSaliguoriDEF("numa", HAS_ARG, QEMU_OPTION_numa, 102ad96090aSBlue Swirl "-numa node[,mem=size][,cpus=cpu[-cpu]][,nodeid=node]\n", QEMU_ARCH_ALL) 103268a362cSaliguoriSTEXI 104268a362cSaliguori@item -numa @var{opts} 1056616b2adSStefan Weil@findex -numa 106268a362cSaliguoriSimulate a multi node NUMA system. If mem and cpus are omitted, resources 107268a362cSaliguoriare split equally. 108268a362cSaliguoriETEXI 109268a362cSaliguori 1105824d651Sblueswir1DEF("fda", HAS_ARG, QEMU_OPTION_fda, 111ad96090aSBlue Swirl "-fda/-fdb file use 'file' as floppy disk 0/1 image\n", QEMU_ARCH_ALL) 112ad96090aSBlue SwirlDEF("fdb", HAS_ARG, QEMU_OPTION_fdb, "", QEMU_ARCH_ALL) 1135824d651Sblueswir1STEXI 1145824d651Sblueswir1@item -fda @var{file} 1155824d651Sblueswir1@item -fdb @var{file} 1166616b2adSStefan Weil@findex -fda 1176616b2adSStefan Weil@findex -fdb 1185824d651Sblueswir1Use @var{file} as floppy disk 0/1 image (@pxref{disk_images}). You can 1195824d651Sblueswir1use the host floppy by using @file{/dev/fd0} as filename (@pxref{host_drives}). 1205824d651Sblueswir1ETEXI 1215824d651Sblueswir1 1225824d651Sblueswir1DEF("hda", HAS_ARG, QEMU_OPTION_hda, 123ad96090aSBlue Swirl "-hda/-hdb file use 'file' as IDE hard disk 0/1 image\n", QEMU_ARCH_ALL) 124ad96090aSBlue SwirlDEF("hdb", HAS_ARG, QEMU_OPTION_hdb, "", QEMU_ARCH_ALL) 1255824d651Sblueswir1DEF("hdc", HAS_ARG, QEMU_OPTION_hdc, 126ad96090aSBlue Swirl "-hdc/-hdd file use 'file' as IDE hard disk 2/3 image\n", QEMU_ARCH_ALL) 127ad96090aSBlue SwirlDEF("hdd", HAS_ARG, QEMU_OPTION_hdd, "", QEMU_ARCH_ALL) 1285824d651Sblueswir1STEXI 1295824d651Sblueswir1@item -hda @var{file} 1305824d651Sblueswir1@item -hdb @var{file} 1315824d651Sblueswir1@item -hdc @var{file} 1325824d651Sblueswir1@item -hdd @var{file} 1336616b2adSStefan Weil@findex -hda 1346616b2adSStefan Weil@findex -hdb 1356616b2adSStefan Weil@findex -hdc 1366616b2adSStefan Weil@findex -hdd 1375824d651Sblueswir1Use @var{file} as hard disk 0, 1, 2 or 3 image (@pxref{disk_images}). 1385824d651Sblueswir1ETEXI 1395824d651Sblueswir1 1405824d651Sblueswir1DEF("cdrom", HAS_ARG, QEMU_OPTION_cdrom, 141ad96090aSBlue Swirl "-cdrom file use 'file' as IDE cdrom image (cdrom is ide1 master)\n", 142ad96090aSBlue Swirl QEMU_ARCH_ALL) 1435824d651Sblueswir1STEXI 1445824d651Sblueswir1@item -cdrom @var{file} 1456616b2adSStefan Weil@findex -cdrom 1465824d651Sblueswir1Use @var{file} as CD-ROM image (you cannot use @option{-hdc} and 1475824d651Sblueswir1@option{-cdrom} at the same time). You can use the host CD-ROM by 1485824d651Sblueswir1using @file{/dev/cdrom} as filename (@pxref{host_drives}). 1495824d651Sblueswir1ETEXI 1505824d651Sblueswir1 1515824d651Sblueswir1DEF("drive", HAS_ARG, QEMU_OPTION_drive, 1525824d651Sblueswir1 "-drive [file=file][,if=type][,bus=n][,unit=m][,media=d][,index=i]\n" 1535824d651Sblueswir1 " [,cyls=c,heads=h,secs=s[,trans=t]][,snapshot=on|off]\n" 15492196b2fSStefan Hajnoczi " [,cache=writethrough|writeback|none|directsync|unsafe][,format=f]\n" 155016f5cf6SAlexander Graf " [,serial=s][,addr=A][,id=name][,aio=threads|native]\n" 156fb0490f6SStefan Hajnoczi " [,readonly=on|off][,copy-on-read=on|off]\n" 1570563e191SZhi Yong Wu " [[,bps=b]|[[,bps_rd=r][,bps_wr=w]]][[,iops=i]|[[,iops_rd=r][,iops_wr=w]]\n" 158ad96090aSBlue Swirl " use 'file' as a drive image\n", QEMU_ARCH_ALL) 1595824d651Sblueswir1STEXI 1605824d651Sblueswir1@item -drive @var{option}[,@var{option}[,@var{option}[,...]]] 1616616b2adSStefan Weil@findex -drive 1625824d651Sblueswir1 1635824d651Sblueswir1Define a new drive. Valid options are: 1645824d651Sblueswir1 165b3f046c2SKevin Wolf@table @option 1665824d651Sblueswir1@item file=@var{file} 1675824d651Sblueswir1This option defines which disk image (@pxref{disk_images}) to use with 1685824d651Sblueswir1this drive. If the filename contains comma, you must double it 1695824d651Sblueswir1(for instance, "file=my,,file" to use file "my,file"). 1700f5314a2SRonnie Sahlberg 1710f5314a2SRonnie SahlbergSpecial files such as iSCSI devices can be specified using protocol 1720f5314a2SRonnie Sahlbergspecific URLs. See the section for "Device URL Syntax" for more information. 1735824d651Sblueswir1@item if=@var{interface} 1745824d651Sblueswir1This option defines on which type on interface the drive is connected. 1755824d651Sblueswir1Available types are: ide, scsi, sd, mtd, floppy, pflash, virtio. 1765824d651Sblueswir1@item bus=@var{bus},unit=@var{unit} 1775824d651Sblueswir1These options define where is connected the drive by defining the bus number and 1785824d651Sblueswir1the unit id. 1795824d651Sblueswir1@item index=@var{index} 1805824d651Sblueswir1This option defines where is connected the drive by using an index in the list 1815824d651Sblueswir1of available connectors of a given interface type. 1825824d651Sblueswir1@item media=@var{media} 1835824d651Sblueswir1This option defines the type of the media: disk or cdrom. 1845824d651Sblueswir1@item cyls=@var{c},heads=@var{h},secs=@var{s}[,trans=@var{t}] 1855824d651Sblueswir1These options have the same definition as they have in @option{-hdachs}. 1865824d651Sblueswir1@item snapshot=@var{snapshot} 1875824d651Sblueswir1@var{snapshot} is "on" or "off" and allows to enable snapshot for given drive (see @option{-snapshot}). 1885824d651Sblueswir1@item cache=@var{cache} 18992196b2fSStefan Hajnoczi@var{cache} is "none", "writeback", "unsafe", "directsync" or "writethrough" and controls how the host cache is used to access block data. 1905c6c3a6cSChristoph Hellwig@item aio=@var{aio} 1915c6c3a6cSChristoph Hellwig@var{aio} is "threads", or "native" and selects between pthread based disk I/O and native Linux AIO. 1925824d651Sblueswir1@item format=@var{format} 1935824d651Sblueswir1Specify which disk @var{format} will be used rather than detecting 1945824d651Sblueswir1the format. Can be used to specifiy format=raw to avoid interpreting 1955824d651Sblueswir1an untrusted format header. 1965824d651Sblueswir1@item serial=@var{serial} 1975824d651Sblueswir1This option specifies the serial number to assign to the device. 198c2cc47a4SMarkus Armbruster@item addr=@var{addr} 199c2cc47a4SMarkus ArmbrusterSpecify the controller's PCI address (if=virtio only). 200ae73e591SLuiz Capitulino@item werror=@var{action},rerror=@var{action} 201ae73e591SLuiz CapitulinoSpecify which @var{action} to take on write and read errors. Valid actions are: 202ae73e591SLuiz Capitulino"ignore" (ignore the error and try to continue), "stop" (pause QEMU), 203ae73e591SLuiz Capitulino"report" (report the error to the guest), "enospc" (pause QEMU only if the 204ae73e591SLuiz Capitulinohost disk is full; report the error to the guest otherwise). 205ae73e591SLuiz CapitulinoThe default setting is @option{werror=enospc} and @option{rerror=report}. 206ae73e591SLuiz Capitulino@item readonly 207ae73e591SLuiz CapitulinoOpen drive @option{file} as read-only. Guest write attempts will fail. 208fb0490f6SStefan Hajnoczi@item copy-on-read=@var{copy-on-read} 209fb0490f6SStefan Hajnoczi@var{copy-on-read} is "on" or "off" and enables whether to copy read backing 210fb0490f6SStefan Hajnoczifile sectors into the image file. 2115824d651Sblueswir1@end table 2125824d651Sblueswir1 2135824d651Sblueswir1By default, writethrough caching is used for all block device. This means that 2145824d651Sblueswir1the host page cache will be used to read and write data but write notification 2155824d651Sblueswir1will be sent to the guest only when the data has been reported as written by 2165824d651Sblueswir1the storage subsystem. 2175824d651Sblueswir1 2185824d651Sblueswir1Writeback caching will report data writes as completed as soon as the data is 2195824d651Sblueswir1present in the host page cache. This is safe as long as you trust your host. 2205824d651Sblueswir1If your host crashes or loses power, then the guest may experience data 221c3177288SAlexander Grafcorruption. 2225824d651Sblueswir1 223c304d317SAurelien JarnoThe host page cache can be avoided entirely with @option{cache=none}. This will 2245824d651Sblueswir1attempt to do disk IO directly to the guests memory. QEMU may still perform 2255824d651Sblueswir1an internal copy of the data. 2265824d651Sblueswir1 22792196b2fSStefan HajnocziThe host page cache can be avoided while only sending write notifications to 22892196b2fSStefan Hajnoczithe guest when the data has been reported as written by the storage subsystem 22992196b2fSStefan Hajnocziusing @option{cache=directsync}. 23092196b2fSStefan Hajnoczi 2315824d651Sblueswir1Some block drivers perform badly with @option{cache=writethrough}, most notably, 2325824d651Sblueswir1qcow2. If performance is more important than correctness, 2330aa217e4SKevin Wolf@option{cache=writeback} should be used with qcow2. 2345824d651Sblueswir1 235016f5cf6SAlexander GrafIn case you don't care about data integrity over host failures, use 236b65ee4faSStefan Weilcache=unsafe. This option tells QEMU that it never needs to write any data 237016f5cf6SAlexander Grafto the disk but can instead keeps things in cache. If anything goes wrong, 238e7d81004SStefan Weillike your host losing power, the disk storage getting disconnected accidentally, 239c3177288SAlexander Grafetc. you're image will most probably be rendered unusable. When using 240c3177288SAlexander Grafthe @option{-snapshot} option, unsafe caching is always used. 241016f5cf6SAlexander Graf 242fb0490f6SStefan HajnocziCopy-on-read avoids accessing the same backing file sectors repeatedly and is 243fb0490f6SStefan Hajnocziuseful when the backing file is over a slow network. By default copy-on-read 244fb0490f6SStefan Hajnocziis off. 245fb0490f6SStefan Hajnoczi 2465824d651Sblueswir1Instead of @option{-cdrom} you can use: 2475824d651Sblueswir1@example 2483804da9dSStefan Weilqemu-system-i386 -drive file=file,index=2,media=cdrom 2495824d651Sblueswir1@end example 2505824d651Sblueswir1 2515824d651Sblueswir1Instead of @option{-hda}, @option{-hdb}, @option{-hdc}, @option{-hdd}, you can 2525824d651Sblueswir1use: 2535824d651Sblueswir1@example 2543804da9dSStefan Weilqemu-system-i386 -drive file=file,index=0,media=disk 2553804da9dSStefan Weilqemu-system-i386 -drive file=file,index=1,media=disk 2563804da9dSStefan Weilqemu-system-i386 -drive file=file,index=2,media=disk 2573804da9dSStefan Weilqemu-system-i386 -drive file=file,index=3,media=disk 2585824d651Sblueswir1@end example 2595824d651Sblueswir1 2605824d651Sblueswir1You can connect a CDROM to the slave of ide0: 2615824d651Sblueswir1@example 2623804da9dSStefan Weilqemu-system-i386 -drive file=file,if=ide,index=1,media=cdrom 2635824d651Sblueswir1@end example 2645824d651Sblueswir1 2655824d651Sblueswir1If you don't specify the "file=" argument, you define an empty drive: 2665824d651Sblueswir1@example 2673804da9dSStefan Weilqemu-system-i386 -drive if=ide,index=1,media=cdrom 2685824d651Sblueswir1@end example 2695824d651Sblueswir1 2705824d651Sblueswir1You can connect a SCSI disk with unit ID 6 on the bus #0: 2715824d651Sblueswir1@example 2723804da9dSStefan Weilqemu-system-i386 -drive file=file,if=scsi,bus=0,unit=6 2735824d651Sblueswir1@end example 2745824d651Sblueswir1 2755824d651Sblueswir1Instead of @option{-fda}, @option{-fdb}, you can use: 2765824d651Sblueswir1@example 2773804da9dSStefan Weilqemu-system-i386 -drive file=file,index=0,if=floppy 2783804da9dSStefan Weilqemu-system-i386 -drive file=file,index=1,if=floppy 2795824d651Sblueswir1@end example 2805824d651Sblueswir1 2815824d651Sblueswir1By default, @var{interface} is "ide" and @var{index} is automatically 2825824d651Sblueswir1incremented: 2835824d651Sblueswir1@example 2843804da9dSStefan Weilqemu-system-i386 -drive file=a -drive file=b" 2855824d651Sblueswir1@end example 2865824d651Sblueswir1is interpreted like: 2875824d651Sblueswir1@example 2883804da9dSStefan Weilqemu-system-i386 -hda a -hdb b 2895824d651Sblueswir1@end example 2905824d651Sblueswir1ETEXI 2915824d651Sblueswir1 2926616b2adSStefan WeilDEF("set", HAS_ARG, QEMU_OPTION_set, 2936616b2adSStefan Weil "-set group.id.arg=value\n" 2946616b2adSStefan Weil " set <arg> parameter for item <id> of type <group>\n" 295ad96090aSBlue Swirl " i.e. -set drive.$id.file=/path/to/image\n", QEMU_ARCH_ALL) 2966616b2adSStefan WeilSTEXI 2976616b2adSStefan Weil@item -set 2986616b2adSStefan Weil@findex -set 2996616b2adSStefan WeilTODO 3006616b2adSStefan WeilETEXI 3016616b2adSStefan Weil 3026616b2adSStefan WeilDEF("global", HAS_ARG, QEMU_OPTION_global, 3033017b72cSMiroslav Rezanina "-global driver.prop=value\n" 304ad96090aSBlue Swirl " set a global default for a driver property\n", 305ad96090aSBlue Swirl QEMU_ARCH_ALL) 3066616b2adSStefan WeilSTEXI 3073017b72cSMiroslav Rezanina@item -global @var{driver}.@var{prop}=@var{value} 3086616b2adSStefan Weil@findex -global 3093017b72cSMiroslav RezaninaSet default value of @var{driver}'s property @var{prop} to @var{value}, e.g.: 3103017b72cSMiroslav Rezanina 3113017b72cSMiroslav Rezanina@example 3123804da9dSStefan Weilqemu-system-i386 -global ide-drive.physical_block_size=4096 -drive file=file,if=ide,index=0,media=disk 3133017b72cSMiroslav Rezanina@end example 3143017b72cSMiroslav Rezanina 3153017b72cSMiroslav RezaninaIn particular, you can use this to set driver properties for devices which are 3163017b72cSMiroslav Rezaninacreated automatically by the machine model. To create a device which is not 3173017b72cSMiroslav Rezaninacreated automatically and set properties on it, use -@option{device}. 3186616b2adSStefan WeilETEXI 3196616b2adSStefan Weil 3205824d651Sblueswir1DEF("mtdblock", HAS_ARG, QEMU_OPTION_mtdblock, 321ad96090aSBlue Swirl "-mtdblock file use 'file' as on-board Flash memory image\n", 322ad96090aSBlue Swirl QEMU_ARCH_ALL) 3235824d651Sblueswir1STEXI 3244e257e5eSKevin Wolf@item -mtdblock @var{file} 3256616b2adSStefan Weil@findex -mtdblock 3264e257e5eSKevin WolfUse @var{file} as on-board Flash memory image. 3275824d651Sblueswir1ETEXI 3285824d651Sblueswir1 3295824d651Sblueswir1DEF("sd", HAS_ARG, QEMU_OPTION_sd, 330ad96090aSBlue Swirl "-sd file use 'file' as SecureDigital card image\n", QEMU_ARCH_ALL) 3315824d651Sblueswir1STEXI 3324e257e5eSKevin Wolf@item -sd @var{file} 3336616b2adSStefan Weil@findex -sd 3344e257e5eSKevin WolfUse @var{file} as SecureDigital card image. 3355824d651Sblueswir1ETEXI 3365824d651Sblueswir1 3375824d651Sblueswir1DEF("pflash", HAS_ARG, QEMU_OPTION_pflash, 338ad96090aSBlue Swirl "-pflash file use 'file' as a parallel flash image\n", QEMU_ARCH_ALL) 3395824d651Sblueswir1STEXI 3404e257e5eSKevin Wolf@item -pflash @var{file} 3416616b2adSStefan Weil@findex -pflash 3424e257e5eSKevin WolfUse @var{file} as a parallel flash image. 3435824d651Sblueswir1ETEXI 3445824d651Sblueswir1 3455824d651Sblueswir1DEF("boot", HAS_ARG, QEMU_OPTION_boot, 3462221dde5SJan Kiszka "-boot [order=drives][,once=drives][,menu=on|off]\n" 3473d3b8303Swayne " [,splash=sp_name][,splash-time=sp_time]\n" 3483d3b8303Swayne " 'drives': floppy (a), hard disk (c), CD-ROM (d), network (n)\n" 3493d3b8303Swayne " 'sp_name': the file's name that would be passed to bios as logo picture, if menu=on\n" 3503d3b8303Swayne " 'sp_time': the period that splash picture last if menu=on, unit is ms\n", 351ad96090aSBlue Swirl QEMU_ARCH_ALL) 3525824d651Sblueswir1STEXI 3533d3b8303Swayne@item -boot [order=@var{drives}][,once=@var{drives}][,menu=on|off][,splash=@var{sp_name}][,splash-time=@var{sp_time}] 3546616b2adSStefan Weil@findex -boot 3552221dde5SJan KiszkaSpecify boot order @var{drives} as a string of drive letters. Valid 3562221dde5SJan Kiszkadrive letters depend on the target achitecture. The x86 PC uses: a, b 3572221dde5SJan Kiszka(floppy 1 and 2), c (first hard disk), d (first CD-ROM), n-p (Etherboot 3582221dde5SJan Kiszkafrom network adapter 1-4), hard disk boot is the default. To apply a 3592221dde5SJan Kiszkaparticular boot order only on the first startup, specify it via 3602221dde5SJan Kiszka@option{once}. 3612221dde5SJan Kiszka 3622221dde5SJan KiszkaInteractive boot menus/prompts can be enabled via @option{menu=on} as far 3632221dde5SJan Kiszkaas firmware/BIOS supports them. The default is non-interactive boot. 3642221dde5SJan Kiszka 3653d3b8303SwayneA splash picture could be passed to bios, enabling user to show it as logo, 3663d3b8303Swaynewhen option splash=@var{sp_name} is given and menu=on, If firmware/BIOS 3673d3b8303Swaynesupports them. Currently Seabios for X86 system support it. 3683d3b8303Swaynelimitation: The splash file could be a jpeg file or a BMP file in 24 BPP 3693d3b8303Swayneformat(true color). The resolution should be supported by the SVGA mode, so 3703d3b8303Swaynethe recommended is 320x240, 640x480, 800x640. 3713d3b8303Swayne 3722221dde5SJan Kiszka@example 3732221dde5SJan Kiszka# try to boot from network first, then from hard disk 3743804da9dSStefan Weilqemu-system-i386 -boot order=nc 3752221dde5SJan Kiszka# boot from CD-ROM first, switch back to default order after reboot 3763804da9dSStefan Weilqemu-system-i386 -boot once=d 3773d3b8303Swayne# boot with a splash picture for 5 seconds. 3783804da9dSStefan Weilqemu-system-i386 -boot menu=on,splash=/root/boot.bmp,splash-time=5000 3792221dde5SJan Kiszka@end example 3802221dde5SJan Kiszka 3812221dde5SJan KiszkaNote: The legacy format '-boot @var{drives}' is still supported but its 3822221dde5SJan Kiszkause is discouraged as it may be removed from future versions. 3835824d651Sblueswir1ETEXI 3845824d651Sblueswir1 3855824d651Sblueswir1DEF("snapshot", 0, QEMU_OPTION_snapshot, 386ad96090aSBlue Swirl "-snapshot write to temporary files instead of disk image files\n", 387ad96090aSBlue Swirl QEMU_ARCH_ALL) 3885824d651Sblueswir1STEXI 3895824d651Sblueswir1@item -snapshot 3906616b2adSStefan Weil@findex -snapshot 3915824d651Sblueswir1Write to temporary files instead of disk image files. In this case, 3925824d651Sblueswir1the raw disk image you use is not written back. You can however force 3935824d651Sblueswir1the write back by pressing @key{C-a s} (@pxref{disk_images}). 3945824d651Sblueswir1ETEXI 3955824d651Sblueswir1 3965824d651Sblueswir1DEF("m", HAS_ARG, QEMU_OPTION_m, 397bec7c2d4SPaolo Bonzini "-m megs set virtual RAM size to megs MB [default=" 398ad96090aSBlue Swirl stringify(DEFAULT_RAM_SIZE) "]\n", QEMU_ARCH_ALL) 3995824d651Sblueswir1STEXI 4005824d651Sblueswir1@item -m @var{megs} 4016616b2adSStefan Weil@findex -m 4025824d651Sblueswir1Set virtual RAM size to @var{megs} megabytes. Default is 128 MiB. Optionally, 4035824d651Sblueswir1a suffix of ``M'' or ``G'' can be used to signify a value in megabytes or 4045824d651Sblueswir1gigabytes respectively. 4055824d651Sblueswir1ETEXI 4065824d651Sblueswir1 407c902760fSMarcelo TosattiDEF("mem-path", HAS_ARG, QEMU_OPTION_mempath, 408ad96090aSBlue Swirl "-mem-path FILE provide backing storage for guest RAM\n", QEMU_ARCH_ALL) 409c902760fSMarcelo TosattiSTEXI 410c902760fSMarcelo Tosatti@item -mem-path @var{path} 411c902760fSMarcelo TosattiAllocate guest RAM from a temporarily created file in @var{path}. 412c902760fSMarcelo TosattiETEXI 413c902760fSMarcelo Tosatti 414c902760fSMarcelo Tosatti#ifdef MAP_POPULATE 415c902760fSMarcelo TosattiDEF("mem-prealloc", 0, QEMU_OPTION_mem_prealloc, 416ad96090aSBlue Swirl "-mem-prealloc preallocate guest memory (use with -mem-path)\n", 417ad96090aSBlue Swirl QEMU_ARCH_ALL) 418c902760fSMarcelo TosattiSTEXI 419c902760fSMarcelo Tosatti@item -mem-prealloc 420c902760fSMarcelo TosattiPreallocate memory when using -mem-path. 421c902760fSMarcelo TosattiETEXI 422c902760fSMarcelo Tosatti#endif 423c902760fSMarcelo Tosatti 4245824d651Sblueswir1DEF("k", HAS_ARG, QEMU_OPTION_k, 425ad96090aSBlue Swirl "-k language use keyboard layout (for example 'fr' for French)\n", 426ad96090aSBlue Swirl QEMU_ARCH_ALL) 4275824d651Sblueswir1STEXI 4285824d651Sblueswir1@item -k @var{language} 4296616b2adSStefan Weil@findex -k 4305824d651Sblueswir1Use keyboard layout @var{language} (for example @code{fr} for 4315824d651Sblueswir1French). This option is only needed where it is not easy to get raw PC 4325824d651Sblueswir1keycodes (e.g. on Macs, with some X11 servers or with a VNC 4335824d651Sblueswir1display). You don't normally need to use it on PC/Linux or PC/Windows 4345824d651Sblueswir1hosts. 4355824d651Sblueswir1 4365824d651Sblueswir1The available layouts are: 4375824d651Sblueswir1@example 4385824d651Sblueswir1ar de-ch es fo fr-ca hu ja mk no pt-br sv 4395824d651Sblueswir1da en-gb et fr fr-ch is lt nl pl ru th 4405824d651Sblueswir1de en-us fi fr-be hr it lv nl-be pt sl tr 4415824d651Sblueswir1@end example 4425824d651Sblueswir1 4435824d651Sblueswir1The default is @code{en-us}. 4445824d651Sblueswir1ETEXI 4455824d651Sblueswir1 4465824d651Sblueswir1 4475824d651Sblueswir1DEF("audio-help", 0, QEMU_OPTION_audio_help, 448ad96090aSBlue Swirl "-audio-help print list of audio drivers and their options\n", 449ad96090aSBlue Swirl QEMU_ARCH_ALL) 4505824d651Sblueswir1STEXI 4515824d651Sblueswir1@item -audio-help 4526616b2adSStefan Weil@findex -audio-help 4535824d651Sblueswir1Will show the audio subsystem help: list of drivers, tunable 4545824d651Sblueswir1parameters. 4555824d651Sblueswir1ETEXI 4565824d651Sblueswir1 4575824d651Sblueswir1DEF("soundhw", HAS_ARG, QEMU_OPTION_soundhw, 4585824d651Sblueswir1 "-soundhw c1,... enable audio support\n" 4595824d651Sblueswir1 " and only specified sound cards (comma separated list)\n" 4605824d651Sblueswir1 " use -soundhw ? to get the list of supported cards\n" 461ad96090aSBlue Swirl " use -soundhw all to enable all of them\n", QEMU_ARCH_ALL) 4625824d651Sblueswir1STEXI 4635824d651Sblueswir1@item -soundhw @var{card1}[,@var{card2},...] or -soundhw all 4646616b2adSStefan Weil@findex -soundhw 4655824d651Sblueswir1Enable audio and selected sound hardware. Use ? to print all 4665824d651Sblueswir1available sound hardware. 4675824d651Sblueswir1 4685824d651Sblueswir1@example 4693804da9dSStefan Weilqemu-system-i386 -soundhw sb16,adlib disk.img 4703804da9dSStefan Weilqemu-system-i386 -soundhw es1370 disk.img 4713804da9dSStefan Weilqemu-system-i386 -soundhw ac97 disk.img 4723804da9dSStefan Weilqemu-system-i386 -soundhw hda disk.img 4733804da9dSStefan Weilqemu-system-i386 -soundhw all disk.img 4743804da9dSStefan Weilqemu-system-i386 -soundhw ? 4755824d651Sblueswir1@end example 4765824d651Sblueswir1 4775824d651Sblueswir1Note that Linux's i810_audio OSS kernel (for AC97) module might 4785824d651Sblueswir1require manually specifying clocking. 4795824d651Sblueswir1 4805824d651Sblueswir1@example 4815824d651Sblueswir1modprobe i810_audio clocking=48000 4825824d651Sblueswir1@end example 4835824d651Sblueswir1ETEXI 4845824d651Sblueswir1 485b1746dddSMichael EllermanDEF("balloon", HAS_ARG, QEMU_OPTION_balloon, 486b1746dddSMichael Ellerman "-balloon none disable balloon device\n" 487b1746dddSMichael Ellerman "-balloon virtio[,addr=str]\n" 488b1746dddSMichael Ellerman " enable virtio balloon device (default)\n", QEMU_ARCH_ALL) 489b1746dddSMichael EllermanSTEXI 490b1746dddSMichael Ellerman@item -balloon none 491b1746dddSMichael Ellerman@findex -balloon 492b1746dddSMichael EllermanDisable balloon device. 493b1746dddSMichael Ellerman@item -balloon virtio[,addr=@var{addr}] 494b1746dddSMichael EllermanEnable virtio balloon device (default), optionally with PCI address 495b1746dddSMichael Ellerman@var{addr}. 496b1746dddSMichael EllermanETEXI 497b1746dddSMichael Ellerman 4985824d651Sblueswir1STEXI 4995824d651Sblueswir1@end table 5005824d651Sblueswir1ETEXI 5015824d651Sblueswir1 5025824d651Sblueswir1DEF("usb", 0, QEMU_OPTION_usb, 503ad96090aSBlue Swirl "-usb enable the USB driver (will be the default soon)\n", 504ad96090aSBlue Swirl QEMU_ARCH_ALL) 5055824d651Sblueswir1STEXI 5065824d651Sblueswir1USB options: 5075824d651Sblueswir1@table @option 5085824d651Sblueswir1 5095824d651Sblueswir1@item -usb 5106616b2adSStefan Weil@findex -usb 5115824d651Sblueswir1Enable the USB driver (will be the default soon) 5125824d651Sblueswir1ETEXI 5135824d651Sblueswir1 5145824d651Sblueswir1DEF("usbdevice", HAS_ARG, QEMU_OPTION_usbdevice, 515ad96090aSBlue Swirl "-usbdevice name add the host or guest USB device 'name'\n", 516ad96090aSBlue Swirl QEMU_ARCH_ALL) 5175824d651Sblueswir1STEXI 5185824d651Sblueswir1 5195824d651Sblueswir1@item -usbdevice @var{devname} 5206616b2adSStefan Weil@findex -usbdevice 5215824d651Sblueswir1Add the USB device @var{devname}. @xref{usb_devices}. 5225824d651Sblueswir1 523b3f046c2SKevin Wolf@table @option 5245824d651Sblueswir1 5255824d651Sblueswir1@item mouse 5265824d651Sblueswir1Virtual Mouse. This will override the PS/2 mouse emulation when activated. 5275824d651Sblueswir1 5285824d651Sblueswir1@item tablet 5295824d651Sblueswir1Pointer device that uses absolute coordinates (like a touchscreen). This 530b65ee4faSStefan Weilmeans QEMU is able to report the mouse position without having to grab the 5315824d651Sblueswir1mouse. Also overrides the PS/2 mouse emulation when activated. 5325824d651Sblueswir1 5334e257e5eSKevin Wolf@item disk:[format=@var{format}]:@var{file} 5345824d651Sblueswir1Mass storage device based on file. The optional @var{format} argument 5355824d651Sblueswir1will be used rather than detecting the format. Can be used to specifiy 5364e257e5eSKevin Wolf@code{format=raw} to avoid interpreting an untrusted format header. 5375824d651Sblueswir1 5384e257e5eSKevin Wolf@item host:@var{bus}.@var{addr} 5394e257e5eSKevin WolfPass through the host device identified by @var{bus}.@var{addr} (Linux only). 5405824d651Sblueswir1 5414e257e5eSKevin Wolf@item host:@var{vendor_id}:@var{product_id} 5424e257e5eSKevin WolfPass through the host device identified by @var{vendor_id}:@var{product_id} 5434e257e5eSKevin Wolf(Linux only). 5445824d651Sblueswir1 5455824d651Sblueswir1@item serial:[vendorid=@var{vendor_id}][,productid=@var{product_id}]:@var{dev} 5465824d651Sblueswir1Serial converter to host character device @var{dev}, see @code{-serial} for the 5475824d651Sblueswir1available devices. 5485824d651Sblueswir1 5495824d651Sblueswir1@item braille 5505824d651Sblueswir1Braille device. This will use BrlAPI to display the braille output on a real 5515824d651Sblueswir1or fake device. 5525824d651Sblueswir1 5534e257e5eSKevin Wolf@item net:@var{options} 5545824d651Sblueswir1Network adapter that supports CDC ethernet and RNDIS protocols. 5555824d651Sblueswir1 5565824d651Sblueswir1@end table 5575824d651Sblueswir1ETEXI 5585824d651Sblueswir1 559bd3c948dSGerd HoffmannDEF("device", HAS_ARG, QEMU_OPTION_device, 56040ea285cSMarkus Armbruster "-device driver[,prop[=value][,...]]\n" 56140ea285cSMarkus Armbruster " add device (based on driver)\n" 56240ea285cSMarkus Armbruster " prop=value,... sets driver properties\n" 56369a319d1SStefan Weil " use -device ? to print all possible drivers\n" 5649848bbf1SMarkus Armbruster " use -device driver,? to print all possible properties\n", 565ad96090aSBlue Swirl QEMU_ARCH_ALL) 5663dbf2c7fSStefan WeilSTEXI 5679848bbf1SMarkus Armbruster@item -device @var{driver}[,@var{prop}[=@var{value}][,...]] 5686616b2adSStefan Weil@findex -device 5699848bbf1SMarkus ArmbrusterAdd device @var{driver}. @var{prop}=@var{value} sets driver 5709848bbf1SMarkus Armbrusterproperties. Valid properties depend on the driver. To get help on 5719848bbf1SMarkus Armbrusterpossible drivers and properties, use @code{-device ?} and 5729848bbf1SMarkus Armbruster@code{-device @var{driver},?}. 5733dbf2c7fSStefan WeilETEXI 5743dbf2c7fSStefan Weil 5757c92a3d2SAneesh Kumar K.VDEFHEADING() 5767c92a3d2SAneesh Kumar K.V 57774db920cSGautham R ShenoyDEFHEADING(File system options:) 57874db920cSGautham R Shenoy 57974db920cSGautham R ShenoyDEF("fsdev", HAS_ARG, QEMU_OPTION_fsdev, 5802c30dd74SAneesh Kumar K.V "-fsdev fsdriver,id=id[,path=path,][security_model={mapped-xattr|mapped-file|passthrough|none}]\n" 58184a87cc4SM. Mohan Kumar " [,writeout=immediate][,readonly][,socket=socket|sock_fd=sock_fd]\n", 58274db920cSGautham R Shenoy QEMU_ARCH_ALL) 58374db920cSGautham R Shenoy 58474db920cSGautham R ShenoySTEXI 58574db920cSGautham R Shenoy 58684a87cc4SM. Mohan Kumar@item -fsdev @var{fsdriver},id=@var{id},path=@var{path},[security_model=@var{security_model}][,writeout=@var{writeout}][,readonly][,socket=@var{socket}|sock_fd=@var{sock_fd}] 58774db920cSGautham R Shenoy@findex -fsdev 5887c92a3d2SAneesh Kumar K.VDefine a new file system device. Valid options are: 5897c92a3d2SAneesh Kumar K.V@table @option 5907c92a3d2SAneesh Kumar K.V@item @var{fsdriver} 5917c92a3d2SAneesh Kumar K.VThis option specifies the fs driver backend to use. 592f67e3ffdSM. Mohan KumarCurrently "local", "handle" and "proxy" file system drivers are supported. 5937c92a3d2SAneesh Kumar K.V@item id=@var{id} 5947c92a3d2SAneesh Kumar K.VSpecifies identifier for this device 5957c92a3d2SAneesh Kumar K.V@item path=@var{path} 5967c92a3d2SAneesh Kumar K.VSpecifies the export path for the file system device. Files under 5977c92a3d2SAneesh Kumar K.Vthis path will be available to the 9p client on the guest. 5987c92a3d2SAneesh Kumar K.V@item security_model=@var{security_model} 5997c92a3d2SAneesh Kumar K.VSpecifies the security model to be used for this export path. 6002c30dd74SAneesh Kumar K.VSupported security models are "passthrough", "mapped-xattr", "mapped-file" and "none". 6017c92a3d2SAneesh Kumar K.VIn "passthrough" security model, files are stored using the same 602b65ee4faSStefan Weilcredentials as they are created on the guest. This requires QEMU 6032c30dd74SAneesh Kumar K.Vto run as root. In "mapped-xattr" security model, some of the file 6047c92a3d2SAneesh Kumar K.Vattributes like uid, gid, mode bits and link target are stored as 6052c30dd74SAneesh Kumar K.Vfile attributes. For "mapped-file" these attributes are stored in the 6062c30dd74SAneesh Kumar K.Vhidden .virtfs_metadata directory. Directories exported by this security model cannot 6077c92a3d2SAneesh Kumar K.Vinteract with other unix tools. "none" security model is same as 6087c92a3d2SAneesh Kumar K.Vpassthrough except the sever won't report failures if it fails to 609d9b36a6eSM. Mohan Kumarset file attributes like ownership. Security model is mandatory 610f67e3ffdSM. Mohan Kumaronly for local fsdriver. Other fsdrivers (like handle, proxy) don't take 611d9b36a6eSM. Mohan Kumarsecurity model as a parameter. 6127c92a3d2SAneesh Kumar K.V@item writeout=@var{writeout} 6137c92a3d2SAneesh Kumar K.VThis is an optional argument. The only supported value is "immediate". 6147c92a3d2SAneesh Kumar K.VThis means that host page cache will be used to read and write data but 6157c92a3d2SAneesh Kumar K.Vwrite notification will be sent to the guest only when the data has been 6167c92a3d2SAneesh Kumar K.Vreported as written by the storage subsystem. 6172c74c2cbSM. Mohan Kumar@item readonly 6182c74c2cbSM. Mohan KumarEnables exporting 9p share as a readonly mount for guests. By default 6192c74c2cbSM. Mohan Kumarread-write access is given. 62084a87cc4SM. Mohan Kumar@item socket=@var{socket} 62184a87cc4SM. Mohan KumarEnables proxy filesystem driver to use passed socket file for communicating 62284a87cc4SM. Mohan Kumarwith virtfs-proxy-helper 623f67e3ffdSM. Mohan Kumar@item sock_fd=@var{sock_fd} 624f67e3ffdSM. Mohan KumarEnables proxy filesystem driver to use passed socket descriptor for 625f67e3ffdSM. Mohan Kumarcommunicating with virtfs-proxy-helper. Usually a helper like libvirt 626f67e3ffdSM. Mohan Kumarwill create socketpair and pass one of the fds as sock_fd 62774db920cSGautham R Shenoy@end table 6287c92a3d2SAneesh Kumar K.V 6297c92a3d2SAneesh Kumar K.V-fsdev option is used along with -device driver "virtio-9p-pci". 6307c92a3d2SAneesh Kumar K.V@item -device virtio-9p-pci,fsdev=@var{id},mount_tag=@var{mount_tag} 6317c92a3d2SAneesh Kumar K.VOptions for virtio-9p-pci driver are: 6327c92a3d2SAneesh Kumar K.V@table @option 6337c92a3d2SAneesh Kumar K.V@item fsdev=@var{id} 6347c92a3d2SAneesh Kumar K.VSpecifies the id value specified along with -fsdev option 6357c92a3d2SAneesh Kumar K.V@item mount_tag=@var{mount_tag} 6367c92a3d2SAneesh Kumar K.VSpecifies the tag name to be used by the guest to mount this export point 6377c92a3d2SAneesh Kumar K.V@end table 6387c92a3d2SAneesh Kumar K.V 63974db920cSGautham R ShenoyETEXI 64074db920cSGautham R Shenoy 6417c92a3d2SAneesh Kumar K.VDEFHEADING() 6427c92a3d2SAneesh Kumar K.V 6433d54abc7SGautham R ShenoyDEFHEADING(Virtual File system pass-through options:) 6443d54abc7SGautham R Shenoy 6453d54abc7SGautham R ShenoyDEF("virtfs", HAS_ARG, QEMU_OPTION_virtfs, 6462c30dd74SAneesh Kumar K.V "-virtfs local,path=path,mount_tag=tag,security_model=[mapped-xattr|mapped-file|passthrough|none]\n" 64784a87cc4SM. Mohan Kumar " [,writeout=immediate][,readonly][,socket=socket|sock_fd=sock_fd]\n", 6483d54abc7SGautham R Shenoy QEMU_ARCH_ALL) 6493d54abc7SGautham R Shenoy 6503d54abc7SGautham R ShenoySTEXI 6513d54abc7SGautham R Shenoy 65284a87cc4SM. Mohan Kumar@item -virtfs @var{fsdriver}[,path=@var{path}],mount_tag=@var{mount_tag}[,security_model=@var{security_model}][,writeout=@var{writeout}][,readonly][,socket=@var{socket}|sock_fd=@var{sock_fd}] 6533d54abc7SGautham R Shenoy@findex -virtfs 6543d54abc7SGautham R Shenoy 6557c92a3d2SAneesh Kumar K.VThe general form of a Virtual File system pass-through options are: 6567c92a3d2SAneesh Kumar K.V@table @option 6577c92a3d2SAneesh Kumar K.V@item @var{fsdriver} 6587c92a3d2SAneesh Kumar K.VThis option specifies the fs driver backend to use. 659f67e3ffdSM. Mohan KumarCurrently "local", "handle" and "proxy" file system drivers are supported. 6607c92a3d2SAneesh Kumar K.V@item id=@var{id} 6617c92a3d2SAneesh Kumar K.VSpecifies identifier for this device 6627c92a3d2SAneesh Kumar K.V@item path=@var{path} 6637c92a3d2SAneesh Kumar K.VSpecifies the export path for the file system device. Files under 6647c92a3d2SAneesh Kumar K.Vthis path will be available to the 9p client on the guest. 6657c92a3d2SAneesh Kumar K.V@item security_model=@var{security_model} 6667c92a3d2SAneesh Kumar K.VSpecifies the security model to be used for this export path. 6672c30dd74SAneesh Kumar K.VSupported security models are "passthrough", "mapped-xattr", "mapped-file" and "none". 6687c92a3d2SAneesh Kumar K.VIn "passthrough" security model, files are stored using the same 669b65ee4faSStefan Weilcredentials as they are created on the guest. This requires QEMU 6702c30dd74SAneesh Kumar K.Vto run as root. In "mapped-xattr" security model, some of the file 6717c92a3d2SAneesh Kumar K.Vattributes like uid, gid, mode bits and link target are stored as 6722c30dd74SAneesh Kumar K.Vfile attributes. For "mapped-file" these attributes are stored in the 6732c30dd74SAneesh Kumar K.Vhidden .virtfs_metadata directory. Directories exported by this security model cannot 6747c92a3d2SAneesh Kumar K.Vinteract with other unix tools. "none" security model is same as 6757c92a3d2SAneesh Kumar K.Vpassthrough except the sever won't report failures if it fails to 676d9b36a6eSM. Mohan Kumarset file attributes like ownership. Security model is mandatory only 677f67e3ffdSM. Mohan Kumarfor local fsdriver. Other fsdrivers (like handle, proxy) don't take security 678d9b36a6eSM. Mohan Kumarmodel as a parameter. 6797c92a3d2SAneesh Kumar K.V@item writeout=@var{writeout} 6807c92a3d2SAneesh Kumar K.VThis is an optional argument. The only supported value is "immediate". 6817c92a3d2SAneesh Kumar K.VThis means that host page cache will be used to read and write data but 6827c92a3d2SAneesh Kumar K.Vwrite notification will be sent to the guest only when the data has been 6837c92a3d2SAneesh Kumar K.Vreported as written by the storage subsystem. 6842c74c2cbSM. Mohan Kumar@item readonly 6852c74c2cbSM. Mohan KumarEnables exporting 9p share as a readonly mount for guests. By default 6862c74c2cbSM. Mohan Kumarread-write access is given. 68784a87cc4SM. Mohan Kumar@item socket=@var{socket} 68884a87cc4SM. Mohan KumarEnables proxy filesystem driver to use passed socket file for 68984a87cc4SM. Mohan Kumarcommunicating with virtfs-proxy-helper. Usually a helper like libvirt 69084a87cc4SM. Mohan Kumarwill create socketpair and pass one of the fds as sock_fd 691f67e3ffdSM. Mohan Kumar@item sock_fd 692f67e3ffdSM. Mohan KumarEnables proxy filesystem driver to use passed 'sock_fd' as the socket 693f67e3ffdSM. Mohan Kumardescriptor for interfacing with virtfs-proxy-helper 6943d54abc7SGautham R Shenoy@end table 6953d54abc7SGautham R ShenoyETEXI 6963d54abc7SGautham R Shenoy 6979db221aeSAneesh Kumar K.VDEF("virtfs_synth", 0, QEMU_OPTION_virtfs_synth, 6989db221aeSAneesh Kumar K.V "-virtfs_synth Create synthetic file system image\n", 6999db221aeSAneesh Kumar K.V QEMU_ARCH_ALL) 7009db221aeSAneesh Kumar K.VSTEXI 7019db221aeSAneesh Kumar K.V@item -virtfs_synth 7029db221aeSAneesh Kumar K.V@findex -virtfs_synth 7039db221aeSAneesh Kumar K.VCreate synthetic file system image 7049db221aeSAneesh Kumar K.VETEXI 7059db221aeSAneesh Kumar K.V 70674db920cSGautham R ShenoyDEFHEADING() 70774db920cSGautham R Shenoy 7085824d651Sblueswir1DEF("name", HAS_ARG, QEMU_OPTION_name, 709ca1a8a06SBruce Rogers "-name string1[,process=string2]\n" 710ca1a8a06SBruce Rogers " set the name of the guest\n" 711ad96090aSBlue Swirl " string1 sets the window title and string2 the process name (on Linux)\n", 712ad96090aSBlue Swirl QEMU_ARCH_ALL) 7135824d651Sblueswir1STEXI 7145824d651Sblueswir1@item -name @var{name} 7156616b2adSStefan Weil@findex -name 7165824d651Sblueswir1Sets the @var{name} of the guest. 7175824d651Sblueswir1This name will be displayed in the SDL window caption. 7185824d651Sblueswir1The @var{name} will also be used for the VNC server. 7191889465aSAndi KleenAlso optionally set the top visible process name in Linux. 7205824d651Sblueswir1ETEXI 7215824d651Sblueswir1 7225824d651Sblueswir1DEF("uuid", HAS_ARG, QEMU_OPTION_uuid, 723e8105ebbSPaolo Bonzini "-uuid %08x-%04x-%04x-%04x-%012x\n" 724ad96090aSBlue Swirl " specify machine UUID\n", QEMU_ARCH_ALL) 7255824d651Sblueswir1STEXI 7265824d651Sblueswir1@item -uuid @var{uuid} 7276616b2adSStefan Weil@findex -uuid 7285824d651Sblueswir1Set system UUID. 7295824d651Sblueswir1ETEXI 7305824d651Sblueswir1 7315824d651Sblueswir1STEXI 7325824d651Sblueswir1@end table 7335824d651Sblueswir1ETEXI 7345824d651Sblueswir1 7355824d651Sblueswir1DEFHEADING() 7365824d651Sblueswir1 7375824d651Sblueswir1DEFHEADING(Display options:) 7385824d651Sblueswir1 7395824d651Sblueswir1STEXI 7405824d651Sblueswir1@table @option 7415824d651Sblueswir1ETEXI 7425824d651Sblueswir1 7431472a95bSJes SorensenDEF("display", HAS_ARG, QEMU_OPTION_display, 7441472a95bSJes Sorensen "-display sdl[,frame=on|off][,alt_grab=on|off][,ctrl_grab=on|off]\n" 7453264ff12SJes Sorensen " [,window_close=on|off]|curses|none|\n" 7463264ff12SJes Sorensen " vnc=<display>[,<optargs>]\n" 7471472a95bSJes Sorensen " select display type\n", QEMU_ARCH_ALL) 7481472a95bSJes SorensenSTEXI 7491472a95bSJes Sorensen@item -display @var{type} 7501472a95bSJes Sorensen@findex -display 7511472a95bSJes SorensenSelect type of display to use. This option is a replacement for the 7521472a95bSJes Sorensenold style -sdl/-curses/... options. Valid values for @var{type} are 7531472a95bSJes Sorensen@table @option 7541472a95bSJes Sorensen@item sdl 7551472a95bSJes SorensenDisplay video output via SDL (usually in a separate graphics 7561472a95bSJes Sorensenwindow; see the SDL documentation for other possibilities). 7571472a95bSJes Sorensen@item curses 7581472a95bSJes SorensenDisplay video output via curses. For graphics device models which 7591472a95bSJes Sorensensupport a text mode, QEMU can display this output using a 7601472a95bSJes Sorensencurses/ncurses interface. Nothing is displayed when the graphics 7611472a95bSJes Sorensendevice is in graphical mode or if the graphics device does not support 7621472a95bSJes Sorensena text mode. Generally only the VGA device models support text mode. 7634171d32eSJes Sorensen@item none 7644171d32eSJes SorensenDo not display video output. The guest will still see an emulated 7654171d32eSJes Sorensengraphics card, but its output will not be displayed to the QEMU 7664171d32eSJes Sorensenuser. This option differs from the -nographic option in that it 7674171d32eSJes Sorensenonly affects what is done with video output; -nographic also changes 7684171d32eSJes Sorensenthe destination of the serial and parallel port data. 7693264ff12SJes Sorensen@item vnc 7703264ff12SJes SorensenStart a VNC server on display <arg> 7711472a95bSJes Sorensen@end table 7721472a95bSJes SorensenETEXI 7731472a95bSJes Sorensen 7745824d651Sblueswir1DEF("nographic", 0, QEMU_OPTION_nographic, 775ad96090aSBlue Swirl "-nographic disable graphical output and redirect serial I/Os to console\n", 776ad96090aSBlue Swirl QEMU_ARCH_ALL) 7775824d651Sblueswir1STEXI 7785824d651Sblueswir1@item -nographic 7796616b2adSStefan Weil@findex -nographic 7805824d651Sblueswir1Normally, QEMU uses SDL to display the VGA output. With this option, 7815824d651Sblueswir1you can totally disable graphical output so that QEMU is a simple 7825824d651Sblueswir1command line application. The emulated serial port is redirected on 7835824d651Sblueswir1the console. Therefore, you can still use QEMU to debug a Linux kernel 7845824d651Sblueswir1with a serial console. 7855824d651Sblueswir1ETEXI 7865824d651Sblueswir1 7875824d651Sblueswir1DEF("curses", 0, QEMU_OPTION_curses, 788ad96090aSBlue Swirl "-curses use a curses/ncurses interface instead of SDL\n", 789ad96090aSBlue Swirl QEMU_ARCH_ALL) 7905824d651Sblueswir1STEXI 7915824d651Sblueswir1@item -curses 7926616b2adSStefan Weil@findex curses 7935824d651Sblueswir1Normally, QEMU uses SDL to display the VGA output. With this option, 7945824d651Sblueswir1QEMU can display the VGA output when in text mode using a 7955824d651Sblueswir1curses/ncurses interface. Nothing is displayed in graphical mode. 7965824d651Sblueswir1ETEXI 7975824d651Sblueswir1 7985824d651Sblueswir1DEF("no-frame", 0, QEMU_OPTION_no_frame, 799ad96090aSBlue Swirl "-no-frame open SDL window without a frame and window decorations\n", 800ad96090aSBlue Swirl QEMU_ARCH_ALL) 8015824d651Sblueswir1STEXI 8025824d651Sblueswir1@item -no-frame 8036616b2adSStefan Weil@findex -no-frame 8045824d651Sblueswir1Do not use decorations for SDL windows and start them using the whole 8055824d651Sblueswir1available screen space. This makes the using QEMU in a dedicated desktop 8065824d651Sblueswir1workspace more convenient. 8075824d651Sblueswir1ETEXI 8085824d651Sblueswir1 8095824d651Sblueswir1DEF("alt-grab", 0, QEMU_OPTION_alt_grab, 810ad96090aSBlue Swirl "-alt-grab use Ctrl-Alt-Shift to grab mouse (instead of Ctrl-Alt)\n", 811ad96090aSBlue Swirl QEMU_ARCH_ALL) 8125824d651Sblueswir1STEXI 8135824d651Sblueswir1@item -alt-grab 8146616b2adSStefan Weil@findex -alt-grab 815de1db2a1SBrad HardsUse Ctrl-Alt-Shift to grab mouse (instead of Ctrl-Alt). Note that this also 816de1db2a1SBrad Hardsaffects the special keys (for fullscreen, monitor-mode switching, etc). 8175824d651Sblueswir1ETEXI 8185824d651Sblueswir1 8190ca9f8a4SDustin KirklandDEF("ctrl-grab", 0, QEMU_OPTION_ctrl_grab, 820ad96090aSBlue Swirl "-ctrl-grab use Right-Ctrl to grab mouse (instead of Ctrl-Alt)\n", 821ad96090aSBlue Swirl QEMU_ARCH_ALL) 8220ca9f8a4SDustin KirklandSTEXI 8230ca9f8a4SDustin Kirkland@item -ctrl-grab 8246616b2adSStefan Weil@findex -ctrl-grab 825de1db2a1SBrad HardsUse Right-Ctrl to grab mouse (instead of Ctrl-Alt). Note that this also 826de1db2a1SBrad Hardsaffects the special keys (for fullscreen, monitor-mode switching, etc). 8270ca9f8a4SDustin KirklandETEXI 8280ca9f8a4SDustin Kirkland 8295824d651Sblueswir1DEF("no-quit", 0, QEMU_OPTION_no_quit, 830ad96090aSBlue Swirl "-no-quit disable SDL window close capability\n", QEMU_ARCH_ALL) 8315824d651Sblueswir1STEXI 8325824d651Sblueswir1@item -no-quit 8336616b2adSStefan Weil@findex -no-quit 8345824d651Sblueswir1Disable SDL window close capability. 8355824d651Sblueswir1ETEXI 8365824d651Sblueswir1 8375824d651Sblueswir1DEF("sdl", 0, QEMU_OPTION_sdl, 838ad96090aSBlue Swirl "-sdl enable SDL\n", QEMU_ARCH_ALL) 8395824d651Sblueswir1STEXI 8405824d651Sblueswir1@item -sdl 8416616b2adSStefan Weil@findex -sdl 8425824d651Sblueswir1Enable SDL. 8435824d651Sblueswir1ETEXI 8445824d651Sblueswir1 84529b0040bSGerd HoffmannDEF("spice", HAS_ARG, QEMU_OPTION_spice, 84627af7788SYonit Halperin "-spice [port=port][,tls-port=secured-port][,x509-dir=<dir>]\n" 84727af7788SYonit Halperin " [,x509-key-file=<file>][,x509-key-password=<file>]\n" 84827af7788SYonit Halperin " [,x509-cert-file=<file>][,x509-cacert-file=<file>]\n" 84927af7788SYonit Halperin " [,x509-dh-key-file=<file>][,addr=addr][,ipv4|ipv6]\n" 85027af7788SYonit Halperin " [,tls-ciphers=<list>]\n" 85127af7788SYonit Halperin " [,tls-channel=[main|display|cursor|inputs|record|playback]]\n" 85227af7788SYonit Halperin " [,plaintext-channel=[main|display|cursor|inputs|record|playback]]\n" 85327af7788SYonit Halperin " [,sasl][,password=<secret>][,disable-ticketing]\n" 85427af7788SYonit Halperin " [,image-compression=[auto_glz|auto_lz|quic|glz|lz|off]]\n" 85527af7788SYonit Halperin " [,jpeg-wan-compression=[auto|never|always]]\n" 85627af7788SYonit Halperin " [,zlib-glz-wan-compression=[auto|never|always]]\n" 85727af7788SYonit Halperin " [,streaming-video=[off|all|filter]][,disable-copy-paste]\n" 85827af7788SYonit Halperin " [,agent-mouse=[on|off]][,playback-compression=[on|off]]\n" 85927af7788SYonit Halperin " [,seamless-migration=[on|off]]\n" 86027af7788SYonit Halperin " enable spice\n" 86127af7788SYonit Halperin " at least one of {port, tls-port} is mandatory\n", 86227af7788SYonit Halperin QEMU_ARCH_ALL) 86329b0040bSGerd HoffmannSTEXI 86429b0040bSGerd Hoffmann@item -spice @var{option}[,@var{option}[,...]] 86529b0040bSGerd Hoffmann@findex -spice 86629b0040bSGerd HoffmannEnable the spice remote desktop protocol. Valid options are 86729b0040bSGerd Hoffmann 86829b0040bSGerd Hoffmann@table @option 86929b0040bSGerd Hoffmann 87029b0040bSGerd Hoffmann@item port=<nr> 871c448e855SGerd HoffmannSet the TCP port spice is listening on for plaintext channels. 87229b0040bSGerd Hoffmann 873333b0eebSGerd Hoffmann@item addr=<addr> 874333b0eebSGerd HoffmannSet the IP address spice is listening on. Default is any address. 875333b0eebSGerd Hoffmann 876333b0eebSGerd Hoffmann@item ipv4 877333b0eebSGerd Hoffmann@item ipv6 878333b0eebSGerd HoffmannForce using the specified IP version. 879333b0eebSGerd Hoffmann 88029b0040bSGerd Hoffmann@item password=<secret> 88129b0040bSGerd HoffmannSet the password you need to authenticate. 88229b0040bSGerd Hoffmann 88348b3ed0aSMarc-André Lureau@item sasl 88448b3ed0aSMarc-André LureauRequire that the client use SASL to authenticate with the spice. 88548b3ed0aSMarc-André LureauThe exact choice of authentication method used is controlled from the 88648b3ed0aSMarc-André Lureausystem / user's SASL configuration file for the 'qemu' service. This 88748b3ed0aSMarc-André Lureauis typically found in /etc/sasl2/qemu.conf. If running QEMU as an 88848b3ed0aSMarc-André Lureauunprivileged user, an environment variable SASL_CONF_PATH can be used 88948b3ed0aSMarc-André Lureauto make it search alternate locations for the service config. 89048b3ed0aSMarc-André LureauWhile some SASL auth methods can also provide data encryption (eg GSSAPI), 89148b3ed0aSMarc-André Lureauit is recommended that SASL always be combined with the 'tls' and 89248b3ed0aSMarc-André Lureau'x509' settings to enable use of SSL and server certificates. This 89348b3ed0aSMarc-André Lureauensures a data encryption preventing compromise of authentication 89448b3ed0aSMarc-André Lureaucredentials. 89548b3ed0aSMarc-André Lureau 89629b0040bSGerd Hoffmann@item disable-ticketing 89729b0040bSGerd HoffmannAllow client connects without authentication. 89829b0040bSGerd Hoffmann 899d4970b07SHans de Goede@item disable-copy-paste 900d4970b07SHans de GoedeDisable copy paste between the client and the guest. 901d4970b07SHans de Goede 902c448e855SGerd Hoffmann@item tls-port=<nr> 903c448e855SGerd HoffmannSet the TCP port spice is listening on for encrypted channels. 904c448e855SGerd Hoffmann 905c448e855SGerd Hoffmann@item x509-dir=<dir> 906c448e855SGerd HoffmannSet the x509 file directory. Expects same filenames as -vnc $display,x509=$dir 907c448e855SGerd Hoffmann 908c448e855SGerd Hoffmann@item x509-key-file=<file> 909c448e855SGerd Hoffmann@item x509-key-password=<file> 910c448e855SGerd Hoffmann@item x509-cert-file=<file> 911c448e855SGerd Hoffmann@item x509-cacert-file=<file> 912c448e855SGerd Hoffmann@item x509-dh-key-file=<file> 913c448e855SGerd HoffmannThe x509 file names can also be configured individually. 914c448e855SGerd Hoffmann 915c448e855SGerd Hoffmann@item tls-ciphers=<list> 916c448e855SGerd HoffmannSpecify which ciphers to use. 917c448e855SGerd Hoffmann 918d70d6b31SAlon Levy@item tls-channel=[main|display|cursor|inputs|record|playback] 919d70d6b31SAlon Levy@item plaintext-channel=[main|display|cursor|inputs|record|playback] 92017b6dea0SGerd HoffmannForce specific channel to be used with or without TLS encryption. The 92117b6dea0SGerd Hoffmannoptions can be specified multiple times to configure multiple 92217b6dea0SGerd Hoffmannchannels. The special name "default" can be used to set the default 92317b6dea0SGerd Hoffmannmode. For channels which are not explicitly forced into one mode the 92417b6dea0SGerd Hoffmannspice client is allowed to pick tls/plaintext as he pleases. 92517b6dea0SGerd Hoffmann 9269f04e09eSYonit Halperin@item image-compression=[auto_glz|auto_lz|quic|glz|lz|off] 9279f04e09eSYonit HalperinConfigure image compression (lossless). 9289f04e09eSYonit HalperinDefault is auto_glz. 9299f04e09eSYonit Halperin 9309f04e09eSYonit Halperin@item jpeg-wan-compression=[auto|never|always] 9319f04e09eSYonit Halperin@item zlib-glz-wan-compression=[auto|never|always] 9329f04e09eSYonit HalperinConfigure wan image compression (lossy for slow links). 9339f04e09eSYonit HalperinDefault is auto. 9349f04e09eSYonit Halperin 93584a23f25SGerd Hoffmann@item streaming-video=[off|all|filter] 93684a23f25SGerd HoffmannConfigure video stream detection. Default is filter. 93784a23f25SGerd Hoffmann 93884a23f25SGerd Hoffmann@item agent-mouse=[on|off] 93984a23f25SGerd HoffmannEnable/disable passing mouse events via vdagent. Default is on. 94084a23f25SGerd Hoffmann 94184a23f25SGerd Hoffmann@item playback-compression=[on|off] 94284a23f25SGerd HoffmannEnable/disable audio stream compression (using celt 0.5.1). Default is on. 94384a23f25SGerd Hoffmann 9448c957053SYonit Halperin@item seamless-migration=[on|off] 9458c957053SYonit HalperinEnable/disable spice seamless migration. Default is off. 9468c957053SYonit Halperin 94729b0040bSGerd Hoffmann@end table 94829b0040bSGerd HoffmannETEXI 94929b0040bSGerd Hoffmann 9505824d651Sblueswir1DEF("portrait", 0, QEMU_OPTION_portrait, 951ad96090aSBlue Swirl "-portrait rotate graphical output 90 deg left (only PXA LCD)\n", 952ad96090aSBlue Swirl QEMU_ARCH_ALL) 9535824d651Sblueswir1STEXI 9545824d651Sblueswir1@item -portrait 9556616b2adSStefan Weil@findex -portrait 9565824d651Sblueswir1Rotate graphical output 90 deg left (only PXA LCD). 9575824d651Sblueswir1ETEXI 9585824d651Sblueswir1 9599312805dSVasily KhoruzhickDEF("rotate", HAS_ARG, QEMU_OPTION_rotate, 9609312805dSVasily Khoruzhick "-rotate <deg> rotate graphical output some deg left (only PXA LCD)\n", 9619312805dSVasily Khoruzhick QEMU_ARCH_ALL) 9629312805dSVasily KhoruzhickSTEXI 9639312805dSVasily Khoruzhick@item -rotate 9649312805dSVasily Khoruzhick@findex -rotate 9659312805dSVasily KhoruzhickRotate graphical output some deg left (only PXA LCD). 9669312805dSVasily KhoruzhickETEXI 9679312805dSVasily Khoruzhick 9685824d651Sblueswir1DEF("vga", HAS_ARG, QEMU_OPTION_vga, 969a19cbfb3SGerd Hoffmann "-vga [std|cirrus|vmware|qxl|xenfb|none]\n" 970ad96090aSBlue Swirl " select video card type\n", QEMU_ARCH_ALL) 9715824d651Sblueswir1STEXI 972e4558dcaSmalc@item -vga @var{type} 9736616b2adSStefan Weil@findex -vga 9745824d651Sblueswir1Select type of VGA card to emulate. Valid values for @var{type} are 975b3f046c2SKevin Wolf@table @option 9765824d651Sblueswir1@item cirrus 9775824d651Sblueswir1Cirrus Logic GD5446 Video card. All Windows versions starting from 9785824d651Sblueswir1Windows 95 should recognize and use this graphic card. For optimal 9795824d651Sblueswir1performances, use 16 bit color depth in the guest and the host OS. 9805824d651Sblueswir1(This one is the default) 9815824d651Sblueswir1@item std 9825824d651Sblueswir1Standard VGA card with Bochs VBE extensions. If your guest OS 9835824d651Sblueswir1supports the VESA 2.0 VBE extensions (e.g. Windows XP) and if you want 9845824d651Sblueswir1to use high resolution modes (>= 1280x1024x16) then you should use 9855824d651Sblueswir1this option. 9865824d651Sblueswir1@item vmware 9875824d651Sblueswir1VMWare SVGA-II compatible adapter. Use it if you have sufficiently 9885824d651Sblueswir1recent XFree86/XOrg server or Windows guest with a driver for this 9895824d651Sblueswir1card. 990a19cbfb3SGerd Hoffmann@item qxl 991a19cbfb3SGerd HoffmannQXL paravirtual graphic card. It is VGA compatible (including VESA 992a19cbfb3SGerd Hoffmann2.0 VBE support). Works best with qxl guest drivers installed though. 993a19cbfb3SGerd HoffmannRecommended choice when using the spice protocol. 9945824d651Sblueswir1@item none 9955824d651Sblueswir1Disable VGA card. 9965824d651Sblueswir1@end table 9975824d651Sblueswir1ETEXI 9985824d651Sblueswir1 9995824d651Sblueswir1DEF("full-screen", 0, QEMU_OPTION_full_screen, 1000ad96090aSBlue Swirl "-full-screen start in full screen\n", QEMU_ARCH_ALL) 10015824d651Sblueswir1STEXI 10025824d651Sblueswir1@item -full-screen 10036616b2adSStefan Weil@findex -full-screen 10045824d651Sblueswir1Start in full screen. 10055824d651Sblueswir1ETEXI 10065824d651Sblueswir1 10075824d651Sblueswir1DEF("g", 1, QEMU_OPTION_g , 1008ad96090aSBlue Swirl "-g WxH[xDEPTH] Set the initial graphical resolution and depth\n", 1009ad96090aSBlue Swirl QEMU_ARCH_PPC | QEMU_ARCH_SPARC) 10105824d651Sblueswir1STEXI 101195d5f08bSStefan Weil@item -g @var{width}x@var{height}[x@var{depth}] 10126616b2adSStefan Weil@findex -g 101395d5f08bSStefan WeilSet the initial graphical resolution and depth (PPC, SPARC only). 10145824d651Sblueswir1ETEXI 10155824d651Sblueswir1 10165824d651Sblueswir1DEF("vnc", HAS_ARG, QEMU_OPTION_vnc , 1017ad96090aSBlue Swirl "-vnc display start a VNC server on display\n", QEMU_ARCH_ALL) 10185824d651Sblueswir1STEXI 10195824d651Sblueswir1@item -vnc @var{display}[,@var{option}[,@var{option}[,...]]] 10206616b2adSStefan Weil@findex -vnc 10215824d651Sblueswir1Normally, QEMU uses SDL to display the VGA output. With this option, 10225824d651Sblueswir1you can have QEMU listen on VNC display @var{display} and redirect the VGA 10235824d651Sblueswir1display over the VNC session. It is very useful to enable the usb 10245824d651Sblueswir1tablet device when using this option (option @option{-usbdevice 10255824d651Sblueswir1tablet}). When using the VNC display, you must use the @option{-k} 10265824d651Sblueswir1parameter to set the keyboard layout if you are not using en-us. Valid 10275824d651Sblueswir1syntax for the @var{display} is 10285824d651Sblueswir1 1029b3f046c2SKevin Wolf@table @option 10305824d651Sblueswir1 10315824d651Sblueswir1@item @var{host}:@var{d} 10325824d651Sblueswir1 10335824d651Sblueswir1TCP connections will only be allowed from @var{host} on display @var{d}. 10345824d651Sblueswir1By convention the TCP port is 5900+@var{d}. Optionally, @var{host} can 10355824d651Sblueswir1be omitted in which case the server will accept connections from any host. 10365824d651Sblueswir1 10374e257e5eSKevin Wolf@item unix:@var{path} 10385824d651Sblueswir1 10395824d651Sblueswir1Connections will be allowed over UNIX domain sockets where @var{path} is the 10405824d651Sblueswir1location of a unix socket to listen for connections on. 10415824d651Sblueswir1 10425824d651Sblueswir1@item none 10435824d651Sblueswir1 10445824d651Sblueswir1VNC is initialized but not started. The monitor @code{change} command 10455824d651Sblueswir1can be used to later start the VNC server. 10465824d651Sblueswir1 10475824d651Sblueswir1@end table 10485824d651Sblueswir1 10495824d651Sblueswir1Following the @var{display} value there may be one or more @var{option} flags 10505824d651Sblueswir1separated by commas. Valid options are 10515824d651Sblueswir1 1052b3f046c2SKevin Wolf@table @option 10535824d651Sblueswir1 10545824d651Sblueswir1@item reverse 10555824d651Sblueswir1 10565824d651Sblueswir1Connect to a listening VNC client via a ``reverse'' connection. The 10575824d651Sblueswir1client is specified by the @var{display}. For reverse network 10585824d651Sblueswir1connections (@var{host}:@var{d},@code{reverse}), the @var{d} argument 10595824d651Sblueswir1is a TCP port number, not a display number. 10605824d651Sblueswir1 10615824d651Sblueswir1@item password 10625824d651Sblueswir1 10635824d651Sblueswir1Require that password based authentication is used for client connections. 106486ee5bc3SMichal Novotny 106586ee5bc3SMichal NovotnyThe password must be set separately using the @code{set_password} command in 106686ee5bc3SMichal Novotnythe @ref{pcsys_monitor}. The syntax to change your password is: 106786ee5bc3SMichal Novotny@code{set_password <protocol> <password>} where <protocol> could be either 106886ee5bc3SMichal Novotny"vnc" or "spice". 106986ee5bc3SMichal Novotny 107086ee5bc3SMichal NovotnyIf you would like to change <protocol> password expiration, you should use 107186ee5bc3SMichal Novotny@code{expire_password <protocol> <expiration-time>} where expiration time could 107286ee5bc3SMichal Novotnybe one of the following options: now, never, +seconds or UNIX time of 107386ee5bc3SMichal Novotnyexpiration, e.g. +60 to make password expire in 60 seconds, or 1335196800 107486ee5bc3SMichal Novotnyto make password expire on "Mon Apr 23 12:00:00 EDT 2012" (UNIX time for this 107586ee5bc3SMichal Novotnydate and time). 107686ee5bc3SMichal Novotny 107786ee5bc3SMichal NovotnyYou can also use keywords "now" or "never" for the expiration time to 107886ee5bc3SMichal Novotnyallow <protocol> password to expire immediately or never expire. 10795824d651Sblueswir1 10805824d651Sblueswir1@item tls 10815824d651Sblueswir1 10825824d651Sblueswir1Require that client use TLS when communicating with the VNC server. This 10835824d651Sblueswir1uses anonymous TLS credentials so is susceptible to a man-in-the-middle 10845824d651Sblueswir1attack. It is recommended that this option be combined with either the 10854e257e5eSKevin Wolf@option{x509} or @option{x509verify} options. 10865824d651Sblueswir1 10875824d651Sblueswir1@item x509=@var{/path/to/certificate/dir} 10885824d651Sblueswir1 10895824d651Sblueswir1Valid if @option{tls} is specified. Require that x509 credentials are used 10905824d651Sblueswir1for negotiating the TLS session. The server will send its x509 certificate 10915824d651Sblueswir1to the client. It is recommended that a password be set on the VNC server 10925824d651Sblueswir1to provide authentication of the client when this is used. The path following 10935824d651Sblueswir1this option specifies where the x509 certificates are to be loaded from. 10945824d651Sblueswir1See the @ref{vnc_security} section for details on generating certificates. 10955824d651Sblueswir1 10965824d651Sblueswir1@item x509verify=@var{/path/to/certificate/dir} 10975824d651Sblueswir1 10985824d651Sblueswir1Valid if @option{tls} is specified. Require that x509 credentials are used 10995824d651Sblueswir1for negotiating the TLS session. The server will send its x509 certificate 11005824d651Sblueswir1to the client, and request that the client send its own x509 certificate. 11015824d651Sblueswir1The server will validate the client's certificate against the CA certificate, 11025824d651Sblueswir1and reject clients when validation fails. If the certificate authority is 11035824d651Sblueswir1trusted, this is a sufficient authentication mechanism. You may still wish 11045824d651Sblueswir1to set a password on the VNC server as a second authentication layer. The 11055824d651Sblueswir1path following this option specifies where the x509 certificates are to 11065824d651Sblueswir1be loaded from. See the @ref{vnc_security} section for details on generating 11075824d651Sblueswir1certificates. 11085824d651Sblueswir1 11095824d651Sblueswir1@item sasl 11105824d651Sblueswir1 11115824d651Sblueswir1Require that the client use SASL to authenticate with the VNC server. 11125824d651Sblueswir1The exact choice of authentication method used is controlled from the 11135824d651Sblueswir1system / user's SASL configuration file for the 'qemu' service. This 11145824d651Sblueswir1is typically found in /etc/sasl2/qemu.conf. If running QEMU as an 11155824d651Sblueswir1unprivileged user, an environment variable SASL_CONF_PATH can be used 11165824d651Sblueswir1to make it search alternate locations for the service config. 11175824d651Sblueswir1While some SASL auth methods can also provide data encryption (eg GSSAPI), 11185824d651Sblueswir1it is recommended that SASL always be combined with the 'tls' and 11195824d651Sblueswir1'x509' settings to enable use of SSL and server certificates. This 11205824d651Sblueswir1ensures a data encryption preventing compromise of authentication 11215824d651Sblueswir1credentials. See the @ref{vnc_security} section for details on using 11225824d651Sblueswir1SASL authentication. 11235824d651Sblueswir1 11245824d651Sblueswir1@item acl 11255824d651Sblueswir1 11265824d651Sblueswir1Turn on access control lists for checking of the x509 client certificate 11275824d651Sblueswir1and SASL party. For x509 certs, the ACL check is made against the 11285824d651Sblueswir1certificate's distinguished name. This is something that looks like 11295824d651Sblueswir1@code{C=GB,O=ACME,L=Boston,CN=bob}. For SASL party, the ACL check is 11305824d651Sblueswir1made against the username, which depending on the SASL plugin, may 11315824d651Sblueswir1include a realm component, eg @code{bob} or @code{bob@@EXAMPLE.COM}. 11325824d651Sblueswir1When the @option{acl} flag is set, the initial access list will be 11335824d651Sblueswir1empty, with a @code{deny} policy. Thus no one will be allowed to 11345824d651Sblueswir1use the VNC server until the ACLs have been loaded. This can be 11355824d651Sblueswir1achieved using the @code{acl} monitor command. 11365824d651Sblueswir1 11376f9c78c1SCorentin Chary@item lossy 11386f9c78c1SCorentin Chary 11396f9c78c1SCorentin CharyEnable lossy compression methods (gradient, JPEG, ...). If this 11406f9c78c1SCorentin Charyoption is set, VNC client may receive lossy framebuffer updates 11416f9c78c1SCorentin Charydepending on its encoding settings. Enabling this option can save 11426f9c78c1SCorentin Charya lot of bandwidth at the expense of quality. 11436f9c78c1SCorentin Chary 114480e0c8c3SCorentin Chary@item non-adaptive 114580e0c8c3SCorentin Chary 114680e0c8c3SCorentin CharyDisable adaptive encodings. Adaptive encodings are enabled by default. 114780e0c8c3SCorentin CharyAn adaptive encoding will try to detect frequently updated screen regions, 114880e0c8c3SCorentin Charyand send updates in these regions using a lossy encoding (like JPEG). 114961cc8701SStefan WeilThis can be really helpful to save bandwidth when playing videos. Disabling 115061cc8701SStefan Weiladaptive encodings allows to restore the original static behavior of encodings 115180e0c8c3SCorentin Charylike Tight. 115280e0c8c3SCorentin Chary 11538cf36489SGerd Hoffmann@item share=[allow-exclusive|force-shared|ignore] 11548cf36489SGerd Hoffmann 11558cf36489SGerd HoffmannSet display sharing policy. 'allow-exclusive' allows clients to ask 11568cf36489SGerd Hoffmannfor exclusive access. As suggested by the rfb spec this is 11578cf36489SGerd Hoffmannimplemented by dropping other connections. Connecting multiple 11588cf36489SGerd Hoffmannclients in parallel requires all clients asking for a shared session 11598cf36489SGerd Hoffmann(vncviewer: -shared switch). This is the default. 'force-shared' 11608cf36489SGerd Hoffmanndisables exclusive client access. Useful for shared desktop sessions, 11618cf36489SGerd Hoffmannwhere you don't want someone forgetting specify -shared disconnect 11628cf36489SGerd Hoffmanneverybody else. 'ignore' completely ignores the shared flag and 11638cf36489SGerd Hoffmannallows everybody connect unconditionally. Doesn't conform to the rfb 1164b65ee4faSStefan Weilspec but is traditional QEMU behavior. 11658cf36489SGerd Hoffmann 11665824d651Sblueswir1@end table 11675824d651Sblueswir1ETEXI 11685824d651Sblueswir1 11695824d651Sblueswir1STEXI 11705824d651Sblueswir1@end table 11715824d651Sblueswir1ETEXI 11725824d651Sblueswir1 1173a3adb7adSMichael EllermanARCHHEADING(, QEMU_ARCH_I386) 11745824d651Sblueswir1 1175a3adb7adSMichael EllermanARCHHEADING(i386 target only:, QEMU_ARCH_I386) 11765824d651Sblueswir1STEXI 11775824d651Sblueswir1@table @option 11785824d651Sblueswir1ETEXI 11795824d651Sblueswir1 11805824d651Sblueswir1DEF("win2k-hack", 0, QEMU_OPTION_win2k_hack, 1181ad96090aSBlue Swirl "-win2k-hack use it when installing Windows 2000 to avoid a disk full bug\n", 1182ad96090aSBlue Swirl QEMU_ARCH_I386) 11835824d651Sblueswir1STEXI 11845824d651Sblueswir1@item -win2k-hack 11856616b2adSStefan Weil@findex -win2k-hack 11865824d651Sblueswir1Use it when installing Windows 2000 to avoid a disk full bug. After 11875824d651Sblueswir1Windows 2000 is installed, you no longer need this option (this option 11885824d651Sblueswir1slows down the IDE transfers). 11895824d651Sblueswir1ETEXI 11905824d651Sblueswir1 11911ed2fc1fSJan KiszkaHXCOMM Deprecated by -rtc 1192ad96090aSBlue SwirlDEF("rtc-td-hack", 0, QEMU_OPTION_rtc_td_hack, "", QEMU_ARCH_I386) 11935824d651Sblueswir1 11945824d651Sblueswir1DEF("no-fd-bootchk", 0, QEMU_OPTION_no_fd_bootchk, 1195ad96090aSBlue Swirl "-no-fd-bootchk disable boot signature checking for floppy disks\n", 1196ad96090aSBlue Swirl QEMU_ARCH_I386) 11975824d651Sblueswir1STEXI 11985824d651Sblueswir1@item -no-fd-bootchk 11996616b2adSStefan Weil@findex -no-fd-bootchk 12005824d651Sblueswir1Disable boot signature checking for floppy disks in Bochs BIOS. It may 12015824d651Sblueswir1be needed to boot from old floppy disks. 12026616b2adSStefan WeilTODO: check reference to Bochs BIOS. 12035824d651Sblueswir1ETEXI 12045824d651Sblueswir1 12055824d651Sblueswir1DEF("no-acpi", 0, QEMU_OPTION_no_acpi, 1206ad96090aSBlue Swirl "-no-acpi disable ACPI\n", QEMU_ARCH_I386) 12075824d651Sblueswir1STEXI 12085824d651Sblueswir1@item -no-acpi 12096616b2adSStefan Weil@findex -no-acpi 12105824d651Sblueswir1Disable ACPI (Advanced Configuration and Power Interface) support. Use 12115824d651Sblueswir1it if your guest OS complains about ACPI problems (PC target machine 12125824d651Sblueswir1only). 12135824d651Sblueswir1ETEXI 12145824d651Sblueswir1 12155824d651Sblueswir1DEF("no-hpet", 0, QEMU_OPTION_no_hpet, 1216ad96090aSBlue Swirl "-no-hpet disable HPET\n", QEMU_ARCH_I386) 12175824d651Sblueswir1STEXI 12185824d651Sblueswir1@item -no-hpet 12196616b2adSStefan Weil@findex -no-hpet 12205824d651Sblueswir1Disable HPET support. 12215824d651Sblueswir1ETEXI 12225824d651Sblueswir1 12235824d651Sblueswir1DEF("acpitable", HAS_ARG, QEMU_OPTION_acpitable, 1224104bf02eSMichael 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" 1225ad96090aSBlue Swirl " ACPI table description\n", QEMU_ARCH_I386) 12265824d651Sblueswir1STEXI 12275824d651Sblueswir1@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}]...] 12286616b2adSStefan Weil@findex -acpitable 12295824d651Sblueswir1Add ACPI table with specified header fields and context from specified files. 1230104bf02eSMichael TokarevFor file=, take whole ACPI table from the specified files, including all 1231104bf02eSMichael TokarevACPI headers (possible overridden by other options). 1232104bf02eSMichael TokarevFor data=, only data 1233104bf02eSMichael Tokarevportion of the table is used, all header information is specified in the 1234104bf02eSMichael Tokarevcommand line. 12355824d651Sblueswir1ETEXI 12365824d651Sblueswir1 1237b6f6e3d3SaliguoriDEF("smbios", HAS_ARG, QEMU_OPTION_smbios, 1238b6f6e3d3Saliguori "-smbios file=binary\n" 1239ca1a8a06SBruce Rogers " load SMBIOS entry from binary file\n" 1240e8105ebbSPaolo Bonzini "-smbios type=0[,vendor=str][,version=str][,date=str][,release=%d.%d]\n" 1241ca1a8a06SBruce Rogers " specify SMBIOS type 0 fields\n" 1242b6f6e3d3Saliguori "-smbios type=1[,manufacturer=str][,product=str][,version=str][,serial=str]\n" 1243b6f6e3d3Saliguori " [,uuid=uuid][,sku=str][,family=str]\n" 1244ad96090aSBlue Swirl " specify SMBIOS type 1 fields\n", QEMU_ARCH_I386) 1245b6f6e3d3SaliguoriSTEXI 1246b6f6e3d3Saliguori@item -smbios file=@var{binary} 12476616b2adSStefan Weil@findex -smbios 1248b6f6e3d3SaliguoriLoad SMBIOS entry from binary file. 1249b6f6e3d3Saliguori 1250b6f6e3d3Saliguori@item -smbios type=0[,vendor=@var{str}][,version=@var{str}][,date=@var{str}][,release=@var{%d.%d}] 12516616b2adSStefan Weil@findex -smbios 1252b6f6e3d3SaliguoriSpecify SMBIOS type 0 fields 1253b6f6e3d3Saliguori 1254b6f6e3d3Saliguori@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}] 1255b6f6e3d3SaliguoriSpecify SMBIOS type 1 fields 1256b6f6e3d3SaliguoriETEXI 1257b6f6e3d3Saliguori 12585824d651Sblueswir1DEFHEADING() 12595824d651Sblueswir1STEXI 12605824d651Sblueswir1@end table 12615824d651Sblueswir1ETEXI 12625824d651Sblueswir1 12635824d651Sblueswir1DEFHEADING(Network options:) 12645824d651Sblueswir1STEXI 12655824d651Sblueswir1@table @option 12665824d651Sblueswir1ETEXI 12675824d651Sblueswir1 1268ad196a9dSJan KiszkaHXCOMM Legacy slirp options (now moved to -net user): 1269ad196a9dSJan Kiszka#ifdef CONFIG_SLIRP 1270ad96090aSBlue SwirlDEF("tftp", HAS_ARG, QEMU_OPTION_tftp, "", QEMU_ARCH_ALL) 1271ad96090aSBlue SwirlDEF("bootp", HAS_ARG, QEMU_OPTION_bootp, "", QEMU_ARCH_ALL) 1272ad96090aSBlue SwirlDEF("redir", HAS_ARG, QEMU_OPTION_redir, "", QEMU_ARCH_ALL) 1273ad196a9dSJan Kiszka#ifndef _WIN32 1274ad96090aSBlue SwirlDEF("smb", HAS_ARG, QEMU_OPTION_smb, "", QEMU_ARCH_ALL) 1275ad196a9dSJan Kiszka#endif 1276ad196a9dSJan Kiszka#endif 1277ad196a9dSJan Kiszka 1278bab7944cSBlue SwirlDEF("net", HAS_ARG, QEMU_OPTION_net, 1279ffe6370cSMichael S. Tsirkin "-net nic[,vlan=n][,macaddr=mac][,model=type][,name=str][,addr=str][,vectors=v]\n" 12805824d651Sblueswir1 " create a new Network Interface Card and connect it to VLAN 'n'\n" 12815824d651Sblueswir1#ifdef CONFIG_SLIRP 1282c54ed5bcSJan Kiszka "-net user[,vlan=n][,name=str][,net=addr[/mask]][,host=addr][,restrict=on|off]\n" 1283c92ef6a2SJan Kiszka " [,hostname=host][,dhcpstart=addr][,dns=addr][,tftp=dir][,bootfile=f]\n" 1284c92ef6a2SJan Kiszka " [,hostfwd=rule][,guestfwd=rule]" 1285ad196a9dSJan Kiszka#ifndef _WIN32 1286c92ef6a2SJan Kiszka "[,smb=dir[,smbserver=addr]]\n" 1287ad196a9dSJan Kiszka#endif 1288ad196a9dSJan Kiszka " connect the user mode network stack to VLAN 'n', configure its\n" 1289ad196a9dSJan Kiszka " DHCP server and enabled optional services\n" 12905824d651Sblueswir1#endif 12915824d651Sblueswir1#ifdef _WIN32 12925824d651Sblueswir1 "-net tap[,vlan=n][,name=str],ifname=name\n" 12935824d651Sblueswir1 " connect the host TAP network interface to VLAN 'n'\n" 12945824d651Sblueswir1#else 1295a7c36ee4SCorey Bryant "-net tap[,vlan=n][,name=str][,fd=h][,ifname=name][,script=file][,downscript=dfile][,helper=helper][,sndbuf=nbytes][,vnet_hdr=on|off][,vhost=on|off][,vhostfd=h][,vhostforce=on|off]\n" 1296a7c36ee4SCorey Bryant " connect the host TAP network interface to VLAN 'n' \n" 1297a7c36ee4SCorey Bryant " use network scripts 'file' (default=" DEFAULT_NETWORK_SCRIPT ")\n" 1298a7c36ee4SCorey Bryant " to configure it and 'dfile' (default=" DEFAULT_NETWORK_DOWN_SCRIPT ")\n" 1299a7c36ee4SCorey Bryant " to deconfigure it\n" 1300ca1a8a06SBruce Rogers " use '[down]script=no' to disable script execution\n" 1301a7c36ee4SCorey Bryant " use network helper 'helper' (default=" DEFAULT_BRIDGE_HELPER ") to\n" 1302a7c36ee4SCorey Bryant " configure it\n" 13035824d651Sblueswir1 " use 'fd=h' to connect to an already opened TAP interface\n" 1304ca1a8a06SBruce Rogers " use 'sndbuf=nbytes' to limit the size of the send buffer (the\n" 1305f157ed20SMichael S. Tsirkin " default is disabled 'sndbuf=0' to enable flow control set 'sndbuf=1048576')\n" 1306ca1a8a06SBruce Rogers " use vnet_hdr=off to avoid enabling the IFF_VNET_HDR tap flag\n" 1307ca1a8a06SBruce Rogers " use vnet_hdr=on to make the lack of IFF_VNET_HDR support an error condition\n" 130882b0d80eSMichael S. Tsirkin " use vhost=on to enable experimental in kernel accelerator\n" 13095430a28fSmst@redhat.com " (only has effect for virtio guests which use MSIX)\n" 13105430a28fSmst@redhat.com " use vhostforce=on to force vhost on for non-MSIX virtio guests\n" 131182b0d80eSMichael S. Tsirkin " use 'vhostfd=h' to connect to an already opened vhost net device\n" 1312a7c36ee4SCorey Bryant "-net bridge[,vlan=n][,name=str][,br=bridge][,helper=helper]\n" 1313a7c36ee4SCorey Bryant " connects a host TAP network interface to a host bridge device 'br'\n" 1314a7c36ee4SCorey Bryant " (default=" DEFAULT_BRIDGE_INTERFACE ") using the program 'helper'\n" 1315a7c36ee4SCorey Bryant " (default=" DEFAULT_BRIDGE_HELPER ")\n" 13160df0ff6dSMark McLoughlin#endif 13175824d651Sblueswir1 "-net socket[,vlan=n][,name=str][,fd=h][,listen=[host]:port][,connect=host:port]\n" 13185824d651Sblueswir1 " connect the vlan 'n' to another VLAN using a socket connection\n" 13193a75e74cSMike Ryan "-net socket[,vlan=n][,name=str][,fd=h][,mcast=maddr:port[,localaddr=addr]]\n" 13205824d651Sblueswir1 " connect the vlan 'n' to multicast maddr and port\n" 13213a75e74cSMike Ryan " use 'localaddr=addr' to specify the host address to send packets from\n" 13220e0e7facSBenjamin "-net socket[,vlan=n][,name=str][,fd=h][,udp=host:port][,localaddr=host:port]\n" 13230e0e7facSBenjamin " connect the vlan 'n' to another VLAN using an UDP tunnel\n" 13245824d651Sblueswir1#ifdef CONFIG_VDE 13255824d651Sblueswir1 "-net vde[,vlan=n][,name=str][,sock=socketpath][,port=n][,group=groupname][,mode=octalmode]\n" 13265824d651Sblueswir1 " connect the vlan 'n' to port 'n' of a vde switch running\n" 13275824d651Sblueswir1 " on host and listening for incoming connections on 'socketpath'.\n" 13285824d651Sblueswir1 " Use group 'groupname' and mode 'octalmode' to change default\n" 13295824d651Sblueswir1 " ownership and permissions for communication port.\n" 13305824d651Sblueswir1#endif 1331bb9ea79eSaliguori "-net dump[,vlan=n][,file=f][,len=n]\n" 1332bb9ea79eSaliguori " dump traffic on vlan 'n' to file 'f' (max n bytes per packet)\n" 1333ca1a8a06SBruce Rogers "-net none use it alone to have zero network devices. If no -net option\n" 1334ad96090aSBlue Swirl " is provided, the default is '-net nic -net user'\n", QEMU_ARCH_ALL) 1335a1ea458fSMark McLoughlinDEF("netdev", HAS_ARG, QEMU_OPTION_netdev, 1336a1ea458fSMark McLoughlin "-netdev [" 1337a1ea458fSMark McLoughlin#ifdef CONFIG_SLIRP 1338a1ea458fSMark McLoughlin "user|" 1339a1ea458fSMark McLoughlin#endif 1340a1ea458fSMark McLoughlin "tap|" 1341a7c36ee4SCorey Bryant "bridge|" 1342a1ea458fSMark McLoughlin#ifdef CONFIG_VDE 1343a1ea458fSMark McLoughlin "vde|" 1344a1ea458fSMark McLoughlin#endif 1345ad96090aSBlue Swirl "socket],id=str[,option][,option][,...]\n", QEMU_ARCH_ALL) 13465824d651Sblueswir1STEXI 1347ffe6370cSMichael S. Tsirkin@item -net nic[,vlan=@var{n}][,macaddr=@var{mac}][,model=@var{type}] [,name=@var{name}][,addr=@var{addr}][,vectors=@var{v}] 13486616b2adSStefan Weil@findex -net 13495824d651Sblueswir1Create a new Network Interface Card and connect it to VLAN @var{n} (@var{n} 13500d6b0b1dSAnthony Liguori= 0 is the default). The NIC is an e1000 by default on the PC 13515607c388SMarkus Armbrustertarget. Optionally, the MAC address can be changed to @var{mac}, the 13525607c388SMarkus Armbrusterdevice address set to @var{addr} (PCI cards only), 1353ffe6370cSMichael S. Tsirkinand a @var{name} can be assigned for use in monitor commands. 1354ffe6370cSMichael S. TsirkinOptionally, for PCI cards, you can specify the number @var{v} of MSI-X vectors 1355ffe6370cSMichael S. Tsirkinthat the card should have; this option currently only affects virtio cards; set 1356ffe6370cSMichael S. Tsirkin@var{v} = 0 to disable MSI-X. If no @option{-net} option is specified, a single 1357071c9394SStefan WeilNIC is created. QEMU can emulate several different models of network card. 13585824d651Sblueswir1Valid values for @var{type} are 1359ffe6370cSMichael S. Tsirkin@code{virtio}, @code{i82551}, @code{i82557b}, @code{i82559er}, 13605824d651Sblueswir1@code{ne2k_pci}, @code{ne2k_isa}, @code{pcnet}, @code{rtl8139}, 13615824d651Sblueswir1@code{e1000}, @code{smc91c111}, @code{lance} and @code{mcf_fec}. 13625824d651Sblueswir1Not all devices are supported on all targets. Use -net nic,model=? 13635824d651Sblueswir1for a list of available devices for your target. 13645824d651Sblueswir1 1365ad196a9dSJan Kiszka@item -net user[,@var{option}][,@var{option}][,...] 13665824d651Sblueswir1Use the user mode network stack which requires no administrator 1367ad196a9dSJan Kiszkaprivilege to run. Valid options are: 13685824d651Sblueswir1 1369b3f046c2SKevin Wolf@table @option 1370ad196a9dSJan Kiszka@item vlan=@var{n} 1371ad196a9dSJan KiszkaConnect user mode stack to VLAN @var{n} (@var{n} = 0 is the default). 1372ad196a9dSJan Kiszka 1373ad196a9dSJan Kiszka@item name=@var{name} 1374ad196a9dSJan KiszkaAssign symbolic name for use in monitor commands. 1375ad196a9dSJan Kiszka 1376c92ef6a2SJan Kiszka@item net=@var{addr}[/@var{mask}] 1377c92ef6a2SJan KiszkaSet IP network address the guest will see. Optionally specify the netmask, 1378c92ef6a2SJan Kiszkaeither in the form a.b.c.d or as number of valid top-most bits. Default is 1379b0b36e5dSBrad Hards10.0.2.0/24. 1380c92ef6a2SJan Kiszka 1381c92ef6a2SJan Kiszka@item host=@var{addr} 1382c92ef6a2SJan KiszkaSpecify the guest-visible address of the host. Default is the 2nd IP in the 1383c92ef6a2SJan Kiszkaguest network, i.e. x.x.x.2. 1384ad196a9dSJan Kiszka 1385c54ed5bcSJan Kiszka@item restrict=on|off 1386caef55edSBrad HardsIf this option is enabled, the guest will be isolated, i.e. it will not be 1387ad196a9dSJan Kiszkaable to contact the host and no guest IP packets will be routed over the host 1388caef55edSBrad Hardsto the outside. This option does not affect any explicitly set forwarding rules. 1389ad196a9dSJan Kiszka 1390ad196a9dSJan Kiszka@item hostname=@var{name} 1391ad196a9dSJan KiszkaSpecifies the client hostname reported by the builtin DHCP server. 1392ad196a9dSJan Kiszka 1393c92ef6a2SJan Kiszka@item dhcpstart=@var{addr} 1394c92ef6a2SJan KiszkaSpecify the first of the 16 IPs the built-in DHCP server can assign. Default 1395b0b36e5dSBrad Hardsis the 15th to 31st IP in the guest network, i.e. x.x.x.15 to x.x.x.31. 1396c92ef6a2SJan Kiszka 1397c92ef6a2SJan Kiszka@item dns=@var{addr} 1398c92ef6a2SJan KiszkaSpecify the guest-visible address of the virtual nameserver. The address must 1399c92ef6a2SJan Kiszkabe different from the host address. Default is the 3rd IP in the guest network, 1400c92ef6a2SJan Kiszkai.e. x.x.x.3. 1401c92ef6a2SJan Kiszka 1402ad196a9dSJan Kiszka@item tftp=@var{dir} 1403ad196a9dSJan KiszkaWhen using the user mode network stack, activate a built-in TFTP 1404ad196a9dSJan Kiszkaserver. The files in @var{dir} will be exposed as the root of a TFTP server. 1405ad196a9dSJan KiszkaThe TFTP client on the guest must be configured in binary mode (use the command 1406c92ef6a2SJan Kiszka@code{bin} of the Unix TFTP client). 1407ad196a9dSJan Kiszka 1408ad196a9dSJan Kiszka@item bootfile=@var{file} 1409ad196a9dSJan KiszkaWhen using the user mode network stack, broadcast @var{file} as the BOOTP 1410ad196a9dSJan Kiszkafilename. In conjunction with @option{tftp}, this can be used to network boot 1411ad196a9dSJan Kiszkaa guest from a local directory. 1412ad196a9dSJan Kiszka 1413ad196a9dSJan KiszkaExample (using pxelinux): 1414ad196a9dSJan Kiszka@example 14153804da9dSStefan Weilqemu-system-i386 -hda linux.img -boot n -net user,tftp=/path/to/tftp/files,bootfile=/pxelinux.0 1416ad196a9dSJan Kiszka@end example 1417ad196a9dSJan Kiszka 1418c92ef6a2SJan Kiszka@item smb=@var{dir}[,smbserver=@var{addr}] 1419ad196a9dSJan KiszkaWhen using the user mode network stack, activate a built-in SMB 1420ad196a9dSJan Kiszkaserver so that Windows OSes can access to the host files in @file{@var{dir}} 1421c92ef6a2SJan Kiszkatransparently. The IP address of the SMB server can be set to @var{addr}. By 1422c92ef6a2SJan Kiszkadefault the 4th IP in the guest network is used, i.e. x.x.x.4. 1423ad196a9dSJan Kiszka 1424ad196a9dSJan KiszkaIn the guest Windows OS, the line: 1425ad196a9dSJan Kiszka@example 1426ad196a9dSJan Kiszka10.0.2.4 smbserver 1427ad196a9dSJan Kiszka@end example 1428ad196a9dSJan Kiszkamust be added in the file @file{C:\WINDOWS\LMHOSTS} (for windows 9x/Me) 1429ad196a9dSJan Kiszkaor @file{C:\WINNT\SYSTEM32\DRIVERS\ETC\LMHOSTS} (Windows NT/2000). 1430ad196a9dSJan Kiszka 1431ad196a9dSJan KiszkaThen @file{@var{dir}} can be accessed in @file{\\smbserver\qemu}. 1432ad196a9dSJan Kiszka 1433e2d8830eSBradNote that a SAMBA server must be installed on the host OS. 1434e2d8830eSBradQEMU was tested successfully with smbd versions from Red Hat 9, 1435e2d8830eSBradFedora Core 3 and OpenSUSE 11.x. 1436ad196a9dSJan Kiszka 14373c6a0580SJan Kiszka@item hostfwd=[tcp|udp]:[@var{hostaddr}]:@var{hostport}-[@var{guestaddr}]:@var{guestport} 1438c92ef6a2SJan KiszkaRedirect incoming TCP or UDP connections to the host port @var{hostport} to 1439c92ef6a2SJan Kiszkathe guest IP address @var{guestaddr} on guest port @var{guestport}. If 1440c92ef6a2SJan Kiszka@var{guestaddr} is not specified, its value is x.x.x.15 (default first address 14413c6a0580SJan Kiszkagiven by the built-in DHCP server). By specifying @var{hostaddr}, the rule can 14423c6a0580SJan Kiszkabe bound to a specific host interface. If no connection type is set, TCP is 1443c92ef6a2SJan Kiszkaused. This option can be given multiple times. 1444ad196a9dSJan Kiszka 1445ad196a9dSJan KiszkaFor example, to redirect host X11 connection from screen 1 to guest 1446ad196a9dSJan Kiszkascreen 0, use the following: 1447ad196a9dSJan Kiszka 1448ad196a9dSJan Kiszka@example 1449ad196a9dSJan Kiszka# on the host 14503804da9dSStefan Weilqemu-system-i386 -net user,hostfwd=tcp:127.0.0.1:6001-:6000 [...] 1451ad196a9dSJan Kiszka# this host xterm should open in the guest X11 server 1452ad196a9dSJan Kiszkaxterm -display :1 1453ad196a9dSJan Kiszka@end example 1454ad196a9dSJan Kiszka 1455ad196a9dSJan KiszkaTo redirect telnet connections from host port 5555 to telnet port on 1456ad196a9dSJan Kiszkathe guest, use the following: 1457ad196a9dSJan Kiszka 1458ad196a9dSJan Kiszka@example 1459ad196a9dSJan Kiszka# on the host 14603804da9dSStefan Weilqemu-system-i386 -net user,hostfwd=tcp::5555-:23 [...] 1461ad196a9dSJan Kiszkatelnet localhost 5555 1462ad196a9dSJan Kiszka@end example 1463ad196a9dSJan Kiszka 1464ad196a9dSJan KiszkaThen when you use on the host @code{telnet localhost 5555}, you 1465ad196a9dSJan Kiszkaconnect to the guest telnet server. 1466ad196a9dSJan Kiszka 1467c92ef6a2SJan Kiszka@item guestfwd=[tcp]:@var{server}:@var{port}-@var{dev} 1468b412eb61SAlexander Graf@item guestfwd=[tcp]:@var{server}:@var{port}-@var{cmd:command} 14693c6a0580SJan KiszkaForward guest TCP connections to the IP address @var{server} on port @var{port} 1470b412eb61SAlexander Grafto the character device @var{dev} or to a program executed by @var{cmd:command} 1471b412eb61SAlexander Grafwhich gets spawned for each connection. This option can be given multiple times. 1472b412eb61SAlexander Graf 147343ffe61fSStefan WeilYou can either use a chardev directly and have that one used throughout QEMU's 1474b412eb61SAlexander Graflifetime, like in the following example: 1475b412eb61SAlexander Graf 1476b412eb61SAlexander Graf@example 1477b412eb61SAlexander Graf# open 10.10.1.1:4321 on bootup, connect 10.0.2.100:1234 to it whenever 1478b412eb61SAlexander Graf# the guest accesses it 1479b412eb61SAlexander Grafqemu -net user,guestfwd=tcp:10.0.2.100:1234-tcp:10.10.1.1:4321 [...] 1480b412eb61SAlexander Graf@end example 1481b412eb61SAlexander Graf 1482b412eb61SAlexander GrafOr you can execute a command on every TCP connection established by the guest, 148343ffe61fSStefan Weilso that QEMU behaves similar to an inetd process for that virtual server: 1484b412eb61SAlexander Graf 1485b412eb61SAlexander Graf@example 1486b412eb61SAlexander Graf# call "netcat 10.10.1.1 4321" on every TCP connection to 10.0.2.100:1234 1487b412eb61SAlexander Graf# and connect the TCP stream to its stdin/stdout 1488b412eb61SAlexander Grafqemu -net 'user,guestfwd=tcp:10.0.2.100:1234-cmd:netcat 10.10.1.1 4321' 1489b412eb61SAlexander Graf@end example 1490ad196a9dSJan Kiszka 1491ad196a9dSJan Kiszka@end table 1492ad196a9dSJan Kiszka 1493ad196a9dSJan KiszkaNote: Legacy stand-alone options -tftp, -bootp, -smb and -redir are still 1494ad196a9dSJan Kiszkaprocessed and applied to -net user. Mixing them with the new configuration 1495ad196a9dSJan Kiszkasyntax gives undefined results. Their use for new applications is discouraged 1496ad196a9dSJan Kiszkaas they will be removed from future versions. 14975824d651Sblueswir1 1498a7c36ee4SCorey Bryant@item -net tap[,vlan=@var{n}][,name=@var{name}][,fd=@var{h}][,ifname=@var{name}][,script=@var{file}][,downscript=@var{dfile}][,helper=@var{helper}] 1499a7c36ee4SCorey BryantConnect the host TAP network interface @var{name} to VLAN @var{n}. 1500a7c36ee4SCorey Bryant 1501a7c36ee4SCorey BryantUse the network script @var{file} to configure it and the network script 15025824d651Sblueswir1@var{dfile} to deconfigure it. If @var{name} is not provided, the OS 1503a7c36ee4SCorey Bryantautomatically provides one. The default network configure script is 1504a7c36ee4SCorey Bryant@file{/etc/qemu-ifup} and the default network deconfigure script is 1505a7c36ee4SCorey Bryant@file{/etc/qemu-ifdown}. Use @option{script=no} or @option{downscript=no} 1506a7c36ee4SCorey Bryantto disable script execution. 1507a7c36ee4SCorey Bryant 1508a7c36ee4SCorey BryantIf running QEMU as an unprivileged user, use the network helper 1509a7c36ee4SCorey Bryant@var{helper} to configure the TAP interface. The default network 1510a7c36ee4SCorey Bryanthelper executable is @file{/usr/local/libexec/qemu-bridge-helper}. 1511a7c36ee4SCorey Bryant 1512a7c36ee4SCorey Bryant@option{fd}=@var{h} can be used to specify the handle of an already 1513a7c36ee4SCorey Bryantopened host TAP interface. 1514a7c36ee4SCorey Bryant 1515a7c36ee4SCorey BryantExamples: 15165824d651Sblueswir1 15175824d651Sblueswir1@example 1518a7c36ee4SCorey Bryant#launch a QEMU instance with the default network script 15193804da9dSStefan Weilqemu-system-i386 linux.img -net nic -net tap 15205824d651Sblueswir1@end example 15215824d651Sblueswir1 15225824d651Sblueswir1@example 1523a7c36ee4SCorey Bryant#launch a QEMU instance with two NICs, each one connected 1524a7c36ee4SCorey Bryant#to a TAP device 15253804da9dSStefan Weilqemu-system-i386 linux.img \ 15263804da9dSStefan Weil -net nic,vlan=0 -net tap,vlan=0,ifname=tap0 \ 15275824d651Sblueswir1 -net nic,vlan=1 -net tap,vlan=1,ifname=tap1 15285824d651Sblueswir1@end example 15295824d651Sblueswir1 1530a7c36ee4SCorey Bryant@example 1531a7c36ee4SCorey Bryant#launch a QEMU instance with the default network helper to 1532a7c36ee4SCorey Bryant#connect a TAP device to bridge br0 15333804da9dSStefan Weilqemu-system-i386 linux.img \ 15343804da9dSStefan Weil -net nic -net tap,"helper=/usr/local/libexec/qemu-bridge-helper" 1535a7c36ee4SCorey Bryant@end example 1536a7c36ee4SCorey Bryant 1537a7c36ee4SCorey Bryant@item -net bridge[,vlan=@var{n}][,name=@var{name}][,br=@var{bridge}][,helper=@var{helper}] 1538a7c36ee4SCorey BryantConnect a host TAP network interface to a host bridge device. 1539a7c36ee4SCorey Bryant 1540a7c36ee4SCorey BryantUse the network helper @var{helper} to configure the TAP interface and 1541a7c36ee4SCorey Bryantattach it to the bridge. The default network helper executable is 1542a7c36ee4SCorey Bryant@file{/usr/local/libexec/qemu-bridge-helper} and the default bridge 1543a7c36ee4SCorey Bryantdevice is @file{br0}. 1544a7c36ee4SCorey Bryant 1545a7c36ee4SCorey BryantExamples: 1546a7c36ee4SCorey Bryant 1547a7c36ee4SCorey Bryant@example 1548a7c36ee4SCorey Bryant#launch a QEMU instance with the default network helper to 1549a7c36ee4SCorey Bryant#connect a TAP device to bridge br0 15503804da9dSStefan Weilqemu-system-i386 linux.img -net bridge -net nic,model=virtio 1551a7c36ee4SCorey Bryant@end example 1552a7c36ee4SCorey Bryant 1553a7c36ee4SCorey Bryant@example 1554a7c36ee4SCorey Bryant#launch a QEMU instance with the default network helper to 1555a7c36ee4SCorey Bryant#connect a TAP device to bridge qemubr0 15563804da9dSStefan Weilqemu-system-i386 linux.img -net bridge,br=qemubr0 -net nic,model=virtio 1557a7c36ee4SCorey Bryant@end example 1558a7c36ee4SCorey Bryant 15595824d651Sblueswir1@item -net socket[,vlan=@var{n}][,name=@var{name}][,fd=@var{h}] [,listen=[@var{host}]:@var{port}][,connect=@var{host}:@var{port}] 15605824d651Sblueswir1 15615824d651Sblueswir1Connect the VLAN @var{n} to a remote VLAN in another QEMU virtual 15625824d651Sblueswir1machine using a TCP socket connection. If @option{listen} is 15635824d651Sblueswir1specified, QEMU waits for incoming connections on @var{port} 15645824d651Sblueswir1(@var{host} is optional). @option{connect} is used to connect to 15655824d651Sblueswir1another QEMU instance using the @option{listen} option. @option{fd}=@var{h} 15665824d651Sblueswir1specifies an already opened TCP socket. 15675824d651Sblueswir1 15685824d651Sblueswir1Example: 15695824d651Sblueswir1@example 15705824d651Sblueswir1# launch a first QEMU instance 15713804da9dSStefan Weilqemu-system-i386 linux.img \ 15723804da9dSStefan Weil -net nic,macaddr=52:54:00:12:34:56 \ 15735824d651Sblueswir1 -net socket,listen=:1234 15745824d651Sblueswir1# connect the VLAN 0 of this instance to the VLAN 0 15755824d651Sblueswir1# of the first instance 15763804da9dSStefan Weilqemu-system-i386 linux.img \ 15773804da9dSStefan Weil -net nic,macaddr=52:54:00:12:34:57 \ 15785824d651Sblueswir1 -net socket,connect=127.0.0.1:1234 15795824d651Sblueswir1@end example 15805824d651Sblueswir1 15813a75e74cSMike Ryan@item -net socket[,vlan=@var{n}][,name=@var{name}][,fd=@var{h}][,mcast=@var{maddr}:@var{port}[,localaddr=@var{addr}]] 15825824d651Sblueswir1 15835824d651Sblueswir1Create a VLAN @var{n} shared with another QEMU virtual 15845824d651Sblueswir1machines using a UDP multicast socket, effectively making a bus for 15855824d651Sblueswir1every QEMU with same multicast address @var{maddr} and @var{port}. 15865824d651Sblueswir1NOTES: 15875824d651Sblueswir1@enumerate 15885824d651Sblueswir1@item 15895824d651Sblueswir1Several QEMU can be running on different hosts and share same bus (assuming 15905824d651Sblueswir1correct multicast setup for these hosts). 15915824d651Sblueswir1@item 15925824d651Sblueswir1mcast support is compatible with User Mode Linux (argument @option{eth@var{N}=mcast}), see 15935824d651Sblueswir1@url{http://user-mode-linux.sf.net}. 15945824d651Sblueswir1@item 15955824d651Sblueswir1Use @option{fd=h} to specify an already opened UDP multicast socket. 15965824d651Sblueswir1@end enumerate 15975824d651Sblueswir1 15985824d651Sblueswir1Example: 15995824d651Sblueswir1@example 16005824d651Sblueswir1# launch one QEMU instance 16013804da9dSStefan Weilqemu-system-i386 linux.img \ 16023804da9dSStefan Weil -net nic,macaddr=52:54:00:12:34:56 \ 16035824d651Sblueswir1 -net socket,mcast=230.0.0.1:1234 16045824d651Sblueswir1# launch another QEMU instance on same "bus" 16053804da9dSStefan Weilqemu-system-i386 linux.img \ 16063804da9dSStefan Weil -net nic,macaddr=52:54:00:12:34:57 \ 16075824d651Sblueswir1 -net socket,mcast=230.0.0.1:1234 16085824d651Sblueswir1# launch yet another QEMU instance on same "bus" 16093804da9dSStefan Weilqemu-system-i386 linux.img \ 16103804da9dSStefan Weil -net nic,macaddr=52:54:00:12:34:58 \ 16115824d651Sblueswir1 -net socket,mcast=230.0.0.1:1234 16125824d651Sblueswir1@end example 16135824d651Sblueswir1 16145824d651Sblueswir1Example (User Mode Linux compat.): 16155824d651Sblueswir1@example 16165824d651Sblueswir1# launch QEMU instance (note mcast address selected 16175824d651Sblueswir1# is UML's default) 16183804da9dSStefan Weilqemu-system-i386 linux.img \ 16193804da9dSStefan Weil -net nic,macaddr=52:54:00:12:34:56 \ 16205824d651Sblueswir1 -net socket,mcast=239.192.168.1:1102 16215824d651Sblueswir1# launch UML 16225824d651Sblueswir1/path/to/linux ubd0=/path/to/root_fs eth0=mcast 16235824d651Sblueswir1@end example 16245824d651Sblueswir1 16253a75e74cSMike RyanExample (send packets from host's 1.2.3.4): 16263a75e74cSMike Ryan@example 16273804da9dSStefan Weilqemu-system-i386 linux.img \ 16283804da9dSStefan Weil -net nic,macaddr=52:54:00:12:34:56 \ 16293a75e74cSMike Ryan -net socket,mcast=239.192.168.1:1102,localaddr=1.2.3.4 16303a75e74cSMike Ryan@end example 16313a75e74cSMike Ryan 16325824d651Sblueswir1@item -net vde[,vlan=@var{n}][,name=@var{name}][,sock=@var{socketpath}] [,port=@var{n}][,group=@var{groupname}][,mode=@var{octalmode}] 16335824d651Sblueswir1Connect VLAN @var{n} to PORT @var{n} of a vde switch running on host and 16345824d651Sblueswir1listening for incoming connections on @var{socketpath}. Use GROUP @var{groupname} 16355824d651Sblueswir1and MODE @var{octalmode} to change default ownership and permissions for 1636c1ba4e0bSStefan Weilcommunication port. This option is only available if QEMU has been compiled 16375824d651Sblueswir1with vde support enabled. 16385824d651Sblueswir1 16395824d651Sblueswir1Example: 16405824d651Sblueswir1@example 16415824d651Sblueswir1# launch vde switch 16425824d651Sblueswir1vde_switch -F -sock /tmp/myswitch 16435824d651Sblueswir1# launch QEMU instance 16443804da9dSStefan Weilqemu-system-i386 linux.img -net nic -net vde,sock=/tmp/myswitch 16455824d651Sblueswir1@end example 16465824d651Sblueswir1 1647bb9ea79eSaliguori@item -net dump[,vlan=@var{n}][,file=@var{file}][,len=@var{len}] 1648bb9ea79eSaliguoriDump network traffic on VLAN @var{n} to file @var{file} (@file{qemu-vlan0.pcap} by default). 1649bb9ea79eSaliguoriAt most @var{len} bytes (64k by default) per packet are stored. The file format is 1650bb9ea79eSaliguorilibpcap, so it can be analyzed with tools such as tcpdump or Wireshark. 1651bb9ea79eSaliguori 16525824d651Sblueswir1@item -net none 16535824d651Sblueswir1Indicate that no network devices should be configured. It is used to 16545824d651Sblueswir1override the default configuration (@option{-net nic -net user}) which 16555824d651Sblueswir1is activated if no @option{-net} options are provided. 16565824d651Sblueswir1 16575824d651Sblueswir1@end table 16585824d651Sblueswir1ETEXI 16595824d651Sblueswir1 16607273a2dbSMatthew BoothDEFHEADING() 16617273a2dbSMatthew Booth 16627273a2dbSMatthew BoothDEFHEADING(Character device options:) 16637273a2dbSMatthew Booth 16647273a2dbSMatthew BoothDEF("chardev", HAS_ARG, QEMU_OPTION_chardev, 166597331287SJan Kiszka "-chardev null,id=id[,mux=on|off]\n" 16667273a2dbSMatthew Booth "-chardev socket,id=id[,host=host],port=host[,to=to][,ipv4][,ipv6][,nodelay]\n" 166797331287SJan Kiszka " [,server][,nowait][,telnet][,mux=on|off] (tcp)\n" 166897331287SJan Kiszka "-chardev socket,id=id,path=path[,server][,nowait][,telnet],[mux=on|off] (unix)\n" 16697273a2dbSMatthew Booth "-chardev udp,id=id[,host=host],port=port[,localaddr=localaddr]\n" 167097331287SJan Kiszka " [,localport=localport][,ipv4][,ipv6][,mux=on|off]\n" 167197331287SJan Kiszka "-chardev msmouse,id=id[,mux=on|off]\n" 16727273a2dbSMatthew Booth "-chardev vc,id=id[[,width=width][,height=height]][[,cols=cols][,rows=rows]]\n" 167397331287SJan Kiszka " [,mux=on|off]\n" 167497331287SJan Kiszka "-chardev file,id=id,path=path[,mux=on|off]\n" 167597331287SJan Kiszka "-chardev pipe,id=id,path=path[,mux=on|off]\n" 16767273a2dbSMatthew Booth#ifdef _WIN32 167797331287SJan Kiszka "-chardev console,id=id[,mux=on|off]\n" 167897331287SJan Kiszka "-chardev serial,id=id,path=path[,mux=on|off]\n" 16797273a2dbSMatthew Booth#else 168097331287SJan Kiszka "-chardev pty,id=id[,mux=on|off]\n" 1681b7fdb3abSAurelien Jarno "-chardev stdio,id=id[,mux=on|off][,signal=on|off]\n" 16827273a2dbSMatthew Booth#endif 16837273a2dbSMatthew Booth#ifdef CONFIG_BRLAPI 168497331287SJan Kiszka "-chardev braille,id=id[,mux=on|off]\n" 16857273a2dbSMatthew Booth#endif 16867273a2dbSMatthew Booth#if defined(__linux__) || defined(__sun__) || defined(__FreeBSD__) \ 16877273a2dbSMatthew Booth || defined(__NetBSD__) || defined(__OpenBSD__) || defined(__DragonFly__) 168897331287SJan Kiszka "-chardev tty,id=id,path=path[,mux=on|off]\n" 16897273a2dbSMatthew Booth#endif 16907273a2dbSMatthew Booth#if defined(__linux__) || defined(__FreeBSD__) || defined(__DragonFly__) 169197331287SJan Kiszka "-chardev parport,id=id,path=path[,mux=on|off]\n" 16927273a2dbSMatthew Booth#endif 1693cbcc6336SAlon Levy#if defined(CONFIG_SPICE) 1694cbcc6336SAlon Levy "-chardev spicevmc,id=id,name=name[,debug=debug]\n" 1695cbcc6336SAlon Levy#endif 1696ad96090aSBlue Swirl , QEMU_ARCH_ALL 16977273a2dbSMatthew Booth) 16987273a2dbSMatthew Booth 16997273a2dbSMatthew BoothSTEXI 17007273a2dbSMatthew Booth 17017273a2dbSMatthew BoothThe general form of a character device option is: 17027273a2dbSMatthew Booth@table @option 17037273a2dbSMatthew Booth 170497331287SJan Kiszka@item -chardev @var{backend} ,id=@var{id} [,mux=on|off] [,@var{options}] 17056616b2adSStefan Weil@findex -chardev 17067273a2dbSMatthew BoothBackend is one of: 17077273a2dbSMatthew Booth@option{null}, 17087273a2dbSMatthew Booth@option{socket}, 17097273a2dbSMatthew Booth@option{udp}, 17107273a2dbSMatthew Booth@option{msmouse}, 17117273a2dbSMatthew Booth@option{vc}, 17127273a2dbSMatthew Booth@option{file}, 17137273a2dbSMatthew Booth@option{pipe}, 17147273a2dbSMatthew Booth@option{console}, 17157273a2dbSMatthew Booth@option{serial}, 17167273a2dbSMatthew Booth@option{pty}, 17177273a2dbSMatthew Booth@option{stdio}, 17187273a2dbSMatthew Booth@option{braille}, 17197273a2dbSMatthew Booth@option{tty}, 1720cbcc6336SAlon Levy@option{parport}, 1721cbcc6336SAlon Levy@option{spicevmc}. 17227273a2dbSMatthew BoothThe specific backend will determine the applicable options. 17237273a2dbSMatthew Booth 17247273a2dbSMatthew BoothAll devices must have an id, which can be any string up to 127 characters long. 17257273a2dbSMatthew BoothIt is used to uniquely identify this device in other command line directives. 17267273a2dbSMatthew Booth 172797331287SJan KiszkaA character device may be used in multiplexing mode by multiple front-ends. 172897331287SJan KiszkaThe key sequence of @key{Control-a} and @key{c} will rotate the input focus 172997331287SJan Kiszkabetween attached front-ends. Specify @option{mux=on} to enable this mode. 173097331287SJan Kiszka 17317273a2dbSMatthew BoothOptions to each backend are described below. 17327273a2dbSMatthew Booth 17337273a2dbSMatthew Booth@item -chardev null ,id=@var{id} 17347273a2dbSMatthew BoothA void device. This device will not emit any data, and will drop any data it 17357273a2dbSMatthew Boothreceives. The null backend does not take any options. 17367273a2dbSMatthew Booth 17377273a2dbSMatthew Booth@item -chardev socket ,id=@var{id} [@var{TCP options} or @var{unix options}] [,server] [,nowait] [,telnet] 17387273a2dbSMatthew Booth 17397273a2dbSMatthew BoothCreate a two-way stream socket, which can be either a TCP or a unix socket. A 17407273a2dbSMatthew Boothunix socket will be created if @option{path} is specified. Behaviour is 17417273a2dbSMatthew Boothundefined if TCP options are specified for a unix socket. 17427273a2dbSMatthew Booth 17437273a2dbSMatthew Booth@option{server} specifies that the socket shall be a listening socket. 17447273a2dbSMatthew Booth 17457273a2dbSMatthew Booth@option{nowait} specifies that QEMU should not block waiting for a client to 17467273a2dbSMatthew Boothconnect to a listening socket. 17477273a2dbSMatthew Booth 17487273a2dbSMatthew Booth@option{telnet} specifies that traffic on the socket should interpret telnet 17497273a2dbSMatthew Boothescape sequences. 17507273a2dbSMatthew Booth 17517273a2dbSMatthew BoothTCP and unix socket options are given below: 17527273a2dbSMatthew Booth 17537273a2dbSMatthew Booth@table @option 17547273a2dbSMatthew Booth 17558d533561SAurelien Jarno@item TCP options: port=@var{port} [,host=@var{host}] [,to=@var{to}] [,ipv4] [,ipv6] [,nodelay] 17567273a2dbSMatthew Booth 17577273a2dbSMatthew Booth@option{host} for a listening socket specifies the local address to be bound. 17587273a2dbSMatthew BoothFor a connecting socket species the remote host to connect to. @option{host} is 17597273a2dbSMatthew Boothoptional for listening sockets. If not specified it defaults to @code{0.0.0.0}. 17607273a2dbSMatthew Booth 17617273a2dbSMatthew Booth@option{port} for a listening socket specifies the local port to be bound. For a 17627273a2dbSMatthew Boothconnecting socket specifies the port on the remote host to connect to. 17637273a2dbSMatthew Booth@option{port} can be given as either a port number or a service name. 17647273a2dbSMatthew Booth@option{port} is required. 17657273a2dbSMatthew Booth 17667273a2dbSMatthew Booth@option{to} is only relevant to listening sockets. If it is specified, and 17677273a2dbSMatthew Booth@option{port} cannot be bound, QEMU will attempt to bind to subsequent ports up 17687273a2dbSMatthew Boothto and including @option{to} until it succeeds. @option{to} must be specified 17697273a2dbSMatthew Boothas a port number. 17707273a2dbSMatthew Booth 17717273a2dbSMatthew Booth@option{ipv4} and @option{ipv6} specify that either IPv4 or IPv6 must be used. 17727273a2dbSMatthew BoothIf neither is specified the socket may use either protocol. 17737273a2dbSMatthew Booth 17747273a2dbSMatthew Booth@option{nodelay} disables the Nagle algorithm. 17757273a2dbSMatthew Booth 17767273a2dbSMatthew Booth@item unix options: path=@var{path} 17777273a2dbSMatthew Booth 17787273a2dbSMatthew Booth@option{path} specifies the local path of the unix socket. @option{path} is 17797273a2dbSMatthew Boothrequired. 17807273a2dbSMatthew Booth 17817273a2dbSMatthew Booth@end table 17827273a2dbSMatthew Booth 17837273a2dbSMatthew Booth@item -chardev udp ,id=@var{id} [,host=@var{host}] ,port=@var{port} [,localaddr=@var{localaddr}] [,localport=@var{localport}] [,ipv4] [,ipv6] 17847273a2dbSMatthew Booth 17857273a2dbSMatthew BoothSends all traffic from the guest to a remote host over UDP. 17867273a2dbSMatthew Booth 17877273a2dbSMatthew Booth@option{host} specifies the remote host to connect to. If not specified it 17887273a2dbSMatthew Boothdefaults to @code{localhost}. 17897273a2dbSMatthew Booth 17907273a2dbSMatthew Booth@option{port} specifies the port on the remote host to connect to. @option{port} 17917273a2dbSMatthew Boothis required. 17927273a2dbSMatthew Booth 17937273a2dbSMatthew Booth@option{localaddr} specifies the local address to bind to. If not specified it 17947273a2dbSMatthew Boothdefaults to @code{0.0.0.0}. 17957273a2dbSMatthew Booth 17967273a2dbSMatthew Booth@option{localport} specifies the local port to bind to. If not specified any 17977273a2dbSMatthew Boothavailable local port will be used. 17987273a2dbSMatthew Booth 17997273a2dbSMatthew Booth@option{ipv4} and @option{ipv6} specify that either IPv4 or IPv6 must be used. 18007273a2dbSMatthew BoothIf neither is specified the device may use either protocol. 18017273a2dbSMatthew Booth 18027273a2dbSMatthew Booth@item -chardev msmouse ,id=@var{id} 18037273a2dbSMatthew Booth 18047273a2dbSMatthew BoothForward QEMU's emulated msmouse events to the guest. @option{msmouse} does not 18057273a2dbSMatthew Boothtake any options. 18067273a2dbSMatthew Booth 18077273a2dbSMatthew Booth@item -chardev vc ,id=@var{id} [[,width=@var{width}] [,height=@var{height}]] [[,cols=@var{cols}] [,rows=@var{rows}]] 18087273a2dbSMatthew Booth 18097273a2dbSMatthew BoothConnect to a QEMU text console. @option{vc} may optionally be given a specific 18107273a2dbSMatthew Boothsize. 18117273a2dbSMatthew Booth 18127273a2dbSMatthew Booth@option{width} and @option{height} specify the width and height respectively of 18137273a2dbSMatthew Booththe console, in pixels. 18147273a2dbSMatthew Booth 18157273a2dbSMatthew Booth@option{cols} and @option{rows} specify that the console be sized to fit a text 18167273a2dbSMatthew Boothconsole with the given dimensions. 18177273a2dbSMatthew Booth 18187273a2dbSMatthew Booth@item -chardev file ,id=@var{id} ,path=@var{path} 18197273a2dbSMatthew Booth 18207273a2dbSMatthew BoothLog all traffic received from the guest to a file. 18217273a2dbSMatthew Booth 18227273a2dbSMatthew Booth@option{path} specifies the path of the file to be opened. This file will be 18237273a2dbSMatthew Boothcreated if it does not already exist, and overwritten if it does. @option{path} 18247273a2dbSMatthew Boothis required. 18257273a2dbSMatthew Booth 18267273a2dbSMatthew Booth@item -chardev pipe ,id=@var{id} ,path=@var{path} 18277273a2dbSMatthew Booth 18287273a2dbSMatthew BoothCreate a two-way connection to the guest. The behaviour differs slightly between 18297273a2dbSMatthew BoothWindows hosts and other hosts: 18307273a2dbSMatthew Booth 18317273a2dbSMatthew BoothOn Windows, a single duplex pipe will be created at 18327273a2dbSMatthew Booth@file{\\.pipe\@option{path}}. 18337273a2dbSMatthew Booth 18347273a2dbSMatthew BoothOn other hosts, 2 pipes will be created called @file{@option{path}.in} and 18357273a2dbSMatthew Booth@file{@option{path}.out}. Data written to @file{@option{path}.in} will be 18367273a2dbSMatthew Boothreceived by the guest. Data written by the guest can be read from 18377273a2dbSMatthew Booth@file{@option{path}.out}. QEMU will not create these fifos, and requires them to 18387273a2dbSMatthew Boothbe present. 18397273a2dbSMatthew Booth 18407273a2dbSMatthew Booth@option{path} forms part of the pipe path as described above. @option{path} is 18417273a2dbSMatthew Boothrequired. 18427273a2dbSMatthew Booth 18437273a2dbSMatthew Booth@item -chardev console ,id=@var{id} 18447273a2dbSMatthew Booth 18457273a2dbSMatthew BoothSend traffic from the guest to QEMU's standard output. @option{console} does not 18467273a2dbSMatthew Boothtake any options. 18477273a2dbSMatthew Booth 18487273a2dbSMatthew Booth@option{console} is only available on Windows hosts. 18497273a2dbSMatthew Booth 18507273a2dbSMatthew Booth@item -chardev serial ,id=@var{id} ,path=@option{path} 18517273a2dbSMatthew Booth 18527273a2dbSMatthew BoothSend traffic from the guest to a serial device on the host. 18537273a2dbSMatthew Booth 18547273a2dbSMatthew Booth@option{serial} is 18557273a2dbSMatthew Boothonly available on Windows hosts. 18567273a2dbSMatthew Booth 18577273a2dbSMatthew Booth@option{path} specifies the name of the serial device to open. 18587273a2dbSMatthew Booth 18597273a2dbSMatthew Booth@item -chardev pty ,id=@var{id} 18607273a2dbSMatthew Booth 18617273a2dbSMatthew BoothCreate a new pseudo-terminal on the host and connect to it. @option{pty} does 18627273a2dbSMatthew Boothnot take any options. 18637273a2dbSMatthew Booth 18647273a2dbSMatthew Booth@option{pty} is not available on Windows hosts. 18657273a2dbSMatthew Booth 1866b7fdb3abSAurelien Jarno@item -chardev stdio ,id=@var{id} [,signal=on|off] 1867b65ee4faSStefan WeilConnect to standard input and standard output of the QEMU process. 1868b7fdb3abSAurelien Jarno 1869b7fdb3abSAurelien Jarno@option{signal} controls if signals are enabled on the terminal, that includes 1870b7fdb3abSAurelien Jarnoexiting QEMU with the key sequence @key{Control-c}. This option is enabled by 1871b7fdb3abSAurelien Jarnodefault, use @option{signal=off} to disable it. 1872b7fdb3abSAurelien Jarno 1873b7fdb3abSAurelien Jarno@option{stdio} is not available on Windows hosts. 18747273a2dbSMatthew Booth 18757273a2dbSMatthew Booth@item -chardev braille ,id=@var{id} 18767273a2dbSMatthew Booth 18777273a2dbSMatthew BoothConnect to a local BrlAPI server. @option{braille} does not take any options. 18787273a2dbSMatthew Booth 18797273a2dbSMatthew Booth@item -chardev tty ,id=@var{id} ,path=@var{path} 18807273a2dbSMatthew Booth 18817273a2dbSMatthew BoothConnect to a local tty device. 18827273a2dbSMatthew Booth 18837273a2dbSMatthew Booth@option{tty} is only available on Linux, Sun, FreeBSD, NetBSD, OpenBSD and 18847273a2dbSMatthew BoothDragonFlyBSD hosts. 18857273a2dbSMatthew Booth 18867273a2dbSMatthew Booth@option{path} specifies the path to the tty. @option{path} is required. 18877273a2dbSMatthew Booth 18887273a2dbSMatthew Booth@item -chardev parport ,id=@var{id} ,path=@var{path} 18897273a2dbSMatthew Booth 18907273a2dbSMatthew Booth@option{parport} is only available on Linux, FreeBSD and DragonFlyBSD hosts. 18917273a2dbSMatthew Booth 18927273a2dbSMatthew BoothConnect to a local parallel port. 18937273a2dbSMatthew Booth 18947273a2dbSMatthew Booth@option{path} specifies the path to the parallel port device. @option{path} is 18957273a2dbSMatthew Boothrequired. 18967273a2dbSMatthew Booth 1897cbcc6336SAlon Levy@item -chardev spicevmc ,id=@var{id} ,debug=@var{debug}, name=@var{name} 1898cbcc6336SAlon Levy 18993a846906SStefan Hajnoczi@option{spicevmc} is only available when spice support is built in. 19003a846906SStefan Hajnoczi 1901cbcc6336SAlon Levy@option{debug} debug level for spicevmc 1902cbcc6336SAlon Levy 1903cbcc6336SAlon Levy@option{name} name of spice channel to connect to 1904cbcc6336SAlon Levy 1905cbcc6336SAlon LevyConnect to a spice virtual machine channel, such as vdiport. 1906cbcc6336SAlon Levy 19077273a2dbSMatthew Booth@end table 19087273a2dbSMatthew BoothETEXI 19097273a2dbSMatthew Booth 19107273a2dbSMatthew BoothDEFHEADING() 19117273a2dbSMatthew Booth 19120f5314a2SRonnie SahlbergSTEXI 19130f5314a2SRonnie SahlbergDEFHEADING(Device URL Syntax:) 19140f5314a2SRonnie Sahlberg 19150f5314a2SRonnie SahlbergIn addition to using normal file images for the emulated storage devices, 19160f5314a2SRonnie SahlbergQEMU can also use networked resources such as iSCSI devices. These are 19170f5314a2SRonnie Sahlbergspecified using a special URL syntax. 19180f5314a2SRonnie Sahlberg 19190f5314a2SRonnie Sahlberg@table @option 19200f5314a2SRonnie Sahlberg@item iSCSI 19210f5314a2SRonnie SahlbergiSCSI support allows QEMU to access iSCSI resources directly and use as 19220f5314a2SRonnie Sahlbergimages for the guest storage. Both disk and cdrom images are supported. 19230f5314a2SRonnie Sahlberg 19240f5314a2SRonnie SahlbergSyntax for specifying iSCSI LUNs is 19250f5314a2SRonnie Sahlberg``iscsi://<target-ip>[:<port>]/<target-iqn>/<lun>'' 19260f5314a2SRonnie Sahlberg 192731459f46SRonnie SahlbergBy default qemu will use the iSCSI initiator-name 192831459f46SRonnie Sahlberg'iqn.2008-11.org.linux-kvm[:<name>]' but this can also be set from the command 192931459f46SRonnie Sahlbergline or a configuration file. 193031459f46SRonnie Sahlberg 193131459f46SRonnie Sahlberg 19320f5314a2SRonnie SahlbergExample (without authentication): 19330f5314a2SRonnie Sahlberg@example 19343804da9dSStefan Weilqemu-system-i386 -iscsi initiator-name=iqn.2001-04.com.example:my-initiator \ 1935f9dadc98SRonnie Sahlberg -cdrom iscsi://192.0.2.1/iqn.2001-04.com.example/2 \ 1936f9dadc98SRonnie Sahlberg -drive file=iscsi://192.0.2.1/iqn.2001-04.com.example/1 19370f5314a2SRonnie Sahlberg@end example 19380f5314a2SRonnie Sahlberg 19390f5314a2SRonnie SahlbergExample (CHAP username/password via URL): 19400f5314a2SRonnie Sahlberg@example 19413804da9dSStefan Weilqemu-system-i386 -drive file=iscsi://user%password@@192.0.2.1/iqn.2001-04.com.example/1 19420f5314a2SRonnie Sahlberg@end example 19430f5314a2SRonnie Sahlberg 19440f5314a2SRonnie SahlbergExample (CHAP username/password via environment variables): 19450f5314a2SRonnie Sahlberg@example 19460f5314a2SRonnie SahlbergLIBISCSI_CHAP_USERNAME="user" \ 19470f5314a2SRonnie SahlbergLIBISCSI_CHAP_PASSWORD="password" \ 19483804da9dSStefan Weilqemu-system-i386 -drive file=iscsi://192.0.2.1/iqn.2001-04.com.example/1 19490f5314a2SRonnie Sahlberg@end example 19500f5314a2SRonnie Sahlberg 19510f5314a2SRonnie SahlbergiSCSI support is an optional feature of QEMU and only available when 19520f5314a2SRonnie Sahlbergcompiled and linked against libiscsi. 1953f9dadc98SRonnie SahlbergETEXI 1954f9dadc98SRonnie SahlbergDEF("iscsi", HAS_ARG, QEMU_OPTION_iscsi, 1955f9dadc98SRonnie Sahlberg "-iscsi [user=user][,password=password]\n" 1956f9dadc98SRonnie Sahlberg " [,header-digest=CRC32C|CR32C-NONE|NONE-CRC32C|NONE\n" 1957f9dadc98SRonnie Sahlberg " [,initiator-name=iqn]\n" 1958f9dadc98SRonnie Sahlberg " iSCSI session parameters\n", QEMU_ARCH_ALL) 1959f9dadc98SRonnie SahlbergSTEXI 19600f5314a2SRonnie Sahlberg 196131459f46SRonnie SahlbergiSCSI parameters such as username and password can also be specified via 196231459f46SRonnie Sahlberga configuration file. See qemu-doc for more information and examples. 196331459f46SRonnie Sahlberg 196408ae330eSRonnie Sahlberg@item NBD 196508ae330eSRonnie SahlbergQEMU supports NBD (Network Block Devices) both using TCP protocol as well 196608ae330eSRonnie Sahlbergas Unix Domain Sockets. 196708ae330eSRonnie Sahlberg 196808ae330eSRonnie SahlbergSyntax for specifying a NBD device using TCP 196908ae330eSRonnie Sahlberg``nbd:<server-ip>:<port>[:exportname=<export>]'' 197008ae330eSRonnie Sahlberg 197108ae330eSRonnie SahlbergSyntax for specifying a NBD device using Unix Domain Sockets 197208ae330eSRonnie Sahlberg``nbd:unix:<domain-socket>[:exportname=<export>]'' 197308ae330eSRonnie Sahlberg 197408ae330eSRonnie Sahlberg 197508ae330eSRonnie SahlbergExample for TCP 197608ae330eSRonnie Sahlberg@example 19773804da9dSStefan Weilqemu-system-i386 --drive file=nbd:192.0.2.1:30000 197808ae330eSRonnie Sahlberg@end example 197908ae330eSRonnie Sahlberg 198008ae330eSRonnie SahlbergExample for Unix Domain Sockets 198108ae330eSRonnie Sahlberg@example 19823804da9dSStefan Weilqemu-system-i386 --drive file=nbd:unix:/tmp/nbd-socket 198308ae330eSRonnie Sahlberg@end example 198408ae330eSRonnie Sahlberg 1985d9990228SRonnie Sahlberg@item Sheepdog 1986d9990228SRonnie SahlbergSheepdog is a distributed storage system for QEMU. 1987d9990228SRonnie SahlbergQEMU supports using either local sheepdog devices or remote networked 1988d9990228SRonnie Sahlbergdevices. 1989d9990228SRonnie Sahlberg 1990d9990228SRonnie SahlbergSyntax for specifying a sheepdog device 1991d9990228SRonnie Sahlberg@table @list 1992d9990228SRonnie Sahlberg``sheepdog:<vdiname>'' 1993d9990228SRonnie Sahlberg 1994d9990228SRonnie Sahlberg``sheepdog:<vdiname>:<snapid>'' 1995d9990228SRonnie Sahlberg 1996d9990228SRonnie Sahlberg``sheepdog:<vdiname>:<tag>'' 1997d9990228SRonnie Sahlberg 1998d9990228SRonnie Sahlberg``sheepdog:<host>:<port>:<vdiname>'' 1999d9990228SRonnie Sahlberg 2000d9990228SRonnie Sahlberg``sheepdog:<host>:<port>:<vdiname>:<snapid>'' 2001d9990228SRonnie Sahlberg 2002d9990228SRonnie Sahlberg``sheepdog:<host>:<port>:<vdiname>:<tag>'' 2003d9990228SRonnie Sahlberg@end table 2004d9990228SRonnie Sahlberg 2005d9990228SRonnie SahlbergExample 2006d9990228SRonnie Sahlberg@example 20073804da9dSStefan Weilqemu-system-i386 --drive file=sheepdog:192.0.2.1:30000:MyVirtualMachine 2008d9990228SRonnie Sahlberg@end example 2009d9990228SRonnie Sahlberg 2010d9990228SRonnie SahlbergSee also @url{http://http://www.osrg.net/sheepdog/}. 2011d9990228SRonnie Sahlberg 20120f5314a2SRonnie Sahlberg@end table 20130f5314a2SRonnie SahlbergETEXI 20140f5314a2SRonnie Sahlberg 20157273a2dbSMatthew BoothDEFHEADING(Bluetooth(R) options:) 20167273a2dbSMatthew Booth 20175824d651Sblueswir1DEF("bt", HAS_ARG, QEMU_OPTION_bt, \ 20185824d651Sblueswir1 "-bt hci,null dumb bluetooth HCI - doesn't respond to commands\n" \ 20195824d651Sblueswir1 "-bt hci,host[:id]\n" \ 20205824d651Sblueswir1 " use host's HCI with the given name\n" \ 20215824d651Sblueswir1 "-bt hci[,vlan=n]\n" \ 20225824d651Sblueswir1 " emulate a standard HCI in virtual scatternet 'n'\n" \ 20235824d651Sblueswir1 "-bt vhci[,vlan=n]\n" \ 20245824d651Sblueswir1 " add host computer to virtual scatternet 'n' using VHCI\n" \ 20255824d651Sblueswir1 "-bt device:dev[,vlan=n]\n" \ 2026ad96090aSBlue Swirl " emulate a bluetooth device 'dev' in scatternet 'n'\n", 2027ad96090aSBlue Swirl QEMU_ARCH_ALL) 20285824d651Sblueswir1STEXI 20295824d651Sblueswir1@table @option 20305824d651Sblueswir1 20315824d651Sblueswir1@item -bt hci[...] 20326616b2adSStefan Weil@findex -bt 20335824d651Sblueswir1Defines the function of the corresponding Bluetooth HCI. -bt options 20345824d651Sblueswir1are matched with the HCIs present in the chosen machine type. For 20355824d651Sblueswir1example when emulating a machine with only one HCI built into it, only 20365824d651Sblueswir1the first @code{-bt hci[...]} option is valid and defines the HCI's 20375824d651Sblueswir1logic. The Transport Layer is decided by the machine type. Currently 20385824d651Sblueswir1the machines @code{n800} and @code{n810} have one HCI and all other 20395824d651Sblueswir1machines have none. 20405824d651Sblueswir1 20415824d651Sblueswir1@anchor{bt-hcis} 20425824d651Sblueswir1The following three types are recognized: 20435824d651Sblueswir1 2044b3f046c2SKevin Wolf@table @option 20455824d651Sblueswir1@item -bt hci,null 20465824d651Sblueswir1(default) The corresponding Bluetooth HCI assumes no internal logic 20475824d651Sblueswir1and will not respond to any HCI commands or emit events. 20485824d651Sblueswir1 20495824d651Sblueswir1@item -bt hci,host[:@var{id}] 20505824d651Sblueswir1(@code{bluez} only) The corresponding HCI passes commands / events 20515824d651Sblueswir1to / from the physical HCI identified by the name @var{id} (default: 20525824d651Sblueswir1@code{hci0}) on the computer running QEMU. Only available on @code{bluez} 20535824d651Sblueswir1capable systems like Linux. 20545824d651Sblueswir1 20555824d651Sblueswir1@item -bt hci[,vlan=@var{n}] 20565824d651Sblueswir1Add a virtual, standard HCI that will participate in the Bluetooth 20575824d651Sblueswir1scatternet @var{n} (default @code{0}). Similarly to @option{-net} 20585824d651Sblueswir1VLANs, devices inside a bluetooth network @var{n} can only communicate 20595824d651Sblueswir1with other devices in the same network (scatternet). 20605824d651Sblueswir1@end table 20615824d651Sblueswir1 20625824d651Sblueswir1@item -bt vhci[,vlan=@var{n}] 20635824d651Sblueswir1(Linux-host only) Create a HCI in scatternet @var{n} (default 0) attached 20645824d651Sblueswir1to the host bluetooth stack instead of to the emulated target. This 20655824d651Sblueswir1allows the host and target machines to participate in a common scatternet 20665824d651Sblueswir1and communicate. Requires the Linux @code{vhci} driver installed. Can 20675824d651Sblueswir1be used as following: 20685824d651Sblueswir1 20695824d651Sblueswir1@example 20703804da9dSStefan Weilqemu-system-i386 [...OPTIONS...] -bt hci,vlan=5 -bt vhci,vlan=5 20715824d651Sblueswir1@end example 20725824d651Sblueswir1 20735824d651Sblueswir1@item -bt device:@var{dev}[,vlan=@var{n}] 20745824d651Sblueswir1Emulate a bluetooth device @var{dev} and place it in network @var{n} 20755824d651Sblueswir1(default @code{0}). QEMU can only emulate one type of bluetooth devices 20765824d651Sblueswir1currently: 20775824d651Sblueswir1 2078b3f046c2SKevin Wolf@table @option 20795824d651Sblueswir1@item keyboard 20805824d651Sblueswir1Virtual wireless keyboard implementing the HIDP bluetooth profile. 20815824d651Sblueswir1@end table 20825824d651Sblueswir1@end table 20835824d651Sblueswir1ETEXI 20845824d651Sblueswir1 20855824d651Sblueswir1DEFHEADING() 20865824d651Sblueswir1 20877677f05dSAlexander GrafDEFHEADING(Linux/Multiboot boot specific:) 20885824d651Sblueswir1STEXI 20897677f05dSAlexander Graf 20907677f05dSAlexander GrafWhen using these options, you can use a given Linux or Multiboot 20917677f05dSAlexander Grafkernel without installing it in the disk image. It can be useful 20925824d651Sblueswir1for easier testing of various kernels. 20935824d651Sblueswir1 20945824d651Sblueswir1@table @option 20955824d651Sblueswir1ETEXI 20965824d651Sblueswir1 20975824d651Sblueswir1DEF("kernel", HAS_ARG, QEMU_OPTION_kernel, \ 2098ad96090aSBlue Swirl "-kernel bzImage use 'bzImage' as kernel image\n", QEMU_ARCH_ALL) 20995824d651Sblueswir1STEXI 21005824d651Sblueswir1@item -kernel @var{bzImage} 21016616b2adSStefan Weil@findex -kernel 21027677f05dSAlexander GrafUse @var{bzImage} as kernel image. The kernel can be either a Linux kernel 21037677f05dSAlexander Grafor in multiboot format. 21045824d651Sblueswir1ETEXI 21055824d651Sblueswir1 21065824d651Sblueswir1DEF("append", HAS_ARG, QEMU_OPTION_append, \ 2107ad96090aSBlue Swirl "-append cmdline use 'cmdline' as kernel command line\n", QEMU_ARCH_ALL) 21085824d651Sblueswir1STEXI 21095824d651Sblueswir1@item -append @var{cmdline} 21106616b2adSStefan Weil@findex -append 21115824d651Sblueswir1Use @var{cmdline} as kernel command line 21125824d651Sblueswir1ETEXI 21135824d651Sblueswir1 21145824d651Sblueswir1DEF("initrd", HAS_ARG, QEMU_OPTION_initrd, \ 2115ad96090aSBlue Swirl "-initrd file use 'file' as initial ram disk\n", QEMU_ARCH_ALL) 21165824d651Sblueswir1STEXI 21175824d651Sblueswir1@item -initrd @var{file} 21186616b2adSStefan Weil@findex -initrd 21195824d651Sblueswir1Use @var{file} as initial ram disk. 21207677f05dSAlexander Graf 21217677f05dSAlexander Graf@item -initrd "@var{file1} arg=foo,@var{file2}" 21227677f05dSAlexander Graf 21237677f05dSAlexander GrafThis syntax is only available with multiboot. 21247677f05dSAlexander Graf 21257677f05dSAlexander GrafUse @var{file1} and @var{file2} as modules and pass arg=foo as parameter to the 21267677f05dSAlexander Graffirst module. 21275824d651Sblueswir1ETEXI 21285824d651Sblueswir1 2129412beee6SGrant LikelyDEF("dtb", HAS_ARG, QEMU_OPTION_dtb, \ 2130379b5c7cSPeter A. G. Crosthwaite "-dtb file use 'file' as device tree image\n", QEMU_ARCH_ALL) 2131412beee6SGrant LikelySTEXI 2132412beee6SGrant Likely@item -dtb @var{file} 2133412beee6SGrant Likely@findex -dtb 2134412beee6SGrant LikelyUse @var{file} as a device tree binary (dtb) image and pass it to the kernel 2135412beee6SGrant Likelyon boot. 2136412beee6SGrant LikelyETEXI 2137412beee6SGrant Likely 21385824d651Sblueswir1STEXI 21395824d651Sblueswir1@end table 21405824d651Sblueswir1ETEXI 21415824d651Sblueswir1 21425824d651Sblueswir1DEFHEADING() 21435824d651Sblueswir1 21445824d651Sblueswir1DEFHEADING(Debug/Expert options:) 21455824d651Sblueswir1 21465824d651Sblueswir1STEXI 21475824d651Sblueswir1@table @option 21485824d651Sblueswir1ETEXI 21495824d651Sblueswir1 21505824d651Sblueswir1DEF("serial", HAS_ARG, QEMU_OPTION_serial, \ 2151ad96090aSBlue Swirl "-serial dev redirect the serial port to char device 'dev'\n", 2152ad96090aSBlue Swirl QEMU_ARCH_ALL) 21535824d651Sblueswir1STEXI 21545824d651Sblueswir1@item -serial @var{dev} 21556616b2adSStefan Weil@findex -serial 21565824d651Sblueswir1Redirect the virtual serial port to host character device 21575824d651Sblueswir1@var{dev}. The default device is @code{vc} in graphical mode and 21585824d651Sblueswir1@code{stdio} in non graphical mode. 21595824d651Sblueswir1 21605824d651Sblueswir1This option can be used several times to simulate up to 4 serial 21615824d651Sblueswir1ports. 21625824d651Sblueswir1 21635824d651Sblueswir1Use @code{-serial none} to disable all serial ports. 21645824d651Sblueswir1 21655824d651Sblueswir1Available character devices are: 2166b3f046c2SKevin Wolf@table @option 21674e257e5eSKevin Wolf@item vc[:@var{W}x@var{H}] 21685824d651Sblueswir1Virtual console. Optionally, a width and height can be given in pixel with 21695824d651Sblueswir1@example 21705824d651Sblueswir1vc:800x600 21715824d651Sblueswir1@end example 21725824d651Sblueswir1It is also possible to specify width or height in characters: 21735824d651Sblueswir1@example 21745824d651Sblueswir1vc:80Cx24C 21755824d651Sblueswir1@end example 21765824d651Sblueswir1@item pty 21775824d651Sblueswir1[Linux only] Pseudo TTY (a new PTY is automatically allocated) 21785824d651Sblueswir1@item none 21795824d651Sblueswir1No device is allocated. 21805824d651Sblueswir1@item null 21815824d651Sblueswir1void device 21825824d651Sblueswir1@item /dev/XXX 21835824d651Sblueswir1[Linux only] Use host tty, e.g. @file{/dev/ttyS0}. The host serial port 21845824d651Sblueswir1parameters are set according to the emulated ones. 21855824d651Sblueswir1@item /dev/parport@var{N} 21865824d651Sblueswir1[Linux only, parallel port only] Use host parallel port 21875824d651Sblueswir1@var{N}. Currently SPP and EPP parallel port features can be used. 21885824d651Sblueswir1@item file:@var{filename} 21895824d651Sblueswir1Write output to @var{filename}. No character can be read. 21905824d651Sblueswir1@item stdio 21915824d651Sblueswir1[Unix only] standard input/output 21925824d651Sblueswir1@item pipe:@var{filename} 21935824d651Sblueswir1name pipe @var{filename} 21945824d651Sblueswir1@item COM@var{n} 21955824d651Sblueswir1[Windows only] Use host serial port @var{n} 21965824d651Sblueswir1@item udp:[@var{remote_host}]:@var{remote_port}[@@[@var{src_ip}]:@var{src_port}] 21975824d651Sblueswir1This implements UDP Net Console. 21985824d651Sblueswir1When @var{remote_host} or @var{src_ip} are not specified 21995824d651Sblueswir1they default to @code{0.0.0.0}. 22005824d651Sblueswir1When not using a specified @var{src_port} a random port is automatically chosen. 22015824d651Sblueswir1 22025824d651Sblueswir1If you just want a simple readonly console you can use @code{netcat} or 2203b65ee4faSStefan Weil@code{nc}, by starting QEMU with: @code{-serial udp::4555} and nc as: 2204b65ee4faSStefan Weil@code{nc -u -l -p 4555}. Any time QEMU writes something to that port it 22055824d651Sblueswir1will appear in the netconsole session. 22065824d651Sblueswir1 22075824d651Sblueswir1If you plan to send characters back via netconsole or you want to stop 2208b65ee4faSStefan Weiland start QEMU a lot of times, you should have QEMU use the same 22095824d651Sblueswir1source port each time by using something like @code{-serial 2210b65ee4faSStefan Weiludp::4555@@:4556} to QEMU. Another approach is to use a patched 22115824d651Sblueswir1version of netcat which can listen to a TCP port and send and receive 22125824d651Sblueswir1characters via udp. If you have a patched version of netcat which 22135824d651Sblueswir1activates telnet remote echo and single char transfer, then you can 22145824d651Sblueswir1use the following options to step up a netcat redirector to allow 2215b65ee4faSStefan Weiltelnet on port 5555 to access the QEMU port. 22165824d651Sblueswir1@table @code 2217071c9394SStefan Weil@item QEMU Options: 22185824d651Sblueswir1-serial udp::4555@@:4556 22195824d651Sblueswir1@item netcat options: 22205824d651Sblueswir1-u -P 4555 -L 0.0.0.0:4556 -t -p 5555 -I -T 22215824d651Sblueswir1@item telnet options: 22225824d651Sblueswir1localhost 5555 22235824d651Sblueswir1@end table 22245824d651Sblueswir1 22255824d651Sblueswir1@item tcp:[@var{host}]:@var{port}[,@var{server}][,nowait][,nodelay] 22265824d651Sblueswir1The TCP Net Console has two modes of operation. It can send the serial 22275824d651Sblueswir1I/O to a location or wait for a connection from a location. By default 22285824d651Sblueswir1the TCP Net Console is sent to @var{host} at the @var{port}. If you use 22295824d651Sblueswir1the @var{server} option QEMU will wait for a client socket application 22305824d651Sblueswir1to connect to the port before continuing, unless the @code{nowait} 22315824d651Sblueswir1option was specified. The @code{nodelay} option disables the Nagle buffering 22325824d651Sblueswir1algorithm. If @var{host} is omitted, 0.0.0.0 is assumed. Only 22335824d651Sblueswir1one TCP connection at a time is accepted. You can use @code{telnet} to 22345824d651Sblueswir1connect to the corresponding character device. 22355824d651Sblueswir1@table @code 22365824d651Sblueswir1@item Example to send tcp console to 192.168.0.2 port 4444 22375824d651Sblueswir1-serial tcp:192.168.0.2:4444 22385824d651Sblueswir1@item Example to listen and wait on port 4444 for connection 22395824d651Sblueswir1-serial tcp::4444,server 22405824d651Sblueswir1@item Example to not wait and listen on ip 192.168.0.100 port 4444 22415824d651Sblueswir1-serial tcp:192.168.0.100:4444,server,nowait 22425824d651Sblueswir1@end table 22435824d651Sblueswir1 22445824d651Sblueswir1@item telnet:@var{host}:@var{port}[,server][,nowait][,nodelay] 22455824d651Sblueswir1The telnet protocol is used instead of raw tcp sockets. The options 22465824d651Sblueswir1work the same as if you had specified @code{-serial tcp}. The 22475824d651Sblueswir1difference is that the port acts like a telnet server or client using 22485824d651Sblueswir1telnet option negotiation. This will also allow you to send the 22495824d651Sblueswir1MAGIC_SYSRQ sequence if you use a telnet that supports sending the break 22505824d651Sblueswir1sequence. Typically in unix telnet you do it with Control-] and then 22515824d651Sblueswir1type "send break" followed by pressing the enter key. 22525824d651Sblueswir1 22535824d651Sblueswir1@item unix:@var{path}[,server][,nowait] 22545824d651Sblueswir1A unix domain socket is used instead of a tcp socket. The option works the 22555824d651Sblueswir1same as if you had specified @code{-serial tcp} except the unix domain socket 22565824d651Sblueswir1@var{path} is used for connections. 22575824d651Sblueswir1 22585824d651Sblueswir1@item mon:@var{dev_string} 22595824d651Sblueswir1This is a special option to allow the monitor to be multiplexed onto 22605824d651Sblueswir1another serial port. The monitor is accessed with key sequence of 22615824d651Sblueswir1@key{Control-a} and then pressing @key{c}. See monitor access 22625824d651Sblueswir1@ref{pcsys_keys} in the -nographic section for more keys. 22635824d651Sblueswir1@var{dev_string} should be any one of the serial devices specified 22645824d651Sblueswir1above. An example to multiplex the monitor onto a telnet server 22655824d651Sblueswir1listening on port 4444 would be: 22665824d651Sblueswir1@table @code 22675824d651Sblueswir1@item -serial mon:telnet::4444,server,nowait 22685824d651Sblueswir1@end table 22695824d651Sblueswir1 22705824d651Sblueswir1@item braille 22715824d651Sblueswir1Braille device. This will use BrlAPI to display the braille output on a real 22725824d651Sblueswir1or fake device. 22735824d651Sblueswir1 2274be8b28a9SKevin Wolf@item msmouse 2275be8b28a9SKevin WolfThree button serial mouse. Configure the guest to use Microsoft protocol. 22765824d651Sblueswir1@end table 22775824d651Sblueswir1ETEXI 22785824d651Sblueswir1 22795824d651Sblueswir1DEF("parallel", HAS_ARG, QEMU_OPTION_parallel, \ 2280ad96090aSBlue Swirl "-parallel dev redirect the parallel port to char device 'dev'\n", 2281ad96090aSBlue Swirl QEMU_ARCH_ALL) 22825824d651Sblueswir1STEXI 22835824d651Sblueswir1@item -parallel @var{dev} 22846616b2adSStefan Weil@findex -parallel 22855824d651Sblueswir1Redirect the virtual parallel port to host device @var{dev} (same 22865824d651Sblueswir1devices as the serial port). On Linux hosts, @file{/dev/parportN} can 22875824d651Sblueswir1be used to use hardware devices connected on the corresponding host 22885824d651Sblueswir1parallel port. 22895824d651Sblueswir1 22905824d651Sblueswir1This option can be used several times to simulate up to 3 parallel 22915824d651Sblueswir1ports. 22925824d651Sblueswir1 22935824d651Sblueswir1Use @code{-parallel none} to disable all parallel ports. 22945824d651Sblueswir1ETEXI 22955824d651Sblueswir1 22965824d651Sblueswir1DEF("monitor", HAS_ARG, QEMU_OPTION_monitor, \ 2297ad96090aSBlue Swirl "-monitor dev redirect the monitor to char device 'dev'\n", 2298ad96090aSBlue Swirl QEMU_ARCH_ALL) 22995824d651Sblueswir1STEXI 23004e307fc8SGerd Hoffmann@item -monitor @var{dev} 23016616b2adSStefan Weil@findex -monitor 23025824d651Sblueswir1Redirect the monitor to host device @var{dev} (same devices as the 23035824d651Sblueswir1serial port). 23045824d651Sblueswir1The default device is @code{vc} in graphical mode and @code{stdio} in 23055824d651Sblueswir1non graphical mode. 23065824d651Sblueswir1ETEXI 23076ca5582dSGerd HoffmannDEF("qmp", HAS_ARG, QEMU_OPTION_qmp, \ 2308ad96090aSBlue Swirl "-qmp dev like -monitor but opens in 'control' mode\n", 2309ad96090aSBlue Swirl QEMU_ARCH_ALL) 231095d5f08bSStefan WeilSTEXI 231195d5f08bSStefan Weil@item -qmp @var{dev} 23126616b2adSStefan Weil@findex -qmp 231395d5f08bSStefan WeilLike -monitor but opens in 'control' mode. 231495d5f08bSStefan WeilETEXI 23155824d651Sblueswir1 231622a0e04bSGerd HoffmannDEF("mon", HAS_ARG, QEMU_OPTION_mon, \ 2317ad96090aSBlue Swirl "-mon chardev=[name][,mode=readline|control][,default]\n", QEMU_ARCH_ALL) 231822a0e04bSGerd HoffmannSTEXI 231922a0e04bSGerd Hoffmann@item -mon chardev=[name][,mode=readline|control][,default] 23206616b2adSStefan Weil@findex -mon 232122a0e04bSGerd HoffmannSetup monitor on chardev @var{name}. 232222a0e04bSGerd HoffmannETEXI 232322a0e04bSGerd Hoffmann 2324c9f398e5SH. Peter AnvinDEF("debugcon", HAS_ARG, QEMU_OPTION_debugcon, \ 2325ad96090aSBlue Swirl "-debugcon dev redirect the debug console to char device 'dev'\n", 2326ad96090aSBlue Swirl QEMU_ARCH_ALL) 2327c9f398e5SH. Peter AnvinSTEXI 2328c9f398e5SH. Peter Anvin@item -debugcon @var{dev} 23296616b2adSStefan Weil@findex -debugcon 2330c9f398e5SH. Peter AnvinRedirect the debug console to host device @var{dev} (same devices as the 2331c9f398e5SH. Peter Anvinserial port). The debug console is an I/O port which is typically port 2332c9f398e5SH. Peter Anvin0xe9; writing to that I/O port sends output to this device. 2333c9f398e5SH. Peter AnvinThe default device is @code{vc} in graphical mode and @code{stdio} in 2334c9f398e5SH. Peter Anvinnon graphical mode. 2335c9f398e5SH. Peter AnvinETEXI 2336c9f398e5SH. Peter Anvin 23375824d651Sblueswir1DEF("pidfile", HAS_ARG, QEMU_OPTION_pidfile, \ 2338ad96090aSBlue Swirl "-pidfile file write PID to 'file'\n", QEMU_ARCH_ALL) 23395824d651Sblueswir1STEXI 23405824d651Sblueswir1@item -pidfile @var{file} 23416616b2adSStefan Weil@findex -pidfile 23425824d651Sblueswir1Store the QEMU process PID in @var{file}. It is useful if you launch QEMU 23435824d651Sblueswir1from a script. 23445824d651Sblueswir1ETEXI 23455824d651Sblueswir1 23461b530a6dSaurel32DEF("singlestep", 0, QEMU_OPTION_singlestep, \ 2347ad96090aSBlue Swirl "-singlestep always run in singlestep mode\n", QEMU_ARCH_ALL) 23481b530a6dSaurel32STEXI 23491b530a6dSaurel32@item -singlestep 23506616b2adSStefan Weil@findex -singlestep 23511b530a6dSaurel32Run the emulation in single step mode. 23521b530a6dSaurel32ETEXI 23531b530a6dSaurel32 23545824d651Sblueswir1DEF("S", 0, QEMU_OPTION_S, \ 2355ad96090aSBlue Swirl "-S freeze CPU at startup (use 'c' to start execution)\n", 2356ad96090aSBlue Swirl QEMU_ARCH_ALL) 23575824d651Sblueswir1STEXI 23585824d651Sblueswir1@item -S 23596616b2adSStefan Weil@findex -S 23605824d651Sblueswir1Do not start CPU at startup (you must type 'c' in the monitor). 23615824d651Sblueswir1ETEXI 23625824d651Sblueswir1 236359030a8cSaliguoriDEF("gdb", HAS_ARG, QEMU_OPTION_gdb, \ 2364ad96090aSBlue Swirl "-gdb dev wait for gdb connection on 'dev'\n", QEMU_ARCH_ALL) 23655824d651Sblueswir1STEXI 236659030a8cSaliguori@item -gdb @var{dev} 23676616b2adSStefan Weil@findex -gdb 236859030a8cSaliguoriWait for gdb connection on device @var{dev} (@pxref{gdb_usage}). Typical 236959030a8cSaliguoriconnections will likely be TCP-based, but also UDP, pseudo TTY, or even 2370b65ee4faSStefan Weilstdio are reasonable use case. The latter is allowing to start QEMU from 237159030a8cSaliguoriwithin gdb and establish the connection via a pipe: 237259030a8cSaliguori@example 23733804da9dSStefan Weil(gdb) target remote | exec qemu-system-i386 -gdb stdio ... 237459030a8cSaliguori@end example 23755824d651Sblueswir1ETEXI 23765824d651Sblueswir1 237759030a8cSaliguoriDEF("s", 0, QEMU_OPTION_s, \ 2378ad96090aSBlue Swirl "-s shorthand for -gdb tcp::" DEFAULT_GDBSTUB_PORT "\n", 2379ad96090aSBlue Swirl QEMU_ARCH_ALL) 23805824d651Sblueswir1STEXI 238159030a8cSaliguori@item -s 23826616b2adSStefan Weil@findex -s 238359030a8cSaliguoriShorthand for -gdb tcp::1234, i.e. open a gdbserver on TCP port 1234 238459030a8cSaliguori(@pxref{gdb_usage}). 23855824d651Sblueswir1ETEXI 23865824d651Sblueswir1 23875824d651Sblueswir1DEF("d", HAS_ARG, QEMU_OPTION_d, \ 2388ad96090aSBlue Swirl "-d item1,... output log to /tmp/qemu.log (use -d ? for a list of log items)\n", 2389ad96090aSBlue Swirl QEMU_ARCH_ALL) 23905824d651Sblueswir1STEXI 23915824d651Sblueswir1@item -d 23926616b2adSStefan Weil@findex -d 23935824d651Sblueswir1Output log in /tmp/qemu.log 23945824d651Sblueswir1ETEXI 23955824d651Sblueswir1 2396c235d738SMatthew FernandezDEF("D", HAS_ARG, QEMU_OPTION_D, \ 2397c235d738SMatthew Fernandez "-D logfile output log to logfile (instead of the default /tmp/qemu.log)\n", 2398c235d738SMatthew Fernandez QEMU_ARCH_ALL) 2399c235d738SMatthew FernandezSTEXI 24008bd383b4SStefan Weil@item -D @var{logfile} 2401c235d738SMatthew Fernandez@findex -D 24028bd383b4SStefan WeilOutput log in @var{logfile} instead of /tmp/qemu.log 2403c235d738SMatthew FernandezETEXI 2404c235d738SMatthew Fernandez 24055824d651Sblueswir1DEF("hdachs", HAS_ARG, QEMU_OPTION_hdachs, \ 24065824d651Sblueswir1 "-hdachs c,h,s[,t]\n" \ 24075824d651Sblueswir1 " force hard disk 0 physical geometry and the optional BIOS\n" \ 2408b65ee4faSStefan Weil " translation (t=none or lba) (usually QEMU can guess them)\n", 2409ad96090aSBlue Swirl QEMU_ARCH_ALL) 24105824d651Sblueswir1STEXI 24115824d651Sblueswir1@item -hdachs @var{c},@var{h},@var{s},[,@var{t}] 24126616b2adSStefan Weil@findex -hdachs 24135824d651Sblueswir1Force hard disk 0 physical geometry (1 <= @var{c} <= 16383, 1 <= 24145824d651Sblueswir1@var{h} <= 16, 1 <= @var{s} <= 63) and optionally force the BIOS 24155824d651Sblueswir1translation mode (@var{t}=none, lba or auto). Usually QEMU can guess 24165824d651Sblueswir1all those parameters. This option is useful for old MS-DOS disk 24175824d651Sblueswir1images. 24185824d651Sblueswir1ETEXI 24195824d651Sblueswir1 24205824d651Sblueswir1DEF("L", HAS_ARG, QEMU_OPTION_L, \ 2421ad96090aSBlue Swirl "-L path set the directory for the BIOS, VGA BIOS and keymaps\n", 2422ad96090aSBlue Swirl QEMU_ARCH_ALL) 24235824d651Sblueswir1STEXI 24245824d651Sblueswir1@item -L @var{path} 24256616b2adSStefan Weil@findex -L 24265824d651Sblueswir1Set the directory for the BIOS, VGA BIOS and keymaps. 24275824d651Sblueswir1ETEXI 24285824d651Sblueswir1 24295824d651Sblueswir1DEF("bios", HAS_ARG, QEMU_OPTION_bios, \ 2430ad96090aSBlue Swirl "-bios file set the filename for the BIOS\n", QEMU_ARCH_ALL) 24315824d651Sblueswir1STEXI 24325824d651Sblueswir1@item -bios @var{file} 24336616b2adSStefan Weil@findex -bios 24345824d651Sblueswir1Set the filename for the BIOS. 24355824d651Sblueswir1ETEXI 24365824d651Sblueswir1 24375824d651Sblueswir1DEF("enable-kvm", 0, QEMU_OPTION_enable_kvm, \ 2438ad96090aSBlue Swirl "-enable-kvm enable KVM full virtualization support\n", QEMU_ARCH_ALL) 24395824d651Sblueswir1STEXI 24405824d651Sblueswir1@item -enable-kvm 24416616b2adSStefan Weil@findex -enable-kvm 24425824d651Sblueswir1Enable KVM full virtualization support. This option is only available 24435824d651Sblueswir1if KVM support is enabled when compiling. 24445824d651Sblueswir1ETEXI 24455824d651Sblueswir1 2446e37630caSaliguoriDEF("xen-domid", HAS_ARG, QEMU_OPTION_xen_domid, 2447ad96090aSBlue Swirl "-xen-domid id specify xen guest domain id\n", QEMU_ARCH_ALL) 2448e37630caSaliguoriDEF("xen-create", 0, QEMU_OPTION_xen_create, 2449e37630caSaliguori "-xen-create create domain using xen hypercalls, bypassing xend\n" 2450ad96090aSBlue Swirl " warning: should not be used when xend is in use\n", 2451ad96090aSBlue Swirl QEMU_ARCH_ALL) 2452e37630caSaliguoriDEF("xen-attach", 0, QEMU_OPTION_xen_attach, 2453e37630caSaliguori "-xen-attach attach to existing xen domain\n" 2454b65ee4faSStefan Weil " xend will use this when starting QEMU\n", 2455ad96090aSBlue Swirl QEMU_ARCH_ALL) 245695d5f08bSStefan WeilSTEXI 245795d5f08bSStefan Weil@item -xen-domid @var{id} 24586616b2adSStefan Weil@findex -xen-domid 245995d5f08bSStefan WeilSpecify xen guest domain @var{id} (XEN only). 246095d5f08bSStefan Weil@item -xen-create 24616616b2adSStefan Weil@findex -xen-create 246295d5f08bSStefan WeilCreate domain using xen hypercalls, bypassing xend. 246395d5f08bSStefan WeilWarning: should not be used when xend is in use (XEN only). 246495d5f08bSStefan Weil@item -xen-attach 24656616b2adSStefan Weil@findex -xen-attach 246695d5f08bSStefan WeilAttach to existing xen domain. 2467b65ee4faSStefan Weilxend will use this when starting QEMU (XEN only). 246895d5f08bSStefan WeilETEXI 2469e37630caSaliguori 24705824d651Sblueswir1DEF("no-reboot", 0, QEMU_OPTION_no_reboot, \ 2471ad96090aSBlue Swirl "-no-reboot exit instead of rebooting\n", QEMU_ARCH_ALL) 24725824d651Sblueswir1STEXI 24735824d651Sblueswir1@item -no-reboot 24746616b2adSStefan Weil@findex -no-reboot 24755824d651Sblueswir1Exit instead of rebooting. 24765824d651Sblueswir1ETEXI 24775824d651Sblueswir1 24785824d651Sblueswir1DEF("no-shutdown", 0, QEMU_OPTION_no_shutdown, \ 2479ad96090aSBlue Swirl "-no-shutdown stop before shutdown\n", QEMU_ARCH_ALL) 24805824d651Sblueswir1STEXI 24815824d651Sblueswir1@item -no-shutdown 24826616b2adSStefan Weil@findex -no-shutdown 24835824d651Sblueswir1Don't exit QEMU on guest shutdown, but instead only stop the emulation. 24845824d651Sblueswir1This allows for instance switching to monitor to commit changes to the 24855824d651Sblueswir1disk image. 24865824d651Sblueswir1ETEXI 24875824d651Sblueswir1 24885824d651Sblueswir1DEF("loadvm", HAS_ARG, QEMU_OPTION_loadvm, \ 24895824d651Sblueswir1 "-loadvm [tag|id]\n" \ 2490ad96090aSBlue Swirl " start right away with a saved state (loadvm in monitor)\n", 2491ad96090aSBlue Swirl QEMU_ARCH_ALL) 24925824d651Sblueswir1STEXI 24935824d651Sblueswir1@item -loadvm @var{file} 24946616b2adSStefan Weil@findex -loadvm 24955824d651Sblueswir1Start right away with a saved state (@code{loadvm} in monitor) 24965824d651Sblueswir1ETEXI 24975824d651Sblueswir1 24985824d651Sblueswir1#ifndef _WIN32 24995824d651Sblueswir1DEF("daemonize", 0, QEMU_OPTION_daemonize, \ 2500ad96090aSBlue Swirl "-daemonize daemonize QEMU after initializing\n", QEMU_ARCH_ALL) 25015824d651Sblueswir1#endif 25025824d651Sblueswir1STEXI 25035824d651Sblueswir1@item -daemonize 25046616b2adSStefan Weil@findex -daemonize 25055824d651Sblueswir1Daemonize the QEMU process after initialization. QEMU will not detach from 25065824d651Sblueswir1standard IO until it is ready to receive connections on any of its devices. 25075824d651Sblueswir1This option is a useful way for external programs to launch QEMU without having 25085824d651Sblueswir1to cope with initialization race conditions. 25095824d651Sblueswir1ETEXI 25105824d651Sblueswir1 25115824d651Sblueswir1DEF("option-rom", HAS_ARG, QEMU_OPTION_option_rom, \ 2512ad96090aSBlue Swirl "-option-rom rom load a file, rom, into the option ROM space\n", 2513ad96090aSBlue Swirl QEMU_ARCH_ALL) 25145824d651Sblueswir1STEXI 25155824d651Sblueswir1@item -option-rom @var{file} 25166616b2adSStefan Weil@findex -option-rom 25175824d651Sblueswir1Load the contents of @var{file} as an option ROM. 25185824d651Sblueswir1This option is useful to load things like EtherBoot. 25195824d651Sblueswir1ETEXI 25205824d651Sblueswir1 25215824d651Sblueswir1DEF("clock", HAS_ARG, QEMU_OPTION_clock, \ 25225824d651Sblueswir1 "-clock force the use of the given methods for timer alarm.\n" \ 2523ad96090aSBlue Swirl " To see what timers are available use -clock ?\n", 2524ad96090aSBlue Swirl QEMU_ARCH_ALL) 25255824d651Sblueswir1STEXI 25265824d651Sblueswir1@item -clock @var{method} 25276616b2adSStefan Weil@findex -clock 25285824d651Sblueswir1Force the use of the given methods for timer alarm. To see what timers 25295824d651Sblueswir1are available use -clock ?. 25305824d651Sblueswir1ETEXI 25315824d651Sblueswir1 25321ed2fc1fSJan KiszkaHXCOMM Options deprecated by -rtc 2533ad96090aSBlue SwirlDEF("localtime", 0, QEMU_OPTION_localtime, "", QEMU_ARCH_ALL) 2534ad96090aSBlue SwirlDEF("startdate", HAS_ARG, QEMU_OPTION_startdate, "", QEMU_ARCH_ALL) 25355824d651Sblueswir1 25361ed2fc1fSJan KiszkaDEF("rtc", HAS_ARG, QEMU_OPTION_rtc, \ 253778808141SPaolo Bonzini "-rtc [base=utc|localtime|date][,clock=host|rt|vm][,driftfix=none|slew]\n" \ 2538ad96090aSBlue Swirl " set the RTC base and clock, enable drift fix for clock ticks (x86 only)\n", 2539ad96090aSBlue Swirl QEMU_ARCH_ALL) 25401ed2fc1fSJan Kiszka 25415824d651Sblueswir1STEXI 25425824d651Sblueswir1 25436875204cSJan Kiszka@item -rtc [base=utc|localtime|@var{date}][,clock=host|vm][,driftfix=none|slew] 25446616b2adSStefan Weil@findex -rtc 25451ed2fc1fSJan KiszkaSpecify @option{base} as @code{utc} or @code{localtime} to let the RTC start at the current 25461ed2fc1fSJan KiszkaUTC or local time, respectively. @code{localtime} is required for correct date in 25471ed2fc1fSJan KiszkaMS-DOS or Windows. To start at a specific point in time, provide @var{date} in the 25481ed2fc1fSJan Kiszkaformat @code{2006-06-17T16:01:21} or @code{2006-06-17}. The default base is UTC. 25491ed2fc1fSJan Kiszka 25506875204cSJan KiszkaBy default the RTC is driven by the host system time. This allows to use the 25516875204cSJan KiszkaRTC as accurate reference clock inside the guest, specifically if the host 25526875204cSJan Kiszkatime is smoothly following an accurate external reference clock, e.g. via NTP. 255378808141SPaolo BonziniIf you want to isolate the guest time from the host, you can set @option{clock} 255478808141SPaolo Bonzinito @code{rt} instead. To even prevent it from progressing during suspension, 255578808141SPaolo Bonziniyou can set it to @code{vm}. 25566875204cSJan Kiszka 25571ed2fc1fSJan KiszkaEnable @option{driftfix} (i386 targets only) if you experience time drift problems, 25581ed2fc1fSJan Kiszkaspecifically with Windows' ACPI HAL. This option will try to figure out how 25591ed2fc1fSJan Kiszkamany timer interrupts were not processed by the Windows guest and will 25601ed2fc1fSJan Kiszkare-inject them. 25615824d651Sblueswir1ETEXI 25625824d651Sblueswir1 25635824d651Sblueswir1DEF("icount", HAS_ARG, QEMU_OPTION_icount, \ 25645824d651Sblueswir1 "-icount [N|auto]\n" \ 2565bc14ca24Saliguori " enable virtual instruction counter with 2^N clock ticks per\n" \ 2566ad96090aSBlue Swirl " instruction\n", QEMU_ARCH_ALL) 25675824d651Sblueswir1STEXI 25684e257e5eSKevin Wolf@item -icount [@var{N}|auto] 25696616b2adSStefan Weil@findex -icount 25705824d651Sblueswir1Enable virtual instruction counter. The virtual cpu will execute one 25714e257e5eSKevin Wolfinstruction every 2^@var{N} ns of virtual time. If @code{auto} is specified 25725824d651Sblueswir1then the virtual cpu speed will be automatically adjusted to keep virtual 25735824d651Sblueswir1time within a few seconds of real time. 25745824d651Sblueswir1 25755824d651Sblueswir1Note that while this option can give deterministic behavior, it does not 25765824d651Sblueswir1provide cycle accurate emulation. Modern CPUs contain superscalar out of 25775824d651Sblueswir1order cores with complex cache hierarchies. The number of instructions 25785824d651Sblueswir1executed often has little or no correlation with actual performance. 25795824d651Sblueswir1ETEXI 25805824d651Sblueswir1 25819dd986ccSRichard W.M. JonesDEF("watchdog", HAS_ARG, QEMU_OPTION_watchdog, \ 25829dd986ccSRichard W.M. Jones "-watchdog i6300esb|ib700\n" \ 2583ad96090aSBlue Swirl " enable virtual hardware watchdog [default=none]\n", 2584ad96090aSBlue Swirl QEMU_ARCH_ALL) 25859dd986ccSRichard W.M. JonesSTEXI 25869dd986ccSRichard W.M. Jones@item -watchdog @var{model} 25876616b2adSStefan Weil@findex -watchdog 25889dd986ccSRichard W.M. JonesCreate a virtual hardware watchdog device. Once enabled (by a guest 25899dd986ccSRichard W.M. Jonesaction), the watchdog must be periodically polled by an agent inside 25909dd986ccSRichard W.M. Jonesthe guest or else the guest will be restarted. 25919dd986ccSRichard W.M. Jones 25929dd986ccSRichard W.M. JonesThe @var{model} is the model of hardware watchdog to emulate. Choices 25939dd986ccSRichard W.M. Jonesfor model are: @code{ib700} (iBASE 700) which is a very simple ISA 25949dd986ccSRichard W.M. Joneswatchdog with a single timer, or @code{i6300esb} (Intel 6300ESB I/O 25959dd986ccSRichard W.M. Jonescontroller hub) which is a much more featureful PCI-based dual-timer 25969dd986ccSRichard W.M. Joneswatchdog. Choose a model for which your guest has drivers. 25979dd986ccSRichard W.M. Jones 25989dd986ccSRichard W.M. JonesUse @code{-watchdog ?} to list available hardware models. Only one 25999dd986ccSRichard W.M. Joneswatchdog can be enabled for a guest. 26009dd986ccSRichard W.M. JonesETEXI 26019dd986ccSRichard W.M. Jones 26029dd986ccSRichard W.M. JonesDEF("watchdog-action", HAS_ARG, QEMU_OPTION_watchdog_action, \ 26039dd986ccSRichard W.M. Jones "-watchdog-action reset|shutdown|poweroff|pause|debug|none\n" \ 2604ad96090aSBlue Swirl " action when watchdog fires [default=reset]\n", 2605ad96090aSBlue Swirl QEMU_ARCH_ALL) 26069dd986ccSRichard W.M. JonesSTEXI 26079dd986ccSRichard W.M. Jones@item -watchdog-action @var{action} 26089dd986ccSRichard W.M. Jones 26099dd986ccSRichard W.M. JonesThe @var{action} controls what QEMU will do when the watchdog timer 26109dd986ccSRichard W.M. Jonesexpires. 26119dd986ccSRichard W.M. JonesThe default is 26129dd986ccSRichard W.M. Jones@code{reset} (forcefully reset the guest). 26139dd986ccSRichard W.M. JonesOther possible actions are: 26149dd986ccSRichard W.M. Jones@code{shutdown} (attempt to gracefully shutdown the guest), 26159dd986ccSRichard W.M. Jones@code{poweroff} (forcefully poweroff the guest), 26169dd986ccSRichard W.M. Jones@code{pause} (pause the guest), 26179dd986ccSRichard W.M. Jones@code{debug} (print a debug message and continue), or 26189dd986ccSRichard W.M. Jones@code{none} (do nothing). 26199dd986ccSRichard W.M. Jones 26209dd986ccSRichard W.M. JonesNote that the @code{shutdown} action requires that the guest responds 26219dd986ccSRichard W.M. Jonesto ACPI signals, which it may not be able to do in the sort of 26229dd986ccSRichard W.M. Jonessituations where the watchdog would have expired, and thus 26239dd986ccSRichard W.M. Jones@code{-watchdog-action shutdown} is not recommended for production use. 26249dd986ccSRichard W.M. Jones 26259dd986ccSRichard W.M. JonesExamples: 26269dd986ccSRichard W.M. Jones 26279dd986ccSRichard W.M. Jones@table @code 26289dd986ccSRichard W.M. Jones@item -watchdog i6300esb -watchdog-action pause 26299dd986ccSRichard W.M. Jones@item -watchdog ib700 26309dd986ccSRichard W.M. Jones@end table 26319dd986ccSRichard W.M. JonesETEXI 26329dd986ccSRichard W.M. Jones 26335824d651Sblueswir1DEF("echr", HAS_ARG, QEMU_OPTION_echr, \ 2634ad96090aSBlue Swirl "-echr chr set terminal escape character instead of ctrl-a\n", 2635ad96090aSBlue Swirl QEMU_ARCH_ALL) 26365824d651Sblueswir1STEXI 26375824d651Sblueswir1 26384e257e5eSKevin Wolf@item -echr @var{numeric_ascii_value} 26396616b2adSStefan Weil@findex -echr 26405824d651Sblueswir1Change the escape character used for switching to the monitor when using 26415824d651Sblueswir1monitor and serial sharing. The default is @code{0x01} when using the 26425824d651Sblueswir1@code{-nographic} option. @code{0x01} is equal to pressing 26435824d651Sblueswir1@code{Control-a}. You can select a different character from the ascii 26445824d651Sblueswir1control keys where 1 through 26 map to Control-a through Control-z. For 26455824d651Sblueswir1instance you could use the either of the following to change the escape 26465824d651Sblueswir1character to Control-t. 26475824d651Sblueswir1@table @code 26485824d651Sblueswir1@item -echr 0x14 26495824d651Sblueswir1@item -echr 20 26505824d651Sblueswir1@end table 26515824d651Sblueswir1ETEXI 26525824d651Sblueswir1 26535824d651Sblueswir1DEF("virtioconsole", HAS_ARG, QEMU_OPTION_virtiocon, \ 26545824d651Sblueswir1 "-virtioconsole c\n" \ 2655ad96090aSBlue Swirl " set virtio console\n", QEMU_ARCH_ALL) 26565824d651Sblueswir1STEXI 26575824d651Sblueswir1@item -virtioconsole @var{c} 26586616b2adSStefan Weil@findex -virtioconsole 26595824d651Sblueswir1Set virtio console. 266098b19252SAmit Shah 266198b19252SAmit ShahThis option is maintained for backward compatibility. 266298b19252SAmit Shah 266398b19252SAmit ShahPlease use @code{-device virtconsole} for the new way of invocation. 26645824d651Sblueswir1ETEXI 26655824d651Sblueswir1 26665824d651Sblueswir1DEF("show-cursor", 0, QEMU_OPTION_show_cursor, \ 2667ad96090aSBlue Swirl "-show-cursor show cursor\n", QEMU_ARCH_ALL) 26685824d651Sblueswir1STEXI 266995d5f08bSStefan Weil@item -show-cursor 26706616b2adSStefan Weil@findex -show-cursor 267195d5f08bSStefan WeilShow cursor. 26725824d651Sblueswir1ETEXI 26735824d651Sblueswir1 26745824d651Sblueswir1DEF("tb-size", HAS_ARG, QEMU_OPTION_tb_size, \ 2675ad96090aSBlue Swirl "-tb-size n set TB size\n", QEMU_ARCH_ALL) 26765824d651Sblueswir1STEXI 267795d5f08bSStefan Weil@item -tb-size @var{n} 26786616b2adSStefan Weil@findex -tb-size 267995d5f08bSStefan WeilSet TB size. 26805824d651Sblueswir1ETEXI 26815824d651Sblueswir1 26825824d651Sblueswir1DEF("incoming", HAS_ARG, QEMU_OPTION_incoming, \ 2683ad96090aSBlue Swirl "-incoming p prepare for incoming migration, listen on port p\n", 2684ad96090aSBlue Swirl QEMU_ARCH_ALL) 26855824d651Sblueswir1STEXI 268695d5f08bSStefan Weil@item -incoming @var{port} 26876616b2adSStefan Weil@findex -incoming 268895d5f08bSStefan WeilPrepare for incoming migration, listen on @var{port}. 26895824d651Sblueswir1ETEXI 26905824d651Sblueswir1 2691d8c208ddSGerd HoffmannDEF("nodefaults", 0, QEMU_OPTION_nodefaults, \ 2692ad96090aSBlue Swirl "-nodefaults don't create default devices\n", QEMU_ARCH_ALL) 2693d8c208ddSGerd HoffmannSTEXI 26943dbf2c7fSStefan Weil@item -nodefaults 26956616b2adSStefan Weil@findex -nodefaults 269666c19bf1SMichal NovotnyDon't create default devices. Normally, QEMU sets the default devices like serial 269766c19bf1SMichal Novotnyport, parallel port, virtual console, monitor device, VGA adapter, floppy and 269866c19bf1SMichal NovotnyCD-ROM drive and others. The @code{-nodefaults} option will disable all those 269966c19bf1SMichal Novotnydefault devices. 2700d8c208ddSGerd HoffmannETEXI 2701d8c208ddSGerd Hoffmann 27025824d651Sblueswir1#ifndef _WIN32 27035824d651Sblueswir1DEF("chroot", HAS_ARG, QEMU_OPTION_chroot, \ 2704ad96090aSBlue Swirl "-chroot dir chroot to dir just before starting the VM\n", 2705ad96090aSBlue Swirl QEMU_ARCH_ALL) 27065824d651Sblueswir1#endif 27075824d651Sblueswir1STEXI 27084e257e5eSKevin Wolf@item -chroot @var{dir} 27096616b2adSStefan Weil@findex -chroot 27105824d651Sblueswir1Immediately before starting guest execution, chroot to the specified 27115824d651Sblueswir1directory. Especially useful in combination with -runas. 27125824d651Sblueswir1ETEXI 27135824d651Sblueswir1 27145824d651Sblueswir1#ifndef _WIN32 27155824d651Sblueswir1DEF("runas", HAS_ARG, QEMU_OPTION_runas, \ 2716ad96090aSBlue Swirl "-runas user change to user id user just before starting the VM\n", 2717ad96090aSBlue Swirl QEMU_ARCH_ALL) 27185824d651Sblueswir1#endif 27195824d651Sblueswir1STEXI 27204e257e5eSKevin Wolf@item -runas @var{user} 27216616b2adSStefan Weil@findex -runas 27225824d651Sblueswir1Immediately before starting guest execution, drop root privileges, switching 27235824d651Sblueswir1to the specified user. 27245824d651Sblueswir1ETEXI 27255824d651Sblueswir1 27265824d651Sblueswir1DEF("prom-env", HAS_ARG, QEMU_OPTION_prom_env, 27275824d651Sblueswir1 "-prom-env variable=value\n" 2728ad96090aSBlue Swirl " set OpenBIOS nvram variables\n", 2729ad96090aSBlue Swirl QEMU_ARCH_PPC | QEMU_ARCH_SPARC) 273095d5f08bSStefan WeilSTEXI 273195d5f08bSStefan Weil@item -prom-env @var{variable}=@var{value} 27326616b2adSStefan Weil@findex -prom-env 273395d5f08bSStefan WeilSet OpenBIOS nvram @var{variable} to given @var{value} (PPC, SPARC only). 273495d5f08bSStefan WeilETEXI 27355824d651Sblueswir1DEF("semihosting", 0, QEMU_OPTION_semihosting, 27361ddeaa5dSMax Filippov "-semihosting semihosting mode\n", QEMU_ARCH_ARM | QEMU_ARCH_M68K | QEMU_ARCH_XTENSA) 273795d5f08bSStefan WeilSTEXI 273895d5f08bSStefan Weil@item -semihosting 27396616b2adSStefan Weil@findex -semihosting 27401ddeaa5dSMax FilippovSemihosting mode (ARM, M68K, Xtensa only). 274195d5f08bSStefan WeilETEXI 27425824d651Sblueswir1DEF("old-param", 0, QEMU_OPTION_old_param, 2743ad96090aSBlue Swirl "-old-param old param mode\n", QEMU_ARCH_ARM) 274495d5f08bSStefan WeilSTEXI 274595d5f08bSStefan Weil@item -old-param 27466616b2adSStefan Weil@findex -old-param (ARM) 274795d5f08bSStefan WeilOld param mode (ARM only). 274895d5f08bSStefan WeilETEXI 274995d5f08bSStefan Weil 27507d76ad4fSEduardo OtuboDEF("sandbox", HAS_ARG, QEMU_OPTION_sandbox, \ 27517d76ad4fSEduardo Otubo "-sandbox <arg> Enable seccomp mode 2 system call filter (default 'off').\n", 27527d76ad4fSEduardo Otubo QEMU_ARCH_ALL) 27537d76ad4fSEduardo OtuboSTEXI 27547d76ad4fSEduardo Otubo@item -sandbox 27557d76ad4fSEduardo Otubo@findex -sandbox 27567d76ad4fSEduardo OtuboEnable Seccomp mode 2 system call filter. 'on' will enable syscall filtering and 'off' will 27577d76ad4fSEduardo Otubodisable it. The default is 'off'. 27587d76ad4fSEduardo OtuboETEXI 27597d76ad4fSEduardo Otubo 2760715a664aSGerd HoffmannDEF("readconfig", HAS_ARG, QEMU_OPTION_readconfig, 2761ad96090aSBlue Swirl "-readconfig <file>\n", QEMU_ARCH_ALL) 27623dbf2c7fSStefan WeilSTEXI 27633dbf2c7fSStefan Weil@item -readconfig @var{file} 27646616b2adSStefan Weil@findex -readconfig 2765ed24cfacSMichal NovotnyRead device configuration from @var{file}. This approach is useful when you want to spawn 2766ed24cfacSMichal NovotnyQEMU process with many command line options but you don't want to exceed the command line 2767ed24cfacSMichal Novotnycharacter limit. 27683dbf2c7fSStefan WeilETEXI 2769715a664aSGerd HoffmannDEF("writeconfig", HAS_ARG, QEMU_OPTION_writeconfig, 2770715a664aSGerd Hoffmann "-writeconfig <file>\n" 2771ad96090aSBlue Swirl " read/write config file\n", QEMU_ARCH_ALL) 27723dbf2c7fSStefan WeilSTEXI 27733dbf2c7fSStefan Weil@item -writeconfig @var{file} 27746616b2adSStefan Weil@findex -writeconfig 2775ed24cfacSMichal NovotnyWrite device configuration to @var{file}. The @var{file} can be either filename to save 2776ed24cfacSMichal Novotnycommand line and device configuration into file or dash @code{-}) character to print the 2777ed24cfacSMichal Novotnyoutput to stdout. This can be later used as input file for @code{-readconfig} option. 27783dbf2c7fSStefan WeilETEXI 2779292444cbSAnthony LiguoriDEF("nodefconfig", 0, QEMU_OPTION_nodefconfig, 2780292444cbSAnthony Liguori "-nodefconfig\n" 2781ad96090aSBlue Swirl " do not load default config files at startup\n", 2782ad96090aSBlue Swirl QEMU_ARCH_ALL) 2783292444cbSAnthony LiguoriSTEXI 2784292444cbSAnthony Liguori@item -nodefconfig 27856616b2adSStefan Weil@findex -nodefconfig 2786f29a5614SEduardo HabkostNormally QEMU loads configuration files from @var{sysconfdir} and @var{datadir} at startup. 2787f29a5614SEduardo HabkostThe @code{-nodefconfig} option will prevent QEMU from loading any of those config files. 2788f29a5614SEduardo HabkostETEXI 2789f29a5614SEduardo HabkostDEF("no-user-config", 0, QEMU_OPTION_nouserconfig, 2790f29a5614SEduardo Habkost "-no-user-config\n" 2791f29a5614SEduardo Habkost " do not load user-provided config files at startup\n", 2792f29a5614SEduardo Habkost QEMU_ARCH_ALL) 2793f29a5614SEduardo HabkostSTEXI 2794f29a5614SEduardo Habkost@item -no-user-config 2795f29a5614SEduardo Habkost@findex -no-user-config 2796f29a5614SEduardo HabkostThe @code{-no-user-config} option makes QEMU not load any of the user-provided 2797f29a5614SEduardo Habkostconfig files on @var{sysconfdir}, but won't make it skip the QEMU-provided config 2798f29a5614SEduardo Habkostfiles from @var{datadir}. 2799292444cbSAnthony LiguoriETEXI 2800ab6540d5SPrerna SaxenaDEF("trace", HAS_ARG, QEMU_OPTION_trace, 280123d15e86SLluís "-trace [events=<file>][,file=<file>]\n" 280223d15e86SLluís " specify tracing options\n", 2803ab6540d5SPrerna Saxena QEMU_ARCH_ALL) 2804ab6540d5SPrerna SaxenaSTEXI 280523d15e86SLluísHXCOMM This line is not accurate, as some sub-options are backend-specific but 280623d15e86SLluísHXCOMM HX does not support conditional compilation of text. 280723d15e86SLluís@item -trace [events=@var{file}][,file=@var{file}] 2808ab6540d5SPrerna Saxena@findex -trace 2809e4858974SLluís 281023d15e86SLluísSpecify tracing options. 281123d15e86SLluís 281223d15e86SLluís@table @option 281323d15e86SLluís@item events=@var{file} 281423d15e86SLluísImmediately enable events listed in @var{file}. 281523d15e86SLluísThe file must contain one event name (as listed in the @var{trace-events} file) 281623d15e86SLluísper line. 2817c1ba4e0bSStefan WeilThis option is only available if QEMU has been compiled with 2818c1ba4e0bSStefan Weileither @var{simple} or @var{stderr} tracing backend. 281923d15e86SLluís@item file=@var{file} 282023d15e86SLluísLog output traces to @var{file}. 282123d15e86SLluís 2822c1ba4e0bSStefan WeilThis option is only available if QEMU has been compiled with 2823c1ba4e0bSStefan Weilthe @var{simple} tracing backend. 282423d15e86SLluís@end table 2825ab6540d5SPrerna SaxenaETEXI 28263dbf2c7fSStefan Weil 2827c7f0f3b1SAnthony LiguoriDEF("qtest", HAS_ARG, QEMU_OPTION_qtest, 2828c7f0f3b1SAnthony Liguori "-qtest CHR specify tracing options\n", 2829c7f0f3b1SAnthony Liguori QEMU_ARCH_ALL) 2830c7f0f3b1SAnthony Liguori 2831c7f0f3b1SAnthony LiguoriDEF("qtest-log", HAS_ARG, QEMU_OPTION_qtest_log, 2832c7f0f3b1SAnthony Liguori "-qtest-log LOG specify tracing options\n", 2833c7f0f3b1SAnthony Liguori QEMU_ARCH_ALL) 2834c7f0f3b1SAnthony Liguori 28350f66998fSPaul Moore#ifdef __linux__ 28360f66998fSPaul MooreDEF("enable-fips", 0, QEMU_OPTION_enablefips, 28370f66998fSPaul Moore "-enable-fips enable FIPS 140-2 compliance\n", 28380f66998fSPaul Moore QEMU_ARCH_ALL) 28390f66998fSPaul Moore#endif 28400f66998fSPaul MooreSTEXI 28410f66998fSPaul Moore@item -enable-fips 28420f66998fSPaul Moore@findex -enable-fips 28430f66998fSPaul MooreEnable FIPS 140-2 compliance mode. 28440f66998fSPaul MooreETEXI 28450f66998fSPaul Moore 28463dbf2c7fSStefan WeilHXCOMM This is the last statement. Insert new options before this line! 28473dbf2c7fSStefan WeilSTEXI 28483dbf2c7fSStefan Weil@end table 28493dbf2c7fSStefan WeilETEXI 2850