From deb42a075ff3e4d2b1c08c919dd77c9a8b93a180 Mon Sep 17 00:00:00 2001 From: nicolargo Date: Fri, 21 Oct 2016 18:03:33 +0200 Subject: Add documentation (issue #937) --- docs/_static/wifi.png | Bin 0 -> 9385 bytes docs/aoa/index.rst | 1 + docs/aoa/network.rst | 2 +- docs/aoa/wifi.rst | 18 ++++++++++++++++++ docs/man/glances.1 | 2 +- 5 files changed, 21 insertions(+), 2 deletions(-) create mode 100644 docs/_static/wifi.png create mode 100644 docs/aoa/wifi.rst (limited to 'docs') diff --git a/docs/_static/wifi.png b/docs/_static/wifi.png new file mode 100644 index 00000000..1b865b2a Binary files /dev/null and b/docs/_static/wifi.png differ diff --git a/docs/aoa/index.rst b/docs/aoa/index.rst index adccf082..e9526756 100644 --- a/docs/aoa/index.rst +++ b/docs/aoa/index.rst @@ -26,6 +26,7 @@ Legend: load memory network + wifi ports disk fs diff --git a/docs/aoa/network.rst b/docs/aoa/network.rst index 56e8c7f8..09c25792 100644 --- a/docs/aoa/network.rst +++ b/docs/aoa/network.rst @@ -11,7 +11,7 @@ dynamically (bit/s, kbit/s, Mbit/s, etc). Alerts are only set if the maximum speed per network interface is available (see sample in the configuration file). -It's also possibile to define: +It's also possible to define: - a list of network interfaces to hide - per-interface limit values diff --git a/docs/aoa/wifi.rst b/docs/aoa/wifi.rst new file mode 100644 index 00000000..6a91721d --- /dev/null +++ b/docs/aoa/wifi.rst @@ -0,0 +1,18 @@ +.. _wifi: + +Wifi +===== + +.. image:: ../_static/wifi.png + +Glances displays the Wifi hotspot name and quality where the host is connected. +If Glances is ran as root, then all the available hotspots are displayed. + +It's also possible to disable the scan on a specific interface from the +configuration file (``[network]`` section). For example, if you want to +hide the loopback interface (lo) and all the virtual docker interface: + +.. code-block:: ini + + [wifi] + hide=lo,docker.* diff --git a/docs/man/glances.1 b/docs/man/glances.1 index 8e360848..ec123482 100644 --- a/docs/man/glances.1 +++ b/docs/man/glances.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "GLANCES" "1" "Oct 15, 2016" "2.8_DEVELOP" "Glances" +.TH "GLANCES" "1" "Oct 21, 2016" "2.8_DEVELOP" "Glances" .SH NAME glances \- An eye on your system . -- cgit v1.2.3