Added cffi man page

This commit is contained in:
Crom (Thibaut CHARLES) 2023-12-12 16:16:21 +01:00
parent 02c64f3f1e
commit 75f9141cac
No known key found for this signature in database
GPG Key ID: 45A3D5F880B9E6D0
2 changed files with 38 additions and 0 deletions

37
man/waybar-cffi.5.scd Normal file
View File

@ -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.

View File

@ -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',