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 [cpus=]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
[cpus
=]@
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("add-fd", HAS_ARG
, QEMU_OPTION_add_fd
,
107 "-add-fd fd=fd,set=set[,opaque=opaque]\n"
108 " Add 'fd' to fd 'set'\n", QEMU_ARCH_ALL
)
110 @item
-add
-fd fd
=@
var{fd
},set
=@
var{set
}[,opaque
=@
var{opaque
}]
113 Add a file descriptor to an fd set
. Valid options are
:
117 This option defines the file descriptor of which a duplicate is added to fd set
.
118 The file descriptor cannot be stdin
, stdout
, or stderr
.
120 This option defines the ID of the fd set to add the file descriptor to
.
121 @item opaque
=@
var{opaque
}
122 This option defines a free
-form string that can be used to describe @
var{fd
}.
125 You can open an image
using pre
-opened file descriptors from an fd set
:
128 -add
-fd fd
=3,set
=2,opaque
="rdwr:/path/to/file"
129 -add
-fd fd
=4,set
=2,opaque
="rdonly:/path/to/file"
130 -drive file
=/dev
/fdset
/2,index
=0,media
=disk
134 DEF("set", HAS_ARG
, QEMU_OPTION_set
,
135 "-set group.id.arg=value\n"
136 " set <arg> parameter for item <id> of type <group>\n"
137 " i.e. -set drive.$id.file=/path/to/image\n", QEMU_ARCH_ALL
)
139 @item
-set @
var{group
}.@
var{id
}.@
var{arg
}=@
var{value
}
141 Set parameter @
var{arg
} for item @
var{id
} of type @
var{group
}\n"
144 DEF("global
", HAS_ARG, QEMU_OPTION_global,
145 "-global driver
.prop
=value
\n"
146 " set a global
default for a driver property
\n",
149 @item -global @var{driver}.@var{prop}=@var{value}
151 Set default value of @var{driver}'s property @var{prop} to @var{value}, e.g.:
154 qemu-system-i386 -global ide-drive.physical_block_size=4096 -drive file=file,if=ide,index=0,media=disk
157 In particular, you can use this to set driver properties for devices which are
158 created automatically by the machine model. To create a device which is not
159 created automatically and set properties on it, use -@option{device}.
162 DEF("boot
", HAS_ARG, QEMU_OPTION_boot,
163 "-boot
[order
=drives
][,once
=drives
][,menu
=on|off
]\n"
164 " [,splash
=sp_name
][,splash
-time
=sp_time
][,reboot
-timeout
=rb_time
][,strict
=on|off
]\n"
165 " 'drives': floppy (a
), hard
disk (c
), CD
-ROM (d
), network (n
)\n"
166 " 'sp_name': the file
's name that would be passed to bios as logo picture, if menu=on\n"
167 " 'sp_time
': the period that splash picture last if menu=on, unit is ms\n"
168 " 'rb_timeout
': the timeout before guest reboot when boot failed, unit is ms\n",
171 @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}][,strict=on|off]
173 Specify boot order @var{drives} as a string of drive letters. Valid
174 drive letters depend on the target achitecture. The x86 PC uses: a, b
175 (floppy 1 and 2), c (first hard disk), d (first CD-ROM), n-p (Etherboot
176 from network adapter 1-4), hard disk boot is the default. To apply a
177 particular boot order only on the first startup, specify it via
180 Interactive boot menus/prompts can be enabled via @option{menu=on} as far
181 as firmware/BIOS supports them. The default is non-interactive boot.
183 A splash picture could be passed to bios, enabling user to show it as logo,
184 when option splash=@var{sp_name} is given and menu=on, If firmware/BIOS
185 supports them. Currently Seabios for X86 system support it.
186 limitation: The splash file could be a jpeg file or a BMP file in 24 BPP
187 format(true color). The resolution should be supported by the SVGA mode, so
188 the recommended is 320x240, 640x480, 800x640.
190 A timeout could be passed to bios, guest will pause for @var{rb_timeout} ms
191 when boot failed, then reboot. If @var{rb_timeout} is '-1', guest will not
192 reboot, qemu passes '-1' to bios by default. Currently Seabios for X86
195 Do strict boot via @option{strict=on} as far as firmware/BIOS
196 supports it. This only effects when boot priority is changed by
197 bootindex options. The default is non-strict boot.
200 # try to boot from network first, then from hard disk
201 qemu-system-i386 -boot order=nc
202 # boot from CD-ROM first, switch back to default order after reboot
203 qemu-system-i386 -boot once=d
204 # boot with a splash picture for 5 seconds.
205 qemu-system-i386 -boot menu=on,splash=/root/boot.bmp,splash-time=5000
208 Note: The legacy format '-boot @
var{drives
}' is still supported but its
209 use is discouraged as it may be removed from future versions.
212 DEF("m", HAS_ARG, QEMU_OPTION_m,
214 " configure guest RAM\n"
215 " size: initial amount of guest memory (default: "
216 stringify(DEFAULT_RAM_SIZE) "MiB)\n",
219 @item -m [size=]@var{megs}
221 Set virtual RAM size to @var{megs} megabytes. Default is 128 MiB. Optionally,
222 a suffix of ``M'' or ``G'' can be used to signify a value in megabytes or
223 gigabytes respectively.
226 DEF("mem-path", HAS_ARG, QEMU_OPTION_mempath,
227 "-mem-path FILE provide backing storage for guest RAM\n", QEMU_ARCH_ALL)
229 @item -mem-path @var{path}
231 Allocate guest RAM from a temporarily created file in @var{path}.
234 DEF("mem-prealloc", 0, QEMU_OPTION_mem_prealloc,
235 "-mem-prealloc preallocate guest memory (use with -mem-path)\n",
239 @findex -mem-prealloc
240 Preallocate memory when using -mem-path.
243 DEF("k", HAS_ARG, QEMU_OPTION_k,
244 "-k language use keyboard layout (for example 'fr
' for French)\n",
247 @item -k @var{language}
249 Use keyboard layout @var{language} (for example @code{fr} for
250 French). This option is only needed where it is not easy to get raw PC
251 keycodes (e.g. on Macs, with some X11 servers or with a VNC
252 display). You don't normally need to use it on PC
/Linux or PC
/Windows
255 The available layouts are
:
257 ar de
-ch es fo fr
-ca hu ja mk no pt
-br sv
258 da en
-gb et fr fr
-ch is lt nl pl ru th
259 de en
-us fi fr
-be hr it lv nl
-be pt sl tr
262 The
default is @code
{en
-us
}.
266 DEF("audio-help", 0, QEMU_OPTION_audio_help
,
267 "-audio-help print list of audio drivers and their options\n",
272 Will show the audio subsystem help
: list of drivers
, tunable
276 DEF("soundhw", HAS_ARG
, QEMU_OPTION_soundhw
,
277 "-soundhw c1,... enable audio support\n"
278 " and only specified sound cards (comma separated list)\n"
279 " use '-soundhw help' to get the list of supported cards\n"
280 " use '-soundhw all' to enable all of them\n", QEMU_ARCH_ALL
)
282 @item
-soundhw @
var{card1
}[,@
var{card2
},...] or
-soundhw all
284 Enable audio and selected sound hardware
. Use
'help' to print all
285 available sound hardware
.
288 qemu
-system
-i386
-soundhw sb16
,adlib disk
.img
289 qemu
-system
-i386
-soundhw es1370 disk
.img
290 qemu
-system
-i386
-soundhw ac97 disk
.img
291 qemu
-system
-i386
-soundhw hda disk
.img
292 qemu
-system
-i386
-soundhw all disk
.img
293 qemu
-system
-i386
-soundhw help
296 Note that Linux
's i810_audio OSS kernel (for AC97) module might
297 require manually specifying clocking.
300 modprobe i810_audio clocking=48000
304 DEF("balloon", HAS_ARG, QEMU_OPTION_balloon,
305 "-balloon none disable balloon device\n"
306 "-balloon virtio[,addr=str]\n"
307 " enable virtio balloon device (default)\n", QEMU_ARCH_ALL)
311 Disable balloon device.
312 @item -balloon virtio[,addr=@var{addr}]
313 Enable virtio balloon device (default), optionally with PCI address
317 DEF("device", HAS_ARG, QEMU_OPTION_device,
318 "-device driver[,prop[=value][,...]]\n"
319 " add device (based on driver)\n"
320 " prop=value,... sets driver properties\n"
321 " use '-device help
' to print all possible drivers\n"
322 " use '-device driver
,help
' to print all possible properties\n",
325 @item -device @var{driver}[,@var{prop}[=@var{value}][,...]]
327 Add device @var{driver}. @var{prop}=@var{value} sets driver
328 properties. Valid properties depend on the driver. To get help on
329 possible drivers and properties, use @code{-device help} and
330 @code{-device @var{driver},help}.
333 DEF("name", HAS_ARG, QEMU_OPTION_name,
334 "-name string1[,process=string2][,debug-threads=on|off]\n"
335 " set the name of the guest\n"
336 " string1 sets the window title and string2 the process name (on Linux)\n"
337 " When debug-threads is enabled, individual threads are given a separate name (on Linux)\n"
338 " NOTE: The thread names are for debugging and not a stable API.\n",
341 @item -name @var{name}
343 Sets the @var{name} of the guest.
344 This name will be displayed in the SDL window caption.
345 The @var{name} will also be used for the VNC server.
346 Also optionally set the top visible process name in Linux.
347 Naming of individual threads can also be enabled on Linux to aid debugging.
350 DEF("uuid", HAS_ARG, QEMU_OPTION_uuid,
351 "-uuid %08x-%04x-%04x-%04x-%012x\n"
352 " specify machine UUID\n", QEMU_ARCH_ALL)
354 @item -uuid @var{uuid}
364 DEFHEADING(Block device options:)
369 DEF("fda", HAS_ARG, QEMU_OPTION_fda,
370 "-fda/-fdb file use 'file
' as floppy disk 0/1 image\n", QEMU_ARCH_ALL)
371 DEF("fdb", HAS_ARG, QEMU_OPTION_fdb, "", QEMU_ARCH_ALL)
373 @item -fda @var{file}
374 @item -fdb @var{file}
377 Use @var{file} as floppy disk 0/1 image (@pxref{disk_images}). You can
378 use the host floppy by using @file{/dev/fd0} as filename (@pxref{host_drives}).
381 DEF("hda", HAS_ARG, QEMU_OPTION_hda,
382 "-hda/-hdb file use 'file
' as IDE hard disk 0/1 image\n", QEMU_ARCH_ALL)
383 DEF("hdb", HAS_ARG, QEMU_OPTION_hdb, "", QEMU_ARCH_ALL)
384 DEF("hdc", HAS_ARG, QEMU_OPTION_hdc,
385 "-hdc/-hdd file use 'file
' as IDE hard disk 2/3 image\n", QEMU_ARCH_ALL)
386 DEF("hdd", HAS_ARG, QEMU_OPTION_hdd, "", QEMU_ARCH_ALL)
388 @item -hda @var{file}
389 @item -hdb @var{file}
390 @item -hdc @var{file}
391 @item -hdd @var{file}
396 Use @var{file} as hard disk 0, 1, 2 or 3 image (@pxref{disk_images}).
399 DEF("cdrom", HAS_ARG, QEMU_OPTION_cdrom,
400 "-cdrom file use 'file
' as IDE cdrom image (cdrom is ide1 master)\n",
403 @item -cdrom @var{file}
405 Use @var{file} as CD-ROM image (you cannot use @option{-hdc} and
406 @option{-cdrom} at the same time). You can use the host CD-ROM by
407 using @file{/dev/cdrom} as filename (@pxref{host_drives}).
410 DEF("drive", HAS_ARG, QEMU_OPTION_drive,
411 "-drive [file=file][,if=type][,bus=n][,unit=m][,media=d][,index=i]\n"
412 " [,cyls=c,heads=h,secs=s[,trans=t]][,snapshot=on|off]\n"
413 " [,cache=writethrough|writeback|none|directsync|unsafe][,format=f]\n"
414 " [,serial=s][,addr=A][,id=name][,aio=threads|native]\n"
415 " [,readonly=on|off][,copy-on-read=on|off]\n"
416 " [[,bps=b]|[[,bps_rd=r][,bps_wr=w]]]\n"
417 " [[,iops=i]|[[,iops_rd=r][,iops_wr=w]]]\n"
418 " [[,bps_max=bm]|[[,bps_rd_max=rm][,bps_wr_max=wm]]]\n"
419 " [[,iops_max=im]|[[,iops_rd_max=irm][,iops_wr_max=iwm]]]\n"
420 " [[,iops_size=is]]\n"
421 " use 'file
' as a drive image\n", QEMU_ARCH_ALL)
423 @item -drive @var{option}[,@var{option}[,@var{option}[,...]]]
426 Define a new drive. Valid options are:
429 @item file=@var{file}
430 This option defines which disk image (@pxref{disk_images}) to use with
431 this drive. If the filename contains comma, you must double it
432 (for instance, "file=my,,file" to use file "my,file").
434 Special files such as iSCSI devices can be specified using protocol
435 specific URLs. See the section for "Device URL Syntax" for more information.
436 @item if=@var{interface}
437 This option defines on which type on interface the drive is connected.
438 Available types are: ide, scsi, sd, mtd, floppy, pflash, virtio.
439 @item bus=@var{bus},unit=@var{unit}
440 These options define where is connected the drive by defining the bus number and
442 @item index=@var{index}
443 This option defines where is connected the drive by using an index in the list
444 of available connectors of a given interface type.
445 @item media=@var{media}
446 This option defines the type of the media: disk or cdrom.
447 @item cyls=@var{c},heads=@var{h},secs=@var{s}[,trans=@var{t}]
448 These options have the same definition as they have in @option{-hdachs}.
449 @item snapshot=@var{snapshot}
450 @var{snapshot} is "on" or "off" and controls snapshot mode for the given drive
451 (see @option{-snapshot}).
452 @item cache=@var{cache}
453 @var{cache} is "none", "writeback", "unsafe", "directsync" or "writethrough" and controls how the host cache is used to access block data.
455 @var{aio} is "threads", or "native" and selects between pthread based disk I/O and native Linux AIO.
456 @item discard=@var{discard}
457 @var{discard} is one of "ignore" (or "off") or "unmap" (or "on") and controls whether @dfn{discard} (also known as @dfn{trim} or @dfn{unmap}) requests are ignored or passed to the filesystem. Some machine types may not support discard requests.
458 @item format=@var{format}
459 Specify which disk @var{format} will be used rather than detecting
460 the format. Can be used to specifiy format=raw to avoid interpreting
461 an untrusted format header.
462 @item serial=@var{serial}
463 This option specifies the serial number to assign to the device.
464 @item addr=@var{addr}
465 Specify the controller's PCI
address (if=virtio only
).
466 @item werror
=@
var{action
},rerror
=@
var{action
}
467 Specify which @
var{action
} to take on write and read errors
. Valid actions are
:
468 "ignore" (ignore the error and
try to
continue), "stop" (pause QEMU
),
469 "report" (report the error to the guest
), "enospc" (pause QEMU only
if the
470 host disk is full
; report the error to the guest otherwise
).
471 The
default setting is @option
{werror
=enospc
} and @option
{rerror
=report
}.
473 Open drive @option
{file
} as read
-only
. Guest write attempts will fail
.
474 @item copy
-on
-read
=@
var{copy
-on
-read
}
475 @
var{copy
-on
-read
} is
"on" or
"off" and enables whether to copy read backing
476 file sectors into the image file
.
479 By
default, the @option
{cache
=writeback
} mode is used
. It will report data
480 writes as completed as soon as the data is present
in the host page cache
.
481 This is safe as long as your guest OS makes sure to correctly flush disk caches
482 where needed
. If your guest OS does not handle volatile disk write caches
483 correctly and your host crashes or loses power
, then the guest may experience
486 For such guests
, you should consider
using @option
{cache
=writethrough
}. This
487 means that the host page cache will be used to read and write data
, but write
488 notification will be sent to the guest only after QEMU has made sure to flush
489 each write to the disk
. Be aware that
this has a major impact on performance
.
491 The host page cache can be avoided entirely with @option
{cache
=none
}. This will
492 attempt to
do disk IO directly to the guest
's memory. QEMU may still perform
493 an internal copy of the data. Note that this is considered a writeback mode and
494 the guest OS must handle the disk write cache correctly in order to avoid data
495 corruption on host crashes.
497 The host page cache can be avoided while only sending write notifications to
498 the guest when the data has been flushed to the disk using
499 @option{cache=directsync}.
501 In case you don't care about data integrity over host failures
, use
502 @option
{cache
=unsafe
}. This option tells QEMU that it
never needs to write any
503 data to the disk but can instead keep things
in cache
. If anything goes wrong
,
504 like your host losing power
, the disk storage getting disconnected accidentally
,
505 etc
. your image will most probably be rendered unusable
. When
using
506 the @option
{-snapshot
} option
, unsafe caching is always used
.
508 Copy
-on
-read avoids accessing the same backing file sectors repeatedly and is
509 useful when the backing file is over a slow network
. By
default copy
-on
-read
512 Instead of @option
{-cdrom
} you can use
:
514 qemu
-system
-i386
-drive file
=file
,index
=2,media
=cdrom
517 Instead of @option
{-hda
}, @option
{-hdb
}, @option
{-hdc
}, @option
{-hdd
}, you can
520 qemu
-system
-i386
-drive file
=file
,index
=0,media
=disk
521 qemu
-system
-i386
-drive file
=file
,index
=1,media
=disk
522 qemu
-system
-i386
-drive file
=file
,index
=2,media
=disk
523 qemu
-system
-i386
-drive file
=file
,index
=3,media
=disk
526 You can open an image
using pre
-opened file descriptors from an fd set
:
529 -add
-fd fd
=3,set
=2,opaque
="rdwr:/path/to/file"
530 -add
-fd fd
=4,set
=2,opaque
="rdonly:/path/to/file"
531 -drive file
=/dev
/fdset
/2,index
=0,media
=disk
534 You can connect a CDROM to the slave of ide0
:
536 qemu
-system
-i386
-drive file
=file
,if=ide
,index
=1,media
=cdrom
539 If you don
't specify the "file=" argument, you define an empty drive:
541 qemu-system-i386 -drive if=ide,index=1,media=cdrom
544 You can connect a SCSI disk with unit ID 6 on the bus #0:
546 qemu-system-i386 -drive file=file,if=scsi,bus=0,unit=6
549 Instead of @option{-fda}, @option{-fdb}, you can use:
551 qemu-system-i386 -drive file=file,index=0,if=floppy
552 qemu-system-i386 -drive file=file,index=1,if=floppy
555 By default, @var{interface} is "ide" and @var{index} is automatically
558 qemu-system-i386 -drive file=a -drive file=b"
562 qemu-system-i386 -hda a -hdb b
566 DEF("mtdblock", HAS_ARG, QEMU_OPTION_mtdblock,
567 "-mtdblock file use 'file
' as on-board Flash memory image\n",
570 @item -mtdblock @var{file}
572 Use @var{file} as on-board Flash memory image.
575 DEF("sd", HAS_ARG, QEMU_OPTION_sd,
576 "-sd file use 'file
' as SecureDigital card image\n", QEMU_ARCH_ALL)
580 Use @var{file} as SecureDigital card image.
583 DEF("pflash", HAS_ARG, QEMU_OPTION_pflash,
584 "-pflash file use 'file
' as a parallel flash image\n", QEMU_ARCH_ALL)
586 @item -pflash @var{file}
588 Use @var{file} as a parallel flash image.
591 DEF("snapshot", 0, QEMU_OPTION_snapshot,
592 "-snapshot write to temporary files instead of disk image files\n",
597 Write to temporary files instead of disk image files. In this case,
598 the raw disk image you use is not written back. You can however force
599 the write back by pressing @key{C-a s} (@pxref{disk_images}).
602 DEF("hdachs", HAS_ARG, QEMU_OPTION_hdachs, \
603 "-hdachs c,h,s[,t]\n" \
604 " force hard disk 0 physical geometry and the optional BIOS\n" \
605 " translation (t=none or lba) (usually QEMU can guess them)\n",
608 @item -hdachs @var{c},@var{h},@var{s},[,@var{t}]
610 Force hard disk 0 physical geometry (1 <= @var{c} <= 16383, 1 <=
611 @var{h} <= 16, 1 <= @var{s} <= 63) and optionally force the BIOS
612 translation mode (@var{t}=none, lba or auto). Usually QEMU can guess
613 all those parameters. This option is useful for old MS-DOS disk
617 DEF("fsdev", HAS_ARG, QEMU_OPTION_fsdev,
618 "-fsdev fsdriver,id=id[,path=path,][security_model={mapped-xattr|mapped-file|passthrough|none}]\n"
619 " [,writeout=immediate][,readonly][,socket=socket|sock_fd=sock_fd]\n",
624 @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}]
626 Define a new file system device. Valid options are:
629 This option specifies the fs driver backend to use.
630 Currently "local", "handle" and "proxy" file system drivers are supported.
632 Specifies identifier for this device
633 @item path=@var{path}
634 Specifies the export path for the file system device. Files under
635 this path will be available to the 9p client on the guest.
636 @item security_model=@var{security_model}
637 Specifies the security model to be used for this export path.
638 Supported security models are "passthrough", "mapped-xattr", "mapped-file" and "none".
639 In "passthrough" security model, files are stored using the same
640 credentials as they are created on the guest. This requires QEMU
641 to run as root. In "mapped-xattr" security model, some of the file
642 attributes like uid, gid, mode bits and link target are stored as
643 file attributes. For "mapped-file" these attributes are stored in the
644 hidden .virtfs_metadata directory. Directories exported by this security model cannot
645 interact with other unix tools. "none" security model is same as
646 passthrough except the sever won't report failures
if it fails to
647 set file attributes like ownership
. Security model is mandatory
648 only
for local fsdriver
. Other
fsdrivers (like handle
, proxy
) don
't take
649 security model as a parameter.
650 @item writeout=@var{writeout}
651 This is an optional argument. The only supported value is "immediate".
652 This means that host page cache will be used to read and write data but
653 write notification will be sent to the guest only when the data has been
654 reported as written by the storage subsystem.
656 Enables exporting 9p share as a readonly mount for guests. By default
657 read-write access is given.
658 @item socket=@var{socket}
659 Enables proxy filesystem driver to use passed socket file for communicating
660 with virtfs-proxy-helper
661 @item sock_fd=@var{sock_fd}
662 Enables proxy filesystem driver to use passed socket descriptor for
663 communicating with virtfs-proxy-helper. Usually a helper like libvirt
664 will create socketpair and pass one of the fds as sock_fd
667 -fsdev option is used along with -device driver "virtio-9p-pci".
668 @item -device virtio-9p-pci,fsdev=@var{id},mount_tag=@var{mount_tag}
669 Options for virtio-9p-pci driver are:
672 Specifies the id value specified along with -fsdev option
673 @item mount_tag=@var{mount_tag}
674 Specifies the tag name to be used by the guest to mount this export point
679 DEF("virtfs", HAS_ARG, QEMU_OPTION_virtfs,
680 "-virtfs local,path=path,mount_tag=tag,security_model=[mapped-xattr|mapped-file|passthrough|none]\n"
681 " [,writeout=immediate][,readonly][,socket=socket|sock_fd=sock_fd]\n",
686 @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}]
689 The general form of a Virtual File system pass-through options are:
692 This option specifies the fs driver backend to use.
693 Currently "local", "handle" and "proxy" file system drivers are supported.
695 Specifies identifier for this device
696 @item path=@var{path}
697 Specifies the export path for the file system device. Files under
698 this path will be available to the 9p client on the guest.
699 @item security_model=@var{security_model}
700 Specifies the security model to be used for this export path.
701 Supported security models are "passthrough", "mapped-xattr", "mapped-file" and "none".
702 In "passthrough" security model, files are stored using the same
703 credentials as they are created on the guest. This requires QEMU
704 to run as root. In "mapped-xattr" security model, some of the file
705 attributes like uid, gid, mode bits and link target are stored as
706 file attributes. For "mapped-file" these attributes are stored in the
707 hidden .virtfs_metadata directory. Directories exported by this security model cannot
708 interact with other unix tools. "none" security model is same as
709 passthrough except the sever won't report failures
if it fails to
710 set file attributes like ownership
. Security model is mandatory only
711 for local fsdriver
. Other
fsdrivers (like handle
, proxy
) don
't take security
712 model as a parameter.
713 @item writeout=@var{writeout}
714 This is an optional argument. The only supported value is "immediate".
715 This means that host page cache will be used to read and write data but
716 write notification will be sent to the guest only when the data has been
717 reported as written by the storage subsystem.
719 Enables exporting 9p share as a readonly mount for guests. By default
720 read-write access is given.
721 @item socket=@var{socket}
722 Enables proxy filesystem driver to use passed socket file for
723 communicating with virtfs-proxy-helper. Usually a helper like libvirt
724 will create socketpair and pass one of the fds as sock_fd
726 Enables proxy filesystem driver to use passed 'sock_fd
' as the socket
727 descriptor for interfacing with virtfs-proxy-helper
731 DEF("virtfs_synth", 0, QEMU_OPTION_virtfs_synth,
732 "-virtfs_synth Create synthetic file system image\n",
736 @findex -virtfs_synth
737 Create synthetic file system image
745 DEFHEADING(USB options:)
750 DEF("usb", 0, QEMU_OPTION_usb,
751 "-usb enable the USB driver (will be the default soon)\n",
756 Enable the USB driver (will be the default soon)
759 DEF("usbdevice", HAS_ARG, QEMU_OPTION_usbdevice,
760 "-usbdevice name add the host or guest USB device 'name
'\n",
764 @item -usbdevice @var{devname}
766 Add the USB device @var{devname}. @xref{usb_devices}.
771 Virtual Mouse. This will override the PS/2 mouse emulation when activated.
774 Pointer device that uses absolute coordinates (like a touchscreen). This
775 means QEMU is able to report the mouse position without having to grab the
776 mouse. Also overrides the PS/2 mouse emulation when activated.
778 @item disk:[format=@var{format}]:@var{file}
779 Mass storage device based on file. The optional @var{format} argument
780 will be used rather than detecting the format. Can be used to specifiy
781 @code{format=raw} to avoid interpreting an untrusted format header.
783 @item host:@var{bus}.@var{addr}
784 Pass through the host device identified by @var{bus}.@var{addr} (Linux only).
786 @item host:@var{vendor_id}:@var{product_id}
787 Pass through the host device identified by @var{vendor_id}:@var{product_id}
790 @item serial:[vendorid=@var{vendor_id}][,productid=@var{product_id}]:@var{dev}
791 Serial converter to host character device @var{dev}, see @code{-serial} for the
795 Braille device. This will use BrlAPI to display the braille output on a real
798 @item net:@var{options}
799 Network adapter that supports CDC ethernet and RNDIS protocols.
809 DEFHEADING(Display options:)
814 DEF("display", HAS_ARG, QEMU_OPTION_display,
815 "-display sdl[,frame=on|off][,alt_grab=on|off][,ctrl_grab=on|off]\n"
816 " [,window_close=on|off]|curses|none|\n"
817 " gtk[,grab_on_hover=on|off]|\n"
818 " vnc=<display>[,<optargs>]\n"
819 " select display type\n", QEMU_ARCH_ALL)
821 @item -display @var{type}
823 Select type of display to use. This option is a replacement for the
824 old style -sdl/-curses/... options. Valid values for @var{type} are
827 Display video output via SDL (usually in a separate graphics
828 window; see the SDL documentation for other possibilities).
830 Display video output via curses. For graphics device models which
831 support a text mode, QEMU can display this output using a
832 curses/ncurses interface. Nothing is displayed when the graphics
833 device is in graphical mode or if the graphics device does not support
834 a text mode. Generally only the VGA device models support text mode.
836 Do not display video output. The guest will still see an emulated
837 graphics card, but its output will not be displayed to the QEMU
838 user. This option differs from the -nographic option in that it
839 only affects what is done with video output; -nographic also changes
840 the destination of the serial and parallel port data.
842 Display video output in a GTK window. This interface provides drop-down
843 menus and other UI elements to configure and control the VM during
846 Start a VNC server on display <arg>
850 DEF("nographic", 0, QEMU_OPTION_nographic,
851 "-nographic disable graphical output and redirect serial I/Os to console\n",
856 Normally, QEMU uses SDL to display the VGA output. With this option,
857 you can totally disable graphical output so that QEMU is a simple
858 command line application. The emulated serial port is redirected on
859 the console and muxed with the monitor (unless redirected elsewhere
860 explicitly). Therefore, you can still use QEMU to debug a Linux kernel
861 with a serial console. Use @key{C-a h} for help on switching between
862 the console and monitor.
865 DEF("curses", 0, QEMU_OPTION_curses,
866 "-curses use a curses/ncurses interface instead of SDL\n",
871 Normally, QEMU uses SDL to display the VGA output. With this option,
872 QEMU can display the VGA output when in text mode using a
873 curses/ncurses interface. Nothing is displayed in graphical mode.
876 DEF("no-frame", 0, QEMU_OPTION_no_frame,
877 "-no-frame open SDL window without a frame and window decorations\n",
882 Do not use decorations for SDL windows and start them using the whole
883 available screen space. This makes the using QEMU in a dedicated desktop
884 workspace more convenient.
887 DEF("alt-grab", 0, QEMU_OPTION_alt_grab,
888 "-alt-grab use Ctrl-Alt-Shift to grab mouse (instead of Ctrl-Alt)\n",
893 Use Ctrl-Alt-Shift to grab mouse (instead of Ctrl-Alt). Note that this also
894 affects the special keys (for fullscreen, monitor-mode switching, etc).
897 DEF("ctrl-grab", 0, QEMU_OPTION_ctrl_grab,
898 "-ctrl-grab use Right-Ctrl to grab mouse (instead of Ctrl-Alt)\n",
903 Use Right-Ctrl to grab mouse (instead of Ctrl-Alt). Note that this also
904 affects the special keys (for fullscreen, monitor-mode switching, etc).
907 DEF("no-quit", 0, QEMU_OPTION_no_quit,
908 "-no-quit disable SDL window close capability\n", QEMU_ARCH_ALL)
912 Disable SDL window close capability.
915 DEF("sdl", 0, QEMU_OPTION_sdl,
916 "-sdl enable SDL\n", QEMU_ARCH_ALL)
923 DEF("spice", HAS_ARG, QEMU_OPTION_spice,
924 "-spice [port=port][,tls-port=secured-port][,x509-dir=<dir>]\n"
925 " [,x509-key-file=<file>][,x509-key-password=<file>]\n"
926 " [,x509-cert-file=<file>][,x509-cacert-file=<file>]\n"
927 " [,x509-dh-key-file=<file>][,addr=addr][,ipv4|ipv6]\n"
928 " [,tls-ciphers=<list>]\n"
929 " [,tls-channel=[main|display|cursor|inputs|record|playback]]\n"
930 " [,plaintext-channel=[main|display|cursor|inputs|record|playback]]\n"
931 " [,sasl][,password=<secret>][,disable-ticketing]\n"
932 " [,image-compression=[auto_glz|auto_lz|quic|glz|lz|off]]\n"
933 " [,jpeg-wan-compression=[auto|never|always]]\n"
934 " [,zlib-glz-wan-compression=[auto|never|always]]\n"
935 " [,streaming-video=[off|all|filter]][,disable-copy-paste]\n"
936 " [,disable-agent-file-xfer][,agent-mouse=[on|off]]\n"
937 " [,playback-compression=[on|off]][,seamless-migration=[on|off]]\n"
939 " at least one of {port, tls-port} is mandatory\n",
942 @item -spice @var{option}[,@var{option}[,...]]
944 Enable the spice remote desktop protocol. Valid options are
949 Set the TCP port spice is listening on for plaintext channels.
952 Set the IP address spice is listening on. Default is any address.
956 Force using the specified IP version.
958 @item password=<secret>
959 Set the password you need to authenticate.
962 Require that the client use SASL to authenticate with the spice.
963 The exact choice of authentication method used is controlled from the
964 system / user's SASL configuration file
for the
'qemu' service
. This
965 is typically found
in /etc
/sasl2
/qemu
.conf
. If running QEMU as an
966 unprivileged user
, an environment variable SASL_CONF_PATH can be used
967 to make it search alternate locations
for the service config
.
968 While some SASL auth methods can also provide data
encryption (eg GSSAPI
),
969 it is recommended that SASL always be combined with the
'tls' and
970 'x509' settings to enable use of SSL and server certificates
. This
971 ensures a data encryption preventing compromise of authentication
974 @item disable
-ticketing
975 Allow client connects without authentication
.
977 @item disable
-copy
-paste
978 Disable copy paste between the client and the guest
.
980 @item disable
-agent
-file
-xfer
981 Disable spice
-vdagent based file
-xfer between the client and the guest
.
984 Set the TCP port spice is listening on
for encrypted channels
.
987 Set the x509 file directory
. Expects same filenames as
-vnc $display
,x509
=$dir
989 @item x509
-key
-file
=<file
>
990 @item x509
-key
-password
=<file
>
991 @item x509
-cert
-file
=<file
>
992 @item x509
-cacert
-file
=<file
>
993 @item x509
-dh
-key
-file
=<file
>
994 The x509 file names can also be configured individually
.
996 @item tls
-ciphers
=<list
>
997 Specify which ciphers to use
.
999 @item tls
-channel
=[main|display|cursor|inputs|record|playback
]
1000 @item plaintext
-channel
=[main|display|cursor|inputs|record|playback
]
1001 Force specific channel to be used with or without TLS encryption
. The
1002 options can be specified multiple times to configure multiple
1003 channels
. The special name
"default" can be used to set the
default
1004 mode
. For channels which are not explicitly forced into one mode the
1005 spice client is allowed to pick tls
/plaintext as he pleases
.
1007 @item image
-compression
=[auto_glz|auto_lz|quic|glz|lz|off
]
1008 Configure image
compression (lossless
).
1009 Default is auto_glz
.
1011 @item jpeg
-wan
-compression
=[auto|
never|always
]
1012 @item zlib
-glz
-wan
-compression
=[auto|
never|always
]
1013 Configure wan image
compression (lossy
for slow links
).
1016 @item streaming
-video
=[off|all|filter
]
1017 Configure video stream detection
. Default is filter
.
1019 @item agent
-mouse
=[on|off
]
1020 Enable
/disable passing mouse events via vdagent
. Default is on
.
1022 @item playback
-compression
=[on|off
]
1023 Enable
/disable audio stream
compression (using celt
0.5.1). Default is on
.
1025 @item seamless
-migration
=[on|off
]
1026 Enable
/disable spice seamless migration
. Default is off
.
1031 DEF("portrait", 0, QEMU_OPTION_portrait
,
1032 "-portrait rotate graphical output 90 deg left (only PXA LCD)\n",
1037 Rotate graphical output
90 deg
left (only PXA LCD
).
1040 DEF("rotate", HAS_ARG
, QEMU_OPTION_rotate
,
1041 "-rotate <deg> rotate graphical output some deg left (only PXA LCD)\n",
1044 @item
-rotate @
var{deg
}
1046 Rotate graphical output some deg
left (only PXA LCD
).
1049 DEF("vga", HAS_ARG
, QEMU_OPTION_vga
,
1050 "-vga [std|cirrus|vmware|qxl|xenfb|tcx|cg3|none]\n"
1051 " select video card type\n", QEMU_ARCH_ALL
)
1053 @item
-vga @
var{type
}
1055 Select type of VGA card to emulate
. Valid values
for @
var{type
} are
1058 Cirrus Logic GD5446 Video card
. All Windows versions starting from
1059 Windows
95 should recognize and use
this graphic card
. For optimal
1060 performances
, use
16 bit color depth
in the guest and the host OS
.
1061 (This one is the
default)
1063 Standard VGA card with Bochs VBE extensions
. If your guest OS
1064 supports the VESA
2.0 VBE
extensions (e
.g
. Windows XP
) and
if you want
1065 to use high resolution
modes (>= 1280x1024x16
) then you should use
1068 VMWare SVGA
-II compatible adapter
. Use it
if you have sufficiently
1069 recent XFree86
/XOrg server or Windows guest with a driver
for this
1072 QXL paravirtual graphic card
. It is VGA
compatible (including VESA
1073 2.0 VBE support
). Works best with qxl guest drivers installed though
.
1074 Recommended choice when
using the spice protocol
.
1076 (sun4m only
) Sun TCX framebuffer
. This is the
default framebuffer
for
1077 sun4m machines and offers both
8-bit and
24-bit colour depths at a
1078 fixed resolution of
1024x768
.
1080 (sun4m only
) Sun cgthree framebuffer
. This is a simple
8-bit framebuffer
1081 for sun4m machines available
in both
1024x768 (OpenBIOS
) and
1152x900 (OBP
)
1082 resolutions aimed at people wishing to run older Solaris versions
.
1088 DEF("full-screen", 0, QEMU_OPTION_full_screen
,
1089 "-full-screen start in full screen\n", QEMU_ARCH_ALL
)
1092 @findex
-full
-screen
1093 Start
in full screen
.
1096 DEF("g", 1, QEMU_OPTION_g
,
1097 "-g WxH[xDEPTH] Set the initial graphical resolution and depth\n",
1098 QEMU_ARCH_PPC | QEMU_ARCH_SPARC
)
1100 @item
-g @
var{width
}x@
var{height
}[x@
var{depth
}]
1102 Set the initial graphical resolution and
depth (PPC
, SPARC only
).
1105 DEF("vnc", HAS_ARG
, QEMU_OPTION_vnc
,
1106 "-vnc display start a VNC server on display\n", QEMU_ARCH_ALL
)
1108 @item
-vnc @
var{display
}[,@
var{option
}[,@
var{option
}[,...]]]
1110 Normally
, QEMU uses SDL to display the VGA output
. With
this option
,
1111 you can have QEMU listen on VNC display @
var{display
} and redirect the VGA
1112 display over the VNC session
. It is very useful to enable the usb
1113 tablet device when
using this option (option @option
{-usbdevice
1114 tablet
}). When
using the VNC display
, you must use the @option
{-k
}
1115 parameter to set the keyboard layout
if you are not
using en
-us
. Valid
1116 syntax
for the @
var{display
} is
1120 @item @
var{host
}:@
var{d
}
1122 TCP connections will only be allowed from @
var{host
} on display @
var{d
}.
1123 By convention the TCP port is
5900+@
var{d
}. Optionally
, @
var{host
} can
1124 be omitted
in which
case the server will accept connections from any host
.
1126 @item unix
:@
var{path
}
1128 Connections will be allowed over UNIX domain sockets where @
var{path
} is the
1129 location of a unix socket to listen
for connections on
.
1133 VNC is initialized but not started
. The monitor @code
{change
} command
1134 can be used to later start the VNC server
.
1138 Following the @
var{display
} value there may be one or more @
var{option
} flags
1139 separated by commas
. Valid options are
1145 Connect to a listening VNC client via a ``reverse
'' connection
. The
1146 client is specified by the @
var{display
}. For reverse network
1147 connections (@
var{host
}:@
var{d
},@code
{reverse
}), the @
var{d
} argument
1148 is a TCP port number
, not a display number
.
1152 Opens an additional TCP listening port dedicated to VNC Websocket connections
.
1153 By definition the Websocket port is
5700+@
var{display
}. If @
var{host
} is
1154 specified connections will only be allowed from
this host
.
1155 As an alternative the Websocket port could be specified by
using
1156 @code
{websocket
}=@
var{port
}.
1157 TLS encryption
for the Websocket connection is supported
if the required
1158 certificates are specified with the VNC option @option
{x509
}.
1162 Require that password based authentication is used
for client connections
.
1164 The password must be set separately
using the @code
{set_password
} command
in
1165 the @ref
{pcsys_monitor
}. The syntax to change your password is
:
1166 @code
{set_password
<protocol
> <password
>} where
<protocol
> could be either
1169 If you would like to change
<protocol
> password expiration
, you should use
1170 @code
{expire_password
<protocol
> <expiration
-time
>} where expiration time could
1171 be one of the following options
: now
, never, +seconds or UNIX time of
1172 expiration
, e
.g
. +60 to make password expire
in 60 seconds
, or
1335196800
1173 to make password expire on
"Mon Apr 23 12:00:00 EDT 2012" (UNIX time
for this
1176 You can also use keywords
"now" or
"never" for the expiration time to
1177 allow
<protocol
> password to expire immediately or
never expire
.
1181 Require that client use TLS when communicating with the VNC server
. This
1182 uses anonymous TLS credentials so is susceptible to a man
-in-the
-middle
1183 attack
. It is recommended that
this option be combined with either the
1184 @option
{x509
} or @option
{x509verify
} options
.
1186 @item x509
=@
var{/path
/to
/certificate
/dir
}
1188 Valid
if @option
{tls
} is specified
. Require that x509 credentials are used
1189 for negotiating the TLS session
. The server will send its x509 certificate
1190 to the client
. It is recommended that a password be set on the VNC server
1191 to provide authentication of the client when
this is used
. The path following
1192 this option specifies where the x509 certificates are to be loaded from
.
1193 See the @ref
{vnc_security
} section
for details on generating certificates
.
1195 @item x509verify
=@
var{/path
/to
/certificate
/dir
}
1197 Valid
if @option
{tls
} is specified
. Require that x509 credentials are used
1198 for negotiating the TLS session
. The server will send its x509 certificate
1199 to the client
, and request that the client send its own x509 certificate
.
1200 The server will validate the client
's certificate against the CA certificate,
1201 and reject clients when validation fails. If the certificate authority is
1202 trusted, this is a sufficient authentication mechanism. You may still wish
1203 to set a password on the VNC server as a second authentication layer. The
1204 path following this option specifies where the x509 certificates are to
1205 be loaded from. See the @ref{vnc_security} section for details on generating
1210 Require that the client use SASL to authenticate with the VNC server.
1211 The exact choice of authentication method used is controlled from the
1212 system / user's SASL configuration file
for the
'qemu' service
. This
1213 is typically found
in /etc
/sasl2
/qemu
.conf
. If running QEMU as an
1214 unprivileged user
, an environment variable SASL_CONF_PATH can be used
1215 to make it search alternate locations
for the service config
.
1216 While some SASL auth methods can also provide data
encryption (eg GSSAPI
),
1217 it is recommended that SASL always be combined with the
'tls' and
1218 'x509' settings to enable use of SSL and server certificates
. This
1219 ensures a data encryption preventing compromise of authentication
1220 credentials
. See the @ref
{vnc_security
} section
for details on
using
1221 SASL authentication
.
1225 Turn on access control lists
for checking of the x509 client certificate
1226 and SASL party
. For x509 certs
, the ACL check is made against the
1227 certificate
's distinguished name. This is something that looks like
1228 @code{C=GB,O=ACME,L=Boston,CN=bob}. For SASL party, the ACL check is
1229 made against the username, which depending on the SASL plugin, may
1230 include a realm component, eg @code{bob} or @code{bob@@EXAMPLE.COM}.
1231 When the @option{acl} flag is set, the initial access list will be
1232 empty, with a @code{deny} policy. Thus no one will be allowed to
1233 use the VNC server until the ACLs have been loaded. This can be
1234 achieved using the @code{acl} monitor command.
1238 Enable lossy compression methods (gradient, JPEG, ...). If this
1239 option is set, VNC client may receive lossy framebuffer updates
1240 depending on its encoding settings. Enabling this option can save
1241 a lot of bandwidth at the expense of quality.
1245 Disable adaptive encodings. Adaptive encodings are enabled by default.
1246 An adaptive encoding will try to detect frequently updated screen regions,
1247 and send updates in these regions using a lossy encoding (like JPEG).
1248 This can be really helpful to save bandwidth when playing videos. Disabling
1249 adaptive encodings restores the original static behavior of encodings
1252 @item share=[allow-exclusive|force-shared|ignore]
1254 Set display sharing policy. 'allow
-exclusive
' allows clients to ask
1255 for exclusive access. As suggested by the rfb spec this is
1256 implemented by dropping other connections. Connecting multiple
1257 clients in parallel requires all clients asking for a shared session
1258 (vncviewer: -shared switch). This is the default. 'force
-shared
'
1259 disables exclusive client access. Useful for shared desktop sessions,
1260 where you don't want someone forgetting specify
-shared disconnect
1261 everybody
else. 'ignore' completely ignores the shared flag and
1262 allows everybody connect unconditionally
. Doesn
't conform to the rfb
1263 spec but is traditional QEMU behavior.
1271 ARCHHEADING(, QEMU_ARCH_I386)
1273 ARCHHEADING(i386 target only:, QEMU_ARCH_I386)
1278 DEF("win2k-hack", 0, QEMU_OPTION_win2k_hack,
1279 "-win2k-hack use it when installing Windows 2000 to avoid a disk full bug\n",
1284 Use it when installing Windows 2000 to avoid a disk full bug. After
1285 Windows 2000 is installed, you no longer need this option (this option
1286 slows down the IDE transfers).
1289 HXCOMM Deprecated by -rtc
1290 DEF("rtc-td-hack", 0, QEMU_OPTION_rtc_td_hack, "", QEMU_ARCH_I386)
1292 DEF("no-fd-bootchk", 0, QEMU_OPTION_no_fd_bootchk,
1293 "-no-fd-bootchk disable boot signature checking for floppy disks\n",
1296 @item -no-fd-bootchk
1297 @findex -no-fd-bootchk
1298 Disable boot signature checking for floppy disks in BIOS. May
1299 be needed to boot from old floppy disks.
1302 DEF("no-acpi", 0, QEMU_OPTION_no_acpi,
1303 "-no-acpi disable ACPI\n", QEMU_ARCH_I386)
1307 Disable ACPI (Advanced Configuration and Power Interface) support. Use
1308 it if your guest OS complains about ACPI problems (PC target machine
1312 DEF("no-hpet", 0, QEMU_OPTION_no_hpet,
1313 "-no-hpet disable HPET\n", QEMU_ARCH_I386)
1317 Disable HPET support.
1320 DEF("acpitable", HAS_ARG, QEMU_OPTION_acpitable,
1321 "-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"
1322 " ACPI table description\n", QEMU_ARCH_I386)
1324 @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}]...]
1326 Add ACPI table with specified header fields and context from specified files.
1327 For file=, take whole ACPI table from the specified files, including all
1328 ACPI headers (possible overridden by other options).
1329 For data=, only data
1330 portion of the table is used, all header information is specified in the
1334 DEF("smbios", HAS_ARG, QEMU_OPTION_smbios,
1335 "-smbios file=binary\n"
1336 " load SMBIOS entry from binary file\n"
1337 "-smbios type=0[,vendor=str][,version=str][,date=str][,release=%d.%d]\n"
1338 " specify SMBIOS type 0 fields\n"
1339 "-smbios type=1[,manufacturer=str][,product=str][,version=str][,serial=str]\n"
1340 " [,uuid=uuid][,sku=str][,family=str]\n"
1341 " specify SMBIOS type 1 fields\n", QEMU_ARCH_I386)
1343 @item -smbios file=@var{binary}
1345 Load SMBIOS entry from binary file.
1347 @item -smbios type=0[,vendor=@var{str}][,version=@var{str}][,date=@var{str}][,release=@var{%d.%d}]
1348 Specify SMBIOS type 0 fields
1350 @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}]
1351 Specify SMBIOS type 1 fields
1359 DEFHEADING(Network options:)
1364 HXCOMM Legacy slirp options (now moved to -net user):
1366 DEF("tftp", HAS_ARG, QEMU_OPTION_tftp, "", QEMU_ARCH_ALL)
1367 DEF("bootp", HAS_ARG, QEMU_OPTION_bootp, "", QEMU_ARCH_ALL)
1368 DEF("redir", HAS_ARG, QEMU_OPTION_redir, "", QEMU_ARCH_ALL)
1370 DEF("smb", HAS_ARG, QEMU_OPTION_smb, "", QEMU_ARCH_ALL)
1374 DEF("net", HAS_ARG, QEMU_OPTION_net,
1375 "-net nic[,vlan=n][,macaddr=mac][,model=type][,name=str][,addr=str][,vectors=v]\n"
1376 " create a new Network Interface Card and connect it to VLAN 'n
'\n"
1378 "-net user[,vlan=n][,name=str][,net=addr[/mask]][,host=addr][,restrict=on|off]\n"
1379 " [,hostname=host][,dhcpstart=addr][,dns=addr][,dnssearch=domain][,tftp=dir]\n"
1380 " [,bootfile=f][,hostfwd=rule][,guestfwd=rule]"
1382 "[,smb=dir[,smbserver=addr]]\n"
1384 " connect the user mode network stack to VLAN 'n
', configure its\n"
1385 " DHCP server and enabled optional services\n"
1388 "-net tap[,vlan=n][,name=str],ifname=name\n"
1389 " connect the host TAP network interface to VLAN 'n
'\n"
1391 "-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"
1392 " connect the host TAP network interface to VLAN 'n
'\n"
1393 " use network scripts 'file
' (default=" DEFAULT_NETWORK_SCRIPT ")\n"
1394 " to configure it and 'dfile
' (default=" DEFAULT_NETWORK_DOWN_SCRIPT ")\n"
1395 " to deconfigure it\n"
1396 " use '[down
]script
=no
' to disable script execution\n"
1397 " use network helper 'helper
' (default=" DEFAULT_BRIDGE_HELPER ") to\n"
1399 " use 'fd
=h
' to connect to an already opened TAP interface\n"
1400 " use 'fds
=x
:y
:...:z
' to connect to already opened multiqueue capable TAP interfaces\n"
1401 " use 'sndbuf
=nbytes
' to limit the size of the send buffer (the\n"
1402 " default is disabled 'sndbuf
=0' to enable flow control set 'sndbuf
=1048576')\n"
1403 " use vnet_hdr=off to avoid enabling the IFF_VNET_HDR tap flag\n"
1404 " use vnet_hdr=on to make the lack of IFF_VNET_HDR support an error condition\n"
1405 " use vhost=on to enable experimental in kernel accelerator\n"
1406 " (only has effect for virtio guests which use MSIX)\n"
1407 " use vhostforce=on to force vhost on for non-MSIX virtio guests\n"
1408 " use 'vhostfd
=h
' to connect to an already opened vhost net device\n"
1409 " use 'vhostfds
=x
:y
:...:z to connect to multiple already opened vhost net devices
\n"
1410 " use
'queues=n' to specify the number of queues to be created
for multiqueue TAP
\n"
1411 "-net bridge
[,vlan
=n
][,name
=str
][,br
=bridge
][,helper
=helper
]\n"
1412 " connects a host TAP network
interface to a host bridge device
'br'\n"
1413 " (default=" DEFAULT_BRIDGE_INTERFACE ") using the program
'helper'\n"
1414 " (default=" DEFAULT_BRIDGE_HELPER ")\n"
1416 "-net socket
[,vlan
=n
][,name
=str
][,fd
=h
][,listen
=[host
]:port
][,connect
=host
:port
]\n"
1417 " connect the vlan
'n' to another VLAN
using a socket connection
\n"
1418 "-net socket
[,vlan
=n
][,name
=str
][,fd
=h
][,mcast
=maddr
:port
[,localaddr
=addr
]]\n"
1419 " connect the vlan
'n' to multicast maddr and port
\n"
1420 " use
'localaddr=addr' to specify the host address to send packets from
\n"
1421 "-net socket
[,vlan
=n
][,name
=str
][,fd
=h
][,udp
=host
:port
][,localaddr
=host
:port
]\n"
1422 " connect the vlan
'n' to another VLAN
using an UDP tunnel
\n"
1424 "-net vde
[,vlan
=n
][,name
=str
][,sock
=socketpath
][,port
=n
][,group
=groupname
][,mode
=octalmode
]\n"
1425 " connect the vlan
'n' to port
'n' of a vde
switch running
\n"
1426 " on host and listening
for incoming connections on
'socketpath'.\n"
1427 " Use group
'groupname' and mode
'octalmode' to change
default\n"
1428 " ownership and permissions
for communication port
.\n"
1430 #ifdef CONFIG_NETMAP
1431 "-net netmap
,ifname
=name
[,devname
=nmname
]\n"
1432 " attach to the existing netmap
-enabled network
interface 'name', or to a
\n"
1433 " VALE
port (created on the fly
) called
'name' ('nmname' is name of the
\n"
1434 " netmap device
, defaults to
'/dev/netmap')\n"
1436 "-net dump
[,vlan
=n
][,file
=f
][,len
=n
]\n"
1437 " dump traffic on vlan
'n' to file
'f' (max n bytes per packet
)\n"
1438 "-net none use it alone to have zero network devices
. If no
-net option
\n"
1439 " is provided
, the
default is
'-net nic -net user'\n", QEMU_ARCH_ALL)
1440 DEF("netdev
", HAS_ARG, QEMU_OPTION_netdev,
1450 #ifdef CONFIG_NETMAP
1454 "hubport
],id
=str
[,option
][,option
][,...]\n", QEMU_ARCH_ALL)
1456 @item -net nic[,vlan=@var{n}][,macaddr=@var{mac}][,model=@var{type}] [,name=@var{name}][,addr=@var{addr}][,vectors=@var{v}]
1458 Create a new Network Interface Card and connect it to VLAN @var{n} (@var{n}
1459 = 0 is the default). The NIC is an e1000 by default on the PC
1460 target. Optionally, the MAC address can be changed to @var{mac}, the
1461 device address set to @var{addr} (PCI cards only),
1462 and a @var{name} can be assigned for use in monitor commands.
1463 Optionally, for PCI cards, you can specify the number @var{v} of MSI-X vectors
1464 that the card should have; this option currently only affects virtio cards; set
1465 @var{v} = 0 to disable MSI-X. If no @option{-net} option is specified, a single
1466 NIC is created. QEMU can emulate several different models of network card.
1467 Valid values for @var{type} are
1468 @code{virtio}, @code{i82551}, @code{i82557b}, @code{i82559er},
1469 @code{ne2k_pci}, @code{ne2k_isa}, @code{pcnet}, @code{rtl8139},
1470 @code{e1000}, @code{smc91c111}, @code{lance} and @code{mcf_fec}.
1471 Not all devices are supported on all targets. Use @code{-net nic,model=help}
1472 for a list of available devices for your target.
1474 @item -netdev user,id=@var{id}[,@var{option}][,@var{option}][,...]
1476 @item -net user[,@var{option}][,@var{option}][,...]
1477 Use the user mode network stack which requires no administrator
1478 privilege to run. Valid options are:
1482 Connect user mode stack to VLAN @var{n} (@var{n} = 0 is the default).
1485 @item name=@var{name}
1486 Assign symbolic name for use in monitor commands.
1488 @item net=@var{addr}[/@var{mask}]
1489 Set IP network address the guest will see. Optionally specify the netmask,
1490 either in the form a.b.c.d or as number of valid top-most bits. Default is
1493 @item host=@var{addr}
1494 Specify the guest-visible address of the host. Default is the 2nd IP in the
1495 guest network, i.e. x.x.x.2.
1497 @item restrict=on|off
1498 If this option is enabled, the guest will be isolated, i.e. it will not be
1499 able to contact the host and no guest IP packets will be routed over the host
1500 to the outside. This option does not affect any explicitly set forwarding rules.
1502 @item hostname=@var{name}
1503 Specifies the client hostname reported by the built-in DHCP server.
1505 @item dhcpstart=@var{addr}
1506 Specify the first of the 16 IPs the built-in DHCP server can assign. Default
1507 is the 15th to 31st IP in the guest network, i.e. x.x.x.15 to x.x.x.31.
1509 @item dns=@var{addr}
1510 Specify the guest-visible address of the virtual nameserver. The address must
1511 be different from the host address. Default is the 3rd IP in the guest network,
1514 @item dnssearch=@var{domain}
1515 Provides an entry for the domain-search list sent by the built-in
1516 DHCP server. More than one domain suffix can be transmitted by specifying
1517 this option multiple times. If supported, this will cause the guest to
1518 automatically try to append the given domain suffix(es) in case a domain name
1519 can not be resolved.
1523 qemu -net user,dnssearch=mgmt.example.org,dnssearch=example.org [...]
1526 @item tftp=@var{dir}
1527 When using the user mode network stack, activate a built-in TFTP
1528 server. The files in @var{dir} will be exposed as the root of a TFTP server.
1529 The TFTP client on the guest must be configured in binary mode (use the command
1530 @code{bin} of the Unix TFTP client).
1532 @item bootfile=@var{file}
1533 When using the user mode network stack, broadcast @var{file} as the BOOTP
1534 filename. In conjunction with @option{tftp}, this can be used to network boot
1535 a guest from a local directory.
1537 Example (using pxelinux):
1539 qemu-system-i386 -hda linux.img -boot n -net user,tftp=/path/to/tftp/files,bootfile=/pxelinux.0
1542 @item smb=@var{dir}[,smbserver=@var{addr}]
1543 When using the user mode network stack, activate a built-in SMB
1544 server so that Windows OSes can access to the host files in @file{@var{dir}}
1545 transparently. The IP address of the SMB server can be set to @var{addr}. By
1546 default the 4th IP in the guest network is used, i.e. x.x.x.4.
1548 In the guest Windows OS, the line:
1552 must be added in the file @file{C:\WINDOWS\LMHOSTS} (for windows 9x/Me)
1553 or @file{C:\WINNT\SYSTEM32\DRIVERS\ETC\LMHOSTS} (Windows NT/2000).
1555 Then @file{@var{dir}} can be accessed in @file{\\smbserver\qemu}.
1557 Note that a SAMBA server must be installed on the host OS.
1558 QEMU was tested successfully with smbd versions from Red Hat 9,
1559 Fedora Core 3 and OpenSUSE 11.x.
1561 @item hostfwd=[tcp|udp]:[@var{hostaddr}]:@var{hostport}-[@var{guestaddr}]:@var{guestport}
1562 Redirect incoming TCP or UDP connections to the host port @var{hostport} to
1563 the guest IP address @var{guestaddr} on guest port @var{guestport}. If
1564 @var{guestaddr} is not specified, its value is x.x.x.15 (default first address
1565 given by the built-in DHCP server). By specifying @var{hostaddr}, the rule can
1566 be bound to a specific host interface. If no connection type is set, TCP is
1567 used. This option can be given multiple times.
1569 For example, to redirect host X11 connection from screen 1 to guest
1570 screen 0, use the following:
1574 qemu-system-i386 -net user,hostfwd=tcp:127.0.0.1:6001-:6000 [...]
1575 # this host xterm should open in the guest X11 server
1579 To redirect telnet connections from host port 5555 to telnet port on
1580 the guest, use the following:
1584 qemu-system-i386 -net user,hostfwd=tcp::5555-:23 [...]
1585 telnet localhost 5555
1588 Then when you use on the host @code{telnet localhost 5555}, you
1589 connect to the guest telnet server.
1591 @item guestfwd=[tcp]:@var{server}:@var{port}-@var{dev}
1592 @item guestfwd=[tcp]:@var{server}:@var{port}-@var{cmd:command}
1593 Forward guest TCP connections to the IP address @var{server} on port @var{port}
1594 to the character device @var{dev} or to a program executed by @var{cmd:command}
1595 which gets spawned for each connection. This option can be given multiple times.
1597 You can either use a chardev directly and have that one used throughout QEMU's
1598 lifetime, like in the following example:
1601 # open 10.10.1.1:4321 on bootup, connect 10.0.2.100:1234 to it whenever
1602 # the guest accesses it
1603 qemu -net user,guestfwd=tcp:10.0.2.100:1234-tcp:10.10.1.1:4321 [...]
1606 Or you can execute a command on every TCP connection established by the guest,
1607 so that QEMU behaves similar to an inetd process for that virtual server:
1610 # call "netcat
10.10.1.1 4321" on every TCP connection to 10.0.2.100:1234
1611 # and connect the TCP stream to its stdin/stdout
1612 qemu -net 'user,guestfwd=tcp:10.0.2.100:1234-cmd:netcat 10.10.1.1 4321'
1617 Note: Legacy stand-alone options -tftp, -bootp, -smb and -redir are still
1618 processed and applied to -net user. Mixing them with the new configuration
1619 syntax gives undefined results. Their use for new applications is discouraged
1620 as they will be removed from future versions.
1622 @item -netdev tap,id=@var{id}[,fd=@var{h}][,ifname=@var{name}][,script=@var{file}][,downscript=@var{dfile}][,helper=@var{helper}]
1623 @item -net tap[,vlan=@var{n}][,name=@var{name}][,fd=@var{h}][,ifname=@var{name}][,script=@var{file}][,downscript=@var{dfile}][,helper=@var{helper}]
1624 Connect the host TAP network interface @var{name} to VLAN @var{n}.
1626 Use the network script @var{file} to configure it and the network script
1627 @var{dfile} to deconfigure it. If @var{name} is not provided, the OS
1628 automatically provides one. The default network configure script is
1629 @file{/etc/qemu-ifup} and the default network deconfigure script is
1630 @file{/etc/qemu-ifdown}. Use @option{script=no} or @option{downscript=no}
1631 to disable script execution.
1633 If running QEMU as an unprivileged user, use the network helper
1634 @var{helper} to configure the TAP interface. The default network
1635 helper executable is @file{/path/to/qemu-bridge-helper}.
1637 @option{fd}=@var{h} can be used to specify the handle of an already
1638 opened host TAP interface.
1643 #launch a QEMU instance with the default network script
1644 qemu-system-i386 linux.img -net nic -net tap
1648 #launch a QEMU instance with two NICs, each one connected
1650 qemu-system-i386 linux.img \
1651 -net nic,vlan=0 -net tap,vlan=0,ifname=tap0 \
1652 -net nic,vlan=1 -net tap,vlan=1,ifname=tap1
1656 #launch a QEMU instance with the default network helper to
1657 #connect a TAP device to bridge br0
1658 qemu-system-i386 linux.img \
1659 -net nic -net tap,"helper
=/path
/to
/qemu
-bridge
-helper
"
1662 @item -netdev bridge,id=@var{id}[,br=@var{bridge}][,helper=@var{helper}]
1663 @item -net bridge[,vlan=@var{n}][,name=@var{name}][,br=@var{bridge}][,helper=@var{helper}]
1664 Connect a host TAP network interface to a host bridge device.
1666 Use the network helper @var{helper} to configure the TAP interface and
1667 attach it to the bridge. The default network helper executable is
1668 @file{/path/to/qemu-bridge-helper} and the default bridge
1669 device is @file{br0}.
1674 #launch a QEMU instance with the default network helper to
1675 #connect a TAP device to bridge br0
1676 qemu-system-i386 linux.img -net bridge -net nic,model=virtio
1680 #launch a QEMU instance with the default network helper to
1681 #connect a TAP device to bridge qemubr0
1682 qemu-system-i386 linux.img -net bridge,br=qemubr0 -net nic,model=virtio
1685 @item -netdev socket,id=@var{id}[,fd=@var{h}][,listen=[@var{host}]:@var{port}][,connect=@var{host}:@var{port}]
1686 @item -net socket[,vlan=@var{n}][,name=@var{name}][,fd=@var{h}] [,listen=[@var{host}]:@var{port}][,connect=@var{host}:@var{port}]
1688 Connect the VLAN @var{n} to a remote VLAN in another QEMU virtual
1689 machine using a TCP socket connection. If @option{listen} is
1690 specified, QEMU waits for incoming connections on @var{port}
1691 (@var{host} is optional). @option{connect} is used to connect to
1692 another QEMU instance using the @option{listen} option. @option{fd}=@var{h}
1693 specifies an already opened TCP socket.
1697 # launch a first QEMU instance
1698 qemu-system-i386 linux.img \
1699 -net nic,macaddr=52:54:00:12:34:56 \
1700 -net socket,listen=:1234
1701 # connect the VLAN 0 of this instance to the VLAN 0
1702 # of the first instance
1703 qemu-system-i386 linux.img \
1704 -net nic,macaddr=52:54:00:12:34:57 \
1705 -net socket,connect=127.0.0.1:1234
1708 @item -netdev socket,id=@var{id}[,fd=@var{h}][,mcast=@var{maddr}:@var{port}[,localaddr=@var{addr}]]
1709 @item -net socket[,vlan=@var{n}][,name=@var{name}][,fd=@var{h}][,mcast=@var{maddr}:@var{port}[,localaddr=@var{addr}]]
1711 Create a VLAN @var{n} shared with another QEMU virtual
1712 machines using a UDP multicast socket, effectively making a bus for
1713 every QEMU with same multicast address @var{maddr} and @var{port}.
1717 Several QEMU can be running on different hosts and share same bus (assuming
1718 correct multicast setup for these hosts).
1720 mcast support is compatible with User Mode Linux (argument @option{eth@var{N}=mcast}), see
1721 @url{http://user-mode-linux.sf.net}.
1723 Use @option{fd=h} to specify an already opened UDP multicast socket.
1728 # launch one QEMU instance
1729 qemu-system-i386 linux.img \
1730 -net nic,macaddr=52:54:00:12:34:56 \
1731 -net socket,mcast=230.0.0.1:1234
1732 # launch another QEMU instance on same "bus
"
1733 qemu-system-i386 linux.img \
1734 -net nic,macaddr=52:54:00:12:34:57 \
1735 -net socket,mcast=230.0.0.1:1234
1736 # launch yet another QEMU instance on same "bus
"
1737 qemu-system-i386 linux.img \
1738 -net nic,macaddr=52:54:00:12:34:58 \
1739 -net socket,mcast=230.0.0.1:1234
1742 Example (User Mode Linux compat.):
1744 # launch QEMU instance (note mcast address selected
1746 qemu-system-i386 linux.img \
1747 -net nic,macaddr=52:54:00:12:34:56 \
1748 -net socket,mcast=239.192.168.1:1102
1750 /path/to/linux ubd0=/path/to/root_fs eth0=mcast
1753 Example (send packets from host's 1.2.3.4):
1755 qemu-system-i386 linux.img \
1756 -net nic,macaddr=52:54:00:12:34:56 \
1757 -net socket,mcast=239.192.168.1:1102,localaddr=1.2.3.4
1760 @item -netdev vde,id=@var{id}[,sock=@var{socketpath}][,port=@var{n}][,group=@var{groupname}][,mode=@var{octalmode}]
1761 @item -net vde[,vlan=@var{n}][,name=@var{name}][,sock=@var{socketpath}] [,port=@var{n}][,group=@var{groupname}][,mode=@var{octalmode}]
1762 Connect VLAN @var{n} to PORT @var{n} of a vde switch running on host and
1763 listening for incoming connections on @var{socketpath}. Use GROUP @var{groupname}
1764 and MODE @var{octalmode} to change default ownership and permissions for
1765 communication port. This option is only available if QEMU has been compiled
1766 with vde support enabled.
1771 vde_switch -F -sock /tmp/myswitch
1772 # launch QEMU instance
1773 qemu-system-i386 linux.img -net nic -net vde,sock=/tmp/myswitch
1776 @item -netdev hubport,id=@var{id},hubid=@var{hubid}
1778 Create a hub port on QEMU "vlan
" @var{hubid}.
1780 The hubport netdev lets you connect a NIC to a QEMU "vlan
" instead of a single
1781 netdev. @code{-net} and @code{-device} with parameter @option{vlan} create the
1782 required hub automatically.
1784 @item -net dump[,vlan=@var{n}][,file=@var{file}][,len=@var{len}]
1785 Dump network traffic on VLAN @var{n} to file @var{file} (@file{qemu-vlan0.pcap} by default).
1786 At most @var{len} bytes (64k by default) per packet are stored. The file format is
1787 libpcap, so it can be analyzed with tools such as tcpdump or Wireshark.
1790 Indicate that no network devices should be configured. It is used to
1791 override the default configuration (@option{-net nic -net user}) which
1792 is activated if no @option{-net} options are provided.
1800 DEFHEADING(Character device options:)
1803 The general form of a character device option is:
1807 DEF("chardev
", HAS_ARG, QEMU_OPTION_chardev,
1808 "-chardev
null,id
=id
[,mux
=on|off
]\n"
1809 "-chardev socket
,id
=id
[,host
=host
],port
=host
[,to
=to
][,ipv4
][,ipv6
][,nodelay
]\n"
1810 " [,server
][,nowait
][,telnet
][,mux
=on|off
] (tcp
)\n"
1811 "-chardev socket
,id
=id
,path
=path
[,server
][,nowait
][,telnet
],[mux
=on|off
] (unix
)\n"
1812 "-chardev udp
,id
=id
[,host
=host
],port
=port
[,localaddr
=localaddr
]\n"
1813 " [,localport
=localport
][,ipv4
][,ipv6
][,mux
=on|off
]\n"
1814 "-chardev msmouse
,id
=id
[,mux
=on|off
]\n"
1815 "-chardev vc
,id
=id
[[,width
=width
][,height
=height
]][[,cols
=cols
][,rows
=rows
]]\n"
1817 "-chardev ringbuf
,id
=id
[,size
=size
]\n"
1818 "-chardev file
,id
=id
,path
=path
[,mux
=on|off
]\n"
1819 "-chardev pipe
,id
=id
,path
=path
[,mux
=on|off
]\n"
1821 "-chardev console
,id
=id
[,mux
=on|off
]\n"
1822 "-chardev serial
,id
=id
,path
=path
[,mux
=on|off
]\n"
1824 "-chardev pty
,id
=id
[,mux
=on|off
]\n"
1825 "-chardev stdio
,id
=id
[,mux
=on|off
][,signal
=on|off
]\n"
1827 #ifdef CONFIG_BRLAPI
1828 "-chardev braille
,id
=id
[,mux
=on|off
]\n"
1830 #if defined(__linux__) || defined(__sun__) || defined(__FreeBSD__) \
1831 || defined(__NetBSD__) || defined(__OpenBSD__) || defined(__DragonFly__)
1832 "-chardev serial
,id
=id
,path
=path
[,mux
=on|off
]\n"
1833 "-chardev tty
,id
=id
,path
=path
[,mux
=on|off
]\n"
1835 #if defined(__linux__) || defined(__FreeBSD__) || defined(__DragonFly__)
1836 "-chardev parallel
,id
=id
,path
=path
[,mux
=on|off
]\n"
1837 "-chardev parport
,id
=id
,path
=path
[,mux
=on|off
]\n"
1839 #if defined(CONFIG_SPICE)
1840 "-chardev spicevmc
,id
=id
,name
=name
[,debug
=debug
]\n"
1841 "-chardev spiceport
,id
=id
,name
=name
[,debug
=debug
]\n"
1847 @item -chardev @var{backend} ,id=@var{id} [,mux=on|off] [,@var{options}]
1868 The specific backend will determine the applicable options.
1870 All devices must have an id, which can be any string up to 127 characters long.
1871 It is used to uniquely identify this device in other command line directives.
1873 A character device may be used in multiplexing mode by multiple front-ends.
1874 The key sequence of @key{Control-a} and @key{c} will rotate the input focus
1875 between attached front-ends. Specify @option{mux=on} to enable this mode.
1877 Options to each backend are described below.
1879 @item -chardev null ,id=@var{id}
1880 A void device. This device will not emit any data, and will drop any data it
1881 receives. The null backend does not take any options.
1883 @item -chardev socket ,id=@var{id} [@var{TCP options} or @var{unix options}] [,server] [,nowait] [,telnet]
1885 Create a two-way stream socket, which can be either a TCP or a unix socket. A
1886 unix socket will be created if @option{path} is specified. Behaviour is
1887 undefined if TCP options are specified for a unix socket.
1889 @option{server} specifies that the socket shall be a listening socket.
1891 @option{nowait} specifies that QEMU should not block waiting for a client to
1892 connect to a listening socket.
1894 @option{telnet} specifies that traffic on the socket should interpret telnet
1897 TCP and unix socket options are given below:
1901 @item TCP options: port=@var{port} [,host=@var{host}] [,to=@var{to}] [,ipv4] [,ipv6] [,nodelay]
1903 @option{host} for a listening socket specifies the local address to be bound.
1904 For a connecting socket species the remote host to connect to. @option{host} is
1905 optional for listening sockets. If not specified it defaults to @code{0.0.0.0}.
1907 @option{port} for a listening socket specifies the local port to be bound. For a
1908 connecting socket specifies the port on the remote host to connect to.
1909 @option{port} can be given as either a port number or a service name.
1910 @option{port} is required.
1912 @option{to} is only relevant to listening sockets. If it is specified, and
1913 @option{port} cannot be bound, QEMU will attempt to bind to subsequent ports up
1914 to and including @option{to} until it succeeds. @option{to} must be specified
1917 @option{ipv4} and @option{ipv6} specify that either IPv4 or IPv6 must be used.
1918 If neither is specified the socket may use either protocol.
1920 @option{nodelay} disables the Nagle algorithm.
1922 @item unix options: path=@var{path}
1924 @option{path} specifies the local path of the unix socket. @option{path} is
1929 @item -chardev udp ,id=@var{id} [,host=@var{host}] ,port=@var{port} [,localaddr=@var{localaddr}] [,localport=@var{localport}] [,ipv4] [,ipv6]
1931 Sends all traffic from the guest to a remote host over UDP.
1933 @option{host} specifies the remote host to connect to. If not specified it
1934 defaults to @code{localhost}.
1936 @option{port} specifies the port on the remote host to connect to. @option{port}
1939 @option{localaddr} specifies the local address to bind to. If not specified it
1940 defaults to @code{0.0.0.0}.
1942 @option{localport} specifies the local port to bind to. If not specified any
1943 available local port will be used.
1945 @option{ipv4} and @option{ipv6} specify that either IPv4 or IPv6 must be used.
1946 If neither is specified the device may use either protocol.
1948 @item -chardev msmouse ,id=@var{id}
1950 Forward QEMU's emulated msmouse events to the guest. @option{msmouse} does not
1953 @item -chardev vc ,id=@var{id} [[,width=@var{width}] [,height=@var{height}]] [[,cols=@var{cols}] [,rows=@var{rows}]]
1955 Connect to a QEMU text console. @option{vc} may optionally be given a specific
1958 @option{width} and @option{height} specify the width and height respectively of
1959 the console, in pixels.
1961 @option{cols} and @option{rows} specify that the console be sized to fit a text
1962 console with the given dimensions.
1964 @item -chardev ringbuf ,id=@var{id} [,size=@var{size}]
1966 Create a ring buffer with fixed size @option{size}.
1967 @var{size} must be a power of two, and defaults to @code{64K}).
1969 @item -chardev file ,id=@var{id} ,path=@var{path}
1971 Log all traffic received from the guest to a file.
1973 @option{path} specifies the path of the file to be opened. This file will be
1974 created if it does not already exist, and overwritten if it does. @option{path}
1977 @item -chardev pipe ,id=@var{id} ,path=@var{path}
1979 Create a two-way connection to the guest. The behaviour differs slightly between
1980 Windows hosts and other hosts:
1982 On Windows, a single duplex pipe will be created at
1983 @file{\\.pipe\@option{path}}.
1985 On other hosts, 2 pipes will be created called @file{@option{path}.in} and
1986 @file{@option{path}.out}. Data written to @file{@option{path}.in} will be
1987 received by the guest. Data written by the guest can be read from
1988 @file{@option{path}.out}. QEMU will not create these fifos, and requires them to
1991 @option{path} forms part of the pipe path as described above. @option{path} is
1994 @item -chardev console ,id=@var{id}
1996 Send traffic from the guest to QEMU's standard output. @option{console} does not
1999 @option{console} is only available on Windows hosts.
2001 @item -chardev serial ,id=@var{id} ,path=@option{path}
2003 Send traffic from the guest to a serial device on the host.
2005 On Unix hosts serial will actually accept any tty device,
2006 not only serial lines.
2008 @option{path} specifies the name of the serial device to open.
2010 @item -chardev pty ,id=@var{id}
2012 Create a new pseudo-terminal on the host and connect to it. @option{pty} does
2013 not take any options.
2015 @option{pty} is not available on Windows hosts.
2017 @item -chardev stdio ,id=@var{id} [,signal=on|off]
2018 Connect to standard input and standard output of the QEMU process.
2020 @option{signal} controls if signals are enabled on the terminal, that includes
2021 exiting QEMU with the key sequence @key{Control-c}. This option is enabled by
2022 default, use @option{signal=off} to disable it.
2024 @option{stdio} is not available on Windows hosts.
2026 @item -chardev braille ,id=@var{id}
2028 Connect to a local BrlAPI server. @option{braille} does not take any options.
2030 @item -chardev tty ,id=@var{id} ,path=@var{path}
2032 @option{tty} is only available on Linux, Sun, FreeBSD, NetBSD, OpenBSD and
2033 DragonFlyBSD hosts. It is an alias for @option{serial}.
2035 @option{path} specifies the path to the tty. @option{path} is required.
2037 @item -chardev parallel ,id=@var{id} ,path=@var{path}
2038 @item -chardev parport ,id=@var{id} ,path=@var{path}
2040 @option{parallel} is only available on Linux, FreeBSD and DragonFlyBSD hosts.
2042 Connect to a local parallel port.
2044 @option{path} specifies the path to the parallel port device. @option{path} is
2047 @item -chardev spicevmc ,id=@var{id} ,debug=@var{debug}, name=@var{name}
2049 @option{spicevmc} is only available when spice support is built in.
2051 @option{debug} debug level for spicevmc
2053 @option{name} name of spice channel to connect to
2055 Connect to a spice virtual machine channel, such as vdiport.
2057 @item -chardev spiceport ,id=@var{id} ,debug=@var{debug}, name=@var{name}
2059 @option{spiceport} is only available when spice support is built in.
2061 @option{debug} debug level for spicevmc
2063 @option{name} name of spice port to connect to
2065 Connect to a spice port, allowing a Spice client to handle the traffic
2066 identified by a name (preferably a fqdn).
2074 DEFHEADING(Device URL Syntax:)
2077 In addition to using normal file images for the emulated storage devices,
2078 QEMU can also use networked resources such as iSCSI devices. These are
2079 specified using a special URL syntax.
2083 iSCSI support allows QEMU to access iSCSI resources directly and use as
2084 images for the guest storage. Both disk and cdrom images are supported.
2086 Syntax for specifying iSCSI LUNs is
2087 ``iscsi://<target-ip>[:<port>]/<target-iqn>/<lun>''
2089 By default qemu will use the iSCSI initiator-name
2090 'iqn.2008-11.org.linux-kvm[:<name>]' but this can also be set from the command
2091 line or a configuration file.
2094 Example (without authentication):
2096 qemu-system-i386 -iscsi initiator-name=iqn.2001-04.com.example:my-initiator \
2097 -cdrom iscsi://192.0.2.1/iqn.2001-04.com.example/2 \
2098 -drive file=iscsi://192.0.2.1/iqn.2001-04.com.example/1
2101 Example (CHAP username/password via URL):
2103 qemu-system-i386 -drive file=iscsi://user%password@@192.0.2.1/iqn.2001-04.com.example/1
2106 Example (CHAP username/password via environment variables):
2108 LIBISCSI_CHAP_USERNAME="user
" \
2109 LIBISCSI_CHAP_PASSWORD="password
" \
2110 qemu-system-i386 -drive file=iscsi://192.0.2.1/iqn.2001-04.com.example/1
2113 iSCSI support is an optional feature of QEMU and only available when
2114 compiled and linked against libiscsi.
2116 DEF("iscsi
", HAS_ARG, QEMU_OPTION_iscsi,
2117 "-iscsi
[user
=user
][,password
=password
]\n"
2118 " [,header
-digest
=CRC32C|CR32C
-NONE|NONE
-CRC32C|NONE
\n"
2119 " [,initiator
-name
=initiator
-iqn
][,id
=target
-iqn
]\n"
2120 " iSCSI session parameters
\n", QEMU_ARCH_ALL)
2123 iSCSI parameters such as username and password can also be specified via
2124 a configuration file. See qemu-doc for more information and examples.
2127 QEMU supports NBD (Network Block Devices) both using TCP protocol as well
2128 as Unix Domain Sockets.
2130 Syntax for specifying a NBD device using TCP
2131 ``nbd:<server-ip>:<port>[:exportname=<export>]''
2133 Syntax for specifying a NBD device using Unix Domain Sockets
2134 ``nbd:unix:<domain-socket>[:exportname=<export>]''
2139 qemu-system-i386 --drive file=nbd:192.0.2.1:30000
2142 Example for Unix Domain Sockets
2144 qemu-system-i386 --drive file=nbd:unix:/tmp/nbd-socket
2148 QEMU supports SSH (Secure Shell) access to remote disks.
2152 qemu-system-i386 -drive file=ssh://user@@host/path/to/disk.img
2153 qemu-system-i386 -drive file.driver=ssh,file.user=user,file.host=host,file.port=22,file.path=/path/to/disk.img
2156 Currently authentication must be done using ssh-agent. Other
2157 authentication methods may be supported in future.
2160 Sheepdog is a distributed storage system for QEMU.
2161 QEMU supports using either local sheepdog devices or remote networked
2164 Syntax for specifying a sheepdog device
2166 sheepdog[+tcp|+unix]://[host:port]/vdiname[?socket=path][#snapid|#tag]
2171 qemu-system-i386 --drive file=sheepdog://192.0.2.1:30000/MyVirtualMachine
2174 See also @url{http://http://www.osrg.net/sheepdog/}.
2177 GlusterFS is an user space distributed file system.
2178 QEMU supports the use of GlusterFS volumes for hosting VM disk images using
2179 TCP, Unix Domain Sockets and RDMA transport protocols.
2181 Syntax for specifying a VM disk image on GlusterFS volume is
2183 gluster[+transport]://[server[:port]]/volname/image[?socket=...]
2189 qemu-system-x86_64 --drive file=gluster://192.0.2.1/testvol/a.img
2192 See also @url{http://www.gluster.org}.
2199 DEFHEADING(Bluetooth(R) options:)
2204 DEF("bt
", HAS_ARG, QEMU_OPTION_bt, \
2205 "-bt hci
,null dumb bluetooth HCI
- doesn
't respond to commands\n" \
2206 "-bt hci,host[:id]\n" \
2207 " use host's HCI with the given name
\n" \
2208 "-bt hci
[,vlan
=n
]\n" \
2209 " emulate a standard HCI
in virtual scatternet
'n'\n" \
2210 "-bt vhci
[,vlan
=n
]\n" \
2211 " add host computer to virtual scatternet
'n' using VHCI
\n" \
2212 "-bt device
:dev
[,vlan
=n
]\n" \
2213 " emulate a bluetooth device
'dev' in scatternet
'n'\n",
2218 Defines the function of the corresponding Bluetooth HCI. -bt options
2219 are matched with the HCIs present in the chosen machine type. For
2220 example when emulating a machine with only one HCI built into it, only
2221 the first @code{-bt hci[...]} option is valid and defines the HCI's
2222 logic. The Transport Layer is decided by the machine type. Currently
2223 the machines @code{n800} and @code{n810} have one HCI and all other
2227 The following three types are recognized:
2231 (default) The corresponding Bluetooth HCI assumes no internal logic
2232 and will not respond to any HCI commands or emit events.
2234 @item -bt hci,host[:@var{id}]
2235 (@code{bluez} only) The corresponding HCI passes commands / events
2236 to / from the physical HCI identified by the name @var{id} (default:
2237 @code{hci0}) on the computer running QEMU. Only available on @code{bluez}
2238 capable systems like Linux.
2240 @item -bt hci[,vlan=@var{n}]
2241 Add a virtual, standard HCI that will participate in the Bluetooth
2242 scatternet @var{n} (default @code{0}). Similarly to @option{-net}
2243 VLANs, devices inside a bluetooth network @var{n} can only communicate
2244 with other devices in the same network (scatternet).
2247 @item -bt vhci[,vlan=@var{n}]
2248 (Linux-host only) Create a HCI in scatternet @var{n} (default 0) attached
2249 to the host bluetooth stack instead of to the emulated target. This
2250 allows the host and target machines to participate in a common scatternet
2251 and communicate. Requires the Linux @code{vhci} driver installed. Can
2252 be used as following:
2255 qemu-system-i386 [...OPTIONS...] -bt hci,vlan=5 -bt vhci,vlan=5
2258 @item -bt device:@var{dev}[,vlan=@var{n}]
2259 Emulate a bluetooth device @var{dev} and place it in network @var{n}
2260 (default @code{0}). QEMU can only emulate one type of bluetooth devices
2265 Virtual wireless keyboard implementing the HIDP bluetooth profile.
2275 DEFHEADING(TPM device options:)
2277 DEF("tpmdev
", HAS_ARG, QEMU_OPTION_tpmdev, \
2278 "-tpmdev passthrough
,id
=id
[,path
=path
][,cancel
-path
=path
]\n"
2279 " use path to provide path to a character device
; default is
/dev
/tpm0
\n"
2280 " use cancel
-path to provide path to TPM
's cancel sysfs entry; if\n"
2281 " not provided it will be searched for in /sys/class/misc/tpm?/device\n",
2285 The general form of a TPM device option is:
2288 @item -tpmdev @var{backend} ,id=@var{id} [,@var{options}]
2290 Backend type must be:
2291 @option{passthrough}.
2293 The specific backend type will determine the applicable options.
2294 The @code{-tpmdev} option creates the TPM backend and requires a
2295 @code{-device} option that specifies the TPM frontend interface model.
2297 Options to each backend are described below.
2299 Use 'help
' to print all available TPM backend types.
2304 @item -tpmdev passthrough, id=@var{id}, path=@var{path}, cancel-path=@var{cancel-path}
2306 (Linux-host only) Enable access to the host's TPM
using the passthrough
2309 @option
{path
} specifies the path to the host
's TPM device, i.e., on
2310 a Linux host this would be @code{/dev/tpm0}.
2311 @option{path} is optional and by default @code{/dev/tpm0} is used.
2313 @option{cancel-path} specifies the path to the host TPM device's sysfs
2314 entry allowing
for cancellation of an ongoing TPM command
.
2315 @option
{cancel
-path
} is optional and by
default QEMU will search
for the
2318 Some notes about
using the host
's TPM with the passthrough driver:
2320 The TPM device accessed by the passthrough driver must not be
2321 used by any other application on the host.
2323 Since the host's
firmware (BIOS
/UEFI
) has already initialized the TPM
,
2324 the VM
's firmware (BIOS/UEFI) will not be able to initialize the
2325 TPM again and may therefore not show a TPM-specific menu that would
2326 otherwise allow the user to configure the TPM, e.g., allow the user to
2327 enable/disable or activate/deactivate the TPM.
2328 Further, if TPM ownership is released from within a VM then the host's TPM
2329 will get disabled and deactivated
. To enable and activate the
2330 TPM again afterwards
, the host has to be rebooted and the user is
2331 required to enter the firmware
's menu to enable and activate the TPM.
2332 If the TPM is left disabled and/or deactivated most TPM commands will fail.
2334 To create a passthrough TPM use the following two options:
2336 -tpmdev passthrough,id=tpm0 -device tpm-tis,tpmdev=tpm0
2338 Note that the @code{-tpmdev} id is @code{tpm0} and is referenced by
2339 @code{tpmdev=tpm0} in the device option.
2349 DEFHEADING(Linux/Multiboot boot specific:)
2352 When using these options, you can use a given Linux or Multiboot
2353 kernel without installing it in the disk image. It can be useful
2354 for easier testing of various kernels.
2359 DEF("kernel", HAS_ARG, QEMU_OPTION_kernel, \
2360 "-kernel bzImage use 'bzImage
' as kernel image\n", QEMU_ARCH_ALL)
2362 @item -kernel @var{bzImage}
2364 Use @var{bzImage} as kernel image. The kernel can be either a Linux kernel
2365 or in multiboot format.
2368 DEF("append", HAS_ARG, QEMU_OPTION_append, \
2369 "-append cmdline use 'cmdline
' as kernel command line\n", QEMU_ARCH_ALL)
2371 @item -append @var{cmdline}
2373 Use @var{cmdline} as kernel command line
2376 DEF("initrd", HAS_ARG, QEMU_OPTION_initrd, \
2377 "-initrd file use 'file
' as initial ram disk\n", QEMU_ARCH_ALL)
2379 @item -initrd @var{file}
2381 Use @var{file} as initial ram disk.
2383 @item -initrd "@var{file1} arg=foo,@var{file2}"
2385 This syntax is only available with multiboot.
2387 Use @var{file1} and @var{file2} as modules and pass arg=foo as parameter to the
2391 DEF("dtb", HAS_ARG, QEMU_OPTION_dtb, \
2392 "-dtb file use 'file
' as device tree image\n", QEMU_ARCH_ALL)
2394 @item -dtb @var{file}
2396 Use @var{file} as a device tree binary (dtb) image and pass it to the kernel
2405 DEFHEADING(Debug/Expert options:)
2410 DEF("serial", HAS_ARG, QEMU_OPTION_serial, \
2411 "-serial dev redirect the serial port to char device 'dev
'\n",
2414 @item -serial @var{dev}
2416 Redirect the virtual serial port to host character device
2417 @var{dev}. The default device is @code{vc} in graphical mode and
2418 @code{stdio} in non graphical mode.
2420 This option can be used several times to simulate up to 4 serial
2423 Use @code{-serial none} to disable all serial ports.
2425 Available character devices are:
2427 @item vc[:@var{W}x@var{H}]
2428 Virtual console. Optionally, a width and height can be given in pixel with
2432 It is also possible to specify width or height in characters:
2437 [Linux only] Pseudo TTY (a new PTY is automatically allocated)
2439 No device is allocated.
2442 @item chardev:@var{id}
2443 Use a named character device defined with the @code{-chardev} option.
2445 [Linux only] Use host tty, e.g. @file{/dev/ttyS0}. The host serial port
2446 parameters are set according to the emulated ones.
2447 @item /dev/parport@var{N}
2448 [Linux only, parallel port only] Use host parallel port
2449 @var{N}. Currently SPP and EPP parallel port features can be used.
2450 @item file:@var{filename}
2451 Write output to @var{filename}. No character can be read.
2453 [Unix only] standard input/output
2454 @item pipe:@var{filename}
2455 name pipe @var{filename}
2457 [Windows only] Use host serial port @var{n}
2458 @item udp:[@var{remote_host}]:@var{remote_port}[@@[@var{src_ip}]:@var{src_port}]
2459 This implements UDP Net Console.
2460 When @var{remote_host} or @var{src_ip} are not specified
2461 they default to @code{0.0.0.0}.
2462 When not using a specified @var{src_port} a random port is automatically chosen.
2464 If you just want a simple readonly console you can use @code{netcat} or
2465 @code{nc}, by starting QEMU with: @code{-serial udp::4555} and nc as:
2466 @code{nc -u -l -p 4555}. Any time QEMU writes something to that port it
2467 will appear in the netconsole session.
2469 If you plan to send characters back via netconsole or you want to stop
2470 and start QEMU a lot of times, you should have QEMU use the same
2471 source port each time by using something like @code{-serial
2472 udp::4555@@:4556} to QEMU. Another approach is to use a patched
2473 version of netcat which can listen to a TCP port and send and receive
2474 characters via udp. If you have a patched version of netcat which
2475 activates telnet remote echo and single char transfer, then you can
2476 use the following options to step up a netcat redirector to allow
2477 telnet on port 5555 to access the QEMU port.
2480 -serial udp::4555@@:4556
2481 @item netcat options:
2482 -u -P 4555 -L 0.0.0.0:4556 -t -p 5555 -I -T
2483 @item telnet options:
2487 @item tcp:[@var{host}]:@var{port}[,@var{server}][,nowait][,nodelay]
2488 The TCP Net Console has two modes of operation. It can send the serial
2489 I/O to a location or wait for a connection from a location. By default
2490 the TCP Net Console is sent to @var{host} at the @var{port}. If you use
2491 the @var{server} option QEMU will wait for a client socket application
2492 to connect to the port before continuing, unless the @code{nowait}
2493 option was specified. The @code{nodelay} option disables the Nagle buffering
2494 algorithm. If @var{host} is omitted, 0.0.0.0 is assumed. Only
2495 one TCP connection at a time is accepted. You can use @code{telnet} to
2496 connect to the corresponding character device.
2498 @item Example to send tcp console to 192.168.0.2 port 4444
2499 -serial tcp:192.168.0.2:4444
2500 @item Example to listen and wait on port 4444 for connection
2501 -serial tcp::4444,server
2502 @item Example to not wait and listen on ip 192.168.0.100 port 4444
2503 -serial tcp:192.168.0.100:4444,server,nowait
2506 @item telnet:@var{host}:@var{port}[,server][,nowait][,nodelay]
2507 The telnet protocol is used instead of raw tcp sockets. The options
2508 work the same as if you had specified @code{-serial tcp}. The
2509 difference is that the port acts like a telnet server or client using
2510 telnet option negotiation. This will also allow you to send the
2511 MAGIC_SYSRQ sequence if you use a telnet that supports sending the break
2512 sequence. Typically in unix telnet you do it with Control-] and then
2513 type "send break" followed by pressing the enter key.
2515 @item unix:@var{path}[,server][,nowait]
2516 A unix domain socket is used instead of a tcp socket. The option works the
2517 same as if you had specified @code{-serial tcp} except the unix domain socket
2518 @var{path} is used for connections.
2520 @item mon:@var{dev_string}
2521 This is a special option to allow the monitor to be multiplexed onto
2522 another serial port. The monitor is accessed with key sequence of
2523 @key{Control-a} and then pressing @key{c}.
2524 @var{dev_string} should be any one of the serial devices specified
2525 above. An example to multiplex the monitor onto a telnet server
2526 listening on port 4444 would be:
2528 @item -serial mon:telnet::4444,server,nowait
2530 When the monitor is multiplexed to stdio in this way, Ctrl+C will not terminate
2531 QEMU any more but will be passed to the guest instead.
2534 Braille device. This will use BrlAPI to display the braille output on a real
2538 Three button serial mouse. Configure the guest to use Microsoft protocol.
2542 DEF("parallel", HAS_ARG, QEMU_OPTION_parallel, \
2543 "-parallel dev redirect the parallel port to char device 'dev
'\n",
2546 @item -parallel @var{dev}
2548 Redirect the virtual parallel port to host device @var{dev} (same
2549 devices as the serial port). On Linux hosts, @file{/dev/parportN} can
2550 be used to use hardware devices connected on the corresponding host
2553 This option can be used several times to simulate up to 3 parallel
2556 Use @code{-parallel none} to disable all parallel ports.
2559 DEF("monitor", HAS_ARG, QEMU_OPTION_monitor, \
2560 "-monitor dev redirect the monitor to char device 'dev
'\n",
2563 @item -monitor @var{dev}
2565 Redirect the monitor to host device @var{dev} (same devices as the
2567 The default device is @code{vc} in graphical mode and @code{stdio} in
2569 Use @code{-monitor none} to disable the default monitor.
2571 DEF("qmp", HAS_ARG, QEMU_OPTION_qmp, \
2572 "-qmp dev like -monitor but opens in 'control
' mode\n",
2575 @item -qmp @var{dev}
2577 Like -monitor but opens in 'control
' mode.
2580 DEF("mon", HAS_ARG, QEMU_OPTION_mon, \
2581 "-mon [chardev=]name[,mode=readline|control][,default]\n", QEMU_ARCH_ALL)
2583 @item -mon [chardev=]name[,mode=readline|control][,default]
2585 Setup monitor on chardev @var{name}.
2588 DEF("debugcon", HAS_ARG, QEMU_OPTION_debugcon, \
2589 "-debugcon dev redirect the debug console to char device 'dev
'\n",
2592 @item -debugcon @var{dev}
2594 Redirect the debug console to host device @var{dev} (same devices as the
2595 serial port). The debug console is an I/O port which is typically port
2596 0xe9; writing to that I/O port sends output to this device.
2597 The default device is @code{vc} in graphical mode and @code{stdio} in
2601 DEF("pidfile", HAS_ARG, QEMU_OPTION_pidfile, \
2602 "-pidfile file write PID to 'file
'\n", QEMU_ARCH_ALL)
2604 @item -pidfile @var{file}
2606 Store the QEMU process PID in @var{file}. It is useful if you launch QEMU
2610 DEF("singlestep", 0, QEMU_OPTION_singlestep, \
2611 "-singlestep always run in singlestep mode\n", QEMU_ARCH_ALL)
2615 Run the emulation in single step mode.
2618 DEF("S", 0, QEMU_OPTION_S, \
2619 "-S freeze CPU at startup (use 'c
' to start execution)\n",
2624 Do not start CPU at startup (you must type 'c
' in the monitor).
2627 DEF("realtime", HAS_ARG, QEMU_OPTION_realtime,
2628 "-realtime [mlock=on|off]\n"
2629 " run qemu with realtime features\n"
2630 " mlock=on|off controls mlock support (default: on)\n",
2633 @item -realtime mlock=on|off
2635 Run qemu with realtime features.
2636 mlocking qemu and guest memory can be enabled via @option{mlock=on}
2637 (enabled by default).
2640 DEF("gdb", HAS_ARG, QEMU_OPTION_gdb, \
2641 "-gdb dev wait for gdb connection on 'dev
'\n", QEMU_ARCH_ALL)
2643 @item -gdb @var{dev}
2645 Wait for gdb connection on device @var{dev} (@pxref{gdb_usage}). Typical
2646 connections will likely be TCP-based, but also UDP, pseudo TTY, or even
2647 stdio are reasonable use case. The latter is allowing to start QEMU from
2648 within gdb and establish the connection via a pipe:
2650 (gdb) target remote | exec qemu-system-i386 -gdb stdio ...
2654 DEF("s", 0, QEMU_OPTION_s, \
2655 "-s shorthand for -gdb tcp::" DEFAULT_GDBSTUB_PORT "\n",
2660 Shorthand for -gdb tcp::1234, i.e. open a gdbserver on TCP port 1234
2661 (@pxref{gdb_usage}).
2664 DEF("d", HAS_ARG, QEMU_OPTION_d, \
2665 "-d item1,... enable logging of specified items (use '-d help
' for a list of log items)\n",
2668 @item -d @var{item1}[,...]
2670 Enable logging of specified items. Use '-d help
' for a list of log items.
2673 DEF("D", HAS_ARG, QEMU_OPTION_D, \
2674 "-D logfile output log to logfile (default stderr)\n",
2677 @item -D @var{logfile}
2679 Output log in @var{logfile} instead of to stderr
2682 DEF("L", HAS_ARG, QEMU_OPTION_L, \
2683 "-L path set the directory for the BIOS, VGA BIOS and keymaps\n",
2688 Set the directory for the BIOS, VGA BIOS and keymaps.
2691 DEF("bios", HAS_ARG, QEMU_OPTION_bios, \
2692 "-bios file set the filename for the BIOS\n", QEMU_ARCH_ALL)
2694 @item -bios @var{file}
2696 Set the filename for the BIOS.
2699 DEF("enable-kvm", 0, QEMU_OPTION_enable_kvm, \
2700 "-enable-kvm enable KVM full virtualization support\n", QEMU_ARCH_ALL)
2704 Enable KVM full virtualization support. This option is only available
2705 if KVM support is enabled when compiling.
2708 DEF("xen-domid", HAS_ARG, QEMU_OPTION_xen_domid,
2709 "-xen-domid id specify xen guest domain id\n", QEMU_ARCH_ALL)
2710 DEF("xen-create", 0, QEMU_OPTION_xen_create,
2711 "-xen-create create domain using xen hypercalls, bypassing xend\n"
2712 " warning: should not be used when xend is in use\n",
2714 DEF("xen-attach", 0, QEMU_OPTION_xen_attach,
2715 "-xen-attach attach to existing xen domain\n"
2716 " xend will use this when starting QEMU\n",
2719 @item -xen-domid @var{id}
2721 Specify xen guest domain @var{id} (XEN only).
2724 Create domain using xen hypercalls, bypassing xend.
2725 Warning: should not be used when xend is in use (XEN only).
2728 Attach to existing xen domain.
2729 xend will use this when starting QEMU (XEN only).
2732 DEF("no-reboot", 0, QEMU_OPTION_no_reboot, \
2733 "-no-reboot exit instead of rebooting\n", QEMU_ARCH_ALL)
2737 Exit instead of rebooting.
2740 DEF("no-shutdown", 0, QEMU_OPTION_no_shutdown, \
2741 "-no-shutdown stop before shutdown\n", QEMU_ARCH_ALL)
2744 @findex -no-shutdown
2745 Don't exit QEMU on guest shutdown
, but instead only stop the emulation
.
2746 This allows
for instance switching to monitor to commit changes to the
2750 DEF("loadvm", HAS_ARG
, QEMU_OPTION_loadvm
, \
2751 "-loadvm [tag|id]\n" \
2752 " start right away with a saved state (loadvm in monitor)\n",
2755 @item
-loadvm @
var{file
}
2757 Start right away with a saved
state (@code
{loadvm
} in monitor
)
2761 DEF("daemonize", 0, QEMU_OPTION_daemonize
, \
2762 "-daemonize daemonize QEMU after initializing\n", QEMU_ARCH_ALL
)
2767 Daemonize the QEMU process after initialization
. QEMU will not detach from
2768 standard IO until it is ready to receive connections on any of its devices
.
2769 This option is a useful way
for external programs to launch QEMU without having
2770 to cope with initialization race conditions
.
2773 DEF("option-rom", HAS_ARG
, QEMU_OPTION_option_rom
, \
2774 "-option-rom rom load a file, rom, into the option ROM space\n",
2777 @item
-option
-rom @
var{file
}
2779 Load the contents of @
var{file
} as an option ROM
.
2780 This option is useful to load things like EtherBoot
.
2783 DEF("clock", HAS_ARG
, QEMU_OPTION_clock
, \
2784 "-clock force the use of the given methods for timer alarm.\n" \
2785 " To see what timers are available use '-clock help'\n",
2788 @item
-clock @
var{method
}
2790 Force the use of the given methods
for timer alarm
. To see what timers
2791 are available use @code
{-clock help
}.
2794 HXCOMM Options deprecated by
-rtc
2795 DEF("localtime", 0, QEMU_OPTION_localtime
, "", QEMU_ARCH_ALL
)
2796 DEF("startdate", HAS_ARG
, QEMU_OPTION_startdate
, "", QEMU_ARCH_ALL
)
2798 DEF("rtc", HAS_ARG
, QEMU_OPTION_rtc
, \
2799 "-rtc [base=utc|localtime|date][,clock=host|rt|vm][,driftfix=none|slew]\n" \
2800 " set the RTC base and clock, enable drift fix for clock ticks (x86 only)\n",
2805 @item
-rtc
[base
=utc|localtime|@
var{date
}][,clock
=host|vm
][,driftfix
=none|slew
]
2807 Specify @option
{base
} as @code
{utc
} or @code
{localtime
} to let the RTC start at the current
2808 UTC or local time
, respectively
. @code
{localtime
} is required
for correct date
in
2809 MS
-DOS or Windows
. To start at a specific point
in time
, provide @
var{date
} in the
2810 format @code
{2006-06-17T16
:01:21} or @code
{2006-06-17}. The
default base is UTC
.
2812 By
default the RTC is driven by the host system time
. This allows
using of the
2813 RTC as accurate reference clock inside the guest
, specifically
if the host
2814 time is smoothly following an accurate external reference clock
, e
.g
. via NTP
.
2815 If you want to isolate the guest time from the host
, you can set @option
{clock
}
2816 to @code
{rt
} instead
. To even prevent it from progressing during suspension
,
2817 you can set it to @code
{vm
}.
2819 Enable @option
{driftfix
} (i386 targets only
) if you experience time drift problems
,
2820 specifically with Windows
' ACPI HAL. This option will try to figure out how
2821 many timer interrupts were not processed by the Windows guest and will
2825 DEF("icount", HAS_ARG, QEMU_OPTION_icount, \
2826 "-icount [N|auto]\n" \
2827 " enable virtual instruction counter with 2^N clock ticks per\n" \
2828 " instruction\n", QEMU_ARCH_ALL)
2830 @item -icount [@var{N}|auto]
2832 Enable virtual instruction counter. The virtual cpu will execute one
2833 instruction every 2^@var{N} ns of virtual time. If @code{auto} is specified
2834 then the virtual cpu speed will be automatically adjusted to keep virtual
2835 time within a few seconds of real time.
2837 Note that while this option can give deterministic behavior, it does not
2838 provide cycle accurate emulation. Modern CPUs contain superscalar out of
2839 order cores with complex cache hierarchies. The number of instructions
2840 executed often has little or no correlation with actual performance.
2843 DEF("watchdog", HAS_ARG, QEMU_OPTION_watchdog, \
2844 "-watchdog i6300esb|ib700\n" \
2845 " enable virtual hardware watchdog [default=none]\n",
2848 @item -watchdog @var{model}
2850 Create a virtual hardware watchdog device. Once enabled (by a guest
2851 action), the watchdog must be periodically polled by an agent inside
2852 the guest or else the guest will be restarted.
2854 The @var{model} is the model of hardware watchdog to emulate. Choices
2855 for model are: @code{ib700} (iBASE 700) which is a very simple ISA
2856 watchdog with a single timer, or @code{i6300esb} (Intel 6300ESB I/O
2857 controller hub) which is a much more featureful PCI-based dual-timer
2858 watchdog. Choose a model for which your guest has drivers.
2860 Use @code{-watchdog help} to list available hardware models. Only one
2861 watchdog can be enabled for a guest.
2864 DEF("watchdog-action", HAS_ARG, QEMU_OPTION_watchdog_action, \
2865 "-watchdog-action reset|shutdown|poweroff|pause|debug|none\n" \
2866 " action when watchdog fires [default=reset]\n",
2869 @item -watchdog-action @var{action}
2870 @findex -watchdog-action
2872 The @var{action} controls what QEMU will do when the watchdog timer
2875 @code{reset} (forcefully reset the guest).
2876 Other possible actions are:
2877 @code{shutdown} (attempt to gracefully shutdown the guest),
2878 @code{poweroff} (forcefully poweroff the guest),
2879 @code{pause} (pause the guest),
2880 @code{debug} (print a debug message and continue), or
2881 @code{none} (do nothing).
2883 Note that the @code{shutdown} action requires that the guest responds
2884 to ACPI signals, which it may not be able to do in the sort of
2885 situations where the watchdog would have expired, and thus
2886 @code{-watchdog-action shutdown} is not recommended for production use.
2891 @item -watchdog i6300esb -watchdog-action pause
2892 @item -watchdog ib700
2896 DEF("echr", HAS_ARG, QEMU_OPTION_echr, \
2897 "-echr chr set terminal escape character instead of ctrl-a\n",
2901 @item -echr @var{numeric_ascii_value}
2903 Change the escape character used for switching to the monitor when using
2904 monitor and serial sharing. The default is @code{0x01} when using the
2905 @code{-nographic} option. @code{0x01} is equal to pressing
2906 @code{Control-a}. You can select a different character from the ascii
2907 control keys where 1 through 26 map to Control-a through Control-z. For
2908 instance you could use the either of the following to change the escape
2909 character to Control-t.
2916 DEF("virtioconsole", HAS_ARG, QEMU_OPTION_virtiocon, \
2917 "-virtioconsole c\n" \
2918 " set virtio console\n", QEMU_ARCH_ALL)
2920 @item -virtioconsole @var{c}
2921 @findex -virtioconsole
2924 This option is maintained for backward compatibility.
2926 Please use @code{-device virtconsole} for the new way of invocation.
2929 DEF("show-cursor", 0, QEMU_OPTION_show_cursor, \
2930 "-show-cursor show cursor\n", QEMU_ARCH_ALL)
2933 @findex -show-cursor
2937 DEF("tb-size", HAS_ARG, QEMU_OPTION_tb_size, \
2938 "-tb-size n set TB size\n", QEMU_ARCH_ALL)
2940 @item -tb-size @var{n}
2945 DEF("incoming", HAS_ARG, QEMU_OPTION_incoming, \
2946 "-incoming p prepare for incoming migration, listen on port p\n",
2949 @item -incoming @var{port}
2951 Prepare for incoming migration, listen on @var{port}.
2954 DEF("nodefaults", 0, QEMU_OPTION_nodefaults, \
2955 "-nodefaults don't create
default devices
\n", QEMU_ARCH_ALL)
2959 Don't create default devices. Normally, QEMU sets the default devices like serial
2960 port, parallel port, virtual console, monitor device, VGA adapter, floppy and
2961 CD-ROM drive and others. The @code{-nodefaults} option will disable all those
2966 DEF("chroot
", HAS_ARG, QEMU_OPTION_chroot, \
2967 "-chroot dir chroot to dir just before starting the VM
\n",
2971 @item -chroot @var{dir}
2973 Immediately before starting guest execution, chroot to the specified
2974 directory. Especially useful in combination with -runas.
2978 DEF("runas
", HAS_ARG, QEMU_OPTION_runas, \
2979 "-runas user change to user id user just before starting the VM
\n",
2983 @item -runas @var{user}
2985 Immediately before starting guest execution, drop root privileges, switching
2986 to the specified user.
2989 DEF("prom
-env
", HAS_ARG, QEMU_OPTION_prom_env,
2990 "-prom
-env variable
=value
\n"
2991 " set OpenBIOS nvram variables
\n",
2992 QEMU_ARCH_PPC | QEMU_ARCH_SPARC)
2994 @item -prom-env @var{variable}=@var{value}
2996 Set OpenBIOS nvram @var{variable} to given @var{value} (PPC, SPARC only).
2998 DEF("semihosting
", 0, QEMU_OPTION_semihosting,
2999 "-semihosting semihosting mode
\n", QEMU_ARCH_ARM | QEMU_ARCH_M68K | QEMU_ARCH_XTENSA)
3002 @findex -semihosting
3003 Semihosting mode (ARM, M68K, Xtensa only).
3005 DEF("old
-param
", 0, QEMU_OPTION_old_param,
3006 "-old
-param old param mode
\n", QEMU_ARCH_ARM)
3009 @findex -old-param (ARM)
3010 Old param mode (ARM only).
3013 DEF("sandbox
", HAS_ARG, QEMU_OPTION_sandbox, \
3014 "-sandbox
<arg
> Enable seccomp mode
2 system call
filter (default 'off').\n",
3017 @item -sandbox @var{arg}
3019 Enable Seccomp mode 2 system call filter. 'on' will enable syscall filtering and 'off' will
3020 disable it. The default is 'off'.
3023 DEF("readconfig
", HAS_ARG, QEMU_OPTION_readconfig,
3024 "-readconfig
<file
>\n", QEMU_ARCH_ALL)
3026 @item -readconfig @var{file}
3028 Read device configuration from @var{file}. This approach is useful when you want to spawn
3029 QEMU process with many command line options but you don't want to exceed the command line
3032 DEF("writeconfig
", HAS_ARG, QEMU_OPTION_writeconfig,
3033 "-writeconfig
<file
>\n"
3034 " read
/write config file
\n", QEMU_ARCH_ALL)
3036 @item -writeconfig @var{file}
3037 @findex -writeconfig
3038 Write device configuration to @var{file}. The @var{file} can be either filename to save
3039 command line and device configuration into file or dash @code{-}) character to print the
3040 output to stdout. This can be later used as input file for @code{-readconfig} option.
3042 DEF("nodefconfig
", 0, QEMU_OPTION_nodefconfig,
3044 " do not load
default config files at startup
\n",
3048 @findex -nodefconfig
3049 Normally QEMU loads configuration files from @var{sysconfdir} and @var{datadir} at startup.
3050 The @code{-nodefconfig} option will prevent QEMU from loading any of those config files.
3052 DEF("no
-user
-config
", 0, QEMU_OPTION_nouserconfig,
3054 " do not load user
-provided config files at startup
\n",
3057 @item -no-user-config
3058 @findex -no-user-config
3059 The @code{-no-user-config} option makes QEMU not load any of the user-provided
3060 config files on @var{sysconfdir}, but won't make it skip the QEMU-provided config
3061 files from @var{datadir}.
3063 DEF("trace", HAS_ARG, QEMU_OPTION_trace,
3064 "-trace [events
=<file
>][,file
=<file
>]\n"
3065 " specify tracing options
\n",
3068 HXCOMM This line is not accurate, as some sub-options are backend-specific but
3069 HXCOMM HX does not support conditional compilation of text.
3070 @item -trace [events=@var{file}][,file=@var{file}]
3073 Specify tracing options.
3076 @item events=@var{file}
3077 Immediately enable events listed in @var{file}.
3078 The file must contain one event name (as listed in the @var{trace-events} file)
3080 This option is only available if QEMU has been compiled with
3081 either @var{simple} or @var{stderr} tracing backend.
3082 @item file=@var{file}
3083 Log output traces to @var{file}.
3085 This option is only available if QEMU has been compiled with
3086 the @var{simple} tracing backend.
3091 DEF("qtest
", HAS_ARG, QEMU_OPTION_qtest, "", QEMU_ARCH_ALL)
3092 DEF("qtest
-log
", HAS_ARG, QEMU_OPTION_qtest_log, "", QEMU_ARCH_ALL)
3095 DEF("enable
-fips
", 0, QEMU_OPTION_enablefips,
3096 "-enable
-fips enable FIPS
140-2 compliance
\n",
3101 @findex -enable-fips
3102 Enable FIPS 140-2 compliance mode.
3105 HXCOMM Deprecated by -machine accel=tcg property
3106 DEF("no
-kvm
", 0, QEMU_OPTION_no_kvm, "", QEMU_ARCH_I386)
3108 HXCOMM Deprecated by kvm-pit driver properties
3109 DEF("no
-kvm
-pit
-reinjection
", 0, QEMU_OPTION_no_kvm_pit_reinjection,
3112 HXCOMM Deprecated (ignored)
3113 DEF("no
-kvm
-pit
", 0, QEMU_OPTION_no_kvm_pit, "", QEMU_ARCH_I386)
3115 HXCOMM Deprecated by -machine kernel_irqchip=on|off property
3116 DEF("no
-kvm
-irqchip
", 0, QEMU_OPTION_no_kvm_irqchip, "", QEMU_ARCH_I386)
3118 HXCOMM Deprecated (ignored)
3119 DEF("tdf
", 0, QEMU_OPTION_tdf,"", QEMU_ARCH_ALL)
3121 DEF("object
", HAS_ARG, QEMU_OPTION_object,
3122 "-object TYPENAME
[,PROP1
=VALUE1
,...]\n"
3123 " create an
new object of type TYPENAME setting properties
\n"
3124 " in the order they are specified
. Note that the
'id'\n"
3125 " property must be set
. These objects are placed
in the
\n"
3126 " '/objects' path
.\n",
3129 @item -object @var{typename}[,@var{prop1}=@var{value1},...]
3131 Create an new object of type @var{typename} setting properties
3132 in the order they are specified. Note that the 'id'
3133 property must be set. These objects are placed in the
3137 DEF("msg
", HAS_ARG, QEMU_OPTION_msg,
3138 "-msg timestamp
[=on|off
]\n"
3139 " change the format of messages
\n"
3140 " on|off controls leading
timestamps (default:on
)\n",
3143 @item -msg timestamp[=on|off]
3145 prepend a timestamp to each log message.(default:on)
3148 HXCOMM This is the last statement. Insert new options before this line!