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