Merge pull request #2625 from gtimchenko/doc_fix#001

Fix typos and make grammatical and stylistic edits in project documentation

docs/cmds.rst

@@ -12,7 +12,7 @@ Command-Line Options
 
 .. option:: -V, --version
 
-    show program's version number and exit
+    show the program's version number and exit
 
 .. option:: -d, --debug
 
@@ -32,19 +32,19 @@ Command-Line Options
 
 .. option:: --disable-plugin PLUGIN
 
-    disable PLUGIN (comma separated list)
+    disable PLUGIN (comma-separated list)
 
 .. option:: --enable-plugin PLUGIN
 
-    enable PLUGIN (comma separated list)
+    enable PLUGIN (comma-separated list)
 
 .. option:: --stdout PLUGINS_STATS
 
-    display stats to stdout (comma separated list of plugins/plugins.attribute)
+    display stats to stdout (comma-separated list of plugins/plugins.attribute)
 
 .. option:: --export EXPORT
 
-    enable EXPORT module (comma separated list)
+    enable EXPORT module (comma-separated list)
 
 .. option:: --export-csv-file EXPORT_CSV_FILE
 
@@ -64,7 +64,7 @@ Command-Line Options
 
 .. option:: --light, --enable-light
 
-    light mode for Curses UI (disable all but top menu)
+    light mode for Curses UI (disable all but the top menu)
 
 .. option:: -0, --disable-irix
 
@@ -88,7 +88,7 @@ Command-Line Options
 
 .. option:: -5, --disable-top
 
-    disable top menu (QuickLook, CPU, MEM, SWAP and LOAD)
+    disable top menu (QuickLook, CPU, MEM, SWAP, and LOAD)
 
 .. option:: -6, --meangpu
 
@@ -196,11 +196,11 @@ Command-Line Options
 
 .. option:: --hide-kernel-threads
 
-    hide kernel threads in process list (not available on Windows)
+    hide kernel threads in the process list (not available on Windows)
 
 .. option:: -b, --byte
 
-    display network rate in byte per second
+    display network rate in bytes per second
 
 .. option:: --diskio-show-ramfs
 
@@ -220,7 +220,7 @@ Command-Line Options
 
 .. option:: --theme-white
 
-    optimize display colors for white background
+    optimize display colors for a white background
 
 .. option:: --disable-check-update
 
@@ -236,7 +236,7 @@ The following commands (key pressed) are supported while in Glances:
 
     .. note:: On macOS please use ``CTRL-H`` to delete filter.
 
-    Filter is a regular expression pattern:
+    The filter is a regular expression pattern:
 
     - ``gnome``: matches all processes starting with the ``gnome``
       string
@@ -254,7 +254,7 @@ The following commands (key pressed) are supported while in Glances:
     - If CPU iowait ``>60%``, sort processes by I/O read and write
 
 ``A``
-    Enable/disable Application Monitoring Process
+    Enable/disable the Application Monitoring Process
 
 ``b``
     Switch between bit/s or Byte/s for network I/O
@@ -278,7 +278,7 @@ The following commands (key pressed) are supported while in Glances:
     Enable/disable top extended stats
 
 ``E``
-    Erase current process filter
+    Erase the current process filter
 
 ``f``
     Show/hide file system and folder monitoring stats
@@ -356,7 +356,7 @@ The following commands (key pressed) are supported while in Glances:
     Sort process by CPU times (TIME+)
 
 ``T``
-    View network I/O as combination
+    View network I/O as a combination
 
 ``u``
     Sort processes by USER
@@ -379,13 +379,13 @@ The following commands (key pressed) are supported while in Glances:
 ``0``
     Enable/disable Irix/Solaris mode
 
-    Task's CPU usage will be divided by the total number of CPUs
+    The task's CPU usage will be divided by the total number of CPUs
 
 ``1``
     Switch between global CPU and per-CPU stats
 
 ``2``
-    Enable/disable left sidebar
+    Enable/disable the left sidebar
 
 ``3``
     Enable/disable the quick look module
@@ -394,7 +394,7 @@ The following commands (key pressed) are supported while in Glances:
     Enable/disable all but quick look and load module
 
 ``5``
-    Enable/disable top menu (QuickLook, CPU, MEM, SWAP and LOAD)
+    Enable/disable the top menu (QuickLook, CPU, MEM, SWAP, and LOAD)
 
 ``6``
     Enable/disable mean GPU mode
@@ -409,10 +409,10 @@ The following commands (key pressed) are supported while in Glances:
     Refresh user interface
 
 ``LEFT``
-    Navigation left through process sort
+    Navigation left through the process sort
 
 ``RIGHT``
-    Navigation right through process sort
+    Navigation right through the process sort
 
 ``UP``
     Up in the processes list

docs/config.rst

@@ -5,7 +5,7 @@ Configuration
 
 No configuration file is mandatory to use Glances.
 
-Furthermore a configuration file is needed to access more settings.
+Furthermore, a configuration file is needed to access more settings.
 
 Location
 --------
