Code

Imported upstream SVN snapshot 1.4~rc2+20090928.
[pkg-rrdtool.git] / doc / rrdbuild.txt
index b284bde7db59541718ee2b177b3241f3100e7abb..772b259a265833ef252bdda4debf66211bcadb4e 100644 (file)
@@ -16,9 +16,9 @@ O\bOV\bVE\bER\bRV\bVI\bIE\bEW\bW
        This document will tell you about all the necessary steps to get going.
 
        These instructions assume you are using a b\bba\bas\bsh\bh shell. If you use
-       csh/tcsh, then you can either type _\bb_\ba_\bs_\bh to switch to bash for the com-
-       pilation or if you know what you are doing just replace the export bits
-       with setenv.
+       csh/tcsh, then you can either type _\bb_\ba_\bs_\bh 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 t\bta\bar\br and m\bma\bak\bke\be are actually G\bGN\bNU\bU t\bta\bar\br
        and G\bGN\bNU\bU m\bma\bak\bke\be respectively. It could be that they are installed as g\bgt\bta\bar\br
@@ -31,8 +31,8 @@ O\bOP\bPT\bTI\bIM\bMI\bIS\bST\bTI\bIC\bC B\bBU\bUI\bIL\bLD\bD
 
        2.  Where you want to install the software.
 
-       Once you have decided. Save the two locations into environment vari-
-       ables.
+       Once you have decided. Save the two locations into environment
+       variables.
 
         BUILD_DIR=/tmp/rrdbuild
         INSTALL_DIR=/usr/local/rrdtool-1.3.2
@@ -45,8 +45,8 @@ O\bOP\bPT\bTI\bIM\bMI\bIS\bST\bTI\bIC\bC B\bBU\bUI\bIL\bLD\bD
         mkdir -p $BUILD_DIR
         cd $BUILD_DIR
 
-       Lets first assume you already have all the necessary libraries
-       pre-installed.
+       Lets first assume you already have all the necessary libraries pre-
+       installed.
 
         wget http://oss.oetiker.ch/rrdtool/pub/rrdtool-1.3.2.tar.gz
         gunzip -c rrdtool-1.3.2.tar.gz | tar xf -
@@ -57,27 +57,26 @@ O\bOP\bPT\bTI\bIM\bMI\bIS\bST\bTI\bIC\bC B\bBU\bUI\bIL\bLD\bD
        c\bco\bon\bnf\bfi\big\bgu\bur\bre\be complaining about several missing libraries.
 
 I\bIN\bNS\bST\bTA\bAL\bLL\bLI\bIN\bNG\bG D\bDE\bEP\bPE\bEN\bND\bDE\bEN\bNC\bCI\bIE\bES\bS
-       If your OS lets you install additional packages from a software reposi-
-       tory, 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 com-
-       pilation.
+       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. 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.
 
-       O\bOp\bpe\ben\bnS\bSo\bol\bla\bar\bri\bis\bs 2\b20\b00\b08\b8.\b.0\b05\b5
-
+   O\bOp\bpe\ben\bnS\bSo\bol\bla\bar\bri\bis\bs 2\b20\b00\b08\b8.\b.0\b05\b5
        Just add a compiler and the gnome development package:
 
         pkg install sunstudioexpress
         pkg install SUNWgnome-common-devel
 
-       There is a problem with _\bc_\ba_\bi_\br_\bo_\b._\bp_\bc on OpenSolaris. It suggests that xren-
-       der is required for compilation with cairo. This is not true and also
-       bad since OpenSolaris does not include an _\bx_\br_\be_\bn_\bd_\be_\br_\b._\bp_\bc file. Use Perl to
-       fix this:
+       There is a problem with _\bc_\ba_\bi_\br_\bo_\b._\bp_\bc 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 _\bx_\br_\be_\bn_\bd_\be_\br_\b._\bp_\bc file. Use
+       Perl to fix this:
 
         perl -i~ -p -e 's/(Requires.*?)\s*xrender.*/$1/' /usr/lib/pkgconfig/cairo.pc
 
@@ -92,20 +91,18 @@ I\bIN\bNS\bST\bTA\bAL\bLL\bLI\bIN\bNG\bG D\bDE\bEP\bPE\bEN\bND\bDE\bEN\bNC\bCI\bIE\bES\bS
 
        option.
 
-       D\bDe\beb\bbi\bia\ban\bn /\b/ U\bUb\bbu\bun\bnt\btu\bu
-
+   D\bDe\beb\bbi\bia\ban\bn /\b/ U\bUb\bbu\bun\bnt\btu\bu
        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
 
-       G\bGe\ben\bnt\bto\boo\bo
-
+   G\bGe\ben\bnt\bto\boo\bo
        In Gentoo installing rrdtool is really simple you just need to e\bem\bme\ber\brg\bge\be
        r\brr\brd\bdt\bto\boo\bol\bl. 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 fol-
-       lowing USE flags are available:
+       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/
@@ -132,23 +129,21 @@ B\bBU\bUI\bIL\bLD\bDI\bIN\bNG\bG D\bDE\bEP\bPE\bEN\bND\bDE\bEN\bNC\bCI\bIE\bES\bS
        don't live up to our expectations, so you may want to compile their
        latest versions.
 
