diff --git a/meson.build b/meson.build index 60f5311..5677bac 100644 --- a/meson.build +++ b/meson.build @@ -161,7 +161,7 @@ if scdoc.found() mandir = get_option('mandir') man_files = [ 'waybar.5.scd', - + 'waybar-backlight.5.scd', ] foreach filename : man_files diff --git a/waybar-backlight.5.scd b/waybar-backlight.5.scd new file mode 100644 index 0000000..1992558 --- /dev/null +++ b/waybar-backlight.5.scd @@ -0,0 +1,68 @@ +waybar-backlight(5) + +# NAME + +waybar - backlight module + +# DESCRIPTION + +The *backlight* module displays the current backlight level. + +# Config + +*interval* ++ + typeof: integer ++ + default: 2 ++ + The interval in which information gets polled. + +*format* ++ + typeof: string ++ + default: {percent}% ++ + The format, how information should be displayed. On {} data gets inserted. + +*max-length* ++ + typeof: integer ++ + The maximum length in characters the module should display. + +*rotate* ++ + typeof: integer ++ + Positive value to rotate the text label. + +*states* ++ + typeof: array ++ + A number of backlight states which get activated on certain brightness levels. + +*on-click* ++ + typeof: string ++ + Command to execute when the module is clicked. + +*on-click-right* ++ + typeof: string ++ + Command to execute when the module is right clicked. + +*on-scroll-up* ++ + typeof: string ++ + Command to execute when performing a scroll up on the module. + +*on-scroll-down* ++ + typeof: string + Command to execute when performing a scroll down on the module. + +*smooth-scrolling-threshold* ++ + typeof: double + Threshold to be used when scrolling. + +# Example: + +``` +"backlight": { + "device": "intel_backlight", + "format": "{percent}% {icon}", + "format-icons": ["", ""] +} + +``` + +# Style + +- `#backlight`