8f14a2a197ef5bc584ffcbecde1b38dd2d4e0e7d
1 =head1 NAME
3 rrdbuild - Instructions for building RRDtool
5 =head1 OVERVIEW
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 thrid 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
19 setenv.
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:
29 =over
31 =item 1.
33 In which directory you want to build the software.
35 =item 2.
37 Where you want to install the software.
39 =back
41 Once you have decided. Save the two locations into environment variables.
43 BUILD_DIR=/tmp/rrdbuild
44 INSTALL_DIR=/usr/local/rrdtool-1.3rc2
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:
52 mkdir -p $BUILD_DIR
53 cd $BUILD_DIR
55 Lets first assume you already have all the necessary libraries
56 pre-installed.
58 wget http://oss.oetiker.ch/rrdtool/pub/rrdtool-1.3rc2.tar.gz
59 gunzip -c rrdtool-1.3rc2.tar.gz | tar xf -
60 cd rrdtool-1.3rc2
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. Additions to
72 this list are welcome.
74 =head2 OpenSolaris 2008.05
76 Just add a compiler and the gnome development package:
78 pkg install sunstudioexpress
79 pkg install SUNWgnome-common-devel
81 There is a a problem with F<cairo.pc> on opensolaris. It suggests that
82 xrender is required for compilation with cairo. This is not true and also
83 bad since opensolaris does not include an F<xrender.pc> file. Use perl to
84 fix this:
86 perl -i~ -p -e 's/(Requires.*?)\s*xrender.*/$1/' /usr/lib/pkgconfig/cairo.pc
88 =head2 Debian / Ubuntu
90 Use apt-get to make sure you have all that is required. A number
91 of packages will get added through dependencies.
93 apt-get install libpango1.0-dev libxml2-dev
95 =head1 BUILDING DEPENDENCIES
97 But again this may have been too optimistic still, and you actually have to
98 compile your own copies of some of the required libraries. Things like
99 libpng and zlib are pretty standard so you will probably have them on your
100 system anyway. Freetype, Fontinst, Cairo, Pango may be installed, but it is
101 possible that they are pretty old and thus don't live up to the
102 expectations, so you may want to compile their latest versions.
104 =head3 Build Tipps for AIX
106 If you are woking with AIX, you may find the the B<--disable-shared> option
107 will cause things to break for you. In that case you may have to install the
108 shared libraries into the rrdtool PREFIX and work with B<--disable-static>
109 instead.
111 Another hint to get rrdtool working on AIX is to use the IBM XL C Compiler:
113 export CC=/usr/vac/bin/cc
114 export PERLCC=$CC
116 (Better instructions for AIX welcome!)
118 =head2 Building Libraries
120 In order to build the libraries you need a compiler on your system.
121 Unfortunately compilers are not all alike. This has an effect on the CFLAGS
122 you want to set. The examples below are for the popular GCC compiler suite.
123 If you have an other compile you have to use the following settings:
125 =over
127 =item Sun Forte
129 CFLAGS="-xO3 -kPIC"
131 =back
133 =over
135 Some libraries want to know where other libraries are. For this to work,
136 set the following environamen variable
138 export PKG_CONFIG_PATH=${INSTALL_DIR}/lib/pkgconfig
139 export PATH=$INSTALL_DIR/bin:$PATH
141 Since we are compiling libraries dynamically, you they must further know
142 where to find each other. This is done by setting an appropriate LDFLAG.
143 Unfortunatly the syntax differs from system to system:
145 =over
147 =item Solaris
149 export LDFLAGS=-R${INSTALL_DIR}/lib
151 =item Linux
153 export LDFLAGS="-Wl,--rpath -Wl,${INSTALL_DIR}/lib"
155 =item HPUX
157 export LDFLAGS="+b${INSTALL_DIR}/lib"
159 =item AIX
161 export LDFLAGS="-Wl,-blibpath:${INSTALL_DIR}/lib"
163 =back
165 If you have GNUmake installed and it is not called 'make',
166 then do
168 export MAKE=gmake
169 export GNUMAKE=gmake
171 otherwhise just do
173 export MAKE=make
175 =item Building zlib
177 Chances are very high that you already have that on your system ...
179 cd $BUILD_DIR
180 wget http://oss.oetiker.ch/rrdtool/pub/libs/zlib-1.2.3.tar.gz
181 gunzip -c zlib-1.2.3.tar.gz | tar xf -
182 cd zlib-1.2.3
183 ./configure --prefix=$INSTALL_DIR CFLAGS="-O3 -fPIC"
184 $MAKE
185 $MAKE install
187 =item Building libpng
189 Libpng itself requires zlib to build, so we need to help a bit. If you
190 already have a copy of zlib on your system (which is very likley) you can
191 drop the settings of LDFLAGS and CPPFLAGS. Note that the backslash (\) at
192 the end of line 4 means that line 4 and line 5 are on one line.
194 cd $BUILD_DIR
195 wget http://oss.oetiker.ch/rrdtool/pub/libs/libpng-1.2.18.tar.gz
196 gunzip -c libpng-1.2.18.tar.gz | tar xf -
197 cd libpng-1.2.10
198 env CFLAGS="-O3 -fPIC" ./configure --prefix=$INSTALL_DIR
199 $MAKE
200 $MAKE install
202 =item Building freetype
204 cd $BUILD_DIR
205 wget http://oss.oetiker.ch/rrdtool/pub/libs/freetype-2.3.5.tar.gz
206 gunzip -c freetype-2.3.5.tar.gz | tar xf -
207 cd freetype-2.3.5
208 ./configure --prefix=$INSTALL_DIR CFLAGS="-O3 -fPIC"
209 $MAKE
210 $MAKE install
212 If you run into problems building freetype on Solaris, you may want to try to
213 add the following at the start the configure line:
215 env EGREP=egrep
217 =item Building fontconfig
219 Note that fontconfig has a runtime configuration file in INSTALL_DIR/etc you
220 may want to adjust that so that fontconfig finds the fonts on your system.
221 Run the fc-cache program to build the fontconfig cache after changeing the
222 config file.
224 cd $BUILD_DIR
225 wget http://oss.oetiker.ch/rrdtool/pub/libs/fontconfig-2.4.2.tar.gz
226 gunzip -c fontconfig-2.4.2.tar.gz | tar xf -
227 cd fontconfig-2.4.2
228 ./configure --prefix=$INSTALL_DIR CFLAGS="-O3 -fPIC"
229 $MAKE
230 $MAKE install
232 =item Building Cairo
234 cd $BUILD_DIR
235 wget http://oss.oetiker.ch/rrdtool/pub/libs/cairo-1.4.10.tar.gz
236 gunzip -c cairo-1.4.10.tar.gz | tar xf -
237 cd cairo-1.4.10
238 ./configure --prefix=$INSTALL_DIR \
239 --enable-xlib=no \
240 --enable-xlib-render=no \
241 --enable-win32=no \
242 CFLAGS="-O3 -fPIC"
243 $MAKE
244 $MAKE install
246 =item Building Glib
248 cd $BUILD_DIR
249 wget http://oss.oetiker.ch/rrdtool/pub/libs/glib-2.12.13.tar.gz
250 gunzip -c glib-2.12.13.tar.gz | tar xf -
251 cd glib-2.12.13
252 ./configure --prefix=$INSTALL_DIR CFLAGS="-O3 -fPIC"
253 $MAKE
254 $MAKE install
256 =item Building Pango
258 cd $BUILD_DIR
259 wget http://oss.oetiker.ch/rrdtool/pub/libs/pango-1.17.5.tar.gz
260 gunzip -c pango-1.17.5.tar.gz | tar xf -
261 cd pango-1.17.5
262 ./configure --prefix=$INSTALL_DIR CFLAGS="-O3 -fPIC"
263 $MAKE
264 $MAKE install
266 =item Building LibXML2
268 cd $BUILD_DIR
269 wget http://oss.oetiker.ch/rrdtool/pub/libs/libxml2-sources-2.6.31.tar.gz
270 gunzip -c libxml2-sources-2.6.31.tar.gz | tar xf -
271 cd libxml2-sources-2.6.31
272 ./configure --prefix=$INSTALL_DIR CFLAGS="-O3 -fPIC"
273 $MAKE
274 $MAKE install
276 =back
278 Now all the dependent libraries are built and you can try again. This time
279 you tell configure where it should be looking for libraries and include
280 files. This is done via environment variables. Depending on the shell you
281 are running, the syntax for setting environment variables is different.
283 And finally try building again. We disable the python and tcl bindings
284 because it seems that a fair number of people have ill configured python and
285 tcl setups that would prevent rrdtool from building if they are included in
286 their current state.
288 cd $BUILD_DIR/rrdtool-1.3rc2
289 ./configure --prefix=$INSTALL_DIR --disable-tcl --disable-python
290 $MAKE clean
291 $MAKE
292 $MAKE install
294 SOLARIS HINT: if you want to build the perl module for the native perl (the
295 one shipping with solaris) you will need the sun forte compiler installed on
296 your box or you have to hand-tune bindings/perl-shared/Makefile while
297 building!
299 Now go to I<$INSTALL_DIR>B</share/rrdtool/examples/> and run them to see if
300 your build has been successful.
302 =head1 AUTHOR
304 Tobias Oetiker E<lt>tobi@oetiker.chE<gt>