]> git.madduck.net Git - etc/awesome.git/blobdiff - cpu.md

madduck's git repository

Every one of the projects in this repository is available at the canonical URL git://git.madduck.net/madduck/pub/<projectpath> — see each project's metadata for the exact URL.

All patches and comments are welcome. Please squash your changes to logical commits before using git-format-patch and git-send-email to patches@git.madduck.net. If you'd read over the Git project's submission guidelines and adhered to them, I'd be especially grateful.

SSH access, as well as push access can be individually arranged.

If you use my repositories frequently, consider adding the following snippet to ~/.gitconfig and using the third clone URL listed for each project:

[url "git://git.madduck.net/madduck/"]
  insteadOf = madduck:

Updated mpd (markdown)
[etc/awesome.git] / cpu.md
diff --git a/cpu.md b/cpu.md
index bdcc1284c943eb1613f8b5891251dcb6cf329849..ae490b0d3b830a7367e27a70a06e97948ea06515 100644 (file)
--- 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()
 
 
        mycpuusage = lain.widgets.cpu()
 
-The function takes a table as optional argument, which can contain:
+### input table
 
 Variable | Meaning | Type | Default
 --- | --- | --- | ---
 
 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