Updated fs (markdown)

[etc/awesome.git] / maildir.md

diff --git a/maildir.md b/maildir.md
index df5f6fe34a62acc6951123646363a06a8aee015b..a30e59fb676e316003038ad8fb0336de16bf0d37 100644 (file)
--- a/maildir.md
+++ b/maildir.md
@@ -1,4 +1,6 @@
-Checks your maildirs.
+[<- widgets](https://github.com/copycat-killer/lain/wiki/Widgets)
+
+Shows maildirs status in a textbox.
 
 Maildirs are structured as follows:
 
@@ -17,10 +19,10 @@ Maildirs are structured as follows:
        .
 
 therefore the widget checks whether there are files in the `new` directories.
-If there's new mail, the textbox will say something like "mail: bugs(3), system(1)", otherwise it says
+If there's new mails, the textbox will say something like "mail: bugs(3), system(1)", otherwise it says
 "no mail".
 
-       mymaildir= lain.widgets.maildir("/path/to/my/maildir")
+       mymaildir = lain.widgets.maildir("/path/to/my/maildir")
 
 The function takes a table as optional argument, which can contain:
 
@@ -33,5 +35,8 @@ Variable | Meaning | Type | Default
 `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"
+`footer` | Text to append after value | string | " "
 `app` | Mail program to spawn on click | string | "mutt"| boolean | false
-`shadow` | Hide widget when there are no mails | boolean | false
\ No newline at end of file
+`shadow` | Hide widget when there are no mails | boolean | false
+
+**Note**: `footer` can be markup text.
\ No newline at end of file