[Top][All Lists]
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[Qemu-devel] [6884] Syncing documentation vs.
|
From: |
Blue Swirl |
|
Subject: |
[Qemu-devel] [6884] Syncing documentation vs. |
|
Date: |
Sat, 28 Mar 2009 06:44:28 +0000 |
Revision: 6884
http://svn.sv.gnu.org/viewvc/?view=rev&root=qemu&revision=6884
Author: blueswir1
Date: 2009-03-28 06:44:27 +0000 (Sat, 28 Mar 2009)
Log Message:
-----------
Syncing documentation vs. -help vs. qemu_options table
Try to keep documentation about command line switches, -help text and
qemu_options table synchronized.
In true Qemu tradition, an include file is generated from single .hx file
containing all relevant information in one place. The include file is
parsed once for getting the enums, another time for getopt tables and
hird time for help messages. Texi documentation for the options is
generated from the same .hx file.
Modified Paths:
--------------
trunk/Makefile
trunk/Makefile.target
trunk/qemu-doc.texi
trunk/vl.c
Added Paths:
-----------
trunk/hxtool
trunk/qemu-options.hx
Modified: trunk/Makefile
===================================================================
--- trunk/Makefile 2009-03-22 03:01:39 UTC (rev 6883)
+++ trunk/Makefile 2009-03-28 06:44:27 UTC (rev 6884)
@@ -283,14 +283,17 @@
# documentation
%.html: %.texi
- texi2html -monolithic -number $<
+ texi2html -I=. -monolithic -number $<
%.info: %.texi
- makeinfo $< -o $@
+ makeinfo -I . $< -o $@
%.dvi: %.texi
- texi2dvi $<
+ texi2dvi -I . $<
+qemu-options.texi: $(SRC_PATH)/qemu-options.hx
+ sh ./hxtool -t < $< > $@
+
qemu.1: qemu-doc.texi
perl -Ww -- $(SRC_PATH)/texi2pod.pl $< qemu.pod
pod2man --section=1 --center=" " --release=" " qemu.pod > $@
@@ -309,7 +312,7 @@
html: qemu-doc.html qemu-tech.html
-qemu-doc.dvi qemu-doc.html qemu-doc.info: qemu-img.texi qemu-nbd.texi
+qemu-doc.dvi qemu-doc.html qemu-doc.info: qemu-img.texi qemu-nbd.texi
qemu-options.texi
VERSION ?= $(shell cat VERSION)
FILE = qemu-$(VERSION)
Modified: trunk/Makefile.target
===================================================================
--- trunk/Makefile.target 2009-03-22 03:01:39 UTC (rev 6883)
+++ trunk/Makefile.target 2009-03-28 06:44:27 UTC (rev 6884)
@@ -729,6 +729,8 @@
main.o: CFLAGS+=-p
endif
+vl.o: qemu-options.h
+
$(QEMU_PROG): LIBS += $(SDL_LIBS) $(COCOA_LIBS) $(CURSES_LIBS) $(BRLAPI_LIBS)
$(VDE_LIBS)
$(QEMU_PROG): $(OBJS) ../libqemu_common.a libqemu.a
@@ -744,8 +746,11 @@
$(SHELL) $(SRC_PATH)/feature_to_c.sh $@ $(TARGET_XML_FILES)
endif
+qemu-options.h: $(SRC_PATH)/qemu-options.hx
+ sh ../hxtool -h < $< > $@
+
clean:
- rm -f *.o *.a *~ $(PROGS) nwfpe/*.o fpu/*.o
+ rm -f *.o *.a *~ $(PROGS) nwfpe/*.o fpu/*.o qemu-options.h
rm -f *.d */*.d tcg/*.o
install: all
Added: trunk/hxtool
===================================================================
--- trunk/hxtool (rev 0)
+++ trunk/hxtool 2009-03-28 06:44:27 UTC (rev 6884)
@@ -0,0 +1,42 @@
+#!/bin/sh
+
+hxtoh()
+{
+ flag=1
+ while read str; do
+ case $str in
+ HXCOMM*)
+ ;;
+ STEXI*|ETEXI*) flag=$(($flag^1))
+ ;;
+ *)
+ test $flag -eq 1 && echo $str
+ ;;
+ esac
+ done
+}
+
+hxtotexi()
+{
+ flag=0
+ while read str; do
+ case "$str" in
+ HXCOMM*)
+ ;;
+ STEXI*|ETEXI*) flag=$(($flag^1))
+ ;;
+ DEFHEADING*)
+ echo $(expr "$str" : "DEFHEADING(\(.*\))")
+ ;;
+ *)
+ test $flag -eq 1 && echo $str
+ ;;
+ esac
+ done
+}
+
+case "$1" in
+"-h") hxtoh ;;
+"-t") hxtotexi ;;
+*) exit 1 ;;
+esac
Modified: trunk/qemu-doc.texi
===================================================================
--- trunk/qemu-doc.texi 2009-03-22 03:01:39 UTC (rev 6883)
+++ trunk/qemu-doc.texi 2009-03-28 06:44:27 UTC (rev 6884)
@@ -224,981 +224,8 @@
@var{disk_image} is a raw hard disk image for IDE hard disk 0. Some
targets do not need a disk image.
-General options:
address@hidden @option
address@hidden -h
-Display help and exit
address@hidden qemu-options.texi
address@hidden -M @var{machine}
-Select the emulated @var{machine} (@code{-M ?} for list)
-
address@hidden -cpu @var{model}
-Select CPU model (-cpu ? for list and additional feature selection)
-
address@hidden -smp @var{n}
-Simulate an SMP system with @var{n} CPUs. On the PC target, up to 255
-CPUs are supported. On Sparc32 target, Linux limits the number of usable CPUs
-to 4.
-
address@hidden -fda @var{file}
address@hidden -fdb @var{file}
-Use @var{file} as floppy disk 0/1 image (@pxref{disk_images}). You can
-use the host floppy by using @file{/dev/fd0} as filename (@pxref{host_drives}).
-
address@hidden -hda @var{file}
address@hidden -hdb @var{file}
address@hidden -hdc @var{file}
address@hidden -hdd @var{file}
-Use @var{file} as hard disk 0, 1, 2 or 3 image (@pxref{disk_images}).
-
address@hidden -cdrom @var{file}
-Use @var{file} as CD-ROM image (you cannot use @option{-hdc} and
address@hidden at the same time). You can use the host CD-ROM by
-using @file{/dev/cdrom} as filename (@pxref{host_drives}).
-
address@hidden -drive @var{option}[,@var{option}[,@var{option}[,...]]]
-
-Define a new drive. Valid options are:
-
address@hidden @code
address@hidden address@hidden
-This option defines which disk image (@pxref{disk_images}) to use with
-this drive. If the filename contains comma, you must double it
-(for instance, "file=my,,file" to use file "my,file").
address@hidden address@hidden
-This option defines on which type on interface the drive is connected.
-Available types are: ide, scsi, sd, mtd, floppy, pflash, virtio.
address@hidden address@hidden,address@hidden
-These options define where is connected the drive by defining the bus number
and
-the unit id.
address@hidden address@hidden
-This option defines where is connected the drive by using an index in the list
-of available connectors of a given interface type.
address@hidden address@hidden
-This option defines the type of the media: disk or cdrom.
address@hidden address@hidden,address@hidden,address@hidden,address@hidden
-These options have the same definition as they have in @option{-hdachs}.
address@hidden address@hidden
address@hidden is "on" or "off" and allows to enable snapshot for given drive
(see @option{-snapshot}).
address@hidden address@hidden
address@hidden is "none", "writeback", or "writethrough" and controls how the
host cache is used to access block data.
address@hidden address@hidden
-Specify which disk @var{format} will be used rather than detecting
-the format. Can be used to specifiy format=raw to avoid interpreting
-an untrusted format header.
address@hidden address@hidden
-This option specifies the serial number to assign to the device.
address@hidden table
-
-By default, writethrough caching is used for all block device. This means that
-the host page cache will be used to read and write data but write notification
-will be sent to the guest only when the data has been reported as written by
-the storage subsystem.
-
-Writeback caching will report data writes as completed as soon as the data is
-present in the host page cache. This is safe as long as you trust your host.
-If your host crashes or loses power, then the guest may experience data
-corruption. When using the @option{-snapshot} option, writeback caching is
-used by default.
-
-The host page can be avoided entirely with @option{cache=none}. This will
-attempt to do disk IO directly to the guests memory. QEMU may still perform
-an internal copy of the data.
-
-Some block drivers perform badly with @option{cache=writethrough}, most
notably,
-qcow2. If performance is more important than correctness,
address@hidden should be used with qcow2. By default, if no explicit
-caching is specified for a qcow2 disk image, @option{cache=writeback} will be
-used. For all other disk types, @option{cache=writethrough} is the default.
-
-Instead of @option{-cdrom} you can use:
address@hidden
-qemu -drive file=file,index=2,media=cdrom
address@hidden example
-
-Instead of @option{-hda}, @option{-hdb}, @option{-hdc}, @option{-hdd}, you can
-use:
address@hidden
-qemu -drive file=file,index=0,media=disk
-qemu -drive file=file,index=1,media=disk
-qemu -drive file=file,index=2,media=disk
-qemu -drive file=file,index=3,media=disk
address@hidden example
-
-You can connect a CDROM to the slave of ide0:
address@hidden
-qemu -drive file=file,if=ide,index=1,media=cdrom
address@hidden example
-
-If you don't specify the "file=" argument, you define an empty drive:
address@hidden
-qemu -drive if=ide,index=1,media=cdrom
address@hidden example
-
-You can connect a SCSI disk with unit ID 6 on the bus #0:
address@hidden
-qemu -drive file=file,if=scsi,bus=0,unit=6
address@hidden example
-
-Instead of @option{-fda}, @option{-fdb}, you can use:
address@hidden
-qemu -drive file=file,index=0,if=floppy
-qemu -drive file=file,index=1,if=floppy
address@hidden example
-
-By default, @var{interface} is "ide" and @var{index} is automatically
-incremented:
address@hidden
-qemu -drive file=a -drive file=b"
address@hidden example
-is interpreted like:
address@hidden
-qemu -hda a -hdb b
address@hidden example
-
address@hidden -mtdblock file
-Use 'file' as on-board Flash memory image.
-
address@hidden -sd file
-Use 'file' as SecureDigital card image.
-
address@hidden -pflash file
-Use 'file' as a parallel flash image.
-
address@hidden -boot [a|c|d|n]
-Boot on floppy (a), hard disk (c), CD-ROM (d), or Etherboot (n). Hard disk boot
-is the default.
-
address@hidden -snapshot
-Write to temporary files instead of disk image files. In this case,
-the raw disk image you use is not written back. You can however force
-the write back by pressing @key{C-a s} (@pxref{disk_images}).
-
address@hidden -m @var{megs}
-Set virtual RAM size to @var{megs} megabytes. Default is 128 MiB. Optionally,
-a suffix of ``M'' or ``G'' can be used to signify a value in megabytes or
-gigabytes respectively.
-
address@hidden -k @var{language}
-
-Use keyboard layout @var{language} (for example @code{fr} for
-French). This option is only needed where it is not easy to get raw PC
-keycodes (e.g. on Macs, with some X11 servers or with a VNC
-display). You don't normally need to use it on PC/Linux or PC/Windows
-hosts.
-
-The available layouts are:
address@hidden
-ar de-ch es fo fr-ca hu ja mk no pt-br sv
-da en-gb et fr fr-ch is lt nl pl ru th
-de en-us fi fr-be hr it lv nl-be pt sl tr
address@hidden example
-
-The default is @code{en-us}.
-
address@hidden -audio-help
-
-Will show the audio subsystem help: list of drivers, tunable
-parameters.
-
address@hidden -soundhw @var{card1}[,@var{card2},...] or -soundhw all
-
-Enable audio and selected sound hardware. Use ? to print all
-available sound hardware.
-
address@hidden
-qemu -soundhw sb16,adlib disk.img
-qemu -soundhw es1370 disk.img
-qemu -soundhw ac97 disk.img
-qemu -soundhw all disk.img
-qemu -soundhw ?
address@hidden example
-
-Note that Linux's i810_audio OSS kernel (for AC97) module might
-require manually specifying clocking.
-
address@hidden
-modprobe i810_audio clocking=48000
address@hidden example
-
address@hidden table
-
-USB options:
address@hidden @option
-
address@hidden -usb
-Enable the USB driver (will be the default soon)
-
address@hidden -usbdevice @var{devname}
-Add the USB device @var{devname}. @xref{usb_devices}.
-
address@hidden @code
-
address@hidden mouse
-Virtual Mouse. This will override the PS/2 mouse emulation when activated.
-
address@hidden tablet
-Pointer device that uses absolute coordinates (like a touchscreen). This
-means qemu is able to report the mouse position without having to grab the
-mouse. Also overrides the PS/2 mouse emulation when activated.
-
address@hidden disk:address@hidden:file
-Mass storage device based on file. The optional @var{format} argument
-will be used rather than detecting the format. Can be used to specifiy
-format=raw to avoid interpreting an untrusted format header.
-
address@hidden host:bus.addr
-Pass through the host device identified by bus.addr (Linux only).
-
address@hidden host:vendor_id:product_id
-Pass through the host device identified by vendor_id:product_id (Linux only).
-
address@hidden serial:address@hidden,address@hidden:@var{dev}
-Serial converter to host character device @var{dev}, see @code{-serial} for the
-available devices.
-
address@hidden braille
-Braille device. This will use BrlAPI to display the braille output on a real
-or fake device.
-
address@hidden net:options
-Network adapter that supports CDC ethernet and RNDIS protocols.
-
address@hidden table
-
address@hidden -name @var{name}
-Sets the @var{name} of the guest.
-This name will be displayed in the SDL window caption.
-The @var{name} will also be used for the VNC server.
-
address@hidden -uuid @var{uuid}
-Set system UUID.
-
address@hidden table
-
-Display options:
address@hidden @option
-
address@hidden -nographic
-
-Normally, QEMU uses SDL to display the VGA output. With this option,
-you can totally disable graphical output so that QEMU is a simple
-command line application. The emulated serial port is redirected on
-the console. Therefore, you can still use QEMU to debug a Linux kernel
-with a serial console.
-
address@hidden -curses
-
-Normally, QEMU uses SDL to display the VGA output. With this option,
-QEMU can display the VGA output when in text mode using a
-curses/ncurses interface. Nothing is displayed in graphical mode.
-
address@hidden -no-frame
-
-Do not use decorations for SDL windows and start them using the whole
-available screen space. This makes the using QEMU in a dedicated desktop
-workspace more convenient.
-
address@hidden -alt-grab
-
-Use Ctrl-Alt-Shift to grab mouse (instead of Ctrl-Alt).
-
address@hidden -no-quit
-
-Disable SDL window close capability.
-
address@hidden -sdl
-
-Enable SDL.
-
address@hidden -portrait
-
-Rotate graphical output 90 deg left (only PXA LCD).
-
address@hidden -vga @var{type}
-Select type of VGA card to emulate. Valid values for @var{type} are
address@hidden @code
address@hidden cirrus
-Cirrus Logic GD5446 Video card. All Windows versions starting from
-Windows 95 should recognize and use this graphic card. For optimal
-performances, use 16 bit color depth in the guest and the host OS.
-(This one is the default)
address@hidden std
-Standard VGA card with Bochs VBE extensions. If your guest OS
-supports the VESA 2.0 VBE extensions (e.g. Windows XP) and if you want
-to use high resolution modes (>= 1280x1024x16) then you should use
-this option.
address@hidden vmware
-VMWare SVGA-II compatible adapter. Use it if you have sufficiently
-recent XFree86/XOrg server or Windows guest with a driver for this
-card.
address@hidden none
-Disable VGA card.
address@hidden table
-
address@hidden -full-screen
-Start in full screen.
-
address@hidden -vnc @var{display}[,@var{option}[,@var{option}[,...]]]
-
-Normally, QEMU uses SDL to display the VGA output. With this option,
-you can have QEMU listen on VNC display @var{display} and redirect the VGA
-display over the VNC session. It is very useful to enable the usb
-tablet device when using this option (option @option{-usbdevice
-tablet}). When using the VNC display, you must use the @option{-k}
-parameter to set the keyboard layout if you are not using en-us. Valid
-syntax for the @var{display} is
-
address@hidden @code
-
address@hidden @var{host}:@var{d}
-
-TCP connections will only be allowed from @var{host} on display @var{d}.
-By convention the TCP port is address@hidden Optionally, @var{host} can
-be omitted in which case the server will accept connections from any host.
-
address@hidden @code{unix}:@var{path}
-
-Connections will be allowed over UNIX domain sockets where @var{path} is the
-location of a unix socket to listen for connections on.
-
address@hidden none
-
-VNC is initialized but not started. The monitor @code{change} command
-can be used to later start the VNC server.
-
address@hidden table
-
-Following the @var{display} value there may be one or more @var{option} flags
-separated by commas. Valid options are
-
address@hidden @code
-
address@hidden reverse
-
-Connect to a listening VNC client via a ``reverse'' connection. The
-client is specified by the @var{display}. For reverse network
-connections (@var{host}:@var{d},@code{reverse}), the @var{d} argument
-is a TCP port number, not a display number.
-
address@hidden password
-
-Require that password based authentication is used for client connections.
-The password must be set separately using the @code{change} command in the
address@hidden
-
address@hidden tls
-
-Require that client use TLS when communicating with the VNC server. This
-uses anonymous TLS credentials so is susceptible to a man-in-the-middle
-attack. It is recommended that this option be combined with either the
address@hidden or @var{x509verify} options.
-
address@hidden address@hidden/path/to/certificate/dir}
-
-Valid if @option{tls} is specified. Require that x509 credentials are used
-for negotiating the TLS session. The server will send its x509 certificate
-to the client. It is recommended that a password be set on the VNC server
-to provide authentication of the client when this is used. The path following
-this option specifies where the x509 certificates are to be loaded from.
-See the @ref{vnc_security} section for details on generating certificates.
-
address@hidden address@hidden/path/to/certificate/dir}
-
-Valid if @option{tls} is specified. Require that x509 credentials are used
-for negotiating the TLS session. The server will send its x509 certificate
-to the client, and request that the client send its own x509 certificate.
-The server will validate the client's certificate against the CA certificate,
-and reject clients when validation fails. If the certificate authority is
-trusted, this is a sufficient authentication mechanism. You may still wish
-to set a password on the VNC server as a second authentication layer. The
-path following this option specifies where the x509 certificates are to
-be loaded from. See the @ref{vnc_security} section for details on generating
-certificates.
-
address@hidden sasl
-
-Require that the client use SASL to authenticate with the VNC server.
-The exact choice of authentication method used is controlled from the
-system / user's SASL configuration file for the 'qemu' service. This
-is typically found in /etc/sasl2/qemu.conf. If running QEMU as an
-unprivileged user, an environment variable SASL_CONF_PATH can be used
-to make it search alternate locations for the service config.
-While some SASL auth methods can also provide data encryption (eg GSSAPI),
-it is recommended that SASL always be combined with the 'tls' and
-'x509' settings to enable use of SSL and server certificates. This
-ensures a data encryption preventing compromise of authentication
-credentials. See the @ref{vnc_security} section for details on using
-SASL authentication.
-
address@hidden acl
-
-Turn on access control lists for checking of the x509 client certificate
-and SASL party. For x509 certs, the ACL check is made against the
-certificate's distinguished name. This is something that looks like
address@hidden,O=ACME,L=Boston,CN=bob}. For SASL party, the ACL check is
-made against the username, which depending on the SASL plugin, may
-include a realm component, eg @code{bob} or @code{bob@@EXAMPLE.COM}.
-When the @option{acl} flag is set, the initial access list will be
-empty, with a @code{deny} policy. Thus no one will be allowed to
-use the VNC server until the ACLs have been loaded. This can be
-achieved using the @code{acl} monitor command.
-
address@hidden table
-
address@hidden table
-
-Network options:
-
address@hidden @option
-
address@hidden -net
nic[,address@hidden,address@hidden,address@hidden,address@hidden
-Create a new Network Interface Card and connect it to VLAN @var{n} (@var{n}
-= 0 is the default). The NIC is an ne2k_pci by default on the PC
-target. Optionally, the MAC address can be changed to @var{addr}
-and a @var{name} can be assigned for use in monitor commands. If no
address@hidden option is specified, a single NIC is created.
-Qemu can emulate several different models of network card.
-Valid values for @var{type} are
address@hidden, @code{i82557b}, @code{i82559er},
address@hidden, @code{ne2k_isa}, @code{pcnet}, @code{rtl8139},
address@hidden, @code{smc91c111}, @code{lance} and @code{mcf_fec}.
-Not all devices are supported on all targets. Use -net nic,model=?
-for a list of available devices for your target.
-
address@hidden -net user[,address@hidden,address@hidden,address@hidden
-Use the user mode network stack which requires no administrator
-privilege to run. @option{hostname=name} can be used to specify the client
-hostname reported by the builtin DHCP server.
-
address@hidden -net channel,@var{port}:@var{dev}
-Forward @option{user} TCP connection to port @var{port} to character device
@var{dev}
-
address@hidden -net
tap[,address@hidden,address@hidden,address@hidden,address@hidden,address@hidden,address@hidden
-Connect the host TAP network interface @var{name} to VLAN @var{n}, use
-the network script @var{file} to configure it and the network script
address@hidden to deconfigure it. If @var{name} is not provided, the OS
-automatically provides one. @address@hidden can be used to specify
-the handle of an already opened host TAP interface. The default network
-configure script is @file{/etc/qemu-ifup} and the default network
-deconfigure script is @file{/etc/qemu-ifdown}. Use @option{script=no}
-or @option{downscript=no} to disable script execution. Example:
-
address@hidden
-qemu linux.img -net nic -net tap
address@hidden example
-
-More complicated example (two NICs, each one connected to a TAP device)
address@hidden
-qemu linux.img -net nic,vlan=0 -net tap,vlan=0,ifname=tap0 \
- -net nic,vlan=1 -net tap,vlan=1,ifname=tap1
address@hidden example
-
-
address@hidden -net
socket[,address@hidden,address@hidden,address@hidden,address@hidden:@var{port}][,address@hidden:@var{port}]
-
-Connect the VLAN @var{n} to a remote VLAN in another QEMU virtual
-machine using a TCP socket connection. If @option{listen} is
-specified, QEMU waits for incoming connections on @var{port}
-(@var{host} is optional). @option{connect} is used to connect to
-another QEMU instance using the @option{listen} option. @address@hidden
-specifies an already opened TCP socket.
-
-Example:
address@hidden
-# launch a first QEMU instance
-qemu linux.img -net nic,macaddr=52:54:00:12:34:56 \
- -net socket,listen=:1234
-# connect the VLAN 0 of this instance to the VLAN 0
-# of the first instance
-qemu linux.img -net nic,macaddr=52:54:00:12:34:57 \
- -net socket,connect=127.0.0.1:1234
address@hidden example
-
address@hidden -net
socket[,address@hidden,address@hidden,address@hidden,address@hidden:@var{port}]
-
-Create a VLAN @var{n} shared with another QEMU virtual
-machines using a UDP multicast socket, effectively making a bus for
-every QEMU with same multicast address @var{maddr} and @var{port}.
-NOTES:
address@hidden
address@hidden
-Several QEMU can be running on different hosts and share same bus (assuming
-correct multicast setup for these hosts).
address@hidden
-mcast support is compatible with User Mode Linux (argument @address@hidden),
see
address@hidden://user-mode-linux.sf.net}.
address@hidden
-Use @option{fd=h} to specify an already opened UDP multicast socket.
address@hidden enumerate
-
-Example:
address@hidden
-# launch one QEMU instance
-qemu linux.img -net nic,macaddr=52:54:00:12:34:56 \
- -net socket,mcast=230.0.0.1:1234
-# launch another QEMU instance on same "bus"
-qemu linux.img -net nic,macaddr=52:54:00:12:34:57 \
- -net socket,mcast=230.0.0.1:1234
-# launch yet another QEMU instance on same "bus"
-qemu linux.img -net nic,macaddr=52:54:00:12:34:58 \
- -net socket,mcast=230.0.0.1:1234
address@hidden example
-
-Example (User Mode Linux compat.):
address@hidden
-# launch QEMU instance (note mcast address selected
-# is UML's default)
-qemu linux.img -net nic,macaddr=52:54:00:12:34:56 \
- -net socket,mcast=239.192.168.1:1102
-# launch UML
-/path/to/linux ubd0=/path/to/root_fs eth0=mcast
address@hidden example
-
address@hidden -net
vde[,address@hidden,address@hidden,address@hidden,address@hidden,address@hidden,address@hidden
-Connect VLAN @var{n} to PORT @var{n} of a vde switch running on host and
-listening for incoming connections on @var{socketpath}. Use GROUP
@var{groupname}
-and MODE @var{octalmode} to change default ownership and permissions for
-communication port. This option is available only if QEMU has been compiled
-with vde support enabled.
-
-Example:
address@hidden
-# launch vde switch
-vde_switch -F -sock /tmp/myswitch
-# launch QEMU instance
-qemu linux.img -net nic -net vde,sock=/tmp/myswitch
address@hidden example
-
address@hidden -net none
-Indicate that no network devices should be configured. It is used to
-override the default configuration (@option{-net nic -net user}) which
-is activated if no @option{-net} options are provided.
-
address@hidden -tftp @var{dir}
-When using the user mode network stack, activate a built-in TFTP
-server. The files in @var{dir} will be exposed as the root of a TFTP server.
-The TFTP client on the guest must be configured in binary mode (use the command
address@hidden of the Unix TFTP client). The host IP address on the guest is as
-usual 10.0.2.2.
-
address@hidden -bootp @var{file}
-When using the user mode network stack, broadcast @var{file} as the BOOTP
-filename. In conjunction with @option{-tftp}, this can be used to network boot
-a guest from a local directory.
-
-Example (using pxelinux):
address@hidden
-qemu -hda linux.img -boot n -tftp /path/to/tftp/files -bootp /pxelinux.0
address@hidden example
-
address@hidden -smb @var{dir}
-When using the user mode network stack, activate a built-in SMB
-server so that Windows OSes can access to the host files in @address@hidden
-transparently.
-
-In the guest Windows OS, the line:
address@hidden
-10.0.2.4 smbserver
address@hidden example
-must be added in the file @file{C:\WINDOWS\LMHOSTS} (for windows 9x/Me)
-or @file{C:\WINNT\SYSTEM32\DRIVERS\ETC\LMHOSTS} (Windows NT/2000).
-
-Then @address@hidden can be accessed in @file{\\smbserver\qemu}.
-
-Note that a SAMBA server must be installed on the host OS in
address@hidden/usr/sbin/smbd}. QEMU was tested successfully with smbd version
-2.2.7a from the Red Hat 9 and version 3.0.10-1.fc3 from Fedora Core 3.
-
address@hidden -redir [tcp|udp]:@var{host-port}:address@hidden:@var{guest-port}
-
-When using the user mode network stack, redirect incoming TCP or UDP
-connections to the host port @var{host-port} to the guest
address@hidden on guest port @var{guest-port}. If @var{guest-host}
-is not specified, its value is 10.0.2.15 (default address given by the
-built-in DHCP server).
-
-For example, to redirect host X11 connection from screen 1 to guest
-screen 0, use the following:
-
address@hidden
-# on the host
-qemu -redir tcp:6001::6000 [...]
-# this host xterm should open in the guest X11 server
-xterm -display :1
address@hidden example
-
-To redirect telnet connections from host port 5555 to telnet port on
-the guest, use the following:
-
address@hidden
-# on the host
-qemu -redir tcp:5555::23 [...]
-telnet localhost 5555
address@hidden example
-
-Then when you use on the host @code{telnet localhost 5555}, you
-connect to the guest telnet server.
-
address@hidden table
-
-Bluetooth(R) options:
address@hidden @option
-
address@hidden -bt hci[...]
-Defines the function of the corresponding Bluetooth HCI. -bt options
-are matched with the HCIs present in the chosen machine type. For
-example when emulating a machine with only one HCI built into it, only
-the first @code{-bt hci[...]} option is valid and defines the HCI's
-logic. The Transport Layer is decided by the machine type. Currently
-the machines @code{n800} and @code{n810} have one HCI and all other
-machines have none.
-
address@hidden
-The following three types are recognized:
-
address@hidden @code
address@hidden -bt hci,null
-(default) The corresponding Bluetooth HCI assumes no internal logic
-and will not respond to any HCI commands or emit events.
-
address@hidden -bt hci,host[:@var{id}]
-(@code{bluez} only) The corresponding HCI passes commands / events
-to / from the physical HCI identified by the name @var{id} (default:
address@hidden) on the computer running QEMU. Only available on @code{bluez}
-capable systems like Linux.
-
address@hidden -bt hci[,address@hidden
-Add a virtual, standard HCI that will participate in the Bluetooth
-scatternet @var{n} (default @code{0}). Similarly to @option{-net}
-VLANs, devices inside a bluetooth network @var{n} can only communicate
-with other devices in the same network (scatternet).
address@hidden table
-
address@hidden -bt vhci[,address@hidden
-(Linux-host only) Create a HCI in scatternet @var{n} (default 0) attached
-to the host bluetooth stack instead of to the emulated target. This
-allows the host and target machines to participate in a common scatternet
-and communicate. Requires the Linux @code{vhci} driver installed. Can
-be used as following:
-
address@hidden
-qemu [...OPTIONS...] -bt hci,vlan=5 -bt vhci,vlan=5
address@hidden example
-
address@hidden -bt device:@var{dev}[,address@hidden
-Emulate a bluetooth device @var{dev} and place it in network @var{n}
-(default @code{0}). QEMU can only emulate one type of bluetooth devices
-currently:
-
address@hidden @code
address@hidden keyboard
-Virtual wireless keyboard implementing the HIDP bluetooth profile.
address@hidden table
-
address@hidden table
-
-i386 target only:
-
address@hidden @option
-
address@hidden -win2k-hack
-Use it when installing Windows 2000 to avoid a disk full bug. After
-Windows 2000 is installed, you no longer need this option (this option
-slows down the IDE transfers).
-
address@hidden -rtc-td-hack
-Use it if you experience time drift problem in Windows with ACPI HAL.
-This option will try to figure out how many timer interrupts were not
-processed by the Windows guest and will re-inject them.
-
address@hidden -no-fd-bootchk
-Disable boot signature checking for floppy disks in Bochs BIOS. It may
-be needed to boot from old floppy disks.
-
address@hidden -no-acpi
-Disable ACPI (Advanced Configuration and Power Interface) support. Use
-it if your guest OS complains about ACPI problems (PC target machine
-only).
-
address@hidden -no-hpet
-Disable HPET support.
-
address@hidden -acpitable
address@hidden,address@hidden,address@hidden,address@hidden,address@hidden
[,address@hidden,address@hidden,address@hidden:@var{file2}]...]
-Add ACPI table with specified header fields and context from specified files.
-
address@hidden table
-
-Linux boot specific: When using these options, you can use a given
-Linux kernel without installing it in the disk image. It can be useful
-for easier testing of various kernels.
-
address@hidden @option
-
address@hidden -kernel @var{bzImage}
-Use @var{bzImage} as kernel image.
-
address@hidden -append @var{cmdline}
-Use @var{cmdline} as kernel command line
-
address@hidden -initrd @var{file}
-Use @var{file} as initial ram disk.
-
address@hidden table
-
-Debug/Expert options:
address@hidden @option
-
address@hidden -serial @var{dev}
-Redirect the virtual serial port to host character device
address@hidden The default device is @code{vc} in graphical mode and
address@hidden in non graphical mode.
-
-This option can be used several times to simulate up to 4 serial
-ports.
-
-Use @code{-serial none} to disable all serial ports.
-
-Available character devices are:
address@hidden @code
address@hidden vc[:WxH]
-Virtual console. Optionally, a width and height can be given in pixel with
address@hidden
-vc:800x600
address@hidden example
-It is also possible to specify width or height in characters:
address@hidden
-vc:80Cx24C
address@hidden example
address@hidden pty
-[Linux only] Pseudo TTY (a new PTY is automatically allocated)
address@hidden none
-No device is allocated.
address@hidden null
-void device
address@hidden /dev/XXX
-[Linux only] Use host tty, e.g. @file{/dev/ttyS0}. The host serial port
-parameters are set according to the emulated ones.
address@hidden /dev/address@hidden
-[Linux only, parallel port only] Use host parallel port
address@hidden Currently SPP and EPP parallel port features can be used.
address@hidden file:@var{filename}
-Write output to @var{filename}. No character can be read.
address@hidden stdio
-[Unix only] standard input/output
address@hidden pipe:@var{filename}
-name pipe @var{filename}
address@hidden address@hidden
-[Windows only] Use host serial port @var{n}
address@hidden
udp:address@hidden:@var{remote_port}[@@address@hidden:@var{src_port}]
-This implements UDP Net Console.
-When @var{remote_host} or @var{src_ip} are not specified
-they default to @code{0.0.0.0}.
-When not using a specified @var{src_port} a random port is automatically
chosen.
address@hidden msmouse
-Three button serial mouse. Configure the guest to use Microsoft protocol.
-
-If you just want a simple readonly console you can use @code{netcat} or
address@hidden, by starting qemu with: @code{-serial udp::4555} and nc as:
address@hidden -u -l -p 4555}. Any time qemu writes something to that port it
-will appear in the netconsole session.
-
-If you plan to send characters back via netconsole or you want to stop
-and start qemu a lot of times, you should have qemu use the same
-source port each time by using something like @code{-serial
-udp::4555@@:4556} to qemu. Another approach is to use a patched
-version of netcat which can listen to a TCP port and send and receive
-characters via udp. If you have a patched version of netcat which
-activates telnet remote echo and single char transfer, then you can
-use the following options to step up a netcat redirector to allow
-telnet on port 5555 to access the qemu port.
address@hidden @code
address@hidden Qemu Options:
--serial udp::4555@@:4556
address@hidden netcat options:
--u -P 4555 -L 0.0.0.0:4556 -t -p 5555 -I -T
address@hidden telnet options:
-localhost 5555
address@hidden table
-
-
address@hidden tcp:address@hidden:@var{port}[,@var{server}][,nowait][,nodelay]
-The TCP Net Console has two modes of operation. It can send the serial
-I/O to a location or wait for a connection from a location. By default
-the TCP Net Console is sent to @var{host} at the @var{port}. If you use
-the @var{server} option QEMU will wait for a client socket application
-to connect to the port before continuing, unless the @code{nowait}
-option was specified. The @code{nodelay} option disables the Nagle buffering
-algorithm. If @var{host} is omitted, 0.0.0.0 is assumed. Only
-one TCP connection at a time is accepted. You can use @code{telnet} to
-connect to the corresponding character device.
address@hidden @code
address@hidden Example to send tcp console to 192.168.0.2 port 4444
--serial tcp:192.168.0.2:4444
address@hidden Example to listen and wait on port 4444 for connection
--serial tcp::4444,server
address@hidden Example to not wait and listen on ip 192.168.0.100 port 4444
--serial tcp:192.168.0.100:4444,server,nowait
address@hidden table
-
address@hidden telnet:@var{host}:@var{port}[,server][,nowait][,nodelay]
-The telnet protocol is used instead of raw tcp sockets. The options
-work the same as if you had specified @code{-serial tcp}. The
-difference is that the port acts like a telnet server or client using
-telnet option negotiation. This will also allow you to send the
-MAGIC_SYSRQ sequence if you use a telnet that supports sending the break
-sequence. Typically in unix telnet you do it with Control-] and then
-type "send break" followed by pressing the enter key.
-
address@hidden unix:@var{path}[,server][,nowait]
-A unix domain socket is used instead of a tcp socket. The option works the
-same as if you had specified @code{-serial tcp} except the unix domain socket
address@hidden is used for connections.
-
address@hidden mon:@var{dev_string}
-This is a special option to allow the monitor to be multiplexed onto
-another serial port. The monitor is accessed with key sequence of
address@hidden and then pressing @key{c}. See monitor access
address@hidden in the -nographic section for more keys.
address@hidden should be any one of the serial devices specified
-above. An example to multiplex the monitor onto a telnet server
-listening on port 4444 would be:
address@hidden @code
address@hidden -serial mon:telnet::4444,server,nowait
address@hidden table
-
address@hidden braille
-Braille device. This will use BrlAPI to display the braille output on a real
-or fake device.
-
address@hidden table
-
address@hidden -parallel @var{dev}
-Redirect the virtual parallel port to host device @var{dev} (same
-devices as the serial port). On Linux hosts, @file{/dev/parportN} can
-be used to use hardware devices connected on the corresponding host
-parallel port.
-
-This option can be used several times to simulate up to 3 parallel
-ports.
-
-Use @code{-parallel none} to disable all parallel ports.
-
address@hidden -monitor @var{dev}
-Redirect the monitor to host device @var{dev} (same devices as the
-serial port).
-The default device is @code{vc} in graphical mode and @code{stdio} in
-non graphical mode.
-
address@hidden -pidfile @var{file}
-Store the QEMU process PID in @var{file}. It is useful if you launch QEMU
-from a script.
-
address@hidden -S
-Do not start CPU at startup (you must type 'c' in the monitor).
-
address@hidden -s
-Wait gdb connection to port 1234 (@pxref{gdb_usage}).
-
address@hidden -p @var{port}
-Change gdb connection port. @var{port} can be either a decimal number
-to specify a TCP port, or a host device (same devices as the serial port).
-
address@hidden -d
-Output log in /tmp/qemu.log
address@hidden -hdachs @var{c},@var{h},@var{s},[,@var{t}]
-Force hard disk 0 physical geometry (1 <= @var{c} <= 16383, 1 <=
address@hidden <= 16, 1 <= @var{s} <= 63) and optionally force the BIOS
-translation mode (@var{t}=none, lba or auto). Usually QEMU can guess
-all those parameters. This option is useful for old MS-DOS disk
-images.
-
address@hidden -L @var{path}
-Set the directory for the BIOS, VGA BIOS and keymaps.
-
address@hidden -bios @var{file}
-Set the filename for the BIOS.
-
address@hidden -kernel-kqemu
-Enable KQEMU full virtualization (default is user mode only).
-
address@hidden -no-kqemu
-Disable KQEMU kernel module usage. KQEMU options are only available if
-KQEMU support is enabled when compiling.
-
address@hidden -enable-kvm
-Enable KVM full virtualization support. This option is only available
-if KVM support is enabled when compiling.
-
address@hidden -no-reboot
-Exit instead of rebooting.
-
address@hidden -no-shutdown
-Don't exit QEMU on guest shutdown, but instead only stop the emulation.
-This allows for instance switching to monitor to commit changes to the
-disk image.
-
address@hidden -loadvm @var{file}
-Start right away with a saved state (@code{loadvm} in monitor)
-
address@hidden -daemonize
-Daemonize the QEMU process after initialization. QEMU will not detach from
-standard IO until it is ready to receive connections on any of its devices.
-This option is a useful way for external programs to launch QEMU without having
-to cope with initialization race conditions.
-
address@hidden -option-rom @var{file}
-Load the contents of @var{file} as an option ROM.
-This option is useful to load things like EtherBoot.
-
address@hidden -clock @var{method}
-Force the use of the given methods for timer alarm. To see what timers
-are available use -clock ?.
-
address@hidden -localtime
-Set the real time clock to local time (the default is to UTC
-time). This option is needed to have correct date in MS-DOS or
-Windows.
-
address@hidden -startdate @var{date}
-Set the initial date of the real time clock. Valid formats for
address@hidden are: @code{now} or @code{2006-06-17T16:01:21} or
address@hidden The default value is @code{now}.
-
address@hidden -icount [N|auto]
-Enable virtual instruction counter. The virtual cpu will execute one
-instruction every 2^N ns of virtual time. If @code{auto} is specified
-then the virtual cpu speed will be automatically adjusted to keep virtual
-time within a few seconds of real time.
-
-Note that while this option can give deterministic behavior, it does not
-provide cycle accurate emulation. Modern CPUs contain superscalar out of
-order cores with complex cache hierarchies. The number of instructions
-executed often has little or no correlation with actual performance.
-
address@hidden -echr numeric_ascii_value
-Change the escape character used for switching to the monitor when using
-monitor and serial sharing. The default is @code{0x01} when using the
address@hidden option. @code{0x01} is equal to pressing
address@hidden You can select a different character from the ascii
-control keys where 1 through 26 map to Control-a through Control-z. For
-instance you could use the either of the following to change the escape
-character to Control-t.
address@hidden @code
address@hidden -echr 0x14
address@hidden -echr 20
address@hidden table
-
address@hidden -chroot dir
-Immediately before starting guest execution, chroot to the specified
-directory. Especially useful in combination with -runas.
-
address@hidden -runas user
-Immediately before starting guest execution, drop root privileges, switching
-to the specified user.
-
address@hidden table
-
@c man end
@node pcsys_keys
Added: trunk/qemu-options.hx
===================================================================
--- trunk/qemu-options.hx (rev 0)
+++ trunk/qemu-options.hx 2009-03-28 06:44:27 UTC (rev 6884)
@@ -0,0 +1,1462 @@
+HXCOMM Use DEFHEADING() to define headings in both help text and texi
+HXCOMM Text between STEXI and ETEXI are copied to texi version and
+HXCOMM discarded from C version
+HXCOMM DEF(option, HAS_ARG/0, opt_enum, opt_help) is used to construct
+HXCOMM option structures, enums and help message.
+HXCOMM HXCOMM can be used for comments, discarded from both texi and C
+
+DEFHEADING(Standard options:)
+STEXI
address@hidden @option
+ETEXI
+
+DEF("help", 0, QEMU_OPTION_h,
+ "-h or -help display this help and exit\n")
+STEXI
address@hidden -h
+Display help and exit
+ETEXI
+
+DEF("M", HAS_ARG, QEMU_OPTION_M,
+ "-M machine select emulated machine (-M ? for list)\n")
+STEXI
address@hidden -M @var{machine}
+Select the emulated @var{machine} (@code{-M ?} for list)
+ETEXI
+
+DEF("cpu", HAS_ARG, QEMU_OPTION_cpu,
+ "-cpu cpu select CPU (-cpu ? for list)\n")
+STEXI
address@hidden -cpu @var{model}
+Select CPU model (-cpu ? for list and additional feature selection)
+ETEXI
+
+DEF("smp", HAS_ARG, QEMU_OPTION_smp,
+ "-smp n set the number of CPUs to 'n' [default=1]\n")
+STEXI
address@hidden -smp @var{n}
+Simulate an SMP system with @var{n} CPUs. On the PC target, up to 255
+CPUs are supported. On Sparc32 target, Linux limits the number of usable CPUs
+to 4.
+ETEXI
+
+DEF("fda", HAS_ARG, QEMU_OPTION_fda,
+ "-fda/-fdb file use 'file' as floppy disk 0/1 image\n")
+DEF("fdb", HAS_ARG, QEMU_OPTION_fdb, "")
+STEXI
address@hidden -fda @var{file}
address@hidden -fdb @var{file}
+Use @var{file} as floppy disk 0/1 image (@pxref{disk_images}). You can
+use the host floppy by using @file{/dev/fd0} as filename (@pxref{host_drives}).
+ETEXI
+
+DEF("hda", HAS_ARG, QEMU_OPTION_hda,
+ "-hda/-hdb file use 'file' as IDE hard disk 0/1 image\n")
+DEF("hdb", HAS_ARG, QEMU_OPTION_hdb, "")
+DEF("hdc", HAS_ARG, QEMU_OPTION_hdc,
+ "-hdc/-hdd file use 'file' as IDE hard disk 2/3 image\n")
+DEF("hdd", HAS_ARG, QEMU_OPTION_hdd, "")
+STEXI
address@hidden -hda @var{file}
address@hidden -hdb @var{file}
address@hidden -hdc @var{file}
address@hidden -hdd @var{file}
+Use @var{file} as hard disk 0, 1, 2 or 3 image (@pxref{disk_images}).
+ETEXI
+
+DEF("cdrom", HAS_ARG, QEMU_OPTION_cdrom,
+ "-cdrom file use 'file' as IDE cdrom image (cdrom is ide1 master)\n")
+STEXI
address@hidden -cdrom @var{file}
+Use @var{file} as CD-ROM image (you cannot use @option{-hdc} and
address@hidden at the same time). You can use the host CD-ROM by
+using @file{/dev/cdrom} as filename (@pxref{host_drives}).
+ETEXI
+
+DEF("drive", HAS_ARG, QEMU_OPTION_drive,
+ "-drive [file=file][,if=type][,bus=n][,unit=m][,media=d][,index=i]\n"
+ " [,cyls=c,heads=h,secs=s[,trans=t]][,snapshot=on|off]\n"
+ " [,cache=writethrough|writeback|none][,format=f][,serial=s]\n"
+ " use 'file' as a drive image\n")
+STEXI
address@hidden -drive @var{option}[,@var{option}[,@var{option}[,...]]]
+
+Define a new drive. Valid options are:
+
address@hidden @code
address@hidden address@hidden
+This option defines which disk image (@pxref{disk_images}) to use with
+this drive. If the filename contains comma, you must double it
+(for instance, "file=my,,file" to use file "my,file").
address@hidden address@hidden
+This option defines on which type on interface the drive is connected.
+Available types are: ide, scsi, sd, mtd, floppy, pflash, virtio.
address@hidden address@hidden,address@hidden
+These options define where is connected the drive by defining the bus number
and
+the unit id.
address@hidden address@hidden
+This option defines where is connected the drive by using an index in the list
+of available connectors of a given interface type.
address@hidden address@hidden
+This option defines the type of the media: disk or cdrom.
address@hidden address@hidden,address@hidden,address@hidden,address@hidden
+These options have the same definition as they have in @option{-hdachs}.
address@hidden address@hidden
address@hidden is "on" or "off" and allows to enable snapshot for given drive
(see @option{-snapshot}).
address@hidden address@hidden
address@hidden is "none", "writeback", or "writethrough" and controls how the
host cache is used to access block data.
address@hidden address@hidden
+Specify which disk @var{format} will be used rather than detecting
+the format. Can be used to specifiy format=raw to avoid interpreting
+an untrusted format header.
address@hidden address@hidden
+This option specifies the serial number to assign to the device.
address@hidden table
+
+By default, writethrough caching is used for all block device. This means that
+the host page cache will be used to read and write data but write notification
+will be sent to the guest only when the data has been reported as written by
+the storage subsystem.
+
+Writeback caching will report data writes as completed as soon as the data is
+present in the host page cache. This is safe as long as you trust your host.
+If your host crashes or loses power, then the guest may experience data
+corruption. When using the @option{-snapshot} option, writeback caching is
+used by default.
+
+The host page can be avoided entirely with @option{cache=none}. This will
+attempt to do disk IO directly to the guests memory. QEMU may still perform
+an internal copy of the data.
+
+Some block drivers perform badly with @option{cache=writethrough}, most
notably,
+qcow2. If performance is more important than correctness,
address@hidden should be used with qcow2. By default, if no explicit
+caching is specified for a qcow2 disk image, @option{cache=writeback} will be
+used. For all other disk types, @option{cache=writethrough} is the default.
+
+Instead of @option{-cdrom} you can use:
address@hidden
+qemu -drive file=file,index=2,media=cdrom
address@hidden example
+
+Instead of @option{-hda}, @option{-hdb}, @option{-hdc}, @option{-hdd}, you can
+use:
address@hidden
+qemu -drive file=file,index=0,media=disk
+qemu -drive file=file,index=1,media=disk
+qemu -drive file=file,index=2,media=disk
+qemu -drive file=file,index=3,media=disk
address@hidden example
+
+You can connect a CDROM to the slave of ide0:
address@hidden
+qemu -drive file=file,if=ide,index=1,media=cdrom
address@hidden example
+
+If you don't specify the "file=" argument, you define an empty drive:
address@hidden
+qemu -drive if=ide,index=1,media=cdrom
address@hidden example
+
+You can connect a SCSI disk with unit ID 6 on the bus #0:
address@hidden
+qemu -drive file=file,if=scsi,bus=0,unit=6
address@hidden example
+
+Instead of @option{-fda}, @option{-fdb}, you can use:
address@hidden
+qemu -drive file=file,index=0,if=floppy
+qemu -drive file=file,index=1,if=floppy
address@hidden example
+
+By default, @var{interface} is "ide" and @var{index} is automatically
+incremented:
address@hidden
+qemu -drive file=a -drive file=b"
address@hidden example
+is interpreted like:
address@hidden
+qemu -hda a -hdb b
address@hidden example
+ETEXI
+
+DEF("mtdblock", HAS_ARG, QEMU_OPTION_mtdblock,
+ "-mtdblock file use 'file' as on-board Flash memory image\n")
+STEXI
+
address@hidden -mtdblock file
+Use 'file' as on-board Flash memory image.
+ETEXI
+
+DEF("sd", HAS_ARG, QEMU_OPTION_sd,
+ "-sd file use 'file' as SecureDigital card image\n")
+STEXI
address@hidden -sd file
+Use 'file' as SecureDigital card image.
+ETEXI
+
+DEF("pflash", HAS_ARG, QEMU_OPTION_pflash,
+ "-pflash file use 'file' as a parallel flash image\n")
+STEXI
address@hidden -pflash file
+Use 'file' as a parallel flash image.
+ETEXI
+
+DEF("boot", HAS_ARG, QEMU_OPTION_boot,
+ "-boot [a|c|d|n] boot on floppy (a), hard disk (c), CD-ROM (d), or network
(n)\n")
+STEXI
address@hidden -boot [a|c|d|n]
+Boot on floppy (a), hard disk (c), CD-ROM (d), or Etherboot (n). Hard disk boot
+is the default.
+ETEXI
+
+DEF("snapshot", 0, QEMU_OPTION_snapshot,
+ "-snapshot write to temporary files instead of disk image files\n")
+STEXI
address@hidden -snapshot
+Write to temporary files instead of disk image files. In this case,
+the raw disk image you use is not written back. You can however force
+the write back by pressing @key{C-a s} (@pxref{disk_images}).
+ETEXI
+
+DEF("m", HAS_ARG, QEMU_OPTION_m,
+ "-m megs set virtual RAM size to megs MB [default=%d]\n")
+STEXI
address@hidden -m @var{megs}
+Set virtual RAM size to @var{megs} megabytes. Default is 128 MiB. Optionally,
+a suffix of ``M'' or ``G'' can be used to signify a value in megabytes or
+gigabytes respectively.
+ETEXI
+
+#ifndef _WIN32
+DEF("k", HAS_ARG, QEMU_OPTION_k,
+ "-k language use keyboard layout (for example \"fr\" for French)\n")
+#endif
+STEXI
address@hidden -k @var{language}
+
+Use keyboard layout @var{language} (for example @code{fr} for
+French). This option is only needed where it is not easy to get raw PC
+keycodes (e.g. on Macs, with some X11 servers or with a VNC
+display). You don't normally need to use it on PC/Linux or PC/Windows
+hosts.
+
+The available layouts are:
address@hidden
+ar de-ch es fo fr-ca hu ja mk no pt-br sv
+da en-gb et fr fr-ch is lt nl pl ru th
+de en-us fi fr-be hr it lv nl-be pt sl tr
address@hidden example
+
+The default is @code{en-us}.
+ETEXI
+
+
+#ifdef HAS_AUDIO
+DEF("audio-help", 0, QEMU_OPTION_audio_help,
+ "-audio-help print list of audio drivers and their options\n")
+#endif
+STEXI
address@hidden -audio-help
+
+Will show the audio subsystem help: list of drivers, tunable
+parameters.
+ETEXI
+
+#ifdef HAS_AUDIO
+DEF("soundhw", HAS_ARG, QEMU_OPTION_soundhw,
+ "-soundhw c1,... enable audio support\n"
+ " and only specified sound cards (comma separated list)\n"
+ " use -soundhw ? to get the list of supported cards\n"
+ " use -soundhw all to enable all of them\n")
+#endif
+STEXI
address@hidden -soundhw @var{card1}[,@var{card2},...] or -soundhw all
+
+Enable audio and selected sound hardware. Use ? to print all
+available sound hardware.
+
address@hidden
+qemu -soundhw sb16,adlib disk.img
+qemu -soundhw es1370 disk.img
+qemu -soundhw ac97 disk.img
+qemu -soundhw all disk.img
+qemu -soundhw ?
address@hidden example
+
+Note that Linux's i810_audio OSS kernel (for AC97) module might
+require manually specifying clocking.
+
address@hidden
+modprobe i810_audio clocking=48000
address@hidden example
+ETEXI
+
+STEXI
address@hidden table
+ETEXI
+
+DEF("usb", 0, QEMU_OPTION_usb,
+ "-usb enable the USB driver (will be the default soon)\n")
+STEXI
+USB options:
address@hidden @option
+
address@hidden -usb
+Enable the USB driver (will be the default soon)
+ETEXI
+
+DEF("usbdevice", HAS_ARG, QEMU_OPTION_usbdevice,
+ "-usbdevice name add the host or guest USB device 'name'\n")
+STEXI
+
address@hidden -usbdevice @var{devname}
+Add the USB device @var{devname}. @xref{usb_devices}.
+
address@hidden @code
+
address@hidden mouse
+Virtual Mouse. This will override the PS/2 mouse emulation when activated.
+
address@hidden tablet
+Pointer device that uses absolute coordinates (like a touchscreen). This
+means qemu is able to report the mouse position without having to grab the
+mouse. Also overrides the PS/2 mouse emulation when activated.
+
address@hidden disk:address@hidden:file
+Mass storage device based on file. The optional @var{format} argument
+will be used rather than detecting the format. Can be used to specifiy
+format=raw to avoid interpreting an untrusted format header.
+
address@hidden host:bus.addr
+Pass through the host device identified by bus.addr (Linux only).
+
address@hidden host:vendor_id:product_id
+Pass through the host device identified by vendor_id:product_id (Linux only).
+
address@hidden serial:address@hidden,address@hidden:@var{dev}
+Serial converter to host character device @var{dev}, see @code{-serial} for the
+available devices.
+
address@hidden braille
+Braille device. This will use BrlAPI to display the braille output on a real
+or fake device.
+
address@hidden net:options
+Network adapter that supports CDC ethernet and RNDIS protocols.
+
address@hidden table
+ETEXI
+
+DEF("name", HAS_ARG, QEMU_OPTION_name,
+ "-name string set the name of the guest\n")
+STEXI
address@hidden -name @var{name}
+Sets the @var{name} of the guest.
+This name will be displayed in the SDL window caption.
+The @var{name} will also be used for the VNC server.
+ETEXI
+
+DEF("uuid", HAS_ARG, QEMU_OPTION_uuid,
+ "-uuid %%08x-%%04x-%%04x-%%04x-%%012x\n"
+ " specify machine UUID\n")
+STEXI
address@hidden -uuid @var{uuid}
+Set system UUID.
+ETEXI
+
+STEXI
address@hidden table
+ETEXI
+
+DEFHEADING()
+
+DEFHEADING(Display options:)
+
+STEXI
address@hidden @option
+ETEXI
+
+DEF("nographic", 0, QEMU_OPTION_nographic,
+ "-nographic disable graphical output and redirect serial I/Os to
console\n")
+STEXI
address@hidden -nographic
+
+Normally, QEMU uses SDL to display the VGA output. With this option,
+you can totally disable graphical output so that QEMU is a simple
+command line application. The emulated serial port is redirected on
+the console. Therefore, you can still use QEMU to debug a Linux kernel
+with a serial console.
+ETEXI
+
+#ifdef CONFIG_CURSES
+DEF("curses", 0, QEMU_OPTION_curses,
+ "-curses use a curses/ncurses interface instead of SDL\n")
+#endif
+STEXI
address@hidden -curses
+
+Normally, QEMU uses SDL to display the VGA output. With this option,
+QEMU can display the VGA output when in text mode using a
+curses/ncurses interface. Nothing is displayed in graphical mode.
+ETEXI
+
+#ifdef CONFIG_SDL
+DEF("no-frame", 0, QEMU_OPTION_no_frame,
+ "-no-frame open SDL window without a frame and window decorations\n")
+#endif
+STEXI
address@hidden -no-frame
+
+Do not use decorations for SDL windows and start them using the whole
+available screen space. This makes the using QEMU in a dedicated desktop
+workspace more convenient.
+ETEXI
+
+#ifdef CONFIG_SDL
+DEF("alt-grab", 0, QEMU_OPTION_alt_grab,
+ "-alt-grab use Ctrl-Alt-Shift to grab mouse (instead of Ctrl-Alt)\n")
+#endif
+STEXI
address@hidden -alt-grab
+
+Use Ctrl-Alt-Shift to grab mouse (instead of Ctrl-Alt).
+ETEXI
+
+#ifdef CONFIG_SDL
+DEF("no-quit", 0, QEMU_OPTION_no_quit,
+ "-no-quit disable SDL window close capability\n")
+#endif
+STEXI
address@hidden -no-quit
+
+Disable SDL window close capability.
+ETEXI
+
+#ifdef CONFIG_SDL
+DEF("sdl", 0, QEMU_OPTION_sdl,
+ "-sdl enable SDL\n")
+#endif
+STEXI
address@hidden -sdl
+
+Enable SDL.
+ETEXI
+
+DEF("portrait", 0, QEMU_OPTION_portrait,
+ "-portrait rotate graphical output 90 deg left (only PXA LCD)\n")
+STEXI
address@hidden -portrait
+
+Rotate graphical output 90 deg left (only PXA LCD).
+ETEXI
+
+DEF("vga", HAS_ARG, QEMU_OPTION_vga,
+ "-vga [std|cirrus|vmware|none]\n"
+ " select video card type\n")
+STEXI
address@hidden -vga @var{type}
+Select type of VGA card to emulate. Valid values for @var{type} are
address@hidden @code
address@hidden cirrus
+Cirrus Logic GD5446 Video card. All Windows versions starting from
+Windows 95 should recognize and use this graphic card. For optimal
+performances, use 16 bit color depth in the guest and the host OS.
+(This one is the default)
address@hidden std
+Standard VGA card with Bochs VBE extensions. If your guest OS
+supports the VESA 2.0 VBE extensions (e.g. Windows XP) and if you want
+to use high resolution modes (>= 1280x1024x16) then you should use
+this option.
address@hidden vmware
+VMWare SVGA-II compatible adapter. Use it if you have sufficiently
+recent XFree86/XOrg server or Windows guest with a driver for this
+card.
address@hidden none
+Disable VGA card.
address@hidden table
+ETEXI
+
+DEF("full-screen", 0, QEMU_OPTION_full_screen,
+ "-full-screen start in full screen\n")
+STEXI
address@hidden -full-screen
+Start in full screen.
+ETEXI
+
+#if defined(TARGET_PPC) || defined(TARGET_SPARC)
+DEF("g", 1, QEMU_OPTION_g ,
+ "-g WxH[xDEPTH] Set the initial graphical resolution and depth\n")
+#endif
+STEXI
+ETEXI
+
+DEF("vnc", HAS_ARG, QEMU_OPTION_vnc ,
+ "-vnc display start a VNC server on display\n")
+STEXI
address@hidden -vnc @var{display}[,@var{option}[,@var{option}[,...]]]
+
+Normally, QEMU uses SDL to display the VGA output. With this option,
+you can have QEMU listen on VNC display @var{display} and redirect the VGA
+display over the VNC session. It is very useful to enable the usb
+tablet device when using this option (option @option{-usbdevice
+tablet}). When using the VNC display, you must use the @option{-k}
+parameter to set the keyboard layout if you are not using en-us. Valid
+syntax for the @var{display} is
+
address@hidden @code
+
address@hidden @var{host}:@var{d}
+
+TCP connections will only be allowed from @var{host} on display @var{d}.
+By convention the TCP port is address@hidden Optionally, @var{host} can
+be omitted in which case the server will accept connections from any host.
+
address@hidden @code{unix}:@var{path}
+
+Connections will be allowed over UNIX domain sockets where @var{path} is the
+location of a unix socket to listen for connections on.
+
address@hidden none
+
+VNC is initialized but not started. The monitor @code{change} command
+can be used to later start the VNC server.
+
address@hidden table
+
+Following the @var{display} value there may be one or more @var{option} flags
+separated by commas. Valid options are
+
address@hidden @code
+
address@hidden reverse
+
+Connect to a listening VNC client via a ``reverse'' connection. The
+client is specified by the @var{display}. For reverse network
+connections (@var{host}:@var{d},@code{reverse}), the @var{d} argument
+is a TCP port number, not a display number.
+
address@hidden password
+
+Require that password based authentication is used for client connections.
+The password must be set separately using the @code{change} command in the
address@hidden
+
address@hidden tls
+
+Require that client use TLS when communicating with the VNC server. This
+uses anonymous TLS credentials so is susceptible to a man-in-the-middle
+attack. It is recommended that this option be combined with either the
address@hidden or @var{x509verify} options.
+
address@hidden address@hidden/path/to/certificate/dir}
+
+Valid if @option{tls} is specified. Require that x509 credentials are used
+for negotiating the TLS session. The server will send its x509 certificate
+to the client. It is recommended that a password be set on the VNC server
+to provide authentication of the client when this is used. The path following
+this option specifies where the x509 certificates are to be loaded from.
+See the @ref{vnc_security} section for details on generating certificates.
+
address@hidden address@hidden/path/to/certificate/dir}
+
+Valid if @option{tls} is specified. Require that x509 credentials are used
+for negotiating the TLS session. The server will send its x509 certificate
+to the client, and request that the client send its own x509 certificate.
+The server will validate the client's certificate against the CA certificate,
+and reject clients when validation fails. If the certificate authority is
+trusted, this is a sufficient authentication mechanism. You may still wish
+to set a password on the VNC server as a second authentication layer. The
+path following this option specifies where the x509 certificates are to
+be loaded from. See the @ref{vnc_security} section for details on generating
+certificates.
+
address@hidden sasl
+
+Require that the client use SASL to authenticate with the VNC server.
+The exact choice of authentication method used is controlled from the
+system / user's SASL configuration file for the 'qemu' service. This
+is typically found in /etc/sasl2/qemu.conf. If running QEMU as an
+unprivileged user, an environment variable SASL_CONF_PATH can be used
+to make it search alternate locations for the service config.
+While some SASL auth methods can also provide data encryption (eg GSSAPI),
+it is recommended that SASL always be combined with the 'tls' and
+'x509' settings to enable use of SSL and server certificates. This
+ensures a data encryption preventing compromise of authentication
+credentials. See the @ref{vnc_security} section for details on using
+SASL authentication.
+
address@hidden acl
+
+Turn on access control lists for checking of the x509 client certificate
+and SASL party. For x509 certs, the ACL check is made against the
+certificate's distinguished name. This is something that looks like
address@hidden,O=ACME,L=Boston,CN=bob}. For SASL party, the ACL check is
+made against the username, which depending on the SASL plugin, may
+include a realm component, eg @code{bob} or @code{bob@@EXAMPLE.COM}.
+When the @option{acl} flag is set, the initial access list will be
+empty, with a @code{deny} policy. Thus no one will be allowed to
+use the VNC server until the ACLs have been loaded. This can be
+achieved using the @code{acl} monitor command.
+
address@hidden table
+ETEXI
+
+STEXI
address@hidden table
+ETEXI
+
+DEFHEADING()
+
+#ifdef TARGET_I386
+DEFHEADING(i386 target only:)
+#endif
+STEXI
address@hidden @option
+ETEXI
+
+#ifdef TARGET_I386
+DEF("win2k-hack", 0, QEMU_OPTION_win2k_hack,
+ "-win2k-hack use it when installing Windows 2000 to avoid a disk full
bug\n")
+#endif
+STEXI
address@hidden -win2k-hack
+Use it when installing Windows 2000 to avoid a disk full bug. After
+Windows 2000 is installed, you no longer need this option (this option
+slows down the IDE transfers).
+ETEXI
+
+#ifdef TARGET_I386
+DEF("rtc-td-hack", 0, QEMU_OPTION_rtc_td_hack,
+ "-rtc-td-hack use it to fix time drift in Windows ACPI HAL\n")
+#endif
+STEXI
address@hidden -rtc-td-hack
+Use it if you experience time drift problem in Windows with ACPI HAL.
+This option will try to figure out how many timer interrupts were not
+processed by the Windows guest and will re-inject them.
+ETEXI
+
+#ifdef TARGET_I386
+DEF("no-fd-bootchk", 0, QEMU_OPTION_no_fd_bootchk,
+ "-no-fd-bootchk disable boot signature checking for floppy disks\n")
+#endif
+STEXI
address@hidden -no-fd-bootchk
+Disable boot signature checking for floppy disks in Bochs BIOS. It may
+be needed to boot from old floppy disks.
+ETEXI
+
+#ifdef TARGET_I386
+DEF("no-acpi", 0, QEMU_OPTION_no_acpi,
+ "-no-acpi disable ACPI\n")
+#endif
+STEXI
address@hidden -no-acpi
+Disable ACPI (Advanced Configuration and Power Interface) support. Use
+it if your guest OS complains about ACPI problems (PC target machine
+only).
+ETEXI
+
+#ifdef TARGET_I386
+DEF("no-hpet", 0, QEMU_OPTION_no_hpet,
+ "-no-hpet disable HPET\n")
+#endif
+STEXI
address@hidden -no-hpet
+Disable HPET support.
+ETEXI
+
+#ifdef TARGET_I386
+DEF("acpitable", HAS_ARG, QEMU_OPTION_acpitable,
+ "-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"
+ " ACPI table description\n")
+#endif
+STEXI
address@hidden -acpitable
address@hidden,address@hidden,address@hidden,address@hidden,address@hidden
[,address@hidden,address@hidden,address@hidden:@var{file2}]...]
+Add ACPI table with specified header fields and context from specified files.
+ETEXI
+
+#ifdef TARGET_I386
+DEFHEADING()
+#endif
+STEXI
address@hidden table
+ETEXI
+
+DEFHEADING(Network options:)
+STEXI
address@hidden @option
+ETEXI
+
+DEF("net", HAS_ARG, QEMU_OPTION_net, \
+ "-net nic[,vlan=n][,macaddr=addr][,model=type][,name=str]\n"
+ " create a new Network Interface Card and connect it to
VLAN 'n'\n"
+#ifdef CONFIG_SLIRP
+ "-net user[,vlan=n][,name=str][,hostname=host]\n"
+ " connect the user mode network stack to VLAN 'n' and
send\n"
+ " hostname 'host' to DHCP clients\n"
+#endif
+#ifdef _WIN32
+ "-net tap[,vlan=n][,name=str],ifname=name\n"
+ " connect the host TAP network interface to VLAN 'n'\n"
+#else
+ "-net
tap[,vlan=n][,name=str][,fd=h][,ifname=name][,script=file][,downscript=dfile]\n"
+ " connect the host TAP network interface to VLAN 'n' and
use the\n"
+ " network scripts 'file' (default=%s)\n"
+ " and 'dfile' (default=%s);\n"
+ " use '[down]script=no' to disable script execution;\n"
+ " use 'fd=h' to connect to an already opened TAP
interface\n"
+#endif
+ "-net
socket[,vlan=n][,name=str][,fd=h][,listen=[host]:port][,connect=host:port]\n"
+ " connect the vlan 'n' to another VLAN using a socket
connection\n"
+ "-net socket[,vlan=n][,name=str][,fd=h][,mcast=maddr:port]\n"
+ " connect the vlan 'n' to multicast maddr and port\n"
+#ifdef CONFIG_VDE
+ "-net
vde[,vlan=n][,name=str][,sock=socketpath][,port=n][,group=groupname][,mode=octalmode]\n"
+ " connect the vlan 'n' to port 'n' of a vde switch
running\n"
+ " on host and listening for incoming connections on
'socketpath'.\n"
+ " Use group 'groupname' and mode 'octalmode' to change
default\n"
+ " ownership and permissions for communication port.\n"
+#endif
+ "-net none use it alone to have zero network devices; if no -net
option\n"
+ " is provided, the default is '-net nic -net user'\n")
+STEXI
address@hidden -net
nic[,address@hidden,address@hidden,address@hidden,address@hidden
+Create a new Network Interface Card and connect it to VLAN @var{n} (@var{n}
+= 0 is the default). The NIC is an ne2k_pci by default on the PC
+target. Optionally, the MAC address can be changed to @var{addr}
+and a @var{name} can be assigned for use in monitor commands. If no
address@hidden option is specified, a single NIC is created.
+Qemu can emulate several different models of network card.
+Valid values for @var{type} are
address@hidden, @code{i82557b}, @code{i82559er},
address@hidden, @code{ne2k_isa}, @code{pcnet}, @code{rtl8139},
address@hidden, @code{smc91c111}, @code{lance} and @code{mcf_fec}.
+Not all devices are supported on all targets. Use -net nic,model=?
+for a list of available devices for your target.
+
address@hidden -net user[,address@hidden,address@hidden,address@hidden
+Use the user mode network stack which requires no administrator
+privilege to run. @option{hostname=name} can be used to specify the client
+hostname reported by the builtin DHCP server.
+
address@hidden -net channel,@var{port}:@var{dev}
+Forward @option{user} TCP connection to port @var{port} to character device
@var{dev}
+
address@hidden -net
tap[,address@hidden,address@hidden,address@hidden,address@hidden,address@hidden,address@hidden
+Connect the host TAP network interface @var{name} to VLAN @var{n}, use
+the network script @var{file} to configure it and the network script
address@hidden to deconfigure it. If @var{name} is not provided, the OS
+automatically provides one. @address@hidden can be used to specify
+the handle of an already opened host TAP interface. The default network
+configure script is @file{/etc/qemu-ifup} and the default network
+deconfigure script is @file{/etc/qemu-ifdown}. Use @option{script=no}
+or @option{downscript=no} to disable script execution. Example:
+
address@hidden
+qemu linux.img -net nic -net tap
address@hidden example
+
+More complicated example (two NICs, each one connected to a TAP device)
address@hidden
+qemu linux.img -net nic,vlan=0 -net tap,vlan=0,ifname=tap0 \
+ -net nic,vlan=1 -net tap,vlan=1,ifname=tap1
address@hidden example
+
address@hidden -net
socket[,address@hidden,address@hidden,address@hidden,address@hidden:@var{port}][,address@hidden:@var{port}]
+
+Connect the VLAN @var{n} to a remote VLAN in another QEMU virtual
+machine using a TCP socket connection. If @option{listen} is
+specified, QEMU waits for incoming connections on @var{port}
+(@var{host} is optional). @option{connect} is used to connect to
+another QEMU instance using the @option{listen} option. @address@hidden
+specifies an already opened TCP socket.
+
+Example:
address@hidden
+# launch a first QEMU instance
+qemu linux.img -net nic,macaddr=52:54:00:12:34:56 \
+ -net socket,listen=:1234
+# connect the VLAN 0 of this instance to the VLAN 0
+# of the first instance
+qemu linux.img -net nic,macaddr=52:54:00:12:34:57 \
+ -net socket,connect=127.0.0.1:1234
address@hidden example
+
address@hidden -net
socket[,address@hidden,address@hidden,address@hidden,address@hidden:@var{port}]
+
+Create a VLAN @var{n} shared with another QEMU virtual
+machines using a UDP multicast socket, effectively making a bus for
+every QEMU with same multicast address @var{maddr} and @var{port}.
+NOTES:
address@hidden
address@hidden
+Several QEMU can be running on different hosts and share same bus (assuming
+correct multicast setup for these hosts).
address@hidden
+mcast support is compatible with User Mode Linux (argument @address@hidden),
see
address@hidden://user-mode-linux.sf.net}.
address@hidden
+Use @option{fd=h} to specify an already opened UDP multicast socket.
address@hidden enumerate
+
+Example:
address@hidden
+# launch one QEMU instance
+qemu linux.img -net nic,macaddr=52:54:00:12:34:56 \
+ -net socket,mcast=230.0.0.1:1234
+# launch another QEMU instance on same "bus"
+qemu linux.img -net nic,macaddr=52:54:00:12:34:57 \
+ -net socket,mcast=230.0.0.1:1234
+# launch yet another QEMU instance on same "bus"
+qemu linux.img -net nic,macaddr=52:54:00:12:34:58 \
+ -net socket,mcast=230.0.0.1:1234
address@hidden example
+
+Example (User Mode Linux compat.):
address@hidden
+# launch QEMU instance (note mcast address selected
+# is UML's default)
+qemu linux.img -net nic,macaddr=52:54:00:12:34:56 \
+ -net socket,mcast=239.192.168.1:1102
+# launch UML
+/path/to/linux ubd0=/path/to/root_fs eth0=mcast
address@hidden example
+
address@hidden -net
vde[,address@hidden,address@hidden,address@hidden,address@hidden,address@hidden,address@hidden
+Connect VLAN @var{n} to PORT @var{n} of a vde switch running on host and
+listening for incoming connections on @var{socketpath}. Use GROUP
@var{groupname}
+and MODE @var{octalmode} to change default ownership and permissions for
+communication port. This option is available only if QEMU has been compiled
+with vde support enabled.
+
+Example:
address@hidden
+# launch vde switch
+vde_switch -F -sock /tmp/myswitch
+# launch QEMU instance
+qemu linux.img -net nic -net vde,sock=/tmp/myswitch
address@hidden example
+
address@hidden -net none
+Indicate that no network devices should be configured. It is used to
+override the default configuration (@option{-net nic -net user}) which
+is activated if no @option{-net} options are provided.
+ETEXI
+
+#ifdef CONFIG_SLIRP
+DEF("tftp", HAS_ARG, QEMU_OPTION_tftp, \
+ "-tftp dir allow tftp access to files in dir [-net user]\n")
+#endif
+STEXI
address@hidden -tftp @var{dir}
+When using the user mode network stack, activate a built-in TFTP
+server. The files in @var{dir} will be exposed as the root of a TFTP server.
+The TFTP client on the guest must be configured in binary mode (use the command
address@hidden of the Unix TFTP client). The host IP address on the guest is as
+usual 10.0.2.2.
+ETEXI
+
+#ifdef CONFIG_SLIRP
+DEF("bootp", HAS_ARG, QEMU_OPTION_bootp, \
+ "-bootp file advertise file in BOOTP replies\n")
+#endif
+STEXI
address@hidden -bootp @var{file}
+When using the user mode network stack, broadcast @var{file} as the BOOTP
+filename. In conjunction with @option{-tftp}, this can be used to network boot
+a guest from a local directory.
+
+Example (using pxelinux):
address@hidden
+qemu -hda linux.img -boot n -tftp /path/to/tftp/files -bootp /pxelinux.0
address@hidden example
+ETEXI
+
+#ifndef _WIN32
+DEF("smb", HAS_ARG, QEMU_OPTION_smb, \
+ "-smb dir allow SMB access to files in 'dir' [-net user]\n")
+#endif
+STEXI
address@hidden -smb @var{dir}
+When using the user mode network stack, activate a built-in SMB
+server so that Windows OSes can access to the host files in @address@hidden
+transparently.
+
+In the guest Windows OS, the line:
address@hidden
+10.0.2.4 smbserver
address@hidden example
+must be added in the file @file{C:\WINDOWS\LMHOSTS} (for windows 9x/Me)
+or @file{C:\WINNT\SYSTEM32\DRIVERS\ETC\LMHOSTS} (Windows NT/2000).
+
+Then @address@hidden can be accessed in @file{\\smbserver\qemu}.
+
+Note that a SAMBA server must be installed on the host OS in
address@hidden/usr/sbin/smbd}. QEMU was tested successfully with smbd version
+2.2.7a from the Red Hat 9 and version 3.0.10-1.fc3 from Fedora Core 3.
+ETEXI
+
+#ifdef CONFIG_SLIRP
+DEF("redir", HAS_ARG, QEMU_OPTION_redir, \
+ "-redir [tcp|udp]:host-port:[guest-host]:guest-port\n" \
+ " redirect TCP or UDP connections from host to guest [-net
user]\n")
+#endif
+STEXI
address@hidden -redir [tcp|udp]:@var{host-port}:address@hidden:@var{guest-port}
+
+When using the user mode network stack, redirect incoming TCP or UDP
+connections to the host port @var{host-port} to the guest
address@hidden on guest port @var{guest-port}. If @var{guest-host}
+is not specified, its value is 10.0.2.15 (default address given by the
+built-in DHCP server).
+
+For example, to redirect host X11 connection from screen 1 to guest
+screen 0, use the following:
+
address@hidden
+# on the host
+qemu -redir tcp:6001::6000 [...]
+# this host xterm should open in the guest X11 server
+xterm -display :1
address@hidden example
+
+To redirect telnet connections from host port 5555 to telnet port on
+the guest, use the following:
+
address@hidden
+# on the host
+qemu -redir tcp:5555::23 [...]
+telnet localhost 5555
address@hidden example
+
+Then when you use on the host @code{telnet localhost 5555}, you
+connect to the guest telnet server.
+
address@hidden table
+ETEXI
+
+DEF("bt", HAS_ARG, QEMU_OPTION_bt, \
+ "\n" \
+ "-bt hci,null dumb bluetooth HCI - doesn't respond to commands\n" \
+ "-bt hci,host[:id]\n" \
+ " use host's HCI with the given name\n" \
+ "-bt hci[,vlan=n]\n" \
+ " emulate a standard HCI in virtual scatternet 'n'\n" \
+ "-bt vhci[,vlan=n]\n" \
+ " add host computer to virtual scatternet 'n' using VHCI\n"
\
+ "-bt device:dev[,vlan=n]\n" \
+ " emulate a bluetooth device 'dev' in scatternet 'n'\n")
+STEXI
+Bluetooth(R) options:
address@hidden @option
+
address@hidden -bt hci[...]
+Defines the function of the corresponding Bluetooth HCI. -bt options
+are matched with the HCIs present in the chosen machine type. For
+example when emulating a machine with only one HCI built into it, only
+the first @code{-bt hci[...]} option is valid and defines the HCI's
+logic. The Transport Layer is decided by the machine type. Currently
+the machines @code{n800} and @code{n810} have one HCI and all other
+machines have none.
+
address@hidden
+The following three types are recognized:
+
address@hidden @code
address@hidden -bt hci,null
+(default) The corresponding Bluetooth HCI assumes no internal logic
+and will not respond to any HCI commands or emit events.
+
address@hidden -bt hci,host[:@var{id}]
+(@code{bluez} only) The corresponding HCI passes commands / events
+to / from the physical HCI identified by the name @var{id} (default:
address@hidden) on the computer running QEMU. Only available on @code{bluez}
+capable systems like Linux.
+
address@hidden -bt hci[,address@hidden
+Add a virtual, standard HCI that will participate in the Bluetooth
+scatternet @var{n} (default @code{0}). Similarly to @option{-net}
+VLANs, devices inside a bluetooth network @var{n} can only communicate
+with other devices in the same network (scatternet).
address@hidden table
+
address@hidden -bt vhci[,address@hidden
+(Linux-host only) Create a HCI in scatternet @var{n} (default 0) attached
+to the host bluetooth stack instead of to the emulated target. This
+allows the host and target machines to participate in a common scatternet
+and communicate. Requires the Linux @code{vhci} driver installed. Can
+be used as following:
+
address@hidden
+qemu [...OPTIONS...] -bt hci,vlan=5 -bt vhci,vlan=5
address@hidden example
+
address@hidden -bt device:@var{dev}[,address@hidden
+Emulate a bluetooth device @var{dev} and place it in network @var{n}
+(default @code{0}). QEMU can only emulate one type of bluetooth devices
+currently:
+
address@hidden @code
address@hidden keyboard
+Virtual wireless keyboard implementing the HIDP bluetooth profile.
address@hidden table
address@hidden table
+ETEXI
+
+DEFHEADING()
+
+DEFHEADING(Linux boot specific:)
+STEXI
+When using these options, you can use a given
+Linux kernel without installing it in the disk image. It can be useful
+for easier testing of various kernels.
+
address@hidden @option
+ETEXI
+
+DEF("kernel", HAS_ARG, QEMU_OPTION_kernel, \
+ "-kernel bzImage use 'bzImage' as kernel image\n")
+STEXI
address@hidden -kernel @var{bzImage}
+Use @var{bzImage} as kernel image.
+ETEXI
+
+DEF("append", HAS_ARG, QEMU_OPTION_append, \
+ "-append cmdline use 'cmdline' as kernel command line\n")
+STEXI
address@hidden -append @var{cmdline}
+Use @var{cmdline} as kernel command line
+ETEXI
+
+DEF("initrd", HAS_ARG, QEMU_OPTION_initrd, \
+ "-initrd file use 'file' as initial ram disk\n")
+STEXI
address@hidden -initrd @var{file}
+Use @var{file} as initial ram disk.
+ETEXI
+
+STEXI
address@hidden table
+ETEXI
+
+DEFHEADING()
+
+DEFHEADING(Debug/Expert options:)
+
+STEXI
address@hidden @option
+ETEXI
+
+DEF("serial", HAS_ARG, QEMU_OPTION_serial, \
+ "-serial dev redirect the serial port to char device 'dev'\n")
+STEXI
address@hidden -serial @var{dev}
+Redirect the virtual serial port to host character device
address@hidden The default device is @code{vc} in graphical mode and
address@hidden in non graphical mode.
+
+This option can be used several times to simulate up to 4 serial
+ports.
+
+Use @code{-serial none} to disable all serial ports.
+
+Available character devices are:
address@hidden @code
address@hidden vc[:WxH]
+Virtual console. Optionally, a width and height can be given in pixel with
address@hidden
+vc:800x600
address@hidden example
+It is also possible to specify width or height in characters:
address@hidden
+vc:80Cx24C
address@hidden example
address@hidden pty
+[Linux only] Pseudo TTY (a new PTY is automatically allocated)
address@hidden none
+No device is allocated.
address@hidden null
+void device
address@hidden /dev/XXX
+[Linux only] Use host tty, e.g. @file{/dev/ttyS0}. The host serial port
+parameters are set according to the emulated ones.
address@hidden /dev/address@hidden
+[Linux only, parallel port only] Use host parallel port
address@hidden Currently SPP and EPP parallel port features can be used.
address@hidden file:@var{filename}
+Write output to @var{filename}. No character can be read.
address@hidden stdio
+[Unix only] standard input/output
address@hidden pipe:@var{filename}
+name pipe @var{filename}
address@hidden address@hidden
+[Windows only] Use host serial port @var{n}
address@hidden
udp:address@hidden:@var{remote_port}[@@address@hidden:@var{src_port}]
+This implements UDP Net Console.
+When @var{remote_host} or @var{src_ip} are not specified
+they default to @code{0.0.0.0}.
+When not using a specified @var{src_port} a random port is automatically
chosen.
address@hidden msmouse
+Three button serial mouse. Configure the guest to use Microsoft protocol.
+
+If you just want a simple readonly console you can use @code{netcat} or
address@hidden, by starting qemu with: @code{-serial udp::4555} and nc as:
address@hidden -u -l -p 4555}. Any time qemu writes something to that port it
+will appear in the netconsole session.
+
+If you plan to send characters back via netconsole or you want to stop
+and start qemu a lot of times, you should have qemu use the same
+source port each time by using something like @code{-serial
+udp::4555@@:4556} to qemu. Another approach is to use a patched
+version of netcat which can listen to a TCP port and send and receive
+characters via udp. If you have a patched version of netcat which
+activates telnet remote echo and single char transfer, then you can
+use the following options to step up a netcat redirector to allow
+telnet on port 5555 to access the qemu port.
address@hidden @code
address@hidden Qemu Options:
+-serial udp::4555@@:4556
address@hidden netcat options:
+-u -P 4555 -L 0.0.0.0:4556 -t -p 5555 -I -T
address@hidden telnet options:
+localhost 5555
address@hidden table
+
address@hidden tcp:address@hidden:@var{port}[,@var{server}][,nowait][,nodelay]
+The TCP Net Console has two modes of operation. It can send the serial
+I/O to a location or wait for a connection from a location. By default
+the TCP Net Console is sent to @var{host} at the @var{port}. If you use
+the @var{server} option QEMU will wait for a client socket application
+to connect to the port before continuing, unless the @code{nowait}
+option was specified. The @code{nodelay} option disables the Nagle buffering
+algorithm. If @var{host} is omitted, 0.0.0.0 is assumed. Only
+one TCP connection at a time is accepted. You can use @code{telnet} to
+connect to the corresponding character device.
address@hidden @code
address@hidden Example to send tcp console to 192.168.0.2 port 4444
+-serial tcp:192.168.0.2:4444
address@hidden Example to listen and wait on port 4444 for connection
+-serial tcp::4444,server
address@hidden Example to not wait and listen on ip 192.168.0.100 port 4444
+-serial tcp:192.168.0.100:4444,server,nowait
address@hidden table
+
address@hidden telnet:@var{host}:@var{port}[,server][,nowait][,nodelay]
+The telnet protocol is used instead of raw tcp sockets. The options
+work the same as if you had specified @code{-serial tcp}. The
+difference is that the port acts like a telnet server or client using
+telnet option negotiation. This will also allow you to send the
+MAGIC_SYSRQ sequence if you use a telnet that supports sending the break
+sequence. Typically in unix telnet you do it with Control-] and then
+type "send break" followed by pressing the enter key.
+
address@hidden unix:@var{path}[,server][,nowait]
+A unix domain socket is used instead of a tcp socket. The option works the
+same as if you had specified @code{-serial tcp} except the unix domain socket
address@hidden is used for connections.
+
address@hidden mon:@var{dev_string}
+This is a special option to allow the monitor to be multiplexed onto
+another serial port. The monitor is accessed with key sequence of
address@hidden and then pressing @key{c}. See monitor access
address@hidden in the -nographic section for more keys.
address@hidden should be any one of the serial devices specified
+above. An example to multiplex the monitor onto a telnet server
+listening on port 4444 would be:
address@hidden @code
address@hidden -serial mon:telnet::4444,server,nowait
address@hidden table
+
address@hidden braille
+Braille device. This will use BrlAPI to display the braille output on a real
+or fake device.
+
address@hidden table
+ETEXI
+
+DEF("parallel", HAS_ARG, QEMU_OPTION_parallel, \
+ "-parallel dev redirect the parallel port to char device 'dev'\n")
+STEXI
address@hidden -parallel @var{dev}
+Redirect the virtual parallel port to host device @var{dev} (same
+devices as the serial port). On Linux hosts, @file{/dev/parportN} can
+be used to use hardware devices connected on the corresponding host
+parallel port.
+
+This option can be used several times to simulate up to 3 parallel
+ports.
+
+Use @code{-parallel none} to disable all parallel ports.
+ETEXI
+
+DEF("monitor", HAS_ARG, QEMU_OPTION_monitor, \
+ "-monitor dev redirect the monitor to char device 'dev'\n")
+STEXI
address@hidden -monitor @var{dev}
+Redirect the monitor to host device @var{dev} (same devices as the
+serial port).
+The default device is @code{vc} in graphical mode and @code{stdio} in
+non graphical mode.
+ETEXI
+
+DEF("pidfile", HAS_ARG, QEMU_OPTION_pidfile, \
+ "-pidfile file write PID to 'file'\n")
+STEXI
address@hidden -pidfile @var{file}
+Store the QEMU process PID in @var{file}. It is useful if you launch QEMU
+from a script.
+ETEXI
+
+DEF("S", 0, QEMU_OPTION_S, \
+ "-S freeze CPU at startup (use 'c' to start execution)\n")
+STEXI
address@hidden -S
+Do not start CPU at startup (you must type 'c' in the monitor).
+ETEXI
+
+DEF("s", 0, QEMU_OPTION_s, \
+ "-s wait gdb connection to port\n")
+STEXI
address@hidden -s
+Wait gdb connection to port 1234 (@pxref{gdb_usage}).
+ETEXI
+
+DEF("p", HAS_ARG, QEMU_OPTION_p, \
+ "-p port set gdb connection port [default=%s]\n")
+STEXI
address@hidden -p @var{port}
+Change gdb connection port. @var{port} can be either a decimal number
+to specify a TCP port, or a host device (same devices as the serial port).
+ETEXI
+
+DEF("d", HAS_ARG, QEMU_OPTION_d, \
+ "-d item1,... output log to %s (use -d ? for a list of log items)\n")
+STEXI
address@hidden -d
+Output log in /tmp/qemu.log
+ETEXI
+
+DEF("hdachs", HAS_ARG, QEMU_OPTION_hdachs, \
+ "-hdachs c,h,s[,t]\n" \
+ " force hard disk 0 physical geometry and the optional
BIOS\n" \
+ " translation (t=none or lba) (usually qemu can guess
them)\n")
+STEXI
address@hidden -hdachs @var{c},@var{h},@var{s},[,@var{t}]
+Force hard disk 0 physical geometry (1 <= @var{c} <= 16383, 1 <=
address@hidden <= 16, 1 <= @var{s} <= 63) and optionally force the BIOS
+translation mode (@var{t}=none, lba or auto). Usually QEMU can guess
+all those parameters. This option is useful for old MS-DOS disk
+images.
+ETEXI
+
+DEF("L", HAS_ARG, QEMU_OPTION_L, \
+ "-L path set the directory for the BIOS, VGA BIOS and keymaps\n")
+STEXI
address@hidden -L @var{path}
+Set the directory for the BIOS, VGA BIOS and keymaps.
+ETEXI
+
+DEF("bios", HAS_ARG, QEMU_OPTION_bios, \
+ "-bios file set the filename for the BIOS\n")
+STEXI
address@hidden -bios @var{file}
+Set the filename for the BIOS.
+ETEXI
+
+#ifdef USE_KQEMU
+DEF("kernel-kqemu", 0, QEMU_OPTION_kernel_kqemu, \
+ "-kernel-kqemu enable KQEMU full virtualization (default is user mode
only)\n")
+#endif
+STEXI
address@hidden -kernel-kqemu
+Enable KQEMU full virtualization (default is user mode only).
+ETEXI
+
+#ifdef USE_KQEMU
+DEF("no-kqemu", 0, QEMU_OPTION_no_kqemu, \
+ "-no-kqemu disable KQEMU kernel module usage\n")
+#endif
+STEXI
address@hidden -no-kqemu
+Disable KQEMU kernel module usage. KQEMU options are only available if
+KQEMU support is enabled when compiling.
+ETEXI
+
+#ifdef CONFIG_KVM
+DEF("enable-kvm", 0, QEMU_OPTION_enable_kvm, \
+ "-enable-kvm enable KVM full virtualization support\n")
+#endif
+STEXI
address@hidden -enable-kvm
+Enable KVM full virtualization support. This option is only available
+if KVM support is enabled when compiling.
+ETEXI
+
+DEF("no-reboot", 0, QEMU_OPTION_no_reboot, \
+ "-no-reboot exit instead of rebooting\n")
+STEXI
address@hidden -no-reboot
+Exit instead of rebooting.
+ETEXI
+
+DEF("no-shutdown", 0, QEMU_OPTION_no_shutdown, \
+ "-no-shutdown stop before shutdown\n")
+STEXI
address@hidden -no-shutdown
+Don't exit QEMU on guest shutdown, but instead only stop the emulation.
+This allows for instance switching to monitor to commit changes to the
+disk image.
+ETEXI
+
+DEF("loadvm", HAS_ARG, QEMU_OPTION_loadvm, \
+ "-loadvm [tag|id]\n" \
+ " start right away with a saved state (loadvm in
monitor)\n")
+STEXI
address@hidden -loadvm @var{file}
+Start right away with a saved state (@code{loadvm} in monitor)
+ETEXI
+
+#ifndef _WIN32
+DEF("daemonize", 0, QEMU_OPTION_daemonize, \
+ "-daemonize daemonize QEMU after initializing\n")
+#endif
+STEXI
address@hidden -daemonize
+Daemonize the QEMU process after initialization. QEMU will not detach from
+standard IO until it is ready to receive connections on any of its devices.
+This option is a useful way for external programs to launch QEMU without having
+to cope with initialization race conditions.
+ETEXI
+
+DEF("option-rom", HAS_ARG, QEMU_OPTION_option_rom, \
+ "-option-rom rom load a file, rom, into the option ROM space\n")
+STEXI
address@hidden -option-rom @var{file}
+Load the contents of @var{file} as an option ROM.
+This option is useful to load things like EtherBoot.
+ETEXI
+
+DEF("clock", HAS_ARG, QEMU_OPTION_clock, \
+ "-clock force the use of the given methods for timer alarm.\n" \
+ " To see what timers are available use -clock ?\n")
+STEXI
address@hidden -clock @var{method}
+Force the use of the given methods for timer alarm. To see what timers
+are available use -clock ?.
+ETEXI
+
+DEF("localtime", 0, QEMU_OPTION_localtime, \
+ "-localtime set the real time clock to local time [default=utc]\n")
+STEXI
address@hidden -localtime
+Set the real time clock to local time (the default is to UTC
+time). This option is needed to have correct date in MS-DOS or
+Windows.
+ETEXI
+
+DEF("startdate", HAS_ARG, QEMU_OPTION_startdate, \
+ "-startdate select initial date of the clock\n")
+STEXI
+
address@hidden -startdate @var{date}
+Set the initial date of the real time clock. Valid formats for
address@hidden are: @code{now} or @code{2006-06-17T16:01:21} or
address@hidden The default value is @code{now}.
+ETEXI
+
+DEF("icount", HAS_ARG, QEMU_OPTION_icount, \
+ "-icount [N|auto]\n" \
+ " enable virtual instruction counter with 2^N clock ticks
per instruction\n")
+STEXI
address@hidden -icount [N|auto]
+Enable virtual instruction counter. The virtual cpu will execute one
+instruction every 2^N ns of virtual time. If @code{auto} is specified
+then the virtual cpu speed will be automatically adjusted to keep virtual
+time within a few seconds of real time.
+
+Note that while this option can give deterministic behavior, it does not
+provide cycle accurate emulation. Modern CPUs contain superscalar out of
+order cores with complex cache hierarchies. The number of instructions
+executed often has little or no correlation with actual performance.
+ETEXI
+
+DEF("echr", HAS_ARG, QEMU_OPTION_echr, \
+ "-echr chr set terminal escape character instead of ctrl-a\n")
+STEXI
+
address@hidden -echr numeric_ascii_value
+Change the escape character used for switching to the monitor when using
+monitor and serial sharing. The default is @code{0x01} when using the
address@hidden option. @code{0x01} is equal to pressing
address@hidden You can select a different character from the ascii
+control keys where 1 through 26 map to Control-a through Control-z. For
+instance you could use the either of the following to change the escape
+character to Control-t.
address@hidden @code
address@hidden -echr 0x14
address@hidden -echr 20
address@hidden table
+ETEXI
+
+DEF("virtioconsole", HAS_ARG, QEMU_OPTION_virtiocon, \
+ "-virtioconsole c\n" \
+ " set virtio console\n")
+STEXI
address@hidden -virtioconsole @var{c}
+Set virtio console.
+ETEXI
+
+DEF("show-cursor", 0, QEMU_OPTION_show_cursor, \
+ "-show-cursor show cursor\n")
+STEXI
+ETEXI
+
+DEF("tb-size", HAS_ARG, QEMU_OPTION_tb_size, \
+ "-tb-size n set TB size\n")
+STEXI
+ETEXI
+
+DEF("incoming", HAS_ARG, QEMU_OPTION_incoming, \
+ "-incoming p prepare for incoming migration, listen on port p\n")
+STEXI
+ETEXI
+
+#ifndef _WIN32
+DEF("chroot", HAS_ARG, QEMU_OPTION_chroot, \
+ "-chroot dir Chroot to dir just before starting the VM.\n")
+#endif
+STEXI
address@hidden -chroot dir
+Immediately before starting guest execution, chroot to the specified
+directory. Especially useful in combination with -runas.
+ETEXI
+
+#ifndef _WIN32
+DEF("runas", HAS_ARG, QEMU_OPTION_runas, \
+ "-runas user Change to user id user just before starting the VM.\n")
+#endif
+STEXI
address@hidden -runas user
+Immediately before starting guest execution, drop root privileges, switching
+to the specified user.
+ETEXI
+
+STEXI
address@hidden table
+ETEXI
+
+#if defined(TARGET_SPARC) || defined(TARGET_PPC)
+DEF("prom-env", HAS_ARG, QEMU_OPTION_prom_env,
+ "-prom-env variable=value\n"
+ " set OpenBIOS nvram variables\n")
+#endif
+#if defined(TARGET_ARM) || defined(TARGET_M68K)
+DEF("semihosting", 0, QEMU_OPTION_semihosting,
+ "-semihosting semihosting mode\n")
+#endif
+#if defined(TARGET_ARM)
+DEF("old-param", 0, QEMU_OPTION_old_param,
+ "-old-param old param mode\n")
+#endif
Modified: trunk/vl.c
===================================================================
--- trunk/vl.c 2009-03-22 03:01:39 UTC (rev 6883)
+++ trunk/vl.c 2009-03-28 06:44:27 UTC (rev 6884)
@@ -3937,192 +3937,19 @@
static void help(int exitcode)
{
- /* Please keep in synch with QEMU_OPTION_ enums, qemu_options[]
- and qemu-doc.texi */
printf("QEMU PC emulator version " QEMU_VERSION ", Copyright (c) 2003-2008
Fabrice Bellard\n"
"usage: %s [options] [disk_image]\n"
"\n"
"'disk_image' is a raw hard image image for IDE hard disk 0\n"
"\n"
- "Standard options:\n"
- "-h or -help display this help and exit\n"
- "-M machine select emulated machine (-M ? for list)\n"
- "-cpu cpu select CPU (-cpu ? for list)\n"
- "-smp n set the number of CPUs to 'n' [default=1]\n"
- "-fda/-fdb file use 'file' as floppy disk 0/1 image\n"
- "-hda/-hdb file use 'file' as IDE hard disk 0/1 image\n"
- "-hdc/-hdd file use 'file' as IDE hard disk 2/3 image\n"
- "-cdrom file use 'file' as IDE cdrom image (cdrom is ide1
master)\n"
- "-drive [file=file][,if=type][,bus=n][,unit=m][,media=d][,index=i]\n"
- " [,cyls=c,heads=h,secs=s[,trans=t]][,snapshot=on|off]\n"
- "
[,cache=writethrough|writeback|none][,format=f][,serial=s]\n"
- " use 'file' as a drive image\n"
- "-mtdblock file use 'file' as on-board Flash memory image\n"
- "-sd file use 'file' as SecureDigital card image\n"
- "-pflash file use 'file' as a parallel flash image\n"
- "-boot [a|c|d|n] boot on floppy (a), hard disk (c), CD-ROM (d), or
network (n)\n"
- "-snapshot write to temporary files instead of disk image
files\n"
- "-m megs set virtual RAM size to megs MB [default=%d]\n"
-#ifndef _WIN32
- "-k language use keyboard layout (for example \"fr\" for
French)\n"
-#endif
-#ifdef HAS_AUDIO
- "-audio-help print list of audio drivers and their options\n"
- "-soundhw c1,... enable audio support\n"
- " and only specified sound cards (comma separated
list)\n"
- " use -soundhw ? to get the list of supported
cards\n"
- " use -soundhw all to enable all of them\n"
-#endif
- "-usb enable the USB driver (will be the default soon)\n"
- "-usbdevice name add the host or guest USB device 'name'\n"
- "-name string set the name of the guest\n"
- "-uuid %%08x-%%04x-%%04x-%%04x-%%012x\n"
- " specify machine UUID\n"
+#define DEF(option, opt_arg, opt_enum, opt_help) \
+ opt_help
+#define DEFHEADING(text) stringify(text) "\n"
+#include "qemu-options.h"
+#undef DEF
+#undef DEFHEADING
+#undef GEN_DOCS
"\n"
- "Display options:\n"
- "-nographic disable graphical output and redirect serial I/Os
to console\n"
-#ifdef CONFIG_CURSES
- "-curses use a curses/ncurses interface instead of SDL\n"
-#endif
-#ifdef CONFIG_SDL
- "-no-frame open SDL window without a frame and window
decorations\n"
- "-alt-grab use Ctrl-Alt-Shift to grab mouse (instead of
Ctrl-Alt)\n"
- "-no-quit disable SDL window close capability\n"
- "-sdl enable SDL\n"
-#endif
- "-portrait rotate graphical output 90 deg left (only PXA
LCD)\n"
- "-vga [std|cirrus|vmware|none]\n"
- " select video card type\n"
- "-full-screen start in full screen\n"
-#if defined(TARGET_PPC) || defined(TARGET_SPARC)
- "-g WxH[xDEPTH] Set the initial graphical resolution and depth\n"
-#endif
- "-vnc display start a VNC server on display\n"
- "\n"
- "Network options:\n"
- "-net nic[,vlan=n][,macaddr=addr][,model=type][,name=str]\n"
- " create a new Network Interface Card and connect it
to VLAN 'n'\n"
-#ifdef CONFIG_SLIRP
- "-net user[,vlan=n][,name=str][,hostname=host]\n"
- " connect the user mode network stack to VLAN 'n'
and send\n"
- " hostname 'host' to DHCP clients\n"
-#endif
-#ifdef _WIN32
- "-net tap[,vlan=n][,name=str],ifname=name\n"
- " connect the host TAP network interface to VLAN
'n'\n"
-#else
- "-net
tap[,vlan=n][,name=str][,fd=h][,ifname=name][,script=file][,downscript=dfile]\n"
- " connect the host TAP network interface to VLAN 'n'
and use the\n"
- " network scripts 'file' (default=%s)\n"
- " and 'dfile' (default=%s);\n"
- " use '[down]script=no' to disable script
execution;\n"
- " use 'fd=h' to connect to an already opened TAP
interface\n"
-#endif
- "-net
socket[,vlan=n][,name=str][,fd=h][,listen=[host]:port][,connect=host:port]\n"
- " connect the vlan 'n' to another VLAN using a
socket connection\n"
- "-net socket[,vlan=n][,name=str][,fd=h][,mcast=maddr:port]\n"
- " connect the vlan 'n' to multicast maddr and port\n"
-#ifdef CONFIG_VDE
- "-net
vde[,vlan=n][,name=str][,sock=socketpath][,port=n][,group=groupname][,mode=octalmode]\n"
- " connect the vlan 'n' to port 'n' of a vde switch
running\n"
- " on host and listening for incoming connections on
'socketpath'.\n"
- " Use group 'groupname' and mode 'octalmode' to
change default\n"
- " ownership and permissions for communication
port.\n"
-#endif
- "-net none use it alone to have zero network devices; if no
-net option\n"
- " is provided, the default is '-net nic -net user'\n"
-#ifdef CONFIG_SLIRP
- "-tftp dir allow tftp access to files in dir [-net user]\n"
- "-bootp file advertise file in BOOTP replies\n"
-#ifndef _WIN32
- "-smb dir allow SMB access to files in 'dir' [-net user]\n"
-#endif
- "-redir [tcp|udp]:host-port:[guest-host]:guest-port\n"
- " redirect TCP or UDP connections from host to guest
[-net user]\n"
-#endif
- "\n"
- "-bt hci,null dumb bluetooth HCI - doesn't respond to commands\n"
- "-bt hci,host[:id]\n"
- " use host's HCI with the given name\n"
- "-bt hci[,vlan=n]\n"
- " emulate a standard HCI in virtual scatternet 'n'\n"
- "-bt vhci[,vlan=n]\n"
- " add host computer to virtual scatternet 'n' using
VHCI\n"
- "-bt device:dev[,vlan=n]\n"
- " emulate a bluetooth device 'dev' in scatternet
'n'\n"
- "\n"
-#ifdef TARGET_I386
- "\n"
- "i386 target only:\n"
- "-win2k-hack use it when installing Windows 2000 to avoid a
disk full bug\n"
- "-rtc-td-hack use it to fix time drift in Windows ACPI HAL\n"
- "-no-fd-bootchk disable boot signature checking for floppy disks\n"
- "-no-acpi disable ACPI\n"
- "-no-hpet disable HPET\n"
- "-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"
- " ACPI table description\n"
-#endif
- "Linux boot specific:\n"
- "-kernel bzImage use 'bzImage' as kernel image\n"
- "-append cmdline use 'cmdline' as kernel command line\n"
- "-initrd file use 'file' as initial ram disk\n"
- "\n"
- "Debug/Expert options:\n"
- "-serial dev redirect the serial port to char device 'dev'\n"
- "-parallel dev redirect the parallel port to char device 'dev'\n"
- "-monitor dev redirect the monitor to char device 'dev'\n"
- "-pidfile file write PID to 'file'\n"
- "-S freeze CPU at startup (use 'c' to start
execution)\n"
- "-s wait gdb connection to port\n"
- "-p port set gdb connection port [default=%s]\n"
- "-d item1,... output log to %s (use -d ? for a list of log
items)\n"
- "-hdachs c,h,s[,t]\n"
- " force hard disk 0 physical geometry and the
optional BIOS\n"
- " translation (t=none or lba) (usually qemu can
guess them)\n"
- "-L path set the directory for the BIOS, VGA BIOS and
keymaps\n"
- "-bios file set the filename for the BIOS\n"
-#ifdef USE_KQEMU
- "-kernel-kqemu enable KQEMU full virtualization (default is user
mode only)\n"
- "-no-kqemu disable KQEMU kernel module usage\n"
-#endif
-#ifdef CONFIG_KVM
- "-enable-kvm enable KVM full virtualization support\n"
-#endif
- "-no-reboot exit instead of rebooting\n"
- "-no-shutdown stop before shutdown\n"
- "-loadvm [tag|id]\n"
- " start right away with a saved state (loadvm in
monitor)\n"
-#ifndef _WIN32
- "-daemonize daemonize QEMU after initializing\n"
-#endif
- "-option-rom rom load a file, rom, into the option ROM space\n"
-#if defined(TARGET_SPARC) || defined(TARGET_PPC)
- "-prom-env variable=value\n"
- " set OpenBIOS nvram variables\n"
-#endif
- "-clock force the use of the given methods for timer
alarm.\n"
- " To see what timers are available use -clock ?\n"
- "-localtime set the real time clock to local time
[default=utc]\n"
- "-startdate select initial date of the clock\n"
- "-icount [N|auto]\n"
- " enable virtual instruction counter with 2^N clock
ticks per instruction\n"
- "-echr chr set terminal escape character instead of ctrl-a\n"
- "-virtioconsole c\n"
- " set virtio console\n"
- "-show-cursor show cursor\n"
-#if defined(TARGET_ARM) || defined(TARGET_M68K)
- "-semihosting semihosting mode\n"
-#endif
-#if defined(TARGET_ARM)
- "-old-param old param mode\n"
-#endif
- "-tb-size n set TB size\n"
- "-incoming p prepare for incoming migration, listen on port p\n"
-#ifndef _WIN32
- "-chroot dir Chroot to dir just before starting the VM.\n"
- "-runas user Change to user id user just before starting the
VM.\n"
-#endif
- "\n"
"During emulation, the following keys are useful:\n"
"ctrl-alt-f toggle full screen\n"
"ctrl-alt-n switch to virtual console 'n'\n"
@@ -4144,103 +3971,13 @@
#define HAS_ARG 0x0001
enum {
- /* Please keep in synch with help, qemu_options[] and
- qemu-doc.texi */
- /* Standard options: */
- QEMU_OPTION_h,
- QEMU_OPTION_M,
- QEMU_OPTION_cpu,
- QEMU_OPTION_smp,
- QEMU_OPTION_fda,
- QEMU_OPTION_fdb,
- QEMU_OPTION_hda,
- QEMU_OPTION_hdb,
- QEMU_OPTION_hdc,
- QEMU_OPTION_hdd,
- QEMU_OPTION_cdrom,
- QEMU_OPTION_drive,
- QEMU_OPTION_mtdblock,
- QEMU_OPTION_sd,
- QEMU_OPTION_pflash,
- QEMU_OPTION_boot,
- QEMU_OPTION_snapshot,
- QEMU_OPTION_m,
- QEMU_OPTION_k,
- QEMU_OPTION_audio_help,
- QEMU_OPTION_soundhw,
- QEMU_OPTION_usb,
- QEMU_OPTION_usbdevice,
- QEMU_OPTION_name,
- QEMU_OPTION_uuid,
-
- /* Display options: */
- QEMU_OPTION_nographic,
- QEMU_OPTION_curses,
- QEMU_OPTION_no_frame,
- QEMU_OPTION_alt_grab,
- QEMU_OPTION_no_quit,
- QEMU_OPTION_sdl,
- QEMU_OPTION_portrait,
- QEMU_OPTION_vga,
- QEMU_OPTION_full_screen,
- QEMU_OPTION_g,
- QEMU_OPTION_vnc,
-
- /* Network options: */
- QEMU_OPTION_net,
- QEMU_OPTION_tftp,
- QEMU_OPTION_bootp,
- QEMU_OPTION_smb,
- QEMU_OPTION_redir,
- QEMU_OPTION_bt,
-
- /* i386 target only: */
- QEMU_OPTION_win2k_hack,
- QEMU_OPTION_rtc_td_hack,
- QEMU_OPTION_no_fd_bootchk,
- QEMU_OPTION_no_acpi,
- QEMU_OPTION_no_hpet,
- QEMU_OPTION_acpitable,
-
- /* Linux boot specific: */
- QEMU_OPTION_kernel,
- QEMU_OPTION_append,
- QEMU_OPTION_initrd,
-
- /* Debug/Expert options: */
- QEMU_OPTION_serial,
- QEMU_OPTION_parallel,
- QEMU_OPTION_monitor,
- QEMU_OPTION_pidfile,
- QEMU_OPTION_S,
- QEMU_OPTION_s,
- QEMU_OPTION_p,
- QEMU_OPTION_d,
- QEMU_OPTION_hdachs,
- QEMU_OPTION_L,
- QEMU_OPTION_bios,
- QEMU_OPTION_kernel_kqemu,
- QEMU_OPTION_no_kqemu,
- QEMU_OPTION_enable_kvm,
- QEMU_OPTION_no_reboot,
- QEMU_OPTION_no_shutdown,
- QEMU_OPTION_loadvm,
- QEMU_OPTION_daemonize,
- QEMU_OPTION_option_rom,
- QEMU_OPTION_prom_env,
- QEMU_OPTION_clock,
- QEMU_OPTION_localtime,
- QEMU_OPTION_startdate,
- QEMU_OPTION_icount,
- QEMU_OPTION_echr,
- QEMU_OPTION_virtiocon,
- QEMU_OPTION_show_cursor,
- QEMU_OPTION_semihosting,
- QEMU_OPTION_old_param,
- QEMU_OPTION_tb_size,
- QEMU_OPTION_incoming,
- QEMU_OPTION_chroot,
- QEMU_OPTION_runas,
+#define DEF(option, opt_arg, opt_enum, opt_help) \
+ opt_enum,
+#define DEFHEADING(text)
+#include "qemu-options.h"
+#undef DEF
+#undef DEFHEADING
+#undef GEN_DOCS
};
typedef struct QEMUOption {
@@ -4250,129 +3987,14 @@
} QEMUOption;
static const QEMUOption qemu_options[] = {
- /* Please keep in synch with help, QEMU_OPTION_ enums, and
- qemu-doc.texi */
- /* Standard options: */
{ "h", 0, QEMU_OPTION_h },
- { "help", 0, QEMU_OPTION_h },
- { "M", HAS_ARG, QEMU_OPTION_M },
- { "cpu", HAS_ARG, QEMU_OPTION_cpu },
- { "smp", HAS_ARG, QEMU_OPTION_smp },
- { "fda", HAS_ARG, QEMU_OPTION_fda },
- { "fdb", HAS_ARG, QEMU_OPTION_fdb },
- { "hda", HAS_ARG, QEMU_OPTION_hda },
- { "hdb", HAS_ARG, QEMU_OPTION_hdb },
- { "hdc", HAS_ARG, QEMU_OPTION_hdc },
- { "hdd", HAS_ARG, QEMU_OPTION_hdd },
- { "cdrom", HAS_ARG, QEMU_OPTION_cdrom },
- { "drive", HAS_ARG, QEMU_OPTION_drive },
- { "mtdblock", HAS_ARG, QEMU_OPTION_mtdblock },
- { "sd", HAS_ARG, QEMU_OPTION_sd },
- { "pflash", HAS_ARG, QEMU_OPTION_pflash },
- { "boot", HAS_ARG, QEMU_OPTION_boot },
- { "snapshot", 0, QEMU_OPTION_snapshot },
- { "m", HAS_ARG, QEMU_OPTION_m },
-#ifndef _WIN32
- { "k", HAS_ARG, QEMU_OPTION_k },
-#endif
-#ifdef HAS_AUDIO
- { "audio-help", 0, QEMU_OPTION_audio_help },
- { "soundhw", HAS_ARG, QEMU_OPTION_soundhw },
-#endif
- { "usb", 0, QEMU_OPTION_usb },
- { "usbdevice", HAS_ARG, QEMU_OPTION_usbdevice },
- { "name", HAS_ARG, QEMU_OPTION_name },
- { "uuid", HAS_ARG, QEMU_OPTION_uuid },
-
- /* Display options: */
- { "nographic", 0, QEMU_OPTION_nographic },
-#ifdef CONFIG_CURSES
- { "curses", 0, QEMU_OPTION_curses },
-#endif
-#ifdef CONFIG_SDL
- { "no-frame", 0, QEMU_OPTION_no_frame },
- { "alt-grab", 0, QEMU_OPTION_alt_grab },
- { "no-quit", 0, QEMU_OPTION_no_quit },
- { "sdl", 0, QEMU_OPTION_sdl },
-#endif
- { "portrait", 0, QEMU_OPTION_portrait },
- { "vga", HAS_ARG, QEMU_OPTION_vga },
- { "full-screen", 0, QEMU_OPTION_full_screen },
-#if defined(TARGET_PPC) || defined(TARGET_SPARC)
- { "g", 1, QEMU_OPTION_g },
-#endif
- { "vnc", HAS_ARG, QEMU_OPTION_vnc },
-
- /* Network options: */
- { "net", HAS_ARG, QEMU_OPTION_net},
-#ifdef CONFIG_SLIRP
- { "tftp", HAS_ARG, QEMU_OPTION_tftp },
- { "bootp", HAS_ARG, QEMU_OPTION_bootp },
-#ifndef _WIN32
- { "smb", HAS_ARG, QEMU_OPTION_smb },
-#endif
- { "redir", HAS_ARG, QEMU_OPTION_redir },
-#endif
- { "bt", HAS_ARG, QEMU_OPTION_bt },
-#ifdef TARGET_I386
- /* i386 target only: */
- { "win2k-hack", 0, QEMU_OPTION_win2k_hack },
- { "rtc-td-hack", 0, QEMU_OPTION_rtc_td_hack },
- { "no-fd-bootchk", 0, QEMU_OPTION_no_fd_bootchk },
- { "no-acpi", 0, QEMU_OPTION_no_acpi },
- { "no-hpet", 0, QEMU_OPTION_no_hpet },
- { "acpitable", HAS_ARG, QEMU_OPTION_acpitable },
-#endif
-
- /* Linux boot specific: */
- { "kernel", HAS_ARG, QEMU_OPTION_kernel },
- { "append", HAS_ARG, QEMU_OPTION_append },
- { "initrd", HAS_ARG, QEMU_OPTION_initrd },
-
- /* Debug/Expert options: */
- { "serial", HAS_ARG, QEMU_OPTION_serial },
- { "parallel", HAS_ARG, QEMU_OPTION_parallel },
- { "monitor", HAS_ARG, QEMU_OPTION_monitor },
- { "pidfile", HAS_ARG, QEMU_OPTION_pidfile },
- { "S", 0, QEMU_OPTION_S },
- { "s", 0, QEMU_OPTION_s },
- { "p", HAS_ARG, QEMU_OPTION_p },
- { "d", HAS_ARG, QEMU_OPTION_d },
- { "hdachs", HAS_ARG, QEMU_OPTION_hdachs },
- { "L", HAS_ARG, QEMU_OPTION_L },
- { "bios", HAS_ARG, QEMU_OPTION_bios },
-#ifdef USE_KQEMU
- { "kernel-kqemu", 0, QEMU_OPTION_kernel_kqemu },
- { "no-kqemu", 0, QEMU_OPTION_no_kqemu },
-#endif
-#ifdef CONFIG_KVM
- { "enable-kvm", 0, QEMU_OPTION_enable_kvm },
-#endif
- { "no-reboot", 0, QEMU_OPTION_no_reboot },
- { "no-shutdown", 0, QEMU_OPTION_no_shutdown },
- { "loadvm", HAS_ARG, QEMU_OPTION_loadvm },
- { "daemonize", 0, QEMU_OPTION_daemonize },
- { "option-rom", HAS_ARG, QEMU_OPTION_option_rom },
-#if defined(TARGET_SPARC) || defined(TARGET_PPC)
- { "prom-env", HAS_ARG, QEMU_OPTION_prom_env },
-#endif
- { "clock", HAS_ARG, QEMU_OPTION_clock },
- { "localtime", 0, QEMU_OPTION_localtime },
- { "startdate", HAS_ARG, QEMU_OPTION_startdate },
- { "icount", HAS_ARG, QEMU_OPTION_icount },
- { "echr", HAS_ARG, QEMU_OPTION_echr },
- { "virtioconsole", HAS_ARG, QEMU_OPTION_virtiocon },
- { "show-cursor", 0, QEMU_OPTION_show_cursor },
-#if defined(TARGET_ARM) || defined(TARGET_M68K)
- { "semihosting", 0, QEMU_OPTION_semihosting },
-#endif
-#if defined(TARGET_ARM)
- { "old-param", 0, QEMU_OPTION_old_param },
-#endif
- { "tb-size", HAS_ARG, QEMU_OPTION_tb_size },
- { "incoming", HAS_ARG, QEMU_OPTION_incoming },
- { "chroot", HAS_ARG, QEMU_OPTION_chroot },
- { "runas", HAS_ARG, QEMU_OPTION_runas },
+#define DEF(option, opt_arg, opt_enum, opt_help) \
+ { option, opt_arg, opt_enum },
+#define DEFHEADING(text)
+#include "qemu-options.h"
+#undef DEF
+#undef DEFHEADING
+#undef GEN_DOCS
{ NULL },
};
@@ -5038,15 +4660,18 @@
case QEMU_OPTION_S:
autostart = 0;
break;
+#ifndef _WIN32
case QEMU_OPTION_k:
keyboard_layout = optarg;
break;
+#endif
case QEMU_OPTION_localtime:
rtc_utc = 0;
break;
case QEMU_OPTION_vga:
select_vgahw (optarg);
break;
+#if defined(TARGET_PPC) || defined(TARGET_SPARC)
case QEMU_OPTION_g:
{
const char *p;
@@ -5081,6 +4706,7 @@
graphic_depth = depth;
}
break;
+#endif
case QEMU_OPTION_echr:
{
char *r;
@@ -5191,12 +4817,14 @@
case QEMU_OPTION_vnc:
vnc_display = optarg;
break;
+#ifdef TARGET_I386
case QEMU_OPTION_no_acpi:
acpi_enabled = 0;
break;
case QEMU_OPTION_no_hpet:
no_hpet = 1;
break;
+#endif
case QEMU_OPTION_no_reboot:
no_reboot = 1;
break;
@@ -5213,9 +4841,11 @@
exit(1);
}
break;
+#ifndef _WIN32
case QEMU_OPTION_daemonize:
daemonize = 1;
break;
+#endif
case QEMU_OPTION_option_rom:
if (nb_option_roms >= MAX_OPTION_ROMS) {
fprintf(stderr, "Too many option ROMs\n");
@@ -5224,9 +4854,11 @@
option_rom[nb_option_roms] = optarg;
nb_option_roms++;
break;
+#if defined(TARGET_ARM) || defined(TARGET_M68K)
case QEMU_OPTION_semihosting:
semihosting_enabled = 1;
break;
+#endif
case QEMU_OPTION_name:
qemu_name = optarg;
break;
@@ -5302,12 +4934,14 @@
case QEMU_OPTION_incoming:
incoming = optarg;
break;
+#ifndef _WIN32
case QEMU_OPTION_chroot:
chroot_dir = optarg;
break;
case QEMU_OPTION_runas:
run_as = optarg;
break;
+#endif
}
}
}
| [Prev in Thread] |
Current Thread |
[Next in Thread] |
- [Qemu-devel] [6884] Syncing documentation vs.,
Blue Swirl <=