X-Git-Url: https://git.madduck.net/etc/awesome.git/blobdiff_plain/87e14e029c7112a6628d0ef149d65d675ef5c5c6..37c3546f5143dbb71985dc0adf47ef5c8c38ca26:/cpu.md?ds=sidebyside diff --git a/cpu.md b/cpu.md index 7f7cd82..11bf53f 100644 --- a/cpu.md +++ b/cpu.md @@ -4,14 +4,15 @@ 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 | "Cpu" -`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 | 10 +`settings` | User settings | function | empty function -**Note**: `footer` color is `color`. \ No newline at end of file +`settings` can use the string `usage`, which is the cpu use percentage. + +### output + +A textbox. \ No newline at end of file