wmail/README

   1 Name            : wmail
   2 Description     : a enhanced Window Maker email flagging docklet
   3 Current version : 2.3
   4 Licence         : see file COPYING for licencing details
   5 Web/Home        : https://www.dockapps.net/wmail
   6 Contact         : Window Maker Developers <wmaker-dev@googlegroups.com>
   7
   8 Description:
   9
  10  This is wmail - a nifty Window Maker docklet watching your inbox, which is
  11  either a ordinary mbox or a directory conforming to qmail's Maildir format.
  12  It provides a nice little GUI displaying some useful pieces of information
  13  about your inbox (as many other nice wm-apps doing nearly the same thing...).
  14  Per default it uses the $MAIL environment-variable to locate the inbox you
  15  are using, other mailing mechanisms like POP or IMAP are not supported - use
  16  a tool like fetchmail to retrieve POP- or IMAP-based mail.
  17
  18  It displays the following:
  19
  20  - a mail-icon in the upper-left if your inbox contains some mails
  21  - a frequently flashing "M@iL" in the upper-right if there are unread mails
  22  - a ticker displaying either complete mail-address, its name-part or the
  23    full sender's name (without the "-n" option each sender found in the inbox
  24    is tickered, else only the unread ones)
  25  - the number of new and read emails found (or the number of unread messages
  26    if invoked with the "-n" option)
  27
  28  In addition, the lower-right button allowes you to quickly launch your
  29  preferred email user agent (xterm -e mail, mutt, pine, etc.)
  30
  31  wmail is highly customizable, both command-line and configuration-file support
  32  is provided. The following list describes all customizable items,
  33  their associated cmd-line options, config-file statements and default values:
  34
  35  item             : X11 display
  36  cmd-line option  : -display <string>
  37  rc-file statement: Window.Display = "<string>"
  38  default value    : <unset>
  39
  40  item             : toggle nonshaped mode
  41  cmd-line option  : -ns
  42  rc-file statement: Window.NonShaped = Yes|No
  43  default value    : No
  44
  45  item             : button command to execute
  46  cmd-line option  : -c <string>
  47  rc-file statement: Window.Button.Command = "<string>"
  48  default value    : "xterm -e mail"
  49
  50  item             : your mailbox (file => mbox, directory => Maildir)
  51  cmd-line option  : -mb <string>
  52  rc-file statement: Mail.MailBox = "<string>"
  53  default value    : <unset, $MAIL is used>
  54
  55  item             : file to store the checksums used to identify mbox mails
  56  cmd-line option  : <no option>
  57  rc-file statement: Mail.ChecksumFile = "<string>"
  58  default value    : "~/.wmail-cksums"
  59
  60  item             : ticker (and count) only unread mails
  61  cmd-line option  : -n
  62  rc-file statement: Mail.ShowOnlyNew = Yes|No
  63  default value    : No
  64
  65  item             : mail check interval (sec)
  66  cmd-line option  : -i <num>
  67  rc-file statement: Mail.CheckInterval = <num>
  68  default value    : 1
  69
  70  item             : consider status-field (not used when in maildir mode)
  71  cmd-line option  : -sf
  72  rc-file statement: Mail.UseStatusField = Yes|No
  73  default value    : No
  74
  75  item             : custom status field content used for read mails
  76  cmd-line option  : -rs
  77  rc-file statement: Mail.ReadStatus = "<string>"
  78  default value    : "O"
  79
  80  item             : show nick names in the ticker (all before the @)
  81  cmd-line option  : -s
  82  rc-file statement: Ticker.Mode = NickName
  83  default value    : Address
  84
  85  item             : show family names in the ticker (if available)
  86  cmd-line option  : -f
  87  rc-file statement: Ticker.Mode = FamilyName
  88  default value    : Address
  89
  90  item             : how many ticker frames per sec
  91  cmd-line option  : -fps <num>
  92  rc-file statement: Ticker.Frames = <num>
  93  default value    : 30
  94
  95  item             : use a real X11 font when drawing the ticker
  96  cmd-line option  : -fn <string>
  97  rc-file statement: Ticker.X11Font = "<string>"
  98  default value    : <unset, a buildin font is used>
  99
 100  item             : command to execute when new mail has arrived
 101  cmd-line option  : -e <string>
 102  rc-file statement: Mail.OnNew.Command = "<string>"
 103  default value    : <unset>
 104
 105  item             : sender-names to skip (don't ticker and count them)
 106  cmd-line option  : <no option>
 107  rc-file statement: Mail.SkipSender = "<string>"
 108  default value    : <unset>
 109
 110  item             : color for upper symbols (envelope and MAiL)
 111  cmd-line option  : -sc <string>
 112  rc-file statement: Colors.Symbols = "<string>"
 113  default value    : "#20B2AA"
 114
 115  item             : ticker font color
 116  cmd-line option  : -fc <string>
 117  rc-file statement: Colors.Font = "<string>"
 118  default value    : "#D3D3D3"
 119
 120  item             : backlight color (dockapp background)
 121  cmd-line option  : -bc <string>
 122  rc-file statement: Colors.Backlight = "<string>"
 123  default value    : "#282828"
 124
 125  item             : color of inactive symbols
 126  cmd-line option  : -oc <string>
 127  rc-file statement: Colors.OffLight = "<string>"
 128  default value    : "#282828"
 129
 130  item             : outer frame color (used in nonshaped window mode)
 131  cmd-line option  : -bg <color>
 132  rc-file statement: Colors.NonShapedFrame = "<string>"
 133  default value    : <unset, this color is translucent>
 134
 135  item             : rc-file location
 136  cmd-line option  : -rc <path>
 137  rc-file statement: <none>
 138  default value    : "~/.wmailrc"
 139
 140  libdockapp provides the following additional cmd-line options:
 141
 142  windowed-mode        : -w
 143
 144  show help and exit   : -h
 145
 146  show version and exit: -v
 147
 148 Known bugs:
 149
 150  - Solaris: sometimes wmail gets terminated by Xlib displaying the message:
 151    XIO:  fatal IO error 0 (Error 0) on X server ":0.0"
 152          after XXX requests (YYY known processed) with 0 events remaining.
 153    I do not have any ideas on how to fix this ... :-( --> PLEASE HELP!!!
 154  - "From" header field folding (see RFC822) is not supported
 155  - Reconfiguration during run-time results in a complete state-lost -> all
 156    email in your mbox is assumed to be unread again
 157
 158  Please keep in mind this code is free and comes with absolutly no warranty
 159  (see file COPYING included in the package) - but if you think something goes
 160  wrong, please let me know!
 161
 162 What is still missing (and when it will be done :)
 163
 164  - Pop3/Imap support (never - use fetchmail)
 165  - Character encoding in ticker - at least latin1 (currently in progress)
 166  - Multiple mailslots (never)
 167  - Displaying/tickering of other email header fields (hmm, i don't know...)
 168  - Your needs/ideas...?
 169
 170 Requirements:
 171
 172  This application needs a running X window system and libdockapp v0.2 or newer
 173  (0.4.0 required for windowed-mode), that for itself has some requirements
 174  (Xpm support for example). libdockapp comes with Window Maker - if not sure,
 175  see what the configure-script says when running it.
 176
 177 Compile:
 178
 179  Simply follow these steps:
 180  1. Call "./configure", try "./configure --help" for a list of options.
 181  2. Call "make" to build the binary (or gmake if make isn't GNU make compliant)
 182
 183  If compiling does not succeed due to missed header files or libraries you have
 184  to make use of the environment variables listed by "configure --help" in order
 185  to pass the flags that specify the paths to those files.
 186
 187 Porting:
 188
 189  This code (without using the new Maildir code and autoconf package setup)
 190  is known to work under:
 191  - Linux >=2.4.10 on x86
 192  - Osf 3.2 on Dec/Alpha
 193  - Sun Solaris 4.0 on Sparc Station 4 and 10
 194  - Sun Solaris 6, 7 and 8 (thanx to Kristian Borum!)
 195  - SunOs 5.7 on Ultra Sparc 5 (thanx to Alessandro!)
 196
 197  ...together with Window Maker v0.60.0 or better (or standalone of course) and
 198  libdockapp v0.4.0.
 199
 200  Please let me know if you have ported this to a platform not listed
 201  above to mention it (and your name of cource ;). Some users had
 202  trouble porting wmail to Solaris because the original timer signal handling
 203  has not worked properly. This was caused by different semantics of libc's
 204  signal function and should got fixed since releases >= v1.3.
 205
 206 Install:
 207
 208  Call "make install" or copy the binary found in the src subdirectory by hand.
 209
 210  Keep in mind, libdockapp must be installed properly (i.e. let reside it in
 211  your X11 base library directory or let $LD_LIBRARY_PATH point to the lib).
 212  If you would like to use rc-based configuration, look into the provided
 213  sample-file "wmailrc-sample" and use it as a base for your particular needs
 214  by copying it to ~/.wmailrc.
 215
 216 Run:
 217
 218  Try wmail -h to see a list of all available options.
 219
 220 Final words:
 221
 222  Thanx to Thomas Kurschel for his suggestions and coding assistance.
 223  Thanx to Juergen A. Erhard for his codings and Debian packaging efforts.
 224  Thanx to many users on the web for their ideas, test- and bug reports.
 225
 226  And many great thanx to all the GNUstep and Window Maker people who've
 227  provided us with such a great user environment!
 228
 229  Hope you will ENJOY!