wmbiff-0.4.27/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>] [-font <X11 font>|default] [-hi <highlight-color>] [+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 Licq history files and 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.  Implies -font default, unless
  65 overridden.
  66 .TP
  67 .B \-font <font>
  68 Use specified X11 font instead of the LED pixmap.  This may
  69 be more readable or suitable for some non-US characters.
  70 The special font "default" tells wmbiff to use a compile
  71 time default.
  72 .TP
  73 .B \-hi <color>
  74 Use specified X11 color for new mail counters.  Implies -font
  75 default, unless overridden.
  76 .TP
  77 .B \-skip-certificate-check
  78 When using TLS (IMAPS), keep going, even if the server's
  79 certificate is invalid.  Invalid certificates have expired,
  80 have a different hostname than you connected to, are
  81 corrupt, or have been revoked.  Do not use this option
  82 unless wmbiff fails and suggests it to you, and even then,
  83 be careful and consider alerting your mail system
  84 administrator first.  The need to use this option is a sign
  85 of server misconfiguration.
  86 .TP
  87 .B \+w
  88 Do not use the "withdrawn" state: the wmbiff window will not
  89 be captured as an icon and placed in the dock, but will
  90 instead have its own window.  This option starts with a '+'
  91 for consistency with other software programs: many use '-w'
  92 to mean the opposite.
  93
  94 .SH BUGS
  95 Send bug reports or suggestions to the WMBiff Development
  96 Mailing List <wmbiff-devel@lists.sourceforge.net>.   Consider
  97 attaching a transcript of your session, generated using:
  98 .RS
  99 wmbiff -debug | tee wmbiff-log
 100 .RE
 101 Be sure to remove any instances of your password.
 102
 103 .SH FILES
 104 .TP
 105 .I ~/.wmbiffrc
 106 peruser wmbiff configuration file.
 107
 108 .SH AUTHOR
 109 This manual page was written by Jordi Mallach <jordi@sindominio.net>,
 110 originally for the Debian system (but may be used by others).
 111 .br
 112 WMBiff was first maintained by Gennady Belyakov. Since January 2001 it is
 113 maintained group of people that have added lots of new features to the
 114 original program. Please see the README document for a list of all the people
 115 involved.
 116
 117 .SH SEE ALSO
 118 .PD 0
 119 .TP
 120 \fBwmbiffrc\fP(5)
 121 .PP
 122 \fI/usr/share/doc/wmbiff/examples/sample.wmbiffrc\fP
 123 (or equivalent for your system)