Added cffi man page
This commit is contained in:
parent
02c64f3f1e
commit
75f9141cac
|
@ -0,0 +1,37 @@
|
||||||
|
waybar-cffi(5)
|
||||||
|
# NAME
|
||||||
|
|
||||||
|
waybar - cffi module
|
||||||
|
|
||||||
|
# DESCRIPTION
|
||||||
|
|
||||||
|
The *cffi* module gives full control of a GTK widget to a third-party dynamic library, to create more complex modules using different programming languages.
|
||||||
|
|
||||||
|
# CONFIGURATION
|
||||||
|
|
||||||
|
Addressed by *cffi/<name>*
|
||||||
|
|
||||||
|
*module_path*: ++
|
||||||
|
typeof: string ++
|
||||||
|
The path to the dynamic library to load to control the widget.
|
||||||
|
|
||||||
|
Some additional configuration may be required depending on the cffi dynamic library being used.
|
||||||
|
|
||||||
|
|
||||||
|
# EXAMPLES
|
||||||
|
|
||||||
|
## C example:
|
||||||
|
|
||||||
|
An example module written in C can be found at https://github.com/Alexays/Waybar/resources/custom_modules/cffi_example/
|
||||||
|
|
||||||
|
Waybar config to enable the module:
|
||||||
|
```
|
||||||
|
"cffi/c_example": {
|
||||||
|
"module_path": ".config/waybar/cffi/wb_cffi_example.so"
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
# STYLE
|
||||||
|
|
||||||
|
The classes and IDs are managed by the cffi dynamic library.
|
|
@ -442,6 +442,7 @@ if scdoc.found()
|
||||||
'waybar-backlight-slider.5.scd',
|
'waybar-backlight-slider.5.scd',
|
||||||
'waybar-battery.5.scd',
|
'waybar-battery.5.scd',
|
||||||
'waybar-cava.5.scd',
|
'waybar-cava.5.scd',
|
||||||
|
'waybar-cffi.5.scd',
|
||||||
'waybar-clock.5.scd',
|
'waybar-clock.5.scd',
|
||||||
'waybar-cpu.5.scd',
|
'waybar-cpu.5.scd',
|
||||||
'waybar-custom.5.scd',
|
'waybar-custom.5.scd',
|
||||||
|
|
Loading…
Reference in New Issue