1 HXCOMM Use
DEFHEADING() to define headings
in both help text and texi
2 HXCOMM Text between STEXI and ETEXI are copied to texi version and
3 HXCOMM discarded from C version
4 HXCOMM
DEF(option
, HAS_ARG
/0, opt_enum
, opt_help
, arch_mask
) is used to
5 HXCOMM construct option structures
, enums and help message
for specified
7 HXCOMM HXCOMM can be used
for comments
, discarded from both texi and C
9 DEFHEADING(Standard options
:)
14 DEF("help", 0, QEMU_OPTION_h
,
15 "-h or -help display this help and exit\n", QEMU_ARCH_ALL
)
22 DEF("version", 0, QEMU_OPTION_version
,
23 "-version display version information and exit\n", QEMU_ARCH_ALL
)
27 Display version information and exit
30 DEF("machine", HAS_ARG
, QEMU_OPTION_machine
, \
31 "-machine [type=]name[,prop[=value][,...]]\n"
32 " selects emulated machine ('-machine help' for list)\n"
33 " property accel=accel1[:accel2[:...]] selects accelerator\n"
34 " supported accelerators are kvm, xen, tcg (default: tcg)\n"
35 " kernel_irqchip=on|off controls accelerated irqchip support\n"
36 " kvm_shadow_mem=size of KVM shadow MMU\n"
37 " dump-guest-core=on|off include guest memory in a core dump (default=on)\n"
38 " mem-merge=on|off controls memory merge support (default: on)\n",
41 @item
-machine
[type
=]@
var{name
}[,prop
=@
var{value
}[,...]]
43 Select the emulated machine by @
var{name
}. Use @code
{-machine help
} to list
44 available machines
. Supported machine properties are
:
46 @item accel
=@
var{accels1
}[:@
var{accels2
}[:...]]
47 This is used to enable an accelerator
. Depending on the target architecture
,
48 kvm
, xen
, or tcg can be available
. By
default, tcg is used
. If there is more
49 than one accelerator specified
, the next one is used
if the previous one fails
51 @item kernel_irqchip
=on|off
52 Enables
in-kernel irqchip support
for the chosen accelerator when available
.
53 @item kvm_shadow_mem
=size
54 Defines the size of the KVM shadow MMU
.
55 @item dump
-guest
-core
=on|off
56 Include guest memory
in a core dump
. The
default is on
.
57 @item mem
-merge
=on|off
58 Enables or disables memory merge support
. This feature
, when supported by
59 the host
, de
-duplicates identical memory pages among VMs instances
64 HXCOMM Deprecated by
-machine
65 DEF("M", HAS_ARG
, QEMU_OPTION_M
, "", QEMU_ARCH_ALL
)
67 DEF("cpu", HAS_ARG
, QEMU_OPTION_cpu
,
68 "-cpu cpu select CPU ('-cpu help' for list)\n", QEMU_ARCH_ALL
)
70 @item
-cpu @
var{model
}
72 Select CPU
model (@code
{-cpu help
} for list and additional feature selection
)
75 DEF("smp", HAS_ARG
, QEMU_OPTION_smp
,
76 "-smp n[,maxcpus=cpus][,cores=cores][,threads=threads][,sockets=sockets]\n"
77 " set the number of CPUs to 'n' [default=1]\n"
78 " maxcpus= maximum number of total cpus, including\n"
79 " offline CPUs for hotplug, etc\n"
80 " cores= number of CPU cores on one socket\n"
81 " threads= number of threads on one CPU core\n"
82 " sockets= number of discrete sockets in the system\n",
85 @item
-smp @
var{n
}[,cores
=@
var{cores
}][,threads
=@
var{threads
}][,sockets
=@
var{sockets
}][,maxcpus
=@
var{maxcpus
}]
87 Simulate an SMP system with @
var{n
} CPUs
. On the PC target
, up to
255
88 CPUs are supported
. On Sparc32 target
, Linux limits the number of usable CPUs
90 For the PC target
, the number of @
var{cores
} per socket
, the number
91 of @
var{threads
} per cores and the total number of @
var{sockets
} can be
92 specified
. Missing values will be computed
. If any on the three values is
93 given
, the total number of CPUs @
var{n
} can be omitted
. @
var{maxcpus
}
94 specifies the maximum number of hotpluggable CPUs
.
97 DEF("numa", HAS_ARG
, QEMU_OPTION_numa
,
98 "-numa node[,mem=size][,cpus=cpu[-cpu]][,nodeid=node]\n", QEMU_ARCH_ALL
)
100 @item
-numa @
var{opts
}
102 Simulate a multi node NUMA system
. If mem and cpus are omitted
, resources
106 DEF("fda", HAS_ARG
, QEMU_OPTION_fda
,
107 "-fda/-fdb file use 'file' as floppy disk 0/1 image\n", QEMU_ARCH_ALL
)
108 DEF("fdb", HAS_ARG
, QEMU_OPTION_fdb
, "", QEMU_ARCH_ALL
)
110 @item
-fda @
var{file
}
111 @item
-fdb @
var{file
}
114 Use @
var{file
} as floppy disk
0/1 image (@pxref
{disk_images
}). You can
115 use the host floppy by
using @file
{/dev
/fd0
} as
filename (@pxref
{host_drives
}).
118 DEF("hda", HAS_ARG
, QEMU_OPTION_hda
,
119 "-hda/-hdb file use 'file' as IDE hard disk 0/1 image\n", QEMU_ARCH_ALL
)
120 DEF("hdb", HAS_ARG
, QEMU_OPTION_hdb
, "", QEMU_ARCH_ALL
)
121 DEF("hdc", HAS_ARG
, QEMU_OPTION_hdc
,
122 "-hdc/-hdd file use 'file' as IDE hard disk 2/3 image\n", QEMU_ARCH_ALL
)
123 DEF("hdd", HAS_ARG
, QEMU_OPTION_hdd
, "", QEMU_ARCH_ALL
)
125 @item
-hda @
var{file
}
126 @item
-hdb @
var{file
}
127 @item
-hdc @
var{file
}
128 @item
-hdd @
var{file
}
133 Use @
var{file
} as hard disk
0, 1, 2 or
3 image (@pxref
{disk_images
}).
136 DEF("cdrom", HAS_ARG
, QEMU_OPTION_cdrom
,
137 "-cdrom file use 'file' as IDE cdrom image (cdrom is ide1 master)\n",
140 @item
-cdrom @
var{file
}
142 Use @
var{file
} as CD
-ROM
image (you cannot use @option
{-hdc
} and
143 @option
{-cdrom
} at the same time
). You can use the host CD
-ROM by
144 using @file
{/dev
/cdrom
} as
filename (@pxref
{host_drives
}).
147 DEF("drive", HAS_ARG
, QEMU_OPTION_drive
,
148 "-drive [file=file][,if=type][,bus=n][,unit=m][,media=d][,index=i]\n"
149 " [,cyls=c,heads=h,secs=s[,trans=t]][,snapshot=on|off]\n"
150 " [,cache=writethrough|writeback|none|directsync|unsafe][,format=f]\n"
151 " [,serial=s][,addr=A][,id=name][,aio=threads|native]\n"
152 " [,readonly=on|off][,copy-on-read=on|off]\n"
153 " [[,bps=b]|[[,bps_rd=r][,bps_wr=w]]][[,iops=i]|[[,iops_rd=r][,iops_wr=w]]\n"
154 " use 'file' as a drive image\n", QEMU_ARCH_ALL
)
156 @item
-drive @
var{option
}[,@
var{option
}[,@
var{option
}[,...]]]
159 Define a
new drive
. Valid options are
:
162 @item file
=@
var{file
}
163 This option defines which disk
image (@pxref
{disk_images
}) to use with
164 this drive
. If the filename contains comma
, you must double it
165 (for instance
, "file=my,,file" to use file
"my,file").
167 Special files such as iSCSI devices can be specified
using protocol
168 specific URLs
. See the section
for "Device URL Syntax" for more information
.
169 @item
if=@
var{interface}
170 This option defines on which type on
interface the drive is connected
.
171 Available types are
: ide
, scsi
, sd
, mtd
, floppy
, pflash
, virtio
.
172 @item bus
=@
var{bus
},unit
=@
var{unit
}
173 These options define where is connected the drive by defining the bus number and
175 @item index
=@
var{index
}
176 This option defines where is connected the drive by
using an index
in the list
177 of available connectors of a given
interface type
.
178 @item media
=@
var{media
}
179 This option defines the type of the media
: disk or cdrom
.
180 @item cyls
=@
var{c
},heads
=@
var{h
},secs
=@
var{s
}[,trans
=@
var{t
}]
181 These options have the same definition as they have
in @option
{-hdachs
}.
182 @item snapshot
=@
var{snapshot
}
183 @
var{snapshot
} is
"on" or
"off" and allows to enable snapshot
for given
drive (see @option
{-snapshot
}).
184 @item cache
=@
var{cache
}
185 @
var{cache
} is
"none", "writeback", "unsafe", "directsync" or
"writethrough" and controls how the host cache is used to access block data
.
187 @
var{aio
} is
"threads", or
"native" and selects between pthread based disk I
/O and native Linux AIO
.
188 @item format
=@
var{format
}
189 Specify which disk @
var{format
} will be used rather than detecting
190 the format
. Can be used to specifiy format
=raw to avoid interpreting
191 an untrusted format header
.
192 @item serial
=@
var{serial
}
193 This option specifies the serial number to assign to the device
.
194 @item addr
=@
var{addr
}
195 Specify the controller
's PCI address (if=virtio only).
196 @item werror=@var{action},rerror=@var{action}
197 Specify which @var{action} to take on write and read errors. Valid actions are:
198 "ignore" (ignore the error and try to continue), "stop" (pause QEMU),
199 "report" (report the error to the guest), "enospc" (pause QEMU only if the
200 host disk is full; report the error to the guest otherwise).
201 The default setting is @option{werror=enospc} and @option{rerror=report}.
203 Open drive @option{file} as read-only. Guest write attempts will fail.
204 @item copy-on-read=@var{copy-on-read}
205 @var{copy-on-read} is "on" or "off" and enables whether to copy read backing
206 file sectors into the image file.
209 By default, the @option{cache=writeback} mode is used. It will report data
210 writes as completed as soon as the data is present in the host page cache.
211 This is safe as long as your guest OS makes sure to correctly flush disk caches
212 where needed. If your guest OS does not handle volatile disk write caches
213 correctly and your host crashes or loses power, then the guest may experience
216 For such guests, you should consider using @option{cache=writethrough}. This
217 means that the host page cache will be used to read and write data, but write
218 notification will be sent to the guest only after QEMU has made sure to flush
219 each write to the disk. Be aware that this has a major impact on performance.
221 The host page cache can be avoided entirely with @option{cache=none}. This will
222 attempt to do disk IO directly to the guest's memory
. QEMU may still perform
223 an internal copy of the data
. Note that
this is considered a writeback mode and
224 the guest OS must handle the disk write cache correctly
in order to avoid data
225 corruption on host crashes
.
227 The host page cache can be avoided
while only sending write notifications to
228 the guest when the data has been flushed to the disk
using
229 @option
{cache
=directsync
}.
231 In
case you don
't care about data integrity over host failures, use
232 @option{cache=unsafe}. This option tells QEMU that it never needs to write any
233 data to the disk but can instead keep things in cache. If anything goes wrong,
234 like your host losing power, the disk storage getting disconnected accidentally,
235 etc. your image will most probably be rendered unusable. When using
236 the @option{-snapshot} option, unsafe caching is always used.
238 Copy-on-read avoids accessing the same backing file sectors repeatedly and is
239 useful when the backing file is over a slow network. By default copy-on-read
242 Instead of @option{-cdrom} you can use:
244 qemu-system-i386 -drive file=file,index=2,media=cdrom
247 Instead of @option{-hda}, @option{-hdb}, @option{-hdc}, @option{-hdd}, you can
250 qemu-system-i386 -drive file=file,index=0,media=disk
251 qemu-system-i386 -drive file=file,index=1,media=disk
252 qemu-system-i386 -drive file=file,index=2,media=disk
253 qemu-system-i386 -drive file=file,index=3,media=disk
256 You can open an image using pre-opened file descriptors from an fd set:
259 -add-fd fd=3,set=2,opaque="rdwr:/path/to/file"
260 -add-fd fd=4,set=2,opaque="rdonly:/path/to/file"
261 -drive file=/dev/fdset/2,index=0,media=disk
264 You can connect a CDROM to the slave of ide0:
266 qemu-system-i386 -drive file=file,if=ide,index=1,media=cdrom
269 If you don't specify the
"file=" argument
, you define an empty drive
:
271 qemu
-system
-i386
-drive
if=ide
,index
=1,media
=cdrom
274 You can connect a SCSI disk with unit ID
6 on the bus #
0:
276 qemu
-system
-i386
-drive file
=file
,if=scsi
,bus
=0,unit
=6
279 Instead of @option
{-fda
}, @option
{-fdb
}, you can use
:
281 qemu
-system
-i386
-drive file
=file
,index
=0,if=floppy
282 qemu
-system
-i386
-drive file
=file
,index
=1,if=floppy
285 By
default, @
var{interface} is
"ide" and @
var{index
} is automatically
288 qemu
-system
-i386
-drive file
=a
-drive file
=b
"
292 qemu-system-i386 -hda a -hdb b
296 DEF("add
-fd
", HAS_ARG, QEMU_OPTION_add_fd,
297 "-add
-fd fd
=fd
,set
=set
[,opaque
=opaque
]\n"
298 " Add
'fd' to fd
'set'\n", QEMU_ARCH_ALL)
300 @item -add-fd fd=@var{fd},set=@var{set}[,opaque=@var{opaque}]
303 Add a file descriptor to an fd set. Valid options are:
307 This option defines the file descriptor of which a duplicate is added to fd set.
308 The file descriptor cannot be stdin, stdout, or stderr.
310 This option defines the ID of the fd set to add the file descriptor to.
311 @item opaque=@var{opaque}
312 This option defines a free-form string that can be used to describe @var{fd}.
315 You can open an image using pre-opened file descriptors from an fd set:
318 -add-fd fd=3,set=2,opaque="rdwr
:/path
/to
/file
"
319 -add-fd fd=4,set=2,opaque="rdonly
:/path
/to
/file
"
320 -drive file=/dev/fdset/2,index=0,media=disk
324 DEF("set
", HAS_ARG, QEMU_OPTION_set,
325 "-set group
.id
.arg
=value
\n"
326 " set
<arg
> parameter
for item
<id
> of type
<group
>\n"
327 " i
.e
. -set drive
.$id
.file
=/path
/to
/image
\n", QEMU_ARCH_ALL)
334 DEF("global
", HAS_ARG, QEMU_OPTION_global,
335 "-global driver
.prop
=value
\n"
336 " set a global
default for a driver property
\n",
339 @item -global @var{driver}.@var{prop}=@var{value}
341 Set default value of @var{driver}'s property @var{prop} to @var{value}, e.g.:
344 qemu-system-i386 -global ide-drive.physical_block_size=4096 -drive file=file,if=ide,index=0,media=disk
347 In particular, you can use this to set driver properties for devices which are
348 created automatically by the machine model. To create a device which is not
349 created automatically and set properties on it, use -@option{device}.
352 DEF("mtdblock
", HAS_ARG, QEMU_OPTION_mtdblock,
353 "-mtdblock file use
'file' as on
-board Flash memory image
\n",
356 @item -mtdblock @var{file}
358 Use @var{file} as on-board Flash memory image.
361 DEF("sd
", HAS_ARG, QEMU_OPTION_sd,
362 "-sd file use
'file' as SecureDigital card image
\n", QEMU_ARCH_ALL)
366 Use @var{file} as SecureDigital card image.
369 DEF("pflash
", HAS_ARG, QEMU_OPTION_pflash,
370 "-pflash file use
'file' as a parallel flash image
\n", QEMU_ARCH_ALL)
372 @item -pflash @var{file}
374 Use @var{file} as a parallel flash image.
377 DEF("boot
", HAS_ARG, QEMU_OPTION_boot,
378 "-boot
[order
=drives
][,once
=drives
][,menu
=on|off
]\n"
379 " [,splash
=sp_name
][,splash
-time
=sp_time
][,reboot
-timeout
=rb_time
]\n"
380 " 'drives': floppy (a
), hard
disk (c
), CD
-ROM (d
), network (n
)\n"
381 " 'sp_name': the file
's name that would be passed to bios as logo picture, if menu=on\n"
382 " 'sp_time
': the period that splash picture last if menu=on, unit is ms\n"
383 " 'rb_timeout
': the timeout before guest reboot when boot failed, unit is ms\n",
386 @item -boot [order=@var{drives}][,once=@var{drives}][,menu=on|off][,splash=@var{sp_name}][,splash-time=@var{sp_time}][,reboot-timeout=@var{rb_timeout}]
388 Specify boot order @var{drives} as a string of drive letters. Valid
389 drive letters depend on the target achitecture. The x86 PC uses: a, b
390 (floppy 1 and 2), c (first hard disk), d (first CD-ROM), n-p (Etherboot
391 from network adapter 1-4), hard disk boot is the default. To apply a
392 particular boot order only on the first startup, specify it via
395 Interactive boot menus/prompts can be enabled via @option{menu=on} as far
396 as firmware/BIOS supports them. The default is non-interactive boot.
398 A splash picture could be passed to bios, enabling user to show it as logo,
399 when option splash=@var{sp_name} is given and menu=on, If firmware/BIOS
400 supports them. Currently Seabios for X86 system support it.
401 limitation: The splash file could be a jpeg file or a BMP file in 24 BPP
402 format(true color). The resolution should be supported by the SVGA mode, so
403 the recommended is 320x240, 640x480, 800x640.
405 A timeout could be passed to bios, guest will pause for @var{rb_timeout} ms
406 when boot failed, then reboot. If @var{rb_timeout} is '-1', guest will not
407 reboot, qemu passes '-1' to bios by default. Currently Seabios for X86
411 # try to boot from network first, then from hard disk
412 qemu-system-i386 -boot order=nc
413 # boot from CD-ROM first, switch back to default order after reboot
414 qemu-system-i386 -boot once=d
415 # boot with a splash picture for 5 seconds.
416 qemu-system-i386 -boot menu=on,splash=/root/boot.bmp,splash-time=5000
419 Note: The legacy format '-boot @
var{drives
}' is still supported but its
420 use is discouraged as it may be removed from future versions.
423 DEF("snapshot", 0, QEMU_OPTION_snapshot,
424 "-snapshot write to temporary files instead of disk image files\n",
429 Write to temporary files instead of disk image files. In this case,
430 the raw disk image you use is not written back. You can however force
431 the write back by pressing @key{C-a s} (@pxref{disk_images}).
434 DEF("m", HAS_ARG, QEMU_OPTION_m,
435 "-m megs set virtual RAM size to megs MB [default="
436 stringify(DEFAULT_RAM_SIZE) "]\n", QEMU_ARCH_ALL)
440 Set virtual RAM size to @var{megs} megabytes. Default is 128 MiB. Optionally,
441 a suffix of ``M'' or ``G'' can be used to signify a value in megabytes or
442 gigabytes respectively.
445 DEF("mem-path", HAS_ARG, QEMU_OPTION_mempath,
446 "-mem-path FILE provide backing storage for guest RAM\n", QEMU_ARCH_ALL)
448 @item -mem-path @var{path}
449 Allocate guest RAM from a temporarily created file in @var{path}.
453 DEF("mem-prealloc", 0, QEMU_OPTION_mem_prealloc,
454 "-mem-prealloc preallocate guest memory (use with -mem-path)\n",
458 Preallocate memory when using -mem-path.
462 DEF("k", HAS_ARG, QEMU_OPTION_k,
463 "-k language use keyboard layout (for example 'fr
' for French)\n",
466 @item -k @var{language}
468 Use keyboard layout @var{language} (for example @code{fr} for
469 French). This option is only needed where it is not easy to get raw PC
470 keycodes (e.g. on Macs, with some X11 servers or with a VNC
471 display). You don't normally need to use it on PC
/Linux or PC
/Windows
474 The available layouts are
:
476 ar de
-ch es fo fr
-ca hu ja mk no pt
-br sv
477 da en
-gb et fr fr
-ch is lt nl pl ru th
478 de en
-us fi fr
-be hr it lv nl
-be pt sl tr
481 The
default is @code
{en
-us
}.
485 DEF("audio-help", 0, QEMU_OPTION_audio_help
,
486 "-audio-help print list of audio drivers and their options\n",
491 Will show the audio subsystem help
: list of drivers
, tunable
495 DEF("soundhw", HAS_ARG
, QEMU_OPTION_soundhw
,
496 "-soundhw c1,... enable audio support\n"
497 " and only specified sound cards (comma separated list)\n"
498 " use '-soundhw help' to get the list of supported cards\n"
499 " use '-soundhw all' to enable all of them\n", QEMU_ARCH_ALL
)
501 @item
-soundhw @
var{card1
}[,@
var{card2
},...] or
-soundhw all
503 Enable audio and selected sound hardware
. Use
'help' to print all
504 available sound hardware
.
507 qemu
-system
-i386
-soundhw sb16
,adlib disk
.img
508 qemu
-system
-i386
-soundhw es1370 disk
.img
509 qemu
-system
-i386
-soundhw ac97 disk
.img
510 qemu
-system
-i386
-soundhw hda disk
.img
511 qemu
-system
-i386
-soundhw all disk
.img
512 qemu
-system
-i386
-soundhw help
515 Note that Linux
's i810_audio OSS kernel (for AC97) module might
516 require manually specifying clocking.
519 modprobe i810_audio clocking=48000
523 DEF("balloon", HAS_ARG, QEMU_OPTION_balloon,
524 "-balloon none disable balloon device\n"
525 "-balloon virtio[,addr=str]\n"
526 " enable virtio balloon device (default)\n", QEMU_ARCH_ALL)
530 Disable balloon device.
531 @item -balloon virtio[,addr=@var{addr}]
532 Enable virtio balloon device (default), optionally with PCI address
545 DEF("usb", 0, QEMU_OPTION_usb,
546 "-usb enable the USB driver (will be the default soon)\n",
551 Enable the USB driver (will be the default soon)
554 DEF("usbdevice", HAS_ARG, QEMU_OPTION_usbdevice,
555 "-usbdevice name add the host or guest USB device 'name
'\n",
559 @item -usbdevice @var{devname}
561 Add the USB device @var{devname}. @xref{usb_devices}.
566 Virtual Mouse. This will override the PS/2 mouse emulation when activated.
569 Pointer device that uses absolute coordinates (like a touchscreen). This
570 means QEMU is able to report the mouse position without having to grab the
571 mouse. Also overrides the PS/2 mouse emulation when activated.
573 @item disk:[format=@var{format}]:@var{file}
574 Mass storage device based on file. The optional @var{format} argument
575 will be used rather than detecting the format. Can be used to specifiy
576 @code{format=raw} to avoid interpreting an untrusted format header.
578 @item host:@var{bus}.@var{addr}
579 Pass through the host device identified by @var{bus}.@var{addr} (Linux only).
581 @item host:@var{vendor_id}:@var{product_id}
582 Pass through the host device identified by @var{vendor_id}:@var{product_id}
585 @item serial:[vendorid=@var{vendor_id}][,productid=@var{product_id}]:@var{dev}
586 Serial converter to host character device @var{dev}, see @code{-serial} for the
590 Braille device. This will use BrlAPI to display the braille output on a real
593 @item net:@var{options}
594 Network adapter that supports CDC ethernet and RNDIS protocols.
599 DEF("device", HAS_ARG, QEMU_OPTION_device,
600 "-device driver[,prop[=value][,...]]\n"
601 " add device (based on driver)\n"
602 " prop=value,... sets driver properties\n"
603 " use '-device help
' to print all possible drivers\n"
604 " use '-device driver
,help
' to print all possible properties\n",
607 @item -device @var{driver}[,@var{prop}[=@var{value}][,...]]
609 Add device @var{driver}. @var{prop}=@var{value} sets driver
610 properties. Valid properties depend on the driver. To get help on
611 possible drivers and properties, use @code{-device help} and
612 @code{-device @var{driver},help}.
620 DEFHEADING(File system options:)
625 DEF("fsdev", HAS_ARG, QEMU_OPTION_fsdev,
626 "-fsdev fsdriver,id=id[,path=path,][security_model={mapped-xattr|mapped-file|passthrough|none}]\n"
627 " [,writeout=immediate][,readonly][,socket=socket|sock_fd=sock_fd]\n",
632 @item -fsdev @var{fsdriver},id=@var{id},path=@var{path},[security_model=@var{security_model}][,writeout=@var{writeout}][,readonly][,socket=@var{socket}|sock_fd=@var{sock_fd}]
634 Define a new file system device. Valid options are:
637 This option specifies the fs driver backend to use.
638 Currently "local", "handle" and "proxy" file system drivers are supported.
640 Specifies identifier for this device
641 @item path=@var{path}
642 Specifies the export path for the file system device. Files under
643 this path will be available to the 9p client on the guest.
644 @item security_model=@var{security_model}
645 Specifies the security model to be used for this export path.
646 Supported security models are "passthrough", "mapped-xattr", "mapped-file" and "none".
647 In "passthrough" security model, files are stored using the same
648 credentials as they are created on the guest. This requires QEMU
649 to run as root. In "mapped-xattr" security model, some of the file
650 attributes like uid, gid, mode bits and link target are stored as
651 file attributes. For "mapped-file" these attributes are stored in the
652 hidden .virtfs_metadata directory. Directories exported by this security model cannot
653 interact with other unix tools. "none" security model is same as
654 passthrough except the sever won't report failures
if it fails to
655 set file attributes like ownership
. Security model is mandatory
656 only
for local fsdriver
. Other
fsdrivers (like handle
, proxy
) don
't take
657 security model as a parameter.
658 @item writeout=@var{writeout}
659 This is an optional argument. The only supported value is "immediate".
660 This means that host page cache will be used to read and write data but
661 write notification will be sent to the guest only when the data has been
662 reported as written by the storage subsystem.
664 Enables exporting 9p share as a readonly mount for guests. By default
665 read-write access is given.
666 @item socket=@var{socket}
667 Enables proxy filesystem driver to use passed socket file for communicating
668 with virtfs-proxy-helper
669 @item sock_fd=@var{sock_fd}
670 Enables proxy filesystem driver to use passed socket descriptor for
671 communicating with virtfs-proxy-helper. Usually a helper like libvirt
672 will create socketpair and pass one of the fds as sock_fd
675 -fsdev option is used along with -device driver "virtio-9p-pci".
676 @item -device virtio-9p-pci,fsdev=@var{id},mount_tag=@var{mount_tag}
677 Options for virtio-9p-pci driver are:
680 Specifies the id value specified along with -fsdev option
681 @item mount_tag=@var{mount_tag}
682 Specifies the tag name to be used by the guest to mount this export point
692 DEFHEADING(Virtual File system pass-through options:)
697 DEF("virtfs", HAS_ARG, QEMU_OPTION_virtfs,
698 "-virtfs local,path=path,mount_tag=tag,security_model=[mapped-xattr|mapped-file|passthrough|none]\n"
699 " [,writeout=immediate][,readonly][,socket=socket|sock_fd=sock_fd]\n",
704 @item -virtfs @var{fsdriver}[,path=@var{path}],mount_tag=@var{mount_tag}[,security_model=@var{security_model}][,writeout=@var{writeout}][,readonly][,socket=@var{socket}|sock_fd=@var{sock_fd}]
707 The general form of a Virtual File system pass-through options are:
710 This option specifies the fs driver backend to use.
711 Currently "local", "handle" and "proxy" file system drivers are supported.
713 Specifies identifier for this device
714 @item path=@var{path}
715 Specifies the export path for the file system device. Files under
716 this path will be available to the 9p client on the guest.
717 @item security_model=@var{security_model}
718 Specifies the security model to be used for this export path.
719 Supported security models are "passthrough", "mapped-xattr", "mapped-file" and "none".
720 In "passthrough" security model, files are stored using the same
721 credentials as they are created on the guest. This requires QEMU
722 to run as root. In "mapped-xattr" security model, some of the file
723 attributes like uid, gid, mode bits and link target are stored as
724 file attributes. For "mapped-file" these attributes are stored in the
725 hidden .virtfs_metadata directory. Directories exported by this security model cannot
726 interact with other unix tools. "none" security model is same as
727 passthrough except the sever won't report failures
if it fails to
728 set file attributes like ownership
. Security model is mandatory only
729 for local fsdriver
. Other
fsdrivers (like handle
, proxy
) don
't take security
730 model as a parameter.
731 @item writeout=@var{writeout}
732 This is an optional argument. The only supported value is "immediate".
733 This means that host page cache will be used to read and write data but
734 write notification will be sent to the guest only when the data has been
735 reported as written by the storage subsystem.
737 Enables exporting 9p share as a readonly mount for guests. By default
738 read-write access is given.
739 @item socket=@var{socket}
740 Enables proxy filesystem driver to use passed socket file for
741 communicating with virtfs-proxy-helper. Usually a helper like libvirt
742 will create socketpair and pass one of the fds as sock_fd
744 Enables proxy filesystem driver to use passed 'sock_fd
' as the socket
745 descriptor for interfacing with virtfs-proxy-helper
749 DEF("virtfs_synth", 0, QEMU_OPTION_virtfs_synth,
750 "-virtfs_synth Create synthetic file system image\n",
754 @findex -virtfs_synth
755 Create synthetic file system image
760 DEF("name", HAS_ARG, QEMU_OPTION_name,
761 "-name string1[,process=string2]\n"
762 " set the name of the guest\n"
763 " string1 sets the window title and string2 the process name (on Linux)\n",
766 @item -name @var{name}
768 Sets the @var{name} of the guest.
769 This name will be displayed in the SDL window caption.
770 The @var{name} will also be used for the VNC server.
771 Also optionally set the top visible process name in Linux.
774 DEF("uuid", HAS_ARG, QEMU_OPTION_uuid,
775 "-uuid %08x-%04x-%04x-%04x-%012x\n"
776 " specify machine UUID\n", QEMU_ARCH_ALL)
778 @item -uuid @var{uuid}
788 DEFHEADING(Display options:)
793 DEF("display", HAS_ARG, QEMU_OPTION_display,
794 "-display sdl[,frame=on|off][,alt_grab=on|off][,ctrl_grab=on|off]\n"
795 " [,window_close=on|off]|curses|none|\n"
796 " vnc=<display>[,<optargs>]\n"
797 " select display type\n", QEMU_ARCH_ALL)
799 @item -display @var{type}
801 Select type of display to use. This option is a replacement for the
802 old style -sdl/-curses/... options. Valid values for @var{type} are
805 Display video output via SDL (usually in a separate graphics
806 window; see the SDL documentation for other possibilities).
808 Display video output via curses. For graphics device models which
809 support a text mode, QEMU can display this output using a
810 curses/ncurses interface. Nothing is displayed when the graphics
811 device is in graphical mode or if the graphics device does not support
812 a text mode. Generally only the VGA device models support text mode.
814 Do not display video output. The guest will still see an emulated
815 graphics card, but its output will not be displayed to the QEMU
816 user. This option differs from the -nographic option in that it
817 only affects what is done with video output; -nographic also changes
818 the destination of the serial and parallel port data.
820 Start a VNC server on display <arg>
824 DEF("nographic", 0, QEMU_OPTION_nographic,
825 "-nographic disable graphical output and redirect serial I/Os to console\n",
830 Normally, QEMU uses SDL to display the VGA output. With this option,
831 you can totally disable graphical output so that QEMU is a simple
832 command line application. The emulated serial port is redirected on
833 the console. Therefore, you can still use QEMU to debug a Linux kernel
834 with a serial console.
837 DEF("curses", 0, QEMU_OPTION_curses,
838 "-curses use a curses/ncurses interface instead of SDL\n",
843 Normally, QEMU uses SDL to display the VGA output. With this option,
844 QEMU can display the VGA output when in text mode using a
845 curses/ncurses interface. Nothing is displayed in graphical mode.
848 DEF("no-frame", 0, QEMU_OPTION_no_frame,
849 "-no-frame open SDL window without a frame and window decorations\n",
854 Do not use decorations for SDL windows and start them using the whole
855 available screen space. This makes the using QEMU in a dedicated desktop
856 workspace more convenient.
859 DEF("alt-grab", 0, QEMU_OPTION_alt_grab,
860 "-alt-grab use Ctrl-Alt-Shift to grab mouse (instead of Ctrl-Alt)\n",
865 Use Ctrl-Alt-Shift to grab mouse (instead of Ctrl-Alt). Note that this also
866 affects the special keys (for fullscreen, monitor-mode switching, etc).
869 DEF("ctrl-grab", 0, QEMU_OPTION_ctrl_grab,
870 "-ctrl-grab use Right-Ctrl to grab mouse (instead of Ctrl-Alt)\n",
875 Use Right-Ctrl to grab mouse (instead of Ctrl-Alt). Note that this also
876 affects the special keys (for fullscreen, monitor-mode switching, etc).
879 DEF("no-quit", 0, QEMU_OPTION_no_quit,
880 "-no-quit disable SDL window close capability\n", QEMU_ARCH_ALL)
884 Disable SDL window close capability.
887 DEF("sdl", 0, QEMU_OPTION_sdl,
888 "-sdl enable SDL\n", QEMU_ARCH_ALL)
895 DEF("spice", HAS_ARG, QEMU_OPTION_spice,
896 "-spice [port=port][,tls-port=secured-port][,x509-dir=<dir>]\n"
897 " [,x509-key-file=<file>][,x509-key-password=<file>]\n"
898 " [,x509-cert-file=<file>][,x509-cacert-file=<file>]\n"
899 " [,x509-dh-key-file=<file>][,addr=addr][,ipv4|ipv6]\n"
900 " [,tls-ciphers=<list>]\n"
901 " [,tls-channel=[main|display|cursor|inputs|record|playback]]\n"
902 " [,plaintext-channel=[main|display|cursor|inputs|record|playback]]\n"
903 " [,sasl][,password=<secret>][,disable-ticketing]\n"
904 " [,image-compression=[auto_glz|auto_lz|quic|glz|lz|off]]\n"
905 " [,jpeg-wan-compression=[auto|never|always]]\n"
906 " [,zlib-glz-wan-compression=[auto|never|always]]\n"
907 " [,streaming-video=[off|all|filter]][,disable-copy-paste]\n"
908 " [,agent-mouse=[on|off]][,playback-compression=[on|off]]\n"
909 " [,seamless-migration=[on|off]]\n"
911 " at least one of {port, tls-port} is mandatory\n",
914 @item -spice @var{option}[,@var{option}[,...]]
916 Enable the spice remote desktop protocol. Valid options are
921 Set the TCP port spice is listening on for plaintext channels.
924 Set the IP address spice is listening on. Default is any address.
928 Force using the specified IP version.
930 @item password=<secret>
931 Set the password you need to authenticate.
934 Require that the client use SASL to authenticate with the spice.
935 The exact choice of authentication method used is controlled from the
936 system / user's SASL configuration file
for the
'qemu' service
. This
937 is typically found
in /etc
/sasl2
/qemu
.conf
. If running QEMU as an
938 unprivileged user
, an environment variable SASL_CONF_PATH can be used
939 to make it search alternate locations
for the service config
.
940 While some SASL auth methods can also provide data
encryption (eg GSSAPI
),
941 it is recommended that SASL always be combined with the
'tls' and
942 'x509' settings to enable use of SSL and server certificates
. This
943 ensures a data encryption preventing compromise of authentication
946 @item disable
-ticketing
947 Allow client connects without authentication
.
949 @item disable
-copy
-paste
950 Disable copy paste between the client and the guest
.
953 Set the TCP port spice is listening on
for encrypted channels
.
956 Set the x509 file directory
. Expects same filenames as
-vnc $display
,x509
=$dir
958 @item x509
-key
-file
=<file
>
959 @item x509
-key
-password
=<file
>
960 @item x509
-cert
-file
=<file
>
961 @item x509
-cacert
-file
=<file
>
962 @item x509
-dh
-key
-file
=<file
>
963 The x509 file names can also be configured individually
.
965 @item tls
-ciphers
=<list
>
966 Specify which ciphers to use
.
968 @item tls
-channel
=[main|display|cursor|inputs|record|playback
]
969 @item plaintext
-channel
=[main|display|cursor|inputs|record|playback
]
970 Force specific channel to be used with or without TLS encryption
. The
971 options can be specified multiple times to configure multiple
972 channels
. The special name
"default" can be used to set the
default
973 mode
. For channels which are not explicitly forced into one mode the
974 spice client is allowed to pick tls
/plaintext as he pleases
.
976 @item image
-compression
=[auto_glz|auto_lz|quic|glz|lz|off
]
977 Configure image
compression (lossless
).
980 @item jpeg
-wan
-compression
=[auto|
never|always
]
981 @item zlib
-glz
-wan
-compression
=[auto|
never|always
]
982 Configure wan image
compression (lossy
for slow links
).
985 @item streaming
-video
=[off|all|filter
]
986 Configure video stream detection
. Default is filter
.
988 @item agent
-mouse
=[on|off
]
989 Enable
/disable passing mouse events via vdagent
. Default is on
.
991 @item playback
-compression
=[on|off
]
992 Enable
/disable audio stream
compression (using celt
0.5.1). Default is on
.
994 @item seamless
-migration
=[on|off
]
995 Enable
/disable spice seamless migration
. Default is off
.
1000 DEF("portrait", 0, QEMU_OPTION_portrait
,
1001 "-portrait rotate graphical output 90 deg left (only PXA LCD)\n",
1006 Rotate graphical output
90 deg
left (only PXA LCD
).
1009 DEF("rotate", HAS_ARG
, QEMU_OPTION_rotate
,
1010 "-rotate <deg> rotate graphical output some deg left (only PXA LCD)\n",
1015 Rotate graphical output some deg
left (only PXA LCD
).
1018 DEF("vga", HAS_ARG
, QEMU_OPTION_vga
,
1019 "-vga [std|cirrus|vmware|qxl|xenfb|none]\n"
1020 " select video card type\n", QEMU_ARCH_ALL
)
1022 @item
-vga @
var{type
}
1024 Select type of VGA card to emulate
. Valid values
for @
var{type
} are
1027 Cirrus Logic GD5446 Video card
. All Windows versions starting from
1028 Windows
95 should recognize and use
this graphic card
. For optimal
1029 performances
, use
16 bit color depth
in the guest and the host OS
.
1030 (This one is the
default)
1032 Standard VGA card with Bochs VBE extensions
. If your guest OS
1033 supports the VESA
2.0 VBE
extensions (e
.g
. Windows XP
) and
if you want
1034 to use high resolution
modes (>= 1280x1024x16
) then you should use
1037 VMWare SVGA
-II compatible adapter
. Use it
if you have sufficiently
1038 recent XFree86
/XOrg server or Windows guest with a driver
for this
1041 QXL paravirtual graphic card
. It is VGA
compatible (including VESA
1042 2.0 VBE support
). Works best with qxl guest drivers installed though
.
1043 Recommended choice when
using the spice protocol
.
1049 DEF("full-screen", 0, QEMU_OPTION_full_screen
,
1050 "-full-screen start in full screen\n", QEMU_ARCH_ALL
)
1053 @findex
-full
-screen
1054 Start
in full screen
.
1057 DEF("g", 1, QEMU_OPTION_g
,
1058 "-g WxH[xDEPTH] Set the initial graphical resolution and depth\n",
1059 QEMU_ARCH_PPC | QEMU_ARCH_SPARC
)
1061 @item
-g @
var{width
}x@
var{height
}[x@
var{depth
}]
1063 Set the initial graphical resolution and
depth (PPC
, SPARC only
).
1066 DEF("vnc", HAS_ARG
, QEMU_OPTION_vnc
,
1067 "-vnc display start a VNC server on display\n", QEMU_ARCH_ALL
)
1069 @item
-vnc @
var{display
}[,@
var{option
}[,@
var{option
}[,...]]]
1071 Normally
, QEMU uses SDL to display the VGA output
. With
this option
,
1072 you can have QEMU listen on VNC display @
var{display
} and redirect the VGA
1073 display over the VNC session
. It is very useful to enable the usb
1074 tablet device when
using this option (option @option
{-usbdevice
1075 tablet
}). When
using the VNC display
, you must use the @option
{-k
}
1076 parameter to set the keyboard layout
if you are not
using en
-us
. Valid
1077 syntax
for the @
var{display
} is
1081 @item @
var{host
}:@
var{d
}
1083 TCP connections will only be allowed from @
var{host
} on display @
var{d
}.
1084 By convention the TCP port is
5900+@
var{d
}. Optionally
, @
var{host
} can
1085 be omitted
in which
case the server will accept connections from any host
.
1087 @item unix
:@
var{path
}
1089 Connections will be allowed over UNIX domain sockets where @
var{path
} is the
1090 location of a unix socket to listen
for connections on
.
1094 VNC is initialized but not started
. The monitor @code
{change
} command
1095 can be used to later start the VNC server
.
1099 Following the @
var{display
} value there may be one or more @
var{option
} flags
1100 separated by commas
. Valid options are
1106 Connect to a listening VNC client via a ``reverse
'' connection
. The
1107 client is specified by the @
var{display
}. For reverse network
1108 connections (@
var{host
}:@
var{d
},@code
{reverse
}), the @
var{d
} argument
1109 is a TCP port number
, not a display number
.
1113 Opens an additional TCP listening port dedicated to VNC Websocket connections
.
1114 By defintion the Websocket port is
5700+@
var{display
}. If @
var{host
} is
1115 specified connections will only be allowed from
this host
.
1116 As an alternative the Websocket port could be specified by
using
1117 @code
{websocket
}=@
var{port
}.
1121 Require that password based authentication is used
for client connections
.
1123 The password must be set separately
using the @code
{set_password
} command
in
1124 the @ref
{pcsys_monitor
}. The syntax to change your password is
:
1125 @code
{set_password
<protocol
> <password
>} where
<protocol
> could be either
1128 If you would like to change
<protocol
> password expiration
, you should use
1129 @code
{expire_password
<protocol
> <expiration
-time
>} where expiration time could
1130 be one of the following options
: now
, never, +seconds or UNIX time of
1131 expiration
, e
.g
. +60 to make password expire
in 60 seconds
, or
1335196800
1132 to make password expire on
"Mon Apr 23 12:00:00 EDT 2012" (UNIX time
for this
1135 You can also use keywords
"now" or
"never" for the expiration time to
1136 allow
<protocol
> password to expire immediately or
never expire
.
1140 Require that client use TLS when communicating with the VNC server
. This
1141 uses anonymous TLS credentials so is susceptible to a man
-in-the
-middle
1142 attack
. It is recommended that
this option be combined with either the
1143 @option
{x509
} or @option
{x509verify
} options
.
1145 @item x509
=@
var{/path
/to
/certificate
/dir
}
1147 Valid
if @option
{tls
} is specified
. Require that x509 credentials are used
1148 for negotiating the TLS session
. The server will send its x509 certificate
1149 to the client
. It is recommended that a password be set on the VNC server
1150 to provide authentication of the client when
this is used
. The path following
1151 this option specifies where the x509 certificates are to be loaded from
.
1152 See the @ref
{vnc_security
} section
for details on generating certificates
.
1154 @item x509verify
=@
var{/path
/to
/certificate
/dir
}
1156 Valid
if @option
{tls
} is specified
. Require that x509 credentials are used
1157 for negotiating the TLS session
. The server will send its x509 certificate
1158 to the client
, and request that the client send its own x509 certificate
.
1159 The server will validate the client
's certificate against the CA certificate,
1160 and reject clients when validation fails. If the certificate authority is
1161 trusted, this is a sufficient authentication mechanism. You may still wish
1162 to set a password on the VNC server as a second authentication layer. The
1163 path following this option specifies where the x509 certificates are to
1164 be loaded from. See the @ref{vnc_security} section for details on generating
1169 Require that the client use SASL to authenticate with the VNC server.
1170 The exact choice of authentication method used is controlled from the
1171 system / user's SASL configuration file
for the
'qemu' service
. This
1172 is typically found
in /etc
/sasl2
/qemu
.conf
. If running QEMU as an
1173 unprivileged user
, an environment variable SASL_CONF_PATH can be used
1174 to make it search alternate locations
for the service config
.
1175 While some SASL auth methods can also provide data
encryption (eg GSSAPI
),
1176 it is recommended that SASL always be combined with the
'tls' and
1177 'x509' settings to enable use of SSL and server certificates
. This
1178 ensures a data encryption preventing compromise of authentication
1179 credentials
. See the @ref
{vnc_security
} section
for details on
using
1180 SASL authentication
.
1184 Turn on access control lists
for checking of the x509 client certificate
1185 and SASL party
. For x509 certs
, the ACL check is made against the
1186 certificate
's distinguished name. This is something that looks like
1187 @code{C=GB,O=ACME,L=Boston,CN=bob}. For SASL party, the ACL check is
1188 made against the username, which depending on the SASL plugin, may
1189 include a realm component, eg @code{bob} or @code{bob@@EXAMPLE.COM}.
1190 When the @option{acl} flag is set, the initial access list will be
1191 empty, with a @code{deny} policy. Thus no one will be allowed to
1192 use the VNC server until the ACLs have been loaded. This can be
1193 achieved using the @code{acl} monitor command.
1197 Enable lossy compression methods (gradient, JPEG, ...). If this
1198 option is set, VNC client may receive lossy framebuffer updates
1199 depending on its encoding settings. Enabling this option can save
1200 a lot of bandwidth at the expense of quality.
1204 Disable adaptive encodings. Adaptive encodings are enabled by default.
1205 An adaptive encoding will try to detect frequently updated screen regions,
1206 and send updates in these regions using a lossy encoding (like JPEG).
1207 This can be really helpful to save bandwidth when playing videos. Disabling
1208 adaptive encodings allows to restore the original static behavior of encodings
1211 @item share=[allow-exclusive|force-shared|ignore]
1213 Set display sharing policy. 'allow
-exclusive
' allows clients to ask
1214 for exclusive access. As suggested by the rfb spec this is
1215 implemented by dropping other connections. Connecting multiple
1216 clients in parallel requires all clients asking for a shared session
1217 (vncviewer: -shared switch). This is the default. 'force
-shared
'
1218 disables exclusive client access. Useful for shared desktop sessions,
1219 where you don't want someone forgetting specify
-shared disconnect
1220 everybody
else. 'ignore' completely ignores the shared flag and
1221 allows everybody connect unconditionally
. Doesn
't conform to the rfb
1222 spec but is traditional QEMU behavior.
1230 ARCHHEADING(, QEMU_ARCH_I386)
1232 ARCHHEADING(i386 target only:, QEMU_ARCH_I386)
1237 DEF("win2k-hack", 0, QEMU_OPTION_win2k_hack,
1238 "-win2k-hack use it when installing Windows 2000 to avoid a disk full bug\n",
1243 Use it when installing Windows 2000 to avoid a disk full bug. After
1244 Windows 2000 is installed, you no longer need this option (this option
1245 slows down the IDE transfers).
1248 HXCOMM Deprecated by -rtc
1249 DEF("rtc-td-hack", 0, QEMU_OPTION_rtc_td_hack, "", QEMU_ARCH_I386)
1251 DEF("no-fd-bootchk", 0, QEMU_OPTION_no_fd_bootchk,
1252 "-no-fd-bootchk disable boot signature checking for floppy disks\n",
1255 @item -no-fd-bootchk
1256 @findex -no-fd-bootchk
1257 Disable boot signature checking for floppy disks in Bochs BIOS. It may
1258 be needed to boot from old floppy disks.
1259 TODO: check reference to Bochs BIOS.
1262 DEF("no-acpi", 0, QEMU_OPTION_no_acpi,
1263 "-no-acpi disable ACPI\n", QEMU_ARCH_I386)
1267 Disable ACPI (Advanced Configuration and Power Interface) support. Use
1268 it if your guest OS complains about ACPI problems (PC target machine
1272 DEF("no-hpet", 0, QEMU_OPTION_no_hpet,
1273 "-no-hpet disable HPET\n", QEMU_ARCH_I386)
1277 Disable HPET support.
1280 DEF("acpitable", HAS_ARG, QEMU_OPTION_acpitable,
1281 "-acpitable [sig=str][,rev=n][,oem_id=str][,oem_table_id=str][,oem_rev=n][,asl_compiler_id=str][,asl_compiler_rev=n][,{data|file}=file1[:file2]...]\n"
1282 " ACPI table description\n", QEMU_ARCH_I386)
1284 @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}]...]
1286 Add ACPI table with specified header fields and context from specified files.
1287 For file=, take whole ACPI table from the specified files, including all
1288 ACPI headers (possible overridden by other options).
1289 For data=, only data
1290 portion of the table is used, all header information is specified in the
1294 DEF("smbios", HAS_ARG, QEMU_OPTION_smbios,
1295 "-smbios file=binary\n"
1296 " load SMBIOS entry from binary file\n"
1297 "-smbios type=0[,vendor=str][,version=str][,date=str][,release=%d.%d]\n"
1298 " specify SMBIOS type 0 fields\n"
1299 "-smbios type=1[,manufacturer=str][,product=str][,version=str][,serial=str]\n"
1300 " [,uuid=uuid][,sku=str][,family=str]\n"
1301 " specify SMBIOS type 1 fields\n", QEMU_ARCH_I386)
1303 @item -smbios file=@var{binary}
1305 Load SMBIOS entry from binary file.
1307 @item -smbios type=0[,vendor=@var{str}][,version=@var{str}][,date=@var{str}][,release=@var{%d.%d}]
1309 Specify SMBIOS type 0 fields
1311 @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}]
1312 Specify SMBIOS type 1 fields
1320 DEFHEADING(Network options:)
1325 HXCOMM Legacy slirp options (now moved to -net user):
1327 DEF("tftp", HAS_ARG, QEMU_OPTION_tftp, "", QEMU_ARCH_ALL)
1328 DEF("bootp", HAS_ARG, QEMU_OPTION_bootp, "", QEMU_ARCH_ALL)
1329 DEF("redir", HAS_ARG, QEMU_OPTION_redir, "", QEMU_ARCH_ALL)
1331 DEF("smb", HAS_ARG, QEMU_OPTION_smb, "", QEMU_ARCH_ALL)
1335 DEF("net", HAS_ARG, QEMU_OPTION_net,
1336 "-net nic[,vlan=n][,macaddr=mac][,model=type][,name=str][,addr=str][,vectors=v]\n"
1337 " create a new Network Interface Card and connect it to VLAN 'n
'\n"
1339 "-net user[,vlan=n][,name=str][,net=addr[/mask]][,host=addr][,restrict=on|off]\n"
1340 " [,hostname=host][,dhcpstart=addr][,dns=addr][,dnssearch=domain][,tftp=dir]\n"
1341 " [,bootfile=f][,hostfwd=rule][,guestfwd=rule]"
1343 "[,smb=dir[,smbserver=addr]]\n"
1345 " connect the user mode network stack to VLAN 'n
', configure its\n"
1346 " DHCP server and enabled optional services\n"
1349 "-net tap[,vlan=n][,name=str],ifname=name\n"
1350 " connect the host TAP network interface to VLAN 'n
'\n"
1352 "-net tap[,vlan=n][,name=str][,fd=h][,fds=x:y:...:z][,ifname=name][,script=file][,downscript=dfile][,helper=helper][,sndbuf=nbytes][,vnet_hdr=on|off][,vhost=on|off][,vhostfd=h][,vhostfds=x:y:...:z][,vhostforce=on|off][,queues=n]\n"
1353 " connect the host TAP network interface to VLAN 'n
'\n"
1354 " use network scripts 'file
' (default=" DEFAULT_NETWORK_SCRIPT ")\n"
1355 " to configure it and 'dfile
' (default=" DEFAULT_NETWORK_DOWN_SCRIPT ")\n"
1356 " to deconfigure it\n"
1357 " use '[down
]script
=no
' to disable script execution\n"
1358 " use network helper 'helper
' (default=" DEFAULT_BRIDGE_HELPER ") to\n"
1360 " use 'fd
=h
' to connect to an already opened TAP interface\n"
1361 " use 'fds
=x
:y
:...:z
' to connect to already opened multiqueue capable TAP interfaces\n"
1362 " use 'sndbuf
=nbytes
' to limit the size of the send buffer (the\n"
1363 " default is disabled 'sndbuf
=0' to enable flow control set 'sndbuf
=1048576')\n"
1364 " use vnet_hdr=off to avoid enabling the IFF_VNET_HDR tap flag\n"
1365 " use vnet_hdr=on to make the lack of IFF_VNET_HDR support an error condition\n"
1366 " use vhost=on to enable experimental in kernel accelerator\n"
1367 " (only has effect for virtio guests which use MSIX)\n"
1368 " use vhostforce=on to force vhost on for non-MSIX virtio guests\n"
1369 " use 'vhostfd
=h
' to connect to an already opened vhost net device\n"
1370 " use 'vhostfds
=x
:y
:...:z to connect to multiple already opened vhost net devices
\n"
1371 " use
'queues=n' to specify the number of queues to be created
for multiqueue TAP
\n"
1372 "-net bridge
[,vlan
=n
][,name
=str
][,br
=bridge
][,helper
=helper
]\n"
1373 " connects a host TAP network
interface to a host bridge device
'br'\n"
1374 " (default=" DEFAULT_BRIDGE_INTERFACE ") using the program
'helper'\n"
1375 " (default=" DEFAULT_BRIDGE_HELPER ")\n"
1377 "-net socket
[,vlan
=n
][,name
=str
][,fd
=h
][,listen
=[host
]:port
][,connect
=host
:port
]\n"
1378 " connect the vlan
'n' to another VLAN
using a socket connection
\n"
1379 "-net socket
[,vlan
=n
][,name
=str
][,fd
=h
][,mcast
=maddr
:port
[,localaddr
=addr
]]\n"
1380 " connect the vlan
'n' to multicast maddr and port
\n"
1381 " use
'localaddr=addr' to specify the host address to send packets from
\n"
1382 "-net socket
[,vlan
=n
][,name
=str
][,fd
=h
][,udp
=host
:port
][,localaddr
=host
:port
]\n"
1383 " connect the vlan
'n' to another VLAN
using an UDP tunnel
\n"
1385 "-net vde
[,vlan
=n
][,name
=str
][,sock
=socketpath
][,port
=n
][,group
=groupname
][,mode
=octalmode
]\n"
1386 " connect the vlan
'n' to port
'n' of a vde
switch running
\n"
1387 " on host and listening
for incoming connections on
'socketpath'.\n"
1388 " Use group
'groupname' and mode
'octalmode' to change
default\n"
1389 " ownership and permissions
for communication port
.\n"
1391 "-net dump
[,vlan
=n
][,file
=f
][,len
=n
]\n"
1392 " dump traffic on vlan
'n' to file
'f' (max n bytes per packet
)\n"
1393 "-net none use it alone to have zero network devices
. If no
-net option
\n"
1394 " is provided
, the
default is
'-net nic -net user'\n", QEMU_ARCH_ALL)
1395 DEF("netdev
", HAS_ARG, QEMU_OPTION_netdev,
1405 "socket
],id
=str
[,option
][,option
][,...]\n", QEMU_ARCH_ALL)
1407 @item -net nic[,vlan=@var{n}][,macaddr=@var{mac}][,model=@var{type}] [,name=@var{name}][,addr=@var{addr}][,vectors=@var{v}]
1409 Create a new Network Interface Card and connect it to VLAN @var{n} (@var{n}
1410 = 0 is the default). The NIC is an e1000 by default on the PC
1411 target. Optionally, the MAC address can be changed to @var{mac}, the
1412 device address set to @var{addr} (PCI cards only),
1413 and a @var{name} can be assigned for use in monitor commands.
1414 Optionally, for PCI cards, you can specify the number @var{v} of MSI-X vectors
1415 that the card should have; this option currently only affects virtio cards; set
1416 @var{v} = 0 to disable MSI-X. If no @option{-net} option is specified, a single
1417 NIC is created. QEMU can emulate several different models of network card.
1418 Valid values for @var{type} are
1419 @code{virtio}, @code{i82551}, @code{i82557b}, @code{i82559er},
1420 @code{ne2k_pci}, @code{ne2k_isa}, @code{pcnet}, @code{rtl8139},
1421 @code{e1000}, @code{smc91c111}, @code{lance} and @code{mcf_fec}.
1422 Not all devices are supported on all targets. Use @code{-net nic,model=help}
1423 for a list of available devices for your target.
1425 @item -netdev user,id=@var{id}[,@var{option}][,@var{option}][,...]
1426 @item -net user[,@var{option}][,@var{option}][,...]
1427 Use the user mode network stack which requires no administrator
1428 privilege to run. Valid options are:
1432 Connect user mode stack to VLAN @var{n} (@var{n} = 0 is the default).
1435 @item name=@var{name}
1436 Assign symbolic name for use in monitor commands.
1438 @item net=@var{addr}[/@var{mask}]
1439 Set IP network address the guest will see. Optionally specify the netmask,
1440 either in the form a.b.c.d or as number of valid top-most bits. Default is
1443 @item host=@var{addr}
1444 Specify the guest-visible address of the host. Default is the 2nd IP in the
1445 guest network, i.e. x.x.x.2.
1447 @item restrict=on|off
1448 If this option is enabled, the guest will be isolated, i.e. it will not be
1449 able to contact the host and no guest IP packets will be routed over the host
1450 to the outside. This option does not affect any explicitly set forwarding rules.
1452 @item hostname=@var{name}
1453 Specifies the client hostname reported by the built-in DHCP server.
1455 @item dhcpstart=@var{addr}
1456 Specify the first of the 16 IPs the built-in DHCP server can assign. Default
1457 is the 15th to 31st IP in the guest network, i.e. x.x.x.15 to x.x.x.31.
1459 @item dns=@var{addr}
1460 Specify the guest-visible address of the virtual nameserver. The address must
1461 be different from the host address. Default is the 3rd IP in the guest network,
1464 @item dnssearch=@var{domain}
1465 Provides an entry for the domain-search list sent by the built-in
1466 DHCP server. More than one domain suffix can be transmitted by specifying
1467 this option multiple times. If supported, this will cause the guest to
1468 automatically try to append the given domain suffix(es) in case a domain name
1469 can not be resolved.
1473 qemu -net user,dnssearch=mgmt.example.org,dnssearch=example.org [...]
1476 @item tftp=@var{dir}
1477 When using the user mode network stack, activate a built-in TFTP
1478 server. The files in @var{dir} will be exposed as the root of a TFTP server.
1479 The TFTP client on the guest must be configured in binary mode (use the command
1480 @code{bin} of the Unix TFTP client).
1482 @item bootfile=@var{file}
1483 When using the user mode network stack, broadcast @var{file} as the BOOTP
1484 filename. In conjunction with @option{tftp}, this can be used to network boot
1485 a guest from a local directory.
1487 Example (using pxelinux):
1489 qemu-system-i386 -hda linux.img -boot n -net user,tftp=/path/to/tftp/files,bootfile=/pxelinux.0
1492 @item smb=@var{dir}[,smbserver=@var{addr}]
1493 When using the user mode network stack, activate a built-in SMB
1494 server so that Windows OSes can access to the host files in @file{@var{dir}}
1495 transparently. The IP address of the SMB server can be set to @var{addr}. By
1496 default the 4th IP in the guest network is used, i.e. x.x.x.4.
1498 In the guest Windows OS, the line:
1502 must be added in the file @file{C:\WINDOWS\LMHOSTS} (for windows 9x/Me)
1503 or @file{C:\WINNT\SYSTEM32\DRIVERS\ETC\LMHOSTS} (Windows NT/2000).
1505 Then @file{@var{dir}} can be accessed in @file{\\smbserver\qemu}.
1507 Note that a SAMBA server must be installed on the host OS.
1508 QEMU was tested successfully with smbd versions from Red Hat 9,
1509 Fedora Core 3 and OpenSUSE 11.x.
1511 @item hostfwd=[tcp|udp]:[@var{hostaddr}]:@var{hostport}-[@var{guestaddr}]:@var{guestport}
1512 Redirect incoming TCP or UDP connections to the host port @var{hostport} to
1513 the guest IP address @var{guestaddr} on guest port @var{guestport}. If
1514 @var{guestaddr} is not specified, its value is x.x.x.15 (default first address
1515 given by the built-in DHCP server). By specifying @var{hostaddr}, the rule can
1516 be bound to a specific host interface. If no connection type is set, TCP is
1517 used. This option can be given multiple times.
1519 For example, to redirect host X11 connection from screen 1 to guest
1520 screen 0, use the following:
1524 qemu-system-i386 -net user,hostfwd=tcp:127.0.0.1:6001-:6000 [...]
1525 # this host xterm should open in the guest X11 server
1529 To redirect telnet connections from host port 5555 to telnet port on
1530 the guest, use the following:
1534 qemu-system-i386 -net user,hostfwd=tcp::5555-:23 [...]
1535 telnet localhost 5555
1538 Then when you use on the host @code{telnet localhost 5555}, you
1539 connect to the guest telnet server.
1541 @item guestfwd=[tcp]:@var{server}:@var{port}-@var{dev}
1542 @item guestfwd=[tcp]:@var{server}:@var{port}-@var{cmd:command}
1543 Forward guest TCP connections to the IP address @var{server} on port @var{port}
1544 to the character device @var{dev} or to a program executed by @var{cmd:command}
1545 which gets spawned for each connection. This option can be given multiple times.
1547 You can either use a chardev directly and have that one used throughout QEMU's
1548 lifetime, like in the following example:
1551 # open 10.10.1.1:4321 on bootup, connect 10.0.2.100:1234 to it whenever
1552 # the guest accesses it
1553 qemu -net user,guestfwd=tcp:10.0.2.100:1234-tcp:10.10.1.1:4321 [...]
1556 Or you can execute a command on every TCP connection established by the guest,
1557 so that QEMU behaves similar to an inetd process for that virtual server:
1560 # call "netcat
10.10.1.1 4321" on every TCP connection to 10.0.2.100:1234
1561 # and connect the TCP stream to its stdin/stdout
1562 qemu -net 'user,guestfwd=tcp:10.0.2.100:1234-cmd:netcat 10.10.1.1 4321'
1567 Note: Legacy stand-alone options -tftp, -bootp, -smb and -redir are still
1568 processed and applied to -net user. Mixing them with the new configuration
1569 syntax gives undefined results. Their use for new applications is discouraged
1570 as they will be removed from future versions.
1572 @item -netdev tap,id=@var{id}[,fd=@var{h}][,ifname=@var{name}][,script=@var{file}][,downscript=@var{dfile}][,helper=@var{helper}]
1573 @item -net tap[,vlan=@var{n}][,name=@var{name}][,fd=@var{h}][,ifname=@var{name}][,script=@var{file}][,downscript=@var{dfile}][,helper=@var{helper}]
1574 Connect the host TAP network interface @var{name} to VLAN @var{n}.
1576 Use the network script @var{file} to configure it and the network script
1577 @var{dfile} to deconfigure it. If @var{name} is not provided, the OS
1578 automatically provides one. The default network configure script is
1579 @file{/etc/qemu-ifup} and the default network deconfigure script is
1580 @file{/etc/qemu-ifdown}. Use @option{script=no} or @option{downscript=no}
1581 to disable script execution.
1583 If running QEMU as an unprivileged user, use the network helper
1584 @var{helper} to configure the TAP interface. The default network
1585 helper executable is @file{/usr/local/libexec/qemu-bridge-helper}.
1587 @option{fd}=@var{h} can be used to specify the handle of an already
1588 opened host TAP interface.
1593 #launch a QEMU instance with the default network script
1594 qemu-system-i386 linux.img -net nic -net tap
1598 #launch a QEMU instance with two NICs, each one connected
1600 qemu-system-i386 linux.img \
1601 -net nic,vlan=0 -net tap,vlan=0,ifname=tap0 \
1602 -net nic,vlan=1 -net tap,vlan=1,ifname=tap1
1606 #launch a QEMU instance with the default network helper to
1607 #connect a TAP device to bridge br0
1608 qemu-system-i386 linux.img \
1609 -net nic -net tap,"helper
=/usr
/local
/libexec
/qemu
-bridge
-helper
"
1612 @item -netdev bridge,id=@var{id}[,br=@var{bridge}][,helper=@var{helper}]
1613 @item -net bridge[,vlan=@var{n}][,name=@var{name}][,br=@var{bridge}][,helper=@var{helper}]
1614 Connect a host TAP network interface to a host bridge device.
1616 Use the network helper @var{helper} to configure the TAP interface and
1617 attach it to the bridge. The default network helper executable is
1618 @file{/usr/local/libexec/qemu-bridge-helper} and the default bridge
1619 device is @file{br0}.
1624 #launch a QEMU instance with the default network helper to
1625 #connect a TAP device to bridge br0
1626 qemu-system-i386 linux.img -net bridge -net nic,model=virtio
1630 #launch a QEMU instance with the default network helper to
1631 #connect a TAP device to bridge qemubr0
1632 qemu-system-i386 linux.img -net bridge,br=qemubr0 -net nic,model=virtio
1635 @item -netdev socket,id=@var{id}[,fd=@var{h}][,listen=[@var{host}]:@var{port}][,connect=@var{host}:@var{port}]
1636 @item -net socket[,vlan=@var{n}][,name=@var{name}][,fd=@var{h}] [,listen=[@var{host}]:@var{port}][,connect=@var{host}:@var{port}]
1638 Connect the VLAN @var{n} to a remote VLAN in another QEMU virtual
1639 machine using a TCP socket connection. If @option{listen} is
1640 specified, QEMU waits for incoming connections on @var{port}
1641 (@var{host} is optional). @option{connect} is used to connect to
1642 another QEMU instance using the @option{listen} option. @option{fd}=@var{h}
1643 specifies an already opened TCP socket.
1647 # launch a first QEMU instance
1648 qemu-system-i386 linux.img \
1649 -net nic,macaddr=52:54:00:12:34:56 \
1650 -net socket,listen=:1234
1651 # connect the VLAN 0 of this instance to the VLAN 0
1652 # of the first instance
1653 qemu-system-i386 linux.img \
1654 -net nic,macaddr=52:54:00:12:34:57 \
1655 -net socket,connect=127.0.0.1:1234
1658 @item -netdev socket,id=@var{id}[,fd=@var{h}][,mcast=@var{maddr}:@var{port}[,localaddr=@var{addr}]]
1659 @item -net socket[,vlan=@var{n}][,name=@var{name}][,fd=@var{h}][,mcast=@var{maddr}:@var{port}[,localaddr=@var{addr}]]
1661 Create a VLAN @var{n} shared with another QEMU virtual
1662 machines using a UDP multicast socket, effectively making a bus for
1663 every QEMU with same multicast address @var{maddr} and @var{port}.
1667 Several QEMU can be running on different hosts and share same bus (assuming
1668 correct multicast setup for these hosts).
1670 mcast support is compatible with User Mode Linux (argument @option{eth@var{N}=mcast}), see
1671 @url{http://user-mode-linux.sf.net}.
1673 Use @option{fd=h} to specify an already opened UDP multicast socket.
1678 # launch one QEMU instance
1679 qemu-system-i386 linux.img \
1680 -net nic,macaddr=52:54:00:12:34:56 \
1681 -net socket,mcast=230.0.0.1:1234
1682 # launch another QEMU instance on same "bus
"
1683 qemu-system-i386 linux.img \
1684 -net nic,macaddr=52:54:00:12:34:57 \
1685 -net socket,mcast=230.0.0.1:1234
1686 # launch yet another QEMU instance on same "bus
"
1687 qemu-system-i386 linux.img \
1688 -net nic,macaddr=52:54:00:12:34:58 \
1689 -net socket,mcast=230.0.0.1:1234
1692 Example (User Mode Linux compat.):
1694 # launch QEMU instance (note mcast address selected
1696 qemu-system-i386 linux.img \
1697 -net nic,macaddr=52:54:00:12:34:56 \
1698 -net socket,mcast=239.192.168.1:1102
1700 /path/to/linux ubd0=/path/to/root_fs eth0=mcast
1703 Example (send packets from host's 1.2.3.4):
1705 qemu-system-i386 linux.img \
1706 -net nic,macaddr=52:54:00:12:34:56 \
1707 -net socket,mcast=239.192.168.1:1102,localaddr=1.2.3.4
1710 @item -netdev vde,id=@var{id}[,sock=@var{socketpath}][,port=@var{n}][,group=@var{groupname}][,mode=@var{octalmode}]
1711 @item -net vde[,vlan=@var{n}][,name=@var{name}][,sock=@var{socketpath}] [,port=@var{n}][,group=@var{groupname}][,mode=@var{octalmode}]
1712 Connect VLAN @var{n} to PORT @var{n} of a vde switch running on host and
1713 listening for incoming connections on @var{socketpath}. Use GROUP @var{groupname}
1714 and MODE @var{octalmode} to change default ownership and permissions for
1715 communication port. This option is only available if QEMU has been compiled
1716 with vde support enabled.
1721 vde_switch -F -sock /tmp/myswitch
1722 # launch QEMU instance
1723 qemu-system-i386 linux.img -net nic -net vde,sock=/tmp/myswitch
1726 @item -net dump[,vlan=@var{n}][,file=@var{file}][,len=@var{len}]
1727 Dump network traffic on VLAN @var{n} to file @var{file} (@file{qemu-vlan0.pcap} by default).
1728 At most @var{len} bytes (64k by default) per packet are stored. The file format is
1729 libpcap, so it can be analyzed with tools such as tcpdump or Wireshark.
1732 Indicate that no network devices should be configured. It is used to
1733 override the default configuration (@option{-net nic -net user}) which
1734 is activated if no @option{-net} options are provided.
1742 DEFHEADING(Character device options:)
1745 The general form of a character device option is:
1749 DEF("chardev
", HAS_ARG, QEMU_OPTION_chardev,
1750 "-chardev
null,id
=id
[,mux
=on|off
]\n"
1751 "-chardev socket
,id
=id
[,host
=host
],port
=host
[,to
=to
][,ipv4
][,ipv6
][,nodelay
]\n"
1752 " [,server
][,nowait
][,telnet
][,mux
=on|off
] (tcp
)\n"
1753 "-chardev socket
,id
=id
,path
=path
[,server
][,nowait
][,telnet
],[mux
=on|off
] (unix
)\n"
1754 "-chardev udp
,id
=id
[,host
=host
],port
=port
[,localaddr
=localaddr
]\n"
1755 " [,localport
=localport
][,ipv4
][,ipv6
][,mux
=on|off
]\n"
1756 "-chardev msmouse
,id
=id
[,mux
=on|off
]\n"
1757 "-chardev vc
,id
=id
[[,width
=width
][,height
=height
]][[,cols
=cols
][,rows
=rows
]]\n"
1759 "-chardev ringbuf
,id
=id
[,size
=size
]\n"
1760 "-chardev file
,id
=id
,path
=path
[,mux
=on|off
]\n"
1761 "-chardev pipe
,id
=id
,path
=path
[,mux
=on|off
]\n"
1763 "-chardev console
,id
=id
[,mux
=on|off
]\n"
1764 "-chardev serial
,id
=id
,path
=path
[,mux
=on|off
]\n"
1766 "-chardev pty
,id
=id
[,mux
=on|off
]\n"
1767 "-chardev stdio
,id
=id
[,mux
=on|off
][,signal
=on|off
]\n"
1769 #ifdef CONFIG_BRLAPI
1770 "-chardev braille
,id
=id
[,mux
=on|off
]\n"
1772 #if defined(__linux__) || defined(__sun__) || defined(__FreeBSD__) \
1773 || defined(__NetBSD__) || defined(__OpenBSD__) || defined(__DragonFly__)
1774 "-chardev serial
,id
=id
,path
=path
[,mux
=on|off
]\n"
1775 "-chardev tty
,id
=id
,path
=path
[,mux
=on|off
]\n"
1777 #if defined(__linux__) || defined(__FreeBSD__) || defined(__DragonFly__)
1778 "-chardev parallel
,id
=id
,path
=path
[,mux
=on|off
]\n"
1779 "-chardev parport
,id
=id
,path
=path
[,mux
=on|off
]\n"
1781 #if defined(CONFIG_SPICE)
1782 "-chardev spicevmc
,id
=id
,name
=name
[,debug
=debug
]\n"
1783 "-chardev spiceport
,id
=id
,name
=name
[,debug
=debug
]\n"
1789 @item -chardev @var{backend} ,id=@var{id} [,mux=on|off] [,@var{options}]
1810 The specific backend will determine the applicable options.
1812 All devices must have an id, which can be any string up to 127 characters long.
1813 It is used to uniquely identify this device in other command line directives.
1815 A character device may be used in multiplexing mode by multiple front-ends.
1816 The key sequence of @key{Control-a} and @key{c} will rotate the input focus
1817 between attached front-ends. Specify @option{mux=on} to enable this mode.
1819 Options to each backend are described below.
1821 @item -chardev null ,id=@var{id}
1822 A void device. This device will not emit any data, and will drop any data it
1823 receives. The null backend does not take any options.
1825 @item -chardev socket ,id=@var{id} [@var{TCP options} or @var{unix options}] [,server] [,nowait] [,telnet]
1827 Create a two-way stream socket, which can be either a TCP or a unix socket. A
1828 unix socket will be created if @option{path} is specified. Behaviour is
1829 undefined if TCP options are specified for a unix socket.
1831 @option{server} specifies that the socket shall be a listening socket.
1833 @option{nowait} specifies that QEMU should not block waiting for a client to
1834 connect to a listening socket.
1836 @option{telnet} specifies that traffic on the socket should interpret telnet
1839 TCP and unix socket options are given below:
1843 @item TCP options: port=@var{port} [,host=@var{host}] [,to=@var{to}] [,ipv4] [,ipv6] [,nodelay]
1845 @option{host} for a listening socket specifies the local address to be bound.
1846 For a connecting socket species the remote host to connect to. @option{host} is
1847 optional for listening sockets. If not specified it defaults to @code{0.0.0.0}.
1849 @option{port} for a listening socket specifies the local port to be bound. For a
1850 connecting socket specifies the port on the remote host to connect to.
1851 @option{port} can be given as either a port number or a service name.
1852 @option{port} is required.
1854 @option{to} is only relevant to listening sockets. If it is specified, and
1855 @option{port} cannot be bound, QEMU will attempt to bind to subsequent ports up
1856 to and including @option{to} until it succeeds. @option{to} must be specified
1859 @option{ipv4} and @option{ipv6} specify that either IPv4 or IPv6 must be used.
1860 If neither is specified the socket may use either protocol.
1862 @option{nodelay} disables the Nagle algorithm.
1864 @item unix options: path=@var{path}
1866 @option{path} specifies the local path of the unix socket. @option{path} is
1871 @item -chardev udp ,id=@var{id} [,host=@var{host}] ,port=@var{port} [,localaddr=@var{localaddr}] [,localport=@var{localport}] [,ipv4] [,ipv6]
1873 Sends all traffic from the guest to a remote host over UDP.
1875 @option{host} specifies the remote host to connect to. If not specified it
1876 defaults to @code{localhost}.
1878 @option{port} specifies the port on the remote host to connect to. @option{port}
1881 @option{localaddr} specifies the local address to bind to. If not specified it
1882 defaults to @code{0.0.0.0}.
1884 @option{localport} specifies the local port to bind to. If not specified any
1885 available local port will be used.
1887 @option{ipv4} and @option{ipv6} specify that either IPv4 or IPv6 must be used.
1888 If neither is specified the device may use either protocol.
1890 @item -chardev msmouse ,id=@var{id}
1892 Forward QEMU's emulated msmouse events to the guest. @option{msmouse} does not
1895 @item -chardev vc ,id=@var{id} [[,width=@var{width}] [,height=@var{height}]] [[,cols=@var{cols}] [,rows=@var{rows}]]
1897 Connect to a QEMU text console. @option{vc} may optionally be given a specific
1900 @option{width} and @option{height} specify the width and height respectively of
1901 the console, in pixels.
1903 @option{cols} and @option{rows} specify that the console be sized to fit a text
1904 console with the given dimensions.
1906 @item -chardev ringbuf ,id=@var{id} [,size=@var{size}]
1908 Create a ring buffer with fixed size @option{size}.
1909 @var{size} must be a power of two, and defaults to @code{64K}).
1911 @item -chardev file ,id=@var{id} ,path=@var{path}
1913 Log all traffic received from the guest to a file.
1915 @option{path} specifies the path of the file to be opened. This file will be
1916 created if it does not already exist, and overwritten if it does. @option{path}
1919 @item -chardev pipe ,id=@var{id} ,path=@var{path}
1921 Create a two-way connection to the guest. The behaviour differs slightly between
1922 Windows hosts and other hosts:
1924 On Windows, a single duplex pipe will be created at
1925 @file{\\.pipe\@option{path}}.
1927 On other hosts, 2 pipes will be created called @file{@option{path}.in} and
1928 @file{@option{path}.out}. Data written to @file{@option{path}.in} will be
1929 received by the guest. Data written by the guest can be read from
1930 @file{@option{path}.out}. QEMU will not create these fifos, and requires them to
1933 @option{path} forms part of the pipe path as described above. @option{path} is
1936 @item -chardev console ,id=@var{id}
1938 Send traffic from the guest to QEMU's standard output. @option{console} does not
1941 @option{console} is only available on Windows hosts.
1943 @item -chardev serial ,id=@var{id} ,path=@option{path}
1945 Send traffic from the guest to a serial device on the host.
1947 On Unix hosts serial will actually accept any tty device,
1948 not only serial lines.
1950 @option{path} specifies the name of the serial device to open.
1952 @item -chardev pty ,id=@var{id}
1954 Create a new pseudo-terminal on the host and connect to it. @option{pty} does
1955 not take any options.
1957 @option{pty} is not available on Windows hosts.
1959 @item -chardev stdio ,id=@var{id} [,signal=on|off]
1960 Connect to standard input and standard output of the QEMU process.
1962 @option{signal} controls if signals are enabled on the terminal, that includes
1963 exiting QEMU with the key sequence @key{Control-c}. This option is enabled by
1964 default, use @option{signal=off} to disable it.
1966 @option{stdio} is not available on Windows hosts.
1968 @item -chardev braille ,id=@var{id}
1970 Connect to a local BrlAPI server. @option{braille} does not take any options.
1972 @item -chardev tty ,id=@var{id} ,path=@var{path}
1974 @option{tty} is only available on Linux, Sun, FreeBSD, NetBSD, OpenBSD and
1975 DragonFlyBSD hosts. It is an alias for @option{serial}.
1977 @option{path} specifies the path to the tty. @option{path} is required.
1979 @item -chardev parallel ,id=@var{id} ,path=@var{path}
1980 @item -chardev parport ,id=@var{id} ,path=@var{path}
1982 @option{parallel} is only available on Linux, FreeBSD and DragonFlyBSD hosts.
1984 Connect to a local parallel port.
1986 @option{path} specifies the path to the parallel port device. @option{path} is
1989 @item -chardev spicevmc ,id=@var{id} ,debug=@var{debug}, name=@var{name}
1991 @option{spicevmc} is only available when spice support is built in.
1993 @option{debug} debug level for spicevmc
1995 @option{name} name of spice channel to connect to
1997 Connect to a spice virtual machine channel, such as vdiport.
1999 @item -chardev spiceport ,id=@var{id} ,debug=@var{debug}, name=@var{name}
2001 @option{spiceport} is only available when spice support is built in.
2003 @option{debug} debug level for spicevmc
2005 @option{name} name of spice port to connect to
2007 Connect to a spice port, allowing a Spice client to handle the traffic
2008 identified by a name (preferably a fqdn).
2016 DEFHEADING(Device URL Syntax:)
2019 In addition to using normal file images for the emulated storage devices,
2020 QEMU can also use networked resources such as iSCSI devices. These are
2021 specified using a special URL syntax.
2025 iSCSI support allows QEMU to access iSCSI resources directly and use as
2026 images for the guest storage. Both disk and cdrom images are supported.
2028 Syntax for specifying iSCSI LUNs is
2029 ``iscsi://<target-ip>[:<port>]/<target-iqn>/<lun>''
2031 By default qemu will use the iSCSI initiator-name
2032 'iqn.2008-11.org.linux-kvm[:<name>]' but this can also be set from the command
2033 line or a configuration file.
2036 Example (without authentication):
2038 qemu-system-i386 -iscsi initiator-name=iqn.2001-04.com.example:my-initiator \
2039 -cdrom iscsi://192.0.2.1/iqn.2001-04.com.example/2 \
2040 -drive file=iscsi://192.0.2.1/iqn.2001-04.com.example/1
2043 Example (CHAP username/password via URL):
2045 qemu-system-i386 -drive file=iscsi://user%password@@192.0.2.1/iqn.2001-04.com.example/1
2048 Example (CHAP username/password via environment variables):
2050 LIBISCSI_CHAP_USERNAME="user
" \
2051 LIBISCSI_CHAP_PASSWORD="password
" \
2052 qemu-system-i386 -drive file=iscsi://192.0.2.1/iqn.2001-04.com.example/1
2055 iSCSI support is an optional feature of QEMU and only available when
2056 compiled and linked against libiscsi.
2058 DEF("iscsi
", HAS_ARG, QEMU_OPTION_iscsi,
2059 "-iscsi
[user
=user
][,password
=password
]\n"
2060 " [,header
-digest
=CRC32C|CR32C
-NONE|NONE
-CRC32C|NONE
\n"
2061 " [,initiator
-name
=iqn
]\n"
2062 " iSCSI session parameters
\n", QEMU_ARCH_ALL)
2065 iSCSI parameters such as username and password can also be specified via
2066 a configuration file. See qemu-doc for more information and examples.
2069 QEMU supports NBD (Network Block Devices) both using TCP protocol as well
2070 as Unix Domain Sockets.
2072 Syntax for specifying a NBD device using TCP
2073 ``nbd:<server-ip>:<port>[:exportname=<export>]''
2075 Syntax for specifying a NBD device using Unix Domain Sockets
2076 ``nbd:unix:<domain-socket>[:exportname=<export>]''
2081 qemu-system-i386 --drive file=nbd:192.0.2.1:30000
2084 Example for Unix Domain Sockets
2086 qemu-system-i386 --drive file=nbd:unix:/tmp/nbd-socket
2090 Sheepdog is a distributed storage system for QEMU.
2091 QEMU supports using either local sheepdog devices or remote networked
2094 Syntax for specifying a sheepdog device
2096 ``sheepdog:<vdiname>''
2098 ``sheepdog:<vdiname>:<snapid>''
2100 ``sheepdog:<vdiname>:<tag>''
2102 ``sheepdog:<host>:<port>:<vdiname>''
2104 ``sheepdog:<host>:<port>:<vdiname>:<snapid>''
2106 ``sheepdog:<host>:<port>:<vdiname>:<tag>''
2111 qemu-system-i386 --drive file=sheepdog:192.0.2.1:30000:MyVirtualMachine
2114 See also @url{http://http://www.osrg.net/sheepdog/}.
2117 GlusterFS is an user space distributed file system.
2118 QEMU supports the use of GlusterFS volumes for hosting VM disk images using
2119 TCP, Unix Domain Sockets and RDMA transport protocols.
2121 Syntax for specifying a VM disk image on GlusterFS volume is
2123 gluster[+transport]://[server[:port]]/volname/image[?socket=...]
2129 qemu-system-x86_84 --drive file=gluster://192.0.2.1/testvol/a.img
2132 See also @url{http://www.gluster.org}.
2139 DEFHEADING(Bluetooth(R) options:)
2144 DEF("bt
", HAS_ARG, QEMU_OPTION_bt, \
2145 "-bt hci
,null dumb bluetooth HCI
- doesn
't respond to commands\n" \
2146 "-bt hci,host[:id]\n" \
2147 " use host's HCI with the given name
\n" \
2148 "-bt hci
[,vlan
=n
]\n" \
2149 " emulate a standard HCI
in virtual scatternet
'n'\n" \
2150 "-bt vhci
[,vlan
=n
]\n" \
2151 " add host computer to virtual scatternet
'n' using VHCI
\n" \
2152 "-bt device
:dev
[,vlan
=n
]\n" \
2153 " emulate a bluetooth device
'dev' in scatternet
'n'\n",
2158 Defines the function of the corresponding Bluetooth HCI. -bt options
2159 are matched with the HCIs present in the chosen machine type. For
2160 example when emulating a machine with only one HCI built into it, only
2161 the first @code{-bt hci[...]} option is valid and defines the HCI's
2162 logic. The Transport Layer is decided by the machine type. Currently
2163 the machines @code{n800} and @code{n810} have one HCI and all other
2167 The following three types are recognized:
2171 (default) The corresponding Bluetooth HCI assumes no internal logic
2172 and will not respond to any HCI commands or emit events.
2174 @item -bt hci,host[:@var{id}]
2175 (@code{bluez} only) The corresponding HCI passes commands / events
2176 to / from the physical HCI identified by the name @var{id} (default:
2177 @code{hci0}) on the computer running QEMU. Only available on @code{bluez}
2178 capable systems like Linux.
2180 @item -bt hci[,vlan=@var{n}]
2181 Add a virtual, standard HCI that will participate in the Bluetooth
2182 scatternet @var{n} (default @code{0}). Similarly to @option{-net}
2183 VLANs, devices inside a bluetooth network @var{n} can only communicate
2184 with other devices in the same network (scatternet).
2187 @item -bt vhci[,vlan=@var{n}]
2188 (Linux-host only) Create a HCI in scatternet @var{n} (default 0) attached
2189 to the host bluetooth stack instead of to the emulated target. This
2190 allows the host and target machines to participate in a common scatternet
2191 and communicate. Requires the Linux @code{vhci} driver installed. Can
2192 be used as following:
2195 qemu-system-i386 [...OPTIONS...] -bt hci,vlan=5 -bt vhci,vlan=5
2198 @item -bt device:@var{dev}[,vlan=@var{n}]
2199 Emulate a bluetooth device @var{dev} and place it in network @var{n}
2200 (default @code{0}). QEMU can only emulate one type of bluetooth devices
2205 Virtual wireless keyboard implementing the HIDP bluetooth profile.
2214 DEFHEADING(Linux/Multiboot boot specific:)
2217 When using these options, you can use a given Linux or Multiboot
2218 kernel without installing it in the disk image. It can be useful
2219 for easier testing of various kernels.
2224 DEF("kernel
", HAS_ARG, QEMU_OPTION_kernel, \
2225 "-kernel bzImage use
'bzImage' as kernel image
\n", QEMU_ARCH_ALL)
2227 @item -kernel @var{bzImage}
2229 Use @var{bzImage} as kernel image. The kernel can be either a Linux kernel
2230 or in multiboot format.
2233 DEF("append
", HAS_ARG, QEMU_OPTION_append, \
2234 "-append cmdline use
'cmdline' as kernel command line
\n", QEMU_ARCH_ALL)
2236 @item -append @var{cmdline}
2238 Use @var{cmdline} as kernel command line
2241 DEF("initrd
", HAS_ARG, QEMU_OPTION_initrd, \
2242 "-initrd file use
'file' as initial ram disk
\n", QEMU_ARCH_ALL)
2244 @item -initrd @var{file}
2246 Use @var{file} as initial ram disk.
2248 @item -initrd "@
var{file1
} arg
=foo
,@
var{file2
}"
2250 This syntax is only available with multiboot.
2252 Use @var{file1} and @var{file2} as modules and pass arg=foo as parameter to the
2256 DEF("dtb
", HAS_ARG, QEMU_OPTION_dtb, \
2257 "-dtb file use
'file' as device tree image
\n", QEMU_ARCH_ALL)
2259 @item -dtb @var{file}
2261 Use @var{file} as a device tree binary (dtb) image and pass it to the kernel
2270 DEFHEADING(Debug/Expert options:)
2275 DEF("serial
", HAS_ARG, QEMU_OPTION_serial, \
2276 "-serial dev redirect the serial port to char device
'dev'\n",
2279 @item -serial @var{dev}
2281 Redirect the virtual serial port to host character device
2282 @var{dev}. The default device is @code{vc} in graphical mode and
2283 @code{stdio} in non graphical mode.
2285 This option can be used several times to simulate up to 4 serial
2288 Use @code{-serial none} to disable all serial ports.
2290 Available character devices are:
2292 @item vc[:@var{W}x@var{H}]
2293 Virtual console. Optionally, a width and height can be given in pixel with
2297 It is also possible to specify width or height in characters:
2302 [Linux only] Pseudo TTY (a new PTY is automatically allocated)
2304 No device is allocated.
2308 [Linux only] Use host tty, e.g. @file{/dev/ttyS0}. The host serial port
2309 parameters are set according to the emulated ones.
2310 @item /dev/parport@var{N}
2311 [Linux only, parallel port only] Use host parallel port
2312 @var{N}. Currently SPP and EPP parallel port features can be used.
2313 @item file:@var{filename}
2314 Write output to @var{filename}. No character can be read.
2316 [Unix only] standard input/output
2317 @item pipe:@var{filename}
2318 name pipe @var{filename}
2320 [Windows only] Use host serial port @var{n}
2321 @item udp:[@var{remote_host}]:@var{remote_port}[@@[@var{src_ip}]:@var{src_port}]
2322 This implements UDP Net Console.
2323 When @var{remote_host} or @var{src_ip} are not specified
2324 they default to @code{0.0.0.0}.
2325 When not using a specified @var{src_port} a random port is automatically chosen.
2327 If you just want a simple readonly console you can use @code{netcat} or
2328 @code{nc}, by starting QEMU with: @code{-serial udp::4555} and nc as:
2329 @code{nc -u -l -p 4555}. Any time QEMU writes something to that port it
2330 will appear in the netconsole session.
2332 If you plan to send characters back via netconsole or you want to stop
2333 and start QEMU a lot of times, you should have QEMU use the same
2334 source port each time by using something like @code{-serial
2335 udp::4555@@:4556} to QEMU. Another approach is to use a patched
2336 version of netcat which can listen to a TCP port and send and receive
2337 characters via udp. If you have a patched version of netcat which
2338 activates telnet remote echo and single char transfer, then you can
2339 use the following options to step up a netcat redirector to allow
2340 telnet on port 5555 to access the QEMU port.
2343 -serial udp::4555@@:4556
2344 @item netcat options:
2345 -u -P 4555 -L 0.0.0.0:4556 -t -p 5555 -I -T
2346 @item telnet options:
2350 @item tcp:[@var{host}]:@var{port}[,@var{server}][,nowait][,nodelay]
2351 The TCP Net Console has two modes of operation. It can send the serial
2352 I/O to a location or wait for a connection from a location. By default
2353 the TCP Net Console is sent to @var{host} at the @var{port}. If you use
2354 the @var{server} option QEMU will wait for a client socket application
2355 to connect to the port before continuing, unless the @code{nowait}
2356 option was specified. The @code{nodelay} option disables the Nagle buffering
2357 algorithm. If @var{host} is omitted, 0.0.0.0 is assumed. Only
2358 one TCP connection at a time is accepted. You can use @code{telnet} to
2359 connect to the corresponding character device.
2361 @item Example to send tcp console to 192.168.0.2 port 4444
2362 -serial tcp:192.168.0.2:4444
2363 @item Example to listen and wait on port 4444 for connection
2364 -serial tcp::4444,server
2365 @item Example to not wait and listen on ip 192.168.0.100 port 4444
2366 -serial tcp:192.168.0.100:4444,server,nowait
2369 @item telnet:@var{host}:@var{port}[,server][,nowait][,nodelay]
2370 The telnet protocol is used instead of raw tcp sockets. The options
2371 work the same as if you had specified @code{-serial tcp}. The
2372 difference is that the port acts like a telnet server or client using
2373 telnet option negotiation. This will also allow you to send the
2374 MAGIC_SYSRQ sequence if you use a telnet that supports sending the break
2375 sequence. Typically in unix telnet you do it with Control-] and then
2376 type "send
break" followed by pressing the enter key.
2378 @item unix:@var{path}[,server][,nowait]
2379 A unix domain socket is used instead of a tcp socket. The option works the
2380 same as if you had specified @code{-serial tcp} except the unix domain socket
2381 @var{path} is used for connections.
2383 @item mon:@var{dev_string}
2384 This is a special option to allow the monitor to be multiplexed onto
2385 another serial port. The monitor is accessed with key sequence of
2386 @key{Control-a} and then pressing @key{c}. See monitor access
2387 @ref{pcsys_keys} in the -nographic section for more keys.
2388 @var{dev_string} should be any one of the serial devices specified
2389 above. An example to multiplex the monitor onto a telnet server
2390 listening on port 4444 would be:
2392 @item -serial mon:telnet::4444,server,nowait
2396 Braille device. This will use BrlAPI to display the braille output on a real
2400 Three button serial mouse. Configure the guest to use Microsoft protocol.
2404 DEF("parallel
", HAS_ARG, QEMU_OPTION_parallel, \
2405 "-parallel dev redirect the parallel port to char device
'dev'\n",
2408 @item -parallel @var{dev}
2410 Redirect the virtual parallel port to host device @var{dev} (same
2411 devices as the serial port). On Linux hosts, @file{/dev/parportN} can
2412 be used to use hardware devices connected on the corresponding host
2415 This option can be used several times to simulate up to 3 parallel
2418 Use @code{-parallel none} to disable all parallel ports.
2421 DEF("monitor
", HAS_ARG, QEMU_OPTION_monitor, \
2422 "-monitor dev redirect the monitor to char device
'dev'\n",
2425 @item -monitor @var{dev}
2427 Redirect the monitor to host device @var{dev} (same devices as the
2429 The default device is @code{vc} in graphical mode and @code{stdio} in
2432 DEF("qmp
", HAS_ARG, QEMU_OPTION_qmp, \
2433 "-qmp dev like
-monitor but opens
in 'control' mode
\n",
2436 @item -qmp @var{dev}
2438 Like -monitor but opens in 'control' mode.
2441 DEF("mon
", HAS_ARG, QEMU_OPTION_mon, \
2442 "-mon chardev
=[name
][,mode
=readline|control
][,default]\n", QEMU_ARCH_ALL)
2444 @item -mon chardev=[name][,mode=readline|control][,default]
2446 Setup monitor on chardev @var{name}.
2449 DEF("debugcon
", HAS_ARG, QEMU_OPTION_debugcon, \
2450 "-debugcon dev redirect the debug console to char device
'dev'\n",
2453 @item -debugcon @var{dev}
2455 Redirect the debug console to host device @var{dev} (same devices as the
2456 serial port). The debug console is an I/O port which is typically port
2457 0xe9; writing to that I/O port sends output to this device.
2458 The default device is @code{vc} in graphical mode and @code{stdio} in
2462 DEF("pidfile
", HAS_ARG, QEMU_OPTION_pidfile, \
2463 "-pidfile file write PID to
'file'\n", QEMU_ARCH_ALL)
2465 @item -pidfile @var{file}
2467 Store the QEMU process PID in @var{file}. It is useful if you launch QEMU
2471 DEF("singlestep
", 0, QEMU_OPTION_singlestep, \
2472 "-singlestep always run
in singlestep mode
\n", QEMU_ARCH_ALL)
2476 Run the emulation in single step mode.
2479 DEF("S
", 0, QEMU_OPTION_S, \
2480 "-S freeze CPU at
startup (use
'c' to start execution
)\n",
2485 Do not start CPU at startup (you must type 'c' in the monitor).
2488 DEF("gdb
", HAS_ARG, QEMU_OPTION_gdb, \
2489 "-gdb dev wait
for gdb connection on
'dev'\n", QEMU_ARCH_ALL)
2491 @item -gdb @var{dev}
2493 Wait for gdb connection on device @var{dev} (@pxref{gdb_usage}). Typical
2494 connections will likely be TCP-based, but also UDP, pseudo TTY, or even
2495 stdio are reasonable use case. The latter is allowing to start QEMU from
2496 within gdb and establish the connection via a pipe:
2498 (gdb) target remote | exec qemu-system-i386 -gdb stdio ...
2502 DEF("s
", 0, QEMU_OPTION_s, \
2503 "-s shorthand
for -gdb tcp
::" DEFAULT_GDBSTUB_PORT "\n",
2508 Shorthand for -gdb tcp::1234, i.e. open a gdbserver on TCP port 1234
2509 (@pxref{gdb_usage}).
2512 DEF("d
", HAS_ARG, QEMU_OPTION_d, \
2513 "-d item1
,... output log to
/tmp
/qemu
.log (use
'-d help' for a list of log items
)\n",
2518 Output log in /tmp/qemu.log
2521 DEF("D
", HAS_ARG, QEMU_OPTION_D, \
2522 "-D logfile output log to
logfile (instead of the
default /tmp
/qemu
.log
)\n",
2525 @item -D @var{logfile}
2527 Output log in @var{logfile} instead of /tmp/qemu.log
2530 DEF("hdachs
", HAS_ARG, QEMU_OPTION_hdachs, \
2531 "-hdachs c
,h
,s
[,t
]\n" \
2532 " force hard disk
0 physical geometry and the optional BIOS
\n" \
2533 " translation (t
=none or lba
) (usually QEMU can guess them
)\n",
2536 @item -hdachs @var{c},@var{h},@var{s},[,@var{t}]
2538 Force hard disk 0 physical geometry (1 <= @var{c} <= 16383, 1 <=
2539 @var{h} <= 16, 1 <= @var{s} <= 63) and optionally force the BIOS
2540 translation mode (@var{t}=none, lba or auto). Usually QEMU can guess
2541 all those parameters. This option is useful for old MS-DOS disk
2545 DEF("L
", HAS_ARG, QEMU_OPTION_L, \
2546 "-L path set the directory
for the BIOS
, VGA BIOS and keymaps
\n",
2551 Set the directory for the BIOS, VGA BIOS and keymaps.
2554 DEF("bios
", HAS_ARG, QEMU_OPTION_bios, \
2555 "-bios file set the filename
for the BIOS
\n", QEMU_ARCH_ALL)
2557 @item -bios @var{file}
2559 Set the filename for the BIOS.
2562 DEF("enable
-kvm
", 0, QEMU_OPTION_enable_kvm, \
2563 "-enable
-kvm enable KVM full virtualization support
\n", QEMU_ARCH_ALL)
2567 Enable KVM full virtualization support. This option is only available
2568 if KVM support is enabled when compiling.
2571 DEF("xen
-domid
", HAS_ARG, QEMU_OPTION_xen_domid,
2572 "-xen
-domid id specify xen guest domain id
\n", QEMU_ARCH_ALL)
2573 DEF("xen
-create
", 0, QEMU_OPTION_xen_create,
2574 "-xen
-create create domain
using xen hypercalls
, bypassing xend
\n"
2575 " warning
: should not be used when xend is
in use
\n",
2577 DEF("xen
-attach
", 0, QEMU_OPTION_xen_attach,
2578 "-xen
-attach attach to existing xen domain
\n"
2579 " xend will use
this when starting QEMU
\n",
2582 @item -xen-domid @var{id}
2584 Specify xen guest domain @var{id} (XEN only).
2587 Create domain using xen hypercalls, bypassing xend.
2588 Warning: should not be used when xend is in use (XEN only).
2591 Attach to existing xen domain.
2592 xend will use this when starting QEMU (XEN only).
2595 DEF("no
-reboot
", 0, QEMU_OPTION_no_reboot, \
2596 "-no
-reboot exit instead of rebooting
\n", QEMU_ARCH_ALL)
2600 Exit instead of rebooting.
2603 DEF("no
-shutdown
", 0, QEMU_OPTION_no_shutdown, \
2604 "-no
-shutdown stop before shutdown
\n", QEMU_ARCH_ALL)
2607 @findex -no-shutdown
2608 Don't exit QEMU on guest shutdown, but instead only stop the emulation.
2609 This allows for instance switching to monitor to commit changes to the
2613 DEF("loadvm
", HAS_ARG, QEMU_OPTION_loadvm, \
2614 "-loadvm
[tag|id
]\n" \
2615 " start right away with a saved
state (loadvm
in monitor
)\n",
2618 @item -loadvm @var{file}
2620 Start right away with a saved state (@code{loadvm} in monitor)
2624 DEF("daemonize
", 0, QEMU_OPTION_daemonize, \
2625 "-daemonize daemonize QEMU after initializing
\n", QEMU_ARCH_ALL)
2630 Daemonize the QEMU process after initialization. QEMU will not detach from
2631 standard IO until it is ready to receive connections on any of its devices.
2632 This option is a useful way for external programs to launch QEMU without having
2633 to cope with initialization race conditions.
2636 DEF("option
-rom
", HAS_ARG, QEMU_OPTION_option_rom, \
2637 "-option
-rom rom load a file
, rom
, into the option ROM space
\n",
2640 @item -option-rom @var{file}
2642 Load the contents of @var{file} as an option ROM.
2643 This option is useful to load things like EtherBoot.
2646 DEF("clock
", HAS_ARG, QEMU_OPTION_clock, \
2647 "-clock force the use of the given methods
for timer alarm
.\n" \
2648 " To see what timers are available use
'-clock help'\n",
2651 @item -clock @var{method}
2653 Force the use of the given methods for timer alarm. To see what timers
2654 are available use @code{-clock help}.
2657 HXCOMM Options deprecated by -rtc
2658 DEF("localtime
", 0, QEMU_OPTION_localtime, "", QEMU_ARCH_ALL)
2659 DEF("startdate
", HAS_ARG, QEMU_OPTION_startdate, "", QEMU_ARCH_ALL)
2661 DEF("rtc
", HAS_ARG, QEMU_OPTION_rtc, \
2662 "-rtc
[base
=utc|localtime|date
][,clock
=host|rt|vm
][,driftfix
=none|slew
]\n" \
2663 " set the RTC base and clock
, enable drift fix
for clock
ticks (x86 only
)\n",
2668 @item -rtc [base=utc|localtime|@var{date}][,clock=host|vm][,driftfix=none|slew]
2670 Specify @option{base} as @code{utc} or @code{localtime} to let the RTC start at the current
2671 UTC or local time, respectively. @code{localtime} is required for correct date in
2672 MS-DOS or Windows. To start at a specific point in time, provide @var{date} in the
2673 format @code{2006-06-17T16:01:21} or @code{2006-06-17}. The default base is UTC.
2675 By default the RTC is driven by the host system time. This allows to use the
2676 RTC as accurate reference clock inside the guest, specifically if the host
2677 time is smoothly following an accurate external reference clock, e.g. via NTP.
2678 If you want to isolate the guest time from the host, you can set @option{clock}
2679 to @code{rt} instead. To even prevent it from progressing during suspension,
2680 you can set it to @code{vm}.
2682 Enable @option{driftfix} (i386 targets only) if you experience time drift problems,
2683 specifically with Windows' ACPI HAL. This option will try to figure out how
2684 many timer interrupts were not processed by the Windows guest and will
2688 DEF("icount
", HAS_ARG, QEMU_OPTION_icount, \
2689 "-icount
[N|auto
]\n" \
2690 " enable virtual instruction counter with
2^N clock ticks per
\n" \
2691 " instruction
\n", QEMU_ARCH_ALL)
2693 @item -icount [@var{N}|auto]
2695 Enable virtual instruction counter. The virtual cpu will execute one
2696 instruction every 2^@var{N} ns of virtual time. If @code{auto} is specified
2697 then the virtual cpu speed will be automatically adjusted to keep virtual
2698 time within a few seconds of real time.
2700 Note that while this option can give deterministic behavior, it does not
2701 provide cycle accurate emulation. Modern CPUs contain superscalar out of
2702 order cores with complex cache hierarchies. The number of instructions
2703 executed often has little or no correlation with actual performance.
2706 DEF("watchdog
", HAS_ARG, QEMU_OPTION_watchdog, \
2707 "-watchdog i6300esb|ib700
\n" \
2708 " enable virtual hardware watchdog
[default=none
]\n",
2711 @item -watchdog @var{model}
2713 Create a virtual hardware watchdog device. Once enabled (by a guest
2714 action), the watchdog must be periodically polled by an agent inside
2715 the guest or else the guest will be restarted.
2717 The @var{model} is the model of hardware watchdog to emulate. Choices
2718 for model are: @code{ib700} (iBASE 700) which is a very simple ISA
2719 watchdog with a single timer, or @code{i6300esb} (Intel 6300ESB I/O
2720 controller hub) which is a much more featureful PCI-based dual-timer
2721 watchdog. Choose a model for which your guest has drivers.
2723 Use @code{-watchdog help} to list available hardware models. Only one
2724 watchdog can be enabled for a guest.
2727 DEF("watchdog
-action
", HAS_ARG, QEMU_OPTION_watchdog_action, \
2728 "-watchdog
-action reset|shutdown|poweroff|pause|debug|none
\n" \
2729 " action when watchdog fires
[default=reset
]\n",
2732 @item -watchdog-action @var{action}
2734 The @var{action} controls what QEMU will do when the watchdog timer
2737 @code{reset} (forcefully reset the guest).
2738 Other possible actions are:
2739 @code{shutdown} (attempt to gracefully shutdown the guest),
2740 @code{poweroff} (forcefully poweroff the guest),
2741 @code{pause} (pause the guest),
2742 @code{debug} (print a debug message and continue), or
2743 @code{none} (do nothing).
2745 Note that the @code{shutdown} action requires that the guest responds
2746 to ACPI signals, which it may not be able to do in the sort of
2747 situations where the watchdog would have expired, and thus
2748 @code{-watchdog-action shutdown} is not recommended for production use.
2753 @item -watchdog i6300esb -watchdog-action pause
2754 @item -watchdog ib700
2758 DEF("echr
", HAS_ARG, QEMU_OPTION_echr, \
2759 "-echr chr set terminal escape character instead of ctrl
-a
\n",
2763 @item -echr @var{numeric_ascii_value}
2765 Change the escape character used for switching to the monitor when using
2766 monitor and serial sharing. The default is @code{0x01} when using the
2767 @code{-nographic} option. @code{0x01} is equal to pressing
2768 @code{Control-a}. You can select a different character from the ascii
2769 control keys where 1 through 26 map to Control-a through Control-z. For
2770 instance you could use the either of the following to change the escape
2771 character to Control-t.
2778 DEF("virtioconsole
", HAS_ARG, QEMU_OPTION_virtiocon, \
2779 "-virtioconsole c
\n" \
2780 " set virtio console
\n", QEMU_ARCH_ALL)
2782 @item -virtioconsole @var{c}
2783 @findex -virtioconsole
2786 This option is maintained for backward compatibility.
2788 Please use @code{-device virtconsole} for the new way of invocation.
2791 DEF("show
-cursor
", 0, QEMU_OPTION_show_cursor, \
2792 "-show
-cursor show cursor
\n", QEMU_ARCH_ALL)
2795 @findex -show-cursor
2799 DEF("tb
-size
", HAS_ARG, QEMU_OPTION_tb_size, \
2800 "-tb
-size n set TB size
\n", QEMU_ARCH_ALL)
2802 @item -tb-size @var{n}
2807 DEF("incoming
", HAS_ARG, QEMU_OPTION_incoming, \
2808 "-incoming p prepare
for incoming migration
, listen on port p
\n",
2811 @item -incoming @var{port}
2813 Prepare for incoming migration, listen on @var{port}.
2816 DEF("nodefaults
", 0, QEMU_OPTION_nodefaults, \
2817 "-nodefaults don
't create default devices\n", QEMU_ARCH_ALL)
2821 Don't create
default devices
. Normally
, QEMU sets the
default devices like serial
2822 port
, parallel port
, virtual console
, monitor device
, VGA adapter
, floppy and
2823 CD
-ROM drive and others
. The @code
{-nodefaults
} option will disable all those
2828 DEF("chroot", HAS_ARG
, QEMU_OPTION_chroot
, \
2829 "-chroot dir chroot to dir just before starting the VM\n",
2833 @item
-chroot @
var{dir
}
2835 Immediately before starting guest execution
, chroot to the specified
2836 directory
. Especially useful
in combination with
-runas
.
2840 DEF("runas", HAS_ARG
, QEMU_OPTION_runas
, \
2841 "-runas user change to user id user just before starting the VM\n",
2845 @item
-runas @
var{user
}
2847 Immediately before starting guest execution
, drop root privileges
, switching
2848 to the specified user
.
2851 DEF("prom-env", HAS_ARG
, QEMU_OPTION_prom_env
,
2852 "-prom-env variable=value\n"
2853 " set OpenBIOS nvram variables\n",
2854 QEMU_ARCH_PPC | QEMU_ARCH_SPARC
)
2856 @item
-prom
-env @
var{variable
}=@
var{value
}
2858 Set OpenBIOS nvram @
var{variable
} to given @
var{value
} (PPC
, SPARC only
).
2860 DEF("semihosting", 0, QEMU_OPTION_semihosting
,
2861 "-semihosting semihosting mode\n", QEMU_ARCH_ARM | QEMU_ARCH_M68K | QEMU_ARCH_XTENSA
)
2864 @findex
-semihosting
2865 Semihosting
mode (ARM
, M68K
, Xtensa only
).
2867 DEF("old-param", 0, QEMU_OPTION_old_param
,
2868 "-old-param old param mode\n", QEMU_ARCH_ARM
)
2871 @findex
-old
-param (ARM
)
2872 Old param
mode (ARM only
).
2875 DEF("sandbox", HAS_ARG
, QEMU_OPTION_sandbox
, \
2876 "-sandbox <arg> Enable seccomp mode 2 system call filter (default 'off').\n",
2881 Enable Seccomp mode
2 system call filter
. 'on' will enable syscall filtering and
'off' will
2882 disable it
. The
default is
'off'.
2885 DEF("readconfig", HAS_ARG
, QEMU_OPTION_readconfig
,
2886 "-readconfig <file>\n", QEMU_ARCH_ALL
)
2888 @item
-readconfig @
var{file
}
2890 Read device configuration from @
var{file
}. This approach is useful when you want to spawn
2891 QEMU process with many command line options but you don
't want to exceed the command line
2894 DEF("writeconfig", HAS_ARG, QEMU_OPTION_writeconfig,
2895 "-writeconfig <file>\n"
2896 " read/write config file\n", QEMU_ARCH_ALL)
2898 @item -writeconfig @var{file}
2899 @findex -writeconfig
2900 Write device configuration to @var{file}. The @var{file} can be either filename to save
2901 command line and device configuration into file or dash @code{-}) character to print the
2902 output to stdout. This can be later used as input file for @code{-readconfig} option.
2904 DEF("nodefconfig", 0, QEMU_OPTION_nodefconfig,
2906 " do not load default config files at startup\n",
2910 @findex -nodefconfig
2911 Normally QEMU loads configuration files from @var{sysconfdir} and @var{datadir} at startup.
2912 The @code{-nodefconfig} option will prevent QEMU from loading any of those config files.
2914 DEF("no-user-config", 0, QEMU_OPTION_nouserconfig,
2916 " do not load user-provided config files at startup\n",
2919 @item -no-user-config
2920 @findex -no-user-config
2921 The @code{-no-user-config} option makes QEMU not load any of the user-provided
2922 config files on @var{sysconfdir}, but won't make it skip the QEMU
-provided config
2923 files from @
var{datadir
}.
2925 DEF("trace", HAS_ARG
, QEMU_OPTION_trace
,
2926 "-trace [events=<file>][,file=<file>]\n"
2927 " specify tracing options\n",
2930 HXCOMM This line is not accurate
, as some sub
-options are backend
-specific but
2931 HXCOMM HX does not support conditional compilation of text
.
2932 @item
-trace [events
=@
var{file
}][,file
=@
var{file
}]
2935 Specify tracing options
.
2938 @item events
=@
var{file
}
2939 Immediately enable events listed
in @
var{file
}.
2940 The file must contain one event
name (as listed
in the @
var{trace-events
} file
)
2942 This option is only available
if QEMU has been compiled with
2943 either @
var{simple
} or @
var{stderr
} tracing backend
.
2944 @item file
=@
var{file
}
2945 Log output traces to @
var{file
}.
2947 This option is only available
if QEMU has been compiled with
2948 the @
var{simple
} tracing backend
.
2952 DEF("qtest", HAS_ARG
, QEMU_OPTION_qtest
,
2953 "-qtest CHR specify tracing options\n",
2956 DEF("qtest-log", HAS_ARG
, QEMU_OPTION_qtest_log
,
2957 "-qtest-log LOG specify tracing options\n",
2961 DEF("enable-fips", 0, QEMU_OPTION_enablefips
,
2962 "-enable-fips enable FIPS 140-2 compliance\n",
2967 @findex
-enable
-fips
2968 Enable FIPS
140-2 compliance mode
.
2971 HXCOMM Deprecated by
-machine accel
=tcg property
2972 DEF("no-kvm", 0, QEMU_OPTION_no_kvm
, "", QEMU_ARCH_I386
)
2974 HXCOMM Deprecated by kvm
-pit driver properties
2975 DEF("no-kvm-pit-reinjection", 0, QEMU_OPTION_no_kvm_pit_reinjection
,
2978 HXCOMM
Deprecated (ignored
)
2979 DEF("no-kvm-pit", 0, QEMU_OPTION_no_kvm_pit
, "", QEMU_ARCH_I386
)
2981 HXCOMM Deprecated by
-machine kernel_irqchip
=on|off property
2982 DEF("no-kvm-irqchip", 0, QEMU_OPTION_no_kvm_irqchip
, "", QEMU_ARCH_I386
)
2984 HXCOMM
Deprecated (ignored
)
2985 DEF("tdf", 0, QEMU_OPTION_tdf
,"", QEMU_ARCH_ALL
)
2987 DEF("object", HAS_ARG
, QEMU_OPTION_object
,
2988 "-object TYPENAME[,PROP1=VALUE1,...]\n"
2989 " create an new object of type TYPENAME setting properties\n"
2990 " in the order they are specified. Note that the 'id'\n"
2991 " property must be set. These objects are placed in the\n"
2992 " '/objects' path.\n",
2995 HXCOMM This is the last statement
. Insert
new options before
this line
!