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("machine", HAS_ARG
, QEMU_OPTION_machine
, \
31 "-machine [type=]name[,prop[=value][,...]]\n"
32 " selects emulated machine (-machine ? for list)\n"
33 " property accel=accel1[:accel2[:...]] selects accelerator\n"
34 " supported accelerators are kvm, xen, tcg (default: tcg)\n",
37 @item
-machine
[type
=]@
var{name
}[,prop
=@
var{value
}[,...]]
39 Select the emulated machine by @
var{name
}. Use @code
{-machine ?
} to list
40 available machines
. Supported machine properties are
:
42 @item accel
=@
var{accels1
}[:@
var{accels2
}[:...]]
43 This is used to enable an accelerator
. Depending on the target architecture
,
44 kvm
, xen
, or tcg can be available
. By
default, tcg is used
. If there is more
45 than one accelerator specified
, the next one is used
if the previous one fails
50 HXCOMM Deprecated by
-machine
51 DEF("M", HAS_ARG
, QEMU_OPTION_M
, "", QEMU_ARCH_ALL
)
53 DEF("cpu", HAS_ARG
, QEMU_OPTION_cpu
,
54 "-cpu cpu select CPU (-cpu ? for list)\n", QEMU_ARCH_ALL
)
56 @item
-cpu @
var{model
}
58 Select CPU
model (-cpu ?
for list and additional feature selection
)
61 DEF("smp", HAS_ARG
, QEMU_OPTION_smp
,
62 "-smp n[,maxcpus=cpus][,cores=cores][,threads=threads][,sockets=sockets]\n"
63 " set the number of CPUs to 'n' [default=1]\n"
64 " maxcpus= maximum number of total cpus, including\n"
65 " offline CPUs for hotplug, etc\n"
66 " cores= number of CPU cores on one socket\n"
67 " threads= number of threads on one CPU core\n"
68 " sockets= number of discrete sockets in the system\n",
71 @item
-smp @
var{n
}[,cores
=@
var{cores
}][,threads
=@
var{threads
}][,sockets
=@
var{sockets
}][,maxcpus
=@
var{maxcpus
}]
73 Simulate an SMP system with @
var{n
} CPUs
. On the PC target
, up to
255
74 CPUs are supported
. On Sparc32 target
, Linux limits the number of usable CPUs
76 For the PC target
, the number of @
var{cores
} per socket
, the number
77 of @
var{threads
} per cores and the total number of @
var{sockets
} can be
78 specified
. Missing values will be computed
. If any on the three values is
79 given
, the total number of CPUs @
var{n
} can be omitted
. @
var{maxcpus
}
80 specifies the maximum number of hotpluggable CPUs
.
83 DEF("numa", HAS_ARG
, QEMU_OPTION_numa
,
84 "-numa node[,mem=size][,cpus=cpu[-cpu]][,nodeid=node]\n", QEMU_ARCH_ALL
)
86 @item
-numa @
var{opts
}
88 Simulate a multi node NUMA system
. If mem and cpus are omitted
, resources
92 DEF("fda", HAS_ARG
, QEMU_OPTION_fda
,
93 "-fda/-fdb file use 'file' as floppy disk 0/1 image\n", QEMU_ARCH_ALL
)
94 DEF("fdb", HAS_ARG
, QEMU_OPTION_fdb
, "", QEMU_ARCH_ALL
)
100 Use @
var{file
} as floppy disk
0/1 image (@pxref
{disk_images
}). You can
101 use the host floppy by
using @file
{/dev
/fd0
} as
filename (@pxref
{host_drives
}).
104 DEF("hda", HAS_ARG
, QEMU_OPTION_hda
,
105 "-hda/-hdb file use 'file' as IDE hard disk 0/1 image\n", QEMU_ARCH_ALL
)
106 DEF("hdb", HAS_ARG
, QEMU_OPTION_hdb
, "", QEMU_ARCH_ALL
)
107 DEF("hdc", HAS_ARG
, QEMU_OPTION_hdc
,
108 "-hdc/-hdd file use 'file' as IDE hard disk 2/3 image\n", QEMU_ARCH_ALL
)
109 DEF("hdd", HAS_ARG
, QEMU_OPTION_hdd
, "", QEMU_ARCH_ALL
)
111 @item
-hda @
var{file
}
112 @item
-hdb @
var{file
}
113 @item
-hdc @
var{file
}
114 @item
-hdd @
var{file
}
119 Use @
var{file
} as hard disk
0, 1, 2 or
3 image (@pxref
{disk_images
}).
122 DEF("cdrom", HAS_ARG
, QEMU_OPTION_cdrom
,
123 "-cdrom file use 'file' as IDE cdrom image (cdrom is ide1 master)\n",
126 @item
-cdrom @
var{file
}
128 Use @
var{file
} as CD
-ROM
image (you cannot use @option
{-hdc
} and
129 @option
{-cdrom
} at the same time
). You can use the host CD
-ROM by
130 using @file
{/dev
/cdrom
} as
filename (@pxref
{host_drives
}).
133 DEF("drive", HAS_ARG
, QEMU_OPTION_drive
,
134 "-drive [file=file][,if=type][,bus=n][,unit=m][,media=d][,index=i]\n"
135 " [,cyls=c,heads=h,secs=s[,trans=t]][,snapshot=on|off]\n"
136 " [,cache=writethrough|writeback|none|unsafe][,format=f]\n"
137 " [,serial=s][,addr=A][,id=name][,aio=threads|native]\n"
138 " [,readonly=on|off][,boot=on|off]\n"
139 " use 'file' as a drive image\n", QEMU_ARCH_ALL
)
141 @item
-drive @
var{option
}[,@
var{option
}[,@
var{option
}[,...]]]
144 Define a
new drive
. Valid options are
:
147 @item file
=@
var{file
}
148 This option defines which disk
image (@pxref
{disk_images
}) to use with
149 this drive
. If the filename contains comma
, you must double it
150 (for instance
, "file=my,,file" to use file
"my,file").
151 @item
if=@
var{interface}
152 This option defines on which type on
interface the drive is connected
.
153 Available types are
: ide
, scsi
, sd
, mtd
, floppy
, pflash
, virtio
.
154 @item bus
=@
var{bus
},unit
=@
var{unit
}
155 These options define where is connected the drive by defining the bus number and
157 @item index
=@
var{index
}
158 This option defines where is connected the drive by
using an index
in the list
159 of available connectors of a given
interface type
.
160 @item media
=@
var{media
}
161 This option defines the type of the media
: disk or cdrom
.
162 @item cyls
=@
var{c
},heads
=@
var{h
},secs
=@
var{s
}[,trans
=@
var{t
}]
163 These options have the same definition as they have
in @option
{-hdachs
}.
164 @item snapshot
=@
var{snapshot
}
165 @
var{snapshot
} is
"on" or
"off" and allows to enable snapshot
for given
drive (see @option
{-snapshot
}).
166 @item cache
=@
var{cache
}
167 @
var{cache
} is
"none", "writeback", "unsafe", or
"writethrough" and controls how the host cache is used to access block data
.
169 @
var{aio
} is
"threads", or
"native" and selects between pthread based disk I
/O and native Linux AIO
.
170 @item format
=@
var{format
}
171 Specify which disk @
var{format
} will be used rather than detecting
172 the format
. Can be used to specifiy format
=raw to avoid interpreting
173 an untrusted format header
.
174 @item serial
=@
var{serial
}
175 This option specifies the serial number to assign to the device
.
176 @item addr
=@
var{addr
}
177 Specify the controller
's PCI address (if=virtio only).
178 @item werror=@var{action},rerror=@var{action}
179 Specify which @var{action} to take on write and read errors. Valid actions are:
180 "ignore" (ignore the error and try to continue), "stop" (pause QEMU),
181 "report" (report the error to the guest), "enospc" (pause QEMU only if the
182 host disk is full; report the error to the guest otherwise).
183 The default setting is @option{werror=enospc} and @option{rerror=report}.
185 Open drive @option{file} as read-only. Guest write attempts will fail.
186 @item boot=@var{boot}
187 @var{boot} is "on" or "off" and allows for booting from non-traditional interfaces, such as virtio.
190 By default, writethrough caching is used for all block device. This means that
191 the host page cache will be used to read and write data but write notification
192 will be sent to the guest only when the data has been reported as written by
193 the storage subsystem.
195 Writeback caching will report data writes as completed as soon as the data is
196 present in the host page cache. This is safe as long as you trust your host.
197 If your host crashes or loses power, then the guest may experience data
200 The host page cache can be avoided entirely with @option{cache=none}. This will
201 attempt to do disk IO directly to the guests memory. QEMU may still perform
202 an internal copy of the data.
204 Some block drivers perform badly with @option{cache=writethrough}, most notably,
205 qcow2. If performance is more important than correctness,
206 @option{cache=writeback} should be used with qcow2.
208 In case you don't care about data integrity over host failures
, use
209 cache
=unsafe
. This option tells qemu that it
never needs to write any data
210 to the disk but can instead keeps things
in cache
. If anything goes wrong
,
211 like your host losing power
, the disk storage getting disconnected accidently
,
212 etc
. you
're image will most probably be rendered unusable. When using
213 the @option{-snapshot} option, unsafe caching is always used.
215 Instead of @option{-cdrom} you can use:
217 qemu -drive file=file,index=2,media=cdrom
220 Instead of @option{-hda}, @option{-hdb}, @option{-hdc}, @option{-hdd}, you can
223 qemu -drive file=file,index=0,media=disk
224 qemu -drive file=file,index=1,media=disk
225 qemu -drive file=file,index=2,media=disk
226 qemu -drive file=file,index=3,media=disk
229 You can connect a CDROM to the slave of ide0:
231 qemu -drive file=file,if=ide,index=1,media=cdrom
234 If you don't specify the
"file=" argument
, you define an empty drive
:
236 qemu
-drive
if=ide
,index
=1,media
=cdrom
239 You can connect a SCSI disk with unit ID
6 on the bus #
0:
241 qemu
-drive file
=file
,if=scsi
,bus
=0,unit
=6
244 Instead of @option
{-fda
}, @option
{-fdb
}, you can use
:
246 qemu
-drive file
=file
,index
=0,if=floppy
247 qemu
-drive file
=file
,index
=1,if=floppy
250 By
default, @
var{interface} is
"ide" and @
var{index
} is automatically
253 qemu
-drive file
=a
-drive file
=b
"
261 DEF("set
", HAS_ARG, QEMU_OPTION_set,
262 "-set group
.id
.arg
=value
\n"
263 " set
<arg
> parameter
for item
<id
> of type
<group
>\n"
264 " i
.e
. -set drive
.$id
.file
=/path
/to
/image
\n", QEMU_ARCH_ALL)
271 DEF("global
", HAS_ARG, QEMU_OPTION_global,
272 "-global driver
.property
=value
\n"
273 " set a global
default for a driver property
\n",
281 DEF("mtdblock
", HAS_ARG, QEMU_OPTION_mtdblock,
282 "-mtdblock file use
'file' as on
-board Flash memory image
\n",
285 @item -mtdblock @var{file}
287 Use @var{file} as on-board Flash memory image.
290 DEF("sd
", HAS_ARG, QEMU_OPTION_sd,
291 "-sd file use
'file' as SecureDigital card image
\n", QEMU_ARCH_ALL)
295 Use @var{file} as SecureDigital card image.
298 DEF("pflash
", HAS_ARG, QEMU_OPTION_pflash,
299 "-pflash file use
'file' as a parallel flash image
\n", QEMU_ARCH_ALL)
301 @item -pflash @var{file}
303 Use @var{file} as a parallel flash image.
306 DEF("boot
", HAS_ARG, QEMU_OPTION_boot,
307 "-boot
[order
=drives
][,once
=drives
][,menu
=on|off
]\n"
308 " [,splash
=sp_name
][,splash
-time
=sp_time
]\n"
309 " 'drives': floppy (a
), hard
disk (c
), CD
-ROM (d
), network (n
)\n"
310 " 'sp_name': the file
's name that would be passed to bios as logo picture, if menu=on\n"
311 " 'sp_time
': the period that splash picture last if menu=on, unit is ms\n",
314 @item -boot [order=@var{drives}][,once=@var{drives}][,menu=on|off][,splash=@var{sp_name}][,splash-time=@var{sp_time}]
316 Specify boot order @var{drives} as a string of drive letters. Valid
317 drive letters depend on the target achitecture. The x86 PC uses: a, b
318 (floppy 1 and 2), c (first hard disk), d (first CD-ROM), n-p (Etherboot
319 from network adapter 1-4), hard disk boot is the default. To apply a
320 particular boot order only on the first startup, specify it via
323 Interactive boot menus/prompts can be enabled via @option{menu=on} as far
324 as firmware/BIOS supports them. The default is non-interactive boot.
326 A splash picture could be passed to bios, enabling user to show it as logo,
327 when option splash=@var{sp_name} is given and menu=on, If firmware/BIOS
328 supports them. Currently Seabios for X86 system support it.
329 limitation: The splash file could be a jpeg file or a BMP file in 24 BPP
330 format(true color). The resolution should be supported by the SVGA mode, so
331 the recommended is 320x240, 640x480, 800x640.
334 # try to boot from network first, then from hard disk
336 # boot from CD-ROM first, switch back to default order after reboot
338 # boot with a splash picture for 5 seconds.
339 qemu -boot menu=on,splash=/root/boot.bmp,splash-time=5000
342 Note: The legacy format '-boot @
var{drives
}' is still supported but its
343 use is discouraged as it may be removed from future versions.
346 DEF("snapshot", 0, QEMU_OPTION_snapshot,
347 "-snapshot write to temporary files instead of disk image files\n",
352 Write to temporary files instead of disk image files. In this case,
353 the raw disk image you use is not written back. You can however force
354 the write back by pressing @key{C-a s} (@pxref{disk_images}).
357 DEF("m", HAS_ARG, QEMU_OPTION_m,
358 "-m megs set virtual RAM size to megs MB [default="
359 stringify(DEFAULT_RAM_SIZE) "]\n", QEMU_ARCH_ALL)
363 Set virtual RAM size to @var{megs} megabytes. Default is 128 MiB. Optionally,
364 a suffix of ``M'' or ``G'' can be used to signify a value in megabytes or
365 gigabytes respectively.
368 DEF("mem-path", HAS_ARG, QEMU_OPTION_mempath,
369 "-mem-path FILE provide backing storage for guest RAM\n", QEMU_ARCH_ALL)
371 @item -mem-path @var{path}
372 Allocate guest RAM from a temporarily created file in @var{path}.
376 DEF("mem-prealloc", 0, QEMU_OPTION_mem_prealloc,
377 "-mem-prealloc preallocate guest memory (use with -mem-path)\n",
381 Preallocate memory when using -mem-path.
385 DEF("k", HAS_ARG, QEMU_OPTION_k,
386 "-k language use keyboard layout (for example 'fr
' for French)\n",
389 @item -k @var{language}
391 Use keyboard layout @var{language} (for example @code{fr} for
392 French). This option is only needed where it is not easy to get raw PC
393 keycodes (e.g. on Macs, with some X11 servers or with a VNC
394 display). You don't normally need to use it on PC
/Linux or PC
/Windows
397 The available layouts are
:
399 ar de
-ch es fo fr
-ca hu ja mk no pt
-br sv
400 da en
-gb et fr fr
-ch is lt nl pl ru th
401 de en
-us fi fr
-be hr it lv nl
-be pt sl tr
404 The
default is @code
{en
-us
}.
408 DEF("audio-help", 0, QEMU_OPTION_audio_help
,
409 "-audio-help print list of audio drivers and their options\n",
414 Will show the audio subsystem help
: list of drivers
, tunable
418 DEF("soundhw", HAS_ARG
, QEMU_OPTION_soundhw
,
419 "-soundhw c1,... enable audio support\n"
420 " and only specified sound cards (comma separated list)\n"
421 " use -soundhw ? to get the list of supported cards\n"
422 " use -soundhw all to enable all of them\n", QEMU_ARCH_ALL
)
424 @item
-soundhw @
var{card1
}[,@
var{card2
},...] or
-soundhw all
426 Enable audio and selected sound hardware
. Use ? to print all
427 available sound hardware
.
430 qemu
-soundhw sb16
,adlib disk
.img
431 qemu
-soundhw es1370 disk
.img
432 qemu
-soundhw ac97 disk
.img
433 qemu
-soundhw hda disk
.img
434 qemu
-soundhw all disk
.img
438 Note that Linux
's i810_audio OSS kernel (for AC97) module might
439 require manually specifying clocking.
442 modprobe i810_audio clocking=48000
450 DEF("usb", 0, QEMU_OPTION_usb,
451 "-usb enable the USB driver (will be the default soon)\n",
459 Enable the USB driver (will be the default soon)
462 DEF("usbdevice", HAS_ARG, QEMU_OPTION_usbdevice,
463 "-usbdevice name add the host or guest USB device 'name
'\n",
467 @item -usbdevice @var{devname}
469 Add the USB device @var{devname}. @xref{usb_devices}.
474 Virtual Mouse. This will override the PS/2 mouse emulation when activated.
477 Pointer device that uses absolute coordinates (like a touchscreen). This
478 means qemu is able to report the mouse position without having to grab the
479 mouse. Also overrides the PS/2 mouse emulation when activated.
481 @item disk:[format=@var{format}]:@var{file}
482 Mass storage device based on file. The optional @var{format} argument
483 will be used rather than detecting the format. Can be used to specifiy
484 @code{format=raw} to avoid interpreting an untrusted format header.
486 @item host:@var{bus}.@var{addr}
487 Pass through the host device identified by @var{bus}.@var{addr} (Linux only).
489 @item host:@var{vendor_id}:@var{product_id}
490 Pass through the host device identified by @var{vendor_id}:@var{product_id}
493 @item serial:[vendorid=@var{vendor_id}][,productid=@var{product_id}]:@var{dev}
494 Serial converter to host character device @var{dev}, see @code{-serial} for the
498 Braille device. This will use BrlAPI to display the braille output on a real
501 @item net:@var{options}
502 Network adapter that supports CDC ethernet and RNDIS protocols.
507 DEF("device", HAS_ARG, QEMU_OPTION_device,
508 "-device driver[,prop[=value][,...]]\n"
509 " add device (based on driver)\n"
510 " prop=value,... sets driver properties\n"
511 " use -device ? to print all possible drivers\n"
512 " use -device driver,? to print all possible properties\n",
515 @item -device @var{driver}[,@var{prop}[=@var{value}][,...]]
517 Add device @var{driver}. @var{prop}=@var{value} sets driver
518 properties. Valid properties depend on the driver. To get help on
519 possible drivers and properties, use @code{-device ?} and
520 @code{-device @var{driver},?}.
523 DEFHEADING(File system options:)
525 DEF("fsdev", HAS_ARG, QEMU_OPTION_fsdev,
526 "-fsdev local,id=id,path=path,security_model=[mapped|passthrough|none]\n",
531 The general form of a File system device option is:
534 @item -fsdev @var{fstype} ,id=@var{id} [,@var{options}]
538 The specific Fstype will determine the applicable options.
540 Options to each backend are described below.
542 @item -fsdev local ,id=@var{id} ,path=@var{path} ,security_model=@var{security_model}
544 Create a file-system-"device" 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.
556 DEFHEADING(Virtual File system pass-through options:)
558 DEF("virtfs", HAS_ARG, QEMU_OPTION_virtfs,
559 "-virtfs local,path=path,mount_tag=tag,security_model=[mapped|passthrough|none]\n",
564 The general form of a Virtual File system pass-through option is:
567 @item -virtfs @var{fstype} [,@var{options}]
571 The specific Fstype will determine the applicable options.
573 Options to each backend are described below.
575 @item -virtfs local ,path=@var{path} ,mount_tag=@var{mount_tag} ,security_model=@var{security_model}
577 Create a Virtual file-system-pass through for local-filesystem.
579 @option{local} is only available on Linux.
581 @option{path} specifies the path to be exported. @option{path} is required.
583 @option{security_model} specifies the security model to be followed.
584 @option{security_model} is required.
587 @option{mount_tag} specifies the tag with which the exported file is mounted.
588 @option{mount_tag} is required.
595 DEF("name", HAS_ARG, QEMU_OPTION_name,
596 "-name string1[,process=string2]\n"
597 " set the name of the guest\n"
598 " string1 sets the window title and string2 the process name (on Linux)\n",
601 @item -name @var{name}
603 Sets the @var{name} of the guest.
604 This name will be displayed in the SDL window caption.
605 The @var{name} will also be used for the VNC server.
606 Also optionally set the top visible process name in Linux.
609 DEF("uuid", HAS_ARG, QEMU_OPTION_uuid,
610 "-uuid %08x-%04x-%04x-%04x-%012x\n"
611 " specify machine UUID\n", QEMU_ARCH_ALL)
613 @item -uuid @var{uuid}
624 DEFHEADING(Display options:)
630 DEF("display", HAS_ARG, QEMU_OPTION_display,
631 "-display sdl[,frame=on|off][,alt_grab=on|off][,ctrl_grab=on|off]\n"
632 " [,window_close=on|off]|curses|none|\n"
633 " vnc=<display>[,<optargs>]\n"
634 " select display type\n", QEMU_ARCH_ALL)
636 @item -display @var{type}
638 Select type of display to use. This option is a replacement for the
639 old style -sdl/-curses/... options. Valid values for @var{type} are
642 Display video output via SDL (usually in a separate graphics
643 window; see the SDL documentation for other possibilities).
645 Display video output via curses. For graphics device models which
646 support a text mode, QEMU can display this output using a
647 curses/ncurses interface. Nothing is displayed when the graphics
648 device is in graphical mode or if the graphics device does not support
649 a text mode. Generally only the VGA device models support text mode.
651 Do not display video output. The guest will still see an emulated
652 graphics card, but its output will not be displayed to the QEMU
653 user. This option differs from the -nographic option in that it
654 only affects what is done with video output; -nographic also changes
655 the destination of the serial and parallel port data.
657 Start a VNC server on display <arg>
661 DEF("nographic", 0, QEMU_OPTION_nographic,
662 "-nographic disable graphical output and redirect serial I/Os to console\n",
667 Normally, QEMU uses SDL to display the VGA output. With this option,
668 you can totally disable graphical output so that QEMU is a simple
669 command line application. The emulated serial port is redirected on
670 the console. Therefore, you can still use QEMU to debug a Linux kernel
671 with a serial console.
674 DEF("curses", 0, QEMU_OPTION_curses,
675 "-curses use a curses/ncurses interface instead of SDL\n",
680 Normally, QEMU uses SDL to display the VGA output. With this option,
681 QEMU can display the VGA output when in text mode using a
682 curses/ncurses interface. Nothing is displayed in graphical mode.
685 DEF("no-frame", 0, QEMU_OPTION_no_frame,
686 "-no-frame open SDL window without a frame and window decorations\n",
691 Do not use decorations for SDL windows and start them using the whole
692 available screen space. This makes the using QEMU in a dedicated desktop
693 workspace more convenient.
696 DEF("alt-grab", 0, QEMU_OPTION_alt_grab,
697 "-alt-grab use Ctrl-Alt-Shift to grab mouse (instead of Ctrl-Alt)\n",
702 Use Ctrl-Alt-Shift to grab mouse (instead of Ctrl-Alt). Note that this also
703 affects the special keys (for fullscreen, monitor-mode switching, etc).
706 DEF("ctrl-grab", 0, QEMU_OPTION_ctrl_grab,
707 "-ctrl-grab use Right-Ctrl to grab mouse (instead of Ctrl-Alt)\n",
712 Use Right-Ctrl to grab mouse (instead of Ctrl-Alt). Note that this also
713 affects the special keys (for fullscreen, monitor-mode switching, etc).
716 DEF("no-quit", 0, QEMU_OPTION_no_quit,
717 "-no-quit disable SDL window close capability\n", QEMU_ARCH_ALL)
721 Disable SDL window close capability.
724 DEF("sdl", 0, QEMU_OPTION_sdl,
725 "-sdl enable SDL\n", QEMU_ARCH_ALL)
732 DEF("spice", HAS_ARG, QEMU_OPTION_spice,
733 "-spice <args> enable spice\n", QEMU_ARCH_ALL)
735 @item -spice @var{option}[,@var{option}[,...]]
737 Enable the spice remote desktop protocol. Valid options are
742 Set the TCP port spice is listening on for plaintext channels.
745 Set the IP address spice is listening on. Default is any address.
749 Force using the specified IP version.
751 @item password=<secret>
752 Set the password you need to authenticate.
755 Require that the client use SASL to authenticate with the spice.
756 The exact choice of authentication method used is controlled from the
757 system / user's SASL configuration file
for the
'qemu' service
. This
758 is typically found
in /etc
/sasl2
/qemu
.conf
. If running QEMU as an
759 unprivileged user
, an environment variable SASL_CONF_PATH can be used
760 to make it search alternate locations
for the service config
.
761 While some SASL auth methods can also provide data
encryption (eg GSSAPI
),
762 it is recommended that SASL always be combined with the
'tls' and
763 'x509' settings to enable use of SSL and server certificates
. This
764 ensures a data encryption preventing compromise of authentication
767 @item disable
-ticketing
768 Allow client connects without authentication
.
770 @item disable
-copy
-paste
771 Disable copy paste between the client and the guest
.
774 Set the TCP port spice is listening on
for encrypted channels
.
777 Set the x509 file directory
. Expects same filenames as
-vnc $display
,x509
=$dir
779 @item x509
-key
-file
=<file
>
780 @item x509
-key
-password
=<file
>
781 @item x509
-cert
-file
=<file
>
782 @item x509
-cacert
-file
=<file
>
783 @item x509
-dh
-key
-file
=<file
>
784 The x509 file names can also be configured individually
.
786 @item tls
-ciphers
=<list
>
787 Specify which ciphers to use
.
789 @item tls
-channel
=[main|display|inputs|record|playback|tunnel
]
790 @item plaintext
-channel
=[main|display|inputs|record|playback|tunnel
]
791 Force specific channel to be used with or without TLS encryption
. The
792 options can be specified multiple times to configure multiple
793 channels
. The special name
"default" can be used to set the
default
794 mode
. For channels which are not explicitly forced into one mode the
795 spice client is allowed to pick tls
/plaintext as he pleases
.
797 @item image
-compression
=[auto_glz|auto_lz|quic|glz|lz|off
]
798 Configure image
compression (lossless
).
801 @item jpeg
-wan
-compression
=[auto|
never|always
]
802 @item zlib
-glz
-wan
-compression
=[auto|
never|always
]
803 Configure wan image
compression (lossy
for slow links
).
806 @item streaming
-video
=[off|all|filter
]
807 Configure video stream detection
. Default is filter
.
809 @item agent
-mouse
=[on|off
]
810 Enable
/disable passing mouse events via vdagent
. Default is on
.
812 @item playback
-compression
=[on|off
]
813 Enable
/disable audio stream
compression (using celt
0.5.1). Default is on
.
818 DEF("portrait", 0, QEMU_OPTION_portrait
,
819 "-portrait rotate graphical output 90 deg left (only PXA LCD)\n",
824 Rotate graphical output
90 deg
left (only PXA LCD
).
827 DEF("rotate", HAS_ARG
, QEMU_OPTION_rotate
,
828 "-rotate <deg> rotate graphical output some deg left (only PXA LCD)\n",
833 Rotate graphical output some deg
left (only PXA LCD
).
836 DEF("vga", HAS_ARG
, QEMU_OPTION_vga
,
837 "-vga [std|cirrus|vmware|qxl|xenfb|none]\n"
838 " select video card type\n", QEMU_ARCH_ALL
)
840 @item
-vga @
var{type
}
842 Select type of VGA card to emulate
. Valid values
for @
var{type
} are
845 Cirrus Logic GD5446 Video card
. All Windows versions starting from
846 Windows
95 should recognize and use
this graphic card
. For optimal
847 performances
, use
16 bit color depth
in the guest and the host OS
.
848 (This one is the
default)
850 Standard VGA card with Bochs VBE extensions
. If your guest OS
851 supports the VESA
2.0 VBE
extensions (e
.g
. Windows XP
) and
if you want
852 to use high resolution
modes (>= 1280x1024x16
) then you should use
855 VMWare SVGA
-II compatible adapter
. Use it
if you have sufficiently
856 recent XFree86
/XOrg server or Windows guest with a driver
for this
859 QXL paravirtual graphic card
. It is VGA
compatible (including VESA
860 2.0 VBE support
). Works best with qxl guest drivers installed though
.
861 Recommended choice when
using the spice protocol
.
867 DEF("full-screen", 0, QEMU_OPTION_full_screen
,
868 "-full-screen start in full screen\n", QEMU_ARCH_ALL
)
872 Start
in full screen
.
875 DEF("g", 1, QEMU_OPTION_g
,
876 "-g WxH[xDEPTH] Set the initial graphical resolution and depth\n",
877 QEMU_ARCH_PPC | QEMU_ARCH_SPARC
)
879 @item
-g @
var{width
}x@
var{height
}[x@
var{depth
}]
881 Set the initial graphical resolution and
depth (PPC
, SPARC only
).
884 DEF("vnc", HAS_ARG
, QEMU_OPTION_vnc
,
885 "-vnc display start a VNC server on display\n", QEMU_ARCH_ALL
)
887 @item
-vnc @
var{display
}[,@
var{option
}[,@
var{option
}[,...]]]
889 Normally
, QEMU uses SDL to display the VGA output
. With
this option
,
890 you can have QEMU listen on VNC display @
var{display
} and redirect the VGA
891 display over the VNC session
. It is very useful to enable the usb
892 tablet device when
using this option (option @option
{-usbdevice
893 tablet
}). When
using the VNC display
, you must use the @option
{-k
}
894 parameter to set the keyboard layout
if you are not
using en
-us
. Valid
895 syntax
for the @
var{display
} is
899 @item @
var{host
}:@
var{d
}
901 TCP connections will only be allowed from @
var{host
} on display @
var{d
}.
902 By convention the TCP port is
5900+@
var{d
}. Optionally
, @
var{host
} can
903 be omitted
in which
case the server will accept connections from any host
.
905 @item unix
:@
var{path
}
907 Connections will be allowed over UNIX domain sockets where @
var{path
} is the
908 location of a unix socket to listen
for connections on
.
912 VNC is initialized but not started
. The monitor @code
{change
} command
913 can be used to later start the VNC server
.
917 Following the @
var{display
} value there may be one or more @
var{option
} flags
918 separated by commas
. Valid options are
924 Connect to a listening VNC client via a ``reverse
'' connection
. The
925 client is specified by the @
var{display
}. For reverse network
926 connections (@
var{host
}:@
var{d
},@code
{reverse
}), the @
var{d
} argument
927 is a TCP port number
, not a display number
.
931 Require that password based authentication is used
for client connections
.
932 The password must be set separately
using the @code
{change
} command
in the
937 Require that client use TLS when communicating with the VNC server
. This
938 uses anonymous TLS credentials so is susceptible to a man
-in-the
-middle
939 attack
. It is recommended that
this option be combined with either the
940 @option
{x509
} or @option
{x509verify
} options
.
942 @item x509
=@
var{/path
/to
/certificate
/dir
}
944 Valid
if @option
{tls
} is specified
. Require that x509 credentials are used
945 for negotiating the TLS session
. The server will send its x509 certificate
946 to the client
. It is recommended that a password be set on the VNC server
947 to provide authentication of the client when
this is used
. The path following
948 this option specifies where the x509 certificates are to be loaded from
.
949 See the @ref
{vnc_security
} section
for details on generating certificates
.
951 @item x509verify
=@
var{/path
/to
/certificate
/dir
}
953 Valid
if @option
{tls
} is specified
. Require that x509 credentials are used
954 for negotiating the TLS session
. The server will send its x509 certificate
955 to the client
, and request that the client send its own x509 certificate
.
956 The server will validate the client
's certificate against the CA certificate,
957 and reject clients when validation fails. If the certificate authority is
958 trusted, this is a sufficient authentication mechanism. You may still wish
959 to set a password on the VNC server as a second authentication layer. The
960 path following this option specifies where the x509 certificates are to
961 be loaded from. See the @ref{vnc_security} section for details on generating
966 Require that the client use SASL to authenticate with the VNC server.
967 The exact choice of authentication method used is controlled from the
968 system / user's SASL configuration file
for the
'qemu' service
. This
969 is typically found
in /etc
/sasl2
/qemu
.conf
. If running QEMU as an
970 unprivileged user
, an environment variable SASL_CONF_PATH can be used
971 to make it search alternate locations
for the service config
.
972 While some SASL auth methods can also provide data
encryption (eg GSSAPI
),
973 it is recommended that SASL always be combined with the
'tls' and
974 'x509' settings to enable use of SSL and server certificates
. This
975 ensures a data encryption preventing compromise of authentication
976 credentials
. See the @ref
{vnc_security
} section
for details on
using
981 Turn on access control lists
for checking of the x509 client certificate
982 and SASL party
. For x509 certs
, the ACL check is made against the
983 certificate
's distinguished name. This is something that looks like
984 @code{C=GB,O=ACME,L=Boston,CN=bob}. For SASL party, the ACL check is
985 made against the username, which depending on the SASL plugin, may
986 include a realm component, eg @code{bob} or @code{bob@@EXAMPLE.COM}.
987 When the @option{acl} flag is set, the initial access list will be
988 empty, with a @code{deny} policy. Thus no one will be allowed to
989 use the VNC server until the ACLs have been loaded. This can be
990 achieved using the @code{acl} monitor command.
994 Enable lossy compression methods (gradient, JPEG, ...). If this
995 option is set, VNC client may receive lossy framebuffer updates
996 depending on its encoding settings. Enabling this option can save
997 a lot of bandwidth at the expense of quality.
1001 Disable adaptive encodings. Adaptive encodings are enabled by default.
1002 An adaptive encoding will try to detect frequently updated screen regions,
1003 and send updates in these regions using a lossy encoding (like JPEG).
1004 This can be really helpful to save bandwidth when playing videos. Disabling
1005 adaptive encodings allows to restore the original static behavior of encodings
1017 DEFHEADING(i386 target only:)
1022 DEF("win2k-hack", 0, QEMU_OPTION_win2k_hack,
1023 "-win2k-hack use it when installing Windows 2000 to avoid a disk full bug\n",
1028 Use it when installing Windows 2000 to avoid a disk full bug. After
1029 Windows 2000 is installed, you no longer need this option (this option
1030 slows down the IDE transfers).
1033 HXCOMM Deprecated by -rtc
1034 DEF("rtc-td-hack", 0, QEMU_OPTION_rtc_td_hack, "", QEMU_ARCH_I386)
1036 DEF("no-fd-bootchk", 0, QEMU_OPTION_no_fd_bootchk,
1037 "-no-fd-bootchk disable boot signature checking for floppy disks\n",
1040 @item -no-fd-bootchk
1041 @findex -no-fd-bootchk
1042 Disable boot signature checking for floppy disks in Bochs BIOS. It may
1043 be needed to boot from old floppy disks.
1044 TODO: check reference to Bochs BIOS.
1047 DEF("no-acpi", 0, QEMU_OPTION_no_acpi,
1048 "-no-acpi disable ACPI\n", QEMU_ARCH_I386)
1052 Disable ACPI (Advanced Configuration and Power Interface) support. Use
1053 it if your guest OS complains about ACPI problems (PC target machine
1057 DEF("no-hpet", 0, QEMU_OPTION_no_hpet,
1058 "-no-hpet disable HPET\n", QEMU_ARCH_I386)
1062 Disable HPET support.
1065 DEF("balloon", HAS_ARG, QEMU_OPTION_balloon,
1066 "-balloon none disable balloon device\n"
1067 "-balloon virtio[,addr=str]\n"
1068 " enable virtio balloon device (default)\n", QEMU_ARCH_ALL)
1072 Disable balloon device.
1073 @item -balloon virtio[,addr=@var{addr}]
1074 Enable virtio balloon device (default), optionally with PCI address
1078 DEF("acpitable", HAS_ARG, QEMU_OPTION_acpitable,
1079 "-acpitable [sig=str][,rev=n][,oem_id=str][,oem_table_id=str][,oem_rev=n][,asl_compiler_id=str][,asl_compiler_rev=n][,{data|file}=file1[:file2]...]\n"
1080 " ACPI table description\n", QEMU_ARCH_I386)
1082 @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}]...]
1084 Add ACPI table with specified header fields and context from specified files.
1085 For file=, take whole ACPI table from the specified files, including all
1086 ACPI headers (possible overridden by other options).
1087 For data=, only data
1088 portion of the table is used, all header information is specified in the
1092 DEF("smbios", HAS_ARG, QEMU_OPTION_smbios,
1093 "-smbios file=binary\n"
1094 " load SMBIOS entry from binary file\n"
1095 "-smbios type=0[,vendor=str][,version=str][,date=str][,release=%d.%d]\n"
1096 " specify SMBIOS type 0 fields\n"
1097 "-smbios type=1[,manufacturer=str][,product=str][,version=str][,serial=str]\n"
1098 " [,uuid=uuid][,sku=str][,family=str]\n"
1099 " specify SMBIOS type 1 fields\n", QEMU_ARCH_I386)
1101 @item -smbios file=@var{binary}
1103 Load SMBIOS entry from binary file.
1105 @item -smbios type=0[,vendor=@var{str}][,version=@var{str}][,date=@var{str}][,release=@var{%d.%d}]
1107 Specify SMBIOS type 0 fields
1109 @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}]
1110 Specify SMBIOS type 1 fields
1118 DEFHEADING(Network options:)
1123 HXCOMM Legacy slirp options (now moved to -net user):
1125 DEF("tftp", HAS_ARG, QEMU_OPTION_tftp, "", QEMU_ARCH_ALL)
1126 DEF("bootp", HAS_ARG, QEMU_OPTION_bootp, "", QEMU_ARCH_ALL)
1127 DEF("redir", HAS_ARG, QEMU_OPTION_redir, "", QEMU_ARCH_ALL)
1129 DEF("smb", HAS_ARG, QEMU_OPTION_smb, "", QEMU_ARCH_ALL)
1133 DEF("net", HAS_ARG, QEMU_OPTION_net,
1134 "-net nic[,vlan=n][,macaddr=mac][,model=type][,name=str][,addr=str][,vectors=v]\n"
1135 " create a new Network Interface Card and connect it to VLAN 'n
'\n"
1137 "-net user[,vlan=n][,name=str][,net=addr[/mask]][,host=addr][,restrict=on|off]\n"
1138 " [,hostname=host][,dhcpstart=addr][,dns=addr][,tftp=dir][,bootfile=f]\n"
1139 " [,hostfwd=rule][,guestfwd=rule]"
1141 "[,smb=dir[,smbserver=addr]]\n"
1143 " connect the user mode network stack to VLAN 'n
', configure its\n"
1144 " DHCP server and enabled optional services\n"
1147 "-net tap[,vlan=n][,name=str],ifname=name\n"
1148 " connect the host TAP network interface to VLAN 'n
'\n"
1150 "-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"
1151 " connect the host TAP network interface to VLAN 'n
' and use the\n"
1152 " network scripts 'file
' (default=" DEFAULT_NETWORK_SCRIPT ")\n"
1153 " and 'dfile
' (default=" DEFAULT_NETWORK_DOWN_SCRIPT ")\n"
1154 " use '[down
]script
=no
' to disable script execution\n"
1155 " use 'fd
=h
' to connect to an already opened TAP interface\n"
1156 " use 'sndbuf
=nbytes
' to limit the size of the send buffer (the\n"
1157 " default is disabled 'sndbuf
=0' to enable flow control set 'sndbuf
=1048576')\n"
1158 " use vnet_hdr=off to avoid enabling the IFF_VNET_HDR tap flag\n"
1159 " use vnet_hdr=on to make the lack of IFF_VNET_HDR support an error condition\n"
1160 " use vhost=on to enable experimental in kernel accelerator\n"
1161 " (only has effect for virtio guests which use MSIX)\n"
1162 " use vhostforce=on to force vhost on for non-MSIX virtio guests\n"
1163 " use 'vhostfd
=h
' to connect to an already opened vhost net device\n"
1165 "-net socket[,vlan=n][,name=str][,fd=h][,listen=[host]:port][,connect=host:port]\n"
1166 " connect the vlan 'n
' to another VLAN using a socket connection\n"
1167 "-net socket[,vlan=n][,name=str][,fd=h][,mcast=maddr:port[,localaddr=addr]]\n"
1168 " connect the vlan 'n
' to multicast maddr and port\n"
1169 " use 'localaddr
=addr
' to specify the host address to send packets from\n"
1171 "-net vde[,vlan=n][,name=str][,sock=socketpath][,port=n][,group=groupname][,mode=octalmode]\n"
1172 " connect the vlan 'n
' to port 'n
' of a vde switch running\n"
1173 " on host and listening for incoming connections on 'socketpath
'.\n"
1174 " Use group 'groupname
' and mode 'octalmode
' to change default\n"
1175 " ownership and permissions for communication port.\n"
1177 "-net dump[,vlan=n][,file=f][,len=n]\n"
1178 " dump traffic on vlan 'n
' to file 'f
' (max n bytes per packet)\n"
1179 "-net none use it alone to have zero network devices. If no -net option\n"
1180 " is provided, the default is '-net nic
-net user
'\n", QEMU_ARCH_ALL)
1181 DEF("netdev", HAS_ARG, QEMU_OPTION_netdev,
1190 "socket],id=str[,option][,option][,...]\n", QEMU_ARCH_ALL)
1192 @item -net nic[,vlan=@var{n}][,macaddr=@var{mac}][,model=@var{type}] [,name=@var{name}][,addr=@var{addr}][,vectors=@var{v}]
1194 Create a new Network Interface Card and connect it to VLAN @var{n} (@var{n}
1195 = 0 is the default). The NIC is an e1000 by default on the PC
1196 target. Optionally, the MAC address can be changed to @var{mac}, the
1197 device address set to @var{addr} (PCI cards only),
1198 and a @var{name} can be assigned for use in monitor commands.
1199 Optionally, for PCI cards, you can specify the number @var{v} of MSI-X vectors
1200 that the card should have; this option currently only affects virtio cards; set
1201 @var{v} = 0 to disable MSI-X. If no @option{-net} option is specified, a single
1202 NIC is created. Qemu can emulate several different models of network card.
1203 Valid values for @var{type} are
1204 @code{virtio}, @code{i82551}, @code{i82557b}, @code{i82559er},
1205 @code{ne2k_pci}, @code{ne2k_isa}, @code{pcnet}, @code{rtl8139},
1206 @code{e1000}, @code{smc91c111}, @code{lance} and @code{mcf_fec}.
1207 Not all devices are supported on all targets. Use -net nic,model=?
1208 for a list of available devices for your target.
1210 @item -net user[,@var{option}][,@var{option}][,...]
1211 Use the user mode network stack which requires no administrator
1212 privilege to run. Valid options are:
1216 Connect user mode stack to VLAN @var{n} (@var{n} = 0 is the default).
1218 @item name=@var{name}
1219 Assign symbolic name for use in monitor commands.
1221 @item net=@var{addr}[/@var{mask}]
1222 Set IP network address the guest will see. Optionally specify the netmask,
1223 either in the form a.b.c.d or as number of valid top-most bits. Default is
1226 @item host=@var{addr}
1227 Specify the guest-visible address of the host. Default is the 2nd IP in the
1228 guest network, i.e. x.x.x.2.
1230 @item restrict=on|off
1231 If this option is enabled, the guest will be isolated, i.e. it will not be
1232 able to contact the host and no guest IP packets will be routed over the host
1233 to the outside. This option does not affect any explicitly set forwarding rules.
1235 @item hostname=@var{name}
1236 Specifies the client hostname reported by the builtin DHCP server.
1238 @item dhcpstart=@var{addr}
1239 Specify the first of the 16 IPs the built-in DHCP server can assign. Default
1240 is the 15th to 31st IP in the guest network, i.e. x.x.x.15 to x.x.x.31.
1242 @item dns=@var{addr}
1243 Specify the guest-visible address of the virtual nameserver. The address must
1244 be different from the host address. Default is the 3rd IP in the guest network,
1247 @item tftp=@var{dir}
1248 When using the user mode network stack, activate a built-in TFTP
1249 server. The files in @var{dir} will be exposed as the root of a TFTP server.
1250 The TFTP client on the guest must be configured in binary mode (use the command
1251 @code{bin} of the Unix TFTP client).
1253 @item bootfile=@var{file}
1254 When using the user mode network stack, broadcast @var{file} as the BOOTP
1255 filename. In conjunction with @option{tftp}, this can be used to network boot
1256 a guest from a local directory.
1258 Example (using pxelinux):
1260 qemu -hda linux.img -boot n -net user,tftp=/path/to/tftp/files,bootfile=/pxelinux.0
1263 @item smb=@var{dir}[,smbserver=@var{addr}]
1264 When using the user mode network stack, activate a built-in SMB
1265 server so that Windows OSes can access to the host files in @file{@var{dir}}
1266 transparently. The IP address of the SMB server can be set to @var{addr}. By
1267 default the 4th IP in the guest network is used, i.e. x.x.x.4.
1269 In the guest Windows OS, the line:
1273 must be added in the file @file{C:\WINDOWS\LMHOSTS} (for windows 9x/Me)
1274 or @file{C:\WINNT\SYSTEM32\DRIVERS\ETC\LMHOSTS} (Windows NT/2000).
1276 Then @file{@var{dir}} can be accessed in @file{\\smbserver\qemu}.
1278 Note that a SAMBA server must be installed on the host OS in
1279 @file{/usr/sbin/smbd}. QEMU was tested successfully with smbd versions from
1280 Red Hat 9, Fedora Core 3 and OpenSUSE 11.x.
1282 @item hostfwd=[tcp|udp]:[@var{hostaddr}]:@var{hostport}-[@var{guestaddr}]:@var{guestport}
1283 Redirect incoming TCP or UDP connections to the host port @var{hostport} to
1284 the guest IP address @var{guestaddr} on guest port @var{guestport}. If
1285 @var{guestaddr} is not specified, its value is x.x.x.15 (default first address
1286 given by the built-in DHCP server). By specifying @var{hostaddr}, the rule can
1287 be bound to a specific host interface. If no connection type is set, TCP is
1288 used. This option can be given multiple times.
1290 For example, to redirect host X11 connection from screen 1 to guest
1291 screen 0, use the following:
1295 qemu -net user,hostfwd=tcp:127.0.0.1:6001-:6000 [...]
1296 # this host xterm should open in the guest X11 server
1300 To redirect telnet connections from host port 5555 to telnet port on
1301 the guest, use the following:
1305 qemu -net user,hostfwd=tcp::5555-:23 [...]
1306 telnet localhost 5555
1309 Then when you use on the host @code{telnet localhost 5555}, you
1310 connect to the guest telnet server.
1312 @item guestfwd=[tcp]:@var{server}:@var{port}-@var{dev}
1313 Forward guest TCP connections to the IP address @var{server} on port @var{port}
1314 to the character device @var{dev}. This option can be given multiple times.
1318 Note: Legacy stand-alone options -tftp, -bootp, -smb and -redir are still
1319 processed and applied to -net user. Mixing them with the new configuration
1320 syntax gives undefined results. Their use for new applications is discouraged
1321 as they will be removed from future versions.
1323 @item -net tap[,vlan=@var{n}][,name=@var{name}][,fd=@var{h}][,ifname=@var{name}] [,script=@var{file}][,downscript=@var{dfile}]
1324 Connect the host TAP network interface @var{name} to VLAN @var{n}, use
1325 the network script @var{file} to configure it and the network script
1326 @var{dfile} to deconfigure it. If @var{name} is not provided, the OS
1327 automatically provides one. @option{fd}=@var{h} can be used to specify
1328 the handle of an already opened host TAP interface. The default network
1329 configure script is @file{/etc/qemu-ifup} and the default network
1330 deconfigure script is @file{/etc/qemu-ifdown}. Use @option{script=no}
1331 or @option{downscript=no} to disable script execution. Example:
1334 qemu linux.img -net nic -net tap
1337 More complicated example (two NICs, each one connected to a TAP device)
1339 qemu linux.img -net nic,vlan=0 -net tap,vlan=0,ifname=tap0 \
1340 -net nic,vlan=1 -net tap,vlan=1,ifname=tap1
1343 @item -net socket[,vlan=@var{n}][,name=@var{name}][,fd=@var{h}] [,listen=[@var{host}]:@var{port}][,connect=@var{host}:@var{port}]
1345 Connect the VLAN @var{n} to a remote VLAN in another QEMU virtual
1346 machine using a TCP socket connection. If @option{listen} is
1347 specified, QEMU waits for incoming connections on @var{port}
1348 (@var{host} is optional). @option{connect} is used to connect to
1349 another QEMU instance using the @option{listen} option. @option{fd}=@var{h}
1350 specifies an already opened TCP socket.
1354 # launch a first QEMU instance
1355 qemu linux.img -net nic,macaddr=52:54:00:12:34:56 \
1356 -net socket,listen=:1234
1357 # connect the VLAN 0 of this instance to the VLAN 0
1358 # of the first instance
1359 qemu linux.img -net nic,macaddr=52:54:00:12:34:57 \
1360 -net socket,connect=127.0.0.1:1234
1363 @item -net socket[,vlan=@var{n}][,name=@var{name}][,fd=@var{h}][,mcast=@var{maddr}:@var{port}[,localaddr=@var{addr}]]
1365 Create a VLAN @var{n} shared with another QEMU virtual
1366 machines using a UDP multicast socket, effectively making a bus for
1367 every QEMU with same multicast address @var{maddr} and @var{port}.
1371 Several QEMU can be running on different hosts and share same bus (assuming
1372 correct multicast setup for these hosts).
1374 mcast support is compatible with User Mode Linux (argument @option{eth@var{N}=mcast}), see
1375 @url{http://user-mode-linux.sf.net}.
1377 Use @option{fd=h} to specify an already opened UDP multicast socket.
1382 # launch one QEMU instance
1383 qemu linux.img -net nic,macaddr=52:54:00:12:34:56 \
1384 -net socket,mcast=230.0.0.1:1234
1385 # launch another QEMU instance on same "bus"
1386 qemu linux.img -net nic,macaddr=52:54:00:12:34:57 \
1387 -net socket,mcast=230.0.0.1:1234
1388 # launch yet another QEMU instance on same "bus"
1389 qemu linux.img -net nic,macaddr=52:54:00:12:34:58 \
1390 -net socket,mcast=230.0.0.1:1234
1393 Example (User Mode Linux compat.):
1395 # launch QEMU instance (note mcast address selected
1397 qemu linux
.img
-net nic
,macaddr
=52:54:00:12:34:56 \
1398 -net socket
,mcast
=239.192.168.1:1102
1400 /path
/to
/linux ubd0
=/path
/to
/root_fs eth0
=mcast
1403 Example (send packets from host
's 1.2.3.4):
1405 qemu linux.img -net nic,macaddr=52:54:00:12:34:56 \
1406 -net socket,mcast=239.192.168.1:1102,localaddr=1.2.3.4
1409 @item -net vde[,vlan=@var{n}][,name=@var{name}][,sock=@var{socketpath}] [,port=@var{n}][,group=@var{groupname}][,mode=@var{octalmode}]
1410 Connect VLAN @var{n} to PORT @var{n} of a vde switch running on host and
1411 listening for incoming connections on @var{socketpath}. Use GROUP @var{groupname}
1412 and MODE @var{octalmode} to change default ownership and permissions for
1413 communication port. This option is available only if QEMU has been compiled
1414 with vde support enabled.
1419 vde_switch -F -sock /tmp/myswitch
1420 # launch QEMU instance
1421 qemu linux.img -net nic -net vde,sock=/tmp/myswitch
1424 @item -net dump[,vlan=@var{n}][,file=@var{file}][,len=@var{len}]
1425 Dump network traffic on VLAN @var{n} to file @var{file} (@file{qemu-vlan0.pcap} by default).
1426 At most @var{len} bytes (64k by default) per packet are stored. The file format is
1427 libpcap, so it can be analyzed with tools such as tcpdump or Wireshark.
1430 Indicate that no network devices should be configured. It is used to
1431 override the default configuration (@option{-net nic -net user}) which
1432 is activated if no @option{-net} options are provided.
1439 DEFHEADING(Character device options:)
1441 DEF("chardev", HAS_ARG, QEMU_OPTION_chardev,
1442 "-chardev null,id=id[,mux=on|off]\n"
1443 "-chardev socket,id=id[,host=host],port=host[,to=to][,ipv4][,ipv6][,nodelay]\n"
1444 " [,server][,nowait][,telnet][,mux=on|off] (tcp)\n"
1445 "-chardev socket,id=id,path=path[,server][,nowait][,telnet],[mux=on|off] (unix)\n"
1446 "-chardev udp,id=id[,host=host],port=port[,localaddr=localaddr]\n"
1447 " [,localport=localport][,ipv4][,ipv6][,mux=on|off]\n"
1448 "-chardev msmouse,id=id[,mux=on|off]\n"
1449 "-chardev vc,id=id[[,width=width][,height=height]][[,cols=cols][,rows=rows]]\n"
1451 "-chardev file,id=id,path=path[,mux=on|off]\n"
1452 "-chardev pipe,id=id,path=path[,mux=on|off]\n"
1454 "-chardev console,id=id[,mux=on|off]\n"
1455 "-chardev serial,id=id,path=path[,mux=on|off]\n"
1457 "-chardev pty,id=id[,mux=on|off]\n"
1458 "-chardev stdio,id=id[,mux=on|off][,signal=on|off]\n"
1460 #ifdef CONFIG_BRLAPI
1461 "-chardev braille,id=id[,mux=on|off]\n"
1463 #if defined(__linux__) || defined(__sun__) || defined(__FreeBSD__) \
1464 || defined(__NetBSD__) || defined(__OpenBSD__) || defined(__DragonFly__)
1465 "-chardev tty,id=id,path=path[,mux=on|off]\n"
1467 #if defined(__linux__) || defined(__FreeBSD__) || defined(__DragonFly__)
1468 "-chardev parport,id=id,path=path[,mux=on|off]\n"
1470 #if defined(CONFIG_SPICE)
1471 "-chardev spicevmc,id=id,name=name[,debug=debug]\n"
1478 The general form of a character device option is:
1481 @item -chardev @var{backend} ,id=@var{id} [,mux=on|off] [,@var{options}]
1499 The specific backend will determine the applicable options.
1501 All devices must have an id, which can be any string up to 127 characters long.
1502 It is used to uniquely identify this device in other command line directives.
1504 A character device may be used in multiplexing mode by multiple front-ends.
1505 The key sequence of @key{Control-a} and @key{c} will rotate the input focus
1506 between attached front-ends. Specify @option{mux=on} to enable this mode.
1508 Options to each backend are described below.
1510 @item -chardev null ,id=@var{id}
1511 A void device. This device will not emit any data, and will drop any data it
1512 receives. The null backend does not take any options.
1514 @item -chardev socket ,id=@var{id} [@var{TCP options} or @var{unix options}] [,server] [,nowait] [,telnet]
1516 Create a two-way stream socket, which can be either a TCP or a unix socket. A
1517 unix socket will be created if @option{path} is specified. Behaviour is
1518 undefined if TCP options are specified for a unix socket.
1520 @option{server} specifies that the socket shall be a listening socket.
1522 @option{nowait} specifies that QEMU should not block waiting for a client to
1523 connect to a listening socket.
1525 @option{telnet} specifies that traffic on the socket should interpret telnet
1528 TCP and unix socket options are given below:
1532 @item TCP options: port=@var{port} [,host=@var{host}] [,to=@var{to}] [,ipv4] [,ipv6] [,nodelay]
1534 @option{host} for a listening socket specifies the local address to be bound.
1535 For a connecting socket species the remote host to connect to. @option{host} is
1536 optional for listening sockets. If not specified it defaults to @code{0.0.0.0}.
1538 @option{port} for a listening socket specifies the local port to be bound. For a
1539 connecting socket specifies the port on the remote host to connect to.
1540 @option{port} can be given as either a port number or a service name.
1541 @option{port} is required.
1543 @option{to} is only relevant to listening sockets. If it is specified, and
1544 @option{port} cannot be bound, QEMU will attempt to bind to subsequent ports up
1545 to and including @option{to} until it succeeds. @option{to} must be specified
1548 @option{ipv4} and @option{ipv6} specify that either IPv4 or IPv6 must be used.
1549 If neither is specified the socket may use either protocol.
1551 @option{nodelay} disables the Nagle algorithm.
1553 @item unix options: path=@var{path}
1555 @option{path} specifies the local path of the unix socket. @option{path} is
1560 @item -chardev udp ,id=@var{id} [,host=@var{host}] ,port=@var{port} [,localaddr=@var{localaddr}] [,localport=@var{localport}] [,ipv4] [,ipv6]
1562 Sends all traffic from the guest to a remote host over UDP.
1564 @option{host} specifies the remote host to connect to. If not specified it
1565 defaults to @code{localhost}.
1567 @option{port} specifies the port on the remote host to connect to. @option{port}
1570 @option{localaddr} specifies the local address to bind to. If not specified it
1571 defaults to @code{0.0.0.0}.
1573 @option{localport} specifies the local port to bind to. If not specified any
1574 available local port will be used.
1576 @option{ipv4} and @option{ipv6} specify that either IPv4 or IPv6 must be used.
1577 If neither is specified the device may use either protocol.
1579 @item -chardev msmouse ,id=@var{id}
1581 Forward QEMU's emulated msmouse events to the guest
. @option
{msmouse
} does not
1584 @item
-chardev vc
,id
=@
var{id
} [[,width
=@
var{width
}] [,height
=@
var{height
}]] [[,cols
=@
var{cols
}] [,rows
=@
var{rows
}]]
1586 Connect to a QEMU text console
. @option
{vc
} may optionally be given a specific
1589 @option
{width
} and @option
{height
} specify the width and height respectively of
1590 the console
, in pixels
.
1592 @option
{cols
} and @option
{rows
} specify that the console be sized to fit a text
1593 console with the given dimensions
.
1595 @item
-chardev file
,id
=@
var{id
} ,path
=@
var{path
}
1597 Log all traffic received from the guest to a file
.
1599 @option
{path
} specifies the path of the file to be opened
. This file will be
1600 created
if it does not already exist
, and overwritten
if it does
. @option
{path
}
1603 @item
-chardev pipe
,id
=@
var{id
} ,path
=@
var{path
}
1605 Create a two
-way connection to the guest
. The behaviour differs slightly between
1606 Windows hosts and other hosts
:
1608 On Windows
, a single duplex pipe will be created at
1609 @file
{\\.pipe\@option
{path
}}.
1611 On other hosts
, 2 pipes will be created called @file
{@option
{path
}.in} and
1612 @file
{@option
{path
}.out
}. Data written to @file
{@option
{path
}.in} will be
1613 received by the guest
. Data written by the guest can be read from
1614 @file
{@option
{path
}.out
}. QEMU will not create these fifos
, and requires them to
1617 @option
{path
} forms part of the pipe path as described above
. @option
{path
} is
1620 @item
-chardev console
,id
=@
var{id
}
1622 Send traffic from the guest to QEMU
's standard output. @option{console} does not
1625 @option{console} is only available on Windows hosts.
1627 @item -chardev serial ,id=@var{id} ,path=@option{path}
1629 Send traffic from the guest to a serial device on the host.
1632 only available on Windows hosts.
1634 @option{path} specifies the name of the serial device to open.
1636 @item -chardev pty ,id=@var{id}
1638 Create a new pseudo-terminal on the host and connect to it. @option{pty} does
1639 not take any options.
1641 @option{pty} is not available on Windows hosts.
1643 @item -chardev stdio ,id=@var{id} [,signal=on|off]
1644 Connect to standard input and standard output of the qemu process.
1646 @option{signal} controls if signals are enabled on the terminal, that includes
1647 exiting QEMU with the key sequence @key{Control-c}. This option is enabled by
1648 default, use @option{signal=off} to disable it.
1650 @option{stdio} is not available on Windows hosts.
1652 @item -chardev braille ,id=@var{id}
1654 Connect to a local BrlAPI server. @option{braille} does not take any options.
1656 @item -chardev tty ,id=@var{id} ,path=@var{path}
1658 Connect to a local tty device.
1660 @option{tty} is only available on Linux, Sun, FreeBSD, NetBSD, OpenBSD and
1663 @option{path} specifies the path to the tty. @option{path} is required.
1665 @item -chardev parport ,id=@var{id} ,path=@var{path}
1667 @option{parport} is only available on Linux, FreeBSD and DragonFlyBSD hosts.
1669 Connect to a local parallel port.
1671 @option{path} specifies the path to the parallel port device. @option{path} is
1674 #if defined(CONFIG_SPICE)
1675 @item -chardev spicevmc ,id=@var{id} ,debug=@var{debug}, name=@var{name}
1677 @option{debug} debug level for spicevmc
1679 @option{name} name of spice channel to connect to
1681 Connect to a spice virtual machine channel, such as vdiport.
1689 DEFHEADING(Bluetooth(R) options:)
1691 DEF("bt", HAS_ARG, QEMU_OPTION_bt, \
1692 "-bt hci,null dumb bluetooth HCI - doesn't respond to commands
\n" \
1693 "-bt hci
,host
[:id
]\n" \
1694 " use host
's HCI with the given name\n" \
1695 "-bt hci[,vlan=n]\n" \
1696 " emulate a standard HCI in virtual scatternet 'n
'\n" \
1697 "-bt vhci[,vlan=n]\n" \
1698 " add host computer to virtual scatternet 'n
' using VHCI\n" \
1699 "-bt device:dev[,vlan=n]\n" \
1700 " emulate a bluetooth device 'dev
' in scatternet 'n
'\n",
1707 Defines the function of the corresponding Bluetooth HCI. -bt options
1708 are matched with the HCIs present in the chosen machine type. For
1709 example when emulating a machine with only one HCI built into it, only
1710 the first @code{-bt hci[...]} option is valid and defines the HCI's
1711 logic
. The Transport Layer is decided by the machine type
. Currently
1712 the machines @code
{n800
} and @code
{n810
} have one HCI and all other
1716 The following three types are recognized
:
1720 (default) The corresponding Bluetooth HCI assumes no internal logic
1721 and will not respond to any HCI commands or emit events
.
1723 @item
-bt hci
,host
[:@
var{id
}]
1724 (@code
{bluez
} only
) The corresponding HCI passes commands
/ events
1725 to
/ from the physical HCI identified by the name @
var{id
} (default:
1726 @code
{hci0
}) on the computer running QEMU
. Only available on @code
{bluez
}
1727 capable systems like Linux
.
1729 @item
-bt hci
[,vlan
=@
var{n
}]
1730 Add a virtual
, standard HCI that will participate
in the Bluetooth
1731 scatternet @
var{n
} (default @code
{0}). Similarly to @option
{-net
}
1732 VLANs
, devices inside a bluetooth network @
var{n
} can only communicate
1733 with other devices
in the same
network (scatternet
).
1736 @item
-bt vhci
[,vlan
=@
var{n
}]
1737 (Linux
-host only
) Create a HCI
in scatternet @
var{n
} (default 0) attached
1738 to the host bluetooth stack instead of to the emulated target
. This
1739 allows the host and target machines to participate
in a common scatternet
1740 and communicate
. Requires the Linux @code
{vhci
} driver installed
. Can
1741 be used as following
:
1744 qemu
[...OPTIONS
...] -bt hci
,vlan
=5 -bt vhci
,vlan
=5
1747 @item
-bt device
:@
var{dev
}[,vlan
=@
var{n
}]
1748 Emulate a bluetooth device @
var{dev
} and place it
in network @
var{n
}
1749 (default @code
{0}). QEMU can only emulate one type of bluetooth devices
1754 Virtual wireless keyboard implementing the HIDP bluetooth profile
.
1761 DEFHEADING(Linux
/Multiboot boot specific
:)
1764 When
using these options
, you can use a given Linux or Multiboot
1765 kernel without installing it
in the disk image
. It can be useful
1766 for easier testing of various kernels
.
1771 DEF("kernel", HAS_ARG
, QEMU_OPTION_kernel
, \
1772 "-kernel bzImage use 'bzImage' as kernel image\n", QEMU_ARCH_ALL
)
1774 @item
-kernel @
var{bzImage
}
1776 Use @
var{bzImage
} as kernel image
. The kernel can be either a Linux kernel
1777 or
in multiboot format
.
1780 DEF("append", HAS_ARG
, QEMU_OPTION_append
, \
1781 "-append cmdline use 'cmdline' as kernel command line\n", QEMU_ARCH_ALL
)
1783 @item
-append @
var{cmdline
}
1785 Use @
var{cmdline
} as kernel command line
1788 DEF("initrd", HAS_ARG
, QEMU_OPTION_initrd
, \
1789 "-initrd file use 'file' as initial ram disk\n", QEMU_ARCH_ALL
)
1791 @item
-initrd @
var{file
}
1793 Use @
var{file
} as initial ram disk
.
1795 @item
-initrd
"@var{file1} arg=foo,@var{file2}"
1797 This syntax is only available with multiboot
.
1799 Use @
var{file1
} and @
var{file2
} as modules and pass arg
=foo as parameter to the
1809 DEFHEADING(Debug
/Expert options
:)
1815 DEF("serial", HAS_ARG
, QEMU_OPTION_serial
, \
1816 "-serial dev redirect the serial port to char device 'dev'\n",
1819 @item
-serial @
var{dev
}
1821 Redirect the virtual serial port to host character device
1822 @
var{dev
}. The
default device is @code
{vc
} in graphical mode and
1823 @code
{stdio
} in non graphical mode
.
1825 This option can be used several times to simulate up to
4 serial
1828 Use @code
{-serial none
} to disable all serial ports
.
1830 Available character devices are
:
1832 @item vc
[:@
var{W
}x@
var{H
}]
1833 Virtual console
. Optionally
, a width and height can be given
in pixel with
1837 It is also possible to specify width or height
in characters
:
1842 [Linux only
] Pseudo
TTY (a
new PTY is automatically allocated
)
1844 No device is allocated
.
1848 [Linux only
] Use host tty
, e
.g
. @file
{/dev
/ttyS0
}. The host serial port
1849 parameters are set according to the emulated ones
.
1850 @item
/dev
/parport@
var{N
}
1851 [Linux only
, parallel port only
] Use host parallel port
1852 @
var{N
}. Currently SPP and EPP parallel port features can be used
.
1853 @item file
:@
var{filename
}
1854 Write output to @
var{filename
}. No character can be read
.
1856 [Unix only
] standard input
/output
1857 @item pipe
:@
var{filename
}
1858 name pipe @
var{filename
}
1860 [Windows only
] Use host serial port @
var{n
}
1861 @item udp
:[@
var{remote_host
}]:@
var{remote_port
}[@@
[@
var{src_ip
}]:@
var{src_port
}]
1862 This
implements UDP Net Console
.
1863 When @
var{remote_host
} or @
var{src_ip
} are not specified
1864 they
default to @code
{0.0.0.0}.
1865 When not
using a specified @
var{src_port
} a random port is automatically chosen
.
1867 If you just want a simple readonly console you can use @code
{netcat
} or
1868 @code
{nc
}, by starting qemu with
: @code
{-serial udp
::4555} and nc as
:
1869 @code
{nc
-u
-l
-p
4555}. Any time qemu writes something to that port it
1870 will appear
in the netconsole session
.
1872 If you plan to send characters back via netconsole or you want to stop
1873 and start qemu a lot of times
, you should have qemu use the same
1874 source port each time by
using something like @code
{-serial
1875 udp
::4555@@
:4556} to qemu
. Another approach is to use a patched
1876 version of netcat which can listen to a TCP port and send and receive
1877 characters via udp
. If you have a patched version of netcat which
1878 activates telnet remote echo and single char transfer
, then you can
1879 use the following options to step up a netcat redirector to allow
1880 telnet on port
5555 to access the qemu port
.
1883 -serial udp
::4555@@
:4556
1884 @item netcat options
:
1885 -u
-P
4555 -L
0.0.0.0:4556 -t
-p
5555 -I
-T
1886 @item telnet options
:
1890 @item tcp
:[@
var{host
}]:@
var{port
}[,@
var{server
}][,nowait
][,nodelay
]
1891 The TCP Net Console has two modes of operation
. It can send the serial
1892 I
/O to a location or wait
for a connection from a location
. By
default
1893 the TCP Net Console is sent to @
var{host
} at the @
var{port
}. If you use
1894 the @
var{server
} option QEMU will wait
for a client socket application
1895 to connect to the port before continuing
, unless the @code
{nowait
}
1896 option was specified
. The @code
{nodelay
} option disables the Nagle buffering
1897 algorithm
. If @
var{host
} is omitted
, 0.0.0.0 is assumed
. Only
1898 one TCP connection at a time is accepted
. You can use @code
{telnet
} to
1899 connect to the corresponding character device
.
1901 @item Example to send tcp console to
192.168.0.2 port
4444
1902 -serial tcp
:192.168.0.2:4444
1903 @item Example to listen and wait on port
4444 for connection
1904 -serial tcp
::4444,server
1905 @item Example to not wait and listen on ip
192.168.0.100 port
4444
1906 -serial tcp
:192.168.0.100:4444,server
,nowait
1909 @item telnet
:@
var{host
}:@
var{port
}[,server
][,nowait
][,nodelay
]
1910 The telnet protocol is used instead of raw tcp sockets
. The options
1911 work the same as
if you had specified @code
{-serial tcp
}. The
1912 difference is that the port acts like a telnet server or client
using
1913 telnet option negotiation
. This will also allow you to send the
1914 MAGIC_SYSRQ sequence
if you use a telnet that supports sending the
break
1915 sequence
. Typically
in unix telnet you
do it with Control
-] and then
1916 type
"send break" followed by pressing the enter key
.
1918 @item unix
:@
var{path
}[,server
][,nowait
]
1919 A unix domain socket is used instead of a tcp socket
. The option works the
1920 same as
if you had specified @code
{-serial tcp
} except the unix domain socket
1921 @
var{path
} is used
for connections
.
1923 @item mon
:@
var{dev_string
}
1924 This is a special option to allow the monitor to be multiplexed onto
1925 another serial port
. The monitor is accessed with key sequence of
1926 @key
{Control
-a
} and then pressing @key
{c
}. See monitor access
1927 @ref
{pcsys_keys
} in the
-nographic section
for more keys
.
1928 @
var{dev_string
} should be any one of the serial devices specified
1929 above
. An example to multiplex the monitor onto a telnet server
1930 listening on port
4444 would be
:
1932 @item
-serial mon
:telnet
::4444,server
,nowait
1936 Braille device
. This will use BrlAPI to display the braille output on a real
1940 Three button serial mouse
. Configure the guest to use Microsoft protocol
.
1944 DEF("parallel", HAS_ARG
, QEMU_OPTION_parallel
, \
1945 "-parallel dev redirect the parallel port to char device 'dev'\n",
1948 @item
-parallel @
var{dev
}
1950 Redirect the virtual parallel port to host device @
var{dev
} (same
1951 devices as the serial port
). On Linux hosts
, @file
{/dev
/parportN
} can
1952 be used to use hardware devices connected on the corresponding host
1955 This option can be used several times to simulate up to
3 parallel
1958 Use @code
{-parallel none
} to disable all parallel ports
.
1961 DEF("monitor", HAS_ARG
, QEMU_OPTION_monitor
, \
1962 "-monitor dev redirect the monitor to char device 'dev'\n",
1965 @item
-monitor @
var{dev
}
1967 Redirect the monitor to host device @
var{dev
} (same devices as the
1969 The
default device is @code
{vc
} in graphical mode and @code
{stdio
} in
1972 DEF("qmp", HAS_ARG
, QEMU_OPTION_qmp
, \
1973 "-qmp dev like -monitor but opens in 'control' mode\n",
1976 @item
-qmp @
var{dev
}
1978 Like
-monitor but opens
in 'control' mode
.
1981 DEF("mon", HAS_ARG
, QEMU_OPTION_mon
, \
1982 "-mon chardev=[name][,mode=readline|control][,default]\n", QEMU_ARCH_ALL
)
1984 @item
-mon chardev
=[name
][,mode
=readline|control
][,default]
1986 Setup monitor on chardev @
var{name
}.
1989 DEF("debugcon", HAS_ARG
, QEMU_OPTION_debugcon
, \
1990 "-debugcon dev redirect the debug console to char device 'dev'\n",
1993 @item
-debugcon @
var{dev
}
1995 Redirect the debug console to host device @
var{dev
} (same devices as the
1996 serial port
). The debug console is an I
/O port which is typically port
1997 0xe9; writing to that I
/O port sends output to
this device
.
1998 The
default device is @code
{vc
} in graphical mode and @code
{stdio
} in
2002 DEF("pidfile", HAS_ARG
, QEMU_OPTION_pidfile
, \
2003 "-pidfile file write PID to 'file'\n", QEMU_ARCH_ALL
)
2005 @item
-pidfile @
var{file
}
2007 Store the QEMU process PID
in @
var{file
}. It is useful
if you launch QEMU
2011 DEF("singlestep", 0, QEMU_OPTION_singlestep
, \
2012 "-singlestep always run in singlestep mode\n", QEMU_ARCH_ALL
)
2016 Run the emulation
in single step mode
.
2019 DEF("S", 0, QEMU_OPTION_S
, \
2020 "-S freeze CPU at startup (use 'c' to start execution)\n",
2025 Do not start CPU at
startup (you must type
'c' in the monitor
).
2028 DEF("gdb", HAS_ARG
, QEMU_OPTION_gdb
, \
2029 "-gdb dev wait for gdb connection on 'dev'\n", QEMU_ARCH_ALL
)
2031 @item
-gdb @
var{dev
}
2033 Wait
for gdb connection on device @
var{dev
} (@pxref
{gdb_usage
}). Typical
2034 connections will likely be TCP
-based
, but also UDP
, pseudo TTY
, or even
2035 stdio are reasonable use
case. The latter is allowing to start qemu from
2036 within gdb and establish the connection via a pipe
:
2038 (gdb
) target remote | exec qemu
-gdb stdio
...
2042 DEF("s", 0, QEMU_OPTION_s
, \
2043 "-s shorthand for -gdb tcp::" DEFAULT_GDBSTUB_PORT
"\n",
2048 Shorthand
for -gdb tcp
::1234, i
.e
. open a gdbserver on TCP port
1234
2049 (@pxref
{gdb_usage
}).
2052 DEF("d", HAS_ARG
, QEMU_OPTION_d
, \
2053 "-d item1,... output log to /tmp/qemu.log (use -d ? for a list of log items)\n",
2058 Output log
in /tmp
/qemu
.log
2061 DEF("D", HAS_ARG
, QEMU_OPTION_D
, \
2062 "-D logfile output log to logfile (instead of the default /tmp/qemu.log)\n",
2067 Output log
in logfile instead of
/tmp
/qemu
.log
2070 DEF("hdachs", HAS_ARG
, QEMU_OPTION_hdachs
, \
2071 "-hdachs c,h,s[,t]\n" \
2072 " force hard disk 0 physical geometry and the optional BIOS\n" \
2073 " translation (t=none or lba) (usually qemu can guess them)\n",
2076 @item
-hdachs @
var{c
},@
var{h
},@
var{s
},[,@
var{t
}]
2078 Force hard disk
0 physical
geometry (1 <= @
var{c
} <= 16383, 1 <=
2079 @
var{h
} <= 16, 1 <= @
var{s
} <= 63) and optionally force the BIOS
2080 translation
mode (@
var{t
}=none
, lba or auto
). Usually QEMU can guess
2081 all those parameters
. This option is useful
for old MS
-DOS disk
2085 DEF("L", HAS_ARG
, QEMU_OPTION_L
, \
2086 "-L path set the directory for the BIOS, VGA BIOS and keymaps\n",
2091 Set the directory
for the BIOS
, VGA BIOS and keymaps
.
2094 DEF("bios", HAS_ARG
, QEMU_OPTION_bios
, \
2095 "-bios file set the filename for the BIOS\n", QEMU_ARCH_ALL
)
2097 @item
-bios @
var{file
}
2099 Set the filename
for the BIOS
.
2102 DEF("enable-kvm", 0, QEMU_OPTION_enable_kvm
, \
2103 "-enable-kvm enable KVM full virtualization support\n", QEMU_ARCH_ALL
)
2107 Enable KVM full virtualization support
. This option is only available
2108 if KVM support is enabled when compiling
.
2111 DEF("xen-domid", HAS_ARG
, QEMU_OPTION_xen_domid
,
2112 "-xen-domid id specify xen guest domain id\n", QEMU_ARCH_ALL
)
2113 DEF("xen-create", 0, QEMU_OPTION_xen_create
,
2114 "-xen-create create domain using xen hypercalls, bypassing xend\n"
2115 " warning: should not be used when xend is in use\n",
2117 DEF("xen-attach", 0, QEMU_OPTION_xen_attach
,
2118 "-xen-attach attach to existing xen domain\n"
2119 " xend will use this when starting qemu\n",
2122 @item
-xen
-domid @
var{id
}
2124 Specify xen guest domain @
var{id
} (XEN only
).
2127 Create domain
using xen hypercalls
, bypassing xend
.
2128 Warning
: should not be used when xend is
in use (XEN only
).
2131 Attach to existing xen domain
.
2132 xend will use
this when starting
qemu (XEN only
).
2135 DEF("no-reboot", 0, QEMU_OPTION_no_reboot
, \
2136 "-no-reboot exit instead of rebooting\n", QEMU_ARCH_ALL
)
2140 Exit instead of rebooting
.
2143 DEF("no-shutdown", 0, QEMU_OPTION_no_shutdown
, \
2144 "-no-shutdown stop before shutdown\n", QEMU_ARCH_ALL
)
2147 @findex
-no
-shutdown
2148 Don
't exit QEMU on guest shutdown, but instead only stop the emulation.
2149 This allows for instance switching to monitor to commit changes to the
2153 DEF("loadvm", HAS_ARG, QEMU_OPTION_loadvm, \
2154 "-loadvm [tag|id]\n" \
2155 " start right away with a saved state (loadvm in monitor)\n",
2158 @item -loadvm @var{file}
2160 Start right away with a saved state (@code{loadvm} in monitor)
2164 DEF("daemonize", 0, QEMU_OPTION_daemonize, \
2165 "-daemonize daemonize QEMU after initializing\n", QEMU_ARCH_ALL)
2170 Daemonize the QEMU process after initialization. QEMU will not detach from
2171 standard IO until it is ready to receive connections on any of its devices.
2172 This option is a useful way for external programs to launch QEMU without having
2173 to cope with initialization race conditions.
2176 DEF("option-rom", HAS_ARG, QEMU_OPTION_option_rom, \
2177 "-option-rom rom load a file, rom, into the option ROM space\n",
2180 @item -option-rom @var{file}
2182 Load the contents of @var{file} as an option ROM.
2183 This option is useful to load things like EtherBoot.
2186 DEF("clock", HAS_ARG, QEMU_OPTION_clock, \
2187 "-clock force the use of the given methods for timer alarm.\n" \
2188 " To see what timers are available use -clock ?\n",
2191 @item -clock @var{method}
2193 Force the use of the given methods for timer alarm. To see what timers
2194 are available use -clock ?.
2197 HXCOMM Options deprecated by -rtc
2198 DEF("localtime", 0, QEMU_OPTION_localtime, "", QEMU_ARCH_ALL)
2199 DEF("startdate", HAS_ARG, QEMU_OPTION_startdate, "", QEMU_ARCH_ALL)
2201 DEF("rtc", HAS_ARG, QEMU_OPTION_rtc, \
2202 "-rtc [base=utc|localtime|date][,clock=host|vm][,driftfix=none|slew]\n" \
2203 " set the RTC base and clock, enable drift fix for clock ticks (x86 only)\n",
2208 @item -rtc [base=utc|localtime|@var{date}][,clock=host|vm][,driftfix=none|slew]
2210 Specify @option{base} as @code{utc} or @code{localtime} to let the RTC start at the current
2211 UTC or local time, respectively. @code{localtime} is required for correct date in
2212 MS-DOS or Windows. To start at a specific point in time, provide @var{date} in the
2213 format @code{2006-06-17T16:01:21} or @code{2006-06-17}. The default base is UTC.
2215 By default the RTC is driven by the host system time. This allows to use the
2216 RTC as accurate reference clock inside the guest, specifically if the host
2217 time is smoothly following an accurate external reference clock, e.g. via NTP.
2218 If you want to isolate the guest time from the host, even prevent it from
2219 progressing during suspension, you can set @option{clock} to @code{vm} instead.
2221 Enable @option{driftfix} (i386 targets only) if you experience time drift problems,
2222 specifically with Windows' ACPI HAL
. This option will
try to figure out how
2223 many timer interrupts were not processed by the Windows guest and will
2227 DEF("icount", HAS_ARG
, QEMU_OPTION_icount
, \
2228 "-icount [N|auto]\n" \
2229 " enable virtual instruction counter with 2^N clock ticks per\n" \
2230 " instruction\n", QEMU_ARCH_ALL
)
2232 @item
-icount
[@
var{N
}|auto
]
2234 Enable virtual instruction counter
. The virtual cpu will execute one
2235 instruction every
2^@
var{N
} ns of virtual time
. If @code
{auto
} is specified
2236 then the virtual cpu speed will be automatically adjusted to keep virtual
2237 time within a few seconds of real time
.
2239 Note that
while this option can give deterministic behavior
, it does not
2240 provide cycle accurate emulation
. Modern CPUs contain superscalar out of
2241 order cores with complex cache hierarchies
. The number of instructions
2242 executed often has little or no correlation with actual performance
.
2245 DEF("watchdog", HAS_ARG
, QEMU_OPTION_watchdog
, \
2246 "-watchdog i6300esb|ib700\n" \
2247 " enable virtual hardware watchdog [default=none]\n",
2250 @item
-watchdog @
var{model
}
2252 Create a virtual hardware watchdog device
. Once
enabled (by a guest
2253 action
), the watchdog must be periodically polled by an agent inside
2254 the guest or
else the guest will be restarted
.
2256 The @
var{model
} is the model of hardware watchdog to emulate
. Choices
2257 for model are
: @code
{ib700
} (iBASE
700) which is a very simple ISA
2258 watchdog with a single timer
, or @code
{i6300esb
} (Intel
6300ESB I
/O
2259 controller hub
) which is a much more featureful PCI
-based dual
-timer
2260 watchdog
. Choose a model
for which your guest has drivers
.
2262 Use @code
{-watchdog ?
} to list available hardware models
. Only one
2263 watchdog can be enabled
for a guest
.
2266 DEF("watchdog-action", HAS_ARG
, QEMU_OPTION_watchdog_action
, \
2267 "-watchdog-action reset|shutdown|poweroff|pause|debug|none\n" \
2268 " action when watchdog fires [default=reset]\n",
2271 @item
-watchdog
-action @
var{action
}
2273 The @
var{action
} controls what QEMU will
do when the watchdog timer
2276 @code
{reset
} (forcefully reset the guest
).
2277 Other possible actions are
:
2278 @code
{shutdown
} (attempt to gracefully shutdown the guest
),
2279 @code
{poweroff
} (forcefully poweroff the guest
),
2280 @code
{pause
} (pause the guest
),
2281 @code
{debug
} (print a debug message and
continue), or
2282 @code
{none
} (do nothing
).
2284 Note that the @code
{shutdown
} action requires that the guest responds
2285 to ACPI signals
, which it may not be able to
do in the sort of
2286 situations where the watchdog would have expired
, and thus
2287 @code
{-watchdog
-action shutdown
} is not recommended
for production use
.
2292 @item
-watchdog i6300esb
-watchdog
-action pause
2293 @item
-watchdog ib700
2297 DEF("echr", HAS_ARG
, QEMU_OPTION_echr
, \
2298 "-echr chr set terminal escape character instead of ctrl-a\n",
2302 @item
-echr @
var{numeric_ascii_value
}
2304 Change the escape character used
for switching to the monitor when
using
2305 monitor and serial sharing
. The
default is @code
{0x01} when
using the
2306 @code
{-nographic
} option
. @code
{0x01} is equal to pressing
2307 @code
{Control
-a
}. You can select a different character from the ascii
2308 control keys where
1 through
26 map to Control
-a through Control
-z
. For
2309 instance you could use the either of the following to change the escape
2310 character to Control
-t
.
2317 DEF("virtioconsole", HAS_ARG
, QEMU_OPTION_virtiocon
, \
2318 "-virtioconsole c\n" \
2319 " set virtio console\n", QEMU_ARCH_ALL
)
2321 @item
-virtioconsole @
var{c
}
2322 @findex
-virtioconsole
2325 This option is maintained
for backward compatibility
.
2327 Please use @code
{-device virtconsole
} for the
new way of invocation
.
2330 DEF("show-cursor", 0, QEMU_OPTION_show_cursor
, \
2331 "-show-cursor show cursor\n", QEMU_ARCH_ALL
)
2334 @findex
-show
-cursor
2338 DEF("tb-size", HAS_ARG
, QEMU_OPTION_tb_size
, \
2339 "-tb-size n set TB size\n", QEMU_ARCH_ALL
)
2341 @item
-tb
-size @
var{n
}
2346 DEF("incoming", HAS_ARG
, QEMU_OPTION_incoming
, \
2347 "-incoming p prepare for incoming migration, listen on port p\n",
2350 @item
-incoming @
var{port
}
2352 Prepare
for incoming migration
, listen on @
var{port
}.
2355 DEF("nodefaults", 0, QEMU_OPTION_nodefaults
, \
2356 "-nodefaults don't create default devices\n", QEMU_ARCH_ALL
)
2360 Don
't create default devices.
2364 DEF("chroot", HAS_ARG, QEMU_OPTION_chroot, \
2365 "-chroot dir chroot to dir just before starting the VM\n",
2369 @item -chroot @var{dir}
2371 Immediately before starting guest execution, chroot to the specified
2372 directory. Especially useful in combination with -runas.
2376 DEF("runas", HAS_ARG, QEMU_OPTION_runas, \
2377 "-runas user change to user id user just before starting the VM\n",
2381 @item -runas @var{user}
2383 Immediately before starting guest execution, drop root privileges, switching
2384 to the specified user.
2387 DEF("prom-env", HAS_ARG, QEMU_OPTION_prom_env,
2388 "-prom-env variable=value\n"
2389 " set OpenBIOS nvram variables\n",
2390 QEMU_ARCH_PPC | QEMU_ARCH_SPARC)
2392 @item -prom-env @var{variable}=@var{value}
2394 Set OpenBIOS nvram @var{variable} to given @var{value} (PPC, SPARC only).
2396 DEF("semihosting", 0, QEMU_OPTION_semihosting,
2397 "-semihosting semihosting mode\n", QEMU_ARCH_ARM | QEMU_ARCH_M68K)
2400 @findex -semihosting
2401 Semihosting mode (ARM, M68K only).
2403 DEF("old-param", 0, QEMU_OPTION_old_param,
2404 "-old-param old param mode\n", QEMU_ARCH_ARM)
2407 @findex -old-param (ARM)
2408 Old param mode (ARM only).
2411 DEF("readconfig", HAS_ARG, QEMU_OPTION_readconfig,
2412 "-readconfig <file>\n", QEMU_ARCH_ALL)
2414 @item -readconfig @var{file}
2416 Read device configuration from @var{file}.
2418 DEF("writeconfig", HAS_ARG, QEMU_OPTION_writeconfig,
2419 "-writeconfig <file>\n"
2420 " read/write config file\n", QEMU_ARCH_ALL)
2422 @item -writeconfig @var{file}
2423 @findex -writeconfig
2424 Write device configuration to @var{file}.
2426 DEF("nodefconfig", 0, QEMU_OPTION_nodefconfig,
2428 " do not load default config files at startup\n",
2432 @findex -nodefconfig
2433 Normally QEMU loads a configuration file from @var{sysconfdir}/qemu.conf and
2434 @var{sysconfdir}/target-@var{ARCH}.conf on startup. The @code{-nodefconfig}
2435 option will prevent QEMU from loading these configuration files at startup.
2437 #ifdef CONFIG_SIMPLE_TRACE
2438 DEF("trace", HAS_ARG, QEMU_OPTION_trace,
2440 " Specify a trace file to log traces to\n",
2445 Specify a trace file to log output traces to.
2449 DEF("no-kvm", 0, QEMU_OPTION_no_kvm,
2450 "-no-kvm disable KVM hardware virtualization\n",
2452 DEF("no-kvm-irqchip", 0, QEMU_OPTION_no_kvm_irqchip,
2453 "-no-kvm-irqchip disable KVM kernel mode PIC/IOAPIC/LAPIC\n",
2455 DEF("no-kvm-pit", 0, QEMU_OPTION_no_kvm_pit,
2456 "-no-kvm-pit disable KVM kernel mode PIT\n",
2458 DEF("no-kvm-pit-reinjection", 0, QEMU_OPTION_no_kvm_pit_reinjection,
2459 "-no-kvm-pit-reinjection\n"
2460 " disable KVM kernel mode PIT interrupt reinjection\n",
2462 DEF("nvram", HAS_ARG, QEMU_OPTION_nvram,
2463 "-nvram FILE provide ia64 nvram contents\n", QEMU_ARCH_ALL)
2464 DEF("tdf", 0, QEMU_OPTION_tdf,
2465 "-tdf enable guest time drift compensation\n", QEMU_ARCH_ALL)
2466 DEF("kvm-shadow-memory", HAS_ARG, QEMU_OPTION_kvm_shadow_memory,
2467 "-kvm-shadow-memory MEGABYTES\n"
2468 " allocate MEGABYTES for kvm mmu shadowing\n",
2471 HXCOMM This is the last statement. Insert new options before this line!