X-Git-Url: https://git.madduck.net/etc/awesome.git/blobdiff_plain/1c3ec6c8c71836e3770c2df3e2354b4479b0e747..18af84d88ecbdedee3048e65aa6ff2df130252e9:/bat.md?ds=sidebyside

diff --git a/bat.md b/bat.md
index 3ff9e65..50c14e8 100644
--- a/bat.md
+++ b/bat.md
@@ -1,3 +1,5 @@
+[<- widgets](https://github.com/copycat-killer/lain/wiki/Widgets)
+
 Shows in a textbox the remaining time and percentage capacity of your laptop battery, as well as
 the current wattage.
 
@@ -5,14 +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"
-`shadow` | Hide the widget when battery is not present | boolean | false
\ 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