diff options
| author | nicolargo <nicolas@nicolargo.com> | 2023-10-29 10:27:32 +0100 |
|---|---|---|
| committer | nicolargo <nicolas@nicolargo.com> | 2023-10-29 10:27:32 +0100 |
| commit | 51330ca8e7ad240f24a5545738c24b129ec06fa9 (patch) | |
| tree | 2d7e5e48ff80458afeb0ba9d63f115e46327296c /docs | |
| parent | 091e4975caeddb332f71dd8ed6db3860394dd4fc (diff) | |
| parent | eb72dbe35d3480df4dc7dbd553aa3d9c9dbb5b12 (diff) | |
Merge branch 'develop' of https://github.com/monochromec/glances into monochromec-develop
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/Makefile | 2 | ||||
| -rw-r--r-- | docs/cmds.rst | 4 | ||||
| -rw-r--r-- | docs/config.rst | 4 | ||||
| -rw-r--r-- | docs/man/glances.1 | 5 |
4 files changed, 14 insertions, 1 deletions
diff --git a/docs/Makefile b/docs/Makefile index 75bae57f..30485295 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -3,7 +3,7 @@ # You can set these variables from the command line. SPHINXOPTS = -SPHINXBUILD = ../venv/bin/sphinx-build +SPHINXBUILD = sphinx-build PAPER = BUILDDIR = _build diff --git a/docs/cmds.rst b/docs/cmds.rst index 7ab1ef49..cffeb153 100644 --- a/docs/cmds.rst +++ b/docs/cmds.rst @@ -22,6 +22,10 @@ Command-Line Options path to the configuration file +.. option:: -P plugin directory, --plugins plugin directory + + path to a directory containing additional plugins + .. option:: --modules-list display modules (plugins & exports) list and exit diff --git a/docs/config.rst b/docs/config.rst index 38c0cd18..f1c76e16 100644 --- a/docs/config.rst +++ b/docs/config.rst @@ -48,6 +48,10 @@ A first section (called global) is available: # History size (maximum number of values) # Default is 28800: 1 day with 1 point every 3 seconds history_size=28800 + # Define directory external to glances hierarchy for loading additional plugins + # The layout follows the glances standard for plugin definitions + # (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: diff --git a/docs/man/glances.1 b/docs/man/glances.1 index d6451f25..66a23e95 100644 --- a/docs/man/glances.1 +++ b/docs/man/glances.1 @@ -68,6 +68,11 @@ path to the configuration file .UNINDENT .INDENT 0.0 .TP +.B \-C PLUGIN_DIR, \-\-plugins CONF_FILE +path to the directory containing additional plugins +.UNINDENT +.INDENT 0.0 +.TP .B \-\-modules\-list display modules (plugins & exports) list and exit .UNINDENT |