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

Replace <term><command><arg> with <term><property><parameter> to describe

Browse Source 
options in the config file because:
 * <arg> can only be used within <cmdsynopsis>.
 * <cmdsynopsis> does not allow text outside <command> and <arg>.
 * <arg> does not allow decorating elements like <literal> or <emphasis>.
This fixes #2803057.

Add shortcut entities for commonly used parameters (yes/no, size).
Remove Debian patch which is obsoleted by above changes.
This commit is contained in:
mmdolze
2009-06-12 09:12:50 +00:00
parent 5108e4931e
commit f59af2e241
48 changed files with 794 additions and 1321 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/lcdproc-user/Makefile.am
+1
View File
@@ -11,6 +11,7 @@ EXTRA_DIST = bookinfo.docbook \
introduction.docbook \
lcdproc-user.docbook \
license.docbook \
parameters.ent \
running.docbook \
README.docbook
docs/lcdproc-user/configuration.docbook
+2 -10
View File
@@ -228,11 +228,7 @@ settings for the LCDproc server <application>LCDd</application>.
<varlistentry>
<term>
<property>ReportToSyslog</property> =
{
<emphasis><parameter><literal>no</literal></parameter></emphasis> |
<parameter><literal>yes</literal></parameter>
}
<property>ReportToSyslog</property> = &parameters.yesnodef;
</term>
<listitem>
<para>
@@ -276,11 +272,7 @@ settings for the LCDproc server <application>LCDd</application>.
<varlistentry>
<term>
<property>Foreground</property> =
{
<emphasis><parameter><literal>no</literal></parameter></emphasis> |
<parameter><literal>yes</literal></parameter>
}
<property>Foreground</property> = &parameters.yesnodef;
</term>
<listitem>
<para>
docs/lcdproc-user/drivers/CFontz.docbook
+19 -38
View File
@@ -15,8 +15,8 @@ CFA632 and CFA634 series by CrystalFontz, Inc.
<variablelist>
<varlistentry>
<term>
<command>Device</command> =
<arg choice="plain"><replaceable>DEVICE</replaceable></arg>
<property>Device</property> =
<parameter><replaceable>DEVICE</replaceable></parameter>
</term>
<listitem><para>
Select the serial output device to use.
@@ -26,12 +26,7 @@ CFA632 and CFA634 series by CrystalFontz, Inc.
<varlistentry>
<term>
<command>Size</command> =
<arg choice="plain">
<replaceable>WIDTH</replaceable>
<literal>x</literal>
<replaceable>HEIGHT</replaceable>
</arg>
<property>Size</property> = &parameters.size;
</term>
<listitem><para>
Set the LCD's dimensions in terms of characters per line and lines.
@@ -41,8 +36,8 @@ CFA632 and CFA634 series by CrystalFontz, Inc.
<varlistentry>
<term>
<command>Contrast</command> =
<arg choice="plain"><replaceable>CONTRAST</replaceable></arg>
<property>Contrast</property> =
<parameter><replaceable>CONTRAST</replaceable></parameter>
</term>
<listitem><para>
Set the initial contrast.
@@ -54,8 +49,8 @@ CFA632 and CFA634 series by CrystalFontz, Inc.
<varlistentry>
<term>
<command>Brightness</command> =
<arg choice="plain"><replaceable>BRIGHTNESS</replaceable></arg>
<property>Brightness</property> =
<parameter><replaceable>BRIGHTNESS</replaceable></parameter>
</term>
<listitem><para>
Set the initial brightness.
@@ -67,8 +62,8 @@ CFA632 and CFA634 series by CrystalFontz, Inc.
<varlistentry>
<term>
<command>OffBrightness</command> =
<arg choice="plain"><replaceable>BRIGHTNESS</replaceable></arg>
<property>OffBrightness</property> =
<parameter><replaceable>BRIGHTNESS</replaceable></parameter>
</term>
<listitem><para>
Set the initial off-brightness.
@@ -82,16 +77,14 @@ CFA632 and CFA634 series by CrystalFontz, Inc.
<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>
<property>Speed</property> =
{
<parameter><literal>1200</literal></parameter> |
<parameter><literal>2400</literal></parameter> |
<emphasis><parameter><literal>9600</literal></parameter></emphasis> |
<parameter><literal>19200</literal></parameter> |
<parameter><literal>115200</literal></parameter> |
}
</term>
<listitem><para>
Set the the baud rate to use when communicating with the LCD.
@@ -101,13 +94,7 @@ CFA632 and CFA634 series by CrystalFontz, Inc.
<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>
<property>NewFirmware</property> = &parameters.yesnodef;
</term>
<listitem><para>
Set the firmware version (<emphasis>New</emphasis> means >= 2.0) [default: <literal>no</literal>; legal: <literal>yes</literal>, <literal>no</literal>]
@@ -116,13 +103,7 @@ CFA632 and CFA634 series by CrystalFontz, Inc.
<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>
<property>Reboot</property> = &parameters.yesnodef;
</term>
<listitem><para>
Reinitialize the LCD's BIOS [default: <literal>no</literal>; legal: <literal>yes</literal>, <literal>no</literal>]
docs/lcdproc-user/drivers/CFontz633.docbook
+19 -38
View File
@@ -16,8 +16,8 @@ CFontz633 chipset.
<variablelist>
<varlistentry>
<term>
<command>Device</command> =
<arg choice="plain"><replaceable>DEVICE</replaceable></arg>
<property>Device</property> =
<parameter><replaceable>DEVICE</replaceable></parameter>
</term>
<listitem><para>
Select the output device to use [default: <filename>/dev/lcd</filename>]
@@ -28,12 +28,7 @@ CFontz633 chipset.
<varlistentry>
<term>
<command>Size</command> =
<arg choice="plain">
<replaceable>WIDTH</replaceable>
<literal>x</literal>
<replaceable>HEIGHT</replaceable>
</arg>
<property>Size</property> = &parameters.size;
</term>
<listitem><para>
Select the LCD type (size) [default: <literal>16x2</literal>]
@@ -42,8 +37,8 @@ CFontz633 chipset.
<varlistentry>
<term>
<command>Contrast</command> =
<arg choice="plain"><replaceable>CONTRAST</replaceable></arg>
<property>Contrast</property> =
<parameter><replaceable>CONTRAST</replaceable></parameter>
</term>
<listitem><para>
Set the initial contrast.
@@ -54,8 +49,8 @@ CFontz633 chipset.
<varlistentry>
<term>
<command>Brightness</command> =
<arg choice="plain"><replaceable>BRIGHTNESS</replaceable></arg>
<property>Brightness</property> =
<parameter><replaceable>BRIGHTNESS</replaceable></parameter>
</term>
<listitem><para>
Set the initial brightness [default: <literal>1000</literal>; legal: <literal>0</literal> - <literal>1000</literal>]
@@ -64,8 +59,8 @@ CFontz633 chipset.
<varlistentry>
<term>
<command>OffBrightness</command> =
<arg choice="plain"><replaceable>BRIGHTNESS</replaceable></arg>
<property>OffBrightness</property> =
<parameter><replaceable>BRIGHTNESS</replaceable></parameter>
</term>
<listitem><para>
Set the initial off-brightness [default: <literal>0</literal>; legal: <literal>0</literal> - <literal>1000</literal>]
@@ -76,16 +71,14 @@ CFontz633 chipset.
<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>
<property>Speed</property> =
{
<parameter><literal>1200</literal></parameter> |
<parameter><literal>2400</literal></parameter> |
<parameter><literal>9600</literal></parameter> |
<emphasis><parameter><literal>19200</literal></parameter></emphasis> |
<parameter><literal>115200</literal></parameter>
}
</term>
<listitem><para>
Set the the baud rate for communication with the LCD.
@@ -95,13 +88,7 @@ CFontz633 chipset.
<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>
<property>NewFirmware</property> = &parameters.yesnodef;
</term>
<listitem><para>
Set the firmware version (<emphasis>New</emphasis> means >= 2.0) [default: <literal>no</literal>; legal: <literal>yes</literal>, <literal>no</literal>]
@@ -111,13 +98,7 @@ CFontz633 chipset.
<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>
<property>Reboot</property> = &parameters.yesnodef;
</term>
<listitem><para>
Reinitialize the LCD's BIOS [default: <literal>no</literal>; legal: <literal>yes</literal>, <literal>no</literal>]
docs/lcdproc-user/drivers/CFontzPacket.docbook
+25 -46
View File
@@ -62,14 +62,12 @@ Currently this line of modules comprises the models:
<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>
<property>Model</property> =
{
<parameter><literal>631</literal></parameter> |
<emphasis><parameter><literal>633</literal></parameter></emphasis> |
<parameter><literal>635</literal></parameter>
}
</term>
<listitem><para>
Select the LCD model that is connected.
@@ -81,8 +79,8 @@ Currently this line of modules comprises the models:
<varlistentry>
<term>
<command>Device</command> =
<arg choice="plain"><replaceable>DEVICE</replaceable></arg>
<property>Device</property> =
<parameter><replaceable>DEVICE</replaceable></parameter>
</term>
<listitem>
<para>
@@ -101,12 +99,7 @@ Currently this line of modules comprises the models:
<varlistentry>
<term>
<command>Size</command> =
<arg choice="plain">
<replaceable>WIDTH</replaceable>
<literal>x</literal>
<replaceable>HEIGHT</replaceable>
</arg>
<property>Size</property> = &parameters.size;
</term>
<listitem><para>
Select the LCD size [default: depending on model: 635: <literal>20x4</literal>,
@@ -117,8 +110,8 @@ Currently this line of modules comprises the models:
<varlistentry>
<term>
<command>Contrast</command> =
<arg choice="plain"><replaceable>CONTRAST</replaceable></arg>
<property>Contrast</property> =
<parameter><replaceable>CONTRAST</replaceable></parameter>
</term>
<listitem><para>
Set the initial contrast.
@@ -129,8 +122,8 @@ Currently this line of modules comprises the models:
<varlistentry>
<term>
<command>Brightness</command> =
<arg choice="plain"><replaceable>BRIGHTNESS</replaceable></arg>
<property>Brightness</property> =
<parameter><replaceable>BRIGHTNESS</replaceable></parameter>
</term>
<listitem><para>
Set the initial brightness [default: <literal>1000</literal>; legal: <literal>0</literal> - <literal>1000</literal>]
@@ -139,8 +132,8 @@ Currently this line of modules comprises the models:
<varlistentry>
<term>
<command>OffBrightness</command> =
<arg choice="plain"><replaceable>BRIGHTNESS</replaceable></arg>
<property>OffBrightness</property> =
<parameter><replaceable>BRIGHTNESS</replaceable></parameter>
</term>
<listitem><para>
Set the initial off-brightness [default: <literal>0</literal>; legal: <literal>0</literal> - <literal>1000</literal>]
@@ -151,16 +144,14 @@ Currently this line of modules comprises the models:
<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>
<property>Speed</property> =
{
<parameter><literal>1200</literal></parameter> |
<parameter><literal>2400</literal></parameter> |
<parameter><literal>9600</literal></parameter> |
<parameter><literal>19200</literal></parameter> |
<parameter><literal>115200</literal></parameter>
}
</term>
<listitem><para>
Set the the baud rate for communication with the LCD.
@@ -171,13 +162,7 @@ Currently this line of modules comprises the models:
<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>
<property>NewFirmware</property> = &parameters.yesnodef;
</term>
<listitem><para>
Set the firmware version (<emphasis>New</emphasis> means >= 2.0) [default: <literal>no</literal>; legal: <literal>yes</literal>, <literal>no</literal>]
@@ -187,13 +172,7 @@ Currently this line of modules comprises the models:
<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>
<property>Reboot</property> = &parameters.yesnodef;
</term>
<listitem><para>
Reinitialize the LCD's BIOS [default: <literal>no</literal>; legal: <literal>yes</literal>, <literal>no</literal>]
docs/lcdproc-user/drivers/CwLnx.docbook
+31 -58
View File
@@ -13,7 +13,7 @@ and CW1602 by CwLinux.
The CwLinux CW12232 LCDs are graphical LCDs with 122 x 32 dots
that also have a text mode with 20 x 4 characters,
the CW12832 are graphical displays with 128 x 32 dots and a
21 x 4 character text mode,
21 x 4 character text mode,
the CW1602 LCDs are character LCDs that are 16 characters wide and
2 lines high.
</para>
@@ -40,7 +40,7 @@ power connector, while the USB modules only require an USB connection.
</para>
<para>
For more information see the
For more information see the
<ulink url="http://www.cwlinux.com">CwLinux web site</ulink>
</para>
@@ -57,14 +57,12 @@ For more information see the
<variablelist>
<varlistentry>
<term>
<command>Model</command> =
<arg choice="plain">
<group choice="req">
<arg choice="plain"><literal><emphasis>12232</emphasis></literal></arg>
<arg choice="plain"><literal>12832</literal></arg>
<arg choice="plain"><literal>1602</literal></arg>
</group>
</arg>
<property>Model</property> =
{
<emphasis><parameter><literal>12232</literal></parameter></emphasis> |
<parameter><literal>12832</literal></parameter> |
<parameter><literal>1602</literal></parameter>
}
</term>
<listitem><para>
Select the LCD model [default: <literal>12232</literal>;
@@ -74,8 +72,8 @@ For more information see the
<varlistentry>
<term>
<command>Device</command> =
<arg choice="plain"><replaceable>DEVICE</replaceable></arg>
<property>Device</property> =
<parameter><replaceable>DEVICE</replaceable></parameter>
</term>
<listitem><para>
Select the output device to use [default: <filename>/dev/lcd</filename>]
@@ -85,12 +83,7 @@ For more information see the
<varlistentry>
<term>
<command>Size</command> =
<arg choice="plain">
<replaceable>WIDTH</replaceable>
<literal>x</literal>
<replaceable>HEIGHT</replaceable>
</arg>
<property>Size</property> = &parameters.size;
</term>
<listitem><para>
Select the LCD size [default: depending on model: 12232: <literal>20x4</literal>,
@@ -101,13 +94,11 @@ For more information see the
<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>
<property>Speed</property> =
{
<parameter><literal>9600</literal></parameter> |
<emphasis><parameter><literal>19200</literal></parameter></emphasis>
}
</term>
<listitem><para>
Set the the baud rate for communication with the LCD.
@@ -117,13 +108,7 @@ For more information see the
<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>
<property>Reboot</property> = &parameters.yesnodef;
</term>
<listitem><para>
Reinitialize the LCD's BIOS [default: <literal>no</literal>; legal: <literal>yes</literal>, <literal>no</literal>]
@@ -133,13 +118,7 @@ For more information see the
<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>
<property>Keypad</property> = &parameters.yesnodef;
</term>
<listitem><para>
Tells if you have a keypad connected. Keypad layout is currently not
@@ -149,28 +128,28 @@ For more information see the
<varlistentry>
<term>
<command>KeyMap_A</command> =
<arg choice="plain"><replaceable>KEY</replaceable></arg>
<property>KeyMap_A</property> =
<parameter><replaceable>KEY</replaceable></parameter>
</term>
<term>
<command>KeyMap_B</command> =
<arg choice="plain"><replaceable>KEY</replaceable></arg>
<property>KeyMap_B</property> =
<parameter><replaceable>KEY</replaceable></parameter>
</term>
<term>
<command>KeyMap_C</command> =
<arg choice="plain"><replaceable>KEY</replaceable></arg>
<property>KeyMap_C</property> =
<parameter><replaceable>KEY</replaceable></parameter>
</term>
<term>
<command>KeyMap_D</command> =
<arg choice="plain"><replaceable>KEY</replaceable></arg>
<property>KeyMap_D</property> =
<parameter><replaceable>KEY</replaceable></parameter>
</term>
<term>
<command>KeyMap_E</command> =
<arg choice="plain"><replaceable>KEY</replaceable></arg>
<property>KeyMap_E</property> =
<parameter><replaceable>KEY</replaceable></parameter>
</term>
<term>
<command>KeyMap_F</command> =
<arg choice="plain"><replaceable>KEY</replaceable></arg>
<property>KeyMap_F</property> =
<parameter><replaceable>KEY</replaceable></parameter>
</term>
<listitem><para>
If you have a non standard keypad you can associate any keystrings to keys.
@@ -223,13 +202,7 @@ For more information see the
<varlistentry>
<term>
<command>keypad_test_mode</command> =
<arg choice="plain">
<group choice="req">
<arg choice="plain"><literal>yes</literal></arg>
<arg choice="plain"><literal><emphasis>no</emphasis></literal></arg>
</group>
</arg>
<property>keypad_test_mode</property> = &parameters.yesnodef;
</term>
<listitem><para>
keypad_test_mode permit to test keypad assignment
docs/lcdproc-user/drivers/IOWarrior.docbook
+5 -22
View File
@@ -119,12 +119,7 @@ as well as Darwin/MacOS X.
<variablelist>
<varlistentry>
<term>
<command>Size</command> =
<arg choice="plain">
<replaceable>WIDTH</replaceable>
<literal>x</literal>
<replaceable>HEIGHT</replaceable>
</arg>
<property>Size</property> = &parameters.size;
</term>
<listitem><para>
Set the display dimensions. If not given, it defaults to <literal>20x4</literal>.
@@ -133,8 +128,8 @@ as well as Darwin/MacOS X.
<varlistentry>
<term>
<command>SerialNumber</command> =
<arg choice="plain"><replaceable>SERIALNO</replaceable></arg>
<property>SerialNumber</property> =
<parameter><replaceable>SERIALNO</replaceable></parameter>
</term>
<listitem><para>
Use the IOWarrior module with the serial number <replaceable>SERIALNO</replaceable>.
@@ -144,13 +139,7 @@ as well as Darwin/MacOS X.
<varlistentry>
<term>
<command>ExtendedMode</command> =
<arg choice="plain">
<group choice="req">
<arg choice="plain"><literal>yes</literal></arg>
<arg choice="plain"><literal><emphasis>no</emphasis></literal></arg>
</group>
</arg>
<property>ExtendedMode</property> = &parameters.yesnodef;
</term>
<listitem><para>
If you have a KS0073 or an other 'almost HD44780-compatible' display
@@ -161,13 +150,7 @@ as well as Darwin/MacOS X.
<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>
<property>Lastline</property> = &parameters.yesdefno;
</term>
<listitem><para>
Specifies if the last line is pixel addressable or it controls an
docs/lcdproc-user/drivers/MD8800.docbook
+7 -12
View File
@@ -25,8 +25,8 @@ You may find more information about the LCD on
<variablelist>
<varlistentry>
<term>
<command>Device</command> =
<arg choice="plain"><replaceable>DEVICE</replaceable></arg>
<property>Device</property> =
<parameter><replaceable>DEVICE</replaceable></parameter>
</term>
<listitem><para>
device to use [default: <filename>/dev/ttyS1</filename>]
@@ -35,12 +35,7 @@ You may find more information about the LCD on
<varlistentry>
<term>
<command>Size</command> =
<arg choice="plain">
<replaceable>WIDTH</replaceable>
<literal>x</literal>
<replaceable>HEIGHT</replaceable>
</arg>
<property>Size</property> = &parameters.size;
</term>
<listitem><para>
display size [default: <literal>16x2</literal>]
@@ -49,8 +44,8 @@ You may find more information about the LCD on
<varlistentry>
<term>
<command>Brightness</command> =
<arg choice="plain"><replaceable>BRIGHTNESS</replaceable></arg>
<property>Brightness</property> =
<parameter><replaceable>BRIGHTNESS</replaceable></parameter>
</term>
<listitem><para>
Set the initial brightness [default: <literal>1000</literal>; legal: <literal>0</literal> - <literal>1000</literal>]
@@ -59,8 +54,8 @@ You may find more information about the LCD on
<varlistentry>
<term>
<command>OffBrightness</command> =
<arg choice="plain"><replaceable>BRIGHTNESS</replaceable></arg>
<property>OffBrightness</property> =
<parameter><replaceable>BRIGHTNESS</replaceable></parameter>
</term>
<listitem><para>
Set the initial off-brightness [default: <literal>0</literal>; legal: <literal>0</literal> - <literal>1000</literal>]
docs/lcdproc-user/drivers/NoritakeVFD.docbook
+22 -37
View File
@@ -16,8 +16,8 @@ This section talks about using LCDproc with text mode VFD displays from
<variablelist>
<varlistentry>
<term>
<command>Device</command> =
<arg choice="plain"><replaceable>DEVICE</replaceable></arg>
<property>Device</property> =
<parameter><replaceable>DEVICE</replaceable></parameter>
</term>
<listitem><para>
Port where the VFD is. Usual values are <filename>/dev/ttyS0</filename> and <filename>/dev/ttyS1</filename>
@@ -27,12 +27,7 @@ This section talks about using LCDproc with text mode VFD displays from
<varlistentry>
<term>
<command>Size</command> =
<arg choice="plain">
<replaceable>WIDTH</replaceable>
<literal>x</literal>
<replaceable>HEIGHT</replaceable>
</arg>
<property>Size</property> = &parameters.size;
</term>
<listitem><para>
Specifies the size of the LCD.
@@ -42,8 +37,8 @@ This section talks about using LCDproc with text mode VFD displays from
<varlistentry>
<term>
<command>Brightness</command> =
<arg choice="plain"><replaceable>BRIGHTNESS</replaceable></arg>
<property>Brightness</property> =
<parameter><replaceable>BRIGHTNESS</replaceable></parameter>
</term>
<listitem><para>
Set the initial brightness [default: <literal>1000</literal>; legal: <literal>0</literal> - <literal>1000</literal>]
@@ -52,8 +47,8 @@ This section talks about using LCDproc with text mode VFD displays from
<varlistentry>
<term>
<command>OffBrightness</command> =
<arg choice="plain"><replaceable>BRIGHTNESS</replaceable></arg>
<property>OffBrightness</property> =
<parameter><replaceable>BRIGHTNESS</replaceable></parameter>
</term>
<listitem><para>
Set the initial off-brightness [default: <literal>0</literal>; legal: <literal>0</literal> - <literal>1000</literal>]
@@ -64,16 +59,14 @@ This section talks about using LCDproc with text mode VFD displays from
<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>
<property>Speed</property> =
{
<parameter><literal>1200</literal></parameter> |
<parameter><literal>2400</literal></parameter> |
<emphasis><parameter><literal>9600</literal></parameter></emphasis> |
<parameter><literal>19200</literal></parameter> |
<parameter><literal>115200</literal></parameter>
}
</term>
<listitem><para>
Set the the baud rate to use when communicating with the VFD.
@@ -83,14 +76,12 @@ This section talks about using LCDproc with text mode VFD displays from
<varlistentry>
<term>
<command>Parity</command> =
<arg choice="plain">
<group choice="req">
<arg choice="plain"><literal><emphasis>0</emphasis></literal></arg>
<arg choice="plain"><literal>1</literal></arg>
<arg choice="plain"><literal>2</literal></arg>
</group>
</arg>
<property>Parity</property> =
{
<emphasis><parameter><literal>0</literal></parameter></emphasis> |
<parameter><literal>1</literal></parameter> |
<parameter><literal>2</literal></parameter>
}
</term>
<listitem><para>
Set the parity for communication with the device to even parity (<literal>2</literal>),
@@ -101,13 +92,7 @@ This section talks about using LCDproc with text mode VFD displays from
<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>
<property>Reboot</property> = &parameters.yesnodef;
</term>
<listitem><para>
Reinitialize the VFD [default: <literal>no</literal>; legal: <literal>yes</literal>, <literal>no</literal>]
docs/lcdproc-user/drivers/bayrad.docbook
+9 -11
View File
@@ -38,8 +38,8 @@ For more information see the
<variablelist>
<varlistentry>
<term>
<command>Device</command> =
<arg choice="plain"><replaceable>DEVICE</replaceable></arg>
<property>Device</property> =
<parameter><replaceable>DEVICE</replaceable></parameter>
</term>
<listitem><para>
Select the serial output device to use.
@@ -49,15 +49,13 @@ For more information see the
<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>
<property>Speed</property> =
{
<parameter><literal>1200</literal></parameter> |
<parameter><literal>2400</literal></parameter> |
<emphasis><parameter><literal>9600</literal></parameter></emphasis> |
<parameter><literal>19200</literal></parameter>
}
</term>
<listitem><para>
Set the the baud rate to use when communicating with the LCD.
docs/lcdproc-user/drivers/curses.docbook
+19 -36
View File
@@ -16,8 +16,8 @@ curses chipset.
<variablelist>
<varlistentry>
<term>
<command>Foreground</command> =
<arg choice="plain"><replaceable>COLOUR</replaceable></arg>
<property>Foreground</property> =
<parameter><replaceable>COLOUR</replaceable></parameter>
</term>
<listitem>
<para>
@@ -26,7 +26,7 @@ curses chipset.
</para>
<para>
Legal values for <replaceable>COLOUR</replaceable> are
Legal values for <replaceable>COLOUR</replaceable> are
<literal>red</literal>, <literal>black</literal>,
<literal>green</literal>, <literal>yellow</literal>,
<literal>blue</literal>, <literal>magenta</literal>,
@@ -37,8 +37,8 @@ curses chipset.
<varlistentry>
<term>
<command>Background</command> =
<arg choice="plain"><replaceable>COLOUR</replaceable></arg>
<property>Background</property> =
<parameter><replaceable>COLOUR</replaceable></parameter>
</term>
<listitem>
<para>
@@ -47,16 +47,16 @@ curses chipset.
</para>
<para>
The legal values for <replaceable>COLOUR</replaceable> are
the same as for the <command>Foreground</command> setting.
The legal values for <replaceable>COLOUR</replaceable> are
the same as for the <property>Foreground</property> setting.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<command>Backlight</command> =
<arg choice="plain"><replaceable>COLOUR</replaceable></arg>
<property>Backlight</property> =
<parameter><replaceable>COLOUR</replaceable></parameter>
</term>
<listitem>
<para>
@@ -65,20 +65,15 @@ curses chipset.
</para>
<para>
The legal values for <replaceable>COLOUR</replaceable> are
the same as for the <command>Foreground</command> setting.
The legal values for <replaceable>COLOUR</replaceable> are
the same as for the <property>Foreground</property> setting.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<command>Size</command> =
<arg choice="plain">
<replaceable>WIDTH</replaceable>
<literal>x</literal>
<replaceable>HEIGHT</replaceable>
</arg>
<property>Size</property> = &parameters.size;
</term>
<listitem><para>
display size [default: <literal>20x4</literal>]
@@ -87,12 +82,12 @@ curses chipset.
<varlistentry>
<term>
<command>TopLeftx</command> =
<arg choice="plain"><replaceable>X-OFFSET</replaceable></arg>
<property>TopLeftx</property> =
<parameter><replaceable>X-OFFSET</replaceable></parameter>
</term>
<term>
<command>TopLefty</command> =
<arg choice="plain"><replaceable>Y-OFFSET</replaceable></arg>
<property>TopLefty</property> =
<parameter><replaceable>Y-OFFSET</replaceable></parameter>
</term>
<listitem><para>
What position (X,Y) to start the left top corner at.
@@ -102,29 +97,17 @@ curses chipset.
<varlistentry>
<term>
<command>UseACS</command> =
<arg choice ="plain">
<group choice="req">
<arg choice="plain"><literal>yes</literal></arg>
<arg choice="plain"><literal><emphasis>no</emphasis></literal></arg>
</group>
</arg>
<property>UseACS</property> = &parameters.yesnodef;
</term>
<listitem><para>
Tell whether to use ACS (alternative character set) symbols for icons and bars
instead of simple ASCII characters.
instead of simple ASCII characters.
</para></listitem>
</varlistentry>
<varlistentry>
<term>
<command>DrawBorder</command> =
<arg choice ="plain">
<group choice="req">
<arg choice="plain"><literal><emphasis>yes</emphasis></literal></arg>
<arg choice="plain"><literal>no</literal></arg>
</group>
</arg>
<property>DrawBorder</property> = &parameters.yesdefno;
</term>
<listitem><para>
Tell whether to draw a border around the screen.
docs/lcdproc-user/drivers/ea65.docbook
+28 -26
View File
@@ -2,31 +2,33 @@
<title>The ea65 driver</title>
<para>
This section describes the ea65 driver which works with the front panel
VFD display on the AOpen XC Cube-AV EA65 media barebone.
This section describes the ea65 driver which works with the front panel
VFD display on the AOpen XC Cube-AV EA65 media barebone.
</para>
<sect2 id="ea65-features">
<title>EA65 front panel VFD </title>
<para>
The AOpen XC Cube-AV is a barebone designed for using as a media center.
It comes with a front panel display which is capable of displaying one line
of 9 characters.
</para>
<para>
The display is internally connected to the serial port
(<filename>/dev/ttyS1</filename>) with a fixed rate of 9600 baud.
</para>
<para>
The display uses 13 segments per character. That's why the driver provides
no custom characters like the ones for dot matrix displays do.
</para>
<para>
The front panel furthermore has 9 keys which are illuminated by blue LEDs.
The LEDs can be controlled with the backlight functions. The keys are not
supported by this driver. The red LED (RECORD) can be controlled with the
<code>output</code> command of <application>LCDd</application>.
</para>
<title>EA65 front panel VFD </title>
<para>
The AOpen XC Cube-AV is a barebone designed for using as a media center.
It comes with a front panel display which is capable of displaying one line
of 9 characters.
</para>
<para>
The display is internally connected to the serial port
(<filename>/dev/ttyS1</filename>) with a fixed rate of 9600 baud.
</para>
<para>
The display uses 13 segments per character. That's why the driver provides
no custom characters like the ones for dot matrix displays do.
</para>
<para>
The front panel furthermore has 9 keys which are illuminated by blue LEDs.
The LEDs can be controlled with the backlight functions. The keys are not
supported by this driver. The red LED (RECORD) can be controlled with the
<code>output</code> command of <application>LCDd</application>.
</para>
</sect2>
<sect2 id="ea65-config">
@@ -38,8 +40,8 @@
<variablelist>
<varlistentry>
<term>
<command>Brightness</command> =
<arg choice="plain"><replaceable>BRIGHTNESS</replaceable></arg>
<property>Brightness</property> =
<parameter><replaceable>BRIGHTNESS</replaceable></parameter>
</term>
<listitem><para>
Set the brightness for the front LEDs if backlight is switched on.
@@ -54,8 +56,8 @@
</varlistentry>
<varlistentry>
<term>
<command>OffBrightness</command> =
<arg choice="plain"><replaceable>OFFBRIGHTNESS</replaceable></arg>
<property>OffBrightness</property> =
<parameter><replaceable>OFFBRIGHTNESS</replaceable></parameter>
</term>
<listitem><para>
Set the brightness for the front LEDs if backlight is switched off.
docs/lcdproc-user/drivers/eyeboxone.docbook
+76 -92
View File
@@ -2,50 +2,59 @@
<title>The Eyebox One Driver (EyeboxOne)</title>
<para>
This section describes the Eyebox One.
</para>
This section describes the Eyebox One.
</para>
<sect2 id="eyeboxone-features">
<title>Eyebox One LCD Module</title>
<para>
Eyebox One is a small rackmounted server marketed by Rightvision
(<ulink url="http://www.alcateleyebox.rightvision.com/"></ulink>).
This server has an LCD module, a keypad, two graphbars and some leds.
</para>
<para>
The LCD is a 20x4 alphanumeric module connected via standard DB-9 cabling and
connector.
</para>
<para>
I couldn't find any documentation about it.
All I know has been obtained with some reverse engineering.
It seems that it can run only at 19.200 baud.
Sending ASCII to the module will make it simply display that text at
its current cursor position.
The module has a built-in BIOS that recognizes commands (sent by transmitting a
single-byte "marker" signifying that a command is on the way, followed by
the single-byte command character itself along with any parameters, if needed)
allowing the programmer to clear the screen, position the cursor anywhere,
hide/show the cursor, on/off the backlight, and so on.
</para>
<para>
This module is fast. If updating less than the whole screen, the LCD can
update faster than can be seen by the human eye. This, of course,
more than meets LCDproc's needs.
</para>
</sect2>
<sect2 id="eyeboxone-special_features">
<title>Eyebox One Driver and lcdproc client</title>
<para>
You can use the two Eyebox One graphbars, one as a free CPU meter, and one as a free RAM meter
with lcdproc client (see eyebox.c in lcdproc client sources).
In order to use it, you must execute ./configure with a special parameter:
<command>CPPFLAGS=-DLCDPROC_EYEBOXONE ./configure --enable-drivers=EyeboxOne</command>
This is only a BETA version modification, take it as a demo...
</para>
</sect2>
<title>Eyebox One LCD Module</title>
<para>
Eyebox One is a small rackmounted server marketed by Rightvision
(<ulink url="http://www.alcateleyebox.rightvision.com/"></ulink>).
This server has an LCD module, a keypad, two graphbars and some leds.
</para>
<para>
The LCD is a 20x4 alphanumeric module connected via standard DB-9 cabling and
connector.
</para>
<para>
I couldn't find any documentation about it.
All I know has been obtained with some reverse engineering.
It seems that it can run only at 19.200 baud.
Sending ASCII to the module will make it simply display that text at
its current cursor position.
The module has a built-in BIOS that recognizes commands (sent by transmitting a
single-byte "marker" signifying that a command is on the way, followed by
the single-byte command character itself along with any parameters, if needed)
allowing the programmer to clear the screen, position the cursor anywhere,
hide/show the cursor, on/off the backlight, and so on.
</para>
<para>
This module is fast. If updating less than the whole screen, the LCD can
update faster than can be seen by the human eye. This, of course,
more than meets LCDproc's needs.
</para>
</sect2>
<sect2 id="eyeboxone-special_features">
<title>Eyebox One Driver and lcdproc client</title>
<para>
You can use the two Eyebox One graphbars, one as a free CPU meter, and one as a free RAM meter
with lcdproc client (see eyebox.c in lcdproc client sources).
</para>
<para>
In order to use it, you must execute ./configure with a special parameter:
<command>CPPFLAGS=-DLCDPROC_EYEBOXONE ./configure --enable-drivers=EyeboxOne</command>
</para>
<para>
This is only a BETA version modification, take it as a demo...
</para>
</sect2>
<sect2 id="eyeboxone-copy">
<title>Copyright</title>
@@ -68,8 +77,8 @@ This section has been modified by Cédric TESSIER (http://www.nezetic.info)
<variablelist>
<varlistentry>
<term>
<command>Device</command> =
<arg choice="plain"><replaceable>DEVICE</replaceable></arg>
<property>Device</property> =
<parameter><replaceable>DEVICE</replaceable></parameter>
</term>
<listitem><para>
Select the output device to use [default: <filename>/dev/ttyS1</filename>]
@@ -78,12 +87,7 @@ This section has been modified by Cédric TESSIER (http://www.nezetic.info)
<varlistentry>
<term>
<command>Size</command> =
<arg choice="plain">
<replaceable>WIDTH</replaceable>
<literal>x</literal>
<replaceable>HEIGHT</replaceable>
</arg>
<property>Size</property> = &parameters.size;
</term>
<listitem><para>
Set the display size [default: <literal>20x4</literal>]
@@ -92,13 +96,7 @@ This section has been modified by Cédric TESSIER (http://www.nezetic.info)
<varlistentry>
<term>
<command>Backlight</command> =
<arg choice="plain">
<group choice="req">
<arg choice="plain"><literal><emphasis>yes</emphasis></literal></arg>
<arg choice="plain"><literal>no</literal></arg>
</group>
</arg>
<property>Backlight</property> = &parameters.yesdefno;
</term>
<listitem><para>
Switch on the backlight? [default: <literal>yes</literal>; legal: <literal>yes</literal>, <literal>no</literal>]
@@ -112,13 +110,7 @@ This section has been modified by Cédric TESSIER (http://www.nezetic.info)
<varlistentry>
<term>
<command>Cursor</command> =
<arg choice="plain">
<group choice="req">
<arg choice="plain"><literal>yes</literal></arg>
<arg choice="plain"><literal><emphasis>no</emphasis></literal></arg>
</group>
</arg>
<property>Cursor</property> = &parameters.yesnodef;
</term>
<listitem><para>
Switch on the cursor? [default: <literal>no</literal>; legal: <literal>yes</literal>, <literal>no</literal>]
@@ -128,15 +120,13 @@ This section has been modified by Cédric TESSIER (http://www.nezetic.info)
<varlistentry>
<term>
<command>Speed</command> =
<arg choice="plain">
<group choice="req">
<arg choice="plain"><literal>1200</literal></arg>
<arg choice="plain"><literal>2400</literal></arg>
<arg choice="plain"><literal>9600</literal></arg>
<arg choice="plain"><literal><emphasis>19200</emphasis></literal></arg>
</group>
</arg>
<property>Speed</property> =
{
<parameter><literal>1200</literal></parameter> |
<parameter><literal>2400</literal></parameter> |
<parameter><literal>9600</literal></parameter> |
<emphasis><parameter><literal>19200</literal></parameter></emphasis>
}
</term>
<listitem><para>
Set the the baud rate to use when communicating with the LCD.
@@ -150,28 +140,28 @@ This section has been modified by Cédric TESSIER (http://www.nezetic.info)
<varlistentry>
<term>
<command>LeftKey</command> =
<arg choice="plain"><replaceable>D</replaceable></arg>
<property>LeftKey</property> =
<parameter><replaceable>D</replaceable></parameter>
</term>
<term>
<command>RightKey</command> =
<arg choice="plain"><replaceable>C</replaceable></arg>
<property>RightKey</property> =
<parameter><replaceable>C</replaceable></parameter>
</term>
<term>
<command>UpKey</command> =
<arg choice="plain"><replaceable>A</replaceable></arg>
<property>UpKey</property> =
<parameter><replaceable>A</replaceable></parameter>
</term>
<term>
<command>DownKey</command> =
<arg choice="plain"><replaceable>B</replaceable></arg>
<property>DownKey</property> =
<parameter><replaceable>B</replaceable></parameter>
</term>
<term>
<command>EscapeKey</command> =
<arg choice="plain"><replaceable>P</replaceable></arg>
<property>EscapeKey</property> =
<parameter><replaceable>P</replaceable></parameter>
</term>
<term>
<command>EnterKey</command> =
<arg choice="plain"><replaceable></replaceable></arg>
<property>EnterKey</property> =
<parameter><replaceable></replaceable></parameter>
</term>
<listitem><para>
The following table translate from EyeboxOne Key to Logical Key.
@@ -181,13 +171,7 @@ This section has been modified by Cédric TESSIER (http://www.nezetic.info)
<varlistentry>
<term>
<command>keypad_test_mode</command> =
<arg choice="plain">
<group choice="req">
<arg choice="plain"><literal>yes</literal></arg>
<arg choice="plain"><literal><emphasis>no</emphasis></literal></arg>
</group>
</arg>
<property>keypad_test_mode</property> = &parameters.yesnodef;
</term>
<listitem><para>
You can find out which key of your display sends which
docs/lcdproc-user/drivers/glcdlib.docbook
+30 -72
View File
@@ -39,9 +39,9 @@ before configuring the LCDproc build process --enable-drivers=glcdlib.
<variablelist>
<varlistentry>
<term>
<command>Driver</command> =
<arg choice="plain"><replaceable>GRAPHLCD-DRIVER</replaceable></arg>
<term>
<property>Driver</property> =
<parameter><replaceable>GRAPHLCD-DRIVER</replaceable></parameter>
</term>
<listitem><para>
Specify which graphical display supported by graphlcd-base to use.
@@ -58,13 +58,7 @@ before configuring the LCDproc build process --enable-drivers=glcdlib.
<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>
<property>UseFT2</property> = &parameters.yesdefno;
</term>
<listitem><para>
Tell whether to use FreeType2 or not.
@@ -79,12 +73,7 @@ before configuring the LCDproc build process --enable-drivers=glcdlib.
<varlistentry>
<term>
<command>TextResolution</command> =
<arg choice="plain">
<replaceable>WIDTH</replaceable>
<literal>x</literal>
<replaceable>HEIGHT</replaceable>
</arg>
<property>TextResolution</property> = &parameters.size;
</term>
<listitem><para>
Give text resolution in fixed width characters. If it won't fit according
@@ -96,8 +85,8 @@ before configuring the LCDproc build process --enable-drivers=glcdlib.
<varlistentry>
<term>
<command>FontFile</command> =
<arg choice="plain"><replaceable>FILENAME</replaceable></arg>
<property>FontFile</property> =
<parameter><replaceable>FILENAME</replaceable></parameter>
</term>
<listitem><para>
Set path to font file to use, e.g. <filename>/usr/share/fonts/corefonts/courbd.ttf</filename>.
@@ -106,14 +95,14 @@ before configuring the LCDproc build process --enable-drivers=glcdlib.
</variablelist>
<para>
The following parameters only apply if <command>UseFT2</command> = <literal>yes</literal>:
The following parameters only apply if <property>UseFT2</property> = <literal>yes</literal>:
</para>
<variablelist>
<varlistentry>
<term>
<command>CharEncoding</command> =
<arg choice="plain"><replaceable>CHARSET</replaceable></arg>
<property>CharEncoding</property> =
<parameter><replaceable>CHARSET</replaceable></parameter>
</term>
<listitem><para>
Specify character encoding to use, e.g. <literal>iso8859-2</literal>.
@@ -123,12 +112,12 @@ The following parameters only apply if <command>UseFT2</command> = <literal>yes<
<varlistentry>
<term>
<command>MinFontFaceSize</command> =
<arg choice="plain">
<property>MinFontFaceSize</property> =
<parameter>
<replaceable>COLUMNS</replaceable>
<literal>x</literal>
<replaceable>ROWS</replaceable>
</arg>
</parameter>
</term>
<listitem><para>
minimum size in pixels in which fonts should be rendered
@@ -142,8 +131,8 @@ The following parameters only apply if <command>UseFT2</command> = <literal>yes<
<title>Optional settings</title>
<varlistentry>
<term>
<command>Brightness</command> =
<arg choice="plain"><replaceable>BRIGHTNESS</replaceable></arg>
<property>Brightness</property> =
<parameter><replaceable>BRIGHTNESS</replaceable></parameter>
</term>
<listitem><para>
Brightness (in %) if applicable
@@ -154,8 +143,8 @@ The following parameters only apply if <command>UseFT2</command> = <literal>yes<
<varlistentry>
<term>
<command>Contrast</command> =
<arg choice="plain"><replaceable>CONTRAST</replaceable></arg>
<property>Contrast</property> =
<parameter><replaceable>CONTRAST</replaceable></parameter>
</term>
<listitem><para>
Set the contrast (in %) if applicable.
@@ -166,13 +155,7 @@ The following parameters only apply if <command>UseFT2</command> = <literal>yes<
<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>
<property>Backlight</property> = &parameters.yesnodef;
</term>
<listitem><para>
Backlight if applicable
@@ -181,13 +164,7 @@ The following parameters only apply if <command>UseFT2</command> = <literal>yes<
<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>
<property>UpsideDown</property> = &parameters.yesnodef;
</term>
<listitem><para>
flip image upside down
@@ -196,13 +173,7 @@ The following parameters only apply if <command>UseFT2</command> = <literal>yes<
<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>
<property>Invert</property> = &parameters.yesnodef;
</term>
<listitem><para>
invert light/dark pixels
@@ -211,13 +182,7 @@ The following parameters only apply if <command>UseFT2</command> = <literal>yes<
<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>
<property>ShowDebugFrame</property> = &parameters.yesnodef;
</term>
<listitem><para>
turns on/off 1 pixel thick debugging
@@ -229,13 +194,7 @@ The following parameters only apply if <command>UseFT2</command> = <literal>yes<
<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>
<property>ShowBigBorder</property> = &parameters.yesnodef;
</term>
<listitem><para>
border around the unused area
@@ -244,13 +203,7 @@ The following parameters only apply if <command>UseFT2</command> = <literal>yes<
<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>
<property>ShowThinBorder</property> = &parameters.yesnodef;
</term>
<listitem><para>
border around the unused area
@@ -259,12 +212,17 @@ The following parameters only apply if <command>UseFT2</command> = <literal>yes<
<varlistentry>
<term>
<command>PixelShiftX=<replaceable>0</replaceable></command>
<property>PixelShiftX</property> =
<parameter><replaceable>SHIFTX</replaceable></parameter>
</term>
<term>
<command>PixelShiftY=<replaceable>2</replaceable></command>
<property>PixelShiftY</property> =
<parameter><replaceable>SHIFTY</replaceable></parameter>
</term>
<listitem><para>
Shifts the content of the display by <replaceable>SHIFTX</replaceable>
(default: <literal>0</literal>) and <replaceable>SHIFTY</replaceable>
(default: <literal>0</literal>) pixels.
</para></listitem>
</varlistentry>
</variablelist>
docs/lcdproc-user/drivers/glk.docbook
+10 -12
View File
@@ -16,8 +16,8 @@ Matrix Orbital GLK chipset.
<variablelist>
<varlistentry>
<term>
<command>Device</command> =
<arg choice="plain"><replaceable>DEVICE</replaceable></arg>
<property>Device</property> =
<parameter><replaceable>DEVICE</replaceable></parameter>
</term>
<listitem><para>
select the serial device to use [default: <filename>/dev/lcd</filename>]
@@ -26,8 +26,8 @@ Matrix Orbital GLK chipset.
<varlistentry>
<term>
<command>Contrast</command> =
<arg choice="plain"><replaceable>CONTRAST</replaceable></arg>
<property>Contrast</property> =
<parameter><replaceable>CONTRAST</replaceable></parameter>
</term>
<listitem><para>
Set the initial contrast.
@@ -38,14 +38,12 @@ Matrix Orbital GLK chipset.
<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>
<property>Speed</property> =
{
<parameter><literal>9600</literal></parameter> |
<emphasis><parameter><literal>19200</literal></parameter></emphasis> |
<parameter><literal>38400</literal></parameter>
}
</term>
<listitem><para>
Set the the baud rate for communication with the LCD.
docs/lcdproc-user/drivers/hd44780.docbook
+130 -205
View File
@@ -360,7 +360,7 @@ By default, the following keystrokes are generated by the different keys:
</table>
You can change the mapping using the
<command>KeyDirect_<replaceable>NUM</replaceable></command>
<property>KeyDirect_<replaceable>NUM</replaceable></property>
configuration option, where <replaceable>NUM</replaceable>
is the subscript to the <literal>X</literal> in the table above.
</para>
@@ -485,7 +485,7 @@ To be more precise, it assumes this mapping:
<para>
This mapping can be changed using the
<command>KeyMatrix_<replaceable>X</replaceable>_<replaceable>Y</replaceable></command>
<property>KeyMatrix_<replaceable>X</replaceable>_<replaceable>Y</replaceable></property>
configuration option, where <replaceable>X</replaceable> and
<replaceable>Y</replaceable> are the subscripts to the respective axes above.
</para>
@@ -720,9 +720,9 @@ This wiring is originally based on "lcdtext" (by Matthias Prinke).
<note>
<para>
The <literal>RW</literal> (pin 5) line of the display decides whether the display receives data from the
LPT port, or whether it sends data to the LPT port: if grounded it receives, if High or connected
to nothing at all it "sends" (i.e., will not work as intended). So, if you are not sure that
The <literal>RW</literal> (pin 5) line of the display decides whether the display receives data from the
LPT port, or whether it sends data to the LPT port: if grounded it receives, if High or connected
to nothing at all it "sends" (i.e., will not work as intended). So, if you are not sure that
you need it otherwise, then connect it to GND. This certainly applies if you have only one display.
</para>
<para>
@@ -1053,9 +1053,9 @@ This type of connection should work with winamp.
</table>
<para>
(*) on the RW line of the display: this line decides whether the display receives data from the
LPT port, or whether it sends data to the LPT port: if grounded it receives, if High or connected
to nothing at all it "sends" (i.e., will not work as intended). So, if you are not sure that
(*) on the RW line of the display: this line decides whether the display receives data from the
LPT port, or whether it sends data to the LPT port: if grounded it receives, if High or connected
to nothing at all it "sends" (i.e., will not work as intended). So, if you are not sure that
you need it otherwise, then connect it to GND. This certainly applies if you have only one display.
</para>
@@ -1315,9 +1315,9 @@ The LCD connections are:
</table>
<para>
(*) on the RW line of the display: this line decides whether the display receives data from the
LPT port, or whether it sends data to the LPT port: if grounded it receives, if High or connected
to nothing at all it "sends" (i.e., will not work as intended). So, if you are not sure that
(*) on the RW line of the display: this line decides whether the display receives data from the
LPT port, or whether it sends data to the LPT port: if grounded it receives, if High or connected
to nothing at all it "sends" (i.e., will not work as intended). So, if you are not sure that
you need it otherwise, then connect it to GND.
</para>
@@ -1915,7 +1915,7 @@ Please address Matteo Pillon for further information.
<para>
The VDR-Wake module by Frank Jepsen is a serial IO extension module for the
famous Linux-based VDR that allows to connect an LCD to it and supports LCDproc.
famous Linux-based VDR that allows to connect an LCD to it and supports LCDproc.
</para>
<para>
@@ -1932,7 +1932,7 @@ See <ulink url="http://www.jepsennet.de/vdr/"></ulink>
The Pertelian X2040 includes an HD44780 display with enclosure and USB
connection.
In order to work with <package>LCDproc</package> in Linux you need
In order to work with <package>LCDproc</package> in Linux you need
the <filename>usbserial.ko</filename> and <filename>ftdi_sio.ko</filename>
kernel modules loaded. The display will then be available on a
serial port <filename>/dev/ttyUSB<replaceable>x</replaceable></filename>.
@@ -1954,7 +1954,7 @@ serial port <filename>/dev/ttyUSB<replaceable>x</replaceable></filename>.
The PIC-an-LCD module is also supported. It is not connected to the LPT port
but to a serial port, which saves you from a lot of potential problems.
To use it, specify the device to which you have connected the module in the
config file with the <command>Device</command> setting.
config file with the <property>Device</property> setting.
The default is <filename>/dev/lcd</filename>.
It does not support a keypad nor backlight switching.
</para>
@@ -2147,7 +2147,7 @@ Refer to <link linkend="hd44780-lcdserializer-burning">burning section</link> in
<title>BWCT USB LCD module "bwctusb"</title>
<para>
The BWCT USB LCD module, sold by Bernd Walter Computing Technology
The BWCT USB LCD module, sold by Bernd Walter Computing Technology
(<ulink url="http://www.bwct.de/lcd.html"></ulink>) is a little board
that can be piggy-packed to a HD44780 display and connects that to USB.
</para>
@@ -2157,7 +2157,7 @@ The board, driven by the <code>bwctusb</code> connection type,
does neither support a keypad for input, nor more than one single-controller
display, nor does it allow setting the backlight or brightness.
But you can set the display's contrast using software
(see the <command>Contrast</command> configuration parameter).
(see the <property>Contrast</property> configuration parameter).
</para>
<sect4 id="hd44780-bwctusb-config">
@@ -2165,7 +2165,7 @@ But you can set the display's contrast using software
<para>
If there is more than one BWCT USB module connected to the system,
the <command>SerialNumber</command> configuration parameter allows
the <property>SerialNumber</property> configuration parameter allows
selecting which display is used in LCDd.
</para>
@@ -2187,7 +2187,7 @@ as well as dual controller displays (required for 4*27 and 4*40).
<para>
It is based upon an Atmel AVR Mega8 CPU with a pure software implementation
of the USB protocol for the Atmel AVR microcontroller series.
of the USB protocol for the Atmel AVR microcontroller series.
</para>
<para>
@@ -2199,7 +2199,7 @@ for your own interface e.g. for a graphic LCD.
<para>
Two keys can be connected to the LCD2USB interface board.
They can generate three key events that can be mapped to key names using
the <command>DirectKey_1</command> to <command>DirectKey_3</command> commands:
the <property>DirectKey_1</property> to <property>DirectKey_3</property> commands:
one for each key and the third if the keys are pressed simultaneously.
With this 3-key setup, menus can be used (see example below).
</para>
@@ -2216,9 +2216,9 @@ or those developed by <ulink url="http://www.maltepoeggel.de/index.php?site=sp-l
<para>
Besides the standard configuration options for <code>hd44780</code> displays, the
<code>lcd2usb</code> connection type supports three additional options:
<command>Contrast</command> to set the display's contrast,
<command>Brightness</command> to set the display's brightness when the backlight is switched on and
<command>OffBrightness</command> to set the display's brightness when is backlight is switched off.
<property>Contrast</property> to set the display's contrast,
<property>Brightness</property> to set the display's brightness when the backlight is switched on and
<property>OffBrightness</property> to set the display's brightness when is backlight is switched off.
All three options expect a number in the range from <literal>0</literal> to <literal>1000</literal>.
</para>
@@ -2249,9 +2249,9 @@ KeyDirect_3=Escape
<tip>
<para>
In order to make the <code>lcd2usb</code> connection type work with a 2-controller display
you may need to set the <command>vSpan</command> config option accordingly.
you may need to set the <property>vSpan</property> config option accordingly.
</para>
</tip>
</tip>
</sect4>
</sect3>
@@ -2262,17 +2262,17 @@ KeyDirect_3=Escape
<title>USS-720 USB-to-IEEE 1284 Bridge (Belkin F5U002) "uss720"</title>
<para>
The USS-720 USB-to-IEEE 1284 Bridge is a fully featured USB to parallel chip that is used
in most (but not all) Belkin F5U002 USB Parallel Printer Adapters. Because these adapters are
inexpensive and readily available on the second-hand market, they provide an excellent solution
for users who want to experiment with a parallel port but only have USB ports on their computers.
The USS-720 USB-to-IEEE 1284 Bridge is a fully featured USB to parallel chip that is used
in most (but not all) Belkin F5U002 USB Parallel Printer Adapters. Because these adapters are
inexpensive and readily available on the second-hand market, they provide an excellent solution
for users who want to experiment with a parallel port but only have USB ports on their computers.
</para>
<para>
Because the chip acts as a parallel port, the driver maintains the same features and wiring as
the 8-bit "winamp" driver. However, because most USB Parallel Printer Adapters use a centronics
printer connector, be sure to convert the pin numbering of the parallel port pins in the "winamp"
wiring to the pin numbering of the centronics port. Many tables are available on the internet
Because the chip acts as a parallel port, the driver maintains the same features and wiring as
the 8-bit "winamp" driver. However, because most USB Parallel Printer Adapters use a centronics
printer connector, be sure to convert the pin numbering of the parallel port pins in the "winamp"
wiring to the pin numbering of the centronics port. Many tables are available on the internet
that illustrate how the pin numbering differs between the two.
</para>
@@ -2280,15 +2280,15 @@ that illustrate how the pin numbering differs between the two.
<title>Special configuration options</title>
<para>
Because several manufacturers used the USS720 chip in their USB Parallel Printer Adapters, the
<command>VendorID</command> and <command>ProductID</command> options are configurable in the
Because several manufacturers used the USS720 chip in their USB Parallel Printer Adapters, the
<property>VendorID</property> and <property>ProductID</property> options are configurable in the
<filename>LCDd.conf</filename> file.
</para>
<note>
<para>
Not all Belkin F5U002 USB Parallel Printer Adapters used the USS720 chip. Look for the dark grey
adapters with the removable USB cable for best results.
Not all Belkin F5U002 USB Parallel Printer Adapters used the USS720 chip. Look for the dark grey
adapters with the removable USB cable for best results.
</para>
</note>
@@ -2332,7 +2332,7 @@ port expander there (PCF8574P in this example).
+-----|A1 | ___
Here: 0x00 | | | +---|___|--o 15 backlight
=== | | |c 10R
| |12 ___ b|/
| |12 ___ b|/
|13 P7|-----|___|-----|
-|INT | 1k |\
| | bc557 |e
@@ -2354,7 +2354,7 @@ port expander there (PCF8574P in this example).
</figure>
<sect4 id="hd44780-i2c-config">
<title>Configuration</title>
<title>Configuration</title>
<example id="hd44780-i2c-config.example">
<title>HD44780: Configuration for I<superscript>2</superscript>C with port expander</title>
@@ -2374,15 +2374,15 @@ Keypad=no
</example>
<para>
The <command>Device</command> configuration setting denotes the device file
The <property>Device</property> configuration setting denotes the device file
of your I<superscript>2</superscript>C bus (here <filename>/dev/i2c-0</filename>).
You have to load the kernel standard module <filename>i2c-dev.ko</filename> and
the bus driver, but <emphasis>no</emphasis> I<superscript>2</superscript>C
the bus driver, but <emphasis>no</emphasis> I<superscript>2</superscript>C
chip modules (e.g. <filename>pcf8574.ko</filename>)!
</para>
<para>
The <command>Port</command> config option contains the I<superscript>2</superscript>C
The <property>Port</property> config option contains the I<superscript>2</superscript>C
address of the I<superscript>2</superscript>C port expander
(here 0x20, the PCF8574 from the example above, with all address bits set to <literal>0</literal>).
@@ -2481,7 +2481,7 @@ is the wiring - instead of connecting the display directly to PC (via serial/par
it is connected via ethernet and the communication is done over TCP connection.
The main feature is - that to power and control the LCD is needed single UTP cable.
To use the driver, specify the device IP address or hostname, on which the ethlcd device
is accessible by setting in config file the <command>Device</command> value.
is accessible by setting in config file the <property>Device</property> value.
The default is <filename>ethlcd</filename>.
</para>
@@ -2539,8 +2539,8 @@ This can be done by specifying <option>--enable-drivers=all</option> or by inclu
<variablelist>
<varlistentry>
<term>
<command>Port</command> =
<arg choice="plain"><replaceable>PORT</replaceable></arg>
<property>Port</property> =
<parameter><replaceable>PORT</replaceable></parameter>
</term>
<listitem><para>
For parallel connections, specify the address of the parallel port the LCD is connected to.
@@ -2552,8 +2552,8 @@ This can be done by specifying <option>--enable-drivers=all</option> or by inclu
<varlistentry>
<term>
<command>Device</command> =
<arg choice="plain"><replaceable>DEVICE</replaceable></arg>
<property>Device</property> =
<parameter><replaceable>DEVICE</replaceable></parameter>
</term>
<listitem><para>
If you are using a serial or I<superscript>2</superscript>C connection,
@@ -2566,28 +2566,26 @@ This can be done by specifying <option>--enable-drivers=all</option> or by inclu
<varlistentry>
<term>
<command>ConnectionType</command> =
<arg choice="plain">
<group choice="req">
<arg choice="plain"><literal><emphasis>4bit</emphasis></literal></arg>
<arg choice="plain"><literal>8bit</literal></arg>
<arg choice="plain"><literal>winamp</literal></arg>
<arg choice="plain"><literal>serialLpt</literal></arg>
<arg choice="plain"><literal>picanlcd</literal></arg>
<arg choice="plain"><literal>lcdserializer</literal></arg>
<arg choice="plain"><literal>los-panel</literal></arg>
<arg choice="plain"><literal>vdr-lcd</literal></arg>
<arg choice="plain"><literal>vdr-wakeup</literal></arg>
<arg choice="plain"><literal>pertelian</literal></arg>
<arg choice="plain"><literal>bwctusb</literal></arg>
<arg choice="plain"><literal>lcd2usb</literal></arg>
<arg choice="plain"><literal>lis2</literal></arg>
<arg choice="plain"><literal>mplay</literal></arg>
<arg choice="plain"><literal>i2c</literal></arg>
<arg choice="plain"><literal>ftdi</literal></arg>
<arg choice="plain"><literal>usblcd</literal></arg>
</group>
</arg>
<property>ConnectionType</property> =
{
<emphasis><parameter><literal>4bit</literal></parameter></emphasis> |
<parameter><literal>8bit</literal></parameter> |
<parameter><literal>winamp</literal></parameter> |
<parameter><literal>serialLpt</literal></parameter> |
<parameter><literal>picanlcd</literal></parameter> |
<parameter><literal>lcdserializer</literal></parameter> |
<parameter><literal>los-panel</literal></parameter> |
<parameter><literal>vdr-lcd</literal></parameter> |
<parameter><literal>vdr-wakeup</literal></parameter> |
<parameter><literal>pertelian</literal></parameter> |
<parameter><literal>bwctusb</literal></parameter> |
<parameter><literal>lcd2usb</literal></parameter> |
<parameter><literal>lis2</literal></parameter> |
<parameter><literal>mplay</literal></parameter> |
<parameter><literal>i2c</literal></parameter> |
<parameter><literal>ftdi</literal></parameter> |
<parameter><literal>usblcd</literal></parameter>
}
</term>
<listitem>
<para>
@@ -2602,7 +2600,7 @@ This can be done by specifying <option>--enable-drivers=all</option> or by inclu
</row>
</thead>
<tbody>
<!-- parallel -->
<!-- parallel -->
<row>
<entry><literal><link linkend="hd44780-4bit">4bit</link></literal></entry>
<entry>4bit Wiring to parallel port(default)</entry>
@@ -2619,7 +2617,7 @@ This can be done by specifying <option>--enable-drivers=all</option> or by inclu
<entry><literal><link linkend="hd44780-seriallpt">serialLpt</link></literal></entry>
<entry>Serial LPT Wiring</entry>
</row>
<!-- serial -->
<!-- serial -->
<row>
<entry><literal><link linkend="hd44780-picanlcd">picanlcd</link></literal></entry>
<entry>PIC-an-LCD serial device "picanlcd"</entry>
@@ -2640,7 +2638,7 @@ This can be done by specifying <option>--enable-drivers=all</option> or by inclu
<entry><literal><link linkend="hd44780-vdr-wakeup">vdr-wakeup</link></literal></entry>
<entry>VDR-Wakeup module "vdr-wakeup"</entry>
</row>
<!-- USB -->
<!-- USB -->
<row>
<entry><literal><link linkend="hd44780-pertelian">pertelian</link></literal></entry>
<entry>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>)</entry>
@@ -2669,7 +2667,7 @@ This can be done by specifying <option>--enable-drivers=all</option> or by inclu
<entry><literal><link linkend="hd44780-usblcd">usblcd</link></literal></entry>
<entry>USBLCD adapter from Adams IT Services (<ulink url="http://www.usblcd.de/"></ulink>)</entry>
</row>
<!-- I2C -->
<!-- I2C -->
<row>
<entry><literal><link linkend="hd44780-i2c">i2c</link></literal></entry>
<entry>LCD driven by PCF8574(A)/PCA9554(A) connected via I<superscript>2</superscript>C</entry>
@@ -2692,8 +2690,8 @@ This can be done by specifying <option>--enable-drivers=all</option> or by inclu
<varlistentry>
<term>
<command>Speed</command> =
<arg choice="plain"><replaceable>BITRATE</replaceable></arg>
<property>Speed</property> =
<parameter><replaceable>BITRATE</replaceable></parameter>
</term>
<listitem><para>
For a serial connection, set to the serial port bitrate. To use
@@ -2703,15 +2701,13 @@ This can be done by specifying <option>--enable-drivers=all</option> or by inclu
<varlistentry>
<term>
<command>CharMap</command> =
<arg choice="plain">
<group choice="req">
<arg choice="plain"><literal><emphasis>hd44780_default</emphasis></literal></arg>
<arg choice="plain"><literal>hd44780_euro</literal></arg>
<arg choice="plain"><literal>ea_ks0073</literal></arg>
<arg choice="plain"><literal>sed12780f_0b</literal></arg>
</group>
</arg>
<property>CharMap</property> =
{
<emphasis><parameter><literal>hd44780_default</literal></parameter></emphasis> |
<parameter><literal>hd44780_euro</literal></parameter> |
<parameter><literal>ea_ks0073</literal></parameter> |
<parameter><literal>sed12780f_0b</literal></parameter>
}
</term>
<listitem><para>
Set the character mapping depending on the display you have:
@@ -2719,21 +2715,21 @@ This can be done by specifying <option>--enable-drivers=all</option> or by inclu
<listitem><para>
The default, <literal>hd44780_default</literal>, is for "classic"
HD44780 displays.
</para></listitem>
<listitem><para>
</para></listitem>
<listitem><para>
<literal>hd44780_euro</literal> is for displays with a ROM mask
supporting the european charset (ROM code A02).
</para></listitem>
<listitem><para>
</para></listitem>
<listitem><para>
<literal>ea_ks0073</literal> is the charmap for Electronic
Assembly's KS0073 based displays. These devices have a richer
charset, including many icons and many more characters of the
ISO-8859-1 than standard HD44780s.
</para></listitem>
<listitem><para>
<literal>sed12780f_0b</literal> is for some SED 1278 displays.
</para></listitem>
</itemizedlist>
</para></listitem>
<listitem><para>
<literal>sed12780f_0b</literal> is for some SED 1278 displays.
</para></listitem>
</itemizedlist>
You only need to set this parameter if you have a non-standard
HD44780 display.
@@ -2749,13 +2745,7 @@ This can be done by specifying <option>--enable-drivers=all</option> or by inclu
<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>
<property>Keypad</property> = &parameters.yesnodef;
</term>
<listitem><para>
Tell whether you have a keypad connected.
@@ -2765,8 +2755,8 @@ This can be done by specifying <option>--enable-drivers=all</option> or by inclu
<varlistentry>
<term>
<command>Brightness</command> =
<arg choice="plain"><replaceable>BRIGHTNESS</replaceable></arg>
<property>Brightness</property> =
<parameter><replaceable>BRIGHTNESS</replaceable></parameter>
</term>
<listitem><para>
Set the initial brightness when the backlight is on
@@ -2778,8 +2768,8 @@ This can be done by specifying <option>--enable-drivers=all</option> or by inclu
<varlistentry>
<term>
<command>OffBrightness</command> =
<arg choice="plain"><replaceable>BRIGHTNESS</replaceable></arg>
<property>OffBrightness</property> =
<parameter><replaceable>BRIGHTNESS</replaceable></parameter>
</term>
<listitem><para>
Set the initial off-brightness, i.e. the brightness when the backlight is off,
@@ -2791,8 +2781,8 @@ This can be done by specifying <option>--enable-drivers=all</option> or by inclu
<varlistentry>
<term>
<command>Contrast</command> =
<arg choice="plain"><replaceable>CONTRAST</replaceable></arg>
<property>Contrast</property> =
<parameter><replaceable>CONTRAST</replaceable></parameter>
</term>
<listitem><para>
Set the initial contrast for the <code>bwctusb</code> and
@@ -2808,13 +2798,7 @@ This can be done by specifying <option>--enable-drivers=all</option> or by inclu
<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>
<property>Backlight</property> = &parameters.yesnodef;
</term>
<listitem><para>
Specifiy if you have a switchable backlight.
@@ -2823,13 +2807,7 @@ This can be done by specifying <option>--enable-drivers=all</option> or by inclu
<varlistentry>
<term>
<command>OutputPort</command> =
<arg choice="plain">
<group choice="req">
<arg choice="plain"><literal>yes</literal></arg>
<arg choice="plain"><literal><emphasis>no</emphasis></literal></arg>
</group>
</arg>
<property>OutputPort</property> = &parameters.yesnodef;
</term>
<listitem><para>
Tell if you have the additional output port ("bargraph") and you want to
@@ -2839,29 +2817,18 @@ This can be done by specifying <option>--enable-drivers=all</option> or by inclu
<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>
<property>Lastline</property> = &parameters.yesdefno;
</term>
<listitem><para>
Specifies whether the lowest pixel line of a character is pixel addressable
or if it controls an underline effect.
or if it controls an underline effect.
The default is <literal>yes</literal>, meaning a pixel addressable last pixel line.
</para></listitem>
</varlistentry>
<varlistentry>
<term>
<command>Size</command> =
<arg choice="plain">
<replaceable>WIDTH</replaceable>
<literal>x</literal>
<replaceable>HEIGHT</replaceable>
</arg>
<property>Size</property> = &parameters.size;
</term>
<listitem><para>
Specifies the size of the LCD.
@@ -2872,11 +2839,11 @@ This can be done by specifying <option>--enable-drivers=all</option> or by inclu
<varlistentry>
<term>
<command>vSpan</command> =
<arg choice="plain">
<property>vSpan</property> =
<parameter>
<replaceable>HEIGHT</replaceable>
<literal>,</literal>&hellip;
</arg>
</parameter>
</term>
<listitem><para>
The "vertical span" when using the driver with multi-controller displays
@@ -2898,13 +2865,7 @@ This can be done by specifying <option>--enable-drivers=all</option> or by inclu
<varlistentry>
<term>
<command>ExtendedMode</command> =
<arg choice="plain">
<group choice="req">
<arg choice="plain"><literal>yes</literal></arg>
<arg choice="plain"><literal><emphasis>no</emphasis></literal></arg>
</group>
</arg>
<property>ExtendedMode</property> = &parameters.yesnodef;
</term>
<listitem><para>
If you have a KS0073 or an other 'almost HD44780-compatible', set this
@@ -2914,8 +2875,8 @@ This can be done by specifying <option>--enable-drivers=all</option> or by inclu
<varlistentry>
<term>
<command>LineAddress</command> =
<arg choice="plain"><replaceable>ADDR</replaceable></arg>
<property>LineAddress</property> =
<parameter><replaceable>ADDR</replaceable></parameter>
</term>
<listitem><para>
If the next line of your display doesn't start <literal>0x20</literal> higher in
@@ -2925,8 +2886,8 @@ This can be done by specifying <option>--enable-drivers=all</option> or by inclu
<varlistentry>
<term>
<command>DelayMult</command> =
<arg choice="plain"><replaceable>DELAY</replaceable></arg>
<property>DelayMult</property> =
<parameter><replaceable>DELAY</replaceable></parameter>
</term>
<listitem><para>
If your display is slow and cannot keep up with the flow of data from
@@ -2938,13 +2899,7 @@ This can be done by specifying <option>--enable-drivers=all</option> or by inclu
<varlistentry>
<term>
<command>DelayBus</command> =
<arg choice="plain">
<group choice="req">
<arg choice="plain"><literal><emphasis>yes</emphasis></literal></arg>
<arg choice="plain"><literal>no</literal></arg>
</group>
</arg>
<property>DelayBus</property> = &parameters.yesdefno;
</term>
<listitem><para>
You can reduce the inserted delays by setting this to <literal>no</literal>.
@@ -2955,8 +2910,8 @@ This can be done by specifying <option>--enable-drivers=all</option> or by inclu
<varlistentry>
<term>
<command>KeepAliveDisplay</command> =
<arg choice="plain"><replaceable>SECONDS</replaceable></arg>
<property>KeepAliveDisplay</property> =
<parameter><replaceable>SECONDS</replaceable></parameter>
</term>
<listitem><para>
Some displays (e.g. <code>vdr-wakeup</code>) need a message from the driver to
@@ -2969,8 +2924,8 @@ This can be done by specifying <option>--enable-drivers=all</option> or by inclu
<varlistentry>
<term>
<command>RefreshDisplay</command> =
<arg choice="plain"><replaceable>SECONDS</replaceable></arg>
<property>RefreshDisplay</property> =
<parameter><replaceable>SECONDS</replaceable></parameter>
</term>
<listitem><para>
If you experience occasional garbage on your display you can use this
@@ -2982,12 +2937,12 @@ This can be done by specifying <option>--enable-drivers=all</option> or by inclu
<varlistentry>
<term>
<command>KeyDirect_<replaceable>NUM</replaceable></command> =
<arg choice="plain"><replaceable>KEY</replaceable></arg>
<property>KeyDirect_<replaceable>NUM</replaceable></property> =
<parameter><replaceable>KEY</replaceable></parameter>
</term>
<term>
<command>KeyMatrix_<replaceable>X</replaceable>_<replaceable>Y</replaceable></command> =
<arg choice="plain"><replaceable>KEY</replaceable></arg>
<property>KeyMatrix_<replaceable>X</replaceable>_<replaceable>Y</replaceable></property> =
<parameter><replaceable>KEY</replaceable></parameter>
</term>
<listitem>
<para>
@@ -3008,36 +2963,36 @@ This can be done by specifying <option>--enable-drivers=all</option> or by inclu
<varlistentry>
<term>
<command>VendorID</command> =
<arg choice="plain"><replaceable>VENDORID</replaceable></arg>
<property>VendorID</property> =
<parameter><replaceable>VENDORID</replaceable></parameter>
</term>
<listitem><para>
USB vendor ID to look for in certain USB connection types.
When using an FTDI chip with connection type <code>ftdi</code>, the default value is
<literal>0x4003</literal>.
When using a USS720 chip with connection type <code>uss720</code>, the default value is
USB vendor ID to look for in certain USB connection types.
When using an FTDI chip with connection type <code>ftdi</code>, the default value is
<literal>0x4003</literal>.
When using a USS720 chip with connection type <code>uss720</code>, the default value is
<literal>0x1293</literal>.
</para></listitem>
</varlistentry>
<varlistentry>
<term>
<command>ProductID</command> =
<arg choice="plain"><replaceable>PRODUCTID</replaceable></arg>
<property>ProductID</property> =
<parameter><replaceable>PRODUCTID</replaceable></parameter>
</term>
<listitem><para>
USB product ID to look for in certain USB connection types.
When using an FTDI chip with connection type <code>ftdi</code>, the default value is
USB product ID to look for in certain USB connection types.
When using an FTDI chip with connection type <code>ftdi</code>, the default value is
<literal>0x6001</literal>.
When using a USS720 chip with connection type <code>uss720</code>, the default value is
When using a USS720 chip with connection type <code>uss720</code>, the default value is
<literal>0x0002</literal>.
</para></listitem>
</varlistentry>
<varlistentry>
<term>
<command>SerialNumber</command> =
<arg choice="plain"><replaceable>SERIALNO</replaceable></arg>
<property>SerialNumber</property> =
<parameter><replaceable>SERIALNO</replaceable></parameter>
</term>
<listitem><para>
Serial number of the USB device to look for with
@@ -3052,36 +3007,6 @@ This can be done by specifying <option>--enable-drivers=all</option> or by inclu
</sect2>
<!--
<sect2 id="hd44780-running">
<title>Running</title>
<para>
Modify the <filename>LCDd.conf</filename> file before you run LCDd. In this config file are
detailed instructions on how to configure the HD44780 driver.
</para>
<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 <filename>LCDd.conf</filename> then use:
</para>
<para>
<command>LCDd -c ./LCDd.conf -d HD44780</command>
</para>
<para>
If you use this, the HD44780 driver will read the options from the config
file anyway.
</para>
</sect2>
-->
<sect2 id="hd44780-miscellania">
<title>Miscellania</title>
docs/lcdproc-user/drivers/icp_a106.docbook
+3 -2
View File
@@ -25,10 +25,11 @@ very nice.
<variablelist>
<varlistentry>
<term>
<command>Device</command> =
<arg choice="plain"><replaceable>DEVICE</replaceable></arg>
<property>Device</property> =
<parameter><replaceable>DEVICE</replaceable></parameter>
</term>
<listitem><para>
Sets the device to use. Defaults to <filename>/dev/lcd</filename>.
</para></listitem>
</varlistentry>
</variablelist>
docs/lcdproc-user/drivers/imon.docbook
+3 -8
View File
@@ -56,12 +56,7 @@ For further details, please consult the page and the forum at
<variablelist>
<varlistentry>
<term>
<command>Size</command> =
<arg choice="plain">
<replaceable>WIDTH</replaceable>
<literal>x</literal>
<replaceable>HEIGHT</replaceable>
</arg>
<property>Size</property> = &parameters.size;
</term>
<listitem><para>
Set the display size. The default <literal>16x2</literal> should be safe
@@ -73,8 +68,8 @@ For further details, please consult the page and the forum at
<varlistentry>
<term>
<command>Device</command> =
<arg choice="plain"><replaceable>DEVICE</replaceable></arg>
<property>Device</property> =
<parameter><replaceable>DEVICE</replaceable></parameter>
</term>
<listitem><para>
Select the output device to use. Change this from the default
docs/lcdproc-user/drivers/imonlcd.docbook
+15 -22
View File
@@ -38,22 +38,20 @@ The 15c2:0038 device may require LIRC v0.8.5 or newer.
<variablelist>
<varlistentry>
<term>
<command>Protocol</command> =
<arg choice="plain">
<replaceable>PROTOCOL</replaceable>
</arg>
<property>Protocol</property> =
<parameter><replaceable>PROTOCOL</replaceable></parameter>
</term>
<listitem><para>
Specify which version of iMON LCD is installed.
The default, <literal>0</literal> specifies the :ffdc device.
<literal>1</literal> should be used for the :0038 device.
</para></listitem>
</varlistentry>
</varlistentry>
<varlistentry>
<term>
<command>OnExit</command> =
<arg choice="plain"><replaceable>ONEXIT</replaceable></arg>
<property>OnExit</property> =
<parameter><replaceable>ONEXIT</replaceable></parameter>
</term>
<listitem><para>
Specify the exit behavior.
@@ -65,8 +63,8 @@ The 15c2:0038 device may require LIRC v0.8.5 or newer.
<varlistentry>
<term>
<command>Device</command> =
<arg choice="plain"><replaceable>DEVICE</replaceable></arg>
<property>Device</property> =
<parameter><replaceable>DEVICE</replaceable></parameter>
</term>
<listitem><para>
Select the output device to use. Change this from the default
@@ -78,8 +76,8 @@ The 15c2:0038 device may require LIRC v0.8.5 or newer.
<varlistentry>
<term>
<command>Contrast</command> =
<arg choice="plain"><replaceable>CONTRAST</replaceable></arg>
<property>Contrast</property> =
<parameter><replaceable>CONTRAST</replaceable></parameter>
</term>
<listitem><para>
Select the display's contrast <literal>200</literal> is the default.
@@ -89,12 +87,7 @@ The 15c2:0038 device may require LIRC v0.8.5 or newer.
<varlistentry>
<term>
<command>Size</command> =
<arg choice="plain">
<replaceable>WIDTH</replaceable>
<literal>x</literal>
<replaceable>HEIGHT</replaceable>
</arg>
<property>Size</property> = &parameters.size;
</term>
<listitem><para>
Set the display size in pixels. The default <literal>96x16</literal> should
@@ -105,8 +98,8 @@ The 15c2:0038 device may require LIRC v0.8.5 or newer.
<varlistentry>
<term>
<command>Backlight</command> =
<arg choice="plain"><replaceable>BACKLIGHT</replaceable></arg>
<property>Backlight</property> =
<parameter><replaceable>BACKLIGHT</replaceable></parameter>
</term>
<listitem><para>
Set the backlight state. The default is <literal>1</literal>, which turns
@@ -116,8 +109,8 @@ The 15c2:0038 device may require LIRC v0.8.5 or newer.
<varlistentry>
<term>
<command>DiscMode</command> =
<arg choice="plain"><replaceable>DISCMODE</replaceable></arg>
<property>DiscMode</property> =
<parameter><replaceable>DISCMODE</replaceable></parameter>
</term>
<listitem><para>
Sets the disc mode. The default is <literal>0</literal> which spins the
docs/lcdproc-user/drivers/irman.docbook
+4 -4
View File
@@ -68,8 +68,8 @@ The keys are mapped according to the following table:
<variablelist>
<varlistentry>
<term>
<command>Device</command> =
<arg choice="plain"><replaceable>DEVICE</replaceable></arg>
<property>Device</property> =
<parameter><replaceable>DEVICE</replaceable></parameter>
</term>
<listitem><para>
Select the input device to use, e.g. <filename>/dev/irman</filename>.
@@ -78,8 +78,8 @@ The keys are mapped according to the following table:
<varlistentry>
<term>
<command>Config</command> =
<arg choice="plain"><replaceable>FILENAME</replaceable></arg>
<property>Config</property> =
<parameter><replaceable>FILENAME</replaceable></parameter>
</term>
<listitem><para>
Select the IrMan configuration file to use, e.g. <filename>/etc/irman.cfg</filename>.
docs/lcdproc-user/drivers/irtrans.docbook
+6 -17
View File
@@ -13,7 +13,7 @@ devices, that are preinstalled in cases such as the Ahanix MCE303.
<para>
The IRTrans VFD sports a vacuum fluorescent display with 16x2 characters
that connects to the computer using USB. Although the device is shipped
with an IR remote control, <package>LCDproc</package>'s driver currently only supports
with an IR remote control, <package>LCDproc</package>'s driver currently only supports
the display part of the device.
</para>
@@ -34,24 +34,18 @@ from <ulink url="http://www.irtrans.de/en/download/linux.php"></ulink>.
<variablelist>
<varlistentry>
<term>
<command>Backlight</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>Backlight</property> = &parameters.yesnodef;
</term>
<listitem><para>
Tell whether te device has a backlight, or whether the backlight shall be used.
If not goven, it defaults to <literal><emphasis>no</emphasis></literal>.
If not goven, it defaults to <literal>no</literal>.
</para></listitem>
</varlistentry>
<varlistentry>
<term>
<command>Hostname</command> =
<arg choice="plain"><replaceable>HOSTNAME_OR_IP-ADDRESS</replaceable></arg>
<property>Hostname</property> =
<parameter><replaceable>HOSTNAME_OR_IP-ADDRESS</replaceable></parameter>
</term>
<listitem><para>
Set the hostname or IP address of the IRTrans device to connect to.
@@ -61,12 +55,7 @@ from <ulink url="http://www.irtrans.de/en/download/linux.php"></ulink>.
<varlistentry>
<term>
<command>Size</command> =
<arg choice="plain">
<replaceable>WIDTH</replaceable>
<literal>x</literal>
<replaceable>HEIGHT</replaceable>
</arg>
<property>Size</property> = &parameters.size;
</term>
<listitem><para>
Select the display size [default: <literal>16x2</literal>]
docs/lcdproc-user/drivers/joy.docbook
+10 -10
View File
@@ -15,8 +15,8 @@ This section covers the joystick input driver for LCDd.
<variablelist>
<varlistentry>
<term>
<command>Device</command> =
<arg choice="plain"><replaceable>DEVICE</replaceable></arg>
<property>Device</property> =
<parameter><replaceable>DEVICE</replaceable></parameter>
</term>
<listitem><para>
Select the input device to use [default: <filename>/dev/js0</filename>]
@@ -25,12 +25,12 @@ This section covers the joystick input driver for LCDd.
<varlistentry>
<term>
<command>Map_Axis<replaceable>NUM</replaceable>neg</command> =
<arg choice="plain"><replaceable>KEY</replaceable></arg>
<property>Map_Axis<replaceable>NUM</replaceable>neg</property> =
<parameter><replaceable>KEY</replaceable></parameter>
</term>
<term>
<command>Map_Axis<replaceable>NUM</replaceable>pos</command> =
<arg choice="plain"><replaceable>KEY</replaceable></arg>
<property>Map_Axis<replaceable>NUM</replaceable>pos</property> =
<parameter><replaceable>KEY</replaceable></parameter>
</term>
<listitem>
<para>
@@ -46,7 +46,7 @@ This section covers the joystick input driver for LCDd.
<para>
<replaceable>KEY</replaceable> can be one of the keys that LCDd recognizes
(<literal>Left</literal>, <literal>Right</literal>, <literal>Up</literal>,
(<literal>Left</literal>, <literal>Right</literal>, <literal>Up</literal>,
<literal>Down</literal>, <literal>Enter</literal> or <literal>Escape</literal>)
or any other string that a client can parse.
</para>
@@ -55,8 +55,8 @@ This section covers the joystick input driver for LCDd.
<varlistentry>
<term>
<command>Map_Button<replaceable>NUM</replaceable></command> =
<arg choice="plain"><replaceable>KEY</replaceable></arg>
<property>Map_Button<replaceable>NUM</replaceable></property> =
<parameter><replaceable>KEY</replaceable></parameter>
</term>
<listitem>
<para>
@@ -71,7 +71,7 @@ This section covers the joystick input driver for LCDd.
<para>
<replaceable>KEY</replaceable> can be one of the keys that LCDd recognizes
(<literal>Left</literal>, <literal>Right</literal>, <literal>Up</literal>,
(<literal>Left</literal>, <literal>Right</literal>, <literal>Up</literal>,
<literal>Down</literal>, <literal>Enter</literal> or <literal>Escape</literal>)
or any other string that a client can parse.
</para>
docs/lcdproc-user/drivers/lb216.docbook
+10 -18
View File
@@ -35,8 +35,8 @@ made in australia :-)
<variablelist>
<varlistentry>
<term>
<command>Device</command> =
<arg choice="plain"><replaceable>DEVICE</replaceable></arg>
<property>Device</property> =
<parameter><replaceable>DEVICE</replaceable></parameter>
</term>
<listitem><para>
Select the output device to use [default: <filename>/dev/lcd</filename>]
@@ -45,8 +45,8 @@ made in australia :-)
<varlistentry>
<term>
<command>Brightness</command> =
<arg choice="plain"><replaceable>BRIGHTNESS</replaceable></arg>
<property>Brightness</property> =
<parameter><replaceable>BRIGHTNESS</replaceable></parameter>
</term>
<listitem><para>
Set the initial brightness [default: <literal>255</literal>; legal: <literal>0</literal> - <literal>255</literal>]
@@ -55,13 +55,11 @@ made in australia :-)
<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>
<property>Speed</property> =
{
<parameter><literal>2400</literal></parameter> |
<emphasis><parameter><literal>9600</literal></parameter></emphasis>
}
</term>
<listitem><para>
Set the the baud rate to use when communicating with the LCD.
@@ -71,13 +69,7 @@ made in australia :-)
<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>
<property>Reboot</property> = &parameters.yesnodef;
</term>
<listitem><para>
Reinitialize the LCD's BIOS [default: <literal>no</literal>; legal: <literal>yes</literal>, <literal>no</literal>]
docs/lcdproc-user/drivers/lcdm001.docbook
+11 -11
View File
@@ -16,8 +16,8 @@ lcdm001 chipset.
<variablelist>
<varlistentry>
<term>
<command>Device</command> =
<arg choice="plain"><replaceable>DEVICE</replaceable></arg>
<property>Device</property> =
<parameter><replaceable>DEVICE</replaceable></parameter>
</term>
<listitem><para>
Default: <filename>/dev/lcd</filename>
@@ -26,20 +26,20 @@ lcdm001 chipset.
<varlistentry>
<term>
<command>PauseKey</command> =
<arg choice="plain"><replaceable>KEY</replaceable></arg>
<property>PauseKey</property> =
<parameter><replaceable>KEY</replaceable></parameter>
</term>
<term>
<command>BackKey</command> =
<arg choice="plain"><replaceable>KEY</replaceable></arg>
<property>BackKey</property> =
<parameter><replaceable>KEY</replaceable></parameter>
</term>
<term>
<command>ForwardKey</command> =
<arg choice="plain"><replaceable>KEY</replaceable></arg>
<property>ForwardKey</property> =
<parameter><replaceable>KEY</replaceable></parameter>
</term>
<term>
<command>MainMenuKey</command> =
<arg choice="plain"><replaceable>KEY</replaceable></arg>
<property>MainMenuKey</property> =
<parameter><replaceable>KEY</replaceable></parameter>
</term>
<listitem>
<para>
@@ -75,7 +75,7 @@ lcdm001 chipset.
<entry>Open main menu</entry>
<entry>Exit/Cancel</entry>
</row>
</tbody>
</tbody>
</tgroup>
</informaltable>
<para>
docs/lcdproc-user/drivers/lcterm.docbook
+4 -9
View File
@@ -16,8 +16,8 @@ lcterm chipset.
<variablelist>
<varlistentry>
<term>
<command>Device</command> =
<arg choice="plain"><replaceable>DEVICE</replaceable></arg>
<property>Device</property> =
<parameter><replaceable>DEVICE</replaceable></parameter>
</term>
<listitem><para>
Default: <filename>/dev/lcd</filename>
@@ -26,15 +26,10 @@ lcterm chipset.
<varlistentry>
<term>
<command>Size</command> =
<arg choice="plain">
<replaceable>WIDTH</replaceable>
<literal>x</literal>
<replaceable>HEIGHT</replaceable>
</arg>
<property>Size</property> = &parameters.size;
</term>
<listitem><para>
16x2
Default: <literal>16x2</literal>.
</para></listitem>
</varlistentry>
</variablelist>
docs/lcdproc-user/drivers/lircin.docbook
+5 -5
View File
@@ -81,14 +81,14 @@ Then you have to modify the <code>[lirc]</code> section of your
<variablelist>
<varlistentry>
<term>
<command>lircrc</command> =
<arg choice="plain"><replaceable>FILENAME</replaceable></arg>
<property>lircrc</property> =
<parameter><replaceable>FILENAME</replaceable></parameter>
</term>
<listitem>
<para>
<anchor id="which-lircrc" />
Normally all LIRC clients scan the file <filename>~/.lircrc</filename>.
However, you might want to have a separate file to configure the LCDproc lirc driver only.
However, you might want to have a separate file to configure the LCDproc lirc driver only.
</para>
<para>
This option enables you to specify the file you want the lirc driver to scan.
@@ -99,8 +99,8 @@ Then you have to modify the <code>[lirc]</code> section of your
<varlistentry>
<term>
<command>Prog</command> =
<arg choice="plain"><replaceable>PROGRAM</replaceable></arg>
<property>Prog</property> =
<parameter><replaceable>PROGRAM</replaceable></parameter>
</term>
<listitem>
<para>
docs/lcdproc-user/drivers/lis.docbook
+9 -18
View File
@@ -58,12 +58,7 @@ USB library.
<variablelist>
<varlistentry>
<term>
<command>Size</command> =
<arg choice="plain">
<replaceable>WIDTH</replaceable>
<literal>x</literal>
<replaceable>HEIGHT</replaceable>
</arg>
<property>Size</property> = &parameters.size;
</term>
<listitem><para>
Set the display size. The default <literal>20x2</literal> should be safe
@@ -75,10 +70,8 @@ USB library.
<varlistentry>
<term>
<command>VendorID</command> =
<arg choice="plain">
<replaceable>VENDORID</replaceable>
</arg>
<property>VendorID</property> =
<parameter><replaceable>VENDORID</replaceable></parameter>
</term>
<listitem>
<para>
@@ -96,16 +89,14 @@ USB library.
<varlistentry>
<term>
<command>ProductID</command> =
<arg choice="plain">
<replaceable>PRODUCTID</replaceable>
</arg>
<property>ProductID</property> =
<parameter><replaceable>PRODUCTID</replaceable></parameter>
</term>
<listitem>
<para>
The USB Product ID of the device to use.
If not given, it defaults to <literal>0x6001</literal> for a VLSystems L.I.S. MCE 2005 VFD
based on a FT232BL USB-to-RS232 converter by FTDI, which was produced
based on a FT232BL USB-to-RS232 converter by FTDI, which was produced
before March 2007.
</para>
<para>
@@ -117,12 +108,12 @@ USB library.
<varlistentry>
<term>
<command>Brightness</command> =
<arg choice="plain"><replaceable>BRIGHTNESS</replaceable></arg>
<property>Brightness</property> =
<parameter><replaceable>BRIGHTNESS</replaceable></parameter>
</term>
<listitem>
<para>
Set the initial brightness [default: <literal>1000</literal>;
Set the initial brightness [default: <literal>1000</literal>;
legal: <literal>0</literal> - <literal>1000</literal>. Values
between 0 and 250 give 25% brightness, 251 to 500 give 50% brightness,
501 and 750, give 75% brightness, and values higher than 751 give 100%
docs/lcdproc-user/drivers/ms6931.docbook
+3 -8
View File
@@ -16,8 +16,8 @@ ms6931 chipset.
<variablelist>
<varlistentry>
<term>
<command>Device</command> =
<arg choice="plain"><replaceable>DEVICE</replaceable></arg>
<property>Device</property> =
<parameter><replaceable>DEVICE</replaceable></parameter>
</term>
<listitem><para>
device to use [default: <filename>/dev/ttyS1</filename>]
@@ -26,12 +26,7 @@ ms6931 chipset.
<varlistentry>
<term>
<command>Size</command> =
<arg choice="plain">
<replaceable>WIDTH</replaceable>
<literal>x</literal>
<replaceable>HEIGHT</replaceable>
</arg>
<property>Size</property> = &parameters.size;
</term>
<listitem><para>
display size [default: <literal>16x2</literal>]
docs/lcdproc-user/drivers/mtc_s16209x.docbook
+5 -11
View File
@@ -16,8 +16,8 @@ mtc_s16209x chipset.
<variablelist>
<varlistentry>
<term>
<command>Device</command> =
<arg choice="plain"><replaceable>DEVICE</replaceable></arg>
<property>Device</property> =
<parameter><replaceable>DEVICE</replaceable></parameter>
</term>
<listitem><para>
Select the output device to use [default: <filename>/dev/lcd</filename>]
@@ -26,8 +26,8 @@ mtc_s16209x chipset.
<varlistentry>
<term>
<command>Brightness</command> =
<arg choice="plain"><replaceable>BRIGHTNESS</replaceable></arg>
<property>Brightness</property> =
<parameter><replaceable>BRIGHTNESS</replaceable></parameter>
</term>
<listitem><para>
Set the initial brightness [default: <literal>255</literal>; legal: <literal>0</literal> - <literal>255</literal>]
@@ -36,13 +36,7 @@ mtc_s16209x chipset.
<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>
<property>Reboot</property> = &parameters.yesnodef;
</term>
<listitem><para>
Reinitialize the LCD's BIOS [default: <literal>no</literal>; legal: <literal>yes</literal>, <literal>no</literal>]
docs/lcdproc-user/drivers/mtxorb.docbook
+29 -86
View File
@@ -233,8 +233,8 @@ Slightly modified in order to include it in this document March 2002, Rene Wagne
<variablelist>
<varlistentry>
<term>
<command>Device</command> =
<arg choice="plain"><replaceable>DEVICE</replaceable></arg>
<property>Device</property> =
<parameter><replaceable>DEVICE</replaceable></parameter>
</term>
<listitem><para>
Select the output device to use [default: <filename>/dev/lcd</filename>]
@@ -243,12 +243,7 @@ Slightly modified in order to include it in this document March 2002, Rene Wagne
<varlistentry>
<term>
<command>Size</command> =
<arg choice="plain">
<replaceable>WIDTH</replaceable>
<literal>x</literal>
<replaceable>HEIGHT</replaceable>
</arg>
<property>Size</property> = &parameters.size;
</term>
<listitem><para>
Set the display size [default: <literal>20x4</literal>]
@@ -257,15 +252,13 @@ Slightly modified in order to include it in this document March 2002, Rene Wagne
<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>
<property>Type</property> =
{
<emphasis><parameter><literal>lcd</literal></parameter></emphasis> |
<parameter><literal>lkd</literal></parameter> |
<parameter><literal>vfd</literal></parameter> |
<parameter><literal>vkd</literal></parameter>
}
</term>
<listitem><para>
Set the display type [default: <literal>lcd</literal>; legal: <literal>lcd</literal>,
@@ -277,8 +270,8 @@ Slightly modified in order to include it in this document March 2002, Rene Wagne
<varlistentry>
<term>
<command>Contrast</command> =
<arg choice="plain"><replaceable>CONTRAST</replaceable></arg>
<property>Contrast</property> =
<parameter><replaceable>CONTRAST</replaceable></parameter>
</term>
<listitem><para>
Set the initial contrast.
@@ -294,13 +287,7 @@ Slightly modified in order to include it in this document March 2002, Rene Wagne
<varlistentry>
<term>
<command>hasAdjustableBacklight</command> =
<arg choice="plain">
<group choice="req">
<arg choice="plain"><literal><emphasis>yes</emphasis></literal></arg>
<arg choice="plain"><literal>no</literal></arg>
</group>
</arg>
<property>hasAdjustableBacklight</property> = &parameters.yesdefno;
</term>
<listitem><para>
Some old firmware versions of Matrix Orbital modules do not support an
@@ -313,8 +300,8 @@ Slightly modified in order to include it in this document March 2002, Rene Wagne
<varlistentry>
<term>
<command>Brightness</command> =
<arg choice="plain"><replaceable>BRIGHTNESS</replaceable></arg>
<property>Brightness</property> =
<parameter><replaceable>BRIGHTNESS</replaceable></parameter>
</term>
<listitem><para>
Set the initial brightness [default: <literal>1000</literal>; legal: <literal>0</literal> - <literal>1000</literal>]
@@ -323,8 +310,8 @@ Slightly modified in order to include it in this document March 2002, Rene Wagne
<varlistentry>
<term>
<command>OffBrightness</command> =
<arg choice="plain"><replaceable>BRIGHTNESS</replaceable></arg>
<property>OffBrightness</property> =
<parameter><replaceable>BRIGHTNESS</replaceable></parameter>
</term>
<listitem><para>
Set the initial off-brightness [default: <literal>0</literal>; legal: <literal>0</literal> - <literal>1000</literal>]
@@ -335,15 +322,13 @@ Slightly modified in order to include it in this document March 2002, Rene Wagne
<varlistentry>
<term>
<command>Speed</command> =
<arg choice="plain">
<group choice="req">
<arg choice="plain"><literal>1200</literal></arg>
<arg choice="plain"><literal>2400</literal></arg>
<arg choice="plain"><literal>9600</literal></arg>
<arg choice="plain"><literal><emphasis>19200</emphasis></literal></arg>
</group>
</arg>
<property>Speed</property> =
{
<parameter><literal>1200</literal></parameter> |
<parameter><literal>2400</literal></parameter> |
<parameter><literal>9600</literal></parameter> |
<emphasis><parameter><literal>19200</literal></parameter></emphasis>
}
</term>
<listitem><para>
Set the the baud rate to use when communicating with the LCD.
@@ -353,8 +338,8 @@ Slightly modified in order to include it in this document March 2002, Rene Wagne
<varlistentry>
<term>
<command>KeyMap_<replaceable>LETTER</replaceable></command> =
<arg choice="plain"><replaceable>KEY</replaceable></arg>
<property>KeyMap_<replaceable>LETTER</replaceable></property> =
<parameter><replaceable>KEY</replaceable></parameter>
</term>
<listitem>
<para>
@@ -365,7 +350,7 @@ Slightly modified in order to include it in this document March 2002, Rene Wagne
<para>
These settings allow to map the letter <replaceable>LETTER</replaceable>,
that is generated by the display when a key is pressed, to be mapped to
a key name <replaceable>KEY</replaceable> that <command>LCDd</command>
a key name <replaceable>KEY</replaceable> that <property>LCDd</property>
can understand (see <link linkend="menu-section" endterm="menu-section.title"/>
for more information).
</para>
@@ -384,55 +369,13 @@ Slightly modified in order to include it in this document March 2002, Rene Wagne
KeyMap_E=Enter
KeyMap_F=Escape
</programlisting>
</example>
</example>
</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>
<property>keypad_test_mode</property> = &parameters.yesnodef;
</term>
<listitem><para>
You can find out which key of your display sends which
docs/lcdproc-user/drivers/mx5000.docbook
+4 -4
View File
@@ -24,8 +24,8 @@ This drivers uses the library from mx5000tools.
<variablelist>
<varlistentry>
<term>
<command>Device</command> =
<arg choice="plain"><replaceable>DEVICE</replaceable></arg>
<property>Device</property> =
<parameter><replaceable>DEVICE</replaceable></parameter>
</term>
<listitem><para>
Select the output device to use [default: <filename>/dev/hiddev0</filename>]
@@ -34,8 +34,8 @@ This drivers uses the library from mx5000tools.
<varlistentry>
<term>
<command>WaitAfterRefresh</command> =
<arg choice="plain"><replaceable>MS</replaceable></arg>
<property>WaitAfterRefresh</property> =
<parameter><replaceable>MS</replaceable></parameter>
</term>
<listitem><para>
Set the time (in ms) to wait after each screen sent to the keyboard.
docs/lcdproc-user/drivers/picolcd.docbook
+68 -118
View File
@@ -45,7 +45,7 @@
<para>
When pre-installed in enclosures like the
<ulink url="http://www.mini-box.com/Mini-Box-M300-LCD">Mini-Box M300 LCD</ulink>
it comes equipped with an InfraRed receiver as well as key pad with
it comes equipped with an InfraRed receiver as well as key pad with
12 keys labeled <literal>Plus</literal>, <literal>Minus</literal>,
<literal>F1</literal>, <literal>F2</literal>, <literal>F3</literal>,
<literal>F4</literal>, <literal>F5</literal>, <literal>Up</literal>,
@@ -57,7 +57,7 @@
Finally, the picoLCD 20x2 (OEM) supports 8 general purpose outputs
and 10 custom splash screens.
Although these features are not supported by this driver, the
splash screens can be changed using the <command>usblcd</command>
splash screens can be changed using the <command>usblcd</command>
tool, that can be built from the Linux SDK available on the picoLCD web page.
</para>
</listitem>
@@ -110,58 +110,44 @@
<title>[picolcd]</title>
<variablelist>
<!--
<varlistentry>
<term>
<command>Backlight</command> =
<arg choice="plain">
<group choice="req">
<arg choice="plain"><literal><emphasis>yes</emphasis></literal></arg>
<arg choice="plain"><literal>no</literal></arg>
</group>
</arg>
<property>Backlight</property> = &parameters.yesdefno;
</term>
<listitem><para>
Turn on backlight.
Turns the backlight on or off, default <literal>yes</literal>.
</para></listitem>
</varlistentry>
-->
<varlistentry>
<term>
<command>Brightness</command> =
<arg choice="plain"><replaceable>BRIGHTNESS</replaceable></arg>
<property>Brightness</property> =
<parameter><replaceable>BRIGHTNESS</replaceable></parameter>
</term>
<listitem>
<para>
Set the initial brightness.
Legal values are: <literal>0</literal> - <literal>1000</literal>.
If not given, it defaults to <literal><emphasis>1000</emphasis></literal>.
If not given, it defaults to <literal>1000</literal>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<command>Contrast</command> =
<arg choice="plain"><replaceable>CONTRAST</replaceable></arg>
<property>Contrast</property> =
<parameter><replaceable>CONTRAST</replaceable></parameter>
</term>
<listitem><para>
Contrast: <literal>0</literal>-<literal>1000</literal>.
<literal>0</literal> is visible, and <literal>1000</literal> is not on my M300.
Default is <literal><emphasis>1000</emphasis></literal>.
Default is <literal>1000</literal>.
</para></listitem>
</varlistentry>
<varlistentry>
<term>
<command>KeyLights</command> =
<arg choice="plain">
<group choice="req">
<arg choice="plain"><literal><emphasis>yes</emphasis></literal></arg>
<arg choice="plain"><literal>no</literal></arg>
</group>
</arg>
<property>KeyLights</property> = &parameters.yesdefno;
</term>
<listitem><para>
Allow key LEDs to be turned on or off. Default is <literal>yes</literal>.
@@ -170,118 +156,82 @@
<varlistentry>
<term>
<command>Key0Light</command> =
<arg choice="plain">
<group choice="req">
<arg choice="plain"><literal><emphasis>yes</emphasis></literal></arg>
<arg choice="plain"><literal>no</literal></arg>
</group>
</arg>
<property>Key0Light</property> = &parameters.yesdefno;
</term>
<listitem><para>
If <command>Keylights</command> is set, you can disable the directional pad LED by
If <property>Keylights</property> is set, you can disable the directional pad LED by
setting this value to <literal>no</literal>. Default is <literal>yes</literal>.
</para></listitem>
</varlistentry>
<varlistentry>
<term>
<command>Key1Light</command> =
<arg choice="plain">
<group choice="req">
<arg choice="plain"><literal><emphasis>yes</emphasis></literal></arg>
<arg choice="plain"><literal>no</literal></arg>
</group>
</arg>
<property>Key1Light</property> = &parameters.yesdefno;
</term>
<listitem><para>
If <command>Keylights</command> is set, you can disable the F1 LED by setting this value
If <property>Keylights</property> is set, you can disable the F1 LED by setting this value
to <literal>no</literal>. Default is <literal>yes</literal>.
</para></listitem>
</varlistentry>
<varlistentry>
<term>
<command>Key2Light</command> =
<arg choice="plain">
<group choice="req">
<arg choice="plain"><literal><emphasis>yes</emphasis></literal></arg>
<arg choice="plain"><literal>no</literal></arg>
</group>
</arg>
<property>Key2Light</property> = &parameters.yesdefno;
</term>
<listitem><para>
If <command>Keylights</command> is set, you can disable the F2 LED by setting this value
If <property>Keylights</property> is set, you can disable the F2 LED by setting this value
to <literal>no</literal>. Default is <literal>yes</literal>.
</para></listitem>
</varlistentry>
<varlistentry>
<term>
<command>Key3Light</command> =
<arg choice="plain">
<group choice="req">
<arg choice="plain"><literal><emphasis>yes</emphasis></literal></arg>
<arg choice="plain"><literal>no</literal></arg>
</group>
</arg>
<property>Key3Light</property> = &parameters.yesdefno;
</term>
<listitem><para>
If <command>Keylights</command> is set, you can disable the F3 LED by setting this value
If <property>Keylights</property> is set, you can disable the F3 LED by setting this value
to <literal>no</literal>. Default is <literal>yes</literal>.
</para></listitem>
</varlistentry>
<varlistentry>
<term>
<command>Key4Light</command> =
<arg choice="plain">
<group choice="req">
<arg choice="plain"><literal><emphasis>yes</emphasis></literal></arg>
<arg choice="plain"><literal>no</literal></arg>
</group>
</arg>
<property>Key4Light</property> = &parameters.yesdefno;
</term>
<listitem><para>
If <command>Keylights</command> is set, you can disable the F4 LED by setting this value
If <property>Keylights</property> is set, you can disable the F4 LED by setting this value
to <literal>no</literal>. Default is <literal>yes</literal>.
</para></listitem>
</varlistentry>
<varlistentry>
<term>
<command>Key5Light</command> =
<arg choice="plain">
<group choice="req">
<arg choice="plain"><literal><emphasis>yes</emphasis></literal></arg>
<arg choice="plain"><literal>no</literal></arg>
</group>
</arg>
<property>Key5Light</property> = &parameters.yesdefno;
</term>
<listitem><para>
If <command>Keylights</command> is set, you can disable the F5 LED by setting this value
If <property>Keylights</property> is set, you can disable the F5 LED by setting this value
to <literal>no</literal>. Default is <literal>yes</literal>.
</para></listitem>
</varlistentry>
<varlistentry>
<term>
<command>KeyTimeout</command> =
<arg choice="plain"><replaceable>DURATION</replaceable></arg>
<property>KeyTimeout</property> =
<parameter><replaceable>DURATION</replaceable></parameter>
</term>
<listitem><para>
(Advanced) This value controls how long <application>LCDd</application> waits for a key press when
(Advanced) This value controls how long <application>LCDd</application> waits for a key press when
get_key() is called. The value represents microseconds and the default is <literal>500</literal>
or .5 seconds. Lowering this value will make LCDd more responsive but also causes LCDd to use
more CPU time and, as the timeout grows shorter, key presses become harder to detect.
Larger values make key presses more reliable if somewhat slow to take effect.
or .5 seconds. Lowering this value will make LCDd more responsive but also causes LCDd to use
more CPU time and, as the timeout grows shorter, key presses become harder to detect.
Lparameterer values make key presses more reliable if somewhat slow to take effect.
</para></listitem>
</varlistentry>
<varlistentry>
<term>
<command>LircHost</command> =
<arg choice="plain"><replaceable>HOSTNAME_OR_IP-ADDRESS</replaceable></arg>
<property>LircHost</property> =
<parameter><replaceable>HOSTNAME_OR_IP-ADDRESS</replaceable></parameter>
</term>
<listitem>
<para>
@@ -289,53 +239,53 @@
If not set or set to an empty value, IR support for LIRC will be disabled.
</para>
<para>
LIRC should be configured to use the driver "udp", which will cause it to listen on some
UDP port for packets containing a series of integers, representing pulse and mark
intervals from the sensor. It doesn't matter whether LCDd or LIRC is started first; if LIRC
isn't listening, the packets from LCDd will be discarded. When LIRC comes back, it will
start picking up the packets. Similarly, LCDd can be stopped and restarted without affecting
anything, because UDP is a connectionless protocol.
LIRC should be configured to use the driver "udp", which will cause it to listen on some
UDP port for packets containing a series of integers, representing pulse and mark
intervals from the sensor. It doesn't matter whether LCDd or LIRC is started first; if LIRC
isn't listening, the packets from LCDd will be discarded. When LIRC comes back, it will
start picking up the packets. Similarly, LCDd can be stopped and restarted without affecting
anything, because UDP is a connectionless protocol.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<command>LircPort</command> =
<arg choice="plain"><replaceable>PORTNUM</replaceable></arg>
<property>LircPort</property> =
<parameter><replaceable>PORTNUM</replaceable></parameter>
</term>
<listitem>
<para>
This value determines the UDP port to which the driver will send IR data from the sensor. It
defaults to <literal>8765</literal>, which is also the default port on which LIRC will listen.
defaults to <literal>8765</literal>, which is also the default port on which LIRC will listen.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<command>LircSync</command> =
<arg choice="plain"><replaceable>DURATION</replaceable></arg>
<property>LircSync</property> =
<parameter><replaceable>DURATION</replaceable></parameter>
</term>
<listitem>
<para>
This value determines the length in jiffies (1/16384 seconds) of the synthesized sync pulse added
to the beginning of the UDP packet sent to LIRC. Values up to 255 are permitted. Setting a length
of zero will suppress the synthesized pulse (I can't make it work without it, though). The default is
<literal>64</literal> jiffies (3.9ms).
This value determines the length in jiffies (1/16384 seconds) of the synthesized sync pulse added
to the beginning of the UDP packet sent to LIRC. Values up to 255 are permitted. Setting a length
of zero will suppress the synthesized pulse (I can't make it work without it, though). The default is
<literal>64</literal> jiffies (3.9ms).
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<command>LircLength</command> =
<arg choice="plain"><replaceable>DURATION</replaceable></arg>
<property>LircLength</property> =
<parameter><replaceable>DURATION</replaceable></parameter>
</term>
<listitem>
<para>
This value determines the length in jiffies (1/16384 seconds) of the entire LIRC code for a single remote
command. It depends on the notion that all commands are of the same duration, and are padded with a trailing
This value determines the length in jiffies (1/16384 seconds) of the entire LIRC code for a single remote
property. It depends on the notion that all propertys are of the same duration, and are padded with a trailing
gap (space) to make up the time. No such gap is emitted by the picolcd hardware. Values up to MAXINT are permitted.
Setting a length of zero will suppress the synthesized gap. The default is 2048 jiffies (125ms).
</para>
@@ -351,13 +301,13 @@
<title>picolcd driver status</title>
<para>
The hardware also reports key-up events. Normally this would be of no issue (they are
usually a 0 or 'no key') except that when keys are used in combonation, the key-up
event may actually come back as multiple events depending on how the user released the
keys. If the key-up event for a multiple key press comes back as two events, the first
up event will actually look like a new key press. The algorithm in get_key tries to
deal with this in a sane way and toss out all key-up events for now. The hardware is
touchy and both combo key-down and key-up actions may be reported as mutiple events if
The hardware also reports key-up events. Normally this would be of no issue (they are
usually a 0 or 'no key') except that when keys are used in combonation, the key-up
event may actually come back as multiple events depending on how the user released the
keys. If the key-up event for a multiple key press comes back as two events, the first
up event will actually look like a new key press. The algorithm in get_key tries to
deal with this in a sane way and toss out all key-up events for now. The hardware is
touchy and both combo key-down and key-up actions may be reported as mutiple events if
the user is more than a tenth of a second (maybe less?) off in motions.
</para>
@@ -365,20 +315,20 @@
<title>Infrared sensor status</title>
<para>
LIRC expects sensor data that starts with a longish 'sync' space, denoting the start of
a command; followed by the code data, a sequence of mark/space pairs; sometimes followed by
a 'gap', which should be a space long enough to make the entire command up to a preset
duration in milliseconds. The 'sync' and the 'gap' are absent from the data
emitted by the picolcd hardware. I found that LIRC configuration files for remotes similar to the
ones I tested all used such a fixed-duration encoding, and as that was the only way I could get it
working, this driver by default adds the gap as well as the sync. However I have
<emphasis>still</emphasis> had trouble getting <code>irrecord</code> to work; you need at least
to feed it a template configuration containing sync and gap data.
LIRC expects sensor data that starts with a longish 'sync' space, denoting the start of
a command; followed by the code data, a sequence of mark/space pairs; sometimes followed by
a 'gap', which should be a space long enough to make the entire command up to a preset
duration in milliseconds. The 'sync' and the 'gap' are absent from the data
emitted by the picolcd hardware. I found that LIRC configuration files for remotes similar to the
ones I tested all used such a fixed-duration encoding, and as that was the only way I could get it
working, this driver by default adds the gap as well as the sync. However I have
<emphasis>still</emphasis> had trouble getting <code>irrecord</code> to work; you need at least
to feed it a template configuration containing sync and gap data.
</para>
<para>
This code could therefore use more testing, more research, and more work.
</para>
</para>
</sect3>
</sect2>
@@ -388,7 +338,7 @@
<title>Copyright</title>
<para>
The lcdproc picolcd driver originally was written by Gatewood Green (woody@nitrosecurity.com)
The lcdproc picolcd driver originally was written by Gatewood Green (woody@nitrosecurity.com)
or (woody@linif.org) and paid for by NitroSecurity, Inc (nitrosecurity.com),
but has been extended with code from various contributors since then.
</para>
docs/lcdproc-user/drivers/pylcd.docbook
+6 -6
View File
@@ -23,7 +23,7 @@ to show system data, and to allow the user to change important parameters or
shut down the appliance in a controlled manner.
The LCD module, accessible via USB, can be integrated by Pyramid's BTO server
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.
made available separately for self-integration, e.g. as a 5.25" module.
</para>
@@ -42,7 +42,7 @@ buttons as well as 3 (or 9) LEDs which can also be software controlled.
<title>Connector</title>
<para>
The display is connected to the host system using USB, with the
The display is connected to the host system using USB, with the
usual USB pinout as shown below.
The +5V V<subscript>CC</subscript> pin is marked with red colour.
</para>
@@ -79,7 +79,7 @@ The +5V V<subscript>CC</subscript> pin is marked with red colour.
For Linux the driver depends on features of the <filename>ftdi_sio.ko</filename>
that have only been added to version 2.6.15 version of the 2.6 kernel series.
For older Linux kernels of the 2.6 series these patches to
<filename>ftdi_sio.c</filename> may help:
<filename>ftdi_sio.c</filename> may help:
</para>
<itemizedlist>
@@ -105,7 +105,7 @@ For older Linux kernels of the 2.6 series these patches to
<para>
I've added support for the LEDs on the Pyramid LC-Display to the
"pyramid" driver of lcdproc.
"pyramid" driver of lcdproc.
</para>
<para>
@@ -208,8 +208,8 @@ More information on the Pyramid LC-Display can be found here:
<variablelist>
<varlistentry>
<term>
<command>Device</command> =
<arg choice="plain"><replaceable>DEVICE</replaceable></arg>
<property>Device</property> =
<parameter><replaceable>DEVICE</replaceable></parameter>
</term>
<listitem><para>
Device to connect to. Default: <filename>/dev/lcd</filename>
docs/lcdproc-user/drivers/sed1330.docbook
+18 -27
View File
@@ -513,31 +513,24 @@ use the following circuit.
<variablelist>
<varlistentry>
<term>
<command>CellSize</command> =
<arg choice="plain">
<replaceable>WIDTH</replaceable>
<literal>x</literal>
<replaceable>HEIGHT</replaceable>
</arg>
<property>CellSize</property> = &parameters.size;
</term>
<listitem><para>
Specify the size of a character in pixels.
<replaceable>WIDTH</replaceable> may vary between <literal>6</literal> and <literal>8</literal>;
legal values for <replaceable>HEIGHT</replaceable> range from <literal>7</literal> to
<literal>16</literal>.
If not given <command>CellSize</command> defaults to <literal>6x10</literal>.
If not given <property>CellSize</property> defaults to <literal>6x10</literal>.
</para></listitem>
</varlistentry>
<varlistentry>
<term>
<command>ConnectionType</command> =
<arg choice="plain">
<group choice="req">
<arg choice="plain"><literal><emphasis>classic</emphasis></literal></arg>
<arg choice="plain"><literal>bitshaker</literal></arg>
</group>
</arg>
<property>ConnectionType</property> =
{
<emphasis><parameter><literal>classic</literal></parameter></emphasis> |
<parameter><literal>bitshaker</literal></parameter>
}
</term>
<listitem>
<para>
@@ -573,8 +566,8 @@ use the following circuit.
<varlistentry>
<term>
<command>Port</command> =
<arg choice="plain"><replaceable>PORT</replaceable></arg>
<property>Port</property> =
<parameter><replaceable>PORT</replaceable></parameter>
</term>
<listitem><para>
Specify the address of the parallel port the LCD is connected to.
@@ -586,17 +579,15 @@ use the following circuit.
<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>
<arg choice="plain"><literal>SP14Q002</literal></arg>
</group>
</arg>
<property>Type</property> =
{
<parameter><literal>G321D</literal></parameter> |
<parameter><literal>G121C</literal></parameter> |
<parameter><literal>G242C</literal></parameter> |
<parameter><literal>G191D</literal></parameter> |
<parameter><literal>G2446</literal></parameter> |
<parameter><literal>SP14Q002</literal></parameter>
}
</term>
<listitem>
<para>
docs/lcdproc-user/drivers/sed1520.docbook
+2 -2
View File
@@ -16,8 +16,8 @@ sed1520 chipset.
<variablelist>
<varlistentry>
<term>
<command>Port</command> =
<arg choice="plain"><replaceable>PORT</replaceable></arg>
<property>Port</property> =
<parameter><replaceable>PORT</replaceable></parameter>
</term>
<listitem><para>
Specify the address of the parallel port the LCD is connected to.
docs/lcdproc-user/drivers/serialPOS.docbook
+25 -34
View File
@@ -6,13 +6,13 @@ This section talks about using LCDproc with a point of sale ("POS") character-di
</para>
<para>
The <code>serialPOS</code> driver is currently working with the AEDEX emulation protocol,
and may support Epson ESC/POS and Logic Controls. It can be extended to work with various
The <code>serialPOS</code> driver is currently working with the AEDEX emulation protocol,
and may support Epson ESC/POS and Logic Controls. It can be extended to work with various
other protocol displays.
</para>
<para>
The driver should operate most character POS displays with a serial (RS-232) input.
The driver should operate most character POS displays with a serial (RS-232) input.
Because these displays use a standardized protocol, if the protocol is
supported by your display, it should work as expected.
Feedback is welcome.
@@ -83,7 +83,7 @@ Feedback is welcome.
<para>
Connecting the display should consist of simply plugging it into your computer's
RS-232 serial port. Because these displays typically support full RS-232, no additional
RS-232 serial port. Because these displays typically support full RS-232, no additional
wiring is needed. If your computer does not have such a port (many newer computers don't),
you can use a USB to serial adapter with a driver provided by the adapter manufacturer.
</para>
@@ -118,8 +118,8 @@ arrow, delete, and return keys by default.
<varlistentry>
<term>
<command>Device</command> =
<arg choice="plain"><replaceable>DEVICE</replaceable></arg>
<property>Device</property> =
<parameter><replaceable>DEVICE</replaceable></parameter>
</term>
<listitem><para>
Device to use in serial mode. Usual values are <filename>/dev/ttyS0</filename> or
@@ -129,12 +129,7 @@ arrow, delete, and return keys by default.
<varlistentry>
<term>
<command>Size</command> =
<arg choice="plain">
<replaceable>WIDTH</replaceable>
<literal>x</literal>
<replaceable>HEIGHT</replaceable>
</arg>
<property>Size</property> = &parameters.size;
</term>
<listitem><para>
Specifies the size of the VFD in characters.
@@ -144,18 +139,16 @@ arrow, delete, and return keys by default.
<varlistentry>
<term>
<command>Type</command> =
<arg choice="plain">
<group choice="req">
<arg choice="plain"><literal>IEE</literal></arg>
<arg choice="plain"><literal><emphasis>AEDEX</emphasis></literal></arg>
<arg choice="plain"><literal>Epson</literal></arg>
<arg choice="plain"><literal>Emax</literal></arg>
<arg choice="plain"><literal>IBM</literal></arg>
<arg choice="plain"><literal>LogicControls</literal></arg>
<arg choice="plain"><literal>Ultimate</literal></arg>
</group>
</arg>
<property>Type</property> =
{
<parameter><literal>IEE</literal></parameter> |
<emphasis><parameter><literal>AEDEX</literal></parameter></emphasis> |
<parameter><literal>Epson</literal></parameter> |
<parameter><literal>Emax</literal></parameter> |
<parameter><literal>IBM</literal></parameter> |
<parameter><literal>LogicControls</literal></parameter> |
<parameter><literal>Ultimate</literal></parameter>
}
</term>
<listitem><para>
Set the communication protocol to use with the POS display.
@@ -166,16 +159,14 @@ arrow, delete, and return keys by default.
<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>
<property>Speed</property> =
{
<parameter><literal>1200</literal></parameter> |
<parameter><literal>2400</literal></parameter> |
<emphasis><parameter><literal>9600</literal></parameter></emphasis> |
<parameter><literal>19200</literal></parameter> |
<parameter><literal>115200</literal></parameter>
}
</term>
<listitem><para>
Set the the baud rate communication with the POS display.
docs/lcdproc-user/drivers/serialVFD.docbook
+30 -49
View File
@@ -186,7 +186,7 @@ If your display isn't working 100% satisfactorily you can add a new device with
commands to the driver if you want. To do that you have to add a new section to the display
<command>Type</command>-switch-case in <filename>./server/drivers/serialVFD-displays.c</filename>
and to write a new "load" function with the correct commands for the display.
(Try which display <command>Type</command> works best with your display,
(Try which display <command>Type</command> works best with your display,
then copy, rename and modify this function to your needs - that is the easiest way I guess.)
</para>
@@ -339,7 +339,7 @@ It must be connected directly with the serial port.</para>
<screen><![CDATA[Suggested Jumper Setting:
JP1 open, JP2 open, JP3 closed, JP4 open, JP5 open]]></screen>
<para>More detailed information can be found in the users manual of
<para>More detailed information can be found in the users manual of
the display.</para>
</sect4>
@@ -433,13 +433,7 @@ optional
<varlistentry>
<term>
<command>use_parallel</command> =
<arg choice="plain">
<group choice="req">
<arg choice="plain"><literal><emphasis>yes</emphasis></literal></arg>
<arg choice="plain"><literal>no</literal></arg>
</group>
</arg>
<property>use_parallel</property> = &parameters.yesdefno;
</term>
<listitem><para>
"<literal>no</literal>" if display connected serial, "<literal>yes</literal>" if connected parallel [default: <literal>no</literal>(serial)].
@@ -448,8 +442,8 @@ optional
<varlistentry>
<term>
<command>Port</command> =
<arg choice="plain"><replaceable>PORT</replaceable></arg>
<property>Port</property> =
<parameter><replaceable>PORT</replaceable></parameter>
</term>
<listitem><para>
Portaddress where the LPT is. Used in parallelmode only. Usual values are 0x278, 0x378 and 0x3BC [default: <literal>0x278</literal>].
@@ -458,18 +452,18 @@ optional
<varlistentry>
<term>
<command>PortWait</command> =
<arg choice="plain"><replaceable>DELAY</replaceable></arg>
<property>PortWait</property> =
<parameter><replaceable>DELAY</replaceable></parameter>
</term>
<listitem><para>
Set parallel port timingdelay (us). Used in parallelmode only. [default: <literal>2</literal>; legal: 0 - 255].
Set parallel port timingdelay (us). Used in parallel mode only. [default: <literal>2</literal>; legal: 0 - 255].
</para></listitem>
</varlistentry>
<varlistentry>
<term>
<command>Device</command> =
<arg choice="plain"><replaceable>DEVICE</replaceable></arg>
<property>Device</property> =
<parameter><replaceable>DEVICE</replaceable></parameter>
</term>
<listitem><para>
Device to use in serial mode. Usual values are <filename>/dev/ttyS0</filename> and <filename>/dev/ttyS1</filename>
@@ -479,22 +473,17 @@ optional
<varlistentry>
<term>
<command>Custom-Characters</command> =
<arg choice="plain"><replaceable>CUSTOM-CHARACTERS</replaceable></arg>
<property>Custom-Characters</property> =
<parameter><replaceable>CUSTOM-CHARACTERS</replaceable></parameter>
</term>
<listitem><para>
Number of Custom-Characters [default: Display-<command>Type</command> dependent].
Number of Custom-Characters [default: Display-<property>Type</property> dependent].
</para></listitem>
</varlistentry>
<varlistentry>
<term>
<command>Size</command> =
<arg choice="plain">
<replaceable>WIDTH</replaceable>
<literal>x</literal>
<replaceable>HEIGHT</replaceable>
</arg>
<property>Size</property> = &parameters.size;
</term>
<listitem><para>
Specifies the size of the VFD.
@@ -504,8 +493,8 @@ Number of Custom-Characters [default: Display-<command>Type</command> dependent]
<varlistentry>
<term>
<command>Type</command> =
<arg choice="plain"><replaceable>CODE</replaceable></arg>
<property>Type</property> =
<parameter><replaceable>CODE</replaceable></parameter>
</term>
<listitem>
<para>
@@ -522,7 +511,7 @@ Number of Custom-Characters [default: Display-<command>Type</command> dependent]
</thead>
<tbody>
<row>
<entry><literal><emphasis>0</emphasis></literal></entry>
<entry><emphasis><literal>0</literal></emphasis></entry>
<entry>NEC (FIPC8367 based) VFDs</entry>
</row>
<row>
@@ -568,8 +557,8 @@ Number of Custom-Characters [default: Display-<command>Type</command> dependent]
<varlistentry>
<term>
<command>Brightness</command> =
<arg choice="plain"><replaceable>BRIGHTNESS</replaceable></arg>
<property>Brightness</property> =
<parameter><replaceable>BRIGHTNESS</replaceable></parameter>
</term>
<listitem><para>
Set the initial brightness [default: 1000; legal: 0 - 1000]
@@ -579,8 +568,8 @@ Set the initial brightness [default: 1000; legal: 0 - 1000]
<varlistentry>
<term>
<command>OffBrightness</command> =
<arg choice="plain"><replaceable>OFFBRIGHTNESS</replaceable></arg>
<property>OffBrightness</property> =
<parameter><replaceable>OFFBRIGHTNESS</replaceable></parameter>
</term>
<listitem><para>
Set the initial off-brightness [default: 0; legal: 0 - 1000].
@@ -592,16 +581,14 @@ Set the initial off-brightness [default: 0; legal: 0 - 1000].
<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>
<property>Speed</property> =
{
<parameter><literal>1200</literal></parameter> |
<parameter><literal>2400</literal></parameter> |
<emphasis><parameter><literal>9600</literal></parameter></emphasis> |
<parameter><literal>19200</literal></parameter> |
<parameter><literal>115200</literal></parameter>
}
</term>
<listitem><para>
Set the the baud rate communication with the VFD.
@@ -611,13 +598,7 @@ Set the initial off-brightness [default: 0; legal: 0 - 1000].
<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>
<property>ISO_8859_1</property> = &parameters.yesdefno;
</term>
<listitem><para>
Enable ISO-8859-1 compatibility [default is <literal>yes</literal>].
docs/lcdproc-user/drivers/sli.docbook
+12 -14
View File
@@ -16,8 +16,8 @@ sli chipset.
<variablelist>
<varlistentry>
<term>
<command>Device</command> =
<arg choice="plain"><replaceable>DEVICE</replaceable></arg>
<property>Device</property> =
<parameter><replaceable>DEVICE</replaceable></parameter>
</term>
<listitem><para>
Select the output device to use [default: <filename>/dev/lcd</filename>]
@@ -26,18 +26,16 @@ sli chipset.
<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>
<property>Speed</property> =
{
<parameter><literal>1200</literal></parameter> |
<parameter><literal>2400</literal></parameter> |
<parameter><literal>9600</literal></parameter> |
<emphasis><parameter><literal>19200</literal></parameter></emphasis> |
<parameter><literal>38400</literal></parameter> |
<parameter><literal>57600</literal></parameter> |
<parameter><literal>115200</literal></parameter>
}
</term>
<listitem><para>
Set the the baud rate communication with the LCD.
docs/lcdproc-user/drivers/stv5730.docbook
+2 -2
View File
@@ -16,8 +16,8 @@ stv5730 chipset.
<variablelist>
<varlistentry>
<term>
<command>Port</command> =
<arg choice="plain"><replaceable>PORT</replaceable></arg>
<property>Port</property> =
<parameter><replaceable>PORT</replaceable></parameter>
</term>
<listitem><para>
Specify the address of the parallel port the LCD is connected to.
docs/lcdproc-user/drivers/svga.docbook
+9 -14
View File
@@ -16,8 +16,8 @@ svga chipset.
<variablelist>
<varlistentry>
<term>
<command>Mode</command> =
<arg choice="plain"><replaceable>SCGALIB-MODE</replaceable></arg>
<property>Mode</property> =
<parameter><replaceable>SCGALIB-MODE</replaceable></parameter>
</term>
<listitem><para>
svgalib mode to use [default: <literal>G320x240x256</literal>]
@@ -29,12 +29,7 @@ svga chipset.
<varlistentry>
<term>
<command>Size</command> =
<arg choice="plain">
<replaceable>WIDTH</replaceable>
<literal>x</literal>
<replaceable>HEIGHT</replaceable>
</arg>
<property>Size</property> = &parameters.size;
</term>
<listitem><para>
set display size [default: <literal>20x4</literal>]
@@ -43,8 +38,8 @@ svga chipset.
<varlistentry>
<term>
<command>Contrast</command> =
<arg choice="plain"><replaceable>CONTRAST</replaceable></arg>
<property>Contrast</property> =
<parameter><replaceable>CONTRAST</replaceable></parameter>
</term>
<listitem><para>
Set the initial contrast.
@@ -59,8 +54,8 @@ svga chipset.
<varlistentry>
<term>
<command>Brightness</command> =
<arg choice="plain"><replaceable>BRIGHTNESS</replaceable></arg>
<property>Brightness</property> =
<parameter><replaceable>BRIGHTNESS</replaceable></parameter>
</term>
<listitem><para>
Set the initial brightness [default: <literal>1000</literal>; legal: <literal>1</literal> - <literal>1000</literal>]
@@ -69,8 +64,8 @@ svga chipset.
<varlistentry>
<term>
<command>OffBrightness</command> =
<arg choice="plain"><replaceable>BRIGHTNESS</replaceable></arg>
<property>OffBrightness</property> =
<parameter><replaceable>BRIGHTNESS</replaceable></parameter>
</term>
<listitem><para>
Set the initial off-brightness [default: <literal>500</literal>; legal: <literal>1</literal> - <literal>1000</literal>]
docs/lcdproc-user/drivers/t6963.docbook
+7 -24
View File
@@ -2,8 +2,8 @@
<title>The Toshiba T6963 Driver</title>
<para>
This section talks about using LCDproc with LCD displays that use the
T6963 chipset from Toshiba. Usually, this chipset is used on big character LCD
This section talks about using LCDproc with LCD displays that use the
T6963 chipset from Toshiba. Usually, this chipset is used on big character LCD
displays that can often act as a screen.
</para>
@@ -75,12 +75,7 @@ can be done by specifying "--enable-drivers=all" or by
<variablelist>
<varlistentry>
<term>
<command>Size</command> =
<arg choice="plain">
<replaceable>WIDTH</replaceable>
<literal>x</literal>
<replaceable>HEIGHT</replaceable>
</arg>
<property>Size</property> = &parameters.size;
</term>
<listitem><para>
set display size [default: <literal>20x6</literal>]
@@ -89,8 +84,8 @@ can be done by specifying "--enable-drivers=all" or by
<varlistentry>
<term>
<command>Port</command> =
<arg choice="plain"><replaceable>PORT</replaceable></arg>
<property>Port</property> =
<parameter><replaceable>PORT</replaceable></parameter>
</term>
<listitem><para>
Specify the address of the parallel port the LCD is connected to.
@@ -103,13 +98,7 @@ can be done by specifying "--enable-drivers=all" or by
<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>
<property>ECPlpt</property> = &parameters.yesdefno;
</term>
<listitem><para>
Is ECP mode on? [default: <literal>yes</literal>; legal: <literal>yes</literal>, <literal>no</literal>]
@@ -118,13 +107,7 @@ can be done by specifying "--enable-drivers=all" or by
<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>
<property>graphic</property> = &parameters.yesnodef;
</term>
<listitem><para>
Use graphic? [default: <literal>no</literal>; legal: <literal>yes</literal>, <literal>no</literal>]
docs/lcdproc-user/drivers/text.docbook
+1 -6
View File
@@ -16,12 +16,7 @@ text chipset.
<variablelist>
<varlistentry>
<term>
<command>Size</command> =
<arg choice="plain">
<replaceable>WIDTH</replaceable>
<literal>x</literal>
<replaceable>HEIGHT</replaceable>
</arg>
<property>Size</property> = &parameters.size;
</term>
<listitem><para>
Set the display size [default: <literal>20x4</literal>]
docs/lcdproc-user/drivers/tyan.docbook
+9 -16
View File
@@ -18,7 +18,7 @@ To the right of the display there is a 6 button keypad:
</para>
<para>
For more information see the
For more information see the
<ulink url="ftp://ftp.tyan.com/barebone_support/GS10-GS12%20LCD-Pack.zip">LCD pack</ulink>
from the Tyan support page.
Besides a useless old version of LCDproc it contains some
@@ -39,8 +39,8 @@ of the LCD display by its manufacturer.
<variablelist>
<varlistentry>
<term>
<command>Device</command> =
<arg choice="plain"><replaceable>DEVICE</replaceable></arg>
<property>Device</property> =
<parameter><replaceable>DEVICE</replaceable></parameter>
</term>
<listitem><para>
Select the output device to use [default: <filename>/dev/lcd</filename>]
@@ -49,13 +49,11 @@ of the LCD display by its manufacturer.
<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>
<property>Speed</property> =
{
<parameter><literal>4800</literal></parameter> |
<emphasis><parameter><literal>9600</literal></parameter></emphasis>
}
</term>
<listitem><para>
Set the the baud rate communication with the LCD.
@@ -65,12 +63,7 @@ of the LCD display by its manufacturer.
<varlistentry>
<term>
<command>Size</command> =
<arg choice="plain">
<replaceable>WIDTH</replaceable>
<literal>x</literal>
<replaceable>HEIGHT</replaceable>
</arg>
<property>Size</property> = &parameters.size;
</term>
<listitem><para>
set display size [default: <literal>16x2</literal>]
docs/lcdproc-user/drivers/ula200.docbook
+13 -18
View File
@@ -121,12 +121,7 @@ a standard character which looks good.
<variablelist>
<varlistentry>
<term>
<command>Size</command> =
<arg choice="plain">
<replaceable>WIDTH</replaceable>
<literal>x</literal>
<replaceable>HEIGHT</replaceable>
</arg>
<property>Size</property> = &parameters.size;
</term>
<listitem><para>
Select the LCD size [default: <literal>20x4</literal>]
@@ -135,28 +130,28 @@ a standard character which looks good.
<varlistentry>
<term>
<command>KeyMap_A</command> =
<arg choice="plain"><replaceable>KEY</replaceable></arg>
<property>KeyMap_A</property> =
<parameter><replaceable>KEY</replaceable></parameter>
</term>
<term>
<command>KeyMap_B</command> =
<arg choice="plain"><replaceable>KEY</replaceable></arg>
<property>KeyMap_B</property> =
<parameter><replaceable>KEY</replaceable></parameter>
</term>
<term>
<command>KeyMap_C</command> =
<arg choice="plain"><replaceable>KEY</replaceable></arg>
<property>KeyMap_C</property> =
<parameter><replaceable>KEY</replaceable></parameter>
</term>
<term>
<command>KeyMap_D</command> =
<arg choice="plain"><replaceable>KEY</replaceable></arg>
<property>KeyMap_D</property> =
<parameter><replaceable>KEY</replaceable></parameter>
</term>
<term>
<command>KeyMap_E</command> =
<arg choice="plain"><replaceable>KEY</replaceable></arg>
<property>KeyMap_E</property> =
<parameter><replaceable>KEY</replaceable></parameter>
</term>
<term>
<command>KeyMap_F</command> =
<arg choice="plain"><replaceable>KEY</replaceable></arg>
<property>KeyMap_F</property> =
<parameter><replaceable>KEY</replaceable></parameter>
</term>
<listitem><para>
If you have a non standard keypad you can associate any keystrings to keys.
docs/lcdproc-user/drivers/xosd.docbook
+14 -19
View File
@@ -22,12 +22,7 @@ on-screen display (OSD) used by most modern televisions and video-players.
<variablelist>
<varlistentry>
<term>
<command>Size</command> =
<arg choice="plain">
<replaceable>WIDTH</replaceable>
<literal>x</literal>
<replaceable>HEIGHT</replaceable>
</arg>
<property>Size</property> = &parameters.size;
</term>
<listitem><para>
set display size [default: <literal>20x4</literal>]
@@ -36,12 +31,12 @@ on-screen display (OSD) used by most modern televisions and video-players.
<varlistentry>
<term>
<command>Offset</command> =
<arg choice="plain">
<property>Offset</property> =
<parameter>
<replaceable>X-OFFSET</replaceable>
<literal>x</literal>
<replaceable>Y-OFFSET</replaceable>
</arg>
</parameter>
</term>
<listitem><para>
Offset (in pixels) of the top-left corner of <package>LCDproc</package>'s
@@ -52,18 +47,18 @@ on-screen display (OSD) used by most modern televisions and video-players.
<varlistentry>
<term>
<command>Font</command> =
<arg choice="plain"><replaceable>FONT</replaceable></arg>
<property>Font</property> =
<parameter><replaceable>FONT</replaceable></parameter>
</term>
<listitem>
<para>
X font to use, in XLFD (X Logical Font Description) format,
as given by the <command>xfontsel</command> command.
as given by the <property>xfontsel</property> property.
E.g. <literal>-*-terminus-*-r-*-*-*-320-*-*-*-*-*</literal>.
</para>
<para>
For best results it is recommended to use a mono-spaced font
to mimic the aspect of a physical LCD display that most
to mimic the aspect of a physical LCD display that most
clients expect with regard to their screen layouts.
</para>
</listitem>
@@ -71,8 +66,8 @@ on-screen display (OSD) used by most modern televisions and video-players.
<varlistentry>
<term>
<command>Contrast</command> =
<arg choice="plain"><replaceable>CONTRAST</replaceable></arg>
<property>Contrast</property> =
<parameter><replaceable>CONTRAST</replaceable></parameter>
</term>
<listitem><para>
Set the initial contrast.
@@ -87,8 +82,8 @@ on-screen display (OSD) used by most modern televisions and video-players.
<varlistentry>
<term>
<command>Brightness</command> =
<arg choice="plain"><replaceable>BRIGHTNESS</replaceable></arg>
<property>Brightness</property> =
<parameter><replaceable>BRIGHTNESS</replaceable></parameter>
</term>
<listitem><para>
Set the initial brightness [default: <literal>1000</literal>; legal: <literal>1</literal> - <literal>1000</literal>]
@@ -97,8 +92,8 @@ on-screen display (OSD) used by most modern televisions and video-players.
<varlistentry>
<term>
<command>OffBrightness</command> =
<arg choice="plain"><replaceable>BRIGHTNESS</replaceable></arg>
<property>OffBrightness</property> =
<parameter><replaceable>BRIGHTNESS</replaceable></parameter>
</term>
<listitem><para>
Set the initial off-brightness [default: <literal>500</literal>; legal: <literal>1</literal> - <literal>1000</literal>]
docs/lcdproc-user/lcdproc-user.docbook
+3 -1
View File
@@ -1,6 +1,7 @@
<?xml version='1.0'?>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!ENTITY % parameters SYSTEM "parameters.ent">
<!ENTITY bookinfo SYSTEM "bookinfo.docbook">
<!ENTITY introduction SYSTEM "introduction.docbook">
<!ENTITY how-to-obtain SYSTEM "how-to-obtain.docbook">
@@ -59,10 +60,11 @@
<!ENTITY tyan SYSTEM "drivers/tyan.docbook">
<!ENTITY ula200 SYSTEM "drivers/ula200.docbook">
<!ENTITY xosd SYSTEM "drivers/xosd.docbook">
%parameters;
]>
<book id="lcdproc-user" lang="en">
&bookinfo;
&introduction;
docs/lcdproc-user/parameters.ent
+21
View File
@@ -0,0 +1,21 @@
<!-- Entity for a yes/no parameters with yes as default value -->
<!ENTITY parameters.yesdefno "
{
<emphasis><parameter><literal>yes</literal></parameter></emphasis> |
<parameter><literal>no</literal></parameter>
}" >
<!-- Entity for a yes/no parameters with no as default value -->
<!ENTITY parameters.yesnodef "
{
<parameter><literal>yes</literal></parameter> |
<emphasis><parameter><literal>no</literal></parameter></emphasis>
}" >
<!-- Entity for a typical size parameter -->
<!ENTITY parameters.size "
<parameter>
<replaceable>WIDTH</replaceable>
<literal>x</literal>
<replaceable>HEIGHT</replaceable>
</parameter>" >
scripts/debian/patches/userguide_Makefile.diff
-23
View File
@@ -1,23 +0,0 @@
diff -ur lcdproc-0.5dev.orig/docs/lcdproc-user/Makefile.am lcdproc-0.5dev/docs/lcdproc-user/Makefile.am
--- lcdproc-0.5dev.orig/docs/lcdproc-user/Makefile.am 2008-10-10 12:08:10.000000000 +0200
+++ lcdproc-0.5dev/docs/lcdproc-user/Makefile.am 2009-06-07 15:27:45.000000000 +0200
@@ -23,6 +23,6 @@
install-html-userguide: $(xmlto) lcdproc-user.docbook
$(mkinstalldirs) $(userguidedir)
- $(xmlto) html -o $(userguidedir) lcdproc-user.docbook
+ $(xmlto) html -o $(userguidedir) --skip-validation lcdproc-user.docbook
## EOF
diff -ur lcdproc-0.5dev.orig/docs/lcdproc-user/Makefile.in lcdproc-0.5dev/docs/lcdproc-user/Makefile.in
--- lcdproc-0.5dev.orig/docs/lcdproc-user/Makefile.in 2009-06-07 15:14:20.000000000 +0200
+++ lcdproc-0.5dev/docs/lcdproc-user/Makefile.in 2009-06-07 15:29:21.000000000 +0200
@@ -491,7 +491,7 @@
install-html-userguide: $(xmlto) lcdproc-user.docbook
$(mkinstalldirs) $(userguidedir)
- $(xmlto) html -o $(userguidedir) lcdproc-user.docbook
+ $(xmlto) html -o $(userguidedir) --skip-validation lcdproc-user.docbook
# Tell versions [3.59,3.63) of GNU make to not export all variables.
# Otherwise a system limit (for SysV at least) may be exceeded.
.NOEXPORT: