Improve documantion of many plugins

Specifically the configuration examples are now indented properly.

plugins/apache/apache_vhosts/apache_vhosts

@@ -32,9 +32,15 @@ user root
   env.subgraphs requests bytes time
   env.checks requests bytes time
 
-# user		- probably necessary for shared memory IPC
+=over 4
-# subgraphs 	- create multigraph subgraphs (watch your graphing performance...), default 0
+
-# checks	- enable stats on bytes and response times per request, you have to log these in apache
+=item user - probably necessary for shared memory IPC
+
+=item subgraphs - create multigraph subgraphs (watch your graphing performance...), default 0
+
+=item checks - enable stats on bytes and response times per request, you have to log these in apache
+
+=back
 
 A word on performance:
 Requests/sec should not be much of a problem.  Pipelogger and Logparser should not have man performance problems, as the apply one regex per line and add some stats.

plugins/currency/nanopool/nanopool_

@@ -51,6 +51,8 @@ GNU General Public License for more details.
 You should have received a copy of the GNU General Public License
 along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
+SPDX-License-Identifier: GPL-3.0-or-later
+
 =head1 MAGIC MARKERS
 
  #%# family=contrib

plugins/docker/docker_cpu

@@ -30,8 +30,7 @@ user root
 
 =head1 AUTHOR
 
-Copyright (C) 2015 Samuel Cantero.
+Copyright (C) 2015 Samuel Cantero <scanterog at gmail dot com>
-Email: scanterog at gmail dot com
 
 =head1 LICENSE
 

plugins/docker/docker_memory

@@ -30,8 +30,7 @@ user root
 
 =head1 AUTHOR
 
-Copyright (C) 2015 Samuel Cantero.
+Copyright (C) 2015 Samuel Cantero <scanterog at gmail dot com>
-Email: scanterog at gmail dot com
 
 =head1 LICENSE
 

plugins/etherpadlite/etherpadlite_

@@ -6,8 +6,7 @@ set -e
 
 =head1 NAME
 
-etherpadlite_ - Monitor number of pads with etherpad-lite plugin called 
+etherpadlite_ - Monitor number of pads with etherpad-lite plugin called ep_pads_stats
-ep_pads_stats
 
 =head1 APPLICABLE SYSTEMS
 

plugins/git/git_commit_behind

