prepare for the release of rrdtool-1.4.2
[rrdtool.git] / doc / rrdbuild.pod
index 78d55dc..8de70c8 100644 (file)
@@ -4,10 +4,10 @@ rrdbuild - Instructions for building RRDtool
 
 =head1 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.
 
-RRDtool relies on services of thrid part libraries. Some of these libraries
+RRDtool relies on services of third part libraries. Some of these libraries
 may already be installed on your system. You have to compile copies of the other
 ones before you can build RRDtool.
 
@@ -41,7 +41,7 @@ Where you want to install the software.
 Once you have decided. Save the two locations into environment variables.
 
  BUILD_DIR=/tmp/rrdbuild
- INSTALL_DIR=/usr/local/rrdtool-1.3rc7
+ INSTALL_DIR=/opt/rrdtool-1.4.2
 
 
 If your F</tmp> is mounted with the option noexec (RHEL seems todo that) you have to choose
@@ -55,9 +55,9 @@ 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.3rc7.tar.gz
- gunzip -c rrdtool-1.3rc7.tar.gz | tar xf -
- cd rrdtool-1.3rc7
+ wget http://oss.oetiker.ch/rrdtool/pub/rrdtool-1.4.2.tar.gz
+ gunzip -c rrdtool-1.4.2.tar.gz | tar xf -
+ cd rrdtool-1.4.2
  ./configure --prefix=$INSTALL_DIR && make && make install
 
 Ok, this was very optimistic. This try will probably have ended with
@@ -68,9 +68,11 @@ B<configure> complaining about several missing libraries.
 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.
+hints on getting your OS ready for compiling RRDtool.
 
-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.
 
 =head2 OpenSolaris 2008.05
 
@@ -79,13 +81,24 @@ 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
+There is 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
+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 
 
+Make sure the RRDtool build system finds your new compiler
+
+ export PATH=/opt/SunStudioExpress/bin
+
+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
+
+ --disable-libintl
+
+option.
+
 =head2 Debian / Ubuntu
 
 Use apt-get to make sure you have all that is required. A number
@@ -93,6 +106,30 @@ of packages will get added through dependencies.
 
  apt-get install libpango1.0-dev libxml2-dev
 
+=head2 Gentoo
+
+In Gentoo installing RRDtool is really simple you just need to B<emerge
+rrdtool>. All dependencies will be handled automatically by the portage
+system. The only thing you should care about are USE flags, which allow you
+fine tune features RRDtool will be built with. Currently the following USE
+flags are available:
+
+ doc    - install .html and .txt documentation
+          into /usr/share/doc/rrdtool-1.x.xx/
+ perl   - build and install perl language bindings
+ python - build and install python language bindings
+ ruby   - build and install ruby language bindings
+ tcl    - build and install tcl language bindings
+ rrdcgi - build and install rrdcgi
+
+After you've decided which USE flags you need, set them either in
+F<make.conf> or F</etc/portage/package.use> and finally run:
+
+ # emerge -va rrdtool
+
+Take a look at Gentoo handbook for further details on how to manage USE
+flags: http://www.gentoo.org/doc/en/handbook/handbook-x86.xml?part=2
+
 =head1 BUILDING DEPENDENCIES
 
 But again this may have been too optimistic still, and you actually have to
@@ -102,49 +139,34 @@ 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.
 
-=head3 Build Tipps for AIX
+=head2 General build tips for AIX
 
-If you are woking with AIX, you may find the the B<--disable-shared> option
+If you are working with AIX, you may find the B<--disable-shared> option
 will cause things to break for you. In that case you may have to install the
-shared libraries into the rrdtool PREFIX and work with B<--disable-static>
+shared libraries into the RRDtool PREFIX and work with B<--disable-static>
 instead.
 
-Another hint to get rrdtool working on AIX is to use the IBM XL C Compiler:
+Another hint to get RRDtool working on AIX is to use the IBM XL C Compiler:
 
  export CC=/usr/vac/bin/cc
  export PERLCC=$CC
 
 (Better instructions for AIX welcome!)
 
-=head2 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 CFLAGS
-you want to set. The examples below are for the popular GCC compiler suite.
-If you have an other compilers here are some ides:
-
-=over
-
-=item Sun Forte
-
- CFLAGS="-xO3 -kPIC"
-
-=back
-
-=over 
+=head2 Build Instructions
 
 Some libraries want to know where other libraries are. For this to work,
