1 =head1 NAME
3 rrdbuild - Instructions for building RRDtool
5 =head1 DESCRIPTION
7 =head2 Overview
9 If you downloaded the source of rrdtool you have to compile it. This
10 document will give some information on how this is done.
12 RRDtool relies on services of thrid part libraries. Some of these libraries
13 may already be installed on your system. You have to compile copies of the other
14 ones before you can build RRDtool.
16 This document will tell you about all the necessary steps to get going.
18 =head2 Building
20 Before you start to build RRDtool, you have to decide two things:
22 =over
24 =item 1.
26 In which directory you want to build the software.
28 =item 2.
30 Where you want to install the software.
32 =back
34 Once you have decided. Save the two locations into environment variables.
35 Depending on the shell you are using, you can do either (bash,zsh):
37 BUILD_DIR=/tmp/rrdbuild
38 INSTALL_DIR=/usr/local/rrdtool-1.2.16
40 Or if you run tcsh:
42 set BUILD_DIR=/tmp/rrdbuild
43 set INSTALL_DIR=/usr/local/rrdtool-1.2.16
45 If your F</tmp> is mounted with the option noexec (RHEL seems todo that) you have to choose
46 a different directory!
48 Now make sure the BUILD_DIR exists and go there:
50 mkdir -p $BUILD_DIR
51 cd $BUILD_DIR
53 Lets first assume you already have all the necessary libraries
54 pre-installed. Note that these instructions assume that your copies of
55 B<tar> and B<make> are actually B<GNU tar> and B<GNU make> respectively. It
56 could be that they are installed as B<gtar> and B<gmake> on your system.
58 wget http://oss.oetiker.ch/rrdtool/pub/rrdtool-1.2.16.tar.gz
59 tar zxf rrdtool-1.2.16.tar.gz
60 cd rrdtool-1.2.16
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. If you are on a
65 Linux or *bsd system you may want to just install the missing bits from your
66 software repository. When you do that, make sure you also get the B<-dev>
67 package for each library you install. Once you have the missing bits on
68 board, just re-run the last line of the instructions above.
70 But again this may have been too optimistic, and you actually have to
71 compile your own copies of the required libraries.
73 =head3 Build Tipps for AIX
75 If you are woking with AIX, you may find the the B<--disable-shared> option
76 will cause things to break for you. In that case you may have to install the
77 shared libraries into the rrdtool PREFIX and work with B<--disable-static>
78 instead.
80 Another hint to get rrdtool working on AIX is to use the IBM XL C Compiler:
82 export CC=/usr/vac/bin/cc
83 export PERLCC=$CC
85 (Better instructions for AIX welcome!)
87 =head2 Building Libraries
89 In order to build the libraries you need a compiler on your system.
90 Unfortunately compilers are not all alike. This has an effect on the CFLAGS
91 you want to set. The examples below are for the popular GCC compiler suite.
92 If you have an other compile you have to use the following settings:
94 =over
96 =item Sun Forte
98 CFLAGS="-xO3 -kPIC"
100 =back
102 =over
104 =item Building zlib
106 cd $BUILD_DIR
107 wget http://oss.oetiker.ch/rrdtool/pub/libs/zlib-1.2.3.tar.gz
108 tar zxf zlib-1.2.3.tar.gz
109 cd zlib-1.2.3
110 env CFLAGS="-O3 -fPIC" ./configure --prefix=$BUILD_DIR/lb
111 make
112 make install
114 =item Building libpng
116 Libpng itself requires zlib to build, so we need to help a bit. If you
117 already have a copy of zlib on your system (which is very likley) you can
118 drop the settings of LDFLAGS and CPPFLAGS. Note that the backslash (\) at
119 the end of line 4 means that line 4 and line 5 are on one line.
121 cd $BUILD_DIR
122 wget http://oss.oetiker.ch/rrdtool/pub/libs/libpng-1.2.10.tar.gz
123 tar zxvf libpng-1.2.10.tar.gz
124 cd libpng-1.2.10
125 env CPPFLAGS="-I$BUILD_DIR/lb/include" LDFLAGS="-L$BUILD_DIR/lb/lib" CFLAGS="-O3 -fPIC" \
126 ./configure --disable-shared --prefix=$BUILD_DIR/lb
127 make
128 make install
130 =item Building freetype
132 cd $BUILD_DIR
133 wget http://oss.oetiker.ch/rrdtool/pub/libs/freetype-2.1.10.tar.bz2
134 tar jxvf freetype-2.1.10.tar.bz2
135 cd freetype-2.1.10
136 env CPPFLAGS="-I$BUILD_DIR/lb/include" LDFLAGS="-L$BUILD_DIR/lb/lib" CFLAGS="-O3 -fPIC" \
137 ./configure --disable-shared --prefix=$BUILD_DIR/lb
138 make
139 make install
141 If you run into problems building freetype on Solaris, you may want to try to
142 add the following at the end of the configure line:
144 GNUMAKE=gmake EGREP=egrep
146 =item Building libart_lgpl
148 cd $BUILD_DIR
149 wget http://oss.oetiker.ch/rrdtool/pub/libs/libart_lgpl-2.3.17.tar.gz
150 tar zxvf libart_lgpl-2.3.17.tar.gz
151 cd libart_lgpl-2.3.17
152 env CFLAGS="-O3 -fPIC" ./configure --disable-shared --prefix=$BUILD_DIR/lb
153 make
154 make install
156 =back
158 Now all the dependent libraries are built and you can try again. Since these
159 are static libraries, you may have to use F<ranlib> to make them accessible.
160 Especially BSD systems like Mac OS X may require this, Linux and Solaris
161 will do just fine without since their F<ar> command does ranlibs job as well.
163 ranlib $BUILD_DIR/lb/lib/*.a
165 This time you tell configure where it should be looking for libraries and
166 include files. This is done via environment variables. Depending on the
167 shell you are running, the syntax for setting environment variables is
168 different. Under csh/tcsh you use:
170 set IR=-I$BUILD_DIR/lb/include
171 setenv CPPFLAGS "$IR $IR/libart-2.0 $IR/freetype2 $IR/libpng"
172 setenv LDFLAGS -L$BUILD_DIR/lb/lib
173 setenv CFLAGS -O3
175 If you are running bash/sh/ash/ksh/zsh use this:
177 IR=-I$BUILD_DIR/lb/include
178 CPPFLAGS="$IR $IR/libart-2.0 $IR/freetype2 $IR/libpng"
179 LDFLAGS="-L$BUILD_DIR/lb/lib"
180 CFLAGS=-O3
181 export CPPFLAGS LDFLAGS CFLAGS
183 And finally try building again. We disable the python and tcl bindings
184 because it seems that a fair number of people have ill configured python and
185 tcl setups that would prevent rrdtool from building if they are included in
186 their current state.
188 cd $BUILD_DIR/rrdtool-1.2.16
189 ./configure --prefix=$INSTALL_DIR --disable-python --disable-tcl
190 make clean
191 make
192 make install
194 SOLARIS HINT: if you want to build the perl module for the native perl (the
195 one shipping with solaris) you will need the sun forte compiler
196 installed on your box or you have to hand-tune bindings/perl-shared/Makefile
197 while building!
199 Now go to I<$INSTALL_DIR>B</share/rrdtool/examples/> and run them to see if your
200 build has been successful.
202 =head1 AUTHOR
204 Tobias Oetiker E<lt>tobi@oetiker.chE<gt>