Updated alsabar (markdown)

[etc/awesome.git] / bat.md

diff --git a/bat.md b/bat.md
index 8b241519e33cd7669593da1d8cdd4002570d8f24..50c14e8cb33f668e6b8a0a215595cfbf273a7d58 100644 (file)
--- a/bat.md
+++ b/bat.md
@@ -7,17 +7,21 @@ 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` ("Not present", "Charging", "Discharging");
+- `perc`;
+- `time`;
+- `watt`.
+
+### output
+
+A textbox.
\ No newline at end of file