Add documentation

plugins/teamspeak/teamspeak_user

@@ -1,24 +1,58 @@
 #!/usr/bin/perl -w
-# teamspeak_user.pl
-# Munin Plugin for Teamspeak3 Servers
-# displays the number of connected users on TS3 servers
 
-#######################################################
+=head1 NAME
-#
+
-# by Tim Wulkau - www.wulkau.de
+Munin Plugin for Teamspeak3 Servers
-#
+
-# 18.11.10 - v0.4
+Displays the number of connected users on TS3 servers
-#            -added queryuser login
+
-#	     -subtract queryclients from usercount (tanks to Jakob Lenfers for the idea)
+=head1 INSTALLATION
-# 02.10.10 - v0.3
+
-#            -fixed welcomemessage error
+- Copy this plugin in your munin plugins directory
-# 31.01.10 - v0.2
+
-#            -fixed multiserver support
+=over 2
-#            -corrected usercount
+
-# 17.01.10 - v0.1
+    ln -s /usr/share/munin/plugins/teamspeak_user /etc/munin/plugins/teamspeak_user
-#            -initial release
+
-#
+=back
-######################################################
+
+After the installation you need to restart your munin-node service.
+
+=head1 CONFIGURATION
+
+You need to create a file named teamspeak_user placed in the directory
+/etc/munin/plugin-conf.d/ with the following config:
+
+=over 2
+
+    [teamspeak_user]
+    env.hostname 127.0.0.1
+    env.port 10011
+    env.username serveradmin
+    env.password <password>
+
+=back
+
+=head1 AUTHORS
+
+Tim Wulkau - www.wulkau.de
+
+=head1 CHANGELOG
+
+23.01.22 - v0.5
+           -add environment variables
+18.11.10 - v0.4
+           -added queryuser login
+           -subtract queryclients from usercount (tanks to Jakob Lenfers for the idea)
+02.10.10 - v0.3
+           -fixed welcomemessage error
+31.01.10 - v0.2
+           -fixed multiserver support
+           -corrected usercount
+17.01.10 - v0.1
+           -initial release
+
+=cut
 
 use strict;
 use Net::Telnet;