Code

Imported upstream version 1.4.8
[pkg-rrdtool.git] / doc / rrdbuild.html
index 01a9efca6fcf761134d2e8e4f163c3a7ba46b2fe..a2065590024880f90a59ed599335bab7d1e71c08 100644 (file)
@@ -9,8 +9,10 @@
 
 <body style="background-color: white">
 
-<p><a name="__index__"></a></p>
+
 <!-- INDEX BEGIN -->
+<div name="index">
+<p><a name="__index__"></a></p>
 <!--
 
 <ul>
        <li><a href="#building_dependencies">BUILDING DEPENDENCIES</a></li>
        <ul>
 
+               <li><a href="#general_build_tips_for_aix">General build tips for AIX</a></li>
+               <li><a href="#build_instructions">Build Instructions</a></li>
                <ul>
 
-                       <li><a href="#build_tips_for_aix">Build Tips for AIX</a></li>
+                       <li><a href="#building_pkgconfig">Building pkgconfig</a></li>
+                       <li><a href="#building_zlib">Building zlib</a></li>
+                       <li><a href="#building_libpng">Building libpng</a></li>
+                       <li><a href="#building_freetype">Building freetype</a></li>
+                       <li><a href="#building_libxml2">Building LibXML2</a></li>
+                       <li><a href="#building_fontconfig">Building fontconfig</a></li>
+                       <li><a href="#building_pixman">Building Pixman</a></li>
+                       <li><a href="#building_cairo">Building Cairo</a></li>
+                       <li><a href="#building_glib">Building Glib</a></li>
+                       <li><a href="#building_pango">Building Pango</a></li>
                </ul>
 
-               <li><a href="#building_libraries">Building Libraries</a></li>
+               <li><a href="#building_rrdtool__second_try_">Building rrdtool (second try)</a></li>
        </ul>
 
        <li><a href="#author">AUTHOR</a></li>
 </ul>
+
 -->
+
+
+</div>
 <!-- INDEX END -->
 
 <p>
 </p>
 <hr />
 <h1><a name="overview">OVERVIEW</a></h1>
-<p>If you downloaded the source of rrdtool you have to compile it. This
+<p>If you downloaded the source of RRDtool you have to compile it. This
 document will give some information on how this is done.</p>
 <p>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.</p>
 <p>This document will tell you about all the necessary steps to get going.</p>
 <p>These instructions assume you are using a <strong>bash</strong> shell. If you use csh/tcsh,
-then you can either type <em>bash</em> to switch to bash for the compilation or if
+then you can either type <em class="file">bash</em> to switch to bash for the compilation or if
 you know what you are doing just replace the export bits with
 setenv.</p>
 <p>We further assume that your copies of <strong>tar</strong> and <strong>make</strong> are actually <strong>GNU
@@ -79,8 +96,8 @@ tar</strong> and <strong>GNU make</strong> respectively. It could be that they a
 <p>Once you have decided. Save the two locations into environment variables.</p>
 <pre>
  BUILD_DIR=/tmp/rrdbuild
- INSTALL_DIR=/usr/local/rrdtool-1.3.0</pre>
-<p>If your <em>/tmp</em> is mounted with the option noexec (RHEL seems todo that) you have to choose
+ INSTALL_DIR=/opt/rrdtool-1.4.8</pre>
+<p>If your <em class="file">/tmp</em> is mounted with the option noexec (RHEL seems todo that) you have to choose
 a different directory!</p>
 <p>Now make sure the BUILD_DIR exists and go there:</p>
 <pre>
@@ -89,9 +106,9 @@ a different directory!</p>
 <p>Lets first assume you already have all the necessary libraries
 pre-installed.</p>
 <pre>
