From 1a614fb00d5e4531b85ee9feade0e541bb0799d4 Mon Sep 17 00:00:00 2001
From: Lars Kruse <devel@sumpfralle.de>
Date: Fri, 4 Sep 2020 01:55:06 +0200
Subject: [PATCH] Plugin acpi_batt_: improve perldoc formatting

---
 plugins/battery/acpi_batt_ | 66 +++++++++++++++++++++++++-------------
 1 file changed, 44 insertions(+), 22 deletions(-)

diff --git a/plugins/battery/acpi_batt_ b/plugins/battery/acpi_batt_
index d88804a2..24d5d36e 100755
--- a/plugins/battery/acpi_batt_
+++ b/plugins/battery/acpi_batt_
@@ -3,7 +3,7 @@
 
 =head1 NAME
 
-acpi_batt_ Munin plugin to monitor the (note|net)book battery states through procfs
+acpi_batt_ - monitor the (note|net)book battery states through procfs
 
 =head1 APPLICABLE SYSTEMS
 
@@ -11,37 +11,59 @@ Notebooks and netbooks with available /proc/acpi/battery
 
 =head1 CONFIGURATION
 
-Configured change the name of symbolic link
+The name of the plugin (or its symbolic link) determines the retrieved data.
+
+=over
+
+=item acpi_batt_X_capacity: chart of Design capacity, Last full capacity, Design capacity low, Design capacity warning, Capacity granularity 1, Capacity granularity 2, Remaining capacity, Present rate (mA)
+
+=item acpi_batt_X_percents: percentage chart of Current voltage, Current capacity, Full capacity (of design)
+
+=item acpi_batt_X_voltage: chart of Design voltage, Present voltage
+
+=back
 
-acpi_batt_X_capacity - chart of Design capacity, Last full capacity, Design capacity low,
-                       Design capacity warning, Capacity granularity 1, Capacity granularity 2,
-                       Remaining capacity, Present rate (mA)
-acpi_batt_X_percents - percentage chart of Current voltage, Current capacity, Full capacity (of design)
-acpi_batt_X_voltage  - chart of Design voltage, Present voltage
 Where X is the number of battery from /proc/acpi/battery/BATX
 
 =head1 INTERPRETATION
 
 The plugin shows:
- Design capacity
- Last full capacity
- Design capacity low
- Design capacity warning
- Capacity granularity 1
- Capacity granularity 2
- Remaining capacity
- Present rate (mA)
- Percentage Current/design voltage
- Percentage Full/current capacity
- Percentage Design/full capacity
- Design voltage
- Present voltage
+
+=over
+
+=item Design capacity
+
+=item Last full capacity
+
+=item Design capacity low
+
+=item Design capacity warning
+
+=item Capacity granularity 1
+
+=item Capacity granularity 2
+
+=item Remaining capacity
+
+=item Present rate (mA)
+
+=item Percentage Current/design voltage
+
+=item Percentage Full/current capacity
+
+=item Percentage Design/full capacity
+
+=item Design voltage
+
+=item Present voltage
+
+=back
+
 
 =head1 MAGIC MARKERS
 
-#%# family=power
+ #%# family=power
 
-=head1 VERSION
 =head1 BUGS
 
 None known.