Out off array access in usb-net
[qemu.git] / qemu-options.hx
blob4d99a58fc502d96c7f2d8b04cdd27eb3e763cc96
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|unsafe][,format=f]\n"
122 " [,serial=s][,addr=A][,id=name][,aio=threads|native]\n"
123 " [,readonly=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", "unsafe", 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 @end table
165 By default, writethrough caching is used for all block device. This means that
166 the host page cache will be used to read and write data but write notification
167 will be sent to the guest only when the data has been reported as written by
168 the storage subsystem.
170 Writeback caching will report data writes as completed as soon as the data is
171 present in the host page cache. This is safe as long as you trust your host.
172 If your host crashes or loses power, then the guest may experience data
173 corruption.
175 The host page cache can be avoided entirely with @option{cache=none}. This will
176 attempt to do disk IO directly to the guests memory. QEMU may still perform
177 an internal copy of the data.
179 Some block drivers perform badly with @option{cache=writethrough}, most notably,
180 qcow2. If performance is more important than correctness,
181 @option{cache=writeback} should be used with qcow2.
183 In case you don't care about data integrity over host failures, use
184 cache=unsafe. This option tells qemu that it never needs to write any data
185 to the disk but can instead keeps things in cache. If anything goes wrong,
186 like your host losing power, the disk storage getting disconnected accidently,
187 etc. you're image will most probably be rendered unusable. When using
188 the @option{-snapshot} option, unsafe caching is always used.
190 Instead of @option{-cdrom} you can use:
191 @example
192 qemu -drive file=file,index=2,media=cdrom
193 @end example
195 Instead of @option{-hda}, @option{-hdb}, @option{-hdc}, @option{-hdd}, you can
196 use:
197 @example
198 qemu -drive file=file,index=0,media=disk
199 qemu -drive file=file,index=1,media=disk
200 qemu -drive file=file,index=2,media=disk
201 qemu -drive file=file,index=3,media=disk
202 @end example
204 You can connect a CDROM to the slave of ide0:
205 @example
206 qemu -drive file=file,if=ide,index=1,media=cdrom
207 @end example
209 If you don't specify the "file=" argument, you define an empty drive:
210 @example
211 qemu -drive if=ide,index=1,media=cdrom
212 @end example
214 You can connect a SCSI disk with unit ID 6 on the bus #0:
215 @example
216 qemu -drive file=file,if=scsi,bus=0,unit=6
217 @end example
219 Instead of @option{-fda}, @option{-fdb}, you can use:
220 @example
221 qemu -drive file=file,index=0,if=floppy
222 qemu -drive file=file,index=1,if=floppy
223 @end example
225 By default, @var{interface} is "ide" and @var{index} is automatically
226 incremented:
227 @example
228 qemu -drive file=a -drive file=b"
229 @end example
230 is interpreted like:
231 @example
232 qemu -hda a -hdb b
233 @end example
234 ETEXI
236 DEF("set", HAS_ARG, QEMU_OPTION_set,
237 "-set group.id.arg=value\n"
238 " set <arg> parameter for item <id> of type <group>\n"
239 " i.e. -set drive.$id.file=/path/to/image\n", QEMU_ARCH_ALL)
240 STEXI
241 @item -set
242 @findex -set
243 TODO
244 ETEXI
246 DEF("global", HAS_ARG, QEMU_OPTION_global,
247 "-global driver.property=value\n"
248 " set a global default for a driver property\n",
249 QEMU_ARCH_ALL)
250 STEXI
251 @item -global
252 @findex -global
253 TODO
254 ETEXI
256 DEF("mtdblock", HAS_ARG, QEMU_OPTION_mtdblock,
257 "-mtdblock file use 'file' as on-board Flash memory image\n",
258 QEMU_ARCH_ALL)
259 STEXI
260 @item -mtdblock @var{file}
261 @findex -mtdblock
262 Use @var{file} as on-board Flash memory image.
263 ETEXI
265 DEF("sd", HAS_ARG, QEMU_OPTION_sd,
266 "-sd file use 'file' as SecureDigital card image\n", QEMU_ARCH_ALL)
267 STEXI
268 @item -sd @var{file}
269 @findex -sd
270 Use @var{file} as SecureDigital card image.
271 ETEXI
273 DEF("pflash", HAS_ARG, QEMU_OPTION_pflash,
274 "-pflash file use 'file' as a parallel flash image\n", QEMU_ARCH_ALL)
275 STEXI
276 @item -pflash @var{file}
277 @findex -pflash
278 Use @var{file} as a parallel flash image.
279 ETEXI
281 DEF("boot", HAS_ARG, QEMU_OPTION_boot,
282 "-boot [order=drives][,once=drives][,menu=on|off]\n"
283 " 'drives': floppy (a), hard disk (c), CD-ROM (d), network (n)\n",
284 QEMU_ARCH_ALL)
285 STEXI
286 @item -boot [order=@var{drives}][,once=@var{drives}][,menu=on|off]
287 @findex -boot
288 Specify boot order @var{drives} as a string of drive letters. Valid
289 drive letters depend on the target achitecture. The x86 PC uses: a, b
290 (floppy 1 and 2), c (first hard disk), d (first CD-ROM), n-p (Etherboot
291 from network adapter 1-4), hard disk boot is the default. To apply a
292 particular boot order only on the first startup, specify it via
293 @option{once}.
295 Interactive boot menus/prompts can be enabled via @option{menu=on} as far
296 as firmware/BIOS supports them. The default is non-interactive boot.
298 @example
299 # try to boot from network first, then from hard disk
300 qemu -boot order=nc
301 # boot from CD-ROM first, switch back to default order after reboot
302 qemu -boot once=d
303 @end example
305 Note: The legacy format '-boot @var{drives}' is still supported but its
306 use is discouraged as it may be removed from future versions.
307 ETEXI
309 DEF("snapshot", 0, QEMU_OPTION_snapshot,
310 "-snapshot write to temporary files instead of disk image files\n",
311 QEMU_ARCH_ALL)
312 STEXI
313 @item -snapshot
314 @findex -snapshot
315 Write to temporary files instead of disk image files. In this case,
316 the raw disk image you use is not written back. You can however force
317 the write back by pressing @key{C-a s} (@pxref{disk_images}).
318 ETEXI
320 DEF("m", HAS_ARG, QEMU_OPTION_m,
321 "-m megs set virtual RAM size to megs MB [default="
322 stringify(DEFAULT_RAM_SIZE) "]\n", QEMU_ARCH_ALL)
323 STEXI
324 @item -m @var{megs}
325 @findex -m
326 Set virtual RAM size to @var{megs} megabytes. Default is 128 MiB. Optionally,
327 a suffix of ``M'' or ``G'' can be used to signify a value in megabytes or
328 gigabytes respectively.
329 ETEXI
331 DEF("mem-path", HAS_ARG, QEMU_OPTION_mempath,
332 "-mem-path FILE provide backing storage for guest RAM\n", QEMU_ARCH_ALL)
333 STEXI
334 @item -mem-path @var{path}
335 Allocate guest RAM from a temporarily created file in @var{path}.
336 ETEXI
338 #ifdef MAP_POPULATE
339 DEF("mem-prealloc", 0, QEMU_OPTION_mem_prealloc,
340 "-mem-prealloc preallocate guest memory (use with -mem-path)\n",
341 QEMU_ARCH_ALL)
342 STEXI
343 @item -mem-prealloc
344 Preallocate memory when using -mem-path.
345 ETEXI
346 #endif
348 DEF("k", HAS_ARG, QEMU_OPTION_k,
349 "-k language use keyboard layout (for example 'fr' for French)\n",
350 QEMU_ARCH_ALL)
351 STEXI
352 @item -k @var{language}
353 @findex -k
354 Use keyboard layout @var{language} (for example @code{fr} for
355 French). This option is only needed where it is not easy to get raw PC
356 keycodes (e.g. on Macs, with some X11 servers or with a VNC
357 display). You don't normally need to use it on PC/Linux or PC/Windows
358 hosts.
360 The available layouts are:
361 @example
362 ar de-ch es fo fr-ca hu ja mk no pt-br sv
363 da en-gb et fr fr-ch is lt nl pl ru th
364 de en-us fi fr-be hr it lv nl-be pt sl tr
365 @end example
367 The default is @code{en-us}.
368 ETEXI
371 DEF("audio-help", 0, QEMU_OPTION_audio_help,
372 "-audio-help print list of audio drivers and their options\n",
373 QEMU_ARCH_ALL)
374 STEXI
375 @item -audio-help
376 @findex -audio-help
377 Will show the audio subsystem help: list of drivers, tunable
378 parameters.
379 ETEXI
381 DEF("soundhw", HAS_ARG, QEMU_OPTION_soundhw,
382 "-soundhw c1,... enable audio support\n"
383 " and only specified sound cards (comma separated list)\n"
384 " use -soundhw ? to get the list of supported cards\n"
385 " use -soundhw all to enable all of them\n", QEMU_ARCH_ALL)
386 STEXI
387 @item -soundhw @var{card1}[,@var{card2},...] or -soundhw all
388 @findex -soundhw
389 Enable audio and selected sound hardware. Use ? to print all
390 available sound hardware.
392 @example
393 qemu -soundhw sb16,adlib disk.img
394 qemu -soundhw es1370 disk.img
395 qemu -soundhw ac97 disk.img
396 qemu -soundhw hda disk.img
397 qemu -soundhw all disk.img
398 qemu -soundhw ?
399 @end example
401 Note that Linux's i810_audio OSS kernel (for AC97) module might
402 require manually specifying clocking.
404 @example
405 modprobe i810_audio clocking=48000
406 @end example
407 ETEXI
409 STEXI
410 @end table
411 ETEXI
413 DEF("usb", 0, QEMU_OPTION_usb,
414 "-usb enable the USB driver (will be the default soon)\n",
415 QEMU_ARCH_ALL)
416 STEXI
417 USB options:
418 @table @option
420 @item -usb
421 @findex -usb
422 Enable the USB driver (will be the default soon)
423 ETEXI
425 DEF("usbdevice", HAS_ARG, QEMU_OPTION_usbdevice,
426 "-usbdevice name add the host or guest USB device 'name'\n",
427 QEMU_ARCH_ALL)
428 STEXI
430 @item -usbdevice @var{devname}
431 @findex -usbdevice
432 Add the USB device @var{devname}. @xref{usb_devices}.
434 @table @option
436 @item mouse
437 Virtual Mouse. This will override the PS/2 mouse emulation when activated.
439 @item tablet
440 Pointer device that uses absolute coordinates (like a touchscreen). This
441 means qemu is able to report the mouse position without having to grab the
442 mouse. Also overrides the PS/2 mouse emulation when activated.
444 @item disk:[format=@var{format}]:@var{file}
445 Mass storage device based on file. The optional @var{format} argument
446 will be used rather than detecting the format. Can be used to specifiy
447 @code{format=raw} to avoid interpreting an untrusted format header.
449 @item host:@var{bus}.@var{addr}
450 Pass through the host device identified by @var{bus}.@var{addr} (Linux only).
452 @item host:@var{vendor_id}:@var{product_id}
453 Pass through the host device identified by @var{vendor_id}:@var{product_id}
454 (Linux only).
456 @item serial:[vendorid=@var{vendor_id}][,productid=@var{product_id}]:@var{dev}
457 Serial converter to host character device @var{dev}, see @code{-serial} for the
458 available devices.
460 @item braille
461 Braille device. This will use BrlAPI to display the braille output on a real
462 or fake device.
464 @item net:@var{options}
465 Network adapter that supports CDC ethernet and RNDIS protocols.
467 @end table
468 ETEXI
470 DEF("device", HAS_ARG, QEMU_OPTION_device,
471 "-device driver[,prop[=value][,...]]\n"
472 " add device (based on driver)\n"
473 " prop=value,... sets driver properties\n"
474 " use -device ? to print all possible drivers\n"
475 " use -device driver,? to print all possible properties\n",
476 QEMU_ARCH_ALL)
477 STEXI
478 @item -device @var{driver}[,@var{prop}[=@var{value}][,...]]
479 @findex -device
480 Add device @var{driver}. @var{prop}=@var{value} sets driver
481 properties. Valid properties depend on the driver. To get help on
482 possible drivers and properties, use @code{-device ?} and
483 @code{-device @var{driver},?}.
484 ETEXI
486 DEFHEADING(File system options:)
488 DEF("fsdev", HAS_ARG, QEMU_OPTION_fsdev,
489 "-fsdev local,id=id,path=path,security_model=[mapped|passthrough|none]\n",
490 QEMU_ARCH_ALL)
492 STEXI
494 The general form of a File system device option is:
495 @table @option
497 @item -fsdev @var{fstype} ,id=@var{id} [,@var{options}]
498 @findex -fsdev
499 Fstype is one of:
500 @option{local},
501 The specific Fstype will determine the applicable options.
503 Options to each backend are described below.
505 @item -fsdev local ,id=@var{id} ,path=@var{path} ,security_model=@var{security_model}
507 Create a file-system-"device" for local-filesystem.
509 @option{local} is only available on Linux.
511 @option{path} specifies the path to be exported. @option{path} is required.
513 @option{security_model} specifies the security model to be followed.
514 @option{security_model} is required.
516 @end table
517 ETEXI
519 DEFHEADING(Virtual File system pass-through options:)
521 DEF("virtfs", HAS_ARG, QEMU_OPTION_virtfs,
522 "-virtfs local,path=path,mount_tag=tag,security_model=[mapped|passthrough|none]\n",
523 QEMU_ARCH_ALL)
525 STEXI
527 The general form of a Virtual File system pass-through option is:
528 @table @option
530 @item -virtfs @var{fstype} [,@var{options}]
531 @findex -virtfs
532 Fstype is one of:
533 @option{local},
534 The specific Fstype will determine the applicable options.
536 Options to each backend are described below.
538 @item -virtfs local ,path=@var{path} ,mount_tag=@var{mount_tag} ,security_model=@var{security_model}
540 Create a Virtual file-system-pass through for local-filesystem.
542 @option{local} is only available on Linux.
544 @option{path} specifies the path to be exported. @option{path} is required.
546 @option{security_model} specifies the security model to be followed.
547 @option{security_model} is required.
550 @option{mount_tag} specifies the tag with which the exported file is mounted.
551 @option{mount_tag} is required.
553 @end table
554 ETEXI
556 DEFHEADING()
558 DEF("name", HAS_ARG, QEMU_OPTION_name,
559 "-name string1[,process=string2]\n"
560 " set the name of the guest\n"
561 " string1 sets the window title and string2 the process name (on Linux)\n",
562 QEMU_ARCH_ALL)
563 STEXI
564 @item -name @var{name}
565 @findex -name
566 Sets the @var{name} of the guest.
567 This name will be displayed in the SDL window caption.
568 The @var{name} will also be used for the VNC server.
569 Also optionally set the top visible process name in Linux.
570 ETEXI
572 DEF("uuid", HAS_ARG, QEMU_OPTION_uuid,
573 "-uuid %08x-%04x-%04x-%04x-%012x\n"
574 " specify machine UUID\n", QEMU_ARCH_ALL)
575 STEXI
576 @item -uuid @var{uuid}
577 @findex -uuid
578 Set system UUID.
579 ETEXI
581 STEXI
582 @end table
583 ETEXI
585 DEFHEADING()
587 DEFHEADING(Display options:)
589 STEXI
590 @table @option
591 ETEXI
593 DEF("nographic", 0, QEMU_OPTION_nographic,
594 "-nographic disable graphical output and redirect serial I/Os to console\n",
595 QEMU_ARCH_ALL)
596 STEXI
597 @item -nographic
598 @findex -nographic
599 Normally, QEMU uses SDL to display the VGA output. With this option,
600 you can totally disable graphical output so that QEMU is a simple
601 command line application. The emulated serial port is redirected on
602 the console. Therefore, you can still use QEMU to debug a Linux kernel
603 with a serial console.
604 ETEXI
606 #ifdef CONFIG_CURSES
607 DEF("curses", 0, QEMU_OPTION_curses,
608 "-curses use a curses/ncurses interface instead of SDL\n",
609 QEMU_ARCH_ALL)
610 #endif
611 STEXI
612 @item -curses
613 @findex curses
614 Normally, QEMU uses SDL to display the VGA output. With this option,
615 QEMU can display the VGA output when in text mode using a
616 curses/ncurses interface. Nothing is displayed in graphical mode.
617 ETEXI
619 #ifdef CONFIG_SDL
620 DEF("no-frame", 0, QEMU_OPTION_no_frame,
621 "-no-frame open SDL window without a frame and window decorations\n",
622 QEMU_ARCH_ALL)
623 #endif
624 STEXI
625 @item -no-frame
626 @findex -no-frame
627 Do not use decorations for SDL windows and start them using the whole
628 available screen space. This makes the using QEMU in a dedicated desktop
629 workspace more convenient.
630 ETEXI
632 #ifdef CONFIG_SDL
633 DEF("alt-grab", 0, QEMU_OPTION_alt_grab,
634 "-alt-grab use Ctrl-Alt-Shift to grab mouse (instead of Ctrl-Alt)\n",
635 QEMU_ARCH_ALL)
636 #endif
637 STEXI
638 @item -alt-grab
639 @findex -alt-grab
640 Use Ctrl-Alt-Shift to grab mouse (instead of Ctrl-Alt).
641 ETEXI
643 #ifdef CONFIG_SDL
644 DEF("ctrl-grab", 0, QEMU_OPTION_ctrl_grab,
645 "-ctrl-grab use Right-Ctrl to grab mouse (instead of Ctrl-Alt)\n",
646 QEMU_ARCH_ALL)
647 #endif
648 STEXI
649 @item -ctrl-grab
650 @findex -ctrl-grab
651 Use Right-Ctrl to grab mouse (instead of Ctrl-Alt).
652 ETEXI
654 #ifdef CONFIG_SDL
655 DEF("no-quit", 0, QEMU_OPTION_no_quit,
656 "-no-quit disable SDL window close capability\n", QEMU_ARCH_ALL)
657 #endif
658 STEXI
659 @item -no-quit
660 @findex -no-quit
661 Disable SDL window close capability.
662 ETEXI
664 #ifdef CONFIG_SDL
665 DEF("sdl", 0, QEMU_OPTION_sdl,
666 "-sdl enable SDL\n", QEMU_ARCH_ALL)
667 #endif
668 STEXI
669 @item -sdl
670 @findex -sdl
671 Enable SDL.
672 ETEXI
674 DEF("spice", HAS_ARG, QEMU_OPTION_spice,
675 "-spice <args> enable spice\n", QEMU_ARCH_ALL)
676 STEXI
677 @item -spice @var{option}[,@var{option}[,...]]
678 @findex -spice
679 Enable the spice remote desktop protocol. Valid options are
681 @table @option
683 @item port=<nr>
684 Set the TCP port spice is listening on for plaintext channels.
686 @item addr=<addr>
687 Set the IP address spice is listening on. Default is any address.
689 @item ipv4
690 @item ipv6
691 Force using the specified IP version.
693 @item password=<secret>
694 Set the password you need to authenticate.
696 @item disable-ticketing
697 Allow client connects without authentication.
699 @item tls-port=<nr>
700 Set the TCP port spice is listening on for encrypted channels.
702 @item x509-dir=<dir>
703 Set the x509 file directory. Expects same filenames as -vnc $display,x509=$dir
705 @item x509-key-file=<file>
706 @item x509-key-password=<file>
707 @item x509-cert-file=<file>
708 @item x509-cacert-file=<file>
709 @item x509-dh-key-file=<file>
710 The x509 file names can also be configured individually.
712 @item tls-ciphers=<list>
713 Specify which ciphers to use.
715 @item tls-channel=[main|display|inputs|record|playback|tunnel]
716 @item plaintext-channel=[main|display|inputs|record|playback|tunnel]
717 Force specific channel to be used with or without TLS encryption. The
718 options can be specified multiple times to configure multiple
719 channels. The special name "default" can be used to set the default
720 mode. For channels which are not explicitly forced into one mode the
721 spice client is allowed to pick tls/plaintext as he pleases.
723 @item image-compression=[auto_glz|auto_lz|quic|glz|lz|off]
724 Configure image compression (lossless).
725 Default is auto_glz.
727 @item jpeg-wan-compression=[auto|never|always]
728 @item zlib-glz-wan-compression=[auto|never|always]
729 Configure wan image compression (lossy for slow links).
730 Default is auto.
732 @item streaming-video=[off|all|filter]
733 Configure video stream detection. Default is filter.
735 @item agent-mouse=[on|off]
736 Enable/disable passing mouse events via vdagent. Default is on.
738 @item playback-compression=[on|off]
739 Enable/disable audio stream compression (using celt 0.5.1). Default is on.
741 @end table
742 ETEXI
744 DEF("portrait", 0, QEMU_OPTION_portrait,
745 "-portrait rotate graphical output 90 deg left (only PXA LCD)\n",
746 QEMU_ARCH_ALL)
747 STEXI
748 @item -portrait
749 @findex -portrait
750 Rotate graphical output 90 deg left (only PXA LCD).
751 ETEXI
753 DEF("vga", HAS_ARG, QEMU_OPTION_vga,
754 "-vga [std|cirrus|vmware|xenfb|none]\n"
755 " select video card type\n", QEMU_ARCH_ALL)
756 STEXI
757 @item -vga @var{type}
758 @findex -vga
759 Select type of VGA card to emulate. Valid values for @var{type} are
760 @table @option
761 @item cirrus
762 Cirrus Logic GD5446 Video card. All Windows versions starting from
763 Windows 95 should recognize and use this graphic card. For optimal
764 performances, use 16 bit color depth in the guest and the host OS.
765 (This one is the default)
766 @item std
767 Standard VGA card with Bochs VBE extensions. If your guest OS
768 supports the VESA 2.0 VBE extensions (e.g. Windows XP) and if you want
769 to use high resolution modes (>= 1280x1024x16) then you should use
770 this option.
771 @item vmware
772 VMWare SVGA-II compatible adapter. Use it if you have sufficiently
773 recent XFree86/XOrg server or Windows guest with a driver for this
774 card.
775 @item none
776 Disable VGA card.
777 @end table
778 ETEXI
780 DEF("full-screen", 0, QEMU_OPTION_full_screen,
781 "-full-screen start in full screen\n", QEMU_ARCH_ALL)
782 STEXI
783 @item -full-screen
784 @findex -full-screen
785 Start in full screen.
786 ETEXI
788 DEF("g", 1, QEMU_OPTION_g ,
789 "-g WxH[xDEPTH] Set the initial graphical resolution and depth\n",
790 QEMU_ARCH_PPC | QEMU_ARCH_SPARC)
791 STEXI
792 @item -g @var{width}x@var{height}[x@var{depth}]
793 @findex -g
794 Set the initial graphical resolution and depth (PPC, SPARC only).
795 ETEXI
797 DEF("vnc", HAS_ARG, QEMU_OPTION_vnc ,
798 "-vnc display start a VNC server on display\n", QEMU_ARCH_ALL)
799 STEXI
800 @item -vnc @var{display}[,@var{option}[,@var{option}[,...]]]
801 @findex -vnc
802 Normally, QEMU uses SDL to display the VGA output. With this option,
803 you can have QEMU listen on VNC display @var{display} and redirect the VGA
804 display over the VNC session. It is very useful to enable the usb
805 tablet device when using this option (option @option{-usbdevice
806 tablet}). When using the VNC display, you must use the @option{-k}
807 parameter to set the keyboard layout if you are not using en-us. Valid
808 syntax for the @var{display} is
810 @table @option
812 @item @var{host}:@var{d}
814 TCP connections will only be allowed from @var{host} on display @var{d}.
815 By convention the TCP port is 5900+@var{d}. Optionally, @var{host} can
816 be omitted in which case the server will accept connections from any host.
818 @item unix:@var{path}
820 Connections will be allowed over UNIX domain sockets where @var{path} is the
821 location of a unix socket to listen for connections on.
823 @item none
825 VNC is initialized but not started. The monitor @code{change} command
826 can be used to later start the VNC server.
828 @end table
830 Following the @var{display} value there may be one or more @var{option} flags
831 separated by commas. Valid options are
833 @table @option
835 @item reverse
837 Connect to a listening VNC client via a ``reverse'' connection. The
838 client is specified by the @var{display}. For reverse network
839 connections (@var{host}:@var{d},@code{reverse}), the @var{d} argument
840 is a TCP port number, not a display number.
842 @item password
844 Require that password based authentication is used for client connections.
845 The password must be set separately using the @code{change} command in the
846 @ref{pcsys_monitor}
848 @item tls
850 Require that client use TLS when communicating with the VNC server. This
851 uses anonymous TLS credentials so is susceptible to a man-in-the-middle
852 attack. It is recommended that this option be combined with either the
853 @option{x509} or @option{x509verify} options.
855 @item x509=@var{/path/to/certificate/dir}
857 Valid if @option{tls} is specified. Require that x509 credentials are used
858 for negotiating the TLS session. The server will send its x509 certificate
859 to the client. It is recommended that a password be set on the VNC server
860 to provide authentication of the client when this is used. The path following
861 this option specifies where the x509 certificates are to be loaded from.
862 See the @ref{vnc_security} section for details on generating certificates.
864 @item x509verify=@var{/path/to/certificate/dir}
866 Valid if @option{tls} is specified. Require that x509 credentials are used
867 for negotiating the TLS session. The server will send its x509 certificate
868 to the client, and request that the client send its own x509 certificate.
869 The server will validate the client's certificate against the CA certificate,
870 and reject clients when validation fails. If the certificate authority is
871 trusted, this is a sufficient authentication mechanism. You may still wish
872 to set a password on the VNC server as a second authentication layer. The
873 path following this option specifies where the x509 certificates are to
874 be loaded from. See the @ref{vnc_security} section for details on generating
875 certificates.
877 @item sasl
879 Require that the client use SASL to authenticate with the VNC server.
880 The exact choice of authentication method used is controlled from the
881 system / user's SASL configuration file for the 'qemu' service. This
882 is typically found in /etc/sasl2/qemu.conf. If running QEMU as an
883 unprivileged user, an environment variable SASL_CONF_PATH can be used
884 to make it search alternate locations for the service config.
885 While some SASL auth methods can also provide data encryption (eg GSSAPI),
886 it is recommended that SASL always be combined with the 'tls' and
887 'x509' settings to enable use of SSL and server certificates. This
888 ensures a data encryption preventing compromise of authentication
889 credentials. See the @ref{vnc_security} section for details on using
890 SASL authentication.
892 @item acl
894 Turn on access control lists for checking of the x509 client certificate
895 and SASL party. For x509 certs, the ACL check is made against the
896 certificate's distinguished name. This is something that looks like
897 @code{C=GB,O=ACME,L=Boston,CN=bob}. For SASL party, the ACL check is
898 made against the username, which depending on the SASL plugin, may
899 include a realm component, eg @code{bob} or @code{bob@@EXAMPLE.COM}.
900 When the @option{acl} flag is set, the initial access list will be
901 empty, with a @code{deny} policy. Thus no one will be allowed to
902 use the VNC server until the ACLs have been loaded. This can be
903 achieved using the @code{acl} monitor command.
905 @item lossy
907 Enable lossy compression methods (gradient, JPEG, ...). If this
908 option is set, VNC client may receive lossy framebuffer updates
909 depending on its encoding settings. Enabling this option can save
910 a lot of bandwidth at the expense of quality.
912 @end table
913 ETEXI
915 STEXI
916 @end table
917 ETEXI
919 DEFHEADING()
921 DEFHEADING(i386 target only:)
922 STEXI
923 @table @option
924 ETEXI
926 DEF("win2k-hack", 0, QEMU_OPTION_win2k_hack,
927 "-win2k-hack use it when installing Windows 2000 to avoid a disk full bug\n",
928 QEMU_ARCH_I386)
929 STEXI
930 @item -win2k-hack
931 @findex -win2k-hack
932 Use it when installing Windows 2000 to avoid a disk full bug. After
933 Windows 2000 is installed, you no longer need this option (this option
934 slows down the IDE transfers).
935 ETEXI
937 HXCOMM Deprecated by -rtc
938 DEF("rtc-td-hack", 0, QEMU_OPTION_rtc_td_hack, "", QEMU_ARCH_I386)
940 DEF("no-fd-bootchk", 0, QEMU_OPTION_no_fd_bootchk,
941 "-no-fd-bootchk disable boot signature checking for floppy disks\n",
942 QEMU_ARCH_I386)
943 STEXI
944 @item -no-fd-bootchk
945 @findex -no-fd-bootchk
946 Disable boot signature checking for floppy disks in Bochs BIOS. It may
947 be needed to boot from old floppy disks.
948 TODO: check reference to Bochs BIOS.
949 ETEXI
951 DEF("no-acpi", 0, QEMU_OPTION_no_acpi,
952 "-no-acpi disable ACPI\n", QEMU_ARCH_I386)
953 STEXI
954 @item -no-acpi
955 @findex -no-acpi
956 Disable ACPI (Advanced Configuration and Power Interface) support. Use
957 it if your guest OS complains about ACPI problems (PC target machine
958 only).
959 ETEXI
961 DEF("no-hpet", 0, QEMU_OPTION_no_hpet,
962 "-no-hpet disable HPET\n", QEMU_ARCH_I386)
963 STEXI
964 @item -no-hpet
965 @findex -no-hpet
966 Disable HPET support.
967 ETEXI
969 DEF("balloon", HAS_ARG, QEMU_OPTION_balloon,
970 "-balloon none disable balloon device\n"
971 "-balloon virtio[,addr=str]\n"
972 " enable virtio balloon device (default)\n", QEMU_ARCH_ALL)
973 STEXI
974 @item -balloon none
975 @findex -balloon
976 Disable balloon device.
977 @item -balloon virtio[,addr=@var{addr}]
978 Enable virtio balloon device (default), optionally with PCI address
979 @var{addr}.
980 ETEXI
982 DEF("acpitable", HAS_ARG, QEMU_OPTION_acpitable,
983 "-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"
984 " ACPI table description\n", QEMU_ARCH_I386)
985 STEXI
986 @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}]...]
987 @findex -acpitable
988 Add ACPI table with specified header fields and context from specified files.
989 ETEXI
991 DEF("smbios", HAS_ARG, QEMU_OPTION_smbios,
992 "-smbios file=binary\n"
993 " load SMBIOS entry from binary file\n"
994 "-smbios type=0[,vendor=str][,version=str][,date=str][,release=%d.%d]\n"
995 " specify SMBIOS type 0 fields\n"
996 "-smbios type=1[,manufacturer=str][,product=str][,version=str][,serial=str]\n"
997 " [,uuid=uuid][,sku=str][,family=str]\n"
998 " specify SMBIOS type 1 fields\n", QEMU_ARCH_I386)
999 STEXI
1000 @item -smbios file=@var{binary}
1001 @findex -smbios
1002 Load SMBIOS entry from binary file.
1004 @item -smbios type=0[,vendor=@var{str}][,version=@var{str}][,date=@var{str}][,release=@var{%d.%d}]
1005 @findex -smbios
1006 Specify SMBIOS type 0 fields
1008 @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}]
1009 Specify SMBIOS type 1 fields
1010 ETEXI
1012 DEFHEADING()
1013 STEXI
1014 @end table
1015 ETEXI
1017 DEFHEADING(Network options:)
1018 STEXI
1019 @table @option
1020 ETEXI
1022 HXCOMM Legacy slirp options (now moved to -net user):
1023 #ifdef CONFIG_SLIRP
1024 DEF("tftp", HAS_ARG, QEMU_OPTION_tftp, "", QEMU_ARCH_ALL)
1025 DEF("bootp", HAS_ARG, QEMU_OPTION_bootp, "", QEMU_ARCH_ALL)
1026 DEF("redir", HAS_ARG, QEMU_OPTION_redir, "", QEMU_ARCH_ALL)
1027 #ifndef _WIN32
1028 DEF("smb", HAS_ARG, QEMU_OPTION_smb, "", QEMU_ARCH_ALL)
1029 #endif
1030 #endif
1032 DEF("net", HAS_ARG, QEMU_OPTION_net,
1033 "-net nic[,vlan=n][,macaddr=mac][,model=type][,name=str][,addr=str][,vectors=v]\n"
1034 " create a new Network Interface Card and connect it to VLAN 'n'\n"
1035 #ifdef CONFIG_SLIRP
1036 "-net user[,vlan=n][,name=str][,net=addr[/mask]][,host=addr][,restrict=y|n]\n"
1037 " [,hostname=host][,dhcpstart=addr][,dns=addr][,tftp=dir][,bootfile=f]\n"
1038 " [,hostfwd=rule][,guestfwd=rule]"
1039 #ifndef _WIN32
1040 "[,smb=dir[,smbserver=addr]]\n"
1041 #endif
1042 " connect the user mode network stack to VLAN 'n', configure its\n"
1043 " DHCP server and enabled optional services\n"
1044 #endif
1045 #ifdef _WIN32
1046 "-net tap[,vlan=n][,name=str],ifname=name\n"
1047 " connect the host TAP network interface to VLAN 'n'\n"
1048 #else
1049 "-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"
1050 " connect the host TAP network interface to VLAN 'n' and use the\n"
1051 " network scripts 'file' (default=" DEFAULT_NETWORK_SCRIPT ")\n"
1052 " and 'dfile' (default=" DEFAULT_NETWORK_DOWN_SCRIPT ")\n"
1053 " use '[down]script=no' to disable script execution\n"
1054 " use 'fd=h' to connect to an already opened TAP interface\n"
1055 " use 'sndbuf=nbytes' to limit the size of the send buffer (the\n"
1056 " default of 'sndbuf=1048576' can be disabled using 'sndbuf=0')\n"
1057 " use vnet_hdr=off to avoid enabling the IFF_VNET_HDR tap flag\n"
1058 " use vnet_hdr=on to make the lack of IFF_VNET_HDR support an error condition\n"
1059 " use vhost=on to enable experimental in kernel accelerator\n"
1060 " use 'vhostfd=h' to connect to an already opened vhost net device\n"
1061 #endif
1062 "-net socket[,vlan=n][,name=str][,fd=h][,listen=[host]:port][,connect=host:port]\n"
1063 " connect the vlan 'n' to another VLAN using a socket connection\n"
1064 "-net socket[,vlan=n][,name=str][,fd=h][,mcast=maddr:port]\n"
1065 " connect the vlan 'n' to multicast maddr and port\n"
1066 #ifdef CONFIG_VDE
1067 "-net vde[,vlan=n][,name=str][,sock=socketpath][,port=n][,group=groupname][,mode=octalmode]\n"
1068 " connect the vlan 'n' to port 'n' of a vde switch running\n"
1069 " on host and listening for incoming connections on 'socketpath'.\n"
1070 " Use group 'groupname' and mode 'octalmode' to change default\n"
1071 " ownership and permissions for communication port.\n"
1072 #endif
1073 "-net dump[,vlan=n][,file=f][,len=n]\n"
1074 " dump traffic on vlan 'n' to file 'f' (max n bytes per packet)\n"
1075 "-net none use it alone to have zero network devices. If no -net option\n"
1076 " is provided, the default is '-net nic -net user'\n", QEMU_ARCH_ALL)
1077 DEF("netdev", HAS_ARG, QEMU_OPTION_netdev,
1078 "-netdev ["
1079 #ifdef CONFIG_SLIRP
1080 "user|"
1081 #endif
1082 "tap|"
1083 #ifdef CONFIG_VDE
1084 "vde|"
1085 #endif
1086 "socket],id=str[,option][,option][,...]\n", QEMU_ARCH_ALL)
1087 STEXI
1088 @item -net nic[,vlan=@var{n}][,macaddr=@var{mac}][,model=@var{type}] [,name=@var{name}][,addr=@var{addr}][,vectors=@var{v}]
1089 @findex -net
1090 Create a new Network Interface Card and connect it to VLAN @var{n} (@var{n}
1091 = 0 is the default). The NIC is an e1000 by default on the PC
1092 target. Optionally, the MAC address can be changed to @var{mac}, the
1093 device address set to @var{addr} (PCI cards only),
1094 and a @var{name} can be assigned for use in monitor commands.
1095 Optionally, for PCI cards, you can specify the number @var{v} of MSI-X vectors
1096 that the card should have; this option currently only affects virtio cards; set
1097 @var{v} = 0 to disable MSI-X. If no @option{-net} option is specified, a single
1098 NIC is created. Qemu can emulate several different models of network card.
1099 Valid values for @var{type} are
1100 @code{virtio}, @code{i82551}, @code{i82557b}, @code{i82559er},
1101 @code{ne2k_pci}, @code{ne2k_isa}, @code{pcnet}, @code{rtl8139},
1102 @code{e1000}, @code{smc91c111}, @code{lance} and @code{mcf_fec}.
1103 Not all devices are supported on all targets. Use -net nic,model=?
1104 for a list of available devices for your target.
1106 @item -net user[,@var{option}][,@var{option}][,...]
1107 Use the user mode network stack which requires no administrator
1108 privilege to run. Valid options are:
1110 @table @option
1111 @item vlan=@var{n}
1112 Connect user mode stack to VLAN @var{n} (@var{n} = 0 is the default).
1114 @item name=@var{name}
1115 Assign symbolic name for use in monitor commands.
1117 @item net=@var{addr}[/@var{mask}]
1118 Set IP network address the guest will see. Optionally specify the netmask,
1119 either in the form a.b.c.d or as number of valid top-most bits. Default is
1120 10.0.2.0/8.
1122 @item host=@var{addr}
1123 Specify the guest-visible address of the host. Default is the 2nd IP in the
1124 guest network, i.e. x.x.x.2.
1126 @item restrict=y|yes|n|no
1127 If this options is enabled, the guest will be isolated, i.e. it will not be
1128 able to contact the host and no guest IP packets will be routed over the host
1129 to the outside. This option does not affect explicitly set forwarding rule.
1131 @item hostname=@var{name}
1132 Specifies the client hostname reported by the builtin DHCP server.
1134 @item dhcpstart=@var{addr}
1135 Specify the first of the 16 IPs the built-in DHCP server can assign. Default
1136 is the 16th to 31st IP in the guest network, i.e. x.x.x.16 to x.x.x.31.
1138 @item dns=@var{addr}
1139 Specify the guest-visible address of the virtual nameserver. The address must
1140 be different from the host address. Default is the 3rd IP in the guest network,
1141 i.e. x.x.x.3.
1143 @item tftp=@var{dir}
1144 When using the user mode network stack, activate a built-in TFTP
1145 server. The files in @var{dir} will be exposed as the root of a TFTP server.
1146 The TFTP client on the guest must be configured in binary mode (use the command
1147 @code{bin} of the Unix TFTP client).
1149 @item bootfile=@var{file}
1150 When using the user mode network stack, broadcast @var{file} as the BOOTP
1151 filename. In conjunction with @option{tftp}, this can be used to network boot
1152 a guest from a local directory.
1154 Example (using pxelinux):
1155 @example
1156 qemu -hda linux.img -boot n -net user,tftp=/path/to/tftp/files,bootfile=/pxelinux.0
1157 @end example
1159 @item smb=@var{dir}[,smbserver=@var{addr}]
1160 When using the user mode network stack, activate a built-in SMB
1161 server so that Windows OSes can access to the host files in @file{@var{dir}}
1162 transparently. The IP address of the SMB server can be set to @var{addr}. By
1163 default the 4th IP in the guest network is used, i.e. x.x.x.4.
1165 In the guest Windows OS, the line:
1166 @example
1167 10.0.2.4 smbserver
1168 @end example
1169 must be added in the file @file{C:\WINDOWS\LMHOSTS} (for windows 9x/Me)
1170 or @file{C:\WINNT\SYSTEM32\DRIVERS\ETC\LMHOSTS} (Windows NT/2000).
1172 Then @file{@var{dir}} can be accessed in @file{\\smbserver\qemu}.
1174 Note that a SAMBA server must be installed on the host OS in
1175 @file{/usr/sbin/smbd}. QEMU was tested successfully with smbd versions from
1176 Red Hat 9, Fedora Core 3 and OpenSUSE 11.x.
1178 @item hostfwd=[tcp|udp]:[@var{hostaddr}]:@var{hostport}-[@var{guestaddr}]:@var{guestport}
1179 Redirect incoming TCP or UDP connections to the host port @var{hostport} to
1180 the guest IP address @var{guestaddr} on guest port @var{guestport}. If
1181 @var{guestaddr} is not specified, its value is x.x.x.15 (default first address
1182 given by the built-in DHCP server). By specifying @var{hostaddr}, the rule can
1183 be bound to a specific host interface. If no connection type is set, TCP is
1184 used. This option can be given multiple times.
1186 For example, to redirect host X11 connection from screen 1 to guest
1187 screen 0, use the following:
1189 @example
1190 # on the host
1191 qemu -net user,hostfwd=tcp:127.0.0.1:6001-:6000 [...]
1192 # this host xterm should open in the guest X11 server
1193 xterm -display :1
1194 @end example
1196 To redirect telnet connections from host port 5555 to telnet port on
1197 the guest, use the following:
1199 @example
1200 # on the host
1201 qemu -net user,hostfwd=tcp::5555-:23 [...]
1202 telnet localhost 5555
1203 @end example
1205 Then when you use on the host @code{telnet localhost 5555}, you
1206 connect to the guest telnet server.
1208 @item guestfwd=[tcp]:@var{server}:@var{port}-@var{dev}
1209 Forward guest TCP connections to the IP address @var{server} on port @var{port}
1210 to the character device @var{dev}. This option can be given multiple times.
1212 @end table
1214 Note: Legacy stand-alone options -tftp, -bootp, -smb and -redir are still
1215 processed and applied to -net user. Mixing them with the new configuration
1216 syntax gives undefined results. Their use for new applications is discouraged
1217 as they will be removed from future versions.
1219 @item -net tap[,vlan=@var{n}][,name=@var{name}][,fd=@var{h}][,ifname=@var{name}] [,script=@var{file}][,downscript=@var{dfile}]
1220 Connect the host TAP network interface @var{name} to VLAN @var{n}, use
1221 the network script @var{file} to configure it and the network script
1222 @var{dfile} to deconfigure it. If @var{name} is not provided, the OS
1223 automatically provides one. @option{fd}=@var{h} can be used to specify
1224 the handle of an already opened host TAP interface. The default network
1225 configure script is @file{/etc/qemu-ifup} and the default network
1226 deconfigure script is @file{/etc/qemu-ifdown}. Use @option{script=no}
1227 or @option{downscript=no} to disable script execution. Example:
1229 @example
1230 qemu linux.img -net nic -net tap
1231 @end example
1233 More complicated example (two NICs, each one connected to a TAP device)
1234 @example
1235 qemu linux.img -net nic,vlan=0 -net tap,vlan=0,ifname=tap0 \
1236 -net nic,vlan=1 -net tap,vlan=1,ifname=tap1
1237 @end example
1239 @item -net socket[,vlan=@var{n}][,name=@var{name}][,fd=@var{h}] [,listen=[@var{host}]:@var{port}][,connect=@var{host}:@var{port}]
1241 Connect the VLAN @var{n} to a remote VLAN in another QEMU virtual
1242 machine using a TCP socket connection. If @option{listen} is
1243 specified, QEMU waits for incoming connections on @var{port}
1244 (@var{host} is optional). @option{connect} is used to connect to
1245 another QEMU instance using the @option{listen} option. @option{fd}=@var{h}
1246 specifies an already opened TCP socket.
1248 Example:
1249 @example
1250 # launch a first QEMU instance
1251 qemu linux.img -net nic,macaddr=52:54:00:12:34:56 \
1252 -net socket,listen=:1234
1253 # connect the VLAN 0 of this instance to the VLAN 0
1254 # of the first instance
1255 qemu linux.img -net nic,macaddr=52:54:00:12:34:57 \
1256 -net socket,connect=127.0.0.1:1234
1257 @end example
1259 @item -net socket[,vlan=@var{n}][,name=@var{name}][,fd=@var{h}] [,mcast=@var{maddr}:@var{port}]
1261 Create a VLAN @var{n} shared with another QEMU virtual
1262 machines using a UDP multicast socket, effectively making a bus for
1263 every QEMU with same multicast address @var{maddr} and @var{port}.
1264 NOTES:
1265 @enumerate
1266 @item
1267 Several QEMU can be running on different hosts and share same bus (assuming
1268 correct multicast setup for these hosts).
1269 @item
1270 mcast support is compatible with User Mode Linux (argument @option{eth@var{N}=mcast}), see
1271 @url{http://user-mode-linux.sf.net}.
1272 @item
1273 Use @option{fd=h} to specify an already opened UDP multicast socket.
1274 @end enumerate
1276 Example:
1277 @example
1278 # launch one QEMU instance
1279 qemu linux.img -net nic,macaddr=52:54:00:12:34:56 \
1280 -net socket,mcast=230.0.0.1:1234
1281 # launch another QEMU instance on same "bus"
1282 qemu linux.img -net nic,macaddr=52:54:00:12:34:57 \
1283 -net socket,mcast=230.0.0.1:1234
1284 # launch yet another QEMU instance on same "bus"
1285 qemu linux.img -net nic,macaddr=52:54:00:12:34:58 \
1286 -net socket,mcast=230.0.0.1:1234
1287 @end example
1289 Example (User Mode Linux compat.):
1290 @example
1291 # launch QEMU instance (note mcast address selected
1292 # is UML's default)
1293 qemu linux.img -net nic,macaddr=52:54:00:12:34:56 \
1294 -net socket,mcast=239.192.168.1:1102
1295 # launch UML
1296 /path/to/linux ubd0=/path/to/root_fs eth0=mcast
1297 @end example
1299 @item -net vde[,vlan=@var{n}][,name=@var{name}][,sock=@var{socketpath}] [,port=@var{n}][,group=@var{groupname}][,mode=@var{octalmode}]
1300 Connect VLAN @var{n} to PORT @var{n} of a vde switch running on host and
1301 listening for incoming connections on @var{socketpath}. Use GROUP @var{groupname}
1302 and MODE @var{octalmode} to change default ownership and permissions for
1303 communication port. This option is available only if QEMU has been compiled
1304 with vde support enabled.
1306 Example:
1307 @example
1308 # launch vde switch
1309 vde_switch -F -sock /tmp/myswitch
1310 # launch QEMU instance
1311 qemu linux.img -net nic -net vde,sock=/tmp/myswitch
1312 @end example
1314 @item -net dump[,vlan=@var{n}][,file=@var{file}][,len=@var{len}]
1315 Dump network traffic on VLAN @var{n} to file @var{file} (@file{qemu-vlan0.pcap} by default).
1316 At most @var{len} bytes (64k by default) per packet are stored. The file format is
1317 libpcap, so it can be analyzed with tools such as tcpdump or Wireshark.
1319 @item -net none
1320 Indicate that no network devices should be configured. It is used to
1321 override the default configuration (@option{-net nic -net user}) which
1322 is activated if no @option{-net} options are provided.
1324 @end table
1325 ETEXI
1327 DEFHEADING()
1329 DEFHEADING(Character device options:)
1331 DEF("chardev", HAS_ARG, QEMU_OPTION_chardev,
1332 "-chardev null,id=id[,mux=on|off]\n"
1333 "-chardev socket,id=id[,host=host],port=host[,to=to][,ipv4][,ipv6][,nodelay]\n"
1334 " [,server][,nowait][,telnet][,mux=on|off] (tcp)\n"
1335 "-chardev socket,id=id,path=path[,server][,nowait][,telnet],[mux=on|off] (unix)\n"
1336 "-chardev udp,id=id[,host=host],port=port[,localaddr=localaddr]\n"
1337 " [,localport=localport][,ipv4][,ipv6][,mux=on|off]\n"
1338 "-chardev msmouse,id=id[,mux=on|off]\n"
1339 "-chardev vc,id=id[[,width=width][,height=height]][[,cols=cols][,rows=rows]]\n"
1340 " [,mux=on|off]\n"
1341 "-chardev file,id=id,path=path[,mux=on|off]\n"
1342 "-chardev pipe,id=id,path=path[,mux=on|off]\n"
1343 #ifdef _WIN32
1344 "-chardev console,id=id[,mux=on|off]\n"
1345 "-chardev serial,id=id,path=path[,mux=on|off]\n"
1346 #else
1347 "-chardev pty,id=id[,mux=on|off]\n"
1348 "-chardev stdio,id=id[,mux=on|off][,signal=on|off]\n"
1349 #endif
1350 #ifdef CONFIG_BRLAPI
1351 "-chardev braille,id=id[,mux=on|off]\n"
1352 #endif
1353 #if defined(__linux__) || defined(__sun__) || defined(__FreeBSD__) \
1354 || defined(__NetBSD__) || defined(__OpenBSD__) || defined(__DragonFly__)
1355 "-chardev tty,id=id,path=path[,mux=on|off]\n"
1356 #endif
1357 #if defined(__linux__) || defined(__FreeBSD__) || defined(__DragonFly__)
1358 "-chardev parport,id=id,path=path[,mux=on|off]\n"
1359 #endif
1360 , QEMU_ARCH_ALL
1363 STEXI
1365 The general form of a character device option is:
1366 @table @option
1368 @item -chardev @var{backend} ,id=@var{id} [,mux=on|off] [,@var{options}]
1369 @findex -chardev
1370 Backend is one of:
1371 @option{null},
1372 @option{socket},
1373 @option{udp},
1374 @option{msmouse},
1375 @option{vc},
1376 @option{file},
1377 @option{pipe},
1378 @option{console},
1379 @option{serial},
1380 @option{pty},
1381 @option{stdio},
1382 @option{braille},
1383 @option{tty},
1384 @option{parport}.
1385 The specific backend will determine the applicable options.
1387 All devices must have an id, which can be any string up to 127 characters long.
1388 It is used to uniquely identify this device in other command line directives.
1390 A character device may be used in multiplexing mode by multiple front-ends.
1391 The key sequence of @key{Control-a} and @key{c} will rotate the input focus
1392 between attached front-ends. Specify @option{mux=on} to enable this mode.
1394 Options to each backend are described below.
1396 @item -chardev null ,id=@var{id}
1397 A void device. This device will not emit any data, and will drop any data it
1398 receives. The null backend does not take any options.
1400 @item -chardev socket ,id=@var{id} [@var{TCP options} or @var{unix options}] [,server] [,nowait] [,telnet]
1402 Create a two-way stream socket, which can be either a TCP or a unix socket. A
1403 unix socket will be created if @option{path} is specified. Behaviour is
1404 undefined if TCP options are specified for a unix socket.
1406 @option{server} specifies that the socket shall be a listening socket.
1408 @option{nowait} specifies that QEMU should not block waiting for a client to
1409 connect to a listening socket.
1411 @option{telnet} specifies that traffic on the socket should interpret telnet
1412 escape sequences.
1414 TCP and unix socket options are given below:
1416 @table @option
1418 @item TCP options: port=@var{port} [,host=@var{host}] [,to=@var{to}] [,ipv4] [,ipv6] [,nodelay]
1420 @option{host} for a listening socket specifies the local address to be bound.
1421 For a connecting socket species the remote host to connect to. @option{host} is
1422 optional for listening sockets. If not specified it defaults to @code{0.0.0.0}.
1424 @option{port} for a listening socket specifies the local port to be bound. For a
1425 connecting socket specifies the port on the remote host to connect to.
1426 @option{port} can be given as either a port number or a service name.
1427 @option{port} is required.
1429 @option{to} is only relevant to listening sockets. If it is specified, and
1430 @option{port} cannot be bound, QEMU will attempt to bind to subsequent ports up
1431 to and including @option{to} until it succeeds. @option{to} must be specified
1432 as a port number.
1434 @option{ipv4} and @option{ipv6} specify that either IPv4 or IPv6 must be used.
1435 If neither is specified the socket may use either protocol.
1437 @option{nodelay} disables the Nagle algorithm.
1439 @item unix options: path=@var{path}
1441 @option{path} specifies the local path of the unix socket. @option{path} is
1442 required.
1444 @end table
1446 @item -chardev udp ,id=@var{id} [,host=@var{host}] ,port=@var{port} [,localaddr=@var{localaddr}] [,localport=@var{localport}] [,ipv4] [,ipv6]
1448 Sends all traffic from the guest to a remote host over UDP.
1450 @option{host} specifies the remote host to connect to. If not specified it
1451 defaults to @code{localhost}.
1453 @option{port} specifies the port on the remote host to connect to. @option{port}
1454 is required.
1456 @option{localaddr} specifies the local address to bind to. If not specified it
1457 defaults to @code{0.0.0.0}.
1459 @option{localport} specifies the local port to bind to. If not specified any
1460 available local port will be used.
1462 @option{ipv4} and @option{ipv6} specify that either IPv4 or IPv6 must be used.
1463 If neither is specified the device may use either protocol.
1465 @item -chardev msmouse ,id=@var{id}
1467 Forward QEMU's emulated msmouse events to the guest. @option{msmouse} does not
1468 take any options.
1470 @item -chardev vc ,id=@var{id} [[,width=@var{width}] [,height=@var{height}]] [[,cols=@var{cols}] [,rows=@var{rows}]]
1472 Connect to a QEMU text console. @option{vc} may optionally be given a specific
1473 size.
1475 @option{width} and @option{height} specify the width and height respectively of
1476 the console, in pixels.
1478 @option{cols} and @option{rows} specify that the console be sized to fit a text
1479 console with the given dimensions.
1481 @item -chardev file ,id=@var{id} ,path=@var{path}
1483 Log all traffic received from the guest to a file.
1485 @option{path} specifies the path of the file to be opened. This file will be
1486 created if it does not already exist, and overwritten if it does. @option{path}
1487 is required.
1489 @item -chardev pipe ,id=@var{id} ,path=@var{path}
1491 Create a two-way connection to the guest. The behaviour differs slightly between
1492 Windows hosts and other hosts:
1494 On Windows, a single duplex pipe will be created at
1495 @file{\\.pipe\@option{path}}.
1497 On other hosts, 2 pipes will be created called @file{@option{path}.in} and
1498 @file{@option{path}.out}. Data written to @file{@option{path}.in} will be
1499 received by the guest. Data written by the guest can be read from
1500 @file{@option{path}.out}. QEMU will not create these fifos, and requires them to
1501 be present.
1503 @option{path} forms part of the pipe path as described above. @option{path} is
1504 required.
1506 @item -chardev console ,id=@var{id}
1508 Send traffic from the guest to QEMU's standard output. @option{console} does not
1509 take any options.
1511 @option{console} is only available on Windows hosts.
1513 @item -chardev serial ,id=@var{id} ,path=@option{path}
1515 Send traffic from the guest to a serial device on the host.
1517 @option{serial} is
1518 only available on Windows hosts.
1520 @option{path} specifies the name of the serial device to open.
1522 @item -chardev pty ,id=@var{id}
1524 Create a new pseudo-terminal on the host and connect to it. @option{pty} does
1525 not take any options.
1527 @option{pty} is not available on Windows hosts.
1529 @item -chardev stdio ,id=@var{id} [,signal=on|off]
1530 Connect to standard input and standard output of the qemu process.
1532 @option{signal} controls if signals are enabled on the terminal, that includes
1533 exiting QEMU with the key sequence @key{Control-c}. This option is enabled by
1534 default, use @option{signal=off} to disable it.
1536 @option{stdio} is not available on Windows hosts.
1538 @item -chardev braille ,id=@var{id}
1540 Connect to a local BrlAPI server. @option{braille} does not take any options.
1542 @item -chardev tty ,id=@var{id} ,path=@var{path}
1544 Connect to a local tty device.
1546 @option{tty} is only available on Linux, Sun, FreeBSD, NetBSD, OpenBSD and
1547 DragonFlyBSD hosts.
1549 @option{path} specifies the path to the tty. @option{path} is required.
1551 @item -chardev parport ,id=@var{id} ,path=@var{path}
1553 @option{parport} is only available on Linux, FreeBSD and DragonFlyBSD hosts.
1555 Connect to a local parallel port.
1557 @option{path} specifies the path to the parallel port device. @option{path} is
1558 required.
1560 @end table
1561 ETEXI
1563 DEFHEADING()
1565 DEFHEADING(Bluetooth(R) options:)
1567 DEF("bt", HAS_ARG, QEMU_OPTION_bt, \
1568 "-bt hci,null dumb bluetooth HCI - doesn't respond to commands\n" \
1569 "-bt hci,host[:id]\n" \
1570 " use host's HCI with the given name\n" \
1571 "-bt hci[,vlan=n]\n" \
1572 " emulate a standard HCI in virtual scatternet 'n'\n" \
1573 "-bt vhci[,vlan=n]\n" \
1574 " add host computer to virtual scatternet 'n' using VHCI\n" \
1575 "-bt device:dev[,vlan=n]\n" \
1576 " emulate a bluetooth device 'dev' in scatternet 'n'\n",
1577 QEMU_ARCH_ALL)
1578 STEXI
1579 @table @option
1581 @item -bt hci[...]
1582 @findex -bt
1583 Defines the function of the corresponding Bluetooth HCI. -bt options
1584 are matched with the HCIs present in the chosen machine type. For
1585 example when emulating a machine with only one HCI built into it, only
1586 the first @code{-bt hci[...]} option is valid and defines the HCI's
1587 logic. The Transport Layer is decided by the machine type. Currently
1588 the machines @code{n800} and @code{n810} have one HCI and all other
1589 machines have none.
1591 @anchor{bt-hcis}
1592 The following three types are recognized:
1594 @table @option
1595 @item -bt hci,null
1596 (default) The corresponding Bluetooth HCI assumes no internal logic
1597 and will not respond to any HCI commands or emit events.
1599 @item -bt hci,host[:@var{id}]
1600 (@code{bluez} only) The corresponding HCI passes commands / events
1601 to / from the physical HCI identified by the name @var{id} (default:
1602 @code{hci0}) on the computer running QEMU. Only available on @code{bluez}
1603 capable systems like Linux.
1605 @item -bt hci[,vlan=@var{n}]
1606 Add a virtual, standard HCI that will participate in the Bluetooth
1607 scatternet @var{n} (default @code{0}). Similarly to @option{-net}
1608 VLANs, devices inside a bluetooth network @var{n} can only communicate
1609 with other devices in the same network (scatternet).
1610 @end table
1612 @item -bt vhci[,vlan=@var{n}]
1613 (Linux-host only) Create a HCI in scatternet @var{n} (default 0) attached
1614 to the host bluetooth stack instead of to the emulated target. This
1615 allows the host and target machines to participate in a common scatternet
1616 and communicate. Requires the Linux @code{vhci} driver installed. Can
1617 be used as following:
1619 @example
1620 qemu [...OPTIONS...] -bt hci,vlan=5 -bt vhci,vlan=5
1621 @end example
1623 @item -bt device:@var{dev}[,vlan=@var{n}]
1624 Emulate a bluetooth device @var{dev} and place it in network @var{n}
1625 (default @code{0}). QEMU can only emulate one type of bluetooth devices
1626 currently:
1628 @table @option
1629 @item keyboard
1630 Virtual wireless keyboard implementing the HIDP bluetooth profile.
1631 @end table
1632 @end table
1633 ETEXI
1635 DEFHEADING()
1637 DEFHEADING(Linux/Multiboot boot specific:)
1638 STEXI
1640 When using these options, you can use a given Linux or Multiboot
1641 kernel without installing it in the disk image. It can be useful
1642 for easier testing of various kernels.
1644 @table @option
1645 ETEXI
1647 DEF("kernel", HAS_ARG, QEMU_OPTION_kernel, \
1648 "-kernel bzImage use 'bzImage' as kernel image\n", QEMU_ARCH_ALL)
1649 STEXI
1650 @item -kernel @var{bzImage}
1651 @findex -kernel
1652 Use @var{bzImage} as kernel image. The kernel can be either a Linux kernel
1653 or in multiboot format.
1654 ETEXI
1656 DEF("append", HAS_ARG, QEMU_OPTION_append, \
1657 "-append cmdline use 'cmdline' as kernel command line\n", QEMU_ARCH_ALL)
1658 STEXI
1659 @item -append @var{cmdline}
1660 @findex -append
1661 Use @var{cmdline} as kernel command line
1662 ETEXI
1664 DEF("initrd", HAS_ARG, QEMU_OPTION_initrd, \
1665 "-initrd file use 'file' as initial ram disk\n", QEMU_ARCH_ALL)
1666 STEXI
1667 @item -initrd @var{file}
1668 @findex -initrd
1669 Use @var{file} as initial ram disk.
1671 @item -initrd "@var{file1} arg=foo,@var{file2}"
1673 This syntax is only available with multiboot.
1675 Use @var{file1} and @var{file2} as modules and pass arg=foo as parameter to the
1676 first module.
1677 ETEXI
1679 STEXI
1680 @end table
1681 ETEXI
1683 DEFHEADING()
1685 DEFHEADING(Debug/Expert options:)
1687 STEXI
1688 @table @option
1689 ETEXI
1691 DEF("serial", HAS_ARG, QEMU_OPTION_serial, \
1692 "-serial dev redirect the serial port to char device 'dev'\n",
1693 QEMU_ARCH_ALL)
1694 STEXI
1695 @item -serial @var{dev}
1696 @findex -serial
1697 Redirect the virtual serial port to host character device
1698 @var{dev}. The default device is @code{vc} in graphical mode and
1699 @code{stdio} in non graphical mode.
1701 This option can be used several times to simulate up to 4 serial
1702 ports.
1704 Use @code{-serial none} to disable all serial ports.
1706 Available character devices are:
1707 @table @option
1708 @item vc[:@var{W}x@var{H}]
1709 Virtual console. Optionally, a width and height can be given in pixel with
1710 @example
1711 vc:800x600
1712 @end example
1713 It is also possible to specify width or height in characters:
1714 @example
1715 vc:80Cx24C
1716 @end example
1717 @item pty
1718 [Linux only] Pseudo TTY (a new PTY is automatically allocated)
1719 @item none
1720 No device is allocated.
1721 @item null
1722 void device
1723 @item /dev/XXX
1724 [Linux only] Use host tty, e.g. @file{/dev/ttyS0}. The host serial port
1725 parameters are set according to the emulated ones.
1726 @item /dev/parport@var{N}
1727 [Linux only, parallel port only] Use host parallel port
1728 @var{N}. Currently SPP and EPP parallel port features can be used.
1729 @item file:@var{filename}
1730 Write output to @var{filename}. No character can be read.
1731 @item stdio
1732 [Unix only] standard input/output
1733 @item pipe:@var{filename}
1734 name pipe @var{filename}
1735 @item COM@var{n}
1736 [Windows only] Use host serial port @var{n}
1737 @item udp:[@var{remote_host}]:@var{remote_port}[@@[@var{src_ip}]:@var{src_port}]
1738 This implements UDP Net Console.
1739 When @var{remote_host} or @var{src_ip} are not specified
1740 they default to @code{0.0.0.0}.
1741 When not using a specified @var{src_port} a random port is automatically chosen.
1743 If you just want a simple readonly console you can use @code{netcat} or
1744 @code{nc}, by starting qemu with: @code{-serial udp::4555} and nc as:
1745 @code{nc -u -l -p 4555}. Any time qemu writes something to that port it
1746 will appear in the netconsole session.
1748 If you plan to send characters back via netconsole or you want to stop
1749 and start qemu a lot of times, you should have qemu use the same
1750 source port each time by using something like @code{-serial
1751 udp::4555@@:4556} to qemu. Another approach is to use a patched
1752 version of netcat which can listen to a TCP port and send and receive
1753 characters via udp. If you have a patched version of netcat which
1754 activates telnet remote echo and single char transfer, then you can
1755 use the following options to step up a netcat redirector to allow
1756 telnet on port 5555 to access the qemu port.
1757 @table @code
1758 @item Qemu Options:
1759 -serial udp::4555@@:4556
1760 @item netcat options:
1761 -u -P 4555 -L 0.0.0.0:4556 -t -p 5555 -I -T
1762 @item telnet options:
1763 localhost 5555
1764 @end table
1766 @item tcp:[@var{host}]:@var{port}[,@var{server}][,nowait][,nodelay]
1767 The TCP Net Console has two modes of operation. It can send the serial
1768 I/O to a location or wait for a connection from a location. By default
1769 the TCP Net Console is sent to @var{host} at the @var{port}. If you use
1770 the @var{server} option QEMU will wait for a client socket application
1771 to connect to the port before continuing, unless the @code{nowait}
1772 option was specified. The @code{nodelay} option disables the Nagle buffering
1773 algorithm. If @var{host} is omitted, 0.0.0.0 is assumed. Only
1774 one TCP connection at a time is accepted. You can use @code{telnet} to
1775 connect to the corresponding character device.
1776 @table @code
1777 @item Example to send tcp console to 192.168.0.2 port 4444
1778 -serial tcp:192.168.0.2:4444
1779 @item Example to listen and wait on port 4444 for connection
1780 -serial tcp::4444,server
1781 @item Example to not wait and listen on ip 192.168.0.100 port 4444
1782 -serial tcp:192.168.0.100:4444,server,nowait
1783 @end table
1785 @item telnet:@var{host}:@var{port}[,server][,nowait][,nodelay]
1786 The telnet protocol is used instead of raw tcp sockets. The options
1787 work the same as if you had specified @code{-serial tcp}. The
1788 difference is that the port acts like a telnet server or client using
1789 telnet option negotiation. This will also allow you to send the
1790 MAGIC_SYSRQ sequence if you use a telnet that supports sending the break
1791 sequence. Typically in unix telnet you do it with Control-] and then
1792 type "send break" followed by pressing the enter key.
1794 @item unix:@var{path}[,server][,nowait]
1795 A unix domain socket is used instead of a tcp socket. The option works the
1796 same as if you had specified @code{-serial tcp} except the unix domain socket
1797 @var{path} is used for connections.
1799 @item mon:@var{dev_string}
1800 This is a special option to allow the monitor to be multiplexed onto
1801 another serial port. The monitor is accessed with key sequence of
1802 @key{Control-a} and then pressing @key{c}. See monitor access
1803 @ref{pcsys_keys} in the -nographic section for more keys.
1804 @var{dev_string} should be any one of the serial devices specified
1805 above. An example to multiplex the monitor onto a telnet server
1806 listening on port 4444 would be:
1807 @table @code
1808 @item -serial mon:telnet::4444,server,nowait
1809 @end table
1811 @item braille
1812 Braille device. This will use BrlAPI to display the braille output on a real
1813 or fake device.
1815 @item msmouse
1816 Three button serial mouse. Configure the guest to use Microsoft protocol.
1817 @end table
1818 ETEXI
1820 DEF("parallel", HAS_ARG, QEMU_OPTION_parallel, \
1821 "-parallel dev redirect the parallel port to char device 'dev'\n",
1822 QEMU_ARCH_ALL)
1823 STEXI
1824 @item -parallel @var{dev}
1825 @findex -parallel
1826 Redirect the virtual parallel port to host device @var{dev} (same
1827 devices as the serial port). On Linux hosts, @file{/dev/parportN} can
1828 be used to use hardware devices connected on the corresponding host
1829 parallel port.
1831 This option can be used several times to simulate up to 3 parallel
1832 ports.
1834 Use @code{-parallel none} to disable all parallel ports.
1835 ETEXI
1837 DEF("monitor", HAS_ARG, QEMU_OPTION_monitor, \
1838 "-monitor dev redirect the monitor to char device 'dev'\n",
1839 QEMU_ARCH_ALL)
1840 STEXI
1841 @item -monitor @var{dev}
1842 @findex -monitor
1843 Redirect the monitor to host device @var{dev} (same devices as the
1844 serial port).
1845 The default device is @code{vc} in graphical mode and @code{stdio} in
1846 non graphical mode.
1847 ETEXI
1848 DEF("qmp", HAS_ARG, QEMU_OPTION_qmp, \
1849 "-qmp dev like -monitor but opens in 'control' mode\n",
1850 QEMU_ARCH_ALL)
1851 STEXI
1852 @item -qmp @var{dev}
1853 @findex -qmp
1854 Like -monitor but opens in 'control' mode.
1855 ETEXI
1857 DEF("mon", HAS_ARG, QEMU_OPTION_mon, \
1858 "-mon chardev=[name][,mode=readline|control][,default]\n", QEMU_ARCH_ALL)
1859 STEXI
1860 @item -mon chardev=[name][,mode=readline|control][,default]
1861 @findex -mon
1862 Setup monitor on chardev @var{name}.
1863 ETEXI
1865 DEF("debugcon", HAS_ARG, QEMU_OPTION_debugcon, \
1866 "-debugcon dev redirect the debug console to char device 'dev'\n",
1867 QEMU_ARCH_ALL)
1868 STEXI
1869 @item -debugcon @var{dev}
1870 @findex -debugcon
1871 Redirect the debug console to host device @var{dev} (same devices as the
1872 serial port). The debug console is an I/O port which is typically port
1873 0xe9; writing to that I/O port sends output to this device.
1874 The default device is @code{vc} in graphical mode and @code{stdio} in
1875 non graphical mode.
1876 ETEXI
1878 DEF("pidfile", HAS_ARG, QEMU_OPTION_pidfile, \
1879 "-pidfile file write PID to 'file'\n", QEMU_ARCH_ALL)
1880 STEXI
1881 @item -pidfile @var{file}
1882 @findex -pidfile
1883 Store the QEMU process PID in @var{file}. It is useful if you launch QEMU
1884 from a script.
1885 ETEXI
1887 DEF("singlestep", 0, QEMU_OPTION_singlestep, \
1888 "-singlestep always run in singlestep mode\n", QEMU_ARCH_ALL)
1889 STEXI
1890 @item -singlestep
1891 @findex -singlestep
1892 Run the emulation in single step mode.
1893 ETEXI
1895 DEF("S", 0, QEMU_OPTION_S, \
1896 "-S freeze CPU at startup (use 'c' to start execution)\n",
1897 QEMU_ARCH_ALL)
1898 STEXI
1899 @item -S
1900 @findex -S
1901 Do not start CPU at startup (you must type 'c' in the monitor).
1902 ETEXI
1904 DEF("gdb", HAS_ARG, QEMU_OPTION_gdb, \
1905 "-gdb dev wait for gdb connection on 'dev'\n", QEMU_ARCH_ALL)
1906 STEXI
1907 @item -gdb @var{dev}
1908 @findex -gdb
1909 Wait for gdb connection on device @var{dev} (@pxref{gdb_usage}). Typical
1910 connections will likely be TCP-based, but also UDP, pseudo TTY, or even
1911 stdio are reasonable use case. The latter is allowing to start qemu from
1912 within gdb and establish the connection via a pipe:
1913 @example
1914 (gdb) target remote | exec qemu -gdb stdio ...
1915 @end example
1916 ETEXI
1918 DEF("s", 0, QEMU_OPTION_s, \
1919 "-s shorthand for -gdb tcp::" DEFAULT_GDBSTUB_PORT "\n",
1920 QEMU_ARCH_ALL)
1921 STEXI
1922 @item -s
1923 @findex -s
1924 Shorthand for -gdb tcp::1234, i.e. open a gdbserver on TCP port 1234
1925 (@pxref{gdb_usage}).
1926 ETEXI
1928 DEF("d", HAS_ARG, QEMU_OPTION_d, \
1929 "-d item1,... output log to /tmp/qemu.log (use -d ? for a list of log items)\n",
1930 QEMU_ARCH_ALL)
1931 STEXI
1932 @item -d
1933 @findex -d
1934 Output log in /tmp/qemu.log
1935 ETEXI
1937 DEF("hdachs", HAS_ARG, QEMU_OPTION_hdachs, \
1938 "-hdachs c,h,s[,t]\n" \
1939 " force hard disk 0 physical geometry and the optional BIOS\n" \
1940 " translation (t=none or lba) (usually qemu can guess them)\n",
1941 QEMU_ARCH_ALL)
1942 STEXI
1943 @item -hdachs @var{c},@var{h},@var{s},[,@var{t}]
1944 @findex -hdachs
1945 Force hard disk 0 physical geometry (1 <= @var{c} <= 16383, 1 <=
1946 @var{h} <= 16, 1 <= @var{s} <= 63) and optionally force the BIOS
1947 translation mode (@var{t}=none, lba or auto). Usually QEMU can guess
1948 all those parameters. This option is useful for old MS-DOS disk
1949 images.
1950 ETEXI
1952 DEF("L", HAS_ARG, QEMU_OPTION_L, \
1953 "-L path set the directory for the BIOS, VGA BIOS and keymaps\n",
1954 QEMU_ARCH_ALL)
1955 STEXI
1956 @item -L @var{path}
1957 @findex -L
1958 Set the directory for the BIOS, VGA BIOS and keymaps.
1959 ETEXI
1961 DEF("bios", HAS_ARG, QEMU_OPTION_bios, \
1962 "-bios file set the filename for the BIOS\n", QEMU_ARCH_ALL)
1963 STEXI
1964 @item -bios @var{file}
1965 @findex -bios
1966 Set the filename for the BIOS.
1967 ETEXI
1969 DEF("enable-kvm", 0, QEMU_OPTION_enable_kvm, \
1970 "-enable-kvm enable KVM full virtualization support\n", QEMU_ARCH_ALL)
1971 STEXI
1972 @item -enable-kvm
1973 @findex -enable-kvm
1974 Enable KVM full virtualization support. This option is only available
1975 if KVM support is enabled when compiling.
1976 ETEXI
1978 DEF("xen-domid", HAS_ARG, QEMU_OPTION_xen_domid,
1979 "-xen-domid id specify xen guest domain id\n", QEMU_ARCH_ALL)
1980 DEF("xen-create", 0, QEMU_OPTION_xen_create,
1981 "-xen-create create domain using xen hypercalls, bypassing xend\n"
1982 " warning: should not be used when xend is in use\n",
1983 QEMU_ARCH_ALL)
1984 DEF("xen-attach", 0, QEMU_OPTION_xen_attach,
1985 "-xen-attach attach to existing xen domain\n"
1986 " xend will use this when starting qemu\n",
1987 QEMU_ARCH_ALL)
1988 STEXI
1989 @item -xen-domid @var{id}
1990 @findex -xen-domid
1991 Specify xen guest domain @var{id} (XEN only).
1992 @item -xen-create
1993 @findex -xen-create
1994 Create domain using xen hypercalls, bypassing xend.
1995 Warning: should not be used when xend is in use (XEN only).
1996 @item -xen-attach
1997 @findex -xen-attach
1998 Attach to existing xen domain.
1999 xend will use this when starting qemu (XEN only).
2000 ETEXI
2002 DEF("no-reboot", 0, QEMU_OPTION_no_reboot, \
2003 "-no-reboot exit instead of rebooting\n", QEMU_ARCH_ALL)
2004 STEXI
2005 @item -no-reboot
2006 @findex -no-reboot
2007 Exit instead of rebooting.
2008 ETEXI
2010 DEF("no-shutdown", 0, QEMU_OPTION_no_shutdown, \
2011 "-no-shutdown stop before shutdown\n", QEMU_ARCH_ALL)
2012 STEXI
2013 @item -no-shutdown
2014 @findex -no-shutdown
2015 Don't exit QEMU on guest shutdown, but instead only stop the emulation.
2016 This allows for instance switching to monitor to commit changes to the
2017 disk image.
2018 ETEXI
2020 DEF("loadvm", HAS_ARG, QEMU_OPTION_loadvm, \
2021 "-loadvm [tag|id]\n" \
2022 " start right away with a saved state (loadvm in monitor)\n",
2023 QEMU_ARCH_ALL)
2024 STEXI
2025 @item -loadvm @var{file}
2026 @findex -loadvm
2027 Start right away with a saved state (@code{loadvm} in monitor)
2028 ETEXI
2030 #ifndef _WIN32
2031 DEF("daemonize", 0, QEMU_OPTION_daemonize, \
2032 "-daemonize daemonize QEMU after initializing\n", QEMU_ARCH_ALL)
2033 #endif
2034 STEXI
2035 @item -daemonize
2036 @findex -daemonize
2037 Daemonize the QEMU process after initialization. QEMU will not detach from
2038 standard IO until it is ready to receive connections on any of its devices.
2039 This option is a useful way for external programs to launch QEMU without having
2040 to cope with initialization race conditions.
2041 ETEXI
2043 DEF("option-rom", HAS_ARG, QEMU_OPTION_option_rom, \
2044 "-option-rom rom load a file, rom, into the option ROM space\n",
2045 QEMU_ARCH_ALL)
2046 STEXI
2047 @item -option-rom @var{file}
2048 @findex -option-rom
2049 Load the contents of @var{file} as an option ROM.
2050 This option is useful to load things like EtherBoot.
2051 ETEXI
2053 DEF("clock", HAS_ARG, QEMU_OPTION_clock, \
2054 "-clock force the use of the given methods for timer alarm.\n" \
2055 " To see what timers are available use -clock ?\n",
2056 QEMU_ARCH_ALL)
2057 STEXI
2058 @item -clock @var{method}
2059 @findex -clock
2060 Force the use of the given methods for timer alarm. To see what timers
2061 are available use -clock ?.
2062 ETEXI
2064 HXCOMM Options deprecated by -rtc
2065 DEF("localtime", 0, QEMU_OPTION_localtime, "", QEMU_ARCH_ALL)
2066 DEF("startdate", HAS_ARG, QEMU_OPTION_startdate, "", QEMU_ARCH_ALL)
2068 DEF("rtc", HAS_ARG, QEMU_OPTION_rtc, \
2069 "-rtc [base=utc|localtime|date][,clock=host|vm][,driftfix=none|slew]\n" \
2070 " set the RTC base and clock, enable drift fix for clock ticks (x86 only)\n",
2071 QEMU_ARCH_ALL)
2073 STEXI
2075 @item -rtc [base=utc|localtime|@var{date}][,clock=host|vm][,driftfix=none|slew]
2076 @findex -rtc
2077 Specify @option{base} as @code{utc} or @code{localtime} to let the RTC start at the current
2078 UTC or local time, respectively. @code{localtime} is required for correct date in
2079 MS-DOS or Windows. To start at a specific point in time, provide @var{date} in the
2080 format @code{2006-06-17T16:01:21} or @code{2006-06-17}. The default base is UTC.
2082 By default the RTC is driven by the host system time. This allows to use the
2083 RTC as accurate reference clock inside the guest, specifically if the host
2084 time is smoothly following an accurate external reference clock, e.g. via NTP.
2085 If you want to isolate the guest time from the host, even prevent it from
2086 progressing during suspension, you can set @option{clock} to @code{vm} instead.
2088 Enable @option{driftfix} (i386 targets only) if you experience time drift problems,
2089 specifically with Windows' ACPI HAL. This option will try to figure out how
2090 many timer interrupts were not processed by the Windows guest and will
2091 re-inject them.
2092 ETEXI
2094 DEF("icount", HAS_ARG, QEMU_OPTION_icount, \
2095 "-icount [N|auto]\n" \
2096 " enable virtual instruction counter with 2^N clock ticks per\n" \
2097 " instruction\n", QEMU_ARCH_ALL)
2098 STEXI
2099 @item -icount [@var{N}|auto]
2100 @findex -icount
2101 Enable virtual instruction counter. The virtual cpu will execute one
2102 instruction every 2^@var{N} ns of virtual time. If @code{auto} is specified
2103 then the virtual cpu speed will be automatically adjusted to keep virtual
2104 time within a few seconds of real time.
2106 Note that while this option can give deterministic behavior, it does not
2107 provide cycle accurate emulation. Modern CPUs contain superscalar out of
2108 order cores with complex cache hierarchies. The number of instructions
2109 executed often has little or no correlation with actual performance.
2110 ETEXI
2112 DEF("watchdog", HAS_ARG, QEMU_OPTION_watchdog, \
2113 "-watchdog i6300esb|ib700\n" \
2114 " enable virtual hardware watchdog [default=none]\n",
2115 QEMU_ARCH_ALL)
2116 STEXI
2117 @item -watchdog @var{model}
2118 @findex -watchdog
2119 Create a virtual hardware watchdog device. Once enabled (by a guest
2120 action), the watchdog must be periodically polled by an agent inside
2121 the guest or else the guest will be restarted.
2123 The @var{model} is the model of hardware watchdog to emulate. Choices
2124 for model are: @code{ib700} (iBASE 700) which is a very simple ISA
2125 watchdog with a single timer, or @code{i6300esb} (Intel 6300ESB I/O
2126 controller hub) which is a much more featureful PCI-based dual-timer
2127 watchdog. Choose a model for which your guest has drivers.
2129 Use @code{-watchdog ?} to list available hardware models. Only one
2130 watchdog can be enabled for a guest.
2131 ETEXI
2133 DEF("watchdog-action", HAS_ARG, QEMU_OPTION_watchdog_action, \
2134 "-watchdog-action reset|shutdown|poweroff|pause|debug|none\n" \
2135 " action when watchdog fires [default=reset]\n",
2136 QEMU_ARCH_ALL)
2137 STEXI
2138 @item -watchdog-action @var{action}
2140 The @var{action} controls what QEMU will do when the watchdog timer
2141 expires.
2142 The default is
2143 @code{reset} (forcefully reset the guest).
2144 Other possible actions are:
2145 @code{shutdown} (attempt to gracefully shutdown the guest),
2146 @code{poweroff} (forcefully poweroff the guest),
2147 @code{pause} (pause the guest),
2148 @code{debug} (print a debug message and continue), or
2149 @code{none} (do nothing).
2151 Note that the @code{shutdown} action requires that the guest responds
2152 to ACPI signals, which it may not be able to do in the sort of
2153 situations where the watchdog would have expired, and thus
2154 @code{-watchdog-action shutdown} is not recommended for production use.
2156 Examples:
2158 @table @code
2159 @item -watchdog i6300esb -watchdog-action pause
2160 @item -watchdog ib700
2161 @end table
2162 ETEXI
2164 DEF("echr", HAS_ARG, QEMU_OPTION_echr, \
2165 "-echr chr set terminal escape character instead of ctrl-a\n",
2166 QEMU_ARCH_ALL)
2167 STEXI
2169 @item -echr @var{numeric_ascii_value}
2170 @findex -echr
2171 Change the escape character used for switching to the monitor when using
2172 monitor and serial sharing. The default is @code{0x01} when using the
2173 @code{-nographic} option. @code{0x01} is equal to pressing
2174 @code{Control-a}. You can select a different character from the ascii
2175 control keys where 1 through 26 map to Control-a through Control-z. For
2176 instance you could use the either of the following to change the escape
2177 character to Control-t.
2178 @table @code
2179 @item -echr 0x14
2180 @item -echr 20
2181 @end table
2182 ETEXI
2184 DEF("virtioconsole", HAS_ARG, QEMU_OPTION_virtiocon, \
2185 "-virtioconsole c\n" \
2186 " set virtio console\n", QEMU_ARCH_ALL)
2187 STEXI
2188 @item -virtioconsole @var{c}
2189 @findex -virtioconsole
2190 Set virtio console.
2192 This option is maintained for backward compatibility.
2194 Please use @code{-device virtconsole} for the new way of invocation.
2195 ETEXI
2197 DEF("show-cursor", 0, QEMU_OPTION_show_cursor, \
2198 "-show-cursor show cursor\n", QEMU_ARCH_ALL)
2199 STEXI
2200 @item -show-cursor
2201 @findex -show-cursor
2202 Show cursor.
2203 ETEXI
2205 DEF("tb-size", HAS_ARG, QEMU_OPTION_tb_size, \
2206 "-tb-size n set TB size\n", QEMU_ARCH_ALL)
2207 STEXI
2208 @item -tb-size @var{n}
2209 @findex -tb-size
2210 Set TB size.
2211 ETEXI
2213 DEF("incoming", HAS_ARG, QEMU_OPTION_incoming, \
2214 "-incoming p prepare for incoming migration, listen on port p\n",
2215 QEMU_ARCH_ALL)
2216 STEXI
2217 @item -incoming @var{port}
2218 @findex -incoming
2219 Prepare for incoming migration, listen on @var{port}.
2220 ETEXI
2222 DEF("nodefaults", 0, QEMU_OPTION_nodefaults, \
2223 "-nodefaults don't create default devices\n", QEMU_ARCH_ALL)
2224 STEXI
2225 @item -nodefaults
2226 @findex -nodefaults
2227 Don't create default devices.
2228 ETEXI
2230 #ifndef _WIN32
2231 DEF("chroot", HAS_ARG, QEMU_OPTION_chroot, \
2232 "-chroot dir chroot to dir just before starting the VM\n",
2233 QEMU_ARCH_ALL)
2234 #endif
2235 STEXI
2236 @item -chroot @var{dir}
2237 @findex -chroot
2238 Immediately before starting guest execution, chroot to the specified
2239 directory. Especially useful in combination with -runas.
2240 ETEXI
2242 #ifndef _WIN32
2243 DEF("runas", HAS_ARG, QEMU_OPTION_runas, \
2244 "-runas user change to user id user just before starting the VM\n",
2245 QEMU_ARCH_ALL)
2246 #endif
2247 STEXI
2248 @item -runas @var{user}
2249 @findex -runas
2250 Immediately before starting guest execution, drop root privileges, switching
2251 to the specified user.
2252 ETEXI
2254 DEF("prom-env", HAS_ARG, QEMU_OPTION_prom_env,
2255 "-prom-env variable=value\n"
2256 " set OpenBIOS nvram variables\n",
2257 QEMU_ARCH_PPC | QEMU_ARCH_SPARC)
2258 STEXI
2259 @item -prom-env @var{variable}=@var{value}
2260 @findex -prom-env
2261 Set OpenBIOS nvram @var{variable} to given @var{value} (PPC, SPARC only).
2262 ETEXI
2263 DEF("semihosting", 0, QEMU_OPTION_semihosting,
2264 "-semihosting semihosting mode\n", QEMU_ARCH_ARM | QEMU_ARCH_M68K)
2265 STEXI
2266 @item -semihosting
2267 @findex -semihosting
2268 Semihosting mode (ARM, M68K only).
2269 ETEXI
2270 DEF("old-param", 0, QEMU_OPTION_old_param,
2271 "-old-param old param mode\n", QEMU_ARCH_ARM)
2272 STEXI
2273 @item -old-param
2274 @findex -old-param (ARM)
2275 Old param mode (ARM only).
2276 ETEXI
2278 DEF("readconfig", HAS_ARG, QEMU_OPTION_readconfig,
2279 "-readconfig <file>\n", QEMU_ARCH_ALL)
2280 STEXI
2281 @item -readconfig @var{file}
2282 @findex -readconfig
2283 Read device configuration from @var{file}.
2284 ETEXI
2285 DEF("writeconfig", HAS_ARG, QEMU_OPTION_writeconfig,
2286 "-writeconfig <file>\n"
2287 " read/write config file\n", QEMU_ARCH_ALL)
2288 STEXI
2289 @item -writeconfig @var{file}
2290 @findex -writeconfig
2291 Write device configuration to @var{file}.
2292 ETEXI
2293 DEF("nodefconfig", 0, QEMU_OPTION_nodefconfig,
2294 "-nodefconfig\n"
2295 " do not load default config files at startup\n",
2296 QEMU_ARCH_ALL)
2297 STEXI
2298 @item -nodefconfig
2299 @findex -nodefconfig
2300 Normally QEMU loads a configuration file from @var{sysconfdir}/qemu.conf and
2301 @var{sysconfdir}/target-@var{ARCH}.conf on startup. The @code{-nodefconfig}
2302 option will prevent QEMU from loading these configuration files at startup.
2303 ETEXI
2304 #ifdef CONFIG_SIMPLE_TRACE
2305 DEF("trace", HAS_ARG, QEMU_OPTION_trace,
2306 "-trace\n"
2307 " Specify a trace file to log traces to\n",
2308 QEMU_ARCH_ALL)
2309 STEXI
2310 @item -trace
2311 @findex -trace
2312 Specify a trace file to log output traces to.
2313 ETEXI
2314 #endif
2316 HXCOMM This is the last statement. Insert new options before this line!
2317 STEXI
2318 @end table
2319 ETEXI