Replace <term><command><arg> with <term><property><parameter> to describe
options in the config file because: * <arg> can only be used within <cmdsynopsis>. * <cmdsynopsis> does not allow text outside <command> and <arg>. * <arg> does not allow decorating elements like <literal> or <emphasis>. This fixes #2803057. Add shortcut entities for commonly used parameters (yes/no, size). Remove Debian patch which is obsoleted by above changes.
This commit is contained in:
mmdolze
@@ -2,50 +2,59 @@
|
||||
<title>The Eyebox One Driver (EyeboxOne)</title>
|
||||
|
||||
<para>
|
||||
This section describes the Eyebox One.
|
||||
</para>
|
||||
This section describes the Eyebox One.
|
||||
</para>
|
||||
|
||||
<sect2 id="eyeboxone-features">
|
||||
<title>Eyebox One LCD Module</title>
|
||||
<para>
|
||||
Eyebox One is a small rackmounted server marketed by Rightvision
|
||||
(<ulink url="http://www.alcateleyebox.rightvision.com/"></ulink>).
|
||||
This server has an LCD module, a keypad, two graphbars and some leds.
|
||||
</para>
|
||||
<para>
|
||||
The LCD is a 20x4 alphanumeric module connected via standard DB-9 cabling and
|
||||
connector.
|
||||
</para>
|
||||
<para>
|
||||
I couldn't find any documentation about it.
|
||||
All I know has been obtained with some reverse engineering.
|
||||
It seems that it can run only at 19.200 baud.
|
||||
Sending ASCII to the module will make it simply display that text at
|
||||
its current cursor position.
|
||||
The module has a built-in BIOS that recognizes commands (sent by transmitting a
|
||||
single-byte "marker" signifying that a command is on the way, followed by
|
||||
the single-byte command character itself along with any parameters, if needed)
|
||||
allowing the programmer to clear the screen, position the cursor anywhere,
|
||||
hide/show the cursor, on/off the backlight, and so on.
|
||||
</para>
|
||||
<para>
|
||||
This module is fast. If updating less than the whole screen, the LCD can
|
||||
update faster than can be seen by the human eye. This, of course,
|
||||
more than meets LCDproc's needs.
|
||||
</para>
|
||||
</sect2>
|
||||
<sect2 id="eyeboxone-special_features">
|
||||
<title>Eyebox One Driver and lcdproc client</title>
|
||||
<para>
|
||||
You can use the two Eyebox One graphbars, one as a free CPU meter, and one as a free RAM meter
|
||||
with lcdproc client (see eyebox.c in lcdproc client sources).
|
||||
|
||||
In order to use it, you must execute ./configure with a special parameter:
|
||||
<command>CPPFLAGS=-DLCDPROC_EYEBOXONE ./configure --enable-drivers=EyeboxOne</command>
|
||||
|
||||
This is only a BETA version modification, take it as a demo...
|
||||
</para>
|
||||
</sect2>
|
||||
<title>Eyebox One LCD Module</title>
|
||||
|
||||
<para>
|
||||
Eyebox One is a small rackmounted server marketed by Rightvision
|
||||
(<ulink url="http://www.alcateleyebox.rightvision.com/"></ulink>).
|
||||
This server has an LCD module, a keypad, two graphbars and some leds.
|
||||
</para>
|
||||
<para>
|
||||
The LCD is a 20x4 alphanumeric module connected via standard DB-9 cabling and
|
||||
connector.
|
||||
</para>
|
||||
<para>
|
||||
I couldn't find any documentation about it.
|
||||
All I know has been obtained with some reverse engineering.
|
||||
It seems that it can run only at 19.200 baud.
|
||||
Sending ASCII to the module will make it simply display that text at
|
||||
its current cursor position.
|
||||
The module has a built-in BIOS that recognizes commands (sent by transmitting a
|
||||
single-byte "marker" signifying that a command is on the way, followed by
|
||||
the single-byte command character itself along with any parameters, if needed)
|
||||
allowing the programmer to clear the screen, position the cursor anywhere,
|
||||
hide/show the cursor, on/off the backlight, and so on.
|
||||
</para>
|
||||
<para>
|
||||
This module is fast. If updating less than the whole screen, the LCD can
|
||||
update faster than can be seen by the human eye. This, of course,
|
||||
more than meets LCDproc's needs.
|
||||
</para>
|
||||
|
||||
</sect2>
|
||||
|
||||
<sect2 id="eyeboxone-special_features">
|
||||
<title>Eyebox One Driver and lcdproc client</title>
|
||||
<para>
|
||||
You can use the two Eyebox One graphbars, one as a free CPU meter, and one as a free RAM meter
|
||||
with lcdproc client (see eyebox.c in lcdproc client sources).
|
||||
</para>
|
||||
|
||||
<para>
|
||||
In order to use it, you must execute ./configure with a special parameter:
|
||||
<command>CPPFLAGS=-DLCDPROC_EYEBOXONE ./configure --enable-drivers=EyeboxOne</command>
|
||||
</para>
|
||||
|
||||
<para>
|
||||
This is only a BETA version modification, take it as a demo...
|
||||
</para>
|
||||
|
||||
</sect2>
|
||||
|
||||
<sect2 id="eyeboxone-copy">
|
||||
<title>Copyright</title>
|
||||
|
||||
@@ -68,8 +77,8 @@ This section has been modified by Cédric TESSIER (http://www.nezetic.info)
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term>
|
||||
<command>Device</command> =
|
||||
<arg choice="plain"><replaceable>DEVICE</replaceable></arg>
|
||||
<property>Device</property> =
|
||||
<parameter><replaceable>DEVICE</replaceable></parameter>
|
||||
</term>
|
||||
<listitem><para>
|
||||
Select the output device to use [default: <filename>/dev/ttyS1</filename>]
|
||||
@@ -78,12 +87,7 @@ This section has been modified by Cédric TESSIER (http://www.nezetic.info)
|
||||
|
||||
<varlistentry>
|
||||
<term>
|
||||
<command>Size</command> =
|
||||
<arg choice="plain">
|
||||
<replaceable>WIDTH</replaceable>
|
||||
<literal>x</literal>
|
||||
<replaceable>HEIGHT</replaceable>
|
||||
</arg>
|
||||
<property>Size</property> = ¶meters.size;
|
||||
</term>
|
||||
<listitem><para>
|
||||
Set the display size [default: <literal>20x4</literal>]
|
||||
@@ -92,13 +96,7 @@ This section has been modified by Cédric TESSIER (http://www.nezetic.info)
|
||||
|
||||
<varlistentry>
|
||||
<term>
|
||||
<command>Backlight</command> =
|
||||
<arg choice="plain">
|
||||
<group choice="req">
|
||||
<arg choice="plain"><literal><emphasis>yes</emphasis></literal></arg>
|
||||
<arg choice="plain"><literal>no</literal></arg>
|
||||
</group>
|
||||
</arg>
|
||||
<property>Backlight</property> = ¶meters.yesdefno;
|
||||
</term>
|
||||
<listitem><para>
|
||||
Switch on the backlight? [default: <literal>yes</literal>; legal: <literal>yes</literal>, <literal>no</literal>]
|
||||
@@ -112,13 +110,7 @@ This section has been modified by Cédric TESSIER (http://www.nezetic.info)
|
||||
|
||||
<varlistentry>
|
||||
<term>
|
||||
<command>Cursor</command> =
|
||||
<arg choice="plain">
|
||||
<group choice="req">
|
||||
<arg choice="plain"><literal>yes</literal></arg>
|
||||
<arg choice="plain"><literal><emphasis>no</emphasis></literal></arg>
|
||||
</group>
|
||||
</arg>
|
||||
<property>Cursor</property> = ¶meters.yesnodef;
|
||||
</term>
|
||||
<listitem><para>
|
||||
Switch on the cursor? [default: <literal>no</literal>; legal: <literal>yes</literal>, <literal>no</literal>]
|
||||
@@ -128,15 +120,13 @@ This section has been modified by Cédric TESSIER (http://www.nezetic.info)
|
||||
|
||||
<varlistentry>
|
||||
<term>
|
||||
<command>Speed</command> =
|
||||
<arg choice="plain">
|
||||
<group choice="req">
|
||||
<arg choice="plain"><literal>1200</literal></arg>
|
||||
<arg choice="plain"><literal>2400</literal></arg>
|
||||
<arg choice="plain"><literal>9600</literal></arg>
|
||||
<arg choice="plain"><literal><emphasis>19200</emphasis></literal></arg>
|
||||
</group>
|
||||
</arg>
|
||||
<property>Speed</property> =
|
||||
{
|
||||
<parameter><literal>1200</literal></parameter> |
|
||||
<parameter><literal>2400</literal></parameter> |
|
||||
<parameter><literal>9600</literal></parameter> |
|
||||
<emphasis><parameter><literal>19200</literal></parameter></emphasis>
|
||||
}
|
||||
</term>
|
||||
<listitem><para>
|
||||
Set the the baud rate to use when communicating with the LCD.
|
||||
@@ -150,28 +140,28 @@ This section has been modified by Cédric TESSIER (http://www.nezetic.info)
|
||||
|
||||
<varlistentry>
|
||||
<term>
|
||||
<command>LeftKey</command> =
|
||||
<arg choice="plain"><replaceable>D</replaceable></arg>
|
||||
<property>LeftKey</property> =
|
||||
<parameter><replaceable>D</replaceable></parameter>
|
||||
</term>
|
||||
<term>
|
||||
<command>RightKey</command> =
|
||||
<arg choice="plain"><replaceable>C</replaceable></arg>
|
||||
<property>RightKey</property> =
|
||||
<parameter><replaceable>C</replaceable></parameter>
|
||||
</term>
|
||||
<term>
|
||||
<command>UpKey</command> =
|
||||
<arg choice="plain"><replaceable>A</replaceable></arg>
|
||||
<property>UpKey</property> =
|
||||
<parameter><replaceable>A</replaceable></parameter>
|
||||
</term>
|
||||
<term>
|
||||
<command>DownKey</command> =
|
||||
<arg choice="plain"><replaceable>B</replaceable></arg>
|
||||
<property>DownKey</property> =
|
||||
<parameter><replaceable>B</replaceable></parameter>
|
||||
</term>
|
||||
<term>
|
||||
<command>EscapeKey</command> =
|
||||
<arg choice="plain"><replaceable>P</replaceable></arg>
|
||||
<property>EscapeKey</property> =
|
||||
<parameter><replaceable>P</replaceable></parameter>
|
||||
</term>
|
||||
<term>
|
||||
<command>EnterKey</command> =
|
||||
<arg choice="plain"><replaceable></replaceable></arg>
|
||||
<property>EnterKey</property> =
|
||||
<parameter><replaceable></replaceable></parameter>
|
||||
</term>
|
||||
<listitem><para>
|
||||
The following table translate from EyeboxOne Key to Logical Key.
|
||||
@@ -181,13 +171,7 @@ This section has been modified by Cédric TESSIER (http://www.nezetic.info)
|
||||
|
||||
<varlistentry>
|
||||
<term>
|
||||
<command>keypad_test_mode</command> =
|
||||
<arg choice="plain">
|
||||
<group choice="req">
|
||||
<arg choice="plain"><literal>yes</literal></arg>
|
||||
<arg choice="plain"><literal><emphasis>no</emphasis></literal></arg>
|
||||
</group>
|
||||
</arg>
|
||||
<property>keypad_test_mode</property> = ¶meters.yesnodef;
|
||||
</term>
|
||||
<listitem><para>
|
||||
You can find out which key of your display sends which
|
||||
|
||||
Reference in New Issue
Block a user