summaryrefslogtreecommitdiff
path: root/README.rst
blob: 485b266d34eb0c623b5b68efc50aa999f9f9863c (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
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
================================================
Mailman - The GNU Mailing List Management System
================================================

.. image:: https://gitlab.com/mailman/mailman/badges/master/build.svg
    :target: https://gitlab.com/mailman/mailman/commits/master

.. image:: https://readthedocs.org/projects/mailman/badge
    :target: https://mailman.readthedocs.io

.. image:: http://img.shields.io/pypi/v/mailman.svg
    :target: https://pypi.python.org/pypi/mailman

.. image:: http://img.shields.io/pypi/dm/mailman.svg
    :target: https://pypi.python.org/pypi/mailman

Copyright (C) 1998-2017 by the Free Software Foundation, Inc.

This is GNU Mailman, a mailing list management system distributed under the
terms of the GNU General Public License (GPL) version 3 or later.  The name of
this software is spelled "Mailman" with a leading capital 'M' but with a lower
case second 'm'.  Any other spelling is incorrect.

Mailman is written in Python which is available for all platforms that Mailman
is supported on, including GNU/Linux and most other Unix-like operating
systems (e.g. Solaris, \*BSD, MacOSX, etc.).  Mailman is not supported on
Windows, although web and mail clients on any platform should be able to
interact with Mailman just fine.

The Mailman home page is:

    http://www.list.org

and there is a community driven wiki at

    http://wiki.list.org

For more information on Mailman, see the above web sites, or the
:ref:`documentation provided with this software <start-here>`.


Table of Contents
=================

.. toctree::
    :glob:
    :maxdepth: 1

    src/mailman/docs/introduction
    src/mailman/docs/release-notes
    src/mailman/docs/install
    src/mailman/config/docs/config
    src/mailman/docs/database
    src/mailman/docs/mta
    src/mailman/docs/postorius
    src/mailman/docs/hyperkitty
    src/mailman/docs/contribute
    src/mailman/docs/STYLEGUIDE
    src/mailman/docs/architecture
    src/mailman/docs/8-miles-high


Mailman modules
---------------

These documents are generated from the internal module documentation.

.. toctree::
    :maxdepth: 1

    src/mailman/model/docs/model
    src/mailman/runners/docs/runners
    src/mailman/chains/docs/chains
    src/mailman/rules/docs/rules
    src/mailman/handlers/docs/handlers
    src/mailman/rest/docs/rest
    src/mailman/core/docs/core
    src/mailman/app/docs/app
    src/mailman/styles/docs/styles
    src/mailman/archiving/docs/common
    src/mailman/mta/docs/mta
    src/mailman/bin/docs/master
    src/mailman/commands/docs/commands
    src/mailman/docs/NEWS
    src/mailman/docs/ACKNOWLEDGMENTS
    contrib/README


Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`