Barry Warsaw pushed to branch master at mailman / Mailman Core
Commits: 03d2b83a by Barry Warsaw at 2017-09-06T18:56:39-07:00 Add an admonition about requiring a UTF-8 locale. - - - - - b3eb9dd4 by Barry Warsaw at 2017-09-07T02:25:59+00:00 Merge branch 'click-utf8' into 'master' Add an admonition about requiring a UTF-8 locale See merge request !316 - - - - - 1 changed file: - src/mailman/docs/install.rst Changes: ===================================== src/mailman/docs/install.rst ===================================== --- a/src/mailman/docs/install.rst +++ b/src/mailman/docs/install.rst @@ -1,6 +1,6 @@ -====================== - Installing Mailman 3 -====================== +================================== + Installing and running Mailman 3 +================================== Copyright (C) 2008-2017 by the Free Software Foundation, Inc. @@ -8,12 +8,12 @@ Copyright (C) 2008-2017 by the Free Software Foundation, Inc. Requirements ============ -For the Core, Python 3.4 or newer is required. It can either be the default -'python3' on your ``$PATH`` or it can be accessible via the ``python3.4``, -``python3.5``, or ``python3.6`` binary. If your operating system does not -include Python 3, see http://www.python.org for information about downloading -installers (where available) and installing it from source (when necessary or -preferred). Python 2 is not supported by the Core. +For the Core, Python 3.5 or newer is required. It can either be the default +'python3' on your ``$PATH`` or it can be accessible via the ``python3.5`` or +``python3.6`` binary. If your operating system does not include Python 3, see +http://www.python.org for information about downloading installers (where +available) and installing it from source (when necessary or preferred). +Python 2 is not supported by the Core. You may need some additional dependencies, which are either available from your OS vendor, or can be downloaded automatically from the `Python @@ -48,6 +48,17 @@ or if you have a GitLab account and prefer ssh:: Running Mailman 3 ================= +.. ATTENTION:: + The Mailman command line interface requires a properly configured UTF-8 + locale. This is because the Core is implemented in `Python 3 and uses the + click`_ command line argument parsing library. Generally this will not be + an issue since your shell is probably set up correctly. However, in + certain environments such as init scripts and cron scripts, your locale may + not be UTF-8 compatible. This can cause Mailman to mysteriously fail to + run (since often, proper logging may also not be set up). If you're seeing + weird behavior in these types of environments, be sure they are UTF-8 + compatible, e.g. by setting ``export LANG=en_US.UTF-8``. + You will need to set up a configuration file to override the defaults and set things up for your environment. Mailman is configured using an "ini"-style configuration system. Usually this means creating a ``mailman.cfg`` file and @@ -103,3 +114,4 @@ do:: .. _`Mailman 3 Core documentation`: https://mailman.readthedocs.io .. _`Zope Component Architecture`: https://pypi.python.org/pypi/zope.component .. _`building out the mailman3.org`: https://wiki.list.org/DOC/Mailman%203%20installation%20experience +.. _`Python 3 and uses the click`: http://click.pocoo.org/6/python3/ View it on GitLab: https://gitlab.com/mailman/mailman/compare/dd8071a24562477e006952f22e61aa70658b25a7...b3eb9dd428b47232ee50db1f897e128480d6b4c4 --- View it on GitLab: https://gitlab.com/mailman/mailman/compare/dd8071a24562477e006952f22e61aa70658b25a7...b3eb9dd428b47232ee50db1f897e128480d6b4c4 You're receiving this email because of your account on gitlab.com.
_______________________________________________ Mailman-checkins mailing list Mailman-checkins@python.org Unsubscribe: https://mail.python.org/mailman/options/mailman-checkins/archive%40jab.org
