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("M", HAS_ARG, QEMU_OPTION_M,
31 "-M machine select emulated machine (-M ? for list)\n", QEMU_ARCH_ALL)
33 @item -M @var{machine}
35 Select the emulated @var{machine} (@code{-M ?} for list)
38 DEF("cpu", HAS_ARG, QEMU_OPTION_cpu,
39 "-cpu cpu select CPU (-cpu ? for list)\n", QEMU_ARCH_ALL)
41 @item -cpu @var{model}
43 Select CPU model (-cpu ? for list and additional feature selection)
46 DEF("smp", HAS_ARG, QEMU_OPTION_smp,
47 "-smp n[,maxcpus=cpus][,cores=cores][,threads=threads][,sockets=sockets]\n"
48 " set the number of CPUs to 'n' [default=1]\n"
49 " maxcpus= maximum number of total cpus, including\n"
50 " offline CPUs for hotplug, etc\n"
51 " cores= number of CPU cores on one socket\n"
52 " threads= number of threads on one CPU core\n"
53 " sockets= number of discrete sockets in the system\n",
56 @item -smp @var{n}[,cores=@var{cores}][,threads=@var{threads}][,sockets=@var{sockets}][,maxcpus=@var{maxcpus}]
58 Simulate an SMP system with @var{n} CPUs. On the PC target, up to 255
59 CPUs are supported. On Sparc32 target, Linux limits the number of usable CPUs
61 For the PC target, the number of @var{cores} per socket, the number
62 of @var{threads} per cores and the total number of @var{sockets} can be
63 specified. Missing values will be computed. If any on the three values is
64 given, the total number of CPUs @var{n} can be omitted. @var{maxcpus}
65 specifies the maximum number of hotpluggable CPUs.
68 DEF("numa", HAS_ARG, QEMU_OPTION_numa,
69 "-numa node[,mem=size][,cpus=cpu[-cpu]][,nodeid=node]\n", QEMU_ARCH_ALL)
71 @item -numa @var{opts}
73 Simulate a multi node NUMA system. If mem and cpus are omitted, resources
77 DEF("fda", HAS_ARG, QEMU_OPTION_fda,
78 "-fda/-fdb file use 'file' as floppy disk 0/1 image\n", QEMU_ARCH_ALL)
79 DEF("fdb", HAS_ARG, QEMU_OPTION_fdb, "", QEMU_ARCH_ALL)
85 Use @var{file} as floppy disk 0/1 image (@pxref{disk_images}). You can
86 use the host floppy by using @file{/dev/fd0} as filename (@pxref{host_drives}).
89 DEF("hda", HAS_ARG, QEMU_OPTION_hda,
90 "-hda/-hdb file use 'file' as IDE hard disk 0/1 image\n", QEMU_ARCH_ALL)
91 DEF("hdb", HAS_ARG, QEMU_OPTION_hdb, "", QEMU_ARCH_ALL)
92 DEF("hdc", HAS_ARG, QEMU_OPTION_hdc,
93 "-hdc/-hdd file use 'file' as IDE hard disk 2/3 image\n", QEMU_ARCH_ALL)
94 DEF("hdd", HAS_ARG, QEMU_OPTION_hdd, "", QEMU_ARCH_ALL)
104 Use @var{file} as hard disk 0, 1, 2 or 3 image (@pxref{disk_images}).
107 DEF("cdrom", HAS_ARG, QEMU_OPTION_cdrom,
108 "-cdrom file use 'file' as IDE cdrom image (cdrom is ide1 master)\n",
111 @item -cdrom @var{file}
113 Use @var{file} as CD-ROM image (you cannot use @option{-hdc} and
114 @option{-cdrom} at the same time). You can use the host CD-ROM by
115 using @file{/dev/cdrom} as filename (@pxref{host_drives}).
118 DEF("drive", HAS_ARG, QEMU_OPTION_drive,
119 "-drive [file=file][,if=type][,bus=n][,unit=m][,media=d][,index=i]\n"
120 " [,cyls=c,heads=h,secs=s[,trans=t]][,snapshot=on|off]\n"
121 " [,cache=writethrough|writeback|none|unsafe][,format=f]\n"
122 " [,serial=s][,addr=A][,id=name][,aio=threads|native]\n"
123 " [,readonly=on|off]\n"
124 " use 'file' as a drive image\n", QEMU_ARCH_ALL)
126 @item -drive @var{option}[,@var{option}[,@var{option}[,...]]]
129 Define a new drive. Valid options are:
132 @item file=@var{file}
133 This option defines which disk image (@pxref{disk_images}) to use with
134 this drive. If the filename contains comma, you must double it
135 (for instance, "file=my,,file" to use file "my,file").
136 @item if=@var{interface}
137 This option defines on which type on interface the drive is connected.
138 Available types are: ide, scsi, sd, mtd, floppy, pflash, virtio.
139 @item bus=@var{bus},unit=@var{unit}
140 These options define where is connected the drive by defining the bus number and
142 @item index=@var{index}
143 This option defines where is connected the drive by using an index in the list
144 of available connectors of a given interface type.
145 @item media=@var{media}
146 This option defines the type of the media: disk or cdrom.
147 @item cyls=@var{c},heads=@var{h},secs=@var{s}[,trans=@var{t}]
148 These options have the same definition as they have in @option{-hdachs}.
149 @item snapshot=@var{snapshot}
150 @var{snapshot} is "on" or "off" and allows to enable snapshot for given drive (see @option{-snapshot}).
151 @item cache=@var{cache}
152 @var{cache} is "none", "writeback", "unsafe", or "writethrough" and controls how the host cache is used to access block data.
154 @var{aio} is "threads", or "native" and selects between pthread based disk I/O and native Linux AIO.
155 @item format=@var{format}
156 Specify which disk @var{format} will be used rather than detecting
157 the format. Can be used to specifiy format=raw to avoid interpreting
158 an untrusted format header.
159 @item serial=@var{serial}
160 This option specifies the serial number to assign to the device.
161 @item addr=@var{addr}
162 Specify the controller's PCI address (if=virtio only).
165 By default, writethrough caching is used for all block device. This means that
166 the host page cache will be used to read and write data but write notification
167 will be sent to the guest only when the data has been reported as written by
168 the storage subsystem.
170 Writeback caching will report data writes as completed as soon as the data is
171 present in the host page cache. This is safe as long as you trust your host.
172 If your host crashes or loses power, then the guest may experience data
175 The host page cache can be avoided entirely with @option{cache=none}. This will
176 attempt to do disk IO directly to the guests memory. QEMU may still perform
177 an internal copy of the data.
179 Some block drivers perform badly with @option{cache=writethrough}, most notably,
180 qcow2. If performance is more important than correctness,
181 @option{cache=writeback} should be used with qcow2.
183 In case you don't care about data integrity over host failures, use
184 cache=unsafe. This option tells qemu that it never needs to write any data
185 to the disk but can instead keeps things in cache. If anything goes wrong,
186 like your host losing power, the disk storage getting disconnected accidently,
187 etc. you're image will most probably be rendered unusable. When using
188 the @option{-snapshot} option, unsafe caching is always used.
190 Instead of @option{-cdrom} you can use:
192 qemu -drive file=file,index=2,media=cdrom
195 Instead of @option{-hda}, @option{-hdb}, @option{-hdc}, @option{-hdd}, you can
198 qemu -drive file=file,index=0,media=disk
199 qemu -drive file=file,index=1,media=disk
200 qemu -drive file=file,index=2,media=disk
201 qemu -drive file=file,index=3,media=disk
204 You can connect a CDROM to the slave of ide0:
206 qemu -drive file=file,if=ide,index=1,media=cdrom
209 If you don't specify the "file=" argument, you define an empty drive:
211 qemu -drive if=ide,index=1,media=cdrom
214 You can connect a SCSI disk with unit ID 6 on the bus #0:
216 qemu -drive file=file,if=scsi,bus=0,unit=6
219 Instead of @option{-fda}, @option{-fdb}, you can use:
221 qemu -drive file=file,index=0,if=floppy
222 qemu -drive file=file,index=1,if=floppy
225 By default, @var{interface} is "ide" and @var{index} is automatically
228 qemu -drive file=a -drive file=b"
236 DEF("set", HAS_ARG, QEMU_OPTION_set,
237 "-set group.id.arg=value\n"
238 " set <arg> parameter for item <id> of type <group>\n"
239 " i.e. -set drive.$id.file=/path/to/image\n", QEMU_ARCH_ALL)
246 DEF("global", HAS_ARG, QEMU_OPTION_global,
247 "-global driver.property=value\n"
248 " set a global default for a driver property\n",
256 DEF("mtdblock", HAS_ARG, QEMU_OPTION_mtdblock,
257 "-mtdblock file use 'file' as on-board Flash memory image\n",
260 @item -mtdblock @var{file}
262 Use @var{file} as on-board Flash memory image.
265 DEF("sd", HAS_ARG, QEMU_OPTION_sd,
266 "-sd file use 'file' as SecureDigital card image\n", QEMU_ARCH_ALL)
270 Use @var{file} as SecureDigital card image.
273 DEF("pflash", HAS_ARG, QEMU_OPTION_pflash,
274 "-pflash file use 'file' as a parallel flash image\n", QEMU_ARCH_ALL)
276 @item -pflash @var{file}
278 Use @var{file} as a parallel flash image.
281 DEF("boot", HAS_ARG, QEMU_OPTION_boot,
282 "-boot [order=drives][,once=drives][,menu=on|off]\n"
283 " 'drives': floppy (a), hard disk (c), CD-ROM (d), network (n)\n",
286 @item -boot [order=@var{drives}][,once=@var{drives}][,menu=on|off]
288 Specify boot order @var{drives} as a string of drive letters. Valid
289 drive letters depend on the target achitecture. The x86 PC uses: a, b
290 (floppy 1 and 2), c (first hard disk), d (first CD-ROM), n-p (Etherboot
291 from network adapter 1-4), hard disk boot is the default. To apply a
292 particular boot order only on the first startup, specify it via
295 Interactive boot menus/prompts can be enabled via @option{menu=on} as far
296 as firmware/BIOS supports them. The default is non-interactive boot.
299 # try to boot from network first, then from hard disk
301 # boot from CD-ROM first, switch back to default order after reboot
305 Note: The legacy format '-boot @var{drives}' is still supported but its
306 use is discouraged as it may be removed from future versions.
309 DEF("snapshot", 0, QEMU_OPTION_snapshot,
310 "-snapshot write to temporary files instead of disk image files\n",
315 Write to temporary files instead of disk image files. In this case,
316 the raw disk image you use is not written back. You can however force
317 the write back by pressing @key{C-a s} (@pxref{disk_images}).
320 DEF("m", HAS_ARG, QEMU_OPTION_m,
321 "-m megs set virtual RAM size to megs MB [default="
322 stringify(DEFAULT_RAM_SIZE) "]\n", QEMU_ARCH_ALL)
326 Set virtual RAM size to @var{megs} megabytes. Default is 128 MiB. Optionally,
327 a suffix of ``M'' or ``G'' can be used to signify a value in megabytes or
328 gigabytes respectively.
331 DEF("mem-path", HAS_ARG, QEMU_OPTION_mempath,
332 "-mem-path FILE provide backing storage for guest RAM\n", QEMU_ARCH_ALL)
334 @item -mem-path @var{path}
335 Allocate guest RAM from a temporarily created file in @var{path}.
339 DEF("mem-prealloc", 0, QEMU_OPTION_mem_prealloc,
340 "-mem-prealloc preallocate guest memory (use with -mem-path)\n",
344 Preallocate memory when using -mem-path.
348 DEF("k", HAS_ARG, QEMU_OPTION_k,
349 "-k language use keyboard layout (for example 'fr' for French)\n",
352 @item -k @var{language}
354 Use keyboard layout @var{language} (for example @code{fr} for
355 French). This option is only needed where it is not easy to get raw PC
356 keycodes (e.g. on Macs, with some X11 servers or with a VNC
357 display). You don't normally need to use it on PC/Linux or PC/Windows
360 The available layouts are:
362 ar de-ch es fo fr-ca hu ja mk no pt-br sv
363 da en-gb et fr fr-ch is lt nl pl ru th
364 de en-us fi fr-be hr it lv nl-be pt sl tr
367 The default is @code{en-us}.
371 DEF("audio-help", 0, QEMU_OPTION_audio_help,
372 "-audio-help print list of audio drivers and their options\n",
377 Will show the audio subsystem help: list of drivers, tunable
381 DEF("soundhw", HAS_ARG, QEMU_OPTION_soundhw,
382 "-soundhw c1,... enable audio support\n"
383 " and only specified sound cards (comma separated list)\n"
384 " use -soundhw ? to get the list of supported cards\n"
385 " use -soundhw all to enable all of them\n", QEMU_ARCH_ALL)
387 @item -soundhw @var{card1}[,@var{card2},...] or -soundhw all
389 Enable audio and selected sound hardware. Use ? to print all
390 available sound hardware.
393 qemu -soundhw sb16,adlib disk.img
394 qemu -soundhw es1370 disk.img
395 qemu -soundhw ac97 disk.img
396 qemu -soundhw hda disk.img
397 qemu -soundhw all disk.img
401 Note that Linux's i810_audio OSS kernel (for AC97) module might
402 require manually specifying clocking.
405 modprobe i810_audio clocking=48000
413 DEF("usb", 0, QEMU_OPTION_usb,
414 "-usb enable the USB driver (will be the default soon)\n",
422 Enable the USB driver (will be the default soon)
425 DEF("usbdevice", HAS_ARG, QEMU_OPTION_usbdevice,
426 "-usbdevice name add the host or guest USB device 'name'\n",
430 @item -usbdevice @var{devname}
432 Add the USB device @var{devname}. @xref{usb_devices}.
437 Virtual Mouse. This will override the PS/2 mouse emulation when activated.
440 Pointer device that uses absolute coordinates (like a touchscreen). This
441 means qemu is able to report the mouse position without having to grab the
442 mouse. Also overrides the PS/2 mouse emulation when activated.
444 @item disk:[format=@var{format}]:@var{file}
445 Mass storage device based on file. The optional @var{format} argument
446 will be used rather than detecting the format. Can be used to specifiy
447 @code{format=raw} to avoid interpreting an untrusted format header.
449 @item host:@var{bus}.@var{addr}
450 Pass through the host device identified by @var{bus}.@var{addr} (Linux only).
452 @item host:@var{vendor_id}:@var{product_id}
453 Pass through the host device identified by @var{vendor_id}:@var{product_id}
456 @item serial:[vendorid=@var{vendor_id}][,productid=@var{product_id}]:@var{dev}
457 Serial converter to host character device @var{dev}, see @code{-serial} for the
461 Braille device. This will use BrlAPI to display the braille output on a real
464 @item net:@var{options}
465 Network adapter that supports CDC ethernet and RNDIS protocols.
470 DEF("device", HAS_ARG, QEMU_OPTION_device,
471 "-device driver[,prop[=value][,...]]\n"
472 " add device (based on driver)\n"
473 " prop=value,... sets driver properties\n"
474 " use -device ? to print all possible drivers\n"
475 " use -device driver,? to print all possible properties\n",
478 @item -device @var{driver}[,@var{prop}[=@var{value}][,...]]
480 Add device @var{driver}. @var{prop}=@var{value} sets driver
481 properties. Valid properties depend on the driver. To get help on
482 possible drivers and properties, use @code{-device ?} and
483 @code{-device @var{driver},?}.
486 DEFHEADING(File system options:)
488 DEF("fsdev", HAS_ARG, QEMU_OPTION_fsdev,
489 "-fsdev local,id=id,path=path,security_model=[mapped|passthrough|none]\n",
494 The general form of a File system device option is:
497 @item -fsdev @var{fstype} ,id=@var{id} [,@var{options}]
501 The specific Fstype will determine the applicable options.
503 Options to each backend are described below.
505 @item -fsdev local ,id=@var{id} ,path=@var{path} ,security_model=@var{security_model}
507 Create a file-system-"device" for local-filesystem.
509 @option{local} is only available on Linux.
511 @option{path} specifies the path to be exported. @option{path} is required.
513 @option{security_model} specifies the security model to be followed.
514 @option{security_model} is required.
519 DEFHEADING(Virtual File system pass-through options:)
521 DEF("virtfs", HAS_ARG, QEMU_OPTION_virtfs,
522 "-virtfs local,path=path,mount_tag=tag,security_model=[mapped|passthrough|none]\n",
527 The general form of a Virtual File system pass-through option is:
530 @item -virtfs @var{fstype} [,@var{options}]
534 The specific Fstype will determine the applicable options.
536 Options to each backend are described below.
538 @item -virtfs local ,path=@var{path} ,mount_tag=@var{mount_tag} ,security_model=@var{security_model}
540 Create a Virtual file-system-pass through for local-filesystem.
542 @option{local} is only available on Linux.
544 @option{path} specifies the path to be exported. @option{path} is required.
546 @option{security_model} specifies the security model to be followed.
547 @option{security_model} is required.
550 @option{mount_tag} specifies the tag with which the exported file is mounted.
551 @option{mount_tag} is required.
558 DEF("name", HAS_ARG, QEMU_OPTION_name,
559 "-name string1[,process=string2]\n"
560 " set the name of the guest\n"
561 " string1 sets the window title and string2 the process name (on Linux)\n",
564 @item -name @var{name}
566 Sets the @var{name} of the guest.
567 This name will be displayed in the SDL window caption.
568 The @var{name} will also be used for the VNC server.
569 Also optionally set the top visible process name in Linux.
572 DEF("uuid", HAS_ARG, QEMU_OPTION_uuid,
573 "-uuid %08x-%04x-%04x-%04x-%012x\n"
574 " specify machine UUID\n", QEMU_ARCH_ALL)
576 @item -uuid @var{uuid}
587 DEFHEADING(Display options:)
593 DEF("display", HAS_ARG, QEMU_OPTION_display,
594 "-display sdl[,frame=on|off][,alt_grab=on|off][,ctrl_grab=on|off]\n"
595 " [,window_close=on|off]|curses|none|\n"
596 " vnc=<display>[,<optargs>]\n"
597 " select display type\n", QEMU_ARCH_ALL)
599 @item -display @var{type}
601 Select type of display to use. This option is a replacement for the
602 old style -sdl/-curses/... options. Valid values for @var{type} are
605 Display video output via SDL (usually in a separate graphics
606 window; see the SDL documentation for other possibilities).
608 Display video output via curses. For graphics device models which
609 support a text mode, QEMU can display this output using a
610 curses/ncurses interface. Nothing is displayed when the graphics
611 device is in graphical mode or if the graphics device does not support
612 a text mode. Generally only the VGA device models support text mode.
614 Do not display video output. The guest will still see an emulated
615 graphics card, but its output will not be displayed to the QEMU
616 user. This option differs from the -nographic option in that it
617 only affects what is done with video output; -nographic also changes
618 the destination of the serial and parallel port data.
620 Start a VNC server on display <arg>
624 DEF("nographic", 0, QEMU_OPTION_nographic,
625 "-nographic disable graphical output and redirect serial I/Os to console\n",
630 Normally, QEMU uses SDL to display the VGA output. With this option,
631 you can totally disable graphical output so that QEMU is a simple
632 command line application. The emulated serial port is redirected on
633 the console. Therefore, you can still use QEMU to debug a Linux kernel
634 with a serial console.
638 DEF("curses", 0, QEMU_OPTION_curses,
639 "-curses use a curses/ncurses interface instead of SDL\n",
645 Normally, QEMU uses SDL to display the VGA output. With this option,
646 QEMU can display the VGA output when in text mode using a
647 curses/ncurses interface. Nothing is displayed in graphical mode.
651 DEF("no-frame", 0, QEMU_OPTION_no_frame,
652 "-no-frame open SDL window without a frame and window decorations\n",
658 Do not use decorations for SDL windows and start them using the whole
659 available screen space. This makes the using QEMU in a dedicated desktop
660 workspace more convenient.
664 DEF("alt-grab", 0, QEMU_OPTION_alt_grab,
665 "-alt-grab use Ctrl-Alt-Shift to grab mouse (instead of Ctrl-Alt)\n",
671 Use Ctrl-Alt-Shift to grab mouse (instead of Ctrl-Alt).
675 DEF("ctrl-grab", 0, QEMU_OPTION_ctrl_grab,
676 "-ctrl-grab use Right-Ctrl to grab mouse (instead of Ctrl-Alt)\n",
682 Use Right-Ctrl to grab mouse (instead of Ctrl-Alt).
686 DEF("no-quit", 0, QEMU_OPTION_no_quit,
687 "-no-quit disable SDL window close capability\n", QEMU_ARCH_ALL)
692 Disable SDL window close capability.
696 DEF("sdl", 0, QEMU_OPTION_sdl,
697 "-sdl enable SDL\n", QEMU_ARCH_ALL)
705 DEF("spice", HAS_ARG, QEMU_OPTION_spice,
706 "-spice <args> enable spice\n", QEMU_ARCH_ALL)
708 @item -spice @var{option}[,@var{option}[,...]]
710 Enable the spice remote desktop protocol. Valid options are
715 Set the TCP port spice is listening on for plaintext channels.
718 Set the IP address spice is listening on. Default is any address.
722 Force using the specified IP version.
724 @item password=<secret>
725 Set the password you need to authenticate.
727 @item disable-ticketing
728 Allow client connects without authentication.
731 Set the TCP port spice is listening on for encrypted channels.
734 Set the x509 file directory. Expects same filenames as -vnc $display,x509=$dir
736 @item x509-key-file=<file>
737 @item x509-key-password=<file>
738 @item x509-cert-file=<file>
739 @item x509-cacert-file=<file>
740 @item x509-dh-key-file=<file>
741 The x509 file names can also be configured individually.
743 @item tls-ciphers=<list>
744 Specify which ciphers to use.
746 @item tls-channel=[main|display|inputs|record|playback|tunnel]
747 @item plaintext-channel=[main|display|inputs|record|playback|tunnel]
748 Force specific channel to be used with or without TLS encryption. The
749 options can be specified multiple times to configure multiple
750 channels. The special name "default" can be used to set the default
751 mode. For channels which are not explicitly forced into one mode the
752 spice client is allowed to pick tls/plaintext as he pleases.
754 @item image-compression=[auto_glz|auto_lz|quic|glz|lz|off]
755 Configure image compression (lossless).
758 @item jpeg-wan-compression=[auto|never|always]
759 @item zlib-glz-wan-compression=[auto|never|always]
760 Configure wan image compression (lossy for slow links).
763 @item streaming-video=[off|all|filter]
764 Configure video stream detection. Default is filter.
766 @item agent-mouse=[on|off]
767 Enable/disable passing mouse events via vdagent. Default is on.
769 @item playback-compression=[on|off]
770 Enable/disable audio stream compression (using celt 0.5.1). Default is on.
775 DEF("portrait", 0, QEMU_OPTION_portrait,
776 "-portrait rotate graphical output 90 deg left (only PXA LCD)\n",
781 Rotate graphical output 90 deg left (only PXA LCD).
784 DEF("vga", HAS_ARG, QEMU_OPTION_vga,
785 "-vga [std|cirrus|vmware|qxl|xenfb|none]\n"
786 " select video card type\n", QEMU_ARCH_ALL)
788 @item -vga @var{type}
790 Select type of VGA card to emulate. Valid values for @var{type} are
793 Cirrus Logic GD5446 Video card. All Windows versions starting from
794 Windows 95 should recognize and use this graphic card. For optimal
795 performances, use 16 bit color depth in the guest and the host OS.
796 (This one is the default)
798 Standard VGA card with Bochs VBE extensions. If your guest OS
799 supports the VESA 2.0 VBE extensions (e.g. Windows XP) and if you want
800 to use high resolution modes (>= 1280x1024x16) then you should use
803 VMWare SVGA-II compatible adapter. Use it if you have sufficiently
804 recent XFree86/XOrg server or Windows guest with a driver for this
807 QXL paravirtual graphic card. It is VGA compatible (including VESA
808 2.0 VBE support). Works best with qxl guest drivers installed though.
809 Recommended choice when using the spice protocol.
815 DEF("full-screen", 0, QEMU_OPTION_full_screen,
816 "-full-screen start in full screen\n", QEMU_ARCH_ALL)
820 Start in full screen.
823 DEF("g", 1, QEMU_OPTION_g ,
824 "-g WxH[xDEPTH] Set the initial graphical resolution and depth\n",
825 QEMU_ARCH_PPC | QEMU_ARCH_SPARC)
827 @item -g @var{width}x@var{height}[x@var{depth}]
829 Set the initial graphical resolution and depth (PPC, SPARC only).
832 DEF("vnc", HAS_ARG, QEMU_OPTION_vnc ,
833 "-vnc display start a VNC server on display\n", QEMU_ARCH_ALL)
835 @item -vnc @var{display}[,@var{option}[,@var{option}[,...]]]
837 Normally, QEMU uses SDL to display the VGA output. With this option,
838 you can have QEMU listen on VNC display @var{display} and redirect the VGA
839 display over the VNC session. It is very useful to enable the usb
840 tablet device when using this option (option @option{-usbdevice
841 tablet}). When using the VNC display, you must use the @option{-k}
842 parameter to set the keyboard layout if you are not using en-us. Valid
843 syntax for the @var{display} is
847 @item @var{host}:@var{d}
849 TCP connections will only be allowed from @var{host} on display @var{d}.
850 By convention the TCP port is 5900+@var{d}. Optionally, @var{host} can
851 be omitted in which case the server will accept connections from any host.
853 @item unix:@var{path}
855 Connections will be allowed over UNIX domain sockets where @var{path} is the
856 location of a unix socket to listen for connections on.
860 VNC is initialized but not started. The monitor @code{change} command
861 can be used to later start the VNC server.
865 Following the @var{display} value there may be one or more @var{option} flags
866 separated by commas. Valid options are
872 Connect to a listening VNC client via a ``reverse'' connection. The
873 client is specified by the @var{display}. For reverse network
874 connections (@var{host}:@var{d},@code{reverse}), the @var{d} argument
875 is a TCP port number, not a display number.
879 Require that password based authentication is used for client connections.
880 The password must be set separately using the @code{change} command in the
885 Require that client use TLS when communicating with the VNC server. This
886 uses anonymous TLS credentials so is susceptible to a man-in-the-middle
887 attack. It is recommended that this option be combined with either the
888 @option{x509} or @option{x509verify} options.
890 @item x509=@var{/path/to/certificate/dir}
892 Valid if @option{tls} is specified. Require that x509 credentials are used
893 for negotiating the TLS session. The server will send its x509 certificate
894 to the client. It is recommended that a password be set on the VNC server
895 to provide authentication of the client when this is used. The path following
896 this option specifies where the x509 certificates are to be loaded from.
897 See the @ref{vnc_security} section for details on generating certificates.
899 @item x509verify=@var{/path/to/certificate/dir}
901 Valid if @option{tls} is specified. Require that x509 credentials are used
902 for negotiating the TLS session. The server will send its x509 certificate
903 to the client, and request that the client send its own x509 certificate.
904 The server will validate the client's certificate against the CA certificate,
905 and reject clients when validation fails. If the certificate authority is
906 trusted, this is a sufficient authentication mechanism. You may still wish
907 to set a password on the VNC server as a second authentication layer. The
908 path following this option specifies where the x509 certificates are to
909 be loaded from. See the @ref{vnc_security} section for details on generating
914 Require that the client use SASL to authenticate with the VNC server.
915 The exact choice of authentication method used is controlled from the
916 system / user's SASL configuration file for the 'qemu' service. This
917 is typically found in /etc/sasl2/qemu.conf. If running QEMU as an
918 unprivileged user, an environment variable SASL_CONF_PATH can be used
919 to make it search alternate locations for the service config.
920 While some SASL auth methods can also provide data encryption (eg GSSAPI),
921 it is recommended that SASL always be combined with the 'tls' and
922 'x509' settings to enable use of SSL and server certificates. This
923 ensures a data encryption preventing compromise of authentication
924 credentials. See the @ref{vnc_security} section for details on using
929 Turn on access control lists for checking of the x509 client certificate
930 and SASL party. For x509 certs, the ACL check is made against the
931 certificate's distinguished name. This is something that looks like
932 @code{C=GB,O=ACME,L=Boston,CN=bob}. For SASL party, the ACL check is
933 made against the username, which depending on the SASL plugin, may
934 include a realm component, eg @code{bob} or @code{bob@@EXAMPLE.COM}.
935 When the @option{acl} flag is set, the initial access list will be
936 empty, with a @code{deny} policy. Thus no one will be allowed to
937 use the VNC server until the ACLs have been loaded. This can be
938 achieved using the @code{acl} monitor command.
942 Enable lossy compression methods (gradient, JPEG, ...). If this
943 option is set, VNC client may receive lossy framebuffer updates
944 depending on its encoding settings. Enabling this option can save
945 a lot of bandwidth at the expense of quality.
949 Disable adaptive encodings. Adaptive encodings are enabled by default.
950 An adaptive encoding will try to detect frequently updated screen regions,
951 and send updates in these regions using a lossy encoding (like JPEG).
952 This can be really helpfull to save bandwidth when playing videos. Disabling
953 adaptive encodings allow to restore the original static behavior of encodings
965 DEFHEADING(i386 target only:)
970 DEF("win2k-hack", 0, QEMU_OPTION_win2k_hack,
971 "-win2k-hack use it when installing Windows 2000 to avoid a disk full bug\n",
976 Use it when installing Windows 2000 to avoid a disk full bug. After
977 Windows 2000 is installed, you no longer need this option (this option
978 slows down the IDE transfers).
981 HXCOMM Deprecated by -rtc
982 DEF("rtc-td-hack", 0, QEMU_OPTION_rtc_td_hack, "", QEMU_ARCH_I386)
984 DEF("no-fd-bootchk", 0, QEMU_OPTION_no_fd_bootchk,
985 "-no-fd-bootchk disable boot signature checking for floppy disks\n",
989 @findex -no-fd-bootchk
990 Disable boot signature checking for floppy disks in Bochs BIOS. It may
991 be needed to boot from old floppy disks.
992 TODO: check reference to Bochs BIOS.
995 DEF("no-acpi", 0, QEMU_OPTION_no_acpi,
996 "-no-acpi disable ACPI\n", QEMU_ARCH_I386)
1000 Disable ACPI (Advanced Configuration and Power Interface) support. Use
1001 it if your guest OS complains about ACPI problems (PC target machine
1005 DEF("no-hpet", 0, QEMU_OPTION_no_hpet,
1006 "-no-hpet disable HPET\n", QEMU_ARCH_I386)
1010 Disable HPET support.
1013 DEF("balloon", HAS_ARG, QEMU_OPTION_balloon,
1014 "-balloon none disable balloon device\n"
1015 "-balloon virtio[,addr=str]\n"
1016 " enable virtio balloon device (default)\n", QEMU_ARCH_ALL)
1020 Disable balloon device.
1021 @item -balloon virtio[,addr=@var{addr}]
1022 Enable virtio balloon device (default), optionally with PCI address
1026 DEF("acpitable", HAS_ARG, QEMU_OPTION_acpitable,
1027 "-acpitable [sig=str][,rev=n][,oem_id=str][,oem_table_id=str][,oem_rev=n][,asl_compiler_id=str][,asl_compiler_rev=n][,data=file1[:file2]...]\n"
1028 " ACPI table description\n", QEMU_ARCH_I386)
1030 @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}]...]
1032 Add ACPI table with specified header fields and context from specified files.
1035 DEF("smbios", HAS_ARG, QEMU_OPTION_smbios,
1036 "-smbios file=binary\n"
1037 " load SMBIOS entry from binary file\n"
1038 "-smbios type=0[,vendor=str][,version=str][,date=str][,release=%d.%d]\n"
1039 " specify SMBIOS type 0 fields\n"
1040 "-smbios type=1[,manufacturer=str][,product=str][,version=str][,serial=str]\n"
1041 " [,uuid=uuid][,sku=str][,family=str]\n"
1042 " specify SMBIOS type 1 fields\n", QEMU_ARCH_I386)
1044 @item -smbios file=@var{binary}
1046 Load SMBIOS entry from binary file.
1048 @item -smbios type=0[,vendor=@var{str}][,version=@var{str}][,date=@var{str}][,release=@var{%d.%d}]
1050 Specify SMBIOS type 0 fields
1052 @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}]
1053 Specify SMBIOS type 1 fields
1061 DEFHEADING(Network options:)
1066 HXCOMM Legacy slirp options (now moved to -net user):
1068 DEF("tftp", HAS_ARG, QEMU_OPTION_tftp, "", QEMU_ARCH_ALL)
1069 DEF("bootp", HAS_ARG, QEMU_OPTION_bootp, "", QEMU_ARCH_ALL)
1070 DEF("redir", HAS_ARG, QEMU_OPTION_redir, "", QEMU_ARCH_ALL)
1072 DEF("smb", HAS_ARG, QEMU_OPTION_smb, "", QEMU_ARCH_ALL)
1076 DEF("net", HAS_ARG, QEMU_OPTION_net,
1077 "-net nic[,vlan=n][,macaddr=mac][,model=type][,name=str][,addr=str][,vectors=v]\n"
1078 " create a new Network Interface Card and connect it to VLAN 'n'\n"
1080 "-net user[,vlan=n][,name=str][,net=addr[/mask]][,host=addr][,restrict=y|n]\n"
1081 " [,hostname=host][,dhcpstart=addr][,dns=addr][,tftp=dir][,bootfile=f]\n"
1082 " [,hostfwd=rule][,guestfwd=rule]"
1084 "[,smb=dir[,smbserver=addr]]\n"
1086 " connect the user mode network stack to VLAN 'n', configure its\n"
1087 " DHCP server and enabled optional services\n"
1090 "-net tap[,vlan=n][,name=str],ifname=name\n"
1091 " connect the host TAP network interface to VLAN 'n'\n"
1093 "-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"
1094 " connect the host TAP network interface to VLAN 'n' and use the\n"
1095 " network scripts 'file' (default=" DEFAULT_NETWORK_SCRIPT ")\n"
1096 " and 'dfile' (default=" DEFAULT_NETWORK_DOWN_SCRIPT ")\n"
1097 " use '[down]script=no' to disable script execution\n"
1098 " use 'fd=h' to connect to an already opened TAP interface\n"
1099 " use 'sndbuf=nbytes' to limit the size of the send buffer (the\n"
1100 " default is disabled 'sndbuf=0' to enable flow control set 'sndbuf=1048576')\n"
1101 " use vnet_hdr=off to avoid enabling the IFF_VNET_HDR tap flag\n"
1102 " use vnet_hdr=on to make the lack of IFF_VNET_HDR support an error condition\n"
1103 " use vhost=on to enable experimental in kernel accelerator\n"
1104 " (only has effect for virtio guests which use MSIX)\n"
1105 " use vhostforce=on to force vhost on for non-MSIX virtio guests\n"
1106 " use 'vhostfd=h' to connect to an already opened vhost net device\n"
1108 "-net socket[,vlan=n][,name=str][,fd=h][,listen=[host]:port][,connect=host:port]\n"
1109 " connect the vlan 'n' to another VLAN using a socket connection\n"
1110 "-net socket[,vlan=n][,name=str][,fd=h][,mcast=maddr:port[,localaddr=addr]]\n"
1111 " connect the vlan 'n' to multicast maddr and port\n"
1112 " use 'localaddr=addr' to specify the host address to send packets from\n"
1114 "-net vde[,vlan=n][,name=str][,sock=socketpath][,port=n][,group=groupname][,mode=octalmode]\n"
1115 " connect the vlan 'n' to port 'n' of a vde switch running\n"
1116 " on host and listening for incoming connections on 'socketpath'.\n"
1117 " Use group 'groupname' and mode 'octalmode' to change default\n"
1118 " ownership and permissions for communication port.\n"
1120 "-net dump[,vlan=n][,file=f][,len=n]\n"
1121 " dump traffic on vlan 'n' to file 'f' (max n bytes per packet)\n"
1122 "-net none use it alone to have zero network devices. If no -net option\n"
1123 " is provided, the default is '-net nic -net user'\n", QEMU_ARCH_ALL)
1124 DEF("netdev", HAS_ARG, QEMU_OPTION_netdev,
1133 "socket],id=str[,option][,option][,...]\n", QEMU_ARCH_ALL)
1135 @item -net nic[,vlan=@var{n}][,macaddr=@var{mac}][,model=@var{type}] [,name=@var{name}][,addr=@var{addr}][,vectors=@var{v}]
1137 Create a new Network Interface Card and connect it to VLAN @var{n} (@var{n}
1138 = 0 is the default). The NIC is an e1000 by default on the PC
1139 target. Optionally, the MAC address can be changed to @var{mac}, the
1140 device address set to @var{addr} (PCI cards only),
1141 and a @var{name} can be assigned for use in monitor commands.
1142 Optionally, for PCI cards, you can specify the number @var{v} of MSI-X vectors
1143 that the card should have; this option currently only affects virtio cards; set
1144 @var{v} = 0 to disable MSI-X. If no @option{-net} option is specified, a single
1145 NIC is created. Qemu can emulate several different models of network card.
1146 Valid values for @var{type} are
1147 @code{virtio}, @code{i82551}, @code{i82557b}, @code{i82559er},
1148 @code{ne2k_pci}, @code{ne2k_isa}, @code{pcnet}, @code{rtl8139},
1149 @code{e1000}, @code{smc91c111}, @code{lance} and @code{mcf_fec}.
1150 Not all devices are supported on all targets. Use -net nic,model=?
1151 for a list of available devices for your target.
1153 @item -net user[,@var{option}][,@var{option}][,...]
1154 Use the user mode network stack which requires no administrator
1155 privilege to run. Valid options are:
1159 Connect user mode stack to VLAN @var{n} (@var{n} = 0 is the default).
1161 @item name=@var{name}
1162 Assign symbolic name for use in monitor commands.
1164 @item net=@var{addr}[/@var{mask}]
1165 Set IP network address the guest will see. Optionally specify the netmask,
1166 either in the form a.b.c.d or as number of valid top-most bits. Default is
1169 @item host=@var{addr}
1170 Specify the guest-visible address of the host. Default is the 2nd IP in the
1171 guest network, i.e. x.x.x.2.
1173 @item restrict=y|yes|n|no
1174 If this options is enabled, the guest will be isolated, i.e. it will not be
1175 able to contact the host and no guest IP packets will be routed over the host
1176 to the outside. This option does not affect explicitly set forwarding rule.
1178 @item hostname=@var{name}
1179 Specifies the client hostname reported by the builtin DHCP server.
1181 @item dhcpstart=@var{addr}
1182 Specify the first of the 16 IPs the built-in DHCP server can assign. Default
1183 is the 16th to 31st IP in the guest network, i.e. x.x.x.16 to x.x.x.31.
1185 @item dns=@var{addr}
1186 Specify the guest-visible address of the virtual nameserver. The address must
1187 be different from the host address. Default is the 3rd IP in the guest network,
1190 @item tftp=@var{dir}
1191 When using the user mode network stack, activate a built-in TFTP
1192 server. The files in @var{dir} will be exposed as the root of a TFTP server.
1193 The TFTP client on the guest must be configured in binary mode (use the command
1194 @code{bin} of the Unix TFTP client).
1196 @item bootfile=@var{file}
1197 When using the user mode network stack, broadcast @var{file} as the BOOTP
1198 filename. In conjunction with @option{tftp}, this can be used to network boot
1199 a guest from a local directory.
1201 Example (using pxelinux):
1203 qemu -hda linux.img -boot n -net user,tftp=/path/to/tftp/files,bootfile=/pxelinux.0
1206 @item smb=@var{dir}[,smbserver=@var{addr}]
1207 When using the user mode network stack, activate a built-in SMB
1208 server so that Windows OSes can access to the host files in @file{@var{dir}}
1209 transparently. The IP address of the SMB server can be set to @var{addr}. By
1210 default the 4th IP in the guest network is used, i.e. x.x.x.4.
1212 In the guest Windows OS, the line:
1216 must be added in the file @file{C:\WINDOWS\LMHOSTS} (for windows 9x/Me)
1217 or @file{C:\WINNT\SYSTEM32\DRIVERS\ETC\LMHOSTS} (Windows NT/2000).
1219 Then @file{@var{dir}} can be accessed in @file{\\smbserver\qemu}.
1221 Note that a SAMBA server must be installed on the host OS in
1222 @file{/usr/sbin/smbd}. QEMU was tested successfully with smbd versions from
1223 Red Hat 9, Fedora Core 3 and OpenSUSE 11.x.
1225 @item hostfwd=[tcp|udp]:[@var{hostaddr}]:@var{hostport}-[@var{guestaddr}]:@var{guestport}
1226 Redirect incoming TCP or UDP connections to the host port @var{hostport} to
1227 the guest IP address @var{guestaddr} on guest port @var{guestport}. If
1228 @var{guestaddr} is not specified, its value is x.x.x.15 (default first address
1229 given by the built-in DHCP server). By specifying @var{hostaddr}, the rule can
1230 be bound to a specific host interface. If no connection type is set, TCP is
1231 used. This option can be given multiple times.
1233 For example, to redirect host X11 connection from screen 1 to guest
1234 screen 0, use the following:
1238 qemu -net user,hostfwd=tcp:127.0.0.1:6001-:6000 [...]
1239 # this host xterm should open in the guest X11 server
1243 To redirect telnet connections from host port 5555 to telnet port on
1244 the guest, use the following:
1248 qemu -net user,hostfwd=tcp::5555-:23 [...]
1249 telnet localhost 5555
1252 Then when you use on the host @code{telnet localhost 5555}, you
1253 connect to the guest telnet server.
1255 @item guestfwd=[tcp]:@var{server}:@var{port}-@var{dev}
1256 Forward guest TCP connections to the IP address @var{server} on port @var{port}
1257 to the character device @var{dev}. This option can be given multiple times.
1261 Note: Legacy stand-alone options -tftp, -bootp, -smb and -redir are still
1262 processed and applied to -net user. Mixing them with the new configuration
1263 syntax gives undefined results. Their use for new applications is discouraged
1264 as they will be removed from future versions.
1266 @item -net tap[,vlan=@var{n}][,name=@var{name}][,fd=@var{h}][,ifname=@var{name}] [,script=@var{file}][,downscript=@var{dfile}]
1267 Connect the host TAP network interface @var{name} to VLAN @var{n}, use
1268 the network script @var{file} to configure it and the network script
1269 @var{dfile} to deconfigure it. If @var{name} is not provided, the OS
1270 automatically provides one. @option{fd}=@var{h} can be used to specify
1271 the handle of an already opened host TAP interface. The default network
1272 configure script is @file{/etc/qemu-ifup} and the default network
1273 deconfigure script is @file{/etc/qemu-ifdown}. Use @option{script=no}
1274 or @option{downscript=no} to disable script execution. Example:
1277 qemu linux.img -net nic -net tap
1280 More complicated example (two NICs, each one connected to a TAP device)
1282 qemu linux.img -net nic,vlan=0 -net tap,vlan=0,ifname=tap0 \
1283 -net nic,vlan=1 -net tap,vlan=1,ifname=tap1
1286 @item -net socket[,vlan=@var{n}][,name=@var{name}][,fd=@var{h}] [,listen=[@var{host}]:@var{port}][,connect=@var{host}:@var{port}]
1288 Connect the VLAN @var{n} to a remote VLAN in another QEMU virtual
1289 machine using a TCP socket connection. If @option{listen} is
1290 specified, QEMU waits for incoming connections on @var{port}
1291 (@var{host} is optional). @option{connect} is used to connect to
1292 another QEMU instance using the @option{listen} option. @option{fd}=@var{h}
1293 specifies an already opened TCP socket.
1297 # launch a first QEMU instance
1298 qemu linux.img -net nic,macaddr=52:54:00:12:34:56 \
1299 -net socket,listen=:1234
1300 # connect the VLAN 0 of this instance to the VLAN 0
1301 # of the first instance
1302 qemu linux.img -net nic,macaddr=52:54:00:12:34:57 \
1303 -net socket,connect=127.0.0.1:1234
1306 @item -net socket[,vlan=@var{n}][,name=@var{name}][,fd=@var{h}][,mcast=@var{maddr}:@var{port}[,localaddr=@var{addr}]]
1308 Create a VLAN @var{n} shared with another QEMU virtual
1309 machines using a UDP multicast socket, effectively making a bus for
1310 every QEMU with same multicast address @var{maddr} and @var{port}.
1314 Several QEMU can be running on different hosts and share same bus (assuming
1315 correct multicast setup for these hosts).
1317 mcast support is compatible with User Mode Linux (argument @option{eth@var{N}=mcast}), see
1318 @url{http://user-mode-linux.sf.net}.
1320 Use @option{fd=h} to specify an already opened UDP multicast socket.
1325 # launch one QEMU instance
1326 qemu linux.img -net nic,macaddr=52:54:00:12:34:56 \
1327 -net socket,mcast=230.0.0.1:1234
1328 # launch another QEMU instance on same "bus"
1329 qemu linux.img -net nic,macaddr=52:54:00:12:34:57 \
1330 -net socket,mcast=230.0.0.1:1234
1331 # launch yet another QEMU instance on same "bus"
1332 qemu linux.img -net nic,macaddr=52:54:00:12:34:58 \
1333 -net socket,mcast=230.0.0.1:1234
1336 Example (User Mode Linux compat.):
1338 # launch QEMU instance (note mcast address selected
1340 qemu linux.img -net nic,macaddr=52:54:00:12:34:56 \
1341 -net socket,mcast=239.192.168.1:1102
1343 /path/to/linux ubd0=/path/to/root_fs eth0=mcast
1346 Example (send packets from host's 1.2.3.4):
1348 qemu linux.img -net nic,macaddr=52:54:00:12:34:56 \
1349 -net socket,mcast=239.192.168.1:1102,localaddr=1.2.3.4
1352 @item -net vde[,vlan=@var{n}][,name=@var{name}][,sock=@var{socketpath}] [,port=@var{n}][,group=@var{groupname}][,mode=@var{octalmode}]
1353 Connect VLAN @var{n} to PORT @var{n} of a vde switch running on host and
1354 listening for incoming connections on @var{socketpath}. Use GROUP @var{groupname}
1355 and MODE @var{octalmode} to change default ownership and permissions for
1356 communication port. This option is available only if QEMU has been compiled
1357 with vde support enabled.
1362 vde_switch -F -sock /tmp/myswitch
1363 # launch QEMU instance
1364 qemu linux.img -net nic -net vde,sock=/tmp/myswitch
1367 @item -net dump[,vlan=@var{n}][,file=@var{file}][,len=@var{len}]
1368 Dump network traffic on VLAN @var{n} to file @var{file} (@file{qemu-vlan0.pcap} by default).
1369 At most @var{len} bytes (64k by default) per packet are stored. The file format is
1370 libpcap, so it can be analyzed with tools such as tcpdump or Wireshark.
1373 Indicate that no network devices should be configured. It is used to
1374 override the default configuration (@option{-net nic -net user}) which
1375 is activated if no @option{-net} options are provided.
1382 DEFHEADING(Character device options:)
1384 DEF("chardev", HAS_ARG, QEMU_OPTION_chardev,
1385 "-chardev null,id=id[,mux=on|off]\n"
1386 "-chardev socket,id=id[,host=host],port=host[,to=to][,ipv4][,ipv6][,nodelay]\n"
1387 " [,server][,nowait][,telnet][,mux=on|off] (tcp)\n"
1388 "-chardev socket,id=id,path=path[,server][,nowait][,telnet],[mux=on|off] (unix)\n"
1389 "-chardev udp,id=id[,host=host],port=port[,localaddr=localaddr]\n"
1390 " [,localport=localport][,ipv4][,ipv6][,mux=on|off]\n"
1391 "-chardev msmouse,id=id[,mux=on|off]\n"
1392 "-chardev vc,id=id[[,width=width][,height=height]][[,cols=cols][,rows=rows]]\n"
1394 "-chardev file,id=id,path=path[,mux=on|off]\n"
1395 "-chardev pipe,id=id,path=path[,mux=on|off]\n"
1397 "-chardev console,id=id[,mux=on|off]\n"
1398 "-chardev serial,id=id,path=path[,mux=on|off]\n"
1400 "-chardev pty,id=id[,mux=on|off]\n"
1401 "-chardev stdio,id=id[,mux=on|off][,signal=on|off]\n"
1403 #ifdef CONFIG_BRLAPI
1404 "-chardev braille,id=id[,mux=on|off]\n"
1406 #if defined(__linux__) || defined(__sun__) || defined(__FreeBSD__) \
1407 || defined(__NetBSD__) || defined(__OpenBSD__) || defined(__DragonFly__)
1408 "-chardev tty,id=id,path=path[,mux=on|off]\n"
1410 #if defined(__linux__) || defined(__FreeBSD__) || defined(__DragonFly__)
1411 "-chardev parport,id=id,path=path[,mux=on|off]\n"
1413 #if defined(CONFIG_SPICE)
1414 "-chardev spicevmc,id=id,name=name[,debug=debug]\n"
1421 The general form of a character device option is:
1424 @item -chardev @var{backend} ,id=@var{id} [,mux=on|off] [,@var{options}]
1442 The specific backend will determine the applicable options.
1444 All devices must have an id, which can be any string up to 127 characters long.
1445 It is used to uniquely identify this device in other command line directives.
1447 A character device may be used in multiplexing mode by multiple front-ends.
1448 The key sequence of @key{Control-a} and @key{c} will rotate the input focus
1449 between attached front-ends. Specify @option{mux=on} to enable this mode.
1451 Options to each backend are described below.
1453 @item -chardev null ,id=@var{id}
1454 A void device. This device will not emit any data, and will drop any data it
1455 receives. The null backend does not take any options.
1457 @item -chardev socket ,id=@var{id} [@var{TCP options} or @var{unix options}] [,server] [,nowait] [,telnet]
1459 Create a two-way stream socket, which can be either a TCP or a unix socket. A
1460 unix socket will be created if @option{path} is specified. Behaviour is
1461 undefined if TCP options are specified for a unix socket.
1463 @option{server} specifies that the socket shall be a listening socket.
1465 @option{nowait} specifies that QEMU should not block waiting for a client to
1466 connect to a listening socket.
1468 @option{telnet} specifies that traffic on the socket should interpret telnet
1471 TCP and unix socket options are given below:
1475 @item TCP options: port=@var{port} [,host=@var{host}] [,to=@var{to}] [,ipv4] [,ipv6] [,nodelay]
1477 @option{host} for a listening socket specifies the local address to be bound.
1478 For a connecting socket species the remote host to connect to. @option{host} is
1479 optional for listening sockets. If not specified it defaults to @code{0.0.0.0}.
1481 @option{port} for a listening socket specifies the local port to be bound. For a
1482 connecting socket specifies the port on the remote host to connect to.
1483 @option{port} can be given as either a port number or a service name.
1484 @option{port} is required.
1486 @option{to} is only relevant to listening sockets. If it is specified, and
1487 @option{port} cannot be bound, QEMU will attempt to bind to subsequent ports up
1488 to and including @option{to} until it succeeds. @option{to} must be specified
1491 @option{ipv4} and @option{ipv6} specify that either IPv4 or IPv6 must be used.
1492 If neither is specified the socket may use either protocol.
1494 @option{nodelay} disables the Nagle algorithm.
1496 @item unix options: path=@var{path}
1498 @option{path} specifies the local path of the unix socket. @option{path} is
1503 @item -chardev udp ,id=@var{id} [,host=@var{host}] ,port=@var{port} [,localaddr=@var{localaddr}] [,localport=@var{localport}] [,ipv4] [,ipv6]
1505 Sends all traffic from the guest to a remote host over UDP.
1507 @option{host} specifies the remote host to connect to. If not specified it
1508 defaults to @code{localhost}.
1510 @option{port} specifies the port on the remote host to connect to. @option{port}
1513 @option{localaddr} specifies the local address to bind to. If not specified it
1514 defaults to @code{0.0.0.0}.
1516 @option{localport} specifies the local port to bind to. If not specified any
1517 available local port will be used.
1519 @option{ipv4} and @option{ipv6} specify that either IPv4 or IPv6 must be used.
1520 If neither is specified the device may use either protocol.
1522 @item -chardev msmouse ,id=@var{id}
1524 Forward QEMU's emulated msmouse events to the guest. @option{msmouse} does not
1527 @item -chardev vc ,id=@var{id} [[,width=@var{width}] [,height=@var{height}]] [[,cols=@var{cols}] [,rows=@var{rows}]]
1529 Connect to a QEMU text console. @option{vc} may optionally be given a specific
1532 @option{width} and @option{height} specify the width and height respectively of
1533 the console, in pixels.
1535 @option{cols} and @option{rows} specify that the console be sized to fit a text
1536 console with the given dimensions.
1538 @item -chardev file ,id=@var{id} ,path=@var{path}
1540 Log all traffic received from the guest to a file.
1542 @option{path} specifies the path of the file to be opened. This file will be
1543 created if it does not already exist, and overwritten if it does. @option{path}
1546 @item -chardev pipe ,id=@var{id} ,path=@var{path}
1548 Create a two-way connection to the guest. The behaviour differs slightly between
1549 Windows hosts and other hosts:
1551 On Windows, a single duplex pipe will be created at
1552 @file{\\.pipe\@option{path}}.
1554 On other hosts, 2 pipes will be created called @file{@option{path}.in} and
1555 @file{@option{path}.out}. Data written to @file{@option{path}.in} will be
1556 received by the guest. Data written by the guest can be read from
1557 @file{@option{path}.out}. QEMU will not create these fifos, and requires them to
1560 @option{path} forms part of the pipe path as described above. @option{path} is
1563 @item -chardev console ,id=@var{id}
1565 Send traffic from the guest to QEMU's standard output. @option{console} does not
1568 @option{console} is only available on Windows hosts.
1570 @item -chardev serial ,id=@var{id} ,path=@option{path}
1572 Send traffic from the guest to a serial device on the host.
1575 only available on Windows hosts.
1577 @option{path} specifies the name of the serial device to open.
1579 @item -chardev pty ,id=@var{id}
1581 Create a new pseudo-terminal on the host and connect to it. @option{pty} does
1582 not take any options.
1584 @option{pty} is not available on Windows hosts.
1586 @item -chardev stdio ,id=@var{id} [,signal=on|off]
1587 Connect to standard input and standard output of the qemu process.
1589 @option{signal} controls if signals are enabled on the terminal, that includes
1590 exiting QEMU with the key sequence @key{Control-c}. This option is enabled by
1591 default, use @option{signal=off} to disable it.
1593 @option{stdio} is not available on Windows hosts.
1595 @item -chardev braille ,id=@var{id}
1597 Connect to a local BrlAPI server. @option{braille} does not take any options.
1599 @item -chardev tty ,id=@var{id} ,path=@var{path}
1601 Connect to a local tty device.
1603 @option{tty} is only available on Linux, Sun, FreeBSD, NetBSD, OpenBSD and
1606 @option{path} specifies the path to the tty. @option{path} is required.
1608 @item -chardev parport ,id=@var{id} ,path=@var{path}
1610 @option{parport} is only available on Linux, FreeBSD and DragonFlyBSD hosts.
1612 Connect to a local parallel port.
1614 @option{path} specifies the path to the parallel port device. @option{path} is
1617 #if defined(CONFIG_SPICE)
1618 @item -chardev spicevmc ,id=@var{id} ,debug=@var{debug}, name=@var{name}
1620 @option{debug} debug level for spicevmc
1622 @option{name} name of spice channel to connect to
1624 Connect to a spice virtual machine channel, such as vdiport.
1632 DEFHEADING(Bluetooth(R) options:)
1634 DEF("bt", HAS_ARG, QEMU_OPTION_bt, \
1635 "-bt hci,null dumb bluetooth HCI - doesn't respond to commands\n" \
1636 "-bt hci,host[:id]\n" \
1637 " use host's HCI with the given name\n" \
1638 "-bt hci[,vlan=n]\n" \
1639 " emulate a standard HCI in virtual scatternet 'n'\n" \
1640 "-bt vhci[,vlan=n]\n" \
1641 " add host computer to virtual scatternet 'n' using VHCI\n" \
1642 "-bt device:dev[,vlan=n]\n" \
1643 " emulate a bluetooth device 'dev' in scatternet 'n'\n",
1650 Defines the function of the corresponding Bluetooth HCI. -bt options
1651 are matched with the HCIs present in the chosen machine type. For
1652 example when emulating a machine with only one HCI built into it, only
1653 the first @code{-bt hci[...]} option is valid and defines the HCI's
1654 logic. The Transport Layer is decided by the machine type. Currently
1655 the machines @code{n800} and @code{n810} have one HCI and all other
1659 The following three types are recognized:
1663 (default) The corresponding Bluetooth HCI assumes no internal logic
1664 and will not respond to any HCI commands or emit events.
1666 @item -bt hci,host[:@var{id}]
1667 (@code{bluez} only) The corresponding HCI passes commands / events
1668 to / from the physical HCI identified by the name @var{id} (default:
1669 @code{hci0}) on the computer running QEMU. Only available on @code{bluez}
1670 capable systems like Linux.
1672 @item -bt hci[,vlan=@var{n}]
1673 Add a virtual, standard HCI that will participate in the Bluetooth
1674 scatternet @var{n} (default @code{0}). Similarly to @option{-net}
1675 VLANs, devices inside a bluetooth network @var{n} can only communicate
1676 with other devices in the same network (scatternet).
1679 @item -bt vhci[,vlan=@var{n}]
1680 (Linux-host only) Create a HCI in scatternet @var{n} (default 0) attached
1681 to the host bluetooth stack instead of to the emulated target. This
1682 allows the host and target machines to participate in a common scatternet
1683 and communicate. Requires the Linux @code{vhci} driver installed. Can
1684 be used as following:
1687 qemu [...OPTIONS...] -bt hci,vlan=5 -bt vhci,vlan=5
1690 @item -bt device:@var{dev}[,vlan=@var{n}]
1691 Emulate a bluetooth device @var{dev} and place it in network @var{n}
1692 (default @code{0}). QEMU can only emulate one type of bluetooth devices
1697 Virtual wireless keyboard implementing the HIDP bluetooth profile.
1704 DEFHEADING(Linux/Multiboot boot specific:)
1707 When using these options, you can use a given Linux or Multiboot
1708 kernel without installing it in the disk image. It can be useful
1709 for easier testing of various kernels.
1714 DEF("kernel", HAS_ARG, QEMU_OPTION_kernel, \
1715 "-kernel bzImage use 'bzImage' as kernel image\n", QEMU_ARCH_ALL)
1717 @item -kernel @var{bzImage}
1719 Use @var{bzImage} as kernel image. The kernel can be either a Linux kernel
1720 or in multiboot format.
1723 DEF("append", HAS_ARG, QEMU_OPTION_append, \
1724 "-append cmdline use 'cmdline' as kernel command line\n", QEMU_ARCH_ALL)
1726 @item -append @var{cmdline}
1728 Use @var{cmdline} as kernel command line
1731 DEF("initrd", HAS_ARG, QEMU_OPTION_initrd, \
1732 "-initrd file use 'file' as initial ram disk\n", QEMU_ARCH_ALL)
1734 @item -initrd @var{file}
1736 Use @var{file} as initial ram disk.
1738 @item -initrd "@var{file1} arg=foo,@var{file2}"
1740 This syntax is only available with multiboot.
1742 Use @var{file1} and @var{file2} as modules and pass arg=foo as parameter to the
1752 DEFHEADING(Debug/Expert options:)
1758 DEF("serial", HAS_ARG, QEMU_OPTION_serial, \
1759 "-serial dev redirect the serial port to char device 'dev'\n",
1762 @item -serial @var{dev}
1764 Redirect the virtual serial port to host character device
1765 @var{dev}. The default device is @code{vc} in graphical mode and
1766 @code{stdio} in non graphical mode.
1768 This option can be used several times to simulate up to 4 serial
1771 Use @code{-serial none} to disable all serial ports.
1773 Available character devices are:
1775 @item vc[:@var{W}x@var{H}]
1776 Virtual console. Optionally, a width and height can be given in pixel with
1780 It is also possible to specify width or height in characters:
1785 [Linux only] Pseudo TTY (a new PTY is automatically allocated)
1787 No device is allocated.
1791 [Linux only] Use host tty, e.g. @file{/dev/ttyS0}. The host serial port
1792 parameters are set according to the emulated ones.
1793 @item /dev/parport@var{N}
1794 [Linux only, parallel port only] Use host parallel port
1795 @var{N}. Currently SPP and EPP parallel port features can be used.
1796 @item file:@var{filename}
1797 Write output to @var{filename}. No character can be read.
1799 [Unix only] standard input/output
1800 @item pipe:@var{filename}
1801 name pipe @var{filename}
1803 [Windows only] Use host serial port @var{n}
1804 @item udp:[@var{remote_host}]:@var{remote_port}[@@[@var{src_ip}]:@var{src_port}]
1805 This implements UDP Net Console.
1806 When @var{remote_host} or @var{src_ip} are not specified
1807 they default to @code{0.0.0.0}.
1808 When not using a specified @var{src_port} a random port is automatically chosen.
1810 If you just want a simple readonly console you can use @code{netcat} or
1811 @code{nc}, by starting qemu with: @code{-serial udp::4555} and nc as:
1812 @code{nc -u -l -p 4555}. Any time qemu writes something to that port it
1813 will appear in the netconsole session.
1815 If you plan to send characters back via netconsole or you want to stop
1816 and start qemu a lot of times, you should have qemu use the same
1817 source port each time by using something like @code{-serial
1818 udp::4555@@:4556} to qemu. Another approach is to use a patched
1819 version of netcat which can listen to a TCP port and send and receive
1820 characters via udp. If you have a patched version of netcat which
1821 activates telnet remote echo and single char transfer, then you can
1822 use the following options to step up a netcat redirector to allow
1823 telnet on port 5555 to access the qemu port.
1826 -serial udp::4555@@:4556
1827 @item netcat options:
1828 -u -P 4555 -L 0.0.0.0:4556 -t -p 5555 -I -T
1829 @item telnet options:
1833 @item tcp:[@var{host}]:@var{port}[,@var{server}][,nowait][,nodelay]
1834 The TCP Net Console has two modes of operation. It can send the serial
1835 I/O to a location or wait for a connection from a location. By default
1836 the TCP Net Console is sent to @var{host} at the @var{port}. If you use
1837 the @var{server} option QEMU will wait for a client socket application
1838 to connect to the port before continuing, unless the @code{nowait}
1839 option was specified. The @code{nodelay} option disables the Nagle buffering
1840 algorithm. If @var{host} is omitted, 0.0.0.0 is assumed. Only
1841 one TCP connection at a time is accepted. You can use @code{telnet} to
1842 connect to the corresponding character device.
1844 @item Example to send tcp console to 192.168.0.2 port 4444
1845 -serial tcp:192.168.0.2:4444
1846 @item Example to listen and wait on port 4444 for connection
1847 -serial tcp::4444,server
1848 @item Example to not wait and listen on ip 192.168.0.100 port 4444
1849 -serial tcp:192.168.0.100:4444,server,nowait
1852 @item telnet:@var{host}:@var{port}[,server][,nowait][,nodelay]
1853 The telnet protocol is used instead of raw tcp sockets. The options
1854 work the same as if you had specified @code{-serial tcp}. The
1855 difference is that the port acts like a telnet server or client using
1856 telnet option negotiation. This will also allow you to send the
1857 MAGIC_SYSRQ sequence if you use a telnet that supports sending the break
1858 sequence. Typically in unix telnet you do it with Control-] and then
1859 type "send break" followed by pressing the enter key.
1861 @item unix:@var{path}[,server][,nowait]
1862 A unix domain socket is used instead of a tcp socket. The option works the
1863 same as if you had specified @code{-serial tcp} except the unix domain socket
1864 @var{path} is used for connections.
1866 @item mon:@var{dev_string}
1867 This is a special option to allow the monitor to be multiplexed onto
1868 another serial port. The monitor is accessed with key sequence of
1869 @key{Control-a} and then pressing @key{c}. See monitor access
1870 @ref{pcsys_keys} in the -nographic section for more keys.
1871 @var{dev_string} should be any one of the serial devices specified
1872 above. An example to multiplex the monitor onto a telnet server
1873 listening on port 4444 would be:
1875 @item -serial mon:telnet::4444,server,nowait
1879 Braille device. This will use BrlAPI to display the braille output on a real
1883 Three button serial mouse. Configure the guest to use Microsoft protocol.
1887 DEF("parallel", HAS_ARG, QEMU_OPTION_parallel, \
1888 "-parallel dev redirect the parallel port to char device 'dev'\n",
1891 @item -parallel @var{dev}
1893 Redirect the virtual parallel port to host device @var{dev} (same
1894 devices as the serial port). On Linux hosts, @file{/dev/parportN} can
1895 be used to use hardware devices connected on the corresponding host
1898 This option can be used several times to simulate up to 3 parallel
1901 Use @code{-parallel none} to disable all parallel ports.
1904 DEF("monitor", HAS_ARG, QEMU_OPTION_monitor, \
1905 "-monitor dev redirect the monitor to char device 'dev'\n",
1908 @item -monitor @var{dev}
1910 Redirect the monitor to host device @var{dev} (same devices as the
1912 The default device is @code{vc} in graphical mode and @code{stdio} in
1915 DEF("qmp", HAS_ARG, QEMU_OPTION_qmp, \
1916 "-qmp dev like -monitor but opens in 'control' mode\n",
1919 @item -qmp @var{dev}
1921 Like -monitor but opens in 'control' mode.
1924 DEF("mon", HAS_ARG, QEMU_OPTION_mon, \
1925 "-mon chardev=[name][,mode=readline|control][,default]\n", QEMU_ARCH_ALL)
1927 @item -mon chardev=[name][,mode=readline|control][,default]
1929 Setup monitor on chardev @var{name}.
1932 DEF("debugcon", HAS_ARG, QEMU_OPTION_debugcon, \
1933 "-debugcon dev redirect the debug console to char device 'dev'\n",
1936 @item -debugcon @var{dev}
1938 Redirect the debug console to host device @var{dev} (same devices as the
1939 serial port). The debug console is an I/O port which is typically port
1940 0xe9; writing to that I/O port sends output to this device.
1941 The default device is @code{vc} in graphical mode and @code{stdio} in
1945 DEF("pidfile", HAS_ARG, QEMU_OPTION_pidfile, \
1946 "-pidfile file write PID to 'file'\n", QEMU_ARCH_ALL)
1948 @item -pidfile @var{file}
1950 Store the QEMU process PID in @var{file}. It is useful if you launch QEMU
1954 DEF("singlestep", 0, QEMU_OPTION_singlestep, \
1955 "-singlestep always run in singlestep mode\n", QEMU_ARCH_ALL)
1959 Run the emulation in single step mode.
1962 DEF("S", 0, QEMU_OPTION_S, \
1963 "-S freeze CPU at startup (use 'c' to start execution)\n",
1968 Do not start CPU at startup (you must type 'c' in the monitor).
1971 DEF("gdb", HAS_ARG, QEMU_OPTION_gdb, \
1972 "-gdb dev wait for gdb connection on 'dev'\n", QEMU_ARCH_ALL)
1974 @item -gdb @var{dev}
1976 Wait for gdb connection on device @var{dev} (@pxref{gdb_usage}). Typical
1977 connections will likely be TCP-based, but also UDP, pseudo TTY, or even
1978 stdio are reasonable use case. The latter is allowing to start qemu from
1979 within gdb and establish the connection via a pipe:
1981 (gdb) target remote | exec qemu -gdb stdio ...
1985 DEF("s", 0, QEMU_OPTION_s, \
1986 "-s shorthand for -gdb tcp::" DEFAULT_GDBSTUB_PORT "\n",
1991 Shorthand for -gdb tcp::1234, i.e. open a gdbserver on TCP port 1234
1992 (@pxref{gdb_usage}).
1995 DEF("d", HAS_ARG, QEMU_OPTION_d, \
1996 "-d item1,... output log to /tmp/qemu.log (use -d ? for a list of log items)\n",
2001 Output log in /tmp/qemu.log
2004 DEF("hdachs", HAS_ARG, QEMU_OPTION_hdachs, \
2005 "-hdachs c,h,s[,t]\n" \
2006 " force hard disk 0 physical geometry and the optional BIOS\n" \
2007 " translation (t=none or lba) (usually qemu can guess them)\n",
2010 @item -hdachs @var{c},@var{h},@var{s},[,@var{t}]
2012 Force hard disk 0 physical geometry (1 <= @var{c} <= 16383, 1 <=
2013 @var{h} <= 16, 1 <= @var{s} <= 63) and optionally force the BIOS
2014 translation mode (@var{t}=none, lba or auto). Usually QEMU can guess
2015 all those parameters. This option is useful for old MS-DOS disk
2019 DEF("L", HAS_ARG, QEMU_OPTION_L, \
2020 "-L path set the directory for the BIOS, VGA BIOS and keymaps\n",
2025 Set the directory for the BIOS, VGA BIOS and keymaps.
2028 DEF("bios", HAS_ARG, QEMU_OPTION_bios, \
2029 "-bios file set the filename for the BIOS\n", QEMU_ARCH_ALL)
2031 @item -bios @var{file}
2033 Set the filename for the BIOS.
2036 DEF("enable-kvm", 0, QEMU_OPTION_enable_kvm, \
2037 "-enable-kvm enable KVM full virtualization support\n", QEMU_ARCH_ALL)
2041 Enable KVM full virtualization support. This option is only available
2042 if KVM support is enabled when compiling.
2045 DEF("xen-domid", HAS_ARG, QEMU_OPTION_xen_domid,
2046 "-xen-domid id specify xen guest domain id\n", QEMU_ARCH_ALL)
2047 DEF("xen-create", 0, QEMU_OPTION_xen_create,
2048 "-xen-create create domain using xen hypercalls, bypassing xend\n"
2049 " warning: should not be used when xend is in use\n",
2051 DEF("xen-attach", 0, QEMU_OPTION_xen_attach,
2052 "-xen-attach attach to existing xen domain\n"
2053 " xend will use this when starting qemu\n",
2056 @item -xen-domid @var{id}
2058 Specify xen guest domain @var{id} (XEN only).
2061 Create domain using xen hypercalls, bypassing xend.
2062 Warning: should not be used when xend is in use (XEN only).
2065 Attach to existing xen domain.
2066 xend will use this when starting qemu (XEN only).
2069 DEF("no-reboot", 0, QEMU_OPTION_no_reboot, \
2070 "-no-reboot exit instead of rebooting\n", QEMU_ARCH_ALL)
2074 Exit instead of rebooting.
2077 DEF("no-shutdown", 0, QEMU_OPTION_no_shutdown, \
2078 "-no-shutdown stop before shutdown\n", QEMU_ARCH_ALL)
2081 @findex -no-shutdown
2082 Don't exit QEMU on guest shutdown, but instead only stop the emulation.
2083 This allows for instance switching to monitor to commit changes to the
2087 DEF("loadvm", HAS_ARG, QEMU_OPTION_loadvm, \
2088 "-loadvm [tag|id]\n" \
2089 " start right away with a saved state (loadvm in monitor)\n",
2092 @item -loadvm @var{file}
2094 Start right away with a saved state (@code{loadvm} in monitor)
2098 DEF("daemonize", 0, QEMU_OPTION_daemonize, \
2099 "-daemonize daemonize QEMU after initializing\n", QEMU_ARCH_ALL)
2104 Daemonize the QEMU process after initialization. QEMU will not detach from
2105 standard IO until it is ready to receive connections on any of its devices.
2106 This option is a useful way for external programs to launch QEMU without having
2107 to cope with initialization race conditions.
2110 DEF("option-rom", HAS_ARG, QEMU_OPTION_option_rom, \
2111 "-option-rom rom load a file, rom, into the option ROM space\n",
2114 @item -option-rom @var{file}
2116 Load the contents of @var{file} as an option ROM.
2117 This option is useful to load things like EtherBoot.
2120 DEF("clock", HAS_ARG, QEMU_OPTION_clock, \
2121 "-clock force the use of the given methods for timer alarm.\n" \
2122 " To see what timers are available use -clock ?\n",
2125 @item -clock @var{method}
2127 Force the use of the given methods for timer alarm. To see what timers
2128 are available use -clock ?.
2131 HXCOMM Options deprecated by -rtc
2132 DEF("localtime", 0, QEMU_OPTION_localtime, "", QEMU_ARCH_ALL)
2133 DEF("startdate", HAS_ARG, QEMU_OPTION_startdate, "", QEMU_ARCH_ALL)
2135 DEF("rtc", HAS_ARG, QEMU_OPTION_rtc, \
2136 "-rtc [base=utc|localtime|date][,clock=host|vm][,driftfix=none|slew]\n" \
2137 " set the RTC base and clock, enable drift fix for clock ticks (x86 only)\n",
2142 @item -rtc [base=utc|localtime|@var{date}][,clock=host|vm][,driftfix=none|slew]
2144 Specify @option{base} as @code{utc} or @code{localtime} to let the RTC start at the current
2145 UTC or local time, respectively. @code{localtime} is required for correct date in
2146 MS-DOS or Windows. To start at a specific point in time, provide @var{date} in the
2147 format @code{2006-06-17T16:01:21} or @code{2006-06-17}. The default base is UTC.
2149 By default the RTC is driven by the host system time. This allows to use the
2150 RTC as accurate reference clock inside the guest, specifically if the host
2151 time is smoothly following an accurate external reference clock, e.g. via NTP.
2152 If you want to isolate the guest time from the host, even prevent it from
2153 progressing during suspension, you can set @option{clock} to @code{vm} instead.
2155 Enable @option{driftfix} (i386 targets only) if you experience time drift problems,
2156 specifically with Windows' ACPI HAL. This option will try to figure out how
2157 many timer interrupts were not processed by the Windows guest and will
2161 DEF("icount", HAS_ARG, QEMU_OPTION_icount, \
2162 "-icount [N|auto]\n" \
2163 " enable virtual instruction counter with 2^N clock ticks per\n" \
2164 " instruction\n", QEMU_ARCH_ALL)
2166 @item -icount [@var{N}|auto]
2168 Enable virtual instruction counter. The virtual cpu will execute one
2169 instruction every 2^@var{N} ns of virtual time. If @code{auto} is specified
2170 then the virtual cpu speed will be automatically adjusted to keep virtual
2171 time within a few seconds of real time.
2173 Note that while this option can give deterministic behavior, it does not
2174 provide cycle accurate emulation. Modern CPUs contain superscalar out of
2175 order cores with complex cache hierarchies. The number of instructions
2176 executed often has little or no correlation with actual performance.
2179 DEF("watchdog", HAS_ARG, QEMU_OPTION_watchdog, \
2180 "-watchdog i6300esb|ib700\n" \
2181 " enable virtual hardware watchdog [default=none]\n",
2184 @item -watchdog @var{model}
2186 Create a virtual hardware watchdog device. Once enabled (by a guest
2187 action), the watchdog must be periodically polled by an agent inside
2188 the guest or else the guest will be restarted.
2190 The @var{model} is the model of hardware watchdog to emulate. Choices
2191 for model are: @code{ib700} (iBASE 700) which is a very simple ISA
2192 watchdog with a single timer, or @code{i6300esb} (Intel 6300ESB I/O
2193 controller hub) which is a much more featureful PCI-based dual-timer
2194 watchdog. Choose a model for which your guest has drivers.
2196 Use @code{-watchdog ?} to list available hardware models. Only one
2197 watchdog can be enabled for a guest.
2200 DEF("watchdog-action", HAS_ARG, QEMU_OPTION_watchdog_action, \
2201 "-watchdog-action reset|shutdown|poweroff|pause|debug|none\n" \
2202 " action when watchdog fires [default=reset]\n",
2205 @item -watchdog-action @var{action}
2207 The @var{action} controls what QEMU will do when the watchdog timer
2210 @code{reset} (forcefully reset the guest).
2211 Other possible actions are:
2212 @code{shutdown} (attempt to gracefully shutdown the guest),
2213 @code{poweroff} (forcefully poweroff the guest),
2214 @code{pause} (pause the guest),
2215 @code{debug} (print a debug message and continue), or
2216 @code{none} (do nothing).
2218 Note that the @code{shutdown} action requires that the guest responds
2219 to ACPI signals, which it may not be able to do in the sort of
2220 situations where the watchdog would have expired, and thus
2221 @code{-watchdog-action shutdown} is not recommended for production use.
2226 @item -watchdog i6300esb -watchdog-action pause
2227 @item -watchdog ib700
2231 DEF("echr", HAS_ARG, QEMU_OPTION_echr, \
2232 "-echr chr set terminal escape character instead of ctrl-a\n",
2236 @item -echr @var{numeric_ascii_value}
2238 Change the escape character used for switching to the monitor when using
2239 monitor and serial sharing. The default is @code{0x01} when using the
2240 @code{-nographic} option. @code{0x01} is equal to pressing
2241 @code{Control-a}. You can select a different character from the ascii
2242 control keys where 1 through 26 map to Control-a through Control-z. For
2243 instance you could use the either of the following to change the escape
2244 character to Control-t.
2251 DEF("virtioconsole", HAS_ARG, QEMU_OPTION_virtiocon, \
2252 "-virtioconsole c\n" \
2253 " set virtio console\n", QEMU_ARCH_ALL)
2255 @item -virtioconsole @var{c}
2256 @findex -virtioconsole
2259 This option is maintained for backward compatibility.
2261 Please use @code{-device virtconsole} for the new way of invocation.
2264 DEF("show-cursor", 0, QEMU_OPTION_show_cursor, \
2265 "-show-cursor show cursor\n", QEMU_ARCH_ALL)
2268 @findex -show-cursor
2272 DEF("tb-size", HAS_ARG, QEMU_OPTION_tb_size, \
2273 "-tb-size n set TB size\n", QEMU_ARCH_ALL)
2275 @item -tb-size @var{n}
2280 DEF("incoming", HAS_ARG, QEMU_OPTION_incoming, \
2281 "-incoming p prepare for incoming migration, listen on port p\n",
2284 @item -incoming @var{port}
2286 Prepare for incoming migration, listen on @var{port}.
2289 DEF("nodefaults", 0, QEMU_OPTION_nodefaults, \
2290 "-nodefaults don't create default devices\n", QEMU_ARCH_ALL)
2294 Don't create default devices.
2298 DEF("chroot", HAS_ARG, QEMU_OPTION_chroot, \
2299 "-chroot dir chroot to dir just before starting the VM\n",
2303 @item -chroot @var{dir}
2305 Immediately before starting guest execution, chroot to the specified
2306 directory. Especially useful in combination with -runas.
2310 DEF("runas", HAS_ARG, QEMU_OPTION_runas, \
2311 "-runas user change to user id user just before starting the VM\n",
2315 @item -runas @var{user}
2317 Immediately before starting guest execution, drop root privileges, switching
2318 to the specified user.
2321 DEF("prom-env", HAS_ARG, QEMU_OPTION_prom_env,
2322 "-prom-env variable=value\n"
2323 " set OpenBIOS nvram variables\n",
2324 QEMU_ARCH_PPC | QEMU_ARCH_SPARC)
2326 @item -prom-env @var{variable}=@var{value}
2328 Set OpenBIOS nvram @var{variable} to given @var{value} (PPC, SPARC only).
2330 DEF("semihosting", 0, QEMU_OPTION_semihosting,
2331 "-semihosting semihosting mode\n", QEMU_ARCH_ARM | QEMU_ARCH_M68K)
2334 @findex -semihosting
2335 Semihosting mode (ARM, M68K only).
2337 DEF("old-param", 0, QEMU_OPTION_old_param,
2338 "-old-param old param mode\n", QEMU_ARCH_ARM)
2341 @findex -old-param (ARM)
2342 Old param mode (ARM only).
2345 DEF("readconfig", HAS_ARG, QEMU_OPTION_readconfig,
2346 "-readconfig <file>\n", QEMU_ARCH_ALL)
2348 @item -readconfig @var{file}
2350 Read device configuration from @var{file}.
2352 DEF("writeconfig", HAS_ARG, QEMU_OPTION_writeconfig,
2353 "-writeconfig <file>\n"
2354 " read/write config file\n", QEMU_ARCH_ALL)
2356 @item -writeconfig @var{file}
2357 @findex -writeconfig
2358 Write device configuration to @var{file}.
2360 DEF("nodefconfig", 0, QEMU_OPTION_nodefconfig,
2362 " do not load default config files at startup\n",
2366 @findex -nodefconfig
2367 Normally QEMU loads a configuration file from @var{sysconfdir}/qemu.conf and
2368 @var{sysconfdir}/target-@var{ARCH}.conf on startup. The @code{-nodefconfig}
2369 option will prevent QEMU from loading these configuration files at startup.
2371 #ifdef CONFIG_SIMPLE_TRACE
2372 DEF("trace", HAS_ARG, QEMU_OPTION_trace,
2374 " Specify a trace file to log traces to\n",
2379 Specify a trace file to log output traces to.
2383 HXCOMM This is the last statement. Insert new options before this line!