1 HXCOMM Use
DEFHEADING() to define headings
in both help text and texi
2 HXCOMM Text between STEXI and ETEXI are copied to texi version and
3 HXCOMM discarded from C version
4 HXCOMM
DEF(option
, HAS_ARG
/0, opt_enum
, opt_help
, arch_mask
) is used to
5 HXCOMM construct option structures
, enums and help message
for specified
7 HXCOMM HXCOMM can be used
for comments
, discarded from both texi and C
9 DEFHEADING(Standard options
:)
14 DEF("help", 0, QEMU_OPTION_h
,
15 "-h or -help display this help and exit\n", QEMU_ARCH_ALL
)
22 DEF("version", 0, QEMU_OPTION_version
,
23 "-version display version information and exit\n", QEMU_ARCH_ALL
)
27 Display version information and exit
30 DEF("machine", HAS_ARG
, QEMU_OPTION_machine
, \
31 "-machine [type=]name[,prop[=value][,...]]\n"
32 " selects emulated machine (-machine ? for list)\n"
33 " property accel=accel1[:accel2[:...]] selects accelerator\n"
34 " supported accelerators are kvm, xen, tcg (default: tcg)\n",
37 @item
-machine
[type
=]@
var{name
}[,prop
=@
var{value
}[,...]]
39 Select the emulated machine by @
var{name
}. Use @code
{-machine ?
} to list
40 available machines
. Supported machine properties are
:
42 @item accel
=@
var{accels1
}[:@
var{accels2
}[:...]]
43 This is used to enable an accelerator
. Depending on the target architecture
,
44 kvm
, xen
, or tcg can be available
. By
default, tcg is used
. If there is more
45 than one accelerator specified
, the next one is used
if the previous one fails
50 HXCOMM Deprecated by
-machine
51 DEF("M", HAS_ARG
, QEMU_OPTION_M
, "", QEMU_ARCH_ALL
)
53 DEF("cpu", HAS_ARG
, QEMU_OPTION_cpu
,
54 "-cpu cpu select CPU (-cpu ? for list)\n", QEMU_ARCH_ALL
)
56 @item
-cpu @
var{model
}
58 Select CPU
model (-cpu ?
for list and additional feature selection
)
61 DEF("smp", HAS_ARG
, QEMU_OPTION_smp
,
62 "-smp n[,maxcpus=cpus][,cores=cores][,threads=threads][,sockets=sockets]\n"
63 " set the number of CPUs to 'n' [default=1]\n"
64 " maxcpus= maximum number of total cpus, including\n"
65 " offline CPUs for hotplug, etc\n"
66 " cores= number of CPU cores on one socket\n"
67 " threads= number of threads on one CPU core\n"
68 " sockets= number of discrete sockets in the system\n",
71 @item
-smp @
var{n
}[,cores
=@
var{cores
}][,threads
=@
var{threads
}][,sockets
=@
var{sockets
}][,maxcpus
=@
var{maxcpus
}]
73 Simulate an SMP system with @
var{n
} CPUs
. On the PC target
, up to
255
74 CPUs are supported
. On Sparc32 target
, Linux limits the number of usable CPUs
76 For the PC target
, the number of @
var{cores
} per socket
, the number
77 of @
var{threads
} per cores and the total number of @
var{sockets
} can be
78 specified
. Missing values will be computed
. If any on the three values is
79 given
, the total number of CPUs @
var{n
} can be omitted
. @
var{maxcpus
}
80 specifies the maximum number of hotpluggable CPUs
.
83 DEF("numa", HAS_ARG
, QEMU_OPTION_numa
,
84 "-numa node[,mem=size][,cpus=cpu[-cpu]][,nodeid=node]\n", QEMU_ARCH_ALL
)
86 @item
-numa @
var{opts
}
88 Simulate a multi node NUMA system
. If mem and cpus are omitted
, resources
92 DEF("fda", HAS_ARG
, QEMU_OPTION_fda
,
93 "-fda/-fdb file use 'file' as floppy disk 0/1 image\n", QEMU_ARCH_ALL
)
94 DEF("fdb", HAS_ARG
, QEMU_OPTION_fdb
, "", QEMU_ARCH_ALL
)
100 Use @
var{file
} as floppy disk
0/1 image (@pxref
{disk_images
}). You can
101 use the host floppy by
using @file
{/dev
/fd0
} as
filename (@pxref
{host_drives
}).
104 DEF("hda", HAS_ARG
, QEMU_OPTION_hda
,
105 "-hda/-hdb file use 'file' as IDE hard disk 0/1 image\n", QEMU_ARCH_ALL
)
106 DEF("hdb", HAS_ARG
, QEMU_OPTION_hdb
, "", QEMU_ARCH_ALL
)
107 DEF("hdc", HAS_ARG
, QEMU_OPTION_hdc
,
108 "-hdc/-hdd file use 'file' as IDE hard disk 2/3 image\n", QEMU_ARCH_ALL
)
109 DEF("hdd", HAS_ARG
, QEMU_OPTION_hdd
, "", QEMU_ARCH_ALL
)
111 @item
-hda @
var{file
}
112 @item
-hdb @
var{file
}
113 @item
-hdc @
var{file
}
114 @item
-hdd @
var{file
}
119 Use @
var{file
} as hard disk
0, 1, 2 or
3 image (@pxref
{disk_images
}).
122 DEF("cdrom", HAS_ARG
, QEMU_OPTION_cdrom
,
123 "-cdrom file use 'file' as IDE cdrom image (cdrom is ide1 master)\n",
126 @item
-cdrom @
var{file
}
128 Use @
var{file
} as CD
-ROM
image (you cannot use @option
{-hdc
} and
129 @option
{-cdrom
} at the same time
). You can use the host CD
-ROM by
130 using @file
{/dev
/cdrom
} as
filename (@pxref
{host_drives
}).
133 DEF("drive", HAS_ARG
, QEMU_OPTION_drive
,
134 "-drive [file=file][,if=type][,bus=n][,unit=m][,media=d][,index=i]\n"
135 " [,cyls=c,heads=h,secs=s[,trans=t]][,snapshot=on|off]\n"
136 " [,cache=writethrough|writeback|none|directsync|unsafe][,format=f]\n"
137 " [,serial=s][,addr=A][,id=name][,aio=threads|native]\n"
138 " [,readonly=on|off][,copy-on-read=on|off]\n"
139 " [[,bps=b]|[[,bps_rd=r][,bps_wr=w]]][[,iops=i]|[[,iops_rd=r][,iops_wr=w]]\n"
140 " use 'file' as a drive image\n", QEMU_ARCH_ALL
)
142 @item
-drive @
var{option
}[,@
var{option
}[,@
var{option
}[,...]]]
145 Define a
new drive
. Valid options are
:
148 @item file
=@
var{file
}
149 This option defines which disk
image (@pxref
{disk_images
}) to use with
150 this drive
. If the filename contains comma
, you must double it
151 (for instance
, "file=my,,file" to use file
"my,file").
153 Special files such as iSCSI devices can be specified
using protocol
154 specific URLs
. See the section
for "Device URL Syntax" for more information
.
155 @item
if=@
var{interface}
156 This option defines on which type on
interface the drive is connected
.
157 Available types are
: ide
, scsi
, sd
, mtd
, floppy
, pflash
, virtio
.
158 @item bus
=@
var{bus
},unit
=@
var{unit
}
159 These options define where is connected the drive by defining the bus number and
161 @item index
=@
var{index
}
162 This option defines where is connected the drive by
using an index
in the list
163 of available connectors of a given
interface type
.
164 @item media
=@
var{media
}
165 This option defines the type of the media
: disk or cdrom
.
166 @item cyls
=@
var{c
},heads
=@
var{h
},secs
=@
var{s
}[,trans
=@
var{t
}]
167 These options have the same definition as they have
in @option
{-hdachs
}.
168 @item snapshot
=@
var{snapshot
}
169 @
var{snapshot
} is
"on" or
"off" and allows to enable snapshot
for given
drive (see @option
{-snapshot
}).
170 @item cache
=@
var{cache
}
171 @
var{cache
} is
"none", "writeback", "unsafe", "directsync" or
"writethrough" and controls how the host cache is used to access block data
.
173 @
var{aio
} is
"threads", or
"native" and selects between pthread based disk I
/O and native Linux AIO
.
174 @item format
=@
var{format
}
175 Specify which disk @
var{format
} will be used rather than detecting
176 the format
. Can be used to specifiy format
=raw to avoid interpreting
177 an untrusted format header
.
178 @item serial
=@
var{serial
}
179 This option specifies the serial number to assign to the device
.
180 @item addr
=@
var{addr
}
181 Specify the controller
's PCI address (if=virtio only).
182 @item werror=@var{action},rerror=@var{action}
183 Specify which @var{action} to take on write and read errors. Valid actions are:
184 "ignore" (ignore the error and try to continue), "stop" (pause QEMU),
185 "report" (report the error to the guest), "enospc" (pause QEMU only if the
186 host disk is full; report the error to the guest otherwise).
187 The default setting is @option{werror=enospc} and @option{rerror=report}.
189 Open drive @option{file} as read-only. Guest write attempts will fail.
190 @item copy-on-read=@var{copy-on-read}
191 @var{copy-on-read} is "on" or "off" and enables whether to copy read backing
192 file sectors into the image file.
195 By default, writethrough caching is used for all block device. This means that
196 the host page cache will be used to read and write data but write notification
197 will be sent to the guest only when the data has been reported as written by
198 the storage subsystem.
200 Writeback caching will report data writes as completed as soon as the data is
201 present in the host page cache. This is safe as long as you trust your host.
202 If your host crashes or loses power, then the guest may experience data
205 The host page cache can be avoided entirely with @option{cache=none}. This will
206 attempt to do disk IO directly to the guests memory. QEMU may still perform
207 an internal copy of the data.
209 The host page cache can be avoided while only sending write notifications to
210 the guest when the data has been reported as written by the storage subsystem
211 using @option{cache=directsync}.
213 Some block drivers perform badly with @option{cache=writethrough}, most notably,
214 qcow2. If performance is more important than correctness,
215 @option{cache=writeback} should be used with qcow2.
217 In case you don't care about data integrity over host failures
, use
218 cache
=unsafe
. This option tells qemu that it
never needs to write any data
219 to the disk but can instead keeps things
in cache
. If anything goes wrong
,
220 like your host losing power
, the disk storage getting disconnected accidently
,
221 etc
. you
're image will most probably be rendered unusable. When using
222 the @option{-snapshot} option, unsafe caching is always used.
224 Copy-on-read avoids accessing the same backing file sectors repeatedly and is
225 useful when the backing file is over a slow network. By default copy-on-read
228 Instead of @option{-cdrom} you can use:
230 qemu -drive file=file,index=2,media=cdrom
233 Instead of @option{-hda}, @option{-hdb}, @option{-hdc}, @option{-hdd}, you can
236 qemu -drive file=file,index=0,media=disk
237 qemu -drive file=file,index=1,media=disk
238 qemu -drive file=file,index=2,media=disk
239 qemu -drive file=file,index=3,media=disk
242 You can connect a CDROM to the slave of ide0:
244 qemu -drive file=file,if=ide,index=1,media=cdrom
247 If you don't specify the
"file=" argument
, you define an empty drive
:
249 qemu
-drive
if=ide
,index
=1,media
=cdrom
252 You can connect a SCSI disk with unit ID
6 on the bus #
0:
254 qemu
-drive file
=file
,if=scsi
,bus
=0,unit
=6
257 Instead of @option
{-fda
}, @option
{-fdb
}, you can use
:
259 qemu
-drive file
=file
,index
=0,if=floppy
260 qemu
-drive file
=file
,index
=1,if=floppy
263 By
default, @
var{interface} is
"ide" and @
var{index
} is automatically
266 qemu
-drive file
=a
-drive file
=b
"
274 DEF("set
", HAS_ARG, QEMU_OPTION_set,
275 "-set group
.id
.arg
=value
\n"
276 " set
<arg
> parameter
for item
<id
> of type
<group
>\n"
277 " i
.e
. -set drive
.$id
.file
=/path
/to
/image
\n", QEMU_ARCH_ALL)
284 DEF("global
", HAS_ARG, QEMU_OPTION_global,
285 "-global driver
.property
=value
\n"
286 " set a global
default for a driver property
\n",
294 DEF("mtdblock
", HAS_ARG, QEMU_OPTION_mtdblock,
295 "-mtdblock file use
'file' as on
-board Flash memory image
\n",
298 @item -mtdblock @var{file}
300 Use @var{file} as on-board Flash memory image.
303 DEF("sd
", HAS_ARG, QEMU_OPTION_sd,
304 "-sd file use
'file' as SecureDigital card image
\n", QEMU_ARCH_ALL)
308 Use @var{file} as SecureDigital card image.
311 DEF("pflash
", HAS_ARG, QEMU_OPTION_pflash,
312 "-pflash file use
'file' as a parallel flash image
\n", QEMU_ARCH_ALL)
314 @item -pflash @var{file}
316 Use @var{file} as a parallel flash image.
319 DEF("boot
", HAS_ARG, QEMU_OPTION_boot,
320 "-boot
[order
=drives
][,once
=drives
][,menu
=on|off
]\n"
321 " [,splash
=sp_name
][,splash
-time
=sp_time
]\n"
322 " 'drives': floppy (a
), hard
disk (c
), CD
-ROM (d
), network (n
)\n"
323 " 'sp_name': the file
's name that would be passed to bios as logo picture, if menu=on\n"
324 " 'sp_time
': the period that splash picture last if menu=on, unit is ms\n",
327 @item -boot [order=@var{drives}][,once=@var{drives}][,menu=on|off][,splash=@var{sp_name}][,splash-time=@var{sp_time}]
329 Specify boot order @var{drives} as a string of drive letters. Valid
330 drive letters depend on the target achitecture. The x86 PC uses: a, b
331 (floppy 1 and 2), c (first hard disk), d (first CD-ROM), n-p (Etherboot
332 from network adapter 1-4), hard disk boot is the default. To apply a
333 particular boot order only on the first startup, specify it via
336 Interactive boot menus/prompts can be enabled via @option{menu=on} as far
337 as firmware/BIOS supports them. The default is non-interactive boot.
339 A splash picture could be passed to bios, enabling user to show it as logo,
340 when option splash=@var{sp_name} is given and menu=on, If firmware/BIOS
341 supports them. Currently Seabios for X86 system support it.
342 limitation: The splash file could be a jpeg file or a BMP file in 24 BPP
343 format(true color). The resolution should be supported by the SVGA mode, so
344 the recommended is 320x240, 640x480, 800x640.
347 # try to boot from network first, then from hard disk
349 # boot from CD-ROM first, switch back to default order after reboot
351 # boot with a splash picture for 5 seconds.
352 qemu -boot menu=on,splash=/root/boot.bmp,splash-time=5000
355 Note: The legacy format '-boot @
var{drives
}' is still supported but its
356 use is discouraged as it may be removed from future versions.
359 DEF("snapshot", 0, QEMU_OPTION_snapshot,
360 "-snapshot write to temporary files instead of disk image files\n",
365 Write to temporary files instead of disk image files. In this case,
366 the raw disk image you use is not written back. You can however force
367 the write back by pressing @key{C-a s} (@pxref{disk_images}).
370 DEF("m", HAS_ARG, QEMU_OPTION_m,
371 "-m megs set virtual RAM size to megs MB [default="
372 stringify(DEFAULT_RAM_SIZE) "]\n", QEMU_ARCH_ALL)
376 Set virtual RAM size to @var{megs} megabytes. Default is 128 MiB. Optionally,
377 a suffix of ``M'' or ``G'' can be used to signify a value in megabytes or
378 gigabytes respectively.
381 DEF("mem-path", HAS_ARG, QEMU_OPTION_mempath,
382 "-mem-path FILE provide backing storage for guest RAM\n", QEMU_ARCH_ALL)
384 @item -mem-path @var{path}
385 Allocate guest RAM from a temporarily created file in @var{path}.
389 DEF("mem-prealloc", 0, QEMU_OPTION_mem_prealloc,
390 "-mem-prealloc preallocate guest memory (use with -mem-path)\n",
394 Preallocate memory when using -mem-path.
398 DEF("k", HAS_ARG, QEMU_OPTION_k,
399 "-k language use keyboard layout (for example 'fr
' for French)\n",
402 @item -k @var{language}
404 Use keyboard layout @var{language} (for example @code{fr} for
405 French). This option is only needed where it is not easy to get raw PC
406 keycodes (e.g. on Macs, with some X11 servers or with a VNC
407 display). You don't normally need to use it on PC
/Linux or PC
/Windows
410 The available layouts are
:
412 ar de
-ch es fo fr
-ca hu ja mk no pt
-br sv
413 da en
-gb et fr fr
-ch is lt nl pl ru th
414 de en
-us fi fr
-be hr it lv nl
-be pt sl tr
417 The
default is @code
{en
-us
}.
421 DEF("audio-help", 0, QEMU_OPTION_audio_help
,
422 "-audio-help print list of audio drivers and their options\n",
427 Will show the audio subsystem help
: list of drivers
, tunable
431 DEF("soundhw", HAS_ARG
, QEMU_OPTION_soundhw
,
432 "-soundhw c1,... enable audio support\n"
433 " and only specified sound cards (comma separated list)\n"
434 " use -soundhw ? to get the list of supported cards\n"
435 " use -soundhw all to enable all of them\n", QEMU_ARCH_ALL
)
437 @item
-soundhw @
var{card1
}[,@
var{card2
},...] or
-soundhw all
439 Enable audio and selected sound hardware
. Use ? to print all
440 available sound hardware
.
443 qemu
-soundhw sb16
,adlib disk
.img
444 qemu
-soundhw es1370 disk
.img
445 qemu
-soundhw ac97 disk
.img
446 qemu
-soundhw hda disk
.img
447 qemu
-soundhw all disk
.img
451 Note that Linux
's i810_audio OSS kernel (for AC97) module might
452 require manually specifying clocking.
455 modprobe i810_audio clocking=48000
463 DEF("usb", 0, QEMU_OPTION_usb,
464 "-usb enable the USB driver (will be the default soon)\n",
472 Enable the USB driver (will be the default soon)
475 DEF("usbdevice", HAS_ARG, QEMU_OPTION_usbdevice,
476 "-usbdevice name add the host or guest USB device 'name
'\n",
480 @item -usbdevice @var{devname}
482 Add the USB device @var{devname}. @xref{usb_devices}.
487 Virtual Mouse. This will override the PS/2 mouse emulation when activated.
490 Pointer device that uses absolute coordinates (like a touchscreen). This
491 means qemu is able to report the mouse position without having to grab the
492 mouse. Also overrides the PS/2 mouse emulation when activated.
494 @item disk:[format=@var{format}]:@var{file}
495 Mass storage device based on file. The optional @var{format} argument
496 will be used rather than detecting the format. Can be used to specifiy
497 @code{format=raw} to avoid interpreting an untrusted format header.
499 @item host:@var{bus}.@var{addr}
500 Pass through the host device identified by @var{bus}.@var{addr} (Linux only).
502 @item host:@var{vendor_id}:@var{product_id}
503 Pass through the host device identified by @var{vendor_id}:@var{product_id}
506 @item serial:[vendorid=@var{vendor_id}][,productid=@var{product_id}]:@var{dev}
507 Serial converter to host character device @var{dev}, see @code{-serial} for the
511 Braille device. This will use BrlAPI to display the braille output on a real
514 @item net:@var{options}
515 Network adapter that supports CDC ethernet and RNDIS protocols.
520 DEF("device", HAS_ARG, QEMU_OPTION_device,
521 "-device driver[,prop[=value][,...]]\n"
522 " add device (based on driver)\n"
523 " prop=value,... sets driver properties\n"
524 " use -device ? to print all possible drivers\n"
525 " use -device driver,? to print all possible properties\n",
528 @item -device @var{driver}[,@var{prop}[=@var{value}][,...]]
530 Add device @var{driver}. @var{prop}=@var{value} sets driver
531 properties. Valid properties depend on the driver. To get help on
532 possible drivers and properties, use @code{-device ?} and
533 @code{-device @var{driver},?}.
538 DEFHEADING(File system options:)
540 DEF("fsdev", HAS_ARG, QEMU_OPTION_fsdev,
541 "-fsdev fsdriver,id=id[,path=path,][security_model={mapped|passthrough|none}]\n"
542 " [,writeout=immediate][,readonly][,socket=socket|sock_fd=sock_fd]\n",
547 @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}]
549 Define a new file system device. Valid options are:
552 This option specifies the fs driver backend to use.
553 Currently "local", "handle" and "proxy" file system drivers are supported.
555 Specifies identifier for this device
556 @item path=@var{path}
557 Specifies the export path for the file system device. Files under
558 this path will be available to the 9p client on the guest.
559 @item security_model=@var{security_model}
560 Specifies the security model to be used for this export path.
561 Supported security models are "passthrough", "mapped" and "none".
562 In "passthrough" security model, files are stored using the same
563 credentials as they are created on the guest. This requires qemu
564 to run as root. In "mapped" security model, some of the file
565 attributes like uid, gid, mode bits and link target are stored as
566 file attributes. Directories exported by this security model cannot
567 interact with other unix tools. "none" security model is same as
568 passthrough except the sever won't report failures
if it fails to
569 set file attributes like ownership
. Security model is mandatory
570 only
for local fsdriver
. Other
fsdrivers (like handle
, proxy
) don
't take
571 security model as a parameter.
572 @item writeout=@var{writeout}
573 This is an optional argument. The only supported value is "immediate".
574 This means that host page cache will be used to read and write data but
575 write notification will be sent to the guest only when the data has been
576 reported as written by the storage subsystem.
578 Enables exporting 9p share as a readonly mount for guests. By default
579 read-write access is given.
580 @item socket=@var{socket}
581 Enables proxy filesystem driver to use passed socket file for communicating
582 with virtfs-proxy-helper
583 @item sock_fd=@var{sock_fd}
584 Enables proxy filesystem driver to use passed socket descriptor for
585 communicating with virtfs-proxy-helper. Usually a helper like libvirt
586 will create socketpair and pass one of the fds as sock_fd
589 -fsdev option is used along with -device driver "virtio-9p-pci".
590 @item -device virtio-9p-pci,fsdev=@var{id},mount_tag=@var{mount_tag}
591 Options for virtio-9p-pci driver are:
594 Specifies the id value specified along with -fsdev option
595 @item mount_tag=@var{mount_tag}
596 Specifies the tag name to be used by the guest to mount this export point
603 DEFHEADING(Virtual File system pass-through options:)
605 DEF("virtfs", HAS_ARG, QEMU_OPTION_virtfs,
606 "-virtfs local,path=path,mount_tag=tag,security_model=[mapped|passthrough|none]\n"
607 " [,writeout=immediate][,readonly][,socket=socket|sock_fd=sock_fd]\n",
612 @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}]
615 The general form of a Virtual File system pass-through options are:
618 This option specifies the fs driver backend to use.
619 Currently "local", "handle" and "proxy" file system drivers are supported.
621 Specifies identifier for this device
622 @item path=@var{path}
623 Specifies the export path for the file system device. Files under
624 this path will be available to the 9p client on the guest.
625 @item security_model=@var{security_model}
626 Specifies the security model to be used for this export path.
627 Supported security models are "passthrough", "mapped" and "none".
628 In "passthrough" security model, files are stored using the same
629 credentials as they are created on the guest. This requires qemu
630 to run as root. In "mapped" security model, some of the file
631 attributes like uid, gid, mode bits and link target are stored as
632 file attributes. Directories exported by this security model cannot
633 interact with other unix tools. "none" security model is same as
634 passthrough except the sever won't report failures
if it fails to
635 set file attributes like ownership
. Security model is mandatory only
636 for local fsdriver
. Other
fsdrivers (like handle
, proxy
) don
't take security
637 model as a parameter.
638 @item writeout=@var{writeout}
639 This is an optional argument. The only supported value is "immediate".
640 This means that host page cache will be used to read and write data but
641 write notification will be sent to the guest only when the data has been
642 reported as written by the storage subsystem.
644 Enables exporting 9p share as a readonly mount for guests. By default
645 read-write access is given.
646 @item socket=@var{socket}
647 Enables proxy filesystem driver to use passed socket file for
648 communicating with virtfs-proxy-helper. Usually a helper like libvirt
649 will create socketpair and pass one of the fds as sock_fd
651 Enables proxy filesystem driver to use passed 'sock_fd
' as the socket
652 descriptor for interfacing with virtfs-proxy-helper
656 DEF("virtfs_synth", 0, QEMU_OPTION_virtfs_synth,
657 "-virtfs_synth Create synthetic file system image\n",
661 @findex -virtfs_synth
662 Create synthetic file system image
667 DEF("name", HAS_ARG, QEMU_OPTION_name,
668 "-name string1[,process=string2]\n"
669 " set the name of the guest\n"
670 " string1 sets the window title and string2 the process name (on Linux)\n",
673 @item -name @var{name}
675 Sets the @var{name} of the guest.
676 This name will be displayed in the SDL window caption.
677 The @var{name} will also be used for the VNC server.
678 Also optionally set the top visible process name in Linux.
681 DEF("uuid", HAS_ARG, QEMU_OPTION_uuid,
682 "-uuid %08x-%04x-%04x-%04x-%012x\n"
683 " specify machine UUID\n", QEMU_ARCH_ALL)
685 @item -uuid @var{uuid}
696 DEFHEADING(Display options:)
702 DEF("display", HAS_ARG, QEMU_OPTION_display,
703 "-display sdl[,frame=on|off][,alt_grab=on|off][,ctrl_grab=on|off]\n"
704 " [,window_close=on|off]|curses|none|\n"
705 " vnc=<display>[,<optargs>]\n"
706 " select display type\n", QEMU_ARCH_ALL)
708 @item -display @var{type}
710 Select type of display to use. This option is a replacement for the
711 old style -sdl/-curses/... options. Valid values for @var{type} are
714 Display video output via SDL (usually in a separate graphics
715 window; see the SDL documentation for other possibilities).
717 Display video output via curses. For graphics device models which
718 support a text mode, QEMU can display this output using a
719 curses/ncurses interface. Nothing is displayed when the graphics
720 device is in graphical mode or if the graphics device does not support
721 a text mode. Generally only the VGA device models support text mode.
723 Do not display video output. The guest will still see an emulated
724 graphics card, but its output will not be displayed to the QEMU
725 user. This option differs from the -nographic option in that it
726 only affects what is done with video output; -nographic also changes
727 the destination of the serial and parallel port data.
729 Start a VNC server on display <arg>
733 DEF("nographic", 0, QEMU_OPTION_nographic,
734 "-nographic disable graphical output and redirect serial I/Os to console\n",
739 Normally, QEMU uses SDL to display the VGA output. With this option,
740 you can totally disable graphical output so that QEMU is a simple
741 command line application. The emulated serial port is redirected on
742 the console. Therefore, you can still use QEMU to debug a Linux kernel
743 with a serial console.
746 DEF("curses", 0, QEMU_OPTION_curses,
747 "-curses use a curses/ncurses interface instead of SDL\n",
752 Normally, QEMU uses SDL to display the VGA output. With this option,
753 QEMU can display the VGA output when in text mode using a
754 curses/ncurses interface. Nothing is displayed in graphical mode.
757 DEF("no-frame", 0, QEMU_OPTION_no_frame,
758 "-no-frame open SDL window without a frame and window decorations\n",
763 Do not use decorations for SDL windows and start them using the whole
764 available screen space. This makes the using QEMU in a dedicated desktop
765 workspace more convenient.
768 DEF("alt-grab", 0, QEMU_OPTION_alt_grab,
769 "-alt-grab use Ctrl-Alt-Shift to grab mouse (instead of Ctrl-Alt)\n",
774 Use Ctrl-Alt-Shift to grab mouse (instead of Ctrl-Alt). Note that this also
775 affects the special keys (for fullscreen, monitor-mode switching, etc).
778 DEF("ctrl-grab", 0, QEMU_OPTION_ctrl_grab,
779 "-ctrl-grab use Right-Ctrl to grab mouse (instead of Ctrl-Alt)\n",
784 Use Right-Ctrl to grab mouse (instead of Ctrl-Alt). Note that this also
785 affects the special keys (for fullscreen, monitor-mode switching, etc).
788 DEF("no-quit", 0, QEMU_OPTION_no_quit,
789 "-no-quit disable SDL window close capability\n", QEMU_ARCH_ALL)
793 Disable SDL window close capability.
796 DEF("sdl", 0, QEMU_OPTION_sdl,
797 "-sdl enable SDL\n", QEMU_ARCH_ALL)
804 DEF("spice", HAS_ARG, QEMU_OPTION_spice,
805 "-spice <args> enable spice\n", QEMU_ARCH_ALL)
807 @item -spice @var{option}[,@var{option}[,...]]
809 Enable the spice remote desktop protocol. Valid options are
814 Set the TCP port spice is listening on for plaintext channels.
817 Set the IP address spice is listening on. Default is any address.
821 Force using the specified IP version.
823 @item password=<secret>
824 Set the password you need to authenticate.
827 Require that the client use SASL to authenticate with the spice.
828 The exact choice of authentication method used is controlled from the
829 system / user's SASL configuration file
for the
'qemu' service
. This
830 is typically found
in /etc
/sasl2
/qemu
.conf
. If running QEMU as an
831 unprivileged user
, an environment variable SASL_CONF_PATH can be used
832 to make it search alternate locations
for the service config
.
833 While some SASL auth methods can also provide data
encryption (eg GSSAPI
),
834 it is recommended that SASL always be combined with the
'tls' and
835 'x509' settings to enable use of SSL and server certificates
. This
836 ensures a data encryption preventing compromise of authentication
839 @item disable
-ticketing
840 Allow client connects without authentication
.
842 @item disable
-copy
-paste
843 Disable copy paste between the client and the guest
.
846 Set the TCP port spice is listening on
for encrypted channels
.
849 Set the x509 file directory
. Expects same filenames as
-vnc $display
,x509
=$dir
851 @item x509
-key
-file
=<file
>
852 @item x509
-key
-password
=<file
>
853 @item x509
-cert
-file
=<file
>
854 @item x509
-cacert
-file
=<file
>
855 @item x509
-dh
-key
-file
=<file
>
856 The x509 file names can also be configured individually
.
858 @item tls
-ciphers
=<list
>
859 Specify which ciphers to use
.
861 @item tls
-channel
=[main|display|inputs|record|playback|tunnel
]
862 @item plaintext
-channel
=[main|display|inputs|record|playback|tunnel
]
863 Force specific channel to be used with or without TLS encryption
. The
864 options can be specified multiple times to configure multiple
865 channels
. The special name
"default" can be used to set the
default
866 mode
. For channels which are not explicitly forced into one mode the
867 spice client is allowed to pick tls
/plaintext as he pleases
.
869 @item image
-compression
=[auto_glz|auto_lz|quic|glz|lz|off
]
870 Configure image
compression (lossless
).
873 @item jpeg
-wan
-compression
=[auto|
never|always
]
874 @item zlib
-glz
-wan
-compression
=[auto|
never|always
]
875 Configure wan image
compression (lossy
for slow links
).
878 @item streaming
-video
=[off|all|filter
]
879 Configure video stream detection
. Default is filter
.
881 @item agent
-mouse
=[on|off
]
882 Enable
/disable passing mouse events via vdagent
. Default is on
.
884 @item playback
-compression
=[on|off
]
885 Enable
/disable audio stream
compression (using celt
0.5.1). Default is on
.
890 DEF("portrait", 0, QEMU_OPTION_portrait
,
891 "-portrait rotate graphical output 90 deg left (only PXA LCD)\n",
896 Rotate graphical output
90 deg
left (only PXA LCD
).
899 DEF("rotate", HAS_ARG
, QEMU_OPTION_rotate
,
900 "-rotate <deg> rotate graphical output some deg left (only PXA LCD)\n",
905 Rotate graphical output some deg
left (only PXA LCD
).
908 DEF("vga", HAS_ARG
, QEMU_OPTION_vga
,
909 "-vga [std|cirrus|vmware|qxl|xenfb|none]\n"
910 " select video card type\n", QEMU_ARCH_ALL
)
912 @item
-vga @
var{type
}
914 Select type of VGA card to emulate
. Valid values
for @
var{type
} are
917 Cirrus Logic GD5446 Video card
. All Windows versions starting from
918 Windows
95 should recognize and use
this graphic card
. For optimal
919 performances
, use
16 bit color depth
in the guest and the host OS
.
920 (This one is the
default)
922 Standard VGA card with Bochs VBE extensions
. If your guest OS
923 supports the VESA
2.0 VBE
extensions (e
.g
. Windows XP
) and
if you want
924 to use high resolution
modes (>= 1280x1024x16
) then you should use
927 VMWare SVGA
-II compatible adapter
. Use it
if you have sufficiently
928 recent XFree86
/XOrg server or Windows guest with a driver
for this
931 QXL paravirtual graphic card
. It is VGA
compatible (including VESA
932 2.0 VBE support
). Works best with qxl guest drivers installed though
.
933 Recommended choice when
using the spice protocol
.
939 DEF("full-screen", 0, QEMU_OPTION_full_screen
,
940 "-full-screen start in full screen\n", QEMU_ARCH_ALL
)
944 Start
in full screen
.
947 DEF("g", 1, QEMU_OPTION_g
,
948 "-g WxH[xDEPTH] Set the initial graphical resolution and depth\n",
949 QEMU_ARCH_PPC | QEMU_ARCH_SPARC
)
951 @item
-g @
var{width
}x@
var{height
}[x@
var{depth
}]
953 Set the initial graphical resolution and
depth (PPC
, SPARC only
).
956 DEF("vnc", HAS_ARG
, QEMU_OPTION_vnc
,
957 "-vnc display start a VNC server on display\n", QEMU_ARCH_ALL
)
959 @item
-vnc @
var{display
}[,@
var{option
}[,@
var{option
}[,...]]]
961 Normally
, QEMU uses SDL to display the VGA output
. With
this option
,
962 you can have QEMU listen on VNC display @
var{display
} and redirect the VGA
963 display over the VNC session
. It is very useful to enable the usb
964 tablet device when
using this option (option @option
{-usbdevice
965 tablet
}). When
using the VNC display
, you must use the @option
{-k
}
966 parameter to set the keyboard layout
if you are not
using en
-us
. Valid
967 syntax
for the @
var{display
} is
971 @item @
var{host
}:@
var{d
}
973 TCP connections will only be allowed from @
var{host
} on display @
var{d
}.
974 By convention the TCP port is
5900+@
var{d
}. Optionally
, @
var{host
} can
975 be omitted
in which
case the server will accept connections from any host
.
977 @item unix
:@
var{path
}
979 Connections will be allowed over UNIX domain sockets where @
var{path
} is the
980 location of a unix socket to listen
for connections on
.
984 VNC is initialized but not started
. The monitor @code
{change
} command
985 can be used to later start the VNC server
.
989 Following the @
var{display
} value there may be one or more @
var{option
} flags
990 separated by commas
. Valid options are
996 Connect to a listening VNC client via a ``reverse
'' connection
. The
997 client is specified by the @
var{display
}. For reverse network
998 connections (@
var{host
}:@
var{d
},@code
{reverse
}), the @
var{d
} argument
999 is a TCP port number
, not a display number
.
1003 Require that password based authentication is used
for client connections
.
1004 The password must be set separately
using the @code
{change
} command
in the
1009 Require that client use TLS when communicating with the VNC server
. This
1010 uses anonymous TLS credentials so is susceptible to a man
-in-the
-middle
1011 attack
. It is recommended that
this option be combined with either the
1012 @option
{x509
} or @option
{x509verify
} options
.
1014 @item x509
=@
var{/path
/to
/certificate
/dir
}
1016 Valid
if @option
{tls
} is specified
. Require that x509 credentials are used
1017 for negotiating the TLS session
. The server will send its x509 certificate
1018 to the client
. It is recommended that a password be set on the VNC server
1019 to provide authentication of the client when
this is used
. The path following
1020 this option specifies where the x509 certificates are to be loaded from
.
1021 See the @ref
{vnc_security
} section
for details on generating certificates
.
1023 @item x509verify
=@
var{/path
/to
/certificate
/dir
}
1025 Valid
if @option
{tls
} is specified
. Require that x509 credentials are used
1026 for negotiating the TLS session
. The server will send its x509 certificate
1027 to the client
, and request that the client send its own x509 certificate
.
1028 The server will validate the client
's certificate against the CA certificate,
1029 and reject clients when validation fails. If the certificate authority is
1030 trusted, this is a sufficient authentication mechanism. You may still wish
1031 to set a password on the VNC server as a second authentication layer. The
1032 path following this option specifies where the x509 certificates are to
1033 be loaded from. See the @ref{vnc_security} section for details on generating
1038 Require that the client use SASL to authenticate with the VNC server.
1039 The exact choice of authentication method used is controlled from the
1040 system / user's SASL configuration file
for the
'qemu' service
. This
1041 is typically found
in /etc
/sasl2
/qemu
.conf
. If running QEMU as an
1042 unprivileged user
, an environment variable SASL_CONF_PATH can be used
1043 to make it search alternate locations
for the service config
.
1044 While some SASL auth methods can also provide data
encryption (eg GSSAPI
),
1045 it is recommended that SASL always be combined with the
'tls' and
1046 'x509' settings to enable use of SSL and server certificates
. This
1047 ensures a data encryption preventing compromise of authentication
1048 credentials
. See the @ref
{vnc_security
} section
for details on
using
1049 SASL authentication
.
1053 Turn on access control lists
for checking of the x509 client certificate
1054 and SASL party
. For x509 certs
, the ACL check is made against the
1055 certificate
's distinguished name. This is something that looks like
1056 @code{C=GB,O=ACME,L=Boston,CN=bob}. For SASL party, the ACL check is
1057 made against the username, which depending on the SASL plugin, may
1058 include a realm component, eg @code{bob} or @code{bob@@EXAMPLE.COM}.
1059 When the @option{acl} flag is set, the initial access list will be
1060 empty, with a @code{deny} policy. Thus no one will be allowed to
1061 use the VNC server until the ACLs have been loaded. This can be
1062 achieved using the @code{acl} monitor command.
1066 Enable lossy compression methods (gradient, JPEG, ...). If this
1067 option is set, VNC client may receive lossy framebuffer updates
1068 depending on its encoding settings. Enabling this option can save
1069 a lot of bandwidth at the expense of quality.
1073 Disable adaptive encodings. Adaptive encodings are enabled by default.
1074 An adaptive encoding will try to detect frequently updated screen regions,
1075 and send updates in these regions using a lossy encoding (like JPEG).
1076 This can be really helpful to save bandwidth when playing videos. Disabling
1077 adaptive encodings allows to restore the original static behavior of encodings
1089 DEFHEADING(i386 target only:)
1094 DEF("win2k-hack", 0, QEMU_OPTION_win2k_hack,
1095 "-win2k-hack use it when installing Windows 2000 to avoid a disk full bug\n",
1100 Use it when installing Windows 2000 to avoid a disk full bug. After
1101 Windows 2000 is installed, you no longer need this option (this option
1102 slows down the IDE transfers).
1105 HXCOMM Deprecated by -rtc
1106 DEF("rtc-td-hack", 0, QEMU_OPTION_rtc_td_hack, "", QEMU_ARCH_I386)
1108 DEF("no-fd-bootchk", 0, QEMU_OPTION_no_fd_bootchk,
1109 "-no-fd-bootchk disable boot signature checking for floppy disks\n",
1112 @item -no-fd-bootchk
1113 @findex -no-fd-bootchk
1114 Disable boot signature checking for floppy disks in Bochs BIOS. It may
1115 be needed to boot from old floppy disks.
1116 TODO: check reference to Bochs BIOS.
1119 DEF("no-acpi", 0, QEMU_OPTION_no_acpi,
1120 "-no-acpi disable ACPI\n", QEMU_ARCH_I386)
1124 Disable ACPI (Advanced Configuration and Power Interface) support. Use
1125 it if your guest OS complains about ACPI problems (PC target machine
1129 DEF("no-hpet", 0, QEMU_OPTION_no_hpet,
1130 "-no-hpet disable HPET\n", QEMU_ARCH_I386)
1134 Disable HPET support.
1137 DEF("balloon", HAS_ARG, QEMU_OPTION_balloon,
1138 "-balloon none disable balloon device\n"
1139 "-balloon virtio[,addr=str]\n"
1140 " enable virtio balloon device (default)\n", QEMU_ARCH_ALL)
1144 Disable balloon device.
1145 @item -balloon virtio[,addr=@var{addr}]
1146 Enable virtio balloon device (default), optionally with PCI address
1150 DEF("acpitable", HAS_ARG, QEMU_OPTION_acpitable,
1151 "-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"
1152 " ACPI table description\n", QEMU_ARCH_I386)
1154 @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}]...]
1156 Add ACPI table with specified header fields and context from specified files.
1157 For file=, take whole ACPI table from the specified files, including all
1158 ACPI headers (possible overridden by other options).
1159 For data=, only data
1160 portion of the table is used, all header information is specified in the
1164 DEF("smbios", HAS_ARG, QEMU_OPTION_smbios,
1165 "-smbios file=binary\n"
1166 " load SMBIOS entry from binary file\n"
1167 "-smbios type=0[,vendor=str][,version=str][,date=str][,release=%d.%d]\n"
1168 " specify SMBIOS type 0 fields\n"
1169 "-smbios type=1[,manufacturer=str][,product=str][,version=str][,serial=str]\n"
1170 " [,uuid=uuid][,sku=str][,family=str]\n"
1171 " specify SMBIOS type 1 fields\n", QEMU_ARCH_I386)
1173 @item -smbios file=@var{binary}
1175 Load SMBIOS entry from binary file.
1177 @item -smbios type=0[,vendor=@var{str}][,version=@var{str}][,date=@var{str}][,release=@var{%d.%d}]
1179 Specify SMBIOS type 0 fields
1181 @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}]
1182 Specify SMBIOS type 1 fields
1190 DEFHEADING(Network options:)
1195 HXCOMM Legacy slirp options (now moved to -net user):
1197 DEF("tftp", HAS_ARG, QEMU_OPTION_tftp, "", QEMU_ARCH_ALL)
1198 DEF("bootp", HAS_ARG, QEMU_OPTION_bootp, "", QEMU_ARCH_ALL)
1199 DEF("redir", HAS_ARG, QEMU_OPTION_redir, "", QEMU_ARCH_ALL)
1201 DEF("smb", HAS_ARG, QEMU_OPTION_smb, "", QEMU_ARCH_ALL)
1205 DEF("net", HAS_ARG, QEMU_OPTION_net,
1206 "-net nic[,vlan=n][,macaddr=mac][,model=type][,name=str][,addr=str][,vectors=v]\n"
1207 " create a new Network Interface Card and connect it to VLAN 'n
'\n"
1209 "-net user[,vlan=n][,name=str][,net=addr[/mask]][,host=addr][,restrict=on|off]\n"
1210 " [,hostname=host][,dhcpstart=addr][,dns=addr][,tftp=dir][,bootfile=f]\n"
1211 " [,hostfwd=rule][,guestfwd=rule]"
1213 "[,smb=dir[,smbserver=addr]]\n"
1215 " connect the user mode network stack to VLAN 'n
', configure its\n"
1216 " DHCP server and enabled optional services\n"
1219 "-net tap[,vlan=n][,name=str],ifname=name\n"
1220 " connect the host TAP network interface to VLAN 'n
'\n"
1222 "-net tap[,vlan=n][,name=str][,fd=h][,ifname=name][,script=file][,downscript=dfile][,sndbuf=nbytes][,vnet_hdr=on|off][,vhost=on|off][,vhostfd=h][,vhostforce=on|off]\n"
1223 " connect the host TAP network interface to VLAN 'n
' and use the\n"
1224 " network scripts 'file
' (default=" DEFAULT_NETWORK_SCRIPT ")\n"
1225 " and 'dfile
' (default=" DEFAULT_NETWORK_DOWN_SCRIPT ")\n"
1226 " use '[down
]script
=no
' to disable script execution\n"
1227 " use 'fd
=h
' to connect to an already opened TAP interface\n"
1228 " use 'sndbuf
=nbytes
' to limit the size of the send buffer (the\n"
1229 " default is disabled 'sndbuf
=0' to enable flow control set 'sndbuf
=1048576')\n"
1230 " use vnet_hdr=off to avoid enabling the IFF_VNET_HDR tap flag\n"
1231 " use vnet_hdr=on to make the lack of IFF_VNET_HDR support an error condition\n"
1232 " use vhost=on to enable experimental in kernel accelerator\n"
1233 " (only has effect for virtio guests which use MSIX)\n"
1234 " use vhostforce=on to force vhost on for non-MSIX virtio guests\n"
1235 " use 'vhostfd
=h
' to connect to an already opened vhost net device\n"
1237 "-net socket[,vlan=n][,name=str][,fd=h][,listen=[host]:port][,connect=host:port]\n"
1238 " connect the vlan 'n
' to another VLAN using a socket connection\n"
1239 "-net socket[,vlan=n][,name=str][,fd=h][,mcast=maddr:port[,localaddr=addr]]\n"
1240 " connect the vlan 'n
' to multicast maddr and port\n"
1241 " use 'localaddr
=addr
' to specify the host address to send packets from\n"
1243 "-net vde[,vlan=n][,name=str][,sock=socketpath][,port=n][,group=groupname][,mode=octalmode]\n"
1244 " connect the vlan 'n
' to port 'n
' of a vde switch running\n"
1245 " on host and listening for incoming connections on 'socketpath
'.\n"
1246 " Use group 'groupname
' and mode 'octalmode
' to change default\n"
1247 " ownership and permissions for communication port.\n"
1249 "-net dump[,vlan=n][,file=f][,len=n]\n"
1250 " dump traffic on vlan 'n
' to file 'f
' (max n bytes per packet)\n"
1251 "-net none use it alone to have zero network devices. If no -net option\n"
1252 " is provided, the default is '-net nic
-net user
'\n", QEMU_ARCH_ALL)
1253 DEF("netdev", HAS_ARG, QEMU_OPTION_netdev,
1262 "socket],id=str[,option][,option][,...]\n", QEMU_ARCH_ALL)
1264 @item -net nic[,vlan=@var{n}][,macaddr=@var{mac}][,model=@var{type}] [,name=@var{name}][,addr=@var{addr}][,vectors=@var{v}]
1266 Create a new Network Interface Card and connect it to VLAN @var{n} (@var{n}
1267 = 0 is the default). The NIC is an e1000 by default on the PC
1268 target. Optionally, the MAC address can be changed to @var{mac}, the
1269 device address set to @var{addr} (PCI cards only),
1270 and a @var{name} can be assigned for use in monitor commands.
1271 Optionally, for PCI cards, you can specify the number @var{v} of MSI-X vectors
1272 that the card should have; this option currently only affects virtio cards; set
1273 @var{v} = 0 to disable MSI-X. If no @option{-net} option is specified, a single
1274 NIC is created. Qemu can emulate several different models of network card.
1275 Valid values for @var{type} are
1276 @code{virtio}, @code{i82551}, @code{i82557b}, @code{i82559er},
1277 @code{ne2k_pci}, @code{ne2k_isa}, @code{pcnet}, @code{rtl8139},
1278 @code{e1000}, @code{smc91c111}, @code{lance} and @code{mcf_fec}.
1279 Not all devices are supported on all targets. Use -net nic,model=?
1280 for a list of available devices for your target.
1282 @item -net user[,@var{option}][,@var{option}][,...]
1283 Use the user mode network stack which requires no administrator
1284 privilege to run. Valid options are:
1288 Connect user mode stack to VLAN @var{n} (@var{n} = 0 is the default).
1290 @item name=@var{name}
1291 Assign symbolic name for use in monitor commands.
1293 @item net=@var{addr}[/@var{mask}]
1294 Set IP network address the guest will see. Optionally specify the netmask,
1295 either in the form a.b.c.d or as number of valid top-most bits. Default is
1298 @item host=@var{addr}
1299 Specify the guest-visible address of the host. Default is the 2nd IP in the
1300 guest network, i.e. x.x.x.2.
1302 @item restrict=on|off
1303 If this option is enabled, the guest will be isolated, i.e. it will not be
1304 able to contact the host and no guest IP packets will be routed over the host
1305 to the outside. This option does not affect any explicitly set forwarding rules.
1307 @item hostname=@var{name}
1308 Specifies the client hostname reported by the builtin DHCP server.
1310 @item dhcpstart=@var{addr}
1311 Specify the first of the 16 IPs the built-in DHCP server can assign. Default
1312 is the 15th to 31st IP in the guest network, i.e. x.x.x.15 to x.x.x.31.
1314 @item dns=@var{addr}
1315 Specify the guest-visible address of the virtual nameserver. The address must
1316 be different from the host address. Default is the 3rd IP in the guest network,
1319 @item tftp=@var{dir}
1320 When using the user mode network stack, activate a built-in TFTP
1321 server. The files in @var{dir} will be exposed as the root of a TFTP server.
1322 The TFTP client on the guest must be configured in binary mode (use the command
1323 @code{bin} of the Unix TFTP client).
1325 @item bootfile=@var{file}
1326 When using the user mode network stack, broadcast @var{file} as the BOOTP
1327 filename. In conjunction with @option{tftp}, this can be used to network boot
1328 a guest from a local directory.
1330 Example (using pxelinux):
1332 qemu -hda linux.img -boot n -net user,tftp=/path/to/tftp/files,bootfile=/pxelinux.0
1335 @item smb=@var{dir}[,smbserver=@var{addr}]
1336 When using the user mode network stack, activate a built-in SMB
1337 server so that Windows OSes can access to the host files in @file{@var{dir}}
1338 transparently. The IP address of the SMB server can be set to @var{addr}. By
1339 default the 4th IP in the guest network is used, i.e. x.x.x.4.
1341 In the guest Windows OS, the line:
1345 must be added in the file @file{C:\WINDOWS\LMHOSTS} (for windows 9x/Me)
1346 or @file{C:\WINNT\SYSTEM32\DRIVERS\ETC\LMHOSTS} (Windows NT/2000).
1348 Then @file{@var{dir}} can be accessed in @file{\\smbserver\qemu}.
1350 Note that a SAMBA server must be installed on the host OS.
1351 QEMU was tested successfully with smbd versions from Red Hat 9,
1352 Fedora Core 3 and OpenSUSE 11.x.
1354 @item hostfwd=[tcp|udp]:[@var{hostaddr}]:@var{hostport}-[@var{guestaddr}]:@var{guestport}
1355 Redirect incoming TCP or UDP connections to the host port @var{hostport} to
1356 the guest IP address @var{guestaddr} on guest port @var{guestport}. If
1357 @var{guestaddr} is not specified, its value is x.x.x.15 (default first address
1358 given by the built-in DHCP server). By specifying @var{hostaddr}, the rule can
1359 be bound to a specific host interface. If no connection type is set, TCP is
1360 used. This option can be given multiple times.
1362 For example, to redirect host X11 connection from screen 1 to guest
1363 screen 0, use the following:
1367 qemu -net user,hostfwd=tcp:127.0.0.1:6001-:6000 [...]
1368 # this host xterm should open in the guest X11 server
1372 To redirect telnet connections from host port 5555 to telnet port on
1373 the guest, use the following:
1377 qemu -net user,hostfwd=tcp::5555-:23 [...]
1378 telnet localhost 5555
1381 Then when you use on the host @code{telnet localhost 5555}, you
1382 connect to the guest telnet server.
1384 @item guestfwd=[tcp]:@var{server}:@var{port}-@var{dev}
1385 Forward guest TCP connections to the IP address @var{server} on port @var{port}
1386 to the character device @var{dev}. This option can be given multiple times.
1390 Note: Legacy stand-alone options -tftp, -bootp, -smb and -redir are still
1391 processed and applied to -net user. Mixing them with the new configuration
1392 syntax gives undefined results. Their use for new applications is discouraged
1393 as they will be removed from future versions.
1395 @item -net tap[,vlan=@var{n}][,name=@var{name}][,fd=@var{h}][,ifname=@var{name}] [,script=@var{file}][,downscript=@var{dfile}]
1396 Connect the host TAP network interface @var{name} to VLAN @var{n}, use
1397 the network script @var{file} to configure it and the network script
1398 @var{dfile} to deconfigure it. If @var{name} is not provided, the OS
1399 automatically provides one. @option{fd}=@var{h} can be used to specify
1400 the handle of an already opened host TAP interface. The default network
1401 configure script is @file{/etc/qemu-ifup} and the default network
1402 deconfigure script is @file{/etc/qemu-ifdown}. Use @option{script=no}
1403 or @option{downscript=no} to disable script execution. Example:
1406 qemu linux.img -net nic -net tap
1409 More complicated example (two NICs, each one connected to a TAP device)
1411 qemu linux.img -net nic,vlan=0 -net tap,vlan=0,ifname=tap0 \
1412 -net nic,vlan=1 -net tap,vlan=1,ifname=tap1
1415 @item -net socket[,vlan=@var{n}][,name=@var{name}][,fd=@var{h}] [,listen=[@var{host}]:@var{port}][,connect=@var{host}:@var{port}]
1417 Connect the VLAN @var{n} to a remote VLAN in another QEMU virtual
1418 machine using a TCP socket connection. If @option{listen} is
1419 specified, QEMU waits for incoming connections on @var{port}
1420 (@var{host} is optional). @option{connect} is used to connect to
1421 another QEMU instance using the @option{listen} option. @option{fd}=@var{h}
1422 specifies an already opened TCP socket.
1426 # launch a first QEMU instance
1427 qemu linux.img -net nic,macaddr=52:54:00:12:34:56 \
1428 -net socket,listen=:1234
1429 # connect the VLAN 0 of this instance to the VLAN 0
1430 # of the first instance
1431 qemu linux.img -net nic,macaddr=52:54:00:12:34:57 \
1432 -net socket,connect=127.0.0.1:1234
1435 @item -net socket[,vlan=@var{n}][,name=@var{name}][,fd=@var{h}][,mcast=@var{maddr}:@var{port}[,localaddr=@var{addr}]]
1437 Create a VLAN @var{n} shared with another QEMU virtual
1438 machines using a UDP multicast socket, effectively making a bus for
1439 every QEMU with same multicast address @var{maddr} and @var{port}.
1443 Several QEMU can be running on different hosts and share same bus (assuming
1444 correct multicast setup for these hosts).
1446 mcast support is compatible with User Mode Linux (argument @option{eth@var{N}=mcast}), see
1447 @url{http://user-mode-linux.sf.net}.
1449 Use @option{fd=h} to specify an already opened UDP multicast socket.
1454 # launch one QEMU instance
1455 qemu linux.img -net nic,macaddr=52:54:00:12:34:56 \
1456 -net socket,mcast=230.0.0.1:1234
1457 # launch another QEMU instance on same "bus"
1458 qemu linux.img -net nic,macaddr=52:54:00:12:34:57 \
1459 -net socket,mcast=230.0.0.1:1234
1460 # launch yet another QEMU instance on same "bus"
1461 qemu linux.img -net nic,macaddr=52:54:00:12:34:58 \
1462 -net socket,mcast=230.0.0.1:1234
1465 Example (User Mode Linux compat.):
1467 # launch QEMU instance (note mcast address selected
1469 qemu linux
.img
-net nic
,macaddr
=52:54:00:12:34:56 \
1470 -net socket
,mcast
=239.192.168.1:1102
1472 /path
/to
/linux ubd0
=/path
/to
/root_fs eth0
=mcast
1475 Example (send packets from host
's 1.2.3.4):
1477 qemu linux.img -net nic,macaddr=52:54:00:12:34:56 \
1478 -net socket,mcast=239.192.168.1:1102,localaddr=1.2.3.4
1481 @item -net vde[,vlan=@var{n}][,name=@var{name}][,sock=@var{socketpath}] [,port=@var{n}][,group=@var{groupname}][,mode=@var{octalmode}]
1482 Connect VLAN @var{n} to PORT @var{n} of a vde switch running on host and
1483 listening for incoming connections on @var{socketpath}. Use GROUP @var{groupname}
1484 and MODE @var{octalmode} to change default ownership and permissions for
1485 communication port. This option is only available if QEMU has been compiled
1486 with vde support enabled.
1491 vde_switch -F -sock /tmp/myswitch
1492 # launch QEMU instance
1493 qemu linux.img -net nic -net vde,sock=/tmp/myswitch
1496 @item -net dump[,vlan=@var{n}][,file=@var{file}][,len=@var{len}]
1497 Dump network traffic on VLAN @var{n} to file @var{file} (@file{qemu-vlan0.pcap} by default).
1498 At most @var{len} bytes (64k by default) per packet are stored. The file format is
1499 libpcap, so it can be analyzed with tools such as tcpdump or Wireshark.
1502 Indicate that no network devices should be configured. It is used to
1503 override the default configuration (@option{-net nic -net user}) which
1504 is activated if no @option{-net} options are provided.
1511 DEFHEADING(Character device options:)
1513 DEF("chardev", HAS_ARG, QEMU_OPTION_chardev,
1514 "-chardev null,id=id[,mux=on|off]\n"
1515 "-chardev socket,id=id[,host=host],port=host[,to=to][,ipv4][,ipv6][,nodelay]\n"
1516 " [,server][,nowait][,telnet][,mux=on|off] (tcp)\n"
1517 "-chardev socket,id=id,path=path[,server][,nowait][,telnet],[mux=on|off] (unix)\n"
1518 "-chardev udp,id=id[,host=host],port=port[,localaddr=localaddr]\n"
1519 " [,localport=localport][,ipv4][,ipv6][,mux=on|off]\n"
1520 "-chardev msmouse,id=id[,mux=on|off]\n"
1521 "-chardev vc,id=id[[,width=width][,height=height]][[,cols=cols][,rows=rows]]\n"
1523 "-chardev file,id=id,path=path[,mux=on|off]\n"
1524 "-chardev pipe,id=id,path=path[,mux=on|off]\n"
1526 "-chardev console,id=id[,mux=on|off]\n"
1527 "-chardev serial,id=id,path=path[,mux=on|off]\n"
1529 "-chardev pty,id=id[,mux=on|off]\n"
1530 "-chardev stdio,id=id[,mux=on|off][,signal=on|off]\n"
1532 #ifdef CONFIG_BRLAPI
1533 "-chardev braille,id=id[,mux=on|off]\n"
1535 #if defined(__linux__) || defined(__sun__) || defined(__FreeBSD__) \
1536 || defined(__NetBSD__) || defined(__OpenBSD__) || defined(__DragonFly__)
1537 "-chardev tty,id=id,path=path[,mux=on|off]\n"
1539 #if defined(__linux__) || defined(__FreeBSD__) || defined(__DragonFly__)
1540 "-chardev parport,id=id,path=path[,mux=on|off]\n"
1542 #if defined(CONFIG_SPICE)
1543 "-chardev spicevmc,id=id,name=name[,debug=debug]\n"
1550 The general form of a character device option is:
1553 @item -chardev @var{backend} ,id=@var{id} [,mux=on|off] [,@var{options}]
1571 The specific backend will determine the applicable options.
1573 All devices must have an id, which can be any string up to 127 characters long.
1574 It is used to uniquely identify this device in other command line directives.
1576 A character device may be used in multiplexing mode by multiple front-ends.
1577 The key sequence of @key{Control-a} and @key{c} will rotate the input focus
1578 between attached front-ends. Specify @option{mux=on} to enable this mode.
1580 Options to each backend are described below.
1582 @item -chardev null ,id=@var{id}
1583 A void device. This device will not emit any data, and will drop any data it
1584 receives. The null backend does not take any options.
1586 @item -chardev socket ,id=@var{id} [@var{TCP options} or @var{unix options}] [,server] [,nowait] [,telnet]
1588 Create a two-way stream socket, which can be either a TCP or a unix socket. A
1589 unix socket will be created if @option{path} is specified. Behaviour is
1590 undefined if TCP options are specified for a unix socket.
1592 @option{server} specifies that the socket shall be a listening socket.
1594 @option{nowait} specifies that QEMU should not block waiting for a client to
1595 connect to a listening socket.
1597 @option{telnet} specifies that traffic on the socket should interpret telnet
1600 TCP and unix socket options are given below:
1604 @item TCP options: port=@var{port} [,host=@var{host}] [,to=@var{to}] [,ipv4] [,ipv6] [,nodelay]
1606 @option{host} for a listening socket specifies the local address to be bound.
1607 For a connecting socket species the remote host to connect to. @option{host} is
1608 optional for listening sockets. If not specified it defaults to @code{0.0.0.0}.
1610 @option{port} for a listening socket specifies the local port to be bound. For a
1611 connecting socket specifies the port on the remote host to connect to.
1612 @option{port} can be given as either a port number or a service name.
1613 @option{port} is required.
1615 @option{to} is only relevant to listening sockets. If it is specified, and
1616 @option{port} cannot be bound, QEMU will attempt to bind to subsequent ports up
1617 to and including @option{to} until it succeeds. @option{to} must be specified
1620 @option{ipv4} and @option{ipv6} specify that either IPv4 or IPv6 must be used.
1621 If neither is specified the socket may use either protocol.
1623 @option{nodelay} disables the Nagle algorithm.
1625 @item unix options: path=@var{path}
1627 @option{path} specifies the local path of the unix socket. @option{path} is
1632 @item -chardev udp ,id=@var{id} [,host=@var{host}] ,port=@var{port} [,localaddr=@var{localaddr}] [,localport=@var{localport}] [,ipv4] [,ipv6]
1634 Sends all traffic from the guest to a remote host over UDP.
1636 @option{host} specifies the remote host to connect to. If not specified it
1637 defaults to @code{localhost}.
1639 @option{port} specifies the port on the remote host to connect to. @option{port}
1642 @option{localaddr} specifies the local address to bind to. If not specified it
1643 defaults to @code{0.0.0.0}.
1645 @option{localport} specifies the local port to bind to. If not specified any
1646 available local port will be used.
1648 @option{ipv4} and @option{ipv6} specify that either IPv4 or IPv6 must be used.
1649 If neither is specified the device may use either protocol.
1651 @item -chardev msmouse ,id=@var{id}
1653 Forward QEMU's emulated msmouse events to the guest
. @option
{msmouse
} does not
1656 @item
-chardev vc
,id
=@
var{id
} [[,width
=@
var{width
}] [,height
=@
var{height
}]] [[,cols
=@
var{cols
}] [,rows
=@
var{rows
}]]
1658 Connect to a QEMU text console
. @option
{vc
} may optionally be given a specific
1661 @option
{width
} and @option
{height
} specify the width and height respectively of
1662 the console
, in pixels
.
1664 @option
{cols
} and @option
{rows
} specify that the console be sized to fit a text
1665 console with the given dimensions
.
1667 @item
-chardev file
,id
=@
var{id
} ,path
=@
var{path
}
1669 Log all traffic received from the guest to a file
.
1671 @option
{path
} specifies the path of the file to be opened
. This file will be
1672 created
if it does not already exist
, and overwritten
if it does
. @option
{path
}
1675 @item
-chardev pipe
,id
=@
var{id
} ,path
=@
var{path
}
1677 Create a two
-way connection to the guest
. The behaviour differs slightly between
1678 Windows hosts and other hosts
:
1680 On Windows
, a single duplex pipe will be created at
1681 @file
{\\.pipe\@option
{path
}}.
1683 On other hosts
, 2 pipes will be created called @file
{@option
{path
}.in} and
1684 @file
{@option
{path
}.out
}. Data written to @file
{@option
{path
}.in} will be
1685 received by the guest
. Data written by the guest can be read from
1686 @file
{@option
{path
}.out
}. QEMU will not create these fifos
, and requires them to
1689 @option
{path
} forms part of the pipe path as described above
. @option
{path
} is
1692 @item
-chardev console
,id
=@
var{id
}
1694 Send traffic from the guest to QEMU
's standard output. @option{console} does not
1697 @option{console} is only available on Windows hosts.
1699 @item -chardev serial ,id=@var{id} ,path=@option{path}
1701 Send traffic from the guest to a serial device on the host.
1704 only available on Windows hosts.
1706 @option{path} specifies the name of the serial device to open.
1708 @item -chardev pty ,id=@var{id}
1710 Create a new pseudo-terminal on the host and connect to it. @option{pty} does
1711 not take any options.
1713 @option{pty} is not available on Windows hosts.
1715 @item -chardev stdio ,id=@var{id} [,signal=on|off]
1716 Connect to standard input and standard output of the qemu process.
1718 @option{signal} controls if signals are enabled on the terminal, that includes
1719 exiting QEMU with the key sequence @key{Control-c}. This option is enabled by
1720 default, use @option{signal=off} to disable it.
1722 @option{stdio} is not available on Windows hosts.
1724 @item -chardev braille ,id=@var{id}
1726 Connect to a local BrlAPI server. @option{braille} does not take any options.
1728 @item -chardev tty ,id=@var{id} ,path=@var{path}
1730 Connect to a local tty device.
1732 @option{tty} is only available on Linux, Sun, FreeBSD, NetBSD, OpenBSD and
1735 @option{path} specifies the path to the tty. @option{path} is required.
1737 @item -chardev parport ,id=@var{id} ,path=@var{path}
1739 @option{parport} is only available on Linux, FreeBSD and DragonFlyBSD hosts.
1741 Connect to a local parallel port.
1743 @option{path} specifies the path to the parallel port device. @option{path} is
1746 @item -chardev spicevmc ,id=@var{id} ,debug=@var{debug}, name=@var{name}
1748 @option{spicevmc} is only available when spice support is built in.
1750 @option{debug} debug level for spicevmc
1752 @option{name} name of spice channel to connect to
1754 Connect to a spice virtual machine channel, such as vdiport.
1762 DEFHEADING(Device URL Syntax:)
1764 In addition to using normal file images for the emulated storage devices,
1765 QEMU can also use networked resources such as iSCSI devices. These are
1766 specified using a special URL syntax.
1770 iSCSI support allows QEMU to access iSCSI resources directly and use as
1771 images for the guest storage. Both disk and cdrom images are supported.
1773 Syntax for specifying iSCSI LUNs is
1774 ``iscsi://<target-ip>[:<port>]/<target-iqn>/<lun>''
1776 Example (without authentication):
1778 qemu -cdrom iscsi://192.0.2.1/iqn.2001-04.com.example/2 \
1779 --drive file=iscsi://192.0.2.1/iqn.2001-04.com.example/1
1782 Example (CHAP username/password via URL):
1784 qemu --drive file=iscsi://user%password@@192.0.2.1/iqn.2001-04.com.example/1
1787 Example (CHAP username/password via environment variables):
1789 LIBISCSI_CHAP_USERNAME="user" \
1790 LIBISCSI_CHAP_PASSWORD="password" \
1791 qemu --drive file=iscsi://192.0.2.1/iqn.2001-04.com.example/1
1794 iSCSI support is an optional feature of QEMU and only available when
1795 compiled and linked against libiscsi.
1798 QEMU supports NBD (Network Block Devices) both using TCP protocol as well
1799 as Unix Domain Sockets.
1801 Syntax for specifying a NBD device using TCP
1802 ``nbd:<server-ip>:<port>[:exportname=<export>]''
1804 Syntax for specifying a NBD device using Unix Domain Sockets
1805 ``nbd:unix:<domain-socket>[:exportname=<export>]''
1810 qemu --drive file=nbd:192.0.2.1:30000
1813 Example for Unix Domain Sockets
1815 qemu --drive file=nbd:unix:/tmp/nbd-socket
1819 Sheepdog is a distributed storage system for QEMU.
1820 QEMU supports using either local sheepdog devices or remote networked
1823 Syntax for specifying a sheepdog device
1825 ``sheepdog:<vdiname>''
1827 ``sheepdog:<vdiname>:<snapid>''
1829 ``sheepdog:<vdiname>:<tag>''
1831 ``sheepdog:<host>:<port>:<vdiname>''
1833 ``sheepdog:<host>:<port>:<vdiname>:<snapid>''
1835 ``sheepdog:<host>:<port>:<vdiname>:<tag>''
1840 qemu --drive file=sheepdog:192.0.2.1:30000:MyVirtualMachine
1843 See also @url{http://http://www.osrg.net/sheepdog/}.
1848 DEFHEADING(Bluetooth(R) options:)
1850 DEF("bt", HAS_ARG, QEMU_OPTION_bt, \
1851 "-bt hci,null dumb bluetooth HCI - doesn't respond to commands
\n" \
1852 "-bt hci
,host
[:id
]\n" \
1853 " use host
's HCI with the given name\n" \
1854 "-bt hci[,vlan=n]\n" \
1855 " emulate a standard HCI in virtual scatternet 'n
'\n" \
1856 "-bt vhci[,vlan=n]\n" \
1857 " add host computer to virtual scatternet 'n
' using VHCI\n" \
1858 "-bt device:dev[,vlan=n]\n" \
1859 " emulate a bluetooth device 'dev
' in scatternet 'n
'\n",
1866 Defines the function of the corresponding Bluetooth HCI. -bt options
1867 are matched with the HCIs present in the chosen machine type. For
1868 example when emulating a machine with only one HCI built into it, only
1869 the first @code{-bt hci[...]} option is valid and defines the HCI's
1870 logic
. The Transport Layer is decided by the machine type
. Currently
1871 the machines @code
{n800
} and @code
{n810
} have one HCI and all other
1875 The following three types are recognized
:
1879 (default) The corresponding Bluetooth HCI assumes no internal logic
1880 and will not respond to any HCI commands or emit events
.
1882 @item
-bt hci
,host
[:@
var{id
}]
1883 (@code
{bluez
} only
) The corresponding HCI passes commands
/ events
1884 to
/ from the physical HCI identified by the name @
var{id
} (default:
1885 @code
{hci0
}) on the computer running QEMU
. Only available on @code
{bluez
}
1886 capable systems like Linux
.
1888 @item
-bt hci
[,vlan
=@
var{n
}]
1889 Add a virtual
, standard HCI that will participate
in the Bluetooth
1890 scatternet @
var{n
} (default @code
{0}). Similarly to @option
{-net
}
1891 VLANs
, devices inside a bluetooth network @
var{n
} can only communicate
1892 with other devices
in the same
network (scatternet
).
1895 @item
-bt vhci
[,vlan
=@
var{n
}]
1896 (Linux
-host only
) Create a HCI
in scatternet @
var{n
} (default 0) attached
1897 to the host bluetooth stack instead of to the emulated target
. This
1898 allows the host and target machines to participate
in a common scatternet
1899 and communicate
. Requires the Linux @code
{vhci
} driver installed
. Can
1900 be used as following
:
1903 qemu
[...OPTIONS
...] -bt hci
,vlan
=5 -bt vhci
,vlan
=5
1906 @item
-bt device
:@
var{dev
}[,vlan
=@
var{n
}]
1907 Emulate a bluetooth device @
var{dev
} and place it
in network @
var{n
}
1908 (default @code
{0}). QEMU can only emulate one type of bluetooth devices
1913 Virtual wireless keyboard implementing the HIDP bluetooth profile
.
1920 DEFHEADING(Linux
/Multiboot boot specific
:)
1923 When
using these options
, you can use a given Linux or Multiboot
1924 kernel without installing it
in the disk image
. It can be useful
1925 for easier testing of various kernels
.
1930 DEF("kernel", HAS_ARG
, QEMU_OPTION_kernel
, \
1931 "-kernel bzImage use 'bzImage' as kernel image\n", QEMU_ARCH_ALL
)
1933 @item
-kernel @
var{bzImage
}
1935 Use @
var{bzImage
} as kernel image
. The kernel can be either a Linux kernel
1936 or
in multiboot format
.
1939 DEF("append", HAS_ARG
, QEMU_OPTION_append
, \
1940 "-append cmdline use 'cmdline' as kernel command line\n", QEMU_ARCH_ALL
)
1942 @item
-append @
var{cmdline
}
1944 Use @
var{cmdline
} as kernel command line
1947 DEF("initrd", HAS_ARG
, QEMU_OPTION_initrd
, \
1948 "-initrd file use 'file' as initial ram disk\n", QEMU_ARCH_ALL
)
1950 @item
-initrd @
var{file
}
1952 Use @
var{file
} as initial ram disk
.
1954 @item
-initrd
"@var{file1} arg=foo,@var{file2}"
1956 This syntax is only available with multiboot
.
1958 Use @
var{file1
} and @
var{file2
} as modules and pass arg
=foo as parameter to the
1968 DEFHEADING(Debug
/Expert options
:)
1974 DEF("serial", HAS_ARG
, QEMU_OPTION_serial
, \
1975 "-serial dev redirect the serial port to char device 'dev'\n",
1978 @item
-serial @
var{dev
}
1980 Redirect the virtual serial port to host character device
1981 @
var{dev
}. The
default device is @code
{vc
} in graphical mode and
1982 @code
{stdio
} in non graphical mode
.
1984 This option can be used several times to simulate up to
4 serial
1987 Use @code
{-serial none
} to disable all serial ports
.
1989 Available character devices are
:
1991 @item vc
[:@
var{W
}x@
var{H
}]
1992 Virtual console
. Optionally
, a width and height can be given
in pixel with
1996 It is also possible to specify width or height
in characters
:
2001 [Linux only
] Pseudo
TTY (a
new PTY is automatically allocated
)
2003 No device is allocated
.
2007 [Linux only
] Use host tty
, e
.g
. @file
{/dev
/ttyS0
}. The host serial port
2008 parameters are set according to the emulated ones
.
2009 @item
/dev
/parport@
var{N
}
2010 [Linux only
, parallel port only
] Use host parallel port
2011 @
var{N
}. Currently SPP and EPP parallel port features can be used
.
2012 @item file
:@
var{filename
}
2013 Write output to @
var{filename
}. No character can be read
.
2015 [Unix only
] standard input
/output
2016 @item pipe
:@
var{filename
}
2017 name pipe @
var{filename
}
2019 [Windows only
] Use host serial port @
var{n
}
2020 @item udp
:[@
var{remote_host
}]:@
var{remote_port
}[@@
[@
var{src_ip
}]:@
var{src_port
}]
2021 This
implements UDP Net Console
.
2022 When @
var{remote_host
} or @
var{src_ip
} are not specified
2023 they
default to @code
{0.0.0.0}.
2024 When not
using a specified @
var{src_port
} a random port is automatically chosen
.
2026 If you just want a simple readonly console you can use @code
{netcat
} or
2027 @code
{nc
}, by starting qemu with
: @code
{-serial udp
::4555} and nc as
:
2028 @code
{nc
-u
-l
-p
4555}. Any time qemu writes something to that port it
2029 will appear
in the netconsole session
.
2031 If you plan to send characters back via netconsole or you want to stop
2032 and start qemu a lot of times
, you should have qemu use the same
2033 source port each time by
using something like @code
{-serial
2034 udp
::4555@@
:4556} to qemu
. Another approach is to use a patched
2035 version of netcat which can listen to a TCP port and send and receive
2036 characters via udp
. If you have a patched version of netcat which
2037 activates telnet remote echo and single char transfer
, then you can
2038 use the following options to step up a netcat redirector to allow
2039 telnet on port
5555 to access the qemu port
.
2042 -serial udp
::4555@@
:4556
2043 @item netcat options
:
2044 -u
-P
4555 -L
0.0.0.0:4556 -t
-p
5555 -I
-T
2045 @item telnet options
:
2049 @item tcp
:[@
var{host
}]:@
var{port
}[,@
var{server
}][,nowait
][,nodelay
]
2050 The TCP Net Console has two modes of operation
. It can send the serial
2051 I
/O to a location or wait
for a connection from a location
. By
default
2052 the TCP Net Console is sent to @
var{host
} at the @
var{port
}. If you use
2053 the @
var{server
} option QEMU will wait
for a client socket application
2054 to connect to the port before continuing
, unless the @code
{nowait
}
2055 option was specified
. The @code
{nodelay
} option disables the Nagle buffering
2056 algorithm
. If @
var{host
} is omitted
, 0.0.0.0 is assumed
. Only
2057 one TCP connection at a time is accepted
. You can use @code
{telnet
} to
2058 connect to the corresponding character device
.
2060 @item Example to send tcp console to
192.168.0.2 port
4444
2061 -serial tcp
:192.168.0.2:4444
2062 @item Example to listen and wait on port
4444 for connection
2063 -serial tcp
::4444,server
2064 @item Example to not wait and listen on ip
192.168.0.100 port
4444
2065 -serial tcp
:192.168.0.100:4444,server
,nowait
2068 @item telnet
:@
var{host
}:@
var{port
}[,server
][,nowait
][,nodelay
]
2069 The telnet protocol is used instead of raw tcp sockets
. The options
2070 work the same as
if you had specified @code
{-serial tcp
}. The
2071 difference is that the port acts like a telnet server or client
using
2072 telnet option negotiation
. This will also allow you to send the
2073 MAGIC_SYSRQ sequence
if you use a telnet that supports sending the
break
2074 sequence
. Typically
in unix telnet you
do it with Control
-] and then
2075 type
"send break" followed by pressing the enter key
.
2077 @item unix
:@
var{path
}[,server
][,nowait
]
2078 A unix domain socket is used instead of a tcp socket
. The option works the
2079 same as
if you had specified @code
{-serial tcp
} except the unix domain socket
2080 @
var{path
} is used
for connections
.
2082 @item mon
:@
var{dev_string
}
2083 This is a special option to allow the monitor to be multiplexed onto
2084 another serial port
. The monitor is accessed with key sequence of
2085 @key
{Control
-a
} and then pressing @key
{c
}. See monitor access
2086 @ref
{pcsys_keys
} in the
-nographic section
for more keys
.
2087 @
var{dev_string
} should be any one of the serial devices specified
2088 above
. An example to multiplex the monitor onto a telnet server
2089 listening on port
4444 would be
:
2091 @item
-serial mon
:telnet
::4444,server
,nowait
2095 Braille device
. This will use BrlAPI to display the braille output on a real
2099 Three button serial mouse
. Configure the guest to use Microsoft protocol
.
2103 DEF("parallel", HAS_ARG
, QEMU_OPTION_parallel
, \
2104 "-parallel dev redirect the parallel port to char device 'dev'\n",
2107 @item
-parallel @
var{dev
}
2109 Redirect the virtual parallel port to host device @
var{dev
} (same
2110 devices as the serial port
). On Linux hosts
, @file
{/dev
/parportN
} can
2111 be used to use hardware devices connected on the corresponding host
2114 This option can be used several times to simulate up to
3 parallel
2117 Use @code
{-parallel none
} to disable all parallel ports
.
2120 DEF("monitor", HAS_ARG
, QEMU_OPTION_monitor
, \
2121 "-monitor dev redirect the monitor to char device 'dev'\n",
2124 @item
-monitor @
var{dev
}
2126 Redirect the monitor to host device @
var{dev
} (same devices as the
2128 The
default device is @code
{vc
} in graphical mode and @code
{stdio
} in
2131 DEF("qmp", HAS_ARG
, QEMU_OPTION_qmp
, \
2132 "-qmp dev like -monitor but opens in 'control' mode\n",
2135 @item
-qmp @
var{dev
}
2137 Like
-monitor but opens
in 'control' mode
.
2140 DEF("mon", HAS_ARG
, QEMU_OPTION_mon
, \
2141 "-mon chardev=[name][,mode=readline|control][,default]\n", QEMU_ARCH_ALL
)
2143 @item
-mon chardev
=[name
][,mode
=readline|control
][,default]
2145 Setup monitor on chardev @
var{name
}.
2148 DEF("debugcon", HAS_ARG
, QEMU_OPTION_debugcon
, \
2149 "-debugcon dev redirect the debug console to char device 'dev'\n",
2152 @item
-debugcon @
var{dev
}
2154 Redirect the debug console to host device @
var{dev
} (same devices as the
2155 serial port
). The debug console is an I
/O port which is typically port
2156 0xe9; writing to that I
/O port sends output to
this device
.
2157 The
default device is @code
{vc
} in graphical mode and @code
{stdio
} in
2161 DEF("pidfile", HAS_ARG
, QEMU_OPTION_pidfile
, \
2162 "-pidfile file write PID to 'file'\n", QEMU_ARCH_ALL
)
2164 @item
-pidfile @
var{file
}
2166 Store the QEMU process PID
in @
var{file
}. It is useful
if you launch QEMU
2170 DEF("singlestep", 0, QEMU_OPTION_singlestep
, \
2171 "-singlestep always run in singlestep mode\n", QEMU_ARCH_ALL
)
2175 Run the emulation
in single step mode
.
2178 DEF("S", 0, QEMU_OPTION_S
, \
2179 "-S freeze CPU at startup (use 'c' to start execution)\n",
2184 Do not start CPU at
startup (you must type
'c' in the monitor
).
2187 DEF("gdb", HAS_ARG
, QEMU_OPTION_gdb
, \
2188 "-gdb dev wait for gdb connection on 'dev'\n", QEMU_ARCH_ALL
)
2190 @item
-gdb @
var{dev
}
2192 Wait
for gdb connection on device @
var{dev
} (@pxref
{gdb_usage
}). Typical
2193 connections will likely be TCP
-based
, but also UDP
, pseudo TTY
, or even
2194 stdio are reasonable use
case. The latter is allowing to start qemu from
2195 within gdb and establish the connection via a pipe
:
2197 (gdb
) target remote | exec qemu
-gdb stdio
...
2201 DEF("s", 0, QEMU_OPTION_s
, \
2202 "-s shorthand for -gdb tcp::" DEFAULT_GDBSTUB_PORT
"\n",
2207 Shorthand
for -gdb tcp
::1234, i
.e
. open a gdbserver on TCP port
1234
2208 (@pxref
{gdb_usage
}).
2211 DEF("d", HAS_ARG
, QEMU_OPTION_d
, \
2212 "-d item1,... output log to /tmp/qemu.log (use -d ? for a list of log items)\n",
2217 Output log
in /tmp
/qemu
.log
2220 DEF("D", HAS_ARG
, QEMU_OPTION_D
, \
2221 "-D logfile output log to logfile (instead of the default /tmp/qemu.log)\n",
2226 Output log
in logfile instead of
/tmp
/qemu
.log
2229 DEF("hdachs", HAS_ARG
, QEMU_OPTION_hdachs
, \
2230 "-hdachs c,h,s[,t]\n" \
2231 " force hard disk 0 physical geometry and the optional BIOS\n" \
2232 " translation (t=none or lba) (usually qemu can guess them)\n",
2235 @item
-hdachs @
var{c
},@
var{h
},@
var{s
},[,@
var{t
}]
2237 Force hard disk
0 physical
geometry (1 <= @
var{c
} <= 16383, 1 <=
2238 @
var{h
} <= 16, 1 <= @
var{s
} <= 63) and optionally force the BIOS
2239 translation
mode (@
var{t
}=none
, lba or auto
). Usually QEMU can guess
2240 all those parameters
. This option is useful
for old MS
-DOS disk
2244 DEF("L", HAS_ARG
, QEMU_OPTION_L
, \
2245 "-L path set the directory for the BIOS, VGA BIOS and keymaps\n",
2250 Set the directory
for the BIOS
, VGA BIOS and keymaps
.
2253 DEF("bios", HAS_ARG
, QEMU_OPTION_bios
, \
2254 "-bios file set the filename for the BIOS\n", QEMU_ARCH_ALL
)
2256 @item
-bios @
var{file
}
2258 Set the filename
for the BIOS
.
2261 DEF("enable-kvm", 0, QEMU_OPTION_enable_kvm
, \
2262 "-enable-kvm enable KVM full virtualization support\n", QEMU_ARCH_ALL
)
2266 Enable KVM full virtualization support
. This option is only available
2267 if KVM support is enabled when compiling
.
2270 DEF("xen-domid", HAS_ARG
, QEMU_OPTION_xen_domid
,
2271 "-xen-domid id specify xen guest domain id\n", QEMU_ARCH_ALL
)
2272 DEF("xen-create", 0, QEMU_OPTION_xen_create
,
2273 "-xen-create create domain using xen hypercalls, bypassing xend\n"
2274 " warning: should not be used when xend is in use\n",
2276 DEF("xen-attach", 0, QEMU_OPTION_xen_attach
,
2277 "-xen-attach attach to existing xen domain\n"
2278 " xend will use this when starting qemu\n",
2281 @item
-xen
-domid @
var{id
}
2283 Specify xen guest domain @
var{id
} (XEN only
).
2286 Create domain
using xen hypercalls
, bypassing xend
.
2287 Warning
: should not be used when xend is
in use (XEN only
).
2290 Attach to existing xen domain
.
2291 xend will use
this when starting
qemu (XEN only
).
2294 DEF("no-reboot", 0, QEMU_OPTION_no_reboot
, \
2295 "-no-reboot exit instead of rebooting\n", QEMU_ARCH_ALL
)
2299 Exit instead of rebooting
.
2302 DEF("no-shutdown", 0, QEMU_OPTION_no_shutdown
, \
2303 "-no-shutdown stop before shutdown\n", QEMU_ARCH_ALL
)
2306 @findex
-no
-shutdown
2307 Don
't exit QEMU on guest shutdown, but instead only stop the emulation.
2308 This allows for instance switching to monitor to commit changes to the
2312 DEF("loadvm", HAS_ARG, QEMU_OPTION_loadvm, \
2313 "-loadvm [tag|id]\n" \
2314 " start right away with a saved state (loadvm in monitor)\n",
2317 @item -loadvm @var{file}
2319 Start right away with a saved state (@code{loadvm} in monitor)
2323 DEF("daemonize", 0, QEMU_OPTION_daemonize, \
2324 "-daemonize daemonize QEMU after initializing\n", QEMU_ARCH_ALL)
2329 Daemonize the QEMU process after initialization. QEMU will not detach from
2330 standard IO until it is ready to receive connections on any of its devices.
2331 This option is a useful way for external programs to launch QEMU without having
2332 to cope with initialization race conditions.
2335 DEF("option-rom", HAS_ARG, QEMU_OPTION_option_rom, \
2336 "-option-rom rom load a file, rom, into the option ROM space\n",
2339 @item -option-rom @var{file}
2341 Load the contents of @var{file} as an option ROM.
2342 This option is useful to load things like EtherBoot.
2345 DEF("clock", HAS_ARG, QEMU_OPTION_clock, \
2346 "-clock force the use of the given methods for timer alarm.\n" \
2347 " To see what timers are available use -clock ?\n",
2350 @item -clock @var{method}
2352 Force the use of the given methods for timer alarm. To see what timers
2353 are available use -clock ?.
2356 HXCOMM Options deprecated by -rtc
2357 DEF("localtime", 0, QEMU_OPTION_localtime, "", QEMU_ARCH_ALL)
2358 DEF("startdate", HAS_ARG, QEMU_OPTION_startdate, "", QEMU_ARCH_ALL)
2360 DEF("rtc", HAS_ARG, QEMU_OPTION_rtc, \
2361 "-rtc [base=utc|localtime|date][,clock=host|vm][,driftfix=none|slew]\n" \
2362 " set the RTC base and clock, enable drift fix for clock ticks (x86 only)\n",
2367 @item -rtc [base=utc|localtime|@var{date}][,clock=host|vm][,driftfix=none|slew]
2369 Specify @option{base} as @code{utc} or @code{localtime} to let the RTC start at the current
2370 UTC or local time, respectively. @code{localtime} is required for correct date in
2371 MS-DOS or Windows. To start at a specific point in time, provide @var{date} in the
2372 format @code{2006-06-17T16:01:21} or @code{2006-06-17}. The default base is UTC.
2374 By default the RTC is driven by the host system time. This allows to use the
2375 RTC as accurate reference clock inside the guest, specifically if the host
2376 time is smoothly following an accurate external reference clock, e.g. via NTP.
2377 If you want to isolate the guest time from the host, even prevent it from
2378 progressing during suspension, you can set @option{clock} to @code{vm} instead.
2380 Enable @option{driftfix} (i386 targets only) if you experience time drift problems,
2381 specifically with Windows' ACPI HAL
. This option will
try to figure out how
2382 many timer interrupts were not processed by the Windows guest and will
2386 DEF("icount", HAS_ARG
, QEMU_OPTION_icount
, \
2387 "-icount [N|auto]\n" \
2388 " enable virtual instruction counter with 2^N clock ticks per\n" \
2389 " instruction\n", QEMU_ARCH_ALL
)
2391 @item
-icount
[@
var{N
}|auto
]
2393 Enable virtual instruction counter
. The virtual cpu will execute one
2394 instruction every
2^@
var{N
} ns of virtual time
. If @code
{auto
} is specified
2395 then the virtual cpu speed will be automatically adjusted to keep virtual
2396 time within a few seconds of real time
.
2398 Note that
while this option can give deterministic behavior
, it does not
2399 provide cycle accurate emulation
. Modern CPUs contain superscalar out of
2400 order cores with complex cache hierarchies
. The number of instructions
2401 executed often has little or no correlation with actual performance
.
2404 DEF("watchdog", HAS_ARG
, QEMU_OPTION_watchdog
, \
2405 "-watchdog i6300esb|ib700\n" \
2406 " enable virtual hardware watchdog [default=none]\n",
2409 @item
-watchdog @
var{model
}
2411 Create a virtual hardware watchdog device
. Once
enabled (by a guest
2412 action
), the watchdog must be periodically polled by an agent inside
2413 the guest or
else the guest will be restarted
.
2415 The @
var{model
} is the model of hardware watchdog to emulate
. Choices
2416 for model are
: @code
{ib700
} (iBASE
700) which is a very simple ISA
2417 watchdog with a single timer
, or @code
{i6300esb
} (Intel
6300ESB I
/O
2418 controller hub
) which is a much more featureful PCI
-based dual
-timer
2419 watchdog
. Choose a model
for which your guest has drivers
.
2421 Use @code
{-watchdog ?
} to list available hardware models
. Only one
2422 watchdog can be enabled
for a guest
.
2425 DEF("watchdog-action", HAS_ARG
, QEMU_OPTION_watchdog_action
, \
2426 "-watchdog-action reset|shutdown|poweroff|pause|debug|none\n" \
2427 " action when watchdog fires [default=reset]\n",
2430 @item
-watchdog
-action @
var{action
}
2432 The @
var{action
} controls what QEMU will
do when the watchdog timer
2435 @code
{reset
} (forcefully reset the guest
).
2436 Other possible actions are
:
2437 @code
{shutdown
} (attempt to gracefully shutdown the guest
),
2438 @code
{poweroff
} (forcefully poweroff the guest
),
2439 @code
{pause
} (pause the guest
),
2440 @code
{debug
} (print a debug message and
continue), or
2441 @code
{none
} (do nothing
).
2443 Note that the @code
{shutdown
} action requires that the guest responds
2444 to ACPI signals
, which it may not be able to
do in the sort of
2445 situations where the watchdog would have expired
, and thus
2446 @code
{-watchdog
-action shutdown
} is not recommended
for production use
.
2451 @item
-watchdog i6300esb
-watchdog
-action pause
2452 @item
-watchdog ib700
2456 DEF("echr", HAS_ARG
, QEMU_OPTION_echr
, \
2457 "-echr chr set terminal escape character instead of ctrl-a\n",
2461 @item
-echr @
var{numeric_ascii_value
}
2463 Change the escape character used
for switching to the monitor when
using
2464 monitor and serial sharing
. The
default is @code
{0x01} when
using the
2465 @code
{-nographic
} option
. @code
{0x01} is equal to pressing
2466 @code
{Control
-a
}. You can select a different character from the ascii
2467 control keys where
1 through
26 map to Control
-a through Control
-z
. For
2468 instance you could use the either of the following to change the escape
2469 character to Control
-t
.
2476 DEF("virtioconsole", HAS_ARG
, QEMU_OPTION_virtiocon
, \
2477 "-virtioconsole c\n" \
2478 " set virtio console\n", QEMU_ARCH_ALL
)
2480 @item
-virtioconsole @
var{c
}
2481 @findex
-virtioconsole
2484 This option is maintained
for backward compatibility
.
2486 Please use @code
{-device virtconsole
} for the
new way of invocation
.
2489 DEF("show-cursor", 0, QEMU_OPTION_show_cursor
, \
2490 "-show-cursor show cursor\n", QEMU_ARCH_ALL
)
2493 @findex
-show
-cursor
2497 DEF("tb-size", HAS_ARG
, QEMU_OPTION_tb_size
, \
2498 "-tb-size n set TB size\n", QEMU_ARCH_ALL
)
2500 @item
-tb
-size @
var{n
}
2505 DEF("incoming", HAS_ARG
, QEMU_OPTION_incoming
, \
2506 "-incoming p prepare for incoming migration, listen on port p\n",
2509 @item
-incoming @
var{port
}
2511 Prepare
for incoming migration
, listen on @
var{port
}.
2514 DEF("nodefaults", 0, QEMU_OPTION_nodefaults
, \
2515 "-nodefaults don't create default devices\n", QEMU_ARCH_ALL
)
2519 Don
't create default devices.
2523 DEF("chroot", HAS_ARG, QEMU_OPTION_chroot, \
2524 "-chroot dir chroot to dir just before starting the VM\n",
2528 @item -chroot @var{dir}
2530 Immediately before starting guest execution, chroot to the specified
2531 directory. Especially useful in combination with -runas.
2535 DEF("runas", HAS_ARG, QEMU_OPTION_runas, \
2536 "-runas user change to user id user just before starting the VM\n",
2540 @item -runas @var{user}
2542 Immediately before starting guest execution, drop root privileges, switching
2543 to the specified user.
2546 DEF("prom-env", HAS_ARG, QEMU_OPTION_prom_env,
2547 "-prom-env variable=value\n"
2548 " set OpenBIOS nvram variables\n",
2549 QEMU_ARCH_PPC | QEMU_ARCH_SPARC)
2551 @item -prom-env @var{variable}=@var{value}
2553 Set OpenBIOS nvram @var{variable} to given @var{value} (PPC, SPARC only).
2555 DEF("semihosting", 0, QEMU_OPTION_semihosting,
2556 "-semihosting semihosting mode\n", QEMU_ARCH_ARM | QEMU_ARCH_M68K | QEMU_ARCH_XTENSA)
2559 @findex -semihosting
2560 Semihosting mode (ARM, M68K, Xtensa only).
2562 DEF("old-param", 0, QEMU_OPTION_old_param,
2563 "-old-param old param mode\n", QEMU_ARCH_ARM)
2566 @findex -old-param (ARM)
2567 Old param mode (ARM only).
2570 DEF("readconfig", HAS_ARG, QEMU_OPTION_readconfig,
2571 "-readconfig <file>\n", QEMU_ARCH_ALL)
2573 @item -readconfig @var{file}
2575 Read device configuration from @var{file}.
2577 DEF("writeconfig", HAS_ARG, QEMU_OPTION_writeconfig,
2578 "-writeconfig <file>\n"
2579 " read/write config file\n", QEMU_ARCH_ALL)
2581 @item -writeconfig @var{file}
2582 @findex -writeconfig
2583 Write device configuration to @var{file}.
2585 DEF("nodefconfig", 0, QEMU_OPTION_nodefconfig,
2587 " do not load default config files at startup\n",
2591 @findex -nodefconfig
2592 Normally QEMU loads a configuration file from @var{sysconfdir}/qemu.conf and
2593 @var{sysconfdir}/target-@var{ARCH}.conf on startup. The @code{-nodefconfig}
2594 option will prevent QEMU from loading these configuration files at startup.
2596 DEF("trace", HAS_ARG, QEMU_OPTION_trace,
2597 "-trace [events=<file>][,file=<file>]\n"
2598 " specify tracing options\n",
2601 HXCOMM This line is not accurate, as some sub-options are backend-specific but
2602 HXCOMM HX does not support conditional compilation of text.
2603 @item -trace [events=@var{file}][,file=@var{file}]
2606 Specify tracing options.
2609 @item events=@var{file}
2610 Immediately enable events listed in @var{file}.
2611 The file must contain one event name (as listed in the @var{trace-events} file)
2613 This option is only available if QEMU has been compiled with
2614 either @var{simple} or @var{stderr} tracing backend.
2615 @item file=@var{file}
2616 Log output traces to @var{file}.
2618 This option is only available if QEMU has been compiled with
2619 the @var{simple} tracing backend.
2623 HXCOMM This is the last statement. Insert new options before this line!