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:: http://img.shields.io/pypi/v/mailman.svg
  12     :target: https://pypi.python.org/pypi/mailman
  13
  14 .. image:: http://img.shields.io/pypi/dm/mailman.svg
  15     :target: https://pypi.python.org/pypi/mailman
  16
  17 Copyright (C) 1998-2017 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 Mailman is written in Python which is available for all platforms that Mailman
  25 is supported on, including GNU/Linux and most other Unix-like operating
  26 systems (e.g. Solaris, \*BSD, MacOSX, etc.).  Mailman is not supported on
  27 Windows, although web and mail clients on any platform should be able to
  28 interact with Mailman just fine.
  29
  30 The Mailman home page is:
  31
  32     http://www.list.org
  33
  34 and there is a community driven wiki at
  35
  36     http://wiki.list.org
  37
  38 For more information on Mailman, see the above web sites, or the
  39 :ref:`documentation provided with this software <start-here>`.
  40
  41
  42 Table of Contents
  43 =================
  44
  45 .. toctree::
  46     :glob:
  47
  48     src/mailman/docs/INTRODUCTION
  49     src/mailman/docs/RELEASENOTES
  50     src/mailman/config/docs/config
  51     src/mailman/docs/DATABASE
  52     src/mailman/docs/MTA
  53     src/mailman/docs/WebUIin5
  54     src/mailman/docs/ArchiveUIin5
  55     src/mailman/docs/CONTRIBUTE
  56     src/mailman/docs/STYLEGUIDE
  57     src/mailman/docs/ARCHITECTURE
  58     src/mailman/docs/8-miles-high
  59
  60
  61 Mailman modules
  62 ---------------
  63
  64 These documents are generated from the doctest suite.
  65
  66 .. toctree::
  67     :maxdepth: 1
  68
  69     src/mailman/model/docs/model
  70     src/mailman/runners/docs/runners
  71     src/mailman/chains/docs/chains
  72     src/mailman/rules/docs/rules
  73     src/mailman/handlers/docs/handlers
  74     src/mailman/rest/docs/rest
  75     src/mailman/core/docs/core
  76     src/mailman/app/docs/app
  77     src/mailman/styles/docs/styles
  78     src/mailman/archiving/docs/common
  79     src/mailman/mta/docs/mta
  80     src/mailman/bin/docs/master
  81     src/mailman/commands/docs/commands
  82     src/mailman/docs/NEWS
  83     src/mailman/docs/ACKNOWLEDGMENTS
  84     contrib/README
  85
  86
  87 Indices and tables
  88 ==================
  89
  90 * :ref:`genindex`
  91 * :ref:`modindex`
  92 * :ref:`search`