- wget <a href="http://oss.oetiker.ch/rrdtool/pub/rrdtool-1.3.0.tar.gz">http://oss.oetiker.ch/rrdtool/pub/rrdtool-1.3.0.tar.gz</a>
- gunzip -c rrdtool-1.3.0.tar.gz | tar xf -
- cd rrdtool-1.3.0
+ wget <a href="http://oss.oetiker.ch/rrdtool/pub/rrdtool-1.4.8.tar.gz">http://oss.oetiker.ch/rrdtool/pub/rrdtool-1.4.8.tar.gz</a>
+ gunzip -c rrdtool-1.4.8.tar.gz | tar xf -
+ cd rrdtool-1.4.8
  ./configure --prefix=$INSTALL_DIR &amp;&amp; make &amp;&amp; make install</pre>
 <p>Ok, this was very optimistic. This try will probably have ended with
 <strong>configure</strong> complaining about several missing libraries.</p>
@@ -102,8 +119,10 @@ pre-installed.</p>
 <p>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.</p>
-<p>Additions to this list are welcome.</p>
+hints on getting your OS ready for compiling RRDtool.</p>
+<p>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.</p>
 <p>
 </p>
 <h2><a name="opensolaris_2008_05">OpenSolaris 2008.05</a></h2>
@@ -111,12 +130,15 @@ hints on getting your OS ready for the rrdtool compilation.</p>
 <pre>
  pkg install sunstudioexpress
  pkg install SUNWgnome-common-devel</pre>
-<p>There is a problem with <em>cairo.pc</em> on opensolaris. It suggests that
+<p>There is a problem with <em class="file">cairo.pc</em> 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 <em>xrender.pc</em> file. Use perl to
+bad since OpenSolaris does not include an <em class="file">xrender.pc</em> file. Use Perl to
 fix this:</p>
 <pre>
  perl -i~ -p -e 's/(Requires.*?)\s*xrender.*/$1/' /usr/lib/pkgconfig/cairo.pc</pre>
+<p>Make sure the RRDtool build system finds your new compiler</p>
+<pre>
+ export PATH=/opt/SunStudioExpress/bin</pre>
 <p>
 </p>
 <h2><a name="debian___ubuntu">Debian / Ubuntu</a></h2>
@@ -127,10 +149,10 @@ of packages will get added through dependencies.</p>
 <p>
 </p>
 <h2><a name="gentoo">Gentoo</a></h2>
-<p>In Gentoo installing rrdtool is really simple you just need to <strong>emerge
+<p>In Gentoo installing RRDtool is really simple you just need to <strong>emerge
 rrdtool</strong>. 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
+fine tune features RRDtool will be built with. Currently the following USE
 flags are available:</p>
 <pre>
  doc    - install .html and .txt documentation
@@ -141,7 +163,7 @@ flags are available:</p>
  tcl    - build and install tcl language bindings
  rrdcgi - build and install rrdcgi</pre>
 <p>After you've decided which USE flags you need, set them either in
-<em>make.conf</em> or <em>/etc/portage/package.use</em> and finally run:</p>
+<em class="file">make.conf</em> or <em class="file">/etc/portage/package.use</em> and finally run:</p>
 <pre>
  # emerge -va rrdtool</pre>
 <p>Take a look at Gentoo handbook for further details on how to manage USE
@@ -158,67 +180,60 @@ possible that they are pretty old and thus don't live up to our
 expectations, so you may want to compile their latest versions.</p>
 <p>
 </p>
-<h3><a name="build_tips_for_aix">Build Tips for AIX</a></h3>
-<p>If you are working with AIX, you may find the the <strong>--disable-shared</strong> option
+<h2><a name="general_build_tips_for_aix">General build tips for AIX</a></h2>
+<p>If you are working with AIX, you may find the <strong>--disable-shared</strong> 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 <strong>--disable-static</strong>
+shared libraries into the RRDtool PREFIX and work with <strong>--disable-static</strong>
 instead.</p>
-<p>Another hint to get rrdtool working on AIX is to use the IBM XL C Compiler:</p>
+<p>Another hint to get RRDtool working on AIX is to use the IBM XL C Compiler:</p>
 <pre>
  export CC=/usr/vac/bin/cc
  export PERLCC=$CC</pre>
 <p>(Better instructions for AIX welcome!)</p>
 <p>
 </p>
