[12/13] Documentation for iucv bus.

[Cornelia Huck]

[12/13] Documentation for iucv bus.

Document the properties for iucv devices.

 hal-spec.xml.in |   69 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 files changed, 69 insertions(+)

Index: doc/spec/hal-spec.xml.in
===================================================================
RCS file: /cvs/hal/hal/doc/spec/hal-spec.xml.in,v
retrieving revision 1.38
diff -u -r1.38 hal-spec.xml.in
--- doc/spec/hal-spec.xml.in	24 Mar 2005 01:15:31 -0000	1.38
+++ doc/spec/hal-spec.xml.in	23 Jun 2005 13:59:56 -0000
@@ -2085,6 +2085,75 @@
       </informaltable>
     </sect2>
 
+    <sect2 id="device-properties-iucv">
+      <title><literal>iucv</literal> namespace</title>
+
+      <para>
+
+	Device objects with <literal>info.bus</literal> set to <literal>iucv
+	</literal> are using the "Intra-User Comminication Vehicle" and are
+	described by the following properties.
+
+      </para>
+
+      <informaltable>
+        <tgroup cols="2">
+          <thead>
+            <row>
+              <entry>Key (type)</entry>
+              <entry>Values</entry>
+              <entry>Mandatory</entry>
+              <entry>Description</entry>
+            </row>
+          </thead>
+          <tbody>
+
+            <row>
+              <entry><literal>iucv.bus_id</literal> (string)</entry>
+              <entry>example: netiucv0</entry>
+              <entry>Yes</entry>
+              <entry>The device's bus id in sysfs</entry>
+            </row>
+
+          </tbody>
+        </tgroup>
+      </informaltable>
+      <para>
+
+      The following properties describe <literal>iucv</literal> devices
+      where <literal>linux.driver</literal> is <literal>netiucv</literal>.
+
+      </para>
+
+      <informaltable>
+        <tgroup cols="2">
+          <thead>
+            <row>
+              <entry>Key (type)</entry>
+              <entry>Values</entry>
+              <entry>Mandatory</entry>
+              <entry>Description</entry>
+            </row>
+          </thead>
+          <tbody>
+
+            <row>
+              <entry><literal>iucv.netiucv.user</literal> (string) </entry>
+              <entry>example: linux12</entry>
+              <entry>Yes</entry>
+              <entry>The guest name of the connection's target</entry>
+            </row>
+            <row>
+              <entry><literal>iucv.netiucv.buffer</literal> (int) </entry>
+              <entry>example: 32768</entry>
+              <entry>Yes</entry>
+              <entry>The maximum buffer size of the connection</entry>
+            </row>
+
+          </tbody>
+        </tgroup>
+      </informaltable>
+    </sect2>
 
     <sect2 id="device-properties-block">
       <title><literal>block</literal> namespace</title>
_______________________________________________
hal mailing list
hal at lists.freedesktop.org
http://lists.freedesktop.org/mailman/listinfo/hal