1
0
Fork 0
mirror of https://github.com/munin-monitoring/contrib.git synced 2025-07-21 18:41:03 +00:00

Improve documantion of many plugins

Specifically the configuration examples are now indented properly.
This commit is contained in:
Lars Kruse 2020-10-24 17:28:11 +02:00
parent 384d482fe2
commit 09b88141b3
92 changed files with 556 additions and 388 deletions

View file

@ -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
@ -25,10 +29,10 @@ name like nn_<GRAPH> to this script.
connection parameters - use this in your plugin configuration file.
[nn_*]
env.mysqlconnection DBI:mysql:<yourdatabase>;host=127.0.0.1;port=3306
env.mysqluser <user>
env.mysqlpassword <password>
[nn_*]
env.mysqlconnection DBI:mysql:<yourdatabase>;host=127.0.0.1;port=3306
env.mysqluser <user>
env.mysqlpassword <password>
=head1 DEPENDENCIES
@ -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;