.. _plugin:watcher:

=======
WATCHER
=======
| 

about
-----
| 

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

| 

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

 watch channels. channels events can be of remote origin. 



| 

commands
--------
| 


    :commands in this plugin: watcher-start .. watcher-list .. watcher-subscribers .. watch .. watcher-stop .. watcher-reset

| 

1) *watch .. [handle_watcherstart]*

    :description:  arguments: [<channel>] - start watching a target (channel/wave). 
2) *watcher-list .. [handle_watcherlist]*

    :description:  no arguments - see what channels we are watching. 

    :permissions: OPER .. USER .. GUEST

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

    :examples:

    ::

        <user> ;watcher-list
        <output> channels watched on #test: <channel>


3) *watcher-reset .. [handle_watcherreset]*

    :description:  no arguments - reset all watcher for a channel. 

    :permissions: OPER .. USER .. GUEST

    :code: :ref:`fbf.plugs.extra.watcher_watcher-reset_command`.

    :examples:

    ::

        <user> ;watcher-reset
        <output> done - watcher-reset


4) *watcher-start .. [handle_watcherstart]*

    :description:  arguments: [<channel>] - start watching a target (channel/wave). 

    :permissions: OPER

    :code: :ref:`fbf.plugs.extra.watcher_watcher-start_command`.

    :examples:

    ::

        <user> ;watcher-start <channel>
        <output> done - watcher-start


5) *watcher-stop .. [handle_watcherstop]*

    :description:  arguments: [<channel>] - stop watching a channel. 

    :permissions: OPER .. USER .. GUEST

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

    :examples:

    ::

        <user> ;watcher-stop #dunkbots
        <output> error removing watcher: '#dunkbots'


6) *watcher-subscribers .. [handle_watchersubscribers]*

    :description: " no arguments - show channels that are watching us. 

    :permissions: OPER .. USER .. GUEST

    :code: :ref:`fbf.plugs.extra.watcher_watcher-subscribers_command`.

    :examples:

    ::

        <user> ;watcher-list
        <output> channels watched on #test: <channel>