1 HXCOMM Use
DEFHEADING() to define headings
in both help text and texi
2 HXCOMM Text between STEXI and ETEXI are copied to texi version and
3 HXCOMM discarded from C version
4 HXCOMM
DEF(option
, HAS_ARG
/0, opt_enum
, opt_help
, arch_mask
) is used to
5 HXCOMM construct option structures
, enums and help message
for specified
7 HXCOMM HXCOMM can be used
for comments
, discarded from both texi and C
9 DEFHEADING(Standard options
:)
14 DEF("help", 0, QEMU_OPTION_h
,
15 "-h or -help display this help and exit\n", QEMU_ARCH_ALL
)
22 DEF("version", 0, QEMU_OPTION_version
,
23 "-version display version information and exit\n", QEMU_ARCH_ALL
)
27 Display version information and exit
30 DEF("M", HAS_ARG
, QEMU_OPTION_M
,
31 "-M machine select emulated machine (-M ? for list)\n", QEMU_ARCH_ALL
)
33 @item
-M @
var{machine
}
35 Select the emulated @
var{machine
} (@code
{-M ?
} for list
)
38 DEF("cpu", HAS_ARG
, QEMU_OPTION_cpu
,
39 "-cpu cpu select CPU (-cpu ? for list)\n", QEMU_ARCH_ALL
)
41 @item
-cpu @
var{model
}
43 Select CPU
model (-cpu ?
for list and additional feature selection
)
46 DEF("smp", HAS_ARG
, QEMU_OPTION_smp
,
47 "-smp n[,maxcpus=cpus][,cores=cores][,threads=threads][,sockets=sockets]\n"
48 " set the number of CPUs to 'n' [default=1]\n"
49 " maxcpus= maximum number of total cpus, including\n"
50 " offline CPUs for hotplug, etc\n"
51 " cores= number of CPU cores on one socket\n"
52 " threads= number of threads on one CPU core\n"
53 " sockets= number of discrete sockets in the system\n",
56 @item
-smp @
var{n
}[,cores
=@
var{cores
}][,threads
=@
var{threads
}][,sockets
=@
var{sockets
}][,maxcpus
=@
var{maxcpus
}]
58 Simulate an SMP system with @
var{n
} CPUs
. On the PC target
, up to
255
59 CPUs are supported
. On Sparc32 target
, Linux limits the number of usable CPUs
61 For the PC target
, the number of @
var{cores
} per socket
, the number
62 of @
var{threads
} per cores and the total number of @
var{sockets
} can be
63 specified
. Missing values will be computed
. If any on the three values is
64 given
, the total number of CPUs @
var{n
} can be omitted
. @
var{maxcpus
}
65 specifies the maximum number of hotpluggable CPUs
.
68 DEF("numa", HAS_ARG
, QEMU_OPTION_numa
,
69 "-numa node[,mem=size][,cpus=cpu[-cpu]][,nodeid=node]\n", QEMU_ARCH_ALL
)
71 @item
-numa @
var{opts
}
73 Simulate a multi node NUMA system
. If mem and cpus are omitted
, resources
77 DEF("fda", HAS_ARG
, QEMU_OPTION_fda
,
78 "-fda/-fdb file use 'file' as floppy disk 0/1 image\n", QEMU_ARCH_ALL
)
79 DEF("fdb", HAS_ARG
, QEMU_OPTION_fdb
, "", QEMU_ARCH_ALL
)
85 Use @
var{file
} as floppy disk
0/1 image (@pxref
{disk_images
}). You can
86 use the host floppy by
using @file
{/dev
/fd0
} as
filename (@pxref
{host_drives
}).
89 DEF("hda", HAS_ARG
, QEMU_OPTION_hda
,
90 "-hda/-hdb file use 'file' as IDE hard disk 0/1 image\n", QEMU_ARCH_ALL
)
91 DEF("hdb", HAS_ARG
, QEMU_OPTION_hdb
, "", QEMU_ARCH_ALL
)
92 DEF("hdc", HAS_ARG
, QEMU_OPTION_hdc
,
93 "-hdc/-hdd file use 'file' as IDE hard disk 2/3 image\n", QEMU_ARCH_ALL
)
94 DEF("hdd", HAS_ARG
, QEMU_OPTION_hdd
, "", QEMU_ARCH_ALL
)
104 Use @
var{file
} as hard disk
0, 1, 2 or
3 image (@pxref
{disk_images
}).
107 DEF("cdrom", HAS_ARG
, QEMU_OPTION_cdrom
,
108 "-cdrom file use 'file' as IDE cdrom image (cdrom is ide1 master)\n",
111 @item
-cdrom @
var{file
}
113 Use @
var{file
} as CD
-ROM
image (you cannot use @option
{-hdc
} and
114 @option
{-cdrom
} at the same time
). You can use the host CD
-ROM by
115 using @file
{/dev
/cdrom
} as
filename (@pxref
{host_drives
}).
118 DEF("drive", HAS_ARG
, QEMU_OPTION_drive
,
119 "-drive [file=file][,if=type][,bus=n][,unit=m][,media=d][,index=i]\n"
120 " [,cyls=c,heads=h,secs=s[,trans=t]][,snapshot=on|off]\n"
121 " [,cache=writethrough|writeback|none|unsafe][,format=f]\n"
122 " [,serial=s][,addr=A][,id=name][,aio=threads|native]\n"
123 " [,readonly=on|off][,boot=on|off]\n"
124 " use 'file' as a drive image\n", QEMU_ARCH_ALL
)
126 @item
-drive @
var{option
}[,@
var{option
}[,@
var{option
}[,...]]]
129 Define a
new drive
. Valid options are
:
132 @item file
=@
var{file
}
133 This option defines which disk
image (@pxref
{disk_images
}) to use with
134 this drive
. If the filename contains comma
, you must double it
135 (for instance
, "file=my,,file" to use file
"my,file").
136 @item
if=@
var{interface}
137 This option defines on which type on
interface the drive is connected
.
138 Available types are
: ide
, scsi
, sd
, mtd
, floppy
, pflash
, virtio
.
139 @item bus
=@
var{bus
},unit
=@
var{unit
}
140 These options define where is connected the drive by defining the bus number and
142 @item index
=@
var{index
}
143 This option defines where is connected the drive by
using an index
in the list
144 of available connectors of a given
interface type
.
145 @item media
=@
var{media
}
146 This option defines the type of the media
: disk or cdrom
.
147 @item cyls
=@
var{c
},heads
=@
var{h
},secs
=@
var{s
}[,trans
=@
var{t
}]
148 These options have the same definition as they have
in @option
{-hdachs
}.
149 @item snapshot
=@
var{snapshot
}
150 @
var{snapshot
} is
"on" or
"off" and allows to enable snapshot
for given
drive (see @option
{-snapshot
}).
151 @item cache
=@
var{cache
}
152 @
var{cache
} is
"none", "writeback", "unsafe", or
"writethrough" and controls how the host cache is used to access block data
.
154 @
var{aio
} is
"threads", or
"native" and selects between pthread based disk I
/O and native Linux AIO
.
155 @item format
=@
var{format
}
156 Specify which disk @
var{format
} will be used rather than detecting
157 the format
. Can be used to specifiy format
=raw to avoid interpreting
158 an untrusted format header
.
159 @item serial
=@
var{serial
}
160 This option specifies the serial number to assign to the device
.
161 @item addr
=@
var{addr
}
162 Specify the controller
's PCI address (if=virtio only).
163 @item boot=@var{boot}
164 @var{boot} is "on" or "off" and allows for booting from non-traditional interfaces, such as virtio.
167 By default, writethrough caching is used for all block device. This means that
168 the host page cache will be used to read and write data but write notification
169 will be sent to the guest only when the data has been reported as written by
170 the storage subsystem.
172 Writeback caching will report data writes as completed as soon as the data is
173 present in the host page cache. This is safe as long as you trust your host.
174 If your host crashes or loses power, then the guest may experience data
177 The host page cache can be avoided entirely with @option{cache=none}. This will
178 attempt to do disk IO directly to the guests memory. QEMU may still perform
179 an internal copy of the data.
181 Some block drivers perform badly with @option{cache=writethrough}, most notably,
182 qcow2. If performance is more important than correctness,
183 @option{cache=writeback} should be used with qcow2.
185 In case you don't care about data integrity over host failures
, use
186 cache
=unsafe
. This option tells qemu that it
never needs to write any data
187 to the disk but can instead keeps things
in cache
. If anything goes wrong
,
188 like your host losing power
, the disk storage getting disconnected accidently
,
189 etc
. you
're image will most probably be rendered unusable. When using
190 the @option{-snapshot} option, unsafe caching is always used.
192 Instead of @option{-cdrom} you can use:
194 qemu -drive file=file,index=2,media=cdrom
197 Instead of @option{-hda}, @option{-hdb}, @option{-hdc}, @option{-hdd}, you can
200 qemu -drive file=file,index=0,media=disk
201 qemu -drive file=file,index=1,media=disk
202 qemu -drive file=file,index=2,media=disk
203 qemu -drive file=file,index=3,media=disk
206 You can connect a CDROM to the slave of ide0:
208 qemu -drive file=file,if=ide,index=1,media=cdrom
211 If you don't specify the
"file=" argument
, you define an empty drive
:
213 qemu
-drive
if=ide
,index
=1,media
=cdrom
216 You can connect a SCSI disk with unit ID
6 on the bus #
0:
218 qemu
-drive file
=file
,if=scsi
,bus
=0,unit
=6
221 Instead of @option
{-fda
}, @option
{-fdb
}, you can use
:
223 qemu
-drive file
=file
,index
=0,if=floppy
224 qemu
-drive file
=file
,index
=1,if=floppy
227 By
default, @
var{interface} is
"ide" and @
var{index
} is automatically
230 qemu
-drive file
=a
-drive file
=b
"
238 DEF("set
", HAS_ARG, QEMU_OPTION_set,
239 "-set group
.id
.arg
=value
\n"
240 " set
<arg
> parameter
for item
<id
> of type
<group
>\n"
241 " i
.e
. -set drive
.$id
.file
=/path
/to
/image
\n", QEMU_ARCH_ALL)
248 DEF("global
", HAS_ARG, QEMU_OPTION_global,
249 "-global driver
.property
=value
\n"
250 " set a global
default for a driver property
\n",
258 DEF("mtdblock
", HAS_ARG, QEMU_OPTION_mtdblock,
259 "-mtdblock file use
'file' as on
-board Flash memory image
\n",
262 @item -mtdblock @var{file}
264 Use @var{file} as on-board Flash memory image.
267 DEF("sd
", HAS_ARG, QEMU_OPTION_sd,
268 "-sd file use
'file' as SecureDigital card image
\n", QEMU_ARCH_ALL)
272 Use @var{file} as SecureDigital card image.
275 DEF("pflash
", HAS_ARG, QEMU_OPTION_pflash,
276 "-pflash file use
'file' as a parallel flash image
\n", QEMU_ARCH_ALL)
278 @item -pflash @var{file}
280 Use @var{file} as a parallel flash image.
283 DEF("boot
", HAS_ARG, QEMU_OPTION_boot,
284 "-boot
[order
=drives
][,once
=drives
][,menu
=on|off
]\n"
285 " 'drives': floppy (a
), hard
disk (c
), CD
-ROM (d
), network (n
)\n",
288 @item -boot [order=@var{drives}][,once=@var{drives}][,menu=on|off]
290 Specify boot order @var{drives} as a string of drive letters. Valid
291 drive letters depend on the target achitecture. The x86 PC uses: a, b
292 (floppy 1 and 2), c (first hard disk), d (first CD-ROM), n-p (Etherboot
293 from network adapter 1-4), hard disk boot is the default. To apply a
294 particular boot order only on the first startup, specify it via
297 Interactive boot menus/prompts can be enabled via @option{menu=on} as far
298 as firmware/BIOS supports them. The default is non-interactive boot.
301 # try to boot from network first, then from hard disk
303 # boot from CD-ROM first, switch back to default order after reboot
307 Note: The legacy format '-boot @var{drives}' is still supported but its
308 use is discouraged as it may be removed from future versions.
311 DEF("snapshot
", 0, QEMU_OPTION_snapshot,
312 "-snapshot write to temporary files instead of disk image files
\n",
317 Write to temporary files instead of disk image files. In this case,
318 the raw disk image you use is not written back. You can however force
319 the write back by pressing @key{C-a s} (@pxref{disk_images}).
322 DEF("m
", HAS_ARG, QEMU_OPTION_m,
323 "-m megs set virtual RAM size to megs MB
[default="
324 stringify(DEFAULT_RAM_SIZE) "]\n", QEMU_ARCH_ALL)
328 Set virtual RAM size to @var{megs} megabytes. Default is 128 MiB. Optionally,
329 a suffix of ``M'' or ``G'' can be used to signify a value in megabytes or
330 gigabytes respectively.
333 DEF("mem
-path
", HAS_ARG, QEMU_OPTION_mempath,
334 "-mem
-path FILE provide backing storage
for guest RAM
\n", QEMU_ARCH_ALL)
336 @item -mem-path @var{path}
337 Allocate guest RAM from a temporarily created file in @var{path}.
341 DEF("mem
-prealloc
", 0, QEMU_OPTION_mem_prealloc,
342 "-mem
-prealloc preallocate guest
memory (use with
-mem
-path
)\n",
346 Preallocate memory when using -mem-path.
350 DEF("k
", HAS_ARG, QEMU_OPTION_k,
351 "-k language use keyboard
layout (for example
'fr' for French
)\n",
354 @item -k @var{language}
356 Use keyboard layout @var{language} (for example @code{fr} for
357 French). This option is only needed where it is not easy to get raw PC
358 keycodes (e.g. on Macs, with some X11 servers or with a VNC
359 display). You don't normally need to use it on PC/Linux or PC/Windows
362 The available layouts are:
364 ar de-ch es fo fr-ca hu ja mk no pt-br sv
365 da en-gb et fr fr-ch is lt nl pl ru th
366 de en-us fi fr-be hr it lv nl-be pt sl tr
369 The default is @code{en-us}.
373 DEF("audio
-help
", 0, QEMU_OPTION_audio_help,
374 "-audio
-help print list of audio drivers and their options
\n",
379 Will show the audio subsystem help: list of drivers, tunable
383 DEF("soundhw
", HAS_ARG, QEMU_OPTION_soundhw,
384 "-soundhw c1
,... enable audio support
\n"
385 " and only specified sound
cards (comma separated list
)\n"
386 " use
-soundhw ? to get the list of supported cards
\n"
387 " use
-soundhw all to enable all of them
\n", QEMU_ARCH_ALL)
389 @item -soundhw @var{card1}[,@var{card2},...] or -soundhw all
391 Enable audio and selected sound hardware. Use ? to print all
392 available sound hardware.
395 qemu -soundhw sb16,adlib disk.img
396 qemu -soundhw es1370 disk.img
397 qemu -soundhw ac97 disk.img
398 qemu -soundhw all disk.img
402 Note that Linux's i810_audio OSS kernel (for AC97) module might
403 require manually specifying clocking.
406 modprobe i810_audio clocking=48000
414 DEF("usb
", 0, QEMU_OPTION_usb,
415 "-usb enable the USB
driver (will be the
default soon
)\n",
423 Enable the USB driver (will be the default soon)
426 DEF("usbdevice
", HAS_ARG, QEMU_OPTION_usbdevice,
427 "-usbdevice name add the host or guest USB device
'name'\n",
431 @item -usbdevice @var{devname}
433 Add the USB device @var{devname}. @xref{usb_devices}.
438 Virtual Mouse. This will override the PS/2 mouse emulation when activated.
441 Pointer device that uses absolute coordinates (like a touchscreen). This
442 means qemu is able to report the mouse position without having to grab the
443 mouse. Also overrides the PS/2 mouse emulation when activated.
445 @item disk:[format=@var{format}]:@var{file}
446 Mass storage device based on file. The optional @var{format} argument
447 will be used rather than detecting the format. Can be used to specifiy
448 @code{format=raw} to avoid interpreting an untrusted format header.
450 @item host:@var{bus}.@var{addr}
451 Pass through the host device identified by @var{bus}.@var{addr} (Linux only).
453 @item host:@var{vendor_id}:@var{product_id}
454 Pass through the host device identified by @var{vendor_id}:@var{product_id}
457 @item serial:[vendorid=@var{vendor_id}][,productid=@var{product_id}]:@var{dev}
458 Serial converter to host character device @var{dev}, see @code{-serial} for the
462 Braille device. This will use BrlAPI to display the braille output on a real
465 @item net:@var{options}
466 Network adapter that supports CDC ethernet and RNDIS protocols.
471 DEF("device
", HAS_ARG, QEMU_OPTION_device,
472 "-device driver
[,prop
[=value
][,...]]\n"
473 " add
device (based on driver
)\n"
474 " prop
=value
,... sets driver properties
\n"
475 " use
-device ? to print all possible drivers
\n"
476 " use
-device driver
,? to print all possible properties
\n",
479 @item -device @var{driver}[,@var{prop}[=@var{value}][,...]]
481 Add device @var{driver}. @var{prop}=@var{value} sets driver
482 properties. Valid properties depend on the driver. To get help on
483 possible drivers and properties, use @code{-device ?} and
484 @code{-device @var{driver},?}.
488 DEFHEADING(File system options:)
490 DEF("fsdev
", HAS_ARG, QEMU_OPTION_fsdev,
491 "-fsdev local
,id
=id
,path
=path
,security_model
=[mapped|passthrough
]\n",
496 The general form of a File system device option is:
499 @item -fsdev @var{fstype} ,id=@var{id} [,@var{options}]
503 The specific Fstype will determine the applicable options.
505 Options to each backend are described below.
507 @item -fsdev local ,id=@var{id} ,path=@var{path} ,security_model=@var{security_model}
509 Create a file-system-"device
" for local-filesystem.
511 @option{local} is only available on Linux.
513 @option{path} specifies the path to be exported. @option{path} is required.
515 @option{security_model} specifies the security model to be followed.
516 @option{security_model} is required.
523 DEFHEADING(Virtual File system pass-through options:)
525 DEF("virtfs
", HAS_ARG, QEMU_OPTION_virtfs,
526 "-virtfs local
,path
=path
,mount_tag
=tag
,security_model
=[mapped|passthrough
]\n",
531 The general form of a Virtual File system pass-through option is:
534 @item -virtfs @var{fstype} [,@var{options}]
538 The specific Fstype will determine the applicable options.
540 Options to each backend are described below.
542 @item -virtfs local ,path=@var{path} ,mount_tag=@var{mount_tag} ,security_model=@var{security_model}
544 Create a Virtual file-system-pass through for local-filesystem.
546 @option{local} is only available on Linux.
548 @option{path} specifies the path to be exported. @option{path} is required.
550 @option{security_model} specifies the security model to be followed.
551 @option{security_model} is required.
554 @option{mount_tag} specifies the tag with which the exported file is mounted.
555 @option{mount_tag} is required.
563 DEF("name
", HAS_ARG, QEMU_OPTION_name,
564 "-name string1
[,process
=string2
]\n"
565 " set the name of the guest
\n"
566 " string1 sets the window title and string2 the process
name (on Linux
)\n",
569 @item -name @var{name}
571 Sets the @var{name} of the guest.
572 This name will be displayed in the SDL window caption.
573 The @var{name} will also be used for the VNC server.
574 Also optionally set the top visible process name in Linux.
577 DEF("uuid
", HAS_ARG, QEMU_OPTION_uuid,
578 "-uuid
%08x
-%04x
-%04x
-%04x
-%012x
\n"
579 " specify machine UUID
\n", QEMU_ARCH_ALL)
581 @item -uuid @var{uuid}
592 DEFHEADING(Display options:)
598 DEF("nographic
", 0, QEMU_OPTION_nographic,
599 "-nographic disable graphical output and redirect serial I
/Os to console
\n",
604 Normally, QEMU uses SDL to display the VGA output. With this option,
605 you can totally disable graphical output so that QEMU is a simple
606 command line application. The emulated serial port is redirected on
607 the console. Therefore, you can still use QEMU to debug a Linux kernel
608 with a serial console.
612 DEF("curses
", 0, QEMU_OPTION_curses,
613 "-curses use a curses
/ncurses
interface instead of SDL
\n",
619 Normally, QEMU uses SDL to display the VGA output. With this option,
620 QEMU can display the VGA output when in text mode using a
621 curses/ncurses interface. Nothing is displayed in graphical mode.
625 DEF("no
-frame
", 0, QEMU_OPTION_no_frame,
626 "-no
-frame open SDL window without a frame and window decorations
\n",
632 Do not use decorations for SDL windows and start them using the whole
633 available screen space. This makes the using QEMU in a dedicated desktop
634 workspace more convenient.
638 DEF("alt
-grab
", 0, QEMU_OPTION_alt_grab,
639 "-alt
-grab use Ctrl
-Alt
-Shift to grab
mouse (instead of Ctrl
-Alt
)\n",
645 Use Ctrl-Alt-Shift to grab mouse (instead of Ctrl-Alt).
649 DEF("ctrl
-grab
", 0, QEMU_OPTION_ctrl_grab,
650 "-ctrl
-grab use Right
-Ctrl to grab
mouse (instead of Ctrl
-Alt
)\n",
656 Use Right-Ctrl to grab mouse (instead of Ctrl-Alt).
660 DEF("no
-quit
", 0, QEMU_OPTION_no_quit,
661 "-no
-quit disable SDL window close capability
\n", QEMU_ARCH_ALL)
666 Disable SDL window close capability.
670 DEF("sdl
", 0, QEMU_OPTION_sdl,
671 "-sdl enable SDL
\n", QEMU_ARCH_ALL)
679 DEF("portrait
", 0, QEMU_OPTION_portrait,
680 "-portrait rotate graphical output
90 deg
left (only PXA LCD
)\n",
685 Rotate graphical output 90 deg left (only PXA LCD).
688 DEF("vga
", HAS_ARG, QEMU_OPTION_vga,
689 "-vga
[std|cirrus|vmware|xenfb|none
]\n"
690 " select video card type
\n", QEMU_ARCH_ALL)
692 @item -vga @var{type}
694 Select type of VGA card to emulate. Valid values for @var{type} are
697 Cirrus Logic GD5446 Video card. All Windows versions starting from
698 Windows 95 should recognize and use this graphic card. For optimal
699 performances, use 16 bit color depth in the guest and the host OS.
700 (This one is the default)
702 Standard VGA card with Bochs VBE extensions. If your guest OS
703 supports the VESA 2.0 VBE extensions (e.g. Windows XP) and if you want
704 to use high resolution modes (>= 1280x1024x16) then you should use
707 VMWare SVGA-II compatible adapter. Use it if you have sufficiently
708 recent XFree86/XOrg server or Windows guest with a driver for this
715 DEF("full
-screen
", 0, QEMU_OPTION_full_screen,
716 "-full
-screen start
in full screen
\n", QEMU_ARCH_ALL)
720 Start in full screen.
723 DEF("g
", 1, QEMU_OPTION_g ,
724 "-g WxH
[xDEPTH
] Set the initial graphical resolution and depth
\n",
725 QEMU_ARCH_PPC | QEMU_ARCH_SPARC)
727 @item -g @var{width}x@var{height}[x@var{depth}]
729 Set the initial graphical resolution and depth (PPC, SPARC only).
732 DEF("vnc
", HAS_ARG, QEMU_OPTION_vnc ,
733 "-vnc display start a VNC server on display
\n", QEMU_ARCH_ALL)
735 @item -vnc @var{display}[,@var{option}[,@var{option}[,...]]]
737 Normally, QEMU uses SDL to display the VGA output. With this option,
738 you can have QEMU listen on VNC display @var{display} and redirect the VGA
739 display over the VNC session. It is very useful to enable the usb
740 tablet device when using this option (option @option{-usbdevice
741 tablet}). When using the VNC display, you must use the @option{-k}
742 parameter to set the keyboard layout if you are not using en-us. Valid
743 syntax for the @var{display} is
747 @item @var{host}:@var{d}
749 TCP connections will only be allowed from @var{host} on display @var{d}.
750 By convention the TCP port is 5900+@var{d}. Optionally, @var{host} can
751 be omitted in which case the server will accept connections from any host.
753 @item unix:@var{path}
755 Connections will be allowed over UNIX domain sockets where @var{path} is the
756 location of a unix socket to listen for connections on.
760 VNC is initialized but not started. The monitor @code{change} command
761 can be used to later start the VNC server.
765 Following the @var{display} value there may be one or more @var{option} flags
766 separated by commas. Valid options are
772 Connect to a listening VNC client via a ``reverse'' connection. The
773 client is specified by the @var{display}. For reverse network
774 connections (@var{host}:@var{d},@code{reverse}), the @var{d} argument
775 is a TCP port number, not a display number.
779 Require that password based authentication is used for client connections.
780 The password must be set separately using the @code{change} command in the
785 Require that client use TLS when communicating with the VNC server. This
786 uses anonymous TLS credentials so is susceptible to a man-in-the-middle
787 attack. It is recommended that this option be combined with either the
788 @option{x509} or @option{x509verify} options.
790 @item x509=@var{/path/to/certificate/dir}
792 Valid if @option{tls} is specified. Require that x509 credentials are used
793 for negotiating the TLS session. The server will send its x509 certificate
794 to the client. It is recommended that a password be set on the VNC server
795 to provide authentication of the client when this is used. The path following
796 this option specifies where the x509 certificates are to be loaded from.
797 See the @ref{vnc_security} section for details on generating certificates.
799 @item x509verify=@var{/path/to/certificate/dir}
801 Valid if @option{tls} is specified. Require that x509 credentials are used
802 for negotiating the TLS session. The server will send its x509 certificate
803 to the client, and request that the client send its own x509 certificate.
804 The server will validate the client's certificate against the CA certificate,
805 and reject clients when validation fails. If the certificate authority is
806 trusted, this is a sufficient authentication mechanism. You may still wish
807 to set a password on the VNC server as a second authentication layer. The
808 path following this option specifies where the x509 certificates are to
809 be loaded from. See the @ref{vnc_security} section for details on generating
814 Require that the client use SASL to authenticate with the VNC server.
815 The exact choice of authentication method used is controlled from the
816 system / user's SASL configuration file for the 'qemu' service. This
817 is typically found in /etc/sasl2/qemu.conf. If running QEMU as an
818 unprivileged user, an environment variable SASL_CONF_PATH can be used
819 to make it search alternate locations for the service config.
820 While some SASL auth methods can also provide data encryption (eg GSSAPI),
821 it is recommended that SASL always be combined with the 'tls' and
822 'x509' settings to enable use of SSL and server certificates. This
823 ensures a data encryption preventing compromise of authentication
824 credentials. See the @ref{vnc_security} section for details on using
829 Turn on access control lists for checking of the x509 client certificate
830 and SASL party. For x509 certs, the ACL check is made against the
831 certificate's distinguished name. This is something that looks like
832 @code{C=GB,O=ACME,L=Boston,CN=bob}. For SASL party, the ACL check is
833 made against the username, which depending on the SASL plugin, may
834 include a realm component, eg @code{bob} or @code{bob@@EXAMPLE.COM}.
835 When the @option{acl} flag is set, the initial access list will be
836 empty, with a @code{deny} policy. Thus no one will be allowed to
837 use the VNC server until the ACLs have been loaded. This can be
838 achieved using the @code{acl} monitor command.
842 Enable lossy compression methods (gradient, JPEG, ...). If this
843 option is set, VNC client may receive lossy framebuffer updates
844 depending on its encoding settings. Enabling this option can save
845 a lot of bandwidth at the expense of quality.
856 DEFHEADING(i386 target only:)
861 DEF("win2k
-hack
", 0, QEMU_OPTION_win2k_hack,
862 "-win2k
-hack use it when installing Windows
2000 to avoid a disk full bug
\n",
867 Use it when installing Windows 2000 to avoid a disk full bug. After
868 Windows 2000 is installed, you no longer need this option (this option
869 slows down the IDE transfers).
872 HXCOMM Deprecated by -rtc
873 DEF("rtc
-td
-hack
", 0, QEMU_OPTION_rtc_td_hack, "", QEMU_ARCH_I386)
875 DEF("no
-fd
-bootchk
", 0, QEMU_OPTION_no_fd_bootchk,
876 "-no
-fd
-bootchk disable boot signature checking
for floppy disks
\n",
880 @findex -no-fd-bootchk
881 Disable boot signature checking for floppy disks in Bochs BIOS. It may
882 be needed to boot from old floppy disks.
883 TODO: check reference to Bochs BIOS.
886 DEF("no
-acpi
", 0, QEMU_OPTION_no_acpi,
887 "-no
-acpi disable ACPI
\n", QEMU_ARCH_I386)
891 Disable ACPI (Advanced Configuration and Power Interface) support. Use
892 it if your guest OS complains about ACPI problems (PC target machine
896 DEF("no
-hpet
", 0, QEMU_OPTION_no_hpet,
897 "-no
-hpet disable HPET
\n", QEMU_ARCH_I386)
901 Disable HPET support.
904 DEF("balloon
", HAS_ARG, QEMU_OPTION_balloon,
905 "-balloon none disable balloon device
\n"
906 "-balloon virtio
[,addr
=str
]\n"
907 " enable virtio balloon
device (default)\n", QEMU_ARCH_ALL)
911 Disable balloon device.
912 @item -balloon virtio[,addr=@var{addr}]
913 Enable virtio balloon device (default), optionally with PCI address
917 DEF("acpitable
", HAS_ARG, QEMU_OPTION_acpitable,
918 "-acpitable
[sig
=str
][,rev
=n
][,oem_id
=str
][,oem_table_id
=str
][,oem_rev
=n
][,asl_compiler_id
=str
][,asl_compiler_rev
=n
][,data
=file1
[:file2
]...]\n"
919 " ACPI table description
\n", QEMU_ARCH_I386)
921 @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}]...]
923 Add ACPI table with specified header fields and context from specified files.
926 DEF("smbios
", HAS_ARG, QEMU_OPTION_smbios,
927 "-smbios file
=binary
\n"
928 " load SMBIOS entry from binary file
\n"
929 "-smbios type
=0[,vendor
=str
][,version
=str
][,date
=str
][,release
=%d
.%d
]\n"
930 " specify SMBIOS type
0 fields
\n"
931 "-smbios type
=1[,manufacturer
=str
][,product
=str
][,version
=str
][,serial
=str
]\n"
932 " [,uuid
=uuid
][,sku
=str
][,family
=str
]\n"
933 " specify SMBIOS type
1 fields
\n", QEMU_ARCH_I386)
935 @item -smbios file=@var{binary}
937 Load SMBIOS entry from binary file.
939 @item -smbios type=0[,vendor=@var{str}][,version=@var{str}][,date=@var{str}][,release=@var{%d.%d}]
941 Specify SMBIOS type 0 fields
943 @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}]
944 Specify SMBIOS type 1 fields
952 DEFHEADING(Network options:)
957 HXCOMM Legacy slirp options (now moved to -net user):
959 DEF("tftp
", HAS_ARG, QEMU_OPTION_tftp, "", QEMU_ARCH_ALL)
960 DEF("bootp
", HAS_ARG, QEMU_OPTION_bootp, "", QEMU_ARCH_ALL)
961 DEF("redir
", HAS_ARG, QEMU_OPTION_redir, "", QEMU_ARCH_ALL)
963 DEF("smb
", HAS_ARG, QEMU_OPTION_smb, "", QEMU_ARCH_ALL)
967 DEF("net
", HAS_ARG, QEMU_OPTION_net,
968 "-net nic
[,vlan
=n
][,macaddr
=mac
][,model
=type
][,name
=str
][,addr
=str
][,vectors
=v
]\n"
969 " create a
new Network Interface Card and connect it to VLAN
'n'\n"
971 "-net user
[,vlan
=n
][,name
=str
][,net
=addr
[/mask
]][,host
=addr
][,restrict
=y|n
]\n"
972 " [,hostname
=host
][,dhcpstart
=addr
][,dns
=addr
][,tftp
=dir
][,bootfile
=f
]\n"
973 " [,hostfwd
=rule
][,guestfwd
=rule
]"
975 "[,smb
=dir
[,smbserver
=addr
]]\n"
977 " connect the user mode network stack to VLAN
'n', configure its
\n"
978 " DHCP server and enabled optional services
\n"
981 "-net tap
[,vlan
=n
][,name
=str
],ifname
=name
\n"
982 " connect the host TAP network
interface to VLAN
'n'\n"
984 "-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
]\n"
985 " connect the host TAP network
interface to VLAN
'n' and use the
\n"
986 " network scripts
'file' (default=" DEFAULT_NETWORK_SCRIPT ")\n"
987 " and
'dfile' (default=" DEFAULT_NETWORK_DOWN_SCRIPT ")\n"
988 " use
'[down]script=no' to disable script execution
\n"
989 " use
'fd=h' to connect to an already opened TAP
interface\n"
990 " use
'sndbuf=nbytes' to limit the size of the send
buffer (the
\n"
991 " default of
'sndbuf=1048576' can be disabled
using 'sndbuf=0')\n"
992 " use vnet_hdr
=off to avoid enabling the IFF_VNET_HDR tap flag
\n"
993 " use vnet_hdr
=on to make the lack of IFF_VNET_HDR support an error condition
\n"
994 " use vhost
=on to enable experimental
in kernel accelerator
\n"
995 " use
'vhostfd=h' to connect to an already opened vhost net device
\n"
997 "-net socket
[,vlan
=n
][,name
=str
][,fd
=h
][,listen
=[host
]:port
][,connect
=host
:port
]\n"
998 " connect the vlan
'n' to another VLAN
using a socket connection
\n"
999 "-net socket
[,vlan
=n
][,name
=str
][,fd
=h
][,mcast
=maddr
:port
]\n"
1000 " connect the vlan
'n' to multicast maddr and port
\n"
1002 "-net vde
[,vlan
=n
][,name
=str
][,sock
=socketpath
][,port
=n
][,group
=groupname
][,mode
=octalmode
]\n"
1003 " connect the vlan
'n' to port
'n' of a vde
switch running
\n"
1004 " on host and listening
for incoming connections on
'socketpath'.\n"
1005 " Use group
'groupname' and mode
'octalmode' to change
default\n"
1006 " ownership and permissions
for communication port
.\n"
1008 "-net dump
[,vlan
=n
][,file
=f
][,len
=n
]\n"
1009 " dump traffic on vlan
'n' to file
'f' (max n bytes per packet
)\n"
1010 "-net none use it alone to have zero network devices
. If no
-net option
\n"
1011 " is provided
, the
default is
'-net nic -net user'\n", QEMU_ARCH_ALL)
1012 DEF("netdev
", HAS_ARG, QEMU_OPTION_netdev,
1021 "socket
],id
=str
[,option
][,option
][,...]\n", QEMU_ARCH_ALL)
1023 @item -net nic[,vlan=@var{n}][,macaddr=@var{mac}][,model=@var{type}] [,name=@var{name}][,addr=@var{addr}][,vectors=@var{v}]
1025 Create a new Network Interface Card and connect it to VLAN @var{n} (@var{n}
1026 = 0 is the default). The NIC is an e1000 by default on the PC
1027 target. Optionally, the MAC address can be changed to @var{mac}, the
1028 device address set to @var{addr} (PCI cards only),
1029 and a @var{name} can be assigned for use in monitor commands.
1030 Optionally, for PCI cards, you can specify the number @var{v} of MSI-X vectors
1031 that the card should have; this option currently only affects virtio cards; set
1032 @var{v} = 0 to disable MSI-X. If no @option{-net} option is specified, a single
1033 NIC is created. Qemu can emulate several different models of network card.
1034 Valid values for @var{type} are
1035 @code{virtio}, @code{i82551}, @code{i82557b}, @code{i82559er},
1036 @code{ne2k_pci}, @code{ne2k_isa}, @code{pcnet}, @code{rtl8139},
1037 @code{e1000}, @code{smc91c111}, @code{lance} and @code{mcf_fec}.
1038 Not all devices are supported on all targets. Use -net nic,model=?
1039 for a list of available devices for your target.
1041 @item -net user[,@var{option}][,@var{option}][,...]
1042 Use the user mode network stack which requires no administrator
1043 privilege to run. Valid options are:
1047 Connect user mode stack to VLAN @var{n} (@var{n} = 0 is the default).
1049 @item name=@var{name}
1050 Assign symbolic name for use in monitor commands.
1052 @item net=@var{addr}[/@var{mask}]
1053 Set IP network address the guest will see. Optionally specify the netmask,
1054 either in the form a.b.c.d or as number of valid top-most bits. Default is
1057 @item host=@var{addr}
1058 Specify the guest-visible address of the host. Default is the 2nd IP in the
1059 guest network, i.e. x.x.x.2.
1061 @item restrict=y|yes|n|no
1062 If this options is enabled, the guest will be isolated, i.e. it will not be
1063 able to contact the host and no guest IP packets will be routed over the host
1064 to the outside. This option does not affect explicitly set forwarding rule.
1066 @item hostname=@var{name}
1067 Specifies the client hostname reported by the builtin DHCP server.
1069 @item dhcpstart=@var{addr}
1070 Specify the first of the 16 IPs the built-in DHCP server can assign. Default
1071 is the 16th to 31st IP in the guest network, i.e. x.x.x.16 to x.x.x.31.
1073 @item dns=@var{addr}
1074 Specify the guest-visible address of the virtual nameserver. The address must
1075 be different from the host address. Default is the 3rd IP in the guest network,
1078 @item tftp=@var{dir}
1079 When using the user mode network stack, activate a built-in TFTP
1080 server. The files in @var{dir} will be exposed as the root of a TFTP server.
1081 The TFTP client on the guest must be configured in binary mode (use the command
1082 @code{bin} of the Unix TFTP client).
1084 @item bootfile=@var{file}
1085 When using the user mode network stack, broadcast @var{file} as the BOOTP
1086 filename. In conjunction with @option{tftp}, this can be used to network boot
1087 a guest from a local directory.
1089 Example (using pxelinux):
1091 qemu -hda linux.img -boot n -net user,tftp=/path/to/tftp/files,bootfile=/pxelinux.0
1094 @item smb=@var{dir}[,smbserver=@var{addr}]
1095 When using the user mode network stack, activate a built-in SMB
1096 server so that Windows OSes can access to the host files in @file{@var{dir}}
1097 transparently. The IP address of the SMB server can be set to @var{addr}. By
1098 default the 4th IP in the guest network is used, i.e. x.x.x.4.
1100 In the guest Windows OS, the line:
1104 must be added in the file @file{C:\WINDOWS\LMHOSTS} (for windows 9x/Me)
1105 or @file{C:\WINNT\SYSTEM32\DRIVERS\ETC\LMHOSTS} (Windows NT/2000).
1107 Then @file{@var{dir}} can be accessed in @file{\\smbserver\qemu}.
1109 Note that a SAMBA server must be installed on the host OS in
1110 @file{/usr/sbin/smbd}. QEMU was tested successfully with smbd versions from
1111 Red Hat 9, Fedora Core 3 and OpenSUSE 11.x.
1113 @item hostfwd=[tcp|udp]:[@var{hostaddr}]:@var{hostport}-[@var{guestaddr}]:@var{guestport}
1114 Redirect incoming TCP or UDP connections to the host port @var{hostport} to
1115 the guest IP address @var{guestaddr} on guest port @var{guestport}. If
1116 @var{guestaddr} is not specified, its value is x.x.x.15 (default first address
1117 given by the built-in DHCP server). By specifying @var{hostaddr}, the rule can
1118 be bound to a specific host interface. If no connection type is set, TCP is
1119 used. This option can be given multiple times.
1121 For example, to redirect host X11 connection from screen 1 to guest
1122 screen 0, use the following:
1126 qemu -net user,hostfwd=tcp:127.0.0.1:6001-:6000 [...]
1127 # this host xterm should open in the guest X11 server
1131 To redirect telnet connections from host port 5555 to telnet port on
1132 the guest, use the following:
1136 qemu -net user,hostfwd=tcp::5555-:23 [...]
1137 telnet localhost 5555
1140 Then when you use on the host @code{telnet localhost 5555}, you
1141 connect to the guest telnet server.
1143 @item guestfwd=[tcp]:@var{server}:@var{port}-@var{dev}
1144 Forward guest TCP connections to the IP address @var{server} on port @var{port}
1145 to the character device @var{dev}. This option can be given multiple times.
1149 Note: Legacy stand-alone options -tftp, -bootp, -smb and -redir are still
1150 processed and applied to -net user. Mixing them with the new configuration
1151 syntax gives undefined results. Their use for new applications is discouraged
1152 as they will be removed from future versions.
1154 @item -net tap[,vlan=@var{n}][,name=@var{name}][,fd=@var{h}][,ifname=@var{name}] [,script=@var{file}][,downscript=@var{dfile}]
1155 Connect the host TAP network interface @var{name} to VLAN @var{n}, use
1156 the network script @var{file} to configure it and the network script
1157 @var{dfile} to deconfigure it. If @var{name} is not provided, the OS
1158 automatically provides one. @option{fd}=@var{h} can be used to specify
1159 the handle of an already opened host TAP interface. The default network
1160 configure script is @file{/etc/qemu-ifup} and the default network
1161 deconfigure script is @file{/etc/qemu-ifdown}. Use @option{script=no}
1162 or @option{downscript=no} to disable script execution. Example:
1165 qemu linux.img -net nic -net tap
1168 More complicated example (two NICs, each one connected to a TAP device)
1170 qemu linux.img -net nic,vlan=0 -net tap,vlan=0,ifname=tap0 \
1171 -net nic,vlan=1 -net tap,vlan=1,ifname=tap1
1174 @item -net socket[,vlan=@var{n}][,name=@var{name}][,fd=@var{h}] [,listen=[@var{host}]:@var{port}][,connect=@var{host}:@var{port}]
1176 Connect the VLAN @var{n} to a remote VLAN in another QEMU virtual
1177 machine using a TCP socket connection. If @option{listen} is
1178 specified, QEMU waits for incoming connections on @var{port}
1179 (@var{host} is optional). @option{connect} is used to connect to
1180 another QEMU instance using the @option{listen} option. @option{fd}=@var{h}
1181 specifies an already opened TCP socket.
1185 # launch a first QEMU instance
1186 qemu linux.img -net nic,macaddr=52:54:00:12:34:56 \
1187 -net socket,listen=:1234
1188 # connect the VLAN 0 of this instance to the VLAN 0
1189 # of the first instance
1190 qemu linux.img -net nic,macaddr=52:54:00:12:34:57 \
1191 -net socket,connect=127.0.0.1:1234
1194 @item -net socket[,vlan=@var{n}][,name=@var{name}][,fd=@var{h}] [,mcast=@var{maddr}:@var{port}]
1196 Create a VLAN @var{n} shared with another QEMU virtual
1197 machines using a UDP multicast socket, effectively making a bus for
1198 every QEMU with same multicast address @var{maddr} and @var{port}.
1202 Several QEMU can be running on different hosts and share same bus (assuming
1203 correct multicast setup for these hosts).
1205 mcast support is compatible with User Mode Linux (argument @option{eth@var{N}=mcast}), see
1206 @url{http://user-mode-linux.sf.net}.
1208 Use @option{fd=h} to specify an already opened UDP multicast socket.
1213 # launch one QEMU instance
1214 qemu linux.img -net nic,macaddr=52:54:00:12:34:56 \
1215 -net socket,mcast=230.0.0.1:1234
1216 # launch another QEMU instance on same "bus
"
1217 qemu linux.img -net nic,macaddr=52:54:00:12:34:57 \
1218 -net socket,mcast=230.0.0.1:1234
1219 # launch yet another QEMU instance on same "bus
"
1220 qemu linux.img -net nic,macaddr=52:54:00:12:34:58 \
1221 -net socket,mcast=230.0.0.1:1234
1224 Example (User Mode Linux compat.):
1226 # launch QEMU instance (note mcast address selected
1228 qemu linux.img -net nic,macaddr=52:54:00:12:34:56 \
1229 -net socket,mcast=239.192.168.1:1102
1231 /path/to/linux ubd0=/path/to/root_fs eth0=mcast
1234 @item -net vde[,vlan=@var{n}][,name=@var{name}][,sock=@var{socketpath}] [,port=@var{n}][,group=@var{groupname}][,mode=@var{octalmode}]
1235 Connect VLAN @var{n} to PORT @var{n} of a vde switch running on host and
1236 listening for incoming connections on @var{socketpath}. Use GROUP @var{groupname}
1237 and MODE @var{octalmode} to change default ownership and permissions for
1238 communication port. This option is available only if QEMU has been compiled
1239 with vde support enabled.
1244 vde_switch -F -sock /tmp/myswitch
1245 # launch QEMU instance
1246 qemu linux.img -net nic -net vde,sock=/tmp/myswitch
1249 @item -net dump[,vlan=@var{n}][,file=@var{file}][,len=@var{len}]
1250 Dump network traffic on VLAN @var{n} to file @var{file} (@file{qemu-vlan0.pcap} by default).
1251 At most @var{len} bytes (64k by default) per packet are stored. The file format is
1252 libpcap, so it can be analyzed with tools such as tcpdump or Wireshark.
1255 Indicate that no network devices should be configured. It is used to
1256 override the default configuration (@option{-net nic -net user}) which
1257 is activated if no @option{-net} options are provided.
1264 DEFHEADING(Character device options:)
1266 DEF("chardev
", HAS_ARG, QEMU_OPTION_chardev,
1267 "-chardev
null,id
=id
[,mux
=on|off
]\n"
1268 "-chardev socket
,id
=id
[,host
=host
],port
=host
[,to
=to
][,ipv4
][,ipv6
][,nodelay
]\n"
1269 " [,server
][,nowait
][,telnet
][,mux
=on|off
] (tcp
)\n"
1270 "-chardev socket
,id
=id
,path
=path
[,server
][,nowait
][,telnet
],[mux
=on|off
] (unix
)\n"
1271 "-chardev udp
,id
=id
[,host
=host
],port
=port
[,localaddr
=localaddr
]\n"
1272 " [,localport
=localport
][,ipv4
][,ipv6
][,mux
=on|off
]\n"
1273 "-chardev msmouse
,id
=id
[,mux
=on|off
]\n"
1274 "-chardev vc
,id
=id
[[,width
=width
][,height
=height
]][[,cols
=cols
][,rows
=rows
]]\n"
1276 "-chardev file
,id
=id
,path
=path
[,mux
=on|off
]\n"
1277 "-chardev pipe
,id
=id
,path
=path
[,mux
=on|off
]\n"
1279 "-chardev console
,id
=id
[,mux
=on|off
]\n"
1280 "-chardev serial
,id
=id
,path
=path
[,mux
=on|off
]\n"
1282 "-chardev pty
,id
=id
[,mux
=on|off
]\n"
1283 "-chardev stdio
,id
=id
[,mux
=on|off
][,signal
=on|off
]\n"
1285 #ifdef CONFIG_BRLAPI
1286 "-chardev braille
,id
=id
[,mux
=on|off
]\n"
1288 #if defined(__linux__) || defined(__sun__) || defined(__FreeBSD__) \
1289 || defined(__NetBSD__) || defined(__OpenBSD__) || defined(__DragonFly__)
1290 "-chardev tty
,id
=id
,path
=path
[,mux
=on|off
]\n"
1292 #if defined(__linux__) || defined(__FreeBSD__) || defined(__DragonFly__)
1293 "-chardev parport
,id
=id
,path
=path
[,mux
=on|off
]\n"
1300 The general form of a character device option is:
1303 @item -chardev @var{backend} ,id=@var{id} [,mux=on|off] [,@var{options}]
1320 The specific backend will determine the applicable options.
1322 All devices must have an id, which can be any string up to 127 characters long.
1323 It is used to uniquely identify this device in other command line directives.
1325 A character device may be used in multiplexing mode by multiple front-ends.
1326 The key sequence of @key{Control-a} and @key{c} will rotate the input focus
1327 between attached front-ends. Specify @option{mux=on} to enable this mode.
1329 Options to each backend are described below.
1331 @item -chardev null ,id=@var{id}
1332 A void device. This device will not emit any data, and will drop any data it
1333 receives. The null backend does not take any options.
1335 @item -chardev socket ,id=@var{id} [@var{TCP options} or @var{unix options}] [,server] [,nowait] [,telnet]
1337 Create a two-way stream socket, which can be either a TCP or a unix socket. A
1338 unix socket will be created if @option{path} is specified. Behaviour is
1339 undefined if TCP options are specified for a unix socket.
1341 @option{server} specifies that the socket shall be a listening socket.
1343 @option{nowait} specifies that QEMU should not block waiting for a client to
1344 connect to a listening socket.
1346 @option{telnet} specifies that traffic on the socket should interpret telnet
1349 TCP and unix socket options are given below:
1353 @item TCP options: port=@var{port} [,host=@var{host}] [,to=@var{to}] [,ipv4] [,ipv6] [,nodelay]
1355 @option{host} for a listening socket specifies the local address to be bound.
1356 For a connecting socket species the remote host to connect to. @option{host} is
1357 optional for listening sockets. If not specified it defaults to @code{0.0.0.0}.
1359 @option{port} for a listening socket specifies the local port to be bound. For a
1360 connecting socket specifies the port on the remote host to connect to.
1361 @option{port} can be given as either a port number or a service name.
1362 @option{port} is required.
1364 @option{to} is only relevant to listening sockets. If it is specified, and
1365 @option{port} cannot be bound, QEMU will attempt to bind to subsequent ports up
1366 to and including @option{to} until it succeeds. @option{to} must be specified
1369 @option{ipv4} and @option{ipv6} specify that either IPv4 or IPv6 must be used.
1370 If neither is specified the socket may use either protocol.
1372 @option{nodelay} disables the Nagle algorithm.
1374 @item unix options: path=@var{path}
1376 @option{path} specifies the local path of the unix socket. @option{path} is
1381 @item -chardev udp ,id=@var{id} [,host=@var{host}] ,port=@var{port} [,localaddr=@var{localaddr}] [,localport=@var{localport}] [,ipv4] [,ipv6]
1383 Sends all traffic from the guest to a remote host over UDP.
1385 @option{host} specifies the remote host to connect to. If not specified it
1386 defaults to @code{localhost}.
1388 @option{port} specifies the port on the remote host to connect to. @option{port}
1391 @option{localaddr} specifies the local address to bind to. If not specified it
1392 defaults to @code{0.0.0.0}.
1394 @option{localport} specifies the local port to bind to. If not specified any
1395 available local port will be used.
1397 @option{ipv4} and @option{ipv6} specify that either IPv4 or IPv6 must be used.
1398 If neither is specified the device may use either protocol.
1400 @item -chardev msmouse ,id=@var{id}
1402 Forward QEMU's emulated msmouse events to the guest. @option{msmouse} does not
1405 @item -chardev vc ,id=@var{id} [[,width=@var{width}] [,height=@var{height}]] [[,cols=@var{cols}] [,rows=@var{rows}]]
1407 Connect to a QEMU text console. @option{vc} may optionally be given a specific
1410 @option{width} and @option{height} specify the width and height respectively of
1411 the console, in pixels.
1413 @option{cols} and @option{rows} specify that the console be sized to fit a text
1414 console with the given dimensions.
1416 @item -chardev file ,id=@var{id} ,path=@var{path}
1418 Log all traffic received from the guest to a file.
1420 @option{path} specifies the path of the file to be opened. This file will be
1421 created if it does not already exist, and overwritten if it does. @option{path}
1424 @item -chardev pipe ,id=@var{id} ,path=@var{path}
1426 Create a two-way connection to the guest. The behaviour differs slightly between
1427 Windows hosts and other hosts:
1429 On Windows, a single duplex pipe will be created at
1430 @file{\\.pipe\@option{path}}.
1432 On other hosts, 2 pipes will be created called @file{@option{path}.in} and
1433 @file{@option{path}.out}. Data written to @file{@option{path}.in} will be
1434 received by the guest. Data written by the guest can be read from
1435 @file{@option{path}.out}. QEMU will not create these fifos, and requires them to
1438 @option{path} forms part of the pipe path as described above. @option{path} is
1441 @item -chardev console ,id=@var{id}
1443 Send traffic from the guest to QEMU's standard output. @option{console} does not
1446 @option{console} is only available on Windows hosts.
1448 @item -chardev serial ,id=@var{id} ,path=@option{path}
1450 Send traffic from the guest to a serial device on the host.
1453 only available on Windows hosts.
1455 @option{path} specifies the name of the serial device to open.
1457 @item -chardev pty ,id=@var{id}
1459 Create a new pseudo-terminal on the host and connect to it. @option{pty} does
1460 not take any options.
1462 @option{pty} is not available on Windows hosts.
1464 @item -chardev stdio ,id=@var{id} [,signal=on|off]
1465 Connect to standard input and standard output of the qemu process.
1467 @option{signal} controls if signals are enabled on the terminal, that includes
1468 exiting QEMU with the key sequence @key{Control-c}. This option is enabled by
1469 default, use @option{signal=off} to disable it.
1471 @option{stdio} is not available on Windows hosts.
1473 @item -chardev braille ,id=@var{id}
1475 Connect to a local BrlAPI server. @option{braille} does not take any options.
1477 @item -chardev tty ,id=@var{id} ,path=@var{path}
1479 Connect to a local tty device.
1481 @option{tty} is only available on Linux, Sun, FreeBSD, NetBSD, OpenBSD and
1484 @option{path} specifies the path to the tty. @option{path} is required.
1486 @item -chardev parport ,id=@var{id} ,path=@var{path}
1488 @option{parport} is only available on Linux, FreeBSD and DragonFlyBSD hosts.
1490 Connect to a local parallel port.
1492 @option{path} specifies the path to the parallel port device. @option{path} is
1500 DEFHEADING(Bluetooth(R) options:)
1502 DEF("bt
", HAS_ARG, QEMU_OPTION_bt, \
1503 "-bt hci
,null dumb bluetooth HCI
- doesn
't respond to commands\n" \
1504 "-bt hci,host[:id]\n" \
1505 " use host's HCI with the given name
\n" \
1506 "-bt hci
[,vlan
=n
]\n" \
1507 " emulate a standard HCI
in virtual scatternet
'n'\n" \
1508 "-bt vhci
[,vlan
=n
]\n" \
1509 " add host computer to virtual scatternet
'n' using VHCI
\n" \
1510 "-bt device
:dev
[,vlan
=n
]\n" \
1511 " emulate a bluetooth device
'dev' in scatternet
'n'\n",
1518 Defines the function of the corresponding Bluetooth HCI. -bt options
1519 are matched with the HCIs present in the chosen machine type. For
1520 example when emulating a machine with only one HCI built into it, only
1521 the first @code{-bt hci[...]} option is valid and defines the HCI's
1522 logic. The Transport Layer is decided by the machine type. Currently
1523 the machines @code{n800} and @code{n810} have one HCI and all other
1527 The following three types are recognized:
1531 (default) The corresponding Bluetooth HCI assumes no internal logic
1532 and will not respond to any HCI commands or emit events.
1534 @item -bt hci,host[:@var{id}]
1535 (@code{bluez} only) The corresponding HCI passes commands / events
1536 to / from the physical HCI identified by the name @var{id} (default:
1537 @code{hci0}) on the computer running QEMU. Only available on @code{bluez}
1538 capable systems like Linux.
1540 @item -bt hci[,vlan=@var{n}]
1541 Add a virtual, standard HCI that will participate in the Bluetooth
1542 scatternet @var{n} (default @code{0}). Similarly to @option{-net}
1543 VLANs, devices inside a bluetooth network @var{n} can only communicate
1544 with other devices in the same network (scatternet).
1547 @item -bt vhci[,vlan=@var{n}]
1548 (Linux-host only) Create a HCI in scatternet @var{n} (default 0) attached
1549 to the host bluetooth stack instead of to the emulated target. This
1550 allows the host and target machines to participate in a common scatternet
1551 and communicate. Requires the Linux @code{vhci} driver installed. Can
1552 be used as following:
1555 qemu [...OPTIONS...] -bt hci,vlan=5 -bt vhci,vlan=5
1558 @item -bt device:@var{dev}[,vlan=@var{n}]
1559 Emulate a bluetooth device @var{dev} and place it in network @var{n}
1560 (default @code{0}). QEMU can only emulate one type of bluetooth devices
1565 Virtual wireless keyboard implementing the HIDP bluetooth profile.
1572 DEFHEADING(Linux/Multiboot boot specific:)
1575 When using these options, you can use a given Linux or Multiboot
1576 kernel without installing it in the disk image. It can be useful
1577 for easier testing of various kernels.
1582 DEF("kernel
", HAS_ARG, QEMU_OPTION_kernel, \
1583 "-kernel bzImage use
'bzImage' as kernel image
\n", QEMU_ARCH_ALL)
1585 @item -kernel @var{bzImage}
1587 Use @var{bzImage} as kernel image. The kernel can be either a Linux kernel
1588 or in multiboot format.
1591 DEF("append
", HAS_ARG, QEMU_OPTION_append, \
1592 "-append cmdline use
'cmdline' as kernel command line
\n", QEMU_ARCH_ALL)
1594 @item -append @var{cmdline}
1596 Use @var{cmdline} as kernel command line
1599 DEF("initrd
", HAS_ARG, QEMU_OPTION_initrd, \
1600 "-initrd file use
'file' as initial ram disk
\n", QEMU_ARCH_ALL)
1602 @item -initrd @var{file}
1604 Use @var{file} as initial ram disk.
1606 @item -initrd "@
var{file1
} arg
=foo
,@
var{file2
}"
1608 This syntax is only available with multiboot.
1610 Use @var{file1} and @var{file2} as modules and pass arg=foo as parameter to the
1620 DEFHEADING(Debug/Expert options:)
1626 DEF("serial
", HAS_ARG, QEMU_OPTION_serial, \
1627 "-serial dev redirect the serial port to char device
'dev'\n",
1630 @item -serial @var{dev}
1632 Redirect the virtual serial port to host character device
1633 @var{dev}. The default device is @code{vc} in graphical mode and
1634 @code{stdio} in non graphical mode.
1636 This option can be used several times to simulate up to 4 serial
1639 Use @code{-serial none} to disable all serial ports.
1641 Available character devices are:
1643 @item vc[:@var{W}x@var{H}]
1644 Virtual console. Optionally, a width and height can be given in pixel with
1648 It is also possible to specify width or height in characters:
1653 [Linux only] Pseudo TTY (a new PTY is automatically allocated)
1655 No device is allocated.
1659 [Linux only] Use host tty, e.g. @file{/dev/ttyS0}. The host serial port
1660 parameters are set according to the emulated ones.
1661 @item /dev/parport@var{N}
1662 [Linux only, parallel port only] Use host parallel port
1663 @var{N}. Currently SPP and EPP parallel port features can be used.
1664 @item file:@var{filename}
1665 Write output to @var{filename}. No character can be read.
1667 [Unix only] standard input/output
1668 @item pipe:@var{filename}
1669 name pipe @var{filename}
1671 [Windows only] Use host serial port @var{n}
1672 @item udp:[@var{remote_host}]:@var{remote_port}[@@[@var{src_ip}]:@var{src_port}]
1673 This implements UDP Net Console.
1674 When @var{remote_host} or @var{src_ip} are not specified
1675 they default to @code{0.0.0.0}.
1676 When not using a specified @var{src_port} a random port is automatically chosen.
1678 If you just want a simple readonly console you can use @code{netcat} or
1679 @code{nc}, by starting qemu with: @code{-serial udp::4555} and nc as:
1680 @code{nc -u -l -p 4555}. Any time qemu writes something to that port it
1681 will appear in the netconsole session.
1683 If you plan to send characters back via netconsole or you want to stop
1684 and start qemu a lot of times, you should have qemu use the same
1685 source port each time by using something like @code{-serial
1686 udp::4555@@:4556} to qemu. Another approach is to use a patched
1687 version of netcat which can listen to a TCP port and send and receive
1688 characters via udp. If you have a patched version of netcat which
1689 activates telnet remote echo and single char transfer, then you can
1690 use the following options to step up a netcat redirector to allow
1691 telnet on port 5555 to access the qemu port.
1694 -serial udp::4555@@:4556
1695 @item netcat options:
1696 -u -P 4555 -L 0.0.0.0:4556 -t -p 5555 -I -T
1697 @item telnet options:
1701 @item tcp:[@var{host}]:@var{port}[,@var{server}][,nowait][,nodelay]
1702 The TCP Net Console has two modes of operation. It can send the serial
1703 I/O to a location or wait for a connection from a location. By default
1704 the TCP Net Console is sent to @var{host} at the @var{port}. If you use
1705 the @var{server} option QEMU will wait for a client socket application
1706 to connect to the port before continuing, unless the @code{nowait}
1707 option was specified. The @code{nodelay} option disables the Nagle buffering
1708 algorithm. If @var{host} is omitted, 0.0.0.0 is assumed. Only
1709 one TCP connection at a time is accepted. You can use @code{telnet} to
1710 connect to the corresponding character device.
1712 @item Example to send tcp console to 192.168.0.2 port 4444
1713 -serial tcp:192.168.0.2:4444
1714 @item Example to listen and wait on port 4444 for connection
1715 -serial tcp::4444,server
1716 @item Example to not wait and listen on ip 192.168.0.100 port 4444
1717 -serial tcp:192.168.0.100:4444,server,nowait
1720 @item telnet:@var{host}:@var{port}[,server][,nowait][,nodelay]
1721 The telnet protocol is used instead of raw tcp sockets. The options
1722 work the same as if you had specified @code{-serial tcp}. The
1723 difference is that the port acts like a telnet server or client using
1724 telnet option negotiation. This will also allow you to send the
1725 MAGIC_SYSRQ sequence if you use a telnet that supports sending the break
1726 sequence. Typically in unix telnet you do it with Control-] and then
1727 type "send
break" followed by pressing the enter key.
1729 @item unix:@var{path}[,server][,nowait]
1730 A unix domain socket is used instead of a tcp socket. The option works the
1731 same as if you had specified @code{-serial tcp} except the unix domain socket
1732 @var{path} is used for connections.
1734 @item mon:@var{dev_string}
1735 This is a special option to allow the monitor to be multiplexed onto
1736 another serial port. The monitor is accessed with key sequence of
1737 @key{Control-a} and then pressing @key{c}. See monitor access
1738 @ref{pcsys_keys} in the -nographic section for more keys.
1739 @var{dev_string} should be any one of the serial devices specified
1740 above. An example to multiplex the monitor onto a telnet server
1741 listening on port 4444 would be:
1743 @item -serial mon:telnet::4444,server,nowait
1747 Braille device. This will use BrlAPI to display the braille output on a real
1751 Three button serial mouse. Configure the guest to use Microsoft protocol.
1755 DEF("parallel
", HAS_ARG, QEMU_OPTION_parallel, \
1756 "-parallel dev redirect the parallel port to char device
'dev'\n",
1759 @item -parallel @var{dev}
1761 Redirect the virtual parallel port to host device @var{dev} (same
1762 devices as the serial port). On Linux hosts, @file{/dev/parportN} can
1763 be used to use hardware devices connected on the corresponding host
1766 This option can be used several times to simulate up to 3 parallel
1769 Use @code{-parallel none} to disable all parallel ports.
1772 DEF("monitor
", HAS_ARG, QEMU_OPTION_monitor, \
1773 "-monitor dev redirect the monitor to char device
'dev'\n",
1776 @item -monitor @var{dev}
1778 Redirect the monitor to host device @var{dev} (same devices as the
1780 The default device is @code{vc} in graphical mode and @code{stdio} in
1783 DEF("qmp
", HAS_ARG, QEMU_OPTION_qmp, \
1784 "-qmp dev like
-monitor but opens
in 'control' mode
\n",
1787 @item -qmp @var{dev}
1789 Like -monitor but opens in 'control' mode.
1792 DEF("mon
", HAS_ARG, QEMU_OPTION_mon, \
1793 "-mon chardev
=[name
][,mode
=readline|control
][,default]\n", QEMU_ARCH_ALL)
1795 @item -mon chardev=[name][,mode=readline|control][,default]
1797 Setup monitor on chardev @var{name}.
1800 DEF("debugcon
", HAS_ARG, QEMU_OPTION_debugcon, \
1801 "-debugcon dev redirect the debug console to char device
'dev'\n",
1804 @item -debugcon @var{dev}
1806 Redirect the debug console to host device @var{dev} (same devices as the
1807 serial port). The debug console is an I/O port which is typically port
1808 0xe9; writing to that I/O port sends output to this device.
1809 The default device is @code{vc} in graphical mode and @code{stdio} in
1813 DEF("pidfile
", HAS_ARG, QEMU_OPTION_pidfile, \
1814 "-pidfile file write PID to
'file'\n", QEMU_ARCH_ALL)
1816 @item -pidfile @var{file}
1818 Store the QEMU process PID in @var{file}. It is useful if you launch QEMU
1822 DEF("singlestep
", 0, QEMU_OPTION_singlestep, \
1823 "-singlestep always run
in singlestep mode
\n", QEMU_ARCH_ALL)
1827 Run the emulation in single step mode.
1830 DEF("S
", 0, QEMU_OPTION_S, \
1831 "-S freeze CPU at
startup (use
'c' to start execution
)\n",
1836 Do not start CPU at startup (you must type 'c' in the monitor).
1839 DEF("gdb
", HAS_ARG, QEMU_OPTION_gdb, \
1840 "-gdb dev wait
for gdb connection on
'dev'\n", QEMU_ARCH_ALL)
1842 @item -gdb @var{dev}
1844 Wait for gdb connection on device @var{dev} (@pxref{gdb_usage}). Typical
1845 connections will likely be TCP-based, but also UDP, pseudo TTY, or even
1846 stdio are reasonable use case. The latter is allowing to start qemu from
1847 within gdb and establish the connection via a pipe:
1849 (gdb) target remote | exec qemu -gdb stdio ...
1853 DEF("s
", 0, QEMU_OPTION_s, \
1854 "-s shorthand
for -gdb tcp
::" DEFAULT_GDBSTUB_PORT "\n",
1859 Shorthand for -gdb tcp::1234, i.e. open a gdbserver on TCP port 1234
1860 (@pxref{gdb_usage}).
1863 DEF("d
", HAS_ARG, QEMU_OPTION_d, \
1864 "-d item1
,... output log to
/tmp
/qemu
.log (use
-d ?
for a list of log items
)\n",
1869 Output log in /tmp/qemu.log
1872 DEF("hdachs
", HAS_ARG, QEMU_OPTION_hdachs, \
1873 "-hdachs c
,h
,s
[,t
]\n" \
1874 " force hard disk
0 physical geometry and the optional BIOS
\n" \
1875 " translation (t
=none or lba
) (usually qemu can guess them
)\n",
1878 @item -hdachs @var{c},@var{h},@var{s},[,@var{t}]
1880 Force hard disk 0 physical geometry (1 <= @var{c} <= 16383, 1 <=
1881 @var{h} <= 16, 1 <= @var{s} <= 63) and optionally force the BIOS
1882 translation mode (@var{t}=none, lba or auto). Usually QEMU can guess
1883 all those parameters. This option is useful for old MS-DOS disk
1887 DEF("L
", HAS_ARG, QEMU_OPTION_L, \
1888 "-L path set the directory
for the BIOS
, VGA BIOS and keymaps
\n",
1893 Set the directory for the BIOS, VGA BIOS and keymaps.
1896 DEF("bios
", HAS_ARG, QEMU_OPTION_bios, \
1897 "-bios file set the filename
for the BIOS
\n", QEMU_ARCH_ALL)
1899 @item -bios @var{file}
1901 Set the filename for the BIOS.
1904 DEF("enable
-kvm
", 0, QEMU_OPTION_enable_kvm, \
1905 "-enable
-kvm enable KVM full virtualization support
\n", QEMU_ARCH_ALL)
1909 Enable KVM full virtualization support. This option is only available
1910 if KVM support is enabled when compiling.
1913 DEF("xen
-domid
", HAS_ARG, QEMU_OPTION_xen_domid,
1914 "-xen
-domid id specify xen guest domain id
\n", QEMU_ARCH_ALL)
1915 DEF("xen
-create
", 0, QEMU_OPTION_xen_create,
1916 "-xen
-create create domain
using xen hypercalls
, bypassing xend
\n"
1917 " warning
: should not be used when xend is
in use
\n",
1919 DEF("xen
-attach
", 0, QEMU_OPTION_xen_attach,
1920 "-xen
-attach attach to existing xen domain
\n"
1921 " xend will use
this when starting qemu
\n",
1924 @item -xen-domid @var{id}
1926 Specify xen guest domain @var{id} (XEN only).
1929 Create domain using xen hypercalls, bypassing xend.
1930 Warning: should not be used when xend is in use (XEN only).
1933 Attach to existing xen domain.
1934 xend will use this when starting qemu (XEN only).
1937 DEF("no
-reboot
", 0, QEMU_OPTION_no_reboot, \
1938 "-no
-reboot exit instead of rebooting
\n", QEMU_ARCH_ALL)
1942 Exit instead of rebooting.
1945 DEF("no
-shutdown
", 0, QEMU_OPTION_no_shutdown, \
1946 "-no
-shutdown stop before shutdown
\n", QEMU_ARCH_ALL)
1949 @findex -no-shutdown
1950 Don't exit QEMU on guest shutdown, but instead only stop the emulation.
1951 This allows for instance switching to monitor to commit changes to the
1955 DEF("loadvm
", HAS_ARG, QEMU_OPTION_loadvm, \
1956 "-loadvm
[tag|id
]\n" \
1957 " start right away with a saved
state (loadvm
in monitor
)\n",
1960 @item -loadvm @var{file}
1962 Start right away with a saved state (@code{loadvm} in monitor)
1966 DEF("daemonize
", 0, QEMU_OPTION_daemonize, \
1967 "-daemonize daemonize QEMU after initializing
\n", QEMU_ARCH_ALL)
1972 Daemonize the QEMU process after initialization. QEMU will not detach from
1973 standard IO until it is ready to receive connections on any of its devices.
1974 This option is a useful way for external programs to launch QEMU without having
1975 to cope with initialization race conditions.
1978 DEF("option
-rom
", HAS_ARG, QEMU_OPTION_option_rom, \
1979 "-option
-rom rom load a file
, rom
, into the option ROM space
\n",
1982 @item -option-rom @var{file}
1984 Load the contents of @var{file} as an option ROM.
1985 This option is useful to load things like EtherBoot.
1988 DEF("clock
", HAS_ARG, QEMU_OPTION_clock, \
1989 "-clock force the use of the given methods
for timer alarm
.\n" \
1990 " To see what timers are available use
-clock ?
\n",
1993 @item -clock @var{method}
1995 Force the use of the given methods for timer alarm. To see what timers
1996 are available use -clock ?.
1999 HXCOMM Options deprecated by -rtc
2000 DEF("localtime
", 0, QEMU_OPTION_localtime, "", QEMU_ARCH_ALL)
2001 DEF("startdate
", HAS_ARG, QEMU_OPTION_startdate, "", QEMU_ARCH_ALL)
2003 DEF("rtc
", HAS_ARG, QEMU_OPTION_rtc, \
2004 "-rtc
[base
=utc|localtime|date
][,clock
=host|vm
][,driftfix
=none|slew
]\n" \
2005 " set the RTC base and clock
, enable drift fix
for clock
ticks (x86 only
)\n",
2010 @item -rtc [base=utc|localtime|@var{date}][,clock=host|vm][,driftfix=none|slew]
2012 Specify @option{base} as @code{utc} or @code{localtime} to let the RTC start at the current
2013 UTC or local time, respectively. @code{localtime} is required for correct date in
2014 MS-DOS or Windows. To start at a specific point in time, provide @var{date} in the
2015 format @code{2006-06-17T16:01:21} or @code{2006-06-17}. The default base is UTC.
2017 By default the RTC is driven by the host system time. This allows to use the
2018 RTC as accurate reference clock inside the guest, specifically if the host
2019 time is smoothly following an accurate external reference clock, e.g. via NTP.
2020 If you want to isolate the guest time from the host, even prevent it from
2021 progressing during suspension, you can set @option{clock} to @code{vm} instead.
2023 Enable @option{driftfix} (i386 targets only) if you experience time drift problems,
2024 specifically with Windows' ACPI HAL. This option will try to figure out how
2025 many timer interrupts were not processed by the Windows guest and will
2029 DEF("icount
", HAS_ARG, QEMU_OPTION_icount, \
2030 "-icount
[N|auto
]\n" \
2031 " enable virtual instruction counter with
2^N clock ticks per
\n" \
2032 " instruction
\n", QEMU_ARCH_ALL)
2034 @item -icount [@var{N}|auto]
2036 Enable virtual instruction counter. The virtual cpu will execute one
2037 instruction every 2^@var{N} ns of virtual time. If @code{auto} is specified
2038 then the virtual cpu speed will be automatically adjusted to keep virtual
2039 time within a few seconds of real time.
2041 Note that while this option can give deterministic behavior, it does not
2042 provide cycle accurate emulation. Modern CPUs contain superscalar out of
2043 order cores with complex cache hierarchies. The number of instructions
2044 executed often has little or no correlation with actual performance.
2047 DEF("watchdog
", HAS_ARG, QEMU_OPTION_watchdog, \
2048 "-watchdog i6300esb|ib700
\n" \
2049 " enable virtual hardware watchdog
[default=none
]\n",
2052 @item -watchdog @var{model}
2054 Create a virtual hardware watchdog device. Once enabled (by a guest
2055 action), the watchdog must be periodically polled by an agent inside
2056 the guest or else the guest will be restarted.
2058 The @var{model} is the model of hardware watchdog to emulate. Choices
2059 for model are: @code{ib700} (iBASE 700) which is a very simple ISA
2060 watchdog with a single timer, or @code{i6300esb} (Intel 6300ESB I/O
2061 controller hub) which is a much more featureful PCI-based dual-timer
2062 watchdog. Choose a model for which your guest has drivers.
2064 Use @code{-watchdog ?} to list available hardware models. Only one
2065 watchdog can be enabled for a guest.
2068 DEF("watchdog
-action
", HAS_ARG, QEMU_OPTION_watchdog_action, \
2069 "-watchdog
-action reset|shutdown|poweroff|pause|debug|none
\n" \
2070 " action when watchdog fires
[default=reset
]\n",
2073 @item -watchdog-action @var{action}
2075 The @var{action} controls what QEMU will do when the watchdog timer
2078 @code{reset} (forcefully reset the guest).
2079 Other possible actions are:
2080 @code{shutdown} (attempt to gracefully shutdown the guest),
2081 @code{poweroff} (forcefully poweroff the guest),
2082 @code{pause} (pause the guest),
2083 @code{debug} (print a debug message and continue), or
2084 @code{none} (do nothing).
2086 Note that the @code{shutdown} action requires that the guest responds
2087 to ACPI signals, which it may not be able to do in the sort of
2088 situations where the watchdog would have expired, and thus
2089 @code{-watchdog-action shutdown} is not recommended for production use.
2094 @item -watchdog i6300esb -watchdog-action pause
2095 @item -watchdog ib700
2099 DEF("echr
", HAS_ARG, QEMU_OPTION_echr, \
2100 "-echr chr set terminal escape character instead of ctrl
-a
\n",
2104 @item -echr @var{numeric_ascii_value}
2106 Change the escape character used for switching to the monitor when using
2107 monitor and serial sharing. The default is @code{0x01} when using the
2108 @code{-nographic} option. @code{0x01} is equal to pressing
2109 @code{Control-a}. You can select a different character from the ascii
2110 control keys where 1 through 26 map to Control-a through Control-z. For
2111 instance you could use the either of the following to change the escape
2112 character to Control-t.
2119 DEF("virtioconsole
", HAS_ARG, QEMU_OPTION_virtiocon, \
2120 "-virtioconsole c
\n" \
2121 " set virtio console
\n", QEMU_ARCH_ALL)
2123 @item -virtioconsole @var{c}
2124 @findex -virtioconsole
2127 This option is maintained for backward compatibility.
2129 Please use @code{-device virtconsole} for the new way of invocation.
2132 DEF("show
-cursor
", 0, QEMU_OPTION_show_cursor, \
2133 "-show
-cursor show cursor
\n", QEMU_ARCH_ALL)
2136 @findex -show-cursor
2140 DEF("tb
-size
", HAS_ARG, QEMU_OPTION_tb_size, \
2141 "-tb
-size n set TB size
\n", QEMU_ARCH_ALL)
2143 @item -tb-size @var{n}
2148 DEF("incoming
", HAS_ARG, QEMU_OPTION_incoming, \
2149 "-incoming p prepare
for incoming migration
, listen on port p
\n",
2152 @item -incoming @var{port}
2154 Prepare for incoming migration, listen on @var{port}.
2157 DEF("nodefaults
", 0, QEMU_OPTION_nodefaults, \
2158 "-nodefaults don
't create default devices\n", QEMU_ARCH_ALL)
2162 Don't create
default devices
.
2166 DEF("chroot", HAS_ARG
, QEMU_OPTION_chroot
, \
2167 "-chroot dir chroot to dir just before starting the VM\n",
2171 @item
-chroot @
var{dir
}
2173 Immediately before starting guest execution
, chroot to the specified
2174 directory
. Especially useful
in combination with
-runas
.
2178 DEF("runas", HAS_ARG
, QEMU_OPTION_runas
, \
2179 "-runas user change to user id user just before starting the VM\n",
2183 @item
-runas @
var{user
}
2185 Immediately before starting guest execution
, drop root privileges
, switching
2186 to the specified user
.
2189 DEF("prom-env", HAS_ARG
, QEMU_OPTION_prom_env
,
2190 "-prom-env variable=value\n"
2191 " set OpenBIOS nvram variables\n",
2192 QEMU_ARCH_PPC | QEMU_ARCH_SPARC
)
2194 @item
-prom
-env @
var{variable
}=@
var{value
}
2196 Set OpenBIOS nvram @
var{variable
} to given @
var{value
} (PPC
, SPARC only
).
2198 DEF("semihosting", 0, QEMU_OPTION_semihosting
,
2199 "-semihosting semihosting mode\n", QEMU_ARCH_ARM | QEMU_ARCH_M68K
)
2202 @findex
-semihosting
2203 Semihosting
mode (ARM
, M68K only
).
2205 DEF("old-param", 0, QEMU_OPTION_old_param
,
2206 "-old-param old param mode\n", QEMU_ARCH_ARM
)
2209 @findex
-old
-param (ARM
)
2210 Old param
mode (ARM only
).
2213 DEF("readconfig", HAS_ARG
, QEMU_OPTION_readconfig
,
2214 "-readconfig <file>\n", QEMU_ARCH_ALL
)
2216 @item
-readconfig @
var{file
}
2218 Read device configuration from @
var{file
}.
2220 DEF("writeconfig", HAS_ARG
, QEMU_OPTION_writeconfig
,
2221 "-writeconfig <file>\n"
2222 " read/write config file\n", QEMU_ARCH_ALL
)
2224 @item
-writeconfig @
var{file
}
2225 @findex
-writeconfig
2226 Write device configuration to @
var{file
}.
2228 DEF("nodefconfig", 0, QEMU_OPTION_nodefconfig
,
2230 " do not load default config files at startup\n",
2234 @findex
-nodefconfig
2235 Normally QEMU loads a configuration file from @
var{sysconfdir
}/qemu
.conf and
2236 @
var{sysconfdir
}/target
-@
var{ARCH
}.conf on startup
. The @code
{-nodefconfig
}
2237 option will prevent QEMU from loading these configuration files at startup
.
2240 DEF("no-kvm", 0, QEMU_OPTION_no_kvm
,
2241 "-no-kvm disable KVM hardware virtualization\n",
2243 DEF("no-kvm-irqchip", 0, QEMU_OPTION_no_kvm_irqchip
,
2244 "-no-kvm-irqchip disable KVM kernel mode PIC/IOAPIC/LAPIC\n",
2246 DEF("no-kvm-pit", 0, QEMU_OPTION_no_kvm_pit
,
2247 "-no-kvm-pit disable KVM kernel mode PIT\n",
2249 DEF("no-kvm-pit-reinjection", 0, QEMU_OPTION_no_kvm_pit_reinjection
,
2250 "-no-kvm-pit-reinjection\n"
2251 " disable KVM kernel mode PIT interrupt reinjection\n",
2253 DEF("pcidevice", HAS_ARG
, QEMU_OPTION_pcidevice
,
2254 "-pcidevice host=[seg:]bus:dev.func[,dma=none][,name=string]\n"
2255 " expose a PCI device to the guest OS\n"
2256 " dma=none: don't perform any dma translations (default is to use an iommu)\n"
2257 " 'string' is used in log output\n", QEMU_ARCH_I386
)
2258 DEF("enable-nesting", 0, QEMU_OPTION_enable_nesting
,
2259 "-enable-nesting enable support for running a VM inside the VM (AMD only)\n", QEMU_ARCH_I386
)
2260 DEF("nvram", HAS_ARG
, QEMU_OPTION_nvram
,
2261 "-nvram FILE provide ia64 nvram contents\n", QEMU_ARCH_ALL
)
2262 DEF("tdf", 0, QEMU_OPTION_tdf
,
2263 "-tdf enable guest time drift compensation\n", QEMU_ARCH_ALL
)
2264 DEF("kvm-shadow-memory", HAS_ARG
, QEMU_OPTION_kvm_shadow_memory
,
2265 "-kvm-shadow-memory MEGABYTES\n"
2266 " allocate MEGABYTES for kvm mmu shadowing\n",
2269 HXCOMM This is the last statement
. Insert
new options before
this line
!