summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authornicolargo <nicolas@nicolargo.com>2020-11-14 11:59:44 +0100
committernicolargo <nicolas@nicolargo.com>2020-11-14 11:59:44 +0100
commitcbcba97ab019f7aae302cee3bc2410498f1d48ee (patch)
tree8a1d06f154f9c6394578c3a5710783b4a288614f /docs
parentf68915265a07375df50e8155e1711528e5e3ca29 (diff)
parent357c5afa5d1b8d1d28e59285b81c10a4e45be027 (diff)
Solve conflict with refresh
Diffstat (limited to 'docs')
-rw-r--r--docs/aoa/docker.rst3
-rw-r--r--docs/aoa/fs.rst4
-rw-r--r--docs/cmds.rst2
-rw-r--r--docs/conf.py5
-rw-r--r--docs/config.rst8
-rw-r--r--docs/gw/json.rst2
-rw-r--r--docs/man/glances.113
7 files changed, 24 insertions, 13 deletions
diff --git a/docs/aoa/docker.rst b/docs/aoa/docker.rst
index 484dcd14..0fb440ff 100644
--- a/docs/aoa/docker.rst
+++ b/docs/aoa/docker.rst
@@ -20,6 +20,9 @@ under the ``[docker]`` section:
.. code-block:: ini
[docker]
+ disable=False
+ # Define the maximum docker size name (default is 20 chars)
+ max_name_size=20
# Global containers' thresholds for CPU and MEM (in %)
cpu_careful=50
cpu_warning=70
diff --git a/docs/aoa/fs.rst b/docs/aoa/fs.rst
index 37dae695..23d4eecd 100644
--- a/docs/aoa/fs.rst
+++ b/docs/aoa/fs.rst
@@ -27,13 +27,13 @@ User disk space usage Status
By default, the plugin only displays physical devices (hard disks, USB
keys). To allow other file system types, you have to enable them in the
-configuration file. For example, if you want to allow the ``zfs`` file
+configuration file. For example, if you want to allow the ``shm`` file
system:
.. code-block:: ini
[fs]
- allow=zfs
+ allow=shm
Also, you can hide mount points as well (in the following ``/boot``):
diff --git a/docs/cmds.rst b/docs/cmds.rst
index a4c88179..b97734ce 100644
--- a/docs/cmds.rst
+++ b/docs/cmds.rst
@@ -375,6 +375,8 @@ The following commands (key pressed) are supported while in Glances:
Enable/disable mean GPU mode
``/``
Switch between process command line or command name
+``F5``
+ Refresh stats in curses user interface
In the Glances client browser (accessible through the ``--browser``
command line argument):
diff --git a/docs/conf.py b/docs/conf.py
index 54b5bc00..ade53f17 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -54,7 +54,10 @@ master_doc = 'index'
# General information about the project.
project = 'Glances'
author = 'Nicolas Hennion'
-year = datetime.now().year
+try:
+ year = datetime.utcfromtimestamp(int(os.environ['SOURCE_DATE_EPOCH'])).year
+except (KeyError, ValueError):
+ year = datetime.now().year
copyright = '%d, %s' % (year, author)
# The version info for the project you're documenting, acts as replacement for
diff --git a/docs/config.rst b/docs/config.rst
index 00c54851..07f0efd5 100644
--- a/docs/config.rst
+++ b/docs/config.rst
@@ -17,10 +17,10 @@ Location
You can put your own ``glances.conf`` file in the following locations:
==================== =============================================================
-``Linux``, ``SunOS`` ~/.config/glances, /etc/glances
-``*BSD`` ~/.config/glances, /usr/local/etc/glances
-``macOS`` ~/Library/Application Support/glances, /usr/local/etc/glances
-``Windows`` %APPDATA%\\glances
+``Linux``, ``SunOS`` ~/.config/glances/glances.conf, /etc/glances/glances.conf
+``*BSD`` ~/.config/glances/glances.conf, /usr/local/etc/glances/glances.conf
+``macOS`` ~/Library/Application Support/glances/glances.conf, /usr/local/etc/glances/glances.conf
+``Windows`` %APPDATA%\\glances\glances.conf
==================== =============================================================
- On Windows XP, ``%APPDATA%`` is: ``C:\Documents and Settings\<USERNAME>\Application Data``.
diff --git a/docs/gw/json.rst b/docs/gw/json.rst
index 0b086c7d..e85a4832 100644
--- a/docs/gw/json.rst
+++ b/docs/gw/json.rst
@@ -6,5 +6,5 @@ JSON
It's possible to export stats to a JSON file.
.. code-block:: console
+ $ glances --export json --export-json-file /tmp/glances.json
- $ glances --export json --export-json-file json /tmp/glances.json
diff --git a/docs/man/glances.1 b/docs/man/glances.1
index e3c274fe..170620fc 100644
--- a/docs/man/glances.1
+++ b/docs/man/glances.1
@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
-.TH "GLANCES" "1" "Jul 21, 2020" "3.1.5_DEVELOP" "Glances"
+.TH "GLANCES" "1" "Nov 07, 2020" "3.1.6_b1" "Glances"
.SH NAME
glances \- An eye on your system
.
@@ -488,6 +488,9 @@ Up in the processes list
.TP
.B \fBDOWN\fP
Down in the processes list
+.TP
+.B \fBF5\fP
+Refresh stats in curses user interface
.UNINDENT
.sp
In the Glances client browser (accessible through the \fB\-\-browser\fP
@@ -529,25 +532,25 @@ _
T{
\fBLinux\fP, \fBSunOS\fP
T} T{
-~/.config/glances, /etc/glances
+~/.config/glances/glances.conf, /etc/glances/glances.conf
T}
_
T{
\fB*BSD\fP
T} T{
-~/.config/glances, /usr/local/etc/glances
+~/.config/glances/glances.conf, /usr/local/etc/glances/glances.conf
T}
_
T{
\fBmacOS\fP
T} T{
-~/Library/Application Support/glances, /usr/local/etc/glances
+~/Library/Application Support/glances/glances.conf, /usr/local/etc/glances/glances.conf
T}
_
T{
\fBWindows\fP
T} T{
-%APPDATA%\eglances
+%APPDATA%\eglancesglances.conf
T}
_
.TE