README.rst

   1 ================================================
   2 Mailman - The GNU Mailing List Management System
   3 ================================================
   4
   5 .. image:: https://gitlab.com/mailman/mailman/badges/master/build.svg
   6     :target: https://gitlab.com/mailman/mailman/commits/master
   7
   8 .. image:: https://readthedocs.org/projects/mailman/badge
   9     :target: https://mailman.readthedocs.io
  10
  11 .. image:: https://img.shields.io/pypi/v/mailman.svg
  12     :target: https://pypi.org/project/mailman/
  13
  14 .. image:: https://img.shields.io/pypi/dm/mailman.svg
  15     :target: https://pypi.org/project/mailman/
  16
  17 Copyright (C) 1998-2022 by the Free Software Foundation, Inc.
  18
  19 This is GNU Mailman, a mailing list management system distributed under the
  20 terms of the GNU General Public License (GPL) version 3 or later.  The name of
  21 this software is spelled "Mailman" with a leading capital 'M' but with a lower
  22 case second 'm'.  Any other spelling is incorrect.
  23
  24 Technically speaking, you are reading the documentation for Mailman Core.  The
  25 full `Mailman 3 suite <http://docs.mailman3.org>`_ includes a web user
  26 interface called Postorius, a web archiver called HyperKitty, and a few other
  27 components.  If you're looking for instructions on installing the full suite,
  28 read that documentation.
  29
  30 Mailman is written in Python which is available for all platforms that Python
  31 is supported on, including GNU/Linux and most other Unix-like operating
  32 systems (e.g. Solaris, \*BSD, MacOSX, etc.).  Mailman is not supported on
  33 Windows, although web and mail clients on any platform should be able to
  34 interact with Mailman just fine.
  35
  36 The Mailman home page is:
  37
  38     http://www.list.org
  39
  40 and there is a community driven wiki at
  41
  42     http://wiki.list.org
  43
  44 For more information on Mailman, see the above web sites, or the
  45 :ref:`documentation provided with this software <start-here>`.
  46
  47
  48 Table of Contents
  49 =================
  50
  51 .. toctree::
  52     :glob:
  53     :maxdepth: 1
  54
  55     src/mailman/docs/introduction
  56     src/mailman/docs/release-notes
  57     src/mailman/docs/install
  58     src/mailman/config/docs/config
  59     src/mailman/docs/database
  60     src/mailman/docs/mta
  61     src/mailman/docs/postorius
  62     src/mailman/docs/hyperkitty
  63     src/mailman/docs/documentation
  64     src/mailman/plugins/docs/intro
  65     src/mailman/docs/contribute
  66     src/mailman/docs/STYLEGUIDE
  67     src/mailman/docs/internationalization
  68     src/mailman/docs/architecture
  69     src/mailman/docs/8-miles-high
  70     src/mailman/docs/NEWS
  71     src/mailman/docs/ACKNOWLEDGMENTS
  72
  73
  74 REST API
  75 --------
  76
  77 .. toctree::
  78     :maxdepth: 2
  79     :caption: REST API
  80
  81     src/mailman/rest/docs/rest
  82
  83
  84 Mailman modules
  85 ---------------
  86
  87 These documents are generated from the internal module documentation.
  88
  89 .. toctree::
  90     :maxdepth: 1
  91     :caption: Mailman Modules
  92
  93     src/mailman/model/docs/model
  94     src/mailman/runners/docs/runners
  95     src/mailman/chains/docs/chains
  96     src/mailman/rules/docs/rules
  97     src/mailman/handlers/docs/handlers
  98     src/mailman/core/docs/core
  99     src/mailman/app/docs/app
 100     src/mailman/styles/docs/styles
 101     src/mailman/archiving/docs/common
 102     src/mailman/mta/docs/mta
 103     src/mailman/bin/docs/master
 104     src/mailman/commands/docs/commands
 105     contrib/README
 106
 107
 108 Indices and tables
 109 ==================
 110
 111 * :ref:`genindex`
 112 * :ref:`modindex`
 113 * :ref:`search`