Llewellyn/conky
1
0
Fork 0
mirror of https://github.com/Llewellynvdm/conky.git synced 2024-11-16 18:15:17 +00:00
Code Issues Releases Activity

Tidy up docs

Browse Source
This commit is contained in:
Brenden Matthews 2024-03-11 18:37:30 -04:00
parent 4c095d1e6a
commit bc85f40704
3 changed files with 104 additions and 102 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

55
doc/config_settings.yaml
View File

@ -172,6 +172,13 @@ values:
Create an API token at Create an API token at
https://github.com/settings/tokens/new?scopes=notifications&description=conky. https://github.com/settings/tokens/new?scopes=notifications&description=conky.
- name: graph_gradient_mode
desc: |-
Changes the color space used for interpolation. Arguments are hcl, hsv,
and rgb (default).
args:
- (rgb|hcl|hsv)
default: rgb
- name: hddtemp_host - name: hddtemp_host
desc: |- desc: |-
Hostname to connect to for hddtemp objects. Hostname to connect to for hddtemp objects.
@ -218,15 +225,6 @@ values:
Imlib2 image cache size, in bytes. Increase this value if you use $image Imlib2 image cache size, in bytes. Increase this value if you use $image
lots. Set to 0 to disable the image cache. lots. Set to 0 to disable the image cache.
default: 4194304 default: 4194304
- name: lua_mouse_hook
desc: |-
This function, if defined, will be called by Conky upon receiving mouse
events from X or Wayland. A table containing event information will be
passed to this function as the first argument. Use this hook for detecting
mouse input and acting on it. Conky requires that the function declaration
has a 'conky_' prefix to prevent accidental calls to the wrong function.
args:
- function_name
- name: lowercase - name: lowercase
desc: Boolean value, if true, text is rendered in lower case. desc: Boolean value, if true, text is rendered in lower case.
- name: lua_draw_hook_post - name: lua_draw_hook_post
@ -253,6 +251,15 @@ values:
- [function arguments] - [function arguments]
- name: lua_load - name: lua_load
desc: Loads the Lua scripts separated by spaces. desc: Loads the Lua scripts separated by spaces.
- name: lua_mouse_hook
desc: |-
This function, if defined, will be called by Conky upon receiving mouse
events from X or Wayland. A table containing event information will be
passed to this function as the first argument. Use this hook for detecting
mouse input and acting on it. Conky requires that the function declaration
has a 'conky_' prefix to prevent accidental calls to the wrong function.
args:
- function_name
- name: lua_shutdown_hook - name: lua_shutdown_hook
desc: |- desc: |-
This function, if defined, will be called by Conky at This function, if defined, will be called by Conky at
@ -415,18 +422,17 @@ values:
background opacity to 0%. background opacity to 0%.
- name: own_window_type - name: own_window_type
desc: |- desc: |-
if own_window is yes, you may specify type normal, desktop, If own_window is yes, you may specify type normal, desktop, dock, panel,
dock, panel, utility or override. Desktop windows are special utility or override. Desktop windows are special windows that have no
windows that have no window decorations; are always visible on your window decorations; are always visible on your desktop; do not appear in
desktop; do not appear in your pager or taskbar; and are sticky across your pager or taskbar; and are sticky across all workspaces. Utility
all workspaces. Utility windows are like desktop windows, windows are like desktop windows, except they appear above everything
except they appear above everything else rather than below. else rather than below. Panel windows reserve space along a desktop edge,
Panel windows reserve space along a desktop edge, just just like panels and taskbars, preventing maximized windows
like panels and taskbars, preventing maximized windows from from overlapping them. The edge is chosen based on the alignment
overlapping them. The edge is chosen based on the alignment option. option. Override windows are not under the control of the window
Override windows are not under the control of the window manager. manager. Hints are ignored. This type of window can be useful for
Hints are ignored. This type of window can be useful for certain certain situations.
situations.
default: normal default: normal
- name: pad_percents - name: pad_percents
desc: Pad percentages to this many decimals (0 = no padding). desc: Pad percentages to this many decimals (0 = no padding).
@ -454,13 +460,6 @@ values:
desc: Shows the time range covered by a graph. desc: Shows the time range covered by a graph.
- name: show_graph_scale - name: show_graph_scale
desc: Shows the maximum value in scaled graphs. desc: Shows the maximum value in scaled graphs.
- name: graph_gradient_mode
desc: |-
Changes the color space used for interpolation. Arguments are hcl, hsv,
and rgb (default).
args:
- (rgb|hcl|hsv)
default: rgb
- name: stippled_borders - name: stippled_borders
desc: Border stippling (dashing) in pixels. desc: Border stippling (dashing) in pixels.
- name: store_graph_data_explicitly - name: store_graph_data_explicitly

