Hi, "make info" gives a warning:
makeinfo /head/qemu-doc.texi -o qemu-doc.info /head/qemu-doc.texi:949: warning: unlikely character , in @var. As I noticed an inconsistent usage of @var in qemu-doc.texi, I did not stop after fixing this warning but re-worked other parts, too. My patch fixes * Warning from makeinfo (see above) * Usage of @var (I hope that I got all places...) * Replace "and and" by just "and" * Added a "." at the end of selected items (in item list where most other items had one, too) Please apply the patch to CVS HEAD. Regards Stefan
Index: qemu-doc.texi =================================================================== RCS file: /sources/qemu/qemu/qemu-doc.texi,v retrieving revision 1.166 diff -u -r1.166 qemu-doc.texi --- qemu-doc.texi 11 Nov 2007 17:56:38 -0000 1.166 +++ qemu-doc.texi 20 Nov 2007 21:38:08 -0000 @@ -199,7 +199,7 @@ @example @c man begin SYNOPSIS -usage: qemu [options] [disk_image] +usage: qemu [options] [EMAIL PROTECTED] @c man end @end example @@ -208,22 +208,22 @@ General options: @table @option [EMAIL PROTECTED] -M machine -Select the emulated machine (@code{-M ?} for list) [EMAIL PROTECTED] -M @var{machine} +Select the emulated @var{machine} (@code{-M ?} for list) [EMAIL PROTECTED] -fda file [EMAIL PROTECTED] -fdb file [EMAIL PROTECTED] -fda @var{file} [EMAIL PROTECTED] -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}). [EMAIL PROTECTED] -hda file [EMAIL PROTECTED] -hdb file [EMAIL PROTECTED] -hdc file [EMAIL PROTECTED] -hdd file [EMAIL PROTECTED] -hda @var{file} [EMAIL PROTECTED] -hdb @var{file} [EMAIL PROTECTED] -hdc @var{file} [EMAIL PROTECTED] -hdd @var{file} Use @var{file} as hard disk 0, 1, 2 or 3 image (@pxref{disk_images}). [EMAIL PROTECTED] -cdrom file -Use @var{file} as CD-ROM image (you cannot use @option{-hdc} and and [EMAIL PROTECTED] -cdrom @var{file} +Use @var{file} as CD-ROM image (you cannot use @option{-hdc} and @option{-cdrom} at the same time). You can use the host CD-ROM by using @file{/dev/cdrom} as filename (@pxref{host_drives}). @@ -240,10 +240,10 @@ Disable boot signature checking for floppy disks in Bochs BIOS. It may be needed to boot from old floppy disks. [EMAIL PROTECTED] -m megs -Set virtual RAM size to @var{megs} megabytes. Default is 128 MB. [EMAIL PROTECTED] -m @var{megs} +Set virtual RAM size to @var{megs} megabytes. Default is 128 MiB. [EMAIL PROTECTED] -smp n [EMAIL PROTECTED] -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. @@ -253,7 +253,7 @@ Will show the audio subsystem help: list of drivers, tunable parameters. [EMAIL PROTECTED] -soundhw card1,card2,... or -soundhw all [EMAIL PROTECTED] -soundhw @var{card1}[,@var{card2},...] or -soundhw all Enable audio and selected sound hardware. Use ? to print all available sound hardware. @@ -270,12 +270,12 @@ time). This option is needed to have correct date in MS-DOS or Windows. [EMAIL PROTECTED] -startdate date [EMAIL PROTECTED] -startdate @var{date} Set the initial date of the real time clock. Valid format for @var{date} are: @code{now} or @code{2006-06-17T16:01:21} or @code{2006-06-17}. The default value is @code{now}. [EMAIL PROTECTED] -pidfile file [EMAIL PROTECTED] -pidfile @var{file} Store the QEMU process PID in @var{file}. It is useful if you launch QEMU from a script. @@ -290,13 +290,14 @@ Windows 2000 is installed, you no longer need this option (this option slows down the IDE transfers). [EMAIL PROTECTED] -option-rom file -Load the contents of file as an option ROM. This option is useful to load -things like EtherBoot. - [EMAIL PROTECTED] -name string -Sets the name of the guest. This name will be display in the SDL window -caption. The name will also be used for the VNC server. [EMAIL PROTECTED] -option-rom @var{file} +Load the contents of @var{file} as an option ROM. +This option is useful to load things like EtherBoot. + [EMAIL PROTECTED] -name @var{name} +Sets the @var{name} of the guest. +This name will be display in the SDL window caption. +The @var{name} will also be used for the VNC server. @end table @@ -320,7 +321,7 @@ @item -full-screen Start in full screen. [EMAIL PROTECTED] -vnc display[,option[,option[,...]]] [EMAIL PROTECTED] -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 @@ -332,18 +333,18 @@ @table @code [EMAIL PROTECTED] @var{interface:d} [EMAIL PROTECTED] @var{interface}:@var{d} TCP connections will only be allowed from @var{interface} on display @var{d}. By convention the TCP port is [EMAIL PROTECTED] Optionally, @var{interface} can be omitted in which case the server will bind to all interfaces. [EMAIL PROTECTED] @var{unix:path} [EMAIL PROTECTED] @var{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. [EMAIL PROTECTED] @var{none} [EMAIL PROTECTED] none VNC is initialized by not started. The monitor @code{change} command can be used to later start the VNC server. @@ -355,31 +356,31 @@ @table @code [EMAIL PROTECTED] @var{password} [EMAIL PROTECTED] password Require that password based authentication is used for client connections. The password must be set separately using the @code{change} command in the @ref{pcsys_monitor} [EMAIL PROTECTED] @var{tls} [EMAIL PROTECTED] 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 @var{x509} or @var{x509verify} options. [EMAIL PROTECTED] @var{x509=/path/to/certificate/dir} [EMAIL PROTECTED] [EMAIL PROTECTED]/path/to/certificate/dir} -Valid if @var{tls} is specified. Require that x509 credentials are used +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. [EMAIL PROTECTED] @var{x509verify=/path/to/certificate/dir} [EMAIL PROTECTED] [EMAIL PROTECTED]/path/to/certificate/dir} -Valid if @var{tls} is specified. Require that x509 credentials are used +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, @@ -392,7 +393,7 @@ @end table [EMAIL PROTECTED] -k language [EMAIL PROTECTED] -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 @@ -417,7 +418,7 @@ @item -usb Enable the USB driver (will be the default soon) [EMAIL PROTECTED] -usbdevice devname [EMAIL PROTECTED] -usbdevice @var{devname} Add the USB device @var{devname}. @xref{usb_devices}. @end table @@ -425,7 +426,7 @@ @table @option [EMAIL PROTECTED] -net nic[,vlan=n][,macaddr=addr][,model=type] [EMAIL PROTECTED] -net nic[,[EMAIL PROTECTED],[EMAIL PROTECTED],[EMAIL PROTECTED] 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. If no @@ -438,17 +439,17 @@ Not all devices are supported on all targets. Use -net nic,model=? for a list of available devices for your target. [EMAIL PROTECTED] -net user[,vlan=n][,hostname=name] [EMAIL PROTECTED] -net user[,[EMAIL PROTECTED],[EMAIL PROTECTED] 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. [EMAIL PROTECTED] -net tap[,vlan=n][,fd=h][,ifname=name][,script=file] [EMAIL PROTECTED] -net tap[,[EMAIL PROTECTED],[EMAIL PROTECTED],[EMAIL PROTECTED],[EMAIL PROTECTED] Connect the host TAP network interface @var{name} to VLAN @var{n} and use the network script @var{file} to configure it. The default network script is @file{/etc/qemu-ifup}. Use @option{script=no} to disable script execution. If @var{name} is not -provided, the OS automatically provides one. @option{fd=h} can be +provided, the OS automatically provides one. @[EMAIL PROTECTED] can be used to specify the handle of an already opened host TAP interface. Example: @example @@ -462,13 +463,13 @@ @end example [EMAIL PROTECTED] -net socket[,vlan=n][,fd=h][,listen=[host]:port][,connect=host:port] [EMAIL PROTECTED] -net socket[,[EMAIL PROTECTED],[EMAIL PROTECTED],[EMAIL PROTECTED]:@var{port}][,[EMAIL PROTECTED]:@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. @option{fd=h} +another QEMU instance using the @option{listen} option. @[EMAIL PROTECTED] specifies an already opened TCP socket. Example: @@ -482,7 +483,7 @@ -net socket,connect=127.0.0.1:1234 @end example [EMAIL PROTECTED] -net socket[,vlan=n][,fd=h][,mcast=maddr:port] [EMAIL PROTECTED] -net socket[,[EMAIL PROTECTED],[EMAIL PROTECTED],[EMAIL PROTECTED]:@var{port}] Create a VLAN @var{n} shared with another QEMU virtual machines using a UDP multicast socket, effectively making a bus for @@ -527,14 +528,14 @@ override the default configuration (@option{-net nic -net user}) which is activated if no @option{-net} options are provided. [EMAIL PROTECTED] -tftp dir [EMAIL PROTECTED] -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 @code{bin} of the Unix TFTP client). The host IP address on the guest is as usual 10.0.2.2. [EMAIL PROTECTED] -bootp file [EMAIL PROTECTED] -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. @@ -544,9 +545,9 @@ qemu -hda linux.img -boot n -tftp /path/to/tftp/files -bootp /pxelinux.0 @end example [EMAIL PROTECTED] -smb dir [EMAIL PROTECTED] -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 @file{dir} +server so that Windows OSes can access to the host files in @[EMAIL PROTECTED] transparently. In the guest Windows OS, the line: @@ -556,13 +557,13 @@ 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 @file{dir} can be accessed in @file{\\smbserver\qemu}. +Then @[EMAIL PROTECTED] can be accessed in @file{\\smbserver\qemu}. Note that a SAMBA server must be installed on the host OS in @file{/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. [EMAIL PROTECTED] -redir [tcp|udp]:host-port:[guest-host]:guest-port [EMAIL PROTECTED] -redir [tcp|udp]:@var{host-port}:[EMAIL PROTECTED]:@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 @@ -600,13 +601,13 @@ @table @option [EMAIL PROTECTED] -kernel bzImage [EMAIL PROTECTED] -kernel @var{bzImage} Use @var{bzImage} as kernel image. [EMAIL PROTECTED] -append cmdline [EMAIL PROTECTED] -append @var{cmdline} Use @var{cmdline} as kernel command line [EMAIL PROTECTED] -initrd file [EMAIL PROTECTED] -initrd @var{file} Use @var{file} as initial ram disk. @end table @@ -614,7 +615,7 @@ Debug/Expert options: @table @option [EMAIL PROTECTED] -serial dev [EMAIL PROTECTED] -serial @var{dev} Redirect the virtual serial port to host character device @var{dev}. The default device is @code{vc} in graphical mode and @code{stdio} in non graphical mode. @@ -644,19 +645,22 @@ @item /dev/XXX [Linux only] Use host tty, e.g. @file{/dev/ttyS0}. The host serial port parameters are set according to the emulated ones. [EMAIL PROTECTED] /dev/parportN [EMAIL PROTECTED] /dev/[EMAIL PROTECTED] [Linux only, parallel port only] Use host parallel port @var{N}. Currently SPP and EPP parallel port features can be used. [EMAIL PROTECTED] file:filename -Write output to filename. No character can be read. [EMAIL PROTECTED] file:@var{filename} +Write output to @var{filename}. No character can be read. @item stdio [Unix only] standard input/output [EMAIL PROTECTED] pipe:filename [EMAIL PROTECTED] pipe:@var{filename} name pipe @var{filename} [EMAIL PROTECTED] COMn [EMAIL PROTECTED] [EMAIL PROTECTED] [Windows only] Use host serial port @var{n} [EMAIL PROTECTED] udp:[remote_host]:remote_port[@@[src_ip]: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. [EMAIL PROTECTED] udp:[EMAIL PROTECTED]:@var{remote_port}[@@[EMAIL PROTECTED]:@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. If you just want a simple readonly console you can use @code{netcat} or @code{nc}, by starting qemu with: @code{-serial udp::4555} and nc as: @@ -682,7 +686,7 @@ @end table [EMAIL PROTECTED] tcp:[host]:port[,server][,nowait][,nodelay] [EMAIL PROTECTED] tcp:[EMAIL PROTECTED]:@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 @@ -701,7 +705,7 @@ -serial tcp:192.168.0.100:4444,server,nowait @end table [EMAIL PROTECTED] telnet:host:port[,server][,nowait][,nodelay] [EMAIL PROTECTED] 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 @@ -710,12 +714,12 @@ sequence. Typically in unix telnet you do it with Control-] and then type "send break" followed by pressing the enter key. [EMAIL PROTECTED] unix:path[,server][,nowait] [EMAIL PROTECTED] 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 @var{path} is used for connections. [EMAIL PROTECTED] mon:dev_string [EMAIL PROTECTED] 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 @key{Control-a} and then pressing @key{c}. See monitor access @@ -729,7 +733,7 @@ @end table [EMAIL PROTECTED] -parallel dev [EMAIL PROTECTED] -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 @@ -740,7 +744,7 @@ Use @code{-parallel none} to disable all parallel ports. [EMAIL PROTECTED] -monitor dev [EMAIL PROTECTED] -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 @@ -761,14 +765,14 @@ @item -s Wait gdb connection to port 1234 (@pxref{gdb_usage}). [EMAIL PROTECTED] -p port [EMAIL PROTECTED] -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). @item -S Do not start CPU at startup (you must type 'c' in the monitor). @item -d Output log in /tmp/qemu.log [EMAIL PROTECTED] -hdachs c,h,s,[,t] [EMAIL PROTECTED] -hdachs @var{c},@var{h},@var{s},[,@var{t}] Force hard disk 0 physical geometry (1 <= @var{c} <= 16383, 1 <= @var{h} <= 16, 1 <= @var{s} <= 63) and optionally force the BIOS translation mode (@var{t}=none, lba or auto). Usually QEMU can guess @@ -879,7 +883,7 @@ @item Remove or insert removable media images -(such as CD-ROM or floppies) +(such as CD-ROM or floppies). @item Freeze/unfreeze the Virtual Machine (VM) and save or restore its state @@ -895,14 +899,14 @@ @table @option [EMAIL PROTECTED] help or ? [cmd] [EMAIL PROTECTED] help or ? [EMAIL PROTECTED] Show the help for all commands or just for command @var{cmd}. @item commit -Commit changes to the disk images (if -snapshot is used) +Commit changes to the disk images (if -snapshot is used). [EMAIL PROTECTED] info subcommand -show various information about the system state [EMAIL PROTECTED] info @var{subcommand} +Show various information about the system state. @table @option @item info network @@ -930,12 +934,12 @@ @item q or quit Quit the emulator. [EMAIL PROTECTED] eject [-f] device [EMAIL PROTECTED] eject [-f] @var{device} Eject a removable medium (use -f to force it). [EMAIL PROTECTED] change device setting [EMAIL PROTECTED] change @var{device} @var{setting} -Change the configuration of a device +Change the configuration of a device. @table @option @item change @var{diskdevice} @var{filename} @@ -945,7 +949,7 @@ (qemu) change cdrom /path/to/some.iso @end example [EMAIL PROTECTED] change vnc @var{display,options} [EMAIL PROTECTED] change vnc @var{display},@var{options} Change the configuration of the VNC server. The valid syntax for @var{display} and @var{options} are described at @ref{sec_invocation}. eg @@ -966,24 +970,24 @@ @end table [EMAIL PROTECTED] screendump filename [EMAIL PROTECTED] screendump @var{filename} Save screen into PPM image @var{filename}. [EMAIL PROTECTED] mouse_move dx dy [dz] [EMAIL PROTECTED] mouse_move @var{dx} @var{dy} [EMAIL PROTECTED] Move the active mouse to the specified coordinates @var{dx} @var{dy} with optional scroll axis @var{dz}. [EMAIL PROTECTED] mouse_button val [EMAIL PROTECTED] mouse_button @var{val} Change the active mouse button state @var{val} (1=L, 2=M, 4=R). [EMAIL PROTECTED] mouse_set index [EMAIL PROTECTED] mouse_set @var{index} Set which mouse device receives events at given @var{index}, index can be obtained with @example info mice @end example [EMAIL PROTECTED] wavcapture filename [frequency [bits [channels]]] [EMAIL PROTECTED] wavcapture @var{filename} [EMAIL PROTECTED] [EMAIL PROTECTED] [EMAIL PROTECTED] Capture audio into @var{filename}. Using sample rate @var{frequency} bits per sample @var{bits} and number of channels @var{channels}. @@ -994,26 +998,26 @@ @item Number of channels = 2 - Stereo @end itemize [EMAIL PROTECTED] stopcapture index [EMAIL PROTECTED] stopcapture @var{index} Stop capture with a given @var{index}, index can be obtained with @example info capture @end example [EMAIL PROTECTED] log item1[,...] [EMAIL PROTECTED] log @var{item1}[,...] Activate logging of the specified items to @file{/tmp/qemu.log}. [EMAIL PROTECTED] savevm [tag|id] [EMAIL PROTECTED] savevm [EMAIL PROTECTED]|@var{id}] Create a snapshot of the whole virtual machine. If @var{tag} is provided, it is used as human readable identifier. If there is already a snapshot with the same tag or ID, it is replaced. More info at @ref{vm_snapshots}. [EMAIL PROTECTED] loadvm tag|id [EMAIL PROTECTED] loadvm @var{tag}|@var{id} Set the whole virtual machine to the snapshot identified by the tag @var{tag} or the unique snapshot ID @var{id}. [EMAIL PROTECTED] delvm tag|id [EMAIL PROTECTED] delvm @var{tag}|@var{id} Delete the snapshot identified by @var{tag} or @var{id}. @item stop @@ -1022,13 +1026,13 @@ @item c or cont Resume emulation. [EMAIL PROTECTED] gdbserver [port] -Start gdbserver session (default port=1234) [EMAIL PROTECTED] gdbserver [EMAIL PROTECTED] +Start gdbserver session (default @var{port}=1234) [EMAIL PROTECTED] x/fmt addr [EMAIL PROTECTED] x/fmt @var{addr} Virtual memory dump starting at @var{addr}. [EMAIL PROTECTED] xp /fmt addr [EMAIL PROTECTED] xp /@var{fmt} @var{addr} Physical memory dump starting at @var{addr}. @var{fmt} is a format which tells the command how to format the @@ -1084,12 +1088,12 @@ @end smallexample @end itemize [EMAIL PROTECTED] p or print/fmt expr [EMAIL PROTECTED] p or print/@var{fmt} @var{expr} Print expression value. Only the @var{format} part of @var{fmt} is used. [EMAIL PROTECTED] sendkey keys [EMAIL PROTECTED] sendkey @var{keys} Send @var{keys} to the emulator. Use @code{-} to press several keys simultaneously. Example: @@ -1104,12 +1108,12 @@ Reset the system. [EMAIL PROTECTED] usb_add devname [EMAIL PROTECTED] usb_add @var{devname} Add the USB device @var{devname}. For details of available devices see @ref{usb_devices} [EMAIL PROTECTED] usb_del devname [EMAIL PROTECTED] usb_del @var{devname} Remove the USB device @var{devname} from the QEMU virtual USB hub. @var{devname} has the syntax @code{bus.addr}. Use the monitor @@ -1263,7 +1267,7 @@ is better to use the @code{change} or @code{eject} monitor commands to change or eject media. @item Hard disks -Hard disks can be used with the syntax: @file{\\.\PhysicalDriveN} +Hard disks can be used with the syntax: @[EMAIL PROTECTED] where @var{N} is the drive number (0 is the first hard disk). WARNING: unless you know what you do, it is better to only make @@ -1458,12 +1462,12 @@ 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. [EMAIL PROTECTED] @code{disk:file} [EMAIL PROTECTED] @code{disk:@var{file}} Mass storage device based on @var{file} (@pxref{disk_images}) [EMAIL PROTECTED] @code{host:bus.addr} [EMAIL PROTECTED] @code{host:@var{bus.addr}} Pass through the host device identified by @var{bus.addr} (Linux only) [EMAIL PROTECTED] @code{host:vendor_id:product_id} [EMAIL PROTECTED] @code{host:@var{vendor_id:product_id}} Pass through the host device identified by @var{vendor_id:product_id} (Linux only) @item @code{wacom-tablet}