diff --git a/doc/rrdbuild.1 b/doc/rrdbuild.1
index cc01820f627e9774248d0ea0b032b2f2ca650604..29f5f0c571eed8cb808a6be0063e6e2817a6d0fe 100644 (file)
--- a/doc/rrdbuild.1
+++ b/doc/rrdbuild.1
-.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.14
+.\" Automatically generated by Pod::Man 2.22 (Pod::Simple 3.07)
.\"
.\" 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
..
.\" Set up some character translations and predefined strings. \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
-.\" double quote, and \*(R" will give a right double quote. | will give a
-.\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used to
-.\" do unbreakable dashes and therefore won't be available. \*(C` and \*(C'
-.\" expand to `' in nroff, nothing in troff, for use with C<>.
-.tr \(*W-|\(bv\*(Tr
+.\" double quote, and \*(R" will give a right double quote. \*(C+ will
+.\" give a nicer C++. Capital omega is used to do unbreakable dashes and
+.\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
+.\" nothing in troff, for use with C<>.
+.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
. ds -- \(*W-
. 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-12-26" "1.3.99909060808" "rrdtool"
+.TH RRDBUILD 1 "2012-01-24" "1.4.7" "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.2
+\& INSTALL_DIR=/opt/rrdtool\-1.4.7
.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.2.tar.gz
-\& gunzip \-c rrdtool\-1.3.2.tar.gz | tar xf \-
-\& cd rrdtool\-1.3.2
+\& wget http://oss.oetiker.ch/rrdtool/pub/rrdtool\-1.4.7.tar.gz
+\& gunzip \-c rrdtool\-1.4.7.tar.gz | tar xf \-
+\& cd rrdtool\-1.4.7
\& ./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. In general rrdtool should work with the
+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.
-.Sh "OpenSolaris 2008.05"
+.SS "OpenSolaris 2008.05"
.IX Subsection "OpenSolaris 2008.05"
Just add a compiler and the gnome development package:
.PP
fix this:
.PP
.Vb 1
-\& perl \-i~ \-p \-e 's/(Requires.*?)\es*xrender.*/$1/' /usr/lib/pkgconfig/cairo.pc
+\& perl \-i~ \-p \-e \*(Aqs/(Requires.*?)\es*xrender.*/$1/\*(Aq /usr/lib/pkgconfig/cairo.pc
.Ve
.PP
-Make sure rrdtool finds your new compiler
+Make sure the RRDtool build system finds your new compiler
.PP
.Vb 1
\& export PATH=/opt/SunStudioExpress/bin
.Ve
-.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.
-.Sh "Debian / Ubuntu"
+.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 \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
@@ -288,7 +278,7 @@ 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"
Some libraries want to know where other libraries are. For this to work,
set the following environment variable
\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
\& cd $BUILD_DIR
\& wget http://oss.oetiker.ch/rrdtool/pub/libs/cairo\-1.6.4.tar.gz
\& gunzip \-c cairo\-1.6.4.tar.gz | tar xf \-
-\& cd cairo\-1.4.10
+\& cd cairo\-1.6.4
\& ./configure \-\-prefix=$INSTALL_DIR \e
\& \-\-enable\-xlib=no \e
\& \-\-enable\-xlib\-render=no \e
\& $MAKE install
.Ve
.PP
+When building on Solaris you may want todo
+.PP
+.Vb 5
+\& ./configure \-\-prefix=$INSTALL_DIR \e
+\& \-\-enable\-xlib=no \e
+\& \-\-enable\-xlib\-render=no \e
+\& \-\-enable\-win32=no \e
+\& CFLAGS="\-O3 \-fPIC \-D_POSIX_PTHREAD_SEMANTICS"
+.Ve
+.PP
\fIBuilding Glib\fR
.IX Subsection "Building Glib"
.PP
\& $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.2
+\& cd $BUILD_DIR/rrdtool\-1.4.7
\& ./configure \-\-prefix=$INSTALL_DIR \-\-disable\-tcl \-\-disable\-python
\& $MAKE clean
\& $MAKE
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"