From: Michael Howe <michael@michaelhowe.org>
Date: Thu, 27 Dec 2018 10:31:56 +0000 (+0000)
Subject: Improve docs
X-Git-Tag: v1.0~9
X-Git-Url: https://git.michaelhowe.org/gitweb/?a=commitdiff_plain;h=561e2f9d6d6b060374c00b23a72cae4b51ce93e3;p=packages%2Fm%2Fmunin-plugins-afs.git

Improve docs
---

diff --git a/plugins/afs_volumes b/plugins/afs_volumes
index aeff438..f5afd4d 100755
--- a/plugins/afs_volumes
+++ b/plugins/afs_volumes
@@ -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";