X-Git-Url: https://git.madduck.net/etc/awesome.git/blobdiff_plain/ce4a3cd07665a8ad0d8f86d676e65a78da491b65..f996cdb74e7583534256d82706ef63d2b9811b42:/sysload.md diff --git a/sysload.md b/sysload.md index 0e57a8f..3e53881 100644 --- a/sysload.md +++ b/sysload.md @@ -1,14 +1,18 @@ -Show the current system load in a textbox. +[<- widgets](https://github.com/copycat-killer/lain/wiki/Widgets) + +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