aboutsummaryrefslogtreecommitdiffstats
path: root/contrib/README.getmail
blob: 237889cd86d5ffda44646eaa36e5dbbc34464ac1 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
-------------------------------------------------------------------------------

                         - GetMail - GotMail -

             1999 by Thomas Nesges <ThomaNesges@TNT-Computer.de>

-------------------------------------------------------------------------------

-------------------------------------------------------------------------------
Installation:
-------------------------------------------------------------------------------
The Installation is as simple as it could be.  Just create the directory
/usr/local/gotmail and copy all files to it. Ready.

If you decide to choose an other directory to copy the files to, don't forget
to change the path in the scripts.

-------------------------------------------------------------------------------
Usage:
-------------------------------------------------------------------------------
GetMail starts with: getmail <option>

options:
 clear  - stops fetchmail and kills the logfile
 fetch  - starts fetchmail
 got    - starts gotmail
 goth   - starts gotmail html
 send   - sends all mail from the mailqueue
 status - tails the logfile
 start  - starts fetchmail and tails the logfile
 stop   - stops fetchmail
 -v     - prints GetMails version number

GotMail can be startet without any parameters. It then prints a statistic
on the console. The only parameters so far are:

 html   - prints the output to an html file specified in gotmail.conf
 -v     - prints GotMails version number

-------------------------------------------------------------------------------
Configuration
-------------------------------------------------------------------------------
GotMail is configured by a file named gotmail.conf either in the user's home
dir, in /etc or in /usr/local/gotmail. gotmail.conf itself is a shell script.
It just exports some variables to the environment. So it's syntax is like this:

 export <OPTION>=<VALUE>

Remember not to put spaces between <OPTION>=<VALUE> !!
You have the folllowing options:
 
  GOTM_ERR	yes|no		print error messages?
  GOTM_MSG	yes|no		print mail stats?
  GOTM_TIM	yes|no		print start/stop stats?
  GOTM_HED	yes|no		print a header?

 Special HTML options:
  GOTM_BGCOL	hex color	backgroundcolor
  GOTM_TXCOL	hex color	textcolor
  GOTM_ERRCOL	hex color	color of error messages
  GOTM_TIMCOL	hex color	color of start/stop stats
  GOTM_MSGCOL	hex color	color of mail stats
  GOTM_HTMLFILE	filename	filename for html output
