README.rst

   1 ================================================
   2 Mailman - The GNU Mailing List Management System
   3 ================================================
   4
   5 Copyright (C) 1998-2016 by the Free Software Foundation, Inc.
   6
   7 This is GNU Mailman, a mailing list management system distributed under the
   8 terms of the GNU General Public License (GPL) version 3 or later.  The name of
   9 this 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 in Python which is available for all platforms that Mailman
  13 is supported on, including GNU/Linux and most other Unix-like operating
  14 systems (e.g. Solaris, \*BSD, MacOSX, etc.).  Mailman is not supported on
  15 Windows, although web and mail clients on any platform should be able to
  16 interact with Mailman just fine.
  17
  18 The Mailman home page is:
  19
  20     http://www.list.org
  21
  22 and there is a community driven wiki at
  23
  24     http://wiki.list.org
  25
  26 For more information on Mailman, see the above web sites, or the
  27 :ref:`documentation provided with this software <start-here>`.
  28
  29
  30 Table of Contents
  31 =================
  32
  33 .. toctree::
  34     :glob:
  35
  36     src/mailman/docs/INTRODUCTION
  37     src/mailman/docs/START
  38     src/mailman/docs/RELEASENOTES
  39     src/mailman/docs/DATABASE
  40     src/mailman/docs/MTA
  41     src/mailman/docs/8-miles-high
  42     src/mailman/docs/WebUIin5
  43     src/mailman/docs/ArchiveUIin5
  44     src/mailman/docs/DEVELOP
  45
  46
  47 Mailman modules
  48 ---------------
  49
  50 These documents are generated from the doctest suite.
  51
  52 .. toctree::
  53     :glob:
  54
  55     src/mailman/model/docs/*
  56     src/mailman/runners/docs/*
  57     src/mailman/chains/docs/*
  58     src/mailman/rules/docs/*
  59     src/mailman/handlers/docs/*
  60     src/mailman/rest/docs/*
  61     src/mailman/core/docs/*
  62     src/mailman/app/docs/*
  63     src/mailman/styles/docs/*
  64     src/mailman/archiving/docs/*
  65     src/mailman/mta/docs/*
  66     src/mailman/bin/docs/*
  67     src/mailman/commands/docs/*
  68     src/mailman/docs/NEWS
  69     src/mailman/docs/STYLEGUIDE
  70     src/mailman/docs/ACKNOWLEDGMENTS
  71
  72
  73 Indices and tables
  74 ==================
  75
  76 * :ref:`genindex`
  77 * :ref:`modindex`
  78 * :ref:`search`