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