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.13
  39
  40 Or if you run tcsh:
  41
  42  set BUILD_DIR=/tmp/rrdbuild
  43  set INSTALL_DIR=/usr/local/rrdtool-1.2.13
  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.13.tar.gz
  56  tar zxf rrdtool-1.2.13.tar.gz
  57  cd rrdtool-1.2.13
  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.
  69
  70 =head2 Building on AIX
  71
  72 If you are woking with AIX, you may find the the B<--disable-shared> option
  73 will cause things to break for you. In that case you may have to install the
  74 shared libraries into the rrdtool PREFIX and work with B<--disable-static>
  75 instead.
  76
  77 Another hint to get rrdtool working on AIX is to use the IBM XL C Compiler:
  78
  79  export CC=/usr/vac/bin/cc
  80  export PERLCC=$CC
  81
  82 (Better instructions for AIX welcome!)
  83
  84 =over
  85
  86 =head2 Building Libraries
  87
  88 =item Building zlib
  89
  90  cd $BUILD_DIR
  91  wget http://oss.oetiker.ch/rrdtool/pub/libs/zlib-1.2.3.tar.gz
  92  tar  zxf zlib-1.2.3.tar.gz
  93  cd zlib-1.2.2
  94  env CFLAGS="-O3 -fPIC" ./configure --prefix=$BUILD_DIR/lb
  95  make
  96  make install
  97
  98 =item Building libpng
  99
 100 Libpng itself requires zlib to build, so we need to help a bit. If you
 101 already have a copy of zlib on your system (which is very likley) you can
 102 drop the settings of LDFLAGS and CPPFLAGS. Note that the backslash (\) at
 103 the end of line 4 means that line 4 and line 5 are on one line.
 104
 105  cd $BUILD_DIR
 106  wget http://oss.oetiker.ch/rrdtool/pub/libs/libpng-1.2.8-config.tar.gz
 107  tar zxvf libpng-1.2.10.tar.gz
 108  cd libpng-1.2.10
 109  env CPPFLAGS="-I$BUILD_DIR/lb/include" LDFLAGS="-L$BUILD_DIR/lb/lib" CFLAGS="-O3 -fPIC" \
 110      ./configure --disable-shared --prefix=$BUILD_DIR/lb
 111  make
 112  make install
 113
 114 =item Building freetype
 115
 116  cd $BUILD_DIR
 117  wget http://oss.oetiker.ch/rrdtool/pub/libs/freetype-2.1.10.tar.bz2
 118  tar jxvf freetype-2.1.10.tar.bz2
 119  cd freetype-2.1.10
 120  env CPPFLAGS="-I$BUILD_DIR/lb/include" LDFLAGS="-L$BUILD_DIR/lb/lib" CFLAGS="-O3 -fPIC" \
 121      ./configure --disable-shared --prefix=$BUILD_DIR/lb
 122  make
 123  make install
 124
 125 If you run into problems building freetype on Solaris, you may want to try to
 126 add the following at the end of the configure line:
 127
 128  GNUMAKE=gmake EGREP=egrep
 129
 130 =item Building libart_lgpl
 131
 132  cd $BUILD_DIR
 133  wget http://oss.oetiker.ch/rrdtool/pub/libs/libart_lgpl-2.3.17.tar.gz
 134  tar zxvf libart_lgpl-2.3.17.tar.gz
 135  cd libart_lgpl-2.3.17
 136  env CFLAGS="-O3 -fPIC" ./configure --disable-shared --prefix=$BUILD_DIR/lb
 137  make
 138  make install
 139
 140 =back
 141
 142 Now all the dependent libraries are built and you can try again. Since these
 143 are static libraries, you may have to use F<ranlib> to make them accessible.
 144 Especially BSD systems like Mac OS X may require this, Linux and Solaris
 145 will do just fine without since their F<ar> command does ranlibs job as well.
 146
 147  ranlib $BUILD_DIR/lb/lib/*.a
 148
 149 This time you tell configure where it should be looking for libraries and
 150 include files. This is done via environment variables. Depending on the
 151 shell you are running, the syntax for setting environment variables is
 152 different. Under csh/tcsh you use:
 153
 154  set IR=-I$BUILD_DIR/lb/include
 155  setenv CPPFLAGS "$IR $IR/libart-2.0 $IR/freetype2 $IR/libpng"
 156  setenv LDFLAGS  -L$BUILD_DIR/lb/lib
 157  setenv CFLAGS -O3
 158
 159 If you are running bash/sh/ash/ksh/zsh use this:
 160
 161  IR=-I$BUILD_DIR/lb/include
 162  CPPFLAGS="$IR $IR/libart-2.0 $IR/freetype2 $IR/libpng"
 163  LDFLAGS="-L$BUILD_DIR/lb/lib"
 164  CFLAGS=-O3
 165  export CPPFLAGS LDFLAGS CFLAGS
 166
 167 And finally try building again. We disable the python and tcl bindings
 168 because it seems that a fair number of people have ill configured python and
 169 tcl setups that would prevent rrdtool from building if they are included in
 170 their current state.
 171
 172  cd $BUILD_DIR/rrdtool-1.2.13
 173  ./configure --prefix=$INSTALL_DIR --disable-python --disable-tcl
 174  make clean
 175  make
 176  make install
 177
 178 SOLARIS HINT: if you want to build  the perl module for the native perl (the
 179 one shipping with solaris) you will need the sun forte compiler
 180 installed on your box or you have to hand-tune bindings/perl-shared/Makefile
 181 while building!
 182
 183 Now go to I<$INSTALL_DIR>B</share/rrdtool/examples/> and run them to see if your
 184 build has been successful.
 185
 186 =head1 AUTHOR
 187
 188 Tobias Oetiker E<lt>tobi@oetiker.chE<gt>
 189