.. _plugin:snarf:

=====
SNARF
=====
| 

about
-----
| 

:author:  Wijnand 'tehmaze' Modderman - http://tehmaze.com
:contact: FREENODE/#fbf
:distribution: core
:license:  

| 

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

 fetch title of url. 



| 

commands
--------
| 


    :commands in this plugin: @ .. snarf-cfgsave .. snarf-list .. snarf-cfgdefined .. snarf-enable .. snarf-disable .. validate .. snarf .. snarf-cfg

| 

1) *@ .. [handle_snarf]*

    :description:  snarf provided url or last url in log 
2) *snarf .. [handle_snarf]*

    :description:  snarf provided url or last url in log 

    :permissions: USER

    :code: :ref:`fbf.plugs.extra.snarf_snarf_command`.

    :examples:

    ::

        <user> ;snarf http://gozerbot.org
        <output> gozerbot.org: WELCOME TO GOZERBOT &mdash; GOZERBOT v1.0.1 FINAL documentation


3) *snarf-cfg .. [cfg]*

    :description:  the config (cfg) command. 

    :permissions: OPER

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

    :examples:

    ::

        <user> ;snarf-cfg
        <output> options: allow=['text/plain', 'text/html', 'application/xml'] .. cfile="docs/docrun/config/plugs/fbf.plugs.extra.snarf" .. datadir="docs/docrun/" .. dir="docs/docrun/config" .. filename="plugs/fbf.plugs.extra.snarf" .. hide=[] .. issaved=True .. jsondb=None .. logname="config/plugs/fbf.plugs.extra.snarf" .. modname="fbf.plugs.extra.snarf" .. origdir="docs/docrun" .. origname="plugs/fbf.plugs.extra.snarf" - 1 more


4) *snarf-cfgdefined .. [cfgdefined]*

    :description:  show defined attributes. 

    :permissions: OPER

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

    :examples:

    ::

        <user> ;snarf-cfgdefined
        <output> cfg has the following options defined: allow, cfile, datadir, dir, filename, hide, issaved, jsondb, logname, modname, origdir, origname, plugname, port, uuid


5) *snarf-cfgsave .. [cfgsave]*

    :description:  save config. 

    :permissions: OPER

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

    :examples:

    ::

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


6) *snarf-disable .. [handle_snarf_disable]*

    :description:  disable snarfing in channel 

    :permissions: OPER

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

    :examples:

    ::

        <user> ;snarf-disable
        <output> ok


7) *snarf-enable .. [handle_snarf_enable]*

    :description:  enable snarfing in channel 

    :permissions: OPER

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

    :examples:

    ::

        <user> ;snarf-enable
        <output> ok


8) *snarf-list .. [handle_snarf_list]*

    :description:  show channels in which snarfing is enabled 

    :permissions: OPER

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

    :examples:

    ::

        <user> ;snarf-list
        <output> snarfers enable on: :


9) *validate .. [handle_validate]*

    :description:  validate provided url or last url in log 

    :permissions: USER

    :code: :ref:`fbf.plugs.extra.snarf_validate_command`.

    :examples:

    ::

        <user> ;validate http://gozerbot.org
        <output> gozerbot.org: (unknown) | modified: Tue, 25 Sep 2012 23:02:49 GMT | server: Apache/1.3.42 (Unix) | size: 3526 | content-type: text/html | encoding: utf-8 | doctype: XHTML 1.0 Transitional