@@ -3,8 +3,7 @@
 """=cut
 =head1 NAME
 
-git_commit_behind - Munin plugin to monitor local git repositories and report
+git_commit_behind - Munin plugin to monitor local git repositories and report how many commits behind their remote they are
-how many commits behind their remote they are
 
 =head1 NOTES
 
@@ -19,13 +18,20 @@ separate cron job.
 
 =head1 REQUIREMENTS
 
- - Python3
+=over 4
- - Git
+
+=item Python3
+
+=item Git
+
+=back
+
 
 =head1 INSTALLATION
 
 Link this plugin, as usual.
 For example :
+
   ln -s /path/to/git_commit_behind /etc/munin/plugins/git_commit_behind
 
 If you wish to update the repositories via cron and not during the plugin
@@ -43,6 +49,7 @@ For example, you can use the following cron :
 =head1 CONFIGURATION
 
 Use your "/etc/munin/plugin-conf.d/munin-node" to configure this plugin.
+
     [git_commit_behind]
     user [user]
     env.git_path /path/to/git
@@ -63,7 +70,8 @@ env.update.maxinterval : optional (default : 7200),
 
 
 Then, for each repository you want to check, you need the following
-configuration block under the git_commit_behind section
+configuration block under the git_commit_behind section:
+
     env.repo.[repoCode].path /path/to/local/repo
     env.repo.[repoCode].name Repo Name
     env.repo.[repoCode].user user

plugins/jitsi/jitsi_videobridge

@@ -6,8 +6,7 @@ set -e
 
 =head1 NAME
 
-jitsi_videobridge - Monitor sessions and conferences 
+jitsi_videobridge - Monitor sessions and conferences on a jitsi-videobridge
-on a jitsi-videobridge
 
 =head1 APPLICABLE SYSTEMS
 

plugins/netapp/snmp__netapp_cifs2

@@ -48,6 +48,7 @@ This plugin wasn't tested on many hardware and only on Ontap 7.3.x.
 =head1 AUTHOR
 
 2013, Claudius Herder
+
 NetApp is a registered trademark and Network Appliance is a trademark
 of Network Appliance, Inc. in the U.S. and other countries.
 

plugins/netapp/snmp__netapp_cifscalls

@@ -50,6 +50,7 @@ This plugin wasn't tested on many hardware and only on Ontap 7.3.x.
 =head1 AUTHOR
 
 2013, Claudius Herder
+
 NetApp is a registered trademark and Network Appliance is a trademark
 of Network Appliance, Inc. in the U.S. and other countries.
 

plugins/netapp/snmp__netapp_cpu2

@@ -48,6 +48,7 @@ This plugin wasn't tested on many hardware and only on Ontap 7.3.x.
 =head1 AUTHOR
 
 2013, Claudius Herder
+
 NetApp is a registered trademark and Network Appliance is a trademark
 of Network Appliance, Inc. in the U.S. and other countries.
 

plugins/netapp/snmp__netapp_diskusage2_

@@ -48,6 +48,7 @@ This plugin wasn't tested on many hardware and only on Ontap 7.3.x.
 =head1 AUTHOR
 
 2013, Claudius Herder
+
 NetApp is a registered trademark and Network Appliance is a trademark
 of Network Appliance, Inc. in the U.S. and other countries.
 

plugins/netapp/snmp__netapp_diskutil

@@ -48,6 +48,7 @@ This plugin wasn't tested on many hardware and only on Ontap 7.3.x.
 =head1 AUTHOR
 
 2013, Claudius Herder
+
 NetApp is a registered trademark and Network Appliance is a trademark
 of Network Appliance, Inc. in the U.S. and other countries.
 

plugins/netapp/snmp__netapp_ndmp

@@ -48,6 +48,7 @@ This plugin wasn't tested on many hardware and only on Ontap 7.3.x.
 =head1 AUTHOR
 
 2013, Claudius Herder
+
 NetApp is a registered trademark and Network Appliance is a trademark
 of Network Appliance, Inc. in the U.S. and other countries.
 

plugins/netapp/snmp__netapp_net

@@ -48,6 +48,7 @@ This plugin wasn't tested on many hardware and only on Ontap 7.3.x.
 =head1 AUTHOR
 
 2013, Claudius Herder
+
 NetApp is a registered trademark and Network Appliance is a trademark
 of Network Appliance, Inc. in the U.S. and other countries.
 

plugins/netapp/snmp__netapp_nfs3calls

@@ -45,6 +45,7 @@ Network Appliance. It reports the content of the v3Calls OID.
 =head1 VERSION
 
 v1.0 - 06/19/2009 18:36:02 CEST
+
 Initial revision
 
 =head1 AUTHOR
@@ -63,6 +64,8 @@ please report any to Guillaume Blairon E<lt>L<g@yom.be>E<gt>.
 
 GPLv2 or (at your option) any later version.
 
+SPDX-License-Identifier: GPL-2.0-or-later
+
 =cut
 
 use strict;

plugins/netapp/snmp__netapp_ops

@@ -48,6 +48,7 @@ This plugin wasn't tested on many hardware and only on Ontap 7.3.x.
 =head1 AUTHOR
 
 2013, Claudius Herder
+
 NetApp is a registered trademark and Network Appliance is a trademark
 of Network Appliance, Inc. in the U.S. and other countries.
 

plugins/netapp/snmp__netapp_sis

@@ -49,6 +49,7 @@ This plugin wasn't tested on many hardware and only on Ontap 7.3.x.
 =head1 AUTHOR
 
 2013, Claudius Herder
+
 NetApp is a registered trademark and Network Appliance is a trademark
 of Network Appliance, Inc. in the U.S. and other countries.
 

plugins/network/linux_if/linux_if

@@ -1,17 +1,29 @@
 #!/usr/bin/env python
 
 """
+=head1 NAME
+
 linux_if - munin plugin monitoring Linux network interfaces
 
