wmckgmail/INSTALL

   1 wmckgmail 1.1 : A dockapp to monitor the number of unread mails in a gmail inbox
   2 written by    : Sylvain Tremblay <stremblay@gmail.com>
   3 release date  : September 09, 2006
   4
   5 *******************
   6 *** COMPILATION ***
   7 *******************
   8
   9 To compile, simply invoke the "make" command.
  10
  11 ********************
  12 *** INSTALLATION ***
  13 ********************
  14
  15 To install the program (in /usr/local/bin), run : "make install"
  16 To install the man pages (in /usr/local/man/man1), run : "make install-man"
  17
  18 *********************
  19 *** CONFIGURATION ***
  20 *********************
  21
  22 The wmckgmail program is independent for each user. To be able to use it, you
  23 need to create a folder in the user home directory ($HOME/.wmckgmail).
  24
  25 In this folder, you need to create the configuration file ($HOME/.wmckgmail/config).
  26
  27 This configuration file works in "<key> <value>" pairs. There is two mandatory
  28 entries that needs to be defined :
  29
  30   uname <gmail username>
  31   pass <gmail user password>
  32
  33 There is also an optional parameter used to define the interval (in seconds)
  34 between each new emails verification. If you don't define this value, a default
  35 of 300 seconds (5 minutes) will be used.
  36
  37   pollinterval <number of seconds between each verification>
  38
  39 --- WARNING ---
  40
  41 It is strongly recommended to set the permissions on the configuration file to
  42 something like "600" or "400" as your gmail account password is clearly written
  43 into it.