started updating for 1.2 release
[rrdtool.git] / README
diff --git a/README b/README
index 47f727f..02e9c21 100644 (file)
--- a/README
+++ b/README
@@ -14,7 +14,7 @@ values collected over a definable time period.
 To compile:
 -----------
 
-  you need the following libraries installed on your system.
+you need the following libraries installed on your system.
 
    cgilib-0.5.tar.gz
    freetype-2.1.5.tar.gz
@@ -22,22 +22,25 @@ To compile:
    libpng-1.2.5.tar.gz
    zlib-1.2.1.tar.gz
 
-  you can either get these libraries directly from their original sites
-  or you can get copies from 
+you can either get these libraries directly from their original sites
+or you can get copies from 
 
    http://people.ee.ethz.ch/~oetiker/webtools/rrdtool/pub/libs
 
-  if the libraries are not installed in standard places you may need
-  to set CPPFLAGS and LDFLAGS accordingly. This will be improved in further
-  editions of this developers series. Here is an example call.
+the configure program will try to use the libraries with out adding any extra
+flags apart from the ones defined in CPPFLAGS and LDFLAGS. If this does not
+work it will try to get information from pkgconfig.
+
+If your libraries are not installed in standard places and you do not have
+pkgconfig support, then you may want to set CPPFLAGS and LDFLAGS to help
+configure while it tries to find the libraries.
 
   env CPPFLAGS="-I/scratch/oetiker/cgilib-0.5 \
-                -I/scratch/oetiker/lib/include/libart-2.0 \
-                -I/scratch/oetiker/lib/include \
-                -I/scratch/oetiker/lib/include/freetype2" \
-       LDFLAGS="-L/scratch/oetiker/lib/lib -R/scratch/oetiker/lib/lib \
-                -L/scratch/oetiker/cgilib-0.5" \
-      ./configure --prefix=/scratch/oetiker/lib
+                -I/scratch/oetiker/libs/include/libart-2.0 \
+                -I/scratch/oetiker/libs/include \
+                -I/scratch/oetiker/libs/include/freetype2" \
+       LDFLAGS="-L/scratch/oetiker/libs/lib -R/scratch/oetiker/libs/lib \
+                -L/scratch/oetiker/cgilib-0.5" ./configure 
 
   make             <------ GNU make
 
@@ -47,9 +50,9 @@ This will configure, compile and install RRDtool in
 /usr/local/rrdtool-VERSION. If you prefer to install RRDtool in some other
 place, use
 
-  sh configure --prefix=/some/other/RRDtool-dir
+  ./configure --prefix=/some/other/RRDtool-dir
 
-The configure script will try to find your perl installation (5.004
+The configure script will try to find your perl installation (5.008
 preferred). If it does not find it, you can still build RRDtool but no perl
 modules will be generated.
 
@@ -58,13 +61,14 @@ directory. This will require you to use a 'use lib' statement in your
 RRDtool perl programs. If you do not care what happens to your site-perl
 directory, you can also use
 
-  make site-perl-install
+   --enable-perl-site-install 
 
-this will install the perl modules whereever you keep your local perl
-modules. Doing this reliefs you from using 'use lib' in your scripts.
+when running configure to have the RRD perl modules installed  wherever you
+keep your local perl modules. Doing this reliefs you from using 'use lib' in
+your scripts.
 
 Configure will also look for an TCL installation on your system. If it finds
-one it will build a TCL interface for rrdtool. If you keep tcl in a non
+one it will build a TCL interface for RRDtool. If you keep tcl in a non
 standard location you can use
 
   sh configure --with-tcllib=/sw/tcl-8.3/lib
@@ -72,8 +76,8 @@ standard location you can use
 to indicte the right version (note, this must point to the directory where
 tclConfig.sh is located). Note that install will integrate the tcl bindings
 into your tcl installation. It will use a separate directory for each
-version though, so this is not much of a problem. Never the less the TCL
-module will not get intalled by default as TCL wants its module in the base
+version though, so this is not much of a problem. Nevertheless the Tcl
+module will not get intalled by default as Tcl wants its module in the base
 tcl installation where you might not be able to write to. So if you want the
 tcl stuff installed, type
 
@@ -133,7 +137,7 @@ Use GNU   diff --unified --recursive olddir newdir   to build your patches.
 
 The latest Version:
 -------------------
-Is available from http://people.ee.ethz.ch/~oetiker/webtools/rrdtool/
+Is available from http://people.ee.ethz.ch/oetiker/webtools/rrdtool/
 
 
 Tobias Oetiker <oetiker@ee.ethz.ch>