@@ -14,7 +14,7 @@ Location
     A template is available in the ``/usr{,/local}/share/doc/glances``
     (Unix-like) directory or directly on `GitHub`_.
 
-You can put your own ``glances.conf`` file in the following locations:
+You can place your ``glances.conf`` file in the following locations:
 
 ==================== =============================================================
 ``Linux``, ``SunOS`` ~/.config/glances/, /etc/glances/, /usr/share/docs/glances/
@@ -26,13 +26,13 @@ You can put your own ``glances.conf`` file in the following locations:
 - On Windows XP, ``%APPDATA%`` is: ``C:\Documents and Settings\<USERNAME>\Application Data``.
 - On Windows Vista and later: ``C:\Users\<USERNAME>\AppData\Roaming``.
 
-User-specific options override system-wide options and options given on
-the command line override either.
+User-specific options override system-wide options, and options given on
+the command line overrides both.
 
 Syntax
 ------
 
-Glances reads configuration files in the *ini* syntax.
+Glances read configuration files in the *ini* syntax.
 
 A first section (called global) is available:
 
@@ -41,7 +41,7 @@ A first section (called global) is available:
     [global]
     # Refresh rate (default is a minimum of 2 seconds)
     # Can be overwritten by the -t <sec> option
-    # It is also possible to overwrite it in each plugin sections
+    # It is also possible to overwrite it in each plugin section
     refresh=2
     # Should Glances check if a newer version is available on PyPI ?
     check_update=false
@@ -53,8 +53,8 @@ A first section (called global) is available:
     # (see <install-dir>glances/plugins for details)
     # plugin_dir=/home/user/dev/plugins
 
-Each plugin, export module and application monitoring process (AMP) can
-have a section. Below an example for the CPU plugin:
+Each plugin, export module, and application monitoring process (AMP) can
+have a section. Below is an example for the CPU plugin:
 
 .. code-block:: ini
 
@@ -94,16 +94,16 @@ or a Nginx AMP:
 .. code-block:: ini
 
     [amp_nginx]
-    # Nginx status page should be enable (https://easyengine.io/tutorials/nginx/status-page/)
+    # Nginx status page should be enabled (https://easyengine.io/tutorials/nginx/status-page/)
     enable=true
     regex=\/usr\/sbin\/nginx
     refresh=60
     one_line=false
     status_url=http://localhost/nginx_status
 
-With Glances 3.0 or higher it is also possible to use dynamic configuration
-value using system command. For example, if you to set the prefix of an
-InfluxDB export to the current hostname, use:
+With Glances 3.0 or higher, you can use dynamic configuration values
+by utilizing system commands. For example, if you want to set the prefix
+of an InfluxDB export to the current hostname, use:
 
 .. code-block:: ini
 
@@ -127,14 +127,14 @@ Glances logs all of its internal messages to a log file.
 ``DEBUG`` messages can be logged using the ``-d`` option on the command
 line.
 
-The location of the Glances log file depends of your operating system. You can
-display the full path of the Glances log file full path using the``glances -V``
+The location of the Glances log file depends on your operating system. You can
+display the full path of the Glances log file using the ``glances -V``
 command line.
 
 The file is automatically rotated when its size exceeds 1 MB.
 
 If you want to use another system path or change the log message, you
-can use your own logger configuration. First of all, you have to create
+can use your logger configuration. First of all, you have to create
 a ``glances.json`` file with, for example, the following content (JSON
 format):
 
@@ -206,7 +206,7 @@ and start Glances using the following command line:
     LOG_CFG=<path>/glances.json glances
 
 .. note::
-    Replace ``<path>`` by the folder where your ``glances.json`` file
+    Replace ``<path>`` with the directory where your ``glances.json`` file
     is hosted.
 
 .. _GitHub: https://raw.githubusercontent.com/nicolargo/glances/master/conf/glances.conf

docs/docker.rst

@@ -3,15 +3,17 @@
 Docker
 ======
 
-Glances can be installed through Docker, allowing you to run it without installing all the python dependencies directly on your system. Once you have `docker installed <https://docs.docker.com/install/>`_, you can
+Glances can be installed through Docker, allowing you to run it without
+installing all the Python dependencies directly on your system. Once you
+have `docker installed <https://docs.docker.com/install/>`_, you can
 
 Get the Glances container:
 
 .. code-block:: console
 
     docker pull nicolargo/glances:<version or tag>
 
-Available tags (all images are based on both Alpine and Ubuntu Operating System):
+Available tags (all images are based on both Alpine and Ubuntu Operating Systems):
 
 .. list-table::
    :widths: 25 15 25 35
@@ -47,13 +49,13 @@ Available tags (all images are based on both Alpine and Ubuntu Operating System)
      - Full
 
 .. warning::
-    Tags containing `dev` target the `develop` branch directly and could be unstable.
+    Tags containing `dev` directly target the `develop` branch and could be unstable.
 
 For example, if you want a full Alpine Glances image (latest release) with all dependencies, go for `latest-full`.
 
 You can also specify a version (example: 3.4.0). All available versions can be found on `DockerHub`_.
 
