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 set the number of CPUs to 'n' [default=1]\n")
45 Simulate an SMP system with @
var{n
} CPUs
. On the PC target
, up to
255
46 CPUs are supported
. On Sparc32 target
, Linux limits the number of usable CPUs
50 DEF("numa", HAS_ARG
, QEMU_OPTION_numa
,
51 "-numa node[,mem=size][,cpus=cpu[-cpu]][,nodeid=node]\n")
53 @item
-numa @
var{opts
}
54 Simulate a multi node NUMA system
. If mem and cpus are omitted
, resources
58 DEF("fda", HAS_ARG
, QEMU_OPTION_fda
,
59 "-fda/-fdb file use 'file' as floppy disk 0/1 image\n")
60 DEF("fdb", HAS_ARG
, QEMU_OPTION_fdb
, "")
64 Use @
var{file
} as floppy disk
0/1 image (@pxref
{disk_images
}). You can
65 use the host floppy by
using @file
{/dev
/fd0
} as
filename (@pxref
{host_drives
}).
68 DEF("hda", HAS_ARG
, QEMU_OPTION_hda
,
69 "-hda/-hdb file use 'file' as IDE hard disk 0/1 image\n")
70 DEF("hdb", HAS_ARG
, QEMU_OPTION_hdb
, "")
71 DEF("hdc", HAS_ARG
, QEMU_OPTION_hdc
,
72 "-hdc/-hdd file use 'file' as IDE hard disk 2/3 image\n")
73 DEF("hdd", HAS_ARG
, QEMU_OPTION_hdd
, "")
79 Use @
var{file
} as hard disk
0, 1, 2 or
3 image (@pxref
{disk_images
}).
82 DEF("cdrom", HAS_ARG
, QEMU_OPTION_cdrom
,
83 "-cdrom file use 'file' as IDE cdrom image (cdrom is ide1 master)\n")
85 @item
-cdrom @
var{file
}
86 Use @
var{file
} as CD
-ROM
image (you cannot use @option
{-hdc
} and
87 @option
{-cdrom
} at the same time
). You can use the host CD
-ROM by
88 using @file
{/dev
/cdrom
} as
filename (@pxref
{host_drives
}).
91 DEF("drive", HAS_ARG
, QEMU_OPTION_drive
,
92 "-drive [file=file][,if=type][,bus=n][,unit=m][,media=d][,index=i]\n"
93 " [,cyls=c,heads=h,secs=s[,trans=t]][,snapshot=on|off]\n"
94 " [,cache=writethrough|writeback|none][,format=f][,serial=s]\n"
96 " use 'file' as a drive image\n")
98 @item
-drive @
var{option
}[,@
var{option
}[,@
var{option
}[,...]]]
100 Define a
new drive
. Valid options are
:
103 @item file
=@
var{file
}
104 This option defines which disk
image (@pxref
{disk_images
}) to use with
105 this drive
. If the filename contains comma
, you must double it
106 (for instance
, "file=my,,file" to use file
"my,file").
107 @item
if=@
var{interface}
108 This option defines on which type on
interface the drive is connected
.
109 Available types are
: ide
, scsi
, sd
, mtd
, floppy
, pflash
, virtio
.
110 @item bus
=@
var{bus
},unit
=@
var{unit
}
111 These options define where is connected the drive by defining the bus number and
113 @item index
=@
var{index
}
114 This option defines where is connected the drive by
using an index
in the list
115 of available connectors of a given
interface type
.
116 @item media
=@
var{media
}
117 This option defines the type of the media
: disk or cdrom
.
118 @item cyls
=@
var{c
},heads
=@
var{h
},secs
=@
var{s
}[,trans
=@
var{t
}]
119 These options have the same definition as they have
in @option
{-hdachs
}.
120 @item snapshot
=@
var{snapshot
}
121 @
var{snapshot
} is
"on" or
"off" and allows to enable snapshot
for given
drive (see @option
{-snapshot
}).
122 @item cache
=@
var{cache
}
123 @
var{cache
} is
"none", "writeback", or
"writethrough" and controls how the host cache is used to access block data
.
124 @item format
=@
var{format
}
125 Specify which disk @
var{format
} will be used rather than detecting
126 the format
. Can be used to specifiy format
=raw to avoid interpreting
127 an untrusted format header
.
128 @item serial
=@
var{serial
}
129 This option specifies the serial number to assign to the device
.
130 @item addr
=@
var{addr
}
131 Specify the controller
's PCI address (if=virtio only).
134 By default, writethrough caching is used for all block device. This means that
135 the host page cache will be used to read and write data but write notification
136 will be sent to the guest only when the data has been reported as written by
137 the storage subsystem.
139 Writeback caching will report data writes as completed as soon as the data is
140 present in the host page cache. This is safe as long as you trust your host.
141 If your host crashes or loses power, then the guest may experience data
142 corruption. When using the @option{-snapshot} option, writeback caching is
145 The host page cache can be avoided entirely with @option{cache=none}. This will
146 attempt to do disk IO directly to the guests memory. QEMU may still perform
147 an internal copy of the data.
149 Some block drivers perform badly with @option{cache=writethrough}, most notably,
150 qcow2. If performance is more important than correctness,
151 @option{cache=writeback} should be used with qcow2. By default, if no explicit
152 caching is specified for a qcow2 disk image, @option{cache=writeback} will be
153 used. For all other disk types, @option{cache=writethrough} is the default.
155 Instead of @option{-cdrom} you can use:
157 qemu -drive file=file,index=2,media=cdrom
160 Instead of @option{-hda}, @option{-hdb}, @option{-hdc}, @option{-hdd}, you can
163 qemu -drive file=file,index=0,media=disk
164 qemu -drive file=file,index=1,media=disk
165 qemu -drive file=file,index=2,media=disk
166 qemu -drive file=file,index=3,media=disk
169 You can connect a CDROM to the slave of ide0:
171 qemu -drive file=file,if=ide,index=1,media=cdrom
174 If you don't specify the
"file=" argument
, you define an empty drive
:
176 qemu
-drive
if=ide
,index
=1,media
=cdrom
179 You can connect a SCSI disk with unit ID
6 on the bus #
0:
181 qemu
-drive file
=file
,if=scsi
,bus
=0,unit
=6
184 Instead of @option
{-fda
}, @option
{-fdb
}, you can use
:
186 qemu
-drive file
=file
,index
=0,if=floppy
187 qemu
-drive file
=file
,index
=1,if=floppy
190 By
default, @
var{interface} is
"ide" and @
var{index
} is automatically
193 qemu
-drive file
=a
-drive file
=b
"
201 DEF("mtdblock
", HAS_ARG, QEMU_OPTION_mtdblock,
202 "-mtdblock file use
'file' as on
-board Flash memory image
\n")
206 Use 'file' as on-board Flash memory image.
209 DEF("sd
", HAS_ARG, QEMU_OPTION_sd,
210 "-sd file use
'file' as SecureDigital card image
\n")
213 Use 'file' as SecureDigital card image.
216 DEF("pflash
", HAS_ARG, QEMU_OPTION_pflash,
217 "-pflash file use
'file' as a parallel flash image
\n")
220 Use 'file' as a parallel flash image.
223 DEF("boot
", HAS_ARG, QEMU_OPTION_boot,
224 "-boot
[a|c|d|n
] boot on
floppy (a
), hard
disk (c
), CD
-ROM (d
), or
network (n
)\n")
226 @item -boot [a|c|d|n]
227 Boot on floppy (a), hard disk (c), CD-ROM (d), or Etherboot (n). Hard disk boot
231 DEF("snapshot
", 0, QEMU_OPTION_snapshot,
232 "-snapshot write to temporary files instead of disk image files
\n")
235 Write to temporary files instead of disk image files. In this case,
236 the raw disk image you use is not written back. You can however force
237 the write back by pressing @key{C-a s} (@pxref{disk_images}).
240 DEF("m
", HAS_ARG, QEMU_OPTION_m,
241 "-m megs set virtual RAM size to megs MB
[default=%d
]\n")
244 Set virtual RAM size to @var{megs} megabytes. Default is 128 MiB. Optionally,
245 a suffix of ``M'' or ``G'' can be used to signify a value in megabytes or
246 gigabytes respectively.
249 DEF("k
", HAS_ARG, QEMU_OPTION_k,
250 "-k language use keyboard
layout (for example
'fr' for French
)\n")
252 @item -k @var{language}
254 Use keyboard layout @var{language} (for example @code{fr} for
255 French). This option is only needed where it is not easy to get raw PC
256 keycodes (e.g. on Macs, with some X11 servers or with a VNC
257 display). You don't normally need to use it on PC/Linux or PC/Windows
260 The available layouts are:
262 ar de-ch es fo fr-ca hu ja mk no pt-br sv
263 da en-gb et fr fr-ch is lt nl pl ru th
264 de en-us fi fr-be hr it lv nl-be pt sl tr
267 The default is @code{en-us}.
272 DEF("audio
-help
", 0, QEMU_OPTION_audio_help,
273 "-audio
-help print list of audio drivers and their options
\n")
278 Will show the audio subsystem help: list of drivers, tunable
283 DEF("soundhw
", HAS_ARG, QEMU_OPTION_soundhw,
284 "-soundhw c1
,... enable audio support
\n"
285 " and only specified sound
cards (comma separated list
)\n"
286 " use
-soundhw ? to get the list of supported cards
\n"
287 " use
-soundhw all to enable all of them
\n")
290 @item -soundhw @var{card1}[,@var{card2},...] or -soundhw all
292 Enable audio and selected sound hardware. Use ? to print all
293 available sound hardware.
296 qemu -soundhw sb16,adlib disk.img
297 qemu -soundhw es1370 disk.img
298 qemu -soundhw ac97 disk.img
299 qemu -soundhw all disk.img
303 Note that Linux's i810_audio OSS kernel (for AC97) module might
304 require manually specifying clocking.
307 modprobe i810_audio clocking=48000
315 DEF("usb
", 0, QEMU_OPTION_usb,
316 "-usb enable the USB
driver (will be the
default soon
)\n")
322 Enable the USB driver (will be the default soon)
325 DEF("usbdevice
", HAS_ARG, QEMU_OPTION_usbdevice,
326 "-usbdevice name add the host or guest USB device
'name'\n")
329 @item -usbdevice @var{devname}
330 Add the USB device @var{devname}. @xref{usb_devices}.
335 Virtual Mouse. This will override the PS/2 mouse emulation when activated.
338 Pointer device that uses absolute coordinates (like a touchscreen). This
339 means qemu is able to report the mouse position without having to grab the
340 mouse. Also overrides the PS/2 mouse emulation when activated.
342 @item disk:[format=@var{format}]:file
343 Mass storage device based on file. The optional @var{format} argument
344 will be used rather than detecting the format. Can be used to specifiy
345 format=raw to avoid interpreting an untrusted format header.
348 Pass through the host device identified by bus.addr (Linux only).
350 @item host:vendor_id:product_id
351 Pass through the host device identified by vendor_id:product_id (Linux only).
353 @item serial:[vendorid=@var{vendor_id}][,productid=@var{product_id}]:@var{dev}
354 Serial converter to host character device @var{dev}, see @code{-serial} for the
358 Braille device. This will use BrlAPI to display the braille output on a real
362 Network adapter that supports CDC ethernet and RNDIS protocols.
367 DEF("name
", HAS_ARG, QEMU_OPTION_name,
368 "-name string set the name of the guest
\n")
370 @item -name @var{name}
371 Sets the @var{name} of the guest.
372 This name will be displayed in the SDL window caption.
373 The @var{name} will also be used for the VNC server.
376 DEF("uuid
", HAS_ARG, QEMU_OPTION_uuid,
377 "-uuid
%%08x
-%%04x
-%%04x
-%%04x
-%%012x
\n"
378 " specify machine UUID
\n")
380 @item -uuid @var{uuid}
390 DEFHEADING(Display options:)
396 DEF("nographic
", 0, QEMU_OPTION_nographic,
397 "-nographic disable graphical output and redirect serial I
/Os to console
\n")
401 Normally, QEMU uses SDL to display the VGA output. With this option,
402 you can totally disable graphical output so that QEMU is a simple
403 command line application. The emulated serial port is redirected on
404 the console. Therefore, you can still use QEMU to debug a Linux kernel
405 with a serial console.
409 DEF("curses
", 0, QEMU_OPTION_curses,
410 "-curses use a curses
/ncurses
interface instead of SDL
\n")
415 Normally, QEMU uses SDL to display the VGA output. With this option,
416 QEMU can display the VGA output when in text mode using a
417 curses/ncurses interface. Nothing is displayed in graphical mode.
421 DEF("no
-frame
", 0, QEMU_OPTION_no_frame,
422 "-no
-frame open SDL window without a frame and window decorations
\n")
427 Do not use decorations for SDL windows and start them using the whole
428 available screen space. This makes the using QEMU in a dedicated desktop
429 workspace more convenient.
433 DEF("alt
-grab
", 0, QEMU_OPTION_alt_grab,
434 "-alt
-grab use Ctrl
-Alt
-Shift to grab
mouse (instead of Ctrl
-Alt
)\n")
439 Use Ctrl-Alt-Shift to grab mouse (instead of Ctrl-Alt).
443 DEF("no
-quit
", 0, QEMU_OPTION_no_quit,
444 "-no
-quit disable SDL window close capability
\n")
449 Disable SDL window close capability.
453 DEF("sdl
", 0, QEMU_OPTION_sdl,
462 DEF("portrait
", 0, QEMU_OPTION_portrait,
463 "-portrait rotate graphical output
90 deg
left (only PXA LCD
)\n")
467 Rotate graphical output 90 deg left (only PXA LCD).
470 DEF("vga
", HAS_ARG, QEMU_OPTION_vga,
471 "-vga
[std|cirrus|vmware|xenfb|none
]\n"
472 " select video card type
\n")
474 @item -vga @var{type}
475 Select type of VGA card to emulate. Valid values for @var{type} are
478 Cirrus Logic GD5446 Video card. All Windows versions starting from
479 Windows 95 should recognize and use this graphic card. For optimal
480 performances, use 16 bit color depth in the guest and the host OS.
481 (This one is the default)
483 Standard VGA card with Bochs VBE extensions. If your guest OS
484 supports the VESA 2.0 VBE extensions (e.g. Windows XP) and if you want
485 to use high resolution modes (>= 1280x1024x16) then you should use
488 VMWare SVGA-II compatible adapter. Use it if you have sufficiently
489 recent XFree86/XOrg server or Windows guest with a driver for this
496 DEF("full
-screen
", 0, QEMU_OPTION_full_screen,
497 "-full
-screen start
in full screen
\n")
500 Start in full screen.
503 #if defined(TARGET_PPC) || defined(TARGET_SPARC)
504 DEF("g
", 1, QEMU_OPTION_g ,
505 "-g WxH
[xDEPTH
] Set the initial graphical resolution and depth
\n")
510 DEF("vnc
", HAS_ARG, QEMU_OPTION_vnc ,
511 "-vnc display start a VNC server on display
\n")
513 @item -vnc @var{display}[,@var{option}[,@var{option}[,...]]]
515 Normally, QEMU uses SDL to display the VGA output. With this option,
516 you can have QEMU listen on VNC display @var{display} and redirect the VGA
517 display over the VNC session. It is very useful to enable the usb
518 tablet device when using this option (option @option{-usbdevice
519 tablet}). When using the VNC display, you must use the @option{-k}
520 parameter to set the keyboard layout if you are not using en-us. Valid
521 syntax for the @var{display} is
525 @item @var{host}:@var{d}
527 TCP connections will only be allowed from @var{host} on display @var{d}.
528 By convention the TCP port is 5900+@var{d}. Optionally, @var{host} can
529 be omitted in which case the server will accept connections from any host.
531 @item @code{unix}:@var{path}
533 Connections will be allowed over UNIX domain sockets where @var{path} is the
534 location of a unix socket to listen for connections on.
538 VNC is initialized but not started. The monitor @code{change} command
539 can be used to later start the VNC server.
543 Following the @var{display} value there may be one or more @var{option} flags
544 separated by commas. Valid options are
550 Connect to a listening VNC client via a ``reverse'' connection. The
551 client is specified by the @var{display}. For reverse network
552 connections (@var{host}:@var{d},@code{reverse}), the @var{d} argument
553 is a TCP port number, not a display number.
557 Require that password based authentication is used for client connections.
558 The password must be set separately using the @code{change} command in the
563 Require that client use TLS when communicating with the VNC server. This
564 uses anonymous TLS credentials so is susceptible to a man-in-the-middle
565 attack. It is recommended that this option be combined with either the
566 @var{x509} or @var{x509verify} options.
568 @item x509=@var{/path/to/certificate/dir}
570 Valid if @option{tls} is specified. Require that x509 credentials are used
571 for negotiating the TLS session. The server will send its x509 certificate
572 to the client. It is recommended that a password be set on the VNC server
573 to provide authentication of the client when this is used. The path following
574 this option specifies where the x509 certificates are to be loaded from.
575 See the @ref{vnc_security} section for details on generating certificates.
577 @item x509verify=@var{/path/to/certificate/dir}
579 Valid if @option{tls} is specified. Require that x509 credentials are used
580 for negotiating the TLS session. The server will send its x509 certificate
581 to the client, and request that the client send its own x509 certificate.
582 The server will validate the client's certificate against the CA certificate,
583 and reject clients when validation fails. If the certificate authority is
584 trusted, this is a sufficient authentication mechanism. You may still wish
585 to set a password on the VNC server as a second authentication layer. The
586 path following this option specifies where the x509 certificates are to
587 be loaded from. See the @ref{vnc_security} section for details on generating
592 Require that the client use SASL to authenticate with the VNC server.
593 The exact choice of authentication method used is controlled from the
594 system / user's SASL configuration file for the 'qemu' service. This
595 is typically found in /etc/sasl2/qemu.conf. If running QEMU as an
596 unprivileged user, an environment variable SASL_CONF_PATH can be used
597 to make it search alternate locations for the service config.
598 While some SASL auth methods can also provide data encryption (eg GSSAPI),
599 it is recommended that SASL always be combined with the 'tls' and
600 'x509' settings to enable use of SSL and server certificates. This
601 ensures a data encryption preventing compromise of authentication
602 credentials. See the @ref{vnc_security} section for details on using
607 Turn on access control lists for checking of the x509 client certificate
608 and SASL party. For x509 certs, the ACL check is made against the
609 certificate's distinguished name. This is something that looks like
610 @code{C=GB,O=ACME,L=Boston,CN=bob}. For SASL party, the ACL check is
611 made against the username, which depending on the SASL plugin, may
612 include a realm component, eg @code{bob} or @code{bob@@EXAMPLE.COM}.
613 When the @option{acl} flag is set, the initial access list will be
614 empty, with a @code{deny} policy. Thus no one will be allowed to
615 use the VNC server until the ACLs have been loaded. This can be
616 achieved using the @code{acl} monitor command.
628 DEFHEADING(i386 target only:)
635 DEF("win2k
-hack
", 0, QEMU_OPTION_win2k_hack,
636 "-win2k
-hack use it when installing Windows
2000 to avoid a disk full bug
\n")
640 Use it when installing Windows 2000 to avoid a disk full bug. After
641 Windows 2000 is installed, you no longer need this option (this option
642 slows down the IDE transfers).
646 DEF("rtc
-td
-hack
", 0, QEMU_OPTION_rtc_td_hack,
647 "-rtc
-td
-hack use it to fix time drift
in Windows ACPI HAL
\n")
651 Use it if you experience time drift problem in Windows with ACPI HAL.
652 This option will try to figure out how many timer interrupts were not
653 processed by the Windows guest and will re-inject them.
657 DEF("no
-fd
-bootchk
", 0, QEMU_OPTION_no_fd_bootchk,
658 "-no
-fd
-bootchk disable boot signature checking
for floppy disks
\n")
662 Disable boot signature checking for floppy disks in Bochs BIOS. It may
663 be needed to boot from old floppy disks.
667 DEF("no
-acpi
", 0, QEMU_OPTION_no_acpi,
668 "-no
-acpi disable ACPI
\n")
672 Disable ACPI (Advanced Configuration and Power Interface) support. Use
673 it if your guest OS complains about ACPI problems (PC target machine
678 DEF("no
-hpet
", 0, QEMU_OPTION_no_hpet,
679 "-no
-hpet disable HPET
\n")
683 Disable HPET support.
687 DEF("no
-virtio
-balloon
", 0, QEMU_OPTION_no_virtio_balloon,
688 "-no
-virtio
-balloon disable virtio balloon device
\n")
691 @item -no-virtio-balloon
692 Disable virtio-balloon device.
696 DEF("acpitable
", HAS_ARG, QEMU_OPTION_acpitable,
697 "-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"
698 " ACPI table description
\n")
701 @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}]...]
702 Add ACPI table with specified header fields and context from specified files.
706 DEF("smbios
", HAS_ARG, QEMU_OPTION_smbios,
707 "-smbios file
=binary
\n"
708 " Load SMBIOS entry from binary file
\n"
709 "-smbios type
=0[,vendor
=str
][,version
=str
][,date
=str
][,release
=%%d
.%%d
]\n"
710 " Specify SMBIOS type
0 fields
\n"
711 "-smbios type
=1[,manufacturer
=str
][,product
=str
][,version
=str
][,serial
=str
]\n"
712 " [,uuid
=uuid
][,sku
=str
][,family
=str
]\n"
713 " Specify SMBIOS type
1 fields
\n")
716 @item -smbios file=@var{binary}
717 Load SMBIOS entry from binary file.
719 @item -smbios type=0[,vendor=@var{str}][,version=@var{str}][,date=@var{str}][,release=@var{%d.%d}]
720 Specify SMBIOS type 0 fields
722 @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}]
723 Specify SMBIOS type 1 fields
733 DEFHEADING(Network options:)
738 DEF("net
", HAS_ARG, QEMU_OPTION_net,
739 "-net nic
[,vlan
=n
][,macaddr
=mac
][,model
=type
][,name
=str
][,addr
=str
]\n"
740 " create a
new Network Interface Card and connect it to VLAN
'n'\n"
742 "-net user
[,vlan
=n
][,name
=str
][,hostname
=host
]\n"
743 " connect the user mode network stack to VLAN
'n' and send
\n"
744 " hostname
'host' to DHCP clients
\n"
747 "-net tap
[,vlan
=n
][,name
=str
],ifname
=name
\n"
748 " connect the host TAP network
interface to VLAN
'n'\n"
750 "-net tap
[,vlan
=n
][,name
=str
][,fd
=h
][,ifname
=name
][,script
=file
][,downscript
=dfile
]\n"
751 " connect the host TAP network
interface to VLAN
'n' and use the
\n"
752 " network scripts
'file' (default=%s
)\n"
753 " and
'dfile' (default=%s
);\n"
754 " use
'[down]script=no' to disable script execution
;\n"
755 " use
'fd=h' to connect to an already opened TAP
interface\n"
757 "-net socket
[,vlan
=n
][,name
=str
][,fd
=h
][,listen
=[host
]:port
][,connect
=host
:port
]\n"
758 " connect the vlan
'n' to another VLAN
using a socket connection
\n"
759 "-net socket
[,vlan
=n
][,name
=str
][,fd
=h
][,mcast
=maddr
:port
]\n"
760 " connect the vlan
'n' to multicast maddr and port
\n"
762 "-net vde
[,vlan
=n
][,name
=str
][,sock
=socketpath
][,port
=n
][,group
=groupname
][,mode
=octalmode
]\n"
763 " connect the vlan
'n' to port
'n' of a vde
switch running
\n"
764 " on host and listening
for incoming connections on
'socketpath'.\n"
765 " Use group
'groupname' and mode
'octalmode' to change
default\n"
766 " ownership and permissions
for communication port
.\n"
768 "-net dump
[,vlan
=n
][,file
=f
][,len
=n
]\n"
769 " dump traffic on vlan
'n' to file
'f' (max n bytes per packet
)\n"
770 "-net none use it alone to have zero network devices
; if no
-net option
\n"
771 " is provided
, the
default is
'-net nic -net user'\n")
773 @item -net nic[,vlan=@var{n}][,macaddr=@var{mac}][,model=@var{type}][,name=@var{name}][,addr=@var{addr}]
774 Create a new Network Interface Card and connect it to VLAN @var{n} (@var{n}
775 = 0 is the default). The NIC is an ne2k_pci by default on the PC
776 target. Optionally, the MAC address can be changed to @var{mac}, the
777 device address set to @var{addr} (PCI cards only),
778 and a @var{name} can be assigned for use in monitor commands. If no
779 @option{-net} option is specified, a single NIC is created.
780 Qemu can emulate several different models of network card.
781 Valid values for @var{type} are
782 @code{i82551}, @code{i82557b}, @code{i82559er},
783 @code{ne2k_pci}, @code{ne2k_isa}, @code{pcnet}, @code{rtl8139},
784 @code{e1000}, @code{smc91c111}, @code{lance} and @code{mcf_fec}.
785 Not all devices are supported on all targets. Use -net nic,model=?
786 for a list of available devices for your target.
788 @item -net user[,vlan=@var{n}][,hostname=@var{name}][,name=@var{name}]
789 Use the user mode network stack which requires no administrator
790 privilege to run. @option{hostname=name} can be used to specify the client
791 hostname reported by the builtin DHCP server.
793 @item -net channel,@var{port}:@var{dev}
794 Forward @option{user} TCP connection to port @var{port} to character device @var{dev}
796 @item -net tap[,vlan=@var{n}][,name=@var{name}][,fd=@var{h}][,ifname=@var{name}][,script=@var{file}][,downscript=@var{dfile}]
797 Connect the host TAP network interface @var{name} to VLAN @var{n}, use
798 the network script @var{file} to configure it and the network script
799 @var{dfile} to deconfigure it. If @var{name} is not provided, the OS
800 automatically provides one. @option{fd}=@var{h} can be used to specify
801 the handle of an already opened host TAP interface. The default network
802 configure script is @file{/etc/qemu-ifup} and the default network
803 deconfigure script is @file{/etc/qemu-ifdown}. Use @option{script=no}
804 or @option{downscript=no} to disable script execution. Example:
807 qemu linux.img -net nic -net tap
810 More complicated example (two NICs, each one connected to a TAP device)
812 qemu linux.img -net nic,vlan=0 -net tap,vlan=0,ifname=tap0 \
813 -net nic,vlan=1 -net tap,vlan=1,ifname=tap1
816 @item -net socket[,vlan=@var{n}][,name=@var{name}][,fd=@var{h}][,listen=[@var{host}]:@var{port}][,connect=@var{host}:@var{port}]
818 Connect the VLAN @var{n} to a remote VLAN in another QEMU virtual
819 machine using a TCP socket connection. If @option{listen} is
820 specified, QEMU waits for incoming connections on @var{port}
821 (@var{host} is optional). @option{connect} is used to connect to
822 another QEMU instance using the @option{listen} option. @option{fd}=@var{h}
823 specifies an already opened TCP socket.
827 # launch a first QEMU instance
828 qemu linux.img -net nic,macaddr=52:54:00:12:34:56 \
829 -net socket,listen=:1234
830 # connect the VLAN 0 of this instance to the VLAN 0
831 # of the first instance
832 qemu linux.img -net nic,macaddr=52:54:00:12:34:57 \
833 -net socket,connect=127.0.0.1:1234
836 @item -net socket[,vlan=@var{n}][,name=@var{name}][,fd=@var{h}][,mcast=@var{maddr}:@var{port}]
838 Create a VLAN @var{n} shared with another QEMU virtual
839 machines using a UDP multicast socket, effectively making a bus for
840 every QEMU with same multicast address @var{maddr} and @var{port}.
844 Several QEMU can be running on different hosts and share same bus (assuming
845 correct multicast setup for these hosts).
847 mcast support is compatible with User Mode Linux (argument @option{eth@var{N}=mcast}), see
848 @url{http://user-mode-linux.sf.net}.
850 Use @option{fd=h} to specify an already opened UDP multicast socket.
855 # launch one QEMU instance
856 qemu linux.img -net nic,macaddr=52:54:00:12:34:56 \
857 -net socket,mcast=230.0.0.1:1234
858 # launch another QEMU instance on same "bus
"
859 qemu linux.img -net nic,macaddr=52:54:00:12:34:57 \
860 -net socket,mcast=230.0.0.1:1234
861 # launch yet another QEMU instance on same "bus
"
862 qemu linux.img -net nic,macaddr=52:54:00:12:34:58 \
863 -net socket,mcast=230.0.0.1:1234
866 Example (User Mode Linux compat.):
868 # launch QEMU instance (note mcast address selected
870 qemu linux.img -net nic,macaddr=52:54:00:12:34:56 \
871 -net socket,mcast=239.192.168.1:1102
873 /path/to/linux ubd0=/path/to/root_fs eth0=mcast
876 @item -net vde[,vlan=@var{n}][,name=@var{name}][,sock=@var{socketpath}][,port=@var{n}][,group=@var{groupname}][,mode=@var{octalmode}]
877 Connect VLAN @var{n} to PORT @var{n} of a vde switch running on host and
878 listening for incoming connections on @var{socketpath}. Use GROUP @var{groupname}
879 and MODE @var{octalmode} to change default ownership and permissions for
880 communication port. This option is available only if QEMU has been compiled
881 with vde support enabled.
886 vde_switch -F -sock /tmp/myswitch
887 # launch QEMU instance
888 qemu linux.img -net nic -net vde,sock=/tmp/myswitch
891 @item -net dump[,vlan=@var{n}][,file=@var{file}][,len=@var{len}]
892 Dump network traffic on VLAN @var{n} to file @var{file} (@file{qemu-vlan0.pcap} by default).
893 At most @var{len} bytes (64k by default) per packet are stored. The file format is
894 libpcap, so it can be analyzed with tools such as tcpdump or Wireshark.
897 Indicate that no network devices should be configured. It is used to
898 override the default configuration (@option{-net nic -net user}) which
899 is activated if no @option{-net} options are provided.
903 DEF("tftp
", HAS_ARG, QEMU_OPTION_tftp, \
904 "-tftp dir allow tftp access to files
in dir
[-net user
]\n")
907 @item -tftp @var{dir}
908 When using the user mode network stack, activate a built-in TFTP
909 server. The files in @var{dir} will be exposed as the root of a TFTP server.
910 The TFTP client on the guest must be configured in binary mode (use the command
911 @code{bin} of the Unix TFTP client). The host IP address on the guest is as
916 DEF("bootp
", HAS_ARG, QEMU_OPTION_bootp, \
917 "-bootp file advertise file
in BOOTP replies
\n")
920 @item -bootp @var{file}
921 When using the user mode network stack, broadcast @var{file} as the BOOTP
922 filename. In conjunction with @option{-tftp}, this can be used to network boot
923 a guest from a local directory.
925 Example (using pxelinux):
927 qemu -hda linux.img -boot n -tftp /path/to/tftp/files -bootp /pxelinux.0
932 DEF("smb
", HAS_ARG, QEMU_OPTION_smb, \
933 "-smb dir allow SMB access to files
in 'dir' [-net user
]\n")
937 When using the user mode network stack, activate a built-in SMB
938 server so that Windows OSes can access to the host files in @file{@var{dir}}
941 In the guest Windows OS, the line:
945 must be added in the file @file{C:\WINDOWS\LMHOSTS} (for windows 9x/Me)
946 or @file{C:\WINNT\SYSTEM32\DRIVERS\ETC\LMHOSTS} (Windows NT/2000).
948 Then @file{@var{dir}} can be accessed in @file{\\smbserver\qemu}.
950 Note that a SAMBA server must be installed on the host OS in
951 @file{/usr/sbin/smbd}. QEMU was tested successfully with smbd version
952 2.2.7a from the Red Hat 9 and version 3.0.10-1.fc3 from Fedora Core 3.
956 DEF("redir
", HAS_ARG, QEMU_OPTION_redir, \
957 "-redir
[tcp|udp
]:host
-port
:[guest
-host
]:guest
-port
\n" \
958 " redirect TCP or UDP connections from host to guest
[-net user
]\n")
961 @item -redir [tcp|udp]:@var{host-port}:[@var{guest-host}]:@var{guest-port}
963 When using the user mode network stack, redirect incoming TCP or UDP
964 connections to the host port @var{host-port} to the guest
965 @var{guest-host} on guest port @var{guest-port}. If @var{guest-host}
966 is not specified, its value is 10.0.2.15 (default address given by the
967 built-in DHCP server). If no connection type is specified, TCP is used.
969 For example, to redirect host X11 connection from screen 1 to guest
970 screen 0, use the following:
974 qemu -redir tcp:6001::6000 [...]
975 # this host xterm should open in the guest X11 server
979 To redirect telnet connections from host port 5555 to telnet port on
980 the guest, use the following:
984 qemu -redir tcp:5555::23 [...]
985 telnet localhost 5555
988 Then when you use on the host @code{telnet localhost 5555}, you
989 connect to the guest telnet server.
994 DEF("bt
", HAS_ARG, QEMU_OPTION_bt, \
996 "-bt hci
,null dumb bluetooth HCI
- doesn
't respond to commands\n" \
997 "-bt hci,host[:id]\n" \
998 " use host's HCI with the given name
\n" \
999 "-bt hci
[,vlan
=n
]\n" \
1000 " emulate a standard HCI
in virtual scatternet
'n'\n" \
1001 "-bt vhci
[,vlan
=n
]\n" \
1002 " add host computer to virtual scatternet
'n' using VHCI
\n" \
1003 "-bt device
:dev
[,vlan
=n
]\n" \
1004 " emulate a bluetooth device
'dev' in scatternet
'n'\n")
1006 Bluetooth(R) options:
1010 Defines the function of the corresponding Bluetooth HCI. -bt options
1011 are matched with the HCIs present in the chosen machine type. For
1012 example when emulating a machine with only one HCI built into it, only
1013 the first @code{-bt hci[...]} option is valid and defines the HCI's
1014 logic. The Transport Layer is decided by the machine type. Currently
1015 the machines @code{n800} and @code{n810} have one HCI and all other
1019 The following three types are recognized:
1023 (default) The corresponding Bluetooth HCI assumes no internal logic
1024 and will not respond to any HCI commands or emit events.
1026 @item -bt hci,host[:@var{id}]
1027 (@code{bluez} only) The corresponding HCI passes commands / events
1028 to / from the physical HCI identified by the name @var{id} (default:
1029 @code{hci0}) on the computer running QEMU. Only available on @code{bluez}
1030 capable systems like Linux.
1032 @item -bt hci[,vlan=@var{n}]
1033 Add a virtual, standard HCI that will participate in the Bluetooth
1034 scatternet @var{n} (default @code{0}). Similarly to @option{-net}
1035 VLANs, devices inside a bluetooth network @var{n} can only communicate
1036 with other devices in the same network (scatternet).
1039 @item -bt vhci[,vlan=@var{n}]
1040 (Linux-host only) Create a HCI in scatternet @var{n} (default 0) attached
1041 to the host bluetooth stack instead of to the emulated target. This
1042 allows the host and target machines to participate in a common scatternet
1043 and communicate. Requires the Linux @code{vhci} driver installed. Can
1044 be used as following:
1047 qemu [...OPTIONS...] -bt hci,vlan=5 -bt vhci,vlan=5
1050 @item -bt device:@var{dev}[,vlan=@var{n}]
1051 Emulate a bluetooth device @var{dev} and place it in network @var{n}
1052 (default @code{0}). QEMU can only emulate one type of bluetooth devices
1057 Virtual wireless keyboard implementing the HIDP bluetooth profile.
1064 DEFHEADING(Linux boot specific:)
1066 When using these options, you can use a given
1067 Linux kernel without installing it in the disk image. It can be useful
1068 for easier testing of various kernels.
1073 DEF("kernel
", HAS_ARG, QEMU_OPTION_kernel, \
1074 "-kernel bzImage use
'bzImage' as kernel image
\n")
1076 @item -kernel @var{bzImage}
1077 Use @var{bzImage} as kernel image.
1080 DEF("append
", HAS_ARG, QEMU_OPTION_append, \
1081 "-append cmdline use
'cmdline' as kernel command line
\n")
1083 @item -append @var{cmdline}
1084 Use @var{cmdline} as kernel command line
1087 DEF("initrd
", HAS_ARG, QEMU_OPTION_initrd, \
1088 "-initrd file use
'file' as initial ram disk
\n")
1090 @item -initrd @var{file}
1091 Use @var{file} as initial ram disk.
1100 DEFHEADING(Debug/Expert options:)
1106 DEF("serial
", HAS_ARG, QEMU_OPTION_serial, \
1107 "-serial dev redirect the serial port to char device
'dev'\n")
1109 @item -serial @var{dev}
1110 Redirect the virtual serial port to host character device
1111 @var{dev}. The default device is @code{vc} in graphical mode and
1112 @code{stdio} in non graphical mode.
1114 This option can be used several times to simulate up to 4 serial
1117 Use @code{-serial none} to disable all serial ports.
1119 Available character devices are:
1122 Virtual console. Optionally, a width and height can be given in pixel with
1126 It is also possible to specify width or height in characters:
1131 [Linux only] Pseudo TTY (a new PTY is automatically allocated)
1133 No device is allocated.
1137 [Linux only] Use host tty, e.g. @file{/dev/ttyS0}. The host serial port
1138 parameters are set according to the emulated ones.
1139 @item /dev/parport@var{N}
1140 [Linux only, parallel port only] Use host parallel port
1141 @var{N}. Currently SPP and EPP parallel port features can be used.
1142 @item file:@var{filename}
1143 Write output to @var{filename}. No character can be read.
1145 [Unix only] standard input/output
1146 @item pipe:@var{filename}
1147 name pipe @var{filename}
1149 [Windows only] Use host serial port @var{n}
1150 @item udp:[@var{remote_host}]:@var{remote_port}[@@[@var{src_ip}]:@var{src_port}]
1151 This implements UDP Net Console.
1152 When @var{remote_host} or @var{src_ip} are not specified
1153 they default to @code{0.0.0.0}.
1154 When not using a specified @var{src_port} a random port is automatically chosen.
1156 Three button serial mouse. Configure the guest to use Microsoft protocol.
1158 If you just want a simple readonly console you can use @code{netcat} or
1159 @code{nc}, by starting qemu with: @code{-serial udp::4555} and nc as:
1160 @code{nc -u -l -p 4555}. Any time qemu writes something to that port it
1161 will appear in the netconsole session.
1163 If you plan to send characters back via netconsole or you want to stop
1164 and start qemu a lot of times, you should have qemu use the same
1165 source port each time by using something like @code{-serial
1166 udp::4555@@:4556} to qemu. Another approach is to use a patched
1167 version of netcat which can listen to a TCP port and send and receive
1168 characters via udp. If you have a patched version of netcat which
1169 activates telnet remote echo and single char transfer, then you can
1170 use the following options to step up a netcat redirector to allow
1171 telnet on port 5555 to access the qemu port.
1174 -serial udp::4555@@:4556
1175 @item netcat options:
1176 -u -P 4555 -L 0.0.0.0:4556 -t -p 5555 -I -T
1177 @item telnet options:
1181 @item tcp:[@var{host}]:@var{port}[,@var{server}][,nowait][,nodelay]
1182 The TCP Net Console has two modes of operation. It can send the serial
1183 I/O to a location or wait for a connection from a location. By default
1184 the TCP Net Console is sent to @var{host} at the @var{port}. If you use
1185 the @var{server} option QEMU will wait for a client socket application
1186 to connect to the port before continuing, unless the @code{nowait}
1187 option was specified. The @code{nodelay} option disables the Nagle buffering
1188 algorithm. If @var{host} is omitted, 0.0.0.0 is assumed. Only
1189 one TCP connection at a time is accepted. You can use @code{telnet} to
1190 connect to the corresponding character device.
1192 @item Example to send tcp console to 192.168.0.2 port 4444
1193 -serial tcp:192.168.0.2:4444
1194 @item Example to listen and wait on port 4444 for connection
1195 -serial tcp::4444,server
1196 @item Example to not wait and listen on ip 192.168.0.100 port 4444
1197 -serial tcp:192.168.0.100:4444,server,nowait
1200 @item telnet:@var{host}:@var{port}[,server][,nowait][,nodelay]
1201 The telnet protocol is used instead of raw tcp sockets. The options
1202 work the same as if you had specified @code{-serial tcp}. The
1203 difference is that the port acts like a telnet server or client using
1204 telnet option negotiation. This will also allow you to send the
1205 MAGIC_SYSRQ sequence if you use a telnet that supports sending the break
1206 sequence. Typically in unix telnet you do it with Control-] and then
1207 type "send
break" followed by pressing the enter key.
1209 @item unix:@var{path}[,server][,nowait]
1210 A unix domain socket is used instead of a tcp socket. The option works the
1211 same as if you had specified @code{-serial tcp} except the unix domain socket
1212 @var{path} is used for connections.
1214 @item mon:@var{dev_string}
1215 This is a special option to allow the monitor to be multiplexed onto
1216 another serial port. The monitor is accessed with key sequence of
1217 @key{Control-a} and then pressing @key{c}. See monitor access
1218 @ref{pcsys_keys} in the -nographic section for more keys.
1219 @var{dev_string} should be any one of the serial devices specified
1220 above. An example to multiplex the monitor onto a telnet server
1221 listening on port 4444 would be:
1223 @item -serial mon:telnet::4444,server,nowait
1227 Braille device. This will use BrlAPI to display the braille output on a real
1233 DEF("parallel
", HAS_ARG, QEMU_OPTION_parallel, \
1234 "-parallel dev redirect the parallel port to char device
'dev'\n")
1236 @item -parallel @var{dev}
1237 Redirect the virtual parallel port to host device @var{dev} (same
1238 devices as the serial port). On Linux hosts, @file{/dev/parportN} can
1239 be used to use hardware devices connected on the corresponding host
1242 This option can be used several times to simulate up to 3 parallel
1245 Use @code{-parallel none} to disable all parallel ports.
1248 DEF("monitor
", HAS_ARG, QEMU_OPTION_monitor, \
1249 "-monitor dev redirect the monitor to char device
'dev'\n")
1251 @item -monitor @var{dev}
1252 Redirect the monitor to host device @var{dev} (same devices as the
1254 The default device is @code{vc} in graphical mode and @code{stdio} in
1258 DEF("pidfile
", HAS_ARG, QEMU_OPTION_pidfile, \
1259 "-pidfile file write PID to
'file'\n")
1261 @item -pidfile @var{file}
1262 Store the QEMU process PID in @var{file}. It is useful if you launch QEMU
1266 DEF("singlestep
", 0, QEMU_OPTION_singlestep, \
1267 "-singlestep always run
in singlestep mode
\n")
1270 Run the emulation in single step mode.
1273 DEF("S
", 0, QEMU_OPTION_S, \
1274 "-S freeze CPU at
startup (use
'c' to start execution
)\n")
1277 Do not start CPU at startup (you must type 'c' in the monitor).
1280 DEF("gdb
", HAS_ARG, QEMU_OPTION_gdb, \
1281 "-gdb dev wait
for gdb connection on
'dev'\n")
1283 @item -gdb @var{dev}
1284 Wait for gdb connection on device @var{dev} (@pxref{gdb_usage}). Typical
1285 connections will likely be TCP-based, but also UDP, pseudo TTY, or even
1286 stdio are reasonable use case. The latter is allowing to start qemu from
1287 within gdb and establish the connection via a pipe:
1289 (gdb) target remote | exec qemu -gdb stdio ...
1293 DEF("s
", 0, QEMU_OPTION_s, \
1294 "-s shorthand
for -gdb tcp
::%s
\n")
1297 Shorthand for -gdb tcp::1234, i.e. open a gdbserver on TCP port 1234
1298 (@pxref{gdb_usage}).
1301 DEF("d
", HAS_ARG, QEMU_OPTION_d, \
1302 "-d item1
,... output log to
%s (use
-d ?
for a list of log items
)\n")
1305 Output log in /tmp/qemu.log
1308 DEF("hdachs
", HAS_ARG, QEMU_OPTION_hdachs, \
1309 "-hdachs c
,h
,s
[,t
]\n" \
1310 " force hard disk
0 physical geometry and the optional BIOS
\n" \
1311 " translation (t
=none or lba
) (usually qemu can guess them
)\n")
1313 @item -hdachs @var{c},@var{h},@var{s},[,@var{t}]
1314 Force hard disk 0 physical geometry (1 <= @var{c} <= 16383, 1 <=
1315 @var{h} <= 16, 1 <= @var{s} <= 63) and optionally force the BIOS
1316 translation mode (@var{t}=none, lba or auto). Usually QEMU can guess
1317 all those parameters. This option is useful for old MS-DOS disk
1321 DEF("L
", HAS_ARG, QEMU_OPTION_L, \
1322 "-L path set the directory
for the BIOS
, VGA BIOS and keymaps
\n")
1325 Set the directory for the BIOS, VGA BIOS and keymaps.
1328 DEF("bios
", HAS_ARG, QEMU_OPTION_bios, \
1329 "-bios file set the filename
for the BIOS
\n")
1331 @item -bios @var{file}
1332 Set the filename for the BIOS.
1336 DEF("kernel
-kqemu
", 0, QEMU_OPTION_kernel_kqemu, \
1337 "-kernel
-kqemu enable KQEMU full
virtualization (default is user mode only
)\n")
1341 Enable KQEMU full virtualization (default is user mode only).
1345 DEF("no
-kqemu
", 0, QEMU_OPTION_no_kqemu, \
1346 "-no
-kqemu disable KQEMU kernel module usage
\n")
1350 Disable KQEMU kernel module usage. KQEMU options are only available if
1351 KQEMU support is enabled when compiling.
1355 DEF("enable
-kvm
", 0, QEMU_OPTION_enable_kvm, \
1356 "-enable
-kvm enable KVM full virtualization support
\n")
1360 Enable KVM full virtualization support. This option is only available
1361 if KVM support is enabled when compiling.
1365 DEF("xen
-domid
", HAS_ARG, QEMU_OPTION_xen_domid,
1366 "-xen
-domid id specify xen guest domain id
\n")
1367 DEF("xen
-create
", 0, QEMU_OPTION_xen_create,
1368 "-xen
-create create domain
using xen hypercalls
, bypassing xend
\n"
1369 " warning
: should not be used when xend is
in use
\n")
1370 DEF("xen
-attach
", 0, QEMU_OPTION_xen_attach,
1371 "-xen
-attach attach to existing xen domain
\n"
1372 " xend will use
this when starting qemu
\n")
1375 DEF("no
-reboot
", 0, QEMU_OPTION_no_reboot, \
1376 "-no
-reboot exit instead of rebooting
\n")
1379 Exit instead of rebooting.
1382 DEF("no
-shutdown
", 0, QEMU_OPTION_no_shutdown, \
1383 "-no
-shutdown stop before shutdown
\n")
1386 Don't exit QEMU on guest shutdown, but instead only stop the emulation.
1387 This allows for instance switching to monitor to commit changes to the
1391 DEF("loadvm
", HAS_ARG, QEMU_OPTION_loadvm, \
1392 "-loadvm
[tag|id
]\n" \
1393 " start right away with a saved
state (loadvm
in monitor
)\n")
1395 @item -loadvm @var{file}
1396 Start right away with a saved state (@code{loadvm} in monitor)
1400 DEF("daemonize
", 0, QEMU_OPTION_daemonize, \
1401 "-daemonize daemonize QEMU after initializing
\n")
1405 Daemonize the QEMU process after initialization. QEMU will not detach from
1406 standard IO until it is ready to receive connections on any of its devices.
1407 This option is a useful way for external programs to launch QEMU without having
1408 to cope with initialization race conditions.
1411 DEF("option
-rom
", HAS_ARG, QEMU_OPTION_option_rom, \
1412 "-option
-rom rom load a file
, rom
, into the option ROM space
\n")
1414 @item -option-rom @var{file}
1415 Load the contents of @var{file} as an option ROM.
1416 This option is useful to load things like EtherBoot.
1419 DEF("clock
", HAS_ARG, QEMU_OPTION_clock, \
1420 "-clock force the use of the given methods
for timer alarm
.\n" \
1421 " To see what timers are available use
-clock ?
\n")
1423 @item -clock @var{method}
1424 Force the use of the given methods for timer alarm. To see what timers
1425 are available use -clock ?.
1428 DEF("localtime
", 0, QEMU_OPTION_localtime, \
1429 "-localtime set the real time clock to local time
[default=utc
]\n")
1432 Set the real time clock to local time (the default is to UTC
1433 time). This option is needed to have correct date in MS-DOS or
1437 DEF("startdate
", HAS_ARG, QEMU_OPTION_startdate, \
1438 "-startdate select initial date of the clock
\n")
1441 @item -startdate @var{date}
1442 Set the initial date of the real time clock. Valid formats for
1443 @var{date} are: @code{now} or @code{2006-06-17T16:01:21} or
1444 @code{2006-06-17}. The default value is @code{now}.
1447 DEF("icount
", HAS_ARG, QEMU_OPTION_icount, \
1448 "-icount
[N|auto
]\n" \
1449 " enable virtual instruction counter with
2^N clock ticks per
\n" \
1452 @item -icount [N|auto]
1453 Enable virtual instruction counter. The virtual cpu will execute one
1454 instruction every 2^N ns of virtual time. If @code{auto} is specified
1455 then the virtual cpu speed will be automatically adjusted to keep virtual
1456 time within a few seconds of real time.
1458 Note that while this option can give deterministic behavior, it does not
1459 provide cycle accurate emulation. Modern CPUs contain superscalar out of
1460 order cores with complex cache hierarchies. The number of instructions
1461 executed often has little or no correlation with actual performance.
1464 DEF("watchdog
", HAS_ARG, QEMU_OPTION_watchdog, \
1465 "-watchdog i6300esb|ib700
\n" \
1466 " enable virtual hardware watchdog
[default=none
]\n")
1468 @item -watchdog @var{model}
1469 Create a virtual hardware watchdog device. Once enabled (by a guest
1470 action), the watchdog must be periodically polled by an agent inside
1471 the guest or else the guest will be restarted.
1473 The @var{model} is the model of hardware watchdog to emulate. Choices
1474 for model are: @code{ib700} (iBASE 700) which is a very simple ISA
1475 watchdog with a single timer, or @code{i6300esb} (Intel 6300ESB I/O
1476 controller hub) which is a much more featureful PCI-based dual-timer
1477 watchdog. Choose a model for which your guest has drivers.
1479 Use @code{-watchdog ?} to list available hardware models. Only one
1480 watchdog can be enabled for a guest.
1483 DEF("watchdog
-action
", HAS_ARG, QEMU_OPTION_watchdog_action, \
1484 "-watchdog
-action reset|shutdown|poweroff|pause|debug|none
\n" \
1485 " action when watchdog fires
[default=reset
]\n")
1487 @item -watchdog-action @var{action}
1489 The @var{action} controls what QEMU will do when the watchdog timer
1492 @code{reset} (forcefully reset the guest).
1493 Other possible actions are:
1494 @code{shutdown} (attempt to gracefully shutdown the guest),
1495 @code{poweroff} (forcefully poweroff the guest),
1496 @code{pause} (pause the guest),
1497 @code{debug} (print a debug message and continue), or
1498 @code{none} (do nothing).
1500 Note that the @code{shutdown} action requires that the guest responds
1501 to ACPI signals, which it may not be able to do in the sort of
1502 situations where the watchdog would have expired, and thus
1503 @code{-watchdog-action shutdown} is not recommended for production use.
1508 @item -watchdog i6300esb -watchdog-action pause
1509 @item -watchdog ib700
1513 DEF("echr
", HAS_ARG, QEMU_OPTION_echr, \
1514 "-echr chr set terminal escape character instead of ctrl
-a
\n")
1517 @item -echr numeric_ascii_value
1518 Change the escape character used for switching to the monitor when using
1519 monitor and serial sharing. The default is @code{0x01} when using the
1520 @code{-nographic} option. @code{0x01} is equal to pressing
1521 @code{Control-a}. You can select a different character from the ascii
1522 control keys where 1 through 26 map to Control-a through Control-z. For
1523 instance you could use the either of the following to change the escape
1524 character to Control-t.
1531 DEF("virtioconsole
", HAS_ARG, QEMU_OPTION_virtiocon, \
1532 "-virtioconsole c
\n" \
1533 " set virtio console
\n")
1535 @item -virtioconsole @var{c}
1539 DEF("show
-cursor
", 0, QEMU_OPTION_show_cursor, \
1540 "-show
-cursor show cursor
\n")
1544 DEF("tb
-size
", HAS_ARG, QEMU_OPTION_tb_size, \
1545 "-tb
-size n set TB size
\n")
1549 DEF("incoming
", HAS_ARG, QEMU_OPTION_incoming, \
1550 "-incoming p prepare
for incoming migration
, listen on port p
\n")
1555 DEF("chroot
", HAS_ARG, QEMU_OPTION_chroot, \
1556 "-chroot dir Chroot to dir just before starting the VM
.\n")
1560 Immediately before starting guest execution, chroot to the specified
1561 directory. Especially useful in combination with -runas.
1565 DEF("runas
", HAS_ARG, QEMU_OPTION_runas, \
1566 "-runas user Change to user id user just before starting the VM
.\n")
1570 Immediately before starting guest execution, drop root privileges, switching
1571 to the specified user.
1578 #if defined(TARGET_SPARC) || defined(TARGET_PPC)
1579 DEF("prom
-env
", HAS_ARG, QEMU_OPTION_prom_env,
1580 "-prom
-env variable
=value
\n"
1581 " set OpenBIOS nvram variables
\n")
1583 #if defined(TARGET_ARM) || defined(TARGET_M68K)
1584 DEF("semihosting
", 0, QEMU_OPTION_semihosting,
1585 "-semihosting semihosting mode
\n")
1587 #if defined(TARGET_ARM)
1588 DEF("old
-param
", 0, QEMU_OPTION_old_param,
1589 "-old
-param old param mode
\n")