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=/opt/rrdtool-1.4.3
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.4.3.tar.gz
59 gunzip -c rrdtool-1.4.3.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 compiling RRDtool.
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.
77 =head2 OpenSolaris 2008.05
79 Just add a compiler and the gnome development package:
81 pkg install sunstudioexpress
82 pkg install SUNWgnome-common-devel
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
89 perl -i~ -p -e 's/(Requires.*?)\s*xrender.*/$1/' /usr/lib/pkgconfig/cairo.pc
91 Make sure the RRDtool build system finds your new compiler
93 export PATH=/opt/SunStudioExpress/bin
95 =head2 Debian / Ubuntu
97 Use apt-get to make sure you have all that is required. A number
98 of packages will get added through dependencies.
100 apt-get install libpango1.0-dev libxml2-dev
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
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
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:
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
126 =head1 BUILDING DEPENDENCIES
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.
135 =head2 General build tips for AIX
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>
142 Another hint to get RRDtool working on AIX is to use the IBM XL C Compiler:
144 export CC=/usr/vac/bin/cc
147 (Better instructions for AIX welcome!)
149 =head2 Build Instructions
151 Some libraries want to know where other libraries are. For this to work,
152 set the following environment variable
154 export PKG_CONFIG_PATH=${INSTALL_DIR}/lib/pkgconfig
155 export PATH=$INSTALL_DIR/bin:$PATH
157 The above relies on the presence of the F<pkgconfig> program. Below you find instructions
158 on how to compile pkgconfig.
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:
168 export LDFLAGS=-R${INSTALL_DIR}/lib
170 if you are using the Sun Studio/Forte compiler, you may also want to set
172 CFLAGS="-xO3 -xcode=pic13" (SPARC)
173 CFLAGS="-xO3 -Kpic" (x86)
177 export LDFLAGS="-Wl,--rpath -Wl,${INSTALL_DIR}/lib"
181 export LDFLAGS="+b${INSTALL_DIR}/lib"
185 export LDFLAGS="-Wl,-blibpath:${INSTALL_DIR}/lib"
189 If you have GNU make installed and it is not called 'make',
199 =head3 Building pkgconfig
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.
205 wget http://pkgconfig.freedesktop.org/releases/pkg-config-0.23.tar.gz
206 gunzip -c pkg-config-0.23.tar.gz | tar xf -
208 ./configure --prefix=$INSTALL_DIR CFLAGS="-O3 -fPIC"
212 After installing pkgconfig in a custom directory, setting up the corresponding
213 environment variable will be helpful.
215 export PKG_CONFIG=$INSTALL_DIR/bin/pkg-config
219 Chances are very high that you already have that on your system ...
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 -
225 ./configure --prefix=$INSTALL_DIR CFLAGS="-O3 -fPIC" --shared
229 =head3 Building libpng
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.
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 -
240 env CFLAGS="-O3 -fPIC" ./configure --prefix=$INSTALL_DIR
244 =head3 Building freetype
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 -
250 ./configure --prefix=$INSTALL_DIR CFLAGS="-O3 -fPIC"
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:
259 =head3 Building LibXML2
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 -
265 ./configure --prefix=$INSTALL_DIR CFLAGS="-O3 -fPIC"
269 =head3 Building fontconfig
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
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 -
280 ./configure --prefix=$INSTALL_DIR CFLAGS="-O3 -fPIC" --with-freetype-config=$INSTALL_DIR/bin/freetype-config
284 =head3 Building Pixman
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 -
290 ./configure --prefix=$INSTALL_DIR CFLAGS="-O3 -fPIC"
294 =head3 Building Cairo
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 -
300 ./configure --prefix=$INSTALL_DIR \
302 --enable-xlib-render=no \
308 When building on Solaris you may want todo
310 ./configure --prefix=$INSTALL_DIR \
312 --enable-xlib-render=no \
314 CFLAGS="-O3 -fPIC -D_POSIX_PTHREAD_SEMANTICS"
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 -
322 ./configure --prefix=$INSTALL_DIR CFLAGS="-O3 -fPIC"
326 =head3 Building Pango
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 -
332 ./configure --prefix=$INSTALL_DIR CFLAGS="-O3 -fPIC" --without-x
336 =head2 Building rrdtool (second try)
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.
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
348 cd $BUILD_DIR/rrdtool-1.4.3
349 ./configure --prefix=$INSTALL_DIR --disable-tcl --disable-python
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
359 Now go to I<$INSTALL_DIR>B</share/rrdtool/examples/> and run them to see if
360 your build has been successful.
364 Tobias Oetiker E<lt>tobi@oetiker.chE<gt>