From: Guido Günther <agx@sigxcpu.org>
Date: Fri, 24 Jul 2009 20:16:51 +0000 (+0200)
Subject: document tcp listen and raw wire option
X-Git-Url: http://xenbits.xensource.com/gitweb?a=commitdiff_plain;h=2348cf20e71b292b7c93ea756ee6799f65ab151f;p=libvirt.git

document tcp listen and raw wire option
---

diff --git a/docs/formatdomain.html.in b/docs/formatdomain.html.in
index 191b03e541..eb1278413d 100644
--- a/docs/formatdomain.html.in
+++ b/docs/formatdomain.html.in
@@ -858,13 +858,45 @@ qemu-kvm -net nic,model=? /dev/null
 
     <p>
       The character device acts as a TCP client connecting to a
-      remote server, or as a server waiting for a client connection.
+      remote server.
     </p>
 
     <pre>
       ...
       &lt;serial type="tcp"&gt;
         &lt;source mode="connect" host="0.0.0.0" service="2445"/&gt;
+        &lt;protocol type="raw"/&gt;
+        &lt;target port="1"/&gt;
+      &lt;/serial&gt;
+      ...</pre>
+
+    <p>
+      Or as a TCP server waiting for a client connection.
+    </p>
+
+    <pre>
+      ...
+      &lt;serial type="tcp"&gt;
+        &lt;source mode="bind" host="127.0.0.1" service="2445"/&gt;
+        &lt;protocol type="raw"/&gt;
+        &lt;target port="1"/&gt;
+      &lt;/serial&gt;
+      ...</pre>
+
+    <p>
+      Alternatively you can use telnet instead of raw TCP.
+    <p>
+
+    <pre>
+      ...
+      &lt;serial type="tcp"&gt;
+        &lt;source mode="connect" host="0.0.0.0" service="2445"/&gt;
+        &lt;protocol type="telnet"/&gt;
+        &lt;target port="1"/&gt;
+      &lt;/serial&gt;
+      ...
+      &lt;serial type="tcp"&gt;
+        &lt;source mode="bind" host="127.0.0.1" service="2445"/&gt;
         &lt;protocol type="telnet"/&gt;
         &lt;target port="1"/&gt;
       &lt;/serial&gt;