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