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][,readonly]\n",
536 @item -fsdev @var{fsdriver},id=@var{id},path=@var{path},[security_model=@var{security_model}][,writeout=@var{writeout}][,readonly]
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. Security model is mandatory
559 only for local fsdriver. Other fsdrivers (like handle) don't take
560 security model as a parameter.
561 @item writeout=@var{writeout}
562 This is an optional argument. The only supported value is "immediate".
563 This means that host page cache will be used to read and write data but
564 write notification will be sent to the guest only when the data has been
565 reported as written by the storage subsystem.
567 Enables exporting 9p share as a readonly mount for guests. By default
568 read-write access is given.
571 -fsdev option is used along with -device driver "virtio-9p-pci".
572 @item -device virtio-9p-pci,fsdev=@var{id},mount_tag=@var{mount_tag}
573 Options for virtio-9p-pci driver are:
576 Specifies the id value specified along with -fsdev option
577 @item mount_tag=@var{mount_tag}
578 Specifies the tag name to be used by the guest to mount this export point
585 DEFHEADING(Virtual File system pass-through options:)
587 DEF("virtfs", HAS_ARG, QEMU_OPTION_virtfs,
588 "-virtfs local,path=path,mount_tag=tag,security_model=[mapped|passthrough|none]\n"
589 " [,writeout=immediate][,readonly]\n",
594 @item -virtfs @var{fsdriver},path=@var{path},mount_tag=@var{mount_tag},security_model=@var{security_model}[,writeout=@var{writeout}][,readonly]
597 The general form of a Virtual File system pass-through options are:
600 This option specifies the fs driver backend to use.
601 Currently "local" and "handle" file system drivers are supported.
603 Specifies identifier for this device
604 @item path=@var{path}
605 Specifies the export path for the file system device. Files under
606 this path will be available to the 9p client on the guest.
607 @item security_model=@var{security_model}
608 Specifies the security model to be used for this export path.
609 Supported security models are "passthrough", "mapped" and "none".
610 In "passthrough" security model, files are stored using the same
611 credentials as they are created on the guest. This requires qemu
612 to run as root. In "mapped" security model, some of the file
613 attributes like uid, gid, mode bits and link target are stored as
614 file attributes. Directories exported by this security model cannot
615 interact with other unix tools. "none" security model is same as
616 passthrough except the sever won't report failures if it fails to
617 set file attributes like ownership. Security model is mandatory only
618 for local fsdriver. Other fsdrivers (like handle) don't take security
619 model as a parameter.
620 @item writeout=@var{writeout}
621 This is an optional argument. The only supported value is "immediate".
622 This means that host page cache will be used to read and write data but
623 write notification will be sent to the guest only when the data has been
624 reported as written by the storage subsystem.
626 Enables exporting 9p share as a readonly mount for guests. By default
627 read-write access is given.
633 DEF("name", HAS_ARG, QEMU_OPTION_name,
634 "-name string1[,process=string2]\n"
635 " set the name of the guest\n"
636 " string1 sets the window title and string2 the process name (on Linux)\n",
639 @item -name @var{name}
641 Sets the @var{name} of the guest.
642 This name will be displayed in the SDL window caption.
643 The @var{name} will also be used for the VNC server.
644 Also optionally set the top visible process name in Linux.
647 DEF("uuid", HAS_ARG, QEMU_OPTION_uuid,
648 "-uuid %08x-%04x-%04x-%04x-%012x\n"
649 " specify machine UUID\n", QEMU_ARCH_ALL)
651 @item -uuid @var{uuid}
662 DEFHEADING(Display options:)
668 DEF("display", HAS_ARG, QEMU_OPTION_display,
669 "-display sdl[,frame=on|off][,alt_grab=on|off][,ctrl_grab=on|off]\n"
670 " [,window_close=on|off]|curses|none|\n"
671 " vnc=<display>[,<optargs>]\n"
672 " select display type\n", QEMU_ARCH_ALL)
674 @item -display @var{type}
676 Select type of display to use. This option is a replacement for the
677 old style -sdl/-curses/... options. Valid values for @var{type} are
680 Display video output via SDL (usually in a separate graphics
681 window; see the SDL documentation for other possibilities).
683 Display video output via curses. For graphics device models which
684 support a text mode, QEMU can display this output using a
685 curses/ncurses interface. Nothing is displayed when the graphics
686 device is in graphical mode or if the graphics device does not support
687 a text mode. Generally only the VGA device models support text mode.
689 Do not display video output. The guest will still see an emulated
690 graphics card, but its output will not be displayed to the QEMU
691 user. This option differs from the -nographic option in that it
692 only affects what is done with video output; -nographic also changes
693 the destination of the serial and parallel port data.
695 Start a VNC server on display <arg>
699 DEF("nographic", 0, QEMU_OPTION_nographic,
700 "-nographic disable graphical output and redirect serial I/Os to console\n",
705 Normally, QEMU uses SDL to display the VGA output. With this option,
706 you can totally disable graphical output so that QEMU is a simple
707 command line application. The emulated serial port is redirected on
708 the console. Therefore, you can still use QEMU to debug a Linux kernel
709 with a serial console.
712 DEF("curses", 0, QEMU_OPTION_curses,
713 "-curses use a curses/ncurses interface instead of SDL\n",
718 Normally, QEMU uses SDL to display the VGA output. With this option,
719 QEMU can display the VGA output when in text mode using a
720 curses/ncurses interface. Nothing is displayed in graphical mode.
723 DEF("no-frame", 0, QEMU_OPTION_no_frame,
724 "-no-frame open SDL window without a frame and window decorations\n",
729 Do not use decorations for SDL windows and start them using the whole
730 available screen space. This makes the using QEMU in a dedicated desktop
731 workspace more convenient.
734 DEF("alt-grab", 0, QEMU_OPTION_alt_grab,
735 "-alt-grab use Ctrl-Alt-Shift to grab mouse (instead of Ctrl-Alt)\n",
740 Use Ctrl-Alt-Shift to grab mouse (instead of Ctrl-Alt). Note that this also
741 affects the special keys (for fullscreen, monitor-mode switching, etc).
744 DEF("ctrl-grab", 0, QEMU_OPTION_ctrl_grab,
745 "-ctrl-grab use Right-Ctrl to grab mouse (instead of Ctrl-Alt)\n",
750 Use Right-Ctrl to grab mouse (instead of Ctrl-Alt). Note that this also
751 affects the special keys (for fullscreen, monitor-mode switching, etc).
754 DEF("no-quit", 0, QEMU_OPTION_no_quit,
755 "-no-quit disable SDL window close capability\n", QEMU_ARCH_ALL)
759 Disable SDL window close capability.
762 DEF("sdl", 0, QEMU_OPTION_sdl,
763 "-sdl enable SDL\n", QEMU_ARCH_ALL)
770 DEF("spice", HAS_ARG, QEMU_OPTION_spice,
771 "-spice <args> enable spice\n", QEMU_ARCH_ALL)
773 @item -spice @var{option}[,@var{option}[,...]]
775 Enable the spice remote desktop protocol. Valid options are
780 Set the TCP port spice is listening on for plaintext channels.
783 Set the IP address spice is listening on. Default is any address.
787 Force using the specified IP version.
789 @item password=<secret>
790 Set the password you need to authenticate.
793 Require that the client use SASL to authenticate with the spice.
794 The exact choice of authentication method used is controlled from the
795 system / user's SASL configuration file for the 'qemu' service. This
796 is typically found in /etc/sasl2/qemu.conf. If running QEMU as an
797 unprivileged user, an environment variable SASL_CONF_PATH can be used
798 to make it search alternate locations for the service config.
799 While some SASL auth methods can also provide data encryption (eg GSSAPI),
800 it is recommended that SASL always be combined with the 'tls' and
801 'x509' settings to enable use of SSL and server certificates. This
802 ensures a data encryption preventing compromise of authentication
805 @item disable-ticketing
806 Allow client connects without authentication.
808 @item disable-copy-paste
809 Disable copy paste between the client and the guest.
812 Set the TCP port spice is listening on for encrypted channels.
815 Set the x509 file directory. Expects same filenames as -vnc $display,x509=$dir
817 @item x509-key-file=<file>
818 @item x509-key-password=<file>
819 @item x509-cert-file=<file>
820 @item x509-cacert-file=<file>
821 @item x509-dh-key-file=<file>
822 The x509 file names can also be configured individually.
824 @item tls-ciphers=<list>
825 Specify which ciphers to use.
827 @item tls-channel=[main|display|inputs|record|playback|tunnel]
828 @item plaintext-channel=[main|display|inputs|record|playback|tunnel]
829 Force specific channel to be used with or without TLS encryption. The
830 options can be specified multiple times to configure multiple
831 channels. The special name "default" can be used to set the default
832 mode. For channels which are not explicitly forced into one mode the
833 spice client is allowed to pick tls/plaintext as he pleases.
835 @item image-compression=[auto_glz|auto_lz|quic|glz|lz|off]
836 Configure image compression (lossless).
839 @item jpeg-wan-compression=[auto|never|always]
840 @item zlib-glz-wan-compression=[auto|never|always]
841 Configure wan image compression (lossy for slow links).
844 @item streaming-video=[off|all|filter]
845 Configure video stream detection. Default is filter.
847 @item agent-mouse=[on|off]
848 Enable/disable passing mouse events via vdagent. Default is on.
850 @item playback-compression=[on|off]
851 Enable/disable audio stream compression (using celt 0.5.1). Default is on.
856 DEF("portrait", 0, QEMU_OPTION_portrait,
857 "-portrait rotate graphical output 90 deg left (only PXA LCD)\n",
862 Rotate graphical output 90 deg left (only PXA LCD).
865 DEF("rotate", HAS_ARG, QEMU_OPTION_rotate,
866 "-rotate <deg> rotate graphical output some deg left (only PXA LCD)\n",
871 Rotate graphical output some deg left (only PXA LCD).
874 DEF("vga", HAS_ARG, QEMU_OPTION_vga,
875 "-vga [std|cirrus|vmware|qxl|xenfb|none]\n"
876 " select video card type\n", QEMU_ARCH_ALL)
878 @item -vga @var{type}
880 Select type of VGA card to emulate. Valid values for @var{type} are
883 Cirrus Logic GD5446 Video card. All Windows versions starting from
884 Windows 95 should recognize and use this graphic card. For optimal
885 performances, use 16 bit color depth in the guest and the host OS.
886 (This one is the default)
888 Standard VGA card with Bochs VBE extensions. If your guest OS
889 supports the VESA 2.0 VBE extensions (e.g. Windows XP) and if you want
890 to use high resolution modes (>= 1280x1024x16) then you should use
893 VMWare SVGA-II compatible adapter. Use it if you have sufficiently
894 recent XFree86/XOrg server or Windows guest with a driver for this
897 QXL paravirtual graphic card. It is VGA compatible (including VESA
898 2.0 VBE support). Works best with qxl guest drivers installed though.
899 Recommended choice when using the spice protocol.
905 DEF("full-screen", 0, QEMU_OPTION_full_screen,
906 "-full-screen start in full screen\n", QEMU_ARCH_ALL)
910 Start in full screen.
913 DEF("g", 1, QEMU_OPTION_g ,
914 "-g WxH[xDEPTH] Set the initial graphical resolution and depth\n",
915 QEMU_ARCH_PPC | QEMU_ARCH_SPARC)
917 @item -g @var{width}x@var{height}[x@var{depth}]
919 Set the initial graphical resolution and depth (PPC, SPARC only).
922 DEF("vnc", HAS_ARG, QEMU_OPTION_vnc ,
923 "-vnc display start a VNC server on display\n", QEMU_ARCH_ALL)
925 @item -vnc @var{display}[,@var{option}[,@var{option}[,...]]]
927 Normally, QEMU uses SDL to display the VGA output. With this option,
928 you can have QEMU listen on VNC display @var{display} and redirect the VGA
929 display over the VNC session. It is very useful to enable the usb
930 tablet device when using this option (option @option{-usbdevice
931 tablet}). When using the VNC display, you must use the @option{-k}
932 parameter to set the keyboard layout if you are not using en-us. Valid
933 syntax for the @var{display} is
937 @item @var{host}:@var{d}
939 TCP connections will only be allowed from @var{host} on display @var{d}.
940 By convention the TCP port is 5900+@var{d}. Optionally, @var{host} can
941 be omitted in which case the server will accept connections from any host.
943 @item unix:@var{path}
945 Connections will be allowed over UNIX domain sockets where @var{path} is the
946 location of a unix socket to listen for connections on.
950 VNC is initialized but not started. The monitor @code{change} command
951 can be used to later start the VNC server.
955 Following the @var{display} value there may be one or more @var{option} flags
956 separated by commas. Valid options are
962 Connect to a listening VNC client via a ``reverse'' connection. The
963 client is specified by the @var{display}. For reverse network
964 connections (@var{host}:@var{d},@code{reverse}), the @var{d} argument
965 is a TCP port number, not a display number.
969 Require that password based authentication is used for client connections.
970 The password must be set separately using the @code{change} command in the
975 Require that client use TLS when communicating with the VNC server. This
976 uses anonymous TLS credentials so is susceptible to a man-in-the-middle
977 attack. It is recommended that this option be combined with either the
978 @option{x509} or @option{x509verify} options.
980 @item x509=@var{/path/to/certificate/dir}
982 Valid if @option{tls} is specified. Require that x509 credentials are used
983 for negotiating the TLS session. The server will send its x509 certificate
984 to the client. It is recommended that a password be set on the VNC server
985 to provide authentication of the client when this is used. The path following
986 this option specifies where the x509 certificates are to be loaded from.
987 See the @ref{vnc_security} section for details on generating certificates.
989 @item x509verify=@var{/path/to/certificate/dir}
991 Valid if @option{tls} is specified. Require that x509 credentials are used
992 for negotiating the TLS session. The server will send its x509 certificate
993 to the client, and request that the client send its own x509 certificate.
994 The server will validate the client's certificate against the CA certificate,
995 and reject clients when validation fails. If the certificate authority is
996 trusted, this is a sufficient authentication mechanism. You may still wish
997 to set a password on the VNC server as a second authentication layer. The
998 path following this option specifies where the x509 certificates are to
999 be loaded from. See the @ref{vnc_security} section for details on generating
1004 Require that the client use SASL to authenticate with the VNC server.
1005 The exact choice of authentication method used is controlled from the
1006 system / user's SASL configuration file for the 'qemu' service. This
1007 is typically found in /etc/sasl2/qemu.conf. If running QEMU as an
1008 unprivileged user, an environment variable SASL_CONF_PATH can be used
1009 to make it search alternate locations for the service config.
1010 While some SASL auth methods can also provide data encryption (eg GSSAPI),
1011 it is recommended that SASL always be combined with the 'tls' and
1012 'x509' settings to enable use of SSL and server certificates. This
1013 ensures a data encryption preventing compromise of authentication
1014 credentials. See the @ref{vnc_security} section for details on using
1015 SASL authentication.
1019 Turn on access control lists for checking of the x509 client certificate
1020 and SASL party. For x509 certs, the ACL check is made against the
1021 certificate's distinguished name. This is something that looks like
1022 @code{C=GB,O=ACME,L=Boston,CN=bob}. For SASL party, the ACL check is
1023 made against the username, which depending on the SASL plugin, may
1024 include a realm component, eg @code{bob} or @code{bob@@EXAMPLE.COM}.
1025 When the @option{acl} flag is set, the initial access list will be
1026 empty, with a @code{deny} policy. Thus no one will be allowed to
1027 use the VNC server until the ACLs have been loaded. This can be
1028 achieved using the @code{acl} monitor command.
1032 Enable lossy compression methods (gradient, JPEG, ...). If this
1033 option is set, VNC client may receive lossy framebuffer updates
1034 depending on its encoding settings. Enabling this option can save
1035 a lot of bandwidth at the expense of quality.
1039 Disable adaptive encodings. Adaptive encodings are enabled by default.
1040 An adaptive encoding will try to detect frequently updated screen regions,
1041 and send updates in these regions using a lossy encoding (like JPEG).
1042 This can be really helpful to save bandwidth when playing videos. Disabling
1043 adaptive encodings allows to restore the original static behavior of encodings
1055 DEFHEADING(i386 target only:)
1060 DEF("win2k-hack", 0, QEMU_OPTION_win2k_hack,
1061 "-win2k-hack use it when installing Windows 2000 to avoid a disk full bug\n",
1066 Use it when installing Windows 2000 to avoid a disk full bug. After
1067 Windows 2000 is installed, you no longer need this option (this option
1068 slows down the IDE transfers).
1071 HXCOMM Deprecated by -rtc
1072 DEF("rtc-td-hack", 0, QEMU_OPTION_rtc_td_hack, "", QEMU_ARCH_I386)
1074 DEF("no-fd-bootchk", 0, QEMU_OPTION_no_fd_bootchk,
1075 "-no-fd-bootchk disable boot signature checking for floppy disks\n",
1078 @item -no-fd-bootchk
1079 @findex -no-fd-bootchk
1080 Disable boot signature checking for floppy disks in Bochs BIOS. It may
1081 be needed to boot from old floppy disks.
1082 TODO: check reference to Bochs BIOS.
1085 DEF("no-acpi", 0, QEMU_OPTION_no_acpi,
1086 "-no-acpi disable ACPI\n", QEMU_ARCH_I386)
1090 Disable ACPI (Advanced Configuration and Power Interface) support. Use
1091 it if your guest OS complains about ACPI problems (PC target machine
1095 DEF("no-hpet", 0, QEMU_OPTION_no_hpet,
1096 "-no-hpet disable HPET\n", QEMU_ARCH_I386)
1100 Disable HPET support.
1103 DEF("balloon", HAS_ARG, QEMU_OPTION_balloon,
1104 "-balloon none disable balloon device\n"
1105 "-balloon virtio[,addr=str]\n"
1106 " enable virtio balloon device (default)\n", QEMU_ARCH_ALL)
1110 Disable balloon device.
1111 @item -balloon virtio[,addr=@var{addr}]
1112 Enable virtio balloon device (default), optionally with PCI address
1116 DEF("acpitable", HAS_ARG, QEMU_OPTION_acpitable,
1117 "-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"
1118 " ACPI table description\n", QEMU_ARCH_I386)
1120 @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}]...]
1122 Add ACPI table with specified header fields and context from specified files.
1123 For file=, take whole ACPI table from the specified files, including all
1124 ACPI headers (possible overridden by other options).
1125 For data=, only data
1126 portion of the table is used, all header information is specified in the
1130 DEF("smbios", HAS_ARG, QEMU_OPTION_smbios,
1131 "-smbios file=binary\n"
1132 " load SMBIOS entry from binary file\n"
1133 "-smbios type=0[,vendor=str][,version=str][,date=str][,release=%d.%d]\n"
1134 " specify SMBIOS type 0 fields\n"
1135 "-smbios type=1[,manufacturer=str][,product=str][,version=str][,serial=str]\n"
1136 " [,uuid=uuid][,sku=str][,family=str]\n"
1137 " specify SMBIOS type 1 fields\n", QEMU_ARCH_I386)
1139 @item -smbios file=@var{binary}
1141 Load SMBIOS entry from binary file.
1143 @item -smbios type=0[,vendor=@var{str}][,version=@var{str}][,date=@var{str}][,release=@var{%d.%d}]
1145 Specify SMBIOS type 0 fields
1147 @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}]
1148 Specify SMBIOS type 1 fields
1156 DEFHEADING(Network options:)
1161 HXCOMM Legacy slirp options (now moved to -net user):
1163 DEF("tftp", HAS_ARG, QEMU_OPTION_tftp, "", QEMU_ARCH_ALL)
1164 DEF("bootp", HAS_ARG, QEMU_OPTION_bootp, "", QEMU_ARCH_ALL)
1165 DEF("redir", HAS_ARG, QEMU_OPTION_redir, "", QEMU_ARCH_ALL)
1167 DEF("smb", HAS_ARG, QEMU_OPTION_smb, "", QEMU_ARCH_ALL)
1171 DEF("net", HAS_ARG, QEMU_OPTION_net,
1172 "-net nic[,vlan=n][,macaddr=mac][,model=type][,name=str][,addr=str][,vectors=v]\n"
1173 " create a new Network Interface Card and connect it to VLAN 'n'\n"
1175 "-net user[,vlan=n][,name=str][,net=addr[/mask]][,host=addr][,restrict=on|off]\n"
1176 " [,hostname=host][,dhcpstart=addr][,dns=addr][,tftp=dir][,bootfile=f]\n"
1177 " [,hostfwd=rule][,guestfwd=rule]"
1179 "[,smb=dir[,smbserver=addr]]\n"
1181 " connect the user mode network stack to VLAN 'n', configure its\n"
1182 " DHCP server and enabled optional services\n"
1185 "-net tap[,vlan=n][,name=str],ifname=name\n"
1186 " connect the host TAP network interface to VLAN 'n'\n"
1188 "-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"
1189 " connect the host TAP network interface to VLAN 'n' and use the\n"
1190 " network scripts 'file' (default=" DEFAULT_NETWORK_SCRIPT ")\n"
1191 " and 'dfile' (default=" DEFAULT_NETWORK_DOWN_SCRIPT ")\n"
1192 " use '[down]script=no' to disable script execution\n"
1193 " use 'fd=h' to connect to an already opened TAP interface\n"
1194 " use 'sndbuf=nbytes' to limit the size of the send buffer (the\n"
1195 " default is disabled 'sndbuf=0' to enable flow control set 'sndbuf=1048576')\n"
1196 " use vnet_hdr=off to avoid enabling the IFF_VNET_HDR tap flag\n"
1197 " use vnet_hdr=on to make the lack of IFF_VNET_HDR support an error condition\n"
1198 " use vhost=on to enable experimental in kernel accelerator\n"
1199 " (only has effect for virtio guests which use MSIX)\n"
1200 " use vhostforce=on to force vhost on for non-MSIX virtio guests\n"
1201 " use 'vhostfd=h' to connect to an already opened vhost net device\n"
1203 "-net socket[,vlan=n][,name=str][,fd=h][,listen=[host]:port][,connect=host:port]\n"
1204 " connect the vlan 'n' to another VLAN using a socket connection\n"
1205 "-net socket[,vlan=n][,name=str][,fd=h][,mcast=maddr:port[,localaddr=addr]]\n"
1206 " connect the vlan 'n' to multicast maddr and port\n"
1207 " use 'localaddr=addr' to specify the host address to send packets from\n"
1209 "-net vde[,vlan=n][,name=str][,sock=socketpath][,port=n][,group=groupname][,mode=octalmode]\n"
1210 " connect the vlan 'n' to port 'n' of a vde switch running\n"
1211 " on host and listening for incoming connections on 'socketpath'.\n"
1212 " Use group 'groupname' and mode 'octalmode' to change default\n"
1213 " ownership and permissions for communication port.\n"
1215 "-net dump[,vlan=n][,file=f][,len=n]\n"
1216 " dump traffic on vlan 'n' to file 'f' (max n bytes per packet)\n"
1217 "-net none use it alone to have zero network devices. If no -net option\n"
1218 " is provided, the default is '-net nic -net user'\n", QEMU_ARCH_ALL)
1219 DEF("netdev", HAS_ARG, QEMU_OPTION_netdev,
1228 "socket],id=str[,option][,option][,...]\n", QEMU_ARCH_ALL)
1230 @item -net nic[,vlan=@var{n}][,macaddr=@var{mac}][,model=@var{type}] [,name=@var{name}][,addr=@var{addr}][,vectors=@var{v}]
1232 Create a new Network Interface Card and connect it to VLAN @var{n} (@var{n}
1233 = 0 is the default). The NIC is an e1000 by default on the PC
1234 target. Optionally, the MAC address can be changed to @var{mac}, the
1235 device address set to @var{addr} (PCI cards only),
1236 and a @var{name} can be assigned for use in monitor commands.
1237 Optionally, for PCI cards, you can specify the number @var{v} of MSI-X vectors
1238 that the card should have; this option currently only affects virtio cards; set
1239 @var{v} = 0 to disable MSI-X. If no @option{-net} option is specified, a single
1240 NIC is created. Qemu can emulate several different models of network card.
1241 Valid values for @var{type} are
1242 @code{virtio}, @code{i82551}, @code{i82557b}, @code{i82559er},
1243 @code{ne2k_pci}, @code{ne2k_isa}, @code{pcnet}, @code{rtl8139},
1244 @code{e1000}, @code{smc91c111}, @code{lance} and @code{mcf_fec}.
1245 Not all devices are supported on all targets. Use -net nic,model=?
1246 for a list of available devices for your target.
1248 @item -net user[,@var{option}][,@var{option}][,...]
1249 Use the user mode network stack which requires no administrator
1250 privilege to run. Valid options are:
1254 Connect user mode stack to VLAN @var{n} (@var{n} = 0 is the default).
1256 @item name=@var{name}
1257 Assign symbolic name for use in monitor commands.
1259 @item net=@var{addr}[/@var{mask}]
1260 Set IP network address the guest will see. Optionally specify the netmask,
1261 either in the form a.b.c.d or as number of valid top-most bits. Default is
1264 @item host=@var{addr}
1265 Specify the guest-visible address of the host. Default is the 2nd IP in the
1266 guest network, i.e. x.x.x.2.
1268 @item restrict=on|off
1269 If this option is enabled, the guest will be isolated, i.e. it will not be
1270 able to contact the host and no guest IP packets will be routed over the host
1271 to the outside. This option does not affect any explicitly set forwarding rules.
1273 @item hostname=@var{name}
1274 Specifies the client hostname reported by the builtin DHCP server.
1276 @item dhcpstart=@var{addr}
1277 Specify the first of the 16 IPs the built-in DHCP server can assign. Default
1278 is the 15th to 31st IP in the guest network, i.e. x.x.x.15 to x.x.x.31.
1280 @item dns=@var{addr}
1281 Specify the guest-visible address of the virtual nameserver. The address must
1282 be different from the host address. Default is the 3rd IP in the guest network,
1285 @item tftp=@var{dir}
1286 When using the user mode network stack, activate a built-in TFTP
1287 server. The files in @var{dir} will be exposed as the root of a TFTP server.
1288 The TFTP client on the guest must be configured in binary mode (use the command
1289 @code{bin} of the Unix TFTP client).
1291 @item bootfile=@var{file}
1292 When using the user mode network stack, broadcast @var{file} as the BOOTP
1293 filename. In conjunction with @option{tftp}, this can be used to network boot
1294 a guest from a local directory.
1296 Example (using pxelinux):
1298 qemu -hda linux.img -boot n -net user,tftp=/path/to/tftp/files,bootfile=/pxelinux.0
1301 @item smb=@var{dir}[,smbserver=@var{addr}]
1302 When using the user mode network stack, activate a built-in SMB
1303 server so that Windows OSes can access to the host files in @file{@var{dir}}
1304 transparently. The IP address of the SMB server can be set to @var{addr}. By
1305 default the 4th IP in the guest network is used, i.e. x.x.x.4.
1307 In the guest Windows OS, the line:
1311 must be added in the file @file{C:\WINDOWS\LMHOSTS} (for windows 9x/Me)
1312 or @file{C:\WINNT\SYSTEM32\DRIVERS\ETC\LMHOSTS} (Windows NT/2000).
1314 Then @file{@var{dir}} can be accessed in @file{\\smbserver\qemu}.
1316 Note that a SAMBA server must be installed on the host OS.
1317 QEMU was tested successfully with smbd versions from Red Hat 9,
1318 Fedora Core 3 and OpenSUSE 11.x.
1320 @item hostfwd=[tcp|udp]:[@var{hostaddr}]:@var{hostport}-[@var{guestaddr}]:@var{guestport}
1321 Redirect incoming TCP or UDP connections to the host port @var{hostport} to
1322 the guest IP address @var{guestaddr} on guest port @var{guestport}. If
1323 @var{guestaddr} is not specified, its value is x.x.x.15 (default first address
1324 given by the built-in DHCP server). By specifying @var{hostaddr}, the rule can
1325 be bound to a specific host interface. If no connection type is set, TCP is
1326 used. This option can be given multiple times.
1328 For example, to redirect host X11 connection from screen 1 to guest
1329 screen 0, use the following:
1333 qemu -net user,hostfwd=tcp:127.0.0.1:6001-:6000 [...]
1334 # this host xterm should open in the guest X11 server
1338 To redirect telnet connections from host port 5555 to telnet port on
1339 the guest, use the following:
1343 qemu -net user,hostfwd=tcp::5555-:23 [...]
1344 telnet localhost 5555
1347 Then when you use on the host @code{telnet localhost 5555}, you
1348 connect to the guest telnet server.
1350 @item guestfwd=[tcp]:@var{server}:@var{port}-@var{dev}
1351 Forward guest TCP connections to the IP address @var{server} on port @var{port}
1352 to the character device @var{dev}. This option can be given multiple times.
1356 Note: Legacy stand-alone options -tftp, -bootp, -smb and -redir are still
1357 processed and applied to -net user. Mixing them with the new configuration
1358 syntax gives undefined results. Their use for new applications is discouraged
1359 as they will be removed from future versions.
1361 @item -net tap[,vlan=@var{n}][,name=@var{name}][,fd=@var{h}][,ifname=@var{name}] [,script=@var{file}][,downscript=@var{dfile}]
1362 Connect the host TAP network interface @var{name} to VLAN @var{n}, use
1363 the network script @var{file} to configure it and the network script
1364 @var{dfile} to deconfigure it. If @var{name} is not provided, the OS
1365 automatically provides one. @option{fd}=@var{h} can be used to specify
1366 the handle of an already opened host TAP interface. The default network
1367 configure script is @file{/etc/qemu-ifup} and the default network
1368 deconfigure script is @file{/etc/qemu-ifdown}. Use @option{script=no}
1369 or @option{downscript=no} to disable script execution. Example:
1372 qemu linux.img -net nic -net tap
1375 More complicated example (two NICs, each one connected to a TAP device)
1377 qemu linux.img -net nic,vlan=0 -net tap,vlan=0,ifname=tap0 \
1378 -net nic,vlan=1 -net tap,vlan=1,ifname=tap1
1381 @item -net socket[,vlan=@var{n}][,name=@var{name}][,fd=@var{h}] [,listen=[@var{host}]:@var{port}][,connect=@var{host}:@var{port}]
1383 Connect the VLAN @var{n} to a remote VLAN in another QEMU virtual
1384 machine using a TCP socket connection. If @option{listen} is
1385 specified, QEMU waits for incoming connections on @var{port}
1386 (@var{host} is optional). @option{connect} is used to connect to
1387 another QEMU instance using the @option{listen} option. @option{fd}=@var{h}
1388 specifies an already opened TCP socket.
1392 # launch a first QEMU instance
1393 qemu linux.img -net nic,macaddr=52:54:00:12:34:56 \
1394 -net socket,listen=:1234
1395 # connect the VLAN 0 of this instance to the VLAN 0
1396 # of the first instance
1397 qemu linux.img -net nic,macaddr=52:54:00:12:34:57 \
1398 -net socket,connect=127.0.0.1:1234
1401 @item -net socket[,vlan=@var{n}][,name=@var{name}][,fd=@var{h}][,mcast=@var{maddr}:@var{port}[,localaddr=@var{addr}]]
1403 Create a VLAN @var{n} shared with another QEMU virtual
1404 machines using a UDP multicast socket, effectively making a bus for
1405 every QEMU with same multicast address @var{maddr} and @var{port}.
1409 Several QEMU can be running on different hosts and share same bus (assuming
1410 correct multicast setup for these hosts).
1412 mcast support is compatible with User Mode Linux (argument @option{eth@var{N}=mcast}), see
1413 @url{http://user-mode-linux.sf.net}.
1415 Use @option{fd=h} to specify an already opened UDP multicast socket.
1420 # launch one QEMU instance
1421 qemu linux.img -net nic,macaddr=52:54:00:12:34:56 \
1422 -net socket,mcast=230.0.0.1:1234
1423 # launch another QEMU instance on same "bus"
1424 qemu linux.img -net nic,macaddr=52:54:00:12:34:57 \
1425 -net socket,mcast=230.0.0.1:1234
1426 # launch yet another QEMU instance on same "bus"
1427 qemu linux.img -net nic,macaddr=52:54:00:12:34:58 \
1428 -net socket,mcast=230.0.0.1:1234
1431 Example (User Mode Linux compat.):
1433 # launch QEMU instance (note mcast address selected
1435 qemu linux.img -net nic,macaddr=52:54:00:12:34:56 \
1436 -net socket,mcast=239.192.168.1:1102
1438 /path/to/linux ubd0=/path/to/root_fs eth0=mcast
1441 Example (send packets from host's 1.2.3.4):
1443 qemu linux.img -net nic,macaddr=52:54:00:12:34:56 \
1444 -net socket,mcast=239.192.168.1:1102,localaddr=1.2.3.4
1447 @item -net vde[,vlan=@var{n}][,name=@var{name}][,sock=@var{socketpath}] [,port=@var{n}][,group=@var{groupname}][,mode=@var{octalmode}]
1448 Connect VLAN @var{n} to PORT @var{n} of a vde switch running on host and
1449 listening for incoming connections on @var{socketpath}. Use GROUP @var{groupname}
1450 and MODE @var{octalmode} to change default ownership and permissions for
1451 communication port. This option is only available if QEMU has been compiled
1452 with vde support enabled.
1457 vde_switch -F -sock /tmp/myswitch
1458 # launch QEMU instance
1459 qemu linux.img -net nic -net vde,sock=/tmp/myswitch
1462 @item -net dump[,vlan=@var{n}][,file=@var{file}][,len=@var{len}]
1463 Dump network traffic on VLAN @var{n} to file @var{file} (@file{qemu-vlan0.pcap} by default).
1464 At most @var{len} bytes (64k by default) per packet are stored. The file format is
1465 libpcap, so it can be analyzed with tools such as tcpdump or Wireshark.
1468 Indicate that no network devices should be configured. It is used to
1469 override the default configuration (@option{-net nic -net user}) which
1470 is activated if no @option{-net} options are provided.
1477 DEFHEADING(Character device options:)
1479 DEF("chardev", HAS_ARG, QEMU_OPTION_chardev,
1480 "-chardev null,id=id[,mux=on|off]\n"
1481 "-chardev socket,id=id[,host=host],port=host[,to=to][,ipv4][,ipv6][,nodelay]\n"
1482 " [,server][,nowait][,telnet][,mux=on|off] (tcp)\n"
1483 "-chardev socket,id=id,path=path[,server][,nowait][,telnet],[mux=on|off] (unix)\n"
1484 "-chardev udp,id=id[,host=host],port=port[,localaddr=localaddr]\n"
1485 " [,localport=localport][,ipv4][,ipv6][,mux=on|off]\n"
1486 "-chardev msmouse,id=id[,mux=on|off]\n"
1487 "-chardev vc,id=id[[,width=width][,height=height]][[,cols=cols][,rows=rows]]\n"
1489 "-chardev file,id=id,path=path[,mux=on|off]\n"
1490 "-chardev pipe,id=id,path=path[,mux=on|off]\n"
1492 "-chardev console,id=id[,mux=on|off]\n"
1493 "-chardev serial,id=id,path=path[,mux=on|off]\n"
1495 "-chardev pty,id=id[,mux=on|off]\n"
1496 "-chardev stdio,id=id[,mux=on|off][,signal=on|off]\n"
1498 #ifdef CONFIG_BRLAPI
1499 "-chardev braille,id=id[,mux=on|off]\n"
1501 #if defined(__linux__) || defined(__sun__) || defined(__FreeBSD__) \
1502 || defined(__NetBSD__) || defined(__OpenBSD__) || defined(__DragonFly__)
1503 "-chardev tty,id=id,path=path[,mux=on|off]\n"
1505 #if defined(__linux__) || defined(__FreeBSD__) || defined(__DragonFly__)
1506 "-chardev parport,id=id,path=path[,mux=on|off]\n"
1508 #if defined(CONFIG_SPICE)
1509 "-chardev spicevmc,id=id,name=name[,debug=debug]\n"
1516 The general form of a character device option is:
1519 @item -chardev @var{backend} ,id=@var{id} [,mux=on|off] [,@var{options}]
1537 The specific backend will determine the applicable options.
1539 All devices must have an id, which can be any string up to 127 characters long.
1540 It is used to uniquely identify this device in other command line directives.
1542 A character device may be used in multiplexing mode by multiple front-ends.
1543 The key sequence of @key{Control-a} and @key{c} will rotate the input focus
1544 between attached front-ends. Specify @option{mux=on} to enable this mode.
1546 Options to each backend are described below.
1548 @item -chardev null ,id=@var{id}
1549 A void device. This device will not emit any data, and will drop any data it
1550 receives. The null backend does not take any options.
1552 @item -chardev socket ,id=@var{id} [@var{TCP options} or @var{unix options}] [,server] [,nowait] [,telnet]
1554 Create a two-way stream socket, which can be either a TCP or a unix socket. A
1555 unix socket will be created if @option{path} is specified. Behaviour is
1556 undefined if TCP options are specified for a unix socket.
1558 @option{server} specifies that the socket shall be a listening socket.
1560 @option{nowait} specifies that QEMU should not block waiting for a client to
1561 connect to a listening socket.
1563 @option{telnet} specifies that traffic on the socket should interpret telnet
1566 TCP and unix socket options are given below:
1570 @item TCP options: port=@var{port} [,host=@var{host}] [,to=@var{to}] [,ipv4] [,ipv6] [,nodelay]
1572 @option{host} for a listening socket specifies the local address to be bound.
1573 For a connecting socket species the remote host to connect to. @option{host} is
1574 optional for listening sockets. If not specified it defaults to @code{0.0.0.0}.
1576 @option{port} for a listening socket specifies the local port to be bound. For a
1577 connecting socket specifies the port on the remote host to connect to.
1578 @option{port} can be given as either a port number or a service name.
1579 @option{port} is required.
1581 @option{to} is only relevant to listening sockets. If it is specified, and
1582 @option{port} cannot be bound, QEMU will attempt to bind to subsequent ports up
1583 to and including @option{to} until it succeeds. @option{to} must be specified
1586 @option{ipv4} and @option{ipv6} specify that either IPv4 or IPv6 must be used.
1587 If neither is specified the socket may use either protocol.
1589 @option{nodelay} disables the Nagle algorithm.
1591 @item unix options: path=@var{path}
1593 @option{path} specifies the local path of the unix socket. @option{path} is
1598 @item -chardev udp ,id=@var{id} [,host=@var{host}] ,port=@var{port} [,localaddr=@var{localaddr}] [,localport=@var{localport}] [,ipv4] [,ipv6]
1600 Sends all traffic from the guest to a remote host over UDP.
1602 @option{host} specifies the remote host to connect to. If not specified it
1603 defaults to @code{localhost}.
1605 @option{port} specifies the port on the remote host to connect to. @option{port}
1608 @option{localaddr} specifies the local address to bind to. If not specified it
1609 defaults to @code{0.0.0.0}.
1611 @option{localport} specifies the local port to bind to. If not specified any
1612 available local port will be used.
1614 @option{ipv4} and @option{ipv6} specify that either IPv4 or IPv6 must be used.
1615 If neither is specified the device may use either protocol.
1617 @item -chardev msmouse ,id=@var{id}
1619 Forward QEMU's emulated msmouse events to the guest. @option{msmouse} does not
1622 @item -chardev vc ,id=@var{id} [[,width=@var{width}] [,height=@var{height}]] [[,cols=@var{cols}] [,rows=@var{rows}]]
1624 Connect to a QEMU text console. @option{vc} may optionally be given a specific
1627 @option{width} and @option{height} specify the width and height respectively of
1628 the console, in pixels.
1630 @option{cols} and @option{rows} specify that the console be sized to fit a text
1631 console with the given dimensions.
1633 @item -chardev file ,id=@var{id} ,path=@var{path}
1635 Log all traffic received from the guest to a file.
1637 @option{path} specifies the path of the file to be opened. This file will be
1638 created if it does not already exist, and overwritten if it does. @option{path}
1641 @item -chardev pipe ,id=@var{id} ,path=@var{path}
1643 Create a two-way connection to the guest. The behaviour differs slightly between
1644 Windows hosts and other hosts:
1646 On Windows, a single duplex pipe will be created at
1647 @file{\\.pipe\@option{path}}.
1649 On other hosts, 2 pipes will be created called @file{@option{path}.in} and
1650 @file{@option{path}.out}. Data written to @file{@option{path}.in} will be
1651 received by the guest. Data written by the guest can be read from
1652 @file{@option{path}.out}. QEMU will not create these fifos, and requires them to
1655 @option{path} forms part of the pipe path as described above. @option{path} is
1658 @item -chardev console ,id=@var{id}
1660 Send traffic from the guest to QEMU's standard output. @option{console} does not
1663 @option{console} is only available on Windows hosts.
1665 @item -chardev serial ,id=@var{id} ,path=@option{path}
1667 Send traffic from the guest to a serial device on the host.
1670 only available on Windows hosts.
1672 @option{path} specifies the name of the serial device to open.
1674 @item -chardev pty ,id=@var{id}
1676 Create a new pseudo-terminal on the host and connect to it. @option{pty} does
1677 not take any options.
1679 @option{pty} is not available on Windows hosts.
1681 @item -chardev stdio ,id=@var{id} [,signal=on|off]
1682 Connect to standard input and standard output of the qemu process.
1684 @option{signal} controls if signals are enabled on the terminal, that includes
1685 exiting QEMU with the key sequence @key{Control-c}. This option is enabled by
1686 default, use @option{signal=off} to disable it.
1688 @option{stdio} is not available on Windows hosts.
1690 @item -chardev braille ,id=@var{id}
1692 Connect to a local BrlAPI server. @option{braille} does not take any options.
1694 @item -chardev tty ,id=@var{id} ,path=@var{path}
1696 Connect to a local tty device.
1698 @option{tty} is only available on Linux, Sun, FreeBSD, NetBSD, OpenBSD and
1701 @option{path} specifies the path to the tty. @option{path} is required.
1703 @item -chardev parport ,id=@var{id} ,path=@var{path}
1705 @option{parport} is only available on Linux, FreeBSD and DragonFlyBSD hosts.
1707 Connect to a local parallel port.
1709 @option{path} specifies the path to the parallel port device. @option{path} is
1712 @item -chardev spicevmc ,id=@var{id} ,debug=@var{debug}, name=@var{name}
1714 @option{spicevmc} is only available when spice support is built in.
1716 @option{debug} debug level for spicevmc
1718 @option{name} name of spice channel to connect to
1720 Connect to a spice virtual machine channel, such as vdiport.
1727 DEFHEADING(Bluetooth(R) options:)
1729 DEF("bt", HAS_ARG, QEMU_OPTION_bt, \
1730 "-bt hci,null dumb bluetooth HCI - doesn't respond to commands\n" \
1731 "-bt hci,host[:id]\n" \
1732 " use host's HCI with the given name\n" \
1733 "-bt hci[,vlan=n]\n" \
1734 " emulate a standard HCI in virtual scatternet 'n'\n" \
1735 "-bt vhci[,vlan=n]\n" \
1736 " add host computer to virtual scatternet 'n' using VHCI\n" \
1737 "-bt device:dev[,vlan=n]\n" \
1738 " emulate a bluetooth device 'dev' in scatternet 'n'\n",
1745 Defines the function of the corresponding Bluetooth HCI. -bt options
1746 are matched with the HCIs present in the chosen machine type. For
1747 example when emulating a machine with only one HCI built into it, only
1748 the first @code{-bt hci[...]} option is valid and defines the HCI's
1749 logic. The Transport Layer is decided by the machine type. Currently
1750 the machines @code{n800} and @code{n810} have one HCI and all other
1754 The following three types are recognized:
1758 (default) The corresponding Bluetooth HCI assumes no internal logic
1759 and will not respond to any HCI commands or emit events.
1761 @item -bt hci,host[:@var{id}]
1762 (@code{bluez} only) The corresponding HCI passes commands / events
1763 to / from the physical HCI identified by the name @var{id} (default:
1764 @code{hci0}) on the computer running QEMU. Only available on @code{bluez}
1765 capable systems like Linux.
1767 @item -bt hci[,vlan=@var{n}]
1768 Add a virtual, standard HCI that will participate in the Bluetooth
1769 scatternet @var{n} (default @code{0}). Similarly to @option{-net}
1770 VLANs, devices inside a bluetooth network @var{n} can only communicate
1771 with other devices in the same network (scatternet).
1774 @item -bt vhci[,vlan=@var{n}]
1775 (Linux-host only) Create a HCI in scatternet @var{n} (default 0) attached
1776 to the host bluetooth stack instead of to the emulated target. This
1777 allows the host and target machines to participate in a common scatternet
1778 and communicate. Requires the Linux @code{vhci} driver installed. Can
1779 be used as following:
1782 qemu [...OPTIONS...] -bt hci,vlan=5 -bt vhci,vlan=5
1785 @item -bt device:@var{dev}[,vlan=@var{n}]
1786 Emulate a bluetooth device @var{dev} and place it in network @var{n}
1787 (default @code{0}). QEMU can only emulate one type of bluetooth devices
1792 Virtual wireless keyboard implementing the HIDP bluetooth profile.
1799 DEFHEADING(Linux/Multiboot boot specific:)
1802 When using these options, you can use a given Linux or Multiboot
1803 kernel without installing it in the disk image. It can be useful
1804 for easier testing of various kernels.
1809 DEF("kernel", HAS_ARG, QEMU_OPTION_kernel, \
1810 "-kernel bzImage use 'bzImage' as kernel image\n", QEMU_ARCH_ALL)
1812 @item -kernel @var{bzImage}
1814 Use @var{bzImage} as kernel image. The kernel can be either a Linux kernel
1815 or in multiboot format.
1818 DEF("append", HAS_ARG, QEMU_OPTION_append, \
1819 "-append cmdline use 'cmdline' as kernel command line\n", QEMU_ARCH_ALL)
1821 @item -append @var{cmdline}
1823 Use @var{cmdline} as kernel command line
1826 DEF("initrd", HAS_ARG, QEMU_OPTION_initrd, \
1827 "-initrd file use 'file' as initial ram disk\n", QEMU_ARCH_ALL)
1829 @item -initrd @var{file}
1831 Use @var{file} as initial ram disk.
1833 @item -initrd "@var{file1} arg=foo,@var{file2}"
1835 This syntax is only available with multiboot.
1837 Use @var{file1} and @var{file2} as modules and pass arg=foo as parameter to the
1847 DEFHEADING(Debug/Expert options:)
1853 DEF("serial", HAS_ARG, QEMU_OPTION_serial, \
1854 "-serial dev redirect the serial port to char device 'dev'\n",
1857 @item -serial @var{dev}
1859 Redirect the virtual serial port to host character device
1860 @var{dev}. The default device is @code{vc} in graphical mode and
1861 @code{stdio} in non graphical mode.
1863 This option can be used several times to simulate up to 4 serial
1866 Use @code{-serial none} to disable all serial ports.
1868 Available character devices are:
1870 @item vc[:@var{W}x@var{H}]
1871 Virtual console. Optionally, a width and height can be given in pixel with
1875 It is also possible to specify width or height in characters:
1880 [Linux only] Pseudo TTY (a new PTY is automatically allocated)
1882 No device is allocated.
1886 [Linux only] Use host tty, e.g. @file{/dev/ttyS0}. The host serial port
1887 parameters are set according to the emulated ones.
1888 @item /dev/parport@var{N}
1889 [Linux only, parallel port only] Use host parallel port
1890 @var{N}. Currently SPP and EPP parallel port features can be used.
1891 @item file:@var{filename}
1892 Write output to @var{filename}. No character can be read.
1894 [Unix only] standard input/output
1895 @item pipe:@var{filename}
1896 name pipe @var{filename}
1898 [Windows only] Use host serial port @var{n}
1899 @item udp:[@var{remote_host}]:@var{remote_port}[@@[@var{src_ip}]:@var{src_port}]
1900 This implements UDP Net Console.
1901 When @var{remote_host} or @var{src_ip} are not specified
1902 they default to @code{0.0.0.0}.
1903 When not using a specified @var{src_port} a random port is automatically chosen.
1905 If you just want a simple readonly console you can use @code{netcat} or
1906 @code{nc}, by starting qemu with: @code{-serial udp::4555} and nc as:
1907 @code{nc -u -l -p 4555}. Any time qemu writes something to that port it
1908 will appear in the netconsole session.
1910 If you plan to send characters back via netconsole or you want to stop
1911 and start qemu a lot of times, you should have qemu use the same
1912 source port each time by using something like @code{-serial
1913 udp::4555@@:4556} to qemu. Another approach is to use a patched
1914 version of netcat which can listen to a TCP port and send and receive
1915 characters via udp. If you have a patched version of netcat which
1916 activates telnet remote echo and single char transfer, then you can
1917 use the following options to step up a netcat redirector to allow
1918 telnet on port 5555 to access the qemu port.
1921 -serial udp::4555@@:4556
1922 @item netcat options:
1923 -u -P 4555 -L 0.0.0.0:4556 -t -p 5555 -I -T
1924 @item telnet options:
1928 @item tcp:[@var{host}]:@var{port}[,@var{server}][,nowait][,nodelay]
1929 The TCP Net Console has two modes of operation. It can send the serial
1930 I/O to a location or wait for a connection from a location. By default
1931 the TCP Net Console is sent to @var{host} at the @var{port}. If you use
1932 the @var{server} option QEMU will wait for a client socket application
1933 to connect to the port before continuing, unless the @code{nowait}
1934 option was specified. The @code{nodelay} option disables the Nagle buffering
1935 algorithm. If @var{host} is omitted, 0.0.0.0 is assumed. Only
1936 one TCP connection at a time is accepted. You can use @code{telnet} to
1937 connect to the corresponding character device.
1939 @item Example to send tcp console to 192.168.0.2 port 4444
1940 -serial tcp:192.168.0.2:4444
1941 @item Example to listen and wait on port 4444 for connection
1942 -serial tcp::4444,server
1943 @item Example to not wait and listen on ip 192.168.0.100 port 4444
1944 -serial tcp:192.168.0.100:4444,server,nowait
1947 @item telnet:@var{host}:@var{port}[,server][,nowait][,nodelay]
1948 The telnet protocol is used instead of raw tcp sockets. The options
1949 work the same as if you had specified @code{-serial tcp}. The
1950 difference is that the port acts like a telnet server or client using
1951 telnet option negotiation. This will also allow you to send the
1952 MAGIC_SYSRQ sequence if you use a telnet that supports sending the break
1953 sequence. Typically in unix telnet you do it with Control-] and then
1954 type "send break" followed by pressing the enter key.
1956 @item unix:@var{path}[,server][,nowait]
1957 A unix domain socket is used instead of a tcp socket. The option works the
1958 same as if you had specified @code{-serial tcp} except the unix domain socket
1959 @var{path} is used for connections.
1961 @item mon:@var{dev_string}
1962 This is a special option to allow the monitor to be multiplexed onto
1963 another serial port. The monitor is accessed with key sequence of
1964 @key{Control-a} and then pressing @key{c}. See monitor access
1965 @ref{pcsys_keys} in the -nographic section for more keys.
1966 @var{dev_string} should be any one of the serial devices specified
1967 above. An example to multiplex the monitor onto a telnet server
1968 listening on port 4444 would be:
1970 @item -serial mon:telnet::4444,server,nowait
1974 Braille device. This will use BrlAPI to display the braille output on a real
1978 Three button serial mouse. Configure the guest to use Microsoft protocol.
1982 DEF("parallel", HAS_ARG, QEMU_OPTION_parallel, \
1983 "-parallel dev redirect the parallel port to char device 'dev'\n",
1986 @item -parallel @var{dev}
1988 Redirect the virtual parallel port to host device @var{dev} (same
1989 devices as the serial port). On Linux hosts, @file{/dev/parportN} can
1990 be used to use hardware devices connected on the corresponding host
1993 This option can be used several times to simulate up to 3 parallel
1996 Use @code{-parallel none} to disable all parallel ports.
1999 DEF("monitor", HAS_ARG, QEMU_OPTION_monitor, \
2000 "-monitor dev redirect the monitor to char device 'dev'\n",
2003 @item -monitor @var{dev}
2005 Redirect the monitor to host device @var{dev} (same devices as the
2007 The default device is @code{vc} in graphical mode and @code{stdio} in
2010 DEF("qmp", HAS_ARG, QEMU_OPTION_qmp, \
2011 "-qmp dev like -monitor but opens in 'control' mode\n",
2014 @item -qmp @var{dev}
2016 Like -monitor but opens in 'control' mode.
2019 DEF("mon", HAS_ARG, QEMU_OPTION_mon, \
2020 "-mon chardev=[name][,mode=readline|control][,default]\n", QEMU_ARCH_ALL)
2022 @item -mon chardev=[name][,mode=readline|control][,default]
2024 Setup monitor on chardev @var{name}.
2027 DEF("debugcon", HAS_ARG, QEMU_OPTION_debugcon, \
2028 "-debugcon dev redirect the debug console to char device 'dev'\n",
2031 @item -debugcon @var{dev}
2033 Redirect the debug console to host device @var{dev} (same devices as the
2034 serial port). The debug console is an I/O port which is typically port
2035 0xe9; writing to that I/O port sends output to this device.
2036 The default device is @code{vc} in graphical mode and @code{stdio} in
2040 DEF("pidfile", HAS_ARG, QEMU_OPTION_pidfile, \
2041 "-pidfile file write PID to 'file'\n", QEMU_ARCH_ALL)
2043 @item -pidfile @var{file}
2045 Store the QEMU process PID in @var{file}. It is useful if you launch QEMU
2049 DEF("singlestep", 0, QEMU_OPTION_singlestep, \
2050 "-singlestep always run in singlestep mode\n", QEMU_ARCH_ALL)
2054 Run the emulation in single step mode.
2057 DEF("S", 0, QEMU_OPTION_S, \
2058 "-S freeze CPU at startup (use 'c' to start execution)\n",
2063 Do not start CPU at startup (you must type 'c' in the monitor).
2066 DEF("gdb", HAS_ARG, QEMU_OPTION_gdb, \
2067 "-gdb dev wait for gdb connection on 'dev'\n", QEMU_ARCH_ALL)
2069 @item -gdb @var{dev}
2071 Wait for gdb connection on device @var{dev} (@pxref{gdb_usage}). Typical
2072 connections will likely be TCP-based, but also UDP, pseudo TTY, or even
2073 stdio are reasonable use case. The latter is allowing to start qemu from
2074 within gdb and establish the connection via a pipe:
2076 (gdb) target remote | exec qemu -gdb stdio ...
2080 DEF("s", 0, QEMU_OPTION_s, \
2081 "-s shorthand for -gdb tcp::" DEFAULT_GDBSTUB_PORT "\n",
2086 Shorthand for -gdb tcp::1234, i.e. open a gdbserver on TCP port 1234
2087 (@pxref{gdb_usage}).
2090 DEF("d", HAS_ARG, QEMU_OPTION_d, \
2091 "-d item1,... output log to /tmp/qemu.log (use -d ? for a list of log items)\n",
2096 Output log in /tmp/qemu.log
2099 DEF("D", HAS_ARG, QEMU_OPTION_D, \
2100 "-D logfile output log to logfile (instead of the default /tmp/qemu.log)\n",
2105 Output log in logfile instead of /tmp/qemu.log
2108 DEF("hdachs", HAS_ARG, QEMU_OPTION_hdachs, \
2109 "-hdachs c,h,s[,t]\n" \
2110 " force hard disk 0 physical geometry and the optional BIOS\n" \
2111 " translation (t=none or lba) (usually qemu can guess them)\n",
2114 @item -hdachs @var{c},@var{h},@var{s},[,@var{t}]
2116 Force hard disk 0 physical geometry (1 <= @var{c} <= 16383, 1 <=
2117 @var{h} <= 16, 1 <= @var{s} <= 63) and optionally force the BIOS
2118 translation mode (@var{t}=none, lba or auto). Usually QEMU can guess
2119 all those parameters. This option is useful for old MS-DOS disk
2123 DEF("L", HAS_ARG, QEMU_OPTION_L, \
2124 "-L path set the directory for the BIOS, VGA BIOS and keymaps\n",
2129 Set the directory for the BIOS, VGA BIOS and keymaps.
2132 DEF("bios", HAS_ARG, QEMU_OPTION_bios, \
2133 "-bios file set the filename for the BIOS\n", QEMU_ARCH_ALL)
2135 @item -bios @var{file}
2137 Set the filename for the BIOS.
2140 DEF("enable-kvm", 0, QEMU_OPTION_enable_kvm, \
2141 "-enable-kvm enable KVM full virtualization support\n", QEMU_ARCH_ALL)
2145 Enable KVM full virtualization support. This option is only available
2146 if KVM support is enabled when compiling.
2149 DEF("xen-domid", HAS_ARG, QEMU_OPTION_xen_domid,
2150 "-xen-domid id specify xen guest domain id\n", QEMU_ARCH_ALL)
2151 DEF("xen-create", 0, QEMU_OPTION_xen_create,
2152 "-xen-create create domain using xen hypercalls, bypassing xend\n"
2153 " warning: should not be used when xend is in use\n",
2155 DEF("xen-attach", 0, QEMU_OPTION_xen_attach,
2156 "-xen-attach attach to existing xen domain\n"
2157 " xend will use this when starting qemu\n",
2160 @item -xen-domid @var{id}
2162 Specify xen guest domain @var{id} (XEN only).
2165 Create domain using xen hypercalls, bypassing xend.
2166 Warning: should not be used when xend is in use (XEN only).
2169 Attach to existing xen domain.
2170 xend will use this when starting qemu (XEN only).
2173 DEF("no-reboot", 0, QEMU_OPTION_no_reboot, \
2174 "-no-reboot exit instead of rebooting\n", QEMU_ARCH_ALL)
2178 Exit instead of rebooting.
2181 DEF("no-shutdown", 0, QEMU_OPTION_no_shutdown, \
2182 "-no-shutdown stop before shutdown\n", QEMU_ARCH_ALL)
2185 @findex -no-shutdown
2186 Don't exit QEMU on guest shutdown, but instead only stop the emulation.
2187 This allows for instance switching to monitor to commit changes to the
2191 DEF("loadvm", HAS_ARG, QEMU_OPTION_loadvm, \
2192 "-loadvm [tag|id]\n" \
2193 " start right away with a saved state (loadvm in monitor)\n",
2196 @item -loadvm @var{file}
2198 Start right away with a saved state (@code{loadvm} in monitor)
2202 DEF("daemonize", 0, QEMU_OPTION_daemonize, \
2203 "-daemonize daemonize QEMU after initializing\n", QEMU_ARCH_ALL)
2208 Daemonize the QEMU process after initialization. QEMU will not detach from
2209 standard IO until it is ready to receive connections on any of its devices.
2210 This option is a useful way for external programs to launch QEMU without having
2211 to cope with initialization race conditions.
2214 DEF("option-rom", HAS_ARG, QEMU_OPTION_option_rom, \
2215 "-option-rom rom load a file, rom, into the option ROM space\n",
2218 @item -option-rom @var{file}
2220 Load the contents of @var{file} as an option ROM.
2221 This option is useful to load things like EtherBoot.
2224 DEF("clock", HAS_ARG, QEMU_OPTION_clock, \
2225 "-clock force the use of the given methods for timer alarm.\n" \
2226 " To see what timers are available use -clock ?\n",
2229 @item -clock @var{method}
2231 Force the use of the given methods for timer alarm. To see what timers
2232 are available use -clock ?.
2235 HXCOMM Options deprecated by -rtc
2236 DEF("localtime", 0, QEMU_OPTION_localtime, "", QEMU_ARCH_ALL)
2237 DEF("startdate", HAS_ARG, QEMU_OPTION_startdate, "", QEMU_ARCH_ALL)
2239 DEF("rtc", HAS_ARG, QEMU_OPTION_rtc, \
2240 "-rtc [base=utc|localtime|date][,clock=host|vm][,driftfix=none|slew]\n" \
2241 " set the RTC base and clock, enable drift fix for clock ticks (x86 only)\n",
2246 @item -rtc [base=utc|localtime|@var{date}][,clock=host|vm][,driftfix=none|slew]
2248 Specify @option{base} as @code{utc} or @code{localtime} to let the RTC start at the current
2249 UTC or local time, respectively. @code{localtime} is required for correct date in
2250 MS-DOS or Windows. To start at a specific point in time, provide @var{date} in the
2251 format @code{2006-06-17T16:01:21} or @code{2006-06-17}. The default base is UTC.
2253 By default the RTC is driven by the host system time. This allows to use the
2254 RTC as accurate reference clock inside the guest, specifically if the host
2255 time is smoothly following an accurate external reference clock, e.g. via NTP.
2256 If you want to isolate the guest time from the host, even prevent it from
2257 progressing during suspension, you can set @option{clock} to @code{vm} instead.
2259 Enable @option{driftfix} (i386 targets only) if you experience time drift problems,
2260 specifically with Windows' ACPI HAL. This option will try to figure out how
2261 many timer interrupts were not processed by the Windows guest and will
2265 DEF("icount", HAS_ARG, QEMU_OPTION_icount, \
2266 "-icount [N|auto]\n" \
2267 " enable virtual instruction counter with 2^N clock ticks per\n" \
2268 " instruction\n", QEMU_ARCH_ALL)
2270 @item -icount [@var{N}|auto]
2272 Enable virtual instruction counter. The virtual cpu will execute one
2273 instruction every 2^@var{N} ns of virtual time. If @code{auto} is specified
2274 then the virtual cpu speed will be automatically adjusted to keep virtual
2275 time within a few seconds of real time.
2277 Note that while this option can give deterministic behavior, it does not
2278 provide cycle accurate emulation. Modern CPUs contain superscalar out of
2279 order cores with complex cache hierarchies. The number of instructions
2280 executed often has little or no correlation with actual performance.
2283 DEF("watchdog", HAS_ARG, QEMU_OPTION_watchdog, \
2284 "-watchdog i6300esb|ib700\n" \
2285 " enable virtual hardware watchdog [default=none]\n",
2288 @item -watchdog @var{model}
2290 Create a virtual hardware watchdog device. Once enabled (by a guest
2291 action), the watchdog must be periodically polled by an agent inside
2292 the guest or else the guest will be restarted.
2294 The @var{model} is the model of hardware watchdog to emulate. Choices
2295 for model are: @code{ib700} (iBASE 700) which is a very simple ISA
2296 watchdog with a single timer, or @code{i6300esb} (Intel 6300ESB I/O
2297 controller hub) which is a much more featureful PCI-based dual-timer
2298 watchdog. Choose a model for which your guest has drivers.
2300 Use @code{-watchdog ?} to list available hardware models. Only one
2301 watchdog can be enabled for a guest.
2304 DEF("watchdog-action", HAS_ARG, QEMU_OPTION_watchdog_action, \
2305 "-watchdog-action reset|shutdown|poweroff|pause|debug|none\n" \
2306 " action when watchdog fires [default=reset]\n",
2309 @item -watchdog-action @var{action}
2311 The @var{action} controls what QEMU will do when the watchdog timer
2314 @code{reset} (forcefully reset the guest).
2315 Other possible actions are:
2316 @code{shutdown} (attempt to gracefully shutdown the guest),
2317 @code{poweroff} (forcefully poweroff the guest),
2318 @code{pause} (pause the guest),
2319 @code{debug} (print a debug message and continue), or
2320 @code{none} (do nothing).
2322 Note that the @code{shutdown} action requires that the guest responds
2323 to ACPI signals, which it may not be able to do in the sort of
2324 situations where the watchdog would have expired, and thus
2325 @code{-watchdog-action shutdown} is not recommended for production use.
2330 @item -watchdog i6300esb -watchdog-action pause
2331 @item -watchdog ib700
2335 DEF("echr", HAS_ARG, QEMU_OPTION_echr, \
2336 "-echr chr set terminal escape character instead of ctrl-a\n",
2340 @item -echr @var{numeric_ascii_value}
2342 Change the escape character used for switching to the monitor when using
2343 monitor and serial sharing. The default is @code{0x01} when using the
2344 @code{-nographic} option. @code{0x01} is equal to pressing
2345 @code{Control-a}. You can select a different character from the ascii
2346 control keys where 1 through 26 map to Control-a through Control-z. For
2347 instance you could use the either of the following to change the escape
2348 character to Control-t.
2355 DEF("virtioconsole", HAS_ARG, QEMU_OPTION_virtiocon, \
2356 "-virtioconsole c\n" \
2357 " set virtio console\n", QEMU_ARCH_ALL)
2359 @item -virtioconsole @var{c}
2360 @findex -virtioconsole
2363 This option is maintained for backward compatibility.
2365 Please use @code{-device virtconsole} for the new way of invocation.
2368 DEF("show-cursor", 0, QEMU_OPTION_show_cursor, \
2369 "-show-cursor show cursor\n", QEMU_ARCH_ALL)
2372 @findex -show-cursor
2376 DEF("tb-size", HAS_ARG, QEMU_OPTION_tb_size, \
2377 "-tb-size n set TB size\n", QEMU_ARCH_ALL)
2379 @item -tb-size @var{n}
2384 DEF("incoming", HAS_ARG, QEMU_OPTION_incoming, \
2385 "-incoming p prepare for incoming migration, listen on port p\n",
2388 @item -incoming @var{port}
2390 Prepare for incoming migration, listen on @var{port}.
2393 DEF("nodefaults", 0, QEMU_OPTION_nodefaults, \
2394 "-nodefaults don't create default devices\n", QEMU_ARCH_ALL)
2398 Don't create default devices.
2402 DEF("chroot", HAS_ARG, QEMU_OPTION_chroot, \
2403 "-chroot dir chroot to dir just before starting the VM\n",
2407 @item -chroot @var{dir}
2409 Immediately before starting guest execution, chroot to the specified
2410 directory. Especially useful in combination with -runas.
2414 DEF("runas", HAS_ARG, QEMU_OPTION_runas, \
2415 "-runas user change to user id user just before starting the VM\n",
2419 @item -runas @var{user}
2421 Immediately before starting guest execution, drop root privileges, switching
2422 to the specified user.
2425 DEF("prom-env", HAS_ARG, QEMU_OPTION_prom_env,
2426 "-prom-env variable=value\n"
2427 " set OpenBIOS nvram variables\n",
2428 QEMU_ARCH_PPC | QEMU_ARCH_SPARC)
2430 @item -prom-env @var{variable}=@var{value}
2432 Set OpenBIOS nvram @var{variable} to given @var{value} (PPC, SPARC only).
2434 DEF("semihosting", 0, QEMU_OPTION_semihosting,
2435 "-semihosting semihosting mode\n", QEMU_ARCH_ARM | QEMU_ARCH_M68K | QEMU_ARCH_XTENSA)
2438 @findex -semihosting
2439 Semihosting mode (ARM, M68K, Xtensa only).
2441 DEF("old-param", 0, QEMU_OPTION_old_param,
2442 "-old-param old param mode\n", QEMU_ARCH_ARM)
2445 @findex -old-param (ARM)
2446 Old param mode (ARM only).
2449 DEF("readconfig", HAS_ARG, QEMU_OPTION_readconfig,
2450 "-readconfig <file>\n", QEMU_ARCH_ALL)
2452 @item -readconfig @var{file}
2454 Read device configuration from @var{file}.
2456 DEF("writeconfig", HAS_ARG, QEMU_OPTION_writeconfig,
2457 "-writeconfig <file>\n"
2458 " read/write config file\n", QEMU_ARCH_ALL)
2460 @item -writeconfig @var{file}
2461 @findex -writeconfig
2462 Write device configuration to @var{file}.
2464 DEF("nodefconfig", 0, QEMU_OPTION_nodefconfig,
2466 " do not load default config files at startup\n",
2470 @findex -nodefconfig
2471 Normally QEMU loads a configuration file from @var{sysconfdir}/qemu.conf and
2472 @var{sysconfdir}/target-@var{ARCH}.conf on startup. The @code{-nodefconfig}
2473 option will prevent QEMU from loading these configuration files at startup.
2475 DEF("trace", HAS_ARG, QEMU_OPTION_trace,
2476 "-trace [events=<file>][,file=<file>]\n"
2477 " specify tracing options\n",
2480 HXCOMM This line is not accurate, as some sub-options are backend-specific but
2481 HXCOMM HX does not support conditional compilation of text.
2482 @item -trace [events=@var{file}][,file=@var{file}]
2485 Specify tracing options.
2488 @item events=@var{file}
2489 Immediately enable events listed in @var{file}.
2490 The file must contain one event name (as listed in the @var{trace-events} file)
2492 This option is only available if QEMU has been compiled with
2493 either @var{simple} or @var{stderr} tracing backend.
2494 @item file=@var{file}
2495 Log output traces to @var{file}.
2497 This option is only available if QEMU has been compiled with
2498 the @var{simple} tracing backend.
2502 HXCOMM This is the last statement. Insert new options before this line!