$Id: README,v 1.19 2003/04/08 13:40:51 carri Exp $
$Source: /cvsroot/lwatch/files/README,v $

Log Watcher - tool for log watching and colorize.
http://sf.net/projects/lwatch/

Installation procedure: see INSTALL
Bug reporting: see BUGS
Feature request: see TODO.

Regular expression support is provided by the PCRE library package,
which is an open source software, written by Philip Hazel, copyright
by the University of Cambridge, England.

PCRE library is available at:
ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre/

For me it works with libpcre 3.4.

This package uses autotools. You can change all paths and directories
running configure with proper options.
Path and directories changes should be propagated into documentation
and binary. If not, please submit a bug (see BUGS for details).

If you want to use CVS snapshot you need autoconf 2.57.
Automake 1.7 is not necessary. You may safely ignore messages about the 
lack of it as long as Makefile.am, acinclude.m4 and configure.ac are not
modified.

System manual has been written in SGML DocBook. You need some kind (any)
docbook->man converter to generate proper manual page. For now, configure
supports docbook-to-man available at:
http://www.oasis-open.org/docbook/tools/dtm/docbook-to-man.tar.gz

docbook2man from docbook-utils are not supported and I am not sure
if I will.

Log Watcher uses getopt_long function. Some unices have it included
in libc (specially glibc based ones), some have it in other libraries
and some do not have it. If you use one of the two last flavors of 
unices, please inform me how you compiled/linked lwatch.

In most cases (assuming, that you have the required libriaries)
    ./configure
    make
    make install
should work. If not, you can set following environment variables:
 - CPPFLAGS specifies additional directories where headers files are searched
 - LDFLAGS specifies additional directories where libraries are searched
 - LIBS specifies additional libraries which lwatch should be linked with

If you have includes/libraries in non-standard directories you can run
(for example):
CPPFLAGS="-I/opt/include" LDFLAGS="-L/opt/lib" ./configure
CPPFLAGS="-I/opt/include" LDFLAGS="-L/opt/lib" make
make install

If you have non-standard library which contains (i.e.) getopt_long run:
LIBS="-lgnugetopt" ./configure
LIBS="-lgnugetopt" make

Set also CPPFLAGS and LDFLAGS if needed

Default input file is /dev/lwatch. You can change it running:
configure --enable-input=/other/file
What do you think about adding proper entries into syslog/syslog-ng
configuration file during package installation?

If you add this piece of software into any distribution as a package do me
a favour and, please, send me an email notice about it. You can find my email
address in AUTHORS file.

============================================
OS specific information
============================================

* Cygwin
Bartek Tomczak told me that lwatch compiles and runs on cygwin without
any problemes. You can contact him at xinu@blabluga.hell.pl

* FreeBSD
Install libgnugetopt (1.2 works for me)
Use `gmake' instead of `make'

* Linux on i386
No additional packages required.

* Linux on other architectures
No experiences. Feedback mostly welcomed.

* Solaris - not tested
Read following resources:
http://sources.redhat.com/ml/automake/2000-08/msg00013.html
http://sunfreeware.com/programlistsparc8.html#libiberty
install libiberty and try:
LIBS="-liberty" CPPFLAGS="-I/usr/local/include" LDFLAGS="-L/usr/local/lib" ./configure
LIBS="-liberty" CPPFLAGS="-I/usr/local/include" LDFLAGS="-L/usr/local/lib" make
make install
and, please, notify me if it works.

* MS Windows
There is no native Windows port for lwatch. If you want to use it under MS Win
install Cygwin from http://www.cygwin.com/ and read a note about Cygwin in this
README.

* Other OS
I have no shell access to any other platforms. Any feedback about compiling
and running lwatch on them is greatly appreciated.
