From: Luke Bonham <dadasignificanulla@gmail.com>
Date: Sat, 7 Sep 2013 10:11:44 +0000 (-0700)
Subject: Created mem (markdown)
X-Git-Url: https://git.madduck.net/etc/awesome.git/commitdiff_plain/f026d1011a3b28c1f649b32afe85920175355b38

Created mem (markdown)
---

diff --git a/mem.md b/mem.md
new file mode 100644
index 0000000..58ccf72
--- /dev/null
+++ b/mem.md
@@ -0,0 +1,19 @@
+Show used memory and total memory in MiB.
+
+	mymem = lain.widgets.mem()
+
+
+The function takes a table as an optional argument. That table may
+contain:
+
+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"
+
+**Note**: `footer` color is `color`.
\ No newline at end of file