From cb31c7b975aa990b16690d855a31f0aa84c954d8 Mon Sep 17 00:00:00 2001 From: marschap Date: Mon, 2 Oct 2006 11:14:15 +0000 Subject: [PATCH] add extension by Robert buchholz with soem changes --- INSTALL | 101 ++++++++++++++++++++++++++++++++++++++++---------------- 1 file changed, 73 insertions(+), 28 deletions(-) diff --git a/INSTALL b/INSTALL index 9c109c6..13c5ad2 100644 --- a/INSTALL +++ b/INSTALL @@ -7,6 +7,7 @@ make And if you start wondering why it doesn't work, come back and read the rest of the file. 8) + -- PREREQUISITES ----------------------------------------------------- First read the README if you haven't already. @@ -14,21 +15,61 @@ First read the README if you haven't already. Please take a few minutes to read the user guide located at http://lcdproc.sourceforge.net/docs/ -For the details on supported platforms, see the PLAFORM SPECIFIC section +For the details on supported platforms, see the PLATFORM SPECIFIC section of this file. In order to compile LCDproc, you'll need the following programs: -an ANSI C compiler, we recommend GCC. Most Linux or BSD systems come -with GCC. +* An ANSI C compiler, we recommend GCC. Most Linux or BSD systems come + with GCC. -GNU Make. It is available for all major distributions. If you want to -compile it yourself, see http://www.gnu.org/software/make/make.html . +* GNU Make. It is available for all major distributions. If you want to + compile it yourself, see http://www.gnu.org/software/make/make.html . + +* The GNU autotools, that is automake and autoconf. They are only required + if you want to build LCdproc directory from CVS. + The GNU autotools are available for all major distributions. If you want + to compile them yourself, see + http://www.gnu.org/software/autoconf/ and + http://www.gnu.org/software/automake/. + +Depending on the ./configure options and your choice of drivers, you will +need some additional programs or libraries installed: + +* DocBook if you want to create the documentation or Doxygen when used with + --enable-doxygen, also see + http://sources.redhat.com/docbook-tools/ and + http://www.stack.nl/~dimitri/doxygen/ + +* OpenLDAP if you --enable-ldap, see http://www.openldap.org/software/ + Please note that OpenlDAP support is currently very experimental. + +* libusb if you --enable-libusb, see http://libusb.sourceforge.net/ + +* G15daemon, libg15 and libg15render for use with the 'g15' driver, see + http://g15daemon.sourceforge.net/ and http://g15tools.sourceforge.net/ + +* GraphLCD and GLCDprocDriver for use with the 'glcdlib' driver, see + http://graphlcd.berlios.de/ and http://www.muresan.de/graphlcd/lcdproc/ + +* libirman for use with the 'irman' driver, see + http://www.evation.com/libirman/libirman.html for the home page and + http://www.lirc.org/software/snapshots/ for current downloads + +* LIRC for use with the 'lirc' driver, see http://www.lirc.org/ + +* ncurses for use with the 'curses' driver, see + http://www.gnu.org/software/ncurses/ + +* svgalib for use with the 'svga' driver, see http://www.svgalib.org/ + +* libftdi and libusb for use with the 'ula200' driver, see + http://www.intra2net.com/de/produkte/opensource/ftdi/ and + http://libusb.sourceforge.net/ + +* XOSD for use with the 'xosd' driver, see http://www.ignavus.net/software.html , + as well as an x11 implementation, more precisely libX11 and libXext. -The GNU autotools, that is automake and autoconf. It is available for -all major distributions. If you want to compile it yourself, see -http://sources.redhat.com/automake/ and -http://sources.redhat.com/autoconf/ . -- DISPLAYS ----------------------------------------------------------- @@ -45,10 +86,10 @@ should be in a directory that is indicated by the DriverPath= line in the configfile. Depending on what kind of LCD display that you have, there are several -sources for informations. If your LCD display came with a manual, this +sources for information. If your LCD display came with a manual, this is a great place to start. If you don't have a manual, then you must find out what kind of display this is, and check the related -informations: +information: HD44780 and compatible: read the HD44780 section in the LCDproc User's Guide (docs/lcdproc-user) @@ -99,7 +140,7 @@ compile the clients: Depending on your system, LCDproc will build in a few seconds to a few minutes. It's not very big. -If you want, you can install it (if you're root) by typing: +If you want to, you can install it (if you're root) by typing: make install This will install the binaries and the man pages in the directory you @@ -107,6 +148,7 @@ specified in configure. You may have to copy the configuration file (LCDd.conf) to /etc (or /usr/local/etc) manually. + -- CREATING DISTRIBUTION SPECIFIC PACKAGES -------------------------- Instead of manually configuring, compiling and installing LCDproc you @@ -118,27 +160,28 @@ Debian: cp lcdproc-VERSION.tgz lcdproc_VERSION.orig.tar.gz - Extract the source tar ball tar xvzf lcdproc_VERSION.orig.tar.gz - - Copy the debian/ directory below scripts/ to the rouut of the + - Copy the debian/ directory below scripts/ to the root of the source tree cp -a lcdproc-VERSION/scripts/debian lcdproc-VERSION/ - Generate .deb debian package cd lcdproc-VERSION/ - dpkg-buildpackage -rfakleroot -sd + dpkg-buildpackage -rfakeroot -sd cd .. This creates a file named lcdproc_VERSION-RELEASE_ARCH.deb that contains the LCDproc suite as a regular Debian package. - + + -- PLATFORM SPECIFIC ------------------------------------------------ The lcdproc crew has tried to support a number of platforms. Platforms -that are very non-standard are not and will probably never be supported. -Both server & drivers and clients have their own difficulties in -porting. Here's are the prerequistes for both: +that are very non-standard are not and probably will never be supported. +Both, the server with its drivers and the clients, have their own +difficulties in porting. Here's are the prerequisites for both: --- Client --- The client should run on any POSIX compliant system. -It has been sucessfully tested on: +It has been successfully tested on: Linux 2.2.x - 2.6.x, FreeBSD 4.x & 5.x, NetBSD 1.5 & 3.x, OpenBSD 3.0, Darwin and Solaris. In the future, we want it to run on Windows, MacOS and others. @@ -146,7 +189,7 @@ In the future, we want it to run on Windows, MacOS and others. --- Server --- The server needs to talk to the LCD display. At this time, it works on very little more than on the Intel i386 (PC Compatible) -architecture. It has been sucessfully tested on: +architecture. It has been successfully tested on: Linux 2.2.x - 2.6.x, FreeBSD 4.x & 5.x, NetBSD 1.5 & 3.x, OpenBSD 3.0, Darwin and Solaris. @@ -181,11 +224,12 @@ It should compile fine on i386. --- Other platforms --- If the build process fails, but you do know how to link a loadable -module by hand, you can add the appropriate flags etcetera into +module by hand, you can add the appropriate flags et cetera into acinclude.m4. Experience required. Please let us know if you got it working on a previously unsupported system, so we can include it in a next release. + -- RUNNING LCDPROC ----------------------------------------------------- --- Configuration file --- @@ -200,27 +244,28 @@ to do. If you're in the LCDproc source directory, and have just built it, run: server/LCDd -c path/to/config/file -You can find out what drivers were compiled by running "LCDd -h". +You can find out which drivers were compiled by running "LCDd -h". Note that you cannot use more than one display driver at the same time. For security reasons, LCDd by default only accepts connections from localhost (127.0.0.1), it will not accept connections from other computers on -your network / the Internet. You can change this behavior in the +your network / the Internet. You can change this behaviour in the configuration file. --- Starting the client(s) --- Then, you'll need some clients. LCDproc comes with a few, of which the 'lcdproc' client is the main client: - clients/lcdproc/lcdproc -d C M T L + clients/lcdproc/lcdproc -f C M T L This will run the LCDproc client, with the [C]pu, [M]emory, -[T]ime, and [L]oad screens. The option "-d" icauses it to daemonize right -after startup. +[T]ime, and [L]oad screens. The option "-f" causes it not to daemonizei, +but run in the foreground. By default, the client tries to connect to a server located on localhost and listening to port 13666. To change this, use the -s and -p options. + -- PUTTING LCDPROC IN SYSTEM STARTUP ----------------------------------- It's nice to have LCDproc start when the computer boots, so here's how @@ -238,7 +283,7 @@ Slackware: /usr/local/bin/lcdproc C M X & Debian: (the hard way) - - Copy (as root) the debian init script from the scripts/ direcory of the + - Copy (as root) the debian init script from the scripts/ directory of the sources to /etc/init.d (cp scripts/init-LCDd.debian /etc/init.d/LCDd && \ cp scripts/init-lcdproc.debian /etc/init.d/lcdproc) @@ -262,5 +307,5 @@ Redhat / Mandrake: - enable the scripts with e.g. linuxconf or create the symlinks manually -That's all the OS`s we've actually done this with so far.. +That's all the OS's we've actually done this with so far.