]> git.michaelhowe.org Git - packages/m/munin-plugins-afs.git/commitdiff
Improve docs
authorMichael Howe <michael@michaelhowe.org>
Thu, 27 Dec 2018 10:31:56 +0000 (10:31 +0000)
committerMichael Howe <michael@michaelhowe.org>
Thu, 27 Dec 2018 10:31:56 +0000 (10:31 +0000)
plugins/afs_volumes

index aeff438423877841bbaa0b4be87b4fdb3df2cf7e..f5afd4daba8bfd256b3f43ae244217ef4ebab9b9 100755 (executable)
@@ -1,19 +1,28 @@
 #!/usr/bin/perl
-#
-# Perl script to produce graphs of % quota usage of all AFS volumes on a given
-# server.
-#
-# Override the following by setting an appropriate environment variable in munin:
-# timeout_cmd
-# timeout
-# vos
+
+=head1 NAME
+
+afs_volumes - plugin to graph AFS volume quota usage
+
+=head1 CONFIGURATION
+
+The following can be overriden using environment variables in the standard
+munin way:
+
+server, timeout_cmd, timeout, vos
+
+=head1 MAGIC MARKERS
+
+ #%# family=auto 
+ #%# capabilities=autoconf
+
+=cut
+
 use strict;
 use warnings;
 
 use v5.14.0;
 
-#%# family=auto
-
 use Net::Domain;
 
 my $TIMEOUT_CMD = $ENV{timeout_cmd} // "/usr/bin/timeout";