summaryrefslogtreecommitdiff
path: root/system/glances/README
diff options
context:
space:
mode:
Diffstat (limited to 'system/glances/README')
-rw-r--r--system/glances/README42
1 files changed, 27 insertions, 15 deletions
diff --git a/system/glances/README b/system/glances/README
index 0169b34e9b..da0a08dc36 100644
--- a/system/glances/README
+++ b/system/glances/README
@@ -1,20 +1,32 @@
-Glances is a free (LGPL) cross-platform curses-based monitoring tool,
-which aims to present a maximum of information in a minimum of space
-and ideally fits in a classical 80x24 terminal, or larger for additional
-information.
+Glances is a free (LGPL) cross-platform curses-based system monitoring tool
+which aims to present a maximum of information in a minimum of space, ideally
+to fit in a classical 80x24 terminal, or larger for additional information: in
+fact it can adapt dynamically the displayed information depending on the
+terminal size.
-Glances can adapt dynamically the displayed information depending on
-the terminal size. It can also work in a client/server mode for remote
-monitoring.
+This tool can also work in client/server mode. Remote monitoring can be
+done via terminal or web interface.
-This tool is written in Python and uses the psutil library to fetch the
-statistical values from key elements, like CPU, load average, memory,
-network, disks, file systems, processes, etc.
+Glances is written in Python and uses the psutil library to fetch statistical
+values from key elements, like CPU, load average, memory, network, disks,
+file systems, processes, etc.
-Optional dependencies are hddtemp (HHD temperature monitoring support),
-pysnmp (SNMP support), matplotlib, netifaces and python3. Others not
-available on SBo are bottle (Web server mode), py3sensors (HW monitoring
-support), batinfo (battery monitoring support) and zeroconf.
+OPTIONAL DEPENDENCIES
-NOTE: when launching Glances in a terminal with a bright background, the
+Available on SBo: hddtemp (HHD temperature monitoring support), py3sensors
+(HW monitoring support), pysnmp (SNMP support), netifaces (auto discoverer
+mode), statsd (StatsD export module), matplotlib (generation of graphs from
+history data) and python3.
+
+Not available on SBo: bottle (Web server mode), batinfo (battery monitoring
+support), pymdstat (RAID support), zeroconf (auto discoverer mode), influxdb
+(InfluxDB export module), pystache (action script feature), docker-py (Docker
+monitoring support).
+
+NOTES
+
+1) When launching Glances in a terminal with a bright background, the
option '--theme-white' is recommended.
+
+2) For the optional auto discoverer mode, both zeroconf and netifaces
+are needed.