Imported upstream version 1.3.7.

[pkg-rrdtool.git] / doc / rrdbuild.1

diff --git a/doc/rrdbuild.1 b/doc/rrdbuild.1
index 3cb645aa0fbb2792ac33dc52f998d56ff7c6e147..f95c206fc8af7abcc7c2985f9c6d8eafc1cf9b0f 100644 (file)
--- a/doc/rrdbuild.1
+++ b/doc/rrdbuild.1
@@ -129,7 +129,7 @@
 .\" ========================================================================
 .\"
 .IX Title "RRDBUILD 1"
-.TH RRDBUILD 1 "2008-12-15" "1.3.5" "rrdtool"
+.TH RRDBUILD 1 "2009-04-07" "1.3.7" "rrdtool"
 .SH "NAME"
 rrdbuild \- Instructions for building RRDtool
 .SH "OVERVIEW"
@@ -163,7 +163,7 @@ Once you have decided. Save the two locations into environment variables.
 .PP
 .Vb 2
 \& BUILD_DIR=/tmp/rrdbuild
-\& INSTALL_DIR=/usr/local/rrdtool\-1.3.5
+\& INSTALL_DIR=/usr/local/rrdtool\-1.3.7
 .Ve
 .PP
 If your \fI/tmp\fR is mounted with the option noexec (\s-1RHEL\s0 seems todo that) you have to choose
@@ -180,9 +180,9 @@ Lets first assume you already have all the necessary libraries
 pre\-installed. 
 .PP
 .Vb 4
-\& wget http://oss.oetiker.ch/rrdtool/pub/rrdtool\-1.3.5.tar.gz
-\& gunzip \-c rrdtool\-1.3.5.tar.gz | tar xf \-
-\& cd rrdtool\-1.3.5
+\& wget http://oss.oetiker.ch/rrdtool/pub/rrdtool\-1.3.7.tar.gz
+\& gunzip \-c rrdtool\-1.3.7.tar.gz | tar xf \-
+\& cd rrdtool\-1.3.7
 \& ./configure \-\-prefix=$INSTALL_DIR && make && make install
 .Ve
 .PP
@@ -193,9 +193,11 @@ Ok, this was very optimistic. This try will probably have ended with
 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.
+hints on getting your \s-1OS\s0 ready for the rrdtool compilation. 
 .PP
-Additions to this list are welcome.
+Additions to this list are welcome. In general rrdtool should work with the
+latest versions of the libraries. The versions listed here are just what was
+current when I tested this.
 .Sh "OpenSolaris 2008.05"
 .IX Subsection "OpenSolaris 2008.05"
 Just add a compiler and the gnome development package:
@@ -205,9 +207,9 @@ Just add a compiler and the gnome development package:
 \& pkg install SUNWgnome\-common\-devel
 .Ve
 .PP
-There is a problem with \fIcairo.pc\fR on opensolaris. It suggests that
+There is 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
+bad since OpenSolaris does not include an \fIxrender.pc\fR file. Use Perl to
 fix this:
 .PP
 .Vb 1
@@ -220,7 +222,7 @@ Make sure rrdtool finds your new compiler
 \& export PATH=/opt/SunStudioExpress/bin
 .Ve
 .PP