+
+=head1 DESCRIPTION
+
 This is not a wildcard plugin. Monitored interfaces are controlled
 by 'include', 'exclude' in config. By default, only statically
 configured interfaces (and their sub-interfaces) are monitored.
 
 Features:
-* bonding - group bonding slave interfaces with master
-* vlans - group vlan sub-interfaces with main (dot1q trunk) interface
 
-plugin configuration:
+=over
+
+=item bonding - group bonding slave interfaces with master
+
+=item vlans - group vlan sub-interfaces with main (dot1q trunk) interface
+
+=back
+
+
+=head1 CONFIGURATION
 
   [linux_if]
   # run plugin as root (required if you have VLAN sub-interfaces)
@@ -31,22 +43,44 @@ plugin configuration:
   # default: true
   env.include_configured_if = true
 
-Include/exclude logic in detail. Interface name is matched..
+Include/exclude logic in detail. Interface name is matched according to the following rules:
-1) if matched by any exclude pattern, then exclude. Otherwise next step.
+
-2) if matched by any include pattern, then include, Otherwise next step.
+=over 4
-3) if 'include_configured_if' is true and 'ifcfg-*' file exists then include
+
-4) default is not to include interface in monitoring
+=item 1. if matched by any exclude pattern, then exclude. Otherwise next step.
-5) automatically include sub-interface, if the parent interface is monitored
+
+=item 2. if matched by any include pattern, then include, Otherwise next step.
+
+=item 3. if 'include_configured_if' is true and 'ifcfg-*' file exists then include
+
+=item 4. default is not to include interface in monitoring
+
+=item 5. automatically include sub-interface, if the parent interface is monitored
+
+=back
 
 Tested on: RHEL 6.x and clones (with Python 2.6)
 
-TODO:
-* implement 'data loaning' between graphs, removes duplicit measures
-* add support for bridging
-* configurable graph max based on interface speed
 
-MUNIN MAGIC MARKER
+=head1 TODO
+
+=over 4
+
+=item implement 'data loaning' between graphs, removes duplicit measures
+
+=item add support for bridging
+
+=item configurable graph max based on interface speed
+
+=back
+
+
+=head1 MAGIC MARKERS
+
  #%# family=manual
