summaryrefslogtreecommitdiffhomepage
path: root/README
diff options
context:
space:
mode:
Diffstat (limited to 'README')
-rw-r--r--README21
1 files changed, 14 insertions, 7 deletions
diff --git a/README b/README
index 5d0a8ba..af979c9 100644
--- a/README
+++ b/README
@@ -473,22 +473,29 @@ Monitors have default aliases.
To activate, pass --flags="with_inotify" to "runhaskell Setup configure"
or to "cabal install".
-`MBox Mboxes BaseDir`
+`MBox Mboxes Opts Alias`
-- aliases to `MBox`
- Mboxes a list of mbox files of the form [("name", "path", "color")],
where name is the displayed name, path the absolute or relative (to
BaseDir) path of the mbox file, and color the color to use to display
the mail count (use an empty string for the default).
-- BaseDir is a string giving the base directory where mbox files with
- a relative path live. It can be empty if all your paths are
- absolute.
+- Opts is a possibly empty list of options, as flags. Possible values:
+ -a --all (no arg) Show all mailboxes, even if empty.
+ -d dir --dir dir a string giving the base directory where mbox files with
+ a relative path live.
+ -p prefix --prefix prefix a string giving a prefix for the list
+ of displayed mail coints
+ -s suffix --suffix suffix a string giving a suffix for the list
+ of displayed mail coints
- This plugin requires INOTIFY support in Linux kernel and hinotify library.
To activate, pass --flags="with_inotify" to "runhaskell Setup
configure" or to "cabal install".
- Example:
- `Run MBox [("I ", "inbox", "red"), ("O ", "/foo/mbox", "")] "/var/mail/"`
- will look for mails in /var/mail/inbox and /foo/mbox.
+ `Run MBox [("I ", "inbox", "red"), ("O ", "/foo/mbox", "")]
+ ["-d", "/var/mail/", "-p", " "] "mbox"`
+ will look for mails in `/var/mail/inbox` and `/foo/mbox`, and will put
+ a space in front of the printed string (when it's not empty); it
+ can be used in the template with the alias `mbox`.
### Monitor Plugins Commands Arguments