-An Example to pull the `latest` tag:
+An example of how to pull the `latest` tag:
 
 .. code-block:: console
 
@@ -81,7 +83,7 @@ Alternatively, you can specify something along the same lines with docker run op
 
 Where \`pwd\`/glances.conf is a local directory containing your glances.conf file.
 
-Glances by default, uses the container's OS information in the UI. If you want to display the host's OS info, you can do that by mounting `/etc/os-release` into the container.
+Glances by default uses the container's OS information in the UI. If you want to display the host's OS info, you can do that by mounting `/etc/os-release` into the container.
 
 Here is a simple docker run example for that:
 
@@ -97,7 +99,7 @@ Run the container in *Web server mode* (notice the `GLANCES_OPT` environment var
 
 Note: if you want to see the network interface stats within the container, add --net=host --privileged
 
-You can also include Glances container in you own `docker-compose.yml`. Here's a realistic example including a "traefik" reverse proxy serving an "whoami" app container plus a Glances container, providing a simple and efficient monitoring webui.
+You can also include Glances container in you own `docker-compose.yml`. A realistic example includes a "traefik" reverse proxy serving an "whoami" app container plus a Glances container, providing a simple and efficient monitoring webui.
 
 .. code-block:: console
 

docs/glances.rst

@@ -11,12 +11,12 @@ SYNOPSIS
 DESCRIPTION
 -----------
 
-**glances** is a cross-platform curses-based monitoring tool which aims
-to present a maximum of information in a minimum of space, ideally to
-fit in a classical 80x24 terminal or higher to have additional
-information. It can adapt dynamically the displayed information
-depending on the terminal size. It can also work in client/server mode.
-Remote monitoring could be done via terminal or web interface.
+**glances** is a cross-platform curses-based monitoring tool that aims
+to present a maximum of information in a minimum of space, ideally fitting
+in a classic 80x24 terminal or larger for more details. It can adapt
+dynamically to the displayed information depending on the terminal size.
+It can also work in client/server mode.
+Remote monitoring can be performed via a terminal or web interface.
 
 **glances** is written in Python and uses the *psutil* library to get
 information from your system.
@@ -38,19 +38,20 @@ Monitor local machine (standalone mode):
 
     $ glances
 
-Monitor local machine with the web interface (Web UI), run the following command line:
+To monitor the local machine with the web interface (Web UI),
+, run the following command line:
 
     $ glances -w
 
-and open a Web browser with the returned URL
+then, open a web browser to the provided URL.
 
 Monitor local machine and export stats to a CSV file:
 
     $ glances --export csv --export-csv-file /tmp/glances.csv
 
-Monitor local machine and export stats to a InfluxDB server with 5s
+Monitor local machine and export stats to an InfluxDB server with 5s
 refresh time (also possible to export to OpenTSDB, Cassandra, Statsd,
-ElasticSearch, RabbitMQ and Riemann):
+ElasticSearch, RabbitMQ, and Riemann):
 
     $ glances -t 5 --export influxdb
 

docs/index.rst

@@ -3,13 +3,13 @@ Glances
 
 .. image:: _static/screenshot-wide.png
 
-Glances is a cross-platform monitoring tool which aims to present a
-maximum of information in a minimum of space through a curses or Web
-based interface. It can adapt dynamically the displayed information
-depending on the terminal size.
+Glances is a cross-platform monitoring tool that aims to present
+maximum information in minimal space through either a curses-based
+or Web-based interface. It can dynamically adapt the displayed
+information depending on the terminal size.
 
-It can also work in client/server mode. Remote monitoring could be
-done via terminal, Web interface or API (XMLRPC and RESTful).
+It can also work in client/server mode. Remote monitoring can be
+done via terminal, Web interface, or API (XMLRPC and RESTful).
 
 Glances is written in Python and uses the `psutil`_ library to get
 information from your system.

docs/install.rst

@@ -3,22 +3,22 @@
 Install
 =======
 
-Glances is on ``PyPI``. By using PyPI, you are sure to have the latest
-stable version.
+Glances is available on ``PyPI``. By using PyPI, you are sure to have the
+latest stable version.
 
 To install, simply use ``pip``:
 
 .. code-block:: console
 
     pip install glances
 
-*Note*: Python headers are required to install `psutil`_. For example,
-on Debian/Ubuntu you need to install first the *python-dev* package.
-For Fedora/CentOS/RHEL install first *python-devel* package. For Windows,
-just install psutil from the binary installation file.
+*Note*: Python headers are required to install `psutil`_. For instance,
+on Debian/Ubuntu, you must first install the *python-dev* package.
+On Fedora/CentOS/RHEL, first, install the *python-devel* package. For Windows,
+psutil can be installed from the binary installation file.
 
-You can also install the following libraries in order to use optional
-features (like the Web interface, export modules...):
+You can also install the following libraries to use the optional
+features (such as the web interface, export modules, etc.):
 
 .. code-block:: console