X-Git-Url: https://git.madduck.net/etc/awesome.git/blobdiff_plain/afd328fe2598ea9d8621fe17abdd098f30a731e2..cb04a2e7413ce1f09734218e10e6193cabfc23ac:/bat.md diff --git a/bat.md b/bat.md index 8b24151..1f8bf1f 100644 --- a/bat.md +++ b/bat.md @@ -7,17 +7,14 @@ Displays a notification when battery is low or critical. mybattery = lain.widgets.bat() -The function takes a table as optional argument, which can contain: +### input table Variable | Meaning | Type | Default --- | --- | --- | --- +`timeout` | Refresh timeout seconds | int | 30 `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 | " 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 +`settings` | User settings | function | empty function -**Note**: `footer` can be markup text. \ No newline at end of file +### output + +A textbox. \ No newline at end of file