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