-       G\bGe\ben\bne\ber\bra\bal\bl b\bbu\bui\bil\bld\bd t\bti\bip\bps\bs f\bfo\bor\br A\bAI\bIX\bX
-
+   G\bGe\ben\bne\ber\bra\bal\bl b\bbu\bui\bil\bld\bd t\bti\bip\bps\bs f\bfo\bor\br A\bAI\bIX\bX
        If you are working with AIX, you may find the -\b--\b-d\bdi\bis\bsa\bab\bbl\ble\be-\b-s\bsh\bha\bar\bre\bed\bd 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--\b-d\bdi\bis\bsa\bab\bbl\ble\be-\b-s\bst\bta\bat\bti\bic\bc instead.
 
-       Another hint to get rrdtool working on AIX is to use the IBM XL C Com-
-       piler:
+       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!)
 
-       B\bBu\bui\bil\bld\bd I\bIn\bns\bst\btr\bru\buc\bct\bti\bio\bon\bns\bs
-
+   B\bBu\bui\bil\bld\bd I\bIn\bns\bst\btr\bru\buc\bct\bti\bio\bon\bns\bs
        Some libraries want to know where other libraries are. For this to
        work, set the following environment variable
 
@@ -159,8 +154,8 @@ B\bBU\bUI\bIL\bLD\bDI\bIN\bNG\bG D\bDE\bEP\bPE\bEN\bND\bDE\bEN\bNC\bCI\bIE\bES\bS
        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 LDFLAGS. Unfor-
-       tunately, the syntax again differs from system to system:
+       find each other. This is done by setting an appropriate LDFLAGS.
+       Unfortunately, the syntax again differs from system to system:
 
        Solaris
             export LDFLAGS=-R${INSTALL_DIR}/lib
@@ -192,8 +187,8 @@ B\bBU\bUI\bIL\bLD\bDI\bIN\bNG\bG D\bDE\bEP\bPE\bEN\bND\bDE\bEN\bNC\bCI\bIE\bES\bS
        _\bB_\bu_\bi_\bl_\bd_\bi_\bn_\bg _\bp_\bk_\bg_\bc_\bo_\bn_\bf_\bi_\bg
 
        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 sys-
-       tem. If it is not available natively, here is how to compile it.
+       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.
 
         wget http://pkgconfig.freedesktop.org/releases/pkg-config-0.23.tar.gz
         gunzip -c pkg-config-0.23.tar.gz | tar xf -
@@ -202,8 +197,8 @@ B\bBU\bUI\bIL\bLD\bDI\bIN\bNG\bG D\bDE\bEP\bPE\bEN\bND\bDE\bEN\bNC\bCI\bIE\bES\bS
         $MAKE
         $MAKE install
 
-       After installing pkgconfig in a custom directory, setting up the corre-
-       sponding environment variable will be helpful.
+       After installing pkgconfig in a custom directory, setting up the
+       corresponding environment variable will be helpful.
 
         export PKG_CONFIG=$INSTALL_DIR/bin/pkg-config
 
@@ -263,8 +258,8 @@ B\bBU\bUI\bIL\bLD\bDI\bIN\bNG\bG D\bDE\bEP\bPE\bEN\bND\bDE\bEN\bNC\bCI\bIE\bES\bS
 
        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 font-
-       config cache after changing the config file.
+       the fonts on your system.  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
@@ -318,8 +313,7 @@ B\bBU\bUI\bIL\bLD\bDI\bIN\bNG\bG D\bDE\bEP\bPE\bEN\bND\bDE\bEN\bNC\bCI\bIE\bES\bS
         $MAKE
         $MAKE install
 
-       B\bBu\bui\bil\bld\bdi\bin\bng\bg r\brr\brd\bdt\bto\boo\bol\bl (\b(s\bse\bec\bco\bon\bnd\bd t\btr\bry\by)\b)
-
+   B\bBu\bui\bil\bld\bdi\bin\bng\bg r\brr\brd\bdt\bto\boo\bol\bl (\b(s\bse\bec\bco\bon\bnd\bd t\btr\bry\by)\b)
        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
@@ -339,8 +333,8 @@ B\bBU\bUI\bIL\bLD\bDI\bIN\bNG\bG D\bDE\bEP\bPE\bEN\bND\bDE\bEN\bNC\bCI\bIE\bES\bS
 
        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 bind-
-       ings/perl-shared/Makefile while building!
+       installed on your box or you have to hand-tune
+       bindings/perl-shared/Makefile while building!
 
        Now go to _\b$_\bI_\bN_\bS_\bT_\bA_\bL_\bL_\b__\bD_\bI_\bR/\b/s\bsh\bha\bar\bre\be/\b/r\brr\brd\bdt\bto\boo\bol\bl/\b/e\bex\bxa\bam\bmp\bpl\ble\bes\bs/\b/ and run them to see if
        your build has been successful.
@@ -350,4 +344,4 @@ A\bAU\bUT\bTH\bHO\bOR\bR
 
 
 
-1.3.99909060808                   2008-12-26                       RRDBUILD(1)
+1.3.999                           2009-06-09                       RRDBUILD(1)