[libvirt] [PATCH 2/2] Add documentation for <channel> domain element
* src/formatdomain.html.in: Add <channel>
---
docs/formatdomain.html.in | 40 +++++++++++++++++++++++++++++++++++++---
1 files changed, 37 insertions(+), 3 deletions(-)
diff --git a/docs/formatdomain.html.in b/docs/formatdomain.html.in
index be35ad0..52889af 100644
--- a/docs/formatdomain.html.in
+++ b/docs/formatdomain.html.in
@@ -764,12 +764,12 @@ qemu-kvm -net nic,model=? /dev/null
</dl>
- <h4><a name="elementsConsole">Consoles, serial &
parallel devices</a></h4>
+ <h4><a name="elementsConsole">Consoles, serial, parallel
& channel devices</a></h4>
<p>
A character device provides a way to interact with the virtual machine.
- Paravirtualized consoles, serial ports and parallel ports are all
- classed as character devices and so represented using the same syntax.
+ Paravirtualized consoles, serial ports, parallel ports and channels are
+ all classed as character devices and so represented using the same syntax.
</p>
<pre>
@@ -786,6 +786,10 @@ qemu-kvm -net nic,model=? /dev/null
<source path='/dev/pts/4'/>
<target port='0'/>
</console>
+ <channel type='unix'>
+ <source mode='bind' path='/tmp/guestfwd'/>
+ <target type='guestfwd' address='10.0.2.1'
port='4600'/>
+ </channel>
</devices>
</domain></pre>
@@ -862,6 +866,36 @@ qemu-kvm -net nic,model=? /dev/null
only 1 console.
</p>
+ <h6><a name="elementCharChannel">Channel</a></h6>
+
+ <p>
+ This represents a private communication channel between the host and the
+ guest.
+ </p>
+
+ <pre>
+ ...
+ <channel type='unix'>
+ <source mode='bind' path='/tmp/guestfwd'/>
+ <target type='guestfwd' address='10.0.2.1'
port='4600'/>
+ </channel>
+ ...</pre>
+
+ <p>
+ This can be implemented in a variety of ways. The specific type of
+ channel is given in the <code>type</code> attribute of the
+ <code>target</code> element. Different channel types have different
+ <code>target</code> attributes.
+ </p>
+
+ <dl>
+ <dt><code>guestfwd</code></dt>
+ <dd>TCP traffic sent by the guest to a given IP address and port is
+ forwarded to the channel device on the host. The <code>target</code>
+ element must have <code>address</code> and
<code>port</code> attributes.
+ <span class="since">Since 0.7.3</span></dd>
+ </dl>
+
<h5><a name="elementsCharHostInterface">Host
interface</a></h5>
<p>
--
1.6.2.5