1 HXCOMM Use
DEFHEADING() to define headings
in both help text and texi
2 HXCOMM Text between STEXI and ETEXI are copied to texi version and
3 HXCOMM discarded from C version
4 HXCOMM
DEF(option
, HAS_ARG
/0, opt_enum
, opt_help
, arch_mask
) is used to
5 HXCOMM construct option structures
, enums and help message
for specified
7 HXCOMM HXCOMM can be used
for comments
, discarded from both texi and C
9 DEFHEADING(Standard options
:)
14 DEF("help", 0, QEMU_OPTION_h
,
15 "-h or -help display this help and exit\n", QEMU_ARCH_ALL
)
22 DEF("version", 0, QEMU_OPTION_version
,
23 "-version display version information and exit\n", QEMU_ARCH_ALL
)
27 Display version information and exit
30 DEF("M", HAS_ARG
, QEMU_OPTION_M
,
31 "-M machine select emulated machine (-M ? for list)\n", QEMU_ARCH_ALL
)
33 @item
-M @
var{machine
}
35 Select the emulated @
var{machine
} (@code
{-M ?
} for list
)
38 DEF("cpu", HAS_ARG
, QEMU_OPTION_cpu
,
39 "-cpu cpu select CPU (-cpu ? for list)\n", QEMU_ARCH_ALL
)
41 @item
-cpu @
var{model
}
43 Select CPU
model (-cpu ?
for list and additional feature selection
)
46 DEF("smp", HAS_ARG
, QEMU_OPTION_smp
,
47 "-smp n[,maxcpus=cpus][,cores=cores][,threads=threads][,sockets=sockets]\n"
48 " set the number of CPUs to 'n' [default=1]\n"
49 " maxcpus= maximum number of total cpus, including\n"
50 " offline CPUs for hotplug, etc\n"
51 " cores= number of CPU cores on one socket\n"
52 " threads= number of threads on one CPU core\n"
53 " sockets= number of discrete sockets in the system\n",
56 @item
-smp @
var{n
}[,cores
=@
var{cores
}][,threads
=@
var{threads
}][,sockets
=@
var{sockets
}][,maxcpus
=@
var{maxcpus
}]
58 Simulate an SMP system with @
var{n
} CPUs
. On the PC target
, up to
255
59 CPUs are supported
. On Sparc32 target
, Linux limits the number of usable CPUs
61 For the PC target
, the number of @
var{cores
} per socket
, the number
62 of @
var{threads
} per cores and the total number of @
var{sockets
} can be
63 specified
. Missing values will be computed
. If any on the three values is
64 given
, the total number of CPUs @
var{n
} can be omitted
. @
var{maxcpus
}
65 specifies the maximum number of hotpluggable CPUs
.
68 DEF("numa", HAS_ARG
, QEMU_OPTION_numa
,
69 "-numa node[,mem=size][,cpus=cpu[-cpu]][,nodeid=node]\n", QEMU_ARCH_ALL
)
71 @item
-numa @
var{opts
}
73 Simulate a multi node NUMA system
. If mem and cpus are omitted
, resources
77 DEF("fda", HAS_ARG
, QEMU_OPTION_fda
,
78 "-fda/-fdb file use 'file' as floppy disk 0/1 image\n", QEMU_ARCH_ALL
)
79 DEF("fdb", HAS_ARG
, QEMU_OPTION_fdb
, "", QEMU_ARCH_ALL
)
85 Use @
var{file
} as floppy disk
0/1 image (@pxref
{disk_images
}). You can
86 use the host floppy by
using @file
{/dev
/fd0
} as
filename (@pxref
{host_drives
}).
89 DEF("hda", HAS_ARG
, QEMU_OPTION_hda
,
90 "-hda/-hdb file use 'file' as IDE hard disk 0/1 image\n", QEMU_ARCH_ALL
)
91 DEF("hdb", HAS_ARG
, QEMU_OPTION_hdb
, "", QEMU_ARCH_ALL
)
92 DEF("hdc", HAS_ARG
, QEMU_OPTION_hdc
,
93 "-hdc/-hdd file use 'file' as IDE hard disk 2/3 image\n", QEMU_ARCH_ALL
)
94 DEF("hdd", HAS_ARG
, QEMU_OPTION_hdd
, "", QEMU_ARCH_ALL
)
104 Use @
var{file
} as hard disk
0, 1, 2 or
3 image (@pxref
{disk_images
}).
107 DEF("cdrom", HAS_ARG
, QEMU_OPTION_cdrom
,
108 "-cdrom file use 'file' as IDE cdrom image (cdrom is ide1 master)\n",
111 @item
-cdrom @
var{file
}
113 Use @
var{file
} as CD
-ROM
image (you cannot use @option
{-hdc
} and
114 @option
{-cdrom
} at the same time
). You can use the host CD
-ROM by
115 using @file
{/dev
/cdrom
} as
filename (@pxref
{host_drives
}).
118 DEF("drive", HAS_ARG
, QEMU_OPTION_drive
,
119 "-drive [file=file][,if=type][,bus=n][,unit=m][,media=d][,index=i]\n"
120 " [,cyls=c,heads=h,secs=s[,trans=t]][,snapshot=on|off]\n"
121 " [,cache=writethrough|writeback|none|unsafe][,format=f]\n"
122 " [,serial=s][,addr=A][,id=name][,aio=threads|native]\n"
123 " [,readonly=on|off]\n"
124 " use 'file' as a drive image\n", QEMU_ARCH_ALL
)
126 @item
-drive @
var{option
}[,@
var{option
}[,@
var{option
}[,...]]]
129 Define a
new drive
. Valid options are
:
132 @item file
=@
var{file
}
133 This option defines which disk
image (@pxref
{disk_images
}) to use with
134 this drive
. If the filename contains comma
, you must double it
135 (for instance
, "file=my,,file" to use file
"my,file").
136 @item
if=@
var{interface}
137 This option defines on which type on
interface the drive is connected
.
138 Available types are
: ide
, scsi
, sd
, mtd
, floppy
, pflash
, virtio
.
139 @item bus
=@
var{bus
},unit
=@
var{unit
}
140 These options define where is connected the drive by defining the bus number and
142 @item index
=@
var{index
}
143 This option defines where is connected the drive by
using an index
in the list
144 of available connectors of a given
interface type
.
145 @item media
=@
var{media
}
146 This option defines the type of the media
: disk or cdrom
.
147 @item cyls
=@
var{c
},heads
=@
var{h
},secs
=@
var{s
}[,trans
=@
var{t
}]
148 These options have the same definition as they have
in @option
{-hdachs
}.
149 @item snapshot
=@
var{snapshot
}
150 @
var{snapshot
} is
"on" or
"off" and allows to enable snapshot
for given
drive (see @option
{-snapshot
}).
151 @item cache
=@
var{cache
}
152 @
var{cache
} is
"none", "writeback", "unsafe", or
"writethrough" and controls how the host cache is used to access block data
.
154 @
var{aio
} is
"threads", or
"native" and selects between pthread based disk I
/O and native Linux AIO
.
155 @item format
=@
var{format
}
156 Specify which disk @
var{format
} will be used rather than detecting
157 the format
. Can be used to specifiy format
=raw to avoid interpreting
158 an untrusted format header
.
159 @item serial
=@
var{serial
}
160 This option specifies the serial number to assign to the device
.
161 @item addr
=@
var{addr
}
162 Specify the controller
's PCI address (if=virtio only).
165 By default, writethrough caching is used for all block device. This means that
166 the host page cache will be used to read and write data but write notification
167 will be sent to the guest only when the data has been reported as written by
168 the storage subsystem.
170 Writeback caching will report data writes as completed as soon as the data is
171 present in the host page cache. This is safe as long as you trust your host.
172 If your host crashes or loses power, then the guest may experience data
175 The host page cache can be avoided entirely with @option{cache=none}. This will
176 attempt to do disk IO directly to the guests memory. QEMU may still perform
177 an internal copy of the data.
179 Some block drivers perform badly with @option{cache=writethrough}, most notably,
180 qcow2. If performance is more important than correctness,
181 @option{cache=writeback} should be used with qcow2.
183 In case you don't care about data integrity over host failures
, use
184 cache
=unsafe
. This option tells qemu that it
never needs to write any data
185 to the disk but can instead keeps things
in cache
. If anything goes wrong
,
186 like your host losing power
, the disk storage getting disconnected accidently
,
187 etc
. you
're image will most probably be rendered unusable. When using
188 the @option{-snapshot} option, unsafe caching is always used.
190 Instead of @option{-cdrom} you can use:
192 qemu -drive file=file,index=2,media=cdrom
195 Instead of @option{-hda}, @option{-hdb}, @option{-hdc}, @option{-hdd}, you can
198 qemu -drive file=file,index=0,media=disk
199 qemu -drive file=file,index=1,media=disk
200 qemu -drive file=file,index=2,media=disk
201 qemu -drive file=file,index=3,media=disk
204 You can connect a CDROM to the slave of ide0:
206 qemu -drive file=file,if=ide,index=1,media=cdrom
209 If you don't specify the
"file=" argument
, you define an empty drive
:
211 qemu
-drive
if=ide
,index
=1,media
=cdrom
214 You can connect a SCSI disk with unit ID
6 on the bus #
0:
216 qemu
-drive file
=file
,if=scsi
,bus
=0,unit
=6
219 Instead of @option
{-fda
}, @option
{-fdb
}, you can use
:
221 qemu
-drive file
=file
,index
=0,if=floppy
222 qemu
-drive file
=file
,index
=1,if=floppy
225 By
default, @
var{interface} is
"ide" and @
var{index
} is automatically
228 qemu
-drive file
=a
-drive file
=b
"
236 DEF("set
", HAS_ARG, QEMU_OPTION_set,
237 "-set group
.id
.arg
=value
\n"
238 " set
<arg
> parameter
for item
<id
> of type
<group
>\n"
239 " i
.e
. -set drive
.$id
.file
=/path
/to
/image
\n", QEMU_ARCH_ALL)
246 DEF("global
", HAS_ARG, QEMU_OPTION_global,
247 "-global driver
.property
=value
\n"
248 " set a global
default for a driver property
\n",
256 DEF("mtdblock
", HAS_ARG, QEMU_OPTION_mtdblock,
257 "-mtdblock file use
'file' as on
-board Flash memory image
\n",
260 @item -mtdblock @var{file}
262 Use @var{file} as on-board Flash memory image.
265 DEF("sd
", HAS_ARG, QEMU_OPTION_sd,
266 "-sd file use
'file' as SecureDigital card image
\n", QEMU_ARCH_ALL)
270 Use @var{file} as SecureDigital card image.
273 DEF("pflash
", HAS_ARG, QEMU_OPTION_pflash,
274 "-pflash file use
'file' as a parallel flash image
\n", QEMU_ARCH_ALL)
276 @item -pflash @var{file}
278 Use @var{file} as a parallel flash image.
281 DEF("boot
", HAS_ARG, QEMU_OPTION_boot,
282 "-boot
[order
=drives
][,once
=drives
][,menu
=on|off
]\n"
283 " 'drives': floppy (a
), hard
disk (c
), CD
-ROM (d
), network (n
)\n",
286 @item -boot [order=@var{drives}][,once=@var{drives}][,menu=on|off]
288 Specify boot order @var{drives} as a string of drive letters. Valid
289 drive letters depend on the target achitecture. The x86 PC uses: a, b
290 (floppy 1 and 2), c (first hard disk), d (first CD-ROM), n-p (Etherboot
291 from network adapter 1-4), hard disk boot is the default. To apply a
292 particular boot order only on the first startup, specify it via
295 Interactive boot menus/prompts can be enabled via @option{menu=on} as far
296 as firmware/BIOS supports them. The default is non-interactive boot.
299 # try to boot from network first, then from hard disk
301 # boot from CD-ROM first, switch back to default order after reboot
305 Note: The legacy format '-boot @var{drives}' is still supported but its
306 use is discouraged as it may be removed from future versions.
309 DEF("snapshot
", 0, QEMU_OPTION_snapshot,
310 "-snapshot write to temporary files instead of disk image files
\n",
315 Write to temporary files instead of disk image files. In this case,
316 the raw disk image you use is not written back. You can however force
317 the write back by pressing @key{C-a s} (@pxref{disk_images}).
320 DEF("m
", HAS_ARG, QEMU_OPTION_m,
321 "-m megs set virtual RAM size to megs MB
[default="
322 stringify(DEFAULT_RAM_SIZE) "]\n", QEMU_ARCH_ALL)
326 Set virtual RAM size to @var{megs} megabytes. Default is 128 MiB. Optionally,
327 a suffix of ``M'' or ``G'' can be used to signify a value in megabytes or
328 gigabytes respectively.
331 DEF("mem
-path
", HAS_ARG, QEMU_OPTION_mempath,
332 "-mem
-path FILE provide backing storage
for guest RAM
\n", QEMU_ARCH_ALL)
334 @item -mem-path @var{path}
335 Allocate guest RAM from a temporarily created file in @var{path}.
339 DEF("mem
-prealloc
", 0, QEMU_OPTION_mem_prealloc,
340 "-mem
-prealloc preallocate guest
memory (use with
-mem
-path
)\n",
344 Preallocate memory when using -mem-path.
348 DEF("k
", HAS_ARG, QEMU_OPTION_k,
349 "-k language use keyboard
layout (for example
'fr' for French
)\n",
352 @item -k @var{language}
354 Use keyboard layout @var{language} (for example @code{fr} for
355 French). This option is only needed where it is not easy to get raw PC
356 keycodes (e.g. on Macs, with some X11 servers or with a VNC
357 display). You don't normally need to use it on PC/Linux or PC/Windows
360 The available layouts are:
362 ar de-ch es fo fr-ca hu ja mk no pt-br sv
363 da en-gb et fr fr-ch is lt nl pl ru th
364 de en-us fi fr-be hr it lv nl-be pt sl tr
367 The default is @code{en-us}.
371 DEF("audio
-help
", 0, QEMU_OPTION_audio_help,
372 "-audio
-help print list of audio drivers and their options
\n",
377 Will show the audio subsystem help: list of drivers, tunable
381 DEF("soundhw
", HAS_ARG, QEMU_OPTION_soundhw,
382 "-soundhw c1
,... enable audio support
\n"
383 " and only specified sound
cards (comma separated list
)\n"
384 " use
-soundhw ? to get the list of supported cards
\n"
385 " use
-soundhw all to enable all of them
\n", QEMU_ARCH_ALL)
387 @item -soundhw @var{card1}[,@var{card2},...] or -soundhw all
389 Enable audio and selected sound hardware. Use ? to print all
390 available sound hardware.
393 qemu -soundhw sb16,adlib disk.img
394 qemu -soundhw es1370 disk.img
395 qemu -soundhw ac97 disk.img
396 qemu -soundhw all disk.img
400 Note that Linux's i810_audio OSS kernel (for AC97) module might
401 require manually specifying clocking.
404 modprobe i810_audio clocking=48000
412 DEF("usb
", 0, QEMU_OPTION_usb,
413 "-usb enable the USB
driver (will be the
default soon
)\n",
421 Enable the USB driver (will be the default soon)
424 DEF("usbdevice
", HAS_ARG, QEMU_OPTION_usbdevice,
425 "-usbdevice name add the host or guest USB device
'name'\n",
429 @item -usbdevice @var{devname}
431 Add the USB device @var{devname}. @xref{usb_devices}.
436 Virtual Mouse. This will override the PS/2 mouse emulation when activated.
439 Pointer device that uses absolute coordinates (like a touchscreen). This
440 means qemu is able to report the mouse position without having to grab the
441 mouse. Also overrides the PS/2 mouse emulation when activated.
443 @item disk:[format=@var{format}]:@var{file}
444 Mass storage device based on file. The optional @var{format} argument
445 will be used rather than detecting the format. Can be used to specifiy
446 @code{format=raw} to avoid interpreting an untrusted format header.
448 @item host:@var{bus}.@var{addr}
449 Pass through the host device identified by @var{bus}.@var{addr} (Linux only).
451 @item host:@var{vendor_id}:@var{product_id}
452 Pass through the host device identified by @var{vendor_id}:@var{product_id}
455 @item serial:[vendorid=@var{vendor_id}][,productid=@var{product_id}]:@var{dev}
456 Serial converter to host character device @var{dev}, see @code{-serial} for the
460 Braille device. This will use BrlAPI to display the braille output on a real
463 @item net:@var{options}
464 Network adapter that supports CDC ethernet and RNDIS protocols.
469 DEF("device
", HAS_ARG, QEMU_OPTION_device,
470 "-device driver
[,prop
[=value
][,...]]\n"
471 " add
device (based on driver
)\n"
472 " prop
=value
,... sets driver properties
\n"
473 " use
-device ? to print all possible drivers
\n"
474 " use
-device driver
,? to print all possible properties
\n",
477 @item -device @var{driver}[,@var{prop}[=@var{value}][,...]]
479 Add device @var{driver}. @var{prop}=@var{value} sets driver
480 properties. Valid properties depend on the driver. To get help on
481 possible drivers and properties, use @code{-device ?} and
482 @code{-device @var{driver},?}.
485 DEFHEADING(File system options:)
487 DEF("fsdev
", HAS_ARG, QEMU_OPTION_fsdev,
488 "-fsdev local
,id
=id
,path
=path
,security_model
=[mapped|passthrough|none
]\n",
493 The general form of a File system device option is:
496 @item -fsdev @var{fstype} ,id=@var{id} [,@var{options}]
500 The specific Fstype will determine the applicable options.
502 Options to each backend are described below.
504 @item -fsdev local ,id=@var{id} ,path=@var{path} ,security_model=@var{security_model}
506 Create a file-system-"device
" for local-filesystem.
508 @option{local} is only available on Linux.
510 @option{path} specifies the path to be exported. @option{path} is required.
512 @option{security_model} specifies the security model to be followed.
513 @option{security_model} is required.
518 DEFHEADING(Virtual File system pass-through options:)
520 DEF("virtfs
", HAS_ARG, QEMU_OPTION_virtfs,
521 "-virtfs local
,path
=path
,mount_tag
=tag
,security_model
=[mapped|passthrough|none
]\n",
526 The general form of a Virtual File system pass-through option is:
529 @item -virtfs @var{fstype} [,@var{options}]
533 The specific Fstype will determine the applicable options.
535 Options to each backend are described below.
537 @item -virtfs local ,path=@var{path} ,mount_tag=@var{mount_tag} ,security_model=@var{security_model}
539 Create a Virtual file-system-pass through for local-filesystem.
541 @option{local} is only available on Linux.
543 @option{path} specifies the path to be exported. @option{path} is required.
545 @option{security_model} specifies the security model to be followed.
546 @option{security_model} is required.
549 @option{mount_tag} specifies the tag with which the exported file is mounted.
550 @option{mount_tag} is required.
557 DEF("name
", HAS_ARG, QEMU_OPTION_name,
558 "-name string1
[,process
=string2
]\n"
559 " set the name of the guest
\n"
560 " string1 sets the window title and string2 the process
name (on Linux
)\n",
563 @item -name @var{name}
565 Sets the @var{name} of the guest.
566 This name will be displayed in the SDL window caption.
567 The @var{name} will also be used for the VNC server.
568 Also optionally set the top visible process name in Linux.
571 DEF("uuid
", HAS_ARG, QEMU_OPTION_uuid,
572 "-uuid
%08x
-%04x
-%04x
-%04x
-%012x
\n"
573 " specify machine UUID
\n", QEMU_ARCH_ALL)
575 @item -uuid @var{uuid}
586 DEFHEADING(Display options:)
592 DEF("nographic
", 0, QEMU_OPTION_nographic,
593 "-nographic disable graphical output and redirect serial I
/Os to console
\n",
598 Normally, QEMU uses SDL to display the VGA output. With this option,
599 you can totally disable graphical output so that QEMU is a simple
600 command line application. The emulated serial port is redirected on
601 the console. Therefore, you can still use QEMU to debug a Linux kernel
602 with a serial console.
606 DEF("curses
", 0, QEMU_OPTION_curses,
607 "-curses use a curses
/ncurses
interface instead of SDL
\n",
613 Normally, QEMU uses SDL to display the VGA output. With this option,
614 QEMU can display the VGA output when in text mode using a
615 curses/ncurses interface. Nothing is displayed in graphical mode.
619 DEF("no
-frame
", 0, QEMU_OPTION_no_frame,
620 "-no
-frame open SDL window without a frame and window decorations
\n",
626 Do not use decorations for SDL windows and start them using the whole
627 available screen space. This makes the using QEMU in a dedicated desktop
628 workspace more convenient.
632 DEF("alt
-grab
", 0, QEMU_OPTION_alt_grab,
633 "-alt
-grab use Ctrl
-Alt
-Shift to grab
mouse (instead of Ctrl
-Alt
)\n",
639 Use Ctrl-Alt-Shift to grab mouse (instead of Ctrl-Alt).
643 DEF("ctrl
-grab
", 0, QEMU_OPTION_ctrl_grab,
644 "-ctrl
-grab use Right
-Ctrl to grab
mouse (instead of Ctrl
-Alt
)\n",
650 Use Right-Ctrl to grab mouse (instead of Ctrl-Alt).
654 DEF("no
-quit
", 0, QEMU_OPTION_no_quit,
655 "-no
-quit disable SDL window close capability
\n", QEMU_ARCH_ALL)
660 Disable SDL window close capability.
664 DEF("sdl
", 0, QEMU_OPTION_sdl,
665 "-sdl enable SDL
\n", QEMU_ARCH_ALL)
673 DEF("spice
", HAS_ARG, QEMU_OPTION_spice,
674 "-spice
<args
> enable spice
\n", QEMU_ARCH_ALL)
676 @item -spice @var{option}[,@var{option}[,...]]
678 Enable the spice remote desktop protocol. Valid options are
683 Set the TCP port spice is listening on for plaintext channels.
686 Set the IP address spice is listening on. Default is any address.
690 Force using the specified IP version.
692 @item password=<secret>
693 Set the password you need to authenticate.
695 @item disable-ticketing
696 Allow client connects without authentication.
699 Set the TCP port spice is listening on for encrypted channels.
702 Set the x509 file directory. Expects same filenames as -vnc $display,x509=$dir
704 @item x509-key-file=<file>
705 @item x509-key-password=<file>
706 @item x509-cert-file=<file>
707 @item x509-cacert-file=<file>
708 @item x509-dh-key-file=<file>
709 The x509 file names can also be configured individually.
711 @item tls-ciphers=<list>
712 Specify which ciphers to use.
714 @item tls-channel=[main|display|inputs|record|playback|tunnel]
715 @item plaintext-channel=[main|display|inputs|record|playback|tunnel]
716 Force specific channel to be used with or without TLS encryption. The
717 options can be specified multiple times to configure multiple
718 channels. The special name "default" can be used to set the default
719 mode. For channels which are not explicitly forced into one mode the
720 spice client is allowed to pick tls/plaintext as he pleases.
722 @item image-compression=[auto_glz|auto_lz|quic|glz|lz|off]
723 Configure image compression (lossless).
726 @item jpeg-wan-compression=[auto|never|always]
727 @item zlib-glz-wan-compression=[auto|never|always]
728 Configure wan image compression (lossy for slow links).
731 @item streaming-video=[off|all|filter]
732 Configure video stream detection. Default is filter.
734 @item agent-mouse=[on|off]
735 Enable/disable passing mouse events via vdagent. Default is on.
737 @item playback-compression=[on|off]
738 Enable/disable audio stream compression (using celt 0.5.1). Default is on.
743 DEF("portrait
", 0, QEMU_OPTION_portrait,
744 "-portrait rotate graphical output
90 deg
left (only PXA LCD
)\n",
749 Rotate graphical output 90 deg left (only PXA LCD).
752 DEF("vga
", HAS_ARG, QEMU_OPTION_vga,
753 "-vga
[std|cirrus|vmware|xenfb|none
]\n"
754 " select video card type
\n", QEMU_ARCH_ALL)
756 @item -vga @var{type}
758 Select type of VGA card to emulate. Valid values for @var{type} are
761 Cirrus Logic GD5446 Video card. All Windows versions starting from
762 Windows 95 should recognize and use this graphic card. For optimal
763 performances, use 16 bit color depth in the guest and the host OS.
764 (This one is the default)
766 Standard VGA card with Bochs VBE extensions. If your guest OS
767 supports the VESA 2.0 VBE extensions (e.g. Windows XP) and if you want
768 to use high resolution modes (>= 1280x1024x16) then you should use
771 VMWare SVGA-II compatible adapter. Use it if you have sufficiently
772 recent XFree86/XOrg server or Windows guest with a driver for this
779 DEF("full
-screen
", 0, QEMU_OPTION_full_screen,
780 "-full
-screen start
in full screen
\n", QEMU_ARCH_ALL)
784 Start in full screen.
787 DEF("g
", 1, QEMU_OPTION_g ,
788 "-g WxH
[xDEPTH
] Set the initial graphical resolution and depth
\n",
789 QEMU_ARCH_PPC | QEMU_ARCH_SPARC)
791 @item -g @var{width}x@var{height}[x@var{depth}]
793 Set the initial graphical resolution and depth (PPC, SPARC only).
796 DEF("vnc
", HAS_ARG, QEMU_OPTION_vnc ,
797 "-vnc display start a VNC server on display
\n", QEMU_ARCH_ALL)
799 @item -vnc @var{display}[,@var{option}[,@var{option}[,...]]]
801 Normally, QEMU uses SDL to display the VGA output. With this option,
802 you can have QEMU listen on VNC display @var{display} and redirect the VGA
803 display over the VNC session. It is very useful to enable the usb
804 tablet device when using this option (option @option{-usbdevice
805 tablet}). When using the VNC display, you must use the @option{-k}
806 parameter to set the keyboard layout if you are not using en-us. Valid
807 syntax for the @var{display} is
811 @item @var{host}:@var{d}
813 TCP connections will only be allowed from @var{host} on display @var{d}.
814 By convention the TCP port is 5900+@var{d}. Optionally, @var{host} can
815 be omitted in which case the server will accept connections from any host.
817 @item unix:@var{path}
819 Connections will be allowed over UNIX domain sockets where @var{path} is the
820 location of a unix socket to listen for connections on.
824 VNC is initialized but not started. The monitor @code{change} command
825 can be used to later start the VNC server.
829 Following the @var{display} value there may be one or more @var{option} flags
830 separated by commas. Valid options are
836 Connect to a listening VNC client via a ``reverse'' connection. The
837 client is specified by the @var{display}. For reverse network
838 connections (@var{host}:@var{d},@code{reverse}), the @var{d} argument
839 is a TCP port number, not a display number.
843 Require that password based authentication is used for client connections.
844 The password must be set separately using the @code{change} command in the
849 Require that client use TLS when communicating with the VNC server. This
850 uses anonymous TLS credentials so is susceptible to a man-in-the-middle
851 attack. It is recommended that this option be combined with either the
852 @option{x509} or @option{x509verify} options.
854 @item x509=@var{/path/to/certificate/dir}
856 Valid if @option{tls} is specified. Require that x509 credentials are used
857 for negotiating the TLS session. The server will send its x509 certificate
858 to the client. It is recommended that a password be set on the VNC server
859 to provide authentication of the client when this is used. The path following
860 this option specifies where the x509 certificates are to be loaded from.
861 See the @ref{vnc_security} section for details on generating certificates.
863 @item x509verify=@var{/path/to/certificate/dir}
865 Valid if @option{tls} is specified. Require that x509 credentials are used
866 for negotiating the TLS session. The server will send its x509 certificate
867 to the client, and request that the client send its own x509 certificate.
868 The server will validate the client's certificate against the CA certificate,
869 and reject clients when validation fails. If the certificate authority is
870 trusted, this is a sufficient authentication mechanism. You may still wish
871 to set a password on the VNC server as a second authentication layer. The
872 path following this option specifies where the x509 certificates are to
873 be loaded from. See the @ref{vnc_security} section for details on generating
878 Require that the client use SASL to authenticate with the VNC server.
879 The exact choice of authentication method used is controlled from the
880 system / user's SASL configuration file for the 'qemu' service. This
881 is typically found in /etc/sasl2/qemu.conf. If running QEMU as an
882 unprivileged user, an environment variable SASL_CONF_PATH can be used
883 to make it search alternate locations for the service config.
884 While some SASL auth methods can also provide data encryption (eg GSSAPI),
885 it is recommended that SASL always be combined with the 'tls' and
886 'x509' settings to enable use of SSL and server certificates. This
887 ensures a data encryption preventing compromise of authentication
888 credentials. See the @ref{vnc_security} section for details on using
893 Turn on access control lists for checking of the x509 client certificate
894 and SASL party. For x509 certs, the ACL check is made against the
895 certificate's distinguished name. This is something that looks like
896 @code{C=GB,O=ACME,L=Boston,CN=bob}. For SASL party, the ACL check is
897 made against the username, which depending on the SASL plugin, may
898 include a realm component, eg @code{bob} or @code{bob@@EXAMPLE.COM}.
899 When the @option{acl} flag is set, the initial access list will be
900 empty, with a @code{deny} policy. Thus no one will be allowed to
901 use the VNC server until the ACLs have been loaded. This can be
902 achieved using the @code{acl} monitor command.
906 Enable lossy compression methods (gradient, JPEG, ...). If this
907 option is set, VNC client may receive lossy framebuffer updates
908 depending on its encoding settings. Enabling this option can save
909 a lot of bandwidth at the expense of quality.
920 DEFHEADING(i386 target only:)
925 DEF("win2k
-hack
", 0, QEMU_OPTION_win2k_hack,
926 "-win2k
-hack use it when installing Windows
2000 to avoid a disk full bug
\n",
931 Use it when installing Windows 2000 to avoid a disk full bug. After
932 Windows 2000 is installed, you no longer need this option (this option
933 slows down the IDE transfers).
936 HXCOMM Deprecated by -rtc
937 DEF("rtc
-td
-hack
", 0, QEMU_OPTION_rtc_td_hack, "", QEMU_ARCH_I386)
939 DEF("no
-fd
-bootchk
", 0, QEMU_OPTION_no_fd_bootchk,
940 "-no
-fd
-bootchk disable boot signature checking
for floppy disks
\n",
944 @findex -no-fd-bootchk
945 Disable boot signature checking for floppy disks in Bochs BIOS. It may
946 be needed to boot from old floppy disks.
947 TODO: check reference to Bochs BIOS.
950 DEF("no
-acpi
", 0, QEMU_OPTION_no_acpi,
951 "-no
-acpi disable ACPI
\n", QEMU_ARCH_I386)
955 Disable ACPI (Advanced Configuration and Power Interface) support. Use
956 it if your guest OS complains about ACPI problems (PC target machine
960 DEF("no
-hpet
", 0, QEMU_OPTION_no_hpet,
961 "-no
-hpet disable HPET
\n", QEMU_ARCH_I386)
965 Disable HPET support.
968 DEF("balloon
", HAS_ARG, QEMU_OPTION_balloon,
969 "-balloon none disable balloon device
\n"
970 "-balloon virtio
[,addr
=str
]\n"
971 " enable virtio balloon
device (default)\n", QEMU_ARCH_ALL)
975 Disable balloon device.
976 @item -balloon virtio[,addr=@var{addr}]
977 Enable virtio balloon device (default), optionally with PCI address
981 DEF("acpitable
", HAS_ARG, QEMU_OPTION_acpitable,
982 "-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"
983 " ACPI table description
\n", QEMU_ARCH_I386)
985 @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}]...]
987 Add ACPI table with specified header fields and context from specified files.
990 DEF("smbios
", HAS_ARG, QEMU_OPTION_smbios,
991 "-smbios file
=binary
\n"
992 " load SMBIOS entry from binary file
\n"
993 "-smbios type
=0[,vendor
=str
][,version
=str
][,date
=str
][,release
=%d
.%d
]\n"
994 " specify SMBIOS type
0 fields
\n"
995 "-smbios type
=1[,manufacturer
=str
][,product
=str
][,version
=str
][,serial
=str
]\n"
996 " [,uuid
=uuid
][,sku
=str
][,family
=str
]\n"
997 " specify SMBIOS type
1 fields
\n", QEMU_ARCH_I386)
999 @item -smbios file=@var{binary}
1001 Load SMBIOS entry from binary file.
1003 @item -smbios type=0[,vendor=@var{str}][,version=@var{str}][,date=@var{str}][,release=@var{%d.%d}]
1005 Specify SMBIOS type 0 fields
1007 @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}]
1008 Specify SMBIOS type 1 fields
1016 DEFHEADING(Network options:)
1021 HXCOMM Legacy slirp options (now moved to -net user):
1023 DEF("tftp
", HAS_ARG, QEMU_OPTION_tftp, "", QEMU_ARCH_ALL)
1024 DEF("bootp
", HAS_ARG, QEMU_OPTION_bootp, "", QEMU_ARCH_ALL)
1025 DEF("redir
", HAS_ARG, QEMU_OPTION_redir, "", QEMU_ARCH_ALL)
1027 DEF("smb
", HAS_ARG, QEMU_OPTION_smb, "", QEMU_ARCH_ALL)
1031 DEF("net
", HAS_ARG, QEMU_OPTION_net,
1032 "-net nic
[,vlan
=n
][,macaddr
=mac
][,model
=type
][,name
=str
][,addr
=str
][,vectors
=v
]\n"
1033 " create a
new Network Interface Card and connect it to VLAN
'n'\n"
1035 "-net user
[,vlan
=n
][,name
=str
][,net
=addr
[/mask
]][,host
=addr
][,restrict
=y|n
]\n"
1036 " [,hostname
=host
][,dhcpstart
=addr
][,dns
=addr
][,tftp
=dir
][,bootfile
=f
]\n"
1037 " [,hostfwd
=rule
][,guestfwd
=rule
]"
1039 "[,smb
=dir
[,smbserver
=addr
]]\n"
1041 " connect the user mode network stack to VLAN
'n', configure its
\n"
1042 " DHCP server and enabled optional services
\n"
1045 "-net tap
[,vlan
=n
][,name
=str
],ifname
=name
\n"
1046 " connect the host TAP network
interface to VLAN
'n'\n"
1048 "-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"
1049 " connect the host TAP network
interface to VLAN
'n' and use the
\n"
1050 " network scripts
'file' (default=" DEFAULT_NETWORK_SCRIPT ")\n"
1051 " and
'dfile' (default=" DEFAULT_NETWORK_DOWN_SCRIPT ")\n"
1052 " use
'[down]script=no' to disable script execution
\n"
1053 " use
'fd=h' to connect to an already opened TAP
interface\n"
1054 " use
'sndbuf=nbytes' to limit the size of the send
buffer (the
\n"
1055 " default of
'sndbuf=1048576' can be disabled
using 'sndbuf=0')\n"
1056 " use vnet_hdr
=off to avoid enabling the IFF_VNET_HDR tap flag
\n"
1057 " use vnet_hdr
=on to make the lack of IFF_VNET_HDR support an error condition
\n"
1058 " use vhost
=on to enable experimental
in kernel accelerator
\n"
1059 " use
'vhostfd=h' to connect to an already opened vhost net device
\n"
1061 "-net socket
[,vlan
=n
][,name
=str
][,fd
=h
][,listen
=[host
]:port
][,connect
=host
:port
]\n"
1062 " connect the vlan
'n' to another VLAN
using a socket connection
\n"
1063 "-net socket
[,vlan
=n
][,name
=str
][,fd
=h
][,mcast
=maddr
:port
]\n"
1064 " connect the vlan
'n' to multicast maddr and port
\n"
1066 "-net vde
[,vlan
=n
][,name
=str
][,sock
=socketpath
][,port
=n
][,group
=groupname
][,mode
=octalmode
]\n"
1067 " connect the vlan
'n' to port
'n' of a vde
switch running
\n"
1068 " on host and listening
for incoming connections on
'socketpath'.\n"
1069 " Use group
'groupname' and mode
'octalmode' to change
default\n"
1070 " ownership and permissions
for communication port
.\n"
1072 "-net dump
[,vlan
=n
][,file
=f
][,len
=n
]\n"
1073 " dump traffic on vlan
'n' to file
'f' (max n bytes per packet
)\n"
1074 "-net none use it alone to have zero network devices
. If no
-net option
\n"
1075 " is provided
, the
default is
'-net nic -net user'\n", QEMU_ARCH_ALL)
1076 DEF("netdev
", HAS_ARG, QEMU_OPTION_netdev,
1085 "socket
],id
=str
[,option
][,option
][,...]\n", QEMU_ARCH_ALL)
1087 @item -net nic[,vlan=@var{n}][,macaddr=@var{mac}][,model=@var{type}] [,name=@var{name}][,addr=@var{addr}][,vectors=@var{v}]
1089 Create a new Network Interface Card and connect it to VLAN @var{n} (@var{n}
1090 = 0 is the default). The NIC is an e1000 by default on the PC
1091 target. Optionally, the MAC address can be changed to @var{mac}, the
1092 device address set to @var{addr} (PCI cards only),
1093 and a @var{name} can be assigned for use in monitor commands.
1094 Optionally, for PCI cards, you can specify the number @var{v} of MSI-X vectors
1095 that the card should have; this option currently only affects virtio cards; set
1096 @var{v} = 0 to disable MSI-X. If no @option{-net} option is specified, a single
1097 NIC is created. Qemu can emulate several different models of network card.
1098 Valid values for @var{type} are
1099 @code{virtio}, @code{i82551}, @code{i82557b}, @code{i82559er},
1100 @code{ne2k_pci}, @code{ne2k_isa}, @code{pcnet}, @code{rtl8139},
1101 @code{e1000}, @code{smc91c111}, @code{lance} and @code{mcf_fec}.
1102 Not all devices are supported on all targets. Use -net nic,model=?
1103 for a list of available devices for your target.
1105 @item -net user[,@var{option}][,@var{option}][,...]
1106 Use the user mode network stack which requires no administrator
1107 privilege to run. Valid options are:
1111 Connect user mode stack to VLAN @var{n} (@var{n} = 0 is the default).
1113 @item name=@var{name}
1114 Assign symbolic name for use in monitor commands.
1116 @item net=@var{addr}[/@var{mask}]
1117 Set IP network address the guest will see. Optionally specify the netmask,
1118 either in the form a.b.c.d or as number of valid top-most bits. Default is
1121 @item host=@var{addr}
1122 Specify the guest-visible address of the host. Default is the 2nd IP in the
1123 guest network, i.e. x.x.x.2.
1125 @item restrict=y|yes|n|no
1126 If this options is enabled, the guest will be isolated, i.e. it will not be
1127 able to contact the host and no guest IP packets will be routed over the host
1128 to the outside. This option does not affect explicitly set forwarding rule.
1130 @item hostname=@var{name}
1131 Specifies the client hostname reported by the builtin DHCP server.
1133 @item dhcpstart=@var{addr}
1134 Specify the first of the 16 IPs the built-in DHCP server can assign. Default
1135 is the 16th to 31st IP in the guest network, i.e. x.x.x.16 to x.x.x.31.
1137 @item dns=@var{addr}
1138 Specify the guest-visible address of the virtual nameserver. The address must
1139 be different from the host address. Default is the 3rd IP in the guest network,
1142 @item tftp=@var{dir}
1143 When using the user mode network stack, activate a built-in TFTP
1144 server. The files in @var{dir} will be exposed as the root of a TFTP server.
1145 The TFTP client on the guest must be configured in binary mode (use the command
1146 @code{bin} of the Unix TFTP client).
1148 @item bootfile=@var{file}
1149 When using the user mode network stack, broadcast @var{file} as the BOOTP
1150 filename. In conjunction with @option{tftp}, this can be used to network boot
1151 a guest from a local directory.
1153 Example (using pxelinux):
1155 qemu -hda linux.img -boot n -net user,tftp=/path/to/tftp/files,bootfile=/pxelinux.0
1158 @item smb=@var{dir}[,smbserver=@var{addr}]
1159 When using the user mode network stack, activate a built-in SMB
1160 server so that Windows OSes can access to the host files in @file{@var{dir}}
1161 transparently. The IP address of the SMB server can be set to @var{addr}. By
1162 default the 4th IP in the guest network is used, i.e. x.x.x.4.
1164 In the guest Windows OS, the line:
1168 must be added in the file @file{C:\WINDOWS\LMHOSTS} (for windows 9x/Me)
1169 or @file{C:\WINNT\SYSTEM32\DRIVERS\ETC\LMHOSTS} (Windows NT/2000).
1171 Then @file{@var{dir}} can be accessed in @file{\\smbserver\qemu}.
1173 Note that a SAMBA server must be installed on the host OS in
1174 @file{/usr/sbin/smbd}. QEMU was tested successfully with smbd versions from
1175 Red Hat 9, Fedora Core 3 and OpenSUSE 11.x.
1177 @item hostfwd=[tcp|udp]:[@var{hostaddr}]:@var{hostport}-[@var{guestaddr}]:@var{guestport}
1178 Redirect incoming TCP or UDP connections to the host port @var{hostport} to
1179 the guest IP address @var{guestaddr} on guest port @var{guestport}. If
1180 @var{guestaddr} is not specified, its value is x.x.x.15 (default first address
1181 given by the built-in DHCP server). By specifying @var{hostaddr}, the rule can
1182 be bound to a specific host interface. If no connection type is set, TCP is
1183 used. This option can be given multiple times.
1185 For example, to redirect host X11 connection from screen 1 to guest
1186 screen 0, use the following:
1190 qemu -net user,hostfwd=tcp:127.0.0.1:6001-:6000 [...]
1191 # this host xterm should open in the guest X11 server
1195 To redirect telnet connections from host port 5555 to telnet port on
1196 the guest, use the following:
1200 qemu -net user,hostfwd=tcp::5555-:23 [...]
1201 telnet localhost 5555
1204 Then when you use on the host @code{telnet localhost 5555}, you
1205 connect to the guest telnet server.
1207 @item guestfwd=[tcp]:@var{server}:@var{port}-@var{dev}
1208 Forward guest TCP connections to the IP address @var{server} on port @var{port}
1209 to the character device @var{dev}. This option can be given multiple times.
1213 Note: Legacy stand-alone options -tftp, -bootp, -smb and -redir are still
1214 processed and applied to -net user. Mixing them with the new configuration
1215 syntax gives undefined results. Their use for new applications is discouraged
1216 as they will be removed from future versions.
1218 @item -net tap[,vlan=@var{n}][,name=@var{name}][,fd=@var{h}][,ifname=@var{name}] [,script=@var{file}][,downscript=@var{dfile}]
1219 Connect the host TAP network interface @var{name} to VLAN @var{n}, use
1220 the network script @var{file} to configure it and the network script
1221 @var{dfile} to deconfigure it. If @var{name} is not provided, the OS
1222 automatically provides one. @option{fd}=@var{h} can be used to specify
1223 the handle of an already opened host TAP interface. The default network
1224 configure script is @file{/etc/qemu-ifup} and the default network
1225 deconfigure script is @file{/etc/qemu-ifdown}. Use @option{script=no}
1226 or @option{downscript=no} to disable script execution. Example:
1229 qemu linux.img -net nic -net tap
1232 More complicated example (two NICs, each one connected to a TAP device)
1234 qemu linux.img -net nic,vlan=0 -net tap,vlan=0,ifname=tap0 \
1235 -net nic,vlan=1 -net tap,vlan=1,ifname=tap1
1238 @item -net socket[,vlan=@var{n}][,name=@var{name}][,fd=@var{h}] [,listen=[@var{host}]:@var{port}][,connect=@var{host}:@var{port}]
1240 Connect the VLAN @var{n} to a remote VLAN in another QEMU virtual
1241 machine using a TCP socket connection. If @option{listen} is
1242 specified, QEMU waits for incoming connections on @var{port}
1243 (@var{host} is optional). @option{connect} is used to connect to
1244 another QEMU instance using the @option{listen} option. @option{fd}=@var{h}
1245 specifies an already opened TCP socket.
1249 # launch a first QEMU instance
1250 qemu linux.img -net nic,macaddr=52:54:00:12:34:56 \
1251 -net socket,listen=:1234
1252 # connect the VLAN 0 of this instance to the VLAN 0
1253 # of the first instance
1254 qemu linux.img -net nic,macaddr=52:54:00:12:34:57 \
1255 -net socket,connect=127.0.0.1:1234
1258 @item -net socket[,vlan=@var{n}][,name=@var{name}][,fd=@var{h}] [,mcast=@var{maddr}:@var{port}]
1260 Create a VLAN @var{n} shared with another QEMU virtual
1261 machines using a UDP multicast socket, effectively making a bus for
1262 every QEMU with same multicast address @var{maddr} and @var{port}.
1266 Several QEMU can be running on different hosts and share same bus (assuming
1267 correct multicast setup for these hosts).
1269 mcast support is compatible with User Mode Linux (argument @option{eth@var{N}=mcast}), see
1270 @url{http://user-mode-linux.sf.net}.
1272 Use @option{fd=h} to specify an already opened UDP multicast socket.
1277 # launch one QEMU instance
1278 qemu linux.img -net nic,macaddr=52:54:00:12:34:56 \
1279 -net socket,mcast=230.0.0.1:1234
1280 # launch another QEMU instance on same "bus
"
1281 qemu linux.img -net nic,macaddr=52:54:00:12:34:57 \
1282 -net socket,mcast=230.0.0.1:1234
1283 # launch yet another QEMU instance on same "bus
"
1284 qemu linux.img -net nic,macaddr=52:54:00:12:34:58 \
1285 -net socket,mcast=230.0.0.1:1234
1288 Example (User Mode Linux compat.):
1290 # launch QEMU instance (note mcast address selected
1292 qemu linux.img -net nic,macaddr=52:54:00:12:34:56 \
1293 -net socket,mcast=239.192.168.1:1102
1295 /path/to/linux ubd0=/path/to/root_fs eth0=mcast
1298 @item -net vde[,vlan=@var{n}][,name=@var{name}][,sock=@var{socketpath}] [,port=@var{n}][,group=@var{groupname}][,mode=@var{octalmode}]
1299 Connect VLAN @var{n} to PORT @var{n} of a vde switch running on host and
1300 listening for incoming connections on @var{socketpath}. Use GROUP @var{groupname}
1301 and MODE @var{octalmode} to change default ownership and permissions for
1302 communication port. This option is available only if QEMU has been compiled
1303 with vde support enabled.
1308 vde_switch -F -sock /tmp/myswitch
1309 # launch QEMU instance
1310 qemu linux.img -net nic -net vde,sock=/tmp/myswitch
1313 @item -net dump[,vlan=@var{n}][,file=@var{file}][,len=@var{len}]
1314 Dump network traffic on VLAN @var{n} to file @var{file} (@file{qemu-vlan0.pcap} by default).
1315 At most @var{len} bytes (64k by default) per packet are stored. The file format is
1316 libpcap, so it can be analyzed with tools such as tcpdump or Wireshark.
1319 Indicate that no network devices should be configured. It is used to
1320 override the default configuration (@option{-net nic -net user}) which
1321 is activated if no @option{-net} options are provided.
1328 DEFHEADING(Character device options:)
1330 DEF("chardev
", HAS_ARG, QEMU_OPTION_chardev,
1331 "-chardev
null,id
=id
[,mux
=on|off
]\n"
1332 "-chardev socket
,id
=id
[,host
=host
],port
=host
[,to
=to
][,ipv4
][,ipv6
][,nodelay
]\n"
1333 " [,server
][,nowait
][,telnet
][,mux
=on|off
] (tcp
)\n"
1334 "-chardev socket
,id
=id
,path
=path
[,server
][,nowait
][,telnet
],[mux
=on|off
] (unix
)\n"
1335 "-chardev udp
,id
=id
[,host
=host
],port
=port
[,localaddr
=localaddr
]\n"
1336 " [,localport
=localport
][,ipv4
][,ipv6
][,mux
=on|off
]\n"
1337 "-chardev msmouse
,id
=id
[,mux
=on|off
]\n"
1338 "-chardev vc
,id
=id
[[,width
=width
][,height
=height
]][[,cols
=cols
][,rows
=rows
]]\n"
1340 "-chardev file
,id
=id
,path
=path
[,mux
=on|off
]\n"
1341 "-chardev pipe
,id
=id
,path
=path
[,mux
=on|off
]\n"
1343 "-chardev console
,id
=id
[,mux
=on|off
]\n"
1344 "-chardev serial
,id
=id
,path
=path
[,mux
=on|off
]\n"
1346 "-chardev pty
,id
=id
[,mux
=on|off
]\n"
1347 "-chardev stdio
,id
=id
[,mux
=on|off
][,signal
=on|off
]\n"
1349 #ifdef CONFIG_BRLAPI
1350 "-chardev braille
,id
=id
[,mux
=on|off
]\n"
1352 #if defined(__linux__) || defined(__sun__) || defined(__FreeBSD__) \
1353 || defined(__NetBSD__) || defined(__OpenBSD__) || defined(__DragonFly__)
1354 "-chardev tty
,id
=id
,path
=path
[,mux
=on|off
]\n"
1356 #if defined(__linux__) || defined(__FreeBSD__) || defined(__DragonFly__)
1357 "-chardev parport
,id
=id
,path
=path
[,mux
=on|off
]\n"
1364 The general form of a character device option is:
1367 @item -chardev @var{backend} ,id=@var{id} [,mux=on|off] [,@var{options}]
1384 The specific backend will determine the applicable options.
1386 All devices must have an id, which can be any string up to 127 characters long.
1387 It is used to uniquely identify this device in other command line directives.
1389 A character device may be used in multiplexing mode by multiple front-ends.
1390 The key sequence of @key{Control-a} and @key{c} will rotate the input focus
1391 between attached front-ends. Specify @option{mux=on} to enable this mode.
1393 Options to each backend are described below.
1395 @item -chardev null ,id=@var{id}
1396 A void device. This device will not emit any data, and will drop any data it
1397 receives. The null backend does not take any options.
1399 @item -chardev socket ,id=@var{id} [@var{TCP options} or @var{unix options}] [,server] [,nowait] [,telnet]
1401 Create a two-way stream socket, which can be either a TCP or a unix socket. A
1402 unix socket will be created if @option{path} is specified. Behaviour is
1403 undefined if TCP options are specified for a unix socket.
1405 @option{server} specifies that the socket shall be a listening socket.
1407 @option{nowait} specifies that QEMU should not block waiting for a client to
1408 connect to a listening socket.
1410 @option{telnet} specifies that traffic on the socket should interpret telnet
1413 TCP and unix socket options are given below:
1417 @item TCP options: port=@var{port} [,host=@var{host}] [,to=@var{to}] [,ipv4] [,ipv6] [,nodelay]
1419 @option{host} for a listening socket specifies the local address to be bound.
1420 For a connecting socket species the remote host to connect to. @option{host} is
1421 optional for listening sockets. If not specified it defaults to @code{0.0.0.0}.
1423 @option{port} for a listening socket specifies the local port to be bound. For a
1424 connecting socket specifies the port on the remote host to connect to.
1425 @option{port} can be given as either a port number or a service name.
1426 @option{port} is required.
1428 @option{to} is only relevant to listening sockets. If it is specified, and
1429 @option{port} cannot be bound, QEMU will attempt to bind to subsequent ports up
1430 to and including @option{to} until it succeeds. @option{to} must be specified
1433 @option{ipv4} and @option{ipv6} specify that either IPv4 or IPv6 must be used.
1434 If neither is specified the socket may use either protocol.
1436 @option{nodelay} disables the Nagle algorithm.
1438 @item unix options: path=@var{path}
1440 @option{path} specifies the local path of the unix socket. @option{path} is
1445 @item -chardev udp ,id=@var{id} [,host=@var{host}] ,port=@var{port} [,localaddr=@var{localaddr}] [,localport=@var{localport}] [,ipv4] [,ipv6]
1447 Sends all traffic from the guest to a remote host over UDP.
1449 @option{host} specifies the remote host to connect to. If not specified it
1450 defaults to @code{localhost}.
1452 @option{port} specifies the port on the remote host to connect to. @option{port}
1455 @option{localaddr} specifies the local address to bind to. If not specified it
1456 defaults to @code{0.0.0.0}.
1458 @option{localport} specifies the local port to bind to. If not specified any
1459 available local port will be used.
1461 @option{ipv4} and @option{ipv6} specify that either IPv4 or IPv6 must be used.
1462 If neither is specified the device may use either protocol.
1464 @item -chardev msmouse ,id=@var{id}
1466 Forward QEMU's emulated msmouse events to the guest. @option{msmouse} does not
1469 @item -chardev vc ,id=@var{id} [[,width=@var{width}] [,height=@var{height}]] [[,cols=@var{cols}] [,rows=@var{rows}]]
1471 Connect to a QEMU text console. @option{vc} may optionally be given a specific
1474 @option{width} and @option{height} specify the width and height respectively of
1475 the console, in pixels.
1477 @option{cols} and @option{rows} specify that the console be sized to fit a text
1478 console with the given dimensions.
1480 @item -chardev file ,id=@var{id} ,path=@var{path}
1482 Log all traffic received from the guest to a file.
1484 @option{path} specifies the path of the file to be opened. This file will be
1485 created if it does not already exist, and overwritten if it does. @option{path}
1488 @item -chardev pipe ,id=@var{id} ,path=@var{path}
1490 Create a two-way connection to the guest. The behaviour differs slightly between
1491 Windows hosts and other hosts:
1493 On Windows, a single duplex pipe will be created at
1494 @file{\\.pipe\@option{path}}.
1496 On other hosts, 2 pipes will be created called @file{@option{path}.in} and
1497 @file{@option{path}.out}. Data written to @file{@option{path}.in} will be
1498 received by the guest. Data written by the guest can be read from
1499 @file{@option{path}.out}. QEMU will not create these fifos, and requires them to
1502 @option{path} forms part of the pipe path as described above. @option{path} is
1505 @item -chardev console ,id=@var{id}
1507 Send traffic from the guest to QEMU's standard output. @option{console} does not
1510 @option{console} is only available on Windows hosts.
1512 @item -chardev serial ,id=@var{id} ,path=@option{path}
1514 Send traffic from the guest to a serial device on the host.
1517 only available on Windows hosts.
1519 @option{path} specifies the name of the serial device to open.
1521 @item -chardev pty ,id=@var{id}
1523 Create a new pseudo-terminal on the host and connect to it. @option{pty} does
1524 not take any options.
1526 @option{pty} is not available on Windows hosts.
1528 @item -chardev stdio ,id=@var{id} [,signal=on|off]
1529 Connect to standard input and standard output of the qemu process.
1531 @option{signal} controls if signals are enabled on the terminal, that includes
1532 exiting QEMU with the key sequence @key{Control-c}. This option is enabled by
1533 default, use @option{signal=off} to disable it.
1535 @option{stdio} is not available on Windows hosts.
1537 @item -chardev braille ,id=@var{id}
1539 Connect to a local BrlAPI server. @option{braille} does not take any options.
1541 @item -chardev tty ,id=@var{id} ,path=@var{path}
1543 Connect to a local tty device.
1545 @option{tty} is only available on Linux, Sun, FreeBSD, NetBSD, OpenBSD and
1548 @option{path} specifies the path to the tty. @option{path} is required.
1550 @item -chardev parport ,id=@var{id} ,path=@var{path}
1552 @option{parport} is only available on Linux, FreeBSD and DragonFlyBSD hosts.
1554 Connect to a local parallel port.
1556 @option{path} specifies the path to the parallel port device. @option{path} is
1564 DEFHEADING(Bluetooth(R) options:)
1566 DEF("bt
", HAS_ARG, QEMU_OPTION_bt, \
1567 "-bt hci
,null dumb bluetooth HCI
- doesn
't respond to commands\n" \
1568 "-bt hci,host[:id]\n" \
1569 " use host's HCI with the given name
\n" \
1570 "-bt hci
[,vlan
=n
]\n" \
1571 " emulate a standard HCI
in virtual scatternet
'n'\n" \
1572 "-bt vhci
[,vlan
=n
]\n" \
1573 " add host computer to virtual scatternet
'n' using VHCI
\n" \
1574 "-bt device
:dev
[,vlan
=n
]\n" \
1575 " emulate a bluetooth device
'dev' in scatternet
'n'\n",
1582 Defines the function of the corresponding Bluetooth HCI. -bt options
1583 are matched with the HCIs present in the chosen machine type. For
1584 example when emulating a machine with only one HCI built into it, only
1585 the first @code{-bt hci[...]} option is valid and defines the HCI's
1586 logic. The Transport Layer is decided by the machine type. Currently
1587 the machines @code{n800} and @code{n810} have one HCI and all other
1591 The following three types are recognized:
1595 (default) The corresponding Bluetooth HCI assumes no internal logic
1596 and will not respond to any HCI commands or emit events.
1598 @item -bt hci,host[:@var{id}]
1599 (@code{bluez} only) The corresponding HCI passes commands / events
1600 to / from the physical HCI identified by the name @var{id} (default:
1601 @code{hci0}) on the computer running QEMU. Only available on @code{bluez}
1602 capable systems like Linux.
1604 @item -bt hci[,vlan=@var{n}]
1605 Add a virtual, standard HCI that will participate in the Bluetooth
1606 scatternet @var{n} (default @code{0}). Similarly to @option{-net}
1607 VLANs, devices inside a bluetooth network @var{n} can only communicate
1608 with other devices in the same network (scatternet).
1611 @item -bt vhci[,vlan=@var{n}]
1612 (Linux-host only) Create a HCI in scatternet @var{n} (default 0) attached
1613 to the host bluetooth stack instead of to the emulated target. This
1614 allows the host and target machines to participate in a common scatternet
1615 and communicate. Requires the Linux @code{vhci} driver installed. Can
1616 be used as following:
1619 qemu [...OPTIONS...] -bt hci,vlan=5 -bt vhci,vlan=5
1622 @item -bt device:@var{dev}[,vlan=@var{n}]
1623 Emulate a bluetooth device @var{dev} and place it in network @var{n}
1624 (default @code{0}). QEMU can only emulate one type of bluetooth devices
1629 Virtual wireless keyboard implementing the HIDP bluetooth profile.
1636 DEFHEADING(Linux/Multiboot boot specific:)
1639 When using these options, you can use a given Linux or Multiboot
1640 kernel without installing it in the disk image. It can be useful
1641 for easier testing of various kernels.
1646 DEF("kernel
", HAS_ARG, QEMU_OPTION_kernel, \
1647 "-kernel bzImage use
'bzImage' as kernel image
\n", QEMU_ARCH_ALL)
1649 @item -kernel @var{bzImage}
1651 Use @var{bzImage} as kernel image. The kernel can be either a Linux kernel
1652 or in multiboot format.
1655 DEF("append
", HAS_ARG, QEMU_OPTION_append, \
1656 "-append cmdline use
'cmdline' as kernel command line
\n", QEMU_ARCH_ALL)
1658 @item -append @var{cmdline}
1660 Use @var{cmdline} as kernel command line
1663 DEF("initrd
", HAS_ARG, QEMU_OPTION_initrd, \
1664 "-initrd file use
'file' as initial ram disk
\n", QEMU_ARCH_ALL)
1666 @item -initrd @var{file}
1668 Use @var{file} as initial ram disk.
1670 @item -initrd "@
var{file1
} arg
=foo
,@
var{file2
}"
1672 This syntax is only available with multiboot.
1674 Use @var{file1} and @var{file2} as modules and pass arg=foo as parameter to the
1684 DEFHEADING(Debug/Expert options:)
1690 DEF("serial
", HAS_ARG, QEMU_OPTION_serial, \
1691 "-serial dev redirect the serial port to char device
'dev'\n",
1694 @item -serial @var{dev}
1696 Redirect the virtual serial port to host character device
1697 @var{dev}. The default device is @code{vc} in graphical mode and
1698 @code{stdio} in non graphical mode.
1700 This option can be used several times to simulate up to 4 serial
1703 Use @code{-serial none} to disable all serial ports.
1705 Available character devices are:
1707 @item vc[:@var{W}x@var{H}]
1708 Virtual console. Optionally, a width and height can be given in pixel with
1712 It is also possible to specify width or height in characters:
1717 [Linux only] Pseudo TTY (a new PTY is automatically allocated)
1719 No device is allocated.
1723 [Linux only] Use host tty, e.g. @file{/dev/ttyS0}. The host serial port
1724 parameters are set according to the emulated ones.
1725 @item /dev/parport@var{N}
1726 [Linux only, parallel port only] Use host parallel port
1727 @var{N}. Currently SPP and EPP parallel port features can be used.
1728 @item file:@var{filename}
1729 Write output to @var{filename}. No character can be read.
1731 [Unix only] standard input/output
1732 @item pipe:@var{filename}
1733 name pipe @var{filename}
1735 [Windows only] Use host serial port @var{n}
1736 @item udp:[@var{remote_host}]:@var{remote_port}[@@[@var{src_ip}]:@var{src_port}]
1737 This implements UDP Net Console.
1738 When @var{remote_host} or @var{src_ip} are not specified
1739 they default to @code{0.0.0.0}.
1740 When not using a specified @var{src_port} a random port is automatically chosen.
1742 If you just want a simple readonly console you can use @code{netcat} or
1743 @code{nc}, by starting qemu with: @code{-serial udp::4555} and nc as:
1744 @code{nc -u -l -p 4555}. Any time qemu writes something to that port it
1745 will appear in the netconsole session.
1747 If you plan to send characters back via netconsole or you want to stop
1748 and start qemu a lot of times, you should have qemu use the same
1749 source port each time by using something like @code{-serial
1750 udp::4555@@:4556} to qemu. Another approach is to use a patched
1751 version of netcat which can listen to a TCP port and send and receive
1752 characters via udp. If you have a patched version of netcat which
1753 activates telnet remote echo and single char transfer, then you can
1754 use the following options to step up a netcat redirector to allow
1755 telnet on port 5555 to access the qemu port.
1758 -serial udp::4555@@:4556
1759 @item netcat options:
1760 -u -P 4555 -L 0.0.0.0:4556 -t -p 5555 -I -T
1761 @item telnet options:
1765 @item tcp:[@var{host}]:@var{port}[,@var{server}][,nowait][,nodelay]
1766 The TCP Net Console has two modes of operation. It can send the serial
1767 I/O to a location or wait for a connection from a location. By default
1768 the TCP Net Console is sent to @var{host} at the @var{port}. If you use
1769 the @var{server} option QEMU will wait for a client socket application
1770 to connect to the port before continuing, unless the @code{nowait}
1771 option was specified. The @code{nodelay} option disables the Nagle buffering
1772 algorithm. If @var{host} is omitted, 0.0.0.0 is assumed. Only
1773 one TCP connection at a time is accepted. You can use @code{telnet} to
1774 connect to the corresponding character device.
1776 @item Example to send tcp console to 192.168.0.2 port 4444
1777 -serial tcp:192.168.0.2:4444
1778 @item Example to listen and wait on port 4444 for connection
1779 -serial tcp::4444,server
1780 @item Example to not wait and listen on ip 192.168.0.100 port 4444
1781 -serial tcp:192.168.0.100:4444,server,nowait
1784 @item telnet:@var{host}:@var{port}[,server][,nowait][,nodelay]
1785 The telnet protocol is used instead of raw tcp sockets. The options
1786 work the same as if you had specified @code{-serial tcp}. The
1787 difference is that the port acts like a telnet server or client using
1788 telnet option negotiation. This will also allow you to send the
1789 MAGIC_SYSRQ sequence if you use a telnet that supports sending the break
1790 sequence. Typically in unix telnet you do it with Control-] and then
1791 type "send
break" followed by pressing the enter key.
1793 @item unix:@var{path}[,server][,nowait]
1794 A unix domain socket is used instead of a tcp socket. The option works the
1795 same as if you had specified @code{-serial tcp} except the unix domain socket
1796 @var{path} is used for connections.
1798 @item mon:@var{dev_string}
1799 This is a special option to allow the monitor to be multiplexed onto
1800 another serial port. The monitor is accessed with key sequence of
1801 @key{Control-a} and then pressing @key{c}. See monitor access
1802 @ref{pcsys_keys} in the -nographic section for more keys.
1803 @var{dev_string} should be any one of the serial devices specified
1804 above. An example to multiplex the monitor onto a telnet server
1805 listening on port 4444 would be:
1807 @item -serial mon:telnet::4444,server,nowait
1811 Braille device. This will use BrlAPI to display the braille output on a real
1815 Three button serial mouse. Configure the guest to use Microsoft protocol.
1819 DEF("parallel
", HAS_ARG, QEMU_OPTION_parallel, \
1820 "-parallel dev redirect the parallel port to char device
'dev'\n",
1823 @item -parallel @var{dev}
1825 Redirect the virtual parallel port to host device @var{dev} (same
1826 devices as the serial port). On Linux hosts, @file{/dev/parportN} can
1827 be used to use hardware devices connected on the corresponding host
1830 This option can be used several times to simulate up to 3 parallel
1833 Use @code{-parallel none} to disable all parallel ports.
1836 DEF("monitor
", HAS_ARG, QEMU_OPTION_monitor, \
1837 "-monitor dev redirect the monitor to char device
'dev'\n",
1840 @item -monitor @var{dev}
1842 Redirect the monitor to host device @var{dev} (same devices as the
1844 The default device is @code{vc} in graphical mode and @code{stdio} in
1847 DEF("qmp
", HAS_ARG, QEMU_OPTION_qmp, \
1848 "-qmp dev like
-monitor but opens
in 'control' mode
\n",
1851 @item -qmp @var{dev}
1853 Like -monitor but opens in 'control' mode.
1856 DEF("mon
", HAS_ARG, QEMU_OPTION_mon, \
1857 "-mon chardev
=[name
][,mode
=readline|control
][,default]\n", QEMU_ARCH_ALL)
1859 @item -mon chardev=[name][,mode=readline|control][,default]
1861 Setup monitor on chardev @var{name}.
1864 DEF("debugcon
", HAS_ARG, QEMU_OPTION_debugcon, \
1865 "-debugcon dev redirect the debug console to char device
'dev'\n",
1868 @item -debugcon @var{dev}
1870 Redirect the debug console to host device @var{dev} (same devices as the
1871 serial port). The debug console is an I/O port which is typically port
1872 0xe9; writing to that I/O port sends output to this device.
1873 The default device is @code{vc} in graphical mode and @code{stdio} in
1877 DEF("pidfile
", HAS_ARG, QEMU_OPTION_pidfile, \
1878 "-pidfile file write PID to
'file'\n", QEMU_ARCH_ALL)
1880 @item -pidfile @var{file}
1882 Store the QEMU process PID in @var{file}. It is useful if you launch QEMU
1886 DEF("singlestep
", 0, QEMU_OPTION_singlestep, \
1887 "-singlestep always run
in singlestep mode
\n", QEMU_ARCH_ALL)
1891 Run the emulation in single step mode.
1894 DEF("S
", 0, QEMU_OPTION_S, \
1895 "-S freeze CPU at
startup (use
'c' to start execution
)\n",
1900 Do not start CPU at startup (you must type 'c' in the monitor).
1903 DEF("gdb
", HAS_ARG, QEMU_OPTION_gdb, \
1904 "-gdb dev wait
for gdb connection on
'dev'\n", QEMU_ARCH_ALL)
1906 @item -gdb @var{dev}
1908 Wait for gdb connection on device @var{dev} (@pxref{gdb_usage}). Typical
1909 connections will likely be TCP-based, but also UDP, pseudo TTY, or even
1910 stdio are reasonable use case. The latter is allowing to start qemu from
1911 within gdb and establish the connection via a pipe:
1913 (gdb) target remote | exec qemu -gdb stdio ...
1917 DEF("s
", 0, QEMU_OPTION_s, \
1918 "-s shorthand
for -gdb tcp
::" DEFAULT_GDBSTUB_PORT "\n",
1923 Shorthand for -gdb tcp::1234, i.e. open a gdbserver on TCP port 1234
1924 (@pxref{gdb_usage}).
1927 DEF("d
", HAS_ARG, QEMU_OPTION_d, \
1928 "-d item1
,... output log to
/tmp
/qemu
.log (use
-d ?
for a list of log items
)\n",
1933 Output log in /tmp/qemu.log
1936 DEF("hdachs
", HAS_ARG, QEMU_OPTION_hdachs, \
1937 "-hdachs c
,h
,s
[,t
]\n" \
1938 " force hard disk
0 physical geometry and the optional BIOS
\n" \
1939 " translation (t
=none or lba
) (usually qemu can guess them
)\n",
1942 @item -hdachs @var{c},@var{h},@var{s},[,@var{t}]
1944 Force hard disk 0 physical geometry (1 <= @var{c} <= 16383, 1 <=
1945 @var{h} <= 16, 1 <= @var{s} <= 63) and optionally force the BIOS
1946 translation mode (@var{t}=none, lba or auto). Usually QEMU can guess
1947 all those parameters. This option is useful for old MS-DOS disk
1951 DEF("L
", HAS_ARG, QEMU_OPTION_L, \
1952 "-L path set the directory
for the BIOS
, VGA BIOS and keymaps
\n",
1957 Set the directory for the BIOS, VGA BIOS and keymaps.
1960 DEF("bios
", HAS_ARG, QEMU_OPTION_bios, \
1961 "-bios file set the filename
for the BIOS
\n", QEMU_ARCH_ALL)
1963 @item -bios @var{file}
1965 Set the filename for the BIOS.
1968 DEF("enable
-kvm
", 0, QEMU_OPTION_enable_kvm, \
1969 "-enable
-kvm enable KVM full virtualization support
\n", QEMU_ARCH_ALL)
1973 Enable KVM full virtualization support. This option is only available
1974 if KVM support is enabled when compiling.
1977 DEF("xen
-domid
", HAS_ARG, QEMU_OPTION_xen_domid,
1978 "-xen
-domid id specify xen guest domain id
\n", QEMU_ARCH_ALL)
1979 DEF("xen
-create
", 0, QEMU_OPTION_xen_create,
1980 "-xen
-create create domain
using xen hypercalls
, bypassing xend
\n"
1981 " warning
: should not be used when xend is
in use
\n",
1983 DEF("xen
-attach
", 0, QEMU_OPTION_xen_attach,
1984 "-xen
-attach attach to existing xen domain
\n"
1985 " xend will use
this when starting qemu
\n",
1988 @item -xen-domid @var{id}
1990 Specify xen guest domain @var{id} (XEN only).
1993 Create domain using xen hypercalls, bypassing xend.
1994 Warning: should not be used when xend is in use (XEN only).
1997 Attach to existing xen domain.
1998 xend will use this when starting qemu (XEN only).
2001 DEF("no
-reboot
", 0, QEMU_OPTION_no_reboot, \
2002 "-no
-reboot exit instead of rebooting
\n", QEMU_ARCH_ALL)
2006 Exit instead of rebooting.
2009 DEF("no
-shutdown
", 0, QEMU_OPTION_no_shutdown, \
2010 "-no
-shutdown stop before shutdown
\n", QEMU_ARCH_ALL)
2013 @findex -no-shutdown
2014 Don't exit QEMU on guest shutdown, but instead only stop the emulation.
2015 This allows for instance switching to monitor to commit changes to the
2019 DEF("loadvm
", HAS_ARG, QEMU_OPTION_loadvm, \
2020 "-loadvm
[tag|id
]\n" \
2021 " start right away with a saved
state (loadvm
in monitor
)\n",
2024 @item -loadvm @var{file}
2026 Start right away with a saved state (@code{loadvm} in monitor)
2030 DEF("daemonize
", 0, QEMU_OPTION_daemonize, \
2031 "-daemonize daemonize QEMU after initializing
\n", QEMU_ARCH_ALL)
2036 Daemonize the QEMU process after initialization. QEMU will not detach from
2037 standard IO until it is ready to receive connections on any of its devices.
2038 This option is a useful way for external programs to launch QEMU without having
2039 to cope with initialization race conditions.
2042 DEF("option
-rom
", HAS_ARG, QEMU_OPTION_option_rom, \
2043 "-option
-rom rom load a file
, rom
, into the option ROM space
\n",
2046 @item -option-rom @var{file}
2048 Load the contents of @var{file} as an option ROM.
2049 This option is useful to load things like EtherBoot.
2052 DEF("clock
", HAS_ARG, QEMU_OPTION_clock, \
2053 "-clock force the use of the given methods
for timer alarm
.\n" \
2054 " To see what timers are available use
-clock ?
\n",
2057 @item -clock @var{method}
2059 Force the use of the given methods for timer alarm. To see what timers
2060 are available use -clock ?.
2063 HXCOMM Options deprecated by -rtc
2064 DEF("localtime
", 0, QEMU_OPTION_localtime, "", QEMU_ARCH_ALL)
2065 DEF("startdate
", HAS_ARG, QEMU_OPTION_startdate, "", QEMU_ARCH_ALL)
2067 DEF("rtc
", HAS_ARG, QEMU_OPTION_rtc, \
2068 "-rtc
[base
=utc|localtime|date
][,clock
=host|vm
][,driftfix
=none|slew
]\n" \
2069 " set the RTC base and clock
, enable drift fix
for clock
ticks (x86 only
)\n",
2074 @item -rtc [base=utc|localtime|@var{date}][,clock=host|vm][,driftfix=none|slew]
2076 Specify @option{base} as @code{utc} or @code{localtime} to let the RTC start at the current
2077 UTC or local time, respectively. @code{localtime} is required for correct date in
2078 MS-DOS or Windows. To start at a specific point in time, provide @var{date} in the
2079 format @code{2006-06-17T16:01:21} or @code{2006-06-17}. The default base is UTC.
2081 By default the RTC is driven by the host system time. This allows to use the
2082 RTC as accurate reference clock inside the guest, specifically if the host
2083 time is smoothly following an accurate external reference clock, e.g. via NTP.
2084 If you want to isolate the guest time from the host, even prevent it from
2085 progressing during suspension, you can set @option{clock} to @code{vm} instead.
2087 Enable @option{driftfix} (i386 targets only) if you experience time drift problems,
2088 specifically with Windows' ACPI HAL. This option will try to figure out how
2089 many timer interrupts were not processed by the Windows guest and will
2093 DEF("icount
", HAS_ARG, QEMU_OPTION_icount, \
2094 "-icount
[N|auto
]\n" \
2095 " enable virtual instruction counter with
2^N clock ticks per
\n" \
2096 " instruction
\n", QEMU_ARCH_ALL)
2098 @item -icount [@var{N}|auto]
2100 Enable virtual instruction counter. The virtual cpu will execute one
2101 instruction every 2^@var{N} ns of virtual time. If @code{auto} is specified
2102 then the virtual cpu speed will be automatically adjusted to keep virtual
2103 time within a few seconds of real time.
2105 Note that while this option can give deterministic behavior, it does not
2106 provide cycle accurate emulation. Modern CPUs contain superscalar out of
2107 order cores with complex cache hierarchies. The number of instructions
2108 executed often has little or no correlation with actual performance.
2111 DEF("watchdog
", HAS_ARG, QEMU_OPTION_watchdog, \
2112 "-watchdog i6300esb|ib700
\n" \
2113 " enable virtual hardware watchdog
[default=none
]\n",
2116 @item -watchdog @var{model}
2118 Create a virtual hardware watchdog device. Once enabled (by a guest
2119 action), the watchdog must be periodically polled by an agent inside
2120 the guest or else the guest will be restarted.
2122 The @var{model} is the model of hardware watchdog to emulate. Choices
2123 for model are: @code{ib700} (iBASE 700) which is a very simple ISA
2124 watchdog with a single timer, or @code{i6300esb} (Intel 6300ESB I/O
2125 controller hub) which is a much more featureful PCI-based dual-timer
2126 watchdog. Choose a model for which your guest has drivers.
2128 Use @code{-watchdog ?} to list available hardware models. Only one
2129 watchdog can be enabled for a guest.
2132 DEF("watchdog
-action
", HAS_ARG, QEMU_OPTION_watchdog_action, \
2133 "-watchdog
-action reset|shutdown|poweroff|pause|debug|none
\n" \
2134 " action when watchdog fires
[default=reset
]\n",
2137 @item -watchdog-action @var{action}
2139 The @var{action} controls what QEMU will do when the watchdog timer
2142 @code{reset} (forcefully reset the guest).
2143 Other possible actions are:
2144 @code{shutdown} (attempt to gracefully shutdown the guest),
2145 @code{poweroff} (forcefully poweroff the guest),
2146 @code{pause} (pause the guest),
2147 @code{debug} (print a debug message and continue), or
2148 @code{none} (do nothing).
2150 Note that the @code{shutdown} action requires that the guest responds
2151 to ACPI signals, which it may not be able to do in the sort of
2152 situations where the watchdog would have expired, and thus
2153 @code{-watchdog-action shutdown} is not recommended for production use.
2158 @item -watchdog i6300esb -watchdog-action pause
2159 @item -watchdog ib700
2163 DEF("echr
", HAS_ARG, QEMU_OPTION_echr, \
2164 "-echr chr set terminal escape character instead of ctrl
-a
\n",
2168 @item -echr @var{numeric_ascii_value}
2170 Change the escape character used for switching to the monitor when using
2171 monitor and serial sharing. The default is @code{0x01} when using the
2172 @code{-nographic} option. @code{0x01} is equal to pressing
2173 @code{Control-a}. You can select a different character from the ascii
2174 control keys where 1 through 26 map to Control-a through Control-z. For
2175 instance you could use the either of the following to change the escape
2176 character to Control-t.
2183 DEF("virtioconsole
", HAS_ARG, QEMU_OPTION_virtiocon, \
2184 "-virtioconsole c
\n" \
2185 " set virtio console
\n", QEMU_ARCH_ALL)
2187 @item -virtioconsole @var{c}
2188 @findex -virtioconsole
2191 This option is maintained for backward compatibility.
2193 Please use @code{-device virtconsole} for the new way of invocation.
2196 DEF("show
-cursor
", 0, QEMU_OPTION_show_cursor, \
2197 "-show
-cursor show cursor
\n", QEMU_ARCH_ALL)
2200 @findex -show-cursor
2204 DEF("tb
-size
", HAS_ARG, QEMU_OPTION_tb_size, \
2205 "-tb
-size n set TB size
\n", QEMU_ARCH_ALL)
2207 @item -tb-size @var{n}
2212 DEF("incoming
", HAS_ARG, QEMU_OPTION_incoming, \
2213 "-incoming p prepare
for incoming migration
, listen on port p
\n",
2216 @item -incoming @var{port}
2218 Prepare for incoming migration, listen on @var{port}.
2221 DEF("nodefaults
", 0, QEMU_OPTION_nodefaults, \
2222 "-nodefaults don
't create default devices\n", QEMU_ARCH_ALL)
2226 Don't create
default devices
.
2230 DEF("chroot", HAS_ARG
, QEMU_OPTION_chroot
, \
2231 "-chroot dir chroot to dir just before starting the VM\n",
2235 @item
-chroot @
var{dir
}
2237 Immediately before starting guest execution
, chroot to the specified
2238 directory
. Especially useful
in combination with
-runas
.
2242 DEF("runas", HAS_ARG
, QEMU_OPTION_runas
, \
2243 "-runas user change to user id user just before starting the VM\n",
2247 @item
-runas @
var{user
}
2249 Immediately before starting guest execution
, drop root privileges
, switching
2250 to the specified user
.
2253 DEF("prom-env", HAS_ARG
, QEMU_OPTION_prom_env
,
2254 "-prom-env variable=value\n"
2255 " set OpenBIOS nvram variables\n",
2256 QEMU_ARCH_PPC | QEMU_ARCH_SPARC
)
2258 @item
-prom
-env @
var{variable
}=@
var{value
}
2260 Set OpenBIOS nvram @
var{variable
} to given @
var{value
} (PPC
, SPARC only
).
2262 DEF("semihosting", 0, QEMU_OPTION_semihosting
,
2263 "-semihosting semihosting mode\n", QEMU_ARCH_ARM | QEMU_ARCH_M68K
)
2266 @findex
-semihosting
2267 Semihosting
mode (ARM
, M68K only
).
2269 DEF("old-param", 0, QEMU_OPTION_old_param
,
2270 "-old-param old param mode\n", QEMU_ARCH_ARM
)
2273 @findex
-old
-param (ARM
)
2274 Old param
mode (ARM only
).
2277 DEF("readconfig", HAS_ARG
, QEMU_OPTION_readconfig
,
2278 "-readconfig <file>\n", QEMU_ARCH_ALL
)
2280 @item
-readconfig @
var{file
}
2282 Read device configuration from @
var{file
}.
2284 DEF("writeconfig", HAS_ARG
, QEMU_OPTION_writeconfig
,
2285 "-writeconfig <file>\n"
2286 " read/write config file\n", QEMU_ARCH_ALL
)
2288 @item
-writeconfig @
var{file
}
2289 @findex
-writeconfig
2290 Write device configuration to @
var{file
}.
2292 DEF("nodefconfig", 0, QEMU_OPTION_nodefconfig
,
2294 " do not load default config files at startup\n",
2298 @findex
-nodefconfig
2299 Normally QEMU loads a configuration file from @
var{sysconfdir
}/qemu
.conf and
2300 @
var{sysconfdir
}/target
-@
var{ARCH
}.conf on startup
. The @code
{-nodefconfig
}
2301 option will prevent QEMU from loading these configuration files at startup
.
2303 #ifdef CONFIG_SIMPLE_TRACE
2304 DEF("trace", HAS_ARG
, QEMU_OPTION_trace
,
2306 " Specify a trace file to log traces to\n",
2311 Specify a
trace file to log output traces to
.
2315 HXCOMM This is the last statement
. Insert
new options before
this line
!