added support for FLUSHALL command -- kevin brintnall

[rrdtool.git] / doc / rrdpython.pod

diff --git a/doc/rrdpython.pod b/doc/rrdpython.pod
index a158577..d504deb 100644 (file)
--- a/doc/rrdpython.pod
+++ b/doc/rrdpython.pod
@@ -18,13 +18,15 @@ to the other B<rrdtool> documentation for functions and valid arguments.
 
 =head1 EXAMPLE
 
+ import sys
+ sys.path.append('/path/to/rrdtool/lib/python2.3/site-packages/')
  import rrdtool, tempfile
 
  DAY = 86400
  YEAR = 365 * DAY
  fd,path = tempfile.mkstemp('.png')
 
- rrdtool.graph(path, 
+ rrdtool.graph(path,
               '--imgformat', 'PNG',
               '--width', '540',
               '--height', '100',
@@ -40,6 +42,11 @@ to the other B<rrdtool> documentation for functions and valid arguments.
  print info['last_update']
  print info['ds']['downloads']['minimal_heartbeat']
 
+If you use the B<site-python-install> make target you can drop to first sys.path.append
+line since the rrdtool module will be available everywhere.
+
+If rrdtool runs into trouble, it will throw an exception which you might want to catch.
+
 =head1 SEE ALSO
 
 rrdcreate, rrdupdate, rrdgraph, rrddump, rrdfetch, rrdtune, rrdlast,