From: yawnt <yawnt@users.noreply.github.com>
Date: Mon, 23 Dec 2013 16:04:02 +0000 (-0800)
Subject: Created brightness (markdown)
X-Git-Url: https://git.madduck.net/etc/awesome.git/commitdiff_plain/648be56a195bd3fdb63b6de5ab5be90c628b4546

Created brightness (markdown)
---

diff --git a/brightness.md b/brightness.md
new file mode 100644
index 0000000..590359a
--- /dev/null
+++ b/brightness.md
@@ -0,0 +1,40 @@
+[<- widgets](https://github.com/copycat-killer/lain/wiki/Widgets)
+
+Shows brightness level in a textbox.
+
+	volumewidget = lain.widgets.contrib.brightness()
+
+### input table
+
+Variable | Meaning | Type | Default
+--- | --- | --- | ---
+`timeout` | Refresh timeout seconds | int | 5
+`backlight` | Backlight Video | string | "acpi_video0" 
+`settings` | User settings | function | empty function
+
+`settings` can use the following variables:
+
+Variable | Meaning | Type | Values
+--- | --- | --- | ---
+`brightness_now` | Brightness level | int | 0-100
+
+### output table
+
+Variable | Meaning | Type
+--- | --- | --- 
+`widget` | The widget | `wibox.widget.textbox`
+`update` | Update `widget` | function
+
+You can control the widget with key bindings like these:
+
+    -- Volume control
+    awful.key({}, "XF86MonBrightnessUp",
+    function ()
+        awful.util.spawn("xbacklight -inc 1")
+        brightnesswidget.update()
+    end),
+    awful.key({}, "XF86MonBrightnessDown",
+    function ()
+        awful.util.spawn("xbacklight -dec 1")
+        brightnesswidget.update()
+    end),