]> git.madduck.net Git - etc/awesome.git/blobdiff - sysload.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 mem (markdown)
[etc/awesome.git] / sysload.md
index 65b5eec918d909a1d03adadca76fa069b859eaea..3e538816bac9d82fb0bcd964decd7a687266f86d 100644 (file)
@@ -1,16 +1,18 @@
 [<- widgets](https://github.com/copycat-killer/lain/wiki/Widgets)
 
-Show the current system load in a textbox.
+Shows the current system load.
 
        mysysload = lain.widgets.sysload()
 
-The function takes a table as optional argument, which can contain:
+### input table
 
 Variable | Meaning | Type | Default
 --- | --- | --- | ---
-`show_all` | Show all the three values (true), or only the first one (false) | boolean | false
-`refresh_timeout` | Refresh timeout seconds | int | 5
-`header` | Text to show before value | string | " Load "
-`header_color` | Header color | string | `beautiful.fg_normal` or "#FFFFFF"
-`color` | Value color | string | `beautiful.fg_focus` or "#FFFFFF"
-`app` | Proc program to spawn on click | string | "top"
\ No newline at end of file
+`timeout` | Refresh timeout seconds | int | 5
+`settings` | User settings | function | empty function
+
+`settings` can use strings `load_1`, `load_5` and `load_15`, which are loadavg over 1, 5, and 15 minutes.
+
+### output
+
+A textbox.
\ No newline at end of file