Code

Merge branch 'upstream' into experimental
[pkg-rrdtool.git] / doc / rrdbuild.pod
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 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
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.3.5
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.3.5.tar.gz
59  gunzip -c rrdtool-1.3.5.tar.gz | tar xf -
60  cd rrdtool-1.3.5
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
85 fix this:
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
96  --disable-libintl
98 option.
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
107 =head2 Gentoo
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
113 flags are available:
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:
126  # emerge -va rrdtool
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>
145 instead.
147 Another hint to get rrdtool working on AIX is to use the IBM XL C Compiler:
149  export CC=/usr/vac/bin/cc
150  export PERLCC=$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:
169 =over
171 =item Solaris
173  export LDFLAGS=-R${INSTALL_DIR}/lib 
175 if you are using the Sun Studio/Forte compiler, you may also want to set
177  CFLAGS="-xO3 -xcode=pic13"   (SPARC)
178  CFLAGS="-xO3 -Kpic"          (x86)
181 =item Linux
183  export LDFLAGS="-Wl,--rpath -Wl,${INSTALL_DIR}/lib" 
185 =item HPUX
187  export LDFLAGS="+b${INSTALL_DIR}/lib"
189 =item AIX
191  export LDFLAGS="-Wl,-blibpath:${INSTALL_DIR}/lib"
193 =back 
195 If you have GNUmake installed and it is not called 'make',
196 then do
198  export MAKE=gmake
199  export GNUMAKE=gmake
201 otherwise just do
203  export MAKE=make
205 =head3 Building pkgconfig
207 As mentioned above, without pkgconfig the whole build process will be lots
208 of pain and suffering, so make sure you have a copy on your system. If it is
209 not available natively, here is how to compile it.
211  wget http://pkgconfig.freedesktop.org/releases/pkg-config-0.23.tar.gz
212  gunzip -c pkg-config-0.23.tar.gz | tar xf -
213  cd pkg-config-0.23
214  ./configure --prefix=$INSTALL_DIR CFLAGS="-O3 -fPIC"
215  $MAKE
216  $MAKE install
218 =head3 Building zlib
220 Chances are very high that you already have that on your system ... 
222  cd $BUILD_DIR
223  wget http://oss.oetiker.ch/rrdtool/pub/libs/zlib-1.2.3.tar.gz
224  gunzip -c zlib-1.2.3.tar.gz | tar xf -
225  cd zlib-1.2.3
226  ./configure --prefix=$INSTALL_DIR CFLAGS="-O3 -fPIC" --shared
227  $MAKE
228  $MAKE install
230 =head3 Building libpng
232 Libpng itself requires zlib to build, so we need to help a bit. If you
233 already have a copy of zlib on your system (which is very likely) you can
234 drop the settings of LDFLAGS and CPPFLAGS. Note that the backslash (\) at
235 the end of line 4 means that line 4 and line 5 are on one line.
237  cd $BUILD_DIR
238  wget http://oss.oetiker.ch/rrdtool/pub/libs/libpng-1.2.18.tar.gz
239  gunzip -c libpng-1.2.18.tar.gz | tar xf -
240  cd libpng-1.2.10
241  env CFLAGS="-O3 -fPIC" ./configure --prefix=$INSTALL_DIR
242  $MAKE
243  $MAKE install
245 =head3 Building freetype
247  cd $BUILD_DIR
248  wget http://oss.oetiker.ch/rrdtool/pub/libs/freetype-2.3.5.tar.gz
249  gunzip -c freetype-2.3.5.tar.gz | tar xf -
250  cd freetype-2.3.5
251  ./configure --prefix=$INSTALL_DIR CFLAGS="-O3 -fPIC"
252  $MAKE
253  $MAKE install
255 If you run into problems building freetype on Solaris, you may want to try to
256 add the following at the start the configure line:
258  env EGREP=egrep
260 =head3 Building LibXML2
262  cd $BUILD_DIR
263  wget http://oss.oetiker.ch/rrdtool/pub/libs/libxml2-sources-2.6.31.tar.gz
264  gunzip -c libxml2-sources-2.6.31.tar.gz | tar xf -
265  cd libxml2-sources-2.6.31
266  ./configure --prefix=$INSTALL_DIR CFLAGS="-O3 -fPIC"
267  $MAKE
268  $MAKE install
270 =head3 Building fontconfig
272 Note that fontconfig has a run time configuration file in INSTALL_DIR/etc you
273 may want to adjust that so that fontconfig finds the fonts on your system.
274 Run the fc-cache program to build the fontconfig cache after changing the
275 config file.
277  cd $BUILD_DIR
278  wget http://oss.oetiker.ch/rrdtool/pub/libs/fontconfig-2.4.2.tar.gz
279  gunzip -c fontconfig-2.4.2.tar.gz   | tar xf -
280  cd fontconfig-2.4.2
281  ./configure --prefix=$INSTALL_DIR CFLAGS="-O3 -fPIC"
282  $MAKE
283  $MAKE install
285 =head3 Building Pixman
287  cd $BUILD_DIR
288  wget http://oss.oetiker.ch/rrdtool/pub/libs/pixman-0.10.0.tar.gz
289  gunzip -c pixman-0.10.0.tar.gz  | tar xf -
290  cd pixman-0.10.0
291  ./configure --prefix=$INSTALL_DIR CFLAGS="-O3 -fPIC"
292  $MAKE
293  $MAKE install
295 =head3 Building Cairo
297  cd $BUILD_DIR
298  wget http://oss.oetiker.ch/rrdtool/pub/libs/cairo-1.6.4.tar.gz
299  gunzip -c cairo-1.6.4.tar.gz   | tar xf -
300  cd cairo-1.4.10
301  ./configure --prefix=$INSTALL_DIR \
302     --enable-xlib=no \
303     --enable-xlib-render=no \
304     --enable-win32=no \
305     CFLAGS="-O3 -fPIC"
306  $MAKE
307  $MAKE install
309 =head3 Building Glib
311  cd $BUILD_DIR
312  wget http://oss.oetiker.ch/rrdtool/pub/libs/glib-2.15.4.tar.gz
313  gunzip -c glib-2.15.4.tar.gz  | tar xf -
314  cd glib-2.15.4
315  ./configure --prefix=$INSTALL_DIR CFLAGS="-O3 -fPIC"
316  $MAKE
317  $MAKE install
319 =head3 Building Pango
321  cd $BUILD_DIR
322  wget http://oss.oetiker.ch/rrdtool/pub/libs/pango-1.21.1.tar.gz
323  gunzip -c pango-1.21.1.tar.gz  | tar xf -
324  cd pango-1.21.1
325  ./configure --prefix=$INSTALL_DIR CFLAGS="-O3 -fPIC" --without-x
326  $MAKE
327  $MAKE install
329 =head2 Building rrdtool (second try)
331 Now all the dependent libraries are built and you can try again. This time
332 you tell configure where it should be looking for libraries and include
333 files. This is done via environment variables. Depending on the shell you
334 are running, the syntax for setting environment variables is different.
336 And finally try building again. We disable the python and tcl bindings
337 because it seems that a fair number of people have ill configured python and
338 tcl setups that would prevent rrdtool from building if they are included in
339 their current state.
341  cd $BUILD_DIR/rrdtool-1.3.5
342  ./configure --prefix=$INSTALL_DIR --disable-tcl --disable-python
343  $MAKE clean
344  $MAKE
345  $MAKE install
347 SOLARIS HINT: if you want to build  the perl module for the native perl (the
348 one shipping with Solaris) you will need the Sun Forte compiler installed on
349 your box or you have to hand-tune bindings/perl-shared/Makefile while
350 building!
352 Now go to I<$INSTALL_DIR>B</share/rrdtool/examples/> and run them to see if
353 your build has been successful.
355 =head1 AUTHOR
357 Tobias Oetiker E<lt>tobi@oetiker.chE<gt>