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|directsync|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", "directsync" 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 The host page cache can be avoided while only sending write notifications to
205 the guest when the data has been reported as written by the storage subsystem
206 using @option{cache=directsync}.
208 Some block drivers perform badly with @option{cache=writethrough}, most notably,
209 qcow2. If performance is more important than correctness,
210 @option{cache=writeback} should be used with qcow2.
212 In case you don't care about data integrity over host failures
, use
213 cache
=unsafe
. This option tells qemu that it
never needs to write any data
214 to the disk but can instead keeps things
in cache
. If anything goes wrong
,
215 like your host losing power
, the disk storage getting disconnected accidently
,
216 etc
. you
're image will most probably be rendered unusable. When using
217 the @option{-snapshot} option, unsafe caching is always used.
219 Instead of @option{-cdrom} you can use:
221 qemu -drive file=file,index=2,media=cdrom
224 Instead of @option{-hda}, @option{-hdb}, @option{-hdc}, @option{-hdd}, you can
227 qemu -drive file=file,index=0,media=disk
228 qemu -drive file=file,index=1,media=disk
229 qemu -drive file=file,index=2,media=disk
230 qemu -drive file=file,index=3,media=disk
233 You can connect a CDROM to the slave of ide0:
235 qemu -drive file=file,if=ide,index=1,media=cdrom
238 If you don't specify the
"file=" argument
, you define an empty drive
:
240 qemu
-drive
if=ide
,index
=1,media
=cdrom
243 You can connect a SCSI disk with unit ID
6 on the bus #
0:
245 qemu
-drive file
=file
,if=scsi
,bus
=0,unit
=6
248 Instead of @option
{-fda
}, @option
{-fdb
}, you can use
:
250 qemu
-drive file
=file
,index
=0,if=floppy
251 qemu
-drive file
=file
,index
=1,if=floppy
254 By
default, @
var{interface} is
"ide" and @
var{index
} is automatically
257 qemu
-drive file
=a
-drive file
=b
"
265 DEF("set
", HAS_ARG, QEMU_OPTION_set,
266 "-set group
.id
.arg
=value
\n"
267 " set
<arg
> parameter
for item
<id
> of type
<group
>\n"
268 " i
.e
. -set drive
.$id
.file
=/path
/to
/image
\n", QEMU_ARCH_ALL)
275 DEF("global
", HAS_ARG, QEMU_OPTION_global,
276 "-global driver
.property
=value
\n"
277 " set a global
default for a driver property
\n",
285 DEF("mtdblock
", HAS_ARG, QEMU_OPTION_mtdblock,
286 "-mtdblock file use
'file' as on
-board Flash memory image
\n",
289 @item -mtdblock @var{file}
291 Use @var{file} as on-board Flash memory image.
294 DEF("sd
", HAS_ARG, QEMU_OPTION_sd,
295 "-sd file use
'file' as SecureDigital card image
\n", QEMU_ARCH_ALL)
299 Use @var{file} as SecureDigital card image.
302 DEF("pflash
", HAS_ARG, QEMU_OPTION_pflash,
303 "-pflash file use
'file' as a parallel flash image
\n", QEMU_ARCH_ALL)
305 @item -pflash @var{file}
307 Use @var{file} as a parallel flash image.
310 DEF("boot
", HAS_ARG, QEMU_OPTION_boot,
311 "-boot
[order
=drives
][,once
=drives
][,menu
=on|off
]\n"
312 " [,splash
=sp_name
][,splash
-time
=sp_time
]\n"
313 " 'drives': floppy (a
), hard
disk (c
), CD
-ROM (d
), network (n
)\n"
314 " 'sp_name': the file
's name that would be passed to bios as logo picture, if menu=on\n"
315 " 'sp_time
': the period that splash picture last if menu=on, unit is ms\n",
318 @item -boot [order=@var{drives}][,once=@var{drives}][,menu=on|off][,splash=@var{sp_name}][,splash-time=@var{sp_time}]
320 Specify boot order @var{drives} as a string of drive letters. Valid
321 drive letters depend on the target achitecture. The x86 PC uses: a, b
322 (floppy 1 and 2), c (first hard disk), d (first CD-ROM), n-p (Etherboot
323 from network adapter 1-4), hard disk boot is the default. To apply a
324 particular boot order only on the first startup, specify it via
327 Interactive boot menus/prompts can be enabled via @option{menu=on} as far
328 as firmware/BIOS supports them. The default is non-interactive boot.
330 A splash picture could be passed to bios, enabling user to show it as logo,
331 when option splash=@var{sp_name} is given and menu=on, If firmware/BIOS
332 supports them. Currently Seabios for X86 system support it.
333 limitation: The splash file could be a jpeg file or a BMP file in 24 BPP
334 format(true color). The resolution should be supported by the SVGA mode, so
335 the recommended is 320x240, 640x480, 800x640.
338 # try to boot from network first, then from hard disk
340 # boot from CD-ROM first, switch back to default order after reboot
342 # boot with a splash picture for 5 seconds.
343 qemu -boot menu=on,splash=/root/boot.bmp,splash-time=5000
346 Note: The legacy format '-boot @
var{drives
}' is still supported but its
347 use is discouraged as it may be removed from future versions.
350 DEF("snapshot", 0, QEMU_OPTION_snapshot,
351 "-snapshot write to temporary files instead of disk image files\n",
356 Write to temporary files instead of disk image files. In this case,
357 the raw disk image you use is not written back. You can however force
358 the write back by pressing @key{C-a s} (@pxref{disk_images}).
361 DEF("m", HAS_ARG, QEMU_OPTION_m,
362 "-m megs set virtual RAM size to megs MB [default="
363 stringify(DEFAULT_RAM_SIZE) "]\n", QEMU_ARCH_ALL)
367 Set virtual RAM size to @var{megs} megabytes. Default is 128 MiB. Optionally,
368 a suffix of ``M'' or ``G'' can be used to signify a value in megabytes or
369 gigabytes respectively.
372 DEF("mem-path", HAS_ARG, QEMU_OPTION_mempath,
373 "-mem-path FILE provide backing storage for guest RAM\n", QEMU_ARCH_ALL)
375 @item -mem-path @var{path}
376 Allocate guest RAM from a temporarily created file in @var{path}.
380 DEF("mem-prealloc", 0, QEMU_OPTION_mem_prealloc,
381 "-mem-prealloc preallocate guest memory (use with -mem-path)\n",
385 Preallocate memory when using -mem-path.
389 DEF("k", HAS_ARG, QEMU_OPTION_k,
390 "-k language use keyboard layout (for example 'fr
' for French)\n",
393 @item -k @var{language}
395 Use keyboard layout @var{language} (for example @code{fr} for
396 French). This option is only needed where it is not easy to get raw PC
397 keycodes (e.g. on Macs, with some X11 servers or with a VNC
398 display). You don't normally need to use it on PC
/Linux or PC
/Windows
401 The available layouts are
:
403 ar de
-ch es fo fr
-ca hu ja mk no pt
-br sv
404 da en
-gb et fr fr
-ch is lt nl pl ru th
405 de en
-us fi fr
-be hr it lv nl
-be pt sl tr
408 The
default is @code
{en
-us
}.
412 DEF("audio-help", 0, QEMU_OPTION_audio_help
,
413 "-audio-help print list of audio drivers and their options\n",
418 Will show the audio subsystem help
: list of drivers
, tunable
422 DEF("soundhw", HAS_ARG
, QEMU_OPTION_soundhw
,
423 "-soundhw c1,... enable audio support\n"
424 " and only specified sound cards (comma separated list)\n"
425 " use -soundhw ? to get the list of supported cards\n"
426 " use -soundhw all to enable all of them\n", QEMU_ARCH_ALL
)
428 @item
-soundhw @
var{card1
}[,@
var{card2
},...] or
-soundhw all
430 Enable audio and selected sound hardware
. Use ? to print all
431 available sound hardware
.
434 qemu
-soundhw sb16
,adlib disk
.img
435 qemu
-soundhw es1370 disk
.img
436 qemu
-soundhw ac97 disk
.img
437 qemu
-soundhw hda disk
.img
438 qemu
-soundhw all disk
.img
442 Note that Linux
's i810_audio OSS kernel (for AC97) module might
443 require manually specifying clocking.
446 modprobe i810_audio clocking=48000
454 DEF("usb", 0, QEMU_OPTION_usb,
455 "-usb enable the USB driver (will be the default soon)\n",
463 Enable the USB driver (will be the default soon)
466 DEF("usbdevice", HAS_ARG, QEMU_OPTION_usbdevice,
467 "-usbdevice name add the host or guest USB device 'name
'\n",
471 @item -usbdevice @var{devname}
473 Add the USB device @var{devname}. @xref{usb_devices}.
478 Virtual Mouse. This will override the PS/2 mouse emulation when activated.
481 Pointer device that uses absolute coordinates (like a touchscreen). This
482 means qemu is able to report the mouse position without having to grab the
483 mouse. Also overrides the PS/2 mouse emulation when activated.
485 @item disk:[format=@var{format}]:@var{file}
486 Mass storage device based on file. The optional @var{format} argument
487 will be used rather than detecting the format. Can be used to specifiy
488 @code{format=raw} to avoid interpreting an untrusted format header.
490 @item host:@var{bus}.@var{addr}
491 Pass through the host device identified by @var{bus}.@var{addr} (Linux only).
493 @item host:@var{vendor_id}:@var{product_id}
494 Pass through the host device identified by @var{vendor_id}:@var{product_id}
497 @item serial:[vendorid=@var{vendor_id}][,productid=@var{product_id}]:@var{dev}
498 Serial converter to host character device @var{dev}, see @code{-serial} for the
502 Braille device. This will use BrlAPI to display the braille output on a real
505 @item net:@var{options}
506 Network adapter that supports CDC ethernet and RNDIS protocols.
511 DEF("device", HAS_ARG, QEMU_OPTION_device,
512 "-device driver[,prop[=value][,...]]\n"
513 " add device (based on driver)\n"
514 " prop=value,... sets driver properties\n"
515 " use -device ? to print all possible drivers\n"
516 " use -device driver,? to print all possible properties\n",
519 @item -device @var{driver}[,@var{prop}[=@var{value}][,...]]
521 Add device @var{driver}. @var{prop}=@var{value} sets driver
522 properties. Valid properties depend on the driver. To get help on
523 possible drivers and properties, use @code{-device ?} and
524 @code{-device @var{driver},?}.
527 DEFHEADING(File system options:)
529 DEF("fsdev", HAS_ARG, QEMU_OPTION_fsdev,
530 "-fsdev local,id=id,path=path,security_model=[mapped|passthrough|none]\n",
535 The general form of a File system device option is:
538 @item -fsdev @var{fstype} ,id=@var{id} [,@var{options}]
542 The specific Fstype will determine the applicable options.
544 Options to each backend are described below.
546 @item -fsdev local ,id=@var{id} ,path=@var{path} ,security_model=@var{security_model}
548 Create a file-system-"device" for local-filesystem.
550 @option{local} is only available on Linux.
552 @option{path} specifies the path to be exported. @option{path} is required.
554 @option{security_model} specifies the security model to be followed.
555 @option{security_model} is required.
560 DEFHEADING(Virtual File system pass-through options:)
562 DEF("virtfs", HAS_ARG, QEMU_OPTION_virtfs,
563 "-virtfs local,path=path,mount_tag=tag,security_model=[mapped|passthrough|none]\n",
568 The general form of a Virtual File system pass-through option is:
571 @item -virtfs @var{fstype} [,@var{options}]
575 The specific Fstype will determine the applicable options.
577 Options to each backend are described below.
579 @item -virtfs local ,path=@var{path} ,mount_tag=@var{mount_tag} ,security_model=@var{security_model}
581 Create a Virtual file-system-pass through for local-filesystem.
583 @option{local} is only available on Linux.
585 @option{path} specifies the path to be exported. @option{path} is required.
587 @option{security_model} specifies the security model to be followed.
588 @option{security_model} is required.
591 @option{mount_tag} specifies the tag with which the exported file is mounted.
592 @option{mount_tag} is required.
599 DEF("name", HAS_ARG, QEMU_OPTION_name,
600 "-name string1[,process=string2]\n"
601 " set the name of the guest\n"
602 " string1 sets the window title and string2 the process name (on Linux)\n",
605 @item -name @var{name}
607 Sets the @var{name} of the guest.
608 This name will be displayed in the SDL window caption.
609 The @var{name} will also be used for the VNC server.
610 Also optionally set the top visible process name in Linux.
613 DEF("uuid", HAS_ARG, QEMU_OPTION_uuid,
614 "-uuid %08x-%04x-%04x-%04x-%012x\n"
615 " specify machine UUID\n", QEMU_ARCH_ALL)
617 @item -uuid @var{uuid}
628 DEFHEADING(Display options:)
634 DEF("display", HAS_ARG, QEMU_OPTION_display,
635 "-display sdl[,frame=on|off][,alt_grab=on|off][,ctrl_grab=on|off]\n"
636 " [,window_close=on|off]|curses|none|\n"
637 " vnc=<display>[,<optargs>]\n"
638 " select display type\n", QEMU_ARCH_ALL)
640 @item -display @var{type}
642 Select type of display to use. This option is a replacement for the
643 old style -sdl/-curses/... options. Valid values for @var{type} are
646 Display video output via SDL (usually in a separate graphics
647 window; see the SDL documentation for other possibilities).
649 Display video output via curses. For graphics device models which
650 support a text mode, QEMU can display this output using a
651 curses/ncurses interface. Nothing is displayed when the graphics
652 device is in graphical mode or if the graphics device does not support
653 a text mode. Generally only the VGA device models support text mode.
655 Do not display video output. The guest will still see an emulated
656 graphics card, but its output will not be displayed to the QEMU
657 user. This option differs from the -nographic option in that it
658 only affects what is done with video output; -nographic also changes
659 the destination of the serial and parallel port data.
661 Start a VNC server on display <arg>
665 DEF("nographic", 0, QEMU_OPTION_nographic,
666 "-nographic disable graphical output and redirect serial I/Os to console\n",
671 Normally, QEMU uses SDL to display the VGA output. With this option,
672 you can totally disable graphical output so that QEMU is a simple
673 command line application. The emulated serial port is redirected on
674 the console. Therefore, you can still use QEMU to debug a Linux kernel
675 with a serial console.
678 DEF("curses", 0, QEMU_OPTION_curses,
679 "-curses use a curses/ncurses interface instead of SDL\n",
684 Normally, QEMU uses SDL to display the VGA output. With this option,
685 QEMU can display the VGA output when in text mode using a
686 curses/ncurses interface. Nothing is displayed in graphical mode.
689 DEF("no-frame", 0, QEMU_OPTION_no_frame,
690 "-no-frame open SDL window without a frame and window decorations\n",
695 Do not use decorations for SDL windows and start them using the whole
696 available screen space. This makes the using QEMU in a dedicated desktop
697 workspace more convenient.
700 DEF("alt-grab", 0, QEMU_OPTION_alt_grab,
701 "-alt-grab use Ctrl-Alt-Shift to grab mouse (instead of Ctrl-Alt)\n",
706 Use Ctrl-Alt-Shift to grab mouse (instead of Ctrl-Alt). Note that this also
707 affects the special keys (for fullscreen, monitor-mode switching, etc).
710 DEF("ctrl-grab", 0, QEMU_OPTION_ctrl_grab,
711 "-ctrl-grab use Right-Ctrl to grab mouse (instead of Ctrl-Alt)\n",
716 Use Right-Ctrl to grab mouse (instead of Ctrl-Alt). Note that this also
717 affects the special keys (for fullscreen, monitor-mode switching, etc).
720 DEF("no-quit", 0, QEMU_OPTION_no_quit,
721 "-no-quit disable SDL window close capability\n", QEMU_ARCH_ALL)
725 Disable SDL window close capability.
728 DEF("sdl", 0, QEMU_OPTION_sdl,
729 "-sdl enable SDL\n", QEMU_ARCH_ALL)
736 DEF("spice", HAS_ARG, QEMU_OPTION_spice,
737 "-spice <args> enable spice\n", QEMU_ARCH_ALL)
739 @item -spice @var{option}[,@var{option}[,...]]
741 Enable the spice remote desktop protocol. Valid options are
746 Set the TCP port spice is listening on for plaintext channels.
749 Set the IP address spice is listening on. Default is any address.
753 Force using the specified IP version.
755 @item password=<secret>
756 Set the password you need to authenticate.
759 Require that the client use SASL to authenticate with the spice.
760 The exact choice of authentication method used is controlled from the
761 system / user's SASL configuration file
for the
'qemu' service
. This
762 is typically found
in /etc
/sasl2
/qemu
.conf
. If running QEMU as an
763 unprivileged user
, an environment variable SASL_CONF_PATH can be used
764 to make it search alternate locations
for the service config
.
765 While some SASL auth methods can also provide data
encryption (eg GSSAPI
),
766 it is recommended that SASL always be combined with the
'tls' and
767 'x509' settings to enable use of SSL and server certificates
. This
768 ensures a data encryption preventing compromise of authentication
771 @item disable
-ticketing
772 Allow client connects without authentication
.
774 @item disable
-copy
-paste
775 Disable copy paste between the client and the guest
.
778 Set the TCP port spice is listening on
for encrypted channels
.
781 Set the x509 file directory
. Expects same filenames as
-vnc $display
,x509
=$dir
783 @item x509
-key
-file
=<file
>
784 @item x509
-key
-password
=<file
>
785 @item x509
-cert
-file
=<file
>
786 @item x509
-cacert
-file
=<file
>
787 @item x509
-dh
-key
-file
=<file
>
788 The x509 file names can also be configured individually
.
790 @item tls
-ciphers
=<list
>
791 Specify which ciphers to use
.
793 @item tls
-channel
=[main|display|inputs|record|playback|tunnel
]
794 @item plaintext
-channel
=[main|display|inputs|record|playback|tunnel
]
795 Force specific channel to be used with or without TLS encryption
. The
796 options can be specified multiple times to configure multiple
797 channels
. The special name
"default" can be used to set the
default
798 mode
. For channels which are not explicitly forced into one mode the
799 spice client is allowed to pick tls
/plaintext as he pleases
.
801 @item image
-compression
=[auto_glz|auto_lz|quic|glz|lz|off
]
802 Configure image
compression (lossless
).
805 @item jpeg
-wan
-compression
=[auto|
never|always
]
806 @item zlib
-glz
-wan
-compression
=[auto|
never|always
]
807 Configure wan image
compression (lossy
for slow links
).
810 @item streaming
-video
=[off|all|filter
]
811 Configure video stream detection
. Default is filter
.
813 @item agent
-mouse
=[on|off
]
814 Enable
/disable passing mouse events via vdagent
. Default is on
.
816 @item playback
-compression
=[on|off
]
817 Enable
/disable audio stream
compression (using celt
0.5.1). Default is on
.
822 DEF("portrait", 0, QEMU_OPTION_portrait
,
823 "-portrait rotate graphical output 90 deg left (only PXA LCD)\n",
828 Rotate graphical output
90 deg
left (only PXA LCD
).
831 DEF("rotate", HAS_ARG
, QEMU_OPTION_rotate
,
832 "-rotate <deg> rotate graphical output some deg left (only PXA LCD)\n",
837 Rotate graphical output some deg
left (only PXA LCD
).
840 DEF("vga", HAS_ARG
, QEMU_OPTION_vga
,
841 "-vga [std|cirrus|vmware|qxl|xenfb|none]\n"
842 " select video card type\n", QEMU_ARCH_ALL
)
844 @item
-vga @
var{type
}
846 Select type of VGA card to emulate
. Valid values
for @
var{type
} are
849 Cirrus Logic GD5446 Video card
. All Windows versions starting from
850 Windows
95 should recognize and use
this graphic card
. For optimal
851 performances
, use
16 bit color depth
in the guest and the host OS
.
852 (This one is the
default)
854 Standard VGA card with Bochs VBE extensions
. If your guest OS
855 supports the VESA
2.0 VBE
extensions (e
.g
. Windows XP
) and
if you want
856 to use high resolution
modes (>= 1280x1024x16
) then you should use
859 VMWare SVGA
-II compatible adapter
. Use it
if you have sufficiently
860 recent XFree86
/XOrg server or Windows guest with a driver
for this
863 QXL paravirtual graphic card
. It is VGA
compatible (including VESA
864 2.0 VBE support
). Works best with qxl guest drivers installed though
.
865 Recommended choice when
using the spice protocol
.
871 DEF("full-screen", 0, QEMU_OPTION_full_screen
,
872 "-full-screen start in full screen\n", QEMU_ARCH_ALL
)
876 Start
in full screen
.
879 DEF("g", 1, QEMU_OPTION_g
,
880 "-g WxH[xDEPTH] Set the initial graphical resolution and depth\n",
881 QEMU_ARCH_PPC | QEMU_ARCH_SPARC
)
883 @item
-g @
var{width
}x@
var{height
}[x@
var{depth
}]
885 Set the initial graphical resolution and
depth (PPC
, SPARC only
).
888 DEF("vnc", HAS_ARG
, QEMU_OPTION_vnc
,
889 "-vnc display start a VNC server on display\n", QEMU_ARCH_ALL
)
891 @item
-vnc @
var{display
}[,@
var{option
}[,@
var{option
}[,...]]]
893 Normally
, QEMU uses SDL to display the VGA output
. With
this option
,
894 you can have QEMU listen on VNC display @
var{display
} and redirect the VGA
895 display over the VNC session
. It is very useful to enable the usb
896 tablet device when
using this option (option @option
{-usbdevice
897 tablet
}). When
using the VNC display
, you must use the @option
{-k
}
898 parameter to set the keyboard layout
if you are not
using en
-us
. Valid
899 syntax
for the @
var{display
} is
903 @item @
var{host
}:@
var{d
}
905 TCP connections will only be allowed from @
var{host
} on display @
var{d
}.
906 By convention the TCP port is
5900+@
var{d
}. Optionally
, @
var{host
} can
907 be omitted
in which
case the server will accept connections from any host
.
909 @item unix
:@
var{path
}
911 Connections will be allowed over UNIX domain sockets where @
var{path
} is the
912 location of a unix socket to listen
for connections on
.
916 VNC is initialized but not started
. The monitor @code
{change
} command
917 can be used to later start the VNC server
.
921 Following the @
var{display
} value there may be one or more @
var{option
} flags
922 separated by commas
. Valid options are
928 Connect to a listening VNC client via a ``reverse
'' connection
. The
929 client is specified by the @
var{display
}. For reverse network
930 connections (@
var{host
}:@
var{d
},@code
{reverse
}), the @
var{d
} argument
931 is a TCP port number
, not a display number
.
935 Require that password based authentication is used
for client connections
.
936 The password must be set separately
using the @code
{change
} command
in the
941 Require that client use TLS when communicating with the VNC server
. This
942 uses anonymous TLS credentials so is susceptible to a man
-in-the
-middle
943 attack
. It is recommended that
this option be combined with either the
944 @option
{x509
} or @option
{x509verify
} options
.
946 @item x509
=@
var{/path
/to
/certificate
/dir
}
948 Valid
if @option
{tls
} is specified
. Require that x509 credentials are used
949 for negotiating the TLS session
. The server will send its x509 certificate
950 to the client
. It is recommended that a password be set on the VNC server
951 to provide authentication of the client when
this is used
. The path following
952 this option specifies where the x509 certificates are to be loaded from
.
953 See the @ref
{vnc_security
} section
for details on generating certificates
.
955 @item x509verify
=@
var{/path
/to
/certificate
/dir
}
957 Valid
if @option
{tls
} is specified
. Require that x509 credentials are used
958 for negotiating the TLS session
. The server will send its x509 certificate
959 to the client
, and request that the client send its own x509 certificate
.
960 The server will validate the client
's certificate against the CA certificate,
961 and reject clients when validation fails. If the certificate authority is
962 trusted, this is a sufficient authentication mechanism. You may still wish
963 to set a password on the VNC server as a second authentication layer. The
964 path following this option specifies where the x509 certificates are to
965 be loaded from. See the @ref{vnc_security} section for details on generating
970 Require that the client use SASL to authenticate with the VNC server.
971 The exact choice of authentication method used is controlled from the
972 system / user's SASL configuration file
for the
'qemu' service
. This
973 is typically found
in /etc
/sasl2
/qemu
.conf
. If running QEMU as an
974 unprivileged user
, an environment variable SASL_CONF_PATH can be used
975 to make it search alternate locations
for the service config
.
976 While some SASL auth methods can also provide data
encryption (eg GSSAPI
),
977 it is recommended that SASL always be combined with the
'tls' and
978 'x509' settings to enable use of SSL and server certificates
. This
979 ensures a data encryption preventing compromise of authentication
980 credentials
. See the @ref
{vnc_security
} section
for details on
using
985 Turn on access control lists
for checking of the x509 client certificate
986 and SASL party
. For x509 certs
, the ACL check is made against the
987 certificate
's distinguished name. This is something that looks like
988 @code{C=GB,O=ACME,L=Boston,CN=bob}. For SASL party, the ACL check is
989 made against the username, which depending on the SASL plugin, may
990 include a realm component, eg @code{bob} or @code{bob@@EXAMPLE.COM}.
991 When the @option{acl} flag is set, the initial access list will be
992 empty, with a @code{deny} policy. Thus no one will be allowed to
993 use the VNC server until the ACLs have been loaded. This can be
994 achieved using the @code{acl} monitor command.
998 Enable lossy compression methods (gradient, JPEG, ...). If this
999 option is set, VNC client may receive lossy framebuffer updates
1000 depending on its encoding settings. Enabling this option can save
1001 a lot of bandwidth at the expense of quality.
1005 Disable adaptive encodings. Adaptive encodings are enabled by default.
1006 An adaptive encoding will try to detect frequently updated screen regions,
1007 and send updates in these regions using a lossy encoding (like JPEG).
1008 This can be really helpful to save bandwidth when playing videos. Disabling
1009 adaptive encodings allows to restore the original static behavior of encodings
1021 DEFHEADING(i386 target only:)
1026 DEF("win2k-hack", 0, QEMU_OPTION_win2k_hack,
1027 "-win2k-hack use it when installing Windows 2000 to avoid a disk full bug\n",
1032 Use it when installing Windows 2000 to avoid a disk full bug. After
1033 Windows 2000 is installed, you no longer need this option (this option
1034 slows down the IDE transfers).
1037 HXCOMM Deprecated by -rtc
1038 DEF("rtc-td-hack", 0, QEMU_OPTION_rtc_td_hack, "", QEMU_ARCH_I386)
1040 DEF("no-fd-bootchk", 0, QEMU_OPTION_no_fd_bootchk,
1041 "-no-fd-bootchk disable boot signature checking for floppy disks\n",
1044 @item -no-fd-bootchk
1045 @findex -no-fd-bootchk
1046 Disable boot signature checking for floppy disks in Bochs BIOS. It may
1047 be needed to boot from old floppy disks.
1048 TODO: check reference to Bochs BIOS.
1051 DEF("no-acpi", 0, QEMU_OPTION_no_acpi,
1052 "-no-acpi disable ACPI\n", QEMU_ARCH_I386)
1056 Disable ACPI (Advanced Configuration and Power Interface) support. Use
1057 it if your guest OS complains about ACPI problems (PC target machine
1061 DEF("no-hpet", 0, QEMU_OPTION_no_hpet,
1062 "-no-hpet disable HPET\n", QEMU_ARCH_I386)
1066 Disable HPET support.
1069 DEF("balloon", HAS_ARG, QEMU_OPTION_balloon,
1070 "-balloon none disable balloon device\n"
1071 "-balloon virtio[,addr=str]\n"
1072 " enable virtio balloon device (default)\n", QEMU_ARCH_ALL)
1076 Disable balloon device.
1077 @item -balloon virtio[,addr=@var{addr}]
1078 Enable virtio balloon device (default), optionally with PCI address
1082 DEF("acpitable", HAS_ARG, QEMU_OPTION_acpitable,
1083 "-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"
1084 " ACPI table description\n", QEMU_ARCH_I386)
1086 @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}]...]
1088 Add ACPI table with specified header fields and context from specified files.
1089 For file=, take whole ACPI table from the specified files, including all
1090 ACPI headers (possible overridden by other options).
1091 For data=, only data
1092 portion of the table is used, all header information is specified in the
1096 DEF("smbios", HAS_ARG, QEMU_OPTION_smbios,
1097 "-smbios file=binary\n"
1098 " load SMBIOS entry from binary file\n"
1099 "-smbios type=0[,vendor=str][,version=str][,date=str][,release=%d.%d]\n"
1100 " specify SMBIOS type 0 fields\n"
1101 "-smbios type=1[,manufacturer=str][,product=str][,version=str][,serial=str]\n"
1102 " [,uuid=uuid][,sku=str][,family=str]\n"
1103 " specify SMBIOS type 1 fields\n", QEMU_ARCH_I386)
1105 @item -smbios file=@var{binary}
1107 Load SMBIOS entry from binary file.
1109 @item -smbios type=0[,vendor=@var{str}][,version=@var{str}][,date=@var{str}][,release=@var{%d.%d}]
1111 Specify SMBIOS type 0 fields
1113 @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}]
1114 Specify SMBIOS type 1 fields
1122 DEFHEADING(Network options:)
1127 HXCOMM Legacy slirp options (now moved to -net user):
1129 DEF("tftp", HAS_ARG, QEMU_OPTION_tftp, "", QEMU_ARCH_ALL)
1130 DEF("bootp", HAS_ARG, QEMU_OPTION_bootp, "", QEMU_ARCH_ALL)
1131 DEF("redir", HAS_ARG, QEMU_OPTION_redir, "", QEMU_ARCH_ALL)
1133 DEF("smb", HAS_ARG, QEMU_OPTION_smb, "", QEMU_ARCH_ALL)
1137 DEF("net", HAS_ARG, QEMU_OPTION_net,
1138 "-net nic[,vlan=n][,macaddr=mac][,model=type][,name=str][,addr=str][,vectors=v]\n"
1139 " create a new Network Interface Card and connect it to VLAN 'n
'\n"
1141 "-net user[,vlan=n][,name=str][,net=addr[/mask]][,host=addr][,restrict=on|off]\n"
1142 " [,hostname=host][,dhcpstart=addr][,dns=addr][,tftp=dir][,bootfile=f]\n"
1143 " [,hostfwd=rule][,guestfwd=rule]"
1145 "[,smb=dir[,smbserver=addr]]\n"
1147 " connect the user mode network stack to VLAN 'n
', configure its\n"
1148 " DHCP server and enabled optional services\n"
1151 "-net tap[,vlan=n][,name=str],ifname=name\n"
1152 " connect the host TAP network interface to VLAN 'n
'\n"
1154 "-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"
1155 " connect the host TAP network interface to VLAN 'n
' and use the\n"
1156 " network scripts 'file
' (default=" DEFAULT_NETWORK_SCRIPT ")\n"
1157 " and 'dfile
' (default=" DEFAULT_NETWORK_DOWN_SCRIPT ")\n"
1158 " use '[down
]script
=no
' to disable script execution\n"
1159 " use 'fd
=h
' to connect to an already opened TAP interface\n"
1160 " use 'sndbuf
=nbytes
' to limit the size of the send buffer (the\n"
1161 " default is disabled 'sndbuf
=0' to enable flow control set 'sndbuf
=1048576')\n"
1162 " use vnet_hdr=off to avoid enabling the IFF_VNET_HDR tap flag\n"
1163 " use vnet_hdr=on to make the lack of IFF_VNET_HDR support an error condition\n"
1164 " use vhost=on to enable experimental in kernel accelerator\n"
1165 " (only has effect for virtio guests which use MSIX)\n"
1166 " use vhostforce=on to force vhost on for non-MSIX virtio guests\n"
1167 " use 'vhostfd
=h
' to connect to an already opened vhost net device\n"
1169 "-net socket[,vlan=n][,name=str][,fd=h][,listen=[host]:port][,connect=host:port]\n"
1170 " connect the vlan 'n
' to another VLAN using a socket connection\n"
1171 "-net socket[,vlan=n][,name=str][,fd=h][,mcast=maddr:port[,localaddr=addr]]\n"
1172 " connect the vlan 'n
' to multicast maddr and port\n"
1173 " use 'localaddr
=addr
' to specify the host address to send packets from\n"
1175 "-net vde[,vlan=n][,name=str][,sock=socketpath][,port=n][,group=groupname][,mode=octalmode]\n"
1176 " connect the vlan 'n
' to port 'n
' of a vde switch running\n"
1177 " on host and listening for incoming connections on 'socketpath
'.\n"
1178 " Use group 'groupname
' and mode 'octalmode
' to change default\n"
1179 " ownership and permissions for communication port.\n"
1181 "-net dump[,vlan=n][,file=f][,len=n]\n"
1182 " dump traffic on vlan 'n
' to file 'f
' (max n bytes per packet)\n"
1183 "-net none use it alone to have zero network devices. If no -net option\n"
1184 " is provided, the default is '-net nic
-net user
'\n", QEMU_ARCH_ALL)
1185 DEF("netdev", HAS_ARG, QEMU_OPTION_netdev,
1194 "socket],id=str[,option][,option][,...]\n", QEMU_ARCH_ALL)
1196 @item -net nic[,vlan=@var{n}][,macaddr=@var{mac}][,model=@var{type}] [,name=@var{name}][,addr=@var{addr}][,vectors=@var{v}]
1198 Create a new Network Interface Card and connect it to VLAN @var{n} (@var{n}
1199 = 0 is the default). The NIC is an e1000 by default on the PC
1200 target. Optionally, the MAC address can be changed to @var{mac}, the
1201 device address set to @var{addr} (PCI cards only),
1202 and a @var{name} can be assigned for use in monitor commands.
1203 Optionally, for PCI cards, you can specify the number @var{v} of MSI-X vectors
1204 that the card should have; this option currently only affects virtio cards; set
1205 @var{v} = 0 to disable MSI-X. If no @option{-net} option is specified, a single
1206 NIC is created. Qemu can emulate several different models of network card.
1207 Valid values for @var{type} are
1208 @code{virtio}, @code{i82551}, @code{i82557b}, @code{i82559er},
1209 @code{ne2k_pci}, @code{ne2k_isa}, @code{pcnet}, @code{rtl8139},
1210 @code{e1000}, @code{smc91c111}, @code{lance} and @code{mcf_fec}.
1211 Not all devices are supported on all targets. Use -net nic,model=?
1212 for a list of available devices for your target.
1214 @item -net user[,@var{option}][,@var{option}][,...]
1215 Use the user mode network stack which requires no administrator
1216 privilege to run. Valid options are:
1220 Connect user mode stack to VLAN @var{n} (@var{n} = 0 is the default).
1222 @item name=@var{name}
1223 Assign symbolic name for use in monitor commands.
1225 @item net=@var{addr}[/@var{mask}]
1226 Set IP network address the guest will see. Optionally specify the netmask,
1227 either in the form a.b.c.d or as number of valid top-most bits. Default is
1230 @item host=@var{addr}
1231 Specify the guest-visible address of the host. Default is the 2nd IP in the
1232 guest network, i.e. x.x.x.2.
1234 @item restrict=on|off
1235 If this option is enabled, the guest will be isolated, i.e. it will not be
1236 able to contact the host and no guest IP packets will be routed over the host
1237 to the outside. This option does not affect any explicitly set forwarding rules.
1239 @item hostname=@var{name}
1240 Specifies the client hostname reported by the builtin DHCP server.
1242 @item dhcpstart=@var{addr}
1243 Specify the first of the 16 IPs the built-in DHCP server can assign. Default
1244 is the 15th to 31st IP in the guest network, i.e. x.x.x.15 to x.x.x.31.
1246 @item dns=@var{addr}
1247 Specify the guest-visible address of the virtual nameserver. The address must
1248 be different from the host address. Default is the 3rd IP in the guest network,
1251 @item tftp=@var{dir}
1252 When using the user mode network stack, activate a built-in TFTP
1253 server. The files in @var{dir} will be exposed as the root of a TFTP server.
1254 The TFTP client on the guest must be configured in binary mode (use the command
1255 @code{bin} of the Unix TFTP client).
1257 @item bootfile=@var{file}
1258 When using the user mode network stack, broadcast @var{file} as the BOOTP
1259 filename. In conjunction with @option{tftp}, this can be used to network boot
1260 a guest from a local directory.
1262 Example (using pxelinux):
1264 qemu -hda linux.img -boot n -net user,tftp=/path/to/tftp/files,bootfile=/pxelinux.0
1267 @item smb=@var{dir}[,smbserver=@var{addr}]
1268 When using the user mode network stack, activate a built-in SMB
1269 server so that Windows OSes can access to the host files in @file{@var{dir}}
1270 transparently. The IP address of the SMB server can be set to @var{addr}. By
1271 default the 4th IP in the guest network is used, i.e. x.x.x.4.
1273 In the guest Windows OS, the line:
1277 must be added in the file @file{C:\WINDOWS\LMHOSTS} (for windows 9x/Me)
1278 or @file{C:\WINNT\SYSTEM32\DRIVERS\ETC\LMHOSTS} (Windows NT/2000).
1280 Then @file{@var{dir}} can be accessed in @file{\\smbserver\qemu}.
1282 Note that a SAMBA server must be installed on the host OS.
1283 QEMU was tested successfully with smbd versions from Red Hat 9,
1284 Fedora Core 3 and OpenSUSE 11.x.
1286 @item hostfwd=[tcp|udp]:[@var{hostaddr}]:@var{hostport}-[@var{guestaddr}]:@var{guestport}
1287 Redirect incoming TCP or UDP connections to the host port @var{hostport} to
1288 the guest IP address @var{guestaddr} on guest port @var{guestport}. If
1289 @var{guestaddr} is not specified, its value is x.x.x.15 (default first address
1290 given by the built-in DHCP server). By specifying @var{hostaddr}, the rule can
1291 be bound to a specific host interface. If no connection type is set, TCP is
1292 used. This option can be given multiple times.
1294 For example, to redirect host X11 connection from screen 1 to guest
1295 screen 0, use the following:
1299 qemu -net user,hostfwd=tcp:127.0.0.1:6001-:6000 [...]
1300 # this host xterm should open in the guest X11 server
1304 To redirect telnet connections from host port 5555 to telnet port on
1305 the guest, use the following:
1309 qemu -net user,hostfwd=tcp::5555-:23 [...]
1310 telnet localhost 5555
1313 Then when you use on the host @code{telnet localhost 5555}, you
1314 connect to the guest telnet server.
1316 @item guestfwd=[tcp]:@var{server}:@var{port}-@var{dev}
1317 Forward guest TCP connections to the IP address @var{server} on port @var{port}
1318 to the character device @var{dev}. This option can be given multiple times.
1322 Note: Legacy stand-alone options -tftp, -bootp, -smb and -redir are still
1323 processed and applied to -net user. Mixing them with the new configuration
1324 syntax gives undefined results. Their use for new applications is discouraged
1325 as they will be removed from future versions.
1327 @item -net tap[,vlan=@var{n}][,name=@var{name}][,fd=@var{h}][,ifname=@var{name}] [,script=@var{file}][,downscript=@var{dfile}]
1328 Connect the host TAP network interface @var{name} to VLAN @var{n}, use
1329 the network script @var{file} to configure it and the network script
1330 @var{dfile} to deconfigure it. If @var{name} is not provided, the OS
1331 automatically provides one. @option{fd}=@var{h} can be used to specify
1332 the handle of an already opened host TAP interface. The default network
1333 configure script is @file{/etc/qemu-ifup} and the default network
1334 deconfigure script is @file{/etc/qemu-ifdown}. Use @option{script=no}
1335 or @option{downscript=no} to disable script execution. Example:
1338 qemu linux.img -net nic -net tap
1341 More complicated example (two NICs, each one connected to a TAP device)
1343 qemu linux.img -net nic,vlan=0 -net tap,vlan=0,ifname=tap0 \
1344 -net nic,vlan=1 -net tap,vlan=1,ifname=tap1
1347 @item -net socket[,vlan=@var{n}][,name=@var{name}][,fd=@var{h}] [,listen=[@var{host}]:@var{port}][,connect=@var{host}:@var{port}]
1349 Connect the VLAN @var{n} to a remote VLAN in another QEMU virtual
1350 machine using a TCP socket connection. If @option{listen} is
1351 specified, QEMU waits for incoming connections on @var{port}
1352 (@var{host} is optional). @option{connect} is used to connect to
1353 another QEMU instance using the @option{listen} option. @option{fd}=@var{h}
1354 specifies an already opened TCP socket.
1358 # launch a first QEMU instance
1359 qemu linux.img -net nic,macaddr=52:54:00:12:34:56 \
1360 -net socket,listen=:1234
1361 # connect the VLAN 0 of this instance to the VLAN 0
1362 # of the first instance
1363 qemu linux.img -net nic,macaddr=52:54:00:12:34:57 \
1364 -net socket,connect=127.0.0.1:1234
1367 @item -net socket[,vlan=@var{n}][,name=@var{name}][,fd=@var{h}][,mcast=@var{maddr}:@var{port}[,localaddr=@var{addr}]]
1369 Create a VLAN @var{n} shared with another QEMU virtual
1370 machines using a UDP multicast socket, effectively making a bus for
1371 every QEMU with same multicast address @var{maddr} and @var{port}.
1375 Several QEMU can be running on different hosts and share same bus (assuming
1376 correct multicast setup for these hosts).
1378 mcast support is compatible with User Mode Linux (argument @option{eth@var{N}=mcast}), see
1379 @url{http://user-mode-linux.sf.net}.
1381 Use @option{fd=h} to specify an already opened UDP multicast socket.
1386 # launch one QEMU instance
1387 qemu linux.img -net nic,macaddr=52:54:00:12:34:56 \
1388 -net socket,mcast=230.0.0.1:1234
1389 # launch another QEMU instance on same "bus"
1390 qemu linux.img -net nic,macaddr=52:54:00:12:34:57 \
1391 -net socket,mcast=230.0.0.1:1234
1392 # launch yet another QEMU instance on same "bus"
1393 qemu linux.img -net nic,macaddr=52:54:00:12:34:58 \
1394 -net socket,mcast=230.0.0.1:1234
1397 Example (User Mode Linux compat.):
1399 # launch QEMU instance (note mcast address selected
1401 qemu linux
.img
-net nic
,macaddr
=52:54:00:12:34:56 \
1402 -net socket
,mcast
=239.192.168.1:1102
1404 /path
/to
/linux ubd0
=/path
/to
/root_fs eth0
=mcast
1407 Example (send packets from host
's 1.2.3.4):
1409 qemu linux.img -net nic,macaddr=52:54:00:12:34:56 \
1410 -net socket,mcast=239.192.168.1:1102,localaddr=1.2.3.4
1413 @item -net vde[,vlan=@var{n}][,name=@var{name}][,sock=@var{socketpath}] [,port=@var{n}][,group=@var{groupname}][,mode=@var{octalmode}]
1414 Connect VLAN @var{n} to PORT @var{n} of a vde switch running on host and
1415 listening for incoming connections on @var{socketpath}. Use GROUP @var{groupname}
1416 and MODE @var{octalmode} to change default ownership and permissions for
1417 communication port. This option is available only if QEMU has been compiled
1418 with vde support enabled.
1423 vde_switch -F -sock /tmp/myswitch
1424 # launch QEMU instance
1425 qemu linux.img -net nic -net vde,sock=/tmp/myswitch
1428 @item -net dump[,vlan=@var{n}][,file=@var{file}][,len=@var{len}]
1429 Dump network traffic on VLAN @var{n} to file @var{file} (@file{qemu-vlan0.pcap} by default).
1430 At most @var{len} bytes (64k by default) per packet are stored. The file format is
1431 libpcap, so it can be analyzed with tools such as tcpdump or Wireshark.
1434 Indicate that no network devices should be configured. It is used to
1435 override the default configuration (@option{-net nic -net user}) which
1436 is activated if no @option{-net} options are provided.
1443 DEFHEADING(Character device options:)
1445 DEF("chardev", HAS_ARG, QEMU_OPTION_chardev,
1446 "-chardev null,id=id[,mux=on|off]\n"
1447 "-chardev socket,id=id[,host=host],port=host[,to=to][,ipv4][,ipv6][,nodelay]\n"
1448 " [,server][,nowait][,telnet][,mux=on|off] (tcp)\n"
1449 "-chardev socket,id=id,path=path[,server][,nowait][,telnet],[mux=on|off] (unix)\n"
1450 "-chardev udp,id=id[,host=host],port=port[,localaddr=localaddr]\n"
1451 " [,localport=localport][,ipv4][,ipv6][,mux=on|off]\n"
1452 "-chardev msmouse,id=id[,mux=on|off]\n"
1453 "-chardev vc,id=id[[,width=width][,height=height]][[,cols=cols][,rows=rows]]\n"
1455 "-chardev file,id=id,path=path[,mux=on|off]\n"
1456 "-chardev pipe,id=id,path=path[,mux=on|off]\n"
1458 "-chardev console,id=id[,mux=on|off]\n"
1459 "-chardev serial,id=id,path=path[,mux=on|off]\n"
1461 "-chardev pty,id=id[,mux=on|off]\n"
1462 "-chardev stdio,id=id[,mux=on|off][,signal=on|off]\n"
1464 #ifdef CONFIG_BRLAPI
1465 "-chardev braille,id=id[,mux=on|off]\n"
1467 #if defined(__linux__) || defined(__sun__) || defined(__FreeBSD__) \
1468 || defined(__NetBSD__) || defined(__OpenBSD__) || defined(__DragonFly__)
1469 "-chardev tty,id=id,path=path[,mux=on|off]\n"
1471 #if defined(__linux__) || defined(__FreeBSD__) || defined(__DragonFly__)
1472 "-chardev parport,id=id,path=path[,mux=on|off]\n"
1474 #if defined(CONFIG_SPICE)
1475 "-chardev spicevmc,id=id,name=name[,debug=debug]\n"
1482 The general form of a character device option is:
1485 @item -chardev @var{backend} ,id=@var{id} [,mux=on|off] [,@var{options}]
1503 The specific backend will determine the applicable options.
1505 All devices must have an id, which can be any string up to 127 characters long.
1506 It is used to uniquely identify this device in other command line directives.
1508 A character device may be used in multiplexing mode by multiple front-ends.
1509 The key sequence of @key{Control-a} and @key{c} will rotate the input focus
1510 between attached front-ends. Specify @option{mux=on} to enable this mode.
1512 Options to each backend are described below.
1514 @item -chardev null ,id=@var{id}
1515 A void device. This device will not emit any data, and will drop any data it
1516 receives. The null backend does not take any options.
1518 @item -chardev socket ,id=@var{id} [@var{TCP options} or @var{unix options}] [,server] [,nowait] [,telnet]
1520 Create a two-way stream socket, which can be either a TCP or a unix socket. A
1521 unix socket will be created if @option{path} is specified. Behaviour is
1522 undefined if TCP options are specified for a unix socket.
1524 @option{server} specifies that the socket shall be a listening socket.
1526 @option{nowait} specifies that QEMU should not block waiting for a client to
1527 connect to a listening socket.
1529 @option{telnet} specifies that traffic on the socket should interpret telnet
1532 TCP and unix socket options are given below:
1536 @item TCP options: port=@var{port} [,host=@var{host}] [,to=@var{to}] [,ipv4] [,ipv6] [,nodelay]
1538 @option{host} for a listening socket specifies the local address to be bound.
1539 For a connecting socket species the remote host to connect to. @option{host} is
1540 optional for listening sockets. If not specified it defaults to @code{0.0.0.0}.
1542 @option{port} for a listening socket specifies the local port to be bound. For a
1543 connecting socket specifies the port on the remote host to connect to.
1544 @option{port} can be given as either a port number or a service name.
1545 @option{port} is required.
1547 @option{to} is only relevant to listening sockets. If it is specified, and
1548 @option{port} cannot be bound, QEMU will attempt to bind to subsequent ports up
1549 to and including @option{to} until it succeeds. @option{to} must be specified
1552 @option{ipv4} and @option{ipv6} specify that either IPv4 or IPv6 must be used.
1553 If neither is specified the socket may use either protocol.
1555 @option{nodelay} disables the Nagle algorithm.
1557 @item unix options: path=@var{path}
1559 @option{path} specifies the local path of the unix socket. @option{path} is
1564 @item -chardev udp ,id=@var{id} [,host=@var{host}] ,port=@var{port} [,localaddr=@var{localaddr}] [,localport=@var{localport}] [,ipv4] [,ipv6]
1566 Sends all traffic from the guest to a remote host over UDP.
1568 @option{host} specifies the remote host to connect to. If not specified it
1569 defaults to @code{localhost}.
1571 @option{port} specifies the port on the remote host to connect to. @option{port}
1574 @option{localaddr} specifies the local address to bind to. If not specified it
1575 defaults to @code{0.0.0.0}.
1577 @option{localport} specifies the local port to bind to. If not specified any
1578 available local port will be used.
1580 @option{ipv4} and @option{ipv6} specify that either IPv4 or IPv6 must be used.
1581 If neither is specified the device may use either protocol.
1583 @item -chardev msmouse ,id=@var{id}
1585 Forward QEMU's emulated msmouse events to the guest
. @option
{msmouse
} does not
1588 @item
-chardev vc
,id
=@
var{id
} [[,width
=@
var{width
}] [,height
=@
var{height
}]] [[,cols
=@
var{cols
}] [,rows
=@
var{rows
}]]
1590 Connect to a QEMU text console
. @option
{vc
} may optionally be given a specific
1593 @option
{width
} and @option
{height
} specify the width and height respectively of
1594 the console
, in pixels
.
1596 @option
{cols
} and @option
{rows
} specify that the console be sized to fit a text
1597 console with the given dimensions
.
1599 @item
-chardev file
,id
=@
var{id
} ,path
=@
var{path
}
1601 Log all traffic received from the guest to a file
.
1603 @option
{path
} specifies the path of the file to be opened
. This file will be
1604 created
if it does not already exist
, and overwritten
if it does
. @option
{path
}
1607 @item
-chardev pipe
,id
=@
var{id
} ,path
=@
var{path
}
1609 Create a two
-way connection to the guest
. The behaviour differs slightly between
1610 Windows hosts and other hosts
:
1612 On Windows
, a single duplex pipe will be created at
1613 @file
{\\.pipe\@option
{path
}}.
1615 On other hosts
, 2 pipes will be created called @file
{@option
{path
}.in} and
1616 @file
{@option
{path
}.out
}. Data written to @file
{@option
{path
}.in} will be
1617 received by the guest
. Data written by the guest can be read from
1618 @file
{@option
{path
}.out
}. QEMU will not create these fifos
, and requires them to
1621 @option
{path
} forms part of the pipe path as described above
. @option
{path
} is
1624 @item
-chardev console
,id
=@
var{id
}
1626 Send traffic from the guest to QEMU
's standard output. @option{console} does not
1629 @option{console} is only available on Windows hosts.
1631 @item -chardev serial ,id=@var{id} ,path=@option{path}
1633 Send traffic from the guest to a serial device on the host.
1636 only available on Windows hosts.
1638 @option{path} specifies the name of the serial device to open.
1640 @item -chardev pty ,id=@var{id}
1642 Create a new pseudo-terminal on the host and connect to it. @option{pty} does
1643 not take any options.
1645 @option{pty} is not available on Windows hosts.
1647 @item -chardev stdio ,id=@var{id} [,signal=on|off]
1648 Connect to standard input and standard output of the qemu process.
1650 @option{signal} controls if signals are enabled on the terminal, that includes
1651 exiting QEMU with the key sequence @key{Control-c}. This option is enabled by
1652 default, use @option{signal=off} to disable it.
1654 @option{stdio} is not available on Windows hosts.
1656 @item -chardev braille ,id=@var{id}
1658 Connect to a local BrlAPI server. @option{braille} does not take any options.
1660 @item -chardev tty ,id=@var{id} ,path=@var{path}
1662 Connect to a local tty device.
1664 @option{tty} is only available on Linux, Sun, FreeBSD, NetBSD, OpenBSD and
1667 @option{path} specifies the path to the tty. @option{path} is required.
1669 @item -chardev parport ,id=@var{id} ,path=@var{path}
1671 @option{parport} is only available on Linux, FreeBSD and DragonFlyBSD hosts.
1673 Connect to a local parallel port.
1675 @option{path} specifies the path to the parallel port device. @option{path} is
1678 #if defined(CONFIG_SPICE)
1679 @item -chardev spicevmc ,id=@var{id} ,debug=@var{debug}, name=@var{name}
1681 @option{debug} debug level for spicevmc
1683 @option{name} name of spice channel to connect to
1685 Connect to a spice virtual machine channel, such as vdiport.
1693 DEFHEADING(Bluetooth(R) options:)
1695 DEF("bt", HAS_ARG, QEMU_OPTION_bt, \
1696 "-bt hci,null dumb bluetooth HCI - doesn't respond to commands
\n" \
1697 "-bt hci
,host
[:id
]\n" \
1698 " use host
's HCI with the given name\n" \
1699 "-bt hci[,vlan=n]\n" \
1700 " emulate a standard HCI in virtual scatternet 'n
'\n" \
1701 "-bt vhci[,vlan=n]\n" \
1702 " add host computer to virtual scatternet 'n
' using VHCI\n" \
1703 "-bt device:dev[,vlan=n]\n" \
1704 " emulate a bluetooth device 'dev
' in scatternet 'n
'\n",
1711 Defines the function of the corresponding Bluetooth HCI. -bt options
1712 are matched with the HCIs present in the chosen machine type. For
1713 example when emulating a machine with only one HCI built into it, only
1714 the first @code{-bt hci[...]} option is valid and defines the HCI's
1715 logic
. The Transport Layer is decided by the machine type
. Currently
1716 the machines @code
{n800
} and @code
{n810
} have one HCI and all other
1720 The following three types are recognized
:
1724 (default) The corresponding Bluetooth HCI assumes no internal logic
1725 and will not respond to any HCI commands or emit events
.
1727 @item
-bt hci
,host
[:@
var{id
}]
1728 (@code
{bluez
} only
) The corresponding HCI passes commands
/ events
1729 to
/ from the physical HCI identified by the name @
var{id
} (default:
1730 @code
{hci0
}) on the computer running QEMU
. Only available on @code
{bluez
}
1731 capable systems like Linux
.
1733 @item
-bt hci
[,vlan
=@
var{n
}]
1734 Add a virtual
, standard HCI that will participate
in the Bluetooth
1735 scatternet @
var{n
} (default @code
{0}). Similarly to @option
{-net
}
1736 VLANs
, devices inside a bluetooth network @
var{n
} can only communicate
1737 with other devices
in the same
network (scatternet
).
1740 @item
-bt vhci
[,vlan
=@
var{n
}]
1741 (Linux
-host only
) Create a HCI
in scatternet @
var{n
} (default 0) attached
1742 to the host bluetooth stack instead of to the emulated target
. This
1743 allows the host and target machines to participate
in a common scatternet
1744 and communicate
. Requires the Linux @code
{vhci
} driver installed
. Can
1745 be used as following
:
1748 qemu
[...OPTIONS
...] -bt hci
,vlan
=5 -bt vhci
,vlan
=5
1751 @item
-bt device
:@
var{dev
}[,vlan
=@
var{n
}]
1752 Emulate a bluetooth device @
var{dev
} and place it
in network @
var{n
}
1753 (default @code
{0}). QEMU can only emulate one type of bluetooth devices
1758 Virtual wireless keyboard implementing the HIDP bluetooth profile
.
1765 DEFHEADING(Linux
/Multiboot boot specific
:)
1768 When
using these options
, you can use a given Linux or Multiboot
1769 kernel without installing it
in the disk image
. It can be useful
1770 for easier testing of various kernels
.
1775 DEF("kernel", HAS_ARG
, QEMU_OPTION_kernel
, \
1776 "-kernel bzImage use 'bzImage' as kernel image\n", QEMU_ARCH_ALL
)
1778 @item
-kernel @
var{bzImage
}
1780 Use @
var{bzImage
} as kernel image
. The kernel can be either a Linux kernel
1781 or
in multiboot format
.
1784 DEF("append", HAS_ARG
, QEMU_OPTION_append
, \
1785 "-append cmdline use 'cmdline' as kernel command line\n", QEMU_ARCH_ALL
)
1787 @item
-append @
var{cmdline
}
1789 Use @
var{cmdline
} as kernel command line
1792 DEF("initrd", HAS_ARG
, QEMU_OPTION_initrd
, \
1793 "-initrd file use 'file' as initial ram disk\n", QEMU_ARCH_ALL
)
1795 @item
-initrd @
var{file
}
1797 Use @
var{file
} as initial ram disk
.
1799 @item
-initrd
"@var{file1} arg=foo,@var{file2}"
1801 This syntax is only available with multiboot
.
1803 Use @
var{file1
} and @
var{file2
} as modules and pass arg
=foo as parameter to the
1813 DEFHEADING(Debug
/Expert options
:)
1819 DEF("serial", HAS_ARG
, QEMU_OPTION_serial
, \
1820 "-serial dev redirect the serial port to char device 'dev'\n",
1823 @item
-serial @
var{dev
}
1825 Redirect the virtual serial port to host character device
1826 @
var{dev
}. The
default device is @code
{vc
} in graphical mode and
1827 @code
{stdio
} in non graphical mode
.
1829 This option can be used several times to simulate up to
4 serial
1832 Use @code
{-serial none
} to disable all serial ports
.
1834 Available character devices are
:
1836 @item vc
[:@
var{W
}x@
var{H
}]
1837 Virtual console
. Optionally
, a width and height can be given
in pixel with
1841 It is also possible to specify width or height
in characters
:
1846 [Linux only
] Pseudo
TTY (a
new PTY is automatically allocated
)
1848 No device is allocated
.
1852 [Linux only
] Use host tty
, e
.g
. @file
{/dev
/ttyS0
}. The host serial port
1853 parameters are set according to the emulated ones
.
1854 @item
/dev
/parport@
var{N
}
1855 [Linux only
, parallel port only
] Use host parallel port
1856 @
var{N
}. Currently SPP and EPP parallel port features can be used
.
1857 @item file
:@
var{filename
}
1858 Write output to @
var{filename
}. No character can be read
.
1860 [Unix only
] standard input
/output
1861 @item pipe
:@
var{filename
}
1862 name pipe @
var{filename
}
1864 [Windows only
] Use host serial port @
var{n
}
1865 @item udp
:[@
var{remote_host
}]:@
var{remote_port
}[@@
[@
var{src_ip
}]:@
var{src_port
}]
1866 This
implements UDP Net Console
.
1867 When @
var{remote_host
} or @
var{src_ip
} are not specified
1868 they
default to @code
{0.0.0.0}.
1869 When not
using a specified @
var{src_port
} a random port is automatically chosen
.
1871 If you just want a simple readonly console you can use @code
{netcat
} or
1872 @code
{nc
}, by starting qemu with
: @code
{-serial udp
::4555} and nc as
:
1873 @code
{nc
-u
-l
-p
4555}. Any time qemu writes something to that port it
1874 will appear
in the netconsole session
.
1876 If you plan to send characters back via netconsole or you want to stop
1877 and start qemu a lot of times
, you should have qemu use the same
1878 source port each time by
using something like @code
{-serial
1879 udp
::4555@@
:4556} to qemu
. Another approach is to use a patched
1880 version of netcat which can listen to a TCP port and send and receive
1881 characters via udp
. If you have a patched version of netcat which
1882 activates telnet remote echo and single char transfer
, then you can
1883 use the following options to step up a netcat redirector to allow
1884 telnet on port
5555 to access the qemu port
.
1887 -serial udp
::4555@@
:4556
1888 @item netcat options
:
1889 -u
-P
4555 -L
0.0.0.0:4556 -t
-p
5555 -I
-T
1890 @item telnet options
:
1894 @item tcp
:[@
var{host
}]:@
var{port
}[,@
var{server
}][,nowait
][,nodelay
]
1895 The TCP Net Console has two modes of operation
. It can send the serial
1896 I
/O to a location or wait
for a connection from a location
. By
default
1897 the TCP Net Console is sent to @
var{host
} at the @
var{port
}. If you use
1898 the @
var{server
} option QEMU will wait
for a client socket application
1899 to connect to the port before continuing
, unless the @code
{nowait
}
1900 option was specified
. The @code
{nodelay
} option disables the Nagle buffering
1901 algorithm
. If @
var{host
} is omitted
, 0.0.0.0 is assumed
. Only
1902 one TCP connection at a time is accepted
. You can use @code
{telnet
} to
1903 connect to the corresponding character device
.
1905 @item Example to send tcp console to
192.168.0.2 port
4444
1906 -serial tcp
:192.168.0.2:4444
1907 @item Example to listen and wait on port
4444 for connection
1908 -serial tcp
::4444,server
1909 @item Example to not wait and listen on ip
192.168.0.100 port
4444
1910 -serial tcp
:192.168.0.100:4444,server
,nowait
1913 @item telnet
:@
var{host
}:@
var{port
}[,server
][,nowait
][,nodelay
]
1914 The telnet protocol is used instead of raw tcp sockets
. The options
1915 work the same as
if you had specified @code
{-serial tcp
}. The
1916 difference is that the port acts like a telnet server or client
using
1917 telnet option negotiation
. This will also allow you to send the
1918 MAGIC_SYSRQ sequence
if you use a telnet that supports sending the
break
1919 sequence
. Typically
in unix telnet you
do it with Control
-] and then
1920 type
"send break" followed by pressing the enter key
.
1922 @item unix
:@
var{path
}[,server
][,nowait
]
1923 A unix domain socket is used instead of a tcp socket
. The option works the
1924 same as
if you had specified @code
{-serial tcp
} except the unix domain socket
1925 @
var{path
} is used
for connections
.
1927 @item mon
:@
var{dev_string
}
1928 This is a special option to allow the monitor to be multiplexed onto
1929 another serial port
. The monitor is accessed with key sequence of
1930 @key
{Control
-a
} and then pressing @key
{c
}. See monitor access
1931 @ref
{pcsys_keys
} in the
-nographic section
for more keys
.
1932 @
var{dev_string
} should be any one of the serial devices specified
1933 above
. An example to multiplex the monitor onto a telnet server
1934 listening on port
4444 would be
:
1936 @item
-serial mon
:telnet
::4444,server
,nowait
1940 Braille device
. This will use BrlAPI to display the braille output on a real
1944 Three button serial mouse
. Configure the guest to use Microsoft protocol
.
1948 DEF("parallel", HAS_ARG
, QEMU_OPTION_parallel
, \
1949 "-parallel dev redirect the parallel port to char device 'dev'\n",
1952 @item
-parallel @
var{dev
}
1954 Redirect the virtual parallel port to host device @
var{dev
} (same
1955 devices as the serial port
). On Linux hosts
, @file
{/dev
/parportN
} can
1956 be used to use hardware devices connected on the corresponding host
1959 This option can be used several times to simulate up to
3 parallel
1962 Use @code
{-parallel none
} to disable all parallel ports
.
1965 DEF("monitor", HAS_ARG
, QEMU_OPTION_monitor
, \
1966 "-monitor dev redirect the monitor to char device 'dev'\n",
1969 @item
-monitor @
var{dev
}
1971 Redirect the monitor to host device @
var{dev
} (same devices as the
1973 The
default device is @code
{vc
} in graphical mode and @code
{stdio
} in
1976 DEF("qmp", HAS_ARG
, QEMU_OPTION_qmp
, \
1977 "-qmp dev like -monitor but opens in 'control' mode\n",
1980 @item
-qmp @
var{dev
}
1982 Like
-monitor but opens
in 'control' mode
.
1985 DEF("mon", HAS_ARG
, QEMU_OPTION_mon
, \
1986 "-mon chardev=[name][,mode=readline|control][,default]\n", QEMU_ARCH_ALL
)
1988 @item
-mon chardev
=[name
][,mode
=readline|control
][,default]
1990 Setup monitor on chardev @
var{name
}.
1993 DEF("debugcon", HAS_ARG
, QEMU_OPTION_debugcon
, \
1994 "-debugcon dev redirect the debug console to char device 'dev'\n",
1997 @item
-debugcon @
var{dev
}
1999 Redirect the debug console to host device @
var{dev
} (same devices as the
2000 serial port
). The debug console is an I
/O port which is typically port
2001 0xe9; writing to that I
/O port sends output to
this device
.
2002 The
default device is @code
{vc
} in graphical mode and @code
{stdio
} in
2006 DEF("pidfile", HAS_ARG
, QEMU_OPTION_pidfile
, \
2007 "-pidfile file write PID to 'file'\n", QEMU_ARCH_ALL
)
2009 @item
-pidfile @
var{file
}
2011 Store the QEMU process PID
in @
var{file
}. It is useful
if you launch QEMU
2015 DEF("singlestep", 0, QEMU_OPTION_singlestep
, \
2016 "-singlestep always run in singlestep mode\n", QEMU_ARCH_ALL
)
2020 Run the emulation
in single step mode
.
2023 DEF("S", 0, QEMU_OPTION_S
, \
2024 "-S freeze CPU at startup (use 'c' to start execution)\n",
2029 Do not start CPU at
startup (you must type
'c' in the monitor
).
2032 DEF("gdb", HAS_ARG
, QEMU_OPTION_gdb
, \
2033 "-gdb dev wait for gdb connection on 'dev'\n", QEMU_ARCH_ALL
)
2035 @item
-gdb @
var{dev
}
2037 Wait
for gdb connection on device @
var{dev
} (@pxref
{gdb_usage
}). Typical
2038 connections will likely be TCP
-based
, but also UDP
, pseudo TTY
, or even
2039 stdio are reasonable use
case. The latter is allowing to start qemu from
2040 within gdb and establish the connection via a pipe
:
2042 (gdb
) target remote | exec qemu
-gdb stdio
...
2046 DEF("s", 0, QEMU_OPTION_s
, \
2047 "-s shorthand for -gdb tcp::" DEFAULT_GDBSTUB_PORT
"\n",
2052 Shorthand
for -gdb tcp
::1234, i
.e
. open a gdbserver on TCP port
1234
2053 (@pxref
{gdb_usage
}).
2056 DEF("d", HAS_ARG
, QEMU_OPTION_d
, \
2057 "-d item1,... output log to /tmp/qemu.log (use -d ? for a list of log items)\n",
2062 Output log
in /tmp
/qemu
.log
2065 DEF("D", HAS_ARG
, QEMU_OPTION_D
, \
2066 "-D logfile output log to logfile (instead of the default /tmp/qemu.log)\n",
2071 Output log
in logfile instead of
/tmp
/qemu
.log
2074 DEF("hdachs", HAS_ARG
, QEMU_OPTION_hdachs
, \
2075 "-hdachs c,h,s[,t]\n" \
2076 " force hard disk 0 physical geometry and the optional BIOS\n" \
2077 " translation (t=none or lba) (usually qemu can guess them)\n",
2080 @item
-hdachs @
var{c
},@
var{h
},@
var{s
},[,@
var{t
}]
2082 Force hard disk
0 physical
geometry (1 <= @
var{c
} <= 16383, 1 <=
2083 @
var{h
} <= 16, 1 <= @
var{s
} <= 63) and optionally force the BIOS
2084 translation
mode (@
var{t
}=none
, lba or auto
). Usually QEMU can guess
2085 all those parameters
. This option is useful
for old MS
-DOS disk
2089 DEF("L", HAS_ARG
, QEMU_OPTION_L
, \
2090 "-L path set the directory for the BIOS, VGA BIOS and keymaps\n",
2095 Set the directory
for the BIOS
, VGA BIOS and keymaps
.
2098 DEF("bios", HAS_ARG
, QEMU_OPTION_bios
, \
2099 "-bios file set the filename for the BIOS\n", QEMU_ARCH_ALL
)
2101 @item
-bios @
var{file
}
2103 Set the filename
for the BIOS
.
2106 DEF("enable-kvm", 0, QEMU_OPTION_enable_kvm
, \
2107 "-enable-kvm enable KVM full virtualization support\n", QEMU_ARCH_ALL
)
2111 Enable KVM full virtualization support
. This option is only available
2112 if KVM support is enabled when compiling
.
2115 DEF("xen-domid", HAS_ARG
, QEMU_OPTION_xen_domid
,
2116 "-xen-domid id specify xen guest domain id\n", QEMU_ARCH_ALL
)
2117 DEF("xen-create", 0, QEMU_OPTION_xen_create
,
2118 "-xen-create create domain using xen hypercalls, bypassing xend\n"
2119 " warning: should not be used when xend is in use\n",
2121 DEF("xen-attach", 0, QEMU_OPTION_xen_attach
,
2122 "-xen-attach attach to existing xen domain\n"
2123 " xend will use this when starting qemu\n",
2126 @item
-xen
-domid @
var{id
}
2128 Specify xen guest domain @
var{id
} (XEN only
).
2131 Create domain
using xen hypercalls
, bypassing xend
.
2132 Warning
: should not be used when xend is
in use (XEN only
).
2135 Attach to existing xen domain
.
2136 xend will use
this when starting
qemu (XEN only
).
2139 DEF("no-reboot", 0, QEMU_OPTION_no_reboot
, \
2140 "-no-reboot exit instead of rebooting\n", QEMU_ARCH_ALL
)
2144 Exit instead of rebooting
.
2147 DEF("no-shutdown", 0, QEMU_OPTION_no_shutdown
, \
2148 "-no-shutdown stop before shutdown\n", QEMU_ARCH_ALL
)
2151 @findex
-no
-shutdown
2152 Don
't exit QEMU on guest shutdown, but instead only stop the emulation.
2153 This allows for instance switching to monitor to commit changes to the
2157 DEF("loadvm", HAS_ARG, QEMU_OPTION_loadvm, \
2158 "-loadvm [tag|id]\n" \
2159 " start right away with a saved state (loadvm in monitor)\n",
2162 @item -loadvm @var{file}
2164 Start right away with a saved state (@code{loadvm} in monitor)
2168 DEF("daemonize", 0, QEMU_OPTION_daemonize, \
2169 "-daemonize daemonize QEMU after initializing\n", QEMU_ARCH_ALL)
2174 Daemonize the QEMU process after initialization. QEMU will not detach from
2175 standard IO until it is ready to receive connections on any of its devices.
2176 This option is a useful way for external programs to launch QEMU without having
2177 to cope with initialization race conditions.
2180 DEF("option-rom", HAS_ARG, QEMU_OPTION_option_rom, \
2181 "-option-rom rom load a file, rom, into the option ROM space\n",
2184 @item -option-rom @var{file}
2186 Load the contents of @var{file} as an option ROM.
2187 This option is useful to load things like EtherBoot.
2190 DEF("clock", HAS_ARG, QEMU_OPTION_clock, \
2191 "-clock force the use of the given methods for timer alarm.\n" \
2192 " To see what timers are available use -clock ?\n",
2195 @item -clock @var{method}
2197 Force the use of the given methods for timer alarm. To see what timers
2198 are available use -clock ?.
2201 HXCOMM Options deprecated by -rtc
2202 DEF("localtime", 0, QEMU_OPTION_localtime, "", QEMU_ARCH_ALL)
2203 DEF("startdate", HAS_ARG, QEMU_OPTION_startdate, "", QEMU_ARCH_ALL)
2205 DEF("rtc", HAS_ARG, QEMU_OPTION_rtc, \
2206 "-rtc [base=utc|localtime|date][,clock=host|vm][,driftfix=none|slew]\n" \
2207 " set the RTC base and clock, enable drift fix for clock ticks (x86 only)\n",
2212 @item -rtc [base=utc|localtime|@var{date}][,clock=host|vm][,driftfix=none|slew]
2214 Specify @option{base} as @code{utc} or @code{localtime} to let the RTC start at the current
2215 UTC or local time, respectively. @code{localtime} is required for correct date in
2216 MS-DOS or Windows. To start at a specific point in time, provide @var{date} in the
2217 format @code{2006-06-17T16:01:21} or @code{2006-06-17}. The default base is UTC.
2219 By default the RTC is driven by the host system time. This allows to use the
2220 RTC as accurate reference clock inside the guest, specifically if the host
2221 time is smoothly following an accurate external reference clock, e.g. via NTP.
2222 If you want to isolate the guest time from the host, even prevent it from
2223 progressing during suspension, you can set @option{clock} to @code{vm} instead.
2225 Enable @option{driftfix} (i386 targets only) if you experience time drift problems,
2226 specifically with Windows' ACPI HAL
. This option will
try to figure out how
2227 many timer interrupts were not processed by the Windows guest and will
2231 DEF("icount", HAS_ARG
, QEMU_OPTION_icount
, \
2232 "-icount [N|auto]\n" \
2233 " enable virtual instruction counter with 2^N clock ticks per\n" \
2234 " instruction\n", QEMU_ARCH_ALL
)
2236 @item
-icount
[@
var{N
}|auto
]
2238 Enable virtual instruction counter
. The virtual cpu will execute one
2239 instruction every
2^@
var{N
} ns of virtual time
. If @code
{auto
} is specified
2240 then the virtual cpu speed will be automatically adjusted to keep virtual
2241 time within a few seconds of real time
.
2243 Note that
while this option can give deterministic behavior
, it does not
2244 provide cycle accurate emulation
. Modern CPUs contain superscalar out of
2245 order cores with complex cache hierarchies
. The number of instructions
2246 executed often has little or no correlation with actual performance
.
2249 DEF("watchdog", HAS_ARG
, QEMU_OPTION_watchdog
, \
2250 "-watchdog i6300esb|ib700\n" \
2251 " enable virtual hardware watchdog [default=none]\n",
2254 @item
-watchdog @
var{model
}
2256 Create a virtual hardware watchdog device
. Once
enabled (by a guest
2257 action
), the watchdog must be periodically polled by an agent inside
2258 the guest or
else the guest will be restarted
.
2260 The @
var{model
} is the model of hardware watchdog to emulate
. Choices
2261 for model are
: @code
{ib700
} (iBASE
700) which is a very simple ISA
2262 watchdog with a single timer
, or @code
{i6300esb
} (Intel
6300ESB I
/O
2263 controller hub
) which is a much more featureful PCI
-based dual
-timer
2264 watchdog
. Choose a model
for which your guest has drivers
.
2266 Use @code
{-watchdog ?
} to list available hardware models
. Only one
2267 watchdog can be enabled
for a guest
.
2270 DEF("watchdog-action", HAS_ARG
, QEMU_OPTION_watchdog_action
, \
2271 "-watchdog-action reset|shutdown|poweroff|pause|debug|none\n" \
2272 " action when watchdog fires [default=reset]\n",
2275 @item
-watchdog
-action @
var{action
}
2277 The @
var{action
} controls what QEMU will
do when the watchdog timer
2280 @code
{reset
} (forcefully reset the guest
).
2281 Other possible actions are
:
2282 @code
{shutdown
} (attempt to gracefully shutdown the guest
),
2283 @code
{poweroff
} (forcefully poweroff the guest
),
2284 @code
{pause
} (pause the guest
),
2285 @code
{debug
} (print a debug message and
continue), or
2286 @code
{none
} (do nothing
).
2288 Note that the @code
{shutdown
} action requires that the guest responds
2289 to ACPI signals
, which it may not be able to
do in the sort of
2290 situations where the watchdog would have expired
, and thus
2291 @code
{-watchdog
-action shutdown
} is not recommended
for production use
.
2296 @item
-watchdog i6300esb
-watchdog
-action pause
2297 @item
-watchdog ib700
2301 DEF("echr", HAS_ARG
, QEMU_OPTION_echr
, \
2302 "-echr chr set terminal escape character instead of ctrl-a\n",
2306 @item
-echr @
var{numeric_ascii_value
}
2308 Change the escape character used
for switching to the monitor when
using
2309 monitor and serial sharing
. The
default is @code
{0x01} when
using the
2310 @code
{-nographic
} option
. @code
{0x01} is equal to pressing
2311 @code
{Control
-a
}. You can select a different character from the ascii
2312 control keys where
1 through
26 map to Control
-a through Control
-z
. For
2313 instance you could use the either of the following to change the escape
2314 character to Control
-t
.
2321 DEF("virtioconsole", HAS_ARG
, QEMU_OPTION_virtiocon
, \
2322 "-virtioconsole c\n" \
2323 " set virtio console\n", QEMU_ARCH_ALL
)
2325 @item
-virtioconsole @
var{c
}
2326 @findex
-virtioconsole
2329 This option is maintained
for backward compatibility
.
2331 Please use @code
{-device virtconsole
} for the
new way of invocation
.
2334 DEF("show-cursor", 0, QEMU_OPTION_show_cursor
, \
2335 "-show-cursor show cursor\n", QEMU_ARCH_ALL
)
2338 @findex
-show
-cursor
2342 DEF("tb-size", HAS_ARG
, QEMU_OPTION_tb_size
, \
2343 "-tb-size n set TB size\n", QEMU_ARCH_ALL
)
2345 @item
-tb
-size @
var{n
}
2350 DEF("incoming", HAS_ARG
, QEMU_OPTION_incoming
, \
2351 "-incoming p prepare for incoming migration, listen on port p\n",
2354 @item
-incoming @
var{port
}
2356 Prepare
for incoming migration
, listen on @
var{port
}.
2359 DEF("nodefaults", 0, QEMU_OPTION_nodefaults
, \
2360 "-nodefaults don't create default devices\n", QEMU_ARCH_ALL
)
2364 Don
't create default devices.
2368 DEF("chroot", HAS_ARG, QEMU_OPTION_chroot, \
2369 "-chroot dir chroot to dir just before starting the VM\n",
2373 @item -chroot @var{dir}
2375 Immediately before starting guest execution, chroot to the specified
2376 directory. Especially useful in combination with -runas.
2380 DEF("runas", HAS_ARG, QEMU_OPTION_runas, \
2381 "-runas user change to user id user just before starting the VM\n",
2385 @item -runas @var{user}
2387 Immediately before starting guest execution, drop root privileges, switching
2388 to the specified user.
2391 DEF("prom-env", HAS_ARG, QEMU_OPTION_prom_env,
2392 "-prom-env variable=value\n"
2393 " set OpenBIOS nvram variables\n",
2394 QEMU_ARCH_PPC | QEMU_ARCH_SPARC)
2396 @item -prom-env @var{variable}=@var{value}
2398 Set OpenBIOS nvram @var{variable} to given @var{value} (PPC, SPARC only).
2400 DEF("semihosting", 0, QEMU_OPTION_semihosting,
2401 "-semihosting semihosting mode\n", QEMU_ARCH_ARM | QEMU_ARCH_M68K)
2404 @findex -semihosting
2405 Semihosting mode (ARM, M68K only).
2407 DEF("old-param", 0, QEMU_OPTION_old_param,
2408 "-old-param old param mode\n", QEMU_ARCH_ARM)
2411 @findex -old-param (ARM)
2412 Old param mode (ARM only).
2415 DEF("readconfig", HAS_ARG, QEMU_OPTION_readconfig,
2416 "-readconfig <file>\n", QEMU_ARCH_ALL)
2418 @item -readconfig @var{file}
2420 Read device configuration from @var{file}.
2422 DEF("writeconfig", HAS_ARG, QEMU_OPTION_writeconfig,
2423 "-writeconfig <file>\n"
2424 " read/write config file\n", QEMU_ARCH_ALL)
2426 @item -writeconfig @var{file}
2427 @findex -writeconfig
2428 Write device configuration to @var{file}.
2430 DEF("nodefconfig", 0, QEMU_OPTION_nodefconfig,
2432 " do not load default config files at startup\n",
2436 @findex -nodefconfig
2437 Normally QEMU loads a configuration file from @var{sysconfdir}/qemu.conf and
2438 @var{sysconfdir}/target-@var{ARCH}.conf on startup. The @code{-nodefconfig}
2439 option will prevent QEMU from loading these configuration files at startup.
2441 DEF("trace", HAS_ARG, QEMU_OPTION_trace,
2442 "-trace [events=<file>][,file=<file>]\n"
2443 " specify tracing options\n",
2446 HXCOMM This line is not accurate, as some sub-options are backend-specific but
2447 HXCOMM HX does not support conditional compilation of text.
2448 @item -trace [events=@var{file}][,file=@var{file}]
2451 Specify tracing options.
2454 @item events=@var{file}
2455 Immediately enable events listed in @var{file}.
2456 The file must contain one event name (as listed in the @var{trace-events} file)
2459 This option is only available when using the @var{simple} and @var{stderr}
2461 @item file=@var{file}
2462 Log output traces to @var{file}.
2464 This option is only available when using the @var{simple} tracing backend.
2468 DEF("no-kvm", 0, QEMU_OPTION_no_kvm,
2469 "-no-kvm disable KVM hardware virtualization\n",
2471 DEF("no-kvm-irqchip", 0, QEMU_OPTION_no_kvm_irqchip,
2472 "-no-kvm-irqchip disable KVM kernel mode PIC/IOAPIC/LAPIC\n",
2474 DEF("no-kvm-pit", 0, QEMU_OPTION_no_kvm_pit,
2475 "-no-kvm-pit disable KVM kernel mode PIT\n",
2477 DEF("no-kvm-pit-reinjection", 0, QEMU_OPTION_no_kvm_pit_reinjection,
2478 "-no-kvm-pit-reinjection\n"
2479 " disable KVM kernel mode PIT interrupt reinjection\n",
2481 DEF("nvram", HAS_ARG, QEMU_OPTION_nvram,
2482 "-nvram FILE provide ia64 nvram contents\n", QEMU_ARCH_ALL)
2483 DEF("tdf", 0, QEMU_OPTION_tdf,
2484 "-tdf enable guest time drift compensation\n", QEMU_ARCH_ALL)
2485 DEF("kvm-shadow-memory", HAS_ARG, QEMU_OPTION_kvm_shadow_memory,
2486 "-kvm-shadow-memory MEGABYTES\n"
2487 " allocate MEGABYTES for kvm mmu shadowing\n",
2490 HXCOMM This is the last statement. Insert new options before this line!