X-Git-Url: https://git.madduck.net/etc/awesome.git/blobdiff_plain/211e7a5ec6905372bc9f1a3ee9a79fda54d53056..2098a3ef16f6f435509adde00fc7a37794a140d2:/imap.md?ds=sidebyside

diff --git a/imap.md b/imap.md
index 3c049dd..97cd437 100644
--- a/imap.md
+++ b/imap.md
@@ -1,8 +1,10 @@
-Check new mails over IMAP protocol.
+[<- widgets](https://github.com/copycat-killer/lain/wiki/Widgets)
+
+Shows mail status in a textbox over IMAP protocol.
 
 Dependencies:
 
-- Python3
+- python3
 
 New mails are notified through a notification like this:
 
@@ -38,14 +40,16 @@ Variable | Meaning | Type | Default
 `refresh_timeout` | Refresh timeout seconds | int | 60
 `header` | Text to show before value | string | " Mail "
 `header_color` | Header color | string | `beautiful.fg_normal` or "#FFFFFF"
-`color_newmail` | New mail value color | string | `beautiful.fg_focus` or "#FFFFFF"
-`color_nomail` | No mail value color | string | `beautiful.fg_normal` or "#FFFFFF"
+`color` | Mail value color | string | `beautiful.fg_focus` or "#FFFFFF"
+`footer` | Text to append after value | string | " "
 `mail_encoding` | Mail character encoding | string | autodetected
 `maxlen` | Maximum chars to display in notification | int | 200
 `app` | Mail program to spawn on click | string | "mutt"
 `shadow` | Hide widget when there are no mails | boolean | false
 `is_plain` | Define whether `password` is a plain password (true) or a function that retrieves it (false) | boolean | false
 
+**Note**: `footer` can be markup text.
+
 Let's focus better on `is_plain`.
 
 You can just set your password like this:
@@ -61,4 +65,6 @@ and you'll have the same security provided by `~/.netrc`.
 
 When `is_plain == false`, it *executes* `password` before using it, so you can also use whatever password fetching solution you want.
 
-You can also define your custom icon for the naughty notification. Just set `lain_mail_notify` into `theme.lua`.
\ No newline at end of file
+You can also define your custom icon for the naughty notification. Just set `lain_mail_notify` into `theme.lua`:
+
+    theme.lain_mail_notify = "/path/to/my/icon"
\ No newline at end of file