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

update documentation a bit

Browse Source
This commit is contained in:
marschap
2007-10-28 11:19:53 +00:00
parent 5cf6eeee00
commit ca3745d75f
7 changed files with 151 additions and 92 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/lcdproc-user/configuration.docbook
+38 -17
View File
@@ -599,10 +599,13 @@ input "events".
-->
<para>
The menu is an LCDproc client built into <application>LCDd</application>.
The menu is a special LCDproc client built into <application>LCDd</application>
that allows changing server and display settings as well as extending it
with entries from client applications.
</para>
<para>
You can configure what keys the menu should use.
Note that the <literal>MenuKey</literal> will be reserved exclusively,
while the others work in shared mode.
</para>
<variablelist>
@@ -611,12 +614,19 @@ while the others work in shared mode.
<command>MenuKey=</command>
<arg choice="plain"><replaceable>KEY</replaceable></arg>
</term>
<listitem><para>
The key that switches into menu mode (=open the main menu).
In menu mode it cancels any operation. Cancelling the main menu
means returning to the regular display mode.
It has no default, but a natural candidate is <literal>Menu</literal>.
</para></listitem>
<listitem>
<para>
The key that switches into menu mode (=open the main menu).
In menu mode it cancels any operation. Cancelling the main menu
means returning to the regular display mode.
It has no default, but a natural candidate is <literal>Menu</literal>.
</para>
<note>
The <literal>MenuKey</literal> will be reserved exclusively,
while the others work in shared mode and can thus be used by a
client application when not in the menu.
</note>
</listitem>
</varlistentry>
<varlistentry>
@@ -625,7 +635,13 @@ while the others work in shared mode.
<arg choice="plain"><replaceable>KEY</replaceable></arg>
</term>
<listitem><para>
The key to enter a sub menu and/or, to select an entry.
The key to enter a sub menu, to select an entry and/or
to confirm the value of an input field.
If the <replaceable>RightKey</replaceable> is not defined,
it is also used to move right in input fields.
In this case the value of the input field is not confirmed,
until the right end of the input has been reached.
It is not set by default, but a natural candidate is <literal>Enter</literal>.
</para></listitem>
</varlistentry>
@@ -636,9 +652,11 @@ while the others work in shared mode.
<arg choice="plain"><replaceable>KEY</replaceable></arg>
</term>
<listitem><para>
The key to move to the previous menu item.
If the <replaceable>LeftKey</replaceable> is not set,
it is also used to move left in input fields.
The key to move to the previous item in a menu and/or to select
the previous value in input fields (e.g. the previous character
available for the current position).
If the <replaceable>DownKey</replaceable> is not set, moving up
before the first entry automatically wraps around to the last entry.
It is not set by default, but a natural candidate is <literal>Up</literal>.
</para></listitem>
</varlistentry>
@@ -649,9 +667,11 @@ while the others work in shared mode.
<arg choice="plain"><replaceable>KEY</replaceable></arg>
</term>
<listitem><para>
The key to move to the next menu item.
If the <replaceable>RightKey</replaceable> is not set,
it is also used to move right in input fields.
The key to move to the next item in a menu andi/or to select
the next value in input fields (e.g. the next character available
for the current position).
If the <replaceable>UpKey</replaceable> is not set, moving down
below the last entry automatically wraps around to the first entry.
It has no default, but a natural candidate is <literal>Down</literal>.
</para></listitem>
</varlistentry>
@@ -683,7 +703,7 @@ while the others work in shared mode.
</variablelist>
<para>
The keys required for the menu work correctly are the <command>MenuKey</command>,
The minimal keys required for the menu work correctly are the <command>MenuKey</command>,
the <command>EnterKey</command> and one of <command>UpKey</command> or
<command>DownKey</command>.
With these 3 keys the menus can be operated.
@@ -693,6 +713,7 @@ Especially the <command>LeftKey</command> and <command>RightKey</command>
make a big difference in user experience.
</para>
</sect2>
docs/lcdproc-user/drivers/hd44780.docbook
+104 -66
View File
@@ -70,12 +70,12 @@ All variants use the same method of obtaining power. i.e., for each LCD:
</thead>
<tbody>
<row>
<entry>V<subscript>SS</subscript></entry>
<entry>V<subscript>EE</subscript></entry>
<entry>1</entry>
<entry>GND (connect to any of pins 18 - 25 of you parallel port)</entry>
</row>
<row>
<entry>V<subscript>DD</subscript></entry>
<entry>V<subscript>CC</subscript></entry>
<entry>2</entry>
<entry>+5V</entry>
</row>
@@ -100,25 +100,28 @@ There are several ways to get 5V:
</para>
<itemizedlist>
<listitem><para>
Connect to a 5V line intented for disk drives (the red wire is 5V,
black is GND).
</para></listitem>
<listitem><para>
Get it from a joystick port (pin 1 and 9 are 5V, 4, 5 and 12 are GND).
It seems that some soundcards can use these lines for communication,
so if you want to use this first check wether it really gives a 'clean' 5V.
</para></listitem>
<listitem><para>
If you don't have a backlight, you can sometimes get the needed mA's
from the LPT port itself. Connect a few diodes from the data pins to
a capacitor and you have the 5V. If it's strong enough is another question...
</para></listitem>
<listitem><para>
Get it from the keyboard connector. I do not recommend to use this with
a backlight, as the keyboard connector is often protected with a fuse
of 100mA or 200mA.
</para></listitem>
<listitem><para>
Connect to a 5V line intented for disk drives (the red wire is 5V,
black is GND).
</para></listitem>
<listitem><para>
Get it from the V<subscript>CC</subscript> pin of an USB connector.
</para></listitem>
<listitem><para>
Get it from a joystick port (pin 1 and 9 are 5V, 4, 5 and 12 are GND).
It seems that some soundcards can use these lines for communication,
so if you want to use this first check wether it really gives a 'clean' 5V.
</para></listitem>
<listitem><para>
If you don't have a backlight, you can sometimes get the needed mA's
from the LPT port itself. Connect a few diodes from the data pins to
a capacitor and you have the 5V. If it's strong enough is another question...
</para></listitem>
<listitem><para>
Get it from the keyboard connector. I do not recommend to use this with
a backlight, as the keyboard connector is often protected with a fuse
of 100mA or 200mA.
</para></listitem>
</itemizedlist>
<figure id="hd44780-connections-power.contrast-circuit">
@@ -380,7 +383,7 @@ Y3 o---|<---o o---+----o return line
If the driver generates keypresses without that you actually press a key,
it might be that the unconnected input lines are picking up
electromagnetic waves from the air. In that case connect the unconnected
input lines (pin 10, 11, 12, 13 and 15 of the LPT) to VCC = 5V.
input lines (pin 10, 11, 12, 13 and 15 of the LPT) to V<subscript>CC</subscript> = 5V.
</para>
</tip>
@@ -488,6 +491,48 @@ This is originally based on "lcdtext" (by Matthias Prinke).
</row>
</thead>
<tbody>
<row>
<entry></entry>
<entry></entry>
<entry>GND</entry>
<entry>V<subscript>EE</subscript></entry>
<entry>1</entry>
</row>
<row>
<entry></entry>
<entry></entry>
<entry>+5V</entry>
<entry>V<subscript>CC</subscript></entry>
<entry>2</entry>
</row>
<row>
<entry></entry>
<entry></entry>
<entry>(contrast adjustment)</entry>
<entry>V<subscript>LC</subscript></entry>
<entry>3</entry>
</row>
<row>
<entry>D4</entry>
<entry>6</entry>
<entry></entry>
<entry>RS</entry>
<entry>4</entry>
</row>
<row>
<entry></entry>
<entry></entry>
<entry>GND</entry>
<entry>RW</entry>
<entry>5</entry>
</row>
<row>
<entry>D6</entry>
<entry>8</entry>
<entry></entry>
<entry>EN</entry>
<entry>6</entry>
</row>
<row>
<entry>D0</entry>
<entry>2</entry>
@@ -507,7 +552,7 @@ This is originally based on "lcdtext" (by Matthias Prinke).
<entry>4</entry>
<entry></entry>
<entry>D6</entry>
<entry>(13)</entry>
<entry>13</entry>
</row>
<row>
<entry>D3</entry>
@@ -516,49 +561,28 @@ This is originally based on "lcdtext" (by Matthias Prinke).
<entry>D7</entry>
<entry>14</entry>
</row>
<row>
<entry>D4</entry>
<entry>6</entry>
<entry></entry>
<entry>RS</entry>
<entry>4</entry>
</row>
<row>
<entry>D5</entry>
<entry>7</entry>
<entry></entry>
<entry>RW</entry>
<entry>5 (LCD3 - 6) (optional - pull all LCD RW low (*) )</entry>
</row>
<row>
<entry>D6</entry>
<entry>8</entry>
<entry></entry>
<entry>EN</entry>
<entry>6</entry>
</row>
<row>
<entry>D7</entry>
<entry>9</entry>
<entry></entry>
<entry>EN2</entry>
<entry>(LCD2 - 6) (optional)</entry>
</row>
</tbody>
</tgroup>
</table>
<para>
(*) on the RW line of the display: this line decides whether the display receives data from the
<note>
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.
</note>
<para>
The <literal>4bit</literal> connection type supports more than one display connected
to the same parallel port.
If you want to connect more than one display, then wire the all the displays to the
parallel port according to the scheme above with the exception of the <literal>EN</literal>
(pin 6) line of the LCDs.
</para>
<para>
If you want to connect more than two displays to the parallel port then
wire D5 (pin 7) to the enable line (pin 6) of the third LCD. Then for
displays four to seven use:
For the second and further displays, you can find the wiring for the <literal>EN</literal>
(pin 6) line in the table below.
</para>
<table id="hd44780-4bit.multi-mapping">
@@ -583,33 +607,47 @@ displays four to seven use:
</row>
</thead>
<tbody>
<row>
<entry>D7</entry>
<entry>9</entry>
<entry></entry>
<entry>EN<subscript>2</subscript></entry>
<entry>6 of 2<superscript>nd</superscript> display</entry>
</row>
<row>
<entry>D5</entry>
<entry>7</entry>
<entry></entry>
<entry>EN<subscript>3</subscript></entry>
<entry>6 of 3<superscript>rd</superscript> display</entry>
</row>
<row>
<entry>STR</entry>
<entry>1</entry>
<entry></entry>
<entry>EN4</entry>
<entry>6</entry>
<entry>EN<subscript>4</subscript></entry>
<entry>6 of 4<superscript>th</superscript> display</entry>
</row>
<row>
<entry>LF</entry>
<entry>14</entry>
<entry></entry>
<entry>EN5</entry>
<entry>6</entry>
<entry>EN<subscript>5</subscript></entry>
<entry>6 of 5<superscript>th</superscript> display</entry>
</row>
<row>
<entry>INIT</entry>
<entry>16</entry>
<entry></entry>
<entry>EN6</entry>
<entry>6</entry>
<entry>EN<subscript>6</subscript></entry>
<entry>6 of 6<superscript>th</superscript> display</entry>
</row>
<row>
<entry>SEL</entry>
<entry>17</entry>
<entry></entry>
<entry>EN7</entry>
<entry>6</entry>
<entry>EN<subscript>7</subscript></entry>
<entry>6 of 7<superscript>th</superscript> display</entry>
</row>
</tbody>
</tgroup>
@@ -2469,7 +2507,7 @@ This can be done by specifying <option>--enable-drivers=all</option> or by inclu
<title>Running</title>
<para>
Modify the LCDd.conf file before you run LCDd. In this config file are
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>
@@ -2480,7 +2518,7 @@ Then as usual, start LCDd with the correct config file:
E.g. <command>LCDd -c ./LCDd.conf</command>
</para>
<para>
If you want to override the driver selection in LCDd.conf then use:
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>
docs/lcdproc-user/drivers/picolcd.docbook
+2 -2
View File
@@ -45,7 +45,7 @@
to the LCDproc <code>./configure</code> <code>--drivers</code> option
(or use <literal>all</literal>), set the <code>Driver=</code> to
<literal>picolcd</literal> in the <filename>LCDd.conf</filename> config
file, and then start LCDd either directly or using startup scripts.
file, and then start <application>LCDd</application> either directly or using startup scripts.
The driver has sane default options and the options that are user configurable
are limited to mostly simple items, like contrast and which keys to light up.
</para>
@@ -179,7 +179,7 @@
<arg choice="plain"><replaceable>DURATION</replaceable></arg>
</term>
<listitem><para>
(Advanced) This value controls how long LCDd 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.
docs/lcdproc-user/drivers/ppttrouble.docbook
+1 -1
View File
@@ -42,7 +42,7 @@ thick enough (or not existent, see 1) the resistance of the
wire may cause differing GND potentials in the circuit.
This may lead to strange display behaviour. It may also be
wise to solder a 100nF capacitor directly to the GND and
V<subscript>DD</subscript> pins of the display.
V<subscript>CC</subscript> pins of the display.
</para>
</sect2>
<sect2 id="ppt-latchup">
docs/lcdproc-user/drivers/sed1330.docbook
+4 -4
View File
@@ -146,14 +146,14 @@ the connections given here are also correct for your display !
<entry>D7</entry>
</row>
<row>
<entry>V<subscript>DD</subscript></entry>
<entry>V<subscript>CC</subscript></entry>
<entry>16</entry>
<entry>+5V</entry>
<entry></entry>
<entry></entry>
</row>
<row>
<entry>V<subscript>SS</subscript></entry>
<entry>V<subscript>EE</subscript></entry>
<entry>17</entry>
<entry>GND</entry>
<entry>18..25</entry>
@@ -368,7 +368,7 @@ the connections given here are also correct for your display !
<entry>^SELECT_IN</entry>
</row>
<row>
<entry>V<subscript>SS</subscript></entry>
<entry>V<subscript>EE</subscript></entry>
<entry>17</entry>
<entry>GND</entry>
<entry>18..25</entry>
@@ -403,7 +403,7 @@ the connections given here are also correct for your display !
<entry></entry>
</row>
<row>
<entry>V<subscript>DD</subscript></entry>
<entry>V<subscript>CC</subscript></entry>
<entry>16</entry>
<entry>+5V</entry>
<entry></entry>
docs/lcdproc-user/drivers/t6963.docbook
+1 -1
View File
@@ -140,7 +140,7 @@ can be done by specifying "--enable-drivers=all" or by
<title>Running</title>
<para>
Modify the LCDd.conf file before you run LCDd. In this config file are
Modify the <filename>LCDd.conf</filename> file before you run LCDd. In this config file are
detailed instructions on how to configure the T6963 driver.
</para>
docs/lcdproc-user/drivers/xosd.docbook
+1 -1
View File
@@ -106,7 +106,7 @@ Offset=200x200
<listitem><para>
Set the initial off-brightness [default: <literal>500</literal>; legal: <literal>1</literal> - <literal>1000</literal>]
This value is used when the display is normally
switched off in case LCDd is inactive
switched off in case <application>LCDd</application> is inactive
</para></listitem>
</varlistentry>
-->