2011-06-28 08:11:32 +02:00
|
|
|
|
|
|
|
|
.. _plugin-herald:
|
|
|
|
|
|
|
|
|
|
The Herald plugin
|
|
|
|
|
=================
|
|
|
|
|
|
2011-06-28 17:29:38 +02:00
|
|
|
User commands
|
|
|
|
|
-------------
|
2011-06-28 08:11:32 +02:00
|
|
|
|
2011-06-28 17:29:38 +02:00
|
|
|
.. _command-herald-get:
|
|
|
|
|
|
|
|
|
|
herald get [<channel>] [<user|nick>]
|
|
|
|
|
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
2011-06-28 08:11:32 +02:00
|
|
|
|
|
|
|
|
Returns the current herald message for *<user>* (or the user
|
|
|
|
|
*<nick|hostmask>* is currently identified or recognized as). If *<user>*
|
|
|
|
|
is not given, defaults to the user giving the command. *<channel>*
|
|
|
|
|
is only necessary if the message isn't sent in the channel itself.
|
|
|
|
|
|
2011-06-28 17:29:38 +02:00
|
|
|
.. _command-herald-remove:
|
2011-06-28 08:11:32 +02:00
|
|
|
|
2011-06-28 17:29:38 +02:00
|
|
|
herald remove [<channel>] [<user|nick>]
|
|
|
|
|
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
2011-06-28 08:11:32 +02:00
|
|
|
|
|
|
|
|
Removes the herald message set for *<user>*, or the user
|
|
|
|
|
*<nick|hostmask>* is currently identified or recognized as. If *<user>*
|
|
|
|
|
is not given, defaults to the user giving the command.
|
|
|
|
|
*<channel>* is only necessary if the message isn't sent in the channel
|
|
|
|
|
itself.
|
|
|
|
|
|
2011-06-28 17:29:38 +02:00
|
|
|
.. _command-herald-change:
|
2011-06-28 08:11:32 +02:00
|
|
|
|
2011-06-28 17:29:38 +02:00
|
|
|
herald change [<channel>] [<user|nick>] <regexp>
|
|
|
|
|
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
2011-06-28 08:11:32 +02:00
|
|
|
|
2011-06-28 17:29:38 +02:00
|
|
|
Changes the herald message for *<user>*, or the user *<nick|hostmask>* is
|
|
|
|
|
currently identified or recognized as, according to *<regexp>*. If
|
|
|
|
|
*<user>* is not given, defaults to the calling user. *<channel>* is only
|
|
|
|
|
necessary if the message isn't sent in the channel itself.
|
|
|
|
|
|
|
|
|
|
Op commands
|
|
|
|
|
-----------
|
|
|
|
|
|
|
|
|
|
.. _command-herald-default:
|
|
|
|
|
|
|
|
|
|
herald default [<channel>] [--remove|<msg>]
|
|
|
|
|
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
2011-06-28 08:11:32 +02:00
|
|
|
|
|
|
|
|
If *<msg>* is given, sets the default herald to *<msg>*. A *<msg>* of ""
|
|
|
|
|
will remove the default herald. If *<msg>* is not given, returns the
|
|
|
|
|
current default herald. *<channel>* is only necessary if the message
|
|
|
|
|
isn't sent in the channel itself.
|
|
|
|
|
|
2011-06-28 17:29:38 +02:00
|
|
|
.. _command-herald-add:
|
2011-06-28 08:11:32 +02:00
|
|
|
|
2011-06-28 17:29:38 +02:00
|
|
|
herald add [<channel>] <user|nick> <msg>
|
|
|
|
|
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
2011-06-28 08:11:32 +02:00
|
|
|
|
|
|
|
|
Sets the herald message for *<user>* (or the user *<nick|hostmask>* is
|
|
|
|
|
currently identified or recognized as) to *<msg>*. *<channel>* is only
|
|
|
|
|
necessary if the message isn't sent in the channel itself.
|
|
|
|
|
|
