.. _plugin:irc:

===
IRC
===
| 

about
-----
| 

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

| 

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

 irc related commands. 



| 

commands
--------
| 


    :commands in this plugin: jump .. action .. broadcast .. say .. voice .. nicks .. server .. nick .. sendraw

| 

1) *action .. [handle_action]*

    :description:  arguments: <channel> <txt> - make the bot send an action string. 

    :permissions: ACTION .. OPER

    :code: :ref:`fbf.plugs.core.irc_action_command`.

    :examples:

    ::

        <user> ;action #test yoo dudes
        <output> done - action


2) *broadcast .. [handle_broadcast]*

    :description:  arguments: <txt> - broadcast txt to all joined channels. 

    :permissions: OPER

    :code: :ref:`fbf.plugs.core.irc_broadcast_command`.

    :examples:

    ::

        <user> ;broadcast good morning
        <output> broadcasting
        <output> done


3) *jump .. [handle_jump]*

    :description:  arguments: <server> <port> - change server. 

    :permissions: OPER

    :code: :ref:`fbf.plugs.core.irc_jump_command`.

    :examples:

    ::

        <user> ;jump localhost 6667
        <output> changing to server localhost
        <output> done - jump


4) *nick .. [handle_nick]*

    :description:  arguments: <nickname> - change bot's nick. 

    :permissions: OPER

    :code: :ref:`fbf.plugs.core.irc_nick_command`.

    :examples:

    ::

        <user> ;nick mekker
        <output> changing nick to mekker
        <output> done - nick


5) *nicks .. [handle_nicks]*

    :description:  no arguments - return nicks on channel. 

    :permissions: OPER .. USER

    :code: :ref:`fbf.plugs.core.irc_nicks_command`.

    :examples:

    ::

        <user> ;nicks
        <output> nicks only works on irc bots


6) *say .. [handle_say]*

    :description:  aguments: <channel> <txt> - make the bot say something. 

    :permissions: SAY .. OPER

    :code: :ref:`fbf.plugs.core.irc_say_command`.

    :examples:

    ::

        <user> ;say #test good morning
        <output> done - say


7) *sendraw .. [handle_sendraw]*

    :description:  arguments: <txt> - send raw text to the server. 

    :permissions: OPER .. SENDRAW

    :code: :ref:`fbf.plugs.core.irc_sendraw_command`.

    :examples:

    ::

        <user> ;sendraw PRIVMSG #test :yo!
        <output> sending raw txt
        <output> done - sendraw


8) *server .. [handle_server]*

    :description:  no arguments - show the server to which the bot is connected. 

    :permissions: OPER

    :code: :ref:`fbf.plugs.core.irc_server_command`.

    :examples:

    ::

        <user> ;server
        <output> localhost


9) *voice .. [handle_voice]*

    :description:  arguments: <nick> - give voice. 

    :permissions: OPER

    :code: :ref:`fbf.plugs.core.irc_voice_command`.

    :examples:

    ::

        <user> ;voice test
        <output> voice only works on irc bots