[Lcdproc] Installation documentation improvement
Robert Buchholz
rob@thetruth.de
Mon Oct 2 01:38:01 2006
This is a multi-part message in MIME format.
--------------030709040606080005080808
Content-Type: text/plain; charset=ISO-8859-1
Content-Transfer-Encoding: 7bit
Hi,
after being encouraged by Peter Marschall, I decided to document the
things I learned about software depencencies of lcdproc in the last
weeks and update the INSTALL file accordingly.
Besides some line spacing changes and typo fixes, there's an expanded
section on "prerequisites" needed to compile certian functions and
drivers. If I missed something, please let me know. Any other comments
are welcome, too.
I am mostly uncertain about what happens when using USB driven devices,
but using --disable-libusb. Don't they work at all or is libusb used anyway?
Bye,
Robert
--------------030709040606080005080808
Content-Type: text/x-patch;
name="INSTALL.patch"
Content-Transfer-Encoding: 7bit
Content-Disposition: inline;
filename="INSTALL.patch"
--- INSTALL.orig 2006-10-01 17:13:22.000000000 +0200
+++ INSTALL 2006-10-02 03:31:04.000000000 +0200
@@ -7,6 +7,7 @@
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,58 @@
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 .
+
+* 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/ .
+
+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/
+
+* 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
-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 .
+* 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 +83,10 @@
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 +137,7 @@
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 +145,7 @@
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 +157,28 @@
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 +186,7 @@
--- 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 +221,12 @@
--- 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,12 +241,12 @@
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) ---
@@ -215,12 +256,13 @@
clients/lcdproc/lcdproc -d 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 "-d" causes it to daemonize right
+after start-up.
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 +280,7 @@
/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 +304,5 @@
- 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.
--------------030709040606080005080808--