Llewellyn/conky
1
0
Fork 0
mirror of https://github.com/Llewellynvdm/conky.git synced 2025-01-30 10:38:36 +00:00
Code Issues Releases Activity

Updated documentation

Browse Source
This commit is contained in:
donutAnees 2024-07-23 21:02:32 +05:30 committed by Brenden Matthews
parent 03ed0d0e79
commit ad0c9d3e23
1 changed files with 32 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

43
doc/variables.yaml
View File

@ -97,6 +97,7 @@ values:
- (scale) - (scale)
- (-t) - (-t)
- (-l) - (-l)
- (-x)
- name: apcupsd_model - name: apcupsd_model
desc: Prints the model of the UPS. desc: Prints the model of the UPS.
- name: apcupsd_name - name: apcupsd_name
@ -328,7 +329,8 @@ values:
See $cpu for more info on SMP. Uses a logarithmic scale (to see small See $cpu for more info on SMP. Uses a logarithmic scale (to see small
numbers) when you use the -l switch. Takes the switch '-t' to use a numbers) when you use the -l switch. Takes the switch '-t' to use a
temperature gradient, which makes the gradient values change depending temperature gradient, which makes the gradient values change depending
on the amplitude of a particular graph value (try it and see). on the amplitude of a particular graph value (try it and see). The flag
'-x' inverts the x axis of the graph.
args: args:
- (cpuN) - (cpuN)
- (height),(width) - (height),(width)
@ -337,6 +339,7 @@ values:
- (scale) - (scale)
- (-t) - (-t)
- (-l) - (-l)
- (-x)
- name: curl - name: curl
desc: |- desc: |-
Download data from URI using Curl at the specified interval. Download data from URI using Curl at the specified interval.
@ -389,7 +392,7 @@ values:
scale (to see small numbers) when you use -l switch. Takes the switch scale (to see small numbers) when you use -l switch. Takes the switch
'-t' to use a temperature gradient, which makes the gradient values '-t' to use a temperature gradient, which makes the gradient values
change depending on the amplitude of a particular graph value (try it change depending on the amplitude of a particular graph value (try it
and see). and see). The flag '-x' inverts the x axis of the graph.
args: args:
- (device) - (device)
- (height),(width) - (height),(width)
@ -398,6 +401,7 @@ values:
- (scale) - (scale)
- (-t) - (-t)
- (-l) - (-l)
- (-x)
- name: diskiograph_read - name: diskiograph_read
desc: |- desc: |-
Disk IO graph for reads, colours defined in hex, minus the Disk IO graph for reads, colours defined in hex, minus the
@ -405,7 +409,8 @@ values:
in diskio. Uses a logarithmic scale (to see small numbers) when you in diskio. Uses a logarithmic scale (to see small numbers) when you
use -l switch. Takes the switch '-t' to use a temperature gradient, use -l switch. Takes the switch '-t' to use a temperature gradient,
which makes the gradient values change depending on the amplitude of a which makes the gradient values change depending on the amplitude of a
particular graph value (try it and see). particular graph value (try it and see). The flag '-x' inverts the x
axis of the graph.
args: args:
- (device) - (device)
- (height),(width) - (height),(width)
@ -414,6 +419,7 @@ values:
- (scale) - (scale)
- (-t) - (-t)
- (-l) - (-l)
- (-x)
- name: diskiograph_write - name: diskiograph_write
desc: |- desc: |-
Disk IO graph for writes, colours defined in hex, minus the Disk IO graph for writes, colours defined in hex, minus the
@ -421,7 +427,8 @@ values:
in diskio. Uses a logarithmic scale (to see small numbers) when you in diskio. Uses a logarithmic scale (to see small numbers) when you
use -l switch. Takes the switch '-t' to use a temperature gradient, use -l switch. Takes the switch '-t' to use a temperature gradient,
which makes the gradient values change depending on the amplitude of a which makes the gradient values change depending on the amplitude of a
particular graph value (try it and see). particular graph value (try it and see). The flag '-x' inverts the x
axis of the graph.
args: args:
- (device) - (device)
- (height),(width) - (height),(width)
@ -430,6 +437,7 @@ values:
- (scale) - (scale)
- (-t) - (-t)
- (-l) - (-l)
- (-x)
- name: distribution - name: distribution
desc: |- desc: |-
The name of the distribution. It could be that some of the The name of the distribution. It could be that some of the
@ -456,7 +464,7 @@ values:
per second). Uses a logarithmic scale (to see small numbers) when you use per second). Uses a logarithmic scale (to see small numbers) when you use
-l switch. Takes the switch '-t' to use a temperature gradient, which makes -l switch. Takes the switch '-t' to use a temperature gradient, which makes
the gradient values change depending on the amplitude of a particular the gradient values change depending on the amplitude of a particular
graph value (try it and see). graph value (try it and see). The flag '-x' inverts the x axis of the graph.
args: args:
- (netdev) - (netdev)
- (height),(width) - (height),(width)
@ -465,6 +473,7 @@ values:
- (scale) - (scale)
- (-t) - (-t)
- (-l) - (-l)
- (-x)
- name: draft_mails - name: draft_mails
desc: |- desc: |-
Number of mails marked as draft in the specified mailbox or Number of mails marked as draft in the specified mailbox or
@ -535,7 +544,8 @@ values:
graph. The scale parameter defines the maximum value of the graph. Use the graph. The scale parameter defines the maximum value of the graph. Use the
-l switch to enable a logarithmic scale, which helps to see small values. -l switch to enable a logarithmic scale, which helps to see small values.
The default size for graphs can be controlled via the default_graph_height The default size for graphs can be controlled via the default_graph_height
and default_graph_width config settings. and default_graph_width config settings. The flag '-x' inverts the x axis
of the graph.
If you need to execute a command with spaces, you have a If you need to execute a command with spaces, you have a
couple options: couple options:
@ -562,6 +572,7 @@ values:
- (scale) - (scale)
- (-t) - (-t)
- (-l) - (-l)
- (-x)
- name: execi - name: execi
desc: |- desc: |-
Same as exec, but with a specific interval in seconds. The Same as exec, but with a specific interval in seconds. The
@ -593,6 +604,7 @@ values:
- (scale) - (scale)
- (-t) - (-t)
- (-l) - (-l)
- (-x)
- name: execp - name: execp
desc: |- desc: |-
Executes a shell command and displays the output in conky. Executes a shell command and displays the output in conky.
@ -1111,7 +1123,8 @@ values:
in hex, minus the #. Uses a logarithmic scale (to see small numbers) in hex, minus the #. Uses a logarithmic scale (to see small numbers)
when you use the -l switch. Takes the switch '-t' to use a temperature when you use the -l switch. Takes the switch '-t' to use a temperature
gradient, which makes the gradient values change depending on the gradient, which makes the gradient values change depending on the
amplitude of a particular graph value (try it and see). amplitude of a particular graph value (try it and see). The flag
'-x' inverts the x axis of the graph.
args: args:
- (height),(width) - (height),(width)
- (gradient colour 1) - (gradient colour 1)
@ -1119,6 +1132,7 @@ values:
- (scale) - (scale)
- (-t) - (-t)
- (-l) - (-l)
- (-x)
- name: lowercase - name: lowercase
desc: Converts all letters into lowercase. desc: Converts all letters into lowercase.
args: args:
@ -1173,6 +1187,7 @@ values:
- (scale) - (scale)
- (-t) - (-t)
- (-l) - (-l)
- (-x)
- name: lua_parse - name: lua_parse
desc: |- desc: |-
Executes a Lua function with given parameters as per $lua, Executes a Lua function with given parameters as per $lua,
@ -1232,7 +1247,8 @@ values:
Memory usage graph. Uses a logarithmic scale (to see small Memory usage graph. Uses a logarithmic scale (to see small
numbers) when you use the -l switch. Takes the switch '-t' to use a numbers) when you use the -l switch. Takes the switch '-t' to use a
temperature gradient, which makes the gradient values change depending temperature gradient, which makes the gradient values change depending
on the amplitude of a particular graph value (try it and see). on the amplitude of a particular graph value (try it and see). The flag
'-x' inverts the x axis of the graph.
args: args:
- (height),(width) - (height),(width)
- (gradient colour 1) - (gradient colour 1)
@ -1240,6 +1256,7 @@ values:
- (scale) - (scale)
- (-t) - (-t)
- (-l) - (-l)
- (-x)
- name: meminactive - name: meminactive
desc: Amount of inactive memory. FreeBSD only. desc: Amount of inactive memory. FreeBSD only.
- name: memlaundry - name: memlaundry
@ -1266,7 +1283,8 @@ values:
and cache. Uses a logarithmic scale (to see small numbers) when you and cache. Uses a logarithmic scale (to see small numbers) when you
use the -l switch. Takes the switch '-t' to use a temperature use the -l switch. Takes the switch '-t' to use a temperature
gradient, which makes the gradient values change depending on the gradient, which makes the gradient values change depending on the
amplitude of a particular graph value (try it and see). amplitude of a particular graph value (try it and see). The flag
'-x' inverts the x axis of the graph.
args: args:
- (height),(width) - (height),(width)
- (gradient colour 1) - (gradient colour 1)
@ -1274,6 +1292,7 @@ values:
- (scale) - (scale)
- (-t) - (-t)
- (-l) - (-l)
- (-x)
- name: mixer - name: mixer
desc: |- desc: |-
Prints the mixer value as reported by the OS. On Linux, this Prints the mixer value as reported by the OS. On Linux, this
@ -1529,7 +1548,7 @@ values:
used as 0,1,2,3,.. used as 0,1,2,3,..
For possible arguments see nvidia and nvidiabar. To learn more about the For possible arguments see nvidia and nvidiabar. To learn more about the
-t -l and gradient color options, see execgraph. -t -l -x and gradient color options, see execgraph.
args: args:
- argument - argument
- (height),(width) - (height),(width)
@ -1538,6 +1557,7 @@ values:
- (scale) - (scale)
- (-t) - (-t)
- (-l) - (-l)
- (-x)
- GPU_ID - GPU_ID
- name: offset - name: offset
desc: Move text over by N pixels. See also $voffset. desc: Move text over by N pixels. See also $voffset.
@ -2328,7 +2348,7 @@ values:
numbers) when you use the -l switch. Takes the switch '-t' to numbers) when you use the -l switch. Takes the switch '-t' to
use a temperature gradient, which makes the gradient values use a temperature gradient, which makes the gradient values
change depending on the amplitude of a particular graph value change depending on the amplitude of a particular graph value
(try it and see). (try it and see). The flag '-x' inverts the x axis of the graph.
args: args:
- (netdev) - (netdev)
- (height),(width) - (height),(width)
@ -2337,6 +2357,7 @@ values:
- (scale) - (scale)
- (-t) - (-t)
- (-l) - (-l)
- (-x)
- name: uptime - name: uptime
desc: Uptime. desc: Uptime.
- name: uptime_short - name: uptime_short