Add documentation for the ports plugin

NEWS

@@ -18,6 +18,7 @@ Deprecated:
 Enhancements and new features:
 
     * Add Application Monitoring Process plugin (issue #780)
+    * Add a new "Ports scanner" plugin (issue #734)
     * Improve IP plugin to display public IP address (issue #646)
     * CPU additionnal stats monitoring: Context switch, Interrupts... (issue #810)
     * Filter processes by others stats (username) (issue #748)

docs/aoa/index.rst

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

docs/aoa/ports.rst

@@ -0,0 +1,36 @@
+.. _ports:
+
+Ports
+=====
+
+*Availability: All*
+
+.. image:: ../_static/ports.png
+
+This plugin aims at providing a list of hosts/port to scan.
+
+You can define ICMP or TCP ports scan.
+
+The list should be define in the ``[ports]`` section of the Glances configuration file.
+
+.. code-block:: ini
+
+    [ports]
+    # Ports scanner plugin configuration
+    # Interval in second between scan
+    refresh=30
+    # Set the default timeout for a scan (can be overwrite in the scan list)
+    timeout=3
+    # If True, add the default gateway on top of the scan list
+    port_default_gateway=True
+    # Define the scan list
+    # host (name or IP) is mandatory
+    # port (TCP port number) is optional (if not set, use ICMP)
+    # description is optional (if not set, define to host:port)
+    port_1_host=192.168.0.1
+    port_1_port=80
+    port_1_description=Home Box
+    port_2_host=www.free.fr
+    port_2_description=My ISP
+    port_3_host=www.google.com
+    port_3_description=Internet

docs/cmds.rst

@@ -82,6 +82,10 @@ Command-Line Options
 
     disable Docker module
 
+.. option:: --disable-ports
+
+    disable Ports module
+
 .. option:: -5, --disable-top
 
     disable top menu (QuickLook, CPU, MEM, SWAP and LOAD)