spapr-rtas: add CPU argument to RTAS calls
[qemu/ar7.git] / qemu-options.hx
blob137a39b7ad557890d06922c3a2b81c1789c0f9aa
1 HXCOMM Use DEFHEADING() to define headings in both help text and texi
2 HXCOMM Text between STEXI and ETEXI are copied to texi version and
3 HXCOMM discarded from C version
4 HXCOMM DEF(option, HAS_ARG/0, opt_enum, opt_help, arch_mask) is used to
5 HXCOMM construct option structures, enums and help message for specified
6 HXCOMM architectures.
7 HXCOMM HXCOMM can be used for comments, discarded from both texi and C
9 DEFHEADING(Standard options:)
10 STEXI
11 @table @option
12 ETEXI
14 DEF("help", 0, QEMU_OPTION_h,
15 "-h or -help display this help and exit\n", QEMU_ARCH_ALL)
16 STEXI
17 @item -h
18 @findex -h
19 Display help and exit
20 ETEXI
22 DEF("version", 0, QEMU_OPTION_version,
23 "-version display version information and exit\n", QEMU_ARCH_ALL)
24 STEXI
25 @item -version
26 @findex -version
27 Display version information and exit
28 ETEXI
30 DEF("machine", HAS_ARG, QEMU_OPTION_machine, \
31 "-machine [type=]name[,prop[=value][,...]]\n"
32 " selects emulated machine ('-machine help' for list)\n"
33 " property accel=accel1[:accel2[:...]] selects accelerator\n"
34 " supported accelerators are kvm, xen, tcg (default: tcg)\n"
35 " kernel_irqchip=on|off controls accelerated irqchip support\n"
36 " 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
64 HXCOMM Deprecated by -machine
65 DEF("M", HAS_ARG, QEMU_OPTION_M, "", QEMU_ARCH_ALL)
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
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
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
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
113 Add a file descriptor to an fd set. Valid options are:
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
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
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
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.:
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
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
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}.
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.
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.
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.
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.
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
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
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
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
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
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.
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
261 The default is @code{en-us}.
262 ETEXI
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
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.
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
295 Note that Linux's i810_audio OSS kernel (for AC97) module might
296 require manually specifying clocking.
298 @example
299 modprobe i810_audio clocking=48000
300 @end example
301 ETEXI
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
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
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
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
355 STEXI
356 @end table
357 ETEXI
358 DEFHEADING()
360 DEFHEADING(Block device options:)
361 STEXI
362 @table @option
363 ETEXI
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
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
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
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
418 Define a new drive. Valid options are:
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").
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
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.
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.
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.
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}.
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.
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.
503 Instead of @option{-cdrom} you can use:
504 @example
505 qemu-system-i386 -drive file=file,index=2,media=cdrom
506 @end example
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
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
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
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
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
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
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
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
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
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
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
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
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)
613 STEXI
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
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
668 ETEXI
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)
675 STEXI
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
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
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
731 STEXI
732 @end table
733 ETEXI
734 DEFHEADING()
736 DEFHEADING(USB options:)
737 STEXI
738 @table @option
739 ETEXI
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
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
755 @item -usbdevice @var{devname}
756 @findex -usbdevice
757 Add the USB device @var{devname}. @xref{usb_devices}.
759 @table @option
761 @item mouse
762 Virtual Mouse. This will override the PS/2 mouse emulation when activated.
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.
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.
774 @item host:@var{bus}.@var{addr}
775 Pass through the host device identified by @var{bus}.@var{addr} (Linux only).
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).
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.
785 @item braille
786 Braille device. This will use BrlAPI to display the braille output on a real
787 or fake device.
789 @item net:@var{options}
790 Network adapter that supports CDC ethernet and RNDIS protocols.
792 @end table
793 ETEXI
795 STEXI
796 @end table
797 ETEXI
798 DEFHEADING()
800 DEFHEADING(Display options:)
801 STEXI
802 @table @option
803 ETEXI
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
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. Therefore, you can still use QEMU to debug a Linux kernel
846 with a serial console.
847 ETEXI
849 DEF("curses", 0, QEMU_OPTION_curses,
850 "-curses use a curses/ncurses interface instead of SDL\n",
851 QEMU_ARCH_ALL)
852 STEXI
853 @item -curses
854 @findex -curses
855 Normally, QEMU uses SDL to display the VGA output. With this option,
856 QEMU can display the VGA output when in text mode using a
857 curses/ncurses interface. Nothing is displayed in graphical mode.
858 ETEXI
860 DEF("no-frame", 0, QEMU_OPTION_no_frame,
861 "-no-frame open SDL window without a frame and window decorations\n",
862 QEMU_ARCH_ALL)
863 STEXI
864 @item -no-frame
865 @findex -no-frame
866 Do not use decorations for SDL windows and start them using the whole
867 available screen space. This makes the using QEMU in a dedicated desktop
868 workspace more convenient.
869 ETEXI
871 DEF("alt-grab", 0, QEMU_OPTION_alt_grab,
872 "-alt-grab use Ctrl-Alt-Shift to grab mouse (instead of Ctrl-Alt)\n",
873 QEMU_ARCH_ALL)
874 STEXI
875 @item -alt-grab
876 @findex -alt-grab
877 Use Ctrl-Alt-Shift to grab mouse (instead of Ctrl-Alt). Note that this also
878 affects the special keys (for fullscreen, monitor-mode switching, etc).
879 ETEXI
881 DEF("ctrl-grab", 0, QEMU_OPTION_ctrl_grab,
882 "-ctrl-grab use Right-Ctrl to grab mouse (instead of Ctrl-Alt)\n",
883 QEMU_ARCH_ALL)
884 STEXI
885 @item -ctrl-grab
886 @findex -ctrl-grab
887 Use Right-Ctrl to grab mouse (instead of Ctrl-Alt). Note that this also
888 affects the special keys (for fullscreen, monitor-mode switching, etc).
889 ETEXI
891 DEF("no-quit", 0, QEMU_OPTION_no_quit,
892 "-no-quit disable SDL window close capability\n", QEMU_ARCH_ALL)
893 STEXI
894 @item -no-quit
895 @findex -no-quit
896 Disable SDL window close capability.
897 ETEXI
899 DEF("sdl", 0, QEMU_OPTION_sdl,
900 "-sdl enable SDL\n", QEMU_ARCH_ALL)
901 STEXI
902 @item -sdl
903 @findex -sdl
904 Enable SDL.
905 ETEXI
907 DEF("spice", HAS_ARG, QEMU_OPTION_spice,
908 "-spice [port=port][,tls-port=secured-port][,x509-dir=<dir>]\n"
909 " [,x509-key-file=<file>][,x509-key-password=<file>]\n"
910 " [,x509-cert-file=<file>][,x509-cacert-file=<file>]\n"
911 " [,x509-dh-key-file=<file>][,addr=addr][,ipv4|ipv6]\n"
912 " [,tls-ciphers=<list>]\n"
913 " [,tls-channel=[main|display|cursor|inputs|record|playback]]\n"
914 " [,plaintext-channel=[main|display|cursor|inputs|record|playback]]\n"
915 " [,sasl][,password=<secret>][,disable-ticketing]\n"
916 " [,image-compression=[auto_glz|auto_lz|quic|glz|lz|off]]\n"
917 " [,jpeg-wan-compression=[auto|never|always]]\n"
918 " [,zlib-glz-wan-compression=[auto|never|always]]\n"
919 " [,streaming-video=[off|all|filter]][,disable-copy-paste]\n"
920 " [,disable-agent-file-xfer][,agent-mouse=[on|off]]\n"
921 " [,playback-compression=[on|off]][,seamless-migration=[on|off]]\n"
922 " enable spice\n"
923 " at least one of {port, tls-port} is mandatory\n",
924 QEMU_ARCH_ALL)
925 STEXI
926 @item -spice @var{option}[,@var{option}[,...]]
927 @findex -spice
928 Enable the spice remote desktop protocol. Valid options are
930 @table @option
932 @item port=<nr>
933 Set the TCP port spice is listening on for plaintext channels.
935 @item addr=<addr>
936 Set the IP address spice is listening on. Default is any address.
938 @item ipv4
939 @item ipv6
940 Force using the specified IP version.
942 @item password=<secret>
943 Set the password you need to authenticate.
945 @item sasl
946 Require that the client use SASL to authenticate with the spice.
947 The exact choice of authentication method used is controlled from the
948 system / user's SASL configuration file for the 'qemu' service. This
949 is typically found in /etc/sasl2/qemu.conf. If running QEMU as an
950 unprivileged user, an environment variable SASL_CONF_PATH can be used
951 to make it search alternate locations for the service config.
952 While some SASL auth methods can also provide data encryption (eg GSSAPI),
953 it is recommended that SASL always be combined with the 'tls' and
954 'x509' settings to enable use of SSL and server certificates. This
955 ensures a data encryption preventing compromise of authentication
956 credentials.
958 @item disable-ticketing
959 Allow client connects without authentication.
961 @item disable-copy-paste
962 Disable copy paste between the client and the guest.
964 @item disable-agent-file-xfer
965 Disable spice-vdagent based file-xfer between the client and the guest.
967 @item tls-port=<nr>
968 Set the TCP port spice is listening on for encrypted channels.
970 @item x509-dir=<dir>
971 Set the x509 file directory. Expects same filenames as -vnc $display,x509=$dir
973 @item x509-key-file=<file>
974 @item x509-key-password=<file>
975 @item x509-cert-file=<file>
976 @item x509-cacert-file=<file>
977 @item x509-dh-key-file=<file>
978 The x509 file names can also be configured individually.
980 @item tls-ciphers=<list>
981 Specify which ciphers to use.
983 @item tls-channel=[main|display|cursor|inputs|record|playback]
984 @item plaintext-channel=[main|display|cursor|inputs|record|playback]
985 Force specific channel to be used with or without TLS encryption. The
986 options can be specified multiple times to configure multiple
987 channels. The special name "default" can be used to set the default
988 mode. For channels which are not explicitly forced into one mode the
989 spice client is allowed to pick tls/plaintext as he pleases.
991 @item image-compression=[auto_glz|auto_lz|quic|glz|lz|off]
992 Configure image compression (lossless).
993 Default is auto_glz.
995 @item jpeg-wan-compression=[auto|never|always]
996 @item zlib-glz-wan-compression=[auto|never|always]
997 Configure wan image compression (lossy for slow links).
998 Default is auto.
1000 @item streaming-video=[off|all|filter]
1001 Configure video stream detection. Default is filter.
1003 @item agent-mouse=[on|off]
1004 Enable/disable passing mouse events via vdagent. Default is on.
1006 @item playback-compression=[on|off]
1007 Enable/disable audio stream compression (using celt 0.5.1). Default is on.
1009 @item seamless-migration=[on|off]
1010 Enable/disable spice seamless migration. Default is off.
1012 @end table
1013 ETEXI
1015 DEF("portrait", 0, QEMU_OPTION_portrait,
1016 "-portrait rotate graphical output 90 deg left (only PXA LCD)\n",
1017 QEMU_ARCH_ALL)
1018 STEXI
1019 @item -portrait
1020 @findex -portrait
1021 Rotate graphical output 90 deg left (only PXA LCD).
1022 ETEXI
1024 DEF("rotate", HAS_ARG, QEMU_OPTION_rotate,
1025 "-rotate <deg> rotate graphical output some deg left (only PXA LCD)\n",
1026 QEMU_ARCH_ALL)
1027 STEXI
1028 @item -rotate @var{deg}
1029 @findex -rotate
1030 Rotate graphical output some deg left (only PXA LCD).
1031 ETEXI
1033 DEF("vga", HAS_ARG, QEMU_OPTION_vga,
1034 "-vga [std|cirrus|vmware|qxl|xenfb|none]\n"
1035 " select video card type\n", QEMU_ARCH_ALL)
1036 STEXI
1037 @item -vga @var{type}
1038 @findex -vga
1039 Select type of VGA card to emulate. Valid values for @var{type} are
1040 @table @option
1041 @item cirrus
1042 Cirrus Logic GD5446 Video card. All Windows versions starting from
1043 Windows 95 should recognize and use this graphic card. For optimal
1044 performances, use 16 bit color depth in the guest and the host OS.
1045 (This one is the default)
1046 @item std
1047 Standard VGA card with Bochs VBE extensions. If your guest OS
1048 supports the VESA 2.0 VBE extensions (e.g. Windows XP) and if you want
1049 to use high resolution modes (>= 1280x1024x16) then you should use
1050 this option.
1051 @item vmware
1052 VMWare SVGA-II compatible adapter. Use it if you have sufficiently
1053 recent XFree86/XOrg server or Windows guest with a driver for this
1054 card.
1055 @item qxl
1056 QXL paravirtual graphic card. It is VGA compatible (including VESA
1057 2.0 VBE support). Works best with qxl guest drivers installed though.
1058 Recommended choice when using the spice protocol.
1059 @item none
1060 Disable VGA card.
1061 @end table
1062 ETEXI
1064 DEF("full-screen", 0, QEMU_OPTION_full_screen,
1065 "-full-screen start in full screen\n", QEMU_ARCH_ALL)
1066 STEXI
1067 @item -full-screen
1068 @findex -full-screen
1069 Start in full screen.
1070 ETEXI
1072 DEF("g", 1, QEMU_OPTION_g ,
1073 "-g WxH[xDEPTH] Set the initial graphical resolution and depth\n",
1074 QEMU_ARCH_PPC | QEMU_ARCH_SPARC)
1075 STEXI
1076 @item -g @var{width}x@var{height}[x@var{depth}]
1077 @findex -g
1078 Set the initial graphical resolution and depth (PPC, SPARC only).
1079 ETEXI
1081 DEF("vnc", HAS_ARG, QEMU_OPTION_vnc ,
1082 "-vnc display start a VNC server on display\n", QEMU_ARCH_ALL)
1083 STEXI
1084 @item -vnc @var{display}[,@var{option}[,@var{option}[,...]]]
1085 @findex -vnc
1086 Normally, QEMU uses SDL to display the VGA output. With this option,
1087 you can have QEMU listen on VNC display @var{display} and redirect the VGA
1088 display over the VNC session. It is very useful to enable the usb
1089 tablet device when using this option (option @option{-usbdevice
1090 tablet}). When using the VNC display, you must use the @option{-k}
1091 parameter to set the keyboard layout if you are not using en-us. Valid
1092 syntax for the @var{display} is
1094 @table @option
1096 @item @var{host}:@var{d}
1098 TCP connections will only be allowed from @var{host} on display @var{d}.
1099 By convention the TCP port is 5900+@var{d}. Optionally, @var{host} can
1100 be omitted in which case the server will accept connections from any host.
1102 @item unix:@var{path}
1104 Connections will be allowed over UNIX domain sockets where @var{path} is the
1105 location of a unix socket to listen for connections on.
1107 @item none
1109 VNC is initialized but not started. The monitor @code{change} command
1110 can be used to later start the VNC server.
1112 @end table
1114 Following the @var{display} value there may be one or more @var{option} flags
1115 separated by commas. Valid options are
1117 @table @option
1119 @item reverse
1121 Connect to a listening VNC client via a ``reverse'' connection. The
1122 client is specified by the @var{display}. For reverse network
1123 connections (@var{host}:@var{d},@code{reverse}), the @var{d} argument
1124 is a TCP port number, not a display number.
1126 @item websocket
1128 Opens an additional TCP listening port dedicated to VNC Websocket connections.
1129 By definition the Websocket port is 5700+@var{display}. If @var{host} is
1130 specified connections will only be allowed from this host.
1131 As an alternative the Websocket port could be specified by using
1132 @code{websocket}=@var{port}.
1133 TLS encryption for the Websocket connection is supported if the required
1134 certificates are specified with the VNC option @option{x509}.
1136 @item password
1138 Require that password based authentication is used for client connections.
1140 The password must be set separately using the @code{set_password} command in
1141 the @ref{pcsys_monitor}. The syntax to change your password is:
1142 @code{set_password <protocol> <password>} where <protocol> could be either
1143 "vnc" or "spice".
1145 If you would like to change <protocol> password expiration, you should use
1146 @code{expire_password <protocol> <expiration-time>} where expiration time could
1147 be one of the following options: now, never, +seconds or UNIX time of
1148 expiration, e.g. +60 to make password expire in 60 seconds, or 1335196800
1149 to make password expire on "Mon Apr 23 12:00:00 EDT 2012" (UNIX time for this
1150 date and time).
1152 You can also use keywords "now" or "never" for the expiration time to
1153 allow <protocol> password to expire immediately or never expire.
1155 @item tls
1157 Require that client use TLS when communicating with the VNC server. This
1158 uses anonymous TLS credentials so is susceptible to a man-in-the-middle
1159 attack. It is recommended that this option be combined with either the
1160 @option{x509} or @option{x509verify} options.
1162 @item x509=@var{/path/to/certificate/dir}
1164 Valid if @option{tls} is specified. Require that x509 credentials are used
1165 for negotiating the TLS session. The server will send its x509 certificate
1166 to the client. It is recommended that a password be set on the VNC server
1167 to provide authentication of the client when this is used. The path following
1168 this option specifies where the x509 certificates are to be loaded from.
1169 See the @ref{vnc_security} section for details on generating certificates.
1171 @item x509verify=@var{/path/to/certificate/dir}
1173 Valid if @option{tls} is specified. Require that x509 credentials are used
1174 for negotiating the TLS session. The server will send its x509 certificate
1175 to the client, and request that the client send its own x509 certificate.
1176 The server will validate the client's certificate against the CA certificate,
1177 and reject clients when validation fails. If the certificate authority is
1178 trusted, this is a sufficient authentication mechanism. You may still wish
1179 to set a password on the VNC server as a second authentication layer. The
1180 path following this option specifies where the x509 certificates are to
1181 be loaded from. See the @ref{vnc_security} section for details on generating
1182 certificates.
1184 @item sasl
1186 Require that the client use SASL to authenticate with the VNC server.
1187 The exact choice of authentication method used is controlled from the
1188 system / user's SASL configuration file for the 'qemu' service. This
1189 is typically found in /etc/sasl2/qemu.conf. If running QEMU as an
1190 unprivileged user, an environment variable SASL_CONF_PATH can be used
1191 to make it search alternate locations for the service config.
1192 While some SASL auth methods can also provide data encryption (eg GSSAPI),
1193 it is recommended that SASL always be combined with the 'tls' and
1194 'x509' settings to enable use of SSL and server certificates. This
1195 ensures a data encryption preventing compromise of authentication
1196 credentials. See the @ref{vnc_security} section for details on using
1197 SASL authentication.
1199 @item acl
1201 Turn on access control lists for checking of the x509 client certificate
1202 and SASL party. For x509 certs, the ACL check is made against the
1203 certificate's distinguished name. This is something that looks like
1204 @code{C=GB,O=ACME,L=Boston,CN=bob}. For SASL party, the ACL check is
1205 made against the username, which depending on the SASL plugin, may
1206 include a realm component, eg @code{bob} or @code{bob@@EXAMPLE.COM}.
1207 When the @option{acl} flag is set, the initial access list will be
1208 empty, with a @code{deny} policy. Thus no one will be allowed to
1209 use the VNC server until the ACLs have been loaded. This can be
1210 achieved using the @code{acl} monitor command.
1212 @item lossy
1214 Enable lossy compression methods (gradient, JPEG, ...). If this
1215 option is set, VNC client may receive lossy framebuffer updates
1216 depending on its encoding settings. Enabling this option can save
1217 a lot of bandwidth at the expense of quality.
1219 @item non-adaptive
1221 Disable adaptive encodings. Adaptive encodings are enabled by default.
1222 An adaptive encoding will try to detect frequently updated screen regions,
1223 and send updates in these regions using a lossy encoding (like JPEG).
1224 This can be really helpful to save bandwidth when playing videos. Disabling
1225 adaptive encodings allows to restore the original static behavior of encodings
1226 like Tight.
1228 @item share=[allow-exclusive|force-shared|ignore]
1230 Set display sharing policy. 'allow-exclusive' allows clients to ask
1231 for exclusive access. As suggested by the rfb spec this is
1232 implemented by dropping other connections. Connecting multiple
1233 clients in parallel requires all clients asking for a shared session
1234 (vncviewer: -shared switch). This is the default. 'force-shared'
1235 disables exclusive client access. Useful for shared desktop sessions,
1236 where you don't want someone forgetting specify -shared disconnect
1237 everybody else. 'ignore' completely ignores the shared flag and
1238 allows everybody connect unconditionally. Doesn't conform to the rfb
1239 spec but is traditional QEMU behavior.
1241 @end table
1242 ETEXI
1244 STEXI
1245 @end table
1246 ETEXI
1247 ARCHHEADING(, QEMU_ARCH_I386)
1249 ARCHHEADING(i386 target only:, QEMU_ARCH_I386)
1250 STEXI
1251 @table @option
1252 ETEXI
1254 DEF("win2k-hack", 0, QEMU_OPTION_win2k_hack,
1255 "-win2k-hack use it when installing Windows 2000 to avoid a disk full bug\n",
1256 QEMU_ARCH_I386)
1257 STEXI
1258 @item -win2k-hack
1259 @findex -win2k-hack
1260 Use it when installing Windows 2000 to avoid a disk full bug. After
1261 Windows 2000 is installed, you no longer need this option (this option
1262 slows down the IDE transfers).
1263 ETEXI
1265 HXCOMM Deprecated by -rtc
1266 DEF("rtc-td-hack", 0, QEMU_OPTION_rtc_td_hack, "", QEMU_ARCH_I386)
1268 DEF("no-fd-bootchk", 0, QEMU_OPTION_no_fd_bootchk,
1269 "-no-fd-bootchk disable boot signature checking for floppy disks\n",
1270 QEMU_ARCH_I386)
1271 STEXI
1272 @item -no-fd-bootchk
1273 @findex -no-fd-bootchk
1274 Disable boot signature checking for floppy disks in BIOS. May
1275 be needed to boot from old floppy disks.
1276 ETEXI
1278 DEF("no-acpi", 0, QEMU_OPTION_no_acpi,
1279 "-no-acpi disable ACPI\n", QEMU_ARCH_I386)
1280 STEXI
1281 @item -no-acpi
1282 @findex -no-acpi
1283 Disable ACPI (Advanced Configuration and Power Interface) support. Use
1284 it if your guest OS complains about ACPI problems (PC target machine
1285 only).
1286 ETEXI
1288 DEF("no-hpet", 0, QEMU_OPTION_no_hpet,
1289 "-no-hpet disable HPET\n", QEMU_ARCH_I386)
1290 STEXI
1291 @item -no-hpet
1292 @findex -no-hpet
1293 Disable HPET support.
1294 ETEXI
1296 DEF("acpitable", HAS_ARG, QEMU_OPTION_acpitable,
1297 "-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"
1298 " ACPI table description\n", QEMU_ARCH_I386)
1299 STEXI
1300 @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}]...]
1301 @findex -acpitable
1302 Add ACPI table with specified header fields and context from specified files.
1303 For file=, take whole ACPI table from the specified files, including all
1304 ACPI headers (possible overridden by other options).
1305 For data=, only data
1306 portion of the table is used, all header information is specified in the
1307 command line.
1308 ETEXI
1310 DEF("smbios", HAS_ARG, QEMU_OPTION_smbios,
1311 "-smbios file=binary\n"
1312 " load SMBIOS entry from binary file\n"
1313 "-smbios type=0[,vendor=str][,version=str][,date=str][,release=%d.%d]\n"
1314 " specify SMBIOS type 0 fields\n"
1315 "-smbios type=1[,manufacturer=str][,product=str][,version=str][,serial=str]\n"
1316 " [,uuid=uuid][,sku=str][,family=str]\n"
1317 " specify SMBIOS type 1 fields\n", QEMU_ARCH_I386)
1318 STEXI
1319 @item -smbios file=@var{binary}
1320 @findex -smbios
1321 Load SMBIOS entry from binary file.
1323 @item -smbios type=0[,vendor=@var{str}][,version=@var{str}][,date=@var{str}][,release=@var{%d.%d}]
1324 Specify SMBIOS type 0 fields
1326 @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}]
1327 Specify SMBIOS type 1 fields
1328 ETEXI
1330 STEXI
1331 @end table
1332 ETEXI
1333 DEFHEADING()
1335 DEFHEADING(Network options:)
1336 STEXI
1337 @table @option
1338 ETEXI
1340 HXCOMM Legacy slirp options (now moved to -net user):
1341 #ifdef CONFIG_SLIRP
1342 DEF("tftp", HAS_ARG, QEMU_OPTION_tftp, "", QEMU_ARCH_ALL)
1343 DEF("bootp", HAS_ARG, QEMU_OPTION_bootp, "", QEMU_ARCH_ALL)
1344 DEF("redir", HAS_ARG, QEMU_OPTION_redir, "", QEMU_ARCH_ALL)
1345 #ifndef _WIN32
1346 DEF("smb", HAS_ARG, QEMU_OPTION_smb, "", QEMU_ARCH_ALL)
1347 #endif
1348 #endif
1350 DEF("net", HAS_ARG, QEMU_OPTION_net,
1351 "-net nic[,vlan=n][,macaddr=mac][,model=type][,name=str][,addr=str][,vectors=v]\n"
1352 " create a new Network Interface Card and connect it to VLAN 'n'\n"
1353 #ifdef CONFIG_SLIRP
1354 "-net user[,vlan=n][,name=str][,net=addr[/mask]][,host=addr][,restrict=on|off]\n"
1355 " [,hostname=host][,dhcpstart=addr][,dns=addr][,dnssearch=domain][,tftp=dir]\n"
1356 " [,bootfile=f][,hostfwd=rule][,guestfwd=rule]"
1357 #ifndef _WIN32
1358 "[,smb=dir[,smbserver=addr]]\n"
1359 #endif
1360 " connect the user mode network stack to VLAN 'n', configure its\n"
1361 " DHCP server and enabled optional services\n"
1362 #endif
1363 #ifdef _WIN32
1364 "-net tap[,vlan=n][,name=str],ifname=name\n"
1365 " connect the host TAP network interface to VLAN 'n'\n"
1366 #else
1367 "-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"
1368 " connect the host TAP network interface to VLAN 'n'\n"
1369 " use network scripts 'file' (default=" DEFAULT_NETWORK_SCRIPT ")\n"
1370 " to configure it and 'dfile' (default=" DEFAULT_NETWORK_DOWN_SCRIPT ")\n"
1371 " to deconfigure it\n"
1372 " use '[down]script=no' to disable script execution\n"
1373 " use network helper 'helper' (default=" DEFAULT_BRIDGE_HELPER ") to\n"
1374 " configure it\n"
1375 " use 'fd=h' to connect to an already opened TAP interface\n"
1376 " use 'fds=x:y:...:z' to connect to already opened multiqueue capable TAP interfaces\n"
1377 " use 'sndbuf=nbytes' to limit the size of the send buffer (the\n"
1378 " default is disabled 'sndbuf=0' to enable flow control set 'sndbuf=1048576')\n"
1379 " use vnet_hdr=off to avoid enabling the IFF_VNET_HDR tap flag\n"
1380 " use vnet_hdr=on to make the lack of IFF_VNET_HDR support an error condition\n"
1381 " use vhost=on to enable experimental in kernel accelerator\n"
1382 " (only has effect for virtio guests which use MSIX)\n"
1383 " use vhostforce=on to force vhost on for non-MSIX virtio guests\n"
1384 " use 'vhostfd=h' to connect to an already opened vhost net device\n"
1385 " use 'vhostfds=x:y:...:z to connect to multiple already opened vhost net devices\n"
1386 " use 'queues=n' to specify the number of queues to be created for multiqueue TAP\n"
1387 "-net bridge[,vlan=n][,name=str][,br=bridge][,helper=helper]\n"
1388 " connects a host TAP network interface to a host bridge device 'br'\n"
1389 " (default=" DEFAULT_BRIDGE_INTERFACE ") using the program 'helper'\n"
1390 " (default=" DEFAULT_BRIDGE_HELPER ")\n"
1391 #endif
1392 "-net socket[,vlan=n][,name=str][,fd=h][,listen=[host]:port][,connect=host:port]\n"
1393 " connect the vlan 'n' to another VLAN using a socket connection\n"
1394 "-net socket[,vlan=n][,name=str][,fd=h][,mcast=maddr:port[,localaddr=addr]]\n"
1395 " connect the vlan 'n' to multicast maddr and port\n"
1396 " use 'localaddr=addr' to specify the host address to send packets from\n"
1397 "-net socket[,vlan=n][,name=str][,fd=h][,udp=host:port][,localaddr=host:port]\n"
1398 " connect the vlan 'n' to another VLAN using an UDP tunnel\n"
1399 #ifdef CONFIG_VDE
1400 "-net vde[,vlan=n][,name=str][,sock=socketpath][,port=n][,group=groupname][,mode=octalmode]\n"
1401 " connect the vlan 'n' to port 'n' of a vde switch running\n"
1402 " on host and listening for incoming connections on 'socketpath'.\n"
1403 " Use group 'groupname' and mode 'octalmode' to change default\n"
1404 " ownership and permissions for communication port.\n"
1405 #endif
1406 "-net dump[,vlan=n][,file=f][,len=n]\n"
1407 " dump traffic on vlan 'n' to file 'f' (max n bytes per packet)\n"
1408 "-net none use it alone to have zero network devices. If no -net option\n"
1409 " is provided, the default is '-net nic -net user'\n", QEMU_ARCH_ALL)
1410 DEF("netdev", HAS_ARG, QEMU_OPTION_netdev,
1411 "-netdev ["
1412 #ifdef CONFIG_SLIRP
1413 "user|"
1414 #endif
1415 "tap|"
1416 "bridge|"
1417 #ifdef CONFIG_VDE
1418 "vde|"
1419 #endif
1420 "socket|"
1421 "hubport],id=str[,option][,option][,...]\n", QEMU_ARCH_ALL)
1422 STEXI
1423 @item -net nic[,vlan=@var{n}][,macaddr=@var{mac}][,model=@var{type}] [,name=@var{name}][,addr=@var{addr}][,vectors=@var{v}]
1424 @findex -net
1425 Create a new Network Interface Card and connect it to VLAN @var{n} (@var{n}
1426 = 0 is the default). The NIC is an e1000 by default on the PC
1427 target. Optionally, the MAC address can be changed to @var{mac}, the
1428 device address set to @var{addr} (PCI cards only),
1429 and a @var{name} can be assigned for use in monitor commands.
1430 Optionally, for PCI cards, you can specify the number @var{v} of MSI-X vectors
1431 that the card should have; this option currently only affects virtio cards; set
1432 @var{v} = 0 to disable MSI-X. If no @option{-net} option is specified, a single
1433 NIC is created. QEMU can emulate several different models of network card.
1434 Valid values for @var{type} are
1435 @code{virtio}, @code{i82551}, @code{i82557b}, @code{i82559er},
1436 @code{ne2k_pci}, @code{ne2k_isa}, @code{pcnet}, @code{rtl8139},
1437 @code{e1000}, @code{smc91c111}, @code{lance} and @code{mcf_fec}.
1438 Not all devices are supported on all targets. Use @code{-net nic,model=help}
1439 for a list of available devices for your target.
1441 @item -netdev user,id=@var{id}[,@var{option}][,@var{option}][,...]
1442 @findex -netdev
1443 @item -net user[,@var{option}][,@var{option}][,...]
1444 Use the user mode network stack which requires no administrator
1445 privilege to run. Valid options are:
1447 @table @option
1448 @item vlan=@var{n}
1449 Connect user mode stack to VLAN @var{n} (@var{n} = 0 is the default).
1451 @item id=@var{id}
1452 @item name=@var{name}
1453 Assign symbolic name for use in monitor commands.
1455 @item net=@var{addr}[/@var{mask}]
1456 Set IP network address the guest will see. Optionally specify the netmask,
1457 either in the form a.b.c.d or as number of valid top-most bits. Default is
1458 10.0.2.0/24.
1460 @item host=@var{addr}
1461 Specify the guest-visible address of the host. Default is the 2nd IP in the
1462 guest network, i.e. x.x.x.2.
1464 @item restrict=on|off
1465 If this option is enabled, the guest will be isolated, i.e. it will not be
1466 able to contact the host and no guest IP packets will be routed over the host
1467 to the outside. This option does not affect any explicitly set forwarding rules.
1469 @item hostname=@var{name}
1470 Specifies the client hostname reported by the built-in DHCP server.
1472 @item dhcpstart=@var{addr}
1473 Specify the first of the 16 IPs the built-in DHCP server can assign. Default
1474 is the 15th to 31st IP in the guest network, i.e. x.x.x.15 to x.x.x.31.
1476 @item dns=@var{addr}
1477 Specify the guest-visible address of the virtual nameserver. The address must
1478 be different from the host address. Default is the 3rd IP in the guest network,
1479 i.e. x.x.x.3.
1481 @item dnssearch=@var{domain}
1482 Provides an entry for the domain-search list sent by the built-in
1483 DHCP server. More than one domain suffix can be transmitted by specifying
1484 this option multiple times. If supported, this will cause the guest to
1485 automatically try to append the given domain suffix(es) in case a domain name
1486 can not be resolved.
1488 Example:
1489 @example
1490 qemu -net user,dnssearch=mgmt.example.org,dnssearch=example.org [...]
1491 @end example
1493 @item tftp=@var{dir}
1494 When using the user mode network stack, activate a built-in TFTP
1495 server. The files in @var{dir} will be exposed as the root of a TFTP server.
1496 The TFTP client on the guest must be configured in binary mode (use the command
1497 @code{bin} of the Unix TFTP client).
1499 @item bootfile=@var{file}
1500 When using the user mode network stack, broadcast @var{file} as the BOOTP
1501 filename. In conjunction with @option{tftp}, this can be used to network boot
1502 a guest from a local directory.
1504 Example (using pxelinux):
1505 @example
1506 qemu-system-i386 -hda linux.img -boot n -net user,tftp=/path/to/tftp/files,bootfile=/pxelinux.0
1507 @end example
1509 @item smb=@var{dir}[,smbserver=@var{addr}]
1510 When using the user mode network stack, activate a built-in SMB
1511 server so that Windows OSes can access to the host files in @file{@var{dir}}
1512 transparently. The IP address of the SMB server can be set to @var{addr}. By
1513 default the 4th IP in the guest network is used, i.e. x.x.x.4.
1515 In the guest Windows OS, the line:
1516 @example
1517 10.0.2.4 smbserver
1518 @end example
1519 must be added in the file @file{C:\WINDOWS\LMHOSTS} (for windows 9x/Me)
1520 or @file{C:\WINNT\SYSTEM32\DRIVERS\ETC\LMHOSTS} (Windows NT/2000).
1522 Then @file{@var{dir}} can be accessed in @file{\\smbserver\qemu}.
1524 Note that a SAMBA server must be installed on the host OS.
1525 QEMU was tested successfully with smbd versions from Red Hat 9,
1526 Fedora Core 3 and OpenSUSE 11.x.
1528 @item hostfwd=[tcp|udp]:[@var{hostaddr}]:@var{hostport}-[@var{guestaddr}]:@var{guestport}
1529 Redirect incoming TCP or UDP connections to the host port @var{hostport} to
1530 the guest IP address @var{guestaddr} on guest port @var{guestport}. If
1531 @var{guestaddr} is not specified, its value is x.x.x.15 (default first address
1532 given by the built-in DHCP server). By specifying @var{hostaddr}, the rule can
1533 be bound to a specific host interface. If no connection type is set, TCP is
1534 used. This option can be given multiple times.
1536 For example, to redirect host X11 connection from screen 1 to guest
1537 screen 0, use the following:
1539 @example
1540 # on the host
1541 qemu-system-i386 -net user,hostfwd=tcp:127.0.0.1:6001-:6000 [...]
1542 # this host xterm should open in the guest X11 server
1543 xterm -display :1
1544 @end example
1546 To redirect telnet connections from host port 5555 to telnet port on
1547 the guest, use the following:
1549 @example
1550 # on the host
1551 qemu-system-i386 -net user,hostfwd=tcp::5555-:23 [...]
1552 telnet localhost 5555
1553 @end example
1555 Then when you use on the host @code{telnet localhost 5555}, you
1556 connect to the guest telnet server.
1558 @item guestfwd=[tcp]:@var{server}:@var{port}-@var{dev}
1559 @item guestfwd=[tcp]:@var{server}:@var{port}-@var{cmd:command}
1560 Forward guest TCP connections to the IP address @var{server} on port @var{port}
1561 to the character device @var{dev} or to a program executed by @var{cmd:command}
1562 which gets spawned for each connection. This option can be given multiple times.
1564 You can either use a chardev directly and have that one used throughout QEMU's
1565 lifetime, like in the following example:
1567 @example
1568 # open 10.10.1.1:4321 on bootup, connect 10.0.2.100:1234 to it whenever
1569 # the guest accesses it
1570 qemu -net user,guestfwd=tcp:10.0.2.100:1234-tcp:10.10.1.1:4321 [...]
1571 @end example
1573 Or you can execute a command on every TCP connection established by the guest,
1574 so that QEMU behaves similar to an inetd process for that virtual server:
1576 @example
1577 # call "netcat 10.10.1.1 4321" on every TCP connection to 10.0.2.100:1234
1578 # and connect the TCP stream to its stdin/stdout
1579 qemu -net 'user,guestfwd=tcp:10.0.2.100:1234-cmd:netcat 10.10.1.1 4321'
1580 @end example
1582 @end table
1584 Note: Legacy stand-alone options -tftp, -bootp, -smb and -redir are still
1585 processed and applied to -net user. Mixing them with the new configuration
1586 syntax gives undefined results. Their use for new applications is discouraged
1587 as they will be removed from future versions.
1589 @item -netdev tap,id=@var{id}[,fd=@var{h}][,ifname=@var{name}][,script=@var{file}][,downscript=@var{dfile}][,helper=@var{helper}]
1590 @item -net tap[,vlan=@var{n}][,name=@var{name}][,fd=@var{h}][,ifname=@var{name}][,script=@var{file}][,downscript=@var{dfile}][,helper=@var{helper}]
1591 Connect the host TAP network interface @var{name} to VLAN @var{n}.
1593 Use the network script @var{file} to configure it and the network script
1594 @var{dfile} to deconfigure it. If @var{name} is not provided, the OS
1595 automatically provides one. The default network configure script is
1596 @file{/etc/qemu-ifup} and the default network deconfigure script is
1597 @file{/etc/qemu-ifdown}. Use @option{script=no} or @option{downscript=no}
1598 to disable script execution.
1600 If running QEMU as an unprivileged user, use the network helper
1601 @var{helper} to configure the TAP interface. The default network
1602 helper executable is @file{/usr/local/libexec/qemu-bridge-helper}.
1604 @option{fd}=@var{h} can be used to specify the handle of an already
1605 opened host TAP interface.
1607 Examples:
1609 @example
1610 #launch a QEMU instance with the default network script
1611 qemu-system-i386 linux.img -net nic -net tap
1612 @end example
1614 @example
1615 #launch a QEMU instance with two NICs, each one connected
1616 #to a TAP device
1617 qemu-system-i386 linux.img \
1618 -net nic,vlan=0 -net tap,vlan=0,ifname=tap0 \
1619 -net nic,vlan=1 -net tap,vlan=1,ifname=tap1
1620 @end example
1622 @example
1623 #launch a QEMU instance with the default network helper to
1624 #connect a TAP device to bridge br0
1625 qemu-system-i386 linux.img \
1626 -net nic -net tap,"helper=/usr/local/libexec/qemu-bridge-helper"
1627 @end example
1629 @item -netdev bridge,id=@var{id}[,br=@var{bridge}][,helper=@var{helper}]
1630 @item -net bridge[,vlan=@var{n}][,name=@var{name}][,br=@var{bridge}][,helper=@var{helper}]
1631 Connect a host TAP network interface to a host bridge device.
1633 Use the network helper @var{helper} to configure the TAP interface and
1634 attach it to the bridge. The default network helper executable is
1635 @file{/usr/local/libexec/qemu-bridge-helper} and the default bridge
1636 device is @file{br0}.
1638 Examples:
1640 @example
1641 #launch a QEMU instance with the default network helper to
1642 #connect a TAP device to bridge br0
1643 qemu-system-i386 linux.img -net bridge -net nic,model=virtio
1644 @end example
1646 @example
1647 #launch a QEMU instance with the default network helper to
1648 #connect a TAP device to bridge qemubr0
1649 qemu-system-i386 linux.img -net bridge,br=qemubr0 -net nic,model=virtio
1650 @end example
1652 @item -netdev socket,id=@var{id}[,fd=@var{h}][,listen=[@var{host}]:@var{port}][,connect=@var{host}:@var{port}]
1653 @item -net socket[,vlan=@var{n}][,name=@var{name}][,fd=@var{h}] [,listen=[@var{host}]:@var{port}][,connect=@var{host}:@var{port}]
1655 Connect the VLAN @var{n} to a remote VLAN in another QEMU virtual
1656 machine using a TCP socket connection. If @option{listen} is
1657 specified, QEMU waits for incoming connections on @var{port}
1658 (@var{host} is optional). @option{connect} is used to connect to
1659 another QEMU instance using the @option{listen} option. @option{fd}=@var{h}
1660 specifies an already opened TCP socket.
1662 Example:
1663 @example
1664 # launch a first QEMU instance
1665 qemu-system-i386 linux.img \
1666 -net nic,macaddr=52:54:00:12:34:56 \
1667 -net socket,listen=:1234
1668 # connect the VLAN 0 of this instance to the VLAN 0
1669 # of the first instance
1670 qemu-system-i386 linux.img \
1671 -net nic,macaddr=52:54:00:12:34:57 \
1672 -net socket,connect=127.0.0.1:1234
1673 @end example
1675 @item -netdev socket,id=@var{id}[,fd=@var{h}][,mcast=@var{maddr}:@var{port}[,localaddr=@var{addr}]]
1676 @item -net socket[,vlan=@var{n}][,name=@var{name}][,fd=@var{h}][,mcast=@var{maddr}:@var{port}[,localaddr=@var{addr}]]
1678 Create a VLAN @var{n} shared with another QEMU virtual
1679 machines using a UDP multicast socket, effectively making a bus for
1680 every QEMU with same multicast address @var{maddr} and @var{port}.
1681 NOTES:
1682 @enumerate
1683 @item
1684 Several QEMU can be running on different hosts and share same bus (assuming
1685 correct multicast setup for these hosts).
1686 @item
1687 mcast support is compatible with User Mode Linux (argument @option{eth@var{N}=mcast}), see
1688 @url{http://user-mode-linux.sf.net}.
1689 @item
1690 Use @option{fd=h} to specify an already opened UDP multicast socket.
1691 @end enumerate
1693 Example:
1694 @example
1695 # launch one QEMU instance
1696 qemu-system-i386 linux.img \
1697 -net nic,macaddr=52:54:00:12:34:56 \
1698 -net socket,mcast=230.0.0.1:1234
1699 # launch another QEMU instance on same "bus"
1700 qemu-system-i386 linux.img \
1701 -net nic,macaddr=52:54:00:12:34:57 \
1702 -net socket,mcast=230.0.0.1:1234
1703 # launch yet another QEMU instance on same "bus"
1704 qemu-system-i386 linux.img \
1705 -net nic,macaddr=52:54:00:12:34:58 \
1706 -net socket,mcast=230.0.0.1:1234
1707 @end example
1709 Example (User Mode Linux compat.):
1710 @example
1711 # launch QEMU instance (note mcast address selected
1712 # is UML's default)
1713 qemu-system-i386 linux.img \
1714 -net nic,macaddr=52:54:00:12:34:56 \
1715 -net socket,mcast=239.192.168.1:1102
1716 # launch UML
1717 /path/to/linux ubd0=/path/to/root_fs eth0=mcast
1718 @end example
1720 Example (send packets from host's 1.2.3.4):
1721 @example
1722 qemu-system-i386 linux.img \
1723 -net nic,macaddr=52:54:00:12:34:56 \
1724 -net socket,mcast=239.192.168.1:1102,localaddr=1.2.3.4
1725 @end example
1727 @item -netdev vde,id=@var{id}[,sock=@var{socketpath}][,port=@var{n}][,group=@var{groupname}][,mode=@var{octalmode}]
1728 @item -net vde[,vlan=@var{n}][,name=@var{name}][,sock=@var{socketpath}] [,port=@var{n}][,group=@var{groupname}][,mode=@var{octalmode}]
1729 Connect VLAN @var{n} to PORT @var{n} of a vde switch running on host and
1730 listening for incoming connections on @var{socketpath}. Use GROUP @var{groupname}
1731 and MODE @var{octalmode} to change default ownership and permissions for
1732 communication port. This option is only available if QEMU has been compiled
1733 with vde support enabled.
1735 Example:
1736 @example
1737 # launch vde switch
1738 vde_switch -F -sock /tmp/myswitch
1739 # launch QEMU instance
1740 qemu-system-i386 linux.img -net nic -net vde,sock=/tmp/myswitch
1741 @end example
1743 @item -netdev hubport,id=@var{id},hubid=@var{hubid}
1745 Create a hub port on QEMU "vlan" @var{hubid}.
1747 The hubport netdev lets you connect a NIC to a QEMU "vlan" instead of a single
1748 netdev. @code{-net} and @code{-device} with parameter @option{vlan} create the
1749 required hub automatically.
1751 @item -net dump[,vlan=@var{n}][,file=@var{file}][,len=@var{len}]
1752 Dump network traffic on VLAN @var{n} to file @var{file} (@file{qemu-vlan0.pcap} by default).
1753 At most @var{len} bytes (64k by default) per packet are stored. The file format is
1754 libpcap, so it can be analyzed with tools such as tcpdump or Wireshark.
1756 @item -net none
1757 Indicate that no network devices should be configured. It is used to
1758 override the default configuration (@option{-net nic -net user}) which
1759 is activated if no @option{-net} options are provided.
1760 ETEXI
1762 STEXI
1763 @end table
1764 ETEXI
1765 DEFHEADING()
1767 DEFHEADING(Character device options:)
1768 STEXI
1770 The general form of a character device option is:
1771 @table @option
1772 ETEXI
1774 DEF("chardev", HAS_ARG, QEMU_OPTION_chardev,
1775 "-chardev null,id=id[,mux=on|off]\n"
1776 "-chardev socket,id=id[,host=host],port=host[,to=to][,ipv4][,ipv6][,nodelay]\n"
1777 " [,server][,nowait][,telnet][,mux=on|off] (tcp)\n"
1778 "-chardev socket,id=id,path=path[,server][,nowait][,telnet],[mux=on|off] (unix)\n"
1779 "-chardev udp,id=id[,host=host],port=port[,localaddr=localaddr]\n"
1780 " [,localport=localport][,ipv4][,ipv6][,mux=on|off]\n"
1781 "-chardev msmouse,id=id[,mux=on|off]\n"
1782 "-chardev vc,id=id[[,width=width][,height=height]][[,cols=cols][,rows=rows]]\n"
1783 " [,mux=on|off]\n"
1784 "-chardev memory,id=id[,size=size]\n"
1785 "-chardev file,id=id,path=path[,mux=on|off]\n"
1786 "-chardev pipe,id=id,path=path[,mux=on|off]\n"
1787 #ifdef _WIN32
1788 "-chardev console,id=id[,mux=on|off]\n"
1789 "-chardev serial,id=id,path=path[,mux=on|off]\n"
1790 #else
1791 "-chardev pty,id=id[,mux=on|off]\n"
1792 "-chardev stdio,id=id[,mux=on|off][,signal=on|off]\n"
1793 #endif
1794 #ifdef CONFIG_BRLAPI
1795 "-chardev braille,id=id[,mux=on|off]\n"
1796 #endif
1797 #if defined(__linux__) || defined(__sun__) || defined(__FreeBSD__) \
1798 || defined(__NetBSD__) || defined(__OpenBSD__) || defined(__DragonFly__)
1799 "-chardev serial,id=id,path=path[,mux=on|off]\n"
1800 "-chardev tty,id=id,path=path[,mux=on|off]\n"
1801 #endif
1802 #if defined(__linux__) || defined(__FreeBSD__) || defined(__DragonFly__)
1803 "-chardev parallel,id=id,path=path[,mux=on|off]\n"
1804 "-chardev parport,id=id,path=path[,mux=on|off]\n"
1805 #endif
1806 #if defined(CONFIG_SPICE)
1807 "-chardev spicevmc,id=id,name=name[,debug=debug]\n"
1808 "-chardev spiceport,id=id,name=name[,debug=debug]\n"
1809 #endif
1810 , QEMU_ARCH_ALL
1813 STEXI
1814 @item -chardev @var{backend} ,id=@var{id} [,mux=on|off] [,@var{options}]
1815 @findex -chardev
1816 Backend is one of:
1817 @option{null},
1818 @option{socket},
1819 @option{udp},
1820 @option{msmouse},
1821 @option{vc},
1822 @option{memory},
1823 @option{file},
1824 @option{pipe},
1825 @option{console},
1826 @option{serial},
1827 @option{pty},
1828 @option{stdio},
1829 @option{braille},
1830 @option{tty},
1831 @option{parallel},
1832 @option{parport},
1833 @option{spicevmc}.
1834 @option{spiceport}.
1835 The specific backend will determine the applicable options.
1837 All devices must have an id, which can be any string up to 127 characters long.
1838 It is used to uniquely identify this device in other command line directives.
1840 A character device may be used in multiplexing mode by multiple front-ends.
1841 The key sequence of @key{Control-a} and @key{c} will rotate the input focus
1842 between attached front-ends. Specify @option{mux=on} to enable this mode.
1844 Options to each backend are described below.
1846 @item -chardev null ,id=@var{id}
1847 A void device. This device will not emit any data, and will drop any data it
1848 receives. The null backend does not take any options.
1850 @item -chardev socket ,id=@var{id} [@var{TCP options} or @var{unix options}] [,server] [,nowait] [,telnet]
1852 Create a two-way stream socket, which can be either a TCP or a unix socket. A
1853 unix socket will be created if @option{path} is specified. Behaviour is
1854 undefined if TCP options are specified for a unix socket.
1856 @option{server} specifies that the socket shall be a listening socket.
1858 @option{nowait} specifies that QEMU should not block waiting for a client to
1859 connect to a listening socket.
1861 @option{telnet} specifies that traffic on the socket should interpret telnet
1862 escape sequences.
1864 TCP and unix socket options are given below:
1866 @table @option
1868 @item TCP options: port=@var{port} [,host=@var{host}] [,to=@var{to}] [,ipv4] [,ipv6] [,nodelay]
1870 @option{host} for a listening socket specifies the local address to be bound.
1871 For a connecting socket species the remote host to connect to. @option{host} is
1872 optional for listening sockets. If not specified it defaults to @code{0.0.0.0}.
1874 @option{port} for a listening socket specifies the local port to be bound. For a
1875 connecting socket specifies the port on the remote host to connect to.
1876 @option{port} can be given as either a port number or a service name.
1877 @option{port} is required.
1879 @option{to} is only relevant to listening sockets. If it is specified, and
1880 @option{port} cannot be bound, QEMU will attempt to bind to subsequent ports up
1881 to and including @option{to} until it succeeds. @option{to} must be specified
1882 as a port number.
1884 @option{ipv4} and @option{ipv6} specify that either IPv4 or IPv6 must be used.
1885 If neither is specified the socket may use either protocol.
1887 @option{nodelay} disables the Nagle algorithm.
1889 @item unix options: path=@var{path}
1891 @option{path} specifies the local path of the unix socket. @option{path} is
1892 required.
1894 @end table
1896 @item -chardev udp ,id=@var{id} [,host=@var{host}] ,port=@var{port} [,localaddr=@var{localaddr}] [,localport=@var{localport}] [,ipv4] [,ipv6]
1898 Sends all traffic from the guest to a remote host over UDP.
1900 @option{host} specifies the remote host to connect to. If not specified it
1901 defaults to @code{localhost}.
1903 @option{port} specifies the port on the remote host to connect to. @option{port}
1904 is required.
1906 @option{localaddr} specifies the local address to bind to. If not specified it
1907 defaults to @code{0.0.0.0}.
1909 @option{localport} specifies the local port to bind to. If not specified any
1910 available local port will be used.
1912 @option{ipv4} and @option{ipv6} specify that either IPv4 or IPv6 must be used.
1913 If neither is specified the device may use either protocol.
1915 @item -chardev msmouse ,id=@var{id}
1917 Forward QEMU's emulated msmouse events to the guest. @option{msmouse} does not
1918 take any options.
1920 @item -chardev vc ,id=@var{id} [[,width=@var{width}] [,height=@var{height}]] [[,cols=@var{cols}] [,rows=@var{rows}]]
1922 Connect to a QEMU text console. @option{vc} may optionally be given a specific
1923 size.
1925 @option{width} and @option{height} specify the width and height respectively of
1926 the console, in pixels.
1928 @option{cols} and @option{rows} specify that the console be sized to fit a text
1929 console with the given dimensions.
1931 @item -chardev memory ,id=@var{id} [,size=@var{size}]
1933 Create a ring buffer with fixed size @option{size}.
1934 @var{size} must be a power of two, and defaults to @code{64K}).
1936 @item -chardev file ,id=@var{id} ,path=@var{path}
1938 Log all traffic received from the guest to a file.
1940 @option{path} specifies the path of the file to be opened. This file will be
1941 created if it does not already exist, and overwritten if it does. @option{path}
1942 is required.
1944 @item -chardev pipe ,id=@var{id} ,path=@var{path}
1946 Create a two-way connection to the guest. The behaviour differs slightly between
1947 Windows hosts and other hosts:
1949 On Windows, a single duplex pipe will be created at
1950 @file{\\.pipe\@option{path}}.
1952 On other hosts, 2 pipes will be created called @file{@option{path}.in} and
1953 @file{@option{path}.out}. Data written to @file{@option{path}.in} will be
1954 received by the guest. Data written by the guest can be read from
1955 @file{@option{path}.out}. QEMU will not create these fifos, and requires them to
1956 be present.
1958 @option{path} forms part of the pipe path as described above. @option{path} is
1959 required.
1961 @item -chardev console ,id=@var{id}
1963 Send traffic from the guest to QEMU's standard output. @option{console} does not
1964 take any options.
1966 @option{console} is only available on Windows hosts.
1968 @item -chardev serial ,id=@var{id} ,path=@option{path}
1970 Send traffic from the guest to a serial device on the host.
1972 On Unix hosts serial will actually accept any tty device,
1973 not only serial lines.
1975 @option{path} specifies the name of the serial device to open.
1977 @item -chardev pty ,id=@var{id}
1979 Create a new pseudo-terminal on the host and connect to it. @option{pty} does
1980 not take any options.
1982 @option{pty} is not available on Windows hosts.
1984 @item -chardev stdio ,id=@var{id} [,signal=on|off]
1985 Connect to standard input and standard output of the QEMU process.
1987 @option{signal} controls if signals are enabled on the terminal, that includes
1988 exiting QEMU with the key sequence @key{Control-c}. This option is enabled by
1989 default, use @option{signal=off} to disable it.
1991 @option{stdio} is not available on Windows hosts.
1993 @item -chardev braille ,id=@var{id}
1995 Connect to a local BrlAPI server. @option{braille} does not take any options.
1997 @item -chardev tty ,id=@var{id} ,path=@var{path}
1999 @option{tty} is only available on Linux, Sun, FreeBSD, NetBSD, OpenBSD and
2000 DragonFlyBSD hosts. It is an alias for @option{serial}.
2002 @option{path} specifies the path to the tty. @option{path} is required.
2004 @item -chardev parallel ,id=@var{id} ,path=@var{path}
2005 @item -chardev parport ,id=@var{id} ,path=@var{path}
2007 @option{parallel} is only available on Linux, FreeBSD and DragonFlyBSD hosts.
2009 Connect to a local parallel port.
2011 @option{path} specifies the path to the parallel port device. @option{path} is
2012 required.
2014 @item -chardev spicevmc ,id=@var{id} ,debug=@var{debug}, name=@var{name}
2016 @option{spicevmc} is only available when spice support is built in.
2018 @option{debug} debug level for spicevmc
2020 @option{name} name of spice channel to connect to
2022 Connect to a spice virtual machine channel, such as vdiport.
2024 @item -chardev spiceport ,id=@var{id} ,debug=@var{debug}, name=@var{name}
2026 @option{spiceport} is only available when spice support is built in.
2028 @option{debug} debug level for spicevmc
2030 @option{name} name of spice port to connect to
2032 Connect to a spice port, allowing a Spice client to handle the traffic
2033 identified by a name (preferably a fqdn).
2034 ETEXI
2036 STEXI
2037 @end table
2038 ETEXI
2039 DEFHEADING()
2041 DEFHEADING(Device URL Syntax:)
2042 STEXI
2044 In addition to using normal file images for the emulated storage devices,
2045 QEMU can also use networked resources such as iSCSI devices. These are
2046 specified using a special URL syntax.
2048 @table @option
2049 @item iSCSI
2050 iSCSI support allows QEMU to access iSCSI resources directly and use as
2051 images for the guest storage. Both disk and cdrom images are supported.
2053 Syntax for specifying iSCSI LUNs is
2054 ``iscsi://<target-ip>[:<port>]/<target-iqn>/<lun>''
2056 By default qemu will use the iSCSI initiator-name
2057 'iqn.2008-11.org.linux-kvm[:<name>]' but this can also be set from the command
2058 line or a configuration file.
2061 Example (without authentication):
2062 @example
2063 qemu-system-i386 -iscsi initiator-name=iqn.2001-04.com.example:my-initiator \
2064 -cdrom iscsi://192.0.2.1/iqn.2001-04.com.example/2 \
2065 -drive file=iscsi://192.0.2.1/iqn.2001-04.com.example/1
2066 @end example
2068 Example (CHAP username/password via URL):
2069 @example
2070 qemu-system-i386 -drive file=iscsi://user%password@@192.0.2.1/iqn.2001-04.com.example/1
2071 @end example
2073 Example (CHAP username/password via environment variables):
2074 @example
2075 LIBISCSI_CHAP_USERNAME="user" \
2076 LIBISCSI_CHAP_PASSWORD="password" \
2077 qemu-system-i386 -drive file=iscsi://192.0.2.1/iqn.2001-04.com.example/1
2078 @end example
2080 iSCSI support is an optional feature of QEMU and only available when
2081 compiled and linked against libiscsi.
2082 ETEXI
2083 DEF("iscsi", HAS_ARG, QEMU_OPTION_iscsi,
2084 "-iscsi [user=user][,password=password]\n"
2085 " [,header-digest=CRC32C|CR32C-NONE|NONE-CRC32C|NONE\n"
2086 " [,initiator-name=iqn]\n"
2087 " iSCSI session parameters\n", QEMU_ARCH_ALL)
2088 STEXI
2090 iSCSI parameters such as username and password can also be specified via
2091 a configuration file. See qemu-doc for more information and examples.
2093 @item NBD
2094 QEMU supports NBD (Network Block Devices) both using TCP protocol as well
2095 as Unix Domain Sockets.
2097 Syntax for specifying a NBD device using TCP
2098 ``nbd:<server-ip>:<port>[:exportname=<export>]''
2100 Syntax for specifying a NBD device using Unix Domain Sockets
2101 ``nbd:unix:<domain-socket>[:exportname=<export>]''
2104 Example for TCP
2105 @example
2106 qemu-system-i386 --drive file=nbd:192.0.2.1:30000
2107 @end example
2109 Example for Unix Domain Sockets
2110 @example
2111 qemu-system-i386 --drive file=nbd:unix:/tmp/nbd-socket
2112 @end example
2114 @item SSH
2115 QEMU supports SSH (Secure Shell) access to remote disks.
2117 Examples:
2118 @example
2119 qemu-system-i386 -drive file=ssh://user@@host/path/to/disk.img
2120 qemu-system-i386 -drive file.driver=ssh,file.user=user,file.host=host,file.port=22,file.path=/path/to/disk.img
2121 @end example
2123 Currently authentication must be done using ssh-agent. Other
2124 authentication methods may be supported in future.
2126 @item Sheepdog
2127 Sheepdog is a distributed storage system for QEMU.
2128 QEMU supports using either local sheepdog devices or remote networked
2129 devices.
2131 Syntax for specifying a sheepdog device
2132 @example
2133 sheepdog[+tcp|+unix]://[host:port]/vdiname[?socket=path][#snapid|#tag]
2134 @end example
2136 Example
2137 @example
2138 qemu-system-i386 --drive file=sheepdog://192.0.2.1:30000/MyVirtualMachine
2139 @end example
2141 See also @url{http://http://www.osrg.net/sheepdog/}.
2143 @item GlusterFS
2144 GlusterFS is an user space distributed file system.
2145 QEMU supports the use of GlusterFS volumes for hosting VM disk images using
2146 TCP, Unix Domain Sockets and RDMA transport protocols.
2148 Syntax for specifying a VM disk image on GlusterFS volume is
2149 @example
2150 gluster[+transport]://[server[:port]]/volname/image[?socket=...]
2151 @end example
2154 Example
2155 @example
2156 qemu-system-x86_64 --drive file=gluster://192.0.2.1/testvol/a.img
2157 @end example
2159 See also @url{http://www.gluster.org}.
2160 ETEXI
2162 STEXI
2163 @end table
2164 ETEXI
2166 DEFHEADING(Bluetooth(R) options:)
2167 STEXI
2168 @table @option
2169 ETEXI
2171 DEF("bt", HAS_ARG, QEMU_OPTION_bt, \
2172 "-bt hci,null dumb bluetooth HCI - doesn't respond to commands\n" \
2173 "-bt hci,host[:id]\n" \
2174 " use host's HCI with the given name\n" \
2175 "-bt hci[,vlan=n]\n" \
2176 " emulate a standard HCI in virtual scatternet 'n'\n" \
2177 "-bt vhci[,vlan=n]\n" \
2178 " add host computer to virtual scatternet 'n' using VHCI\n" \
2179 "-bt device:dev[,vlan=n]\n" \
2180 " emulate a bluetooth device 'dev' in scatternet 'n'\n",
2181 QEMU_ARCH_ALL)
2182 STEXI
2183 @item -bt hci[...]
2184 @findex -bt
2185 Defines the function of the corresponding Bluetooth HCI. -bt options
2186 are matched with the HCIs present in the chosen machine type. For
2187 example when emulating a machine with only one HCI built into it, only
2188 the first @code{-bt hci[...]} option is valid and defines the HCI's
2189 logic. The Transport Layer is decided by the machine type. Currently
2190 the machines @code{n800} and @code{n810} have one HCI and all other
2191 machines have none.
2193 @anchor{bt-hcis}
2194 The following three types are recognized:
2196 @table @option
2197 @item -bt hci,null
2198 (default) The corresponding Bluetooth HCI assumes no internal logic
2199 and will not respond to any HCI commands or emit events.
2201 @item -bt hci,host[:@var{id}]
2202 (@code{bluez} only) The corresponding HCI passes commands / events
2203 to / from the physical HCI identified by the name @var{id} (default:
2204 @code{hci0}) on the computer running QEMU. Only available on @code{bluez}
2205 capable systems like Linux.
2207 @item -bt hci[,vlan=@var{n}]
2208 Add a virtual, standard HCI that will participate in the Bluetooth
2209 scatternet @var{n} (default @code{0}). Similarly to @option{-net}
2210 VLANs, devices inside a bluetooth network @var{n} can only communicate
2211 with other devices in the same network (scatternet).
2212 @end table
2214 @item -bt vhci[,vlan=@var{n}]
2215 (Linux-host only) Create a HCI in scatternet @var{n} (default 0) attached
2216 to the host bluetooth stack instead of to the emulated target. This
2217 allows the host and target machines to participate in a common scatternet
2218 and communicate. Requires the Linux @code{vhci} driver installed. Can
2219 be used as following:
2221 @example
2222 qemu-system-i386 [...OPTIONS...] -bt hci,vlan=5 -bt vhci,vlan=5
2223 @end example
2225 @item -bt device:@var{dev}[,vlan=@var{n}]
2226 Emulate a bluetooth device @var{dev} and place it in network @var{n}
2227 (default @code{0}). QEMU can only emulate one type of bluetooth devices
2228 currently:
2230 @table @option
2231 @item keyboard
2232 Virtual wireless keyboard implementing the HIDP bluetooth profile.
2233 @end table
2234 ETEXI
2236 STEXI
2237 @end table
2238 ETEXI
2239 DEFHEADING()
2241 #ifdef CONFIG_TPM
2242 DEFHEADING(TPM device options:)
2244 DEF("tpmdev", HAS_ARG, QEMU_OPTION_tpmdev, \
2245 "-tpmdev passthrough,id=id[,path=path][,cancel-path=path]\n"
2246 " use path to provide path to a character device; default is /dev/tpm0\n"
2247 " use cancel-path to provide path to TPM's cancel sysfs entry; if\n"
2248 " not provided it will be searched for in /sys/class/misc/tpm?/device\n",
2249 QEMU_ARCH_ALL)
2250 STEXI
2252 The general form of a TPM device option is:
2253 @table @option
2255 @item -tpmdev @var{backend} ,id=@var{id} [,@var{options}]
2256 @findex -tpmdev
2257 Backend type must be:
2258 @option{passthrough}.
2260 The specific backend type will determine the applicable options.
2261 The @code{-tpmdev} option creates the TPM backend and requires a
2262 @code{-device} option that specifies the TPM frontend interface model.
2264 Options to each backend are described below.
2266 Use 'help' to print all available TPM backend types.
2267 @example
2268 qemu -tpmdev help
2269 @end example
2271 @item -tpmdev passthrough, id=@var{id}, path=@var{path}, cancel-path=@var{cancel-path}
2273 (Linux-host only) Enable access to the host's TPM using the passthrough
2274 driver.
2276 @option{path} specifies the path to the host's TPM device, i.e., on
2277 a Linux host this would be @code{/dev/tpm0}.
2278 @option{path} is optional and by default @code{/dev/tpm0} is used.
2280 @option{cancel-path} specifies the path to the host TPM device's sysfs
2281 entry allowing for cancellation of an ongoing TPM command.
2282 @option{cancel-path} is optional and by default QEMU will search for the
2283 sysfs entry to use.
2285 Some notes about using the host's TPM with the passthrough driver:
2287 The TPM device accessed by the passthrough driver must not be
2288 used by any other application on the host.
2290 Since the host's firmware (BIOS/UEFI) has already initialized the TPM,
2291 the VM's firmware (BIOS/UEFI) will not be able to initialize the
2292 TPM again and may therefore not show a TPM-specific menu that would
2293 otherwise allow the user to configure the TPM, e.g., allow the user to
2294 enable/disable or activate/deactivate the TPM.
2295 Further, if TPM ownership is released from within a VM then the host's TPM
2296 will get disabled and deactivated. To enable and activate the
2297 TPM again afterwards, the host has to be rebooted and the user is
2298 required to enter the firmware's menu to enable and activate the TPM.
2299 If the TPM is left disabled and/or deactivated most TPM commands will fail.
2301 To create a passthrough TPM use the following two options:
2302 @example
2303 -tpmdev passthrough,id=tpm0 -device tpm-tis,tpmdev=tpm0
2304 @end example
2305 Note that the @code{-tpmdev} id is @code{tpm0} and is referenced by
2306 @code{tpmdev=tpm0} in the device option.
2308 @end table
2310 ETEXI
2312 DEFHEADING()
2314 #endif
2316 DEFHEADING(Linux/Multiboot boot specific:)
2317 STEXI
2319 When using these options, you can use a given Linux or Multiboot
2320 kernel without installing it in the disk image. It can be useful
2321 for easier testing of various kernels.
2323 @table @option
2324 ETEXI
2326 DEF("kernel", HAS_ARG, QEMU_OPTION_kernel, \
2327 "-kernel bzImage use 'bzImage' as kernel image\n", QEMU_ARCH_ALL)
2328 STEXI
2329 @item -kernel @var{bzImage}
2330 @findex -kernel
2331 Use @var{bzImage} as kernel image. The kernel can be either a Linux kernel
2332 or in multiboot format.
2333 ETEXI
2335 DEF("append", HAS_ARG, QEMU_OPTION_append, \
2336 "-append cmdline use 'cmdline' as kernel command line\n", QEMU_ARCH_ALL)
2337 STEXI
2338 @item -append @var{cmdline}
2339 @findex -append
2340 Use @var{cmdline} as kernel command line
2341 ETEXI
2343 DEF("initrd", HAS_ARG, QEMU_OPTION_initrd, \
2344 "-initrd file use 'file' as initial ram disk\n", QEMU_ARCH_ALL)
2345 STEXI
2346 @item -initrd @var{file}
2347 @findex -initrd
2348 Use @var{file} as initial ram disk.
2350 @item -initrd "@var{file1} arg=foo,@var{file2}"
2352 This syntax is only available with multiboot.
2354 Use @var{file1} and @var{file2} as modules and pass arg=foo as parameter to the
2355 first module.
2356 ETEXI
2358 DEF("dtb", HAS_ARG, QEMU_OPTION_dtb, \
2359 "-dtb file use 'file' as device tree image\n", QEMU_ARCH_ALL)
2360 STEXI
2361 @item -dtb @var{file}
2362 @findex -dtb
2363 Use @var{file} as a device tree binary (dtb) image and pass it to the kernel
2364 on boot.
2365 ETEXI
2367 STEXI
2368 @end table
2369 ETEXI
2370 DEFHEADING()
2372 DEFHEADING(Debug/Expert options:)
2373 STEXI
2374 @table @option
2375 ETEXI
2377 DEF("serial", HAS_ARG, QEMU_OPTION_serial, \
2378 "-serial dev redirect the serial port to char device 'dev'\n",
2379 QEMU_ARCH_ALL)
2380 STEXI
2381 @item -serial @var{dev}
2382 @findex -serial
2383 Redirect the virtual serial port to host character device
2384 @var{dev}. The default device is @code{vc} in graphical mode and
2385 @code{stdio} in non graphical mode.
2387 This option can be used several times to simulate up to 4 serial
2388 ports.
2390 Use @code{-serial none} to disable all serial ports.
2392 Available character devices are:
2393 @table @option
2394 @item vc[:@var{W}x@var{H}]
2395 Virtual console. Optionally, a width and height can be given in pixel with
2396 @example
2397 vc:800x600
2398 @end example
2399 It is also possible to specify width or height in characters:
2400 @example
2401 vc:80Cx24C
2402 @end example
2403 @item pty
2404 [Linux only] Pseudo TTY (a new PTY is automatically allocated)
2405 @item none
2406 No device is allocated.
2407 @item null
2408 void device
2409 @item /dev/XXX
2410 [Linux only] Use host tty, e.g. @file{/dev/ttyS0}. The host serial port
2411 parameters are set according to the emulated ones.
2412 @item /dev/parport@var{N}
2413 [Linux only, parallel port only] Use host parallel port
2414 @var{N}. Currently SPP and EPP parallel port features can be used.
2415 @item file:@var{filename}
2416 Write output to @var{filename}. No character can be read.
2417 @item stdio
2418 [Unix only] standard input/output
2419 @item pipe:@var{filename}
2420 name pipe @var{filename}
2421 @item COM@var{n}
2422 [Windows only] Use host serial port @var{n}
2423 @item udp:[@var{remote_host}]:@var{remote_port}[@@[@var{src_ip}]:@var{src_port}]
2424 This implements UDP Net Console.
2425 When @var{remote_host} or @var{src_ip} are not specified
2426 they default to @code{0.0.0.0}.
2427 When not using a specified @var{src_port} a random port is automatically chosen.
2429 If you just want a simple readonly console you can use @code{netcat} or
2430 @code{nc}, by starting QEMU with: @code{-serial udp::4555} and nc as:
2431 @code{nc -u -l -p 4555}. Any time QEMU writes something to that port it
2432 will appear in the netconsole session.
2434 If you plan to send characters back via netconsole or you want to stop
2435 and start QEMU a lot of times, you should have QEMU use the same
2436 source port each time by using something like @code{-serial
2437 udp::4555@@:4556} to QEMU. Another approach is to use a patched
2438 version of netcat which can listen to a TCP port and send and receive
2439 characters via udp. If you have a patched version of netcat which
2440 activates telnet remote echo and single char transfer, then you can
2441 use the following options to step up a netcat redirector to allow
2442 telnet on port 5555 to access the QEMU port.
2443 @table @code
2444 @item QEMU Options:
2445 -serial udp::4555@@:4556
2446 @item netcat options:
2447 -u -P 4555 -L 0.0.0.0:4556 -t -p 5555 -I -T
2448 @item telnet options:
2449 localhost 5555
2450 @end table
2452 @item tcp:[@var{host}]:@var{port}[,@var{server}][,nowait][,nodelay]
2453 The TCP Net Console has two modes of operation. It can send the serial
2454 I/O to a location or wait for a connection from a location. By default
2455 the TCP Net Console is sent to @var{host} at the @var{port}. If you use
2456 the @var{server} option QEMU will wait for a client socket application
2457 to connect to the port before continuing, unless the @code{nowait}
2458 option was specified. The @code{nodelay} option disables the Nagle buffering
2459 algorithm. If @var{host} is omitted, 0.0.0.0 is assumed. Only
2460 one TCP connection at a time is accepted. You can use @code{telnet} to
2461 connect to the corresponding character device.
2462 @table @code
2463 @item Example to send tcp console to 192.168.0.2 port 4444
2464 -serial tcp:192.168.0.2:4444
2465 @item Example to listen and wait on port 4444 for connection
2466 -serial tcp::4444,server
2467 @item Example to not wait and listen on ip 192.168.0.100 port 4444
2468 -serial tcp:192.168.0.100:4444,server,nowait
2469 @end table
2471 @item telnet:@var{host}:@var{port}[,server][,nowait][,nodelay]
2472 The telnet protocol is used instead of raw tcp sockets. The options
2473 work the same as if you had specified @code{-serial tcp}. The
2474 difference is that the port acts like a telnet server or client using
2475 telnet option negotiation. This will also allow you to send the
2476 MAGIC_SYSRQ sequence if you use a telnet that supports sending the break
2477 sequence. Typically in unix telnet you do it with Control-] and then
2478 type "send break" followed by pressing the enter key.
2480 @item unix:@var{path}[,server][,nowait]
2481 A unix domain socket is used instead of a tcp socket. The option works the
2482 same as if you had specified @code{-serial tcp} except the unix domain socket
2483 @var{path} is used for connections.
2485 @item mon:@var{dev_string}
2486 This is a special option to allow the monitor to be multiplexed onto
2487 another serial port. The monitor is accessed with key sequence of
2488 @key{Control-a} and then pressing @key{c}. See monitor access
2489 @ref{pcsys_keys} in the -nographic section for more keys.
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
2497 @item braille
2498 Braille device. This will use BrlAPI to display the braille output on a real
2499 or fake device.
2501 @item msmouse
2502 Three button serial mouse. Configure the guest to use Microsoft protocol.
2503 @end table
2504 ETEXI
2506 DEF("parallel", HAS_ARG, QEMU_OPTION_parallel, \
2507 "-parallel dev redirect the parallel port to char device 'dev'\n",
2508 QEMU_ARCH_ALL)
2509 STEXI
2510 @item -parallel @var{dev}
2511 @findex -parallel
2512 Redirect the virtual parallel port to host device @var{dev} (same
2513 devices as the serial port). On Linux hosts, @file{/dev/parportN} can
2514 be used to use hardware devices connected on the corresponding host
2515 parallel port.
2517 This option can be used several times to simulate up to 3 parallel
2518 ports.
2520 Use @code{-parallel none} to disable all parallel ports.
2521 ETEXI
2523 DEF("monitor", HAS_ARG, QEMU_OPTION_monitor, \
2524 "-monitor dev redirect the monitor to char device 'dev'\n",
2525 QEMU_ARCH_ALL)
2526 STEXI
2527 @item -monitor @var{dev}
2528 @findex -monitor
2529 Redirect the monitor to host device @var{dev} (same devices as the
2530 serial port).
2531 The default device is @code{vc} in graphical mode and @code{stdio} in
2532 non graphical mode.
2533 Use @code{-monitor none} to disable the default monitor.
2534 ETEXI
2535 DEF("qmp", HAS_ARG, QEMU_OPTION_qmp, \
2536 "-qmp dev like -monitor but opens in 'control' mode\n",
2537 QEMU_ARCH_ALL)
2538 STEXI
2539 @item -qmp @var{dev}
2540 @findex -qmp
2541 Like -monitor but opens in 'control' mode.
2542 ETEXI
2544 DEF("mon", HAS_ARG, QEMU_OPTION_mon, \
2545 "-mon [chardev=]name[,mode=readline|control][,default]\n", QEMU_ARCH_ALL)
2546 STEXI
2547 @item -mon [chardev=]name[,mode=readline|control][,default]
2548 @findex -mon
2549 Setup monitor on chardev @var{name}.
2550 ETEXI
2552 DEF("debugcon", HAS_ARG, QEMU_OPTION_debugcon, \
2553 "-debugcon dev redirect the debug console to char device 'dev'\n",
2554 QEMU_ARCH_ALL)
2555 STEXI
2556 @item -debugcon @var{dev}
2557 @findex -debugcon
2558 Redirect the debug console to host device @var{dev} (same devices as the
2559 serial port). The debug console is an I/O port which is typically port
2560 0xe9; writing to that I/O port sends output to this device.
2561 The default device is @code{vc} in graphical mode and @code{stdio} in
2562 non graphical mode.
2563 ETEXI
2565 DEF("pidfile", HAS_ARG, QEMU_OPTION_pidfile, \
2566 "-pidfile file write PID to 'file'\n", QEMU_ARCH_ALL)
2567 STEXI
2568 @item -pidfile @var{file}
2569 @findex -pidfile
2570 Store the QEMU process PID in @var{file}. It is useful if you launch QEMU
2571 from a script.
2572 ETEXI
2574 DEF("singlestep", 0, QEMU_OPTION_singlestep, \
2575 "-singlestep always run in singlestep mode\n", QEMU_ARCH_ALL)
2576 STEXI
2577 @item -singlestep
2578 @findex -singlestep
2579 Run the emulation in single step mode.
2580 ETEXI
2582 DEF("S", 0, QEMU_OPTION_S, \
2583 "-S freeze CPU at startup (use 'c' to start execution)\n",
2584 QEMU_ARCH_ALL)
2585 STEXI
2586 @item -S
2587 @findex -S
2588 Do not start CPU at startup (you must type 'c' in the monitor).
2589 ETEXI
2591 DEF("realtime", HAS_ARG, QEMU_OPTION_realtime,
2592 "-realtime [mlock=on|off]\n"
2593 " run qemu with realtime features\n"
2594 " mlock=on|off controls mlock support (default: on)\n",
2595 QEMU_ARCH_ALL)
2596 STEXI
2597 @item -realtime mlock=on|off
2598 @findex -realtime
2599 Run qemu with realtime features.
2600 mlocking qemu and guest memory can be enabled via @option{mlock=on}
2601 (enabled by default).
2602 ETEXI
2604 DEF("gdb", HAS_ARG, QEMU_OPTION_gdb, \
2605 "-gdb dev wait for gdb connection on 'dev'\n", QEMU_ARCH_ALL)
2606 STEXI
2607 @item -gdb @var{dev}
2608 @findex -gdb
2609 Wait for gdb connection on device @var{dev} (@pxref{gdb_usage}). Typical
2610 connections will likely be TCP-based, but also UDP, pseudo TTY, or even
2611 stdio are reasonable use case. The latter is allowing to start QEMU from
2612 within gdb and establish the connection via a pipe:
2613 @example
2614 (gdb) target remote | exec qemu-system-i386 -gdb stdio ...
2615 @end example
2616 ETEXI
2618 DEF("s", 0, QEMU_OPTION_s, \
2619 "-s shorthand for -gdb tcp::" DEFAULT_GDBSTUB_PORT "\n",
2620 QEMU_ARCH_ALL)
2621 STEXI
2622 @item -s
2623 @findex -s
2624 Shorthand for -gdb tcp::1234, i.e. open a gdbserver on TCP port 1234
2625 (@pxref{gdb_usage}).
2626 ETEXI
2628 DEF("d", HAS_ARG, QEMU_OPTION_d, \
2629 "-d item1,... enable logging of specified items (use '-d help' for a list of log items)\n",
2630 QEMU_ARCH_ALL)
2631 STEXI
2632 @item -d @var{item1}[,...]
2633 @findex -d
2634 Enable logging of specified items. Use '-d help' for a list of log items.
2635 ETEXI
2637 DEF("D", HAS_ARG, QEMU_OPTION_D, \
2638 "-D logfile output log to logfile (default stderr)\n",
2639 QEMU_ARCH_ALL)
2640 STEXI
2641 @item -D @var{logfile}
2642 @findex -D
2643 Output log in @var{logfile} instead of to stderr
2644 ETEXI
2646 DEF("L", HAS_ARG, QEMU_OPTION_L, \
2647 "-L path set the directory for the BIOS, VGA BIOS and keymaps\n",
2648 QEMU_ARCH_ALL)
2649 STEXI
2650 @item -L @var{path}
2651 @findex -L
2652 Set the directory for the BIOS, VGA BIOS and keymaps.
2653 ETEXI
2655 DEF("bios", HAS_ARG, QEMU_OPTION_bios, \
2656 "-bios file set the filename for the BIOS\n", QEMU_ARCH_ALL)
2657 STEXI
2658 @item -bios @var{file}
2659 @findex -bios
2660 Set the filename for the BIOS.
2661 ETEXI
2663 DEF("enable-kvm", 0, QEMU_OPTION_enable_kvm, \
2664 "-enable-kvm enable KVM full virtualization support\n", QEMU_ARCH_ALL)
2665 STEXI
2666 @item -enable-kvm
2667 @findex -enable-kvm
2668 Enable KVM full virtualization support. This option is only available
2669 if KVM support is enabled when compiling.
2670 ETEXI
2672 DEF("xen-domid", HAS_ARG, QEMU_OPTION_xen_domid,
2673 "-xen-domid id specify xen guest domain id\n", QEMU_ARCH_ALL)
2674 DEF("xen-create", 0, QEMU_OPTION_xen_create,
2675 "-xen-create create domain using xen hypercalls, bypassing xend\n"
2676 " warning: should not be used when xend is in use\n",
2677 QEMU_ARCH_ALL)
2678 DEF("xen-attach", 0, QEMU_OPTION_xen_attach,
2679 "-xen-attach attach to existing xen domain\n"
2680 " xend will use this when starting QEMU\n",
2681 QEMU_ARCH_ALL)
2682 STEXI
2683 @item -xen-domid @var{id}
2684 @findex -xen-domid
2685 Specify xen guest domain @var{id} (XEN only).
2686 @item -xen-create
2687 @findex -xen-create
2688 Create domain using xen hypercalls, bypassing xend.
2689 Warning: should not be used when xend is in use (XEN only).
2690 @item -xen-attach
2691 @findex -xen-attach
2692 Attach to existing xen domain.
2693 xend will use this when starting QEMU (XEN only).
2694 ETEXI
2696 DEF("no-reboot", 0, QEMU_OPTION_no_reboot, \
2697 "-no-reboot exit instead of rebooting\n", QEMU_ARCH_ALL)
2698 STEXI
2699 @item -no-reboot
2700 @findex -no-reboot
2701 Exit instead of rebooting.
2702 ETEXI
2704 DEF("no-shutdown", 0, QEMU_OPTION_no_shutdown, \
2705 "-no-shutdown stop before shutdown\n", QEMU_ARCH_ALL)
2706 STEXI
2707 @item -no-shutdown
2708 @findex -no-shutdown
2709 Don't exit QEMU on guest shutdown, but instead only stop the emulation.
2710 This allows for instance switching to monitor to commit changes to the
2711 disk image.
2712 ETEXI
2714 DEF("loadvm", HAS_ARG, QEMU_OPTION_loadvm, \
2715 "-loadvm [tag|id]\n" \
2716 " start right away with a saved state (loadvm in monitor)\n",
2717 QEMU_ARCH_ALL)
2718 STEXI
2719 @item -loadvm @var{file}
2720 @findex -loadvm
2721 Start right away with a saved state (@code{loadvm} in monitor)
2722 ETEXI
2724 #ifndef _WIN32
2725 DEF("daemonize", 0, QEMU_OPTION_daemonize, \
2726 "-daemonize daemonize QEMU after initializing\n", QEMU_ARCH_ALL)
2727 #endif
2728 STEXI
2729 @item -daemonize
2730 @findex -daemonize
2731 Daemonize the QEMU process after initialization. QEMU will not detach from
2732 standard IO until it is ready to receive connections on any of its devices.
2733 This option is a useful way for external programs to launch QEMU without having
2734 to cope with initialization race conditions.
2735 ETEXI
2737 DEF("option-rom", HAS_ARG, QEMU_OPTION_option_rom, \
2738 "-option-rom rom load a file, rom, into the option ROM space\n",
2739 QEMU_ARCH_ALL)
2740 STEXI
2741 @item -option-rom @var{file}
2742 @findex -option-rom
2743 Load the contents of @var{file} as an option ROM.
2744 This option is useful to load things like EtherBoot.
2745 ETEXI
2747 DEF("clock", HAS_ARG, QEMU_OPTION_clock, \
2748 "-clock force the use of the given methods for timer alarm.\n" \
2749 " To see what timers are available use '-clock help'\n",
2750 QEMU_ARCH_ALL)
2751 STEXI
2752 @item -clock @var{method}
2753 @findex -clock
2754 Force the use of the given methods for timer alarm. To see what timers
2755 are available use @code{-clock help}.
2756 ETEXI
2758 HXCOMM Options deprecated by -rtc
2759 DEF("localtime", 0, QEMU_OPTION_localtime, "", QEMU_ARCH_ALL)
2760 DEF("startdate", HAS_ARG, QEMU_OPTION_startdate, "", QEMU_ARCH_ALL)
2762 DEF("rtc", HAS_ARG, QEMU_OPTION_rtc, \
2763 "-rtc [base=utc|localtime|date][,clock=host|rt|vm][,driftfix=none|slew]\n" \
2764 " set the RTC base and clock, enable drift fix for clock ticks (x86 only)\n",
2765 QEMU_ARCH_ALL)
2767 STEXI
2769 @item -rtc [base=utc|localtime|@var{date}][,clock=host|vm][,driftfix=none|slew]
2770 @findex -rtc
2771 Specify @option{base} as @code{utc} or @code{localtime} to let the RTC start at the current
2772 UTC or local time, respectively. @code{localtime} is required for correct date in
2773 MS-DOS or Windows. To start at a specific point in time, provide @var{date} in the
2774 format @code{2006-06-17T16:01:21} or @code{2006-06-17}. The default base is UTC.
2776 By default the RTC is driven by the host system time. This allows to use the
2777 RTC as accurate reference clock inside the guest, specifically if the host
2778 time is smoothly following an accurate external reference clock, e.g. via NTP.
2779 If you want to isolate the guest time from the host, you can set @option{clock}
2780 to @code{rt} instead. To even prevent it from progressing during suspension,
2781 you can set it to @code{vm}.
2783 Enable @option{driftfix} (i386 targets only) if you experience time drift problems,
2784 specifically with Windows' ACPI HAL. This option will try to figure out how
2785 many timer interrupts were not processed by the Windows guest and will
2786 re-inject them.
2787 ETEXI
2789 DEF("icount", HAS_ARG, QEMU_OPTION_icount, \
2790 "-icount [N|auto]\n" \
2791 " enable virtual instruction counter with 2^N clock ticks per\n" \
2792 " instruction\n", QEMU_ARCH_ALL)
2793 STEXI
2794 @item -icount [@var{N}|auto]
2795 @findex -icount
2796 Enable virtual instruction counter. The virtual cpu will execute one
2797 instruction every 2^@var{N} ns of virtual time. If @code{auto} is specified
2798 then the virtual cpu speed will be automatically adjusted to keep virtual
2799 time within a few seconds of real time.
2801 Note that while this option can give deterministic behavior, it does not
2802 provide cycle accurate emulation. Modern CPUs contain superscalar out of
2803 order cores with complex cache hierarchies. The number of instructions
2804 executed often has little or no correlation with actual performance.
2805 ETEXI
2807 DEF("watchdog", HAS_ARG, QEMU_OPTION_watchdog, \
2808 "-watchdog i6300esb|ib700\n" \
2809 " enable virtual hardware watchdog [default=none]\n",
2810 QEMU_ARCH_ALL)
2811 STEXI
2812 @item -watchdog @var{model}
2813 @findex -watchdog
2814 Create a virtual hardware watchdog device. Once enabled (by a guest
2815 action), the watchdog must be periodically polled by an agent inside
2816 the guest or else the guest will be restarted.
2818 The @var{model} is the model of hardware watchdog to emulate. Choices
2819 for model are: @code{ib700} (iBASE 700) which is a very simple ISA
2820 watchdog with a single timer, or @code{i6300esb} (Intel 6300ESB I/O
2821 controller hub) which is a much more featureful PCI-based dual-timer
2822 watchdog. Choose a model for which your guest has drivers.
2824 Use @code{-watchdog help} to list available hardware models. Only one
2825 watchdog can be enabled for a guest.
2826 ETEXI
2828 DEF("watchdog-action", HAS_ARG, QEMU_OPTION_watchdog_action, \
2829 "-watchdog-action reset|shutdown|poweroff|pause|debug|none\n" \
2830 " action when watchdog fires [default=reset]\n",
2831 QEMU_ARCH_ALL)
2832 STEXI
2833 @item -watchdog-action @var{action}
2834 @findex -watchdog-action
2836 The @var{action} controls what QEMU will do when the watchdog timer
2837 expires.
2838 The default is
2839 @code{reset} (forcefully reset the guest).
2840 Other possible actions are:
2841 @code{shutdown} (attempt to gracefully shutdown the guest),
2842 @code{poweroff} (forcefully poweroff the guest),
2843 @code{pause} (pause the guest),
2844 @code{debug} (print a debug message and continue), or
2845 @code{none} (do nothing).
2847 Note that the @code{shutdown} action requires that the guest responds
2848 to ACPI signals, which it may not be able to do in the sort of
2849 situations where the watchdog would have expired, and thus
2850 @code{-watchdog-action shutdown} is not recommended for production use.
2852 Examples:
2854 @table @code
2855 @item -watchdog i6300esb -watchdog-action pause
2856 @item -watchdog ib700
2857 @end table
2858 ETEXI
2860 DEF("echr", HAS_ARG, QEMU_OPTION_echr, \
2861 "-echr chr set terminal escape character instead of ctrl-a\n",
2862 QEMU_ARCH_ALL)
2863 STEXI
2865 @item -echr @var{numeric_ascii_value}
2866 @findex -echr
2867 Change the escape character used for switching to the monitor when using
2868 monitor and serial sharing. The default is @code{0x01} when using the
2869 @code{-nographic} option. @code{0x01} is equal to pressing
2870 @code{Control-a}. You can select a different character from the ascii
2871 control keys where 1 through 26 map to Control-a through Control-z. For
2872 instance you could use the either of the following to change the escape
2873 character to Control-t.
2874 @table @code
2875 @item -echr 0x14
2876 @item -echr 20
2877 @end table
2878 ETEXI
2880 DEF("virtioconsole", HAS_ARG, QEMU_OPTION_virtiocon, \
2881 "-virtioconsole c\n" \
2882 " set virtio console\n", QEMU_ARCH_ALL)
2883 STEXI
2884 @item -virtioconsole @var{c}
2885 @findex -virtioconsole
2886 Set virtio console.
2888 This option is maintained for backward compatibility.
2890 Please use @code{-device virtconsole} for the new way of invocation.
2891 ETEXI
2893 DEF("show-cursor", 0, QEMU_OPTION_show_cursor, \
2894 "-show-cursor show cursor\n", QEMU_ARCH_ALL)
2895 STEXI
2896 @item -show-cursor
2897 @findex -show-cursor
2898 Show cursor.
2899 ETEXI
2901 DEF("tb-size", HAS_ARG, QEMU_OPTION_tb_size, \
2902 "-tb-size n set TB size\n", QEMU_ARCH_ALL)
2903 STEXI
2904 @item -tb-size @var{n}
2905 @findex -tb-size
2906 Set TB size.
2907 ETEXI
2909 DEF("incoming", HAS_ARG, QEMU_OPTION_incoming, \
2910 "-incoming p prepare for incoming migration, listen on port p\n",
2911 QEMU_ARCH_ALL)
2912 STEXI
2913 @item -incoming @var{port}
2914 @findex -incoming
2915 Prepare for incoming migration, listen on @var{port}.
2916 ETEXI
2918 DEF("nodefaults", 0, QEMU_OPTION_nodefaults, \
2919 "-nodefaults don't create default devices\n", QEMU_ARCH_ALL)
2920 STEXI
2921 @item -nodefaults
2922 @findex -nodefaults
2923 Don't create default devices. Normally, QEMU sets the default devices like serial
2924 port, parallel port, virtual console, monitor device, VGA adapter, floppy and
2925 CD-ROM drive and others. The @code{-nodefaults} option will disable all those
2926 default devices.
2927 ETEXI
2929 #ifndef _WIN32
2930 DEF("chroot", HAS_ARG, QEMU_OPTION_chroot, \
2931 "-chroot dir chroot to dir just before starting the VM\n",
2932 QEMU_ARCH_ALL)
2933 #endif
2934 STEXI
2935 @item -chroot @var{dir}
2936 @findex -chroot
2937 Immediately before starting guest execution, chroot to the specified
2938 directory. Especially useful in combination with -runas.
2939 ETEXI
2941 #ifndef _WIN32
2942 DEF("runas", HAS_ARG, QEMU_OPTION_runas, \
2943 "-runas user change to user id user just before starting the VM\n",
2944 QEMU_ARCH_ALL)
2945 #endif
2946 STEXI
2947 @item -runas @var{user}
2948 @findex -runas
2949 Immediately before starting guest execution, drop root privileges, switching
2950 to the specified user.
2951 ETEXI
2953 DEF("prom-env", HAS_ARG, QEMU_OPTION_prom_env,
2954 "-prom-env variable=value\n"
2955 " set OpenBIOS nvram variables\n",
2956 QEMU_ARCH_PPC | QEMU_ARCH_SPARC)
2957 STEXI
2958 @item -prom-env @var{variable}=@var{value}
2959 @findex -prom-env
2960 Set OpenBIOS nvram @var{variable} to given @var{value} (PPC, SPARC only).
2961 ETEXI
2962 DEF("semihosting", 0, QEMU_OPTION_semihosting,
2963 "-semihosting semihosting mode\n", QEMU_ARCH_ARM | QEMU_ARCH_M68K | QEMU_ARCH_XTENSA)
2964 STEXI
2965 @item -semihosting
2966 @findex -semihosting
2967 Semihosting mode (ARM, M68K, Xtensa only).
2968 ETEXI
2969 DEF("old-param", 0, QEMU_OPTION_old_param,
2970 "-old-param old param mode\n", QEMU_ARCH_ARM)
2971 STEXI
2972 @item -old-param
2973 @findex -old-param (ARM)
2974 Old param mode (ARM only).
2975 ETEXI
2977 DEF("sandbox", HAS_ARG, QEMU_OPTION_sandbox, \
2978 "-sandbox <arg> Enable seccomp mode 2 system call filter (default 'off').\n",
2979 QEMU_ARCH_ALL)
2980 STEXI
2981 @item -sandbox @var{arg}
2982 @findex -sandbox
2983 Enable Seccomp mode 2 system call filter. 'on' will enable syscall filtering and 'off' will
2984 disable it. The default is 'off'.
2985 ETEXI
2987 DEF("readconfig", HAS_ARG, QEMU_OPTION_readconfig,
2988 "-readconfig <file>\n", QEMU_ARCH_ALL)
2989 STEXI
2990 @item -readconfig @var{file}
2991 @findex -readconfig
2992 Read device configuration from @var{file}. This approach is useful when you want to spawn
2993 QEMU process with many command line options but you don't want to exceed the command line
2994 character limit.
2995 ETEXI
2996 DEF("writeconfig", HAS_ARG, QEMU_OPTION_writeconfig,
2997 "-writeconfig <file>\n"
2998 " read/write config file\n", QEMU_ARCH_ALL)
2999 STEXI
3000 @item -writeconfig @var{file}
3001 @findex -writeconfig
3002 Write device configuration to @var{file}. The @var{file} can be either filename to save
3003 command line and device configuration into file or dash @code{-}) character to print the
3004 output to stdout. This can be later used as input file for @code{-readconfig} option.
3005 ETEXI
3006 DEF("nodefconfig", 0, QEMU_OPTION_nodefconfig,
3007 "-nodefconfig\n"
3008 " do not load default config files at startup\n",
3009 QEMU_ARCH_ALL)
3010 STEXI
3011 @item -nodefconfig
3012 @findex -nodefconfig
3013 Normally QEMU loads configuration files from @var{sysconfdir} and @var{datadir} at startup.
3014 The @code{-nodefconfig} option will prevent QEMU from loading any of those config files.
3015 ETEXI
3016 DEF("no-user-config", 0, QEMU_OPTION_nouserconfig,
3017 "-no-user-config\n"
3018 " do not load user-provided config files at startup\n",
3019 QEMU_ARCH_ALL)
3020 STEXI
3021 @item -no-user-config
3022 @findex -no-user-config
3023 The @code{-no-user-config} option makes QEMU not load any of the user-provided
3024 config files on @var{sysconfdir}, but won't make it skip the QEMU-provided config
3025 files from @var{datadir}.
3026 ETEXI
3027 DEF("trace", HAS_ARG, QEMU_OPTION_trace,
3028 "-trace [events=<file>][,file=<file>]\n"
3029 " specify tracing options\n",
3030 QEMU_ARCH_ALL)
3031 STEXI
3032 HXCOMM This line is not accurate, as some sub-options are backend-specific but
3033 HXCOMM HX does not support conditional compilation of text.
3034 @item -trace [events=@var{file}][,file=@var{file}]
3035 @findex -trace
3037 Specify tracing options.
3039 @table @option
3040 @item events=@var{file}
3041 Immediately enable events listed in @var{file}.
3042 The file must contain one event name (as listed in the @var{trace-events} file)
3043 per line.
3044 This option is only available if QEMU has been compiled with
3045 either @var{simple} or @var{stderr} tracing backend.
3046 @item file=@var{file}
3047 Log output traces to @var{file}.
3049 This option is only available if QEMU has been compiled with
3050 the @var{simple} tracing backend.
3051 @end table
3052 ETEXI
3054 HXCOMM Internal use
3055 DEF("qtest", HAS_ARG, QEMU_OPTION_qtest, "", QEMU_ARCH_ALL)
3056 DEF("qtest-log", HAS_ARG, QEMU_OPTION_qtest_log, "", QEMU_ARCH_ALL)
3058 #ifdef __linux__
3059 DEF("enable-fips", 0, QEMU_OPTION_enablefips,
3060 "-enable-fips enable FIPS 140-2 compliance\n",
3061 QEMU_ARCH_ALL)
3062 #endif
3063 STEXI
3064 @item -enable-fips
3065 @findex -enable-fips
3066 Enable FIPS 140-2 compliance mode.
3067 ETEXI
3069 HXCOMM Deprecated by -machine accel=tcg property
3070 DEF("no-kvm", 0, QEMU_OPTION_no_kvm, "", QEMU_ARCH_I386)
3072 HXCOMM Deprecated by kvm-pit driver properties
3073 DEF("no-kvm-pit-reinjection", 0, QEMU_OPTION_no_kvm_pit_reinjection,
3074 "", QEMU_ARCH_I386)
3076 HXCOMM Deprecated (ignored)
3077 DEF("no-kvm-pit", 0, QEMU_OPTION_no_kvm_pit, "", QEMU_ARCH_I386)
3079 HXCOMM Deprecated by -machine kernel_irqchip=on|off property
3080 DEF("no-kvm-irqchip", 0, QEMU_OPTION_no_kvm_irqchip, "", QEMU_ARCH_I386)
3082 HXCOMM Deprecated (ignored)
3083 DEF("tdf", 0, QEMU_OPTION_tdf,"", QEMU_ARCH_ALL)
3085 DEF("object", HAS_ARG, QEMU_OPTION_object,
3086 "-object TYPENAME[,PROP1=VALUE1,...]\n"
3087 " create an new object of type TYPENAME setting properties\n"
3088 " in the order they are specified. Note that the 'id'\n"
3089 " property must be set. These objects are placed in the\n"
3090 " '/objects' path.\n",
3091 QEMU_ARCH_ALL)
3092 STEXI
3093 @item -object @var{typename}[,@var{prop1}=@var{value1},...]
3094 @findex -object
3095 Create an new object of type @var{typename} setting properties
3096 in the order they are specified. Note that the 'id'
3097 property must be set. These objects are placed in the
3098 '/objects' path.
3099 ETEXI
3101 HXCOMM This is the last statement. Insert new options before this line!
3102 STEXI
3103 @end table
3104 ETEXI