X-Git-Url: https://git.madduck.net/etc/awesome.git/blobdiff_plain/131ccc38a7f306a19c6b756dbf3d203f4b6d34e3..8f1b80f2843b9c13d68d56fd82c9f5eada721bfd:/bat.md?ds=sidebyside diff --git a/bat.md b/bat.md index 8b24151..ec10057 100644 --- a/bat.md +++ b/bat.md @@ -7,17 +7,16 @@ 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 - -**Note**: `footer` can be markup text. \ No newline at end of file +`settings` | User settings | function | empty function + +`settings` can use the `bat_now` table, which contains the following strings: `status`, `perc`, `time`, `watt`. + +### output + +A textbox. \ No newline at end of file