From: Sebastian Harl <sh@tokkee.org>
Date: Fri, 18 Jan 2008 11:29:19 +0000 (+0100)
Subject: collectd-exec(5): Improved description of the value-list identifier.
X-Git-Tag: collectd-4.3.0beta0~10^2~3^2
X-Git-Url: https://git.verplant.org/?a=commitdiff_plain;h=57d32cdea9ed71a34cfdf62e8b0050749486319e;p=collectd.git

collectd-exec(5): Improved description of the value-list identifier.

A short note about valid values for the plugin and type names and the
respective instance names as well as a pointer to types.db has been added.

Signed-off-by: Sebastian Harl <sh@tokkee.org>
Signed-off-by: Florian Forster <octo@huhu.verplant.org>
---

diff --git a/src/collectd-exec.pod b/src/collectd-exec.pod
index 27d0eedc..7dc76541 100644
--- a/src/collectd-exec.pod
+++ b/src/collectd-exec.pod
@@ -42,7 +42,11 @@ I<Value-List>, separated by a spaces. A description of these two parts follows:
 An I<Identifier> is of the form
 C<I<host>B</>I<plugin>B<->I<instance>B</>I<type>B<->I<instance>> with both
 I<instance>-parts being optional. If they're omitted the hyphen must be
-omitted, too.
+omitted, too. I<plugin> and each I<instance>-part may be chosen freely as long
+as the tuple (plugin, plugin instance, type instance) uniquely identifies the
+plugin within collectd. I<type> identifies the type and number of values
+(i.E<nbsp>e. data-set) passed to collectd. A large list of predefined
+data-sets is available in the B<types.db> file.
 
 The I<OptionList> is an optional list of I<Options>, where each option if a
 key-value-pair. A list of currently understood options can be found below, all