diff options
| -rw-r--r-- | src/mailman/docs/START.rst | 13 |
1 files changed, 13 insertions, 0 deletions
diff --git a/src/mailman/docs/START.rst b/src/mailman/docs/START.rst index 5074d9c25..94db25146 100644 --- a/src/mailman/docs/START.rst +++ b/src/mailman/docs/START.rst @@ -176,6 +176,19 @@ developed as a separate, Django-based project. For now, the most flexible means of configuration is via the command line and REST API. +Mailman Shell +------------- + +The `Mailman 3 documentation`_ has examples which use the Mailman shell to +interact with Mailman. To start the shell type ``mailman shell`` in your +terminal. + +There are some testings functions which need to be imported first before you +use them. They can be imported from the modules available in +``mailman.testing``. For example, to use ``dump_list`` you first need to +import it from the ``mailman.testing.documentation`` module. + + Mailman Web UI -------------- |