.. _plugin:core: ==== CORE ==== | about ----- | :author: FeedBackLoop :contact: FREENODE/#fbf :distribution: core :license: | description ----------- | core bot commands. | commands -------- | :commands in this plugin: list .. version .. threads .. perm .. help-site .. loglevel .. help .. ping .. disabled .. statusline .. reboot .. help-plug .. encoding .. whatcommands .. apro .. descriptions .. stats .. commands .. loaded .. quit .. uptime .. whereis .. running .. topper .. versions | 1) *apro .. [handle_apro]* :description: arguments: - apropos (search) for commands. :permissions: USER .. GUEST :code: :ref:`fbf.plugs.core.core_apro_command`. :examples: :: ;apro com commands matching com: admin-commands, bug-comments, chan-allowcommand, chan-loudcommand, chan-removecommand, chan-silentcommand, commands, fisheye_commit_lookup_disable, fisheye_commit_lookup_enable, welcome, whatcommands 2) *commands .. [handle_commands]* :description: arguments: [] - show commands of plugin. :permissions: USER .. GUEST :code: :ref:`fbf.plugs.core.core_commands_command`. :examples: :: ;commands core no commands found for plugin core 3) *descriptions .. [handle_descriptions]* :description: no arguments - show descriptions of all plugins. :permissions: USER .. GUEST :code: :ref:`fbf.plugs.core.core_descriptions_command`. :examples: :: ;descriptions descriptions:
* 8b plugin (fbf.plugs.extra.8b) - run the eight ball.

* admin plugin (fbf.plugs.core.admin) - admin related commands. these commands are mainly for maintaining the bot.