+
+
+=cut
 """
 
 __author__ = 'Brano Zarnovican'

plugins/network/multibandwidth

@@ -31,23 +31,28 @@ env.small_packet_size 44
  env.big_packet_size 108
  env.max_valid_bps 15728640
 
-- env.hosts: space separated list of hostnames or IPs of the hosts to calculate the bandwidth.
+=over 4
+
+=item env.hosts: space separated list of hostnames or IPs of the hosts to calculate the bandwidth.
         This setting is required.
 
-- env.samples: Reset stats after sending this number of ECHO_REQUEST packets.
+=item env.samples: Reset stats after sending this number of ECHO_REQUEST packets.
         Defaults to 15 samples.
 
-- env.small_packet_size: Specifies the number of data bytes to be sent in the small
+=item env.small_packet_size: Specifies the number of data bytes to be sent in the small
         packets. The default and minimum value is 44.
 
-- env.big_packet_size: Specifies the number of data bytes to be sent in the big
+=item env.big_packet_size: Specifies the number of data bytes to be sent in the big
         packets. The default is 108. The size should be chosen so that big packet roundtrip times
         are long enough to be accurately measured.
 
-- env.max_valid_bps: bing have some random spikes. This variable is used to indicate
+=item env.max_valid_bps: bing have some random spikes. This variable is used to indicate
         the maximum value of mbps that can be recorded (in bps).
         Defaults to the empty string (no validity check).
 
+=back
+
+
 =head1 MAGIC MARKERS
 
  #%# capabilities=autoconf
@@ -59,6 +64,7 @@ env.max_valid_bps 15728640
 =head1 AUTHOR
 
 Jose Manuel Febrer Cortés <https://www.linkedin.com/in/jfebrer/>
+
 Marco Bertola’s help <https://www.linkedin.com/in/bertolamarco/>
 
 =head1 LICENSE

plugins/newznab/nn_

@@ -6,6 +6,7 @@
 
 nn_ - Munin plugin to display misc newznab stats.
 
+
 =head1 CONFIGURATION
 
 This script is used to generate data for several graphs. To generate
@@ -13,10 +14,13 @@ data for one specific graph, you need to create a symbolic link with a
 name like nn_<GRAPH> to this script.
 
 To get a graph over numbers of users use nn_users
+
+
 =head1 APPLICABLE SYSTEMS
 
 Any MySQL platform, tested by the author on MySQL 5.1.29 and 5.0.51
 
+
 =head1 CONFIGURATION
 
 This script is used to generate data for several graphs. To generate
@@ -39,10 +43,13 @@ env.mysqlpassword <password>
 
 =back
 
+
 =head1 THANKS
+
 A special thanks to Kjell-Magne Øierud for the mysql_ plugin in munin which
 gave me the inspiration and reusable code to create this plugin.
 
+
 =head1 LICENSE
 
 Copyright (C) 2012 Jan Astrup (cryzeck@synIRC)
@@ -61,6 +68,8 @@ along with this program; if not, write to the Free Software
 Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307,
 USA.
 
+SPDX-License-Identifier: GPL-2.0-only
+
 =cut
 
 use warnings;

plugins/openfire/openfire_

@@ -33,7 +33,6 @@ You need to have the Openfire "Load Statistic" Plugin-installed!
 
 This plugin is configurable environment variables.
 
-
  user root 		must be root user
  env.statsfile 	path to stats.txt file
 
@@ -46,7 +45,7 @@ env.statsfile /var/log/openfire/stats.txt
 
 =head1 AUTHOR
 
-Philipp Haussleiter <philipp@haussleiter.de> (email)
+Philipp Haussleiter <philipp@haussleiter.de>
 
 =head1 LICENSE
 

plugins/other/opentracker_

@@ -1,6 +1,6 @@
 #!/usr/bin/perl
 #
-=head1 OPENTRACKER PLUGIN
+=head1 NAME
 
 A Plugin to monitor OpenTracker Servers and their Performance
 

plugins/php/php_fpm_process

@@ -17,13 +17,16 @@ You will need the perl fastcgi::client on your host
 
 You have to put this in your plugin.conf.d folder
 
-# If your php process is listening on TCP
+In case your php process is listening on TCP:
+
    [php_fpm_process]
    env.serveraddr 127.0.0.1
    env.port 9000
    env.path /status
 
-# If your php process is listening on Unix Socket
+
+In case your php process is listening on a Unix Socket:
+
    [php_fpm_process]
    env.sock /var/run/php-fpm.sock
    env.path /status
@@ -40,6 +43,7 @@ You have to put this in your plugin.conf.d folder
 =head1 AUTHOR
 
 Minitux
+
 Olivier Mehani <shtrom+munin@ssji.net>
 
 =head1 LICENSE

plugins/router/arris-sb6183

@@ -24,10 +24,18 @@ arris-sb6183 - Health monitoring plugin for Arris SB6183 Cable Modem
 =head1 DESCRIPTION
 
 This provides the following multigraphs:
-* upstream and downstream power levels
+
-* downstream signal to noise ratio
+=over 4
-* downstream error counts
+
-* uptime
+=item upstream and downstream power levels
+
+=item downstream signal to noise ratio
+
+=item downstream error counts
+
+=item uptime
+
+=back
 
 The values are retrieved from the cable modem's status web pages at
 192.168.100.1. So, this plugin must be installed on a munin node

plugins/router/arris-tg3442

@@ -12,13 +12,20 @@ downstream channels. (Signal Power, SNR, Lock Status)
 
 
 =head1 REQUIREMENTS
-- BeautifulSoup
+
-- pycryptodome
+=over 4
+
+=item BeautifulSoup
+
+=item pycryptodome
+
+=back
 
 
 =head1 CONFIGURATION
 
 =head2 Example
+
  [arris]
  env.url http://192.168.100.1
  env.username admin
@@ -26,6 +33,7 @@ env.password yourpassword
 
 
 =head2 Parameters
+
 url      - URL to web-frontend
 username - defaults to "admin"
 password - valid password
@@ -38,11 +46,14 @@ https://www.arris.com/products/touchstone-tg3442-cable-voice-gateway/
 =head1 AUTHOR
 
 Copyright (c) 2019 Daniel Hiepler <d-munin@coderdu.de>
+
 Copyright (c) 2004-2009 Nicolas Stransky <Nico@stransky.cx>
+
 Copyright (c) 2018 Lars Kruse <devel@sumpfralle.de>
 
 
 =head1 LICENSE
+
 Permission to use, copy, and modify this software with or without fee
 is hereby granted, provided that this entire notice is included in
 all source code copies of any software which is or includes a copy or

plugins/snmp/snmp__airport

@@ -1,11 +1,12 @@
 #!/usr/bin/python
 """
