awesomewm-mirrors
/
lain
mirror of https://github.com/lcpz/lain.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Updated bat (markdown)

This commit is contained in:
Luke Bonham 2013-09-10 13:32:32 -07:00 committed by copycat-killer
parent e95e05e2d3
commit 87af954c99
1 changed files with 6 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
bat.md
View File

@ -7,17 +7,14 @@ Displays a notification when battery is low or critical.
mybattery = lain.widgets.bat() mybattery = lain.widgets.bat()
The function takes a table as optional argument, which can contain: ### input table
Variable | Meaning | Type | Default Variable | Meaning | Type | Default
--- | --- | --- | --- --- | --- | --- | ---
`timeout` | Refresh timeout seconds | int | 30
`battery` | Identifier of the battery | string | "BAT0" `battery` | Identifier of the battery | string | "BAT0"
`show_all` | Show all values (true), or only remaining capacity (false) | boolean | false `settings` | User settings | function | empty function
`refresh_timeout` | Refresh timeout seconds | int | 30
`header` | Text to show before value | string | " Bat "
`header_color` | Header color | string | `beautiful.fg_normal` or "#FFFFFF"
`color` | Value color | string | `beautiful.fg_focus` or "#FFFFFF"
`footer` | Text to append after value | string | " "
`shadow` | Hide the widget when battery is not present | boolean | false
**Note**: `footer` can be markup text. ### output
A textbox.