[lcd4linux @ 2003-07-28 08:22:17 by reinelt]

several README's moved to web page

9 files changed, 0 insertions, 474 deletions

diff --git a/README.Crystalfontz b/README.Crystalfontz
deleted file mode 100644
index 4c76b45..0000000
--- a/README.Crystalfontz
+++ /dev/null
@@ -1,44 +0,0 @@
-
-This is the README file for the Crystalfontz display driver for lcd4linux
-
-This driver supports the 632/634 LCD-Modules from Crystalfontz, but should
-work for the 626 and 636 modules too. The 634 is a 20x4 character display,
-while the others only display 16x2. I've written the driver using a
-634 module.
-
-The driver understands the following configuration parameters:
-
-Display:    any of 626, 632, 634 and 636.
-
-Port:	    serial device (i.e. ttyS0) the LCD module is connnected
-            to.
-
-Speed:      any of 1200, 2400, 9600 and 19200. By default, the driver
-            uses 9600 which is the speed the LCD modules are hardwired
-            at. If your module works at a different speed than 9600,
-            use this parameter. Otherwise omit it (i.e. omit it when
-            you have a 634).
-
-Backlight:  controls the backlight brightness. Quote from 634.pdf from
-            the Crystalfonts-Webserver[1]: "0=OFF 100=ON. Intermediate
-            values vary the brightness. There are a total of 25 possible
-            brightness levels."
-
-Contrast:   controls the contrast settings. Quote[1]: "0=very light,
-            100 = very dark. 50 is typical. There are a total of 25
-            possible contrast levels."
-
-
-Known bugs:
-When you draw a bar over a previously drawn textfield, the white portion
-the bar will not erase the text. Only when the black portion of the bar
-has reached the full bar length, the text will be erased. I did not bother
-to implement that, since in lcd4linux, the whole display-screen is erased
-prior to switching to a different 'screen'. Implementing this feature would
-just add to program-overhead. Yes, you guessed it: I did not use the "bar"-
-command that comes with the LCD-module, but wrote my own instead.
-lcd4linux also supports "split-" or "dual-bars" (two bars in one segment),
-which are not available on the Crystalfontz firmware.
-
-  [1] http://www.crystalfontz.com
-
diff --git a/README.HD44780 b/README.HD44780
deleted file mode 100644
index 5fb762e..0000000
--- a/README.HD44780
+++ /dev/null
@@ -1,124 +0,0 @@
-#
-# $Id: README.HD44780,v 1.3 2001/03/14 15:14:59 reinelt Exp $
-#
-
-This is the README file for the HD44780 display driver for lcd4linux
-
-This driver supports all display modules based on the Hitachi HD44780 chip.
-These displays are made by different manufactures, and come in various sizes.
-
-At least the following types are known to work:
-
-DataVision DV16244: 2 lines by 16 characters
-Nan Ya NLC 08x2x06: 2 lines by  8 characters 
-
-The displays are connected to the parallel board (see Wiring below), and are quite timing-critical.
-There's no way to delay a usermode program under Linux for e.g. 40 usec, so we have to do 
-busy-waiting. This is done in a delay loop, which had to be calibrated (see Configuration below).
-Since 0.98 there are two new delay loops, one based on the processor's TSC (Time Stamp Counter),
-one based on gettimeofday(). lcd4linux decides automatically which one to use (it prefers the
-TSC method, but falls back to gettimeofday() if neither the tsc flag nor the MHz value is set 
-in /proc/cpuinfo).
-
-The driver knows of two ways of controlling the parallel port: The (old, ugly and unportable) raw
-programming of ports, and the new, cool, great ppdev() style. You decide which one to use by 
-specifying either a hexadecimal value or a device file with the 'Port' entry in the config file.
-
-Note that the old port programming only works with standard ports (0x3f8, 2f8,...), but not 
-with PCI parallel port cards.
-
-ppdev requires kernel 2.4. The configure script detects if you have the required include files, 
-and deactivates ppdev if they are not there.
-
-You should use ppdev whenever possible. Raw port access may be dropped someday. 
-
-
-The driver supports vertical, horizontal and split bars (two independent bars in one line),
-all bar types can be used simultanously. As the displays only have 8 user-defined characters,
-the needed characters to display all the bars must be reduced to 8. This is done by replacing
-characters with similar ones. To reduce flicker, a character which is displayed at the moment,
-will not be redefined, even if it's not used in this run. Only if the character compaction 
-fails, this characters will be redefined, too.
-
-
-Configuration:
-
-The driver needs the following entries in lcd4linux.conf:
-
-Display: HD44780
-
-Port: either the hexadecimal address of the parallel port (e.g. 0x378)
-      or a ppdev device (e.g. /dev/parports/0)
-
-Size: [columns]x[rows] e.g. "16x2"
-
-
-#ifdef USE_OLD_UDELAY
-
-Delay: calibration of the delay loop, loops per microsecond
-       THIS IS NO LONGER NECESSARY!
-
-It is very important to use a correct delay value, otherwise you will get only junk on the
-display. lcd4linux has a switch '-d' where it helps you to find the correct value. Run
-'lcd4linux -d' several times on a otherwise idle machine, and use the maximum value. If you
-encounter display problems, increase this value. But don't take it too big, lcd4linux will get
-slow, and you're burning CPU cycles.
-
-The delay value is defined by your CPU model and clock frequency (it looks like it's your 
-'BogoMips' value divided by 2, because we use a similar delay loop than the kernel does). 
-Here are some examples:
-
-Pentium MMX, 133 MHz,  106 BogoMips:   54
-Pentium MMX, 166 MHz,  333 BogoMips:  166
-Celeron,     333 MHz,  333 BogoMips:  166
-Pentium III, 600 MHz,  600 BogoMips:  300
-AMD Athlon  1010 MHz, 2012 BogoMips:  505 
-
-#endif
-
-
-Wiring:
-
-There are two basic wiring modes for HD44780-Displays: a 4 bit mode (used by lcdproc) and a 
-8 bit mode (used by most other packages). At the moment we only support the 8 bit mode, but
-I'm working on the 4 bit mode, too.
-
-The main difference is that the 8 bit mode transfers one byte at a time, but the HD44780 needs 
-some control signals, so some of the parallel port control lines are used for this. The 4 bit
-mode uses only 4 bits for data (so a byte has to be transferred in two cycles), but you can use 
-the other 4 bits for the control signals.
-
-Normally a HD44780-based display have 14 or 16 pins, where pins 15 and 16 are used for backlight.
-Power (+5V) must be supplied via pins 1 and 2, be careful not to change polarity, you will 
-destroy your display! Pin 3 is used to control the contrast, you can either hardwire it to GND
-(pin 1) or place a potentiometer (10k-20k) between pins 1 and 2, and connect pin 3 to the slider.
-
-Note that the data bits are called DB0..DB7 on the display, but DB1..DB8 on the parallel port!
-
-Here comes the wiring diagram for the 8 bit mode:
-
---- Display ---        --- DB25 ---            --- comment ---
-Name        Pin        Pin     Name
-
-GND           1        18      GND             GND of power supply, too!
-+5V           2        -                       power supply only
-LCD drive     3        -                       see above
-RS            4        14      Auto Feed       register select, 0=data, 1=command
-R/W           5        18      GND             hardwired to 0, write data only
-Enable        6         1      Strobe          toggled when data is valid
-DB0           7         2      DB1             data bit 0
-DB1           8         3      DB2             data bit 1
-DB2           9         4      DB3             data bit 2
-DB3          10         5      DB4             data bit 3
-DB4          11         6      DB5             data bit 4
-DB5          12         7      DB6             data bit 5
-DB6          13         8      DB7             data bit 6
-DB7          14         9      DB8             data bit 7
-+5V          15         -                      power for backlight
-GND          16         -                      power for backlight
-                        10-13  not connected
-                        15-17  not connected
-                        19-25  not connected
-
-
-Wiring diagram for 4 bit mode: soon to come!
diff --git a/README.HD44780.GPO b/README.HD44780.GPO
deleted file mode 100644
index 20c65e0..0000000
--- a/README.HD44780.GPO
+++ /dev/null
@@ -1,46 +0,0 @@
-#
-# $Id: README.HD44780.GPO,v 1.3 2001/09/07 05:58:44 reinelt Exp $
-#
-
-Erweiterung der LCD Anzeige um 8 Ausgaenge (GPOs)
-
-Man braucht:
-1 Stk. 74HC573
-1 Stk. ULN2803
-8 Stk. RES 330R
-8 Stk. LED rot 3mm
-
-Schaltplan:
-Die Schaltung wird parallel zum Display angeschlossen. 
-INIT ist Pin 16 vom LPT am Rechner.
----|330r|--- das soll ein Widerstand 330 Ohm sein, 
-             man kann aber auch 470 Ohm nehmen.
-  ---|<---   das soll ein LED sein.
-    Vcc      Versorgungsspannung 5V DC
-    GND      Masse
-
-
-           74HC573
-        ______  ______              ULN2803
-        |    |__|    |           ______  ______
- GND o--|1         20|---+ Vcc   |    |__|    |
-  D0 o--|2         19|-----------|1         18|----|330r|---|<---+ Vcc
-  D1 o--|3         18|-----------|2         17|----|330r|---|<---+ Vcc
-  D2 o--|4         17|-----------|3         16|----|330r|---|<---+ Vcc
-  D3 o--|5         16|-----------|4         15|----|330r|---|<---+ Vcc
-  D4 o--|6         15|-----------|5         14|----|330r|---|<---+ Vcc
-  D5 o--|7         14|-----------|6         13|----|330r|---|<---+ Vcc
-  D6 o--|8         13|-----------|7         12|----|330r|---|<---+ Vcc
-  D7 o--|9         12|-----------|8         11|----|330r|---|<---+ Vcc
-INIT o--|11        10|--o GND o--|9         10|----+ Vcc
-        --------------           --------------
-	
-Statt der LED's kann man auch was anderes ansteuern. Der ULN2803 hat eine 
-Open Kollektor Ausgang, der mit 30V belastet werden kann. Aber Vorsicht!!!
-
-Die gesammte Schaltung nimmt max. ca. 130mA an 5V DC auf, ich nehme die 
-Spannung vom Gameport. Bei mir klappts, ich uebernehme aber keine Garantie.
-
-Wuppertal, den 13.02.2001
-
-Carsten Nau
diff --git a/README.MatrixOrbital b/README.MatrixOrbital
deleted file mode 100644
index a8e889c..0000000
--- a/README.MatrixOrbital
+++ /dev/null
@@ -1,53 +0,0 @@
-#
-# $Id: README.MatrixOrbital,v 1.2 2000/03/22 07:33:50 reinelt Exp $
-#
-
-This is the README file for the MatrixOrbital display driver for lcd4linux
-
-This driver supports the serial interface alphanumeric display modules by
-Matrix Orbital Corporation (http://www.matrixorbital.com).
-
-I could only test it with the LCD2041 model, but I think every other (LCD) model 
-should work. These displays are supported:
-
-  LCD0821: 2 lines by  8 characters
-  LCD1621: 2 lines by 16 characters
-  LCD2021: 2 lines by 20 characters
-  LCD2041: 4 lines by 20 characters (tested)
-  LCD4021: 2 lines by 40 characters
-
-I could not test the vacuum fluorescent display models, but I think they should work, too.
-There are no entries for this models in the driver table (at the bottom of MatrixOrbital.c),
-but they could be easily added.
-
-The displays come with an RS-232 and an I2C interface. The driver supports the RS-232 interface
-only (because I have no idea how to find the I2C bus on my motherboard). 
-
-Power can be applied either via an external DC power supply, a modified floppy power connector
-(be aware that you can destroy your display if you get the pins wrong!) or via the RI (ring) 
-signal of the RS-232 port. I choosed the latter, and modified a serial card so that it supplies 
-+5V from the ISA bus to this pin (again, be aware that this is dangerous if you connect any other 
-serial device to this modified port).
-
-The driver supports vertical, horizontal and split bars (two independent bars in one line),
-all bar types can be used simultanously. As the displays only have 8 user-defined characters,
-the needed characters to display all the bars must be reduced to 8. This is done by replacing
-characters with similar ones. To reduce flicker, a character which is displayed at the moment,
-will not be redefined, even if it's not used in this run. Only if the character compaction 
-fails, this characters will be redefined, too.
-
-The displays have a GPO (general purpose output), where you can connect a LED or something. 
-The driver supports controlling this GPO, but this function is unused by now.
-
-
-Configuration:
-
-The driver needs/supports the following entries in lcd4linux.conf:
-
-Display: a valid Matrix Orbital Display name (e.g. "LCD2041")
-Port: serial device the display is attached to (e.g. /dev/ttyS2)
-Speed: the baud rate from the display (configured via jumpers) must match 
-       this value. Possible values are 1200, 2400, 9600 and 19200
-Contrast: sets the LCD display contrast to a level between 0 (light) 
-          and 256 (dark). Default value: 160
-
diff --git a/README.Png b/README.Png
deleted file mode 100644
index 5005918..0000000
--- a/README.Png
+++ /dev/null
@@ -1,47 +0,0 @@
-#
-# $Id: README.Png,v 1.1 2001/03/02 18:06:18 reinelt Exp $
-#
-
-This is the README file for the Png display driver for lcd4linux.
-
-Preliminarys: libgd, libpng, libz
-Optional: perl, apache
-
-The driver creates the output file specified with the -o switch. The
-parameter is used as a format string for sprintf(), if you specify '%d'
-in the output file, files with a sequence number will be created.
-
-The output file is first created with a '.tmp' extension, this temporary
-file will be written and closed, and finally (atomically) renamed. This way
-you can be shure that you will always get a complete file, but its contents
-changes every 'tick' milliseconds. 
-
-Configuration:
-
-The driver needs/supports the following entries in lcd4linux.conf:
-
-Display: must be "Png"
-size: [columns]x[rows], e.g. "20x4"
-font: [xrex]x[yres], at the moment only "5x8" and "6x8" supported.
-pixel: [pixelsize]+[pixelgap], e.g. "5+1"
-gap: [row gap]x[column gap], e.g. "3x3"
-border: border width
-foreground: color of an active LCD Pixel, must be #rrggbb
-halfground: color of an inactive LCD Pixel, must be #rrggbb
-background: backlight color, must be #rrggbb
-
-For details please look into README.Raster.
-
-To display this png file continuosly in a web page, follow these instructions:
-Copy the sample png.html to an appropriate place under your htdocs.
-Copy the sample nph-png perl script into your cgi-bin directory, and adjust
-png.html to contain this directory.
-Adjust nph-png to contain the path/filename of the outputfile (s -o above).
-Start lcd4linux -o path/filename.png.
-If you are on a slow connection to your webserver you might also adjust the
-$DELAY in nph-png or in lcd4linux.conf.
-
-Note: depending on your webervers configuration, you must rename nph-png to
-   nph-png.pl or npg-png.cgi.
-
-Have fun.
diff --git a/README.Raster b/README.Raster
deleted file mode 100644
index 2c01fe3..0000000
--- a/README.Raster
+++ /dev/null
@@ -1,51 +0,0 @@
-#
-# $Id: README.Raster,v 1.3 2001/03/04 15:01:12 ltoetsch Exp $
-#
-
-This is the README file for the Raster display driver for lcd4linux
-
-This driver is intended to create various raster formats, at the moment 
-there is support for binary PPM (portable pixmap) and PNG.
-
-The driver creates the output file(s) specified with the -o switch. The
-parameter is used as a format string for sprintf(), if you specify '%d'
-in the output file, files with a sequence number will be created.
-
-The output file is first created with a '.tmp' extension, this temporary
-file will be written and closed, and finally (atomically) renamed. This way
-you can be shure that you will always get a complete file, but its contents
-changes every 'tick' milliseconds. 
-
-Configuration:
-
-The driver needs/supports the following entries in lcd4linux.conf:
-
-Display: must be either "PPM" or "PNG"
-size: [columns]x[rows], e.g. "20x4"
-font: [xrex]x[yres], at the moment only "5x8" and "6x8" supported.
-pixel: [pixelsize]+[pixelgap], e.g. "5+1"
-gap: [row gap]x[column gap], e.g. "3x3"
-border: border width
-foreground: color of an active LCD Pixel, must be #rrggbb
-halfground: color of an inactive LCD Pixel, must be #rrggbb
-background: backlight color, must be #rrggbb
-
-This may look weird, but it is weird. Let's explain this a bit further:
-The raster driver tries to emulate a real LC display. A real LCD has a
-size of columns*rows characters. Each character consists of xres*yres 
-LCD cells. One single cell will be represented by a rectangle of
-pixelsize*pixelsize pixels. If you want to, you can emulate the gap 
-between this lcd cells by specifying a pixelgap greater than zero.
-Sometimes there's a gap between characters, too. You can specify this 
-gap (in pixels again) horizontally and vertically. Usually this gap
-is the same size as a cell (which is pixelsize+pixelgap). If you specify
-either the row gap or the column gap as -1, this cell size will be used
-instead.
-
-If you use a font of 5x8, some characters may use the first and the last 
-pixel. So you should specify a column gap, otherwise the caracters may 
-touch. On the other hand, the 6x8 font never uses the first pixel. So you 
-can omit the column gap, and will get the same text layout, but 
-uninterupted bars!
-
-After all: don't try to understand this unless you have tried it out!
diff --git a/README.Text b/README.Text
deleted file mode 100644
index 465f0d3..0000000
--- a/README.Text
+++ /dev/null
@@ -1,33 +0,0 @@
-#
-# $Id: README.Text,v 1.2 2001/03/16 09:28:08 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. In this window
-CR and LF are displayed as underscores.
-
-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
-
-
diff --git a/README.Webinterface b/README.Webinterface
deleted file mode 100644
index 0f87dff..0000000
--- a/README.Webinterface
+++ /dev/null
@@ -1,29 +0,0 @@
-
-Prerequisits:
-
-- libgd (I used 1.81 for testing), which needs libpng and libz.
-    Get it from http://www.boutell.com/gd/
-- apache, perl, netscape (I don't know, if other browsers can display
-    server pushed images)
-
-The PNG driver in Raster is able to generate PNG-Images.
-
-To display this png file continuously in a web page, follow these instructions:
-Copy the sample png.html to an appropriate place under your htdocs.
-Copy the sample nph-png perl script into your cgi-bin directory, and adjust
-png.html to contain this directory.
-Adjust nph-png to contain the path/filename of the outputfile (s. -o option
-in README.Raster or 'lcd4linux -h').
-Start 'lcd4linux -o /path/filename.png'.
-
-If you are on a slow connection to your webserver you might also adjust the
-$DELAY in nph-png or the tick/tack in lcd4linux.conf.
-
-Note: depending on your webservers configuration, you must rename nph-png to
-   nph-png.pl or npg-png.cgi.
-
-
-Please send correction, additions, questions & donations to
-Leopold Toetsch <lt@toetsch.at>
-
-Have fun.
diff --git a/README.X11 b/README.X11
deleted file mode 100644
index 0fb3dbf..0000000
--- a/README.X11
+++ /dev/null
@@ -1,47 +0,0 @@
-#
-# $Id: README.X11,v 1.3 2003/02/18 06:13:44 reinelt Exp $
-#
-
-This is the README file for the X11 display driver for lcd4linux
-
-The driver opens a X11 window based on the geometry specified in the
-config file. This window cannot be resized. The contents of the window
-will be redrawn every 'tick' msec.
-
-The driver uses very low cpu time, and requires low bandwitdh, because 
-only modified pixels are redrawn.
-
-
-Configuration:
-
-The driver needs/supports the following entries in lcd4linux.conf:
-
-Display: must be "X11"
-size: [columns]x[rows], e.g. "20x4"
-font: [xrex]x[yres], at the moment only "5x8" and "6x8" supported.
-pixel: [pixelsize]+[pixelgap], e.g. "5+1"
-gap: [row gap]x[column gap], e.g. "3x3"
-border: border width
-foreground: color of an active LCD Pixel, must be #rrggbb
-halfground: color of an inactive LCD Pixel, must be #rrggbb
-background: backlight color, must be #rrggbb
-
-This may look weird, but it is weird. Let's explain this a bit further:
-The X11 driver tries to emulate a real LC display. A real LCD has a
-size of columns*rows characters. Each character consists of xres*yres 
-LCD cells. One single cell will be represented by a rectangle of
-pixelsize*pixelsize pixels. If you want to, you can emulate the gap 
-between this lcd cells by specifying a pixelgap greater than zero.
-Sometimes there's a gap between characters, too. You can specify this 
-gap (in pixels again) horizontally and vertically. Usually this gap
-is the same size as a cell (which is pixelsize+pixelgap). If you specify
-either the row gap or the column gap as -1, this cell size will be used
-instead.
-
-If you use a font of 5x8, some characters may use the first and the last 
-pixel. So you should specify a column gap, otherwise the caracters may 
-touch. On the other hand, the 6x8 font never uses the first pixel. So you 
-can omit the column gap, and will get the same text layout, but 
-uninterupted bars!
-
-After all: don't try to understand this unless you have tried it out!