doc/rrdbuild.pod

   1 =head1 NAME
   2
   3 rrdbuild - Instructions for building RRDtool
   4
   5 =head1 OVERVIEW
   6
   7 If you downloaded the source of RRDtool you have to compile it. This
   8 document will give some information on how this is done.
   9
  10 RRDtool relies on services of third part libraries. Some of these libraries
  11 may already be installed on your system. You have to compile copies of the other
  12 ones before you can build RRDtool.
  13
  14 This document will tell you about all the necessary steps to get going.
  15
  16 These instructions assume you are using a B<bash> shell. If you use csh/tcsh,
  17 then you can either type F<bash> to switch to bash for the compilation or if
  18 you know what you are doing just replace the export bits with
  19 setenv.
  20
  21 We further assume that your copies of B<tar> and B<make> are actually B<GNU
  22 tar> and B<GNU make> respectively. It could be that they are installed as
  23 B<gtar> and B<gmake> on your system.
  24
  25 =head1 OPTIMISTIC BUILD
  26
  27 Before you start to build RRDtool, you have to decide two things:
  28
  29 =over
  30
  31 =item 1.
  32
  33 In which directory you want to build the software.
  34
  35 =item 2.
  36
  37 Where you want to install the software.
  38
  39 =back
  40
  41 Once you have decided. Save the two locations into environment variables.
  42
  43  BUILD_DIR=/tmp/rrdbuild
  44  INSTALL_DIR=/opt/rrdtool-1.4.3
  45
  46
  47 If your F</tmp> is mounted with the option noexec (RHEL seems todo that) you have to choose
  48 a different directory!
  49
  50 Now make sure the BUILD_DIR exists and go there:
  51
  52  mkdir -p $BUILD_DIR
  53  cd $BUILD_DIR
  54
  55 Lets first assume you already have all the necessary libraries
  56 pre-installed.
  57
  58  wget http://oss.oetiker.ch/rrdtool/pub/rrdtool-1.4.3.tar.gz
  59  gunzip -c rrdtool-1.4.3.tar.gz | tar xf -
  60  cd rrdtool-1.4.3
  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.
  65
  66 =head1 INSTALLING DEPENDENCIES
  67
  68 If your OS lets you install additional packages from a software repository,
  69 you may get away with installing the missing packages. When the packages are
  70 installed, run configure again and try to compile again. Below you find some
  71 hints on getting your OS ready for compiling RRDtool.
  72
  73 Additions to this list are welcome. In general RRDtool should work with the
  74 latest versions of the libraries. The versions listed here are just what was
  75 current when I tested this.
  76
  77 =head2 OpenSolaris 2008.05
  78
  79 Just add a compiler and the gnome development package:
  80
  81  pkg install sunstudioexpress
  82  pkg install SUNWgnome-common-devel
  83
  84 There is a problem with F<cairo.pc> on OpenSolaris. It suggests that
  85 xrender is required for compilation with cairo. This is not true and also
  86 bad since OpenSolaris does not include an F<xrender.pc> file. Use Perl to
  87 fix this:
  88
  89  perl -i~ -p -e 's/(Requires.*?)\s*xrender.*/$1/' /usr/lib/pkgconfig/cairo.pc
  90
  91 Make sure the RRDtool build system finds your new compiler
  92
  93  export PATH=/opt/SunStudioExpress/bin
  94
  95 =head2 Debian / Ubuntu
  96
  97 Use apt-get to make sure you have all that is required. A number
  98 of packages will get added through dependencies.
  99
 100  apt-get install libpango1.0-dev libxml2-dev
 101
 102 =head2 Gentoo
 103
 104 In Gentoo installing RRDtool is really simple you just need to B<emerge
 105 rrdtool>. All dependencies will be handled automatically by the portage
 106 system. The only thing you should care about are USE flags, which allow you
 107 fine tune features RRDtool will be built with. Currently the following USE
 108 flags are available:
 109
 110  doc    - install .html and .txt documentation
 111           into /usr/share/doc/rrdtool-1.x.xx/
 112  perl   - build and install perl language bindings
 113  python - build and install python language bindings
 114  ruby   - build and install ruby language bindings
 115  tcl    - build and install tcl language bindings
 116  rrdcgi - build and install rrdcgi
 117
 118 After you've decided which USE flags you need, set them either in
 119 F<make.conf> or F</etc/portage/package.use> and finally run:
 120
 121  # emerge -va rrdtool
 122
 123 Take a look at Gentoo handbook for further details on how to manage USE
 124 flags: http://www.gentoo.org/doc/en/handbook/handbook-x86.xml?part=2
 125
 126 =head1 BUILDING DEPENDENCIES
 127
 128 But again this may have been too optimistic still, and you actually have to
 129 compile your own copies of some of the required libraries. Things like
 130 libpng and zlib are pretty standard so you will probably have them on your
 131 system anyway. Freetype, Fontinst, Cairo, Pango may be installed, but it is
 132 possible that they are pretty old and thus don't live up to our
 133 expectations, so you may want to compile their latest versions.
 134
 135 =head2 General build tips for AIX
 136
 137 If you are working with AIX, you may find the B<--disable-shared> option
 138 will cause things to break for you. In that case you may have to install the
 139 shared libraries into the RRDtool PREFIX and work with B<--disable-static>
 140 instead.
 141
 142 Another hint to get RRDtool working on AIX is to use the IBM XL C Compiler:
 143
 144  export CC=/usr/vac/bin/cc
 145  export PERLCC=$CC
 146
 147 (Better instructions for AIX welcome!)
 148
 149 =head2 Build Instructions
 150
 151 Some libraries want to know where other libraries are. For this to work,
 152 set the following environment variable
 153
 154  export PKG_CONFIG_PATH=${INSTALL_DIR}/lib/pkgconfig
 155  export PATH=$INSTALL_DIR/bin:$PATH
 156
 157 The above relies on the presence of the F<pkgconfig> program. Below you find instructions
 158 on how to compile pkgconfig.
 159
 160 Since we are compiling libraries dynamically, they must know where to find
 161 each other. This is done by setting an appropriate LDFLAGS. Unfortunately,
 162 the syntax again differs from system to system:
 163
 164 =over
 165
 166 =item Solaris
 167
 168  export LDFLAGS=-R${INSTALL_DIR}/lib
 169
 170 if you are using the Sun Studio/Forte compiler, you may also want to set
 171
 172  CFLAGS="-xO3 -xcode=pic13"   (SPARC)
 173  CFLAGS="-xO3 -Kpic"          (x86)
 174
 175 =item Linux
 176
 177  export LDFLAGS="-Wl,--rpath -Wl,${INSTALL_DIR}/lib"
 178
 179 =item HPUX
 180
 181  export LDFLAGS="+b${INSTALL_DIR}/lib"
 182
 183 =item AIX
 184
 185  export LDFLAGS="-Wl,-blibpath:${INSTALL_DIR}/lib"
 186
 187 =back
 188
 189 If you have GNU make installed and it is not called 'make',
 190 then do
 191
 192  export MAKE=gmake
 193  export GNUMAKE=gmake
 194
 195 otherwise just do
 196
 197  export MAKE=make
 198
 199 =head3 Building pkgconfig
 200
 201 As mentioned above, without pkgconfig the whole build process will be lots
 202 of pain and suffering, so make sure you have a copy on your system. If it is
 203 not available natively, here is how to compile it.
 204
 205  wget http://pkgconfig.freedesktop.org/releases/pkg-config-0.23.tar.gz
 206  gunzip -c pkg-config-0.23.tar.gz | tar xf -
 207  cd pkg-config-0.23
 208  ./configure --prefix=$INSTALL_DIR CFLAGS="-O3 -fPIC"
 209  $MAKE
 210  $MAKE install
 211
 212 After installing pkgconfig in a custom directory, setting up the corresponding
 213 environment variable will be helpful.
 214
 215  export PKG_CONFIG=$INSTALL_DIR/bin/pkg-config
 216
 217 =head3 Building zlib
 218
 219 Chances are very high that you already have that on your system ...
 220
 221  cd $BUILD_DIR
 222  wget http://oss.oetiker.ch/rrdtool/pub/libs/zlib-1.2.3.tar.gz
 223  gunzip -c zlib-1.2.3.tar.gz | tar xf -
 224  cd zlib-1.2.3
 225  ./configure --prefix=$INSTALL_DIR CFLAGS="-O3 -fPIC" --shared
 226  $MAKE
 227  $MAKE install
 228
 229 =head3 Building libpng
 230
 231 Libpng itself requires zlib to build, so we need to help a bit. If you
 232 already have a copy of zlib on your system (which is very likely) you can
 233 drop the settings of LDFLAGS and CPPFLAGS. Note that the backslash (\) at
 234 the end of line 4 means that line 4 and line 5 are on one line.
 235
 236  cd $BUILD_DIR
 237  wget http://oss.oetiker.ch/rrdtool/pub/libs/libpng-1.2.18.tar.gz
 238  gunzip -c libpng-1.2.18.tar.gz | tar xf -
 239  cd libpng-1.2.10
 240  env CFLAGS="-O3 -fPIC" ./configure --prefix=$INSTALL_DIR
 241  $MAKE
 242  $MAKE install
 243
 244 =head3 Building freetype
 245
 246  cd $BUILD_DIR
 247  wget http://oss.oetiker.ch/rrdtool/pub/libs/freetype-2.3.5.tar.gz
 248  gunzip -c freetype-2.3.5.tar.gz | tar xf -
 249  cd freetype-2.3.5
 250  ./configure --prefix=$INSTALL_DIR CFLAGS="-O3 -fPIC"
 251  $MAKE
 252  $MAKE install
 253
 254 If you run into problems building freetype on Solaris, you may want to try to
 255 add the following at the start the configure line:
 256
 257  env EGREP=egrep
 258
 259 =head3 Building LibXML2
 260
 261  cd $BUILD_DIR
 262  wget http://oss.oetiker.ch/rrdtool/pub/libs/libxml2-2.6.32.tar.gz
 263  gunzip -c libxml2-2.6.32.tar.gz | tar xf -
 264  cd libxml2-2.6.32
 265  ./configure --prefix=$INSTALL_DIR CFLAGS="-O3 -fPIC"
 266  $MAKE
 267  $MAKE install
 268
 269 =head3 Building fontconfig
 270
 271 Note that fontconfig has a run time configuration file in INSTALL_DIR/etc you
 272 may want to adjust that so that fontconfig finds the fonts on your system.
 273 Run the fc-cache program to build the fontconfig cache after changing the
 274 config file.
 275
 276  cd $BUILD_DIR
 277  wget http://oss.oetiker.ch/rrdtool/pub/libs/fontconfig-2.4.2.tar.gz
 278  gunzip -c fontconfig-2.4.2.tar.gz   | tar xf -
 279  cd fontconfig-2.4.2
 280  ./configure --prefix=$INSTALL_DIR CFLAGS="-O3 -fPIC" --with-freetype-config=$INSTALL_DIR/bin/freetype-config
 281  $MAKE
 282  $MAKE install
 283
 284 =head3 Building Pixman
 285
 286  cd $BUILD_DIR
 287  wget http://oss.oetiker.ch/rrdtool/pub/libs/pixman-0.10.0.tar.gz
 288  gunzip -c pixman-0.10.0.tar.gz  | tar xf -
 289  cd pixman-0.10.0
 290  ./configure --prefix=$INSTALL_DIR CFLAGS="-O3 -fPIC"
 291  $MAKE
 292  $MAKE install
 293
 294 =head3 Building Cairo
 295
 296  cd $BUILD_DIR
 297  wget http://oss.oetiker.ch/rrdtool/pub/libs/cairo-1.6.4.tar.gz
 298  gunzip -c cairo-1.6.4.tar.gz   | tar xf -
 299  cd cairo-1.6.4
 300  ./configure --prefix=$INSTALL_DIR \
 301     --enable-xlib=no \
 302     --enable-xlib-render=no \
 303     --enable-win32=no \
 304     CFLAGS="-O3 -fPIC"
 305  $MAKE
 306  $MAKE install
 307
 308 When building on Solaris you may want todo
 309
 310  ./configure --prefix=$INSTALL_DIR \
 311     --enable-xlib=no \
 312     --enable-xlib-render=no \
 313     --enable-win32=no \
 314     CFLAGS="-O3 -fPIC -D_POSIX_PTHREAD_SEMANTICS"
 315
 316 =head3 Building Glib
 317
 318  cd $BUILD_DIR
 319  wget http://oss.oetiker.ch/rrdtool/pub/libs/glib-2.15.4.tar.gz
 320  gunzip -c glib-2.15.4.tar.gz  | tar xf -
 321  cd glib-2.15.4
 322  ./configure --prefix=$INSTALL_DIR CFLAGS="-O3 -fPIC"
 323  $MAKE
 324  $MAKE install
 325
 326 =head3 Building Pango
 327
 328  cd $BUILD_DIR
 329  wget http://oss.oetiker.ch/rrdtool/pub/libs/pango-1.21.1.tar.bz2
 330  bunzip2 -c pango-1.21.1.tar.bz2 | tar xf -
 331  cd pango-1.21.1
 332  ./configure --prefix=$INSTALL_DIR CFLAGS="-O3 -fPIC" --without-x
 333  $MAKE
 334  $MAKE install
 335
 336 =head2 Building rrdtool (second try)
 337
 338 Now all the dependent libraries are built and you can try again. This time
 339 you tell configure where it should be looking for libraries and include
 340 files. This is done via environment variables. Depending on the shell you
 341 are running, the syntax for setting environment variables is different.
 342
 343 And finally try building again. We disable the python and tcl bindings
 344 because it seems that a fair number of people have ill configured python and
 345 tcl setups that would prevent RRDtool from building if they are included in
 346 their current state.
 347
 348  cd $BUILD_DIR/rrdtool-1.4.3
 349  ./configure --prefix=$INSTALL_DIR --disable-tcl --disable-python
 350  $MAKE clean
 351  $MAKE
 352  $MAKE install
 353
 354 SOLARIS HINT: if you want to build  the Perl module for the native Perl (the
 355 one shipping with Solaris) you will need the Sun Forte compiler installed on
 356 your box or you have to hand-tune bindings/perl-shared/Makefile while
 357 building!
 358
 359 Now go to I<$INSTALL_DIR>B</share/rrdtool/examples/> and run them to see if
 360 your build has been successful.
 361
 362 =head1 AUTHOR
 363
 364 Tobias Oetiker E<lt>tobi@oetiker.chE<gt>
 365