-Munin plugin to monitor various items of data from an Apple Airport
-Express/Extreme or a Time Capsule.
 
-v1.0 by Chris Jones <cmsj@tenshu.net>
+=head1 NAME
-Copyright (C) 2011 Chris Jones
+
-This script is released under the GNU GPL v2 license.
+Munin plugin to monitor various items of data from an Apple Airport Express/Extreme or a Time Capsule.
+
+
+=head1 INSTALLATION
 
 To use this plugin, use specially named symlinks:
 
@@ -29,15 +30,41 @@ Now add a virtual host entry to your munin server's munin.conf:
 
 this will create a virtual host in munin for the airport named 'myairport' and
 produce graphs for:
-    * number of connected wireless clients
-    * number of active DHCP leases
-    * rate at which clients are connected (in Mb/s)
-    * signal quality of connected clients (in dB)
-    * noise level of connected clients (in dB)
 
-# Magic markers
+=over 4
+
+=item number of connected wireless clients
+
+=item number of active DHCP leases
+
+=item rate at which clients are connected (in Mb/s)
+
+=item signal quality of connected clients (in dB)
+
+=item noise level of connected clients (in dB)
+
+=back
+
+
+=head1 AUTHORS
+
+Copyright (C) 2011 Chris Jones <cmsj@tenshu.net>
+
+
+=head1 LICENSE
+
+This script is released under the GNU GPL v2 license.
+
+SPDX-License-Identifier: GPL-2.0-only
+
+
+=head1 MAGIC MARKERS
+
  #%# capabilities=
  #%# family=contrib manual
