aboutsummaryrefslogtreecommitdiffstats
path: root/README
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--README15
-rw-r--r--README.Drivers24
-rw-r--r--README.Text31
3 files changed, 58 insertions, 12 deletions
diff --git a/README b/README
index 4d014ce..0ce7f46 100644
--- a/README
+++ b/README
@@ -1,5 +1,5 @@
#
-# $Id: README,v 1.14 2001/03/08 15:25:38 ltoetsch Exp $
+# $Id: README,v 1.15 2001/03/09 13:08:11 ltoetsch Exp $
#
This is the README file for lcd4linux
@@ -8,7 +8,8 @@ This is the README file for lcd4linux
INTRODUCTION
lcd4linux is a small program that reads various information from the kernel
-(and probably from other subsystems, especially ISDN) and displays them on a LCD.
+(and probably from other subsystems, especially ISDN) and displays them on a
+LCD.
It supports displaying text values and different types of bars: Horizontal and
vertical bars, logarithmic bars, split bars (two independent bars in one row).
@@ -34,6 +35,14 @@ lcd4linux [-c key=val] [-F] [-f config-file] [-o output] [-q] [-v]
suppress startup splash screen with '-q'
generate info messages with '-v'
generate debugging messages with '-vv'
+
+DIAGNOSTICS
+
+ lcd4linux on foreground writes (depending on level) to stdout or stderr.
+ The Text-Driver has ist's own diagnostics window.
+
+ Started in the background (the default), lcd4linux uses your syslog daemon
+ for logging. Facility is USER, levels are ERR, INFO and DEBUG.
SUPPORTED DISPLAYS
@@ -78,6 +87,8 @@ SUPPORTED DISPLAYS
PPM (portable pixmap)
PNG (with libgd)
+* Text:
+ This is a ncurses based text driver, mainly intended for debugging.
* other displays: lcd4linux and especially the display driver code is very
modular, so it should be quite easy to write a driver for any display. See
diff --git a/README.Drivers b/README.Drivers
index 1e8ce49..98628ec 100644
--- a/README.Drivers
+++ b/README.Drivers
@@ -1,5 +1,5 @@
#
-# $Id: README.Drivers,v 1.3 2000/05/21 06:20:35 reinelt Exp $
+# $Id: README.Drivers,v 1.4 2001/03/09 13:08:11 ltoetsch Exp $
#
How to write new display drivers for lcd4linux
@@ -7,9 +7,13 @@ How to write new display drivers for lcd4linux
If you plan to write a new display driver for lcd4linux, you should follow
this guidelines:
-* use Skeleton.c as a start point
+* use Skeleton.c as a start point.
+ You might also have a look at Text.c
-* create a new sourcefile <drivername>.c and add it to the bottom of Makefile.am
+* create a new sourcefile <drivername>.c and add it to the bottom of
+ Makefile.am
+
+* add an entry to configure.in
* there's no need for a <drivername>.h
@@ -45,10 +49,10 @@ this guidelines:
{ "" }
};
-* write the correspondig init(), clear(), put(), bar() and flush()-functions.
- There's no need to use a framebuffer and display its contents with the flush()-
- call (as in MatrixOrbital.c), you can directly write to the display in the put()-
- and bar()-functions, and use an empty flush()-function. But if you have a limited
- number of user-defined characters, and therefore you have to do some sort of
- 'character reduction' or similar stuff, you will have to use a framebuffer and
- the flush()-call.
+* write the correspondig init(), clear(), put(), bar(), quit() and
+ flush()-functions. There's no need to use a framebuffer and display its
+ contents with the flush()- call (as in MatrixOrbital.c), you can directly
+ write to the display in the put()- and bar()-functions, and use an empty
+ flush()-function. But if you have a limited number of user-defined
+ characters, and therefore you have to do some sort of 'character reduction'
+ or similar stuff, you will have to use a framebuffer and the flush()-call.
diff --git a/README.Text b/README.Text
new file mode 100644
index 0000000..77d419d
--- /dev/null
+++ b/README.Text
@@ -0,0 +1,31 @@
+#
+# $Id: README.Text,v 1.1 2001/03/09 13:08:11 ltoetsch Exp $
+#
+
+This is the README file for the Text display driver for lcd4linux.
+
+This driver is mainly for debugging purposes.
+It needs ncurses for display.
+
+The driver understands the following options:
+
+Display: must be "Text"
+size: [columns]x[rows], e.g. "20x4"
+TextBar: if this is set, Bars display the values max, len1 and len2.
+
+Of course, lcd4linux should be started in the foreground with this driver.
+The driver shows also a window with lcd4linux's diagnostics.
+
+Example:
+./lcd4linux -q -vv -F -cDisplay=Text -ctick=1000 -ctack=1000
+
+
+BUGS:
+- A resize of the term window messes up the display.
+- Vertical bars are not supported.
+- BAR_L is ignored.
+
+Have fun
+ -lt
+
+