-<h2><a name="building_libraries">Building Libraries</a></h2>
-<p>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:</p>
-<dl>
-<dt><strong><a name="item_sun_forte">Sun Forte</a></strong></dt>
-
-<dd>
-<pre>
- CFLAGS=&quot;-xO3 -kPIC&quot;</pre>
-</dd>
-</dl>
+<h2><a name="build_instructions">Build Instructions</a></h2>
 <p>Some libraries want to know where other libraries are. For this to work,
 set the following environment variable</p>
 <pre>
  export PKG_CONFIG_PATH=${INSTALL_DIR}/lib/pkgconfig
  export PATH=$INSTALL_DIR/bin:$PATH</pre>
-<p>This relies on the presence of the <em>pkgconfig</em> program. Below you find instructions
-on how to compile pkgconfig as well.</p>
-<p>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:</p>
+<p>The above relies on the presence of the <em class="file">pkgconfig</em> program. Below you find instructions
+on how to compile pkgconfig.</p>
+<p>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:</p>
 <dl>
-<dt><strong><a name="item_solaris">Solaris</a></strong></dt>
+<dt><strong><a name="solaris" class="item">Solaris</a></strong></dt>
 
 <dd>
 <pre>
  export LDFLAGS=-R${INSTALL_DIR}/lib</pre>
+<p>if you are using the Sun Studio/Forte compiler, you may also want to set</p>
+<pre>
+ CFLAGS=&quot;-xO3 -xcode=pic13&quot;   (SPARC)
+ CFLAGS=&quot;-xO3 -Kpic&quot;          (x86)</pre>
 </dd>
-<dt><strong><a name="item_linux">Linux</a></strong></dt>
+<dt><strong><a name="linux" class="item">Linux</a></strong></dt>
 
 <dd>
 <pre>
  export LDFLAGS=&quot;-Wl,--rpath -Wl,${INSTALL_DIR}/lib&quot;</pre>
 </dd>
-<dt><strong><a name="item_hpux">HPUX</a></strong></dt>
+<dt><strong><a name="hpux" class="item">HPUX</a></strong></dt>
 
 <dd>
 <pre>
-
  export LDFLAGS=&quot;+b${INSTALL_DIR}/lib&quot;</pre>
 </dd>
-<dt><strong><a name="item_aix">AIX</a></strong></dt>
+<dt><strong><a name="aix" class="item">AIX</a></strong></dt>
 
 <dd>
 <pre>
  export LDFLAGS=&quot;-Wl,-blibpath:${INSTALL_DIR}/lib&quot;</pre>
-<p>If you have GNUmake installed and it is not called 'make',
+</dd>
+</dl>
+<p>If you have GNU make installed and it is not called 'make',
 then do</p>
 <pre>
  export MAKE=gmake
@@ -226,10 +241,9 @@ then do</p>
 <p>otherwise just do</p>
 <pre>
  export MAKE=make</pre>
-<dl>
-<dt><strong><a name="item_building_pkgconfig">Building pkgconfig</a></strong></dt>
-
-<dd>
+<p>
+</p>
+<h3><a name="building_pkgconfig">Building pkgconfig</a></h3>
 <p>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.</p>
@@ -240,10 +254,13 @@ not available natively, here is how to compile it.</p>
  ./configure --prefix=$INSTALL_DIR CFLAGS=&quot;-O3 -fPIC&quot;
  $MAKE
  $MAKE install</pre>
-</dd>
-<dt><strong><a name="item_building_zlib">Building zlib</a></strong></dt>
-
-<dd>
+<p>After installing pkgconfig in a custom directory, setting up the corresponding
+environment variable will be helpful.</p>
+<pre>
+ export PKG_CONFIG=$INSTALL_DIR/bin/pkg-config</pre>
+<p>
+</p>
+<h3><a name="building_zlib">Building zlib</a></h3>
 <p>Chances are very high that you already have that on your system ...</p>
 <pre>
  cd $BUILD_DIR
@@ -253,10 +270,9 @@ not available natively, here is how to compile it.</p>
  ./configure --prefix=$INSTALL_DIR CFLAGS=&quot;-O3 -fPIC&quot; --shared
  $MAKE
  $MAKE install</pre>
