Code

maximum library version is 255
[rrdtool-all.git] / contrib / php4 / README
1 $Id$
3 UPDATES for php4:
5     This version of the module will only build for php4/zend.  It will
6 not build for php3.  Get php3_rrdtool from the rrdtool distribution
7 if you need the rrd_* functions in php3.  
9     The module now contains two ways to install.  The first is as
10 a self-contained extension (much like the php3_rrdtool module),
11 and the second is as a php4 embedded extension.  See the INSTALL
12 file for instructions on how to install in both ways.
14     Also fixed some of the scripts in the 'examples' directory. 
15 A few of them were checking the return value for -1 on some
16 of the rrd_* function calls.  Most calls will return 0 or 1 to
17 indicate failure or success, not -1.  Sorry about that.
21 ------------------------------------
23 PHP bindings for RRD Tool.
25     Contained herein are bindings to allow you to interface
26 php scripts with RRD tool directly via RRD tool's 'librrd' library,
27 thus avoiding the need to use system() calls to the rrdtool binary.
29     RRD Tool is an AMAZING package of tools to faciliate
30 the easy storage, retrieval, and graphing of statistics (usually
31 but not limited to bit/byte counts from routers, switches, and 
32 hubs).  It was written by the author of MRTG, Tobias Oetiker
33 (oetiker@ee.ethz.ch).  The primary web site for RRD Tool is:
34 http://www.caida.org/Tools/RRDtool
37 Reason I wrote this:  Wanted to use PHP to create fairly real-time / 
38 dynamic web pages w/ RRD tool, but the only way was to use system()
39 and popen() with PHP, since there was no direct interface to RRD
40 Tool from PHP.  The fork()ing would have been slow and tedious
41 so that was pretty much out of the question.  I could have used the 
42 Perl library (RRDs) to interface ePerl, or mod_perl, or even 
43 'rrdcgi', but I didn't really want to.  I wanted to use PHP and
44 there was nothing to change my mind.
47 You are free to redistribute the source provided my name is
48 kept at the top of the source files as credit for the original
49 author.  I make no warranties to the usability of this software,
50 nor I am responsible if your machine explodes (although it 
51 shouldn't).
54 BUGS:
55      There might be some.  Let me know: joeym@inficad.com.  
56 Patches to fix bugs you find are more welcome than simple
57 reports of bugs (I don't have a lot of time to maintain
58 this code).
60         You must include OS, apache version, and method of use
61 (embedded or self-contained extension) in bug reports.  This
62 info is important.  Also, give as much detail and examples 
63 as possible so I can figure out what is wrong =)
65 THANKS:
66         I'd like to thank Jeroen Roodnat for generously helping 
67 debug the PHP4/Zend version of this module.  
70 Joe Miller, <joeym@inficad.com>,<joeym@ibizcorp.com>,
71 2/12/2000  (updated: 8/28/2000)