-------------------------------------------------------------------------------
erted */ .highlight .go { color: #888888 } /* Generic.Output */ .highlight .gp { color: #555555 } /* Generic.Prompt */ .highlight .gs { font-weight: bold } /* Generic.Strong */ .highlight .gu { color: #666666 } /* Generic.Subheading */ .highlight .gt { color: #aa0000 } /* Generic.Traceback */ .highlight .kc { color: #008800; font-weight: bold } /* Keyword.Constant */ .highlight .kd { color: #008800; font-weight: bold } /* Keyword.Declaration */ .highlight .kn { color: #008800; font-weight: bold } /* Keyword.Namespace */ .highlight .kp { color: #008800 } /* Keyword.Pseudo */ .highlight .kr { color: #008800; font-weight: bold } /* Keyword.Reserved */ .highlight .kt { color: #888888; font-weight: bold } /* Keyword.Type */ .highlight .m { color: #0000DD; font-weight: bold } /* Literal.Number */ .highlight .s { color: #dd2200; background-color: #fff0f0 } /* Literal.String */ .highlight .na { color: #336699 } /* Name.Attribute */ .highlight .nb { color: #003388 } /* Name.Builtin */ .highlight .nc { color: #bb0066; font-weight: bold } /* Name.Class */ .highlight .no { color: #003366; font-weight: bold } /* Name.Constant */ .highlight .nd { color: #555555 } /* Name.Decorator */ .highlight .ne { color: #bb0066; font-weight: bold } /* Name.Exception */ .highlight .nf { color: #0066bb; font-weight: bold } /* Name.Function */ .highlight .nl { color: #336699; font-style: italic } /* Name.Label */ .highlight .nn { color: #bb0066; font-weight: bold } /* Name.Namespace */ .highlight .py { color: #336699; font-weight: bold } /* Name.Property */ .highlight .nt { color: #bb0066; font-weight: bold } /* Name.Tag */ .highlight .nv { color: #336699 } /* Name.Variable */ .highlight .ow { color: #008800 } /* Operator.Word */ .highlight .w { color: #bbbbbb } /* Text.Whitespace */ .highlight .mb { color: #0000DD; font-weight: bold } /* Literal.Number.Bin */ .highlight .mf { color: #0000DD; font-weight: bold } /* Literal.Number.Float */ .highlight .mh { color: #0000DD; font-weight: bold } /* Literal.Number.Hex */ .highlight .mi { color: #0000DD; font-weight: bold } /* Literal.Number.Integer */ .highlight .mo { color: #0000DD; font-weight: bold } /* Literal.Number.Oct */ .highlight .sa { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Affix */ .highlight .sb { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Backtick */ .highlight .sc { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Char */ .highlight .dl { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Delimiter */ .highlight .sd { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Doc */ .highlight .s2 { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Double */ .highlight .se { color: #0044dd; background-color: #fff0f0 } /* Literal.String.Escape */ .highlight .sh { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Heredoc */ .highlight .si { color: #3333bb; background-color: #fff0f0 } /* Literal.String.Interpol */ .highlight .sx { color: #22bb22; background-color: #f0fff0 } /* Literal.String.Other */ .highlight .sr { color: #008800; background-color: #fff0ff } /* Literal.String.Regex */ .highlight .s1 { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Single */ .highlight .ss { color: #aa6600; background-color: #fff0f0 } /* Literal.String.Symbol */ .highlight .bp { color: #003388 } /* Name.Builtin.Pseudo */ .highlight .fm { color: #0066bb; font-weight: bold } /* Name.Function.Magic */ .highlight .vc { color: #336699 } /* Name.Variable.Class */ .highlight .vg { color: #dd7700 } /* Name.Variable.Global */ .highlight .vi { color: #3333bb } /* Name.Variable.Instance */ .highlight .vm { color: #336699 } /* Name.Variable.Magic */ .highlight .il { color: #0000DD; font-weight: bold } /* Literal.Number.Integer.Long */
Note that this file is kept for historic reference.
It will no longer be updated or maintained.

-- Matthias Andree, 2010-02-06

SVN release - fetchmail release    - release manager
====================================================
              SORT_BY (release)
r5480       - 6.3.14   (2010-02-05) - MA
r5450       - 6.3.13   (2009-10-30) - MA
r5439       - 6.3.12   (2009-10-05) - MA
r5398       - 6.3.11   (2009-08-06) - MA
r5373       - 6.3.10   (2009-07-02) - MA
r5248       - 6.3.9    (2008-11-16) - MA
r5093       - 6.3.8    (2007-04-06) - MA
r5037       - 6.3.7    (2007-02-18) - MA
r5010       - 6.3.6    (2007-01-05) - MA
r4921       - 6.3.5    (2006-10-09) - MA
r4802       - 6.3.4    (2006-04-14) - MA
r4760       - 6.3.3    (2006-03-31) - MA
r4678       - 6.3.2    (2006-01-22) - MA
r4579       - 6.3.1    (2005-12-19) - MA
r4573       - 6.2.5.5  (2005-12-19) - MA
r4499       - 6.3.0    (2005-11-30) - MA
r4439       - 6.2.5.4  (2005-11-13) - MA
r4430       - 6.2.5.3  (2005-11-13) - MA
(tarball)   - 6.2.5.2  (2005-07-22) - MA
(tarball)   - 6.2.5.1  (2005-07-20) - MA
-- maintainer change --
r3860       - 6.2.5    (2003-10-15) - ESR
r3835       - 6.2.4    (2003-08-13) - ESR
r3826       - 6.2.3    (2003-07-17) - ESR
r3806       - 6.2.2    (2003-03-01) - ESR
r3783       - 6.2.1    (2003-01-14) - ESR
r3776       - 6.2.0    (2002-12-13) - ESR
r3773       - 6.1.3    (2002-11-28) - ESR
r3765       - 6.1.2    (2002-10-31) - ESR
r3755       - 6.1.1    (2002-10-18) - ESR
r3731       - 6.1.0    (2002-09-23) - ESR
r3726       - 6.0.0    (2002-09-18) - ESR
r3703       - 5.9.14   (2002-09-06) - ESR
r3655       - 5.9.13   (2002-06-23) - ESR
r3632       - 5.9.12   (2002-06-04) - ESR
r3608       - 5.9.11   (2002-04-02) - ESR
r3598       - 5.9.10   (2002-03-10) - ESR
r3593       - 5.9.9    (2002-03-09) - ESR
r3581       - 5.9.8    (2002-02-15) - ESR
r3576       - 5.9.7    (2002-02-02) - ESR
r3564       - 5.9.6    (2001-12-14) - ESR
r3548       - 5.9.5    (2001-11-08) - ESR
r3534       - 5.9.4    (2001-10-03) - ESR
r3514       - 5.9.3    (2001-09-30) - ESR
r3493       - 5.9.2    (2001-09-26) - ESR
r3481       - 5.9.1    (2001-09-25) - ESR
r3453       - 5.9.0    (2001-08-13) - ESR
r3447       - 5.8.17   (2001-08-08) - ESR
r3438       - 5.8.16   (2001-08-04) - ESR
r3429       - 5.8.15   (2001-07-31) - ESR
r3413       - 5.8.13   (2001-07-11) - ESR
r3403       - 5.8.12   (2001-07-06) - ESR
r3389       - 5.8.11   (2001-07-02) - ESR
r3385       - 5.8.10   (2001-06-25) - ESR
r3380       - 5.8.9    (2001-06-25) - ESR
r3364       - 5.8.8    (2001-06-20) - ESR
r3355       - 5.8.7    (2001-06-17) - ESR
r3338       - 5.8.6    (2001-06-12) - ESR
r3332       - 5.8.5    (2001-05-30) - ESR
r3322       - 5.8.4    (2001-05-21) - ESR
r3312       - 5.8.3    (2001-05-12) - ESR
r3298       - 5.8.2    (2001-04-26) - ESR
r3291       - 5.8.1    (2001-04-10) - ESR
r3284       - 5.8.0    (2001-04-02) - ESR
r3280       - 5.7.7    (2001-03-29) - ESR
r3272       - 5.7.6    (2001-03-22) - ESR
r3266       - 5.7.5    (2001-03-18) - ESR
r3243       - 5.7.4    (2001-03-12) - ESR
r3236       - 5.7.3    (2001-03-11) - ESR
r3201       - 5.7.2    (2001-03-05) - ESR
r3187       - 5.7.1    (2001-03-04) - ESR
r3174       - 5.7.0    (2001-03-02) - ESR
r3134       - 5.6.8    (2001-02-22) - ESR
r3119       - 5.6.7    (2001-02-19) - ESR
r3112       - 5.6.6    (2001-02-16) - ESR
r3086       - 5.6.5    (2001-02-12) - ESR
r3047       - 5.6.4    (2001-02-11) - ESR
r3036       - 5.6.3    (2001-02-07) - ESR
r3019       - 5.6.2    (2001-01-05) - ESR
r2999       - 5.6.1    (2000-12-12) - ESR
r2990       - 5.6.0    (2000-11-27) - ESR
r2983       - 5.5.6    (2000-11-11) - ESR
r2979       - 5.5.5    (2000-10-17) - ESR
r2976       - 5.5.4    (2000-10-08) - ESR
r2971       - 5.5.3    (2000-09-26) - ESR
r2963       - 5.5.2    (2000-09-08) - ESR
r2953       - 5.5.1    (2000-08-21) - ESR
r2950       - 5.5.0    (2000-08-12) - ESR
r2945       - 5.4.5    (2000-08-07) - ESR
r2935       - 5.4.4    (2000-07-23) - ESR
r2924       - 5.4.3    (2000-07-02) - ESR
r2903       - 5.4.1    (2000-06-07) - ESR
r2897       - 5.4.0    (2000-05-14) - ESR
r2885       - 5.3.8    (2000-04-21) - ESR
r2877       - 5.3.7    (2000-04-16) - ESR
r2870       - 5.3.6    (2000-04-08) - ESR
r2849       - 5.3.5    (2000-03-30) - ESR
r2835       - 5.3.4    (2000-03-22) - ESR
r2821       - 5.3.3    (2000-03-13) - ESR
r2807       - 5.3.2    (2000-03-07) - ESR
r2788       - 5.3.1    (2000-03-06) - ESR
r2768       - 5.3.0    (2000-02-22) - ESR
r2749       - 5.2.8    (2000-02-15) - ESR
r2734       - 5.2.7    (2000-02-07) - ESR
r2731       - 5.2.6    (2000-02-05) - ESR
r2724       - 5.2.5    (2000-01-31) - ESR
r2718       - 5.2.4    (2000-01-17) - ESR
r2702       - 5.2.3    (2000-01-04) - ESR
r2965       - 5.2.2    (2000-09-08) - ESR
r2669       - 5.2.1    (1999-12-20) - ESR
r2659       - 5.2.0    (1999-12-19) - ESR
r2654       - 5.1.4    (1999-11-07) - ESR
r2646       - 5.1.3    (1999-10-31) - ESR
r2636       - 5.1.2    (1999-10-07) - ESR
r2623       - 5.1.1    (1999-09-29) - ESR
r2573       - 5.1.0    (1999-09-22) - ESR
r2561       - 5.0.8    (1999-09-14) - ESR
r2547       - 5.0.7    (1999-08-21) - ESR
r2536       - 5.0.6    (1999-08-02) - ESR
r2513       - 5.0.5    (1999-06-26) - ESR
r2495       - 5.0.4    (1999-06-12) - ESR
r2466       - 5.0.3    (1999-05-03) - ESR
r2461       - 5.0.2    (1999-04-30) - ESR
r2441       - 5.0.1    (1999-04-18) - ESR
r2428       - 5.0.0    (1999-04-05) - ESR
r2405       - 4.7.9    (1999-03-09) - ESR
r2391       - 4.7.8    (1999-02-22) - ESR
r2371       - 4.7.7    (1999-02-03) - ESR
r2361       - 4.7.6    (1999-01-31) - ESR
r2343       - 4.7.5    (1999-01-09) - ESR
r2321       - 4.7.4    (1999-01-04) - ESR
r2305       - 4.7.3    (1998-12-31) - ESR
r2289       - 4.7.2    (1998-12-25) - ESR
r2283       - 4.7.1    (1998-12-18) - ESR
r2274       - 4.7.0    (1998-12-14) - ESR
r2252       - 4.6.9    (1998-12-01) - ESR
r2226       - 4.6.8    (1998-11-29) - ESR
r2202       - 4.6.7    (1998-11-21) - ESR
r2180       - 4.6.6    (1998-11-07) - ESR
r2146       - 4.6.5    (1998-10-29) - ESR
r2139       - 4.6.4    (1998-10-27) - ESR
r2130       - 4.6.3    (1998-10-20) - ESR
r2097       - 4.6.2    (1998-10-16) - ESR
r2088       - 4.6.1    (1998-10-15) - ESR
r2074       - 4.6.0    (1998-09-18) - ESR
r2070       - 4.5.8    (1998-09-08) - ESR
r2062       - 4.5.7    (1998-08-27) - ESR
r2055       - 4.5.6    (1998-08-25) - ESR
r2037       - 4.5.5    (1998-08-03) - ESR
r2022       - 4.5.4    (1998-07-25) - ESR
r2002       - 4.5.3    (1998-07-20) - ESR
r1972       - 4.5.2    (1998-07-15) - ESR
r1962       - 4.5.1    (1998-07-02) - ESR
r1942       - 4.5.0bis (1998-06-20) - ESR
r1939       - 4.5.0    (1998-06-16) - ESR
r1895       - 4.4.9    (1998-06-04) - ESR
r1863       - 4.4.8    (1998-05-26) - ESR
r1804       - 4.4.7    (1998-05-23) - ESR
r1788       - 4.4.6bis (1998-05-16) - ESR
r1784       - 4.4.6    (1998-05-16) - ESR
r1777       - 4.4.5bis (1998-05-15) - ESR
r1775       - 4.4.5    (1998-05-14) - ESR
r1760       - 4.4.4    (1998-05-06) - ESR
r1753       - 4.4.3    (1998-04-20) - ESR
r1744       - 4.4.2    (1998-04-19) - ESR
r1725       - 4.4.1    (1998-03-24) - ESR
r1708       - 4.4.0    (1998-03-17) - ESR
r1691       - 4.3.9    (1998-03-06) - ESR
r1675       - 4.3.8bis (1998-02-25) - ESR
r1673       - 4.3.8    (1998-02-25) - ESR
r1647       - 4.3.7    (1998-02-18) - ESR
r1607       - 4.3.6    (1998-01-23) - ESR
r1573       - 4.3.5    (1997-12-15) - ESR
r1565       - 4.3.4    (1997-12-05) - ESR
r1538       - 4.3.3    (1997-11-22) - ESR
r1527       - 4.3.2    (1997-10-23) - ESR
r1514       - 4.3.1    (1997-10-14) - ESR
r1487       - 4.3.0    (1997-10-06) - ESR
r1452       - 4.2.9    (1997-10-01) - ESR
r1432       - 4.2.8    (1997-09-28) - ESR
r1421       - 4.2.7    (1997-09-26) - ESR
r1405       - 4.2.6    (1997-09-24) - ESR
r1390       - 4.2.5    (1997-09-23) - ESR
r1378       - 4.2.4    (1997-09-20) - ESR
r1372       - 4.2.3    (1997-09-18) - ESR
r1366       - 4.2.2    (1997-09-18) - ESR
r1352       - 4.2.1    (1997-09-16) - ESR
r1342       - 4.2.0    (1997-09-14) - ESR
r1334       - 4.1.8    (1997-09-11) - ESR
r1324       - 4.1.7    (1997-09-09) - ESR
r1319       - 4.1.6    (1997-09-07) - ESR
r1311       - 4.1.5    (1997-09-05) - ESR
r1293       - 4.1.2    (1997-09-04) - ESR
r1274       - 4.1.1    (1997-08-16) - ESR
r1264       - 4.1.0    (1997-08-11) - ESR
r1247       - 4.0.8    (1997-08-07) - ESR
r1216       - 4.0.6    (1997-08-01) - ESR
r1204       - 4.0.5    (1997-07-30) - ESR
r1198       - 4.0.4    (1997-07-29) - ESR
r1184       - 4.0.3    (1997-07-28) - ESR
r1171       - 4.0.1    (1997-07-16) - ESR
r1165       - 4.0.0bis (1997-07-09) - ESR
r1163       - 4.0.0    (1997-07-09) - ESR
r1119       - 3.9.9    (1997-06-25) - ESR
r1099       - 3.9.8    (1997-06-14) - ESR
r1076       - 3.9.7    (1997-06-10) - ESR
r1048       - 3.9.6    (1997-05-29) - ESR
r1024       - 3.9.5    (1997-05-18) - ESR
r1003       - 3.9.4    (1997-05-14) - ESR
r983        - 3.9.3    (1997-05-07) - ESR
r974        - 3.9.2    (1997-04-23) - ESR
r968        - 3.9.1    (1997-04-17) - ESR
r947        - 3.9.0    (1997-04-03) - ESR
r924        - 3.8.0    (1997-03-07) - ESR
r916        - 3.7.0    (1997-02-21) - ESR
r895        - 3.6.0    (1997-02-17) - ESR
r887        - 3.5.0    (1997-02-16) - ESR
r873        - 3.4.0    (1997-02-13) - ESR
r855        - 3.3.1    (1997-02-02) - ESR
r853        - 3.3.0    (1997-02-02) - ESR
r800        - 3.0.0    (1997-01-22) - ESR
r762        - 2.8tris  (1997-01-14) - ESR
r760        - 2.8bis   (1997-01-14) - ESR
r745        - 2.8.0    (1997-01-11) - ESR
r726        - 2.7.0    (1997-01-09) - ESR
r702        - 2.6.0    (1996-12-27) - ESR
r678        - 2.5.0    (1996-12-23) - ESR
r670        - 2.4.0bis (1996-12-21) - ESR
r667        - 2.4.0    (1996-12-21) - ESR
r2434       - 2.3.2    (1999-04-17) - ESR
r659        - 2.3.0    (1996-12-18) - ESR
r618        - 2.2.0    (1996-12-09) - ESR
r607        - 2.1.3    (1996-12-06) - ESR
r602        - 2.1.2    (1996-12-05) - ESR
r588        - 2.1.1    (1996-11-30) - ESR
r585        - 2.1.0    (1996-11-29) - ESR
r553        - 2.0.0    (1996-11-18) - ESR
r362        - 1.9a     (1996-10-21) - ESR
r533        - 1.9.9    (1996-11-11) - ESR
r498        - 1.9.8    (1996-11-06) - ESR
r462        - 1.9.7    (1996-11-01) - ESR
r442        - 1.9.6    (1996-10-31) - ESR
r432        - 1.9.5    (1996-10-30) - ESR
r416        - 1.9.4    (1996-10-29) - ESR
r410        - 1.9.3    (1996-10-28) - ESR
r399        - 1.9.2    (1996-10-27) - ESR
r393        - 1.9.0    (1996-10-26) - ESR
r317        - 1.8.0    (1996-10-11) - ESR
r241        - 1.6.0bis (1996-10-07) - ESR
r238        - 1.6.0    (1996-10-07) - ESR
r209        - 1.5.0    (1996-10-03) - ESR
r203        - 1.4.0    (1996-10-02) - ESR
r179        - 1.2.0    (1996-09-28) - ESR
r176        - 1.1.0bis (1996-09-28) - ESR
r174        - 1.1.0    (1996-09-28) - ESR
r163        - 1.0.0    (1996-09-26) - ESR


Release managers
================
ESR = Eric S[teven] Raymond
MA  = Matthias Andree