program/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=/usr/local/rrdtool-1.3.2
  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.3.2.tar.gz
  59  gunzip -c rrdtool-1.3.2.tar.gz | tar xf -
  60  cd rrdtool-1.3.2
  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 the rrdtool compilation.
  72
  73 Additions to this list are welcome.
  74
  75 =head2 OpenSolaris 2008.05
  76
  77 Just add a compiler and the gnome development package:
  78
  79  pkg install sunstudioexpress
  80  pkg install SUNWgnome-common-devel
  81
  82 There is a problem with F<cairo.pc> on opensolaris. It suggests that
  83 xrender is required for compilation with cairo. This is not true and also
  84 bad since opensolaris does not include an F<xrender.pc> file. Use perl to
  85 fix this:
  86
  87  perl -i~ -p -e 's/(Requires.*?)\s*xrender.*/$1/' /usr/lib/pkgconfig/cairo.pc
  88
  89 Make sure rrdtool finds your new compiler
  90
  91  export PATH=/opt/SunStudioExpress/bin
  92
  93 Since there does not seem to ba a viable msgfmt tool on opensolaris (short
  94 of installing it yourself). You have to call configure with the
  95
  96  --disable-libintl
  97
  98 option.
  99
 100 =head2 Debian / Ubuntu
 101
 102 Use apt-get to make sure you have all that is required. A number
 103 of packages will get added through dependencies.
 104
 105  apt-get install libpango1.0-dev libxml2-dev
 106
 107 =head2 Gentoo
 108
 109 In Gentoo installing rrdtool is really simple you just need to B<emerge
 110 rrdtool>. All dependencies will be handled automatically by the portage
 111 system. The only thing you should care about are USE flags, which allow you
 112 fine tune features rrdtool will be built with. Currently the following USE
 113 flags are available:
 114
 115  doc    - install .html and .txt documentation
 116           into /usr/share/doc/rrdtool-1.x.xx/
 117  perl   - build and install perl language bindings
 118  python - build and install python language bindings
 119  ruby   - build and install ruby language bindings
 120  tcl    - build and install tcl language bindings
 121  rrdcgi - build and install rrdcgi
 122
 123 After you've decided which USE flags you need, set them either in
 124 F<make.conf> or F</etc/portage/package.use> and finally run:
 125
 126  # emerge -va rrdtool
 127
 128 Take a look at Gentoo handbook for further details on how to manage USE
 129 flags: http://www.gentoo.org/doc/en/handbook/handbook-x86.xml?part=2
 130
 131 =head1 BUILDING DEPENDENCIES
 132
 133 But again this may have been too optimistic still, and you actually have to
 134 compile your own copies of some of the required libraries. Things like
 135 libpng and zlib are pretty standard so you will probably have them on your
 136 system anyway. Freetype, Fontinst, Cairo, Pango may be installed, but it is
 137 possible that they are pretty old and thus don't live up to our
 138 expectations, so you may want to compile their latest versions.
 139
 140 =head2 General build tips for AIX
 141
 142 If you are working with AIX, you may find the the B<--disable-shared> option
 143 will cause things to break for you. In that case you may have to install the
 144 shared libraries into the rrdtool PREFIX and work with B<--disable-static>
 145 instead.
 146
 147 Another hint to get rrdtool working on AIX is to use the IBM XL C Compiler:
 148
 149  export CC=/usr/vac/bin/cc
 150  export PERLCC=$CC
 151
 152 (Better instructions for AIX welcome!)
 153
 154 =head2 Build Instructions
 155
 156 In order to build rrdtool need a compiler on your system. Unfortunately
 157 compilers are not all alike. This has an effect on the CFLAGS you want to
 158 set. The examples below are for the popular GCC compiler suite. If you have
 159 an other compilers here are some ides:
 160
 161 =over
 162
 163 =item Sun Forte
 164
 165  CFLAGS="-xO3 -kPIC"
 166
 167 =back
 168
 169 Some libraries want to know where other libraries are. For this to work,
 170 set the following environment variable
 171
 172  export PKG_CONFIG_PATH=${INSTALL_DIR}/lib/pkgconfig
 173  export PATH=$INSTALL_DIR/bin:$PATH
 174
 175 The above relies on the presence of the F<pkgconfig> program. Below you find instructions
 176 on how to compile pkgconfig.
 177
 178 Since we are compiling libraries dynamically, they must know where to find
 179 each other. This is done by setting an appropriate LDFLAGS. Unfortunately,
 180 the syntax again differs from system to system:
 181
 182 =over
 183
 184 =item Solaris
 185
 186  export LDFLAGS=-R${INSTALL_DIR}/lib
 187
 188 =item Linux
 189
 190  export LDFLAGS="-Wl,--rpath -Wl,${INSTALL_DIR}/lib"
 191
 192 =item HPUX
 193
 194  export LDFLAGS="+b${INSTALL_DIR}/lib"
 195
 196 =item AIX
 197
 198  export LDFLAGS="-Wl,-blibpath:${INSTALL_DIR}/lib"
 199
 200 =back
 201
 202 If you have GNUmake installed and it is not called 'make',
 203 then do
 204
 205  export MAKE=gmake
 206  export GNUMAKE=gmake
 207
 208 otherwise just do
 209
 210  export MAKE=make
 211
 212 =head3 Building pkgconfig
 213
 214 As mentioned above, without pkgconfig the whole build process will be lots
 215 of pain and suffering, so make sure you have a copy on your system. If it is
 216 not available natively, here is how to compile it.
 217
 218  wget http://pkgconfig.freedesktop.org/releases/pkg-config-0.23.tar.gz
 219  gunzip -c pkg-config-0.23.tar.gz | tar xf -
 220  cd pkg-config-0.23
 221  ./configure --prefix=$INSTALL_DIR CFLAGS="-O3 -fPIC"
 222  $MAKE
 223  $MAKE install
 224
 225 =head3 Building zlib
 226
 227 Chances are very high that you already have that on your system ...
 228
 229  cd $BUILD_DIR
 230  wget http://oss.oetiker.ch/rrdtool/pub/libs/zlib-1.2.3.tar.gz
 231  gunzip -c zlib-1.2.3.tar.gz | tar xf -
 232  cd zlib-1.2.3
 233  ./configure --prefix=$INSTALL_DIR CFLAGS="-O3 -fPIC" --shared
 234  $MAKE
 235  $MAKE install
 236
 237 =head3 Building libpng
 238
 239 Libpng itself requires zlib to build, so we need to help a bit. If you
 240 already have a copy of zlib on your system (which is very likely) you can
 241 drop the settings of LDFLAGS and CPPFLAGS. Note that the backslash (\) at
 242 the end of line 4 means that line 4 and line 5 are on one line.
 243
 244  cd $BUILD_DIR
 245  wget http://oss.oetiker.ch/rrdtool/pub/libs/libpng-1.2.18.tar.gz
 246  gunzip -c libpng-1.2.18.tar.gz | tar xf -
 247  cd libpng-1.2.10
 248  env CFLAGS="-O3 -fPIC" ./configure --prefix=$INSTALL_DIR
 249  $MAKE
 250  $MAKE install
 251
 252 =head3 Building freetype
 253
 254  cd $BUILD_DIR
 255  wget http://oss.oetiker.ch/rrdtool/pub/libs/freetype-2.3.5.tar.gz
 256  gunzip -c freetype-2.3.5.tar.gz | tar xf -
 257  cd freetype-2.3.5
 258  ./configure --prefix=$INSTALL_DIR CFLAGS="-O3 -fPIC"
 259  $MAKE
 260  $MAKE install
 261
 262 If you run into problems building freetype on Solaris, you may want to try to
 263 add the following at the start the configure line:
 264
 265  env EGREP=egrep
 266
 267 =head3 Building LibXML2
 268
 269  cd $BUILD_DIR
 270  wget http://oss.oetiker.ch/rrdtool/pub/libs/libxml2-sources-2.6.31.tar.gz
 271  gunzip -c libxml2-sources-2.6.32.tar.gz | tar xf -
 272  cd libxml2-sources-2.6.32
 273  ./configure --prefix=$INSTALL_DIR CFLAGS="-O3 -fPIC"
 274  $MAKE
 275  $MAKE install
 276
 277 =head3 Building fontconfig
 278
 279 Note that fontconfig has a run time configuration file in INSTALL_DIR/etc you
 280 may want to adjust that so that fontconfig finds the fonts on your system.
 281 Run the fc-cache program to build the fontconfig cache after changing the
 282 config file.
 283
 284  cd $BUILD_DIR
 285  wget http://oss.oetiker.ch/rrdtool/pub/libs/fontconfig-2.4.2.tar.gz
 286  gunzip -c fontconfig-2.4.2.tar.gz   | tar xf -
 287  cd fontconfig-2.4.2
 288  ./configure --prefix=$INSTALL_DIR CFLAGS="-O3 -fPIC"
 289  $MAKE
 290  $MAKE install
 291
 292 =head3 Building Pixman
 293
 294  cd $BUILD_DIR
 295  wget http://oss.oetiker.ch/rrdtool/pub/libs/pixman-0.10.0.tar.gz
 296  gunzip -c pixman-0.10.0.tar.gz  | tar xf -
 297  cd pixman-0.10.0
 298  ./configure --prefix=$INSTALL_DIR CFLAGS="-O3 -fPIC"
 299  $MAKE
 300  $MAKE install
 301
 302 =head3 Building Cairo
 303
 304  cd $BUILD_DIR
 305  wget http://oss.oetiker.ch/rrdtool/pub/libs/cairo-1.6.4.tar.gz
 306  gunzip -c cairo-1.4.10.tar.gz   | tar xf -
 307  cd cairo-1.4.10
 308  ./configure --prefix=$INSTALL_DIR \
 309     --enable-xlib=no \
 310     --enable-xlib-render=no \
 311     --enable-win32=no \
 312     CFLAGS="-O3 -fPIC"
 313  $MAKE
 314  $MAKE install
 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.12.13.tar.gz  | tar xf -
 321  cd glib-2.12.13
 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.gz
 330  gunzip -c pango-1.21.1.tar.gz  | 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.3.2
 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