.. _plugin:chatlog:

=======
CHATLOG
=======
| 

about
-----
| 

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

| 

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

 log channels to [hour:min] <nick> txt format, only logging to files is supported right now.  



| 

commands
--------
| 


    :commands in this plugin: chatlog-cfgdefined .. chatlog-stats .. chatlog-cfgsave .. chatlog-cfg .. chatlog-off .. chatlog-on .. chatlog-search

| 

1) *chatlog-cfg .. [cfg]*

    :description:  the config (cfg) command. 

    :permissions: OPER

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

    :examples:

    ::

        <user> ;chatlog-cfg
        <output> options: backend="log" .. basepath="docs/docrun" .. cfile="docs/docrun/config/plugs/fbf.plugs.extra.chatlog" .. channels=[['testbot', '#test']] .. datadir="docs/docrun/" .. dir="docs/docrun/config" .. filename="plugs/fbf.plugs.extra.chatlog" .. format="log" .. hide=[] .. issaved=True .. jsondb=None .. logname="config/plugs/fbf.plugs.extra.chatlog" .. modname="fbf.plugs.extra.chatlog" - 1 more


2) *chatlog-cfgdefined .. [cfgdefined]*

    :description:  show defined attributes. 

    :permissions: OPER

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

    :examples:

    ::

        <user> ;chatlog-cfgdefined
        <output> cfg has the following options defined: backend, basepath, cfile, channels, datadir, dir, filename, format, hide, issaved, jsondb, logname, modname, nologmsg, nologprefix, origdir, origname, plugname, port, uuid


3) *chatlog-cfgsave .. [cfgsave]*

    :description:  save config. 

    :permissions: OPER

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

    :examples:

    ::

        <user> ;chatlog-cfgsave
        <output> config saved


4) *chatlog-off .. [handle_chatlogoff]*

    :description:  no arguments - disable chatlog. 

    :permissions: OPER

    :code: :ref:`fbf.plugs.extra.chatlog_chatlog-off_command`.

    :examples:

    ::

        <user> ;chatlog-off
        <output> chatlog disabled on (testbot,#test)


5) *chatlog-on .. [handle_chatlogon]*

    :description:  no arguments - enable chatlog. 

    :permissions: OPER

    :code: :ref:`fbf.plugs.extra.chatlog_chatlog-on_command`.

    :examples:

    ::

        <user> ;chatlog-on
        <output> chatlog enabled on (testbot,#test)


6) *chatlog-search .. [handle_chatlogsearch]*

    :description:  arguments: <searchtxt> - search in the logs. 

    :permissions: OPER .. USER .. GUEST

    :code: :ref:`fbf.plugs.extra.chatlog_chatlog-search_command`.

    :examples:

    ::

        <user> ;chatlog-search fbfbot
        <output> no result found for #test


7) *chatlog-stats .. [handle_chatlogstats]*

    :description:  no arguments - create log stats of the channel, possible options: --chan <channel> 

    :permissions: OPER .. USER .. GUEST

    :code: :ref:`fbf.plugs.extra.chatlog_chatlog-stats_command`.

    :examples:

    ::

        <user> ;chatlog-stats
        <output> creating stats for channel #test (Thu Jan 1 01:00:00 1970)
        <output> no result found for #test