From: Igor Peshansky <igorpeshansky@github.com>
Date: Thu, 8 Sep 2016 16:26:00 +0000 (-0400)
Subject: Document interpolation and DeleteMetaData.
X-Git-Tag: collectd-5.7.0~99^2~2
X-Git-Url: https://git.verplant.org/?a=commitdiff_plain;h=db1d3f57a0ea740e6011a394605121ce433aced0;p=collectd.git

Document interpolation and DeleteMetaData.
---

diff --git a/src/collectd.conf.pod b/src/collectd.conf.pod
index 0fa74d54..127d5186 100644
--- a/src/collectd.conf.pod
+++ b/src/collectd.conf.pod
@@ -9419,9 +9419,37 @@ Available options:
 
 =item B<MetaData> I<String> I<String>
 
-Set the appropriate field to the given string. The strings for plugin instance
-and type instance may be empty, the strings for host and plugin may not be
-empty. It's currently not possible to set the type of a value this way.
+Set the appropriate field to the given string. The strings for plugin instance,
+type instance, and meta data may be empty, the strings for host and plugin may
+not be empty. It's currently not possible to set the type of a value this way.
+
+The following placeholders will be replaced by an appropriate value:
+
+=over 4
+
+=item B<%{host}>
+
+=item B<%{plugin}>
+
+=item B<%{plugin_instance}>
+
+=item B<%{type}>
+
+=item B<%{type_instance}>
+
+These placeholders are replaced by the identifier field of the same name.
+
+=item B<%{meta:>I<name>B<}>
+
+These placeholders are replaced by the meta data value with the given name.
+
+=back
+
+Please note that these placeholders are B<case sensitive>!
+
+=item B<DeleteMetaData> I<String>
+
+Delete the named meta data field.
 
 =back