116
doc/lua.yaml
View File

@ -30,6 +30,50 @@ desc: |-
API, Conky will export a few additional functions for the creation of API, Conky will export a few additional functions for the creation of
certain structures. These are documented below. certain structures. These are documented below.
values: values:
- name: RsvgDimensionData:create()
desc: |-
Call this method to return a new RsvgDimensionData
structure. A creation function for this structure is not provided
by the Rsvg API.
After calling this, you should use `tolua.takeownership(rect)` on the return
value to ensure ownership is passed properly.
- name: RsvgDimensionData:destroy()
desc: |-
Call this method to free memory allocated by
`RsvgDimensionData:create`.
You should call `tolua.releaseownership(dd)` before calling this function to
avoid double-frees, but only if you previously called
`tolua.takeownership(dd)`
- name: RsvgDimensionData:get()
desc: |-
Gets the values of an existing RsvgDimensionData.
- name: RsvgDimensionData:set(x, y, width, height)
desc: |-
Sets the values of an existing RsvgDimensionData.
- name: RsvgRectangle:create()
desc: |-
Call this method to return a new RsvgRectangle
structure. A creation function for this structure is not provided
by the Rsvg API.
After calling this, you should use `tolua.takeownership(rect)` on the return
value to ensure ownership is passed properly.
- name: RsvgRectangle:destroy()
desc: |-
Call this method to free memory allocated by
`RsvgRectangle:create`.
You should call `tolua.releaseownership(rect)` before calling this function to
avoid double-frees, but only if you previously called
`tolua.takeownership(rect)`
- name: RsvgRectangle:get()
desc: |-
Gets the values of an existing RsvgRectangle.
- name: RsvgRectangle:set(x, y, width, height)
desc: |-
Sets the values of an existing RsvgRectangle.
- name: cairo_font_extents_t:create() - name: cairo_font_extents_t:create()
desc: |- desc: |-
Call this function to return a new cairo_font_extents_t Call this function to return a new cairo_font_extents_t
@ -64,6 +108,20 @@ values:
You should call `tolua.releaseownership(cm)` before calling this function to You should call `tolua.releaseownership(cm)` before calling this function to
avoid double-frees, but only if you previously called avoid double-frees, but only if you previously called
`tolua.takeownership(cm)` `tolua.takeownership(cm)`
- name: cairo_place_image(file, cr, x, y, width, height, alpha)
desc: |-
Renders an image onto a cairo_t, using imlib2. In some cases using a cairo_t and exact coordinates is more
useful.
| Argument | Description |
|---------------------|--------------------------------------------------------------------------------------|
| file | Path to the image to render. |
| cr | The `cairo_t` to render to. |
| x,y | Position to render the image. |
| width, height | The width and height to draw the image |
| alpha | The transparency of the image 1.0 is solid 0.0 is fully translucent. |
require('cairo_imlib2_helper') in your lua file.
- name: cairo_text_extents_t:create() - name: cairo_text_extents_t:create()
desc: |- desc: |-
Call this function to return a new cairo_text_extents_t Call this function to return a new cairo_text_extents_t
@ -137,50 +195,6 @@ values:
NOTE: This table is only defined when X support is NOTE: This table is only defined when X support is
enabled. enabled.
- name: RsvgRectangle:create()
desc: |-
Call this method to return a new RsvgRectangle
structure. A creation function for this structure is not provided
by the Rsvg API.
After calling this, you should use `tolua.takeownership(rect)` on the return
value to ensure ownership is passed properly.
- name: RsvgRectangle:destroy()
desc: |-
Call this method to free memory allocated by
`RsvgRectangle:create`.
You should call `tolua.releaseownership(rect)` before calling this function to
avoid double-frees, but only if you previously called
`tolua.takeownership(rect)`
- name: RsvgRectangle:set(x, y, width, height)
desc: |-
Sets the values of an existing RsvgRectangle.
- name: RsvgRectangle:get()
desc: |-
Gets the values of an existing RsvgRectangle.
- name: RsvgDimensionData:create()
desc: |-
Call this method to return a new RsvgDimensionData
structure. A creation function for this structure is not provided
by the Rsvg API.
After calling this, you should use `tolua.takeownership(rect)` on the return
value to ensure ownership is passed properly.
- name: RsvgDimensionData:destroy()
desc: |-
Call this method to free memory allocated by
`RsvgDimensionData:create`.
You should call `tolua.releaseownership(dd)` before calling this function to
avoid double-frees, but only if you previously called
`tolua.takeownership(dd)`
- name: RsvgDimensionData:set(x, y, width, height)
desc: |-
Sets the values of an existing RsvgDimensionData.
- name: RsvgDimensionData:get()
desc: |-
Gets the values of an existing RsvgDimensionData.
- name: ret_scale_x,ret_scale_y:cairo_draw_image(file, cs, x, y, scale_x, scale_y) - name: ret_scale_x,ret_scale_y:cairo_draw_image(file, cs, x, y, scale_x, scale_y)
desc: |- desc: |-
Renders an image onto a cairo_surface_t, using imlib2. Returns the amount the image was scaled by Renders an image onto a cairo_surface_t, using imlib2. Returns the amount the image was scaled by
@ -194,18 +208,4 @@ values:
| | 0.5 for half size etc. | | | 0.5 for half size etc. |
| | Default value: No Scaling (1.0,1.0) | | | Default value: No Scaling (1.0,1.0) |
require('cairo_imlib2_helper') in your lua file.
- name: cairo_place_image(file, cr, x, y, width, height, alpha)
desc: |-
Renders an image onto a cairo_t, using imlib2. In some cases using a cairo_t and exact coordinates is more
useful.
| Argument | Description |
|---------------------|--------------------------------------------------------------------------------------|
| file | Path to the image to render. |
| cr | The `cairo_t` to render to. |
| x,y | Position to render the image. |
| width, height | The width and height to draw the image |
| alpha | The transparency of the image 1.0 is solid 0.0 is fully translucent. |
require('cairo_imlib2_helper') in your lua file. require('cairo_imlib2_helper') in your lua file.

