summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorBharath Vignesh J K <52282402+RazCrimson@users.noreply.github.com>2024-05-16 17:15:42 +0530
committerBharath Vignesh J K <52282402+RazCrimson@users.noreply.github.com>2024-05-16 17:15:42 +0530
commitfecd23b26feaf54187b5171881dec4d10a373859 (patch)
tree6055fe3c5a52c37e9e1fe622918b086a2baf983c /docs
parenteb83f6e6b117176f327b0144a2462121ef4035ed (diff)
parent16621cf75ffe8031fdc1ee558d7369e81b46289e (diff)
Merge branch 'refs/heads/support/v4.0.x'
# Conflicts: # NEWS.rst # docs/api.rst # docs/man/glances.1 # glances/__init__.py # glances/plugins/sensors/__init__.py # snap/snapcraft.yaml
Diffstat (limited to 'docs')
-rw-r--r--docs/api.rst26
-rwxr-xr-x[-rw-r--r--]docs/man/glances.12
2 files changed, 25 insertions, 3 deletions
diff --git a/docs/api.rst b/docs/api.rst
index 3f793558..8aeaa79d 100644
--- a/docs/api.rst
+++ b/docs/api.rst
@@ -480,7 +480,13 @@ GET gpu
Get plugin stats::
# curl http://localhost:61208/api/4/gpu
- []
+ [{"fan_speed": 29,
+ "gpu_id": "nvidia0",
+ "key": "gpu_id",
+ "mem": 46.144612630208336,
+ "name": "NVIDIA GeForce GTX 1060 3GB",
+ "proc": 2,
+ "temperature": 57}]
Fields descriptions:
@@ -491,6 +497,22 @@ Fields descriptions:
* **temperature**: GPU temperature (unit is *celsius*)
* **fan_speed**: GPU fan speed (unit is *roundperminute*)
+Get a specific field::
+
+ # curl http://localhost:61208/api/4/gpu/gpu_id
+ {"gpu_id": ["nvidia0"]}
+
+Get a specific item when field matches the given value::
+
+ # curl http://localhost:61208/api/4/gpu/gpu_id/nvidia0
+ {"nvidia0": [{"fan_speed": 29,
+ "gpu_id": "nvidia0",
+ "key": "gpu_id",
+ "mem": 46.144612630208336,
+ "name": "NVIDIA GeForce GTX 1060 3GB",
+ "proc": 2,
+ "temperature": 57}]}
+
GET help
--------
@@ -1226,7 +1248,7 @@ GET version
Get plugin stats::
# curl http://localhost:61208/api/4/version
- "4.0.2"
+ "4.0.4"
GET wifi
--------
diff --git a/docs/man/glances.1 b/docs/man/glances.1
index 9eb2fd95..eb65ad92 100644..100755
--- a/docs/man/glances.1
+++ b/docs/man/glances.1
@@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
-.TH "GLANCES" "1" "May 13, 2024" "4.0.2" "Glances"
+.TH "GLANCES" "1" "May 15, 2024" "4.0.4" "Glances"
.SH NAME
glances \- An eye on your system
.SH SYNOPSIS