![[tokkee]](http://tokkee.org/images/avatar.png){kind=avatar}
diff --git a/doc/rrdbuild.1 b/doc/rrdbuild.1
index 1ba620ba897e0e87f0daa4d7765500d58182239f..05fdc80951170005ed6413f3bda8db445c29d5d1 100644 (file)
--- a/doc/rrdbuild.1
+++ b/doc/rrdbuild.1
-.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.32
+.\" Automatically generated by Pod::Man 2.1801 (Pod::Simple 3.08)
.\"
.\" Standard preamble:
.\" ========================================================================
-.de Sh \" Subsection heading
-.br
-.if t .Sp
-.ne 5
-.PP
-\fB\\$1\fR
-.PP
-..
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
. ds R" ''
'br\}
.\"
+.\" Escape single quotes in literal strings from groff's Unicode transform.
+.ie \n(.g .ds Aq \(aq
+.el .ds Aq '
+.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
-.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
+.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD. Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
-.if \nF \{\
+.ie \nF \{\
. de IX
. tm Index:\\$1\t\\n%\t"\\$2"
..
. nr % 0
. rr F
.\}
-.\"
-.\" For nroff, turn off justification. Always turn off hyphenation; it makes
-.\" way too many mistakes in technical documents.
-.hy 0
-.if n .na
+.el \{\
+. de IX
+..
+.\}
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear. Run. Save yourself. No user-serviceable parts.
.\" ========================================================================
.\"
.IX Title "RRDBUILD 1"
-.TH RRDBUILD 1 "2008-06-11" "1.3.0" "rrdtool"
+.TH RRDBUILD 1 "2009-06-09" "1.3.999" "rrdtool"
+.\" For nroff, turn off justification. Always turn off hyphenation; it makes
+.\" way too many mistakes in technical documents.
+.if n .ad l
+.nh
.SH "NAME"
rrdbuild \- Instructions for building RRDtool
.SH "OVERVIEW"
.PP
.Vb 2
\& BUILD_DIR=/tmp/rrdbuild
-\& INSTALL_DIR=/usr/local/rrdtool\-1.3.0
+\& INSTALL_DIR=/usr/local/rrdtool\-1.3.2
.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.
+pre-installed.
.PP
.Vb 4
-\& wget http://oss.oetiker.ch/rrdtool/pub/rrdtool\-1.3.0.tar.gz
-\& gunzip \-c rrdtool\-1.3.0.tar.gz | tar xf \-
-\& cd rrdtool\-1.3.0
+\& wget http://oss.oetiker.ch/rrdtool/pub/rrdtool\-1.3.2.tar.gz
+\& gunzip \-c rrdtool\-1.3.2.tar.gz | tar xf \-
+\& cd rrdtool\-1.3.2
\& ./configure \-\-prefix=$INSTALL_DIR && make && make install
.Ve
.PP
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.
.PP
-Additions to this list are welcome.
-.Sh "OpenSolaris 2008.05"
+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.
+.SS "OpenSolaris 2008.05"
.IX Subsection "OpenSolaris 2008.05"
Just add a compiler and the gnome development package:
.PP
\& 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
-\& perl \-i~ \-p \-e \(aqs/(Requires.*?)\es*xrender.*/$1/\(aq /usr/lib/pkgconfig/cairo.pc
+\& perl \-i~ \-p \-e \*(Aqs/(Requires.*?)\es*xrender.*/$1/\*(Aq /usr/lib/pkgconfig/cairo.pc
+.Ve
+.PP
+Make sure rrdtool finds your new compiler
+.PP
+.Vb 1
+\& export PATH=/opt/SunStudioExpress/bin
.Ve
-.Sh "Debian / Ubuntu"
+.PP
+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
+\& \-\-disable\-libintl
+.Ve
+.PP
+option.
+.SS "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.
.Vb 1
\& apt\-get install libpango1.0\-dev libxml2\-dev
.Ve
-.Sh "Gentoo"
+.SS "Gentoo"
.IX Subsection "Gentoo"
In Gentoo installing rrdtool is really simple you just need to \fBemerge
rrdtool\fR. All dependencies will be handled automatically by the portage
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 our
expectations, so you may want to compile their latest versions.
-.PP
-\fIBuild Tips for \s-1AIX\s0\fR
-.IX Subsection "Build Tips for AIX"
-.PP
-If you are working with \s-1AIX\s0, you may find the the \fB\-\-disable\-shared\fR option
+.SS "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 \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.
@@ -273,38 +287,34 @@ Another hint to get rrdtool working on \s-1AIX\s0 is to use the \s-1IBM\s0 \s-1X
.Ve
.PP
(Better instructions for \s-1AIX\s0 welcome!)
-.Sh "Building Libraries"
-.IX Subsection "Building Libraries"
-In order to build the libraries you need a compiler on your system.
-Unfortunately compilers are not all alike. This has an effect on the \s-1CFLAGS\s0
-you want to set. The examples below are for the popular \s-1GCC\s0 compiler suite.
-If you have an other compilers here are some ides:
-.IP "Sun Forte" 4
-.IX Item "Sun Forte"
-.Vb 1
-\& CFLAGS="\-xO3 \-kPIC"
-.Ve
-.Sp
-.RS 4
+.SS "Build Instructions"
+.IX Subsection "Build Instructions"
Some libraries want to know where other libraries are. For this to work,
set the following environment variable
-.Sp
+.PP
.Vb 2
\& export PKG_CONFIG_PATH=${INSTALL_DIR}/lib/pkgconfig
\& export PATH=$INSTALL_DIR/bin:$PATH
.Ve
-.Sp
-This relies on the presence of the \fIpkgconfig\fR program. Below you find instructions
-on how to compile pkgconfig as well.
-.Sp
-Since we are compiling libraries dynamically, they must know
-where to find each other. This is done by setting an appropriate \s-1LDFLAGS\s0.
-Unfortunately, the syntax again differs from system to system:
+.PP
+The above relies on the presence of the \fIpkgconfig\fR program. Below you find instructions
+on how to compile pkgconfig.
+.PP
+Since we are compiling libraries dynamically, they must know where to find
+each other. This is done by setting an appropriate \s-1LDFLAGS\s0. Unfortunately,
+the syntax again differs from system to system:
.IP "Solaris" 4
.IX Item "Solaris"
.Vb 1
\& export LDFLAGS=\-R${INSTALL_DIR}/lib
.Ve
+.Sp
+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)
+.Ve
.IP "Linux" 4
.IX Item "Linux"
.Vb 1
.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',
+.PP
+If you have \s-1GNU\s0 make installed and it is not called 'make',
then do
-.Sp
+.PP
.Vb 2
\& export MAKE=gmake
\& export GNUMAKE=gmake
.Ve
-.Sp
+.PP
otherwise just do
-.Sp
+.PP
.Vb 1
\& export MAKE=make
.Ve
-.RE
-.IP "Building pkgconfig" 4
-.IX Item "Building pkgconfig"
+.PP
+\fIBuilding pkgconfig\fR
+.IX Subsection "Building pkgconfig"
+.PP
As mentioned above, without pkgconfig the whole build process will be lots
of pain and suffering, so make sure you have a copy on your system. If it is
not available natively, here is how to compile it.
-.Sp
+.PP
.Vb 6
\& wget http://pkgconfig.freedesktop.org/releases/pkg\-config\-0.23.tar.gz
\& gunzip \-c pkg\-config\-0.23.tar.gz | tar xf \-
\& $MAKE
\& $MAKE install
.Ve
-.IP "Building zlib" 4
-.IX Item "Building zlib"
-Chances are very high that you already have that on your system ...
-.Sp
+.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
+Chances are very high that you already have that on your system ...
+.PP
.Vb 7
\& cd $BUILD_DIR
\& wget http://oss.oetiker.ch/rrdtool/pub/libs/zlib\-1.2.3.tar.gz
\& $MAKE
\& $MAKE install
.Ve
-.IP "Building libpng" 4
-.IX Item "Building libpng"
+.PP
+\fIBuilding libpng\fR
+.IX Subsection "Building libpng"
+.PP
Libpng itself requires zlib to build, so we need to help a bit. If you
already have a copy of zlib on your system (which is very likely) you can
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
+.PP
.Vb 7
\& cd $BUILD_DIR
\& wget http://oss.oetiker.ch/rrdtool/pub/libs/libpng\-1.2.18.tar.gz
\& $MAKE
\& $MAKE install
.Ve
-.IP "Building freetype" 4
-.IX Item "Building freetype"
+.PP
+\fIBuilding freetype\fR
+.IX Subsection "Building freetype"
+.PP
.Vb 7
\& cd $BUILD_DIR
\& wget http://oss.oetiker.ch/rrdtool/pub/libs/freetype\-2.3.5.tar.gz
\& $MAKE
\& $MAKE install
.Ve
-.Sp
+.PP
If you run into problems building freetype on Solaris, you may want to try to
add the following at the start the configure line:
-.Sp
+.PP
.Vb 1
\& env EGREP=egrep
.Ve
-.IP "Building LibXML2" 4
-.IX Item "Building LibXML2"
+.PP
+\fIBuilding LibXML2\fR
+.IX Subsection "Building LibXML2"
+.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.32.tar.gz | tar xf \-
-\& cd libxml2\-sources\-2.6.32
+\& 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 CFLAGS="\-O3 \-fPIC"
\& $MAKE
\& $MAKE install
.Ve
-.IP "Building fontconfig" 4
-.IX Item "Building fontconfig"
+.PP
+\fIBuilding fontconfig\fR
+.IX Subsection "Building fontconfig"
+.PP
Note that fontconfig has a run time 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 changing the
config file.
-.Sp
+.PP
.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"
+\& ./configure \-\-prefix=$INSTALL_DIR CFLAGS="\-O3 \-fPIC" \-\-with\-freetype\-config=$INSTALL_DIR/bin/freetype\-config
\& $MAKE
\& $MAKE install
.Ve
-.IP "Building Pixman" 4
-.IX Item "Building Pixman"
+.PP
+\fIBuilding Pixman\fR
+.IX Subsection "Building Pixman"
+.PP
.Vb 7
\& cd $BUILD_DIR
\& wget http://oss.oetiker.ch/rrdtool/pub/libs/pixman\-0.10.0.tar.gz
\& $MAKE
\& $MAKE install
.Ve
-.IP "Building Cairo" 4
-.IX Item "Building Cairo"
+.PP
+\fIBuilding Cairo\fR
+.IX Subsection "Building Cairo"
+.PP
.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 \-
+\& gunzip \-c cairo\-1.6.4.tar.gz | tar xf \-
\& cd cairo\-1.4.10
\& ./configure \-\-prefix=$INSTALL_DIR \e
\& \-\-enable\-xlib=no \e
\& $MAKE
\& $MAKE install
.Ve
-.IP "Building Glib" 4
-.IX Item "Building Glib"
+.PP
+\fIBuilding Glib\fR
+.IX Subsection "Building Glib"
+.PP
.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
+\& gunzip \-c glib\-2.15.4.tar.gz | tar xf \-
+\& cd glib\-2.15.4
\& ./configure \-\-prefix=$INSTALL_DIR CFLAGS="\-O3 \-fPIC"
\& $MAKE
\& $MAKE install
.Ve
-.IP "Building Pango" 4
-.IX Item "Building Pango"
+.PP
+\fIBuilding Pango\fR
+.IX Subsection "Building Pango"
+.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
\& $MAKE
\& $MAKE install
.Ve
-.PP
+.SS "Building rrdtool (second try)"
+.IX Subsection "Building rrdtool (second try)"
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
their current state.
.PP
.Vb 5
-\& cd $BUILD_DIR/rrdtool\-1.3.0
+\& cd $BUILD_DIR/rrdtool\-1.3.2
\& ./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
+\&\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!
.PP
-Now go to \fI$INSTALL_DIR\fR\fB/share/rrdtool/examples/\fR and run them to see if
+Now go to \fI\f(CI$INSTALL_DIR\fI\fR\fB/share/rrdtool/examples/\fR and run them to see if
your build has been successful.
.SH "AUTHOR"
.IX Header "AUTHOR"