From cd9a3fb5401ecd0048d03f42933f3b09015cd164 Mon Sep 17 00:00:00 2001 From: David Bremner Date: Sun, 1 Aug 2021 12:35:40 -0300 Subject: initial README.rst --- README.rst | 43 +++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 43 insertions(+) create mode 100644 README.rst diff --git a/README.rst b/README.rst new file mode 100644 index 0000000..5005af5 --- /dev/null +++ b/README.rst @@ -0,0 +1,43 @@ +mm3mod: Command line list moderation for mailman3 +================================================= + +Installation +------------ + +Install with your favourite python package manager (not so well +tested), or just copy ``mm3mod/__install_.py`` to a nicer name in your +path and run it as a script. + +Configuration +------------- + +Create $XDG_CONFIG_DIR/mm3mod/config.ine with at least + +.. code-block:: ini + + [rest] + password= + + [list] + name= + +The password is output by ``mailman info`` or ``mailmain-wrapper info`` + +Use +--- + +Run + +:: + + $ mm3mod + +This will put you in a loop that + +1. Prints the first page of held messages +2. Allows you to ``accept`` or ``discard`` by request-id, or to discard the whole page. + +Other useful commands include ``quit`` and ``help`` + +Tab completion is available for commands and request-ids. + -- cgit v1.2.3