From 864e9457cad0e341444499b12cecb03067735639 Mon Sep 17 00:00:00 2001 From: Eric Blake Date: Wed, 6 Jul 2011 13:49:28 -0600 Subject: [PATCH] docs: minor whitespace cleanups No change in wording. One spacing change in a 
, noticed because
of odd XML formatting online; the rest is in free-flowing text to
make it easier to see nesting levels in the document.

* docs/formatdomain.html.in: Adjust spacing.  Break long lines.
---
 docs/formatdomain.html.in | 195 ++++++++++++++++++++++----------------
 1 file changed, 112 insertions(+), 83 deletions(-)

diff --git a/docs/formatdomain.html.in b/docs/formatdomain.html.in
index fe8d74cc05..10d87a9bb6 100644
--- a/docs/formatdomain.html.in
+++ b/docs/formatdomain.html.in
@@ -46,7 +46,8 @@
       
uuid

       
The content of the uuid element provides
         a globally unique identifier for the virtual machine.
-        The format must be RFC 4122 compliant, eg 3e3fce45-4f53-4fa7-bb32-11f34168b82b.
+        The format must be RFC 4122 compliant,
+        eg 3e3fce45-4f53-4fa7-bb32-11f34168b82b.
         If omitted when defining/creating a new machine, a random
         UUID is generated. It is also possible to provide the UUID
         via a sysinfo
@@ -96,13 +97,16 @@
         on bare metal, so requires full virtualization. linux
         (badly named!) refers to an OS that supports the Xen 3 hypervisor
         guest ABI. There are also two optional attributes, arch
-        specifying the CPU architecture to virtualization, and machine
-        referring to the machine type. The Capabilities XML
-        provides details on allowed values for these. Since 0.0.1

+        specifying the CPU architecture to virtualization,
+        and machine referring to the machine
+        type. The Capabilities XML
+        provides details on allowed values for
+        these. Since 0.0.1
       
loader

       
The optional loader tag refers to a firmware blob
         used to assist the domain creation process. At this time, it is
-        only needed by Xen fully virtualized domains. Since 0.1.0

+        only needed by Xen fully virtualized
+        domains. Since 0.1.0
       
boot

       
The dev attribute takes one of the values "fd", "hd",
         "cdrom" or "network" and is used to specify the next boot device
@@ -296,7 +300,7 @@
     <shares>2048</shares>
   </cputune>
   <numatune>
-  <memory mode="strict" nodeset="1-4,^3"/>
+    <memory mode="strict" nodeset="1-4,^3"/>
   </numatune>
   ...
@@ -372,7 +376,8 @@ physical CPUS the domain VCPU will be pinned to. If this is ommited, each VCPU pinned to all the physical CPUS by default. It contains two required attributes, the attribute vcpu specifies vcpu id, - and the attribute cpuset is same as attribute cpuset + and the attribute cpuset is same as + attribute cpuset of element vcpu. (NB: Only qemu driver support) Since 0.9.0 @@ -380,8 +385,9 @@
The optional shares element specifies the proportional weighted share for the domain. If this is ommited, it defaults to - the OS provided defaults. NB, There is no unit for the value, it's a relative - measure based on the setting of other VM, e.g. A VM configured with value + the OS provided defaults. NB, There is no unit for the value, + it's a relative measure based on the setting of other VM, + e.g. A VM configured with value 2048 will get twice as much CPU time as a VM configured with value 1024. Since 0.9.0
@@ -395,7 +401,8 @@
The optional memory element specify how to allocate memory for the domain process on a NUMA host. It contains two attributes, - attribute mode is either 'interleave', 'strict', or 'preferred', + attribute mode is either 'interleave', 'strict', + or 'preferred', attribute nodeset specifies the NUMA nodes, it leads same syntax with attribute cpuset of element vcpu. Since 0.9.3 @@ -825,12 +832,14 @@ to connect. Since 0.0.3
target
-
The target element controls the bus / device under which the - disk is exposed to the guest OS. The dev attribute indicates - the "logical" device name. The actual device name specified is not guaranteed to map to - the device name in the guest OS. Treat it as a device ordering hint. - The optional bus attribute specifies the type of disk device - to emulate; possible values are driver specific, with typical values being +
The target element controls the bus / device + under which the disk is exposed to the guest + OS. The dev attribute indicates the "logical" + device name. The actual device name specified is not + guaranteed to map to the device name in the guest OS. Treat it + as a device ordering hint. The optional bus + attribute specifies the type of disk device to emulate; + possible values are driver specific, with typical values being "ide", "scsi", "virtio", "xen" or "usb". If omitted, the bus type is inferred from the style of the device name. eg, a device named 'sda' will typically be exported using a SCSI bus. @@ -905,7 +914,8 @@
serial
If present, this specify serial number of virtual hard drive. - For example, it may look as <serial>WD-WMAP9A966149</serial>. + For example, it may look + like <serial>WD-WMAP9A966149</serial>. Since 0.7.1
host
@@ -1146,7 +1156,8 @@

