Update documentation

NEWS

@@ -5,9 +5,19 @@ Glances Version 2.x
 Version 2.2
 ===========
 
-    * Improve graph history feature (issue #428)
+Enhancements and news features:
+
+    * Add centralized curse interface with a Glances servers list to monitor (issue #418)
+    * Add processes tree view (--tree) (issue #444)
+    * Improve graph history feature (issue #69)
     * Extended stats is disable by default (use --enable-process-extended to enable it - issue #430)
-    * Add a key ('F') and a command line option (--fs-free-space) to display FS free space instead of used space (issue #411)
+    * Add a short key ('F') and a command line option (--fs-free-space) to display FS free space instead of used space (issue #411)
+    * Add a short key ('2') and a command line option (--disable-left-sidebar) to disable/enable the side bar (issue #429)
+
+Bugs corrected:
+
+    * Correct issue on battery stat update (issue #433)
+    * Correct issue on process no longer exist (issues #414 and #432)
 
 Version 2.1.2
 =============
@@ -22,6 +32,7 @@ Version 2.1.1
 =============
 
 Enhancement:
+
     * Automaticaly compute top processes number for the current screen (issue #408)
     * CPU and Memory footprint optimization (issue #401)
 

README.rst

@@ -37,7 +37,7 @@ Optional dependencies:
 - ``hddtemp`` (for HDD temperature monitoring support) [Linux-only]
 - ``batinfo`` (for battery monitoring support) [Linux-only]
 - ``pysnmp`` (for SNMP support)
-- ``zeroconf`` and ``netifaces`` (for the autodiscovered support)
+- ``zeroconf`` and ``netifaces`` (for the auto discoverer mode)
 
 Installation
 ============
@@ -192,11 +192,11 @@ on the server side and run:
 
 on the client one.
 
-You can also detect and display all the Glances servers available on your network:
+You can also detect and display all Glances servers available on your network or defined in the configuration file:
 
 .. code-block:: console
 
-    $ glances --autodiscover
+    $ glances --browser
 
 
 And RTFM, always.

docs/glances-doc.rst

@@ -67,18 +67,20 @@ and on the client:
 
 where ``@server`` is the IP address or hostname of the server.
 
-Glances can detect and display all Glances servers available on you network using the Zeroconf protocol:
+Glances can centralize available Glances servers using the ``--browser`` option. The server list can be staticaly defined in the Glances configuration file (section [serverlist]). Glances can also detect and display all Glances servers available on you network (auto discover mode is based on the the Zeroconf protocol):
 
 .. code-block:: console
 
-    client$ glances --autodiscover
+    client$ glances --browser
+
+It is possible to disable the auto discover mode ``--disable-autodiscover``.
 
 In server mode, you can set the bind address ``-B ADDRESS`` and listening
 TCP port ``-p PORT``.
 
 In client mode, you can set the TCP port of the server ``-p PORT``.
 
-You can also set a password to access to the server ``--password``.
+You can set a password to access to the server ``--password``.
 
 Default binding address is ``0.0.0.0`` (Glances will listen on all the
 available network interfaces) and TCP port is ``61209``.
@@ -95,13 +97,13 @@ client, the latter will try to grab stats using the ``SNMP`` protocol:
 
     client$ glances -c @snmpserver
 
-Note: Stats grabbed by SNMP request are limited.
+Note: Stats grabbed by SNMP request are limited (operating system dependent).
 
 Web Server Mode
 ---------------
 
 If you want to remotely monitor a machine, called ``server``, from any
-device with a web browser, just run on the server:
+device with a web browser, just run the server with the ``-w`` option:
 
 .. code-block:: console
 
@@ -145,13 +147,18 @@ Command-Line Options
   --disable-log         disable log module
   --enable-process-extended
                         enable extended stats on top process
+  --enable-history      enable the history mode
+  --path-history PATH_HISTORY
+                        Set the export path for graph history
   --output-csv OUTPUT_CSV
                         export stats to a CSV file
-  --autodiscover        run the Glances client browser (list of Glances server)
   -c CLIENT, --client CLIENT
                         connect to a Glances server by IPv4/IPv6 address or
                         hostname
   -s, --server          run Glances in server mode
+  --browser             run the Glances client browser (list of Glances server)
+  --disable-autodiscover
+                        disable autodiscover feature
   -p PORT, --port PORT  define the client/server TCP port [default: 61209]
   -B BIND_ADDRESS, --bind BIND_ADDRESS
                         bind server to the given IPv4/IPv6 address or hostname
@@ -177,6 +184,9 @@ Command-Line Options
   -f PROCESS_FILTER, --process-filter PROCESS_FILTER
                         set the process filter patern (regular expression)
   --process-short-name  force short name for processes name
+  --hide-kernel-threads
+                        hide kernel threads in process list
+  --tree                display processes as a tree
   -b, --byte            display network rate in byte per second
   -1, --percpu          start Glances in per CPU mode
   --fs-free-space       display FS free space instead of used
@@ -248,7 +258,7 @@ The following commands (key pressed) are supported while in Glances:
 ``/``
     Switch between short name / command line (processes name)
 
-In the Glances client browser (accessible through the --autodiscover command line argument):
+In the Glances client browser (accessible through the --browser command line argument):
 
 ``ENTER``
     Run Glances client to the selected server

man/glances.1

@@ -20,7 +20,7 @@ systems, processes and so on.
 The command-line options are the following:
 .TP
 .B \-h, \-\-help
-display the help and exit
+show this help message and exit
 .TP
 .B \-V, \-\-version
 show program's version number and exit
@@ -28,14 +28,11 @@ show program's version number and exit
 .B \-d, \-\-debug
 Enable debug mode (log file is /tmp/glances.log)
 .TP
-.B \-b, \-\-byte
-display network rate in byte per second [default: bit per second]
-.TP
 .B \-C CONF_FILE, \-\-config CONF_FILE
 path to the configuration file
 .TP
-.B \-\-enable-history
-enable the history mode
+.B \-b, \-\-byte
+display network rate in byte per second [default: bit per second]
 .TP
 .B \-\-disable-bold
 disable bold mode in the terminal
@@ -64,12 +61,24 @@ disable log module
 .B \-\-enable-process-extended
 enable extended stats on top process
 .TP
+.B \-\-enable-history
+enable the history mode
+.TP
+B \-\-path-history PATH_HISTORY
+set the export path for graph history
+.TP
 .B \-\-output-csv OUTPUT_CSV
 export stats to a CSV file
 .TP
 .B \-s, \-\-server
 run Glances in server mode
 .TP
+.B \-\-browser
+start the client browser (display list of servers)
+.TP
+.B \-\-disable-autodiscover
+disable autodiscover feature
+.TP
 .B \-c CLIENT, \-\-client CLIENT
 connect to a Glances server by IPv4/IPv6 address or hostname
 .TP
@@ -121,7 +130,7 @@ Optimize display for white background
 You can use the following keys while in Glances:
 .TP
 .B ENTER
-Set the process filter patern (as a regular expression)
+Set the process filter pattern (as a regular expression)
 .TP
 .B a
 Sort process list automatically