Created mem (markdown)

This commit is contained in:
Luke Bonham 2013-09-07 03:11:44 -07:00 committed by copycat-killer
parent 00cd5d9e59
commit 8c213f95cf
1 changed files with 19 additions and 0 deletions

19
mem.md Normal file
View File

@ -0,0 +1,19 @@
Show used memory and total memory in MiB.
mymem = lain.widgets.mem()
The function takes a table as an optional argument. That table may
contain:
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"
**Note**: `footer` color is `color`.