X-Git-Url: https://git.madduck.net/etc/awesome.git/blobdiff_plain/8c213f95cf9beebd872fc3116380053a0f0334a6..6e6914aa5b1b9e5de69f0769a64b83202122a7d0:/mem.md?ds=sidebyside diff --git a/mem.md b/mem.md index 58ccf72..84b7ad2 100644 --- a/mem.md +++ b/mem.md @@ -1,19 +1,18 @@ -Show used memory and total memory in MiB. +[<- widgets](https://github.com/copycat-killer/lain/wiki/Widgets) - mymem = lain.widgets.mem() +Shows memory status (in MiB) in a textbox. + mymem = lain.widgets.mem() -The function takes a table as an optional argument. That table may -contain: +### input table Variable | Meaning | Type | Default --- | --- | --- | --- -`refresh_timeout` | Refresh timeout seconds | int | 10 -`show_swap` | Show amount of used swap space? | boolean | false -`show_total` | Show amout of total memory? | boolean | false -`header` | Text to show before value | string | " Vol " -`header_color` | Header color | string | `beautiful.fg_normal` or "#FFFFFF" -`color` | Value color | string | `beautiful.fg_focus` or "#FFFFFF" -`footer` | Text to show after value | string | "MB" +`timeout` | Refresh timeout seconds | int | 3 +`settings` | User settings | function | empty function + +`settings` can use the strings `mem_now.used` (memory used MB) and `mem_now.swapused` (swap used MB). + +### output -**Note**: `footer` color is `color`. \ No newline at end of file +A textbox. \ No newline at end of file