Add documentation (issue #937)

This commit is contained in:
nicolargo 2016-10-21 18:03:33 +02:00
parent 092930d4a0
commit deb42a075f
7 changed files with 24 additions and 4 deletions

3
NEWS
View File

@ -5,10 +5,11 @@ Glances Version 2
Version 2.8
===========
Enhancements and new features:
Enhancements and news features:
* Add ZeroMQ exporter (issue #939)
* Add CouchDB exporter (issue #928)
* Add hotspot Wifi informations (issue #937)
* Highlight max stats in the processes list (issue #878)
* Docker alerts and actions (issue #875)
* Glances API returns the processes PPID (issue #926)

BIN
docs/_static/wifi.png vendored Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 9.2 KiB

View File

@ -26,6 +26,7 @@ Legend:
load
memory
network
wifi
ports
disk
fs

View File

@ -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

18
docs/aoa/wifi.rst Normal file
View File

@ -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.*

View File

@ -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
.

View File

@ -165,10 +165,10 @@ class Plugin(GlancesPlugin):
ret.append(self.curse_add_line(msg, "TITLE"))
msg = '{:>6}'.format('Quality')
ret.append(self.curse_add_line(msg))
ret.append(self.curse_new_line())
# Hotspot list (sorted by name)
for i in sorted(self.stats, key=operator.itemgetter(self.get_key())):
ret.append(self.curse_new_line())
# Do not display hotspot with no name (/ssid)
if i['ssid'] == '':
continue