Add documentation for yard2

2016-08-16 22:54:21 +02:00
parent 72e27fc718
commit d24f73374c
5 changed files with 36 additions and 0 deletions
@@ -52,6 +52,7 @@ EXTRA_DIST =	bayrad.docbook \
 		tyan.docbook \
 		ula200.docbook \
 		vlsys_m428.docbook \
+		yard2.docbook \
 		xosd.docbook

 ## EOF
@@ -0,0 +1,30 @@
+<sect1 id="yard2-howto">
+<title>The yard2 driver</title>
+
+<sect2 id="yard2-general">
+<title>General</title>
+
+<para>
+The yard2 driver handles the yard2 LCD device.
+The driver functionality is currently limited to character LCD.
+</para>
+
+<para>
+This driver writes via socket to yard2srvd deamon.
+</para>
+
+<para>
+The yard2 driver assumes the character encoding ISO 8859-1.
+</para>
+</sect2>
+
+<sect2 id="yard2-configuration">
+<title>Configuration</title>
+
+<para>
+The only configuration parameter is <property>Size</property>.
+All other settings are done in yard2srvd daemon.
+</para>
+</sect2>
+
+</sect1>