wmbiff/wmbiff/wmbiff.1

   1 .\" Hey, Emacs!  This is an -*- nroff -*- source file.
   2 .\" $Id: wmbiff.1,v 1.13 2003/02/08 21:04:48 bluehal Exp $
   3 .\"
   4 .\" wmbiff.1 and wmbiffrc.5 are copyright 1999-2001 by
   5 .\" Jordi Mallach <jordi@debian.org>
   6 .\"
   7 .\" This is free documentation, see the latest version of the GNU
   8 .\" General Public License for copying conditions. There is NO warranty.
   9 .TH WMBIFF 1 "October 4, 2001" "wmbiff"
  10
  11 .SH NAME
  12 WMBiff \- A dockable Mailbox Monitor
  13
  14 .SH SYNOPSIS
  15 .B wmbiff
  16 [-display <display name>] [-geometry +XPOS+YPOS] [-c <filename>] [-h] [-v] [-debug] [-fg <foreground-color>] [-bg <background-color>] [-hi <highlight-color>] [-font <X11 font>|default] [-o] [+w]
  17 .br
  18
  19 .SH DESCRIPTION
  20 WMbiff displays the status of up to five mailboxes. It shows the number
  21 of new mail messages, if any, otherwise 0. In classic mode instead of 0
  22 it shows the total number of messages.
  23 It also has mail
  24 retrieval capabilies, and can be configured to do this automatically. At the
  25 moment, UNIX-style, maildir, POP3, APOP and IMAP4 mailboxes are supported.
  26
  27 The mailboxes are displayed in 5 different lines, each one with its own
  28 description of up to five chars. If no mail is present in a given mailbox,
  29 WMbiff will display the total number of mails in cyan. If there's new mail
  30 in the box, the number of new messages will be displayed in yellow. When new
  31 mail arrives, this number will optionally flash for a small period of time,
  32 and also optionally, a command can be executed on mail arrival (for example,
  33 opening your mail reader or playing a sound file).
  34
  35 Pressing mouse button 1 will execute a command, defined in the user's config
  36 file. Mouse button 3 will execute a command to fetch mail, if defined.
  37 To restart wmbiff, press mouse button 1 while holding control and shift keys,
  38 or send it SIGUSR1.
  39
  40 .PP
  41
  42 .SH OPTIONS
  43 .TP
  44 .B \-h
  45 Show summary of options.
  46 .TP
  47 .B \-v
  48 Show version of program.
  49 .TP
  50 .B \-display <display name>
  51 Use an alternate X Display.
  52 .TP
  53 .B \-geometry <geometry>
  54 Initial window position.
  55 .TP
  56 .B \-c <filename>
  57 Use specified configuration file instead of ~/.wmbiffrc.
  58 .TP
  59 .B \-debug
  60 Print verbose log of progress.
  61 .TP
  62 .B \-fg <color>
  63 Use specified X11 color for foreground. Implies -font default,
  64 unless overridden.
  65 .TP
  66 .B \-bg <color>
  67 Use specified X11 color for background. Implies -font default,
  68 unless overridden.
  69 .TP
  70 .B \-hi <color>
  71 Use specified X11 color for new mail counters. Implies -font
  72 default, unless overridden.
  73 .TP
  74 .B \-font <font>
  75 Use specified X11 font instead of the LED pixmap.  This may
  76 be more readable or suitable for some non-US characters.
  77 The special font "default" tells wmbiff to use a compile
  78 time default.
  79 .TP
  80 .B \-skip-certificate-check
  81 When using TLS (IMAPS), keep going, even if the server's
  82 certificate is invalid.  Invalid certificates have expired,
  83 have a different hostname than you connected to, are
  84 corrupt, or have been revoked.  Do not use this option
  85 unless wmbiff fails and suggests it to you, and even then,
  86 be careful and consider alerting your mail system
  87 administrator first.  The need to use this option is a sign
  88 of server misconfiguration.
  89 .TP
  90 .B \-o
  91 Enable classical mode look and behaviour: shows the number of
  92 new mail messages, if any, or the total number of messages.
  93 This option also enables the special keyword "beep" (disabled
  94 by default).
  95 .TP
  96 .B \+w
  97 Do not use the "withdrawn" state: the wmbiff window will not
  98 be captured as an icon and placed in the dock, but will
  99 instead have its own window.  This option starts with a '+'
 100 for consistency with other software programs: many use '-w'
 101 to mean the opposite.
 102
 103 .SH BUGS
 104 Send bug reports or suggestions to the WMBiff Development
 105 Mailing List <wmbiff-devel@lists.sourceforge.net>.   Consider
 106 attaching a transcript of your session, generated using:
 107 .RS
 108 wmbiff -debug | tee wmbiff-log
 109 .RE
 110 Be sure to remove any instances of your password.
 111
 112 .SH FILES
 113 .TP
 114 .I ~/.wmbiffrc
 115 peruser wmbiff configuration file.
 116
 117 .SH AUTHOR
 118 This manual page was written by Jordi Mallach <jordi@sindominio.net>,
 119 originally for the Debian system (but may be used by others).
 120 .br
 121 WMBiff was first maintained by Gennady Belyakov. Since January 2001 it is
 122 maintained group of people that have added lots of new features to the
 123 original program. Please see the README document for a list of all the people
 124 involved.
 125
 126 .SH SEE ALSO
 127 .PD 0
 128 .TP
 129 \fBwmbiffrc\fP(5)
 130 .PP
 131 \fI/usr/share/doc/wmbiff/examples/sample.wmbiffrc\fP
 132 (or equivalent for your system)