.. _plugin:kickban:

=======
KICKBAN
=======
| 

about
-----
| 

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

| 

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

 kickban functionality for IRC. 



| 

commands
--------
| 


    :commands in this plugin: ban-add .. ban-remove .. ban-kickban .. ban-list

| 

1) *ban-add .. [handle_ban_add]*

    :description:  arguments: <nick> - add a ban. 

    :permissions: OPER

    :code: :ref:`fbf.plugs.extra.kickban_ban-add_command`.

    :examples:

    ::

        <user> ;ban-add *!*@lamers.are.us
        <output> can not get userhost of *!*@lamers.are.us


2) *ban-kickban .. [handle_kickban_add]*

    :description:  arguments: <nick> [<reason>] - add a kickban. 

    :permissions: OPER

    :code: :ref:`fbf.plugs.extra.kickban_ban-kickban_command`.

    :examples:

    ::

        <user> ;ban-kickban Lam0r Get out of here
        <output> can not get userhost of Lam0r


3) *ban-list .. [handle_ban_list]*

    :description:  no arguments - list all bans. 

    :permissions: OPER

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

    :examples:

    ::

        <user> ;ban-list
        <output> the ban list for #test is empty


4) *ban-remove .. [handle_ban_remove]*

    :description:  arguments: <banlistindex> - remove a ban. 

    :permissions: OPER

    :code: :ref:`fbf.plugs.extra.kickban_ban-remove_command`.

    :examples:

    ::

        <user> ;ban-remove 1
        <output> ban index out of range