diff options
| author | mathieui <mathieui@mathieui.net> | 2013-04-13 22:33:06 +0200 |
|---|---|---|
| committer | mathieui <mathieui@mathieui.net> | 2013-04-13 22:33:06 +0200 |
| commit | d676c2ee7b6207ff0b2a7b384052ab07c08bf43a (patch) | |
| tree | b6c22d35da1eb5bc33ab0cc983a86d8dfe6c2a78 /plugins/ping.py | |
| parent | e6cb43eeedcd6c6961c5ab430f25bb962d40bf8e (diff) | |
| download | poezio-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/ping.py')
| -rw-r--r-- | plugins/ping.py | 32 |
1 files changed, 32 insertions, 0 deletions
diff --git a/plugins/ping.py b/plugins/ping.py index faf3e97d..c4f56c81 100644 --- a/plugins/ping.py +++ b/plugins/ping.py @@ -1,3 +1,35 @@ +""" +This plugin allows you to ping an entity. + +Installation +------------ +You only have to load the plugin. + +.. code-block:: none + + /load ping + +Command +------- + +.. glossary:: + + /ping + **Usage (globally):** ``/ping <jid>`` + + **Usage (in a MUC tab):** ``/ping <jid or nick>`` + + **Usage (in a conversation tab):** ``/ping [jid]`` + + Globally, you can do ``/ping jid@example.com`` to get a ping. + + In a MUC, you can either do it to a JID or a nick (``/ping nick`` or ``/ping + jid@example.com``). + + In a private or a direct conversation, you can do ``/ping`` to ping + the current interlocutor. +""" + from plugin import BasePlugin from roster import roster from common import safeJID |