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 45824d651Sblueswir1HXCOMM DEF(option, HAS_ARG/0, opt_enum, opt_help) is used to construct 55824d651Sblueswir1HXCOMM option structures, enums and help message. 65824d651Sblueswir1HXCOMM HXCOMM can be used for comments, discarded from both texi and C 75824d651Sblueswir1 85824d651Sblueswir1DEFHEADING(Standard options:) 95824d651Sblueswir1STEXI 105824d651Sblueswir1@table @option 115824d651Sblueswir1ETEXI 125824d651Sblueswir1 135824d651Sblueswir1DEF("help", 0, QEMU_OPTION_h, 145824d651Sblueswir1 "-h or -help display this help and exit\n") 155824d651Sblueswir1STEXI 165824d651Sblueswir1@item -h 175824d651Sblueswir1Display help and exit 185824d651Sblueswir1ETEXI 195824d651Sblueswir1 209bd7e6d9SpbrookDEF("version", 0, QEMU_OPTION_version, 219bd7e6d9Spbrook "-version display version information and exit\n") 229bd7e6d9SpbrookSTEXI 239bd7e6d9Spbrook@item -version 249bd7e6d9SpbrookDisplay version information and exit 259bd7e6d9SpbrookETEXI 269bd7e6d9Spbrook 275824d651Sblueswir1DEF("M", HAS_ARG, QEMU_OPTION_M, 285824d651Sblueswir1 "-M machine select emulated machine (-M ? for list)\n") 295824d651Sblueswir1STEXI 305824d651Sblueswir1@item -M @var{machine} 315824d651Sblueswir1Select the emulated @var{machine} (@code{-M ?} for list) 325824d651Sblueswir1ETEXI 335824d651Sblueswir1 345824d651Sblueswir1DEF("cpu", HAS_ARG, QEMU_OPTION_cpu, 355824d651Sblueswir1 "-cpu cpu select CPU (-cpu ? for list)\n") 365824d651Sblueswir1STEXI 375824d651Sblueswir1@item -cpu @var{model} 385824d651Sblueswir1Select CPU model (-cpu ? for list and additional feature selection) 395824d651Sblueswir1ETEXI 405824d651Sblueswir1 415824d651Sblueswir1DEF("smp", HAS_ARG, QEMU_OPTION_smp, 4258a04db1SAndre Przywara "-smp n[,maxcpus=cpus][,cores=cores][,threads=threads][,sockets=sockets]\n" 436be68d7eSJes Sorensen " set the number of CPUs to 'n' [default=1]\n" 446be68d7eSJes Sorensen " maxcpus= maximum number of total cpus, including\n" 45ca1a8a06SBruce Rogers " offline CPUs for hotplug, etc\n" 4658a04db1SAndre Przywara " cores= number of CPU cores on one socket\n" 4758a04db1SAndre Przywara " threads= number of threads on one CPU core\n" 4858a04db1SAndre Przywara " sockets= number of discrete sockets in the system\n") 495824d651Sblueswir1STEXI 5058a04db1SAndre Przywara@item -smp @var{n}[,cores=@var{cores}][,threads=@var{threads}][,sockets=@var{sockets}][,maxcpus=@var{maxcpus}] 515824d651Sblueswir1Simulate an SMP system with @var{n} CPUs. On the PC target, up to 255 525824d651Sblueswir1CPUs are supported. On Sparc32 target, Linux limits the number of usable CPUs 535824d651Sblueswir1to 4. 5458a04db1SAndre PrzywaraFor the PC target, the number of @var{cores} per socket, the number 5558a04db1SAndre Przywaraof @var{threads} per cores and the total number of @var{sockets} can be 5658a04db1SAndre Przywaraspecified. Missing values will be computed. If any on the three values is 5758a04db1SAndre Przywaragiven, the total number of CPUs @var{n} can be omitted. @var{maxcpus} 5858a04db1SAndre Przywaraspecifies the maximum number of hotpluggable CPUs. 595824d651Sblueswir1ETEXI 605824d651Sblueswir1 61268a362cSaliguoriDEF("numa", HAS_ARG, QEMU_OPTION_numa, 62268a362cSaliguori "-numa node[,mem=size][,cpus=cpu[-cpu]][,nodeid=node]\n") 63268a362cSaliguoriSTEXI 64268a362cSaliguori@item -numa @var{opts} 65268a362cSaliguoriSimulate a multi node NUMA system. If mem and cpus are omitted, resources 66268a362cSaliguoriare split equally. 67268a362cSaliguoriETEXI 68268a362cSaliguori 695824d651Sblueswir1DEF("fda", HAS_ARG, QEMU_OPTION_fda, 705824d651Sblueswir1 "-fda/-fdb file use 'file' as floppy disk 0/1 image\n") 715824d651Sblueswir1DEF("fdb", HAS_ARG, QEMU_OPTION_fdb, "") 725824d651Sblueswir1STEXI 735824d651Sblueswir1@item -fda @var{file} 745824d651Sblueswir1@item -fdb @var{file} 755824d651Sblueswir1Use @var{file} as floppy disk 0/1 image (@pxref{disk_images}). You can 765824d651Sblueswir1use the host floppy by using @file{/dev/fd0} as filename (@pxref{host_drives}). 775824d651Sblueswir1ETEXI 785824d651Sblueswir1 795824d651Sblueswir1DEF("hda", HAS_ARG, QEMU_OPTION_hda, 805824d651Sblueswir1 "-hda/-hdb file use 'file' as IDE hard disk 0/1 image\n") 815824d651Sblueswir1DEF("hdb", HAS_ARG, QEMU_OPTION_hdb, "") 825824d651Sblueswir1DEF("hdc", HAS_ARG, QEMU_OPTION_hdc, 835824d651Sblueswir1 "-hdc/-hdd file use 'file' as IDE hard disk 2/3 image\n") 845824d651Sblueswir1DEF("hdd", HAS_ARG, QEMU_OPTION_hdd, "") 855824d651Sblueswir1STEXI 865824d651Sblueswir1@item -hda @var{file} 875824d651Sblueswir1@item -hdb @var{file} 885824d651Sblueswir1@item -hdc @var{file} 895824d651Sblueswir1@item -hdd @var{file} 905824d651Sblueswir1Use @var{file} as hard disk 0, 1, 2 or 3 image (@pxref{disk_images}). 915824d651Sblueswir1ETEXI 925824d651Sblueswir1 935824d651Sblueswir1DEF("cdrom", HAS_ARG, QEMU_OPTION_cdrom, 945824d651Sblueswir1 "-cdrom file use 'file' as IDE cdrom image (cdrom is ide1 master)\n") 955824d651Sblueswir1STEXI 965824d651Sblueswir1@item -cdrom @var{file} 975824d651Sblueswir1Use @var{file} as CD-ROM image (you cannot use @option{-hdc} and 985824d651Sblueswir1@option{-cdrom} at the same time). You can use the host CD-ROM by 995824d651Sblueswir1using @file{/dev/cdrom} as filename (@pxref{host_drives}). 1005824d651Sblueswir1ETEXI 1015824d651Sblueswir1 1025824d651Sblueswir1DEF("drive", HAS_ARG, QEMU_OPTION_drive, 1035824d651Sblueswir1 "-drive [file=file][,if=type][,bus=n][,unit=m][,media=d][,index=i]\n" 1045824d651Sblueswir1 " [,cyls=c,heads=h,secs=s[,trans=t]][,snapshot=on|off]\n" 1055824d651Sblueswir1 " [,cache=writethrough|writeback|none][,format=f][,serial=s]\n" 1063f3ed593SNaphtali Sprei " [,addr=A][,id=name][,aio=threads|native][,readonly=on|off]\n" 1075824d651Sblueswir1 " use 'file' as a drive image\n") 108d058fe03SGerd HoffmannDEF("set", HAS_ARG, QEMU_OPTION_set, 109d058fe03SGerd Hoffmann "-set group.id.arg=value\n" 110d058fe03SGerd Hoffmann " set <arg> parameter for item <id> of type <group>\n" 111d058fe03SGerd Hoffmann " i.e. -set drive.$id.file=/path/to/image\n") 112d0fef6fbSGerd HoffmannDEF("global", HAS_ARG, QEMU_OPTION_global, 113d0fef6fbSGerd Hoffmann "-global driver.property=value\n" 114d0fef6fbSGerd Hoffmann " set a global default for a driver property\n") 1155824d651Sblueswir1STEXI 1165824d651Sblueswir1@item -drive @var{option}[,@var{option}[,@var{option}[,...]]] 1175824d651Sblueswir1 1185824d651Sblueswir1Define a new drive. Valid options are: 1195824d651Sblueswir1 120b3f046c2SKevin Wolf@table @option 1215824d651Sblueswir1@item file=@var{file} 1225824d651Sblueswir1This option defines which disk image (@pxref{disk_images}) to use with 1235824d651Sblueswir1this drive. If the filename contains comma, you must double it 1245824d651Sblueswir1(for instance, "file=my,,file" to use file "my,file"). 1255824d651Sblueswir1@item if=@var{interface} 1265824d651Sblueswir1This option defines on which type on interface the drive is connected. 1275824d651Sblueswir1Available types are: ide, scsi, sd, mtd, floppy, pflash, virtio. 1285824d651Sblueswir1@item bus=@var{bus},unit=@var{unit} 1295824d651Sblueswir1These options define where is connected the drive by defining the bus number and 1305824d651Sblueswir1the unit id. 1315824d651Sblueswir1@item index=@var{index} 1325824d651Sblueswir1This option defines where is connected the drive by using an index in the list 1335824d651Sblueswir1of available connectors of a given interface type. 1345824d651Sblueswir1@item media=@var{media} 1355824d651Sblueswir1This option defines the type of the media: disk or cdrom. 1365824d651Sblueswir1@item cyls=@var{c},heads=@var{h},secs=@var{s}[,trans=@var{t}] 1375824d651Sblueswir1These options have the same definition as they have in @option{-hdachs}. 1385824d651Sblueswir1@item snapshot=@var{snapshot} 1395824d651Sblueswir1@var{snapshot} is "on" or "off" and allows to enable snapshot for given drive (see @option{-snapshot}). 1405824d651Sblueswir1@item cache=@var{cache} 1415824d651Sblueswir1@var{cache} is "none", "writeback", or "writethrough" and controls how the host cache is used to access block data. 1425c6c3a6cSChristoph Hellwig@item aio=@var{aio} 1435c6c3a6cSChristoph Hellwig@var{aio} is "threads", or "native" and selects between pthread based disk I/O and native Linux AIO. 1445824d651Sblueswir1@item format=@var{format} 1455824d651Sblueswir1Specify which disk @var{format} will be used rather than detecting 1465824d651Sblueswir1the format. Can be used to specifiy format=raw to avoid interpreting 1475824d651Sblueswir1an untrusted format header. 1485824d651Sblueswir1@item serial=@var{serial} 1495824d651Sblueswir1This option specifies the serial number to assign to the device. 150c2cc47a4SMarkus Armbruster@item addr=@var{addr} 151c2cc47a4SMarkus ArmbrusterSpecify the controller's PCI address (if=virtio only). 1525824d651Sblueswir1@end table 1535824d651Sblueswir1 1545824d651Sblueswir1By default, writethrough caching is used for all block device. This means that 1555824d651Sblueswir1the host page cache will be used to read and write data but write notification 1565824d651Sblueswir1will be sent to the guest only when the data has been reported as written by 1575824d651Sblueswir1the storage subsystem. 1585824d651Sblueswir1 1595824d651Sblueswir1Writeback caching will report data writes as completed as soon as the data is 1605824d651Sblueswir1present in the host page cache. This is safe as long as you trust your host. 1615824d651Sblueswir1If your host crashes or loses power, then the guest may experience data 1625824d651Sblueswir1corruption. When using the @option{-snapshot} option, writeback caching is 1635824d651Sblueswir1used by default. 1645824d651Sblueswir1 165c304d317SAurelien JarnoThe host page cache can be avoided entirely with @option{cache=none}. This will 1665824d651Sblueswir1attempt to do disk IO directly to the guests memory. QEMU may still perform 1675824d651Sblueswir1an internal copy of the data. 1685824d651Sblueswir1 1695824d651Sblueswir1Some block drivers perform badly with @option{cache=writethrough}, most notably, 1705824d651Sblueswir1qcow2. If performance is more important than correctness, 1710aa217e4SKevin Wolf@option{cache=writeback} should be used with qcow2. 1725824d651Sblueswir1 1735824d651Sblueswir1Instead of @option{-cdrom} you can use: 1745824d651Sblueswir1@example 1755824d651Sblueswir1qemu -drive file=file,index=2,media=cdrom 1765824d651Sblueswir1@end example 1775824d651Sblueswir1 1785824d651Sblueswir1Instead of @option{-hda}, @option{-hdb}, @option{-hdc}, @option{-hdd}, you can 1795824d651Sblueswir1use: 1805824d651Sblueswir1@example 1815824d651Sblueswir1qemu -drive file=file,index=0,media=disk 1825824d651Sblueswir1qemu -drive file=file,index=1,media=disk 1835824d651Sblueswir1qemu -drive file=file,index=2,media=disk 1845824d651Sblueswir1qemu -drive file=file,index=3,media=disk 1855824d651Sblueswir1@end example 1865824d651Sblueswir1 1875824d651Sblueswir1You can connect a CDROM to the slave of ide0: 1885824d651Sblueswir1@example 1895824d651Sblueswir1qemu -drive file=file,if=ide,index=1,media=cdrom 1905824d651Sblueswir1@end example 1915824d651Sblueswir1 1925824d651Sblueswir1If you don't specify the "file=" argument, you define an empty drive: 1935824d651Sblueswir1@example 1945824d651Sblueswir1qemu -drive if=ide,index=1,media=cdrom 1955824d651Sblueswir1@end example 1965824d651Sblueswir1 1975824d651Sblueswir1You can connect a SCSI disk with unit ID 6 on the bus #0: 1985824d651Sblueswir1@example 1995824d651Sblueswir1qemu -drive file=file,if=scsi,bus=0,unit=6 2005824d651Sblueswir1@end example 2015824d651Sblueswir1 2025824d651Sblueswir1Instead of @option{-fda}, @option{-fdb}, you can use: 2035824d651Sblueswir1@example 2045824d651Sblueswir1qemu -drive file=file,index=0,if=floppy 2055824d651Sblueswir1qemu -drive file=file,index=1,if=floppy 2065824d651Sblueswir1@end example 2075824d651Sblueswir1 2085824d651Sblueswir1By default, @var{interface} is "ide" and @var{index} is automatically 2095824d651Sblueswir1incremented: 2105824d651Sblueswir1@example 2115824d651Sblueswir1qemu -drive file=a -drive file=b" 2125824d651Sblueswir1@end example 2135824d651Sblueswir1is interpreted like: 2145824d651Sblueswir1@example 2155824d651Sblueswir1qemu -hda a -hdb b 2165824d651Sblueswir1@end example 2175824d651Sblueswir1ETEXI 2185824d651Sblueswir1 2195824d651Sblueswir1DEF("mtdblock", HAS_ARG, QEMU_OPTION_mtdblock, 2205824d651Sblueswir1 "-mtdblock file use 'file' as on-board Flash memory image\n") 2215824d651Sblueswir1STEXI 2225824d651Sblueswir1 2234e257e5eSKevin Wolf@item -mtdblock @var{file} 2244e257e5eSKevin WolfUse @var{file} as on-board Flash memory image. 2255824d651Sblueswir1ETEXI 2265824d651Sblueswir1 2275824d651Sblueswir1DEF("sd", HAS_ARG, QEMU_OPTION_sd, 2285824d651Sblueswir1 "-sd file use 'file' as SecureDigital card image\n") 2295824d651Sblueswir1STEXI 2304e257e5eSKevin Wolf@item -sd @var{file} 2314e257e5eSKevin WolfUse @var{file} as SecureDigital card image. 2325824d651Sblueswir1ETEXI 2335824d651Sblueswir1 2345824d651Sblueswir1DEF("pflash", HAS_ARG, QEMU_OPTION_pflash, 2355824d651Sblueswir1 "-pflash file use 'file' as a parallel flash image\n") 2365824d651Sblueswir1STEXI 2374e257e5eSKevin Wolf@item -pflash @var{file} 2384e257e5eSKevin WolfUse @var{file} as a parallel flash image. 2395824d651Sblueswir1ETEXI 2405824d651Sblueswir1 2415824d651Sblueswir1DEF("boot", HAS_ARG, QEMU_OPTION_boot, 2422221dde5SJan Kiszka "-boot [order=drives][,once=drives][,menu=on|off]\n" 2432221dde5SJan Kiszka " 'drives': floppy (a), hard disk (c), CD-ROM (d), network (n)\n") 2445824d651Sblueswir1STEXI 2452221dde5SJan Kiszka@item -boot [order=@var{drives}][,once=@var{drives}][,menu=on|off] 2462221dde5SJan Kiszka 2472221dde5SJan KiszkaSpecify boot order @var{drives} as a string of drive letters. Valid 2482221dde5SJan Kiszkadrive letters depend on the target achitecture. The x86 PC uses: a, b 2492221dde5SJan Kiszka(floppy 1 and 2), c (first hard disk), d (first CD-ROM), n-p (Etherboot 2502221dde5SJan Kiszkafrom network adapter 1-4), hard disk boot is the default. To apply a 2512221dde5SJan Kiszkaparticular boot order only on the first startup, specify it via 2522221dde5SJan Kiszka@option{once}. 2532221dde5SJan Kiszka 2542221dde5SJan KiszkaInteractive boot menus/prompts can be enabled via @option{menu=on} as far 2552221dde5SJan Kiszkaas firmware/BIOS supports them. The default is non-interactive boot. 2562221dde5SJan Kiszka 2572221dde5SJan Kiszka@example 2582221dde5SJan Kiszka# try to boot from network first, then from hard disk 2592221dde5SJan Kiszkaqemu -boot order=nc 2602221dde5SJan Kiszka# boot from CD-ROM first, switch back to default order after reboot 2612221dde5SJan Kiszkaqemu -boot once=d 2622221dde5SJan Kiszka@end example 2632221dde5SJan Kiszka 2642221dde5SJan KiszkaNote: The legacy format '-boot @var{drives}' is still supported but its 2652221dde5SJan Kiszkause is discouraged as it may be removed from future versions. 2665824d651Sblueswir1ETEXI 2675824d651Sblueswir1 2685824d651Sblueswir1DEF("snapshot", 0, QEMU_OPTION_snapshot, 2695824d651Sblueswir1 "-snapshot write to temporary files instead of disk image files\n") 2705824d651Sblueswir1STEXI 2715824d651Sblueswir1@item -snapshot 2725824d651Sblueswir1Write to temporary files instead of disk image files. In this case, 2735824d651Sblueswir1the raw disk image you use is not written back. You can however force 2745824d651Sblueswir1the write back by pressing @key{C-a s} (@pxref{disk_images}). 2755824d651Sblueswir1ETEXI 2765824d651Sblueswir1 2775824d651Sblueswir1DEF("m", HAS_ARG, QEMU_OPTION_m, 2785824d651Sblueswir1 "-m megs set virtual RAM size to megs MB [default=%d]\n") 2795824d651Sblueswir1STEXI 2805824d651Sblueswir1@item -m @var{megs} 2815824d651Sblueswir1Set virtual RAM size to @var{megs} megabytes. Default is 128 MiB. Optionally, 2825824d651Sblueswir1a suffix of ``M'' or ``G'' can be used to signify a value in megabytes or 2835824d651Sblueswir1gigabytes respectively. 2845824d651Sblueswir1ETEXI 2855824d651Sblueswir1 2865824d651Sblueswir1DEF("k", HAS_ARG, QEMU_OPTION_k, 2875c2f8d2dSblueswir1 "-k language use keyboard layout (for example 'fr' for French)\n") 2885824d651Sblueswir1STEXI 2895824d651Sblueswir1@item -k @var{language} 2905824d651Sblueswir1 2915824d651Sblueswir1Use keyboard layout @var{language} (for example @code{fr} for 2925824d651Sblueswir1French). This option is only needed where it is not easy to get raw PC 2935824d651Sblueswir1keycodes (e.g. on Macs, with some X11 servers or with a VNC 2945824d651Sblueswir1display). You don't normally need to use it on PC/Linux or PC/Windows 2955824d651Sblueswir1hosts. 2965824d651Sblueswir1 2975824d651Sblueswir1The available layouts are: 2985824d651Sblueswir1@example 2995824d651Sblueswir1ar de-ch es fo fr-ca hu ja mk no pt-br sv 3005824d651Sblueswir1da en-gb et fr fr-ch is lt nl pl ru th 3015824d651Sblueswir1de en-us fi fr-be hr it lv nl-be pt sl tr 3025824d651Sblueswir1@end example 3035824d651Sblueswir1 3045824d651Sblueswir1The default is @code{en-us}. 3055824d651Sblueswir1ETEXI 3065824d651Sblueswir1 3075824d651Sblueswir1 3085824d651Sblueswir1#ifdef HAS_AUDIO 3095824d651Sblueswir1DEF("audio-help", 0, QEMU_OPTION_audio_help, 3105824d651Sblueswir1 "-audio-help print list of audio drivers and their options\n") 3115824d651Sblueswir1#endif 3125824d651Sblueswir1STEXI 3135824d651Sblueswir1@item -audio-help 3145824d651Sblueswir1 3155824d651Sblueswir1Will show the audio subsystem help: list of drivers, tunable 3165824d651Sblueswir1parameters. 3175824d651Sblueswir1ETEXI 3185824d651Sblueswir1 3195824d651Sblueswir1#ifdef HAS_AUDIO 3205824d651Sblueswir1DEF("soundhw", HAS_ARG, QEMU_OPTION_soundhw, 3215824d651Sblueswir1 "-soundhw c1,... enable audio support\n" 3225824d651Sblueswir1 " and only specified sound cards (comma separated list)\n" 3235824d651Sblueswir1 " use -soundhw ? to get the list of supported cards\n" 3245824d651Sblueswir1 " use -soundhw all to enable all of them\n") 3255824d651Sblueswir1#endif 3265824d651Sblueswir1STEXI 3275824d651Sblueswir1@item -soundhw @var{card1}[,@var{card2},...] or -soundhw all 3285824d651Sblueswir1 3295824d651Sblueswir1Enable audio and selected sound hardware. Use ? to print all 3305824d651Sblueswir1available sound hardware. 3315824d651Sblueswir1 3325824d651Sblueswir1@example 3335824d651Sblueswir1qemu -soundhw sb16,adlib disk.img 3345824d651Sblueswir1qemu -soundhw es1370 disk.img 3355824d651Sblueswir1qemu -soundhw ac97 disk.img 3365824d651Sblueswir1qemu -soundhw all disk.img 3375824d651Sblueswir1qemu -soundhw ? 3385824d651Sblueswir1@end example 3395824d651Sblueswir1 3405824d651Sblueswir1Note that Linux's i810_audio OSS kernel (for AC97) module might 3415824d651Sblueswir1require manually specifying clocking. 3425824d651Sblueswir1 3435824d651Sblueswir1@example 3445824d651Sblueswir1modprobe i810_audio clocking=48000 3455824d651Sblueswir1@end example 3465824d651Sblueswir1ETEXI 3475824d651Sblueswir1 3485824d651Sblueswir1STEXI 3495824d651Sblueswir1@end table 3505824d651Sblueswir1ETEXI 3515824d651Sblueswir1 3525824d651Sblueswir1DEF("usb", 0, QEMU_OPTION_usb, 3535824d651Sblueswir1 "-usb enable the USB driver (will be the default soon)\n") 3545824d651Sblueswir1STEXI 3555824d651Sblueswir1USB options: 3565824d651Sblueswir1@table @option 3575824d651Sblueswir1 3585824d651Sblueswir1@item -usb 3595824d651Sblueswir1Enable the USB driver (will be the default soon) 3605824d651Sblueswir1ETEXI 3615824d651Sblueswir1 3625824d651Sblueswir1DEF("usbdevice", HAS_ARG, QEMU_OPTION_usbdevice, 3635824d651Sblueswir1 "-usbdevice name add the host or guest USB device 'name'\n") 3645824d651Sblueswir1STEXI 3655824d651Sblueswir1 3665824d651Sblueswir1@item -usbdevice @var{devname} 3675824d651Sblueswir1Add the USB device @var{devname}. @xref{usb_devices}. 3685824d651Sblueswir1 369b3f046c2SKevin Wolf@table @option 3705824d651Sblueswir1 3715824d651Sblueswir1@item mouse 3725824d651Sblueswir1Virtual Mouse. This will override the PS/2 mouse emulation when activated. 3735824d651Sblueswir1 3745824d651Sblueswir1@item tablet 3755824d651Sblueswir1Pointer device that uses absolute coordinates (like a touchscreen). This 3765824d651Sblueswir1means qemu is able to report the mouse position without having to grab the 3775824d651Sblueswir1mouse. Also overrides the PS/2 mouse emulation when activated. 3785824d651Sblueswir1 3794e257e5eSKevin Wolf@item disk:[format=@var{format}]:@var{file} 3805824d651Sblueswir1Mass storage device based on file. The optional @var{format} argument 3815824d651Sblueswir1will be used rather than detecting the format. Can be used to specifiy 3824e257e5eSKevin Wolf@code{format=raw} to avoid interpreting an untrusted format header. 3835824d651Sblueswir1 3844e257e5eSKevin Wolf@item host:@var{bus}.@var{addr} 3854e257e5eSKevin WolfPass through the host device identified by @var{bus}.@var{addr} (Linux only). 3865824d651Sblueswir1 3874e257e5eSKevin Wolf@item host:@var{vendor_id}:@var{product_id} 3884e257e5eSKevin WolfPass through the host device identified by @var{vendor_id}:@var{product_id} 3894e257e5eSKevin Wolf(Linux only). 3905824d651Sblueswir1 3915824d651Sblueswir1@item serial:[vendorid=@var{vendor_id}][,productid=@var{product_id}]:@var{dev} 3925824d651Sblueswir1Serial converter to host character device @var{dev}, see @code{-serial} for the 3935824d651Sblueswir1available devices. 3945824d651Sblueswir1 3955824d651Sblueswir1@item braille 3965824d651Sblueswir1Braille device. This will use BrlAPI to display the braille output on a real 3975824d651Sblueswir1or fake device. 3985824d651Sblueswir1 3994e257e5eSKevin Wolf@item net:@var{options} 4005824d651Sblueswir1Network adapter that supports CDC ethernet and RNDIS protocols. 4015824d651Sblueswir1 4025824d651Sblueswir1@end table 4035824d651Sblueswir1ETEXI 4045824d651Sblueswir1 405bd3c948dSGerd HoffmannDEF("device", HAS_ARG, QEMU_OPTION_device, 406*40ea285cSMarkus Armbruster "-device driver[,prop[=value][,...]]\n" 407*40ea285cSMarkus Armbruster " add device (based on driver)\n" 408*40ea285cSMarkus Armbruster " prop=value,... sets driver properties\n" 40969a319d1SStefan Weil " use -device ? to print all possible drivers\n" 410*40ea285cSMarkus Armbruster " use -device driver,? to print all possible properties\n") 4113dbf2c7fSStefan WeilSTEXI 412*40ea285cSMarkus Armbruster@item -device @var{driver}[,@var{prop}[=@var{value}][,...]] 413*40ea285cSMarkus ArmbrusterAdd device @var{driver}. @var{prop}=@var{value} sets driver 414*40ea285cSMarkus Armbrusterproperties. Valid properties depend on the driver. To get help on 415*40ea285cSMarkus Armbrusterpossible drivers and properties, use @code{-device ?} and 416*40ea285cSMarkus Armbruster@code{-device @var{driver},?}. 4173dbf2c7fSStefan WeilETEXI 4183dbf2c7fSStefan Weil 4195824d651Sblueswir1DEF("name", HAS_ARG, QEMU_OPTION_name, 420ca1a8a06SBruce Rogers "-name string1[,process=string2]\n" 421ca1a8a06SBruce Rogers " set the name of the guest\n" 4221889465aSAndi Kleen " string1 sets the window title and string2 the process name (on Linux)\n") 4235824d651Sblueswir1STEXI 4245824d651Sblueswir1@item -name @var{name} 4255824d651Sblueswir1Sets the @var{name} of the guest. 4265824d651Sblueswir1This name will be displayed in the SDL window caption. 4275824d651Sblueswir1The @var{name} will also be used for the VNC server. 4281889465aSAndi KleenAlso optionally set the top visible process name in Linux. 4295824d651Sblueswir1ETEXI 4305824d651Sblueswir1 4315824d651Sblueswir1DEF("uuid", HAS_ARG, QEMU_OPTION_uuid, 4325824d651Sblueswir1 "-uuid %%08x-%%04x-%%04x-%%04x-%%012x\n" 4335824d651Sblueswir1 " specify machine UUID\n") 4345824d651Sblueswir1STEXI 4355824d651Sblueswir1@item -uuid @var{uuid} 4365824d651Sblueswir1Set system UUID. 4375824d651Sblueswir1ETEXI 4385824d651Sblueswir1 4395824d651Sblueswir1STEXI 4405824d651Sblueswir1@end table 4415824d651Sblueswir1ETEXI 4425824d651Sblueswir1 4435824d651Sblueswir1DEFHEADING() 4445824d651Sblueswir1 4455824d651Sblueswir1DEFHEADING(Display options:) 4465824d651Sblueswir1 4475824d651Sblueswir1STEXI 4485824d651Sblueswir1@table @option 4495824d651Sblueswir1ETEXI 4505824d651Sblueswir1 4515824d651Sblueswir1DEF("nographic", 0, QEMU_OPTION_nographic, 4525824d651Sblueswir1 "-nographic disable graphical output and redirect serial I/Os to console\n") 4535824d651Sblueswir1STEXI 4545824d651Sblueswir1@item -nographic 4555824d651Sblueswir1 4565824d651Sblueswir1Normally, QEMU uses SDL to display the VGA output. With this option, 4575824d651Sblueswir1you can totally disable graphical output so that QEMU is a simple 4585824d651Sblueswir1command line application. The emulated serial port is redirected on 4595824d651Sblueswir1the console. Therefore, you can still use QEMU to debug a Linux kernel 4605824d651Sblueswir1with a serial console. 4615824d651Sblueswir1ETEXI 4625824d651Sblueswir1 4635824d651Sblueswir1#ifdef CONFIG_CURSES 4645824d651Sblueswir1DEF("curses", 0, QEMU_OPTION_curses, 4655824d651Sblueswir1 "-curses use a curses/ncurses interface instead of SDL\n") 4665824d651Sblueswir1#endif 4675824d651Sblueswir1STEXI 4685824d651Sblueswir1@item -curses 4695824d651Sblueswir1 4705824d651Sblueswir1Normally, QEMU uses SDL to display the VGA output. With this option, 4715824d651Sblueswir1QEMU can display the VGA output when in text mode using a 4725824d651Sblueswir1curses/ncurses interface. Nothing is displayed in graphical mode. 4735824d651Sblueswir1ETEXI 4745824d651Sblueswir1 4755824d651Sblueswir1#ifdef CONFIG_SDL 4765824d651Sblueswir1DEF("no-frame", 0, QEMU_OPTION_no_frame, 4775824d651Sblueswir1 "-no-frame open SDL window without a frame and window decorations\n") 4785824d651Sblueswir1#endif 4795824d651Sblueswir1STEXI 4805824d651Sblueswir1@item -no-frame 4815824d651Sblueswir1 4825824d651Sblueswir1Do not use decorations for SDL windows and start them using the whole 4835824d651Sblueswir1available screen space. This makes the using QEMU in a dedicated desktop 4845824d651Sblueswir1workspace more convenient. 4855824d651Sblueswir1ETEXI 4865824d651Sblueswir1 4875824d651Sblueswir1#ifdef CONFIG_SDL 4885824d651Sblueswir1DEF("alt-grab", 0, QEMU_OPTION_alt_grab, 4895824d651Sblueswir1 "-alt-grab use Ctrl-Alt-Shift to grab mouse (instead of Ctrl-Alt)\n") 4905824d651Sblueswir1#endif 4915824d651Sblueswir1STEXI 4925824d651Sblueswir1@item -alt-grab 4935824d651Sblueswir1 4945824d651Sblueswir1Use Ctrl-Alt-Shift to grab mouse (instead of Ctrl-Alt). 4955824d651Sblueswir1ETEXI 4965824d651Sblueswir1 4975824d651Sblueswir1#ifdef CONFIG_SDL 4980ca9f8a4SDustin KirklandDEF("ctrl-grab", 0, QEMU_OPTION_ctrl_grab, 4990ca9f8a4SDustin Kirkland "-ctrl-grab use Right-Ctrl to grab mouse (instead of Ctrl-Alt)\n") 5000ca9f8a4SDustin Kirkland#endif 5010ca9f8a4SDustin KirklandSTEXI 5020ca9f8a4SDustin Kirkland@item -ctrl-grab 5030ca9f8a4SDustin Kirkland 5040ca9f8a4SDustin KirklandUse Right-Ctrl to grab mouse (instead of Ctrl-Alt). 5050ca9f8a4SDustin KirklandETEXI 5060ca9f8a4SDustin Kirkland 5070ca9f8a4SDustin Kirkland#ifdef CONFIG_SDL 5085824d651Sblueswir1DEF("no-quit", 0, QEMU_OPTION_no_quit, 5095824d651Sblueswir1 "-no-quit disable SDL window close capability\n") 5105824d651Sblueswir1#endif 5115824d651Sblueswir1STEXI 5125824d651Sblueswir1@item -no-quit 5135824d651Sblueswir1 5145824d651Sblueswir1Disable SDL window close capability. 5155824d651Sblueswir1ETEXI 5165824d651Sblueswir1 5175824d651Sblueswir1#ifdef CONFIG_SDL 5185824d651Sblueswir1DEF("sdl", 0, QEMU_OPTION_sdl, 5195824d651Sblueswir1 "-sdl enable SDL\n") 5205824d651Sblueswir1#endif 5215824d651Sblueswir1STEXI 5225824d651Sblueswir1@item -sdl 5235824d651Sblueswir1 5245824d651Sblueswir1Enable SDL. 5255824d651Sblueswir1ETEXI 5265824d651Sblueswir1 5275824d651Sblueswir1DEF("portrait", 0, QEMU_OPTION_portrait, 5285824d651Sblueswir1 "-portrait rotate graphical output 90 deg left (only PXA LCD)\n") 5295824d651Sblueswir1STEXI 5305824d651Sblueswir1@item -portrait 5315824d651Sblueswir1 5325824d651Sblueswir1Rotate graphical output 90 deg left (only PXA LCD). 5335824d651Sblueswir1ETEXI 5345824d651Sblueswir1 5355824d651Sblueswir1DEF("vga", HAS_ARG, QEMU_OPTION_vga, 53694909d9fSaliguori "-vga [std|cirrus|vmware|xenfb|none]\n" 5375824d651Sblueswir1 " select video card type\n") 5385824d651Sblueswir1STEXI 5395824d651Sblueswir1@item -vga @var{type} 5405824d651Sblueswir1Select type of VGA card to emulate. Valid values for @var{type} are 541b3f046c2SKevin Wolf@table @option 5425824d651Sblueswir1@item cirrus 5435824d651Sblueswir1Cirrus Logic GD5446 Video card. All Windows versions starting from 5445824d651Sblueswir1Windows 95 should recognize and use this graphic card. For optimal 5455824d651Sblueswir1performances, use 16 bit color depth in the guest and the host OS. 5465824d651Sblueswir1(This one is the default) 5475824d651Sblueswir1@item std 5485824d651Sblueswir1Standard VGA card with Bochs VBE extensions. If your guest OS 5495824d651Sblueswir1supports the VESA 2.0 VBE extensions (e.g. Windows XP) and if you want 5505824d651Sblueswir1to use high resolution modes (>= 1280x1024x16) then you should use 5515824d651Sblueswir1this option. 5525824d651Sblueswir1@item vmware 5535824d651Sblueswir1VMWare SVGA-II compatible adapter. Use it if you have sufficiently 5545824d651Sblueswir1recent XFree86/XOrg server or Windows guest with a driver for this 5555824d651Sblueswir1card. 5565824d651Sblueswir1@item none 5575824d651Sblueswir1Disable VGA card. 5585824d651Sblueswir1@end table 5595824d651Sblueswir1ETEXI 5605824d651Sblueswir1 5615824d651Sblueswir1DEF("full-screen", 0, QEMU_OPTION_full_screen, 5625824d651Sblueswir1 "-full-screen start in full screen\n") 5635824d651Sblueswir1STEXI 5645824d651Sblueswir1@item -full-screen 5655824d651Sblueswir1Start in full screen. 5665824d651Sblueswir1ETEXI 5675824d651Sblueswir1 5685824d651Sblueswir1#if defined(TARGET_PPC) || defined(TARGET_SPARC) 5695824d651Sblueswir1DEF("g", 1, QEMU_OPTION_g , 5705824d651Sblueswir1 "-g WxH[xDEPTH] Set the initial graphical resolution and depth\n") 5715824d651Sblueswir1#endif 5725824d651Sblueswir1STEXI 57395d5f08bSStefan Weil@item -g @var{width}x@var{height}[x@var{depth}] 57495d5f08bSStefan WeilSet the initial graphical resolution and depth (PPC, SPARC only). 5755824d651Sblueswir1ETEXI 5765824d651Sblueswir1 5775824d651Sblueswir1DEF("vnc", HAS_ARG, QEMU_OPTION_vnc , 5785824d651Sblueswir1 "-vnc display start a VNC server on display\n") 5795824d651Sblueswir1STEXI 5805824d651Sblueswir1@item -vnc @var{display}[,@var{option}[,@var{option}[,...]]] 5815824d651Sblueswir1 5825824d651Sblueswir1Normally, QEMU uses SDL to display the VGA output. With this option, 5835824d651Sblueswir1you can have QEMU listen on VNC display @var{display} and redirect the VGA 5845824d651Sblueswir1display over the VNC session. It is very useful to enable the usb 5855824d651Sblueswir1tablet device when using this option (option @option{-usbdevice 5865824d651Sblueswir1tablet}). When using the VNC display, you must use the @option{-k} 5875824d651Sblueswir1parameter to set the keyboard layout if you are not using en-us. Valid 5885824d651Sblueswir1syntax for the @var{display} is 5895824d651Sblueswir1 590b3f046c2SKevin Wolf@table @option 5915824d651Sblueswir1 5925824d651Sblueswir1@item @var{host}:@var{d} 5935824d651Sblueswir1 5945824d651Sblueswir1TCP connections will only be allowed from @var{host} on display @var{d}. 5955824d651Sblueswir1By convention the TCP port is 5900+@var{d}. Optionally, @var{host} can 5965824d651Sblueswir1be omitted in which case the server will accept connections from any host. 5975824d651Sblueswir1 5984e257e5eSKevin Wolf@item unix:@var{path} 5995824d651Sblueswir1 6005824d651Sblueswir1Connections will be allowed over UNIX domain sockets where @var{path} is the 6015824d651Sblueswir1location of a unix socket to listen for connections on. 6025824d651Sblueswir1 6035824d651Sblueswir1@item none 6045824d651Sblueswir1 6055824d651Sblueswir1VNC is initialized but not started. The monitor @code{change} command 6065824d651Sblueswir1can be used to later start the VNC server. 6075824d651Sblueswir1 6085824d651Sblueswir1@end table 6095824d651Sblueswir1 6105824d651Sblueswir1Following the @var{display} value there may be one or more @var{option} flags 6115824d651Sblueswir1separated by commas. Valid options are 6125824d651Sblueswir1 613b3f046c2SKevin Wolf@table @option 6145824d651Sblueswir1 6155824d651Sblueswir1@item reverse 6165824d651Sblueswir1 6175824d651Sblueswir1Connect to a listening VNC client via a ``reverse'' connection. The 6185824d651Sblueswir1client is specified by the @var{display}. For reverse network 6195824d651Sblueswir1connections (@var{host}:@var{d},@code{reverse}), the @var{d} argument 6205824d651Sblueswir1is a TCP port number, not a display number. 6215824d651Sblueswir1 6225824d651Sblueswir1@item password 6235824d651Sblueswir1 6245824d651Sblueswir1Require that password based authentication is used for client connections. 6255824d651Sblueswir1The password must be set separately using the @code{change} command in the 6265824d651Sblueswir1@ref{pcsys_monitor} 6275824d651Sblueswir1 6285824d651Sblueswir1@item tls 6295824d651Sblueswir1 6305824d651Sblueswir1Require that client use TLS when communicating with the VNC server. This 6315824d651Sblueswir1uses anonymous TLS credentials so is susceptible to a man-in-the-middle 6325824d651Sblueswir1attack. It is recommended that this option be combined with either the 6334e257e5eSKevin Wolf@option{x509} or @option{x509verify} options. 6345824d651Sblueswir1 6355824d651Sblueswir1@item x509=@var{/path/to/certificate/dir} 6365824d651Sblueswir1 6375824d651Sblueswir1Valid if @option{tls} is specified. Require that x509 credentials are used 6385824d651Sblueswir1for negotiating the TLS session. The server will send its x509 certificate 6395824d651Sblueswir1to the client. It is recommended that a password be set on the VNC server 6405824d651Sblueswir1to provide authentication of the client when this is used. The path following 6415824d651Sblueswir1this option specifies where the x509 certificates are to be loaded from. 6425824d651Sblueswir1See the @ref{vnc_security} section for details on generating certificates. 6435824d651Sblueswir1 6445824d651Sblueswir1@item x509verify=@var{/path/to/certificate/dir} 6455824d651Sblueswir1 6465824d651Sblueswir1Valid if @option{tls} is specified. Require that x509 credentials are used 6475824d651Sblueswir1for negotiating the TLS session. The server will send its x509 certificate 6485824d651Sblueswir1to the client, and request that the client send its own x509 certificate. 6495824d651Sblueswir1The server will validate the client's certificate against the CA certificate, 6505824d651Sblueswir1and reject clients when validation fails. If the certificate authority is 6515824d651Sblueswir1trusted, this is a sufficient authentication mechanism. You may still wish 6525824d651Sblueswir1to set a password on the VNC server as a second authentication layer. The 6535824d651Sblueswir1path following this option specifies where the x509 certificates are to 6545824d651Sblueswir1be loaded from. See the @ref{vnc_security} section for details on generating 6555824d651Sblueswir1certificates. 6565824d651Sblueswir1 6575824d651Sblueswir1@item sasl 6585824d651Sblueswir1 6595824d651Sblueswir1Require that the client use SASL to authenticate with the VNC server. 6605824d651Sblueswir1The exact choice of authentication method used is controlled from the 6615824d651Sblueswir1system / user's SASL configuration file for the 'qemu' service. This 6625824d651Sblueswir1is typically found in /etc/sasl2/qemu.conf. If running QEMU as an 6635824d651Sblueswir1unprivileged user, an environment variable SASL_CONF_PATH can be used 6645824d651Sblueswir1to make it search alternate locations for the service config. 6655824d651Sblueswir1While some SASL auth methods can also provide data encryption (eg GSSAPI), 6665824d651Sblueswir1it is recommended that SASL always be combined with the 'tls' and 6675824d651Sblueswir1'x509' settings to enable use of SSL and server certificates. This 6685824d651Sblueswir1ensures a data encryption preventing compromise of authentication 6695824d651Sblueswir1credentials. See the @ref{vnc_security} section for details on using 6705824d651Sblueswir1SASL authentication. 6715824d651Sblueswir1 6725824d651Sblueswir1@item acl 6735824d651Sblueswir1 6745824d651Sblueswir1Turn on access control lists for checking of the x509 client certificate 6755824d651Sblueswir1and SASL party. For x509 certs, the ACL check is made against the 6765824d651Sblueswir1certificate's distinguished name. This is something that looks like 6775824d651Sblueswir1@code{C=GB,O=ACME,L=Boston,CN=bob}. For SASL party, the ACL check is 6785824d651Sblueswir1made against the username, which depending on the SASL plugin, may 6795824d651Sblueswir1include a realm component, eg @code{bob} or @code{bob@@EXAMPLE.COM}. 6805824d651Sblueswir1When the @option{acl} flag is set, the initial access list will be 6815824d651Sblueswir1empty, with a @code{deny} policy. Thus no one will be allowed to 6825824d651Sblueswir1use the VNC server until the ACLs have been loaded. This can be 6835824d651Sblueswir1achieved using the @code{acl} monitor command. 6845824d651Sblueswir1 6855824d651Sblueswir1@end table 6865824d651Sblueswir1ETEXI 6875824d651Sblueswir1 6885824d651Sblueswir1STEXI 6895824d651Sblueswir1@end table 6905824d651Sblueswir1ETEXI 6915824d651Sblueswir1 6925824d651Sblueswir1DEFHEADING() 6935824d651Sblueswir1 6945824d651Sblueswir1#ifdef TARGET_I386 6955824d651Sblueswir1DEFHEADING(i386 target only:) 6965824d651Sblueswir1#endif 6975824d651Sblueswir1STEXI 6985824d651Sblueswir1@table @option 6995824d651Sblueswir1ETEXI 7005824d651Sblueswir1 7015824d651Sblueswir1#ifdef TARGET_I386 7025824d651Sblueswir1DEF("win2k-hack", 0, QEMU_OPTION_win2k_hack, 7035824d651Sblueswir1 "-win2k-hack use it when installing Windows 2000 to avoid a disk full bug\n") 7045824d651Sblueswir1#endif 7055824d651Sblueswir1STEXI 7065824d651Sblueswir1@item -win2k-hack 7075824d651Sblueswir1Use it when installing Windows 2000 to avoid a disk full bug. After 7085824d651Sblueswir1Windows 2000 is installed, you no longer need this option (this option 7095824d651Sblueswir1slows down the IDE transfers). 7105824d651Sblueswir1ETEXI 7115824d651Sblueswir1 7125824d651Sblueswir1#ifdef TARGET_I386 7131ed2fc1fSJan KiszkaHXCOMM Deprecated by -rtc 7141ed2fc1fSJan KiszkaDEF("rtc-td-hack", 0, QEMU_OPTION_rtc_td_hack, "") 7155824d651Sblueswir1#endif 7165824d651Sblueswir1 7175824d651Sblueswir1#ifdef TARGET_I386 7185824d651Sblueswir1DEF("no-fd-bootchk", 0, QEMU_OPTION_no_fd_bootchk, 7195824d651Sblueswir1 "-no-fd-bootchk disable boot signature checking for floppy disks\n") 7205824d651Sblueswir1#endif 7215824d651Sblueswir1STEXI 7225824d651Sblueswir1@item -no-fd-bootchk 7235824d651Sblueswir1Disable boot signature checking for floppy disks in Bochs BIOS. It may 7245824d651Sblueswir1be needed to boot from old floppy disks. 7255824d651Sblueswir1ETEXI 7265824d651Sblueswir1 7275824d651Sblueswir1#ifdef TARGET_I386 7285824d651Sblueswir1DEF("no-acpi", 0, QEMU_OPTION_no_acpi, 7295824d651Sblueswir1 "-no-acpi disable ACPI\n") 7305824d651Sblueswir1#endif 7315824d651Sblueswir1STEXI 7325824d651Sblueswir1@item -no-acpi 7335824d651Sblueswir1Disable ACPI (Advanced Configuration and Power Interface) support. Use 7345824d651Sblueswir1it if your guest OS complains about ACPI problems (PC target machine 7355824d651Sblueswir1only). 7365824d651Sblueswir1ETEXI 7375824d651Sblueswir1 7385824d651Sblueswir1#ifdef TARGET_I386 7395824d651Sblueswir1DEF("no-hpet", 0, QEMU_OPTION_no_hpet, 7405824d651Sblueswir1 "-no-hpet disable HPET\n") 7415824d651Sblueswir1#endif 7425824d651Sblueswir1STEXI 7435824d651Sblueswir1@item -no-hpet 7445824d651Sblueswir1Disable HPET support. 7455824d651Sblueswir1ETEXI 7465824d651Sblueswir1 7475824d651Sblueswir1#ifdef TARGET_I386 7487d4c3d53SMarkus ArmbrusterDEF("balloon", HAS_ARG, QEMU_OPTION_balloon, 7497d4c3d53SMarkus Armbruster "-balloon none disable balloon device\n" 7507d4c3d53SMarkus Armbruster "-balloon virtio[,addr=str]\n" 7517d4c3d53SMarkus Armbruster " enable virtio balloon device (default)\n") 752df97b920SEduardo Habkost#endif 753df97b920SEduardo HabkostSTEXI 7547d4c3d53SMarkus Armbruster@item -balloon none 7557d4c3d53SMarkus ArmbrusterDisable balloon device. 7567d4c3d53SMarkus Armbruster@item -balloon virtio[,addr=@var{addr}] 7577d4c3d53SMarkus ArmbrusterEnable virtio balloon device (default), optionally with PCI address 7587d4c3d53SMarkus Armbruster@var{addr}. 759df97b920SEduardo HabkostETEXI 760df97b920SEduardo Habkost 761df97b920SEduardo Habkost#ifdef TARGET_I386 7625824d651Sblueswir1DEF("acpitable", HAS_ARG, QEMU_OPTION_acpitable, 7635824d651Sblueswir1 "-acpitable [sig=str][,rev=n][,oem_id=str][,oem_table_id=str][,oem_rev=n][,asl_compiler_id=str][,asl_compiler_rev=n][,data=file1[:file2]...]\n" 7645824d651Sblueswir1 " ACPI table description\n") 7655824d651Sblueswir1#endif 7665824d651Sblueswir1STEXI 7675824d651Sblueswir1@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}]...] 7685824d651Sblueswir1Add ACPI table with specified header fields and context from specified files. 7695824d651Sblueswir1ETEXI 7705824d651Sblueswir1 7715824d651Sblueswir1#ifdef TARGET_I386 772b6f6e3d3SaliguoriDEF("smbios", HAS_ARG, QEMU_OPTION_smbios, 773b6f6e3d3Saliguori "-smbios file=binary\n" 774ca1a8a06SBruce Rogers " load SMBIOS entry from binary file\n" 775b6f6e3d3Saliguori "-smbios type=0[,vendor=str][,version=str][,date=str][,release=%%d.%%d]\n" 776ca1a8a06SBruce Rogers " specify SMBIOS type 0 fields\n" 777b6f6e3d3Saliguori "-smbios type=1[,manufacturer=str][,product=str][,version=str][,serial=str]\n" 778b6f6e3d3Saliguori " [,uuid=uuid][,sku=str][,family=str]\n" 779ca1a8a06SBruce Rogers " specify SMBIOS type 1 fields\n") 780b6f6e3d3Saliguori#endif 781b6f6e3d3SaliguoriSTEXI 782b6f6e3d3Saliguori@item -smbios file=@var{binary} 783b6f6e3d3SaliguoriLoad SMBIOS entry from binary file. 784b6f6e3d3Saliguori 785b6f6e3d3Saliguori@item -smbios type=0[,vendor=@var{str}][,version=@var{str}][,date=@var{str}][,release=@var{%d.%d}] 786b6f6e3d3SaliguoriSpecify SMBIOS type 0 fields 787b6f6e3d3Saliguori 788b6f6e3d3Saliguori@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}] 789b6f6e3d3SaliguoriSpecify SMBIOS type 1 fields 790b6f6e3d3SaliguoriETEXI 791b6f6e3d3Saliguori 792b6f6e3d3Saliguori#ifdef TARGET_I386 7935824d651Sblueswir1DEFHEADING() 7945824d651Sblueswir1#endif 7955824d651Sblueswir1STEXI 7965824d651Sblueswir1@end table 7975824d651Sblueswir1ETEXI 7985824d651Sblueswir1 7995824d651Sblueswir1DEFHEADING(Network options:) 8005824d651Sblueswir1STEXI 8015824d651Sblueswir1@table @option 8025824d651Sblueswir1ETEXI 8035824d651Sblueswir1 804ad196a9dSJan KiszkaHXCOMM Legacy slirp options (now moved to -net user): 805ad196a9dSJan Kiszka#ifdef CONFIG_SLIRP 806ad196a9dSJan KiszkaDEF("tftp", HAS_ARG, QEMU_OPTION_tftp, "") 807ad196a9dSJan KiszkaDEF("bootp", HAS_ARG, QEMU_OPTION_bootp, "") 808ad196a9dSJan KiszkaDEF("redir", HAS_ARG, QEMU_OPTION_redir, "") 809ad196a9dSJan Kiszka#ifndef _WIN32 810ad196a9dSJan KiszkaDEF("smb", HAS_ARG, QEMU_OPTION_smb, "") 811ad196a9dSJan Kiszka#endif 812ad196a9dSJan Kiszka#endif 813ad196a9dSJan Kiszka 814bab7944cSBlue SwirlDEF("net", HAS_ARG, QEMU_OPTION_net, 815ffe6370cSMichael S. Tsirkin "-net nic[,vlan=n][,macaddr=mac][,model=type][,name=str][,addr=str][,vectors=v]\n" 8165824d651Sblueswir1 " create a new Network Interface Card and connect it to VLAN 'n'\n" 8175824d651Sblueswir1#ifdef CONFIG_SLIRP 818c92ef6a2SJan Kiszka "-net user[,vlan=n][,name=str][,net=addr[/mask]][,host=addr][,restrict=y|n]\n" 819c92ef6a2SJan Kiszka " [,hostname=host][,dhcpstart=addr][,dns=addr][,tftp=dir][,bootfile=f]\n" 820c92ef6a2SJan Kiszka " [,hostfwd=rule][,guestfwd=rule]" 821ad196a9dSJan Kiszka#ifndef _WIN32 822c92ef6a2SJan Kiszka "[,smb=dir[,smbserver=addr]]\n" 823ad196a9dSJan Kiszka#endif 824ad196a9dSJan Kiszka " connect the user mode network stack to VLAN 'n', configure its\n" 825ad196a9dSJan Kiszka " DHCP server and enabled optional services\n" 8265824d651Sblueswir1#endif 8275824d651Sblueswir1#ifdef _WIN32 8285824d651Sblueswir1 "-net tap[,vlan=n][,name=str],ifname=name\n" 8295824d651Sblueswir1 " connect the host TAP network interface to VLAN 'n'\n" 8305824d651Sblueswir1#else 831baf74c95SMark McLoughlin "-net tap[,vlan=n][,name=str][,fd=h][,ifname=name][,script=file][,downscript=dfile][,sndbuf=nbytes][,vnet_hdr=on|off]\n" 8325824d651Sblueswir1 " connect the host TAP network interface to VLAN 'n' and use the\n" 8335824d651Sblueswir1 " network scripts 'file' (default=%s)\n" 834ca1a8a06SBruce Rogers " and 'dfile' (default=%s)\n" 835ca1a8a06SBruce Rogers " use '[down]script=no' to disable script execution\n" 8365824d651Sblueswir1 " use 'fd=h' to connect to an already opened TAP interface\n" 837ca1a8a06SBruce Rogers " use 'sndbuf=nbytes' to limit the size of the send buffer (the\n" 838ca1a8a06SBruce Rogers " default of 'sndbuf=1048576' can be disabled using 'sndbuf=0')\n" 839ca1a8a06SBruce Rogers " use vnet_hdr=off to avoid enabling the IFF_VNET_HDR tap flag\n" 840ca1a8a06SBruce Rogers " use vnet_hdr=on to make the lack of IFF_VNET_HDR support an error condition\n" 8410df0ff6dSMark McLoughlin#endif 8425824d651Sblueswir1 "-net socket[,vlan=n][,name=str][,fd=h][,listen=[host]:port][,connect=host:port]\n" 8435824d651Sblueswir1 " connect the vlan 'n' to another VLAN using a socket connection\n" 8445824d651Sblueswir1 "-net socket[,vlan=n][,name=str][,fd=h][,mcast=maddr:port]\n" 8455824d651Sblueswir1 " connect the vlan 'n' to multicast maddr and port\n" 8465824d651Sblueswir1#ifdef CONFIG_VDE 8475824d651Sblueswir1 "-net vde[,vlan=n][,name=str][,sock=socketpath][,port=n][,group=groupname][,mode=octalmode]\n" 8485824d651Sblueswir1 " connect the vlan 'n' to port 'n' of a vde switch running\n" 8495824d651Sblueswir1 " on host and listening for incoming connections on 'socketpath'.\n" 8505824d651Sblueswir1 " Use group 'groupname' and mode 'octalmode' to change default\n" 8515824d651Sblueswir1 " ownership and permissions for communication port.\n" 8525824d651Sblueswir1#endif 853bb9ea79eSaliguori "-net dump[,vlan=n][,file=f][,len=n]\n" 854bb9ea79eSaliguori " dump traffic on vlan 'n' to file 'f' (max n bytes per packet)\n" 855ca1a8a06SBruce Rogers "-net none use it alone to have zero network devices. If no -net option\n" 8565824d651Sblueswir1 " is provided, the default is '-net nic -net user'\n") 857a1ea458fSMark McLoughlinDEF("netdev", HAS_ARG, QEMU_OPTION_netdev, 858a1ea458fSMark McLoughlin "-netdev [" 859a1ea458fSMark McLoughlin#ifdef CONFIG_SLIRP 860a1ea458fSMark McLoughlin "user|" 861a1ea458fSMark McLoughlin#endif 862a1ea458fSMark McLoughlin "tap|" 863a1ea458fSMark McLoughlin#ifdef CONFIG_VDE 864a1ea458fSMark McLoughlin "vde|" 865a1ea458fSMark McLoughlin#endif 866a1ea458fSMark McLoughlin "socket],id=str[,option][,option][,...]\n") 8675824d651Sblueswir1STEXI 868ffe6370cSMichael S. Tsirkin@item -net nic[,vlan=@var{n}][,macaddr=@var{mac}][,model=@var{type}][,name=@var{name}][,addr=@var{addr}][,vectors=@var{v}] 8695824d651Sblueswir1Create a new Network Interface Card and connect it to VLAN @var{n} (@var{n} 8700d6b0b1dSAnthony Liguori= 0 is the default). The NIC is an e1000 by default on the PC 8715607c388SMarkus Armbrustertarget. Optionally, the MAC address can be changed to @var{mac}, the 8725607c388SMarkus Armbrusterdevice address set to @var{addr} (PCI cards only), 873ffe6370cSMichael S. Tsirkinand a @var{name} can be assigned for use in monitor commands. 874ffe6370cSMichael S. TsirkinOptionally, for PCI cards, you can specify the number @var{v} of MSI-X vectors 875ffe6370cSMichael S. Tsirkinthat the card should have; this option currently only affects virtio cards; set 876ffe6370cSMichael S. Tsirkin@var{v} = 0 to disable MSI-X. If no @option{-net} option is specified, a single 877ffe6370cSMichael S. TsirkinNIC is created. Qemu can emulate several different models of network card. 8785824d651Sblueswir1Valid values for @var{type} are 879ffe6370cSMichael S. Tsirkin@code{virtio}, @code{i82551}, @code{i82557b}, @code{i82559er}, 8805824d651Sblueswir1@code{ne2k_pci}, @code{ne2k_isa}, @code{pcnet}, @code{rtl8139}, 8815824d651Sblueswir1@code{e1000}, @code{smc91c111}, @code{lance} and @code{mcf_fec}. 8825824d651Sblueswir1Not all devices are supported on all targets. Use -net nic,model=? 8835824d651Sblueswir1for a list of available devices for your target. 8845824d651Sblueswir1 885ad196a9dSJan Kiszka@item -net user[,@var{option}][,@var{option}][,...] 8865824d651Sblueswir1Use the user mode network stack which requires no administrator 887ad196a9dSJan Kiszkaprivilege to run. Valid options are: 8885824d651Sblueswir1 889b3f046c2SKevin Wolf@table @option 890ad196a9dSJan Kiszka@item vlan=@var{n} 891ad196a9dSJan KiszkaConnect user mode stack to VLAN @var{n} (@var{n} = 0 is the default). 892ad196a9dSJan Kiszka 893ad196a9dSJan Kiszka@item name=@var{name} 894ad196a9dSJan KiszkaAssign symbolic name for use in monitor commands. 895ad196a9dSJan Kiszka 896c92ef6a2SJan Kiszka@item net=@var{addr}[/@var{mask}] 897c92ef6a2SJan KiszkaSet IP network address the guest will see. Optionally specify the netmask, 898c92ef6a2SJan Kiszkaeither in the form a.b.c.d or as number of valid top-most bits. Default is 899c92ef6a2SJan Kiszka10.0.2.0/8. 900c92ef6a2SJan Kiszka 901c92ef6a2SJan Kiszka@item host=@var{addr} 902c92ef6a2SJan KiszkaSpecify the guest-visible address of the host. Default is the 2nd IP in the 903c92ef6a2SJan Kiszkaguest network, i.e. x.x.x.2. 904ad196a9dSJan Kiszka 905ad196a9dSJan Kiszka@item restrict=y|yes|n|no 906ad196a9dSJan KiszkaIf this options is enabled, the guest will be isolated, i.e. it will not be 907ad196a9dSJan Kiszkaable to contact the host and no guest IP packets will be routed over the host 908ad196a9dSJan Kiszkato the outside. This option does not affect explicitly set forwarding rule. 909ad196a9dSJan Kiszka 910ad196a9dSJan Kiszka@item hostname=@var{name} 911ad196a9dSJan KiszkaSpecifies the client hostname reported by the builtin DHCP server. 912ad196a9dSJan Kiszka 913c92ef6a2SJan Kiszka@item dhcpstart=@var{addr} 914c92ef6a2SJan KiszkaSpecify the first of the 16 IPs the built-in DHCP server can assign. Default 915c92ef6a2SJan Kiszkais the 16th to 31st IP in the guest network, i.e. x.x.x.16 to x.x.x.31. 916c92ef6a2SJan Kiszka 917c92ef6a2SJan Kiszka@item dns=@var{addr} 918c92ef6a2SJan KiszkaSpecify the guest-visible address of the virtual nameserver. The address must 919c92ef6a2SJan Kiszkabe different from the host address. Default is the 3rd IP in the guest network, 920c92ef6a2SJan Kiszkai.e. x.x.x.3. 921c92ef6a2SJan Kiszka 922ad196a9dSJan Kiszka@item tftp=@var{dir} 923ad196a9dSJan KiszkaWhen using the user mode network stack, activate a built-in TFTP 924ad196a9dSJan Kiszkaserver. The files in @var{dir} will be exposed as the root of a TFTP server. 925ad196a9dSJan KiszkaThe TFTP client on the guest must be configured in binary mode (use the command 926c92ef6a2SJan Kiszka@code{bin} of the Unix TFTP client). 927ad196a9dSJan Kiszka 928ad196a9dSJan Kiszka@item bootfile=@var{file} 929ad196a9dSJan KiszkaWhen using the user mode network stack, broadcast @var{file} as the BOOTP 930ad196a9dSJan Kiszkafilename. In conjunction with @option{tftp}, this can be used to network boot 931ad196a9dSJan Kiszkaa guest from a local directory. 932ad196a9dSJan Kiszka 933ad196a9dSJan KiszkaExample (using pxelinux): 934ad196a9dSJan Kiszka@example 935ad196a9dSJan Kiszkaqemu -hda linux.img -boot n -net user,tftp=/path/to/tftp/files,bootfile=/pxelinux.0 936ad196a9dSJan Kiszka@end example 937ad196a9dSJan Kiszka 938c92ef6a2SJan Kiszka@item smb=@var{dir}[,smbserver=@var{addr}] 939ad196a9dSJan KiszkaWhen using the user mode network stack, activate a built-in SMB 940ad196a9dSJan Kiszkaserver so that Windows OSes can access to the host files in @file{@var{dir}} 941c92ef6a2SJan Kiszkatransparently. The IP address of the SMB server can be set to @var{addr}. By 942c92ef6a2SJan Kiszkadefault the 4th IP in the guest network is used, i.e. x.x.x.4. 943ad196a9dSJan Kiszka 944ad196a9dSJan KiszkaIn the guest Windows OS, the line: 945ad196a9dSJan Kiszka@example 946ad196a9dSJan Kiszka10.0.2.4 smbserver 947ad196a9dSJan Kiszka@end example 948ad196a9dSJan Kiszkamust be added in the file @file{C:\WINDOWS\LMHOSTS} (for windows 9x/Me) 949ad196a9dSJan Kiszkaor @file{C:\WINNT\SYSTEM32\DRIVERS\ETC\LMHOSTS} (Windows NT/2000). 950ad196a9dSJan Kiszka 951ad196a9dSJan KiszkaThen @file{@var{dir}} can be accessed in @file{\\smbserver\qemu}. 952ad196a9dSJan Kiszka 953ad196a9dSJan KiszkaNote that a SAMBA server must be installed on the host OS in 954ad196a9dSJan Kiszka@file{/usr/sbin/smbd}. QEMU was tested successfully with smbd versions from 955ad196a9dSJan KiszkaRed Hat 9, Fedora Core 3 and OpenSUSE 11.x. 956ad196a9dSJan Kiszka 9573c6a0580SJan Kiszka@item hostfwd=[tcp|udp]:[@var{hostaddr}]:@var{hostport}-[@var{guestaddr}]:@var{guestport} 958c92ef6a2SJan KiszkaRedirect incoming TCP or UDP connections to the host port @var{hostport} to 959c92ef6a2SJan Kiszkathe guest IP address @var{guestaddr} on guest port @var{guestport}. If 960c92ef6a2SJan Kiszka@var{guestaddr} is not specified, its value is x.x.x.15 (default first address 9613c6a0580SJan Kiszkagiven by the built-in DHCP server). By specifying @var{hostaddr}, the rule can 9623c6a0580SJan Kiszkabe bound to a specific host interface. If no connection type is set, TCP is 963c92ef6a2SJan Kiszkaused. This option can be given multiple times. 964ad196a9dSJan Kiszka 965ad196a9dSJan KiszkaFor example, to redirect host X11 connection from screen 1 to guest 966ad196a9dSJan Kiszkascreen 0, use the following: 967ad196a9dSJan Kiszka 968ad196a9dSJan Kiszka@example 969ad196a9dSJan Kiszka# on the host 9703c6a0580SJan Kiszkaqemu -net user,hostfwd=tcp:127.0.0.1:6001-:6000 [...] 971ad196a9dSJan Kiszka# this host xterm should open in the guest X11 server 972ad196a9dSJan Kiszkaxterm -display :1 973ad196a9dSJan Kiszka@end example 974ad196a9dSJan Kiszka 975ad196a9dSJan KiszkaTo redirect telnet connections from host port 5555 to telnet port on 976ad196a9dSJan Kiszkathe guest, use the following: 977ad196a9dSJan Kiszka 978ad196a9dSJan Kiszka@example 979ad196a9dSJan Kiszka# on the host 980c92ef6a2SJan Kiszkaqemu -net user,hostfwd=tcp:5555::23 [...] 981ad196a9dSJan Kiszkatelnet localhost 5555 982ad196a9dSJan Kiszka@end example 983ad196a9dSJan Kiszka 984ad196a9dSJan KiszkaThen when you use on the host @code{telnet localhost 5555}, you 985ad196a9dSJan Kiszkaconnect to the guest telnet server. 986ad196a9dSJan Kiszka 987c92ef6a2SJan Kiszka@item guestfwd=[tcp]:@var{server}:@var{port}-@var{dev} 9883c6a0580SJan KiszkaForward guest TCP connections to the IP address @var{server} on port @var{port} 9893c6a0580SJan Kiszkato the character device @var{dev}. This option can be given multiple times. 990ad196a9dSJan Kiszka 991ad196a9dSJan Kiszka@end table 992ad196a9dSJan Kiszka 993ad196a9dSJan KiszkaNote: Legacy stand-alone options -tftp, -bootp, -smb and -redir are still 994ad196a9dSJan Kiszkaprocessed and applied to -net user. Mixing them with the new configuration 995ad196a9dSJan Kiszkasyntax gives undefined results. Their use for new applications is discouraged 996ad196a9dSJan Kiszkaas they will be removed from future versions. 9975824d651Sblueswir1 9985824d651Sblueswir1@item -net tap[,vlan=@var{n}][,name=@var{name}][,fd=@var{h}][,ifname=@var{name}][,script=@var{file}][,downscript=@var{dfile}] 9995824d651Sblueswir1Connect the host TAP network interface @var{name} to VLAN @var{n}, use 10005824d651Sblueswir1the network script @var{file} to configure it and the network script 10015824d651Sblueswir1@var{dfile} to deconfigure it. If @var{name} is not provided, the OS 10025824d651Sblueswir1automatically provides one. @option{fd}=@var{h} can be used to specify 10035824d651Sblueswir1the handle of an already opened host TAP interface. The default network 10045824d651Sblueswir1configure script is @file{/etc/qemu-ifup} and the default network 10055824d651Sblueswir1deconfigure script is @file{/etc/qemu-ifdown}. Use @option{script=no} 10065824d651Sblueswir1or @option{downscript=no} to disable script execution. Example: 10075824d651Sblueswir1 10085824d651Sblueswir1@example 10095824d651Sblueswir1qemu linux.img -net nic -net tap 10105824d651Sblueswir1@end example 10115824d651Sblueswir1 10125824d651Sblueswir1More complicated example (two NICs, each one connected to a TAP device) 10135824d651Sblueswir1@example 10145824d651Sblueswir1qemu linux.img -net nic,vlan=0 -net tap,vlan=0,ifname=tap0 \ 10155824d651Sblueswir1 -net nic,vlan=1 -net tap,vlan=1,ifname=tap1 10165824d651Sblueswir1@end example 10175824d651Sblueswir1 10185824d651Sblueswir1@item -net socket[,vlan=@var{n}][,name=@var{name}][,fd=@var{h}][,listen=[@var{host}]:@var{port}][,connect=@var{host}:@var{port}] 10195824d651Sblueswir1 10205824d651Sblueswir1Connect the VLAN @var{n} to a remote VLAN in another QEMU virtual 10215824d651Sblueswir1machine using a TCP socket connection. If @option{listen} is 10225824d651Sblueswir1specified, QEMU waits for incoming connections on @var{port} 10235824d651Sblueswir1(@var{host} is optional). @option{connect} is used to connect to 10245824d651Sblueswir1another QEMU instance using the @option{listen} option. @option{fd}=@var{h} 10255824d651Sblueswir1specifies an already opened TCP socket. 10265824d651Sblueswir1 10275824d651Sblueswir1Example: 10285824d651Sblueswir1@example 10295824d651Sblueswir1# launch a first QEMU instance 10305824d651Sblueswir1qemu linux.img -net nic,macaddr=52:54:00:12:34:56 \ 10315824d651Sblueswir1 -net socket,listen=:1234 10325824d651Sblueswir1# connect the VLAN 0 of this instance to the VLAN 0 10335824d651Sblueswir1# of the first instance 10345824d651Sblueswir1qemu linux.img -net nic,macaddr=52:54:00:12:34:57 \ 10355824d651Sblueswir1 -net socket,connect=127.0.0.1:1234 10365824d651Sblueswir1@end example 10375824d651Sblueswir1 10385824d651Sblueswir1@item -net socket[,vlan=@var{n}][,name=@var{name}][,fd=@var{h}][,mcast=@var{maddr}:@var{port}] 10395824d651Sblueswir1 10405824d651Sblueswir1Create a VLAN @var{n} shared with another QEMU virtual 10415824d651Sblueswir1machines using a UDP multicast socket, effectively making a bus for 10425824d651Sblueswir1every QEMU with same multicast address @var{maddr} and @var{port}. 10435824d651Sblueswir1NOTES: 10445824d651Sblueswir1@enumerate 10455824d651Sblueswir1@item 10465824d651Sblueswir1Several QEMU can be running on different hosts and share same bus (assuming 10475824d651Sblueswir1correct multicast setup for these hosts). 10485824d651Sblueswir1@item 10495824d651Sblueswir1mcast support is compatible with User Mode Linux (argument @option{eth@var{N}=mcast}), see 10505824d651Sblueswir1@url{http://user-mode-linux.sf.net}. 10515824d651Sblueswir1@item 10525824d651Sblueswir1Use @option{fd=h} to specify an already opened UDP multicast socket. 10535824d651Sblueswir1@end enumerate 10545824d651Sblueswir1 10555824d651Sblueswir1Example: 10565824d651Sblueswir1@example 10575824d651Sblueswir1# launch one QEMU instance 10585824d651Sblueswir1qemu linux.img -net nic,macaddr=52:54:00:12:34:56 \ 10595824d651Sblueswir1 -net socket,mcast=230.0.0.1:1234 10605824d651Sblueswir1# launch another QEMU instance on same "bus" 10615824d651Sblueswir1qemu linux.img -net nic,macaddr=52:54:00:12:34:57 \ 10625824d651Sblueswir1 -net socket,mcast=230.0.0.1:1234 10635824d651Sblueswir1# launch yet another QEMU instance on same "bus" 10645824d651Sblueswir1qemu linux.img -net nic,macaddr=52:54:00:12:34:58 \ 10655824d651Sblueswir1 -net socket,mcast=230.0.0.1:1234 10665824d651Sblueswir1@end example 10675824d651Sblueswir1 10685824d651Sblueswir1Example (User Mode Linux compat.): 10695824d651Sblueswir1@example 10705824d651Sblueswir1# launch QEMU instance (note mcast address selected 10715824d651Sblueswir1# is UML's default) 10725824d651Sblueswir1qemu linux.img -net nic,macaddr=52:54:00:12:34:56 \ 10735824d651Sblueswir1 -net socket,mcast=239.192.168.1:1102 10745824d651Sblueswir1# launch UML 10755824d651Sblueswir1/path/to/linux ubd0=/path/to/root_fs eth0=mcast 10765824d651Sblueswir1@end example 10775824d651Sblueswir1 10785824d651Sblueswir1@item -net vde[,vlan=@var{n}][,name=@var{name}][,sock=@var{socketpath}][,port=@var{n}][,group=@var{groupname}][,mode=@var{octalmode}] 10795824d651Sblueswir1Connect VLAN @var{n} to PORT @var{n} of a vde switch running on host and 10805824d651Sblueswir1listening for incoming connections on @var{socketpath}. Use GROUP @var{groupname} 10815824d651Sblueswir1and MODE @var{octalmode} to change default ownership and permissions for 10825824d651Sblueswir1communication port. This option is available only if QEMU has been compiled 10835824d651Sblueswir1with vde support enabled. 10845824d651Sblueswir1 10855824d651Sblueswir1Example: 10865824d651Sblueswir1@example 10875824d651Sblueswir1# launch vde switch 10885824d651Sblueswir1vde_switch -F -sock /tmp/myswitch 10895824d651Sblueswir1# launch QEMU instance 10905824d651Sblueswir1qemu linux.img -net nic -net vde,sock=/tmp/myswitch 10915824d651Sblueswir1@end example 10925824d651Sblueswir1 1093bb9ea79eSaliguori@item -net dump[,vlan=@var{n}][,file=@var{file}][,len=@var{len}] 1094bb9ea79eSaliguoriDump network traffic on VLAN @var{n} to file @var{file} (@file{qemu-vlan0.pcap} by default). 1095bb9ea79eSaliguoriAt most @var{len} bytes (64k by default) per packet are stored. The file format is 1096bb9ea79eSaliguorilibpcap, so it can be analyzed with tools such as tcpdump or Wireshark. 1097bb9ea79eSaliguori 10985824d651Sblueswir1@item -net none 10995824d651Sblueswir1Indicate that no network devices should be configured. It is used to 11005824d651Sblueswir1override the default configuration (@option{-net nic -net user}) which 11015824d651Sblueswir1is activated if no @option{-net} options are provided. 11025824d651Sblueswir1 11035824d651Sblueswir1@end table 11045824d651Sblueswir1ETEXI 11055824d651Sblueswir1 11067273a2dbSMatthew BoothDEFHEADING() 11077273a2dbSMatthew Booth 11087273a2dbSMatthew BoothDEFHEADING(Character device options:) 11097273a2dbSMatthew Booth 11107273a2dbSMatthew BoothDEF("chardev", HAS_ARG, QEMU_OPTION_chardev, 11117273a2dbSMatthew Booth "-chardev null,id=id\n" 11127273a2dbSMatthew Booth "-chardev socket,id=id[,host=host],port=host[,to=to][,ipv4][,ipv6][,nodelay]\n" 11137273a2dbSMatthew Booth " [,server][,nowait][,telnet] (tcp)\n" 11147273a2dbSMatthew Booth "-chardev socket,id=id,path=path[,server][,nowait][,telnet] (unix)\n" 11157273a2dbSMatthew Booth "-chardev udp,id=id[,host=host],port=port[,localaddr=localaddr]\n" 11167273a2dbSMatthew Booth " [,localport=localport][,ipv4][,ipv6]\n" 11177273a2dbSMatthew Booth "-chardev msmouse,id=id\n" 11187273a2dbSMatthew Booth "-chardev vc,id=id[[,width=width][,height=height]][[,cols=cols][,rows=rows]]\n" 11197273a2dbSMatthew Booth "-chardev file,id=id,path=path\n" 11207273a2dbSMatthew Booth "-chardev pipe,id=id,path=path\n" 11217273a2dbSMatthew Booth#ifdef _WIN32 11227273a2dbSMatthew Booth "-chardev console,id=id\n" 11237273a2dbSMatthew Booth "-chardev serial,id=id,path=path\n" 11247273a2dbSMatthew Booth#else 11257273a2dbSMatthew Booth "-chardev pty,id=id\n" 11267273a2dbSMatthew Booth "-chardev stdio,id=id\n" 11277273a2dbSMatthew Booth#endif 11287273a2dbSMatthew Booth#ifdef CONFIG_BRLAPI 11297273a2dbSMatthew Booth "-chardev braille,id=id\n" 11307273a2dbSMatthew Booth#endif 11317273a2dbSMatthew Booth#if defined(__linux__) || defined(__sun__) || defined(__FreeBSD__) \ 11327273a2dbSMatthew Booth || defined(__NetBSD__) || defined(__OpenBSD__) || defined(__DragonFly__) 11337273a2dbSMatthew Booth "-chardev tty,id=id,path=path\n" 11347273a2dbSMatthew Booth#endif 11357273a2dbSMatthew Booth#if defined(__linux__) || defined(__FreeBSD__) || defined(__DragonFly__) 11367273a2dbSMatthew Booth "-chardev parport,id=id,path=path\n" 11377273a2dbSMatthew Booth#endif 11387273a2dbSMatthew Booth) 11397273a2dbSMatthew Booth 11407273a2dbSMatthew BoothSTEXI 11417273a2dbSMatthew Booth 11427273a2dbSMatthew BoothThe general form of a character device option is: 11437273a2dbSMatthew Booth@table @option 11447273a2dbSMatthew Booth 11457273a2dbSMatthew Booth@item -chardev @var{backend} ,id=@var{id} [,@var{options}] 11467273a2dbSMatthew Booth 11477273a2dbSMatthew BoothBackend is one of: 11487273a2dbSMatthew Booth@option{null}, 11497273a2dbSMatthew Booth@option{socket}, 11507273a2dbSMatthew Booth@option{udp}, 11517273a2dbSMatthew Booth@option{msmouse}, 11527273a2dbSMatthew Booth@option{vc}, 11537273a2dbSMatthew Booth@option{file}, 11547273a2dbSMatthew Booth@option{pipe}, 11557273a2dbSMatthew Booth@option{console}, 11567273a2dbSMatthew Booth@option{serial}, 11577273a2dbSMatthew Booth@option{pty}, 11587273a2dbSMatthew Booth@option{stdio}, 11597273a2dbSMatthew Booth@option{braille}, 11607273a2dbSMatthew Booth@option{tty}, 11617273a2dbSMatthew Booth@option{parport}. 11627273a2dbSMatthew BoothThe specific backend will determine the applicable options. 11637273a2dbSMatthew Booth 11647273a2dbSMatthew BoothAll devices must have an id, which can be any string up to 127 characters long. 11657273a2dbSMatthew BoothIt is used to uniquely identify this device in other command line directives. 11667273a2dbSMatthew Booth 11677273a2dbSMatthew BoothOptions to each backend are described below. 11687273a2dbSMatthew Booth 11697273a2dbSMatthew Booth@item -chardev null ,id=@var{id} 11707273a2dbSMatthew BoothA void device. This device will not emit any data, and will drop any data it 11717273a2dbSMatthew Boothreceives. The null backend does not take any options. 11727273a2dbSMatthew Booth 11737273a2dbSMatthew Booth@item -chardev socket ,id=@var{id} [@var{TCP options} or @var{unix options}] [,server] [,nowait] [,telnet] 11747273a2dbSMatthew Booth 11757273a2dbSMatthew BoothCreate a two-way stream socket, which can be either a TCP or a unix socket. A 11767273a2dbSMatthew Boothunix socket will be created if @option{path} is specified. Behaviour is 11777273a2dbSMatthew Boothundefined if TCP options are specified for a unix socket. 11787273a2dbSMatthew Booth 11797273a2dbSMatthew Booth@option{server} specifies that the socket shall be a listening socket. 11807273a2dbSMatthew Booth 11817273a2dbSMatthew Booth@option{nowait} specifies that QEMU should not block waiting for a client to 11827273a2dbSMatthew Boothconnect to a listening socket. 11837273a2dbSMatthew Booth 11847273a2dbSMatthew Booth@option{telnet} specifies that traffic on the socket should interpret telnet 11857273a2dbSMatthew Boothescape sequences. 11867273a2dbSMatthew Booth 11877273a2dbSMatthew BoothTCP and unix socket options are given below: 11887273a2dbSMatthew Booth 11897273a2dbSMatthew Booth@table @option 11907273a2dbSMatthew Booth 11917273a2dbSMatthew Booth@item TCP options: port=@var{host} [,host=@var{host}] [,to=@var{to}] [,ipv4] [,ipv6] [,nodelay] 11927273a2dbSMatthew Booth 11937273a2dbSMatthew Booth@option{host} for a listening socket specifies the local address to be bound. 11947273a2dbSMatthew BoothFor a connecting socket species the remote host to connect to. @option{host} is 11957273a2dbSMatthew Boothoptional for listening sockets. If not specified it defaults to @code{0.0.0.0}. 11967273a2dbSMatthew Booth 11977273a2dbSMatthew Booth@option{port} for a listening socket specifies the local port to be bound. For a 11987273a2dbSMatthew Boothconnecting socket specifies the port on the remote host to connect to. 11997273a2dbSMatthew Booth@option{port} can be given as either a port number or a service name. 12007273a2dbSMatthew Booth@option{port} is required. 12017273a2dbSMatthew Booth 12027273a2dbSMatthew Booth@option{to} is only relevant to listening sockets. If it is specified, and 12037273a2dbSMatthew Booth@option{port} cannot be bound, QEMU will attempt to bind to subsequent ports up 12047273a2dbSMatthew Boothto and including @option{to} until it succeeds. @option{to} must be specified 12057273a2dbSMatthew Boothas a port number. 12067273a2dbSMatthew Booth 12077273a2dbSMatthew Booth@option{ipv4} and @option{ipv6} specify that either IPv4 or IPv6 must be used. 12087273a2dbSMatthew BoothIf neither is specified the socket may use either protocol. 12097273a2dbSMatthew Booth 12107273a2dbSMatthew Booth@option{nodelay} disables the Nagle algorithm. 12117273a2dbSMatthew Booth 12127273a2dbSMatthew Booth@item unix options: path=@var{path} 12137273a2dbSMatthew Booth 12147273a2dbSMatthew Booth@option{path} specifies the local path of the unix socket. @option{path} is 12157273a2dbSMatthew Boothrequired. 12167273a2dbSMatthew Booth 12177273a2dbSMatthew Booth@end table 12187273a2dbSMatthew Booth 12197273a2dbSMatthew Booth@item -chardev udp ,id=@var{id} [,host=@var{host}] ,port=@var{port} [,localaddr=@var{localaddr}] [,localport=@var{localport}] [,ipv4] [,ipv6] 12207273a2dbSMatthew Booth 12217273a2dbSMatthew BoothSends all traffic from the guest to a remote host over UDP. 12227273a2dbSMatthew Booth 12237273a2dbSMatthew Booth@option{host} specifies the remote host to connect to. If not specified it 12247273a2dbSMatthew Boothdefaults to @code{localhost}. 12257273a2dbSMatthew Booth 12267273a2dbSMatthew Booth@option{port} specifies the port on the remote host to connect to. @option{port} 12277273a2dbSMatthew Boothis required. 12287273a2dbSMatthew Booth 12297273a2dbSMatthew Booth@option{localaddr} specifies the local address to bind to. If not specified it 12307273a2dbSMatthew Boothdefaults to @code{0.0.0.0}. 12317273a2dbSMatthew Booth 12327273a2dbSMatthew Booth@option{localport} specifies the local port to bind to. If not specified any 12337273a2dbSMatthew Boothavailable local port will be used. 12347273a2dbSMatthew Booth 12357273a2dbSMatthew Booth@option{ipv4} and @option{ipv6} specify that either IPv4 or IPv6 must be used. 12367273a2dbSMatthew BoothIf neither is specified the device may use either protocol. 12377273a2dbSMatthew Booth 12387273a2dbSMatthew Booth@item -chardev msmouse ,id=@var{id} 12397273a2dbSMatthew Booth 12407273a2dbSMatthew BoothForward QEMU's emulated msmouse events to the guest. @option{msmouse} does not 12417273a2dbSMatthew Boothtake any options. 12427273a2dbSMatthew Booth 12437273a2dbSMatthew Booth@item -chardev vc ,id=@var{id} [[,width=@var{width}] [,height=@var{height}]] [[,cols=@var{cols}] [,rows=@var{rows}]] 12447273a2dbSMatthew Booth 12457273a2dbSMatthew BoothConnect to a QEMU text console. @option{vc} may optionally be given a specific 12467273a2dbSMatthew Boothsize. 12477273a2dbSMatthew Booth 12487273a2dbSMatthew Booth@option{width} and @option{height} specify the width and height respectively of 12497273a2dbSMatthew Booththe console, in pixels. 12507273a2dbSMatthew Booth 12517273a2dbSMatthew Booth@option{cols} and @option{rows} specify that the console be sized to fit a text 12527273a2dbSMatthew Boothconsole with the given dimensions. 12537273a2dbSMatthew Booth 12547273a2dbSMatthew Booth@item -chardev file ,id=@var{id} ,path=@var{path} 12557273a2dbSMatthew Booth 12567273a2dbSMatthew BoothLog all traffic received from the guest to a file. 12577273a2dbSMatthew Booth 12587273a2dbSMatthew Booth@option{path} specifies the path of the file to be opened. This file will be 12597273a2dbSMatthew Boothcreated if it does not already exist, and overwritten if it does. @option{path} 12607273a2dbSMatthew Boothis required. 12617273a2dbSMatthew Booth 12627273a2dbSMatthew Booth@item -chardev pipe ,id=@var{id} ,path=@var{path} 12637273a2dbSMatthew Booth 12647273a2dbSMatthew BoothCreate a two-way connection to the guest. The behaviour differs slightly between 12657273a2dbSMatthew BoothWindows hosts and other hosts: 12667273a2dbSMatthew Booth 12677273a2dbSMatthew BoothOn Windows, a single duplex pipe will be created at 12687273a2dbSMatthew Booth@file{\\.pipe\@option{path}}. 12697273a2dbSMatthew Booth 12707273a2dbSMatthew BoothOn other hosts, 2 pipes will be created called @file{@option{path}.in} and 12717273a2dbSMatthew Booth@file{@option{path}.out}. Data written to @file{@option{path}.in} will be 12727273a2dbSMatthew Boothreceived by the guest. Data written by the guest can be read from 12737273a2dbSMatthew Booth@file{@option{path}.out}. QEMU will not create these fifos, and requires them to 12747273a2dbSMatthew Boothbe present. 12757273a2dbSMatthew Booth 12767273a2dbSMatthew Booth@option{path} forms part of the pipe path as described above. @option{path} is 12777273a2dbSMatthew Boothrequired. 12787273a2dbSMatthew Booth 12797273a2dbSMatthew Booth@item -chardev console ,id=@var{id} 12807273a2dbSMatthew Booth 12817273a2dbSMatthew BoothSend traffic from the guest to QEMU's standard output. @option{console} does not 12827273a2dbSMatthew Boothtake any options. 12837273a2dbSMatthew Booth 12847273a2dbSMatthew Booth@option{console} is only available on Windows hosts. 12857273a2dbSMatthew Booth 12867273a2dbSMatthew Booth@item -chardev serial ,id=@var{id} ,path=@option{path} 12877273a2dbSMatthew Booth 12887273a2dbSMatthew BoothSend traffic from the guest to a serial device on the host. 12897273a2dbSMatthew Booth 12907273a2dbSMatthew Booth@option{serial} is 12917273a2dbSMatthew Boothonly available on Windows hosts. 12927273a2dbSMatthew Booth 12937273a2dbSMatthew Booth@option{path} specifies the name of the serial device to open. 12947273a2dbSMatthew Booth 12957273a2dbSMatthew Booth@item -chardev pty ,id=@var{id} 12967273a2dbSMatthew Booth 12977273a2dbSMatthew BoothCreate a new pseudo-terminal on the host and connect to it. @option{pty} does 12987273a2dbSMatthew Boothnot take any options. 12997273a2dbSMatthew Booth 13007273a2dbSMatthew Booth@option{pty} is not available on Windows hosts. 13017273a2dbSMatthew Booth 13027273a2dbSMatthew Booth@item -chardev stdio ,id=@var{id} 13037273a2dbSMatthew BoothConnect to standard input and standard output of the qemu process. 13047273a2dbSMatthew Booth@option{stdio} does not take any options. @option{stdio} is not available on 13057273a2dbSMatthew BoothWindows hosts. 13067273a2dbSMatthew Booth 13077273a2dbSMatthew Booth@item -chardev braille ,id=@var{id} 13087273a2dbSMatthew Booth 13097273a2dbSMatthew BoothConnect to a local BrlAPI server. @option{braille} does not take any options. 13107273a2dbSMatthew Booth 13117273a2dbSMatthew Booth@item -chardev tty ,id=@var{id} ,path=@var{path} 13127273a2dbSMatthew Booth 13137273a2dbSMatthew BoothConnect to a local tty device. 13147273a2dbSMatthew Booth 13157273a2dbSMatthew Booth@option{tty} is only available on Linux, Sun, FreeBSD, NetBSD, OpenBSD and 13167273a2dbSMatthew BoothDragonFlyBSD hosts. 13177273a2dbSMatthew Booth 13187273a2dbSMatthew Booth@option{path} specifies the path to the tty. @option{path} is required. 13197273a2dbSMatthew Booth 13207273a2dbSMatthew Booth@item -chardev parport ,id=@var{id} ,path=@var{path} 13217273a2dbSMatthew Booth 13227273a2dbSMatthew Booth@option{parport} is only available on Linux, FreeBSD and DragonFlyBSD hosts. 13237273a2dbSMatthew Booth 13247273a2dbSMatthew BoothConnect to a local parallel port. 13257273a2dbSMatthew Booth 13267273a2dbSMatthew Booth@option{path} specifies the path to the parallel port device. @option{path} is 13277273a2dbSMatthew Boothrequired. 13287273a2dbSMatthew Booth 13297273a2dbSMatthew Booth@end table 13307273a2dbSMatthew BoothETEXI 13317273a2dbSMatthew Booth 13327273a2dbSMatthew BoothDEFHEADING() 13337273a2dbSMatthew Booth 13347273a2dbSMatthew BoothDEFHEADING(Bluetooth(R) options:) 13357273a2dbSMatthew Booth 13365824d651Sblueswir1DEF("bt", HAS_ARG, QEMU_OPTION_bt, \ 13375824d651Sblueswir1 "-bt hci,null dumb bluetooth HCI - doesn't respond to commands\n" \ 13385824d651Sblueswir1 "-bt hci,host[:id]\n" \ 13395824d651Sblueswir1 " use host's HCI with the given name\n" \ 13405824d651Sblueswir1 "-bt hci[,vlan=n]\n" \ 13415824d651Sblueswir1 " emulate a standard HCI in virtual scatternet 'n'\n" \ 13425824d651Sblueswir1 "-bt vhci[,vlan=n]\n" \ 13435824d651Sblueswir1 " add host computer to virtual scatternet 'n' using VHCI\n" \ 13445824d651Sblueswir1 "-bt device:dev[,vlan=n]\n" \ 13455824d651Sblueswir1 " emulate a bluetooth device 'dev' in scatternet 'n'\n") 13465824d651Sblueswir1STEXI 13475824d651Sblueswir1@table @option 13485824d651Sblueswir1 13495824d651Sblueswir1@item -bt hci[...] 13505824d651Sblueswir1Defines the function of the corresponding Bluetooth HCI. -bt options 13515824d651Sblueswir1are matched with the HCIs present in the chosen machine type. For 13525824d651Sblueswir1example when emulating a machine with only one HCI built into it, only 13535824d651Sblueswir1the first @code{-bt hci[...]} option is valid and defines the HCI's 13545824d651Sblueswir1logic. The Transport Layer is decided by the machine type. Currently 13555824d651Sblueswir1the machines @code{n800} and @code{n810} have one HCI and all other 13565824d651Sblueswir1machines have none. 13575824d651Sblueswir1 13585824d651Sblueswir1@anchor{bt-hcis} 13595824d651Sblueswir1The following three types are recognized: 13605824d651Sblueswir1 1361b3f046c2SKevin Wolf@table @option 13625824d651Sblueswir1@item -bt hci,null 13635824d651Sblueswir1(default) The corresponding Bluetooth HCI assumes no internal logic 13645824d651Sblueswir1and will not respond to any HCI commands or emit events. 13655824d651Sblueswir1 13665824d651Sblueswir1@item -bt hci,host[:@var{id}] 13675824d651Sblueswir1(@code{bluez} only) The corresponding HCI passes commands / events 13685824d651Sblueswir1to / from the physical HCI identified by the name @var{id} (default: 13695824d651Sblueswir1@code{hci0}) on the computer running QEMU. Only available on @code{bluez} 13705824d651Sblueswir1capable systems like Linux. 13715824d651Sblueswir1 13725824d651Sblueswir1@item -bt hci[,vlan=@var{n}] 13735824d651Sblueswir1Add a virtual, standard HCI that will participate in the Bluetooth 13745824d651Sblueswir1scatternet @var{n} (default @code{0}). Similarly to @option{-net} 13755824d651Sblueswir1VLANs, devices inside a bluetooth network @var{n} can only communicate 13765824d651Sblueswir1with other devices in the same network (scatternet). 13775824d651Sblueswir1@end table 13785824d651Sblueswir1 13795824d651Sblueswir1@item -bt vhci[,vlan=@var{n}] 13805824d651Sblueswir1(Linux-host only) Create a HCI in scatternet @var{n} (default 0) attached 13815824d651Sblueswir1to the host bluetooth stack instead of to the emulated target. This 13825824d651Sblueswir1allows the host and target machines to participate in a common scatternet 13835824d651Sblueswir1and communicate. Requires the Linux @code{vhci} driver installed. Can 13845824d651Sblueswir1be used as following: 13855824d651Sblueswir1 13865824d651Sblueswir1@example 13875824d651Sblueswir1qemu [...OPTIONS...] -bt hci,vlan=5 -bt vhci,vlan=5 13885824d651Sblueswir1@end example 13895824d651Sblueswir1 13905824d651Sblueswir1@item -bt device:@var{dev}[,vlan=@var{n}] 13915824d651Sblueswir1Emulate a bluetooth device @var{dev} and place it in network @var{n} 13925824d651Sblueswir1(default @code{0}). QEMU can only emulate one type of bluetooth devices 13935824d651Sblueswir1currently: 13945824d651Sblueswir1 1395b3f046c2SKevin Wolf@table @option 13965824d651Sblueswir1@item keyboard 13975824d651Sblueswir1Virtual wireless keyboard implementing the HIDP bluetooth profile. 13985824d651Sblueswir1@end table 13995824d651Sblueswir1@end table 14005824d651Sblueswir1ETEXI 14015824d651Sblueswir1 14025824d651Sblueswir1DEFHEADING() 14035824d651Sblueswir1 14047677f05dSAlexander GrafDEFHEADING(Linux/Multiboot boot specific:) 14055824d651Sblueswir1STEXI 14067677f05dSAlexander Graf 14077677f05dSAlexander GrafWhen using these options, you can use a given Linux or Multiboot 14087677f05dSAlexander Grafkernel without installing it in the disk image. It can be useful 14095824d651Sblueswir1for easier testing of various kernels. 14105824d651Sblueswir1 14115824d651Sblueswir1@table @option 14125824d651Sblueswir1ETEXI 14135824d651Sblueswir1 14145824d651Sblueswir1DEF("kernel", HAS_ARG, QEMU_OPTION_kernel, \ 14155824d651Sblueswir1 "-kernel bzImage use 'bzImage' as kernel image\n") 14165824d651Sblueswir1STEXI 14175824d651Sblueswir1@item -kernel @var{bzImage} 14187677f05dSAlexander GrafUse @var{bzImage} as kernel image. The kernel can be either a Linux kernel 14197677f05dSAlexander Grafor in multiboot format. 14205824d651Sblueswir1ETEXI 14215824d651Sblueswir1 14225824d651Sblueswir1DEF("append", HAS_ARG, QEMU_OPTION_append, \ 14235824d651Sblueswir1 "-append cmdline use 'cmdline' as kernel command line\n") 14245824d651Sblueswir1STEXI 14255824d651Sblueswir1@item -append @var{cmdline} 14265824d651Sblueswir1Use @var{cmdline} as kernel command line 14275824d651Sblueswir1ETEXI 14285824d651Sblueswir1 14295824d651Sblueswir1DEF("initrd", HAS_ARG, QEMU_OPTION_initrd, \ 14305824d651Sblueswir1 "-initrd file use 'file' as initial ram disk\n") 14315824d651Sblueswir1STEXI 14325824d651Sblueswir1@item -initrd @var{file} 14335824d651Sblueswir1Use @var{file} as initial ram disk. 14347677f05dSAlexander Graf 14357677f05dSAlexander Graf@item -initrd "@var{file1} arg=foo,@var{file2}" 14367677f05dSAlexander Graf 14377677f05dSAlexander GrafThis syntax is only available with multiboot. 14387677f05dSAlexander Graf 14397677f05dSAlexander GrafUse @var{file1} and @var{file2} as modules and pass arg=foo as parameter to the 14407677f05dSAlexander Graffirst module. 14415824d651Sblueswir1ETEXI 14425824d651Sblueswir1 14435824d651Sblueswir1STEXI 14445824d651Sblueswir1@end table 14455824d651Sblueswir1ETEXI 14465824d651Sblueswir1 14475824d651Sblueswir1DEFHEADING() 14485824d651Sblueswir1 14495824d651Sblueswir1DEFHEADING(Debug/Expert options:) 14505824d651Sblueswir1 14515824d651Sblueswir1STEXI 14525824d651Sblueswir1@table @option 14535824d651Sblueswir1ETEXI 14545824d651Sblueswir1 14555824d651Sblueswir1DEF("serial", HAS_ARG, QEMU_OPTION_serial, \ 14565824d651Sblueswir1 "-serial dev redirect the serial port to char device 'dev'\n") 14575824d651Sblueswir1STEXI 14585824d651Sblueswir1@item -serial @var{dev} 14595824d651Sblueswir1Redirect the virtual serial port to host character device 14605824d651Sblueswir1@var{dev}. The default device is @code{vc} in graphical mode and 14615824d651Sblueswir1@code{stdio} in non graphical mode. 14625824d651Sblueswir1 14635824d651Sblueswir1This option can be used several times to simulate up to 4 serial 14645824d651Sblueswir1ports. 14655824d651Sblueswir1 14665824d651Sblueswir1Use @code{-serial none} to disable all serial ports. 14675824d651Sblueswir1 14685824d651Sblueswir1Available character devices are: 1469b3f046c2SKevin Wolf@table @option 14704e257e5eSKevin Wolf@item vc[:@var{W}x@var{H}] 14715824d651Sblueswir1Virtual console. Optionally, a width and height can be given in pixel with 14725824d651Sblueswir1@example 14735824d651Sblueswir1vc:800x600 14745824d651Sblueswir1@end example 14755824d651Sblueswir1It is also possible to specify width or height in characters: 14765824d651Sblueswir1@example 14775824d651Sblueswir1vc:80Cx24C 14785824d651Sblueswir1@end example 14795824d651Sblueswir1@item pty 14805824d651Sblueswir1[Linux only] Pseudo TTY (a new PTY is automatically allocated) 14815824d651Sblueswir1@item none 14825824d651Sblueswir1No device is allocated. 14835824d651Sblueswir1@item null 14845824d651Sblueswir1void device 14855824d651Sblueswir1@item /dev/XXX 14865824d651Sblueswir1[Linux only] Use host tty, e.g. @file{/dev/ttyS0}. The host serial port 14875824d651Sblueswir1parameters are set according to the emulated ones. 14885824d651Sblueswir1@item /dev/parport@var{N} 14895824d651Sblueswir1[Linux only, parallel port only] Use host parallel port 14905824d651Sblueswir1@var{N}. Currently SPP and EPP parallel port features can be used. 14915824d651Sblueswir1@item file:@var{filename} 14925824d651Sblueswir1Write output to @var{filename}. No character can be read. 14935824d651Sblueswir1@item stdio 14945824d651Sblueswir1[Unix only] standard input/output 14955824d651Sblueswir1@item pipe:@var{filename} 14965824d651Sblueswir1name pipe @var{filename} 14975824d651Sblueswir1@item COM@var{n} 14985824d651Sblueswir1[Windows only] Use host serial port @var{n} 14995824d651Sblueswir1@item udp:[@var{remote_host}]:@var{remote_port}[@@[@var{src_ip}]:@var{src_port}] 15005824d651Sblueswir1This implements UDP Net Console. 15015824d651Sblueswir1When @var{remote_host} or @var{src_ip} are not specified 15025824d651Sblueswir1they default to @code{0.0.0.0}. 15035824d651Sblueswir1When not using a specified @var{src_port} a random port is automatically chosen. 15045824d651Sblueswir1 15055824d651Sblueswir1If you just want a simple readonly console you can use @code{netcat} or 15065824d651Sblueswir1@code{nc}, by starting qemu with: @code{-serial udp::4555} and nc as: 15075824d651Sblueswir1@code{nc -u -l -p 4555}. Any time qemu writes something to that port it 15085824d651Sblueswir1will appear in the netconsole session. 15095824d651Sblueswir1 15105824d651Sblueswir1If you plan to send characters back via netconsole or you want to stop 15115824d651Sblueswir1and start qemu a lot of times, you should have qemu use the same 15125824d651Sblueswir1source port each time by using something like @code{-serial 15135824d651Sblueswir1udp::4555@@:4556} to qemu. Another approach is to use a patched 15145824d651Sblueswir1version of netcat which can listen to a TCP port and send and receive 15155824d651Sblueswir1characters via udp. If you have a patched version of netcat which 15165824d651Sblueswir1activates telnet remote echo and single char transfer, then you can 15175824d651Sblueswir1use the following options to step up a netcat redirector to allow 15185824d651Sblueswir1telnet on port 5555 to access the qemu port. 15195824d651Sblueswir1@table @code 15205824d651Sblueswir1@item Qemu Options: 15215824d651Sblueswir1-serial udp::4555@@:4556 15225824d651Sblueswir1@item netcat options: 15235824d651Sblueswir1-u -P 4555 -L 0.0.0.0:4556 -t -p 5555 -I -T 15245824d651Sblueswir1@item telnet options: 15255824d651Sblueswir1localhost 5555 15265824d651Sblueswir1@end table 15275824d651Sblueswir1 15285824d651Sblueswir1@item tcp:[@var{host}]:@var{port}[,@var{server}][,nowait][,nodelay] 15295824d651Sblueswir1The TCP Net Console has two modes of operation. It can send the serial 15305824d651Sblueswir1I/O to a location or wait for a connection from a location. By default 15315824d651Sblueswir1the TCP Net Console is sent to @var{host} at the @var{port}. If you use 15325824d651Sblueswir1the @var{server} option QEMU will wait for a client socket application 15335824d651Sblueswir1to connect to the port before continuing, unless the @code{nowait} 15345824d651Sblueswir1option was specified. The @code{nodelay} option disables the Nagle buffering 15355824d651Sblueswir1algorithm. If @var{host} is omitted, 0.0.0.0 is assumed. Only 15365824d651Sblueswir1one TCP connection at a time is accepted. You can use @code{telnet} to 15375824d651Sblueswir1connect to the corresponding character device. 15385824d651Sblueswir1@table @code 15395824d651Sblueswir1@item Example to send tcp console to 192.168.0.2 port 4444 15405824d651Sblueswir1-serial tcp:192.168.0.2:4444 15415824d651Sblueswir1@item Example to listen and wait on port 4444 for connection 15425824d651Sblueswir1-serial tcp::4444,server 15435824d651Sblueswir1@item Example to not wait and listen on ip 192.168.0.100 port 4444 15445824d651Sblueswir1-serial tcp:192.168.0.100:4444,server,nowait 15455824d651Sblueswir1@end table 15465824d651Sblueswir1 15475824d651Sblueswir1@item telnet:@var{host}:@var{port}[,server][,nowait][,nodelay] 15485824d651Sblueswir1The telnet protocol is used instead of raw tcp sockets. The options 15495824d651Sblueswir1work the same as if you had specified @code{-serial tcp}. The 15505824d651Sblueswir1difference is that the port acts like a telnet server or client using 15515824d651Sblueswir1telnet option negotiation. This will also allow you to send the 15525824d651Sblueswir1MAGIC_SYSRQ sequence if you use a telnet that supports sending the break 15535824d651Sblueswir1sequence. Typically in unix telnet you do it with Control-] and then 15545824d651Sblueswir1type "send break" followed by pressing the enter key. 15555824d651Sblueswir1 15565824d651Sblueswir1@item unix:@var{path}[,server][,nowait] 15575824d651Sblueswir1A unix domain socket is used instead of a tcp socket. The option works the 15585824d651Sblueswir1same as if you had specified @code{-serial tcp} except the unix domain socket 15595824d651Sblueswir1@var{path} is used for connections. 15605824d651Sblueswir1 15615824d651Sblueswir1@item mon:@var{dev_string} 15625824d651Sblueswir1This is a special option to allow the monitor to be multiplexed onto 15635824d651Sblueswir1another serial port. The monitor is accessed with key sequence of 15645824d651Sblueswir1@key{Control-a} and then pressing @key{c}. See monitor access 15655824d651Sblueswir1@ref{pcsys_keys} in the -nographic section for more keys. 15665824d651Sblueswir1@var{dev_string} should be any one of the serial devices specified 15675824d651Sblueswir1above. An example to multiplex the monitor onto a telnet server 15685824d651Sblueswir1listening on port 4444 would be: 15695824d651Sblueswir1@table @code 15705824d651Sblueswir1@item -serial mon:telnet::4444,server,nowait 15715824d651Sblueswir1@end table 15725824d651Sblueswir1 15735824d651Sblueswir1@item braille 15745824d651Sblueswir1Braille device. This will use BrlAPI to display the braille output on a real 15755824d651Sblueswir1or fake device. 15765824d651Sblueswir1 1577be8b28a9SKevin Wolf@item msmouse 1578be8b28a9SKevin WolfThree button serial mouse. Configure the guest to use Microsoft protocol. 15795824d651Sblueswir1@end table 15805824d651Sblueswir1ETEXI 15815824d651Sblueswir1 15825824d651Sblueswir1DEF("parallel", HAS_ARG, QEMU_OPTION_parallel, \ 15835824d651Sblueswir1 "-parallel dev redirect the parallel port to char device 'dev'\n") 15845824d651Sblueswir1STEXI 15855824d651Sblueswir1@item -parallel @var{dev} 15865824d651Sblueswir1Redirect the virtual parallel port to host device @var{dev} (same 15875824d651Sblueswir1devices as the serial port). On Linux hosts, @file{/dev/parportN} can 15885824d651Sblueswir1be used to use hardware devices connected on the corresponding host 15895824d651Sblueswir1parallel port. 15905824d651Sblueswir1 15915824d651Sblueswir1This option can be used several times to simulate up to 3 parallel 15925824d651Sblueswir1ports. 15935824d651Sblueswir1 15945824d651Sblueswir1Use @code{-parallel none} to disable all parallel ports. 15955824d651Sblueswir1ETEXI 15965824d651Sblueswir1 15975824d651Sblueswir1DEF("monitor", HAS_ARG, QEMU_OPTION_monitor, \ 15984e307fc8SGerd Hoffmann "-monitor dev redirect the monitor to char device 'dev'\n") 15995824d651Sblueswir1STEXI 16004e307fc8SGerd Hoffmann@item -monitor @var{dev} 16015824d651Sblueswir1Redirect the monitor to host device @var{dev} (same devices as the 16025824d651Sblueswir1serial port). 16035824d651Sblueswir1The default device is @code{vc} in graphical mode and @code{stdio} in 16045824d651Sblueswir1non graphical mode. 16055824d651Sblueswir1ETEXI 16066ca5582dSGerd HoffmannDEF("qmp", HAS_ARG, QEMU_OPTION_qmp, \ 1607ca1a8a06SBruce Rogers "-qmp dev like -monitor but opens in 'control' mode\n") 160895d5f08bSStefan WeilSTEXI 160995d5f08bSStefan Weil@item -qmp @var{dev} 161095d5f08bSStefan WeilLike -monitor but opens in 'control' mode. 161195d5f08bSStefan WeilETEXI 16125824d651Sblueswir1 161322a0e04bSGerd HoffmannDEF("mon", HAS_ARG, QEMU_OPTION_mon, \ 161422a0e04bSGerd Hoffmann "-mon chardev=[name][,mode=readline|control][,default]\n") 161522a0e04bSGerd HoffmannSTEXI 161622a0e04bSGerd Hoffmann@item -mon chardev=[name][,mode=readline|control][,default] 161722a0e04bSGerd HoffmannSetup monitor on chardev @var{name}. 161822a0e04bSGerd HoffmannETEXI 161922a0e04bSGerd Hoffmann 1620c9f398e5SH. Peter AnvinDEF("debugcon", HAS_ARG, QEMU_OPTION_debugcon, \ 1621c9f398e5SH. Peter Anvin "-debugcon dev redirect the debug console to char device 'dev'\n") 1622c9f398e5SH. Peter AnvinSTEXI 1623c9f398e5SH. Peter Anvin@item -debugcon @var{dev} 1624c9f398e5SH. Peter AnvinRedirect the debug console to host device @var{dev} (same devices as the 1625c9f398e5SH. Peter Anvinserial port). The debug console is an I/O port which is typically port 1626c9f398e5SH. Peter Anvin0xe9; writing to that I/O port sends output to this device. 1627c9f398e5SH. Peter AnvinThe default device is @code{vc} in graphical mode and @code{stdio} in 1628c9f398e5SH. Peter Anvinnon graphical mode. 1629c9f398e5SH. Peter AnvinETEXI 1630c9f398e5SH. Peter Anvin 16315824d651Sblueswir1DEF("pidfile", HAS_ARG, QEMU_OPTION_pidfile, \ 16325824d651Sblueswir1 "-pidfile file write PID to 'file'\n") 16335824d651Sblueswir1STEXI 16345824d651Sblueswir1@item -pidfile @var{file} 16355824d651Sblueswir1Store the QEMU process PID in @var{file}. It is useful if you launch QEMU 16365824d651Sblueswir1from a script. 16375824d651Sblueswir1ETEXI 16385824d651Sblueswir1 16391b530a6dSaurel32DEF("singlestep", 0, QEMU_OPTION_singlestep, \ 16401b530a6dSaurel32 "-singlestep always run in singlestep mode\n") 16411b530a6dSaurel32STEXI 16421b530a6dSaurel32@item -singlestep 16431b530a6dSaurel32Run the emulation in single step mode. 16441b530a6dSaurel32ETEXI 16451b530a6dSaurel32 16465824d651Sblueswir1DEF("S", 0, QEMU_OPTION_S, \ 16475824d651Sblueswir1 "-S freeze CPU at startup (use 'c' to start execution)\n") 16485824d651Sblueswir1STEXI 16495824d651Sblueswir1@item -S 16505824d651Sblueswir1Do not start CPU at startup (you must type 'c' in the monitor). 16515824d651Sblueswir1ETEXI 16525824d651Sblueswir1 165359030a8cSaliguoriDEF("gdb", HAS_ARG, QEMU_OPTION_gdb, \ 165459030a8cSaliguori "-gdb dev wait for gdb connection on 'dev'\n") 16555824d651Sblueswir1STEXI 165659030a8cSaliguori@item -gdb @var{dev} 165759030a8cSaliguoriWait for gdb connection on device @var{dev} (@pxref{gdb_usage}). Typical 165859030a8cSaliguoriconnections will likely be TCP-based, but also UDP, pseudo TTY, or even 165959030a8cSaliguoristdio are reasonable use case. The latter is allowing to start qemu from 166059030a8cSaliguoriwithin gdb and establish the connection via a pipe: 166159030a8cSaliguori@example 166259030a8cSaliguori(gdb) target remote | exec qemu -gdb stdio ... 166359030a8cSaliguori@end example 16645824d651Sblueswir1ETEXI 16655824d651Sblueswir1 166659030a8cSaliguoriDEF("s", 0, QEMU_OPTION_s, \ 166759030a8cSaliguori "-s shorthand for -gdb tcp::%s\n") 16685824d651Sblueswir1STEXI 166959030a8cSaliguori@item -s 167059030a8cSaliguoriShorthand for -gdb tcp::1234, i.e. open a gdbserver on TCP port 1234 167159030a8cSaliguori(@pxref{gdb_usage}). 16725824d651Sblueswir1ETEXI 16735824d651Sblueswir1 16745824d651Sblueswir1DEF("d", HAS_ARG, QEMU_OPTION_d, \ 16755824d651Sblueswir1 "-d item1,... output log to %s (use -d ? for a list of log items)\n") 16765824d651Sblueswir1STEXI 16775824d651Sblueswir1@item -d 16785824d651Sblueswir1Output log in /tmp/qemu.log 16795824d651Sblueswir1ETEXI 16805824d651Sblueswir1 16815824d651Sblueswir1DEF("hdachs", HAS_ARG, QEMU_OPTION_hdachs, \ 16825824d651Sblueswir1 "-hdachs c,h,s[,t]\n" \ 16835824d651Sblueswir1 " force hard disk 0 physical geometry and the optional BIOS\n" \ 16845824d651Sblueswir1 " translation (t=none or lba) (usually qemu can guess them)\n") 16855824d651Sblueswir1STEXI 16865824d651Sblueswir1@item -hdachs @var{c},@var{h},@var{s},[,@var{t}] 16875824d651Sblueswir1Force hard disk 0 physical geometry (1 <= @var{c} <= 16383, 1 <= 16885824d651Sblueswir1@var{h} <= 16, 1 <= @var{s} <= 63) and optionally force the BIOS 16895824d651Sblueswir1translation mode (@var{t}=none, lba or auto). Usually QEMU can guess 16905824d651Sblueswir1all those parameters. This option is useful for old MS-DOS disk 16915824d651Sblueswir1images. 16925824d651Sblueswir1ETEXI 16935824d651Sblueswir1 16945824d651Sblueswir1DEF("L", HAS_ARG, QEMU_OPTION_L, \ 16955824d651Sblueswir1 "-L path set the directory for the BIOS, VGA BIOS and keymaps\n") 16965824d651Sblueswir1STEXI 16975824d651Sblueswir1@item -L @var{path} 16985824d651Sblueswir1Set the directory for the BIOS, VGA BIOS and keymaps. 16995824d651Sblueswir1ETEXI 17005824d651Sblueswir1 17015824d651Sblueswir1DEF("bios", HAS_ARG, QEMU_OPTION_bios, \ 17025824d651Sblueswir1 "-bios file set the filename for the BIOS\n") 17035824d651Sblueswir1STEXI 17045824d651Sblueswir1@item -bios @var{file} 17055824d651Sblueswir1Set the filename for the BIOS. 17065824d651Sblueswir1ETEXI 17075824d651Sblueswir1 17085824d651Sblueswir1#ifdef CONFIG_KVM 17095824d651Sblueswir1DEF("enable-kvm", 0, QEMU_OPTION_enable_kvm, \ 17105824d651Sblueswir1 "-enable-kvm enable KVM full virtualization support\n") 17115824d651Sblueswir1#endif 17125824d651Sblueswir1STEXI 17135824d651Sblueswir1@item -enable-kvm 17145824d651Sblueswir1Enable KVM full virtualization support. This option is only available 17155824d651Sblueswir1if KVM support is enabled when compiling. 17165824d651Sblueswir1ETEXI 17175824d651Sblueswir1 1718e37630caSaliguori#ifdef CONFIG_XEN 1719e37630caSaliguoriDEF("xen-domid", HAS_ARG, QEMU_OPTION_xen_domid, 1720e37630caSaliguori "-xen-domid id specify xen guest domain id\n") 1721e37630caSaliguoriDEF("xen-create", 0, QEMU_OPTION_xen_create, 1722e37630caSaliguori "-xen-create create domain using xen hypercalls, bypassing xend\n" 1723e37630caSaliguori " warning: should not be used when xend is in use\n") 1724e37630caSaliguoriDEF("xen-attach", 0, QEMU_OPTION_xen_attach, 1725e37630caSaliguori "-xen-attach attach to existing xen domain\n" 1726e37630caSaliguori " xend will use this when starting qemu\n") 1727e37630caSaliguori#endif 172895d5f08bSStefan WeilSTEXI 172995d5f08bSStefan Weil@item -xen-domid @var{id} 173095d5f08bSStefan WeilSpecify xen guest domain @var{id} (XEN only). 173195d5f08bSStefan Weil@item -xen-create 173295d5f08bSStefan WeilCreate domain using xen hypercalls, bypassing xend. 173395d5f08bSStefan WeilWarning: should not be used when xend is in use (XEN only). 173495d5f08bSStefan Weil@item -xen-attach 173595d5f08bSStefan WeilAttach to existing xen domain. 173695d5f08bSStefan Weilxend will use this when starting qemu (XEN only). 173795d5f08bSStefan WeilETEXI 1738e37630caSaliguori 17395824d651Sblueswir1DEF("no-reboot", 0, QEMU_OPTION_no_reboot, \ 17405824d651Sblueswir1 "-no-reboot exit instead of rebooting\n") 17415824d651Sblueswir1STEXI 17425824d651Sblueswir1@item -no-reboot 17435824d651Sblueswir1Exit instead of rebooting. 17445824d651Sblueswir1ETEXI 17455824d651Sblueswir1 17465824d651Sblueswir1DEF("no-shutdown", 0, QEMU_OPTION_no_shutdown, \ 17475824d651Sblueswir1 "-no-shutdown stop before shutdown\n") 17485824d651Sblueswir1STEXI 17495824d651Sblueswir1@item -no-shutdown 17505824d651Sblueswir1Don't exit QEMU on guest shutdown, but instead only stop the emulation. 17515824d651Sblueswir1This allows for instance switching to monitor to commit changes to the 17525824d651Sblueswir1disk image. 17535824d651Sblueswir1ETEXI 17545824d651Sblueswir1 17555824d651Sblueswir1DEF("loadvm", HAS_ARG, QEMU_OPTION_loadvm, \ 17565824d651Sblueswir1 "-loadvm [tag|id]\n" \ 17575824d651Sblueswir1 " start right away with a saved state (loadvm in monitor)\n") 17585824d651Sblueswir1STEXI 17595824d651Sblueswir1@item -loadvm @var{file} 17605824d651Sblueswir1Start right away with a saved state (@code{loadvm} in monitor) 17615824d651Sblueswir1ETEXI 17625824d651Sblueswir1 17635824d651Sblueswir1#ifndef _WIN32 17645824d651Sblueswir1DEF("daemonize", 0, QEMU_OPTION_daemonize, \ 17655824d651Sblueswir1 "-daemonize daemonize QEMU after initializing\n") 17665824d651Sblueswir1#endif 17675824d651Sblueswir1STEXI 17685824d651Sblueswir1@item -daemonize 17695824d651Sblueswir1Daemonize the QEMU process after initialization. QEMU will not detach from 17705824d651Sblueswir1standard IO until it is ready to receive connections on any of its devices. 17715824d651Sblueswir1This option is a useful way for external programs to launch QEMU without having 17725824d651Sblueswir1to cope with initialization race conditions. 17735824d651Sblueswir1ETEXI 17745824d651Sblueswir1 17755824d651Sblueswir1DEF("option-rom", HAS_ARG, QEMU_OPTION_option_rom, \ 17765824d651Sblueswir1 "-option-rom rom load a file, rom, into the option ROM space\n") 17775824d651Sblueswir1STEXI 17785824d651Sblueswir1@item -option-rom @var{file} 17795824d651Sblueswir1Load the contents of @var{file} as an option ROM. 17805824d651Sblueswir1This option is useful to load things like EtherBoot. 17815824d651Sblueswir1ETEXI 17825824d651Sblueswir1 17835824d651Sblueswir1DEF("clock", HAS_ARG, QEMU_OPTION_clock, \ 17845824d651Sblueswir1 "-clock force the use of the given methods for timer alarm.\n" \ 17855824d651Sblueswir1 " To see what timers are available use -clock ?\n") 17865824d651Sblueswir1STEXI 17875824d651Sblueswir1@item -clock @var{method} 17885824d651Sblueswir1Force the use of the given methods for timer alarm. To see what timers 17895824d651Sblueswir1are available use -clock ?. 17905824d651Sblueswir1ETEXI 17915824d651Sblueswir1 17921ed2fc1fSJan KiszkaHXCOMM Options deprecated by -rtc 17931ed2fc1fSJan KiszkaDEF("localtime", 0, QEMU_OPTION_localtime, "") 17941ed2fc1fSJan KiszkaDEF("startdate", HAS_ARG, QEMU_OPTION_startdate, "") 17955824d651Sblueswir1 17961ed2fc1fSJan Kiszka#ifdef TARGET_I386 17971ed2fc1fSJan KiszkaDEF("rtc", HAS_ARG, QEMU_OPTION_rtc, \ 17986875204cSJan Kiszka "-rtc [base=utc|localtime|date][,clock=host|vm][,driftfix=none|slew]\n" \ 17996875204cSJan Kiszka " set the RTC base and clock, enable drift fix for clock ticks\n") 18001ed2fc1fSJan Kiszka#else 18011ed2fc1fSJan KiszkaDEF("rtc", HAS_ARG, QEMU_OPTION_rtc, \ 18026875204cSJan Kiszka "-rtc [base=utc|localtime|date][,clock=host|vm]\n" \ 18031ed2fc1fSJan Kiszka " set the RTC base and clock\n") 18041ed2fc1fSJan Kiszka#endif 18051ed2fc1fSJan Kiszka 18065824d651Sblueswir1STEXI 18075824d651Sblueswir1 18086875204cSJan Kiszka@item -rtc [base=utc|localtime|@var{date}][,clock=host|vm][,driftfix=none|slew] 18091ed2fc1fSJan KiszkaSpecify @option{base} as @code{utc} or @code{localtime} to let the RTC start at the current 18101ed2fc1fSJan KiszkaUTC or local time, respectively. @code{localtime} is required for correct date in 18111ed2fc1fSJan KiszkaMS-DOS or Windows. To start at a specific point in time, provide @var{date} in the 18121ed2fc1fSJan Kiszkaformat @code{2006-06-17T16:01:21} or @code{2006-06-17}. The default base is UTC. 18131ed2fc1fSJan Kiszka 18146875204cSJan KiszkaBy default the RTC is driven by the host system time. This allows to use the 18156875204cSJan KiszkaRTC as accurate reference clock inside the guest, specifically if the host 18166875204cSJan Kiszkatime is smoothly following an accurate external reference clock, e.g. via NTP. 18176875204cSJan KiszkaIf you want to isolate the guest time from the host, even prevent it from 18186875204cSJan Kiszkaprogressing during suspension, you can set @option{clock} to @code{vm} instead. 18196875204cSJan Kiszka 18201ed2fc1fSJan KiszkaEnable @option{driftfix} (i386 targets only) if you experience time drift problems, 18211ed2fc1fSJan Kiszkaspecifically with Windows' ACPI HAL. This option will try to figure out how 18221ed2fc1fSJan Kiszkamany timer interrupts were not processed by the Windows guest and will 18231ed2fc1fSJan Kiszkare-inject them. 18245824d651Sblueswir1ETEXI 18255824d651Sblueswir1 18265824d651Sblueswir1DEF("icount", HAS_ARG, QEMU_OPTION_icount, \ 18275824d651Sblueswir1 "-icount [N|auto]\n" \ 1828bc14ca24Saliguori " enable virtual instruction counter with 2^N clock ticks per\n" \ 1829bc14ca24Saliguori " instruction\n") 18305824d651Sblueswir1STEXI 18314e257e5eSKevin Wolf@item -icount [@var{N}|auto] 18325824d651Sblueswir1Enable virtual instruction counter. The virtual cpu will execute one 18334e257e5eSKevin Wolfinstruction every 2^@var{N} ns of virtual time. If @code{auto} is specified 18345824d651Sblueswir1then the virtual cpu speed will be automatically adjusted to keep virtual 18355824d651Sblueswir1time within a few seconds of real time. 18365824d651Sblueswir1 18375824d651Sblueswir1Note that while this option can give deterministic behavior, it does not 18385824d651Sblueswir1provide cycle accurate emulation. Modern CPUs contain superscalar out of 18395824d651Sblueswir1order cores with complex cache hierarchies. The number of instructions 18405824d651Sblueswir1executed often has little or no correlation with actual performance. 18415824d651Sblueswir1ETEXI 18425824d651Sblueswir1 18439dd986ccSRichard W.M. JonesDEF("watchdog", HAS_ARG, QEMU_OPTION_watchdog, \ 18449dd986ccSRichard W.M. Jones "-watchdog i6300esb|ib700\n" \ 18459dd986ccSRichard W.M. Jones " enable virtual hardware watchdog [default=none]\n") 18469dd986ccSRichard W.M. JonesSTEXI 18479dd986ccSRichard W.M. Jones@item -watchdog @var{model} 18489dd986ccSRichard W.M. JonesCreate a virtual hardware watchdog device. Once enabled (by a guest 18499dd986ccSRichard W.M. Jonesaction), the watchdog must be periodically polled by an agent inside 18509dd986ccSRichard W.M. Jonesthe guest or else the guest will be restarted. 18519dd986ccSRichard W.M. Jones 18529dd986ccSRichard W.M. JonesThe @var{model} is the model of hardware watchdog to emulate. Choices 18539dd986ccSRichard W.M. Jonesfor model are: @code{ib700} (iBASE 700) which is a very simple ISA 18549dd986ccSRichard W.M. Joneswatchdog with a single timer, or @code{i6300esb} (Intel 6300ESB I/O 18559dd986ccSRichard W.M. Jonescontroller hub) which is a much more featureful PCI-based dual-timer 18569dd986ccSRichard W.M. Joneswatchdog. Choose a model for which your guest has drivers. 18579dd986ccSRichard W.M. Jones 18589dd986ccSRichard W.M. JonesUse @code{-watchdog ?} to list available hardware models. Only one 18599dd986ccSRichard W.M. Joneswatchdog can be enabled for a guest. 18609dd986ccSRichard W.M. JonesETEXI 18619dd986ccSRichard W.M. Jones 18629dd986ccSRichard W.M. JonesDEF("watchdog-action", HAS_ARG, QEMU_OPTION_watchdog_action, \ 18639dd986ccSRichard W.M. Jones "-watchdog-action reset|shutdown|poweroff|pause|debug|none\n" \ 18649dd986ccSRichard W.M. Jones " action when watchdog fires [default=reset]\n") 18659dd986ccSRichard W.M. JonesSTEXI 18669dd986ccSRichard W.M. Jones@item -watchdog-action @var{action} 18679dd986ccSRichard W.M. Jones 18689dd986ccSRichard W.M. JonesThe @var{action} controls what QEMU will do when the watchdog timer 18699dd986ccSRichard W.M. Jonesexpires. 18709dd986ccSRichard W.M. JonesThe default is 18719dd986ccSRichard W.M. Jones@code{reset} (forcefully reset the guest). 18729dd986ccSRichard W.M. JonesOther possible actions are: 18739dd986ccSRichard W.M. Jones@code{shutdown} (attempt to gracefully shutdown the guest), 18749dd986ccSRichard W.M. Jones@code{poweroff} (forcefully poweroff the guest), 18759dd986ccSRichard W.M. Jones@code{pause} (pause the guest), 18769dd986ccSRichard W.M. Jones@code{debug} (print a debug message and continue), or 18779dd986ccSRichard W.M. Jones@code{none} (do nothing). 18789dd986ccSRichard W.M. Jones 18799dd986ccSRichard W.M. JonesNote that the @code{shutdown} action requires that the guest responds 18809dd986ccSRichard W.M. Jonesto ACPI signals, which it may not be able to do in the sort of 18819dd986ccSRichard W.M. Jonessituations where the watchdog would have expired, and thus 18829dd986ccSRichard W.M. Jones@code{-watchdog-action shutdown} is not recommended for production use. 18839dd986ccSRichard W.M. Jones 18849dd986ccSRichard W.M. JonesExamples: 18859dd986ccSRichard W.M. Jones 18869dd986ccSRichard W.M. Jones@table @code 18879dd986ccSRichard W.M. Jones@item -watchdog i6300esb -watchdog-action pause 18889dd986ccSRichard W.M. Jones@item -watchdog ib700 18899dd986ccSRichard W.M. Jones@end table 18909dd986ccSRichard W.M. JonesETEXI 18919dd986ccSRichard W.M. Jones 18925824d651Sblueswir1DEF("echr", HAS_ARG, QEMU_OPTION_echr, \ 18935824d651Sblueswir1 "-echr chr set terminal escape character instead of ctrl-a\n") 18945824d651Sblueswir1STEXI 18955824d651Sblueswir1 18964e257e5eSKevin Wolf@item -echr @var{numeric_ascii_value} 18975824d651Sblueswir1Change the escape character used for switching to the monitor when using 18985824d651Sblueswir1monitor and serial sharing. The default is @code{0x01} when using the 18995824d651Sblueswir1@code{-nographic} option. @code{0x01} is equal to pressing 19005824d651Sblueswir1@code{Control-a}. You can select a different character from the ascii 19015824d651Sblueswir1control keys where 1 through 26 map to Control-a through Control-z. For 19025824d651Sblueswir1instance you could use the either of the following to change the escape 19035824d651Sblueswir1character to Control-t. 19045824d651Sblueswir1@table @code 19055824d651Sblueswir1@item -echr 0x14 19065824d651Sblueswir1@item -echr 20 19075824d651Sblueswir1@end table 19085824d651Sblueswir1ETEXI 19095824d651Sblueswir1 19105824d651Sblueswir1DEF("virtioconsole", HAS_ARG, QEMU_OPTION_virtiocon, \ 19115824d651Sblueswir1 "-virtioconsole c\n" \ 19125824d651Sblueswir1 " set virtio console\n") 19135824d651Sblueswir1STEXI 19145824d651Sblueswir1@item -virtioconsole @var{c} 19155824d651Sblueswir1Set virtio console. 191698b19252SAmit Shah 191798b19252SAmit ShahThis option is maintained for backward compatibility. 191898b19252SAmit Shah 191998b19252SAmit ShahPlease use @code{-device virtconsole} for the new way of invocation. 19205824d651Sblueswir1ETEXI 19215824d651Sblueswir1 19225824d651Sblueswir1DEF("show-cursor", 0, QEMU_OPTION_show_cursor, \ 19235824d651Sblueswir1 "-show-cursor show cursor\n") 19245824d651Sblueswir1STEXI 192595d5f08bSStefan Weil@item -show-cursor 192695d5f08bSStefan WeilShow cursor. 19275824d651Sblueswir1ETEXI 19285824d651Sblueswir1 19295824d651Sblueswir1DEF("tb-size", HAS_ARG, QEMU_OPTION_tb_size, \ 19305824d651Sblueswir1 "-tb-size n set TB size\n") 19315824d651Sblueswir1STEXI 193295d5f08bSStefan Weil@item -tb-size @var{n} 193395d5f08bSStefan WeilSet TB size. 19345824d651Sblueswir1ETEXI 19355824d651Sblueswir1 19365824d651Sblueswir1DEF("incoming", HAS_ARG, QEMU_OPTION_incoming, \ 19375824d651Sblueswir1 "-incoming p prepare for incoming migration, listen on port p\n") 19385824d651Sblueswir1STEXI 193995d5f08bSStefan Weil@item -incoming @var{port} 194095d5f08bSStefan WeilPrepare for incoming migration, listen on @var{port}. 19415824d651Sblueswir1ETEXI 19425824d651Sblueswir1 1943d8c208ddSGerd HoffmannDEF("nodefaults", 0, QEMU_OPTION_nodefaults, \ 1944ca1a8a06SBruce Rogers "-nodefaults don't create default devices\n") 1945d8c208ddSGerd HoffmannSTEXI 19463dbf2c7fSStefan Weil@item -nodefaults 19473dbf2c7fSStefan WeilDon't create default devices. 1948d8c208ddSGerd HoffmannETEXI 1949d8c208ddSGerd Hoffmann 19505824d651Sblueswir1#ifndef _WIN32 19515824d651Sblueswir1DEF("chroot", HAS_ARG, QEMU_OPTION_chroot, \ 1952ca1a8a06SBruce Rogers "-chroot dir chroot to dir just before starting the VM\n") 19535824d651Sblueswir1#endif 19545824d651Sblueswir1STEXI 19554e257e5eSKevin Wolf@item -chroot @var{dir} 19565824d651Sblueswir1Immediately before starting guest execution, chroot to the specified 19575824d651Sblueswir1directory. Especially useful in combination with -runas. 19585824d651Sblueswir1ETEXI 19595824d651Sblueswir1 19605824d651Sblueswir1#ifndef _WIN32 19615824d651Sblueswir1DEF("runas", HAS_ARG, QEMU_OPTION_runas, \ 1962ca1a8a06SBruce Rogers "-runas user change to user id user just before starting the VM\n") 19635824d651Sblueswir1#endif 19645824d651Sblueswir1STEXI 19654e257e5eSKevin Wolf@item -runas @var{user} 19665824d651Sblueswir1Immediately before starting guest execution, drop root privileges, switching 19675824d651Sblueswir1to the specified user. 19685824d651Sblueswir1ETEXI 19695824d651Sblueswir1 19705824d651Sblueswir1#if defined(TARGET_SPARC) || defined(TARGET_PPC) 19715824d651Sblueswir1DEF("prom-env", HAS_ARG, QEMU_OPTION_prom_env, 19725824d651Sblueswir1 "-prom-env variable=value\n" 19735824d651Sblueswir1 " set OpenBIOS nvram variables\n") 19745824d651Sblueswir1#endif 197595d5f08bSStefan WeilSTEXI 197695d5f08bSStefan Weil@item -prom-env @var{variable}=@var{value} 197795d5f08bSStefan WeilSet OpenBIOS nvram @var{variable} to given @var{value} (PPC, SPARC only). 197895d5f08bSStefan WeilETEXI 19795824d651Sblueswir1#if defined(TARGET_ARM) || defined(TARGET_M68K) 19805824d651Sblueswir1DEF("semihosting", 0, QEMU_OPTION_semihosting, 19815824d651Sblueswir1 "-semihosting semihosting mode\n") 19825824d651Sblueswir1#endif 198395d5f08bSStefan WeilSTEXI 198495d5f08bSStefan Weil@item -semihosting 198595d5f08bSStefan WeilSemihosting mode (ARM, M68K only). 198695d5f08bSStefan WeilETEXI 19875824d651Sblueswir1#if defined(TARGET_ARM) 19885824d651Sblueswir1DEF("old-param", 0, QEMU_OPTION_old_param, 19895824d651Sblueswir1 "-old-param old param mode\n") 19905824d651Sblueswir1#endif 199195d5f08bSStefan WeilSTEXI 199295d5f08bSStefan Weil@item -old-param 199395d5f08bSStefan WeilOld param mode (ARM only). 199495d5f08bSStefan WeilETEXI 199595d5f08bSStefan Weil 1996715a664aSGerd HoffmannDEF("readconfig", HAS_ARG, QEMU_OPTION_readconfig, 1997715a664aSGerd Hoffmann "-readconfig <file>\n") 19983dbf2c7fSStefan WeilSTEXI 19993dbf2c7fSStefan Weil@item -readconfig @var{file} 20003dbf2c7fSStefan WeilRead device configuration from @var{file}. 20013dbf2c7fSStefan WeilETEXI 2002715a664aSGerd HoffmannDEF("writeconfig", HAS_ARG, QEMU_OPTION_writeconfig, 2003715a664aSGerd Hoffmann "-writeconfig <file>\n" 200419e65b47SMichael Tokarev " read/write config file\n") 20053dbf2c7fSStefan WeilSTEXI 20063dbf2c7fSStefan Weil@item -writeconfig @var{file} 20073dbf2c7fSStefan WeilWrite device configuration to @var{file}. 20083dbf2c7fSStefan WeilETEXI 2009292444cbSAnthony LiguoriDEF("nodefconfig", 0, QEMU_OPTION_nodefconfig, 2010292444cbSAnthony Liguori "-nodefconfig\n" 2011292444cbSAnthony Liguori " do not load default config files at startup\n") 2012292444cbSAnthony LiguoriSTEXI 2013292444cbSAnthony Liguori@item -nodefconfig 2014292444cbSAnthony LiguoriNormally QEMU loads a configuration file from @var{sysconfdir}/qemu.conf and 2015292444cbSAnthony Liguori@var{sysconfdir}/target-@var{ARCH}.conf on startup. The @code{-nodefconfig} 2016292444cbSAnthony Liguorioption will prevent QEMU from loading these configuration files at startup. 2017292444cbSAnthony LiguoriETEXI 20183dbf2c7fSStefan Weil 20193dbf2c7fSStefan WeilHXCOMM This is the last statement. Insert new options before this line! 20203dbf2c7fSStefan WeilSTEXI 20213dbf2c7fSStefan Weil@end table 20223dbf2c7fSStefan WeilETEXI 2023