mangavalk/lcdproc
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

First round of Docbook updates:

Browse Source 
* Update Docbook to version 4.5
* Fix some errors
This commit is contained in:
mmdolze
2009-06-11 15:34:41 +00:00
parent 986a22afc4
commit 5108e4931e
17 changed files with 223 additions and 288 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/lcdproc-user/configuration.docbook
+87 -160
View File
@@ -44,11 +44,11 @@ When quoted, the following character sequences are evaluated as in literal C str
<informaltable>
<tgroup cols="2">
<thead>
</thead>
<row>
<entry>escape sequence</entry>
<entry>character</entry>
</row>
</thead>
<tbody>
<row>
<entry><literal>\a</literal></entry>
@@ -132,8 +132,8 @@ settings for the LCDproc server <application>LCDd</application>.
<variablelist>
<varlistentry>
<term>
<command>DriverPath</command> =
<arg choice="plain"><replaceable>DRIVERPATH</replaceable></arg>
<property>DriverPath</property> =
<parameter><replaceable>DRIVERPATH</replaceable></parameter>
</term>
<listitem><para>
Tells the server where to look for the driver files.
@@ -147,8 +147,8 @@ settings for the LCDproc server <application>LCDd</application>.
<varlistentry>
<term>
<command>Driver</command> =
<arg choice="plain"><replaceable>DRIVERNAME</replaceable></arg>
<property>Driver</property> =
<parameter><replaceable>DRIVERNAME</replaceable></parameter>
</term>
<listitem>
<para>
@@ -173,8 +173,8 @@ settings for the LCDproc server <application>LCDd</application>.
<varlistentry>
<term>
<command>Bind</command> =
<arg choice="plain"><replaceable>ADDRESS</replaceable></arg>
<property>Bind</property> =
<parameter><replaceable>ADDRESS</replaceable></parameter>
</term>
<listitem>
<para>
@@ -192,8 +192,8 @@ settings for the LCDproc server <application>LCDd</application>.
<varlistentry>
<term>
<command>Port</command> =
<arg choice="plain"><replaceable>PORTNUMBER</replaceable></arg>
<property>Port</property> =
<parameter><replaceable>PORTNUMBER</replaceable></parameter>
</term>
<listitem>
<para>
@@ -209,8 +209,8 @@ settings for the LCDproc server <application>LCDd</application>.
<varlistentry>
<term>
<command>ReportLevel</command> =
<arg choice="plain"><replaceable>LEVEL</replaceable></arg>
<property>ReportLevel</property> =
<parameter><replaceable>LEVEL</replaceable></parameter>
</term>
<listitem>
<para>
@@ -228,13 +228,11 @@ settings for the LCDproc server <application>LCDd</application>.
<varlistentry>
<term>
<command>ReportToSyslog</command> =
<arg choice="plain">
<group choice="req">
<arg choice="plain"><literal><emphasis>no</emphasis></literal></arg>
<arg choice="plain"><literal>yes</literal></arg>
</group>
</arg>
<property>ReportToSyslog</property> =
{
<emphasis><parameter><literal>no</literal></parameter></emphasis> |
<parameter><literal>yes</literal></parameter>
}
</term>
<listitem>
<para>
@@ -261,8 +259,8 @@ settings for the LCDproc server <application>LCDd</application>.
<varlistentry>
<term>
<command>User</command> =
<arg choice="plain"><replaceable>USER</replaceable></arg>
<property>User</property> =
<parameter><replaceable>USER</replaceable></parameter>
</term>
<listitem>
<para>
@@ -278,13 +276,11 @@ settings for the LCDproc server <application>LCDd</application>.
<varlistentry>
<term>
<command>Foreground</command> =
<arg choice="plain">
<group choice="req">
<arg choice="plain"><literal><emphasis>no</emphasis></literal></arg>
<arg choice="plain"><literal>yes</literal></arg>
</group>
</arg>
<property>Foreground</property> =
{
<emphasis><parameter><literal>no</literal></parameter></emphasis> |
<parameter><literal>yes</literal></parameter>
}
</term>
<listitem>
<para>
@@ -301,8 +297,8 @@ settings for the LCDproc server <application>LCDd</application>.
<varlistentry>
<term>
<command>Hello</command> =
<arg choice="plain"><replaceable>HELLOMSG</replaceable></arg>
<property>Hello</property> =
<parameter><replaceable>HELLOMSG</replaceable></parameter>
</term>
<listitem>
<para>
@@ -333,8 +329,8 @@ settings for the LCDproc server <application>LCDd</application>.
<varlistentry>
<term>
<command>GoodBye</command> =
<arg choice="plain"><replaceable>GOODBYEMSG</replaceable></arg>
<property>GoodBye</property> =
<parameter><replaceable>GOODBYEMSG</replaceable></parameter>
</term>
<listitem>
<para>
@@ -366,8 +362,8 @@ settings for the LCDproc server <application>LCDd</application>.
<varlistentry>
<term>
<command>WaitTime</command> =
<arg choice="plain"><replaceable>SECONDS</replaceable></arg>
<property>WaitTime</property> =
<parameter><replaceable>SECONDS</replaceable></parameter>
</term>
<listitem>
<para>
@@ -383,14 +379,12 @@ settings for the LCDproc server <application>LCDd</application>.
<varlistentry>
<term>
<command>ServerScreen</command> =
<arg choice="plain">
<group choice="req">
<arg choice="plain"><literal><emphasis>yes</emphasis></literal></arg>
<arg choice="plain"><literal>no</literal></arg>
<arg choice="plain"><literal>blank</literal></arg>
</group>
</arg>
<property>ServerScreen</property> =
{
<emphasis><parameter><literal>yes</literal></parameter></emphasis> |
<parameter><literal>no</literal></parameter> |
<parameter><literal>blank</literal></parameter>
}
</term>
<listitem>
<para>
@@ -421,14 +415,12 @@ settings for the LCDproc server <application>LCDd</application>.
<varlistentry>
<term>
<command>Backlight</command> =
<arg choice="plain">
<group choice="req">
<arg choice="plain"><literal>off</literal></arg>
<arg choice="plain"><literal><emphasis>open</emphasis></literal></arg>
<arg choice="plain"><literal>on</literal></arg>
</group>
</arg>
<property>Backlight</property> =
{
<parameter><literal>off</literal></parameter> |
<emphasis><parameter><literal>open</literal></parameter></emphasis> |
<parameter><literal>on</literal></parameter>
}
</term>
<listitem><para>
Set the master backlight setting.
@@ -442,14 +434,12 @@ settings for the LCDproc server <application>LCDd</application>.
<varlistentry>
<term>
<command>Heartbeat</command> =
<arg choice="plain">
<group choice="req">
<arg choice="plain"><literal>off</literal></arg>
<arg choice="plain"><literal><emphasis>open</emphasis></literal></arg>
<arg choice="plain"><literal>on</literal></arg>
</group>
</arg>
<property>Heartbeat</property> =
{
<parameter><literal>off</literal></parameter> |
<emphasis><parameter><literal>open</literal></parameter></emphasis> |
<parameter><literal>on</literal></parameter>
}
</term>
<listitem><para>
Set the master heartbeat, the oscillating icon in the top right corner
@@ -463,8 +453,8 @@ settings for the LCDproc server <application>LCDd</application>.
<varlistentry>
<term>
<command>TitleSpeed</command> =
<arg choice="plain"><replaceable>SPEED</replaceable></arg>
<property>TitleSpeed</property> =
<parameter><replaceable>SPEED</replaceable></parameter>
</term>
<listitem><para>
Set the speed how fast over-long title lines shall scroll.
@@ -486,8 +476,8 @@ don't go to any client.
<variablelist>
<varlistentry>
<term>
<command>ToggleRotateKey</command> =
<arg choice="plain"><replaceable>KEY</replaceable></arg>
<property>ToggleRotateKey</property> =
<parameter><replaceable>KEY</replaceable></parameter>
</term>
<listitem><para>
Defaults to <literal>Enter</literal>.
@@ -496,8 +486,8 @@ don't go to any client.
<varlistentry>
<term>
<command>PrevScreenKey</command> =
<arg choice="plain"><replaceable>KEY</replaceable></arg>
<property>PrevScreenKey</property> =
<parameter><replaceable>KEY</replaceable></parameter>
</term>
<listitem><para>
Defaults to <literal>Left</literal>.
@@ -506,8 +496,8 @@ don't go to any client.
<varlistentry>
<term>
<command>NextScreenKey</command> =
<arg choice="plain"><replaceable>KEY</replaceable></arg>
<property>NextScreenKey</property> =
<parameter><replaceable>KEY</replaceable></parameter>
</term>
<listitem><para>
Defaults to <literal>Right</literal>.
@@ -516,8 +506,8 @@ don't go to any client.
<varlistentry>
<term>
<command>ScrollUpKey</command> =
<arg choice="plain"><replaceable>KEY</replaceable></arg>
<property>ScrollUpKey</property> =
<parameter><replaceable>KEY</replaceable></parameter>
</term>
<listitem><para>
Defaults to <literal>Up</literal>.
@@ -526,8 +516,8 @@ don't go to any client.
<varlistentry>
<term>
<command>ScrollDownKey</command> =
<arg choice="plain"><replaceable>KEY</replaceable></arg>
<property>ScrollDownKey</property> =
<parameter><replaceable>KEY</replaceable></parameter>
</term>
<listitem><para>
Defaults to <literal>Down</literal>.
@@ -547,57 +537,6 @@ options related to the way <application>LCDd</application> handles
input "events".
</para>
<!--
<table>
<title>The Standard LCDd Input Keys</title>
<tgroup cols="3">
<thead>
<row>
<entry>Keyname</entry>
<entry>Function</entry>
</row>
<row>
<entry></entry>
<entry>Normal context</entry>
<entry>Menu context</entry>
</row>
</thead>
<tbody>
<row>
<entry>MenuKey</entry>
<entry>Open main menu</entry>
<entry>Exit/Cancel</entry>
</row>
<row>
<entry>EnterKey</entry>
<entry>Toggle Hold/Rotate screens</entry>
<entry>Enter/Select</entry>
</row>
<row>
<entry>UpKey</entry>
<entry>Back (Go to previous screen)</entry>
<entry>Up/Left</entry>
</row>
<row>
<entry>DownKey</entry>
<entry>Forward (Go to next screen)</entry>
<entry>Down/Right</entry>
</row>
<row>
<entry>LeftKey</entry>
<entry>Back (Go to previous screen)</entry>
<entry>Left</entry>
</row>
<row>
<entry>RightKey</entry>
<entry>Forward (Go to next screen)</entry>
<entry>Right</entry>
</row>
</tbody>
</tgroup>
</table>
-->
<para>
The menu is a special LCDproc client built into <application>LCDd</application>
that allows changing server and display settings as well as extending it
@@ -611,8 +550,8 @@ You can configure what keys the menu should use.
<variablelist>
<varlistentry>
<term>
<command>MenuKey</command> =
<arg choice="plain"><replaceable>KEY</replaceable></arg>
<property>MenuKey</property> =
<parameter><replaceable>KEY</replaceable></parameter>
</term>
<listitem>
<para>
@@ -621,18 +560,18 @@ You can configure what keys the menu should use.
means returning to the regular display mode.
It has no default, but a natural candidate is <literal>Menu</literal>.
</para>
<note>
<note><para>
The <literal>MenuKey</literal> will be reserved exclusively,
while the others work in shared mode and can thus be used by a
client application when not in the menu.
</note>
</para></note>
</listitem>
</varlistentry>
<varlistentry>
<term>
<command>EnterKey</command> =
<arg choice="plain"><replaceable>KEY</replaceable></arg>
<property>EnterKey</property> =
<parameter><replaceable>KEY</replaceable></parameter>
</term>
<listitem><para>
The key to enter a sub menu, to select an entry and/or
@@ -648,8 +587,8 @@ You can configure what keys the menu should use.
<varlistentry>
<term>
<command>UpKey</command> =
<arg choice="plain"><replaceable>KEY</replaceable></arg>
<property>UpKey</property> =
<parameter><replaceable>KEY</replaceable></parameter>
</term>
<listitem><para>
The key to move to the previous item in a menu and/or to select
@@ -663,8 +602,8 @@ You can configure what keys the menu should use.
<varlistentry>
<term>
<command>DownKey</command> =
<arg choice="plain"><replaceable>KEY</replaceable></arg>
<property>DownKey</property> =
<parameter><replaceable>KEY</replaceable></parameter>
</term>
<listitem><para>
The key to move to the next item in a menu andi/or to select
@@ -678,8 +617,8 @@ You can configure what keys the menu should use.
<varlistentry>
<term>
<command>LeftKey</command> =
<arg choice="plain"><replaceable>KEY</replaceable></arg>
<property>LeftKey</property> =
<parameter><replaceable>KEY</replaceable></parameter>
</term>
<listitem><para>
If defined, this optional key is used to
@@ -691,8 +630,8 @@ You can configure what keys the menu should use.
<varlistentry>
<term>
<command>RightKey</command> =
<arg choice="plain"><replaceable>KEY</replaceable></arg>
<property>RightKey</property> =
<parameter><replaceable>KEY</replaceable></parameter>
</term>
<listitem><para>
If defined, this optional key is used to to move right in input fields.
@@ -766,7 +705,7 @@ Refer to your system's manual on how to install the scripts.
<title>init-LCDd</title>
<para>
The file <filename>scripts/init-LCDd.*</filename> is the init script for the
LCDproc server LCDd. It does not require modification.
LCDproc server <application>LCDd</application>. It does not require modification.
</para>
</sect2>
@@ -774,7 +713,7 @@ LCDproc server LCDd. It does not require modification.
<title>init-lcdproc</title>
<para>
The file <filename>scripts/init-lcdproc.*</filename> is the init script for the
LCDproc "main" client lcdproc.
LCDproc "main" client <application>lcdproc</application>.
</para>
<note>
@@ -783,35 +722,23 @@ You can retrieve a listing of all options of lcdproc running <command>lcdproc --
</para>
</note>
<!--
</sect2>
<sect2 id="init-lcdexec">
<title>init-lcdexec</title>
<para>
The lcdproc init script retrieves the options it will pass to lcdproc from the file
<filename>/etc/lcdproc.conf</filename> (<filename>scripts/lcdproc.conf</filename> in the
sources distribution).
The file <filename>scripts/init-lcdexec.*</filename> is the init script for the
LCDproc <application>lcdexec</application> client, which can execute predefined
commands via the menu feature.
</para>
</sect2>
<example>
<title><filename>lcdproc.conf</filename>: Modify the option passed to lcdproc</title>
<programlisting>
# /etc/lcdproc.conf
#
# Configuration file of the main LCDproc client "lcdproc"
# NOTE: The configuration file of LCDd is /etc/LCDd.conf
# Set SCREENS to the screens you want lcdproc to send to LCDd
# lcdproc -h will give you a list of the screens available
SCREENS="C L"
</programlisting>
</example>
<sect2 id="init-lcdvc">
<title>init-lcdvc</title>
<para>
In this example lcdproc will only send information on the CPU usage [C] and system load [L] to the server.
The file <filename>scripts/init-lcdvc.*</filename> is the init script for the
LCDproc <application>lcdvc</application> client, a simple terminal.
</para>
-->
</sect2>
</sect1>
docs/lcdproc-user/drivers/CFontzPacket.docbook
+13 -13
View File
@@ -17,10 +17,10 @@ Currently this line of modules comprises the models:
<term>CFA-631</term>
<listitem>
<itemizedlist>
<listitem>20x2 character LCD with backlight</listitem>
<listitem>keypad with 4 keys: Up, Down, enter &amp; Escape</listitem>
<listitem>USB connection for data and power</listitem>
<listitem>mounting bracket to fit into 3,5" drive bays</listitem>
<listitem><para>20x2 character LCD with backlight</para></listitem>
<listitem><para>keypad with 4 keys: Up, Down, enter &amp; Escape</para></listitem>
<listitem><para>USB connection for data and power</para></listitem>
<listitem><para>mounting bracket to fit into 3,5" drive bays</para></listitem>
</itemizedlist>
</listitem>
</varlistentry>
@@ -29,10 +29,10 @@ Currently this line of modules comprises the models:
<term>CFA-633</term>
<listitem>
<itemizedlist>
<listitem>16x2 character LCDi with backlight</listitem>
<listitem>keypad with 6 keys: 4 directions, Enter &amp; Escape</listitem>
<listitem>serial or USB connection</listitem>
<listitem>mounting bracket to fit into 5,25" drive bays</listitem>
<listitem><para>16x2 character LCDi with backlight</para></listitem>
<listitem><para>keypad with 6 keys: 4 directions, Enter &amp; Escape</para></listitem>
<listitem><para>serial or USB connection</para></listitem>
<listitem><para>mounting bracket to fit into 5,25" drive bays</para></listitem>
</itemizedlist>
</listitem>
</varlistentry>
@@ -41,11 +41,11 @@ Currently this line of modules comprises the models:
<term>CFA-635</term>
<listitem>
<itemizedlist>
<listitem>20x4 characters LCDi with backlight</listitem>
<listitem>keypad with 6 keys: 4 directions, Enter &amp; Escape</listitem>
<listitem>USB connection for data and power</listitem>
<listitem>four bi-color LEDs to show status information</listitem>
<listitem>optional mounting bracket to fit into 5,25" drive bays</listitem>
<listitem><para>20x4 characters LCDi with backlight</para></listitem>
<listitem><para>keypad with 6 keys: 4 directions, Enter &amp; Escape</para></listitem>
<listitem><para>USB connection for data and power</para></listitem>
<listitem><para>four bi-color LEDs to show status information</para></listitem>
<listitem><para>optional mounting bracket to fit into 5,25" drive bays</para></listitem>
</itemizedlist>
</listitem>
</varlistentry>
docs/lcdproc-user/drivers/IOWarrior.docbook
+20 -20
View File
@@ -15,13 +15,13 @@ support controlling LCD displays:
<term>IOWarrior24</term>
<listitem>
<itemizedlist>
<listitem>USB 1.1 Low Speed</listitem>
<listitem>16 generic I/O Pins, typ. 125Hz read rate</listitem>
<listitem>I<superscript>2</superscript>C master function, 100kHz, throughput typ. 750 bytes/sec</listitem>
<listitem>SPI master interface, up to 2MHz, throughput typ. 750 bytes/sec</listitem>
<listitem>control an HD44780 compatible LCD</listitem>
<listitem>drive a matrix of up to 8x32 LEDs</listitem>
<listitem>decode RC5 compatible infrared remote controls</listitem>
<listitem><para>USB 1.1 Low Speed</para></listitem>
<listitem><para>16 generic I/O Pins, typ. 125Hz read rate</para></listitem>
<listitem><para>I<superscript>2</superscript>C master function, 100kHz, throughput typ. 750 bytes/sec</para></listitem>
<listitem><para>SPI master interface, up to 2MHz, throughput typ. 750 bytes/sec</para></listitem>
<listitem><para>control an HD44780 compatible LCD</para></listitem>
<listitem><para>drive a matrix of up to 8x32 LEDs</para></listitem>
<listitem><para>decode RC5 compatible infrared remote controls</para></listitem>
</itemizedlist>
</listitem>
</varlistentry>
@@ -30,12 +30,12 @@ support controlling LCD displays:
<term>IOWarrior40</term>
<listitem>
<itemizedlist>
<listitem>USB 1.1 Low Speed</listitem>
<listitem>32 generic I/O Pins, typ. 125Hz read rate</listitem>
<listitem>I<superscript>2</superscript>C master function, 100kHz, throughput typ. 750 bytes/sec</listitem>
<listitem>control an HD44780 compatible LCD</listitem>
<listitem>drive a matrix of up to 8x32 LEDs</listitem>
<listitem>drive a 8x8 switch or button matrix</listitem>
<listitem><para>USB 1.1 Low Speed</para></listitem>
<listitem><para>32 generic I/O Pins, typ. 125Hz read rate</para></listitem>
<listitem><para>I<superscript>2</superscript>C master function, 100kHz, throughput typ. 750 bytes/sec</para></listitem>
<listitem><para>control an HD44780 compatible LCD</para></listitem>
<listitem><para>drive a matrix of up to 8x32 LEDs</para></listitem>
<listitem><para>drive a 8x8 switch or button matrix</para></listitem>
</itemizedlist>
</listitem>
</varlistentry>
@@ -44,13 +44,13 @@ support controlling LCD displays:
<term>IOWarrior56</term>
<listitem>
<itemizedlist>
<listitem>USB 1.1 Full Speed</listitem>
<listitem>50 generic I/O Pins, typ. 1000Hz read rate</listitem>
<listitem>I<superscript>2</superscript>C master function, 50, 100, or 400kHz</listitem>
<listitem>SPI master interface, up to 12MHz, throughput up to 62Kbytes/sec</listitem>
<listitem>control various display modules, including most graphic modules</listitem>
<listitem>drive a matrix of up to 8x64 LEDs</listitem>
<listitem>drive a 8x8 switch or button matrix</listitem>
<listitem><para>USB 1.1 Full Speed</para></listitem>
<listitem><para>50 generic I/O Pins, typ. 1000Hz read rate</para></listitem>
<listitem><para>I<superscript>2</superscript>C master function, 50, 100, or 400kHz</para></listitem>
<listitem><para>SPI master interface, up to 12MHz, throughput up to 62Kbytes/sec</para></listitem>
<listitem><para>control various display modules, including most graphic modules</para></listitem>
<listitem><para>drive a matrix of up to 8x64 LEDs</para></listitem>
<listitem><para>drive a 8x8 switch or button matrix</para></listitem>
</itemizedlist>
</listitem>
</varlistentry>
docs/lcdproc-user/drivers/curses.docbook
-2
View File
@@ -14,8 +14,6 @@ curses chipset.
<title>[curses]</title>
<variablelist>
color settings
<varlistentry>
<term>
<command>Foreground</command> =
docs/lcdproc-user/drivers/eyeboxone.docbook
+3 -2
View File
@@ -141,10 +141,11 @@ This section has been modified by Cédric TESSIER (http://www.nezetic.info)
<listitem><para>
Set the the baud rate to use when communicating with the LCD.
If not specified, it defaults to <literal>19200</literal>.
</para></listitem>
<note><para>
</para>
<note><para>
As I said, I think only <literal>19200</literal> is a good choice.
</para></note>
</listitem>
</varlistentry>
<varlistentry>
docs/lcdproc-user/drivers/glcdlib.docbook
+14 -10
View File
@@ -1,4 +1,10 @@
<sect1 id="glcdlib-howto">
<sect1info>
<author>
<firstname>Lucian</firstname>
<surname>Muresan</surname>
</author>
</sect1info>
<title>The glcdlib Driver</title>
<para>
@@ -20,12 +26,6 @@ from <ulink url="http://www.muresan.de/graphlcd/lcdproc"></ulink>
before configuring the LCDproc build process --enable-drivers=glcdlib.
</para>
Author
<author>
<firstname>Lucian</firstname>
<surname>Muresan</surname>
</author>
</sect2>
<!-- ## glcdlib meta driver for graphical LCDs ## -->
@@ -35,7 +35,7 @@ Author
<sect3 id="glcdlib-config-section">
<title>[glcdlib]</title>
## mandatory:
<para>Mandatory settings:</para>
<variablelist>
<varlistentry>
@@ -105,8 +105,9 @@ Author
</varlistentry>
</variablelist>
<para>
The following parameters only apply if <command>UseFT2</command> = <literal>yes</literal>:
</para>
<variablelist>
<varlistentry>
@@ -130,12 +131,15 @@ The following parameters only apply if <command>UseFT2</command> = <literal>yes<
</arg>
</term>
<listitem><para>
minumum size in pixels in which fonts should be rendered
minimum size in pixels in which fonts should be rendered
</para></listitem>
</varlistentry>
</variablelist>
<para>Optional settings:</para>
## optional:
<variablelist>
<title>Optional settings</title>
<varlistentry>
<term>
<command>Brightness</command> =
docs/lcdproc-user/drivers/hd44780.docbook
+44 -42
View File
@@ -30,25 +30,25 @@ historically connected to, the driver supports the connection types:
</para>
<itemizedlist>
<listitem>
<listitem><para>
<link linkend="hd44780-4bit">4bit</link>:
4bit Wiring
</listitem>
</para></listitem>
<listitem>
<listitem><para>
<link linkend="hd44780-8bit-lcdtime">8bit</link>:
8bit Wiring ("lcdtime")
</listitem>
</para></listitem>
<listitem>
<listitem><para>
<link linkend="hd44780-8bit-winamp">winamp</link>:
8bit Wiring "winamp" Style
</listitem>
</para></listitem>
<listitem>
<listitem><para>
<link linkend="hd44780-seriallpt">serialLpt</link>:
Serial LPT Wiring
</listitem>
</para></listitem>
</itemizedlist>
<para>
@@ -56,30 +56,30 @@ For serial RS-232 ports you can choose among these connection types:
</para>
<itemizedlist>
<listitem>
<listitem><para>
<link linkend="hd44780-picanlcd">picanlcd</link>:
PIC-an-LCD serial device
</listitem>
</para></listitem>
<listitem>
<listitem><para>
<link linkend="hd44780-lcdserializer">lcdserializer</link>:
LCD serializer
</listitem>
</para></listitem>
<listitem>
<listitem><para>
<link linkend="hd44780-los-panel">los-panel</link>:
LCD on Serial panel device (<ulink url="http://www.xs4all.nl/~mlf/los/"></ulink>)
</listitem>
</para></listitem>
<listitem>
<listitem><para>
<link linkend="hd44780-vdr-lcd">vdr-lcd</link>:
VDR LCD serial device
</listitem>
</para></listitem>
<listitem>
<listitem><para>
<link linkend="hd44780-vdr-wakeup">vdr-wakeup</link>:
VDR-Wakeup module
</listitem>
</para></listitem>
</itemizedlist>
<para>
@@ -89,45 +89,45 @@ more important. Here are the USB connection types the HD44780 driver supports:
</para>
<itemizedlist>
<listitem>
<listitem><para>
<link linkend="hd44780-pertelian">pertelian</link>:
Pertelian X2040 LCD display (<ulink url="http://pertelian.com/joomla/index.php?option=com_content&amp;task=view&amp;id=43&amp;Itemid=48"></ulink>)
</listitem>
</para></listitem>
<listitem>
<listitem><para>
<link linkend="hd44780-bwctusb">bwctusb</link>:
BWCT USB LCD module (<ulink url="http://www.bwct.de/lcd.html"></ulink>)
</listitem>
</para></listitem>
<listitem>
<listitem><para>
<link linkend="hd44780-lcd2usb">lcd2usb</link>:
Till Harbaum's LCD2USB (<ulink url="http://www.harbaum.org/till/lcd2usb/"></ulink>)
</listitem>
</para></listitem>
<listitem>
<listitem><para>
<link linkend="hd44780-uss720">uss720</link>:
Display connected to USS-720 USB-to-IEEE 1284 Bridge (Belkin F5U002)
</listitem>
</para></listitem>
<listitem>
<listitem><para>
<link linkend="hd44780-lis2">lis2</link>:
LIS2 from VLSystem (<ulink url="http://www.vlsys.co.kr"></ulink>)
</listitem>
</para></listitem>
<listitem>
<listitem><para>
<link linkend="hd44780-mplay">mplay</link>:
MPlay Blast from VLSystem (<ulink url="http://www.vlsys.co.kr"></ulink>)
</listitem>
</para></listitem>
<listitem>
<listitem><para>
<link linkend="hd44780-ftdi">ftdi</link>:
Display connected to a dual channel FTDI 2232D USB chip
</listitem>
</para></listitem>
<listitem>
<listitem><para>
<link linkend="hd44780-usblcd">usblcd</link>:
USBLCD from Adams IT Services (<ulink url="http://www.usblcd.de/"></ulink>)
</listitem>
</para></listitem>
</itemizedlist>
<para>
@@ -135,15 +135,15 @@ Last but not least, for special purposes, there are even more connection types:
</para>
<itemizedlist>
<listitem>
<listitem><para>
<link linkend="hd44780-i2c">i2c</link>:
LCD driven by PCF8574(A)/PCA9554(A) connected via I<superscript>2</superscript>C
</listitem>
</para></listitem>
<listitem>
<listitem><para>
<link linkend="hd44780-ethlcd">ethlcd</link>:
Display connected via TCP to PoE powered ethlcd device (<ulink url="http://manio.skyboo.net/ethlcd/"></ulink>)
</listitem>
</para></listitem>
</itemizedlist>
@@ -151,10 +151,10 @@ Last but not least, for special purposes, there are even more connection types:
Depending on the connection type and the display connected, the driver supports
various special features.
<itemizedlist>
<listitem>Input keys</listitem>
<listitem>software controllable brightness / backlight</listitem>
<listitem>software controllable contrast</listitem>
<listitem>multiple displays / multi-controller displays</listitem>
<listitem><para>Input keys</para></listitem>
<listitem><para>software controllable brightness / backlight</para></listitem>
<listitem><para>software controllable contrast</para></listitem>
<listitem><para>multiple displays / multi-controller displays</para></listitem>
</itemizedlist>
</para>
@@ -483,10 +483,12 @@ To be more precise, it assumes this mapping:
</tgroup>
</table>
<para>
This mapping can be changed using the
<command>KeyMatrix_<replaceable>X</replaceable>_<replaceable>Y</replaceable></command>
configuration option, where <replaceable>X</replaceable> and
<replaceable>Y</replaceable> are the subscripts to the respective axes above.
</para>
<para>
If you only need e.g. 10 keys, leave the rest away.
docs/lcdproc-user/drivers/irman.docbook
+2 -1
View File
@@ -7,8 +7,9 @@ to control the LCDproc server <application>LCDd</application>
and/or clients that can handle input.
</para>
<para>
The keys are mapped according to the following table:
</para>
<table id="irman-howto.mapping">
<title>Mapping between LCDproc keys and IrMan commands</title>
docs/lcdproc-user/drivers/lb216.docbook
+7 -10
View File
@@ -1,4 +1,11 @@
<sect1 id="lb216-howto">
<sect1info>
<author>
<firstname>Chris</firstname>
<surname>Debenham</surname>
<email>chris.debenham@aus.sun.com</email>
</author>
</sect1info>
<title>The lb216 Driver</title>
<para>
@@ -6,16 +13,6 @@ This section talks about using LCDproc with LCD displays that use the
lb216 chipset.
</para>
<sect2 id="lb216-connections">
<title>Connections</title>
</sect2>
<firstname>Chris</firstname>
<surname>Debenham</surname>
Sun Systems Engineer
<email>chris.debenham@aus.sun.com</email>
<screen>
Heres a bit more info on the display.
It is the LB216 and is made by R.T.N. Australia
docs/lcdproc-user/drivers/lcdm001.docbook
+1 -1
View File
@@ -85,7 +85,7 @@ lcdm001 chipset.
</varlistentry>
</variablelist>
If your device is broken, have a look at server/drivers/lcdm001.h
<para>If your device is broken, have a look at server/drivers/lcdm001.h</para>
</sect3>
docs/lcdproc-user/drivers/lircin.docbook
+1 -2
View File
@@ -69,6 +69,7 @@ Then you have to modify the <code>[lirc]</code> section of your
<filename>LCDd.conf</filename>.
</para>
</sect2>
<!-- ## LIRC input driver ## -->
<sect2 id="lirc-config">
@@ -118,8 +119,6 @@ Then you have to modify the <code>[lirc]</code> section of your
</sect2>
</sect2>
<sect2 id="lircrc">
<title>Modify Your <filename>~/.lircrc</filename></title>
docs/lcdproc-user/drivers/pylcd.docbook
+14 -12
View File
@@ -1,4 +1,15 @@
<sect1 id="pyramid-howto">
<sect1info>
<author>
<firstname>Stefan</firstname>
<surname>Reinauer</surname>
</author>
</sect1info>
<!-- Only as a comment, as inline presentation is awful in Docbook 4.5
coresystems GmbH · Brahmsstr. 16 · D-79104 Freiburg i. Br.
Tel.: +49 761 7668825 · Fax: +49 761 7664613
Email: info@coresystems.de · http://www.coresystems.de/
-->
<title>The pyramid Driver</title>
<para>
@@ -15,6 +26,7 @@ and appliance manufacturing division at the customer's request or it can be
made available separately for self-integration, e.g. as a 5.25" module.
</para>
<sect2 id="pyramid-features">
<title>Features</title>
@@ -170,13 +182,13 @@ hello
output 67
</programlisting>
will light up LEDs 3, 4 and 9.
<para>will light up LEDs 3, 4 and 9.</para>
<programlisting>
output 0
</programlisting>
will clear all LEDs.
<para>will clear all LEDs.</para>
</example>
<para>
@@ -186,16 +198,6 @@ More information on the Pyramid LC-Display can be found here:
</sect2>
Author
<author>
<firstname>Stefan</firstname>
<surname>Reinauer</surname>
</author>
coresystems GmbH · Brahmsstr. 16 · D-79104 Freiburg i. Br.
Tel.: +49 761 7668825 · Fax: +49 761 7664613
Email: info@coresystems.de · http://www.coresystems.de/
<!-- ## Pyramid LCD driver ## -->
<sect2 id="pyramid-config">
<title>Configuration in LCDd.conf</title>
docs/lcdproc-user/drivers/sed1330.docbook
+8
View File
@@ -5,7 +5,9 @@
This section talks about using LCDproc with graphical LCD displays driven by
the EPSON/SMOS SED1330 or SED1335 LCD controllers, which may also be known by their
new names: S1D13300 (= SED1330) and S1D13305 (= SED1335).
</para>
<para>
The displays are driven in text mode using their built-in character generator.
</para>
@@ -434,7 +436,9 @@ the connections given here are also correct for your display !
</tgroup>
</table>
<para>
The potentiometer should be connected like this on these display modules:
</para>
<screen>
<![CDATA[
@@ -456,10 +460,14 @@ The potentiometer should be connected like this on these display modules:
]]>
</screen>
<para>
The G242C generates -24V internally. It is available on Vlc.
</para>
<para>
To generate -24 from the +5V without an external power source, you can
use the following circuit.
</para>
<screen>
<![CDATA[
docs/lcdproc-user/drivers/serialVFD.docbook
+2 -2
View File
@@ -138,7 +138,7 @@ Feedback is welcome.
<entry>No</entry>
<entry>2</entry>
<entry> </entry>
</row>IEE 36657
</row>
<row>
<entry>IEE 36657-01 (= 02S-93290-VFD 36657-01)</entry>
<entry>?</entry>
@@ -329,7 +329,7 @@ Pin 19 ------ RxD
]]></screen>
</sect4>
<sect4 id="serialVFD-serial-connections-BA63/66">
<sect4 id="serialVFD-serial-connections-BA63_66">
<title>Siemens/Wincor Nixdorf BA63/66:</title>
<para>This display doesn't need the inverter!
It must be connected directly with the serial port.</para>
docs/lcdproc-user/drivers/ula200.docbook
+5 -5
View File
@@ -16,11 +16,11 @@ Additionally it provides 6 digital inputs that can be used for keys.
The <code>ula200</code> driver controls this board supporting the features:
<itemizedlist>
<listitem>display on a single-controller HD44780 display</listitem>
<listitem>standard icons (heart, checkbox)</listitem>
<listitem>backlight control</listitem>
<listitem>input buttons</listitem>
<listitem><emphasis>no</emphasis> horizontal or vertical bars</listitem>
<listitem><para>display on a single-controller HD44780 display</para></listitem>
<listitem><para>standard icons (heart, checkbox)</para></listitem>
<listitem><para>backlight control</para></listitem>
<listitem><para>input buttons</para></listitem>
<listitem><para><emphasis>no</emphasis> horizontal or vertical bars</para></listitem>
</itemizedlist>
</para>
docs/lcdproc-user/drivers/xosd.docbook
-4
View File
@@ -50,8 +50,6 @@ on-screen display (OSD) used by most modern televisions and video-players.
</para></listitem>
</varlistentry>
Offset=200x200
<varlistentry>
<term>
<command>Font</command> =
@@ -71,7 +69,6 @@ Offset=200x200
</listitem>
</varlistentry>
<!--
<varlistentry>
<term>
<command>Contrast</command> =
@@ -109,7 +106,6 @@ Offset=200x200
switched off in case <application>LCDd</application> is inactive
</para></listitem>
</varlistentry>
-->
</variablelist>
</sect3>
docs/lcdproc-user/lcdproc-user.docbook
+2 -2
View File
@@ -1,6 +1,6 @@
<?xml version='1.0'?>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!ENTITY bookinfo SYSTEM "bookinfo.docbook">
<!ENTITY introduction SYSTEM "introduction.docbook">
<!ENTITY how-to-obtain SYSTEM "how-to-obtain.docbook">