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"
108 " use 'file' as a drive image\n")
109 DEF("set", HAS_ARG
, QEMU_OPTION_set
,
110 "-set group.id.arg=value\n"
111 " set <arg> parameter for item <id> of type <group>\n"
112 " i.e. -set drive.$id.file=/path/to/image\n")
114 @item
-drive @
var{option
}[,@
var{option
}[,@
var{option
}[,...]]]
116 Define a
new drive
. Valid options are
:
119 @item file
=@
var{file
}
120 This option defines which disk
image (@pxref
{disk_images
}) to use with
121 this drive
. If the filename contains comma
, you must double it
122 (for instance
, "file=my,,file" to use file
"my,file").
123 @item
if=@
var{interface}
124 This option defines on which type on
interface the drive is connected
.
125 Available types are
: ide
, scsi
, sd
, mtd
, floppy
, pflash
, virtio
.
126 @item bus
=@
var{bus
},unit
=@
var{unit
}
127 These options define where is connected the drive by defining the bus number and
129 @item index
=@
var{index
}
130 This option defines where is connected the drive by
using an index
in the list
131 of available connectors of a given
interface type
.
132 @item media
=@
var{media
}
133 This option defines the type of the media
: disk or cdrom
.
134 @item cyls
=@
var{c
},heads
=@
var{h
},secs
=@
var{s
}[,trans
=@
var{t
}]
135 These options have the same definition as they have
in @option
{-hdachs
}.
136 @item snapshot
=@
var{snapshot
}
137 @
var{snapshot
} is
"on" or
"off" and allows to enable snapshot
for given
drive (see @option
{-snapshot
}).
138 @item cache
=@
var{cache
}
139 @
var{cache
} is
"none", "writeback", or
"writethrough" and controls how the host cache is used to access block data
.
141 @
var{aio
} is
"threads", or
"native" and selects between pthread based disk I
/O and native Linux AIO
.
142 @item format
=@
var{format
}
143 Specify which disk @
var{format
} will be used rather than detecting
144 the format
. Can be used to specifiy format
=raw to avoid interpreting
145 an untrusted format header
.
146 @item serial
=@
var{serial
}
147 This option specifies the serial number to assign to the device
.
148 @item addr
=@
var{addr
}
149 Specify the controller
's PCI address (if=virtio only).
152 By default, writethrough caching is used for all block device. This means that
153 the host page cache will be used to read and write data but write notification
154 will be sent to the guest only when the data has been reported as written by
155 the storage subsystem.
157 Writeback caching will report data writes as completed as soon as the data is
158 present in the host page cache. This is safe as long as you trust your host.
159 If your host crashes or loses power, then the guest may experience data
160 corruption. When using the @option{-snapshot} option, writeback caching is
163 The host page cache can be avoided entirely with @option{cache=none}. This will
164 attempt to do disk IO directly to the guests memory. QEMU may still perform
165 an internal copy of the data.
167 Some block drivers perform badly with @option{cache=writethrough}, most notably,
168 qcow2. If performance is more important than correctness,
169 @option{cache=writeback} should be used with qcow2.
171 Instead of @option{-cdrom} you can use:
173 qemu -drive file=file,index=2,media=cdrom
176 Instead of @option{-hda}, @option{-hdb}, @option{-hdc}, @option{-hdd}, you can
179 qemu -drive file=file,index=0,media=disk
180 qemu -drive file=file,index=1,media=disk
181 qemu -drive file=file,index=2,media=disk
182 qemu -drive file=file,index=3,media=disk
185 You can connect a CDROM to the slave of ide0:
187 qemu -drive file=file,if=ide,index=1,media=cdrom
190 If you don't specify the
"file=" argument
, you define an empty drive
:
192 qemu
-drive
if=ide
,index
=1,media
=cdrom
195 You can connect a SCSI disk with unit ID
6 on the bus #
0:
197 qemu
-drive file
=file
,if=scsi
,bus
=0,unit
=6
200 Instead of @option
{-fda
}, @option
{-fdb
}, you can use
:
202 qemu
-drive file
=file
,index
=0,if=floppy
203 qemu
-drive file
=file
,index
=1,if=floppy
206 By
default, @
var{interface} is
"ide" and @
var{index
} is automatically
209 qemu
-drive file
=a
-drive file
=b
"
217 DEF("mtdblock
", HAS_ARG, QEMU_OPTION_mtdblock,
218 "-mtdblock file use
'file' as on
-board Flash memory image
\n")
221 @item -mtdblock @var{file}
222 Use @var{file} as on-board Flash memory image.
225 DEF("sd
", HAS_ARG, QEMU_OPTION_sd,
226 "-sd file use
'file' as SecureDigital card image
\n")
229 Use @var{file} as SecureDigital card image.
232 DEF("pflash
", HAS_ARG, QEMU_OPTION_pflash,
233 "-pflash file use
'file' as a parallel flash image
\n")
235 @item -pflash @var{file}
236 Use @var{file} as a parallel flash image.
239 DEF("boot
", HAS_ARG, QEMU_OPTION_boot,
240 "-boot
[order
=drives
][,once
=drives
][,menu
=on|off
]\n"
241 " 'drives': floppy (a
), hard
disk (c
), CD
-ROM (d
), network (n
)\n")
243 @item -boot [order=@var{drives}][,once=@var{drives}][,menu=on|off]
245 Specify boot order @var{drives} as a string of drive letters. Valid
246 drive letters depend on the target achitecture. The x86 PC uses: a, b
247 (floppy 1 and 2), c (first hard disk), d (first CD-ROM), n-p (Etherboot
248 from network adapter 1-4), hard disk boot is the default. To apply a
249 particular boot order only on the first startup, specify it via
252 Interactive boot menus/prompts can be enabled via @option{menu=on} as far
253 as firmware/BIOS supports them. The default is non-interactive boot.
256 # try to boot from network first, then from hard disk
258 # boot from CD-ROM first, switch back to default order after reboot
262 Note: The legacy format '-boot @var{drives}' is still supported but its
263 use is discouraged as it may be removed from future versions.
266 DEF("snapshot
", 0, QEMU_OPTION_snapshot,
267 "-snapshot write to temporary files instead of disk image files
\n")
270 Write to temporary files instead of disk image files. In this case,
271 the raw disk image you use is not written back. You can however force
272 the write back by pressing @key{C-a s} (@pxref{disk_images}).
275 DEF("m
", HAS_ARG, QEMU_OPTION_m,
276 "-m megs set virtual RAM size to megs MB
[default=%d
]\n")
279 Set virtual RAM size to @var{megs} megabytes. Default is 128 MiB. Optionally,
280 a suffix of ``M'' or ``G'' can be used to signify a value in megabytes or
281 gigabytes respectively.
284 DEF("k
", HAS_ARG, QEMU_OPTION_k,
285 "-k language use keyboard
layout (for example
'fr' for French
)\n")
287 @item -k @var{language}
289 Use keyboard layout @var{language} (for example @code{fr} for
290 French). This option is only needed where it is not easy to get raw PC
291 keycodes (e.g. on Macs, with some X11 servers or with a VNC
292 display). You don't normally need to use it on PC/Linux or PC/Windows
295 The available layouts are:
297 ar de-ch es fo fr-ca hu ja mk no pt-br sv
298 da en-gb et fr fr-ch is lt nl pl ru th
299 de en-us fi fr-be hr it lv nl-be pt sl tr
302 The default is @code{en-us}.
307 DEF("audio
-help
", 0, QEMU_OPTION_audio_help,
308 "-audio
-help print list of audio drivers and their options
\n")
313 Will show the audio subsystem help: list of drivers, tunable
318 DEF("soundhw
", HAS_ARG, QEMU_OPTION_soundhw,
319 "-soundhw c1
,... enable audio support
\n"
320 " and only specified sound
cards (comma separated list
)\n"
321 " use
-soundhw ? to get the list of supported cards
\n"
322 " use
-soundhw all to enable all of them
\n")
325 @item -soundhw @var{card1}[,@var{card2},...] or -soundhw all
327 Enable audio and selected sound hardware. Use ? to print all
328 available sound hardware.
331 qemu -soundhw sb16,adlib disk.img
332 qemu -soundhw es1370 disk.img
333 qemu -soundhw ac97 disk.img
334 qemu -soundhw all disk.img
338 Note that Linux's i810_audio OSS kernel (for AC97) module might
339 require manually specifying clocking.
342 modprobe i810_audio clocking=48000
350 DEF("usb
", 0, QEMU_OPTION_usb,
351 "-usb enable the USB
driver (will be the
default soon
)\n")
357 Enable the USB driver (will be the default soon)
360 DEF("usbdevice
", HAS_ARG, QEMU_OPTION_usbdevice,
361 "-usbdevice name add the host or guest USB device
'name'\n")
364 @item -usbdevice @var{devname}
365 Add the USB device @var{devname}. @xref{usb_devices}.
370 Virtual Mouse. This will override the PS/2 mouse emulation when activated.
373 Pointer device that uses absolute coordinates (like a touchscreen). This
374 means qemu is able to report the mouse position without having to grab the
375 mouse. Also overrides the PS/2 mouse emulation when activated.
377 @item disk:[format=@var{format}]:@var{file}
378 Mass storage device based on file. The optional @var{format} argument
379 will be used rather than detecting the format. Can be used to specifiy
380 @code{format=raw} to avoid interpreting an untrusted format header.
382 @item host:@var{bus}.@var{addr}
383 Pass through the host device identified by @var{bus}.@var{addr} (Linux only).
385 @item host:@var{vendor_id}:@var{product_id}
386 Pass through the host device identified by @var{vendor_id}:@var{product_id}
389 @item serial:[vendorid=@var{vendor_id}][,productid=@var{product_id}]:@var{dev}
390 Serial converter to host character device @var{dev}, see @code{-serial} for the
394 Braille device. This will use BrlAPI to display the braille output on a real
397 @item net:@var{options}
398 Network adapter that supports CDC ethernet and RNDIS protocols.
403 DEF("device
", HAS_ARG, QEMU_OPTION_device,
404 "-device driver
[,options
] add device
\n")
405 DEF("name
", HAS_ARG, QEMU_OPTION_name,
406 "-name string1
[,process
=string2
] set the name of the guest
\n"
407 " string1 sets the window title and string2 the process
name (on Linux
)\n")
409 @item -name @var{name}
410 Sets the @var{name} of the guest.
411 This name will be displayed in the SDL window caption.
412 The @var{name} will also be used for the VNC server.
413 Also optionally set the top visible process name in Linux.
416 DEF("uuid
", HAS_ARG, QEMU_OPTION_uuid,
417 "-uuid
%%08x
-%%04x
-%%04x
-%%04x
-%%012x
\n"
418 " specify machine UUID
\n")
420 @item -uuid @var{uuid}
430 DEFHEADING(Display options:)
436 DEF("nographic
", 0, QEMU_OPTION_nographic,
437 "-nographic disable graphical output and redirect serial I
/Os to console
\n")
441 Normally, QEMU uses SDL to display the VGA output. With this option,
442 you can totally disable graphical output so that QEMU is a simple
443 command line application. The emulated serial port is redirected on
444 the console. Therefore, you can still use QEMU to debug a Linux kernel
445 with a serial console.
449 DEF("curses
", 0, QEMU_OPTION_curses,
450 "-curses use a curses
/ncurses
interface instead of SDL
\n")
455 Normally, QEMU uses SDL to display the VGA output. With this option,
456 QEMU can display the VGA output when in text mode using a
457 curses/ncurses interface. Nothing is displayed in graphical mode.
461 DEF("no
-frame
", 0, QEMU_OPTION_no_frame,
462 "-no
-frame open SDL window without a frame and window decorations
\n")
467 Do not use decorations for SDL windows and start them using the whole
468 available screen space. This makes the using QEMU in a dedicated desktop
469 workspace more convenient.
473 DEF("alt
-grab
", 0, QEMU_OPTION_alt_grab,
474 "-alt
-grab use Ctrl
-Alt
-Shift to grab
mouse (instead of Ctrl
-Alt
)\n")
479 Use Ctrl-Alt-Shift to grab mouse (instead of Ctrl-Alt).
483 DEF("ctrl
-grab
", 0, QEMU_OPTION_ctrl_grab,
484 "-ctrl
-grab use Right
-Ctrl to grab
mouse (instead of Ctrl
-Alt
)\n")
489 Use Right-Ctrl to grab mouse (instead of Ctrl-Alt).
493 DEF("no
-quit
", 0, QEMU_OPTION_no_quit,
494 "-no
-quit disable SDL window close capability
\n")
499 Disable SDL window close capability.
503 DEF("sdl
", 0, QEMU_OPTION_sdl,
512 DEF("portrait
", 0, QEMU_OPTION_portrait,
513 "-portrait rotate graphical output
90 deg
left (only PXA LCD
)\n")
517 Rotate graphical output 90 deg left (only PXA LCD).
520 DEF("vga
", HAS_ARG, QEMU_OPTION_vga,
521 "-vga
[std|cirrus|vmware|xenfb|none
]\n"
522 " select video card type
\n")
524 @item -vga @var{type}
525 Select type of VGA card to emulate. Valid values for @var{type} are
528 Cirrus Logic GD5446 Video card. All Windows versions starting from
529 Windows 95 should recognize and use this graphic card. For optimal
530 performances, use 16 bit color depth in the guest and the host OS.
531 (This one is the default)
533 Standard VGA card with Bochs VBE extensions. If your guest OS
534 supports the VESA 2.0 VBE extensions (e.g. Windows XP) and if you want
535 to use high resolution modes (>= 1280x1024x16) then you should use
538 VMWare SVGA-II compatible adapter. Use it if you have sufficiently
539 recent XFree86/XOrg server or Windows guest with a driver for this
546 DEF("full
-screen
", 0, QEMU_OPTION_full_screen,
547 "-full
-screen start
in full screen
\n")
550 Start in full screen.
553 #if defined(TARGET_PPC) || defined(TARGET_SPARC)
554 DEF("g
", 1, QEMU_OPTION_g ,
555 "-g WxH
[xDEPTH
] Set the initial graphical resolution and depth
\n")
560 DEF("vnc
", HAS_ARG, QEMU_OPTION_vnc ,
561 "-vnc display start a VNC server on display
\n")
563 @item -vnc @var{display}[,@var{option}[,@var{option}[,...]]]
565 Normally, QEMU uses SDL to display the VGA output. With this option,
566 you can have QEMU listen on VNC display @var{display} and redirect the VGA
567 display over the VNC session. It is very useful to enable the usb
568 tablet device when using this option (option @option{-usbdevice
569 tablet}). When using the VNC display, you must use the @option{-k}
570 parameter to set the keyboard layout if you are not using en-us. Valid
571 syntax for the @var{display} is
575 @item @var{host}:@var{d}
577 TCP connections will only be allowed from @var{host} on display @var{d}.
578 By convention the TCP port is 5900+@var{d}. Optionally, @var{host} can
579 be omitted in which case the server will accept connections from any host.
581 @item unix:@var{path}
583 Connections will be allowed over UNIX domain sockets where @var{path} is the
584 location of a unix socket to listen for connections on.
588 VNC is initialized but not started. The monitor @code{change} command
589 can be used to later start the VNC server.
593 Following the @var{display} value there may be one or more @var{option} flags
594 separated by commas. Valid options are
600 Connect to a listening VNC client via a ``reverse'' connection. The
601 client is specified by the @var{display}. For reverse network
602 connections (@var{host}:@var{d},@code{reverse}), the @var{d} argument
603 is a TCP port number, not a display number.
607 Require that password based authentication is used for client connections.
608 The password must be set separately using the @code{change} command in the
613 Require that client use TLS when communicating with the VNC server. This
614 uses anonymous TLS credentials so is susceptible to a man-in-the-middle
615 attack. It is recommended that this option be combined with either the
616 @option{x509} or @option{x509verify} options.
618 @item x509=@var{/path/to/certificate/dir}
620 Valid if @option{tls} is specified. Require that x509 credentials are used
621 for negotiating the TLS session. The server will send its x509 certificate
622 to the client. It is recommended that a password be set on the VNC server
623 to provide authentication of the client when this is used. The path following
624 this option specifies where the x509 certificates are to be loaded from.
625 See the @ref{vnc_security} section for details on generating certificates.
627 @item x509verify=@var{/path/to/certificate/dir}
629 Valid if @option{tls} is specified. Require that x509 credentials are used
630 for negotiating the TLS session. The server will send its x509 certificate
631 to the client, and request that the client send its own x509 certificate.
632 The server will validate the client's certificate against the CA certificate,
633 and reject clients when validation fails. If the certificate authority is
634 trusted, this is a sufficient authentication mechanism. You may still wish
635 to set a password on the VNC server as a second authentication layer. The
636 path following this option specifies where the x509 certificates are to
637 be loaded from. See the @ref{vnc_security} section for details on generating
642 Require that the client use SASL to authenticate with the VNC server.
643 The exact choice of authentication method used is controlled from the
644 system / user's SASL configuration file for the 'qemu' service. This
645 is typically found in /etc/sasl2/qemu.conf. If running QEMU as an
646 unprivileged user, an environment variable SASL_CONF_PATH can be used
647 to make it search alternate locations for the service config.
648 While some SASL auth methods can also provide data encryption (eg GSSAPI),
649 it is recommended that SASL always be combined with the 'tls' and
650 'x509' settings to enable use of SSL and server certificates. This
651 ensures a data encryption preventing compromise of authentication
652 credentials. See the @ref{vnc_security} section for details on using
657 Turn on access control lists for checking of the x509 client certificate
658 and SASL party. For x509 certs, the ACL check is made against the
659 certificate's distinguished name. This is something that looks like
660 @code{C=GB,O=ACME,L=Boston,CN=bob}. For SASL party, the ACL check is
661 made against the username, which depending on the SASL plugin, may
662 include a realm component, eg @code{bob} or @code{bob@@EXAMPLE.COM}.
663 When the @option{acl} flag is set, the initial access list will be
664 empty, with a @code{deny} policy. Thus no one will be allowed to
665 use the VNC server until the ACLs have been loaded. This can be
666 achieved using the @code{acl} monitor command.
678 DEFHEADING(i386 target only:)
685 DEF("win2k
-hack
", 0, QEMU_OPTION_win2k_hack,
686 "-win2k
-hack use it when installing Windows
2000 to avoid a disk full bug
\n")
690 Use it when installing Windows 2000 to avoid a disk full bug. After
691 Windows 2000 is installed, you no longer need this option (this option
692 slows down the IDE transfers).
696 HXCOMM Deprecated by -rtc
697 DEF("rtc
-td
-hack
", 0, QEMU_OPTION_rtc_td_hack, "")
701 DEF("no
-fd
-bootchk
", 0, QEMU_OPTION_no_fd_bootchk,
702 "-no
-fd
-bootchk disable boot signature checking
for floppy disks
\n")
706 Disable boot signature checking for floppy disks in Bochs BIOS. It may
707 be needed to boot from old floppy disks.
711 DEF("no
-acpi
", 0, QEMU_OPTION_no_acpi,
712 "-no
-acpi disable ACPI
\n")
716 Disable ACPI (Advanced Configuration and Power Interface) support. Use
717 it if your guest OS complains about ACPI problems (PC target machine
722 DEF("no
-hpet
", 0, QEMU_OPTION_no_hpet,
723 "-no
-hpet disable HPET
\n")
727 Disable HPET support.
731 DEF("balloon
", HAS_ARG, QEMU_OPTION_balloon,
732 "-balloon none disable balloon device
\n"
733 "-balloon virtio
[,addr
=str
]\n"
734 " enable virtio balloon
device (default)\n")
738 Disable balloon device.
739 @item -balloon virtio[,addr=@var{addr}]
740 Enable virtio balloon device (default), optionally with PCI address
745 DEF("acpitable
", HAS_ARG, QEMU_OPTION_acpitable,
746 "-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"
747 " ACPI table description
\n")
750 @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}]...]
751 Add ACPI table with specified header fields and context from specified files.
755 DEF("smbios
", HAS_ARG, QEMU_OPTION_smbios,
756 "-smbios file
=binary
\n"
757 " Load SMBIOS entry from binary file
\n"
758 "-smbios type
=0[,vendor
=str
][,version
=str
][,date
=str
][,release
=%%d
.%%d
]\n"
759 " Specify SMBIOS type
0 fields
\n"
760 "-smbios type
=1[,manufacturer
=str
][,product
=str
][,version
=str
][,serial
=str
]\n"
761 " [,uuid
=uuid
][,sku
=str
][,family
=str
]\n"
762 " Specify SMBIOS type
1 fields
\n")
765 @item -smbios file=@var{binary}
766 Load SMBIOS entry from binary file.
768 @item -smbios type=0[,vendor=@var{str}][,version=@var{str}][,date=@var{str}][,release=@var{%d.%d}]
769 Specify SMBIOS type 0 fields
771 @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}]
772 Specify SMBIOS type 1 fields
782 DEFHEADING(Network options:)
787 HXCOMM Legacy slirp options (now moved to -net user):
789 DEF("tftp
", HAS_ARG, QEMU_OPTION_tftp, "")
790 DEF("bootp
", HAS_ARG, QEMU_OPTION_bootp, "")
791 DEF("redir
", HAS_ARG, QEMU_OPTION_redir, "")
793 DEF("smb
", HAS_ARG, QEMU_OPTION_smb, "")
797 DEF("net
", HAS_ARG, QEMU_OPTION_net,
798 "-net nic
[,vlan
=n
][,macaddr
=mac
][,model
=type
][,name
=str
][,addr
=str
][,vectors
=v
]\n"
799 " create a
new Network Interface Card and connect it to VLAN
'n'\n"
801 "-net user
[,vlan
=n
][,name
=str
][,net
=addr
[/mask
]][,host
=addr
][,restrict
=y|n
]\n"
802 " [,hostname
=host
][,dhcpstart
=addr
][,dns
=addr
][,tftp
=dir
][,bootfile
=f
]\n"
803 " [,hostfwd
=rule
][,guestfwd
=rule
]"
805 "[,smb
=dir
[,smbserver
=addr
]]\n"
807 " connect the user mode network stack to VLAN
'n', configure its
\n"
808 " DHCP server and enabled optional services
\n"
811 "-net tap
[,vlan
=n
][,name
=str
],ifname
=name
\n"
812 " connect the host TAP network
interface to VLAN
'n'\n"
814 "-net tap
[,vlan
=n
][,name
=str
][,fd
=h
][,ifname
=name
][,script
=file
][,downscript
=dfile
][,sndbuf
=nbytes
][,vnet_hdr
=on|off
]\n"
815 " connect the host TAP network
interface to VLAN
'n' and use the
\n"
816 " network scripts
'file' (default=%s
)\n"
817 " and
'dfile' (default=%s
);\n"
818 " use
'[down]script=no' to disable script execution
;\n"
819 " use
'fd=h' to connect to an already opened TAP
interface\n"
820 " use
'sndbuf=nbytes' to limit the size of the send buffer
; the
\n"
821 " default of
'sndbuf=1048576' can be disabled
using 'sndbuf=0'\n"
822 " use vnet_hdr
=off to avoid enabling the IFF_VNET_HDR tap flag
; use
\n"
823 " vnet_hdr
=on to make the lack of IFF_VNET_HDR support an error condition
\n"
825 "-net socket
[,vlan
=n
][,name
=str
][,fd
=h
][,listen
=[host
]:port
][,connect
=host
:port
]\n"
826 " connect the vlan
'n' to another VLAN
using a socket connection
\n"
827 "-net socket
[,vlan
=n
][,name
=str
][,fd
=h
][,mcast
=maddr
:port
]\n"
828 " connect the vlan
'n' to multicast maddr and port
\n"
830 "-net vde
[,vlan
=n
][,name
=str
][,sock
=socketpath
][,port
=n
][,group
=groupname
][,mode
=octalmode
]\n"
831 " connect the vlan
'n' to port
'n' of a vde
switch running
\n"
832 " on host and listening
for incoming connections on
'socketpath'.\n"
833 " Use group
'groupname' and mode
'octalmode' to change
default\n"
834 " ownership and permissions
for communication port
.\n"
836 "-net dump
[,vlan
=n
][,file
=f
][,len
=n
]\n"
837 " dump traffic on vlan
'n' to file
'f' (max n bytes per packet
)\n"
838 "-net none use it alone to have zero network devices
; if no
-net option
\n"
839 " is provided
, the
default is
'-net nic -net user'\n")
840 DEF("netdev
", HAS_ARG, QEMU_OPTION_netdev,
849 "socket
],id
=str
[,option
][,option
][,...]\n")
851 @item -net nic[,vlan=@var{n}][,macaddr=@var{mac}][,model=@var{type}][,name=@var{name}][,addr=@var{addr}][,vectors=@var{v}]
852 Create a new Network Interface Card and connect it to VLAN @var{n} (@var{n}
853 = 0 is the default). The NIC is an e1000 by default on the PC
854 target. Optionally, the MAC address can be changed to @var{mac}, the
855 device address set to @var{addr} (PCI cards only),
856 and a @var{name} can be assigned for use in monitor commands.
857 Optionally, for PCI cards, you can specify the number @var{v} of MSI-X vectors
858 that the card should have; this option currently only affects virtio cards; set
859 @var{v} = 0 to disable MSI-X. If no @option{-net} option is specified, a single
860 NIC is created. Qemu can emulate several different models of network card.
861 Valid values for @var{type} are
862 @code{virtio}, @code{i82551}, @code{i82557b}, @code{i82559er},
863 @code{ne2k_pci}, @code{ne2k_isa}, @code{pcnet}, @code{rtl8139},
864 @code{e1000}, @code{smc91c111}, @code{lance} and @code{mcf_fec}.
865 Not all devices are supported on all targets. Use -net nic,model=?
866 for a list of available devices for your target.
868 @item -net user[,@var{option}][,@var{option}][,...]
869 Use the user mode network stack which requires no administrator
870 privilege to run. Valid options are:
874 Connect user mode stack to VLAN @var{n} (@var{n} = 0 is the default).
876 @item name=@var{name}
877 Assign symbolic name for use in monitor commands.
879 @item net=@var{addr}[/@var{mask}]
880 Set IP network address the guest will see. Optionally specify the netmask,
881 either in the form a.b.c.d or as number of valid top-most bits. Default is
884 @item host=@var{addr}
885 Specify the guest-visible address of the host. Default is the 2nd IP in the
886 guest network, i.e. x.x.x.2.
888 @item restrict=y|yes|n|no
889 If this options is enabled, the guest will be isolated, i.e. it will not be
890 able to contact the host and no guest IP packets will be routed over the host
891 to the outside. This option does not affect explicitly set forwarding rule.
893 @item hostname=@var{name}
894 Specifies the client hostname reported by the builtin DHCP server.
896 @item dhcpstart=@var{addr}
897 Specify the first of the 16 IPs the built-in DHCP server can assign. Default
898 is the 16th to 31st IP in the guest network, i.e. x.x.x.16 to x.x.x.31.
901 Specify the guest-visible address of the virtual nameserver. The address must
902 be different from the host address. Default is the 3rd IP in the guest network,
906 When using the user mode network stack, activate a built-in TFTP
907 server. The files in @var{dir} will be exposed as the root of a TFTP server.
908 The TFTP client on the guest must be configured in binary mode (use the command
909 @code{bin} of the Unix TFTP client).
911 @item bootfile=@var{file}
912 When using the user mode network stack, broadcast @var{file} as the BOOTP
913 filename. In conjunction with @option{tftp}, this can be used to network boot
914 a guest from a local directory.
916 Example (using pxelinux):
918 qemu -hda linux.img -boot n -net user,tftp=/path/to/tftp/files,bootfile=/pxelinux.0
921 @item smb=@var{dir}[,smbserver=@var{addr}]
922 When using the user mode network stack, activate a built-in SMB
923 server so that Windows OSes can access to the host files in @file{@var{dir}}
924 transparently. The IP address of the SMB server can be set to @var{addr}. By
925 default the 4th IP in the guest network is used, i.e. x.x.x.4.
927 In the guest Windows OS, the line:
931 must be added in the file @file{C:\WINDOWS\LMHOSTS} (for windows 9x/Me)
932 or @file{C:\WINNT\SYSTEM32\DRIVERS\ETC\LMHOSTS} (Windows NT/2000).
934 Then @file{@var{dir}} can be accessed in @file{\\smbserver\qemu}.
936 Note that a SAMBA server must be installed on the host OS in
937 @file{/usr/sbin/smbd}. QEMU was tested successfully with smbd versions from
938 Red Hat 9, Fedora Core 3 and OpenSUSE 11.x.
940 @item hostfwd=[tcp|udp]:[@var{hostaddr}]:@var{hostport}-[@var{guestaddr}]:@var{guestport}
941 Redirect incoming TCP or UDP connections to the host port @var{hostport} to
942 the guest IP address @var{guestaddr} on guest port @var{guestport}. If
943 @var{guestaddr} is not specified, its value is x.x.x.15 (default first address
944 given by the built-in DHCP server). By specifying @var{hostaddr}, the rule can
945 be bound to a specific host interface. If no connection type is set, TCP is
946 used. This option can be given multiple times.
948 For example, to redirect host X11 connection from screen 1 to guest
949 screen 0, use the following:
953 qemu -net user,hostfwd=tcp:127.0.0.1:6001-:6000 [...]
954 # this host xterm should open in the guest X11 server
958 To redirect telnet connections from host port 5555 to telnet port on
959 the guest, use the following:
963 qemu -net user,hostfwd=tcp:5555::23 [...]
964 telnet localhost 5555
967 Then when you use on the host @code{telnet localhost 5555}, you
968 connect to the guest telnet server.
970 @item guestfwd=[tcp]:@var{server}:@var{port}-@var{dev}
971 Forward guest TCP connections to the IP address @var{server} on port @var{port}
972 to the character device @var{dev}. This option can be given multiple times.
976 Note: Legacy stand-alone options -tftp, -bootp, -smb and -redir are still
977 processed and applied to -net user. Mixing them with the new configuration
978 syntax gives undefined results. Their use for new applications is discouraged
979 as they will be removed from future versions.
981 @item -net tap[,vlan=@var{n}][,name=@var{name}][,fd=@var{h}][,ifname=@var{name}][,script=@var{file}][,downscript=@var{dfile}]
982 Connect the host TAP network interface @var{name} to VLAN @var{n}, use
983 the network script @var{file} to configure it and the network script
984 @var{dfile} to deconfigure it. If @var{name} is not provided, the OS
985 automatically provides one. @option{fd}=@var{h} can be used to specify
986 the handle of an already opened host TAP interface. The default network
987 configure script is @file{/etc/qemu-ifup} and the default network
988 deconfigure script is @file{/etc/qemu-ifdown}. Use @option{script=no}
989 or @option{downscript=no} to disable script execution. Example:
992 qemu linux.img -net nic -net tap
995 More complicated example (two NICs, each one connected to a TAP device)
997 qemu linux.img -net nic,vlan=0 -net tap,vlan=0,ifname=tap0 \
998 -net nic,vlan=1 -net tap,vlan=1,ifname=tap1
1001 @item -net socket[,vlan=@var{n}][,name=@var{name}][,fd=@var{h}][,listen=[@var{host}]:@var{port}][,connect=@var{host}:@var{port}]
1003 Connect the VLAN @var{n} to a remote VLAN in another QEMU virtual
1004 machine using a TCP socket connection. If @option{listen} is
1005 specified, QEMU waits for incoming connections on @var{port}
1006 (@var{host} is optional). @option{connect} is used to connect to
1007 another QEMU instance using the @option{listen} option. @option{fd}=@var{h}
1008 specifies an already opened TCP socket.
1012 # launch a first QEMU instance
1013 qemu linux.img -net nic,macaddr=52:54:00:12:34:56 \
1014 -net socket,listen=:1234
1015 # connect the VLAN 0 of this instance to the VLAN 0
1016 # of the first instance
1017 qemu linux.img -net nic,macaddr=52:54:00:12:34:57 \
1018 -net socket,connect=127.0.0.1:1234
1021 @item -net socket[,vlan=@var{n}][,name=@var{name}][,fd=@var{h}][,mcast=@var{maddr}:@var{port}]
1023 Create a VLAN @var{n} shared with another QEMU virtual
1024 machines using a UDP multicast socket, effectively making a bus for
1025 every QEMU with same multicast address @var{maddr} and @var{port}.
1029 Several QEMU can be running on different hosts and share same bus (assuming
1030 correct multicast setup for these hosts).
1032 mcast support is compatible with User Mode Linux (argument @option{eth@var{N}=mcast}), see
1033 @url{http://user-mode-linux.sf.net}.
1035 Use @option{fd=h} to specify an already opened UDP multicast socket.
1040 # launch one QEMU instance
1041 qemu linux.img -net nic,macaddr=52:54:00:12:34:56 \
1042 -net socket,mcast=230.0.0.1:1234
1043 # launch another QEMU instance on same "bus
"
1044 qemu linux.img -net nic,macaddr=52:54:00:12:34:57 \
1045 -net socket,mcast=230.0.0.1:1234
1046 # launch yet another QEMU instance on same "bus
"
1047 qemu linux.img -net nic,macaddr=52:54:00:12:34:58 \
1048 -net socket,mcast=230.0.0.1:1234
1051 Example (User Mode Linux compat.):
1053 # launch QEMU instance (note mcast address selected
1055 qemu linux.img -net nic,macaddr=52:54:00:12:34:56 \
1056 -net socket,mcast=239.192.168.1:1102
1058 /path/to/linux ubd0=/path/to/root_fs eth0=mcast
1061 @item -net vde[,vlan=@var{n}][,name=@var{name}][,sock=@var{socketpath}][,port=@var{n}][,group=@var{groupname}][,mode=@var{octalmode}]
1062 Connect VLAN @var{n} to PORT @var{n} of a vde switch running on host and
1063 listening for incoming connections on @var{socketpath}. Use GROUP @var{groupname}
1064 and MODE @var{octalmode} to change default ownership and permissions for
1065 communication port. This option is available only if QEMU has been compiled
1066 with vde support enabled.
1071 vde_switch -F -sock /tmp/myswitch
1072 # launch QEMU instance
1073 qemu linux.img -net nic -net vde,sock=/tmp/myswitch
1076 @item -net dump[,vlan=@var{n}][,file=@var{file}][,len=@var{len}]
1077 Dump network traffic on VLAN @var{n} to file @var{file} (@file{qemu-vlan0.pcap} by default).
1078 At most @var{len} bytes (64k by default) per packet are stored. The file format is
1079 libpcap, so it can be analyzed with tools such as tcpdump or Wireshark.
1082 Indicate that no network devices should be configured. It is used to
1083 override the default configuration (@option{-net nic -net user}) which
1084 is activated if no @option{-net} options are provided.
1089 DEF("bt
", HAS_ARG, QEMU_OPTION_bt, \
1091 "-bt hci
,null dumb bluetooth HCI
- doesn
't respond to commands\n" \
1092 "-bt hci,host[:id]\n" \
1093 " use host's HCI with the given name
\n" \
1094 "-bt hci
[,vlan
=n
]\n" \
1095 " emulate a standard HCI
in virtual scatternet
'n'\n" \
1096 "-bt vhci
[,vlan
=n
]\n" \
1097 " add host computer to virtual scatternet
'n' using VHCI
\n" \
1098 "-bt device
:dev
[,vlan
=n
]\n" \
1099 " emulate a bluetooth device
'dev' in scatternet
'n'\n")
1101 Bluetooth(R) options:
1105 Defines the function of the corresponding Bluetooth HCI. -bt options
1106 are matched with the HCIs present in the chosen machine type. For
1107 example when emulating a machine with only one HCI built into it, only
1108 the first @code{-bt hci[...]} option is valid and defines the HCI's
1109 logic. The Transport Layer is decided by the machine type. Currently
1110 the machines @code{n800} and @code{n810} have one HCI and all other
1114 The following three types are recognized:
1118 (default) The corresponding Bluetooth HCI assumes no internal logic
1119 and will not respond to any HCI commands or emit events.
1121 @item -bt hci,host[:@var{id}]
1122 (@code{bluez} only) The corresponding HCI passes commands / events
1123 to / from the physical HCI identified by the name @var{id} (default:
1124 @code{hci0}) on the computer running QEMU. Only available on @code{bluez}
1125 capable systems like Linux.
1127 @item -bt hci[,vlan=@var{n}]
1128 Add a virtual, standard HCI that will participate in the Bluetooth
1129 scatternet @var{n} (default @code{0}). Similarly to @option{-net}
1130 VLANs, devices inside a bluetooth network @var{n} can only communicate
1131 with other devices in the same network (scatternet).
1134 @item -bt vhci[,vlan=@var{n}]
1135 (Linux-host only) Create a HCI in scatternet @var{n} (default 0) attached
1136 to the host bluetooth stack instead of to the emulated target. This
1137 allows the host and target machines to participate in a common scatternet
1138 and communicate. Requires the Linux @code{vhci} driver installed. Can
1139 be used as following:
1142 qemu [...OPTIONS...] -bt hci,vlan=5 -bt vhci,vlan=5
1145 @item -bt device:@var{dev}[,vlan=@var{n}]
1146 Emulate a bluetooth device @var{dev} and place it in network @var{n}
1147 (default @code{0}). QEMU can only emulate one type of bluetooth devices
1152 Virtual wireless keyboard implementing the HIDP bluetooth profile.
1159 DEFHEADING(Linux/Multiboot boot specific:)
1162 When using these options, you can use a given Linux or Multiboot
1163 kernel without installing it in the disk image. It can be useful
1164 for easier testing of various kernels.
1169 DEF("kernel
", HAS_ARG, QEMU_OPTION_kernel, \
1170 "-kernel bzImage use
'bzImage' as kernel image
\n")
1172 @item -kernel @var{bzImage}
1173 Use @var{bzImage} as kernel image. The kernel can be either a Linux kernel
1174 or in multiboot format.
1177 DEF("append
", HAS_ARG, QEMU_OPTION_append, \
1178 "-append cmdline use
'cmdline' as kernel command line
\n")
1180 @item -append @var{cmdline}
1181 Use @var{cmdline} as kernel command line
1184 DEF("initrd
", HAS_ARG, QEMU_OPTION_initrd, \
1185 "-initrd file use
'file' as initial ram disk
\n")
1187 @item -initrd @var{file}
1188 Use @var{file} as initial ram disk.
1190 @item -initrd "@
var{file1
} arg
=foo
,@
var{file2
}"
1192 This syntax is only available with multiboot.
1194 Use @var{file1} and @var{file2} as modules and pass arg=foo as parameter to the
1204 DEFHEADING(Debug/Expert options:)
1210 DEF("chardev
", HAS_ARG, QEMU_OPTION_chardev, \
1211 "-chardev spec create unconnected chardev
\n")
1212 DEF("serial
", HAS_ARG, QEMU_OPTION_serial, \
1213 "-serial dev redirect the serial port to char device
'dev'\n")
1215 @item -serial @var{dev}
1216 Redirect the virtual serial port to host character device
1217 @var{dev}. The default device is @code{vc} in graphical mode and
1218 @code{stdio} in non graphical mode.
1220 This option can be used several times to simulate up to 4 serial
1223 Use @code{-serial none} to disable all serial ports.
1225 Available character devices are:
1227 @item vc[:@var{W}x@var{H}]
1228 Virtual console. Optionally, a width and height can be given in pixel with
1232 It is also possible to specify width or height in characters:
1237 [Linux only] Pseudo TTY (a new PTY is automatically allocated)
1239 No device is allocated.
1243 [Linux only] Use host tty, e.g. @file{/dev/ttyS0}. The host serial port
1244 parameters are set according to the emulated ones.
1245 @item /dev/parport@var{N}
1246 [Linux only, parallel port only] Use host parallel port
1247 @var{N}. Currently SPP and EPP parallel port features can be used.
1248 @item file:@var{filename}
1249 Write output to @var{filename}. No character can be read.
1251 [Unix only] standard input/output
1252 @item pipe:@var{filename}
1253 name pipe @var{filename}
1255 [Windows only] Use host serial port @var{n}
1256 @item udp:[@var{remote_host}]:@var{remote_port}[@@[@var{src_ip}]:@var{src_port}]
1257 This implements UDP Net Console.
1258 When @var{remote_host} or @var{src_ip} are not specified
1259 they default to @code{0.0.0.0}.
1260 When not using a specified @var{src_port} a random port is automatically chosen.
1262 If you just want a simple readonly console you can use @code{netcat} or
1263 @code{nc}, by starting qemu with: @code{-serial udp::4555} and nc as:
1264 @code{nc -u -l -p 4555}. Any time qemu writes something to that port it
1265 will appear in the netconsole session.
1267 If you plan to send characters back via netconsole or you want to stop
1268 and start qemu a lot of times, you should have qemu use the same
1269 source port each time by using something like @code{-serial
1270 udp::4555@@:4556} to qemu. Another approach is to use a patched
1271 version of netcat which can listen to a TCP port and send and receive
1272 characters via udp. If you have a patched version of netcat which
1273 activates telnet remote echo and single char transfer, then you can
1274 use the following options to step up a netcat redirector to allow
1275 telnet on port 5555 to access the qemu port.
1278 -serial udp::4555@@:4556
1279 @item netcat options:
1280 -u -P 4555 -L 0.0.0.0:4556 -t -p 5555 -I -T
1281 @item telnet options:
1285 @item tcp:[@var{host}]:@var{port}[,@var{server}][,nowait][,nodelay]
1286 The TCP Net Console has two modes of operation. It can send the serial
1287 I/O to a location or wait for a connection from a location. By default
1288 the TCP Net Console is sent to @var{host} at the @var{port}. If you use
1289 the @var{server} option QEMU will wait for a client socket application
1290 to connect to the port before continuing, unless the @code{nowait}
1291 option was specified. The @code{nodelay} option disables the Nagle buffering
1292 algorithm. If @var{host} is omitted, 0.0.0.0 is assumed. Only
1293 one TCP connection at a time is accepted. You can use @code{telnet} to
1294 connect to the corresponding character device.
1296 @item Example to send tcp console to 192.168.0.2 port 4444
1297 -serial tcp:192.168.0.2:4444
1298 @item Example to listen and wait on port 4444 for connection
1299 -serial tcp::4444,server
1300 @item Example to not wait and listen on ip 192.168.0.100 port 4444
1301 -serial tcp:192.168.0.100:4444,server,nowait
1304 @item telnet:@var{host}:@var{port}[,server][,nowait][,nodelay]
1305 The telnet protocol is used instead of raw tcp sockets. The options
1306 work the same as if you had specified @code{-serial tcp}. The
1307 difference is that the port acts like a telnet server or client using
1308 telnet option negotiation. This will also allow you to send the
1309 MAGIC_SYSRQ sequence if you use a telnet that supports sending the break
1310 sequence. Typically in unix telnet you do it with Control-] and then
1311 type "send
break" followed by pressing the enter key.
1313 @item unix:@var{path}[,server][,nowait]
1314 A unix domain socket is used instead of a tcp socket. The option works the
1315 same as if you had specified @code{-serial tcp} except the unix domain socket
1316 @var{path} is used for connections.
1318 @item mon:@var{dev_string}
1319 This is a special option to allow the monitor to be multiplexed onto
1320 another serial port. The monitor is accessed with key sequence of
1321 @key{Control-a} and then pressing @key{c}. See monitor access
1322 @ref{pcsys_keys} in the -nographic section for more keys.
1323 @var{dev_string} should be any one of the serial devices specified
1324 above. An example to multiplex the monitor onto a telnet server
1325 listening on port 4444 would be:
1327 @item -serial mon:telnet::4444,server,nowait
1331 Braille device. This will use BrlAPI to display the braille output on a real
1335 Three button serial mouse. Configure the guest to use Microsoft protocol.
1339 DEF("parallel
", HAS_ARG, QEMU_OPTION_parallel, \
1340 "-parallel dev redirect the parallel port to char device
'dev'\n")
1342 @item -parallel @var{dev}
1343 Redirect the virtual parallel port to host device @var{dev} (same
1344 devices as the serial port). On Linux hosts, @file{/dev/parportN} can
1345 be used to use hardware devices connected on the corresponding host
1348 This option can be used several times to simulate up to 3 parallel
1351 Use @code{-parallel none} to disable all parallel ports.
1354 DEF("monitor
", HAS_ARG, QEMU_OPTION_monitor, \
1355 "-monitor dev redirect the monitor to char device
'dev'\n")
1357 @item -monitor @var{dev}
1358 Redirect the monitor to host device @var{dev} (same devices as the
1360 The default device is @code{vc} in graphical mode and @code{stdio} in
1364 DEF("pidfile
", HAS_ARG, QEMU_OPTION_pidfile, \
1365 "-pidfile file write PID to
'file'\n")
1367 @item -pidfile @var{file}
1368 Store the QEMU process PID in @var{file}. It is useful if you launch QEMU
1372 DEF("singlestep
", 0, QEMU_OPTION_singlestep, \
1373 "-singlestep always run
in singlestep mode
\n")
1376 Run the emulation in single step mode.
1379 DEF("S
", 0, QEMU_OPTION_S, \
1380 "-S freeze CPU at
startup (use
'c' to start execution
)\n")
1383 Do not start CPU at startup (you must type 'c' in the monitor).
1386 DEF("gdb
", HAS_ARG, QEMU_OPTION_gdb, \
1387 "-gdb dev wait
for gdb connection on
'dev'\n")
1389 @item -gdb @var{dev}
1390 Wait for gdb connection on device @var{dev} (@pxref{gdb_usage}). Typical
1391 connections will likely be TCP-based, but also UDP, pseudo TTY, or even
1392 stdio are reasonable use case. The latter is allowing to start qemu from
1393 within gdb and establish the connection via a pipe:
1395 (gdb) target remote | exec qemu -gdb stdio ...
1399 DEF("s
", 0, QEMU_OPTION_s, \
1400 "-s shorthand
for -gdb tcp
::%s
\n")
1403 Shorthand for -gdb tcp::1234, i.e. open a gdbserver on TCP port 1234
1404 (@pxref{gdb_usage}).
1407 DEF("d
", HAS_ARG, QEMU_OPTION_d, \
1408 "-d item1
,... output log to
%s (use
-d ?
for a list of log items
)\n")
1411 Output log in /tmp/qemu.log
1414 DEF("hdachs
", HAS_ARG, QEMU_OPTION_hdachs, \
1415 "-hdachs c
,h
,s
[,t
]\n" \
1416 " force hard disk
0 physical geometry and the optional BIOS
\n" \
1417 " translation (t
=none or lba
) (usually qemu can guess them
)\n")
1419 @item -hdachs @var{c},@var{h},@var{s},[,@var{t}]
1420 Force hard disk 0 physical geometry (1 <= @var{c} <= 16383, 1 <=
1421 @var{h} <= 16, 1 <= @var{s} <= 63) and optionally force the BIOS
1422 translation mode (@var{t}=none, lba or auto). Usually QEMU can guess
1423 all those parameters. This option is useful for old MS-DOS disk
1427 DEF("L
", HAS_ARG, QEMU_OPTION_L, \
1428 "-L path set the directory
for the BIOS
, VGA BIOS and keymaps
\n")
1431 Set the directory for the BIOS, VGA BIOS and keymaps.
1434 DEF("bios
", HAS_ARG, QEMU_OPTION_bios, \
1435 "-bios file set the filename
for the BIOS
\n")
1437 @item -bios @var{file}
1438 Set the filename for the BIOS.
1442 DEF("enable
-kvm
", 0, QEMU_OPTION_enable_kvm, \
1443 "-enable
-kvm enable KVM full virtualization support
\n")
1447 Enable KVM full virtualization support. This option is only available
1448 if KVM support is enabled when compiling.
1452 DEF("xen
-domid
", HAS_ARG, QEMU_OPTION_xen_domid,
1453 "-xen
-domid id specify xen guest domain id
\n")
1454 DEF("xen
-create
", 0, QEMU_OPTION_xen_create,
1455 "-xen
-create create domain
using xen hypercalls
, bypassing xend
\n"
1456 " warning
: should not be used when xend is
in use
\n")
1457 DEF("xen
-attach
", 0, QEMU_OPTION_xen_attach,
1458 "-xen
-attach attach to existing xen domain
\n"
1459 " xend will use
this when starting qemu
\n")
1462 DEF("no
-reboot
", 0, QEMU_OPTION_no_reboot, \
1463 "-no
-reboot exit instead of rebooting
\n")
1466 Exit instead of rebooting.
1469 DEF("no
-shutdown
", 0, QEMU_OPTION_no_shutdown, \
1470 "-no
-shutdown stop before shutdown
\n")
1473 Don't exit QEMU on guest shutdown, but instead only stop the emulation.
1474 This allows for instance switching to monitor to commit changes to the
1478 DEF("loadvm
", HAS_ARG, QEMU_OPTION_loadvm, \
1479 "-loadvm
[tag|id
]\n" \
1480 " start right away with a saved
state (loadvm
in monitor
)\n")
1482 @item -loadvm @var{file}
1483 Start right away with a saved state (@code{loadvm} in monitor)
1487 DEF("daemonize
", 0, QEMU_OPTION_daemonize, \
1488 "-daemonize daemonize QEMU after initializing
\n")
1492 Daemonize the QEMU process after initialization. QEMU will not detach from
1493 standard IO until it is ready to receive connections on any of its devices.
1494 This option is a useful way for external programs to launch QEMU without having
1495 to cope with initialization race conditions.
1498 DEF("option
-rom
", HAS_ARG, QEMU_OPTION_option_rom, \
1499 "-option
-rom rom load a file
, rom
, into the option ROM space
\n")
1501 @item -option-rom @var{file}
1502 Load the contents of @var{file} as an option ROM.
1503 This option is useful to load things like EtherBoot.
1506 DEF("clock
", HAS_ARG, QEMU_OPTION_clock, \
1507 "-clock force the use of the given methods
for timer alarm
.\n" \
1508 " To see what timers are available use
-clock ?
\n")
1510 @item -clock @var{method}
1511 Force the use of the given methods for timer alarm. To see what timers
1512 are available use -clock ?.
1515 HXCOMM Options deprecated by -rtc
1516 DEF("localtime
", 0, QEMU_OPTION_localtime, "")
1517 DEF("startdate
", HAS_ARG, QEMU_OPTION_startdate, "")
1520 DEF("rtc
", HAS_ARG, QEMU_OPTION_rtc, \
1521 "-rtc
[base
=utc|localtime|date
][,clock
=host|vm
][,driftfix
=none|slew
]\n" \
1522 " set the RTC base and clock
, enable drift fix
for clock ticks
\n")
1524 DEF("rtc
", HAS_ARG, QEMU_OPTION_rtc, \
1525 "-rtc
[base
=utc|localtime|date
][,clock
=host|vm
]\n" \
1526 " set the RTC base and clock
\n")
1531 @item -rtc [base=utc|localtime|@var{date}][,clock=host|vm][,driftfix=none|slew]
1532 Specify @option{base} as @code{utc} or @code{localtime} to let the RTC start at the current
1533 UTC or local time, respectively. @code{localtime} is required for correct date in
1534 MS-DOS or Windows. To start at a specific point in time, provide @var{date} in the
1535 format @code{2006-06-17T16:01:21} or @code{2006-06-17}. The default base is UTC.
1537 By default the RTC is driven by the host system time. This allows to use the
1538 RTC as accurate reference clock inside the guest, specifically if the host
1539 time is smoothly following an accurate external reference clock, e.g. via NTP.
1540 If you want to isolate the guest time from the host, even prevent it from
1541 progressing during suspension, you can set @option{clock} to @code{vm} instead.
1543 Enable @option{driftfix} (i386 targets only) if you experience time drift problems,
1544 specifically with Windows' ACPI HAL. This option will try to figure out how
1545 many timer interrupts were not processed by the Windows guest and will
1549 DEF("icount
", HAS_ARG, QEMU_OPTION_icount, \
1550 "-icount
[N|auto
]\n" \
1551 " enable virtual instruction counter with
2^N clock ticks per
\n" \
1554 @item -icount [@var{N}|auto]
1555 Enable virtual instruction counter. The virtual cpu will execute one
1556 instruction every 2^@var{N} ns of virtual time. If @code{auto} is specified
1557 then the virtual cpu speed will be automatically adjusted to keep virtual
1558 time within a few seconds of real time.
1560 Note that while this option can give deterministic behavior, it does not
1561 provide cycle accurate emulation. Modern CPUs contain superscalar out of
1562 order cores with complex cache hierarchies. The number of instructions
1563 executed often has little or no correlation with actual performance.
1566 DEF("watchdog
", HAS_ARG, QEMU_OPTION_watchdog, \
1567 "-watchdog i6300esb|ib700
\n" \
1568 " enable virtual hardware watchdog
[default=none
]\n")
1570 @item -watchdog @var{model}
1571 Create a virtual hardware watchdog device. Once enabled (by a guest
1572 action), the watchdog must be periodically polled by an agent inside
1573 the guest or else the guest will be restarted.
1575 The @var{model} is the model of hardware watchdog to emulate. Choices
1576 for model are: @code{ib700} (iBASE 700) which is a very simple ISA
1577 watchdog with a single timer, or @code{i6300esb} (Intel 6300ESB I/O
1578 controller hub) which is a much more featureful PCI-based dual-timer
1579 watchdog. Choose a model for which your guest has drivers.
1581 Use @code{-watchdog ?} to list available hardware models. Only one
1582 watchdog can be enabled for a guest.
1585 DEF("watchdog
-action
", HAS_ARG, QEMU_OPTION_watchdog_action, \
1586 "-watchdog
-action reset|shutdown|poweroff|pause|debug|none
\n" \
1587 " action when watchdog fires
[default=reset
]\n")
1589 @item -watchdog-action @var{action}
1591 The @var{action} controls what QEMU will do when the watchdog timer
1594 @code{reset} (forcefully reset the guest).
1595 Other possible actions are:
1596 @code{shutdown} (attempt to gracefully shutdown the guest),
1597 @code{poweroff} (forcefully poweroff the guest),
1598 @code{pause} (pause the guest),
1599 @code{debug} (print a debug message and continue), or
1600 @code{none} (do nothing).
1602 Note that the @code{shutdown} action requires that the guest responds
1603 to ACPI signals, which it may not be able to do in the sort of
1604 situations where the watchdog would have expired, and thus
1605 @code{-watchdog-action shutdown} is not recommended for production use.
1610 @item -watchdog i6300esb -watchdog-action pause
1611 @item -watchdog ib700
1615 DEF("echr
", HAS_ARG, QEMU_OPTION_echr, \
1616 "-echr chr set terminal escape character instead of ctrl
-a
\n")
1619 @item -echr @var{numeric_ascii_value}
1620 Change the escape character used for switching to the monitor when using
1621 monitor and serial sharing. The default is @code{0x01} when using the
1622 @code{-nographic} option. @code{0x01} is equal to pressing
1623 @code{Control-a}. You can select a different character from the ascii
1624 control keys where 1 through 26 map to Control-a through Control-z. For
1625 instance you could use the either of the following to change the escape
1626 character to Control-t.
1633 DEF("virtioconsole
", HAS_ARG, QEMU_OPTION_virtiocon, \
1634 "-virtioconsole c
\n" \
1635 " set virtio console
\n")
1637 @item -virtioconsole @var{c}
1641 DEF("show
-cursor
", 0, QEMU_OPTION_show_cursor, \
1642 "-show
-cursor show cursor
\n")
1646 DEF("tb
-size
", HAS_ARG, QEMU_OPTION_tb_size, \
1647 "-tb
-size n set TB size
\n")
1651 DEF("incoming
", HAS_ARG, QEMU_OPTION_incoming, \
1652 "-incoming p prepare
for incoming migration
, listen on port p
\n")
1657 DEF("chroot
", HAS_ARG, QEMU_OPTION_chroot, \
1658 "-chroot dir Chroot to dir just before starting the VM
.\n")
1661 @item -chroot @var{dir}
1662 Immediately before starting guest execution, chroot to the specified
1663 directory. Especially useful in combination with -runas.
1667 DEF("runas
", HAS_ARG, QEMU_OPTION_runas, \
1668 "-runas user Change to user id user just before starting the VM
.\n")
1671 @item -runas @var{user}
1672 Immediately before starting guest execution, drop root privileges, switching
1673 to the specified user.
1680 #if defined(TARGET_SPARC) || defined(TARGET_PPC)
1681 DEF("prom
-env
", HAS_ARG, QEMU_OPTION_prom_env,
1682 "-prom
-env variable
=value
\n"
1683 " set OpenBIOS nvram variables
\n")
1685 #if defined(TARGET_ARM) || defined(TARGET_M68K)
1686 DEF("semihosting
", 0, QEMU_OPTION_semihosting,
1687 "-semihosting semihosting mode
\n")
1689 #if defined(TARGET_ARM)
1690 DEF("old
-param
", 0, QEMU_OPTION_old_param,
1691 "-old
-param old param mode
\n")
1694 DEF("no
-kvm
", 0, QEMU_OPTION_no_kvm,
1695 "-no
-kvm disable KVM hardware virtualization
\n")
1696 DEF("no
-kvm
-irqchip
", 0, QEMU_OPTION_no_kvm_irqchip,
1697 "-no
-kvm
-irqchip disable KVM kernel mode PIC
/IOAPIC
/LAPIC
\n")
1698 DEF("no
-kvm
-pit
", 0, QEMU_OPTION_no_kvm_pit,
1699 "-no
-kvm
-pit disable KVM kernel mode PIT
\n")
1700 DEF("no
-kvm
-pit
-reinjection
", 0, QEMU_OPTION_no_kvm_pit_reinjection,
1701 "-no
-kvm
-pit
-reinjection disable KVM kernel mode PIT interrupt reinjection
\n")
1702 #if defined(TARGET_I386) || defined(TARGET_X86_64) || defined(TARGET_IA64) || defined(__linux__)
1703 DEF("pcidevice
", HAS_ARG, QEMU_OPTION_pcidevice,
1704 "-pcidevice host
=bus
:dev
.func
[,dma
=none
][,name
=string
]\n"
1705 " expose a PCI device to the guest OS
.\n"
1706 " dma
=none
: don
't perform any dma translations (default is to use an iommu)\n"
1707 " 'string
' is used in log output.\n")
1709 DEF("enable-nesting", 0, QEMU_OPTION_enable_nesting,
1710 "-enable-nesting enable support for running a VM inside the VM (AMD only)\n")
1711 DEF("nvram", HAS_ARG, QEMU_OPTION_nvram,
1712 "-nvram FILE provide ia64 nvram contents\n")
1713 DEF("tdf", 0, QEMU_OPTION_tdf,
1714 "-tdf enable guest time drift compensation\n")
1715 DEF("kvm-shadow-memory", HAS_ARG, QEMU_OPTION_kvm_shadow_memory,
1716 "-kvm-shadow-memory MEGABYTES\n"
1717 " allocate MEGABYTES for kvm mmu shadowing\n")
1718 DEF("mem-path", HAS_ARG, QEMU_OPTION_mempath,
1719 "-mem-path FILE provide backing storage for guest RAM\n")
1721 DEF("mem-prealloc", 0, QEMU_OPTION_mem_prealloc,
1722 "-mem-prealloc preallocate guest memory (use with -mempath)\n")