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" 4558a04db1SAndre Przywara " 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" 1065c6c3a6cSChristoph Hellwig " [,addr=A][,id=name][,aio=threads|native]\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") 1125824d651Sblueswir1STEXI 1135824d651Sblueswir1@item -drive @var{option}[,@var{option}[,@var{option}[,...]]] 1145824d651Sblueswir1 1155824d651Sblueswir1Define a new drive. Valid options are: 1165824d651Sblueswir1 1175824d651Sblueswir1@table @code 1185824d651Sblueswir1@item file=@var{file} 1195824d651Sblueswir1This option defines which disk image (@pxref{disk_images}) to use with 1205824d651Sblueswir1this drive. If the filename contains comma, you must double it 1215824d651Sblueswir1(for instance, "file=my,,file" to use file "my,file"). 1225824d651Sblueswir1@item if=@var{interface} 1235824d651Sblueswir1This option defines on which type on interface the drive is connected. 1245824d651Sblueswir1Available types are: ide, scsi, sd, mtd, floppy, pflash, virtio. 1255824d651Sblueswir1@item bus=@var{bus},unit=@var{unit} 1265824d651Sblueswir1These options define where is connected the drive by defining the bus number and 1275824d651Sblueswir1the unit id. 1285824d651Sblueswir1@item index=@var{index} 1295824d651Sblueswir1This option defines where is connected the drive by using an index in the list 1305824d651Sblueswir1of available connectors of a given interface type. 1315824d651Sblueswir1@item media=@var{media} 1325824d651Sblueswir1This option defines the type of the media: disk or cdrom. 1335824d651Sblueswir1@item cyls=@var{c},heads=@var{h},secs=@var{s}[,trans=@var{t}] 1345824d651Sblueswir1These options have the same definition as they have in @option{-hdachs}. 1355824d651Sblueswir1@item snapshot=@var{snapshot} 1365824d651Sblueswir1@var{snapshot} is "on" or "off" and allows to enable snapshot for given drive (see @option{-snapshot}). 1375824d651Sblueswir1@item cache=@var{cache} 1385824d651Sblueswir1@var{cache} is "none", "writeback", or "writethrough" and controls how the host cache is used to access block data. 1395c6c3a6cSChristoph Hellwig@item aio=@var{aio} 1405c6c3a6cSChristoph Hellwig@var{aio} is "threads", or "native" and selects between pthread based disk I/O and native Linux AIO. 1415824d651Sblueswir1@item format=@var{format} 1425824d651Sblueswir1Specify which disk @var{format} will be used rather than detecting 1435824d651Sblueswir1the format. Can be used to specifiy format=raw to avoid interpreting 1445824d651Sblueswir1an untrusted format header. 1455824d651Sblueswir1@item serial=@var{serial} 1465824d651Sblueswir1This option specifies the serial number to assign to the device. 147c2cc47a4SMarkus Armbruster@item addr=@var{addr} 148c2cc47a4SMarkus ArmbrusterSpecify the controller's PCI address (if=virtio only). 1495824d651Sblueswir1@end table 1505824d651Sblueswir1 1515824d651Sblueswir1By default, writethrough caching is used for all block device. This means that 1525824d651Sblueswir1the host page cache will be used to read and write data but write notification 1535824d651Sblueswir1will be sent to the guest only when the data has been reported as written by 1545824d651Sblueswir1the storage subsystem. 1555824d651Sblueswir1 1565824d651Sblueswir1Writeback caching will report data writes as completed as soon as the data is 1575824d651Sblueswir1present in the host page cache. This is safe as long as you trust your host. 1585824d651Sblueswir1If your host crashes or loses power, then the guest may experience data 1595824d651Sblueswir1corruption. When using the @option{-snapshot} option, writeback caching is 1605824d651Sblueswir1used by default. 1615824d651Sblueswir1 162c304d317SAurelien JarnoThe host page cache can be avoided entirely with @option{cache=none}. This will 1635824d651Sblueswir1attempt to do disk IO directly to the guests memory. QEMU may still perform 1645824d651Sblueswir1an internal copy of the data. 1655824d651Sblueswir1 1665824d651Sblueswir1Some block drivers perform badly with @option{cache=writethrough}, most notably, 1675824d651Sblueswir1qcow2. If performance is more important than correctness, 1680aa217e4SKevin Wolf@option{cache=writeback} should be used with qcow2. 1695824d651Sblueswir1 1705824d651Sblueswir1Instead of @option{-cdrom} you can use: 1715824d651Sblueswir1@example 1725824d651Sblueswir1qemu -drive file=file,index=2,media=cdrom 1735824d651Sblueswir1@end example 1745824d651Sblueswir1 1755824d651Sblueswir1Instead of @option{-hda}, @option{-hdb}, @option{-hdc}, @option{-hdd}, you can 1765824d651Sblueswir1use: 1775824d651Sblueswir1@example 1785824d651Sblueswir1qemu -drive file=file,index=0,media=disk 1795824d651Sblueswir1qemu -drive file=file,index=1,media=disk 1805824d651Sblueswir1qemu -drive file=file,index=2,media=disk 1815824d651Sblueswir1qemu -drive file=file,index=3,media=disk 1825824d651Sblueswir1@end example 1835824d651Sblueswir1 1845824d651Sblueswir1You can connect a CDROM to the slave of ide0: 1855824d651Sblueswir1@example 1865824d651Sblueswir1qemu -drive file=file,if=ide,index=1,media=cdrom 1875824d651Sblueswir1@end example 1885824d651Sblueswir1 1895824d651Sblueswir1If you don't specify the "file=" argument, you define an empty drive: 1905824d651Sblueswir1@example 1915824d651Sblueswir1qemu -drive if=ide,index=1,media=cdrom 1925824d651Sblueswir1@end example 1935824d651Sblueswir1 1945824d651Sblueswir1You can connect a SCSI disk with unit ID 6 on the bus #0: 1955824d651Sblueswir1@example 1965824d651Sblueswir1qemu -drive file=file,if=scsi,bus=0,unit=6 1975824d651Sblueswir1@end example 1985824d651Sblueswir1 1995824d651Sblueswir1Instead of @option{-fda}, @option{-fdb}, you can use: 2005824d651Sblueswir1@example 2015824d651Sblueswir1qemu -drive file=file,index=0,if=floppy 2025824d651Sblueswir1qemu -drive file=file,index=1,if=floppy 2035824d651Sblueswir1@end example 2045824d651Sblueswir1 2055824d651Sblueswir1By default, @var{interface} is "ide" and @var{index} is automatically 2065824d651Sblueswir1incremented: 2075824d651Sblueswir1@example 2085824d651Sblueswir1qemu -drive file=a -drive file=b" 2095824d651Sblueswir1@end example 2105824d651Sblueswir1is interpreted like: 2115824d651Sblueswir1@example 2125824d651Sblueswir1qemu -hda a -hdb b 2135824d651Sblueswir1@end example 2145824d651Sblueswir1ETEXI 2155824d651Sblueswir1 2165824d651Sblueswir1DEF("mtdblock", HAS_ARG, QEMU_OPTION_mtdblock, 2175824d651Sblueswir1 "-mtdblock file use 'file' as on-board Flash memory image\n") 2185824d651Sblueswir1STEXI 2195824d651Sblueswir1 2205824d651Sblueswir1@item -mtdblock file 2215824d651Sblueswir1Use 'file' as on-board Flash memory image. 2225824d651Sblueswir1ETEXI 2235824d651Sblueswir1 2245824d651Sblueswir1DEF("sd", HAS_ARG, QEMU_OPTION_sd, 2255824d651Sblueswir1 "-sd file use 'file' as SecureDigital card image\n") 2265824d651Sblueswir1STEXI 2275824d651Sblueswir1@item -sd file 2285824d651Sblueswir1Use 'file' as SecureDigital card image. 2295824d651Sblueswir1ETEXI 2305824d651Sblueswir1 2315824d651Sblueswir1DEF("pflash", HAS_ARG, QEMU_OPTION_pflash, 2325824d651Sblueswir1 "-pflash file use 'file' as a parallel flash image\n") 2335824d651Sblueswir1STEXI 2345824d651Sblueswir1@item -pflash file 2355824d651Sblueswir1Use 'file' as a parallel flash image. 2365824d651Sblueswir1ETEXI 2375824d651Sblueswir1 2385824d651Sblueswir1DEF("boot", HAS_ARG, QEMU_OPTION_boot, 2392221dde5SJan Kiszka "-boot [order=drives][,once=drives][,menu=on|off]\n" 2402221dde5SJan Kiszka " 'drives': floppy (a), hard disk (c), CD-ROM (d), network (n)\n") 2415824d651Sblueswir1STEXI 2422221dde5SJan Kiszka@item -boot [order=@var{drives}][,once=@var{drives}][,menu=on|off] 2432221dde5SJan Kiszka 2442221dde5SJan KiszkaSpecify boot order @var{drives} as a string of drive letters. Valid 2452221dde5SJan Kiszkadrive letters depend on the target achitecture. The x86 PC uses: a, b 2462221dde5SJan Kiszka(floppy 1 and 2), c (first hard disk), d (first CD-ROM), n-p (Etherboot 2472221dde5SJan Kiszkafrom network adapter 1-4), hard disk boot is the default. To apply a 2482221dde5SJan Kiszkaparticular boot order only on the first startup, specify it via 2492221dde5SJan Kiszka@option{once}. 2502221dde5SJan Kiszka 2512221dde5SJan KiszkaInteractive boot menus/prompts can be enabled via @option{menu=on} as far 2522221dde5SJan Kiszkaas firmware/BIOS supports them. The default is non-interactive boot. 2532221dde5SJan Kiszka 2542221dde5SJan Kiszka@example 2552221dde5SJan Kiszka# try to boot from network first, then from hard disk 2562221dde5SJan Kiszkaqemu -boot order=nc 2572221dde5SJan Kiszka# boot from CD-ROM first, switch back to default order after reboot 2582221dde5SJan Kiszkaqemu -boot once=d 2592221dde5SJan Kiszka@end example 2602221dde5SJan Kiszka 2612221dde5SJan KiszkaNote: The legacy format '-boot @var{drives}' is still supported but its 2622221dde5SJan Kiszkause is discouraged as it may be removed from future versions. 2635824d651Sblueswir1ETEXI 2645824d651Sblueswir1 2655824d651Sblueswir1DEF("snapshot", 0, QEMU_OPTION_snapshot, 2665824d651Sblueswir1 "-snapshot write to temporary files instead of disk image files\n") 2675824d651Sblueswir1STEXI 2685824d651Sblueswir1@item -snapshot 2695824d651Sblueswir1Write to temporary files instead of disk image files. In this case, 2705824d651Sblueswir1the raw disk image you use is not written back. You can however force 2715824d651Sblueswir1the write back by pressing @key{C-a s} (@pxref{disk_images}). 2725824d651Sblueswir1ETEXI 2735824d651Sblueswir1 2745824d651Sblueswir1DEF("m", HAS_ARG, QEMU_OPTION_m, 2755824d651Sblueswir1 "-m megs set virtual RAM size to megs MB [default=%d]\n") 2765824d651Sblueswir1STEXI 2775824d651Sblueswir1@item -m @var{megs} 2785824d651Sblueswir1Set virtual RAM size to @var{megs} megabytes. Default is 128 MiB. Optionally, 2795824d651Sblueswir1a suffix of ``M'' or ``G'' can be used to signify a value in megabytes or 2805824d651Sblueswir1gigabytes respectively. 2815824d651Sblueswir1ETEXI 2825824d651Sblueswir1 2835824d651Sblueswir1DEF("k", HAS_ARG, QEMU_OPTION_k, 2845c2f8d2dSblueswir1 "-k language use keyboard layout (for example 'fr' for French)\n") 2855824d651Sblueswir1STEXI 2865824d651Sblueswir1@item -k @var{language} 2875824d651Sblueswir1 2885824d651Sblueswir1Use keyboard layout @var{language} (for example @code{fr} for 2895824d651Sblueswir1French). This option is only needed where it is not easy to get raw PC 2905824d651Sblueswir1keycodes (e.g. on Macs, with some X11 servers or with a VNC 2915824d651Sblueswir1display). You don't normally need to use it on PC/Linux or PC/Windows 2925824d651Sblueswir1hosts. 2935824d651Sblueswir1 2945824d651Sblueswir1The available layouts are: 2955824d651Sblueswir1@example 2965824d651Sblueswir1ar de-ch es fo fr-ca hu ja mk no pt-br sv 2975824d651Sblueswir1da en-gb et fr fr-ch is lt nl pl ru th 2985824d651Sblueswir1de en-us fi fr-be hr it lv nl-be pt sl tr 2995824d651Sblueswir1@end example 3005824d651Sblueswir1 3015824d651Sblueswir1The default is @code{en-us}. 3025824d651Sblueswir1ETEXI 3035824d651Sblueswir1 3045824d651Sblueswir1 3055824d651Sblueswir1#ifdef HAS_AUDIO 3065824d651Sblueswir1DEF("audio-help", 0, QEMU_OPTION_audio_help, 3075824d651Sblueswir1 "-audio-help print list of audio drivers and their options\n") 3085824d651Sblueswir1#endif 3095824d651Sblueswir1STEXI 3105824d651Sblueswir1@item -audio-help 3115824d651Sblueswir1 3125824d651Sblueswir1Will show the audio subsystem help: list of drivers, tunable 3135824d651Sblueswir1parameters. 3145824d651Sblueswir1ETEXI 3155824d651Sblueswir1 3165824d651Sblueswir1#ifdef HAS_AUDIO 3175824d651Sblueswir1DEF("soundhw", HAS_ARG, QEMU_OPTION_soundhw, 3185824d651Sblueswir1 "-soundhw c1,... enable audio support\n" 3195824d651Sblueswir1 " and only specified sound cards (comma separated list)\n" 3205824d651Sblueswir1 " use -soundhw ? to get the list of supported cards\n" 3215824d651Sblueswir1 " use -soundhw all to enable all of them\n") 3225824d651Sblueswir1#endif 3235824d651Sblueswir1STEXI 3245824d651Sblueswir1@item -soundhw @var{card1}[,@var{card2},...] or -soundhw all 3255824d651Sblueswir1 3265824d651Sblueswir1Enable audio and selected sound hardware. Use ? to print all 3275824d651Sblueswir1available sound hardware. 3285824d651Sblueswir1 3295824d651Sblueswir1@example 3305824d651Sblueswir1qemu -soundhw sb16,adlib disk.img 3315824d651Sblueswir1qemu -soundhw es1370 disk.img 3325824d651Sblueswir1qemu -soundhw ac97 disk.img 3335824d651Sblueswir1qemu -soundhw all disk.img 3345824d651Sblueswir1qemu -soundhw ? 3355824d651Sblueswir1@end example 3365824d651Sblueswir1 3375824d651Sblueswir1Note that Linux's i810_audio OSS kernel (for AC97) module might 3385824d651Sblueswir1require manually specifying clocking. 3395824d651Sblueswir1 3405824d651Sblueswir1@example 3415824d651Sblueswir1modprobe i810_audio clocking=48000 3425824d651Sblueswir1@end example 3435824d651Sblueswir1ETEXI 3445824d651Sblueswir1 3455824d651Sblueswir1STEXI 3465824d651Sblueswir1@end table 3475824d651Sblueswir1ETEXI 3485824d651Sblueswir1 3495824d651Sblueswir1DEF("usb", 0, QEMU_OPTION_usb, 3505824d651Sblueswir1 "-usb enable the USB driver (will be the default soon)\n") 3515824d651Sblueswir1STEXI 3525824d651Sblueswir1USB options: 3535824d651Sblueswir1@table @option 3545824d651Sblueswir1 3555824d651Sblueswir1@item -usb 3565824d651Sblueswir1Enable the USB driver (will be the default soon) 3575824d651Sblueswir1ETEXI 3585824d651Sblueswir1 3595824d651Sblueswir1DEF("usbdevice", HAS_ARG, QEMU_OPTION_usbdevice, 3605824d651Sblueswir1 "-usbdevice name add the host or guest USB device 'name'\n") 3615824d651Sblueswir1STEXI 3625824d651Sblueswir1 3635824d651Sblueswir1@item -usbdevice @var{devname} 3645824d651Sblueswir1Add the USB device @var{devname}. @xref{usb_devices}. 3655824d651Sblueswir1 3665824d651Sblueswir1@table @code 3675824d651Sblueswir1 3685824d651Sblueswir1@item mouse 3695824d651Sblueswir1Virtual Mouse. This will override the PS/2 mouse emulation when activated. 3705824d651Sblueswir1 3715824d651Sblueswir1@item tablet 3725824d651Sblueswir1Pointer device that uses absolute coordinates (like a touchscreen). This 3735824d651Sblueswir1means qemu is able to report the mouse position without having to grab the 3745824d651Sblueswir1mouse. Also overrides the PS/2 mouse emulation when activated. 3755824d651Sblueswir1 3765824d651Sblueswir1@item disk:[format=@var{format}]:file 3775824d651Sblueswir1Mass storage device based on file. The optional @var{format} argument 3785824d651Sblueswir1will be used rather than detecting the format. Can be used to specifiy 3795824d651Sblueswir1format=raw to avoid interpreting an untrusted format header. 3805824d651Sblueswir1 3815824d651Sblueswir1@item host:bus.addr 3825824d651Sblueswir1Pass through the host device identified by bus.addr (Linux only). 3835824d651Sblueswir1 3845824d651Sblueswir1@item host:vendor_id:product_id 3855824d651Sblueswir1Pass through the host device identified by vendor_id:product_id (Linux only). 3865824d651Sblueswir1 3875824d651Sblueswir1@item serial:[vendorid=@var{vendor_id}][,productid=@var{product_id}]:@var{dev} 3885824d651Sblueswir1Serial converter to host character device @var{dev}, see @code{-serial} for the 3895824d651Sblueswir1available devices. 3905824d651Sblueswir1 3915824d651Sblueswir1@item braille 3925824d651Sblueswir1Braille device. This will use BrlAPI to display the braille output on a real 3935824d651Sblueswir1or fake device. 3945824d651Sblueswir1 3955824d651Sblueswir1@item net:options 3965824d651Sblueswir1Network adapter that supports CDC ethernet and RNDIS protocols. 3975824d651Sblueswir1 3985824d651Sblueswir1@end table 3995824d651Sblueswir1ETEXI 4005824d651Sblueswir1 401bd3c948dSGerd HoffmannDEF("device", HAS_ARG, QEMU_OPTION_device, 402bd3c948dSGerd Hoffmann "-device driver[,options] add device\n") 4035824d651Sblueswir1DEF("name", HAS_ARG, QEMU_OPTION_name, 4041889465aSAndi Kleen "-name string1[,process=string2] set the name of the guest\n" 4051889465aSAndi Kleen " string1 sets the window title and string2 the process name (on Linux)\n") 4065824d651Sblueswir1STEXI 4075824d651Sblueswir1@item -name @var{name} 4085824d651Sblueswir1Sets the @var{name} of the guest. 4095824d651Sblueswir1This name will be displayed in the SDL window caption. 4105824d651Sblueswir1The @var{name} will also be used for the VNC server. 4111889465aSAndi KleenAlso optionally set the top visible process name in Linux. 4125824d651Sblueswir1ETEXI 4135824d651Sblueswir1 4145824d651Sblueswir1DEF("uuid", HAS_ARG, QEMU_OPTION_uuid, 4155824d651Sblueswir1 "-uuid %%08x-%%04x-%%04x-%%04x-%%012x\n" 4165824d651Sblueswir1 " specify machine UUID\n") 4175824d651Sblueswir1STEXI 4185824d651Sblueswir1@item -uuid @var{uuid} 4195824d651Sblueswir1Set system UUID. 4205824d651Sblueswir1ETEXI 4215824d651Sblueswir1 4225824d651Sblueswir1STEXI 4235824d651Sblueswir1@end table 4245824d651Sblueswir1ETEXI 4255824d651Sblueswir1 4265824d651Sblueswir1DEFHEADING() 4275824d651Sblueswir1 4285824d651Sblueswir1DEFHEADING(Display options:) 4295824d651Sblueswir1 4305824d651Sblueswir1STEXI 4315824d651Sblueswir1@table @option 4325824d651Sblueswir1ETEXI 4335824d651Sblueswir1 4345824d651Sblueswir1DEF("nographic", 0, QEMU_OPTION_nographic, 4355824d651Sblueswir1 "-nographic disable graphical output and redirect serial I/Os to console\n") 4365824d651Sblueswir1STEXI 4375824d651Sblueswir1@item -nographic 4385824d651Sblueswir1 4395824d651Sblueswir1Normally, QEMU uses SDL to display the VGA output. With this option, 4405824d651Sblueswir1you can totally disable graphical output so that QEMU is a simple 4415824d651Sblueswir1command line application. The emulated serial port is redirected on 4425824d651Sblueswir1the console. Therefore, you can still use QEMU to debug a Linux kernel 4435824d651Sblueswir1with a serial console. 4445824d651Sblueswir1ETEXI 4455824d651Sblueswir1 4465824d651Sblueswir1#ifdef CONFIG_CURSES 4475824d651Sblueswir1DEF("curses", 0, QEMU_OPTION_curses, 4485824d651Sblueswir1 "-curses use a curses/ncurses interface instead of SDL\n") 4495824d651Sblueswir1#endif 4505824d651Sblueswir1STEXI 4515824d651Sblueswir1@item -curses 4525824d651Sblueswir1 4535824d651Sblueswir1Normally, QEMU uses SDL to display the VGA output. With this option, 4545824d651Sblueswir1QEMU can display the VGA output when in text mode using a 4555824d651Sblueswir1curses/ncurses interface. Nothing is displayed in graphical mode. 4565824d651Sblueswir1ETEXI 4575824d651Sblueswir1 4585824d651Sblueswir1#ifdef CONFIG_SDL 4595824d651Sblueswir1DEF("no-frame", 0, QEMU_OPTION_no_frame, 4605824d651Sblueswir1 "-no-frame open SDL window without a frame and window decorations\n") 4615824d651Sblueswir1#endif 4625824d651Sblueswir1STEXI 4635824d651Sblueswir1@item -no-frame 4645824d651Sblueswir1 4655824d651Sblueswir1Do not use decorations for SDL windows and start them using the whole 4665824d651Sblueswir1available screen space. This makes the using QEMU in a dedicated desktop 4675824d651Sblueswir1workspace more convenient. 4685824d651Sblueswir1ETEXI 4695824d651Sblueswir1 4705824d651Sblueswir1#ifdef CONFIG_SDL 4715824d651Sblueswir1DEF("alt-grab", 0, QEMU_OPTION_alt_grab, 4725824d651Sblueswir1 "-alt-grab use Ctrl-Alt-Shift to grab mouse (instead of Ctrl-Alt)\n") 4735824d651Sblueswir1#endif 4745824d651Sblueswir1STEXI 4755824d651Sblueswir1@item -alt-grab 4765824d651Sblueswir1 4775824d651Sblueswir1Use Ctrl-Alt-Shift to grab mouse (instead of Ctrl-Alt). 4785824d651Sblueswir1ETEXI 4795824d651Sblueswir1 4805824d651Sblueswir1#ifdef CONFIG_SDL 4810ca9f8a4SDustin KirklandDEF("ctrl-grab", 0, QEMU_OPTION_ctrl_grab, 4820ca9f8a4SDustin Kirkland "-ctrl-grab use Right-Ctrl to grab mouse (instead of Ctrl-Alt)\n") 4830ca9f8a4SDustin Kirkland#endif 4840ca9f8a4SDustin KirklandSTEXI 4850ca9f8a4SDustin Kirkland@item -ctrl-grab 4860ca9f8a4SDustin Kirkland 4870ca9f8a4SDustin KirklandUse Right-Ctrl to grab mouse (instead of Ctrl-Alt). 4880ca9f8a4SDustin KirklandETEXI 4890ca9f8a4SDustin Kirkland 4900ca9f8a4SDustin Kirkland#ifdef CONFIG_SDL 4915824d651Sblueswir1DEF("no-quit", 0, QEMU_OPTION_no_quit, 4925824d651Sblueswir1 "-no-quit disable SDL window close capability\n") 4935824d651Sblueswir1#endif 4945824d651Sblueswir1STEXI 4955824d651Sblueswir1@item -no-quit 4965824d651Sblueswir1 4975824d651Sblueswir1Disable SDL window close capability. 4985824d651Sblueswir1ETEXI 4995824d651Sblueswir1 5005824d651Sblueswir1#ifdef CONFIG_SDL 5015824d651Sblueswir1DEF("sdl", 0, QEMU_OPTION_sdl, 5025824d651Sblueswir1 "-sdl enable SDL\n") 5035824d651Sblueswir1#endif 5045824d651Sblueswir1STEXI 5055824d651Sblueswir1@item -sdl 5065824d651Sblueswir1 5075824d651Sblueswir1Enable SDL. 5085824d651Sblueswir1ETEXI 5095824d651Sblueswir1 5105824d651Sblueswir1DEF("portrait", 0, QEMU_OPTION_portrait, 5115824d651Sblueswir1 "-portrait rotate graphical output 90 deg left (only PXA LCD)\n") 5125824d651Sblueswir1STEXI 5135824d651Sblueswir1@item -portrait 5145824d651Sblueswir1 5155824d651Sblueswir1Rotate graphical output 90 deg left (only PXA LCD). 5165824d651Sblueswir1ETEXI 5175824d651Sblueswir1 5185824d651Sblueswir1DEF("vga", HAS_ARG, QEMU_OPTION_vga, 51994909d9fSaliguori "-vga [std|cirrus|vmware|xenfb|none]\n" 5205824d651Sblueswir1 " select video card type\n") 5215824d651Sblueswir1STEXI 5225824d651Sblueswir1@item -vga @var{type} 5235824d651Sblueswir1Select type of VGA card to emulate. Valid values for @var{type} are 5245824d651Sblueswir1@table @code 5255824d651Sblueswir1@item cirrus 5265824d651Sblueswir1Cirrus Logic GD5446 Video card. All Windows versions starting from 5275824d651Sblueswir1Windows 95 should recognize and use this graphic card. For optimal 5285824d651Sblueswir1performances, use 16 bit color depth in the guest and the host OS. 5295824d651Sblueswir1(This one is the default) 5305824d651Sblueswir1@item std 5315824d651Sblueswir1Standard VGA card with Bochs VBE extensions. If your guest OS 5325824d651Sblueswir1supports the VESA 2.0 VBE extensions (e.g. Windows XP) and if you want 5335824d651Sblueswir1to use high resolution modes (>= 1280x1024x16) then you should use 5345824d651Sblueswir1this option. 5355824d651Sblueswir1@item vmware 5365824d651Sblueswir1VMWare SVGA-II compatible adapter. Use it if you have sufficiently 5375824d651Sblueswir1recent XFree86/XOrg server or Windows guest with a driver for this 5385824d651Sblueswir1card. 5395824d651Sblueswir1@item none 5405824d651Sblueswir1Disable VGA card. 5415824d651Sblueswir1@end table 5425824d651Sblueswir1ETEXI 5435824d651Sblueswir1 5445824d651Sblueswir1DEF("full-screen", 0, QEMU_OPTION_full_screen, 5455824d651Sblueswir1 "-full-screen start in full screen\n") 5465824d651Sblueswir1STEXI 5475824d651Sblueswir1@item -full-screen 5485824d651Sblueswir1Start in full screen. 5495824d651Sblueswir1ETEXI 5505824d651Sblueswir1 5515824d651Sblueswir1#if defined(TARGET_PPC) || defined(TARGET_SPARC) 5525824d651Sblueswir1DEF("g", 1, QEMU_OPTION_g , 5535824d651Sblueswir1 "-g WxH[xDEPTH] Set the initial graphical resolution and depth\n") 5545824d651Sblueswir1#endif 5555824d651Sblueswir1STEXI 5565824d651Sblueswir1ETEXI 5575824d651Sblueswir1 5585824d651Sblueswir1DEF("vnc", HAS_ARG, QEMU_OPTION_vnc , 5595824d651Sblueswir1 "-vnc display start a VNC server on display\n") 5605824d651Sblueswir1STEXI 5615824d651Sblueswir1@item -vnc @var{display}[,@var{option}[,@var{option}[,...]]] 5625824d651Sblueswir1 5635824d651Sblueswir1Normally, QEMU uses SDL to display the VGA output. With this option, 5645824d651Sblueswir1you can have QEMU listen on VNC display @var{display} and redirect the VGA 5655824d651Sblueswir1display over the VNC session. It is very useful to enable the usb 5665824d651Sblueswir1tablet device when using this option (option @option{-usbdevice 5675824d651Sblueswir1tablet}). When using the VNC display, you must use the @option{-k} 5685824d651Sblueswir1parameter to set the keyboard layout if you are not using en-us. Valid 5695824d651Sblueswir1syntax for the @var{display} is 5705824d651Sblueswir1 5715824d651Sblueswir1@table @code 5725824d651Sblueswir1 5735824d651Sblueswir1@item @var{host}:@var{d} 5745824d651Sblueswir1 5755824d651Sblueswir1TCP connections will only be allowed from @var{host} on display @var{d}. 5765824d651Sblueswir1By convention the TCP port is 5900+@var{d}. Optionally, @var{host} can 5775824d651Sblueswir1be omitted in which case the server will accept connections from any host. 5785824d651Sblueswir1 5795824d651Sblueswir1@item @code{unix}:@var{path} 5805824d651Sblueswir1 5815824d651Sblueswir1Connections will be allowed over UNIX domain sockets where @var{path} is the 5825824d651Sblueswir1location of a unix socket to listen for connections on. 5835824d651Sblueswir1 5845824d651Sblueswir1@item none 5855824d651Sblueswir1 5865824d651Sblueswir1VNC is initialized but not started. The monitor @code{change} command 5875824d651Sblueswir1can be used to later start the VNC server. 5885824d651Sblueswir1 5895824d651Sblueswir1@end table 5905824d651Sblueswir1 5915824d651Sblueswir1Following the @var{display} value there may be one or more @var{option} flags 5925824d651Sblueswir1separated by commas. Valid options are 5935824d651Sblueswir1 5945824d651Sblueswir1@table @code 5955824d651Sblueswir1 5965824d651Sblueswir1@item reverse 5975824d651Sblueswir1 5985824d651Sblueswir1Connect to a listening VNC client via a ``reverse'' connection. The 5995824d651Sblueswir1client is specified by the @var{display}. For reverse network 6005824d651Sblueswir1connections (@var{host}:@var{d},@code{reverse}), the @var{d} argument 6015824d651Sblueswir1is a TCP port number, not a display number. 6025824d651Sblueswir1 6035824d651Sblueswir1@item password 6045824d651Sblueswir1 6055824d651Sblueswir1Require that password based authentication is used for client connections. 6065824d651Sblueswir1The password must be set separately using the @code{change} command in the 6075824d651Sblueswir1@ref{pcsys_monitor} 6085824d651Sblueswir1 6095824d651Sblueswir1@item tls 6105824d651Sblueswir1 6115824d651Sblueswir1Require that client use TLS when communicating with the VNC server. This 6125824d651Sblueswir1uses anonymous TLS credentials so is susceptible to a man-in-the-middle 6135824d651Sblueswir1attack. It is recommended that this option be combined with either the 6145824d651Sblueswir1@var{x509} or @var{x509verify} options. 6155824d651Sblueswir1 6165824d651Sblueswir1@item x509=@var{/path/to/certificate/dir} 6175824d651Sblueswir1 6185824d651Sblueswir1Valid if @option{tls} is specified. Require that x509 credentials are used 6195824d651Sblueswir1for negotiating the TLS session. The server will send its x509 certificate 6205824d651Sblueswir1to the client. It is recommended that a password be set on the VNC server 6215824d651Sblueswir1to provide authentication of the client when this is used. The path following 6225824d651Sblueswir1this option specifies where the x509 certificates are to be loaded from. 6235824d651Sblueswir1See the @ref{vnc_security} section for details on generating certificates. 6245824d651Sblueswir1 6255824d651Sblueswir1@item x509verify=@var{/path/to/certificate/dir} 6265824d651Sblueswir1 6275824d651Sblueswir1Valid if @option{tls} is specified. Require that x509 credentials are used 6285824d651Sblueswir1for negotiating the TLS session. The server will send its x509 certificate 6295824d651Sblueswir1to the client, and request that the client send its own x509 certificate. 6305824d651Sblueswir1The server will validate the client's certificate against the CA certificate, 6315824d651Sblueswir1and reject clients when validation fails. If the certificate authority is 6325824d651Sblueswir1trusted, this is a sufficient authentication mechanism. You may still wish 6335824d651Sblueswir1to set a password on the VNC server as a second authentication layer. The 6345824d651Sblueswir1path following this option specifies where the x509 certificates are to 6355824d651Sblueswir1be loaded from. See the @ref{vnc_security} section for details on generating 6365824d651Sblueswir1certificates. 6375824d651Sblueswir1 6385824d651Sblueswir1@item sasl 6395824d651Sblueswir1 6405824d651Sblueswir1Require that the client use SASL to authenticate with the VNC server. 6415824d651Sblueswir1The exact choice of authentication method used is controlled from the 6425824d651Sblueswir1system / user's SASL configuration file for the 'qemu' service. This 6435824d651Sblueswir1is typically found in /etc/sasl2/qemu.conf. If running QEMU as an 6445824d651Sblueswir1unprivileged user, an environment variable SASL_CONF_PATH can be used 6455824d651Sblueswir1to make it search alternate locations for the service config. 6465824d651Sblueswir1While some SASL auth methods can also provide data encryption (eg GSSAPI), 6475824d651Sblueswir1it is recommended that SASL always be combined with the 'tls' and 6485824d651Sblueswir1'x509' settings to enable use of SSL and server certificates. This 6495824d651Sblueswir1ensures a data encryption preventing compromise of authentication 6505824d651Sblueswir1credentials. See the @ref{vnc_security} section for details on using 6515824d651Sblueswir1SASL authentication. 6525824d651Sblueswir1 6535824d651Sblueswir1@item acl 6545824d651Sblueswir1 6555824d651Sblueswir1Turn on access control lists for checking of the x509 client certificate 6565824d651Sblueswir1and SASL party. For x509 certs, the ACL check is made against the 6575824d651Sblueswir1certificate's distinguished name. This is something that looks like 6585824d651Sblueswir1@code{C=GB,O=ACME,L=Boston,CN=bob}. For SASL party, the ACL check is 6595824d651Sblueswir1made against the username, which depending on the SASL plugin, may 6605824d651Sblueswir1include a realm component, eg @code{bob} or @code{bob@@EXAMPLE.COM}. 6615824d651Sblueswir1When the @option{acl} flag is set, the initial access list will be 6625824d651Sblueswir1empty, with a @code{deny} policy. Thus no one will be allowed to 6635824d651Sblueswir1use the VNC server until the ACLs have been loaded. This can be 6645824d651Sblueswir1achieved using the @code{acl} monitor command. 6655824d651Sblueswir1 6665824d651Sblueswir1@end table 6675824d651Sblueswir1ETEXI 6685824d651Sblueswir1 6695824d651Sblueswir1STEXI 6705824d651Sblueswir1@end table 6715824d651Sblueswir1ETEXI 6725824d651Sblueswir1 6735824d651Sblueswir1DEFHEADING() 6745824d651Sblueswir1 6755824d651Sblueswir1#ifdef TARGET_I386 6765824d651Sblueswir1DEFHEADING(i386 target only:) 6775824d651Sblueswir1#endif 6785824d651Sblueswir1STEXI 6795824d651Sblueswir1@table @option 6805824d651Sblueswir1ETEXI 6815824d651Sblueswir1 6825824d651Sblueswir1#ifdef TARGET_I386 6835824d651Sblueswir1DEF("win2k-hack", 0, QEMU_OPTION_win2k_hack, 6845824d651Sblueswir1 "-win2k-hack use it when installing Windows 2000 to avoid a disk full bug\n") 6855824d651Sblueswir1#endif 6865824d651Sblueswir1STEXI 6875824d651Sblueswir1@item -win2k-hack 6885824d651Sblueswir1Use it when installing Windows 2000 to avoid a disk full bug. After 6895824d651Sblueswir1Windows 2000 is installed, you no longer need this option (this option 6905824d651Sblueswir1slows down the IDE transfers). 6915824d651Sblueswir1ETEXI 6925824d651Sblueswir1 6935824d651Sblueswir1#ifdef TARGET_I386 6941ed2fc1fSJan KiszkaHXCOMM Deprecated by -rtc 6951ed2fc1fSJan KiszkaDEF("rtc-td-hack", 0, QEMU_OPTION_rtc_td_hack, "") 6965824d651Sblueswir1#endif 6975824d651Sblueswir1 6985824d651Sblueswir1#ifdef TARGET_I386 6995824d651Sblueswir1DEF("no-fd-bootchk", 0, QEMU_OPTION_no_fd_bootchk, 7005824d651Sblueswir1 "-no-fd-bootchk disable boot signature checking for floppy disks\n") 7015824d651Sblueswir1#endif 7025824d651Sblueswir1STEXI 7035824d651Sblueswir1@item -no-fd-bootchk 7045824d651Sblueswir1Disable boot signature checking for floppy disks in Bochs BIOS. It may 7055824d651Sblueswir1be needed to boot from old floppy disks. 7065824d651Sblueswir1ETEXI 7075824d651Sblueswir1 7085824d651Sblueswir1#ifdef TARGET_I386 7095824d651Sblueswir1DEF("no-acpi", 0, QEMU_OPTION_no_acpi, 7105824d651Sblueswir1 "-no-acpi disable ACPI\n") 7115824d651Sblueswir1#endif 7125824d651Sblueswir1STEXI 7135824d651Sblueswir1@item -no-acpi 7145824d651Sblueswir1Disable ACPI (Advanced Configuration and Power Interface) support. Use 7155824d651Sblueswir1it if your guest OS complains about ACPI problems (PC target machine 7165824d651Sblueswir1only). 7175824d651Sblueswir1ETEXI 7185824d651Sblueswir1 7195824d651Sblueswir1#ifdef TARGET_I386 7205824d651Sblueswir1DEF("no-hpet", 0, QEMU_OPTION_no_hpet, 7215824d651Sblueswir1 "-no-hpet disable HPET\n") 7225824d651Sblueswir1#endif 7235824d651Sblueswir1STEXI 7245824d651Sblueswir1@item -no-hpet 7255824d651Sblueswir1Disable HPET support. 7265824d651Sblueswir1ETEXI 7275824d651Sblueswir1 7285824d651Sblueswir1#ifdef TARGET_I386 7297d4c3d53SMarkus ArmbrusterDEF("balloon", HAS_ARG, QEMU_OPTION_balloon, 7307d4c3d53SMarkus Armbruster "-balloon none disable balloon device\n" 7317d4c3d53SMarkus Armbruster "-balloon virtio[,addr=str]\n" 7327d4c3d53SMarkus Armbruster " enable virtio balloon device (default)\n") 733df97b920SEduardo Habkost#endif 734df97b920SEduardo HabkostSTEXI 7357d4c3d53SMarkus Armbruster@item -balloon none 7367d4c3d53SMarkus ArmbrusterDisable balloon device. 7377d4c3d53SMarkus Armbruster@item -balloon virtio[,addr=@var{addr}] 7387d4c3d53SMarkus ArmbrusterEnable virtio balloon device (default), optionally with PCI address 7397d4c3d53SMarkus Armbruster@var{addr}. 740df97b920SEduardo HabkostETEXI 741df97b920SEduardo Habkost 742df97b920SEduardo Habkost#ifdef TARGET_I386 7435824d651Sblueswir1DEF("acpitable", HAS_ARG, QEMU_OPTION_acpitable, 7445824d651Sblueswir1 "-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" 7455824d651Sblueswir1 " ACPI table description\n") 7465824d651Sblueswir1#endif 7475824d651Sblueswir1STEXI 7485824d651Sblueswir1@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}]...] 7495824d651Sblueswir1Add ACPI table with specified header fields and context from specified files. 7505824d651Sblueswir1ETEXI 7515824d651Sblueswir1 7525824d651Sblueswir1#ifdef TARGET_I386 753b6f6e3d3SaliguoriDEF("smbios", HAS_ARG, QEMU_OPTION_smbios, 754b6f6e3d3Saliguori "-smbios file=binary\n" 755b6f6e3d3Saliguori " Load SMBIOS entry from binary file\n" 756b6f6e3d3Saliguori "-smbios type=0[,vendor=str][,version=str][,date=str][,release=%%d.%%d]\n" 757b6f6e3d3Saliguori " Specify SMBIOS type 0 fields\n" 758b6f6e3d3Saliguori "-smbios type=1[,manufacturer=str][,product=str][,version=str][,serial=str]\n" 759b6f6e3d3Saliguori " [,uuid=uuid][,sku=str][,family=str]\n" 760b6f6e3d3Saliguori " Specify SMBIOS type 1 fields\n") 761b6f6e3d3Saliguori#endif 762b6f6e3d3SaliguoriSTEXI 763b6f6e3d3Saliguori@item -smbios file=@var{binary} 764b6f6e3d3SaliguoriLoad SMBIOS entry from binary file. 765b6f6e3d3Saliguori 766b6f6e3d3Saliguori@item -smbios type=0[,vendor=@var{str}][,version=@var{str}][,date=@var{str}][,release=@var{%d.%d}] 767b6f6e3d3SaliguoriSpecify SMBIOS type 0 fields 768b6f6e3d3Saliguori 769b6f6e3d3Saliguori@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}] 770b6f6e3d3SaliguoriSpecify SMBIOS type 1 fields 771b6f6e3d3SaliguoriETEXI 772b6f6e3d3Saliguori 773b6f6e3d3Saliguori#ifdef TARGET_I386 7745824d651Sblueswir1DEFHEADING() 7755824d651Sblueswir1#endif 7765824d651Sblueswir1STEXI 7775824d651Sblueswir1@end table 7785824d651Sblueswir1ETEXI 7795824d651Sblueswir1 7805824d651Sblueswir1DEFHEADING(Network options:) 7815824d651Sblueswir1STEXI 7825824d651Sblueswir1@table @option 7835824d651Sblueswir1ETEXI 7845824d651Sblueswir1 785ad196a9dSJan KiszkaHXCOMM Legacy slirp options (now moved to -net user): 786ad196a9dSJan Kiszka#ifdef CONFIG_SLIRP 787ad196a9dSJan KiszkaDEF("tftp", HAS_ARG, QEMU_OPTION_tftp, "") 788ad196a9dSJan KiszkaDEF("bootp", HAS_ARG, QEMU_OPTION_bootp, "") 789ad196a9dSJan KiszkaDEF("redir", HAS_ARG, QEMU_OPTION_redir, "") 790ad196a9dSJan Kiszka#ifndef _WIN32 791ad196a9dSJan KiszkaDEF("smb", HAS_ARG, QEMU_OPTION_smb, "") 792ad196a9dSJan Kiszka#endif 793ad196a9dSJan Kiszka#endif 794ad196a9dSJan Kiszka 795bab7944cSBlue SwirlDEF("net", HAS_ARG, QEMU_OPTION_net, 796ffe6370cSMichael S. Tsirkin "-net nic[,vlan=n][,macaddr=mac][,model=type][,name=str][,addr=str][,vectors=v]\n" 7975824d651Sblueswir1 " create a new Network Interface Card and connect it to VLAN 'n'\n" 7985824d651Sblueswir1#ifdef CONFIG_SLIRP 799c92ef6a2SJan Kiszka "-net user[,vlan=n][,name=str][,net=addr[/mask]][,host=addr][,restrict=y|n]\n" 800c92ef6a2SJan Kiszka " [,hostname=host][,dhcpstart=addr][,dns=addr][,tftp=dir][,bootfile=f]\n" 801c92ef6a2SJan Kiszka " [,hostfwd=rule][,guestfwd=rule]" 802ad196a9dSJan Kiszka#ifndef _WIN32 803c92ef6a2SJan Kiszka "[,smb=dir[,smbserver=addr]]\n" 804ad196a9dSJan Kiszka#endif 805ad196a9dSJan Kiszka " connect the user mode network stack to VLAN 'n', configure its\n" 806ad196a9dSJan Kiszka " DHCP server and enabled optional services\n" 8075824d651Sblueswir1#endif 8085824d651Sblueswir1#ifdef _WIN32 8095824d651Sblueswir1 "-net tap[,vlan=n][,name=str],ifname=name\n" 8105824d651Sblueswir1 " connect the host TAP network interface to VLAN 'n'\n" 8115824d651Sblueswir1#else 8120df0ff6dSMark McLoughlin "-net tap[,vlan=n][,name=str][,fd=h][,ifname=name][,script=file][,downscript=dfile]" 8130df0ff6dSMark McLoughlin#ifdef TUNSETSNDBUF 8140df0ff6dSMark McLoughlin "[,sndbuf=nbytes]" 8150df0ff6dSMark McLoughlin#endif 8160df0ff6dSMark McLoughlin "\n" 8175824d651Sblueswir1 " connect the host TAP network interface to VLAN 'n' and use the\n" 8185824d651Sblueswir1 " network scripts 'file' (default=%s)\n" 8195824d651Sblueswir1 " and 'dfile' (default=%s);\n" 8205824d651Sblueswir1 " use '[down]script=no' to disable script execution;\n" 8215824d651Sblueswir1 " use 'fd=h' to connect to an already opened TAP interface\n" 8220df0ff6dSMark McLoughlin#ifdef TUNSETSNDBUF 823fc5b81d1SMark McLoughlin " use 'sndbuf=nbytes' to limit the size of the send buffer; the\n" 824fc5b81d1SMark McLoughlin " default of 'sndbuf=1048576' can be disabled using 'sndbuf=0'\n" 8250df0ff6dSMark McLoughlin#endif 8265824d651Sblueswir1#endif 8275824d651Sblueswir1 "-net socket[,vlan=n][,name=str][,fd=h][,listen=[host]:port][,connect=host:port]\n" 8285824d651Sblueswir1 " connect the vlan 'n' to another VLAN using a socket connection\n" 8295824d651Sblueswir1 "-net socket[,vlan=n][,name=str][,fd=h][,mcast=maddr:port]\n" 8305824d651Sblueswir1 " connect the vlan 'n' to multicast maddr and port\n" 8315824d651Sblueswir1#ifdef CONFIG_VDE 8325824d651Sblueswir1 "-net vde[,vlan=n][,name=str][,sock=socketpath][,port=n][,group=groupname][,mode=octalmode]\n" 8335824d651Sblueswir1 " connect the vlan 'n' to port 'n' of a vde switch running\n" 8345824d651Sblueswir1 " on host and listening for incoming connections on 'socketpath'.\n" 8355824d651Sblueswir1 " Use group 'groupname' and mode 'octalmode' to change default\n" 8365824d651Sblueswir1 " ownership and permissions for communication port.\n" 8375824d651Sblueswir1#endif 838bb9ea79eSaliguori "-net dump[,vlan=n][,file=f][,len=n]\n" 839bb9ea79eSaliguori " dump traffic on vlan 'n' to file 'f' (max n bytes per packet)\n" 8405824d651Sblueswir1 "-net none use it alone to have zero network devices; if no -net option\n" 8415824d651Sblueswir1 " is provided, the default is '-net nic -net user'\n") 842*a1ea458fSMark McLoughlinDEF("netdev", HAS_ARG, QEMU_OPTION_netdev, 843*a1ea458fSMark McLoughlin "-netdev [" 844*a1ea458fSMark McLoughlin#ifdef CONFIG_SLIRP 845*a1ea458fSMark McLoughlin "user|" 846*a1ea458fSMark McLoughlin#endif 847*a1ea458fSMark McLoughlin "tap|" 848*a1ea458fSMark McLoughlin#ifdef CONFIG_VDE 849*a1ea458fSMark McLoughlin "vde|" 850*a1ea458fSMark McLoughlin#endif 851*a1ea458fSMark McLoughlin "socket],id=str[,option][,option][,...]\n") 8525824d651Sblueswir1STEXI 853ffe6370cSMichael S. Tsirkin@item -net nic[,vlan=@var{n}][,macaddr=@var{mac}][,model=@var{type}][,name=@var{name}][,addr=@var{addr}][,vectors=@var{v}] 8545824d651Sblueswir1Create a new Network Interface Card and connect it to VLAN @var{n} (@var{n} 8550d6b0b1dSAnthony Liguori= 0 is the default). The NIC is an e1000 by default on the PC 8565607c388SMarkus Armbrustertarget. Optionally, the MAC address can be changed to @var{mac}, the 8575607c388SMarkus Armbrusterdevice address set to @var{addr} (PCI cards only), 858ffe6370cSMichael S. Tsirkinand a @var{name} can be assigned for use in monitor commands. 859ffe6370cSMichael S. TsirkinOptionally, for PCI cards, you can specify the number @var{v} of MSI-X vectors 860ffe6370cSMichael S. Tsirkinthat the card should have; this option currently only affects virtio cards; set 861ffe6370cSMichael S. Tsirkin@var{v} = 0 to disable MSI-X. If no @option{-net} option is specified, a single 862ffe6370cSMichael S. TsirkinNIC is created. Qemu can emulate several different models of network card. 8635824d651Sblueswir1Valid values for @var{type} are 864ffe6370cSMichael S. Tsirkin@code{virtio}, @code{i82551}, @code{i82557b}, @code{i82559er}, 8655824d651Sblueswir1@code{ne2k_pci}, @code{ne2k_isa}, @code{pcnet}, @code{rtl8139}, 8665824d651Sblueswir1@code{e1000}, @code{smc91c111}, @code{lance} and @code{mcf_fec}. 8675824d651Sblueswir1Not all devices are supported on all targets. Use -net nic,model=? 8685824d651Sblueswir1for a list of available devices for your target. 8695824d651Sblueswir1 870ad196a9dSJan Kiszka@item -net user[,@var{option}][,@var{option}][,...] 8715824d651Sblueswir1Use the user mode network stack which requires no administrator 872ad196a9dSJan Kiszkaprivilege to run. Valid options are: 8735824d651Sblueswir1 874ad196a9dSJan Kiszka@table @code 875ad196a9dSJan Kiszka@item vlan=@var{n} 876ad196a9dSJan KiszkaConnect user mode stack to VLAN @var{n} (@var{n} = 0 is the default). 877ad196a9dSJan Kiszka 878ad196a9dSJan Kiszka@item name=@var{name} 879ad196a9dSJan KiszkaAssign symbolic name for use in monitor commands. 880ad196a9dSJan Kiszka 881c92ef6a2SJan Kiszka@item net=@var{addr}[/@var{mask}] 882c92ef6a2SJan KiszkaSet IP network address the guest will see. Optionally specify the netmask, 883c92ef6a2SJan Kiszkaeither in the form a.b.c.d or as number of valid top-most bits. Default is 884c92ef6a2SJan Kiszka10.0.2.0/8. 885c92ef6a2SJan Kiszka 886c92ef6a2SJan Kiszka@item host=@var{addr} 887c92ef6a2SJan KiszkaSpecify the guest-visible address of the host. Default is the 2nd IP in the 888c92ef6a2SJan Kiszkaguest network, i.e. x.x.x.2. 889ad196a9dSJan Kiszka 890ad196a9dSJan Kiszka@item restrict=y|yes|n|no 891ad196a9dSJan KiszkaIf this options is enabled, the guest will be isolated, i.e. it will not be 892ad196a9dSJan Kiszkaable to contact the host and no guest IP packets will be routed over the host 893ad196a9dSJan Kiszkato the outside. This option does not affect explicitly set forwarding rule. 894ad196a9dSJan Kiszka 895ad196a9dSJan Kiszka@item hostname=@var{name} 896ad196a9dSJan KiszkaSpecifies the client hostname reported by the builtin DHCP server. 897ad196a9dSJan Kiszka 898c92ef6a2SJan Kiszka@item dhcpstart=@var{addr} 899c92ef6a2SJan KiszkaSpecify the first of the 16 IPs the built-in DHCP server can assign. Default 900c92ef6a2SJan Kiszkais the 16th to 31st IP in the guest network, i.e. x.x.x.16 to x.x.x.31. 901c92ef6a2SJan Kiszka 902c92ef6a2SJan Kiszka@item dns=@var{addr} 903c92ef6a2SJan KiszkaSpecify the guest-visible address of the virtual nameserver. The address must 904c92ef6a2SJan Kiszkabe different from the host address. Default is the 3rd IP in the guest network, 905c92ef6a2SJan Kiszkai.e. x.x.x.3. 906c92ef6a2SJan Kiszka 907ad196a9dSJan Kiszka@item tftp=@var{dir} 908ad196a9dSJan KiszkaWhen using the user mode network stack, activate a built-in TFTP 909ad196a9dSJan Kiszkaserver. The files in @var{dir} will be exposed as the root of a TFTP server. 910ad196a9dSJan KiszkaThe TFTP client on the guest must be configured in binary mode (use the command 911c92ef6a2SJan Kiszka@code{bin} of the Unix TFTP client). 912ad196a9dSJan Kiszka 913ad196a9dSJan Kiszka@item bootfile=@var{file} 914ad196a9dSJan KiszkaWhen using the user mode network stack, broadcast @var{file} as the BOOTP 915ad196a9dSJan Kiszkafilename. In conjunction with @option{tftp}, this can be used to network boot 916ad196a9dSJan Kiszkaa guest from a local directory. 917ad196a9dSJan Kiszka 918ad196a9dSJan KiszkaExample (using pxelinux): 919ad196a9dSJan Kiszka@example 920ad196a9dSJan Kiszkaqemu -hda linux.img -boot n -net user,tftp=/path/to/tftp/files,bootfile=/pxelinux.0 921ad196a9dSJan Kiszka@end example 922ad196a9dSJan Kiszka 923c92ef6a2SJan Kiszka@item smb=@var{dir}[,smbserver=@var{addr}] 924ad196a9dSJan KiszkaWhen using the user mode network stack, activate a built-in SMB 925ad196a9dSJan Kiszkaserver so that Windows OSes can access to the host files in @file{@var{dir}} 926c92ef6a2SJan Kiszkatransparently. The IP address of the SMB server can be set to @var{addr}. By 927c92ef6a2SJan Kiszkadefault the 4th IP in the guest network is used, i.e. x.x.x.4. 928ad196a9dSJan Kiszka 929ad196a9dSJan KiszkaIn the guest Windows OS, the line: 930ad196a9dSJan Kiszka@example 931ad196a9dSJan Kiszka10.0.2.4 smbserver 932ad196a9dSJan Kiszka@end example 933ad196a9dSJan Kiszkamust be added in the file @file{C:\WINDOWS\LMHOSTS} (for windows 9x/Me) 934ad196a9dSJan Kiszkaor @file{C:\WINNT\SYSTEM32\DRIVERS\ETC\LMHOSTS} (Windows NT/2000). 935ad196a9dSJan Kiszka 936ad196a9dSJan KiszkaThen @file{@var{dir}} can be accessed in @file{\\smbserver\qemu}. 937ad196a9dSJan Kiszka 938ad196a9dSJan KiszkaNote that a SAMBA server must be installed on the host OS in 939ad196a9dSJan Kiszka@file{/usr/sbin/smbd}. QEMU was tested successfully with smbd versions from 940ad196a9dSJan KiszkaRed Hat 9, Fedora Core 3 and OpenSUSE 11.x. 941ad196a9dSJan Kiszka 9423c6a0580SJan Kiszka@item hostfwd=[tcp|udp]:[@var{hostaddr}]:@var{hostport}-[@var{guestaddr}]:@var{guestport} 943c92ef6a2SJan KiszkaRedirect incoming TCP or UDP connections to the host port @var{hostport} to 944c92ef6a2SJan Kiszkathe guest IP address @var{guestaddr} on guest port @var{guestport}. If 945c92ef6a2SJan Kiszka@var{guestaddr} is not specified, its value is x.x.x.15 (default first address 9463c6a0580SJan Kiszkagiven by the built-in DHCP server). By specifying @var{hostaddr}, the rule can 9473c6a0580SJan Kiszkabe bound to a specific host interface. If no connection type is set, TCP is 948c92ef6a2SJan Kiszkaused. This option can be given multiple times. 949ad196a9dSJan Kiszka 950ad196a9dSJan KiszkaFor example, to redirect host X11 connection from screen 1 to guest 951ad196a9dSJan Kiszkascreen 0, use the following: 952ad196a9dSJan Kiszka 953ad196a9dSJan Kiszka@example 954ad196a9dSJan Kiszka# on the host 9553c6a0580SJan Kiszkaqemu -net user,hostfwd=tcp:127.0.0.1:6001-:6000 [...] 956ad196a9dSJan Kiszka# this host xterm should open in the guest X11 server 957ad196a9dSJan Kiszkaxterm -display :1 958ad196a9dSJan Kiszka@end example 959ad196a9dSJan Kiszka 960ad196a9dSJan KiszkaTo redirect telnet connections from host port 5555 to telnet port on 961ad196a9dSJan Kiszkathe guest, use the following: 962ad196a9dSJan Kiszka 963ad196a9dSJan Kiszka@example 964ad196a9dSJan Kiszka# on the host 965c92ef6a2SJan Kiszkaqemu -net user,hostfwd=tcp:5555::23 [...] 966ad196a9dSJan Kiszkatelnet localhost 5555 967ad196a9dSJan Kiszka@end example 968ad196a9dSJan Kiszka 969ad196a9dSJan KiszkaThen when you use on the host @code{telnet localhost 5555}, you 970ad196a9dSJan Kiszkaconnect to the guest telnet server. 971ad196a9dSJan Kiszka 972c92ef6a2SJan Kiszka@item guestfwd=[tcp]:@var{server}:@var{port}-@var{dev} 9733c6a0580SJan KiszkaForward guest TCP connections to the IP address @var{server} on port @var{port} 9743c6a0580SJan Kiszkato the character device @var{dev}. This option can be given multiple times. 975ad196a9dSJan Kiszka 976ad196a9dSJan Kiszka@end table 977ad196a9dSJan Kiszka 978ad196a9dSJan KiszkaNote: Legacy stand-alone options -tftp, -bootp, -smb and -redir are still 979ad196a9dSJan Kiszkaprocessed and applied to -net user. Mixing them with the new configuration 980ad196a9dSJan Kiszkasyntax gives undefined results. Their use for new applications is discouraged 981ad196a9dSJan Kiszkaas they will be removed from future versions. 9825824d651Sblueswir1 9835824d651Sblueswir1@item -net tap[,vlan=@var{n}][,name=@var{name}][,fd=@var{h}][,ifname=@var{name}][,script=@var{file}][,downscript=@var{dfile}] 9845824d651Sblueswir1Connect the host TAP network interface @var{name} to VLAN @var{n}, use 9855824d651Sblueswir1the network script @var{file} to configure it and the network script 9865824d651Sblueswir1@var{dfile} to deconfigure it. If @var{name} is not provided, the OS 9875824d651Sblueswir1automatically provides one. @option{fd}=@var{h} can be used to specify 9885824d651Sblueswir1the handle of an already opened host TAP interface. The default network 9895824d651Sblueswir1configure script is @file{/etc/qemu-ifup} and the default network 9905824d651Sblueswir1deconfigure script is @file{/etc/qemu-ifdown}. Use @option{script=no} 9915824d651Sblueswir1or @option{downscript=no} to disable script execution. Example: 9925824d651Sblueswir1 9935824d651Sblueswir1@example 9945824d651Sblueswir1qemu linux.img -net nic -net tap 9955824d651Sblueswir1@end example 9965824d651Sblueswir1 9975824d651Sblueswir1More complicated example (two NICs, each one connected to a TAP device) 9985824d651Sblueswir1@example 9995824d651Sblueswir1qemu linux.img -net nic,vlan=0 -net tap,vlan=0,ifname=tap0 \ 10005824d651Sblueswir1 -net nic,vlan=1 -net tap,vlan=1,ifname=tap1 10015824d651Sblueswir1@end example 10025824d651Sblueswir1 10035824d651Sblueswir1@item -net socket[,vlan=@var{n}][,name=@var{name}][,fd=@var{h}][,listen=[@var{host}]:@var{port}][,connect=@var{host}:@var{port}] 10045824d651Sblueswir1 10055824d651Sblueswir1Connect the VLAN @var{n} to a remote VLAN in another QEMU virtual 10065824d651Sblueswir1machine using a TCP socket connection. If @option{listen} is 10075824d651Sblueswir1specified, QEMU waits for incoming connections on @var{port} 10085824d651Sblueswir1(@var{host} is optional). @option{connect} is used to connect to 10095824d651Sblueswir1another QEMU instance using the @option{listen} option. @option{fd}=@var{h} 10105824d651Sblueswir1specifies an already opened TCP socket. 10115824d651Sblueswir1 10125824d651Sblueswir1Example: 10135824d651Sblueswir1@example 10145824d651Sblueswir1# launch a first QEMU instance 10155824d651Sblueswir1qemu linux.img -net nic,macaddr=52:54:00:12:34:56 \ 10165824d651Sblueswir1 -net socket,listen=:1234 10175824d651Sblueswir1# connect the VLAN 0 of this instance to the VLAN 0 10185824d651Sblueswir1# of the first instance 10195824d651Sblueswir1qemu linux.img -net nic,macaddr=52:54:00:12:34:57 \ 10205824d651Sblueswir1 -net socket,connect=127.0.0.1:1234 10215824d651Sblueswir1@end example 10225824d651Sblueswir1 10235824d651Sblueswir1@item -net socket[,vlan=@var{n}][,name=@var{name}][,fd=@var{h}][,mcast=@var{maddr}:@var{port}] 10245824d651Sblueswir1 10255824d651Sblueswir1Create a VLAN @var{n} shared with another QEMU virtual 10265824d651Sblueswir1machines using a UDP multicast socket, effectively making a bus for 10275824d651Sblueswir1every QEMU with same multicast address @var{maddr} and @var{port}. 10285824d651Sblueswir1NOTES: 10295824d651Sblueswir1@enumerate 10305824d651Sblueswir1@item 10315824d651Sblueswir1Several QEMU can be running on different hosts and share same bus (assuming 10325824d651Sblueswir1correct multicast setup for these hosts). 10335824d651Sblueswir1@item 10345824d651Sblueswir1mcast support is compatible with User Mode Linux (argument @option{eth@var{N}=mcast}), see 10355824d651Sblueswir1@url{http://user-mode-linux.sf.net}. 10365824d651Sblueswir1@item 10375824d651Sblueswir1Use @option{fd=h} to specify an already opened UDP multicast socket. 10385824d651Sblueswir1@end enumerate 10395824d651Sblueswir1 10405824d651Sblueswir1Example: 10415824d651Sblueswir1@example 10425824d651Sblueswir1# launch one QEMU instance 10435824d651Sblueswir1qemu linux.img -net nic,macaddr=52:54:00:12:34:56 \ 10445824d651Sblueswir1 -net socket,mcast=230.0.0.1:1234 10455824d651Sblueswir1# launch another QEMU instance on same "bus" 10465824d651Sblueswir1qemu linux.img -net nic,macaddr=52:54:00:12:34:57 \ 10475824d651Sblueswir1 -net socket,mcast=230.0.0.1:1234 10485824d651Sblueswir1# launch yet another QEMU instance on same "bus" 10495824d651Sblueswir1qemu linux.img -net nic,macaddr=52:54:00:12:34:58 \ 10505824d651Sblueswir1 -net socket,mcast=230.0.0.1:1234 10515824d651Sblueswir1@end example 10525824d651Sblueswir1 10535824d651Sblueswir1Example (User Mode Linux compat.): 10545824d651Sblueswir1@example 10555824d651Sblueswir1# launch QEMU instance (note mcast address selected 10565824d651Sblueswir1# is UML's default) 10575824d651Sblueswir1qemu linux.img -net nic,macaddr=52:54:00:12:34:56 \ 10585824d651Sblueswir1 -net socket,mcast=239.192.168.1:1102 10595824d651Sblueswir1# launch UML 10605824d651Sblueswir1/path/to/linux ubd0=/path/to/root_fs eth0=mcast 10615824d651Sblueswir1@end example 10625824d651Sblueswir1 10635824d651Sblueswir1@item -net vde[,vlan=@var{n}][,name=@var{name}][,sock=@var{socketpath}][,port=@var{n}][,group=@var{groupname}][,mode=@var{octalmode}] 10645824d651Sblueswir1Connect VLAN @var{n} to PORT @var{n} of a vde switch running on host and 10655824d651Sblueswir1listening for incoming connections on @var{socketpath}. Use GROUP @var{groupname} 10665824d651Sblueswir1and MODE @var{octalmode} to change default ownership and permissions for 10675824d651Sblueswir1communication port. This option is available only if QEMU has been compiled 10685824d651Sblueswir1with vde support enabled. 10695824d651Sblueswir1 10705824d651Sblueswir1Example: 10715824d651Sblueswir1@example 10725824d651Sblueswir1# launch vde switch 10735824d651Sblueswir1vde_switch -F -sock /tmp/myswitch 10745824d651Sblueswir1# launch QEMU instance 10755824d651Sblueswir1qemu linux.img -net nic -net vde,sock=/tmp/myswitch 10765824d651Sblueswir1@end example 10775824d651Sblueswir1 1078bb9ea79eSaliguori@item -net dump[,vlan=@var{n}][,file=@var{file}][,len=@var{len}] 1079bb9ea79eSaliguoriDump network traffic on VLAN @var{n} to file @var{file} (@file{qemu-vlan0.pcap} by default). 1080bb9ea79eSaliguoriAt most @var{len} bytes (64k by default) per packet are stored. The file format is 1081bb9ea79eSaliguorilibpcap, so it can be analyzed with tools such as tcpdump or Wireshark. 1082bb9ea79eSaliguori 10835824d651Sblueswir1@item -net none 10845824d651Sblueswir1Indicate that no network devices should be configured. It is used to 10855824d651Sblueswir1override the default configuration (@option{-net nic -net user}) which 10865824d651Sblueswir1is activated if no @option{-net} options are provided. 10875824d651Sblueswir1 10885824d651Sblueswir1@end table 10895824d651Sblueswir1ETEXI 10905824d651Sblueswir1 10915824d651Sblueswir1DEF("bt", HAS_ARG, QEMU_OPTION_bt, \ 10925824d651Sblueswir1 "\n" \ 10935824d651Sblueswir1 "-bt hci,null dumb bluetooth HCI - doesn't respond to commands\n" \ 10945824d651Sblueswir1 "-bt hci,host[:id]\n" \ 10955824d651Sblueswir1 " use host's HCI with the given name\n" \ 10965824d651Sblueswir1 "-bt hci[,vlan=n]\n" \ 10975824d651Sblueswir1 " emulate a standard HCI in virtual scatternet 'n'\n" \ 10985824d651Sblueswir1 "-bt vhci[,vlan=n]\n" \ 10995824d651Sblueswir1 " add host computer to virtual scatternet 'n' using VHCI\n" \ 11005824d651Sblueswir1 "-bt device:dev[,vlan=n]\n" \ 11015824d651Sblueswir1 " emulate a bluetooth device 'dev' in scatternet 'n'\n") 11025824d651Sblueswir1STEXI 11035824d651Sblueswir1Bluetooth(R) options: 11045824d651Sblueswir1@table @option 11055824d651Sblueswir1 11065824d651Sblueswir1@item -bt hci[...] 11075824d651Sblueswir1Defines the function of the corresponding Bluetooth HCI. -bt options 11085824d651Sblueswir1are matched with the HCIs present in the chosen machine type. For 11095824d651Sblueswir1example when emulating a machine with only one HCI built into it, only 11105824d651Sblueswir1the first @code{-bt hci[...]} option is valid and defines the HCI's 11115824d651Sblueswir1logic. The Transport Layer is decided by the machine type. Currently 11125824d651Sblueswir1the machines @code{n800} and @code{n810} have one HCI and all other 11135824d651Sblueswir1machines have none. 11145824d651Sblueswir1 11155824d651Sblueswir1@anchor{bt-hcis} 11165824d651Sblueswir1The following three types are recognized: 11175824d651Sblueswir1 11185824d651Sblueswir1@table @code 11195824d651Sblueswir1@item -bt hci,null 11205824d651Sblueswir1(default) The corresponding Bluetooth HCI assumes no internal logic 11215824d651Sblueswir1and will not respond to any HCI commands or emit events. 11225824d651Sblueswir1 11235824d651Sblueswir1@item -bt hci,host[:@var{id}] 11245824d651Sblueswir1(@code{bluez} only) The corresponding HCI passes commands / events 11255824d651Sblueswir1to / from the physical HCI identified by the name @var{id} (default: 11265824d651Sblueswir1@code{hci0}) on the computer running QEMU. Only available on @code{bluez} 11275824d651Sblueswir1capable systems like Linux. 11285824d651Sblueswir1 11295824d651Sblueswir1@item -bt hci[,vlan=@var{n}] 11305824d651Sblueswir1Add a virtual, standard HCI that will participate in the Bluetooth 11315824d651Sblueswir1scatternet @var{n} (default @code{0}). Similarly to @option{-net} 11325824d651Sblueswir1VLANs, devices inside a bluetooth network @var{n} can only communicate 11335824d651Sblueswir1with other devices in the same network (scatternet). 11345824d651Sblueswir1@end table 11355824d651Sblueswir1 11365824d651Sblueswir1@item -bt vhci[,vlan=@var{n}] 11375824d651Sblueswir1(Linux-host only) Create a HCI in scatternet @var{n} (default 0) attached 11385824d651Sblueswir1to the host bluetooth stack instead of to the emulated target. This 11395824d651Sblueswir1allows the host and target machines to participate in a common scatternet 11405824d651Sblueswir1and communicate. Requires the Linux @code{vhci} driver installed. Can 11415824d651Sblueswir1be used as following: 11425824d651Sblueswir1 11435824d651Sblueswir1@example 11445824d651Sblueswir1qemu [...OPTIONS...] -bt hci,vlan=5 -bt vhci,vlan=5 11455824d651Sblueswir1@end example 11465824d651Sblueswir1 11475824d651Sblueswir1@item -bt device:@var{dev}[,vlan=@var{n}] 11485824d651Sblueswir1Emulate a bluetooth device @var{dev} and place it in network @var{n} 11495824d651Sblueswir1(default @code{0}). QEMU can only emulate one type of bluetooth devices 11505824d651Sblueswir1currently: 11515824d651Sblueswir1 11525824d651Sblueswir1@table @code 11535824d651Sblueswir1@item keyboard 11545824d651Sblueswir1Virtual wireless keyboard implementing the HIDP bluetooth profile. 11555824d651Sblueswir1@end table 11565824d651Sblueswir1@end table 11575824d651Sblueswir1ETEXI 11585824d651Sblueswir1 11595824d651Sblueswir1DEFHEADING() 11605824d651Sblueswir1 11617677f05dSAlexander GrafDEFHEADING(Linux/Multiboot boot specific:) 11625824d651Sblueswir1STEXI 11637677f05dSAlexander Graf 11647677f05dSAlexander GrafWhen using these options, you can use a given Linux or Multiboot 11657677f05dSAlexander Grafkernel without installing it in the disk image. It can be useful 11665824d651Sblueswir1for easier testing of various kernels. 11675824d651Sblueswir1 11685824d651Sblueswir1@table @option 11695824d651Sblueswir1ETEXI 11705824d651Sblueswir1 11715824d651Sblueswir1DEF("kernel", HAS_ARG, QEMU_OPTION_kernel, \ 11725824d651Sblueswir1 "-kernel bzImage use 'bzImage' as kernel image\n") 11735824d651Sblueswir1STEXI 11745824d651Sblueswir1@item -kernel @var{bzImage} 11757677f05dSAlexander GrafUse @var{bzImage} as kernel image. The kernel can be either a Linux kernel 11767677f05dSAlexander Grafor in multiboot format. 11775824d651Sblueswir1ETEXI 11785824d651Sblueswir1 11795824d651Sblueswir1DEF("append", HAS_ARG, QEMU_OPTION_append, \ 11805824d651Sblueswir1 "-append cmdline use 'cmdline' as kernel command line\n") 11815824d651Sblueswir1STEXI 11825824d651Sblueswir1@item -append @var{cmdline} 11835824d651Sblueswir1Use @var{cmdline} as kernel command line 11845824d651Sblueswir1ETEXI 11855824d651Sblueswir1 11865824d651Sblueswir1DEF("initrd", HAS_ARG, QEMU_OPTION_initrd, \ 11875824d651Sblueswir1 "-initrd file use 'file' as initial ram disk\n") 11885824d651Sblueswir1STEXI 11895824d651Sblueswir1@item -initrd @var{file} 11905824d651Sblueswir1Use @var{file} as initial ram disk. 11917677f05dSAlexander Graf 11927677f05dSAlexander Graf@item -initrd "@var{file1} arg=foo,@var{file2}" 11937677f05dSAlexander Graf 11947677f05dSAlexander GrafThis syntax is only available with multiboot. 11957677f05dSAlexander Graf 11967677f05dSAlexander GrafUse @var{file1} and @var{file2} as modules and pass arg=foo as parameter to the 11977677f05dSAlexander Graffirst module. 11985824d651Sblueswir1ETEXI 11995824d651Sblueswir1 12005824d651Sblueswir1STEXI 12015824d651Sblueswir1@end table 12025824d651Sblueswir1ETEXI 12035824d651Sblueswir1 12045824d651Sblueswir1DEFHEADING() 12055824d651Sblueswir1 12065824d651Sblueswir1DEFHEADING(Debug/Expert options:) 12075824d651Sblueswir1 12085824d651Sblueswir1STEXI 12095824d651Sblueswir1@table @option 12105824d651Sblueswir1ETEXI 12115824d651Sblueswir1 1212191bc01bSGerd HoffmannDEF("chardev", HAS_ARG, QEMU_OPTION_chardev, \ 1213191bc01bSGerd Hoffmann "-chardev spec create unconnected chardev\n") 12145824d651Sblueswir1DEF("serial", HAS_ARG, QEMU_OPTION_serial, \ 12155824d651Sblueswir1 "-serial dev redirect the serial port to char device 'dev'\n") 12165824d651Sblueswir1STEXI 12175824d651Sblueswir1@item -serial @var{dev} 12185824d651Sblueswir1Redirect the virtual serial port to host character device 12195824d651Sblueswir1@var{dev}. The default device is @code{vc} in graphical mode and 12205824d651Sblueswir1@code{stdio} in non graphical mode. 12215824d651Sblueswir1 12225824d651Sblueswir1This option can be used several times to simulate up to 4 serial 12235824d651Sblueswir1ports. 12245824d651Sblueswir1 12255824d651Sblueswir1Use @code{-serial none} to disable all serial ports. 12265824d651Sblueswir1 12275824d651Sblueswir1Available character devices are: 12285824d651Sblueswir1@table @code 12295824d651Sblueswir1@item vc[:WxH] 12305824d651Sblueswir1Virtual console. Optionally, a width and height can be given in pixel with 12315824d651Sblueswir1@example 12325824d651Sblueswir1vc:800x600 12335824d651Sblueswir1@end example 12345824d651Sblueswir1It is also possible to specify width or height in characters: 12355824d651Sblueswir1@example 12365824d651Sblueswir1vc:80Cx24C 12375824d651Sblueswir1@end example 12385824d651Sblueswir1@item pty 12395824d651Sblueswir1[Linux only] Pseudo TTY (a new PTY is automatically allocated) 12405824d651Sblueswir1@item none 12415824d651Sblueswir1No device is allocated. 12425824d651Sblueswir1@item null 12435824d651Sblueswir1void device 12445824d651Sblueswir1@item /dev/XXX 12455824d651Sblueswir1[Linux only] Use host tty, e.g. @file{/dev/ttyS0}. The host serial port 12465824d651Sblueswir1parameters are set according to the emulated ones. 12475824d651Sblueswir1@item /dev/parport@var{N} 12485824d651Sblueswir1[Linux only, parallel port only] Use host parallel port 12495824d651Sblueswir1@var{N}. Currently SPP and EPP parallel port features can be used. 12505824d651Sblueswir1@item file:@var{filename} 12515824d651Sblueswir1Write output to @var{filename}. No character can be read. 12525824d651Sblueswir1@item stdio 12535824d651Sblueswir1[Unix only] standard input/output 12545824d651Sblueswir1@item pipe:@var{filename} 12555824d651Sblueswir1name pipe @var{filename} 12565824d651Sblueswir1@item COM@var{n} 12575824d651Sblueswir1[Windows only] Use host serial port @var{n} 12585824d651Sblueswir1@item udp:[@var{remote_host}]:@var{remote_port}[@@[@var{src_ip}]:@var{src_port}] 12595824d651Sblueswir1This implements UDP Net Console. 12605824d651Sblueswir1When @var{remote_host} or @var{src_ip} are not specified 12615824d651Sblueswir1they default to @code{0.0.0.0}. 12625824d651Sblueswir1When not using a specified @var{src_port} a random port is automatically chosen. 12635824d651Sblueswir1@item msmouse 12645824d651Sblueswir1Three button serial mouse. Configure the guest to use Microsoft protocol. 12655824d651Sblueswir1 12665824d651Sblueswir1If you just want a simple readonly console you can use @code{netcat} or 12675824d651Sblueswir1@code{nc}, by starting qemu with: @code{-serial udp::4555} and nc as: 12685824d651Sblueswir1@code{nc -u -l -p 4555}. Any time qemu writes something to that port it 12695824d651Sblueswir1will appear in the netconsole session. 12705824d651Sblueswir1 12715824d651Sblueswir1If you plan to send characters back via netconsole or you want to stop 12725824d651Sblueswir1and start qemu a lot of times, you should have qemu use the same 12735824d651Sblueswir1source port each time by using something like @code{-serial 12745824d651Sblueswir1udp::4555@@:4556} to qemu. Another approach is to use a patched 12755824d651Sblueswir1version of netcat which can listen to a TCP port and send and receive 12765824d651Sblueswir1characters via udp. If you have a patched version of netcat which 12775824d651Sblueswir1activates telnet remote echo and single char transfer, then you can 12785824d651Sblueswir1use the following options to step up a netcat redirector to allow 12795824d651Sblueswir1telnet on port 5555 to access the qemu port. 12805824d651Sblueswir1@table @code 12815824d651Sblueswir1@item Qemu Options: 12825824d651Sblueswir1-serial udp::4555@@:4556 12835824d651Sblueswir1@item netcat options: 12845824d651Sblueswir1-u -P 4555 -L 0.0.0.0:4556 -t -p 5555 -I -T 12855824d651Sblueswir1@item telnet options: 12865824d651Sblueswir1localhost 5555 12875824d651Sblueswir1@end table 12885824d651Sblueswir1 12895824d651Sblueswir1@item tcp:[@var{host}]:@var{port}[,@var{server}][,nowait][,nodelay] 12905824d651Sblueswir1The TCP Net Console has two modes of operation. It can send the serial 12915824d651Sblueswir1I/O to a location or wait for a connection from a location. By default 12925824d651Sblueswir1the TCP Net Console is sent to @var{host} at the @var{port}. If you use 12935824d651Sblueswir1the @var{server} option QEMU will wait for a client socket application 12945824d651Sblueswir1to connect to the port before continuing, unless the @code{nowait} 12955824d651Sblueswir1option was specified. The @code{nodelay} option disables the Nagle buffering 12965824d651Sblueswir1algorithm. If @var{host} is omitted, 0.0.0.0 is assumed. Only 12975824d651Sblueswir1one TCP connection at a time is accepted. You can use @code{telnet} to 12985824d651Sblueswir1connect to the corresponding character device. 12995824d651Sblueswir1@table @code 13005824d651Sblueswir1@item Example to send tcp console to 192.168.0.2 port 4444 13015824d651Sblueswir1-serial tcp:192.168.0.2:4444 13025824d651Sblueswir1@item Example to listen and wait on port 4444 for connection 13035824d651Sblueswir1-serial tcp::4444,server 13045824d651Sblueswir1@item Example to not wait and listen on ip 192.168.0.100 port 4444 13055824d651Sblueswir1-serial tcp:192.168.0.100:4444,server,nowait 13065824d651Sblueswir1@end table 13075824d651Sblueswir1 13085824d651Sblueswir1@item telnet:@var{host}:@var{port}[,server][,nowait][,nodelay] 13095824d651Sblueswir1The telnet protocol is used instead of raw tcp sockets. The options 13105824d651Sblueswir1work the same as if you had specified @code{-serial tcp}. The 13115824d651Sblueswir1difference is that the port acts like a telnet server or client using 13125824d651Sblueswir1telnet option negotiation. This will also allow you to send the 13135824d651Sblueswir1MAGIC_SYSRQ sequence if you use a telnet that supports sending the break 13145824d651Sblueswir1sequence. Typically in unix telnet you do it with Control-] and then 13155824d651Sblueswir1type "send break" followed by pressing the enter key. 13165824d651Sblueswir1 13175824d651Sblueswir1@item unix:@var{path}[,server][,nowait] 13185824d651Sblueswir1A unix domain socket is used instead of a tcp socket. The option works the 13195824d651Sblueswir1same as if you had specified @code{-serial tcp} except the unix domain socket 13205824d651Sblueswir1@var{path} is used for connections. 13215824d651Sblueswir1 13225824d651Sblueswir1@item mon:@var{dev_string} 13235824d651Sblueswir1This is a special option to allow the monitor to be multiplexed onto 13245824d651Sblueswir1another serial port. The monitor is accessed with key sequence of 13255824d651Sblueswir1@key{Control-a} and then pressing @key{c}. See monitor access 13265824d651Sblueswir1@ref{pcsys_keys} in the -nographic section for more keys. 13275824d651Sblueswir1@var{dev_string} should be any one of the serial devices specified 13285824d651Sblueswir1above. An example to multiplex the monitor onto a telnet server 13295824d651Sblueswir1listening on port 4444 would be: 13305824d651Sblueswir1@table @code 13315824d651Sblueswir1@item -serial mon:telnet::4444,server,nowait 13325824d651Sblueswir1@end table 13335824d651Sblueswir1 13345824d651Sblueswir1@item braille 13355824d651Sblueswir1Braille device. This will use BrlAPI to display the braille output on a real 13365824d651Sblueswir1or fake device. 13375824d651Sblueswir1 13385824d651Sblueswir1@end table 13395824d651Sblueswir1ETEXI 13405824d651Sblueswir1 13415824d651Sblueswir1DEF("parallel", HAS_ARG, QEMU_OPTION_parallel, \ 13425824d651Sblueswir1 "-parallel dev redirect the parallel port to char device 'dev'\n") 13435824d651Sblueswir1STEXI 13445824d651Sblueswir1@item -parallel @var{dev} 13455824d651Sblueswir1Redirect the virtual parallel port to host device @var{dev} (same 13465824d651Sblueswir1devices as the serial port). On Linux hosts, @file{/dev/parportN} can 13475824d651Sblueswir1be used to use hardware devices connected on the corresponding host 13485824d651Sblueswir1parallel port. 13495824d651Sblueswir1 13505824d651Sblueswir1This option can be used several times to simulate up to 3 parallel 13515824d651Sblueswir1ports. 13525824d651Sblueswir1 13535824d651Sblueswir1Use @code{-parallel none} to disable all parallel ports. 13545824d651Sblueswir1ETEXI 13555824d651Sblueswir1 13565824d651Sblueswir1DEF("monitor", HAS_ARG, QEMU_OPTION_monitor, \ 13575824d651Sblueswir1 "-monitor dev redirect the monitor to char device 'dev'\n") 13585824d651Sblueswir1STEXI 13595824d651Sblueswir1@item -monitor @var{dev} 13605824d651Sblueswir1Redirect the monitor to host device @var{dev} (same devices as the 13615824d651Sblueswir1serial port). 13625824d651Sblueswir1The default device is @code{vc} in graphical mode and @code{stdio} in 13635824d651Sblueswir1non graphical mode. 13645824d651Sblueswir1ETEXI 13655824d651Sblueswir1 13665824d651Sblueswir1DEF("pidfile", HAS_ARG, QEMU_OPTION_pidfile, \ 13675824d651Sblueswir1 "-pidfile file write PID to 'file'\n") 13685824d651Sblueswir1STEXI 13695824d651Sblueswir1@item -pidfile @var{file} 13705824d651Sblueswir1Store the QEMU process PID in @var{file}. It is useful if you launch QEMU 13715824d651Sblueswir1from a script. 13725824d651Sblueswir1ETEXI 13735824d651Sblueswir1 13741b530a6dSaurel32DEF("singlestep", 0, QEMU_OPTION_singlestep, \ 13751b530a6dSaurel32 "-singlestep always run in singlestep mode\n") 13761b530a6dSaurel32STEXI 13771b530a6dSaurel32@item -singlestep 13781b530a6dSaurel32Run the emulation in single step mode. 13791b530a6dSaurel32ETEXI 13801b530a6dSaurel32 13815824d651Sblueswir1DEF("S", 0, QEMU_OPTION_S, \ 13825824d651Sblueswir1 "-S freeze CPU at startup (use 'c' to start execution)\n") 13835824d651Sblueswir1STEXI 13845824d651Sblueswir1@item -S 13855824d651Sblueswir1Do not start CPU at startup (you must type 'c' in the monitor). 13865824d651Sblueswir1ETEXI 13875824d651Sblueswir1 138859030a8cSaliguoriDEF("gdb", HAS_ARG, QEMU_OPTION_gdb, \ 138959030a8cSaliguori "-gdb dev wait for gdb connection on 'dev'\n") 13905824d651Sblueswir1STEXI 139159030a8cSaliguori@item -gdb @var{dev} 139259030a8cSaliguoriWait for gdb connection on device @var{dev} (@pxref{gdb_usage}). Typical 139359030a8cSaliguoriconnections will likely be TCP-based, but also UDP, pseudo TTY, or even 139459030a8cSaliguoristdio are reasonable use case. The latter is allowing to start qemu from 139559030a8cSaliguoriwithin gdb and establish the connection via a pipe: 139659030a8cSaliguori@example 139759030a8cSaliguori(gdb) target remote | exec qemu -gdb stdio ... 139859030a8cSaliguori@end example 13995824d651Sblueswir1ETEXI 14005824d651Sblueswir1 140159030a8cSaliguoriDEF("s", 0, QEMU_OPTION_s, \ 140259030a8cSaliguori "-s shorthand for -gdb tcp::%s\n") 14035824d651Sblueswir1STEXI 140459030a8cSaliguori@item -s 140559030a8cSaliguoriShorthand for -gdb tcp::1234, i.e. open a gdbserver on TCP port 1234 140659030a8cSaliguori(@pxref{gdb_usage}). 14075824d651Sblueswir1ETEXI 14085824d651Sblueswir1 14095824d651Sblueswir1DEF("d", HAS_ARG, QEMU_OPTION_d, \ 14105824d651Sblueswir1 "-d item1,... output log to %s (use -d ? for a list of log items)\n") 14115824d651Sblueswir1STEXI 14125824d651Sblueswir1@item -d 14135824d651Sblueswir1Output log in /tmp/qemu.log 14145824d651Sblueswir1ETEXI 14155824d651Sblueswir1 14165824d651Sblueswir1DEF("hdachs", HAS_ARG, QEMU_OPTION_hdachs, \ 14175824d651Sblueswir1 "-hdachs c,h,s[,t]\n" \ 14185824d651Sblueswir1 " force hard disk 0 physical geometry and the optional BIOS\n" \ 14195824d651Sblueswir1 " translation (t=none or lba) (usually qemu can guess them)\n") 14205824d651Sblueswir1STEXI 14215824d651Sblueswir1@item -hdachs @var{c},@var{h},@var{s},[,@var{t}] 14225824d651Sblueswir1Force hard disk 0 physical geometry (1 <= @var{c} <= 16383, 1 <= 14235824d651Sblueswir1@var{h} <= 16, 1 <= @var{s} <= 63) and optionally force the BIOS 14245824d651Sblueswir1translation mode (@var{t}=none, lba or auto). Usually QEMU can guess 14255824d651Sblueswir1all those parameters. This option is useful for old MS-DOS disk 14265824d651Sblueswir1images. 14275824d651Sblueswir1ETEXI 14285824d651Sblueswir1 14295824d651Sblueswir1DEF("L", HAS_ARG, QEMU_OPTION_L, \ 14305824d651Sblueswir1 "-L path set the directory for the BIOS, VGA BIOS and keymaps\n") 14315824d651Sblueswir1STEXI 14325824d651Sblueswir1@item -L @var{path} 14335824d651Sblueswir1Set the directory for the BIOS, VGA BIOS and keymaps. 14345824d651Sblueswir1ETEXI 14355824d651Sblueswir1 14365824d651Sblueswir1DEF("bios", HAS_ARG, QEMU_OPTION_bios, \ 14375824d651Sblueswir1 "-bios file set the filename for the BIOS\n") 14385824d651Sblueswir1STEXI 14395824d651Sblueswir1@item -bios @var{file} 14405824d651Sblueswir1Set the filename for the BIOS. 14415824d651Sblueswir1ETEXI 14425824d651Sblueswir1 14435824d651Sblueswir1#ifdef CONFIG_KVM 14445824d651Sblueswir1DEF("enable-kvm", 0, QEMU_OPTION_enable_kvm, \ 14455824d651Sblueswir1 "-enable-kvm enable KVM full virtualization support\n") 14465824d651Sblueswir1#endif 14475824d651Sblueswir1STEXI 14485824d651Sblueswir1@item -enable-kvm 14495824d651Sblueswir1Enable KVM full virtualization support. This option is only available 14505824d651Sblueswir1if KVM support is enabled when compiling. 14515824d651Sblueswir1ETEXI 14525824d651Sblueswir1 1453e37630caSaliguori#ifdef CONFIG_XEN 1454e37630caSaliguoriDEF("xen-domid", HAS_ARG, QEMU_OPTION_xen_domid, 1455e37630caSaliguori "-xen-domid id specify xen guest domain id\n") 1456e37630caSaliguoriDEF("xen-create", 0, QEMU_OPTION_xen_create, 1457e37630caSaliguori "-xen-create create domain using xen hypercalls, bypassing xend\n" 1458e37630caSaliguori " warning: should not be used when xend is in use\n") 1459e37630caSaliguoriDEF("xen-attach", 0, QEMU_OPTION_xen_attach, 1460e37630caSaliguori "-xen-attach attach to existing xen domain\n" 1461e37630caSaliguori " xend will use this when starting qemu\n") 1462e37630caSaliguori#endif 1463e37630caSaliguori 14645824d651Sblueswir1DEF("no-reboot", 0, QEMU_OPTION_no_reboot, \ 14655824d651Sblueswir1 "-no-reboot exit instead of rebooting\n") 14665824d651Sblueswir1STEXI 14675824d651Sblueswir1@item -no-reboot 14685824d651Sblueswir1Exit instead of rebooting. 14695824d651Sblueswir1ETEXI 14705824d651Sblueswir1 14715824d651Sblueswir1DEF("no-shutdown", 0, QEMU_OPTION_no_shutdown, \ 14725824d651Sblueswir1 "-no-shutdown stop before shutdown\n") 14735824d651Sblueswir1STEXI 14745824d651Sblueswir1@item -no-shutdown 14755824d651Sblueswir1Don't exit QEMU on guest shutdown, but instead only stop the emulation. 14765824d651Sblueswir1This allows for instance switching to monitor to commit changes to the 14775824d651Sblueswir1disk image. 14785824d651Sblueswir1ETEXI 14795824d651Sblueswir1 14805824d651Sblueswir1DEF("loadvm", HAS_ARG, QEMU_OPTION_loadvm, \ 14815824d651Sblueswir1 "-loadvm [tag|id]\n" \ 14825824d651Sblueswir1 " start right away with a saved state (loadvm in monitor)\n") 14835824d651Sblueswir1STEXI 14845824d651Sblueswir1@item -loadvm @var{file} 14855824d651Sblueswir1Start right away with a saved state (@code{loadvm} in monitor) 14865824d651Sblueswir1ETEXI 14875824d651Sblueswir1 14885824d651Sblueswir1#ifndef _WIN32 14895824d651Sblueswir1DEF("daemonize", 0, QEMU_OPTION_daemonize, \ 14905824d651Sblueswir1 "-daemonize daemonize QEMU after initializing\n") 14915824d651Sblueswir1#endif 14925824d651Sblueswir1STEXI 14935824d651Sblueswir1@item -daemonize 14945824d651Sblueswir1Daemonize the QEMU process after initialization. QEMU will not detach from 14955824d651Sblueswir1standard IO until it is ready to receive connections on any of its devices. 14965824d651Sblueswir1This option is a useful way for external programs to launch QEMU without having 14975824d651Sblueswir1to cope with initialization race conditions. 14985824d651Sblueswir1ETEXI 14995824d651Sblueswir1 15005824d651Sblueswir1DEF("option-rom", HAS_ARG, QEMU_OPTION_option_rom, \ 15015824d651Sblueswir1 "-option-rom rom load a file, rom, into the option ROM space\n") 15025824d651Sblueswir1STEXI 15035824d651Sblueswir1@item -option-rom @var{file} 15045824d651Sblueswir1Load the contents of @var{file} as an option ROM. 15055824d651Sblueswir1This option is useful to load things like EtherBoot. 15065824d651Sblueswir1ETEXI 15075824d651Sblueswir1 15085824d651Sblueswir1DEF("clock", HAS_ARG, QEMU_OPTION_clock, \ 15095824d651Sblueswir1 "-clock force the use of the given methods for timer alarm.\n" \ 15105824d651Sblueswir1 " To see what timers are available use -clock ?\n") 15115824d651Sblueswir1STEXI 15125824d651Sblueswir1@item -clock @var{method} 15135824d651Sblueswir1Force the use of the given methods for timer alarm. To see what timers 15145824d651Sblueswir1are available use -clock ?. 15155824d651Sblueswir1ETEXI 15165824d651Sblueswir1 15171ed2fc1fSJan KiszkaHXCOMM Options deprecated by -rtc 15181ed2fc1fSJan KiszkaDEF("localtime", 0, QEMU_OPTION_localtime, "") 15191ed2fc1fSJan KiszkaDEF("startdate", HAS_ARG, QEMU_OPTION_startdate, "") 15205824d651Sblueswir1 15211ed2fc1fSJan Kiszka#ifdef TARGET_I386 15221ed2fc1fSJan KiszkaDEF("rtc", HAS_ARG, QEMU_OPTION_rtc, \ 15236875204cSJan Kiszka "-rtc [base=utc|localtime|date][,clock=host|vm][,driftfix=none|slew]\n" \ 15246875204cSJan Kiszka " set the RTC base and clock, enable drift fix for clock ticks\n") 15251ed2fc1fSJan Kiszka#else 15261ed2fc1fSJan KiszkaDEF("rtc", HAS_ARG, QEMU_OPTION_rtc, \ 15276875204cSJan Kiszka "-rtc [base=utc|localtime|date][,clock=host|vm]\n" \ 15281ed2fc1fSJan Kiszka " set the RTC base and clock\n") 15291ed2fc1fSJan Kiszka#endif 15301ed2fc1fSJan Kiszka 15315824d651Sblueswir1STEXI 15325824d651Sblueswir1 15336875204cSJan Kiszka@item -rtc [base=utc|localtime|@var{date}][,clock=host|vm][,driftfix=none|slew] 15341ed2fc1fSJan KiszkaSpecify @option{base} as @code{utc} or @code{localtime} to let the RTC start at the current 15351ed2fc1fSJan KiszkaUTC or local time, respectively. @code{localtime} is required for correct date in 15361ed2fc1fSJan KiszkaMS-DOS or Windows. To start at a specific point in time, provide @var{date} in the 15371ed2fc1fSJan Kiszkaformat @code{2006-06-17T16:01:21} or @code{2006-06-17}. The default base is UTC. 15381ed2fc1fSJan Kiszka 15396875204cSJan KiszkaBy default the RTC is driven by the host system time. This allows to use the 15406875204cSJan KiszkaRTC as accurate reference clock inside the guest, specifically if the host 15416875204cSJan Kiszkatime is smoothly following an accurate external reference clock, e.g. via NTP. 15426875204cSJan KiszkaIf you want to isolate the guest time from the host, even prevent it from 15436875204cSJan Kiszkaprogressing during suspension, you can set @option{clock} to @code{vm} instead. 15446875204cSJan Kiszka 15451ed2fc1fSJan KiszkaEnable @option{driftfix} (i386 targets only) if you experience time drift problems, 15461ed2fc1fSJan Kiszkaspecifically with Windows' ACPI HAL. This option will try to figure out how 15471ed2fc1fSJan Kiszkamany timer interrupts were not processed by the Windows guest and will 15481ed2fc1fSJan Kiszkare-inject them. 15495824d651Sblueswir1ETEXI 15505824d651Sblueswir1 15515824d651Sblueswir1DEF("icount", HAS_ARG, QEMU_OPTION_icount, \ 15525824d651Sblueswir1 "-icount [N|auto]\n" \ 1553bc14ca24Saliguori " enable virtual instruction counter with 2^N clock ticks per\n" \ 1554bc14ca24Saliguori " instruction\n") 15555824d651Sblueswir1STEXI 15565824d651Sblueswir1@item -icount [N|auto] 15575824d651Sblueswir1Enable virtual instruction counter. The virtual cpu will execute one 15585824d651Sblueswir1instruction every 2^N ns of virtual time. If @code{auto} is specified 15595824d651Sblueswir1then the virtual cpu speed will be automatically adjusted to keep virtual 15605824d651Sblueswir1time within a few seconds of real time. 15615824d651Sblueswir1 15625824d651Sblueswir1Note that while this option can give deterministic behavior, it does not 15635824d651Sblueswir1provide cycle accurate emulation. Modern CPUs contain superscalar out of 15645824d651Sblueswir1order cores with complex cache hierarchies. The number of instructions 15655824d651Sblueswir1executed often has little or no correlation with actual performance. 15665824d651Sblueswir1ETEXI 15675824d651Sblueswir1 15689dd986ccSRichard W.M. JonesDEF("watchdog", HAS_ARG, QEMU_OPTION_watchdog, \ 15699dd986ccSRichard W.M. Jones "-watchdog i6300esb|ib700\n" \ 15709dd986ccSRichard W.M. Jones " enable virtual hardware watchdog [default=none]\n") 15719dd986ccSRichard W.M. JonesSTEXI 15729dd986ccSRichard W.M. Jones@item -watchdog @var{model} 15739dd986ccSRichard W.M. JonesCreate a virtual hardware watchdog device. Once enabled (by a guest 15749dd986ccSRichard W.M. Jonesaction), the watchdog must be periodically polled by an agent inside 15759dd986ccSRichard W.M. Jonesthe guest or else the guest will be restarted. 15769dd986ccSRichard W.M. Jones 15779dd986ccSRichard W.M. JonesThe @var{model} is the model of hardware watchdog to emulate. Choices 15789dd986ccSRichard W.M. Jonesfor model are: @code{ib700} (iBASE 700) which is a very simple ISA 15799dd986ccSRichard W.M. Joneswatchdog with a single timer, or @code{i6300esb} (Intel 6300ESB I/O 15809dd986ccSRichard W.M. Jonescontroller hub) which is a much more featureful PCI-based dual-timer 15819dd986ccSRichard W.M. Joneswatchdog. Choose a model for which your guest has drivers. 15829dd986ccSRichard W.M. Jones 15839dd986ccSRichard W.M. JonesUse @code{-watchdog ?} to list available hardware models. Only one 15849dd986ccSRichard W.M. Joneswatchdog can be enabled for a guest. 15859dd986ccSRichard W.M. JonesETEXI 15869dd986ccSRichard W.M. Jones 15879dd986ccSRichard W.M. JonesDEF("watchdog-action", HAS_ARG, QEMU_OPTION_watchdog_action, \ 15889dd986ccSRichard W.M. Jones "-watchdog-action reset|shutdown|poweroff|pause|debug|none\n" \ 15899dd986ccSRichard W.M. Jones " action when watchdog fires [default=reset]\n") 15909dd986ccSRichard W.M. JonesSTEXI 15919dd986ccSRichard W.M. Jones@item -watchdog-action @var{action} 15929dd986ccSRichard W.M. Jones 15939dd986ccSRichard W.M. JonesThe @var{action} controls what QEMU will do when the watchdog timer 15949dd986ccSRichard W.M. Jonesexpires. 15959dd986ccSRichard W.M. JonesThe default is 15969dd986ccSRichard W.M. Jones@code{reset} (forcefully reset the guest). 15979dd986ccSRichard W.M. JonesOther possible actions are: 15989dd986ccSRichard W.M. Jones@code{shutdown} (attempt to gracefully shutdown the guest), 15999dd986ccSRichard W.M. Jones@code{poweroff} (forcefully poweroff the guest), 16009dd986ccSRichard W.M. Jones@code{pause} (pause the guest), 16019dd986ccSRichard W.M. Jones@code{debug} (print a debug message and continue), or 16029dd986ccSRichard W.M. Jones@code{none} (do nothing). 16039dd986ccSRichard W.M. Jones 16049dd986ccSRichard W.M. JonesNote that the @code{shutdown} action requires that the guest responds 16059dd986ccSRichard W.M. Jonesto ACPI signals, which it may not be able to do in the sort of 16069dd986ccSRichard W.M. Jonessituations where the watchdog would have expired, and thus 16079dd986ccSRichard W.M. Jones@code{-watchdog-action shutdown} is not recommended for production use. 16089dd986ccSRichard W.M. Jones 16099dd986ccSRichard W.M. JonesExamples: 16109dd986ccSRichard W.M. Jones 16119dd986ccSRichard W.M. Jones@table @code 16129dd986ccSRichard W.M. Jones@item -watchdog i6300esb -watchdog-action pause 16139dd986ccSRichard W.M. Jones@item -watchdog ib700 16149dd986ccSRichard W.M. Jones@end table 16159dd986ccSRichard W.M. JonesETEXI 16169dd986ccSRichard W.M. Jones 16175824d651Sblueswir1DEF("echr", HAS_ARG, QEMU_OPTION_echr, \ 16185824d651Sblueswir1 "-echr chr set terminal escape character instead of ctrl-a\n") 16195824d651Sblueswir1STEXI 16205824d651Sblueswir1 16215824d651Sblueswir1@item -echr numeric_ascii_value 16225824d651Sblueswir1Change the escape character used for switching to the monitor when using 16235824d651Sblueswir1monitor and serial sharing. The default is @code{0x01} when using the 16245824d651Sblueswir1@code{-nographic} option. @code{0x01} is equal to pressing 16255824d651Sblueswir1@code{Control-a}. You can select a different character from the ascii 16265824d651Sblueswir1control keys where 1 through 26 map to Control-a through Control-z. For 16275824d651Sblueswir1instance you could use the either of the following to change the escape 16285824d651Sblueswir1character to Control-t. 16295824d651Sblueswir1@table @code 16305824d651Sblueswir1@item -echr 0x14 16315824d651Sblueswir1@item -echr 20 16325824d651Sblueswir1@end table 16335824d651Sblueswir1ETEXI 16345824d651Sblueswir1 16355824d651Sblueswir1DEF("virtioconsole", HAS_ARG, QEMU_OPTION_virtiocon, \ 16365824d651Sblueswir1 "-virtioconsole c\n" \ 16375824d651Sblueswir1 " set virtio console\n") 16385824d651Sblueswir1STEXI 16395824d651Sblueswir1@item -virtioconsole @var{c} 16405824d651Sblueswir1Set virtio console. 16415824d651Sblueswir1ETEXI 16425824d651Sblueswir1 16435824d651Sblueswir1DEF("show-cursor", 0, QEMU_OPTION_show_cursor, \ 16445824d651Sblueswir1 "-show-cursor show cursor\n") 16455824d651Sblueswir1STEXI 16465824d651Sblueswir1ETEXI 16475824d651Sblueswir1 16485824d651Sblueswir1DEF("tb-size", HAS_ARG, QEMU_OPTION_tb_size, \ 16495824d651Sblueswir1 "-tb-size n set TB size\n") 16505824d651Sblueswir1STEXI 16515824d651Sblueswir1ETEXI 16525824d651Sblueswir1 16535824d651Sblueswir1DEF("incoming", HAS_ARG, QEMU_OPTION_incoming, \ 16545824d651Sblueswir1 "-incoming p prepare for incoming migration, listen on port p\n") 16555824d651Sblueswir1STEXI 16565824d651Sblueswir1ETEXI 16575824d651Sblueswir1 16585824d651Sblueswir1#ifndef _WIN32 16595824d651Sblueswir1DEF("chroot", HAS_ARG, QEMU_OPTION_chroot, \ 16605824d651Sblueswir1 "-chroot dir Chroot to dir just before starting the VM.\n") 16615824d651Sblueswir1#endif 16625824d651Sblueswir1STEXI 16635824d651Sblueswir1@item -chroot dir 16645824d651Sblueswir1Immediately before starting guest execution, chroot to the specified 16655824d651Sblueswir1directory. Especially useful in combination with -runas. 16665824d651Sblueswir1ETEXI 16675824d651Sblueswir1 16685824d651Sblueswir1#ifndef _WIN32 16695824d651Sblueswir1DEF("runas", HAS_ARG, QEMU_OPTION_runas, \ 16705824d651Sblueswir1 "-runas user Change to user id user just before starting the VM.\n") 16715824d651Sblueswir1#endif 16725824d651Sblueswir1STEXI 16735824d651Sblueswir1@item -runas user 16745824d651Sblueswir1Immediately before starting guest execution, drop root privileges, switching 16755824d651Sblueswir1to the specified user. 16765824d651Sblueswir1ETEXI 16775824d651Sblueswir1 16785824d651Sblueswir1STEXI 16795824d651Sblueswir1@end table 16805824d651Sblueswir1ETEXI 16815824d651Sblueswir1 16825824d651Sblueswir1#if defined(TARGET_SPARC) || defined(TARGET_PPC) 16835824d651Sblueswir1DEF("prom-env", HAS_ARG, QEMU_OPTION_prom_env, 16845824d651Sblueswir1 "-prom-env variable=value\n" 16855824d651Sblueswir1 " set OpenBIOS nvram variables\n") 16865824d651Sblueswir1#endif 16875824d651Sblueswir1#if defined(TARGET_ARM) || defined(TARGET_M68K) 16885824d651Sblueswir1DEF("semihosting", 0, QEMU_OPTION_semihosting, 16895824d651Sblueswir1 "-semihosting semihosting mode\n") 16905824d651Sblueswir1#endif 16915824d651Sblueswir1#if defined(TARGET_ARM) 16925824d651Sblueswir1DEF("old-param", 0, QEMU_OPTION_old_param, 16935824d651Sblueswir1 "-old-param old param mode\n") 16945824d651Sblueswir1#endif 1695