From 04ebf0e6f427a0396f228f7c93942dbb58c30cd8 Mon Sep 17 00:00:00 2001
From: shakemid <k-cima@kendama.asia>
Date: Sun, 17 Sep 2017 18:02:15 +0900
Subject: [PATCH] Add document for munin-plugin

---
 munin-plugin/temper | 77 ++++++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 76 insertions(+), 1 deletion(-)

diff --git a/munin-plugin/temper b/munin-plugin/temper
index 3f13a7b..bdeedde 100755
--- a/munin-plugin/temper
+++ b/munin-plugin/temper
@@ -1,7 +1,82 @@
 #!/bin/bash
 # -*- sh -*-
 
-# Munin plugin for TEMPer
+: << =cut
+
+=head1 NAME
+
+  temper - Munin plugin to monitor temperature with PCsensor/TEMPer
+
+=head1 CONFIGURATION
+
+  Install pcsensor command:
+    git clone https://github.com/shakemid/pcsensor-temper 
+    cd pcsensor-temper
+    make
+    cp pcsensor /usr/local/bin/
+
+  Make symlink:
+    cp munin-plugin/temper /path/to/munin/lib/plugins/
+    cd /path/to/munin/etc/plugins/
+    ln -s /path/to/munin/lib/plugins/temper .
+
+=head1 ENVIRONMENT VARIABLES
+
+  env.pcsensor - path to pcsensor command
+    example:  env.pcsensor  /usr/bin/pcsensor
+    default:  /usr/local/bin/pcsensor
+
+  env.device - device number to monitor
+    example:  env.device 1
+    default:  0
+
+  env.cdef - formula for calibration
+    example:  env.cdef  temperature,1.0287,*,0.85,-
+    default:  none
+
+    The formula means temperature * 1.0287 - 0.85
+    For more information about CDEF, see https://oss.oetiker.ch/rrdtool/tut/cdeftutorial.en.html
+
+=head1 EXAMPLE
+
+  Example setting for aggregate multiple temper graphs into one graph,
+
+  [TEMPer]
+    update no
+
+    temper.update no
+    temper.graph_category sensor
+    temper.graph_args --base 1000
+    temper.graph_scale no
+    temper.graph_title TEMPer
+    temper.graph_vlabel Temp C
+
+    temper.graph_order \
+        temperature_1=group;host1:temper.temperature \
+        temperature_2=group;host2:temper.temperature \
+        temperature_3=group;host3:temper.temperature
+
+    temper.temperature_1.cdef temperature_1,1.02,*,0.38,-
+    temper.temperature_2.cdef temperature_2,0.97,*,1.22,-
+    temper.temperature_3.cdef temperature_3,0.93,*,0.55,-
+
+  For more information about graph aggregation, 
+  see http://guide.munin-monitoring.org/en/latest/example/graph/aggregate.html
+
+=head1 AUTHOR
+
+  K.Cima https://github.com/shakemid
+
+=head1 LICENSE
+
+  GPLv2
+
+=head1 Magic markers
+
+  #%# family=contrib
+  #%# capabilities=
+
+=cut
 
 . "${MUNIN_LIBDIR}/plugins/plugin.sh"