README.txt

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