X-Git-Url: https://git.octo.it/?a=blobdiff_plain;f=doc%2Frrdpython.pod;h=ba21f1608ddf0ee3c112aed211b87b4a85da6203;hb=a490ff8d4ae97046a200b6a1c9c033d9b461b77d;hp=a158577f7f983dd474e3bf3b569a03fc3ce4eeb9;hpb=9b1205b30b37e1ef53666a1a1d51b573259becdf;p=rrdtool.git

diff --git a/doc/rrdpython.pod b/doc/rrdpython.pod
index a158577..ba21f16 100644
--- a/doc/rrdpython.pod
+++ b/doc/rrdpython.pod
@@ -5,7 +5,7 @@ rrdpython - About the RRD Python bindings
 =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
 
@@ -13,18 +13,22 @@ The B<rrdtool> functions are directly callable via the Python programming
 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
 
+=head2 Example 1
+
+ import sys
+ sys.path.append('/path/to/rrdtool/lib/python2.6/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',
@@ -38,7 +42,29 @@ to the other B<rrdtool> documentation for functions and valid arguments.
 
  info = rrdtool.info('downloads.rrd')
  print info['last_update']
- print info['ds']['downloads']['minimal_heartbeat']
+ 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 RRDtool runs into trouble, it will throw an exception which you might want to catch.
 
 =head1 SEE ALSO
 
@@ -50,4 +76,3 @@ rrdxport, rrdinfo
 Hye-Shik Chang E<lt>perky@i18n.orgE<gt>
 
 Alan Milligan E<lt>alan.milligan@last-bastion.netE<gt>
-