X-Git-Url: https://git.madduck.net/etc/awesome.git/blobdiff_plain/b7c7e112110785966e45ab8d0475f32278046e13..d2ec840058a6de4eaafe57fe66953ede542815e6:/bat.md diff --git a/bat.md b/bat.md index 79c17da..6bbb21e 100644 --- a/bat.md +++ b/bat.md @@ -7,14 +7,24 @@ 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" -`shadow` | Hide the widget when battery is not present | boolean | false \ No newline at end of file +`notify` | Enable notifications | string | "on" +`settings` | User settings | function | empty function + +`settings` can use the `bat_now` table, which contains the following strings: + +- `status` ("Not present", "Charging", "Discharging"); +- `perc`; +- `time`; +- `watt`. + +To disable warning notifications, set `notify` to `"off"`. + +### output + +A textbox. \ No newline at end of file