+
+
+=cut
 """
 import sys
 import os

plugins/ssl/certificate_file_expiry

@@ -9,16 +9,19 @@ certificate_file_expiry - check the certificate validity of your certificates
 Installing: Add list of your certificates prefixed by the type in munin plugin-conf.d
 
 For openvpn ca.crt and crl.pem
+
  [certificate_file_expiry]
  user root
  env.CERTS crl:/etc/openvpn/easy-rsa/keys/crl.pem x509:/etc/openvpn/easy-rsa/keys/ca.crt
 
 For letsencrypt certificates
+
  [certificate_file_expiry]
  user root
  env.CERTS x509:/etc/letsencrypt/live/domain1.example.com/cert.pem x509:/etc/letsencrypt/live/domain2.example.com/cert.pem
 
-Warning and Critical levels can also be configured with env variables like this
+Warning and Critical levels can also be configured with env variables like this:
+
  [certificate_file_expiry]
  ...
  # warn when certificate will be invalid within 5 days
@@ -32,8 +35,7 @@ Dependencies: openssl
 
 =head1 AUTHOR
 
-andreas perhab - andreas.perhab@wt-io-it.at
+andreas perhab - andreas.perhab@wt-io-it.at (https://www.wt-io-it.at/)
-https://www.wt-io-it.at/
 
 =head1 LICENSE
 

plugins/ssl/letsencrypt_weekly

@@ -22,8 +22,7 @@ Dependencies: openssl
 
 =head1 AUTHOR
 
-andreas perhab - andreas.perhab@wt-io-it.at
+andreas perhab - andreas.perhab@wt-io-it.at (https://www.wt-io-it.at/)
-https://www.wt-io-it.at/
 
 =head1 LICENSE
 

plugins/syncthing/strelaysrv_

@@ -1,34 +1,52 @@
 #!/bin/sh
 : <<=cut
 =head1 NAME
+
 strelaysrv_ - Plugin to monitor Syncthing relay server
 
 =head1 DESCRIPTION
+
 This plugin gathers metrics from a Syncthing relay server.
 
 This plugin requires the jq utility : https://stedolan.github.io/jq/
 This plugin requires the curl utility : https://curl.haxx.se/
 
-Available plugins :
+Available wildcard plugin features:
-strelaysrv_goroutine #
+
-strelaysrv_num       #
+=over 4
-strelaysrv_proxied   #
+
-strelaysrv_transfer  #
+=item strelaysrv_goroutine
-strelaysrv_uptime    #
+
+=item strelaysrv_num
+
+=item strelaysrv_proxied
+
+=item strelaysrv_transfer
+
+=item strelaysrv_uptime
+
+=back
+
 
 =head1 CONFIGURATION
-To make the plugin connect to the Syncthing relay server one has to use this type of
-configuration
-[strelaysrv_*]
 
+To make the plugin connect to the Syncthing relay server one has to use this type of
+configuration:
+
+ [strelaysrv_*]
  env.syncthing_relaysrv_host 127.0.0.1
  env.syncthing_relaysrv_port 22070
 
 =head1 AUTHOR
+
 Pierre-Alain TORET <pierre-alain.toret@protonmail.com>
 
 =head1 LICENSE
+
 MIT
+
+SPDX-License-Identifier: MIT
+
 =cut
 
 syncthing_relaysrv_host=${syncthing_relaysrv_host:-}

plugins/syncthing/syncthing_

@@ -2,36 +2,56 @@
 # -*- sh -*-
 : <<=cut
 =head1 NAME
+
 syncthing_ - Plugin to monitor Syncthing server
 
+
 =head1 DESCRIPTION
+
 This plugin gathers metrics from a Syncthing server.
 
 This plugin requires the jq utility : https://stedolan.github.io/jq/
 This plugin requires the cURL utility : https://curl.haxx.se/
 
-Available plugins :
+Available wildcard plugin features:
-syncthing_cpu       #
+
-syncthing_mem       #
+=over 4
-syncthing_goroutine #
+
-syncthing_transfer  #
+=item syncthing_cpu
-syncthing_uptime    #
+
+=item syncthing_mem
+
+=item syncthing_goroutine
+
+=item syncthing_transfer
+
+=item syncthing_uptime
+
+=back
+
 
 =head1 CONFIGURATION
 To make the plugin connect to the Syncthing server one has to use this type of
-configuration
+configuration:
-[syncthing_*]
 
+ [syncthing_*]
  env.syncthing_apikey myapikey0123456789
  env.syncthing_host 127.0.0.1
  env.syncthing_port 8384
  env.syncthing_proto http
 
+
 =head1 AUTHOR
+
 Pierre-Alain TORET <pierre-alain.toret@protonmail.com>
 
+
 =head1 LICENSE
+
 MIT
+
+SPDX-License-Identifier: MIT
+
 =cut
 
 syncthing_apikey=${syncthing_apikey:-}

plugins/system/irq

@@ -18,7 +18,9 @@ None need
 You can set warning and critical levels for each of the data
 series the plugin reports.
 'General' graph support cpu-irqtype limits and irqtype limits
+
 Examples:
+
  [irq]
  env.warning_cpu1_sirq_total 550
  env.critical_cpu0_irq_total 600
@@ -26,7 +28,9 @@ env.warning_irq_total 700
  env.critical_sirq_total 700
 
 'Child' graphs support cpu-irqtype-irqname and irqtype-irqname limits
+
 Examples:
+
  [irq]
  env.warning_cpu0_irq_7 100
  env.critical_cpu1_sirq_HI 100

plugins/zimbra/zimbra-mailboxsizes

@@ -33,7 +33,10 @@ along with this program; if not, write to the Free Software
 Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
 02110-1301 USA.
 
+SPDX-License-Identifier: GPL-2.0-only
+
 =head1 CONFIGURATION
+
  [zimbra_mailboxsizes]
  user zimbra