USB and PCI devices

- USB and PCI devices attached to the host can be passed through to the guest using + USB and PCI devices attached to the host can be passed through + to the guest using the hostdev element. since after 0.4.4 for USB and 0.6.0 for PCI (KVM only):

@@ -1774,12 +1785,12 @@ qemu-kvm -net nic,model=? /dev/null ...

- If no target is specified, certain hypervisors will automatically - generate a name for the created tun device. This name can be manually - specifed, however the name must not start with either 'vnet' or - 'vif', which are prefixes reserved by libvirt and certain - hypervisors. Manually specified targets using these prefixes will be - ignored. + If no target is specified, certain hypervisors will + automatically generate a name for the created tun device. This + name can be manually specifed, however the name must not + start with either 'vnet' or 'vif', which are prefixes + reserved by libvirt and certain hypervisors. Manually specified + targets using these prefixes will be ignored.

Specifying boot order
@@ -1808,9 +1819,10 @@ qemu-kvm -net nic,model=? /dev/null

Input devices

- Input devices allow interaction with the graphical framebuffer in the guest - virtual machine. When enabling the framebuffer, an input device is automatically - provided. It may be possible to add additional devices explicitly, for example, + Input devices allow interaction with the graphical framebuffer + in the guest virtual machine. When enabling the framebuffer, an + input device is automatically provided. It may be possible to + add additional devices explicitly, for example, to provide a graphics tablet for absolute cursor movement.

@@ -1823,8 +1835,9 @@ qemu-kvm -net nic,model=? /dev/null
input
-
The input element has one mandatory attribute, the type - whose value can be either 'mouse' or 'tablet'. The latter provides absolute +
The input element has one mandatory attribute, + the type whose value can be either 'mouse' or + 'tablet'. The latter provides absolute cursor movement, while the former uses relative movement. The optional bus attribute can be used to refine the exact device type. It takes values "xen" (paravirtualized), "ps2" and "usb".
@@ -1858,56 +1871,67 @@ qemu-kvm -net nic,model=? /dev/null
graphics
The graphics element has a mandatory type - attribute which takes the value "sdl", "vnc", "rdp" or "desktop": + attribute which takes the value "sdl", "vnc", "rdp" or "desktop":
"sdl"
- This displays a window on the host desktop, it can take 3 optional arguments: - a display attribute for the display to use, an xauth - attribute for the authentication identifier, and an optional fullscreen - attribute accepting values 'yes' or 'no'. + This displays a window on the host desktop, it can take 3 + optional arguments: a display attribute for + the display to use, an xauth attribute for + the authentication identifier, and an + optional fullscreen attribute accepting + values 'yes' or 'no'.
"vnc"
- Starts a VNC server. The port attribute specifies the TCP - port number (with -1 as legacy syntax indicating that it should be - auto-allocated). The autoport attribute is the new - preferred syntax for indicating autoallocation of the TCP port to use. - The listen attribute is an IP address for the server to - listen on. The passwd attribute provides a VNC password - in clear text. The keymap attribute specifies the keymap - to use. It is possible to set a limit on the validity of the password - be giving an timestamp passwdValidTo='2010-04-09T15:51:00' - assumed to be in UTC. NB, this may not be supported by all hypervisors.
-
- Rather than using listen/port, QEMU supports a socket - attribute for listening on a unix domain socket path. - Since 0.8.8 + Starts a VNC server. The port attribute + specifies the TCP port number (with -1 as legacy syntax + indicating that it should be + auto-allocated). The autoport attribute is + the new preferred syntax for indicating autoallocation of + the TCP port to use. The listen attribute is + an IP address for the server to listen + on. The passwd attribute provides a VNC + password in clear text. The keymap attribute + specifies the keymap to use. It is possible to set a limit + on the validity of the password be giving an + timestamp passwdValidTo='2010-04-09T15:51:00' + assumed to be in UTC. NB, this may not be supported by all + hypervisors.

