diff options
| author | Gurkirpal | 2016-03-11 16:40:36 +0530 |
|---|---|---|
| committer | Barry Warsaw | 2016-03-22 20:34:26 -0400 |
| commit | b399f600f383a414a2ca2bb3acc653672f637ede (patch) | |
| tree | b358eab1e707f92d472c494f7da11740e17b53bd /src | |
| parent | 4c6ad873f81c0e44ca5580e2b3ba47d0ada8d582 (diff) | |
| download | mailman-b399f600f383a414a2ca2bb3acc653672f637ede.tar.gz mailman-b399f600f383a414a2ca2bb3acc653672f637ede.tar.zst mailman-b399f600f383a414a2ca2bb3acc653672f637ede.zip | |
Updated docs
- instructions for mailman shell
Diffstat (limited to 'src')
| -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 -------------- |