rrdbuild - Instructions for building RRDtool
-=head1 DESCRIPTION
+=head1 OVERVIEW
-=head2 Overview
-
-If you downloaded the source of rrdtool you have to compile it. This
+If you downloaded the source of RRDtool you have to compile it. This
document will give some information on how this is done.
-RRDtool relies on services of thrid part libraries. Some of these libraries
+RRDtool relies on services of third part libraries. Some of these libraries
may already be installed on your system. You have to compile copies of the other
ones before you can build RRDtool.
This document will tell you about all the necessary steps to get going.
-=head2 Building
+These instructions assume you are using a B<bash> shell. If you use csh/tcsh,
+then you can either type F<bash> to switch to bash for the compilation or if
+you know what you are doing just replace the export bits with
+setenv.
+
+We further assume that your copies of B<tar> and B<make> are actually B<GNU
+tar> and B<GNU make> respectively. It could be that they are installed as
+B<gtar> and B<gmake> on your system.
+
+=head1 OPTIMISTIC BUILD
Before you start to build RRDtool, you have to decide two things:
=back
Once you have decided. Save the two locations into environment variables.
-Depending on the shell you are using, you can do either (bash,zsh):
BUILD_DIR=/tmp/rrdbuild
- INSTALL_DIR=/usr/local/rrdtool-1.2.99907080300
-
-Or if you run tcsh:
+ INSTALL_DIR=/opt/rrdtool-1.4.2
- set BUILD_DIR=/tmp/rrdbuild
- set INSTALL_DIR=/usr/local/rrdtool-1.2.99907080300
If your F</tmp> is mounted with the option noexec (RHEL seems todo that) you have to choose
a different directory!
cd $BUILD_DIR
Lets first assume you already have all the necessary libraries
-pre-installed. Note that these instructions assume that your copies of
-B<tar> and B<make> are actually B<GNU tar> and B<GNU make> respectively. It
-could be that they are installed as B<gtar> and B<gmake> on your system.
+pre-installed.
- wget http://oss.oetiker.ch/rrdtool/pub/rrdtool-1.2.99907080300.tar.gz
- tar zxf rrdtool-1.2.99907080300.tar.gz
- cd rrdtool-1.2.99907080300
+ wget http://oss.oetiker.ch/rrdtool/pub/rrdtool-1.4.2.tar.gz
+ gunzip -c rrdtool-1.4.2.tar.gz | tar xf -
+ cd rrdtool-1.4.2
./configure --prefix=$INSTALL_DIR && make && make install
Ok, this was very optimistic. This try will probably have ended with
-B<configure> complaining about several missing libraries. If you are on a
-Linux or *bsd system you may want to just install the missing bits from your
-software repository. When you do that, make sure you also get the B<-dev>
-package for each library you install. Once you have the missing bits on
-board, just re-run the last line of the instructions above.
+B<configure> complaining about several missing libraries.
+
+=head1 INSTALLING DEPENDENCIES
+
+If your OS lets you install additional packages from a software repository,
+you may get away with installing the missing packages. When the packages are
+installed, run configure again and try to compile again. Below you find some
+hints on getting your OS ready for compiling RRDtool.
+
+Additions to this list are welcome. In general RRDtool should work with the
+latest versions of the libraries. The versions listed here are just what was
+current when I tested this.
+
+=head2 OpenSolaris 2008.05
+
+Just add a compiler and the gnome development package:
+
+ pkg install sunstudioexpress
+ pkg install SUNWgnome-common-devel
+
+There is a problem with F<cairo.pc> on OpenSolaris. It suggests that
+xrender is required for compilation with cairo. This is not true and also
+bad since OpenSolaris does not include an F<xrender.pc> file. Use Perl to
+fix this:
+
+ perl -i~ -p -e 's/(Requires.*?)\s*xrender.*/$1/' /usr/lib/pkgconfig/cairo.pc
+
+Make sure the RRDtool build system finds your new compiler
+
+ export PATH=/opt/SunStudioExpress/bin
+
+Since there does not seem to be a viable msgfmt tool on OpenSolaris (short
+of installing it yourself). You have to call configure with the
+
+ --disable-libintl
-But again this may have been too optimistic, and you actually have to
-compile your own copies of the required libraries.
+option.
-=head3 Build Tipps for AIX
+=head2 Debian / Ubuntu
-If you are woking with AIX, you may find the the B<--disable-shared> option
+Use apt-get to make sure you have all that is required. A number
+of packages will get added through dependencies.
+
+ apt-get install libpango1.0-dev libxml2-dev
+
+=head2 Gentoo
+
+In Gentoo installing RRDtool is really simple you just need to B<emerge
+rrdtool>. All dependencies will be handled automatically by the portage
+system. The only thing you should care about are USE flags, which allow you
+fine tune features RRDtool will be built with. Currently the following USE
+flags are available:
+
+ doc - install .html and .txt documentation
+ into /usr/share/doc/rrdtool-1.x.xx/
+ perl - build and install perl language bindings
+ python - build and install python language bindings
+ ruby - build and install ruby language bindings
+ tcl - build and install tcl language bindings
+ rrdcgi - build and install rrdcgi
+
+After you've decided which USE flags you need, set them either in
+F<make.conf> or F</etc/portage/package.use> and finally run:
+
+ # emerge -va rrdtool
+
+Take a look at Gentoo handbook for further details on how to manage USE
+flags: http://www.gentoo.org/doc/en/handbook/handbook-x86.xml?part=2
+
+=head1 BUILDING DEPENDENCIES
+
+But again this may have been too optimistic still, and you actually have to
+compile your own copies of some of the required libraries. Things like
+libpng and zlib are pretty standard so you will probably have them on your
+system anyway. Freetype, Fontinst, Cairo, Pango may be installed, but it is
+possible that they are pretty old and thus don't live up to our
+expectations, so you may want to compile their latest versions.
+
+=head2 General build tips for AIX
+
+If you are working with AIX, you may find the B<--disable-shared> option
will cause things to break for you. In that case you may have to install the
-shared libraries into the rrdtool PREFIX and work with B<--disable-static>
+shared libraries into the RRDtool PREFIX and work with B<--disable-static>
instead.
-Another hint to get rrdtool working on AIX is to use the IBM XL C Compiler:
+Another hint to get RRDtool working on AIX is to use the IBM XL C Compiler:
export CC=/usr/vac/bin/cc
export PERLCC=$CC
(Better instructions for AIX welcome!)
-=head2 Building Libraries
+=head2 Build Instructions
+
+Some libraries want to know where other libraries are. For this to work,
+set the following environment variable
-In order to build the libraries you need a compiler on your system.
-Unfortunately compilers are not all alike. This has an effect on the CFLAGS
-you want to set. The examples below are for the popular GCC compiler suite.
-If you have an other compile you have to use the following settings:
+ export PKG_CONFIG_PATH=${INSTALL_DIR}/lib/pkgconfig
+ export PATH=$INSTALL_DIR/bin:$PATH
+
+The above relies on the presence of the F<pkgconfig> program. Below you find instructions
+on how to compile pkgconfig.
+
+Since we are compiling libraries dynamically, they must know where to find
+each other. This is done by setting an appropriate LDFLAGS. Unfortunately,
+the syntax again differs from system to system:
=over
-=item Sun Forte
+=item Solaris
- CFLAGS="-xO3 -kPIC"
+ export LDFLAGS=-R${INSTALL_DIR}/lib
-=back
+if you are using the Sun Studio/Forte compiler, you may also want to set
+
+ CFLAGS="-xO3 -xcode=pic13" (SPARC)
+ CFLAGS="-xO3 -Kpic" (x86)
-=over
+=item Linux
-=item Building zlib
+ export LDFLAGS="-Wl,--rpath -Wl,${INSTALL_DIR}/lib"
+
+=item HPUX
+
+ export LDFLAGS="+b${INSTALL_DIR}/lib"
+
+=item AIX
+
+ export LDFLAGS="-Wl,-blibpath:${INSTALL_DIR}/lib"
+
+=back
+
+If you have GNU make installed and it is not called 'make',
+then do
+
+ export MAKE=gmake
+ export GNUMAKE=gmake
+
+otherwise just do
+
+ export MAKE=make
+
+=head3 Building pkgconfig
+
+As mentioned above, without pkgconfig the whole build process will be lots
+of pain and suffering, so make sure you have a copy on your system. If it is
+not available natively, here is how to compile it.
+
+ wget http://pkgconfig.freedesktop.org/releases/pkg-config-0.23.tar.gz
+ gunzip -c pkg-config-0.23.tar.gz | tar xf -
+ cd pkg-config-0.23
+ ./configure --prefix=$INSTALL_DIR CFLAGS="-O3 -fPIC"
+ $MAKE
+ $MAKE install
+
+After installing pkgconfig in a custom directory, setting up the corresponding
+environment variable will be helpful.
+
+ export PKG_CONFIG=$INSTALL_DIR/bin/pkg-config
+
+=head3 Building zlib
Chances are very high that you already have that on your system ...
cd $BUILD_DIR
wget http://oss.oetiker.ch/rrdtool/pub/libs/zlib-1.2.3.tar.gz
- tar zxf zlib-1.2.3.tar.gz
+ gunzip -c zlib-1.2.3.tar.gz | tar xf -
cd zlib-1.2.3
- env CFLAGS="-O3 -fPIC" ./configure --prefix=$BUILD_DIR/lb
- make
- make install
+ ./configure --prefix=$INSTALL_DIR CFLAGS="-O3 -fPIC" --shared
+ $MAKE
+ $MAKE install
-=item Building libpng
+=head3 Building libpng
Libpng itself requires zlib to build, so we need to help a bit. If you
-already have a copy of zlib on your system (which is very likley) you can
+already have a copy of zlib on your system (which is very likely) you can
drop the settings of LDFLAGS and CPPFLAGS. Note that the backslash (\) at
the end of line 4 means that line 4 and line 5 are on one line.
cd $BUILD_DIR
wget http://oss.oetiker.ch/rrdtool/pub/libs/libpng-1.2.18.tar.gz
- tar zxvf libpng-1.2.18.tar.gz
+ gunzip -c libpng-1.2.18.tar.gz | tar xf -
cd libpng-1.2.10
- env CPPFLAGS="-I$BUILD_DIR/lb/include" LDFLAGS="-L$BUILD_DIR/lb/lib" CFLAGS="-O3 -fPIC" \
- ./configure --disable-shared --prefix=$BUILD_DIR/lb
- make
- make install
+ env CFLAGS="-O3 -fPIC" ./configure --prefix=$INSTALL_DIR
+ $MAKE
+ $MAKE install
-=item Building freetype
+=head3 Building freetype
cd $BUILD_DIR
wget http://oss.oetiker.ch/rrdtool/pub/libs/freetype-2.3.5.tar.gz
- tar zxvf freetype-2.3.5.tar.gz
+ gunzip -c freetype-2.3.5.tar.gz | tar xf -
cd freetype-2.3.5
- env CPPFLAGS="-I$BUILD_DIR/lb/include" LDFLAGS="-L$BUILD_DIR/lb/lib" CFLAGS="-O3 -fPIC" \
- ./configure --disable-shared --prefix=$BUILD_DIR/lb
- make
- make install
+ ./configure --prefix=$INSTALL_DIR CFLAGS="-O3 -fPIC"
+ $MAKE
+ $MAKE install
If you run into problems building freetype on Solaris, you may want to try to
-add the following at the end of the configure line:
+add the following at the start the configure line:
- GNUMAKE=gmake EGREP=egrep
+ env EGREP=egrep
-=item Building fontconfig
+=head3 Building LibXML2
-Note that fontconfig has a runtime configuration file in INSTALL_DIR/etc you
+ cd $BUILD_DIR
+ wget http://oss.oetiker.ch/rrdtool/pub/libs/libxml2-2.6.32.tar.gz
+ gunzip -c libxml2-2.6.32.tar.gz | tar xf -
+ cd libxml2-2.6.32
+ ./configure --prefix=$INSTALL_DIR CFLAGS="-O3 -fPIC"
+ $MAKE
+ $MAKE install
+
+=head3 Building fontconfig
+
+Note that fontconfig has a run time configuration file in INSTALL_DIR/etc you
may want to adjust that so that fontconfig finds the fonts on your system.
-Run the fc-cache program to build the fontconfig cache after changeing the
+Run the fc-cache program to build the fontconfig cache after changing the
config file.
cd $BUILD_DIR
wget http://oss.oetiker.ch/rrdtool/pub/libs/fontconfig-2.4.2.tar.gz
- tar zxvf fontconfig-2.4.2.tar.gz
+ gunzip -c fontconfig-2.4.2.tar.gz | tar xf -
cd fontconfig-2.4.2
- env CFLAGS="-O3 -fPIC" ./configure --prefix=$INSTALL_DIR
- make
- make install
+ ./configure --prefix=$INSTALL_DIR CFLAGS="-O3 -fPIC" --with-freetype-config=$INSTALL_DIR/bin/freetype-config
+ $MAKE
+ $MAKE install
-=item Building Cairo
+=head3 Building Pixman
cd $BUILD_DIR
- wget http://oss.oetiker.ch/rrdtool/pub/libs/cairo-1.4.10.tar.gz
- tar zxvf cairo-1.4.10.tar.gz
- cd cairo-1.4.10
- env CFLAGS="-O3 -fPIC" ./configure --prefix=$INSTALL_DIR \
- --enable-xlib=no \
- --enable-xlib-render=no \
- --enable-win32=no
- make
- make install
+ wget http://oss.oetiker.ch/rrdtool/pub/libs/pixman-0.10.0.tar.gz
+ gunzip -c pixman-0.10.0.tar.gz | tar xf -
+ cd pixman-0.10.0
+ ./configure --prefix=$INSTALL_DIR CFLAGS="-O3 -fPIC"
+ $MAKE
+ $MAKE install
-=item Building Glib
+=head3 Building Cairo
cd $BUILD_DIR
- wget http://oss.oetiker.ch/rrdtool/pub/libs/glib-2.12.13.tar.gz
- tar zxvf glib-2.12.13.tar.gz
- cd glib-2.12.13
- env CFLAGS="-O3 -fPIC" ./configure --prefix=$INSTALL_DIR
- make
- make install
+ wget http://oss.oetiker.ch/rrdtool/pub/libs/cairo-1.6.4.tar.gz
+ gunzip -c cairo-1.6.4.tar.gz | tar xf -
+ cd cairo-1.6.4
+ ./configure --prefix=$INSTALL_DIR \
+ --enable-xlib=no \
+ --enable-xlib-render=no \
+ --enable-win32=no \
+ CFLAGS="-O3 -fPIC"
+ $MAKE
+ $MAKE install
-=item Building Pango
+=head3 Building Glib
cd $BUILD_DIR
- wget http://oss.oetiker.ch/rrdtool/pub/libs/pango-1.17.5.tar.gz
- tar zxvf pango-1.17.5.tar.gz
- cd pango-1.17.5
- env CFLAGS="-O3 -fPIC" ./configure --prefix=$INSTALL_DIR
- make
- make install
-
-=back
+ wget http://oss.oetiker.ch/rrdtool/pub/libs/glib-2.15.4.tar.gz
+ gunzip -c glib-2.15.4.tar.gz | tar xf -
+ cd glib-2.15.4
+ ./configure --prefix=$INSTALL_DIR CFLAGS="-O3 -fPIC"
+ $MAKE
+ $MAKE install
-Now all the dependent libraries are built and you can try again. Since these
-are static libraries, you may have to use F<ranlib> to make them accessible.
-Especially BSD systems like Mac OS X may require this, Linux and Solaris
-will do just fine without since their F<ar> command does ranlibs job as well.
+=head3 Building Pango
- ranlib $BUILD_DIR/lb/lib/*.a
-
-This time you tell configure where it should be looking for libraries and
-include files. This is done via environment variables. Depending on the
-shell you are running, the syntax for setting environment variables is
-different. Under csh/tcsh you use:
-
- set IR="-I$BUILD_DIR/lb/include -I$INSTALL_DIR/include"
- setenv CPPFLAGS "$IR"
- setenv LDFLAGS -L$BUILD_DIR/lb/lib
- setenv CFLAGS -O3
+ cd $BUILD_DIR
+ wget http://oss.oetiker.ch/rrdtool/pub/libs/pango-1.21.1.tar.bz2
+ bunzip2 -c pango-1.21.1.tar.bz2 | tar xf -
+ cd pango-1.21.1
+ ./configure --prefix=$INSTALL_DIR CFLAGS="-O3 -fPIC" --without-x
+ $MAKE
+ $MAKE install
-If you are running bash/sh/ash/ksh/zsh use this:
+=head2 Building rrdtool (second try)
- IR="-I$BUILD_DIR/lb/include -I$INSTALL_DIR/include"
- CPPFLAGS="$IR"
- LDFLAGS="-L$BUILD_DIR/lb/lib -R$INSTALL_DIR/lib -L$INSTALL_DIR/lib"
- CFLAGS=-O3
- export CPPFLAGS LDFLAGS CFLAGS
+Now all the dependent libraries are built and you can try again. This time
+you tell configure where it should be looking for libraries and include
+files. This is done via environment variables. Depending on the shell you
+are running, the syntax for setting environment variables is different.
And finally try building again. We disable the python and tcl bindings
because it seems that a fair number of people have ill configured python and
-tcl setups that would prevent rrdtool from building if they are included in
+tcl setups that would prevent RRDtool from building if they are included in
their current state.
- cd $BUILD_DIR/rrdtool-1.2.99907080300
- ./configure --prefix=$INSTALL_DIR --disable-tcl
- make clean
- make
- make install
+ cd $BUILD_DIR/rrdtool-1.4.2
+ ./configure --prefix=$INSTALL_DIR --disable-tcl --disable-python
+ $MAKE clean
+ $MAKE
+ $MAKE install
-SOLARIS HINT: if you want to build the perl module for the native perl (the
-one shipping with solaris) you will need the sun forte compiler
-installed on your box or you have to hand-tune bindings/perl-shared/Makefile
-while building!
+SOLARIS HINT: if you want to build the Perl module for the native Perl (the
+one shipping with Solaris) you will need the Sun Forte compiler installed on
+your box or you have to hand-tune bindings/perl-shared/Makefile while
+building!
-Now go to I<$INSTALL_DIR>B</share/rrdtool/examples/> and run them to see if your
-build has been successful.
+Now go to I<$INSTALL_DIR>B</share/rrdtool/examples/> and run them to see if
+your build has been successful.
=head1 AUTHOR
projects / rrdtool.git / blobdiff