xref: /openbmc/qemu/qemu-options.hx (revision bb9ea79e)
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,
425824d651Sblueswir1    "-smp n          set the number of CPUs to 'n' [default=1]\n")
435824d651Sblueswir1STEXI
445824d651Sblueswir1@item -smp @var{n}
455824d651Sblueswir1Simulate an SMP system with @var{n} CPUs. On the PC target, up to 255
465824d651Sblueswir1CPUs are supported. On Sparc32 target, Linux limits the number of usable CPUs
475824d651Sblueswir1to 4.
485824d651Sblueswir1ETEXI
495824d651Sblueswir1
505824d651Sblueswir1DEF("fda", HAS_ARG, QEMU_OPTION_fda,
515824d651Sblueswir1    "-fda/-fdb file  use 'file' as floppy disk 0/1 image\n")
525824d651Sblueswir1DEF("fdb", HAS_ARG, QEMU_OPTION_fdb, "")
535824d651Sblueswir1STEXI
545824d651Sblueswir1@item -fda @var{file}
555824d651Sblueswir1@item -fdb @var{file}
565824d651Sblueswir1Use @var{file} as floppy disk 0/1 image (@pxref{disk_images}). You can
575824d651Sblueswir1use the host floppy by using @file{/dev/fd0} as filename (@pxref{host_drives}).
585824d651Sblueswir1ETEXI
595824d651Sblueswir1
605824d651Sblueswir1DEF("hda", HAS_ARG, QEMU_OPTION_hda,
615824d651Sblueswir1    "-hda/-hdb file  use 'file' as IDE hard disk 0/1 image\n")
625824d651Sblueswir1DEF("hdb", HAS_ARG, QEMU_OPTION_hdb, "")
635824d651Sblueswir1DEF("hdc", HAS_ARG, QEMU_OPTION_hdc,
645824d651Sblueswir1    "-hdc/-hdd file  use 'file' as IDE hard disk 2/3 image\n")
655824d651Sblueswir1DEF("hdd", HAS_ARG, QEMU_OPTION_hdd, "")
665824d651Sblueswir1STEXI
675824d651Sblueswir1@item -hda @var{file}
685824d651Sblueswir1@item -hdb @var{file}
695824d651Sblueswir1@item -hdc @var{file}
705824d651Sblueswir1@item -hdd @var{file}
715824d651Sblueswir1Use @var{file} as hard disk 0, 1, 2 or 3 image (@pxref{disk_images}).
725824d651Sblueswir1ETEXI
735824d651Sblueswir1
745824d651Sblueswir1DEF("cdrom", HAS_ARG, QEMU_OPTION_cdrom,
755824d651Sblueswir1    "-cdrom file     use 'file' as IDE cdrom image (cdrom is ide1 master)\n")
765824d651Sblueswir1STEXI
775824d651Sblueswir1@item -cdrom @var{file}
785824d651Sblueswir1Use @var{file} as CD-ROM image (you cannot use @option{-hdc} and
795824d651Sblueswir1@option{-cdrom} at the same time). You can use the host CD-ROM by
805824d651Sblueswir1using @file{/dev/cdrom} as filename (@pxref{host_drives}).
815824d651Sblueswir1ETEXI
825824d651Sblueswir1
835824d651Sblueswir1DEF("drive", HAS_ARG, QEMU_OPTION_drive,
845824d651Sblueswir1    "-drive [file=file][,if=type][,bus=n][,unit=m][,media=d][,index=i]\n"
855824d651Sblueswir1    "       [,cyls=c,heads=h,secs=s[,trans=t]][,snapshot=on|off]\n"
865824d651Sblueswir1    "       [,cache=writethrough|writeback|none][,format=f][,serial=s]\n"
875824d651Sblueswir1    "                use 'file' as a drive image\n")
885824d651Sblueswir1STEXI
895824d651Sblueswir1@item -drive @var{option}[,@var{option}[,@var{option}[,...]]]
905824d651Sblueswir1
915824d651Sblueswir1Define a new drive. Valid options are:
925824d651Sblueswir1
935824d651Sblueswir1@table @code
945824d651Sblueswir1@item file=@var{file}
955824d651Sblueswir1This option defines which disk image (@pxref{disk_images}) to use with
965824d651Sblueswir1this drive. If the filename contains comma, you must double it
975824d651Sblueswir1(for instance, "file=my,,file" to use file "my,file").
985824d651Sblueswir1@item if=@var{interface}
995824d651Sblueswir1This option defines on which type on interface the drive is connected.
1005824d651Sblueswir1Available types are: ide, scsi, sd, mtd, floppy, pflash, virtio.
1015824d651Sblueswir1@item bus=@var{bus},unit=@var{unit}
1025824d651Sblueswir1These options define where is connected the drive by defining the bus number and
1035824d651Sblueswir1the unit id.
1045824d651Sblueswir1@item index=@var{index}
1055824d651Sblueswir1This option defines where is connected the drive by using an index in the list
1065824d651Sblueswir1of available connectors of a given interface type.
1075824d651Sblueswir1@item media=@var{media}
1085824d651Sblueswir1This option defines the type of the media: disk or cdrom.
1095824d651Sblueswir1@item cyls=@var{c},heads=@var{h},secs=@var{s}[,trans=@var{t}]
1105824d651Sblueswir1These options have the same definition as they have in @option{-hdachs}.
1115824d651Sblueswir1@item snapshot=@var{snapshot}
1125824d651Sblueswir1@var{snapshot} is "on" or "off" and allows to enable snapshot for given drive (see @option{-snapshot}).
1135824d651Sblueswir1@item cache=@var{cache}
1145824d651Sblueswir1@var{cache} is "none", "writeback", or "writethrough" and controls how the host cache is used to access block data.
1155824d651Sblueswir1@item format=@var{format}
1165824d651Sblueswir1Specify which disk @var{format} will be used rather than detecting
1175824d651Sblueswir1the format.  Can be used to specifiy format=raw to avoid interpreting
1185824d651Sblueswir1an untrusted format header.
1195824d651Sblueswir1@item serial=@var{serial}
1205824d651Sblueswir1This option specifies the serial number to assign to the device.
1215824d651Sblueswir1@end table
1225824d651Sblueswir1
1235824d651Sblueswir1By default, writethrough caching is used for all block device.  This means that
1245824d651Sblueswir1the host page cache will be used to read and write data but write notification
1255824d651Sblueswir1will be sent to the guest only when the data has been reported as written by
1265824d651Sblueswir1the storage subsystem.
1275824d651Sblueswir1
1285824d651Sblueswir1Writeback caching will report data writes as completed as soon as the data is
1295824d651Sblueswir1present in the host page cache.  This is safe as long as you trust your host.
1305824d651Sblueswir1If your host crashes or loses power, then the guest may experience data
1315824d651Sblueswir1corruption.  When using the @option{-snapshot} option, writeback caching is
1325824d651Sblueswir1used by default.
1335824d651Sblueswir1
1345824d651Sblueswir1The host page can be avoided entirely with @option{cache=none}.  This will
1355824d651Sblueswir1attempt to do disk IO directly to the guests memory.  QEMU may still perform
1365824d651Sblueswir1an internal copy of the data.
1375824d651Sblueswir1
1385824d651Sblueswir1Some block drivers perform badly with @option{cache=writethrough}, most notably,
1395824d651Sblueswir1qcow2.  If performance is more important than correctness,
1405824d651Sblueswir1@option{cache=writeback} should be used with qcow2.  By default, if no explicit
1415824d651Sblueswir1caching is specified for a qcow2 disk image, @option{cache=writeback} will be
1425824d651Sblueswir1used.  For all other disk types, @option{cache=writethrough} is the default.
1435824d651Sblueswir1
1445824d651Sblueswir1Instead of @option{-cdrom} you can use:
1455824d651Sblueswir1@example
1465824d651Sblueswir1qemu -drive file=file,index=2,media=cdrom
1475824d651Sblueswir1@end example
1485824d651Sblueswir1
1495824d651Sblueswir1Instead of @option{-hda}, @option{-hdb}, @option{-hdc}, @option{-hdd}, you can
1505824d651Sblueswir1use:
1515824d651Sblueswir1@example
1525824d651Sblueswir1qemu -drive file=file,index=0,media=disk
1535824d651Sblueswir1qemu -drive file=file,index=1,media=disk
1545824d651Sblueswir1qemu -drive file=file,index=2,media=disk
1555824d651Sblueswir1qemu -drive file=file,index=3,media=disk
1565824d651Sblueswir1@end example
1575824d651Sblueswir1
1585824d651Sblueswir1You can connect a CDROM to the slave of ide0:
1595824d651Sblueswir1@example
1605824d651Sblueswir1qemu -drive file=file,if=ide,index=1,media=cdrom
1615824d651Sblueswir1@end example
1625824d651Sblueswir1
1635824d651Sblueswir1If you don't specify the "file=" argument, you define an empty drive:
1645824d651Sblueswir1@example
1655824d651Sblueswir1qemu -drive if=ide,index=1,media=cdrom
1665824d651Sblueswir1@end example
1675824d651Sblueswir1
1685824d651Sblueswir1You can connect a SCSI disk with unit ID 6 on the bus #0:
1695824d651Sblueswir1@example
1705824d651Sblueswir1qemu -drive file=file,if=scsi,bus=0,unit=6
1715824d651Sblueswir1@end example
1725824d651Sblueswir1
1735824d651Sblueswir1Instead of @option{-fda}, @option{-fdb}, you can use:
1745824d651Sblueswir1@example
1755824d651Sblueswir1qemu -drive file=file,index=0,if=floppy
1765824d651Sblueswir1qemu -drive file=file,index=1,if=floppy
1775824d651Sblueswir1@end example
1785824d651Sblueswir1
1795824d651Sblueswir1By default, @var{interface} is "ide" and @var{index} is automatically
1805824d651Sblueswir1incremented:
1815824d651Sblueswir1@example
1825824d651Sblueswir1qemu -drive file=a -drive file=b"
1835824d651Sblueswir1@end example
1845824d651Sblueswir1is interpreted like:
1855824d651Sblueswir1@example
1865824d651Sblueswir1qemu -hda a -hdb b
1875824d651Sblueswir1@end example
1885824d651Sblueswir1ETEXI
1895824d651Sblueswir1
1905824d651Sblueswir1DEF("mtdblock", HAS_ARG, QEMU_OPTION_mtdblock,
1915824d651Sblueswir1    "-mtdblock file  use 'file' as on-board Flash memory image\n")
1925824d651Sblueswir1STEXI
1935824d651Sblueswir1
1945824d651Sblueswir1@item -mtdblock file
1955824d651Sblueswir1Use 'file' as on-board Flash memory image.
1965824d651Sblueswir1ETEXI
1975824d651Sblueswir1
1985824d651Sblueswir1DEF("sd", HAS_ARG, QEMU_OPTION_sd,
1995824d651Sblueswir1    "-sd file        use 'file' as SecureDigital card image\n")
2005824d651Sblueswir1STEXI
2015824d651Sblueswir1@item -sd file
2025824d651Sblueswir1Use 'file' as SecureDigital card image.
2035824d651Sblueswir1ETEXI
2045824d651Sblueswir1
2055824d651Sblueswir1DEF("pflash", HAS_ARG, QEMU_OPTION_pflash,
2065824d651Sblueswir1    "-pflash file    use 'file' as a parallel flash image\n")
2075824d651Sblueswir1STEXI
2085824d651Sblueswir1@item -pflash file
2095824d651Sblueswir1Use 'file' as a parallel flash image.
2105824d651Sblueswir1ETEXI
2115824d651Sblueswir1
2125824d651Sblueswir1DEF("boot", HAS_ARG, QEMU_OPTION_boot,
2135824d651Sblueswir1    "-boot [a|c|d|n] boot on floppy (a), hard disk (c), CD-ROM (d), or network (n)\n")
2145824d651Sblueswir1STEXI
2155824d651Sblueswir1@item -boot [a|c|d|n]
2165824d651Sblueswir1Boot on floppy (a), hard disk (c), CD-ROM (d), or Etherboot (n). Hard disk boot
2175824d651Sblueswir1is the default.
2185824d651Sblueswir1ETEXI
2195824d651Sblueswir1
2205824d651Sblueswir1DEF("snapshot", 0, QEMU_OPTION_snapshot,
2215824d651Sblueswir1    "-snapshot       write to temporary files instead of disk image files\n")
2225824d651Sblueswir1STEXI
2235824d651Sblueswir1@item -snapshot
2245824d651Sblueswir1Write to temporary files instead of disk image files. In this case,
2255824d651Sblueswir1the raw disk image you use is not written back. You can however force
2265824d651Sblueswir1the write back by pressing @key{C-a s} (@pxref{disk_images}).
2275824d651Sblueswir1ETEXI
2285824d651Sblueswir1
2295824d651Sblueswir1DEF("m", HAS_ARG, QEMU_OPTION_m,
2305824d651Sblueswir1    "-m megs         set virtual RAM size to megs MB [default=%d]\n")
2315824d651Sblueswir1STEXI
2325824d651Sblueswir1@item -m @var{megs}
2335824d651Sblueswir1Set virtual RAM size to @var{megs} megabytes. Default is 128 MiB.  Optionally,
2345824d651Sblueswir1a suffix of ``M'' or ``G'' can be used to signify a value in megabytes or
2355824d651Sblueswir1gigabytes respectively.
2365824d651Sblueswir1ETEXI
2375824d651Sblueswir1
2385824d651Sblueswir1DEF("k", HAS_ARG, QEMU_OPTION_k,
2395c2f8d2dSblueswir1    "-k language     use keyboard layout (for example 'fr' for French)\n")
2405824d651Sblueswir1STEXI
2415824d651Sblueswir1@item -k @var{language}
2425824d651Sblueswir1
2435824d651Sblueswir1Use keyboard layout @var{language} (for example @code{fr} for
2445824d651Sblueswir1French). This option is only needed where it is not easy to get raw PC
2455824d651Sblueswir1keycodes (e.g. on Macs, with some X11 servers or with a VNC
2465824d651Sblueswir1display). You don't normally need to use it on PC/Linux or PC/Windows
2475824d651Sblueswir1hosts.
2485824d651Sblueswir1
2495824d651Sblueswir1The available layouts are:
2505824d651Sblueswir1@example
2515824d651Sblueswir1ar  de-ch  es  fo     fr-ca  hu  ja  mk     no  pt-br  sv
2525824d651Sblueswir1da  en-gb  et  fr     fr-ch  is  lt  nl     pl  ru     th
2535824d651Sblueswir1de  en-us  fi  fr-be  hr     it  lv  nl-be  pt  sl     tr
2545824d651Sblueswir1@end example
2555824d651Sblueswir1
2565824d651Sblueswir1The default is @code{en-us}.
2575824d651Sblueswir1ETEXI
2585824d651Sblueswir1
2595824d651Sblueswir1
2605824d651Sblueswir1#ifdef HAS_AUDIO
2615824d651Sblueswir1DEF("audio-help", 0, QEMU_OPTION_audio_help,
2625824d651Sblueswir1    "-audio-help     print list of audio drivers and their options\n")
2635824d651Sblueswir1#endif
2645824d651Sblueswir1STEXI
2655824d651Sblueswir1@item -audio-help
2665824d651Sblueswir1
2675824d651Sblueswir1Will show the audio subsystem help: list of drivers, tunable
2685824d651Sblueswir1parameters.
2695824d651Sblueswir1ETEXI
2705824d651Sblueswir1
2715824d651Sblueswir1#ifdef HAS_AUDIO
2725824d651Sblueswir1DEF("soundhw", HAS_ARG, QEMU_OPTION_soundhw,
2735824d651Sblueswir1    "-soundhw c1,... enable audio support\n"
2745824d651Sblueswir1    "                and only specified sound cards (comma separated list)\n"
2755824d651Sblueswir1    "                use -soundhw ? to get the list of supported cards\n"
2765824d651Sblueswir1    "                use -soundhw all to enable all of them\n")
2775824d651Sblueswir1#endif
2785824d651Sblueswir1STEXI
2795824d651Sblueswir1@item -soundhw @var{card1}[,@var{card2},...] or -soundhw all
2805824d651Sblueswir1
2815824d651Sblueswir1Enable audio and selected sound hardware. Use ? to print all
2825824d651Sblueswir1available sound hardware.
2835824d651Sblueswir1
2845824d651Sblueswir1@example
2855824d651Sblueswir1qemu -soundhw sb16,adlib disk.img
2865824d651Sblueswir1qemu -soundhw es1370 disk.img
2875824d651Sblueswir1qemu -soundhw ac97 disk.img
2885824d651Sblueswir1qemu -soundhw all disk.img
2895824d651Sblueswir1qemu -soundhw ?
2905824d651Sblueswir1@end example
2915824d651Sblueswir1
2925824d651Sblueswir1Note that Linux's i810_audio OSS kernel (for AC97) module might
2935824d651Sblueswir1require manually specifying clocking.
2945824d651Sblueswir1
2955824d651Sblueswir1@example
2965824d651Sblueswir1modprobe i810_audio clocking=48000
2975824d651Sblueswir1@end example
2985824d651Sblueswir1ETEXI
2995824d651Sblueswir1
3005824d651Sblueswir1STEXI
3015824d651Sblueswir1@end table
3025824d651Sblueswir1ETEXI
3035824d651Sblueswir1
3045824d651Sblueswir1DEF("usb", 0, QEMU_OPTION_usb,
3055824d651Sblueswir1    "-usb            enable the USB driver (will be the default soon)\n")
3065824d651Sblueswir1STEXI
3075824d651Sblueswir1USB options:
3085824d651Sblueswir1@table @option
3095824d651Sblueswir1
3105824d651Sblueswir1@item -usb
3115824d651Sblueswir1Enable the USB driver (will be the default soon)
3125824d651Sblueswir1ETEXI
3135824d651Sblueswir1
3145824d651Sblueswir1DEF("usbdevice", HAS_ARG, QEMU_OPTION_usbdevice,
3155824d651Sblueswir1    "-usbdevice name add the host or guest USB device 'name'\n")
3165824d651Sblueswir1STEXI
3175824d651Sblueswir1
3185824d651Sblueswir1@item -usbdevice @var{devname}
3195824d651Sblueswir1Add the USB device @var{devname}. @xref{usb_devices}.
3205824d651Sblueswir1
3215824d651Sblueswir1@table @code
3225824d651Sblueswir1
3235824d651Sblueswir1@item mouse
3245824d651Sblueswir1Virtual Mouse. This will override the PS/2 mouse emulation when activated.
3255824d651Sblueswir1
3265824d651Sblueswir1@item tablet
3275824d651Sblueswir1Pointer device that uses absolute coordinates (like a touchscreen). This
3285824d651Sblueswir1means qemu is able to report the mouse position without having to grab the
3295824d651Sblueswir1mouse. Also overrides the PS/2 mouse emulation when activated.
3305824d651Sblueswir1
3315824d651Sblueswir1@item disk:[format=@var{format}]:file
3325824d651Sblueswir1Mass storage device based on file. The optional @var{format} argument
3335824d651Sblueswir1will be used rather than detecting the format. Can be used to specifiy
3345824d651Sblueswir1format=raw to avoid interpreting an untrusted format header.
3355824d651Sblueswir1
3365824d651Sblueswir1@item host:bus.addr
3375824d651Sblueswir1Pass through the host device identified by bus.addr (Linux only).
3385824d651Sblueswir1
3395824d651Sblueswir1@item host:vendor_id:product_id
3405824d651Sblueswir1Pass through the host device identified by vendor_id:product_id (Linux only).
3415824d651Sblueswir1
3425824d651Sblueswir1@item serial:[vendorid=@var{vendor_id}][,productid=@var{product_id}]:@var{dev}
3435824d651Sblueswir1Serial converter to host character device @var{dev}, see @code{-serial} for the
3445824d651Sblueswir1available devices.
3455824d651Sblueswir1
3465824d651Sblueswir1@item braille
3475824d651Sblueswir1Braille device.  This will use BrlAPI to display the braille output on a real
3485824d651Sblueswir1or fake device.
3495824d651Sblueswir1
3505824d651Sblueswir1@item net:options
3515824d651Sblueswir1Network adapter that supports CDC ethernet and RNDIS protocols.
3525824d651Sblueswir1
3535824d651Sblueswir1@end table
3545824d651Sblueswir1ETEXI
3555824d651Sblueswir1
3565824d651Sblueswir1DEF("name", HAS_ARG, QEMU_OPTION_name,
3575824d651Sblueswir1    "-name string    set the name of the guest\n")
3585824d651Sblueswir1STEXI
3595824d651Sblueswir1@item -name @var{name}
3605824d651Sblueswir1Sets the @var{name} of the guest.
3615824d651Sblueswir1This name will be displayed in the SDL window caption.
3625824d651Sblueswir1The @var{name} will also be used for the VNC server.
3635824d651Sblueswir1ETEXI
3645824d651Sblueswir1
3655824d651Sblueswir1DEF("uuid", HAS_ARG, QEMU_OPTION_uuid,
3665824d651Sblueswir1    "-uuid %%08x-%%04x-%%04x-%%04x-%%012x\n"
3675824d651Sblueswir1    "                specify machine UUID\n")
3685824d651Sblueswir1STEXI
3695824d651Sblueswir1@item -uuid @var{uuid}
3705824d651Sblueswir1Set system UUID.
3715824d651Sblueswir1ETEXI
3725824d651Sblueswir1
3735824d651Sblueswir1STEXI
3745824d651Sblueswir1@end table
3755824d651Sblueswir1ETEXI
3765824d651Sblueswir1
3775824d651Sblueswir1DEFHEADING()
3785824d651Sblueswir1
3795824d651Sblueswir1DEFHEADING(Display options:)
3805824d651Sblueswir1
3815824d651Sblueswir1STEXI
3825824d651Sblueswir1@table @option
3835824d651Sblueswir1ETEXI
3845824d651Sblueswir1
3855824d651Sblueswir1DEF("nographic", 0, QEMU_OPTION_nographic,
3865824d651Sblueswir1    "-nographic      disable graphical output and redirect serial I/Os to console\n")
3875824d651Sblueswir1STEXI
3885824d651Sblueswir1@item -nographic
3895824d651Sblueswir1
3905824d651Sblueswir1Normally, QEMU uses SDL to display the VGA output. With this option,
3915824d651Sblueswir1you can totally disable graphical output so that QEMU is a simple
3925824d651Sblueswir1command line application. The emulated serial port is redirected on
3935824d651Sblueswir1the console. Therefore, you can still use QEMU to debug a Linux kernel
3945824d651Sblueswir1with a serial console.
3955824d651Sblueswir1ETEXI
3965824d651Sblueswir1
3975824d651Sblueswir1#ifdef CONFIG_CURSES
3985824d651Sblueswir1DEF("curses", 0, QEMU_OPTION_curses,
3995824d651Sblueswir1    "-curses         use a curses/ncurses interface instead of SDL\n")
4005824d651Sblueswir1#endif
4015824d651Sblueswir1STEXI
4025824d651Sblueswir1@item -curses
4035824d651Sblueswir1
4045824d651Sblueswir1Normally, QEMU uses SDL to display the VGA output.  With this option,
4055824d651Sblueswir1QEMU can display the VGA output when in text mode using a
4065824d651Sblueswir1curses/ncurses interface.  Nothing is displayed in graphical mode.
4075824d651Sblueswir1ETEXI
4085824d651Sblueswir1
4095824d651Sblueswir1#ifdef CONFIG_SDL
4105824d651Sblueswir1DEF("no-frame", 0, QEMU_OPTION_no_frame,
4115824d651Sblueswir1    "-no-frame       open SDL window without a frame and window decorations\n")
4125824d651Sblueswir1#endif
4135824d651Sblueswir1STEXI
4145824d651Sblueswir1@item -no-frame
4155824d651Sblueswir1
4165824d651Sblueswir1Do not use decorations for SDL windows and start them using the whole
4175824d651Sblueswir1available screen space. This makes the using QEMU in a dedicated desktop
4185824d651Sblueswir1workspace more convenient.
4195824d651Sblueswir1ETEXI
4205824d651Sblueswir1
4215824d651Sblueswir1#ifdef CONFIG_SDL
4225824d651Sblueswir1DEF("alt-grab", 0, QEMU_OPTION_alt_grab,
4235824d651Sblueswir1    "-alt-grab       use Ctrl-Alt-Shift to grab mouse (instead of Ctrl-Alt)\n")
4245824d651Sblueswir1#endif
4255824d651Sblueswir1STEXI
4265824d651Sblueswir1@item -alt-grab
4275824d651Sblueswir1
4285824d651Sblueswir1Use Ctrl-Alt-Shift to grab mouse (instead of Ctrl-Alt).
4295824d651Sblueswir1ETEXI
4305824d651Sblueswir1
4315824d651Sblueswir1#ifdef CONFIG_SDL
4325824d651Sblueswir1DEF("no-quit", 0, QEMU_OPTION_no_quit,
4335824d651Sblueswir1    "-no-quit        disable SDL window close capability\n")
4345824d651Sblueswir1#endif
4355824d651Sblueswir1STEXI
4365824d651Sblueswir1@item -no-quit
4375824d651Sblueswir1
4385824d651Sblueswir1Disable SDL window close capability.
4395824d651Sblueswir1ETEXI
4405824d651Sblueswir1
4415824d651Sblueswir1#ifdef CONFIG_SDL
4425824d651Sblueswir1DEF("sdl", 0, QEMU_OPTION_sdl,
4435824d651Sblueswir1    "-sdl            enable SDL\n")
4445824d651Sblueswir1#endif
4455824d651Sblueswir1STEXI
4465824d651Sblueswir1@item -sdl
4475824d651Sblueswir1
4485824d651Sblueswir1Enable SDL.
4495824d651Sblueswir1ETEXI
4505824d651Sblueswir1
4515824d651Sblueswir1DEF("portrait", 0, QEMU_OPTION_portrait,
4525824d651Sblueswir1    "-portrait       rotate graphical output 90 deg left (only PXA LCD)\n")
4535824d651Sblueswir1STEXI
4545824d651Sblueswir1@item -portrait
4555824d651Sblueswir1
4565824d651Sblueswir1Rotate graphical output 90 deg left (only PXA LCD).
4575824d651Sblueswir1ETEXI
4585824d651Sblueswir1
4595824d651Sblueswir1DEF("vga", HAS_ARG, QEMU_OPTION_vga,
4605824d651Sblueswir1    "-vga [std|cirrus|vmware|none]\n"
4615824d651Sblueswir1    "                select video card type\n")
4625824d651Sblueswir1STEXI
4635824d651Sblueswir1@item -vga @var{type}
4645824d651Sblueswir1Select type of VGA card to emulate. Valid values for @var{type} are
4655824d651Sblueswir1@table @code
4665824d651Sblueswir1@item cirrus
4675824d651Sblueswir1Cirrus Logic GD5446 Video card. All Windows versions starting from
4685824d651Sblueswir1Windows 95 should recognize and use this graphic card. For optimal
4695824d651Sblueswir1performances, use 16 bit color depth in the guest and the host OS.
4705824d651Sblueswir1(This one is the default)
4715824d651Sblueswir1@item std
4725824d651Sblueswir1Standard VGA card with Bochs VBE extensions.  If your guest OS
4735824d651Sblueswir1supports the VESA 2.0 VBE extensions (e.g. Windows XP) and if you want
4745824d651Sblueswir1to use high resolution modes (>= 1280x1024x16) then you should use
4755824d651Sblueswir1this option.
4765824d651Sblueswir1@item vmware
4775824d651Sblueswir1VMWare SVGA-II compatible adapter. Use it if you have sufficiently
4785824d651Sblueswir1recent XFree86/XOrg server or Windows guest with a driver for this
4795824d651Sblueswir1card.
4805824d651Sblueswir1@item none
4815824d651Sblueswir1Disable VGA card.
4825824d651Sblueswir1@end table
4835824d651Sblueswir1ETEXI
4845824d651Sblueswir1
4855824d651Sblueswir1DEF("full-screen", 0, QEMU_OPTION_full_screen,
4865824d651Sblueswir1    "-full-screen    start in full screen\n")
4875824d651Sblueswir1STEXI
4885824d651Sblueswir1@item -full-screen
4895824d651Sblueswir1Start in full screen.
4905824d651Sblueswir1ETEXI
4915824d651Sblueswir1
4925824d651Sblueswir1#if defined(TARGET_PPC) || defined(TARGET_SPARC)
4935824d651Sblueswir1DEF("g", 1, QEMU_OPTION_g ,
4945824d651Sblueswir1    "-g WxH[xDEPTH]  Set the initial graphical resolution and depth\n")
4955824d651Sblueswir1#endif
4965824d651Sblueswir1STEXI
4975824d651Sblueswir1ETEXI
4985824d651Sblueswir1
4995824d651Sblueswir1DEF("vnc", HAS_ARG, QEMU_OPTION_vnc ,
5005824d651Sblueswir1    "-vnc display    start a VNC server on display\n")
5015824d651Sblueswir1STEXI
5025824d651Sblueswir1@item -vnc @var{display}[,@var{option}[,@var{option}[,...]]]
5035824d651Sblueswir1
5045824d651Sblueswir1Normally, QEMU uses SDL to display the VGA output.  With this option,
5055824d651Sblueswir1you can have QEMU listen on VNC display @var{display} and redirect the VGA
5065824d651Sblueswir1display over the VNC session.  It is very useful to enable the usb
5075824d651Sblueswir1tablet device when using this option (option @option{-usbdevice
5085824d651Sblueswir1tablet}). When using the VNC display, you must use the @option{-k}
5095824d651Sblueswir1parameter to set the keyboard layout if you are not using en-us. Valid
5105824d651Sblueswir1syntax for the @var{display} is
5115824d651Sblueswir1
5125824d651Sblueswir1@table @code
5135824d651Sblueswir1
5145824d651Sblueswir1@item @var{host}:@var{d}
5155824d651Sblueswir1
5165824d651Sblueswir1TCP connections will only be allowed from @var{host} on display @var{d}.
5175824d651Sblueswir1By convention the TCP port is 5900+@var{d}. Optionally, @var{host} can
5185824d651Sblueswir1be omitted in which case the server will accept connections from any host.
5195824d651Sblueswir1
5205824d651Sblueswir1@item @code{unix}:@var{path}
5215824d651Sblueswir1
5225824d651Sblueswir1Connections will be allowed over UNIX domain sockets where @var{path} is the
5235824d651Sblueswir1location of a unix socket to listen for connections on.
5245824d651Sblueswir1
5255824d651Sblueswir1@item none
5265824d651Sblueswir1
5275824d651Sblueswir1VNC is initialized but not started. The monitor @code{change} command
5285824d651Sblueswir1can be used to later start the VNC server.
5295824d651Sblueswir1
5305824d651Sblueswir1@end table
5315824d651Sblueswir1
5325824d651Sblueswir1Following the @var{display} value there may be one or more @var{option} flags
5335824d651Sblueswir1separated by commas. Valid options are
5345824d651Sblueswir1
5355824d651Sblueswir1@table @code
5365824d651Sblueswir1
5375824d651Sblueswir1@item reverse
5385824d651Sblueswir1
5395824d651Sblueswir1Connect to a listening VNC client via a ``reverse'' connection. The
5405824d651Sblueswir1client is specified by the @var{display}. For reverse network
5415824d651Sblueswir1connections (@var{host}:@var{d},@code{reverse}), the @var{d} argument
5425824d651Sblueswir1is a TCP port number, not a display number.
5435824d651Sblueswir1
5445824d651Sblueswir1@item password
5455824d651Sblueswir1
5465824d651Sblueswir1Require that password based authentication is used for client connections.
5475824d651Sblueswir1The password must be set separately using the @code{change} command in the
5485824d651Sblueswir1@ref{pcsys_monitor}
5495824d651Sblueswir1
5505824d651Sblueswir1@item tls
5515824d651Sblueswir1
5525824d651Sblueswir1Require that client use TLS when communicating with the VNC server. This
5535824d651Sblueswir1uses anonymous TLS credentials so is susceptible to a man-in-the-middle
5545824d651Sblueswir1attack. It is recommended that this option be combined with either the
5555824d651Sblueswir1@var{x509} or @var{x509verify} options.
5565824d651Sblueswir1
5575824d651Sblueswir1@item x509=@var{/path/to/certificate/dir}
5585824d651Sblueswir1
5595824d651Sblueswir1Valid if @option{tls} is specified. Require that x509 credentials are used
5605824d651Sblueswir1for negotiating the TLS session. The server will send its x509 certificate
5615824d651Sblueswir1to the client. It is recommended that a password be set on the VNC server
5625824d651Sblueswir1to provide authentication of the client when this is used. The path following
5635824d651Sblueswir1this option specifies where the x509 certificates are to be loaded from.
5645824d651Sblueswir1See the @ref{vnc_security} section for details on generating certificates.
5655824d651Sblueswir1
5665824d651Sblueswir1@item x509verify=@var{/path/to/certificate/dir}
5675824d651Sblueswir1
5685824d651Sblueswir1Valid if @option{tls} is specified. Require that x509 credentials are used
5695824d651Sblueswir1for negotiating the TLS session. The server will send its x509 certificate
5705824d651Sblueswir1to the client, and request that the client send its own x509 certificate.
5715824d651Sblueswir1The server will validate the client's certificate against the CA certificate,
5725824d651Sblueswir1and reject clients when validation fails. If the certificate authority is
5735824d651Sblueswir1trusted, this is a sufficient authentication mechanism. You may still wish
5745824d651Sblueswir1to set a password on the VNC server as a second authentication layer. The
5755824d651Sblueswir1path following this option specifies where the x509 certificates are to
5765824d651Sblueswir1be loaded from. See the @ref{vnc_security} section for details on generating
5775824d651Sblueswir1certificates.
5785824d651Sblueswir1
5795824d651Sblueswir1@item sasl
5805824d651Sblueswir1
5815824d651Sblueswir1Require that the client use SASL to authenticate with the VNC server.
5825824d651Sblueswir1The exact choice of authentication method used is controlled from the
5835824d651Sblueswir1system / user's SASL configuration file for the 'qemu' service. This
5845824d651Sblueswir1is typically found in /etc/sasl2/qemu.conf. If running QEMU as an
5855824d651Sblueswir1unprivileged user, an environment variable SASL_CONF_PATH can be used
5865824d651Sblueswir1to make it search alternate locations for the service config.
5875824d651Sblueswir1While some SASL auth methods can also provide data encryption (eg GSSAPI),
5885824d651Sblueswir1it is recommended that SASL always be combined with the 'tls' and
5895824d651Sblueswir1'x509' settings to enable use of SSL and server certificates. This
5905824d651Sblueswir1ensures a data encryption preventing compromise of authentication
5915824d651Sblueswir1credentials. See the @ref{vnc_security} section for details on using
5925824d651Sblueswir1SASL authentication.
5935824d651Sblueswir1
5945824d651Sblueswir1@item acl
5955824d651Sblueswir1
5965824d651Sblueswir1Turn on access control lists for checking of the x509 client certificate
5975824d651Sblueswir1and SASL party. For x509 certs, the ACL check is made against the
5985824d651Sblueswir1certificate's distinguished name. This is something that looks like
5995824d651Sblueswir1@code{C=GB,O=ACME,L=Boston,CN=bob}. For SASL party, the ACL check is
6005824d651Sblueswir1made against the username, which depending on the SASL plugin, may
6015824d651Sblueswir1include a realm component, eg @code{bob} or @code{bob@@EXAMPLE.COM}.
6025824d651Sblueswir1When the @option{acl} flag is set, the initial access list will be
6035824d651Sblueswir1empty, with a @code{deny} policy. Thus no one will be allowed to
6045824d651Sblueswir1use the VNC server until the ACLs have been loaded. This can be
6055824d651Sblueswir1achieved using the @code{acl} monitor command.
6065824d651Sblueswir1
6075824d651Sblueswir1@end table
6085824d651Sblueswir1ETEXI
6095824d651Sblueswir1
6105824d651Sblueswir1STEXI
6115824d651Sblueswir1@end table
6125824d651Sblueswir1ETEXI
6135824d651Sblueswir1
6145824d651Sblueswir1DEFHEADING()
6155824d651Sblueswir1
6165824d651Sblueswir1#ifdef TARGET_I386
6175824d651Sblueswir1DEFHEADING(i386 target only:)
6185824d651Sblueswir1#endif
6195824d651Sblueswir1STEXI
6205824d651Sblueswir1@table @option
6215824d651Sblueswir1ETEXI
6225824d651Sblueswir1
6235824d651Sblueswir1#ifdef TARGET_I386
6245824d651Sblueswir1DEF("win2k-hack", 0, QEMU_OPTION_win2k_hack,
6255824d651Sblueswir1    "-win2k-hack     use it when installing Windows 2000 to avoid a disk full bug\n")
6265824d651Sblueswir1#endif
6275824d651Sblueswir1STEXI
6285824d651Sblueswir1@item -win2k-hack
6295824d651Sblueswir1Use it when installing Windows 2000 to avoid a disk full bug. After
6305824d651Sblueswir1Windows 2000 is installed, you no longer need this option (this option
6315824d651Sblueswir1slows down the IDE transfers).
6325824d651Sblueswir1ETEXI
6335824d651Sblueswir1
6345824d651Sblueswir1#ifdef TARGET_I386
6355824d651Sblueswir1DEF("rtc-td-hack", 0, QEMU_OPTION_rtc_td_hack,
6365824d651Sblueswir1    "-rtc-td-hack    use it to fix time drift in Windows ACPI HAL\n")
6375824d651Sblueswir1#endif
6385824d651Sblueswir1STEXI
6395824d651Sblueswir1@item -rtc-td-hack
6405824d651Sblueswir1Use it if you experience time drift problem in Windows with ACPI HAL.
6415824d651Sblueswir1This option will try to figure out how many timer interrupts were not
6425824d651Sblueswir1processed by the Windows guest and will re-inject them.
6435824d651Sblueswir1ETEXI
6445824d651Sblueswir1
6455824d651Sblueswir1#ifdef TARGET_I386
6465824d651Sblueswir1DEF("no-fd-bootchk", 0, QEMU_OPTION_no_fd_bootchk,
6475824d651Sblueswir1    "-no-fd-bootchk  disable boot signature checking for floppy disks\n")
6485824d651Sblueswir1#endif
6495824d651Sblueswir1STEXI
6505824d651Sblueswir1@item -no-fd-bootchk
6515824d651Sblueswir1Disable boot signature checking for floppy disks in Bochs BIOS. It may
6525824d651Sblueswir1be needed to boot from old floppy disks.
6535824d651Sblueswir1ETEXI
6545824d651Sblueswir1
6555824d651Sblueswir1#ifdef TARGET_I386
6565824d651Sblueswir1DEF("no-acpi", 0, QEMU_OPTION_no_acpi,
6575824d651Sblueswir1           "-no-acpi        disable ACPI\n")
6585824d651Sblueswir1#endif
6595824d651Sblueswir1STEXI
6605824d651Sblueswir1@item -no-acpi
6615824d651Sblueswir1Disable ACPI (Advanced Configuration and Power Interface) support. Use
6625824d651Sblueswir1it if your guest OS complains about ACPI problems (PC target machine
6635824d651Sblueswir1only).
6645824d651Sblueswir1ETEXI
6655824d651Sblueswir1
6665824d651Sblueswir1#ifdef TARGET_I386
6675824d651Sblueswir1DEF("no-hpet", 0, QEMU_OPTION_no_hpet,
6685824d651Sblueswir1    "-no-hpet        disable HPET\n")
6695824d651Sblueswir1#endif
6705824d651Sblueswir1STEXI
6715824d651Sblueswir1@item -no-hpet
6725824d651Sblueswir1Disable HPET support.
6735824d651Sblueswir1ETEXI
6745824d651Sblueswir1
6755824d651Sblueswir1#ifdef TARGET_I386
6765824d651Sblueswir1DEF("acpitable", HAS_ARG, QEMU_OPTION_acpitable,
6775824d651Sblueswir1    "-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"
6785824d651Sblueswir1    "                ACPI table description\n")
6795824d651Sblueswir1#endif
6805824d651Sblueswir1STEXI
6815824d651Sblueswir1@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}]...]
6825824d651Sblueswir1Add ACPI table with specified header fields and context from specified files.
6835824d651Sblueswir1ETEXI
6845824d651Sblueswir1
6855824d651Sblueswir1#ifdef TARGET_I386
686b6f6e3d3SaliguoriDEF("smbios", HAS_ARG, QEMU_OPTION_smbios,
687b6f6e3d3Saliguori    "-smbios file=binary\n"
688b6f6e3d3Saliguori    "                Load SMBIOS entry from binary file\n"
689b6f6e3d3Saliguori    "-smbios type=0[,vendor=str][,version=str][,date=str][,release=%%d.%%d]\n"
690b6f6e3d3Saliguori    "                Specify SMBIOS type 0 fields\n"
691b6f6e3d3Saliguori    "-smbios type=1[,manufacturer=str][,product=str][,version=str][,serial=str]\n"
692b6f6e3d3Saliguori    "              [,uuid=uuid][,sku=str][,family=str]\n"
693b6f6e3d3Saliguori    "                Specify SMBIOS type 1 fields\n")
694b6f6e3d3Saliguori#endif
695b6f6e3d3SaliguoriSTEXI
696b6f6e3d3Saliguori@item -smbios file=@var{binary}
697b6f6e3d3SaliguoriLoad SMBIOS entry from binary file.
698b6f6e3d3Saliguori
699b6f6e3d3Saliguori@item -smbios type=0[,vendor=@var{str}][,version=@var{str}][,date=@var{str}][,release=@var{%d.%d}]
700b6f6e3d3SaliguoriSpecify SMBIOS type 0 fields
701b6f6e3d3Saliguori
702b6f6e3d3Saliguori@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}]
703b6f6e3d3SaliguoriSpecify SMBIOS type 1 fields
704b6f6e3d3SaliguoriETEXI
705b6f6e3d3Saliguori
706b6f6e3d3Saliguori#ifdef TARGET_I386
7075824d651Sblueswir1DEFHEADING()
7085824d651Sblueswir1#endif
7095824d651Sblueswir1STEXI
7105824d651Sblueswir1@end table
7115824d651Sblueswir1ETEXI
7125824d651Sblueswir1
7135824d651Sblueswir1DEFHEADING(Network options:)
7145824d651Sblueswir1STEXI
7155824d651Sblueswir1@table @option
7165824d651Sblueswir1ETEXI
7175824d651Sblueswir1
7185824d651Sblueswir1DEF("net", HAS_ARG, QEMU_OPTION_net, \
7195824d651Sblueswir1    "-net nic[,vlan=n][,macaddr=addr][,model=type][,name=str]\n"
7205824d651Sblueswir1    "                create a new Network Interface Card and connect it to VLAN 'n'\n"
7215824d651Sblueswir1#ifdef CONFIG_SLIRP
7225824d651Sblueswir1    "-net user[,vlan=n][,name=str][,hostname=host]\n"
7235824d651Sblueswir1    "                connect the user mode network stack to VLAN 'n' and send\n"
7245824d651Sblueswir1    "                hostname 'host' to DHCP clients\n"
7255824d651Sblueswir1#endif
7265824d651Sblueswir1#ifdef _WIN32
7275824d651Sblueswir1    "-net tap[,vlan=n][,name=str],ifname=name\n"
7285824d651Sblueswir1    "                connect the host TAP network interface to VLAN 'n'\n"
7295824d651Sblueswir1#else
7305824d651Sblueswir1    "-net tap[,vlan=n][,name=str][,fd=h][,ifname=name][,script=file][,downscript=dfile]\n"
7315824d651Sblueswir1    "                connect the host TAP network interface to VLAN 'n' and use the\n"
7325824d651Sblueswir1    "                network scripts 'file' (default=%s)\n"
7335824d651Sblueswir1    "                and 'dfile' (default=%s);\n"
7345824d651Sblueswir1    "                use '[down]script=no' to disable script execution;\n"
7355824d651Sblueswir1    "                use 'fd=h' to connect to an already opened TAP interface\n"
7365824d651Sblueswir1#endif
7375824d651Sblueswir1    "-net socket[,vlan=n][,name=str][,fd=h][,listen=[host]:port][,connect=host:port]\n"
7385824d651Sblueswir1    "                connect the vlan 'n' to another VLAN using a socket connection\n"
7395824d651Sblueswir1    "-net socket[,vlan=n][,name=str][,fd=h][,mcast=maddr:port]\n"
7405824d651Sblueswir1    "                connect the vlan 'n' to multicast maddr and port\n"
7415824d651Sblueswir1#ifdef CONFIG_VDE
7425824d651Sblueswir1    "-net vde[,vlan=n][,name=str][,sock=socketpath][,port=n][,group=groupname][,mode=octalmode]\n"
7435824d651Sblueswir1    "                connect the vlan 'n' to port 'n' of a vde switch running\n"
7445824d651Sblueswir1    "                on host and listening for incoming connections on 'socketpath'.\n"
7455824d651Sblueswir1    "                Use group 'groupname' and mode 'octalmode' to change default\n"
7465824d651Sblueswir1    "                ownership and permissions for communication port.\n"
7475824d651Sblueswir1#endif
748*bb9ea79eSaliguori    "-net dump[,vlan=n][,file=f][,len=n]\n"
749*bb9ea79eSaliguori    "                dump traffic on vlan 'n' to file 'f' (max n bytes per packet)\n"
7505824d651Sblueswir1    "-net none       use it alone to have zero network devices; if no -net option\n"
7515824d651Sblueswir1    "                is provided, the default is '-net nic -net user'\n")
7525824d651Sblueswir1STEXI
7535824d651Sblueswir1@item -net nic[,vlan=@var{n}][,macaddr=@var{addr}][,model=@var{type}][,name=@var{name}]
7545824d651Sblueswir1Create a new Network Interface Card and connect it to VLAN @var{n} (@var{n}
7555824d651Sblueswir1= 0 is the default). The NIC is an ne2k_pci by default on the PC
7565824d651Sblueswir1target. Optionally, the MAC address can be changed to @var{addr}
7575824d651Sblueswir1and a @var{name} can be assigned for use in monitor commands. If no
7585824d651Sblueswir1@option{-net} option is specified, a single NIC is created.
7595824d651Sblueswir1Qemu can emulate several different models of network card.
7605824d651Sblueswir1Valid values for @var{type} are
7615824d651Sblueswir1@code{i82551}, @code{i82557b}, @code{i82559er},
7625824d651Sblueswir1@code{ne2k_pci}, @code{ne2k_isa}, @code{pcnet}, @code{rtl8139},
7635824d651Sblueswir1@code{e1000}, @code{smc91c111}, @code{lance} and @code{mcf_fec}.
7645824d651Sblueswir1Not all devices are supported on all targets.  Use -net nic,model=?
7655824d651Sblueswir1for a list of available devices for your target.
7665824d651Sblueswir1
7675824d651Sblueswir1@item -net user[,vlan=@var{n}][,hostname=@var{name}][,name=@var{name}]
7685824d651Sblueswir1Use the user mode network stack which requires no administrator
7695824d651Sblueswir1privilege to run.  @option{hostname=name} can be used to specify the client
7705824d651Sblueswir1hostname reported by the builtin DHCP server.
7715824d651Sblueswir1
7725824d651Sblueswir1@item -net channel,@var{port}:@var{dev}
7735824d651Sblueswir1Forward @option{user} TCP connection to port @var{port} to character device @var{dev}
7745824d651Sblueswir1
7755824d651Sblueswir1@item -net tap[,vlan=@var{n}][,name=@var{name}][,fd=@var{h}][,ifname=@var{name}][,script=@var{file}][,downscript=@var{dfile}]
7765824d651Sblueswir1Connect the host TAP network interface @var{name} to VLAN @var{n}, use
7775824d651Sblueswir1the network script @var{file} to configure it and the network script
7785824d651Sblueswir1@var{dfile} to deconfigure it. If @var{name} is not provided, the OS
7795824d651Sblueswir1automatically provides one. @option{fd}=@var{h} can be used to specify
7805824d651Sblueswir1the handle of an already opened host TAP interface. The default network
7815824d651Sblueswir1configure script is @file{/etc/qemu-ifup} and the default network
7825824d651Sblueswir1deconfigure script is @file{/etc/qemu-ifdown}. Use @option{script=no}
7835824d651Sblueswir1or @option{downscript=no} to disable script execution. Example:
7845824d651Sblueswir1
7855824d651Sblueswir1@example
7865824d651Sblueswir1qemu linux.img -net nic -net tap
7875824d651Sblueswir1@end example
7885824d651Sblueswir1
7895824d651Sblueswir1More complicated example (two NICs, each one connected to a TAP device)
7905824d651Sblueswir1@example
7915824d651Sblueswir1qemu linux.img -net nic,vlan=0 -net tap,vlan=0,ifname=tap0 \
7925824d651Sblueswir1               -net nic,vlan=1 -net tap,vlan=1,ifname=tap1
7935824d651Sblueswir1@end example
7945824d651Sblueswir1
7955824d651Sblueswir1@item -net socket[,vlan=@var{n}][,name=@var{name}][,fd=@var{h}][,listen=[@var{host}]:@var{port}][,connect=@var{host}:@var{port}]
7965824d651Sblueswir1
7975824d651Sblueswir1Connect the VLAN @var{n} to a remote VLAN in another QEMU virtual
7985824d651Sblueswir1machine using a TCP socket connection. If @option{listen} is
7995824d651Sblueswir1specified, QEMU waits for incoming connections on @var{port}
8005824d651Sblueswir1(@var{host} is optional). @option{connect} is used to connect to
8015824d651Sblueswir1another QEMU instance using the @option{listen} option. @option{fd}=@var{h}
8025824d651Sblueswir1specifies an already opened TCP socket.
8035824d651Sblueswir1
8045824d651Sblueswir1Example:
8055824d651Sblueswir1@example
8065824d651Sblueswir1# launch a first QEMU instance
8075824d651Sblueswir1qemu linux.img -net nic,macaddr=52:54:00:12:34:56 \
8085824d651Sblueswir1               -net socket,listen=:1234
8095824d651Sblueswir1# connect the VLAN 0 of this instance to the VLAN 0
8105824d651Sblueswir1# of the first instance
8115824d651Sblueswir1qemu linux.img -net nic,macaddr=52:54:00:12:34:57 \
8125824d651Sblueswir1               -net socket,connect=127.0.0.1:1234
8135824d651Sblueswir1@end example
8145824d651Sblueswir1
8155824d651Sblueswir1@item -net socket[,vlan=@var{n}][,name=@var{name}][,fd=@var{h}][,mcast=@var{maddr}:@var{port}]
8165824d651Sblueswir1
8175824d651Sblueswir1Create a VLAN @var{n} shared with another QEMU virtual
8185824d651Sblueswir1machines using a UDP multicast socket, effectively making a bus for
8195824d651Sblueswir1every QEMU with same multicast address @var{maddr} and @var{port}.
8205824d651Sblueswir1NOTES:
8215824d651Sblueswir1@enumerate
8225824d651Sblueswir1@item
8235824d651Sblueswir1Several QEMU can be running on different hosts and share same bus (assuming
8245824d651Sblueswir1correct multicast setup for these hosts).
8255824d651Sblueswir1@item
8265824d651Sblueswir1mcast support is compatible with User Mode Linux (argument @option{eth@var{N}=mcast}), see
8275824d651Sblueswir1@url{http://user-mode-linux.sf.net}.
8285824d651Sblueswir1@item
8295824d651Sblueswir1Use @option{fd=h} to specify an already opened UDP multicast socket.
8305824d651Sblueswir1@end enumerate
8315824d651Sblueswir1
8325824d651Sblueswir1Example:
8335824d651Sblueswir1@example
8345824d651Sblueswir1# launch one QEMU instance
8355824d651Sblueswir1qemu linux.img -net nic,macaddr=52:54:00:12:34:56 \
8365824d651Sblueswir1               -net socket,mcast=230.0.0.1:1234
8375824d651Sblueswir1# launch another QEMU instance on same "bus"
8385824d651Sblueswir1qemu linux.img -net nic,macaddr=52:54:00:12:34:57 \
8395824d651Sblueswir1               -net socket,mcast=230.0.0.1:1234
8405824d651Sblueswir1# launch yet another QEMU instance on same "bus"
8415824d651Sblueswir1qemu linux.img -net nic,macaddr=52:54:00:12:34:58 \
8425824d651Sblueswir1               -net socket,mcast=230.0.0.1:1234
8435824d651Sblueswir1@end example
8445824d651Sblueswir1
8455824d651Sblueswir1Example (User Mode Linux compat.):
8465824d651Sblueswir1@example
8475824d651Sblueswir1# launch QEMU instance (note mcast address selected
8485824d651Sblueswir1# is UML's default)
8495824d651Sblueswir1qemu linux.img -net nic,macaddr=52:54:00:12:34:56 \
8505824d651Sblueswir1               -net socket,mcast=239.192.168.1:1102
8515824d651Sblueswir1# launch UML
8525824d651Sblueswir1/path/to/linux ubd0=/path/to/root_fs eth0=mcast
8535824d651Sblueswir1@end example
8545824d651Sblueswir1
8555824d651Sblueswir1@item -net vde[,vlan=@var{n}][,name=@var{name}][,sock=@var{socketpath}][,port=@var{n}][,group=@var{groupname}][,mode=@var{octalmode}]
8565824d651Sblueswir1Connect VLAN @var{n} to PORT @var{n} of a vde switch running on host and
8575824d651Sblueswir1listening for incoming connections on @var{socketpath}. Use GROUP @var{groupname}
8585824d651Sblueswir1and MODE @var{octalmode} to change default ownership and permissions for
8595824d651Sblueswir1communication port. This option is available only if QEMU has been compiled
8605824d651Sblueswir1with vde support enabled.
8615824d651Sblueswir1
8625824d651Sblueswir1Example:
8635824d651Sblueswir1@example
8645824d651Sblueswir1# launch vde switch
8655824d651Sblueswir1vde_switch -F -sock /tmp/myswitch
8665824d651Sblueswir1# launch QEMU instance
8675824d651Sblueswir1qemu linux.img -net nic -net vde,sock=/tmp/myswitch
8685824d651Sblueswir1@end example
8695824d651Sblueswir1
870*bb9ea79eSaliguori@item -net dump[,vlan=@var{n}][,file=@var{file}][,len=@var{len}]
871*bb9ea79eSaliguoriDump network traffic on VLAN @var{n} to file @var{file} (@file{qemu-vlan0.pcap} by default).
872*bb9ea79eSaliguoriAt most @var{len} bytes (64k by default) per packet are stored. The file format is
873*bb9ea79eSaliguorilibpcap, so it can be analyzed with tools such as tcpdump or Wireshark.
874*bb9ea79eSaliguori
8755824d651Sblueswir1@item -net none
8765824d651Sblueswir1Indicate that no network devices should be configured. It is used to
8775824d651Sblueswir1override the default configuration (@option{-net nic -net user}) which
8785824d651Sblueswir1is activated if no @option{-net} options are provided.
8795824d651Sblueswir1ETEXI
8805824d651Sblueswir1
8815824d651Sblueswir1#ifdef CONFIG_SLIRP
8825824d651Sblueswir1DEF("tftp", HAS_ARG, QEMU_OPTION_tftp, \
8835824d651Sblueswir1    "-tftp dir       allow tftp access to files in dir [-net user]\n")
8845824d651Sblueswir1#endif
8855824d651Sblueswir1STEXI
8865824d651Sblueswir1@item -tftp @var{dir}
8875824d651Sblueswir1When using the user mode network stack, activate a built-in TFTP
8885824d651Sblueswir1server. The files in @var{dir} will be exposed as the root of a TFTP server.
8895824d651Sblueswir1The TFTP client on the guest must be configured in binary mode (use the command
8905824d651Sblueswir1@code{bin} of the Unix TFTP client). The host IP address on the guest is as
8915824d651Sblueswir1usual 10.0.2.2.
8925824d651Sblueswir1ETEXI
8935824d651Sblueswir1
8945824d651Sblueswir1#ifdef CONFIG_SLIRP
8955824d651Sblueswir1DEF("bootp", HAS_ARG, QEMU_OPTION_bootp, \
8965824d651Sblueswir1    "-bootp file     advertise file in BOOTP replies\n")
8975824d651Sblueswir1#endif
8985824d651Sblueswir1STEXI
8995824d651Sblueswir1@item -bootp @var{file}
9005824d651Sblueswir1When using the user mode network stack, broadcast @var{file} as the BOOTP
9015824d651Sblueswir1filename.  In conjunction with @option{-tftp}, this can be used to network boot
9025824d651Sblueswir1a guest from a local directory.
9035824d651Sblueswir1
9045824d651Sblueswir1Example (using pxelinux):
9055824d651Sblueswir1@example
9065824d651Sblueswir1qemu -hda linux.img -boot n -tftp /path/to/tftp/files -bootp /pxelinux.0
9075824d651Sblueswir1@end example
9085824d651Sblueswir1ETEXI
9095824d651Sblueswir1
9105824d651Sblueswir1#ifndef _WIN32
9115824d651Sblueswir1DEF("smb", HAS_ARG, QEMU_OPTION_smb, \
9125824d651Sblueswir1           "-smb dir        allow SMB access to files in 'dir' [-net user]\n")
9135824d651Sblueswir1#endif
9145824d651Sblueswir1STEXI
9155824d651Sblueswir1@item -smb @var{dir}
9165824d651Sblueswir1When using the user mode network stack, activate a built-in SMB
9175824d651Sblueswir1server so that Windows OSes can access to the host files in @file{@var{dir}}
9185824d651Sblueswir1transparently.
9195824d651Sblueswir1
9205824d651Sblueswir1In the guest Windows OS, the line:
9215824d651Sblueswir1@example
9225824d651Sblueswir110.0.2.4 smbserver
9235824d651Sblueswir1@end example
9245824d651Sblueswir1must be added in the file @file{C:\WINDOWS\LMHOSTS} (for windows 9x/Me)
9255824d651Sblueswir1or @file{C:\WINNT\SYSTEM32\DRIVERS\ETC\LMHOSTS} (Windows NT/2000).
9265824d651Sblueswir1
9275824d651Sblueswir1Then @file{@var{dir}} can be accessed in @file{\\smbserver\qemu}.
9285824d651Sblueswir1
9295824d651Sblueswir1Note that a SAMBA server must be installed on the host OS in
9305824d651Sblueswir1@file{/usr/sbin/smbd}. QEMU was tested successfully with smbd version
9315824d651Sblueswir12.2.7a from the Red Hat 9 and version 3.0.10-1.fc3 from Fedora Core 3.
9325824d651Sblueswir1ETEXI
9335824d651Sblueswir1
9345824d651Sblueswir1#ifdef CONFIG_SLIRP
9355824d651Sblueswir1DEF("redir", HAS_ARG, QEMU_OPTION_redir, \
9365824d651Sblueswir1    "-redir [tcp|udp]:host-port:[guest-host]:guest-port\n" \
9375824d651Sblueswir1    "                redirect TCP or UDP connections from host to guest [-net user]\n")
9385824d651Sblueswir1#endif
9395824d651Sblueswir1STEXI
9405824d651Sblueswir1@item -redir [tcp|udp]:@var{host-port}:[@var{guest-host}]:@var{guest-port}
9415824d651Sblueswir1
9425824d651Sblueswir1When using the user mode network stack, redirect incoming TCP or UDP
9435824d651Sblueswir1connections to the host port @var{host-port} to the guest
9445824d651Sblueswir1@var{guest-host} on guest port @var{guest-port}. If @var{guest-host}
9455824d651Sblueswir1is not specified, its value is 10.0.2.15 (default address given by the
9465824d651Sblueswir1built-in DHCP server).
9475824d651Sblueswir1
9485824d651Sblueswir1For example, to redirect host X11 connection from screen 1 to guest
9495824d651Sblueswir1screen 0, use the following:
9505824d651Sblueswir1
9515824d651Sblueswir1@example
9525824d651Sblueswir1# on the host
9535824d651Sblueswir1qemu -redir tcp:6001::6000 [...]
9545824d651Sblueswir1# this host xterm should open in the guest X11 server
9555824d651Sblueswir1xterm -display :1
9565824d651Sblueswir1@end example
9575824d651Sblueswir1
9585824d651Sblueswir1To redirect telnet connections from host port 5555 to telnet port on
9595824d651Sblueswir1the guest, use the following:
9605824d651Sblueswir1
9615824d651Sblueswir1@example
9625824d651Sblueswir1# on the host
9635824d651Sblueswir1qemu -redir tcp:5555::23 [...]
9645824d651Sblueswir1telnet localhost 5555
9655824d651Sblueswir1@end example
9665824d651Sblueswir1
9675824d651Sblueswir1Then when you use on the host @code{telnet localhost 5555}, you
9685824d651Sblueswir1connect to the guest telnet server.
9695824d651Sblueswir1
9705824d651Sblueswir1@end table
9715824d651Sblueswir1ETEXI
9725824d651Sblueswir1
9735824d651Sblueswir1DEF("bt", HAS_ARG, QEMU_OPTION_bt, \
9745824d651Sblueswir1    "\n" \
9755824d651Sblueswir1    "-bt hci,null    dumb bluetooth HCI - doesn't respond to commands\n" \
9765824d651Sblueswir1    "-bt hci,host[:id]\n" \
9775824d651Sblueswir1    "                use host's HCI with the given name\n" \
9785824d651Sblueswir1    "-bt hci[,vlan=n]\n" \
9795824d651Sblueswir1    "                emulate a standard HCI in virtual scatternet 'n'\n" \
9805824d651Sblueswir1    "-bt vhci[,vlan=n]\n" \
9815824d651Sblueswir1    "                add host computer to virtual scatternet 'n' using VHCI\n" \
9825824d651Sblueswir1    "-bt device:dev[,vlan=n]\n" \
9835824d651Sblueswir1    "                emulate a bluetooth device 'dev' in scatternet 'n'\n")
9845824d651Sblueswir1STEXI
9855824d651Sblueswir1Bluetooth(R) options:
9865824d651Sblueswir1@table @option
9875824d651Sblueswir1
9885824d651Sblueswir1@item -bt hci[...]
9895824d651Sblueswir1Defines the function of the corresponding Bluetooth HCI.  -bt options
9905824d651Sblueswir1are matched with the HCIs present in the chosen machine type.  For
9915824d651Sblueswir1example when emulating a machine with only one HCI built into it, only
9925824d651Sblueswir1the first @code{-bt hci[...]} option is valid and defines the HCI's
9935824d651Sblueswir1logic.  The Transport Layer is decided by the machine type.  Currently
9945824d651Sblueswir1the machines @code{n800} and @code{n810} have one HCI and all other
9955824d651Sblueswir1machines have none.
9965824d651Sblueswir1
9975824d651Sblueswir1@anchor{bt-hcis}
9985824d651Sblueswir1The following three types are recognized:
9995824d651Sblueswir1
10005824d651Sblueswir1@table @code
10015824d651Sblueswir1@item -bt hci,null
10025824d651Sblueswir1(default) The corresponding Bluetooth HCI assumes no internal logic
10035824d651Sblueswir1and will not respond to any HCI commands or emit events.
10045824d651Sblueswir1
10055824d651Sblueswir1@item -bt hci,host[:@var{id}]
10065824d651Sblueswir1(@code{bluez} only) The corresponding HCI passes commands / events
10075824d651Sblueswir1to / from the physical HCI identified by the name @var{id} (default:
10085824d651Sblueswir1@code{hci0}) on the computer running QEMU.  Only available on @code{bluez}
10095824d651Sblueswir1capable systems like Linux.
10105824d651Sblueswir1
10115824d651Sblueswir1@item -bt hci[,vlan=@var{n}]
10125824d651Sblueswir1Add a virtual, standard HCI that will participate in the Bluetooth
10135824d651Sblueswir1scatternet @var{n} (default @code{0}).  Similarly to @option{-net}
10145824d651Sblueswir1VLANs, devices inside a bluetooth network @var{n} can only communicate
10155824d651Sblueswir1with other devices in the same network (scatternet).
10165824d651Sblueswir1@end table
10175824d651Sblueswir1
10185824d651Sblueswir1@item -bt vhci[,vlan=@var{n}]
10195824d651Sblueswir1(Linux-host only) Create a HCI in scatternet @var{n} (default 0) attached
10205824d651Sblueswir1to the host bluetooth stack instead of to the emulated target.  This
10215824d651Sblueswir1allows the host and target machines to participate in a common scatternet
10225824d651Sblueswir1and communicate.  Requires the Linux @code{vhci} driver installed.  Can
10235824d651Sblueswir1be used as following:
10245824d651Sblueswir1
10255824d651Sblueswir1@example
10265824d651Sblueswir1qemu [...OPTIONS...] -bt hci,vlan=5 -bt vhci,vlan=5
10275824d651Sblueswir1@end example
10285824d651Sblueswir1
10295824d651Sblueswir1@item -bt device:@var{dev}[,vlan=@var{n}]
10305824d651Sblueswir1Emulate a bluetooth device @var{dev} and place it in network @var{n}
10315824d651Sblueswir1(default @code{0}).  QEMU can only emulate one type of bluetooth devices
10325824d651Sblueswir1currently:
10335824d651Sblueswir1
10345824d651Sblueswir1@table @code
10355824d651Sblueswir1@item keyboard
10365824d651Sblueswir1Virtual wireless keyboard implementing the HIDP bluetooth profile.
10375824d651Sblueswir1@end table
10385824d651Sblueswir1@end table
10395824d651Sblueswir1ETEXI
10405824d651Sblueswir1
10415824d651Sblueswir1DEFHEADING()
10425824d651Sblueswir1
10435824d651Sblueswir1DEFHEADING(Linux boot specific:)
10445824d651Sblueswir1STEXI
10455824d651Sblueswir1When using these options, you can use a given
10465824d651Sblueswir1Linux kernel without installing it in the disk image. It can be useful
10475824d651Sblueswir1for easier testing of various kernels.
10485824d651Sblueswir1
10495824d651Sblueswir1@table @option
10505824d651Sblueswir1ETEXI
10515824d651Sblueswir1
10525824d651Sblueswir1DEF("kernel", HAS_ARG, QEMU_OPTION_kernel, \
10535824d651Sblueswir1    "-kernel bzImage use 'bzImage' as kernel image\n")
10545824d651Sblueswir1STEXI
10555824d651Sblueswir1@item -kernel @var{bzImage}
10565824d651Sblueswir1Use @var{bzImage} as kernel image.
10575824d651Sblueswir1ETEXI
10585824d651Sblueswir1
10595824d651Sblueswir1DEF("append", HAS_ARG, QEMU_OPTION_append, \
10605824d651Sblueswir1    "-append cmdline use 'cmdline' as kernel command line\n")
10615824d651Sblueswir1STEXI
10625824d651Sblueswir1@item -append @var{cmdline}
10635824d651Sblueswir1Use @var{cmdline} as kernel command line
10645824d651Sblueswir1ETEXI
10655824d651Sblueswir1
10665824d651Sblueswir1DEF("initrd", HAS_ARG, QEMU_OPTION_initrd, \
10675824d651Sblueswir1           "-initrd file    use 'file' as initial ram disk\n")
10685824d651Sblueswir1STEXI
10695824d651Sblueswir1@item -initrd @var{file}
10705824d651Sblueswir1Use @var{file} as initial ram disk.
10715824d651Sblueswir1ETEXI
10725824d651Sblueswir1
10735824d651Sblueswir1STEXI
10745824d651Sblueswir1@end table
10755824d651Sblueswir1ETEXI
10765824d651Sblueswir1
10775824d651Sblueswir1DEFHEADING()
10785824d651Sblueswir1
10795824d651Sblueswir1DEFHEADING(Debug/Expert options:)
10805824d651Sblueswir1
10815824d651Sblueswir1STEXI
10825824d651Sblueswir1@table @option
10835824d651Sblueswir1ETEXI
10845824d651Sblueswir1
10855824d651Sblueswir1DEF("serial", HAS_ARG, QEMU_OPTION_serial, \
10865824d651Sblueswir1    "-serial dev     redirect the serial port to char device 'dev'\n")
10875824d651Sblueswir1STEXI
10885824d651Sblueswir1@item -serial @var{dev}
10895824d651Sblueswir1Redirect the virtual serial port to host character device
10905824d651Sblueswir1@var{dev}. The default device is @code{vc} in graphical mode and
10915824d651Sblueswir1@code{stdio} in non graphical mode.
10925824d651Sblueswir1
10935824d651Sblueswir1This option can be used several times to simulate up to 4 serial
10945824d651Sblueswir1ports.
10955824d651Sblueswir1
10965824d651Sblueswir1Use @code{-serial none} to disable all serial ports.
10975824d651Sblueswir1
10985824d651Sblueswir1Available character devices are:
10995824d651Sblueswir1@table @code
11005824d651Sblueswir1@item vc[:WxH]
11015824d651Sblueswir1Virtual console. Optionally, a width and height can be given in pixel with
11025824d651Sblueswir1@example
11035824d651Sblueswir1vc:800x600
11045824d651Sblueswir1@end example
11055824d651Sblueswir1It is also possible to specify width or height in characters:
11065824d651Sblueswir1@example
11075824d651Sblueswir1vc:80Cx24C
11085824d651Sblueswir1@end example
11095824d651Sblueswir1@item pty
11105824d651Sblueswir1[Linux only] Pseudo TTY (a new PTY is automatically allocated)
11115824d651Sblueswir1@item none
11125824d651Sblueswir1No device is allocated.
11135824d651Sblueswir1@item null
11145824d651Sblueswir1void device
11155824d651Sblueswir1@item /dev/XXX
11165824d651Sblueswir1[Linux only] Use host tty, e.g. @file{/dev/ttyS0}. The host serial port
11175824d651Sblueswir1parameters are set according to the emulated ones.
11185824d651Sblueswir1@item /dev/parport@var{N}
11195824d651Sblueswir1[Linux only, parallel port only] Use host parallel port
11205824d651Sblueswir1@var{N}. Currently SPP and EPP parallel port features can be used.
11215824d651Sblueswir1@item file:@var{filename}
11225824d651Sblueswir1Write output to @var{filename}. No character can be read.
11235824d651Sblueswir1@item stdio
11245824d651Sblueswir1[Unix only] standard input/output
11255824d651Sblueswir1@item pipe:@var{filename}
11265824d651Sblueswir1name pipe @var{filename}
11275824d651Sblueswir1@item COM@var{n}
11285824d651Sblueswir1[Windows only] Use host serial port @var{n}
11295824d651Sblueswir1@item udp:[@var{remote_host}]:@var{remote_port}[@@[@var{src_ip}]:@var{src_port}]
11305824d651Sblueswir1This implements UDP Net Console.
11315824d651Sblueswir1When @var{remote_host} or @var{src_ip} are not specified
11325824d651Sblueswir1they default to @code{0.0.0.0}.
11335824d651Sblueswir1When not using a specified @var{src_port} a random port is automatically chosen.
11345824d651Sblueswir1@item msmouse
11355824d651Sblueswir1Three button serial mouse. Configure the guest to use Microsoft protocol.
11365824d651Sblueswir1
11375824d651Sblueswir1If you just want a simple readonly console you can use @code{netcat} or
11385824d651Sblueswir1@code{nc}, by starting qemu with: @code{-serial udp::4555} and nc as:
11395824d651Sblueswir1@code{nc -u -l -p 4555}. Any time qemu writes something to that port it
11405824d651Sblueswir1will appear in the netconsole session.
11415824d651Sblueswir1
11425824d651Sblueswir1If you plan to send characters back via netconsole or you want to stop
11435824d651Sblueswir1and start qemu a lot of times, you should have qemu use the same
11445824d651Sblueswir1source port each time by using something like @code{-serial
11455824d651Sblueswir1udp::4555@@:4556} to qemu. Another approach is to use a patched
11465824d651Sblueswir1version of netcat which can listen to a TCP port and send and receive
11475824d651Sblueswir1characters via udp.  If you have a patched version of netcat which
11485824d651Sblueswir1activates telnet remote echo and single char transfer, then you can
11495824d651Sblueswir1use the following options to step up a netcat redirector to allow
11505824d651Sblueswir1telnet on port 5555 to access the qemu port.
11515824d651Sblueswir1@table @code
11525824d651Sblueswir1@item Qemu Options:
11535824d651Sblueswir1-serial udp::4555@@:4556
11545824d651Sblueswir1@item netcat options:
11555824d651Sblueswir1-u -P 4555 -L 0.0.0.0:4556 -t -p 5555 -I -T
11565824d651Sblueswir1@item telnet options:
11575824d651Sblueswir1localhost 5555
11585824d651Sblueswir1@end table
11595824d651Sblueswir1
11605824d651Sblueswir1@item tcp:[@var{host}]:@var{port}[,@var{server}][,nowait][,nodelay]
11615824d651Sblueswir1The TCP Net Console has two modes of operation.  It can send the serial
11625824d651Sblueswir1I/O to a location or wait for a connection from a location.  By default
11635824d651Sblueswir1the TCP Net Console is sent to @var{host} at the @var{port}.  If you use
11645824d651Sblueswir1the @var{server} option QEMU will wait for a client socket application
11655824d651Sblueswir1to connect to the port before continuing, unless the @code{nowait}
11665824d651Sblueswir1option was specified.  The @code{nodelay} option disables the Nagle buffering
11675824d651Sblueswir1algorithm.  If @var{host} is omitted, 0.0.0.0 is assumed. Only
11685824d651Sblueswir1one TCP connection at a time is accepted. You can use @code{telnet} to
11695824d651Sblueswir1connect to the corresponding character device.
11705824d651Sblueswir1@table @code
11715824d651Sblueswir1@item Example to send tcp console to 192.168.0.2 port 4444
11725824d651Sblueswir1-serial tcp:192.168.0.2:4444
11735824d651Sblueswir1@item Example to listen and wait on port 4444 for connection
11745824d651Sblueswir1-serial tcp::4444,server
11755824d651Sblueswir1@item Example to not wait and listen on ip 192.168.0.100 port 4444
11765824d651Sblueswir1-serial tcp:192.168.0.100:4444,server,nowait
11775824d651Sblueswir1@end table
11785824d651Sblueswir1
11795824d651Sblueswir1@item telnet:@var{host}:@var{port}[,server][,nowait][,nodelay]
11805824d651Sblueswir1The telnet protocol is used instead of raw tcp sockets.  The options
11815824d651Sblueswir1work the same as if you had specified @code{-serial tcp}.  The
11825824d651Sblueswir1difference is that the port acts like a telnet server or client using
11835824d651Sblueswir1telnet option negotiation.  This will also allow you to send the
11845824d651Sblueswir1MAGIC_SYSRQ sequence if you use a telnet that supports sending the break
11855824d651Sblueswir1sequence.  Typically in unix telnet you do it with Control-] and then
11865824d651Sblueswir1type "send break" followed by pressing the enter key.
11875824d651Sblueswir1
11885824d651Sblueswir1@item unix:@var{path}[,server][,nowait]
11895824d651Sblueswir1A unix domain socket is used instead of a tcp socket.  The option works the
11905824d651Sblueswir1same as if you had specified @code{-serial tcp} except the unix domain socket
11915824d651Sblueswir1@var{path} is used for connections.
11925824d651Sblueswir1
11935824d651Sblueswir1@item mon:@var{dev_string}
11945824d651Sblueswir1This is a special option to allow the monitor to be multiplexed onto
11955824d651Sblueswir1another serial port.  The monitor is accessed with key sequence of
11965824d651Sblueswir1@key{Control-a} and then pressing @key{c}. See monitor access
11975824d651Sblueswir1@ref{pcsys_keys} in the -nographic section for more keys.
11985824d651Sblueswir1@var{dev_string} should be any one of the serial devices specified
11995824d651Sblueswir1above.  An example to multiplex the monitor onto a telnet server
12005824d651Sblueswir1listening on port 4444 would be:
12015824d651Sblueswir1@table @code
12025824d651Sblueswir1@item -serial mon:telnet::4444,server,nowait
12035824d651Sblueswir1@end table
12045824d651Sblueswir1
12055824d651Sblueswir1@item braille
12065824d651Sblueswir1Braille device.  This will use BrlAPI to display the braille output on a real
12075824d651Sblueswir1or fake device.
12085824d651Sblueswir1
12095824d651Sblueswir1@end table
12105824d651Sblueswir1ETEXI
12115824d651Sblueswir1
12125824d651Sblueswir1DEF("parallel", HAS_ARG, QEMU_OPTION_parallel, \
12135824d651Sblueswir1    "-parallel dev   redirect the parallel port to char device 'dev'\n")
12145824d651Sblueswir1STEXI
12155824d651Sblueswir1@item -parallel @var{dev}
12165824d651Sblueswir1Redirect the virtual parallel port to host device @var{dev} (same
12175824d651Sblueswir1devices as the serial port). On Linux hosts, @file{/dev/parportN} can
12185824d651Sblueswir1be used to use hardware devices connected on the corresponding host
12195824d651Sblueswir1parallel port.
12205824d651Sblueswir1
12215824d651Sblueswir1This option can be used several times to simulate up to 3 parallel
12225824d651Sblueswir1ports.
12235824d651Sblueswir1
12245824d651Sblueswir1Use @code{-parallel none} to disable all parallel ports.
12255824d651Sblueswir1ETEXI
12265824d651Sblueswir1
12275824d651Sblueswir1DEF("monitor", HAS_ARG, QEMU_OPTION_monitor, \
12285824d651Sblueswir1    "-monitor dev    redirect the monitor to char device 'dev'\n")
12295824d651Sblueswir1STEXI
12305824d651Sblueswir1@item -monitor @var{dev}
12315824d651Sblueswir1Redirect the monitor to host device @var{dev} (same devices as the
12325824d651Sblueswir1serial port).
12335824d651Sblueswir1The default device is @code{vc} in graphical mode and @code{stdio} in
12345824d651Sblueswir1non graphical mode.
12355824d651Sblueswir1ETEXI
12365824d651Sblueswir1
12375824d651Sblueswir1DEF("pidfile", HAS_ARG, QEMU_OPTION_pidfile, \
12385824d651Sblueswir1    "-pidfile file   write PID to 'file'\n")
12395824d651Sblueswir1STEXI
12405824d651Sblueswir1@item -pidfile @var{file}
12415824d651Sblueswir1Store the QEMU process PID in @var{file}. It is useful if you launch QEMU
12425824d651Sblueswir1from a script.
12435824d651Sblueswir1ETEXI
12445824d651Sblueswir1
12451b530a6dSaurel32DEF("singlestep", 0, QEMU_OPTION_singlestep, \
12461b530a6dSaurel32    "-singlestep   always run in singlestep mode\n")
12471b530a6dSaurel32STEXI
12481b530a6dSaurel32@item -singlestep
12491b530a6dSaurel32Run the emulation in single step mode.
12501b530a6dSaurel32ETEXI
12511b530a6dSaurel32
12525824d651Sblueswir1DEF("S", 0, QEMU_OPTION_S, \
12535824d651Sblueswir1    "-S              freeze CPU at startup (use 'c' to start execution)\n")
12545824d651Sblueswir1STEXI
12555824d651Sblueswir1@item -S
12565824d651Sblueswir1Do not start CPU at startup (you must type 'c' in the monitor).
12575824d651Sblueswir1ETEXI
12585824d651Sblueswir1
125959030a8cSaliguoriDEF("gdb", HAS_ARG, QEMU_OPTION_gdb, \
126059030a8cSaliguori    "-gdb dev        wait for gdb connection on 'dev'\n")
12615824d651Sblueswir1STEXI
126259030a8cSaliguori@item -gdb @var{dev}
126359030a8cSaliguoriWait for gdb connection on device @var{dev} (@pxref{gdb_usage}). Typical
126459030a8cSaliguoriconnections will likely be TCP-based, but also UDP, pseudo TTY, or even
126559030a8cSaliguoristdio are reasonable use case. The latter is allowing to start qemu from
126659030a8cSaliguoriwithin gdb and establish the connection via a pipe:
126759030a8cSaliguori@example
126859030a8cSaliguori(gdb) target remote | exec qemu -gdb stdio ...
126959030a8cSaliguori@end example
12705824d651Sblueswir1ETEXI
12715824d651Sblueswir1
127259030a8cSaliguoriDEF("s", 0, QEMU_OPTION_s, \
127359030a8cSaliguori    "-s              shorthand for -gdb tcp::%s\n")
12745824d651Sblueswir1STEXI
127559030a8cSaliguori@item -s
127659030a8cSaliguoriShorthand for -gdb tcp::1234, i.e. open a gdbserver on TCP port 1234
127759030a8cSaliguori(@pxref{gdb_usage}).
12785824d651Sblueswir1ETEXI
12795824d651Sblueswir1
12805824d651Sblueswir1DEF("d", HAS_ARG, QEMU_OPTION_d, \
12815824d651Sblueswir1    "-d item1,...    output log to %s (use -d ? for a list of log items)\n")
12825824d651Sblueswir1STEXI
12835824d651Sblueswir1@item -d
12845824d651Sblueswir1Output log in /tmp/qemu.log
12855824d651Sblueswir1ETEXI
12865824d651Sblueswir1
12875824d651Sblueswir1DEF("hdachs", HAS_ARG, QEMU_OPTION_hdachs, \
12885824d651Sblueswir1    "-hdachs c,h,s[,t]\n" \
12895824d651Sblueswir1    "                force hard disk 0 physical geometry and the optional BIOS\n" \
12905824d651Sblueswir1    "                translation (t=none or lba) (usually qemu can guess them)\n")
12915824d651Sblueswir1STEXI
12925824d651Sblueswir1@item -hdachs @var{c},@var{h},@var{s},[,@var{t}]
12935824d651Sblueswir1Force hard disk 0 physical geometry (1 <= @var{c} <= 16383, 1 <=
12945824d651Sblueswir1@var{h} <= 16, 1 <= @var{s} <= 63) and optionally force the BIOS
12955824d651Sblueswir1translation mode (@var{t}=none, lba or auto). Usually QEMU can guess
12965824d651Sblueswir1all those parameters. This option is useful for old MS-DOS disk
12975824d651Sblueswir1images.
12985824d651Sblueswir1ETEXI
12995824d651Sblueswir1
13005824d651Sblueswir1DEF("L", HAS_ARG, QEMU_OPTION_L, \
13015824d651Sblueswir1    "-L path         set the directory for the BIOS, VGA BIOS and keymaps\n")
13025824d651Sblueswir1STEXI
13035824d651Sblueswir1@item -L  @var{path}
13045824d651Sblueswir1Set the directory for the BIOS, VGA BIOS and keymaps.
13055824d651Sblueswir1ETEXI
13065824d651Sblueswir1
13075824d651Sblueswir1DEF("bios", HAS_ARG, QEMU_OPTION_bios, \
13085824d651Sblueswir1    "-bios file      set the filename for the BIOS\n")
13095824d651Sblueswir1STEXI
13105824d651Sblueswir1@item -bios @var{file}
13115824d651Sblueswir1Set the filename for the BIOS.
13125824d651Sblueswir1ETEXI
13135824d651Sblueswir1
1314640f42e4Sblueswir1#ifdef CONFIG_KQEMU
13155824d651Sblueswir1DEF("kernel-kqemu", 0, QEMU_OPTION_kernel_kqemu, \
13165824d651Sblueswir1    "-kernel-kqemu   enable KQEMU full virtualization (default is user mode only)\n")
13175824d651Sblueswir1#endif
13185824d651Sblueswir1STEXI
13195824d651Sblueswir1@item -kernel-kqemu
13205824d651Sblueswir1Enable KQEMU full virtualization (default is user mode only).
13215824d651Sblueswir1ETEXI
13225824d651Sblueswir1
1323640f42e4Sblueswir1#ifdef CONFIG_KQEMU
13245824d651Sblueswir1DEF("no-kqemu", 0, QEMU_OPTION_no_kqemu, \
13255824d651Sblueswir1    "-no-kqemu       disable KQEMU kernel module usage\n")
13265824d651Sblueswir1#endif
13275824d651Sblueswir1STEXI
13285824d651Sblueswir1@item -no-kqemu
13295824d651Sblueswir1Disable KQEMU kernel module usage. KQEMU options are only available if
13305824d651Sblueswir1KQEMU support is enabled when compiling.
13315824d651Sblueswir1ETEXI
13325824d651Sblueswir1
13335824d651Sblueswir1#ifdef CONFIG_KVM
13345824d651Sblueswir1DEF("enable-kvm", 0, QEMU_OPTION_enable_kvm, \
13355824d651Sblueswir1    "-enable-kvm     enable KVM full virtualization support\n")
13365824d651Sblueswir1#endif
13375824d651Sblueswir1STEXI
13385824d651Sblueswir1@item -enable-kvm
13395824d651Sblueswir1Enable KVM full virtualization support. This option is only available
13405824d651Sblueswir1if KVM support is enabled when compiling.
13415824d651Sblueswir1ETEXI
13425824d651Sblueswir1
13435824d651Sblueswir1DEF("no-reboot", 0, QEMU_OPTION_no_reboot, \
13445824d651Sblueswir1    "-no-reboot      exit instead of rebooting\n")
13455824d651Sblueswir1STEXI
13465824d651Sblueswir1@item -no-reboot
13475824d651Sblueswir1Exit instead of rebooting.
13485824d651Sblueswir1ETEXI
13495824d651Sblueswir1
13505824d651Sblueswir1DEF("no-shutdown", 0, QEMU_OPTION_no_shutdown, \
13515824d651Sblueswir1    "-no-shutdown    stop before shutdown\n")
13525824d651Sblueswir1STEXI
13535824d651Sblueswir1@item -no-shutdown
13545824d651Sblueswir1Don't exit QEMU on guest shutdown, but instead only stop the emulation.
13555824d651Sblueswir1This allows for instance switching to monitor to commit changes to the
13565824d651Sblueswir1disk image.
13575824d651Sblueswir1ETEXI
13585824d651Sblueswir1
13595824d651Sblueswir1DEF("loadvm", HAS_ARG, QEMU_OPTION_loadvm, \
13605824d651Sblueswir1    "-loadvm [tag|id]\n" \
13615824d651Sblueswir1    "                start right away with a saved state (loadvm in monitor)\n")
13625824d651Sblueswir1STEXI
13635824d651Sblueswir1@item -loadvm @var{file}
13645824d651Sblueswir1Start right away with a saved state (@code{loadvm} in monitor)
13655824d651Sblueswir1ETEXI
13665824d651Sblueswir1
13675824d651Sblueswir1#ifndef _WIN32
13685824d651Sblueswir1DEF("daemonize", 0, QEMU_OPTION_daemonize, \
13695824d651Sblueswir1    "-daemonize      daemonize QEMU after initializing\n")
13705824d651Sblueswir1#endif
13715824d651Sblueswir1STEXI
13725824d651Sblueswir1@item -daemonize
13735824d651Sblueswir1Daemonize the QEMU process after initialization.  QEMU will not detach from
13745824d651Sblueswir1standard IO until it is ready to receive connections on any of its devices.
13755824d651Sblueswir1This option is a useful way for external programs to launch QEMU without having
13765824d651Sblueswir1to cope with initialization race conditions.
13775824d651Sblueswir1ETEXI
13785824d651Sblueswir1
13795824d651Sblueswir1DEF("option-rom", HAS_ARG, QEMU_OPTION_option_rom, \
13805824d651Sblueswir1    "-option-rom rom load a file, rom, into the option ROM space\n")
13815824d651Sblueswir1STEXI
13825824d651Sblueswir1@item -option-rom @var{file}
13835824d651Sblueswir1Load the contents of @var{file} as an option ROM.
13845824d651Sblueswir1This option is useful to load things like EtherBoot.
13855824d651Sblueswir1ETEXI
13865824d651Sblueswir1
13875824d651Sblueswir1DEF("clock", HAS_ARG, QEMU_OPTION_clock, \
13885824d651Sblueswir1    "-clock          force the use of the given methods for timer alarm.\n" \
13895824d651Sblueswir1    "                To see what timers are available use -clock ?\n")
13905824d651Sblueswir1STEXI
13915824d651Sblueswir1@item -clock @var{method}
13925824d651Sblueswir1Force the use of the given methods for timer alarm. To see what timers
13935824d651Sblueswir1are available use -clock ?.
13945824d651Sblueswir1ETEXI
13955824d651Sblueswir1
13965824d651Sblueswir1DEF("localtime", 0, QEMU_OPTION_localtime, \
13975824d651Sblueswir1    "-localtime      set the real time clock to local time [default=utc]\n")
13985824d651Sblueswir1STEXI
13995824d651Sblueswir1@item -localtime
14005824d651Sblueswir1Set the real time clock to local time (the default is to UTC
14015824d651Sblueswir1time). This option is needed to have correct date in MS-DOS or
14025824d651Sblueswir1Windows.
14035824d651Sblueswir1ETEXI
14045824d651Sblueswir1
14055824d651Sblueswir1DEF("startdate", HAS_ARG, QEMU_OPTION_startdate, \
14065824d651Sblueswir1    "-startdate      select initial date of the clock\n")
14075824d651Sblueswir1STEXI
14085824d651Sblueswir1
14095824d651Sblueswir1@item -startdate @var{date}
14105824d651Sblueswir1Set the initial date of the real time clock. Valid formats for
14115824d651Sblueswir1@var{date} are: @code{now} or @code{2006-06-17T16:01:21} or
14125824d651Sblueswir1@code{2006-06-17}. The default value is @code{now}.
14135824d651Sblueswir1ETEXI
14145824d651Sblueswir1
14155824d651Sblueswir1DEF("icount", HAS_ARG, QEMU_OPTION_icount, \
14165824d651Sblueswir1    "-icount [N|auto]\n" \
1417bc14ca24Saliguori    "                enable virtual instruction counter with 2^N clock ticks per\n" \
1418bc14ca24Saliguori    "                instruction\n")
14195824d651Sblueswir1STEXI
14205824d651Sblueswir1@item -icount [N|auto]
14215824d651Sblueswir1Enable virtual instruction counter.  The virtual cpu will execute one
14225824d651Sblueswir1instruction every 2^N ns of virtual time.  If @code{auto} is specified
14235824d651Sblueswir1then the virtual cpu speed will be automatically adjusted to keep virtual
14245824d651Sblueswir1time within a few seconds of real time.
14255824d651Sblueswir1
14265824d651Sblueswir1Note that while this option can give deterministic behavior, it does not
14275824d651Sblueswir1provide cycle accurate emulation.  Modern CPUs contain superscalar out of
14285824d651Sblueswir1order cores with complex cache hierarchies.  The number of instructions
14295824d651Sblueswir1executed often has little or no correlation with actual performance.
14305824d651Sblueswir1ETEXI
14315824d651Sblueswir1
14325824d651Sblueswir1DEF("echr", HAS_ARG, QEMU_OPTION_echr, \
14335824d651Sblueswir1    "-echr chr       set terminal escape character instead of ctrl-a\n")
14345824d651Sblueswir1STEXI
14355824d651Sblueswir1
14365824d651Sblueswir1@item -echr numeric_ascii_value
14375824d651Sblueswir1Change the escape character used for switching to the monitor when using
14385824d651Sblueswir1monitor and serial sharing.  The default is @code{0x01} when using the
14395824d651Sblueswir1@code{-nographic} option.  @code{0x01} is equal to pressing
14405824d651Sblueswir1@code{Control-a}.  You can select a different character from the ascii
14415824d651Sblueswir1control keys where 1 through 26 map to Control-a through Control-z.  For
14425824d651Sblueswir1instance you could use the either of the following to change the escape
14435824d651Sblueswir1character to Control-t.
14445824d651Sblueswir1@table @code
14455824d651Sblueswir1@item -echr 0x14
14465824d651Sblueswir1@item -echr 20
14475824d651Sblueswir1@end table
14485824d651Sblueswir1ETEXI
14495824d651Sblueswir1
14505824d651Sblueswir1DEF("virtioconsole", HAS_ARG, QEMU_OPTION_virtiocon, \
14515824d651Sblueswir1    "-virtioconsole c\n" \
14525824d651Sblueswir1    "                set virtio console\n")
14535824d651Sblueswir1STEXI
14545824d651Sblueswir1@item -virtioconsole @var{c}
14555824d651Sblueswir1Set virtio console.
14565824d651Sblueswir1ETEXI
14575824d651Sblueswir1
14585824d651Sblueswir1DEF("show-cursor", 0, QEMU_OPTION_show_cursor, \
14595824d651Sblueswir1    "-show-cursor    show cursor\n")
14605824d651Sblueswir1STEXI
14615824d651Sblueswir1ETEXI
14625824d651Sblueswir1
14635824d651Sblueswir1DEF("tb-size", HAS_ARG, QEMU_OPTION_tb_size, \
14645824d651Sblueswir1    "-tb-size n      set TB size\n")
14655824d651Sblueswir1STEXI
14665824d651Sblueswir1ETEXI
14675824d651Sblueswir1
14685824d651Sblueswir1DEF("incoming", HAS_ARG, QEMU_OPTION_incoming, \
14695824d651Sblueswir1    "-incoming p     prepare for incoming migration, listen on port p\n")
14705824d651Sblueswir1STEXI
14715824d651Sblueswir1ETEXI
14725824d651Sblueswir1
14735824d651Sblueswir1#ifndef _WIN32
14745824d651Sblueswir1DEF("chroot", HAS_ARG, QEMU_OPTION_chroot, \
14755824d651Sblueswir1    "-chroot dir     Chroot to dir just before starting the VM.\n")
14765824d651Sblueswir1#endif
14775824d651Sblueswir1STEXI
14785824d651Sblueswir1@item -chroot dir
14795824d651Sblueswir1Immediately before starting guest execution, chroot to the specified
14805824d651Sblueswir1directory.  Especially useful in combination with -runas.
14815824d651Sblueswir1ETEXI
14825824d651Sblueswir1
14835824d651Sblueswir1#ifndef _WIN32
14845824d651Sblueswir1DEF("runas", HAS_ARG, QEMU_OPTION_runas, \
14855824d651Sblueswir1    "-runas user     Change to user id user just before starting the VM.\n")
14865824d651Sblueswir1#endif
14875824d651Sblueswir1STEXI
14885824d651Sblueswir1@item -runas user
14895824d651Sblueswir1Immediately before starting guest execution, drop root privileges, switching
14905824d651Sblueswir1to the specified user.
14915824d651Sblueswir1ETEXI
14925824d651Sblueswir1
14935824d651Sblueswir1STEXI
14945824d651Sblueswir1@end table
14955824d651Sblueswir1ETEXI
14965824d651Sblueswir1
14975824d651Sblueswir1#if defined(TARGET_SPARC) || defined(TARGET_PPC)
14985824d651Sblueswir1DEF("prom-env", HAS_ARG, QEMU_OPTION_prom_env,
14995824d651Sblueswir1    "-prom-env variable=value\n"
15005824d651Sblueswir1    "                set OpenBIOS nvram variables\n")
15015824d651Sblueswir1#endif
15025824d651Sblueswir1#if defined(TARGET_ARM) || defined(TARGET_M68K)
15035824d651Sblueswir1DEF("semihosting", 0, QEMU_OPTION_semihosting,
15045824d651Sblueswir1    "-semihosting    semihosting mode\n")
15055824d651Sblueswir1#endif
15065824d651Sblueswir1#if defined(TARGET_ARM)
15075824d651Sblueswir1DEF("old-param", 0, QEMU_OPTION_old_param,
15085824d651Sblueswir1    "-old-param      old param mode\n")
15095824d651Sblueswir1#endif
1510