kdb.plugins.help module

Help Messages

This plugin allows the user to get help for command of other plugins. It retrieves the __doc__ of the specified command.

class kdb.plugins.help.Commands(*args, **kwargs)

Bases: circuits.core.components.Component

channel = 'commands'

commands(source, target, args)

Display a list of commands for a given plugin or all plugins.

Syntax: COMMANDS [<plugin>]

help(source, target, args)

Display help for the given command or plugin.

Syntax: HELP [<command>] | [<plugin>]

info(source, target, args)

Display info for the given plugin.

Syntax: INFO <plugin>

class kdb.plugins.help.Help(*args, **kwargs)

Bases: kdb.plugin.BasePlugin

Help plugin

Provides commands to display helpful infomration about other plugins and their commands. See: commands help

init(*args, **kwargs)

kdb.plugins.help.format_msg(msg)

kdb.plugins.help.get_command_help(plugin, command)

kdb.plugins.help.get_plugin_help(plugin)