-</dd>
-<dt><strong><a name="item_building_libpng">Building libpng</a></strong></dt>
-
-<dd>
+<p>
+</p>
+<h3><a name="building_libpng">Building libpng</a></h3>
 <p>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 LDFLAGS and CPPFLAGS. Note that the backslash (\) at
@@ -269,10 +285,9 @@ the end of line 4 means that line 4 and line 5 are on one line.</p>
  env CFLAGS=&quot;-O3 -fPIC&quot; ./configure --prefix=$INSTALL_DIR
  $MAKE
  $MAKE install</pre>
-</dd>
-<dt><strong><a name="item_building_freetype">Building freetype</a></strong></dt>
-
-<dd>
+<p>
+</p>
+<h3><a name="building_freetype">Building freetype</a></h3>
 <pre>
  cd $BUILD_DIR
  wget <a href="http://oss.oetiker.ch/rrdtool/pub/libs/freetype-2.3.5.tar.gz">http://oss.oetiker.ch/rrdtool/pub/libs/freetype-2.3.5.tar.gz</a>
@@ -285,22 +300,20 @@ the end of line 4 means that line 4 and line 5 are on one line.</p>
 add the following at the start the configure line:</p>
 <pre>
  env EGREP=egrep</pre>
-</dd>
-<dt><strong><a name="item_building_libxml2">Building LibXML2</a></strong></dt>
-
-<dd>
+<p>
+</p>
+<h3><a name="building_libxml2">Building LibXML2</a></h3>
 <pre>
  cd $BUILD_DIR
- wget <a href="http://oss.oetiker.ch/rrdtool/pub/libs/libxml2-sources-2.6.31.tar.gz">http://oss.oetiker.ch/rrdtool/pub/libs/libxml2-sources-2.6.31.tar.gz</a>
- gunzip -c libxml2-sources-2.6.32.tar.gz | tar xf -
- cd libxml2-sources-2.6.32
+ wget <a href="http://oss.oetiker.ch/rrdtool/pub/libs/libxml2-2.6.32.tar.gz">http://oss.oetiker.ch/rrdtool/pub/libs/libxml2-2.6.32.tar.gz</a>
+ gunzip -c libxml2-2.6.32.tar.gz | tar xf -
+ cd libxml2-2.6.32
  ./configure --prefix=$INSTALL_DIR CFLAGS=&quot;-O3 -fPIC&quot;
  $MAKE
  $MAKE install</pre>
-</dd>
-<dt><strong><a name="item_building_fontconfig">Building fontconfig</a></strong></dt>
-
-<dd>
+<p>
+</p>
+<h3><a name="building_fontconfig">Building fontconfig</a></h3>
 <p>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
@@ -310,13 +323,12 @@ config file.</p>
  wget <a href="http://oss.oetiker.ch/rrdtool/pub/libs/fontconfig-2.4.2.tar.gz">http://oss.oetiker.ch/rrdtool/pub/libs/fontconfig-2.4.2.tar.gz</a>
  gunzip -c fontconfig-2.4.2.tar.gz   | tar xf -
  cd fontconfig-2.4.2
- ./configure --prefix=$INSTALL_DIR CFLAGS=&quot;-O3 -fPIC&quot;
+ ./configure --prefix=$INSTALL_DIR CFLAGS=&quot;-O3 -fPIC&quot; --with-freetype-config=$INSTALL_DIR/bin/freetype-config
  $MAKE
  $MAKE install</pre>
-</dd>
-<dt><strong><a name="item_building_pixman">Building Pixman</a></strong></dt>
-
-<dd>
+<p>
+</p>
+<h3><a name="building_pixman">Building Pixman</a></h3>
 <pre>
  cd $BUILD_DIR
  wget <a href="http://oss.oetiker.ch/rrdtool/pub/libs/pixman-0.10.0.tar.gz">http://oss.oetiker.ch/rrdtool/pub/libs/pixman-0.10.0.tar.gz</a>
