Code

collectd.conf(5): Fixed documentation for include filter patterns.
authorSebastian Harl <sh@tokkee.org>
Thu, 2 May 2013 20:41:35 +0000 (22:41 +0200)
committerSebastian Harl <sh@tokkee.org>
Thu, 2 May 2013 20:41:35 +0000 (22:41 +0200)
The syntax has been changed from a positional argument to using an <Include>
block with additional arguments.

src/collectd.conf.pod

index 8606d3e05533ff123f606e30ea7ef1f514c8857b..af068604f45ff7bacd3d0b411ab5e1f2755370b3 100644 (file)
@@ -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