3 rrdbuild - Instructions for building RRDtool
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.
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.
14 This document will tell you about all the necessary steps to get going.
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
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.
25 =head1 OPTIMISTIC BUILD
27 Before you start to build RRDtool, you have to decide two things:
33 In which directory you want to build the software.
37 Where you want to install the software.
41 Once you have decided. Save the two locations into environment variables.
43 BUILD_DIR=/tmp/rrdbuild
44 INSTALL_DIR=/usr/local/rrdtool-1.3.2
47 If your F</tmp> is mounted with the option noexec (RHEL seems todo that) you have to choose
48 a different directory!
50 Now make sure the BUILD_DIR exists and go there:
55 Lets first assume you already have all the necessary libraries
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 -
61 ./configure --prefix=$INSTALL_DIR && make && make install
63 Ok, this was very optimistic. This try will probably have ended with
64 B<configure> complaining about several missing libraries.
66 =head1 INSTALLING DEPENDENCIES
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.
73 Additions to this list are welcome.
75 =head2 OpenSolaris 2008.05
77 Just add a compiler and the gnome development package:
79 pkg install sunstudioexpress
80 pkg install SUNWgnome-common-devel
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
87 perl -i~ -p -e 's/(Requires.*?)\s*xrender.*/$1/' /usr/lib/pkgconfig/cairo.pc
89 Make sure rrdtool finds your new compiler
91 export PATH=/opt/SunStudioExpress/bin
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
100 =head2 Debian / Ubuntu
102 Use apt-get to make sure you have all that is required. A number
103 of packages will get added through dependencies.
105 apt-get install libpango1.0-dev libxml2-dev
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
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
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:
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
131 =head1 BUILDING DEPENDENCIES
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.
140 =head2 General build tips for AIX
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>
147 Another hint to get rrdtool working on AIX is to use the IBM XL C Compiler:
149 export CC=/usr/vac/bin/cc
152 (Better instructions for AIX welcome!)
154 =head2 Build Instructions
156 Some libraries want to know where other libraries are. For this to work,
157 set the following environment variable
159 export PKG_CONFIG_PATH=${INSTALL_DIR}/lib/pkgconfig
160 export PATH=$INSTALL_DIR/bin:$PATH
162 The above relies on the presence of the F<pkgconfig> program. Below you find instructions
163 on how to compile pkgconfig.
165 Since we are compiling libraries dynamically, they must know where to find
166 each other. This is done by setting an appropriate LDFLAGS. Unfortunately,
167 the syntax again differs from system to system:
173 export LDFLAGS=-R${INSTALL_DIR}/lib
175 if you are using the Sun Studio/Forte compiler, you may also want to set
181 export LDFLAGS="-Wl,--rpath -Wl,${INSTALL_DIR}/lib"
185 export LDFLAGS="+b${INSTALL_DIR}/lib"
189 export LDFLAGS="-Wl,-blibpath:${INSTALL_DIR}/lib"
193 If you have GNUmake installed and it is not called 'make',
203 =head3 Building pkgconfig
205 As mentioned above, without pkgconfig the whole build process will be lots
206 of pain and suffering, so make sure you have a copy on your system. If it is
207 not available natively, here is how to compile it.
209 wget http://pkgconfig.freedesktop.org/releases/pkg-config-0.23.tar.gz
210 gunzip -c pkg-config-0.23.tar.gz | tar xf -
212 ./configure --prefix=$INSTALL_DIR CFLAGS="-O3 -fPIC"
218 Chances are very high that you already have that on your system ...
221 wget http://oss.oetiker.ch/rrdtool/pub/libs/zlib-1.2.3.tar.gz
222 gunzip -c zlib-1.2.3.tar.gz | tar xf -
224 ./configure --prefix=$INSTALL_DIR CFLAGS="-O3 -fPIC" --shared
228 =head3 Building libpng
230 Libpng itself requires zlib to build, so we need to help a bit. If you
231 already have a copy of zlib on your system (which is very likely) you can
232 drop the settings of LDFLAGS and CPPFLAGS. Note that the backslash (\) at
233 the end of line 4 means that line 4 and line 5 are on one line.
236 wget http://oss.oetiker.ch/rrdtool/pub/libs/libpng-1.2.18.tar.gz
237 gunzip -c libpng-1.2.18.tar.gz | tar xf -
239 env CFLAGS="-O3 -fPIC" ./configure --prefix=$INSTALL_DIR
243 =head3 Building freetype
246 wget http://oss.oetiker.ch/rrdtool/pub/libs/freetype-2.3.5.tar.gz
247 gunzip -c freetype-2.3.5.tar.gz | tar xf -
249 ./configure --prefix=$INSTALL_DIR CFLAGS="-O3 -fPIC"
253 If you run into problems building freetype on Solaris, you may want to try to
254 add the following at the start the configure line:
258 =head3 Building LibXML2
261 wget http://oss.oetiker.ch/rrdtool/pub/libs/libxml2-sources-2.6.31.tar.gz
262 gunzip -c libxml2-sources-2.6.32.tar.gz | tar xf -
263 cd libxml2-sources-2.6.32
264 ./configure --prefix=$INSTALL_DIR CFLAGS="-O3 -fPIC"
268 =head3 Building fontconfig
270 Note that fontconfig has a run time configuration file in INSTALL_DIR/etc you
271 may want to adjust that so that fontconfig finds the fonts on your system.
272 Run the fc-cache program to build the fontconfig cache after changing the
276 wget http://oss.oetiker.ch/rrdtool/pub/libs/fontconfig-2.4.2.tar.gz
277 gunzip -c fontconfig-2.4.2.tar.gz | tar xf -
279 ./configure --prefix=$INSTALL_DIR CFLAGS="-O3 -fPIC"
283 =head3 Building Pixman
286 wget http://oss.oetiker.ch/rrdtool/pub/libs/pixman-0.10.0.tar.gz
287 gunzip -c pixman-0.10.0.tar.gz | tar xf -
289 ./configure --prefix=$INSTALL_DIR CFLAGS="-O3 -fPIC"
293 =head3 Building Cairo
296 wget http://oss.oetiker.ch/rrdtool/pub/libs/cairo-1.6.4.tar.gz
297 gunzip -c cairo-1.4.10.tar.gz | tar xf -
299 ./configure --prefix=$INSTALL_DIR \
301 --enable-xlib-render=no \
310 wget http://oss.oetiker.ch/rrdtool/pub/libs/glib-2.15.4.tar.gz
311 gunzip -c glib-2.15.4.tar.gz | tar xf -
313 ./configure --prefix=$INSTALL_DIR CFLAGS="-O3 -fPIC"
317 =head3 Building Pango
320 wget http://oss.oetiker.ch/rrdtool/pub/libs/pango-1.21.1.tar.gz
321 gunzip -c pango-1.21.1.tar.gz | tar xf -
323 ./configure --prefix=$INSTALL_DIR CFLAGS="-O3 -fPIC" --without-x
327 =head2 Building rrdtool (second try)
329 Now all the dependent libraries are built and you can try again. This time
330 you tell configure where it should be looking for libraries and include
331 files. This is done via environment variables. Depending on the shell you
332 are running, the syntax for setting environment variables is different.
334 And finally try building again. We disable the python and tcl bindings
335 because it seems that a fair number of people have ill configured python and
336 tcl setups that would prevent rrdtool from building if they are included in
339 cd $BUILD_DIR/rrdtool-1.3.2
340 ./configure --prefix=$INSTALL_DIR --disable-tcl --disable-python
345 SOLARIS HINT: if you want to build the perl module for the native perl (the
346 one shipping with Solaris) you will need the Sun Forte compiler installed on
347 your box or you have to hand-tune bindings/perl-shared/Makefile while
350 Now go to I<$INSTALL_DIR>B</share/rrdtool/examples/> and run them to see if
351 your build has been successful.
355 Tobias Oetiker E<lt>tobi@oetiker.chE<gt>