Merge commit 'ac4040955b1669f0aac5937f623d6587d5210679' into upstream-merge
[qemu-kvm/amd-iommu.git] / qemu-options.hx
blob7be41e9209d4ee06b7653dd9463a3313ccd7df30
1 HXCOMM Use DEFHEADING() to define headings in both help text and texi
2 HXCOMM Text between STEXI and ETEXI are copied to texi version and
3 HXCOMM discarded from C version
4 HXCOMM DEF(option, HAS_ARG/0, opt_enum, opt_help, arch_mask) is used to
5 HXCOMM construct option structures, enums and help message for specified
6 HXCOMM architectures.
7 HXCOMM HXCOMM can be used for comments, discarded from both texi and C
9 DEFHEADING(Standard options:)
10 STEXI
11 @table @option
12 ETEXI
14 DEF("help", 0, QEMU_OPTION_h,
15 "-h or -help display this help and exit\n", QEMU_ARCH_ALL)
16 STEXI
17 @item -h
18 @findex -h
19 Display help and exit
20 ETEXI
22 DEF("version", 0, QEMU_OPTION_version,
23 "-version display version information and exit\n", QEMU_ARCH_ALL)
24 STEXI
25 @item -version
26 @findex -version
27 Display version information and exit
28 ETEXI
30 DEF("M", HAS_ARG, QEMU_OPTION_M,
31 "-M machine select emulated machine (-M ? for list)\n", QEMU_ARCH_ALL)
32 STEXI
33 @item -M @var{machine}
34 @findex -M
35 Select the emulated @var{machine} (@code{-M ?} for list)
36 ETEXI
38 DEF("cpu", HAS_ARG, QEMU_OPTION_cpu,
39 "-cpu cpu select CPU (-cpu ? for list)\n", QEMU_ARCH_ALL)
40 STEXI
41 @item -cpu @var{model}
42 @findex -cpu
43 Select CPU model (-cpu ? for list and additional feature selection)
44 ETEXI
46 DEF("smp", HAS_ARG, QEMU_OPTION_smp,
47 "-smp n[,maxcpus=cpus][,cores=cores][,threads=threads][,sockets=sockets]\n"
48 " set the number of CPUs to 'n' [default=1]\n"
49 " maxcpus= maximum number of total cpus, including\n"
50 " offline CPUs for hotplug, etc\n"
51 " cores= number of CPU cores on one socket\n"
52 " threads= number of threads on one CPU core\n"
53 " sockets= number of discrete sockets in the system\n",
54 QEMU_ARCH_ALL)
55 STEXI
56 @item -smp @var{n}[,cores=@var{cores}][,threads=@var{threads}][,sockets=@var{sockets}][,maxcpus=@var{maxcpus}]
57 @findex -smp
58 Simulate an SMP system with @var{n} CPUs. On the PC target, up to 255
59 CPUs are supported. On Sparc32 target, Linux limits the number of usable CPUs
60 to 4.
61 For the PC target, the number of @var{cores} per socket, the number
62 of @var{threads} per cores and the total number of @var{sockets} can be
63 specified. Missing values will be computed. If any on the three values is
64 given, the total number of CPUs @var{n} can be omitted. @var{maxcpus}
65 specifies the maximum number of hotpluggable CPUs.
66 ETEXI
68 DEF("numa", HAS_ARG, QEMU_OPTION_numa,
69 "-numa node[,mem=size][,cpus=cpu[-cpu]][,nodeid=node]\n", QEMU_ARCH_ALL)
70 STEXI
71 @item -numa @var{opts}
72 @findex -numa
73 Simulate a multi node NUMA system. If mem and cpus are omitted, resources
74 are split equally.
75 ETEXI
77 DEF("fda", HAS_ARG, QEMU_OPTION_fda,
78 "-fda/-fdb file use 'file' as floppy disk 0/1 image\n", QEMU_ARCH_ALL)
79 DEF("fdb", HAS_ARG, QEMU_OPTION_fdb, "", QEMU_ARCH_ALL)
80 STEXI
81 @item -fda @var{file}
82 @item -fdb @var{file}
83 @findex -fda
84 @findex -fdb
85 Use @var{file} as floppy disk 0/1 image (@pxref{disk_images}). You can
86 use the host floppy by using @file{/dev/fd0} as filename (@pxref{host_drives}).
87 ETEXI
89 DEF("hda", HAS_ARG, QEMU_OPTION_hda,
90 "-hda/-hdb file use 'file' as IDE hard disk 0/1 image\n", QEMU_ARCH_ALL)
91 DEF("hdb", HAS_ARG, QEMU_OPTION_hdb, "", QEMU_ARCH_ALL)
92 DEF("hdc", HAS_ARG, QEMU_OPTION_hdc,
93 "-hdc/-hdd file use 'file' as IDE hard disk 2/3 image\n", QEMU_ARCH_ALL)
94 DEF("hdd", HAS_ARG, QEMU_OPTION_hdd, "", QEMU_ARCH_ALL)
95 STEXI
96 @item -hda @var{file}
97 @item -hdb @var{file}
98 @item -hdc @var{file}
99 @item -hdd @var{file}
100 @findex -hda
101 @findex -hdb
102 @findex -hdc
103 @findex -hdd
104 Use @var{file} as hard disk 0, 1, 2 or 3 image (@pxref{disk_images}).
105 ETEXI
107 DEF("cdrom", HAS_ARG, QEMU_OPTION_cdrom,
108 "-cdrom file use 'file' as IDE cdrom image (cdrom is ide1 master)\n",
109 QEMU_ARCH_ALL)
110 STEXI
111 @item -cdrom @var{file}
112 @findex -cdrom
113 Use @var{file} as CD-ROM image (you cannot use @option{-hdc} and
114 @option{-cdrom} at the same time). You can use the host CD-ROM by
115 using @file{/dev/cdrom} as filename (@pxref{host_drives}).
116 ETEXI
118 DEF("drive", HAS_ARG, QEMU_OPTION_drive,
119 "-drive [file=file][,if=type][,bus=n][,unit=m][,media=d][,index=i]\n"
120 " [,cyls=c,heads=h,secs=s[,trans=t]][,snapshot=on|off]\n"
121 " [,cache=writethrough|writeback|none][,format=f][,serial=s]\n"
122 " [,addr=A][,id=name][,aio=threads|native][,readonly=on|off]\n"
123 " [,boot=on|off]\n"
124 " use 'file' as a drive image\n", QEMU_ARCH_ALL)
125 STEXI
126 @item -drive @var{option}[,@var{option}[,@var{option}[,...]]]
127 @findex -drive
129 Define a new drive. Valid options are:
131 @table @option
132 @item file=@var{file}
133 This option defines which disk image (@pxref{disk_images}) to use with
134 this drive. If the filename contains comma, you must double it
135 (for instance, "file=my,,file" to use file "my,file").
136 @item if=@var{interface}
137 This option defines on which type on interface the drive is connected.
138 Available types are: ide, scsi, sd, mtd, floppy, pflash, virtio.
139 @item bus=@var{bus},unit=@var{unit}
140 These options define where is connected the drive by defining the bus number and
141 the unit id.
142 @item index=@var{index}
143 This option defines where is connected the drive by using an index in the list
144 of available connectors of a given interface type.
145 @item media=@var{media}
146 This option defines the type of the media: disk or cdrom.
147 @item cyls=@var{c},heads=@var{h},secs=@var{s}[,trans=@var{t}]
148 These options have the same definition as they have in @option{-hdachs}.
149 @item snapshot=@var{snapshot}
150 @var{snapshot} is "on" or "off" and allows to enable snapshot for given drive (see @option{-snapshot}).
151 @item cache=@var{cache}
152 @var{cache} is "none", "writeback", or "writethrough" and controls how the host cache is used to access block data.
153 @item aio=@var{aio}
154 @var{aio} is "threads", or "native" and selects between pthread based disk I/O and native Linux AIO.
155 @item format=@var{format}
156 Specify which disk @var{format} will be used rather than detecting
157 the format. Can be used to specifiy format=raw to avoid interpreting
158 an untrusted format header.
159 @item serial=@var{serial}
160 This option specifies the serial number to assign to the device.
161 @item addr=@var{addr}
162 Specify the controller's PCI address (if=virtio only).
163 @item boot=@var{boot}
164 @var{boot} is "on" or "off" and allows for booting from non-traditional interfaces, such as virtio.
165 @end table
167 By default, writethrough caching is used for all block device. This means that
168 the host page cache will be used to read and write data but write notification
169 will be sent to the guest only when the data has been reported as written by
170 the storage subsystem.
172 Writeback caching will report data writes as completed as soon as the data is
173 present in the host page cache. This is safe as long as you trust your host.
174 If your host crashes or loses power, then the guest may experience data
175 corruption. When using the @option{-snapshot} option, writeback caching is
176 used by default.
178 The host page cache can be avoided entirely with @option{cache=none}. This will
179 attempt to do disk IO directly to the guests memory. QEMU may still perform
180 an internal copy of the data.
182 Some block drivers perform badly with @option{cache=writethrough}, most notably,
183 qcow2. If performance is more important than correctness,
184 @option{cache=writeback} should be used with qcow2.
186 Instead of @option{-cdrom} you can use:
187 @example
188 qemu -drive file=file,index=2,media=cdrom
189 @end example
191 Instead of @option{-hda}, @option{-hdb}, @option{-hdc}, @option{-hdd}, you can
192 use:
193 @example
194 qemu -drive file=file,index=0,media=disk
195 qemu -drive file=file,index=1,media=disk
196 qemu -drive file=file,index=2,media=disk
197 qemu -drive file=file,index=3,media=disk
198 @end example
200 You can connect a CDROM to the slave of ide0:
201 @example
202 qemu -drive file=file,if=ide,index=1,media=cdrom
203 @end example
205 If you don't specify the "file=" argument, you define an empty drive:
206 @example
207 qemu -drive if=ide,index=1,media=cdrom
208 @end example
210 You can connect a SCSI disk with unit ID 6 on the bus #0:
211 @example
212 qemu -drive file=file,if=scsi,bus=0,unit=6
213 @end example
215 Instead of @option{-fda}, @option{-fdb}, you can use:
216 @example
217 qemu -drive file=file,index=0,if=floppy
218 qemu -drive file=file,index=1,if=floppy
219 @end example
221 By default, @var{interface} is "ide" and @var{index} is automatically
222 incremented:
223 @example
224 qemu -drive file=a -drive file=b"
225 @end example
226 is interpreted like:
227 @example
228 qemu -hda a -hdb b
229 @end example
230 ETEXI
232 DEF("set", HAS_ARG, QEMU_OPTION_set,
233 "-set group.id.arg=value\n"
234 " set <arg> parameter for item <id> of type <group>\n"
235 " i.e. -set drive.$id.file=/path/to/image\n", QEMU_ARCH_ALL)
236 STEXI
237 @item -set
238 @findex -set
239 TODO
240 ETEXI
242 DEF("global", HAS_ARG, QEMU_OPTION_global,
243 "-global driver.property=value\n"
244 " set a global default for a driver property\n",
245 QEMU_ARCH_ALL)
246 STEXI
247 @item -global
248 @findex -global
249 TODO
250 ETEXI
252 DEF("mtdblock", HAS_ARG, QEMU_OPTION_mtdblock,
253 "-mtdblock file use 'file' as on-board Flash memory image\n",
254 QEMU_ARCH_ALL)
255 STEXI
256 @item -mtdblock @var{file}
257 @findex -mtdblock
258 Use @var{file} as on-board Flash memory image.
259 ETEXI
261 DEF("sd", HAS_ARG, QEMU_OPTION_sd,
262 "-sd file use 'file' as SecureDigital card image\n", QEMU_ARCH_ALL)
263 STEXI
264 @item -sd @var{file}
265 @findex -sd
266 Use @var{file} as SecureDigital card image.
267 ETEXI
269 DEF("pflash", HAS_ARG, QEMU_OPTION_pflash,
270 "-pflash file use 'file' as a parallel flash image\n", QEMU_ARCH_ALL)
271 STEXI
272 @item -pflash @var{file}
273 @findex -pflash
274 Use @var{file} as a parallel flash image.
275 ETEXI
277 DEF("boot", HAS_ARG, QEMU_OPTION_boot,
278 "-boot [order=drives][,once=drives][,menu=on|off]\n"
279 " 'drives': floppy (a), hard disk (c), CD-ROM (d), network (n)\n",
280 QEMU_ARCH_ALL)
281 STEXI
282 @item -boot [order=@var{drives}][,once=@var{drives}][,menu=on|off]
283 @findex -boot
284 Specify boot order @var{drives} as a string of drive letters. Valid
285 drive letters depend on the target achitecture. The x86 PC uses: a, b
286 (floppy 1 and 2), c (first hard disk), d (first CD-ROM), n-p (Etherboot
287 from network adapter 1-4), hard disk boot is the default. To apply a
288 particular boot order only on the first startup, specify it via
289 @option{once}.
291 Interactive boot menus/prompts can be enabled via @option{menu=on} as far
292 as firmware/BIOS supports them. The default is non-interactive boot.
294 @example
295 # try to boot from network first, then from hard disk
296 qemu -boot order=nc
297 # boot from CD-ROM first, switch back to default order after reboot
298 qemu -boot once=d
299 @end example
301 Note: The legacy format '-boot @var{drives}' is still supported but its
302 use is discouraged as it may be removed from future versions.
303 ETEXI
305 DEF("snapshot", 0, QEMU_OPTION_snapshot,
306 "-snapshot write to temporary files instead of disk image files\n",
307 QEMU_ARCH_ALL)
308 STEXI
309 @item -snapshot
310 @findex -snapshot
311 Write to temporary files instead of disk image files. In this case,
312 the raw disk image you use is not written back. You can however force
313 the write back by pressing @key{C-a s} (@pxref{disk_images}).
314 ETEXI
316 DEF("m", HAS_ARG, QEMU_OPTION_m,
317 "-m megs set virtual RAM size to megs MB [default="
318 stringify(DEFAULT_RAM_SIZE) "]\n", QEMU_ARCH_ALL)
319 STEXI
320 @item -m @var{megs}
321 @findex -m
322 Set virtual RAM size to @var{megs} megabytes. Default is 128 MiB. Optionally,
323 a suffix of ``M'' or ``G'' can be used to signify a value in megabytes or
324 gigabytes respectively.
325 ETEXI
327 DEF("mem-path", HAS_ARG, QEMU_OPTION_mempath,
328 "-mem-path FILE provide backing storage for guest RAM\n", QEMU_ARCH_ALL)
329 STEXI
330 @item -mem-path @var{path}
331 Allocate guest RAM from a temporarily created file in @var{path}.
332 ETEXI
334 #ifdef MAP_POPULATE
335 DEF("mem-prealloc", 0, QEMU_OPTION_mem_prealloc,
336 "-mem-prealloc preallocate guest memory (use with -mem-path)\n",
337 QEMU_ARCH_ALL)
338 STEXI
339 @item -mem-prealloc
340 Preallocate memory when using -mem-path.
341 ETEXI
342 #endif
344 DEF("k", HAS_ARG, QEMU_OPTION_k,
345 "-k language use keyboard layout (for example 'fr' for French)\n",
346 QEMU_ARCH_ALL)
347 STEXI
348 @item -k @var{language}
349 @findex -k
350 Use keyboard layout @var{language} (for example @code{fr} for
351 French). This option is only needed where it is not easy to get raw PC
352 keycodes (e.g. on Macs, with some X11 servers or with a VNC
353 display). You don't normally need to use it on PC/Linux or PC/Windows
354 hosts.
356 The available layouts are:
357 @example
358 ar de-ch es fo fr-ca hu ja mk no pt-br sv
359 da en-gb et fr fr-ch is lt nl pl ru th
360 de en-us fi fr-be hr it lv nl-be pt sl tr
361 @end example
363 The default is @code{en-us}.
364 ETEXI
367 DEF("audio-help", 0, QEMU_OPTION_audio_help,
368 "-audio-help print list of audio drivers and their options\n",
369 QEMU_ARCH_ALL)
370 STEXI
371 @item -audio-help
372 @findex -audio-help
373 Will show the audio subsystem help: list of drivers, tunable
374 parameters.
375 ETEXI
377 DEF("soundhw", HAS_ARG, QEMU_OPTION_soundhw,
378 "-soundhw c1,... enable audio support\n"
379 " and only specified sound cards (comma separated list)\n"
380 " use -soundhw ? to get the list of supported cards\n"
381 " use -soundhw all to enable all of them\n", QEMU_ARCH_ALL)
382 STEXI
383 @item -soundhw @var{card1}[,@var{card2},...] or -soundhw all
384 @findex -soundhw
385 Enable audio and selected sound hardware. Use ? to print all
386 available sound hardware.
388 @example
389 qemu -soundhw sb16,adlib disk.img
390 qemu -soundhw es1370 disk.img
391 qemu -soundhw ac97 disk.img
392 qemu -soundhw all disk.img
393 qemu -soundhw ?
394 @end example
396 Note that Linux's i810_audio OSS kernel (for AC97) module might
397 require manually specifying clocking.
399 @example
400 modprobe i810_audio clocking=48000
401 @end example
402 ETEXI
404 STEXI
405 @end table
406 ETEXI
408 DEF("usb", 0, QEMU_OPTION_usb,
409 "-usb enable the USB driver (will be the default soon)\n",
410 QEMU_ARCH_ALL)
411 STEXI
412 USB options:
413 @table @option
415 @item -usb
416 @findex -usb
417 Enable the USB driver (will be the default soon)
418 ETEXI
420 DEF("usbdevice", HAS_ARG, QEMU_OPTION_usbdevice,
421 "-usbdevice name add the host or guest USB device 'name'\n",
422 QEMU_ARCH_ALL)
423 STEXI
425 @item -usbdevice @var{devname}
426 @findex -usbdevice
427 Add the USB device @var{devname}. @xref{usb_devices}.
429 @table @option
431 @item mouse
432 Virtual Mouse. This will override the PS/2 mouse emulation when activated.
434 @item tablet
435 Pointer device that uses absolute coordinates (like a touchscreen). This
436 means qemu is able to report the mouse position without having to grab the
437 mouse. Also overrides the PS/2 mouse emulation when activated.
439 @item disk:[format=@var{format}]:@var{file}
440 Mass storage device based on file. The optional @var{format} argument
441 will be used rather than detecting the format. Can be used to specifiy
442 @code{format=raw} to avoid interpreting an untrusted format header.
444 @item host:@var{bus}.@var{addr}
445 Pass through the host device identified by @var{bus}.@var{addr} (Linux only).
447 @item host:@var{vendor_id}:@var{product_id}
448 Pass through the host device identified by @var{vendor_id}:@var{product_id}
449 (Linux only).
451 @item serial:[vendorid=@var{vendor_id}][,productid=@var{product_id}]:@var{dev}
452 Serial converter to host character device @var{dev}, see @code{-serial} for the
453 available devices.
455 @item braille
456 Braille device. This will use BrlAPI to display the braille output on a real
457 or fake device.
459 @item net:@var{options}
460 Network adapter that supports CDC ethernet and RNDIS protocols.
462 @end table
463 ETEXI
465 DEF("device", HAS_ARG, QEMU_OPTION_device,
466 "-device driver[,prop[=value][,...]]\n"
467 " add device (based on driver)\n"
468 " prop=value,... sets driver properties\n"
469 " use -device ? to print all possible drivers\n"
470 " use -device driver,? to print all possible options\n"
471 " use -device driver,option=? to print a help for value\n",
472 QEMU_ARCH_ALL)
473 STEXI
474 @item -device @var{driver}[,@var{option}[=@var{value}][,...]]
475 @findex -device
476 Add device @var{driver}. Depending on the device type,
477 @var{option} (with default or given @var{value}) may be useful.
478 To get a help on possible @var{driver}s, @var{option}s or @var{value}s, use
479 @code{-device ?},
480 @code{-device @var{driver},?} or
481 @code{-device @var{driver},@var{option}=?}.
482 ETEXI
484 #ifdef CONFIG_LINUX
485 DEFHEADING(File system options:)
487 DEF("fsdev", HAS_ARG, QEMU_OPTION_fsdev,
488 "-fsdev local,id=id,path=path\n",
489 QEMU_ARCH_ALL)
491 STEXI
493 The general form of a File system device option is:
494 @table @option
496 @item -fsdev @var{fstype} ,id=@var{id} [,@var{options}]
497 @findex -fsdev
498 Fstype is one of:
499 @option{local},
500 The specific Fstype will determine the applicable options.
502 Options to each backend are described below.
504 @item -fsdev local ,id=@var{id} ,path=@var{path}
506 Create a file-system-"device" for local-filesystem.
508 @option{local} is only available on Linux.
510 @option{path} specifies the path to be exported. @option{path} is required.
512 @end table
513 ETEXI
514 #endif
516 #ifdef CONFIG_LINUX
517 DEFHEADING(Virtual File system pass-through options:)
519 DEF("virtfs", HAS_ARG, QEMU_OPTION_virtfs,
520 "-virtfs local,path=path,mount_tag=tag\n",
521 QEMU_ARCH_ALL)
523 STEXI
525 The general form of a Virtual File system pass-through option is:
526 @table @option
528 @item -virtfs @var{fstype} [,@var{options}]
529 @findex -virtfs
530 Fstype is one of:
531 @option{local},
532 The specific Fstype will determine the applicable options.
534 Options to each backend are described below.
536 @item -virtfs local ,path=@var{path} ,mount_tag=@var{mount_tag}
538 Create a Virtual file-system-pass through for local-filesystem.
540 @option{local} is only available on Linux.
542 @option{path} specifies the path to be exported. @option{path} is required.
544 @option{mount_tag} specifies the tag with which the exported file is mounted.
545 @option{mount_tag} is required.
547 @end table
548 ETEXI
549 #endif
551 DEFHEADING()
553 DEF("name", HAS_ARG, QEMU_OPTION_name,
554 "-name string1[,process=string2]\n"
555 " set the name of the guest\n"
556 " string1 sets the window title and string2 the process name (on Linux)\n",
557 QEMU_ARCH_ALL)
558 STEXI
559 @item -name @var{name}
560 @findex -name
561 Sets the @var{name} of the guest.
562 This name will be displayed in the SDL window caption.
563 The @var{name} will also be used for the VNC server.
564 Also optionally set the top visible process name in Linux.
565 ETEXI
567 DEF("uuid", HAS_ARG, QEMU_OPTION_uuid,
568 "-uuid %08x-%04x-%04x-%04x-%012x\n"
569 " specify machine UUID\n", QEMU_ARCH_ALL)
570 STEXI
571 @item -uuid @var{uuid}
572 @findex -uuid
573 Set system UUID.
574 ETEXI
576 STEXI
577 @end table
578 ETEXI
580 DEFHEADING()
582 DEFHEADING(Display options:)
584 STEXI
585 @table @option
586 ETEXI
588 DEF("nographic", 0, QEMU_OPTION_nographic,
589 "-nographic disable graphical output and redirect serial I/Os to console\n",
590 QEMU_ARCH_ALL)
591 STEXI
592 @item -nographic
593 @findex -nographic
594 Normally, QEMU uses SDL to display the VGA output. With this option,
595 you can totally disable graphical output so that QEMU is a simple
596 command line application. The emulated serial port is redirected on
597 the console. Therefore, you can still use QEMU to debug a Linux kernel
598 with a serial console.
599 ETEXI
601 #ifdef CONFIG_CURSES
602 DEF("curses", 0, QEMU_OPTION_curses,
603 "-curses use a curses/ncurses interface instead of SDL\n",
604 QEMU_ARCH_ALL)
605 #endif
606 STEXI
607 @item -curses
608 @findex curses
609 Normally, QEMU uses SDL to display the VGA output. With this option,
610 QEMU can display the VGA output when in text mode using a
611 curses/ncurses interface. Nothing is displayed in graphical mode.
612 ETEXI
614 #ifdef CONFIG_SDL
615 DEF("no-frame", 0, QEMU_OPTION_no_frame,
616 "-no-frame open SDL window without a frame and window decorations\n",
617 QEMU_ARCH_ALL)
618 #endif
619 STEXI
620 @item -no-frame
621 @findex -no-frame
622 Do not use decorations for SDL windows and start them using the whole
623 available screen space. This makes the using QEMU in a dedicated desktop
624 workspace more convenient.
625 ETEXI
627 #ifdef CONFIG_SDL
628 DEF("alt-grab", 0, QEMU_OPTION_alt_grab,
629 "-alt-grab use Ctrl-Alt-Shift to grab mouse (instead of Ctrl-Alt)\n",
630 QEMU_ARCH_ALL)
631 #endif
632 STEXI
633 @item -alt-grab
634 @findex -alt-grab
635 Use Ctrl-Alt-Shift to grab mouse (instead of Ctrl-Alt).
636 ETEXI
638 #ifdef CONFIG_SDL
639 DEF("ctrl-grab", 0, QEMU_OPTION_ctrl_grab,
640 "-ctrl-grab use Right-Ctrl to grab mouse (instead of Ctrl-Alt)\n",
641 QEMU_ARCH_ALL)
642 #endif
643 STEXI
644 @item -ctrl-grab
645 @findex -ctrl-grab
646 Use Right-Ctrl to grab mouse (instead of Ctrl-Alt).
647 ETEXI
649 #ifdef CONFIG_SDL
650 DEF("no-quit", 0, QEMU_OPTION_no_quit,
651 "-no-quit disable SDL window close capability\n", QEMU_ARCH_ALL)
652 #endif
653 STEXI
654 @item -no-quit
655 @findex -no-quit
656 Disable SDL window close capability.
657 ETEXI
659 #ifdef CONFIG_SDL
660 DEF("sdl", 0, QEMU_OPTION_sdl,
661 "-sdl enable SDL\n", QEMU_ARCH_ALL)
662 #endif
663 STEXI
664 @item -sdl
665 @findex -sdl
666 Enable SDL.
667 ETEXI
669 DEF("portrait", 0, QEMU_OPTION_portrait,
670 "-portrait rotate graphical output 90 deg left (only PXA LCD)\n",
671 QEMU_ARCH_ALL)
672 STEXI
673 @item -portrait
674 @findex -portrait
675 Rotate graphical output 90 deg left (only PXA LCD).
676 ETEXI
678 DEF("vga", HAS_ARG, QEMU_OPTION_vga,
679 "-vga [std|cirrus|vmware|xenfb|none]\n"
680 " select video card type\n", QEMU_ARCH_ALL)
681 STEXI
682 @item -vga @var{type}
683 @findex -vga
684 Select type of VGA card to emulate. Valid values for @var{type} are
685 @table @option
686 @item cirrus
687 Cirrus Logic GD5446 Video card. All Windows versions starting from
688 Windows 95 should recognize and use this graphic card. For optimal
689 performances, use 16 bit color depth in the guest and the host OS.
690 (This one is the default)
691 @item std
692 Standard VGA card with Bochs VBE extensions. If your guest OS
693 supports the VESA 2.0 VBE extensions (e.g. Windows XP) and if you want
694 to use high resolution modes (>= 1280x1024x16) then you should use
695 this option.
696 @item vmware
697 VMWare SVGA-II compatible adapter. Use it if you have sufficiently
698 recent XFree86/XOrg server or Windows guest with a driver for this
699 card.
700 @item none
701 Disable VGA card.
702 @end table
703 ETEXI
705 DEF("full-screen", 0, QEMU_OPTION_full_screen,
706 "-full-screen start in full screen\n", QEMU_ARCH_ALL)
707 STEXI
708 @item -full-screen
709 @findex -full-screen
710 Start in full screen.
711 ETEXI
713 DEF("g", 1, QEMU_OPTION_g ,
714 "-g WxH[xDEPTH] Set the initial graphical resolution and depth\n",
715 QEMU_ARCH_PPC | QEMU_ARCH_SPARC)
716 STEXI
717 @item -g @var{width}x@var{height}[x@var{depth}]
718 @findex -g
719 Set the initial graphical resolution and depth (PPC, SPARC only).
720 ETEXI
722 DEF("vnc", HAS_ARG, QEMU_OPTION_vnc ,
723 "-vnc display start a VNC server on display\n", QEMU_ARCH_ALL)
724 STEXI
725 @item -vnc @var{display}[,@var{option}[,@var{option}[,...]]]
726 @findex -vnc
727 Normally, QEMU uses SDL to display the VGA output. With this option,
728 you can have QEMU listen on VNC display @var{display} and redirect the VGA
729 display over the VNC session. It is very useful to enable the usb
730 tablet device when using this option (option @option{-usbdevice
731 tablet}). When using the VNC display, you must use the @option{-k}
732 parameter to set the keyboard layout if you are not using en-us. Valid
733 syntax for the @var{display} is
735 @table @option
737 @item @var{host}:@var{d}
739 TCP connections will only be allowed from @var{host} on display @var{d}.
740 By convention the TCP port is 5900+@var{d}. Optionally, @var{host} can
741 be omitted in which case the server will accept connections from any host.
743 @item unix:@var{path}
745 Connections will be allowed over UNIX domain sockets where @var{path} is the
746 location of a unix socket to listen for connections on.
748 @item none
750 VNC is initialized but not started. The monitor @code{change} command
751 can be used to later start the VNC server.
753 @end table
755 Following the @var{display} value there may be one or more @var{option} flags
756 separated by commas. Valid options are
758 @table @option
760 @item reverse
762 Connect to a listening VNC client via a ``reverse'' connection. The
763 client is specified by the @var{display}. For reverse network
764 connections (@var{host}:@var{d},@code{reverse}), the @var{d} argument
765 is a TCP port number, not a display number.
767 @item password
769 Require that password based authentication is used for client connections.
770 The password must be set separately using the @code{change} command in the
771 @ref{pcsys_monitor}
773 @item tls
775 Require that client use TLS when communicating with the VNC server. This
776 uses anonymous TLS credentials so is susceptible to a man-in-the-middle
777 attack. It is recommended that this option be combined with either the
778 @option{x509} or @option{x509verify} options.
780 @item x509=@var{/path/to/certificate/dir}
782 Valid if @option{tls} is specified. Require that x509 credentials are used
783 for negotiating the TLS session. The server will send its x509 certificate
784 to the client. It is recommended that a password be set on the VNC server
785 to provide authentication of the client when this is used. The path following
786 this option specifies where the x509 certificates are to be loaded from.
787 See the @ref{vnc_security} section for details on generating certificates.
789 @item x509verify=@var{/path/to/certificate/dir}
791 Valid if @option{tls} is specified. Require that x509 credentials are used
792 for negotiating the TLS session. The server will send its x509 certificate
793 to the client, and request that the client send its own x509 certificate.
794 The server will validate the client's certificate against the CA certificate,
795 and reject clients when validation fails. If the certificate authority is
796 trusted, this is a sufficient authentication mechanism. You may still wish
797 to set a password on the VNC server as a second authentication layer. The
798 path following this option specifies where the x509 certificates are to
799 be loaded from. See the @ref{vnc_security} section for details on generating
800 certificates.
802 @item sasl
804 Require that the client use SASL to authenticate with the VNC server.
805 The exact choice of authentication method used is controlled from the
806 system / user's SASL configuration file for the 'qemu' service. This
807 is typically found in /etc/sasl2/qemu.conf. If running QEMU as an
808 unprivileged user, an environment variable SASL_CONF_PATH can be used
809 to make it search alternate locations for the service config.
810 While some SASL auth methods can also provide data encryption (eg GSSAPI),
811 it is recommended that SASL always be combined with the 'tls' and
812 'x509' settings to enable use of SSL and server certificates. This
813 ensures a data encryption preventing compromise of authentication
814 credentials. See the @ref{vnc_security} section for details on using
815 SASL authentication.
817 @item acl
819 Turn on access control lists for checking of the x509 client certificate
820 and SASL party. For x509 certs, the ACL check is made against the
821 certificate's distinguished name. This is something that looks like
822 @code{C=GB,O=ACME,L=Boston,CN=bob}. For SASL party, the ACL check is
823 made against the username, which depending on the SASL plugin, may
824 include a realm component, eg @code{bob} or @code{bob@@EXAMPLE.COM}.
825 When the @option{acl} flag is set, the initial access list will be
826 empty, with a @code{deny} policy. Thus no one will be allowed to
827 use the VNC server until the ACLs have been loaded. This can be
828 achieved using the @code{acl} monitor command.
830 @end table
831 ETEXI
833 STEXI
834 @end table
835 ETEXI
837 DEFHEADING()
839 DEFHEADING(i386 target only:)
840 STEXI
841 @table @option
842 ETEXI
844 DEF("win2k-hack", 0, QEMU_OPTION_win2k_hack,
845 "-win2k-hack use it when installing Windows 2000 to avoid a disk full bug\n",
846 QEMU_ARCH_I386)
847 STEXI
848 @item -win2k-hack
849 @findex -win2k-hack
850 Use it when installing Windows 2000 to avoid a disk full bug. After
851 Windows 2000 is installed, you no longer need this option (this option
852 slows down the IDE transfers).
853 ETEXI
855 HXCOMM Deprecated by -rtc
856 DEF("rtc-td-hack", 0, QEMU_OPTION_rtc_td_hack, "", QEMU_ARCH_I386)
858 DEF("no-fd-bootchk", 0, QEMU_OPTION_no_fd_bootchk,
859 "-no-fd-bootchk disable boot signature checking for floppy disks\n",
860 QEMU_ARCH_I386)
861 STEXI
862 @item -no-fd-bootchk
863 @findex -no-fd-bootchk
864 Disable boot signature checking for floppy disks in Bochs BIOS. It may
865 be needed to boot from old floppy disks.
866 TODO: check reference to Bochs BIOS.
867 ETEXI
869 DEF("no-acpi", 0, QEMU_OPTION_no_acpi,
870 "-no-acpi disable ACPI\n", QEMU_ARCH_I386)
871 STEXI
872 @item -no-acpi
873 @findex -no-acpi
874 Disable ACPI (Advanced Configuration and Power Interface) support. Use
875 it if your guest OS complains about ACPI problems (PC target machine
876 only).
877 ETEXI
879 DEF("no-hpet", 0, QEMU_OPTION_no_hpet,
880 "-no-hpet disable HPET\n", QEMU_ARCH_I386)
881 STEXI
882 @item -no-hpet
883 @findex -no-hpet
884 Disable HPET support.
885 ETEXI
887 DEF("balloon", HAS_ARG, QEMU_OPTION_balloon,
888 "-balloon none disable balloon device\n"
889 "-balloon virtio[,addr=str]\n"
890 " enable virtio balloon device (default)\n", QEMU_ARCH_ALL)
891 STEXI
892 @item -balloon none
893 @findex -balloon
894 Disable balloon device.
895 @item -balloon virtio[,addr=@var{addr}]
896 Enable virtio balloon device (default), optionally with PCI address
897 @var{addr}.
898 ETEXI
900 DEF("acpitable", HAS_ARG, QEMU_OPTION_acpitable,
901 "-acpitable [sig=str][,rev=n][,oem_id=str][,oem_table_id=str][,oem_rev=n][,asl_compiler_id=str][,asl_compiler_rev=n][,data=file1[:file2]...]\n"
902 " ACPI table description\n", QEMU_ARCH_I386)
903 STEXI
904 @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}]...]
905 @findex -acpitable
906 Add ACPI table with specified header fields and context from specified files.
907 ETEXI
909 DEF("smbios", HAS_ARG, QEMU_OPTION_smbios,
910 "-smbios file=binary\n"
911 " load SMBIOS entry from binary file\n"
912 "-smbios type=0[,vendor=str][,version=str][,date=str][,release=%d.%d]\n"
913 " specify SMBIOS type 0 fields\n"
914 "-smbios type=1[,manufacturer=str][,product=str][,version=str][,serial=str]\n"
915 " [,uuid=uuid][,sku=str][,family=str]\n"
916 " specify SMBIOS type 1 fields\n", QEMU_ARCH_I386)
917 STEXI
918 @item -smbios file=@var{binary}
919 @findex -smbios
920 Load SMBIOS entry from binary file.
922 @item -smbios type=0[,vendor=@var{str}][,version=@var{str}][,date=@var{str}][,release=@var{%d.%d}]
923 @findex -smbios
924 Specify SMBIOS type 0 fields
926 @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}]
927 Specify SMBIOS type 1 fields
928 ETEXI
930 DEFHEADING()
931 STEXI
932 @end table
933 ETEXI
935 DEFHEADING(Network options:)
936 STEXI
937 @table @option
938 ETEXI
940 HXCOMM Legacy slirp options (now moved to -net user):
941 #ifdef CONFIG_SLIRP
942 DEF("tftp", HAS_ARG, QEMU_OPTION_tftp, "", QEMU_ARCH_ALL)
943 DEF("bootp", HAS_ARG, QEMU_OPTION_bootp, "", QEMU_ARCH_ALL)
944 DEF("redir", HAS_ARG, QEMU_OPTION_redir, "", QEMU_ARCH_ALL)
945 #ifndef _WIN32
946 DEF("smb", HAS_ARG, QEMU_OPTION_smb, "", QEMU_ARCH_ALL)
947 #endif
948 #endif
950 DEF("net", HAS_ARG, QEMU_OPTION_net,
951 "-net nic[,vlan=n][,macaddr=mac][,model=type][,name=str][,addr=str][,vectors=v]\n"
952 " create a new Network Interface Card and connect it to VLAN 'n'\n"
953 #ifdef CONFIG_SLIRP
954 "-net user[,vlan=n][,name=str][,net=addr[/mask]][,host=addr][,restrict=y|n]\n"
955 " [,hostname=host][,dhcpstart=addr][,dns=addr][,tftp=dir][,bootfile=f]\n"
956 " [,hostfwd=rule][,guestfwd=rule]"
957 #ifndef _WIN32
958 "[,smb=dir[,smbserver=addr]]\n"
959 #endif
960 " connect the user mode network stack to VLAN 'n', configure its\n"
961 " DHCP server and enabled optional services\n"
962 #endif
963 #ifdef _WIN32
964 "-net tap[,vlan=n][,name=str],ifname=name\n"
965 " connect the host TAP network interface to VLAN 'n'\n"
966 #else
967 "-net tap[,vlan=n][,name=str][,fd=h][,ifname=name][,script=file][,downscript=dfile][,sndbuf=nbytes][,vnet_hdr=on|off][,vhost=on|off][,vhostfd=h]\n"
968 " connect the host TAP network interface to VLAN 'n' and use the\n"
969 " network scripts 'file' (default=" DEFAULT_NETWORK_SCRIPT ")\n"
970 " and 'dfile' (default=" DEFAULT_NETWORK_DOWN_SCRIPT ")\n"
971 " use '[down]script=no' to disable script execution\n"
972 " use 'fd=h' to connect to an already opened TAP interface\n"
973 " use 'sndbuf=nbytes' to limit the size of the send buffer (the\n"
974 " default of 'sndbuf=1048576' can be disabled using 'sndbuf=0')\n"
975 " use vnet_hdr=off to avoid enabling the IFF_VNET_HDR tap flag\n"
976 " use vnet_hdr=on to make the lack of IFF_VNET_HDR support an error condition\n"
977 " use vhost=on to enable experimental in kernel accelerator\n"
978 " use 'vhostfd=h' to connect to an already opened vhost net device\n"
979 #endif
980 "-net socket[,vlan=n][,name=str][,fd=h][,listen=[host]:port][,connect=host:port]\n"
981 " connect the vlan 'n' to another VLAN using a socket connection\n"
982 "-net socket[,vlan=n][,name=str][,fd=h][,mcast=maddr:port]\n"
983 " connect the vlan 'n' to multicast maddr and port\n"
984 #ifdef CONFIG_VDE
985 "-net vde[,vlan=n][,name=str][,sock=socketpath][,port=n][,group=groupname][,mode=octalmode]\n"
986 " connect the vlan 'n' to port 'n' of a vde switch running\n"
987 " on host and listening for incoming connections on 'socketpath'.\n"
988 " Use group 'groupname' and mode 'octalmode' to change default\n"
989 " ownership and permissions for communication port.\n"
990 #endif
991 "-net dump[,vlan=n][,file=f][,len=n]\n"
992 " dump traffic on vlan 'n' to file 'f' (max n bytes per packet)\n"
993 "-net none use it alone to have zero network devices. If no -net option\n"
994 " is provided, the default is '-net nic -net user'\n", QEMU_ARCH_ALL)
995 DEF("netdev", HAS_ARG, QEMU_OPTION_netdev,
996 "-netdev ["
997 #ifdef CONFIG_SLIRP
998 "user|"
999 #endif
1000 "tap|"
1001 #ifdef CONFIG_VDE
1002 "vde|"
1003 #endif
1004 "socket],id=str[,option][,option][,...]\n", QEMU_ARCH_ALL)
1005 STEXI
1006 @item -net nic[,vlan=@var{n}][,macaddr=@var{mac}][,model=@var{type}] [,name=@var{name}][,addr=@var{addr}][,vectors=@var{v}]
1007 @findex -net
1008 Create a new Network Interface Card and connect it to VLAN @var{n} (@var{n}
1009 = 0 is the default). The NIC is an e1000 by default on the PC
1010 target. Optionally, the MAC address can be changed to @var{mac}, the
1011 device address set to @var{addr} (PCI cards only),
1012 and a @var{name} can be assigned for use in monitor commands.
1013 Optionally, for PCI cards, you can specify the number @var{v} of MSI-X vectors
1014 that the card should have; this option currently only affects virtio cards; set
1015 @var{v} = 0 to disable MSI-X. If no @option{-net} option is specified, a single
1016 NIC is created. Qemu can emulate several different models of network card.
1017 Valid values for @var{type} are
1018 @code{virtio}, @code{i82551}, @code{i82557b}, @code{i82559er},
1019 @code{ne2k_pci}, @code{ne2k_isa}, @code{pcnet}, @code{rtl8139},
1020 @code{e1000}, @code{smc91c111}, @code{lance} and @code{mcf_fec}.
1021 Not all devices are supported on all targets. Use -net nic,model=?
1022 for a list of available devices for your target.
1024 @item -net user[,@var{option}][,@var{option}][,...]
1025 Use the user mode network stack which requires no administrator
1026 privilege to run. Valid options are:
1028 @table @option
1029 @item vlan=@var{n}
1030 Connect user mode stack to VLAN @var{n} (@var{n} = 0 is the default).
1032 @item name=@var{name}
1033 Assign symbolic name for use in monitor commands.
1035 @item net=@var{addr}[/@var{mask}]
1036 Set IP network address the guest will see. Optionally specify the netmask,
1037 either in the form a.b.c.d or as number of valid top-most bits. Default is
1038 10.0.2.0/8.
1040 @item host=@var{addr}
1041 Specify the guest-visible address of the host. Default is the 2nd IP in the
1042 guest network, i.e. x.x.x.2.
1044 @item restrict=y|yes|n|no
1045 If this options is enabled, the guest will be isolated, i.e. it will not be
1046 able to contact the host and no guest IP packets will be routed over the host
1047 to the outside. This option does not affect explicitly set forwarding rule.
1049 @item hostname=@var{name}
1050 Specifies the client hostname reported by the builtin DHCP server.
1052 @item dhcpstart=@var{addr}
1053 Specify the first of the 16 IPs the built-in DHCP server can assign. Default
1054 is the 16th to 31st IP in the guest network, i.e. x.x.x.16 to x.x.x.31.
1056 @item dns=@var{addr}
1057 Specify the guest-visible address of the virtual nameserver. The address must
1058 be different from the host address. Default is the 3rd IP in the guest network,
1059 i.e. x.x.x.3.
1061 @item tftp=@var{dir}
1062 When using the user mode network stack, activate a built-in TFTP
1063 server. The files in @var{dir} will be exposed as the root of a TFTP server.
1064 The TFTP client on the guest must be configured in binary mode (use the command
1065 @code{bin} of the Unix TFTP client).
1067 @item bootfile=@var{file}
1068 When using the user mode network stack, broadcast @var{file} as the BOOTP
1069 filename. In conjunction with @option{tftp}, this can be used to network boot
1070 a guest from a local directory.
1072 Example (using pxelinux):
1073 @example
1074 qemu -hda linux.img -boot n -net user,tftp=/path/to/tftp/files,bootfile=/pxelinux.0
1075 @end example
1077 @item smb=@var{dir}[,smbserver=@var{addr}]
1078 When using the user mode network stack, activate a built-in SMB
1079 server so that Windows OSes can access to the host files in @file{@var{dir}}
1080 transparently. The IP address of the SMB server can be set to @var{addr}. By
1081 default the 4th IP in the guest network is used, i.e. x.x.x.4.
1083 In the guest Windows OS, the line:
1084 @example
1085 10.0.2.4 smbserver
1086 @end example
1087 must be added in the file @file{C:\WINDOWS\LMHOSTS} (for windows 9x/Me)
1088 or @file{C:\WINNT\SYSTEM32\DRIVERS\ETC\LMHOSTS} (Windows NT/2000).
1090 Then @file{@var{dir}} can be accessed in @file{\\smbserver\qemu}.
1092 Note that a SAMBA server must be installed on the host OS in
1093 @file{/usr/sbin/smbd}. QEMU was tested successfully with smbd versions from
1094 Red Hat 9, Fedora Core 3 and OpenSUSE 11.x.
1096 @item hostfwd=[tcp|udp]:[@var{hostaddr}]:@var{hostport}-[@var{guestaddr}]:@var{guestport}
1097 Redirect incoming TCP or UDP connections to the host port @var{hostport} to
1098 the guest IP address @var{guestaddr} on guest port @var{guestport}. If
1099 @var{guestaddr} is not specified, its value is x.x.x.15 (default first address
1100 given by the built-in DHCP server). By specifying @var{hostaddr}, the rule can
1101 be bound to a specific host interface. If no connection type is set, TCP is
1102 used. This option can be given multiple times.
1104 For example, to redirect host X11 connection from screen 1 to guest
1105 screen 0, use the following:
1107 @example
1108 # on the host
1109 qemu -net user,hostfwd=tcp:127.0.0.1:6001-:6000 [...]
1110 # this host xterm should open in the guest X11 server
1111 xterm -display :1
1112 @end example
1114 To redirect telnet connections from host port 5555 to telnet port on
1115 the guest, use the following:
1117 @example
1118 # on the host
1119 qemu -net user,hostfwd=tcp::5555-:23 [...]
1120 telnet localhost 5555
1121 @end example
1123 Then when you use on the host @code{telnet localhost 5555}, you
1124 connect to the guest telnet server.
1126 @item guestfwd=[tcp]:@var{server}:@var{port}-@var{dev}
1127 Forward guest TCP connections to the IP address @var{server} on port @var{port}
1128 to the character device @var{dev}. This option can be given multiple times.
1130 @end table
1132 Note: Legacy stand-alone options -tftp, -bootp, -smb and -redir are still
1133 processed and applied to -net user. Mixing them with the new configuration
1134 syntax gives undefined results. Their use for new applications is discouraged
1135 as they will be removed from future versions.
1137 @item -net tap[,vlan=@var{n}][,name=@var{name}][,fd=@var{h}][,ifname=@var{name}] [,script=@var{file}][,downscript=@var{dfile}]
1138 Connect the host TAP network interface @var{name} to VLAN @var{n}, use
1139 the network script @var{file} to configure it and the network script
1140 @var{dfile} to deconfigure it. If @var{name} is not provided, the OS
1141 automatically provides one. @option{fd}=@var{h} can be used to specify
1142 the handle of an already opened host TAP interface. The default network
1143 configure script is @file{/etc/qemu-ifup} and the default network
1144 deconfigure script is @file{/etc/qemu-ifdown}. Use @option{script=no}
1145 or @option{downscript=no} to disable script execution. Example:
1147 @example
1148 qemu linux.img -net nic -net tap
1149 @end example
1151 More complicated example (two NICs, each one connected to a TAP device)
1152 @example
1153 qemu linux.img -net nic,vlan=0 -net tap,vlan=0,ifname=tap0 \
1154 -net nic,vlan=1 -net tap,vlan=1,ifname=tap1
1155 @end example
1157 @item -net socket[,vlan=@var{n}][,name=@var{name}][,fd=@var{h}] [,listen=[@var{host}]:@var{port}][,connect=@var{host}:@var{port}]
1159 Connect the VLAN @var{n} to a remote VLAN in another QEMU virtual
1160 machine using a TCP socket connection. If @option{listen} is
1161 specified, QEMU waits for incoming connections on @var{port}
1162 (@var{host} is optional). @option{connect} is used to connect to
1163 another QEMU instance using the @option{listen} option. @option{fd}=@var{h}
1164 specifies an already opened TCP socket.
1166 Example:
1167 @example
1168 # launch a first QEMU instance
1169 qemu linux.img -net nic,macaddr=52:54:00:12:34:56 \
1170 -net socket,listen=:1234
1171 # connect the VLAN 0 of this instance to the VLAN 0
1172 # of the first instance
1173 qemu linux.img -net nic,macaddr=52:54:00:12:34:57 \
1174 -net socket,connect=127.0.0.1:1234
1175 @end example
1177 @item -net socket[,vlan=@var{n}][,name=@var{name}][,fd=@var{h}] [,mcast=@var{maddr}:@var{port}]
1179 Create a VLAN @var{n} shared with another QEMU virtual
1180 machines using a UDP multicast socket, effectively making a bus for
1181 every QEMU with same multicast address @var{maddr} and @var{port}.
1182 NOTES:
1183 @enumerate
1184 @item
1185 Several QEMU can be running on different hosts and share same bus (assuming
1186 correct multicast setup for these hosts).
1187 @item
1188 mcast support is compatible with User Mode Linux (argument @option{eth@var{N}=mcast}), see
1189 @url{http://user-mode-linux.sf.net}.
1190 @item
1191 Use @option{fd=h} to specify an already opened UDP multicast socket.
1192 @end enumerate
1194 Example:
1195 @example
1196 # launch one QEMU instance
1197 qemu linux.img -net nic,macaddr=52:54:00:12:34:56 \
1198 -net socket,mcast=230.0.0.1:1234
1199 # launch another QEMU instance on same "bus"
1200 qemu linux.img -net nic,macaddr=52:54:00:12:34:57 \
1201 -net socket,mcast=230.0.0.1:1234
1202 # launch yet another QEMU instance on same "bus"
1203 qemu linux.img -net nic,macaddr=52:54:00:12:34:58 \
1204 -net socket,mcast=230.0.0.1:1234
1205 @end example
1207 Example (User Mode Linux compat.):
1208 @example
1209 # launch QEMU instance (note mcast address selected
1210 # is UML's default)
1211 qemu linux.img -net nic,macaddr=52:54:00:12:34:56 \
1212 -net socket,mcast=239.192.168.1:1102
1213 # launch UML
1214 /path/to/linux ubd0=/path/to/root_fs eth0=mcast
1215 @end example
1217 @item -net vde[,vlan=@var{n}][,name=@var{name}][,sock=@var{socketpath}] [,port=@var{n}][,group=@var{groupname}][,mode=@var{octalmode}]
1218 Connect VLAN @var{n} to PORT @var{n} of a vde switch running on host and
1219 listening for incoming connections on @var{socketpath}. Use GROUP @var{groupname}
1220 and MODE @var{octalmode} to change default ownership and permissions for
1221 communication port. This option is available only if QEMU has been compiled
1222 with vde support enabled.
1224 Example:
1225 @example
1226 # launch vde switch
1227 vde_switch -F -sock /tmp/myswitch
1228 # launch QEMU instance
1229 qemu linux.img -net nic -net vde,sock=/tmp/myswitch
1230 @end example
1232 @item -net dump[,vlan=@var{n}][,file=@var{file}][,len=@var{len}]
1233 Dump network traffic on VLAN @var{n} to file @var{file} (@file{qemu-vlan0.pcap} by default).
1234 At most @var{len} bytes (64k by default) per packet are stored. The file format is
1235 libpcap, so it can be analyzed with tools such as tcpdump or Wireshark.
1237 @item -net none
1238 Indicate that no network devices should be configured. It is used to
1239 override the default configuration (@option{-net nic -net user}) which
1240 is activated if no @option{-net} options are provided.
1242 @end table
1243 ETEXI
1245 DEFHEADING()
1247 DEFHEADING(Character device options:)
1249 DEF("chardev", HAS_ARG, QEMU_OPTION_chardev,
1250 "-chardev null,id=id[,mux=on|off]\n"
1251 "-chardev socket,id=id[,host=host],port=host[,to=to][,ipv4][,ipv6][,nodelay]\n"
1252 " [,server][,nowait][,telnet][,mux=on|off] (tcp)\n"
1253 "-chardev socket,id=id,path=path[,server][,nowait][,telnet],[mux=on|off] (unix)\n"
1254 "-chardev udp,id=id[,host=host],port=port[,localaddr=localaddr]\n"
1255 " [,localport=localport][,ipv4][,ipv6][,mux=on|off]\n"
1256 "-chardev msmouse,id=id[,mux=on|off]\n"
1257 "-chardev vc,id=id[[,width=width][,height=height]][[,cols=cols][,rows=rows]]\n"
1258 " [,mux=on|off]\n"
1259 "-chardev file,id=id,path=path[,mux=on|off]\n"
1260 "-chardev pipe,id=id,path=path[,mux=on|off]\n"
1261 #ifdef _WIN32
1262 "-chardev console,id=id[,mux=on|off]\n"
1263 "-chardev serial,id=id,path=path[,mux=on|off]\n"
1264 #else
1265 "-chardev pty,id=id[,mux=on|off]\n"
1266 "-chardev stdio,id=id[,mux=on|off]\n"
1267 #endif
1268 #ifdef CONFIG_BRLAPI
1269 "-chardev braille,id=id[,mux=on|off]\n"
1270 #endif
1271 #if defined(__linux__) || defined(__sun__) || defined(__FreeBSD__) \
1272 || defined(__NetBSD__) || defined(__OpenBSD__) || defined(__DragonFly__)
1273 "-chardev tty,id=id,path=path[,mux=on|off]\n"
1274 #endif
1275 #if defined(__linux__) || defined(__FreeBSD__) || defined(__DragonFly__)
1276 "-chardev parport,id=id,path=path[,mux=on|off]\n"
1277 #endif
1278 , QEMU_ARCH_ALL
1281 STEXI
1283 The general form of a character device option is:
1284 @table @option
1286 @item -chardev @var{backend} ,id=@var{id} [,mux=on|off] [,@var{options}]
1287 @findex -chardev
1288 Backend is one of:
1289 @option{null},
1290 @option{socket},
1291 @option{udp},
1292 @option{msmouse},
1293 @option{vc},
1294 @option{file},
1295 @option{pipe},
1296 @option{console},
1297 @option{serial},
1298 @option{pty},
1299 @option{stdio},
1300 @option{braille},
1301 @option{tty},
1302 @option{parport}.
1303 The specific backend will determine the applicable options.
1305 All devices must have an id, which can be any string up to 127 characters long.
1306 It is used to uniquely identify this device in other command line directives.
1308 A character device may be used in multiplexing mode by multiple front-ends.
1309 The key sequence of @key{Control-a} and @key{c} will rotate the input focus
1310 between attached front-ends. Specify @option{mux=on} to enable this mode.
1312 Options to each backend are described below.
1314 @item -chardev null ,id=@var{id}
1315 A void device. This device will not emit any data, and will drop any data it
1316 receives. The null backend does not take any options.
1318 @item -chardev socket ,id=@var{id} [@var{TCP options} or @var{unix options}] [,server] [,nowait] [,telnet]
1320 Create a two-way stream socket, which can be either a TCP or a unix socket. A
1321 unix socket will be created if @option{path} is specified. Behaviour is
1322 undefined if TCP options are specified for a unix socket.
1324 @option{server} specifies that the socket shall be a listening socket.
1326 @option{nowait} specifies that QEMU should not block waiting for a client to
1327 connect to a listening socket.
1329 @option{telnet} specifies that traffic on the socket should interpret telnet
1330 escape sequences.
1332 TCP and unix socket options are given below:
1334 @table @option
1336 @item TCP options: port=@var{port} [,host=@var{host}] [,to=@var{to}] [,ipv4] [,ipv6] [,nodelay]
1338 @option{host} for a listening socket specifies the local address to be bound.
1339 For a connecting socket species the remote host to connect to. @option{host} is
1340 optional for listening sockets. If not specified it defaults to @code{0.0.0.0}.
1342 @option{port} for a listening socket specifies the local port to be bound. For a
1343 connecting socket specifies the port on the remote host to connect to.
1344 @option{port} can be given as either a port number or a service name.
1345 @option{port} is required.
1347 @option{to} is only relevant to listening sockets. If it is specified, and
1348 @option{port} cannot be bound, QEMU will attempt to bind to subsequent ports up
1349 to and including @option{to} until it succeeds. @option{to} must be specified
1350 as a port number.
1352 @option{ipv4} and @option{ipv6} specify that either IPv4 or IPv6 must be used.
1353 If neither is specified the socket may use either protocol.
1355 @option{nodelay} disables the Nagle algorithm.
1357 @item unix options: path=@var{path}
1359 @option{path} specifies the local path of the unix socket. @option{path} is
1360 required.
1362 @end table
1364 @item -chardev udp ,id=@var{id} [,host=@var{host}] ,port=@var{port} [,localaddr=@var{localaddr}] [,localport=@var{localport}] [,ipv4] [,ipv6]
1366 Sends all traffic from the guest to a remote host over UDP.
1368 @option{host} specifies the remote host to connect to. If not specified it
1369 defaults to @code{localhost}.
1371 @option{port} specifies the port on the remote host to connect to. @option{port}
1372 is required.
1374 @option{localaddr} specifies the local address to bind to. If not specified it
1375 defaults to @code{0.0.0.0}.
1377 @option{localport} specifies the local port to bind to. If not specified any
1378 available local port will be used.
1380 @option{ipv4} and @option{ipv6} specify that either IPv4 or IPv6 must be used.
1381 If neither is specified the device may use either protocol.
1383 @item -chardev msmouse ,id=@var{id}
1385 Forward QEMU's emulated msmouse events to the guest. @option{msmouse} does not
1386 take any options.
1388 @item -chardev vc ,id=@var{id} [[,width=@var{width}] [,height=@var{height}]] [[,cols=@var{cols}] [,rows=@var{rows}]]
1390 Connect to a QEMU text console. @option{vc} may optionally be given a specific
1391 size.
1393 @option{width} and @option{height} specify the width and height respectively of
1394 the console, in pixels.
1396 @option{cols} and @option{rows} specify that the console be sized to fit a text
1397 console with the given dimensions.
1399 @item -chardev file ,id=@var{id} ,path=@var{path}
1401 Log all traffic received from the guest to a file.
1403 @option{path} specifies the path of the file to be opened. This file will be
1404 created if it does not already exist, and overwritten if it does. @option{path}
1405 is required.
1407 @item -chardev pipe ,id=@var{id} ,path=@var{path}
1409 Create a two-way connection to the guest. The behaviour differs slightly between
1410 Windows hosts and other hosts:
1412 On Windows, a single duplex pipe will be created at
1413 @file{\\.pipe\@option{path}}.
1415 On other hosts, 2 pipes will be created called @file{@option{path}.in} and
1416 @file{@option{path}.out}. Data written to @file{@option{path}.in} will be
1417 received by the guest. Data written by the guest can be read from
1418 @file{@option{path}.out}. QEMU will not create these fifos, and requires them to
1419 be present.
1421 @option{path} forms part of the pipe path as described above. @option{path} is
1422 required.
1424 @item -chardev console ,id=@var{id}
1426 Send traffic from the guest to QEMU's standard output. @option{console} does not
1427 take any options.
1429 @option{console} is only available on Windows hosts.
1431 @item -chardev serial ,id=@var{id} ,path=@option{path}
1433 Send traffic from the guest to a serial device on the host.
1435 @option{serial} is
1436 only available on Windows hosts.
1438 @option{path} specifies the name of the serial device to open.
1440 @item -chardev pty ,id=@var{id}
1442 Create a new pseudo-terminal on the host and connect to it. @option{pty} does
1443 not take any options.
1445 @option{pty} is not available on Windows hosts.
1447 @item -chardev stdio ,id=@var{id}
1448 Connect to standard input and standard output of the qemu process.
1449 @option{stdio} does not take any options. @option{stdio} is not available on
1450 Windows hosts.
1452 @item -chardev braille ,id=@var{id}
1454 Connect to a local BrlAPI server. @option{braille} does not take any options.
1456 @item -chardev tty ,id=@var{id} ,path=@var{path}
1458 Connect to a local tty device.
1460 @option{tty} is only available on Linux, Sun, FreeBSD, NetBSD, OpenBSD and
1461 DragonFlyBSD hosts.
1463 @option{path} specifies the path to the tty. @option{path} is required.
1465 @item -chardev parport ,id=@var{id} ,path=@var{path}
1467 @option{parport} is only available on Linux, FreeBSD and DragonFlyBSD hosts.
1469 Connect to a local parallel port.
1471 @option{path} specifies the path to the parallel port device. @option{path} is
1472 required.
1474 @end table
1475 ETEXI
1477 DEFHEADING()
1479 DEFHEADING(Bluetooth(R) options:)
1481 DEF("bt", HAS_ARG, QEMU_OPTION_bt, \
1482 "-bt hci,null dumb bluetooth HCI - doesn't respond to commands\n" \
1483 "-bt hci,host[:id]\n" \
1484 " use host's HCI with the given name\n" \
1485 "-bt hci[,vlan=n]\n" \
1486 " emulate a standard HCI in virtual scatternet 'n'\n" \
1487 "-bt vhci[,vlan=n]\n" \
1488 " add host computer to virtual scatternet 'n' using VHCI\n" \
1489 "-bt device:dev[,vlan=n]\n" \
1490 " emulate a bluetooth device 'dev' in scatternet 'n'\n",
1491 QEMU_ARCH_ALL)
1492 STEXI
1493 @table @option
1495 @item -bt hci[...]
1496 @findex -bt
1497 Defines the function of the corresponding Bluetooth HCI. -bt options
1498 are matched with the HCIs present in the chosen machine type. For
1499 example when emulating a machine with only one HCI built into it, only
1500 the first @code{-bt hci[...]} option is valid and defines the HCI's
1501 logic. The Transport Layer is decided by the machine type. Currently
1502 the machines @code{n800} and @code{n810} have one HCI and all other
1503 machines have none.
1505 @anchor{bt-hcis}
1506 The following three types are recognized:
1508 @table @option
1509 @item -bt hci,null
1510 (default) The corresponding Bluetooth HCI assumes no internal logic
1511 and will not respond to any HCI commands or emit events.
1513 @item -bt hci,host[:@var{id}]
1514 (@code{bluez} only) The corresponding HCI passes commands / events
1515 to / from the physical HCI identified by the name @var{id} (default:
1516 @code{hci0}) on the computer running QEMU. Only available on @code{bluez}
1517 capable systems like Linux.
1519 @item -bt hci[,vlan=@var{n}]
1520 Add a virtual, standard HCI that will participate in the Bluetooth
1521 scatternet @var{n} (default @code{0}). Similarly to @option{-net}
1522 VLANs, devices inside a bluetooth network @var{n} can only communicate
1523 with other devices in the same network (scatternet).
1524 @end table
1526 @item -bt vhci[,vlan=@var{n}]
1527 (Linux-host only) Create a HCI in scatternet @var{n} (default 0) attached
1528 to the host bluetooth stack instead of to the emulated target. This
1529 allows the host and target machines to participate in a common scatternet
1530 and communicate. Requires the Linux @code{vhci} driver installed. Can
1531 be used as following:
1533 @example
1534 qemu [...OPTIONS...] -bt hci,vlan=5 -bt vhci,vlan=5
1535 @end example
1537 @item -bt device:@var{dev}[,vlan=@var{n}]
1538 Emulate a bluetooth device @var{dev} and place it in network @var{n}
1539 (default @code{0}). QEMU can only emulate one type of bluetooth devices
1540 currently:
1542 @table @option
1543 @item keyboard
1544 Virtual wireless keyboard implementing the HIDP bluetooth profile.
1545 @end table
1546 @end table
1547 ETEXI
1549 DEFHEADING()
1551 DEFHEADING(Linux/Multiboot boot specific:)
1552 STEXI
1554 When using these options, you can use a given Linux or Multiboot
1555 kernel without installing it in the disk image. It can be useful
1556 for easier testing of various kernels.
1558 @table @option
1559 ETEXI
1561 DEF("kernel", HAS_ARG, QEMU_OPTION_kernel, \
1562 "-kernel bzImage use 'bzImage' as kernel image\n", QEMU_ARCH_ALL)
1563 STEXI
1564 @item -kernel @var{bzImage}
1565 @findex -kernel
1566 Use @var{bzImage} as kernel image. The kernel can be either a Linux kernel
1567 or in multiboot format.
1568 ETEXI
1570 DEF("append", HAS_ARG, QEMU_OPTION_append, \
1571 "-append cmdline use 'cmdline' as kernel command line\n", QEMU_ARCH_ALL)
1572 STEXI
1573 @item -append @var{cmdline}
1574 @findex -append
1575 Use @var{cmdline} as kernel command line
1576 ETEXI
1578 DEF("initrd", HAS_ARG, QEMU_OPTION_initrd, \
1579 "-initrd file use 'file' as initial ram disk\n", QEMU_ARCH_ALL)
1580 STEXI
1581 @item -initrd @var{file}
1582 @findex -initrd
1583 Use @var{file} as initial ram disk.
1585 @item -initrd "@var{file1} arg=foo,@var{file2}"
1587 This syntax is only available with multiboot.
1589 Use @var{file1} and @var{file2} as modules and pass arg=foo as parameter to the
1590 first module.
1591 ETEXI
1593 STEXI
1594 @end table
1595 ETEXI
1597 DEFHEADING()
1599 DEFHEADING(Debug/Expert options:)
1601 STEXI
1602 @table @option
1603 ETEXI
1605 DEF("serial", HAS_ARG, QEMU_OPTION_serial, \
1606 "-serial dev redirect the serial port to char device 'dev'\n",
1607 QEMU_ARCH_ALL)
1608 STEXI
1609 @item -serial @var{dev}
1610 @findex -serial
1611 Redirect the virtual serial port to host character device
1612 @var{dev}. The default device is @code{vc} in graphical mode and
1613 @code{stdio} in non graphical mode.
1615 This option can be used several times to simulate up to 4 serial
1616 ports.
1618 Use @code{-serial none} to disable all serial ports.
1620 Available character devices are:
1621 @table @option
1622 @item vc[:@var{W}x@var{H}]
1623 Virtual console. Optionally, a width and height can be given in pixel with
1624 @example
1625 vc:800x600
1626 @end example
1627 It is also possible to specify width or height in characters:
1628 @example
1629 vc:80Cx24C
1630 @end example
1631 @item pty
1632 [Linux only] Pseudo TTY (a new PTY is automatically allocated)
1633 @item none
1634 No device is allocated.
1635 @item null
1636 void device
1637 @item /dev/XXX
1638 [Linux only] Use host tty, e.g. @file{/dev/ttyS0}. The host serial port
1639 parameters are set according to the emulated ones.
1640 @item /dev/parport@var{N}
1641 [Linux only, parallel port only] Use host parallel port
1642 @var{N}. Currently SPP and EPP parallel port features can be used.
1643 @item file:@var{filename}
1644 Write output to @var{filename}. No character can be read.
1645 @item stdio
1646 [Unix only] standard input/output
1647 @item pipe:@var{filename}
1648 name pipe @var{filename}
1649 @item COM@var{n}
1650 [Windows only] Use host serial port @var{n}
1651 @item udp:[@var{remote_host}]:@var{remote_port}[@@[@var{src_ip}]:@var{src_port}]
1652 This implements UDP Net Console.
1653 When @var{remote_host} or @var{src_ip} are not specified
1654 they default to @code{0.0.0.0}.
1655 When not using a specified @var{src_port} a random port is automatically chosen.
1657 If you just want a simple readonly console you can use @code{netcat} or
1658 @code{nc}, by starting qemu with: @code{-serial udp::4555} and nc as:
1659 @code{nc -u -l -p 4555}. Any time qemu writes something to that port it
1660 will appear in the netconsole session.
1662 If you plan to send characters back via netconsole or you want to stop
1663 and start qemu a lot of times, you should have qemu use the same
1664 source port each time by using something like @code{-serial
1665 udp::4555@@:4556} to qemu. Another approach is to use a patched
1666 version of netcat which can listen to a TCP port and send and receive
1667 characters via udp. If you have a patched version of netcat which
1668 activates telnet remote echo and single char transfer, then you can
1669 use the following options to step up a netcat redirector to allow
1670 telnet on port 5555 to access the qemu port.
1671 @table @code
1672 @item Qemu Options:
1673 -serial udp::4555@@:4556
1674 @item netcat options:
1675 -u -P 4555 -L 0.0.0.0:4556 -t -p 5555 -I -T
1676 @item telnet options:
1677 localhost 5555
1678 @end table
1680 @item tcp:[@var{host}]:@var{port}[,@var{server}][,nowait][,nodelay]
1681 The TCP Net Console has two modes of operation. It can send the serial
1682 I/O to a location or wait for a connection from a location. By default
1683 the TCP Net Console is sent to @var{host} at the @var{port}. If you use
1684 the @var{server} option QEMU will wait for a client socket application
1685 to connect to the port before continuing, unless the @code{nowait}
1686 option was specified. The @code{nodelay} option disables the Nagle buffering
1687 algorithm. If @var{host} is omitted, 0.0.0.0 is assumed. Only
1688 one TCP connection at a time is accepted. You can use @code{telnet} to
1689 connect to the corresponding character device.
1690 @table @code
1691 @item Example to send tcp console to 192.168.0.2 port 4444
1692 -serial tcp:192.168.0.2:4444
1693 @item Example to listen and wait on port 4444 for connection
1694 -serial tcp::4444,server
1695 @item Example to not wait and listen on ip 192.168.0.100 port 4444
1696 -serial tcp:192.168.0.100:4444,server,nowait
1697 @end table
1699 @item telnet:@var{host}:@var{port}[,server][,nowait][,nodelay]
1700 The telnet protocol is used instead of raw tcp sockets. The options
1701 work the same as if you had specified @code{-serial tcp}. The
1702 difference is that the port acts like a telnet server or client using
1703 telnet option negotiation. This will also allow you to send the
1704 MAGIC_SYSRQ sequence if you use a telnet that supports sending the break
1705 sequence. Typically in unix telnet you do it with Control-] and then
1706 type "send break" followed by pressing the enter key.
1708 @item unix:@var{path}[,server][,nowait]
1709 A unix domain socket is used instead of a tcp socket. The option works the
1710 same as if you had specified @code{-serial tcp} except the unix domain socket
1711 @var{path} is used for connections.
1713 @item mon:@var{dev_string}
1714 This is a special option to allow the monitor to be multiplexed onto
1715 another serial port. The monitor is accessed with key sequence of
1716 @key{Control-a} and then pressing @key{c}. See monitor access
1717 @ref{pcsys_keys} in the -nographic section for more keys.
1718 @var{dev_string} should be any one of the serial devices specified
1719 above. An example to multiplex the monitor onto a telnet server
1720 listening on port 4444 would be:
1721 @table @code
1722 @item -serial mon:telnet::4444,server,nowait
1723 @end table
1725 @item braille
1726 Braille device. This will use BrlAPI to display the braille output on a real
1727 or fake device.
1729 @item msmouse
1730 Three button serial mouse. Configure the guest to use Microsoft protocol.
1731 @end table
1732 ETEXI
1734 DEF("parallel", HAS_ARG, QEMU_OPTION_parallel, \
1735 "-parallel dev redirect the parallel port to char device 'dev'\n",
1736 QEMU_ARCH_ALL)
1737 STEXI
1738 @item -parallel @var{dev}
1739 @findex -parallel
1740 Redirect the virtual parallel port to host device @var{dev} (same
1741 devices as the serial port). On Linux hosts, @file{/dev/parportN} can
1742 be used to use hardware devices connected on the corresponding host
1743 parallel port.
1745 This option can be used several times to simulate up to 3 parallel
1746 ports.
1748 Use @code{-parallel none} to disable all parallel ports.
1749 ETEXI
1751 DEF("monitor", HAS_ARG, QEMU_OPTION_monitor, \
1752 "-monitor dev redirect the monitor to char device 'dev'\n",
1753 QEMU_ARCH_ALL)
1754 STEXI
1755 @item -monitor @var{dev}
1756 @findex -monitor
1757 Redirect the monitor to host device @var{dev} (same devices as the
1758 serial port).
1759 The default device is @code{vc} in graphical mode and @code{stdio} in
1760 non graphical mode.
1761 ETEXI
1762 DEF("qmp", HAS_ARG, QEMU_OPTION_qmp, \
1763 "-qmp dev like -monitor but opens in 'control' mode\n",
1764 QEMU_ARCH_ALL)
1765 STEXI
1766 @item -qmp @var{dev}
1767 @findex -qmp
1768 Like -monitor but opens in 'control' mode.
1769 ETEXI
1771 DEF("mon", HAS_ARG, QEMU_OPTION_mon, \
1772 "-mon chardev=[name][,mode=readline|control][,default]\n", QEMU_ARCH_ALL)
1773 STEXI
1774 @item -mon chardev=[name][,mode=readline|control][,default]
1775 @findex -mon
1776 Setup monitor on chardev @var{name}.
1777 ETEXI
1779 DEF("debugcon", HAS_ARG, QEMU_OPTION_debugcon, \
1780 "-debugcon dev redirect the debug console to char device 'dev'\n",
1781 QEMU_ARCH_ALL)
1782 STEXI
1783 @item -debugcon @var{dev}
1784 @findex -debugcon
1785 Redirect the debug console to host device @var{dev} (same devices as the
1786 serial port). The debug console is an I/O port which is typically port
1787 0xe9; writing to that I/O port sends output to this device.
1788 The default device is @code{vc} in graphical mode and @code{stdio} in
1789 non graphical mode.
1790 ETEXI
1792 DEF("pidfile", HAS_ARG, QEMU_OPTION_pidfile, \
1793 "-pidfile file write PID to 'file'\n", QEMU_ARCH_ALL)
1794 STEXI
1795 @item -pidfile @var{file}
1796 @findex -pidfile
1797 Store the QEMU process PID in @var{file}. It is useful if you launch QEMU
1798 from a script.
1799 ETEXI
1801 DEF("singlestep", 0, QEMU_OPTION_singlestep, \
1802 "-singlestep always run in singlestep mode\n", QEMU_ARCH_ALL)
1803 STEXI
1804 @item -singlestep
1805 @findex -singlestep
1806 Run the emulation in single step mode.
1807 ETEXI
1809 DEF("S", 0, QEMU_OPTION_S, \
1810 "-S freeze CPU at startup (use 'c' to start execution)\n",
1811 QEMU_ARCH_ALL)
1812 STEXI
1813 @item -S
1814 @findex -S
1815 Do not start CPU at startup (you must type 'c' in the monitor).
1816 ETEXI
1818 DEF("gdb", HAS_ARG, QEMU_OPTION_gdb, \
1819 "-gdb dev wait for gdb connection on 'dev'\n", QEMU_ARCH_ALL)
1820 STEXI
1821 @item -gdb @var{dev}
1822 @findex -gdb
1823 Wait for gdb connection on device @var{dev} (@pxref{gdb_usage}). Typical
1824 connections will likely be TCP-based, but also UDP, pseudo TTY, or even
1825 stdio are reasonable use case. The latter is allowing to start qemu from
1826 within gdb and establish the connection via a pipe:
1827 @example
1828 (gdb) target remote | exec qemu -gdb stdio ...
1829 @end example
1830 ETEXI
1832 DEF("s", 0, QEMU_OPTION_s, \
1833 "-s shorthand for -gdb tcp::" DEFAULT_GDBSTUB_PORT "\n",
1834 QEMU_ARCH_ALL)
1835 STEXI
1836 @item -s
1837 @findex -s
1838 Shorthand for -gdb tcp::1234, i.e. open a gdbserver on TCP port 1234
1839 (@pxref{gdb_usage}).
1840 ETEXI
1842 DEF("d", HAS_ARG, QEMU_OPTION_d, \
1843 "-d item1,... output log to /tmp/qemu.log (use -d ? for a list of log items)\n",
1844 QEMU_ARCH_ALL)
1845 STEXI
1846 @item -d
1847 @findex -d
1848 Output log in /tmp/qemu.log
1849 ETEXI
1851 DEF("hdachs", HAS_ARG, QEMU_OPTION_hdachs, \
1852 "-hdachs c,h,s[,t]\n" \
1853 " force hard disk 0 physical geometry and the optional BIOS\n" \
1854 " translation (t=none or lba) (usually qemu can guess them)\n",
1855 QEMU_ARCH_ALL)
1856 STEXI
1857 @item -hdachs @var{c},@var{h},@var{s},[,@var{t}]
1858 @findex -hdachs
1859 Force hard disk 0 physical geometry (1 <= @var{c} <= 16383, 1 <=
1860 @var{h} <= 16, 1 <= @var{s} <= 63) and optionally force the BIOS
1861 translation mode (@var{t}=none, lba or auto). Usually QEMU can guess
1862 all those parameters. This option is useful for old MS-DOS disk
1863 images.
1864 ETEXI
1866 DEF("L", HAS_ARG, QEMU_OPTION_L, \
1867 "-L path set the directory for the BIOS, VGA BIOS and keymaps\n",
1868 QEMU_ARCH_ALL)
1869 STEXI
1870 @item -L @var{path}
1871 @findex -L
1872 Set the directory for the BIOS, VGA BIOS and keymaps.
1873 ETEXI
1875 DEF("bios", HAS_ARG, QEMU_OPTION_bios, \
1876 "-bios file set the filename for the BIOS\n", QEMU_ARCH_ALL)
1877 STEXI
1878 @item -bios @var{file}
1879 @findex -bios
1880 Set the filename for the BIOS.
1881 ETEXI
1883 DEF("enable-kvm", 0, QEMU_OPTION_enable_kvm, \
1884 "-enable-kvm enable KVM full virtualization support\n", QEMU_ARCH_ALL)
1885 STEXI
1886 @item -enable-kvm
1887 @findex -enable-kvm
1888 Enable KVM full virtualization support. This option is only available
1889 if KVM support is enabled when compiling.
1890 ETEXI
1892 DEF("xen-domid", HAS_ARG, QEMU_OPTION_xen_domid,
1893 "-xen-domid id specify xen guest domain id\n", QEMU_ARCH_ALL)
1894 DEF("xen-create", 0, QEMU_OPTION_xen_create,
1895 "-xen-create create domain using xen hypercalls, bypassing xend\n"
1896 " warning: should not be used when xend is in use\n",
1897 QEMU_ARCH_ALL)
1898 DEF("xen-attach", 0, QEMU_OPTION_xen_attach,
1899 "-xen-attach attach to existing xen domain\n"
1900 " xend will use this when starting qemu\n",
1901 QEMU_ARCH_ALL)
1902 STEXI
1903 @item -xen-domid @var{id}
1904 @findex -xen-domid
1905 Specify xen guest domain @var{id} (XEN only).
1906 @item -xen-create
1907 @findex -xen-create
1908 Create domain using xen hypercalls, bypassing xend.
1909 Warning: should not be used when xend is in use (XEN only).
1910 @item -xen-attach
1911 @findex -xen-attach
1912 Attach to existing xen domain.
1913 xend will use this when starting qemu (XEN only).
1914 ETEXI
1916 DEF("no-reboot", 0, QEMU_OPTION_no_reboot, \
1917 "-no-reboot exit instead of rebooting\n", QEMU_ARCH_ALL)
1918 STEXI
1919 @item -no-reboot
1920 @findex -no-reboot
1921 Exit instead of rebooting.
1922 ETEXI
1924 DEF("no-shutdown", 0, QEMU_OPTION_no_shutdown, \
1925 "-no-shutdown stop before shutdown\n", QEMU_ARCH_ALL)
1926 STEXI
1927 @item -no-shutdown
1928 @findex -no-shutdown
1929 Don't exit QEMU on guest shutdown, but instead only stop the emulation.
1930 This allows for instance switching to monitor to commit changes to the
1931 disk image.
1932 ETEXI
1934 DEF("loadvm", HAS_ARG, QEMU_OPTION_loadvm, \
1935 "-loadvm [tag|id]\n" \
1936 " start right away with a saved state (loadvm in monitor)\n",
1937 QEMU_ARCH_ALL)
1938 STEXI
1939 @item -loadvm @var{file}
1940 @findex -loadvm
1941 Start right away with a saved state (@code{loadvm} in monitor)
1942 ETEXI
1944 #ifndef _WIN32
1945 DEF("daemonize", 0, QEMU_OPTION_daemonize, \
1946 "-daemonize daemonize QEMU after initializing\n", QEMU_ARCH_ALL)
1947 #endif
1948 STEXI
1949 @item -daemonize
1950 @findex -daemonize
1951 Daemonize the QEMU process after initialization. QEMU will not detach from
1952 standard IO until it is ready to receive connections on any of its devices.
1953 This option is a useful way for external programs to launch QEMU without having
1954 to cope with initialization race conditions.
1955 ETEXI
1957 DEF("option-rom", HAS_ARG, QEMU_OPTION_option_rom, \
1958 "-option-rom rom load a file, rom, into the option ROM space\n",
1959 QEMU_ARCH_ALL)
1960 STEXI
1961 @item -option-rom @var{file}
1962 @findex -option-rom
1963 Load the contents of @var{file} as an option ROM.
1964 This option is useful to load things like EtherBoot.
1965 ETEXI
1967 DEF("clock", HAS_ARG, QEMU_OPTION_clock, \
1968 "-clock force the use of the given methods for timer alarm.\n" \
1969 " To see what timers are available use -clock ?\n",
1970 QEMU_ARCH_ALL)
1971 STEXI
1972 @item -clock @var{method}
1973 @findex -clock
1974 Force the use of the given methods for timer alarm. To see what timers
1975 are available use -clock ?.
1976 ETEXI
1978 HXCOMM Options deprecated by -rtc
1979 DEF("localtime", 0, QEMU_OPTION_localtime, "", QEMU_ARCH_ALL)
1980 DEF("startdate", HAS_ARG, QEMU_OPTION_startdate, "", QEMU_ARCH_ALL)
1982 DEF("rtc", HAS_ARG, QEMU_OPTION_rtc, \
1983 "-rtc [base=utc|localtime|date][,clock=host|vm][,driftfix=none|slew]\n" \
1984 " set the RTC base and clock, enable drift fix for clock ticks (x86 only)\n",
1985 QEMU_ARCH_ALL)
1987 STEXI
1989 @item -rtc [base=utc|localtime|@var{date}][,clock=host|vm][,driftfix=none|slew]
1990 @findex -rtc
1991 Specify @option{base} as @code{utc} or @code{localtime} to let the RTC start at the current
1992 UTC or local time, respectively. @code{localtime} is required for correct date in
1993 MS-DOS or Windows. To start at a specific point in time, provide @var{date} in the
1994 format @code{2006-06-17T16:01:21} or @code{2006-06-17}. The default base is UTC.
1996 By default the RTC is driven by the host system time. This allows to use the
1997 RTC as accurate reference clock inside the guest, specifically if the host
1998 time is smoothly following an accurate external reference clock, e.g. via NTP.
1999 If you want to isolate the guest time from the host, even prevent it from
2000 progressing during suspension, you can set @option{clock} to @code{vm} instead.
2002 Enable @option{driftfix} (i386 targets only) if you experience time drift problems,
2003 specifically with Windows' ACPI HAL. This option will try to figure out how
2004 many timer interrupts were not processed by the Windows guest and will
2005 re-inject them.
2006 ETEXI
2008 DEF("icount", HAS_ARG, QEMU_OPTION_icount, \
2009 "-icount [N|auto]\n" \
2010 " enable virtual instruction counter with 2^N clock ticks per\n" \
2011 " instruction\n", QEMU_ARCH_ALL)
2012 STEXI
2013 @item -icount [@var{N}|auto]
2014 @findex -icount
2015 Enable virtual instruction counter. The virtual cpu will execute one
2016 instruction every 2^@var{N} ns of virtual time. If @code{auto} is specified
2017 then the virtual cpu speed will be automatically adjusted to keep virtual
2018 time within a few seconds of real time.
2020 Note that while this option can give deterministic behavior, it does not
2021 provide cycle accurate emulation. Modern CPUs contain superscalar out of
2022 order cores with complex cache hierarchies. The number of instructions
2023 executed often has little or no correlation with actual performance.
2024 ETEXI
2026 DEF("watchdog", HAS_ARG, QEMU_OPTION_watchdog, \
2027 "-watchdog i6300esb|ib700\n" \
2028 " enable virtual hardware watchdog [default=none]\n",
2029 QEMU_ARCH_ALL)
2030 STEXI
2031 @item -watchdog @var{model}
2032 @findex -watchdog
2033 Create a virtual hardware watchdog device. Once enabled (by a guest
2034 action), the watchdog must be periodically polled by an agent inside
2035 the guest or else the guest will be restarted.
2037 The @var{model} is the model of hardware watchdog to emulate. Choices
2038 for model are: @code{ib700} (iBASE 700) which is a very simple ISA
2039 watchdog with a single timer, or @code{i6300esb} (Intel 6300ESB I/O
2040 controller hub) which is a much more featureful PCI-based dual-timer
2041 watchdog. Choose a model for which your guest has drivers.
2043 Use @code{-watchdog ?} to list available hardware models. Only one
2044 watchdog can be enabled for a guest.
2045 ETEXI
2047 DEF("watchdog-action", HAS_ARG, QEMU_OPTION_watchdog_action, \
2048 "-watchdog-action reset|shutdown|poweroff|pause|debug|none\n" \
2049 " action when watchdog fires [default=reset]\n",
2050 QEMU_ARCH_ALL)
2051 STEXI
2052 @item -watchdog-action @var{action}
2054 The @var{action} controls what QEMU will do when the watchdog timer
2055 expires.
2056 The default is
2057 @code{reset} (forcefully reset the guest).
2058 Other possible actions are:
2059 @code{shutdown} (attempt to gracefully shutdown the guest),
2060 @code{poweroff} (forcefully poweroff the guest),
2061 @code{pause} (pause the guest),
2062 @code{debug} (print a debug message and continue), or
2063 @code{none} (do nothing).
2065 Note that the @code{shutdown} action requires that the guest responds
2066 to ACPI signals, which it may not be able to do in the sort of
2067 situations where the watchdog would have expired, and thus
2068 @code{-watchdog-action shutdown} is not recommended for production use.
2070 Examples:
2072 @table @code
2073 @item -watchdog i6300esb -watchdog-action pause
2074 @item -watchdog ib700
2075 @end table
2076 ETEXI
2078 DEF("echr", HAS_ARG, QEMU_OPTION_echr, \
2079 "-echr chr set terminal escape character instead of ctrl-a\n",
2080 QEMU_ARCH_ALL)
2081 STEXI
2083 @item -echr @var{numeric_ascii_value}
2084 @findex -echr
2085 Change the escape character used for switching to the monitor when using
2086 monitor and serial sharing. The default is @code{0x01} when using the
2087 @code{-nographic} option. @code{0x01} is equal to pressing
2088 @code{Control-a}. You can select a different character from the ascii
2089 control keys where 1 through 26 map to Control-a through Control-z. For
2090 instance you could use the either of the following to change the escape
2091 character to Control-t.
2092 @table @code
2093 @item -echr 0x14
2094 @item -echr 20
2095 @end table
2096 ETEXI
2098 DEF("virtioconsole", HAS_ARG, QEMU_OPTION_virtiocon, \
2099 "-virtioconsole c\n" \
2100 " set virtio console\n", QEMU_ARCH_ALL)
2101 STEXI
2102 @item -virtioconsole @var{c}
2103 @findex -virtioconsole
2104 Set virtio console.
2106 This option is maintained for backward compatibility.
2108 Please use @code{-device virtconsole} for the new way of invocation.
2109 ETEXI
2111 DEF("show-cursor", 0, QEMU_OPTION_show_cursor, \
2112 "-show-cursor show cursor\n", QEMU_ARCH_ALL)
2113 STEXI
2114 @item -show-cursor
2115 @findex -show-cursor
2116 Show cursor.
2117 ETEXI
2119 DEF("tb-size", HAS_ARG, QEMU_OPTION_tb_size, \
2120 "-tb-size n set TB size\n", QEMU_ARCH_ALL)
2121 STEXI
2122 @item -tb-size @var{n}
2123 @findex -tb-size
2124 Set TB size.
2125 ETEXI
2127 DEF("incoming", HAS_ARG, QEMU_OPTION_incoming, \
2128 "-incoming p prepare for incoming migration, listen on port p\n",
2129 QEMU_ARCH_ALL)
2130 STEXI
2131 @item -incoming @var{port}
2132 @findex -incoming
2133 Prepare for incoming migration, listen on @var{port}.
2134 ETEXI
2136 DEF("nodefaults", 0, QEMU_OPTION_nodefaults, \
2137 "-nodefaults don't create default devices\n", QEMU_ARCH_ALL)
2138 STEXI
2139 @item -nodefaults
2140 @findex -nodefaults
2141 Don't create default devices.
2142 ETEXI
2144 #ifndef _WIN32
2145 DEF("chroot", HAS_ARG, QEMU_OPTION_chroot, \
2146 "-chroot dir chroot to dir just before starting the VM\n",
2147 QEMU_ARCH_ALL)
2148 #endif
2149 STEXI
2150 @item -chroot @var{dir}
2151 @findex -chroot
2152 Immediately before starting guest execution, chroot to the specified
2153 directory. Especially useful in combination with -runas.
2154 ETEXI
2156 #ifndef _WIN32
2157 DEF("runas", HAS_ARG, QEMU_OPTION_runas, \
2158 "-runas user change to user id user just before starting the VM\n",
2159 QEMU_ARCH_ALL)
2160 #endif
2161 STEXI
2162 @item -runas @var{user}
2163 @findex -runas
2164 Immediately before starting guest execution, drop root privileges, switching
2165 to the specified user.
2166 ETEXI
2168 DEF("prom-env", HAS_ARG, QEMU_OPTION_prom_env,
2169 "-prom-env variable=value\n"
2170 " set OpenBIOS nvram variables\n",
2171 QEMU_ARCH_PPC | QEMU_ARCH_SPARC)
2172 STEXI
2173 @item -prom-env @var{variable}=@var{value}
2174 @findex -prom-env
2175 Set OpenBIOS nvram @var{variable} to given @var{value} (PPC, SPARC only).
2176 ETEXI
2177 DEF("semihosting", 0, QEMU_OPTION_semihosting,
2178 "-semihosting semihosting mode\n", QEMU_ARCH_ARM | QEMU_ARCH_M68K)
2179 STEXI
2180 @item -semihosting
2181 @findex -semihosting
2182 Semihosting mode (ARM, M68K only).
2183 ETEXI
2184 DEF("old-param", 0, QEMU_OPTION_old_param,
2185 "-old-param old param mode\n", QEMU_ARCH_ARM)
2186 STEXI
2187 @item -old-param
2188 @findex -old-param (ARM)
2189 Old param mode (ARM only).
2190 ETEXI
2192 DEF("readconfig", HAS_ARG, QEMU_OPTION_readconfig,
2193 "-readconfig <file>\n", QEMU_ARCH_ALL)
2194 STEXI
2195 @item -readconfig @var{file}
2196 @findex -readconfig
2197 Read device configuration from @var{file}.
2198 ETEXI
2199 DEF("writeconfig", HAS_ARG, QEMU_OPTION_writeconfig,
2200 "-writeconfig <file>\n"
2201 " read/write config file\n", QEMU_ARCH_ALL)
2202 STEXI
2203 @item -writeconfig @var{file}
2204 @findex -writeconfig
2205 Write device configuration to @var{file}.
2206 ETEXI
2207 DEF("nodefconfig", 0, QEMU_OPTION_nodefconfig,
2208 "-nodefconfig\n"
2209 " do not load default config files at startup\n",
2210 QEMU_ARCH_ALL)
2211 STEXI
2212 @item -nodefconfig
2213 @findex -nodefconfig
2214 Normally QEMU loads a configuration file from @var{sysconfdir}/qemu.conf and
2215 @var{sysconfdir}/target-@var{ARCH}.conf on startup. The @code{-nodefconfig}
2216 option will prevent QEMU from loading these configuration files at startup.
2217 ETEXI
2219 DEF("no-kvm", 0, QEMU_OPTION_no_kvm,
2220 "-no-kvm disable KVM hardware virtualization\n",
2221 QEMU_ARCH_ALL)
2222 DEF("no-kvm-irqchip", 0, QEMU_OPTION_no_kvm_irqchip,
2223 "-no-kvm-irqchip disable KVM kernel mode PIC/IOAPIC/LAPIC\n",
2224 QEMU_ARCH_I386)
2225 DEF("no-kvm-pit", 0, QEMU_OPTION_no_kvm_pit,
2226 "-no-kvm-pit disable KVM kernel mode PIT\n",
2227 QEMU_ARCH_I386)
2228 DEF("no-kvm-pit-reinjection", 0, QEMU_OPTION_no_kvm_pit_reinjection,
2229 "-no-kvm-pit-reinjection\n"
2230 " disable KVM kernel mode PIT interrupt reinjection\n",
2231 QEMU_ARCH_I386)
2232 DEF("pcidevice", HAS_ARG, QEMU_OPTION_pcidevice,
2233 "-pcidevice host=[seg:]bus:dev.func[,dma=none][,name=string]\n"
2234 " expose a PCI device to the guest OS\n"
2235 " dma=none: don't perform any dma translations (default is to use an iommu)\n"
2236 " 'string' is used in log output\n", QEMU_ARCH_I386)
2237 DEF("enable-nesting", 0, QEMU_OPTION_enable_nesting,
2238 "-enable-nesting enable support for running a VM inside the VM (AMD only)\n", QEMU_ARCH_I386)
2239 DEF("nvram", HAS_ARG, QEMU_OPTION_nvram,
2240 "-nvram FILE provide ia64 nvram contents\n", QEMU_ARCH_ALL)
2241 DEF("tdf", 0, QEMU_OPTION_tdf,
2242 "-tdf enable guest time drift compensation\n", QEMU_ARCH_ALL)
2243 DEF("kvm-shadow-memory", HAS_ARG, QEMU_OPTION_kvm_shadow_memory,
2244 "-kvm-shadow-memory MEGABYTES\n"
2245 " allocate MEGABYTES for kvm mmu shadowing\n",
2246 QEMU_ARCH_I386)
2248 HXCOMM This is the last statement. Insert new options before this line!
2249 STEXI
2250 @end table
2251 ETEXI