Unified documentation header of all module executables.

(Redmine issue: #3361)

Unified documentation header of all module executables.
03d9cc1a · Jan Mach · f2ea9dea · 03d9cc1a · 03d9cc1a · 03d9cc1a
Commit 03d9cc1a authored 7 years ago by Jan Mach
--- a/bin/mentat-backup.py
+++ b/bin/mentat-backup.py
@@ -4,18 +4,23 @@
 # This file is part of Mentat system (https://mentat.cesnet.cz/).
 #
 # Copyright (C) since 2011 CESNET, z.s.p.o (http://www.ces.net/)
-# Use of this source is governed by the MIT license, see LICENSE file.
+# Use of this source is governed by the MIT license.
 #-------------------------------------------------------------------------------


 """
-This Mentat module provides database backup functions and features.
+This Mentat module is a script providing database backup functions and features.

-To view local documentation please use ``pydoc``::
+To view built-in help please execute the application with ``--help`` command line
+option::
+
+    mentat-backup.py --help
+
+To view local documentation please use ``pydoc3``::

    pydoc3 mentat.module.backup

-The implementation is based on :py:mod:`pyzenkit.zenscript` module. Please see its
+The implementation is based on :py:mod:`pyzenkit.zenscript` framework. Please see its
 documentation for more details.


@@ -23,7 +28,7 @@ License
 ^^^^^^^

 Copyright (C) since 2011 CESNET, z.s.p.o (http://www.ces.net/)
-Use of this source is governed by the MIT license, see LICENSE file.
+Use of this source is governed by the MIT license.
 """



--- a/bin/mentat-cleanup.py
+++ b/bin/mentat-cleanup.py
@@ -4,17 +4,24 @@
 # This file is part of Mentat system (https://mentat.cesnet.cz/).
 #
 # Copyright (C) since 2011 CESNET, z.s.p.o (http://www.ces.net/)
-# Use of this source is governed by the MIT license, see LICENSE file.
+# Use of this source is governed by the MIT license.
 #-------------------------------------------------------------------------------

+
 """
-This Mentat module provides database and cache cleanup functions and features.
+This Mentat module is a script providing database and cache cleanup functions and
+features.
+
+To view built-in help please execute the application with ``--help`` command line
+option::
+
+    mentat-cleanup.py --help

-To view local documentation please use ``pydoc``::
+To view local documentation please use ``pydoc3``::

    pydoc3 mentat.module.cleanup

-The implementation is based on :py:mod:`pyzenkit.zenscript` module. Please see its
+The implementation is based on :py:mod:`pyzenkit.zenscript` framework. Please see its
 documentation for more details.


@@ -22,7 +29,7 @@ License
 ^^^^^^^

 Copyright (C) since 2011 CESNET, z.s.p.o (http://www.ces.net/)
-Use of this source is governed by the MIT license, see LICENSE file.
+Use of this source is governed by the MIT license.
 """



--- a/bin/mentat-controller.py
+++ b/bin/mentat-controller.py
@@ -4,18 +4,23 @@
 # This file is part of Mentat system (https://mentat.cesnet.cz/).
 #
 # Copyright (C) since 2011 CESNET, z.s.p.o (http://www.ces.net/)
-# Use of this source is governed by the MIT license, see LICENSE file.
+# Use of this source is governed by the MIT license.
 #-------------------------------------------------------------------------------


 """
-This Mentat module provides Mentat system control functions and features.
+This Mentat module is a script providing Mentat system control functions and features.

-To view local documentation please use ``pydoc``::
+To view built-in help please execute the application with ``--help`` command line
+option::

-    pydoc3 mentat.module.cleanup
+    mentat-controller.py --help

-The implementation is based on :py:mod:`pyzenkit.zenscript` module. Please see its
+To view local documentation please use ``pydoc3``::
+
+    pydoc3 mentat.module.controller
+
+The implementation is based on :py:mod:`pyzenkit.zenscript` framework. Please see its
 documentation for more details.


@@ -23,7 +28,7 @@ License
 ^^^^^^^

 Copyright (C) since 2011 CESNET, z.s.p.o (http://www.ces.net/)
-Use of this source is governed by the MIT license, see LICENSE file.
+Use of this source is governed by the MIT license.
 """



--- a/bin/mentat-dbmngr.py
+++ b/bin/mentat-dbmngr.py
@@ -4,18 +4,23 @@
 # This file is part of Mentat system (https://mentat.cesnet.cz/).
 #
 # Copyright (C) since 2011 CESNET, z.s.p.o (http://www.ces.net/)
-# Use of this source is governed by the MIT license, see LICENSE file.
+# Use of this source is governed by the MIT license.
 #-------------------------------------------------------------------------------


 """
-This Mentat module provides database management functions and features.
+This Mentat module is a script providing database management functions and features.

-To view local documentation please use ``pydoc``::
+To view built-in help please execute the application with ``--help`` command line
+option::

-    pydoc3 mentat.module.backup
+    mentat-dbmngr.py --help

-The implementation is based on :py:mod:`pyzenkit.zenscript` module. Please see its
+To view local documentation please use ``pydoc3``::
+
+    pydoc3 mentat.module.dbmngr
+
+The implementation is based on :py:mod:`pyzenkit.zenscript` framework. Please see its
 documentation for more details.


@@ -23,7 +28,7 @@ License
 ^^^^^^^

 Copyright (C) since 2011 CESNET, z.s.p.o (http://www.ces.net/)
-Use of this source is governed by the MIT license, see LICENSE file.
+Use of this source is governed by the MIT license.
 """



--- a/bin/mentat-enricher.py
+++ b/bin/mentat-enricher.py
@@ -4,7 +4,7 @@
 # This file is part of Mentat system (https://mentat.cesnet.cz/).
 #
 # Copyright (C) since 2011 CESNET, z.s.p.o (http://www.ces.net/)
-# Use of this source is governed by the MIT license, see LICENSE file.
+# Use of this source is governed by the MIT license.
 #-------------------------------------------------------------------------------


@@ -17,6 +17,25 @@ This Mentat module is a real-time message processing daemon capable of enriching
    **BUG WARNING:** The dynamic plugin loading feature is currently broken, all
    enricher plugins must be preloaded inside code of this module. Bugfix is under
    development.
+
+To view built-in help please execute the application with ``--help`` command line
+option::
+
+    mentat-enricher.py --help
+
+To view local documentation please use ``pydoc3``::
+
+    pydoc3 mentat.module.enricher
+
+The implementation is based on :py:mod:`pyzenkit.zendaemon` framework. Please see its
+documentation for more details.
+
+
+License
+^^^^^^^
+
+Copyright (C) since 2011 CESNET, z.s.p.o (http://www.ces.net/)
+Use of this source is governed by the MIT license.
 """



--- a/bin/mentat-ideagen.py
+++ b/bin/mentat-ideagen.py
@@ -4,19 +4,24 @@
 # This file is part of Mentat system (https://mentat.cesnet.cz/).
 #
 # Copyright (C) since 2011 CESNET, z.s.p.o (http://www.ces.net/)
-# Use of this source is governed by the MIT license, see LICENSE file.
+# Use of this source is governed by the MIT license.
 #-------------------------------------------------------------------------------


 """
-This Mentat module provides functions for generating IDEA message(s), mainly for
-testing or development purposes.
+This Mentat module is a script providing functions for generating IDEA message(s),
+mainly for testing or development purposes.

-To view local documentation please use ``pydoc``::
+To view built-in help please execute the application with ``--help`` command line
+option::

-    pydoc3 mentat.module.backup
+    mentat-ideagen.py --help

-The implementation is based on :py:mod:`pyzenkit.zenscript` module. Please see its
+To view local documentation please use ``pydoc3``::
+
+    pydoc3 mentat.module.ideagen
+
+The implementation is based on :py:mod:`pyzenkit.zenscript` framework. Please see its
 documentation for more details.


@@ -24,7 +29,7 @@ License
 ^^^^^^^

 Copyright (C) since 2011 CESNET, z.s.p.o (http://www.ces.net/)
-Use of this source is governed by the MIT license, see LICENSE file.
+Use of this source is governed by the MIT license.
 """



--- a/bin/mentat-inspector.py
+++ b/bin/mentat-inspector.py
@@ -4,7 +4,7 @@
 # This file is part of Mentat system (https://mentat.cesnet.cz/).
 #
 # Copyright (C) since 2011 CESNET, z.s.p.o (http://www.ces.net/)
-# Use of this source is governed by the MIT license, see LICENSE file.
+# Use of this source is governed by the MIT license.
 #-------------------------------------------------------------------------------


@@ -12,6 +12,25 @@
 This Mentat module is a real-time message processing daemon capable of inspecting
 `IDEA <https://idea.cesnet.cz/en/index>`__ messages according to given set of
 filtering rules and performing number of associated actions.
+
+To view built-in help please execute the application with ``--help`` command line
+option::
+
+    mentat-inspector.py --help
+
+To view local documentation please use ``pydoc3``::
+
+    pydoc3 mentat.module.inspector
+
+The implementation is based on :py:mod:`pyzenkit.zendaemon` framework. Please see its
+documentation for more details.
+
+
+License
+^^^^^^^
+
+Copyright (C) since 2011 CESNET, z.s.p.o (http://www.ces.net/)
+Use of this source is governed by the MIT license.
 """



--- a/bin/mentat-netmngr.py
+++ b/bin/mentat-netmngr.py
@@ -4,19 +4,24 @@
 # This file is part of Mentat system (https://mentat.cesnet.cz/).
 #
 # Copyright (C) since 2011 CESNET, z.s.p.o (http://www.ces.net/)
-# Use of this source is governed by the MIT license, see LICENSE file.
+# Use of this source is governed by the MIT license.
 #-------------------------------------------------------------------------------


 """
-This Mentat module provides functions for abuse group network management for Mentat system
-database. Still work in progress, use with caution.
+This Mentat module is a script providing functions for abuse group network management
+for Mentat system database. Still work in progress, use with caution.

-To view local documentation please use ``pydoc``::
+To view built-in help please execute the application with ``--help`` command line
+option::

-    pydoc3 mentat.module.backup
+    mentat-netmngr.py --help

-The implementation is based on :py:mod:`pyzenkit.zenscript` module. Please see its
+To view local documentation please use ``pydoc3``::
+
+    pydoc3 mentat.module.netmngr
+
+The implementation is based on :py:mod:`pyzenkit.zenscript` framework. Please see its
 documentation for more details.


@@ -24,7 +29,7 @@ License
 ^^^^^^^

 Copyright (C) since 2011 CESNET, z.s.p.o (http://www.ces.net/)
-Use of this source is governed by the MIT license, see LICENSE file.
+Use of this source is governed by the MIT license.
 """



--- a/bin/mentat-sampler.py
+++ b/bin/mentat-sampler.py
@@ -4,13 +4,32 @@
 # This file is part of Mentat system (https://mentat.cesnet.cz/).
 #
 # Copyright (C) since 2011 CESNET, z.s.p.o (http://www.ces.net/)
-# Use of this source is governed by the MIT license, see LICENSE file.
+# Use of this source is governed by the MIT license.
 #-------------------------------------------------------------------------------


 """
 This Mentat module is a real-time message processing daemon capable of sampling
 `IDEA <https://idea.cesnet.cz/en/index>`__ messages according to various policies.
+
+To view built-in help please execute the application with ``--help`` command line
+option::
+
+    mentat-sampler.py --help
+
+To view local documentation please use ``pydoc3``::
+
+    pydoc3 mentat.module.sampler
+
+The implementation is based on :py:mod:`pyzenkit.zendaemon` framework. Please see its
+documentation for more details.
+
+
+License
+^^^^^^^
+
+Copyright (C) since 2011 CESNET, z.s.p.o (http://www.ces.net/)
+Use of this source is governed by the MIT license.
 """



--- a/bin/mentat-statistician.py
+++ b/bin/mentat-statistician.py
@@ -4,19 +4,24 @@
 # This file is part of Mentat system (https://mentat.cesnet.cz/).
 #
 # Copyright (C) since 2011 CESNET, z.s.p.o (http://www.ces.net/)
-# Use of this source is governed by the MIT license, see LICENSE file.
+# Use of this source is governed by the MIT license.
 #-------------------------------------------------------------------------------


 """
-This Mentat module provides statistical functions and features for message processing
-performance analysis.
+This Mentat module is a script providing statistical functions and features for
+message processing performance analysis.

-To view local documentation please use ``pydoc``::
+To view built-in help please execute the application with ``--help`` command line
+option::

-    pydoc3 mentat.module.backup
+    mentat-statistician.py --help

-The implementation is based on :py:mod:`pyzenkit.zenscript` module. Please see its
+To view local documentation please use ``pydoc3``::
+
+    pydoc3 mentat.module.statistician
+
+The implementation is based on :py:mod:`pyzenkit.zenscript` framework. Please see its
 documentation for more details.


@@ -24,7 +29,7 @@ License
 ^^^^^^^

 Copyright (C) since 2011 CESNET, z.s.p.o (http://www.ces.net/)
-Use of this source is governed by the MIT license, see LICENSE file.
+Use of this source is governed by the MIT license.
 """



--- a/bin/mentat-storage.py
+++ b/bin/mentat-storage.py
@@ -12,6 +12,25 @@
 This Mentat module is a real-time message processing daemon capable of storing
 `IDEA <https://idea.cesnet.cz/en/index>`__ messages into persistent storage.
 Currently only `MongoDB <https://www.mongodb.com/>`__ NoSQL database is supported.
+
+To view built-in help please execute the application with ``--help`` command line
+option::
+
+    mentat-storage.py --help
+
+To view local documentation please use ``pydoc3``::
+
+    pydoc3 mentat.module.storage
+
+The implementation is based on :py:mod:`pyzenkit.zendaemon` framework. Please see its
+documentation for more details.
+
+
+License
+^^^^^^^
+
+Copyright (C) since 2011 CESNET, z.s.p.o (http://www.ces.net/)
+Use of this source is governed by the MIT license, see LICENSE file.
 """