X-Git-Url: https://git.madduck.net/etc/awesome.git/blobdiff_plain/d866043cd7ef8b9861573fba00f9e95b186f261d..e996c58363672b7ca530b02bbd38010adfc2a9e9:/cpu.md?ds=sidebyside diff --git a/cpu.md b/cpu.md index bdcc128..ae490b0 100644 --- a/cpu.md +++ b/cpu.md @@ -1,15 +1,18 @@ -Shows the average CPU usage percent for a given amount of time. +[<- widgets](https://github.com/copycat-killer/lain/wiki/Widgets) + +Shows in a textbox the average CPU usage percent for a given amount of time. mycpuusage = lain.widgets.cpu() -The function takes a table as optional argument, which can contain: +### input table Variable | Meaning | Type | Default --- | --- | --- | --- -`refresh_timeout` | Refresh timeout seconds | int | 10 -`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 add after value | string | "%" +`timeout` | Refresh timeout seconds | int | 5 +`settings` | User settings | function | empty function + +`settings` can use the string `usage`, which is the cpu use percentage. + +### output -**Note**: `footer` color is `color`. \ No newline at end of file +A textbox. \ No newline at end of file