Update documentation a little bit to what is currently done. Reformat

configure's driver list more nicely.
This commit is contained in:
mmdolze
2010-11-06 17:42:45 +00:00
parent 2a3f558545
commit 747cf6d80a
3 changed files with 33 additions and 43 deletions
+3 -7
View File
@@ -9,19 +9,15 @@ COMPILE! YOU'VE BEEN WARNED!
*************************************************************** ***************************************************************
With that out of the way, welcome to the bleeding edge of LCDproc. With that out of the way, welcome to the bleeding edge of LCDproc.
To build and run this version, you'll need autoconf 2.50 or higher To build and run this version, you'll need autoconf 2.59 or higher
and friends installed. and friends installed.
Run: Run:
$ sh ./autogen.sh $ sh ./autogen.sh
This produces the configure script and supporting files, and also This produces the configure script and supporting files. Once the above
runs configure with defaults. You want to run configure again with command has run, the rest is pretty standard:
your own options, trust me :) I suspect the default drivers it sets
aren't going to match your setup.
Once the above two commands have run, the rest is pretty standard:
$ ./configure --help $ ./configure --help
[read about the options, figure out what to use] [read about the options, figure out what to use]
+21 -30
View File
@@ -20,8 +20,8 @@ of this file.
In order to compile LCDproc, you'll need the following programs: In order to compile LCDproc, you'll need the following programs:
* An ANSI C compiler, we recommend GCC. Most Linux or BSD systems come * A C compiler which supports C99, we recommend GCC. Most Linux or BSD systems
with GCC. come with GCC.
* GNU Make. It is available for all major distributions. If you want to * 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 . compile it yourself, see http://www.gnu.org/software/make/make.html .
@@ -38,7 +38,7 @@ need some additional programs or libraries installed:
* DocBook XML converter "xmlto" if you want to create the documentation * DocBook XML converter "xmlto" if you want to create the documentation
or Doxygen when used with --enable-doxygen, also see or Doxygen when used with --enable-doxygen, also see
http://cyberelk.net/tim/xmlto/ and http://cyberelk.net/tim/software/xmlto/ and
http://www.stack.nl/~dimitri/doxygen/ http://www.stack.nl/~dimitri/doxygen/
* libusb if you --enable-libusb, see http://libusb.sourceforge.net/ * libusb if you --enable-libusb, see http://libusb.sourceforge.net/
@@ -91,8 +91,6 @@ information:
HD44780 and compatible: HD44780 and compatible:
read the HD44780 section in the LCDproc User's Guide (docs/lcdproc-user) read the HD44780 section in the LCDproc User's Guide (docs/lcdproc-user)
or alternatively see http://www.robijn.net/lcdproc/ or alternatively see http://www.robijn.net/lcdproc/
STV5730: http://www.usblcd.de/lcdproc/
SED1520: http://www.usblcd.de/lcdproc/
If you still have problems you could take a look at the comments in the If you still have problems you could take a look at the comments in the
driver source code in server/drivers/. You may have some good indications driver source code in server/drivers/. You may have some good indications
@@ -122,17 +120,11 @@ Run make to build the server and all clients
If you only want to compile the clients, you can omit to compile the If you only want to compile the clients, you can omit to compile the
server: server:
cd shared make clients
make
cd ../clients
make
Similarly, if you only want to compile the server, you can omit to Similarly, if you only want to compile the server, you can omit to
compile the clients: compile the clients:
cd shared make server
make
cd ../server
make
Depending on your system, LCDproc will build in a few seconds to a Depending on your system, LCDproc will build in a few seconds to a
few minutes. It's not very big. few minutes. It's not very big.
@@ -153,14 +145,14 @@ may use the support files in the LCDproc source tree to create an
installation package specific to your distribution installation package specific to your distribution
Debian: Debian:
- Rename the .tgz file with the sources to lcdproc_VERSION.orig.tar.gz - Rename the .tgz file with the sources to lcdproc_VERSION.orig.tar.gz
cp lcdproc-VERSION.tgz lcdproc_VERSION.orig.tar.gz cp lcdproc-VERSION.tgz lcdproc_VERSION.orig.tar.gz
- Extract the source tar ball - Extract the source tar ball
tar xvzf lcdproc_VERSION.orig.tar.gz tar xvzf lcdproc_VERSION.orig.tar.gz
- Copy the debian/ directory below scripts/ to the root of the - Copy the debian/ directory below scripts/ to the root of the
source tree source tree
cp -a lcdproc-VERSION/scripts/debian lcdproc-VERSION/ cp -a lcdproc-VERSION/scripts/debian lcdproc-VERSION/
- Generate .deb debian package - Generate .deb debian package
cd lcdproc-VERSION/ cd lcdproc-VERSION/
dpkg-buildpackage -rfakeroot -sd dpkg-buildpackage -rfakeroot -sd
cd .. cd ..
@@ -179,16 +171,15 @@ difficulties in porting. Here's are the prerequisites for both:
--- Client --- --- Client ---
The client should run on any POSIX compliant system. The client should run on any POSIX compliant system.
It has been successfully 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, Linux 2.2.x - 2.6.x, FreeBSD 6.x - 8.1, NetBSD 1.5 & 3.x, OpenBSD 3.0,
Darwin and Solaris. Darwin, Solaris and MacOS.
In the future, we want it to run on Windows, MacOS and others.
--- Server --- --- Server ---
The server needs to talk to the LCD display. At this time, it works 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) on very little more than on the Intel i386 (PC Compatible)
architecture. It has been successfully 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, Linux 2.2.x - 2.6.x, FreeBSD 6.x - 8.1, NetBSD 1.5 & 3.x, OpenBSD 3.0,
Darwin and Solaris. Darwin, Solaris and MacOS.
Here are some comments specific to each platform that LCDproc has been Here are some comments specific to each platform that LCDproc has been
tested on. tested on.
@@ -217,7 +208,8 @@ Remember to type gmake instead of make to compile LCDproc.
The server will probably only compile on OpenBSD/i386. The server will probably only compile on OpenBSD/i386.
--- FreeBSD --- --- FreeBSD ---
It should compile fine on i386. It should compile fine on i386. Must be started as root to be able to use
parallel and USB ports.
--- Other platforms --- --- Other platforms ---
If the build process fails, but you do know how to link a loadable If the build process fails, but you do know how to link a loadable
@@ -241,9 +233,6 @@ to do.
If you're in the LCDproc source directory, and have just built it, run: If you're in the LCDproc source directory, and have just built it, run:
server/LCDd -c path/to/config/file server/LCDd -c path/to/config/file
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 For security reasons, LCDd by default only accepts connections from
localhost (127.0.0.1), it will not accept connections from other computers on localhost (127.0.0.1), it will not accept connections from other computers on
your network / the Internet. You can change this behaviour in the your network / the Internet. You can change this behaviour in the
@@ -303,6 +292,8 @@ Redhat / Mandrake:
cp scripts/init-lcdproc.rpm /etc/rc.d/init.d/lcdproc) cp scripts/init-lcdproc.rpm /etc/rc.d/init.d/lcdproc)
- enable the scripts with e.g. linuxconf or create the symlinks manually - enable the scripts with e.g. linuxconf or create the symlinks manually
FreeBSD:
- If you install from the ports collection startup script are
installed by default.
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.
+9 -6
View File
@@ -8,12 +8,15 @@ AC_ARG_ENABLE(drivers,
[ --enable-drivers=<list> compile drivers for LCDs in <list>,] [ --enable-drivers=<list> compile drivers for LCDs in <list>,]
[ which is a comma-separated list of drivers.] [ which is a comma-separated list of drivers.]
[ Possible drivers are:] [ Possible drivers are:]
[ bayrad,CFontz,CFontz633,CFontzPacket,curses,CwLnx,ea65,] [ bayrad,CFontz,CFontz633,CFontzPacket,curses,CwLnx,]
[ EyeboxOne,g15,glcdlib,glk,hd44780,i2500vfd,icp_a106,imon,imonlcd,] [ ea65,EyeboxOne,g15,glcdlib,glk,hd44780,i2500vfd,]
[ IOWarrior,irman,irtrans,joy,lb216,lcdm001,lcterm,lirc,lis,] [ icp_a106,imon,imonlcd,IOWarrior,irman,irtrans,]
[ MD8800,ms6931,mtc_s16209x,MtxOrb,mx5000,NoritakeVFD,picolcd,] [ joy,lb216,lcdm001,lcterm,lirc,lis,MD8800,ms6931,]
[ pyramid,sed1330,sed1520,serialPOS,serialVFD,shuttleVFD,sli,] [ mtc_s16209x,MtxOrb,mx5000,NoritakeVFD,picolcd,]
[ stv5730,SureElec,svga,t6963,text,tyan,ula200,xosd] [ pyramid,sed1330,sed1520,serialPOS,serialVFD,]
[ shuttleVFD,sli,stv5730,SureElec,svga,t6963,text,
[ tyan,ula200,xosd]
[ ]
[ 'all' compiles all drivers;] [ 'all' compiles all drivers;]
[ 'all,!xxx,!yyy' de-selects previously selected drivers], [ 'all,!xxx,!yyy' de-selects previously selected drivers],
drivers="$enableval", drivers="$enableval",