prepare for the release of rrdtool-1.4.2

[rrdtool.git] / doc / rrdbuild.pod

diff --git a/doc/rrdbuild.pod b/doc/rrdbuild.pod
index f292ab8..8de70c8 100644 (file)
--- a/doc/rrdbuild.pod
+++ b/doc/rrdbuild.pod
@@ -4,7 +4,7 @@ rrdbuild - Instructions for building RRDtool
 
 =head1 OVERVIEW
 
-If you downloaded the source of rrdtool you have to compile it. This
+If you downloaded the source of RRDtool you have to compile it. This
 document will give some information on how this is done.
 
 RRDtool relies on services of third part libraries. Some of these libraries
@@ -41,7 +41,7 @@ Where you want to install the software.
 Once you have decided. Save the two locations into environment variables.
 
  BUILD_DIR=/tmp/rrdbuild
- INSTALL_DIR=/usr/local/rrdtool-1.3.2
+ INSTALL_DIR=/opt/rrdtool-1.4.2
 
 
 If your F</tmp> is mounted with the option noexec (RHEL seems todo that) you have to choose
@@ -55,9 +55,9 @@ Now make sure the BUILD_DIR exists and go there:
 Lets first assume you already have all the necessary libraries
 pre-installed. 
 
- wget http://oss.oetiker.ch/rrdtool/pub/rrdtool-1.3.2.tar.gz
- gunzip -c rrdtool-1.3.2.tar.gz | tar xf -
- cd rrdtool-1.3.2
+ wget http://oss.oetiker.ch/rrdtool/pub/rrdtool-1.4.2.tar.gz
+ gunzip -c rrdtool-1.4.2.tar.gz | tar xf -
+ cd rrdtool-1.4.2
  ./configure --prefix=$INSTALL_DIR && make && make install
 
 Ok, this was very optimistic. This try will probably have ended with
@@ -68,9 +68,11 @@ B<configure> complaining about several missing libraries.
 If your OS lets you install additional packages from a software repository,
 you may get away with installing the missing packages. When the packages are
 installed, run configure again and try to compile again. Below you find some
-hints on getting your OS ready for the rrdtool compilation.
+hints on getting your OS ready for compiling RRDtool.
 
-Additions to this list are welcome.
+Additions to this list are welcome. In general RRDtool should work with the
+latest versions of the libraries. The versions listed here are just what was
+current when I tested this.
 
 =head2 OpenSolaris 2008.05
 
@@ -86,7 +88,7 @@ fix this:
 
  perl -i~ -p -e 's/(Requires.*?)\s*xrender.*/$1/' /usr/lib/pkgconfig/cairo.pc 
 
-Make sure rrdtool finds your new compiler
+Make sure the RRDtool build system finds your new compiler
 
  export PATH=/opt/SunStudioExpress/bin
 
@@ -106,10 +108,10 @@ of packages will get added through dependencies.
 
 =head2 Gentoo
 
-In Gentoo installing rrdtool is really simple you just need to B<emerge
+In Gentoo installing RRDtool is really simple you just need to B<emerge
 rrdtool>. All dependencies will be handled automatically by the portage
 system. The only thing you should care about are USE flags, which allow you
-fine tune features rrdtool will be built with. Currently the following USE
+fine tune features RRDtool will be built with. Currently the following USE
 flags are available:
 
  doc    - install .html and .txt documentation
@@ -141,10 +143,10 @@ expectations, so you may want to compile their latest versions.
 
 If you are working with AIX, you may find the B<--disable-shared> option
 will cause things to break for you. In that case you may have to install the
-shared libraries into the rrdtool PREFIX and work with B<--disable-static>
+shared libraries into the RRDtool PREFIX and work with B<--disable-static>
 instead.
 
-Another hint to get rrdtool working on AIX is to use the IBM XL C Compiler:
+Another hint to get RRDtool working on AIX is to use the IBM XL C Compiler:
 
  export CC=/usr/vac/bin/cc
  export PERLCC=$CC
@@ -214,6 +216,11 @@ not available natively, here is how to compile it.
  $MAKE
  $MAKE install
 
+After installing pkgconfig in a custom directory, setting up the corresponding
+environment variable will be helpful.
+
+ export PKG_CONFIG=$INSTALL_DIR/bin/pkg-config
+
 =head3 Building zlib
 
 Chances are very high that you already have that on your system ... 
@@ -259,9 +266,9 @@ add the following at the start the configure line:
 =head3 Building LibXML2
 
  cd $BUILD_DIR
- wget http://oss.oetiker.ch/rrdtool/pub/libs/libxml2-sources-2.6.31.tar.gz
- gunzip -c libxml2-sources-2.6.31.tar.gz | tar xf -
- cd libxml2-sources-2.6.31
+ wget http://oss.oetiker.ch/rrdtool/pub/libs/libxml2-2.6.32.tar.gz
+ gunzip -c libxml2-2.6.32.tar.gz | tar xf -
+ cd libxml2-2.6.32
  ./configure --prefix=$INSTALL_DIR CFLAGS="-O3 -fPIC"
  $MAKE
  $MAKE install
@@ -277,7 +284,7 @@ config file.
  wget http://oss.oetiker.ch/rrdtool/pub/libs/fontconfig-2.4.2.tar.gz
  gunzip -c fontconfig-2.4.2.tar.gz   | tar xf -
  cd fontconfig-2.4.2
- ./configure --prefix=$INSTALL_DIR CFLAGS="-O3 -fPIC"
+ ./configure --prefix=$INSTALL_DIR CFLAGS="-O3 -fPIC" --with-freetype-config=$INSTALL_DIR/bin/freetype-config
  $MAKE
  $MAKE install
 
@@ -318,8 +325,8 @@ config file.
 =head3 Building Pango
 
  cd $BUILD_DIR
- wget http://oss.oetiker.ch/rrdtool/pub/libs/pango-1.21.1.tar.gz
- gunzip -c pango-1.21.1.tar.gz  | tar xf -
+ wget http://oss.oetiker.ch/rrdtool/pub/libs/pango-1.21.1.tar.bz2
+ bunzip2 -c pango-1.21.1.tar.bz2 | tar xf -
  cd pango-1.21.1
  ./configure --prefix=$INSTALL_DIR CFLAGS="-O3 -fPIC" --without-x
  $MAKE
@@ -334,10 +341,10 @@ are running, the syntax for setting environment variables is different.
 
 And finally try building again. We disable the python and tcl bindings
 because it seems that a fair number of people have ill configured python and
-tcl setups that would prevent rrdtool from building if they are included in
+tcl setups that would prevent RRDtool from building if they are included in
 their current state.
 
- cd $BUILD_DIR/rrdtool-1.3.2
+ cd $BUILD_DIR/rrdtool-1.4.2
  ./configure --prefix=$INSTALL_DIR --disable-tcl --disable-python
  $MAKE clean
  $MAKE