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"
35 " kernel_irqchip=on|off controls accelerated irqchip support\n"
36 " kvm_shadow_mem=size of KVM shadow MMU\n",
39 @item -machine [type=]@var{name}[,prop=@var{value}[,...]]
41 Select the emulated machine by @var{name}. Use @code{-machine ?} to list
42 available machines. Supported machine properties are:
44 @item accel=@var{accels1}[:@var{accels2}[:...]]
45 This is used to enable an accelerator. Depending on the target architecture,
46 kvm, xen, or tcg can be available. By default, tcg is used. If there is more
47 than one accelerator specified, the next one is used if the previous one fails
49 @item kernel_irqchip=on|off
50 Enables in-kernel irqchip support for the chosen accelerator when available.
51 @item kvm_shadow_mem=size
52 Defines the size of the KVM shadow MMU.
56 HXCOMM Deprecated by -machine
57 DEF("M", HAS_ARG, QEMU_OPTION_M, "", QEMU_ARCH_ALL)
59 DEF("cpu", HAS_ARG, QEMU_OPTION_cpu,
60 "-cpu cpu select CPU (-cpu ? for list)\n", QEMU_ARCH_ALL)
62 @item -cpu @var{model}
64 Select CPU model (-cpu ? for list and additional feature selection)
67 DEF("smp", HAS_ARG, QEMU_OPTION_smp,
68 "-smp n[,maxcpus=cpus][,cores=cores][,threads=threads][,sockets=sockets]\n"
69 " set the number of CPUs to 'n' [default=1]\n"
70 " maxcpus= maximum number of total cpus, including\n"
71 " offline CPUs for hotplug, etc\n"
72 " cores= number of CPU cores on one socket\n"
73 " threads= number of threads on one CPU core\n"
74 " sockets= number of discrete sockets in the system\n",
77 @item -smp @var{n}[,cores=@var{cores}][,threads=@var{threads}][,sockets=@var{sockets}][,maxcpus=@var{maxcpus}]
79 Simulate an SMP system with @var{n} CPUs. On the PC target, up to 255
80 CPUs are supported. On Sparc32 target, Linux limits the number of usable CPUs
82 For the PC target, the number of @var{cores} per socket, the number
83 of @var{threads} per cores and the total number of @var{sockets} can be
84 specified. Missing values will be computed. If any on the three values is
85 given, the total number of CPUs @var{n} can be omitted. @var{maxcpus}
86 specifies the maximum number of hotpluggable CPUs.
89 DEF("numa", HAS_ARG, QEMU_OPTION_numa,
90 "-numa node[,mem=size][,cpus=cpu[-cpu]][,nodeid=node]\n", QEMU_ARCH_ALL)
92 @item -numa @var{opts}
94 Simulate a multi node NUMA system. If mem and cpus are omitted, resources
98 DEF("fda", HAS_ARG, QEMU_OPTION_fda,
99 "-fda/-fdb file use 'file' as floppy disk 0/1 image\n", QEMU_ARCH_ALL)
100 DEF("fdb", HAS_ARG, QEMU_OPTION_fdb, "", QEMU_ARCH_ALL)
102 @item -fda @var{file}
103 @item -fdb @var{file}
106 Use @var{file} as floppy disk 0/1 image (@pxref{disk_images}). You can
107 use the host floppy by using @file{/dev/fd0} as filename (@pxref{host_drives}).
110 DEF("hda", HAS_ARG, QEMU_OPTION_hda,
111 "-hda/-hdb file use 'file' as IDE hard disk 0/1 image\n", QEMU_ARCH_ALL)
112 DEF("hdb", HAS_ARG, QEMU_OPTION_hdb, "", QEMU_ARCH_ALL)
113 DEF("hdc", HAS_ARG, QEMU_OPTION_hdc,
114 "-hdc/-hdd file use 'file' as IDE hard disk 2/3 image\n", QEMU_ARCH_ALL)
115 DEF("hdd", HAS_ARG, QEMU_OPTION_hdd, "", QEMU_ARCH_ALL)
117 @item -hda @var{file}
118 @item -hdb @var{file}
119 @item -hdc @var{file}
120 @item -hdd @var{file}
125 Use @var{file} as hard disk 0, 1, 2 or 3 image (@pxref{disk_images}).
128 DEF("cdrom", HAS_ARG, QEMU_OPTION_cdrom,
129 "-cdrom file use 'file' as IDE cdrom image (cdrom is ide1 master)\n",
132 @item -cdrom @var{file}
134 Use @var{file} as CD-ROM image (you cannot use @option{-hdc} and
135 @option{-cdrom} at the same time). You can use the host CD-ROM by
136 using @file{/dev/cdrom} as filename (@pxref{host_drives}).
139 DEF("drive", HAS_ARG, QEMU_OPTION_drive,
140 "-drive [file=file][,if=type][,bus=n][,unit=m][,media=d][,index=i]\n"
141 " [,cyls=c,heads=h,secs=s[,trans=t]][,snapshot=on|off]\n"
142 " [,cache=writethrough|writeback|none|directsync|unsafe][,format=f]\n"
143 " [,serial=s][,addr=A][,id=name][,aio=threads|native]\n"
144 " [,readonly=on|off][,copy-on-read=on|off]\n"
145 " [[,bps=b]|[[,bps_rd=r][,bps_wr=w]]][[,iops=i]|[[,iops_rd=r][,iops_wr=w]]\n"
146 " use 'file' as a drive image\n", QEMU_ARCH_ALL)
148 @item -drive @var{option}[,@var{option}[,@var{option}[,...]]]
151 Define a new drive. Valid options are:
154 @item file=@var{file}
155 This option defines which disk image (@pxref{disk_images}) to use with
156 this drive. If the filename contains comma, you must double it
157 (for instance, "file=my,,file" to use file "my,file").
159 Special files such as iSCSI devices can be specified using protocol
160 specific URLs. See the section for "Device URL Syntax" for more information.
161 @item if=@var{interface}
162 This option defines on which type on interface the drive is connected.
163 Available types are: ide, scsi, sd, mtd, floppy, pflash, virtio.
164 @item bus=@var{bus},unit=@var{unit}
165 These options define where is connected the drive by defining the bus number and
167 @item index=@var{index}
168 This option defines where is connected the drive by using an index in the list
169 of available connectors of a given interface type.
170 @item media=@var{media}
171 This option defines the type of the media: disk or cdrom.
172 @item cyls=@var{c},heads=@var{h},secs=@var{s}[,trans=@var{t}]
173 These options have the same definition as they have in @option{-hdachs}.
174 @item snapshot=@var{snapshot}
175 @var{snapshot} is "on" or "off" and allows to enable snapshot for given drive (see @option{-snapshot}).
176 @item cache=@var{cache}
177 @var{cache} is "none", "writeback", "unsafe", "directsync" or "writethrough" and controls how the host cache is used to access block data.
179 @var{aio} is "threads", or "native" and selects between pthread based disk I/O and native Linux AIO.
180 @item format=@var{format}
181 Specify which disk @var{format} will be used rather than detecting
182 the format. Can be used to specifiy format=raw to avoid interpreting
183 an untrusted format header.
184 @item serial=@var{serial}
185 This option specifies the serial number to assign to the device.
186 @item addr=@var{addr}
187 Specify the controller's PCI address (if=virtio only).
188 @item werror=@var{action},rerror=@var{action}
189 Specify which @var{action} to take on write and read errors. Valid actions are:
190 "ignore" (ignore the error and try to continue), "stop" (pause QEMU),
191 "report" (report the error to the guest), "enospc" (pause QEMU only if the
192 host disk is full; report the error to the guest otherwise).
193 The default setting is @option{werror=enospc} and @option{rerror=report}.
195 Open drive @option{file} as read-only. Guest write attempts will fail.
196 @item copy-on-read=@var{copy-on-read}
197 @var{copy-on-read} is "on" or "off" and enables whether to copy read backing
198 file sectors into the image file.
201 By default, writethrough caching is used for all block device. This means that
202 the host page cache will be used to read and write data but write notification
203 will be sent to the guest only when the data has been reported as written by
204 the storage subsystem.
206 Writeback caching will report data writes as completed as soon as the data is
207 present in the host page cache. This is safe as long as you trust your host.
208 If your host crashes or loses power, then the guest may experience data
211 The host page cache can be avoided entirely with @option{cache=none}. This will
212 attempt to do disk IO directly to the guests memory. QEMU may still perform
213 an internal copy of the data.
215 The host page cache can be avoided while only sending write notifications to
216 the guest when the data has been reported as written by the storage subsystem
217 using @option{cache=directsync}.
219 Some block drivers perform badly with @option{cache=writethrough}, most notably,
220 qcow2. If performance is more important than correctness,
221 @option{cache=writeback} should be used with qcow2.
223 In case you don't care about data integrity over host failures, use
224 cache=unsafe. This option tells qemu that it never needs to write any data
225 to the disk but can instead keeps things in cache. If anything goes wrong,
226 like your host losing power, the disk storage getting disconnected accidentally,
227 etc. you're image will most probably be rendered unusable. When using
228 the @option{-snapshot} option, unsafe caching is always used.
230 Copy-on-read avoids accessing the same backing file sectors repeatedly and is
231 useful when the backing file is over a slow network. By default copy-on-read
234 Instead of @option{-cdrom} you can use:
236 qemu -drive file=file,index=2,media=cdrom
239 Instead of @option{-hda}, @option{-hdb}, @option{-hdc}, @option{-hdd}, you can
242 qemu -drive file=file,index=0,media=disk
243 qemu -drive file=file,index=1,media=disk
244 qemu -drive file=file,index=2,media=disk
245 qemu -drive file=file,index=3,media=disk
248 You can connect a CDROM to the slave of ide0:
250 qemu -drive file=file,if=ide,index=1,media=cdrom
253 If you don't specify the "file=" argument, you define an empty drive:
255 qemu -drive if=ide,index=1,media=cdrom
258 You can connect a SCSI disk with unit ID 6 on the bus #0:
260 qemu -drive file=file,if=scsi,bus=0,unit=6
263 Instead of @option{-fda}, @option{-fdb}, you can use:
265 qemu -drive file=file,index=0,if=floppy
266 qemu -drive file=file,index=1,if=floppy
269 By default, @var{interface} is "ide" and @var{index} is automatically
272 qemu -drive file=a -drive file=b"
280 DEF("set", HAS_ARG, QEMU_OPTION_set,
281 "-set group.id.arg=value\n"
282 " set <arg> parameter for item <id> of type <group>\n"
283 " i.e. -set drive.$id.file=/path/to/image\n", QEMU_ARCH_ALL)
290 DEF("global", HAS_ARG, QEMU_OPTION_global,
291 "-global driver.property=value\n"
292 " set a global default for a driver property\n",
300 DEF("mtdblock", HAS_ARG, QEMU_OPTION_mtdblock,
301 "-mtdblock file use 'file' as on-board Flash memory image\n",
304 @item -mtdblock @var{file}
306 Use @var{file} as on-board Flash memory image.
309 DEF("sd", HAS_ARG, QEMU_OPTION_sd,
310 "-sd file use 'file' as SecureDigital card image\n", QEMU_ARCH_ALL)
314 Use @var{file} as SecureDigital card image.
317 DEF("pflash", HAS_ARG, QEMU_OPTION_pflash,
318 "-pflash file use 'file' as a parallel flash image\n", QEMU_ARCH_ALL)
320 @item -pflash @var{file}
322 Use @var{file} as a parallel flash image.
325 DEF("boot", HAS_ARG, QEMU_OPTION_boot,
326 "-boot [order=drives][,once=drives][,menu=on|off]\n"
327 " [,splash=sp_name][,splash-time=sp_time]\n"
328 " 'drives': floppy (a), hard disk (c), CD-ROM (d), network (n)\n"
329 " 'sp_name': the file's name that would be passed to bios as logo picture, if menu=on\n"
330 " 'sp_time': the period that splash picture last if menu=on, unit is ms\n",
333 @item -boot [order=@var{drives}][,once=@var{drives}][,menu=on|off][,splash=@var{sp_name}][,splash-time=@var{sp_time}]
335 Specify boot order @var{drives} as a string of drive letters. Valid
336 drive letters depend on the target achitecture. The x86 PC uses: a, b
337 (floppy 1 and 2), c (first hard disk), d (first CD-ROM), n-p (Etherboot
338 from network adapter 1-4), hard disk boot is the default. To apply a
339 particular boot order only on the first startup, specify it via
342 Interactive boot menus/prompts can be enabled via @option{menu=on} as far
343 as firmware/BIOS supports them. The default is non-interactive boot.
345 A splash picture could be passed to bios, enabling user to show it as logo,
346 when option splash=@var{sp_name} is given and menu=on, If firmware/BIOS
347 supports them. Currently Seabios for X86 system support it.
348 limitation: The splash file could be a jpeg file or a BMP file in 24 BPP
349 format(true color). The resolution should be supported by the SVGA mode, so
350 the recommended is 320x240, 640x480, 800x640.
353 # try to boot from network first, then from hard disk
355 # boot from CD-ROM first, switch back to default order after reboot
357 # boot with a splash picture for 5 seconds.
358 qemu -boot menu=on,splash=/root/boot.bmp,splash-time=5000
361 Note: The legacy format '-boot @var{drives}' is still supported but its
362 use is discouraged as it may be removed from future versions.
365 DEF("snapshot", 0, QEMU_OPTION_snapshot,
366 "-snapshot write to temporary files instead of disk image files\n",
371 Write to temporary files instead of disk image files. In this case,
372 the raw disk image you use is not written back. You can however force
373 the write back by pressing @key{C-a s} (@pxref{disk_images}).
376 DEF("m", HAS_ARG, QEMU_OPTION_m,
377 "-m megs set virtual RAM size to megs MB [default="
378 stringify(DEFAULT_RAM_SIZE) "]\n", QEMU_ARCH_ALL)
382 Set virtual RAM size to @var{megs} megabytes. Default is 128 MiB. Optionally,
383 a suffix of ``M'' or ``G'' can be used to signify a value in megabytes or
384 gigabytes respectively.
387 DEF("mem-path", HAS_ARG, QEMU_OPTION_mempath,
388 "-mem-path FILE provide backing storage for guest RAM\n", QEMU_ARCH_ALL)
390 @item -mem-path @var{path}
391 Allocate guest RAM from a temporarily created file in @var{path}.
395 DEF("mem-prealloc", 0, QEMU_OPTION_mem_prealloc,
396 "-mem-prealloc preallocate guest memory (use with -mem-path)\n",
400 Preallocate memory when using -mem-path.
404 DEF("k", HAS_ARG, QEMU_OPTION_k,
405 "-k language use keyboard layout (for example 'fr' for French)\n",
408 @item -k @var{language}
410 Use keyboard layout @var{language} (for example @code{fr} for
411 French). This option is only needed where it is not easy to get raw PC
412 keycodes (e.g. on Macs, with some X11 servers or with a VNC
413 display). You don't normally need to use it on PC/Linux or PC/Windows
416 The available layouts are:
418 ar de-ch es fo fr-ca hu ja mk no pt-br sv
419 da en-gb et fr fr-ch is lt nl pl ru th
420 de en-us fi fr-be hr it lv nl-be pt sl tr
423 The default is @code{en-us}.
427 DEF("audio-help", 0, QEMU_OPTION_audio_help,
428 "-audio-help print list of audio drivers and their options\n",
433 Will show the audio subsystem help: list of drivers, tunable
437 DEF("soundhw", HAS_ARG, QEMU_OPTION_soundhw,
438 "-soundhw c1,... enable audio support\n"
439 " and only specified sound cards (comma separated list)\n"
440 " use -soundhw ? to get the list of supported cards\n"
441 " use -soundhw all to enable all of them\n", QEMU_ARCH_ALL)
443 @item -soundhw @var{card1}[,@var{card2},...] or -soundhw all
445 Enable audio and selected sound hardware. Use ? to print all
446 available sound hardware.
449 qemu -soundhw sb16,adlib disk.img
450 qemu -soundhw es1370 disk.img
451 qemu -soundhw ac97 disk.img
452 qemu -soundhw hda disk.img
453 qemu -soundhw all disk.img
457 Note that Linux's i810_audio OSS kernel (for AC97) module might
458 require manually specifying clocking.
461 modprobe i810_audio clocking=48000
465 DEF("balloon", HAS_ARG, QEMU_OPTION_balloon,
466 "-balloon none disable balloon device\n"
467 "-balloon virtio[,addr=str]\n"
468 " enable virtio balloon device (default)\n", QEMU_ARCH_ALL)
472 Disable balloon device.
473 @item -balloon virtio[,addr=@var{addr}]
474 Enable virtio balloon device (default), optionally with PCI address
482 DEF("usb", 0, QEMU_OPTION_usb,
483 "-usb enable the USB driver (will be the default soon)\n",
491 Enable the USB driver (will be the default soon)
494 DEF("usbdevice", HAS_ARG, QEMU_OPTION_usbdevice,
495 "-usbdevice name add the host or guest USB device 'name'\n",
499 @item -usbdevice @var{devname}
501 Add the USB device @var{devname}. @xref{usb_devices}.
506 Virtual Mouse. This will override the PS/2 mouse emulation when activated.
509 Pointer device that uses absolute coordinates (like a touchscreen). This
510 means qemu is able to report the mouse position without having to grab the
511 mouse. Also overrides the PS/2 mouse emulation when activated.
513 @item disk:[format=@var{format}]:@var{file}
514 Mass storage device based on file. The optional @var{format} argument
515 will be used rather than detecting the format. Can be used to specifiy
516 @code{format=raw} to avoid interpreting an untrusted format header.
518 @item host:@var{bus}.@var{addr}
519 Pass through the host device identified by @var{bus}.@var{addr} (Linux only).
521 @item host:@var{vendor_id}:@var{product_id}
522 Pass through the host device identified by @var{vendor_id}:@var{product_id}
525 @item serial:[vendorid=@var{vendor_id}][,productid=@var{product_id}]:@var{dev}
526 Serial converter to host character device @var{dev}, see @code{-serial} for the
530 Braille device. This will use BrlAPI to display the braille output on a real
533 @item net:@var{options}
534 Network adapter that supports CDC ethernet and RNDIS protocols.
539 DEF("device", HAS_ARG, QEMU_OPTION_device,
540 "-device driver[,prop[=value][,...]]\n"
541 " add device (based on driver)\n"
542 " prop=value,... sets driver properties\n"
543 " use -device ? to print all possible drivers\n"
544 " use -device driver,? to print all possible properties\n",
547 @item -device @var{driver}[,@var{prop}[=@var{value}][,...]]
549 Add device @var{driver}. @var{prop}=@var{value} sets driver
550 properties. Valid properties depend on the driver. To get help on
551 possible drivers and properties, use @code{-device ?} and
552 @code{-device @var{driver},?}.
557 DEFHEADING(File system options:)
559 DEF("fsdev", HAS_ARG, QEMU_OPTION_fsdev,
560 "-fsdev fsdriver,id=id[,path=path,][security_model={mapped|passthrough|none}]\n"
561 " [,writeout=immediate][,readonly][,socket=socket|sock_fd=sock_fd]\n",
566 @item -fsdev @var{fsdriver},id=@var{id},path=@var{path},[security_model=@var{security_model}][,writeout=@var{writeout}][,readonly][,socket=@var{socket}|sock_fd=@var{sock_fd}]
568 Define a new file system device. Valid options are:
571 This option specifies the fs driver backend to use.
572 Currently "local", "handle" and "proxy" file system drivers are supported.
574 Specifies identifier for this device
575 @item path=@var{path}
576 Specifies the export path for the file system device. Files under
577 this path will be available to the 9p client on the guest.
578 @item security_model=@var{security_model}
579 Specifies the security model to be used for this export path.
580 Supported security models are "passthrough", "mapped" and "none".
581 In "passthrough" security model, files are stored using the same
582 credentials as they are created on the guest. This requires qemu
583 to run as root. In "mapped" security model, some of the file
584 attributes like uid, gid, mode bits and link target are stored as
585 file attributes. Directories exported by this security model cannot
586 interact with other unix tools. "none" security model is same as
587 passthrough except the sever won't report failures if it fails to
588 set file attributes like ownership. Security model is mandatory
589 only for local fsdriver. Other fsdrivers (like handle, proxy) don't take
590 security model as a parameter.
591 @item writeout=@var{writeout}
592 This is an optional argument. The only supported value is "immediate".
593 This means that host page cache will be used to read and write data but
594 write notification will be sent to the guest only when the data has been
595 reported as written by the storage subsystem.
597 Enables exporting 9p share as a readonly mount for guests. By default
598 read-write access is given.
599 @item socket=@var{socket}
600 Enables proxy filesystem driver to use passed socket file for communicating
601 with virtfs-proxy-helper
602 @item sock_fd=@var{sock_fd}
603 Enables proxy filesystem driver to use passed socket descriptor for
604 communicating with virtfs-proxy-helper. Usually a helper like libvirt
605 will create socketpair and pass one of the fds as sock_fd
608 -fsdev option is used along with -device driver "virtio-9p-pci".
609 @item -device virtio-9p-pci,fsdev=@var{id},mount_tag=@var{mount_tag}
610 Options for virtio-9p-pci driver are:
613 Specifies the id value specified along with -fsdev option
614 @item mount_tag=@var{mount_tag}
615 Specifies the tag name to be used by the guest to mount this export point
622 DEFHEADING(Virtual File system pass-through options:)
624 DEF("virtfs", HAS_ARG, QEMU_OPTION_virtfs,
625 "-virtfs local,path=path,mount_tag=tag,security_model=[mapped|passthrough|none]\n"
626 " [,writeout=immediate][,readonly][,socket=socket|sock_fd=sock_fd]\n",
631 @item -virtfs @var{fsdriver}[,path=@var{path}],mount_tag=@var{mount_tag}[,security_model=@var{security_model}][,writeout=@var{writeout}][,readonly][,socket=@var{socket}|sock_fd=@var{sock_fd}]
634 The general form of a Virtual File system pass-through options are:
637 This option specifies the fs driver backend to use.
638 Currently "local", "handle" and "proxy" file system drivers are supported.
640 Specifies identifier for this device
641 @item path=@var{path}
642 Specifies the export path for the file system device. Files under
643 this path will be available to the 9p client on the guest.
644 @item security_model=@var{security_model}
645 Specifies the security model to be used for this export path.
646 Supported security models are "passthrough", "mapped" and "none".
647 In "passthrough" security model, files are stored using the same
648 credentials as they are created on the guest. This requires qemu
649 to run as root. In "mapped" security model, some of the file
650 attributes like uid, gid, mode bits and link target are stored as
651 file attributes. Directories exported by this security model cannot
652 interact with other unix tools. "none" security model is same as
653 passthrough except the sever won't report failures if it fails to
654 set file attributes like ownership. Security model is mandatory only
655 for local fsdriver. Other fsdrivers (like handle, proxy) don't take security
656 model as a parameter.
657 @item writeout=@var{writeout}
658 This is an optional argument. The only supported value is "immediate".
659 This means that host page cache will be used to read and write data but
660 write notification will be sent to the guest only when the data has been
661 reported as written by the storage subsystem.
663 Enables exporting 9p share as a readonly mount for guests. By default
664 read-write access is given.
665 @item socket=@var{socket}
666 Enables proxy filesystem driver to use passed socket file for
667 communicating with virtfs-proxy-helper. Usually a helper like libvirt
668 will create socketpair and pass one of the fds as sock_fd
670 Enables proxy filesystem driver to use passed 'sock_fd' as the socket
671 descriptor for interfacing with virtfs-proxy-helper
675 DEF("virtfs_synth", 0, QEMU_OPTION_virtfs_synth,
676 "-virtfs_synth Create synthetic file system image\n",
680 @findex -virtfs_synth
681 Create synthetic file system image
686 DEF("name", HAS_ARG, QEMU_OPTION_name,
687 "-name string1[,process=string2]\n"
688 " set the name of the guest\n"
689 " string1 sets the window title and string2 the process name (on Linux)\n",
692 @item -name @var{name}
694 Sets the @var{name} of the guest.
695 This name will be displayed in the SDL window caption.
696 The @var{name} will also be used for the VNC server.
697 Also optionally set the top visible process name in Linux.
700 DEF("uuid", HAS_ARG, QEMU_OPTION_uuid,
701 "-uuid %08x-%04x-%04x-%04x-%012x\n"
702 " specify machine UUID\n", QEMU_ARCH_ALL)
704 @item -uuid @var{uuid}
715 DEFHEADING(Display options:)
721 DEF("display", HAS_ARG, QEMU_OPTION_display,
722 "-display sdl[,frame=on|off][,alt_grab=on|off][,ctrl_grab=on|off]\n"
723 " [,window_close=on|off]|curses|none|\n"
724 " vnc=<display>[,<optargs>]\n"
725 " select display type\n", QEMU_ARCH_ALL)
727 @item -display @var{type}
729 Select type of display to use. This option is a replacement for the
730 old style -sdl/-curses/... options. Valid values for @var{type} are
733 Display video output via SDL (usually in a separate graphics
734 window; see the SDL documentation for other possibilities).
736 Display video output via curses. For graphics device models which
737 support a text mode, QEMU can display this output using a
738 curses/ncurses interface. Nothing is displayed when the graphics
739 device is in graphical mode or if the graphics device does not support
740 a text mode. Generally only the VGA device models support text mode.
742 Do not display video output. The guest will still see an emulated
743 graphics card, but its output will not be displayed to the QEMU
744 user. This option differs from the -nographic option in that it
745 only affects what is done with video output; -nographic also changes
746 the destination of the serial and parallel port data.
748 Start a VNC server on display <arg>
752 DEF("nographic", 0, QEMU_OPTION_nographic,
753 "-nographic disable graphical output and redirect serial I/Os to console\n",
758 Normally, QEMU uses SDL to display the VGA output. With this option,
759 you can totally disable graphical output so that QEMU is a simple
760 command line application. The emulated serial port is redirected on
761 the console. Therefore, you can still use QEMU to debug a Linux kernel
762 with a serial console.
765 DEF("curses", 0, QEMU_OPTION_curses,
766 "-curses use a curses/ncurses interface instead of SDL\n",
771 Normally, QEMU uses SDL to display the VGA output. With this option,
772 QEMU can display the VGA output when in text mode using a
773 curses/ncurses interface. Nothing is displayed in graphical mode.
776 DEF("no-frame", 0, QEMU_OPTION_no_frame,
777 "-no-frame open SDL window without a frame and window decorations\n",
782 Do not use decorations for SDL windows and start them using the whole
783 available screen space. This makes the using QEMU in a dedicated desktop
784 workspace more convenient.
787 DEF("alt-grab", 0, QEMU_OPTION_alt_grab,
788 "-alt-grab use Ctrl-Alt-Shift to grab mouse (instead of Ctrl-Alt)\n",
793 Use Ctrl-Alt-Shift to grab mouse (instead of Ctrl-Alt). Note that this also
794 affects the special keys (for fullscreen, monitor-mode switching, etc).
797 DEF("ctrl-grab", 0, QEMU_OPTION_ctrl_grab,
798 "-ctrl-grab use Right-Ctrl to grab mouse (instead of Ctrl-Alt)\n",
803 Use Right-Ctrl to grab mouse (instead of Ctrl-Alt). Note that this also
804 affects the special keys (for fullscreen, monitor-mode switching, etc).
807 DEF("no-quit", 0, QEMU_OPTION_no_quit,
808 "-no-quit disable SDL window close capability\n", QEMU_ARCH_ALL)
812 Disable SDL window close capability.
815 DEF("sdl", 0, QEMU_OPTION_sdl,
816 "-sdl enable SDL\n", QEMU_ARCH_ALL)
823 DEF("spice", HAS_ARG, QEMU_OPTION_spice,
824 "-spice <args> enable spice\n", QEMU_ARCH_ALL)
826 @item -spice @var{option}[,@var{option}[,...]]
828 Enable the spice remote desktop protocol. Valid options are
833 Set the TCP port spice is listening on for plaintext channels.
836 Set the IP address spice is listening on. Default is any address.
840 Force using the specified IP version.
842 @item password=<secret>
843 Set the password you need to authenticate.
846 Require that the client use SASL to authenticate with the spice.
847 The exact choice of authentication method used is controlled from the
848 system / user's SASL configuration file for the 'qemu' service. This
849 is typically found in /etc/sasl2/qemu.conf. If running QEMU as an
850 unprivileged user, an environment variable SASL_CONF_PATH can be used
851 to make it search alternate locations for the service config.
852 While some SASL auth methods can also provide data encryption (eg GSSAPI),
853 it is recommended that SASL always be combined with the 'tls' and
854 'x509' settings to enable use of SSL and server certificates. This
855 ensures a data encryption preventing compromise of authentication
858 @item disable-ticketing
859 Allow client connects without authentication.
861 @item disable-copy-paste
862 Disable copy paste between the client and the guest.
865 Set the TCP port spice is listening on for encrypted channels.
868 Set the x509 file directory. Expects same filenames as -vnc $display,x509=$dir
870 @item x509-key-file=<file>
871 @item x509-key-password=<file>
872 @item x509-cert-file=<file>
873 @item x509-cacert-file=<file>
874 @item x509-dh-key-file=<file>
875 The x509 file names can also be configured individually.
877 @item tls-ciphers=<list>
878 Specify which ciphers to use.
880 @item tls-channel=[main|display|cursor|inputs|record|playback]
881 @item plaintext-channel=[main|display|cursor|inputs|record|playback]
882 Force specific channel to be used with or without TLS encryption. The
883 options can be specified multiple times to configure multiple
884 channels. The special name "default" can be used to set the default
885 mode. For channels which are not explicitly forced into one mode the
886 spice client is allowed to pick tls/plaintext as he pleases.
888 @item image-compression=[auto_glz|auto_lz|quic|glz|lz|off]
889 Configure image compression (lossless).
892 @item jpeg-wan-compression=[auto|never|always]
893 @item zlib-glz-wan-compression=[auto|never|always]
894 Configure wan image compression (lossy for slow links).
897 @item streaming-video=[off|all|filter]
898 Configure video stream detection. Default is filter.
900 @item agent-mouse=[on|off]
901 Enable/disable passing mouse events via vdagent. Default is on.
903 @item playback-compression=[on|off]
904 Enable/disable audio stream compression (using celt 0.5.1). Default is on.
909 DEF("portrait", 0, QEMU_OPTION_portrait,
910 "-portrait rotate graphical output 90 deg left (only PXA LCD)\n",
915 Rotate graphical output 90 deg left (only PXA LCD).
918 DEF("rotate", HAS_ARG, QEMU_OPTION_rotate,
919 "-rotate <deg> rotate graphical output some deg left (only PXA LCD)\n",
924 Rotate graphical output some deg left (only PXA LCD).
927 DEF("vga", HAS_ARG, QEMU_OPTION_vga,
928 "-vga [std|cirrus|vmware|qxl|xenfb|none]\n"
929 " select video card type\n", QEMU_ARCH_ALL)
931 @item -vga @var{type}
933 Select type of VGA card to emulate. Valid values for @var{type} are
936 Cirrus Logic GD5446 Video card. All Windows versions starting from
937 Windows 95 should recognize and use this graphic card. For optimal
938 performances, use 16 bit color depth in the guest and the host OS.
939 (This one is the default)
941 Standard VGA card with Bochs VBE extensions. If your guest OS
942 supports the VESA 2.0 VBE extensions (e.g. Windows XP) and if you want
943 to use high resolution modes (>= 1280x1024x16) then you should use
946 VMWare SVGA-II compatible adapter. Use it if you have sufficiently
947 recent XFree86/XOrg server or Windows guest with a driver for this
950 QXL paravirtual graphic card. It is VGA compatible (including VESA
951 2.0 VBE support). Works best with qxl guest drivers installed though.
952 Recommended choice when using the spice protocol.
958 DEF("full-screen", 0, QEMU_OPTION_full_screen,
959 "-full-screen start in full screen\n", QEMU_ARCH_ALL)
963 Start in full screen.
966 DEF("g", 1, QEMU_OPTION_g ,
967 "-g WxH[xDEPTH] Set the initial graphical resolution and depth\n",
968 QEMU_ARCH_PPC | QEMU_ARCH_SPARC)
970 @item -g @var{width}x@var{height}[x@var{depth}]
972 Set the initial graphical resolution and depth (PPC, SPARC only).
975 DEF("vnc", HAS_ARG, QEMU_OPTION_vnc ,
976 "-vnc display start a VNC server on display\n", QEMU_ARCH_ALL)
978 @item -vnc @var{display}[,@var{option}[,@var{option}[,...]]]
980 Normally, QEMU uses SDL to display the VGA output. With this option,
981 you can have QEMU listen on VNC display @var{display} and redirect the VGA
982 display over the VNC session. It is very useful to enable the usb
983 tablet device when using this option (option @option{-usbdevice
984 tablet}). When using the VNC display, you must use the @option{-k}
985 parameter to set the keyboard layout if you are not using en-us. Valid
986 syntax for the @var{display} is
990 @item @var{host}:@var{d}
992 TCP connections will only be allowed from @var{host} on display @var{d}.
993 By convention the TCP port is 5900+@var{d}. Optionally, @var{host} can
994 be omitted in which case the server will accept connections from any host.
996 @item unix:@var{path}
998 Connections will be allowed over UNIX domain sockets where @var{path} is the
999 location of a unix socket to listen for connections on.
1003 VNC is initialized but not started. The monitor @code{change} command
1004 can be used to later start the VNC server.
1008 Following the @var{display} value there may be one or more @var{option} flags
1009 separated by commas. Valid options are
1015 Connect to a listening VNC client via a ``reverse'' connection. The
1016 client is specified by the @var{display}. For reverse network
1017 connections (@var{host}:@var{d},@code{reverse}), the @var{d} argument
1018 is a TCP port number, not a display number.
1022 Require that password based authentication is used for client connections.
1023 The password must be set separately using the @code{change} command in the
1028 Require that client use TLS when communicating with the VNC server. This
1029 uses anonymous TLS credentials so is susceptible to a man-in-the-middle
1030 attack. It is recommended that this option be combined with either the
1031 @option{x509} or @option{x509verify} options.
1033 @item x509=@var{/path/to/certificate/dir}
1035 Valid if @option{tls} is specified. Require that x509 credentials are used
1036 for negotiating the TLS session. The server will send its x509 certificate
1037 to the client. It is recommended that a password be set on the VNC server
1038 to provide authentication of the client when this is used. The path following
1039 this option specifies where the x509 certificates are to be loaded from.
1040 See the @ref{vnc_security} section for details on generating certificates.
1042 @item x509verify=@var{/path/to/certificate/dir}
1044 Valid if @option{tls} is specified. Require that x509 credentials are used
1045 for negotiating the TLS session. The server will send its x509 certificate
1046 to the client, and request that the client send its own x509 certificate.
1047 The server will validate the client's certificate against the CA certificate,
1048 and reject clients when validation fails. If the certificate authority is
1049 trusted, this is a sufficient authentication mechanism. You may still wish
1050 to set a password on the VNC server as a second authentication layer. The
1051 path following this option specifies where the x509 certificates are to
1052 be loaded from. See the @ref{vnc_security} section for details on generating
1057 Require that the client use SASL to authenticate with the VNC server.
1058 The exact choice of authentication method used is controlled from the
1059 system / user's SASL configuration file for the 'qemu' service. This
1060 is typically found in /etc/sasl2/qemu.conf. If running QEMU as an
1061 unprivileged user, an environment variable SASL_CONF_PATH can be used
1062 to make it search alternate locations for the service config.
1063 While some SASL auth methods can also provide data encryption (eg GSSAPI),
1064 it is recommended that SASL always be combined with the 'tls' and
1065 'x509' settings to enable use of SSL and server certificates. This
1066 ensures a data encryption preventing compromise of authentication
1067 credentials. See the @ref{vnc_security} section for details on using
1068 SASL authentication.
1072 Turn on access control lists for checking of the x509 client certificate
1073 and SASL party. For x509 certs, the ACL check is made against the
1074 certificate's distinguished name. This is something that looks like
1075 @code{C=GB,O=ACME,L=Boston,CN=bob}. For SASL party, the ACL check is
1076 made against the username, which depending on the SASL plugin, may
1077 include a realm component, eg @code{bob} or @code{bob@@EXAMPLE.COM}.
1078 When the @option{acl} flag is set, the initial access list will be
1079 empty, with a @code{deny} policy. Thus no one will be allowed to
1080 use the VNC server until the ACLs have been loaded. This can be
1081 achieved using the @code{acl} monitor command.
1085 Enable lossy compression methods (gradient, JPEG, ...). If this
1086 option is set, VNC client may receive lossy framebuffer updates
1087 depending on its encoding settings. Enabling this option can save
1088 a lot of bandwidth at the expense of quality.
1092 Disable adaptive encodings. Adaptive encodings are enabled by default.
1093 An adaptive encoding will try to detect frequently updated screen regions,
1094 and send updates in these regions using a lossy encoding (like JPEG).
1095 This can be really helpful to save bandwidth when playing videos. Disabling
1096 adaptive encodings allows to restore the original static behavior of encodings
1106 ARCHHEADING(, QEMU_ARCH_I386)
1108 ARCHHEADING(i386 target only:, QEMU_ARCH_I386)
1113 DEF("win2k-hack", 0, QEMU_OPTION_win2k_hack,
1114 "-win2k-hack use it when installing Windows 2000 to avoid a disk full bug\n",
1119 Use it when installing Windows 2000 to avoid a disk full bug. After
1120 Windows 2000 is installed, you no longer need this option (this option
1121 slows down the IDE transfers).
1124 HXCOMM Deprecated by -rtc
1125 DEF("rtc-td-hack", 0, QEMU_OPTION_rtc_td_hack, "", QEMU_ARCH_I386)
1127 DEF("no-fd-bootchk", 0, QEMU_OPTION_no_fd_bootchk,
1128 "-no-fd-bootchk disable boot signature checking for floppy disks\n",
1131 @item -no-fd-bootchk
1132 @findex -no-fd-bootchk
1133 Disable boot signature checking for floppy disks in Bochs BIOS. It may
1134 be needed to boot from old floppy disks.
1135 TODO: check reference to Bochs BIOS.
1138 DEF("no-acpi", 0, QEMU_OPTION_no_acpi,
1139 "-no-acpi disable ACPI\n", QEMU_ARCH_I386)
1143 Disable ACPI (Advanced Configuration and Power Interface) support. Use
1144 it if your guest OS complains about ACPI problems (PC target machine
1148 DEF("no-hpet", 0, QEMU_OPTION_no_hpet,
1149 "-no-hpet disable HPET\n", QEMU_ARCH_I386)
1153 Disable HPET support.
1156 DEF("acpitable", HAS_ARG, QEMU_OPTION_acpitable,
1157 "-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"
1158 " ACPI table description\n", QEMU_ARCH_I386)
1160 @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}]...]
1162 Add ACPI table with specified header fields and context from specified files.
1163 For file=, take whole ACPI table from the specified files, including all
1164 ACPI headers (possible overridden by other options).
1165 For data=, only data
1166 portion of the table is used, all header information is specified in the
1170 DEF("smbios", HAS_ARG, QEMU_OPTION_smbios,
1171 "-smbios file=binary\n"
1172 " load SMBIOS entry from binary file\n"
1173 "-smbios type=0[,vendor=str][,version=str][,date=str][,release=%d.%d]\n"
1174 " specify SMBIOS type 0 fields\n"
1175 "-smbios type=1[,manufacturer=str][,product=str][,version=str][,serial=str]\n"
1176 " [,uuid=uuid][,sku=str][,family=str]\n"
1177 " specify SMBIOS type 1 fields\n", QEMU_ARCH_I386)
1179 @item -smbios file=@var{binary}
1181 Load SMBIOS entry from binary file.
1183 @item -smbios type=0[,vendor=@var{str}][,version=@var{str}][,date=@var{str}][,release=@var{%d.%d}]
1185 Specify SMBIOS type 0 fields
1187 @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}]
1188 Specify SMBIOS type 1 fields
1196 DEFHEADING(Network options:)
1201 HXCOMM Legacy slirp options (now moved to -net user):
1203 DEF("tftp", HAS_ARG, QEMU_OPTION_tftp, "", QEMU_ARCH_ALL)
1204 DEF("bootp", HAS_ARG, QEMU_OPTION_bootp, "", QEMU_ARCH_ALL)
1205 DEF("redir", HAS_ARG, QEMU_OPTION_redir, "", QEMU_ARCH_ALL)
1207 DEF("smb", HAS_ARG, QEMU_OPTION_smb, "", QEMU_ARCH_ALL)
1211 DEF("net", HAS_ARG, QEMU_OPTION_net,
1212 "-net nic[,vlan=n][,macaddr=mac][,model=type][,name=str][,addr=str][,vectors=v]\n"
1213 " create a new Network Interface Card and connect it to VLAN 'n'\n"
1215 "-net user[,vlan=n][,name=str][,net=addr[/mask]][,host=addr][,restrict=on|off]\n"
1216 " [,hostname=host][,dhcpstart=addr][,dns=addr][,tftp=dir][,bootfile=f]\n"
1217 " [,hostfwd=rule][,guestfwd=rule]"
1219 "[,smb=dir[,smbserver=addr]]\n"
1221 " connect the user mode network stack to VLAN 'n', configure its\n"
1222 " DHCP server and enabled optional services\n"
1225 "-net tap[,vlan=n][,name=str],ifname=name\n"
1226 " connect the host TAP network interface to VLAN 'n'\n"
1228 "-net tap[,vlan=n][,name=str][,fd=h][,ifname=name][,script=file][,downscript=dfile][,helper=helper][,sndbuf=nbytes][,vnet_hdr=on|off][,vhost=on|off][,vhostfd=h][,vhostforce=on|off]\n"
1229 " connect the host TAP network interface to VLAN 'n' \n"
1230 " use network scripts 'file' (default=" DEFAULT_NETWORK_SCRIPT ")\n"
1231 " to configure it and 'dfile' (default=" DEFAULT_NETWORK_DOWN_SCRIPT ")\n"
1232 " to deconfigure it\n"
1233 " use '[down]script=no' to disable script execution\n"
1234 " use network helper 'helper' (default=" DEFAULT_BRIDGE_HELPER ") to\n"
1236 " use 'fd=h' to connect to an already opened TAP interface\n"
1237 " use 'sndbuf=nbytes' to limit the size of the send buffer (the\n"
1238 " default is disabled 'sndbuf=0' to enable flow control set 'sndbuf=1048576')\n"
1239 " use vnet_hdr=off to avoid enabling the IFF_VNET_HDR tap flag\n"
1240 " use vnet_hdr=on to make the lack of IFF_VNET_HDR support an error condition\n"
1241 " use vhost=on to enable experimental in kernel accelerator\n"
1242 " (only has effect for virtio guests which use MSIX)\n"
1243 " use vhostforce=on to force vhost on for non-MSIX virtio guests\n"
1244 " use 'vhostfd=h' to connect to an already opened vhost net device\n"
1245 "-net bridge[,vlan=n][,name=str][,br=bridge][,helper=helper]\n"
1246 " connects a host TAP network interface to a host bridge device 'br'\n"
1247 " (default=" DEFAULT_BRIDGE_INTERFACE ") using the program 'helper'\n"
1248 " (default=" DEFAULT_BRIDGE_HELPER ")\n"
1250 "-net socket[,vlan=n][,name=str][,fd=h][,listen=[host]:port][,connect=host:port]\n"
1251 " connect the vlan 'n' to another VLAN using a socket connection\n"
1252 "-net socket[,vlan=n][,name=str][,fd=h][,mcast=maddr:port[,localaddr=addr]]\n"
1253 " connect the vlan 'n' to multicast maddr and port\n"
1254 " use 'localaddr=addr' to specify the host address to send packets from\n"
1255 "-net socket[,vlan=n][,name=str][,fd=h][,udp=host:port][,localaddr=host:port]\n"
1256 " connect the vlan 'n' to another VLAN using an UDP tunnel\n"
1258 "-net vde[,vlan=n][,name=str][,sock=socketpath][,port=n][,group=groupname][,mode=octalmode]\n"
1259 " connect the vlan 'n' to port 'n' of a vde switch running\n"
1260 " on host and listening for incoming connections on 'socketpath'.\n"
1261 " Use group 'groupname' and mode 'octalmode' to change default\n"
1262 " ownership and permissions for communication port.\n"
1264 "-net dump[,vlan=n][,file=f][,len=n]\n"
1265 " dump traffic on vlan 'n' to file 'f' (max n bytes per packet)\n"
1266 "-net none use it alone to have zero network devices. If no -net option\n"
1267 " is provided, the default is '-net nic -net user'\n", QEMU_ARCH_ALL)
1268 DEF("netdev", HAS_ARG, QEMU_OPTION_netdev,
1278 "socket],id=str[,option][,option][,...]\n", QEMU_ARCH_ALL)
1280 @item -net nic[,vlan=@var{n}][,macaddr=@var{mac}][,model=@var{type}] [,name=@var{name}][,addr=@var{addr}][,vectors=@var{v}]
1282 Create a new Network Interface Card and connect it to VLAN @var{n} (@var{n}
1283 = 0 is the default). The NIC is an e1000 by default on the PC
1284 target. Optionally, the MAC address can be changed to @var{mac}, the
1285 device address set to @var{addr} (PCI cards only),
1286 and a @var{name} can be assigned for use in monitor commands.
1287 Optionally, for PCI cards, you can specify the number @var{v} of MSI-X vectors
1288 that the card should have; this option currently only affects virtio cards; set
1289 @var{v} = 0 to disable MSI-X. If no @option{-net} option is specified, a single
1290 NIC is created. Qemu can emulate several different models of network card.
1291 Valid values for @var{type} are
1292 @code{virtio}, @code{i82551}, @code{i82557b}, @code{i82559er},
1293 @code{ne2k_pci}, @code{ne2k_isa}, @code{pcnet}, @code{rtl8139},
1294 @code{e1000}, @code{smc91c111}, @code{lance} and @code{mcf_fec}.
1295 Not all devices are supported on all targets. Use -net nic,model=?
1296 for a list of available devices for your target.
1298 @item -net user[,@var{option}][,@var{option}][,...]
1299 Use the user mode network stack which requires no administrator
1300 privilege to run. Valid options are:
1304 Connect user mode stack to VLAN @var{n} (@var{n} = 0 is the default).
1306 @item name=@var{name}
1307 Assign symbolic name for use in monitor commands.
1309 @item net=@var{addr}[/@var{mask}]
1310 Set IP network address the guest will see. Optionally specify the netmask,
1311 either in the form a.b.c.d or as number of valid top-most bits. Default is
1314 @item host=@var{addr}
1315 Specify the guest-visible address of the host. Default is the 2nd IP in the
1316 guest network, i.e. x.x.x.2.
1318 @item restrict=on|off
1319 If this option is enabled, the guest will be isolated, i.e. it will not be
1320 able to contact the host and no guest IP packets will be routed over the host
1321 to the outside. This option does not affect any explicitly set forwarding rules.
1323 @item hostname=@var{name}
1324 Specifies the client hostname reported by the builtin DHCP server.
1326 @item dhcpstart=@var{addr}
1327 Specify the first of the 16 IPs the built-in DHCP server can assign. Default
1328 is the 15th to 31st IP in the guest network, i.e. x.x.x.15 to x.x.x.31.
1330 @item dns=@var{addr}
1331 Specify the guest-visible address of the virtual nameserver. The address must
1332 be different from the host address. Default is the 3rd IP in the guest network,
1335 @item tftp=@var{dir}
1336 When using the user mode network stack, activate a built-in TFTP
1337 server. The files in @var{dir} will be exposed as the root of a TFTP server.
1338 The TFTP client on the guest must be configured in binary mode (use the command
1339 @code{bin} of the Unix TFTP client).
1341 @item bootfile=@var{file}
1342 When using the user mode network stack, broadcast @var{file} as the BOOTP
1343 filename. In conjunction with @option{tftp}, this can be used to network boot
1344 a guest from a local directory.
1346 Example (using pxelinux):
1348 qemu -hda linux.img -boot n -net user,tftp=/path/to/tftp/files,bootfile=/pxelinux.0
1351 @item smb=@var{dir}[,smbserver=@var{addr}]
1352 When using the user mode network stack, activate a built-in SMB
1353 server so that Windows OSes can access to the host files in @file{@var{dir}}
1354 transparently. The IP address of the SMB server can be set to @var{addr}. By
1355 default the 4th IP in the guest network is used, i.e. x.x.x.4.
1357 In the guest Windows OS, the line:
1361 must be added in the file @file{C:\WINDOWS\LMHOSTS} (for windows 9x/Me)
1362 or @file{C:\WINNT\SYSTEM32\DRIVERS\ETC\LMHOSTS} (Windows NT/2000).
1364 Then @file{@var{dir}} can be accessed in @file{\\smbserver\qemu}.
1366 Note that a SAMBA server must be installed on the host OS.
1367 QEMU was tested successfully with smbd versions from Red Hat 9,
1368 Fedora Core 3 and OpenSUSE 11.x.
1370 @item hostfwd=[tcp|udp]:[@var{hostaddr}]:@var{hostport}-[@var{guestaddr}]:@var{guestport}
1371 Redirect incoming TCP or UDP connections to the host port @var{hostport} to
1372 the guest IP address @var{guestaddr} on guest port @var{guestport}. If
1373 @var{guestaddr} is not specified, its value is x.x.x.15 (default first address
1374 given by the built-in DHCP server). By specifying @var{hostaddr}, the rule can
1375 be bound to a specific host interface. If no connection type is set, TCP is
1376 used. This option can be given multiple times.
1378 For example, to redirect host X11 connection from screen 1 to guest
1379 screen 0, use the following:
1383 qemu -net user,hostfwd=tcp:127.0.0.1:6001-:6000 [...]
1384 # this host xterm should open in the guest X11 server
1388 To redirect telnet connections from host port 5555 to telnet port on
1389 the guest, use the following:
1393 qemu -net user,hostfwd=tcp::5555-:23 [...]
1394 telnet localhost 5555
1397 Then when you use on the host @code{telnet localhost 5555}, you
1398 connect to the guest telnet server.
1400 @item guestfwd=[tcp]:@var{server}:@var{port}-@var{dev}
1401 Forward guest TCP connections to the IP address @var{server} on port @var{port}
1402 to the character device @var{dev}. This option can be given multiple times.
1406 Note: Legacy stand-alone options -tftp, -bootp, -smb and -redir are still
1407 processed and applied to -net user. Mixing them with the new configuration
1408 syntax gives undefined results. Their use for new applications is discouraged
1409 as they will be removed from future versions.
1411 @item -net tap[,vlan=@var{n}][,name=@var{name}][,fd=@var{h}][,ifname=@var{name}][,script=@var{file}][,downscript=@var{dfile}][,helper=@var{helper}]
1412 Connect the host TAP network interface @var{name} to VLAN @var{n}.
1414 Use the network script @var{file} to configure it and the network script
1415 @var{dfile} to deconfigure it. If @var{name} is not provided, the OS
1416 automatically provides one. The default network configure script is
1417 @file{/etc/qemu-ifup} and the default network deconfigure script is
1418 @file{/etc/qemu-ifdown}. Use @option{script=no} or @option{downscript=no}
1419 to disable script execution.
1421 If running QEMU as an unprivileged user, use the network helper
1422 @var{helper} to configure the TAP interface. The default network
1423 helper executable is @file{/usr/local/libexec/qemu-bridge-helper}.
1425 @option{fd}=@var{h} can be used to specify the handle of an already
1426 opened host TAP interface.
1431 #launch a QEMU instance with the default network script
1432 qemu linux.img -net nic -net tap
1436 #launch a QEMU instance with two NICs, each one connected
1438 qemu linux.img -net nic,vlan=0 -net tap,vlan=0,ifname=tap0 \
1439 -net nic,vlan=1 -net tap,vlan=1,ifname=tap1
1443 #launch a QEMU instance with the default network helper to
1444 #connect a TAP device to bridge br0
1445 qemu linux.img -net nic -net tap,"helper=/usr/local/libexec/qemu-bridge-helper"
1448 @item -net bridge[,vlan=@var{n}][,name=@var{name}][,br=@var{bridge}][,helper=@var{helper}]
1449 Connect a host TAP network interface to a host bridge device.
1451 Use the network helper @var{helper} to configure the TAP interface and
1452 attach it to the bridge. The default network helper executable is
1453 @file{/usr/local/libexec/qemu-bridge-helper} and the default bridge
1454 device is @file{br0}.
1459 #launch a QEMU instance with the default network helper to
1460 #connect a TAP device to bridge br0
1461 qemu linux.img -net bridge -net nic,model=virtio
1465 #launch a QEMU instance with the default network helper to
1466 #connect a TAP device to bridge qemubr0
1467 qemu linux.img -net bridge,br=qemubr0 -net nic,model=virtio
1470 @item -net socket[,vlan=@var{n}][,name=@var{name}][,fd=@var{h}] [,listen=[@var{host}]:@var{port}][,connect=@var{host}:@var{port}]
1472 Connect the VLAN @var{n} to a remote VLAN in another QEMU virtual
1473 machine using a TCP socket connection. If @option{listen} is
1474 specified, QEMU waits for incoming connections on @var{port}
1475 (@var{host} is optional). @option{connect} is used to connect to
1476 another QEMU instance using the @option{listen} option. @option{fd}=@var{h}
1477 specifies an already opened TCP socket.
1481 # launch a first QEMU instance
1482 qemu linux.img -net nic,macaddr=52:54:00:12:34:56 \
1483 -net socket,listen=:1234
1484 # connect the VLAN 0 of this instance to the VLAN 0
1485 # of the first instance
1486 qemu linux.img -net nic,macaddr=52:54:00:12:34:57 \
1487 -net socket,connect=127.0.0.1:1234
1490 @item -net socket[,vlan=@var{n}][,name=@var{name}][,fd=@var{h}][,mcast=@var{maddr}:@var{port}[,localaddr=@var{addr}]]
1492 Create a VLAN @var{n} shared with another QEMU virtual
1493 machines using a UDP multicast socket, effectively making a bus for
1494 every QEMU with same multicast address @var{maddr} and @var{port}.
1498 Several QEMU can be running on different hosts and share same bus (assuming
1499 correct multicast setup for these hosts).
1501 mcast support is compatible with User Mode Linux (argument @option{eth@var{N}=mcast}), see
1502 @url{http://user-mode-linux.sf.net}.
1504 Use @option{fd=h} to specify an already opened UDP multicast socket.
1509 # launch one QEMU instance
1510 qemu linux.img -net nic,macaddr=52:54:00:12:34:56 \
1511 -net socket,mcast=230.0.0.1:1234
1512 # launch another QEMU instance on same "bus"
1513 qemu linux.img -net nic,macaddr=52:54:00:12:34:57 \
1514 -net socket,mcast=230.0.0.1:1234
1515 # launch yet another QEMU instance on same "bus"
1516 qemu linux.img -net nic,macaddr=52:54:00:12:34:58 \
1517 -net socket,mcast=230.0.0.1:1234
1520 Example (User Mode Linux compat.):
1522 # launch QEMU instance (note mcast address selected
1524 qemu linux.img -net nic,macaddr=52:54:00:12:34:56 \
1525 -net socket,mcast=239.192.168.1:1102
1527 /path/to/linux ubd0=/path/to/root_fs eth0=mcast
1530 Example (send packets from host's 1.2.3.4):
1532 qemu linux.img -net nic,macaddr=52:54:00:12:34:56 \
1533 -net socket,mcast=239.192.168.1:1102,localaddr=1.2.3.4
1536 @item -net vde[,vlan=@var{n}][,name=@var{name}][,sock=@var{socketpath}] [,port=@var{n}][,group=@var{groupname}][,mode=@var{octalmode}]
1537 Connect VLAN @var{n} to PORT @var{n} of a vde switch running on host and
1538 listening for incoming connections on @var{socketpath}. Use GROUP @var{groupname}
1539 and MODE @var{octalmode} to change default ownership and permissions for
1540 communication port. This option is only available if QEMU has been compiled
1541 with vde support enabled.
1546 vde_switch -F -sock /tmp/myswitch
1547 # launch QEMU instance
1548 qemu linux.img -net nic -net vde,sock=/tmp/myswitch
1551 @item -net dump[,vlan=@var{n}][,file=@var{file}][,len=@var{len}]
1552 Dump network traffic on VLAN @var{n} to file @var{file} (@file{qemu-vlan0.pcap} by default).
1553 At most @var{len} bytes (64k by default) per packet are stored. The file format is
1554 libpcap, so it can be analyzed with tools such as tcpdump or Wireshark.
1557 Indicate that no network devices should be configured. It is used to
1558 override the default configuration (@option{-net nic -net user}) which
1559 is activated if no @option{-net} options are provided.
1566 DEFHEADING(Character device options:)
1568 DEF("chardev", HAS_ARG, QEMU_OPTION_chardev,
1569 "-chardev null,id=id[,mux=on|off]\n"
1570 "-chardev socket,id=id[,host=host],port=host[,to=to][,ipv4][,ipv6][,nodelay]\n"
1571 " [,server][,nowait][,telnet][,mux=on|off] (tcp)\n"
1572 "-chardev socket,id=id,path=path[,server][,nowait][,telnet],[mux=on|off] (unix)\n"
1573 "-chardev udp,id=id[,host=host],port=port[,localaddr=localaddr]\n"
1574 " [,localport=localport][,ipv4][,ipv6][,mux=on|off]\n"
1575 "-chardev msmouse,id=id[,mux=on|off]\n"
1576 "-chardev vc,id=id[[,width=width][,height=height]][[,cols=cols][,rows=rows]]\n"
1578 "-chardev file,id=id,path=path[,mux=on|off]\n"
1579 "-chardev pipe,id=id,path=path[,mux=on|off]\n"
1581 "-chardev console,id=id[,mux=on|off]\n"
1582 "-chardev serial,id=id,path=path[,mux=on|off]\n"
1584 "-chardev pty,id=id[,mux=on|off]\n"
1585 "-chardev stdio,id=id[,mux=on|off][,signal=on|off]\n"
1587 #ifdef CONFIG_BRLAPI
1588 "-chardev braille,id=id[,mux=on|off]\n"
1590 #if defined(__linux__) || defined(__sun__) || defined(__FreeBSD__) \
1591 || defined(__NetBSD__) || defined(__OpenBSD__) || defined(__DragonFly__)
1592 "-chardev tty,id=id,path=path[,mux=on|off]\n"
1594 #if defined(__linux__) || defined(__FreeBSD__) || defined(__DragonFly__)
1595 "-chardev parport,id=id,path=path[,mux=on|off]\n"
1597 #if defined(CONFIG_SPICE)
1598 "-chardev spicevmc,id=id,name=name[,debug=debug]\n"
1605 The general form of a character device option is:
1608 @item -chardev @var{backend} ,id=@var{id} [,mux=on|off] [,@var{options}]
1626 The specific backend will determine the applicable options.
1628 All devices must have an id, which can be any string up to 127 characters long.
1629 It is used to uniquely identify this device in other command line directives.
1631 A character device may be used in multiplexing mode by multiple front-ends.
1632 The key sequence of @key{Control-a} and @key{c} will rotate the input focus
1633 between attached front-ends. Specify @option{mux=on} to enable this mode.
1635 Options to each backend are described below.
1637 @item -chardev null ,id=@var{id}
1638 A void device. This device will not emit any data, and will drop any data it
1639 receives. The null backend does not take any options.
1641 @item -chardev socket ,id=@var{id} [@var{TCP options} or @var{unix options}] [,server] [,nowait] [,telnet]
1643 Create a two-way stream socket, which can be either a TCP or a unix socket. A
1644 unix socket will be created if @option{path} is specified. Behaviour is
1645 undefined if TCP options are specified for a unix socket.
1647 @option{server} specifies that the socket shall be a listening socket.
1649 @option{nowait} specifies that QEMU should not block waiting for a client to
1650 connect to a listening socket.
1652 @option{telnet} specifies that traffic on the socket should interpret telnet
1655 TCP and unix socket options are given below:
1659 @item TCP options: port=@var{port} [,host=@var{host}] [,to=@var{to}] [,ipv4] [,ipv6] [,nodelay]
1661 @option{host} for a listening socket specifies the local address to be bound.
1662 For a connecting socket species the remote host to connect to. @option{host} is
1663 optional for listening sockets. If not specified it defaults to @code{0.0.0.0}.
1665 @option{port} for a listening socket specifies the local port to be bound. For a
1666 connecting socket specifies the port on the remote host to connect to.
1667 @option{port} can be given as either a port number or a service name.
1668 @option{port} is required.
1670 @option{to} is only relevant to listening sockets. If it is specified, and
1671 @option{port} cannot be bound, QEMU will attempt to bind to subsequent ports up
1672 to and including @option{to} until it succeeds. @option{to} must be specified
1675 @option{ipv4} and @option{ipv6} specify that either IPv4 or IPv6 must be used.
1676 If neither is specified the socket may use either protocol.
1678 @option{nodelay} disables the Nagle algorithm.
1680 @item unix options: path=@var{path}
1682 @option{path} specifies the local path of the unix socket. @option{path} is
1687 @item -chardev udp ,id=@var{id} [,host=@var{host}] ,port=@var{port} [,localaddr=@var{localaddr}] [,localport=@var{localport}] [,ipv4] [,ipv6]
1689 Sends all traffic from the guest to a remote host over UDP.
1691 @option{host} specifies the remote host to connect to. If not specified it
1692 defaults to @code{localhost}.
1694 @option{port} specifies the port on the remote host to connect to. @option{port}
1697 @option{localaddr} specifies the local address to bind to. If not specified it
1698 defaults to @code{0.0.0.0}.
1700 @option{localport} specifies the local port to bind to. If not specified any
1701 available local port will be used.
1703 @option{ipv4} and @option{ipv6} specify that either IPv4 or IPv6 must be used.
1704 If neither is specified the device may use either protocol.
1706 @item -chardev msmouse ,id=@var{id}
1708 Forward QEMU's emulated msmouse events to the guest. @option{msmouse} does not
1711 @item -chardev vc ,id=@var{id} [[,width=@var{width}] [,height=@var{height}]] [[,cols=@var{cols}] [,rows=@var{rows}]]
1713 Connect to a QEMU text console. @option{vc} may optionally be given a specific
1716 @option{width} and @option{height} specify the width and height respectively of
1717 the console, in pixels.
1719 @option{cols} and @option{rows} specify that the console be sized to fit a text
1720 console with the given dimensions.
1722 @item -chardev file ,id=@var{id} ,path=@var{path}
1724 Log all traffic received from the guest to a file.
1726 @option{path} specifies the path of the file to be opened. This file will be
1727 created if it does not already exist, and overwritten if it does. @option{path}
1730 @item -chardev pipe ,id=@var{id} ,path=@var{path}
1732 Create a two-way connection to the guest. The behaviour differs slightly between
1733 Windows hosts and other hosts:
1735 On Windows, a single duplex pipe will be created at
1736 @file{\\.pipe\@option{path}}.
1738 On other hosts, 2 pipes will be created called @file{@option{path}.in} and
1739 @file{@option{path}.out}. Data written to @file{@option{path}.in} will be
1740 received by the guest. Data written by the guest can be read from
1741 @file{@option{path}.out}. QEMU will not create these fifos, and requires them to
1744 @option{path} forms part of the pipe path as described above. @option{path} is
1747 @item -chardev console ,id=@var{id}
1749 Send traffic from the guest to QEMU's standard output. @option{console} does not
1752 @option{console} is only available on Windows hosts.
1754 @item -chardev serial ,id=@var{id} ,path=@option{path}
1756 Send traffic from the guest to a serial device on the host.
1759 only available on Windows hosts.
1761 @option{path} specifies the name of the serial device to open.
1763 @item -chardev pty ,id=@var{id}
1765 Create a new pseudo-terminal on the host and connect to it. @option{pty} does
1766 not take any options.
1768 @option{pty} is not available on Windows hosts.
1770 @item -chardev stdio ,id=@var{id} [,signal=on|off]
1771 Connect to standard input and standard output of the qemu process.
1773 @option{signal} controls if signals are enabled on the terminal, that includes
1774 exiting QEMU with the key sequence @key{Control-c}. This option is enabled by
1775 default, use @option{signal=off} to disable it.
1777 @option{stdio} is not available on Windows hosts.
1779 @item -chardev braille ,id=@var{id}
1781 Connect to a local BrlAPI server. @option{braille} does not take any options.
1783 @item -chardev tty ,id=@var{id} ,path=@var{path}
1785 Connect to a local tty device.
1787 @option{tty} is only available on Linux, Sun, FreeBSD, NetBSD, OpenBSD and
1790 @option{path} specifies the path to the tty. @option{path} is required.
1792 @item -chardev parport ,id=@var{id} ,path=@var{path}
1794 @option{parport} is only available on Linux, FreeBSD and DragonFlyBSD hosts.
1796 Connect to a local parallel port.
1798 @option{path} specifies the path to the parallel port device. @option{path} is
1801 @item -chardev spicevmc ,id=@var{id} ,debug=@var{debug}, name=@var{name}
1803 @option{spicevmc} is only available when spice support is built in.
1805 @option{debug} debug level for spicevmc
1807 @option{name} name of spice channel to connect to
1809 Connect to a spice virtual machine channel, such as vdiport.
1817 DEFHEADING(Device URL Syntax:)
1819 In addition to using normal file images for the emulated storage devices,
1820 QEMU can also use networked resources such as iSCSI devices. These are
1821 specified using a special URL syntax.
1825 iSCSI support allows QEMU to access iSCSI resources directly and use as
1826 images for the guest storage. Both disk and cdrom images are supported.
1828 Syntax for specifying iSCSI LUNs is
1829 ``iscsi://<target-ip>[:<port>]/<target-iqn>/<lun>''
1831 Example (without authentication):
1833 qemu -cdrom iscsi://192.0.2.1/iqn.2001-04.com.example/2 \
1834 --drive file=iscsi://192.0.2.1/iqn.2001-04.com.example/1
1837 Example (CHAP username/password via URL):
1839 qemu --drive file=iscsi://user%password@@192.0.2.1/iqn.2001-04.com.example/1
1842 Example (CHAP username/password via environment variables):
1844 LIBISCSI_CHAP_USERNAME="user" \
1845 LIBISCSI_CHAP_PASSWORD="password" \
1846 qemu --drive file=iscsi://192.0.2.1/iqn.2001-04.com.example/1
1849 iSCSI support is an optional feature of QEMU and only available when
1850 compiled and linked against libiscsi.
1853 QEMU supports NBD (Network Block Devices) both using TCP protocol as well
1854 as Unix Domain Sockets.
1856 Syntax for specifying a NBD device using TCP
1857 ``nbd:<server-ip>:<port>[:exportname=<export>]''
1859 Syntax for specifying a NBD device using Unix Domain Sockets
1860 ``nbd:unix:<domain-socket>[:exportname=<export>]''
1865 qemu --drive file=nbd:192.0.2.1:30000
1868 Example for Unix Domain Sockets
1870 qemu --drive file=nbd:unix:/tmp/nbd-socket
1874 Sheepdog is a distributed storage system for QEMU.
1875 QEMU supports using either local sheepdog devices or remote networked
1878 Syntax for specifying a sheepdog device
1880 ``sheepdog:<vdiname>''
1882 ``sheepdog:<vdiname>:<snapid>''
1884 ``sheepdog:<vdiname>:<tag>''
1886 ``sheepdog:<host>:<port>:<vdiname>''
1888 ``sheepdog:<host>:<port>:<vdiname>:<snapid>''
1890 ``sheepdog:<host>:<port>:<vdiname>:<tag>''
1895 qemu --drive file=sheepdog:192.0.2.1:30000:MyVirtualMachine
1898 See also @url{http://http://www.osrg.net/sheepdog/}.
1903 DEFHEADING(Bluetooth(R) options:)
1905 DEF("bt", HAS_ARG, QEMU_OPTION_bt, \
1906 "-bt hci,null dumb bluetooth HCI - doesn't respond to commands\n" \
1907 "-bt hci,host[:id]\n" \
1908 " use host's HCI with the given name\n" \
1909 "-bt hci[,vlan=n]\n" \
1910 " emulate a standard HCI in virtual scatternet 'n'\n" \
1911 "-bt vhci[,vlan=n]\n" \
1912 " add host computer to virtual scatternet 'n' using VHCI\n" \
1913 "-bt device:dev[,vlan=n]\n" \
1914 " emulate a bluetooth device 'dev' in scatternet 'n'\n",
1921 Defines the function of the corresponding Bluetooth HCI. -bt options
1922 are matched with the HCIs present in the chosen machine type. For
1923 example when emulating a machine with only one HCI built into it, only
1924 the first @code{-bt hci[...]} option is valid and defines the HCI's
1925 logic. The Transport Layer is decided by the machine type. Currently
1926 the machines @code{n800} and @code{n810} have one HCI and all other
1930 The following three types are recognized:
1934 (default) The corresponding Bluetooth HCI assumes no internal logic
1935 and will not respond to any HCI commands or emit events.
1937 @item -bt hci,host[:@var{id}]
1938 (@code{bluez} only) The corresponding HCI passes commands / events
1939 to / from the physical HCI identified by the name @var{id} (default:
1940 @code{hci0}) on the computer running QEMU. Only available on @code{bluez}
1941 capable systems like Linux.
1943 @item -bt hci[,vlan=@var{n}]
1944 Add a virtual, standard HCI that will participate in the Bluetooth
1945 scatternet @var{n} (default @code{0}). Similarly to @option{-net}
1946 VLANs, devices inside a bluetooth network @var{n} can only communicate
1947 with other devices in the same network (scatternet).
1950 @item -bt vhci[,vlan=@var{n}]
1951 (Linux-host only) Create a HCI in scatternet @var{n} (default 0) attached
1952 to the host bluetooth stack instead of to the emulated target. This
1953 allows the host and target machines to participate in a common scatternet
1954 and communicate. Requires the Linux @code{vhci} driver installed. Can
1955 be used as following:
1958 qemu [...OPTIONS...] -bt hci,vlan=5 -bt vhci,vlan=5
1961 @item -bt device:@var{dev}[,vlan=@var{n}]
1962 Emulate a bluetooth device @var{dev} and place it in network @var{n}
1963 (default @code{0}). QEMU can only emulate one type of bluetooth devices
1968 Virtual wireless keyboard implementing the HIDP bluetooth profile.
1975 DEFHEADING(Linux/Multiboot boot specific:)
1978 When using these options, you can use a given Linux or Multiboot
1979 kernel without installing it in the disk image. It can be useful
1980 for easier testing of various kernels.
1985 DEF("kernel", HAS_ARG, QEMU_OPTION_kernel, \
1986 "-kernel bzImage use 'bzImage' as kernel image\n", QEMU_ARCH_ALL)
1988 @item -kernel @var{bzImage}
1990 Use @var{bzImage} as kernel image. The kernel can be either a Linux kernel
1991 or in multiboot format.
1994 DEF("append", HAS_ARG, QEMU_OPTION_append, \
1995 "-append cmdline use 'cmdline' as kernel command line\n", QEMU_ARCH_ALL)
1997 @item -append @var{cmdline}
1999 Use @var{cmdline} as kernel command line
2002 DEF("initrd", HAS_ARG, QEMU_OPTION_initrd, \
2003 "-initrd file use 'file' as initial ram disk\n", QEMU_ARCH_ALL)
2005 @item -initrd @var{file}
2007 Use @var{file} as initial ram disk.
2009 @item -initrd "@var{file1} arg=foo,@var{file2}"
2011 This syntax is only available with multiboot.
2013 Use @var{file1} and @var{file2} as modules and pass arg=foo as parameter to the
2023 DEFHEADING(Debug/Expert options:)
2029 DEF("serial", HAS_ARG, QEMU_OPTION_serial, \
2030 "-serial dev redirect the serial port to char device 'dev'\n",
2033 @item -serial @var{dev}
2035 Redirect the virtual serial port to host character device
2036 @var{dev}. The default device is @code{vc} in graphical mode and
2037 @code{stdio} in non graphical mode.
2039 This option can be used several times to simulate up to 4 serial
2042 Use @code{-serial none} to disable all serial ports.
2044 Available character devices are:
2046 @item vc[:@var{W}x@var{H}]
2047 Virtual console. Optionally, a width and height can be given in pixel with
2051 It is also possible to specify width or height in characters:
2056 [Linux only] Pseudo TTY (a new PTY is automatically allocated)
2058 No device is allocated.
2062 [Linux only] Use host tty, e.g. @file{/dev/ttyS0}. The host serial port
2063 parameters are set according to the emulated ones.
2064 @item /dev/parport@var{N}
2065 [Linux only, parallel port only] Use host parallel port
2066 @var{N}. Currently SPP and EPP parallel port features can be used.
2067 @item file:@var{filename}
2068 Write output to @var{filename}. No character can be read.
2070 [Unix only] standard input/output
2071 @item pipe:@var{filename}
2072 name pipe @var{filename}
2074 [Windows only] Use host serial port @var{n}
2075 @item udp:[@var{remote_host}]:@var{remote_port}[@@[@var{src_ip}]:@var{src_port}]
2076 This implements UDP Net Console.
2077 When @var{remote_host} or @var{src_ip} are not specified
2078 they default to @code{0.0.0.0}.
2079 When not using a specified @var{src_port} a random port is automatically chosen.
2081 If you just want a simple readonly console you can use @code{netcat} or
2082 @code{nc}, by starting qemu with: @code{-serial udp::4555} and nc as:
2083 @code{nc -u -l -p 4555}. Any time qemu writes something to that port it
2084 will appear in the netconsole session.
2086 If you plan to send characters back via netconsole or you want to stop
2087 and start qemu a lot of times, you should have qemu use the same
2088 source port each time by using something like @code{-serial
2089 udp::4555@@:4556} to qemu. Another approach is to use a patched
2090 version of netcat which can listen to a TCP port and send and receive
2091 characters via udp. If you have a patched version of netcat which
2092 activates telnet remote echo and single char transfer, then you can
2093 use the following options to step up a netcat redirector to allow
2094 telnet on port 5555 to access the qemu port.
2097 -serial udp::4555@@:4556
2098 @item netcat options:
2099 -u -P 4555 -L 0.0.0.0:4556 -t -p 5555 -I -T
2100 @item telnet options:
2104 @item tcp:[@var{host}]:@var{port}[,@var{server}][,nowait][,nodelay]
2105 The TCP Net Console has two modes of operation. It can send the serial
2106 I/O to a location or wait for a connection from a location. By default
2107 the TCP Net Console is sent to @var{host} at the @var{port}. If you use
2108 the @var{server} option QEMU will wait for a client socket application
2109 to connect to the port before continuing, unless the @code{nowait}
2110 option was specified. The @code{nodelay} option disables the Nagle buffering
2111 algorithm. If @var{host} is omitted, 0.0.0.0 is assumed. Only
2112 one TCP connection at a time is accepted. You can use @code{telnet} to
2113 connect to the corresponding character device.
2115 @item Example to send tcp console to 192.168.0.2 port 4444
2116 -serial tcp:192.168.0.2:4444
2117 @item Example to listen and wait on port 4444 for connection
2118 -serial tcp::4444,server
2119 @item Example to not wait and listen on ip 192.168.0.100 port 4444
2120 -serial tcp:192.168.0.100:4444,server,nowait
2123 @item telnet:@var{host}:@var{port}[,server][,nowait][,nodelay]
2124 The telnet protocol is used instead of raw tcp sockets. The options
2125 work the same as if you had specified @code{-serial tcp}. The
2126 difference is that the port acts like a telnet server or client using
2127 telnet option negotiation. This will also allow you to send the
2128 MAGIC_SYSRQ sequence if you use a telnet that supports sending the break
2129 sequence. Typically in unix telnet you do it with Control-] and then
2130 type "send break" followed by pressing the enter key.
2132 @item unix:@var{path}[,server][,nowait]
2133 A unix domain socket is used instead of a tcp socket. The option works the
2134 same as if you had specified @code{-serial tcp} except the unix domain socket
2135 @var{path} is used for connections.
2137 @item mon:@var{dev_string}
2138 This is a special option to allow the monitor to be multiplexed onto
2139 another serial port. The monitor is accessed with key sequence of
2140 @key{Control-a} and then pressing @key{c}. See monitor access
2141 @ref{pcsys_keys} in the -nographic section for more keys.
2142 @var{dev_string} should be any one of the serial devices specified
2143 above. An example to multiplex the monitor onto a telnet server
2144 listening on port 4444 would be:
2146 @item -serial mon:telnet::4444,server,nowait
2150 Braille device. This will use BrlAPI to display the braille output on a real
2154 Three button serial mouse. Configure the guest to use Microsoft protocol.
2158 DEF("parallel", HAS_ARG, QEMU_OPTION_parallel, \
2159 "-parallel dev redirect the parallel port to char device 'dev'\n",
2162 @item -parallel @var{dev}
2164 Redirect the virtual parallel port to host device @var{dev} (same
2165 devices as the serial port). On Linux hosts, @file{/dev/parportN} can
2166 be used to use hardware devices connected on the corresponding host
2169 This option can be used several times to simulate up to 3 parallel
2172 Use @code{-parallel none} to disable all parallel ports.
2175 DEF("monitor", HAS_ARG, QEMU_OPTION_monitor, \
2176 "-monitor dev redirect the monitor to char device 'dev'\n",
2179 @item -monitor @var{dev}
2181 Redirect the monitor to host device @var{dev} (same devices as the
2183 The default device is @code{vc} in graphical mode and @code{stdio} in
2186 DEF("qmp", HAS_ARG, QEMU_OPTION_qmp, \
2187 "-qmp dev like -monitor but opens in 'control' mode\n",
2190 @item -qmp @var{dev}
2192 Like -monitor but opens in 'control' mode.
2195 DEF("mon", HAS_ARG, QEMU_OPTION_mon, \
2196 "-mon chardev=[name][,mode=readline|control][,default]\n", QEMU_ARCH_ALL)
2198 @item -mon chardev=[name][,mode=readline|control][,default]
2200 Setup monitor on chardev @var{name}.
2203 DEF("debugcon", HAS_ARG, QEMU_OPTION_debugcon, \
2204 "-debugcon dev redirect the debug console to char device 'dev'\n",
2207 @item -debugcon @var{dev}
2209 Redirect the debug console to host device @var{dev} (same devices as the
2210 serial port). The debug console is an I/O port which is typically port
2211 0xe9; writing to that I/O port sends output to this device.
2212 The default device is @code{vc} in graphical mode and @code{stdio} in
2216 DEF("pidfile", HAS_ARG, QEMU_OPTION_pidfile, \
2217 "-pidfile file write PID to 'file'\n", QEMU_ARCH_ALL)
2219 @item -pidfile @var{file}
2221 Store the QEMU process PID in @var{file}. It is useful if you launch QEMU
2225 DEF("singlestep", 0, QEMU_OPTION_singlestep, \
2226 "-singlestep always run in singlestep mode\n", QEMU_ARCH_ALL)
2230 Run the emulation in single step mode.
2233 DEF("S", 0, QEMU_OPTION_S, \
2234 "-S freeze CPU at startup (use 'c' to start execution)\n",
2239 Do not start CPU at startup (you must type 'c' in the monitor).
2242 DEF("gdb", HAS_ARG, QEMU_OPTION_gdb, \
2243 "-gdb dev wait for gdb connection on 'dev'\n", QEMU_ARCH_ALL)
2245 @item -gdb @var{dev}
2247 Wait for gdb connection on device @var{dev} (@pxref{gdb_usage}). Typical
2248 connections will likely be TCP-based, but also UDP, pseudo TTY, or even
2249 stdio are reasonable use case. The latter is allowing to start qemu from
2250 within gdb and establish the connection via a pipe:
2252 (gdb) target remote | exec qemu -gdb stdio ...
2256 DEF("s", 0, QEMU_OPTION_s, \
2257 "-s shorthand for -gdb tcp::" DEFAULT_GDBSTUB_PORT "\n",
2262 Shorthand for -gdb tcp::1234, i.e. open a gdbserver on TCP port 1234
2263 (@pxref{gdb_usage}).
2266 DEF("d", HAS_ARG, QEMU_OPTION_d, \
2267 "-d item1,... output log to /tmp/qemu.log (use -d ? for a list of log items)\n",
2272 Output log in /tmp/qemu.log
2275 DEF("D", HAS_ARG, QEMU_OPTION_D, \
2276 "-D logfile output log to logfile (instead of the default /tmp/qemu.log)\n",
2281 Output log in logfile instead of /tmp/qemu.log
2284 DEF("hdachs", HAS_ARG, QEMU_OPTION_hdachs, \
2285 "-hdachs c,h,s[,t]\n" \
2286 " force hard disk 0 physical geometry and the optional BIOS\n" \
2287 " translation (t=none or lba) (usually qemu can guess them)\n",
2290 @item -hdachs @var{c},@var{h},@var{s},[,@var{t}]
2292 Force hard disk 0 physical geometry (1 <= @var{c} <= 16383, 1 <=
2293 @var{h} <= 16, 1 <= @var{s} <= 63) and optionally force the BIOS
2294 translation mode (@var{t}=none, lba or auto). Usually QEMU can guess
2295 all those parameters. This option is useful for old MS-DOS disk
2299 DEF("L", HAS_ARG, QEMU_OPTION_L, \
2300 "-L path set the directory for the BIOS, VGA BIOS and keymaps\n",
2305 Set the directory for the BIOS, VGA BIOS and keymaps.
2308 DEF("bios", HAS_ARG, QEMU_OPTION_bios, \
2309 "-bios file set the filename for the BIOS\n", QEMU_ARCH_ALL)
2311 @item -bios @var{file}
2313 Set the filename for the BIOS.
2316 DEF("enable-kvm", 0, QEMU_OPTION_enable_kvm, \
2317 "-enable-kvm enable KVM full virtualization support\n", QEMU_ARCH_ALL)
2321 Enable KVM full virtualization support. This option is only available
2322 if KVM support is enabled when compiling.
2325 DEF("xen-domid", HAS_ARG, QEMU_OPTION_xen_domid,
2326 "-xen-domid id specify xen guest domain id\n", QEMU_ARCH_ALL)
2327 DEF("xen-create", 0, QEMU_OPTION_xen_create,
2328 "-xen-create create domain using xen hypercalls, bypassing xend\n"
2329 " warning: should not be used when xend is in use\n",
2331 DEF("xen-attach", 0, QEMU_OPTION_xen_attach,
2332 "-xen-attach attach to existing xen domain\n"
2333 " xend will use this when starting qemu\n",
2336 @item -xen-domid @var{id}
2338 Specify xen guest domain @var{id} (XEN only).
2341 Create domain using xen hypercalls, bypassing xend.
2342 Warning: should not be used when xend is in use (XEN only).
2345 Attach to existing xen domain.
2346 xend will use this when starting qemu (XEN only).
2349 DEF("no-reboot", 0, QEMU_OPTION_no_reboot, \
2350 "-no-reboot exit instead of rebooting\n", QEMU_ARCH_ALL)
2354 Exit instead of rebooting.
2357 DEF("no-shutdown", 0, QEMU_OPTION_no_shutdown, \
2358 "-no-shutdown stop before shutdown\n", QEMU_ARCH_ALL)
2361 @findex -no-shutdown
2362 Don't exit QEMU on guest shutdown, but instead only stop the emulation.
2363 This allows for instance switching to monitor to commit changes to the
2367 DEF("loadvm", HAS_ARG, QEMU_OPTION_loadvm, \
2368 "-loadvm [tag|id]\n" \
2369 " start right away with a saved state (loadvm in monitor)\n",
2372 @item -loadvm @var{file}
2374 Start right away with a saved state (@code{loadvm} in monitor)
2378 DEF("daemonize", 0, QEMU_OPTION_daemonize, \
2379 "-daemonize daemonize QEMU after initializing\n", QEMU_ARCH_ALL)
2384 Daemonize the QEMU process after initialization. QEMU will not detach from
2385 standard IO until it is ready to receive connections on any of its devices.
2386 This option is a useful way for external programs to launch QEMU without having
2387 to cope with initialization race conditions.
2390 DEF("option-rom", HAS_ARG, QEMU_OPTION_option_rom, \
2391 "-option-rom rom load a file, rom, into the option ROM space\n",
2394 @item -option-rom @var{file}
2396 Load the contents of @var{file} as an option ROM.
2397 This option is useful to load things like EtherBoot.
2400 DEF("clock", HAS_ARG, QEMU_OPTION_clock, \
2401 "-clock force the use of the given methods for timer alarm.\n" \
2402 " To see what timers are available use -clock ?\n",
2405 @item -clock @var{method}
2407 Force the use of the given methods for timer alarm. To see what timers
2408 are available use -clock ?.
2411 HXCOMM Options deprecated by -rtc
2412 DEF("localtime", 0, QEMU_OPTION_localtime, "", QEMU_ARCH_ALL)
2413 DEF("startdate", HAS_ARG, QEMU_OPTION_startdate, "", QEMU_ARCH_ALL)
2415 DEF("rtc", HAS_ARG, QEMU_OPTION_rtc, \
2416 "-rtc [base=utc|localtime|date][,clock=host|vm][,driftfix=none|slew]\n" \
2417 " set the RTC base and clock, enable drift fix for clock ticks (x86 only)\n",
2422 @item -rtc [base=utc|localtime|@var{date}][,clock=host|vm][,driftfix=none|slew]
2424 Specify @option{base} as @code{utc} or @code{localtime} to let the RTC start at the current
2425 UTC or local time, respectively. @code{localtime} is required for correct date in
2426 MS-DOS or Windows. To start at a specific point in time, provide @var{date} in the
2427 format @code{2006-06-17T16:01:21} or @code{2006-06-17}. The default base is UTC.
2429 By default the RTC is driven by the host system time. This allows to use the
2430 RTC as accurate reference clock inside the guest, specifically if the host
2431 time is smoothly following an accurate external reference clock, e.g. via NTP.
2432 If you want to isolate the guest time from the host, even prevent it from
2433 progressing during suspension, you can set @option{clock} to @code{vm} instead.
2435 Enable @option{driftfix} (i386 targets only) if you experience time drift problems,
2436 specifically with Windows' ACPI HAL. This option will try to figure out how
2437 many timer interrupts were not processed by the Windows guest and will
2441 DEF("icount", HAS_ARG, QEMU_OPTION_icount, \
2442 "-icount [N|auto]\n" \
2443 " enable virtual instruction counter with 2^N clock ticks per\n" \
2444 " instruction\n", QEMU_ARCH_ALL)
2446 @item -icount [@var{N}|auto]
2448 Enable virtual instruction counter. The virtual cpu will execute one
2449 instruction every 2^@var{N} ns of virtual time. If @code{auto} is specified
2450 then the virtual cpu speed will be automatically adjusted to keep virtual
2451 time within a few seconds of real time.
2453 Note that while this option can give deterministic behavior, it does not
2454 provide cycle accurate emulation. Modern CPUs contain superscalar out of
2455 order cores with complex cache hierarchies. The number of instructions
2456 executed often has little or no correlation with actual performance.
2459 DEF("watchdog", HAS_ARG, QEMU_OPTION_watchdog, \
2460 "-watchdog i6300esb|ib700\n" \
2461 " enable virtual hardware watchdog [default=none]\n",
2464 @item -watchdog @var{model}
2466 Create a virtual hardware watchdog device. Once enabled (by a guest
2467 action), the watchdog must be periodically polled by an agent inside
2468 the guest or else the guest will be restarted.
2470 The @var{model} is the model of hardware watchdog to emulate. Choices
2471 for model are: @code{ib700} (iBASE 700) which is a very simple ISA
2472 watchdog with a single timer, or @code{i6300esb} (Intel 6300ESB I/O
2473 controller hub) which is a much more featureful PCI-based dual-timer
2474 watchdog. Choose a model for which your guest has drivers.
2476 Use @code{-watchdog ?} to list available hardware models. Only one
2477 watchdog can be enabled for a guest.
2480 DEF("watchdog-action", HAS_ARG, QEMU_OPTION_watchdog_action, \
2481 "-watchdog-action reset|shutdown|poweroff|pause|debug|none\n" \
2482 " action when watchdog fires [default=reset]\n",
2485 @item -watchdog-action @var{action}
2487 The @var{action} controls what QEMU will do when the watchdog timer
2490 @code{reset} (forcefully reset the guest).
2491 Other possible actions are:
2492 @code{shutdown} (attempt to gracefully shutdown the guest),
2493 @code{poweroff} (forcefully poweroff the guest),
2494 @code{pause} (pause the guest),
2495 @code{debug} (print a debug message and continue), or
2496 @code{none} (do nothing).
2498 Note that the @code{shutdown} action requires that the guest responds
2499 to ACPI signals, which it may not be able to do in the sort of
2500 situations where the watchdog would have expired, and thus
2501 @code{-watchdog-action shutdown} is not recommended for production use.
2506 @item -watchdog i6300esb -watchdog-action pause
2507 @item -watchdog ib700
2511 DEF("echr", HAS_ARG, QEMU_OPTION_echr, \
2512 "-echr chr set terminal escape character instead of ctrl-a\n",
2516 @item -echr @var{numeric_ascii_value}
2518 Change the escape character used for switching to the monitor when using
2519 monitor and serial sharing. The default is @code{0x01} when using the
2520 @code{-nographic} option. @code{0x01} is equal to pressing
2521 @code{Control-a}. You can select a different character from the ascii
2522 control keys where 1 through 26 map to Control-a through Control-z. For
2523 instance you could use the either of the following to change the escape
2524 character to Control-t.
2531 DEF("virtioconsole", HAS_ARG, QEMU_OPTION_virtiocon, \
2532 "-virtioconsole c\n" \
2533 " set virtio console\n", QEMU_ARCH_ALL)
2535 @item -virtioconsole @var{c}
2536 @findex -virtioconsole
2539 This option is maintained for backward compatibility.
2541 Please use @code{-device virtconsole} for the new way of invocation.
2544 DEF("show-cursor", 0, QEMU_OPTION_show_cursor, \
2545 "-show-cursor show cursor\n", QEMU_ARCH_ALL)
2548 @findex -show-cursor
2552 DEF("tb-size", HAS_ARG, QEMU_OPTION_tb_size, \
2553 "-tb-size n set TB size\n", QEMU_ARCH_ALL)
2555 @item -tb-size @var{n}
2560 DEF("incoming", HAS_ARG, QEMU_OPTION_incoming, \
2561 "-incoming p prepare for incoming migration, listen on port p\n",
2564 @item -incoming @var{port}
2566 Prepare for incoming migration, listen on @var{port}.
2569 DEF("nodefaults", 0, QEMU_OPTION_nodefaults, \
2570 "-nodefaults don't create default devices\n", QEMU_ARCH_ALL)
2574 Don't create default devices.
2578 DEF("chroot", HAS_ARG, QEMU_OPTION_chroot, \
2579 "-chroot dir chroot to dir just before starting the VM\n",
2583 @item -chroot @var{dir}
2585 Immediately before starting guest execution, chroot to the specified
2586 directory. Especially useful in combination with -runas.
2590 DEF("runas", HAS_ARG, QEMU_OPTION_runas, \
2591 "-runas user change to user id user just before starting the VM\n",
2595 @item -runas @var{user}
2597 Immediately before starting guest execution, drop root privileges, switching
2598 to the specified user.
2601 DEF("prom-env", HAS_ARG, QEMU_OPTION_prom_env,
2602 "-prom-env variable=value\n"
2603 " set OpenBIOS nvram variables\n",
2604 QEMU_ARCH_PPC | QEMU_ARCH_SPARC)
2606 @item -prom-env @var{variable}=@var{value}
2608 Set OpenBIOS nvram @var{variable} to given @var{value} (PPC, SPARC only).
2610 DEF("semihosting", 0, QEMU_OPTION_semihosting,
2611 "-semihosting semihosting mode\n", QEMU_ARCH_ARM | QEMU_ARCH_M68K | QEMU_ARCH_XTENSA)
2614 @findex -semihosting
2615 Semihosting mode (ARM, M68K, Xtensa only).
2617 DEF("old-param", 0, QEMU_OPTION_old_param,
2618 "-old-param old param mode\n", QEMU_ARCH_ARM)
2621 @findex -old-param (ARM)
2622 Old param mode (ARM only).
2625 DEF("readconfig", HAS_ARG, QEMU_OPTION_readconfig,
2626 "-readconfig <file>\n", QEMU_ARCH_ALL)
2628 @item -readconfig @var{file}
2630 Read device configuration from @var{file}.
2632 DEF("writeconfig", HAS_ARG, QEMU_OPTION_writeconfig,
2633 "-writeconfig <file>\n"
2634 " read/write config file\n", QEMU_ARCH_ALL)
2636 @item -writeconfig @var{file}
2637 @findex -writeconfig
2638 Write device configuration to @var{file}.
2640 DEF("nodefconfig", 0, QEMU_OPTION_nodefconfig,
2642 " do not load default config files at startup\n",
2646 @findex -nodefconfig
2647 Normally QEMU loads a configuration file from @var{sysconfdir}/qemu.conf and
2648 @var{sysconfdir}/target-@var{ARCH}.conf on startup. The @code{-nodefconfig}
2649 option will prevent QEMU from loading these configuration files at startup.
2651 DEF("trace", HAS_ARG, QEMU_OPTION_trace,
2652 "-trace [events=<file>][,file=<file>]\n"
2653 " specify tracing options\n",
2656 HXCOMM This line is not accurate, as some sub-options are backend-specific but
2657 HXCOMM HX does not support conditional compilation of text.
2658 @item -trace [events=@var{file}][,file=@var{file}]
2661 Specify tracing options.
2664 @item events=@var{file}
2665 Immediately enable events listed in @var{file}.
2666 The file must contain one event name (as listed in the @var{trace-events} file)
2668 This option is only available if QEMU has been compiled with
2669 either @var{simple} or @var{stderr} tracing backend.
2670 @item file=@var{file}
2671 Log output traces to @var{file}.
2673 This option is only available if QEMU has been compiled with
2674 the @var{simple} tracing backend.
2678 HXCOMM This is the last statement. Insert new options before this line!