summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authornicolargo <nicolas@nicolargo.com>2019-11-02 13:42:24 +0100
committernicolargo <nicolas@nicolargo.com>2019-11-02 13:42:24 +0100
commitcc856941a836c3ff5df73f5abed7b55e01be573d (patch)
tree5060cacd277c55d90084e916a2e469e86067a59f
parentc71bef2cd73562f3813f9f46f9aee09f4c7e346a (diff)
Update documentation.
-rw-r--r--docs/aoa/load.rst9
-rw-r--r--docs/aoa/ps.rst10
-rw-r--r--docs/man/glances.12
3 files changed, 15 insertions, 6 deletions
diff --git a/docs/aoa/load.rst b/docs/aoa/load.rst
index 30eb2e38..ef1827ab 100644
--- a/docs/aoa/load.rst
+++ b/docs/aoa/load.rst
@@ -18,9 +18,12 @@ Be aware that Load on Linux, BSD and Windows are different things, high
`load on BSD`_ does not means high CPU load. The Windows load is emulated
by the PsUtil lib (see `load on Windows`_)
-Glances gets the number of CPU core to adapt the alerts.
-Alerts on load average are only set on 15 minutes time period.
-The first line also displays the number of CPU core.
+Glances gets the number of CPU core (displayed on the first line) to adapt
+the alerts. Alerts on load average are only set on 15 minutes time period.
+
+Thresholds are computed by dividing the 5 and 15 minutes average load per
+CPU(s) number. For example, if you have 4 CPUs and the 5 minutes load is
+1.0, then the warning threshold will be set to 2.8 (0.7 * 4 * 1.0).
Legend:
diff --git a/docs/aoa/ps.rst b/docs/aoa/ps.rst
index 4a5599f5..d96da721 100644
--- a/docs/aoa/ps.rst
+++ b/docs/aoa/ps.rst
@@ -48,7 +48,8 @@ Columns display
If Irix/Solaris mode is off, the value is
divided by logical core number
-``MEM%`` % of MEM used by the process
+``MEM%`` % of MEM used by the process (RES divided by
+ the total RAM you have)
``VIRT`` Virtual Memory Size
The total amount of virtual memory used by the
@@ -57,6 +58,8 @@ Columns display
It includes all code, data and shared
libraries plus pages that have been swapped out
and pages that have been mapped but not used.
+
+ Most of the time, this is not a useful number.
``RES`` Resident Memory Size
The non-swapped physical memory a process is
@@ -74,7 +77,8 @@ Columns display
- ``S``: interruptible sleep (waiting for an event)
- ``D``: uninterruptible sleep (usually I/O)
- ``Z``: defunct ("zombie") process
- - ``T``: traced/stopped by job control signal
+ - ``T``: traced by job control signal
+ - ``t``: stopped by debugger during the tracing
- ``X``: dead (should never be seen)
``R/s`` Per process I/O read rate in B/s
@@ -85,6 +89,8 @@ Columns display
pressing on the ``'/'`` key
========================= ==============================================
+Source: Thanks to the Peteris Ĺ…ikiforovs's blog.
+
Process filtering
-----------------
diff --git a/docs/man/glances.1 b/docs/man/glances.1
index 6f746edc..efefe0a9 100644
--- a/docs/man/glances.1
+++ b/docs/man/glances.1
@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
-.TH "GLANCES" "1" "Oct 13, 2019" "3.1.4_BETA" "Glances"
+.TH "GLANCES" "1" "Nov 02, 2019" "3.1.4_BETA" "Glances"
.SH NAME
glances \- An eye on your system
.