Rather than using listen/port, + QEMU supports a socket attribute for + listening on a unix domain socket + path.Since 0.8.8
"spice"

- Starts a SPICE server. The port attribute specifies the TCP - port number (with -1 as legacy syntax indicating that it should be - auto-allocated), while tlsPort gives an alternative - secure port number. The autoport attribute is the new - preferred syntax for indicating autoallocation of both port numbers. - The listen attribute is an IP address for the server to - listen on. The passwd attribute provides a SPICE password - in clear text. The keymap attribute specifies the keymap - to use. It is possible to set a limit on the validity of the password - be giving an timestamp passwdValidTo='2010-04-09T15:51:00' - assumed to be in UTC. NB, this may not be supported by all hypervisors. - "spice" since 0.8.6. + Starts a SPICE server. The port attribute + specifies the TCP port number (with -1 as legacy syntax + indicating that it should be auto-allocated), + while tlsPort gives an alternative secure + port number. The autoport attribute is the + new preferred syntax for indicating autoallocation of + both port numbers. The listen attribute is + an IP address for the server to listen + on. The passwd attribute provides a SPICE + password in clear text. The keymap + attribute specifies the keymap to use. It is possible to + set a limit on the validity of the password be giving an + timestamp passwdValidTo='2010-04-09T15:51:00' + assumed to be in UTC. NB, this may not be supported by + all hypervisors."spice" since 0.8.6.

- When SPICE has both a normal and TLS secured TCP port configured, it - can be desirable to restrict what channels can be run on each port. - This is achieved by adding one or more <channel> elements inside - the main <graphics> element. Valid channel names include - main, display, inputs, - cursor, playback, record; - and since 0.8.8: smartcard. + When SPICE has both a normal and TLS secured TCP port + configured, it can be desirable to restrict what + channels can be run on each port. This is achieved by + adding one or more <channel> elements inside the + main <graphics> element. Valid channel names + include main, display, + inputs, cursor, + playback, record; + and since + 0.8.8: smartcard. 

   <graphics type='spice' port='-1' tlsPort='-1' autoport='yes'>
@@ -1951,23 +1975,27 @@ qemu-kvm -net nic,model=? /dev/null
"rdp"
- Starts a RDP server. The port attribute - specifies the TCP port number (with -1 as legacy syntax indicating - that it should be auto-allocated). The autoport attribute - is the new preferred syntax for indicating autoallocation of the TCP - port to use. The replaceUser attribute is a boolean deciding - whether multiple simultaneous connections to the VM are permitted. - The multiUser whether the existing connection must be dropped - and a new connection must be established by the VRDP server, when a new - client connects in single connection mode. - + Starts a RDP server. The port attribute + specifies the TCP port number (with -1 as legacy syntax + indicating that it should be + auto-allocated). The autoport attribute is + the new preferred syntax for indicating autoallocation of + the TCP port to use. The replaceUser + attribute is a boolean deciding whether multiple + simultaneous connections to the VM are permitted. + The multiUser whether the existing connection + must be dropped and a new connection must be established + by the VRDP server, when a new client connects in single + connection mode.
"desktop"
- This value is reserved for VirtualBox domains for the moment. It displays - a window on the host desktop, similarly to "sdl", but using the VirtualBox - viewer. Just like "sdl", it accepts the optional attributes display - and fullscreen. + This value is reserved for VirtualBox domains for the + moment. It displays a window on the host desktop, + similarly to "sdl", but using the VirtualBox viewer. Just + like "sdl", it accepts the optional + attributes display + and fullscreen.
@@ -2389,8 +2417,9 @@ qemu-kvm -net nic,model=? /dev/null ...

- Alternatively you can use telnet instead of raw TCP. - Since 0.8.5 you can also use telnets + Alternatively you can use telnet instead + of raw TCP. Since 0.8.5 + you can also use telnets (secure telnet) and tls.