.. _plugin:relay:

=====
RELAY
=====
| 

about
-----
| 

:author:  FeedBackLoop <feedbackloop@gmail.com>
:contact: FREENODE/#fbf
:distribution: core
:license:  

| 

description
-----------
| 

 relay to other users/channels. 



| 

commands
--------
| 


    :commands in this plugin: relay .. relay-unblock .. relay-blocklist .. relay-block .. relay-clear .. relay-list .. relay-stop

| 

1) *relay .. [handle_relay]*

    :description:  arguments: [<botname>] [<type>] <target> .. open a relay to a user. all input from us will be relayed. 

    :permissions: OPER

    :code: :ref:`fbf.plugs.extra.relay_relay_command`.

    :examples:

    ::

        <user> ;relay default-sxmpp sxmpp feedbackloop@gmail.com
        <output> no default-sxmpp bot in fleet.



    ::

        <user> ;relay botfather
        <output> no testbot bot in fleet.


2) *relay-block .. [handle_relayblock]*

    :description:  arguments: <bottype> <target> .. block a user/channel/wave from relaying to us. 

    :permissions: OPER .. USER

    :code: :ref:`fbf.plugs.extra.relay_relay-block_command`.

    :examples:

    ::

        <user> ;relay-block feedbackloop@gmail.com
        <output> relay-block <bottype> <target>


3) *relay-blocklist .. [handle_relayblocklist]*

    :description:  no arguments - show all blocks of a user/channel.wave. 

    :permissions: OPER .. USER

    :code: :ref:`fbf.plugs.extra.relay_relay-blocklist_command`.

    :examples:

    ::

        <user> ;relay-blocklist
        <output> no blocks for ('testbot', '#test')


4) *relay-clear .. [handle_relayclear]*

    :description:  no arguments - clear all relays from a channel. all relaying to target will be ignored. 

    :permissions: OPER

    :code: :ref:`fbf.plugs.extra.relay_relay-clear_command`.

    :examples:

    ::

        <user> ;relay-clear
        <output> done - relay-clear


5) *relay-list .. [handle_askrelaylist]*

    :description:  no arguments - show all relay's of a user. 

    :permissions: OPER .. USER

    :code: :ref:`fbf.plugs.extra.relay_relay-list_command`.

    :examples:

    ::

        <user> ;relay-list
        <output> relays for ('testbot', '#test'):


6) *relay-stop .. [handle_relaystop]*

    :description:  arguments: [<botname>] [<bottype>] [<channel>] - stop a relay to a user. all relaying from the target will be ignored. 

    :permissions: OPER ..  USER

    :code: :ref:`fbf.plugs.extra.relay_relay-stop_command`.

    :examples:

    ::

        <user> ;relay-stop feedbackloop@gmail.com
        <output> done - relay-stop


7) *relay-unblock .. [handle_relaystop]*

    :description:  arguments: [<botname>] [<bottype>] [<channel>] - stop a relay to a user. all relaying from the target will be ignored. 

    :permissions: OPER .. USER

    :code: :ref:`fbf.plugs.extra.relay_relay-unblock_command`.

    :examples:

    ::

        <user> ;relay-unblock feedbackloop@gmail.com
        <output> done - relay-unblock