X-Git-Url: https://git.madduck.net/etc/awesome.git/blobdiff_plain/6d21ffc4f64a3a9ccf5c3537c7199476b94c5efc..e44940ce34d3e5feae6f01c9a2f3ac8beef3342d:/cpu.md diff --git a/cpu.md b/cpu.md index 8a3d5d8..4994e1d 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 be fed with the string `usage`, which means the cpu use percentage. + +### output + +A textbox. \ No newline at end of file