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