1
0
Fork 0
mirror of https://github.com/munin-monitoring/contrib.git synced 2025-07-21 18:41:03 +00:00

Plugin acpi_batt_: improve perldoc formatting

This commit is contained in:
Lars Kruse 2020-09-04 01:55:06 +02:00
parent 6a1a9c7c46
commit 1a614fb00d

View file

@ -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.