-set the following environamen variable
+set the following environment variable
 
  export PKG_CONFIG_PATH=${INSTALL_DIR}/lib/pkgconfig
  export PATH=$INSTALL_DIR/bin:$PATH
 
-This relies on the presence of the F<pkgconfig> program. Below you find instructions
-on how to compile pkgconfig as well.
+The above relies on the presence of the F<pkgconfig> program. Below you find instructions
+on how to compile pkgconfig.
 
-Since we are compiling libraries dynamically, they must know
-where to find each other. This is done by setting an appropriate LDFLAG.
-Unfortunatly, the syntax again differs from system to system:
+Since we are compiling libraries dynamically, they must know where to find
+each other. This is done by setting an appropriate LDFLAGS. Unfortunately,
+the syntax again differs from system to system:
 
 =over
 
@@ -152,12 +174,17 @@ Unfortunatly, the syntax again differs from system to system:
 
  export LDFLAGS=-R${INSTALL_DIR}/lib 
 
+if you are using the Sun Studio/Forte compiler, you may also want to set
+
+ CFLAGS="-xO3 -xcode=pic13"   (SPARC)
+ CFLAGS="-xO3 -Kpic"          (x86)
+
 =item Linux
 
  export LDFLAGS="-Wl,--rpath -Wl,${INSTALL_DIR}/lib" 
 
 =item HPUX
+
  export LDFLAGS="+b${INSTALL_DIR}/lib"
 
 =item AIX
@@ -166,17 +193,17 @@ Unfortunatly, the syntax again differs from system to system:
 
 =back 
 
-If you have GNUmake installed and it is not called 'make',
+If you have GNU make installed and it is not called 'make',
 then do
 
  export MAKE=gmake
  export GNUMAKE=gmake
 
-otherwhise just do
+otherwise just do
 
  export MAKE=make
 
-=item Building pkgconfig
+=head3 Building pkgconfig
 
 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
@@ -189,7 +216,12 @@ not available natively, here is how to compile it.
  $MAKE
  $MAKE install
 
-=item Building zlib
+After installing pkgconfig in a custom directory, setting up the corresponding
+environment variable will be helpful.
+
+ export PKG_CONFIG=$INSTALL_DIR/bin/pkg-config
+
+=head3 Building zlib
 
 Chances are very high that you already have that on your system ... 
 
@@ -201,10 +233,10 @@ Chances are very high that you already have that on your system ...
  $MAKE
  $MAKE install
 
-=item Building libpng
+=head3 Building libpng
 
 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 likley) you can
+already have a copy of zlib on your system (which is very likely) you can
 drop the settings of LDFLAGS and CPPFLAGS. Note that the backslash (\) at
 the end of line 4 means that line 4 and line 5 are on one line.
 
@@ -216,7 +248,7 @@ the end of line 4 means that line 4 and line 5 are on one line.
  $MAKE
  $MAKE install
 
-=item Building freetype
+=head3 Building freetype
 
  cd $BUILD_DIR
  wget http://oss.oetiker.ch/rrdtool/pub/libs/freetype-2.3.5.tar.gz
@@ -231,46 +263,46 @@ add the following at the start the configure line:
 
  env EGREP=egrep
 
-=item Building LibXML2
+=head3 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.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
 
-=item Building fontconfig
+=head3 Building fontconfig
 
-Note that fontconfig has a runtime configuration file in INSTALL_DIR/etc you
+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 changeing the
+Run the fc-cache program to build the fontconfig cache after changing the
 config file.
 
  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
 
-=item Building Pixman
+=head3 Building Pixman
 
  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
+ cd pixman-0.10.0
  ./configure --prefix=$INSTALL_DIR CFLAGS="-O3 -fPIC"
  $MAKE
  $MAKE install
 
-=item Building Cairo
+=head3 Building Cairo
 
  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 \
     --enable-xlib=no \
@@ -280,27 +312,27 @@ config file.
  $MAKE
  $MAKE install
 
-=item Building Glib
+=head3 Building Glib
 
  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
 
-=item Building Pango
+=head3 Building Pango
 
  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
 
-=back
+=head2 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
@@ -309,17 +341,17 @@ are running, the syntax for setting environment variables is different.
 
 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.
 
- cd $BUILD_DIR/rrdtool-1.3rc7
+ cd $BUILD_DIR/rrdtool-1.4.2
  ./configure --prefix=$INSTALL_DIR --disable-tcl --disable-python
  $MAKE clean
  $MAKE
  $MAKE install
 
-SOLARIS HINT: 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
+SOLARIS HINT: 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!