1 HXCOMM Use
DEFHEADING() to define headings
in both help text and texi
2 HXCOMM Text between STEXI and ETEXI are copied to texi version and
3 HXCOMM discarded from C version
4 HXCOMM
DEF(option
, HAS_ARG
/0, opt_enum
, opt_help
, arch_mask
) is used to
5 HXCOMM construct option structures
, enums and help message
for specified
7 HXCOMM HXCOMM can be used
for comments
, discarded from both texi and C
9 DEFHEADING(Standard options
:)
14 DEF("help", 0, QEMU_OPTION_h
,
15 "-h or -help display this help and exit\n", QEMU_ARCH_ALL
)
22 DEF("version", 0, QEMU_OPTION_version
,
23 "-version display version information and exit\n", QEMU_ARCH_ALL
)
27 Display version information and exit
30 DEF("M", HAS_ARG
, QEMU_OPTION_M
,
31 "-M machine select emulated machine (-M ? for list)\n", QEMU_ARCH_ALL
)
33 @item
-M @
var{machine
}
35 Select the emulated @
var{machine
} (@code
{-M ?
} for list
)
38 DEF("cpu", HAS_ARG
, QEMU_OPTION_cpu
,
39 "-cpu cpu select CPU (-cpu ? for list)\n", QEMU_ARCH_ALL
)
41 @item
-cpu @
var{model
}
43 Select CPU
model (-cpu ?
for list and additional feature selection
)
46 DEF("smp", HAS_ARG
, QEMU_OPTION_smp
,
47 "-smp n[,maxcpus=cpus][,cores=cores][,threads=threads][,sockets=sockets]\n"
48 " set the number of CPUs to 'n' [default=1]\n"
49 " maxcpus= maximum number of total cpus, including\n"
50 " offline CPUs for hotplug, etc\n"
51 " cores= number of CPU cores on one socket\n"
52 " threads= number of threads on one CPU core\n"
53 " sockets= number of discrete sockets in the system\n",
56 @item
-smp @
var{n
}[,cores
=@
var{cores
}][,threads
=@
var{threads
}][,sockets
=@
var{sockets
}][,maxcpus
=@
var{maxcpus
}]
58 Simulate an SMP system with @
var{n
} CPUs
. On the PC target
, up to
255
59 CPUs are supported
. On Sparc32 target
, Linux limits the number of usable CPUs
61 For the PC target
, the number of @
var{cores
} per socket
, the number
62 of @
var{threads
} per cores and the total number of @
var{sockets
} can be
63 specified
. Missing values will be computed
. If any on the three values is
64 given
, the total number of CPUs @
var{n
} can be omitted
. @
var{maxcpus
}
65 specifies the maximum number of hotpluggable CPUs
.
68 DEF("numa", HAS_ARG
, QEMU_OPTION_numa
,
69 "-numa node[,mem=size][,cpus=cpu[-cpu]][,nodeid=node]\n", QEMU_ARCH_ALL
)
71 @item
-numa @
var{opts
}
73 Simulate a multi node NUMA system
. If mem and cpus are omitted
, resources
77 DEF("fda", HAS_ARG
, QEMU_OPTION_fda
,
78 "-fda/-fdb file use 'file' as floppy disk 0/1 image\n", QEMU_ARCH_ALL
)
79 DEF("fdb", HAS_ARG
, QEMU_OPTION_fdb
, "", QEMU_ARCH_ALL
)
85 Use @
var{file
} as floppy disk
0/1 image (@pxref
{disk_images
}). You can
86 use the host floppy by
using @file
{/dev
/fd0
} as
filename (@pxref
{host_drives
}).
89 DEF("hda", HAS_ARG
, QEMU_OPTION_hda
,
90 "-hda/-hdb file use 'file' as IDE hard disk 0/1 image\n", QEMU_ARCH_ALL
)
91 DEF("hdb", HAS_ARG
, QEMU_OPTION_hdb
, "", QEMU_ARCH_ALL
)
92 DEF("hdc", HAS_ARG
, QEMU_OPTION_hdc
,
93 "-hdc/-hdd file use 'file' as IDE hard disk 2/3 image\n", QEMU_ARCH_ALL
)
94 DEF("hdd", HAS_ARG
, QEMU_OPTION_hdd
, "", QEMU_ARCH_ALL
)
104 Use @
var{file
} as hard disk
0, 1, 2 or
3 image (@pxref
{disk_images
}).
107 DEF("cdrom", HAS_ARG
, QEMU_OPTION_cdrom
,
108 "-cdrom file use 'file' as IDE cdrom image (cdrom is ide1 master)\n",
111 @item
-cdrom @
var{file
}
113 Use @
var{file
} as CD
-ROM
image (you cannot use @option
{-hdc
} and
114 @option
{-cdrom
} at the same time
). You can use the host CD
-ROM by
115 using @file
{/dev
/cdrom
} as
filename (@pxref
{host_drives
}).
118 DEF("drive", HAS_ARG
, QEMU_OPTION_drive
,
119 "-drive [file=file][,if=type][,bus=n][,unit=m][,media=d][,index=i]\n"
120 " [,cyls=c,heads=h,secs=s[,trans=t]][,snapshot=on|off]\n"
121 " [,cache=writethrough|writeback|none|unsafe][,format=f]\n"
122 " [,serial=s][,addr=A][,id=name][,aio=threads|native]\n"
123 " [,readonly=on|off]\n"
124 " use 'file' as a drive image\n", QEMU_ARCH_ALL
)
126 @item
-drive @
var{option
}[,@
var{option
}[,@
var{option
}[,...]]]
129 Define a
new drive
. Valid options are
:
132 @item file
=@
var{file
}
133 This option defines which disk
image (@pxref
{disk_images
}) to use with
134 this drive
. If the filename contains comma
, you must double it
135 (for instance
, "file=my,,file" to use file
"my,file").
136 @item
if=@
var{interface}
137 This option defines on which type on
interface the drive is connected
.
138 Available types are
: ide
, scsi
, sd
, mtd
, floppy
, pflash
, virtio
.
139 @item bus
=@
var{bus
},unit
=@
var{unit
}
140 These options define where is connected the drive by defining the bus number and
142 @item index
=@
var{index
}
143 This option defines where is connected the drive by
using an index
in the list
144 of available connectors of a given
interface type
.
145 @item media
=@
var{media
}
146 This option defines the type of the media
: disk or cdrom
.
147 @item cyls
=@
var{c
},heads
=@
var{h
},secs
=@
var{s
}[,trans
=@
var{t
}]
148 These options have the same definition as they have
in @option
{-hdachs
}.
149 @item snapshot
=@
var{snapshot
}
150 @
var{snapshot
} is
"on" or
"off" and allows to enable snapshot
for given
drive (see @option
{-snapshot
}).
151 @item cache
=@
var{cache
}
152 @
var{cache
} is
"none", "writeback", "unsafe", or
"writethrough" and controls how the host cache is used to access block data
.
154 @
var{aio
} is
"threads", or
"native" and selects between pthread based disk I
/O and native Linux AIO
.
155 @item format
=@
var{format
}
156 Specify which disk @
var{format
} will be used rather than detecting
157 the format
. Can be used to specifiy format
=raw to avoid interpreting
158 an untrusted format header
.
159 @item serial
=@
var{serial
}
160 This option specifies the serial number to assign to the device
.
161 @item addr
=@
var{addr
}
162 Specify the controller
's PCI address (if=virtio only).
165 By default, writethrough caching is used for all block device. This means that
166 the host page cache will be used to read and write data but write notification
167 will be sent to the guest only when the data has been reported as written by
168 the storage subsystem.
170 Writeback caching will report data writes as completed as soon as the data is
171 present in the host page cache. This is safe as long as you trust your host.
172 If your host crashes or loses power, then the guest may experience data
175 The host page cache can be avoided entirely with @option{cache=none}. This will
176 attempt to do disk IO directly to the guests memory. QEMU may still perform
177 an internal copy of the data.
179 Some block drivers perform badly with @option{cache=writethrough}, most notably,
180 qcow2. If performance is more important than correctness,
181 @option{cache=writeback} should be used with qcow2.
183 In case you don't care about data integrity over host failures
, use
184 cache
=unsafe
. This option tells qemu that it
never needs to write any data
185 to the disk but can instead keeps things
in cache
. If anything goes wrong
,
186 like your host losing power
, the disk storage getting disconnected accidently
,
187 etc
. you
're image will most probably be rendered unusable. When using
188 the @option{-snapshot} option, unsafe caching is always used.
190 Instead of @option{-cdrom} you can use:
192 qemu -drive file=file,index=2,media=cdrom
195 Instead of @option{-hda}, @option{-hdb}, @option{-hdc}, @option{-hdd}, you can
198 qemu -drive file=file,index=0,media=disk
199 qemu -drive file=file,index=1,media=disk
200 qemu -drive file=file,index=2,media=disk
201 qemu -drive file=file,index=3,media=disk
204 You can connect a CDROM to the slave of ide0:
206 qemu -drive file=file,if=ide,index=1,media=cdrom
209 If you don't specify the
"file=" argument
, you define an empty drive
:
211 qemu
-drive
if=ide
,index
=1,media
=cdrom
214 You can connect a SCSI disk with unit ID
6 on the bus #
0:
216 qemu
-drive file
=file
,if=scsi
,bus
=0,unit
=6
219 Instead of @option
{-fda
}, @option
{-fdb
}, you can use
:
221 qemu
-drive file
=file
,index
=0,if=floppy
222 qemu
-drive file
=file
,index
=1,if=floppy
225 By
default, @
var{interface} is
"ide" and @
var{index
} is automatically
228 qemu
-drive file
=a
-drive file
=b
"
236 DEF("set
", HAS_ARG, QEMU_OPTION_set,
237 "-set group
.id
.arg
=value
\n"
238 " set
<arg
> parameter
for item
<id
> of type
<group
>\n"
239 " i
.e
. -set drive
.$id
.file
=/path
/to
/image
\n", QEMU_ARCH_ALL)
246 DEF("global
", HAS_ARG, QEMU_OPTION_global,
247 "-global driver
.property
=value
\n"
248 " set a global
default for a driver property
\n",
256 DEF("mtdblock
", HAS_ARG, QEMU_OPTION_mtdblock,
257 "-mtdblock file use
'file' as on
-board Flash memory image
\n",
260 @item -mtdblock @var{file}
262 Use @var{file} as on-board Flash memory image.
265 DEF("sd
", HAS_ARG, QEMU_OPTION_sd,
266 "-sd file use
'file' as SecureDigital card image
\n", QEMU_ARCH_ALL)
270 Use @var{file} as SecureDigital card image.
273 DEF("pflash
", HAS_ARG, QEMU_OPTION_pflash,
274 "-pflash file use
'file' as a parallel flash image
\n", QEMU_ARCH_ALL)
276 @item -pflash @var{file}
278 Use @var{file} as a parallel flash image.
281 DEF("boot
", HAS_ARG, QEMU_OPTION_boot,
282 "-boot
[order
=drives
][,once
=drives
][,menu
=on|off
]\n"
283 " 'drives': floppy (a
), hard
disk (c
), CD
-ROM (d
), network (n
)\n",
286 @item -boot [order=@var{drives}][,once=@var{drives}][,menu=on|off]
288 Specify boot order @var{drives} as a string of drive letters. Valid
289 drive letters depend on the target achitecture. The x86 PC uses: a, b
290 (floppy 1 and 2), c (first hard disk), d (first CD-ROM), n-p (Etherboot
291 from network adapter 1-4), hard disk boot is the default. To apply a
292 particular boot order only on the first startup, specify it via
295 Interactive boot menus/prompts can be enabled via @option{menu=on} as far
296 as firmware/BIOS supports them. The default is non-interactive boot.
299 # try to boot from network first, then from hard disk
301 # boot from CD-ROM first, switch back to default order after reboot
305 Note: The legacy format '-boot @var{drives}' is still supported but its
306 use is discouraged as it may be removed from future versions.
309 DEF("snapshot
", 0, QEMU_OPTION_snapshot,
310 "-snapshot write to temporary files instead of disk image files
\n",
315 Write to temporary files instead of disk image files. In this case,
316 the raw disk image you use is not written back. You can however force
317 the write back by pressing @key{C-a s} (@pxref{disk_images}).
320 DEF("m
", HAS_ARG, QEMU_OPTION_m,
321 "-m megs set virtual RAM size to megs MB
[default="
322 stringify(DEFAULT_RAM_SIZE) "]\n", QEMU_ARCH_ALL)
326 Set virtual RAM size to @var{megs} megabytes. Default is 128 MiB. Optionally,
327 a suffix of ``M'' or ``G'' can be used to signify a value in megabytes or
328 gigabytes respectively.
331 DEF("mem
-path
", HAS_ARG, QEMU_OPTION_mempath,
332 "-mem
-path FILE provide backing storage
for guest RAM
\n", QEMU_ARCH_ALL)
334 @item -mem-path @var{path}
335 Allocate guest RAM from a temporarily created file in @var{path}.
339 DEF("mem
-prealloc
", 0, QEMU_OPTION_mem_prealloc,
340 "-mem
-prealloc preallocate guest
memory (use with
-mem
-path
)\n",
344 Preallocate memory when using -mem-path.
348 DEF("k
", HAS_ARG, QEMU_OPTION_k,
349 "-k language use keyboard
layout (for example
'fr' for French
)\n",
352 @item -k @var{language}
354 Use keyboard layout @var{language} (for example @code{fr} for
355 French). This option is only needed where it is not easy to get raw PC
356 keycodes (e.g. on Macs, with some X11 servers or with a VNC
357 display). You don't normally need to use it on PC/Linux or PC/Windows
360 The available layouts are:
362 ar de-ch es fo fr-ca hu ja mk no pt-br sv
363 da en-gb et fr fr-ch is lt nl pl ru th
364 de en-us fi fr-be hr it lv nl-be pt sl tr
367 The default is @code{en-us}.
371 DEF("audio
-help
", 0, QEMU_OPTION_audio_help,
372 "-audio
-help print list of audio drivers and their options
\n",
377 Will show the audio subsystem help: list of drivers, tunable
381 DEF("soundhw
", HAS_ARG, QEMU_OPTION_soundhw,
382 "-soundhw c1
,... enable audio support
\n"
383 " and only specified sound
cards (comma separated list
)\n"
384 " use
-soundhw ? to get the list of supported cards
\n"
385 " use
-soundhw all to enable all of them
\n", QEMU_ARCH_ALL)
387 @item -soundhw @var{card1}[,@var{card2},...] or -soundhw all
389 Enable audio and selected sound hardware. Use ? to print all
390 available sound hardware.
393 qemu -soundhw sb16,adlib disk.img
394 qemu -soundhw es1370 disk.img
395 qemu -soundhw ac97 disk.img
396 qemu -soundhw hda disk.img
397 qemu -soundhw all disk.img
401 Note that Linux's i810_audio OSS kernel (for AC97) module might
402 require manually specifying clocking.
405 modprobe i810_audio clocking=48000
413 DEF("usb
", 0, QEMU_OPTION_usb,
414 "-usb enable the USB
driver (will be the
default soon
)\n",
422 Enable the USB driver (will be the default soon)
425 DEF("usbdevice
", HAS_ARG, QEMU_OPTION_usbdevice,
426 "-usbdevice name add the host or guest USB device
'name'\n",
430 @item -usbdevice @var{devname}
432 Add the USB device @var{devname}. @xref{usb_devices}.
437 Virtual Mouse. This will override the PS/2 mouse emulation when activated.
440 Pointer device that uses absolute coordinates (like a touchscreen). This
441 means qemu is able to report the mouse position without having to grab the
442 mouse. Also overrides the PS/2 mouse emulation when activated.
444 @item disk:[format=@var{format}]:@var{file}
445 Mass storage device based on file. The optional @var{format} argument
446 will be used rather than detecting the format. Can be used to specifiy
447 @code{format=raw} to avoid interpreting an untrusted format header.
449 @item host:@var{bus}.@var{addr}
450 Pass through the host device identified by @var{bus}.@var{addr} (Linux only).
452 @item host:@var{vendor_id}:@var{product_id}
453 Pass through the host device identified by @var{vendor_id}:@var{product_id}
456 @item serial:[vendorid=@var{vendor_id}][,productid=@var{product_id}]:@var{dev}
457 Serial converter to host character device @var{dev}, see @code{-serial} for the
461 Braille device. This will use BrlAPI to display the braille output on a real
464 @item net:@var{options}
465 Network adapter that supports CDC ethernet and RNDIS protocols.
470 DEF("device
", HAS_ARG, QEMU_OPTION_device,
471 "-device driver
[,prop
[=value
][,...]]\n"
472 " add
device (based on driver
)\n"
473 " prop
=value
,... sets driver properties
\n"
474 " use
-device ? to print all possible drivers
\n"
475 " use
-device driver
,? to print all possible properties
\n",
478 @item -device @var{driver}[,@var{prop}[=@var{value}][,...]]
480 Add device @var{driver}. @var{prop}=@var{value} sets driver
481 properties. Valid properties depend on the driver. To get help on
482 possible drivers and properties, use @code{-device ?} and
483 @code{-device @var{driver},?}.
486 DEF("plug
", HAS_ARG, QEMU_OPTION_plug,
487 "-plug type
,id
=name
[,prop
[=value
][,...]]\n",
490 DEFHEADING(File system options:)
492 DEF("fsdev
", HAS_ARG, QEMU_OPTION_fsdev,
493 "-fsdev local
,id
=id
,path
=path
,security_model
=[mapped|passthrough|none
]\n",
498 The general form of a File system device option is:
501 @item -fsdev @var{fstype} ,id=@var{id} [,@var{options}]
505 The specific Fstype will determine the applicable options.
507 Options to each backend are described below.
509 @item -fsdev local ,id=@var{id} ,path=@var{path} ,security_model=@var{security_model}
511 Create a file-system-"device
" for local-filesystem.
513 @option{local} is only available on Linux.
515 @option{path} specifies the path to be exported. @option{path} is required.
517 @option{security_model} specifies the security model to be followed.
518 @option{security_model} is required.
523 DEFHEADING(Virtual File system pass-through options:)
525 DEF("virtfs
", HAS_ARG, QEMU_OPTION_virtfs,
526 "-virtfs local
,path
=path
,mount_tag
=tag
,security_model
=[mapped|passthrough|none
]\n",
531 The general form of a Virtual File system pass-through option is:
534 @item -virtfs @var{fstype} [,@var{options}]
538 The specific Fstype will determine the applicable options.
540 Options to each backend are described below.
542 @item -virtfs local ,path=@var{path} ,mount_tag=@var{mount_tag} ,security_model=@var{security_model}
544 Create a Virtual file-system-pass through for local-filesystem.
546 @option{local} is only available on Linux.
548 @option{path} specifies the path to be exported. @option{path} is required.
550 @option{security_model} specifies the security model to be followed.
551 @option{security_model} is required.
554 @option{mount_tag} specifies the tag with which the exported file is mounted.
555 @option{mount_tag} is required.
562 DEF("name
", HAS_ARG, QEMU_OPTION_name,
563 "-name string1
[,process
=string2
]\n"
564 " set the name of the guest
\n"
565 " string1 sets the window title and string2 the process
name (on Linux
)\n",
568 @item -name @var{name}
570 Sets the @var{name} of the guest.
571 This name will be displayed in the SDL window caption.
572 The @var{name} will also be used for the VNC server.
573 Also optionally set the top visible process name in Linux.
576 DEF("uuid
", HAS_ARG, QEMU_OPTION_uuid,
577 "-uuid
%08x
-%04x
-%04x
-%04x
-%012x
\n"
578 " specify machine UUID
\n", QEMU_ARCH_ALL)
580 @item -uuid @var{uuid}
591 DEFHEADING(Display options:)
597 DEF("display
", HAS_ARG, QEMU_OPTION_display,
598 "-display sdl
[,frame
=on|off
][,alt_grab
=on|off
][,ctrl_grab
=on|off
]\n"
599 " [,window_close
=on|off
]|curses|none|
\n"
600 " vnc
=<display
>[,<optargs
>]\n"
601 " select display type
\n", QEMU_ARCH_ALL)
603 @item -display @var{type}
605 Select type of display to use. This option is a replacement for the
606 old style -sdl/-curses/... options. Valid values for @var{type} are
609 Display video output via SDL (usually in a separate graphics
610 window; see the SDL documentation for other possibilities).
612 Display video output via curses. For graphics device models which
613 support a text mode, QEMU can display this output using a
614 curses/ncurses interface. Nothing is displayed when the graphics
615 device is in graphical mode or if the graphics device does not support
616 a text mode. Generally only the VGA device models support text mode.
618 Do not display video output. The guest will still see an emulated
619 graphics card, but its output will not be displayed to the QEMU
620 user. This option differs from the -nographic option in that it
621 only affects what is done with video output; -nographic also changes
622 the destination of the serial and parallel port data.
624 Start a VNC server on display <arg>
628 DEF("nographic
", 0, QEMU_OPTION_nographic,
629 "-nographic disable graphical output and redirect serial I
/Os to console
\n",
634 Normally, QEMU uses SDL to display the VGA output. With this option,
635 you can totally disable graphical output so that QEMU is a simple
636 command line application. The emulated serial port is redirected on
637 the console. Therefore, you can still use QEMU to debug a Linux kernel
638 with a serial console.
641 DEF("curses
", 0, QEMU_OPTION_curses,
642 "-curses use a curses
/ncurses
interface instead of SDL
\n",
647 Normally, QEMU uses SDL to display the VGA output. With this option,
648 QEMU can display the VGA output when in text mode using a
649 curses/ncurses interface. Nothing is displayed in graphical mode.
652 DEF("no
-frame
", 0, QEMU_OPTION_no_frame,
653 "-no
-frame open SDL window without a frame and window decorations
\n",
658 Do not use decorations for SDL windows and start them using the whole
659 available screen space. This makes the using QEMU in a dedicated desktop
660 workspace more convenient.
663 DEF("alt
-grab
", 0, QEMU_OPTION_alt_grab,
664 "-alt
-grab use Ctrl
-Alt
-Shift to grab
mouse (instead of Ctrl
-Alt
)\n",
669 Use Ctrl-Alt-Shift to grab mouse (instead of Ctrl-Alt). Note that this also
670 affects the special keys (for fullscreen, monitor-mode switching, etc).
673 DEF("ctrl
-grab
", 0, QEMU_OPTION_ctrl_grab,
674 "-ctrl
-grab use Right
-Ctrl to grab
mouse (instead of Ctrl
-Alt
)\n",
679 Use Right-Ctrl to grab mouse (instead of Ctrl-Alt). Note that this also
680 affects the special keys (for fullscreen, monitor-mode switching, etc).
683 DEF("no
-quit
", 0, QEMU_OPTION_no_quit,
684 "-no
-quit disable SDL window close capability
\n", QEMU_ARCH_ALL)
688 Disable SDL window close capability.
691 DEF("sdl
", 0, QEMU_OPTION_sdl,
692 "-sdl enable SDL
\n", QEMU_ARCH_ALL)
699 DEF("spice
", HAS_ARG, QEMU_OPTION_spice,
700 "-spice
<args
> enable spice
\n", QEMU_ARCH_ALL)
702 @item -spice @var{option}[,@var{option}[,...]]
704 Enable the spice remote desktop protocol. Valid options are
709 Set the TCP port spice is listening on for plaintext channels.
712 Set the IP address spice is listening on. Default is any address.
716 Force using the specified IP version.
718 @item password=<secret>
719 Set the password you need to authenticate.
722 Require that the client use SASL to authenticate with the spice.
723 The exact choice of authentication method used is controlled from the
724 system / user's SASL configuration file for the 'qemu' service. This
725 is typically found in /etc/sasl2/qemu.conf. If running QEMU as an
726 unprivileged user, an environment variable SASL_CONF_PATH can be used
727 to make it search alternate locations for the service config.
728 While some SASL auth methods can also provide data encryption (eg GSSAPI),
729 it is recommended that SASL always be combined with the 'tls' and
730 'x509' settings to enable use of SSL and server certificates. This
731 ensures a data encryption preventing compromise of authentication
734 @item disable-ticketing
735 Allow client connects without authentication.
737 @item disable-copy-paste
738 Disable copy paste between the client and the guest.
741 Set the TCP port spice is listening on for encrypted channels.
744 Set the x509 file directory. Expects same filenames as -vnc $display,x509=$dir
746 @item x509-key-file=<file>
747 @item x509-key-password=<file>
748 @item x509-cert-file=<file>
749 @item x509-cacert-file=<file>
750 @item x509-dh-key-file=<file>
751 The x509 file names can also be configured individually.
753 @item tls-ciphers=<list>
754 Specify which ciphers to use.
756 @item tls-channel=[main|display|inputs|record|playback|tunnel]
757 @item plaintext-channel=[main|display|inputs|record|playback|tunnel]
758 Force specific channel to be used with or without TLS encryption. The
759 options can be specified multiple times to configure multiple
760 channels. The special name "default" can be used to set the default
761 mode. For channels which are not explicitly forced into one mode the
762 spice client is allowed to pick tls/plaintext as he pleases.
764 @item image-compression=[auto_glz|auto_lz|quic|glz|lz|off]
765 Configure image compression (lossless).
768 @item jpeg-wan-compression=[auto|never|always]
769 @item zlib-glz-wan-compression=[auto|never|always]
770 Configure wan image compression (lossy for slow links).
773 @item streaming-video=[off|all|filter]
774 Configure video stream detection. Default is filter.
776 @item agent-mouse=[on|off]
777 Enable/disable passing mouse events via vdagent. Default is on.
779 @item playback-compression=[on|off]
780 Enable/disable audio stream compression (using celt 0.5.1). Default is on.
785 DEF("portrait
", 0, QEMU_OPTION_portrait,
786 "-portrait rotate graphical output
90 deg
left (only PXA LCD
)\n",
791 Rotate graphical output 90 deg left (only PXA LCD).
794 DEF("vga
", HAS_ARG, QEMU_OPTION_vga,
795 "-vga
[std|cirrus|vmware|qxl|xenfb|none
]\n"
796 " select video card type
\n", QEMU_ARCH_ALL)
798 @item -vga @var{type}
800 Select type of VGA card to emulate. Valid values for @var{type} are
803 Cirrus Logic GD5446 Video card. All Windows versions starting from
804 Windows 95 should recognize and use this graphic card. For optimal
805 performances, use 16 bit color depth in the guest and the host OS.
806 (This one is the default)
808 Standard VGA card with Bochs VBE extensions. If your guest OS
809 supports the VESA 2.0 VBE extensions (e.g. Windows XP) and if you want
810 to use high resolution modes (>= 1280x1024x16) then you should use
813 VMWare SVGA-II compatible adapter. Use it if you have sufficiently
814 recent XFree86/XOrg server or Windows guest with a driver for this
817 QXL paravirtual graphic card. It is VGA compatible (including VESA
818 2.0 VBE support). Works best with qxl guest drivers installed though.
819 Recommended choice when using the spice protocol.
825 DEF("full
-screen
", 0, QEMU_OPTION_full_screen,
826 "-full
-screen start
in full screen
\n", QEMU_ARCH_ALL)
830 Start in full screen.
833 DEF("g
", 1, QEMU_OPTION_g ,
834 "-g WxH
[xDEPTH
] Set the initial graphical resolution and depth
\n",
835 QEMU_ARCH_PPC | QEMU_ARCH_SPARC)
837 @item -g @var{width}x@var{height}[x@var{depth}]
839 Set the initial graphical resolution and depth (PPC, SPARC only).
842 DEF("vnc
", HAS_ARG, QEMU_OPTION_vnc ,
843 "-vnc display start a VNC server on display
\n", QEMU_ARCH_ALL)
845 @item -vnc @var{display}[,@var{option}[,@var{option}[,...]]]
847 Normally, QEMU uses SDL to display the VGA output. With this option,
848 you can have QEMU listen on VNC display @var{display} and redirect the VGA
849 display over the VNC session. It is very useful to enable the usb
850 tablet device when using this option (option @option{-usbdevice
851 tablet}). When using the VNC display, you must use the @option{-k}
852 parameter to set the keyboard layout if you are not using en-us. Valid
853 syntax for the @var{display} is
857 @item @var{host}:@var{d}
859 TCP connections will only be allowed from @var{host} on display @var{d}.
860 By convention the TCP port is 5900+@var{d}. Optionally, @var{host} can
861 be omitted in which case the server will accept connections from any host.
863 @item unix:@var{path}
865 Connections will be allowed over UNIX domain sockets where @var{path} is the
866 location of a unix socket to listen for connections on.
870 VNC is initialized but not started. The monitor @code{change} command
871 can be used to later start the VNC server.
875 Following the @var{display} value there may be one or more @var{option} flags
876 separated by commas. Valid options are
882 Connect to a listening VNC client via a ``reverse'' connection. The
883 client is specified by the @var{display}. For reverse network
884 connections (@var{host}:@var{d},@code{reverse}), the @var{d} argument
885 is a TCP port number, not a display number.
889 Require that password based authentication is used for client connections.
890 The password must be set separately using the @code{change} command in the
895 Require that client use TLS when communicating with the VNC server. This
896 uses anonymous TLS credentials so is susceptible to a man-in-the-middle
897 attack. It is recommended that this option be combined with either the
898 @option{x509} or @option{x509verify} options.
900 @item x509=@var{/path/to/certificate/dir}
902 Valid if @option{tls} is specified. Require that x509 credentials are used
903 for negotiating the TLS session. The server will send its x509 certificate
904 to the client. It is recommended that a password be set on the VNC server
905 to provide authentication of the client when this is used. The path following
906 this option specifies where the x509 certificates are to be loaded from.
907 See the @ref{vnc_security} section for details on generating certificates.
909 @item x509verify=@var{/path/to/certificate/dir}
911 Valid if @option{tls} is specified. Require that x509 credentials are used
912 for negotiating the TLS session. The server will send its x509 certificate
913 to the client, and request that the client send its own x509 certificate.
914 The server will validate the client's certificate against the CA certificate,
915 and reject clients when validation fails. If the certificate authority is
916 trusted, this is a sufficient authentication mechanism. You may still wish
917 to set a password on the VNC server as a second authentication layer. The
918 path following this option specifies where the x509 certificates are to
919 be loaded from. See the @ref{vnc_security} section for details on generating
924 Require that the client use SASL to authenticate with the VNC server.
925 The exact choice of authentication method used is controlled from the
926 system / user's SASL configuration file for the 'qemu' service. This
927 is typically found in /etc/sasl2/qemu.conf. If running QEMU as an
928 unprivileged user, an environment variable SASL_CONF_PATH can be used
929 to make it search alternate locations for the service config.
930 While some SASL auth methods can also provide data encryption (eg GSSAPI),
931 it is recommended that SASL always be combined with the 'tls' and
932 'x509' settings to enable use of SSL and server certificates. This
933 ensures a data encryption preventing compromise of authentication
934 credentials. See the @ref{vnc_security} section for details on using
939 Turn on access control lists for checking of the x509 client certificate
940 and SASL party. For x509 certs, the ACL check is made against the
941 certificate's distinguished name. This is something that looks like
942 @code{C=GB,O=ACME,L=Boston,CN=bob}. For SASL party, the ACL check is
943 made against the username, which depending on the SASL plugin, may
944 include a realm component, eg @code{bob} or @code{bob@@EXAMPLE.COM}.
945 When the @option{acl} flag is set, the initial access list will be
946 empty, with a @code{deny} policy. Thus no one will be allowed to
947 use the VNC server until the ACLs have been loaded. This can be
948 achieved using the @code{acl} monitor command.
952 Enable lossy compression methods (gradient, JPEG, ...). If this
953 option is set, VNC client may receive lossy framebuffer updates
954 depending on its encoding settings. Enabling this option can save
955 a lot of bandwidth at the expense of quality.
959 Disable adaptive encodings. Adaptive encodings are enabled by default.
960 An adaptive encoding will try to detect frequently updated screen regions,
961 and send updates in these regions using a lossy encoding (like JPEG).
962 This can be really helpful to save bandwidth when playing videos. Disabling
963 adaptive encodings allows to restore the original static behavior of encodings
975 DEFHEADING(i386 target only:)
980 DEF("win2k
-hack
", 0, QEMU_OPTION_win2k_hack,
981 "-win2k
-hack use it when installing Windows
2000 to avoid a disk full bug
\n",
986 Use it when installing Windows 2000 to avoid a disk full bug. After
987 Windows 2000 is installed, you no longer need this option (this option
988 slows down the IDE transfers).
991 HXCOMM Deprecated by -rtc
992 DEF("rtc
-td
-hack
", 0, QEMU_OPTION_rtc_td_hack, "", QEMU_ARCH_I386)
994 DEF("no
-fd
-bootchk
", 0, QEMU_OPTION_no_fd_bootchk,
995 "-no
-fd
-bootchk disable boot signature checking
for floppy disks
\n",
999 @findex -no-fd-bootchk
1000 Disable boot signature checking for floppy disks in Bochs BIOS. It may
1001 be needed to boot from old floppy disks.
1002 TODO: check reference to Bochs BIOS.
1005 DEF("no
-acpi
", 0, QEMU_OPTION_no_acpi,
1006 "-no
-acpi disable ACPI
\n", QEMU_ARCH_I386)
1010 Disable ACPI (Advanced Configuration and Power Interface) support. Use
1011 it if your guest OS complains about ACPI problems (PC target machine
1015 DEF("no
-hpet
", 0, QEMU_OPTION_no_hpet,
1016 "-no
-hpet disable HPET
\n", QEMU_ARCH_I386)
1020 Disable HPET support.
1023 DEF("balloon
", HAS_ARG, QEMU_OPTION_balloon,
1024 "-balloon none disable balloon device
\n"
1025 "-balloon virtio
[,addr
=str
]\n"
1026 " enable virtio balloon
device (default)\n", QEMU_ARCH_ALL)
1030 Disable balloon device.
1031 @item -balloon virtio[,addr=@var{addr}]
1032 Enable virtio balloon device (default), optionally with PCI address
1036 DEF("acpitable
", HAS_ARG, QEMU_OPTION_acpitable,
1037 "-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"
1038 " ACPI table description
\n", QEMU_ARCH_I386)
1040 @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}]...]
1042 Add ACPI table with specified header fields and context from specified files.
1045 DEF("smbios
", HAS_ARG, QEMU_OPTION_smbios,
1046 "-smbios file
=binary
\n"
1047 " load SMBIOS entry from binary file
\n"
1048 "-smbios type
=0[,vendor
=str
][,version
=str
][,date
=str
][,release
=%d
.%d
]\n"
1049 " specify SMBIOS type
0 fields
\n"
1050 "-smbios type
=1[,manufacturer
=str
][,product
=str
][,version
=str
][,serial
=str
]\n"
1051 " [,uuid
=uuid
][,sku
=str
][,family
=str
]\n"
1052 " specify SMBIOS type
1 fields
\n", QEMU_ARCH_I386)
1054 @item -smbios file=@var{binary}
1056 Load SMBIOS entry from binary file.
1058 @item -smbios type=0[,vendor=@var{str}][,version=@var{str}][,date=@var{str}][,release=@var{%d.%d}]
1060 Specify SMBIOS type 0 fields
1062 @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}]
1063 Specify SMBIOS type 1 fields
1071 DEFHEADING(Network options:)
1076 HXCOMM Legacy slirp options (now moved to -net user):
1078 DEF("tftp
", HAS_ARG, QEMU_OPTION_tftp, "", QEMU_ARCH_ALL)
1079 DEF("bootp
", HAS_ARG, QEMU_OPTION_bootp, "", QEMU_ARCH_ALL)
1080 DEF("redir
", HAS_ARG, QEMU_OPTION_redir, "", QEMU_ARCH_ALL)
1082 DEF("smb
", HAS_ARG, QEMU_OPTION_smb, "", QEMU_ARCH_ALL)
1086 DEF("net
", HAS_ARG, QEMU_OPTION_net,
1087 "-net nic
[,vlan
=n
][,macaddr
=mac
][,model
=type
][,name
=str
][,addr
=str
][,vectors
=v
]\n"
1088 " create a
new Network Interface Card and connect it to VLAN
'n'\n"
1090 "-net user
[,vlan
=n
][,name
=str
][,net
=addr
[/mask
]][,host
=addr
][,restrict
=y|n
]\n"
1091 " [,hostname
=host
][,dhcpstart
=addr
][,dns
=addr
][,tftp
=dir
][,bootfile
=f
]\n"
1092 " [,hostfwd
=rule
][,guestfwd
=rule
]"
1094 "[,smb
=dir
[,smbserver
=addr
]]\n"
1096 " connect the user mode network stack to VLAN
'n', configure its
\n"
1097 " DHCP server and enabled optional services
\n"
1100 "-net tap
[,vlan
=n
][,name
=str
],ifname
=name
\n"
1101 " connect the host TAP network
interface to VLAN
'n'\n"
1103 "-net tap
[,vlan
=n
][,name
=str
][,fd
=h
][,ifname
=name
][,script
=file
][,downscript
=dfile
][,sndbuf
=nbytes
][,vnet_hdr
=on|off
][,vhost
=on|off
][,vhostfd
=h
][,vhostforce
=on|off
]\n"
1104 " connect the host TAP network
interface to VLAN
'n' and use the
\n"
1105 " network scripts
'file' (default=" DEFAULT_NETWORK_SCRIPT ")\n"
1106 " and
'dfile' (default=" DEFAULT_NETWORK_DOWN_SCRIPT ")\n"
1107 " use
'[down]script=no' to disable script execution
\n"
1108 " use
'fd=h' to connect to an already opened TAP
interface\n"
1109 " use
'sndbuf=nbytes' to limit the size of the send
buffer (the
\n"
1110 " default is disabled
'sndbuf=0' to enable flow control set
'sndbuf=1048576')\n"
1111 " use vnet_hdr
=off to avoid enabling the IFF_VNET_HDR tap flag
\n"
1112 " use vnet_hdr
=on to make the lack of IFF_VNET_HDR support an error condition
\n"
1113 " use vhost
=on to enable experimental
in kernel accelerator
\n"
1114 " (only has effect
for virtio guests which use MSIX
)\n"
1115 " use vhostforce
=on to force vhost on
for non
-MSIX virtio guests
\n"
1116 " use
'vhostfd=h' to connect to an already opened vhost net device
\n"
1118 "-net socket
[,vlan
=n
][,name
=str
][,fd
=h
][,listen
=[host
]:port
][,connect
=host
:port
]\n"
1119 " connect the vlan
'n' to another VLAN
using a socket connection
\n"
1120 "-net socket
[,vlan
=n
][,name
=str
][,fd
=h
][,mcast
=maddr
:port
[,localaddr
=addr
]]\n"
1121 " connect the vlan
'n' to multicast maddr and port
\n"
1122 " use
'localaddr=addr' to specify the host address to send packets from
\n"
1124 "-net vde
[,vlan
=n
][,name
=str
][,sock
=socketpath
][,port
=n
][,group
=groupname
][,mode
=octalmode
]\n"
1125 " connect the vlan
'n' to port
'n' of a vde
switch running
\n"
1126 " on host and listening
for incoming connections on
'socketpath'.\n"
1127 " Use group
'groupname' and mode
'octalmode' to change
default\n"
1128 " ownership and permissions
for communication port
.\n"
1130 "-net dump
[,vlan
=n
][,file
=f
][,len
=n
]\n"
1131 " dump traffic on vlan
'n' to file
'f' (max n bytes per packet
)\n"
1132 "-net none use it alone to have zero network devices
. If no
-net option
\n"
1133 " is provided
, the
default is
'-net nic -net user'\n", QEMU_ARCH_ALL)
1134 DEF("netdev
", HAS_ARG, QEMU_OPTION_netdev,
1143 "socket
],id
=str
[,option
][,option
][,...]\n", QEMU_ARCH_ALL)
1145 @item -net nic[,vlan=@var{n}][,macaddr=@var{mac}][,model=@var{type}] [,name=@var{name}][,addr=@var{addr}][,vectors=@var{v}]
1147 Create a new Network Interface Card and connect it to VLAN @var{n} (@var{n}
1148 = 0 is the default). The NIC is an e1000 by default on the PC
1149 target. Optionally, the MAC address can be changed to @var{mac}, the
1150 device address set to @var{addr} (PCI cards only),
1151 and a @var{name} can be assigned for use in monitor commands.
1152 Optionally, for PCI cards, you can specify the number @var{v} of MSI-X vectors
1153 that the card should have; this option currently only affects virtio cards; set
1154 @var{v} = 0 to disable MSI-X. If no @option{-net} option is specified, a single
1155 NIC is created. Qemu can emulate several different models of network card.
1156 Valid values for @var{type} are
1157 @code{virtio}, @code{i82551}, @code{i82557b}, @code{i82559er},
1158 @code{ne2k_pci}, @code{ne2k_isa}, @code{pcnet}, @code{rtl8139},
1159 @code{e1000}, @code{smc91c111}, @code{lance} and @code{mcf_fec}.
1160 Not all devices are supported on all targets. Use -net nic,model=?
1161 for a list of available devices for your target.
1163 @item -net user[,@var{option}][,@var{option}][,...]
1164 Use the user mode network stack which requires no administrator
1165 privilege to run. Valid options are:
1169 Connect user mode stack to VLAN @var{n} (@var{n} = 0 is the default).
1171 @item name=@var{name}
1172 Assign symbolic name for use in monitor commands.
1174 @item net=@var{addr}[/@var{mask}]
1175 Set IP network address the guest will see. Optionally specify the netmask,
1176 either in the form a.b.c.d or as number of valid top-most bits. Default is
1179 @item host=@var{addr}
1180 Specify the guest-visible address of the host. Default is the 2nd IP in the
1181 guest network, i.e. x.x.x.2.
1183 @item restrict=y|yes|n|no
1184 If this option is enabled, the guest will be isolated, i.e. it will not be
1185 able to contact the host and no guest IP packets will be routed over the host
1186 to the outside. This option does not affect any explicitly set forwarding rules.
1188 @item hostname=@var{name}
1189 Specifies the client hostname reported by the builtin DHCP server.
1191 @item dhcpstart=@var{addr}
1192 Specify the first of the 16 IPs the built-in DHCP server can assign. Default
1193 is the 15th to 31st IP in the guest network, i.e. x.x.x.15 to x.x.x.31.
1195 @item dns=@var{addr}
1196 Specify the guest-visible address of the virtual nameserver. The address must
1197 be different from the host address. Default is the 3rd IP in the guest network,
1200 @item tftp=@var{dir}
1201 When using the user mode network stack, activate a built-in TFTP
1202 server. The files in @var{dir} will be exposed as the root of a TFTP server.
1203 The TFTP client on the guest must be configured in binary mode (use the command
1204 @code{bin} of the Unix TFTP client).
1206 @item bootfile=@var{file}
1207 When using the user mode network stack, broadcast @var{file} as the BOOTP
1208 filename. In conjunction with @option{tftp}, this can be used to network boot
1209 a guest from a local directory.
1211 Example (using pxelinux):
1213 qemu -hda linux.img -boot n -net user,tftp=/path/to/tftp/files,bootfile=/pxelinux.0
1216 @item smb=@var{dir}[,smbserver=@var{addr}]
1217 When using the user mode network stack, activate a built-in SMB
1218 server so that Windows OSes can access to the host files in @file{@var{dir}}
1219 transparently. The IP address of the SMB server can be set to @var{addr}. By
1220 default the 4th IP in the guest network is used, i.e. x.x.x.4.
1222 In the guest Windows OS, the line:
1226 must be added in the file @file{C:\WINDOWS\LMHOSTS} (for windows 9x/Me)
1227 or @file{C:\WINNT\SYSTEM32\DRIVERS\ETC\LMHOSTS} (Windows NT/2000).
1229 Then @file{@var{dir}} can be accessed in @file{\\smbserver\qemu}.
1231 Note that a SAMBA server must be installed on the host OS in
1232 @file{/usr/sbin/smbd}. QEMU was tested successfully with smbd versions from
1233 Red Hat 9, Fedora Core 3 and OpenSUSE 11.x.
1235 @item hostfwd=[tcp|udp]:[@var{hostaddr}]:@var{hostport}-[@var{guestaddr}]:@var{guestport}
1236 Redirect incoming TCP or UDP connections to the host port @var{hostport} to
1237 the guest IP address @var{guestaddr} on guest port @var{guestport}. If
1238 @var{guestaddr} is not specified, its value is x.x.x.15 (default first address
1239 given by the built-in DHCP server). By specifying @var{hostaddr}, the rule can
1240 be bound to a specific host interface. If no connection type is set, TCP is
1241 used. This option can be given multiple times.
1243 For example, to redirect host X11 connection from screen 1 to guest
1244 screen 0, use the following:
1248 qemu -net user,hostfwd=tcp:127.0.0.1:6001-:6000 [...]
1249 # this host xterm should open in the guest X11 server
1253 To redirect telnet connections from host port 5555 to telnet port on
1254 the guest, use the following:
1258 qemu -net user,hostfwd=tcp::5555-:23 [...]
1259 telnet localhost 5555
1262 Then when you use on the host @code{telnet localhost 5555}, you
1263 connect to the guest telnet server.
1265 @item guestfwd=[tcp]:@var{server}:@var{port}-@var{dev}
1266 Forward guest TCP connections to the IP address @var{server} on port @var{port}
1267 to the character device @var{dev}. This option can be given multiple times.
1271 Note: Legacy stand-alone options -tftp, -bootp, -smb and -redir are still
1272 processed and applied to -net user. Mixing them with the new configuration
1273 syntax gives undefined results. Their use for new applications is discouraged
1274 as they will be removed from future versions.
1276 @item -net tap[,vlan=@var{n}][,name=@var{name}][,fd=@var{h}][,ifname=@var{name}] [,script=@var{file}][,downscript=@var{dfile}]
1277 Connect the host TAP network interface @var{name} to VLAN @var{n}, use
1278 the network script @var{file} to configure it and the network script
1279 @var{dfile} to deconfigure it. If @var{name} is not provided, the OS
1280 automatically provides one. @option{fd}=@var{h} can be used to specify
1281 the handle of an already opened host TAP interface. The default network
1282 configure script is @file{/etc/qemu-ifup} and the default network
1283 deconfigure script is @file{/etc/qemu-ifdown}. Use @option{script=no}
1284 or @option{downscript=no} to disable script execution. Example:
1287 qemu linux.img -net nic -net tap
1290 More complicated example (two NICs, each one connected to a TAP device)
1292 qemu linux.img -net nic,vlan=0 -net tap,vlan=0,ifname=tap0 \
1293 -net nic,vlan=1 -net tap,vlan=1,ifname=tap1
1296 @item -net socket[,vlan=@var{n}][,name=@var{name}][,fd=@var{h}] [,listen=[@var{host}]:@var{port}][,connect=@var{host}:@var{port}]
1298 Connect the VLAN @var{n} to a remote VLAN in another QEMU virtual
1299 machine using a TCP socket connection. If @option{listen} is
1300 specified, QEMU waits for incoming connections on @var{port}
1301 (@var{host} is optional). @option{connect} is used to connect to
1302 another QEMU instance using the @option{listen} option. @option{fd}=@var{h}
1303 specifies an already opened TCP socket.
1307 # launch a first QEMU instance
1308 qemu linux.img -net nic,macaddr=52:54:00:12:34:56 \
1309 -net socket,listen=:1234
1310 # connect the VLAN 0 of this instance to the VLAN 0
1311 # of the first instance
1312 qemu linux.img -net nic,macaddr=52:54:00:12:34:57 \
1313 -net socket,connect=127.0.0.1:1234
1316 @item -net socket[,vlan=@var{n}][,name=@var{name}][,fd=@var{h}][,mcast=@var{maddr}:@var{port}[,localaddr=@var{addr}]]
1318 Create a VLAN @var{n} shared with another QEMU virtual
1319 machines using a UDP multicast socket, effectively making a bus for
1320 every QEMU with same multicast address @var{maddr} and @var{port}.
1324 Several QEMU can be running on different hosts and share same bus (assuming
1325 correct multicast setup for these hosts).
1327 mcast support is compatible with User Mode Linux (argument @option{eth@var{N}=mcast}), see
1328 @url{http://user-mode-linux.sf.net}.
1330 Use @option{fd=h} to specify an already opened UDP multicast socket.
1335 # launch one QEMU instance
1336 qemu linux.img -net nic,macaddr=52:54:00:12:34:56 \
1337 -net socket,mcast=230.0.0.1:1234
1338 # launch another QEMU instance on same "bus
"
1339 qemu linux.img -net nic,macaddr=52:54:00:12:34:57 \
1340 -net socket,mcast=230.0.0.1:1234
1341 # launch yet another QEMU instance on same "bus
"
1342 qemu linux.img -net nic,macaddr=52:54:00:12:34:58 \
1343 -net socket,mcast=230.0.0.1:1234
1346 Example (User Mode Linux compat.):
1348 # launch QEMU instance (note mcast address selected
1350 qemu linux.img -net nic,macaddr=52:54:00:12:34:56 \
1351 -net socket,mcast=239.192.168.1:1102
1353 /path/to/linux ubd0=/path/to/root_fs eth0=mcast
1356 Example (send packets from host's 1.2.3.4):
1358 qemu linux.img -net nic,macaddr=52:54:00:12:34:56 \
1359 -net socket,mcast=239.192.168.1:1102,localaddr=1.2.3.4
1362 @item -net vde[,vlan=@var{n}][,name=@var{name}][,sock=@var{socketpath}] [,port=@var{n}][,group=@var{groupname}][,mode=@var{octalmode}]
1363 Connect VLAN @var{n} to PORT @var{n} of a vde switch running on host and
1364 listening for incoming connections on @var{socketpath}. Use GROUP @var{groupname}
1365 and MODE @var{octalmode} to change default ownership and permissions for
1366 communication port. This option is available only if QEMU has been compiled
1367 with vde support enabled.
1372 vde_switch -F -sock /tmp/myswitch
1373 # launch QEMU instance
1374 qemu linux.img -net nic -net vde,sock=/tmp/myswitch
1377 @item -net dump[,vlan=@var{n}][,file=@var{file}][,len=@var{len}]
1378 Dump network traffic on VLAN @var{n} to file @var{file} (@file{qemu-vlan0.pcap} by default).
1379 At most @var{len} bytes (64k by default) per packet are stored. The file format is
1380 libpcap, so it can be analyzed with tools such as tcpdump or Wireshark.
1383 Indicate that no network devices should be configured. It is used to
1384 override the default configuration (@option{-net nic -net user}) which
1385 is activated if no @option{-net} options are provided.
1392 DEFHEADING(Character device options:)
1394 DEF("chardev
", HAS_ARG, QEMU_OPTION_chardev,
1395 "-chardev
null,id
=id
[,mux
=on|off
]\n"
1396 "-chardev socket
,id
=id
[,host
=host
],port
=host
[,to
=to
][,ipv4
][,ipv6
][,nodelay
]\n"
1397 " [,server
][,nowait
][,telnet
][,mux
=on|off
] (tcp
)\n"
1398 "-chardev socket
,id
=id
,path
=path
[,server
][,nowait
][,telnet
],[mux
=on|off
] (unix
)\n"
1399 "-chardev udp
,id
=id
[,host
=host
],port
=port
[,localaddr
=localaddr
]\n"
1400 " [,localport
=localport
][,ipv4
][,ipv6
][,mux
=on|off
]\n"
1401 "-chardev msmouse
,id
=id
[,mux
=on|off
]\n"
1402 "-chardev vc
,id
=id
[[,width
=width
][,height
=height
]][[,cols
=cols
][,rows
=rows
]]\n"
1404 "-chardev file
,id
=id
,path
=path
[,mux
=on|off
]\n"
1405 "-chardev pipe
,id
=id
,path
=path
[,mux
=on|off
]\n"
1407 "-chardev console
,id
=id
[,mux
=on|off
]\n"
1408 "-chardev serial
,id
=id
,path
=path
[,mux
=on|off
]\n"
1410 "-chardev pty
,id
=id
[,mux
=on|off
]\n"
1411 "-chardev stdio
,id
=id
[,mux
=on|off
][,signal
=on|off
]\n"
1413 #ifdef CONFIG_BRLAPI
1414 "-chardev braille
,id
=id
[,mux
=on|off
]\n"
1416 #if defined(__linux__) || defined(__sun__) || defined(__FreeBSD__) \
1417 || defined(__NetBSD__) || defined(__OpenBSD__) || defined(__DragonFly__)
1418 "-chardev tty
,id
=id
,path
=path
[,mux
=on|off
]\n"
1420 #if defined(__linux__) || defined(__FreeBSD__) || defined(__DragonFly__)
1421 "-chardev parport
,id
=id
,path
=path
[,mux
=on|off
]\n"
1423 #if defined(CONFIG_SPICE)
1424 "-chardev spicevmc
,id
=id
,name
=name
[,debug
=debug
]\n"
1431 The general form of a character device option is:
1434 @item -chardev @var{backend} ,id=@var{id} [,mux=on|off] [,@var{options}]
1452 The specific backend will determine the applicable options.
1454 All devices must have an id, which can be any string up to 127 characters long.
1455 It is used to uniquely identify this device in other command line directives.
1457 A character device may be used in multiplexing mode by multiple front-ends.
1458 The key sequence of @key{Control-a} and @key{c} will rotate the input focus
1459 between attached front-ends. Specify @option{mux=on} to enable this mode.
1461 Options to each backend are described below.
1463 @item -chardev null ,id=@var{id}
1464 A void device. This device will not emit any data, and will drop any data it
1465 receives. The null backend does not take any options.
1467 @item -chardev socket ,id=@var{id} [@var{TCP options} or @var{unix options}] [,server] [,nowait] [,telnet]
1469 Create a two-way stream socket, which can be either a TCP or a unix socket. A
1470 unix socket will be created if @option{path} is specified. Behaviour is
1471 undefined if TCP options are specified for a unix socket.
1473 @option{server} specifies that the socket shall be a listening socket.
1475 @option{nowait} specifies that QEMU should not block waiting for a client to
1476 connect to a listening socket.
1478 @option{telnet} specifies that traffic on the socket should interpret telnet
1481 TCP and unix socket options are given below:
1485 @item TCP options: port=@var{port} [,host=@var{host}] [,to=@var{to}] [,ipv4] [,ipv6] [,nodelay]
1487 @option{host} for a listening socket specifies the local address to be bound.
1488 For a connecting socket species the remote host to connect to. @option{host} is
1489 optional for listening sockets. If not specified it defaults to @code{0.0.0.0}.
1491 @option{port} for a listening socket specifies the local port to be bound. For a
1492 connecting socket specifies the port on the remote host to connect to.
1493 @option{port} can be given as either a port number or a service name.
1494 @option{port} is required.
1496 @option{to} is only relevant to listening sockets. If it is specified, and
1497 @option{port} cannot be bound, QEMU will attempt to bind to subsequent ports up
1498 to and including @option{to} until it succeeds. @option{to} must be specified
1501 @option{ipv4} and @option{ipv6} specify that either IPv4 or IPv6 must be used.
1502 If neither is specified the socket may use either protocol.
1504 @option{nodelay} disables the Nagle algorithm.
1506 @item unix options: path=@var{path}
1508 @option{path} specifies the local path of the unix socket. @option{path} is
1513 @item -chardev udp ,id=@var{id} [,host=@var{host}] ,port=@var{port} [,localaddr=@var{localaddr}] [,localport=@var{localport}] [,ipv4] [,ipv6]
1515 Sends all traffic from the guest to a remote host over UDP.
1517 @option{host} specifies the remote host to connect to. If not specified it
1518 defaults to @code{localhost}.
1520 @option{port} specifies the port on the remote host to connect to. @option{port}
1523 @option{localaddr} specifies the local address to bind to. If not specified it
1524 defaults to @code{0.0.0.0}.
1526 @option{localport} specifies the local port to bind to. If not specified any
1527 available local port will be used.
1529 @option{ipv4} and @option{ipv6} specify that either IPv4 or IPv6 must be used.
1530 If neither is specified the device may use either protocol.
1532 @item -chardev msmouse ,id=@var{id}
1534 Forward QEMU's emulated msmouse events to the guest. @option{msmouse} does not
1537 @item -chardev vc ,id=@var{id} [[,width=@var{width}] [,height=@var{height}]] [[,cols=@var{cols}] [,rows=@var{rows}]]
1539 Connect to a QEMU text console. @option{vc} may optionally be given a specific
1542 @option{width} and @option{height} specify the width and height respectively of
1543 the console, in pixels.
1545 @option{cols} and @option{rows} specify that the console be sized to fit a text
1546 console with the given dimensions.
1548 @item -chardev file ,id=@var{id} ,path=@var{path}
1550 Log all traffic received from the guest to a file.
1552 @option{path} specifies the path of the file to be opened. This file will be
1553 created if it does not already exist, and overwritten if it does. @option{path}
1556 @item -chardev pipe ,id=@var{id} ,path=@var{path}
1558 Create a two-way connection to the guest. The behaviour differs slightly between
1559 Windows hosts and other hosts:
1561 On Windows, a single duplex pipe will be created at
1562 @file{\\.pipe\@option{path}}.
1564 On other hosts, 2 pipes will be created called @file{@option{path}.in} and
1565 @file{@option{path}.out}. Data written to @file{@option{path}.in} will be
1566 received by the guest. Data written by the guest can be read from
1567 @file{@option{path}.out}. QEMU will not create these fifos, and requires them to
1570 @option{path} forms part of the pipe path as described above. @option{path} is
1573 @item -chardev console ,id=@var{id}
1575 Send traffic from the guest to QEMU's standard output. @option{console} does not
1578 @option{console} is only available on Windows hosts.
1580 @item -chardev serial ,id=@var{id} ,path=@option{path}
1582 Send traffic from the guest to a serial device on the host.
1585 only available on Windows hosts.
1587 @option{path} specifies the name of the serial device to open.
1589 @item -chardev pty ,id=@var{id}
1591 Create a new pseudo-terminal on the host and connect to it. @option{pty} does
1592 not take any options.
1594 @option{pty} is not available on Windows hosts.
1596 @item -chardev stdio ,id=@var{id} [,signal=on|off]
1597 Connect to standard input and standard output of the qemu process.
1599 @option{signal} controls if signals are enabled on the terminal, that includes
1600 exiting QEMU with the key sequence @key{Control-c}. This option is enabled by
1601 default, use @option{signal=off} to disable it.
1603 @option{stdio} is not available on Windows hosts.
1605 @item -chardev braille ,id=@var{id}
1607 Connect to a local BrlAPI server. @option{braille} does not take any options.
1609 @item -chardev tty ,id=@var{id} ,path=@var{path}
1611 Connect to a local tty device.
1613 @option{tty} is only available on Linux, Sun, FreeBSD, NetBSD, OpenBSD and
1616 @option{path} specifies the path to the tty. @option{path} is required.
1618 @item -chardev parport ,id=@var{id} ,path=@var{path}
1620 @option{parport} is only available on Linux, FreeBSD and DragonFlyBSD hosts.
1622 Connect to a local parallel port.
1624 @option{path} specifies the path to the parallel port device. @option{path} is
1627 #if defined(CONFIG_SPICE)
1628 @item -chardev spicevmc ,id=@var{id} ,debug=@var{debug}, name=@var{name}
1630 @option{debug} debug level for spicevmc
1632 @option{name} name of spice channel to connect to
1634 Connect to a spice virtual machine channel, such as vdiport.
1642 DEFHEADING(Bluetooth(R) options:)
1644 DEF("bt
", HAS_ARG, QEMU_OPTION_bt, \
1645 "-bt hci
,null dumb bluetooth HCI
- doesn
't respond to commands\n" \
1646 "-bt hci,host[:id]\n" \
1647 " use host's HCI with the given name
\n" \
1648 "-bt hci
[,vlan
=n
]\n" \
1649 " emulate a standard HCI
in virtual scatternet
'n'\n" \
1650 "-bt vhci
[,vlan
=n
]\n" \
1651 " add host computer to virtual scatternet
'n' using VHCI
\n" \
1652 "-bt device
:dev
[,vlan
=n
]\n" \
1653 " emulate a bluetooth device
'dev' in scatternet
'n'\n",
1660 Defines the function of the corresponding Bluetooth HCI. -bt options
1661 are matched with the HCIs present in the chosen machine type. For
1662 example when emulating a machine with only one HCI built into it, only
1663 the first @code{-bt hci[...]} option is valid and defines the HCI's
1664 logic. The Transport Layer is decided by the machine type. Currently
1665 the machines @code{n800} and @code{n810} have one HCI and all other
1669 The following three types are recognized:
1673 (default) The corresponding Bluetooth HCI assumes no internal logic
1674 and will not respond to any HCI commands or emit events.
1676 @item -bt hci,host[:@var{id}]
1677 (@code{bluez} only) The corresponding HCI passes commands / events
1678 to / from the physical HCI identified by the name @var{id} (default:
1679 @code{hci0}) on the computer running QEMU. Only available on @code{bluez}
1680 capable systems like Linux.
1682 @item -bt hci[,vlan=@var{n}]
1683 Add a virtual, standard HCI that will participate in the Bluetooth
1684 scatternet @var{n} (default @code{0}). Similarly to @option{-net}
1685 VLANs, devices inside a bluetooth network @var{n} can only communicate
1686 with other devices in the same network (scatternet).
1689 @item -bt vhci[,vlan=@var{n}]
1690 (Linux-host only) Create a HCI in scatternet @var{n} (default 0) attached
1691 to the host bluetooth stack instead of to the emulated target. This
1692 allows the host and target machines to participate in a common scatternet
1693 and communicate. Requires the Linux @code{vhci} driver installed. Can
1694 be used as following:
1697 qemu [...OPTIONS...] -bt hci,vlan=5 -bt vhci,vlan=5
1700 @item -bt device:@var{dev}[,vlan=@var{n}]
1701 Emulate a bluetooth device @var{dev} and place it in network @var{n}
1702 (default @code{0}). QEMU can only emulate one type of bluetooth devices
1707 Virtual wireless keyboard implementing the HIDP bluetooth profile.
1714 DEFHEADING(Linux/Multiboot boot specific:)
1717 When using these options, you can use a given Linux or Multiboot
1718 kernel without installing it in the disk image. It can be useful
1719 for easier testing of various kernels.
1724 DEF("kernel
", HAS_ARG, QEMU_OPTION_kernel, \
1725 "-kernel bzImage use
'bzImage' as kernel image
\n", QEMU_ARCH_ALL)
1727 @item -kernel @var{bzImage}
1729 Use @var{bzImage} as kernel image. The kernel can be either a Linux kernel
1730 or in multiboot format.
1733 DEF("append
", HAS_ARG, QEMU_OPTION_append, \
1734 "-append cmdline use
'cmdline' as kernel command line
\n", QEMU_ARCH_ALL)
1736 @item -append @var{cmdline}
1738 Use @var{cmdline} as kernel command line
1741 DEF("initrd
", HAS_ARG, QEMU_OPTION_initrd, \
1742 "-initrd file use
'file' as initial ram disk
\n", QEMU_ARCH_ALL)
1744 @item -initrd @var{file}
1746 Use @var{file} as initial ram disk.
1748 @item -initrd "@
var{file1
} arg
=foo
,@
var{file2
}"
1750 This syntax is only available with multiboot.
1752 Use @var{file1} and @var{file2} as modules and pass arg=foo as parameter to the
1762 DEFHEADING(Debug/Expert options:)
1768 DEF("serial
", HAS_ARG, QEMU_OPTION_serial, \
1769 "-serial dev redirect the serial port to char device
'dev'\n",
1772 @item -serial @var{dev}
1774 Redirect the virtual serial port to host character device
1775 @var{dev}. The default device is @code{vc} in graphical mode and
1776 @code{stdio} in non graphical mode.
1778 This option can be used several times to simulate up to 4 serial
1781 Use @code{-serial none} to disable all serial ports.
1783 Available character devices are:
1785 @item vc[:@var{W}x@var{H}]
1786 Virtual console. Optionally, a width and height can be given in pixel with
1790 It is also possible to specify width or height in characters:
1795 [Linux only] Pseudo TTY (a new PTY is automatically allocated)
1797 No device is allocated.
1801 [Linux only] Use host tty, e.g. @file{/dev/ttyS0}. The host serial port
1802 parameters are set according to the emulated ones.
1803 @item /dev/parport@var{N}
1804 [Linux only, parallel port only] Use host parallel port
1805 @var{N}. Currently SPP and EPP parallel port features can be used.
1806 @item file:@var{filename}
1807 Write output to @var{filename}. No character can be read.
1809 [Unix only] standard input/output
1810 @item pipe:@var{filename}
1811 name pipe @var{filename}
1813 [Windows only] Use host serial port @var{n}
1814 @item udp:[@var{remote_host}]:@var{remote_port}[@@[@var{src_ip}]:@var{src_port}]
1815 This implements UDP Net Console.
1816 When @var{remote_host} or @var{src_ip} are not specified
1817 they default to @code{0.0.0.0}.
1818 When not using a specified @var{src_port} a random port is automatically chosen.
1820 If you just want a simple readonly console you can use @code{netcat} or
1821 @code{nc}, by starting qemu with: @code{-serial udp::4555} and nc as:
1822 @code{nc -u -l -p 4555}. Any time qemu writes something to that port it
1823 will appear in the netconsole session.
1825 If you plan to send characters back via netconsole or you want to stop
1826 and start qemu a lot of times, you should have qemu use the same
1827 source port each time by using something like @code{-serial
1828 udp::4555@@:4556} to qemu. Another approach is to use a patched
1829 version of netcat which can listen to a TCP port and send and receive
1830 characters via udp. If you have a patched version of netcat which
1831 activates telnet remote echo and single char transfer, then you can
1832 use the following options to step up a netcat redirector to allow
1833 telnet on port 5555 to access the qemu port.
1836 -serial udp::4555@@:4556
1837 @item netcat options:
1838 -u -P 4555 -L 0.0.0.0:4556 -t -p 5555 -I -T
1839 @item telnet options:
1843 @item tcp:[@var{host}]:@var{port}[,@var{server}][,nowait][,nodelay]
1844 The TCP Net Console has two modes of operation. It can send the serial
1845 I/O to a location or wait for a connection from a location. By default
1846 the TCP Net Console is sent to @var{host} at the @var{port}. If you use
1847 the @var{server} option QEMU will wait for a client socket application
1848 to connect to the port before continuing, unless the @code{nowait}
1849 option was specified. The @code{nodelay} option disables the Nagle buffering
1850 algorithm. If @var{host} is omitted, 0.0.0.0 is assumed. Only
1851 one TCP connection at a time is accepted. You can use @code{telnet} to
1852 connect to the corresponding character device.
1854 @item Example to send tcp console to 192.168.0.2 port 4444
1855 -serial tcp:192.168.0.2:4444
1856 @item Example to listen and wait on port 4444 for connection
1857 -serial tcp::4444,server
1858 @item Example to not wait and listen on ip 192.168.0.100 port 4444
1859 -serial tcp:192.168.0.100:4444,server,nowait
1862 @item telnet:@var{host}:@var{port}[,server][,nowait][,nodelay]
1863 The telnet protocol is used instead of raw tcp sockets. The options
1864 work the same as if you had specified @code{-serial tcp}. The
1865 difference is that the port acts like a telnet server or client using
1866 telnet option negotiation. This will also allow you to send the
1867 MAGIC_SYSRQ sequence if you use a telnet that supports sending the break
1868 sequence. Typically in unix telnet you do it with Control-] and then
1869 type "send
break" followed by pressing the enter key.
1871 @item unix:@var{path}[,server][,nowait]
1872 A unix domain socket is used instead of a tcp socket. The option works the
1873 same as if you had specified @code{-serial tcp} except the unix domain socket
1874 @var{path} is used for connections.
1876 @item mon:@var{dev_string}
1877 This is a special option to allow the monitor to be multiplexed onto
1878 another serial port. The monitor is accessed with key sequence of
1879 @key{Control-a} and then pressing @key{c}. See monitor access
1880 @ref{pcsys_keys} in the -nographic section for more keys.
1881 @var{dev_string} should be any one of the serial devices specified
1882 above. An example to multiplex the monitor onto a telnet server
1883 listening on port 4444 would be:
1885 @item -serial mon:telnet::4444,server,nowait
1889 Braille device. This will use BrlAPI to display the braille output on a real
1893 Three button serial mouse. Configure the guest to use Microsoft protocol.
1897 DEF("parallel
", HAS_ARG, QEMU_OPTION_parallel, \
1898 "-parallel dev redirect the parallel port to char device
'dev'\n",
1901 @item -parallel @var{dev}
1903 Redirect the virtual parallel port to host device @var{dev} (same
1904 devices as the serial port). On Linux hosts, @file{/dev/parportN} can
1905 be used to use hardware devices connected on the corresponding host
1908 This option can be used several times to simulate up to 3 parallel
1911 Use @code{-parallel none} to disable all parallel ports.
1914 DEF("monitor
", HAS_ARG, QEMU_OPTION_monitor, \
1915 "-monitor dev redirect the monitor to char device
'dev'\n",
1918 @item -monitor @var{dev}
1920 Redirect the monitor to host device @var{dev} (same devices as the
1922 The default device is @code{vc} in graphical mode and @code{stdio} in
1925 DEF("qmp
", HAS_ARG, QEMU_OPTION_qmp, \
1926 "-qmp dev like
-monitor but opens
in 'control' mode
\n",
1929 @item -qmp @var{dev}
1931 Like -monitor but opens in 'control' mode.
1934 DEF("mon
", HAS_ARG, QEMU_OPTION_mon, \
1935 "-mon chardev
=[name
][,mode
=readline|control
][,default]\n", QEMU_ARCH_ALL)
1937 @item -mon chardev=[name][,mode=readline|control][,default]
1939 Setup monitor on chardev @var{name}.
1942 DEF("debugcon
", HAS_ARG, QEMU_OPTION_debugcon, \
1943 "-debugcon dev redirect the debug console to char device
'dev'\n",
1946 @item -debugcon @var{dev}
1948 Redirect the debug console to host device @var{dev} (same devices as the
1949 serial port). The debug console is an I/O port which is typically port
1950 0xe9; writing to that I/O port sends output to this device.
1951 The default device is @code{vc} in graphical mode and @code{stdio} in
1955 DEF("pidfile
", HAS_ARG, QEMU_OPTION_pidfile, \
1956 "-pidfile file write PID to
'file'\n", QEMU_ARCH_ALL)
1958 @item -pidfile @var{file}
1960 Store the QEMU process PID in @var{file}. It is useful if you launch QEMU
1964 DEF("singlestep
", 0, QEMU_OPTION_singlestep, \
1965 "-singlestep always run
in singlestep mode
\n", QEMU_ARCH_ALL)
1969 Run the emulation in single step mode.
1972 DEF("S
", 0, QEMU_OPTION_S, \
1973 "-S freeze CPU at
startup (use
'c' to start execution
)\n",
1978 Do not start CPU at startup (you must type 'c' in the monitor).
1981 DEF("gdb
", HAS_ARG, QEMU_OPTION_gdb, \
1982 "-gdb dev wait
for gdb connection on
'dev'\n", QEMU_ARCH_ALL)
1984 @item -gdb @var{dev}
1986 Wait for gdb connection on device @var{dev} (@pxref{gdb_usage}). Typical
1987 connections will likely be TCP-based, but also UDP, pseudo TTY, or even
1988 stdio are reasonable use case. The latter is allowing to start qemu from
1989 within gdb and establish the connection via a pipe:
1991 (gdb) target remote | exec qemu -gdb stdio ...
1995 DEF("s
", 0, QEMU_OPTION_s, \
1996 "-s shorthand
for -gdb tcp
::" DEFAULT_GDBSTUB_PORT "\n",
2001 Shorthand for -gdb tcp::1234, i.e. open a gdbserver on TCP port 1234
2002 (@pxref{gdb_usage}).
2005 DEF("d
", HAS_ARG, QEMU_OPTION_d, \
2006 "-d item1
,... output log to
/tmp
/qemu
.log (use
-d ?
for a list of log items
)\n",
2011 Output log in /tmp/qemu.log
2014 DEF("D
", HAS_ARG, QEMU_OPTION_D, \
2015 "-D logfile output log to
logfile (instead of the
default /tmp
/qemu
.log
)\n",
2020 Output log in logfile instead of /tmp/qemu.log
2023 DEF("hdachs
", HAS_ARG, QEMU_OPTION_hdachs, \
2024 "-hdachs c
,h
,s
[,t
]\n" \
2025 " force hard disk
0 physical geometry and the optional BIOS
\n" \
2026 " translation (t
=none or lba
) (usually qemu can guess them
)\n",
2029 @item -hdachs @var{c},@var{h},@var{s},[,@var{t}]
2031 Force hard disk 0 physical geometry (1 <= @var{c} <= 16383, 1 <=
2032 @var{h} <= 16, 1 <= @var{s} <= 63) and optionally force the BIOS
2033 translation mode (@var{t}=none, lba or auto). Usually QEMU can guess
2034 all those parameters. This option is useful for old MS-DOS disk
2038 DEF("L
", HAS_ARG, QEMU_OPTION_L, \
2039 "-L path set the directory
for the BIOS
, VGA BIOS and keymaps
\n",
2044 Set the directory for the BIOS, VGA BIOS and keymaps.
2047 DEF("bios
", HAS_ARG, QEMU_OPTION_bios, \
2048 "-bios file set the filename
for the BIOS
\n", QEMU_ARCH_ALL)
2050 @item -bios @var{file}
2052 Set the filename for the BIOS.
2055 DEF("enable
-kvm
", 0, QEMU_OPTION_enable_kvm, \
2056 "-enable
-kvm enable KVM full virtualization support
\n", QEMU_ARCH_ALL)
2060 Enable KVM full virtualization support. This option is only available
2061 if KVM support is enabled when compiling.
2064 DEF("machine
", HAS_ARG, QEMU_OPTION_machine, \
2065 "-machine accel
=accel1
[:accel2
] use an
accelerator (kvm
,xen
,tcg
), default is tcg
\n", QEMU_ARCH_ALL)
2067 @item -machine accel=@var{accels}
2069 This is use to enable an accelerator, in kvm,xen,tcg.
2070 By default, it use only tcg. If there a more than one accelerator
2071 specified, the next one is used if the first don't work.
2074 DEF("xen
-domid
", HAS_ARG, QEMU_OPTION_xen_domid,
2075 "-xen
-domid id specify xen guest domain id
\n", QEMU_ARCH_ALL)
2076 DEF("xen
-create
", 0, QEMU_OPTION_xen_create,
2077 "-xen
-create create domain
using xen hypercalls
, bypassing xend
\n"
2078 " warning
: should not be used when xend is
in use
\n",
2080 DEF("xen
-attach
", 0, QEMU_OPTION_xen_attach,
2081 "-xen
-attach attach to existing xen domain
\n"
2082 " xend will use
this when starting qemu
\n",
2085 @item -xen-domid @var{id}
2087 Specify xen guest domain @var{id} (XEN only).
2090 Create domain using xen hypercalls, bypassing xend.
2091 Warning: should not be used when xend is in use (XEN only).
2094 Attach to existing xen domain.
2095 xend will use this when starting qemu (XEN only).
2098 DEF("no
-reboot
", 0, QEMU_OPTION_no_reboot, \
2099 "-no
-reboot exit instead of rebooting
\n", QEMU_ARCH_ALL)
2103 Exit instead of rebooting.
2106 DEF("no
-shutdown
", 0, QEMU_OPTION_no_shutdown, \
2107 "-no
-shutdown stop before shutdown
\n", QEMU_ARCH_ALL)
2110 @findex -no-shutdown
2111 Don't exit QEMU on guest shutdown, but instead only stop the emulation.
2112 This allows for instance switching to monitor to commit changes to the
2116 DEF("loadvm
", HAS_ARG, QEMU_OPTION_loadvm, \
2117 "-loadvm
[tag|id
]\n" \
2118 " start right away with a saved
state (loadvm
in monitor
)\n",
2121 @item -loadvm @var{file}
2123 Start right away with a saved state (@code{loadvm} in monitor)
2127 DEF("daemonize
", 0, QEMU_OPTION_daemonize, \
2128 "-daemonize daemonize QEMU after initializing
\n", QEMU_ARCH_ALL)
2133 Daemonize the QEMU process after initialization. QEMU will not detach from
2134 standard IO until it is ready to receive connections on any of its devices.
2135 This option is a useful way for external programs to launch QEMU without having
2136 to cope with initialization race conditions.
2139 DEF("option
-rom
", HAS_ARG, QEMU_OPTION_option_rom, \
2140 "-option
-rom rom load a file
, rom
, into the option ROM space
\n",
2143 @item -option-rom @var{file}
2145 Load the contents of @var{file} as an option ROM.
2146 This option is useful to load things like EtherBoot.
2149 DEF("clock
", HAS_ARG, QEMU_OPTION_clock, \
2150 "-clock force the use of the given methods
for timer alarm
.\n" \
2151 " To see what timers are available use
-clock ?
\n",
2154 @item -clock @var{method}
2156 Force the use of the given methods for timer alarm. To see what timers
2157 are available use -clock ?.
2160 HXCOMM Options deprecated by -rtc
2161 DEF("localtime
", 0, QEMU_OPTION_localtime, "", QEMU_ARCH_ALL)
2162 DEF("startdate
", HAS_ARG, QEMU_OPTION_startdate, "", QEMU_ARCH_ALL)
2164 DEF("rtc
", HAS_ARG, QEMU_OPTION_rtc, \
2165 "-rtc
[base
=utc|localtime|date
][,clock
=host|vm
][,driftfix
=none|slew
]\n" \
2166 " set the RTC base and clock
, enable drift fix
for clock
ticks (x86 only
)\n",
2171 @item -rtc [base=utc|localtime|@var{date}][,clock=host|vm][,driftfix=none|slew]
2173 Specify @option{base} as @code{utc} or @code{localtime} to let the RTC start at the current
2174 UTC or local time, respectively. @code{localtime} is required for correct date in
2175 MS-DOS or Windows. To start at a specific point in time, provide @var{date} in the
2176 format @code{2006-06-17T16:01:21} or @code{2006-06-17}. The default base is UTC.
2178 By default the RTC is driven by the host system time. This allows to use the
2179 RTC as accurate reference clock inside the guest, specifically if the host
2180 time is smoothly following an accurate external reference clock, e.g. via NTP.
2181 If you want to isolate the guest time from the host, even prevent it from
2182 progressing during suspension, you can set @option{clock} to @code{vm} instead.
2184 Enable @option{driftfix} (i386 targets only) if you experience time drift problems,
2185 specifically with Windows' ACPI HAL. This option will try to figure out how
2186 many timer interrupts were not processed by the Windows guest and will
2190 DEF("icount
", HAS_ARG, QEMU_OPTION_icount, \
2191 "-icount
[N|auto
]\n" \
2192 " enable virtual instruction counter with
2^N clock ticks per
\n" \
2193 " instruction
\n", QEMU_ARCH_ALL)
2195 @item -icount [@var{N}|auto]
2197 Enable virtual instruction counter. The virtual cpu will execute one
2198 instruction every 2^@var{N} ns of virtual time. If @code{auto} is specified
2199 then the virtual cpu speed will be automatically adjusted to keep virtual
2200 time within a few seconds of real time.
2202 Note that while this option can give deterministic behavior, it does not
2203 provide cycle accurate emulation. Modern CPUs contain superscalar out of
2204 order cores with complex cache hierarchies. The number of instructions
2205 executed often has little or no correlation with actual performance.
2208 DEF("watchdog
", HAS_ARG, QEMU_OPTION_watchdog, \
2209 "-watchdog i6300esb|ib700
\n" \
2210 " enable virtual hardware watchdog
[default=none
]\n",
2213 @item -watchdog @var{model}
2215 Create a virtual hardware watchdog device. Once enabled (by a guest
2216 action), the watchdog must be periodically polled by an agent inside
2217 the guest or else the guest will be restarted.
2219 The @var{model} is the model of hardware watchdog to emulate. Choices
2220 for model are: @code{ib700} (iBASE 700) which is a very simple ISA
2221 watchdog with a single timer, or @code{i6300esb} (Intel 6300ESB I/O
2222 controller hub) which is a much more featureful PCI-based dual-timer
2223 watchdog. Choose a model for which your guest has drivers.
2225 Use @code{-watchdog ?} to list available hardware models. Only one
2226 watchdog can be enabled for a guest.
2229 DEF("watchdog
-action
", HAS_ARG, QEMU_OPTION_watchdog_action, \
2230 "-watchdog
-action reset|shutdown|poweroff|pause|debug|none
\n" \
2231 " action when watchdog fires
[default=reset
]\n",
2234 @item -watchdog-action @var{action}
2236 The @var{action} controls what QEMU will do when the watchdog timer
2239 @code{reset} (forcefully reset the guest).
2240 Other possible actions are:
2241 @code{shutdown} (attempt to gracefully shutdown the guest),
2242 @code{poweroff} (forcefully poweroff the guest),
2243 @code{pause} (pause the guest),
2244 @code{debug} (print a debug message and continue), or
2245 @code{none} (do nothing).
2247 Note that the @code{shutdown} action requires that the guest responds
2248 to ACPI signals, which it may not be able to do in the sort of
2249 situations where the watchdog would have expired, and thus
2250 @code{-watchdog-action shutdown} is not recommended for production use.
2255 @item -watchdog i6300esb -watchdog-action pause
2256 @item -watchdog ib700
2260 DEF("echr
", HAS_ARG, QEMU_OPTION_echr, \
2261 "-echr chr set terminal escape character instead of ctrl
-a
\n",
2265 @item -echr @var{numeric_ascii_value}
2267 Change the escape character used for switching to the monitor when using
2268 monitor and serial sharing. The default is @code{0x01} when using the
2269 @code{-nographic} option. @code{0x01} is equal to pressing
2270 @code{Control-a}. You can select a different character from the ascii
2271 control keys where 1 through 26 map to Control-a through Control-z. For
2272 instance you could use the either of the following to change the escape
2273 character to Control-t.
2280 DEF("virtioconsole
", HAS_ARG, QEMU_OPTION_virtiocon, \
2281 "-virtioconsole c
\n" \
2282 " set virtio console
\n", QEMU_ARCH_ALL)
2284 @item -virtioconsole @var{c}
2285 @findex -virtioconsole
2288 This option is maintained for backward compatibility.
2290 Please use @code{-device virtconsole} for the new way of invocation.
2293 DEF("show
-cursor
", 0, QEMU_OPTION_show_cursor, \
2294 "-show
-cursor show cursor
\n", QEMU_ARCH_ALL)
2297 @findex -show-cursor
2301 DEF("tb
-size
", HAS_ARG, QEMU_OPTION_tb_size, \
2302 "-tb
-size n set TB size
\n", QEMU_ARCH_ALL)
2304 @item -tb-size @var{n}
2309 DEF("incoming
", HAS_ARG, QEMU_OPTION_incoming, \
2310 "-incoming p prepare
for incoming migration
, listen on port p
\n",
2313 @item -incoming @var{port}
2315 Prepare for incoming migration, listen on @var{port}.
2318 DEF("nodefaults
", 0, QEMU_OPTION_nodefaults, \
2319 "-nodefaults don
't create default devices\n", QEMU_ARCH_ALL)
2323 Don't create
default devices
.
2327 DEF("chroot", HAS_ARG
, QEMU_OPTION_chroot
, \
2328 "-chroot dir chroot to dir just before starting the VM\n",
2332 @item
-chroot @
var{dir
}
2334 Immediately before starting guest execution
, chroot to the specified
2335 directory
. Especially useful
in combination with
-runas
.
2339 DEF("runas", HAS_ARG
, QEMU_OPTION_runas
, \
2340 "-runas user change to user id user just before starting the VM\n",
2344 @item
-runas @
var{user
}
2346 Immediately before starting guest execution
, drop root privileges
, switching
2347 to the specified user
.
2350 DEF("prom-env", HAS_ARG
, QEMU_OPTION_prom_env
,
2351 "-prom-env variable=value\n"
2352 " set OpenBIOS nvram variables\n",
2353 QEMU_ARCH_PPC | QEMU_ARCH_SPARC
)
2355 @item
-prom
-env @
var{variable
}=@
var{value
}
2357 Set OpenBIOS nvram @
var{variable
} to given @
var{value
} (PPC
, SPARC only
).
2359 DEF("semihosting", 0, QEMU_OPTION_semihosting
,
2360 "-semihosting semihosting mode\n", QEMU_ARCH_ARM | QEMU_ARCH_M68K
)
2363 @findex
-semihosting
2364 Semihosting
mode (ARM
, M68K only
).
2366 DEF("old-param", 0, QEMU_OPTION_old_param
,
2367 "-old-param old param mode\n", QEMU_ARCH_ARM
)
2370 @findex
-old
-param (ARM
)
2371 Old param
mode (ARM only
).
2374 DEF("readconfig", HAS_ARG
, QEMU_OPTION_readconfig
,
2375 "-readconfig <file>\n", QEMU_ARCH_ALL
)
2377 @item
-readconfig @
var{file
}
2379 Read device configuration from @
var{file
}.
2381 DEF("writeconfig", HAS_ARG
, QEMU_OPTION_writeconfig
,
2382 "-writeconfig <file>\n"
2383 " read/write config file\n", QEMU_ARCH_ALL
)
2385 @item
-writeconfig @
var{file
}
2386 @findex
-writeconfig
2387 Write device configuration to @
var{file
}.
2389 DEF("nodefconfig", 0, QEMU_OPTION_nodefconfig
,
2391 " do not load default config files at startup\n",
2395 @findex
-nodefconfig
2396 Normally QEMU loads a configuration file from @
var{sysconfdir
}/qemu
.conf and
2397 @
var{sysconfdir
}/target
-@
var{ARCH
}.conf on startup
. The @code
{-nodefconfig
}
2398 option will prevent QEMU from loading these configuration files at startup
.
2400 #ifdef CONFIG_SIMPLE_TRACE
2401 DEF("trace", HAS_ARG
, QEMU_OPTION_trace
,
2403 " Specify a trace file to log traces to\n",
2408 Specify a
trace file to log output traces to
.
2412 HXCOMM This is the last statement
. Insert
new options before
this line
!