![[tokkee]](http://tokkee.org/images/avatar.png){kind=avatar}
diff --git a/doc/rrdbuild.1 b/doc/rrdbuild.1
index 52b88b9cd49aaea5bca8d539383efde1771530a5..25457ae5e9520f465b4d8370d507949a3f363696 100644 (file)
--- a/doc/rrdbuild.1
+++ b/doc/rrdbuild.1
.\" ========================================================================
.\"
.IX Title "RRDBUILD 1"
-.TH RRDBUILD 1 "2008-02-17" "1.2.27" "rrdtool"
+.TH RRDBUILD 1 "2008-05-18" "1.3rc4" "rrdtool"
.SH "NAME"
rrdbuild \- Instructions for building RRDtool
-.SH "DESCRIPTION"
-.IX Header "DESCRIPTION"
-.Sh "Overview"
-.IX Subsection "Overview"
+.SH "OVERVIEW"
+.IX Header "OVERVIEW"
If you downloaded the source of rrdtool you have to compile it. This
document will give some information on how this is done.
.PP
@@ -144,8 +142,17 @@ may already be installed on your system. You have to compile copies of the other
ones before you can build RRDtool.
.PP
This document will tell you about all the necessary steps to get going.
-.Sh "Building"
-.IX Subsection "Building"
+.PP
+These instructions assume you are using a \fBbash\fR shell. If you use csh/tcsh,
+then you can either type \fIbash\fR to switch to bash for the compilation or if
+you know what you are doing just replace the export bits with
+setenv.
+.PP
+We further assume that your copies of \fBtar\fR and \fBmake\fR are actually \fB\s-1GNU\s0
+tar\fR and \fB\s-1GNU\s0 make\fR respectively. It could be that they are installed as
+\&\fBgtar\fR and \fBgmake\fR on your system.
+.SH "OPTIMISTIC BUILD"
+.IX Header "OPTIMISTIC BUILD"
Before you start to build RRDtool, you have to decide two things:
.IP "1." 4
In which directory you want to build the software.
Where you want to install the software.
.PP
Once you have decided. Save the two locations into environment variables.
-Depending on the shell you are using, you can do either (bash,zsh):
.PP
.Vb 2
\& BUILD_DIR=/tmp/rrdbuild
-\& INSTALL_DIR=/usr/local/rrdtool\-1.2.27
-.Ve
-.PP
-Or if you run tcsh:
-.PP
-.Vb 2
-\& set BUILD_DIR=/tmp/rrdbuild
-\& set INSTALL_DIR=/usr/local/rrdtool\-1.2.27
+\& INSTALL_DIR=/usr/local/rrdtool\-1.3rc4
.Ve
.PP
If your \fI/tmp\fR is mounted with the option noexec (\s-1RHEL\s0 seems todo that) you have to choose
.Ve
.PP
Lets first assume you already have all the necessary libraries
-pre\-installed. Note that these instructions assume that your copies of
-\&\fBtar\fR and \fBmake\fR are actually \fB\s-1GNU\s0 tar\fR and \fB\s-1GNU\s0 make\fR respectively. It
-could be that they are installed as \fBgtar\fR and \fBgmake\fR on your system.
+pre\-installed.
.PP
.Vb 4
-\& wget http://oss.oetiker.ch/rrdtool/pub/rrdtool\-1.2.27.tar.gz
-\& tar zxf rrdtool\-1.2.27.tar.gz
-\& cd rrdtool\-1.2.27
+\& wget http://oss.oetiker.ch/rrdtool/pub/rrdtool\-1.3rc4.tar.gz
+\& gunzip \-c rrdtool\-1.3rc4.tar.gz | tar xf \-
+\& cd rrdtool\-1.3rc4
\& ./configure \-\-prefix=$INSTALL_DIR && make && make install
.Ve
.PP
Ok, this was very optimistic. This try will probably have ended with
-\&\fBconfigure\fR complaining about several missing libraries. If you are on a
-Linux or *bsd system you may want to just install the missing bits from your
-software repository. When you do that, make sure you also get the \fB\-dev\fR
-package for each library you install. Once you have the missing bits on
-board, just re-run the last line of the instructions above.
+\&\fBconfigure\fR complaining about several missing libraries.
+.SH "INSTALLING DEPENDENCIES"
+.IX Header "INSTALLING DEPENDENCIES"
+If your \s-1OS\s0 lets you install additional packages from a software repository,
+you may get away with installing the missing packages. When the packages are
+installed, run configure again and try to compile again. Below you find some
+hints on getting your \s-1OS\s0 ready for the rrdtool compilation. Additions to
+this list are welcome.
+.Sh "OpenSolaris 2008.05"
+.IX Subsection "OpenSolaris 2008.05"
+Just add a compiler and the gnome development package:
+.PP
+.Vb 2
+\& pkg install sunstudioexpress
+\& pkg install SUNWgnome\-common\-devel
+.Ve
+.PP
+There is a a problem with \fIcairo.pc\fR on opensolaris. It suggests that
+xrender is required for compilation with cairo. This is not true and also
+bad since opensolaris does not include an \fIxrender.pc\fR file. Use perl to
+fix this:
+.PP
+.Vb 1
+\& perl \-i~ \-p \-e 's/(Requires.*?)\es*xrender.*/$1/' /usr/lib/pkgconfig/cairo.pc
+.Ve
+.Sh "Debian / Ubuntu"
+.IX Subsection "Debian / Ubuntu"
+Use apt-get to make sure you have all that is required. A number
+of packages will get added through dependencies.
.PP
-But again this may have been too optimistic, and you actually have to
-compile your own copies of the required libraries.
+.Vb 1
+\& apt\-get install libpango1.0\-dev libxml2\-dev
+.Ve
+.SH "BUILDING DEPENDENCIES"
+.IX Header "BUILDING DEPENDENCIES"
+But again this may have been too optimistic still, and you actually have to
+compile your own copies of some of the required libraries. Things like
+libpng and zlib are pretty standard so you will probably have them on your
+system anyway. Freetype, Fontinst, Cairo, Pango may be installed, but it is
+possible that they are pretty old and thus don't live up to the
+expectations, so you may want to compile their latest versions.
.PP
\fIBuild Tipps for \s-1AIX\s0\fR
.IX Subsection "Build Tipps for AIX"
.Vb 1
\& CFLAGS="\-xO3 \-kPIC"
.Ve
+.Sp
+.RS 4
+Some libraries want to know where other libraries are. For this to work,
+set the following environamen variable
+.Sp
+.Vb 2
+\& export PKG_CONFIG_PATH=${INSTALL_DIR}/lib/pkgconfig
+\& export PATH=$INSTALL_DIR/bin:$PATH
+.Ve
+.Sp
+Since we are compiling libraries dynamically, you they must further know
+where to find each other. This is done by setting an appropriate \s-1LDFLAG\s0.
+Unfortunatly the syntax differs from system to system:
+.IP "Solaris" 4
+.IX Item "Solaris"
+.Vb 1
+\& export LDFLAGS=\-R${INSTALL_DIR}/lib
+.Ve
+.IP "Linux" 4
+.IX Item "Linux"
+.Vb 1
+\& export LDFLAGS="\-Wl,\-\-rpath \-Wl,${INSTALL_DIR}/lib"
+.Ve
+.Sp
+If you are on a 64bit platform, but would like to continue to use the rrd files created
+on your old 32bit linux, you may be able
+.IP "\s-1HPUX\s0" 4
+.IX Item "HPUX"
+.Vb 1
+\& export LDFLAGS="+b${INSTALL_DIR}/lib"
+.Ve
+.IP "\s-1AIX\s0" 4
+.IX Item "AIX"
+.Vb 1
+\& export LDFLAGS="\-Wl,\-blibpath:${INSTALL_DIR}/lib"
+.Ve
+.RE
+.RS 4
+.Sp
+If you have GNUmake installed and it is not called 'make',
+then do
+.Sp
+.Vb 2
+\& export MAKE=gmake
+\& export GNUMAKE=gmake
+.Ve
+.Sp
+otherwhise just do
+.Sp
+.Vb 1
+\& export MAKE=make
+.Ve
+.RE
.IP "Building zlib" 4
.IX Item "Building zlib"
+Chances are very high that you already have that on your system ...
+.Sp
.Vb 7
\& cd $BUILD_DIR
\& wget http://oss.oetiker.ch/rrdtool/pub/libs/zlib\-1.2.3.tar.gz
-\& tar zxf zlib\-1.2.3.tar.gz
+\& gunzip \-c zlib\-1.2.3.tar.gz | tar xf \-
\& cd zlib\-1.2.3
-\& env CFLAGS="\-O3 \-fPIC" ./configure \-\-prefix=$BUILD_DIR/lb
-\& make
-\& make install
+\& ./configure \-\-prefix=$INSTALL_DIR CFLAGS="\-O3 \-fPIC" \-\-shared
+\& $MAKE
+\& $MAKE install
.Ve
.IP "Building libpng" 4
.IX Item "Building libpng"
drop the settings of \s-1LDFLAGS\s0 and \s-1CPPFLAGS\s0. Note that the backslash (\e) at
the end of line 4 means that line 4 and line 5 are on one line.
.Sp
-.Vb 8
+.Vb 7
\& cd $BUILD_DIR
-\& wget http://oss.oetiker.ch/rrdtool/pub/libs/libpng\-1.2.10.tar.gz
-\& tar zxvf libpng\-1.2.10.tar.gz
+\& wget http://oss.oetiker.ch/rrdtool/pub/libs/libpng\-1.2.18.tar.gz
+\& gunzip \-c libpng\-1.2.18.tar.gz | tar xf \-
\& cd libpng\-1.2.10
-\& env CPPFLAGS="\-I$BUILD_DIR/lb/include" LDFLAGS="\-L$BUILD_DIR/lb/lib" CFLAGS="\-O3 \-fPIC" \e
-\& ./configure \-\-disable\-shared \-\-prefix=$BUILD_DIR/lb
-\& make
-\& make install
+\& env CFLAGS="\-O3 \-fPIC" ./configure \-\-prefix=$INSTALL_DIR
+\& $MAKE
+\& $MAKE install
.Ve
.IP "Building freetype" 4
.IX Item "Building freetype"
-.Vb 8
+.Vb 7
\& cd $BUILD_DIR
-\& wget http://oss.oetiker.ch/rrdtool/pub/libs/freetype\-2.1.10.tar.bz2
-\& tar jxvf freetype\-2.1.10.tar.bz2
-\& cd freetype\-2.1.10
-\& env CPPFLAGS="\-I$BUILD_DIR/lb/include" LDFLAGS="\-L$BUILD_DIR/lb/lib" CFLAGS="\-O3 \-fPIC" \e
-\& ./configure \-\-disable\-shared \-\-prefix=$BUILD_DIR/lb
-\& make
-\& make install
+\& wget http://oss.oetiker.ch/rrdtool/pub/libs/freetype\-2.3.5.tar.gz
+\& gunzip \-c freetype\-2.3.5.tar.gz | tar xf \-
+\& cd freetype\-2.3.5
+\& ./configure \-\-prefix=$INSTALL_DIR CFLAGS="\-O3 \-fPIC"
+\& $MAKE
+\& $MAKE install
.Ve
.Sp
If you run into problems building freetype on Solaris, you may want to try to
-add the following at the end of the configure line:
+add the following at the start the configure line:
.Sp
.Vb 1
-\& GNUMAKE=gmake EGREP=egrep
+\& env EGREP=egrep
.Ve
-.IP "Building libart_lgpl" 4
-.IX Item "Building libart_lgpl"
+.IP "Building LibXML2" 4
+.IX Item "Building LibXML2"
.Vb 7
\& cd $BUILD_DIR
-\& wget http://oss.oetiker.ch/rrdtool/pub/libs/libart_lgpl\-2.3.17.tar.gz
-\& tar zxvf libart_lgpl\-2.3.17.tar.gz
-\& cd libart_lgpl\-2.3.17
-\& env CFLAGS="\-O3 \-fPIC" ./configure \-\-disable\-shared \-\-prefix=$BUILD_DIR/lb
-\& make
-\& make install
+\& wget http://oss.oetiker.ch/rrdtool/pub/libs/libxml2\-sources\-2.6.31.tar.gz
+\& gunzip \-c libxml2\-sources\-2.6.32.tar.gz | tar xf \-
+\& cd libxml2\-sources\-2.6.32
+\& ./configure \-\-prefix=$INSTALL_DIR CFLAGS="\-O3 \-fPIC"
+\& $MAKE
+\& $MAKE install
.Ve
-.PP
-Now all the dependent libraries are built and you can try again. Since these
-are static libraries, you may have to use \fIranlib\fR to make them accessible.
-Especially \s-1BSD\s0 systems like Mac \s-1OS\s0 X may require this, Linux and Solaris
-will do just fine without since their \fIar\fR command does ranlibs job as well.
-.PP
-.Vb 1
-\& ranlib $BUILD_DIR/lb/lib/*.a
+.IP "Building fontconfig" 4
+.IX Item "Building fontconfig"
+Note that fontconfig has a runtime configuration file in INSTALL_DIR/etc you
+may want to adjust that so that fontconfig finds the fonts on your system.
+Run the fc-cache program to build the fontconfig cache after changeing the
+config file.
+.Sp
+.Vb 7
+\& cd $BUILD_DIR
+\& wget http://oss.oetiker.ch/rrdtool/pub/libs/fontconfig\-2.4.2.tar.gz
+\& gunzip \-c fontconfig\-2.4.2.tar.gz | tar xf \-
+\& cd fontconfig\-2.4.2
+\& ./configure \-\-prefix=$INSTALL_DIR CFLAGS="\-O3 \-fPIC"
+\& $MAKE
+\& $MAKE install
.Ve
-.PP
-This time you tell configure where it should be looking for libraries and
-include files. This is done via environment variables. Depending on the
-shell you are running, the syntax for setting environment variables is
-different. Under csh/tcsh you use:
-.PP
-.Vb 4
-\& set IR=\-I$BUILD_DIR/lb/include
-\& setenv CPPFLAGS "$IR $IR/libart\-2.0 $IR/freetype2 $IR/libpng"
-\& setenv LDFLAGS \-L$BUILD_DIR/lb/lib
-\& setenv CFLAGS \-O3
+.IP "Building Pixman" 4
+.IX Item "Building Pixman"
+.Vb 7
+\& cd $BUILD_DIR
+\& wget http://oss.oetiker.ch/rrdtool/pub/libs/pixman\-0.10.0.tar.gz
+\& gunzip \-c pixman\-0.10.0.tar.gz | tar xf \-
+\& cd fontconfig\-2.4.2
+\& ./configure \-\-prefix=$INSTALL_DIR CFLAGS="\-O3 \-fPIC"
+\& $MAKE
+\& $MAKE install
.Ve
-.PP
-If you are running bash/sh/ash/ksh/zsh use this:
-.PP
-.Vb 5
-\& IR=\-I$BUILD_DIR/lb/include
-\& CPPFLAGS="$IR $IR/libart\-2.0 $IR/freetype2 $IR/libpng"
-\& LDFLAGS="\-L$BUILD_DIR/lb/lib"
-\& CFLAGS=\-O3
-\& export CPPFLAGS LDFLAGS CFLAGS
+.IP "Building Cairo" 4
+.IX Item "Building Cairo"
+.Vb 11
+\& cd $BUILD_DIR
+\& wget http://oss.oetiker.ch/rrdtool/pub/libs/cairo\-1.6.4.tar.gz
+\& gunzip \-c cairo\-1.4.10.tar.gz | tar xf \-
+\& cd cairo\-1.4.10
+\& ./configure \-\-prefix=$INSTALL_DIR \e
+\& \-\-enable\-xlib=no \e
+\& \-\-enable\-xlib\-render=no \e
+\& \-\-enable\-win32=no \e
+\& CFLAGS="\-O3 \-fPIC"
+\& $MAKE
+\& $MAKE install
.Ve
+.IP "Building Glib" 4
+.IX Item "Building Glib"
+.Vb 7
+\& cd $BUILD_DIR
+\& wget http://oss.oetiker.ch/rrdtool/pub/libs/glib\-2.15.4.tar.gz
+\& gunzip \-c glib\-2.12.13.tar.gz | tar xf \-
+\& cd glib\-2.12.13
+\& ./configure \-\-prefix=$INSTALL_DIR CFLAGS="\-O3 \-fPIC"
+\& $MAKE
+\& $MAKE install
+.Ve
+.IP "Building Pango" 4
+.IX Item "Building Pango"
+.Vb 7
+\& cd $BUILD_DIR
+\& wget http://oss.oetiker.ch/rrdtool/pub/libs/pango\-1.21.1.tar.gz
+\& gunzip \-c pango\-1.21.1.tar.gz | tar xf \-
+\& cd pango\-1.21.1
+\& ./configure \-\-prefix=$INSTALL_DIR CFLAGS="\-O3 \-fPIC" \-\-without\-x
+\& $MAKE
+\& $MAKE install
+.Ve
+.PP
+Now all the dependent libraries are built and you can try again. This time
+you tell configure where it should be looking for libraries and include
+files. This is done via environment variables. Depending on the shell you
+are running, the syntax for setting environment variables is different.
.PP
And finally try building again. We disable the python and tcl bindings
because it seems that a fair number of people have ill configured python and
their current state.
.PP
.Vb 5
-\& cd $BUILD_DIR/rrdtool\-1.2.27
-\& ./configure \-\-prefix=$INSTALL_DIR \-\-disable\-python \-\-disable\-tcl
-\& make clean
-\& make
-\& make install
+\& cd $BUILD_DIR/rrdtool\-1.3rc4
+\& ./configure \-\-prefix=$INSTALL_DIR \-\-disable\-tcl \-\-disable\-python
+\& $MAKE clean
+\& $MAKE
+\& $MAKE install
.Ve
.PP
\&\s-1SOLARIS\s0 \s-1HINT:\s0 if you want to build the perl module for the native perl (the
-one shipping with solaris) you will need the sun forte compiler
-installed on your box or you have to hand-tune bindings/perl\-shared/Makefile
-while building!
+one shipping with solaris) you will need the sun forte compiler installed on
+your box or you have to hand-tune bindings/perl\-shared/Makefile while
+building!
.PP
-Now go to \fI$INSTALL_DIR\fR\fB/share/rrdtool/examples/\fR and run them to see if your
-build has been successful.
+Now go to \fI$INSTALL_DIR\fR\fB/share/rrdtool/examples/\fR and run them to see if
+your build has been successful.
.SH "AUTHOR"
.IX Header "AUTHOR"
Tobias Oetiker <tobi@oetiker.ch>