virtio-vga: add vgabios configuration
[qemu/ar7.git] / qemu-options.hx
blobc6221d4b580cd3384a7925bc8845296bcd511730
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
6 HXCOMM architectures.
7 HXCOMM HXCOMM can be used for comments, discarded from both texi and C
9 DEFHEADING(Standard options:)
10 STEXI
11 @table @option
12 ETEXI
14 DEF("help", 0, QEMU_OPTION_h,
15 "-h or -help display this help and exit\n", QEMU_ARCH_ALL)
16 STEXI
17 @item -h
18 @findex -h
19 Display help and exit
20 ETEXI
22 DEF("version", 0, QEMU_OPTION_version,
23 "-version display version information and exit\n", QEMU_ARCH_ALL)
24 STEXI
25 @item -version
26 @findex -version
27 Display version information and exit
28 ETEXI
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 " vmport=on|off|auto controls emulation of vmport (default: auto)\n"
37 " kvm_shadow_mem=size of KVM shadow MMU\n"
38 " dump-guest-core=on|off include guest memory in a core dump (default=on)\n"
39 " mem-merge=on|off controls memory merge support (default: on)\n"
40 " iommu=on|off controls emulated Intel IOMMU (VT-d) support (default=off)\n"
41 " aes-key-wrap=on|off controls support for AES key wrapping (default=on)\n"
42 " dea-key-wrap=on|off controls support for DEA key wrapping (default=on)\n"
43 " suppress-vmdesc=on|off disables self-describing migration (default=off)\n",
44 QEMU_ARCH_ALL)
45 STEXI
46 @item -machine [type=]@var{name}[,prop=@var{value}[,...]]
47 @findex -machine
48 Select the emulated machine by @var{name}. Use @code{-machine help} to list
49 available machines. Supported machine properties are:
50 @table @option
51 @item accel=@var{accels1}[:@var{accels2}[:...]]
52 This is used to enable an accelerator. Depending on the target architecture,
53 kvm, xen, or tcg can be available. By default, tcg is used. If there is more
54 than one accelerator specified, the next one is used if the previous one fails
55 to initialize.
56 @item kernel_irqchip=on|off
57 Enables in-kernel irqchip support for the chosen accelerator when available.
58 @item vmport=on|off|auto
59 Enables emulation of VMWare IO port, for vmmouse etc. auto says to select the
60 value based on accel. For accel=xen the default is off otherwise the default
61 is on.
62 @item kvm_shadow_mem=size
63 Defines the size of the KVM shadow MMU.
64 @item dump-guest-core=on|off
65 Include guest memory in a core dump. The default is on.
66 @item mem-merge=on|off
67 Enables or disables memory merge support. This feature, when supported by
68 the host, de-duplicates identical memory pages among VMs instances
69 (enabled by default).
70 @item iommu=on|off
71 Enables or disables emulated Intel IOMMU (VT-d) support. The default is off.
72 @item aes-key-wrap=on|off
73 Enables or disables AES key wrapping support on s390-ccw hosts. This feature
74 controls whether AES wrapping keys will be created to allow
75 execution of AES cryptographic functions. The default is on.
76 @item dea-key-wrap=on|off
77 Enables or disables DEA key wrapping support on s390-ccw hosts. This feature
78 controls whether DEA wrapping keys will be created to allow
79 execution of DEA cryptographic functions. The default is on.
80 @end table
81 ETEXI
83 HXCOMM Deprecated by -machine
84 DEF("M", HAS_ARG, QEMU_OPTION_M, "", QEMU_ARCH_ALL)
86 DEF("cpu", HAS_ARG, QEMU_OPTION_cpu,
87 "-cpu cpu select CPU ('-cpu help' for list)\n", QEMU_ARCH_ALL)
88 STEXI
89 @item -cpu @var{model}
90 @findex -cpu
91 Select CPU model (@code{-cpu help} for list and additional feature selection)
92 ETEXI
94 DEF("smp", HAS_ARG, QEMU_OPTION_smp,
95 "-smp [cpus=]n[,maxcpus=cpus][,cores=cores][,threads=threads][,sockets=sockets]\n"
96 " set the number of CPUs to 'n' [default=1]\n"
97 " maxcpus= maximum number of total cpus, including\n"
98 " offline CPUs for hotplug, etc\n"
99 " cores= number of CPU cores on one socket\n"
100 " threads= number of threads on one CPU core\n"
101 " sockets= number of discrete sockets in the system\n",
102 QEMU_ARCH_ALL)
103 STEXI
104 @item -smp [cpus=]@var{n}[,cores=@var{cores}][,threads=@var{threads}][,sockets=@var{sockets}][,maxcpus=@var{maxcpus}]
105 @findex -smp
106 Simulate an SMP system with @var{n} CPUs. On the PC target, up to 255
107 CPUs are supported. On Sparc32 target, Linux limits the number of usable CPUs
108 to 4.
109 For the PC target, the number of @var{cores} per socket, the number
110 of @var{threads} per cores and the total number of @var{sockets} can be
111 specified. Missing values will be computed. If any on the three values is
112 given, the total number of CPUs @var{n} can be omitted. @var{maxcpus}
113 specifies the maximum number of hotpluggable CPUs.
114 ETEXI
116 DEF("numa", HAS_ARG, QEMU_OPTION_numa,
117 "-numa node[,mem=size][,cpus=cpu[-cpu]][,nodeid=node]\n"
118 "-numa node[,memdev=id][,cpus=cpu[-cpu]][,nodeid=node]\n", QEMU_ARCH_ALL)
119 STEXI
120 @item -numa node[,mem=@var{size}][,cpus=@var{cpu[-cpu]}][,nodeid=@var{node}]
121 @item -numa node[,memdev=@var{id}][,cpus=@var{cpu[-cpu]}][,nodeid=@var{node}]
122 @findex -numa
123 Simulate a multi node NUMA system. If @samp{mem}, @samp{memdev}
124 and @samp{cpus} are omitted, resources are split equally. Also, note
125 that the -@option{numa} option doesn't allocate any of the specified
126 resources. That is, it just assigns existing resources to NUMA nodes. This
127 means that one still has to use the @option{-m}, @option{-smp} options
128 to allocate RAM and VCPUs respectively, and possibly @option{-object}
129 to specify the memory backend for the @samp{memdev} suboption.
131 @samp{mem} and @samp{memdev} are mutually exclusive. Furthermore, if one
132 node uses @samp{memdev}, all of them have to use it.
133 ETEXI
135 DEF("add-fd", HAS_ARG, QEMU_OPTION_add_fd,
136 "-add-fd fd=fd,set=set[,opaque=opaque]\n"
137 " Add 'fd' to fd 'set'\n", QEMU_ARCH_ALL)
138 STEXI
139 @item -add-fd fd=@var{fd},set=@var{set}[,opaque=@var{opaque}]
140 @findex -add-fd
142 Add a file descriptor to an fd set. Valid options are:
144 @table @option
145 @item fd=@var{fd}
146 This option defines the file descriptor of which a duplicate is added to fd set.
147 The file descriptor cannot be stdin, stdout, or stderr.
148 @item set=@var{set}
149 This option defines the ID of the fd set to add the file descriptor to.
150 @item opaque=@var{opaque}
151 This option defines a free-form string that can be used to describe @var{fd}.
152 @end table
154 You can open an image using pre-opened file descriptors from an fd set:
155 @example
156 qemu-system-i386
157 -add-fd fd=3,set=2,opaque="rdwr:/path/to/file"
158 -add-fd fd=4,set=2,opaque="rdonly:/path/to/file"
159 -drive file=/dev/fdset/2,index=0,media=disk
160 @end example
161 ETEXI
163 DEF("set", HAS_ARG, QEMU_OPTION_set,
164 "-set group.id.arg=value\n"
165 " set <arg> parameter for item <id> of type <group>\n"
166 " i.e. -set drive.$id.file=/path/to/image\n", QEMU_ARCH_ALL)
167 STEXI
168 @item -set @var{group}.@var{id}.@var{arg}=@var{value}
169 @findex -set
170 Set parameter @var{arg} for item @var{id} of type @var{group}\n"
171 ETEXI
173 DEF("global", HAS_ARG, QEMU_OPTION_global,
174 "-global driver.property=value\n"
175 "-global driver=driver,property=property,value=value\n"
176 " set a global default for a driver property\n",
177 QEMU_ARCH_ALL)
178 STEXI
179 @item -global @var{driver}.@var{prop}=@var{value}
180 @itemx -global driver=@var{driver},property=@var{property},value=@var{value}
181 @findex -global
182 Set default value of @var{driver}'s property @var{prop} to @var{value}, e.g.:
184 @example
185 qemu-system-i386 -global ide-drive.physical_block_size=4096 -drive file=file,if=ide,index=0,media=disk
186 @end example
188 In particular, you can use this to set driver properties for devices which are
189 created automatically by the machine model. To create a device which is not
190 created automatically and set properties on it, use -@option{device}.
192 The two syntaxes are equivalent. The longer one works for drivers whose name
193 contains a dot.
194 ETEXI
196 DEF("boot", HAS_ARG, QEMU_OPTION_boot,
197 "-boot [order=drives][,once=drives][,menu=on|off]\n"
198 " [,splash=sp_name][,splash-time=sp_time][,reboot-timeout=rb_time][,strict=on|off]\n"
199 " 'drives': floppy (a), hard disk (c), CD-ROM (d), network (n)\n"
200 " 'sp_name': the file's name that would be passed to bios as logo picture, if menu=on\n"
201 " 'sp_time': the period that splash picture last if menu=on, unit is ms\n"
202 " 'rb_timeout': the timeout before guest reboot when boot failed, unit is ms\n",
203 QEMU_ARCH_ALL)
204 STEXI
205 @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]
206 @findex -boot
207 Specify boot order @var{drives} as a string of drive letters. Valid
208 drive letters depend on the target achitecture. The x86 PC uses: a, b
209 (floppy 1 and 2), c (first hard disk), d (first CD-ROM), n-p (Etherboot
210 from network adapter 1-4), hard disk boot is the default. To apply a
211 particular boot order only on the first startup, specify it via
212 @option{once}.
214 Interactive boot menus/prompts can be enabled via @option{menu=on} as far
215 as firmware/BIOS supports them. The default is non-interactive boot.
217 A splash picture could be passed to bios, enabling user to show it as logo,
218 when option splash=@var{sp_name} is given and menu=on, If firmware/BIOS
219 supports them. Currently Seabios for X86 system support it.
220 limitation: The splash file could be a jpeg file or a BMP file in 24 BPP
221 format(true color). The resolution should be supported by the SVGA mode, so
222 the recommended is 320x240, 640x480, 800x640.
224 A timeout could be passed to bios, guest will pause for @var{rb_timeout} ms
225 when boot failed, then reboot. If @var{rb_timeout} is '-1', guest will not
226 reboot, qemu passes '-1' to bios by default. Currently Seabios for X86
227 system support it.
229 Do strict boot via @option{strict=on} as far as firmware/BIOS
230 supports it. This only effects when boot priority is changed by
231 bootindex options. The default is non-strict boot.
233 @example
234 # try to boot from network first, then from hard disk
235 qemu-system-i386 -boot order=nc
236 # boot from CD-ROM first, switch back to default order after reboot
237 qemu-system-i386 -boot once=d
238 # boot with a splash picture for 5 seconds.
239 qemu-system-i386 -boot menu=on,splash=/root/boot.bmp,splash-time=5000
240 @end example
242 Note: The legacy format '-boot @var{drives}' is still supported but its
243 use is discouraged as it may be removed from future versions.
244 ETEXI
246 DEF("m", HAS_ARG, QEMU_OPTION_m,
247 "-m[emory] [size=]megs[,slots=n,maxmem=size]\n"
248 " configure guest RAM\n"
249 " size: initial amount of guest memory\n"
250 " slots: number of hotplug slots (default: none)\n"
251 " maxmem: maximum amount of guest memory (default: none)\n"
252 "NOTE: Some architectures might enforce a specific granularity\n",
253 QEMU_ARCH_ALL)
254 STEXI
255 @item -m [size=]@var{megs}[,slots=n,maxmem=size]
256 @findex -m
257 Sets guest startup RAM size to @var{megs} megabytes. Default is 128 MiB.
258 Optionally, a suffix of ``M'' or ``G'' can be used to signify a value in
259 megabytes or gigabytes respectively. Optional pair @var{slots}, @var{maxmem}
260 could be used to set amount of hotpluggable memory slots and maximum amount of
261 memory. Note that @var{maxmem} must be aligned to the page size.
263 For example, the following command-line sets the guest startup RAM size to
264 1GB, creates 3 slots to hotplug additional memory and sets the maximum
265 memory the guest can reach to 4GB:
267 @example
268 qemu-system-x86_64 -m 1G,slots=3,maxmem=4G
269 @end example
271 If @var{slots} and @var{maxmem} are not specified, memory hotplug won't
272 be enabled and the guest startup RAM will never increase.
273 ETEXI
275 DEF("mem-path", HAS_ARG, QEMU_OPTION_mempath,
276 "-mem-path FILE provide backing storage for guest RAM\n", QEMU_ARCH_ALL)
277 STEXI
278 @item -mem-path @var{path}
279 @findex -mem-path
280 Allocate guest RAM from a temporarily created file in @var{path}.
281 ETEXI
283 DEF("mem-prealloc", 0, QEMU_OPTION_mem_prealloc,
284 "-mem-prealloc preallocate guest memory (use with -mem-path)\n",
285 QEMU_ARCH_ALL)
286 STEXI
287 @item -mem-prealloc
288 @findex -mem-prealloc
289 Preallocate memory when using -mem-path.
290 ETEXI
292 DEF("k", HAS_ARG, QEMU_OPTION_k,
293 "-k language use keyboard layout (for example 'fr' for French)\n",
294 QEMU_ARCH_ALL)
295 STEXI
296 @item -k @var{language}
297 @findex -k
298 Use keyboard layout @var{language} (for example @code{fr} for
299 French). This option is only needed where it is not easy to get raw PC
300 keycodes (e.g. on Macs, with some X11 servers or with a VNC
301 display). You don't normally need to use it on PC/Linux or PC/Windows
302 hosts.
304 The available layouts are:
305 @example
306 ar de-ch es fo fr-ca hu ja mk no pt-br sv
307 da en-gb et fr fr-ch is lt nl pl ru th
308 de en-us fi fr-be hr it lv nl-be pt sl tr
309 @end example
311 The default is @code{en-us}.
312 ETEXI
315 DEF("audio-help", 0, QEMU_OPTION_audio_help,
316 "-audio-help print list of audio drivers and their options\n",
317 QEMU_ARCH_ALL)
318 STEXI
319 @item -audio-help
320 @findex -audio-help
321 Will show the audio subsystem help: list of drivers, tunable
322 parameters.
323 ETEXI
325 DEF("soundhw", HAS_ARG, QEMU_OPTION_soundhw,
326 "-soundhw c1,... enable audio support\n"
327 " and only specified sound cards (comma separated list)\n"
328 " use '-soundhw help' to get the list of supported cards\n"
329 " use '-soundhw all' to enable all of them\n", QEMU_ARCH_ALL)
330 STEXI
331 @item -soundhw @var{card1}[,@var{card2},...] or -soundhw all
332 @findex -soundhw
333 Enable audio and selected sound hardware. Use 'help' to print all
334 available sound hardware.
336 @example
337 qemu-system-i386 -soundhw sb16,adlib disk.img
338 qemu-system-i386 -soundhw es1370 disk.img
339 qemu-system-i386 -soundhw ac97 disk.img
340 qemu-system-i386 -soundhw hda disk.img
341 qemu-system-i386 -soundhw all disk.img
342 qemu-system-i386 -soundhw help
343 @end example
345 Note that Linux's i810_audio OSS kernel (for AC97) module might
346 require manually specifying clocking.
348 @example
349 modprobe i810_audio clocking=48000
350 @end example
351 ETEXI
353 DEF("balloon", HAS_ARG, QEMU_OPTION_balloon,
354 "-balloon none disable balloon device\n"
355 "-balloon virtio[,addr=str]\n"
356 " enable virtio balloon device (default)\n", QEMU_ARCH_ALL)
357 STEXI
358 @item -balloon none
359 @findex -balloon
360 Disable balloon device.
361 @item -balloon virtio[,addr=@var{addr}]
362 Enable virtio balloon device (default), optionally with PCI address
363 @var{addr}.
364 ETEXI
366 DEF("device", HAS_ARG, QEMU_OPTION_device,
367 "-device driver[,prop[=value][,...]]\n"
368 " add device (based on driver)\n"
369 " prop=value,... sets driver properties\n"
370 " use '-device help' to print all possible drivers\n"
371 " use '-device driver,help' to print all possible properties\n",
372 QEMU_ARCH_ALL)
373 STEXI
374 @item -device @var{driver}[,@var{prop}[=@var{value}][,...]]
375 @findex -device
376 Add device @var{driver}. @var{prop}=@var{value} sets driver
377 properties. Valid properties depend on the driver. To get help on
378 possible drivers and properties, use @code{-device help} and
379 @code{-device @var{driver},help}.
380 ETEXI
382 DEF("name", HAS_ARG, QEMU_OPTION_name,
383 "-name string1[,process=string2][,debug-threads=on|off]\n"
384 " set the name of the guest\n"
385 " string1 sets the window title and string2 the process name (on Linux)\n"
386 " When debug-threads is enabled, individual threads are given a separate name (on Linux)\n"
387 " NOTE: The thread names are for debugging and not a stable API.\n",
388 QEMU_ARCH_ALL)
389 STEXI
390 @item -name @var{name}
391 @findex -name
392 Sets the @var{name} of the guest.
393 This name will be displayed in the SDL window caption.
394 The @var{name} will also be used for the VNC server.
395 Also optionally set the top visible process name in Linux.
396 Naming of individual threads can also be enabled on Linux to aid debugging.
397 ETEXI
399 DEF("uuid", HAS_ARG, QEMU_OPTION_uuid,
400 "-uuid %08x-%04x-%04x-%04x-%012x\n"
401 " specify machine UUID\n", QEMU_ARCH_ALL)
402 STEXI
403 @item -uuid @var{uuid}
404 @findex -uuid
405 Set system UUID.
406 ETEXI
408 STEXI
409 @end table
410 ETEXI
411 DEFHEADING()
413 DEFHEADING(Block device options:)
414 STEXI
415 @table @option
416 ETEXI
418 DEF("fda", HAS_ARG, QEMU_OPTION_fda,
419 "-fda/-fdb file use 'file' as floppy disk 0/1 image\n", QEMU_ARCH_ALL)
420 DEF("fdb", HAS_ARG, QEMU_OPTION_fdb, "", QEMU_ARCH_ALL)
421 STEXI
422 @item -fda @var{file}
423 @item -fdb @var{file}
424 @findex -fda
425 @findex -fdb
426 Use @var{file} as floppy disk 0/1 image (@pxref{disk_images}).
427 ETEXI
429 DEF("hda", HAS_ARG, QEMU_OPTION_hda,
430 "-hda/-hdb file use 'file' as IDE hard disk 0/1 image\n", QEMU_ARCH_ALL)
431 DEF("hdb", HAS_ARG, QEMU_OPTION_hdb, "", QEMU_ARCH_ALL)
432 DEF("hdc", HAS_ARG, QEMU_OPTION_hdc,
433 "-hdc/-hdd file use 'file' as IDE hard disk 2/3 image\n", QEMU_ARCH_ALL)
434 DEF("hdd", HAS_ARG, QEMU_OPTION_hdd, "", QEMU_ARCH_ALL)
435 STEXI
436 @item -hda @var{file}
437 @item -hdb @var{file}
438 @item -hdc @var{file}
439 @item -hdd @var{file}
440 @findex -hda
441 @findex -hdb
442 @findex -hdc
443 @findex -hdd
444 Use @var{file} as hard disk 0, 1, 2 or 3 image (@pxref{disk_images}).
445 ETEXI
447 DEF("cdrom", HAS_ARG, QEMU_OPTION_cdrom,
448 "-cdrom file use 'file' as IDE cdrom image (cdrom is ide1 master)\n",
449 QEMU_ARCH_ALL)
450 STEXI
451 @item -cdrom @var{file}
452 @findex -cdrom
453 Use @var{file} as CD-ROM image (you cannot use @option{-hdc} and
454 @option{-cdrom} at the same time). You can use the host CD-ROM by
455 using @file{/dev/cdrom} as filename (@pxref{host_drives}).
456 ETEXI
458 DEF("drive", HAS_ARG, QEMU_OPTION_drive,
459 "-drive [file=file][,if=type][,bus=n][,unit=m][,media=d][,index=i]\n"
460 " [,cyls=c,heads=h,secs=s[,trans=t]][,snapshot=on|off]\n"
461 " [,cache=writethrough|writeback|none|directsync|unsafe][,format=f]\n"
462 " [,serial=s][,addr=A][,rerror=ignore|stop|report]\n"
463 " [,werror=ignore|stop|report|enospc][,id=name][,aio=threads|native]\n"
464 " [,readonly=on|off][,copy-on-read=on|off]\n"
465 " [,discard=ignore|unmap][,detect-zeroes=on|off|unmap]\n"
466 " [[,bps=b]|[[,bps_rd=r][,bps_wr=w]]]\n"
467 " [[,iops=i]|[[,iops_rd=r][,iops_wr=w]]]\n"
468 " [[,bps_max=bm]|[[,bps_rd_max=rm][,bps_wr_max=wm]]]\n"
469 " [[,iops_max=im]|[[,iops_rd_max=irm][,iops_wr_max=iwm]]]\n"
470 " [[,iops_size=is]]\n"
471 " use 'file' as a drive image\n", QEMU_ARCH_ALL)
472 STEXI
473 @item -drive @var{option}[,@var{option}[,@var{option}[,...]]]
474 @findex -drive
476 Define a new drive. Valid options are:
478 @table @option
479 @item file=@var{file}
480 This option defines which disk image (@pxref{disk_images}) to use with
481 this drive. If the filename contains comma, you must double it
482 (for instance, "file=my,,file" to use file "my,file").
484 Special files such as iSCSI devices can be specified using protocol
485 specific URLs. See the section for "Device URL Syntax" for more information.
486 @item if=@var{interface}
487 This option defines on which type on interface the drive is connected.
488 Available types are: ide, scsi, sd, mtd, floppy, pflash, virtio.
489 @item bus=@var{bus},unit=@var{unit}
490 These options define where is connected the drive by defining the bus number and
491 the unit id.
492 @item index=@var{index}
493 This option defines where is connected the drive by using an index in the list
494 of available connectors of a given interface type.
495 @item media=@var{media}
496 This option defines the type of the media: disk or cdrom.
497 @item cyls=@var{c},heads=@var{h},secs=@var{s}[,trans=@var{t}]
498 These options have the same definition as they have in @option{-hdachs}.
499 @item snapshot=@var{snapshot}
500 @var{snapshot} is "on" or "off" and controls snapshot mode for the given drive
501 (see @option{-snapshot}).
502 @item cache=@var{cache}
503 @var{cache} is "none", "writeback", "unsafe", "directsync" or "writethrough" and controls how the host cache is used to access block data.
504 @item aio=@var{aio}
505 @var{aio} is "threads", or "native" and selects between pthread based disk I/O and native Linux AIO.
506 @item discard=@var{discard}
507 @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.
508 @item format=@var{format}
509 Specify which disk @var{format} will be used rather than detecting
510 the format. Can be used to specifiy format=raw to avoid interpreting
511 an untrusted format header.
512 @item serial=@var{serial}
513 This option specifies the serial number to assign to the device.
514 @item addr=@var{addr}
515 Specify the controller's PCI address (if=virtio only).
516 @item werror=@var{action},rerror=@var{action}
517 Specify which @var{action} to take on write and read errors. Valid actions are:
518 "ignore" (ignore the error and try to continue), "stop" (pause QEMU),
519 "report" (report the error to the guest), "enospc" (pause QEMU only if the
520 host disk is full; report the error to the guest otherwise).
521 The default setting is @option{werror=enospc} and @option{rerror=report}.
522 @item readonly
523 Open drive @option{file} as read-only. Guest write attempts will fail.
524 @item copy-on-read=@var{copy-on-read}
525 @var{copy-on-read} is "on" or "off" and enables whether to copy read backing
526 file sectors into the image file.
527 @item detect-zeroes=@var{detect-zeroes}
528 @var{detect-zeroes} is "off", "on" or "unmap" and enables the automatic
529 conversion of plain zero writes by the OS to driver specific optimized
530 zero write commands. You may even choose "unmap" if @var{discard} is set
531 to "unmap" to allow a zero write to be converted to an UNMAP operation.
532 @end table
534 By default, the @option{cache=writeback} mode is used. It will report data
535 writes as completed as soon as the data is present in the host page cache.
536 This is safe as long as your guest OS makes sure to correctly flush disk caches
537 where needed. If your guest OS does not handle volatile disk write caches
538 correctly and your host crashes or loses power, then the guest may experience
539 data corruption.
541 For such guests, you should consider using @option{cache=writethrough}. This
542 means that the host page cache will be used to read and write data, but write
543 notification will be sent to the guest only after QEMU has made sure to flush
544 each write to the disk. Be aware that this has a major impact on performance.
546 The host page cache can be avoided entirely with @option{cache=none}. This will
547 attempt to do disk IO directly to the guest's memory. QEMU may still perform
548 an internal copy of the data. Note that this is considered a writeback mode and
549 the guest OS must handle the disk write cache correctly in order to avoid data
550 corruption on host crashes.
552 The host page cache can be avoided while only sending write notifications to
553 the guest when the data has been flushed to the disk using
554 @option{cache=directsync}.
556 In case you don't care about data integrity over host failures, use
557 @option{cache=unsafe}. This option tells QEMU that it never needs to write any
558 data to the disk but can instead keep things in cache. If anything goes wrong,
559 like your host losing power, the disk storage getting disconnected accidentally,
560 etc. your image will most probably be rendered unusable. When using
561 the @option{-snapshot} option, unsafe caching is always used.
563 Copy-on-read avoids accessing the same backing file sectors repeatedly and is
564 useful when the backing file is over a slow network. By default copy-on-read
565 is off.
567 Instead of @option{-cdrom} you can use:
568 @example
569 qemu-system-i386 -drive file=file,index=2,media=cdrom
570 @end example
572 Instead of @option{-hda}, @option{-hdb}, @option{-hdc}, @option{-hdd}, you can
573 use:
574 @example
575 qemu-system-i386 -drive file=file,index=0,media=disk
576 qemu-system-i386 -drive file=file,index=1,media=disk
577 qemu-system-i386 -drive file=file,index=2,media=disk
578 qemu-system-i386 -drive file=file,index=3,media=disk
579 @end example
581 You can open an image using pre-opened file descriptors from an fd set:
582 @example
583 qemu-system-i386
584 -add-fd fd=3,set=2,opaque="rdwr:/path/to/file"
585 -add-fd fd=4,set=2,opaque="rdonly:/path/to/file"
586 -drive file=/dev/fdset/2,index=0,media=disk
587 @end example
589 You can connect a CDROM to the slave of ide0:
590 @example
591 qemu-system-i386 -drive file=file,if=ide,index=1,media=cdrom
592 @end example
594 If you don't specify the "file=" argument, you define an empty drive:
595 @example
596 qemu-system-i386 -drive if=ide,index=1,media=cdrom
597 @end example
599 You can connect a SCSI disk with unit ID 6 on the bus #0:
600 @example
601 qemu-system-i386 -drive file=file,if=scsi,bus=0,unit=6
602 @end example
604 Instead of @option{-fda}, @option{-fdb}, you can use:
605 @example
606 qemu-system-i386 -drive file=file,index=0,if=floppy
607 qemu-system-i386 -drive file=file,index=1,if=floppy
608 @end example
610 By default, @var{interface} is "ide" and @var{index} is automatically
611 incremented:
612 @example
613 qemu-system-i386 -drive file=a -drive file=b"
614 @end example
615 is interpreted like:
616 @example
617 qemu-system-i386 -hda a -hdb b
618 @end example
619 ETEXI
621 DEF("mtdblock", HAS_ARG, QEMU_OPTION_mtdblock,
622 "-mtdblock file use 'file' as on-board Flash memory image\n",
623 QEMU_ARCH_ALL)
624 STEXI
625 @item -mtdblock @var{file}
626 @findex -mtdblock
627 Use @var{file} as on-board Flash memory image.
628 ETEXI
630 DEF("sd", HAS_ARG, QEMU_OPTION_sd,
631 "-sd file use 'file' as SecureDigital card image\n", QEMU_ARCH_ALL)
632 STEXI
633 @item -sd @var{file}
634 @findex -sd
635 Use @var{file} as SecureDigital card image.
636 ETEXI
638 DEF("pflash", HAS_ARG, QEMU_OPTION_pflash,
639 "-pflash file use 'file' as a parallel flash image\n", QEMU_ARCH_ALL)
640 STEXI
641 @item -pflash @var{file}
642 @findex -pflash
643 Use @var{file} as a parallel flash image.
644 ETEXI
646 DEF("snapshot", 0, QEMU_OPTION_snapshot,
647 "-snapshot write to temporary files instead of disk image files\n",
648 QEMU_ARCH_ALL)
649 STEXI
650 @item -snapshot
651 @findex -snapshot
652 Write to temporary files instead of disk image files. In this case,
653 the raw disk image you use is not written back. You can however force
654 the write back by pressing @key{C-a s} (@pxref{disk_images}).
655 ETEXI
657 DEF("hdachs", HAS_ARG, QEMU_OPTION_hdachs, \
658 "-hdachs c,h,s[,t]\n" \
659 " force hard disk 0 physical geometry and the optional BIOS\n" \
660 " translation (t=none or lba) (usually QEMU can guess them)\n",
661 QEMU_ARCH_ALL)
662 STEXI
663 @item -hdachs @var{c},@var{h},@var{s},[,@var{t}]
664 @findex -hdachs
665 Force hard disk 0 physical geometry (1 <= @var{c} <= 16383, 1 <=
666 @var{h} <= 16, 1 <= @var{s} <= 63) and optionally force the BIOS
667 translation mode (@var{t}=none, lba or auto). Usually QEMU can guess
668 all those parameters. This option is useful for old MS-DOS disk
669 images.
670 ETEXI
672 DEF("fsdev", HAS_ARG, QEMU_OPTION_fsdev,
673 "-fsdev fsdriver,id=id[,path=path,][security_model={mapped-xattr|mapped-file|passthrough|none}]\n"
674 " [,writeout=immediate][,readonly][,socket=socket|sock_fd=sock_fd]\n",
675 QEMU_ARCH_ALL)
677 STEXI
679 @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}]
680 @findex -fsdev
681 Define a new file system device. Valid options are:
682 @table @option
683 @item @var{fsdriver}
684 This option specifies the fs driver backend to use.
685 Currently "local", "handle" and "proxy" file system drivers are supported.
686 @item id=@var{id}
687 Specifies identifier for this device
688 @item path=@var{path}
689 Specifies the export path for the file system device. Files under
690 this path will be available to the 9p client on the guest.
691 @item security_model=@var{security_model}
692 Specifies the security model to be used for this export path.
693 Supported security models are "passthrough", "mapped-xattr", "mapped-file" and "none".
694 In "passthrough" security model, files are stored using the same
695 credentials as they are created on the guest. This requires QEMU
696 to run as root. In "mapped-xattr" security model, some of the file
697 attributes like uid, gid, mode bits and link target are stored as
698 file attributes. For "mapped-file" these attributes are stored in the
699 hidden .virtfs_metadata directory. Directories exported by this security model cannot
700 interact with other unix tools. "none" security model is same as
701 passthrough except the sever won't report failures if it fails to
702 set file attributes like ownership. Security model is mandatory
703 only for local fsdriver. Other fsdrivers (like handle, proxy) don't take
704 security model as a parameter.
705 @item writeout=@var{writeout}
706 This is an optional argument. The only supported value is "immediate".
707 This means that host page cache will be used to read and write data but
708 write notification will be sent to the guest only when the data has been
709 reported as written by the storage subsystem.
710 @item readonly
711 Enables exporting 9p share as a readonly mount for guests. By default
712 read-write access is given.
713 @item socket=@var{socket}
714 Enables proxy filesystem driver to use passed socket file for communicating
715 with virtfs-proxy-helper
716 @item sock_fd=@var{sock_fd}
717 Enables proxy filesystem driver to use passed socket descriptor for
718 communicating with virtfs-proxy-helper. Usually a helper like libvirt
719 will create socketpair and pass one of the fds as sock_fd
720 @end table
722 -fsdev option is used along with -device driver "virtio-9p-pci".
723 @item -device virtio-9p-pci,fsdev=@var{id},mount_tag=@var{mount_tag}
724 Options for virtio-9p-pci driver are:
725 @table @option
726 @item fsdev=@var{id}
727 Specifies the id value specified along with -fsdev option
728 @item mount_tag=@var{mount_tag}
729 Specifies the tag name to be used by the guest to mount this export point
730 @end table
732 ETEXI
734 DEF("virtfs", HAS_ARG, QEMU_OPTION_virtfs,
735 "-virtfs local,path=path,mount_tag=tag,security_model=[mapped-xattr|mapped-file|passthrough|none]\n"
736 " [,writeout=immediate][,readonly][,socket=socket|sock_fd=sock_fd]\n",
737 QEMU_ARCH_ALL)
739 STEXI
741 @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}]
742 @findex -virtfs
744 The general form of a Virtual File system pass-through options are:
745 @table @option
746 @item @var{fsdriver}
747 This option specifies the fs driver backend to use.
748 Currently "local", "handle" and "proxy" file system drivers are supported.
749 @item id=@var{id}
750 Specifies identifier for this device
751 @item path=@var{path}
752 Specifies the export path for the file system device. Files under
753 this path will be available to the 9p client on the guest.
754 @item security_model=@var{security_model}
755 Specifies the security model to be used for this export path.
756 Supported security models are "passthrough", "mapped-xattr", "mapped-file" and "none".
757 In "passthrough" security model, files are stored using the same
758 credentials as they are created on the guest. This requires QEMU
759 to run as root. In "mapped-xattr" security model, some of the file
760 attributes like uid, gid, mode bits and link target are stored as
761 file attributes. For "mapped-file" these attributes are stored in the
762 hidden .virtfs_metadata directory. Directories exported by this security model cannot
763 interact with other unix tools. "none" security model is same as
764 passthrough except the sever won't report failures if it fails to
765 set file attributes like ownership. Security model is mandatory only
766 for local fsdriver. Other fsdrivers (like handle, proxy) don't take security
767 model as a parameter.
768 @item writeout=@var{writeout}
769 This is an optional argument. The only supported value is "immediate".
770 This means that host page cache will be used to read and write data but
771 write notification will be sent to the guest only when the data has been
772 reported as written by the storage subsystem.
773 @item readonly
774 Enables exporting 9p share as a readonly mount for guests. By default
775 read-write access is given.
776 @item socket=@var{socket}
777 Enables proxy filesystem driver to use passed socket file for
778 communicating with virtfs-proxy-helper. Usually a helper like libvirt
779 will create socketpair and pass one of the fds as sock_fd
780 @item sock_fd
781 Enables proxy filesystem driver to use passed 'sock_fd' as the socket
782 descriptor for interfacing with virtfs-proxy-helper
783 @end table
784 ETEXI
786 DEF("virtfs_synth", 0, QEMU_OPTION_virtfs_synth,
787 "-virtfs_synth Create synthetic file system image\n",
788 QEMU_ARCH_ALL)
789 STEXI
790 @item -virtfs_synth
791 @findex -virtfs_synth
792 Create synthetic file system image
793 ETEXI
795 STEXI
796 @end table
797 ETEXI
798 DEFHEADING()
800 DEFHEADING(USB options:)
801 STEXI
802 @table @option
803 ETEXI
805 DEF("usb", 0, QEMU_OPTION_usb,
806 "-usb enable the USB driver (will be the default soon)\n",
807 QEMU_ARCH_ALL)
808 STEXI
809 @item -usb
810 @findex -usb
811 Enable the USB driver (will be the default soon)
812 ETEXI
814 DEF("usbdevice", HAS_ARG, QEMU_OPTION_usbdevice,
815 "-usbdevice name add the host or guest USB device 'name'\n",
816 QEMU_ARCH_ALL)
817 STEXI
819 @item -usbdevice @var{devname}
820 @findex -usbdevice
821 Add the USB device @var{devname}. @xref{usb_devices}.
823 @table @option
825 @item mouse
826 Virtual Mouse. This will override the PS/2 mouse emulation when activated.
828 @item tablet
829 Pointer device that uses absolute coordinates (like a touchscreen). This
830 means QEMU is able to report the mouse position without having to grab the
831 mouse. Also overrides the PS/2 mouse emulation when activated.
833 @item disk:[format=@var{format}]:@var{file}
834 Mass storage device based on file. The optional @var{format} argument
835 will be used rather than detecting the format. Can be used to specifiy
836 @code{format=raw} to avoid interpreting an untrusted format header.
838 @item host:@var{bus}.@var{addr}
839 Pass through the host device identified by @var{bus}.@var{addr} (Linux only).
841 @item host:@var{vendor_id}:@var{product_id}
842 Pass through the host device identified by @var{vendor_id}:@var{product_id}
843 (Linux only).
845 @item serial:[vendorid=@var{vendor_id}][,productid=@var{product_id}]:@var{dev}
846 Serial converter to host character device @var{dev}, see @code{-serial} for the
847 available devices.
849 @item braille
850 Braille device. This will use BrlAPI to display the braille output on a real
851 or fake device.
853 @item net:@var{options}
854 Network adapter that supports CDC ethernet and RNDIS protocols.
856 @end table
857 ETEXI
859 STEXI
860 @end table
861 ETEXI
862 DEFHEADING()
864 DEFHEADING(Display options:)
865 STEXI
866 @table @option
867 ETEXI
869 DEF("display", HAS_ARG, QEMU_OPTION_display,
870 "-display sdl[,frame=on|off][,alt_grab=on|off][,ctrl_grab=on|off]\n"
871 " [,window_close=on|off]|curses|none|\n"
872 " gtk[,grab_on_hover=on|off]|\n"
873 " vnc=<display>[,<optargs>]\n"
874 " select display type\n", QEMU_ARCH_ALL)
875 STEXI
876 @item -display @var{type}
877 @findex -display
878 Select type of display to use. This option is a replacement for the
879 old style -sdl/-curses/... options. Valid values for @var{type} are
880 @table @option
881 @item sdl
882 Display video output via SDL (usually in a separate graphics
883 window; see the SDL documentation for other possibilities).
884 @item curses
885 Display video output via curses. For graphics device models which
886 support a text mode, QEMU can display this output using a
887 curses/ncurses interface. Nothing is displayed when the graphics
888 device is in graphical mode or if the graphics device does not support
889 a text mode. Generally only the VGA device models support text mode.
890 @item none
891 Do not display video output. The guest will still see an emulated
892 graphics card, but its output will not be displayed to the QEMU
893 user. This option differs from the -nographic option in that it
894 only affects what is done with video output; -nographic also changes
895 the destination of the serial and parallel port data.
896 @item gtk
897 Display video output in a GTK window. This interface provides drop-down
898 menus and other UI elements to configure and control the VM during
899 runtime.
900 @item vnc
901 Start a VNC server on display <arg>
902 @end table
903 ETEXI
905 DEF("nographic", 0, QEMU_OPTION_nographic,
906 "-nographic disable graphical output and redirect serial I/Os to console\n",
907 QEMU_ARCH_ALL)
908 STEXI
909 @item -nographic
910 @findex -nographic
911 Normally, QEMU uses SDL to display the VGA output. With this option,
912 you can totally disable graphical output so that QEMU is a simple
913 command line application. The emulated serial port is redirected on
914 the console and muxed with the monitor (unless redirected elsewhere
915 explicitly). Therefore, you can still use QEMU to debug a Linux kernel
916 with a serial console. Use @key{C-a h} for help on switching between
917 the console and monitor.
918 ETEXI
920 DEF("curses", 0, QEMU_OPTION_curses,
921 "-curses use a curses/ncurses interface instead of SDL\n",
922 QEMU_ARCH_ALL)
923 STEXI
924 @item -curses
925 @findex -curses
926 Normally, QEMU uses SDL to display the VGA output. With this option,
927 QEMU can display the VGA output when in text mode using a
928 curses/ncurses interface. Nothing is displayed in graphical mode.
929 ETEXI
931 DEF("no-frame", 0, QEMU_OPTION_no_frame,
932 "-no-frame open SDL window without a frame and window decorations\n",
933 QEMU_ARCH_ALL)
934 STEXI
935 @item -no-frame
936 @findex -no-frame
937 Do not use decorations for SDL windows and start them using the whole
938 available screen space. This makes the using QEMU in a dedicated desktop
939 workspace more convenient.
940 ETEXI
942 DEF("alt-grab", 0, QEMU_OPTION_alt_grab,
943 "-alt-grab use Ctrl-Alt-Shift to grab mouse (instead of Ctrl-Alt)\n",
944 QEMU_ARCH_ALL)
945 STEXI
946 @item -alt-grab
947 @findex -alt-grab
948 Use Ctrl-Alt-Shift to grab mouse (instead of Ctrl-Alt). Note that this also
949 affects the special keys (for fullscreen, monitor-mode switching, etc).
950 ETEXI
952 DEF("ctrl-grab", 0, QEMU_OPTION_ctrl_grab,
953 "-ctrl-grab use Right-Ctrl to grab mouse (instead of Ctrl-Alt)\n",
954 QEMU_ARCH_ALL)
955 STEXI
956 @item -ctrl-grab
957 @findex -ctrl-grab
958 Use Right-Ctrl to grab mouse (instead of Ctrl-Alt). Note that this also
959 affects the special keys (for fullscreen, monitor-mode switching, etc).
960 ETEXI
962 DEF("no-quit", 0, QEMU_OPTION_no_quit,
963 "-no-quit disable SDL window close capability\n", QEMU_ARCH_ALL)
964 STEXI
965 @item -no-quit
966 @findex -no-quit
967 Disable SDL window close capability.
968 ETEXI
970 DEF("sdl", 0, QEMU_OPTION_sdl,
971 "-sdl enable SDL\n", QEMU_ARCH_ALL)
972 STEXI
973 @item -sdl
974 @findex -sdl
975 Enable SDL.
976 ETEXI
978 DEF("spice", HAS_ARG, QEMU_OPTION_spice,
979 "-spice [port=port][,tls-port=secured-port][,x509-dir=<dir>]\n"
980 " [,x509-key-file=<file>][,x509-key-password=<file>]\n"
981 " [,x509-cert-file=<file>][,x509-cacert-file=<file>]\n"
982 " [,x509-dh-key-file=<file>][,addr=addr][,ipv4|ipv6|unix]\n"
983 " [,tls-ciphers=<list>]\n"
984 " [,tls-channel=[main|display|cursor|inputs|record|playback]]\n"
985 " [,plaintext-channel=[main|display|cursor|inputs|record|playback]]\n"
986 " [,sasl][,password=<secret>][,disable-ticketing]\n"
987 " [,image-compression=[auto_glz|auto_lz|quic|glz|lz|off]]\n"
988 " [,jpeg-wan-compression=[auto|never|always]]\n"
989 " [,zlib-glz-wan-compression=[auto|never|always]]\n"
990 " [,streaming-video=[off|all|filter]][,disable-copy-paste]\n"
991 " [,disable-agent-file-xfer][,agent-mouse=[on|off]]\n"
992 " [,playback-compression=[on|off]][,seamless-migration=[on|off]]\n"
993 " enable spice\n"
994 " at least one of {port, tls-port} is mandatory\n",
995 QEMU_ARCH_ALL)
996 STEXI
997 @item -spice @var{option}[,@var{option}[,...]]
998 @findex -spice
999 Enable the spice remote desktop protocol. Valid options are
1001 @table @option
1003 @item port=<nr>
1004 Set the TCP port spice is listening on for plaintext channels.
1006 @item addr=<addr>
1007 Set the IP address spice is listening on. Default is any address.
1009 @item ipv4
1010 @item ipv6
1011 @item unix
1012 Force using the specified IP version.
1014 @item password=<secret>
1015 Set the password you need to authenticate.
1017 @item sasl
1018 Require that the client use SASL to authenticate with the spice.
1019 The exact choice of authentication method used is controlled from the
1020 system / user's SASL configuration file for the 'qemu' service. This
1021 is typically found in /etc/sasl2/qemu.conf. If running QEMU as an
1022 unprivileged user, an environment variable SASL_CONF_PATH can be used
1023 to make it search alternate locations for the service config.
1024 While some SASL auth methods can also provide data encryption (eg GSSAPI),
1025 it is recommended that SASL always be combined with the 'tls' and
1026 'x509' settings to enable use of SSL and server certificates. This
1027 ensures a data encryption preventing compromise of authentication
1028 credentials.
1030 @item disable-ticketing
1031 Allow client connects without authentication.
1033 @item disable-copy-paste
1034 Disable copy paste between the client and the guest.
1036 @item disable-agent-file-xfer
1037 Disable spice-vdagent based file-xfer between the client and the guest.
1039 @item tls-port=<nr>
1040 Set the TCP port spice is listening on for encrypted channels.
1042 @item x509-dir=<dir>
1043 Set the x509 file directory. Expects same filenames as -vnc $display,x509=$dir
1045 @item x509-key-file=<file>
1046 @item x509-key-password=<file>
1047 @item x509-cert-file=<file>
1048 @item x509-cacert-file=<file>
1049 @item x509-dh-key-file=<file>
1050 The x509 file names can also be configured individually.
1052 @item tls-ciphers=<list>
1053 Specify which ciphers to use.
1055 @item tls-channel=[main|display|cursor|inputs|record|playback]
1056 @item plaintext-channel=[main|display|cursor|inputs|record|playback]
1057 Force specific channel to be used with or without TLS encryption. The
1058 options can be specified multiple times to configure multiple
1059 channels. The special name "default" can be used to set the default
1060 mode. For channels which are not explicitly forced into one mode the
1061 spice client is allowed to pick tls/plaintext as he pleases.
1063 @item image-compression=[auto_glz|auto_lz|quic|glz|lz|off]
1064 Configure image compression (lossless).
1065 Default is auto_glz.
1067 @item jpeg-wan-compression=[auto|never|always]
1068 @item zlib-glz-wan-compression=[auto|never|always]
1069 Configure wan image compression (lossy for slow links).
1070 Default is auto.
1072 @item streaming-video=[off|all|filter]
1073 Configure video stream detection. Default is filter.
1075 @item agent-mouse=[on|off]
1076 Enable/disable passing mouse events via vdagent. Default is on.
1078 @item playback-compression=[on|off]
1079 Enable/disable audio stream compression (using celt 0.5.1). Default is on.
1081 @item seamless-migration=[on|off]
1082 Enable/disable spice seamless migration. Default is off.
1084 @end table
1085 ETEXI
1087 DEF("portrait", 0, QEMU_OPTION_portrait,
1088 "-portrait rotate graphical output 90 deg left (only PXA LCD)\n",
1089 QEMU_ARCH_ALL)
1090 STEXI
1091 @item -portrait
1092 @findex -portrait
1093 Rotate graphical output 90 deg left (only PXA LCD).
1094 ETEXI
1096 DEF("rotate", HAS_ARG, QEMU_OPTION_rotate,
1097 "-rotate <deg> rotate graphical output some deg left (only PXA LCD)\n",
1098 QEMU_ARCH_ALL)
1099 STEXI
1100 @item -rotate @var{deg}
1101 @findex -rotate
1102 Rotate graphical output some deg left (only PXA LCD).
1103 ETEXI
1105 DEF("vga", HAS_ARG, QEMU_OPTION_vga,
1106 "-vga [std|cirrus|vmware|qxl|xenfb|tcx|cg3|virtio|none]\n"
1107 " select video card type\n", QEMU_ARCH_ALL)
1108 STEXI
1109 @item -vga @var{type}
1110 @findex -vga
1111 Select type of VGA card to emulate. Valid values for @var{type} are
1112 @table @option
1113 @item cirrus
1114 Cirrus Logic GD5446 Video card. All Windows versions starting from
1115 Windows 95 should recognize and use this graphic card. For optimal
1116 performances, use 16 bit color depth in the guest and the host OS.
1117 (This one is the default)
1118 @item std
1119 Standard VGA card with Bochs VBE extensions. If your guest OS
1120 supports the VESA 2.0 VBE extensions (e.g. Windows XP) and if you want
1121 to use high resolution modes (>= 1280x1024x16) then you should use
1122 this option.
1123 @item vmware
1124 VMWare SVGA-II compatible adapter. Use it if you have sufficiently
1125 recent XFree86/XOrg server or Windows guest with a driver for this
1126 card.
1127 @item qxl
1128 QXL paravirtual graphic card. It is VGA compatible (including VESA
1129 2.0 VBE support). Works best with qxl guest drivers installed though.
1130 Recommended choice when using the spice protocol.
1131 @item tcx
1132 (sun4m only) Sun TCX framebuffer. This is the default framebuffer for
1133 sun4m machines and offers both 8-bit and 24-bit colour depths at a
1134 fixed resolution of 1024x768.
1135 @item cg3
1136 (sun4m only) Sun cgthree framebuffer. This is a simple 8-bit framebuffer
1137 for sun4m machines available in both 1024x768 (OpenBIOS) and 1152x900 (OBP)
1138 resolutions aimed at people wishing to run older Solaris versions.
1139 @item virtio
1140 Virtio VGA card.
1141 @item none
1142 Disable VGA card.
1143 @end table
1144 ETEXI
1146 DEF("full-screen", 0, QEMU_OPTION_full_screen,
1147 "-full-screen start in full screen\n", QEMU_ARCH_ALL)
1148 STEXI
1149 @item -full-screen
1150 @findex -full-screen
1151 Start in full screen.
1152 ETEXI
1154 DEF("g", 1, QEMU_OPTION_g ,
1155 "-g WxH[xDEPTH] Set the initial graphical resolution and depth\n",
1156 QEMU_ARCH_PPC | QEMU_ARCH_SPARC)
1157 STEXI
1158 @item -g @var{width}x@var{height}[x@var{depth}]
1159 @findex -g
1160 Set the initial graphical resolution and depth (PPC, SPARC only).
1161 ETEXI
1163 DEF("vnc", HAS_ARG, QEMU_OPTION_vnc ,
1164 "-vnc display start a VNC server on display\n", QEMU_ARCH_ALL)
1165 STEXI
1166 @item -vnc @var{display}[,@var{option}[,@var{option}[,...]]]
1167 @findex -vnc
1168 Normally, QEMU uses SDL to display the VGA output. With this option,
1169 you can have QEMU listen on VNC display @var{display} and redirect the VGA
1170 display over the VNC session. It is very useful to enable the usb
1171 tablet device when using this option (option @option{-usbdevice
1172 tablet}). When using the VNC display, you must use the @option{-k}
1173 parameter to set the keyboard layout if you are not using en-us. Valid
1174 syntax for the @var{display} is
1176 @table @option
1178 @item @var{host}:@var{d}
1180 TCP connections will only be allowed from @var{host} on display @var{d}.
1181 By convention the TCP port is 5900+@var{d}. Optionally, @var{host} can
1182 be omitted in which case the server will accept connections from any host.
1184 @item unix:@var{path}
1186 Connections will be allowed over UNIX domain sockets where @var{path} is the
1187 location of a unix socket to listen for connections on.
1189 @item none
1191 VNC is initialized but not started. The monitor @code{change} command
1192 can be used to later start the VNC server.
1194 @end table
1196 Following the @var{display} value there may be one or more @var{option} flags
1197 separated by commas. Valid options are
1199 @table @option
1201 @item reverse
1203 Connect to a listening VNC client via a ``reverse'' connection. The
1204 client is specified by the @var{display}. For reverse network
1205 connections (@var{host}:@var{d},@code{reverse}), the @var{d} argument
1206 is a TCP port number, not a display number.
1208 @item websocket
1210 Opens an additional TCP listening port dedicated to VNC Websocket connections.
1211 By definition the Websocket port is 5700+@var{display}. If @var{host} is
1212 specified connections will only be allowed from this host.
1213 As an alternative the Websocket port could be specified by using
1214 @code{websocket}=@var{port}.
1215 TLS encryption for the Websocket connection is supported if the required
1216 certificates are specified with the VNC option @option{x509}.
1218 @item password
1220 Require that password based authentication is used for client connections.
1222 The password must be set separately using the @code{set_password} command in
1223 the @ref{pcsys_monitor}. The syntax to change your password is:
1224 @code{set_password <protocol> <password>} where <protocol> could be either
1225 "vnc" or "spice".
1227 If you would like to change <protocol> password expiration, you should use
1228 @code{expire_password <protocol> <expiration-time>} where expiration time could
1229 be one of the following options: now, never, +seconds or UNIX time of
1230 expiration, e.g. +60 to make password expire in 60 seconds, or 1335196800
1231 to make password expire on "Mon Apr 23 12:00:00 EDT 2012" (UNIX time for this
1232 date and time).
1234 You can also use keywords "now" or "never" for the expiration time to
1235 allow <protocol> password to expire immediately or never expire.
1237 @item tls
1239 Require that client use TLS when communicating with the VNC server. This
1240 uses anonymous TLS credentials so is susceptible to a man-in-the-middle
1241 attack. It is recommended that this option be combined with either the
1242 @option{x509} or @option{x509verify} options.
1244 @item x509=@var{/path/to/certificate/dir}
1246 Valid if @option{tls} is specified. Require that x509 credentials are used
1247 for negotiating the TLS session. The server will send its x509 certificate
1248 to the client. It is recommended that a password be set on the VNC server
1249 to provide authentication of the client when this is used. The path following
1250 this option specifies where the x509 certificates are to be loaded from.
1251 See the @ref{vnc_security} section for details on generating certificates.
1253 @item x509verify=@var{/path/to/certificate/dir}
1255 Valid if @option{tls} is specified. Require that x509 credentials are used
1256 for negotiating the TLS session. The server will send its x509 certificate
1257 to the client, and request that the client send its own x509 certificate.
1258 The server will validate the client's certificate against the CA certificate,
1259 and reject clients when validation fails. If the certificate authority is
1260 trusted, this is a sufficient authentication mechanism. You may still wish
1261 to set a password on the VNC server as a second authentication layer. The
1262 path following this option specifies where the x509 certificates are to
1263 be loaded from. See the @ref{vnc_security} section for details on generating
1264 certificates.
1266 @item sasl
1268 Require that the client use SASL to authenticate with the VNC server.
1269 The exact choice of authentication method used is controlled from the
1270 system / user's SASL configuration file for the 'qemu' service. This
1271 is typically found in /etc/sasl2/qemu.conf. If running QEMU as an
1272 unprivileged user, an environment variable SASL_CONF_PATH can be used
1273 to make it search alternate locations for the service config.
1274 While some SASL auth methods can also provide data encryption (eg GSSAPI),
1275 it is recommended that SASL always be combined with the 'tls' and
1276 'x509' settings to enable use of SSL and server certificates. This
1277 ensures a data encryption preventing compromise of authentication
1278 credentials. See the @ref{vnc_security} section for details on using
1279 SASL authentication.
1281 @item acl
1283 Turn on access control lists for checking of the x509 client certificate
1284 and SASL party. For x509 certs, the ACL check is made against the
1285 certificate's distinguished name. This is something that looks like
1286 @code{C=GB,O=ACME,L=Boston,CN=bob}. For SASL party, the ACL check is
1287 made against the username, which depending on the SASL plugin, may
1288 include a realm component, eg @code{bob} or @code{bob@@EXAMPLE.COM}.
1289 When the @option{acl} flag is set, the initial access list will be
1290 empty, with a @code{deny} policy. Thus no one will be allowed to
1291 use the VNC server until the ACLs have been loaded. This can be
1292 achieved using the @code{acl} monitor command.
1294 @item lossy
1296 Enable lossy compression methods (gradient, JPEG, ...). If this
1297 option is set, VNC client may receive lossy framebuffer updates
1298 depending on its encoding settings. Enabling this option can save
1299 a lot of bandwidth at the expense of quality.
1301 @item non-adaptive
1303 Disable adaptive encodings. Adaptive encodings are enabled by default.
1304 An adaptive encoding will try to detect frequently updated screen regions,
1305 and send updates in these regions using a lossy encoding (like JPEG).
1306 This can be really helpful to save bandwidth when playing videos. Disabling
1307 adaptive encodings restores the original static behavior of encodings
1308 like Tight.
1310 @item share=[allow-exclusive|force-shared|ignore]
1312 Set display sharing policy. 'allow-exclusive' allows clients to ask
1313 for exclusive access. As suggested by the rfb spec this is
1314 implemented by dropping other connections. Connecting multiple
1315 clients in parallel requires all clients asking for a shared session
1316 (vncviewer: -shared switch). This is the default. 'force-shared'
1317 disables exclusive client access. Useful for shared desktop sessions,
1318 where you don't want someone forgetting specify -shared disconnect
1319 everybody else. 'ignore' completely ignores the shared flag and
1320 allows everybody connect unconditionally. Doesn't conform to the rfb
1321 spec but is traditional QEMU behavior.
1323 @end table
1324 ETEXI
1326 STEXI
1327 @end table
1328 ETEXI
1329 ARCHHEADING(, QEMU_ARCH_I386)
1331 ARCHHEADING(i386 target only:, QEMU_ARCH_I386)
1332 STEXI
1333 @table @option
1334 ETEXI
1336 DEF("win2k-hack", 0, QEMU_OPTION_win2k_hack,
1337 "-win2k-hack use it when installing Windows 2000 to avoid a disk full bug\n",
1338 QEMU_ARCH_I386)
1339 STEXI
1340 @item -win2k-hack
1341 @findex -win2k-hack
1342 Use it when installing Windows 2000 to avoid a disk full bug. After
1343 Windows 2000 is installed, you no longer need this option (this option
1344 slows down the IDE transfers).
1345 ETEXI
1347 HXCOMM Deprecated by -rtc
1348 DEF("rtc-td-hack", 0, QEMU_OPTION_rtc_td_hack, "", QEMU_ARCH_I386)
1350 DEF("no-fd-bootchk", 0, QEMU_OPTION_no_fd_bootchk,
1351 "-no-fd-bootchk disable boot signature checking for floppy disks\n",
1352 QEMU_ARCH_I386)
1353 STEXI
1354 @item -no-fd-bootchk
1355 @findex -no-fd-bootchk
1356 Disable boot signature checking for floppy disks in BIOS. May
1357 be needed to boot from old floppy disks.
1358 ETEXI
1360 DEF("no-acpi", 0, QEMU_OPTION_no_acpi,
1361 "-no-acpi disable ACPI\n", QEMU_ARCH_I386 | QEMU_ARCH_ARM)
1362 STEXI
1363 @item -no-acpi
1364 @findex -no-acpi
1365 Disable ACPI (Advanced Configuration and Power Interface) support. Use
1366 it if your guest OS complains about ACPI problems (PC target machine
1367 only).
1368 ETEXI
1370 DEF("no-hpet", 0, QEMU_OPTION_no_hpet,
1371 "-no-hpet disable HPET\n", QEMU_ARCH_I386)
1372 STEXI
1373 @item -no-hpet
1374 @findex -no-hpet
1375 Disable HPET support.
1376 ETEXI
1378 DEF("acpitable", HAS_ARG, QEMU_OPTION_acpitable,
1379 "-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"
1380 " ACPI table description\n", QEMU_ARCH_I386)
1381 STEXI
1382 @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}]...]
1383 @findex -acpitable
1384 Add ACPI table with specified header fields and context from specified files.
1385 For file=, take whole ACPI table from the specified files, including all
1386 ACPI headers (possible overridden by other options).
1387 For data=, only data
1388 portion of the table is used, all header information is specified in the
1389 command line.
1390 ETEXI
1392 DEF("smbios", HAS_ARG, QEMU_OPTION_smbios,
1393 "-smbios file=binary\n"
1394 " load SMBIOS entry from binary file\n"
1395 "-smbios type=0[,vendor=str][,version=str][,date=str][,release=%d.%d]\n"
1396 " [,uefi=on|off]\n"
1397 " specify SMBIOS type 0 fields\n"
1398 "-smbios type=1[,manufacturer=str][,product=str][,version=str][,serial=str]\n"
1399 " [,uuid=uuid][,sku=str][,family=str]\n"
1400 " specify SMBIOS type 1 fields\n"
1401 "-smbios type=2[,manufacturer=str][,product=str][,version=str][,serial=str]\n"
1402 " [,asset=str][,location=str]\n"
1403 " specify SMBIOS type 2 fields\n"
1404 "-smbios type=3[,manufacturer=str][,version=str][,serial=str][,asset=str]\n"
1405 " [,sku=str]\n"
1406 " specify SMBIOS type 3 fields\n"
1407 "-smbios type=4[,sock_pfx=str][,manufacturer=str][,version=str][,serial=str]\n"
1408 " [,asset=str][,part=str]\n"
1409 " specify SMBIOS type 4 fields\n"
1410 "-smbios type=17[,loc_pfx=str][,bank=str][,manufacturer=str][,serial=str]\n"
1411 " [,asset=str][,part=str][,speed=%d]\n"
1412 " specify SMBIOS type 17 fields\n",
1413 QEMU_ARCH_I386)
1414 STEXI
1415 @item -smbios file=@var{binary}
1416 @findex -smbios
1417 Load SMBIOS entry from binary file.
1419 @item -smbios type=0[,vendor=@var{str}][,version=@var{str}][,date=@var{str}][,release=@var{%d.%d}][,uefi=on|off]
1420 Specify SMBIOS type 0 fields
1422 @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}]
1423 Specify SMBIOS type 1 fields
1425 @item -smbios type=2[,manufacturer=@var{str}][,product=@var{str}][,version=@var{str}][,serial=@var{str}][,asset=@var{str}][,location=@var{str}][,family=@var{str}]
1426 Specify SMBIOS type 2 fields
1428 @item -smbios type=3[,manufacturer=@var{str}][,version=@var{str}][,serial=@var{str}][,asset=@var{str}][,sku=@var{str}]
1429 Specify SMBIOS type 3 fields
1431 @item -smbios type=4[,sock_pfx=@var{str}][,manufacturer=@var{str}][,version=@var{str}][,serial=@var{str}][,asset=@var{str}][,part=@var{str}]
1432 Specify SMBIOS type 4 fields
1434 @item -smbios type=17[,loc_pfx=@var{str}][,bank=@var{str}][,manufacturer=@var{str}][,serial=@var{str}][,asset=@var{str}][,part=@var{str}][,speed=@var{%d}]
1435 Specify SMBIOS type 17 fields
1436 ETEXI
1438 STEXI
1439 @end table
1440 ETEXI
1441 DEFHEADING()
1443 DEFHEADING(Network options:)
1444 STEXI
1445 @table @option
1446 ETEXI
1448 HXCOMM Legacy slirp options (now moved to -net user):
1449 #ifdef CONFIG_SLIRP
1450 DEF("tftp", HAS_ARG, QEMU_OPTION_tftp, "", QEMU_ARCH_ALL)
1451 DEF("bootp", HAS_ARG, QEMU_OPTION_bootp, "", QEMU_ARCH_ALL)
1452 DEF("redir", HAS_ARG, QEMU_OPTION_redir, "", QEMU_ARCH_ALL)
1453 #ifndef _WIN32
1454 DEF("smb", HAS_ARG, QEMU_OPTION_smb, "", QEMU_ARCH_ALL)
1455 #endif
1456 #endif
1458 DEF("netdev", HAS_ARG, QEMU_OPTION_netdev,
1459 #ifdef CONFIG_SLIRP
1460 "-netdev user,id=str[,net=addr[/mask]][,host=addr][,restrict=on|off]\n"
1461 " [,hostname=host][,dhcpstart=addr][,dns=addr][,dnssearch=domain][,tftp=dir]\n"
1462 " [,bootfile=f][,hostfwd=rule][,guestfwd=rule]"
1463 #ifndef _WIN32
1464 "[,smb=dir[,smbserver=addr]]\n"
1465 #endif
1466 " configure a user mode network backend with ID 'str',\n"
1467 " its DHCP server and optional services\n"
1468 #endif
1469 #ifdef _WIN32
1470 "-netdev tap,id=str,ifname=name\n"
1471 " configure a host TAP network backend with ID 'str'\n"
1472 #else
1473 "-netdev tap,id=str[,fd=h][,fds=x:y:...:z][,ifname=name][,script=file][,downscript=dfile]\n"
1474 " [,helper=helper][,sndbuf=nbytes][,vnet_hdr=on|off][,vhost=on|off]\n"
1475 " [,vhostfd=h][,vhostfds=x:y:...:z][,vhostforce=on|off][,queues=n]\n"
1476 " configure a host TAP network backend with ID 'str'\n"
1477 " use network scripts 'file' (default=" DEFAULT_NETWORK_SCRIPT ")\n"
1478 " to configure it and 'dfile' (default=" DEFAULT_NETWORK_DOWN_SCRIPT ")\n"
1479 " to deconfigure it\n"
1480 " use '[down]script=no' to disable script execution\n"
1481 " use network helper 'helper' (default=" DEFAULT_BRIDGE_HELPER ") to\n"
1482 " configure it\n"
1483 " use 'fd=h' to connect to an already opened TAP interface\n"
1484 " use 'fds=x:y:...:z' to connect to already opened multiqueue capable TAP interfaces\n"
1485 " use 'sndbuf=nbytes' to limit the size of the send buffer (the\n"
1486 " default is disabled 'sndbuf=0' to enable flow control set 'sndbuf=1048576')\n"
1487 " use vnet_hdr=off to avoid enabling the IFF_VNET_HDR tap flag\n"
1488 " use vnet_hdr=on to make the lack of IFF_VNET_HDR support an error condition\n"
1489 " use vhost=on to enable experimental in kernel accelerator\n"
1490 " (only has effect for virtio guests which use MSIX)\n"
1491 " use vhostforce=on to force vhost on for non-MSIX virtio guests\n"
1492 " use 'vhostfd=h' to connect to an already opened vhost net device\n"
1493 " use 'vhostfds=x:y:...:z to connect to multiple already opened vhost net devices\n"
1494 " use 'queues=n' to specify the number of queues to be created for multiqueue TAP\n"
1495 "-netdev bridge,id=str[,br=bridge][,helper=helper]\n"
1496 " configure a host TAP network backend with ID 'str' that is\n"
1497 " connected to a bridge (default=" DEFAULT_BRIDGE_INTERFACE ")\n"
1498 " using the program 'helper (default=" DEFAULT_BRIDGE_HELPER ")\n"
1499 #endif
1500 #ifdef __linux__
1501 "-netdev l2tpv3,id=str,src=srcaddr,dst=dstaddr[,srcport=srcport][,dstport=dstport]\n"
1502 " [,rxsession=rxsession],txsession=txsession[,ipv6=on/off][,udp=on/off]\n"
1503 " [,cookie64=on/off][,counter][,pincounter][,txcookie=txcookie]\n"
1504 " [,rxcookie=rxcookie][,offset=offset]\n"
1505 " configure a network backend with ID 'str' connected to\n"
1506 " an Ethernet over L2TPv3 pseudowire.\n"
1507 " Linux kernel 3.3+ as well as most routers can talk\n"
1508 " L2TPv3. This transport allows connecting a VM to a VM,\n"
1509 " VM to a router and even VM to Host. It is a nearly-universal\n"
1510 " standard (RFC3391). Note - this implementation uses static\n"
1511 " pre-configured tunnels (same as the Linux kernel).\n"
1512 " use 'src=' to specify source address\n"
1513 " use 'dst=' to specify destination address\n"
1514 " use 'udp=on' to specify udp encapsulation\n"
1515 " use 'srcport=' to specify source udp port\n"
1516 " use 'dstport=' to specify destination udp port\n"
1517 " use 'ipv6=on' to force v6\n"
1518 " L2TPv3 uses cookies to prevent misconfiguration as\n"
1519 " well as a weak security measure\n"
1520 " use 'rxcookie=0x012345678' to specify a rxcookie\n"
1521 " use 'txcookie=0x012345678' to specify a txcookie\n"
1522 " use 'cookie64=on' to set cookie size to 64 bit, otherwise 32\n"
1523 " use 'counter=off' to force a 'cut-down' L2TPv3 with no counter\n"
1524 " use 'pincounter=on' to work around broken counter handling in peer\n"
1525 " use 'offset=X' to add an extra offset between header and data\n"
1526 #endif
1527 "-netdev socket,id=str[,fd=h][,listen=[host]:port][,connect=host:port]\n"
1528 " configure a network backend to connect to another network\n"
1529 " using a socket connection\n"
1530 "-netdev socket,id=str[,fd=h][,mcast=maddr:port[,localaddr=addr]]\n"
1531 " configure a network backend to connect to a multicast maddr and port\n"
1532 " use 'localaddr=addr' to specify the host address to send packets from\n"
1533 "-netdev socket,id=str[,fd=h][,udp=host:port][,localaddr=host:port]\n"
1534 " configure a network backend to connect to another network\n"
1535 " using an UDP tunnel\n"
1536 #ifdef CONFIG_VDE
1537 "-netdev vde,id=str[,sock=socketpath][,port=n][,group=groupname][,mode=octalmode]\n"
1538 " configure a network backend to connect to port 'n' of a vde switch\n"
1539 " running on host and listening for incoming connections on 'socketpath'.\n"
1540 " Use group 'groupname' and mode 'octalmode' to change default\n"
1541 " ownership and permissions for communication port.\n"
1542 #endif
1543 #ifdef CONFIG_NETMAP
1544 "-netdev netmap,id=str,ifname=name[,devname=nmname]\n"
1545 " attach to the existing netmap-enabled network interface 'name', or to a\n"
1546 " VALE port (created on the fly) called 'name' ('nmname' is name of the \n"
1547 " netmap device, defaults to '/dev/netmap')\n"
1548 #endif
1549 "-netdev vhost-user,id=str,chardev=dev[,vhostforce=on|off]\n"
1550 " configure a vhost-user network, backed by a chardev 'dev'\n"
1551 "-netdev hubport,id=str,hubid=n\n"
1552 " configure a hub port on QEMU VLAN 'n'\n", QEMU_ARCH_ALL)
1553 DEF("net", HAS_ARG, QEMU_OPTION_net,
1554 "-net nic[,vlan=n][,macaddr=mac][,model=type][,name=str][,addr=str][,vectors=v]\n"
1555 " old way to create a new NIC and connect it to VLAN 'n'\n"
1556 " (use the '-device devtype,netdev=str' option if possible instead)\n"
1557 "-net dump[,vlan=n][,file=f][,len=n]\n"
1558 " dump traffic on vlan 'n' to file 'f' (max n bytes per packet)\n"
1559 "-net none use it alone to have zero network devices. If no -net option\n"
1560 " is provided, the default is '-net nic -net user'\n"
1561 "-net ["
1562 #ifdef CONFIG_SLIRP
1563 "user|"
1564 #endif
1565 "tap|"
1566 "bridge|"
1567 #ifdef CONFIG_VDE
1568 "vde|"
1569 #endif
1570 #ifdef CONFIG_NETMAP
1571 "netmap|"
1572 #endif
1573 "socket][,vlan=n][,option][,option][,...]\n"
1574 " old way to initialize a host network interface\n"
1575 " (use the -netdev option if possible instead)\n", QEMU_ARCH_ALL)
1576 STEXI
1577 @item -net nic[,vlan=@var{n}][,macaddr=@var{mac}][,model=@var{type}] [,name=@var{name}][,addr=@var{addr}][,vectors=@var{v}]
1578 @findex -net
1579 Create a new Network Interface Card and connect it to VLAN @var{n} (@var{n}
1580 = 0 is the default). The NIC is an e1000 by default on the PC
1581 target. Optionally, the MAC address can be changed to @var{mac}, the
1582 device address set to @var{addr} (PCI cards only),
1583 and a @var{name} can be assigned for use in monitor commands.
1584 Optionally, for PCI cards, you can specify the number @var{v} of MSI-X vectors
1585 that the card should have; this option currently only affects virtio cards; set
1586 @var{v} = 0 to disable MSI-X. If no @option{-net} option is specified, a single
1587 NIC is created. QEMU can emulate several different models of network card.
1588 Valid values for @var{type} are
1589 @code{virtio}, @code{i82551}, @code{i82557b}, @code{i82559er},
1590 @code{ne2k_pci}, @code{ne2k_isa}, @code{pcnet}, @code{rtl8139},
1591 @code{e1000}, @code{smc91c111}, @code{lance} and @code{mcf_fec}.
1592 Not all devices are supported on all targets. Use @code{-net nic,model=help}
1593 for a list of available devices for your target.
1595 @item -netdev user,id=@var{id}[,@var{option}][,@var{option}][,...]
1596 @findex -netdev
1597 @item -net user[,@var{option}][,@var{option}][,...]
1598 Use the user mode network stack which requires no administrator
1599 privilege to run. Valid options are:
1601 @table @option
1602 @item vlan=@var{n}
1603 Connect user mode stack to VLAN @var{n} (@var{n} = 0 is the default).
1605 @item id=@var{id}
1606 @item name=@var{name}
1607 Assign symbolic name for use in monitor commands.
1609 @item net=@var{addr}[/@var{mask}]
1610 Set IP network address the guest will see. Optionally specify the netmask,
1611 either in the form a.b.c.d or as number of valid top-most bits. Default is
1612 10.0.2.0/24.
1614 @item host=@var{addr}
1615 Specify the guest-visible address of the host. Default is the 2nd IP in the
1616 guest network, i.e. x.x.x.2.
1618 @item restrict=on|off
1619 If this option is enabled, the guest will be isolated, i.e. it will not be
1620 able to contact the host and no guest IP packets will be routed over the host
1621 to the outside. This option does not affect any explicitly set forwarding rules.
1623 @item hostname=@var{name}
1624 Specifies the client hostname reported by the built-in DHCP server.
1626 @item dhcpstart=@var{addr}
1627 Specify the first of the 16 IPs the built-in DHCP server can assign. Default
1628 is the 15th to 31st IP in the guest network, i.e. x.x.x.15 to x.x.x.31.
1630 @item dns=@var{addr}
1631 Specify the guest-visible address of the virtual nameserver. The address must
1632 be different from the host address. Default is the 3rd IP in the guest network,
1633 i.e. x.x.x.3.
1635 @item dnssearch=@var{domain}
1636 Provides an entry for the domain-search list sent by the built-in
1637 DHCP server. More than one domain suffix can be transmitted by specifying
1638 this option multiple times. If supported, this will cause the guest to
1639 automatically try to append the given domain suffix(es) in case a domain name
1640 can not be resolved.
1642 Example:
1643 @example
1644 qemu -net user,dnssearch=mgmt.example.org,dnssearch=example.org [...]
1645 @end example
1647 @item tftp=@var{dir}
1648 When using the user mode network stack, activate a built-in TFTP
1649 server. The files in @var{dir} will be exposed as the root of a TFTP server.
1650 The TFTP client on the guest must be configured in binary mode (use the command
1651 @code{bin} of the Unix TFTP client).
1653 @item bootfile=@var{file}
1654 When using the user mode network stack, broadcast @var{file} as the BOOTP
1655 filename. In conjunction with @option{tftp}, this can be used to network boot
1656 a guest from a local directory.
1658 Example (using pxelinux):
1659 @example
1660 qemu-system-i386 -hda linux.img -boot n -net user,tftp=/path/to/tftp/files,bootfile=/pxelinux.0
1661 @end example
1663 @item smb=@var{dir}[,smbserver=@var{addr}]
1664 When using the user mode network stack, activate a built-in SMB
1665 server so that Windows OSes can access to the host files in @file{@var{dir}}
1666 transparently. The IP address of the SMB server can be set to @var{addr}. By
1667 default the 4th IP in the guest network is used, i.e. x.x.x.4.
1669 In the guest Windows OS, the line:
1670 @example
1671 10.0.2.4 smbserver
1672 @end example
1673 must be added in the file @file{C:\WINDOWS\LMHOSTS} (for windows 9x/Me)
1674 or @file{C:\WINNT\SYSTEM32\DRIVERS\ETC\LMHOSTS} (Windows NT/2000).
1676 Then @file{@var{dir}} can be accessed in @file{\\smbserver\qemu}.
1678 Note that a SAMBA server must be installed on the host OS.
1679 QEMU was tested successfully with smbd versions from Red Hat 9,
1680 Fedora Core 3 and OpenSUSE 11.x.
1682 @item hostfwd=[tcp|udp]:[@var{hostaddr}]:@var{hostport}-[@var{guestaddr}]:@var{guestport}
1683 Redirect incoming TCP or UDP connections to the host port @var{hostport} to
1684 the guest IP address @var{guestaddr} on guest port @var{guestport}. If
1685 @var{guestaddr} is not specified, its value is x.x.x.15 (default first address
1686 given by the built-in DHCP server). By specifying @var{hostaddr}, the rule can
1687 be bound to a specific host interface. If no connection type is set, TCP is
1688 used. This option can be given multiple times.
1690 For example, to redirect host X11 connection from screen 1 to guest
1691 screen 0, use the following:
1693 @example
1694 # on the host
1695 qemu-system-i386 -net user,hostfwd=tcp:127.0.0.1:6001-:6000 [...]
1696 # this host xterm should open in the guest X11 server
1697 xterm -display :1
1698 @end example
1700 To redirect telnet connections from host port 5555 to telnet port on
1701 the guest, use the following:
1703 @example
1704 # on the host
1705 qemu-system-i386 -net user,hostfwd=tcp::5555-:23 [...]
1706 telnet localhost 5555
1707 @end example
1709 Then when you use on the host @code{telnet localhost 5555}, you
1710 connect to the guest telnet server.
1712 @item guestfwd=[tcp]:@var{server}:@var{port}-@var{dev}
1713 @item guestfwd=[tcp]:@var{server}:@var{port}-@var{cmd:command}
1714 Forward guest TCP connections to the IP address @var{server} on port @var{port}
1715 to the character device @var{dev} or to a program executed by @var{cmd:command}
1716 which gets spawned for each connection. This option can be given multiple times.
1718 You can either use a chardev directly and have that one used throughout QEMU's
1719 lifetime, like in the following example:
1721 @example
1722 # open 10.10.1.1:4321 on bootup, connect 10.0.2.100:1234 to it whenever
1723 # the guest accesses it
1724 qemu -net user,guestfwd=tcp:10.0.2.100:1234-tcp:10.10.1.1:4321 [...]
1725 @end example
1727 Or you can execute a command on every TCP connection established by the guest,
1728 so that QEMU behaves similar to an inetd process for that virtual server:
1730 @example
1731 # call "netcat 10.10.1.1 4321" on every TCP connection to 10.0.2.100:1234
1732 # and connect the TCP stream to its stdin/stdout
1733 qemu -net 'user,guestfwd=tcp:10.0.2.100:1234-cmd:netcat 10.10.1.1 4321'
1734 @end example
1736 @end table
1738 Note: Legacy stand-alone options -tftp, -bootp, -smb and -redir are still
1739 processed and applied to -net user. Mixing them with the new configuration
1740 syntax gives undefined results. Their use for new applications is discouraged
1741 as they will be removed from future versions.
1743 @item -netdev tap,id=@var{id}[,fd=@var{h}][,ifname=@var{name}][,script=@var{file}][,downscript=@var{dfile}][,helper=@var{helper}]
1744 @item -net tap[,vlan=@var{n}][,name=@var{name}][,fd=@var{h}][,ifname=@var{name}][,script=@var{file}][,downscript=@var{dfile}][,helper=@var{helper}]
1745 Connect the host TAP network interface @var{name} to VLAN @var{n}.
1747 Use the network script @var{file} to configure it and the network script
1748 @var{dfile} to deconfigure it. If @var{name} is not provided, the OS
1749 automatically provides one. The default network configure script is
1750 @file{/etc/qemu-ifup} and the default network deconfigure script is
1751 @file{/etc/qemu-ifdown}. Use @option{script=no} or @option{downscript=no}
1752 to disable script execution.
1754 If running QEMU as an unprivileged user, use the network helper
1755 @var{helper} to configure the TAP interface. The default network
1756 helper executable is @file{/path/to/qemu-bridge-helper}.
1758 @option{fd}=@var{h} can be used to specify the handle of an already
1759 opened host TAP interface.
1761 Examples:
1763 @example
1764 #launch a QEMU instance with the default network script
1765 qemu-system-i386 linux.img -net nic -net tap
1766 @end example
1768 @example
1769 #launch a QEMU instance with two NICs, each one connected
1770 #to a TAP device
1771 qemu-system-i386 linux.img \
1772 -net nic,vlan=0 -net tap,vlan=0,ifname=tap0 \
1773 -net nic,vlan=1 -net tap,vlan=1,ifname=tap1
1774 @end example
1776 @example
1777 #launch a QEMU instance with the default network helper to
1778 #connect a TAP device to bridge br0
1779 qemu-system-i386 linux.img \
1780 -net nic -net tap,"helper=/path/to/qemu-bridge-helper"
1781 @end example
1783 @item -netdev bridge,id=@var{id}[,br=@var{bridge}][,helper=@var{helper}]
1784 @item -net bridge[,vlan=@var{n}][,name=@var{name}][,br=@var{bridge}][,helper=@var{helper}]
1785 Connect a host TAP network interface to a host bridge device.
1787 Use the network helper @var{helper} to configure the TAP interface and
1788 attach it to the bridge. The default network helper executable is
1789 @file{/path/to/qemu-bridge-helper} and the default bridge
1790 device is @file{br0}.
1792 Examples:
1794 @example
1795 #launch a QEMU instance with the default network helper to
1796 #connect a TAP device to bridge br0
1797 qemu-system-i386 linux.img -net bridge -net nic,model=virtio
1798 @end example
1800 @example
1801 #launch a QEMU instance with the default network helper to
1802 #connect a TAP device to bridge qemubr0
1803 qemu-system-i386 linux.img -net bridge,br=qemubr0 -net nic,model=virtio
1804 @end example
1806 @item -netdev socket,id=@var{id}[,fd=@var{h}][,listen=[@var{host}]:@var{port}][,connect=@var{host}:@var{port}]
1807 @item -net socket[,vlan=@var{n}][,name=@var{name}][,fd=@var{h}] [,listen=[@var{host}]:@var{port}][,connect=@var{host}:@var{port}]
1809 Connect the VLAN @var{n} to a remote VLAN in another QEMU virtual
1810 machine using a TCP socket connection. If @option{listen} is
1811 specified, QEMU waits for incoming connections on @var{port}
1812 (@var{host} is optional). @option{connect} is used to connect to
1813 another QEMU instance using the @option{listen} option. @option{fd}=@var{h}
1814 specifies an already opened TCP socket.
1816 Example:
1817 @example
1818 # launch a first QEMU instance
1819 qemu-system-i386 linux.img \
1820 -net nic,macaddr=52:54:00:12:34:56 \
1821 -net socket,listen=:1234
1822 # connect the VLAN 0 of this instance to the VLAN 0
1823 # of the first instance
1824 qemu-system-i386 linux.img \
1825 -net nic,macaddr=52:54:00:12:34:57 \
1826 -net socket,connect=127.0.0.1:1234
1827 @end example
1829 @item -netdev socket,id=@var{id}[,fd=@var{h}][,mcast=@var{maddr}:@var{port}[,localaddr=@var{addr}]]
1830 @item -net socket[,vlan=@var{n}][,name=@var{name}][,fd=@var{h}][,mcast=@var{maddr}:@var{port}[,localaddr=@var{addr}]]
1832 Create a VLAN @var{n} shared with another QEMU virtual
1833 machines using a UDP multicast socket, effectively making a bus for
1834 every QEMU with same multicast address @var{maddr} and @var{port}.
1835 NOTES:
1836 @enumerate
1837 @item
1838 Several QEMU can be running on different hosts and share same bus (assuming
1839 correct multicast setup for these hosts).
1840 @item
1841 mcast support is compatible with User Mode Linux (argument @option{eth@var{N}=mcast}), see
1842 @url{http://user-mode-linux.sf.net}.
1843 @item
1844 Use @option{fd=h} to specify an already opened UDP multicast socket.
1845 @end enumerate
1847 Example:
1848 @example
1849 # launch one QEMU instance
1850 qemu-system-i386 linux.img \
1851 -net nic,macaddr=52:54:00:12:34:56 \
1852 -net socket,mcast=230.0.0.1:1234
1853 # launch another QEMU instance on same "bus"
1854 qemu-system-i386 linux.img \
1855 -net nic,macaddr=52:54:00:12:34:57 \
1856 -net socket,mcast=230.0.0.1:1234
1857 # launch yet another QEMU instance on same "bus"
1858 qemu-system-i386 linux.img \
1859 -net nic,macaddr=52:54:00:12:34:58 \
1860 -net socket,mcast=230.0.0.1:1234
1861 @end example
1863 Example (User Mode Linux compat.):
1864 @example
1865 # launch QEMU instance (note mcast address selected
1866 # is UML's default)
1867 qemu-system-i386 linux.img \
1868 -net nic,macaddr=52:54:00:12:34:56 \
1869 -net socket,mcast=239.192.168.1:1102
1870 # launch UML
1871 /path/to/linux ubd0=/path/to/root_fs eth0=mcast
1872 @end example
1874 Example (send packets from host's 1.2.3.4):
1875 @example
1876 qemu-system-i386 linux.img \
1877 -net nic,macaddr=52:54:00:12:34:56 \
1878 -net socket,mcast=239.192.168.1:1102,localaddr=1.2.3.4
1879 @end example
1881 @item -netdev l2tpv3,id=@var{id},src=@var{srcaddr},dst=@var{dstaddr}[,srcport=@var{srcport}][,dstport=@var{dstport}],txsession=@var{txsession}[,rxsession=@var{rxsession}][,ipv6][,udp][,cookie64][,counter][,pincounter][,txcookie=@var{txcookie}][,rxcookie=@var{rxcookie}][,offset=@var{offset}]
1882 @item -net l2tpv3[,vlan=@var{n}][,name=@var{name}],src=@var{srcaddr},dst=@var{dstaddr}[,srcport=@var{srcport}][,dstport=@var{dstport}],txsession=@var{txsession}[,rxsession=@var{rxsession}][,ipv6][,udp][,cookie64][,counter][,pincounter][,txcookie=@var{txcookie}][,rxcookie=@var{rxcookie}][,offset=@var{offset}]
1883 Connect VLAN @var{n} to L2TPv3 pseudowire. L2TPv3 (RFC3391) is a popular
1884 protocol to transport Ethernet (and other Layer 2) data frames between
1885 two systems. It is present in routers, firewalls and the Linux kernel
1886 (from version 3.3 onwards).
1888 This transport allows a VM to communicate to another VM, router or firewall directly.
1890 @item src=@var{srcaddr}
1891 source address (mandatory)
1892 @item dst=@var{dstaddr}
1893 destination address (mandatory)
1894 @item udp
1895 select udp encapsulation (default is ip).
1896 @item srcport=@var{srcport}
1897 source udp port.
1898 @item dstport=@var{dstport}
1899 destination udp port.
1900 @item ipv6
1901 force v6, otherwise defaults to v4.
1902 @item rxcookie=@var{rxcookie}
1903 @item txcookie=@var{txcookie}
1904 Cookies are a weak form of security in the l2tpv3 specification.
1905 Their function is mostly to prevent misconfiguration. By default they are 32
1906 bit.
1907 @item cookie64
1908 Set cookie size to 64 bit instead of the default 32
1909 @item counter=off
1910 Force a 'cut-down' L2TPv3 with no counter as in
1911 draft-mkonstan-l2tpext-keyed-ipv6-tunnel-00
1912 @item pincounter=on
1913 Work around broken counter handling in peer. This may also help on
1914 networks which have packet reorder.
1915 @item offset=@var{offset}
1916 Add an extra offset between header and data
1918 For example, to attach a VM running on host 4.3.2.1 via L2TPv3 to the bridge br-lan
1919 on the remote Linux host 1.2.3.4:
1920 @example
1921 # Setup tunnel on linux host using raw ip as encapsulation
1922 # on 1.2.3.4
1923 ip l2tp add tunnel remote 4.3.2.1 local 1.2.3.4 tunnel_id 1 peer_tunnel_id 1 \
1924 encap udp udp_sport 16384 udp_dport 16384
1925 ip l2tp add session tunnel_id 1 name vmtunnel0 session_id \
1926 0xFFFFFFFF peer_session_id 0xFFFFFFFF
1927 ifconfig vmtunnel0 mtu 1500
1928 ifconfig vmtunnel0 up
1929 brctl addif br-lan vmtunnel0
1932 # on 4.3.2.1
1933 # launch QEMU instance - if your network has reorder or is very lossy add ,pincounter
1935 qemu-system-i386 linux.img -net nic -net l2tpv3,src=4.2.3.1,dst=1.2.3.4,udp,srcport=16384,dstport=16384,rxsession=0xffffffff,txsession=0xffffffff,counter
1938 @end example
1940 @item -netdev vde,id=@var{id}[,sock=@var{socketpath}][,port=@var{n}][,group=@var{groupname}][,mode=@var{octalmode}]
1941 @item -net vde[,vlan=@var{n}][,name=@var{name}][,sock=@var{socketpath}] [,port=@var{n}][,group=@var{groupname}][,mode=@var{octalmode}]
1942 Connect VLAN @var{n} to PORT @var{n} of a vde switch running on host and
1943 listening for incoming connections on @var{socketpath}. Use GROUP @var{groupname}
1944 and MODE @var{octalmode} to change default ownership and permissions for
1945 communication port. This option is only available if QEMU has been compiled
1946 with vde support enabled.
1948 Example:
1949 @example
1950 # launch vde switch
1951 vde_switch -F -sock /tmp/myswitch
1952 # launch QEMU instance
1953 qemu-system-i386 linux.img -net nic -net vde,sock=/tmp/myswitch
1954 @end example
1956 @item -netdev hubport,id=@var{id},hubid=@var{hubid}
1958 Create a hub port on QEMU "vlan" @var{hubid}.
1960 The hubport netdev lets you connect a NIC to a QEMU "vlan" instead of a single
1961 netdev. @code{-net} and @code{-device} with parameter @option{vlan} create the
1962 required hub automatically.
1964 @item -netdev vhost-user,chardev=@var{id}[,vhostforce=on|off][,queues=n]
1966 Establish a vhost-user netdev, backed by a chardev @var{id}. The chardev should
1967 be a unix domain socket backed one. The vhost-user uses a specifically defined
1968 protocol to pass vhost ioctl replacement messages to an application on the other
1969 end of the socket. On non-MSIX guests, the feature can be forced with
1970 @var{vhostforce}. Use 'queues=@var{n}' to specify the number of queues to
1971 be created for multiqueue vhost-user.
1973 Example:
1974 @example
1975 qemu -m 512 -object memory-backend-file,id=mem,size=512M,mem-path=/hugetlbfs,share=on \
1976 -numa node,memdev=mem \
1977 -chardev socket,path=/path/to/socket \
1978 -netdev type=vhost-user,id=net0,chardev=chr0 \
1979 -device virtio-net-pci,netdev=net0
1980 @end example
1982 @item -net dump[,vlan=@var{n}][,file=@var{file}][,len=@var{len}]
1983 Dump network traffic on VLAN @var{n} to file @var{file} (@file{qemu-vlan0.pcap} by default).
1984 At most @var{len} bytes (64k by default) per packet are stored. The file format is
1985 libpcap, so it can be analyzed with tools such as tcpdump or Wireshark.
1987 @item -net none
1988 Indicate that no network devices should be configured. It is used to
1989 override the default configuration (@option{-net nic -net user}) which
1990 is activated if no @option{-net} options are provided.
1991 ETEXI
1993 STEXI
1994 @end table
1995 ETEXI
1996 DEFHEADING()
1998 DEFHEADING(Character device options:)
1999 STEXI
2001 The general form of a character device option is:
2002 @table @option
2003 ETEXI
2005 DEF("chardev", HAS_ARG, QEMU_OPTION_chardev,
2006 "-chardev null,id=id[,mux=on|off]\n"
2007 "-chardev socket,id=id[,host=host],port=port[,to=to][,ipv4][,ipv6][,nodelay][,reconnect=seconds]\n"
2008 " [,server][,nowait][,telnet][,reconnect=seconds][,mux=on|off] (tcp)\n"
2009 "-chardev socket,id=id,path=path[,server][,nowait][,telnet][,reconnect=seconds][,mux=on|off] (unix)\n"
2010 "-chardev udp,id=id[,host=host],port=port[,localaddr=localaddr]\n"
2011 " [,localport=localport][,ipv4][,ipv6][,mux=on|off]\n"
2012 "-chardev msmouse,id=id[,mux=on|off]\n"
2013 "-chardev vc,id=id[[,width=width][,height=height]][[,cols=cols][,rows=rows]]\n"
2014 " [,mux=on|off]\n"
2015 "-chardev ringbuf,id=id[,size=size]\n"
2016 "-chardev file,id=id,path=path[,mux=on|off]\n"
2017 "-chardev pipe,id=id,path=path[,mux=on|off]\n"
2018 #ifdef _WIN32
2019 "-chardev console,id=id[,mux=on|off]\n"
2020 "-chardev serial,id=id,path=path[,mux=on|off]\n"
2021 #else
2022 "-chardev pty,id=id[,mux=on|off]\n"
2023 "-chardev stdio,id=id[,mux=on|off][,signal=on|off]\n"
2024 #endif
2025 #ifdef CONFIG_BRLAPI
2026 "-chardev braille,id=id[,mux=on|off]\n"
2027 #endif
2028 #if defined(__linux__) || defined(__sun__) || defined(__FreeBSD__) \
2029 || defined(__NetBSD__) || defined(__OpenBSD__) || defined(__DragonFly__)
2030 "-chardev serial,id=id,path=path[,mux=on|off]\n"
2031 "-chardev tty,id=id,path=path[,mux=on|off]\n"
2032 #endif
2033 #if defined(__linux__) || defined(__FreeBSD__) || defined(__DragonFly__)
2034 "-chardev parallel,id=id,path=path[,mux=on|off]\n"
2035 "-chardev parport,id=id,path=path[,mux=on|off]\n"
2036 #endif
2037 #if defined(CONFIG_SPICE)
2038 "-chardev spicevmc,id=id,name=name[,debug=debug]\n"
2039 "-chardev spiceport,id=id,name=name[,debug=debug]\n"
2040 #endif
2041 , QEMU_ARCH_ALL
2044 STEXI
2045 @item -chardev @var{backend} ,id=@var{id} [,mux=on|off] [,@var{options}]
2046 @findex -chardev
2047 Backend is one of:
2048 @option{null},
2049 @option{socket},
2050 @option{udp},
2051 @option{msmouse},
2052 @option{vc},
2053 @option{ringbuf},
2054 @option{file},
2055 @option{pipe},
2056 @option{console},
2057 @option{serial},
2058 @option{pty},
2059 @option{stdio},
2060 @option{braille},
2061 @option{tty},
2062 @option{parallel},
2063 @option{parport},
2064 @option{spicevmc}.
2065 @option{spiceport}.
2066 The specific backend will determine the applicable options.
2068 All devices must have an id, which can be any string up to 127 characters long.
2069 It is used to uniquely identify this device in other command line directives.
2071 A character device may be used in multiplexing mode by multiple front-ends.
2072 The key sequence of @key{Control-a} and @key{c} will rotate the input focus
2073 between attached front-ends. Specify @option{mux=on} to enable this mode.
2075 Options to each backend are described below.
2077 @item -chardev null ,id=@var{id}
2078 A void device. This device will not emit any data, and will drop any data it
2079 receives. The null backend does not take any options.
2081 @item -chardev socket ,id=@var{id} [@var{TCP options} or @var{unix options}] [,server] [,nowait] [,telnet] [,reconnect=@var{seconds}]
2083 Create a two-way stream socket, which can be either a TCP or a unix socket. A
2084 unix socket will be created if @option{path} is specified. Behaviour is
2085 undefined if TCP options are specified for a unix socket.
2087 @option{server} specifies that the socket shall be a listening socket.
2089 @option{nowait} specifies that QEMU should not block waiting for a client to
2090 connect to a listening socket.
2092 @option{telnet} specifies that traffic on the socket should interpret telnet
2093 escape sequences.
2095 @option{reconnect} sets the timeout for reconnecting on non-server sockets when
2096 the remote end goes away. qemu will delay this many seconds and then attempt
2097 to reconnect. Zero disables reconnecting, and is the default.
2099 TCP and unix socket options are given below:
2101 @table @option
2103 @item TCP options: port=@var{port} [,host=@var{host}] [,to=@var{to}] [,ipv4] [,ipv6] [,nodelay]
2105 @option{host} for a listening socket specifies the local address to be bound.
2106 For a connecting socket species the remote host to connect to. @option{host} is
2107 optional for listening sockets. If not specified it defaults to @code{0.0.0.0}.
2109 @option{port} for a listening socket specifies the local port to be bound. For a
2110 connecting socket specifies the port on the remote host to connect to.
2111 @option{port} can be given as either a port number or a service name.
2112 @option{port} is required.
2114 @option{to} is only relevant to listening sockets. If it is specified, and
2115 @option{port} cannot be bound, QEMU will attempt to bind to subsequent ports up
2116 to and including @option{to} until it succeeds. @option{to} must be specified
2117 as a port number.
2119 @option{ipv4} and @option{ipv6} specify that either IPv4 or IPv6 must be used.
2120 If neither is specified the socket may use either protocol.
2122 @option{nodelay} disables the Nagle algorithm.
2124 @item unix options: path=@var{path}
2126 @option{path} specifies the local path of the unix socket. @option{path} is
2127 required.
2129 @end table
2131 @item -chardev udp ,id=@var{id} [,host=@var{host}] ,port=@var{port} [,localaddr=@var{localaddr}] [,localport=@var{localport}] [,ipv4] [,ipv6]
2133 Sends all traffic from the guest to a remote host over UDP.
2135 @option{host} specifies the remote host to connect to. If not specified it
2136 defaults to @code{localhost}.
2138 @option{port} specifies the port on the remote host to connect to. @option{port}
2139 is required.
2141 @option{localaddr} specifies the local address to bind to. If not specified it
2142 defaults to @code{0.0.0.0}.
2144 @option{localport} specifies the local port to bind to. If not specified any
2145 available local port will be used.
2147 @option{ipv4} and @option{ipv6} specify that either IPv4 or IPv6 must be used.
2148 If neither is specified the device may use either protocol.
2150 @item -chardev msmouse ,id=@var{id}
2152 Forward QEMU's emulated msmouse events to the guest. @option{msmouse} does not
2153 take any options.
2155 @item -chardev vc ,id=@var{id} [[,width=@var{width}] [,height=@var{height}]] [[,cols=@var{cols}] [,rows=@var{rows}]]
2157 Connect to a QEMU text console. @option{vc} may optionally be given a specific
2158 size.
2160 @option{width} and @option{height} specify the width and height respectively of
2161 the console, in pixels.
2163 @option{cols} and @option{rows} specify that the console be sized to fit a text
2164 console with the given dimensions.
2166 @item -chardev ringbuf ,id=@var{id} [,size=@var{size}]
2168 Create a ring buffer with fixed size @option{size}.
2169 @var{size} must be a power of two, and defaults to @code{64K}).
2171 @item -chardev file ,id=@var{id} ,path=@var{path}
2173 Log all traffic received from the guest to a file.
2175 @option{path} specifies the path of the file to be opened. This file will be
2176 created if it does not already exist, and overwritten if it does. @option{path}
2177 is required.
2179 @item -chardev pipe ,id=@var{id} ,path=@var{path}
2181 Create a two-way connection to the guest. The behaviour differs slightly between
2182 Windows hosts and other hosts:
2184 On Windows, a single duplex pipe will be created at
2185 @file{\\.pipe\@option{path}}.
2187 On other hosts, 2 pipes will be created called @file{@option{path}.in} and
2188 @file{@option{path}.out}. Data written to @file{@option{path}.in} will be
2189 received by the guest. Data written by the guest can be read from
2190 @file{@option{path}.out}. QEMU will not create these fifos, and requires them to
2191 be present.
2193 @option{path} forms part of the pipe path as described above. @option{path} is
2194 required.
2196 @item -chardev console ,id=@var{id}
2198 Send traffic from the guest to QEMU's standard output. @option{console} does not
2199 take any options.
2201 @option{console} is only available on Windows hosts.
2203 @item -chardev serial ,id=@var{id} ,path=@option{path}
2205 Send traffic from the guest to a serial device on the host.
2207 On Unix hosts serial will actually accept any tty device,
2208 not only serial lines.
2210 @option{path} specifies the name of the serial device to open.
2212 @item -chardev pty ,id=@var{id}
2214 Create a new pseudo-terminal on the host and connect to it. @option{pty} does
2215 not take any options.
2217 @option{pty} is not available on Windows hosts.
2219 @item -chardev stdio ,id=@var{id} [,signal=on|off]
2220 Connect to standard input and standard output of the QEMU process.
2222 @option{signal} controls if signals are enabled on the terminal, that includes
2223 exiting QEMU with the key sequence @key{Control-c}. This option is enabled by
2224 default, use @option{signal=off} to disable it.
2226 @option{stdio} is not available on Windows hosts.
2228 @item -chardev braille ,id=@var{id}
2230 Connect to a local BrlAPI server. @option{braille} does not take any options.
2232 @item -chardev tty ,id=@var{id} ,path=@var{path}
2234 @option{tty} is only available on Linux, Sun, FreeBSD, NetBSD, OpenBSD and
2235 DragonFlyBSD hosts. It is an alias for @option{serial}.
2237 @option{path} specifies the path to the tty. @option{path} is required.
2239 @item -chardev parallel ,id=@var{id} ,path=@var{path}
2240 @item -chardev parport ,id=@var{id} ,path=@var{path}
2242 @option{parallel} is only available on Linux, FreeBSD and DragonFlyBSD hosts.
2244 Connect to a local parallel port.
2246 @option{path} specifies the path to the parallel port device. @option{path} is
2247 required.
2249 @item -chardev spicevmc ,id=@var{id} ,debug=@var{debug}, name=@var{name}
2251 @option{spicevmc} is only available when spice support is built in.
2253 @option{debug} debug level for spicevmc
2255 @option{name} name of spice channel to connect to
2257 Connect to a spice virtual machine channel, such as vdiport.
2259 @item -chardev spiceport ,id=@var{id} ,debug=@var{debug}, name=@var{name}
2261 @option{spiceport} is only available when spice support is built in.
2263 @option{debug} debug level for spicevmc
2265 @option{name} name of spice port to connect to
2267 Connect to a spice port, allowing a Spice client to handle the traffic
2268 identified by a name (preferably a fqdn).
2269 ETEXI
2271 STEXI
2272 @end table
2273 ETEXI
2274 DEFHEADING()
2276 DEFHEADING(Device URL Syntax:)
2277 STEXI
2279 In addition to using normal file images for the emulated storage devices,
2280 QEMU can also use networked resources such as iSCSI devices. These are
2281 specified using a special URL syntax.
2283 @table @option
2284 @item iSCSI
2285 iSCSI support allows QEMU to access iSCSI resources directly and use as
2286 images for the guest storage. Both disk and cdrom images are supported.
2288 Syntax for specifying iSCSI LUNs is
2289 ``iscsi://<target-ip>[:<port>]/<target-iqn>/<lun>''
2291 By default qemu will use the iSCSI initiator-name
2292 'iqn.2008-11.org.linux-kvm[:<name>]' but this can also be set from the command
2293 line or a configuration file.
2296 Example (without authentication):
2297 @example
2298 qemu-system-i386 -iscsi initiator-name=iqn.2001-04.com.example:my-initiator \
2299 -cdrom iscsi://192.0.2.1/iqn.2001-04.com.example/2 \
2300 -drive file=iscsi://192.0.2.1/iqn.2001-04.com.example/1
2301 @end example
2303 Example (CHAP username/password via URL):
2304 @example
2305 qemu-system-i386 -drive file=iscsi://user%password@@192.0.2.1/iqn.2001-04.com.example/1
2306 @end example
2308 Example (CHAP username/password via environment variables):
2309 @example
2310 LIBISCSI_CHAP_USERNAME="user" \
2311 LIBISCSI_CHAP_PASSWORD="password" \
2312 qemu-system-i386 -drive file=iscsi://192.0.2.1/iqn.2001-04.com.example/1
2313 @end example
2315 iSCSI support is an optional feature of QEMU and only available when
2316 compiled and linked against libiscsi.
2317 ETEXI
2318 DEF("iscsi", HAS_ARG, QEMU_OPTION_iscsi,
2319 "-iscsi [user=user][,password=password]\n"
2320 " [,header-digest=CRC32C|CR32C-NONE|NONE-CRC32C|NONE\n"
2321 " [,initiator-name=initiator-iqn][,id=target-iqn]\n"
2322 " iSCSI session parameters\n", QEMU_ARCH_ALL)
2323 STEXI
2325 iSCSI parameters such as username and password can also be specified via
2326 a configuration file. See qemu-doc for more information and examples.
2328 @item NBD
2329 QEMU supports NBD (Network Block Devices) both using TCP protocol as well
2330 as Unix Domain Sockets.
2332 Syntax for specifying a NBD device using TCP
2333 ``nbd:<server-ip>:<port>[:exportname=<export>]''
2335 Syntax for specifying a NBD device using Unix Domain Sockets
2336 ``nbd:unix:<domain-socket>[:exportname=<export>]''
2339 Example for TCP
2340 @example
2341 qemu-system-i386 --drive file=nbd:192.0.2.1:30000
2342 @end example
2344 Example for Unix Domain Sockets
2345 @example
2346 qemu-system-i386 --drive file=nbd:unix:/tmp/nbd-socket
2347 @end example
2349 @item SSH
2350 QEMU supports SSH (Secure Shell) access to remote disks.
2352 Examples:
2353 @example
2354 qemu-system-i386 -drive file=ssh://user@@host/path/to/disk.img
2355 qemu-system-i386 -drive file.driver=ssh,file.user=user,file.host=host,file.port=22,file.path=/path/to/disk.img
2356 @end example
2358 Currently authentication must be done using ssh-agent. Other
2359 authentication methods may be supported in future.
2361 @item Sheepdog
2362 Sheepdog is a distributed storage system for QEMU.
2363 QEMU supports using either local sheepdog devices or remote networked
2364 devices.
2366 Syntax for specifying a sheepdog device
2367 @example
2368 sheepdog[+tcp|+unix]://[host:port]/vdiname[?socket=path][#snapid|#tag]
2369 @end example
2371 Example
2372 @example
2373 qemu-system-i386 --drive file=sheepdog://192.0.2.1:30000/MyVirtualMachine
2374 @end example
2376 See also @url{http://http://www.osrg.net/sheepdog/}.
2378 @item GlusterFS
2379 GlusterFS is an user space distributed file system.
2380 QEMU supports the use of GlusterFS volumes for hosting VM disk images using
2381 TCP, Unix Domain Sockets and RDMA transport protocols.
2383 Syntax for specifying a VM disk image on GlusterFS volume is
2384 @example
2385 gluster[+transport]://[server[:port]]/volname/image[?socket=...]
2386 @end example
2389 Example
2390 @example
2391 qemu-system-x86_64 --drive file=gluster://192.0.2.1/testvol/a.img
2392 @end example
2394 See also @url{http://www.gluster.org}.
2396 @item HTTP/HTTPS/FTP/FTPS/TFTP
2397 QEMU supports read-only access to files accessed over http(s), ftp(s) and tftp.
2399 Syntax using a single filename:
2400 @example
2401 <protocol>://[<username>[:<password>]@@]<host>/<path>
2402 @end example
2404 where:
2405 @table @option
2406 @item protocol
2407 'http', 'https', 'ftp', 'ftps', or 'tftp'.
2409 @item username
2410 Optional username for authentication to the remote server.
2412 @item password
2413 Optional password for authentication to the remote server.
2415 @item host
2416 Address of the remote server.
2418 @item path
2419 Path on the remote server, including any query string.
2420 @end table
2422 The following options are also supported:
2423 @table @option
2424 @item url
2425 The full URL when passing options to the driver explicitly.
2427 @item readahead
2428 The amount of data to read ahead with each range request to the remote server.
2429 This value may optionally have the suffix 'T', 'G', 'M', 'K', 'k' or 'b'. If it
2430 does not have a suffix, it will be assumed to be in bytes. The value must be a
2431 multiple of 512 bytes. It defaults to 256k.
2433 @item sslverify
2434 Whether to verify the remote server's certificate when connecting over SSL. It
2435 can have the value 'on' or 'off'. It defaults to 'on'.
2437 @item cookie
2438 Send this cookie (it can also be a list of cookies separated by ';') with
2439 each outgoing request. Only supported when using protocols such as HTTP
2440 which support cookies, otherwise ignored.
2442 @item timeout
2443 Set the timeout in seconds of the CURL connection. This timeout is the time
2444 that CURL waits for a response from the remote server to get the size of the
2445 image to be downloaded. If not set, the default timeout of 5 seconds is used.
2446 @end table
2448 Note that when passing options to qemu explicitly, @option{driver} is the value
2449 of <protocol>.
2451 Example: boot from a remote Fedora 20 live ISO image
2452 @example
2453 qemu-system-x86_64 --drive media=cdrom,file=http://dl.fedoraproject.org/pub/fedora/linux/releases/20/Live/x86_64/Fedora-Live-Desktop-x86_64-20-1.iso,readonly
2455 qemu-system-x86_64 --drive media=cdrom,file.driver=http,file.url=http://dl.fedoraproject.org/pub/fedora/linux/releases/20/Live/x86_64/Fedora-Live-Desktop-x86_64-20-1.iso,readonly
2456 @end example
2458 Example: boot from a remote Fedora 20 cloud image using a local overlay for
2459 writes, copy-on-read, and a readahead of 64k
2460 @example
2461 qemu-img create -f qcow2 -o backing_file='json:@{"file.driver":"http",, "file.url":"https://dl.fedoraproject.org/pub/fedora/linux/releases/20/Images/x86_64/Fedora-x86_64-20-20131211.1-sda.qcow2",, "file.readahead":"64k"@}' /tmp/Fedora-x86_64-20-20131211.1-sda.qcow2
2463 qemu-system-x86_64 -drive file=/tmp/Fedora-x86_64-20-20131211.1-sda.qcow2,copy-on-read=on
2464 @end example
2466 Example: boot from an image stored on a VMware vSphere server with a self-signed
2467 certificate using a local overlay for writes, a readahead of 64k and a timeout
2468 of 10 seconds.
2469 @example
2470 qemu-img create -f qcow2 -o backing_file='json:@{"file.driver":"https",, "file.url":"https://user:password@@vsphere.example.com/folder/test/test-flat.vmdk?dcPath=Datacenter&dsName=datastore1",, "file.sslverify":"off",, "file.readahead":"64k",, "file.timeout":10@}' /tmp/test.qcow2
2472 qemu-system-x86_64 -drive file=/tmp/test.qcow2
2473 @end example
2474 ETEXI
2476 STEXI
2477 @end table
2478 ETEXI
2480 DEFHEADING(Bluetooth(R) options:)
2481 STEXI
2482 @table @option
2483 ETEXI
2485 DEF("bt", HAS_ARG, QEMU_OPTION_bt, \
2486 "-bt hci,null dumb bluetooth HCI - doesn't respond to commands\n" \
2487 "-bt hci,host[:id]\n" \
2488 " use host's HCI with the given name\n" \
2489 "-bt hci[,vlan=n]\n" \
2490 " emulate a standard HCI in virtual scatternet 'n'\n" \
2491 "-bt vhci[,vlan=n]\n" \
2492 " add host computer to virtual scatternet 'n' using VHCI\n" \
2493 "-bt device:dev[,vlan=n]\n" \
2494 " emulate a bluetooth device 'dev' in scatternet 'n'\n",
2495 QEMU_ARCH_ALL)
2496 STEXI
2497 @item -bt hci[...]
2498 @findex -bt
2499 Defines the function of the corresponding Bluetooth HCI. -bt options
2500 are matched with the HCIs present in the chosen machine type. For
2501 example when emulating a machine with only one HCI built into it, only
2502 the first @code{-bt hci[...]} option is valid and defines the HCI's
2503 logic. The Transport Layer is decided by the machine type. Currently
2504 the machines @code{n800} and @code{n810} have one HCI and all other
2505 machines have none.
2507 @anchor{bt-hcis}
2508 The following three types are recognized:
2510 @table @option
2511 @item -bt hci,null
2512 (default) The corresponding Bluetooth HCI assumes no internal logic
2513 and will not respond to any HCI commands or emit events.
2515 @item -bt hci,host[:@var{id}]
2516 (@code{bluez} only) The corresponding HCI passes commands / events
2517 to / from the physical HCI identified by the name @var{id} (default:
2518 @code{hci0}) on the computer running QEMU. Only available on @code{bluez}
2519 capable systems like Linux.
2521 @item -bt hci[,vlan=@var{n}]
2522 Add a virtual, standard HCI that will participate in the Bluetooth
2523 scatternet @var{n} (default @code{0}). Similarly to @option{-net}
2524 VLANs, devices inside a bluetooth network @var{n} can only communicate
2525 with other devices in the same network (scatternet).
2526 @end table
2528 @item -bt vhci[,vlan=@var{n}]
2529 (Linux-host only) Create a HCI in scatternet @var{n} (default 0) attached
2530 to the host bluetooth stack instead of to the emulated target. This
2531 allows the host and target machines to participate in a common scatternet
2532 and communicate. Requires the Linux @code{vhci} driver installed. Can
2533 be used as following:
2535 @example
2536 qemu-system-i386 [...OPTIONS...] -bt hci,vlan=5 -bt vhci,vlan=5
2537 @end example
2539 @item -bt device:@var{dev}[,vlan=@var{n}]
2540 Emulate a bluetooth device @var{dev} and place it in network @var{n}
2541 (default @code{0}). QEMU can only emulate one type of bluetooth devices
2542 currently:
2544 @table @option
2545 @item keyboard
2546 Virtual wireless keyboard implementing the HIDP bluetooth profile.
2547 @end table
2548 ETEXI
2550 STEXI
2551 @end table
2552 ETEXI
2553 DEFHEADING()
2555 #ifdef CONFIG_TPM
2556 DEFHEADING(TPM device options:)
2558 DEF("tpmdev", HAS_ARG, QEMU_OPTION_tpmdev, \
2559 "-tpmdev passthrough,id=id[,path=path][,cancel-path=path]\n"
2560 " use path to provide path to a character device; default is /dev/tpm0\n"
2561 " use cancel-path to provide path to TPM's cancel sysfs entry; if\n"
2562 " not provided it will be searched for in /sys/class/misc/tpm?/device\n",
2563 QEMU_ARCH_ALL)
2564 STEXI
2566 The general form of a TPM device option is:
2567 @table @option
2569 @item -tpmdev @var{backend} ,id=@var{id} [,@var{options}]
2570 @findex -tpmdev
2571 Backend type must be:
2572 @option{passthrough}.
2574 The specific backend type will determine the applicable options.
2575 The @code{-tpmdev} option creates the TPM backend and requires a
2576 @code{-device} option that specifies the TPM frontend interface model.
2578 Options to each backend are described below.
2580 Use 'help' to print all available TPM backend types.
2581 @example
2582 qemu -tpmdev help
2583 @end example
2585 @item -tpmdev passthrough, id=@var{id}, path=@var{path}, cancel-path=@var{cancel-path}
2587 (Linux-host only) Enable access to the host's TPM using the passthrough
2588 driver.
2590 @option{path} specifies the path to the host's TPM device, i.e., on
2591 a Linux host this would be @code{/dev/tpm0}.
2592 @option{path} is optional and by default @code{/dev/tpm0} is used.
2594 @option{cancel-path} specifies the path to the host TPM device's sysfs
2595 entry allowing for cancellation of an ongoing TPM command.
2596 @option{cancel-path} is optional and by default QEMU will search for the
2597 sysfs entry to use.
2599 Some notes about using the host's TPM with the passthrough driver:
2601 The TPM device accessed by the passthrough driver must not be
2602 used by any other application on the host.
2604 Since the host's firmware (BIOS/UEFI) has already initialized the TPM,
2605 the VM's firmware (BIOS/UEFI) will not be able to initialize the
2606 TPM again and may therefore not show a TPM-specific menu that would
2607 otherwise allow the user to configure the TPM, e.g., allow the user to
2608 enable/disable or activate/deactivate the TPM.
2609 Further, if TPM ownership is released from within a VM then the host's TPM
2610 will get disabled and deactivated. To enable and activate the
2611 TPM again afterwards, the host has to be rebooted and the user is
2612 required to enter the firmware's menu to enable and activate the TPM.
2613 If the TPM is left disabled and/or deactivated most TPM commands will fail.
2615 To create a passthrough TPM use the following two options:
2616 @example
2617 -tpmdev passthrough,id=tpm0 -device tpm-tis,tpmdev=tpm0
2618 @end example
2619 Note that the @code{-tpmdev} id is @code{tpm0} and is referenced by
2620 @code{tpmdev=tpm0} in the device option.
2622 @end table
2624 ETEXI
2626 DEFHEADING()
2628 #endif
2630 DEFHEADING(Linux/Multiboot boot specific:)
2631 STEXI
2633 When using these options, you can use a given Linux or Multiboot
2634 kernel without installing it in the disk image. It can be useful
2635 for easier testing of various kernels.
2637 @table @option
2638 ETEXI
2640 DEF("kernel", HAS_ARG, QEMU_OPTION_kernel, \
2641 "-kernel bzImage use 'bzImage' as kernel image\n", QEMU_ARCH_ALL)
2642 STEXI
2643 @item -kernel @var{bzImage}
2644 @findex -kernel
2645 Use @var{bzImage} as kernel image. The kernel can be either a Linux kernel
2646 or in multiboot format.
2647 ETEXI
2649 DEF("append", HAS_ARG, QEMU_OPTION_append, \
2650 "-append cmdline use 'cmdline' as kernel command line\n", QEMU_ARCH_ALL)
2651 STEXI
2652 @item -append @var{cmdline}
2653 @findex -append
2654 Use @var{cmdline} as kernel command line
2655 ETEXI
2657 DEF("initrd", HAS_ARG, QEMU_OPTION_initrd, \
2658 "-initrd file use 'file' as initial ram disk\n", QEMU_ARCH_ALL)
2659 STEXI
2660 @item -initrd @var{file}
2661 @findex -initrd
2662 Use @var{file} as initial ram disk.
2664 @item -initrd "@var{file1} arg=foo,@var{file2}"
2666 This syntax is only available with multiboot.
2668 Use @var{file1} and @var{file2} as modules and pass arg=foo as parameter to the
2669 first module.
2670 ETEXI
2672 DEF("dtb", HAS_ARG, QEMU_OPTION_dtb, \
2673 "-dtb file use 'file' as device tree image\n", QEMU_ARCH_ALL)
2674 STEXI
2675 @item -dtb @var{file}
2676 @findex -dtb
2677 Use @var{file} as a device tree binary (dtb) image and pass it to the kernel
2678 on boot.
2679 ETEXI
2681 STEXI
2682 @end table
2683 ETEXI
2684 DEFHEADING()
2686 DEFHEADING(Debug/Expert options:)
2687 STEXI
2688 @table @option
2689 ETEXI
2691 DEF("fw_cfg", HAS_ARG, QEMU_OPTION_fwcfg,
2692 "-fw_cfg [name=]<name>,file=<file>\n"
2693 " add named fw_cfg entry from file\n",
2694 QEMU_ARCH_ALL)
2695 STEXI
2696 @item -fw_cfg [name=]@var{name},file=@var{file}
2697 @findex -fw_cfg
2698 Add named fw_cfg entry from file. @var{name} determines the name of
2699 the entry in the fw_cfg file directory exposed to the guest.
2700 ETEXI
2702 DEF("serial", HAS_ARG, QEMU_OPTION_serial, \
2703 "-serial dev redirect the serial port to char device 'dev'\n",
2704 QEMU_ARCH_ALL)
2705 STEXI
2706 @item -serial @var{dev}
2707 @findex -serial
2708 Redirect the virtual serial port to host character device
2709 @var{dev}. The default device is @code{vc} in graphical mode and
2710 @code{stdio} in non graphical mode.
2712 This option can be used several times to simulate up to 4 serial
2713 ports.
2715 Use @code{-serial none} to disable all serial ports.
2717 Available character devices are:
2718 @table @option
2719 @item vc[:@var{W}x@var{H}]
2720 Virtual console. Optionally, a width and height can be given in pixel with
2721 @example
2722 vc:800x600
2723 @end example
2724 It is also possible to specify width or height in characters:
2725 @example
2726 vc:80Cx24C
2727 @end example
2728 @item pty
2729 [Linux only] Pseudo TTY (a new PTY is automatically allocated)
2730 @item none
2731 No device is allocated.
2732 @item null
2733 void device
2734 @item chardev:@var{id}
2735 Use a named character device defined with the @code{-chardev} option.
2736 @item /dev/XXX
2737 [Linux only] Use host tty, e.g. @file{/dev/ttyS0}. The host serial port
2738 parameters are set according to the emulated ones.
2739 @item /dev/parport@var{N}
2740 [Linux only, parallel port only] Use host parallel port
2741 @var{N}. Currently SPP and EPP parallel port features can be used.
2742 @item file:@var{filename}
2743 Write output to @var{filename}. No character can be read.
2744 @item stdio
2745 [Unix only] standard input/output
2746 @item pipe:@var{filename}
2747 name pipe @var{filename}
2748 @item COM@var{n}
2749 [Windows only] Use host serial port @var{n}
2750 @item udp:[@var{remote_host}]:@var{remote_port}[@@[@var{src_ip}]:@var{src_port}]
2751 This implements UDP Net Console.
2752 When @var{remote_host} or @var{src_ip} are not specified
2753 they default to @code{0.0.0.0}.
2754 When not using a specified @var{src_port} a random port is automatically chosen.
2756 If you just want a simple readonly console you can use @code{netcat} or
2757 @code{nc}, by starting QEMU with: @code{-serial udp::4555} and nc as:
2758 @code{nc -u -l -p 4555}. Any time QEMU writes something to that port it
2759 will appear in the netconsole session.
2761 If you plan to send characters back via netconsole or you want to stop
2762 and start QEMU a lot of times, you should have QEMU use the same
2763 source port each time by using something like @code{-serial
2764 udp::4555@@:4556} to QEMU. Another approach is to use a patched
2765 version of netcat which can listen to a TCP port and send and receive
2766 characters via udp. If you have a patched version of netcat which
2767 activates telnet remote echo and single char transfer, then you can
2768 use the following options to step up a netcat redirector to allow
2769 telnet on port 5555 to access the QEMU port.
2770 @table @code
2771 @item QEMU Options:
2772 -serial udp::4555@@:4556
2773 @item netcat options:
2774 -u -P 4555 -L 0.0.0.0:4556 -t -p 5555 -I -T
2775 @item telnet options:
2776 localhost 5555
2777 @end table
2779 @item tcp:[@var{host}]:@var{port}[,@var{server}][,nowait][,nodelay][,reconnect=@var{seconds}]
2780 The TCP Net Console has two modes of operation. It can send the serial
2781 I/O to a location or wait for a connection from a location. By default
2782 the TCP Net Console is sent to @var{host} at the @var{port}. If you use
2783 the @var{server} option QEMU will wait for a client socket application
2784 to connect to the port before continuing, unless the @code{nowait}
2785 option was specified. The @code{nodelay} option disables the Nagle buffering
2786 algorithm. The @code{reconnect} option only applies if @var{noserver} is
2787 set, if the connection goes down it will attempt to reconnect at the
2788 given interval. If @var{host} is omitted, 0.0.0.0 is assumed. Only
2789 one TCP connection at a time is accepted. You can use @code{telnet} to
2790 connect to the corresponding character device.
2791 @table @code
2792 @item Example to send tcp console to 192.168.0.2 port 4444
2793 -serial tcp:192.168.0.2:4444
2794 @item Example to listen and wait on port 4444 for connection
2795 -serial tcp::4444,server
2796 @item Example to not wait and listen on ip 192.168.0.100 port 4444
2797 -serial tcp:192.168.0.100:4444,server,nowait
2798 @end table
2800 @item telnet:@var{host}:@var{port}[,server][,nowait][,nodelay]
2801 The telnet protocol is used instead of raw tcp sockets. The options
2802 work the same as if you had specified @code{-serial tcp}. The
2803 difference is that the port acts like a telnet server or client using
2804 telnet option negotiation. This will also allow you to send the
2805 MAGIC_SYSRQ sequence if you use a telnet that supports sending the break
2806 sequence. Typically in unix telnet you do it with Control-] and then
2807 type "send break" followed by pressing the enter key.
2809 @item unix:@var{path}[,server][,nowait][,reconnect=@var{seconds}]
2810 A unix domain socket is used instead of a tcp socket. The option works the
2811 same as if you had specified @code{-serial tcp} except the unix domain socket
2812 @var{path} is used for connections.
2814 @item mon:@var{dev_string}
2815 This is a special option to allow the monitor to be multiplexed onto
2816 another serial port. The monitor is accessed with key sequence of
2817 @key{Control-a} and then pressing @key{c}.
2818 @var{dev_string} should be any one of the serial devices specified
2819 above. An example to multiplex the monitor onto a telnet server
2820 listening on port 4444 would be:
2821 @table @code
2822 @item -serial mon:telnet::4444,server,nowait
2823 @end table
2824 When the monitor is multiplexed to stdio in this way, Ctrl+C will not terminate
2825 QEMU any more but will be passed to the guest instead.
2827 @item braille
2828 Braille device. This will use BrlAPI to display the braille output on a real
2829 or fake device.
2831 @item msmouse
2832 Three button serial mouse. Configure the guest to use Microsoft protocol.
2833 @end table
2834 ETEXI
2836 DEF("parallel", HAS_ARG, QEMU_OPTION_parallel, \
2837 "-parallel dev redirect the parallel port to char device 'dev'\n",
2838 QEMU_ARCH_ALL)
2839 STEXI
2840 @item -parallel @var{dev}
2841 @findex -parallel
2842 Redirect the virtual parallel port to host device @var{dev} (same
2843 devices as the serial port). On Linux hosts, @file{/dev/parportN} can
2844 be used to use hardware devices connected on the corresponding host
2845 parallel port.
2847 This option can be used several times to simulate up to 3 parallel
2848 ports.
2850 Use @code{-parallel none} to disable all parallel ports.
2851 ETEXI
2853 DEF("monitor", HAS_ARG, QEMU_OPTION_monitor, \
2854 "-monitor dev redirect the monitor to char device 'dev'\n",
2855 QEMU_ARCH_ALL)
2856 STEXI
2857 @item -monitor @var{dev}
2858 @findex -monitor
2859 Redirect the monitor to host device @var{dev} (same devices as the
2860 serial port).
2861 The default device is @code{vc} in graphical mode and @code{stdio} in
2862 non graphical mode.
2863 Use @code{-monitor none} to disable the default monitor.
2864 ETEXI
2865 DEF("qmp", HAS_ARG, QEMU_OPTION_qmp, \
2866 "-qmp dev like -monitor but opens in 'control' mode\n",
2867 QEMU_ARCH_ALL)
2868 STEXI
2869 @item -qmp @var{dev}
2870 @findex -qmp
2871 Like -monitor but opens in 'control' mode.
2872 ETEXI
2873 DEF("qmp-pretty", HAS_ARG, QEMU_OPTION_qmp_pretty, \
2874 "-qmp-pretty dev like -qmp but uses pretty JSON formatting\n",
2875 QEMU_ARCH_ALL)
2876 STEXI
2877 @item -qmp-pretty @var{dev}
2878 @findex -qmp-pretty
2879 Like -qmp but uses pretty JSON formatting.
2880 ETEXI
2882 DEF("mon", HAS_ARG, QEMU_OPTION_mon, \
2883 "-mon [chardev=]name[,mode=readline|control][,default]\n", QEMU_ARCH_ALL)
2884 STEXI
2885 @item -mon [chardev=]name[,mode=readline|control][,default]
2886 @findex -mon
2887 Setup monitor on chardev @var{name}.
2888 ETEXI
2890 DEF("debugcon", HAS_ARG, QEMU_OPTION_debugcon, \
2891 "-debugcon dev redirect the debug console to char device 'dev'\n",
2892 QEMU_ARCH_ALL)
2893 STEXI
2894 @item -debugcon @var{dev}
2895 @findex -debugcon
2896 Redirect the debug console to host device @var{dev} (same devices as the
2897 serial port). The debug console is an I/O port which is typically port
2898 0xe9; writing to that I/O port sends output to this device.
2899 The default device is @code{vc} in graphical mode and @code{stdio} in
2900 non graphical mode.
2901 ETEXI
2903 DEF("pidfile", HAS_ARG, QEMU_OPTION_pidfile, \
2904 "-pidfile file write PID to 'file'\n", QEMU_ARCH_ALL)
2905 STEXI
2906 @item -pidfile @var{file}
2907 @findex -pidfile
2908 Store the QEMU process PID in @var{file}. It is useful if you launch QEMU
2909 from a script.
2910 ETEXI
2912 DEF("singlestep", 0, QEMU_OPTION_singlestep, \
2913 "-singlestep always run in singlestep mode\n", QEMU_ARCH_ALL)
2914 STEXI
2915 @item -singlestep
2916 @findex -singlestep
2917 Run the emulation in single step mode.
2918 ETEXI
2920 DEF("S", 0, QEMU_OPTION_S, \
2921 "-S freeze CPU at startup (use 'c' to start execution)\n",
2922 QEMU_ARCH_ALL)
2923 STEXI
2924 @item -S
2925 @findex -S
2926 Do not start CPU at startup (you must type 'c' in the monitor).
2927 ETEXI
2929 DEF("realtime", HAS_ARG, QEMU_OPTION_realtime,
2930 "-realtime [mlock=on|off]\n"
2931 " run qemu with realtime features\n"
2932 " mlock=on|off controls mlock support (default: on)\n",
2933 QEMU_ARCH_ALL)
2934 STEXI
2935 @item -realtime mlock=on|off
2936 @findex -realtime
2937 Run qemu with realtime features.
2938 mlocking qemu and guest memory can be enabled via @option{mlock=on}
2939 (enabled by default).
2940 ETEXI
2942 DEF("gdb", HAS_ARG, QEMU_OPTION_gdb, \
2943 "-gdb dev wait for gdb connection on 'dev'\n", QEMU_ARCH_ALL)
2944 STEXI
2945 @item -gdb @var{dev}
2946 @findex -gdb
2947 Wait for gdb connection on device @var{dev} (@pxref{gdb_usage}). Typical
2948 connections will likely be TCP-based, but also UDP, pseudo TTY, or even
2949 stdio are reasonable use case. The latter is allowing to start QEMU from
2950 within gdb and establish the connection via a pipe:
2951 @example
2952 (gdb) target remote | exec qemu-system-i386 -gdb stdio ...
2953 @end example
2954 ETEXI
2956 DEF("s", 0, QEMU_OPTION_s, \
2957 "-s shorthand for -gdb tcp::" DEFAULT_GDBSTUB_PORT "\n",
2958 QEMU_ARCH_ALL)
2959 STEXI
2960 @item -s
2961 @findex -s
2962 Shorthand for -gdb tcp::1234, i.e. open a gdbserver on TCP port 1234
2963 (@pxref{gdb_usage}).
2964 ETEXI
2966 DEF("d", HAS_ARG, QEMU_OPTION_d, \
2967 "-d item1,... enable logging of specified items (use '-d help' for a list of log items)\n",
2968 QEMU_ARCH_ALL)
2969 STEXI
2970 @item -d @var{item1}[,...]
2971 @findex -d
2972 Enable logging of specified items. Use '-d help' for a list of log items.
2973 ETEXI
2975 DEF("D", HAS_ARG, QEMU_OPTION_D, \
2976 "-D logfile output log to logfile (default stderr)\n",
2977 QEMU_ARCH_ALL)
2978 STEXI
2979 @item -D @var{logfile}
2980 @findex -D
2981 Output log in @var{logfile} instead of to stderr
2982 ETEXI
2984 DEF("L", HAS_ARG, QEMU_OPTION_L, \
2985 "-L path set the directory for the BIOS, VGA BIOS and keymaps\n",
2986 QEMU_ARCH_ALL)
2987 STEXI
2988 @item -L @var{path}
2989 @findex -L
2990 Set the directory for the BIOS, VGA BIOS and keymaps.
2991 ETEXI
2993 DEF("bios", HAS_ARG, QEMU_OPTION_bios, \
2994 "-bios file set the filename for the BIOS\n", QEMU_ARCH_ALL)
2995 STEXI
2996 @item -bios @var{file}
2997 @findex -bios
2998 Set the filename for the BIOS.
2999 ETEXI
3001 DEF("enable-kvm", 0, QEMU_OPTION_enable_kvm, \
3002 "-enable-kvm enable KVM full virtualization support\n", QEMU_ARCH_ALL)
3003 STEXI
3004 @item -enable-kvm
3005 @findex -enable-kvm
3006 Enable KVM full virtualization support. This option is only available
3007 if KVM support is enabled when compiling.
3008 ETEXI
3010 DEF("xen-domid", HAS_ARG, QEMU_OPTION_xen_domid,
3011 "-xen-domid id specify xen guest domain id\n", QEMU_ARCH_ALL)
3012 DEF("xen-create", 0, QEMU_OPTION_xen_create,
3013 "-xen-create create domain using xen hypercalls, bypassing xend\n"
3014 " warning: should not be used when xend is in use\n",
3015 QEMU_ARCH_ALL)
3016 DEF("xen-attach", 0, QEMU_OPTION_xen_attach,
3017 "-xen-attach attach to existing xen domain\n"
3018 " xend will use this when starting QEMU\n",
3019 QEMU_ARCH_ALL)
3020 STEXI
3021 @item -xen-domid @var{id}
3022 @findex -xen-domid
3023 Specify xen guest domain @var{id} (XEN only).
3024 @item -xen-create
3025 @findex -xen-create
3026 Create domain using xen hypercalls, bypassing xend.
3027 Warning: should not be used when xend is in use (XEN only).
3028 @item -xen-attach
3029 @findex -xen-attach
3030 Attach to existing xen domain.
3031 xend will use this when starting QEMU (XEN only).
3032 ETEXI
3034 DEF("no-reboot", 0, QEMU_OPTION_no_reboot, \
3035 "-no-reboot exit instead of rebooting\n", QEMU_ARCH_ALL)
3036 STEXI
3037 @item -no-reboot
3038 @findex -no-reboot
3039 Exit instead of rebooting.
3040 ETEXI
3042 DEF("no-shutdown", 0, QEMU_OPTION_no_shutdown, \
3043 "-no-shutdown stop before shutdown\n", QEMU_ARCH_ALL)
3044 STEXI
3045 @item -no-shutdown
3046 @findex -no-shutdown
3047 Don't exit QEMU on guest shutdown, but instead only stop the emulation.
3048 This allows for instance switching to monitor to commit changes to the
3049 disk image.
3050 ETEXI
3052 DEF("loadvm", HAS_ARG, QEMU_OPTION_loadvm, \
3053 "-loadvm [tag|id]\n" \
3054 " start right away with a saved state (loadvm in monitor)\n",
3055 QEMU_ARCH_ALL)
3056 STEXI
3057 @item -loadvm @var{file}
3058 @findex -loadvm
3059 Start right away with a saved state (@code{loadvm} in monitor)
3060 ETEXI
3062 #ifndef _WIN32
3063 DEF("daemonize", 0, QEMU_OPTION_daemonize, \
3064 "-daemonize daemonize QEMU after initializing\n", QEMU_ARCH_ALL)
3065 #endif
3066 STEXI
3067 @item -daemonize
3068 @findex -daemonize
3069 Daemonize the QEMU process after initialization. QEMU will not detach from
3070 standard IO until it is ready to receive connections on any of its devices.
3071 This option is a useful way for external programs to launch QEMU without having
3072 to cope with initialization race conditions.
3073 ETEXI
3075 DEF("option-rom", HAS_ARG, QEMU_OPTION_option_rom, \
3076 "-option-rom rom load a file, rom, into the option ROM space\n",
3077 QEMU_ARCH_ALL)
3078 STEXI
3079 @item -option-rom @var{file}
3080 @findex -option-rom
3081 Load the contents of @var{file} as an option ROM.
3082 This option is useful to load things like EtherBoot.
3083 ETEXI
3085 HXCOMM Silently ignored for compatibility
3086 DEF("clock", HAS_ARG, QEMU_OPTION_clock, "", QEMU_ARCH_ALL)
3088 HXCOMM Options deprecated by -rtc
3089 DEF("localtime", 0, QEMU_OPTION_localtime, "", QEMU_ARCH_ALL)
3090 DEF("startdate", HAS_ARG, QEMU_OPTION_startdate, "", QEMU_ARCH_ALL)
3092 DEF("rtc", HAS_ARG, QEMU_OPTION_rtc, \
3093 "-rtc [base=utc|localtime|date][,clock=host|rt|vm][,driftfix=none|slew]\n" \
3094 " set the RTC base and clock, enable drift fix for clock ticks (x86 only)\n",
3095 QEMU_ARCH_ALL)
3097 STEXI
3099 @item -rtc [base=utc|localtime|@var{date}][,clock=host|vm][,driftfix=none|slew]
3100 @findex -rtc
3101 Specify @option{base} as @code{utc} or @code{localtime} to let the RTC start at the current
3102 UTC or local time, respectively. @code{localtime} is required for correct date in
3103 MS-DOS or Windows. To start at a specific point in time, provide @var{date} in the
3104 format @code{2006-06-17T16:01:21} or @code{2006-06-17}. The default base is UTC.
3106 By default the RTC is driven by the host system time. This allows using of the
3107 RTC as accurate reference clock inside the guest, specifically if the host
3108 time is smoothly following an accurate external reference clock, e.g. via NTP.
3109 If you want to isolate the guest time from the host, you can set @option{clock}
3110 to @code{rt} instead. To even prevent it from progressing during suspension,
3111 you can set it to @code{vm}.
3113 Enable @option{driftfix} (i386 targets only) if you experience time drift problems,
3114 specifically with Windows' ACPI HAL. This option will try to figure out how
3115 many timer interrupts were not processed by the Windows guest and will
3116 re-inject them.
3117 ETEXI
3119 DEF("icount", HAS_ARG, QEMU_OPTION_icount, \
3120 "-icount [shift=N|auto][,align=on|off][,sleep=no]\n" \
3121 " enable virtual instruction counter with 2^N clock ticks per\n" \
3122 " instruction, enable aligning the host and virtual clocks\n" \
3123 " or disable real time cpu sleeping\n", QEMU_ARCH_ALL)
3124 STEXI
3125 @item -icount [shift=@var{N}|auto]
3126 @findex -icount
3127 Enable virtual instruction counter. The virtual cpu will execute one
3128 instruction every 2^@var{N} ns of virtual time. If @code{auto} is specified
3129 then the virtual cpu speed will be automatically adjusted to keep virtual
3130 time within a few seconds of real time.
3132 When the virtual cpu is sleeping, the virtual time will advance at default
3133 speed unless @option{sleep=no} is specified.
3134 With @option{sleep=no}, the virtual time will jump to the next timer deadline
3135 instantly whenever the virtual cpu goes to sleep mode and will not advance
3136 if no timer is enabled. This behavior give deterministic execution times from
3137 the guest point of view.
3139 Note that while this option can give deterministic behavior, it does not
3140 provide cycle accurate emulation. Modern CPUs contain superscalar out of
3141 order cores with complex cache hierarchies. The number of instructions
3142 executed often has little or no correlation with actual performance.
3144 @option{align=on} will activate the delay algorithm which will try to
3145 to synchronise the host clock and the virtual clock. The goal is to
3146 have a guest running at the real frequency imposed by the shift option.
3147 Whenever the guest clock is behind the host clock and if
3148 @option{align=on} is specified then we print a message to the user
3149 to inform about the delay.
3150 Currently this option does not work when @option{shift} is @code{auto}.
3151 Note: The sync algorithm will work for those shift values for which
3152 the guest clock runs ahead of the host clock. Typically this happens
3153 when the shift value is high (how high depends on the host machine).
3154 ETEXI
3156 DEF("watchdog", HAS_ARG, QEMU_OPTION_watchdog, \
3157 "-watchdog i6300esb|ib700\n" \
3158 " enable virtual hardware watchdog [default=none]\n",
3159 QEMU_ARCH_ALL)
3160 STEXI
3161 @item -watchdog @var{model}
3162 @findex -watchdog
3163 Create a virtual hardware watchdog device. Once enabled (by a guest
3164 action), the watchdog must be periodically polled by an agent inside
3165 the guest or else the guest will be restarted.
3167 The @var{model} is the model of hardware watchdog to emulate. Choices
3168 for model are: @code{ib700} (iBASE 700) which is a very simple ISA
3169 watchdog with a single timer, or @code{i6300esb} (Intel 6300ESB I/O
3170 controller hub) which is a much more featureful PCI-based dual-timer
3171 watchdog. Choose a model for which your guest has drivers.
3173 Use @code{-watchdog help} to list available hardware models. Only one
3174 watchdog can be enabled for a guest.
3175 ETEXI
3177 DEF("watchdog-action", HAS_ARG, QEMU_OPTION_watchdog_action, \
3178 "-watchdog-action reset|shutdown|poweroff|pause|debug|none\n" \
3179 " action when watchdog fires [default=reset]\n",
3180 QEMU_ARCH_ALL)
3181 STEXI
3182 @item -watchdog-action @var{action}
3183 @findex -watchdog-action
3185 The @var{action} controls what QEMU will do when the watchdog timer
3186 expires.
3187 The default is
3188 @code{reset} (forcefully reset the guest).
3189 Other possible actions are:
3190 @code{shutdown} (attempt to gracefully shutdown the guest),
3191 @code{poweroff} (forcefully poweroff the guest),
3192 @code{pause} (pause the guest),
3193 @code{debug} (print a debug message and continue), or
3194 @code{none} (do nothing).
3196 Note that the @code{shutdown} action requires that the guest responds
3197 to ACPI signals, which it may not be able to do in the sort of
3198 situations where the watchdog would have expired, and thus
3199 @code{-watchdog-action shutdown} is not recommended for production use.
3201 Examples:
3203 @table @code
3204 @item -watchdog i6300esb -watchdog-action pause
3205 @item -watchdog ib700
3206 @end table
3207 ETEXI
3209 DEF("echr", HAS_ARG, QEMU_OPTION_echr, \
3210 "-echr chr set terminal escape character instead of ctrl-a\n",
3211 QEMU_ARCH_ALL)
3212 STEXI
3214 @item -echr @var{numeric_ascii_value}
3215 @findex -echr
3216 Change the escape character used for switching to the monitor when using
3217 monitor and serial sharing. The default is @code{0x01} when using the
3218 @code{-nographic} option. @code{0x01} is equal to pressing
3219 @code{Control-a}. You can select a different character from the ascii
3220 control keys where 1 through 26 map to Control-a through Control-z. For
3221 instance you could use the either of the following to change the escape
3222 character to Control-t.
3223 @table @code
3224 @item -echr 0x14
3225 @item -echr 20
3226 @end table
3227 ETEXI
3229 DEF("virtioconsole", HAS_ARG, QEMU_OPTION_virtiocon, \
3230 "-virtioconsole c\n" \
3231 " set virtio console\n", QEMU_ARCH_ALL)
3232 STEXI
3233 @item -virtioconsole @var{c}
3234 @findex -virtioconsole
3235 Set virtio console.
3237 This option is maintained for backward compatibility.
3239 Please use @code{-device virtconsole} for the new way of invocation.
3240 ETEXI
3242 DEF("show-cursor", 0, QEMU_OPTION_show_cursor, \
3243 "-show-cursor show cursor\n", QEMU_ARCH_ALL)
3244 STEXI
3245 @item -show-cursor
3246 @findex -show-cursor
3247 Show cursor.
3248 ETEXI
3250 DEF("tb-size", HAS_ARG, QEMU_OPTION_tb_size, \
3251 "-tb-size n set TB size\n", QEMU_ARCH_ALL)
3252 STEXI
3253 @item -tb-size @var{n}
3254 @findex -tb-size
3255 Set TB size.
3256 ETEXI
3258 DEF("incoming", HAS_ARG, QEMU_OPTION_incoming, \
3259 "-incoming tcp:[host]:port[,to=maxport][,ipv4][,ipv6]\n" \
3260 "-incoming rdma:host:port[,ipv4][,ipv6]\n" \
3261 "-incoming unix:socketpath\n" \
3262 " prepare for incoming migration, listen on\n" \
3263 " specified protocol and socket address\n" \
3264 "-incoming fd:fd\n" \
3265 "-incoming exec:cmdline\n" \
3266 " accept incoming migration on given file descriptor\n" \
3267 " or from given external command\n" \
3268 "-incoming defer\n" \
3269 " wait for the URI to be specified via migrate_incoming\n",
3270 QEMU_ARCH_ALL)
3271 STEXI
3272 @item -incoming tcp:[@var{host}]:@var{port}[,to=@var{maxport}][,ipv4][,ipv6]
3273 @item -incoming rdma:@var{host}:@var{port}[,ipv4][,ipv6]
3274 @findex -incoming
3275 Prepare for incoming migration, listen on a given tcp port.
3277 @item -incoming unix:@var{socketpath}
3278 Prepare for incoming migration, listen on a given unix socket.
3280 @item -incoming fd:@var{fd}
3281 Accept incoming migration from a given filedescriptor.
3283 @item -incoming exec:@var{cmdline}
3284 Accept incoming migration as an output from specified external command.
3286 @item -incoming defer
3287 Wait for the URI to be specified via migrate_incoming. The monitor can
3288 be used to change settings (such as migration parameters) prior to issuing
3289 the migrate_incoming to allow the migration to begin.
3290 ETEXI
3292 DEF("nodefaults", 0, QEMU_OPTION_nodefaults, \
3293 "-nodefaults don't create default devices\n", QEMU_ARCH_ALL)
3294 STEXI
3295 @item -nodefaults
3296 @findex -nodefaults
3297 Don't create default devices. Normally, QEMU sets the default devices like serial
3298 port, parallel port, virtual console, monitor device, VGA adapter, floppy and
3299 CD-ROM drive and others. The @code{-nodefaults} option will disable all those
3300 default devices.
3301 ETEXI
3303 #ifndef _WIN32
3304 DEF("chroot", HAS_ARG, QEMU_OPTION_chroot, \
3305 "-chroot dir chroot to dir just before starting the VM\n",
3306 QEMU_ARCH_ALL)
3307 #endif
3308 STEXI
3309 @item -chroot @var{dir}
3310 @findex -chroot
3311 Immediately before starting guest execution, chroot to the specified
3312 directory. Especially useful in combination with -runas.
3313 ETEXI
3315 #ifndef _WIN32
3316 DEF("runas", HAS_ARG, QEMU_OPTION_runas, \
3317 "-runas user change to user id user just before starting the VM\n",
3318 QEMU_ARCH_ALL)
3319 #endif
3320 STEXI
3321 @item -runas @var{user}
3322 @findex -runas
3323 Immediately before starting guest execution, drop root privileges, switching
3324 to the specified user.
3325 ETEXI
3327 DEF("prom-env", HAS_ARG, QEMU_OPTION_prom_env,
3328 "-prom-env variable=value\n"
3329 " set OpenBIOS nvram variables\n",
3330 QEMU_ARCH_PPC | QEMU_ARCH_SPARC)
3331 STEXI
3332 @item -prom-env @var{variable}=@var{value}
3333 @findex -prom-env
3334 Set OpenBIOS nvram @var{variable} to given @var{value} (PPC, SPARC only).
3335 ETEXI
3336 DEF("semihosting", 0, QEMU_OPTION_semihosting,
3337 "-semihosting semihosting mode\n",
3338 QEMU_ARCH_ARM | QEMU_ARCH_M68K | QEMU_ARCH_XTENSA | QEMU_ARCH_LM32)
3339 STEXI
3340 @item -semihosting
3341 @findex -semihosting
3342 Enable semihosting mode (ARM, M68K, Xtensa only).
3343 ETEXI
3344 DEF("semihosting-config", HAS_ARG, QEMU_OPTION_semihosting_config,
3345 "-semihosting-config [enable=on|off,]target=native|gdb|auto semihosting configuration\n",
3346 QEMU_ARCH_ARM | QEMU_ARCH_M68K | QEMU_ARCH_XTENSA | QEMU_ARCH_LM32)
3347 STEXI
3348 @item -semihosting-config [enable=on|off,]target=native|gdb|auto
3349 @findex -semihosting-config
3350 Enable semihosting and define where the semihosting calls will be addressed,
3351 to QEMU (@code{native}) or to GDB (@code{gdb}). The default is @code{auto}, which means
3352 @code{gdb} during debug sessions and @code{native} otherwise (ARM, M68K, Xtensa only).
3353 ETEXI
3354 DEF("old-param", 0, QEMU_OPTION_old_param,
3355 "-old-param old param mode\n", QEMU_ARCH_ARM)
3356 STEXI
3357 @item -old-param
3358 @findex -old-param (ARM)
3359 Old param mode (ARM only).
3360 ETEXI
3362 DEF("sandbox", HAS_ARG, QEMU_OPTION_sandbox, \
3363 "-sandbox <arg> Enable seccomp mode 2 system call filter (default 'off').\n",
3364 QEMU_ARCH_ALL)
3365 STEXI
3366 @item -sandbox @var{arg}
3367 @findex -sandbox
3368 Enable Seccomp mode 2 system call filter. 'on' will enable syscall filtering and 'off' will
3369 disable it. The default is 'off'.
3370 ETEXI
3372 DEF("readconfig", HAS_ARG, QEMU_OPTION_readconfig,
3373 "-readconfig <file>\n", QEMU_ARCH_ALL)
3374 STEXI
3375 @item -readconfig @var{file}
3376 @findex -readconfig
3377 Read device configuration from @var{file}. This approach is useful when you want to spawn
3378 QEMU process with many command line options but you don't want to exceed the command line
3379 character limit.
3380 ETEXI
3381 DEF("writeconfig", HAS_ARG, QEMU_OPTION_writeconfig,
3382 "-writeconfig <file>\n"
3383 " read/write config file\n", QEMU_ARCH_ALL)
3384 STEXI
3385 @item -writeconfig @var{file}
3386 @findex -writeconfig
3387 Write device configuration to @var{file}. The @var{file} can be either filename to save
3388 command line and device configuration into file or dash @code{-}) character to print the
3389 output to stdout. This can be later used as input file for @code{-readconfig} option.
3390 ETEXI
3391 DEF("nodefconfig", 0, QEMU_OPTION_nodefconfig,
3392 "-nodefconfig\n"
3393 " do not load default config files at startup\n",
3394 QEMU_ARCH_ALL)
3395 STEXI
3396 @item -nodefconfig
3397 @findex -nodefconfig
3398 Normally QEMU loads configuration files from @var{sysconfdir} and @var{datadir} at startup.
3399 The @code{-nodefconfig} option will prevent QEMU from loading any of those config files.
3400 ETEXI
3401 DEF("no-user-config", 0, QEMU_OPTION_nouserconfig,
3402 "-no-user-config\n"
3403 " do not load user-provided config files at startup\n",
3404 QEMU_ARCH_ALL)
3405 STEXI
3406 @item -no-user-config
3407 @findex -no-user-config
3408 The @code{-no-user-config} option makes QEMU not load any of the user-provided
3409 config files on @var{sysconfdir}, but won't make it skip the QEMU-provided config
3410 files from @var{datadir}.
3411 ETEXI
3412 DEF("trace", HAS_ARG, QEMU_OPTION_trace,
3413 "-trace [events=<file>][,file=<file>]\n"
3414 " specify tracing options\n",
3415 QEMU_ARCH_ALL)
3416 STEXI
3417 HXCOMM This line is not accurate, as some sub-options are backend-specific but
3418 HXCOMM HX does not support conditional compilation of text.
3419 @item -trace [events=@var{file}][,file=@var{file}]
3420 @findex -trace
3422 Specify tracing options.
3424 @table @option
3425 @item events=@var{file}
3426 Immediately enable events listed in @var{file}.
3427 The file must contain one event name (as listed in the @var{trace-events} file)
3428 per line.
3429 This option is only available if QEMU has been compiled with
3430 either @var{simple} or @var{stderr} tracing backend.
3431 @item file=@var{file}
3432 Log output traces to @var{file}.
3434 This option is only available if QEMU has been compiled with
3435 the @var{simple} tracing backend.
3436 @end table
3437 ETEXI
3439 HXCOMM Internal use
3440 DEF("qtest", HAS_ARG, QEMU_OPTION_qtest, "", QEMU_ARCH_ALL)
3441 DEF("qtest-log", HAS_ARG, QEMU_OPTION_qtest_log, "", QEMU_ARCH_ALL)
3443 #ifdef __linux__
3444 DEF("enable-fips", 0, QEMU_OPTION_enablefips,
3445 "-enable-fips enable FIPS 140-2 compliance\n",
3446 QEMU_ARCH_ALL)
3447 #endif
3448 STEXI
3449 @item -enable-fips
3450 @findex -enable-fips
3451 Enable FIPS 140-2 compliance mode.
3452 ETEXI
3454 HXCOMM Deprecated by -machine accel=tcg property
3455 DEF("no-kvm", 0, QEMU_OPTION_no_kvm, "", QEMU_ARCH_I386)
3457 HXCOMM Deprecated by kvm-pit driver properties
3458 DEF("no-kvm-pit-reinjection", 0, QEMU_OPTION_no_kvm_pit_reinjection,
3459 "", QEMU_ARCH_I386)
3461 HXCOMM Deprecated (ignored)
3462 DEF("no-kvm-pit", 0, QEMU_OPTION_no_kvm_pit, "", QEMU_ARCH_I386)
3464 HXCOMM Deprecated by -machine kernel_irqchip=on|off property
3465 DEF("no-kvm-irqchip", 0, QEMU_OPTION_no_kvm_irqchip, "", QEMU_ARCH_I386)
3467 HXCOMM Deprecated (ignored)
3468 DEF("tdf", 0, QEMU_OPTION_tdf,"", QEMU_ARCH_ALL)
3470 DEF("object", HAS_ARG, QEMU_OPTION_object,
3471 "-object TYPENAME[,PROP1=VALUE1,...]\n"
3472 " create an new object of type TYPENAME setting properties\n"
3473 " in the order they are specified. Note that the 'id'\n"
3474 " property must be set. These objects are placed in the\n"
3475 " '/objects' path.\n",
3476 QEMU_ARCH_ALL)
3477 STEXI
3478 @item -object @var{typename}[,@var{prop1}=@var{value1},...]
3479 @findex -object
3480 Create an new object of type @var{typename} setting properties
3481 in the order they are specified. Note that the 'id'
3482 property must be set. These objects are placed in the
3483 '/objects' path.
3484 ETEXI
3486 DEF("msg", HAS_ARG, QEMU_OPTION_msg,
3487 "-msg timestamp[=on|off]\n"
3488 " change the format of messages\n"
3489 " on|off controls leading timestamps (default:on)\n",
3490 QEMU_ARCH_ALL)
3491 STEXI
3492 @item -msg timestamp[=on|off]
3493 @findex -msg
3494 prepend a timestamp to each log message.(default:on)
3495 ETEXI
3497 DEF("dump-vmstate", HAS_ARG, QEMU_OPTION_dump_vmstate,
3498 "-dump-vmstate <file>\n"
3499 " Output vmstate information in JSON format to file.\n"
3500 " Use the scripts/vmstate-static-checker.py file to\n"
3501 " check for possible regressions in migration code\n"
3502 " by comparing two such vmstate dumps.",
3503 QEMU_ARCH_ALL)
3504 STEXI
3505 @item -dump-vmstate @var{file}
3506 @findex -dump-vmstate
3507 Dump json-encoded vmstate information for current machine type to file
3508 in @var{file}
3509 ETEXI
3511 HXCOMM This is the last statement. Insert new options before this line!
3512 STEXI
3513 @end table
3514 ETEXI