i3 - improved tiling WM

Document new maildir support in man page

Patch status: rejected

Patch by Timo Buhrmester

To apply this patch, use:
curl http://cr.i3wm.org/patch/671/raw.patch | git am

b/man/i3status.man

13 
@@ -435,6 +435,50 @@ volume master {
14 
 }
15 
 -------------------------------------------------------------
16
17 
+=== Maildir
18 
+
19 
+Outputs the number of new mails in a local maildir. This is done simply
20 
+by looking at whether or not the 'new' part of the maildir is empty.
21 
+
22 
++format+ and +format_nomail+ specify the output formatting, depending on whether
23 
+or not there is new mail at all.  In these format strings, the following expansions
24 
+may be used:
25 
+
26 
+%name::
27 
+	Expands to the (arbitrary) name given to this maildir in the config file.
28 
+
29 
+%num::
30 
+	Expands to the amount of new mail, possibly capped by the +max+ option.
31 
+
32 
+%mail::
33 
+	Expands to "mail" or "mails", depending on whether we need singular or plural.
34 
+
35 
++path+ specifies the path to the maildir, which might be absolute or relative (in
36 
+which case it is relative to the user's home directory)
37 
+
38 
++name+ assigns an arbitrary name to this maildir, which is the +%name+ format specifier
39 
+expands to.
40 
+
41 
++max+ limits the number of files to enumerate when checking for new mail, to avoid
42 
+unnecessary resource usage for huge maildirs.
43 
+
44 
+*Example order*: +maildir INBOX+
45 
+
46 
+*Example format*: +%num new %mail in %name+
47 
+
48 
+*Example format_nomail*: +no mail in %name+
49 
+
50 
+*Example configuration*:
51 
+-------------------------------------------------------------
52 
+volume master {
53 
+	format = "%name: %num"
54 
+	format_nomail = "%name: -"
55 
+	path = "path/to/Maildir/"
56 
+	name = "INBOX"
57 
+	max = 9
58 
+}
59 
+-------------------------------------------------------------
60 
+
61 
 == Universal module options
62
63 
 When using the i3bar output format, there are a few additional options that