Skip to content

Commit 860563e

Browse files
committed
docs: update README
1 parent 8e4024c commit 860563e

File tree

3 files changed

+15
-3
lines changed

3 files changed

+15
-3
lines changed

check-plugins/sensors-battery/README.rst

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,11 @@ Check sensors-battery
44
Overview
55
--------
66

7-
Return battery status information. If no battery is installed or metrics can't be determined OK is returned.
7+
Return battery status information. If no battery is installed or the metrics cannot be determined, 'OK' is returned.
8+
9+
Hints:
10+
11+
* Run ``sensors-detect --auto`` beforehand to scan your system for the various hardware monitoring chips or sensors supported by libsensors or, more generally, by the lm_sensors tool suite.
812

913

1014
Fact Sheet

check-plugins/sensors-fans/README.rst

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,11 @@ Check sensors-fans
44
Overview
55
--------
66

7-
Return hardware fans speed. Fan speed is expressed in RPM (rounds per minute). OK if no fans are found.
7+
Return the speed of the hardware fans. Fan speed is expressed in RPM (rounds per minute). The plugin returns 'OK' if no fans are found.
8+
9+
Hints:
10+
11+
* Run ``sensors-detect --auto`` beforehand to scan your system for the various hardware monitoring chips or sensors supported by libsensors or, more generally, by the lm_sensors tool suite.
812

913

1014
Fact Sheet

check-plugins/sensors-temperatures/README.rst

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,11 @@ Check sensors-temperatures
44
Overview
55
--------
66

7-
Return certain hardware temperature sensors (it may be a CPU, an hard disk or something else, depending on the OS and its configuration). All temperatures are expressed in celsius. Check is done automatically against hardware thresholds. If sensors are not supported by the OS OK is returned.
7+
Certain hardware temperature sensors may be returned (it could be a CPU, a hard disk or something else, depending on the operating system and its configuration). All temperatures are expressed in Celsius. Checks are performed automatically against hardware thresholds. If the sensors are not supported by the OS, 'OK' is returned.
8+
9+
Hints:
10+
11+
* Run ``sensors-detect --auto`` beforehand to scan your system for the various hardware monitoring chips or sensors supported by libsensors or, more generally, by the lm_sensors tool suite.
812

913

1014
Fact Sheet

0 commit comments

Comments
 (0)