From 839de289ba268d561ec2a8820fec0f5c4537e69d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Daniel=20Ekl=C3=B6f?= Date: Sun, 21 Apr 2019 21:06:10 +0200 Subject: [PATCH] doc: module: backlight --- doc/f00bar-modules.5.scd | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) diff --git a/doc/f00bar-modules.5.scd b/doc/f00bar-modules.5.scd index aa39c1c..873daac 100644 --- a/doc/f00bar-modules.5.scd +++ b/doc/f00bar-modules.5.scd @@ -85,6 +85,34 @@ bar: content: {string: {text: "{volume}"}} ``` +# BACKLIGHT + +This module reads monitor backlight status from +_/sys/class/backlight_, and uses *udev* to monitor for changes. + +## TAGS + +[[ *Name* +:[ *Type* +:[ *Description* +| brightness +: range +: The current brightness level, in absolute value +| percent +: range +: The current brightness level, in percent + +## CONFIGURATION + +[[ *Name* +:[ *Type* +:[ *Req* +:[ *Description* +| name +: string +: yes +: The backlight device's name (one of the names in _/sys/class/backlight_) + # SEE ALSO *f00bar-particles*(5), *f00bar-tags*(5), *f00bar-decorations*(5)