From 8dbc8623522b8de0a8932ff6d7b8310fcb5f2608 Mon Sep 17 00:00:00 2001 From: nicolargo Date: Sun, 24 Nov 2019 17:41:06 +0100 Subject: [PATCH] Update docs --- docs/aoa/raid.rst | 17 +++++++++++++++++ docs/aoa/smart.rst | 24 ++++++++++++++++++++++++ docs/man/glances.1 | 2 +- 3 files changed, 42 insertions(+), 1 deletion(-) create mode 100644 docs/aoa/raid.rst create mode 100644 docs/aoa/smart.rst diff --git a/docs/aoa/raid.rst b/docs/aoa/raid.rst new file mode 100644 index 00000000..fa4239fe --- /dev/null +++ b/docs/aoa/raid.rst @@ -0,0 +1,17 @@ +.. _raid: + +RAID +==== + +*Availability: Linux* + +*Dependency: this plugin uses the optional pymdstat Python lib* + +This plugin is disable by default, please use the --enable raid option +to enable it. + +In the terminal interface, click on ``R`` to enable/disable it. + +.. image:: ../_static/raid.png + +This plugin is only available on GNU/Linux. diff --git a/docs/aoa/smart.rst b/docs/aoa/smart.rst new file mode 100644 index 00000000..2c19c7e4 --- /dev/null +++ b/docs/aoa/smart.rst @@ -0,0 +1,24 @@ +.. _smart: + +SMART +===== + +*Availability: all but Mac OS* + +*Dependency: this plugin uses the optional pySMART Python lib* + +This plugin is disable by default, please use the --enable smart option +to enable it. + +.. image:: ../_static/smart.png + +Glances displays all the SMART attributes. + +How to read the information: + +- The first line display the name and model of the device +- The first column is the SMART attribute name +- The second column is the SMART attribute raw value + +.. warning:: + This plugin needs administrator rights. Please run Glances as root/admin. diff --git a/docs/man/glances.1 b/docs/man/glances.1 index cd9a9882..4fb8ce31 100644 --- a/docs/man/glances.1 +++ b/docs/man/glances.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "GLANCES" "1" "Nov 06, 2019" "3.1.4_BETA" "Glances" +.TH "GLANCES" "1" "Nov 24, 2019" "3.1.4_BETA" "Glances" .SH NAME glances \- An eye on your system .