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