Skip to content

Supybot Website

Sections
Personal tools
You are here: Home » Documentation » Supybot Help Center » Tutorials » Getting started with Supybot » Listing commands

Listing commands

Document Actions
How can I know what my Supybot can do?

ali

An introductory document for those of you just starting out with Supybot. You should have the bot installed before reading this.
Page 3 of 7.

Ok, so let's assume your bot connected to the server and joined the channels you told it to join. For now we'll assume you named your bot supybot (you probably didn't, but it'll make it much clearer in the examples that follow to assume that you did). We'll also assume that you told it to join #channel (a nice generic name for a channel, isn't it? :)) So what do you do with this bot that you just made to join your channel? Try this in the channel:

  supybot: list

Replacing supybot with the actual name you picked for your bot, of course. Your bot should reply with a list of the plugins he currently has loaded. At least Admin, Channel, Config, Misc, Owner, and User should be there; if you used supybot-wizard to create your configuration file you may have many more plugins loaded. The list command can also be used to list the commands in a given plugin:

  supybot: list Misc

will list all the commands in the Misc plugin. If you want to see the help for any command, just use the help command:

  supybot: help help
  supybot: help list
  supybot: help load

Sometimes more than one plugin will have a given command; for instance, the "list" command exists in both the Misc and Config plugins (both loaded by default). List, in this case, defaults to the Misc plugin, but you may want to get the help for the list command in the Config plugin. In that case, you'll want to give your command like this:

  supybot: help config list

Anytime your bot tells you that a given command is defined in several plugins, you'll want to use this syntax ("plugin command") to disambiguate which plugin's command you wish to call. For instance, if you wanted to call the Config plugin's list command, then you'd need to say:

  supybot: config list

Rather than just list.

Created by ali
Last modified 13:21 February 06, 2005
 

Powered by Plone

This site conforms to the following standards: