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