* alarm plugin (fbf.plugs.extra.alarm) -
the alarm plugin allows for alarms that message the user giving the
command at a certain time or number of - 34 more 4) *disabled .. [handle_disabled]* :description: no arguments - show what plugins are disabled. :permissions: OPER .. USER .. GUEST :code: :ref:`fbf.plugs.core.core_disabled_command`. :examples: :: ;disabled disabled plugins: 5) *encoding .. [handle_encoding]* :description: no arguments - show default encoding. :permissions: USER .. GUEST :code: :ref:`fbf.plugs.core.core_encoding_command`. :examples: :: ;encoding default encoding is utf-8 6) *help .. [handle_help]* :description: arguments: [] - show help. :permissions: OPER .. USER .. GUEST :code: :ref:`fbf.plugs.core.core_help_command`. :examples: :: ;help rss-list help on rss-list command: no arguments - return list of available rss items. examples: rss-list
location: fbf.plugs.extra.rss
permissions: RSS, USER 7) *help-plug .. [handle_helpplug]* :description: arguments: - how help on plugin/command or show basic help msg. :permissions: USER .. GUEST :code: :ref:`fbf.plugs.core.core_help-plug_command`. :examples: :: ;help-plug available plugins: 8b, admin, alarm, alias, all, ask, autovoice, birthday, bugtracker, cfg, chan, chatlog, choice, colors, confluence, controlchar, core, count, data, dns, echo, feedback, fisheye, fleet, forward, gatekeeper, gcalc, geo, grep, hubbub, idle, ignore, imdb, infoitem, ipcalc, irc, irccat, jira, karma, kickban, koffie, learn, lists, lmgt, markov, misc, more, - 1 more see !help to get help on a plugin. :: ;help-plug misc help on plugin MISC:
misc commands. commands: 1: !source - no arguments - show where to fetch the bot source. - perms: ['USER', 'GUEST']
2: !test - no arguments - give test response. - perms: ['USER', 'GUEST'] 8) *help-site .. [handle_helpsite]* :description: arguments: - help commands that gives a url to the docs. :permissions: OPER .. USER .. GUEST :code: :ref:`fbf.plugs.core.core_help-site_command`. :examples: :: ;help documentation for fbfbot can be found at http:///docs/fbfbot see !list for loaded plugins and "!help plugin" for help on the plugin. :: ;help rss help on plugin RSS:
the rss mantra is of the following: 1) add a url with !rss-add 2) use !rss-start in the channel you want the feed to appear 3) run !rss-scan to see what tokens you can use .. add them with !rss-additem 4) change markup with !rss-addmarkup .. see !rss-markuplist - 1 more commands: 1: !rss-add - arguments: - add a rss item. - perms: USER
2: !rss-addchannel - arguments: [] [] [] - add a channel to rss item. - perms: ['OPER']
3: !rss-additem - arguments: - add an item (token) to a feeds tokens to be displayed, see rss-scan for a list of available tokens. - 11 more 9) *list .. [handle_available]* :description: no arguments - show available plugins .. to enable use !plug-enable. :permissions: USER .. GUEST :code: :ref:`fbf.plugs.core.core_list_command`. :examples: :: ;list available plugins: 8b, admin, alarm, alias, all, ask, autovoice, birthday, bugtracker, cfg, chan, chatlog, choice, colors, confluence, controlchar, core, count, data, dns, echo, feedback, fisheye, fleet, forward, gatekeeper, gcalc, geo, grep, hubbub, idle, ignore, imdb, infoitem, ipcalc, irc, irccat, jira, karma, kickban, koffie, learn, lists, lmgt, markov, misc, more, - 1 more 10) *loaded .. [handle_loaded]* :description: no arguments - show plugins in cache. :permissions: USER .. GUEST :code: :ref:`fbf.plugs.core.core_loaded_command`. :examples: :: ;loaded loaded plugins (cache): 8b, admin, alarm, alias, all, ask, autovoice, birthday, botevent, bugtracker, cfg, chan, chatlog, choice, colors, confluence, controlchar, core, core, count, data, db, dispatch, dns, echo, extra, feedback, fisheye, fleet, forward, gatekeeper, gcalc, geo, github, grep, hubbub, idle, ignore, imdb, infoitem, ipcalc, irc, irccat, jira, karma, kickban, - 2 more 11) *loglevel .. [handle_loglevel]* :description: arguments: - change loglevel of the bot. loglevel is on of debug, info, warn or error. :permissions: OPER :code: :ref:`fbf.plugs.core.core_loglevel_command`. :examples: :: ;loglevel warn done - loglevel 12) *perm .. [handle_perm]* :description: arguments: - get permission of command. :permissions: USER .. GUEST :code: :ref:`fbf.plugs.core.core_perm_command`. :examples: :: ;perm quit quit command needs ['OPER'] permission 13) *ping .. [handle_ping]* :description: [] :permissions: OPER .. USER :code: :ref:`fbf.plugs.core.core_ping_command`. :examples: :: ;ping pong 14) *quit .. [handle_quit]* :description: no arguments - disconnect from the server. :permissions: OPER :code: :ref:`fbf.plugs.core.core_quit_command`. 15) *reboot .. [handle_reboot]* :description: no arguments - reboot the bot. :permissions: OPER :code: :ref:`fbf.plugs.core.core_reboot_command`. 16) *running .. [handle_running]* :description: no arguments - show running tasks. :permissions: USER .. GUEST :code: :ref:`fbf.plugs.core.core_running_command`. :examples: :: ;running runners: api: [], callback: ['chatlogcb', 'relaycallback', 'forwardoutcb'], cmnd: [], long: [], thread: [], url: [], wait: [] 17) *stats .. [handle_stats]* :description: [] :permissions: OPER .. USER :code: :ref:`fbf.plugs.core.core_stats_command`. :examples: :: ;stats stats results from 1 modules: Runner: 15, init_threaded: 15 :: ;stats rss stats results from 0 modules: 18) *statusline .. [handle_statusline]* :description: no arguments - show a status line. :permissions: USER .. GUEST :code: :ref:`fbf.plugs.core.core_statusline_command`. :examples: :: ;statusline controlchars: ! - perms: OPER, USER, QUOTE, MAIL, GUEST 19) *threads .. [handle_threads]* :description: no arguments - show running threads. :permissions: USER .. GUEST :code: :ref:`fbf.plugs.core.core_threads_command`. :examples: :: ;threads BotEventRunner = 5, IRCBot.start = 1, MainThread = 1, TCPServer.serve_forever = 1, TickLoop = 1, gendoc = 7 20) *topper .. [handle_topper]* :description: no arguments - show a 'topper' startus line. :permissions: USER .. GUEST :code: :ref:`fbf.plugs.core.core_topper_command`. :examples: :: ;topper forwards: none - watched: - feeds: none 21) *uptime .. [handle_uptime]* :description: no arguments - show uptime. :permissions: USER .. GUEST :code: :ref:`fbf.plugs.core.core_uptime_command`. :examples: :: ;uptime uptime is 22 seconds 22) *version .. [handle_version]* :description: no arguments - show bot's version. :permissions: USER .. GUEST :code: :ref:`fbf.plugs.core.core_version_command`. :examples: :: ;version FBFBOT version 0.2 DEVELOPMENT BASE SQLITE 23) *versions .. [handle_versions]* :description: no arguments - show versions of all loaded modules (if available). :permissions: USER .. GUEST :code: :ref:`fbf.plugs.core.core_versions_command`. :examples: :: ;versions versions ==> {'fbf.contrib.bs4': '4.0.1', 'fbf.plugs.extra.spider': '0.2', 'fbf.plugs.extra.mpd': '2007111601', 'python': '3.2.3 (default, Sep 10 2012, 18:14:40) \n[GCC 4.6.3]', 'fbf.api.hooks': '0.1', 'fbf.contrib.feedparser': '5.1.1', 'fbf.version': '0.2', 'fbf.plugs.extra.ipcalc': '0.2a', 'fbf.lib': '0.5.0', 'fbf.lib.container': '1', 'fbf.contrib.tweepy': '1.4'} 24) *whatcommands .. [handle_whatcommands]* :description: arguments: ;whatcommands USER commands known for permission USER: 8b, @, age, alarm, alarm-mylist, alias, alias-del, alias-search, all, apro, ask, ask-experts, ask-join, ask-list, ask-part, ask-stop, ask-subjects, bd, bd-del, bd-set, beledig, bier, bug, bug-comments, bug-list, cc, cfg, cfg-set, chan-disable, chan-enable, chan-list, chatlog-search, chatlog-stats, chips, choice, commands, confluence-wiki, - 6 more 25) *whereis .. [handle_whereis]* :description: arguments: - locate a command. :permissions: USER .. GUEST :code: :ref:`fbf.plugs.core.core_whereis_command`. :examples: :: ;whereis test test command is in: fbf.plugs.core.misc