Remove debian/patches
[mspang/vmailman.git] / README
1 Mailman - The GNU Mailing List Management System
2 Copyright (C) 1998-2004 by the Free Software Foundation, Inc.
3 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
4
5 INTRODUCTION
6
7     This is GNU Mailman, a mailing list management system distributed under
8     the terms of the GNU General Public License (GPL).  The name of this
9     software is spelled "Mailman" with a leading capital `M' but with a lower
10     case second `m'.  Any other spelling is incorrect.
11
12     Mailman is written primarily in Python, a free object-oriented scripting
13     language.  There is some ANSI C code for security purposes.
14
15     Mailman was originally developed by John Viega.  Subsequent development
16     (through version 1.0b3) was by Ken Manheimer.  Further work towards the
17     1.0 final release was a group effort, with the core contributors being:
18     Barry Warsaw, Ken Manheimer, Scott Cotton, Harald Meland, and John Viega.
19     Version 1.0 and beyond have been primarily maintained by Barry Warsaw with
20     contributions from many; see the ACKNOWLEDGMENTS file for details.  Jeremy
21     Hylton helped considerably with the Pipermail code in Mailman 2.0.
22
23     The Mailman home page is:
24
25         http://www.list.org
26
27     with mirrors at:
28
29         http://www.gnu.org/software/mailman
30         http://mailman.sf.net
31
32     Mailman 2.1 requires Python 2.1.3 or greater, which can be downloaded from:
33
34         http://www.python.org
35
36     It is recommended that you use Python 2.3.3, the latest release as of this
37     writing (31-Dec-2003).  Update: 15-May-2004, the Python 2.3.4 release is
38     imminent, see:
39
40         http://www.python.org/2.3.4
41
42     Mailman will work with Python 2.2.3 as well, which is the latest release
43     on the Python 2.2 branch.  Mailman 2.1 is not compatible with Python 2.0
44     or any earlier version.
45
46     You will also need an ANSI C compiler to build both Python and Mailman;
47     gcc (the GNU C compiler) works just fine.  Mailman currently works only on
48     GNU/Linux and other Unix-like operating systems (e.g. Solaris, *BSD,
49     MacOSX, etc.).  It does not run on Windows, although web and mail clients
50     on any platform should be able to interact with Mailman just fine.
51
52     See the INSTALL file for installation instructions.  If you are upgrading
53     from a previous version of Mailman, you need to read the UPGRADING file
54     for important information.
55
56
57 FEATURES
58
59     Read the NEWS file for a list of changes since version 0.9.  Read the TODO
60     file for our (extensive) wish list.  You can see Mailman 2.1 in action at:
61
62         http://mail.python.org/mailman-21/listinfo
63
64     Mailman has most of the standard features you'd expect in a mailing list
65     manager, and more:
66
67     - Web based list administration for nearly all tasks.  Web based
68       subscriptions and user configuration management.  A customizable "home
69       page" for each mailing list.
70
71     - Privacy features such as moderation, open and closed list subscription
72       policies, private membership rosters, and sender-based filters.
73
74     - Automatic web based archiving built-in with support for private and
75       public archives, and hooks for external archivers.
76
77     - Per-user configuration optional digest delivery for either
78       MIME-compliant or RFC 1153 style "plain text" digests.
79
80     - Integrated mail/Usenet gateways.
81
82     - Integrated auto-replies.
83
84     - Majordomo-style email based commands.
85
86     - Integrated bounce detection within an extensible framework.
87
88     - Integrated spam detection, and MIME-based content filtering.
89
90     - An extensible mail delivery pipeline.
91
92     - Support for virtual domains.
93
94
95 REQUIREMENTS
96
97     The default mail delivery mechanism uses a direct SMTP connection to
98     whatever mail transport agent you have running on port 25.  You can thus
99     use Mailman with any such MTA, however with certain MTAs (e.g. Exim and
100     Postfix), Mailman will support thru-the-web creation and removal of
101     mailing lists.
102
103     Mailman works with any web server that supports CGI/1.1.  The HTML it
104     generates is quite pedestrian and stingy on the graphics so it should be
105     friendly to most web browsers and network connections.
106
107     You will need root access on the machine hosting your Mailman installation
108     in order to complete some of the configuration steps.  See the INSTALL
109     file for details.
110
111     Mailman's web and email user interface should be compatible with just
112     about any mail reader or web browser, although a mail reader that is MIME
113     aware will be a big help.  You do not need Java, JavaScript, or any other
114     fancy plugins.
115
116
117 FOR MORE INFORMATION
118
119     The online documentation can be found in
120
121         file:admin/www/index.html
122
123     in the directory in which you unpacked Mailman.
124
125     Chris Kolar has made a list owner-oriented manual available from
126     the following URL
127
128         http://www.imsa.edu/~ckolar/mailman/
129
130     There are also several mailing lists that can be used as resources
131     to help you get going with Mailman.
132
133     Mailman-Users
134         An list for users of Mailman, for posting questions or problems
135         related to installation, use, etc.  We'll try to keep the deep
136         technical discussions off this list.
137
138         http://mail.python.org/mailman/listinfo/mailman-users
139
140     Listowners
141         This mailing list with a non-technical focus, specifically for
142         discussions from the perspective of listowners and moderators who do
143         not have "shell access" to the mailing list server where the Mailman
144         software runs.
145
146         http://listowner.org
147
148     Mailman-Announce
149         A read-only list for release announcements an other important news.
150
151         http://mail.python.org/mailman/listinfo/mailman-announce
152
153     Mailman-Developers
154         A list for those of you interested in helping develop Mailman 2's
155         future direction.  This list will contain in-depth technical
156         discussions.
157
158         http://mail.python.org/mailman/listinfo/mailman-developers
159
160     Mailman3-Dev
161         Get involved now in the development of Mailman 3!
162
163         http://mail.python.org/mailman/listinfo/mailman3-dev
164
165     Mailman-I18N
166         A list for the discussion of the Mailman internationalization
167         effort.  Mailman 2.1 is fully multi-lingual.
168
169         http://mail.python.org/mailman/listinfo/mailman-i18n
170
171     Mailman-Checkins
172         A read-only list which is an adjunct to the public anonymous CVS
173         repository.  You can stay on the bleeding edge of Mailman development
174         by subscribing to this list.
175
176         http://mail.python.org/mailman/listinfo/mailman-checkins
177
178     The Mailman project is coordinated on SourceForge at
179
180         http://sf.net/projects/mailman
181
182     You should use SourceForge to report bugs and to upload patches.
183
184
185 \f
186 Local Variables:
187 mode: indented-text
188 indent-tabs-mode: nil
189 End: