src/mailman/docs/README.txt

   1 ================================================
   2 Mailman - The GNU Mailing List Management System
   3 ================================================
   4
   5 This is `GNU Mailman`_, a mailing list management system distributed under the
   6 terms of the `GNU General Public License`_ (GPL) version 3 or later.
   7
   8 Mailman is written in Python_, a free object-oriented programming language.
   9 Python is available for all platforms that Mailman is supported on, which
  10 includes GNU/Linux and most other Unix-like operating systems (e.g. Solaris,
  11 \*BSD, MacOSX, etc.).  Mailman is not supported on Windows, although web and
  12 mail clients on any platform should be able to interact with Mailman just
  13 fine.
  14
  15
  16 Copyright
  17 =========
  18
  19 Copyright 1998-2009 by the Free Software Foundation, Inc.
  20
  21 This file is part of GNU Mailman.
  22
  23 GNU Mailman is free software: you can redistribute it and/or modify it under
  24 the terms of the GNU General Public License as published by the Free Software
  25 Foundation, either version 3 of the License, or (at your option) any later
  26 version.
  27
  28 GNU Mailman is distributed in the hope that it will be useful, but WITHOUT ANY
  29 WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
  30 A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
  31
  32 You should have received a copy of the GNU General Public License along with
  33 GNU Mailman.  If not, see <http://www.gnu.org/licenses/>.
  34
  35
  36 Spelling
  37 ========
  38
  39 The name of this software is spelled `Mailman` with a leading capital `M`
  40 but with a lower case second `m`.  Any other spelling is incorrect.  Its full
  41 name is `GNU Mailman` but is often referred colloquially as `Mailman`.
  42
  43
  44 History
  45 =======
  46
  47 Mailman was originally developed by John Viega.  Subsequent development
  48 (through version 1.0b3) was by Ken Manheimer.  Further work towards the 1.0
  49 final release was a group effort, with the core contributors being: Barry
  50 Warsaw, Ken Manheimer, Scott Cotton, Harald Meland, and John Viega.  Version
  51 1.0 and beyond have been primarily maintained by Barry Warsaw with
  52 contributions from many; see the ACKNOWLEDGMENTS file for details.  Jeremy
  53 Hylton helped considerably with the Pipermail code in Mailman 2.0.  Mailman
  54 2.1 is now being primarily maintained by Mark Sapiro and Tokio Kikuchi.  Barry
  55 Warsaw is the lead developer on Mailman 3.
  56
  57
  58 Help
  59 ====
  60
  61 The Mailman home page is:
  62
  63     http://www.list.org
  64
  65 with mirrors at:
  66
  67     http://www.gnu.org/software/mailman
  68     http://mailman.sf.net
  69
  70 The community driven wiki (including the FAQ_) is at:
  71
  72     http://wiki.list.org
  73
  74 Other help resources, such as on-line documentation, links to the mailing
  75 lists and archives, etc., are available at:
  76
  77     http://www.list.org/help.html
  78
  79 For more information about the alpha releases, see `ALPHA.txt`_.
  80
  81
  82 Requirements
  83 ============
  84
  85 Mailman 3.0 requires `Python 2.6`_ or newer.
  86
  87
  88 .. _`GNU Mailman`: http://www.list.org
  89 .. _`GNU General Public License`: http://www.gnu.org/licenses/gpl.txt
  90 .. _Python: http://www.python.org
  91 .. _FAQ: http://wiki.list.org/display/DOC/Frequently+Asked+Questions
  92 .. _`Python 2.6`: http://www.python.org/download/releases/2.6.2/
  93 .. _`ALPHA.txt`: ALPHA.html
  94
  95
  96 Table of Contents
  97 =================
  98
  99 .. toctree::
 100     :glob:
 101
 102     *
 103     ../bin/docs/*
 104     ../commands/docs/*
 105     ../pipeline/docs/*
 106     ../queue/docs/*
 107     ../rest/docs/*
 108     ../rules/docs/*
 109     ../archiving/docs/*
 110     ../mta/docs/*