summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorAlessio Sergi <al3hex@gmail.com>2015-04-16 12:36:16 +0200
committerAlessio Sergi <al3hex@gmail.com>2015-04-16 15:28:52 +0200
commit43183615175d44cd9f05a05a24f6297f3853f29b (patch)
tree2e41a76ae0ff58efc1a5dd8c354e1c0149e107c5 /docs
parent9a8792459663d1a95560df7ea953667fd84faa21 (diff)
No more system-wide configuration file by default
Support remains there, but no system-wide configuration file will be provided anymore. Default configuration settings are initialized by code which may be overridden by a configuration file.
Diffstat (limited to 'docs')
-rw-r--r--docs/glances-doc.rst42
1 files changed, 18 insertions, 24 deletions
diff --git a/docs/glances-doc.rst b/docs/glances-doc.rst
index b280232c..6859b001 100644
--- a/docs/glances-doc.rst
+++ b/docs/glances-doc.rst
@@ -288,15 +288,20 @@ Configuration
No configuration file is mandatory to use Glances.
-Furthermore a configuration file is needed to set up limits, disks or
-network interfaces to hide and/or monitored processes list or to define
-alias.
+Furthermore a configuration file is needed to modify limit alerts, to
+set up monitored processes list, to hide disks or network interfaces or
+to define alias.
-By default, the configuration file is under:
+Location
+--------
+
+You can put the configuration file ``glances.conf`` in the following
+locations:
-:Linux: ``/etc/glances/glances.conf``
-:\*BSD and OS X: ``/usr/local/etc/glances/glances.conf``
-:Windows: ``%APPDATA%\glances\glances.conf``
+:Linux: ``~/.config/glances, /etc/glances``
+:\*BSD: ``~/.config/glances, /usr/local/etc/glances``
+:OS X: ``~/Library/Application Support/glances, /usr/local/etc/glances``
+:Windows: ``%APPDATA%\glances``
On Windows XP, the ``%APPDATA%`` path is:
@@ -309,24 +314,12 @@ Since Windows Vista and newer versions:
::
C:\Users\<User>\AppData\Roaming
- or
- %userprofile%\AppData\Roaming
-
-You can override the default configuration, located in one of the above
-directories on your system, except for Windows.
-
-Just copy the ``glances.conf`` file to your ``$XDG_CONFIG_HOME`` directory,
-e.g., on Linux:
-.. code-block:: console
-
- mkdir -p $XDG_CONFIG_HOME/glances
- cp /usr/share/doc/glances/glances.conf $XDG_CONFIG_HOME/glances/
+User-specific options override system-wide options and options given on
+the command line override either.
-On OS X, you should copy the configuration file to
-``~/Library/Application Support/glances/``.
-
-*Configuration file description*
+Syntax
+------
Each plugin and export module can have a section.
@@ -348,7 +341,8 @@ Example for the CPU plugin:
steal_warning=70
steal_critical=90
-By default Steal CPU time alerts aren't logged. If you want to enable log/alert, just add:
+By default the ``steal`` CPU time alerts aren't logged. If you want to
+enable log/alert, just add:
.. code-block::