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) is used to construct
5 HXCOMM option structures, enums and help message.
6 HXCOMM HXCOMM can be used for comments, discarded from both texi and C
8 DEFHEADING(Standard options:)
13 DEF("help", 0, QEMU_OPTION_h,
14 "-h or -help display this help and exit\n")
20 DEF("version", 0, QEMU_OPTION_version,
21 "-version display version information and exit\n")
24 Display version information and exit
27 DEF("M", HAS_ARG, QEMU_OPTION_M,
28 "-M machine select emulated machine (-M ? for list)\n")
30 @item -M @var{machine}
31 Select the emulated @var{machine} (@code{-M ?} for list)
34 DEF("cpu", HAS_ARG, QEMU_OPTION_cpu,
35 "-cpu cpu select CPU (-cpu ? for list)\n")
37 @item -cpu @var{model}
38 Select CPU model (-cpu ? for list and additional feature selection)
41 DEF("smp", HAS_ARG, QEMU_OPTION_smp,
42 "-smp n[,maxcpus=cpus][,cores=cores][,threads=threads][,sockets=sockets]\n"
43 " set the number of CPUs to 'n' [default=1]\n"
44 " maxcpus= maximum number of total cpus, including\n"
45 " offline CPUs for hotplug etc.\n"
46 " cores= number of CPU cores on one socket\n"
47 " threads= number of threads on one CPU core\n"
48 " sockets= number of discrete sockets in the system\n")
50 @item -smp @var{n}[,cores=@var{cores}][,threads=@var{threads}][,sockets=@var{sockets}][,maxcpus=@var{maxcpus}]
51 Simulate an SMP system with @var{n} CPUs. On the PC target, up to 255
52 CPUs are supported. On Sparc32 target, Linux limits the number of usable CPUs
54 For the PC target, the number of @var{cores} per socket, the number
55 of @var{threads} per cores and the total number of @var{sockets} can be
56 specified. Missing values will be computed. If any on the three values is
57 given, the total number of CPUs @var{n} can be omitted. @var{maxcpus}
58 specifies the maximum number of hotpluggable CPUs.
61 DEF("numa", HAS_ARG, QEMU_OPTION_numa,
62 "-numa node[,mem=size][,cpus=cpu[-cpu]][,nodeid=node]\n")
64 @item -numa @var{opts}
65 Simulate a multi node NUMA system. If mem and cpus are omitted, resources
69 DEF("fda", HAS_ARG, QEMU_OPTION_fda,
70 "-fda/-fdb file use 'file' as floppy disk 0/1 image\n")
71 DEF("fdb", HAS_ARG, QEMU_OPTION_fdb, "")
75 Use @var{file} as floppy disk 0/1 image (@pxref{disk_images}). You can
76 use the host floppy by using @file{/dev/fd0} as filename (@pxref{host_drives}).
79 DEF("hda", HAS_ARG, QEMU_OPTION_hda,
80 "-hda/-hdb file use 'file' as IDE hard disk 0/1 image\n")
81 DEF("hdb", HAS_ARG, QEMU_OPTION_hdb, "")
82 DEF("hdc", HAS_ARG, QEMU_OPTION_hdc,
83 "-hdc/-hdd file use 'file' as IDE hard disk 2/3 image\n")
84 DEF("hdd", HAS_ARG, QEMU_OPTION_hdd, "")
90 Use @var{file} as hard disk 0, 1, 2 or 3 image (@pxref{disk_images}).
93 DEF("cdrom", HAS_ARG, QEMU_OPTION_cdrom,
94 "-cdrom file use 'file' as IDE cdrom image (cdrom is ide1 master)\n")
96 @item -cdrom @var{file}
97 Use @var{file} as CD-ROM image (you cannot use @option{-hdc} and
98 @option{-cdrom} at the same time). You can use the host CD-ROM by
99 using @file{/dev/cdrom} as filename (@pxref{host_drives}).
102 DEF("drive", HAS_ARG, QEMU_OPTION_drive,
103 "-drive [file=file][,if=type][,bus=n][,unit=m][,media=d][,index=i]\n"
104 " [,cyls=c,heads=h,secs=s[,trans=t]][,snapshot=on|off]\n"
105 " [,cache=writethrough|writeback|none][,format=f][,serial=s]\n"
106 " [,addr=A][,id=name][,aio=threads|native]\n"
107 " use 'file' as a drive image\n")
108 DEF("set", HAS_ARG, QEMU_OPTION_set,
109 "-set group.id.arg=value\n"
110 " set <arg> parameter for item <id> of type <group>\n"
111 " i.e. -set drive.$id.file=/path/to/image\n")
112 DEF("global", HAS_ARG, QEMU_OPTION_global,
113 "-global driver.property=value\n"
114 " set a global default for a driver property\n")
116 @item -drive @var{option}[,@var{option}[,@var{option}[,...]]]
118 Define a new drive. Valid options are:
121 @item file=@var{file}
122 This option defines which disk image (@pxref{disk_images}) to use with
123 this drive. If the filename contains comma, you must double it
124 (for instance, "file=my,,file" to use file "my,file").
125 @item if=@var{interface}
126 This option defines on which type on interface the drive is connected.
127 Available types are: ide, scsi, sd, mtd, floppy, pflash, virtio.
128 @item bus=@var{bus},unit=@var{unit}
129 These options define where is connected the drive by defining the bus number and
131 @item index=@var{index}
132 This option defines where is connected the drive by using an index in the list
133 of available connectors of a given interface type.
134 @item media=@var{media}
135 This option defines the type of the media: disk or cdrom.
136 @item cyls=@var{c},heads=@var{h},secs=@var{s}[,trans=@var{t}]
137 These options have the same definition as they have in @option{-hdachs}.
138 @item snapshot=@var{snapshot}
139 @var{snapshot} is "on" or "off" and allows to enable snapshot for given drive (see @option{-snapshot}).
140 @item cache=@var{cache}
141 @var{cache} is "none", "writeback", or "writethrough" and controls how the host cache is used to access block data.
143 @var{aio} is "threads", or "native" and selects between pthread based disk I/O and native Linux AIO.
144 @item format=@var{format}
145 Specify which disk @var{format} will be used rather than detecting
146 the format. Can be used to specifiy format=raw to avoid interpreting
147 an untrusted format header.
148 @item serial=@var{serial}
149 This option specifies the serial number to assign to the device.
150 @item addr=@var{addr}
151 Specify the controller's PCI address (if=virtio only).
154 By default, writethrough caching is used for all block device. This means that
155 the host page cache will be used to read and write data but write notification
156 will be sent to the guest only when the data has been reported as written by
157 the storage subsystem.
159 Writeback caching will report data writes as completed as soon as the data is
160 present in the host page cache. This is safe as long as you trust your host.
161 If your host crashes or loses power, then the guest may experience data
162 corruption. When using the @option{-snapshot} option, writeback caching is
165 The host page cache can be avoided entirely with @option{cache=none}. This will
166 attempt to do disk IO directly to the guests memory. QEMU may still perform
167 an internal copy of the data.
169 Some block drivers perform badly with @option{cache=writethrough}, most notably,
170 qcow2. If performance is more important than correctness,
171 @option{cache=writeback} should be used with qcow2.
173 Instead of @option{-cdrom} you can use:
175 qemu -drive file=file,index=2,media=cdrom
178 Instead of @option{-hda}, @option{-hdb}, @option{-hdc}, @option{-hdd}, you can
181 qemu -drive file=file,index=0,media=disk
182 qemu -drive file=file,index=1,media=disk
183 qemu -drive file=file,index=2,media=disk
184 qemu -drive file=file,index=3,media=disk
187 You can connect a CDROM to the slave of ide0:
189 qemu -drive file=file,if=ide,index=1,media=cdrom
192 If you don't specify the "file=" argument, you define an empty drive:
194 qemu -drive if=ide,index=1,media=cdrom
197 You can connect a SCSI disk with unit ID 6 on the bus #0:
199 qemu -drive file=file,if=scsi,bus=0,unit=6
202 Instead of @option{-fda}, @option{-fdb}, you can use:
204 qemu -drive file=file,index=0,if=floppy
205 qemu -drive file=file,index=1,if=floppy
208 By default, @var{interface} is "ide" and @var{index} is automatically
211 qemu -drive file=a -drive file=b"
219 DEF("mtdblock", HAS_ARG, QEMU_OPTION_mtdblock,
220 "-mtdblock file use 'file' as on-board Flash memory image\n")
223 @item -mtdblock @var{file}
224 Use @var{file} as on-board Flash memory image.
227 DEF("sd", HAS_ARG, QEMU_OPTION_sd,
228 "-sd file use 'file' as SecureDigital card image\n")
231 Use @var{file} as SecureDigital card image.
234 DEF("pflash", HAS_ARG, QEMU_OPTION_pflash,
235 "-pflash file use 'file' as a parallel flash image\n")
237 @item -pflash @var{file}
238 Use @var{file} as a parallel flash image.
241 DEF("boot", HAS_ARG, QEMU_OPTION_boot,
242 "-boot [order=drives][,once=drives][,menu=on|off]\n"
243 " 'drives': floppy (a), hard disk (c), CD-ROM (d), network (n)\n")
245 @item -boot [order=@var{drives}][,once=@var{drives}][,menu=on|off]
247 Specify boot order @var{drives} as a string of drive letters. Valid
248 drive letters depend on the target achitecture. The x86 PC uses: a, b
249 (floppy 1 and 2), c (first hard disk), d (first CD-ROM), n-p (Etherboot
250 from network adapter 1-4), hard disk boot is the default. To apply a
251 particular boot order only on the first startup, specify it via
254 Interactive boot menus/prompts can be enabled via @option{menu=on} as far
255 as firmware/BIOS supports them. The default is non-interactive boot.
258 # try to boot from network first, then from hard disk
260 # boot from CD-ROM first, switch back to default order after reboot
264 Note: The legacy format '-boot @var{drives}' is still supported but its
265 use is discouraged as it may be removed from future versions.
268 DEF("snapshot", 0, QEMU_OPTION_snapshot,
269 "-snapshot write to temporary files instead of disk image files\n")
272 Write to temporary files instead of disk image files. In this case,
273 the raw disk image you use is not written back. You can however force
274 the write back by pressing @key{C-a s} (@pxref{disk_images}).
277 DEF("m", HAS_ARG, QEMU_OPTION_m,
278 "-m megs set virtual RAM size to megs MB [default=%d]\n")
281 Set virtual RAM size to @var{megs} megabytes. Default is 128 MiB. Optionally,
282 a suffix of ``M'' or ``G'' can be used to signify a value in megabytes or
283 gigabytes respectively.
286 DEF("k", HAS_ARG, QEMU_OPTION_k,
287 "-k language use keyboard layout (for example 'fr' for French)\n")
289 @item -k @var{language}
291 Use keyboard layout @var{language} (for example @code{fr} for
292 French). This option is only needed where it is not easy to get raw PC
293 keycodes (e.g. on Macs, with some X11 servers or with a VNC
294 display). You don't normally need to use it on PC/Linux or PC/Windows
297 The available layouts are:
299 ar de-ch es fo fr-ca hu ja mk no pt-br sv
300 da en-gb et fr fr-ch is lt nl pl ru th
301 de en-us fi fr-be hr it lv nl-be pt sl tr
304 The default is @code{en-us}.
309 DEF("audio-help", 0, QEMU_OPTION_audio_help,
310 "-audio-help print list of audio drivers and their options\n")
315 Will show the audio subsystem help: list of drivers, tunable
320 DEF("soundhw", HAS_ARG, QEMU_OPTION_soundhw,
321 "-soundhw c1,... enable audio support\n"
322 " and only specified sound cards (comma separated list)\n"
323 " use -soundhw ? to get the list of supported cards\n"
324 " use -soundhw all to enable all of them\n")
327 @item -soundhw @var{card1}[,@var{card2},...] or -soundhw all
329 Enable audio and selected sound hardware. Use ? to print all
330 available sound hardware.
333 qemu -soundhw sb16,adlib disk.img
334 qemu -soundhw es1370 disk.img
335 qemu -soundhw ac97 disk.img
336 qemu -soundhw all disk.img
340 Note that Linux's i810_audio OSS kernel (for AC97) module might
341 require manually specifying clocking.
344 modprobe i810_audio clocking=48000
352 DEF("usb", 0, QEMU_OPTION_usb,
353 "-usb enable the USB driver (will be the default soon)\n")
359 Enable the USB driver (will be the default soon)
362 DEF("usbdevice", HAS_ARG, QEMU_OPTION_usbdevice,
363 "-usbdevice name add the host or guest USB device 'name'\n")
366 @item -usbdevice @var{devname}
367 Add the USB device @var{devname}. @xref{usb_devices}.
372 Virtual Mouse. This will override the PS/2 mouse emulation when activated.
375 Pointer device that uses absolute coordinates (like a touchscreen). This
376 means qemu is able to report the mouse position without having to grab the
377 mouse. Also overrides the PS/2 mouse emulation when activated.
379 @item disk:[format=@var{format}]:@var{file}
380 Mass storage device based on file. The optional @var{format} argument
381 will be used rather than detecting the format. Can be used to specifiy
382 @code{format=raw} to avoid interpreting an untrusted format header.
384 @item host:@var{bus}.@var{addr}
385 Pass through the host device identified by @var{bus}.@var{addr} (Linux only).
387 @item host:@var{vendor_id}:@var{product_id}
388 Pass through the host device identified by @var{vendor_id}:@var{product_id}
391 @item serial:[vendorid=@var{vendor_id}][,productid=@var{product_id}]:@var{dev}
392 Serial converter to host character device @var{dev}, see @code{-serial} for the
396 Braille device. This will use BrlAPI to display the braille output on a real
399 @item net:@var{options}
400 Network adapter that supports CDC ethernet and RNDIS protocols.
405 DEF("device", HAS_ARG, QEMU_OPTION_device,
406 "-device driver[,options] add device\n")
408 @item -device @var{driver}[,@var{option}[,...]]
409 Add device @var{driver}. Depending on the device type,
410 @var{option} (typically @var{key}=@var{value}) may be useful.
413 DEF("name", HAS_ARG, QEMU_OPTION_name,
414 "-name string1[,process=string2] set the name of the guest\n"
415 " string1 sets the window title and string2 the process name (on Linux)\n")
417 @item -name @var{name}
418 Sets the @var{name} of the guest.
419 This name will be displayed in the SDL window caption.
420 The @var{name} will also be used for the VNC server.
421 Also optionally set the top visible process name in Linux.
424 DEF("uuid", HAS_ARG, QEMU_OPTION_uuid,
425 "-uuid %%08x-%%04x-%%04x-%%04x-%%012x\n"
426 " specify machine UUID\n")
428 @item -uuid @var{uuid}
438 DEFHEADING(Display options:)
444 DEF("nographic", 0, QEMU_OPTION_nographic,
445 "-nographic disable graphical output and redirect serial I/Os to console\n")
449 Normally, QEMU uses SDL to display the VGA output. With this option,
450 you can totally disable graphical output so that QEMU is a simple
451 command line application. The emulated serial port is redirected on
452 the console. Therefore, you can still use QEMU to debug a Linux kernel
453 with a serial console.
457 DEF("curses", 0, QEMU_OPTION_curses,
458 "-curses use a curses/ncurses interface instead of SDL\n")
463 Normally, QEMU uses SDL to display the VGA output. With this option,
464 QEMU can display the VGA output when in text mode using a
465 curses/ncurses interface. Nothing is displayed in graphical mode.
469 DEF("no-frame", 0, QEMU_OPTION_no_frame,
470 "-no-frame open SDL window without a frame and window decorations\n")
475 Do not use decorations for SDL windows and start them using the whole
476 available screen space. This makes the using QEMU in a dedicated desktop
477 workspace more convenient.
481 DEF("alt-grab", 0, QEMU_OPTION_alt_grab,
482 "-alt-grab use Ctrl-Alt-Shift to grab mouse (instead of Ctrl-Alt)\n")
487 Use Ctrl-Alt-Shift to grab mouse (instead of Ctrl-Alt).
491 DEF("ctrl-grab", 0, QEMU_OPTION_ctrl_grab,
492 "-ctrl-grab use Right-Ctrl to grab mouse (instead of Ctrl-Alt)\n")
497 Use Right-Ctrl to grab mouse (instead of Ctrl-Alt).
501 DEF("no-quit", 0, QEMU_OPTION_no_quit,
502 "-no-quit disable SDL window close capability\n")
507 Disable SDL window close capability.
511 DEF("sdl", 0, QEMU_OPTION_sdl,
520 DEF("portrait", 0, QEMU_OPTION_portrait,
521 "-portrait rotate graphical output 90 deg left (only PXA LCD)\n")
525 Rotate graphical output 90 deg left (only PXA LCD).
528 DEF("vga", HAS_ARG, QEMU_OPTION_vga,
529 "-vga [std|cirrus|vmware|xenfb|none]\n"
530 " select video card type\n")
532 @item -vga @var{type}
533 Select type of VGA card to emulate. Valid values for @var{type} are
536 Cirrus Logic GD5446 Video card. All Windows versions starting from
537 Windows 95 should recognize and use this graphic card. For optimal
538 performances, use 16 bit color depth in the guest and the host OS.
539 (This one is the default)
541 Standard VGA card with Bochs VBE extensions. If your guest OS
542 supports the VESA 2.0 VBE extensions (e.g. Windows XP) and if you want
543 to use high resolution modes (>= 1280x1024x16) then you should use
546 VMWare SVGA-II compatible adapter. Use it if you have sufficiently
547 recent XFree86/XOrg server or Windows guest with a driver for this
554 DEF("full-screen", 0, QEMU_OPTION_full_screen,
555 "-full-screen start in full screen\n")
558 Start in full screen.
561 #if defined(TARGET_PPC) || defined(TARGET_SPARC)
562 DEF("g", 1, QEMU_OPTION_g ,
563 "-g WxH[xDEPTH] Set the initial graphical resolution and depth\n")
568 DEF("vnc", HAS_ARG, QEMU_OPTION_vnc ,
569 "-vnc display start a VNC server on display\n")
571 @item -vnc @var{display}[,@var{option}[,@var{option}[,...]]]
573 Normally, QEMU uses SDL to display the VGA output. With this option,
574 you can have QEMU listen on VNC display @var{display} and redirect the VGA
575 display over the VNC session. It is very useful to enable the usb
576 tablet device when using this option (option @option{-usbdevice
577 tablet}). When using the VNC display, you must use the @option{-k}
578 parameter to set the keyboard layout if you are not using en-us. Valid
579 syntax for the @var{display} is
583 @item @var{host}:@var{d}
585 TCP connections will only be allowed from @var{host} on display @var{d}.
586 By convention the TCP port is 5900+@var{d}. Optionally, @var{host} can
587 be omitted in which case the server will accept connections from any host.
589 @item unix:@var{path}
591 Connections will be allowed over UNIX domain sockets where @var{path} is the
592 location of a unix socket to listen for connections on.
596 VNC is initialized but not started. The monitor @code{change} command
597 can be used to later start the VNC server.
601 Following the @var{display} value there may be one or more @var{option} flags
602 separated by commas. Valid options are
608 Connect to a listening VNC client via a ``reverse'' connection. The
609 client is specified by the @var{display}. For reverse network
610 connections (@var{host}:@var{d},@code{reverse}), the @var{d} argument
611 is a TCP port number, not a display number.
615 Require that password based authentication is used for client connections.
616 The password must be set separately using the @code{change} command in the
621 Require that client use TLS when communicating with the VNC server. This
622 uses anonymous TLS credentials so is susceptible to a man-in-the-middle
623 attack. It is recommended that this option be combined with either the
624 @option{x509} or @option{x509verify} options.
626 @item x509=@var{/path/to/certificate/dir}
628 Valid if @option{tls} is specified. Require that x509 credentials are used
629 for negotiating the TLS session. The server will send its x509 certificate
630 to the client. It is recommended that a password be set on the VNC server
631 to provide authentication of the client when this is used. The path following
632 this option specifies where the x509 certificates are to be loaded from.
633 See the @ref{vnc_security} section for details on generating certificates.
635 @item x509verify=@var{/path/to/certificate/dir}
637 Valid if @option{tls} is specified. Require that x509 credentials are used
638 for negotiating the TLS session. The server will send its x509 certificate
639 to the client, and request that the client send its own x509 certificate.
640 The server will validate the client's certificate against the CA certificate,
641 and reject clients when validation fails. If the certificate authority is
642 trusted, this is a sufficient authentication mechanism. You may still wish
643 to set a password on the VNC server as a second authentication layer. The
644 path following this option specifies where the x509 certificates are to
645 be loaded from. See the @ref{vnc_security} section for details on generating
650 Require that the client use SASL to authenticate with the VNC server.
651 The exact choice of authentication method used is controlled from the
652 system / user's SASL configuration file for the 'qemu' service. This
653 is typically found in /etc/sasl2/qemu.conf. If running QEMU as an
654 unprivileged user, an environment variable SASL_CONF_PATH can be used
655 to make it search alternate locations for the service config.
656 While some SASL auth methods can also provide data encryption (eg GSSAPI),
657 it is recommended that SASL always be combined with the 'tls' and
658 'x509' settings to enable use of SSL and server certificates. This
659 ensures a data encryption preventing compromise of authentication
660 credentials. See the @ref{vnc_security} section for details on using
665 Turn on access control lists for checking of the x509 client certificate
666 and SASL party. For x509 certs, the ACL check is made against the
667 certificate's distinguished name. This is something that looks like
668 @code{C=GB,O=ACME,L=Boston,CN=bob}. For SASL party, the ACL check is
669 made against the username, which depending on the SASL plugin, may
670 include a realm component, eg @code{bob} or @code{bob@@EXAMPLE.COM}.
671 When the @option{acl} flag is set, the initial access list will be
672 empty, with a @code{deny} policy. Thus no one will be allowed to
673 use the VNC server until the ACLs have been loaded. This can be
674 achieved using the @code{acl} monitor command.
686 DEFHEADING(i386 target only:)
693 DEF("win2k-hack", 0, QEMU_OPTION_win2k_hack,
694 "-win2k-hack use it when installing Windows 2000 to avoid a disk full bug\n")
698 Use it when installing Windows 2000 to avoid a disk full bug. After
699 Windows 2000 is installed, you no longer need this option (this option
700 slows down the IDE transfers).
704 HXCOMM Deprecated by -rtc
705 DEF("rtc-td-hack", 0, QEMU_OPTION_rtc_td_hack, "")
709 DEF("no-fd-bootchk", 0, QEMU_OPTION_no_fd_bootchk,
710 "-no-fd-bootchk disable boot signature checking for floppy disks\n")
714 Disable boot signature checking for floppy disks in Bochs BIOS. It may
715 be needed to boot from old floppy disks.
719 DEF("no-acpi", 0, QEMU_OPTION_no_acpi,
720 "-no-acpi disable ACPI\n")
724 Disable ACPI (Advanced Configuration and Power Interface) support. Use
725 it if your guest OS complains about ACPI problems (PC target machine
730 DEF("no-hpet", 0, QEMU_OPTION_no_hpet,
731 "-no-hpet disable HPET\n")
735 Disable HPET support.
739 DEF("balloon", HAS_ARG, QEMU_OPTION_balloon,
740 "-balloon none disable balloon device\n"
741 "-balloon virtio[,addr=str]\n"
742 " enable virtio balloon device (default)\n")
746 Disable balloon device.
747 @item -balloon virtio[,addr=@var{addr}]
748 Enable virtio balloon device (default), optionally with PCI address
753 DEF("acpitable", HAS_ARG, QEMU_OPTION_acpitable,
754 "-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"
755 " ACPI table description\n")
758 @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}]...]
759 Add ACPI table with specified header fields and context from specified files.
763 DEF("smbios", HAS_ARG, QEMU_OPTION_smbios,
764 "-smbios file=binary\n"
765 " Load SMBIOS entry from binary file\n"
766 "-smbios type=0[,vendor=str][,version=str][,date=str][,release=%%d.%%d]\n"
767 " Specify SMBIOS type 0 fields\n"
768 "-smbios type=1[,manufacturer=str][,product=str][,version=str][,serial=str]\n"
769 " [,uuid=uuid][,sku=str][,family=str]\n"
770 " Specify SMBIOS type 1 fields\n")
773 @item -smbios file=@var{binary}
774 Load SMBIOS entry from binary file.
776 @item -smbios type=0[,vendor=@var{str}][,version=@var{str}][,date=@var{str}][,release=@var{%d.%d}]
777 Specify SMBIOS type 0 fields
779 @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}]
780 Specify SMBIOS type 1 fields
790 DEFHEADING(Network options:)
795 HXCOMM Legacy slirp options (now moved to -net user):
797 DEF("tftp", HAS_ARG, QEMU_OPTION_tftp, "")
798 DEF("bootp", HAS_ARG, QEMU_OPTION_bootp, "")
799 DEF("redir", HAS_ARG, QEMU_OPTION_redir, "")
801 DEF("smb", HAS_ARG, QEMU_OPTION_smb, "")
805 DEF("net", HAS_ARG, QEMU_OPTION_net,
806 "-net nic[,vlan=n][,macaddr=mac][,model=type][,name=str][,addr=str][,vectors=v]\n"
807 " create a new Network Interface Card and connect it to VLAN 'n'\n"
809 "-net user[,vlan=n][,name=str][,net=addr[/mask]][,host=addr][,restrict=y|n]\n"
810 " [,hostname=host][,dhcpstart=addr][,dns=addr][,tftp=dir][,bootfile=f]\n"
811 " [,hostfwd=rule][,guestfwd=rule]"
813 "[,smb=dir[,smbserver=addr]]\n"
815 " connect the user mode network stack to VLAN 'n', configure its\n"
816 " DHCP server and enabled optional services\n"
819 "-net tap[,vlan=n][,name=str],ifname=name\n"
820 " connect the host TAP network interface to VLAN 'n'\n"
822 "-net tap[,vlan=n][,name=str][,fd=h][,ifname=name][,script=file][,downscript=dfile][,sndbuf=nbytes][,vnet_hdr=on|off]\n"
823 " connect the host TAP network interface to VLAN 'n' and use the\n"
824 " network scripts 'file' (default=%s)\n"
825 " and 'dfile' (default=%s);\n"
826 " use '[down]script=no' to disable script execution;\n"
827 " use 'fd=h' to connect to an already opened TAP interface\n"
828 " use 'sndbuf=nbytes' to limit the size of the send buffer; the\n"
829 " default of 'sndbuf=1048576' can be disabled using 'sndbuf=0'\n"
830 " use vnet_hdr=off to avoid enabling the IFF_VNET_HDR tap flag; use\n"
831 " vnet_hdr=on to make the lack of IFF_VNET_HDR support an error condition\n"
833 "-net socket[,vlan=n][,name=str][,fd=h][,listen=[host]:port][,connect=host:port]\n"
834 " connect the vlan 'n' to another VLAN using a socket connection\n"
835 "-net socket[,vlan=n][,name=str][,fd=h][,mcast=maddr:port]\n"
836 " connect the vlan 'n' to multicast maddr and port\n"
838 "-net vde[,vlan=n][,name=str][,sock=socketpath][,port=n][,group=groupname][,mode=octalmode]\n"
839 " connect the vlan 'n' to port 'n' of a vde switch running\n"
840 " on host and listening for incoming connections on 'socketpath'.\n"
841 " Use group 'groupname' and mode 'octalmode' to change default\n"
842 " ownership and permissions for communication port.\n"
844 "-net dump[,vlan=n][,file=f][,len=n]\n"
845 " dump traffic on vlan 'n' to file 'f' (max n bytes per packet)\n"
846 "-net none use it alone to have zero network devices; if no -net option\n"
847 " is provided, the default is '-net nic -net user'\n")
848 DEF("netdev", HAS_ARG, QEMU_OPTION_netdev,
857 "socket],id=str[,option][,option][,...]\n")
859 @item -net nic[,vlan=@var{n}][,macaddr=@var{mac}][,model=@var{type}][,name=@var{name}][,addr=@var{addr}][,vectors=@var{v}]
860 Create a new Network Interface Card and connect it to VLAN @var{n} (@var{n}
861 = 0 is the default). The NIC is an e1000 by default on the PC
862 target. Optionally, the MAC address can be changed to @var{mac}, the
863 device address set to @var{addr} (PCI cards only),
864 and a @var{name} can be assigned for use in monitor commands.
865 Optionally, for PCI cards, you can specify the number @var{v} of MSI-X vectors
866 that the card should have; this option currently only affects virtio cards; set
867 @var{v} = 0 to disable MSI-X. If no @option{-net} option is specified, a single
868 NIC is created. Qemu can emulate several different models of network card.
869 Valid values for @var{type} are
870 @code{virtio}, @code{i82551}, @code{i82557b}, @code{i82559er},
871 @code{ne2k_pci}, @code{ne2k_isa}, @code{pcnet}, @code{rtl8139},
872 @code{e1000}, @code{smc91c111}, @code{lance} and @code{mcf_fec}.
873 Not all devices are supported on all targets. Use -net nic,model=?
874 for a list of available devices for your target.
876 @item -net user[,@var{option}][,@var{option}][,...]
877 Use the user mode network stack which requires no administrator
878 privilege to run. Valid options are:
882 Connect user mode stack to VLAN @var{n} (@var{n} = 0 is the default).
884 @item name=@var{name}
885 Assign symbolic name for use in monitor commands.
887 @item net=@var{addr}[/@var{mask}]
888 Set IP network address the guest will see. Optionally specify the netmask,
889 either in the form a.b.c.d or as number of valid top-most bits. Default is
892 @item host=@var{addr}
893 Specify the guest-visible address of the host. Default is the 2nd IP in the
894 guest network, i.e. x.x.x.2.
896 @item restrict=y|yes|n|no
897 If this options is enabled, the guest will be isolated, i.e. it will not be
898 able to contact the host and no guest IP packets will be routed over the host
899 to the outside. This option does not affect explicitly set forwarding rule.
901 @item hostname=@var{name}
902 Specifies the client hostname reported by the builtin DHCP server.
904 @item dhcpstart=@var{addr}
905 Specify the first of the 16 IPs the built-in DHCP server can assign. Default
906 is the 16th to 31st IP in the guest network, i.e. x.x.x.16 to x.x.x.31.
909 Specify the guest-visible address of the virtual nameserver. The address must
910 be different from the host address. Default is the 3rd IP in the guest network,
914 When using the user mode network stack, activate a built-in TFTP
915 server. The files in @var{dir} will be exposed as the root of a TFTP server.
916 The TFTP client on the guest must be configured in binary mode (use the command
917 @code{bin} of the Unix TFTP client).
919 @item bootfile=@var{file}
920 When using the user mode network stack, broadcast @var{file} as the BOOTP
921 filename. In conjunction with @option{tftp}, this can be used to network boot
922 a guest from a local directory.
924 Example (using pxelinux):
926 qemu -hda linux.img -boot n -net user,tftp=/path/to/tftp/files,bootfile=/pxelinux.0
929 @item smb=@var{dir}[,smbserver=@var{addr}]
930 When using the user mode network stack, activate a built-in SMB
931 server so that Windows OSes can access to the host files in @file{@var{dir}}
932 transparently. The IP address of the SMB server can be set to @var{addr}. By
933 default the 4th IP in the guest network is used, i.e. x.x.x.4.
935 In the guest Windows OS, the line:
939 must be added in the file @file{C:\WINDOWS\LMHOSTS} (for windows 9x/Me)
940 or @file{C:\WINNT\SYSTEM32\DRIVERS\ETC\LMHOSTS} (Windows NT/2000).
942 Then @file{@var{dir}} can be accessed in @file{\\smbserver\qemu}.
944 Note that a SAMBA server must be installed on the host OS in
945 @file{/usr/sbin/smbd}. QEMU was tested successfully with smbd versions from
946 Red Hat 9, Fedora Core 3 and OpenSUSE 11.x.
948 @item hostfwd=[tcp|udp]:[@var{hostaddr}]:@var{hostport}-[@var{guestaddr}]:@var{guestport}
949 Redirect incoming TCP or UDP connections to the host port @var{hostport} to
950 the guest IP address @var{guestaddr} on guest port @var{guestport}. If
951 @var{guestaddr} is not specified, its value is x.x.x.15 (default first address
952 given by the built-in DHCP server). By specifying @var{hostaddr}, the rule can
953 be bound to a specific host interface. If no connection type is set, TCP is
954 used. This option can be given multiple times.
956 For example, to redirect host X11 connection from screen 1 to guest
957 screen 0, use the following:
961 qemu -net user,hostfwd=tcp:127.0.0.1:6001-:6000 [...]
962 # this host xterm should open in the guest X11 server
966 To redirect telnet connections from host port 5555 to telnet port on
967 the guest, use the following:
971 qemu -net user,hostfwd=tcp::5555-:23 [...]
972 telnet localhost 5555
975 Then when you use on the host @code{telnet localhost 5555}, you
976 connect to the guest telnet server.
978 @item guestfwd=[tcp]:@var{server}:@var{port}-@var{dev}
979 Forward guest TCP connections to the IP address @var{server} on port @var{port}
980 to the character device @var{dev}. This option can be given multiple times.
984 Note: Legacy stand-alone options -tftp, -bootp, -smb and -redir are still
985 processed and applied to -net user. Mixing them with the new configuration
986 syntax gives undefined results. Their use for new applications is discouraged
987 as they will be removed from future versions.
989 @item -net tap[,vlan=@var{n}][,name=@var{name}][,fd=@var{h}][,ifname=@var{name}][,script=@var{file}][,downscript=@var{dfile}]
990 Connect the host TAP network interface @var{name} to VLAN @var{n}, use
991 the network script @var{file} to configure it and the network script
992 @var{dfile} to deconfigure it. If @var{name} is not provided, the OS
993 automatically provides one. @option{fd}=@var{h} can be used to specify
994 the handle of an already opened host TAP interface. The default network
995 configure script is @file{/etc/qemu-ifup} and the default network
996 deconfigure script is @file{/etc/qemu-ifdown}. Use @option{script=no}
997 or @option{downscript=no} to disable script execution. Example:
1000 qemu linux.img -net nic -net tap
1003 More complicated example (two NICs, each one connected to a TAP device)
1005 qemu linux.img -net nic,vlan=0 -net tap,vlan=0,ifname=tap0 \
1006 -net nic,vlan=1 -net tap,vlan=1,ifname=tap1
1009 @item -net socket[,vlan=@var{n}][,name=@var{name}][,fd=@var{h}][,listen=[@var{host}]:@var{port}][,connect=@var{host}:@var{port}]
1011 Connect the VLAN @var{n} to a remote VLAN in another QEMU virtual
1012 machine using a TCP socket connection. If @option{listen} is
1013 specified, QEMU waits for incoming connections on @var{port}
1014 (@var{host} is optional). @option{connect} is used to connect to
1015 another QEMU instance using the @option{listen} option. @option{fd}=@var{h}
1016 specifies an already opened TCP socket.
1020 # launch a first QEMU instance
1021 qemu linux.img -net nic,macaddr=52:54:00:12:34:56 \
1022 -net socket,listen=:1234
1023 # connect the VLAN 0 of this instance to the VLAN 0
1024 # of the first instance
1025 qemu linux.img -net nic,macaddr=52:54:00:12:34:57 \
1026 -net socket,connect=127.0.0.1:1234
1029 @item -net socket[,vlan=@var{n}][,name=@var{name}][,fd=@var{h}][,mcast=@var{maddr}:@var{port}]
1031 Create a VLAN @var{n} shared with another QEMU virtual
1032 machines using a UDP multicast socket, effectively making a bus for
1033 every QEMU with same multicast address @var{maddr} and @var{port}.
1037 Several QEMU can be running on different hosts and share same bus (assuming
1038 correct multicast setup for these hosts).
1040 mcast support is compatible with User Mode Linux (argument @option{eth@var{N}=mcast}), see
1041 @url{http://user-mode-linux.sf.net}.
1043 Use @option{fd=h} to specify an already opened UDP multicast socket.
1048 # launch one QEMU instance
1049 qemu linux.img -net nic,macaddr=52:54:00:12:34:56 \
1050 -net socket,mcast=230.0.0.1:1234
1051 # launch another QEMU instance on same "bus"
1052 qemu linux.img -net nic,macaddr=52:54:00:12:34:57 \
1053 -net socket,mcast=230.0.0.1:1234
1054 # launch yet another QEMU instance on same "bus"
1055 qemu linux.img -net nic,macaddr=52:54:00:12:34:58 \
1056 -net socket,mcast=230.0.0.1:1234
1059 Example (User Mode Linux compat.):
1061 # launch QEMU instance (note mcast address selected
1063 qemu linux.img -net nic,macaddr=52:54:00:12:34:56 \
1064 -net socket,mcast=239.192.168.1:1102
1066 /path/to/linux ubd0=/path/to/root_fs eth0=mcast
1069 @item -net vde[,vlan=@var{n}][,name=@var{name}][,sock=@var{socketpath}][,port=@var{n}][,group=@var{groupname}][,mode=@var{octalmode}]
1070 Connect VLAN @var{n} to PORT @var{n} of a vde switch running on host and
1071 listening for incoming connections on @var{socketpath}. Use GROUP @var{groupname}
1072 and MODE @var{octalmode} to change default ownership and permissions for
1073 communication port. This option is available only if QEMU has been compiled
1074 with vde support enabled.
1079 vde_switch -F -sock /tmp/myswitch
1080 # launch QEMU instance
1081 qemu linux.img -net nic -net vde,sock=/tmp/myswitch
1084 @item -net dump[,vlan=@var{n}][,file=@var{file}][,len=@var{len}]
1085 Dump network traffic on VLAN @var{n} to file @var{file} (@file{qemu-vlan0.pcap} by default).
1086 At most @var{len} bytes (64k by default) per packet are stored. The file format is
1087 libpcap, so it can be analyzed with tools such as tcpdump or Wireshark.
1090 Indicate that no network devices should be configured. It is used to
1091 override the default configuration (@option{-net nic -net user}) which
1092 is activated if no @option{-net} options are provided.
1099 DEFHEADING(Character device options:)
1101 DEF("chardev", HAS_ARG, QEMU_OPTION_chardev,
1102 "-chardev null,id=id\n"
1103 "-chardev socket,id=id[,host=host],port=host[,to=to][,ipv4][,ipv6][,nodelay]\n"
1104 " [,server][,nowait][,telnet] (tcp)\n"
1105 "-chardev socket,id=id,path=path[,server][,nowait][,telnet] (unix)\n"
1106 "-chardev udp,id=id[,host=host],port=port[,localaddr=localaddr]\n"
1107 " [,localport=localport][,ipv4][,ipv6]\n"
1108 "-chardev msmouse,id=id\n"
1109 "-chardev vc,id=id[[,width=width][,height=height]][[,cols=cols][,rows=rows]]\n"
1110 "-chardev file,id=id,path=path\n"
1111 "-chardev pipe,id=id,path=path\n"
1113 "-chardev console,id=id\n"
1114 "-chardev serial,id=id,path=path\n"
1116 "-chardev pty,id=id\n"
1117 "-chardev stdio,id=id,[,signal=on|off]\n"
1119 #ifdef CONFIG_BRLAPI
1120 "-chardev braille,id=id\n"
1122 #if defined(__linux__) || defined(__sun__) || defined(__FreeBSD__) \
1123 || defined(__NetBSD__) || defined(__OpenBSD__) || defined(__DragonFly__)
1124 "-chardev tty,id=id,path=path\n"
1126 #if defined(__linux__) || defined(__FreeBSD__) || defined(__DragonFly__)
1127 "-chardev parport,id=id,path=path\n"
1133 The general form of a character device option is:
1136 @item -chardev @var{backend} ,id=@var{id} [,@var{options}]
1153 The specific backend will determine the applicable options.
1155 All devices must have an id, which can be any string up to 127 characters long.
1156 It is used to uniquely identify this device in other command line directives.
1158 Options to each backend are described below.
1160 @item -chardev null ,id=@var{id}
1161 A void device. This device will not emit any data, and will drop any data it
1162 receives. The null backend does not take any options.
1164 @item -chardev socket ,id=@var{id} [@var{TCP options} or @var{unix options}] [,server] [,nowait] [,telnet]
1166 Create a two-way stream socket, which can be either a TCP or a unix socket. A
1167 unix socket will be created if @option{path} is specified. Behaviour is
1168 undefined if TCP options are specified for a unix socket.
1170 @option{server} specifies that the socket shall be a listening socket.
1172 @option{nowait} specifies that QEMU should not block waiting for a client to
1173 connect to a listening socket.
1175 @option{telnet} specifies that traffic on the socket should interpret telnet
1178 TCP and unix socket options are given below:
1182 @item TCP options: port=@var{host} [,host=@var{host}] [,to=@var{to}] [,ipv4] [,ipv6] [,nodelay]
1184 @option{host} for a listening socket specifies the local address to be bound.
1185 For a connecting socket species the remote host to connect to. @option{host} is
1186 optional for listening sockets. If not specified it defaults to @code{0.0.0.0}.
1188 @option{port} for a listening socket specifies the local port to be bound. For a
1189 connecting socket specifies the port on the remote host to connect to.
1190 @option{port} can be given as either a port number or a service name.
1191 @option{port} is required.
1193 @option{to} is only relevant to listening sockets. If it is specified, and
1194 @option{port} cannot be bound, QEMU will attempt to bind to subsequent ports up
1195 to and including @option{to} until it succeeds. @option{to} must be specified
1198 @option{ipv4} and @option{ipv6} specify that either IPv4 or IPv6 must be used.
1199 If neither is specified the socket may use either protocol.
1201 @option{nodelay} disables the Nagle algorithm.
1203 @item unix options: path=@var{path}
1205 @option{path} specifies the local path of the unix socket. @option{path} is
1210 @item -chardev udp ,id=@var{id} [,host=@var{host}] ,port=@var{port} [,localaddr=@var{localaddr}] [,localport=@var{localport}] [,ipv4] [,ipv6]
1212 Sends all traffic from the guest to a remote host over UDP.
1214 @option{host} specifies the remote host to connect to. If not specified it
1215 defaults to @code{localhost}.
1217 @option{port} specifies the port on the remote host to connect to. @option{port}
1220 @option{localaddr} specifies the local address to bind to. If not specified it
1221 defaults to @code{0.0.0.0}.
1223 @option{localport} specifies the local port to bind to. If not specified any
1224 available local port will be used.
1226 @option{ipv4} and @option{ipv6} specify that either IPv4 or IPv6 must be used.
1227 If neither is specified the device may use either protocol.
1229 @item -chardev msmouse ,id=@var{id}
1231 Forward QEMU's emulated msmouse events to the guest. @option{msmouse} does not
1234 @item -chardev vc ,id=@var{id} [[,width=@var{width}] [,height=@var{height}]] [[,cols=@var{cols}] [,rows=@var{rows}]]
1236 Connect to a QEMU text console. @option{vc} may optionally be given a specific
1239 @option{width} and @option{height} specify the width and height respectively of
1240 the console, in pixels.
1242 @option{cols} and @option{rows} specify that the console be sized to fit a text
1243 console with the given dimensions.
1245 @item -chardev file ,id=@var{id} ,path=@var{path}
1247 Log all traffic received from the guest to a file.
1249 @option{path} specifies the path of the file to be opened. This file will be
1250 created if it does not already exist, and overwritten if it does. @option{path}
1253 @item -chardev pipe ,id=@var{id} ,path=@var{path}
1255 Create a two-way connection to the guest. The behaviour differs slightly between
1256 Windows hosts and other hosts:
1258 On Windows, a single duplex pipe will be created at
1259 @file{\\.pipe\@option{path}}.
1261 On other hosts, 2 pipes will be created called @file{@option{path}.in} and
1262 @file{@option{path}.out}. Data written to @file{@option{path}.in} will be
1263 received by the guest. Data written by the guest can be read from
1264 @file{@option{path}.out}. QEMU will not create these fifos, and requires them to
1267 @option{path} forms part of the pipe path as described above. @option{path} is
1270 @item -chardev console ,id=@var{id}
1272 Send traffic from the guest to QEMU's standard output. @option{console} does not
1275 @option{console} is only available on Windows hosts.
1277 @item -chardev serial ,id=@var{id} ,path=@option{path}
1279 Send traffic from the guest to a serial device on the host.
1282 only available on Windows hosts.
1284 @option{path} specifies the name of the serial device to open.
1286 @item -chardev pty ,id=@var{id}
1288 Create a new pseudo-terminal on the host and connect to it. @option{pty} does
1289 not take any options.
1291 @option{pty} is not available on Windows hosts.
1293 @item -chardev stdio ,id=@var{id} [,signal=on|off]
1294 Connect to standard input and standard output of the qemu process.
1296 @option{signal} controls if signals are enabled on the terminal, that includes
1297 exiting QEMU with the key sequence @key{Control-c}. This option is enabled by
1298 default, use @option{signal=off} to disable it.
1300 @option{stdio} is not available on Windows hosts.
1302 @item -chardev braille ,id=@var{id}
1304 Connect to a local BrlAPI server. @option{braille} does not take any options.
1306 @item -chardev tty ,id=@var{id} ,path=@var{path}
1308 Connect to a local tty device.
1310 @option{tty} is only available on Linux, Sun, FreeBSD, NetBSD, OpenBSD and
1313 @option{path} specifies the path to the tty. @option{path} is required.
1315 @item -chardev parport ,id=@var{id} ,path=@var{path}
1317 @option{parport} is only available on Linux, FreeBSD and DragonFlyBSD hosts.
1319 Connect to a local parallel port.
1321 @option{path} specifies the path to the parallel port device. @option{path} is
1329 DEFHEADING(Bluetooth(R) options:)
1331 DEF("bt", HAS_ARG, QEMU_OPTION_bt, \
1332 "-bt hci,null dumb bluetooth HCI - doesn't respond to commands\n" \
1333 "-bt hci,host[:id]\n" \
1334 " use host's HCI with the given name\n" \
1335 "-bt hci[,vlan=n]\n" \
1336 " emulate a standard HCI in virtual scatternet 'n'\n" \
1337 "-bt vhci[,vlan=n]\n" \
1338 " add host computer to virtual scatternet 'n' using VHCI\n" \
1339 "-bt device:dev[,vlan=n]\n" \
1340 " emulate a bluetooth device 'dev' in scatternet 'n'\n")
1345 Defines the function of the corresponding Bluetooth HCI. -bt options
1346 are matched with the HCIs present in the chosen machine type. For
1347 example when emulating a machine with only one HCI built into it, only
1348 the first @code{-bt hci[...]} option is valid and defines the HCI's
1349 logic. The Transport Layer is decided by the machine type. Currently
1350 the machines @code{n800} and @code{n810} have one HCI and all other
1354 The following three types are recognized:
1358 (default) The corresponding Bluetooth HCI assumes no internal logic
1359 and will not respond to any HCI commands or emit events.
1361 @item -bt hci,host[:@var{id}]
1362 (@code{bluez} only) The corresponding HCI passes commands / events
1363 to / from the physical HCI identified by the name @var{id} (default:
1364 @code{hci0}) on the computer running QEMU. Only available on @code{bluez}
1365 capable systems like Linux.
1367 @item -bt hci[,vlan=@var{n}]
1368 Add a virtual, standard HCI that will participate in the Bluetooth
1369 scatternet @var{n} (default @code{0}). Similarly to @option{-net}
1370 VLANs, devices inside a bluetooth network @var{n} can only communicate
1371 with other devices in the same network (scatternet).
1374 @item -bt vhci[,vlan=@var{n}]
1375 (Linux-host only) Create a HCI in scatternet @var{n} (default 0) attached
1376 to the host bluetooth stack instead of to the emulated target. This
1377 allows the host and target machines to participate in a common scatternet
1378 and communicate. Requires the Linux @code{vhci} driver installed. Can
1379 be used as following:
1382 qemu [...OPTIONS...] -bt hci,vlan=5 -bt vhci,vlan=5
1385 @item -bt device:@var{dev}[,vlan=@var{n}]
1386 Emulate a bluetooth device @var{dev} and place it in network @var{n}
1387 (default @code{0}). QEMU can only emulate one type of bluetooth devices
1392 Virtual wireless keyboard implementing the HIDP bluetooth profile.
1399 DEFHEADING(Linux/Multiboot boot specific:)
1402 When using these options, you can use a given Linux or Multiboot
1403 kernel without installing it in the disk image. It can be useful
1404 for easier testing of various kernels.
1409 DEF("kernel", HAS_ARG, QEMU_OPTION_kernel, \
1410 "-kernel bzImage use 'bzImage' as kernel image\n")
1412 @item -kernel @var{bzImage}
1413 Use @var{bzImage} as kernel image. The kernel can be either a Linux kernel
1414 or in multiboot format.
1417 DEF("append", HAS_ARG, QEMU_OPTION_append, \
1418 "-append cmdline use 'cmdline' as kernel command line\n")
1420 @item -append @var{cmdline}
1421 Use @var{cmdline} as kernel command line
1424 DEF("initrd", HAS_ARG, QEMU_OPTION_initrd, \
1425 "-initrd file use 'file' as initial ram disk\n")
1427 @item -initrd @var{file}
1428 Use @var{file} as initial ram disk.
1430 @item -initrd "@var{file1} arg=foo,@var{file2}"
1432 This syntax is only available with multiboot.
1434 Use @var{file1} and @var{file2} as modules and pass arg=foo as parameter to the
1444 DEFHEADING(Debug/Expert options:)
1450 DEF("serial", HAS_ARG, QEMU_OPTION_serial, \
1451 "-serial dev redirect the serial port to char device 'dev'\n")
1453 @item -serial @var{dev}
1454 Redirect the virtual serial port to host character device
1455 @var{dev}. The default device is @code{vc} in graphical mode and
1456 @code{stdio} in non graphical mode.
1458 This option can be used several times to simulate up to 4 serial
1461 Use @code{-serial none} to disable all serial ports.
1463 Available character devices are:
1465 @item vc[:@var{W}x@var{H}]
1466 Virtual console. Optionally, a width and height can be given in pixel with
1470 It is also possible to specify width or height in characters:
1475 [Linux only] Pseudo TTY (a new PTY is automatically allocated)
1477 No device is allocated.
1481 [Linux only] Use host tty, e.g. @file{/dev/ttyS0}. The host serial port
1482 parameters are set according to the emulated ones.
1483 @item /dev/parport@var{N}
1484 [Linux only, parallel port only] Use host parallel port
1485 @var{N}. Currently SPP and EPP parallel port features can be used.
1486 @item file:@var{filename}
1487 Write output to @var{filename}. No character can be read.
1489 [Unix only] standard input/output
1490 @item pipe:@var{filename}
1491 name pipe @var{filename}
1493 [Windows only] Use host serial port @var{n}
1494 @item udp:[@var{remote_host}]:@var{remote_port}[@@[@var{src_ip}]:@var{src_port}]
1495 This implements UDP Net Console.
1496 When @var{remote_host} or @var{src_ip} are not specified
1497 they default to @code{0.0.0.0}.
1498 When not using a specified @var{src_port} a random port is automatically chosen.
1500 If you just want a simple readonly console you can use @code{netcat} or
1501 @code{nc}, by starting qemu with: @code{-serial udp::4555} and nc as:
1502 @code{nc -u -l -p 4555}. Any time qemu writes something to that port it
1503 will appear in the netconsole session.
1505 If you plan to send characters back via netconsole or you want to stop
1506 and start qemu a lot of times, you should have qemu use the same
1507 source port each time by using something like @code{-serial
1508 udp::4555@@:4556} to qemu. Another approach is to use a patched
1509 version of netcat which can listen to a TCP port and send and receive
1510 characters via udp. If you have a patched version of netcat which
1511 activates telnet remote echo and single char transfer, then you can
1512 use the following options to step up a netcat redirector to allow
1513 telnet on port 5555 to access the qemu port.
1516 -serial udp::4555@@:4556
1517 @item netcat options:
1518 -u -P 4555 -L 0.0.0.0:4556 -t -p 5555 -I -T
1519 @item telnet options:
1523 @item tcp:[@var{host}]:@var{port}[,@var{server}][,nowait][,nodelay]
1524 The TCP Net Console has two modes of operation. It can send the serial
1525 I/O to a location or wait for a connection from a location. By default
1526 the TCP Net Console is sent to @var{host} at the @var{port}. If you use
1527 the @var{server} option QEMU will wait for a client socket application
1528 to connect to the port before continuing, unless the @code{nowait}
1529 option was specified. The @code{nodelay} option disables the Nagle buffering
1530 algorithm. If @var{host} is omitted, 0.0.0.0 is assumed. Only
1531 one TCP connection at a time is accepted. You can use @code{telnet} to
1532 connect to the corresponding character device.
1534 @item Example to send tcp console to 192.168.0.2 port 4444
1535 -serial tcp:192.168.0.2:4444
1536 @item Example to listen and wait on port 4444 for connection
1537 -serial tcp::4444,server
1538 @item Example to not wait and listen on ip 192.168.0.100 port 4444
1539 -serial tcp:192.168.0.100:4444,server,nowait
1542 @item telnet:@var{host}:@var{port}[,server][,nowait][,nodelay]
1543 The telnet protocol is used instead of raw tcp sockets. The options
1544 work the same as if you had specified @code{-serial tcp}. The
1545 difference is that the port acts like a telnet server or client using
1546 telnet option negotiation. This will also allow you to send the
1547 MAGIC_SYSRQ sequence if you use a telnet that supports sending the break
1548 sequence. Typically in unix telnet you do it with Control-] and then
1549 type "send break" followed by pressing the enter key.
1551 @item unix:@var{path}[,server][,nowait]
1552 A unix domain socket is used instead of a tcp socket. The option works the
1553 same as if you had specified @code{-serial tcp} except the unix domain socket
1554 @var{path} is used for connections.
1556 @item mon:@var{dev_string}
1557 This is a special option to allow the monitor to be multiplexed onto
1558 another serial port. The monitor is accessed with key sequence of
1559 @key{Control-a} and then pressing @key{c}. See monitor access
1560 @ref{pcsys_keys} in the -nographic section for more keys.
1561 @var{dev_string} should be any one of the serial devices specified
1562 above. An example to multiplex the monitor onto a telnet server
1563 listening on port 4444 would be:
1565 @item -serial mon:telnet::4444,server,nowait
1569 Braille device. This will use BrlAPI to display the braille output on a real
1573 Three button serial mouse. Configure the guest to use Microsoft protocol.
1577 DEF("parallel", HAS_ARG, QEMU_OPTION_parallel, \
1578 "-parallel dev redirect the parallel port to char device 'dev'\n")
1580 @item -parallel @var{dev}
1581 Redirect the virtual parallel port to host device @var{dev} (same
1582 devices as the serial port). On Linux hosts, @file{/dev/parportN} can
1583 be used to use hardware devices connected on the corresponding host
1586 This option can be used several times to simulate up to 3 parallel
1589 Use @code{-parallel none} to disable all parallel ports.
1592 DEF("monitor", HAS_ARG, QEMU_OPTION_monitor, \
1593 "-monitor dev redirect the monitor to char device 'dev'\n")
1595 @item -monitor @var{dev}
1596 Redirect the monitor to host device @var{dev} (same devices as the
1598 The default device is @code{vc} in graphical mode and @code{stdio} in
1601 DEF("qmp", HAS_ARG, QEMU_OPTION_qmp, \
1602 "-qmp dev like -monitor but opens in 'control' mode.\n")
1604 DEF("mon", HAS_ARG, QEMU_OPTION_mon, \
1605 "-mon chardev=[name][,mode=readline|control][,default]\n")
1607 @item -mon chardev=[name][,mode=readline|control][,default]
1608 Setup monitor on chardev @var{name}.
1611 DEF("pidfile", HAS_ARG, QEMU_OPTION_pidfile, \
1612 "-pidfile file write PID to 'file'\n")
1614 @item -pidfile @var{file}
1615 Store the QEMU process PID in @var{file}. It is useful if you launch QEMU
1619 DEF("singlestep", 0, QEMU_OPTION_singlestep, \
1620 "-singlestep always run in singlestep mode\n")
1623 Run the emulation in single step mode.
1626 DEF("S", 0, QEMU_OPTION_S, \
1627 "-S freeze CPU at startup (use 'c' to start execution)\n")
1630 Do not start CPU at startup (you must type 'c' in the monitor).
1633 DEF("gdb", HAS_ARG, QEMU_OPTION_gdb, \
1634 "-gdb dev wait for gdb connection on 'dev'\n")
1636 @item -gdb @var{dev}
1637 Wait for gdb connection on device @var{dev} (@pxref{gdb_usage}). Typical
1638 connections will likely be TCP-based, but also UDP, pseudo TTY, or even
1639 stdio are reasonable use case. The latter is allowing to start qemu from
1640 within gdb and establish the connection via a pipe:
1642 (gdb) target remote | exec qemu -gdb stdio ...
1646 DEF("s", 0, QEMU_OPTION_s, \
1647 "-s shorthand for -gdb tcp::%s\n")
1650 Shorthand for -gdb tcp::1234, i.e. open a gdbserver on TCP port 1234
1651 (@pxref{gdb_usage}).
1654 DEF("d", HAS_ARG, QEMU_OPTION_d, \
1655 "-d item1,... output log to %s (use -d ? for a list of log items)\n")
1658 Output log in /tmp/qemu.log
1661 DEF("hdachs", HAS_ARG, QEMU_OPTION_hdachs, \
1662 "-hdachs c,h,s[,t]\n" \
1663 " force hard disk 0 physical geometry and the optional BIOS\n" \
1664 " translation (t=none or lba) (usually qemu can guess them)\n")
1666 @item -hdachs @var{c},@var{h},@var{s},[,@var{t}]
1667 Force hard disk 0 physical geometry (1 <= @var{c} <= 16383, 1 <=
1668 @var{h} <= 16, 1 <= @var{s} <= 63) and optionally force the BIOS
1669 translation mode (@var{t}=none, lba or auto). Usually QEMU can guess
1670 all those parameters. This option is useful for old MS-DOS disk
1674 DEF("L", HAS_ARG, QEMU_OPTION_L, \
1675 "-L path set the directory for the BIOS, VGA BIOS and keymaps\n")
1678 Set the directory for the BIOS, VGA BIOS and keymaps.
1681 DEF("bios", HAS_ARG, QEMU_OPTION_bios, \
1682 "-bios file set the filename for the BIOS\n")
1684 @item -bios @var{file}
1685 Set the filename for the BIOS.
1689 DEF("enable-kvm", 0, QEMU_OPTION_enable_kvm, \
1690 "-enable-kvm enable KVM full virtualization support\n")
1694 Enable KVM full virtualization support. This option is only available
1695 if KVM support is enabled when compiling.
1699 DEF("xen-domid", HAS_ARG, QEMU_OPTION_xen_domid,
1700 "-xen-domid id specify xen guest domain id\n")
1701 DEF("xen-create", 0, QEMU_OPTION_xen_create,
1702 "-xen-create create domain using xen hypercalls, bypassing xend\n"
1703 " warning: should not be used when xend is in use\n")
1704 DEF("xen-attach", 0, QEMU_OPTION_xen_attach,
1705 "-xen-attach attach to existing xen domain\n"
1706 " xend will use this when starting qemu\n")
1709 DEF("no-reboot", 0, QEMU_OPTION_no_reboot, \
1710 "-no-reboot exit instead of rebooting\n")
1713 Exit instead of rebooting.
1716 DEF("no-shutdown", 0, QEMU_OPTION_no_shutdown, \
1717 "-no-shutdown stop before shutdown\n")
1720 Don't exit QEMU on guest shutdown, but instead only stop the emulation.
1721 This allows for instance switching to monitor to commit changes to the
1725 DEF("loadvm", HAS_ARG, QEMU_OPTION_loadvm, \
1726 "-loadvm [tag|id]\n" \
1727 " start right away with a saved state (loadvm in monitor)\n")
1729 @item -loadvm @var{file}
1730 Start right away with a saved state (@code{loadvm} in monitor)
1734 DEF("daemonize", 0, QEMU_OPTION_daemonize, \
1735 "-daemonize daemonize QEMU after initializing\n")
1739 Daemonize the QEMU process after initialization. QEMU will not detach from
1740 standard IO until it is ready to receive connections on any of its devices.
1741 This option is a useful way for external programs to launch QEMU without having
1742 to cope with initialization race conditions.
1745 DEF("option-rom", HAS_ARG, QEMU_OPTION_option_rom, \
1746 "-option-rom rom load a file, rom, into the option ROM space\n")
1748 @item -option-rom @var{file}
1749 Load the contents of @var{file} as an option ROM.
1750 This option is useful to load things like EtherBoot.
1753 DEF("clock", HAS_ARG, QEMU_OPTION_clock, \
1754 "-clock force the use of the given methods for timer alarm.\n" \
1755 " To see what timers are available use -clock ?\n")
1757 @item -clock @var{method}
1758 Force the use of the given methods for timer alarm. To see what timers
1759 are available use -clock ?.
1762 HXCOMM Options deprecated by -rtc
1763 DEF("localtime", 0, QEMU_OPTION_localtime, "")
1764 DEF("startdate", HAS_ARG, QEMU_OPTION_startdate, "")
1767 DEF("rtc", HAS_ARG, QEMU_OPTION_rtc, \
1768 "-rtc [base=utc|localtime|date][,clock=host|vm][,driftfix=none|slew]\n" \
1769 " set the RTC base and clock, enable drift fix for clock ticks\n")
1771 DEF("rtc", HAS_ARG, QEMU_OPTION_rtc, \
1772 "-rtc [base=utc|localtime|date][,clock=host|vm]\n" \
1773 " set the RTC base and clock\n")
1778 @item -rtc [base=utc|localtime|@var{date}][,clock=host|vm][,driftfix=none|slew]
1779 Specify @option{base} as @code{utc} or @code{localtime} to let the RTC start at the current
1780 UTC or local time, respectively. @code{localtime} is required for correct date in
1781 MS-DOS or Windows. To start at a specific point in time, provide @var{date} in the
1782 format @code{2006-06-17T16:01:21} or @code{2006-06-17}. The default base is UTC.
1784 By default the RTC is driven by the host system time. This allows to use the
1785 RTC as accurate reference clock inside the guest, specifically if the host
1786 time is smoothly following an accurate external reference clock, e.g. via NTP.
1787 If you want to isolate the guest time from the host, even prevent it from
1788 progressing during suspension, you can set @option{clock} to @code{vm} instead.
1790 Enable @option{driftfix} (i386 targets only) if you experience time drift problems,
1791 specifically with Windows' ACPI HAL. This option will try to figure out how
1792 many timer interrupts were not processed by the Windows guest and will
1796 DEF("icount", HAS_ARG, QEMU_OPTION_icount, \
1797 "-icount [N|auto]\n" \
1798 " enable virtual instruction counter with 2^N clock ticks per\n" \
1801 @item -icount [@var{N}|auto]
1802 Enable virtual instruction counter. The virtual cpu will execute one
1803 instruction every 2^@var{N} ns of virtual time. If @code{auto} is specified
1804 then the virtual cpu speed will be automatically adjusted to keep virtual
1805 time within a few seconds of real time.
1807 Note that while this option can give deterministic behavior, it does not
1808 provide cycle accurate emulation. Modern CPUs contain superscalar out of
1809 order cores with complex cache hierarchies. The number of instructions
1810 executed often has little or no correlation with actual performance.
1813 DEF("watchdog", HAS_ARG, QEMU_OPTION_watchdog, \
1814 "-watchdog i6300esb|ib700\n" \
1815 " enable virtual hardware watchdog [default=none]\n")
1817 @item -watchdog @var{model}
1818 Create a virtual hardware watchdog device. Once enabled (by a guest
1819 action), the watchdog must be periodically polled by an agent inside
1820 the guest or else the guest will be restarted.
1822 The @var{model} is the model of hardware watchdog to emulate. Choices
1823 for model are: @code{ib700} (iBASE 700) which is a very simple ISA
1824 watchdog with a single timer, or @code{i6300esb} (Intel 6300ESB I/O
1825 controller hub) which is a much more featureful PCI-based dual-timer
1826 watchdog. Choose a model for which your guest has drivers.
1828 Use @code{-watchdog ?} to list available hardware models. Only one
1829 watchdog can be enabled for a guest.
1832 DEF("watchdog-action", HAS_ARG, QEMU_OPTION_watchdog_action, \
1833 "-watchdog-action reset|shutdown|poweroff|pause|debug|none\n" \
1834 " action when watchdog fires [default=reset]\n")
1836 @item -watchdog-action @var{action}
1838 The @var{action} controls what QEMU will do when the watchdog timer
1841 @code{reset} (forcefully reset the guest).
1842 Other possible actions are:
1843 @code{shutdown} (attempt to gracefully shutdown the guest),
1844 @code{poweroff} (forcefully poweroff the guest),
1845 @code{pause} (pause the guest),
1846 @code{debug} (print a debug message and continue), or
1847 @code{none} (do nothing).
1849 Note that the @code{shutdown} action requires that the guest responds
1850 to ACPI signals, which it may not be able to do in the sort of
1851 situations where the watchdog would have expired, and thus
1852 @code{-watchdog-action shutdown} is not recommended for production use.
1857 @item -watchdog i6300esb -watchdog-action pause
1858 @item -watchdog ib700
1862 DEF("echr", HAS_ARG, QEMU_OPTION_echr, \
1863 "-echr chr set terminal escape character instead of ctrl-a\n")
1866 @item -echr @var{numeric_ascii_value}
1867 Change the escape character used for switching to the monitor when using
1868 monitor and serial sharing. The default is @code{0x01} when using the
1869 @code{-nographic} option. @code{0x01} is equal to pressing
1870 @code{Control-a}. You can select a different character from the ascii
1871 control keys where 1 through 26 map to Control-a through Control-z. For
1872 instance you could use the either of the following to change the escape
1873 character to Control-t.
1880 DEF("virtioconsole", HAS_ARG, QEMU_OPTION_virtiocon, \
1881 "-virtioconsole c\n" \
1882 " set virtio console\n")
1884 @item -virtioconsole @var{c}
1888 DEF("show-cursor", 0, QEMU_OPTION_show_cursor, \
1889 "-show-cursor show cursor\n")
1893 DEF("tb-size", HAS_ARG, QEMU_OPTION_tb_size, \
1894 "-tb-size n set TB size\n")
1898 DEF("incoming", HAS_ARG, QEMU_OPTION_incoming, \
1899 "-incoming p prepare for incoming migration, listen on port p\n")
1903 DEF("nodefaults", 0, QEMU_OPTION_nodefaults, \
1904 "-nodefaults don't create default devices.\n")
1907 Don't create default devices.
1911 DEF("chroot", HAS_ARG, QEMU_OPTION_chroot, \
1912 "-chroot dir Chroot to dir just before starting the VM.\n")
1915 @item -chroot @var{dir}
1916 Immediately before starting guest execution, chroot to the specified
1917 directory. Especially useful in combination with -runas.
1921 DEF("runas", HAS_ARG, QEMU_OPTION_runas, \
1922 "-runas user Change to user id user just before starting the VM.\n")
1925 @item -runas @var{user}
1926 Immediately before starting guest execution, drop root privileges, switching
1927 to the specified user.
1930 #if defined(TARGET_SPARC) || defined(TARGET_PPC)
1931 DEF("prom-env", HAS_ARG, QEMU_OPTION_prom_env,
1932 "-prom-env variable=value\n"
1933 " set OpenBIOS nvram variables\n")
1935 #if defined(TARGET_ARM) || defined(TARGET_M68K)
1936 DEF("semihosting", 0, QEMU_OPTION_semihosting,
1937 "-semihosting semihosting mode\n")
1939 #if defined(TARGET_ARM)
1940 DEF("old-param", 0, QEMU_OPTION_old_param,
1941 "-old-param old param mode\n")
1943 DEF("readconfig", HAS_ARG, QEMU_OPTION_readconfig,
1944 "-readconfig <file>\n")
1946 @item -readconfig @var{file}
1947 Read device configuration from @var{file}.
1949 DEF("writeconfig", HAS_ARG, QEMU_OPTION_writeconfig,
1950 "-writeconfig <file>\n"
1951 " read/write config file\n")
1953 @item -writeconfig @var{file}
1954 Write device configuration to @var{file}.
1957 HXCOMM This is the last statement. Insert new options before this line!