Pileus Git - ~andy/fetchmail/blob - contrib/README.getmail

   1 -------------------------------------------------------------------------------
   2
   3                          - GetMail - GotMail -
   4
   5              1999 by Thomas Nesges <ThomaNesges@TNT-Computer.de>
   6
   7 -------------------------------------------------------------------------------
   8
   9 -------------------------------------------------------------------------------
  10 Installation:
  11 -------------------------------------------------------------------------------
  12 The Installation is as simple as it could be.  Just create the directory
  13 /usr/local/gotmail and copy all files to it. Ready.
  14
  15 If you decide to choose an other directory to copy the files to, don't forget
  16 to change the path in the scripts.
  17
  18 -------------------------------------------------------------------------------
  19 Usage:
  20 -------------------------------------------------------------------------------
  21 GetMail starts with: getmail <option>
  22
  23 options:
  24  clear  - stops fetchmail and kills the logfile
  25  fetch  - starts fetchmail
  26  got    - starts gotmail
  27  goth   - starts gotmail html
  28  send   - sends all mail from the mailqueue
  29  status - tails the logfile
  30  start  - starts fetchmail and tails the logfile
  31  stop   - stops fetchmail
  32  -v     - prints GetMails version number
  33
  34 GotMail can be startet without any parameters. It then prints a statistic
  35 on the console. The only parameters so far are:
  36
  37  html   - prints the output to an html file specified in gotmail.conf
  38  -v     - prints GotMails version number
  39
  40 -------------------------------------------------------------------------------
  41 Configuration
  42 -------------------------------------------------------------------------------
  43 GotMail is configured by a file named gotmail.conf either in the user's home
  44 dir, in /etc or in /usr/local/gotmail. gotmail.conf itself is a shell script.
  45 It just exports some variables to the environment. So it's syntax is like this:
  46
  47  export <OPTION>=<VALUE>
  48
  49 Remember not to put spaces between <OPTION>=<VALUE> !!
  50 You have the folllowing options:
  51
  52   GOTM_ERR      yes|no          print error messages?
  53   GOTM_MSG      yes|no          print mail stats?
  54   GOTM_TIM      yes|no          print start/stop stats?
  55   GOTM_HED      yes|no          print a header?
  56
  57  Special HTML options:
  58   GOTM_BGCOL    hex color       backgroundcolor
  59   GOTM_TXCOL    hex color       textcolor
  60   GOTM_ERRCOL   hex color       color of error messages
  61   GOTM_TIMCOL   hex color       color of start/stop stats
  62   GOTM_MSGCOL   hex color       color of mail stats
  63   GOTM_HTMLFILE filename        filename for html output
  64 -------------------------------------------------------------------------------