]> git.madduck.net Git - etc/awesome.git/blob - bat.md

madduck's git repository

Every one of the projects in this repository is available at the canonical URL git://git.madduck.net/madduck/pub/<projectpath> — see each project's metadata for the exact URL.

All patches and comments are welcome. Please squash your changes to logical commits before using git-format-patch and git-send-email to patches@git.madduck.net. If you'd read over the Git project's submission guidelines and adhered to them, I'd be especially grateful.

SSH access, as well as push access can be individually arranged.

If you use my repositories frequently, consider adding the following snippet to ~/.gitconfig and using the third clone URL listed for each project:

[url "git://git.madduck.net/madduck/"]
  insteadOf = madduck:

9e2d8c5a7d8e1056728fe4b79dcd195ec0051f0b
[etc/awesome.git] / bat.md
1 Shows the remaining time and percentage capacity of your laptop battery, as well as
2 the current wattage.
3
4 Displays a notification when battery is low or critical.
5
6         mybattery = lain.widgets.bat()
7
8 The function takes a table as optional argument, which can contain:
9
10 Variable | Meaning | Type | Default
11 --- | --- | --- | ---
12 `battery` | Identifier of the battery | string | "BAT0"
13 `show_all` | Show all values (true), or only remaining capacity (false) | boolean | false
14 `refresh_timeout` | Refresh timeout seconds | int | 30
15 `header` | Text to show before value | string | " Vol "
16 `header_color` | Header color | string | `beautiful.fg_normal` or "#FFFFFF"
17 `color` | Value color | string | `beautiful.fg_focus` or "#FFFFFF"
18 `shadow` | Hide the widget when battery is not present | boolean | false