From: Florian Forster <octo@collectd.org>
Date: Sun, 11 Mar 2012 12:04:13 +0000 (+0100)
Subject: collectd.conf(5): Improve the network plugin's documentation.
X-Git-Tag: collectd-4.10.7~11
X-Git-Url: https://git.tokkee.org/?a=commitdiff_plain;h=7c0343ce60a3c51edb409de96dc08e2cc7a88abf;p=collectd.git

collectd.conf(5): Improve the network plugin's documentation.

The example given was confusing since it didn't make it clear enough, that only
one "Server" stanza is required.

Resolves GitHub issue #19.
---

diff --git a/src/collectd.conf.pod b/src/collectd.conf.pod
index 62374b62..74249d7f 100644
--- a/src/collectd.conf.pod
+++ b/src/collectd.conf.pod
@@ -2502,10 +2502,18 @@ The default IPv6 multicast group is C<ff18::efc0:4a42>. The default IPv4
 multicast group is C<239.192.74.66>. The default I<UDP> port is B<25826>.
 
 Both, B<Server> and B<Listen> can be used as single option or as block. When
-used as block, given options are valid for this socket only. For example:
+used as block, given options are valid for this socket only. The following
+example will export the metrics twice: Once to an "internal" server (without
+encryption and signing) and one to an external server (with cryptographic
+signature):
 
  <Plugin "network">
+   # Export to an internal server
+   # (demonstrates usage without additional options)
    Server "collectd.internal.tld"
+   
+   # Export to an external server
+   # (demonstrates usage with signature options)
    <Server "collectd.external.tld">
      SecurityLevel "sign"
      Username "myhostname"