wmymail/README

   1
   2     readme for wmymail - mail checker dock application
   3
   4 wmymail is a dock application that shows how many messages are in your
   5 mailbox, and how many of them are unread.  When there are new messages,
   6 it displays one or more brightly colored envelopes.  Otherwise, it
   7 displays a dull, gray envelope.
   8
   9
  10 BEHAVIOR
  11 ========
  12
  13 mbox (local mail file) (default)
  14 --------------------------------
  15
  16 By default, it will check your mailbox file about once per second to
  17 see if it has changed. If it has changed, wmymail reads it to see how
  18 many messages are inside, and how many have been read, and displays
  19 the current counts.
  20
  21   * It looks at the filename specified in the $MAIL environment
  22     variable.
  23
  24   * You can tell it to look in a different file by using the -m
  25     option, e.g.  "wmymail -m /var/foo/mail/username"
  26
  27   * You can make it check less frequently with the -i option, which
  28     changes the interval between mailbox checks:
  29     "wmymail -i 60" will make it check once per minute.
  30
  31 IMAP
  32 ----
  33
  34 If you are using IMAP for your email, you will need to use the -F
  35 option. This option makes wmymail run fetchmail to determine how
  36 many messages you have.
  37
  38 Since running fetchmail takes considerably longer than checking
  39 a local file, wmymail checks once per minute when -F is used.
  40 Furthermore, the -i option now specifies the number of minutes:
  41 "wmymail -F -i 5" would make it check every five minutes.
  42
  43 The command that wmymail runs is: "fetchmail -c"
  44 Therefore, you will need to have fetchmail set up and working prior
  45 to using wmymail.
  46
  47
  48 HISTORY
  49 =======
  50
  51 The current maintainer is Joshua Swink, <yathster@yahoo.com>.
  52
  53 This program forked from version 1.1 of wmail, a similar dock app with
  54 different goals.
  55
  56 wmail may be found here:
  57   http://dockapps.org/file.php/id/70
  58
  59 And here is its old homepage (no longer exists):
  60   http://www.informatik.uni-jena.de/~topical/sveng/wmail.html
  61
  62
  63 INSTALLATION
  64 ============
  65
  66 You will need libdockapp, which can probably be found here:
  67
  68   ftp://shadowmere.student.utwente.nl/pub/WindowMaker/
  69
  70 Then, run "make", and "strip wmymail" if desired, and finally
  71 copy wmymail to a directory in your path.
  72
  73 Making it show up on your dock or wharf or pier varies greatly
  74 according to your window manager, and won't be explained here.
  75