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