From 7ae2054977e93eb08e0177740637a919879c5fb6 Mon Sep 17 00:00:00 2001 From: Sven Trenkel Date: Thu, 23 Oct 2014 19:01:13 +0000 Subject: [PATCH] python: Add get_dataset() to the man page. --- src/collectd-python.pod | 30 ++++++++++++++++++++++++++++-- 1 file changed, 28 insertions(+), 2 deletions(-) diff --git a/src/collectd-python.pod b/src/collectd-python.pod index 6645614c..fc5376ed 100644 --- a/src/collectd-python.pod +++ b/src/collectd-python.pod @@ -562,7 +562,7 @@ receive blocks where your callback identifier matches BI. The callback will be called without arguments. -=item register_read(callback[, interval][, data][, name]) -> identifier +=item register_read(callback[, interval][, data][, name]) -> I This function takes an additional parameter: I. It specifies the time between calls to the callback function. @@ -616,7 +616,33 @@ I is either the string that was returned by the register function or a callback function. The identifier will be constructed in the same way as for the register functions. -=item B(I][, I]) -> None +=item B(I) -> I + +Returns the definition of a dataset specified by I. I is a list +of tuples, each representing one data source. Each tuple has 4 values: + +=over 4 + +=item name + +A string, the name of the data source. + +=item type + +A string that is equal to either of the variables B, +B, B or B. + +=item min + +A float or None, the minimum value. + +=item max + +A float or None, the maximum value. + +=back + +=item B(I[, I][, I]) -> None Flush one or all plugins. I and the specified I are passed on to the registered flush-callbacks. If omitted, the timeout defaults -- 2.11.0