From 6fd9d9072b2fc897fb81a9effd9ac6a858cef382 Mon Sep 17 00:00:00 2001
From: Lars Kruse <devel@sumpfralle.de>
Date: Thu, 10 Nov 2016 23:39:45 +0100
Subject: [PATCH] [chrony] format POD documentation

---
 plugins/time/chrony | 75 +++++++++++++++++++++++++++------------------
 1 file changed, 46 insertions(+), 29 deletions(-)

diff --git a/plugins/time/chrony b/plugins/time/chrony
index 33469f05..5df6765b 100755
--- a/plugins/time/chrony
+++ b/plugins/time/chrony
@@ -1,37 +1,54 @@
 #!/bin/sh
-#
-# Script to parse Chrony Tracking Output
-#
-# Parameters understood:
-#
-#       config   (required)
-#       autoconf (optional - used by munin-config)
-#
-# $log$
-# Revision 0.1 2008/08/23 13:06:00 joti
-# First version only chronyc tracking, autodetection included.
-#
-# Revision 0.2 2008/10/11 16:09:00 joti
-# Added scaling of other values to match with frequency, added more description to fields
-#
-# Revision 0.3 2014/02/16 zjttoefs
-# reduce forking by using awk
-# do not limit output precision
-# add stratum monitoring
-# detect slow/fast time or freqency and adjust sign of value accordingly
-# remove commented out code
-#
-# Magic markers (optional - used by munin-config and installation scripts):
-#
-#%# family=auto
-#%# capabilities=autoconf
 
-#Modify this to fit other chronyc path
+: <<=cut
+
+=head1 NAME
+
+parse Chrony Tracking output for timeserver status information
+
+=head1 APPLICABLE SYSTEMS
+
+Any system with a local chronyd service.
+
+=head1 CONFIGURATION
+
+No configuration.
+
+=head1 MAGIC MARKERS
+
+  #%# family=auto
+  #%# capabilities=autoconf
+
+=head1 VERSION
+
+Revision 0.1 2008/08/23 13:06:00 joti
+
+  First version only chronyc tracking, autodetection included.
+
+Revision 0.2 2008/10/11 16:09:00 joti
+
+  Added scaling of other values to match with frequency, added more description to fields
+
+Revision 0.3 2014/02/16 zjttoefs
+
+  reduce forking by using awk
+  do not limit output precision
+  add stratum monitoring
+  detect slow/fast time or freqency and adjust sign of value accordingly
+  remove commented out code
+
+=head1 AUTHOR
+
+  joti
+  zjttoefs
+
+=cut
+
+# Modify this to fit other chronyc path
 CHRONYC=/usr/bin/chronyc
 
-#Frequency has extremely higher values than other. Therefore they are fitted by scaling. Adjust the factors here
+# Frequency has extremely higher values than other. Therefore they are fitted by scaling. Adjust the factors here
 fieldfactors="1 1000 1 100 100 1000 1000"
-#fieldfactors="1 1000000 0.1 100 10 10 10"
 fields="stratum systime frequency residualfreq skew rootdelay rootdispersion"
 fieldnames="Stratum (=System Time (seconds,x=Frequency (ppm,x=Residual Freq (ppm,x=Skew (ppm,x=Root delay(seconds,x=Root dispersion (seconds,x"