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

update user's guide

Browse Source
This commit is contained in:
marschap
2006-04-05 10:36:58 +00:00
parent fa88c2b8eb
commit bb49a9182b
39 changed files with 4149 additions and 513 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/lcdproc-user/bookinfo.docbook
+13 -5
View File
@@ -5,6 +5,12 @@
<authorgroup>
<author>
<firstname>Peter</firstname>
<surname>Marschall</surname>
<affiliation><address><email>peter@adpm.de</email></address></affiliation>
</author>
<author>
<firstname>Rene</firstname>
<surname>Wagner</surname>
@@ -25,17 +31,19 @@
</authorgroup>
<date>2002-03-01</date>
<date>2006-04-01</date>
<releaseinfo>0.0.1</releaseinfo>
<abstract>
<para>
This document is a guide to LCDproc written for users. It covers LCDproc 0.4.3 ONLY.
Some things may be valid for 0.5 as well, but a lot has changed since 0.4.1 and a lot
will change for 0.5.
This document is a guide to LCDproc written for users. It covers LCDproc 0.5.x
</para>
</abstract>
<copyright>
<year>2006</year>
<holder>Peter Marschall</holder>
</copyright>
<copyright>
<year>2002</year>
<holder>Rene Wagner</holder>
@@ -63,7 +71,7 @@ Free Documentation License".
<keywordset>
<keyword>documentation</keyword>
<keyword>LCDproc</keyword>
<keyword>0.4.3</keyword>
<keyword>0.5.0</keyword>
<keyword>user's guide</keyword>
</keywordset>
docs/lcdproc-user/configuration.docbook
+45 -47
View File
@@ -267,58 +267,56 @@ The Free*Key options enable you to influence this behaviour.
</para>
<variablelist>
<varlistentry>
<term>FreePauseKey=</term>
<listitem>
<para>
If set to yes, this prevents LCDd from handling the PauseKey itself.
Then a client can request the key 'A' and handle it.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>FreeBackKey=</term>
<listitem>
<para>
If set to yes, this prevents LCDd from handling the BackKey itself.
Then a client can request the key 'B' and handle it.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>FreeForwardKey=</term>
<listitem>
<para>
If set to yes, this prevents LCDd from handling the ForwardKey itself.
Then a client can request the key 'C' and handle it.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>FreeMainMenuKey=</term>
<listitem>
<para>
If set to yes, this prevents LCDd from handling the MainMenuKey itself.
Then a client can request the key 'D' and handle it.
</para>
<tip>
<para>
Even if you "free" the above keys, you can still use the menu
provided you set FreeMainMenuKey to no.
</para>
</tip>
</listitem>
</varlistentry>
<varlistentry>
<term>FreePauseKey=</term>
<listitem>
<para>
If set to yes, this prevents LCDd from handling the PauseKey itself.
Then a client can request the key 'A' and handle it.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>FreeBackKey=</term>
<listitem>
<para>
If set to yes, this prevents LCDd from handling the BackKey itself.
Then a client can request the key 'B' and handle it.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>FreeForwardKey=</term>
<listitem>
<para>
If set to yes, this prevents LCDd from handling the ForwardKey itself.
Then a client can request the key 'C' and handle it.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>FreeMainMenuKey=</term>
<listitem>
<para>
If set to yes, this prevents LCDd from handling the MainMenuKey itself.
Then a client can request the key 'D' and handle it.
</para>
<tip>
<para>
Even if you "free" the above keys, you can still use the menu
provided you set FreeMainMenuKey to no.
</para>
</tip>
</listitem>
</varlistentry>
</variablelist>
</sect3>
</sect2>
<sect2 id="drivers-section">
<title><filename>LCDd.conf</filename>: The Drivers Section</title>
<sect2 id="driver-section">
<title><filename>LCDd.conf</filename>: The Driver Section</title>
<para>
As mentioned earlier, each driver has its own section in the
@@ -339,7 +337,7 @@ section of your driver and change everything neccessary.
<para>
The LCDproc distribution contains init scripts for RedHat- and Debian-based
GNU/Linux distributions. You can find them in the <filename>docs/</filename>
GNU/Linux distributions. You can find them in the <filename>scripts/</filename>
directory of the LCDproc sources.
</para>
docs/lcdproc-user/drivers.docbook
+33 -2
View File
@@ -7,10 +7,41 @@ which may include the installation process of the hardware as
well as the configuration of LCDd.
</para>
&bayrad;
&CFontz;
&CFontz633;
&CFontzPacket;
&curses;
&CwLnx;
&glcdlib;
&glk;
&hd44780;
&icp_a106;
&imon;
&IOWarrior;
&irman;
&joy;
&lb216;
&lcdm001;
&lcterm;
&lirc;
&ms6931;
&mtc_s16209x;
&MtxOrb;
&NoritakeVFD;
&pylcd;
&sed1330;
&sed1520;
&serialVFD;
&sli;
&stv5730;
&svga;
&t6963;
&text;
&tyan;
&ula200;
&xosd;
&ppttrouble;
&mtxorb;
&lircin;
</chapter>
docs/lcdproc-user/drivers/CFontz.docbook
+139
View File
@@ -0,0 +1,139 @@
<sect1 id="CFontz-howto">
<title>The CFontz Driver</title>
<para>
This section talks about using LCDproc with LCD displays that use the
CFontz chipset.
</para>
<!-- ## CrystalFontz driver (for CF632 &amp; CF634) ## -->
<sect2 id="CFontz-config">
<title>Configuration in LCDd.conf</title>
<sect3>
<title>[CFontz]</title>
<variablelist>
<varlistentry>
<term>
<command>Device=</command>
<arg choice="plain"><replaceable>DEVICE</replaceable></arg>
</term>
<listitem><para>
Select the serial output device to use.
If not given, default is <filename>/dev/lcd</filename>.
</para></listitem>
</varlistentry>
<varlistentry>
<term>
<command>Size=</command>
<arg choice="plain">
<replaceable>WIDTH</replaceable>
<literal>x</literal>
<replaceable>HEIGHT</replaceable>
</arg>
</term>
<listitem><para>
Set the LCD's dimensions in terms of characters per line and lines.
If not given, it defaults to <literal>20x4</literal>.
</para></listitem>
</varlistentry>
<varlistentry>
<term>
<command>Contrast=</command>
<arg choice="plain"><replaceable>CONTRAST</replaceable></arg>
</term>
<listitem><para>
Set the initial contrast.
Legal values for <replaceable>CONTRAST</replaceable> are in the range
between <literal>0</literal> and <literal>1000</literal>.
If not given, it defaults to <literal>140</literal>.
</para></listitem>
</varlistentry>
<varlistentry>
<term>
<command>Brightness=</command>
<arg choice="plain"><replaceable>BRIGHTNESS</replaceable></arg>
</term>
<listitem><para>
Set the initial brightness.
Legal values for <replaceable>BRIGHTNESS</replaceable> range from
<literal>0</literal> to <literal>255</literal>.
If not given, it defaults to <literal>255</literal>.
</para></listitem>
</varlistentry>
<varlistentry>
<term>
<command>OffBrightness=</command>
<arg choice="plain"><replaceable>BRIGHTNESS</replaceable></arg>
</term>
<listitem><para>
Set the initial off-brightness.
This value is used when the display is normally
switched off in case LCDd is inactive.
Legal values <replaceable>BRIGHTNESS</replaceable> are in the range
from <literal>0</literal> to <literal>255</literal>.
The default is <literal>0</literal>.
</para></listitem>
</varlistentry>
<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><emphasis>9600</emphasis></literal></arg>
<arg choice="plain"><literal>19200</literal></arg>
<arg choice="plain"><literal>115200</literal></arg>
</group>
</arg>
</term>
<listitem><para>
Set the the baud rate to use when communicating with the LCD.
It defaults to <literal>9600</literal> if not specified.
</para></listitem>
</varlistentry>
<varlistentry>
<term>
<command>NewFirmware=</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>
</term>
<listitem><para>
Set the firmware version (New means >= 2.0) [default: no; legal: yes, no]
</para></listitem>
</varlistentry>
<varlistentry>
<term>
<command>Reboot=</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>
</term>
<listitem><para>
Reinitialize the LCD's BIOS [default: no; legal: yes, no]
normally you shouldn't need this
</para></listitem>
</varlistentry>
</variablelist>
</sect3>
</sect2>
</sect1>
docs/lcdproc-user/drivers/CFontz633.docbook
+133
View File
@@ -0,0 +1,133 @@
<sect1 id="CFontz633-howto">
<title>The CFontz633 Driver</title>
<para>
This section talks about using LCDproc with LCD displays that use the
CFontz633 chipset.
</para>
<!-- ## CrystalFontz633 driver (for CF633 only) ## -->
<sect2 id="CFontz633-config">
<title>Configuration in LCDd.conf</title>
<sect3>
<title>[CFontz633]</title>
<variablelist>
<varlistentry>
<term>
<command>Device=</command>
<arg choice="plain"><replaceable>DEVICE</replaceable></arg>
</term>
<listitem><para>
Select the output device to use [default: <filename>/dev/lcd</filename>]
may be serial device or USB device in serial emulation mode.
</para></listitem>
</varlistentry>
<varlistentry>
<term>
<command>Size=</command>
<arg choice="plain">
<replaceable>WIDTH</replaceable>
<literal>x</literal>
<replaceable>HEIGHT</replaceable>
</arg>
</term>
<listitem><para>
Select the LCD type (size) [default: 16x2]
</para></listitem>
</varlistentry>
<varlistentry>
<term>
<command>Contrast=</command>
<arg choice="plain"><replaceable>CONTRAST</replaceable></arg>
</term>
<listitem><para>
Set the initial contrast.
Legal values for <replaceable>CONTRAST</replaceable> are <literal>0</literal> - <literal>1000</literal>.
If not specified, it defaults to <literal>560</literal>.
</para></listitem>
</varlistentry>
<varlistentry>
<term>
<command>Brightness=</command>
<arg choice="plain"><replaceable>BRIGHTNESS</replaceable></arg>
</term>
<listitem><para>
Set the initial brightness [default: 1000; legal: 0 - 1000]
</para></listitem>
</varlistentry>
<varlistentry>
<term>
<command>OffBrightness=</command>
<arg choice="plain"><replaceable>BRIGHTNESS</replaceable></arg>
</term>
<listitem><para>
Set the initial off-brightness [default: 0; legal: 0 - 1000]
This value is used when the display is normally
switched off in case LCDd is inactive
</para></listitem>
</varlistentry>
<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>
<arg choice="plain"><literal>115200</literal></arg>
</group>
</arg>
</term>
<listitem><para>
Set the the baud rate for communication with the LCD.
If not specified, the default is <emphasis>19200</emphasis>.
</para></listitem>
</varlistentry>
<varlistentry>
<term>
<command>NewFirmware=</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>
</term>
<listitem><para>
Set the firmware version (New means >= 2.0) [default: no; legal: yes, no]
Currently this flag is not in use, there is no such thing as NewFirmware. ;=)
</para></listitem>
</varlistentry>
<varlistentry>
<term>
<command>Reboot=</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>
</term>
<listitem><para>
Reinitialize the LCD's BIOS [default: no; legal: yes, no]
I want to reboot the LCD to make sure we start from a known state
</para></listitem>
</varlistentry>
</variablelist>
</sect3>
</sect2>
</sect1>
docs/lcdproc-user/drivers/CFontzPacket.docbook
+149
View File
@@ -0,0 +1,149 @@
<sect1 id="CFontzPacket-howto">
<title>The CFontzPacket Driver</title>
<para>
This section talks about using LCDproc with LCD displays that use the
CFontzPacket chipset.
</para>
<!-- ## CrystalFontz packet driver (for CF631, CF633 &amp; CF635) ## -->
<sect2 id="CFontzPacket-config">
<title>Configuration in LCDd.conf</title>
<sect3>
<title>[CFontzPacket]</title>
<variablelist>
<varlistentry>
<term>
<command>Model=</command>
<arg choice="plain">
<group choice="req">
<arg choice="plain"><literal>631</literal></arg>
<arg choice="plain"><literal><emphasis>633</emphasis></literal></arg>
<arg choice="plain"><literal>635</literal></arg>
</group>
</arg>
</term>
<listitem><para>
Select the LCD model [default: 633; legal: 631, 633, 635]
</para></listitem>
</varlistentry>
<varlistentry>
<term>
<command>Device=</command>
<arg choice="plain"><replaceable>DEVICE</replaceable></arg>
</term>
<listitem><para>
Select the output device to use [default: <filename>/dev/lcd</filename>]
May be a serial device or a USB device in serial emulation mode.
</para></listitem>
</varlistentry>
<varlistentry>
<term>
<command>Size=</command>
<arg choice="plain">
<replaceable>WIDTH</replaceable>
<literal>x</literal>
<replaceable>HEIGHT</replaceable>
</arg>
</term>
<listitem><para>
Select the LCD size [default: depending on model: 635: 20x4, 631 &amp; 633: 16x2]
</para></listitem>
</varlistentry>
<varlistentry>
<term>
<command>Contrast=</command>
<arg choice="plain"><replaceable>CONTRAST</replaceable></arg>
</term>
<listitem><para>
Set the initial contrast.
Legal values for <replaceable>CONTRAST</replaceable> are <literal>0</literal> - <literal>1000</literal>.
If not specified, it defaults to <literal>560</literal>.
</para></listitem>
</varlistentry>
<varlistentry>
<term>
<command>Brightness=</command>
<arg choice="plain"><replaceable>BRIGHTNESS</replaceable></arg>
</term>
<listitem><para>
Set the initial brightness [default: 1000; legal: 0 - 1000]
</para></listitem>
</varlistentry>
<varlistentry>
<term>
<command>OffBrightness=</command>
<arg choice="plain"><replaceable>BRIGHTNESS</replaceable></arg>
</term>
<listitem><para>
Set the initial off-brightness [default: 0; legal: 0 - 1000]
This value is used when the display is normally
switched off in case LCDd is inactive
</para></listitem>
</varlistentry>
<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>19200</literal></arg>
<arg choice="plain"><literal>115200</literal></arg>
</group>
</arg>
</term>
<listitem><para>
Set the the baud rate for communication with the LCD.
If not specified, the default depends on the model: it is <literal>9600</literal>
for the CFA633 and <literal>115200</literal> for the CFA631 and CFA635.
</para></listitem>
</varlistentry>
<varlistentry>
<term>
<command>NewFirmware=</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>
</term>
<listitem><para>
Set the firmware version (New means >= 2.0) [default: no; legal: yes, no]
Currently this flag is not in use, there is no such thing as NewFirmware. ;=)
</para></listitem>
</varlistentry>
<varlistentry>
<term>
<command>Reboot=</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>
</term>
<listitem><para>
Reinitialize the LCD's BIOS [default: no; legal: yes, no]
I want to reboot the LCD to make sure we start from a known state
</para></listitem>
</varlistentry>
</variablelist>
</sect3>
</sect2>
</sect1>
docs/lcdproc-user/drivers/CwLnx.docbook
+185
View File
@@ -0,0 +1,185 @@
<sect1 id="CwLnx-howto">
<title>The CwLnx Driver</title>
<para>
This section talks about using LCDproc with LCD displays that use the
CwLnx chipset.
</para>
<!-- ## Cwlinux driver ## -->
<sect2 id="CwLnx-config">
<title>Configuration in LCDd.conf</title>
<sect3>
<title>[CwLnx]</title>
<variablelist>
<varlistentry>
<term>
<command>Device=</command>
<arg choice="plain"><replaceable>DEVICE</replaceable></arg>
</term>
<listitem><para>
Select the output device to use [default: <filename>/dev/lcd</filename>]
May be serial device or USB device in serial emulation mode.
</para></listitem>
</varlistentry>
<varlistentry>
<term>
<command>Size=</command>
<arg choice="plain">
<replaceable>WIDTH</replaceable>
<literal>x</literal>
<replaceable>HEIGHT</replaceable>
</arg>
</term>
<listitem><para>
Select the LCD size [default: 20x4]
</para></listitem>
</varlistentry>
<varlistentry>
<term>
<command>Speed=</command>
<arg choice="plain">
<group choice="req">
<arg choice="plain"><literal>9600</literal></arg>
<arg choice="plain"><literal><emphasis>19200</emphasis></literal></arg>
</group>
</arg>
</term>
<listitem><para>
Set the the baud rate for communication with the LCD.
If not given, the default is <literal>19200</literal>.
</para></listitem>
</varlistentry>
<varlistentry>
<term>
<command>Reboot=</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>
</term>
<listitem><para>
Reinitialize the LCD's BIOS [default: no; legal: yes, no]
normally you shouldn't need this
</para></listitem>
</varlistentry>
<varlistentry>
<term>
<command>Keypad=</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>
</term>
<listitem><para>
Tells if you have a keypad connected. Keypad layout is currently not
configureable from the config file.
</para></listitem>
</varlistentry>
<varlistentry>
<term>
<command>KeyMap_A=</command>
<arg choice="plain"><replaceable>KEY</replaceable></arg>
</term>
<term>
<command>KeyMap_B=</command>
<arg choice="plain"><replaceable>KEY</replaceable></arg>
</term>
<term>
<command>KeyMap_C=</command>
<arg choice="plain"><replaceable>KEY</replaceable></arg>
</term>
<term>
<command>KeyMap_D=</command>
<arg choice="plain"><replaceable>KEY</replaceable></arg>
</term>
<term>
<command>KeyMap_E=</command>
<arg choice="plain"><replaceable>KEY</replaceable></arg>
</term>
<term>
<command>KeyMap_F=</command>
<arg choice="plain"><replaceable>KEY</replaceable></arg>
</term>
<listitem><para>
If you have a non standard keypad you can associate any keystrings to keys.
There are 6 input key in the CwLnx hardware that generate characters
from '<literal>A</literal>' to '<literal>F</literal>'.
Legal values for <replaceable>KEY</replaceable> are <literal>Up</literal>,
<literal>Down</literal>, <literal>Left</literal>, <literal>Right</literal>,
<literal>Enter</literal> and <literal>Escape</literal>.
</para>
<para>
The following it the built-in default mapping hardcoded in the driver.
</para>
<informaltable>
<tgroup cols="2">
<tbody>
<row>
<entry>KeyMap_A</entry>
<entry><literal>Up</literal></entry>
</row>
<row>
<entry>KeyMap_B</entry>
<entry><literal>Down</literal></entry>
</row>
<row>
<entry>KeyMap_C</entry>
<entry><literal>Left</literal></entry>
</row>
<row>
<entry>KeyMap_D</entry>
<entry><literal>Right</literal></entry>
</row>
<row>
<entry>KeyMap_E</entry>
<entry><literal>Enter</literal></entry>
</row>
<row>
<entry>KeyMap_F</entry>
<entry><literal>Escape</literal></entry>
</row>
</tbody>
</tgroup>
</informaltable>
<para>
You may leave it unchanged if you have a standard keypad.
You can change it if you want to report other keystrings or have a non
standard keypad.
</para>
</listitem>
</varlistentry>
<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>
</term>
<listitem><para>
keypad_test_mode permit to test keypad assignement
Default value is no
</para></listitem>
</varlistentry>
</variablelist>
</sect3>
</sect2>
</sect1>
docs/lcdproc-user/drivers/IOWarrior.docbook
+64
View File
@@ -0,0 +1,64 @@
<sect1 id="IOWarrior-howto">
<title>The IOWarrior Driver</title>
<para>
This section talks about using LCDproc with LCD displays that use the
IOWarrior chipset.
</para>
<!-- ## Code Mercenaries IO-Warrior driver ## -->
<sect2 id="IOWarrior-config">
<title>Configuration in LCDd.conf</title>
<sect3>
<title>[IOWarrior]</title>
<variablelist>
<varlistentry>
<term>
<command>Size=</command>
<arg choice="plain">
<replaceable>WIDTH</replaceable>
<literal>x</literal>
<replaceable>HEIGHT</replaceable>
</arg>
</term>
<listitem><para>
display dimensions
Default: <literal>20x4</literal>.
</para></listitem>
</varlistentry>
<varlistentry>
<term>
<command>SerialNumber=</command>
<arg choice="plain"><replaceable>SERIALNO</replaceable></arg>
</term>
<listitem><para>
serial number [exactly as listed by usbview]
(if not given, the 1st IOWarrior found gets used)
</para></listitem>
</varlistentry>
<varlistentry>
<term>
<command>Lastline=</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>
</term>
<listitem><para>
Specifies if the last line is pixel addressable or it controls an
underline effect. [default: yes (= pixel addressable); legal: yes, no]
</para></listitem>
</varlistentry>
</variablelist>
</sect3>
</sect2>
</sect1>
docs/lcdproc-user/drivers/Makefile.am
+36 -1
View File
@@ -1,5 +1,40 @@
## Process this file with automake to produce Makefile.in
EXTRA_DIST = hd44780.docbook lircin.docbook mtxorb.docbook ppttrouble.docbook t6963.docbook
EXTRA_DIST = bayrad.docbook \
CFontz633.docbook \
CFontz.docbook \
CFontzPacket.docbook \
curses.docbook \
CwLnx.docbook \
glcdlib.docbook \
glk.docbook \
hd44780.docbook \
icp_a106.docbook \
imon.docbook \
IOWarrior.docbook \
irman.docbook \
joy.docbook \
lb216.docbook \
lcdm001.docbook \
lcterm.docbook \
lirc.docbook \
lircin.docbook \
ms6931.docbook \
mtc_s16209x.docbook \
mtxorb.docbook \
NoritakeVFD.docbook \
ppttrouble.docbook \
pylcd.docbook \
sed1330.docbook \
sed1520.docbook \
serialVFD.docbook \
sli.docbook \
stv5730.docbook \
svga.docbook \
t6963.docbook \
text.docbook \
tyan.docbook \
ula200.docbook \
xosd.docbook
## EOF
docs/lcdproc-user/drivers/NoritakeVFD.docbook
+90
View File
@@ -0,0 +1,90 @@
<sect1 id="NoritakeVFD-howto">
<title>The NoritakeVFD Driver</title>
<para>
This section talks about using LCDproc with LCD displays that use the
NoritakeVFD chipset.
</para>
<!-- ## Noritake VFD driver ## -->
<sect2 id="NoritakeVFD-config">
<title>Configuration in LCDd.conf</title>
<sect3>
<title>[NoritakeVFD]</title>
<variablelist>
<varlistentry>
<term>
<command>Device=</command>
<arg choice="plain"><replaceable>DEVICE</replaceable></arg>
</term>
<listitem><para>
Port where the VFD is. Usual values are <filename>/dev/ttyS0</filename> and <filename>/dev/ttyS1</filename>
Default: <filename>/dev/lcd</filename>
</para></listitem>
</varlistentry>
<varlistentry>
<term>
<command>Size=</command>
<arg choice="plain">
<replaceable>WIDTH</replaceable>
<literal>x</literal>
<replaceable>HEIGHT</replaceable>
</arg>
</term>
<listitem><para>
Specifies the size of the LCD.
Default: <literal>20x4</literal>
</para></listitem>
</varlistentry>
<varlistentry>
<term>
<command>Brightness=</command>
<arg choice="plain"><replaceable>BRIGHTNESS</replaceable></arg>
</term>
<listitem><para>
</para></listitem>
</varlistentry>
<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><emphasis>9600</emphasis></literal></arg>
<arg choice="plain"><literal>19200</literal></arg>
<arg choice="plain"><literal>115200</literal></arg>
</group>
</arg>
</term>
<listitem><para>
Set the the baud rate to use when communicating with the VFD.
If not specified, it defaults to <literal>9600</literal>.
</para></listitem>
</varlistentry>
<varlistentry>
<term>
<command>Reboot=</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>
</term>
<listitem><para>
</para></listitem>
</varlistentry>
</variablelist>
</sect3>
</sect2>
</sect1>
docs/lcdproc-user/drivers/bayrad.docbook
+51
View File
@@ -0,0 +1,51 @@
<sect1 id="bayrad-howto">
<title>The bayrad Driver</title>
<para>
This section talks about using LCDproc with LCD displays that use the
bayrad chipset.
</para>
<!-- ## EMAC BayRAD driver ## -->
<sect2 id="bayrad-config">
<title>Configuration in LCDd.conf</title>
<sect3>
<title>[bayrad]</title>
<variablelist>
<varlistentry>
<term>
<command>Device=</command>
<arg choice="plain"><replaceable>DEVICE</replaceable></arg>
</term>
<listitem><para>
Select the serial output device to use.
If not given, default is <filename>/dev/lcd</filename>.
</para></listitem>
</varlistentry>
<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><emphasis>9600</emphasis></literal></arg>
<arg choice="plain"><literal>19200</literal></arg>
</group>
</arg>
</term>
<listitem><para>
Set the the baud rate to use when communicating with the LCD.
<literal>9600</literal> is the default, if not specified.
</para></listitem>
</varlistentry>
</variablelist>
</sect3>
</sect2>
</sect1>
docs/lcdproc-user/drivers/curses.docbook
+83
View File
@@ -0,0 +1,83 @@
<sect1 id="curses-howto">
<title>The curses Driver</title>
<para>
This section talks about using LCDproc with LCD displays that use the
curses chipset.
</para>
<!-- ## Curses driver ## -->
<sect2 id="curses-config">
<title>Configuration in LCDd.conf</title>
<sect3>
<title>[curses]</title>
<variablelist>
color settings
<varlistentry>
<term>
<command>Foreground=</command>
<arg choice="plain"><replaceable>COLOUR</replaceable></arg>
</term>
<listitem><para>
foreground color [default: blue]
</para></listitem>
</varlistentry>
<varlistentry>
<term>
<command>Background=</command>
<arg choice="plain"><replaceable>COLOUR</replaceable></arg>
</term>
<listitem><para>
background color [default: cyan]
</para></listitem>
</varlistentry>
<varlistentry>
<term>
<command>Backlight=</command>
<arg choice="plain"><replaceable>COLOUR</replaceable></arg>
</term>
<listitem><para>
backlight color [default: red]
</para></listitem>
</varlistentry>
<varlistentry>
<term>
<command>Size=</command>
<arg choice="plain">
<replaceable>WIDTH</replaceable>
<literal>x</literal>
<replaceable>HEIGHT</replaceable>
</arg>
</term>
<listitem><para>
display size [default: 20x4]
</para></listitem>
</varlistentry>
<varlistentry>
<term>
<command>TopLeftx=</command>
<arg choice="plain"><replaceable>X-OFFSET</replaceable></arg>
</term>
<term>
<command>TopLefty=</command>
<arg choice="plain"><replaceable>Y-OFFSET</replaceable></arg>
</term>
<listitem><para>
What position (X,Y) to start the left top corner at.
Default: (7,7)
</para></listitem>
</varlistentry>
</variablelist>
</sect3>
</sect2>
</sect1>
docs/lcdproc-user/drivers/glcdlib.docbook
+272
View File
@@ -0,0 +1,272 @@
<sect1 id="glcdlib-howto">
<title>The glcdlib Driver</title>
<para>
This section talks about using LCDproc with LCD displays that use the
glcdlib chipset.
</para>
<sect2 id="glcdlib-connections">
<title>Connections</title>
<para>
The so-called "meta-driver" glcdlib extends LCDproc's supported drivers by
all the drivers supported by graphlcd-base, which you can get from
<ulink url="http://graphlcd.berlios.de"></ulink>.
</para>
<para>
In order to be able to use it, you have to get and install the glcdprocdriver
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 ## -->
<sect2 id="glcdlib-config">
<title>Configuration in LCDd.conf</title>
<sect3>
<title>[glcdlib]</title>
## mandatory:
<variablelist>
<varlistentry>
<term>
<command>Driver=</command>
<arg choice="plain"><replaceable>GRAPHLCD-DRIVER</replaceable></arg>
</term>
<listitem><para>
Specify which graphical display supported by graphlcd-base to use.
Legal values for <replaceable>GRAPHLCD-DRIVER</replaceable> are
specified in graphlcd's configuration file <filename>/etc/graphlcd.conf</filename>.
For graphlcd 0.13 they comprise <literal>avrctl</literal>, <literal>framebuffer</literal>,
<literal>gu140x32f</literal>, <literal>gu256x64-372</literal>, <literal>gu256x64C-3xx0</literal>,
<literal>hd61830</literal>, <literal>image</literal>, <literal>ks0108</literal>,
<literal>noritake800</literal>, <literal>sed1330</literal>, <literal>sed1520</literal>,
<literal>serdisp</literal>, <literal>simlcd</literal>, and <literal>t6963c</literal>.
If not specified it defaluts to <literal>image</literal>.
</para></listitem>
</varlistentry>
<varlistentry>
<term>
<command>UseFT2=</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>
</term>
<listitem><para>
Tell whether to use FreeType2 or not.
If set to <literal>no</literal> use graphlcd's bitmap fonts, which is only one size/font file.
If set to to the default value <literal>yes</literal> use the fonts that FreeType2 provides.
</para>
<note><para>
Setting it to <literal>yes</literal> requires Freetype2 support in libglcdprocdriver and its dependants.
</para></note>
</listitem>
</varlistentry>
<varlistentry>
<term>
<command>TextResolution=</command>
<arg choice="plain">
<replaceable>WIDTH</replaceable>
<literal>x</literal>
<replaceable>HEIGHT</replaceable>
</arg>
</term>
<listitem><para>
Give text resolution in fixed width characters. If it won't fit according
to the available physical pixel resolution and the minimum available font
face size in pixels, 'DebugBorder' will automatically be turned on.
If not specified, it defaults to <literal>16x4</literal>.
</para></listitem>
</varlistentry>
<varlistentry>
<term>
<command>FontFile=</command>
<arg choice="plain"><replaceable>FILENAME</replaceable></arg>
</term>
<listitem><para>
Set path to font file to use, e.g. <filename>/usr/share/fonts/corefonts/courbd.ttf</filename>.
</para></listitem>
</varlistentry>
</variablelist>
The following parameters only apply if <command>UseFT2=</command><literal>yes</literal>:
<variablelist>
<varlistentry>
<term>
<command>CharEncoding=</command>
<arg choice="plain"><replaceable>CHARSET</replaceable></arg>
</term>
<listitem><para>
Specify character encoding to use, e.g. <literal>iso8859-2</literal>.
If not given, use the default <literal>ISO8859-1</literal>.
</para></listitem>
</varlistentry>
<varlistentry>
<term>
<command>MinFontFaceSize=</command>
<arg choice="plain">
<replaceable>COLUMNS</replaceable>
<literal>x</literal>
<replaceable>ROWS</replaceable>
</arg>
</term>
<listitem><para>
minumum size in pixels in which fonts should be rendered
</para></listitem>
</varlistentry>
## optional:
<varlistentry>
<term>
<command>Brightness=</command>
<arg choice="plain"><replaceable>BRIGHTNESS</replaceable></arg>
</term>
<listitem><para>
Brightness (in %) if applicable
Legal values are <literal>0</literal> - <literal>100</literal>.
If not specified, the default is <literal>50</literal>.
</para></listitem>
</varlistentry>
<varlistentry>
<term>
<command>Contrast=</command>
<arg choice="plain"><replaceable>CONTRAST</replaceable></arg>
</term>
<listitem><para>
Set the contrast (in %) if applicable.
Legal values are <literal>0</literal> - <literal>100</literal>,
with <literal>50</literal> being the default when not specified.
</para></listitem>
</varlistentry>
<varlistentry>
<term>
<command>Backlight=</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>
</term>
<listitem><para>
Backlight if applicable
</para></listitem>
</varlistentry>
<varlistentry>
<term>
<command>UpsideDown=</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>
</term>
<listitem><para>
flip image upside down
</para></listitem>
</varlistentry>
<varlistentry>
<term>
<command>Invert=</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>
</term>
<listitem><para>
invert light/dark pixels
</para></listitem>
</varlistentry>
<varlistentry>
<term>
<command>ShowDebugFrame=</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>
</term>
<listitem><para>
turns on/off 1 pixel thick debugging
border whithin the usable text area,
for setting up TextResolution and
MinFontFaceSize (if using FT2);
</para></listitem>
</varlistentry>
<varlistentry>
<term>
<command>ShowBigBorder=</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>
</term>
<listitem><para>
border around the unused area
</para></listitem>
</varlistentry>
<varlistentry>
<term>
<command>ShowThinBorder=</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>
</term>
<listitem><para>
border around the unused area
</para></listitem>
</varlistentry>
<varlistentry>
<term>
<command>PixelShiftX=<replaceable>0</replaceable></command>
</term>
<term>
<command>PixelShiftY=<replaceable>2</replaceable></command>
</term>
<listitem><para>
</para></listitem>
</varlistentry>
</variablelist>
</sect3>
</sect2>
</sect1>
docs/lcdproc-user/drivers/glk.docbook
+61
View File
@@ -0,0 +1,61 @@
<sect1 id="glk-howto">
<title>The glk Driver</title>
<para>
This section talks about using LCDproc with LCD displays that use the
glk chipset.
</para>
<!-- ## Matrix Orbital GLK driver ## -->
<sect2 id="glk-config">
<title>Configuration in LCDd.conf</title>
<sect3>
<title>[glk]</title>
<variablelist>
<varlistentry>
<term>
<command>Device=</command>
<arg choice="plain"><replaceable>DEVICE</replaceable></arg>
</term>
<listitem><para>
select the serial device to use [default: <filename>/dev/lcd</filename>]
</para></listitem>
</varlistentry>
<varlistentry>
<term>
<command>Contrast=</command>
<arg choice="plain"><replaceable>CONTRAST</replaceable></arg>
</term>
<listitem><para>
Set the initial contrast.
Legal values for <replaceable>CONTRAST</replaceable> are <literal>0</literal> - <literal>1000</literal>.
If not given, it defaults to <literal>560</literal>.
</para></listitem>
</varlistentry>
<varlistentry>
<term>
<command>Speed=</command>
<arg choice="plain">
<group choice="req">
<arg choice="plain"><literal>9600</literal></arg>
<arg choice="plain"><literal><emphasis>19200</emphasis></literal></arg>
<arg choice="plain"><literal>38400</literal></arg>
</group>
</arg>
</term>
<listitem><para>
Set the the baud rate for communication with the LCD.
The default is <literal>19200</literal>.
</para></listitem>
</varlistentry>
</variablelist>
</sect3>
</sect2>
</sect1>
docs/lcdproc-user/drivers/hd44780.docbook
+824 -380
View File
File diff suppressed because it is too large Load Diff
docs/lcdproc-user/drivers/icp_a106.docbook
+31
View File
@@ -0,0 +1,31 @@
<sect1 id="icp_a106-howto">
<title>The icp_a106 Driver</title>
<para>
This section talks about using LCDproc with LCD displays that use the
icp_a106 chipset.
</para>
<!-- ## ICP A106 driver ## -->
<sect2 id="icp_a106-config">
<title>Configuration in LCDd.conf</title>
<sect3>
<title>[icp_a106]</title>
<variablelist>
<varlistentry>
<term>
<command>Device=</command>
<arg choice="plain"><replaceable>DEVICE</replaceable></arg>
</term>
<listitem><para>
</para></listitem>
</varlistentry>
</variablelist>
</sect3>
</sect2>
</sect1>
docs/lcdproc-user/drivers/imon.docbook
+72
View File
@@ -0,0 +1,72 @@
<sect1 id="imon-howto">
<title>The imon Driver</title>
<para>
This section talks about using LCDproc with LCD displays that use the
imon chipset.
</para>
<sect2 id="imon-general">
<title>General</title>
Driver for Soundgraph/Ahanix/Silverstone/Uneed/Accent iMON IR/VFD Module
<para>
In order to be able to use it, you have to get and install one of
the following kernel modules:
- standalone iMON VFD driver from http://venky.ws/projects/imon/
- the iMON module included with LIRC ver. 0.7.1 or newer
from http://www.lirc.org/
</para>
<para>
Adjust the 'Device' key in the [imon] section of /etc/LCDd.conf as
necessary, depending on what device is file created by the kernel module
when loaded (this may depend on your system configuration).
</para>
<para>
For further details, please consult the page and the forum at
<ulink url="http://venky.ws/projects/imon/"></ulink>.
</para>
</sect2>
<!-- ## Soundgraph/Ahanix/Silverstone/Uneed/Accent iMON driver ## -->
<sect2 id="imon-config">
<title>Configuration in LCDd.conf</title>
<sect3>
<title>[imon]</title>
<variablelist>
<varlistentry>
<term>
<command>Size=</command>
<arg choice="plain">
<replaceable>WIDTH</replaceable>
<literal>x</literal>
<replaceable>HEIGHT</replaceable>
</arg>
</term>
<listitem><para>
set display size [default: 20x4]
</para></listitem>
</varlistentry>
<varlistentry>
<term>
<command>Device=</command>
<arg choice="plain"><replaceable>DEVICE</replaceable></arg>
</term>
<listitem><para>
Select the output device to use [default: <filename>/dev/lcd</filename>]
</para></listitem>
</varlistentry>
</variablelist>
</sect3>
</sect2>
</sect1>
docs/lcdproc-user/drivers/irman.docbook
+162
View File
@@ -0,0 +1,162 @@
<sect1 id="irman-howto">
<title>The irman Driver</title>
<para>
This section talks about using LCDproc with LCD displays that use the
irman chipset.
</para>
<sect2 id="irman-connections">
<title>Connections</title>
</sect2>
<screen>
Hello,
I made a IRman input driver for lcdproc-0.4 wich is now include in
"lcdproc-0.4-pre6". This input driver require "libirman-0.4.1b" the
library with function support for IRman.
I want to help you use this new driver (if anybody other than me use
it... please tell me!!!).
In order to help you compile your own version of LCDd with support for
IRman, I recorded every step I took in order to compile my own copy
based on two file downloaded directly from the internet.
The first file is " lcdproc-0.4-pre6.tar.gz " the current version of
lcdproc. You can download this file from
"http://lcdproc.omnipotent.net/download.php3" The second file is
"libirman-0.4.1b.tar.gz" the current version of libirman. You can
download this file from http://www.evation.com/libirman/ DO NOT USE
THE COPY OF LIBIRMAN FROM LCDPROC HOME PAGE... I don't know what is
wrong with that one but I can't decompress it???
How to compile lcdproc for use with support for IRman:
-Untar lcdproc and libirman:
tar -xzvf lcdproc-0.4-pre6.tgz
tar -xzvf libirman$$$
-Go, configure and compile libirman:
cd libirman-0.4.1b/
./configure
make
cd ..
-Go in lcdproc directory:
cd lcdproc-0.4-pre6
-Here is the modification you need to include IRman driver in lcdproc:
edit Makefile.config
# Irman input... handy!
DRIVERS += -DIRMANIN_DRV
DOBJ += irmanin.o ../../../libirman-0.4.1b/libirman.a
IRMAN=1
-Compile lcdproc
make
-Make sure you have a network interface up and working:
ifup lo
-Go and install your IRman configuration file:
cd server
cd drivers
cp DOTirmanrc ~/.irmanrc
-Modify if needed (if you use another remote control) the .irmanrc file.
-Run LCDd with two driver, irmanin and an output driver:
./LCDd -d irmanin "-d /dev/ttyS0" -d curses
-Try to access the menu by pressing the remote control.
Now if it does not work:
· Try your IRMAN on ttyS0 alone (with other software).
· Try LCDd without the IrmanIN driver.
· ...
</screen>
<firstname>David</firstname>
<surname>GLAUDE</surname>
<email>dglaude@comtech.be</email>
<screen>
PS: If you really have successfuly made LCDd working without IRman AND
You have successfuly made IRman device working AND you don't succeed
to make it work together ussing my driver... then maybe I can help and
give you some support (as time permit and if it does not eat up too
much bandwidth).
</screen>
The keys are mapped according to the following table:
<table>
<title>Mapping between LCDproc keys and IrMan commands</title>
<tgroup cols="2">
<thead>
<row>
<entry>LCDproc key</entry>
<entry>IrMan command</entry>
</row>
</thead>
<tbody>
<row>
<entry><literal>Up</literal></entry>
<entry>lcdproc-Up</entry>
</row>
<row>
<entry><literal>Down</literal></entry>
<entry>lcdproc-Down</entry>
</row>
<row>
<entry><literal>Left</literal></entry>
<entry>lcdproc-Left</entry>
</row>
<row>
<entry><literal>Right</literal></entry>
<entry>lcdproc-Right</entry>
</row>
<row>
<entry><literal>Enter</literal></entry>
<entry>lcdproc-Enter</entry>
</row>
<row>
<entry><literal>Escape</literal></entry>
<entry>lcdproc-Escape</entry>
</row>
</tbody>
</tgroup>
</table>
<!-- ## IrMan driver ## -->
<sect2 id="IrMan-config">
<title>Configuration in LCDd.conf</title>
<sect3>
<title>[IrMan]</title>
If in trouble with IrMan, try Lirc emulator for IrMan.
<variablelist>
<varlistentry>
<term>
<command>Device=</command>
<arg choice="plain"><replaceable>DEVICE</replaceable></arg>
</term>
<listitem><para>
Select the input device to use, e.g. <filename>/dev/irman</filename>.
default: none
</para></listitem>
</varlistentry>
<varlistentry>
<term>
<command>Config=</command>
<arg choice="plain"><replaceable>FILENAME</replaceable></arg>
</term>
<listitem><para>
Select the IrMan configuration file to use, e.g. <filename>/etc/irman.cfg</filename>.
</para></listitem>
</varlistentry>
</variablelist>
</sect3>
</sect2>
</sect1>
docs/lcdproc-user/drivers/joy.docbook
+51
View File
@@ -0,0 +1,51 @@
<sect1 id="joy-howto">
<title>The Joystick Input Driver</title>
<para>
This section covers the joystick input driver for LCDd.
</para>
<!-- ## Joystick driver ## -->
<sect2 id="joy-config">
<title>Configuration in LCDd.conf</title>
<sect3>
<title>[joy]</title>
<variablelist>
<varlistentry>
<term>
<command>Device=</command>
<arg choice="plain"><replaceable>DEVICE</replaceable></arg>
</term>
<listitem><para>
Select the input device to use [default: <filename>/dev/js0</filename>]
</para></listitem>
</varlistentry>
<varlistentry>
<term>
<command>AxisMap=</command>
<arg choice="plain"><replaceable>MAP-LIST</replaceable></arg>
</term>
<listitem><para>
Modify the axis mapa [default: EFGHIJKLMNOPQRST]
</para></listitem>
</varlistentry>
<varlistentry>
<term>
<command>ButtonMap=</command>
<arg choice="plain"><replaceable>MAP-LIST</replaceable></arg>
</term>
<listitem><para>
Modify the button map [default: BDACEFGHIJKLMNOP]
</para></listitem>
</varlistentry>
</variablelist>
</sect3>
</sect2>
</sect1>
docs/lcdproc-user/drivers/lb216.docbook
+95
View File
@@ -0,0 +1,95 @@
<sect1 id="lb216-howto">
<title>The lb216 Driver</title>
<para>
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>
eSun 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
The web page for it is http://www.nollet.com.au/
It is a serial 16x2 LCD with software controllable backlight.
They also make 40x4 displays (which I'll be getting one of soon :-) )
3 wire connection (5V,0V and serial), 2400 or 9600 bps.
8 custom characters
40*83.5MM size
made in australia :-)
</screen>
<!-- ## LB216 driver ## -->
<sect2 id="lb216-config">
<title>Configuration in LCDd.conf</title>
<sect3>
<title>[lb216]</title>
<variablelist>
<varlistentry>
<term>
<command>Device=</command>
<arg choice="plain"><replaceable>DEVICE</replaceable></arg>
</term>
<listitem><para>
Select the output device to use [default: <filename>/dev/lcd</filename>]
</para></listitem>
</varlistentry>
<varlistentry>
<term>
<command>Brightness=</command>
<arg choice="plain"><replaceable>BRIGHTNESS</replaceable></arg>
</term>
<listitem><para>
Set the initial brightness [default: 255; legal: 0 - 255]
</para></listitem>
</varlistentry>
<varlistentry>
<term>
<command>Speed=</command>
<arg choice="plain">
<group choice="req">
<arg choice="plain"><literal>2400</literal></arg>
<arg choice="plain"><literal><emphasis>9600</emphasis></literal></arg>
</group>
</arg>
</term>
<listitem><para>
Set the the baud rate to use when communicating with the LCD.
If not given, the default is <literal>9600</literal>.
</para></listitem>
</varlistentry>
<varlistentry>
<term>
<command>Reboot=</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>
</term>
<listitem><para>
Reinitialize the LCD's BIOS [default: no; legal: yes, no]
</para></listitem>
</varlistentry>
</variablelist>
</sect3>
</sect2>
</sect1>
docs/lcdproc-user/drivers/lcdm001.docbook
+94
View File
@@ -0,0 +1,94 @@
<sect1 id="lcdm001-howto">
<title>The lcdm001 Driver</title>
<para>
This section talks about using LCDproc with LCD displays that use the
lcdm001 chipset.
</para>
<!-- ## LCDM001 driver ## -->
<sect2 id="lcdm001-config">
<title>Configuration in LCDd.conf</title>
<sect3>
<title>[lcdm001]</title>
<variablelist>
<varlistentry>
<term>
<command>Device=</command>
<arg choice="plain"><replaceable>DEVICE</replaceable></arg>
</term>
<listitem><para>
Default: <filename>/dev/lcd</filename>
</para></listitem>
</varlistentry>
<varlistentry>
<term>
<command>PauseKey=<replaceable>LeftKey</replaceable></command>
<arg choice="plain"><replaceable>KEY</replaceable></arg>
</term>
<term>
<command>BackKey=<replaceable>UpKey</replaceable></command>
<arg choice="plain"><replaceable>KEY</replaceable></arg>
</term>
<term>
<command>ForwardKey=<replaceable>DownKey</replaceable></command>
<arg choice="plain"><replaceable>KEY</replaceable></arg>
</term>
<term>
<command>MainMenuKey=<replaceable>RightKey</replaceable></command>
<arg choice="plain"><replaceable>KEY</replaceable></arg>
</term>
<listitem>
<para>
keypad settings
</para>
<informaltable>
<tgroup cols="3">
<thead>
<row>
<entry>key name</entry>
<entry>function (normal context)</entry>
<entry>function (menu context)</entry>
</row>
</thead>
<tbody>
<row>
<entry>PauseKey</entry>
<entry>Pause/Continue</entry>
<entry>Enter/select</entry>
</row>
<row>
<entry>BackKey</entry>
<entry>Back(Go to previous screen)</entry>
<entry>Up/Left</entry>
</row>
<row>
<entry>ForwardKey</entry>
<entry>Forward(Go to next screen)</entry>
<entry>Down/Right</entry>
</row>
<row>
<entry>MainMenuKey</entry>
<entry>Open main menu</entry>
<entry>Exit/Cancel</entry>
</row>
</tbody>
</tgroup>
</informaltable>
<para>
You can rearrange the settings here.
</para>
</listitem>
</varlistentry>
</variablelist>
If your device is broken, have a look at server/drivers/lcdm001.h
</sect3>
</sect2>
</sect1>
docs/lcdproc-user/drivers/lcterm.docbook
+46
View File
@@ -0,0 +1,46 @@
<sect1 id="lcterm-howto">
<title>The lcterm Driver</title>
<para>
This section talks about using LCDproc with LCD displays that use the
lcterm chipset.
</para>
<!-- ## HNE LCTerm driver ## -->
<sect2 id="lcterm-config">
<title>Configuration in LCDd.conf</title>
<sect3>
<title>[lcterm]</title>
<variablelist>
<varlistentry>
<term>
<command>Device=</command>
<arg choice="plain"><replaceable>DEVICE</replaceable></arg>
</term>
<listitem><para>
Default: <filename>/dev/lcd</filename>
</para></listitem>
</varlistentry>
<varlistentry>
<term>
<command>Size=</command>
<arg choice="plain">
<replaceable>WIDTH</replaceable>
<literal>x</literal>
<replaceable>HEIGHT</replaceable>
</arg>
</term>
<listitem><para>
16x2
</para></listitem>
</varlistentry>
</variablelist>
</sect3>
</sect2>
</sect1>
docs/lcdproc-user/drivers/lircin.docbook
+77 -6
View File
@@ -111,6 +111,53 @@ The prog=... line must be the same as in your <filename>~/.lircrc</filename>
</sect3>
<!-- ## LIRC input driver ## -->
<sect2 id="lirc-config">
<title>Configuration in LCDd.conf</title>
<sect3>
<title>[lirc]</title>
<variablelist>
<varlistentry>
<term>
<command>lircrc=</command>
<arg choice="plain"><replaceable>FILENAME</replaceable></arg>
</term>
<listitem>
<para>
Normally all LIRC clients scan the file <filename>~/.lircrc</filename>.
However, you might want to have a separate file to configure the LCDproc lircin driver only.
</para>
<para>
This option enables you to specify the file you want the lircin driver to scan.
If not given it defaults to <filename>~/.lircrc</filename>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<command>Prog=</command>
<arg choice="plain"><replaceable>PROGRAM</replaceable></arg>
</term>
<listitem>
<para>
All LIRC keys are assigned to a program using the prog=... option
in the lirc configuration file.
</para>
<para>
<replaceable>PROGRAM</replaceable> must be the same as in iyour lirc
configuration file.
</para>
</listitem>
</varlistentry>
</variablelist>
</sect3>
</sect2>
</sect2>
<sect2 id="lircrc">
@@ -128,31 +175,44 @@ lines to the file:
</para>
<example>
<title><filename>~/.lircrc</filename>: Specify the keys for the lircin driver</title>
<title><filename>~/.lircrc</filename>: Specify the associations from buttons to keysi
for the lircin driver</title>
<programlisting>
begin
prog = lcdd
button = 2
config = A
config = Up
end
begin
prog = lcdd
button = 4
config = B
config = Left
end
begin
prog = lcdd
button = 6
config = C
config = Right
end
begin
prog = lcdd
button = 8
config = D
config = Down
end
begin
prog = lcdd
button = 1
config = Escape
end
begin
prog = lcdd
button = 0
config = Enter
end
@@ -161,7 +221,18 @@ end
<para>
Which buttons you specify here depends on your RC and your LIRC configuration.
Anyways, config=A/B/C/D is neccessary to control the server menu of LCDd.
</para>
<para>
The <literal>config</literal> values need to be one of <literal>Up</literal>,
<literal>Down</literal>, <literal>Left</literal>, <literal>Right</literal>,
<literal>Escape</literal> or <literal>Enter</literal>.
For LCDd's server menu at least the keys <literal>Up</literal>, <literal>Escape</literal>
and <literal>Enter</literal> are necessary.
</para>
<para>
<!-- TOTO: is this still true with 0.5 ? -->
Of course you can define other keys. Those keys will not be handled by the
server but sent to a client. Refer to the documentation of the client you want
to use, to find out which keys are neccessary for that client.
docs/lcdproc-user/drivers/ms6931.docbook
+46
View File
@@ -0,0 +1,46 @@
<sect1 id="ms6931-howto">
<title>The ms6931 Driver</title>
<para>
This section talks about using LCDproc with LCD displays that use the
ms6931 chipset.
</para>
<!-- ## MSI MS-6931 driver for displays in 1HU servers ## -->
<sect2 id="ms6931-config">
<title>Configuration in LCDd.conf</title>
<sect3>
<title>[ms6931]</title>
<variablelist>
<varlistentry>
<term>
<command>Device=</command>
<arg choice="plain"><replaceable>DEVICE</replaceable></arg>
</term>
<listitem><para>
device to use [default: <filename>/dev/ttyS1</filename>]
</para></listitem>
</varlistentry>
<varlistentry>
<term>
<command>Size=</command>
<arg choice="plain">
<replaceable>WIDTH</replaceable>
<literal>x</literal>
<replaceable>HEIGHT</replaceable>
</arg>
</term>
<listitem><para>
display size [default: 16x2]
</para></listitem>
</varlistentry>
</variablelist>
</sect3>
</sect2>
</sect1>
docs/lcdproc-user/drivers/mtc_s16209x.docbook
+57
View File
@@ -0,0 +1,57 @@
<sect1 id="mtc_s16209x-howto">
<title>The mtc_s16209x Driver</title>
<para>
This section talks about using LCDproc with LCD displays that use the
mtc_s16209x chipset.
</para>
<!-- ## MTC-S16209x driver ## -->
<sect2 id="mtc_s16209x-config">
<title>Configuration in LCDd.conf</title>
<sect3>
<title>[mtc_s16209x]</title>
<variablelist>
<varlistentry>
<term>
<command>Device=</command>
<arg choice="plain"><replaceable>DEVICE</replaceable></arg>
</term>
<listitem><para>
Select the output device to use [default: <filename>/dev/lcd</filename>]
</para></listitem>
</varlistentry>
<varlistentry>
<term>
<command>Brightness=</command>
<arg choice="plain"><replaceable>BRIGHTNESS</replaceable></arg>
</term>
<listitem><para>
Set the initial brightness [default: 255; legal: 0 - 255]
</para></listitem>
</varlistentry>
<varlistentry>
<term>
<command>Reboot=</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>
</term>
<listitem><para>
Reinitialize the LCD's BIOS [default: no; legal: yes, no]
</para></listitem>
</varlistentry>
</variablelist>
</sect3>
</sect2>
</sect1>
docs/lcdproc-user/drivers/mtxorb.docbook
+162
View File
@@ -218,4 +218,166 @@ Slightly modified in order to include it in this document March 2002, Rene Wagne
</para>
</sect2>
<!-- ## Matrix Orbital driver ## -->
<sect2 id="MtxOrb-config">
<title>Configuration in LCDd.conf</title>
<sect3>
<title>[MtxOrb]</title>
<variablelist>
<varlistentry>
<term>
<command>Device=</command>
<arg choice="plain"><replaceable>DEVICE</replaceable></arg>
</term>
<listitem><para>
Select the output device to use [default: <filename>/dev/lcd</filename>]
</para></listitem>
</varlistentry>
<varlistentry>
<term>
<command>Size=</command>
<arg choice="plain">
<replaceable>WIDTH</replaceable>
<literal>x</literal>
<replaceable>HEIGHT</replaceable>
</arg>
</term>
<listitem><para>
Set the display size [default: 20x4]
</para></listitem>
</varlistentry>
<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>
</term>
<listitem><para>
Switch on the backlight? [default: yes]
</para>
<note><para>
The driver will ignore this setting if the display
is a VFD or VKD as they crash if the backlight is turned off.
</para></note>
</listitem>
</varlistentry>
<varlistentry>
<term>
<command>Contrast=</command>
<arg choice="plain"><replaceable>CONTRAST</replaceable></arg>
</term>
<listitem><para>
Set the initial contrast.
Legal values for <replaceable>CONTRAST</replaceable> are <literal>0</literal> - <literal>1000</literal>.
If not given, the default value is <literal>480</literal>.
</para>
<note><para>
The driver will ignore this setting if the display
is a VFD or VKD as they do not support this feature.
</para></note>
</listitem>
</varlistentry>
<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>
</term>
<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>
</varlistentry>
<varlistentry>
<term>
<command>Type=</command>
<arg choice="plain">
<group choice="req">
<arg choice="plain"><literal><emphasis>lcd</emphasis></literal></arg>
<arg choice="plain"><literal>lkd</literal></arg>
<arg choice="plain"><literal>vfd</literal></arg>
<arg choice="plain"><literal>vkd</literal></arg>
</group>
</arg>
</term>
<listitem><para>
Set the display type [default: lcd; legal: lcd, lkd, vfd, vkd]
</para></listitem>
</varlistentry>
<varlistentry>
<term>
<command>LeftKey=</command>
<arg choice="plain"><replaceable>MTX-KEY</replaceable></arg>
</term>
<term>
<command>RightKey=</command>
<arg choice="plain"><replaceable>MTX-KEY</replaceable></arg>
</term>
<term>
<command>EnterKey=</command>
<arg choice="plain"><replaceable>MTX-KEY</replaceable></arg>
</term>
<term>
<command>UpKey=</command>
<arg choice="plain"><replaceable>MTX-KEY</replaceable></arg>
</term>
<term>
<command>DownKey=</command>
<arg choice="plain"><replaceable>MTX-KEY</replaceable></arg>
</term>
<term>
<command>EscapeKey=</command>
<arg choice="plain"><replaceable>MTX-KEY</replaceable></arg>
</term>
<listitem><para>
The following table translate from MtxOrb Key to Logical Key.
See [input] section for an explanation of the key mappings
This is a new implementation in 0.5
Legal values for <replaceable>MTX-KEY</replaceable> are the letters
<literal>A</literal> - <literal>F</literal>.
</para></listitem>
</varlistentry>
<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>
</term>
<listitem><para>
You can find out which key of your display sends which
character by setting keypad_test_mode to yes and running
LCDd. LCDd will output all characters it receives.
Afterwards you can modify the settings above and set
keypad_set_mode to no again.
</para></listitem>
</varlistentry>
</variablelist>
</sect3>
</sect2>
</sect1>
docs/lcdproc-user/drivers/pylcd.docbook
+109
View File
@@ -0,0 +1,109 @@
<sect1 id="pylcd-howto">
<title>The pylcd Driver</title>
<para>
This section talks about using LCDproc with LCD displays that use the
pylcd chipset.
</para>
<sect2 id="pylcd-connections">
<title>Connections</title>
</sect2>
<sect2 id="pylcd-ledoutput">
<title>LED output</title>
<para>
I've added support for the LEDs on the Pyramid LC-Display to the
pylcd driver of lcdproc.
</para>
<para>
Since it seems that LEDs on an LCD are not directly supported by the
lcdproc API I've used the "output" command of the server to trigger the
LEDs, similar to what the IOWarrior driver does.
</para>
<para>
The Pyramid LC-Display exists in two different versions, with 3 and with
9 LEDs. 2 of these LEDs can not be controlled by software but are
usually hard wired to power and HDD. The other 1 or 7 LEDs can now be
controlled by sending an "output" command to the server. The one
argument to the output command is a bitmask that controls the LEDs.
</para>
<screen>
bit 0: LED3
bit 1: LED4
bit 2: LED5
bit 3: LED6
bit 4: LED7
bit 5: LED8
bit 6: LED9
</screen>
<para>
There's no way of finding out whether 3 or 9 LEDs are available, so it
is up to the software to do the right thing.
</para>
<example>
<title>How to use the LCED output from the lcient</title>
<programlisting>
telnet localhost 13666
hello
output 67
</programlisting>
will light up LEDs 3, 4 and 9.
<programlisting>
output 0
</programlisting>
will clear all LEDs.
</example>
<para>
More information on the Pyramid LC-Display can be found here:
<ulink url="http://www.pyramid.de/e/produkte/server/pyramid-lcd.php"></ulink>
</para>
</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 pylcd driver ## -->
<sect2 id="pylcd-config">
<title>Configuration in LCDd.conf</title>
<sect3>
<title>[pylcd]</title>
<variablelist>
<varlistentry>
<term>
<command>Device=</command>
<arg choice="plain"><replaceable>DEVICE</replaceable></arg>
</term>
<listitem><para>
Device to connect to. Default: <filename>/dev/lcd</filename>
</para></listitem>
</varlistentry>
</variablelist>
</sect3>
</sect2>
</sect1>
docs/lcdproc-user/drivers/sed1330.docbook
+58
View File
@@ -0,0 +1,58 @@
<sect1 id="sed1330-howto">
<title>The sed1330 Driver</title>
<para>
This section talks about using LCDproc with LCD displays that use the
sed1330 chipset.
</para>
<!-- ## Seiko Epson 1330 driver ## -->
<sect2 id="sed1330-config">
<title>Configuration in LCDd.conf</title>
<sect3>
<title>[sed1330]</title>
<variablelist>
<varlistentry>
<term>
<command>Port=</command>
<arg choice="plain"><replaceable>PORT</replaceable></arg>
</term>
<listitem><para>
Specify the address of the parallel port the LCD is connected to.
Common values for <replaceable>PORT</replaceable> are <literal>0x278</literal>,
<literal>0x378</literal> and <literal>0x3BC</literal>.
If not given, it defaults to <literal>0x278</literal>.
</para></listitem>
</varlistentry>
<varlistentry>
<term>
<command>Type=</command>
<arg choice="plain">
<group choice="req">
<arg choice="plain"><literal>G321D</literal></arg>
<arg choice="plain"><literal>G121C</literal></arg>
<arg choice="plain"><literal>G242C</literal></arg>
<arg choice="plain"><literal>G191D</literal></arg>
<arg choice="plain"><literal>G2446</literal></arg>
</group>
</arg>
</term>
<listitem>
<para>
Type of LCD module.
</para>
<note><para>
The G321D is the only one that is tested currently.
</para></note>
</listitem>
</varlistentry>
</variablelist>
</sect3>
</sect2>
</sect1>
docs/lcdproc-user/drivers/sed1520.docbook
+35
View File
@@ -0,0 +1,35 @@
<sect1 id="sed1520-howto">
<title>The sed1520 Driver</title>
<para>
This section talks about using LCDproc with LCD displays that use the
sed1520 chipset.
</para>
<!-- ## Seiko Epson 1520 driver ## -->
<sect2 id="sed1520-config">
<title>Configuration in LCDd.conf</title>
<sect3>
<title>[sed1520]</title>
<variablelist>
<varlistentry>
<term>
<command>Port=</command>
<arg choice="plain"><replaceable>PORT</replaceable></arg>
</term>
<listitem><para>
Specify the address of the parallel port the LCD is connected to.
Common values for <replaceable>PORT</replaceable> are <literal>0x278</literal>,
<literal>0x378</literal> and <literal>0x3BC</literal>.
The default value is <literal>0x378</literal>.
</para></listitem>
</varlistentry>
</variablelist>
</sect3>
</sect2>
</sect1>
docs/lcdproc-user/drivers/serialVFD.docbook
+307
View File
@@ -0,0 +1,307 @@
<sect1 id="serialVFD-howto">
<title>The serialVFD Driver</title>
<para>
This section talks about using LCDproc with LCD displays that use the
serialVFD chipset.
</para>
<sect2 id="serialVFD-connections">
<title>Connections</title>
The serialVFD-driver should work with all NEC FIPC8367 based VFDs:
NEC FC20X2JA
NEC FM20X2KB-AB
NEC FC20X1SA-AB/AA
...
Tested only on: NEC FM20X2KB-AB
The driver also works (tested) on "KD Rev 2.1" (an ATMEL AT90S....
based FM20X2KB-AB replacement).
Note: Above char. 128 the FIPC-displays and KD's charactersets
are different.
The driver may work or will be easy to get working on the following
Displays / Controllers (not tested!).
<table>
<tgroup cols="2">
<thead>
<row>
<entry>Display</entry>
<entry>Controller</entry>
</row>
</thead>
<tbody>
<row>
<entry>FUTABA M204SD01AA</entry>
<entry>FUTABA 5P00A016</entry>
</row>
<row>
<entry>Noritake CU20026SCPB-T</entry>
<entry>(microcontroller)</entry>
</row>
<row>
<entry>Noritake CU20045SCPB-T28A</entry>
<entry>?</entry>
</row>
</tbody>
</tgroup>
</table>
... or compatible.
(most Futaba/Noritake 7x5 dot VFDs with serial(rs232) interface
(including serial(rs232)/parallel types))
<para>
Maybe there are little changes in the commands to do to get all
functions to work correctly. But because of the similarity of the
protocols, it wont be much work.
</para>
<para>
If you want to add a new device to the driver add a new section
to the displaytype-switch-case in the init-function and fill it
with the correct commands for the display.
(Try which displaytype works best with your display, copy and modify
it's section that is the easiest way I guess.)
</para>
<para>
On this page you may find pictures and datasheets of the VFDs:
<ulink url="http://www.maltepoeggel.de/html/vfd/index.html"></ulink>
</para>
<para>
It is possible to switch the display off and back on while the server is
running. It may take a few minutes until the next full refresh makes
the display show everything correctly.
</para>
<para>
To enable the bignumbers on 2-line displays (only this driver supports
this yet) you have to edit <filename>clients/lcdproc/chrono.c</filename>
before compiling.
In function <function>big_clock_screen</function> you have to replace the
<literal>4</literal> by a <literal>2</literal> in this line:
<code>if (lcd_hgt &lt; 4)</code>
</para>
<para>
This driver uses the serial mode of the displays.
It is NOT possible to connect most of the displays directly to the
serialport. The signal has to be inverted. I use the following
circuit to do that job.
</para>
<figure>
<title>serialVFD: Connecting the display</title>
<screen>
<![CDATA[
Computer Display
(signal)
HDD Powerconnector
color(Voltage)
red(+5V) --------------------------------o----- +5V
|
black(GND) --------------------o |
| R
| R 10k
Serial(SUB-D 9Pin female) V* R
pin(signal) |
|
3(TxD) --RRRR--o--o o-----------------o----- RxD
10k | | |
| | C|
| | ----- BC547c (or similar NPN)
R | B| / |
10k R o--|-| |
R | \ |
| --->- A*
| E| |
| | |
5(GND) --------o----------o----o----------------- GND
Shield ------------------------------------------
optional
*connect near display
]]>
</screen>
</figure>
The pins on the different displays vary.
FM20X2KB-AB:
CN1:
Pin 33 &lt;--- RxD
(Testmode: connect pins 25 and 26, then power up)
CN2:
Pin 1 &lt;--- +5V
Pin 2 &lt;--- GND
KD Rev 2.1:
blue connector (6pin in a row) (the important one!):
<screen>
<![CDATA[
--------------------------------
| +5V +5V RxD GND GND GND |
--------------------------------
]]>
</screen>
<tip>
<para>
Hold the display in that position where you can read
the "KD Rev 2.1" marking normally!
</para>
</tip>
gray connector (10pin 2 rows):
Do not use. (the ATMEL ISP connector I guess)
The two jumpers next to the gray connector:
Normally not used.
You can activate two different testmodes with them.
</sect2>
<!-- ## Serial VFD driver ## -->
<sect2 id="serialVFD-config">
<title>Configuration in LCDd.conf</title>
<sect3>
<title>[serialVFD]</title>
<variablelist>
<varlistentry>
<term>
<command>Device=</command>
<arg choice="plain"><replaceable>DEVICE</replaceable></arg>
</term>
<listitem><para>
Device where the VFD is. Usual values are <filename>/dev/ttyS0</filename> and <filename>/dev/ttyS1</filename>
Default: <filename>/dev/lcd</filename>
</para></listitem>
</varlistentry>
<varlistentry>
<term>
<command>Size=</command>
<arg choice="plain">
<replaceable>WIDTH</replaceable>
<literal>x</literal>
<replaceable>HEIGHT</replaceable>
</arg>
</term>
<listitem><para>
Specifies the size of the VFD.
default: <literal>20x2</literal>
</para></listitem>
</varlistentry>
<varlistentry>
<term>
<command>Type=</command>
<arg choice="plain"><replaceable>CODE</replaceable></arg>
</term>
<listitem>
<para>
Specifies the display type.[default: 0]
The following type codes are available:
</para>
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry><replaceable>CODE</replaceable></entry>
<entry>VFD model</entry>
</row>
</thead>
<tbody>
<row>
<entry><literal><emphasis>0</emphasis></literal></entry>
<entry>NEC (FIPC8367 based) VFDs</entry>
</row>
<row>
<entry><literal>1</literal></entry>
<entry>KD Rev 2.1</entry>
</row>
<row>
<entry><literal>2</literal></entry>
<entry>Noritake VFDs</entry>
</row>
<row>
<entry><literal>3</literal></entry>
<entry>Futaba VFDs</entry>
</row>
</tbody>
</tgroup>
</informaltable>
<note><para>
Options 3 and 4 should work, but have not been tested yet. Feedback is welcome.
</para></note>
</listitem>
</varlistentry>
<varlistentry>
<term>
<command>Brightness=</command>
<arg choice="plain"><replaceable>BRIGHTNESS</replaceable></arg>
</term>
<listitem><para>
Display brightness [default: 255].
0 min ... 255 max ... 1000 also max
(4 steps 0-64, 65-128, 129-192, 193-1000)
</para></listitem>
</varlistentry>
<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><emphasis>9600</emphasis></literal></arg>
<arg choice="plain"><literal>19200</literal></arg>
<arg choice="plain"><literal>115200</literal></arg>
</group>
</arg>
</term>
<listitem><para>
Set the the baud rate communication with the VFD.
If not given, it defaults to <literal>9600</literal>.
</para></listitem>
</varlistentry>
<varlistentry>
<term>
<command>ISO_8859_1=</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>
</term>
<listitem><para>
Enable ISO-8859-1 compatibility. Ddefault is <literal>yes</literal>.
</para></listitem>
</varlistentry>
</variablelist>
</sect3>
</sect2>
</sect1>
docs/lcdproc-user/drivers/sli.docbook
+53
View File
@@ -0,0 +1,53 @@
<sect1 id="sli-howto">
<title>The sli Driver</title>
<para>
This section talks about using LCDproc with LCD displays that use the
sli chipset.
</para>
<!-- ## Wirz SLI LCD driver ## -->
<sect2 id="Wirz-sli-config">
<title>Configuration in LCDd.conf</title>
<sect3>
<title>[Wirz-sli]</title>
<variablelist>
<varlistentry>
<term>
<command>Device=</command>
<arg choice="plain"><replaceable>DEVICE</replaceable></arg>
</term>
<listitem><para>
Select the output device to use [default: <filename>/dev/lcd</filename>]
</para></listitem>
</varlistentry>
<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>
<arg choice="plain"><literal>38400</literal></arg>
<arg choice="plain"><literal>57600</literal></arg>
<arg choice="plain"><literal>115200</literal></arg>
</group>
</arg>
</term>
<listitem><para>
Set the the baud rate communication with the LCD.
If not specified, the default is <literal>19200</literal>.
</para></listitem>
</varlistentry>
</variablelist>
</sect3>
</sect2>
</sect1>
docs/lcdproc-user/drivers/stv5730.docbook
+35
View File
@@ -0,0 +1,35 @@
<sect1 id="stv5730-howto">
<title>The stv5730 Driver</title>
<para>
This section talks about using LCDproc with LCD displays that use the
stv5730 chipset.
</para>
<!-- ## stv5730 driver ## -->
<sect2 id="stv5730-config">
<title>Configuration in LCDd.conf</title>
<sect3>
<title>[stv5730]</title>
<variablelist>
<varlistentry>
<term>
<command>Port=</command>
<arg choice="plain"><replaceable>PORT</replaceable></arg>
</term>
<listitem><para>
Specify the address of the parallel port the LCD is connected to.
Common values for <replaceable>PORT</replaceable> are <literal>0x278</literal>,
<literal>0x378</literal> and <literal>0x3BC</literal>.
If not given, it defaults to <literal>0x378</literal>.
</para></listitem>
</varlistentry>
</variablelist>
</sect3>
</sect2>
</sect1>
docs/lcdproc-user/drivers/svga.docbook
+87
View File
@@ -0,0 +1,87 @@
<sect1 id="svga-howto">
<title>The svga Driver</title>
<para>
This section talks about using LCDproc with LCD displays that use the
svga chipset.
</para>
<!-- ## SVGAlib driver ## -->
<sect2 id="svga-config">
<title>Configuration in LCDd.conf</title>
<sect3>
<title>[svga]</title>
<variablelist>
<varlistentry>
<term>
<command>Mode=</command>
<arg choice="plain"><replaceable>SCGALIB-MODE</replaceable></arg>
</term>
<listitem><para>
svgalib mode to use [default: G320x240x256]
<replaceable>SCGALIB-MODE</replaceable> can be any legal mode string for svgalib.
See the <citerefentry><refentrytitle>cwsvgalib</refentrytitle>
<manvolnum>7</manvolnum></citerefentry> manual page for legal mode strings.
</para></listitem>
</varlistentry>
<varlistentry>
<term>
<command>Size=</command>
<arg choice="plain">
<replaceable>WIDTH</replaceable>
<literal>x</literal>
<replaceable>HEIGHT</replaceable>
</arg>
</term>
<listitem><para>
set display size [default: 20x4]
</para></listitem>
</varlistentry>
<varlistentry>
<term>
<command>Contrast=</command>
<arg choice="plain"><replaceable>CONTRAST</replaceable></arg>
</term>
<listitem><para>
Set the initial contrast.
Legal values for <replaceable>CONTRAST</replaceable> are <literal>0</literal> - <literal>1000</literal>.
If not given, the default value is <literal>500</literal>.
</para>
<note><para>
This parameter can be set but it does not change anything in the driver.
</para></note>
</listitem>
</varlistentry>
<varlistentry>
<term>
<command>Brightness=</command>
<arg choice="plain"><replaceable>BRIGHTNESS</replaceable></arg>
</term>
<listitem><para>
Set the initial brightness [default: 1000; legal: 1 - 1000]
</para></listitem>
</varlistentry>
<varlistentry>
<term>
<command>OffBrightness=</command>
<arg choice="plain"><replaceable>BRIGHTNESS</replaceable></arg>
</term>
<listitem><para>
Set the initial off-brightness [default: 500; legal: 1 - 1000]
This value is used when the display is normally
switched off in case LCDd is inactive
</para></listitem>
</varlistentry>
</variablelist>
</sect3>
</sect2>
</sect1>
docs/lcdproc-user/drivers/t6963.docbook
+105 -68
View File
@@ -3,7 +3,7 @@
<para>
This section talks about using LCDproc with LCD displays that use the
T6963 chipset. Usually, this chipset is used on big character LCD
T6963 chipset from Toshiba. Usually, this chipset is used on big character LCD
displays that can often act as a screen.
</para>
@@ -13,42 +13,42 @@ displays that can often act as a screen.
<table>
<title>T6963 wiring schematic</title>
<tgroup cols="2">
<thead>
<row>
<entry>Parallel port</entry>
<entry>LCD</entry>
</row>
</thead>
<tbody>
<row>
<entry>1 (Strobe)</entry>
<entry>5 (WR)</entry>
</row>
<row>
<entry>2-9 (Data)</entry>
<entry>11-18 (Data)</entry>
</row>
<row>
<entry>14 (Autofeed)</entry>
<entry>7 (CE)</entry>
</row>
<row>
<entry>16 (Init)</entry>
<entry>8 (C/D)</entry>
</row>
<row>
<entry>17 (Slct)</entry>
<entry>6 (RD)</entry>
</row>
<row>
<entry>18 (GND)</entry>
<entry>3 (GND)</entry>
</row>
<row>
<entry>+5V</entry>
<entry>3 (LCD +)</entry>
</row>
</tbody>
<thead>
<row>
<entry>Parallel port</entry>
<entry>LCD</entry>
</row>
</thead>
<tbody>
<row>
<entry>1 (Strobe)</entry>
<entry>5 (WR)</entry>
</row>
<row>
<entry>2-9 (Data)</entry>
<entry>11-18 (Data)</entry>
</row>
<row>
<entry>14 (Autofeed)</entry>
<entry>7 (CE)</entry>
</row>
<row>
<entry>16 (Init)</entry>
<entry>8 (C/D)</entry>
</row>
<row>
<entry>17 (Slct)</entry>
<entry>6 (RD)</entry>
</row>
<row>
<entry>18 (GND)</entry>
<entry>3 (GND)</entry>
</row>
<row>
<entry>+5V</entry>
<entry>3 (LCD +)</entry>
</row>
</tbody>
</tgroup>
</table>
@@ -65,41 +65,74 @@ can be done by specifying "--enable-drivers=all" or by
</sect2>
<sect2 id="T6963-configuration">
<title>Configuration</title>
<!-- ## Toshiba T6963 driver ## -->
<sect2 id="t6963-config">
<title>Configuration in LCDd.conf</title>
<para>
Since LCDproc 0.4.3 the T6963 driver must be configured from the configfile (LCDd.conf).
</para>
<sect3>
<title>[t6963]</title>
<para>
At the time of writing, the T6369 driver uses the Arguments option for its
configuration. This will be parsed as if is was passed as argument to a program.
</para>
<variablelist>
<varlistentry>
<term>
<command>Size=</command>
<arg choice="plain">
<replaceable>WIDTH</replaceable>
<literal>x</literal>
<replaceable>HEIGHT</replaceable>
</arg>
</term>
<listitem><para>
set display size [default: 20x6]
</para></listitem>
</varlistentry>
<table>
<title>Arguments</title>
<tgroup cols="2">
<thead>
<row>
<entry>-p --port</entry>
<entry>Select the output port to use [0x378]</entry>
</row>
</thead>
<tbody>
<row>
<entry>-t --type</entry>
<entry>Select the LCD type (size) [20x6]</entry>
</row>
</tbody>
</tgroup>
</table>
<varlistentry>
<term>
<command>Port=</command>
<arg choice="plain"><replaceable>PORT</replaceable></arg>
</term>
<listitem><para>
Specify the address of the parallel port the LCD is connected to.
Common values for <replaceable>PORT</replaceable> are <literal>0x278</literal>,
<literal>0x378</literal> and <literal>0x3BC</literal>.
Legal values are <literal>0x200</literal> - <literal>0x400</literal>.
If not given the default value is <literal>0x378</literal>.
</para></listitem>
</varlistentry>
<tip>
<para>
An example configuration could look like this: Arguments="--port 0x378 --type=20x6"
</para>
</tip>
<varlistentry>
<term>
<command>ECPlpt=</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>
</term>
<listitem><para>
Is ECP mode on? [default: yes; legal: yes, no]
</para></listitem>
</varlistentry>
<varlistentry>
<term>
<command>graphic=</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>
</term>
<listitem><para>
Use graphic? [default: no; legal: yes, no]
</para></listitem>
</varlistentry>
</variablelist>
</sect3>
</sect2>
@@ -114,15 +147,19 @@ detailed instructions on how to configure the T6963 driver.
<para>
Then as usual, start LCDd with the correct config file:
</para>
<para>
E.g. <command>LCDd -c ./LCDd.conf</command>
</para>
<para>
If you want to override the driver selection in LCDd.conf then use:
</para>
<para>
<command>LCDd -c ./LCDd.conf -d T6963</command>
</para>
<para>
If you use this, the T6963 driver will read the options from the config
file anyway.
docs/lcdproc-user/drivers/text.docbook
+36
View File
@@ -0,0 +1,36 @@
<sect1 id="text-howto">
<title>The text Driver</title>
<para>
This section talks about using LCDproc with LCD displays that use the
text chipset.
</para>
<!-- ## Text driver ## -->
<sect2 id="text-config">
<title>Configuration in LCDd.conf</title>
<sect3>
<title>[text]</title>
<variablelist>
<varlistentry>
<term>
<command>Size=</command>
<arg choice="plain">
<replaceable>WIDTH</replaceable>
<literal>x</literal>
<replaceable>HEIGHT</replaceable>
</arg>
</term>
<listitem><para>
Set the display size [default: 20x4]
</para></listitem>
</varlistentry>
</variablelist>
</sect3>
</sect2>
</sect1>
docs/lcdproc-user/drivers/tyan.docbook
+62
View File
@@ -0,0 +1,62 @@
<sect1 id="tyan-howto">
<title>The tyan Driver</title>
<para>
This section talks about using LCDproc with LCD displays that use the
tyan chipset.
</para>
<!-- ## Tyan Barebones LCD driver (GS series; others too?) ## -->
<sect2 id="tyan-config">
<title>Configuration in LCDd.conf</title>
<sect3>
<title>[tyan]</title>
<variablelist>
<varlistentry>
<term>
<command>Device=</command>
<arg choice="plain"><replaceable>DEVICE</replaceable></arg>
</term>
<listitem><para>
Select the output device to use [default: <filename>/dev/lcd</filename>]
</para></listitem>
</varlistentry>
<varlistentry>
<term>
<command>Speed=</command>
<arg choice="plain">
<group choice="req">
<arg choice="plain"><literal>4800</literal></arg>
<arg choice="plain"><literal><emphasis>9600</emphasis></literal></arg>
</group>
</arg>
</term>
<listitem><para>
Set the the baud rate communication with the LCD.
If not given, the default is <literal>9600</literal>.
</para></listitem>
</varlistentry>
<varlistentry>
<term>
<command>Size=</command>
<arg choice="plain">
<replaceable>WIDTH</replaceable>
<literal>x</literal>
<replaceable>HEIGHT</replaceable>
</arg>
</term>
<listitem><para>
set display size [default: 16x2]
</para></listitem>
</varlistentry>
</variablelist>
</sect3>
</sect2>
</sect1>
docs/lcdproc-user/drivers/ula200.docbook
+110
View File
@@ -0,0 +1,110 @@
<sect1 id="ula200-howto">
<title>The ula200 Driver</title>
<para>
This section talks about using LCDproc with LCD displays that use the
ula200 chipset.
</para>
<!-- ## ELV ULA200 driver ## -->
<sect2 id="ula200-config">
<title>Configuration in LCDd.conf</title>
<sect3>
<title>[ula200]</title>
<variablelist>
<varlistentry>
<term>
<command>Size=</command>
<arg choice="plain">
<replaceable>WIDTH</replaceable>
<literal>x</literal>
<replaceable>HEIGHT</replaceable>
</arg>
</term>
<listitem><para>
Select the LCD size [default: 20x4]
</para></listitem>
</varlistentry>
<varlistentry>
<term>
<command>KeyMap_A=</command>
<arg choice="plain"><replaceable>KEY</replaceable></arg>
</term>
<term>
<command>KeyMap_B=</command>
<arg choice="plain"><replaceable>KEY</replaceable></arg>
</term>
<term>
<command>KeyMap_C=</command>
<arg choice="plain"><replaceable>KEY</replaceable></arg>
</term>
<term>
<command>KeyMap_D=</command>
<arg choice="plain"><replaceable>KEY</replaceable></arg>
</term>
<term>
<command>KeyMap_E=</command>
<arg choice="plain"><replaceable>KEY</replaceable></arg>
</term>
<term>
<command>KeyMap_F=</command>
<arg choice="plain"><replaceable>KEY</replaceable></arg>
</term>
<listitem><para>
If you have a non standard keypad you can associate any keystrings to keys.
There are 6 input key in the CwLnx hardware that generate characters
from '<literal>A</literal>' to '<literal>F</literal>'.
Legal values for <replaceable>KEY</replaceable> are <literal>Up</literal>,
<literal>Down</literal>, <literal>Left</literal>, <literal>Right</literal>,
<literal>Enter</literal> and <literal>Escape</literal>.
</para>
<para>
The following it the built-in default mapping hardcoded in the driver.
</para>
<informaltable>
<tgroup cols="2">
<tbody>
<row>
<entry>KeyMap_A</entry>
<entry><literal>Up</literal></entry>
</row>
<row>
<entry>KeyMap_B</entry>
<entry><literal>Down</literal></entry>
</row>
<row>
<entry>KeyMap_C</entry>
<entry><literal>Left</literal></entry>
</row>
<row>
<entry>KeyMap_D</entry>
<entry><literal>Right</literal></entry>
</row>
<row>
<entry>KeyMap_E</entry>
<entry><literal>Enter</literal></entry>
</row>
<row>
<entry>KeyMap_F</entry>
<entry><literal>Escape</literal></entry>
</row>
</tbody>
</tgroup>
</informaltable>
<para>
You may leave it unchanged if you have a standard keypad.
You can change it if you want to report other keystrings or have a non
standard keypad.
</para>
</listitem>
</varlistentry>
</variablelist>
</sect3>
</sect2>
</sect1>
docs/lcdproc-user/drivers/xosd.docbook
+46
View File
@@ -0,0 +1,46 @@
<sect1 id="xosd-howto">
<title>The xosd Driver</title>
<para>
This section talks about using LCDproc with LCD displays that use the
xosd chipset.
</para>
<!-- ## OnScreen Display using libxosd ## -->
<sect2 id="xosd-config">
<title>Configuration in LCDd.conf</title>
<sect3>
<title>[xosd]</title>
<variablelist>
<varlistentry>
<term>
<command>Size=</command>
<arg choice="plain">
<replaceable>WIDTH</replaceable>
<literal>x</literal>
<replaceable>HEIGHT</replaceable>
</arg>
</term>
<listitem><para>
set display size [default: 20x4]
</para></listitem>
</varlistentry>
<varlistentry>
<term>
<command>Font=</command>
<arg choice="plain"><replaceable>FONT</replaceable></arg>
</term>
<listitem><para>
font to use, e.g. <literal>-*-terminus-*-r-*-*-*-320-*-*-*-*-*</literal>.
</para></listitem>
</varlistentry>
</variablelist>
</sect3>
</sect2>
</sect1>
docs/lcdproc-user/lcdproc-user.docbook
+35 -4
View File
@@ -11,11 +11,42 @@
<!ENTITY contact SYSTEM "contact.docbook">
<!ENTITY license SYSTEM "license.docbook">
<!ENTITY hd44780 SYSTEM "drivers/hd44780.docbook">
<!ENTITY t6963 SYSTEM "drivers/t6963.docbook">
<!ENTITY ppttrouble SYSTEM "drivers/ppttrouble.docbook">
<!ENTITY mtxorb SYSTEM "drivers/mtxorb.docbook">
<!ENTITY lircin SYSTEM "drivers/lircin.docbook">
<!ENTITY bayrad SYSTEM "drivers/bayrad.docbook">
<!ENTITY CFontz SYSTEM "drivers/CFontz.docbook">
<!ENTITY CFontz633 SYSTEM "drivers/CFontz633.docbook">
<!ENTITY CFontzPacket SYSTEM "drivers/CFontzPacket.docbook">
<!ENTITY curses SYSTEM "drivers/curses.docbook">
<!ENTITY CwLnx SYSTEM "drivers/CwLnx.docbook">
<!ENTITY glcdlib SYSTEM "drivers/glcdlib.docbook">
<!ENTITY glk SYSTEM "drivers/glk.docbook">
<!ENTITY hd44780 SYSTEM "drivers/hd44780.docbook">
<!ENTITY icp_a106 SYSTEM "drivers/icp_a106.docbook">
<!ENTITY imon SYSTEM "drivers/imon.docbook">
<!ENTITY IOWarrior SYSTEM "drivers/IOWarrior.docbook">
<!ENTITY irman SYSTEM "drivers/irman.docbook">
<!ENTITY joy SYSTEM "drivers/joy.docbook">
<!ENTITY lb216 SYSTEM "drivers/lb216.docbook">
<!ENTITY lcdm001 SYSTEM "drivers/lcdm001.docbook">
<!ENTITY lcterm SYSTEM "drivers/lcterm.docbook">
<!ENTITY lirc SYSTEM "drivers/lircin.docbook">
<!ENTITY ms6931 SYSTEM "drivers/ms6931.docbook">
<!ENTITY mtc_s16209x SYSTEM "drivers/mtc_s16209x.docbook">
<!ENTITY MtxOrb SYSTEM "drivers/mtxorb.docbook">
<!ENTITY NoritakeVFD SYSTEM "drivers/NoritakeVFD.docbook">
<!ENTITY pylcd SYSTEM "drivers/pylcd.docbook">
<!ENTITY sed1330 SYSTEM "drivers/sed1330.docbook">
<!ENTITY sed1520 SYSTEM "drivers/sed1520.docbook">
<!ENTITY serialVFD SYSTEM "drivers/serialVFD.docbook">
<!ENTITY sli SYSTEM "drivers/sli.docbook">
<!ENTITY stv5730 SYSTEM "drivers/stv5730.docbook">
<!ENTITY svga SYSTEM "drivers/svga.docbook">
<!ENTITY t6963 SYSTEM "drivers/t6963.docbook">
<!ENTITY text SYSTEM "drivers/text.docbook">
<!ENTITY tyan SYSTEM "drivers/tyan.docbook">
<!ENTITY ula200 SYSTEM "drivers/ula200.docbook">
<!ENTITY xosd SYSTEM "drivers/xosd.docbook">
]>
<book id="lcdproc-user" lang="en">