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