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
7 HXCOMM HXCOMM can be used for comments, discarded from both texi and C
9 DEFHEADING(Standard options:)
14 DEF("help", 0, QEMU_OPTION_h,
15 "-h or -help display this help and exit\n", QEMU_ARCH_ALL)
22 DEF("version", 0, QEMU_OPTION_version,
23 "-version display version information and exit\n", QEMU_ARCH_ALL)
27 Display version information and exit
30 DEF("machine", HAS_ARG, QEMU_OPTION_machine, \
31 "-machine [type=]name[,prop[=value][,...]]\n"
32 " selects emulated machine (-machine ? for list)\n"
33 " property accel=accel1[:accel2[:...]] selects accelerator\n"
34 " supported accelerators are kvm, xen, tcg (default: tcg)\n",
37 @item -machine [type=]@var{name}[,prop=@var{value}[,...]]
39 Select the emulated machine by @var{name}. Use @code{-machine ?} to list
40 available machines. Supported machine properties are:
42 @item accel=@var{accels1}[:@var{accels2}[:...]]
43 This is used to enable an accelerator. Depending on the target architecture,
44 kvm, xen, or tcg can be available. By default, tcg is used. If there is more
45 than one accelerator specified, the next one is used if the previous one fails
50 HXCOMM Deprecated by -machine
51 DEF("M", HAS_ARG, QEMU_OPTION_M, "", QEMU_ARCH_ALL)
53 DEF("cpu", HAS_ARG, QEMU_OPTION_cpu,
54 "-cpu cpu select CPU (-cpu ? for list)\n", QEMU_ARCH_ALL)
56 @item -cpu @var{model}
58 Select CPU model (-cpu ? for list and additional feature selection)
61 DEF("smp", HAS_ARG, QEMU_OPTION_smp,
62 "-smp n[,maxcpus=cpus][,cores=cores][,threads=threads][,sockets=sockets]\n"
63 " set the number of CPUs to 'n' [default=1]\n"
64 " maxcpus= maximum number of total cpus, including\n"
65 " offline CPUs for hotplug, etc\n"
66 " cores= number of CPU cores on one socket\n"
67 " threads= number of threads on one CPU core\n"
68 " sockets= number of discrete sockets in the system\n",
71 @item -smp @var{n}[,cores=@var{cores}][,threads=@var{threads}][,sockets=@var{sockets}][,maxcpus=@var{maxcpus}]
73 Simulate an SMP system with @var{n} CPUs. On the PC target, up to 255
74 CPUs are supported. On Sparc32 target, Linux limits the number of usable CPUs
76 For the PC target, the number of @var{cores} per socket, the number
77 of @var{threads} per cores and the total number of @var{sockets} can be
78 specified. Missing values will be computed. If any on the three values is
79 given, the total number of CPUs @var{n} can be omitted. @var{maxcpus}
80 specifies the maximum number of hotpluggable CPUs.
83 DEF("numa", HAS_ARG, QEMU_OPTION_numa,
84 "-numa node[,mem=size][,cpus=cpu[-cpu]][,nodeid=node]\n", QEMU_ARCH_ALL)
86 @item -numa @var{opts}
88 Simulate a multi node NUMA system. If mem and cpus are omitted, resources
92 DEF("fda", HAS_ARG, QEMU_OPTION_fda,
93 "-fda/-fdb file use 'file' as floppy disk 0/1 image\n", QEMU_ARCH_ALL)
94 DEF("fdb", HAS_ARG, QEMU_OPTION_fdb, "", QEMU_ARCH_ALL)
100 Use @var{file} as floppy disk 0/1 image (@pxref{disk_images}). You can
101 use the host floppy by using @file{/dev/fd0} as filename (@pxref{host_drives}).
104 DEF("hda", HAS_ARG, QEMU_OPTION_hda,
105 "-hda/-hdb file use 'file' as IDE hard disk 0/1 image\n", QEMU_ARCH_ALL)
106 DEF("hdb", HAS_ARG, QEMU_OPTION_hdb, "", QEMU_ARCH_ALL)
107 DEF("hdc", HAS_ARG, QEMU_OPTION_hdc,
108 "-hdc/-hdd file use 'file' as IDE hard disk 2/3 image\n", QEMU_ARCH_ALL)
109 DEF("hdd", HAS_ARG, QEMU_OPTION_hdd, "", QEMU_ARCH_ALL)
111 @item -hda @var{file}
112 @item -hdb @var{file}
113 @item -hdc @var{file}
114 @item -hdd @var{file}
119 Use @var{file} as hard disk 0, 1, 2 or 3 image (@pxref{disk_images}).
122 DEF("cdrom", HAS_ARG, QEMU_OPTION_cdrom,
123 "-cdrom file use 'file' as IDE cdrom image (cdrom is ide1 master)\n",
126 @item -cdrom @var{file}
128 Use @var{file} as CD-ROM image (you cannot use @option{-hdc} and
129 @option{-cdrom} at the same time). You can use the host CD-ROM by
130 using @file{/dev/cdrom} as filename (@pxref{host_drives}).
133 DEF("drive", HAS_ARG, QEMU_OPTION_drive,
134 "-drive [file=file][,if=type][,bus=n][,unit=m][,media=d][,index=i]\n"
135 " [,cyls=c,heads=h,secs=s[,trans=t]][,snapshot=on|off]\n"
136 " [,cache=writethrough|writeback|none|directsync|unsafe][,format=f]\n"
137 " [,serial=s][,addr=A][,id=name][,aio=threads|native]\n"
138 " [,readonly=on|off]\n"
139 " use 'file' as a drive image\n", QEMU_ARCH_ALL)
141 @item -drive @var{option}[,@var{option}[,@var{option}[,...]]]
144 Define a new drive. Valid options are:
147 @item file=@var{file}
148 This option defines which disk image (@pxref{disk_images}) to use with
149 this drive. If the filename contains comma, you must double it
150 (for instance, "file=my,,file" to use file "my,file").
151 @item if=@var{interface}
152 This option defines on which type on interface the drive is connected.
153 Available types are: ide, scsi, sd, mtd, floppy, pflash, virtio.
154 @item bus=@var{bus},unit=@var{unit}
155 These options define where is connected the drive by defining the bus number and
157 @item index=@var{index}
158 This option defines where is connected the drive by using an index in the list
159 of available connectors of a given interface type.
160 @item media=@var{media}
161 This option defines the type of the media: disk or cdrom.
162 @item cyls=@var{c},heads=@var{h},secs=@var{s}[,trans=@var{t}]
163 These options have the same definition as they have in @option{-hdachs}.
164 @item snapshot=@var{snapshot}
165 @var{snapshot} is "on" or "off" and allows to enable snapshot for given drive (see @option{-snapshot}).
166 @item cache=@var{cache}
167 @var{cache} is "none", "writeback", "unsafe", "directsync" or "writethrough" and controls how the host cache is used to access block data.
169 @var{aio} is "threads", or "native" and selects between pthread based disk I/O and native Linux AIO.
170 @item format=@var{format}
171 Specify which disk @var{format} will be used rather than detecting
172 the format. Can be used to specifiy format=raw to avoid interpreting
173 an untrusted format header.
174 @item serial=@var{serial}
175 This option specifies the serial number to assign to the device.
176 @item addr=@var{addr}
177 Specify the controller's PCI address (if=virtio only).
178 @item werror=@var{action},rerror=@var{action}
179 Specify which @var{action} to take on write and read errors. Valid actions are:
180 "ignore" (ignore the error and try to continue), "stop" (pause QEMU),
181 "report" (report the error to the guest), "enospc" (pause QEMU only if the
182 host disk is full; report the error to the guest otherwise).
183 The default setting is @option{werror=enospc} and @option{rerror=report}.
185 Open drive @option{file} as read-only. Guest write attempts will fail.
188 By default, writethrough caching is used for all block device. This means that
189 the host page cache will be used to read and write data but write notification
190 will be sent to the guest only when the data has been reported as written by
191 the storage subsystem.
193 Writeback caching will report data writes as completed as soon as the data is
194 present in the host page cache. This is safe as long as you trust your host.
195 If your host crashes or loses power, then the guest may experience data
198 The host page cache can be avoided entirely with @option{cache=none}. This will
199 attempt to do disk IO directly to the guests memory. QEMU may still perform
200 an internal copy of the data.
202 The host page cache can be avoided while only sending write notifications to
203 the guest when the data has been reported as written by the storage subsystem
204 using @option{cache=directsync}.
206 Some block drivers perform badly with @option{cache=writethrough}, most notably,
207 qcow2. If performance is more important than correctness,
208 @option{cache=writeback} should be used with qcow2.
210 In case you don't care about data integrity over host failures, use
211 cache=unsafe. This option tells qemu that it never needs to write any data
212 to the disk but can instead keeps things in cache. If anything goes wrong,
213 like your host losing power, the disk storage getting disconnected accidently,
214 etc. you're image will most probably be rendered unusable. When using
215 the @option{-snapshot} option, unsafe caching is always used.
217 Instead of @option{-cdrom} you can use:
219 qemu -drive file=file,index=2,media=cdrom
222 Instead of @option{-hda}, @option{-hdb}, @option{-hdc}, @option{-hdd}, you can
225 qemu -drive file=file,index=0,media=disk
226 qemu -drive file=file,index=1,media=disk
227 qemu -drive file=file,index=2,media=disk
228 qemu -drive file=file,index=3,media=disk
231 You can connect a CDROM to the slave of ide0:
233 qemu -drive file=file,if=ide,index=1,media=cdrom
236 If you don't specify the "file=" argument, you define an empty drive:
238 qemu -drive if=ide,index=1,media=cdrom
241 You can connect a SCSI disk with unit ID 6 on the bus #0:
243 qemu -drive file=file,if=scsi,bus=0,unit=6
246 Instead of @option{-fda}, @option{-fdb}, you can use:
248 qemu -drive file=file,index=0,if=floppy
249 qemu -drive file=file,index=1,if=floppy
252 By default, @var{interface} is "ide" and @var{index} is automatically
255 qemu -drive file=a -drive file=b"
263 DEF("set", HAS_ARG, QEMU_OPTION_set,
264 "-set group.id.arg=value\n"
265 " set <arg> parameter for item <id> of type <group>\n"
266 " i.e. -set drive.$id.file=/path/to/image\n", QEMU_ARCH_ALL)
273 DEF("global", HAS_ARG, QEMU_OPTION_global,
274 "-global driver.property=value\n"
275 " set a global default for a driver property\n",
283 DEF("mtdblock", HAS_ARG, QEMU_OPTION_mtdblock,
284 "-mtdblock file use 'file' as on-board Flash memory image\n",
287 @item -mtdblock @var{file}
289 Use @var{file} as on-board Flash memory image.
292 DEF("sd", HAS_ARG, QEMU_OPTION_sd,
293 "-sd file use 'file' as SecureDigital card image\n", QEMU_ARCH_ALL)
297 Use @var{file} as SecureDigital card image.
300 DEF("pflash", HAS_ARG, QEMU_OPTION_pflash,
301 "-pflash file use 'file' as a parallel flash image\n", QEMU_ARCH_ALL)
303 @item -pflash @var{file}
305 Use @var{file} as a parallel flash image.
308 DEF("boot", HAS_ARG, QEMU_OPTION_boot,
309 "-boot [order=drives][,once=drives][,menu=on|off]\n"
310 " [,splash=sp_name][,splash-time=sp_time]\n"
311 " 'drives': floppy (a), hard disk (c), CD-ROM (d), network (n)\n"
312 " 'sp_name': the file's name that would be passed to bios as logo picture, if menu=on\n"
313 " 'sp_time': the period that splash picture last if menu=on, unit is ms\n",
316 @item -boot [order=@var{drives}][,once=@var{drives}][,menu=on|off][,splash=@var{sp_name}][,splash-time=@var{sp_time}]
318 Specify boot order @var{drives} as a string of drive letters. Valid
319 drive letters depend on the target achitecture. The x86 PC uses: a, b
320 (floppy 1 and 2), c (first hard disk), d (first CD-ROM), n-p (Etherboot
321 from network adapter 1-4), hard disk boot is the default. To apply a
322 particular boot order only on the first startup, specify it via
325 Interactive boot menus/prompts can be enabled via @option{menu=on} as far
326 as firmware/BIOS supports them. The default is non-interactive boot.
328 A splash picture could be passed to bios, enabling user to show it as logo,
329 when option splash=@var{sp_name} is given and menu=on, If firmware/BIOS
330 supports them. Currently Seabios for X86 system support it.
331 limitation: The splash file could be a jpeg file or a BMP file in 24 BPP
332 format(true color). The resolution should be supported by the SVGA mode, so
333 the recommended is 320x240, 640x480, 800x640.
336 # try to boot from network first, then from hard disk
338 # boot from CD-ROM first, switch back to default order after reboot
340 # boot with a splash picture for 5 seconds.
341 qemu -boot menu=on,splash=/root/boot.bmp,splash-time=5000
344 Note: The legacy format '-boot @var{drives}' is still supported but its
345 use is discouraged as it may be removed from future versions.
348 DEF("snapshot", 0, QEMU_OPTION_snapshot,
349 "-snapshot write to temporary files instead of disk image files\n",
354 Write to temporary files instead of disk image files. In this case,
355 the raw disk image you use is not written back. You can however force
356 the write back by pressing @key{C-a s} (@pxref{disk_images}).
359 DEF("m", HAS_ARG, QEMU_OPTION_m,
360 "-m megs set virtual RAM size to megs MB [default="
361 stringify(DEFAULT_RAM_SIZE) "]\n", QEMU_ARCH_ALL)
365 Set virtual RAM size to @var{megs} megabytes. Default is 128 MiB. Optionally,
366 a suffix of ``M'' or ``G'' can be used to signify a value in megabytes or
367 gigabytes respectively.
370 DEF("mem-path", HAS_ARG, QEMU_OPTION_mempath,
371 "-mem-path FILE provide backing storage for guest RAM\n", QEMU_ARCH_ALL)
373 @item -mem-path @var{path}
374 Allocate guest RAM from a temporarily created file in @var{path}.
378 DEF("mem-prealloc", 0, QEMU_OPTION_mem_prealloc,
379 "-mem-prealloc preallocate guest memory (use with -mem-path)\n",
383 Preallocate memory when using -mem-path.
387 DEF("k", HAS_ARG, QEMU_OPTION_k,
388 "-k language use keyboard layout (for example 'fr' for French)\n",
391 @item -k @var{language}
393 Use keyboard layout @var{language} (for example @code{fr} for
394 French). This option is only needed where it is not easy to get raw PC
395 keycodes (e.g. on Macs, with some X11 servers or with a VNC
396 display). You don't normally need to use it on PC/Linux or PC/Windows
399 The available layouts are:
401 ar de-ch es fo fr-ca hu ja mk no pt-br sv
402 da en-gb et fr fr-ch is lt nl pl ru th
403 de en-us fi fr-be hr it lv nl-be pt sl tr
406 The default is @code{en-us}.
410 DEF("audio-help", 0, QEMU_OPTION_audio_help,
411 "-audio-help print list of audio drivers and their options\n",
416 Will show the audio subsystem help: list of drivers, tunable
420 DEF("soundhw", HAS_ARG, QEMU_OPTION_soundhw,
421 "-soundhw c1,... enable audio support\n"
422 " and only specified sound cards (comma separated list)\n"
423 " use -soundhw ? to get the list of supported cards\n"
424 " use -soundhw all to enable all of them\n", QEMU_ARCH_ALL)
426 @item -soundhw @var{card1}[,@var{card2},...] or -soundhw all
428 Enable audio and selected sound hardware. Use ? to print all
429 available sound hardware.
432 qemu -soundhw sb16,adlib disk.img
433 qemu -soundhw es1370 disk.img
434 qemu -soundhw ac97 disk.img
435 qemu -soundhw hda disk.img
436 qemu -soundhw all disk.img
440 Note that Linux's i810_audio OSS kernel (for AC97) module might
441 require manually specifying clocking.
444 modprobe i810_audio clocking=48000
452 DEF("usb", 0, QEMU_OPTION_usb,
453 "-usb enable the USB driver (will be the default soon)\n",
461 Enable the USB driver (will be the default soon)
464 DEF("usbdevice", HAS_ARG, QEMU_OPTION_usbdevice,
465 "-usbdevice name add the host or guest USB device 'name'\n",
469 @item -usbdevice @var{devname}
471 Add the USB device @var{devname}. @xref{usb_devices}.
476 Virtual Mouse. This will override the PS/2 mouse emulation when activated.
479 Pointer device that uses absolute coordinates (like a touchscreen). This
480 means qemu is able to report the mouse position without having to grab the
481 mouse. Also overrides the PS/2 mouse emulation when activated.
483 @item disk:[format=@var{format}]:@var{file}
484 Mass storage device based on file. The optional @var{format} argument
485 will be used rather than detecting the format. Can be used to specifiy
486 @code{format=raw} to avoid interpreting an untrusted format header.
488 @item host:@var{bus}.@var{addr}
489 Pass through the host device identified by @var{bus}.@var{addr} (Linux only).
491 @item host:@var{vendor_id}:@var{product_id}
492 Pass through the host device identified by @var{vendor_id}:@var{product_id}
495 @item serial:[vendorid=@var{vendor_id}][,productid=@var{product_id}]:@var{dev}
496 Serial converter to host character device @var{dev}, see @code{-serial} for the
500 Braille device. This will use BrlAPI to display the braille output on a real
503 @item net:@var{options}
504 Network adapter that supports CDC ethernet and RNDIS protocols.
509 DEF("device", HAS_ARG, QEMU_OPTION_device,
510 "-device driver[,prop[=value][,...]]\n"
511 " add device (based on driver)\n"
512 " prop=value,... sets driver properties\n"
513 " use -device ? to print all possible drivers\n"
514 " use -device driver,? to print all possible properties\n",
517 @item -device @var{driver}[,@var{prop}[=@var{value}][,...]]
519 Add device @var{driver}. @var{prop}=@var{value} sets driver
520 properties. Valid properties depend on the driver. To get help on
521 possible drivers and properties, use @code{-device ?} and
522 @code{-device @var{driver},?}.
527 DEFHEADING(File system options:)
529 DEF("fsdev", HAS_ARG, QEMU_OPTION_fsdev,
530 "-fsdev fsdriver,id=id,path=path,security_model=[mapped|passthrough|none]\n"
531 " [,writeout=immediate]\n",
536 @item -fsdev @var{fsdriver},id=@var{id},path=@var{path},security_model=@var{security_model}[,writeout=@var{writeout}]
538 Define a new file system device. Valid options are:
541 This option specifies the fs driver backend to use.
542 Currently "local" and "handle" file system drivers are supported.
544 Specifies identifier for this device
545 @item path=@var{path}
546 Specifies the export path for the file system device. Files under
547 this path will be available to the 9p client on the guest.
548 @item security_model=@var{security_model}
549 Specifies the security model to be used for this export path.
550 Supported security models are "passthrough", "mapped" and "none".
551 In "passthrough" security model, files are stored using the same
552 credentials as they are created on the guest. This requires qemu
553 to run as root. In "mapped" security model, some of the file
554 attributes like uid, gid, mode bits and link target are stored as
555 file attributes. Directories exported by this security model cannot
556 interact with other unix tools. "none" security model is same as
557 passthrough except the sever won't report failures if it fails to
558 set file attributes like ownership.
559 @item writeout=@var{writeout}
560 This is an optional argument. The only supported value is "immediate".
561 This means that host page cache will be used to read and write data but
562 write notification will be sent to the guest only when the data has been
563 reported as written by the storage subsystem.
566 -fsdev option is used along with -device driver "virtio-9p-pci".
567 @item -device virtio-9p-pci,fsdev=@var{id},mount_tag=@var{mount_tag}
568 Options for virtio-9p-pci driver are:
571 Specifies the id value specified along with -fsdev option
572 @item mount_tag=@var{mount_tag}
573 Specifies the tag name to be used by the guest to mount this export point
580 DEFHEADING(Virtual File system pass-through options:)
582 DEF("virtfs", HAS_ARG, QEMU_OPTION_virtfs,
583 "-virtfs local,path=path,mount_tag=tag,security_model=[mapped|passthrough|none]\n"
584 " [,writeout=immediate]\n",
589 @item -virtfs @var{fsdriver},path=@var{path},mount_tag=@var{mount_tag},security_model=@var{security_model}[,writeout=@var{writeout}]
592 The general form of a Virtual File system pass-through options are:
595 This option specifies the fs driver backend to use.
596 Currently "local" and "handle" file system drivers are supported.
598 Specifies identifier for this device
599 @item path=@var{path}
600 Specifies the export path for the file system device. Files under
601 this path will be available to the 9p client on the guest.
602 @item security_model=@var{security_model}
603 Specifies the security model to be used for this export path.
604 Supported security models are "passthrough", "mapped" and "none".
605 In "passthrough" security model, files are stored using the same
606 credentials as they are created on the guest. This requires qemu
607 to run as root. In "mapped" security model, some of the file
608 attributes like uid, gid, mode bits and link target are stored as
609 file attributes. Directories exported by this security model cannot
610 interact with other unix tools. "none" security model is same as
611 passthrough except the sever won't report failures if it fails to
612 set file attributes like ownership.
613 @item writeout=@var{writeout}
614 This is an optional argument. The only supported value is "immediate".
615 This means that host page cache will be used to read and write data but
616 write notification will be sent to the guest only when the data has been
617 reported as written by the storage subsystem.
623 DEF("name", HAS_ARG, QEMU_OPTION_name,
624 "-name string1[,process=string2]\n"
625 " set the name of the guest\n"
626 " string1 sets the window title and string2 the process name (on Linux)\n",
629 @item -name @var{name}
631 Sets the @var{name} of the guest.
632 This name will be displayed in the SDL window caption.
633 The @var{name} will also be used for the VNC server.
634 Also optionally set the top visible process name in Linux.
637 DEF("uuid", HAS_ARG, QEMU_OPTION_uuid,
638 "-uuid %08x-%04x-%04x-%04x-%012x\n"
639 " specify machine UUID\n", QEMU_ARCH_ALL)
641 @item -uuid @var{uuid}
652 DEFHEADING(Display options:)
658 DEF("display", HAS_ARG, QEMU_OPTION_display,
659 "-display sdl[,frame=on|off][,alt_grab=on|off][,ctrl_grab=on|off]\n"
660 " [,window_close=on|off]|curses|none|\n"
661 " vnc=<display>[,<optargs>]\n"
662 " select display type\n", QEMU_ARCH_ALL)
664 @item -display @var{type}
666 Select type of display to use. This option is a replacement for the
667 old style -sdl/-curses/... options. Valid values for @var{type} are
670 Display video output via SDL (usually in a separate graphics
671 window; see the SDL documentation for other possibilities).
673 Display video output via curses. For graphics device models which
674 support a text mode, QEMU can display this output using a
675 curses/ncurses interface. Nothing is displayed when the graphics
676 device is in graphical mode or if the graphics device does not support
677 a text mode. Generally only the VGA device models support text mode.
679 Do not display video output. The guest will still see an emulated
680 graphics card, but its output will not be displayed to the QEMU
681 user. This option differs from the -nographic option in that it
682 only affects what is done with video output; -nographic also changes
683 the destination of the serial and parallel port data.
685 Start a VNC server on display <arg>
689 DEF("nographic", 0, QEMU_OPTION_nographic,
690 "-nographic disable graphical output and redirect serial I/Os to console\n",
695 Normally, QEMU uses SDL to display the VGA output. With this option,
696 you can totally disable graphical output so that QEMU is a simple
697 command line application. The emulated serial port is redirected on
698 the console. Therefore, you can still use QEMU to debug a Linux kernel
699 with a serial console.
702 DEF("curses", 0, QEMU_OPTION_curses,
703 "-curses use a curses/ncurses interface instead of SDL\n",
708 Normally, QEMU uses SDL to display the VGA output. With this option,
709 QEMU can display the VGA output when in text mode using a
710 curses/ncurses interface. Nothing is displayed in graphical mode.
713 DEF("no-frame", 0, QEMU_OPTION_no_frame,
714 "-no-frame open SDL window without a frame and window decorations\n",
719 Do not use decorations for SDL windows and start them using the whole
720 available screen space. This makes the using QEMU in a dedicated desktop
721 workspace more convenient.
724 DEF("alt-grab", 0, QEMU_OPTION_alt_grab,
725 "-alt-grab use Ctrl-Alt-Shift to grab mouse (instead of Ctrl-Alt)\n",
730 Use Ctrl-Alt-Shift to grab mouse (instead of Ctrl-Alt). Note that this also
731 affects the special keys (for fullscreen, monitor-mode switching, etc).
734 DEF("ctrl-grab", 0, QEMU_OPTION_ctrl_grab,
735 "-ctrl-grab use Right-Ctrl to grab mouse (instead of Ctrl-Alt)\n",
740 Use Right-Ctrl to grab mouse (instead of Ctrl-Alt). Note that this also
741 affects the special keys (for fullscreen, monitor-mode switching, etc).
744 DEF("no-quit", 0, QEMU_OPTION_no_quit,
745 "-no-quit disable SDL window close capability\n", QEMU_ARCH_ALL)
749 Disable SDL window close capability.
752 DEF("sdl", 0, QEMU_OPTION_sdl,
753 "-sdl enable SDL\n", QEMU_ARCH_ALL)
760 DEF("spice", HAS_ARG, QEMU_OPTION_spice,
761 "-spice <args> enable spice\n", QEMU_ARCH_ALL)
763 @item -spice @var{option}[,@var{option}[,...]]
765 Enable the spice remote desktop protocol. Valid options are
770 Set the TCP port spice is listening on for plaintext channels.
773 Set the IP address spice is listening on. Default is any address.
777 Force using the specified IP version.
779 @item password=<secret>
780 Set the password you need to authenticate.
783 Require that the client use SASL to authenticate with the spice.
784 The exact choice of authentication method used is controlled from the
785 system / user's SASL configuration file for the 'qemu' service. This
786 is typically found in /etc/sasl2/qemu.conf. If running QEMU as an
787 unprivileged user, an environment variable SASL_CONF_PATH can be used
788 to make it search alternate locations for the service config.
789 While some SASL auth methods can also provide data encryption (eg GSSAPI),
790 it is recommended that SASL always be combined with the 'tls' and
791 'x509' settings to enable use of SSL and server certificates. This
792 ensures a data encryption preventing compromise of authentication
795 @item disable-ticketing
796 Allow client connects without authentication.
798 @item disable-copy-paste
799 Disable copy paste between the client and the guest.
802 Set the TCP port spice is listening on for encrypted channels.
805 Set the x509 file directory. Expects same filenames as -vnc $display,x509=$dir
807 @item x509-key-file=<file>
808 @item x509-key-password=<file>
809 @item x509-cert-file=<file>
810 @item x509-cacert-file=<file>
811 @item x509-dh-key-file=<file>
812 The x509 file names can also be configured individually.
814 @item tls-ciphers=<list>
815 Specify which ciphers to use.
817 @item tls-channel=[main|display|inputs|record|playback|tunnel]
818 @item plaintext-channel=[main|display|inputs|record|playback|tunnel]
819 Force specific channel to be used with or without TLS encryption. The
820 options can be specified multiple times to configure multiple
821 channels. The special name "default" can be used to set the default
822 mode. For channels which are not explicitly forced into one mode the
823 spice client is allowed to pick tls/plaintext as he pleases.
825 @item image-compression=[auto_glz|auto_lz|quic|glz|lz|off]
826 Configure image compression (lossless).
829 @item jpeg-wan-compression=[auto|never|always]
830 @item zlib-glz-wan-compression=[auto|never|always]
831 Configure wan image compression (lossy for slow links).
834 @item streaming-video=[off|all|filter]
835 Configure video stream detection. Default is filter.
837 @item agent-mouse=[on|off]
838 Enable/disable passing mouse events via vdagent. Default is on.
840 @item playback-compression=[on|off]
841 Enable/disable audio stream compression (using celt 0.5.1). Default is on.
846 DEF("portrait", 0, QEMU_OPTION_portrait,
847 "-portrait rotate graphical output 90 deg left (only PXA LCD)\n",
852 Rotate graphical output 90 deg left (only PXA LCD).
855 DEF("rotate", HAS_ARG, QEMU_OPTION_rotate,
856 "-rotate <deg> rotate graphical output some deg left (only PXA LCD)\n",
861 Rotate graphical output some deg left (only PXA LCD).
864 DEF("vga", HAS_ARG, QEMU_OPTION_vga,
865 "-vga [std|cirrus|vmware|qxl|xenfb|none]\n"
866 " select video card type\n", QEMU_ARCH_ALL)
868 @item -vga @var{type}
870 Select type of VGA card to emulate. Valid values for @var{type} are
873 Cirrus Logic GD5446 Video card. All Windows versions starting from
874 Windows 95 should recognize and use this graphic card. For optimal
875 performances, use 16 bit color depth in the guest and the host OS.
876 (This one is the default)
878 Standard VGA card with Bochs VBE extensions. If your guest OS
879 supports the VESA 2.0 VBE extensions (e.g. Windows XP) and if you want
880 to use high resolution modes (>= 1280x1024x16) then you should use
883 VMWare SVGA-II compatible adapter. Use it if you have sufficiently
884 recent XFree86/XOrg server or Windows guest with a driver for this
887 QXL paravirtual graphic card. It is VGA compatible (including VESA
888 2.0 VBE support). Works best with qxl guest drivers installed though.
889 Recommended choice when using the spice protocol.
895 DEF("full-screen", 0, QEMU_OPTION_full_screen,
896 "-full-screen start in full screen\n", QEMU_ARCH_ALL)
900 Start in full screen.
903 DEF("g", 1, QEMU_OPTION_g ,
904 "-g WxH[xDEPTH] Set the initial graphical resolution and depth\n",
905 QEMU_ARCH_PPC | QEMU_ARCH_SPARC)
907 @item -g @var{width}x@var{height}[x@var{depth}]
909 Set the initial graphical resolution and depth (PPC, SPARC only).
912 DEF("vnc", HAS_ARG, QEMU_OPTION_vnc ,
913 "-vnc display start a VNC server on display\n", QEMU_ARCH_ALL)
915 @item -vnc @var{display}[,@var{option}[,@var{option}[,...]]]
917 Normally, QEMU uses SDL to display the VGA output. With this option,
918 you can have QEMU listen on VNC display @var{display} and redirect the VGA
919 display over the VNC session. It is very useful to enable the usb
920 tablet device when using this option (option @option{-usbdevice
921 tablet}). When using the VNC display, you must use the @option{-k}
922 parameter to set the keyboard layout if you are not using en-us. Valid
923 syntax for the @var{display} is
927 @item @var{host}:@var{d}
929 TCP connections will only be allowed from @var{host} on display @var{d}.
930 By convention the TCP port is 5900+@var{d}. Optionally, @var{host} can
931 be omitted in which case the server will accept connections from any host.
933 @item unix:@var{path}
935 Connections will be allowed over UNIX domain sockets where @var{path} is the
936 location of a unix socket to listen for connections on.
940 VNC is initialized but not started. The monitor @code{change} command
941 can be used to later start the VNC server.
945 Following the @var{display} value there may be one or more @var{option} flags
946 separated by commas. Valid options are
952 Connect to a listening VNC client via a ``reverse'' connection. The
953 client is specified by the @var{display}. For reverse network
954 connections (@var{host}:@var{d},@code{reverse}), the @var{d} argument
955 is a TCP port number, not a display number.
959 Require that password based authentication is used for client connections.
960 The password must be set separately using the @code{change} command in the
965 Require that client use TLS when communicating with the VNC server. This
966 uses anonymous TLS credentials so is susceptible to a man-in-the-middle
967 attack. It is recommended that this option be combined with either the
968 @option{x509} or @option{x509verify} options.
970 @item x509=@var{/path/to/certificate/dir}
972 Valid if @option{tls} is specified. Require that x509 credentials are used
973 for negotiating the TLS session. The server will send its x509 certificate
974 to the client. It is recommended that a password be set on the VNC server
975 to provide authentication of the client when this is used. The path following
976 this option specifies where the x509 certificates are to be loaded from.
977 See the @ref{vnc_security} section for details on generating certificates.
979 @item x509verify=@var{/path/to/certificate/dir}
981 Valid if @option{tls} is specified. Require that x509 credentials are used
982 for negotiating the TLS session. The server will send its x509 certificate
983 to the client, and request that the client send its own x509 certificate.
984 The server will validate the client's certificate against the CA certificate,
985 and reject clients when validation fails. If the certificate authority is
986 trusted, this is a sufficient authentication mechanism. You may still wish
987 to set a password on the VNC server as a second authentication layer. The
988 path following this option specifies where the x509 certificates are to
989 be loaded from. See the @ref{vnc_security} section for details on generating
994 Require that the client use SASL to authenticate with the VNC server.
995 The exact choice of authentication method used is controlled from the
996 system / user's SASL configuration file for the 'qemu' service. This
997 is typically found in /etc/sasl2/qemu.conf. If running QEMU as an
998 unprivileged user, an environment variable SASL_CONF_PATH can be used
999 to make it search alternate locations for the service config.
1000 While some SASL auth methods can also provide data encryption (eg GSSAPI),
1001 it is recommended that SASL always be combined with the 'tls' and
1002 'x509' settings to enable use of SSL and server certificates. This
1003 ensures a data encryption preventing compromise of authentication
1004 credentials. See the @ref{vnc_security} section for details on using
1005 SASL authentication.
1009 Turn on access control lists for checking of the x509 client certificate
1010 and SASL party. For x509 certs, the ACL check is made against the
1011 certificate's distinguished name. This is something that looks like
1012 @code{C=GB,O=ACME,L=Boston,CN=bob}. For SASL party, the ACL check is
1013 made against the username, which depending on the SASL plugin, may
1014 include a realm component, eg @code{bob} or @code{bob@@EXAMPLE.COM}.
1015 When the @option{acl} flag is set, the initial access list will be
1016 empty, with a @code{deny} policy. Thus no one will be allowed to
1017 use the VNC server until the ACLs have been loaded. This can be
1018 achieved using the @code{acl} monitor command.
1022 Enable lossy compression methods (gradient, JPEG, ...). If this
1023 option is set, VNC client may receive lossy framebuffer updates
1024 depending on its encoding settings. Enabling this option can save
1025 a lot of bandwidth at the expense of quality.
1029 Disable adaptive encodings. Adaptive encodings are enabled by default.
1030 An adaptive encoding will try to detect frequently updated screen regions,
1031 and send updates in these regions using a lossy encoding (like JPEG).
1032 This can be really helpful to save bandwidth when playing videos. Disabling
1033 adaptive encodings allows to restore the original static behavior of encodings
1045 DEFHEADING(i386 target only:)
1050 DEF("win2k-hack", 0, QEMU_OPTION_win2k_hack,
1051 "-win2k-hack use it when installing Windows 2000 to avoid a disk full bug\n",
1056 Use it when installing Windows 2000 to avoid a disk full bug. After
1057 Windows 2000 is installed, you no longer need this option (this option
1058 slows down the IDE transfers).
1061 HXCOMM Deprecated by -rtc
1062 DEF("rtc-td-hack", 0, QEMU_OPTION_rtc_td_hack, "", QEMU_ARCH_I386)
1064 DEF("no-fd-bootchk", 0, QEMU_OPTION_no_fd_bootchk,
1065 "-no-fd-bootchk disable boot signature checking for floppy disks\n",
1068 @item -no-fd-bootchk
1069 @findex -no-fd-bootchk
1070 Disable boot signature checking for floppy disks in Bochs BIOS. It may
1071 be needed to boot from old floppy disks.
1072 TODO: check reference to Bochs BIOS.
1075 DEF("no-acpi", 0, QEMU_OPTION_no_acpi,
1076 "-no-acpi disable ACPI\n", QEMU_ARCH_I386)
1080 Disable ACPI (Advanced Configuration and Power Interface) support. Use
1081 it if your guest OS complains about ACPI problems (PC target machine
1085 DEF("no-hpet", 0, QEMU_OPTION_no_hpet,
1086 "-no-hpet disable HPET\n", QEMU_ARCH_I386)
1090 Disable HPET support.
1093 DEF("balloon", HAS_ARG, QEMU_OPTION_balloon,
1094 "-balloon none disable balloon device\n"
1095 "-balloon virtio[,addr=str]\n"
1096 " enable virtio balloon device (default)\n", QEMU_ARCH_ALL)
1100 Disable balloon device.
1101 @item -balloon virtio[,addr=@var{addr}]
1102 Enable virtio balloon device (default), optionally with PCI address
1106 DEF("acpitable", HAS_ARG, QEMU_OPTION_acpitable,
1107 "-acpitable [sig=str][,rev=n][,oem_id=str][,oem_table_id=str][,oem_rev=n][,asl_compiler_id=str][,asl_compiler_rev=n][,{data|file}=file1[:file2]...]\n"
1108 " ACPI table description\n", QEMU_ARCH_I386)
1110 @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}]...]
1112 Add ACPI table with specified header fields and context from specified files.
1113 For file=, take whole ACPI table from the specified files, including all
1114 ACPI headers (possible overridden by other options).
1115 For data=, only data
1116 portion of the table is used, all header information is specified in the
1120 DEF("smbios", HAS_ARG, QEMU_OPTION_smbios,
1121 "-smbios file=binary\n"
1122 " load SMBIOS entry from binary file\n"
1123 "-smbios type=0[,vendor=str][,version=str][,date=str][,release=%d.%d]\n"
1124 " specify SMBIOS type 0 fields\n"
1125 "-smbios type=1[,manufacturer=str][,product=str][,version=str][,serial=str]\n"
1126 " [,uuid=uuid][,sku=str][,family=str]\n"
1127 " specify SMBIOS type 1 fields\n", QEMU_ARCH_I386)
1129 @item -smbios file=@var{binary}
1131 Load SMBIOS entry from binary file.
1133 @item -smbios type=0[,vendor=@var{str}][,version=@var{str}][,date=@var{str}][,release=@var{%d.%d}]
1135 Specify SMBIOS type 0 fields
1137 @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}]
1138 Specify SMBIOS type 1 fields
1146 DEFHEADING(Network options:)
1151 HXCOMM Legacy slirp options (now moved to -net user):
1153 DEF("tftp", HAS_ARG, QEMU_OPTION_tftp, "", QEMU_ARCH_ALL)
1154 DEF("bootp", HAS_ARG, QEMU_OPTION_bootp, "", QEMU_ARCH_ALL)
1155 DEF("redir", HAS_ARG, QEMU_OPTION_redir, "", QEMU_ARCH_ALL)
1157 DEF("smb", HAS_ARG, QEMU_OPTION_smb, "", QEMU_ARCH_ALL)
1161 DEF("net", HAS_ARG, QEMU_OPTION_net,
1162 "-net nic[,vlan=n][,macaddr=mac][,model=type][,name=str][,addr=str][,vectors=v]\n"
1163 " create a new Network Interface Card and connect it to VLAN 'n'\n"
1165 "-net user[,vlan=n][,name=str][,net=addr[/mask]][,host=addr][,restrict=on|off]\n"
1166 " [,hostname=host][,dhcpstart=addr][,dns=addr][,tftp=dir][,bootfile=f]\n"
1167 " [,hostfwd=rule][,guestfwd=rule]"
1169 "[,smb=dir[,smbserver=addr]]\n"
1171 " connect the user mode network stack to VLAN 'n', configure its\n"
1172 " DHCP server and enabled optional services\n"
1175 "-net tap[,vlan=n][,name=str],ifname=name\n"
1176 " connect the host TAP network interface to VLAN 'n'\n"
1178 "-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][,vhostforce=on|off]\n"
1179 " connect the host TAP network interface to VLAN 'n' and use the\n"
1180 " network scripts 'file' (default=" DEFAULT_NETWORK_SCRIPT ")\n"
1181 " and 'dfile' (default=" DEFAULT_NETWORK_DOWN_SCRIPT ")\n"
1182 " use '[down]script=no' to disable script execution\n"
1183 " use 'fd=h' to connect to an already opened TAP interface\n"
1184 " use 'sndbuf=nbytes' to limit the size of the send buffer (the\n"
1185 " default is disabled 'sndbuf=0' to enable flow control set 'sndbuf=1048576')\n"
1186 " use vnet_hdr=off to avoid enabling the IFF_VNET_HDR tap flag\n"
1187 " use vnet_hdr=on to make the lack of IFF_VNET_HDR support an error condition\n"
1188 " use vhost=on to enable experimental in kernel accelerator\n"
1189 " (only has effect for virtio guests which use MSIX)\n"
1190 " use vhostforce=on to force vhost on for non-MSIX virtio guests\n"
1191 " use 'vhostfd=h' to connect to an already opened vhost net device\n"
1193 "-net socket[,vlan=n][,name=str][,fd=h][,listen=[host]:port][,connect=host:port]\n"
1194 " connect the vlan 'n' to another VLAN using a socket connection\n"
1195 "-net socket[,vlan=n][,name=str][,fd=h][,mcast=maddr:port[,localaddr=addr]]\n"
1196 " connect the vlan 'n' to multicast maddr and port\n"
1197 " use 'localaddr=addr' to specify the host address to send packets from\n"
1199 "-net vde[,vlan=n][,name=str][,sock=socketpath][,port=n][,group=groupname][,mode=octalmode]\n"
1200 " connect the vlan 'n' to port 'n' of a vde switch running\n"
1201 " on host and listening for incoming connections on 'socketpath'.\n"
1202 " Use group 'groupname' and mode 'octalmode' to change default\n"
1203 " ownership and permissions for communication port.\n"
1205 "-net dump[,vlan=n][,file=f][,len=n]\n"
1206 " dump traffic on vlan 'n' to file 'f' (max n bytes per packet)\n"
1207 "-net none use it alone to have zero network devices. If no -net option\n"
1208 " is provided, the default is '-net nic -net user'\n", QEMU_ARCH_ALL)
1209 DEF("netdev", HAS_ARG, QEMU_OPTION_netdev,
1218 "socket],id=str[,option][,option][,...]\n", QEMU_ARCH_ALL)
1220 @item -net nic[,vlan=@var{n}][,macaddr=@var{mac}][,model=@var{type}] [,name=@var{name}][,addr=@var{addr}][,vectors=@var{v}]
1222 Create a new Network Interface Card and connect it to VLAN @var{n} (@var{n}
1223 = 0 is the default). The NIC is an e1000 by default on the PC
1224 target. Optionally, the MAC address can be changed to @var{mac}, the
1225 device address set to @var{addr} (PCI cards only),
1226 and a @var{name} can be assigned for use in monitor commands.
1227 Optionally, for PCI cards, you can specify the number @var{v} of MSI-X vectors
1228 that the card should have; this option currently only affects virtio cards; set
1229 @var{v} = 0 to disable MSI-X. If no @option{-net} option is specified, a single
1230 NIC is created. Qemu can emulate several different models of network card.
1231 Valid values for @var{type} are
1232 @code{virtio}, @code{i82551}, @code{i82557b}, @code{i82559er},
1233 @code{ne2k_pci}, @code{ne2k_isa}, @code{pcnet}, @code{rtl8139},
1234 @code{e1000}, @code{smc91c111}, @code{lance} and @code{mcf_fec}.
1235 Not all devices are supported on all targets. Use -net nic,model=?
1236 for a list of available devices for your target.
1238 @item -net user[,@var{option}][,@var{option}][,...]
1239 Use the user mode network stack which requires no administrator
1240 privilege to run. Valid options are:
1244 Connect user mode stack to VLAN @var{n} (@var{n} = 0 is the default).
1246 @item name=@var{name}
1247 Assign symbolic name for use in monitor commands.
1249 @item net=@var{addr}[/@var{mask}]
1250 Set IP network address the guest will see. Optionally specify the netmask,
1251 either in the form a.b.c.d or as number of valid top-most bits. Default is
1254 @item host=@var{addr}
1255 Specify the guest-visible address of the host. Default is the 2nd IP in the
1256 guest network, i.e. x.x.x.2.
1258 @item restrict=on|off
1259 If this option is enabled, the guest will be isolated, i.e. it will not be
1260 able to contact the host and no guest IP packets will be routed over the host
1261 to the outside. This option does not affect any explicitly set forwarding rules.
1263 @item hostname=@var{name}
1264 Specifies the client hostname reported by the builtin DHCP server.
1266 @item dhcpstart=@var{addr}
1267 Specify the first of the 16 IPs the built-in DHCP server can assign. Default
1268 is the 15th to 31st IP in the guest network, i.e. x.x.x.15 to x.x.x.31.
1270 @item dns=@var{addr}
1271 Specify the guest-visible address of the virtual nameserver. The address must
1272 be different from the host address. Default is the 3rd IP in the guest network,
1275 @item tftp=@var{dir}
1276 When using the user mode network stack, activate a built-in TFTP
1277 server. The files in @var{dir} will be exposed as the root of a TFTP server.
1278 The TFTP client on the guest must be configured in binary mode (use the command
1279 @code{bin} of the Unix TFTP client).
1281 @item bootfile=@var{file}
1282 When using the user mode network stack, broadcast @var{file} as the BOOTP
1283 filename. In conjunction with @option{tftp}, this can be used to network boot
1284 a guest from a local directory.
1286 Example (using pxelinux):
1288 qemu -hda linux.img -boot n -net user,tftp=/path/to/tftp/files,bootfile=/pxelinux.0
1291 @item smb=@var{dir}[,smbserver=@var{addr}]
1292 When using the user mode network stack, activate a built-in SMB
1293 server so that Windows OSes can access to the host files in @file{@var{dir}}
1294 transparently. The IP address of the SMB server can be set to @var{addr}. By
1295 default the 4th IP in the guest network is used, i.e. x.x.x.4.
1297 In the guest Windows OS, the line:
1301 must be added in the file @file{C:\WINDOWS\LMHOSTS} (for windows 9x/Me)
1302 or @file{C:\WINNT\SYSTEM32\DRIVERS\ETC\LMHOSTS} (Windows NT/2000).
1304 Then @file{@var{dir}} can be accessed in @file{\\smbserver\qemu}.
1306 Note that a SAMBA server must be installed on the host OS.
1307 QEMU was tested successfully with smbd versions from Red Hat 9,
1308 Fedora Core 3 and OpenSUSE 11.x.
1310 @item hostfwd=[tcp|udp]:[@var{hostaddr}]:@var{hostport}-[@var{guestaddr}]:@var{guestport}
1311 Redirect incoming TCP or UDP connections to the host port @var{hostport} to
1312 the guest IP address @var{guestaddr} on guest port @var{guestport}. If
1313 @var{guestaddr} is not specified, its value is x.x.x.15 (default first address
1314 given by the built-in DHCP server). By specifying @var{hostaddr}, the rule can
1315 be bound to a specific host interface. If no connection type is set, TCP is
1316 used. This option can be given multiple times.
1318 For example, to redirect host X11 connection from screen 1 to guest
1319 screen 0, use the following:
1323 qemu -net user,hostfwd=tcp:127.0.0.1:6001-:6000 [...]
1324 # this host xterm should open in the guest X11 server
1328 To redirect telnet connections from host port 5555 to telnet port on
1329 the guest, use the following:
1333 qemu -net user,hostfwd=tcp::5555-:23 [...]
1334 telnet localhost 5555
1337 Then when you use on the host @code{telnet localhost 5555}, you
1338 connect to the guest telnet server.
1340 @item guestfwd=[tcp]:@var{server}:@var{port}-@var{dev}
1341 Forward guest TCP connections to the IP address @var{server} on port @var{port}
1342 to the character device @var{dev}. This option can be given multiple times.
1346 Note: Legacy stand-alone options -tftp, -bootp, -smb and -redir are still
1347 processed and applied to -net user. Mixing them with the new configuration
1348 syntax gives undefined results. Their use for new applications is discouraged
1349 as they will be removed from future versions.
1351 @item -net tap[,vlan=@var{n}][,name=@var{name}][,fd=@var{h}][,ifname=@var{name}] [,script=@var{file}][,downscript=@var{dfile}]
1352 Connect the host TAP network interface @var{name} to VLAN @var{n}, use
1353 the network script @var{file} to configure it and the network script
1354 @var{dfile} to deconfigure it. If @var{name} is not provided, the OS
1355 automatically provides one. @option{fd}=@var{h} can be used to specify
1356 the handle of an already opened host TAP interface. The default network
1357 configure script is @file{/etc/qemu-ifup} and the default network
1358 deconfigure script is @file{/etc/qemu-ifdown}. Use @option{script=no}
1359 or @option{downscript=no} to disable script execution. Example:
1362 qemu linux.img -net nic -net tap
1365 More complicated example (two NICs, each one connected to a TAP device)
1367 qemu linux.img -net nic,vlan=0 -net tap,vlan=0,ifname=tap0 \
1368 -net nic,vlan=1 -net tap,vlan=1,ifname=tap1
1371 @item -net socket[,vlan=@var{n}][,name=@var{name}][,fd=@var{h}] [,listen=[@var{host}]:@var{port}][,connect=@var{host}:@var{port}]
1373 Connect the VLAN @var{n} to a remote VLAN in another QEMU virtual
1374 machine using a TCP socket connection. If @option{listen} is
1375 specified, QEMU waits for incoming connections on @var{port}
1376 (@var{host} is optional). @option{connect} is used to connect to
1377 another QEMU instance using the @option{listen} option. @option{fd}=@var{h}
1378 specifies an already opened TCP socket.
1382 # launch a first QEMU instance
1383 qemu linux.img -net nic,macaddr=52:54:00:12:34:56 \
1384 -net socket,listen=:1234
1385 # connect the VLAN 0 of this instance to the VLAN 0
1386 # of the first instance
1387 qemu linux.img -net nic,macaddr=52:54:00:12:34:57 \
1388 -net socket,connect=127.0.0.1:1234
1391 @item -net socket[,vlan=@var{n}][,name=@var{name}][,fd=@var{h}][,mcast=@var{maddr}:@var{port}[,localaddr=@var{addr}]]
1393 Create a VLAN @var{n} shared with another QEMU virtual
1394 machines using a UDP multicast socket, effectively making a bus for
1395 every QEMU with same multicast address @var{maddr} and @var{port}.
1399 Several QEMU can be running on different hosts and share same bus (assuming
1400 correct multicast setup for these hosts).
1402 mcast support is compatible with User Mode Linux (argument @option{eth@var{N}=mcast}), see
1403 @url{http://user-mode-linux.sf.net}.
1405 Use @option{fd=h} to specify an already opened UDP multicast socket.
1410 # launch one QEMU instance
1411 qemu linux.img -net nic,macaddr=52:54:00:12:34:56 \
1412 -net socket,mcast=230.0.0.1:1234
1413 # launch another QEMU instance on same "bus"
1414 qemu linux.img -net nic,macaddr=52:54:00:12:34:57 \
1415 -net socket,mcast=230.0.0.1:1234
1416 # launch yet another QEMU instance on same "bus"
1417 qemu linux.img -net nic,macaddr=52:54:00:12:34:58 \
1418 -net socket,mcast=230.0.0.1:1234
1421 Example (User Mode Linux compat.):
1423 # launch QEMU instance (note mcast address selected
1425 qemu linux.img -net nic,macaddr=52:54:00:12:34:56 \
1426 -net socket,mcast=239.192.168.1:1102
1428 /path/to/linux ubd0=/path/to/root_fs eth0=mcast
1431 Example (send packets from host's 1.2.3.4):
1433 qemu linux.img -net nic,macaddr=52:54:00:12:34:56 \
1434 -net socket,mcast=239.192.168.1:1102,localaddr=1.2.3.4
1437 @item -net vde[,vlan=@var{n}][,name=@var{name}][,sock=@var{socketpath}] [,port=@var{n}][,group=@var{groupname}][,mode=@var{octalmode}]
1438 Connect VLAN @var{n} to PORT @var{n} of a vde switch running on host and
1439 listening for incoming connections on @var{socketpath}. Use GROUP @var{groupname}
1440 and MODE @var{octalmode} to change default ownership and permissions for
1441 communication port. This option is only available if QEMU has been compiled
1442 with vde support enabled.
1447 vde_switch -F -sock /tmp/myswitch
1448 # launch QEMU instance
1449 qemu linux.img -net nic -net vde,sock=/tmp/myswitch
1452 @item -net dump[,vlan=@var{n}][,file=@var{file}][,len=@var{len}]
1453 Dump network traffic on VLAN @var{n} to file @var{file} (@file{qemu-vlan0.pcap} by default).
1454 At most @var{len} bytes (64k by default) per packet are stored. The file format is
1455 libpcap, so it can be analyzed with tools such as tcpdump or Wireshark.
1458 Indicate that no network devices should be configured. It is used to
1459 override the default configuration (@option{-net nic -net user}) which
1460 is activated if no @option{-net} options are provided.
1467 DEFHEADING(Character device options:)
1469 DEF("chardev", HAS_ARG, QEMU_OPTION_chardev,
1470 "-chardev null,id=id[,mux=on|off]\n"
1471 "-chardev socket,id=id[,host=host],port=host[,to=to][,ipv4][,ipv6][,nodelay]\n"
1472 " [,server][,nowait][,telnet][,mux=on|off] (tcp)\n"
1473 "-chardev socket,id=id,path=path[,server][,nowait][,telnet],[mux=on|off] (unix)\n"
1474 "-chardev udp,id=id[,host=host],port=port[,localaddr=localaddr]\n"
1475 " [,localport=localport][,ipv4][,ipv6][,mux=on|off]\n"
1476 "-chardev msmouse,id=id[,mux=on|off]\n"
1477 "-chardev vc,id=id[[,width=width][,height=height]][[,cols=cols][,rows=rows]]\n"
1479 "-chardev file,id=id,path=path[,mux=on|off]\n"
1480 "-chardev pipe,id=id,path=path[,mux=on|off]\n"
1482 "-chardev console,id=id[,mux=on|off]\n"
1483 "-chardev serial,id=id,path=path[,mux=on|off]\n"
1485 "-chardev pty,id=id[,mux=on|off]\n"
1486 "-chardev stdio,id=id[,mux=on|off][,signal=on|off]\n"
1488 #ifdef CONFIG_BRLAPI
1489 "-chardev braille,id=id[,mux=on|off]\n"
1491 #if defined(__linux__) || defined(__sun__) || defined(__FreeBSD__) \
1492 || defined(__NetBSD__) || defined(__OpenBSD__) || defined(__DragonFly__)
1493 "-chardev tty,id=id,path=path[,mux=on|off]\n"
1495 #if defined(__linux__) || defined(__FreeBSD__) || defined(__DragonFly__)
1496 "-chardev parport,id=id,path=path[,mux=on|off]\n"
1498 #if defined(CONFIG_SPICE)
1499 "-chardev spicevmc,id=id,name=name[,debug=debug]\n"
1506 The general form of a character device option is:
1509 @item -chardev @var{backend} ,id=@var{id} [,mux=on|off] [,@var{options}]
1527 The specific backend will determine the applicable options.
1529 All devices must have an id, which can be any string up to 127 characters long.
1530 It is used to uniquely identify this device in other command line directives.
1532 A character device may be used in multiplexing mode by multiple front-ends.
1533 The key sequence of @key{Control-a} and @key{c} will rotate the input focus
1534 between attached front-ends. Specify @option{mux=on} to enable this mode.
1536 Options to each backend are described below.
1538 @item -chardev null ,id=@var{id}
1539 A void device. This device will not emit any data, and will drop any data it
1540 receives. The null backend does not take any options.
1542 @item -chardev socket ,id=@var{id} [@var{TCP options} or @var{unix options}] [,server] [,nowait] [,telnet]
1544 Create a two-way stream socket, which can be either a TCP or a unix socket. A
1545 unix socket will be created if @option{path} is specified. Behaviour is
1546 undefined if TCP options are specified for a unix socket.
1548 @option{server} specifies that the socket shall be a listening socket.
1550 @option{nowait} specifies that QEMU should not block waiting for a client to
1551 connect to a listening socket.
1553 @option{telnet} specifies that traffic on the socket should interpret telnet
1556 TCP and unix socket options are given below:
1560 @item TCP options: port=@var{port} [,host=@var{host}] [,to=@var{to}] [,ipv4] [,ipv6] [,nodelay]
1562 @option{host} for a listening socket specifies the local address to be bound.
1563 For a connecting socket species the remote host to connect to. @option{host} is
1564 optional for listening sockets. If not specified it defaults to @code{0.0.0.0}.
1566 @option{port} for a listening socket specifies the local port to be bound. For a
1567 connecting socket specifies the port on the remote host to connect to.
1568 @option{port} can be given as either a port number or a service name.
1569 @option{port} is required.
1571 @option{to} is only relevant to listening sockets. If it is specified, and
1572 @option{port} cannot be bound, QEMU will attempt to bind to subsequent ports up
1573 to and including @option{to} until it succeeds. @option{to} must be specified
1576 @option{ipv4} and @option{ipv6} specify that either IPv4 or IPv6 must be used.
1577 If neither is specified the socket may use either protocol.
1579 @option{nodelay} disables the Nagle algorithm.
1581 @item unix options: path=@var{path}
1583 @option{path} specifies the local path of the unix socket. @option{path} is
1588 @item -chardev udp ,id=@var{id} [,host=@var{host}] ,port=@var{port} [,localaddr=@var{localaddr}] [,localport=@var{localport}] [,ipv4] [,ipv6]
1590 Sends all traffic from the guest to a remote host over UDP.
1592 @option{host} specifies the remote host to connect to. If not specified it
1593 defaults to @code{localhost}.
1595 @option{port} specifies the port on the remote host to connect to. @option{port}
1598 @option{localaddr} specifies the local address to bind to. If not specified it
1599 defaults to @code{0.0.0.0}.
1601 @option{localport} specifies the local port to bind to. If not specified any
1602 available local port will be used.
1604 @option{ipv4} and @option{ipv6} specify that either IPv4 or IPv6 must be used.
1605 If neither is specified the device may use either protocol.
1607 @item -chardev msmouse ,id=@var{id}
1609 Forward QEMU's emulated msmouse events to the guest. @option{msmouse} does not
1612 @item -chardev vc ,id=@var{id} [[,width=@var{width}] [,height=@var{height}]] [[,cols=@var{cols}] [,rows=@var{rows}]]
1614 Connect to a QEMU text console. @option{vc} may optionally be given a specific
1617 @option{width} and @option{height} specify the width and height respectively of
1618 the console, in pixels.
1620 @option{cols} and @option{rows} specify that the console be sized to fit a text
1621 console with the given dimensions.
1623 @item -chardev file ,id=@var{id} ,path=@var{path}
1625 Log all traffic received from the guest to a file.
1627 @option{path} specifies the path of the file to be opened. This file will be
1628 created if it does not already exist, and overwritten if it does. @option{path}
1631 @item -chardev pipe ,id=@var{id} ,path=@var{path}
1633 Create a two-way connection to the guest. The behaviour differs slightly between
1634 Windows hosts and other hosts:
1636 On Windows, a single duplex pipe will be created at
1637 @file{\\.pipe\@option{path}}.
1639 On other hosts, 2 pipes will be created called @file{@option{path}.in} and
1640 @file{@option{path}.out}. Data written to @file{@option{path}.in} will be
1641 received by the guest. Data written by the guest can be read from
1642 @file{@option{path}.out}. QEMU will not create these fifos, and requires them to
1645 @option{path} forms part of the pipe path as described above. @option{path} is
1648 @item -chardev console ,id=@var{id}
1650 Send traffic from the guest to QEMU's standard output. @option{console} does not
1653 @option{console} is only available on Windows hosts.
1655 @item -chardev serial ,id=@var{id} ,path=@option{path}
1657 Send traffic from the guest to a serial device on the host.
1660 only available on Windows hosts.
1662 @option{path} specifies the name of the serial device to open.
1664 @item -chardev pty ,id=@var{id}
1666 Create a new pseudo-terminal on the host and connect to it. @option{pty} does
1667 not take any options.
1669 @option{pty} is not available on Windows hosts.
1671 @item -chardev stdio ,id=@var{id} [,signal=on|off]
1672 Connect to standard input and standard output of the qemu process.
1674 @option{signal} controls if signals are enabled on the terminal, that includes
1675 exiting QEMU with the key sequence @key{Control-c}. This option is enabled by
1676 default, use @option{signal=off} to disable it.
1678 @option{stdio} is not available on Windows hosts.
1680 @item -chardev braille ,id=@var{id}
1682 Connect to a local BrlAPI server. @option{braille} does not take any options.
1684 @item -chardev tty ,id=@var{id} ,path=@var{path}
1686 Connect to a local tty device.
1688 @option{tty} is only available on Linux, Sun, FreeBSD, NetBSD, OpenBSD and
1691 @option{path} specifies the path to the tty. @option{path} is required.
1693 @item -chardev parport ,id=@var{id} ,path=@var{path}
1695 @option{parport} is only available on Linux, FreeBSD and DragonFlyBSD hosts.
1697 Connect to a local parallel port.
1699 @option{path} specifies the path to the parallel port device. @option{path} is
1702 #if defined(CONFIG_SPICE)
1703 @item -chardev spicevmc ,id=@var{id} ,debug=@var{debug}, name=@var{name}
1705 @option{debug} debug level for spicevmc
1707 @option{name} name of spice channel to connect to
1709 Connect to a spice virtual machine channel, such as vdiport.
1717 DEFHEADING(Bluetooth(R) options:)
1719 DEF("bt", HAS_ARG, QEMU_OPTION_bt, \
1720 "-bt hci,null dumb bluetooth HCI - doesn't respond to commands\n" \
1721 "-bt hci,host[:id]\n" \
1722 " use host's HCI with the given name\n" \
1723 "-bt hci[,vlan=n]\n" \
1724 " emulate a standard HCI in virtual scatternet 'n'\n" \
1725 "-bt vhci[,vlan=n]\n" \
1726 " add host computer to virtual scatternet 'n' using VHCI\n" \
1727 "-bt device:dev[,vlan=n]\n" \
1728 " emulate a bluetooth device 'dev' in scatternet 'n'\n",
1735 Defines the function of the corresponding Bluetooth HCI. -bt options
1736 are matched with the HCIs present in the chosen machine type. For
1737 example when emulating a machine with only one HCI built into it, only
1738 the first @code{-bt hci[...]} option is valid and defines the HCI's
1739 logic. The Transport Layer is decided by the machine type. Currently
1740 the machines @code{n800} and @code{n810} have one HCI and all other
1744 The following three types are recognized:
1748 (default) The corresponding Bluetooth HCI assumes no internal logic
1749 and will not respond to any HCI commands or emit events.
1751 @item -bt hci,host[:@var{id}]
1752 (@code{bluez} only) The corresponding HCI passes commands / events
1753 to / from the physical HCI identified by the name @var{id} (default:
1754 @code{hci0}) on the computer running QEMU. Only available on @code{bluez}
1755 capable systems like Linux.
1757 @item -bt hci[,vlan=@var{n}]
1758 Add a virtual, standard HCI that will participate in the Bluetooth
1759 scatternet @var{n} (default @code{0}). Similarly to @option{-net}
1760 VLANs, devices inside a bluetooth network @var{n} can only communicate
1761 with other devices in the same network (scatternet).
1764 @item -bt vhci[,vlan=@var{n}]
1765 (Linux-host only) Create a HCI in scatternet @var{n} (default 0) attached
1766 to the host bluetooth stack instead of to the emulated target. This
1767 allows the host and target machines to participate in a common scatternet
1768 and communicate. Requires the Linux @code{vhci} driver installed. Can
1769 be used as following:
1772 qemu [...OPTIONS...] -bt hci,vlan=5 -bt vhci,vlan=5
1775 @item -bt device:@var{dev}[,vlan=@var{n}]
1776 Emulate a bluetooth device @var{dev} and place it in network @var{n}
1777 (default @code{0}). QEMU can only emulate one type of bluetooth devices
1782 Virtual wireless keyboard implementing the HIDP bluetooth profile.
1789 DEFHEADING(Linux/Multiboot boot specific:)
1792 When using these options, you can use a given Linux or Multiboot
1793 kernel without installing it in the disk image. It can be useful
1794 for easier testing of various kernels.
1799 DEF("kernel", HAS_ARG, QEMU_OPTION_kernel, \
1800 "-kernel bzImage use 'bzImage' as kernel image\n", QEMU_ARCH_ALL)
1802 @item -kernel @var{bzImage}
1804 Use @var{bzImage} as kernel image. The kernel can be either a Linux kernel
1805 or in multiboot format.
1808 DEF("append", HAS_ARG, QEMU_OPTION_append, \
1809 "-append cmdline use 'cmdline' as kernel command line\n", QEMU_ARCH_ALL)
1811 @item -append @var{cmdline}
1813 Use @var{cmdline} as kernel command line
1816 DEF("initrd", HAS_ARG, QEMU_OPTION_initrd, \
1817 "-initrd file use 'file' as initial ram disk\n", QEMU_ARCH_ALL)
1819 @item -initrd @var{file}
1821 Use @var{file} as initial ram disk.
1823 @item -initrd "@var{file1} arg=foo,@var{file2}"
1825 This syntax is only available with multiboot.
1827 Use @var{file1} and @var{file2} as modules and pass arg=foo as parameter to the
1837 DEFHEADING(Debug/Expert options:)
1843 DEF("serial", HAS_ARG, QEMU_OPTION_serial, \
1844 "-serial dev redirect the serial port to char device 'dev'\n",
1847 @item -serial @var{dev}
1849 Redirect the virtual serial port to host character device
1850 @var{dev}. The default device is @code{vc} in graphical mode and
1851 @code{stdio} in non graphical mode.
1853 This option can be used several times to simulate up to 4 serial
1856 Use @code{-serial none} to disable all serial ports.
1858 Available character devices are:
1860 @item vc[:@var{W}x@var{H}]
1861 Virtual console. Optionally, a width and height can be given in pixel with
1865 It is also possible to specify width or height in characters:
1870 [Linux only] Pseudo TTY (a new PTY is automatically allocated)
1872 No device is allocated.
1876 [Linux only] Use host tty, e.g. @file{/dev/ttyS0}. The host serial port
1877 parameters are set according to the emulated ones.
1878 @item /dev/parport@var{N}
1879 [Linux only, parallel port only] Use host parallel port
1880 @var{N}. Currently SPP and EPP parallel port features can be used.
1881 @item file:@var{filename}
1882 Write output to @var{filename}. No character can be read.
1884 [Unix only] standard input/output
1885 @item pipe:@var{filename}
1886 name pipe @var{filename}
1888 [Windows only] Use host serial port @var{n}
1889 @item udp:[@var{remote_host}]:@var{remote_port}[@@[@var{src_ip}]:@var{src_port}]
1890 This implements UDP Net Console.
1891 When @var{remote_host} or @var{src_ip} are not specified
1892 they default to @code{0.0.0.0}.
1893 When not using a specified @var{src_port} a random port is automatically chosen.
1895 If you just want a simple readonly console you can use @code{netcat} or
1896 @code{nc}, by starting qemu with: @code{-serial udp::4555} and nc as:
1897 @code{nc -u -l -p 4555}. Any time qemu writes something to that port it
1898 will appear in the netconsole session.
1900 If you plan to send characters back via netconsole or you want to stop
1901 and start qemu a lot of times, you should have qemu use the same
1902 source port each time by using something like @code{-serial
1903 udp::4555@@:4556} to qemu. Another approach is to use a patched
1904 version of netcat which can listen to a TCP port and send and receive
1905 characters via udp. If you have a patched version of netcat which
1906 activates telnet remote echo and single char transfer, then you can
1907 use the following options to step up a netcat redirector to allow
1908 telnet on port 5555 to access the qemu port.
1911 -serial udp::4555@@:4556
1912 @item netcat options:
1913 -u -P 4555 -L 0.0.0.0:4556 -t -p 5555 -I -T
1914 @item telnet options:
1918 @item tcp:[@var{host}]:@var{port}[,@var{server}][,nowait][,nodelay]
1919 The TCP Net Console has two modes of operation. It can send the serial
1920 I/O to a location or wait for a connection from a location. By default
1921 the TCP Net Console is sent to @var{host} at the @var{port}. If you use
1922 the @var{server} option QEMU will wait for a client socket application
1923 to connect to the port before continuing, unless the @code{nowait}
1924 option was specified. The @code{nodelay} option disables the Nagle buffering
1925 algorithm. If @var{host} is omitted, 0.0.0.0 is assumed. Only
1926 one TCP connection at a time is accepted. You can use @code{telnet} to
1927 connect to the corresponding character device.
1929 @item Example to send tcp console to 192.168.0.2 port 4444
1930 -serial tcp:192.168.0.2:4444
1931 @item Example to listen and wait on port 4444 for connection
1932 -serial tcp::4444,server
1933 @item Example to not wait and listen on ip 192.168.0.100 port 4444
1934 -serial tcp:192.168.0.100:4444,server,nowait
1937 @item telnet:@var{host}:@var{port}[,server][,nowait][,nodelay]
1938 The telnet protocol is used instead of raw tcp sockets. The options
1939 work the same as if you had specified @code{-serial tcp}. The
1940 difference is that the port acts like a telnet server or client using
1941 telnet option negotiation. This will also allow you to send the
1942 MAGIC_SYSRQ sequence if you use a telnet that supports sending the break
1943 sequence. Typically in unix telnet you do it with Control-] and then
1944 type "send break" followed by pressing the enter key.
1946 @item unix:@var{path}[,server][,nowait]
1947 A unix domain socket is used instead of a tcp socket. The option works the
1948 same as if you had specified @code{-serial tcp} except the unix domain socket
1949 @var{path} is used for connections.
1951 @item mon:@var{dev_string}
1952 This is a special option to allow the monitor to be multiplexed onto
1953 another serial port. The monitor is accessed with key sequence of
1954 @key{Control-a} and then pressing @key{c}. See monitor access
1955 @ref{pcsys_keys} in the -nographic section for more keys.
1956 @var{dev_string} should be any one of the serial devices specified
1957 above. An example to multiplex the monitor onto a telnet server
1958 listening on port 4444 would be:
1960 @item -serial mon:telnet::4444,server,nowait
1964 Braille device. This will use BrlAPI to display the braille output on a real
1968 Three button serial mouse. Configure the guest to use Microsoft protocol.
1972 DEF("parallel", HAS_ARG, QEMU_OPTION_parallel, \
1973 "-parallel dev redirect the parallel port to char device 'dev'\n",
1976 @item -parallel @var{dev}
1978 Redirect the virtual parallel port to host device @var{dev} (same
1979 devices as the serial port). On Linux hosts, @file{/dev/parportN} can
1980 be used to use hardware devices connected on the corresponding host
1983 This option can be used several times to simulate up to 3 parallel
1986 Use @code{-parallel none} to disable all parallel ports.
1989 DEF("monitor", HAS_ARG, QEMU_OPTION_monitor, \
1990 "-monitor dev redirect the monitor to char device 'dev'\n",
1993 @item -monitor @var{dev}
1995 Redirect the monitor to host device @var{dev} (same devices as the
1997 The default device is @code{vc} in graphical mode and @code{stdio} in
2000 DEF("qmp", HAS_ARG, QEMU_OPTION_qmp, \
2001 "-qmp dev like -monitor but opens in 'control' mode\n",
2004 @item -qmp @var{dev}
2006 Like -monitor but opens in 'control' mode.
2009 DEF("mon", HAS_ARG, QEMU_OPTION_mon, \
2010 "-mon chardev=[name][,mode=readline|control][,default]\n", QEMU_ARCH_ALL)
2012 @item -mon chardev=[name][,mode=readline|control][,default]
2014 Setup monitor on chardev @var{name}.
2017 DEF("debugcon", HAS_ARG, QEMU_OPTION_debugcon, \
2018 "-debugcon dev redirect the debug console to char device 'dev'\n",
2021 @item -debugcon @var{dev}
2023 Redirect the debug console to host device @var{dev} (same devices as the
2024 serial port). The debug console is an I/O port which is typically port
2025 0xe9; writing to that I/O port sends output to this device.
2026 The default device is @code{vc} in graphical mode and @code{stdio} in
2030 DEF("pidfile", HAS_ARG, QEMU_OPTION_pidfile, \
2031 "-pidfile file write PID to 'file'\n", QEMU_ARCH_ALL)
2033 @item -pidfile @var{file}
2035 Store the QEMU process PID in @var{file}. It is useful if you launch QEMU
2039 DEF("singlestep", 0, QEMU_OPTION_singlestep, \
2040 "-singlestep always run in singlestep mode\n", QEMU_ARCH_ALL)
2044 Run the emulation in single step mode.
2047 DEF("S", 0, QEMU_OPTION_S, \
2048 "-S freeze CPU at startup (use 'c' to start execution)\n",
2053 Do not start CPU at startup (you must type 'c' in the monitor).
2056 DEF("gdb", HAS_ARG, QEMU_OPTION_gdb, \
2057 "-gdb dev wait for gdb connection on 'dev'\n", QEMU_ARCH_ALL)
2059 @item -gdb @var{dev}
2061 Wait for gdb connection on device @var{dev} (@pxref{gdb_usage}). Typical
2062 connections will likely be TCP-based, but also UDP, pseudo TTY, or even
2063 stdio are reasonable use case. The latter is allowing to start qemu from
2064 within gdb and establish the connection via a pipe:
2066 (gdb) target remote | exec qemu -gdb stdio ...
2070 DEF("s", 0, QEMU_OPTION_s, \
2071 "-s shorthand for -gdb tcp::" DEFAULT_GDBSTUB_PORT "\n",
2076 Shorthand for -gdb tcp::1234, i.e. open a gdbserver on TCP port 1234
2077 (@pxref{gdb_usage}).
2080 DEF("d", HAS_ARG, QEMU_OPTION_d, \
2081 "-d item1,... output log to /tmp/qemu.log (use -d ? for a list of log items)\n",
2086 Output log in /tmp/qemu.log
2089 DEF("D", HAS_ARG, QEMU_OPTION_D, \
2090 "-D logfile output log to logfile (instead of the default /tmp/qemu.log)\n",
2095 Output log in logfile instead of /tmp/qemu.log
2098 DEF("hdachs", HAS_ARG, QEMU_OPTION_hdachs, \
2099 "-hdachs c,h,s[,t]\n" \
2100 " force hard disk 0 physical geometry and the optional BIOS\n" \
2101 " translation (t=none or lba) (usually qemu can guess them)\n",
2104 @item -hdachs @var{c},@var{h},@var{s},[,@var{t}]
2106 Force hard disk 0 physical geometry (1 <= @var{c} <= 16383, 1 <=
2107 @var{h} <= 16, 1 <= @var{s} <= 63) and optionally force the BIOS
2108 translation mode (@var{t}=none, lba or auto). Usually QEMU can guess
2109 all those parameters. This option is useful for old MS-DOS disk
2113 DEF("L", HAS_ARG, QEMU_OPTION_L, \
2114 "-L path set the directory for the BIOS, VGA BIOS and keymaps\n",
2119 Set the directory for the BIOS, VGA BIOS and keymaps.
2122 DEF("bios", HAS_ARG, QEMU_OPTION_bios, \
2123 "-bios file set the filename for the BIOS\n", QEMU_ARCH_ALL)
2125 @item -bios @var{file}
2127 Set the filename for the BIOS.
2130 DEF("enable-kvm", 0, QEMU_OPTION_enable_kvm, \
2131 "-enable-kvm enable KVM full virtualization support\n", QEMU_ARCH_ALL)
2135 Enable KVM full virtualization support. This option is only available
2136 if KVM support is enabled when compiling.
2139 DEF("xen-domid", HAS_ARG, QEMU_OPTION_xen_domid,
2140 "-xen-domid id specify xen guest domain id\n", QEMU_ARCH_ALL)
2141 DEF("xen-create", 0, QEMU_OPTION_xen_create,
2142 "-xen-create create domain using xen hypercalls, bypassing xend\n"
2143 " warning: should not be used when xend is in use\n",
2145 DEF("xen-attach", 0, QEMU_OPTION_xen_attach,
2146 "-xen-attach attach to existing xen domain\n"
2147 " xend will use this when starting qemu\n",
2150 @item -xen-domid @var{id}
2152 Specify xen guest domain @var{id} (XEN only).
2155 Create domain using xen hypercalls, bypassing xend.
2156 Warning: should not be used when xend is in use (XEN only).
2159 Attach to existing xen domain.
2160 xend will use this when starting qemu (XEN only).
2163 DEF("no-reboot", 0, QEMU_OPTION_no_reboot, \
2164 "-no-reboot exit instead of rebooting\n", QEMU_ARCH_ALL)
2168 Exit instead of rebooting.
2171 DEF("no-shutdown", 0, QEMU_OPTION_no_shutdown, \
2172 "-no-shutdown stop before shutdown\n", QEMU_ARCH_ALL)
2175 @findex -no-shutdown
2176 Don't exit QEMU on guest shutdown, but instead only stop the emulation.
2177 This allows for instance switching to monitor to commit changes to the
2181 DEF("loadvm", HAS_ARG, QEMU_OPTION_loadvm, \
2182 "-loadvm [tag|id]\n" \
2183 " start right away with a saved state (loadvm in monitor)\n",
2186 @item -loadvm @var{file}
2188 Start right away with a saved state (@code{loadvm} in monitor)
2192 DEF("daemonize", 0, QEMU_OPTION_daemonize, \
2193 "-daemonize daemonize QEMU after initializing\n", QEMU_ARCH_ALL)
2198 Daemonize the QEMU process after initialization. QEMU will not detach from
2199 standard IO until it is ready to receive connections on any of its devices.
2200 This option is a useful way for external programs to launch QEMU without having
2201 to cope with initialization race conditions.
2204 DEF("option-rom", HAS_ARG, QEMU_OPTION_option_rom, \
2205 "-option-rom rom load a file, rom, into the option ROM space\n",
2208 @item -option-rom @var{file}
2210 Load the contents of @var{file} as an option ROM.
2211 This option is useful to load things like EtherBoot.
2214 DEF("clock", HAS_ARG, QEMU_OPTION_clock, \
2215 "-clock force the use of the given methods for timer alarm.\n" \
2216 " To see what timers are available use -clock ?\n",
2219 @item -clock @var{method}
2221 Force the use of the given methods for timer alarm. To see what timers
2222 are available use -clock ?.
2225 HXCOMM Options deprecated by -rtc
2226 DEF("localtime", 0, QEMU_OPTION_localtime, "", QEMU_ARCH_ALL)
2227 DEF("startdate", HAS_ARG, QEMU_OPTION_startdate, "", QEMU_ARCH_ALL)
2229 DEF("rtc", HAS_ARG, QEMU_OPTION_rtc, \
2230 "-rtc [base=utc|localtime|date][,clock=host|vm][,driftfix=none|slew]\n" \
2231 " set the RTC base and clock, enable drift fix for clock ticks (x86 only)\n",
2236 @item -rtc [base=utc|localtime|@var{date}][,clock=host|vm][,driftfix=none|slew]
2238 Specify @option{base} as @code{utc} or @code{localtime} to let the RTC start at the current
2239 UTC or local time, respectively. @code{localtime} is required for correct date in
2240 MS-DOS or Windows. To start at a specific point in time, provide @var{date} in the
2241 format @code{2006-06-17T16:01:21} or @code{2006-06-17}. The default base is UTC.
2243 By default the RTC is driven by the host system time. This allows to use the
2244 RTC as accurate reference clock inside the guest, specifically if the host
2245 time is smoothly following an accurate external reference clock, e.g. via NTP.
2246 If you want to isolate the guest time from the host, even prevent it from
2247 progressing during suspension, you can set @option{clock} to @code{vm} instead.
2249 Enable @option{driftfix} (i386 targets only) if you experience time drift problems,
2250 specifically with Windows' ACPI HAL. This option will try to figure out how
2251 many timer interrupts were not processed by the Windows guest and will
2255 DEF("icount", HAS_ARG, QEMU_OPTION_icount, \
2256 "-icount [N|auto]\n" \
2257 " enable virtual instruction counter with 2^N clock ticks per\n" \
2258 " instruction\n", QEMU_ARCH_ALL)
2260 @item -icount [@var{N}|auto]
2262 Enable virtual instruction counter. The virtual cpu will execute one
2263 instruction every 2^@var{N} ns of virtual time. If @code{auto} is specified
2264 then the virtual cpu speed will be automatically adjusted to keep virtual
2265 time within a few seconds of real time.
2267 Note that while this option can give deterministic behavior, it does not
2268 provide cycle accurate emulation. Modern CPUs contain superscalar out of
2269 order cores with complex cache hierarchies. The number of instructions
2270 executed often has little or no correlation with actual performance.
2273 DEF("watchdog", HAS_ARG, QEMU_OPTION_watchdog, \
2274 "-watchdog i6300esb|ib700\n" \
2275 " enable virtual hardware watchdog [default=none]\n",
2278 @item -watchdog @var{model}
2280 Create a virtual hardware watchdog device. Once enabled (by a guest
2281 action), the watchdog must be periodically polled by an agent inside
2282 the guest or else the guest will be restarted.
2284 The @var{model} is the model of hardware watchdog to emulate. Choices
2285 for model are: @code{ib700} (iBASE 700) which is a very simple ISA
2286 watchdog with a single timer, or @code{i6300esb} (Intel 6300ESB I/O
2287 controller hub) which is a much more featureful PCI-based dual-timer
2288 watchdog. Choose a model for which your guest has drivers.
2290 Use @code{-watchdog ?} to list available hardware models. Only one
2291 watchdog can be enabled for a guest.
2294 DEF("watchdog-action", HAS_ARG, QEMU_OPTION_watchdog_action, \
2295 "-watchdog-action reset|shutdown|poweroff|pause|debug|none\n" \
2296 " action when watchdog fires [default=reset]\n",
2299 @item -watchdog-action @var{action}
2301 The @var{action} controls what QEMU will do when the watchdog timer
2304 @code{reset} (forcefully reset the guest).
2305 Other possible actions are:
2306 @code{shutdown} (attempt to gracefully shutdown the guest),
2307 @code{poweroff} (forcefully poweroff the guest),
2308 @code{pause} (pause the guest),
2309 @code{debug} (print a debug message and continue), or
2310 @code{none} (do nothing).
2312 Note that the @code{shutdown} action requires that the guest responds
2313 to ACPI signals, which it may not be able to do in the sort of
2314 situations where the watchdog would have expired, and thus
2315 @code{-watchdog-action shutdown} is not recommended for production use.
2320 @item -watchdog i6300esb -watchdog-action pause
2321 @item -watchdog ib700
2325 DEF("echr", HAS_ARG, QEMU_OPTION_echr, \
2326 "-echr chr set terminal escape character instead of ctrl-a\n",
2330 @item -echr @var{numeric_ascii_value}
2332 Change the escape character used for switching to the monitor when using
2333 monitor and serial sharing. The default is @code{0x01} when using the
2334 @code{-nographic} option. @code{0x01} is equal to pressing
2335 @code{Control-a}. You can select a different character from the ascii
2336 control keys where 1 through 26 map to Control-a through Control-z. For
2337 instance you could use the either of the following to change the escape
2338 character to Control-t.
2345 DEF("virtioconsole", HAS_ARG, QEMU_OPTION_virtiocon, \
2346 "-virtioconsole c\n" \
2347 " set virtio console\n", QEMU_ARCH_ALL)
2349 @item -virtioconsole @var{c}
2350 @findex -virtioconsole
2353 This option is maintained for backward compatibility.
2355 Please use @code{-device virtconsole} for the new way of invocation.
2358 DEF("show-cursor", 0, QEMU_OPTION_show_cursor, \
2359 "-show-cursor show cursor\n", QEMU_ARCH_ALL)
2362 @findex -show-cursor
2366 DEF("tb-size", HAS_ARG, QEMU_OPTION_tb_size, \
2367 "-tb-size n set TB size\n", QEMU_ARCH_ALL)
2369 @item -tb-size @var{n}
2374 DEF("incoming", HAS_ARG, QEMU_OPTION_incoming, \
2375 "-incoming p prepare for incoming migration, listen on port p\n",
2378 @item -incoming @var{port}
2380 Prepare for incoming migration, listen on @var{port}.
2383 DEF("nodefaults", 0, QEMU_OPTION_nodefaults, \
2384 "-nodefaults don't create default devices\n", QEMU_ARCH_ALL)
2388 Don't create default devices.
2392 DEF("chroot", HAS_ARG, QEMU_OPTION_chroot, \
2393 "-chroot dir chroot to dir just before starting the VM\n",
2397 @item -chroot @var{dir}
2399 Immediately before starting guest execution, chroot to the specified
2400 directory. Especially useful in combination with -runas.
2404 DEF("runas", HAS_ARG, QEMU_OPTION_runas, \
2405 "-runas user change to user id user just before starting the VM\n",
2409 @item -runas @var{user}
2411 Immediately before starting guest execution, drop root privileges, switching
2412 to the specified user.
2415 DEF("prom-env", HAS_ARG, QEMU_OPTION_prom_env,
2416 "-prom-env variable=value\n"
2417 " set OpenBIOS nvram variables\n",
2418 QEMU_ARCH_PPC | QEMU_ARCH_SPARC)
2420 @item -prom-env @var{variable}=@var{value}
2422 Set OpenBIOS nvram @var{variable} to given @var{value} (PPC, SPARC only).
2424 DEF("semihosting", 0, QEMU_OPTION_semihosting,
2425 "-semihosting semihosting mode\n", QEMU_ARCH_ARM | QEMU_ARCH_M68K | QEMU_ARCH_XTENSA)
2428 @findex -semihosting
2429 Semihosting mode (ARM, M68K, Xtensa only).
2431 DEF("old-param", 0, QEMU_OPTION_old_param,
2432 "-old-param old param mode\n", QEMU_ARCH_ARM)
2435 @findex -old-param (ARM)
2436 Old param mode (ARM only).
2439 DEF("readconfig", HAS_ARG, QEMU_OPTION_readconfig,
2440 "-readconfig <file>\n", QEMU_ARCH_ALL)
2442 @item -readconfig @var{file}
2444 Read device configuration from @var{file}.
2446 DEF("writeconfig", HAS_ARG, QEMU_OPTION_writeconfig,
2447 "-writeconfig <file>\n"
2448 " read/write config file\n", QEMU_ARCH_ALL)
2450 @item -writeconfig @var{file}
2451 @findex -writeconfig
2452 Write device configuration to @var{file}.
2454 DEF("nodefconfig", 0, QEMU_OPTION_nodefconfig,
2456 " do not load default config files at startup\n",
2460 @findex -nodefconfig
2461 Normally QEMU loads a configuration file from @var{sysconfdir}/qemu.conf and
2462 @var{sysconfdir}/target-@var{ARCH}.conf on startup. The @code{-nodefconfig}
2463 option will prevent QEMU from loading these configuration files at startup.
2465 DEF("trace", HAS_ARG, QEMU_OPTION_trace,
2466 "-trace [events=<file>][,file=<file>]\n"
2467 " specify tracing options\n",
2470 HXCOMM This line is not accurate, as some sub-options are backend-specific but
2471 HXCOMM HX does not support conditional compilation of text.
2472 @item -trace [events=@var{file}][,file=@var{file}]
2475 Specify tracing options.
2478 @item events=@var{file}
2479 Immediately enable events listed in @var{file}.
2480 The file must contain one event name (as listed in the @var{trace-events} file)
2482 This option is only available if QEMU has been compiled with
2483 either @var{simple} or @var{stderr} tracing backend.
2484 @item file=@var{file}
2485 Log output traces to @var{file}.
2487 This option is only available if QEMU has been compiled with
2488 the @var{simple} tracing backend.
2492 HXCOMM This is the last statement. Insert new options before this line!