]> git.madduck.net Git - etc/awesome.git/blobdiff - mem.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:

Created tpbat (markdown)
[etc/awesome.git] / mem.md
diff --git a/mem.md b/mem.md
index 58ccf721aaebeff470986d9650a5c19ac829fb5c..84b7ad2c8962e51d41f08405cb83817759f7fa3a 100644 (file)
--- a/mem.md
+++ b/mem.md
@@ -1,19 +1,18 @@
-Show used memory and total memory in MiB.
+[<- widgets](https://github.com/copycat-killer/lain/wiki/Widgets)
 
-       mymem = lain.widgets.mem()
+Shows memory status (in MiB) in a textbox.
 
+       mymem = lain.widgets.mem()
 
-The function takes a table as an optional argument. That table may
-contain:
+### input table
 
 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"
+`timeout` | Refresh timeout seconds | int | 3
+`settings` | User settings | function | empty function
+
+`settings` can use the strings `mem_now.used` (memory used MB) and `mem_now.swapused` (swap used MB).
+
+### output
 
-**Note**: `footer` color is `color`.
\ No newline at end of file
+A textbox.
\ No newline at end of file