1 HXCOMM Use DEFHEADING() to define headings in both help text and texi
2 HXCOMM Text between STEXI and ETEXI are copied to texi version and
3 HXCOMM discarded from C version
4 HXCOMM DEF(option, HAS_ARG/0, opt_enum, opt_help, arch_mask) is used to
5 HXCOMM construct option structures, enums and help message for specified
7 HXCOMM HXCOMM can be used for comments, discarded from both texi and C
9 DEFHEADING(Standard options:)
14 DEF("help", 0, QEMU_OPTION_h,
15 "-h or -help display this help and exit\n", QEMU_ARCH_ALL)
22 DEF("version", 0, QEMU_OPTION_version,
23 "-version display version information and exit\n", QEMU_ARCH_ALL)
27 Display version information and exit
30 DEF("M", HAS_ARG, QEMU_OPTION_M,
31 "-M machine select emulated machine (-M ? for list)\n", QEMU_ARCH_ALL)
33 @item -M @var{machine}
35 Select the emulated @var{machine} (@code{-M ?} for list)
38 DEF("cpu", HAS_ARG, QEMU_OPTION_cpu,
39 "-cpu cpu select CPU (-cpu ? for list)\n", QEMU_ARCH_ALL)
41 @item -cpu @var{model}
43 Select CPU model (-cpu ? for list and additional feature selection)
46 DEF("smp", HAS_ARG, QEMU_OPTION_smp,
47 "-smp n[,maxcpus=cpus][,cores=cores][,threads=threads][,sockets=sockets]\n"
48 " set the number of CPUs to 'n' [default=1]\n"
49 " maxcpus= maximum number of total cpus, including\n"
50 " offline CPUs for hotplug, etc\n"
51 " cores= number of CPU cores on one socket\n"
52 " threads= number of threads on one CPU core\n"
53 " sockets= number of discrete sockets in the system\n",
56 @item -smp @var{n}[,cores=@var{cores}][,threads=@var{threads}][,sockets=@var{sockets}][,maxcpus=@var{maxcpus}]
58 Simulate an SMP system with @var{n} CPUs. On the PC target, up to 255
59 CPUs are supported. On Sparc32 target, Linux limits the number of usable CPUs
61 For the PC target, the number of @var{cores} per socket, the number
62 of @var{threads} per cores and the total number of @var{sockets} can be
63 specified. Missing values will be computed. If any on the three values is
64 given, the total number of CPUs @var{n} can be omitted. @var{maxcpus}
65 specifies the maximum number of hotpluggable CPUs.
68 DEF("numa", HAS_ARG, QEMU_OPTION_numa,
69 "-numa node[,mem=size][,cpus=cpu[-cpu]][,nodeid=node]\n", QEMU_ARCH_ALL)
71 @item -numa @var{opts}
73 Simulate a multi node NUMA system. If mem and cpus are omitted, resources
77 DEF("fda", HAS_ARG, QEMU_OPTION_fda,
78 "-fda/-fdb file use 'file' as floppy disk 0/1 image\n", QEMU_ARCH_ALL)
79 DEF("fdb", HAS_ARG, QEMU_OPTION_fdb, "", QEMU_ARCH_ALL)
85 Use @var{file} as floppy disk 0/1 image (@pxref{disk_images}). You can
86 use the host floppy by using @file{/dev/fd0} as filename (@pxref{host_drives}).
89 DEF("hda", HAS_ARG, QEMU_OPTION_hda,
90 "-hda/-hdb file use 'file' as IDE hard disk 0/1 image\n", QEMU_ARCH_ALL)
91 DEF("hdb", HAS_ARG, QEMU_OPTION_hdb, "", QEMU_ARCH_ALL)
92 DEF("hdc", HAS_ARG, QEMU_OPTION_hdc,
93 "-hdc/-hdd file use 'file' as IDE hard disk 2/3 image\n", QEMU_ARCH_ALL)
94 DEF("hdd", HAS_ARG, QEMU_OPTION_hdd, "", QEMU_ARCH_ALL)
104 Use @var{file} as hard disk 0, 1, 2 or 3 image (@pxref{disk_images}).
107 DEF("cdrom", HAS_ARG, QEMU_OPTION_cdrom,
108 "-cdrom file use 'file' as IDE cdrom image (cdrom is ide1 master)\n",
111 @item -cdrom @var{file}
113 Use @var{file} as CD-ROM image (you cannot use @option{-hdc} and
114 @option{-cdrom} at the same time). You can use the host CD-ROM by
115 using @file{/dev/cdrom} as filename (@pxref{host_drives}).
118 DEF("drive", HAS_ARG, QEMU_OPTION_drive,
119 "-drive [file=file][,if=type][,bus=n][,unit=m][,media=d][,index=i]\n"
120 " [,cyls=c,heads=h,secs=s[,trans=t]][,snapshot=on|off]\n"
121 " [,cache=writethrough|writeback|none|unsafe][,format=f]\n"
122 " [,serial=s][,addr=A][,id=name][,aio=threads|native]\n"
123 " [,readonly=on|off]\n"
124 " use 'file' as a drive image\n", QEMU_ARCH_ALL)
126 @item -drive @var{option}[,@var{option}[,@var{option}[,...]]]
129 Define a new drive. Valid options are:
132 @item file=@var{file}
133 This option defines which disk image (@pxref{disk_images}) to use with
134 this drive. If the filename contains comma, you must double it
135 (for instance, "file=my,,file" to use file "my,file").
136 @item if=@var{interface}
137 This option defines on which type on interface the drive is connected.
138 Available types are: ide, scsi, sd, mtd, floppy, pflash, virtio.
139 @item bus=@var{bus},unit=@var{unit}
140 These options define where is connected the drive by defining the bus number and
142 @item index=@var{index}
143 This option defines where is connected the drive by using an index in the list
144 of available connectors of a given interface type.
145 @item media=@var{media}
146 This option defines the type of the media: disk or cdrom.
147 @item cyls=@var{c},heads=@var{h},secs=@var{s}[,trans=@var{t}]
148 These options have the same definition as they have in @option{-hdachs}.
149 @item snapshot=@var{snapshot}
150 @var{snapshot} is "on" or "off" and allows to enable snapshot for given drive (see @option{-snapshot}).
151 @item cache=@var{cache}
152 @var{cache} is "none", "writeback", "unsafe", or "writethrough" and controls how the host cache is used to access block data.
154 @var{aio} is "threads", or "native" and selects between pthread based disk I/O and native Linux AIO.
155 @item format=@var{format}
156 Specify which disk @var{format} will be used rather than detecting
157 the format. Can be used to specifiy format=raw to avoid interpreting
158 an untrusted format header.
159 @item serial=@var{serial}
160 This option specifies the serial number to assign to the device.
161 @item addr=@var{addr}
162 Specify the controller's PCI address (if=virtio only).
165 By default, writethrough caching is used for all block device. This means that
166 the host page cache will be used to read and write data but write notification
167 will be sent to the guest only when the data has been reported as written by
168 the storage subsystem.
170 Writeback caching will report data writes as completed as soon as the data is
171 present in the host page cache. This is safe as long as you trust your host.
172 If your host crashes or loses power, then the guest may experience data
175 The host page cache can be avoided entirely with @option{cache=none}. This will
176 attempt to do disk IO directly to the guests memory. QEMU may still perform
177 an internal copy of the data.
179 Some block drivers perform badly with @option{cache=writethrough}, most notably,
180 qcow2. If performance is more important than correctness,
181 @option{cache=writeback} should be used with qcow2.
183 In case you don't care about data integrity over host failures, use
184 cache=unsafe. This option tells qemu that it never needs to write any data
185 to the disk but can instead keeps things in cache. If anything goes wrong,
186 like your host losing power, the disk storage getting disconnected accidently,
187 etc. you're image will most probably be rendered unusable. When using
188 the @option{-snapshot} option, unsafe caching is always used.
190 Instead of @option{-cdrom} you can use:
192 qemu -drive file=file,index=2,media=cdrom
195 Instead of @option{-hda}, @option{-hdb}, @option{-hdc}, @option{-hdd}, you can
198 qemu -drive file=file,index=0,media=disk
199 qemu -drive file=file,index=1,media=disk
200 qemu -drive file=file,index=2,media=disk
201 qemu -drive file=file,index=3,media=disk
204 You can connect a CDROM to the slave of ide0:
206 qemu -drive file=file,if=ide,index=1,media=cdrom
209 If you don't specify the "file=" argument, you define an empty drive:
211 qemu -drive if=ide,index=1,media=cdrom
214 You can connect a SCSI disk with unit ID 6 on the bus #0:
216 qemu -drive file=file,if=scsi,bus=0,unit=6
219 Instead of @option{-fda}, @option{-fdb}, you can use:
221 qemu -drive file=file,index=0,if=floppy
222 qemu -drive file=file,index=1,if=floppy
225 By default, @var{interface} is "ide" and @var{index} is automatically
228 qemu -drive file=a -drive file=b"
236 DEF("set", HAS_ARG, QEMU_OPTION_set,
237 "-set group.id.arg=value\n"
238 " set <arg> parameter for item <id> of type <group>\n"
239 " i.e. -set drive.$id.file=/path/to/image\n", QEMU_ARCH_ALL)
246 DEF("global", HAS_ARG, QEMU_OPTION_global,
247 "-global driver.property=value\n"
248 " set a global default for a driver property\n",
256 DEF("mtdblock", HAS_ARG, QEMU_OPTION_mtdblock,
257 "-mtdblock file use 'file' as on-board Flash memory image\n",
260 @item -mtdblock @var{file}
262 Use @var{file} as on-board Flash memory image.
265 DEF("sd", HAS_ARG, QEMU_OPTION_sd,
266 "-sd file use 'file' as SecureDigital card image\n", QEMU_ARCH_ALL)
270 Use @var{file} as SecureDigital card image.
273 DEF("pflash", HAS_ARG, QEMU_OPTION_pflash,
274 "-pflash file use 'file' as a parallel flash image\n", QEMU_ARCH_ALL)
276 @item -pflash @var{file}
278 Use @var{file} as a parallel flash image.
281 DEF("boot", HAS_ARG, QEMU_OPTION_boot,
282 "-boot [order=drives][,once=drives][,menu=on|off]\n"
283 " 'drives': floppy (a), hard disk (c), CD-ROM (d), network (n)\n",
286 @item -boot [order=@var{drives}][,once=@var{drives}][,menu=on|off]
288 Specify boot order @var{drives} as a string of drive letters. Valid
289 drive letters depend on the target achitecture. The x86 PC uses: a, b
290 (floppy 1 and 2), c (first hard disk), d (first CD-ROM), n-p (Etherboot
291 from network adapter 1-4), hard disk boot is the default. To apply a
292 particular boot order only on the first startup, specify it via
295 Interactive boot menus/prompts can be enabled via @option{menu=on} as far
296 as firmware/BIOS supports them. The default is non-interactive boot.
299 # try to boot from network first, then from hard disk
301 # boot from CD-ROM first, switch back to default order after reboot
305 Note: The legacy format '-boot @var{drives}' is still supported but its
306 use is discouraged as it may be removed from future versions.
309 DEF("snapshot", 0, QEMU_OPTION_snapshot,
310 "-snapshot write to temporary files instead of disk image files\n",
315 Write to temporary files instead of disk image files. In this case,
316 the raw disk image you use is not written back. You can however force
317 the write back by pressing @key{C-a s} (@pxref{disk_images}).
320 DEF("m", HAS_ARG, QEMU_OPTION_m,
321 "-m megs set virtual RAM size to megs MB [default="
322 stringify(DEFAULT_RAM_SIZE) "]\n", QEMU_ARCH_ALL)
326 Set virtual RAM size to @var{megs} megabytes. Default is 128 MiB. Optionally,
327 a suffix of ``M'' or ``G'' can be used to signify a value in megabytes or
328 gigabytes respectively.
331 DEF("mem-path", HAS_ARG, QEMU_OPTION_mempath,
332 "-mem-path FILE provide backing storage for guest RAM\n", QEMU_ARCH_ALL)
334 @item -mem-path @var{path}
335 Allocate guest RAM from a temporarily created file in @var{path}.
339 DEF("mem-prealloc", 0, QEMU_OPTION_mem_prealloc,
340 "-mem-prealloc preallocate guest memory (use with -mem-path)\n",
344 Preallocate memory when using -mem-path.
348 DEF("k", HAS_ARG, QEMU_OPTION_k,
349 "-k language use keyboard layout (for example 'fr' for French)\n",
352 @item -k @var{language}
354 Use keyboard layout @var{language} (for example @code{fr} for
355 French). This option is only needed where it is not easy to get raw PC
356 keycodes (e.g. on Macs, with some X11 servers or with a VNC
357 display). You don't normally need to use it on PC/Linux or PC/Windows
360 The available layouts are:
362 ar de-ch es fo fr-ca hu ja mk no pt-br sv
363 da en-gb et fr fr-ch is lt nl pl ru th
364 de en-us fi fr-be hr it lv nl-be pt sl tr
367 The default is @code{en-us}.
371 DEF("audio-help", 0, QEMU_OPTION_audio_help,
372 "-audio-help print list of audio drivers and their options\n",
377 Will show the audio subsystem help: list of drivers, tunable
381 DEF("soundhw", HAS_ARG, QEMU_OPTION_soundhw,
382 "-soundhw c1,... enable audio support\n"
383 " and only specified sound cards (comma separated list)\n"
384 " use -soundhw ? to get the list of supported cards\n"
385 " use -soundhw all to enable all of them\n", QEMU_ARCH_ALL)
387 @item -soundhw @var{card1}[,@var{card2},...] or -soundhw all
389 Enable audio and selected sound hardware. Use ? to print all
390 available sound hardware.
393 qemu -soundhw sb16,adlib disk.img
394 qemu -soundhw es1370 disk.img
395 qemu -soundhw ac97 disk.img
396 qemu -soundhw all disk.img
400 Note that Linux's i810_audio OSS kernel (for AC97) module might
401 require manually specifying clocking.
404 modprobe i810_audio clocking=48000
412 DEF("usb", 0, QEMU_OPTION_usb,
413 "-usb enable the USB driver (will be the default soon)\n",
421 Enable the USB driver (will be the default soon)
424 DEF("usbdevice", HAS_ARG, QEMU_OPTION_usbdevice,
425 "-usbdevice name add the host or guest USB device 'name'\n",
429 @item -usbdevice @var{devname}
431 Add the USB device @var{devname}. @xref{usb_devices}.
436 Virtual Mouse. This will override the PS/2 mouse emulation when activated.
439 Pointer device that uses absolute coordinates (like a touchscreen). This
440 means qemu is able to report the mouse position without having to grab the
441 mouse. Also overrides the PS/2 mouse emulation when activated.
443 @item disk:[format=@var{format}]:@var{file}
444 Mass storage device based on file. The optional @var{format} argument
445 will be used rather than detecting the format. Can be used to specifiy
446 @code{format=raw} to avoid interpreting an untrusted format header.
448 @item host:@var{bus}.@var{addr}
449 Pass through the host device identified by @var{bus}.@var{addr} (Linux only).
451 @item host:@var{vendor_id}:@var{product_id}
452 Pass through the host device identified by @var{vendor_id}:@var{product_id}
455 @item serial:[vendorid=@var{vendor_id}][,productid=@var{product_id}]:@var{dev}
456 Serial converter to host character device @var{dev}, see @code{-serial} for the
460 Braille device. This will use BrlAPI to display the braille output on a real
463 @item net:@var{options}
464 Network adapter that supports CDC ethernet and RNDIS protocols.
469 DEF("device", HAS_ARG, QEMU_OPTION_device,
470 "-device driver[,prop[=value][,...]]\n"
471 " add device (based on driver)\n"
472 " prop=value,... sets driver properties\n"
473 " use -device ? to print all possible drivers\n"
474 " use -device driver,? to print all possible properties\n",
477 @item -device @var{driver}[,@var{prop}[=@var{value}][,...]]
479 Add device @var{driver}. @var{prop}=@var{value} sets driver
480 properties. Valid properties depend on the driver. To get help on
481 possible drivers and properties, use @code{-device ?} and
482 @code{-device @var{driver},?}.
485 DEFHEADING(File system options:)
487 DEF("fsdev", HAS_ARG, QEMU_OPTION_fsdev,
488 "-fsdev local,id=id,path=path,security_model=[mapped|passthrough|none]\n",
493 The general form of a File system device option is:
496 @item -fsdev @var{fstype} ,id=@var{id} [,@var{options}]
500 The specific Fstype will determine the applicable options.
502 Options to each backend are described below.
504 @item -fsdev local ,id=@var{id} ,path=@var{path} ,security_model=@var{security_model}
506 Create a file-system-"device" for local-filesystem.
508 @option{local} is only available on Linux.
510 @option{path} specifies the path to be exported. @option{path} is required.
512 @option{security_model} specifies the security model to be followed.
513 @option{security_model} is required.
518 DEFHEADING(Virtual File system pass-through options:)
520 DEF("virtfs", HAS_ARG, QEMU_OPTION_virtfs,
521 "-virtfs local,path=path,mount_tag=tag,security_model=[mapped|passthrough|none]\n",
526 The general form of a Virtual File system pass-through option is:
529 @item -virtfs @var{fstype} [,@var{options}]
533 The specific Fstype will determine the applicable options.
535 Options to each backend are described below.
537 @item -virtfs local ,path=@var{path} ,mount_tag=@var{mount_tag} ,security_model=@var{security_model}
539 Create a Virtual file-system-pass through for local-filesystem.
541 @option{local} is only available on Linux.
543 @option{path} specifies the path to be exported. @option{path} is required.
545 @option{security_model} specifies the security model to be followed.
546 @option{security_model} is required.
549 @option{mount_tag} specifies the tag with which the exported file is mounted.
550 @option{mount_tag} is required.
557 DEF("name", HAS_ARG, QEMU_OPTION_name,
558 "-name string1[,process=string2]\n"
559 " set the name of the guest\n"
560 " string1 sets the window title and string2 the process name (on Linux)\n",
563 @item -name @var{name}
565 Sets the @var{name} of the guest.
566 This name will be displayed in the SDL window caption.
567 The @var{name} will also be used for the VNC server.
568 Also optionally set the top visible process name in Linux.
571 DEF("uuid", HAS_ARG, QEMU_OPTION_uuid,
572 "-uuid %08x-%04x-%04x-%04x-%012x\n"
573 " specify machine UUID\n", QEMU_ARCH_ALL)
575 @item -uuid @var{uuid}
586 DEFHEADING(Display options:)
592 DEF("nographic", 0, QEMU_OPTION_nographic,
593 "-nographic disable graphical output and redirect serial I/Os to console\n",
598 Normally, QEMU uses SDL to display the VGA output. With this option,
599 you can totally disable graphical output so that QEMU is a simple
600 command line application. The emulated serial port is redirected on
601 the console. Therefore, you can still use QEMU to debug a Linux kernel
602 with a serial console.
606 DEF("curses", 0, QEMU_OPTION_curses,
607 "-curses use a curses/ncurses interface instead of SDL\n",
613 Normally, QEMU uses SDL to display the VGA output. With this option,
614 QEMU can display the VGA output when in text mode using a
615 curses/ncurses interface. Nothing is displayed in graphical mode.
619 DEF("no-frame", 0, QEMU_OPTION_no_frame,
620 "-no-frame open SDL window without a frame and window decorations\n",
626 Do not use decorations for SDL windows and start them using the whole
627 available screen space. This makes the using QEMU in a dedicated desktop
628 workspace more convenient.
632 DEF("alt-grab", 0, QEMU_OPTION_alt_grab,
633 "-alt-grab use Ctrl-Alt-Shift to grab mouse (instead of Ctrl-Alt)\n",
639 Use Ctrl-Alt-Shift to grab mouse (instead of Ctrl-Alt).
643 DEF("ctrl-grab", 0, QEMU_OPTION_ctrl_grab,
644 "-ctrl-grab use Right-Ctrl to grab mouse (instead of Ctrl-Alt)\n",
650 Use Right-Ctrl to grab mouse (instead of Ctrl-Alt).
654 DEF("no-quit", 0, QEMU_OPTION_no_quit,
655 "-no-quit disable SDL window close capability\n", QEMU_ARCH_ALL)
660 Disable SDL window close capability.
664 DEF("sdl", 0, QEMU_OPTION_sdl,
665 "-sdl enable SDL\n", QEMU_ARCH_ALL)
673 DEF("spice", HAS_ARG, QEMU_OPTION_spice,
674 "-spice <args> enable spice\n", QEMU_ARCH_ALL)
676 @item -spice @var{option}[,@var{option}[,...]]
678 Enable the spice remote desktop protocol. Valid options are
683 Set the TCP port spice is listening on for plaintext channels.
685 @item password=<secret>
686 Set the password you need to authenticate.
688 @item disable-ticketing
689 Allow client connects without authentication.
692 Set the TCP port spice is listening on for encrypted channels.
695 Set the x509 file directory. Expects same filenames as -vnc $display,x509=$dir
697 @item x509-key-file=<file>
698 @item x509-key-password=<file>
699 @item x509-cert-file=<file>
700 @item x509-cacert-file=<file>
701 @item x509-dh-key-file=<file>
702 The x509 file names can also be configured individually.
704 @item tls-ciphers=<list>
705 Specify which ciphers to use.
707 @item image-compression=[auto_glz|auto_lz|quic|glz|lz|off]
708 Configure image compression (lossless).
711 @item jpeg-wan-compression=[auto|never|always]
712 @item zlib-glz-wan-compression=[auto|never|always]
713 Configure wan image compression (lossy for slow links).
719 DEF("portrait", 0, QEMU_OPTION_portrait,
720 "-portrait rotate graphical output 90 deg left (only PXA LCD)\n",
725 Rotate graphical output 90 deg left (only PXA LCD).
728 DEF("vga", HAS_ARG, QEMU_OPTION_vga,
729 "-vga [std|cirrus|vmware|xenfb|none]\n"
730 " select video card type\n", QEMU_ARCH_ALL)
732 @item -vga @var{type}
734 Select type of VGA card to emulate. Valid values for @var{type} are
737 Cirrus Logic GD5446 Video card. All Windows versions starting from
738 Windows 95 should recognize and use this graphic card. For optimal
739 performances, use 16 bit color depth in the guest and the host OS.
740 (This one is the default)
742 Standard VGA card with Bochs VBE extensions. If your guest OS
743 supports the VESA 2.0 VBE extensions (e.g. Windows XP) and if you want
744 to use high resolution modes (>= 1280x1024x16) then you should use
747 VMWare SVGA-II compatible adapter. Use it if you have sufficiently
748 recent XFree86/XOrg server or Windows guest with a driver for this
755 DEF("full-screen", 0, QEMU_OPTION_full_screen,
756 "-full-screen start in full screen\n", QEMU_ARCH_ALL)
760 Start in full screen.
763 DEF("g", 1, QEMU_OPTION_g ,
764 "-g WxH[xDEPTH] Set the initial graphical resolution and depth\n",
765 QEMU_ARCH_PPC | QEMU_ARCH_SPARC)
767 @item -g @var{width}x@var{height}[x@var{depth}]
769 Set the initial graphical resolution and depth (PPC, SPARC only).
772 DEF("vnc", HAS_ARG, QEMU_OPTION_vnc ,
773 "-vnc display start a VNC server on display\n", QEMU_ARCH_ALL)
775 @item -vnc @var{display}[,@var{option}[,@var{option}[,...]]]
777 Normally, QEMU uses SDL to display the VGA output. With this option,
778 you can have QEMU listen on VNC display @var{display} and redirect the VGA
779 display over the VNC session. It is very useful to enable the usb
780 tablet device when using this option (option @option{-usbdevice
781 tablet}). When using the VNC display, you must use the @option{-k}
782 parameter to set the keyboard layout if you are not using en-us. Valid
783 syntax for the @var{display} is
787 @item @var{host}:@var{d}
789 TCP connections will only be allowed from @var{host} on display @var{d}.
790 By convention the TCP port is 5900+@var{d}. Optionally, @var{host} can
791 be omitted in which case the server will accept connections from any host.
793 @item unix:@var{path}
795 Connections will be allowed over UNIX domain sockets where @var{path} is the
796 location of a unix socket to listen for connections on.
800 VNC is initialized but not started. The monitor @code{change} command
801 can be used to later start the VNC server.
805 Following the @var{display} value there may be one or more @var{option} flags
806 separated by commas. Valid options are
812 Connect to a listening VNC client via a ``reverse'' connection. The
813 client is specified by the @var{display}. For reverse network
814 connections (@var{host}:@var{d},@code{reverse}), the @var{d} argument
815 is a TCP port number, not a display number.
819 Require that password based authentication is used for client connections.
820 The password must be set separately using the @code{change} command in the
825 Require that client use TLS when communicating with the VNC server. This
826 uses anonymous TLS credentials so is susceptible to a man-in-the-middle
827 attack. It is recommended that this option be combined with either the
828 @option{x509} or @option{x509verify} options.
830 @item x509=@var{/path/to/certificate/dir}
832 Valid if @option{tls} is specified. Require that x509 credentials are used
833 for negotiating the TLS session. The server will send its x509 certificate
834 to the client. It is recommended that a password be set on the VNC server
835 to provide authentication of the client when this is used. The path following
836 this option specifies where the x509 certificates are to be loaded from.
837 See the @ref{vnc_security} section for details on generating certificates.
839 @item x509verify=@var{/path/to/certificate/dir}
841 Valid if @option{tls} is specified. Require that x509 credentials are used
842 for negotiating the TLS session. The server will send its x509 certificate
843 to the client, and request that the client send its own x509 certificate.
844 The server will validate the client's certificate against the CA certificate,
845 and reject clients when validation fails. If the certificate authority is
846 trusted, this is a sufficient authentication mechanism. You may still wish
847 to set a password on the VNC server as a second authentication layer. The
848 path following this option specifies where the x509 certificates are to
849 be loaded from. See the @ref{vnc_security} section for details on generating
854 Require that the client use SASL to authenticate with the VNC server.
855 The exact choice of authentication method used is controlled from the
856 system / user's SASL configuration file for the 'qemu' service. This
857 is typically found in /etc/sasl2/qemu.conf. If running QEMU as an
858 unprivileged user, an environment variable SASL_CONF_PATH can be used
859 to make it search alternate locations for the service config.
860 While some SASL auth methods can also provide data encryption (eg GSSAPI),
861 it is recommended that SASL always be combined with the 'tls' and
862 'x509' settings to enable use of SSL and server certificates. This
863 ensures a data encryption preventing compromise of authentication
864 credentials. See the @ref{vnc_security} section for details on using
869 Turn on access control lists for checking of the x509 client certificate
870 and SASL party. For x509 certs, the ACL check is made against the
871 certificate's distinguished name. This is something that looks like
872 @code{C=GB,O=ACME,L=Boston,CN=bob}. For SASL party, the ACL check is
873 made against the username, which depending on the SASL plugin, may
874 include a realm component, eg @code{bob} or @code{bob@@EXAMPLE.COM}.
875 When the @option{acl} flag is set, the initial access list will be
876 empty, with a @code{deny} policy. Thus no one will be allowed to
877 use the VNC server until the ACLs have been loaded. This can be
878 achieved using the @code{acl} monitor command.
882 Enable lossy compression methods (gradient, JPEG, ...). If this
883 option is set, VNC client may receive lossy framebuffer updates
884 depending on its encoding settings. Enabling this option can save
885 a lot of bandwidth at the expense of quality.
896 DEFHEADING(i386 target only:)
901 DEF("win2k-hack", 0, QEMU_OPTION_win2k_hack,
902 "-win2k-hack use it when installing Windows 2000 to avoid a disk full bug\n",
907 Use it when installing Windows 2000 to avoid a disk full bug. After
908 Windows 2000 is installed, you no longer need this option (this option
909 slows down the IDE transfers).
912 HXCOMM Deprecated by -rtc
913 DEF("rtc-td-hack", 0, QEMU_OPTION_rtc_td_hack, "", QEMU_ARCH_I386)
915 DEF("no-fd-bootchk", 0, QEMU_OPTION_no_fd_bootchk,
916 "-no-fd-bootchk disable boot signature checking for floppy disks\n",
920 @findex -no-fd-bootchk
921 Disable boot signature checking for floppy disks in Bochs BIOS. It may
922 be needed to boot from old floppy disks.
923 TODO: check reference to Bochs BIOS.
926 DEF("no-acpi", 0, QEMU_OPTION_no_acpi,
927 "-no-acpi disable ACPI\n", QEMU_ARCH_I386)
931 Disable ACPI (Advanced Configuration and Power Interface) support. Use
932 it if your guest OS complains about ACPI problems (PC target machine
936 DEF("no-hpet", 0, QEMU_OPTION_no_hpet,
937 "-no-hpet disable HPET\n", QEMU_ARCH_I386)
941 Disable HPET support.
944 DEF("balloon", HAS_ARG, QEMU_OPTION_balloon,
945 "-balloon none disable balloon device\n"
946 "-balloon virtio[,addr=str]\n"
947 " enable virtio balloon device (default)\n", QEMU_ARCH_ALL)
951 Disable balloon device.
952 @item -balloon virtio[,addr=@var{addr}]
953 Enable virtio balloon device (default), optionally with PCI address
957 DEF("acpitable", HAS_ARG, QEMU_OPTION_acpitable,
958 "-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"
959 " ACPI table description\n", QEMU_ARCH_I386)
961 @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}]...]
963 Add ACPI table with specified header fields and context from specified files.
966 DEF("smbios", HAS_ARG, QEMU_OPTION_smbios,
967 "-smbios file=binary\n"
968 " load SMBIOS entry from binary file\n"
969 "-smbios type=0[,vendor=str][,version=str][,date=str][,release=%d.%d]\n"
970 " specify SMBIOS type 0 fields\n"
971 "-smbios type=1[,manufacturer=str][,product=str][,version=str][,serial=str]\n"
972 " [,uuid=uuid][,sku=str][,family=str]\n"
973 " specify SMBIOS type 1 fields\n", QEMU_ARCH_I386)
975 @item -smbios file=@var{binary}
977 Load SMBIOS entry from binary file.
979 @item -smbios type=0[,vendor=@var{str}][,version=@var{str}][,date=@var{str}][,release=@var{%d.%d}]
981 Specify SMBIOS type 0 fields
983 @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}]
984 Specify SMBIOS type 1 fields
992 DEFHEADING(Network options:)
997 HXCOMM Legacy slirp options (now moved to -net user):
999 DEF("tftp", HAS_ARG, QEMU_OPTION_tftp, "", QEMU_ARCH_ALL)
1000 DEF("bootp", HAS_ARG, QEMU_OPTION_bootp, "", QEMU_ARCH_ALL)
1001 DEF("redir", HAS_ARG, QEMU_OPTION_redir, "", QEMU_ARCH_ALL)
1003 DEF("smb", HAS_ARG, QEMU_OPTION_smb, "", QEMU_ARCH_ALL)
1007 DEF("net", HAS_ARG, QEMU_OPTION_net,
1008 "-net nic[,vlan=n][,macaddr=mac][,model=type][,name=str][,addr=str][,vectors=v]\n"
1009 " create a new Network Interface Card and connect it to VLAN 'n'\n"
1011 "-net user[,vlan=n][,name=str][,net=addr[/mask]][,host=addr][,restrict=y|n]\n"
1012 " [,hostname=host][,dhcpstart=addr][,dns=addr][,tftp=dir][,bootfile=f]\n"
1013 " [,hostfwd=rule][,guestfwd=rule]"
1015 "[,smb=dir[,smbserver=addr]]\n"
1017 " connect the user mode network stack to VLAN 'n', configure its\n"
1018 " DHCP server and enabled optional services\n"
1021 "-net tap[,vlan=n][,name=str],ifname=name\n"
1022 " connect the host TAP network interface to VLAN 'n'\n"
1024 "-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]\n"
1025 " connect the host TAP network interface to VLAN 'n' and use the\n"
1026 " network scripts 'file' (default=" DEFAULT_NETWORK_SCRIPT ")\n"
1027 " and 'dfile' (default=" DEFAULT_NETWORK_DOWN_SCRIPT ")\n"
1028 " use '[down]script=no' to disable script execution\n"
1029 " use 'fd=h' to connect to an already opened TAP interface\n"
1030 " use 'sndbuf=nbytes' to limit the size of the send buffer (the\n"
1031 " default of 'sndbuf=1048576' can be disabled using 'sndbuf=0')\n"
1032 " use vnet_hdr=off to avoid enabling the IFF_VNET_HDR tap flag\n"
1033 " use vnet_hdr=on to make the lack of IFF_VNET_HDR support an error condition\n"
1034 " use vhost=on to enable experimental in kernel accelerator\n"
1035 " use 'vhostfd=h' to connect to an already opened vhost net device\n"
1037 "-net socket[,vlan=n][,name=str][,fd=h][,listen=[host]:port][,connect=host:port]\n"
1038 " connect the vlan 'n' to another VLAN using a socket connection\n"
1039 "-net socket[,vlan=n][,name=str][,fd=h][,mcast=maddr:port]\n"
1040 " connect the vlan 'n' to multicast maddr and port\n"
1042 "-net vde[,vlan=n][,name=str][,sock=socketpath][,port=n][,group=groupname][,mode=octalmode]\n"
1043 " connect the vlan 'n' to port 'n' of a vde switch running\n"
1044 " on host and listening for incoming connections on 'socketpath'.\n"
1045 " Use group 'groupname' and mode 'octalmode' to change default\n"
1046 " ownership and permissions for communication port.\n"
1048 "-net dump[,vlan=n][,file=f][,len=n]\n"
1049 " dump traffic on vlan 'n' to file 'f' (max n bytes per packet)\n"
1050 "-net none use it alone to have zero network devices. If no -net option\n"
1051 " is provided, the default is '-net nic -net user'\n", QEMU_ARCH_ALL)
1052 DEF("netdev", HAS_ARG, QEMU_OPTION_netdev,
1061 "socket],id=str[,option][,option][,...]\n", QEMU_ARCH_ALL)
1063 @item -net nic[,vlan=@var{n}][,macaddr=@var{mac}][,model=@var{type}] [,name=@var{name}][,addr=@var{addr}][,vectors=@var{v}]
1065 Create a new Network Interface Card and connect it to VLAN @var{n} (@var{n}
1066 = 0 is the default). The NIC is an e1000 by default on the PC
1067 target. Optionally, the MAC address can be changed to @var{mac}, the
1068 device address set to @var{addr} (PCI cards only),
1069 and a @var{name} can be assigned for use in monitor commands.
1070 Optionally, for PCI cards, you can specify the number @var{v} of MSI-X vectors
1071 that the card should have; this option currently only affects virtio cards; set
1072 @var{v} = 0 to disable MSI-X. If no @option{-net} option is specified, a single
1073 NIC is created. Qemu can emulate several different models of network card.
1074 Valid values for @var{type} are
1075 @code{virtio}, @code{i82551}, @code{i82557b}, @code{i82559er},
1076 @code{ne2k_pci}, @code{ne2k_isa}, @code{pcnet}, @code{rtl8139},
1077 @code{e1000}, @code{smc91c111}, @code{lance} and @code{mcf_fec}.
1078 Not all devices are supported on all targets. Use -net nic,model=?
1079 for a list of available devices for your target.
1081 @item -net user[,@var{option}][,@var{option}][,...]
1082 Use the user mode network stack which requires no administrator
1083 privilege to run. Valid options are:
1087 Connect user mode stack to VLAN @var{n} (@var{n} = 0 is the default).
1089 @item name=@var{name}
1090 Assign symbolic name for use in monitor commands.
1092 @item net=@var{addr}[/@var{mask}]
1093 Set IP network address the guest will see. Optionally specify the netmask,
1094 either in the form a.b.c.d or as number of valid top-most bits. Default is
1097 @item host=@var{addr}
1098 Specify the guest-visible address of the host. Default is the 2nd IP in the
1099 guest network, i.e. x.x.x.2.
1101 @item restrict=y|yes|n|no
1102 If this options is enabled, the guest will be isolated, i.e. it will not be
1103 able to contact the host and no guest IP packets will be routed over the host
1104 to the outside. This option does not affect explicitly set forwarding rule.
1106 @item hostname=@var{name}
1107 Specifies the client hostname reported by the builtin DHCP server.
1109 @item dhcpstart=@var{addr}
1110 Specify the first of the 16 IPs the built-in DHCP server can assign. Default
1111 is the 16th to 31st IP in the guest network, i.e. x.x.x.16 to x.x.x.31.
1113 @item dns=@var{addr}
1114 Specify the guest-visible address of the virtual nameserver. The address must
1115 be different from the host address. Default is the 3rd IP in the guest network,
1118 @item tftp=@var{dir}
1119 When using the user mode network stack, activate a built-in TFTP
1120 server. The files in @var{dir} will be exposed as the root of a TFTP server.
1121 The TFTP client on the guest must be configured in binary mode (use the command
1122 @code{bin} of the Unix TFTP client).
1124 @item bootfile=@var{file}
1125 When using the user mode network stack, broadcast @var{file} as the BOOTP
1126 filename. In conjunction with @option{tftp}, this can be used to network boot
1127 a guest from a local directory.
1129 Example (using pxelinux):
1131 qemu -hda linux.img -boot n -net user,tftp=/path/to/tftp/files,bootfile=/pxelinux.0
1134 @item smb=@var{dir}[,smbserver=@var{addr}]
1135 When using the user mode network stack, activate a built-in SMB
1136 server so that Windows OSes can access to the host files in @file{@var{dir}}
1137 transparently. The IP address of the SMB server can be set to @var{addr}. By
1138 default the 4th IP in the guest network is used, i.e. x.x.x.4.
1140 In the guest Windows OS, the line:
1144 must be added in the file @file{C:\WINDOWS\LMHOSTS} (for windows 9x/Me)
1145 or @file{C:\WINNT\SYSTEM32\DRIVERS\ETC\LMHOSTS} (Windows NT/2000).
1147 Then @file{@var{dir}} can be accessed in @file{\\smbserver\qemu}.
1149 Note that a SAMBA server must be installed on the host OS in
1150 @file{/usr/sbin/smbd}. QEMU was tested successfully with smbd versions from
1151 Red Hat 9, Fedora Core 3 and OpenSUSE 11.x.
1153 @item hostfwd=[tcp|udp]:[@var{hostaddr}]:@var{hostport}-[@var{guestaddr}]:@var{guestport}
1154 Redirect incoming TCP or UDP connections to the host port @var{hostport} to
1155 the guest IP address @var{guestaddr} on guest port @var{guestport}. If
1156 @var{guestaddr} is not specified, its value is x.x.x.15 (default first address
1157 given by the built-in DHCP server). By specifying @var{hostaddr}, the rule can
1158 be bound to a specific host interface. If no connection type is set, TCP is
1159 used. This option can be given multiple times.
1161 For example, to redirect host X11 connection from screen 1 to guest
1162 screen 0, use the following:
1166 qemu -net user,hostfwd=tcp:127.0.0.1:6001-:6000 [...]
1167 # this host xterm should open in the guest X11 server
1171 To redirect telnet connections from host port 5555 to telnet port on
1172 the guest, use the following:
1176 qemu -net user,hostfwd=tcp::5555-:23 [...]
1177 telnet localhost 5555
1180 Then when you use on the host @code{telnet localhost 5555}, you
1181 connect to the guest telnet server.
1183 @item guestfwd=[tcp]:@var{server}:@var{port}-@var{dev}
1184 Forward guest TCP connections to the IP address @var{server} on port @var{port}
1185 to the character device @var{dev}. This option can be given multiple times.
1189 Note: Legacy stand-alone options -tftp, -bootp, -smb and -redir are still
1190 processed and applied to -net user. Mixing them with the new configuration
1191 syntax gives undefined results. Their use for new applications is discouraged
1192 as they will be removed from future versions.
1194 @item -net tap[,vlan=@var{n}][,name=@var{name}][,fd=@var{h}][,ifname=@var{name}] [,script=@var{file}][,downscript=@var{dfile}]
1195 Connect the host TAP network interface @var{name} to VLAN @var{n}, use
1196 the network script @var{file} to configure it and the network script
1197 @var{dfile} to deconfigure it. If @var{name} is not provided, the OS
1198 automatically provides one. @option{fd}=@var{h} can be used to specify
1199 the handle of an already opened host TAP interface. The default network
1200 configure script is @file{/etc/qemu-ifup} and the default network
1201 deconfigure script is @file{/etc/qemu-ifdown}. Use @option{script=no}
1202 or @option{downscript=no} to disable script execution. Example:
1205 qemu linux.img -net nic -net tap
1208 More complicated example (two NICs, each one connected to a TAP device)
1210 qemu linux.img -net nic,vlan=0 -net tap,vlan=0,ifname=tap0 \
1211 -net nic,vlan=1 -net tap,vlan=1,ifname=tap1
1214 @item -net socket[,vlan=@var{n}][,name=@var{name}][,fd=@var{h}] [,listen=[@var{host}]:@var{port}][,connect=@var{host}:@var{port}]
1216 Connect the VLAN @var{n} to a remote VLAN in another QEMU virtual
1217 machine using a TCP socket connection. If @option{listen} is
1218 specified, QEMU waits for incoming connections on @var{port}
1219 (@var{host} is optional). @option{connect} is used to connect to
1220 another QEMU instance using the @option{listen} option. @option{fd}=@var{h}
1221 specifies an already opened TCP socket.
1225 # launch a first QEMU instance
1226 qemu linux.img -net nic,macaddr=52:54:00:12:34:56 \
1227 -net socket,listen=:1234
1228 # connect the VLAN 0 of this instance to the VLAN 0
1229 # of the first instance
1230 qemu linux.img -net nic,macaddr=52:54:00:12:34:57 \
1231 -net socket,connect=127.0.0.1:1234
1234 @item -net socket[,vlan=@var{n}][,name=@var{name}][,fd=@var{h}] [,mcast=@var{maddr}:@var{port}]
1236 Create a VLAN @var{n} shared with another QEMU virtual
1237 machines using a UDP multicast socket, effectively making a bus for
1238 every QEMU with same multicast address @var{maddr} and @var{port}.
1242 Several QEMU can be running on different hosts and share same bus (assuming
1243 correct multicast setup for these hosts).
1245 mcast support is compatible with User Mode Linux (argument @option{eth@var{N}=mcast}), see
1246 @url{http://user-mode-linux.sf.net}.
1248 Use @option{fd=h} to specify an already opened UDP multicast socket.
1253 # launch one QEMU instance
1254 qemu linux.img -net nic,macaddr=52:54:00:12:34:56 \
1255 -net socket,mcast=230.0.0.1:1234
1256 # launch another QEMU instance on same "bus"
1257 qemu linux.img -net nic,macaddr=52:54:00:12:34:57 \
1258 -net socket,mcast=230.0.0.1:1234
1259 # launch yet another QEMU instance on same "bus"
1260 qemu linux.img -net nic,macaddr=52:54:00:12:34:58 \
1261 -net socket,mcast=230.0.0.1:1234
1264 Example (User Mode Linux compat.):
1266 # launch QEMU instance (note mcast address selected
1268 qemu linux.img -net nic,macaddr=52:54:00:12:34:56 \
1269 -net socket,mcast=239.192.168.1:1102
1271 /path/to/linux ubd0=/path/to/root_fs eth0=mcast
1274 @item -net vde[,vlan=@var{n}][,name=@var{name}][,sock=@var{socketpath}] [,port=@var{n}][,group=@var{groupname}][,mode=@var{octalmode}]
1275 Connect VLAN @var{n} to PORT @var{n} of a vde switch running on host and
1276 listening for incoming connections on @var{socketpath}. Use GROUP @var{groupname}
1277 and MODE @var{octalmode} to change default ownership and permissions for
1278 communication port. This option is available only if QEMU has been compiled
1279 with vde support enabled.
1284 vde_switch -F -sock /tmp/myswitch
1285 # launch QEMU instance
1286 qemu linux.img -net nic -net vde,sock=/tmp/myswitch
1289 @item -net dump[,vlan=@var{n}][,file=@var{file}][,len=@var{len}]
1290 Dump network traffic on VLAN @var{n} to file @var{file} (@file{qemu-vlan0.pcap} by default).
1291 At most @var{len} bytes (64k by default) per packet are stored. The file format is
1292 libpcap, so it can be analyzed with tools such as tcpdump or Wireshark.
1295 Indicate that no network devices should be configured. It is used to
1296 override the default configuration (@option{-net nic -net user}) which
1297 is activated if no @option{-net} options are provided.
1304 DEFHEADING(Character device options:)
1306 DEF("chardev", HAS_ARG, QEMU_OPTION_chardev,
1307 "-chardev null,id=id[,mux=on|off]\n"
1308 "-chardev socket,id=id[,host=host],port=host[,to=to][,ipv4][,ipv6][,nodelay]\n"
1309 " [,server][,nowait][,telnet][,mux=on|off] (tcp)\n"
1310 "-chardev socket,id=id,path=path[,server][,nowait][,telnet],[mux=on|off] (unix)\n"
1311 "-chardev udp,id=id[,host=host],port=port[,localaddr=localaddr]\n"
1312 " [,localport=localport][,ipv4][,ipv6][,mux=on|off]\n"
1313 "-chardev msmouse,id=id[,mux=on|off]\n"
1314 "-chardev vc,id=id[[,width=width][,height=height]][[,cols=cols][,rows=rows]]\n"
1316 "-chardev file,id=id,path=path[,mux=on|off]\n"
1317 "-chardev pipe,id=id,path=path[,mux=on|off]\n"
1319 "-chardev console,id=id[,mux=on|off]\n"
1320 "-chardev serial,id=id,path=path[,mux=on|off]\n"
1322 "-chardev pty,id=id[,mux=on|off]\n"
1323 "-chardev stdio,id=id[,mux=on|off][,signal=on|off]\n"
1325 #ifdef CONFIG_BRLAPI
1326 "-chardev braille,id=id[,mux=on|off]\n"
1328 #if defined(__linux__) || defined(__sun__) || defined(__FreeBSD__) \
1329 || defined(__NetBSD__) || defined(__OpenBSD__) || defined(__DragonFly__)
1330 "-chardev tty,id=id,path=path[,mux=on|off]\n"
1332 #if defined(__linux__) || defined(__FreeBSD__) || defined(__DragonFly__)
1333 "-chardev parport,id=id,path=path[,mux=on|off]\n"
1340 The general form of a character device option is:
1343 @item -chardev @var{backend} ,id=@var{id} [,mux=on|off] [,@var{options}]
1360 The specific backend will determine the applicable options.
1362 All devices must have an id, which can be any string up to 127 characters long.
1363 It is used to uniquely identify this device in other command line directives.
1365 A character device may be used in multiplexing mode by multiple front-ends.
1366 The key sequence of @key{Control-a} and @key{c} will rotate the input focus
1367 between attached front-ends. Specify @option{mux=on} to enable this mode.
1369 Options to each backend are described below.
1371 @item -chardev null ,id=@var{id}
1372 A void device. This device will not emit any data, and will drop any data it
1373 receives. The null backend does not take any options.
1375 @item -chardev socket ,id=@var{id} [@var{TCP options} or @var{unix options}] [,server] [,nowait] [,telnet]
1377 Create a two-way stream socket, which can be either a TCP or a unix socket. A
1378 unix socket will be created if @option{path} is specified. Behaviour is
1379 undefined if TCP options are specified for a unix socket.
1381 @option{server} specifies that the socket shall be a listening socket.
1383 @option{nowait} specifies that QEMU should not block waiting for a client to
1384 connect to a listening socket.
1386 @option{telnet} specifies that traffic on the socket should interpret telnet
1389 TCP and unix socket options are given below:
1393 @item TCP options: port=@var{port} [,host=@var{host}] [,to=@var{to}] [,ipv4] [,ipv6] [,nodelay]
1395 @option{host} for a listening socket specifies the local address to be bound.
1396 For a connecting socket species the remote host to connect to. @option{host} is
1397 optional for listening sockets. If not specified it defaults to @code{0.0.0.0}.
1399 @option{port} for a listening socket specifies the local port to be bound. For a
1400 connecting socket specifies the port on the remote host to connect to.
1401 @option{port} can be given as either a port number or a service name.
1402 @option{port} is required.
1404 @option{to} is only relevant to listening sockets. If it is specified, and
1405 @option{port} cannot be bound, QEMU will attempt to bind to subsequent ports up
1406 to and including @option{to} until it succeeds. @option{to} must be specified
1409 @option{ipv4} and @option{ipv6} specify that either IPv4 or IPv6 must be used.
1410 If neither is specified the socket may use either protocol.
1412 @option{nodelay} disables the Nagle algorithm.
1414 @item unix options: path=@var{path}
1416 @option{path} specifies the local path of the unix socket. @option{path} is
1421 @item -chardev udp ,id=@var{id} [,host=@var{host}] ,port=@var{port} [,localaddr=@var{localaddr}] [,localport=@var{localport}] [,ipv4] [,ipv6]
1423 Sends all traffic from the guest to a remote host over UDP.
1425 @option{host} specifies the remote host to connect to. If not specified it
1426 defaults to @code{localhost}.
1428 @option{port} specifies the port on the remote host to connect to. @option{port}
1431 @option{localaddr} specifies the local address to bind to. If not specified it
1432 defaults to @code{0.0.0.0}.
1434 @option{localport} specifies the local port to bind to. If not specified any
1435 available local port will be used.
1437 @option{ipv4} and @option{ipv6} specify that either IPv4 or IPv6 must be used.
1438 If neither is specified the device may use either protocol.
1440 @item -chardev msmouse ,id=@var{id}
1442 Forward QEMU's emulated msmouse events to the guest. @option{msmouse} does not
1445 @item -chardev vc ,id=@var{id} [[,width=@var{width}] [,height=@var{height}]] [[,cols=@var{cols}] [,rows=@var{rows}]]
1447 Connect to a QEMU text console. @option{vc} may optionally be given a specific
1450 @option{width} and @option{height} specify the width and height respectively of
1451 the console, in pixels.
1453 @option{cols} and @option{rows} specify that the console be sized to fit a text
1454 console with the given dimensions.
1456 @item -chardev file ,id=@var{id} ,path=@var{path}
1458 Log all traffic received from the guest to a file.
1460 @option{path} specifies the path of the file to be opened. This file will be
1461 created if it does not already exist, and overwritten if it does. @option{path}
1464 @item -chardev pipe ,id=@var{id} ,path=@var{path}
1466 Create a two-way connection to the guest. The behaviour differs slightly between
1467 Windows hosts and other hosts:
1469 On Windows, a single duplex pipe will be created at
1470 @file{\\.pipe\@option{path}}.
1472 On other hosts, 2 pipes will be created called @file{@option{path}.in} and
1473 @file{@option{path}.out}. Data written to @file{@option{path}.in} will be
1474 received by the guest. Data written by the guest can be read from
1475 @file{@option{path}.out}. QEMU will not create these fifos, and requires them to
1478 @option{path} forms part of the pipe path as described above. @option{path} is
1481 @item -chardev console ,id=@var{id}
1483 Send traffic from the guest to QEMU's standard output. @option{console} does not
1486 @option{console} is only available on Windows hosts.
1488 @item -chardev serial ,id=@var{id} ,path=@option{path}
1490 Send traffic from the guest to a serial device on the host.
1493 only available on Windows hosts.
1495 @option{path} specifies the name of the serial device to open.
1497 @item -chardev pty ,id=@var{id}
1499 Create a new pseudo-terminal on the host and connect to it. @option{pty} does
1500 not take any options.
1502 @option{pty} is not available on Windows hosts.
1504 @item -chardev stdio ,id=@var{id} [,signal=on|off]
1505 Connect to standard input and standard output of the qemu process.
1507 @option{signal} controls if signals are enabled on the terminal, that includes
1508 exiting QEMU with the key sequence @key{Control-c}. This option is enabled by
1509 default, use @option{signal=off} to disable it.
1511 @option{stdio} is not available on Windows hosts.
1513 @item -chardev braille ,id=@var{id}
1515 Connect to a local BrlAPI server. @option{braille} does not take any options.
1517 @item -chardev tty ,id=@var{id} ,path=@var{path}
1519 Connect to a local tty device.
1521 @option{tty} is only available on Linux, Sun, FreeBSD, NetBSD, OpenBSD and
1524 @option{path} specifies the path to the tty. @option{path} is required.
1526 @item -chardev parport ,id=@var{id} ,path=@var{path}
1528 @option{parport} is only available on Linux, FreeBSD and DragonFlyBSD hosts.
1530 Connect to a local parallel port.
1532 @option{path} specifies the path to the parallel port device. @option{path} is
1540 DEFHEADING(Bluetooth(R) options:)
1542 DEF("bt", HAS_ARG, QEMU_OPTION_bt, \
1543 "-bt hci,null dumb bluetooth HCI - doesn't respond to commands\n" \
1544 "-bt hci,host[:id]\n" \
1545 " use host's HCI with the given name\n" \
1546 "-bt hci[,vlan=n]\n" \
1547 " emulate a standard HCI in virtual scatternet 'n'\n" \
1548 "-bt vhci[,vlan=n]\n" \
1549 " add host computer to virtual scatternet 'n' using VHCI\n" \
1550 "-bt device:dev[,vlan=n]\n" \
1551 " emulate a bluetooth device 'dev' in scatternet 'n'\n",
1558 Defines the function of the corresponding Bluetooth HCI. -bt options
1559 are matched with the HCIs present in the chosen machine type. For
1560 example when emulating a machine with only one HCI built into it, only
1561 the first @code{-bt hci[...]} option is valid and defines the HCI's
1562 logic. The Transport Layer is decided by the machine type. Currently
1563 the machines @code{n800} and @code{n810} have one HCI and all other
1567 The following three types are recognized:
1571 (default) The corresponding Bluetooth HCI assumes no internal logic
1572 and will not respond to any HCI commands or emit events.
1574 @item -bt hci,host[:@var{id}]
1575 (@code{bluez} only) The corresponding HCI passes commands / events
1576 to / from the physical HCI identified by the name @var{id} (default:
1577 @code{hci0}) on the computer running QEMU. Only available on @code{bluez}
1578 capable systems like Linux.
1580 @item -bt hci[,vlan=@var{n}]
1581 Add a virtual, standard HCI that will participate in the Bluetooth
1582 scatternet @var{n} (default @code{0}). Similarly to @option{-net}
1583 VLANs, devices inside a bluetooth network @var{n} can only communicate
1584 with other devices in the same network (scatternet).
1587 @item -bt vhci[,vlan=@var{n}]
1588 (Linux-host only) Create a HCI in scatternet @var{n} (default 0) attached
1589 to the host bluetooth stack instead of to the emulated target. This
1590 allows the host and target machines to participate in a common scatternet
1591 and communicate. Requires the Linux @code{vhci} driver installed. Can
1592 be used as following:
1595 qemu [...OPTIONS...] -bt hci,vlan=5 -bt vhci,vlan=5
1598 @item -bt device:@var{dev}[,vlan=@var{n}]
1599 Emulate a bluetooth device @var{dev} and place it in network @var{n}
1600 (default @code{0}). QEMU can only emulate one type of bluetooth devices
1605 Virtual wireless keyboard implementing the HIDP bluetooth profile.
1612 DEFHEADING(Linux/Multiboot boot specific:)
1615 When using these options, you can use a given Linux or Multiboot
1616 kernel without installing it in the disk image. It can be useful
1617 for easier testing of various kernels.
1622 DEF("kernel", HAS_ARG, QEMU_OPTION_kernel, \
1623 "-kernel bzImage use 'bzImage' as kernel image\n", QEMU_ARCH_ALL)
1625 @item -kernel @var{bzImage}
1627 Use @var{bzImage} as kernel image. The kernel can be either a Linux kernel
1628 or in multiboot format.
1631 DEF("append", HAS_ARG, QEMU_OPTION_append, \
1632 "-append cmdline use 'cmdline' as kernel command line\n", QEMU_ARCH_ALL)
1634 @item -append @var{cmdline}
1636 Use @var{cmdline} as kernel command line
1639 DEF("initrd", HAS_ARG, QEMU_OPTION_initrd, \
1640 "-initrd file use 'file' as initial ram disk\n", QEMU_ARCH_ALL)
1642 @item -initrd @var{file}
1644 Use @var{file} as initial ram disk.
1646 @item -initrd "@var{file1} arg=foo,@var{file2}"
1648 This syntax is only available with multiboot.
1650 Use @var{file1} and @var{file2} as modules and pass arg=foo as parameter to the
1660 DEFHEADING(Debug/Expert options:)
1666 DEF("serial", HAS_ARG, QEMU_OPTION_serial, \
1667 "-serial dev redirect the serial port to char device 'dev'\n",
1670 @item -serial @var{dev}
1672 Redirect the virtual serial port to host character device
1673 @var{dev}. The default device is @code{vc} in graphical mode and
1674 @code{stdio} in non graphical mode.
1676 This option can be used several times to simulate up to 4 serial
1679 Use @code{-serial none} to disable all serial ports.
1681 Available character devices are:
1683 @item vc[:@var{W}x@var{H}]
1684 Virtual console. Optionally, a width and height can be given in pixel with
1688 It is also possible to specify width or height in characters:
1693 [Linux only] Pseudo TTY (a new PTY is automatically allocated)
1695 No device is allocated.
1699 [Linux only] Use host tty, e.g. @file{/dev/ttyS0}. The host serial port
1700 parameters are set according to the emulated ones.
1701 @item /dev/parport@var{N}
1702 [Linux only, parallel port only] Use host parallel port
1703 @var{N}. Currently SPP and EPP parallel port features can be used.
1704 @item file:@var{filename}
1705 Write output to @var{filename}. No character can be read.
1707 [Unix only] standard input/output
1708 @item pipe:@var{filename}
1709 name pipe @var{filename}
1711 [Windows only] Use host serial port @var{n}
1712 @item udp:[@var{remote_host}]:@var{remote_port}[@@[@var{src_ip}]:@var{src_port}]
1713 This implements UDP Net Console.
1714 When @var{remote_host} or @var{src_ip} are not specified
1715 they default to @code{0.0.0.0}.
1716 When not using a specified @var{src_port} a random port is automatically chosen.
1718 If you just want a simple readonly console you can use @code{netcat} or
1719 @code{nc}, by starting qemu with: @code{-serial udp::4555} and nc as:
1720 @code{nc -u -l -p 4555}. Any time qemu writes something to that port it
1721 will appear in the netconsole session.
1723 If you plan to send characters back via netconsole or you want to stop
1724 and start qemu a lot of times, you should have qemu use the same
1725 source port each time by using something like @code{-serial
1726 udp::4555@@:4556} to qemu. Another approach is to use a patched
1727 version of netcat which can listen to a TCP port and send and receive
1728 characters via udp. If you have a patched version of netcat which
1729 activates telnet remote echo and single char transfer, then you can
1730 use the following options to step up a netcat redirector to allow
1731 telnet on port 5555 to access the qemu port.
1734 -serial udp::4555@@:4556
1735 @item netcat options:
1736 -u -P 4555 -L 0.0.0.0:4556 -t -p 5555 -I -T
1737 @item telnet options:
1741 @item tcp:[@var{host}]:@var{port}[,@var{server}][,nowait][,nodelay]
1742 The TCP Net Console has two modes of operation. It can send the serial
1743 I/O to a location or wait for a connection from a location. By default
1744 the TCP Net Console is sent to @var{host} at the @var{port}. If you use
1745 the @var{server} option QEMU will wait for a client socket application
1746 to connect to the port before continuing, unless the @code{nowait}
1747 option was specified. The @code{nodelay} option disables the Nagle buffering
1748 algorithm. If @var{host} is omitted, 0.0.0.0 is assumed. Only
1749 one TCP connection at a time is accepted. You can use @code{telnet} to
1750 connect to the corresponding character device.
1752 @item Example to send tcp console to 192.168.0.2 port 4444
1753 -serial tcp:192.168.0.2:4444
1754 @item Example to listen and wait on port 4444 for connection
1755 -serial tcp::4444,server
1756 @item Example to not wait and listen on ip 192.168.0.100 port 4444
1757 -serial tcp:192.168.0.100:4444,server,nowait
1760 @item telnet:@var{host}:@var{port}[,server][,nowait][,nodelay]
1761 The telnet protocol is used instead of raw tcp sockets. The options
1762 work the same as if you had specified @code{-serial tcp}. The
1763 difference is that the port acts like a telnet server or client using
1764 telnet option negotiation. This will also allow you to send the
1765 MAGIC_SYSRQ sequence if you use a telnet that supports sending the break
1766 sequence. Typically in unix telnet you do it with Control-] and then
1767 type "send break" followed by pressing the enter key.
1769 @item unix:@var{path}[,server][,nowait]
1770 A unix domain socket is used instead of a tcp socket. The option works the
1771 same as if you had specified @code{-serial tcp} except the unix domain socket
1772 @var{path} is used for connections.
1774 @item mon:@var{dev_string}
1775 This is a special option to allow the monitor to be multiplexed onto
1776 another serial port. The monitor is accessed with key sequence of
1777 @key{Control-a} and then pressing @key{c}. See monitor access
1778 @ref{pcsys_keys} in the -nographic section for more keys.
1779 @var{dev_string} should be any one of the serial devices specified
1780 above. An example to multiplex the monitor onto a telnet server
1781 listening on port 4444 would be:
1783 @item -serial mon:telnet::4444,server,nowait
1787 Braille device. This will use BrlAPI to display the braille output on a real
1791 Three button serial mouse. Configure the guest to use Microsoft protocol.
1795 DEF("parallel", HAS_ARG, QEMU_OPTION_parallel, \
1796 "-parallel dev redirect the parallel port to char device 'dev'\n",
1799 @item -parallel @var{dev}
1801 Redirect the virtual parallel port to host device @var{dev} (same
1802 devices as the serial port). On Linux hosts, @file{/dev/parportN} can
1803 be used to use hardware devices connected on the corresponding host
1806 This option can be used several times to simulate up to 3 parallel
1809 Use @code{-parallel none} to disable all parallel ports.
1812 DEF("monitor", HAS_ARG, QEMU_OPTION_monitor, \
1813 "-monitor dev redirect the monitor to char device 'dev'\n",
1816 @item -monitor @var{dev}
1818 Redirect the monitor to host device @var{dev} (same devices as the
1820 The default device is @code{vc} in graphical mode and @code{stdio} in
1823 DEF("qmp", HAS_ARG, QEMU_OPTION_qmp, \
1824 "-qmp dev like -monitor but opens in 'control' mode\n",
1827 @item -qmp @var{dev}
1829 Like -monitor but opens in 'control' mode.
1832 DEF("mon", HAS_ARG, QEMU_OPTION_mon, \
1833 "-mon chardev=[name][,mode=readline|control][,default]\n", QEMU_ARCH_ALL)
1835 @item -mon chardev=[name][,mode=readline|control][,default]
1837 Setup monitor on chardev @var{name}.
1840 DEF("debugcon", HAS_ARG, QEMU_OPTION_debugcon, \
1841 "-debugcon dev redirect the debug console to char device 'dev'\n",
1844 @item -debugcon @var{dev}
1846 Redirect the debug console to host device @var{dev} (same devices as the
1847 serial port). The debug console is an I/O port which is typically port
1848 0xe9; writing to that I/O port sends output to this device.
1849 The default device is @code{vc} in graphical mode and @code{stdio} in
1853 DEF("pidfile", HAS_ARG, QEMU_OPTION_pidfile, \
1854 "-pidfile file write PID to 'file'\n", QEMU_ARCH_ALL)
1856 @item -pidfile @var{file}
1858 Store the QEMU process PID in @var{file}. It is useful if you launch QEMU
1862 DEF("singlestep", 0, QEMU_OPTION_singlestep, \
1863 "-singlestep always run in singlestep mode\n", QEMU_ARCH_ALL)
1867 Run the emulation in single step mode.
1870 DEF("S", 0, QEMU_OPTION_S, \
1871 "-S freeze CPU at startup (use 'c' to start execution)\n",
1876 Do not start CPU at startup (you must type 'c' in the monitor).
1879 DEF("gdb", HAS_ARG, QEMU_OPTION_gdb, \
1880 "-gdb dev wait for gdb connection on 'dev'\n", QEMU_ARCH_ALL)
1882 @item -gdb @var{dev}
1884 Wait for gdb connection on device @var{dev} (@pxref{gdb_usage}). Typical
1885 connections will likely be TCP-based, but also UDP, pseudo TTY, or even
1886 stdio are reasonable use case. The latter is allowing to start qemu from
1887 within gdb and establish the connection via a pipe:
1889 (gdb) target remote | exec qemu -gdb stdio ...
1893 DEF("s", 0, QEMU_OPTION_s, \
1894 "-s shorthand for -gdb tcp::" DEFAULT_GDBSTUB_PORT "\n",
1899 Shorthand for -gdb tcp::1234, i.e. open a gdbserver on TCP port 1234
1900 (@pxref{gdb_usage}).
1903 DEF("d", HAS_ARG, QEMU_OPTION_d, \
1904 "-d item1,... output log to /tmp/qemu.log (use -d ? for a list of log items)\n",
1909 Output log in /tmp/qemu.log
1912 DEF("hdachs", HAS_ARG, QEMU_OPTION_hdachs, \
1913 "-hdachs c,h,s[,t]\n" \
1914 " force hard disk 0 physical geometry and the optional BIOS\n" \
1915 " translation (t=none or lba) (usually qemu can guess them)\n",
1918 @item -hdachs @var{c},@var{h},@var{s},[,@var{t}]
1920 Force hard disk 0 physical geometry (1 <= @var{c} <= 16383, 1 <=
1921 @var{h} <= 16, 1 <= @var{s} <= 63) and optionally force the BIOS
1922 translation mode (@var{t}=none, lba or auto). Usually QEMU can guess
1923 all those parameters. This option is useful for old MS-DOS disk
1927 DEF("L", HAS_ARG, QEMU_OPTION_L, \
1928 "-L path set the directory for the BIOS, VGA BIOS and keymaps\n",
1933 Set the directory for the BIOS, VGA BIOS and keymaps.
1936 DEF("bios", HAS_ARG, QEMU_OPTION_bios, \
1937 "-bios file set the filename for the BIOS\n", QEMU_ARCH_ALL)
1939 @item -bios @var{file}
1941 Set the filename for the BIOS.
1944 DEF("enable-kvm", 0, QEMU_OPTION_enable_kvm, \
1945 "-enable-kvm enable KVM full virtualization support\n", QEMU_ARCH_ALL)
1949 Enable KVM full virtualization support. This option is only available
1950 if KVM support is enabled when compiling.
1953 DEF("xen-domid", HAS_ARG, QEMU_OPTION_xen_domid,
1954 "-xen-domid id specify xen guest domain id\n", QEMU_ARCH_ALL)
1955 DEF("xen-create", 0, QEMU_OPTION_xen_create,
1956 "-xen-create create domain using xen hypercalls, bypassing xend\n"
1957 " warning: should not be used when xend is in use\n",
1959 DEF("xen-attach", 0, QEMU_OPTION_xen_attach,
1960 "-xen-attach attach to existing xen domain\n"
1961 " xend will use this when starting qemu\n",
1964 @item -xen-domid @var{id}
1966 Specify xen guest domain @var{id} (XEN only).
1969 Create domain using xen hypercalls, bypassing xend.
1970 Warning: should not be used when xend is in use (XEN only).
1973 Attach to existing xen domain.
1974 xend will use this when starting qemu (XEN only).
1977 DEF("no-reboot", 0, QEMU_OPTION_no_reboot, \
1978 "-no-reboot exit instead of rebooting\n", QEMU_ARCH_ALL)
1982 Exit instead of rebooting.
1985 DEF("no-shutdown", 0, QEMU_OPTION_no_shutdown, \
1986 "-no-shutdown stop before shutdown\n", QEMU_ARCH_ALL)
1989 @findex -no-shutdown
1990 Don't exit QEMU on guest shutdown, but instead only stop the emulation.
1991 This allows for instance switching to monitor to commit changes to the
1995 DEF("loadvm", HAS_ARG, QEMU_OPTION_loadvm, \
1996 "-loadvm [tag|id]\n" \
1997 " start right away with a saved state (loadvm in monitor)\n",
2000 @item -loadvm @var{file}
2002 Start right away with a saved state (@code{loadvm} in monitor)
2006 DEF("daemonize", 0, QEMU_OPTION_daemonize, \
2007 "-daemonize daemonize QEMU after initializing\n", QEMU_ARCH_ALL)
2012 Daemonize the QEMU process after initialization. QEMU will not detach from
2013 standard IO until it is ready to receive connections on any of its devices.
2014 This option is a useful way for external programs to launch QEMU without having
2015 to cope with initialization race conditions.
2018 DEF("option-rom", HAS_ARG, QEMU_OPTION_option_rom, \
2019 "-option-rom rom load a file, rom, into the option ROM space\n",
2022 @item -option-rom @var{file}
2024 Load the contents of @var{file} as an option ROM.
2025 This option is useful to load things like EtherBoot.
2028 DEF("clock", HAS_ARG, QEMU_OPTION_clock, \
2029 "-clock force the use of the given methods for timer alarm.\n" \
2030 " To see what timers are available use -clock ?\n",
2033 @item -clock @var{method}
2035 Force the use of the given methods for timer alarm. To see what timers
2036 are available use -clock ?.
2039 HXCOMM Options deprecated by -rtc
2040 DEF("localtime", 0, QEMU_OPTION_localtime, "", QEMU_ARCH_ALL)
2041 DEF("startdate", HAS_ARG, QEMU_OPTION_startdate, "", QEMU_ARCH_ALL)
2043 DEF("rtc", HAS_ARG, QEMU_OPTION_rtc, \
2044 "-rtc [base=utc|localtime|date][,clock=host|vm][,driftfix=none|slew]\n" \
2045 " set the RTC base and clock, enable drift fix for clock ticks (x86 only)\n",
2050 @item -rtc [base=utc|localtime|@var{date}][,clock=host|vm][,driftfix=none|slew]
2052 Specify @option{base} as @code{utc} or @code{localtime} to let the RTC start at the current
2053 UTC or local time, respectively. @code{localtime} is required for correct date in
2054 MS-DOS or Windows. To start at a specific point in time, provide @var{date} in the
2055 format @code{2006-06-17T16:01:21} or @code{2006-06-17}. The default base is UTC.
2057 By default the RTC is driven by the host system time. This allows to use the
2058 RTC as accurate reference clock inside the guest, specifically if the host
2059 time is smoothly following an accurate external reference clock, e.g. via NTP.
2060 If you want to isolate the guest time from the host, even prevent it from
2061 progressing during suspension, you can set @option{clock} to @code{vm} instead.
2063 Enable @option{driftfix} (i386 targets only) if you experience time drift problems,
2064 specifically with Windows' ACPI HAL. This option will try to figure out how
2065 many timer interrupts were not processed by the Windows guest and will
2069 DEF("icount", HAS_ARG, QEMU_OPTION_icount, \
2070 "-icount [N|auto]\n" \
2071 " enable virtual instruction counter with 2^N clock ticks per\n" \
2072 " instruction\n", QEMU_ARCH_ALL)
2074 @item -icount [@var{N}|auto]
2076 Enable virtual instruction counter. The virtual cpu will execute one
2077 instruction every 2^@var{N} ns of virtual time. If @code{auto} is specified
2078 then the virtual cpu speed will be automatically adjusted to keep virtual
2079 time within a few seconds of real time.
2081 Note that while this option can give deterministic behavior, it does not
2082 provide cycle accurate emulation. Modern CPUs contain superscalar out of
2083 order cores with complex cache hierarchies. The number of instructions
2084 executed often has little or no correlation with actual performance.
2087 DEF("watchdog", HAS_ARG, QEMU_OPTION_watchdog, \
2088 "-watchdog i6300esb|ib700\n" \
2089 " enable virtual hardware watchdog [default=none]\n",
2092 @item -watchdog @var{model}
2094 Create a virtual hardware watchdog device. Once enabled (by a guest
2095 action), the watchdog must be periodically polled by an agent inside
2096 the guest or else the guest will be restarted.
2098 The @var{model} is the model of hardware watchdog to emulate. Choices
2099 for model are: @code{ib700} (iBASE 700) which is a very simple ISA
2100 watchdog with a single timer, or @code{i6300esb} (Intel 6300ESB I/O
2101 controller hub) which is a much more featureful PCI-based dual-timer
2102 watchdog. Choose a model for which your guest has drivers.
2104 Use @code{-watchdog ?} to list available hardware models. Only one
2105 watchdog can be enabled for a guest.
2108 DEF("watchdog-action", HAS_ARG, QEMU_OPTION_watchdog_action, \
2109 "-watchdog-action reset|shutdown|poweroff|pause|debug|none\n" \
2110 " action when watchdog fires [default=reset]\n",
2113 @item -watchdog-action @var{action}
2115 The @var{action} controls what QEMU will do when the watchdog timer
2118 @code{reset} (forcefully reset the guest).
2119 Other possible actions are:
2120 @code{shutdown} (attempt to gracefully shutdown the guest),
2121 @code{poweroff} (forcefully poweroff the guest),
2122 @code{pause} (pause the guest),
2123 @code{debug} (print a debug message and continue), or
2124 @code{none} (do nothing).
2126 Note that the @code{shutdown} action requires that the guest responds
2127 to ACPI signals, which it may not be able to do in the sort of
2128 situations where the watchdog would have expired, and thus
2129 @code{-watchdog-action shutdown} is not recommended for production use.
2134 @item -watchdog i6300esb -watchdog-action pause
2135 @item -watchdog ib700
2139 DEF("echr", HAS_ARG, QEMU_OPTION_echr, \
2140 "-echr chr set terminal escape character instead of ctrl-a\n",
2144 @item -echr @var{numeric_ascii_value}
2146 Change the escape character used for switching to the monitor when using
2147 monitor and serial sharing. The default is @code{0x01} when using the
2148 @code{-nographic} option. @code{0x01} is equal to pressing
2149 @code{Control-a}. You can select a different character from the ascii
2150 control keys where 1 through 26 map to Control-a through Control-z. For
2151 instance you could use the either of the following to change the escape
2152 character to Control-t.
2159 DEF("virtioconsole", HAS_ARG, QEMU_OPTION_virtiocon, \
2160 "-virtioconsole c\n" \
2161 " set virtio console\n", QEMU_ARCH_ALL)
2163 @item -virtioconsole @var{c}
2164 @findex -virtioconsole
2167 This option is maintained for backward compatibility.
2169 Please use @code{-device virtconsole} for the new way of invocation.
2172 DEF("show-cursor", 0, QEMU_OPTION_show_cursor, \
2173 "-show-cursor show cursor\n", QEMU_ARCH_ALL)
2176 @findex -show-cursor
2180 DEF("tb-size", HAS_ARG, QEMU_OPTION_tb_size, \
2181 "-tb-size n set TB size\n", QEMU_ARCH_ALL)
2183 @item -tb-size @var{n}
2188 DEF("incoming", HAS_ARG, QEMU_OPTION_incoming, \
2189 "-incoming p prepare for incoming migration, listen on port p\n",
2192 @item -incoming @var{port}
2194 Prepare for incoming migration, listen on @var{port}.
2197 DEF("nodefaults", 0, QEMU_OPTION_nodefaults, \
2198 "-nodefaults don't create default devices\n", QEMU_ARCH_ALL)
2202 Don't create default devices.
2206 DEF("chroot", HAS_ARG, QEMU_OPTION_chroot, \
2207 "-chroot dir chroot to dir just before starting the VM\n",
2211 @item -chroot @var{dir}
2213 Immediately before starting guest execution, chroot to the specified
2214 directory. Especially useful in combination with -runas.
2218 DEF("runas", HAS_ARG, QEMU_OPTION_runas, \
2219 "-runas user change to user id user just before starting the VM\n",
2223 @item -runas @var{user}
2225 Immediately before starting guest execution, drop root privileges, switching
2226 to the specified user.
2229 DEF("prom-env", HAS_ARG, QEMU_OPTION_prom_env,
2230 "-prom-env variable=value\n"
2231 " set OpenBIOS nvram variables\n",
2232 QEMU_ARCH_PPC | QEMU_ARCH_SPARC)
2234 @item -prom-env @var{variable}=@var{value}
2236 Set OpenBIOS nvram @var{variable} to given @var{value} (PPC, SPARC only).
2238 DEF("semihosting", 0, QEMU_OPTION_semihosting,
2239 "-semihosting semihosting mode\n", QEMU_ARCH_ARM | QEMU_ARCH_M68K)
2242 @findex -semihosting
2243 Semihosting mode (ARM, M68K only).
2245 DEF("old-param", 0, QEMU_OPTION_old_param,
2246 "-old-param old param mode\n", QEMU_ARCH_ARM)
2249 @findex -old-param (ARM)
2250 Old param mode (ARM only).
2253 DEF("readconfig", HAS_ARG, QEMU_OPTION_readconfig,
2254 "-readconfig <file>\n", QEMU_ARCH_ALL)
2256 @item -readconfig @var{file}
2258 Read device configuration from @var{file}.
2260 DEF("writeconfig", HAS_ARG, QEMU_OPTION_writeconfig,
2261 "-writeconfig <file>\n"
2262 " read/write config file\n", QEMU_ARCH_ALL)
2264 @item -writeconfig @var{file}
2265 @findex -writeconfig
2266 Write device configuration to @var{file}.
2268 DEF("nodefconfig", 0, QEMU_OPTION_nodefconfig,
2270 " do not load default config files at startup\n",
2274 @findex -nodefconfig
2275 Normally QEMU loads a configuration file from @var{sysconfdir}/qemu.conf and
2276 @var{sysconfdir}/target-@var{ARCH}.conf on startup. The @code{-nodefconfig}
2277 option will prevent QEMU from loading these configuration files at startup.
2279 #ifdef CONFIG_SIMPLE_TRACE
2280 DEF("trace", HAS_ARG, QEMU_OPTION_trace,
2282 " Specify a trace file to log traces to\n",
2287 Specify a trace file to log output traces to.
2291 HXCOMM This is the last statement. Insert new options before this line!