summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authornicolargo <nicolas@nicolargo.com>2021-03-13 08:46:40 +0100
committernicolargo <nicolas@nicolargo.com>2021-03-13 08:46:40 +0100
commit15eba5d4ae4f72467daa1ba9b605274e096dd091 (patch)
treeb98b5d98bf52f68b0dfeb0d53f58fc63737066c4
parent871b4c32b22581242c326b67459c2a86f97c6c4a (diff)
Update documentation for HDDTemp plugin
-rw-r--r--docs/aoa/hddtemp.rst19
-rw-r--r--docs/aoa/index.rst1
-rw-r--r--docs/aoa/sensors.rst6
-rw-r--r--docs/man/glances.12
4 files changed, 21 insertions, 7 deletions
diff --git a/docs/aoa/hddtemp.rst b/docs/aoa/hddtemp.rst
new file mode 100644
index 00000000..2c352b2e
--- /dev/null
+++ b/docs/aoa/hddtemp.rst
@@ -0,0 +1,19 @@
+.. _sensors:
+
+HDD temperature sensor
+======================
+
+*Availability: Linux*
+
+This plugin will add HDD temperature to the sensors plugin.
+
+On your Linux system, you will nedd to have:
+- hddtemp package installed
+- hddtemp service up and running (check it with systemctl status hddtemp)
+- the TCP port 7634 openned on your local Firewall (if it is enabled on your system)
+
+There is no alert on this information.
+
+.. note::
+ Limit values and sensors alias names can be defined in the
+ configuration file under the ``[sensors]`` section.
diff --git a/docs/aoa/index.rst b/docs/aoa/index.rst
index 571e9410..a573581b 100644
--- a/docs/aoa/index.rst
+++ b/docs/aoa/index.rst
@@ -37,6 +37,7 @@ Legend:
raid
smart
sensors
+ hddtemp
ps
monitor
amps
diff --git a/docs/aoa/sensors.rst b/docs/aoa/sensors.rst
index b5efc65f..9dd6dd17 100644
--- a/docs/aoa/sensors.rst
+++ b/docs/aoa/sensors.rst
@@ -15,9 +15,3 @@ There is no alert on this information.
.. note::
Limit values and sensors alias names can be defined in the
configuration file under the ``[sensors]`` section.
-
-.. note::
- This plugin is disabled by default in the configuration file.
- To enable it just use the following option:
-
- # glances --enable-plugin sensors
diff --git a/docs/man/glances.1 b/docs/man/glances.1
index 7ca36a01..2c3b9c1e 100644
--- a/docs/man/glances.1
+++ b/docs/man/glances.1
@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
-.TH "GLANCES" "1" "Jan 30, 2021" "3.1.7_beta" "Glances"
+.TH "GLANCES" "1" "Mar 13, 2021" "3.1.7_beta" "Glances"
.SH NAME
glances \- An eye on your system
.