[docs] [issue11260] smtpd-as-a-script feature should be documented and should use argparse

Éric Araujo report at bugs.python.org
Wed Jul 13 17:50:19 CEST 2011

Éric Araujo <merwok at netwok.org> added the comment:

Here are comments on the doc patch.

+Run as a script
I’d say “Command-Line Interface”.

+``smtpd`` is a pluggable RFC 2821-compliant SMTP proxy.
:mod:`smtpd` is also a pluggable etc.

+.. program:: smtpd.py
Strip the .py

+   the ``setuid``
Please use markup like :func:`os.setuid`.

+   flag in order to run ``smtpd`` as a regular user.
Use :mod:`smtpd` or :program:`smtp` (not very important).

+   Turns on verbose debugging prints (to stderr)
Turn on verbose debbugging, which prints to stderr.

+   The concrete SMTP proxy class ``smtpd`` should use to perform its
+   proxying.
Could you add a link to a section of the doc that defines such classes?

+.. option:: localhost:localport
Currently undocumented.


Python tracker <report at bugs.python.org>

More information about the docs mailing list