.. _plugin:controlchar:

===========
CONTROLCHAR
===========
| 

about
-----
| 

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

| 

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


    command to control the control (command) characters. The cc is a string 
    containing the allowed control characters.





| 

commands
--------
| 


    :commands in this plugin: cc-del .. cc .. cc-add

| 

1) *cc .. [handle_cc]*

    :description:  arguments: [<controlchar>] - set/get control character of channel. 

    :permissions: USER

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

    :examples:

    ::

        <user> ;cc !
        <output> control char set to !



    ::

        <user> ;cc
        <output> controlchar are/is !;


2) *cc-add .. [handle_ccadd]*

    :description:  arguments: <character> - add a control char to the channels cc list. 

    :permissions: OPER

    :code: :ref:`fbf.plugs.core.controlchar_cc-add_command`.

    :examples:

    ::

        <user> ;cc-add #
        <output> control char # added


3) *cc-del .. [handle_ccdel]*

    :description:  arguments: <character> - remove a control char from the channels cc list. 

    :permissions: OPER

    :code: :ref:`fbf.plugs.core.controlchar_cc-del_command`.

    :examples:

    ::

        <user> ;cc-del #
        <output> control char # deleted