Skip to content

Commit

Permalink
Update documentation.
Browse files Browse the repository at this point in the history
  • Loading branch information
nicolargo committed Nov 2, 2019
1 parent c71bef2 commit cc85694
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 6 deletions.
9 changes: 6 additions & 3 deletions docs/aoa/load.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down
10 changes: 8 additions & 2 deletions docs/aoa/ps.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand All @@ -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
Expand All @@ -85,6 +89,8 @@ Columns display
pressing on the ``'/'`` key
========================= ==============================================

Source: Thanks to the Peteris Ņikiforovs's blog.

Process filtering
-----------------

Expand Down
2 changes: 1 addition & 1 deletion docs/man/glances.1
Original file line number Diff line number Diff line change
@@ -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
.
Expand Down

0 comments on commit cc85694

Please sign in to comment.