Fix potential memory leak in rrd_flushcached during failure. -- kevin

[rrdtool.git] / doc / rrdpython.pod

diff --git a/doc/rrdpython.pod b/doc/rrdpython.pod
index dc329ec..b6f9075 100644 (file)
--- a/doc/rrdpython.pod
+++ b/doc/rrdpython.pod
@@ -5,7 +5,7 @@ rrdpython - About the RRD Python bindings
 =head1 SYNOPSIS
 
  import rrdtool
 =head1 SYNOPSIS
 
  import rrdtool

- rrdtool.create('/tmp/test.rrd', 'DS:foo:GUAGE:20:0:U')
+ rrdtool.create('/tmp/test.rrd', 'DS:foo:GAUGE:20:0:U')

 
 =head1 DESCRIPTION
 
 
 =head1 DESCRIPTION
 


@@ -13,12 +13,15 @@ The B<rrdtool> functions are directly callable via the Python programming
 language. This wrapper implementation has been written from the scratch
 (without  SWIG)
 
 language. This wrapper implementation has been written from the scratch
 (without  SWIG)
 

-The API's simply expects string parameters to the functions.  Please refer
-to the other B<rrdtool> documentation for functions and valid arguments.
+The API's expects strings and/or list of strings as parameters to the functions.
+Please refer to the other B<rrdtool> documentation for functions and valid arguments.

 
 

-=head1 EXAMPLE
+=head1 EXAMPLES

 
 

- sys.path.append('/path/to/rrdtool/lib/python2.3/site-packages/')
+=head2 Example 1
+
+ import sys
+ sys.path.append('/path/to/rrdtool/lib/python2.6/site-packages/')

  import rrdtool, tempfile
 
  DAY = 86400
  import rrdtool, tempfile
 
  DAY = 86400


@@ -41,6 +44,23 @@ to the other B<rrdtool> documentation for functions and valid arguments.
  print info['last_update']
  print info['ds']['downloads']['minimal_heartbeat']
 
  print info['last_update']
  print info['ds']['downloads']['minimal_heartbeat']
 

+=head2 Example 2
+
+ import sys
+ sys.path.append('/path/to/rrdtool/lib/python2.6/site-packages/')
+ import rrdtool
+
+ # in real life data_sources would be populated in loop or something similar
+ data_sources=[ 'DS:speed1:COUNTER:600:U:U',
+                'DS:speed2:COUNTER:600:U:U',
+                'DS:speed3:COUNTER:600:U:U' ]
+
+ rrdtool.create( 'speed.rrd',
+                 '--start', '920804400',
+                 data_sources,
+                 'RRA:AVERAGE:0.5:1:24',
+                 'RRA:AVERAGE:0.5:6:10' )
+

 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 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.
 


@@ -56,4 +76,3 @@ rrdxport, rrdinfo
 Hye-Shik Chang E<lt>perky@i18n.orgE<gt>
 
 Alan Milligan E<lt>alan.milligan@last-bastion.netE<gt>
 Hye-Shik Chang E<lt>perky@i18n.orgE<gt>
 
 Alan Milligan E<lt>alan.milligan@last-bastion.netE<gt>

-