doc/rrdbuild.pod

   1 =head1 NAME
   2
   3 rrdbuild - Instructions for building RRDtool
   4
   5 =head1 DESCRIPTION
   6
   7 =head2 Overview
   8
   9 If you downloaded the source of rrdtool you have to compile it. This
  10 document will give some information on how this is done.
  11
  12 RRDtool relies on services of thrid part libraries. Some of these libraries
  13 may already be installed on your system. You have to compile copies of the other
  14 ones before you can build RRDtool.
  15
  16 This document will tell you about all the necessary steps to get going.
  17
  18 =head2 Building
  19
  20 Before you start to build RRDtool, you have to decide two things:
  21
  22 =over
  23
  24 =item 1.
  25
  26 In which directory you want to build the software.
  27
  28 =item 2.
  29
  30 Where you want to install the software.
  31
  32 =back
  33
  34 Once you have decided. Save the two locations into environment variables.
  35 Depending on the shell you are using, you can do either (bash,zsh):
  36
  37  BUILD_DIR=/tmp/rrdbuild
  38  INSTALL_DIR=/usr/local/rrdtool-1.2.12
  39
  40 Or if you run tcsh:
  41
  42  set BUILD_DIR=/tmp/rrdbuild
  43  set INSTALL_DIR=/usr/local/rrdtool-1.2.12
  44
  45 Now make sure the BUILD_DIR exists and go there:
  46
  47  mkdir -p $BUILD_DIR
  48  cd $BUILD_DIR
  49
  50 Lets first assume you already have all the necessary libraries
  51 pre-installed. Note that these instructions assume that your copies of
  52 B<tar> and B<make> are actually B<GNU tar> and B<GNU make> respectively. It
  53 could be that they are installed as B<gtar> and B<gmake> on your system.
  54
  55  wget http://oss.oetiker.ch/rrdtool/pub/rrdtool-1.2.12.tar.gz
  56  tar zxf rrdtool-1.2.12.tar.gz
  57  cd rrdtool-1.2.12
  58  ./configure --prefix=$INSTALL_DIR && make && make install
  59
  60 Ok, this was very optimistic. This try will probably have ended with
  61 B<configure> complaining about several missing libraries. If you are on a
  62 Linux or *bsd system you may want to just install the missing bits from your
  63 software repository. When you do that, make sure you also get the B<-dev>
  64 package for each library you install. Once you have the missing bits on
  65 board, just re-run the last line of the instructions above.
  66
  67 But again this may have been too optimistic, and you actually have to
  68 compile your own copies of the required libraries. Here is how:
  69
  70 =over
  71
  72 =item Building zlib
  73
  74  cd $BUILD_DIR
  75  wget http://oss.oetiker.ch/rrdtool/pub/libs/zlib-1.2.2.tar.gz
  76  tar  zxf zlib-1.2.2.tar.gz
  77  cd zlib-1.2.2
  78  env CFLAGS="-O3 -fPIC" ./configure --prefix=$BUILD_DIR/lb
  79  make
  80  make install
  81
  82 =item Building libpng
  83
  84 Libpng itself requires zlib to build, so we need to help a bit. If you
  85 already have a copy of zlib on your system (which is very likley) you can
  86 drop the settings of LDFLAGS and CPPFLAGS. Note that the backslash (\) at
  87 the end of line 4 means that line 4 and line 5 are on one line.
  88
  89  cd $BUILD_DIR
  90  wget http://oss.oetiker.ch/rrdtool/pub/libs/libpng-1.2.8-config.tar.gz
  91  tar zxvf libpng-1.2.8-config.tar.gz
  92  cd libpng-1.2.8-config
  93  env CPPFLAGS="-I$BUILD_DIR/lb/include" LDFLAGS="-L$BUILD_DIR/lb/lib" CFLAGS="-O3 -fPIC" \
  94      ./configure --disable-shared --prefix=$BUILD_DIR/lb
  95  make
  96  make install
  97
  98 =item Building freetype
  99
 100  cd $BUILD_DIR
 101  wget http://oss.oetiker.ch/rrdtool/pub/libs/freetype-2.1.9.tar.gz
 102  tar zxvf freetype-2.1.9.tar.gz
 103  cd freetype-2.1.9
 104  env CPPFLAGS="-I$BUILD_DIR/lb/include" LDFLAGS="-L$BUILD_DIR/lb/lib" CFLAGS="-O3 -fPIC" \
 105      ./configure --disable-shared --prefix=$BUILD_DIR/lb
 106  make
 107  make install
 108
 109 If you run into problems building freetype on Solaris, you may want to try to
 110 add the following at the end of the configure line:
 111
 112  GNUMAKE=gmake EGREP=egrep
 113
 114 =item Building libart_lgpl
 115
 116  cd $BUILD_DIR
 117  wget http://oss.oetiker.ch/rrdtool/pub/libs/libart_lgpl-2.3.17.tar.gz
 118  tar zxvf libart_lgpl-2.3.17.tar.gz
 119  cd libart_lgpl-2.3.17
 120  env CFLAGS="-O3 -fPIC" ./configure --disable-shared --prefix=$BUILD_DIR/lb
 121  make
 122  make install
 123
 124 =back
 125
 126 Now all the dependent libraries are built and you can try again. Since these
 127 are static libraries, you may have to use F<ranlib> to make them accessible.
 128 Especially BSD systems like Mac OS X may require this, Linux and Solaris
 129 will do just fine without since their F<ar> command does ranlibs job as well.
 130
 131  ranlib $BUILD_DIR/lb/lib/*.a
 132
 133 This time you tell configure where it should be looking for libraries and
 134 include files. This is done via environment variables. Depending on the
 135 shell you are running, the syntax for setting environment variables is
 136 different. Under csh/tcsh you use:
 137
 138  set IR=-I$BUILD_DIR/lb/include
 139  setenv CPPFLAGS "$IR $IR/libart-2.0 $IR/freetype2 $IR/libpng"
 140  setenv LDFLAGS  -L$BUILD_DIR/lb/lib
 141  setenv CFLAGS -O3
 142
 143 If you are running bash/sh/ash/ksh/zsh use this:
 144
 145  IR=-I$BUILD_DIR/lb/include
 146  CPPFLAGS="$IR $IR/libart-2.0 $IR/freetype2 $IR/libpng"
 147  LDFLAGS="-L$BUILD_DIR/lb/lib"
 148  CFLAGS=-O3
 149  export CPPFLAGS LDFLAGS CFLAGS
 150
 151 And finally try building again. We disable the python and tcl bindings
 152 because it seems that a fair number of people have ill configured python and
 153 tcl setups that would prevent rrdtool from building if they are included in
 154 their current state.
 155
 156  cd $BUILD_DIR/rrdtool-1.2.12
 157  ./configure --prefix=$INSTALL_DIR --disable-python --disable-tcl
 158  make clean
 159  make
 160  make install
 161
 162 SOLARIS HINT: if you want to build  the perl module for the native perl (the
 163 one shipping with solaris) you will need the sun forte compiler
 164 installed on your box or you have to hand-tune bindings/perl-shared/Makefile
 165 while building!
 166
 167 Now go to I<$INSTALL_DIR>B</share/rrdtool/examples/> and run them to see if your
 168 build has been successful.
 169
 170 =head1 AUTHOR
 171
 172 Tobias Oetiker E<lt>oetiker@ee.ethz.chE<gt>
 173