From: Marc Fournier <marc.fournier@camptocamp.com>
Date: Fri, 17 May 2013 10:54:16 +0000 (+0200)
Subject: Improve varnish section in manpage.
X-Git-Tag: collectd-5.3.1~4^2~4^2~1
X-Git-Url: https://git.tokkee.org/?a=commitdiff_plain;h=7d71adcde084aef18f54dddb253c6a2d039b418d;p=collectd.git

Improve varnish section in manpage.

There previously was no mention of the mandatory <Instance> block.
---

diff --git a/src/collectd.conf.pod b/src/collectd.conf.pod
index c025f949..6c39f710 100644
--- a/src/collectd.conf.pod
+++ b/src/collectd.conf.pod
@@ -4775,7 +4775,33 @@ Take the UUID from the given file (default I</etc/uuid>).
 
 =head2 Plugin C<varnish>
 
-The Varnish plugin collects information about Varnish, an HTTP accelerator.
+The I<varnish plugin> collects information about Varnish, an HTTP accelerator.
+
+Synopsis:
+
+ <Plugin "varnish">
+   <Instance "example">
+     CollectCache       true
+     CollectConnections true
+     CollectBackend     true
+     CollectSHM         true
+     CollectESI         false
+     CollectFetch       false
+     CollectHCB         false
+     CollectSMA         false
+     CollectSMS         false
+     CollectSM          false
+     CollectTotals      false
+     CollectWorkers     false
+   </Instance>
+ </Plugin>
+
+The configuration consists of one or more E<lt>B<Instance>E<nbsp>I<Name>E<gt>
+blocks. I<Name> is the parameter passed to "varnishd -n". If left empty, it
+will collectd statistics from the default "varnishd" instance (this should work
+fine in most cases).
+
+Inside each E<lt>B<Instance>E<gt> blocks, the following options are recognized:
 
 =over 4