From: Stefan Hacker <stefan.hacker@web.de>
Date: Sun, 13 Apr 2008 08:11:57 +0000 (+0200)
Subject: collectd.conf(5): Added documentation for the TeamSpeak2 plugin.
X-Git-Tag: collectd-4.4.0~39^2~5
X-Git-Url: https://git.verplant.org/?a=commitdiff_plain;h=f27cdf7cdde903447a5fc9e1340de34a5243f002;p=collectd.git

collectd.conf(5): Added documentation for the TeamSpeak2 plugin.
---

diff --git a/src/collectd.conf.in b/src/collectd.conf.in
index 9771cfd7..281a70f6 100644
--- a/src/collectd.conf.in
+++ b/src/collectd.conf.in
@@ -57,7 +57,7 @@ FQDNLookup   true
 @BUILD_PLUGIN_SYSLOG_TRUE@LoadPlugin syslog
 @BUILD_PLUGIN_TAPE_TRUE@LoadPlugin tape
 @BUILD_PLUGIN_TCPCONNS_TRUE@LoadPlugin tcpconns
-@BUILD_PLUGIN_TSS2@LoadPlugin tss2
+@BUILD_PLUGIN_TEAMSPEAK2@LoadPlugin teamspeak2
 @BUILD_PLUGIN_UNIXSOCK_TRUE@LoadPlugin unixsock
 @BUILD_PLUGIN_USERS_TRUE@LoadPlugin users
 @BUILD_PLUGIN_UUID_TRUE@LoadPlugin uuid
@@ -280,7 +280,7 @@ FQDNLookup   true
 #	RemotePort "25"
 #</Plugin>
 
-#<Plugin tss2>
+#<Plugin teamspeak2>
 #	Host "127.0.0.1"
 #	Port 51234
 #	Server 8767
diff --git a/src/collectd.conf.pod b/src/collectd.conf.pod
index d3f5195a..8b6f2bf9 100644
--- a/src/collectd.conf.pod
+++ b/src/collectd.conf.pod
@@ -1103,6 +1103,32 @@ This optional setting sets the type instance to use.
 
 =back
 
+=head2 Plugin C<teamspeak2>
+
+The C<teamspeak2 plugin> connects to the query port of a teamspeak2 server and
+polls interesting global and virtual server data. The plugin can query only one
+physical server but unlimited virtual servers. You can use the following options
+to configure it:
+
+=over 4
+
+=item B<Host> I<hostname/ip>
+
+The hostname or ip which identifies the physical server.
+Default: 127.0.0.1
+
+=item B<Port> I<port>
+
+The query port of the physical server.
+Default: 51234
+
+=item B<Server> I<port>
+
+This option has to be added once for every virtual server the plugin should
+query. If you want to query the virtual server on port 8767 this is what the
+option would look like:
+Server 8767
+
 =head2 Plugin C<tcpconns>
 
 The C<tcpconns plugin> counts the number of currently established TCP
@@ -1113,6 +1139,8 @@ fine-tune the ports you are interested in:
 
 =over 4
 
+=back
+
 =item B<ListeningPorts> I<true>|I<false>
 
 If this option is set to I<true>, statistics for all local ports for which a