@@ -325,15 +337,14 @@ config file.</p>
  ./configure --prefix=$INSTALL_DIR CFLAGS=&quot;-O3 -fPIC&quot;
  $MAKE
  $MAKE install</pre>
-</dd>
-<dt><strong><a name="item_building_cairo">Building Cairo</a></strong></dt>
-
-<dd>
+<p>
+</p>
+<h3><a name="building_cairo">Building Cairo</a></h3>
 <pre>
  cd $BUILD_DIR
  wget <a href="http://oss.oetiker.ch/rrdtool/pub/libs/cairo-1.6.4.tar.gz">http://oss.oetiker.ch/rrdtool/pub/libs/cairo-1.6.4.tar.gz</a>
- 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 \
     --enable-xlib=no \
     --enable-xlib-render=no \
@@ -341,48 +352,54 @@ config file.</p>
     CFLAGS=&quot;-O3 -fPIC&quot;
  $MAKE
  $MAKE install</pre>
-</dd>
-<dt><strong><a name="item_building_glib">Building Glib</a></strong></dt>
-
-<dd>
+<p>When building on Solaris you may want todo</p>
+<pre>
+ ./configure --prefix=$INSTALL_DIR \
+    --enable-xlib=no \
+    --enable-xlib-render=no \
+    --enable-win32=no \
+    CFLAGS=&quot;-O3 -fPIC -D_POSIX_PTHREAD_SEMANTICS&quot;</pre>
+<p>
+</p>
+<h3><a name="building_glib">Building Glib</a></h3>
 <pre>
  cd $BUILD_DIR
  wget <a href="http://oss.oetiker.ch/rrdtool/pub/libs/glib-2.15.4.tar.gz">http://oss.oetiker.ch/rrdtool/pub/libs/glib-2.15.4.tar.gz</a>
- 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=&quot;-O3 -fPIC&quot;
  $MAKE
  $MAKE install</pre>
-</dd>
-<dt><strong><a name="item_building_pango">Building Pango</a></strong></dt>
-
-<dd>
+<p>
+</p>
+<h3><a name="building_pango">Building Pango</a></h3>
 <pre>
  cd $BUILD_DIR
- wget <a href="http://oss.oetiker.ch/rrdtool/pub/libs/pango-1.21.1.tar.gz">http://oss.oetiker.ch/rrdtool/pub/libs/pango-1.21.1.tar.gz</a>
gunzip -c pango-1.21.1.tar.gz  | tar xf -
+ wget <a href="http://oss.oetiker.ch/rrdtool/pub/libs/pango-1.21.1.tar.bz2">http://oss.oetiker.ch/rrdtool/pub/libs/pango-1.21.1.tar.bz2</a>
bunzip2 -c pango-1.21.1.tar.bz2 | tar xf -
  cd pango-1.21.1
  ./configure --prefix=$INSTALL_DIR CFLAGS=&quot;-O3 -fPIC&quot; --without-x
  $MAKE
  $MAKE install</pre>
-</dd>
-</dl>
+<p>
+</p>
+<h2><a name="building_rrdtool__second_try_">Building rrdtool (second try)</a></h2>
 <p>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
 are running, the syntax for setting environment variables is different.</p>
 <p>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.</p>
 <pre>
- cd $BUILD_DIR/rrdtool-1.3.0
+ cd $BUILD_DIR/rrdtool-1.4.8
  ./configure --prefix=$INSTALL_DIR --disable-tcl --disable-python
  $MAKE clean
  $MAKE
  $MAKE install</pre>
-<p>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
+<p>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!</p>
 <p>Now go to <em>$INSTALL_DIR</em><strong>/share/rrdtool/examples/</strong> and run them to see if
@@ -391,9 +408,7 @@ your build has been successful.</p>
 </p>
 <hr />
 <h1><a name="author">AUTHOR</a></h1>
-<p>Tobias Oetiker &lt;<a href="mailto:tobi@oetiker.ch">tobi@oetiker.ch</a>&gt;
-
-</p>
+<p>Tobias Oetiker &lt;<a href="mailto:tobi@oetiker.ch">tobi@oetiker.ch</a>&gt;</p>
 
 </body>