From: Sebastian Harl <sh@tokkee.org>
Date: Thu, 2 May 2013 20:41:35 +0000 (+0200)
Subject: collectd.conf(5): Fixed documentation for include filter patterns.
X-Git-Tag: collectd-5.3.1~5
X-Git-Url: https://git.verplant.org/?a=commitdiff_plain;h=fb67910d554cbf5d6c7035a72561058e8d92f90c;p=collectd.git

collectd.conf(5): Fixed documentation for include filter patterns.

The syntax has been changed from a positional argument to using an <Include>
block with additional arguments.
---

diff --git a/src/collectd.conf.pod b/src/collectd.conf.pod
index 8606d3e0..af068604 100644
--- a/src/collectd.conf.pod
+++ b/src/collectd.conf.pod
@@ -109,7 +109,7 @@ interval, that setting will take precedence.
 
 =back
 
-=item B<Include> I<Path> [I<pattern>]
+=item B<Include> I<Path>
 
 If I<Path> points to a file, includes that file. If I<Path> points to a
 directory, recursively includes all files within that directory and its
@@ -119,15 +119,29 @@ use statements like the following:
 
   Include "/etc/collectd.d/*.conf"
 
+Starting with version 5.3, this may also be a block in which further options
+affecting the behavior of B<Include> may be specified. The following option is
+currently allowed:
+
+  <Include "/etc/collectd.d">
+    Filter "*.conf"
+  </Include>
+
+=over 4
+
+=item B<Filter> I<pattern>
+
 If the C<fnmatch> function is available on your system, a shell-like wildcard
 I<pattern> may be specified to filter which files to include. This may be used
 in combination with recursively including a directory to easily be able to
 arbitrarily mix configuration files and other documents (e.g. README files).
-The following statement is similar to the example above but includes all files
+The given example is similar to the first example above but includes all files
 matching C<*.conf> in any subdirectory of C</etc/collectd.d>:
 
   Include "/etc/collectd.d" "*.conf"
 
+=back
+
 If more than one files are included by a single B<Include> option, the files
 will be included in lexicographical order (as defined by the C<strcmp>
 function). Thus, you can e.E<nbsp>g. use numbered prefixes to specify the