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][,format=f][,serial=s]\n"
122 " [,addr=A][,id=name][,aio=threads|native][,readonly=on|off]\n"
123 " use 'file' as a drive image\n", QEMU_ARCH_ALL)
125 @item -drive @var{option}[,@var{option}[,@var{option}[,...]]]
128 Define a new drive. Valid options are:
131 @item file=@var{file}
132 This option defines which disk image (@pxref{disk_images}) to use with
133 this drive. If the filename contains comma, you must double it
134 (for instance, "file=my,,file" to use file "my,file").
135 @item if=@var{interface}
136 This option defines on which type on interface the drive is connected.
137 Available types are: ide, scsi, sd, mtd, floppy, pflash, virtio.
138 @item bus=@var{bus},unit=@var{unit}
139 These options define where is connected the drive by defining the bus number and
141 @item index=@var{index}
142 This option defines where is connected the drive by using an index in the list
143 of available connectors of a given interface type.
144 @item media=@var{media}
145 This option defines the type of the media: disk or cdrom.
146 @item cyls=@var{c},heads=@var{h},secs=@var{s}[,trans=@var{t}]
147 These options have the same definition as they have in @option{-hdachs}.
148 @item snapshot=@var{snapshot}
149 @var{snapshot} is "on" or "off" and allows to enable snapshot for given drive (see @option{-snapshot}).
150 @item cache=@var{cache}
151 @var{cache} is "none", "writeback", or "writethrough" and controls how the host cache is used to access block data.
153 @var{aio} is "threads", or "native" and selects between pthread based disk I/O and native Linux AIO.
154 @item format=@var{format}
155 Specify which disk @var{format} will be used rather than detecting
156 the format. Can be used to specifiy format=raw to avoid interpreting
157 an untrusted format header.
158 @item serial=@var{serial}
159 This option specifies the serial number to assign to the device.
160 @item addr=@var{addr}
161 Specify the controller's PCI address (if=virtio only).
164 By default, writethrough caching is used for all block device. This means that
165 the host page cache will be used to read and write data but write notification
166 will be sent to the guest only when the data has been reported as written by
167 the storage subsystem.
169 Writeback caching will report data writes as completed as soon as the data is
170 present in the host page cache. This is safe as long as you trust your host.
171 If your host crashes or loses power, then the guest may experience data
172 corruption. When using the @option{-snapshot} option, writeback caching is
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 Instead of @option{-cdrom} you can use:
185 qemu -drive file=file,index=2,media=cdrom
188 Instead of @option{-hda}, @option{-hdb}, @option{-hdc}, @option{-hdd}, you can
191 qemu -drive file=file,index=0,media=disk
192 qemu -drive file=file,index=1,media=disk
193 qemu -drive file=file,index=2,media=disk
194 qemu -drive file=file,index=3,media=disk
197 You can connect a CDROM to the slave of ide0:
199 qemu -drive file=file,if=ide,index=1,media=cdrom
202 If you don't specify the "file=" argument, you define an empty drive:
204 qemu -drive if=ide,index=1,media=cdrom
207 You can connect a SCSI disk with unit ID 6 on the bus #0:
209 qemu -drive file=file,if=scsi,bus=0,unit=6
212 Instead of @option{-fda}, @option{-fdb}, you can use:
214 qemu -drive file=file,index=0,if=floppy
215 qemu -drive file=file,index=1,if=floppy
218 By default, @var{interface} is "ide" and @var{index} is automatically
221 qemu -drive file=a -drive file=b"
229 DEF("set", HAS_ARG, QEMU_OPTION_set,
230 "-set group.id.arg=value\n"
231 " set <arg> parameter for item <id> of type <group>\n"
232 " i.e. -set drive.$id.file=/path/to/image\n", QEMU_ARCH_ALL)
239 DEF("global", HAS_ARG, QEMU_OPTION_global,
240 "-global driver.property=value\n"
241 " set a global default for a driver property\n",
249 DEF("mtdblock", HAS_ARG, QEMU_OPTION_mtdblock,
250 "-mtdblock file use 'file' as on-board Flash memory image\n",
253 @item -mtdblock @var{file}
255 Use @var{file} as on-board Flash memory image.
258 DEF("sd", HAS_ARG, QEMU_OPTION_sd,
259 "-sd file use 'file' as SecureDigital card image\n", QEMU_ARCH_ALL)
263 Use @var{file} as SecureDigital card image.
266 DEF("pflash", HAS_ARG, QEMU_OPTION_pflash,
267 "-pflash file use 'file' as a parallel flash image\n", QEMU_ARCH_ALL)
269 @item -pflash @var{file}
271 Use @var{file} as a parallel flash image.
274 DEF("boot", HAS_ARG, QEMU_OPTION_boot,
275 "-boot [order=drives][,once=drives][,menu=on|off]\n"
276 " 'drives': floppy (a), hard disk (c), CD-ROM (d), network (n)\n",
279 @item -boot [order=@var{drives}][,once=@var{drives}][,menu=on|off]
281 Specify boot order @var{drives} as a string of drive letters. Valid
282 drive letters depend on the target achitecture. The x86 PC uses: a, b
283 (floppy 1 and 2), c (first hard disk), d (first CD-ROM), n-p (Etherboot
284 from network adapter 1-4), hard disk boot is the default. To apply a
285 particular boot order only on the first startup, specify it via
288 Interactive boot menus/prompts can be enabled via @option{menu=on} as far
289 as firmware/BIOS supports them. The default is non-interactive boot.
292 # try to boot from network first, then from hard disk
294 # boot from CD-ROM first, switch back to default order after reboot
298 Note: The legacy format '-boot @var{drives}' is still supported but its
299 use is discouraged as it may be removed from future versions.
302 DEF("snapshot", 0, QEMU_OPTION_snapshot,
303 "-snapshot write to temporary files instead of disk image files\n",
308 Write to temporary files instead of disk image files. In this case,
309 the raw disk image you use is not written back. You can however force
310 the write back by pressing @key{C-a s} (@pxref{disk_images}).
313 DEF("m", HAS_ARG, QEMU_OPTION_m,
314 "-m megs set virtual RAM size to megs MB [default="
315 stringify(DEFAULT_RAM_SIZE) "]\n", QEMU_ARCH_ALL)
319 Set virtual RAM size to @var{megs} megabytes. Default is 128 MiB. Optionally,
320 a suffix of ``M'' or ``G'' can be used to signify a value in megabytes or
321 gigabytes respectively.
324 DEF("mem-path", HAS_ARG, QEMU_OPTION_mempath,
325 "-mem-path FILE provide backing storage for guest RAM\n", QEMU_ARCH_ALL)
327 @item -mem-path @var{path}
328 Allocate guest RAM from a temporarily created file in @var{path}.
332 DEF("mem-prealloc", 0, QEMU_OPTION_mem_prealloc,
333 "-mem-prealloc preallocate guest memory (use with -mem-path)\n",
337 Preallocate memory when using -mem-path.
341 DEF("k", HAS_ARG, QEMU_OPTION_k,
342 "-k language use keyboard layout (for example 'fr' for French)\n",
345 @item -k @var{language}
347 Use keyboard layout @var{language} (for example @code{fr} for
348 French). This option is only needed where it is not easy to get raw PC
349 keycodes (e.g. on Macs, with some X11 servers or with a VNC
350 display). You don't normally need to use it on PC/Linux or PC/Windows
353 The available layouts are:
355 ar de-ch es fo fr-ca hu ja mk no pt-br sv
356 da en-gb et fr fr-ch is lt nl pl ru th
357 de en-us fi fr-be hr it lv nl-be pt sl tr
360 The default is @code{en-us}.
364 DEF("audio-help", 0, QEMU_OPTION_audio_help,
365 "-audio-help print list of audio drivers and their options\n",
370 Will show the audio subsystem help: list of drivers, tunable
374 DEF("soundhw", HAS_ARG, QEMU_OPTION_soundhw,
375 "-soundhw c1,... enable audio support\n"
376 " and only specified sound cards (comma separated list)\n"
377 " use -soundhw ? to get the list of supported cards\n"
378 " use -soundhw all to enable all of them\n", QEMU_ARCH_ALL)
380 @item -soundhw @var{card1}[,@var{card2},...] or -soundhw all
382 Enable audio and selected sound hardware. Use ? to print all
383 available sound hardware.
386 qemu -soundhw sb16,adlib disk.img
387 qemu -soundhw es1370 disk.img
388 qemu -soundhw ac97 disk.img
389 qemu -soundhw all disk.img
393 Note that Linux's i810_audio OSS kernel (for AC97) module might
394 require manually specifying clocking.
397 modprobe i810_audio clocking=48000
405 DEF("usb", 0, QEMU_OPTION_usb,
406 "-usb enable the USB driver (will be the default soon)\n",
414 Enable the USB driver (will be the default soon)
417 DEF("usbdevice", HAS_ARG, QEMU_OPTION_usbdevice,
418 "-usbdevice name add the host or guest USB device 'name'\n",
422 @item -usbdevice @var{devname}
424 Add the USB device @var{devname}. @xref{usb_devices}.
429 Virtual Mouse. This will override the PS/2 mouse emulation when activated.
432 Pointer device that uses absolute coordinates (like a touchscreen). This
433 means qemu is able to report the mouse position without having to grab the
434 mouse. Also overrides the PS/2 mouse emulation when activated.
436 @item disk:[format=@var{format}]:@var{file}
437 Mass storage device based on file. The optional @var{format} argument
438 will be used rather than detecting the format. Can be used to specifiy
439 @code{format=raw} to avoid interpreting an untrusted format header.
441 @item host:@var{bus}.@var{addr}
442 Pass through the host device identified by @var{bus}.@var{addr} (Linux only).
444 @item host:@var{vendor_id}:@var{product_id}
445 Pass through the host device identified by @var{vendor_id}:@var{product_id}
448 @item serial:[vendorid=@var{vendor_id}][,productid=@var{product_id}]:@var{dev}
449 Serial converter to host character device @var{dev}, see @code{-serial} for the
453 Braille device. This will use BrlAPI to display the braille output on a real
456 @item net:@var{options}
457 Network adapter that supports CDC ethernet and RNDIS protocols.
462 DEF("device", HAS_ARG, QEMU_OPTION_device,
463 "-device driver[,prop[=value][,...]]\n"
464 " add device (based on driver)\n"
465 " prop=value,... sets driver properties\n"
466 " use -device ? to print all possible drivers\n"
467 " use -device driver,? to print all possible options\n"
468 " use -device driver,option=? to print a help for value\n",
471 @item -device @var{driver}[,@var{option}[=@var{value}][,...]]
473 Add device @var{driver}. Depending on the device type,
474 @var{option} (with default or given @var{value}) may be useful.
475 To get a help on possible @var{driver}s, @var{option}s or @var{value}s, use
477 @code{-device @var{driver},?} or
478 @code{-device @var{driver},@var{option}=?}.
481 DEF("name", HAS_ARG, QEMU_OPTION_name,
482 "-name string1[,process=string2]\n"
483 " set the name of the guest\n"
484 " string1 sets the window title and string2 the process name (on Linux)\n",
487 @item -name @var{name}
489 Sets the @var{name} of the guest.
490 This name will be displayed in the SDL window caption.
491 The @var{name} will also be used for the VNC server.
492 Also optionally set the top visible process name in Linux.
495 DEF("uuid", HAS_ARG, QEMU_OPTION_uuid,
496 "-uuid %08x-%04x-%04x-%04x-%012x\n"
497 " specify machine UUID\n", QEMU_ARCH_ALL)
499 @item -uuid @var{uuid}
510 DEFHEADING(Display options:)
516 DEF("nographic", 0, QEMU_OPTION_nographic,
517 "-nographic disable graphical output and redirect serial I/Os to console\n",
522 Normally, QEMU uses SDL to display the VGA output. With this option,
523 you can totally disable graphical output so that QEMU is a simple
524 command line application. The emulated serial port is redirected on
525 the console. Therefore, you can still use QEMU to debug a Linux kernel
526 with a serial console.
530 DEF("curses", 0, QEMU_OPTION_curses,
531 "-curses use a curses/ncurses interface instead of SDL\n",
537 Normally, QEMU uses SDL to display the VGA output. With this option,
538 QEMU can display the VGA output when in text mode using a
539 curses/ncurses interface. Nothing is displayed in graphical mode.
543 DEF("no-frame", 0, QEMU_OPTION_no_frame,
544 "-no-frame open SDL window without a frame and window decorations\n",
550 Do not use decorations for SDL windows and start them using the whole
551 available screen space. This makes the using QEMU in a dedicated desktop
552 workspace more convenient.
556 DEF("alt-grab", 0, QEMU_OPTION_alt_grab,
557 "-alt-grab use Ctrl-Alt-Shift to grab mouse (instead of Ctrl-Alt)\n",
563 Use Ctrl-Alt-Shift to grab mouse (instead of Ctrl-Alt).
567 DEF("ctrl-grab", 0, QEMU_OPTION_ctrl_grab,
568 "-ctrl-grab use Right-Ctrl to grab mouse (instead of Ctrl-Alt)\n",
574 Use Right-Ctrl to grab mouse (instead of Ctrl-Alt).
578 DEF("no-quit", 0, QEMU_OPTION_no_quit,
579 "-no-quit disable SDL window close capability\n", QEMU_ARCH_ALL)
584 Disable SDL window close capability.
588 DEF("sdl", 0, QEMU_OPTION_sdl,
589 "-sdl enable SDL\n", QEMU_ARCH_ALL)
597 DEF("portrait", 0, QEMU_OPTION_portrait,
598 "-portrait rotate graphical output 90 deg left (only PXA LCD)\n",
603 Rotate graphical output 90 deg left (only PXA LCD).
606 DEF("vga", HAS_ARG, QEMU_OPTION_vga,
607 "-vga [std|cirrus|vmware|xenfb|none]\n"
608 " select video card type\n", QEMU_ARCH_ALL)
610 @item -vga @var{type}
612 Select type of VGA card to emulate. Valid values for @var{type} are
615 Cirrus Logic GD5446 Video card. All Windows versions starting from
616 Windows 95 should recognize and use this graphic card. For optimal
617 performances, use 16 bit color depth in the guest and the host OS.
618 (This one is the default)
620 Standard VGA card with Bochs VBE extensions. If your guest OS
621 supports the VESA 2.0 VBE extensions (e.g. Windows XP) and if you want
622 to use high resolution modes (>= 1280x1024x16) then you should use
625 VMWare SVGA-II compatible adapter. Use it if you have sufficiently
626 recent XFree86/XOrg server or Windows guest with a driver for this
633 DEF("full-screen", 0, QEMU_OPTION_full_screen,
634 "-full-screen start in full screen\n", QEMU_ARCH_ALL)
638 Start in full screen.
641 DEF("g", 1, QEMU_OPTION_g ,
642 "-g WxH[xDEPTH] Set the initial graphical resolution and depth\n",
643 QEMU_ARCH_PPC | QEMU_ARCH_SPARC)
645 @item -g @var{width}x@var{height}[x@var{depth}]
647 Set the initial graphical resolution and depth (PPC, SPARC only).
650 DEF("vnc", HAS_ARG, QEMU_OPTION_vnc ,
651 "-vnc display start a VNC server on display\n", QEMU_ARCH_ALL)
653 @item -vnc @var{display}[,@var{option}[,@var{option}[,...]]]
655 Normally, QEMU uses SDL to display the VGA output. With this option,
656 you can have QEMU listen on VNC display @var{display} and redirect the VGA
657 display over the VNC session. It is very useful to enable the usb
658 tablet device when using this option (option @option{-usbdevice
659 tablet}). When using the VNC display, you must use the @option{-k}
660 parameter to set the keyboard layout if you are not using en-us. Valid
661 syntax for the @var{display} is
665 @item @var{host}:@var{d}
667 TCP connections will only be allowed from @var{host} on display @var{d}.
668 By convention the TCP port is 5900+@var{d}. Optionally, @var{host} can
669 be omitted in which case the server will accept connections from any host.
671 @item unix:@var{path}
673 Connections will be allowed over UNIX domain sockets where @var{path} is the
674 location of a unix socket to listen for connections on.
678 VNC is initialized but not started. The monitor @code{change} command
679 can be used to later start the VNC server.
683 Following the @var{display} value there may be one or more @var{option} flags
684 separated by commas. Valid options are
690 Connect to a listening VNC client via a ``reverse'' connection. The
691 client is specified by the @var{display}. For reverse network
692 connections (@var{host}:@var{d},@code{reverse}), the @var{d} argument
693 is a TCP port number, not a display number.
697 Require that password based authentication is used for client connections.
698 The password must be set separately using the @code{change} command in the
703 Require that client use TLS when communicating with the VNC server. This
704 uses anonymous TLS credentials so is susceptible to a man-in-the-middle
705 attack. It is recommended that this option be combined with either the
706 @option{x509} or @option{x509verify} options.
708 @item x509=@var{/path/to/certificate/dir}
710 Valid if @option{tls} is specified. Require that x509 credentials are used
711 for negotiating the TLS session. The server will send its x509 certificate
712 to the client. It is recommended that a password be set on the VNC server
713 to provide authentication of the client when this is used. The path following
714 this option specifies where the x509 certificates are to be loaded from.
715 See the @ref{vnc_security} section for details on generating certificates.
717 @item x509verify=@var{/path/to/certificate/dir}
719 Valid if @option{tls} is specified. Require that x509 credentials are used
720 for negotiating the TLS session. The server will send its x509 certificate
721 to the client, and request that the client send its own x509 certificate.
722 The server will validate the client's certificate against the CA certificate,
723 and reject clients when validation fails. If the certificate authority is
724 trusted, this is a sufficient authentication mechanism. You may still wish
725 to set a password on the VNC server as a second authentication layer. The
726 path following this option specifies where the x509 certificates are to
727 be loaded from. See the @ref{vnc_security} section for details on generating
732 Require that the client use SASL to authenticate with the VNC server.
733 The exact choice of authentication method used is controlled from the
734 system / user's SASL configuration file for the 'qemu' service. This
735 is typically found in /etc/sasl2/qemu.conf. If running QEMU as an
736 unprivileged user, an environment variable SASL_CONF_PATH can be used
737 to make it search alternate locations for the service config.
738 While some SASL auth methods can also provide data encryption (eg GSSAPI),
739 it is recommended that SASL always be combined with the 'tls' and
740 'x509' settings to enable use of SSL and server certificates. This
741 ensures a data encryption preventing compromise of authentication
742 credentials. See the @ref{vnc_security} section for details on using
747 Turn on access control lists for checking of the x509 client certificate
748 and SASL party. For x509 certs, the ACL check is made against the
749 certificate's distinguished name. This is something that looks like
750 @code{C=GB,O=ACME,L=Boston,CN=bob}. For SASL party, the ACL check is
751 made against the username, which depending on the SASL plugin, may
752 include a realm component, eg @code{bob} or @code{bob@@EXAMPLE.COM}.
753 When the @option{acl} flag is set, the initial access list will be
754 empty, with a @code{deny} policy. Thus no one will be allowed to
755 use the VNC server until the ACLs have been loaded. This can be
756 achieved using the @code{acl} monitor command.
767 DEFHEADING(i386 target only:)
772 DEF("win2k-hack", 0, QEMU_OPTION_win2k_hack,
773 "-win2k-hack use it when installing Windows 2000 to avoid a disk full bug\n",
778 Use it when installing Windows 2000 to avoid a disk full bug. After
779 Windows 2000 is installed, you no longer need this option (this option
780 slows down the IDE transfers).
783 HXCOMM Deprecated by -rtc
784 DEF("rtc-td-hack", 0, QEMU_OPTION_rtc_td_hack, "", QEMU_ARCH_I386)
786 DEF("no-fd-bootchk", 0, QEMU_OPTION_no_fd_bootchk,
787 "-no-fd-bootchk disable boot signature checking for floppy disks\n",
791 @findex -no-fd-bootchk
792 Disable boot signature checking for floppy disks in Bochs BIOS. It may
793 be needed to boot from old floppy disks.
794 TODO: check reference to Bochs BIOS.
797 DEF("no-acpi", 0, QEMU_OPTION_no_acpi,
798 "-no-acpi disable ACPI\n", QEMU_ARCH_I386)
802 Disable ACPI (Advanced Configuration and Power Interface) support. Use
803 it if your guest OS complains about ACPI problems (PC target machine
807 DEF("no-hpet", 0, QEMU_OPTION_no_hpet,
808 "-no-hpet disable HPET\n", QEMU_ARCH_I386)
812 Disable HPET support.
815 DEF("balloon", HAS_ARG, QEMU_OPTION_balloon,
816 "-balloon none disable balloon device\n"
817 "-balloon virtio[,addr=str]\n"
818 " enable virtio balloon device (default)\n", QEMU_ARCH_ALL)
822 Disable balloon device.
823 @item -balloon virtio[,addr=@var{addr}]
824 Enable virtio balloon device (default), optionally with PCI address
828 DEF("acpitable", HAS_ARG, QEMU_OPTION_acpitable,
829 "-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"
830 " ACPI table description\n", QEMU_ARCH_I386)
832 @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}]...]
834 Add ACPI table with specified header fields and context from specified files.
837 DEF("smbios", HAS_ARG, QEMU_OPTION_smbios,
838 "-smbios file=binary\n"
839 " load SMBIOS entry from binary file\n"
840 "-smbios type=0[,vendor=str][,version=str][,date=str][,release=%d.%d]\n"
841 " specify SMBIOS type 0 fields\n"
842 "-smbios type=1[,manufacturer=str][,product=str][,version=str][,serial=str]\n"
843 " [,uuid=uuid][,sku=str][,family=str]\n"
844 " specify SMBIOS type 1 fields\n", QEMU_ARCH_I386)
846 @item -smbios file=@var{binary}
848 Load SMBIOS entry from binary file.
850 @item -smbios type=0[,vendor=@var{str}][,version=@var{str}][,date=@var{str}][,release=@var{%d.%d}]
852 Specify SMBIOS type 0 fields
854 @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}]
855 Specify SMBIOS type 1 fields
863 DEFHEADING(Network options:)
868 HXCOMM Legacy slirp options (now moved to -net user):
870 DEF("tftp", HAS_ARG, QEMU_OPTION_tftp, "", QEMU_ARCH_ALL)
871 DEF("bootp", HAS_ARG, QEMU_OPTION_bootp, "", QEMU_ARCH_ALL)
872 DEF("redir", HAS_ARG, QEMU_OPTION_redir, "", QEMU_ARCH_ALL)
874 DEF("smb", HAS_ARG, QEMU_OPTION_smb, "", QEMU_ARCH_ALL)
878 DEF("net", HAS_ARG, QEMU_OPTION_net,
879 "-net nic[,vlan=n][,macaddr=mac][,model=type][,name=str][,addr=str][,vectors=v]\n"
880 " create a new Network Interface Card and connect it to VLAN 'n'\n"
882 "-net user[,vlan=n][,name=str][,net=addr[/mask]][,host=addr][,restrict=y|n]\n"
883 " [,hostname=host][,dhcpstart=addr][,dns=addr][,tftp=dir][,bootfile=f]\n"
884 " [,hostfwd=rule][,guestfwd=rule]"
886 "[,smb=dir[,smbserver=addr]]\n"
888 " connect the user mode network stack to VLAN 'n', configure its\n"
889 " DHCP server and enabled optional services\n"
892 "-net tap[,vlan=n][,name=str],ifname=name\n"
893 " connect the host TAP network interface to VLAN 'n'\n"
895 "-net tap[,vlan=n][,name=str][,fd=h][,ifname=name][,script=file][,downscript=dfile][,sndbuf=nbytes][,vnet_hdr=on|off]\n"
896 " connect the host TAP network interface to VLAN 'n' and use the\n"
897 " network scripts 'file' (default=" DEFAULT_NETWORK_SCRIPT ")\n"
898 " and 'dfile' (default=" DEFAULT_NETWORK_DOWN_SCRIPT ")\n"
899 " use '[down]script=no' to disable script execution\n"
900 " use 'fd=h' to connect to an already opened TAP interface\n"
901 " use 'sndbuf=nbytes' to limit the size of the send buffer (the\n"
902 " default of 'sndbuf=1048576' can be disabled using 'sndbuf=0')\n"
903 " use vnet_hdr=off to avoid enabling the IFF_VNET_HDR tap flag\n"
904 " use vnet_hdr=on to make the lack of IFF_VNET_HDR support an error condition\n"
906 "-net socket[,vlan=n][,name=str][,fd=h][,listen=[host]:port][,connect=host:port]\n"
907 " connect the vlan 'n' to another VLAN using a socket connection\n"
908 "-net socket[,vlan=n][,name=str][,fd=h][,mcast=maddr:port]\n"
909 " connect the vlan 'n' to multicast maddr and port\n"
911 "-net vde[,vlan=n][,name=str][,sock=socketpath][,port=n][,group=groupname][,mode=octalmode]\n"
912 " connect the vlan 'n' to port 'n' of a vde switch running\n"
913 " on host and listening for incoming connections on 'socketpath'.\n"
914 " Use group 'groupname' and mode 'octalmode' to change default\n"
915 " ownership and permissions for communication port.\n"
917 "-net dump[,vlan=n][,file=f][,len=n]\n"
918 " dump traffic on vlan 'n' to file 'f' (max n bytes per packet)\n"
919 "-net none use it alone to have zero network devices. If no -net option\n"
920 " is provided, the default is '-net nic -net user'\n", QEMU_ARCH_ALL)
921 DEF("netdev", HAS_ARG, QEMU_OPTION_netdev,
930 "socket],id=str[,option][,option][,...]\n", QEMU_ARCH_ALL)
932 @item -net nic[,vlan=@var{n}][,macaddr=@var{mac}][,model=@var{type}] [,name=@var{name}][,addr=@var{addr}][,vectors=@var{v}]
934 Create a new Network Interface Card and connect it to VLAN @var{n} (@var{n}
935 = 0 is the default). The NIC is an e1000 by default on the PC
936 target. Optionally, the MAC address can be changed to @var{mac}, the
937 device address set to @var{addr} (PCI cards only),
938 and a @var{name} can be assigned for use in monitor commands.
939 Optionally, for PCI cards, you can specify the number @var{v} of MSI-X vectors
940 that the card should have; this option currently only affects virtio cards; set
941 @var{v} = 0 to disable MSI-X. If no @option{-net} option is specified, a single
942 NIC is created. Qemu can emulate several different models of network card.
943 Valid values for @var{type} are
944 @code{virtio}, @code{i82551}, @code{i82557b}, @code{i82559er},
945 @code{ne2k_pci}, @code{ne2k_isa}, @code{pcnet}, @code{rtl8139},
946 @code{e1000}, @code{smc91c111}, @code{lance} and @code{mcf_fec}.
947 Not all devices are supported on all targets. Use -net nic,model=?
948 for a list of available devices for your target.
950 @item -net user[,@var{option}][,@var{option}][,...]
951 Use the user mode network stack which requires no administrator
952 privilege to run. Valid options are:
956 Connect user mode stack to VLAN @var{n} (@var{n} = 0 is the default).
958 @item name=@var{name}
959 Assign symbolic name for use in monitor commands.
961 @item net=@var{addr}[/@var{mask}]
962 Set IP network address the guest will see. Optionally specify the netmask,
963 either in the form a.b.c.d or as number of valid top-most bits. Default is
966 @item host=@var{addr}
967 Specify the guest-visible address of the host. Default is the 2nd IP in the
968 guest network, i.e. x.x.x.2.
970 @item restrict=y|yes|n|no
971 If this options is enabled, the guest will be isolated, i.e. it will not be
972 able to contact the host and no guest IP packets will be routed over the host
973 to the outside. This option does not affect explicitly set forwarding rule.
975 @item hostname=@var{name}
976 Specifies the client hostname reported by the builtin DHCP server.
978 @item dhcpstart=@var{addr}
979 Specify the first of the 16 IPs the built-in DHCP server can assign. Default
980 is the 16th to 31st IP in the guest network, i.e. x.x.x.16 to x.x.x.31.
983 Specify the guest-visible address of the virtual nameserver. The address must
984 be different from the host address. Default is the 3rd IP in the guest network,
988 When using the user mode network stack, activate a built-in TFTP
989 server. The files in @var{dir} will be exposed as the root of a TFTP server.
990 The TFTP client on the guest must be configured in binary mode (use the command
991 @code{bin} of the Unix TFTP client).
993 @item bootfile=@var{file}
994 When using the user mode network stack, broadcast @var{file} as the BOOTP
995 filename. In conjunction with @option{tftp}, this can be used to network boot
996 a guest from a local directory.
998 Example (using pxelinux):
1000 qemu -hda linux.img -boot n -net user,tftp=/path/to/tftp/files,bootfile=/pxelinux.0
1003 @item smb=@var{dir}[,smbserver=@var{addr}]
1004 When using the user mode network stack, activate a built-in SMB
1005 server so that Windows OSes can access to the host files in @file{@var{dir}}
1006 transparently. The IP address of the SMB server can be set to @var{addr}. By
1007 default the 4th IP in the guest network is used, i.e. x.x.x.4.
1009 In the guest Windows OS, the line:
1013 must be added in the file @file{C:\WINDOWS\LMHOSTS} (for windows 9x/Me)
1014 or @file{C:\WINNT\SYSTEM32\DRIVERS\ETC\LMHOSTS} (Windows NT/2000).
1016 Then @file{@var{dir}} can be accessed in @file{\\smbserver\qemu}.
1018 Note that a SAMBA server must be installed on the host OS in
1019 @file{/usr/sbin/smbd}. QEMU was tested successfully with smbd versions from
1020 Red Hat 9, Fedora Core 3 and OpenSUSE 11.x.
1022 @item hostfwd=[tcp|udp]:[@var{hostaddr}]:@var{hostport}-[@var{guestaddr}]:@var{guestport}
1023 Redirect incoming TCP or UDP connections to the host port @var{hostport} to
1024 the guest IP address @var{guestaddr} on guest port @var{guestport}. If
1025 @var{guestaddr} is not specified, its value is x.x.x.15 (default first address
1026 given by the built-in DHCP server). By specifying @var{hostaddr}, the rule can
1027 be bound to a specific host interface. If no connection type is set, TCP is
1028 used. This option can be given multiple times.
1030 For example, to redirect host X11 connection from screen 1 to guest
1031 screen 0, use the following:
1035 qemu -net user,hostfwd=tcp:127.0.0.1:6001-:6000 [...]
1036 # this host xterm should open in the guest X11 server
1040 To redirect telnet connections from host port 5555 to telnet port on
1041 the guest, use the following:
1045 qemu -net user,hostfwd=tcp::5555-:23 [...]
1046 telnet localhost 5555
1049 Then when you use on the host @code{telnet localhost 5555}, you
1050 connect to the guest telnet server.
1052 @item guestfwd=[tcp]:@var{server}:@var{port}-@var{dev}
1053 Forward guest TCP connections to the IP address @var{server} on port @var{port}
1054 to the character device @var{dev}. This option can be given multiple times.
1058 Note: Legacy stand-alone options -tftp, -bootp, -smb and -redir are still
1059 processed and applied to -net user. Mixing them with the new configuration
1060 syntax gives undefined results. Their use for new applications is discouraged
1061 as they will be removed from future versions.
1063 @item -net tap[,vlan=@var{n}][,name=@var{name}][,fd=@var{h}][,ifname=@var{name}] [,script=@var{file}][,downscript=@var{dfile}]
1064 Connect the host TAP network interface @var{name} to VLAN @var{n}, use
1065 the network script @var{file} to configure it and the network script
1066 @var{dfile} to deconfigure it. If @var{name} is not provided, the OS
1067 automatically provides one. @option{fd}=@var{h} can be used to specify
1068 the handle of an already opened host TAP interface. The default network
1069 configure script is @file{/etc/qemu-ifup} and the default network
1070 deconfigure script is @file{/etc/qemu-ifdown}. Use @option{script=no}
1071 or @option{downscript=no} to disable script execution. Example:
1074 qemu linux.img -net nic -net tap
1077 More complicated example (two NICs, each one connected to a TAP device)
1079 qemu linux.img -net nic,vlan=0 -net tap,vlan=0,ifname=tap0 \
1080 -net nic,vlan=1 -net tap,vlan=1,ifname=tap1
1083 @item -net socket[,vlan=@var{n}][,name=@var{name}][,fd=@var{h}] [,listen=[@var{host}]:@var{port}][,connect=@var{host}:@var{port}]
1085 Connect the VLAN @var{n} to a remote VLAN in another QEMU virtual
1086 machine using a TCP socket connection. If @option{listen} is
1087 specified, QEMU waits for incoming connections on @var{port}
1088 (@var{host} is optional). @option{connect} is used to connect to
1089 another QEMU instance using the @option{listen} option. @option{fd}=@var{h}
1090 specifies an already opened TCP socket.
1094 # launch a first QEMU instance
1095 qemu linux.img -net nic,macaddr=52:54:00:12:34:56 \
1096 -net socket,listen=:1234
1097 # connect the VLAN 0 of this instance to the VLAN 0
1098 # of the first instance
1099 qemu linux.img -net nic,macaddr=52:54:00:12:34:57 \
1100 -net socket,connect=127.0.0.1:1234
1103 @item -net socket[,vlan=@var{n}][,name=@var{name}][,fd=@var{h}] [,mcast=@var{maddr}:@var{port}]
1105 Create a VLAN @var{n} shared with another QEMU virtual
1106 machines using a UDP multicast socket, effectively making a bus for
1107 every QEMU with same multicast address @var{maddr} and @var{port}.
1111 Several QEMU can be running on different hosts and share same bus (assuming
1112 correct multicast setup for these hosts).
1114 mcast support is compatible with User Mode Linux (argument @option{eth@var{N}=mcast}), see
1115 @url{http://user-mode-linux.sf.net}.
1117 Use @option{fd=h} to specify an already opened UDP multicast socket.
1122 # launch one QEMU instance
1123 qemu linux.img -net nic,macaddr=52:54:00:12:34:56 \
1124 -net socket,mcast=230.0.0.1:1234
1125 # launch another QEMU instance on same "bus"
1126 qemu linux.img -net nic,macaddr=52:54:00:12:34:57 \
1127 -net socket,mcast=230.0.0.1:1234
1128 # launch yet another QEMU instance on same "bus"
1129 qemu linux.img -net nic,macaddr=52:54:00:12:34:58 \
1130 -net socket,mcast=230.0.0.1:1234
1133 Example (User Mode Linux compat.):
1135 # launch QEMU instance (note mcast address selected
1137 qemu linux.img -net nic,macaddr=52:54:00:12:34:56 \
1138 -net socket,mcast=239.192.168.1:1102
1140 /path/to/linux ubd0=/path/to/root_fs eth0=mcast
1143 @item -net vde[,vlan=@var{n}][,name=@var{name}][,sock=@var{socketpath}] [,port=@var{n}][,group=@var{groupname}][,mode=@var{octalmode}]
1144 Connect VLAN @var{n} to PORT @var{n} of a vde switch running on host and
1145 listening for incoming connections on @var{socketpath}. Use GROUP @var{groupname}
1146 and MODE @var{octalmode} to change default ownership and permissions for
1147 communication port. This option is available only if QEMU has been compiled
1148 with vde support enabled.
1153 vde_switch -F -sock /tmp/myswitch
1154 # launch QEMU instance
1155 qemu linux.img -net nic -net vde,sock=/tmp/myswitch
1158 @item -net dump[,vlan=@var{n}][,file=@var{file}][,len=@var{len}]
1159 Dump network traffic on VLAN @var{n} to file @var{file} (@file{qemu-vlan0.pcap} by default).
1160 At most @var{len} bytes (64k by default) per packet are stored. The file format is
1161 libpcap, so it can be analyzed with tools such as tcpdump or Wireshark.
1164 Indicate that no network devices should be configured. It is used to
1165 override the default configuration (@option{-net nic -net user}) which
1166 is activated if no @option{-net} options are provided.
1173 DEFHEADING(Character device options:)
1175 DEF("chardev", HAS_ARG, QEMU_OPTION_chardev,
1176 "-chardev null,id=id\n"
1177 "-chardev socket,id=id[,host=host],port=host[,to=to][,ipv4][,ipv6][,nodelay]\n"
1178 " [,server][,nowait][,telnet] (tcp)\n"
1179 "-chardev socket,id=id,path=path[,server][,nowait][,telnet] (unix)\n"
1180 "-chardev udp,id=id[,host=host],port=port[,localaddr=localaddr]\n"
1181 " [,localport=localport][,ipv4][,ipv6]\n"
1182 "-chardev msmouse,id=id\n"
1183 "-chardev vc,id=id[[,width=width][,height=height]][[,cols=cols][,rows=rows]]\n"
1184 "-chardev file,id=id,path=path\n"
1185 "-chardev pipe,id=id,path=path\n"
1187 "-chardev console,id=id\n"
1188 "-chardev serial,id=id,path=path\n"
1190 "-chardev pty,id=id\n"
1191 "-chardev stdio,id=id\n"
1193 #ifdef CONFIG_BRLAPI
1194 "-chardev braille,id=id\n"
1196 #if defined(__linux__) || defined(__sun__) || defined(__FreeBSD__) \
1197 || defined(__NetBSD__) || defined(__OpenBSD__) || defined(__DragonFly__)
1198 "-chardev tty,id=id,path=path\n"
1200 #if defined(__linux__) || defined(__FreeBSD__) || defined(__DragonFly__)
1201 "-chardev parport,id=id,path=path\n"
1208 The general form of a character device option is:
1211 @item -chardev @var{backend} ,id=@var{id} [,@var{options}]
1228 The specific backend will determine the applicable options.
1230 All devices must have an id, which can be any string up to 127 characters long.
1231 It is used to uniquely identify this device in other command line directives.
1233 Options to each backend are described below.
1235 @item -chardev null ,id=@var{id}
1236 A void device. This device will not emit any data, and will drop any data it
1237 receives. The null backend does not take any options.
1239 @item -chardev socket ,id=@var{id} [@var{TCP options} or @var{unix options}] [,server] [,nowait] [,telnet]
1241 Create a two-way stream socket, which can be either a TCP or a unix socket. A
1242 unix socket will be created if @option{path} is specified. Behaviour is
1243 undefined if TCP options are specified for a unix socket.
1245 @option{server} specifies that the socket shall be a listening socket.
1247 @option{nowait} specifies that QEMU should not block waiting for a client to
1248 connect to a listening socket.
1250 @option{telnet} specifies that traffic on the socket should interpret telnet
1253 TCP and unix socket options are given below:
1257 @item TCP options: port=@var{port} [,host=@var{host}] [,to=@var{to}] [,ipv4] [,ipv6] [,nodelay]
1259 @option{host} for a listening socket specifies the local address to be bound.
1260 For a connecting socket species the remote host to connect to. @option{host} is
1261 optional for listening sockets. If not specified it defaults to @code{0.0.0.0}.
1263 @option{port} for a listening socket specifies the local port to be bound. For a
1264 connecting socket specifies the port on the remote host to connect to.
1265 @option{port} can be given as either a port number or a service name.
1266 @option{port} is required.
1268 @option{to} is only relevant to listening sockets. If it is specified, and
1269 @option{port} cannot be bound, QEMU will attempt to bind to subsequent ports up
1270 to and including @option{to} until it succeeds. @option{to} must be specified
1273 @option{ipv4} and @option{ipv6} specify that either IPv4 or IPv6 must be used.
1274 If neither is specified the socket may use either protocol.
1276 @option{nodelay} disables the Nagle algorithm.
1278 @item unix options: path=@var{path}
1280 @option{path} specifies the local path of the unix socket. @option{path} is
1285 @item -chardev udp ,id=@var{id} [,host=@var{host}] ,port=@var{port} [,localaddr=@var{localaddr}] [,localport=@var{localport}] [,ipv4] [,ipv6]
1287 Sends all traffic from the guest to a remote host over UDP.
1289 @option{host} specifies the remote host to connect to. If not specified it
1290 defaults to @code{localhost}.
1292 @option{port} specifies the port on the remote host to connect to. @option{port}
1295 @option{localaddr} specifies the local address to bind to. If not specified it
1296 defaults to @code{0.0.0.0}.
1298 @option{localport} specifies the local port to bind to. If not specified any
1299 available local port will be used.
1301 @option{ipv4} and @option{ipv6} specify that either IPv4 or IPv6 must be used.
1302 If neither is specified the device may use either protocol.
1304 @item -chardev msmouse ,id=@var{id}
1306 Forward QEMU's emulated msmouse events to the guest. @option{msmouse} does not
1309 @item -chardev vc ,id=@var{id} [[,width=@var{width}] [,height=@var{height}]] [[,cols=@var{cols}] [,rows=@var{rows}]]
1311 Connect to a QEMU text console. @option{vc} may optionally be given a specific
1314 @option{width} and @option{height} specify the width and height respectively of
1315 the console, in pixels.
1317 @option{cols} and @option{rows} specify that the console be sized to fit a text
1318 console with the given dimensions.
1320 @item -chardev file ,id=@var{id} ,path=@var{path}
1322 Log all traffic received from the guest to a file.
1324 @option{path} specifies the path of the file to be opened. This file will be
1325 created if it does not already exist, and overwritten if it does. @option{path}
1328 @item -chardev pipe ,id=@var{id} ,path=@var{path}
1330 Create a two-way connection to the guest. The behaviour differs slightly between
1331 Windows hosts and other hosts:
1333 On Windows, a single duplex pipe will be created at
1334 @file{\\.pipe\@option{path}}.
1336 On other hosts, 2 pipes will be created called @file{@option{path}.in} and
1337 @file{@option{path}.out}. Data written to @file{@option{path}.in} will be
1338 received by the guest. Data written by the guest can be read from
1339 @file{@option{path}.out}. QEMU will not create these fifos, and requires them to
1342 @option{path} forms part of the pipe path as described above. @option{path} is
1345 @item -chardev console ,id=@var{id}
1347 Send traffic from the guest to QEMU's standard output. @option{console} does not
1350 @option{console} is only available on Windows hosts.
1352 @item -chardev serial ,id=@var{id} ,path=@option{path}
1354 Send traffic from the guest to a serial device on the host.
1357 only available on Windows hosts.
1359 @option{path} specifies the name of the serial device to open.
1361 @item -chardev pty ,id=@var{id}
1363 Create a new pseudo-terminal on the host and connect to it. @option{pty} does
1364 not take any options.
1366 @option{pty} is not available on Windows hosts.
1368 @item -chardev stdio ,id=@var{id}
1369 Connect to standard input and standard output of the qemu process.
1370 @option{stdio} does not take any options. @option{stdio} is not available on
1373 @item -chardev braille ,id=@var{id}
1375 Connect to a local BrlAPI server. @option{braille} does not take any options.
1377 @item -chardev tty ,id=@var{id} ,path=@var{path}
1379 Connect to a local tty device.
1381 @option{tty} is only available on Linux, Sun, FreeBSD, NetBSD, OpenBSD and
1384 @option{path} specifies the path to the tty. @option{path} is required.
1386 @item -chardev parport ,id=@var{id} ,path=@var{path}
1388 @option{parport} is only available on Linux, FreeBSD and DragonFlyBSD hosts.
1390 Connect to a local parallel port.
1392 @option{path} specifies the path to the parallel port device. @option{path} is
1400 DEFHEADING(Bluetooth(R) options:)
1402 DEF("bt", HAS_ARG, QEMU_OPTION_bt, \
1403 "-bt hci,null dumb bluetooth HCI - doesn't respond to commands\n" \
1404 "-bt hci,host[:id]\n" \
1405 " use host's HCI with the given name\n" \
1406 "-bt hci[,vlan=n]\n" \
1407 " emulate a standard HCI in virtual scatternet 'n'\n" \
1408 "-bt vhci[,vlan=n]\n" \
1409 " add host computer to virtual scatternet 'n' using VHCI\n" \
1410 "-bt device:dev[,vlan=n]\n" \
1411 " emulate a bluetooth device 'dev' in scatternet 'n'\n",
1418 Defines the function of the corresponding Bluetooth HCI. -bt options
1419 are matched with the HCIs present in the chosen machine type. For
1420 example when emulating a machine with only one HCI built into it, only
1421 the first @code{-bt hci[...]} option is valid and defines the HCI's
1422 logic. The Transport Layer is decided by the machine type. Currently
1423 the machines @code{n800} and @code{n810} have one HCI and all other
1427 The following three types are recognized:
1431 (default) The corresponding Bluetooth HCI assumes no internal logic
1432 and will not respond to any HCI commands or emit events.
1434 @item -bt hci,host[:@var{id}]
1435 (@code{bluez} only) The corresponding HCI passes commands / events
1436 to / from the physical HCI identified by the name @var{id} (default:
1437 @code{hci0}) on the computer running QEMU. Only available on @code{bluez}
1438 capable systems like Linux.
1440 @item -bt hci[,vlan=@var{n}]
1441 Add a virtual, standard HCI that will participate in the Bluetooth
1442 scatternet @var{n} (default @code{0}). Similarly to @option{-net}
1443 VLANs, devices inside a bluetooth network @var{n} can only communicate
1444 with other devices in the same network (scatternet).
1447 @item -bt vhci[,vlan=@var{n}]
1448 (Linux-host only) Create a HCI in scatternet @var{n} (default 0) attached
1449 to the host bluetooth stack instead of to the emulated target. This
1450 allows the host and target machines to participate in a common scatternet
1451 and communicate. Requires the Linux @code{vhci} driver installed. Can
1452 be used as following:
1455 qemu [...OPTIONS...] -bt hci,vlan=5 -bt vhci,vlan=5
1458 @item -bt device:@var{dev}[,vlan=@var{n}]
1459 Emulate a bluetooth device @var{dev} and place it in network @var{n}
1460 (default @code{0}). QEMU can only emulate one type of bluetooth devices
1465 Virtual wireless keyboard implementing the HIDP bluetooth profile.
1472 DEFHEADING(Linux/Multiboot boot specific:)
1475 When using these options, you can use a given Linux or Multiboot
1476 kernel without installing it in the disk image. It can be useful
1477 for easier testing of various kernels.
1482 DEF("kernel", HAS_ARG, QEMU_OPTION_kernel, \
1483 "-kernel bzImage use 'bzImage' as kernel image\n", QEMU_ARCH_ALL)
1485 @item -kernel @var{bzImage}
1487 Use @var{bzImage} as kernel image. The kernel can be either a Linux kernel
1488 or in multiboot format.
1491 DEF("append", HAS_ARG, QEMU_OPTION_append, \
1492 "-append cmdline use 'cmdline' as kernel command line\n", QEMU_ARCH_ALL)
1494 @item -append @var{cmdline}
1496 Use @var{cmdline} as kernel command line
1499 DEF("initrd", HAS_ARG, QEMU_OPTION_initrd, \
1500 "-initrd file use 'file' as initial ram disk\n", QEMU_ARCH_ALL)
1502 @item -initrd @var{file}
1504 Use @var{file} as initial ram disk.
1506 @item -initrd "@var{file1} arg=foo,@var{file2}"
1508 This syntax is only available with multiboot.
1510 Use @var{file1} and @var{file2} as modules and pass arg=foo as parameter to the
1520 DEFHEADING(Debug/Expert options:)
1526 DEF("serial", HAS_ARG, QEMU_OPTION_serial, \
1527 "-serial dev redirect the serial port to char device 'dev'\n",
1530 @item -serial @var{dev}
1532 Redirect the virtual serial port to host character device
1533 @var{dev}. The default device is @code{vc} in graphical mode and
1534 @code{stdio} in non graphical mode.
1536 This option can be used several times to simulate up to 4 serial
1539 Use @code{-serial none} to disable all serial ports.
1541 Available character devices are:
1543 @item vc[:@var{W}x@var{H}]
1544 Virtual console. Optionally, a width and height can be given in pixel with
1548 It is also possible to specify width or height in characters:
1553 [Linux only] Pseudo TTY (a new PTY is automatically allocated)
1555 No device is allocated.
1559 [Linux only] Use host tty, e.g. @file{/dev/ttyS0}. The host serial port
1560 parameters are set according to the emulated ones.
1561 @item /dev/parport@var{N}
1562 [Linux only, parallel port only] Use host parallel port
1563 @var{N}. Currently SPP and EPP parallel port features can be used.
1564 @item file:@var{filename}
1565 Write output to @var{filename}. No character can be read.
1567 [Unix only] standard input/output
1568 @item pipe:@var{filename}
1569 name pipe @var{filename}
1571 [Windows only] Use host serial port @var{n}
1572 @item udp:[@var{remote_host}]:@var{remote_port}[@@[@var{src_ip}]:@var{src_port}]
1573 This implements UDP Net Console.
1574 When @var{remote_host} or @var{src_ip} are not specified
1575 they default to @code{0.0.0.0}.
1576 When not using a specified @var{src_port} a random port is automatically chosen.
1578 If you just want a simple readonly console you can use @code{netcat} or
1579 @code{nc}, by starting qemu with: @code{-serial udp::4555} and nc as:
1580 @code{nc -u -l -p 4555}. Any time qemu writes something to that port it
1581 will appear in the netconsole session.
1583 If you plan to send characters back via netconsole or you want to stop
1584 and start qemu a lot of times, you should have qemu use the same
1585 source port each time by using something like @code{-serial
1586 udp::4555@@:4556} to qemu. Another approach is to use a patched
1587 version of netcat which can listen to a TCP port and send and receive
1588 characters via udp. If you have a patched version of netcat which
1589 activates telnet remote echo and single char transfer, then you can
1590 use the following options to step up a netcat redirector to allow
1591 telnet on port 5555 to access the qemu port.
1594 -serial udp::4555@@:4556
1595 @item netcat options:
1596 -u -P 4555 -L 0.0.0.0:4556 -t -p 5555 -I -T
1597 @item telnet options:
1601 @item tcp:[@var{host}]:@var{port}[,@var{server}][,nowait][,nodelay]
1602 The TCP Net Console has two modes of operation. It can send the serial
1603 I/O to a location or wait for a connection from a location. By default
1604 the TCP Net Console is sent to @var{host} at the @var{port}. If you use
1605 the @var{server} option QEMU will wait for a client socket application
1606 to connect to the port before continuing, unless the @code{nowait}
1607 option was specified. The @code{nodelay} option disables the Nagle buffering
1608 algorithm. If @var{host} is omitted, 0.0.0.0 is assumed. Only
1609 one TCP connection at a time is accepted. You can use @code{telnet} to
1610 connect to the corresponding character device.
1612 @item Example to send tcp console to 192.168.0.2 port 4444
1613 -serial tcp:192.168.0.2:4444
1614 @item Example to listen and wait on port 4444 for connection
1615 -serial tcp::4444,server
1616 @item Example to not wait and listen on ip 192.168.0.100 port 4444
1617 -serial tcp:192.168.0.100:4444,server,nowait
1620 @item telnet:@var{host}:@var{port}[,server][,nowait][,nodelay]
1621 The telnet protocol is used instead of raw tcp sockets. The options
1622 work the same as if you had specified @code{-serial tcp}. The
1623 difference is that the port acts like a telnet server or client using
1624 telnet option negotiation. This will also allow you to send the
1625 MAGIC_SYSRQ sequence if you use a telnet that supports sending the break
1626 sequence. Typically in unix telnet you do it with Control-] and then
1627 type "send break" followed by pressing the enter key.
1629 @item unix:@var{path}[,server][,nowait]
1630 A unix domain socket is used instead of a tcp socket. The option works the
1631 same as if you had specified @code{-serial tcp} except the unix domain socket
1632 @var{path} is used for connections.
1634 @item mon:@var{dev_string}
1635 This is a special option to allow the monitor to be multiplexed onto
1636 another serial port. The monitor is accessed with key sequence of
1637 @key{Control-a} and then pressing @key{c}. See monitor access
1638 @ref{pcsys_keys} in the -nographic section for more keys.
1639 @var{dev_string} should be any one of the serial devices specified
1640 above. An example to multiplex the monitor onto a telnet server
1641 listening on port 4444 would be:
1643 @item -serial mon:telnet::4444,server,nowait
1647 Braille device. This will use BrlAPI to display the braille output on a real
1651 Three button serial mouse. Configure the guest to use Microsoft protocol.
1655 DEF("parallel", HAS_ARG, QEMU_OPTION_parallel, \
1656 "-parallel dev redirect the parallel port to char device 'dev'\n",
1659 @item -parallel @var{dev}
1661 Redirect the virtual parallel port to host device @var{dev} (same
1662 devices as the serial port). On Linux hosts, @file{/dev/parportN} can
1663 be used to use hardware devices connected on the corresponding host
1666 This option can be used several times to simulate up to 3 parallel
1669 Use @code{-parallel none} to disable all parallel ports.
1672 DEF("monitor", HAS_ARG, QEMU_OPTION_monitor, \
1673 "-monitor dev redirect the monitor to char device 'dev'\n",
1676 @item -monitor @var{dev}
1678 Redirect the monitor to host device @var{dev} (same devices as the
1680 The default device is @code{vc} in graphical mode and @code{stdio} in
1683 DEF("qmp", HAS_ARG, QEMU_OPTION_qmp, \
1684 "-qmp dev like -monitor but opens in 'control' mode\n",
1687 @item -qmp @var{dev}
1689 Like -monitor but opens in 'control' mode.
1692 DEF("mon", HAS_ARG, QEMU_OPTION_mon, \
1693 "-mon chardev=[name][,mode=readline|control][,default]\n", QEMU_ARCH_ALL)
1695 @item -mon chardev=[name][,mode=readline|control][,default]
1697 Setup monitor on chardev @var{name}.
1700 DEF("debugcon", HAS_ARG, QEMU_OPTION_debugcon, \
1701 "-debugcon dev redirect the debug console to char device 'dev'\n",
1704 @item -debugcon @var{dev}
1706 Redirect the debug console to host device @var{dev} (same devices as the
1707 serial port). The debug console is an I/O port which is typically port
1708 0xe9; writing to that I/O port sends output to this device.
1709 The default device is @code{vc} in graphical mode and @code{stdio} in
1713 DEF("pidfile", HAS_ARG, QEMU_OPTION_pidfile, \
1714 "-pidfile file write PID to 'file'\n", QEMU_ARCH_ALL)
1716 @item -pidfile @var{file}
1718 Store the QEMU process PID in @var{file}. It is useful if you launch QEMU
1722 DEF("singlestep", 0, QEMU_OPTION_singlestep, \
1723 "-singlestep always run in singlestep mode\n", QEMU_ARCH_ALL)
1727 Run the emulation in single step mode.
1730 DEF("S", 0, QEMU_OPTION_S, \
1731 "-S freeze CPU at startup (use 'c' to start execution)\n",
1736 Do not start CPU at startup (you must type 'c' in the monitor).
1739 DEF("gdb", HAS_ARG, QEMU_OPTION_gdb, \
1740 "-gdb dev wait for gdb connection on 'dev'\n", QEMU_ARCH_ALL)
1742 @item -gdb @var{dev}
1744 Wait for gdb connection on device @var{dev} (@pxref{gdb_usage}). Typical
1745 connections will likely be TCP-based, but also UDP, pseudo TTY, or even
1746 stdio are reasonable use case. The latter is allowing to start qemu from
1747 within gdb and establish the connection via a pipe:
1749 (gdb) target remote | exec qemu -gdb stdio ...
1753 DEF("s", 0, QEMU_OPTION_s, \
1754 "-s shorthand for -gdb tcp::" DEFAULT_GDBSTUB_PORT "\n",
1759 Shorthand for -gdb tcp::1234, i.e. open a gdbserver on TCP port 1234
1760 (@pxref{gdb_usage}).
1763 DEF("d", HAS_ARG, QEMU_OPTION_d, \
1764 "-d item1,... output log to /tmp/qemu.log (use -d ? for a list of log items)\n",
1769 Output log in /tmp/qemu.log
1772 DEF("hdachs", HAS_ARG, QEMU_OPTION_hdachs, \
1773 "-hdachs c,h,s[,t]\n" \
1774 " force hard disk 0 physical geometry and the optional BIOS\n" \
1775 " translation (t=none or lba) (usually qemu can guess them)\n",
1778 @item -hdachs @var{c},@var{h},@var{s},[,@var{t}]
1780 Force hard disk 0 physical geometry (1 <= @var{c} <= 16383, 1 <=
1781 @var{h} <= 16, 1 <= @var{s} <= 63) and optionally force the BIOS
1782 translation mode (@var{t}=none, lba or auto). Usually QEMU can guess
1783 all those parameters. This option is useful for old MS-DOS disk
1787 DEF("L", HAS_ARG, QEMU_OPTION_L, \
1788 "-L path set the directory for the BIOS, VGA BIOS and keymaps\n",
1793 Set the directory for the BIOS, VGA BIOS and keymaps.
1796 DEF("bios", HAS_ARG, QEMU_OPTION_bios, \
1797 "-bios file set the filename for the BIOS\n", QEMU_ARCH_ALL)
1799 @item -bios @var{file}
1801 Set the filename for the BIOS.
1804 DEF("enable-kvm", 0, QEMU_OPTION_enable_kvm, \
1805 "-enable-kvm enable KVM full virtualization support\n", QEMU_ARCH_ALL)
1809 Enable KVM full virtualization support. This option is only available
1810 if KVM support is enabled when compiling.
1813 DEF("xen-domid", HAS_ARG, QEMU_OPTION_xen_domid,
1814 "-xen-domid id specify xen guest domain id\n", QEMU_ARCH_ALL)
1815 DEF("xen-create", 0, QEMU_OPTION_xen_create,
1816 "-xen-create create domain using xen hypercalls, bypassing xend\n"
1817 " warning: should not be used when xend is in use\n",
1819 DEF("xen-attach", 0, QEMU_OPTION_xen_attach,
1820 "-xen-attach attach to existing xen domain\n"
1821 " xend will use this when starting qemu\n",
1824 @item -xen-domid @var{id}
1826 Specify xen guest domain @var{id} (XEN only).
1829 Create domain using xen hypercalls, bypassing xend.
1830 Warning: should not be used when xend is in use (XEN only).
1833 Attach to existing xen domain.
1834 xend will use this when starting qemu (XEN only).
1837 DEF("no-reboot", 0, QEMU_OPTION_no_reboot, \
1838 "-no-reboot exit instead of rebooting\n", QEMU_ARCH_ALL)
1842 Exit instead of rebooting.
1845 DEF("no-shutdown", 0, QEMU_OPTION_no_shutdown, \
1846 "-no-shutdown stop before shutdown\n", QEMU_ARCH_ALL)
1849 @findex -no-shutdown
1850 Don't exit QEMU on guest shutdown, but instead only stop the emulation.
1851 This allows for instance switching to monitor to commit changes to the
1855 DEF("loadvm", HAS_ARG, QEMU_OPTION_loadvm, \
1856 "-loadvm [tag|id]\n" \
1857 " start right away with a saved state (loadvm in monitor)\n",
1860 @item -loadvm @var{file}
1862 Start right away with a saved state (@code{loadvm} in monitor)
1866 DEF("daemonize", 0, QEMU_OPTION_daemonize, \
1867 "-daemonize daemonize QEMU after initializing\n", QEMU_ARCH_ALL)
1872 Daemonize the QEMU process after initialization. QEMU will not detach from
1873 standard IO until it is ready to receive connections on any of its devices.
1874 This option is a useful way for external programs to launch QEMU without having
1875 to cope with initialization race conditions.
1878 DEF("option-rom", HAS_ARG, QEMU_OPTION_option_rom, \
1879 "-option-rom rom load a file, rom, into the option ROM space\n",
1882 @item -option-rom @var{file}
1884 Load the contents of @var{file} as an option ROM.
1885 This option is useful to load things like EtherBoot.
1888 DEF("clock", HAS_ARG, QEMU_OPTION_clock, \
1889 "-clock force the use of the given methods for timer alarm.\n" \
1890 " To see what timers are available use -clock ?\n",
1893 @item -clock @var{method}
1895 Force the use of the given methods for timer alarm. To see what timers
1896 are available use -clock ?.
1899 HXCOMM Options deprecated by -rtc
1900 DEF("localtime", 0, QEMU_OPTION_localtime, "", QEMU_ARCH_ALL)
1901 DEF("startdate", HAS_ARG, QEMU_OPTION_startdate, "", QEMU_ARCH_ALL)
1903 DEF("rtc", HAS_ARG, QEMU_OPTION_rtc, \
1904 "-rtc [base=utc|localtime|date][,clock=host|vm][,driftfix=none|slew]\n" \
1905 " set the RTC base and clock, enable drift fix for clock ticks (x86 only)\n",
1910 @item -rtc [base=utc|localtime|@var{date}][,clock=host|vm][,driftfix=none|slew]
1912 Specify @option{base} as @code{utc} or @code{localtime} to let the RTC start at the current
1913 UTC or local time, respectively. @code{localtime} is required for correct date in
1914 MS-DOS or Windows. To start at a specific point in time, provide @var{date} in the
1915 format @code{2006-06-17T16:01:21} or @code{2006-06-17}. The default base is UTC.
1917 By default the RTC is driven by the host system time. This allows to use the
1918 RTC as accurate reference clock inside the guest, specifically if the host
1919 time is smoothly following an accurate external reference clock, e.g. via NTP.
1920 If you want to isolate the guest time from the host, even prevent it from
1921 progressing during suspension, you can set @option{clock} to @code{vm} instead.
1923 Enable @option{driftfix} (i386 targets only) if you experience time drift problems,
1924 specifically with Windows' ACPI HAL. This option will try to figure out how
1925 many timer interrupts were not processed by the Windows guest and will
1929 DEF("icount", HAS_ARG, QEMU_OPTION_icount, \
1930 "-icount [N|auto]\n" \
1931 " enable virtual instruction counter with 2^N clock ticks per\n" \
1932 " instruction\n", QEMU_ARCH_ALL)
1934 @item -icount [@var{N}|auto]
1936 Enable virtual instruction counter. The virtual cpu will execute one
1937 instruction every 2^@var{N} ns of virtual time. If @code{auto} is specified
1938 then the virtual cpu speed will be automatically adjusted to keep virtual
1939 time within a few seconds of real time.
1941 Note that while this option can give deterministic behavior, it does not
1942 provide cycle accurate emulation. Modern CPUs contain superscalar out of
1943 order cores with complex cache hierarchies. The number of instructions
1944 executed often has little or no correlation with actual performance.
1947 DEF("watchdog", HAS_ARG, QEMU_OPTION_watchdog, \
1948 "-watchdog i6300esb|ib700\n" \
1949 " enable virtual hardware watchdog [default=none]\n",
1952 @item -watchdog @var{model}
1954 Create a virtual hardware watchdog device. Once enabled (by a guest
1955 action), the watchdog must be periodically polled by an agent inside
1956 the guest or else the guest will be restarted.
1958 The @var{model} is the model of hardware watchdog to emulate. Choices
1959 for model are: @code{ib700} (iBASE 700) which is a very simple ISA
1960 watchdog with a single timer, or @code{i6300esb} (Intel 6300ESB I/O
1961 controller hub) which is a much more featureful PCI-based dual-timer
1962 watchdog. Choose a model for which your guest has drivers.
1964 Use @code{-watchdog ?} to list available hardware models. Only one
1965 watchdog can be enabled for a guest.
1968 DEF("watchdog-action", HAS_ARG, QEMU_OPTION_watchdog_action, \
1969 "-watchdog-action reset|shutdown|poweroff|pause|debug|none\n" \
1970 " action when watchdog fires [default=reset]\n",
1973 @item -watchdog-action @var{action}
1975 The @var{action} controls what QEMU will do when the watchdog timer
1978 @code{reset} (forcefully reset the guest).
1979 Other possible actions are:
1980 @code{shutdown} (attempt to gracefully shutdown the guest),
1981 @code{poweroff} (forcefully poweroff the guest),
1982 @code{pause} (pause the guest),
1983 @code{debug} (print a debug message and continue), or
1984 @code{none} (do nothing).
1986 Note that the @code{shutdown} action requires that the guest responds
1987 to ACPI signals, which it may not be able to do in the sort of
1988 situations where the watchdog would have expired, and thus
1989 @code{-watchdog-action shutdown} is not recommended for production use.
1994 @item -watchdog i6300esb -watchdog-action pause
1995 @item -watchdog ib700
1999 DEF("echr", HAS_ARG, QEMU_OPTION_echr, \
2000 "-echr chr set terminal escape character instead of ctrl-a\n",
2004 @item -echr @var{numeric_ascii_value}
2006 Change the escape character used for switching to the monitor when using
2007 monitor and serial sharing. The default is @code{0x01} when using the
2008 @code{-nographic} option. @code{0x01} is equal to pressing
2009 @code{Control-a}. You can select a different character from the ascii
2010 control keys where 1 through 26 map to Control-a through Control-z. For
2011 instance you could use the either of the following to change the escape
2012 character to Control-t.
2019 DEF("virtioconsole", HAS_ARG, QEMU_OPTION_virtiocon, \
2020 "-virtioconsole c\n" \
2021 " set virtio console\n", QEMU_ARCH_ALL)
2023 @item -virtioconsole @var{c}
2024 @findex -virtioconsole
2027 This option is maintained for backward compatibility.
2029 Please use @code{-device virtconsole} for the new way of invocation.
2032 DEF("show-cursor", 0, QEMU_OPTION_show_cursor, \
2033 "-show-cursor show cursor\n", QEMU_ARCH_ALL)
2036 @findex -show-cursor
2040 DEF("tb-size", HAS_ARG, QEMU_OPTION_tb_size, \
2041 "-tb-size n set TB size\n", QEMU_ARCH_ALL)
2043 @item -tb-size @var{n}
2048 DEF("incoming", HAS_ARG, QEMU_OPTION_incoming, \
2049 "-incoming p prepare for incoming migration, listen on port p\n",
2052 @item -incoming @var{port}
2054 Prepare for incoming migration, listen on @var{port}.
2057 DEF("nodefaults", 0, QEMU_OPTION_nodefaults, \
2058 "-nodefaults don't create default devices\n", QEMU_ARCH_ALL)
2062 Don't create default devices.
2066 DEF("chroot", HAS_ARG, QEMU_OPTION_chroot, \
2067 "-chroot dir chroot to dir just before starting the VM\n",
2071 @item -chroot @var{dir}
2073 Immediately before starting guest execution, chroot to the specified
2074 directory. Especially useful in combination with -runas.
2078 DEF("runas", HAS_ARG, QEMU_OPTION_runas, \
2079 "-runas user change to user id user just before starting the VM\n",
2083 @item -runas @var{user}
2085 Immediately before starting guest execution, drop root privileges, switching
2086 to the specified user.
2089 DEF("prom-env", HAS_ARG, QEMU_OPTION_prom_env,
2090 "-prom-env variable=value\n"
2091 " set OpenBIOS nvram variables\n",
2092 QEMU_ARCH_PPC | QEMU_ARCH_SPARC)
2094 @item -prom-env @var{variable}=@var{value}
2096 Set OpenBIOS nvram @var{variable} to given @var{value} (PPC, SPARC only).
2098 DEF("semihosting", 0, QEMU_OPTION_semihosting,
2099 "-semihosting semihosting mode\n", QEMU_ARCH_ARM | QEMU_ARCH_M68K)
2102 @findex -semihosting
2103 Semihosting mode (ARM, M68K only).
2105 DEF("old-param", 0, QEMU_OPTION_old_param,
2106 "-old-param old param mode\n", QEMU_ARCH_ARM)
2109 @findex -old-param (ARM)
2110 Old param mode (ARM only).
2113 DEF("readconfig", HAS_ARG, QEMU_OPTION_readconfig,
2114 "-readconfig <file>\n", QEMU_ARCH_ALL)
2116 @item -readconfig @var{file}
2118 Read device configuration from @var{file}.
2120 DEF("writeconfig", HAS_ARG, QEMU_OPTION_writeconfig,
2121 "-writeconfig <file>\n"
2122 " read/write config file\n", QEMU_ARCH_ALL)
2124 @item -writeconfig @var{file}
2125 @findex -writeconfig
2126 Write device configuration to @var{file}.
2128 DEF("nodefconfig", 0, QEMU_OPTION_nodefconfig,
2130 " do not load default config files at startup\n",
2134 @findex -nodefconfig
2135 Normally QEMU loads a configuration file from @var{sysconfdir}/qemu.conf and
2136 @var{sysconfdir}/target-@var{ARCH}.conf on startup. The @code{-nodefconfig}
2137 option will prevent QEMU from loading these configuration files at startup.
2140 HXCOMM This is the last statement. Insert new options before this line!