From 0fb405d2a53257a83661b1cb1bbc8f23ff9b7c41 Mon Sep 17 00:00:00 2001 From: Luke Bonham Date: Sat, 7 Sep 2013 03:34:00 -0700 Subject: [PATCH] Created bat (markdown) --- bat.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) create mode 100644 bat.md diff --git a/bat.md b/bat.md new file mode 100644 index 0000000..9e2d8c5 --- /dev/null +++ b/bat.md @@ -0,0 +1,18 @@ +Shows the remaining time and percentage capacity of your laptop battery, as well as +the current wattage. + +Displays a notification when battery is low or critical. + + mybattery = lain.widgets.bat() + +The function takes a table as optional argument, which can contain: + +Variable | Meaning | Type | Default +--- | --- | --- | --- +`battery` | Identifier of the battery | string | "BAT0" +`show_all` | Show all values (true), or only remaining capacity (false) | boolean | false +`refresh_timeout` | Refresh timeout seconds | int | 30 +`header` | Text to show before value | string | " Vol " +`header_color` | Header color | string | `beautiful.fg_normal` or "#FFFFFF" +`color` | Value color | string | `beautiful.fg_focus` or "#FFFFFF" +`shadow` | Hide the widget when battery is not present | boolean | false \ No newline at end of file -- 2.39.2