]> 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:

projects / etc / awesome.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | inline | side by side
Updated cpu (markdown)
[etc/awesome.git] / bat.md
diff --git a/bat.md b/bat.md
index 3ff9e6558979f108eadee6282bd0f2acc98b049d..1f8bf1fe9a8cb2945e0019564b9b498e43dbb3d0 100644 (file)
--- 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.
 
 Shows in a textbox the remaining time and percentage capacity of your laptop battery, as well as
 the current wattage.
 
@@ -5,14 +7,14 @@ Displays a notification when battery is low or critical.
 
        mybattery = lain.widgets.bat()
 
 
        mybattery = lain.widgets.bat()
 
-The function takes a table as optional argument, which can contain:
+### input table
 
 Variable | Meaning | Type | Default
 --- | --- | --- | ---
 
 Variable | Meaning | Type | Default
 --- | --- | --- | ---
+`timeout` | Refresh timeout seconds | int | 30
 `battery` | Identifier of the battery | string | "BAT0"
 `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
+
+### output
+
+A textbox.
\ No newline at end of file
awesome window-manager configuration

Legalese

All content available in this repository is copyright © martin f. krafft, unless otherwise noted.

All files and their content are released under the terms of the Artistic Licence 2.0, unless otherwise noted.

The operator of this repository shall not be held liable for offending content in pages linking to or linked from these page, nor does he endorse their content unless stated otherwise.