Update documetation

This commit is contained in:
nicolargo 2017-05-08 09:46:40 +02:00
parent b91241c47f
commit 4ac8368002
6 changed files with 26 additions and 14 deletions

Binary file not shown.

Before

Width:  |  Height:  |  Size: 30 KiB

After

Width:  |  Height:  |  Size: 8.4 KiB

BIN
docs/_static/cpu.png vendored

Binary file not shown.

Before

Width:  |  Height:  |  Size: 7.3 KiB

After

Width:  |  Height:  |  Size: 4.4 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 23 KiB

After

Width:  |  Height:  |  Size: 9.2 KiB

BIN
docs/_static/mem.png vendored

Binary file not shown.

Before

Width:  |  Height:  |  Size: 13 KiB

After

Width:  |  Height:  |  Size: 5.9 KiB

View File

@ -3,8 +3,10 @@
CPU
===
The CPU stats are shown as a percentage or value and for the configured
refresh time. The total CPU usage is displayed on the first line.
The CPU stats are shown as a percentage or values and for the configured
refresh time.
The total CPU usage is displayed on the first line.
.. image:: ../_static/cpu.png
@ -13,6 +15,17 @@ displayed.
.. image:: ../_static/cpu-wide.png
A character is also displayed just after the CPU header and shows the
trend value:
======== ==============================================================
Trend Status
======== ==============================================================
``-`` CPU value is equal to the mean of the six latests refreshes
``\`` CPU value is lower than the mean of the six latests refreshes
``/`` CPU value is higher than the mean of the six latests refreshes
======== ==============================================================
CPU stats description:
- **user**: percent time spent in user space. User CPU time is the time
@ -69,9 +82,3 @@ CPU (user/system) Status
.. note::
Limit values can be overwritten in the configuration file under
the ``[cpu]`` and/or ``[percpu]`` sections.
.. note::
A trend character could be displayed just after the title.
* '-': value is more or less equal to the mean of the lasts N values
* '/': value is higher than the mean of the lasts N values
* '/': value is lower than the mean of the lasts N values

View File

@ -12,6 +12,17 @@ the ``RAM``:
.. image:: ../_static/mem-wide.png
A character is also displayed just after the MEM header and shows the
trend value:
======== ==============================================================
Trend Status
======== ==============================================================
``-`` MEM value is equal to the mean of the six latests refreshes
``\`` MEM value is lower than the mean of the six latests refreshes
``/`` MEM value is higher than the mean of the six latests refreshes
======== ==============================================================
Alerts are only set for used memory and used swap.
Legend:
@ -28,9 +39,3 @@ RAM/Swap Status
.. note::
Limit values can be overwritten in the configuration file under
the ``[memory]`` and/or ``[memswap]`` sections.
.. note::
A trend character could be displayed just after the title.
* '-': value is more or less equal to the mean of the lasts N values
* '/': value is higher than the mean of the lasts N values
* '/': value is lower than the mean of the lasts N values