Spell check Docbook guides. Hint: Installing a spell checker in you IDE is
a good idea!
This commit is contained in:
@@ -65,7 +65,7 @@ driver to be included in LCDproc's code some conditions have to be met:</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>End user documentation (updates to man pages <emphasis>AND</emphasis>
|
||||
User's Guide in docbook format) is available.</para>
|
||||
User's Guide in Docbook format) is available.</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>Driver options are described in the end user documentation
|
||||
@@ -90,7 +90,7 @@ automake. This allows LCDproc to be ported to several platforms with much
|
||||
less effort. It can be quite daunting to understand how autoconf &
|
||||
automake interact with each others and with your code, but don't be
|
||||
discouraged. We have taken great care in making this as simple as possible
|
||||
for programers to add their own driver to LCDproc. Hopefully, you'll only
|
||||
for programmers to add their own driver to LCDproc. Hopefully, you'll only
|
||||
have to modify two files, one for autoconf and one for automake.
|
||||
</para>
|
||||
|
||||
@@ -191,7 +191,7 @@ mailing list and we'll make it for you.
|
||||
<sect2 id="automake">
|
||||
<title>Automake and its friend, Makefile.am</title>
|
||||
|
||||
<para>Allready half of the job is done! Not to bad, wasn't it? The rest
|
||||
<para>Already half of the job is done! Not to bad, wasn't it? The rest
|
||||
should be just as easy. In this section, you'll be adding your driver to the
|
||||
file server/drivers/Makefile.am. As you can guess, it's the Makefile for the
|
||||
drivers. This can be done in three (or two) simple steps.</para>
|
||||
@@ -219,7 +219,7 @@ EXTRA_PROGRAMS = bayrad CFontz ...(big list)... ula200 xosd <emphasis>myDriver</
|
||||
<para>This second step is only needed if your driver needs a particular
|
||||
library. If it doesn't, you can skip to step 3.</para>
|
||||
|
||||
<para>You basically need to put you driver name followed by _LDADD and egal
|
||||
<para>You basically need to put you driver name followed by _LDADD and equal
|
||||
this to the name of the library that you need. Usually, these library are
|
||||
substituted by a autoconf variable, if you're not comfortable with this, you
|
||||
send an email to the mailing list and we'll set this up for you.</para>
|
||||
@@ -237,7 +237,7 @@ myDriver_LDADD = @SOMESTRANGELIB@
|
||||
<para>
|
||||
Last but not least, you need to specify which source files should be
|
||||
associated with your driver. You put your driver name followed by
|
||||
<literal>_SOURCES</literal> and egal this to a space separated list
|
||||
<literal>_SOURCES</literal> and equal this to a space separated list
|
||||
of the source and header files. See below for an example.</para>
|
||||
|
||||
<screen>
|
||||
@@ -385,7 +385,7 @@ to the directory <filename>docs/lcdproc-user/drivers/</filename>.
|
||||
<title>Step 2</title>
|
||||
|
||||
<para>
|
||||
Define a Docbook entity for your driverfile in <filename>lcdproc-user.docbook</filename>.
|
||||
Define a Docbook entity for your driver file in <filename>lcdproc-user.docbook</filename>.
|
||||
</para>
|
||||
|
||||
<screen>
|
||||
|
||||
@@ -34,7 +34,7 @@
|
||||
</itemizedlist>
|
||||
|
||||
<para>
|
||||
The API is best descibed by starting with the struct lcd_logical_driver
|
||||
The API is best described by starting with the struct lcd_logical_driver
|
||||
which is defined in server/drivers/lcd.h.
|
||||
</para>
|
||||
|
||||
@@ -209,9 +209,9 @@ typedef struct lcd_logical_driver {
|
||||
<title>Private Data</title>
|
||||
|
||||
<para>
|
||||
With the introduction of loadable modules it is necesary to stop using global
|
||||
With the introduction of loadable modules it is necessary to stop using global
|
||||
variables to store a driver's data in. Instead, you should store it in a
|
||||
structure, that you allocate abd store on driver's init. If you don't use
|
||||
structure, that you allocate and store on driver's init. If you don't use
|
||||
this system, but use globals, you get queer results if you run two LCDd
|
||||
daemons on one machine. They will then use the same variables !
|
||||
</para>
|
||||
@@ -599,7 +599,7 @@ typedef struct MyDriver_private_data {
|
||||
</funcsynopsis>
|
||||
<para>
|
||||
Checks if a key has been pressed on the device.
|
||||
Returns NULL for "no key pressed", or a string describing the pressd key.
|
||||
Returns NULL for "no key pressed", or a string describing the pressed key.
|
||||
These characters should match the keypad-layout.
|
||||
</para>
|
||||
|
||||
@@ -682,7 +682,7 @@ typedef struct MyDriver_private_data {
|
||||
</funcprototype>
|
||||
</funcsynopsis>
|
||||
<para>
|
||||
Returns wether a section exists. Does not need to be called prior
|
||||
Returns whether a section exists. Does not need to be called prior
|
||||
to a call to a config_get_* function.
|
||||
</para>
|
||||
|
||||
|
||||
@@ -12,7 +12,7 @@
|
||||
|
||||
<para>
|
||||
The LCDproc clients, for example lcdproc, connect over the network to
|
||||
LCDd. In their communication they use a protocol, often refered to as
|
||||
LCDd. In their communication they use a protocol, often referred to as
|
||||
the "widget language". In this chapter the widget language will be
|
||||
discussed.
|
||||
</para>
|
||||
@@ -218,7 +218,7 @@
|
||||
<para>
|
||||
Sets attributes for the given screen. The following attributes
|
||||
exist:
|
||||
<variablelist><!--<title>screen_set attributes</title>-->
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term>
|
||||
<option>-name <replaceable>name</replaceable></option>
|
||||
@@ -338,7 +338,7 @@
|
||||
</term>
|
||||
<listitem><para>
|
||||
Changes the screen's backlight setting.
|
||||
If iset to the default value <literal>open</literal>,
|
||||
If set to the default value <literal>open</literal>,
|
||||
the state will be determined by the client's setting.
|
||||
<literal>blink</literal> is a moderately striking backlight variation,
|
||||
<literal>flash</literal> is <emphasis>very</emphasis> strinking.
|
||||
@@ -512,7 +512,7 @@
|
||||
<para>
|
||||
Sets parameters for a widget. Because not all widgets are created equal,
|
||||
the various widget types require different parameters.
|
||||
<variablelist><!--<title>widget_set required parameters per widget type</title>-->
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term>
|
||||
<literal>string</literal>
|
||||
@@ -838,8 +838,8 @@
|
||||
<literal>ip</literal>
|
||||
</term>
|
||||
<listitem><para>
|
||||
Allows the user to input an ip number (v4 or
|
||||
v6). When selected, a screen comes up that shows an ip
|
||||
Allows the user to input an IP number (v4 or
|
||||
v6). When selected, a screen comes up that shows an IP
|
||||
number that can be edited - digit by digit - via
|
||||
left/right (switch digit) and up/down keys
|
||||
(increase/decrease).
|
||||
@@ -1447,7 +1447,7 @@
|
||||
<computeroutput>success</computeroutput>
|
||||
</term>
|
||||
<listitem><para>
|
||||
This is the reponse to a command in case everything went ok.
|
||||
This is the response to a command in case everything went OK.
|
||||
</para></listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
@@ -1544,7 +1544,7 @@
|
||||
<literal>leave</literal>
|
||||
</term>
|
||||
<listitem><para>
|
||||
This item has been left, so it is currenly not the (main)
|
||||
This item has been left, so it is currently not the (main)
|
||||
active item anymore.
|
||||
</para></listitem>
|
||||
</varlistentry>
|
||||
|
||||
@@ -3,11 +3,11 @@
|
||||
|
||||
<para>
|
||||
Driving an LCD display is not easy; you need to address ports, to send bytes
|
||||
in a certain order, to respect timing, and unfortunaly no two operating system
|
||||
let you do this in the same way. But don't dispair! There's hope! Someone in
|
||||
a galaxy far far away, has allready done the dirty job for you! This dirty job
|
||||
in a certain order, to respect timing, and unfortunately no two operating system
|
||||
let you do this in the same way. But don't despair! There's hope! Someone in
|
||||
a galaxy far far away, has Already done the dirty job for you! This dirty job
|
||||
has been put in shared files. These shared files are full cross platform and
|
||||
are automagically configured by the configure script. You only need to include
|
||||
are auto-magically configured by the configure script. You only need to include
|
||||
them and use their functions to benefit from them.
|
||||
</para>
|
||||
|
||||
@@ -196,7 +196,7 @@ port_deny_multiple(0x378, 3);
|
||||
<term><function>get_free_chars()</function></term>
|
||||
<listitem>
|
||||
<para>
|
||||
to determine the number of user-defineable characters that can be
|
||||
to determine the number of user-definable characters that can be
|
||||
used in the generation of big numbers.
|
||||
</para>
|
||||
</listitem>
|
||||
@@ -207,7 +207,7 @@ port_deny_multiple(0x378, 3);
|
||||
<listitem>
|
||||
<para>
|
||||
to define a character necessary to write a big number.
|
||||
Of course this is only necessary if there really are user-definieable
|
||||
Of course this is only necessary if there really are user-definable
|
||||
characters, i.e. only if <function>get_free_chars()</function> returns
|
||||
a value greater <literal>0</literal>.
|
||||
</para>
|
||||
@@ -285,7 +285,7 @@ port_deny_multiple(0x378, 3);
|
||||
<term><parameter>drvthis</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
the pointer pointing to the Driver structure passed to thea driver's
|
||||
the pointer pointing to the Driver structure passed to the driver's
|
||||
<function>num()</function> function.
|
||||
</para>
|
||||
</listitem>
|
||||
@@ -317,9 +317,9 @@ port_deny_multiple(0x378, 3);
|
||||
<term><parameter>offset</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
the character position where the user-defineable characters start
|
||||
the character position where the user-definable characters start
|
||||
(usually <literal>0</literal>).
|
||||
The user-defineable characters (if any) are then expected to be at the character positions
|
||||
The user-definable characters (if any) are then expected to be at the character positions
|
||||
<replaceable>offset</replaceable><literal>+0</literal>,
|
||||
<replaceable>offset</replaceable><literal>+1</literal>,
|
||||
<replaceable>offset</replaceable><literal>+2</literal>, ...
|
||||
@@ -408,7 +408,7 @@ myDriver_SOURCES: lcd.h lcd_lib.h myDriver.c myDriver.h report.h <emphasis>adv_b
|
||||
The display-dependent functions are named
|
||||
<function>adv_bignum_num_<replaceable>N_M</replaceable>()</function>,
|
||||
where <replaceable>N</replaceable> is the display's height in lines and <replaceable>M</replaceable>
|
||||
the number of used user-defineable characters.
|
||||
the number of used user-definable characters.
|
||||
The bits of the user-characters are stored in <replaceable>static char bignum</replaceable>
|
||||
(take a look at the source and you will see what I mean). (On a display with a
|
||||
<replaceable>cellheight</replaceable> of 7 the lowest line stored is not shown.)
|
||||
@@ -418,8 +418,8 @@ myDriver_SOURCES: lcd.h lcd_lib.h myDriver.c myDriver.h report.h <emphasis>adv_b
|
||||
</para>
|
||||
|
||||
<para>
|
||||
If user-defineable characters have to be set, the driver's <function>set_char()</function> function
|
||||
will be called once for every user-idefneable character.
|
||||
If user-definable characters have to be set, the driver's <function>set_char()</function> function
|
||||
will be called once for every user-definable character.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
|
||||
@@ -9,7 +9,7 @@ the most current source code available. You can get it several ways:</para>
|
||||
|
||||
<orderedlist>
|
||||
<listitem>
|
||||
<para>Download yesterday's CVS version of as a tarball (prefered).</para>
|
||||
<para>Download yesterday's CVS version of as a tarball (preferred).</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>Download the latest version from CVS.</para>
|
||||
@@ -100,7 +100,7 @@ different programming styles (naming, indention, etc) in the source code.
|
||||
</para>
|
||||
<para>
|
||||
When modifying an existing file, please take a careful look at its style and
|
||||
program continueing that style instead of mixing it up with another one even
|
||||
program continuing that style instead of mixing it up with another one even
|
||||
if it does not comply with the guidelines written below.
|
||||
</para>
|
||||
<para>
|
||||
@@ -121,7 +121,7 @@ should look like.
|
||||
<para>
|
||||
<emphasis>Language: </emphasis>The programming language used for LCDd
|
||||
(server core), drivers and the lcdproc client is <literal>C</literal>.
|
||||
No other programming lanuage will be accepted.
|
||||
No other programming language will be accepted.
|
||||
</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
@@ -168,7 +168,7 @@ should look like.
|
||||
<para>
|
||||
<emphasis>Variable names:</emphasis>
|
||||
We do not use Hungarian Notation. CamelCase may be used,
|
||||
but names shall beginn with a lowercase letter.
|
||||
but names shall begin with a lowercase letter.
|
||||
</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
@@ -256,7 +256,7 @@ unsigned char HD44780_scankeypad(PrivateData *p);
|
||||
<para><emphasis>Function declarations:</emphasis></para>
|
||||
<para>
|
||||
Function declarations have their declaration and
|
||||
opening brace split accross two lines.
|
||||
opening brace split across two lines.
|
||||
</para>
|
||||
<para>
|
||||
Function names start in column one. The return type is placed on the
|
||||
@@ -333,7 +333,7 @@ lib_vbar_static(drvthis, x, y, len, promille, options, p->cellheight, 0);
|
||||
is there is a previous closing brace.
|
||||
</para>
|
||||
<para>
|
||||
Opening and closing braces may be ommited on single line compound
|
||||
Opening and closing braces may be omitted on single line compound
|
||||
statements. However, if one part of an if-else-statement requires braces
|
||||
the other part shall have braces as well.
|
||||
</para>
|
||||
@@ -401,7 +401,7 @@ the LCDproc project. You usually do this by submitting a patch for review to the
|
||||
mailing list.</para>
|
||||
|
||||
<para>To create a patch you need the unmodified files and the files containing
|
||||
your modificatiosn. Usually you do this by storing an unmodified copy of the
|
||||
your modifications. Usually you do this by storing an unmodified copy of the
|
||||
sources in one directory and another copy with your modifications in another
|
||||
one. You then run <command>diff</command> like this:</para>
|
||||
|
||||
@@ -427,7 +427,7 @@ you can also run <command>cvs diff</command> from the working directory:</para>
|
||||
|
||||
<note>
|
||||
<para>Some versions of <command>cvs diff</command> will not handle new files
|
||||
because these are unkown to the repository. There are ways to make cvs believe
|
||||
because these are unknown to the repository. There are ways to make cvs believe
|
||||
the files existed previously (fake add) but this is not recommended. You will
|
||||
need to submit new files 'as-is' in this case.</para>
|
||||
</note>
|
||||
|
||||
@@ -90,7 +90,7 @@ release.
|
||||
<step>
|
||||
<para>
|
||||
Tag the stable tree to indicate the file revision where the branch was
|
||||
made. This eases later diffs againt that point.
|
||||
made. This eases later diffs against that point.
|
||||
</para>
|
||||
<para>
|
||||
Run: <userinput>cvs tag LCDPROC_0_5_<replaceable>A</replaceable>_BP</userinput>
|
||||
@@ -107,14 +107,14 @@ release.
|
||||
<userinput>cvs tag -b lcdproc-0-5-<replaceable>A</replaceable></userinput>
|
||||
</para>
|
||||
<note>
|
||||
<para>Release branch names are all lowercase with hypens to separate
|
||||
<para>Release branch names are all lowercase with hyphens to separate
|
||||
elements!</para>
|
||||
</note>
|
||||
</step>
|
||||
<step>
|
||||
<para>
|
||||
Now you have created a branch from which the new release will done. Before
|
||||
continuing either checkout this new branch to a new workding directory
|
||||
continuing either checkout this new branch to a new working directory
|
||||
or update the current one by running:
|
||||
<userinput>cvs update -r lcdproc-0-5-<replaceable>A</replaceable></userinput>
|
||||
</para>
|
||||
@@ -267,7 +267,7 @@ Here is how to create these documentation packages.
|
||||
</procedure>
|
||||
|
||||
<para>
|
||||
The online documenation consists of the user and developer guide, each
|
||||
The online documentation consists of the user and developer guide, each
|
||||
converted to a single file for viewing online.
|
||||
</para>
|
||||
|
||||
|
||||
@@ -32,7 +32,7 @@ Here we provide functions that should be used by all parts of the program.
|
||||
|
||||
<para>
|
||||
This way, the global DEBUG macro is off but is locally enabled in
|
||||
certains parts of the software.</para>
|
||||
certain parts of the software.</para>
|
||||
|
||||
<para>The reporting levels have the following meaning.</para>
|
||||
|
||||
|
||||
@@ -85,7 +85,7 @@ When quoted, the following character sequences are evaluated as in literal C str
|
||||
</tbody>
|
||||
</tgroup>
|
||||
</informaltable>
|
||||
All other occurences of <literal>\</literal> within quoted values will be ignored.
|
||||
All other occurrences of <literal>\</literal> within quoted values will be ignored.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
@@ -101,7 +101,7 @@ Those sections start with <code>[<replaceable>drivername</replaceable>]</code>.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
<anchor id="which-driver" />The drivers are activated by specifiying them in a <code>Driver=</code>
|
||||
<anchor id="which-driver" />The drivers are activated by specifying them in a <code>Driver=</code>
|
||||
line in the server section, like:
|
||||
</para>
|
||||
|
||||
@@ -296,7 +296,7 @@ settings for the LCDproc server <application>LCDd</application>.
|
||||
<para>
|
||||
Define the startup message printed on the screen when LCDd starts.
|
||||
This message will stay on the screen until the first client connects.
|
||||
If not given, it defaults to the builtin server screen that tells
|
||||
If not given, it defaults to the built-in server screen that tells
|
||||
how many clients are connected and how many screens these clients
|
||||
are using in total.
|
||||
If it is given, each <code>Hello=</code> directive represents
|
||||
@@ -313,7 +313,7 @@ settings for the LCDproc server <application>LCDd</application>.
|
||||
prints a nice 2-line welcome message to the display.
|
||||
</para>
|
||||
<para>
|
||||
To simply disable the default builtin server screen on startup,
|
||||
To simply disable the default built-in server screen on startup,
|
||||
and start with a blank screen a single <code>Hello=""</code> is sufficient.
|
||||
</para>
|
||||
</listitem>
|
||||
@@ -327,7 +327,7 @@ settings for the LCDproc server <application>LCDd</application>.
|
||||
<listitem>
|
||||
<para>
|
||||
Define the message left on the screen when LCDd exits.
|
||||
If not given, it defaults to the builtin
|
||||
If not given, it defaults to the built-in
|
||||
<literal>Thanks for using LCDproc!</literal>.
|
||||
If it is given, each <code>GoodBye=</code> directive represents
|
||||
a line on the display.
|
||||
@@ -346,7 +346,7 @@ settings for the LCDproc server <application>LCDd</application>.
|
||||
to show the full last line).
|
||||
</para>
|
||||
<para>
|
||||
To simply disable the default builtin message, and leave the screen blank
|
||||
To simply disable the default built-in message, and leave the screen blank
|
||||
a single <code>GoodBye=""</code> suffices.
|
||||
</para>
|
||||
</listitem>
|
||||
@@ -380,7 +380,7 @@ settings for the LCDproc server <application>LCDd</application>.
|
||||
</term>
|
||||
<listitem>
|
||||
<para>
|
||||
Control the bahaviour of the server screen, that usually shows the number
|
||||
Control the behaviour of the server screen, that usually shows the number
|
||||
of active clients and screens.
|
||||
When set to its default value <literal>yes</literal>, the server screen
|
||||
is included into the screen rotation scheme when other screens exist.
|
||||
@@ -598,7 +598,7 @@ You can configure what keys the menu should use.
|
||||
<parameter><replaceable>KEY</replaceable></parameter>
|
||||
</term>
|
||||
<listitem><para>
|
||||
The key to move to the next item in a menu andi/or to select
|
||||
The key to move to the next item in a menu and/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
|
||||
@@ -660,7 +660,7 @@ As mentioned earlier, each driver has its own section in the
|
||||
Although the settings are more or less self-explanatory,
|
||||
they are explained in the next chapter in the section for each driver.
|
||||
So, read through the section of your driver and change
|
||||
everything neccessary.
|
||||
everything necessary.
|
||||
</para>
|
||||
|
||||
</sect2>
|
||||
|
||||
@@ -122,7 +122,7 @@ For more information see the
|
||||
</term>
|
||||
<listitem><para>
|
||||
Tells if you have a keypad connected. Keypad layout is currently not
|
||||
configureable from the config file.
|
||||
configurable from the config file.
|
||||
</para></listitem>
|
||||
</varlistentry>
|
||||
|
||||
|
||||
@@ -82,7 +82,7 @@ lack of the required hardware.
|
||||
|
||||
<para>
|
||||
The driver is based on the <ulink url="http://libusb.sourceforge.net/"><filename>libusb</filename></ulink>
|
||||
USB library, which should make it work with Linux, the different BSB variants
|
||||
USB library, which should make it work with Linux, the different BSD variants
|
||||
as well as Darwin/MacOS X.
|
||||
|
||||
<note>
|
||||
|
||||
@@ -99,7 +99,7 @@ This section has been modified by Cédric TESSIER (http://www.nezetic.info)
|
||||
<property>Backlight</property> = ¶meters.yesdefno;
|
||||
</term>
|
||||
<listitem><para>
|
||||
Switch on the backlight? [default: <literal>yes</literal>; legal: <literal>yes</literal>, <literal>no</literal>]
|
||||
Switch on the backlight [default: <literal>yes</literal>; legal: <literal>yes</literal>, <literal>no</literal>]
|
||||
</para>
|
||||
<note><para>
|
||||
If you choose yes, you can switch on/off the backlight in real time
|
||||
|
||||
@@ -180,7 +180,7 @@ before configuring the LCDproc build process --enable-drivers=glcdlib.
|
||||
</term>
|
||||
<listitem><para>
|
||||
turns on/off 1 pixel thick debugging
|
||||
border whithin the usable text area,
|
||||
border within the usable text area,
|
||||
for setting up TextResolution and
|
||||
MinFontFaceSize (if using FT2);
|
||||
</para></listitem>
|
||||
|
||||
@@ -177,11 +177,11 @@ HD44780 driver.
|
||||
<title>Connections</title>
|
||||
|
||||
<sect3 id="hd44780-connections-common">
|
||||
<title>Common connections for all connectiontypes</title>
|
||||
<title>Common connections for all connection types</title>
|
||||
|
||||
<para>
|
||||
No matter what connection type you choose, you will always need some
|
||||
connections. They are explaned here.
|
||||
connections. They are explained here.
|
||||
</para>
|
||||
|
||||
<sect4 id="hd44780-connections-power">
|
||||
@@ -239,7 +239,7 @@ There are several ways to get 5V:
|
||||
|
||||
<itemizedlist>
|
||||
<listitem><para>
|
||||
Connect to a 5V line intented for disk drives (the red wire is 5V,
|
||||
Connect to a 5V line intended for disk drives (the red wire is 5V,
|
||||
black is GND).
|
||||
</para></listitem>
|
||||
<listitem><para>
|
||||
@@ -250,7 +250,7 @@ There are several ways to get 5V:
|
||||
<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.
|
||||
so if you want to use this first check whether 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
|
||||
@@ -435,7 +435,7 @@ Y4 o---|<---@--@--@ O 5V
|
||||
|
||||
<para>
|
||||
As you can see, you need 1 resistor per X line, and 1 diode per Y line.
|
||||
By default, Lcdproc will presume that you have a keypad with a layout
|
||||
By default, lcdproc will presume that you have a keypad with a layout
|
||||
like a telephone connected, with X and Y lines connected as show.
|
||||
To be more precise, it assumes this mapping:
|
||||
</para>
|
||||
@@ -1079,7 +1079,7 @@ you need it otherwise, then connect it to GND. This certainly applies if you hav
|
||||
|
||||
<para>
|
||||
If you want the display to work with the Winamp plugin, wire nLF (pin 14)
|
||||
to RW of your LCD. You can then use the plugin in bidirectional mode (wich
|
||||
to RW of your LCD. You can then use the plugin in bidirectional mode (which
|
||||
is much faster). With 3 connected LCDs this is not possible.
|
||||
Note from Benjamin: I haven't tried using winamp while having the third LCD
|
||||
connected to this line.
|
||||
@@ -1720,7 +1720,7 @@ buffers from the 74HCT14:
|
||||
<title>Serial LPT Backlight</title>
|
||||
|
||||
<para>
|
||||
Also a backlight is suported. You will also need a port from the 74HCT14 for
|
||||
Also a backlight is supported. You will also need a port from the 74HCT14 for
|
||||
that. The BL output below should be connected to the BL input in the
|
||||
<link linkend="hd44780-connections-backlight">backlight section</link>
|
||||
</para>
|
||||
@@ -2959,7 +2959,7 @@ This can be done by specifying <option>--enable-drivers=all</option> or by inclu
|
||||
<property>Backlight</property> = ¶meters.yesnodef;
|
||||
</term>
|
||||
<listitem><para>
|
||||
Specifiy if you have a switchable backlight.
|
||||
Specify if you have a switchable backlight.
|
||||
</para></listitem>
|
||||
</varlistentry>
|
||||
|
||||
@@ -3166,7 +3166,7 @@ This can be done by specifying <option>--enable-drivers=all</option> or by inclu
|
||||
|
||||
|
||||
<sect2 id="hd44780-miscellania">
|
||||
<title>Miscellania</title>
|
||||
<title>Miscellanea</title>
|
||||
|
||||
<para>
|
||||
This text has originally been taken from a message by Bill Farrow
|
||||
@@ -3182,7 +3182,7 @@ Updated October 2001, Joris Robijn <email>joris@robijn.net</email>
|
||||
</para>
|
||||
|
||||
<para>
|
||||
Converted to docbook March 2002, Rene Wagner <email>reenoo@gmx.de</email>
|
||||
Converted to Docbook March 2002, Rene Wagner <email>reenoo@gmx.de</email>
|
||||
</para>
|
||||
|
||||
<para>
|
||||
|
||||
@@ -60,9 +60,9 @@ For further details, please consult the page and the forum at
|
||||
</term>
|
||||
<listitem><para>
|
||||
Set the display size. The default <literal>16x2</literal> should be safe
|
||||
for most if not all users, since the device seeems to be made only with
|
||||
for most if not all users, since the device seems to be made only with
|
||||
this one size.
|
||||
But who knowns …
|
||||
But who knows …
|
||||
</para></listitem>
|
||||
</varlistentry>
|
||||
|
||||
|
||||
@@ -11,12 +11,12 @@ For example, <ulink url="http://www.soundgraph.com/oem-lcd-feature-en/">the iMON
|
||||
|
||||
<para>
|
||||
This driver currently supports versions 15c2:ffdc and 15c2:0038 of the device.
|
||||
(You can find the version of your lcd via the lsusb command).
|
||||
(You can find the version of your LCD via the lsusb command).
|
||||
</para>
|
||||
|
||||
<para>
|
||||
In many systems, the LCD backlight will remain on after the system is shutdown.
|
||||
This behavior remains a mystery - somehow the lcd recieves a reset command (or
|
||||
This behavior remains a mystery - somehow the LCD receives a reset command (or
|
||||
similar) AFTER LCDd is stopped.
|
||||
</para>
|
||||
|
||||
|
||||
@@ -37,8 +37,8 @@ from <ulink url="http://www.irtrans.de/en/download/linux.php"></ulink>.
|
||||
<property>Backlight</property> = ¶meters.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>no</literal>.
|
||||
Tell whether the device has a backlight, or whether the backlight shall be used.
|
||||
If not given, it defaults to <literal>no</literal>.
|
||||
</para></listitem>
|
||||
</varlistentry>
|
||||
|
||||
|
||||
@@ -108,7 +108,7 @@ Then you have to modify the <code>[lirc]</code> section of your
|
||||
directive in the lirc configuration file.
|
||||
</para>
|
||||
<para>
|
||||
<replaceable>PROGRAM</replaceable> must be the same as in iyour lirc
|
||||
<replaceable>PROGRAM</replaceable> must be the same as in your lirc
|
||||
configuration file.
|
||||
</para>
|
||||
</listitem>
|
||||
@@ -192,7 +192,7 @@ and <literal>Enter</literal> are necessary.
|
||||
<!-- TODO: is this still true with 0.5 ? -->
|
||||
Of course you can define other keys. Those keys will not be handled by the
|
||||
server but sent to a client. Refer to the documentation of the client you want
|
||||
to use, to find out which keys are neccessary for that client.
|
||||
to use, to find out which keys are necessary for that client.
|
||||
</para>
|
||||
|
||||
</sect2>
|
||||
|
||||
@@ -3,7 +3,7 @@
|
||||
|
||||
<para>
|
||||
This section talks about using LCDproc with the VLSystem L.I.S
|
||||
MCE 2005 Vacuum Flourescent Display (VFD) based on the FTDI USB-to-serial
|
||||
MCE 2005 Vacuum Fluorescent Display (VFD) based on the FTDI USB-to-serial
|
||||
converter, the Microchip PIC-16F716 microcontroller, and
|
||||
the NEC UPD16314 display driver manufactured by
|
||||
<ulink url="http://www.vlsys.co.kr">VLSystem</ulink>.
|
||||
@@ -14,7 +14,7 @@
|
||||
<title>Features</title>
|
||||
|
||||
<para>
|
||||
This device uses a vacuum flourescent display of 20 characters by 2 lines. Each each
|
||||
This device uses a vacuum fluorescent display of 20 characters by 2 lines. Each each
|
||||
character is 5 pixels wide by 8 pixels high. The device is connected by USB. The FTDI chip
|
||||
translates the USB protocol to serial expected by the VFD driver chip, an NEC UPD16314.
|
||||
A programmable interrupt controller (PIC), the PIC16F716 by Microchip, provides the glue
|
||||
@@ -62,9 +62,9 @@ USB library.
|
||||
</term>
|
||||
<listitem><para>
|
||||
Set the display size. The default <literal>20x2</literal> should be safe
|
||||
for most if not all users, since the device seeems to be made only with
|
||||
for most if not all users, since the device seems to be made only with
|
||||
this one size.
|
||||
But who knowns …
|
||||
But who knows …
|
||||
</para></listitem>
|
||||
</varlistentry>
|
||||
|
||||
|
||||
@@ -15,7 +15,7 @@ is used for 16x2 characters with a 6x8 pixel font. It features several icons,
|
||||
volume level and WLAN strength indicator which are all software controllable
|
||||
using the <function>output</function> function.</para>
|
||||
|
||||
<para>The mdm166a driver builts on top of <literal>libhid</literal> which in
|
||||
<para>The mdm166a driver builds on top of <literal>libhid</literal> which in
|
||||
turn uses <literal>libusb</literal>.</para>
|
||||
|
||||
<para>The driver was developed by Christoph Rasim
|
||||
@@ -43,14 +43,14 @@ protocol.</para>
|
||||
<literal>small</literal> and <literal>big</literal>. If not given no clock
|
||||
is shown.
|
||||
</para></listitem>
|
||||
</varlistentry>
|
||||
</varlistentry>
|
||||
|
||||
<varlistentry>
|
||||
<term>
|
||||
<property>Dimming</property> = ¶meters.yesnodef;
|
||||
</term>
|
||||
<listitem><para>
|
||||
Dimm display, no dimming gives full brightness.
|
||||
Dim display, no dimming gives full brightness.
|
||||
</para></listitem>
|
||||
</varlistentry>
|
||||
|
||||
@@ -59,7 +59,7 @@ protocol.</para>
|
||||
<property>OffDimming</property> = ¶meters.yesnodef;
|
||||
</term>
|
||||
<listitem><para>
|
||||
Dimm display in case LCDd is inactive.
|
||||
Dim display in case LCDd is inactive.
|
||||
</para></listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
@@ -169,13 +169,13 @@ following patch to your kernel source and recompile and install your kernel:
|
||||
@@ -2343,6 +2344,9 @@
|
||||
/* System TALKS, Inc. */
|
||||
product SYSTEMTALKS SGCX2UL 0x1920 SGC-X2UL
|
||||
|
||||
|
||||
+/* Targa Corporation */
|
||||
+product TARGA VFD 0x6a11 Targa USB Graphic VFD
|
||||
+
|
||||
/* Tapwave products */
|
||||
product TAPWAVE ZODIAC 0x0100 Zodiac
|
||||
|
||||
|
||||
--- sys/dev/usb/usb_quirks.c.orig 2010-11-24 02:07:03.000000000 +0100
|
||||
+++ sys/dev/usb/usb_quirks.c 2010-11-24 02:16:30.000000000 +0100
|
||||
@@ -112,6 +112,8 @@
|
||||
@@ -184,7 +184,7 @@ following patch to your kernel source and recompile and install your kernel:
|
||||
ANY, { UQ_HID_IGNORE }},
|
||||
+ { USB_VENDOR_TARGA, USB_PRODUCT_TARGA_VFD,
|
||||
+ ANY, { UQ_HID_IGNORE }},
|
||||
|
||||
|
||||
/* Devices which should be ignored by both ukbd and uhid */
|
||||
{ USB_VENDOR_CYPRESS, USB_PRODUCT_CYPRESS_WISPY1A,
|
||||
]]>
|
||||
|
||||
@@ -209,20 +209,6 @@
|
||||
</sect3>
|
||||
</sect2>
|
||||
|
||||
<!-- This is already covered in bookinfo.docbook
|
||||
<sect2 id="MtxOrb-copy">
|
||||
<title>Copyright</title>
|
||||
|
||||
<para>
|
||||
This section was originally part of the lcdproc.sgml file by William W. Ferrell <email>wwf@splatwerks.org</email>
|
||||
</para>
|
||||
|
||||
<para>
|
||||
Slightly modified in order to include it in this document March 2002, Rene Wagner <email>reenoo@gmx.de</email>
|
||||
</para>
|
||||
</sect2>
|
||||
-->
|
||||
|
||||
<!-- ## Matrix Orbital driver ## -->
|
||||
<sect2 id="MtxOrb-config">
|
||||
<title>Configuration in LCDd.conf</title>
|
||||
|
||||
@@ -18,7 +18,7 @@ The following hints might be helpful:
|
||||
|
||||
<para>
|
||||
Wiring errors can easily be made.
|
||||
If you are unexperienced with the soldering iron better have someone solder
|
||||
If you are inexperienced with the soldering iron better have someone solder
|
||||
it for you.
|
||||
Display modules are sensitive to electrostatic discharges, so touch an
|
||||
earthed surface (computer case, water pipes...) before you handle these.
|
||||
@@ -91,8 +91,8 @@ a logic H as the older parallel ports did, because the operating voltage of
|
||||
computers is lower than 5V these days.
|
||||
I have measured voltages between 2.5V and 4V for logic H, which is barely
|
||||
within specification of the HD44780.
|
||||
If you account RCL of your cable, this may not be enough and can cause
|
||||
unreliable operation.
|
||||
If you account R<subscript>CL</subscript> of your cable, this may not be
|
||||
enough and can cause unreliable operation.
|
||||
</para>
|
||||
</sect2>
|
||||
|
||||
@@ -190,13 +190,13 @@ To name a few: KS0066, KS0070, KS0076, LC7985, NT3881, SED1278, ST7066 ...
|
||||
</sect2>
|
||||
|
||||
<sect2 id="ppt-misc">
|
||||
<title>Miscellania</title>
|
||||
<title>Miscellanea</title>
|
||||
<para>
|
||||
This text has originally been taken from a <ulink url="http://lists.omnipotent.net/pipermail/lcdproc/2002-May/005832.html">message</ulink> by
|
||||
Robin Adams <email>robin@adams-online.de</email>
|
||||
</para>
|
||||
<para>
|
||||
Converted to docbook and slightly modified May 2002, Rene Wagner <email>reenoo@gmx.de</email>
|
||||
Converted to Docbook and slightly modified May 2002, Rene Wagner <email>reenoo@gmx.de</email>
|
||||
</para>
|
||||
</sect2>
|
||||
|
||||
|
||||
@@ -23,7 +23,7 @@ displays have a negative voltage generator onboard.
|
||||
</para>
|
||||
<para>
|
||||
Connections below are for the G242C, G121C and G321D displays. Always consult
|
||||
documentation about the specific display before asuming the connections given
|
||||
documentation about the specific display before assuming the connections given
|
||||
here are also correct for your display!
|
||||
</para>
|
||||
</warning>
|
||||
|
||||
@@ -101,7 +101,7 @@ Feedback is welcome.
|
||||
<entry>Ok</entry>
|
||||
<entry>Yes</entry>
|
||||
<entry>6</entry>
|
||||
<entry>allmost IEE compatible, no Custom-Characters</entry>
|
||||
<entry>almost IEE compatible, no Custom-Characters</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>Samsung 20S204DA2 and 20S207DA1</entry>
|
||||
@@ -119,7 +119,7 @@ Feedback is welcome.
|
||||
<entry>Ok</entry>
|
||||
<entry>Yes</entry>
|
||||
<entry>7, 3<footnoteref linkend="no_char" /></entry>
|
||||
<entry>allmost Futaba compatible</entry>
|
||||
<entry>almost Futaba compatible</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>Noritake CU20026SCPB-T</entry>
|
||||
@@ -446,7 +446,7 @@ optional
|
||||
<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>].
|
||||
Portaddress where the LPT is. Used in parallel mode only. Usual values are 0x278, 0x378 and 0x3BC [default: <literal>0x278</literal>].
|
||||
</para></listitem>
|
||||
</varlistentry>
|
||||
|
||||
@@ -456,7 +456,7 @@ optional
|
||||
<parameter><replaceable>DELAY</replaceable></parameter>
|
||||
</term>
|
||||
<listitem><para>
|
||||
Set parallel port timingdelay (us). Used in parallel mode only. [default: <literal>2</literal>; legal: 0 - 255].
|
||||
Set parallel port timing delay (us). Used in parallel mode only. [default: <literal>2</literal>; legal: 0 - 255].
|
||||
</para></listitem>
|
||||
</varlistentry>
|
||||
|
||||
|
||||
@@ -35,7 +35,7 @@ microseconds after writing to the display. If data is written to the display
|
||||
too quickly, it is simply discarded therefore the driver must sleep. The sleep
|
||||
time was experimentally found on a Shuttle M1000 machine and is hard-coded into
|
||||
the driver. This maybe different for other machines and configurations. This
|
||||
may occassionally cause the display to flicker or refresh unevenly across the
|
||||
may occasionally cause the display to flicker or refresh unevenly across the
|
||||
display. It seems that the PT6314 can signal when it has read the data from the
|
||||
buffer, but this functionality is not used.
|
||||
</para>
|
||||
|
||||
@@ -3,7 +3,7 @@
|
||||
|
||||
<para>
|
||||
This section talks about using LCDproc with LCD displays that use the
|
||||
svga chipset.
|
||||
svga library.
|
||||
</para>
|
||||
|
||||
<!-- ## SVGAlib driver ## -->
|
||||
|
||||
@@ -2,8 +2,8 @@
|
||||
<title>The text Driver</title>
|
||||
|
||||
<para>
|
||||
This section talks about using LCDproc with LCD displays that use the
|
||||
text chipset.
|
||||
The text driver simply outputs the content of the internal framebuffer to
|
||||
the current console using printf().
|
||||
</para>
|
||||
|
||||
<!-- ## Text driver ## -->
|
||||
|
||||
@@ -26,7 +26,7 @@ around on the internet:
|
||||
<listitem>
|
||||
<para>
|
||||
LCDproc 0.5.2 is an old stable version of LCDproc.
|
||||
It now has been superseeded with LCDproc 0.5.3.
|
||||
It now has been superseded with LCDproc 0.5.3.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
|
||||
Reference in New Issue
Block a user