WMBIFFRC(5)WMBIFFRC(5)NAMEwmbiffrc - configuration file for wmbiff(1)DESCRIPTION
WMbiff is a mail notification tool for the WindowMaker and AfterStep
window managers. It can handle up to 5 mailboxes, and you can define
actions on mouse clicks for the different mailboxes. This manpage
explains the different options which can be specified in a user's wmb‐
iffrc.
OPTIONS
Each option takes the form option[.mbox] = value. Comment must be pre‐
ceeded by pound signs (#).
The supported configuration options are:
interval
Global interval between mailbox checking. Value is the number of
seconds, 5 is the default.
askpass
Program run to ask for IMAP passwords, if left empty in the configu‐
ration file. The default is /usr/bin/ssh-askpass. Can be specified
on a per-mailbox basis.
skinfile
XPM pixmap file to load for the background. If not a full path,
wmbiff will search /usr//share/wmbiff/skins, /usr/share/wmbiff,
/usr/local/share/wmbiff, and the current directory for the pixmap
file.
label.n
Specifies the displayed label for a mailbox. It can be up to five
characters long.
path.n
Path to the mailbox, local or remote one. Path lines start with a
prefix, which specifies the type of wmbiff box you're setting up.
The following types are supported:
mbox This is a local mbox mailbox. After the prefix, you only need
to put the path to the mailbox wmbiff needs to read. Local
mboxes may be specified using shell commands enclosed in
back-ticks. (`s.)
mbox:/path/to/mail/debian-devel
maildir
This works just like mbox above.
maildir:/path/to/mail/bugtraq/
pop3 Using this type, WMBiff will check for mail on a pop3 server
using the specified username, password, host and an optional
port number (defaulting to 110). If your password contains a
special character, eg. '@' or ':', use the second path for‐
mat. See Authentication below for a description of the auth
field.
pop3:user:passwd@server[:port] [auth]
pop3:user passwd server[ port] [auth]
imap These are IMAP4 boxes. As with pop3, WMBiff will report the
status of an IMAP4 mbox using the given values. This type
accepts user, optional password, host and optional path to
mailbox and port number. See Authentication below for a
description of the auth field. The password may be left
empty: see askpass above for information on password prompt‐
ing.
imap:user:passwd@server[/mailbox][:port] [auth]
imap:user:@server[/mailbox][:port] [auth]
imap:user passwd server[/mailbox][ port] [auth]
imaps These are IMAP4 boxes wrapped in a TLS (SSL) connection. This
copy of WMBiff was not compiled with GNUTLS. Parameters are
the same as those for ordinary IMAP4 boxes. Port defaults to
993. If 143 is specified, WMBiff will attempt to connect
unencrypted but negotiate TLS using IMAP's STARTTLS command.
TLS support uses GNUTLS, which is under development and may
be insecure. TLS support is only for encryption: since cer‐
tificates are not yet checked, it is vulnerable to man-in-
the-middle attack. Like IMAP, WMBiff will prompt the user if
the password is left blank.
imaps:user:passwd@server[/mailbox][:port] [auth]
imaps:user:@server[/mailbox][:port] [auth]
imaps:user passwd server[/mailbox][ port] [auth]
licq With this box type, wmbiff will read the given history file
and track the number of messages in it. It just needs a path
to a given licq history file.
licq:/path/to/.licq/history/file.history
gicu With this box type, wmbiff will ask gnomeicu for the number
of pending messages. If gnomeicu is not running, nothing
will be displayed. gnomeicu-client must be in your path.
The user's icq UIN is optional.
gicu:[UIN]
finger With this box type, wmbiff will finger an account to see if
there is unread mail. Both finger and perl must be in your
path, and your server must run a finger daemon.
finger:user@host
shell With this EXPERIMENTAL keyword, wmbiff will launch the speci‐
fied shell command and read its output (STDOUT) expecting an
integer message count or a three-character string. If "new"
is in the first line, the string or number will be displayed
in yellow. The behavior of this experimental keyword is
likely to change in future revisions.
shell:::/path/to/command shell:::lpq | grep Queue | awk
'{print $2}'
notify.n
Command to be executed on new mail arrival in the given mailbox.
Accepts the special keyword "beep" to use the pc speaker.
action.n
Command to be executed on left mouse click on a mailbox label.
interval.n
Per mailbox check interval. Value is the amount of seconds between
checkings, default is the global interval.
fetchinterval.n
Interval between mail auto-fetching. Values accept 0 to disable, -1
for autofetching on new mail arrival, and positive values for a
given interval in seconds.
fetchcmd.n
Command to be executed to fetch mail. If not specified, fetching
through wmbiff is disabled completely.
debug.n
Show debugging messages from this mailbox. Currently supported val‐
ues are "all" and "none". The -debug option to wmbiff overrides
this setting. Since IMAP uses a single connection per server, per-
mailbox debugging may not
AUTHENTICATION
Authentication methods include "cram-md5", "apop" (for Pop3), and
"plaintext". "cram-md5" and "apop" are only available when wmbiff is
compiled with libgcrypt. This copy of WMBiff was not compiled with
gcrypt. Authentication methods are tried in the following order: cram-
md5, apop, plaintext.
Each authentication method will be tried unless a list is included in
the [auth] field. For example, append "cram-md5 apop" if you don't
want your password to be sent in cleartext over the network. Con‐
versely, append "plaintext" if you don't want wmbiff to bother with
other authentication methods. Leaving authentication methods unspeci‐
fied should be reasonably safe. The order of entries in the [auth]
list is not currently considered.
TROUBLESHOOTING
For problems authenticating to servers, try specifying the authentica‐
tion method explicitly as described above: sometimes a failed attempt
to authenticate can cause later failures. Some servers claim to sup‐
port cram-md5 but fail: telling wmbiff not totry can help.
For other problems, run wmbiff with the -debug option. See wmbiff(1)
for details.
FILES
~/.wmbiffrc
per-user wmbiff configuration file.
AUTHOR
This manual page was written by Jordi Mallach <jordi@debian.org>, orig‐
inally for the Debian GNU/Linux system (but may be used by others).
SEE ALSOwmbiff(1)
/usr/share/doc/wmbiff/examples/sample.wmbiffrc (or equivalent on your
system)
wmbiff January 27, 2002 WMBIFFRC(5)
