X-Git-Url: https://git.proxmox.com/?a=blobdiff_plain;f=qemu-options.hx;h=82e085a2298183d47c8aa18d13b5e60c563beb43;hb=f4f61d272e26ca34612c05070dfbda86dc00298b;hp=8450b455ac6561bdae90d2534549899acd367f53;hpb=609c1daced7f444f9f6569bba72d6a56a697ac95;p=qemu.git diff --git a/qemu-options.hx b/qemu-options.hx index 8450b455a..82e085a22 100644 --- a/qemu-options.hx +++ b/qemu-options.hx @@ -1,8 +1,9 @@ HXCOMM Use DEFHEADING() to define headings in both help text and texi HXCOMM Text between STEXI and ETEXI are copied to texi version and HXCOMM discarded from C version -HXCOMM DEF(option, HAS_ARG/0, opt_enum, opt_help) is used to construct -HXCOMM option structures, enums and help message. +HXCOMM DEF(option, HAS_ARG/0, opt_enum, opt_help, arch_mask) is used to +HXCOMM construct option structures, enums and help message for specified +HXCOMM architectures. HXCOMM HXCOMM can be used for comments, discarded from both texi and C DEFHEADING(Standard options:) @@ -11,7 +12,7 @@ STEXI ETEXI DEF("help", 0, QEMU_OPTION_h, - "-h or -help display this help and exit\n") + "-h or -help display this help and exit\n", QEMU_ARCH_ALL) STEXI @item -h @findex -h @@ -19,7 +20,7 @@ Display help and exit ETEXI DEF("version", 0, QEMU_OPTION_version, - "-version display version information and exit\n") + "-version display version information and exit\n", QEMU_ARCH_ALL) STEXI @item -version @findex -version @@ -27,7 +28,7 @@ Display version information and exit ETEXI DEF("M", HAS_ARG, QEMU_OPTION_M, - "-M machine select emulated machine (-M ? for list)\n") + "-M machine select emulated machine (-M ? for list)\n", QEMU_ARCH_ALL) STEXI @item -M @var{machine} @findex -M @@ -35,7 +36,7 @@ Select the emulated @var{machine} (@code{-M ?} for list) ETEXI DEF("cpu", HAS_ARG, QEMU_OPTION_cpu, - "-cpu cpu select CPU (-cpu ? for list)\n") + "-cpu cpu select CPU (-cpu ? for list)\n", QEMU_ARCH_ALL) STEXI @item -cpu @var{model} @findex -cpu @@ -49,7 +50,8 @@ DEF("smp", HAS_ARG, QEMU_OPTION_smp, " offline CPUs for hotplug, etc\n" " cores= number of CPU cores on one socket\n" " threads= number of threads on one CPU core\n" - " sockets= number of discrete sockets in the system\n") + " sockets= number of discrete sockets in the system\n", + QEMU_ARCH_ALL) STEXI @item -smp @var{n}[,cores=@var{cores}][,threads=@var{threads}][,sockets=@var{sockets}][,maxcpus=@var{maxcpus}] @findex -smp @@ -64,7 +66,7 @@ specifies the maximum number of hotpluggable CPUs. ETEXI DEF("numa", HAS_ARG, QEMU_OPTION_numa, - "-numa node[,mem=size][,cpus=cpu[-cpu]][,nodeid=node]\n") + "-numa node[,mem=size][,cpus=cpu[-cpu]][,nodeid=node]\n", QEMU_ARCH_ALL) STEXI @item -numa @var{opts} @findex -numa @@ -73,8 +75,8 @@ are split equally. ETEXI DEF("fda", HAS_ARG, QEMU_OPTION_fda, - "-fda/-fdb file use 'file' as floppy disk 0/1 image\n") -DEF("fdb", HAS_ARG, QEMU_OPTION_fdb, "") + "-fda/-fdb file use 'file' as floppy disk 0/1 image\n", QEMU_ARCH_ALL) +DEF("fdb", HAS_ARG, QEMU_OPTION_fdb, "", QEMU_ARCH_ALL) STEXI @item -fda @var{file} @item -fdb @var{file} @@ -85,11 +87,11 @@ use the host floppy by using @file{/dev/fd0} as filename (@pxref{host_drives}). ETEXI DEF("hda", HAS_ARG, QEMU_OPTION_hda, - "-hda/-hdb file use 'file' as IDE hard disk 0/1 image\n") -DEF("hdb", HAS_ARG, QEMU_OPTION_hdb, "") + "-hda/-hdb file use 'file' as IDE hard disk 0/1 image\n", QEMU_ARCH_ALL) +DEF("hdb", HAS_ARG, QEMU_OPTION_hdb, "", QEMU_ARCH_ALL) DEF("hdc", HAS_ARG, QEMU_OPTION_hdc, - "-hdc/-hdd file use 'file' as IDE hard disk 2/3 image\n") -DEF("hdd", HAS_ARG, QEMU_OPTION_hdd, "") + "-hdc/-hdd file use 'file' as IDE hard disk 2/3 image\n", QEMU_ARCH_ALL) +DEF("hdd", HAS_ARG, QEMU_OPTION_hdd, "", QEMU_ARCH_ALL) STEXI @item -hda @var{file} @item -hdb @var{file} @@ -103,7 +105,8 @@ Use @var{file} as hard disk 0, 1, 2 or 3 image (@pxref{disk_images}). ETEXI DEF("cdrom", HAS_ARG, QEMU_OPTION_cdrom, - "-cdrom file use 'file' as IDE cdrom image (cdrom is ide1 master)\n") + "-cdrom file use 'file' as IDE cdrom image (cdrom is ide1 master)\n", + QEMU_ARCH_ALL) STEXI @item -cdrom @var{file} @findex -cdrom @@ -115,9 +118,10 @@ ETEXI DEF("drive", HAS_ARG, QEMU_OPTION_drive, "-drive [file=file][,if=type][,bus=n][,unit=m][,media=d][,index=i]\n" " [,cyls=c,heads=h,secs=s[,trans=t]][,snapshot=on|off]\n" - " [,cache=writethrough|writeback|none][,format=f][,serial=s]\n" - " [,addr=A][,id=name][,aio=threads|native][,readonly=on|off]\n" - " use 'file' as a drive image\n") + " [,cache=writethrough|writeback|none|unsafe][,format=f]\n" + " [,serial=s][,addr=A][,id=name][,aio=threads|native]\n" + " [,readonly=on|off]\n" + " use 'file' as a drive image\n", QEMU_ARCH_ALL) STEXI @item -drive @var{option}[,@var{option}[,@var{option}[,...]]] @findex -drive @@ -145,7 +149,7 @@ These options have the same definition as they have in @option{-hdachs}. @item snapshot=@var{snapshot} @var{snapshot} is "on" or "off" and allows to enable snapshot for given drive (see @option{-snapshot}). @item cache=@var{cache} -@var{cache} is "none", "writeback", or "writethrough" and controls how the host cache is used to access block data. +@var{cache} is "none", "writeback", "unsafe", or "writethrough" and controls how the host cache is used to access block data. @item aio=@var{aio} @var{aio} is "threads", or "native" and selects between pthread based disk I/O and native Linux AIO. @item format=@var{format} @@ -166,8 +170,7 @@ the storage subsystem. Writeback caching will report data writes as completed as soon as the data is present in the host page cache. This is safe as long as you trust your host. If your host crashes or loses power, then the guest may experience data -corruption. When using the @option{-snapshot} option, writeback caching is -used by default. +corruption. The host page cache can be avoided entirely with @option{cache=none}. This will attempt to do disk IO directly to the guests memory. QEMU may still perform @@ -177,6 +180,13 @@ Some block drivers perform badly with @option{cache=writethrough}, most notably, qcow2. If performance is more important than correctness, @option{cache=writeback} should be used with qcow2. +In case you don't care about data integrity over host failures, use +cache=unsafe. This option tells qemu that it never needs to write any data +to the disk but can instead keeps things in cache. If anything goes wrong, +like your host losing power, the disk storage getting disconnected accidently, +etc. you're image will most probably be rendered unusable. When using +the @option{-snapshot} option, unsafe caching is always used. + Instead of @option{-cdrom} you can use: @example qemu -drive file=file,index=2,media=cdrom @@ -226,7 +236,7 @@ ETEXI DEF("set", HAS_ARG, QEMU_OPTION_set, "-set group.id.arg=value\n" " set parameter for item of type \n" - " i.e. -set drive.$id.file=/path/to/image\n") + " i.e. -set drive.$id.file=/path/to/image\n", QEMU_ARCH_ALL) STEXI @item -set @findex -set @@ -235,7 +245,8 @@ ETEXI DEF("global", HAS_ARG, QEMU_OPTION_global, "-global driver.property=value\n" - " set a global default for a driver property\n") + " set a global default for a driver property\n", + QEMU_ARCH_ALL) STEXI @item -global @findex -global @@ -243,7 +254,8 @@ TODO ETEXI DEF("mtdblock", HAS_ARG, QEMU_OPTION_mtdblock, - "-mtdblock file use 'file' as on-board Flash memory image\n") + "-mtdblock file use 'file' as on-board Flash memory image\n", + QEMU_ARCH_ALL) STEXI @item -mtdblock @var{file} @findex -mtdblock @@ -251,7 +263,7 @@ Use @var{file} as on-board Flash memory image. ETEXI DEF("sd", HAS_ARG, QEMU_OPTION_sd, - "-sd file use 'file' as SecureDigital card image\n") + "-sd file use 'file' as SecureDigital card image\n", QEMU_ARCH_ALL) STEXI @item -sd @var{file} @findex -sd @@ -259,7 +271,7 @@ Use @var{file} as SecureDigital card image. ETEXI DEF("pflash", HAS_ARG, QEMU_OPTION_pflash, - "-pflash file use 'file' as a parallel flash image\n") + "-pflash file use 'file' as a parallel flash image\n", QEMU_ARCH_ALL) STEXI @item -pflash @var{file} @findex -pflash @@ -268,7 +280,8 @@ ETEXI DEF("boot", HAS_ARG, QEMU_OPTION_boot, "-boot [order=drives][,once=drives][,menu=on|off]\n" - " 'drives': floppy (a), hard disk (c), CD-ROM (d), network (n)\n") + " 'drives': floppy (a), hard disk (c), CD-ROM (d), network (n)\n", + QEMU_ARCH_ALL) STEXI @item -boot [order=@var{drives}][,once=@var{drives}][,menu=on|off] @findex -boot @@ -294,7 +307,8 @@ use is discouraged as it may be removed from future versions. ETEXI DEF("snapshot", 0, QEMU_OPTION_snapshot, - "-snapshot write to temporary files instead of disk image files\n") + "-snapshot write to temporary files instead of disk image files\n", + QEMU_ARCH_ALL) STEXI @item -snapshot @findex -snapshot @@ -305,7 +319,7 @@ ETEXI DEF("m", HAS_ARG, QEMU_OPTION_m, "-m megs set virtual RAM size to megs MB [default=" - stringify(DEFAULT_RAM_SIZE) "]\n") + stringify(DEFAULT_RAM_SIZE) "]\n", QEMU_ARCH_ALL) STEXI @item -m @var{megs} @findex -m @@ -315,7 +329,7 @@ gigabytes respectively. ETEXI DEF("mem-path", HAS_ARG, QEMU_OPTION_mempath, - "-mem-path FILE provide backing storage for guest RAM\n") + "-mem-path FILE provide backing storage for guest RAM\n", QEMU_ARCH_ALL) STEXI @item -mem-path @var{path} Allocate guest RAM from a temporarily created file in @var{path}. @@ -323,7 +337,8 @@ ETEXI #ifdef MAP_POPULATE DEF("mem-prealloc", 0, QEMU_OPTION_mem_prealloc, - "-mem-prealloc preallocate guest memory (use with -mem-path)\n") + "-mem-prealloc preallocate guest memory (use with -mem-path)\n", + QEMU_ARCH_ALL) STEXI @item -mem-prealloc Preallocate memory when using -mem-path. @@ -331,7 +346,8 @@ ETEXI #endif DEF("k", HAS_ARG, QEMU_OPTION_k, - "-k language use keyboard layout (for example 'fr' for French)\n") + "-k language use keyboard layout (for example 'fr' for French)\n", + QEMU_ARCH_ALL) STEXI @item -k @var{language} @findex -k @@ -352,10 +368,9 @@ The default is @code{en-us}. ETEXI -#ifdef HAS_AUDIO DEF("audio-help", 0, QEMU_OPTION_audio_help, - "-audio-help print list of audio drivers and their options\n") -#endif + "-audio-help print list of audio drivers and their options\n", + QEMU_ARCH_ALL) STEXI @item -audio-help @findex -audio-help @@ -363,13 +378,11 @@ Will show the audio subsystem help: list of drivers, tunable parameters. ETEXI -#ifdef HAS_AUDIO DEF("soundhw", HAS_ARG, QEMU_OPTION_soundhw, "-soundhw c1,... enable audio support\n" " and only specified sound cards (comma separated list)\n" " use -soundhw ? to get the list of supported cards\n" - " use -soundhw all to enable all of them\n") -#endif + " use -soundhw all to enable all of them\n", QEMU_ARCH_ALL) STEXI @item -soundhw @var{card1}[,@var{card2},...] or -soundhw all @findex -soundhw @@ -380,6 +393,7 @@ available sound hardware. qemu -soundhw sb16,adlib disk.img qemu -soundhw es1370 disk.img qemu -soundhw ac97 disk.img +qemu -soundhw hda disk.img qemu -soundhw all disk.img qemu -soundhw ? @end example @@ -397,7 +411,8 @@ STEXI ETEXI DEF("usb", 0, QEMU_OPTION_usb, - "-usb enable the USB driver (will be the default soon)\n") + "-usb enable the USB driver (will be the default soon)\n", + QEMU_ARCH_ALL) STEXI USB options: @table @option @@ -408,7 +423,8 @@ Enable the USB driver (will be the default soon) ETEXI DEF("usbdevice", HAS_ARG, QEMU_OPTION_usbdevice, - "-usbdevice name add the host or guest USB device 'name'\n") + "-usbdevice name add the host or guest USB device 'name'\n", + QEMU_ARCH_ALL) STEXI @item -usbdevice @var{devname} @@ -456,23 +472,94 @@ DEF("device", HAS_ARG, QEMU_OPTION_device, " add device (based on driver)\n" " prop=value,... sets driver properties\n" " use -device ? to print all possible drivers\n" - " use -device driver,? to print all possible options\n" - " use -device driver,option=? to print a help for value\n") + " use -device driver,? to print all possible properties\n", + QEMU_ARCH_ALL) STEXI -@item -device @var{driver}[,@var{option}[=@var{value}][,...]] +@item -device @var{driver}[,@var{prop}[=@var{value}][,...]] @findex -device -Add device @var{driver}. Depending on the device type, -@var{option} (with default or given @var{value}) may be useful. -To get a help on possible @var{driver}s, @var{option}s or @var{value}s, use -@code{-device ?}, -@code{-device @var{driver},?} or -@code{-device @var{driver},@var{option}=?}. +Add device @var{driver}. @var{prop}=@var{value} sets driver +properties. Valid properties depend on the driver. To get help on +possible drivers and properties, use @code{-device ?} and +@code{-device @var{driver},?}. +ETEXI + +DEFHEADING(File system options:) + +DEF("fsdev", HAS_ARG, QEMU_OPTION_fsdev, + "-fsdev local,id=id,path=path,security_model=[mapped|passthrough|none]\n", + QEMU_ARCH_ALL) + +STEXI + +The general form of a File system device option is: +@table @option + +@item -fsdev @var{fstype} ,id=@var{id} [,@var{options}] +@findex -fsdev +Fstype is one of: +@option{local}, +The specific Fstype will determine the applicable options. + +Options to each backend are described below. + +@item -fsdev local ,id=@var{id} ,path=@var{path} ,security_model=@var{security_model} + +Create a file-system-"device" for local-filesystem. + +@option{local} is only available on Linux. + +@option{path} specifies the path to be exported. @option{path} is required. + +@option{security_model} specifies the security model to be followed. +@option{security_model} is required. + +@end table ETEXI +DEFHEADING(Virtual File system pass-through options:) + +DEF("virtfs", HAS_ARG, QEMU_OPTION_virtfs, + "-virtfs local,path=path,mount_tag=tag,security_model=[mapped|passthrough|none]\n", + QEMU_ARCH_ALL) + +STEXI + +The general form of a Virtual File system pass-through option is: +@table @option + +@item -virtfs @var{fstype} [,@var{options}] +@findex -virtfs +Fstype is one of: +@option{local}, +The specific Fstype will determine the applicable options. + +Options to each backend are described below. + +@item -virtfs local ,path=@var{path} ,mount_tag=@var{mount_tag} ,security_model=@var{security_model} + +Create a Virtual file-system-pass through for local-filesystem. + +@option{local} is only available on Linux. + +@option{path} specifies the path to be exported. @option{path} is required. + +@option{security_model} specifies the security model to be followed. +@option{security_model} is required. + + +@option{mount_tag} specifies the tag with which the exported file is mounted. +@option{mount_tag} is required. + +@end table +ETEXI + +DEFHEADING() + DEF("name", HAS_ARG, QEMU_OPTION_name, "-name string1[,process=string2]\n" " set the name of the guest\n" - " string1 sets the window title and string2 the process name (on Linux)\n") + " string1 sets the window title and string2 the process name (on Linux)\n", + QEMU_ARCH_ALL) STEXI @item -name @var{name} @findex -name @@ -484,7 +571,7 @@ ETEXI DEF("uuid", HAS_ARG, QEMU_OPTION_uuid, "-uuid %08x-%04x-%04x-%04x-%012x\n" - " specify machine UUID\n") + " specify machine UUID\n", QEMU_ARCH_ALL) STEXI @item -uuid @var{uuid} @findex -uuid @@ -503,8 +590,40 @@ STEXI @table @option ETEXI +DEF("display", HAS_ARG, QEMU_OPTION_display, + "-display sdl[,frame=on|off][,alt_grab=on|off][,ctrl_grab=on|off]\n" + " [,window_close=on|off]|curses|none|\n" + " vnc=[,]\n" + " select display type\n", QEMU_ARCH_ALL) +STEXI +@item -display @var{type} +@findex -display +Select type of display to use. This option is a replacement for the +old style -sdl/-curses/... options. Valid values for @var{type} are +@table @option +@item sdl +Display video output via SDL (usually in a separate graphics +window; see the SDL documentation for other possibilities). +@item curses +Display video output via curses. For graphics device models which +support a text mode, QEMU can display this output using a +curses/ncurses interface. Nothing is displayed when the graphics +device is in graphical mode or if the graphics device does not support +a text mode. Generally only the VGA device models support text mode. +@item none +Do not display video output. The guest will still see an emulated +graphics card, but its output will not be displayed to the QEMU +user. This option differs from the -nographic option in that it +only affects what is done with video output; -nographic also changes +the destination of the serial and parallel port data. +@item vnc +Start a VNC server on display +@end table +ETEXI + DEF("nographic", 0, QEMU_OPTION_nographic, - "-nographic disable graphical output and redirect serial I/Os to console\n") + "-nographic disable graphical output and redirect serial I/Os to console\n", + QEMU_ARCH_ALL) STEXI @item -nographic @findex -nographic @@ -515,10 +634,9 @@ the console. Therefore, you can still use QEMU to debug a Linux kernel with a serial console. ETEXI -#ifdef CONFIG_CURSES DEF("curses", 0, QEMU_OPTION_curses, - "-curses use a curses/ncurses interface instead of SDL\n") -#endif + "-curses use a curses/ncurses interface instead of SDL\n", + QEMU_ARCH_ALL) STEXI @item -curses @findex curses @@ -527,10 +645,9 @@ QEMU can display the VGA output when in text mode using a curses/ncurses interface. Nothing is displayed in graphical mode. ETEXI -#ifdef CONFIG_SDL DEF("no-frame", 0, QEMU_OPTION_no_frame, - "-no-frame open SDL window without a frame and window decorations\n") -#endif + "-no-frame open SDL window without a frame and window decorations\n", + QEMU_ARCH_ALL) STEXI @item -no-frame @findex -no-frame @@ -539,48 +656,115 @@ available screen space. This makes the using QEMU in a dedicated desktop workspace more convenient. ETEXI -#ifdef CONFIG_SDL DEF("alt-grab", 0, QEMU_OPTION_alt_grab, - "-alt-grab use Ctrl-Alt-Shift to grab mouse (instead of Ctrl-Alt)\n") -#endif + "-alt-grab use Ctrl-Alt-Shift to grab mouse (instead of Ctrl-Alt)\n", + QEMU_ARCH_ALL) STEXI @item -alt-grab @findex -alt-grab -Use Ctrl-Alt-Shift to grab mouse (instead of Ctrl-Alt). +Use Ctrl-Alt-Shift to grab mouse (instead of Ctrl-Alt). Note that this also +affects the special keys (for fullscreen, monitor-mode switching, etc). ETEXI -#ifdef CONFIG_SDL DEF("ctrl-grab", 0, QEMU_OPTION_ctrl_grab, - "-ctrl-grab use Right-Ctrl to grab mouse (instead of Ctrl-Alt)\n") -#endif + "-ctrl-grab use Right-Ctrl to grab mouse (instead of Ctrl-Alt)\n", + QEMU_ARCH_ALL) STEXI @item -ctrl-grab @findex -ctrl-grab -Use Right-Ctrl to grab mouse (instead of Ctrl-Alt). +Use Right-Ctrl to grab mouse (instead of Ctrl-Alt). Note that this also +affects the special keys (for fullscreen, monitor-mode switching, etc). ETEXI -#ifdef CONFIG_SDL DEF("no-quit", 0, QEMU_OPTION_no_quit, - "-no-quit disable SDL window close capability\n") -#endif + "-no-quit disable SDL window close capability\n", QEMU_ARCH_ALL) STEXI @item -no-quit @findex -no-quit Disable SDL window close capability. ETEXI -#ifdef CONFIG_SDL DEF("sdl", 0, QEMU_OPTION_sdl, - "-sdl enable SDL\n") -#endif + "-sdl enable SDL\n", QEMU_ARCH_ALL) STEXI @item -sdl @findex -sdl Enable SDL. ETEXI +DEF("spice", HAS_ARG, QEMU_OPTION_spice, + "-spice enable spice\n", QEMU_ARCH_ALL) +STEXI +@item -spice @var{option}[,@var{option}[,...]] +@findex -spice +Enable the spice remote desktop protocol. Valid options are + +@table @option + +@item port= +Set the TCP port spice is listening on for plaintext channels. + +@item addr= +Set the IP address spice is listening on. Default is any address. + +@item ipv4 +@item ipv6 +Force using the specified IP version. + +@item password= +Set the password you need to authenticate. + +@item disable-ticketing +Allow client connects without authentication. + +@item tls-port= +Set the TCP port spice is listening on for encrypted channels. + +@item x509-dir= +Set the x509 file directory. Expects same filenames as -vnc $display,x509=$dir + +@item x509-key-file= +@item x509-key-password= +@item x509-cert-file= +@item x509-cacert-file= +@item x509-dh-key-file= +The x509 file names can also be configured individually. + +@item tls-ciphers= +Specify which ciphers to use. + +@item tls-channel=[main|display|inputs|record|playback|tunnel] +@item plaintext-channel=[main|display|inputs|record|playback|tunnel] +Force specific channel to be used with or without TLS encryption. The +options can be specified multiple times to configure multiple +channels. The special name "default" can be used to set the default +mode. For channels which are not explicitly forced into one mode the +spice client is allowed to pick tls/plaintext as he pleases. + +@item image-compression=[auto_glz|auto_lz|quic|glz|lz|off] +Configure image compression (lossless). +Default is auto_glz. + +@item jpeg-wan-compression=[auto|never|always] +@item zlib-glz-wan-compression=[auto|never|always] +Configure wan image compression (lossy for slow links). +Default is auto. + +@item streaming-video=[off|all|filter] +Configure video stream detection. Default is filter. + +@item agent-mouse=[on|off] +Enable/disable passing mouse events via vdagent. Default is on. + +@item playback-compression=[on|off] +Enable/disable audio stream compression (using celt 0.5.1). Default is on. + +@end table +ETEXI + DEF("portrait", 0, QEMU_OPTION_portrait, - "-portrait rotate graphical output 90 deg left (only PXA LCD)\n") + "-portrait rotate graphical output 90 deg left (only PXA LCD)\n", + QEMU_ARCH_ALL) STEXI @item -portrait @findex -portrait @@ -588,8 +772,8 @@ Rotate graphical output 90 deg left (only PXA LCD). ETEXI DEF("vga", HAS_ARG, QEMU_OPTION_vga, - "-vga [std|cirrus|vmware|xenfb|none]\n" - " select video card type\n") + "-vga [std|cirrus|vmware|qxl|xenfb|none]\n" + " select video card type\n", QEMU_ARCH_ALL) STEXI @item -vga @var{type} @findex -vga @@ -609,23 +793,26 @@ this option. VMWare SVGA-II compatible adapter. Use it if you have sufficiently recent XFree86/XOrg server or Windows guest with a driver for this card. +@item qxl +QXL paravirtual graphic card. It is VGA compatible (including VESA +2.0 VBE support). Works best with qxl guest drivers installed though. +Recommended choice when using the spice protocol. @item none Disable VGA card. @end table ETEXI DEF("full-screen", 0, QEMU_OPTION_full_screen, - "-full-screen start in full screen\n") + "-full-screen start in full screen\n", QEMU_ARCH_ALL) STEXI @item -full-screen @findex -full-screen Start in full screen. ETEXI -#if defined(TARGET_PPC) || defined(TARGET_SPARC) DEF("g", 1, QEMU_OPTION_g , - "-g WxH[xDEPTH] Set the initial graphical resolution and depth\n") -#endif + "-g WxH[xDEPTH] Set the initial graphical resolution and depth\n", + QEMU_ARCH_PPC | QEMU_ARCH_SPARC) STEXI @item -g @var{width}x@var{height}[x@var{depth}] @findex -g @@ -633,7 +820,7 @@ Set the initial graphical resolution and depth (PPC, SPARC only). ETEXI DEF("vnc", HAS_ARG, QEMU_OPTION_vnc , - "-vnc display start a VNC server on display\n") + "-vnc display start a VNC server on display\n", QEMU_ARCH_ALL) STEXI @item -vnc @var{display}[,@var{option}[,@var{option}[,...]]] @findex -vnc @@ -740,6 +927,22 @@ empty, with a @code{deny} policy. Thus no one will be allowed to use the VNC server until the ACLs have been loaded. This can be achieved using the @code{acl} monitor command. +@item lossy + +Enable lossy compression methods (gradient, JPEG, ...). If this +option is set, VNC client may receive lossy framebuffer updates +depending on its encoding settings. Enabling this option can save +a lot of bandwidth at the expense of quality. + +@item non-adaptive + +Disable adaptive encodings. Adaptive encodings are enabled by default. +An adaptive encoding will try to detect frequently updated screen regions, +and send updates in these regions using a lossy encoding (like JPEG). +This can be really helpful to save bandwidth when playing videos. Disabling +adaptive encodings allows to restore the original static behavior of encodings +like Tight. + @end table ETEXI @@ -749,17 +952,14 @@ ETEXI DEFHEADING() -#ifdef TARGET_I386 DEFHEADING(i386 target only:) -#endif STEXI @table @option ETEXI -#ifdef TARGET_I386 DEF("win2k-hack", 0, QEMU_OPTION_win2k_hack, - "-win2k-hack use it when installing Windows 2000 to avoid a disk full bug\n") -#endif + "-win2k-hack use it when installing Windows 2000 to avoid a disk full bug\n", + QEMU_ARCH_I386) STEXI @item -win2k-hack @findex -win2k-hack @@ -768,15 +968,12 @@ Windows 2000 is installed, you no longer need this option (this option slows down the IDE transfers). ETEXI -#ifdef TARGET_I386 HXCOMM Deprecated by -rtc -DEF("rtc-td-hack", 0, QEMU_OPTION_rtc_td_hack, "") -#endif +DEF("rtc-td-hack", 0, QEMU_OPTION_rtc_td_hack, "", QEMU_ARCH_I386) -#ifdef TARGET_I386 DEF("no-fd-bootchk", 0, QEMU_OPTION_no_fd_bootchk, - "-no-fd-bootchk disable boot signature checking for floppy disks\n") -#endif + "-no-fd-bootchk disable boot signature checking for floppy disks\n", + QEMU_ARCH_I386) STEXI @item -no-fd-bootchk @findex -no-fd-bootchk @@ -785,10 +982,8 @@ be needed to boot from old floppy disks. TODO: check reference to Bochs BIOS. ETEXI -#ifdef TARGET_I386 DEF("no-acpi", 0, QEMU_OPTION_no_acpi, - "-no-acpi disable ACPI\n") -#endif + "-no-acpi disable ACPI\n", QEMU_ARCH_I386) STEXI @item -no-acpi @findex -no-acpi @@ -797,22 +992,18 @@ it if your guest OS complains about ACPI problems (PC target machine only). ETEXI -#ifdef TARGET_I386 DEF("no-hpet", 0, QEMU_OPTION_no_hpet, - "-no-hpet disable HPET\n") -#endif + "-no-hpet disable HPET\n", QEMU_ARCH_I386) STEXI @item -no-hpet @findex -no-hpet Disable HPET support. ETEXI -#ifdef TARGET_I386 DEF("balloon", HAS_ARG, QEMU_OPTION_balloon, "-balloon none disable balloon device\n" "-balloon virtio[,addr=str]\n" - " enable virtio balloon device (default)\n") -#endif + " enable virtio balloon device (default)\n", QEMU_ARCH_ALL) STEXI @item -balloon none @findex -balloon @@ -822,18 +1013,15 @@ Enable virtio balloon device (default), optionally with PCI address @var{addr}. ETEXI -#ifdef TARGET_I386 DEF("acpitable", HAS_ARG, QEMU_OPTION_acpitable, "-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" - " ACPI table description\n") -#endif + " ACPI table description\n", QEMU_ARCH_I386) STEXI @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}]...] @findex -acpitable Add ACPI table with specified header fields and context from specified files. ETEXI -#ifdef TARGET_I386 DEF("smbios", HAS_ARG, QEMU_OPTION_smbios, "-smbios file=binary\n" " load SMBIOS entry from binary file\n" @@ -841,8 +1029,7 @@ DEF("smbios", HAS_ARG, QEMU_OPTION_smbios, " specify SMBIOS type 0 fields\n" "-smbios type=1[,manufacturer=str][,product=str][,version=str][,serial=str]\n" " [,uuid=uuid][,sku=str][,family=str]\n" - " specify SMBIOS type 1 fields\n") -#endif + " specify SMBIOS type 1 fields\n", QEMU_ARCH_I386) STEXI @item -smbios file=@var{binary} @findex -smbios @@ -856,9 +1043,7 @@ Specify SMBIOS type 0 fields Specify SMBIOS type 1 fields ETEXI -#ifdef TARGET_I386 DEFHEADING() -#endif STEXI @end table ETEXI @@ -870,11 +1055,11 @@ ETEXI HXCOMM Legacy slirp options (now moved to -net user): #ifdef CONFIG_SLIRP -DEF("tftp", HAS_ARG, QEMU_OPTION_tftp, "") -DEF("bootp", HAS_ARG, QEMU_OPTION_bootp, "") -DEF("redir", HAS_ARG, QEMU_OPTION_redir, "") +DEF("tftp", HAS_ARG, QEMU_OPTION_tftp, "", QEMU_ARCH_ALL) +DEF("bootp", HAS_ARG, QEMU_OPTION_bootp, "", QEMU_ARCH_ALL) +DEF("redir", HAS_ARG, QEMU_OPTION_redir, "", QEMU_ARCH_ALL) #ifndef _WIN32 -DEF("smb", HAS_ARG, QEMU_OPTION_smb, "") +DEF("smb", HAS_ARG, QEMU_OPTION_smb, "", QEMU_ARCH_ALL) #endif #endif @@ -895,21 +1080,26 @@ DEF("net", HAS_ARG, QEMU_OPTION_net, "-net tap[,vlan=n][,name=str],ifname=name\n" " connect the host TAP network interface to VLAN 'n'\n" #else - "-net tap[,vlan=n][,name=str][,fd=h][,ifname=name][,script=file][,downscript=dfile][,sndbuf=nbytes][,vnet_hdr=on|off]\n" + "-net tap[,vlan=n][,name=str][,fd=h][,ifname=name][,script=file][,downscript=dfile][,sndbuf=nbytes][,vnet_hdr=on|off][,vhost=on|off][,vhostfd=h][,vhostforce=on|off]\n" " connect the host TAP network interface to VLAN 'n' and use the\n" " network scripts 'file' (default=" DEFAULT_NETWORK_SCRIPT ")\n" " and 'dfile' (default=" DEFAULT_NETWORK_DOWN_SCRIPT ")\n" " use '[down]script=no' to disable script execution\n" " use 'fd=h' to connect to an already opened TAP interface\n" " use 'sndbuf=nbytes' to limit the size of the send buffer (the\n" - " default of 'sndbuf=1048576' can be disabled using 'sndbuf=0')\n" + " default is disabled 'sndbuf=0' to enable flow control set 'sndbuf=1048576')\n" " use vnet_hdr=off to avoid enabling the IFF_VNET_HDR tap flag\n" " use vnet_hdr=on to make the lack of IFF_VNET_HDR support an error condition\n" + " use vhost=on to enable experimental in kernel accelerator\n" + " (only has effect for virtio guests which use MSIX)\n" + " use vhostforce=on to force vhost on for non-MSIX virtio guests\n" + " use 'vhostfd=h' to connect to an already opened vhost net device\n" #endif "-net socket[,vlan=n][,name=str][,fd=h][,listen=[host]:port][,connect=host:port]\n" " connect the vlan 'n' to another VLAN using a socket connection\n" - "-net socket[,vlan=n][,name=str][,fd=h][,mcast=maddr:port]\n" + "-net socket[,vlan=n][,name=str][,fd=h][,mcast=maddr:port[,localaddr=addr]]\n" " connect the vlan 'n' to multicast maddr and port\n" + " use 'localaddr=addr' to specify the host address to send packets from\n" #ifdef CONFIG_VDE "-net vde[,vlan=n][,name=str][,sock=socketpath][,port=n][,group=groupname][,mode=octalmode]\n" " connect the vlan 'n' to port 'n' of a vde switch running\n" @@ -920,7 +1110,7 @@ DEF("net", HAS_ARG, QEMU_OPTION_net, "-net dump[,vlan=n][,file=f][,len=n]\n" " dump traffic on vlan 'n' to file 'f' (max n bytes per packet)\n" "-net none use it alone to have zero network devices. If no -net option\n" - " is provided, the default is '-net nic -net user'\n") + " is provided, the default is '-net nic -net user'\n", QEMU_ARCH_ALL) DEF("netdev", HAS_ARG, QEMU_OPTION_netdev, "-netdev [" #ifdef CONFIG_SLIRP @@ -930,7 +1120,7 @@ DEF("netdev", HAS_ARG, QEMU_OPTION_netdev, #ifdef CONFIG_VDE "vde|" #endif - "socket],id=str[,option][,option][,...]\n") + "socket],id=str[,option][,option][,...]\n", QEMU_ARCH_ALL) STEXI @item -net nic[,vlan=@var{n}][,macaddr=@var{mac}][,model=@var{type}] [,name=@var{name}][,addr=@var{addr}][,vectors=@var{v}] @findex -net @@ -964,7 +1154,7 @@ Assign symbolic name for use in monitor commands. @item net=@var{addr}[/@var{mask}] Set IP network address the guest will see. Optionally specify the netmask, either in the form a.b.c.d or as number of valid top-most bits. Default is -10.0.2.0/8. +10.0.2.0/24. @item host=@var{addr} Specify the guest-visible address of the host. Default is the 2nd IP in the @@ -980,7 +1170,7 @@ Specifies the client hostname reported by the builtin DHCP server. @item dhcpstart=@var{addr} Specify the first of the 16 IPs the built-in DHCP server can assign. Default -is the 16th to 31st IP in the guest network, i.e. x.x.x.16 to x.x.x.31. +is the 15th to 31st IP in the guest network, i.e. x.x.x.15 to x.x.x.31. @item dns=@var{addr} Specify the guest-visible address of the virtual nameserver. The address must @@ -1103,7 +1293,7 @@ qemu linux.img -net nic,macaddr=52:54:00:12:34:57 \ -net socket,connect=127.0.0.1:1234 @end example -@item -net socket[,vlan=@var{n}][,name=@var{name}][,fd=@var{h}] [,mcast=@var{maddr}:@var{port}] +@item -net socket[,vlan=@var{n}][,name=@var{name}][,fd=@var{h}][,mcast=@var{maddr}:@var{port}[,localaddr=@var{addr}]] Create a VLAN @var{n} shared with another QEMU virtual machines using a UDP multicast socket, effectively making a bus for @@ -1143,6 +1333,12 @@ qemu linux.img -net nic,macaddr=52:54:00:12:34:56 \ /path/to/linux ubd0=/path/to/root_fs eth0=mcast @end example +Example (send packets from host's 1.2.3.4): +@example +qemu linux.img -net nic,macaddr=52:54:00:12:34:56 \ + -net socket,mcast=239.192.168.1:1102,localaddr=1.2.3.4 +@end example + @item -net vde[,vlan=@var{n}][,name=@var{name}][,sock=@var{socketpath}] [,port=@var{n}][,group=@var{groupname}][,mode=@var{octalmode}] Connect VLAN @var{n} to PORT @var{n} of a vde switch running on host and listening for incoming connections on @var{socketpath}. Use GROUP @var{groupname} @@ -1176,33 +1372,38 @@ DEFHEADING() DEFHEADING(Character device options:) DEF("chardev", HAS_ARG, QEMU_OPTION_chardev, - "-chardev null,id=id\n" + "-chardev null,id=id[,mux=on|off]\n" "-chardev socket,id=id[,host=host],port=host[,to=to][,ipv4][,ipv6][,nodelay]\n" - " [,server][,nowait][,telnet] (tcp)\n" - "-chardev socket,id=id,path=path[,server][,nowait][,telnet] (unix)\n" + " [,server][,nowait][,telnet][,mux=on|off] (tcp)\n" + "-chardev socket,id=id,path=path[,server][,nowait][,telnet],[mux=on|off] (unix)\n" "-chardev udp,id=id[,host=host],port=port[,localaddr=localaddr]\n" - " [,localport=localport][,ipv4][,ipv6]\n" - "-chardev msmouse,id=id\n" + " [,localport=localport][,ipv4][,ipv6][,mux=on|off]\n" + "-chardev msmouse,id=id[,mux=on|off]\n" "-chardev vc,id=id[[,width=width][,height=height]][[,cols=cols][,rows=rows]]\n" - "-chardev file,id=id,path=path\n" - "-chardev pipe,id=id,path=path\n" + " [,mux=on|off]\n" + "-chardev file,id=id,path=path[,mux=on|off]\n" + "-chardev pipe,id=id,path=path[,mux=on|off]\n" #ifdef _WIN32 - "-chardev console,id=id\n" - "-chardev serial,id=id,path=path\n" + "-chardev console,id=id[,mux=on|off]\n" + "-chardev serial,id=id,path=path[,mux=on|off]\n" #else - "-chardev pty,id=id\n" - "-chardev stdio,id=id\n" + "-chardev pty,id=id[,mux=on|off]\n" + "-chardev stdio,id=id[,mux=on|off][,signal=on|off]\n" #endif #ifdef CONFIG_BRLAPI - "-chardev braille,id=id\n" + "-chardev braille,id=id[,mux=on|off]\n" #endif #if defined(__linux__) || defined(__sun__) || defined(__FreeBSD__) \ || defined(__NetBSD__) || defined(__OpenBSD__) || defined(__DragonFly__) - "-chardev tty,id=id,path=path\n" + "-chardev tty,id=id,path=path[,mux=on|off]\n" #endif #if defined(__linux__) || defined(__FreeBSD__) || defined(__DragonFly__) - "-chardev parport,id=id,path=path\n" + "-chardev parport,id=id,path=path[,mux=on|off]\n" #endif +#if defined(CONFIG_SPICE) + "-chardev spicevmc,id=id,name=name[,debug=debug]\n" +#endif + , QEMU_ARCH_ALL ) STEXI @@ -1210,7 +1411,7 @@ STEXI The general form of a character device option is: @table @option -@item -chardev @var{backend} ,id=@var{id} [,@var{options}] +@item -chardev @var{backend} ,id=@var{id} [,mux=on|off] [,@var{options}] @findex -chardev Backend is one of: @option{null}, @@ -1226,12 +1427,17 @@ Backend is one of: @option{stdio}, @option{braille}, @option{tty}, -@option{parport}. +@option{parport}, +@option{spicevmc}. The specific backend will determine the applicable options. All devices must have an id, which can be any string up to 127 characters long. It is used to uniquely identify this device in other command line directives. +A character device may be used in multiplexing mode by multiple front-ends. +The key sequence of @key{Control-a} and @key{c} will rotate the input focus +between attached front-ends. Specify @option{mux=on} to enable this mode. + Options to each backend are described below. @item -chardev null ,id=@var{id} @@ -1256,7 +1462,7 @@ TCP and unix socket options are given below: @table @option -@item TCP options: port=@var{host} [,host=@var{host}] [,to=@var{to}] [,ipv4] [,ipv6] [,nodelay] +@item TCP options: port=@var{port} [,host=@var{host}] [,to=@var{to}] [,ipv4] [,ipv6] [,nodelay] @option{host} for a listening socket specifies the local address to be bound. For a connecting socket species the remote host to connect to. @option{host} is @@ -1367,10 +1573,14 @@ not take any options. @option{pty} is not available on Windows hosts. -@item -chardev stdio ,id=@var{id} +@item -chardev stdio ,id=@var{id} [,signal=on|off] Connect to standard input and standard output of the qemu process. -@option{stdio} does not take any options. @option{stdio} is not available on -Windows hosts. + +@option{signal} controls if signals are enabled on the terminal, that includes +exiting QEMU with the key sequence @key{Control-c}. This option is enabled by +default, use @option{signal=off} to disable it. + +@option{stdio} is not available on Windows hosts. @item -chardev braille ,id=@var{id} @@ -1394,6 +1604,16 @@ Connect to a local parallel port. @option{path} specifies the path to the parallel port device. @option{path} is required. +#if defined(CONFIG_SPICE) +@item -chardev spicevmc ,id=@var{id} ,debug=@var{debug}, name=@var{name} + +@option{debug} debug level for spicevmc + +@option{name} name of spice channel to connect to + +Connect to a spice virtual machine channel, such as vdiport. +#endif + @end table ETEXI @@ -1410,7 +1630,8 @@ DEF("bt", HAS_ARG, QEMU_OPTION_bt, \ "-bt vhci[,vlan=n]\n" \ " add host computer to virtual scatternet 'n' using VHCI\n" \ "-bt device:dev[,vlan=n]\n" \ - " emulate a bluetooth device 'dev' in scatternet 'n'\n") + " emulate a bluetooth device 'dev' in scatternet 'n'\n", + QEMU_ARCH_ALL) STEXI @table @option @@ -1481,7 +1702,7 @@ for easier testing of various kernels. ETEXI DEF("kernel", HAS_ARG, QEMU_OPTION_kernel, \ - "-kernel bzImage use 'bzImage' as kernel image\n") + "-kernel bzImage use 'bzImage' as kernel image\n", QEMU_ARCH_ALL) STEXI @item -kernel @var{bzImage} @findex -kernel @@ -1490,7 +1711,7 @@ or in multiboot format. ETEXI DEF("append", HAS_ARG, QEMU_OPTION_append, \ - "-append cmdline use 'cmdline' as kernel command line\n") + "-append cmdline use 'cmdline' as kernel command line\n", QEMU_ARCH_ALL) STEXI @item -append @var{cmdline} @findex -append @@ -1498,7 +1719,7 @@ Use @var{cmdline} as kernel command line ETEXI DEF("initrd", HAS_ARG, QEMU_OPTION_initrd, \ - "-initrd file use 'file' as initial ram disk\n") + "-initrd file use 'file' as initial ram disk\n", QEMU_ARCH_ALL) STEXI @item -initrd @var{file} @findex -initrd @@ -1525,7 +1746,8 @@ STEXI ETEXI DEF("serial", HAS_ARG, QEMU_OPTION_serial, \ - "-serial dev redirect the serial port to char device 'dev'\n") + "-serial dev redirect the serial port to char device 'dev'\n", + QEMU_ARCH_ALL) STEXI @item -serial @var{dev} @findex -serial @@ -1653,7 +1875,8 @@ Three button serial mouse. Configure the guest to use Microsoft protocol. ETEXI DEF("parallel", HAS_ARG, QEMU_OPTION_parallel, \ - "-parallel dev redirect the parallel port to char device 'dev'\n") + "-parallel dev redirect the parallel port to char device 'dev'\n", + QEMU_ARCH_ALL) STEXI @item -parallel @var{dev} @findex -parallel @@ -1669,7 +1892,8 @@ Use @code{-parallel none} to disable all parallel ports. ETEXI DEF("monitor", HAS_ARG, QEMU_OPTION_monitor, \ - "-monitor dev redirect the monitor to char device 'dev'\n") + "-monitor dev redirect the monitor to char device 'dev'\n", + QEMU_ARCH_ALL) STEXI @item -monitor @var{dev} @findex -monitor @@ -1679,7 +1903,8 @@ The default device is @code{vc} in graphical mode and @code{stdio} in non graphical mode. ETEXI DEF("qmp", HAS_ARG, QEMU_OPTION_qmp, \ - "-qmp dev like -monitor but opens in 'control' mode\n") + "-qmp dev like -monitor but opens in 'control' mode\n", + QEMU_ARCH_ALL) STEXI @item -qmp @var{dev} @findex -qmp @@ -1687,7 +1912,7 @@ Like -monitor but opens in 'control' mode. ETEXI DEF("mon", HAS_ARG, QEMU_OPTION_mon, \ - "-mon chardev=[name][,mode=readline|control][,default]\n") + "-mon chardev=[name][,mode=readline|control][,default]\n", QEMU_ARCH_ALL) STEXI @item -mon chardev=[name][,mode=readline|control][,default] @findex -mon @@ -1695,7 +1920,8 @@ Setup monitor on chardev @var{name}. ETEXI DEF("debugcon", HAS_ARG, QEMU_OPTION_debugcon, \ - "-debugcon dev redirect the debug console to char device 'dev'\n") + "-debugcon dev redirect the debug console to char device 'dev'\n", + QEMU_ARCH_ALL) STEXI @item -debugcon @var{dev} @findex -debugcon @@ -1707,7 +1933,7 @@ non graphical mode. ETEXI DEF("pidfile", HAS_ARG, QEMU_OPTION_pidfile, \ - "-pidfile file write PID to 'file'\n") + "-pidfile file write PID to 'file'\n", QEMU_ARCH_ALL) STEXI @item -pidfile @var{file} @findex -pidfile @@ -1716,7 +1942,7 @@ from a script. ETEXI DEF("singlestep", 0, QEMU_OPTION_singlestep, \ - "-singlestep always run in singlestep mode\n") + "-singlestep always run in singlestep mode\n", QEMU_ARCH_ALL) STEXI @item -singlestep @findex -singlestep @@ -1724,7 +1950,8 @@ Run the emulation in single step mode. ETEXI DEF("S", 0, QEMU_OPTION_S, \ - "-S freeze CPU at startup (use 'c' to start execution)\n") + "-S freeze CPU at startup (use 'c' to start execution)\n", + QEMU_ARCH_ALL) STEXI @item -S @findex -S @@ -1732,7 +1959,7 @@ Do not start CPU at startup (you must type 'c' in the monitor). ETEXI DEF("gdb", HAS_ARG, QEMU_OPTION_gdb, \ - "-gdb dev wait for gdb connection on 'dev'\n") + "-gdb dev wait for gdb connection on 'dev'\n", QEMU_ARCH_ALL) STEXI @item -gdb @var{dev} @findex -gdb @@ -1746,7 +1973,8 @@ within gdb and establish the connection via a pipe: ETEXI DEF("s", 0, QEMU_OPTION_s, \ - "-s shorthand for -gdb tcp::" DEFAULT_GDBSTUB_PORT "\n") + "-s shorthand for -gdb tcp::" DEFAULT_GDBSTUB_PORT "\n", + QEMU_ARCH_ALL) STEXI @item -s @findex -s @@ -1755,7 +1983,8 @@ Shorthand for -gdb tcp::1234, i.e. open a gdbserver on TCP port 1234 ETEXI DEF("d", HAS_ARG, QEMU_OPTION_d, \ - "-d item1,... output log to /tmp/qemu.log (use -d ? for a list of log items)\n") + "-d item1,... output log to /tmp/qemu.log (use -d ? for a list of log items)\n", + QEMU_ARCH_ALL) STEXI @item -d @findex -d @@ -1765,7 +1994,8 @@ ETEXI DEF("hdachs", HAS_ARG, QEMU_OPTION_hdachs, \ "-hdachs c,h,s[,t]\n" \ " force hard disk 0 physical geometry and the optional BIOS\n" \ - " translation (t=none or lba) (usually qemu can guess them)\n") + " translation (t=none or lba) (usually qemu can guess them)\n", + QEMU_ARCH_ALL) STEXI @item -hdachs @var{c},@var{h},@var{s},[,@var{t}] @findex -hdachs @@ -1777,7 +2007,8 @@ images. ETEXI DEF("L", HAS_ARG, QEMU_OPTION_L, \ - "-L path set the directory for the BIOS, VGA BIOS and keymaps\n") + "-L path set the directory for the BIOS, VGA BIOS and keymaps\n", + QEMU_ARCH_ALL) STEXI @item -L @var{path} @findex -L @@ -1785,17 +2016,15 @@ Set the directory for the BIOS, VGA BIOS and keymaps. ETEXI DEF("bios", HAS_ARG, QEMU_OPTION_bios, \ - "-bios file set the filename for the BIOS\n") + "-bios file set the filename for the BIOS\n", QEMU_ARCH_ALL) STEXI @item -bios @var{file} @findex -bios Set the filename for the BIOS. ETEXI -#ifdef CONFIG_KVM DEF("enable-kvm", 0, QEMU_OPTION_enable_kvm, \ - "-enable-kvm enable KVM full virtualization support\n") -#endif + "-enable-kvm enable KVM full virtualization support\n", QEMU_ARCH_ALL) STEXI @item -enable-kvm @findex -enable-kvm @@ -1803,16 +2032,26 @@ Enable KVM full virtualization support. This option is only available if KVM support is enabled when compiling. ETEXI -#ifdef CONFIG_XEN +DEF("machine", HAS_ARG, QEMU_OPTION_machine, \ + "-machine accel=accel1[:accel2] use an accelerator (kvm,xen,tcg), default is tcg\n", QEMU_ARCH_ALL) +STEXI +@item -machine accel=@var{accels} +@findex -machine +This is use to enable an accelerator, in kvm,xen,tcg. +By default, it use only tcg. If there a more than one accelerator +specified, the next one is used if the first don't work. +ETEXI + DEF("xen-domid", HAS_ARG, QEMU_OPTION_xen_domid, - "-xen-domid id specify xen guest domain id\n") + "-xen-domid id specify xen guest domain id\n", QEMU_ARCH_ALL) DEF("xen-create", 0, QEMU_OPTION_xen_create, "-xen-create create domain using xen hypercalls, bypassing xend\n" - " warning: should not be used when xend is in use\n") + " warning: should not be used when xend is in use\n", + QEMU_ARCH_ALL) DEF("xen-attach", 0, QEMU_OPTION_xen_attach, "-xen-attach attach to existing xen domain\n" - " xend will use this when starting qemu\n") -#endif + " xend will use this when starting qemu\n", + QEMU_ARCH_ALL) STEXI @item -xen-domid @var{id} @findex -xen-domid @@ -1828,7 +2067,7 @@ xend will use this when starting qemu (XEN only). ETEXI DEF("no-reboot", 0, QEMU_OPTION_no_reboot, \ - "-no-reboot exit instead of rebooting\n") + "-no-reboot exit instead of rebooting\n", QEMU_ARCH_ALL) STEXI @item -no-reboot @findex -no-reboot @@ -1836,7 +2075,7 @@ Exit instead of rebooting. ETEXI DEF("no-shutdown", 0, QEMU_OPTION_no_shutdown, \ - "-no-shutdown stop before shutdown\n") + "-no-shutdown stop before shutdown\n", QEMU_ARCH_ALL) STEXI @item -no-shutdown @findex -no-shutdown @@ -1847,7 +2086,8 @@ ETEXI DEF("loadvm", HAS_ARG, QEMU_OPTION_loadvm, \ "-loadvm [tag|id]\n" \ - " start right away with a saved state (loadvm in monitor)\n") + " start right away with a saved state (loadvm in monitor)\n", + QEMU_ARCH_ALL) STEXI @item -loadvm @var{file} @findex -loadvm @@ -1856,7 +2096,7 @@ ETEXI #ifndef _WIN32 DEF("daemonize", 0, QEMU_OPTION_daemonize, \ - "-daemonize daemonize QEMU after initializing\n") + "-daemonize daemonize QEMU after initializing\n", QEMU_ARCH_ALL) #endif STEXI @item -daemonize @@ -1868,7 +2108,8 @@ to cope with initialization race conditions. ETEXI DEF("option-rom", HAS_ARG, QEMU_OPTION_option_rom, \ - "-option-rom rom load a file, rom, into the option ROM space\n") + "-option-rom rom load a file, rom, into the option ROM space\n", + QEMU_ARCH_ALL) STEXI @item -option-rom @var{file} @findex -option-rom @@ -1878,7 +2119,8 @@ ETEXI DEF("clock", HAS_ARG, QEMU_OPTION_clock, \ "-clock force the use of the given methods for timer alarm.\n" \ - " To see what timers are available use -clock ?\n") + " To see what timers are available use -clock ?\n", + QEMU_ARCH_ALL) STEXI @item -clock @var{method} @findex -clock @@ -1887,18 +2129,13 @@ are available use -clock ?. ETEXI HXCOMM Options deprecated by -rtc -DEF("localtime", 0, QEMU_OPTION_localtime, "") -DEF("startdate", HAS_ARG, QEMU_OPTION_startdate, "") +DEF("localtime", 0, QEMU_OPTION_localtime, "", QEMU_ARCH_ALL) +DEF("startdate", HAS_ARG, QEMU_OPTION_startdate, "", QEMU_ARCH_ALL) -#ifdef TARGET_I386 DEF("rtc", HAS_ARG, QEMU_OPTION_rtc, \ "-rtc [base=utc|localtime|date][,clock=host|vm][,driftfix=none|slew]\n" \ - " set the RTC base and clock, enable drift fix for clock ticks\n") -#else -DEF("rtc", HAS_ARG, QEMU_OPTION_rtc, \ - "-rtc [base=utc|localtime|date][,clock=host|vm]\n" \ - " set the RTC base and clock\n") -#endif + " set the RTC base and clock, enable drift fix for clock ticks (x86 only)\n", + QEMU_ARCH_ALL) STEXI @@ -1924,7 +2161,7 @@ ETEXI DEF("icount", HAS_ARG, QEMU_OPTION_icount, \ "-icount [N|auto]\n" \ " enable virtual instruction counter with 2^N clock ticks per\n" \ - " instruction\n") + " instruction\n", QEMU_ARCH_ALL) STEXI @item -icount [@var{N}|auto] @findex -icount @@ -1941,7 +2178,8 @@ ETEXI DEF("watchdog", HAS_ARG, QEMU_OPTION_watchdog, \ "-watchdog i6300esb|ib700\n" \ - " enable virtual hardware watchdog [default=none]\n") + " enable virtual hardware watchdog [default=none]\n", + QEMU_ARCH_ALL) STEXI @item -watchdog @var{model} @findex -watchdog @@ -1961,7 +2199,8 @@ ETEXI DEF("watchdog-action", HAS_ARG, QEMU_OPTION_watchdog_action, \ "-watchdog-action reset|shutdown|poweroff|pause|debug|none\n" \ - " action when watchdog fires [default=reset]\n") + " action when watchdog fires [default=reset]\n", + QEMU_ARCH_ALL) STEXI @item -watchdog-action @var{action} @@ -1990,7 +2229,8 @@ Examples: ETEXI DEF("echr", HAS_ARG, QEMU_OPTION_echr, \ - "-echr chr set terminal escape character instead of ctrl-a\n") + "-echr chr set terminal escape character instead of ctrl-a\n", + QEMU_ARCH_ALL) STEXI @item -echr @var{numeric_ascii_value} @@ -2010,7 +2250,7 @@ ETEXI DEF("virtioconsole", HAS_ARG, QEMU_OPTION_virtiocon, \ "-virtioconsole c\n" \ - " set virtio console\n") + " set virtio console\n", QEMU_ARCH_ALL) STEXI @item -virtioconsole @var{c} @findex -virtioconsole @@ -2022,7 +2262,7 @@ Please use @code{-device virtconsole} for the new way of invocation. ETEXI DEF("show-cursor", 0, QEMU_OPTION_show_cursor, \ - "-show-cursor show cursor\n") + "-show-cursor show cursor\n", QEMU_ARCH_ALL) STEXI @item -show-cursor @findex -show-cursor @@ -2030,7 +2270,7 @@ Show cursor. ETEXI DEF("tb-size", HAS_ARG, QEMU_OPTION_tb_size, \ - "-tb-size n set TB size\n") + "-tb-size n set TB size\n", QEMU_ARCH_ALL) STEXI @item -tb-size @var{n} @findex -tb-size @@ -2038,7 +2278,8 @@ Set TB size. ETEXI DEF("incoming", HAS_ARG, QEMU_OPTION_incoming, \ - "-incoming p prepare for incoming migration, listen on port p\n") + "-incoming p prepare for incoming migration, listen on port p\n", + QEMU_ARCH_ALL) STEXI @item -incoming @var{port} @findex -incoming @@ -2046,7 +2287,7 @@ Prepare for incoming migration, listen on @var{port}. ETEXI DEF("nodefaults", 0, QEMU_OPTION_nodefaults, \ - "-nodefaults don't create default devices\n") + "-nodefaults don't create default devices\n", QEMU_ARCH_ALL) STEXI @item -nodefaults @findex -nodefaults @@ -2055,7 +2296,8 @@ ETEXI #ifndef _WIN32 DEF("chroot", HAS_ARG, QEMU_OPTION_chroot, \ - "-chroot dir chroot to dir just before starting the VM\n") + "-chroot dir chroot to dir just before starting the VM\n", + QEMU_ARCH_ALL) #endif STEXI @item -chroot @var{dir} @@ -2066,7 +2308,8 @@ ETEXI #ifndef _WIN32 DEF("runas", HAS_ARG, QEMU_OPTION_runas, \ - "-runas user change to user id user just before starting the VM\n") + "-runas user change to user id user just before starting the VM\n", + QEMU_ARCH_ALL) #endif STEXI @item -runas @var{user} @@ -2075,29 +2318,24 @@ Immediately before starting guest execution, drop root privileges, switching to the specified user. ETEXI -#if defined(TARGET_SPARC) || defined(TARGET_PPC) DEF("prom-env", HAS_ARG, QEMU_OPTION_prom_env, "-prom-env variable=value\n" - " set OpenBIOS nvram variables\n") -#endif + " set OpenBIOS nvram variables\n", + QEMU_ARCH_PPC | QEMU_ARCH_SPARC) STEXI @item -prom-env @var{variable}=@var{value} @findex -prom-env Set OpenBIOS nvram @var{variable} to given @var{value} (PPC, SPARC only). ETEXI -#if defined(TARGET_ARM) || defined(TARGET_M68K) DEF("semihosting", 0, QEMU_OPTION_semihosting, - "-semihosting semihosting mode\n") -#endif + "-semihosting semihosting mode\n", QEMU_ARCH_ARM | QEMU_ARCH_M68K) STEXI @item -semihosting @findex -semihosting Semihosting mode (ARM, M68K only). ETEXI -#if defined(TARGET_ARM) DEF("old-param", 0, QEMU_OPTION_old_param, - "-old-param old param mode\n") -#endif + "-old-param old param mode\n", QEMU_ARCH_ARM) STEXI @item -old-param @findex -old-param (ARM) @@ -2105,7 +2343,7 @@ Old param mode (ARM only). ETEXI DEF("readconfig", HAS_ARG, QEMU_OPTION_readconfig, - "-readconfig \n") + "-readconfig \n", QEMU_ARCH_ALL) STEXI @item -readconfig @var{file} @findex -readconfig @@ -2113,7 +2351,7 @@ Read device configuration from @var{file}. ETEXI DEF("writeconfig", HAS_ARG, QEMU_OPTION_writeconfig, "-writeconfig \n" - " read/write config file\n") + " read/write config file\n", QEMU_ARCH_ALL) STEXI @item -writeconfig @var{file} @findex -writeconfig @@ -2121,7 +2359,8 @@ Write device configuration to @var{file}. ETEXI DEF("nodefconfig", 0, QEMU_OPTION_nodefconfig, "-nodefconfig\n" - " do not load default config files at startup\n") + " do not load default config files at startup\n", + QEMU_ARCH_ALL) STEXI @item -nodefconfig @findex -nodefconfig @@ -2129,6 +2368,17 @@ Normally QEMU loads a configuration file from @var{sysconfdir}/qemu.conf and @var{sysconfdir}/target-@var{ARCH}.conf on startup. The @code{-nodefconfig} option will prevent QEMU from loading these configuration files at startup. ETEXI +#ifdef CONFIG_SIMPLE_TRACE +DEF("trace", HAS_ARG, QEMU_OPTION_trace, + "-trace\n" + " Specify a trace file to log traces to\n", + QEMU_ARCH_ALL) +STEXI +@item -trace +@findex -trace +Specify a trace file to log output traces to. +ETEXI +#endif HXCOMM This is the last statement. Insert new options before this line! STEXI