summaryrefslogtreecommitdiff
path: root/plugins/alias.py
diff options
context:
space:
mode:
authormathieui <mathieui@mathieui.net>2013-04-13 22:33:06 +0200
committermathieui <mathieui@mathieui.net>2013-04-13 22:33:06 +0200
commitd676c2ee7b6207ff0b2a7b384052ab07c08bf43a (patch)
treeb6c22d35da1eb5bc33ab0cc983a86d8dfe6c2a78 /plugins/alias.py
parente6cb43eeedcd6c6961c5ab430f25bb962d40bf8e (diff)
downloadpoezio-d676c2ee7b6207ff0b2a7b384052ab07c08bf43a.tar.gz
poezio-d676c2ee7b6207ff0b2a7b384052ab07c08bf43a.tar.bz2
poezio-d676c2ee7b6207ff0b2a7b384052ab07c08bf43a.tar.xz
poezio-d676c2ee7b6207ff0b2a7b384052ab07c08bf43a.zip
Move the plugins documentation
(use automodule directive & docstrings)
Diffstat (limited to 'plugins/alias.py')
-rw-r--r--plugins/alias.py38
1 files changed, 36 insertions, 2 deletions
diff --git a/plugins/alias.py b/plugins/alias.py
index a3843f35..80efe5bc 100644
--- a/plugins/alias.py
+++ b/plugins/alias.py
@@ -1,7 +1,41 @@
"""
-Alias plugin.
+Installation
+------------
+You only have to load the plugin:
+
+``/load alias``
+
+Usage
+-----
+
+This plugin defines two new global commands: :term:`/alias` and :term:`/unalias`.
+
+.. glossary::
+
+ /alias
+ **Usage:** ``/alias <name> <command> [args]``
+
+ This command will create a new command, named ``name`` (and callable with
+ ``/name``), that runs ``/command``, with ``[args]`` as fixed args for the command.
+ When you run the alias, you can also pass parameters to it, that will be fed
+ to the original command.
+
+ Example: ::
+
+ /alias toto say "koin "
+
+ Will bind ``/say koin `` to ``/toto``, so this alias will work in any
+ Chat tab. If someone calls it with ::
+
+ /toto koin
+
+ Poezio will then execute ``/say koin koin``.
+
+ /unalias
+ **Usage:** ``/unalias <name>``
+
+ This command removes a defined alias.
-Allows the creation and the removal of personal aliases.
"""
from plugin import BasePlugin