massive update, probably broken
[dotfiles/.git] / .config / awesome / lain / wiki / sysload.md
1 ## Usage
2
3 [Read here.](https://github.com/lcpz/lain/wiki/Widgets#usage)
4
5 ### Description
6
7 Shows the current system load.
8
9 ```lua
10 mysysload = lain.widget.sysload()
11 ```
12
13 ## Input table
14
15 Variable | Meaning | Type | Default
16 --- | --- | --- | ---
17 `timeout` | Refresh timeout (in seconds) | integer | 2
18 `settings` | User settings | function | empty function
19
20 `settings` can use strings `load_1`, `load_5` and `load_15`, which are the load averages over 1, 5, and 15 minutes.
21
22 ## Output table
23
24 Variable | Meaning | Type
25 --- | --- | ---
26 `widget` | The widget | `wibox.widget.textbox`
27 `update` | Update `widget` | function