]> git.madduck.net Git - etc/awesome.git/blobdiff - bat.md

madduck's git repository

Every one of the projects in this repository is available at the canonical URL git://git.madduck.net/madduck/pub/<projectpath> — see each project's metadata for the exact URL.

All patches and comments are welcome. Please squash your changes to logical commits before using git-format-patch and git-send-email to patches@git.madduck.net. If you'd read over the Git project's submission guidelines and adhered to them, I'd be especially grateful.

SSH access, as well as push access can be individually arranged.

If you use my repositories frequently, consider adding the following snippet to ~/.gitconfig and using the third clone URL listed for each project:

[url "git://git.madduck.net/madduck/"]
  insteadOf = madduck:

Updated Home (markdown)
[etc/awesome.git] / bat.md
diff --git a/bat.md b/bat.md
index 5d89b14938e3496b8e5bb1efc567fe112bddbe16..50c14e8cb33f668e6b8a0a215595cfbf273a7d58 100644 (file)
--- a/bat.md
+++ b/bat.md
@@ -7,15 +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
\ 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