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.99907080300
  39
  40 Or if you run tcsh:
  41
  42  set BUILD_DIR=/tmp/rrdbuild
  43  set INSTALL_DIR=/usr/local/rrdtool-1.2.99907080300
  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.99907080300.tar.gz
  59  tar zxf rrdtool-1.2.99907080300.tar.gz
  60  cd rrdtool-1.2.99907080300
  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 =head3 Build Tipps for 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 =head2 Building Libraries
  88
  89 In order to build the libraries you need a compiler on your system.
  90 Unfortunately compilers are not all alike. This has an effect on the CFLAGS
  91 you want to set. The examples below are for the popular GCC compiler suite.
  92 If you have an other compile you have to use the following settings:
  93
  94 =over
  95
  96 =item Sun Forte
  97
  98  CFLAGS="-xO3 -kPIC"
  99
 100 =back
 101
 102 =over
 103
 104 =item Building zlib
 105
 106 Chances are very high that you already have that on your system ...
 107
 108  cd $BUILD_DIR
 109  wget http://oss.oetiker.ch/rrdtool/pub/libs/zlib-1.2.3.tar.gz
 110  tar  zxf zlib-1.2.3.tar.gz
 111  cd zlib-1.2.3
 112  env CFLAGS="-O3 -fPIC" ./configure --prefix=$BUILD_DIR/lb
 113  make
 114  make install
 115
 116 =item Building libpng
 117
 118 Libpng itself requires zlib to build, so we need to help a bit. If you
 119 already have a copy of zlib on your system (which is very likley) you can
 120 drop the settings of LDFLAGS and CPPFLAGS. Note that the backslash (\) at
 121 the end of line 4 means that line 4 and line 5 are on one line.
 122
 123  cd $BUILD_DIR
 124  wget http://oss.oetiker.ch/rrdtool/pub/libs/libpng-1.2.18.tar.gz
 125  tar zxvf libpng-1.2.18.tar.gz
 126  cd libpng-1.2.10
 127  env CPPFLAGS="-I$BUILD_DIR/lb/include" LDFLAGS="-L$BUILD_DIR/lb/lib" CFLAGS="-O3 -fPIC" \
 128      ./configure --disable-shared --prefix=$BUILD_DIR/lb
 129  make
 130  make install
 131
 132 =item Building freetype
 133
 134  cd $BUILD_DIR
 135  wget http://oss.oetiker.ch/rrdtool/pub/libs/freetype-2.3.5.tar.gz
 136  tar zxvf freetype-2.3.5.tar.gz
 137  cd freetype-2.3.5
 138  env CPPFLAGS="-I$BUILD_DIR/lb/include" LDFLAGS="-L$BUILD_DIR/lb/lib" CFLAGS="-O3 -fPIC" \
 139      ./configure --disable-shared --prefix=$BUILD_DIR/lb
 140  make
 141  make install
 142
 143 If you run into problems building freetype on Solaris, you may want to try to
 144 add the following at the end of the configure line:
 145
 146  GNUMAKE=gmake EGREP=egrep
 147
 148 =item Building fontconfig
 149
 150 Note that fontconfig has a runtime configuration file in INSTALL_DIR/etc you
 151 may want to adjust that so that fontconfig finds the fonts on your system.
 152 Run the fc-cache program to build the fontconfig cache after changeing the
 153 config file.
 154
 155  cd $BUILD_DIR
 156  wget http://oss.oetiker.ch/rrdtool/pub/libs/fontconfig-2.4.2.tar.gz
 157  tar zxvf fontconfig-2.4.2.tar.gz
 158  cd fontconfig-2.4.2
 159  env CFLAGS="-O3 -fPIC" ./configure --prefix=$INSTALL_DIR
 160  make
 161  make install
 162
 163 =item Building Cairo
 164
 165  cd $BUILD_DIR
 166  wget http://oss.oetiker.ch/rrdtool/pub/libs/cairo-1.4.10.tar.gz
 167  tar zxvf cairo-1.4.10.tar.gz
 168  cd cairo-1.4.10
 169  env CFLAGS="-O3 -fPIC" ./configure --prefix=$INSTALL_DIR \
 170     --enable-xlib=no \
 171     --enable-xlib-render=no \
 172     --enable-win32=no
 173  make
 174  make install
 175
 176 =item Building Glib
 177
 178  cd $BUILD_DIR
 179  wget http://oss.oetiker.ch/rrdtool/pub/libs/glib-2.12.13.tar.gz
 180  tar zxvf glib-2.12.13.tar.gz
 181  cd glib-2.12.13
 182  env CFLAGS="-O3 -fPIC" ./configure --prefix=$INSTALL_DIR
 183  make
 184  make install
 185
 186 =item Building Pango
 187
 188  cd $BUILD_DIR
 189  wget http://oss.oetiker.ch/rrdtool/pub/libs/pango-1.17.5.tar.gz
 190  tar zxvf pango-1.17.5.tar.gz
 191  cd pango-1.17.5
 192  env CFLAGS="-O3 -fPIC" ./configure --prefix=$INSTALL_DIR
 193  make
 194  make install
 195
 196 =back
 197
 198 Now all the dependent libraries are built and you can try again. Since these
 199 are static libraries, you may have to use F<ranlib> to make them accessible.
 200 Especially BSD systems like Mac OS X may require this, Linux and Solaris
 201 will do just fine without since their F<ar> command does ranlibs job as well.
 202
 203  ranlib $BUILD_DIR/lb/lib/*.a
 204
 205 This time you tell configure where it should be looking for libraries and
 206 include files. This is done via environment variables. Depending on the
 207 shell you are running, the syntax for setting environment variables is
 208 different. Under csh/tcsh you use:
 209
 210  set IR="-I$BUILD_DIR/lb/include -I$INSTALL_DIR/include"
 211  setenv CPPFLAGS "$IR"
 212  setenv LDFLAGS -L$BUILD_DIR/lb/lib
 213  setenv CFLAGS -O3
 214
 215 If you are running bash/sh/ash/ksh/zsh use this:
 216
 217  IR="-I$BUILD_DIR/lb/include -I$INSTALL_DIR/include"
 218  CPPFLAGS="$IR"
 219  LDFLAGS="-L$BUILD_DIR/lb/lib -R$INSTALL_DIR/lib -L$INSTALL_DIR/lib"
 220  CFLAGS=-O3
 221  export CPPFLAGS LDFLAGS CFLAGS
 222
 223 And finally try building again. We disable the python and tcl bindings
 224 because it seems that a fair number of people have ill configured python and
 225 tcl setups that would prevent rrdtool from building if they are included in
 226 their current state.
 227
 228  cd $BUILD_DIR/rrdtool-1.2.99907080300
 229  ./configure --prefix=$INSTALL_DIR --disable-tcl
 230  make clean
 231  make
 232  make install
 233
 234 SOLARIS HINT: if you want to build  the perl module for the native perl (the
 235 one shipping with solaris) you will need the sun forte compiler
 236 installed on your box or you have to hand-tune bindings/perl-shared/Makefile
 237 while building!
 238
 239 Now go to I<$INSTALL_DIR>B</share/rrdtool/examples/> and run them to see if your
 240 build has been successful.
 241
 242 =head1 AUTHOR
 243
 244 Tobias Oetiker E<lt>tobi@oetiker.chE<gt>
 245