Mikaela/Limnoria
1
0
Fork 0
mirror of https://github.com/Mikaela/Limnoria.git synced 2024-11-22 10:29:25 +01:00
Code Issues Projects Releases Wiki Activity

supybot-plugin-doc: Add labels for all command and config variables

Browse Source 
So they can be referenced from elsewhere in the doc.
This commit is contained in:
Valentin Lorentz 2021-04-05 22:56:40 +02:00
parent 4fc6580a09
commit cd02444f87
61 changed files with 1126 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
plugins/Admin/README.rst
View File

@ -14,35 +14,57 @@ This plugin provides access to administrative commands, such as
adding capabilities, managing ignore lists, and joining channels.
This is a core Supybot plugin that should not be removed!
.. _commands-Admin:
Commands
--------
.. _command-Admin-acmd:
acmd <command> [<arg> ...]
Perform <command> (with associated <arg>s on all channels on current network.
.. _command-Admin-capability.add:
capability add <name|hostmask> <capability>
Gives the user specified by <name> (or the user to whom <hostmask> currently maps) the specified capability <capability>
.. _command-Admin-capability.remove:
capability remove <name|hostmask> <capability>
Takes from the user specified by <name> (or the user to whom <hostmask> currently maps) the specified capability <capability>
.. _command-Admin-channels:
channels takes no arguments
Returns the channels the bot is on.
.. _command-Admin-clearq:
clearq takes no arguments
Clears the current send queue for this network.
.. _command-Admin-ignore.add:
ignore add <hostmask|nick> [<expires>]
This will set a persistent ignore on <hostmask> or the hostmask currently associated with <nick>. <expires> is an optional argument specifying when (in "seconds from now") the ignore will expire; if it isn't given, the ignore will never automatically expire.
.. _command-Admin-ignore.list:
ignore list takes no arguments
Lists the hostmasks that the bot is ignoring.
.. _command-Admin-ignore.remove:
ignore remove <hostmask|nick>
This will remove the persistent ignore on <hostmask> or the hostmask currently associated with <nick>.
.. _command-Admin-join:
join <channel> [<key>]
Tell the bot to join the given channel. If <key> is given, it is used when attempting to join the channel.
.. _command-Admin-nick:
nick [<nick>] [<network>]
Changes the bot's nick to <nick>. If no nick is given, returns the bot's current nick.

20
plugins/Aka/README.rst
View File

@ -72,32 +72,52 @@ Note that if the nested commands being aliased hadn't been quoted, then
those commands would have been run immediately, and ``@lastfm`` would always
reply with the same information, the result of those commands.
.. _commands-Aka:
Commands
--------
.. _command-Aka-add:
add [--channel <#channel>] <name> <command>
Defines an alias <name> that executes <command>. The <command> should be in the standard "command argument [nestedcommand argument]" arguments to the alias; they'll be filled with the first, second, etc. arguments. $1, $2, etc. can be used for required arguments. @1, @2, etc. can be used for optional arguments. $* simply means "all arguments that have not replaced $1, $2, etc.", ie. it will also include optional arguments.
.. _command-Aka-remove:
remove [--channel <#channel>] <name>
Removes the given alias, if unlocked.
.. _command-Aka-lock:
lock [--channel <#channel>] <alias>
Locks an alias so that no one else can change it.
.. _command-Aka-unlock:
unlock [--channel <#channel>] <alias>
Unlocks an alias so that people can define new aliases over it.
.. _command-Aka-importaliasdatabase:
importaliasdatabase takes no arguments
Imports the Alias database into Aka's, and clean the former.
.. _command-Aka-show:
show [--channel <#channel>] <alias>
This command shows the content of an Aka.
.. _command-Aka-list:
list [--channel <#channel>] [--keys] [--unlocked|--locked]
Lists all Akas defined for <channel>. If <channel> is not specified, lists all global Akas. If --keys is given, lists only the Aka names and not their commands.
.. _command-Aka-set:
set [--channel <#channel>] <name> <command>
Overwrites an existing alias <name> to execute <command> instead. The <command> should be in the standard "command argument [nestedcommand argument]" arguments to the alias; they'll be filled with the first, second, etc. arguments. $1, $2, etc. can be used for required arguments. @1, @2, etc. can be used for optional arguments. $* simply means "all arguments that have not replaced $1, $2, etc.", ie. it will also include optional arguments.
.. _command-Aka-search:
search [--channel <#channel>] <query>
Searches Akas defined for <channel>. If <channel> is not specified, searches all global Akas.

12
plugins/Alias/README.rst
View File

@ -32,20 +32,32 @@ Note that if the nested commands being aliased hadn't been quoted, then
those commands would have been run immediately, and `@lastfm` would always
reply with the same information, the result of those commands.
.. _commands-Alias:
Commands
--------
.. _command-Alias-add:
add <name> <command>
Defines an alias <name> that executes <command>. The <command> should be in the standard "command argument [nestedcommand argument]" arguments to the alias; they'll be filled with the first, second, etc. arguments. $1, $2, etc. can be used for required arguments. @1, @2, etc. can be used for optional arguments. $* simply means "all remaining arguments," and cannot be combined with optional arguments.
.. _command-Alias-list:
list [--locked|--unlocked]
Lists alias names of a particular type, defaults to all aliases if no --locked or --unlocked option is given.
.. _command-Alias-lock:
lock <alias>
Locks an alias so that no one else can change it.
.. _command-Alias-remove:
remove <name>
Removes the given alias, if unlocked.
.. _command-Alias-unlock:
unlock <alias>
Unlocks an alias so that people can define new aliases over it.

10
plugins/Anonymous/README.rst
View File

@ -44,17 +44,27 @@ This
* Note that you won't see the messages that are sent to the bot.
.. _commands-Anonymous:
Commands
--------
.. _command-Anonymous-do:
do <channel> <action>
Performs <action> in <channel>.
.. _command-Anonymous-react:
react <channel> <reaction> <nick>
Sends the <reaction> to <nick>'s last message. <reaction> is typically a smiley or an emoji. This may not be supported on the current network, as this command depends on IRCv3 features. This is also not supported if supybot.protocols.irc.experimentalExtensions disabled (don't enable it unless you know what you are doing).
.. _command-Anonymous-say:
say <channel> <text>
Sends <text> to <channel>.
.. _command-Anonymous-tell:
tell <nick> <text>
Sends <text> to <nick>. Can only be used if supybot.plugins.Anonymous.allowPrivateTarget is True.

8
plugins/BadWords/README.rst
View File

@ -16,14 +16,22 @@ Maintains a list of words that the bot is not allowed to say.
Can also be used to kick people that say these words, if the bot
has op.
.. _commands-BadWords:
Commands
--------
.. _command-BadWords-add:
add <word> [<word> ...]
Adds all <word>s to the list of words being censored.
.. _command-BadWords-list:
list takes no arguments
Returns the list of words being censored.
.. _command-BadWords-remove:
remove <word> [<word> ...]
Removes <word>s from the list of words being censored.

80
plugins/Channel/README.rst
View File

@ -14,122 +14,202 @@ This plugin provides various commands for channel management, such
as setting modes and channel-wide bans/ignores/capabilities. This is
a core Supybot plugin that should not be removed!
.. _commands-Channel:
Commands
--------
.. _command-Channel-alert:
alert [<channel>] <text>
Sends <text> to all the users in <channel> who have the <channel>,op capability.
.. _command-Channel-ban.add:
ban add [<channel>] <nick|hostmask> [<expires>]
If you have the #channel,op capability, this will effect a persistent ban from interacting with the bot on the given <hostmask> (or the current hostmask associated with <nick>). Other plugins may enforce this ban by actually banning users with matching hostmasks when they join. <expires> is an optional argument specifying when (in "seconds from now") the ban should expire; if none is given, the ban will never automatically expire. <channel> is only necessary if the message isn't sent in the channel itself.
.. _command-Channel-ban.hostmask:
ban hostmask [<channel>] <banmask>
Bans the <banmask> from the <channel>.
.. _command-Channel-ban.list:
ban list [<channel>] [<mask>]
If you have the #channel,op capability, this will show you the current persistent bans on the <channel> that match the given mask, if any (returns all of them otherwise). Note that you can use * as a wildcard on masks and \* to match actual * in masks
.. _command-Channel-ban.remove:
ban remove [<channel>] <hostmask>
If you have the #channel,op capability, this will remove the persistent ban on <hostmask>. <channel> is only necessary if the message isn't sent in the channel itself.
.. _command-Channel-capability.add:
capability add [<channel>] <nick|username> <capability> [<capability> ...]
If you have the #channel,op capability, this will give the <username> (or the user to whom <nick> maps) the capability <capability> in the channel. <channel> is only necessary if the message isn't sent in the channel itself.
.. _command-Channel-capability.list:
capability list [<channel>]
Returns the capabilities present on the <channel>. <channel> is only necessary if the message isn't sent in the channel itself.
.. _command-Channel-capability.remove:
capability remove [<channel>] <name|hostmask> <capability> [<capability> ...]
If you have the #channel,op capability, this will take from the user currently identified as <name> (or the user to whom <hostmask> maps) the capability <capability> in the channel. <channel> is only necessary if the message isn't sent in the channel itself.
.. _command-Channel-capability.set:
capability set [<channel>] <capability> [<capability> ...]
If you have the #channel,op capability, this will add the channel capability <capability> for all users in the channel. <channel> is only necessary if the message isn't sent in the channel itself.
.. _command-Channel-capability.setdefault:
capability setdefault [<channel>] {True|False}
If you have the #channel,op capability, this will set the default response to non-power-related (that is, not {op, halfop, voice}) capabilities to be the value you give. <channel> is only necessary if the message isn't sent in the channel itself.
.. _command-Channel-capability.unset:
capability unset [<channel>] <capability> [<capability> ...]
If you have the #channel,op capability, this will unset the channel capability <capability> so each user's specific capability or the channel default capability will take precedence. <channel> is only necessary if the message isn't sent in the channel itself.
.. _command-Channel-cycle:
cycle [<channel>] [<reason>]
If you have the #channel,op capability, this will cause the bot to "cycle", or PART and then JOIN the channel. <channel> is only necessary if the message isn't sent in the channel itself. If <reason> is not specified, the default part message specified in supybot.plugins.Channel.partMsg will be used. No part message will be used if neither a cycle reason nor a default part message is given.
.. _command-Channel-dehalfop:
dehalfop [<channel>] [<nick> ...]
If you have the #channel,op capability, this will remove half-operator privileges from all the nicks given. If no nicks are given, removes half-operator privileges from the person sending the message.
.. _command-Channel-deop:
deop [<channel>] [<nick> ...]
If you have the #channel,op capability, this will remove operator privileges from all the nicks given. If no nicks are given, removes operator privileges from the person sending the message.
.. _command-Channel-devoice:
devoice [<channel>] [<nick> ...]
If you have the #channel,op capability, this will remove voice from all the nicks given. If no nicks are given, removes voice from the person sending the message.
.. _command-Channel-disable:
disable [<channel>] [<plugin>] [<command>]
If you have the #channel,op capability, this will disable the <command> in <channel>. If <plugin> is provided, <command> will be disabled only for that plugin. If only <plugin> is provided, all commands in the given plugin will be disabled. <channel> is only necessary if the message isn't sent in the channel itself.
.. _command-Channel-enable:
enable [<channel>] [<plugin>] [<command>]
If you have the #channel,op capability, this will enable the <command> in <channel> if it has been disabled. If <plugin> is provided, <command> will be enabled only for that plugin. If only <plugin> is provided, all commands in the given plugin will be enabled. <channel> is only necessary if the message isn't sent in the channel itself.
.. _command-Channel-halfop:
halfop [<channel>] [<nick> ...]
If you have the #channel,halfop capability, this will give all the <nick>s you provide halfops. If you don't provide any <nick>s, this will give you halfops. <channel> is only necessary if the message isn't sent in the channel itself.
.. _command-Channel-iban:
iban [<channel>] [--{exact,nick,user,host}] <nick> [<seconds>]
If you have the #channel,op capability, this will ban <nick> for as many seconds as you specify, otherwise (if you specify 0 seconds or don't specify a number of seconds) it will ban the person indefinitely. --exact can be used to specify an exact hostmask. You can combine the exact, nick, user, and host options as you choose. <channel> is only necessary if the message isn't sent in the channel itself.
.. _command-Channel-ignore.add:
ignore add [<channel>] <nick|hostmask> [<expires>]
If you have the #channel,op capability, this will set a persistent ignore on <hostmask> or the hostmask currently associated with <nick>. <expires> is an optional argument specifying when (in "seconds from now") the ignore will expire; if it isn't given, the ignore will never automatically expire. <channel> is only necessary if the message isn't sent in the channel itself.
.. _command-Channel-ignore.list:
ignore list [<channel>]
Lists the hostmasks that the bot is ignoring on the given channel. <channel> is only necessary if the message isn't sent in the channel itself.
.. _command-Channel-ignore.remove:
ignore remove [<channel>] <nick|hostmask>
If you have the #channel,op capability, this will remove the persistent ignore on <hostmask> in the channel. <channel> is only necessary if the message isn't sent in the channel itself.
.. _command-Channel-invite:
invite [<channel>] <nick>
If you have the #channel,op capability, this will invite <nick> to join <channel>. <channel> is only necessary if the message isn't sent in the channel itself.
.. _command-Channel-kban:
kban [<channel>] [--{exact,nick,user,host}] <nick> [<seconds>] [<reason>]
If you have the #channel,op capability, this will kickban <nick> for as many seconds as you specify, or else (if you specify 0 seconds or don't specify a number of seconds) it will ban the person indefinitely. --exact bans only the exact hostmask; --nick bans just the nick; --user bans just the user, and --host bans just the host. You can combine these options as you choose. <reason> is a reason to give for the kick. <channel> is only necessary if the message isn't sent in the channel itself.
.. _command-Channel-key:
key [<channel>] [<key>]
Sets the keyword in <channel> to <key>. If <key> is not given, removes the keyword requirement to join <channel>. <channel> is only necessary if the message isn't sent in the channel itself.
.. _command-Channel-kick:
kick [<channel>] <nick>[, <nick>, ...] [<reason>]
Kicks <nick>(s) from <channel> for <reason>. If <reason> isn't given, uses the nick of the person making the command as the reason. <channel> is only necessary if the message isn't sent in the channel itself.
.. _command-Channel-limit:
limit [<channel>] [<limit>]
Sets the channel limit to <limit>. If <limit> is 0, or isn't given, removes the channel limit. <channel> is only necessary if the message isn't sent in the channel itself.
.. _command-Channel-listbans:
listbans [<channel>]
List all bans on the channel. If <channel> is not given, it defaults to the current channel.
.. _command-Channel-lobotomy.add:
lobotomy add [<channel>]
If you have the #channel,op capability, this will "lobotomize" the bot, making it silent and unanswering to all requests made in the channel. <channel> is only necessary if the message isn't sent in the channel itself.
.. _command-Channel-lobotomy.list:
lobotomy list takes no arguments
Returns the channels in which this bot is lobotomized.
.. _command-Channel-lobotomy.remove:
lobotomy remove [<channel>]
If you have the #channel,op capability, this will unlobotomize the bot, making it respond to requests made in the channel again. <channel> is only necessary if the message isn't sent in the channel itself.
.. _command-Channel-mode:
mode [<channel>] <mode> [<arg> ...]
Sets the mode in <channel> to <mode>, sending the arguments given. <channel> is only necessary if the message isn't sent in the channel itself.
.. _command-Channel-moderate:
moderate [<channel>]
Sets +m on <channel>, making it so only ops and voiced users can send messages to the channel. <channel> is only necessary if the message isn't sent in the channel itself.
.. _command-Channel-nicks:
nicks [<channel>] [--count]
Returns the nicks in <channel>. <channel> is only necessary if the message isn't sent in the channel itself. Returns only the number of nicks if --count option is provided.
.. _command-Channel-op:
op [<channel>] [<nick> ...]
If you have the #channel,op capability, this will give all the <nick>s you provide ops. If you don't provide any <nick>s, this will op you. <channel> is only necessary if the message isn't sent in the channel itself.
.. _command-Channel-part:
part [<channel>] [<reason>]
Tells the bot to part the list of channels you give it. <channel> is only necessary if you want the bot to part a channel other than the current channel. If <reason> is specified, use it as the part message. Otherwise, the default part message specified in supybot.plugins.Channel.partMsg will be used. No part message will be used if no default is configured.
.. _command-Channel-unban:
unban [<channel>] [<hostmask|--all>]
Unbans <hostmask> on <channel>. If <hostmask> is not given, unbans any hostmask currently banned on <channel> that matches your current hostmask. Especially useful for unbanning yourself when you get unexpectedly (or accidentally) banned from the channel. <channel> is only necessary if the message isn't sent in the channel itself.
.. _command-Channel-unmoderate:
unmoderate [<channel>]
Sets -m on <channel>, making it so everyone can send messages to the channel. <channel> is only necessary if the message isn't sent in the channel itself.
.. _command-Channel-voice:
voice [<channel>] [<nick> ...]
If you have the #channel,voice capability, this will voice all the <nick>s you provide. If you don't provide any <nick>s, this will voice you. <channel> is only necessary if the message isn't sent in the channel itself.

8
plugins/ChannelStats/README.rst
View File

@ -14,14 +14,22 @@ Usage
This plugin keeps stats of the channel and returns them with
the command 'channelstats'.
.. _commands-ChannelStats:
Commands
--------
.. _command-ChannelStats-channelstats:
channelstats [<channel>]
Returns the statistics for <channel>. <channel> is only necessary if the message isn't sent on the channel itself.
.. _command-ChannelStats-rank:
rank [<channel>] <stat expression>
Returns the ranking of users according to the given stat expression. Valid variables in the stat expression include 'msgs', 'chars', 'words', 'smileys', 'frowns', 'actions', 'joins', 'parts', 'quits', 'kicks', 'kicked', 'topics', and 'modes'. Any simple mathematical expression involving those variables is permitted.
.. _command-ChannelStats-stats:
stats [<channel>] [<name>]
Returns the statistics for <name> on <channel>. <channel> is only necessary if the message isn't sent on the channel itself. If <name> isn't given, it defaults to the user sending the command.

38
plugins/Conditional/README.rst
View File

@ -17,59 +17,97 @@ This plugin provides logic operators and other commands that
enable you to run commands only if a condition is true. Useful for nested
commands and scripting.
.. _commands-Conditional:
Commands
--------
.. _command-Conditional-cand:
cand <cond1> [<cond2> ... <condN>]
Returns true if all conditions supplied evaluate to true.
.. _command-Conditional-ceq:
ceq <item1> <item2>
Does a string comparison on <item1> and <item2>. Returns true if they are equal.
.. _command-Conditional-cerror:
cerror <testcommand>
Runs <testcommand> and returns true if it raises an error; false otherwise.
.. _command-Conditional-cif:
cif <condition> <ifcommand> <elsecommand>
Runs <ifcommand> if <condition> evaluates to true, runs <elsecommand> if it evaluates to false. Use other logical operators defined in this plugin and command nesting to your advantage here.
.. _command-Conditional-cor:
cor <cond1> [<cond2> ... <condN>]
Returns true if any one of conditions supplied evaluates to true.
.. _command-Conditional-cxor:
cxor <cond1> [<cond2> ... <condN>]
Returns true if only one of conditions supplied evaluates to true.
.. _command-Conditional-ge:
ge <item1> <item2>
Does a string comparison on <item1> and <item2>. Returns true if <item1> is greater than or equal to <item2>.
.. _command-Conditional-gt:
gt <item1> <item2>
Does a string comparison on <item1> and <item2>. Returns true if <item1> is greater than <item2>.
.. _command-Conditional-le:
le <item1> <item2>
Does a string comparison on <item1> and <item2>. Returns true if <item1> is less than or equal to <item2>.
.. _command-Conditional-lt:
lt <item1> <item2>
Does a string comparison on <item1> and <item2>. Returns true if <item1> is less than <item2>.
.. _command-Conditional-match:
match [--case-insensitive] <item1> <item2>
Determines if <item1> is a substring of <item2>. Returns true if <item1> is contained in <item2>. Will only match case if --case-insensitive is not given.
.. _command-Conditional-nceq:
nceq <item1> <item2>
Does a numeric comparison on <item1> and <item2>. Returns true if they are equal.
.. _command-Conditional-ne:
ne <item1> <item2>
Does a string comparison on <item1> and <item2>. Returns true if they are not equal.
.. _command-Conditional-nge:
nge <item1> <item2>
Does a numeric comparison on <item1> and <item2>. Returns true if <item1> is greater than or equal to <item2>.
.. _command-Conditional-ngt:
ngt <item1> <item2>
Does a numeric comparison on <item1> and <item2>. Returns true if <item1> is greater than <item2>.
.. _command-Conditional-nle:
nle <item1> <item2>
Does a numeric comparison on <item1> and <item2>. Returns true if <item1> is less than or equal to <item2>.
.. _command-Conditional-nlt:
nlt <item1> <item2>
Does a numeric comparison on <item1> and <item2>. Returns true if <item1> is less than <item2>.
.. _command-Conditional-nne:
nne <item1> <item2>
Does a numeric comparison on <item1> and <item2>. Returns true if they are not equal.

30
plugins/Config/README.rst
View File

@ -12,47 +12,77 @@ Usage
Provides access to the Supybot configuration. This is
a core Supybot plugin that should not be removed!
.. _commands-Config:
Commands
--------
.. _command-Config-channel:
channel [<network>] [<channel>] <name> [<value>]
If <value> is given, sets the channel configuration variable for <name> to <value> for <channel> on the <network>. Otherwise, returns the current channel configuration value of <name>. <channel> is only necessary if the message isn't sent in the channel itself. More than one channel may be given at once by separating them with commas. <network> defaults to the current network.
.. _command-Config-config:
config <name> [<value>]
If <value> is given, sets the value of <name> to <value>. Otherwise, returns the current value of <name>. You may omit the leading "supybot." in the name if you so choose.
.. _command-Config-default:
default <name>
Returns the default value of the configuration variable <name>.
.. _command-Config-export:
export <filename>
Exports the public variables of your configuration to <filename>. If you want to show someone your configuration file, but you don't want that person to be able to see things like passwords, etc., this command will export a "sanitized" configuration file suitable for showing publicly.
.. _command-Config-help:
help <name>
Returns the description of the configuration variable <name>.
.. _command-Config-list:
list <group>
Returns the configuration variables available under the given configuration <group>. If a variable has values under it, it is preceded by an '@' sign. If a variable is a 'ChannelValue', that is, it can be separately configured for each channel using the 'channel' command in this plugin, it is preceded by an '#' sign. And if a variable is a 'NetworkValue', it is preceded by a ':' sign.
.. _command-Config-network:
network [<network>] <name> [<value>]
If <value> is given, sets the network configuration variable for <name> to <value> for <network>. Otherwise, returns the current network configuration value of <name>. <network> defaults to the current network.
.. _command-Config-reload:
reload takes no arguments
Reloads the various configuration files (user database, channel database, registry, etc.).
.. _command-Config-reset.channel:
reset channel [<network>] [<channel>] <name>
Resets the channel-specific value of variable <name>, so that it will match the network-specific value (or the global one if the latter isn't set). <network> and <channel> default to the current network and channel.
.. _command-Config-reset.network:
reset network [<network>] [<channel>] <name>
Resets the network-specific value of variable <name>, so that it will match the global. <network> defaults to the current network and channel.
.. _command-Config-search:
search <word>
Searches for <word> in the current configuration variables.
.. _command-Config-searchhelp:
searchhelp <phrase>
Searches for <phrase> in the help of current configuration variables.
.. _command-Config-searchvalues:
searchvalues <word>
Searches for <word> in the values of current configuration variables.
.. _command-Config-setdefault:
setdefault <name>
Resets the configuration variable <name> to its default value. Use commands 'reset channel' and 'reset network' instead to make a channel- or network- specific value inherit from the global one.

4
plugins/Ctcp/README.rst
View File

@ -16,8 +16,12 @@ to fetch version responses from channels.
Please note that the command `ctcp version` cannot receive any responses if the channel is
mode +C or similar which prevents CTCP requests to channel.
.. _commands-Ctcp:
Commands
--------
.. _command-Ctcp-version:
version [<channel>] [--nicks]
Sends a CTCP VERSION to <channel>, returning the various version strings returned. It waits for 10 seconds before returning the versions received at that point. If --nicks is given, nicks are associated with the version strings; otherwise, only the version strings are given.

4
plugins/DDG/README.rst
View File

@ -16,8 +16,12 @@ Example::
<+GLolol> %ddg search eiffel tower
<@Atlas> The Eiffel Tower is an iron lattice tower located on the Champ de Mars in Paris. It was named after the engineer Gustave Eiffel, whose company designed and built the tower. - <https://en.wikipedia.org/wiki/Eiffel_Tower>
.. _commands-DDG:
Commands
--------
.. _command-DDG-search:
search <text>
Searches for <text> on DuckDuckGo's web search.

22
plugins/Debug/README.rst
View File

@ -14,35 +14,57 @@ Usage
This plugin provides debugging abilities for Supybot. It
should not be loaded with a default installation.
.. _commands-Debug:
Commands
--------
.. _command-Debug-channeldb:
channeldb [<channel>]
Returns the result of the channeldb converter.
.. _command-Debug-collect:
collect [<times>]
Does <times> gc collections, returning the number of objects collected each time. <times> defaults to 1.
.. _command-Debug-environ:
environ takes no arguments
Returns the environment of the supybot process.
.. _command-Debug-eval:
eval <expression>
Evaluates <expression> (which should be a Python expression) and returns its value. If an exception is raised, reports the exception (and logs the traceback to the bot's logfile).
.. _command-Debug-exec:
exec <statement>
Execs <code>. Returns success if it didn't raise any exceptions.
.. _command-Debug-exn:
exn <exception name>
Raises the exception matching <exception name>.
.. _command-Debug-sendquote:
sendquote <raw IRC message>
Sends (not queues) the raw IRC message given.
.. _command-Debug-settrace:
settrace [<filename>]
Starts tracing function calls to <filename>. If <filename> is not given, sys.stdout is used. This causes much output.
.. _command-Debug-simpleeval:
simpleeval <expression>
Evaluates the given expression.
.. _command-Debug-unsettrace:
unsettrace takes no arguments
Stops tracing function calls on stdout.

10
plugins/Dict/README.rst
View File

@ -17,17 +17,27 @@ Usage
This plugin provides a function to look up words from different
dictionaries.
.. _commands-Dict:
Commands
--------
.. _command-Dict-dict:
dict [<dictionary>] <word>
Looks up the definition of <word> on the dictd server specified by the supybot.plugins.Dict.server config variable.
.. _command-Dict-dictionaries:
dictionaries takes no arguments
Returns the dictionaries valid for the dict command.
.. _command-Dict-random:
random takes no arguments
Returns a random valid dictionary.
.. _command-Dict-synonym:
synonym <word> [<word> ...]
Gets a random synonym from the Moby Thesaurus (moby-thesaurus) database. If given many words, gets a random synonym for each of them. Quote phrases to have them treated as one lookup word.

14
plugins/Dunno/README.rst
View File

@ -18,23 +18,37 @@ Basically, it replaces the standard 'Error: <x> is not a valid command.'
messages with messages kept in a database, able to give more personable
responses.
.. _commands-Dunno:
Commands
--------
.. _command-Dunno-add:
add [<channel>] <text>
Adds <text> to the dunno database for <channel>. <channel> is only necessary if the message isn't sent in the channel itself.
.. _command-Dunno-change:
change [<channel>] <id> <regexp>
Changes the dunno with id <id> according to the regular expression <regexp>. <channel> is only necessary if the message isn't sent in the channel itself.
.. _command-Dunno-get:
get [<channel>] <id>
Gets the dunno with id <id> from the dunno database for <channel>. <channel> is only necessary if the message isn't sent in the channel itself.
.. _command-Dunno-remove:
remove [<channel>] <id>
Removes the dunno with id <id> from the dunno database for <channel>. <channel> is only necessary if the message isn't sent in the channel itself.
.. _command-Dunno-search:
search [<channel>] [--{regexp,by} <value>] [<glob>]
Searches for dunnos matching the criteria given.
.. _command-Dunno-stats:
stats [<channel>]
Returns the number of dunnos in the database for <channel>. <channel> is only necessary if the message isn't sent in the channel itself.

24
plugins/Factoids/README.rst
View File

@ -12,38 +12,62 @@ Usage
-----
Provides the ability to show Factoids.
.. _commands-Factoids:
Commands
--------
.. _command-Factoids-alias:
alias [<channel>] <oldkey> <newkey> [<number>]
Adds a new key <newkey> for factoid associated with <oldkey>. <number> is only necessary if there's more than one factoid associated with <oldkey>. The same action can be accomplished by using the 'learn' function with a new key but an existing (verbatim) factoid content.
.. _command-Factoids-change:
change [<channel>] <key> <number> <regexp>
Changes the factoid #<number> associated with <key> according to <regexp>.
.. _command-Factoids-forget:
forget [<channel>] <key> [<number>|*]
Removes a key-fact relationship for key <key> from the factoids database. If there is more than one such relationship for this key, a number is necessary to determine which one should be removed. A * can be used to remove all relationships for <key>. If as a result, the key (factoid) remains without any relationships to a factoid (key), it shall be removed from the database. <channel> is only necessary if the message isn't sent in the channel itself.
.. _command-Factoids-info:
info [<channel>] <key>
Gives information about the factoid(s) associated with <key>. <channel> is only necessary if the message isn't sent in the channel itself.
.. _command-Factoids-learn:
learn [<channel>] <key> is <value>
Associates <key> with <value>. <channel> is only necessary if the message isn't sent on the channel itself. The word 'is' is necessary to separate the key from the value. It can be changed to another word via the learnSeparator registry value.
.. _command-Factoids-lock:
lock [<channel>] <key>
Locks the factoid(s) associated with <key> so that they cannot be removed or added to. <channel> is only necessary if the message isn't sent in the channel itself.
.. _command-Factoids-random:
random [<channel>]
Returns random factoids from the database for <channel>. <channel> is only necessary if the message isn't sent in the channel itself.
.. _command-Factoids-rank:
rank [<channel>] [--plain] [--alpha] [<number>]
Returns a list of top-ranked factoid keys, sorted by usage count (rank). If <number> is not provided, the default number of factoid keys returned is set by the rankListLength registry value. If --plain option is given, rank numbers and usage counts are not included in output. If --alpha option is given in addition to --plain, keys are sorted alphabetically, instead of by rank. <channel> is only necessary if the message isn't sent in the channel itself.
.. _command-Factoids-search:
search [<channel>] [--values] [--regexp <value>] [--author <username>] [<glob> ...]
Searches the keyspace for keys matching <glob>. If --regexp is given, its associated value is taken as a regexp and matched against the keys. If --values is given, search the value space instead of the keyspace.
.. _command-Factoids-unlock:
unlock [<channel>] <key>
Unlocks the factoid(s) associated with <key> so that they can be removed or added to. <channel> is only necessary if the message isn't sent in the channel itself.
.. _command-Factoids-whatis:
whatis [<channel>] [--raw] <key> [<number>]
Looks up the value of <key> in the factoid database. If given a number, will return only that exact factoid. If '--raw' option is given, no variable substitution will take place on the factoid. <channel> is only necessary if the message isn't sent in the channel itself.

10
plugins/Fediverse/README.rst
View File

@ -33,17 +33,27 @@ Usage
-----
Fetches information from ActivityPub servers.
.. _commands-Fediverse:
Commands
--------
.. _command-Fediverse-featured:
featured <@user@instance>
Returnes the featured statuses of @user@instance (aka. pinned toots).
.. _command-Fediverse-profile:
profile <@user@instance>
Returns generic information on the account @user@instance.
.. _command-Fediverse-status:
status <url>
Shows the content of the status at <url>.
.. _command-Fediverse-statuses:
statuses <@user@instance>
Returned the last statuses of @user@instance.

58
plugins/Filter/README.rst
View File

@ -22,89 +22,147 @@ output of the bot -- for instance, you could make everything the bot says
be in leetspeak, or Morse code, or any number of other kinds of filters.
Not very useful, but definitely quite fun :)
.. _commands-Filter:
Commands
--------
.. _command-Filter-aol:
aol <text>
Returns <text> as if an AOL user had said it.
.. _command-Filter-binary:
binary <text>
Returns the binary representation of <text>.
.. _command-Filter-caps:
caps <text>
EVERYONE LOVES CAPS LOCK.
.. _command-Filter-capwords:
capwords <text>
Capitalises the first letter of each word.
.. _command-Filter-colorize:
colorize <text>
Returns <text> with each character randomly colorized.
.. _command-Filter-gnu:
gnu <text>
Returns <text> as GNU/RMS would say it.
.. _command-Filter-hebrew:
hebrew <text>
Removes all the vowels from <text>. (If you're curious why this is named 'hebrew' it's because I (jemfinch) thought of it in Hebrew class, and printed Hebrew often elides the vowels.)
.. _command-Filter-hexlify:
hexlify <text>
Returns a hexstring from the given string; a hexstring is a string composed of the hexadecimal value of each character in the string
.. _command-Filter-jeffk:
jeffk <text>
Returns <text> as if JeffK had said it himself.
.. _command-Filter-leet:
leet <text>
Returns the l33tspeak version of <text>
.. _command-Filter-morse:
morse <text>
Gives the Morse code equivalent of a given string.
.. _command-Filter-outfilter:
outfilter [<channel>] [<command>]
Sets the outFilter of this plugin to be <command>. If no command is given, unsets the outFilter. <channel> is only necessary if the message isn't sent in the channel itself.
.. _command-Filter-rainbow:
rainbow <text>
Returns <text> colorized like a rainbow.
.. _command-Filter-reverse:
reverse <text>
Reverses <text>.
.. _command-Filter-rot13:
rot13 <text>
Rotates <text> 13 characters to the right in the alphabet. Rot13 is commonly used for text that simply needs to be hidden from inadvertent reading by roaming eyes, since it's easily reversible.
.. _command-Filter-scramble:
scramble <text>
Replies with a string where each word is scrambled; i.e., each internal letter (that is, all letters but the first and last) are shuffled.
.. _command-Filter-shrink:
shrink <text>
Returns <text> with each word longer than supybot.plugins.Filter.shrink.minimum being shrunken (i.e., like "internationalization" becomes "i18n").
.. _command-Filter-spellit:
spellit <text>
Returns <text>, phonetically spelled out.
.. _command-Filter-squish:
squish <text>
Removes all the spaces from <text>.
.. _command-Filter-stripcolor:
stripcolor <text>
Returns <text> stripped of all color codes.
.. _command-Filter-supa1337:
supa1337 <text>
Replies with an especially k-rad translation of <text>.
.. _command-Filter-unbinary:
unbinary <text>
Returns the character representation of binary <text>. Assumes ASCII, 8 digits per character.
.. _command-Filter-undup:
undup <text>
Returns <text>, with all consecutive duplicated letters removed.
.. _command-Filter-unhexlify:
unhexlify <hexstring>
Returns the string corresponding to <hexstring>. Obviously, <hexstring> must be a string of hexadecimal digits.
.. _command-Filter-uniud:
uniud <text>
Returns <text> rotated 180 degrees. Only really works for ASCII printable characters.
.. _command-Filter-unmorse:
unmorse <Morse code text>
Does the reverse of the morse command.
.. _command-Filter-uwu:
uwu <text>
Returns <text> in uwu-speak.
.. _command-Filter-vowelrot:
vowelrot <text>
Returns <text> with vowels rotated

36
plugins/Format/README.rst
View File

@ -15,56 +15,92 @@ Usage
Provides some commands for formatting text, such as making text bold or
capitalized.
.. _commands-Format:
Commands
--------
.. _command-Format-bold:
bold <text>
Returns <text> bolded.
.. _command-Format-capitalize:
capitalize <text>
Returns <text> capitalized.
.. _command-Format-color:
color <foreground> [<background>] <text>
Returns <text> with foreground color <foreground> and background color <background> (if given)
.. _command-Format-concat:
concat <string 1> <string 2>
Concatenates two strings. Do keep in mind that this is *not* the same thing as join "", since if <string 2> contains spaces, they won't be removed by concat.
.. _command-Format-cut:
cut <size> <text>
Cuts <text> down to <size> by chopping off the rightmost characters in excess of <size>. If <size> is a negative number, it chops that many characters off the end of <text>.
.. _command-Format-field:
field <number> <text>
Returns the <number>th space-separated field of <text>. I.e., if text is "foo bar baz" and <number> is 2, "bar" is returned.
.. _command-Format-format:
format <format string> [<arg> ...]
Expands a Python-style format string using the remaining args. Just be sure always to use %s, not %d or %f or whatever, because all the args are strings.
.. _command-Format-join:
join <separator> <string 1> [<string> ...]
Joins all the arguments together with <separator>.
.. _command-Format-lower:
lower <text>
Returns <text> lowercased.
.. _command-Format-replace:
replace <substring to translate> <substring to replace it with> <text>
Replaces all non-overlapping occurrences of <substring to translate> with <substring to replace it with> in <text>.
.. _command-Format-repr:
repr <text>
Returns <text> surrounded by double quotes.
.. _command-Format-reverse:
reverse <text>
Returns <text> in reverse-video.
.. _command-Format-stripformatting:
stripformatting <text>
Strips bold, underline, and colors from <text>.
.. _command-Format-title:
title <text>
Returns <text> titlecased.
.. _command-Format-translate:
translate <chars to translate> <chars to replace those with> <text>
Replaces <chars to translate> with <chars to replace those with> in <text>. The first and second arguments must necessarily be the same length.
.. _command-Format-underline:
underline <text>
Returns <text> underlined.
.. _command-Format-upper:
upper <text>
Returns <text> uppercased.

12
plugins/GPG/README.rst
View File

@ -11,20 +11,32 @@ Usage
-----
Provides authentication based on GPG keys.
.. _commands-GPG:
Commands
--------
.. _command-GPG-key.add:
key add <key id> <key server>
Add a GPG key to your account.
.. _command-GPG-key.list:
key list takes no arguments
List your GPG keys.
.. _command-GPG-key.remove:
key remove <fingerprint>
Remove a GPG key from your account.
.. _command-GPG-signing.auth:
signing auth <url>
Check the GPG signature at the <url> and authenticates you if the key used is associated to a user.
.. _command-GPG-signing.gettoken:
signing gettoken takes no arguments
Send you a token that you'll have to sign with your key.

12
plugins/Games/README.rst
View File

@ -14,20 +14,32 @@ Usage
This plugin provides some small games like (Russian) roulette,
eightball, monologue, coin and dice.
.. _commands-Games:
Commands
--------
.. _command-Games-coin:
coin takes no arguments
Flips a coin and returns the result.
.. _command-Games-dice:
dice <dice>d<sides>
Rolls a die with <sides> number of sides <dice> times. For example, 2d6 will roll 2 six-sided dice; 10d10 will roll 10 ten-sided dice.
.. _command-Games-eightball:
eightball [<question>]
Ask a question and the answer shall be provided.
.. _command-Games-monologue:
monologue [<channel>]
Returns the number of consecutive lines you've sent in <channel> without being interrupted by someone else (i.e. how long your current 'monologue' is). <channel> is only necessary if the message isn't sent in the channel itself.
.. _command-Games-roulette:
roulette [spin]
Fires the revolver. If the bullet was in the chamber, you're dead. Tell me to spin the chambers and I will.

16
plugins/Google/README.rst
View File

@ -36,26 +36,42 @@ Check: `Supported language codes`_
.. _Supported language codes: <https://cloud.google.com/translate/v2/using_rest#language-params>`
.. _commands-Google:
Commands
--------
.. _command-Google-cache:
cache <url>
Returns a link to the cached version of <url> if it is available.
.. _command-Google-calc:
calc <expression>
Uses Google's calculator to calculate the value of <expression>.
.. _command-Google-fight:
fight <search string> <search string> [<search string> ...]
Returns the results of each search, in order, from greatest number of results to least.
.. _command-Google-google:
google <search> [--{filter,language} <value>]
Searches google.com for the given string. As many results as can fit are included. --language accepts a language abbreviation; --filter accepts a filtering level ('active', 'moderate', 'off').
.. _command-Google-lucky:
lucky [--snippet] <search>
Does a google search, but only returns the first result. If option --snippet is given, returns also the page text snippet.
.. _command-Google-phonebook:
phonebook <phone number>
Looks <phone number> up on Google.
.. _command-Google-translate:
translate <source language> [to] <target language> <text>
Returns <text> translated from <source language> into <target language>. <source language> and <target language> take language codes (not language names), which are listed here: https://cloud.google.com/translate/docs/languages

14
plugins/Hashes/README.rst
View File

@ -11,23 +11,37 @@ Usage
-----
Provides hash or encryption related commands
.. _commands-Hashes:
Commands
--------
.. _command-Hashes-algorithms:
algorithms <takes no arguments>
Returns the list of available algorithms.
.. _command-Hashes-md5:
md5 <text>
Returns the md5 hash of a given string.
.. _command-Hashes-mkhash:
mkhash <algorithm> <text>
Returns TEXT after it has been hashed with ALGORITHM. See the 'algorithms' command in this plugin to return the algorithms available on this system.
.. _command-Hashes-sha:
sha <text>
Returns the SHA1 hash of a given string.
.. _command-Hashes-sha256:
sha256 <text>
Returns a SHA256 hash of the given string.
.. _command-Hashes-sha512:
sha512 <text>
Returns a SHA512 hash of the given string.

12
plugins/Herald/README.rst
View File

@ -13,20 +13,32 @@ Usage
This plugin allows you to set welcome messages (heralds) to people who
are recognized by the bot when they join a channel.
.. _commands-Herald:
Commands
--------
.. _command-Herald-add:
add [<channel>] <user|nick> <msg>
Sets the herald message for <user> (or the user <nick|hostmask> is currently identified or recognized as) to <msg>. <channel> is only necessary if the message isn't sent in the channel itself.
.. _command-Herald-change:
change [<channel>] [<user|nick>] <regexp>
Changes the herald message for <user>, or the user <nick|hostmask> is currently identified or recognized as, according to <regexp>. If <user> is not given, defaults to the calling user. <channel> is only necessary if the message isn't sent in the channel itself.
.. _command-Herald-default:
default [<channel>] [--remove|<msg>]
If <msg> is given, sets the default herald to <msg>. A <msg> of "" will remove the default herald. If <msg> is not given, returns the current default herald. <channel> is only necessary if the message isn't sent in the channel itself.
.. _command-Herald-get:
get [<channel>] [<user|nick>]
Returns the current herald message for <user> (or the user <nick|hostmask> is currently identified or recognized as). If <user> is not given, defaults to the user giving the command. <channel> is only necessary if the message isn't sent in the channel itself.
.. _command-Herald-remove:
remove [<channel>] [<user|nick>]
Removes the herald message set for <user>, or the user <nick|hostmask> is currently identified or recognized as. If <user> is not given, defaults to the user giving the command. <channel> is only necessary if the message isn't sent in the channel itself.

8
plugins/Internet/README.rst
View File

@ -13,14 +13,22 @@ Usage
Provides commands to query DNS, search WHOIS databases,
and convert IPs to hex.
.. _commands-Internet:
Commands
--------
.. _command-Internet-dns:
dns <host|ip>
Returns the ip of <host> or the reverse DNS hostname of <ip>.
.. _command-Internet-hexip:
hexip <ip>
Returns the hexadecimal IP for that IP.
.. _command-Internet-whois:
whois <domain>
Returns WHOIS information on the registration of <domain>.

12
plugins/Karma/README.rst
View File

@ -24,20 +24,32 @@ channel by setting `config plugins.Karma.onlyNicks` to ``True``.
If ``config plugins.karma.allowUnaddressedKarma` is set to `False``,
you must address the bot with nick or prefix to add or subtract karma.
.. _commands-Karma:
Commands
--------
.. _command-Karma-clear:
clear [<channel>] [<name>]
Resets the karma of <name> to 0. If <name> is not given, resets everything.
.. _command-Karma-dump:
dump [<channel>] <filename>
Dumps the Karma database for <channel> to <filename> in the bot's data directory. <channel> is only necessary if the message isn't sent in the channel itself.
.. _command-Karma-karma:
karma [<channel>] [<thing> ...]
Returns the karma of <thing>. If <thing> is not given, returns the top N karmas, where N is determined by the config variable supybot.plugins.Karma.rankingDisplay. If one <thing> is given, returns the details of its karma; if more than one <thing> is given, returns the total karma of each of the things. <channel> is only necessary if the message isn't sent on the channel itself.
.. _command-Karma-load:
load [<channel>] <filename>
Loads the Karma database for <channel> from <filename> in the bot's data directory. <channel> is only necessary if the message isn't sent in the channel itself.
.. _command-Karma-most:
most [<channel>] {increased,decreased,active}
Returns the most increased, the most decreased, or the most active (the sum of increased and decreased) karma things. <channel> is only necessary if the message isn't sent in the channel itself.

16
plugins/Lart/README.rst
View File

@ -19,26 +19,42 @@ Example:
* And Someone says ``@lart ChanServ``.
* ``* bot slaps ChanServ``.
.. _commands-Lart:
Commands
--------
.. _command-Lart-add:
add [<channel>] <text>
Adds <text> to the lart database for <channel>. <channel> is only necessary if the message isn't sent in the channel itself.
.. _command-Lart-change:
change [<channel>] <id> <regexp>
Changes the lart with id <id> according to the regular expression <regexp>. <channel> is only necessary if the message isn't sent in the channel itself.
.. _command-Lart-get:
get [<channel>] <id>
Gets the lart with id <id> from the lart database for <channel>. <channel> is only necessary if the message isn't sent in the channel itself.
.. _command-Lart-lart:
lart [<channel>] [<id>] <who|what> [for <reason>]
Uses the Luser Attitude Readjustment Tool on <who|what> (for <reason>, if given). If <id> is given, uses that specific lart. <channel> is only necessary if the message isn't sent in the channel itself.
.. _command-Lart-remove:
remove [<channel>] <id>
Removes the lart with id <id> from the lart database for <channel>. <channel> is only necessary if the message isn't sent in the channel itself.
.. _command-Lart-search:
search [<channel>] [--{regexp,by} <value>] [<glob>]
Searches for larts matching the criteria given.
.. _command-Lart-stats:
stats [<channel>]
Returns the number of larts in the database for <channel>. <channel> is only necessary if the message isn't sent in the channel itself.

10
plugins/Later/README.rst
View File

@ -39,17 +39,27 @@ and allows only users to send notes.
The only people who are able to read notes are the sender, receiver,
and the owner.
.. _commands-Later:
Commands
--------
.. _command-Later-notes:
notes [<nick>]
If <nick> is given, replies with what notes are waiting on <nick>, otherwise, replies with the nicks that have notes waiting for them.
.. _command-Later-remove:
remove <nick>
Removes the notes waiting on <nick>.
.. _command-Later-tell:
tell <nick1[,nick2[,...]]> <text>
Tells each <nickX> <text> the next time <nickX> is seen. <nickX> can contain wildcard characters, and the first matching nick will be given the note.
.. _command-Later-undo:
undo <nick>
Removes the latest note you sent to <nick>.

14
plugins/Math/README.rst
View File

@ -13,23 +13,37 @@ Usage
Provides commands to work with math, such as a calculator and
a unit converter.
.. _commands-Math:
Commands
--------
.. _command-Math-base:
base <fromBase> [<toBase>] <number>
Converts <number> from base <fromBase> to base <toBase>. If <toBase> is left out, it converts to decimal.
.. _command-Math-calc:
calc <math expression>
Returns the value of the evaluated <math expression>. The syntax is Python syntax; the type of arithmetic is floating point. Floating point arithmetic is used in order to prevent a user from being able to crash to the bot with something like '10**10**10**10'. One consequence is that large values such as '10**24' might not be exact.
.. _command-Math-convert:
convert [<number>] <unit> to <other unit>
Converts from <unit> to <other unit>. If number isn't given, it defaults to 1. For unit information, see 'units' command.
.. _command-Math-icalc:
icalc <math expression>
This is the same as the calc command except that it allows integer math, and can thus cause the bot to suck up CPU. Hence it requires the 'trusted' capability to use.
.. _command-Math-rpn:
rpn <rpn math expression>
Returns the value of an RPN expression.
.. _command-Math-units:
units [<type>]
With no arguments, returns a list of measurement types, which can be passed as arguments. When called with a type as an argument, returns the units of that type.

20
plugins/MessageParser/README.rst
View File

@ -18,32 +18,52 @@ Usage
This plugin can set regexp triggers to activate the bot.
Use 'add' command to add regexp trigger, 'remove' to remove.
.. _commands-MessageParser:
Commands
--------
.. _command-MessageParser-add:
add [<channel>|global] <regexp> <action>
Associates <regexp> with <action>. <channel> is only necessary if the message isn't sent on the channel itself. Action is echoed upon regexp match, with variables $1, $2, etc. being interpolated from the regexp match groups.
.. _command-MessageParser-info:
info [<channel>|global] [--id] <regexp>
Display information about <regexp> in the triggers database. <channel> is only necessary if the message isn't sent in the channel itself. If option --id specified, will retrieve by regexp id, not content.
.. _command-MessageParser-list:
list [<channel>|global]
Lists regexps present in the triggers database. <channel> is only necessary if the message isn't sent in the channel itself. Regexp ID listed in parentheses.
.. _command-MessageParser-lock:
lock [<channel>|global] <regexp>
Locks the <regexp> so that it cannot be removed or overwritten to. <channel> is only necessary if the message isn't sent in the channel itself.
.. _command-MessageParser-rank:
rank [<channel>|global]
Returns a list of top-ranked regexps, sorted by usage count (rank). The number of regexps returned is set by the rankListLength registry value. <channel> is only necessary if the message isn't sent in the channel itself.
.. _command-MessageParser-remove:
remove [<channel>|global] [--id] <regexp>]
Removes the trigger for <regexp> from the triggers database. <channel> is only necessary if the message isn't sent in the channel itself. If option --id specified, will retrieve by regexp id, not content.
.. _command-MessageParser-show:
show [<channel>|global] [--id] <regexp>
Looks up the value of <regexp> in the triggers database. <channel> is only necessary if the message isn't sent in the channel itself. If option --id specified, will retrieve by regexp id, not content.
.. _command-MessageParser-unlock:
unlock [<channel>|global] <regexp>
Unlocks the entry associated with <regexp> so that it can be removed or overwritten. <channel> is only necessary if the message isn't sent in the channel itself.
.. _command-MessageParser-vacuum:
vacuum [<channel>|global]
Vacuums the database for <channel>. See SQLite vacuum doc here: http://www.sqlite.org/lang_vacuum.html <channel> is only necessary if the message isn't sent in the channel itself. First check if user has the required capability specified in plugin config requireVacuumCapability.

26
plugins/Misc/README.rst
View File

@ -12,41 +12,67 @@ Usage
Miscellaneous commands to access Supybot core. This is a core
Supybot plugin that should not be removed!
.. _commands-Misc:
Commands
--------
.. _command-Misc-apropos:
apropos <string>
Searches for <string> in the commands currently offered by the bot, returning a list of the commands containing that string.
.. _command-Misc-clearmores:
clearmores takes no arguments
Clears all mores for the current network.
.. _command-Misc-completenick:
completenick [<channel>] <beginning> [--match-case]
Returns the nick of someone on the channel whose nick begins with the given <beginning>. <channel> defaults to the current channel.
.. _command-Misc-help:
help [<plugin>] [<command>]
This command gives a useful description of what <command> does. <plugin> is only necessary if the command is in more than one plugin. You may also want to use the 'list' command to list all available plugins and commands.
.. _command-Misc-last:
last [--{from,in,on,with,without,regexp} <value>] [--nolimit]
Returns the last message matching the given criteria. --from requires a nick from whom the message came; --in requires a channel the message was sent to; --on requires a network the message was sent on; --with requires some string that had to be in the message; --regexp requires a regular expression the message must match; --nolimit returns all the messages that can be found. By default, the channel this command is given in is searched.
.. _command-Misc-list:
list [--private] [--unloaded] [<plugin>]
Lists the commands available in the given plugin. If no plugin is given, lists the public plugins available. If --private is given, lists the private plugins. If --unloaded is given, it will list available plugins that are not loaded.
.. _command-Misc-more:
more [<nick>]
If the last command was truncated due to IRC message length limitations, returns the next chunk of the result of the last command. If <nick> is given, it takes the continuation of the last command from <nick> instead of the person sending this message.
.. _command-Misc-noticetell:
noticetell <nick> <text>
Tells the <nick> whatever <text> is, in a notice. Use nested commands to your benefit here.
.. _command-Misc-ping:
ping takes no arguments
Checks to see if the bot is alive.
.. _command-Misc-source:
source takes no arguments
Returns a URL saying where to get Limnoria.
.. _command-Misc-tell:
tell <nick> <text>
Tells the <nick> whatever <text> is. Use nested commands to your benefit here.
.. _command-Misc-version:
version takes no arguments
Returns the version of the current bot.

22
plugins/MoobotFactoids/README.rst
View File

@ -25,35 +25,57 @@ If you want the bot to use /mes with Factoids, that is possible too.
``@test is <action> tests.`` and everytime when someone calls for
``test`` the bot answers ``* bot tests.``
.. _commands-MoobotFactoids:
Commands
--------
.. _command-MoobotFactoids-factinfo:
factinfo [<channel>] <factoid key>
Returns the various bits of info on the factoid for the given key. <channel> is only necessary if the message isn't sent in the channel itself.
.. _command-MoobotFactoids-listauth:
listauth [<channel>] <author name>
Lists the keys of the factoids with the given author. Note that if an author has an integer name, you'll have to use that author's id to use this function (so don't use integer usernames!). <channel> is only necessary if the message isn't sent in the channel itself.
.. _command-MoobotFactoids-listkeys:
listkeys [<channel>] <text>
Lists the keys of the factoids whose key contains the provided text. <channel> is only necessary if the message isn't sent in the channel itself.
.. _command-MoobotFactoids-listvalues:
listvalues [<channel>] <text>
Lists the keys of the factoids whose value contains the provided text. <channel> is only necessary if the message isn't sent in the channel itself.
.. _command-MoobotFactoids-literal:
literal [<channel>] <factoid key>
Returns the literal factoid for the given factoid key. No parsing of the factoid value is done as it is with normal retrieval. <channel> is only necessary if the message isn't sent in the channel itself.
.. _command-MoobotFactoids-lock:
lock [<channel>] <factoid key>
Locks the factoid with the given factoid key. Requires that the user be registered and have created the factoid originally. <channel> is only necessary if the message isn't sent in the channel itself.
.. _command-MoobotFactoids-most:
most [<channel>] {popular|authored|recent}
Lists the most {popular|authored|recent} factoids. "popular" lists the most frequently requested factoids. "authored" lists the author with the most factoids. "recent" lists the most recently created factoids. <channel> is only necessary if the message isn't sent in the channel itself.
.. _command-MoobotFactoids-random:
random [<channel>]
Displays a random factoid (along with its key) from the database. <channel> is only necessary if the message isn't sent in the channel itself.
.. _command-MoobotFactoids-remove:
remove [<channel>] <factoid key>
Deletes the factoid with the given key. <channel> is only necessary if the message isn't sent in the channel itself.
.. _command-MoobotFactoids-unlock:
unlock [<channel>] <factoid key>
Unlocks the factoid with the given factoid key. Requires that the user be registered and have locked the factoid. <channel> is only necessary if the message isn't sent in the channel itself.

26
plugins/Network/README.rst
View File

@ -14,41 +14,67 @@ Usage
Provides network-related commands, such as connecting to multiple networks
and checking latency to the server.
.. _commands-Network:
Commands
--------
.. _command-Network-capabilities:
capabilities [<network>]
Returns the list of IRCv3 capabilities available on the network.
.. _command-Network-cmdall:
cmdall <command> [<arg> ...]
Perform <command> (with its associated <arg>s) on all networks.
.. _command-Network-command:
command <network> <command> [<arg> ...]
Gives the bot <command> (with its associated <arg>s) on <network>.
.. _command-Network-connect:
connect [--nossl] <network> [<host[:port]>] [<password>]
Connects to another network (which will be represented by the name provided in <network>) at <host:port>. If port is not provided, it defaults to 6697, the default port for IRC with SSL. If password is provided, it will be sent to the server in a PASS command. If --nossl is provided, an SSL connection will not be attempted, and the port will default to 6667.
.. _command-Network-disconnect:
disconnect <network> [<quit message>]
Disconnects from the network represented by the network <network>. If <quit message> is given, quits the network with the given quit message.
.. _command-Network-driver:
driver [<network>]
Returns the current network driver for <network>. <network> is only necessary if the message isn't sent on the network to which this command is to apply.
.. _command-Network-latency:
latency [<network>]
Returns the current latency to <network>. <network> is only necessary if the message isn't sent on the network to which this command is to apply.
.. _command-Network-networks:
networks [--all]
Returns the networks to which the bot is currently connected. If --all is given, also includes networks known by the bot, but not connected to.
.. _command-Network-reconnect:
reconnect [<network>] [<quit message>]
Disconnects and then reconnects to <network>. If no network is given, disconnects and then reconnects to the network the command was given on. If no quit message is given, uses the configured one (supybot.plugins.Owner.quitMsg) or the nick of the person giving the command.
.. _command-Network-uptime:
uptime [<network>]
Returns the time duration since the connection was established.
.. _command-Network-whois:
whois [<network>] <nick>
Returns the WHOIS response <network> gives for <nick>. <network> is only necessary if the network is different than the network the command is sent on.
.. _command-Network-whowas:
whowas [<network>] <nick>
Returns the WHOIS response <network> gives for <nick>. <network> is only necessary if the network is different than the network the command is sent on.

12
plugins/News/README.rst
View File

@ -13,20 +13,32 @@ Usage
-----
This plugin provides a means of maintaining News for a channel.
.. _commands-News:
Commands
--------
.. _command-News-add:
add [<channel>] <expires> <subject>: <text>
Adds a given news item of <text> to a channel with the given <subject>. If <expires> isn't 0, that news item will expire <expires> seconds from now. <channel> is only necessary if the message isn't sent in the channel itself.
.. _command-News-change:
change [<channel>] <id> <regexp>
Changes the news item with <id> from <channel> according to the regular expression <regexp>. <regexp> should be of the form s/text/replacement/flags. <channel> is only necessary if the message isn't sent on the channel itself.
.. _command-News-news:
news [<channel>] [<id>]
Display the news items for <channel> in the format of '(#id) subject'. If <id> is given, retrieve only that news item; otherwise retrieve all news items. <channel> is only necessary if the message isn't sent in the channel itself.
.. _command-News-old:
old [<channel>] [<id>]
Returns the old news item for <channel> with <id>. If no number is given, returns all the old news items in reverse order. <channel> is only necessary if the message isn't sent in the channel itself.
.. _command-News-remove:
remove [<channel>] <id>
Removes the news item with <id> from <channel>. <channel> is only necessary if the message isn't sent in the channel itself.

10
plugins/NickAuth/README.rst
View File

@ -16,17 +16,27 @@ They first have to use ``@nickauth nick add <the nick>`` while being
identified to the bot and then use ``@auth`` when they want to
identify to the bot.
.. _commands-NickAuth:
Commands
--------
.. _command-NickAuth-auth:
auth takes no argument
Tries to authenticate you using network services. If you get no reply, it means you are not authenticated to the network services.
.. _command-NickAuth-nick.add:
nick add [<network>] <user> <nick>
Add <nick> to the list of nicks owned by the <user> on the <network>. You have to register this nick to the network services to be authenticated. <network> defaults to the current network.
.. _command-NickAuth-nick.list:
nick list [<network>] [<user>]
Lists nicks of the <user> on the network. <network> defaults to the current network.
.. _command-NickAuth-nick.remove:
nick remove [<network>] <user> <nick>
Remove <nick> from the list of nicks owned by the <user> on the <network>. <network> defaults to the current network.

4
plugins/Nickometer/README.rst
View File

@ -13,8 +13,12 @@ Usage
-----
Will tell you how lame a nick is by the command 'nickometer [nick]'.
.. _commands-Nickometer:
Commands
--------
.. _command-Nickometer-nickometer:
nickometer [<nick>]
Tells you how lame said nick is. If <nick> is not given, uses the nick of the person giving the command.

16
plugins/Note/README.rst
View File

@ -12,26 +12,42 @@ Usage
-----
Allows you to send notes to other users.
.. _commands-Note:
Commands
--------
.. _command-Note-list:
list [--{old,sent}] [--{from,to} <user>]
Retrieves the ids of all your unread notes. If --old is given, list read notes. If --sent is given, list notes that you have sent. If --from is specified, only lists notes sent to you from <user>. If --to is specified, only lists notes sent by you to <user>.
.. _command-Note-next:
next takes no arguments
Retrieves your next unread note, if any.
.. _command-Note-note:
note <id>
Retrieves a single note by its unique note id. Use the 'note list' command to see what unread notes you have.
.. _command-Note-reply:
reply <id> <text>
Sends a note in reply to <id>.
.. _command-Note-search:
search [--{regexp} <value>] [--sent] [<glob>]
Searches your received notes for ones matching <glob>. If --regexp is given, its associated value is taken as a regexp and matched against the notes. If --sent is specified, only search sent notes.
.. _command-Note-send:
send <recipient>,[<recipient>,[...]] <text>
Sends a new note to the user specified. Multiple recipients may be specified by separating their names by commas.
.. _command-Note-unsend:
unsend <id>
Unsends the note with the id given. You must be the author of the note, and it must be unread.

34
plugins/Owner/README.rst
View File

@ -13,53 +13,87 @@ Usage
Owner-only commands for core Supybot. This is a core Supybot module
that should not be removed!
.. _commands-Owner:
Commands
--------
.. _command-Owner-announce:
announce <text>
Sends <text> to all channels the bot is currently on and not lobotomized in.
.. _command-Owner-defaultcapability:
defaultcapability {add|remove} <capability>
Adds or removes (according to the first argument) <capability> from the default capabilities given to users (the configuration variable supybot.capabilities stores these).
.. _command-Owner-defaultplugin:
defaultplugin [--remove] <command> [<plugin>]
Sets the default plugin for <command> to <plugin>. If --remove is given, removes the current default plugin for <command>. If no plugin is given, returns the current default plugin set for <command>. See also, supybot.commands.defaultPlugins.importantPlugins.
.. _command-Owner-disable:
disable [<plugin>] <command>
Disables the command <command> for all users (including the owners). If <plugin> is given, only disables the <command> from <plugin>. If you want to disable a command for most users but not for yourself, set a default capability of -plugin.command or -command (if you want to disable the command in all plugins).
.. _command-Owner-enable:
enable [<plugin>] <command>
Enables the command <command> for all users. If <plugin> if given, only enables the <command> from <plugin>. This command is the inverse of disable.
.. _command-Owner-flush:
flush takes no arguments
Runs all the periodic flushers in world.flushers. This includes flushing all logs and all configuration changes to disk.
.. _command-Owner-ircquote:
ircquote <string to be sent to the server>
Sends the raw string given to the server.
.. _command-Owner-load:
load [--deprecated] <plugin>
Loads the plugin <plugin> from any of the directories in conf.supybot.directories.plugins; usually this includes the main installed directory and 'plugins' in the current directory. --deprecated is necessary if you wish to load deprecated plugins.
.. _command-Owner-logmark:
logmark <text>
Logs <text> to the global Supybot log at critical priority. Useful for marking logfiles for later searching.
.. _command-Owner-quit:
quit [<text>]
Exits the bot with the QUIT message <text>. If <text> is not given, the default quit message (supybot.plugins.Owner.quitMsg) will be used. If there is no default quitMsg set, your nick will be used. The standard substitutions ($version, $nick, etc.) are all handled appropriately.
.. _command-Owner-reload:
reload <plugin>
Unloads and subsequently reloads the plugin by name; use the 'list' command to see a list of the currently loaded plugins.
.. _command-Owner-reloadlocale:
reloadlocale takes no argument
Reloads the locale of the bot.
.. _command-Owner-rename:
rename <plugin> <command> <new name>
Renames <command> in <plugin> to the <new name>.
.. _command-Owner-unload:
unload <plugin>
Unloads the callback by name; use the 'list' command to see a list of the currently loaded plugins. Obviously, the Owner plugin can't be unloaded.
.. _command-Owner-unrename:
unrename <plugin>
Removes all renames in <plugin>. The plugin will be reloaded after this command is run.
.. _command-Owner-upkeep:
upkeep [<level>]
Runs the standard upkeep stuff (flushes and gc.collects()). If given a level, runs that level of upkeep (currently, the only supported level is "high", which causes the bot to flush a lot of caches as well as do normal upkeep stuff).

12
plugins/Plugin/README.rst
View File

@ -15,20 +15,32 @@ list' to list the loaded plugins; use 'plugin help' to get the description
of a plugin; use the 'plugin' command itself to determine what plugin a
command exists in.
.. _commands-Plugin:
Commands
--------
.. _command-Plugin-author:
author <plugin>
Returns the author of <plugin>. This is the person you should talk to if you have ideas, suggestions, or other comments about a given plugin.
.. _command-Plugin-contributors:
contributors <plugin> [<name>]
Replies with a list of people who made contributions to a given plugin. If <name> is specified, that person's specific contributions will be listed. You can specify a person's name by their full name or their nick, which is shown inside brackets if available.
.. _command-Plugin-help:
help <plugin>
Returns a useful description of how to use <plugin>, if the plugin has one.
.. _command-Plugin-plugin:
plugin <command>
Returns the name of the plugin that would be used to call <command>. If it is not uniquely determined, returns list of all plugins that contain <command>.
.. _command-Plugin-plugins:
plugins <command>
Returns the names of all plugins that contain <command>.

8
plugins/PluginDownloader/README.rst
View File

@ -49,14 +49,22 @@ Examples
< Mikaela> @load Wikipedia
< Limnoria> Ok.
.. _commands-PluginDownloader:
Commands
--------
.. _command-PluginDownloader-info:
info <repository> <plugin>
Displays informations on the <plugin> in the <repository>.
.. _command-PluginDownloader-install:
install <repository> <plugin>
Downloads and installs the <plugin> from the <repository>.
.. _command-PluginDownloader-repolist:
repolist [<repository>]
Displays the list of plugins in the <repository>. If <repository> is not given, returns a list of available repositories.

16
plugins/Praise/README.rst
View File

@ -20,26 +20,42 @@ Example:
* Someone says ``@praise ChanServ``.
* ``* bot hugs ChanServ``
.. _commands-Praise:
Commands
--------
.. _command-Praise-add:
add [<channel>] <text>
Adds <text> to the praise database for <channel>. <channel> is only necessary if the message isn't sent in the channel itself.
.. _command-Praise-change:
change [<channel>] <id> <regexp>
Changes the praise with id <id> according to the regular expression <regexp>. <channel> is only necessary if the message isn't sent in the channel itself.
.. _command-Praise-get:
get [<channel>] <id>
Gets the praise with id <id> from the praise database for <channel>. <channel> is only necessary if the message isn't sent in the channel itself.
.. _command-Praise-praise:
praise [<channel>] [<id>] <who|what> [for <reason>]
Praises <who|what> (for <reason>, if given). If <id> is given, uses that specific praise. <channel> is only necessary if the message isn't sent in the channel itself.
.. _command-Praise-remove:
remove [<channel>] <id>
Removes the praise with id <id> from the praise database for <channel>. <channel> is only necessary if the message isn't sent in the channel itself.
.. _command-Praise-search:
search [<channel>] [--{regexp,by} <value>] [<glob>]
Searches for praises matching the criteria given.
.. _command-Praise-stats:
stats [<channel>]
Returns the number of praises in the database for <channel>. <channel> is only necessary if the message isn't sent in the channel itself.

18
plugins/Quote/README.rst
View File

@ -11,29 +11,47 @@ Usage
-----
This plugin allows you to add quotes to the database for a channel.
.. _commands-Quote:
Commands
--------
.. _command-Quote-add:
add [<channel>] <text>
Adds <text> to the quote database for <channel>. <channel> is only necessary if the message isn't sent in the channel itself.
.. _command-Quote-change:
change [<channel>] <id> <regexp>
Changes the quote with id <id> according to the regular expression <regexp>. <channel> is only necessary if the message isn't sent in the channel itself.
.. _command-Quote-get:
get [<channel>] <id>
Gets the quote with id <id> from the quote database for <channel>. <channel> is only necessary if the message isn't sent in the channel itself.
.. _command-Quote-random:
random [<channel>]
Returns a random quote from <channel>. <channel> is only necessary if the message isn't sent in the channel itself.
.. _command-Quote-remove:
remove [<channel>] <id>
Removes the quote with id <id> from the quote database for <channel>. <channel> is only necessary if the message isn't sent in the channel itself.
.. _command-Quote-replace:
replace [<channel>] <id> <text>
Replace quote <id> with <text>. <channel> is only necessary if the message isn't sent in the channel itself.
.. _command-Quote-search:
search [<channel>] [--{regexp,by} <value>] [<glob>]
Searches for quotes matching the criteria given.
.. _command-Quote-stats:
stats [<channel>]
Returns the number of quotes in the database for <channel>. <channel> is only necessary if the message isn't sent in the channel itself.

18
plugins/QuoteGrabs/README.rst
View File

@ -16,29 +16,47 @@ Usage
Stores and displays quotes from channels. Quotes are stored randomly
and/or on user request.
.. _commands-QuoteGrabs:
Commands
--------
.. _command-QuoteGrabs-get:
get [<channel>] <id>
Return the quotegrab with the given <id>. <channel> is only necessary if the message isn't sent in the channel itself.
.. _command-QuoteGrabs-grab:
grab [<channel>] <nick>
Grabs a quote from <channel> by <nick> for the quotegrabs table. <channel> is only necessary if the message isn't sent in the channel itself.
.. _command-QuoteGrabs-list:
list [<channel>] <nick>
Returns a list of shortened quotes that have been grabbed for <nick> as well as the id of each quote. These ids can be used to get the full quote. <channel> is only necessary if the message isn't sent in the channel itself.
.. _command-QuoteGrabs-quote:
quote [<channel>] <nick>
Returns <nick>'s latest quote grab in <channel>. <channel> is only necessary if the message isn't sent in the channel itself.
.. _command-QuoteGrabs-random:
random [<channel>] [<nick>]
Returns a randomly grabbed quote, optionally choosing only from those quotes grabbed for <nick>. <channel> is only necessary if the message isn't sent in the channel itself.
.. _command-QuoteGrabs-say:
say [<channel>] <id>
Return the quotegrab with the given <id>. <channel> is only necessary if the message isn't sent in the channel itself.
.. _command-QuoteGrabs-search:
search [<channel>] <text>
Searches for <text> in a quote. <channel> is only necessary if the message isn't sent in the channel itself.
.. _command-QuoteGrabs-ungrab:
ungrab [<channel>] <number>
Removes the grab <number> (the last by default) on <channel>. <channel> is only necessary if the message isn't sent in the channel itself.

18
plugins/RSS/README.rst
View File

@ -50,29 +50,47 @@ and understand what it says and then you can do
``@config reply.onetoone False``
.. _commands-RSS:
Commands
--------
.. _command-RSS-add:
add <name> <url>
Adds a command to this plugin that will look up the RSS feed at the given URL.
.. _command-RSS-announce.add:
announce add [<channel>] <name|url> [<name|url> ...]
Adds the list of feeds to the current list of announced feeds in <channel>. Valid feeds include the names of registered feeds as well as URLs for RSS feeds. <channel> is only necessary if the message isn't sent in the channel itself.
.. _command-RSS-announce.channels:
announce channels <name|url>
Returns a list of channels that the given feed name or URL is being announced to.
.. _command-RSS-announce.list:
announce list [<channel>]
Returns the list of feeds announced in <channel>. <channel> is only necessary if the message isn't sent in the channel itself.
.. _command-RSS-announce.remove:
announce remove [<channel>] <name|url> [<name|url> ...]
Removes the list of feeds from the current list of announced feeds in <channel>. Valid feeds include the names of registered feeds as well as URLs for RSS feeds. <channel> is only necessary if the message isn't sent in the channel itself.
.. _command-RSS-info:
info <url|feed>
Returns information from the given RSS feed, namely the title, URL, description, and last update date, if available.
.. _command-RSS-remove:
remove <name>
Removes the command for looking up RSS feeds at <name> from this plugin.
.. _command-RSS-rss:
rss <name|url> [<number of headlines>]
Gets the title components of the given RSS feed. If <number of headlines> is given, return only that many headlines.

8
plugins/Relay/README.rst
View File

@ -20,14 +20,22 @@ There are several advanced alternatives to this plugin, available as
third-party plugins. You can check them out at
https://limnoria.net/plugins.xhtml#messaging
.. _commands-Relay:
Commands
--------
.. _command-Relay-join:
join [<channel>]
Starts relaying between the channel <channel> on all networks. If on a network the bot isn't in <channel>, it'll join. This commands is required even if the bot is in the channel on both networks; it won't relay between those channels unless it's told to join both channels. If <channel> is not given, starts relaying on the channel the message was sent in.
.. _command-Relay-nicks:
nicks [<channel>]
Returns the nicks of the people in the channel on the various networks the bot is connected to. <channel> is only necessary if the message isn't sent on the channel itself.
.. _command-Relay-part:
part <channel>
Ceases relaying between the channel <channel> on all networks. The bot will part from the channel on all networks in which it is on the channel.

12
plugins/Reply/README.rst
View File

@ -14,20 +14,32 @@ This plugin contains a few commands that construct various types of
replies. Some bot owners would be wise to not load this plugin because it
can be easily abused.
.. _commands-Reply:
Commands
--------
.. _command-Reply-action:
action <text>
Replies with <text> as an action. Use nested commands to your benefit here.
.. _command-Reply-notice:
notice <text>
Replies with <text> in a notice. Use nested commands to your benefit here. If you want a private notice, nest the private command.
.. _command-Reply-private:
private <text>
Replies with <text> in private. Use nested commands to your benefit here.
.. _command-Reply-replies:
replies <str> [<str> ...]
Replies with each of its arguments <str> in separate replies, depending the configuration of supybot.reply.oneToOne.
.. _command-Reply-reply:
reply <text>
Replies with <text>. Equivalent to the alias, 'echo $nick: $1'.

12
plugins/Scheduler/README.rst
View File

@ -14,20 +14,32 @@ Usage
-----
This plugin allows you to schedule commands to execute at a later time.
.. _commands-Scheduler:
Commands
--------
.. _command-Scheduler-add:
add <seconds> <command>
Schedules the command string <command> to run <seconds> seconds in the future. For example, 'scheduler add [seconds 30m] "echo [cpu]"' will schedule the command "cpu" to be sent to the channel the schedule add command was given in (with no prefixed nick, a consequence of using echo). Do pay attention to the quotes in that example.
.. _command-Scheduler-list:
list takes no arguments
Lists the currently scheduled events.
.. _command-Scheduler-remind:
remind <seconds> <text>
Sets a reminder with string <text> to run <seconds> seconds in the future. For example, 'scheduler remind [seconds 30m] "Hello World"' will return '<nick> Reminder: Hello World' 30 minutes after being set.
.. _command-Scheduler-remove:
remove <id>
Removes the event scheduled with id <id> from the schedule.
.. _command-Scheduler-repeat:
repeat [--delay <delay>] <name> <seconds> <command>
Schedules the command <command> to run every <seconds> seconds, starting now (i.e., the command runs now, and every <seconds> seconds thereafter). <name> is a name by which the command can be unscheduled. If --delay is given, starts in <delay> seconds instead of now.

12
plugins/Seen/README.rst
View File

@ -14,20 +14,32 @@ Usage
This plugin allows you to see when and what someone last said and
what you missed since you left a channel.
.. _commands-Seen:
Commands
--------
.. _command-Seen-any:
any [<channel>] [--user <name>] [<nick>]
Returns the last time <nick> was seen and what <nick> was last seen doing. This includes any form of activity, instead of just PRIVMSGs. If <nick> isn't specified, returns the last activity seen in <channel>. If --user is specified, looks up name in the user database and returns the last time user was active in <channel>. <channel> is only necessary if the message isn't sent on the channel itself.
.. _command-Seen-last:
last [<channel>]
Returns the last thing said in <channel>. <channel> is only necessary if the message isn't sent in the channel itself.
.. _command-Seen-seen:
seen [<channel>] <nick>
Returns the last time <nick> was seen and what <nick> was last seen saying. <channel> is only necessary if the message isn't sent on the channel itself. <nick> may contain * as a wildcard.
.. _command-Seen-since:
since [<channel>] [<nick>]
Returns the messages since <nick> last left the channel. If <nick> is not given, it defaults to the nickname of the person calling the command.
.. _command-Seen-user:
user [<channel>] <name>
Returns the last time <name> was seen and what <name> was last seen saying. This looks up <name> in the user seen database, which means that it could be any nick recognized as user <name> that was seen. <channel> is only necessary if the message isn't sent in the channel itself.

22
plugins/Services/README.rst
View File

@ -19,35 +19,57 @@ configuration variables to match the NickServ and ChanServ nicks on your
network. Other commands such as identify, op, etc. should not be
necessary if the bot is properly configured.
.. _commands-Services:
Commands
--------
.. _command-Services-ghost:
ghost [<nick>]
Ghosts the bot's given nick and takes it. If no nick is given, ghosts the bot's configured nick and takes it.
.. _command-Services-identify:
identify takes no arguments
Identifies with NickServ using the current nick.
.. _command-Services-invite:
invite [<channel>]
Attempts to get invited by ChanServ to <channel>. <channel> is only necessary if the message isn't sent in the channel itself, but chances are, if you need this command, you're not sending it in the channel itself.
.. _command-Services-nicks:
nicks takes no arguments
Returns the nicks that this plugin is configured to identify and ghost with.
.. _command-Services-op:
op [<channel>]
Attempts to get opped by ChanServ in <channel>. <channel> is only necessary if the message isn't sent in the channel itself.
.. _command-Services-password:
password <nick> [<password>]
Sets the NickServ password for <nick> to <password>. If <password> is not given, removes <nick> from the configured nicks.
.. _command-Services-register:
register [<network>] <password> [<email>]
Uses the experimental REGISTER command to create an account for the bot on the <network>, using the <password> and the <email> if provided. Some networks may require the email. You may need to use the 'services verify' command afterward to confirm your email address.
.. _command-Services-unban:
unban [<channel>]
Attempts to get unbanned by ChanServ in <channel>. <channel> is only necessary if the message isn't sent in the channel itself, but chances are, if you need this command, you're not sending it in the channel itself.
.. _command-Services-verify:
verify [<network>] <account> <code>
If the <network> requires a verification code, you need to call this command with the code the server gave you to finish the registration.
.. _command-Services-voice:
voice [<channel>]
Attempts to get voiced by ChanServ in <channel>. <channel> is only necessary if the message isn't sent in the channel itself.

8
plugins/ShrinkUrl/README.rst
View File

@ -12,14 +12,22 @@ Usage
This plugin features commands to shorten URLs through different services,
like tinyurl.
.. _commands-ShrinkUrl:
Commands
--------
.. _command-ShrinkUrl-tiny:
tiny <url>
Returns a TinyURL.com version of <url>
.. _command-ShrinkUrl-ur1:
ur1 <url>
Returns an ur1 version of <url>.
.. _command-ShrinkUrl-x0:
x0 <url>
Returns an x0.no version of <url>.

22
plugins/Status/README.rst
View File

@ -13,35 +13,57 @@ Usage
This plugin allows you to view different bot statistics, for example,
uptime.
.. _commands-Status:
Commands
--------
.. _command-Status-cmd:
cmd takes no arguments
Returns some interesting command-related statistics.
.. _command-Status-commands:
commands takes no arguments
Returns a list of the commands offered by the bot.
.. _command-Status-cpu:
cpu takes no arguments
Returns some interesting CPU-related statistics on the bot.
.. _command-Status-net:
net takes no arguments
Returns some interesting network-related statistics.
.. _command-Status-network:
network takes no arguments
Returns the network the bot is on.
.. _command-Status-processes:
processes takes no arguments
Returns the number of processes that have been spawned, and list of ones that are still active.
.. _command-Status-server:
server takes no arguments
Returns the server the bot is on.
.. _command-Status-status:
status takes no arguments
Returns the status of the bot.
.. _command-Status-threads:
threads takes no arguments
Returns the current threads that are active.
.. _command-Status-uptime:
uptime takes no arguments
Returns the amount of time the bot has been running.

28
plugins/String/README.rst
View File

@ -11,44 +11,72 @@ Usage
-----
Provides useful commands for manipulating characters and strings.
.. _commands-String:
Commands
--------
.. _command-String-chr:
chr <number>
Returns the unicode character associated with codepoint <number>
.. _command-String-decode:
decode <encoding> <text>
Returns an un-encoded form of the given text; the valid encodings are available in the documentation of the Python codecs module: <http://docs.python.org/library/codecs.html#standard-encodings>.
.. _command-String-encode:
encode <encoding> <text>
Returns an encoded form of the given text; the valid encodings are available in the documentation of the Python codecs module: <http://docs.python.org/library/codecs.html#standard-encodings>.
.. _command-String-len:
len <text>
Returns the length of <text>.
.. _command-String-levenshtein:
levenshtein <string1> <string2>
Returns the levenshtein distance (also known as the "edit distance" between <string1> and <string2>)
.. _command-String-md5:
md5 <text>
Returns the md5 hash of a given string.
.. _command-String-ord:
ord <letter>
Returns the unicode codepoint of <letter>.
.. _command-String-re:
re <regexp> <text>
If <regexp> is of the form m/regexp/flags, returns the portion of <text> that matches the regexp. If <regexp> is of the form s/regexp/replacement/flags, returns the result of applying such a regexp to <text>.
.. _command-String-sha:
sha <text>
Returns the SHA1 hash of a given string.
.. _command-String-soundex:
soundex <string> [<length>]
Returns the Soundex hash to a given length. The length defaults to 4, since that's the standard length for a soundex hash. For unlimited length, use 0. Maximum length 1024.
.. _command-String-unicodename:
unicodename <character>
Returns the name of the given unicode <character>.
.. _command-String-unicodesearch:
unicodesearch <name>
Searches for a unicode character from its <name>.
.. _command-String-xor:
xor <password> <text>
Returns <text> XOR-encrypted with <password>.

14
plugins/Success/README.rst
View File

@ -17,23 +17,37 @@ Basically, it replaces the standard 'The operation succeeded.' messages
with messages kept in a database, able to give more personable
responses.
.. _commands-Success:
Commands
--------
.. _command-Success-add:
add [<channel>] <text>
Adds <text> to the success database for <channel>. <channel> is only necessary if the message isn't sent in the channel itself.
.. _command-Success-change:
change [<channel>] <id> <regexp>
Changes the success with id <id> according to the regular expression <regexp>. <channel> is only necessary if the message isn't sent in the channel itself.
.. _command-Success-get:
get [<channel>] <id>
Gets the success with id <id> from the success database for <channel>. <channel> is only necessary if the message isn't sent in the channel itself.
.. _command-Success-remove:
remove [<channel>] <id>
Removes the success with id <id> from the success database for <channel>. <channel> is only necessary if the message isn't sent in the channel itself.
.. _command-Success-search:
search [<channel>] [--{regexp,by} <value>] [<glob>]
Searches for successes matching the criteria given.
.. _command-Success-stats:
stats [<channel>]
Returns the number of successes in the database for <channel>. <channel> is only necessary if the message isn't sent in the channel itself.

18
plugins/Time/README.rst
View File

@ -11,29 +11,47 @@ Usage
-----
This plugin allows you to use different time-related functions.
.. _commands-Time:
Commands
--------
.. _command-Time-at:
at [<time string>]
Returns the number of seconds since epoch <time string> is. <time string> can be any number of natural formats; just try something and see if it will work. If the <time string> is not given, defaults to now.
.. _command-Time-ctime:
ctime [<seconds since epoch>]
Returns the ctime for <seconds since epoch>, or the current ctime if no <seconds since epoch> is given.
.. _command-Time-ddate:
ddate [<year> <month> <day>]
Returns a the Discordian date today, or an optional different date.
.. _command-Time-elapsed:
elapsed <seconds>
Returns a pretty string that is the amount of time represented by <seconds>.
.. _command-Time-seconds:
seconds [<years>y] [<weeks>w] [<days>d] [<hours>h] [<minutes>m] [<seconds>s]
Returns the number of seconds in the number of <years>, <weeks>, <days>, <hours>, <minutes>, and <seconds> given. An example usage is "seconds 2h 30m", which would return 9000, which is '3600*2 + 30*60'. Useful for scheduling events at a given number of seconds in the future.
.. _command-Time-time:
time [<channel>] [<format>] [<seconds since epoch>]
Returns the current time in <format> format, or, if <format> is not given, uses the configurable format for the current channel. If no <seconds since epoch> time is given, the current time is used. If <channel> is given without <format>, uses the format for <channel>.
.. _command-Time-tztime:
tztime <region>/<city>
Takes a city and its region, and returns its local time. This command uses the IANA Time Zone Database.
.. _command-Time-until:
until <time string>
Returns the number of seconds until <time string>.

14
plugins/Todo/README.rst
View File

@ -13,23 +13,37 @@ Usage
This plugin allows you to create your own personal to-do list on
the bot.
.. _commands-Todo:
Commands
--------
.. _command-Todo-add:
add [--priority=<num>] <text>
Adds <text> as a task in your own personal todo list. The optional priority argument allows you to set a task as a high or low priority. Any integer is valid.
.. _command-Todo-change:
change <task id> <regexp>
Modify the task with the given id using the supplied regexp.
.. _command-Todo-remove:
remove <task id> [<task id> ...]
Removes <task id> from your personal todo list.
.. _command-Todo-search:
search [--{regexp} <value>] [<glob> <glob> ...]
Searches your todos for tasks matching <glob>. If --regexp is given, its associated value is taken as a regexp and matched against the tasks.
.. _command-Todo-setpriority:
setpriority <id> <priority>
Sets the priority of the todo with the given id to the specified value.
.. _command-Todo-todo:
todo [<username>] [<task id>]
Retrieves a task for the given task id. If no task id is given, it will return a list of task ids that that user has added to their todo list.

46
plugins/Topic/README.rst
View File

@ -12,71 +12,117 @@ Usage
This plugin allows you to use many topic-related functions,
such as Add, Undo, and Remove.
.. _commands-Topic:
Commands
--------
.. _command-Topic-add:
add [<channel>] <topic>
Adds <topic> to the topics for <channel>. <channel> is only necessary if the message isn't sent in the channel itself.
.. _command-Topic-change:
change [<channel>] <number> <regexp>
Changes the topic number <number> on <channel> according to the regular expression <regexp>. <number> is the one-based index into the topics; <regexp> is a regular expression of the form s/regexp/replacement/flags. <channel> is only necessary if the message isn't sent in the channel itself.
.. _command-Topic-default:
default [<channel>]
Sets the topic in <channel> to the default topic for <channel>. The default topic for a channel may be configured via the configuration variable supybot.plugins.Topic.default.
.. _command-Topic-fit:
fit [<channel>] <topic>
Adds <topic> to the topics for <channel>. If the topic is too long for the server, topics will be popped until there is enough room. <channel> is only necessary if the message isn't sent in the channel itself.
.. _command-Topic-get:
get [<channel>] <number>
Returns topic number <number> from <channel>. <number> is a one-based index into the topics. <channel> is only necessary if the message isn't sent in the channel itself.
.. _command-Topic-insert:
insert [<channel>] <topic>
Adds <topic> to the topics for <channel> at the beginning of the topics currently on <channel>. <channel> is only necessary if the message isn't sent in the channel itself.
.. _command-Topic-list:
list [<channel>]
Returns a list of the topics in <channel>, prefixed by their indexes. Mostly useful for topic reordering. <channel> is only necessary if the message isn't sent in the channel itself.
.. _command-Topic-lock:
lock [<channel>]
Locks the topic (sets the mode +t) in <channel>. <channel> is only necessary if the message isn't sent in the channel itself.
.. _command-Topic-redo:
redo [<channel>]
Undoes the last undo. <channel> is only necessary if the message isn't sent in the channel itself.
.. _command-Topic-refresh:
refresh [<channel>]
Refreshes current topic set by anyone. Restores topic if empty. <channel> is only necessary if the message isn't sent in the channel itself.
.. _command-Topic-remove:
remove [<channel>] <number1> [<number2> <number3>...]
Removes topics <numbers> from the topic for <channel> Topics are numbered starting from 1; you can also use negative indexes to refer to topics starting the from the end of the topic. <channel> is only necessary if the message isn't sent in the channel itself.
.. _command-Topic-reorder:
reorder [<channel>] <number> [<number> ...]
Reorders the topics from <channel> in the order of the specified <number> arguments. <number> is a one-based index into the topics. <channel> is only necessary if the message isn't sent in the channel itself.
.. _command-Topic-replace:
replace [<channel>] <number> <topic>
Replaces topic <number> with <topic>.
.. _command-Topic-restore:
restore [<channel>]
Restores the topic to the last topic set by the bot. <channel> is only necessary if the message isn't sent in the channel itself.
.. _command-Topic-save:
save [<channel>]
Saves the topic in <channel> to be restored with 'topic default' later. <channel> is only necessary if the message isn't sent in the channel itself.
.. _command-Topic-separator:
separator [<channel>] <separator>
Sets the topic separator for <channel> to <separator> Converts the current topic appropriately.
.. _command-Topic-set:
set [<channel>] [<number>] <topic>
Sets the topic <number> to be <text>. If no <number> is given, this sets the entire topic. <channel> is only necessary if the message isn't sent in the channel itself.
.. _command-Topic-shuffle:
shuffle [<channel>]
Shuffles the topics in <channel>. <channel> is only necessary if the message isn't sent in the channel itself.
.. _command-Topic-swap:
swap [<channel>] <first topic number> <second topic number>
Swaps the order of the first topic number and the second topic number. <channel> is only necessary if the message isn't sent in the channel itself.
.. _command-Topic-topic:
topic [<channel>]
Returns the topic for <channel>. <channel> is only necessary if the message isn't sent in the channel itself.
.. _command-Topic-undo:
undo [<channel>]
Restores the topic to the one previous to the last topic command that set it. <channel> is only necessary if the message isn't sent in the channel itself.
.. _command-Topic-unlock:
unlock [<channel>]
Unlocks the topic (sets the mode -t) in <channel>. <channel> is only necessary if the message isn't sent in the channel itself.

6
plugins/URL/README.rst
View File

@ -14,11 +14,17 @@ Usage
This plugin records how many URLs have been mentioned in
a channel and what the last URL was.
.. _commands-URL:
Commands
--------
.. _command-URL-last:
last [<channel>] [--{from,with,without,near,proto} <value>] [--nolimit]
Gives the last URL matching the given criteria. --from is from whom the URL came; --proto is the protocol the URL used; --with is something inside the URL; --without is something that should not be in the URL; --near is something in the same message as the URL. If --nolimit is given, returns all the URLs that are found to just the URL. <channel> is only necessary if the message isn't sent in the channel itself.
.. _command-URL-stats:
stats [<channel>]
Returns the number of URLs in the URL database. <channel> is only required if the message isn't sent in the channel itself.

28
plugins/Unix/README.rst
View File

@ -11,44 +11,72 @@ Usage
-----
Provides Utilities for Unix-like systems.
.. _commands-Unix:
Commands
--------
.. _command-Unix-call:
call <command to call with any arguments>
Calls any command available on the system, and returns its output. Requires owner capability. Note that being restricted to owner, this command does not do any sanity checking on input/output. So it is up to you to make sure you don't run anything that will spamify your channel or that will bring your machine to its knees.
.. _command-Unix-crypt:
crypt <password> [<salt>]
Returns the resulting of doing a crypt() on <password>. If <salt> is not given, uses a random salt. If running on a glibc2 system, prepending '$1$' to your salt will cause crypt to return an MD5sum based crypt rather than the standard DES based crypt.
.. _command-Unix-errno:
errno <error number or code>
Returns the number of an errno code, or the errno code of a number.
.. _command-Unix-fortune:
fortune takes no arguments
Returns a fortune from the Unix fortune program.
.. _command-Unix-pid:
pid takes no arguments
Returns the current pid of the process for this Supybot.
.. _command-Unix-ping:
ping [--c <count>] [--i <interval>] [--t <ttl>] [--W <timeout>] [--4|--6] <host or ip>
Sends an ICMP echo request to the specified host. The arguments correspond with those listed in ping(8). --c is limited to 10 packets or less (default is 5). --i is limited to 5 or less. --W is limited to 10 or less. --4 and --6 can be used if and only if the system has a unified ping command.
.. _command-Unix-ping6:
ping6 [--c <count>] [--i <interval>] [--t <ttl>] [--W <timeout>] [--4|--6] <host or ip>
Sends an ICMP echo request to the specified host. The arguments correspond with those listed in ping(8). --c is limited to 10 packets or less (default is 5). --i is limited to 5 or less. --W is limited to 10 or less. --4 and --6 can be used if and only if the system has a unified ping command.
.. _command-Unix-progstats:
progstats takes no arguments
Returns various unix-y information on the running supybot process.
.. _command-Unix-shell:
shell <command to call with any arguments>
Calls any command available on the system using the shell specified by the SHELL environment variable, and returns its output. Requires owner capability. Note that being restricted to owner, this command does not do any sanity checking on input/output. So it is up to you to make sure you don't run anything that will spamify your channel or that will bring your machine to its knees.
.. _command-Unix-spell:
spell <word>
Returns the result of passing <word> to aspell/ispell. The results shown are sorted from best to worst in terms of being a likely match for the spelling of <word>.
.. _command-Unix-sysuname:
sysuname takes no arguments
Returns the uname -a from the system the bot is running on.
.. _command-Unix-sysuptime:
sysuptime takes no arguments
Returns the uptime from the system the bot is running on.
.. _command-Unix-wtf:
wtf [is] <something>
Returns wtf <something> is. 'wtf' is a Unix command that first appeared in NetBSD 1.5. In most Unices, it's available in some sort of 'bsdgames' package.

34
plugins/User/README.rst
View File

@ -13,53 +13,87 @@ Provides commands for dealing with users, such as registration and
authentication to the bot. This is a core Supybot plugin that should
not be removed!
.. _commands-User:
Commands
--------
.. _command-User-capabilities:
capabilities [<name>]
Returns the capabilities of the user specified by <name>; if <name> isn't specified, returns the capabilities of the user calling the command.
.. _command-User-changename:
changename <name> <new name> [<password>]
Changes your current user database name to the new name given. <password> is only necessary if the user isn't recognized by hostmask. This message must be sent to the bot privately (not on a channel) since it may contain a password.
.. _command-User-hostmask:
hostmask [<nick>]
Returns the hostmask of <nick>. If <nick> isn't given, return the hostmask of the person giving the command.
.. _command-User-hostmask.add:
hostmask add [<name>] [<hostmask>] [<password>]
Adds the hostmask <hostmask> to the user specified by <name>. The <password> may only be required if the user is not recognized by hostmask. <password> is also not required if an owner user is giving the command on behalf of some other user. If <hostmask> is not given, it defaults to your current hostmask. If <name> is not given, it defaults to your currently identified name. This message must be sent to the bot privately (not on a channel) since it may contain a password.
.. _command-User-hostmask.list:
hostmask list [<name>]
Returns the hostmasks of the user specified by <name>; if <name> isn't specified, returns the hostmasks of the user calling the command.
.. _command-User-hostmask.remove:
hostmask remove [<name>] [<hostmask>] [<password>]
Removes the hostmask <hostmask> from the record of the user specified by <name>. If the hostmask given is 'all' then all hostmasks will be removed. The <password> may only be required if the user is not recognized by their hostmask. This message must be sent to the bot privately (not on a channel) since it may contain a password. If <hostmask> is not given, it defaults to your current hostmask. If <name> is not given, it defaults to your currently identified name.
.. _command-User-identify:
identify <name> <password>
Identifies the user as <name>. This command (and all other commands that include a password) must be sent to the bot privately, not in a channel.
.. _command-User-list:
list [--capability=<capability>] [<glob>]
Returns the valid registered usernames matching <glob>. If <glob> is not given, returns all registered usernames.
.. _command-User-register:
register <name> <password>
Registers <name> with the given password <password> and the current hostmask of the person registering. You shouldn't register twice; if you're not recognized as a user but you've already registered, use the hostmask add command to add another hostmask to your already-registered user, or use the identify command to identify just for a session. This command (and all other commands that include a password) must be sent to the bot privately, not in a channel.
.. _command-User-set.password:
set password [<name>] <old password> <new password>
Sets the new password for the user specified by <name> to <new password>. Obviously this message must be sent to the bot privately (not in a channel). If the requesting user is an owner user, then <old password> needn't be correct.
.. _command-User-set.secure:
set secure <password> [<True|False>]
Sets the secure flag on the user of the person sending the message. Requires that the person's hostmask be in the list of hostmasks for that user in addition to the password being correct. When the secure flag is set, the user *must* identify before they can be recognized. If a specific True/False value is not given, it inverts the current value.
.. _command-User-stats:
stats takes no arguments
Returns some statistics on the user database.
.. _command-User-unidentify:
unidentify takes no arguments
Un-identifies you. Note that this may not result in the desired effect of causing the bot not to recognize you anymore, since you may have added hostmasks to your user that can cause the bot to continue to recognize you.
.. _command-User-unregister:
unregister <name> [<password>]
Unregisters <name> from the user database. If the user giving this command is an owner user, the password is not necessary.
.. _command-User-username:
username <hostmask|nick>
Returns the username of the user specified by <hostmask> or <nick> if the user is registered.
.. _command-User-whoami:
whoami takes no arguments
Returns the name of the user calling the command.

22
plugins/Utilities/README.rst
View File

@ -11,35 +11,57 @@ Usage
-----
Provides useful commands for bot scripting / command nesting.
.. _commands-Utilities:
Commands
--------
.. _command-Utilities-apply:
apply <command> <text>
Tokenizes <text> and calls <command> with the resulting arguments.
.. _command-Utilities-countargs:
countargs <arg> [<arg> ...]
Counts the arguments given.
.. _command-Utilities-echo:
echo <text>
Returns the arguments given it. Uses our standard substitute on the string(s) given to it; $nick (or $who), $randomNick, $randomInt, $botnick, $channel, $user, $host, $today, $now, and $randomDate are all handled appropriately.
.. _command-Utilities-ignore:
ignore requires no arguments
Does nothing. Useful sometimes for sequencing commands when you don't care about their non-error return values.
.. _command-Utilities-last:
last <text> [<text> ...]
Returns the last argument given. Useful when you'd like multiple nested commands to run, but only the output of the last one to be returned.
.. _command-Utilities-let:
let <variable> = <value> in <command>
Defines <variable> to be equal to <value> in the <command> and runs the <command>. '=' and 'in' can be omitted.
.. _command-Utilities-sample:
sample <num> <arg> [<arg> ...]
Randomly chooses <num> items out of the arguments given.
.. _command-Utilities-shuffle:
shuffle <arg> [<arg> ...]
Shuffles the arguments given.
.. _command-Utilities-sort:
sort <arg> [<arg> ...]
Sorts the arguments given.
.. _command-Utilities-success:
success [<text>]
Does nothing except to reply with a success message. This is useful when you want to run multiple commands as nested commands, and don't care about their output as long as they're successful. An error, of course, will break out of this command. <text>, if given, will be appended to the end of the success message.

18
plugins/Web/README.rst
View File

@ -11,29 +11,47 @@ Usage
-----
Add the help for 'help Web' here.
.. _commands-Web:
Commands
--------
.. _command-Web-doctype:
doctype <url>
Returns the DOCTYPE string of <url>. Only HTTP urls are valid, of course.
.. _command-Web-fetch:
fetch <url>
Returns the contents of <url>, or as much as is configured in supybot.plugins.Web.fetch.maximum. If that configuration variable is set to 0, this command will be effectively disabled.
.. _command-Web-headers:
headers <url>
Returns the HTTP headers of <url>. Only HTTP urls are valid, of course.
.. _command-Web-location:
location <url>
If the <url> is redirected to another page, returns the URL of that page. This works even if there are multiple redirects. Only HTTP urls are valid. Useful to "un-tinify" URLs.
.. _command-Web-size:
size <url>
Returns the Content-Length header of <url>. Only HTTP urls are valid, of course.
.. _command-Web-title:
title [--no-filter] <url>
Returns the HTML <title>...</title> of a URL. If --no-filter is given, the bot won't strip special chars (action, DCC, ...).
.. _command-Web-urlquote:
urlquote <text>
Returns the URL quoted form of the text.
.. _command-Web-urlunquote:
urlunquote <text>
Returns the text un-URL quoted.

6
scripts/supybot-plugin-doc
View File

@ -126,10 +126,13 @@ class PluginDoc(object):
self.lines.append('')
commands = self.inst.listCommands()
if len(commands):
self.lines.append('.. _commands-%s:\n' % self.name)
self.appendLine('Commands')
self.appendLine('--------')
for command in commands:
log.debug('command: %s', command)
self.lines.append('.. _command-%s-%s:\n' %
(self.name.lower(), command.replace(' ', '.')))
line = '%s ' % command
command = command.split()
doc = self.inst.getCommandHelp(command)
@ -147,14 +150,17 @@ class PluginDoc(object):
# now the config
try:
confs = conf.supybot.plugins.get(self.name)
self.lines.append('.. _conf-%s:\n' % self.name)
self.appendLine('Configuration')
self.appendLine('-------------')
self.lines.append('')
except registry.NonExistentRegistryEntry:
log.info('No configuration for plugin %s', plugin)
self.appendLine('No configuration for this plugin')
else:
for confValues in self.genConfig(confs, 0):
(name, isChan, isNet, help, default, indent) = confValues
self.lines.append('.. _conf-%s:\n' % name)
self.appendLine('%s' % name, indent - 1)
self.appendLine(
('This config variable defaults to %s, '