.. _plugin:irccat:

======
IRCCAT
======
| 

about
-----
| 

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

| 

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


    irccat2.py - fbfbot "irccat2" Module

    Copyright 2011, Richard Bateman
    Licensed under the New BSD License.

    Written to be used in the #firebreath IRC channel: http://www.firebreath.org

    To test, set up the host and port, then use something like:

    echo "@taxilian I am awesome" | netcat -g0 localhost 54321

    echo "#channel I am awesome" | netcat -g0 localhost 54321

    you can specify multiple users (with @) and channels (with #) by seperating them
    with commas.  Not that with jabber, channels tend to be treated as users
    unless you set up an alias in your channel:

    !irccat-add_alias #channel

    BHJTW - 28-02-2012 .. move to irccat2.py to use the normal irccat-cfg functions
    BHJTW - 15-08-2012 .. ported to GGZBOT
    BHJTW - 28-09-2012 .. ported to FBFBOT





| 

commands
--------
| 


    :commands in this plugin: irccat-cfg .. irccat-delalias .. irccat-cfgdefined .. irccat_-listaliases .. irccat-cfgsave .. irccat-addalias .. irccat-enable .. irccat-disable

| 

1) *irccat-addalias .. [handle_irccat_add_alias]*

    :description: []

    :permissions: OPER

    :code: :ref:`fbf.plugs.extra.irccat_irccat-addalias_command`.

    :examples:

    ::

        <user> ;irccat-addalias #firebreath
        <output> #test will now receive irccat messages directed at #firebreath


2) *irccat-cfg .. [cfg]*

    :description:  the config (cfg) command. 

    :permissions: OPER

    :code: :ref:`fbf.lib.persistconfig_PersistConfig_class`.

    :examples:

    ::

        <user> ;irccat-cfg
        <output> options: botnames=['default-sxmpp'] .. cfile="docs/docrun/config/plugs/fbf.plugs.extra.irccat" .. datadir="docs/docrun/" .. dir="docs/docrun/config" .. enable=True .. filename="plugs/fbf.plugs.extra.irccat" .. hide=[] .. host="localhost" .. issaved=True .. jsondb=None .. logname="config/plugs/fbf.plugs.extra.irccat" .. modname="fbf.plugs.extra.irccat" .. origdir="docs/docrun" - 1 more


3) *irccat-cfgdefined .. [cfgdefined]*

    :description:  show defined attributes. 

    :permissions: OPER

    :code: :ref:`fbf.lib.persistconfig_PersistConfig_class`.

    :examples:

    ::

        <user> ;irccat-cfgdefined
4) *irccat-cfgsave .. [cfgsave]*

    :description:  save config. 

    :permissions: OPER

    :code: :ref:`fbf.lib.persistconfig_PersistConfig_class`.

    :examples:

    ::

        <user> ;irccat-cfgsave
5) *irccat-delalias .. [handle_irccat_del_alias]*

    :description: []

    :permissions: OPER

    :code: :ref:`fbf.plugs.extra.irccat_irccat-delalias_command`.

    :examples:

    ::

        <user> ;irccat-delalias #firebreath
6) *irccat-disable .. [handle_irccat_disable]*

    :description: []

    :permissions: OPER

    :code: :ref:`fbf.plugs.extra.irccat_irccat-disable_command`.

    :examples:

    ::

        <user> ;irccat-disable
7) *irccat-enable .. [handle_irccat_enable]*

    :description: []

    :permissions: OPER

    :code: :ref:`fbf.plugs.extra.irccat_irccat-enable_command`.

    :examples:

    ::

        <user> ;irccat-enable
8) *irccat_-listaliases .. [handle_irccat_list_aliases]*

    :description:  List all aliases defined for the current channel