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

projects / etc / awesome.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | inline | side by side
Updated Layouts (markdown)
[etc/awesome.git] / maildir.md
diff --git a/maildir.md b/maildir.md
index bd81c0272228e60ffcff938aa8d0da2a72d297fa..355ecddd77bc7935452f3a7cb0dc1d887181dc27 100644 (file)
--- a/maildir.md
+++ b/maildir.md
@@ -1,3 +1,5 @@
+[<- widgets](https://github.com/copycat-killer/lain/wiki/Widgets)
+
 Shows maildirs status in a textbox.
 
 Maildirs are structured as follows:
 Shows maildirs status in a textbox.
 
 Maildirs are structured as follows:
@@ -22,19 +24,16 @@ If there's new mails, the textbox will say something like "mail: bugs(3), system
 
        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:
+### input table
 
 Variable | Meaning | Type | Default
 --- | --- | --- | ---
 
 Variable | Meaning | Type | Default
 --- | --- | --- | ---
+`timeout` | Refresh timeout seconds | int | 60
 `mailpath` | Path to your maildir | string | "~/Mail"
 `mailpath` | Path to your maildir | string | "~/Mail"
-`ignore_boxes` | A list of boxes to ignore | table | empty table
-`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"
-`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
-
-**Note**: `footer` can be markup text.
\ No newline at end of file
+`settings` | User settings | function | empty function
+
+`settings` can use the string `newmail`, which format will be something like defined above, or "no mail".
+
+### output
+
+A textbox.
\ No newline at end of file
awesome window-manager configuration

Legalese

All content available in this repository is copyright © martin f. krafft, unless otherwise noted.

All files and their content are released under the terms of the Artistic Licence 2.0, unless otherwise noted.

The operator of this repository shall not be held liable for offending content in pages linking to or linked from these page, nor does he endorse their content unless stated otherwise.