neodotfiles/.config/awesome/lain/wiki/mem.md
Clay Gomera 84a27f2f7f updated
2022-01-13 23:48:37 -04:00

33 lines
No EOL
793 B
Markdown
Executable file

## Usage
[Read here.](https://github.com/lcpz/lain/wiki/Widgets#usage)
### Description
Shows memory status in MiB, [like `top` and `free -h`](https://github.com/lcpz/lain/issues/271).
```lua
local mymem = lain.widget.mem()
```
## Input table
Variable | Meaning | Type | Default
--- | --- | --- | ---
`timeout` | Refresh timeout (in seconds) | integer | 2
`settings` | User settings | function | empty function
in `settings` you can use the following variables:
Variable | Meaning | Type
--- | --- | ---
`mem_now.used` | Memory used (MiB) | string
`mem_now.swapused` | Swap memory used (MiB) | string
`mem_now.perc` | Memory percentage | int
## Output table
Variable | Meaning | Type
--- | --- | ---
`widget` | The widget | `wibox.widget.textbox`
`update` | Update `widget` | function