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