35
doc/variables.yaml
View File

@ -181,7 +181,6 @@ values:
default: BAT0 default: BAT0
args: args:
- (num) - (num)
- name: battery_short - name: battery_short
desc: |- desc: |-
Battery status and remaining percentage capacity of ACPI or APM battery. Battery status and remaining percentage capacity of ACPI or APM battery.
@ -865,9 +864,9 @@ values:
args: args:
- N - N
- name: ibm_thinklight - name: ibm_thinklight
desc: desc: |-
"If running the IBM ACPI, displays the status of your\nThinkLight\u2122. Value\ If running the IBM ACPI, displays the status of your
\ is either 'on', 'off' or 'unknown'." ThinkLight™. Value is either 'on', 'off' or 'unknown'.
- name: ibm_volume - name: ibm_volume
desc: |- desc: |-
If running the IBM ACPI, displays the "master" volume, If running the IBM ACPI, displays the "master" volume,
@ -951,24 +950,28 @@ values:
desc: |- desc: |-
If Pulseaudio's default sink is muted, display everything If Pulseaudio's default sink is muted, display everything
between $if_pa_sink_muted and the corresponding $else or $endif. between $if_pa_sink_muted and the corresponding $else or $endif.
- name: if_pa_source_muted
desc: |-
If Pulseaudio's default source (e.g. your microphone) is muted, display
everything between $if_pa_source_muted and the corresponding $else or $endif.
- name: if_pa_source_running - name: if_pa_source_running
desc: |- desc: |-
If Pulseaudio's default source is running (e.g. a program is accessing If Pulseaudio's default source is running (e.g. a program is accessing
your microphone), display everything between $if_pa_source_running and your microphone), display everything between $if_pa_source_running and
the corresponding $else or $endif. the corresponding $else or $endif.
- name: if_pa_source_muted
desc: |-
If Pulseaudio's default source (e.g. your microphone) is muted, display
everything between $if_pa_source_muted and the corresponding $else or $endif.
- name: if_running - name: if_running
desc: desc: |-
"If PROCESS is running, display everything between\n$if_running and the corresponding\ If PROCESS is running, display everything between `$if_running` and the
\ $else or $endif. Note that PROCESS\nmay be either a full command line with arguments\ corresponding `$else` or `$endif`. Note that PROCESS may be either a full
\ (without the\ndirectory prefix), or simply the name of an executable. For example,\n\ command line with arguments (without the directory prefix), or simply the
either of the following will be true if there is a running process\nwith the command\ name of an executable. For example, either of the following will be true
\ line `/usr/bin/conky -u 5`:\n\n* `${if_running conky -u 5}` or\n* `${if_running\ if there is a running process with the command line `/usr/bin/conky -u
\ conky}`\n \nIt is important not to include trailing spaces. For example,\ 5`:
\ `${if_running\nconky }` will be false." * `${if_running conky -u 5}` or
* `${if_running conky}`
It is important not to include trailing spaces. For example,
`${if_running conky }` will be false.
args: args:
- (process) - (process)
- name: if_smapi_bat_installed - name: if_smapi_bat_installed