added --no-header to documentation and fixed implementation
[rrdtool.git] / doc / rrdbuild.pod
index e783d57..8f14a2a 100644 (file)
@@ -2,9 +2,7 @@
 
 rrdbuild - Instructions for building RRDtool
 
-=head1 DESCRIPTION
-
-=head2 Overview
+=head1 OVERVIEW
 
 If you downloaded the source of rrdtool you have to compile it. This
 document will give some information on how this is done.
@@ -15,16 +13,16 @@ ones before you can build RRDtool.
 
 This document will tell you about all the necessary steps to get going.
 
-These instructions assume you are using a bash shell. If you use csh/tcsh,
-then you can either type 'bash' to switch to bash for the compilation or if
-you know what you are doing just replace replace the export bits with
+These instructions assume you are using a B<bash> shell. If you use csh/tcsh,
+then you can either type F<bash> to switch to bash for the compilation or if
+you know what you are doing just replace the export bits with
 setenv.
 
 We further assume that your copies of B<tar> and B<make> are actually B<GNU
 tar> and B<GNU make> respectively. It could be that they are installed as
 B<gtar> and B<gmake> on your system.
 
-=head2 Building
+=head1 OPTIMISTIC BUILD
 
 Before you start to build RRDtool, you have to decide two things:
 
@@ -41,15 +39,10 @@ Where you want to install the software.
 =back
 
 Once you have decided. Save the two locations into environment variables.
-Depending on the shell you are using, you can do either (bash,zsh):
 
  BUILD_DIR=/tmp/rrdbuild
- INSTALL_DIR=/usr/local/rrdtool-1.2.99907080300
-
-Or if you run tcsh:
+ INSTALL_DIR=/usr/local/rrdtool-1.3rc2
 
- set BUILD_DIR=/tmp/rrdbuild
- set INSTALL_DIR=/usr/local/rrdtool-1.2.99907080300
 
 If your F</tmp> is mounted with the option noexec (RHEL seems todo that) you have to choose
 a different directory!
@@ -62,19 +55,46 @@ Now make sure the BUILD_DIR exists and go there:
 Lets first assume you already have all the necessary libraries
 pre-installed. 
 
- wget http://oss.oetiker.ch/rrdtool/pub/rrdtool-1.2.99907080300.tar.gz
- gunzip -c rrdtool-1.2.99907080300.tar.gz | tar xf -
- cd rrdtool-1.2.99907080300
+ wget http://oss.oetiker.ch/rrdtool/pub/rrdtool-1.3rc2.tar.gz
+ gunzip -c rrdtool-1.3rc2.tar.gz | tar xf -
+ cd rrdtool-1.3rc2
  ./configure --prefix=$INSTALL_DIR && make && make install
 
 Ok, this was very optimistic. This try will probably have ended with
-B<configure> 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 B<-dev>
-package for each library you install. Once you have the missing bits on
-board, just re-run the last line of the instructions above.
+B<configure> complaining about several missing libraries.
+
+=head1 INSTALLING DEPENDENCIES
+
+If your OS 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 OS ready for the rrdtool compilation. Additions to
+this list are welcome.
+
+=head2 OpenSolaris 2008.05
+
+Just add a compiler and the gnome development package:
+
+ pkg install sunstudioexpress
+ pkg install SUNWgnome-common-devel
+
+There is a a problem with F<cairo.pc> 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 F<xrender.pc> file. Use perl to
+fix this:
+
+ perl -i~ -p -e 's/(Requires.*?)\s*xrender.*/$1/' /usr/lib/pkgconfig/cairo.pc 
+
+=head2 Debian / Ubuntu
+
+Use apt-get to make sure you have all that is required. A number
+of packages will get added through dependencies.
+
+ apt-get install libpango1.0-dev libxml2-dev
 
-But again this may have been too optimistic, and you actually have to
+=head1 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
@@ -152,7 +172,6 @@ otherwhise just do
 
  export MAKE=make
 
 =item Building zlib
 
 Chances are very high that you already have that on your system ... 
@@ -187,13 +206,13 @@ the end of line 4 means that line 4 and line 5 are on one line.
  gunzip -c freetype-2.3.5.tar.gz | tar xf -
  cd freetype-2.3.5
  ./configure --prefix=$INSTALL_DIR CFLAGS="-O3 -fPIC"
- $MAKE   (or gmake)
- $MAKE install (or gmake install)
+ $MAKE
+ $MAKE install
 
 If you run into problems building freetype on Solaris, you may want to try to
 add the following at the start the configure line:
 
- env GNUMAKE=gmake EGREP=egrep
+ env EGREP=egrep
 
 =item Building fontconfig
 
@@ -244,6 +263,16 @@ config file.
  $MAKE
  $MAKE install
 
+=item Building LibXML2
+
+ 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"
+ $MAKE
+ $MAKE install
+
 =back
 
 Now all the dependent libraries are built and you can try again. This time
@@ -251,17 +280,12 @@ 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.
 
- CPPFLAGS=-I$INSTALL_DIR/include
- LDFLAGS="-R$INSTALL_DIR/lib -L$INSTALL_DIR/lib"
- CFLAGS=-O3
- export CPPFLAGS LDFLAGS CFLAGS
-
 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
 their current state.
 
- cd $BUILD_DIR/rrdtool-1.2.99907080300
+ cd $BUILD_DIR/rrdtool-1.3rc2
  ./configure --prefix=$INSTALL_DIR --disable-tcl --disable-python
  $MAKE clean
  $MAKE