diff --git a/docs/formatdomain.html.in b/docs/formatdomain.html.in index 72bd7b9266..be35ad0fe7 100644 --- a/docs/formatdomain.html.in +++ b/docs/formatdomain.html.in @@ -789,28 +789,87 @@ qemu-kvm -net nic,model=? /dev/null </devices> </domain> +
+ In each of these directives, the top-level element name (parallel, serial,
+ console, channel) describes how the device is presented to the guest. The
+ guest interface is configured by the target
element.
+
parallel
serial
console
source
source
element
- vary according to the type
attribute on the parent
- tag. Allowed variations will be described belowtarget
port
attribute, numbered starting from 1. There is
- usually only one console device, and 0, 1 or 2 serial devices
- or parallel devices.
-
+ The interface presented to the host is given in the type
+ attribute of the top-level element. The host interface is
+ configured by the source
element.
+
+ A character device presents itself to the guest as one of the following + types. +
+ ++ ... + <parallel type='pty'> + <source path='/dev/pts/2'/> + <target port='0'/> + </parallel> + ...+ +
+ target
can have a port
attribute, which
+ specifies the port number. Ports are numbered starting from 1. There are
+ usually 0, 1 or 2 parallel ports.
+
+ ... + <serial type='pty'> + <source path='/dev/pts/3'/> + <target port='0'/> + </serial> + ...+ +
+ target
can have a port
attribute, which
+ specifies the port number. Ports are numbered starting from 1. There are
+ usually 0, 1 or 2 serial ports.
+
+ This represents the primary console. This can be the paravirtualized + console with Xen guests, or duplicates the primary serial port for fully + virtualized guests without a paravirtualized console. +
+ ++ ... + <console type='pty'> + <source path='/dev/pts/4'/> + <target port='0'/> + </console> + ...+ +
+ If the console is presented as a serial port, the target
+ element has the same attributes as for a serial port. There is usually
+ only 1 console.
+
+ A character device presents itself to the host as one of the following + types. +
+ +This disables all input on the character device, and sends output @@ -825,7 +884,7 @@ qemu-kvm -net nic,model=? /dev/null ... -
A file is opened and all data sent to the character @@ -840,7 +899,7 @@ qemu-kvm -net nic,model=? /dev/null </serial> ... -
Connects the character device to the graphical framebuffer in @@ -855,7 +914,7 @@ qemu-kvm -net nic,model=? /dev/null </serial> ... -
Connects the character device to the void. No data is ever @@ -869,7 +928,7 @@ qemu-kvm -net nic,model=? /dev/null </serial> ... -
A Pseudo TTY is allocated using /dev/ptmx. A suitable client @@ -892,7 +951,7 @@ qemu-kvm -net nic,model=? /dev/null with existing syntax for <console> tags.
-The character device is passed through to the underlying @@ -910,7 +969,7 @@ qemu-kvm -net nic,model=? /dev/null </serial> ... -
The character device writes output to a named pipe. See pipe(7) for @@ -925,7 +984,7 @@ qemu-kvm -net nic,model=? /dev/null </serial> ... -
The character device acts as a TCP client connecting to a @@ -973,7 +1032,7 @@ qemu-kvm -net nic,model=? /dev/null </serial> ... -
The character device acts as a UDP netconsole service, @@ -989,7 +1048,7 @@ qemu-kvm -net nic,model=? /dev/null </serial> ... -
The character device acts as a UNIX domain socket server,