![[tokkee]](http://tokkee.org/images/avatar.png){kind=avatar}
diff --git a/doc/rrdbuild.1 b/doc/rrdbuild.1
index 80dae58885c77e9f066af3943edeb247a69783e3..4200abfe89a357831e7ea8ccf5d0bfca741794e0 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.05)
.\"
.\" 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-07-23" "1.3.1" "rrdtool"
+.TH RRDBUILD 1 "2010-03-22" "1.4.3" "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"
.IX Header "OVERVIEW"
-If you downloaded the source of rrdtool you have to compile it. This
+If you downloaded the source of RRDtool you have to compile it. This
document will give some information on how this is done.
.PP
RRDtool relies on services of third part libraries. Some of these libraries
.PP
.Vb 2
\& BUILD_DIR=/tmp/rrdbuild
-\& INSTALL_DIR=/usr/local/rrdtool\-1.3.1
+\& INSTALL_DIR=/opt/rrdtool\-1.4.3
.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.1.tar.gz
-\& gunzip \-c rrdtool\-1.3.1.tar.gz | tar xf \-
-\& cd rrdtool\-1.3.1
+\& wget http://oss.oetiker.ch/rrdtool/pub/rrdtool\-1.4.3.tar.gz
+\& gunzip \-c rrdtool\-1.4.3.tar.gz | tar xf \-
+\& cd rrdtool\-1.4.3
\& ./configure \-\-prefix=$INSTALL_DIR && make && make install
.Ve
.PP
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 compiling RRDtool.
.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 the RRDtool build system 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
+In Gentoo installing RRDtool is really simple you just need to \fBemerge
rrdtool\fR. All dependencies will be handled automatically by the portage
system. The only thing you should care about are \s-1USE\s0 flags, which allow you
-fine tune features rrdtool will be built with. Currently the following \s-1USE\s0
+fine tune features RRDtool will be built with. Currently the following \s-1USE\s0
flags are available:
.PP
.Vb 7
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.
-.Sh "General build tips for \s-1AIX\s0"
+.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 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
+shared libraries into the RRDtool \s-1PREFIX\s0 and work with \fB\-\-disable\-static\fR
instead.
.PP
-Another hint to get rrdtool working on \s-1AIX\s0 is to use the \s-1IBM\s0 \s-1XL\s0 C Compiler:
+Another hint to get RRDtool working on \s-1AIX\s0 is to use the \s-1IBM\s0 \s-1XL\s0 C Compiler:
.PP
.Vb 2
\& export CC=/usr/vac/bin/cc
@@ -271,18 +287,8 @@ 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 "Build Instructions"
+.SS "Build Instructions"
.IX Subsection "Build Instructions"
-In order to build rrdtool 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
-.PP
Some libraries want to know where other libraries are. For this to work,
set the following environment variable
.PP
.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
\& 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
\& $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
-Chances are very high that you already have that on your system ...
+Chances are very high that you already have that on your system ...
.PP
.Vb 7
\& cd $BUILD_DIR
.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
\& 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
.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
+\& gunzip \-c cairo\-1.6.4.tar.gz | tar xf \-
+\& cd cairo\-1.6.4
\& ./configure \-\-prefix=$INSTALL_DIR \e
\& \-\-enable\-xlib=no \e
\& \-\-enable\-xlib\-render=no \e
.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
.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
-.Sh "Building rrdtool (second try)"
+.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
.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
-tcl setups that would prevent rrdtool from building if they are included in
+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.1
+\& cd $BUILD_DIR/rrdtool\-1.4.3
\& ./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!
.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"