-Since there does not seem to ba a viable msgfmt tool on opensolaris (short
+Since there does not seem to be a viable msgfmt tool on OpenSolaris (short
 of installing it yourself). You have to call configure with the
 .PP
 .Vb 1
@@ -273,7 +275,7 @@ possible that they are pretty old and thus don't live up to our
 expectations, so you may want to compile their latest versions.
 .Sh "General build tips for \s-1AIX\s0"
 .IX Subsection "General build tips for AIX"
-If you are working with \s-1AIX\s0, you may find the the \fB\-\-disable\-shared\fR option
+If you are working with \s-1AIX\s0, you may find the \fB\-\-disable\-shared\fR option
 will cause things to break for you. In that case you may have to install the
 shared libraries into the rrdtool \s-1PREFIX\s0 and work with \fB\-\-disable\-static\fR
 instead.
@@ -311,12 +313,13 @@ the syntax again differs from system to system:
 if you are using the Sun Studio/Forte compiler, you may also want to set
 .Sp
 .Vb 2
-\& CFLAGS="\-xO3 \-xcode=pic13"   (SPARC)
-\& CFLAGS="\-xO3 \-Kpic"          (x86)
+\& export CFLAGS="\-xO3 \-xcode=pic13"   (SPARC)
+\& export CFLAGS="\-xO3 \-Kpic"          (x86)
 .Ve
 .IP "Linux" 4
 .IX Item "Linux"
-.Vb 1
+.Vb 2
+\& export CFLAGS="\-O3 \-fPIC"
 \& export LDFLAGS="\-Wl,\-\-rpath \-Wl,${INSTALL_DIR}/lib"
 .Ve
 .IP "\s-1HPUX\s0" 4
@@ -330,7 +333,7 @@ if you are using the Sun Studio/Forte compiler, you may also want to set
 \& export LDFLAGS="\-Wl,\-blibpath:${INSTALL_DIR}/lib"
 .Ve
 .PP
-If you have GNUmake installed and it is not called 'make',
+If you have \s-1GNU\s0 make installed and it is not called 'make',
 then do
 .PP
 .Vb 2
@@ -355,11 +358,18 @@ not available natively, here is how to compile it.
 \& wget http://pkgconfig.freedesktop.org/releases/pkg\-config\-0.23.tar.gz
 \& gunzip \-c pkg\-config\-0.23.tar.gz | tar xf \-
 \& cd pkg\-config\-0.23
-\& ./configure \-\-prefix=$INSTALL_DIR CFLAGS="\-O3 \-fPIC"
+\& ./configure \-\-prefix=$INSTALL_DIR
 \& $MAKE
 \& $MAKE install
 .Ve
 .PP
+After installing pkgconfig in a custom directory, setting up the corresponding
+environment variable will be helpful.
+.PP
+.Vb 1
+\& export PKG_CONFIG=$INSTALL_DIR/bin/pkg\-config
+.Ve
+.PP
 \fIBuilding zlib\fR
 .IX Subsection "Building zlib"
 .PP
@@ -370,7 +380,7 @@ Chances are very high that you already have that on your system ...
 \& wget http://oss.oetiker.ch/rrdtool/pub/libs/zlib\-1.2.3.tar.gz
 \& gunzip \-c zlib\-1.2.3.tar.gz | tar xf \-
 \& cd zlib\-1.2.3
-\& ./configure \-\-prefix=$INSTALL_DIR CFLAGS="\-O3 \-fPIC" \-\-shared
+\& ./configure \-\-prefix=$INSTALL_DIR \-\-shared
 \& $MAKE
 \& $MAKE install
 .Ve
@@ -387,8 +397,8 @@ the end of line 4 means that line 4 and line 5 are on one line.
 \& cd $BUILD_DIR
 \& 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 CFLAGS="\-O3 \-fPIC" ./configure \-\-prefix=$INSTALL_DIR
+\& cd libpng\-1.2.18
+\& ./configure \-\-prefix=$INSTALL_DIR
 \& $MAKE
 \& $MAKE install
 .Ve
@@ -418,10 +428,10 @@ add the following at the start the configure line:
 .PP
 .Vb 7
 \& cd $BUILD_DIR
-\& wget http://oss.oetiker.ch/rrdtool/pub/libs/libxml2\-sources\-2.6.31.tar.gz
-\& gunzip \-c libxml2\-sources\-2.6.31.tar.gz | tar xf \-
-\& cd libxml2\-sources\-2.6.31
-\& ./configure \-\-prefix=$INSTALL_DIR CFLAGS="\-O3 \-fPIC"
+\& wget http://oss.oetiker.ch/rrdtool/pub/libs/libxml2\-2.6.32.tar.gz
+\& gunzip \-c libxml2\-2.6.32.tar.gz | tar xf \-
+\& cd libxml2\-2.6.32
+\& ./configure \-\-prefix=$INSTALL_DIR
 \& $MAKE
 \& $MAKE install
 .Ve
@@ -439,7 +449,7 @@ config file.
 \& 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"
+\& ./configure \-\-prefix=$INSTALL_DIR \-\-with\-freetype\-config=$INSTALL_DIR/bin/freetype\-config
 \& $MAKE
 \& $MAKE install
 .Ve
@@ -452,7 +462,7 @@ config file.
 \& 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 pixman\-0.10.0
-\& ./configure \-\-prefix=$INSTALL_DIR CFLAGS="\-O3 \-fPIC"
+\& ./configure \-\-prefix=$INSTALL_DIR
 \& $MAKE
 \& $MAKE install
 .Ve
@@ -460,16 +470,15 @@ config file.
 \fIBuilding Cairo\fR
 .IX Subsection "Building Cairo"
 .PP
-.Vb 11
+.Vb 10
 \& cd $BUILD_DIR
 \& wget http://oss.oetiker.ch/rrdtool/pub/libs/cairo\-1.6.4.tar.gz
 \& gunzip \-c cairo\-1.6.4.tar.gz   | tar xf \-
-\& cd cairo\-1.4.10
+\& cd cairo\-1.6.4
 \& ./configure \-\-prefix=$INSTALL_DIR \e
 \&    \-\-enable\-xlib=no \e
 \&    \-\-enable\-xlib\-render=no \e
-\&    \-\-enable\-win32=no \e
-\&    CFLAGS="\-O3 \-fPIC"
+\&    \-\-enable\-win32=no
 \& $MAKE
 \& $MAKE install
 .Ve
@@ -482,7 +491,7 @@ config file.
 \& wget http://oss.oetiker.ch/rrdtool/pub/libs/glib\-2.15.4.tar.gz
 \& gunzip \-c glib\-2.15.4.tar.gz  | tar xf \-
 \& cd glib\-2.15.4
-\& ./configure \-\-prefix=$INSTALL_DIR CFLAGS="\-O3 \-fPIC"
+\& ./configure \-\-prefix=$INSTALL_DIR
 \& $MAKE
 \& $MAKE install
 .Ve
@@ -492,10 +501,10 @@ config file.
 .PP
 .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 \-
+\& wget http://oss.oetiker.ch/rrdtool/pub/libs/pango\-1.21.1.tar.bz2
+\& bunzip2 \-c pango\-1.21.1.tar.bz2 | tar xf \-
 \& cd pango\-1.21.1
-\& ./configure \-\-prefix=$INSTALL_DIR CFLAGS="\-O3 \-fPIC" \-\-without\-x
+\& ./configure \-\-prefix=$INSTALL_DIR \-\-without\-x
 \& $MAKE
 \& $MAKE install
 .Ve
@@ -512,14 +521,14 @@ tcl setups that would prevent rrdtool from building if they are included in
 their current state.
 .PP
 .Vb 5
-\& cd $BUILD_DIR/rrdtool\-1.3.5
+\& cd $BUILD_DIR/rrdtool\-1.3.7
 \& ./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
+\&\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!