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][,boot=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).
163 @item boot=@var{boot}
164 @var{boot} is "on" or "off" and allows for booting from non-traditional interfaces, such as virtio.
167 By default, writethrough caching is used for all block device. This means that
168 the host page cache will be used to read and write data but write notification
169 will be sent to the guest only when the data has been reported as written by
170 the storage subsystem.
172 Writeback caching will report data writes as completed as soon as the data is
173 present in the host page cache. This is safe as long as you trust your host.
174 If your host crashes or loses power, then the guest may experience data
177 The host page cache can be avoided entirely with @option{cache=none}. This will
178 attempt to do disk IO directly to the guests memory. QEMU may still perform
179 an internal copy of the data.
181 Some block drivers perform badly with @option{cache=writethrough}, most notably,
182 qcow2. If performance is more important than correctness,
183 @option{cache=writeback} should be used with qcow2.
185 In case you don't care about data integrity over host failures
, use
186 cache
=unsafe
. This option tells qemu that it
never needs to write any data
187 to the disk but can instead keeps things
in cache
. If anything goes wrong
,
188 like your host losing power
, the disk storage getting disconnected accidently
,
189 etc
. you
're image will most probably be rendered unusable. When using
190 the @option{-snapshot} option, unsafe caching is always used.
192 Instead of @option{-cdrom} you can use:
194 qemu -drive file=file,index=2,media=cdrom
197 Instead of @option{-hda}, @option{-hdb}, @option{-hdc}, @option{-hdd}, you can
200 qemu -drive file=file,index=0,media=disk
201 qemu -drive file=file,index=1,media=disk
202 qemu -drive file=file,index=2,media=disk
203 qemu -drive file=file,index=3,media=disk
206 You can connect a CDROM to the slave of ide0:
208 qemu -drive file=file,if=ide,index=1,media=cdrom
211 If you don't specify the
"file=" argument
, you define an empty drive
:
213 qemu
-drive
if=ide
,index
=1,media
=cdrom
216 You can connect a SCSI disk with unit ID
6 on the bus #
0:
218 qemu
-drive file
=file
,if=scsi
,bus
=0,unit
=6
221 Instead of @option
{-fda
}, @option
{-fdb
}, you can use
:
223 qemu
-drive file
=file
,index
=0,if=floppy
224 qemu
-drive file
=file
,index
=1,if=floppy
227 By
default, @
var{interface} is
"ide" and @
var{index
} is automatically
230 qemu
-drive file
=a
-drive file
=b
"
238 DEF("set
", HAS_ARG, QEMU_OPTION_set,
239 "-set group
.id
.arg
=value
\n"
240 " set
<arg
> parameter
for item
<id
> of type
<group
>\n"
241 " i
.e
. -set drive
.$id
.file
=/path
/to
/image
\n", QEMU_ARCH_ALL)
248 DEF("global
", HAS_ARG, QEMU_OPTION_global,
249 "-global driver
.property
=value
\n"
250 " set a global
default for a driver property
\n",
258 DEF("mtdblock
", HAS_ARG, QEMU_OPTION_mtdblock,
259 "-mtdblock file use
'file' as on
-board Flash memory image
\n",
262 @item -mtdblock @var{file}
264 Use @var{file} as on-board Flash memory image.
267 DEF("sd
", HAS_ARG, QEMU_OPTION_sd,
268 "-sd file use
'file' as SecureDigital card image
\n", QEMU_ARCH_ALL)
272 Use @var{file} as SecureDigital card image.
275 DEF("pflash
", HAS_ARG, QEMU_OPTION_pflash,
276 "-pflash file use
'file' as a parallel flash image
\n", QEMU_ARCH_ALL)
278 @item -pflash @var{file}
280 Use @var{file} as a parallel flash image.
283 DEF("boot
", HAS_ARG, QEMU_OPTION_boot,
284 "-boot
[order
=drives
][,once
=drives
][,menu
=on|off
]\n"
285 " 'drives': floppy (a
), hard
disk (c
), CD
-ROM (d
), network (n
)\n",
288 @item -boot [order=@var{drives}][,once=@var{drives}][,menu=on|off]
290 Specify boot order @var{drives} as a string of drive letters. Valid
291 drive letters depend on the target achitecture. The x86 PC uses: a, b
292 (floppy 1 and 2), c (first hard disk), d (first CD-ROM), n-p (Etherboot
293 from network adapter 1-4), hard disk boot is the default. To apply a
294 particular boot order only on the first startup, specify it via
297 Interactive boot menus/prompts can be enabled via @option{menu=on} as far
298 as firmware/BIOS supports them. The default is non-interactive boot.
301 # try to boot from network first, then from hard disk
303 # boot from CD-ROM first, switch back to default order after reboot
307 Note: The legacy format '-boot @var{drives}' is still supported but its
308 use is discouraged as it may be removed from future versions.
311 DEF("snapshot
", 0, QEMU_OPTION_snapshot,
312 "-snapshot write to temporary files instead of disk image files
\n",
317 Write to temporary files instead of disk image files. In this case,
318 the raw disk image you use is not written back. You can however force
319 the write back by pressing @key{C-a s} (@pxref{disk_images}).
322 DEF("m
", HAS_ARG, QEMU_OPTION_m,
323 "-m megs set virtual RAM size to megs MB
[default="
324 stringify(DEFAULT_RAM_SIZE) "]\n", QEMU_ARCH_ALL)
328 Set virtual RAM size to @var{megs} megabytes. Default is 128 MiB. Optionally,
329 a suffix of ``M'' or ``G'' can be used to signify a value in megabytes or
330 gigabytes respectively.
333 DEF("mem
-path
", HAS_ARG, QEMU_OPTION_mempath,
334 "-mem
-path FILE provide backing storage
for guest RAM
\n", QEMU_ARCH_ALL)
336 @item -mem-path @var{path}
337 Allocate guest RAM from a temporarily created file in @var{path}.
341 DEF("mem
-prealloc
", 0, QEMU_OPTION_mem_prealloc,
342 "-mem
-prealloc preallocate guest
memory (use with
-mem
-path
)\n",
346 Preallocate memory when using -mem-path.
350 DEF("k
", HAS_ARG, QEMU_OPTION_k,
351 "-k language use keyboard
layout (for example
'fr' for French
)\n",
354 @item -k @var{language}
356 Use keyboard layout @var{language} (for example @code{fr} for
357 French). This option is only needed where it is not easy to get raw PC
358 keycodes (e.g. on Macs, with some X11 servers or with a VNC
359 display). You don't normally need to use it on PC/Linux or PC/Windows
362 The available layouts are:
364 ar de-ch es fo fr-ca hu ja mk no pt-br sv
365 da en-gb et fr fr-ch is lt nl pl ru th
366 de en-us fi fr-be hr it lv nl-be pt sl tr
369 The default is @code{en-us}.
373 DEF("audio
-help
", 0, QEMU_OPTION_audio_help,
374 "-audio
-help print list of audio drivers and their options
\n",
379 Will show the audio subsystem help: list of drivers, tunable
383 DEF("soundhw
", HAS_ARG, QEMU_OPTION_soundhw,
384 "-soundhw c1
,... enable audio support
\n"
385 " and only specified sound
cards (comma separated list
)\n"
386 " use
-soundhw ? to get the list of supported cards
\n"
387 " use
-soundhw all to enable all of them
\n", QEMU_ARCH_ALL)
389 @item -soundhw @var{card1}[,@var{card2},...] or -soundhw all
391 Enable audio and selected sound hardware. Use ? to print all
392 available sound hardware.
395 qemu -soundhw sb16,adlib disk.img
396 qemu -soundhw es1370 disk.img
397 qemu -soundhw ac97 disk.img
398 qemu -soundhw hda disk.img
399 qemu -soundhw all disk.img
403 Note that Linux's i810_audio OSS kernel (for AC97) module might
404 require manually specifying clocking.
407 modprobe i810_audio clocking=48000
415 DEF("usb
", 0, QEMU_OPTION_usb,
416 "-usb enable the USB
driver (will be the
default soon
)\n",
424 Enable the USB driver (will be the default soon)
427 DEF("usbdevice
", HAS_ARG, QEMU_OPTION_usbdevice,
428 "-usbdevice name add the host or guest USB device
'name'\n",
432 @item -usbdevice @var{devname}
434 Add the USB device @var{devname}. @xref{usb_devices}.
439 Virtual Mouse. This will override the PS/2 mouse emulation when activated.
442 Pointer device that uses absolute coordinates (like a touchscreen). This
443 means qemu is able to report the mouse position without having to grab the
444 mouse. Also overrides the PS/2 mouse emulation when activated.
446 @item disk:[format=@var{format}]:@var{file}
447 Mass storage device based on file. The optional @var{format} argument
448 will be used rather than detecting the format. Can be used to specifiy
449 @code{format=raw} to avoid interpreting an untrusted format header.
451 @item host:@var{bus}.@var{addr}
452 Pass through the host device identified by @var{bus}.@var{addr} (Linux only).
454 @item host:@var{vendor_id}:@var{product_id}
455 Pass through the host device identified by @var{vendor_id}:@var{product_id}
458 @item serial:[vendorid=@var{vendor_id}][,productid=@var{product_id}]:@var{dev}
459 Serial converter to host character device @var{dev}, see @code{-serial} for the
463 Braille device. This will use BrlAPI to display the braille output on a real
466 @item net:@var{options}
467 Network adapter that supports CDC ethernet and RNDIS protocols.
472 DEF("device
", HAS_ARG, QEMU_OPTION_device,
473 "-device driver
[,prop
[=value
][,...]]\n"
474 " add
device (based on driver
)\n"
475 " prop
=value
,... sets driver properties
\n"
476 " use
-device ? to print all possible drivers
\n"
477 " use
-device driver
,? to print all possible properties
\n",
480 @item -device @var{driver}[,@var{prop}[=@var{value}][,...]]
482 Add device @var{driver}. @var{prop}=@var{value} sets driver
483 properties. Valid properties depend on the driver. To get help on
484 possible drivers and properties, use @code{-device ?} and
485 @code{-device @var{driver},?}.
488 DEFHEADING(File system options:)
490 DEF("fsdev
", HAS_ARG, QEMU_OPTION_fsdev,
491 "-fsdev local
,id
=id
,path
=path
,security_model
=[mapped|passthrough|none
]\n",
496 The general form of a File system device option is:
499 @item -fsdev @var{fstype} ,id=@var{id} [,@var{options}]
503 The specific Fstype will determine the applicable options.
505 Options to each backend are described below.
507 @item -fsdev local ,id=@var{id} ,path=@var{path} ,security_model=@var{security_model}
509 Create a file-system-"device
" for local-filesystem.
511 @option{local} is only available on Linux.
513 @option{path} specifies the path to be exported. @option{path} is required.
515 @option{security_model} specifies the security model to be followed.
516 @option{security_model} is required.
521 DEFHEADING(Virtual File system pass-through options:)
523 DEF("virtfs
", HAS_ARG, QEMU_OPTION_virtfs,
524 "-virtfs local
,path
=path
,mount_tag
=tag
,security_model
=[mapped|passthrough|none
]\n",
529 The general form of a Virtual File system pass-through option is:
532 @item -virtfs @var{fstype} [,@var{options}]
536 The specific Fstype will determine the applicable options.
538 Options to each backend are described below.
540 @item -virtfs local ,path=@var{path} ,mount_tag=@var{mount_tag} ,security_model=@var{security_model}
542 Create a Virtual file-system-pass through for local-filesystem.
544 @option{local} is only available on Linux.
546 @option{path} specifies the path to be exported. @option{path} is required.
548 @option{security_model} specifies the security model to be followed.
549 @option{security_model} is required.
552 @option{mount_tag} specifies the tag with which the exported file is mounted.
553 @option{mount_tag} is required.
560 DEF("name
", HAS_ARG, QEMU_OPTION_name,
561 "-name string1
[,process
=string2
]\n"
562 " set the name of the guest
\n"
563 " string1 sets the window title and string2 the process
name (on Linux
)\n",
566 @item -name @var{name}
568 Sets the @var{name} of the guest.
569 This name will be displayed in the SDL window caption.
570 The @var{name} will also be used for the VNC server.
571 Also optionally set the top visible process name in Linux.
574 DEF("uuid
", HAS_ARG, QEMU_OPTION_uuid,
575 "-uuid
%08x
-%04x
-%04x
-%04x
-%012x
\n"
576 " specify machine UUID
\n", QEMU_ARCH_ALL)
578 @item -uuid @var{uuid}
589 DEFHEADING(Display options:)
595 DEF("display
", HAS_ARG, QEMU_OPTION_display,
596 "-display sdl
[,frame
=on|off
][,alt_grab
=on|off
][,ctrl_grab
=on|off
]\n"
597 " [,window_close
=on|off
]|curses|none|
\n"
598 " vnc
=<display
>[,<optargs
>]\n"
599 " select display type
\n", QEMU_ARCH_ALL)
601 @item -display @var{type}
603 Select type of display to use. This option is a replacement for the
604 old style -sdl/-curses/... options. Valid values for @var{type} are
607 Display video output via SDL (usually in a separate graphics
608 window; see the SDL documentation for other possibilities).
610 Display video output via curses. For graphics device models which
611 support a text mode, QEMU can display this output using a
612 curses/ncurses interface. Nothing is displayed when the graphics
613 device is in graphical mode or if the graphics device does not support
614 a text mode. Generally only the VGA device models support text mode.
616 Do not display video output. The guest will still see an emulated
617 graphics card, but its output will not be displayed to the QEMU
618 user. This option differs from the -nographic option in that it
619 only affects what is done with video output; -nographic also changes
620 the destination of the serial and parallel port data.
622 Start a VNC server on display <arg>
626 DEF("nographic
", 0, QEMU_OPTION_nographic,
627 "-nographic disable graphical output and redirect serial I
/Os to console
\n",
632 Normally, QEMU uses SDL to display the VGA output. With this option,
633 you can totally disable graphical output so that QEMU is a simple
634 command line application. The emulated serial port is redirected on
635 the console. Therefore, you can still use QEMU to debug a Linux kernel
636 with a serial console.
639 DEF("curses
", 0, QEMU_OPTION_curses,
640 "-curses use a curses
/ncurses
interface instead of SDL
\n",
645 Normally, QEMU uses SDL to display the VGA output. With this option,
646 QEMU can display the VGA output when in text mode using a
647 curses/ncurses interface. Nothing is displayed in graphical mode.
650 DEF("no
-frame
", 0, QEMU_OPTION_no_frame,
651 "-no
-frame open SDL window without a frame and window decorations
\n",
656 Do not use decorations for SDL windows and start them using the whole
657 available screen space. This makes the using QEMU in a dedicated desktop
658 workspace more convenient.
661 DEF("alt
-grab
", 0, QEMU_OPTION_alt_grab,
662 "-alt
-grab use Ctrl
-Alt
-Shift to grab
mouse (instead of Ctrl
-Alt
)\n",
667 Use Ctrl-Alt-Shift to grab mouse (instead of Ctrl-Alt). Note that this also
668 affects the special keys (for fullscreen, monitor-mode switching, etc).
671 DEF("ctrl
-grab
", 0, QEMU_OPTION_ctrl_grab,
672 "-ctrl
-grab use Right
-Ctrl to grab
mouse (instead of Ctrl
-Alt
)\n",
677 Use Right-Ctrl to grab mouse (instead of Ctrl-Alt). Note that this also
678 affects the special keys (for fullscreen, monitor-mode switching, etc).
681 DEF("no
-quit
", 0, QEMU_OPTION_no_quit,
682 "-no
-quit disable SDL window close capability
\n", QEMU_ARCH_ALL)
686 Disable SDL window close capability.
689 DEF("sdl
", 0, QEMU_OPTION_sdl,
690 "-sdl enable SDL
\n", QEMU_ARCH_ALL)
697 DEF("spice
", HAS_ARG, QEMU_OPTION_spice,
698 "-spice
<args
> enable spice
\n", QEMU_ARCH_ALL)
700 @item -spice @var{option}[,@var{option}[,...]]
702 Enable the spice remote desktop protocol. Valid options are
707 Set the TCP port spice is listening on for plaintext channels.
710 Set the IP address spice is listening on. Default is any address.
714 Force using the specified IP version.
716 @item password=<secret>
717 Set the password you need to authenticate.
719 @item disable-ticketing
720 Allow client connects without authentication.
723 Set the TCP port spice is listening on for encrypted channels.
726 Set the x509 file directory. Expects same filenames as -vnc $display,x509=$dir
728 @item x509-key-file=<file>
729 @item x509-key-password=<file>
730 @item x509-cert-file=<file>
731 @item x509-cacert-file=<file>
732 @item x509-dh-key-file=<file>
733 The x509 file names can also be configured individually.
735 @item tls-ciphers=<list>
736 Specify which ciphers to use.
738 @item tls-channel=[main|display|inputs|record|playback|tunnel]
739 @item plaintext-channel=[main|display|inputs|record|playback|tunnel]
740 Force specific channel to be used with or without TLS encryption. The
741 options can be specified multiple times to configure multiple
742 channels. The special name "default" can be used to set the default
743 mode. For channels which are not explicitly forced into one mode the
744 spice client is allowed to pick tls/plaintext as he pleases.
746 @item image-compression=[auto_glz|auto_lz|quic|glz|lz|off]
747 Configure image compression (lossless).
750 @item jpeg-wan-compression=[auto|never|always]
751 @item zlib-glz-wan-compression=[auto|never|always]
752 Configure wan image compression (lossy for slow links).
755 @item streaming-video=[off|all|filter]
756 Configure video stream detection. Default is filter.
758 @item agent-mouse=[on|off]
759 Enable/disable passing mouse events via vdagent. Default is on.
761 @item playback-compression=[on|off]
762 Enable/disable audio stream compression (using celt 0.5.1). Default is on.
767 DEF("portrait
", 0, QEMU_OPTION_portrait,
768 "-portrait rotate graphical output
90 deg
left (only PXA LCD
)\n",
773 Rotate graphical output 90 deg left (only PXA LCD).
776 DEF("vga
", HAS_ARG, QEMU_OPTION_vga,
777 "-vga
[std|cirrus|vmware|qxl|xenfb|none
]\n"
778 " select video card type
\n", QEMU_ARCH_ALL)
780 @item -vga @var{type}
782 Select type of VGA card to emulate. Valid values for @var{type} are
785 Cirrus Logic GD5446 Video card. All Windows versions starting from
786 Windows 95 should recognize and use this graphic card. For optimal
787 performances, use 16 bit color depth in the guest and the host OS.
788 (This one is the default)
790 Standard VGA card with Bochs VBE extensions. If your guest OS
791 supports the VESA 2.0 VBE extensions (e.g. Windows XP) and if you want
792 to use high resolution modes (>= 1280x1024x16) then you should use
795 VMWare SVGA-II compatible adapter. Use it if you have sufficiently
796 recent XFree86/XOrg server or Windows guest with a driver for this
799 QXL paravirtual graphic card. It is VGA compatible (including VESA
800 2.0 VBE support). Works best with qxl guest drivers installed though.
801 Recommended choice when using the spice protocol.
807 DEF("full
-screen
", 0, QEMU_OPTION_full_screen,
808 "-full
-screen start
in full screen
\n", QEMU_ARCH_ALL)
812 Start in full screen.
815 DEF("g
", 1, QEMU_OPTION_g ,
816 "-g WxH
[xDEPTH
] Set the initial graphical resolution and depth
\n",
817 QEMU_ARCH_PPC | QEMU_ARCH_SPARC)
819 @item -g @var{width}x@var{height}[x@var{depth}]
821 Set the initial graphical resolution and depth (PPC, SPARC only).
824 DEF("vnc
", HAS_ARG, QEMU_OPTION_vnc ,
825 "-vnc display start a VNC server on display
\n", QEMU_ARCH_ALL)
827 @item -vnc @var{display}[,@var{option}[,@var{option}[,...]]]
829 Normally, QEMU uses SDL to display the VGA output. With this option,
830 you can have QEMU listen on VNC display @var{display} and redirect the VGA
831 display over the VNC session. It is very useful to enable the usb
832 tablet device when using this option (option @option{-usbdevice
833 tablet}). When using the VNC display, you must use the @option{-k}
834 parameter to set the keyboard layout if you are not using en-us. Valid
835 syntax for the @var{display} is
839 @item @var{host}:@var{d}
841 TCP connections will only be allowed from @var{host} on display @var{d}.
842 By convention the TCP port is 5900+@var{d}. Optionally, @var{host} can
843 be omitted in which case the server will accept connections from any host.
845 @item unix:@var{path}
847 Connections will be allowed over UNIX domain sockets where @var{path} is the
848 location of a unix socket to listen for connections on.
852 VNC is initialized but not started. The monitor @code{change} command
853 can be used to later start the VNC server.
857 Following the @var{display} value there may be one or more @var{option} flags
858 separated by commas. Valid options are
864 Connect to a listening VNC client via a ``reverse'' connection. The
865 client is specified by the @var{display}. For reverse network
866 connections (@var{host}:@var{d},@code{reverse}), the @var{d} argument
867 is a TCP port number, not a display number.
871 Require that password based authentication is used for client connections.
872 The password must be set separately using the @code{change} command in the
877 Require that client use TLS when communicating with the VNC server. This
878 uses anonymous TLS credentials so is susceptible to a man-in-the-middle
879 attack. It is recommended that this option be combined with either the
880 @option{x509} or @option{x509verify} options.
882 @item x509=@var{/path/to/certificate/dir}
884 Valid if @option{tls} is specified. Require that x509 credentials are used
885 for negotiating the TLS session. The server will send its x509 certificate
886 to the client. It is recommended that a password be set on the VNC server
887 to provide authentication of the client when this is used. The path following
888 this option specifies where the x509 certificates are to be loaded from.
889 See the @ref{vnc_security} section for details on generating certificates.
891 @item x509verify=@var{/path/to/certificate/dir}
893 Valid if @option{tls} is specified. Require that x509 credentials are used
894 for negotiating the TLS session. The server will send its x509 certificate
895 to the client, and request that the client send its own x509 certificate.
896 The server will validate the client's certificate against the CA certificate,
897 and reject clients when validation fails. If the certificate authority is
898 trusted, this is a sufficient authentication mechanism. You may still wish
899 to set a password on the VNC server as a second authentication layer. The
900 path following this option specifies where the x509 certificates are to
901 be loaded from. See the @ref{vnc_security} section for details on generating
906 Require that the client use SASL to authenticate with the VNC server.
907 The exact choice of authentication method used is controlled from the
908 system / user's SASL configuration file for the 'qemu' service. This
909 is typically found in /etc/sasl2/qemu.conf. If running QEMU as an
910 unprivileged user, an environment variable SASL_CONF_PATH can be used
911 to make it search alternate locations for the service config.
912 While some SASL auth methods can also provide data encryption (eg GSSAPI),
913 it is recommended that SASL always be combined with the 'tls' and
914 'x509' settings to enable use of SSL and server certificates. This
915 ensures a data encryption preventing compromise of authentication
916 credentials. See the @ref{vnc_security} section for details on using
921 Turn on access control lists for checking of the x509 client certificate
922 and SASL party. For x509 certs, the ACL check is made against the
923 certificate's distinguished name. This is something that looks like
924 @code{C=GB,O=ACME,L=Boston,CN=bob}. For SASL party, the ACL check is
925 made against the username, which depending on the SASL plugin, may
926 include a realm component, eg @code{bob} or @code{bob@@EXAMPLE.COM}.
927 When the @option{acl} flag is set, the initial access list will be
928 empty, with a @code{deny} policy. Thus no one will be allowed to
929 use the VNC server until the ACLs have been loaded. This can be
930 achieved using the @code{acl} monitor command.
934 Enable lossy compression methods (gradient, JPEG, ...). If this
935 option is set, VNC client may receive lossy framebuffer updates
936 depending on its encoding settings. Enabling this option can save
937 a lot of bandwidth at the expense of quality.
941 Disable adaptive encodings. Adaptive encodings are enabled by default.
942 An adaptive encoding will try to detect frequently updated screen regions,
943 and send updates in these regions using a lossy encoding (like JPEG).
944 This can be really helpful to save bandwidth when playing videos. Disabling
945 adaptive encodings allows to restore the original static behavior of encodings
957 DEFHEADING(i386 target only:)
962 DEF("win2k
-hack
", 0, QEMU_OPTION_win2k_hack,
963 "-win2k
-hack use it when installing Windows
2000 to avoid a disk full bug
\n",
968 Use it when installing Windows 2000 to avoid a disk full bug. After
969 Windows 2000 is installed, you no longer need this option (this option
970 slows down the IDE transfers).
973 HXCOMM Deprecated by -rtc
974 DEF("rtc
-td
-hack
", 0, QEMU_OPTION_rtc_td_hack, "", QEMU_ARCH_I386)
976 DEF("no
-fd
-bootchk
", 0, QEMU_OPTION_no_fd_bootchk,
977 "-no
-fd
-bootchk disable boot signature checking
for floppy disks
\n",
981 @findex -no-fd-bootchk
982 Disable boot signature checking for floppy disks in Bochs BIOS. It may
983 be needed to boot from old floppy disks.
984 TODO: check reference to Bochs BIOS.
987 DEF("no
-acpi
", 0, QEMU_OPTION_no_acpi,
988 "-no
-acpi disable ACPI
\n", QEMU_ARCH_I386)
992 Disable ACPI (Advanced Configuration and Power Interface) support. Use
993 it if your guest OS complains about ACPI problems (PC target machine
997 DEF("no
-hpet
", 0, QEMU_OPTION_no_hpet,
998 "-no
-hpet disable HPET
\n", QEMU_ARCH_I386)
1002 Disable HPET support.
1005 DEF("balloon
", HAS_ARG, QEMU_OPTION_balloon,
1006 "-balloon none disable balloon device
\n"
1007 "-balloon virtio
[,addr
=str
]\n"
1008 " enable virtio balloon
device (default)\n", QEMU_ARCH_ALL)
1012 Disable balloon device.
1013 @item -balloon virtio[,addr=@var{addr}]
1014 Enable virtio balloon device (default), optionally with PCI address
1018 DEF("acpitable
", HAS_ARG, QEMU_OPTION_acpitable,
1019 "-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"
1020 " ACPI table description
\n", QEMU_ARCH_I386)
1022 @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}]...]
1024 Add ACPI table with specified header fields and context from specified files.
1027 DEF("smbios
", HAS_ARG, QEMU_OPTION_smbios,
1028 "-smbios file
=binary
\n"
1029 " load SMBIOS entry from binary file
\n"
1030 "-smbios type
=0[,vendor
=str
][,version
=str
][,date
=str
][,release
=%d
.%d
]\n"
1031 " specify SMBIOS type
0 fields
\n"
1032 "-smbios type
=1[,manufacturer
=str
][,product
=str
][,version
=str
][,serial
=str
]\n"
1033 " [,uuid
=uuid
][,sku
=str
][,family
=str
]\n"
1034 " specify SMBIOS type
1 fields
\n", QEMU_ARCH_I386)
1036 @item -smbios file=@var{binary}
1038 Load SMBIOS entry from binary file.
1040 @item -smbios type=0[,vendor=@var{str}][,version=@var{str}][,date=@var{str}][,release=@var{%d.%d}]
1042 Specify SMBIOS type 0 fields
1044 @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}]
1045 Specify SMBIOS type 1 fields
1053 DEFHEADING(Network options:)
1058 HXCOMM Legacy slirp options (now moved to -net user):
1060 DEF("tftp
", HAS_ARG, QEMU_OPTION_tftp, "", QEMU_ARCH_ALL)
1061 DEF("bootp
", HAS_ARG, QEMU_OPTION_bootp, "", QEMU_ARCH_ALL)
1062 DEF("redir
", HAS_ARG, QEMU_OPTION_redir, "", QEMU_ARCH_ALL)
1064 DEF("smb
", HAS_ARG, QEMU_OPTION_smb, "", QEMU_ARCH_ALL)
1068 DEF("net
", HAS_ARG, QEMU_OPTION_net,
1069 "-net nic
[,vlan
=n
][,macaddr
=mac
][,model
=type
][,name
=str
][,addr
=str
][,vectors
=v
]\n"
1070 " create a
new Network Interface Card and connect it to VLAN
'n'\n"
1072 "-net user
[,vlan
=n
][,name
=str
][,net
=addr
[/mask
]][,host
=addr
][,restrict
=y|n
]\n"
1073 " [,hostname
=host
][,dhcpstart
=addr
][,dns
=addr
][,tftp
=dir
][,bootfile
=f
]\n"
1074 " [,hostfwd
=rule
][,guestfwd
=rule
]"
1076 "[,smb
=dir
[,smbserver
=addr
]]\n"
1078 " connect the user mode network stack to VLAN
'n', configure its
\n"
1079 " DHCP server and enabled optional services
\n"
1082 "-net tap
[,vlan
=n
][,name
=str
],ifname
=name
\n"
1083 " connect the host TAP network
interface to VLAN
'n'\n"
1085 "-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"
1086 " connect the host TAP network
interface to VLAN
'n' and use the
\n"
1087 " network scripts
'file' (default=" DEFAULT_NETWORK_SCRIPT ")\n"
1088 " and
'dfile' (default=" DEFAULT_NETWORK_DOWN_SCRIPT ")\n"
1089 " use
'[down]script=no' to disable script execution
\n"
1090 " use
'fd=h' to connect to an already opened TAP
interface\n"
1091 " use
'sndbuf=nbytes' to limit the size of the send
buffer (the
\n"
1092 " default is disabled
'sndbuf=0' to enable flow control set
'sndbuf=1048576')\n"
1093 " use vnet_hdr
=off to avoid enabling the IFF_VNET_HDR tap flag
\n"
1094 " use vnet_hdr
=on to make the lack of IFF_VNET_HDR support an error condition
\n"
1095 " use vhost
=on to enable experimental
in kernel accelerator
\n"
1096 " (only has effect
for virtio guests which use MSIX
)\n"
1097 " use vhostforce
=on to force vhost on
for non
-MSIX virtio guests
\n"
1098 " use
'vhostfd=h' to connect to an already opened vhost net device
\n"
1100 "-net socket
[,vlan
=n
][,name
=str
][,fd
=h
][,listen
=[host
]:port
][,connect
=host
:port
]\n"
1101 " connect the vlan
'n' to another VLAN
using a socket connection
\n"
1102 "-net socket
[,vlan
=n
][,name
=str
][,fd
=h
][,mcast
=maddr
:port
[,localaddr
=addr
]]\n"
1103 " connect the vlan
'n' to multicast maddr and port
\n"
1104 " use
'localaddr=addr' to specify the host address to send packets from
\n"
1106 "-net vde
[,vlan
=n
][,name
=str
][,sock
=socketpath
][,port
=n
][,group
=groupname
][,mode
=octalmode
]\n"
1107 " connect the vlan
'n' to port
'n' of a vde
switch running
\n"
1108 " on host and listening
for incoming connections on
'socketpath'.\n"
1109 " Use group
'groupname' and mode
'octalmode' to change
default\n"
1110 " ownership and permissions
for communication port
.\n"
1112 "-net dump
[,vlan
=n
][,file
=f
][,len
=n
]\n"
1113 " dump traffic on vlan
'n' to file
'f' (max n bytes per packet
)\n"
1114 "-net none use it alone to have zero network devices
. If no
-net option
\n"
1115 " is provided
, the
default is
'-net nic -net user'\n", QEMU_ARCH_ALL)
1116 DEF("netdev
", HAS_ARG, QEMU_OPTION_netdev,
1125 "socket
],id
=str
[,option
][,option
][,...]\n", QEMU_ARCH_ALL)
1127 @item -net nic[,vlan=@var{n}][,macaddr=@var{mac}][,model=@var{type}] [,name=@var{name}][,addr=@var{addr}][,vectors=@var{v}]
1129 Create a new Network Interface Card and connect it to VLAN @var{n} (@var{n}
1130 = 0 is the default). The NIC is an e1000 by default on the PC
1131 target. Optionally, the MAC address can be changed to @var{mac}, the
1132 device address set to @var{addr} (PCI cards only),
1133 and a @var{name} can be assigned for use in monitor commands.
1134 Optionally, for PCI cards, you can specify the number @var{v} of MSI-X vectors
1135 that the card should have; this option currently only affects virtio cards; set
1136 @var{v} = 0 to disable MSI-X. If no @option{-net} option is specified, a single
1137 NIC is created. Qemu can emulate several different models of network card.
1138 Valid values for @var{type} are
1139 @code{virtio}, @code{i82551}, @code{i82557b}, @code{i82559er},
1140 @code{ne2k_pci}, @code{ne2k_isa}, @code{pcnet}, @code{rtl8139},
1141 @code{e1000}, @code{smc91c111}, @code{lance} and @code{mcf_fec}.
1142 Not all devices are supported on all targets. Use -net nic,model=?
1143 for a list of available devices for your target.
1145 @item -net user[,@var{option}][,@var{option}][,...]
1146 Use the user mode network stack which requires no administrator
1147 privilege to run. Valid options are:
1151 Connect user mode stack to VLAN @var{n} (@var{n} = 0 is the default).
1153 @item name=@var{name}
1154 Assign symbolic name for use in monitor commands.
1156 @item net=@var{addr}[/@var{mask}]
1157 Set IP network address the guest will see. Optionally specify the netmask,
1158 either in the form a.b.c.d or as number of valid top-most bits. Default is
1161 @item host=@var{addr}
1162 Specify the guest-visible address of the host. Default is the 2nd IP in the
1163 guest network, i.e. x.x.x.2.
1165 @item restrict=y|yes|n|no
1166 If this options is enabled, the guest will be isolated, i.e. it will not be
1167 able to contact the host and no guest IP packets will be routed over the host
1168 to the outside. This option does not affect explicitly set forwarding rule.
1170 @item hostname=@var{name}
1171 Specifies the client hostname reported by the builtin DHCP server.
1173 @item dhcpstart=@var{addr}
1174 Specify the first of the 16 IPs the built-in DHCP server can assign. Default
1175 is the 15th to 31st IP in the guest network, i.e. x.x.x.15 to x.x.x.31.
1177 @item dns=@var{addr}
1178 Specify the guest-visible address of the virtual nameserver. The address must
1179 be different from the host address. Default is the 3rd IP in the guest network,
1182 @item tftp=@var{dir}
1183 When using the user mode network stack, activate a built-in TFTP
1184 server. The files in @var{dir} will be exposed as the root of a TFTP server.
1185 The TFTP client on the guest must be configured in binary mode (use the command
1186 @code{bin} of the Unix TFTP client).
1188 @item bootfile=@var{file}
1189 When using the user mode network stack, broadcast @var{file} as the BOOTP
1190 filename. In conjunction with @option{tftp}, this can be used to network boot
1191 a guest from a local directory.
1193 Example (using pxelinux):
1195 qemu -hda linux.img -boot n -net user,tftp=/path/to/tftp/files,bootfile=/pxelinux.0
1198 @item smb=@var{dir}[,smbserver=@var{addr}]
1199 When using the user mode network stack, activate a built-in SMB
1200 server so that Windows OSes can access to the host files in @file{@var{dir}}
1201 transparently. The IP address of the SMB server can be set to @var{addr}. By
1202 default the 4th IP in the guest network is used, i.e. x.x.x.4.
1204 In the guest Windows OS, the line:
1208 must be added in the file @file{C:\WINDOWS\LMHOSTS} (for windows 9x/Me)
1209 or @file{C:\WINNT\SYSTEM32\DRIVERS\ETC\LMHOSTS} (Windows NT/2000).
1211 Then @file{@var{dir}} can be accessed in @file{\\smbserver\qemu}.
1213 Note that a SAMBA server must be installed on the host OS in
1214 @file{/usr/sbin/smbd}. QEMU was tested successfully with smbd versions from
1215 Red Hat 9, Fedora Core 3 and OpenSUSE 11.x.
1217 @item hostfwd=[tcp|udp]:[@var{hostaddr}]:@var{hostport}-[@var{guestaddr}]:@var{guestport}
1218 Redirect incoming TCP or UDP connections to the host port @var{hostport} to
1219 the guest IP address @var{guestaddr} on guest port @var{guestport}. If
1220 @var{guestaddr} is not specified, its value is x.x.x.15 (default first address
1221 given by the built-in DHCP server). By specifying @var{hostaddr}, the rule can
1222 be bound to a specific host interface. If no connection type is set, TCP is
1223 used. This option can be given multiple times.
1225 For example, to redirect host X11 connection from screen 1 to guest
1226 screen 0, use the following:
1230 qemu -net user,hostfwd=tcp:127.0.0.1:6001-:6000 [...]
1231 # this host xterm should open in the guest X11 server
1235 To redirect telnet connections from host port 5555 to telnet port on
1236 the guest, use the following:
1240 qemu -net user,hostfwd=tcp::5555-:23 [...]
1241 telnet localhost 5555
1244 Then when you use on the host @code{telnet localhost 5555}, you
1245 connect to the guest telnet server.
1247 @item guestfwd=[tcp]:@var{server}:@var{port}-@var{dev}
1248 Forward guest TCP connections to the IP address @var{server} on port @var{port}
1249 to the character device @var{dev}. This option can be given multiple times.
1253 Note: Legacy stand-alone options -tftp, -bootp, -smb and -redir are still
1254 processed and applied to -net user. Mixing them with the new configuration
1255 syntax gives undefined results. Their use for new applications is discouraged
1256 as they will be removed from future versions.
1258 @item -net tap[,vlan=@var{n}][,name=@var{name}][,fd=@var{h}][,ifname=@var{name}] [,script=@var{file}][,downscript=@var{dfile}]
1259 Connect the host TAP network interface @var{name} to VLAN @var{n}, use
1260 the network script @var{file} to configure it and the network script
1261 @var{dfile} to deconfigure it. If @var{name} is not provided, the OS
1262 automatically provides one. @option{fd}=@var{h} can be used to specify
1263 the handle of an already opened host TAP interface. The default network
1264 configure script is @file{/etc/qemu-ifup} and the default network
1265 deconfigure script is @file{/etc/qemu-ifdown}. Use @option{script=no}
1266 or @option{downscript=no} to disable script execution. Example:
1269 qemu linux.img -net nic -net tap
1272 More complicated example (two NICs, each one connected to a TAP device)
1274 qemu linux.img -net nic,vlan=0 -net tap,vlan=0,ifname=tap0 \
1275 -net nic,vlan=1 -net tap,vlan=1,ifname=tap1
1278 @item -net socket[,vlan=@var{n}][,name=@var{name}][,fd=@var{h}] [,listen=[@var{host}]:@var{port}][,connect=@var{host}:@var{port}]
1280 Connect the VLAN @var{n} to a remote VLAN in another QEMU virtual
1281 machine using a TCP socket connection. If @option{listen} is
1282 specified, QEMU waits for incoming connections on @var{port}
1283 (@var{host} is optional). @option{connect} is used to connect to
1284 another QEMU instance using the @option{listen} option. @option{fd}=@var{h}
1285 specifies an already opened TCP socket.
1289 # launch a first QEMU instance
1290 qemu linux.img -net nic,macaddr=52:54:00:12:34:56 \
1291 -net socket,listen=:1234
1292 # connect the VLAN 0 of this instance to the VLAN 0
1293 # of the first instance
1294 qemu linux.img -net nic,macaddr=52:54:00:12:34:57 \
1295 -net socket,connect=127.0.0.1:1234
1298 @item -net socket[,vlan=@var{n}][,name=@var{name}][,fd=@var{h}][,mcast=@var{maddr}:@var{port}[,localaddr=@var{addr}]]
1300 Create a VLAN @var{n} shared with another QEMU virtual
1301 machines using a UDP multicast socket, effectively making a bus for
1302 every QEMU with same multicast address @var{maddr} and @var{port}.
1306 Several QEMU can be running on different hosts and share same bus (assuming
1307 correct multicast setup for these hosts).
1309 mcast support is compatible with User Mode Linux (argument @option{eth@var{N}=mcast}), see
1310 @url{http://user-mode-linux.sf.net}.
1312 Use @option{fd=h} to specify an already opened UDP multicast socket.
1317 # launch one QEMU instance
1318 qemu linux.img -net nic,macaddr=52:54:00:12:34:56 \
1319 -net socket,mcast=230.0.0.1:1234
1320 # launch another QEMU instance on same "bus
"
1321 qemu linux.img -net nic,macaddr=52:54:00:12:34:57 \
1322 -net socket,mcast=230.0.0.1:1234
1323 # launch yet another QEMU instance on same "bus
"
1324 qemu linux.img -net nic,macaddr=52:54:00:12:34:58 \
1325 -net socket,mcast=230.0.0.1:1234
1328 Example (User Mode Linux compat.):
1330 # launch QEMU instance (note mcast address selected
1332 qemu linux.img -net nic,macaddr=52:54:00:12:34:56 \
1333 -net socket,mcast=239.192.168.1:1102
1335 /path/to/linux ubd0=/path/to/root_fs eth0=mcast
1338 Example (send packets from host's 1.2.3.4):
1340 qemu linux.img -net nic,macaddr=52:54:00:12:34:56 \
1341 -net socket,mcast=239.192.168.1:1102,localaddr=1.2.3.4
1344 @item -net vde[,vlan=@var{n}][,name=@var{name}][,sock=@var{socketpath}] [,port=@var{n}][,group=@var{groupname}][,mode=@var{octalmode}]
1345 Connect VLAN @var{n} to PORT @var{n} of a vde switch running on host and
1346 listening for incoming connections on @var{socketpath}. Use GROUP @var{groupname}
1347 and MODE @var{octalmode} to change default ownership and permissions for
1348 communication port. This option is available only if QEMU has been compiled
1349 with vde support enabled.
1354 vde_switch -F -sock /tmp/myswitch
1355 # launch QEMU instance
1356 qemu linux.img -net nic -net vde,sock=/tmp/myswitch
1359 @item -net dump[,vlan=@var{n}][,file=@var{file}][,len=@var{len}]
1360 Dump network traffic on VLAN @var{n} to file @var{file} (@file{qemu-vlan0.pcap} by default).
1361 At most @var{len} bytes (64k by default) per packet are stored. The file format is
1362 libpcap, so it can be analyzed with tools such as tcpdump or Wireshark.
1365 Indicate that no network devices should be configured. It is used to
1366 override the default configuration (@option{-net nic -net user}) which
1367 is activated if no @option{-net} options are provided.
1374 DEFHEADING(Character device options:)
1376 DEF("chardev
", HAS_ARG, QEMU_OPTION_chardev,
1377 "-chardev
null,id
=id
[,mux
=on|off
]\n"
1378 "-chardev socket
,id
=id
[,host
=host
],port
=host
[,to
=to
][,ipv4
][,ipv6
][,nodelay
]\n"
1379 " [,server
][,nowait
][,telnet
][,mux
=on|off
] (tcp
)\n"
1380 "-chardev socket
,id
=id
,path
=path
[,server
][,nowait
][,telnet
],[mux
=on|off
] (unix
)\n"
1381 "-chardev udp
,id
=id
[,host
=host
],port
=port
[,localaddr
=localaddr
]\n"
1382 " [,localport
=localport
][,ipv4
][,ipv6
][,mux
=on|off
]\n"
1383 "-chardev msmouse
,id
=id
[,mux
=on|off
]\n"
1384 "-chardev vc
,id
=id
[[,width
=width
][,height
=height
]][[,cols
=cols
][,rows
=rows
]]\n"
1386 "-chardev file
,id
=id
,path
=path
[,mux
=on|off
]\n"
1387 "-chardev pipe
,id
=id
,path
=path
[,mux
=on|off
]\n"
1389 "-chardev console
,id
=id
[,mux
=on|off
]\n"
1390 "-chardev serial
,id
=id
,path
=path
[,mux
=on|off
]\n"
1392 "-chardev pty
,id
=id
[,mux
=on|off
]\n"
1393 "-chardev stdio
,id
=id
[,mux
=on|off
][,signal
=on|off
]\n"
1395 #ifdef CONFIG_BRLAPI
1396 "-chardev braille
,id
=id
[,mux
=on|off
]\n"
1398 #if defined(__linux__) || defined(__sun__) || defined(__FreeBSD__) \
1399 || defined(__NetBSD__) || defined(__OpenBSD__) || defined(__DragonFly__)
1400 "-chardev tty
,id
=id
,path
=path
[,mux
=on|off
]\n"
1402 #if defined(__linux__) || defined(__FreeBSD__) || defined(__DragonFly__)
1403 "-chardev parport
,id
=id
,path
=path
[,mux
=on|off
]\n"
1405 #if defined(CONFIG_SPICE)
1406 "-chardev spicevmc
,id
=id
,name
=name
[,debug
=debug
]\n"
1413 The general form of a character device option is:
1416 @item -chardev @var{backend} ,id=@var{id} [,mux=on|off] [,@var{options}]
1434 The specific backend will determine the applicable options.
1436 All devices must have an id, which can be any string up to 127 characters long.
1437 It is used to uniquely identify this device in other command line directives.
1439 A character device may be used in multiplexing mode by multiple front-ends.
1440 The key sequence of @key{Control-a} and @key{c} will rotate the input focus
1441 between attached front-ends. Specify @option{mux=on} to enable this mode.
1443 Options to each backend are described below.
1445 @item -chardev null ,id=@var{id}
1446 A void device. This device will not emit any data, and will drop any data it
1447 receives. The null backend does not take any options.
1449 @item -chardev socket ,id=@var{id} [@var{TCP options} or @var{unix options}] [,server] [,nowait] [,telnet]
1451 Create a two-way stream socket, which can be either a TCP or a unix socket. A
1452 unix socket will be created if @option{path} is specified. Behaviour is
1453 undefined if TCP options are specified for a unix socket.
1455 @option{server} specifies that the socket shall be a listening socket.
1457 @option{nowait} specifies that QEMU should not block waiting for a client to
1458 connect to a listening socket.
1460 @option{telnet} specifies that traffic on the socket should interpret telnet
1463 TCP and unix socket options are given below:
1467 @item TCP options: port=@var{port} [,host=@var{host}] [,to=@var{to}] [,ipv4] [,ipv6] [,nodelay]
1469 @option{host} for a listening socket specifies the local address to be bound.
1470 For a connecting socket species the remote host to connect to. @option{host} is
1471 optional for listening sockets. If not specified it defaults to @code{0.0.0.0}.
1473 @option{port} for a listening socket specifies the local port to be bound. For a
1474 connecting socket specifies the port on the remote host to connect to.
1475 @option{port} can be given as either a port number or a service name.
1476 @option{port} is required.
1478 @option{to} is only relevant to listening sockets. If it is specified, and
1479 @option{port} cannot be bound, QEMU will attempt to bind to subsequent ports up
1480 to and including @option{to} until it succeeds. @option{to} must be specified
1483 @option{ipv4} and @option{ipv6} specify that either IPv4 or IPv6 must be used.
1484 If neither is specified the socket may use either protocol.
1486 @option{nodelay} disables the Nagle algorithm.
1488 @item unix options: path=@var{path}
1490 @option{path} specifies the local path of the unix socket. @option{path} is
1495 @item -chardev udp ,id=@var{id} [,host=@var{host}] ,port=@var{port} [,localaddr=@var{localaddr}] [,localport=@var{localport}] [,ipv4] [,ipv6]
1497 Sends all traffic from the guest to a remote host over UDP.
1499 @option{host} specifies the remote host to connect to. If not specified it
1500 defaults to @code{localhost}.
1502 @option{port} specifies the port on the remote host to connect to. @option{port}
1505 @option{localaddr} specifies the local address to bind to. If not specified it
1506 defaults to @code{0.0.0.0}.
1508 @option{localport} specifies the local port to bind to. If not specified any
1509 available local port will be used.
1511 @option{ipv4} and @option{ipv6} specify that either IPv4 or IPv6 must be used.
1512 If neither is specified the device may use either protocol.
1514 @item -chardev msmouse ,id=@var{id}
1516 Forward QEMU's emulated msmouse events to the guest. @option{msmouse} does not
1519 @item -chardev vc ,id=@var{id} [[,width=@var{width}] [,height=@var{height}]] [[,cols=@var{cols}] [,rows=@var{rows}]]
1521 Connect to a QEMU text console. @option{vc} may optionally be given a specific
1524 @option{width} and @option{height} specify the width and height respectively of
1525 the console, in pixels.
1527 @option{cols} and @option{rows} specify that the console be sized to fit a text
1528 console with the given dimensions.
1530 @item -chardev file ,id=@var{id} ,path=@var{path}
1532 Log all traffic received from the guest to a file.
1534 @option{path} specifies the path of the file to be opened. This file will be
1535 created if it does not already exist, and overwritten if it does. @option{path}
1538 @item -chardev pipe ,id=@var{id} ,path=@var{path}
1540 Create a two-way connection to the guest. The behaviour differs slightly between
1541 Windows hosts and other hosts:
1543 On Windows, a single duplex pipe will be created at
1544 @file{\\.pipe\@option{path}}.
1546 On other hosts, 2 pipes will be created called @file{@option{path}.in} and
1547 @file{@option{path}.out}. Data written to @file{@option{path}.in} will be
1548 received by the guest. Data written by the guest can be read from
1549 @file{@option{path}.out}. QEMU will not create these fifos, and requires them to
1552 @option{path} forms part of the pipe path as described above. @option{path} is
1555 @item -chardev console ,id=@var{id}
1557 Send traffic from the guest to QEMU's standard output. @option{console} does not
1560 @option{console} is only available on Windows hosts.
1562 @item -chardev serial ,id=@var{id} ,path=@option{path}
1564 Send traffic from the guest to a serial device on the host.
1567 only available on Windows hosts.
1569 @option{path} specifies the name of the serial device to open.
1571 @item -chardev pty ,id=@var{id}
1573 Create a new pseudo-terminal on the host and connect to it. @option{pty} does
1574 not take any options.
1576 @option{pty} is not available on Windows hosts.
1578 @item -chardev stdio ,id=@var{id} [,signal=on|off]
1579 Connect to standard input and standard output of the qemu process.
1581 @option{signal} controls if signals are enabled on the terminal, that includes
1582 exiting QEMU with the key sequence @key{Control-c}. This option is enabled by
1583 default, use @option{signal=off} to disable it.
1585 @option{stdio} is not available on Windows hosts.
1587 @item -chardev braille ,id=@var{id}
1589 Connect to a local BrlAPI server. @option{braille} does not take any options.
1591 @item -chardev tty ,id=@var{id} ,path=@var{path}
1593 Connect to a local tty device.
1595 @option{tty} is only available on Linux, Sun, FreeBSD, NetBSD, OpenBSD and
1598 @option{path} specifies the path to the tty. @option{path} is required.
1600 @item -chardev parport ,id=@var{id} ,path=@var{path}
1602 @option{parport} is only available on Linux, FreeBSD and DragonFlyBSD hosts.
1604 Connect to a local parallel port.
1606 @option{path} specifies the path to the parallel port device. @option{path} is
1609 #if defined(CONFIG_SPICE)
1610 @item -chardev spicevmc ,id=@var{id} ,debug=@var{debug}, name=@var{name}
1612 @option{debug} debug level for spicevmc
1614 @option{name} name of spice channel to connect to
1616 Connect to a spice virtual machine channel, such as vdiport.
1624 DEFHEADING(Bluetooth(R) options:)
1626 DEF("bt
", HAS_ARG, QEMU_OPTION_bt, \
1627 "-bt hci
,null dumb bluetooth HCI
- doesn
't respond to commands\n" \
1628 "-bt hci,host[:id]\n" \
1629 " use host's HCI with the given name
\n" \
1630 "-bt hci
[,vlan
=n
]\n" \
1631 " emulate a standard HCI
in virtual scatternet
'n'\n" \
1632 "-bt vhci
[,vlan
=n
]\n" \
1633 " add host computer to virtual scatternet
'n' using VHCI
\n" \
1634 "-bt device
:dev
[,vlan
=n
]\n" \
1635 " emulate a bluetooth device
'dev' in scatternet
'n'\n",
1642 Defines the function of the corresponding Bluetooth HCI. -bt options
1643 are matched with the HCIs present in the chosen machine type. For
1644 example when emulating a machine with only one HCI built into it, only
1645 the first @code{-bt hci[...]} option is valid and defines the HCI's
1646 logic. The Transport Layer is decided by the machine type. Currently
1647 the machines @code{n800} and @code{n810} have one HCI and all other
1651 The following three types are recognized:
1655 (default) The corresponding Bluetooth HCI assumes no internal logic
1656 and will not respond to any HCI commands or emit events.
1658 @item -bt hci,host[:@var{id}]
1659 (@code{bluez} only) The corresponding HCI passes commands / events
1660 to / from the physical HCI identified by the name @var{id} (default:
1661 @code{hci0}) on the computer running QEMU. Only available on @code{bluez}
1662 capable systems like Linux.
1664 @item -bt hci[,vlan=@var{n}]
1665 Add a virtual, standard HCI that will participate in the Bluetooth
1666 scatternet @var{n} (default @code{0}). Similarly to @option{-net}
1667 VLANs, devices inside a bluetooth network @var{n} can only communicate
1668 with other devices in the same network (scatternet).
1671 @item -bt vhci[,vlan=@var{n}]
1672 (Linux-host only) Create a HCI in scatternet @var{n} (default 0) attached
1673 to the host bluetooth stack instead of to the emulated target. This
1674 allows the host and target machines to participate in a common scatternet
1675 and communicate. Requires the Linux @code{vhci} driver installed. Can
1676 be used as following:
1679 qemu [...OPTIONS...] -bt hci,vlan=5 -bt vhci,vlan=5
1682 @item -bt device:@var{dev}[,vlan=@var{n}]
1683 Emulate a bluetooth device @var{dev} and place it in network @var{n}
1684 (default @code{0}). QEMU can only emulate one type of bluetooth devices
1689 Virtual wireless keyboard implementing the HIDP bluetooth profile.
1696 DEFHEADING(Linux/Multiboot boot specific:)
1699 When using these options, you can use a given Linux or Multiboot
1700 kernel without installing it in the disk image. It can be useful
1701 for easier testing of various kernels.
1706 DEF("kernel
", HAS_ARG, QEMU_OPTION_kernel, \
1707 "-kernel bzImage use
'bzImage' as kernel image
\n", QEMU_ARCH_ALL)
1709 @item -kernel @var{bzImage}
1711 Use @var{bzImage} as kernel image. The kernel can be either a Linux kernel
1712 or in multiboot format.
1715 DEF("append
", HAS_ARG, QEMU_OPTION_append, \
1716 "-append cmdline use
'cmdline' as kernel command line
\n", QEMU_ARCH_ALL)
1718 @item -append @var{cmdline}
1720 Use @var{cmdline} as kernel command line
1723 DEF("initrd
", HAS_ARG, QEMU_OPTION_initrd, \
1724 "-initrd file use
'file' as initial ram disk
\n", QEMU_ARCH_ALL)
1726 @item -initrd @var{file}
1728 Use @var{file} as initial ram disk.
1730 @item -initrd "@
var{file1
} arg
=foo
,@
var{file2
}"
1732 This syntax is only available with multiboot.
1734 Use @var{file1} and @var{file2} as modules and pass arg=foo as parameter to the
1744 DEFHEADING(Debug/Expert options:)
1750 DEF("serial
", HAS_ARG, QEMU_OPTION_serial, \
1751 "-serial dev redirect the serial port to char device
'dev'\n",
1754 @item -serial @var{dev}
1756 Redirect the virtual serial port to host character device
1757 @var{dev}. The default device is @code{vc} in graphical mode and
1758 @code{stdio} in non graphical mode.
1760 This option can be used several times to simulate up to 4 serial
1763 Use @code{-serial none} to disable all serial ports.
1765 Available character devices are:
1767 @item vc[:@var{W}x@var{H}]
1768 Virtual console. Optionally, a width and height can be given in pixel with
1772 It is also possible to specify width or height in characters:
1777 [Linux only] Pseudo TTY (a new PTY is automatically allocated)
1779 No device is allocated.
1783 [Linux only] Use host tty, e.g. @file{/dev/ttyS0}. The host serial port
1784 parameters are set according to the emulated ones.
1785 @item /dev/parport@var{N}
1786 [Linux only, parallel port only] Use host parallel port
1787 @var{N}. Currently SPP and EPP parallel port features can be used.
1788 @item file:@var{filename}
1789 Write output to @var{filename}. No character can be read.
1791 [Unix only] standard input/output
1792 @item pipe:@var{filename}
1793 name pipe @var{filename}
1795 [Windows only] Use host serial port @var{n}
1796 @item udp:[@var{remote_host}]:@var{remote_port}[@@[@var{src_ip}]:@var{src_port}]
1797 This implements UDP Net Console.
1798 When @var{remote_host} or @var{src_ip} are not specified
1799 they default to @code{0.0.0.0}.
1800 When not using a specified @var{src_port} a random port is automatically chosen.
1802 If you just want a simple readonly console you can use @code{netcat} or
1803 @code{nc}, by starting qemu with: @code{-serial udp::4555} and nc as:
1804 @code{nc -u -l -p 4555}. Any time qemu writes something to that port it
1805 will appear in the netconsole session.
1807 If you plan to send characters back via netconsole or you want to stop
1808 and start qemu a lot of times, you should have qemu use the same
1809 source port each time by using something like @code{-serial
1810 udp::4555@@:4556} to qemu. Another approach is to use a patched
1811 version of netcat which can listen to a TCP port and send and receive
1812 characters via udp. If you have a patched version of netcat which
1813 activates telnet remote echo and single char transfer, then you can
1814 use the following options to step up a netcat redirector to allow
1815 telnet on port 5555 to access the qemu port.
1818 -serial udp::4555@@:4556
1819 @item netcat options:
1820 -u -P 4555 -L 0.0.0.0:4556 -t -p 5555 -I -T
1821 @item telnet options:
1825 @item tcp:[@var{host}]:@var{port}[,@var{server}][,nowait][,nodelay]
1826 The TCP Net Console has two modes of operation. It can send the serial
1827 I/O to a location or wait for a connection from a location. By default
1828 the TCP Net Console is sent to @var{host} at the @var{port}. If you use
1829 the @var{server} option QEMU will wait for a client socket application
1830 to connect to the port before continuing, unless the @code{nowait}
1831 option was specified. The @code{nodelay} option disables the Nagle buffering
1832 algorithm. If @var{host} is omitted, 0.0.0.0 is assumed. Only
1833 one TCP connection at a time is accepted. You can use @code{telnet} to
1834 connect to the corresponding character device.
1836 @item Example to send tcp console to 192.168.0.2 port 4444
1837 -serial tcp:192.168.0.2:4444
1838 @item Example to listen and wait on port 4444 for connection
1839 -serial tcp::4444,server
1840 @item Example to not wait and listen on ip 192.168.0.100 port 4444
1841 -serial tcp:192.168.0.100:4444,server,nowait
1844 @item telnet:@var{host}:@var{port}[,server][,nowait][,nodelay]
1845 The telnet protocol is used instead of raw tcp sockets. The options
1846 work the same as if you had specified @code{-serial tcp}. The
1847 difference is that the port acts like a telnet server or client using
1848 telnet option negotiation. This will also allow you to send the
1849 MAGIC_SYSRQ sequence if you use a telnet that supports sending the break
1850 sequence. Typically in unix telnet you do it with Control-] and then
1851 type "send
break" followed by pressing the enter key.
1853 @item unix:@var{path}[,server][,nowait]
1854 A unix domain socket is used instead of a tcp socket. The option works the
1855 same as if you had specified @code{-serial tcp} except the unix domain socket
1856 @var{path} is used for connections.
1858 @item mon:@var{dev_string}
1859 This is a special option to allow the monitor to be multiplexed onto
1860 another serial port. The monitor is accessed with key sequence of
1861 @key{Control-a} and then pressing @key{c}. See monitor access
1862 @ref{pcsys_keys} in the -nographic section for more keys.
1863 @var{dev_string} should be any one of the serial devices specified
1864 above. An example to multiplex the monitor onto a telnet server
1865 listening on port 4444 would be:
1867 @item -serial mon:telnet::4444,server,nowait
1871 Braille device. This will use BrlAPI to display the braille output on a real
1875 Three button serial mouse. Configure the guest to use Microsoft protocol.
1879 DEF("parallel
", HAS_ARG, QEMU_OPTION_parallel, \
1880 "-parallel dev redirect the parallel port to char device
'dev'\n",
1883 @item -parallel @var{dev}
1885 Redirect the virtual parallel port to host device @var{dev} (same
1886 devices as the serial port). On Linux hosts, @file{/dev/parportN} can
1887 be used to use hardware devices connected on the corresponding host
1890 This option can be used several times to simulate up to 3 parallel
1893 Use @code{-parallel none} to disable all parallel ports.
1896 DEF("monitor
", HAS_ARG, QEMU_OPTION_monitor, \
1897 "-monitor dev redirect the monitor to char device
'dev'\n",
1900 @item -monitor @var{dev}
1902 Redirect the monitor to host device @var{dev} (same devices as the
1904 The default device is @code{vc} in graphical mode and @code{stdio} in
1907 DEF("qmp
", HAS_ARG, QEMU_OPTION_qmp, \
1908 "-qmp dev like
-monitor but opens
in 'control' mode
\n",
1911 @item -qmp @var{dev}
1913 Like -monitor but opens in 'control' mode.
1916 DEF("mon
", HAS_ARG, QEMU_OPTION_mon, \
1917 "-mon chardev
=[name
][,mode
=readline|control
][,default]\n", QEMU_ARCH_ALL)
1919 @item -mon chardev=[name][,mode=readline|control][,default]
1921 Setup monitor on chardev @var{name}.
1924 DEF("debugcon
", HAS_ARG, QEMU_OPTION_debugcon, \
1925 "-debugcon dev redirect the debug console to char device
'dev'\n",
1928 @item -debugcon @var{dev}
1930 Redirect the debug console to host device @var{dev} (same devices as the
1931 serial port). The debug console is an I/O port which is typically port
1932 0xe9; writing to that I/O port sends output to this device.
1933 The default device is @code{vc} in graphical mode and @code{stdio} in
1937 DEF("pidfile
", HAS_ARG, QEMU_OPTION_pidfile, \
1938 "-pidfile file write PID to
'file'\n", QEMU_ARCH_ALL)
1940 @item -pidfile @var{file}
1942 Store the QEMU process PID in @var{file}. It is useful if you launch QEMU
1946 DEF("singlestep
", 0, QEMU_OPTION_singlestep, \
1947 "-singlestep always run
in singlestep mode
\n", QEMU_ARCH_ALL)
1951 Run the emulation in single step mode.
1954 DEF("S
", 0, QEMU_OPTION_S, \
1955 "-S freeze CPU at
startup (use
'c' to start execution
)\n",
1960 Do not start CPU at startup (you must type 'c' in the monitor).
1963 DEF("gdb
", HAS_ARG, QEMU_OPTION_gdb, \
1964 "-gdb dev wait
for gdb connection on
'dev'\n", QEMU_ARCH_ALL)
1966 @item -gdb @var{dev}
1968 Wait for gdb connection on device @var{dev} (@pxref{gdb_usage}). Typical
1969 connections will likely be TCP-based, but also UDP, pseudo TTY, or even
1970 stdio are reasonable use case. The latter is allowing to start qemu from
1971 within gdb and establish the connection via a pipe:
1973 (gdb) target remote | exec qemu -gdb stdio ...
1977 DEF("s
", 0, QEMU_OPTION_s, \
1978 "-s shorthand
for -gdb tcp
::" DEFAULT_GDBSTUB_PORT "\n",
1983 Shorthand for -gdb tcp::1234, i.e. open a gdbserver on TCP port 1234
1984 (@pxref{gdb_usage}).
1987 DEF("d
", HAS_ARG, QEMU_OPTION_d, \
1988 "-d item1
,... output log to
/tmp
/qemu
.log (use
-d ?
for a list of log items
)\n",
1993 Output log in /tmp/qemu.log
1996 DEF("hdachs
", HAS_ARG, QEMU_OPTION_hdachs, \
1997 "-hdachs c
,h
,s
[,t
]\n" \
1998 " force hard disk
0 physical geometry and the optional BIOS
\n" \
1999 " translation (t
=none or lba
) (usually qemu can guess them
)\n",
2002 @item -hdachs @var{c},@var{h},@var{s},[,@var{t}]
2004 Force hard disk 0 physical geometry (1 <= @var{c} <= 16383, 1 <=
2005 @var{h} <= 16, 1 <= @var{s} <= 63) and optionally force the BIOS
2006 translation mode (@var{t}=none, lba or auto). Usually QEMU can guess
2007 all those parameters. This option is useful for old MS-DOS disk
2011 DEF("L
", HAS_ARG, QEMU_OPTION_L, \
2012 "-L path set the directory
for the BIOS
, VGA BIOS and keymaps
\n",
2017 Set the directory for the BIOS, VGA BIOS and keymaps.
2020 DEF("bios
", HAS_ARG, QEMU_OPTION_bios, \
2021 "-bios file set the filename
for the BIOS
\n", QEMU_ARCH_ALL)
2023 @item -bios @var{file}
2025 Set the filename for the BIOS.
2028 DEF("enable
-kvm
", 0, QEMU_OPTION_enable_kvm, \
2029 "-enable
-kvm enable KVM full virtualization support
\n", QEMU_ARCH_ALL)
2033 Enable KVM full virtualization support. This option is only available
2034 if KVM support is enabled when compiling.
2037 DEF("machine
", HAS_ARG, QEMU_OPTION_machine, \
2038 "-machine accel
=accel1
[:accel2
] use an
accelerator (kvm
,xen
,tcg
), default is tcg
\n", QEMU_ARCH_ALL)
2040 @item -machine accel=@var{accels}
2042 This is use to enable an accelerator, in kvm,xen,tcg.
2043 By default, it use only tcg. If there a more than one accelerator
2044 specified, the next one is used if the first don't work.
2047 DEF("xen
-domid
", HAS_ARG, QEMU_OPTION_xen_domid,
2048 "-xen
-domid id specify xen guest domain id
\n", QEMU_ARCH_ALL)
2049 DEF("xen
-create
", 0, QEMU_OPTION_xen_create,
2050 "-xen
-create create domain
using xen hypercalls
, bypassing xend
\n"
2051 " warning
: should not be used when xend is
in use
\n",
2053 DEF("xen
-attach
", 0, QEMU_OPTION_xen_attach,
2054 "-xen
-attach attach to existing xen domain
\n"
2055 " xend will use
this when starting qemu
\n",
2058 @item -xen-domid @var{id}
2060 Specify xen guest domain @var{id} (XEN only).
2063 Create domain using xen hypercalls, bypassing xend.
2064 Warning: should not be used when xend is in use (XEN only).
2067 Attach to existing xen domain.
2068 xend will use this when starting qemu (XEN only).
2071 DEF("no
-reboot
", 0, QEMU_OPTION_no_reboot, \
2072 "-no
-reboot exit instead of rebooting
\n", QEMU_ARCH_ALL)
2076 Exit instead of rebooting.
2079 DEF("no
-shutdown
", 0, QEMU_OPTION_no_shutdown, \
2080 "-no
-shutdown stop before shutdown
\n", QEMU_ARCH_ALL)
2083 @findex -no-shutdown
2084 Don't exit QEMU on guest shutdown, but instead only stop the emulation.
2085 This allows for instance switching to monitor to commit changes to the
2089 DEF("loadvm
", HAS_ARG, QEMU_OPTION_loadvm, \
2090 "-loadvm
[tag|id
]\n" \
2091 " start right away with a saved
state (loadvm
in monitor
)\n",
2094 @item -loadvm @var{file}
2096 Start right away with a saved state (@code{loadvm} in monitor)
2100 DEF("daemonize
", 0, QEMU_OPTION_daemonize, \
2101 "-daemonize daemonize QEMU after initializing
\n", QEMU_ARCH_ALL)
2106 Daemonize the QEMU process after initialization. QEMU will not detach from
2107 standard IO until it is ready to receive connections on any of its devices.
2108 This option is a useful way for external programs to launch QEMU without having
2109 to cope with initialization race conditions.
2112 DEF("option
-rom
", HAS_ARG, QEMU_OPTION_option_rom, \
2113 "-option
-rom rom load a file
, rom
, into the option ROM space
\n",
2116 @item -option-rom @var{file}
2118 Load the contents of @var{file} as an option ROM.
2119 This option is useful to load things like EtherBoot.
2122 DEF("clock
", HAS_ARG, QEMU_OPTION_clock, \
2123 "-clock force the use of the given methods
for timer alarm
.\n" \
2124 " To see what timers are available use
-clock ?
\n",
2127 @item -clock @var{method}
2129 Force the use of the given methods for timer alarm. To see what timers
2130 are available use -clock ?.
2133 HXCOMM Options deprecated by -rtc
2134 DEF("localtime
", 0, QEMU_OPTION_localtime, "", QEMU_ARCH_ALL)
2135 DEF("startdate
", HAS_ARG, QEMU_OPTION_startdate, "", QEMU_ARCH_ALL)
2137 DEF("rtc
", HAS_ARG, QEMU_OPTION_rtc, \
2138 "-rtc
[base
=utc|localtime|date
][,clock
=host|vm
][,driftfix
=none|slew
]\n" \
2139 " set the RTC base and clock
, enable drift fix
for clock
ticks (x86 only
)\n",
2144 @item -rtc [base=utc|localtime|@var{date}][,clock=host|vm][,driftfix=none|slew]
2146 Specify @option{base} as @code{utc} or @code{localtime} to let the RTC start at the current
2147 UTC or local time, respectively. @code{localtime} is required for correct date in
2148 MS-DOS or Windows. To start at a specific point in time, provide @var{date} in the
2149 format @code{2006-06-17T16:01:21} or @code{2006-06-17}. The default base is UTC.
2151 By default the RTC is driven by the host system time. This allows to use the
2152 RTC as accurate reference clock inside the guest, specifically if the host
2153 time is smoothly following an accurate external reference clock, e.g. via NTP.
2154 If you want to isolate the guest time from the host, even prevent it from
2155 progressing during suspension, you can set @option{clock} to @code{vm} instead.
2157 Enable @option{driftfix} (i386 targets only) if you experience time drift problems,
2158 specifically with Windows' ACPI HAL. This option will try to figure out how
2159 many timer interrupts were not processed by the Windows guest and will
2163 DEF("icount
", HAS_ARG, QEMU_OPTION_icount, \
2164 "-icount
[N|auto
]\n" \
2165 " enable virtual instruction counter with
2^N clock ticks per
\n" \
2166 " instruction
\n", QEMU_ARCH_ALL)
2168 @item -icount [@var{N}|auto]
2170 Enable virtual instruction counter. The virtual cpu will execute one
2171 instruction every 2^@var{N} ns of virtual time. If @code{auto} is specified
2172 then the virtual cpu speed will be automatically adjusted to keep virtual
2173 time within a few seconds of real time.
2175 Note that while this option can give deterministic behavior, it does not
2176 provide cycle accurate emulation. Modern CPUs contain superscalar out of
2177 order cores with complex cache hierarchies. The number of instructions
2178 executed often has little or no correlation with actual performance.
2181 DEF("watchdog
", HAS_ARG, QEMU_OPTION_watchdog, \
2182 "-watchdog i6300esb|ib700
\n" \
2183 " enable virtual hardware watchdog
[default=none
]\n",
2186 @item -watchdog @var{model}
2188 Create a virtual hardware watchdog device. Once enabled (by a guest
2189 action), the watchdog must be periodically polled by an agent inside
2190 the guest or else the guest will be restarted.
2192 The @var{model} is the model of hardware watchdog to emulate. Choices
2193 for model are: @code{ib700} (iBASE 700) which is a very simple ISA
2194 watchdog with a single timer, or @code{i6300esb} (Intel 6300ESB I/O
2195 controller hub) which is a much more featureful PCI-based dual-timer
2196 watchdog. Choose a model for which your guest has drivers.
2198 Use @code{-watchdog ?} to list available hardware models. Only one
2199 watchdog can be enabled for a guest.
2202 DEF("watchdog
-action
", HAS_ARG, QEMU_OPTION_watchdog_action, \
2203 "-watchdog
-action reset|shutdown|poweroff|pause|debug|none
\n" \
2204 " action when watchdog fires
[default=reset
]\n",
2207 @item -watchdog-action @var{action}
2209 The @var{action} controls what QEMU will do when the watchdog timer
2212 @code{reset} (forcefully reset the guest).
2213 Other possible actions are:
2214 @code{shutdown} (attempt to gracefully shutdown the guest),
2215 @code{poweroff} (forcefully poweroff the guest),
2216 @code{pause} (pause the guest),
2217 @code{debug} (print a debug message and continue), or
2218 @code{none} (do nothing).
2220 Note that the @code{shutdown} action requires that the guest responds
2221 to ACPI signals, which it may not be able to do in the sort of
2222 situations where the watchdog would have expired, and thus
2223 @code{-watchdog-action shutdown} is not recommended for production use.
2228 @item -watchdog i6300esb -watchdog-action pause
2229 @item -watchdog ib700
2233 DEF("echr
", HAS_ARG, QEMU_OPTION_echr, \
2234 "-echr chr set terminal escape character instead of ctrl
-a
\n",
2238 @item -echr @var{numeric_ascii_value}
2240 Change the escape character used for switching to the monitor when using
2241 monitor and serial sharing. The default is @code{0x01} when using the
2242 @code{-nographic} option. @code{0x01} is equal to pressing
2243 @code{Control-a}. You can select a different character from the ascii
2244 control keys where 1 through 26 map to Control-a through Control-z. For
2245 instance you could use the either of the following to change the escape
2246 character to Control-t.
2253 DEF("virtioconsole
", HAS_ARG, QEMU_OPTION_virtiocon, \
2254 "-virtioconsole c
\n" \
2255 " set virtio console
\n", QEMU_ARCH_ALL)
2257 @item -virtioconsole @var{c}
2258 @findex -virtioconsole
2261 This option is maintained for backward compatibility.
2263 Please use @code{-device virtconsole} for the new way of invocation.
2266 DEF("show
-cursor
", 0, QEMU_OPTION_show_cursor, \
2267 "-show
-cursor show cursor
\n", QEMU_ARCH_ALL)
2270 @findex -show-cursor
2274 DEF("tb
-size
", HAS_ARG, QEMU_OPTION_tb_size, \
2275 "-tb
-size n set TB size
\n", QEMU_ARCH_ALL)
2277 @item -tb-size @var{n}
2282 DEF("incoming
", HAS_ARG, QEMU_OPTION_incoming, \
2283 "-incoming p prepare
for incoming migration
, listen on port p
\n",
2286 @item -incoming @var{port}
2288 Prepare for incoming migration, listen on @var{port}.
2291 DEF("nodefaults
", 0, QEMU_OPTION_nodefaults, \
2292 "-nodefaults don
't create default devices\n", QEMU_ARCH_ALL)
2296 Don't create
default devices
.
2300 DEF("chroot", HAS_ARG
, QEMU_OPTION_chroot
, \
2301 "-chroot dir chroot to dir just before starting the VM\n",
2305 @item
-chroot @
var{dir
}
2307 Immediately before starting guest execution
, chroot to the specified
2308 directory
. Especially useful
in combination with
-runas
.
2312 DEF("runas", HAS_ARG
, QEMU_OPTION_runas
, \
2313 "-runas user change to user id user just before starting the VM\n",
2317 @item
-runas @
var{user
}
2319 Immediately before starting guest execution
, drop root privileges
, switching
2320 to the specified user
.
2323 DEF("prom-env", HAS_ARG
, QEMU_OPTION_prom_env
,
2324 "-prom-env variable=value\n"
2325 " set OpenBIOS nvram variables\n",
2326 QEMU_ARCH_PPC | QEMU_ARCH_SPARC
)
2328 @item
-prom
-env @
var{variable
}=@
var{value
}
2330 Set OpenBIOS nvram @
var{variable
} to given @
var{value
} (PPC
, SPARC only
).
2332 DEF("semihosting", 0, QEMU_OPTION_semihosting
,
2333 "-semihosting semihosting mode\n", QEMU_ARCH_ARM | QEMU_ARCH_M68K
)
2336 @findex
-semihosting
2337 Semihosting
mode (ARM
, M68K only
).
2339 DEF("old-param", 0, QEMU_OPTION_old_param
,
2340 "-old-param old param mode\n", QEMU_ARCH_ARM
)
2343 @findex
-old
-param (ARM
)
2344 Old param
mode (ARM only
).
2347 DEF("readconfig", HAS_ARG
, QEMU_OPTION_readconfig
,
2348 "-readconfig <file>\n", QEMU_ARCH_ALL
)
2350 @item
-readconfig @
var{file
}
2352 Read device configuration from @
var{file
}.
2354 DEF("writeconfig", HAS_ARG
, QEMU_OPTION_writeconfig
,
2355 "-writeconfig <file>\n"
2356 " read/write config file\n", QEMU_ARCH_ALL
)
2358 @item
-writeconfig @
var{file
}
2359 @findex
-writeconfig
2360 Write device configuration to @
var{file
}.
2362 DEF("nodefconfig", 0, QEMU_OPTION_nodefconfig
,
2364 " do not load default config files at startup\n",
2368 @findex
-nodefconfig
2369 Normally QEMU loads a configuration file from @
var{sysconfdir
}/qemu
.conf and
2370 @
var{sysconfdir
}/target
-@
var{ARCH
}.conf on startup
. The @code
{-nodefconfig
}
2371 option will prevent QEMU from loading these configuration files at startup
.
2373 #ifdef CONFIG_SIMPLE_TRACE
2374 DEF("trace", HAS_ARG
, QEMU_OPTION_trace
,
2376 " Specify a trace file to log traces to\n",
2381 Specify a
trace file to log output traces to
.
2385 DEF("no-kvm", 0, QEMU_OPTION_no_kvm
,
2386 "-no-kvm disable KVM hardware virtualization\n",
2388 DEF("no-kvm-irqchip", 0, QEMU_OPTION_no_kvm_irqchip
,
2389 "-no-kvm-irqchip disable KVM kernel mode PIC/IOAPIC/LAPIC\n",
2391 DEF("no-kvm-pit", 0, QEMU_OPTION_no_kvm_pit
,
2392 "-no-kvm-pit disable KVM kernel mode PIT\n",
2394 DEF("no-kvm-pit-reinjection", 0, QEMU_OPTION_no_kvm_pit_reinjection
,
2395 "-no-kvm-pit-reinjection\n"
2396 " disable KVM kernel mode PIT interrupt reinjection\n",
2398 DEF("enable-nesting", 0, QEMU_OPTION_enable_nesting
,
2399 "-enable-nesting enable support for running a VM inside the VM (AMD only)\n", QEMU_ARCH_I386
)
2400 DEF("nvram", HAS_ARG
, QEMU_OPTION_nvram
,
2401 "-nvram FILE provide ia64 nvram contents\n", QEMU_ARCH_ALL
)
2402 DEF("tdf", 0, QEMU_OPTION_tdf
,
2403 "-tdf enable guest time drift compensation\n", QEMU_ARCH_ALL
)
2404 DEF("kvm-shadow-memory", HAS_ARG
, QEMU_OPTION_kvm_shadow_memory
,
2405 "-kvm-shadow-memory MEGABYTES\n"
2406 " allocate MEGABYTES for kvm mmu shadowing\n",
2409 HXCOMM This is the last statement
. Insert
new options before
this line
!