From cd02444f8740ad47ff13f3175bf07ccbeef3afc6 Mon Sep 17 00:00:00 2001 From: Valentin Lorentz Date: Mon, 5 Apr 2021 22:56:40 +0200 Subject: [PATCH] supybot-plugin-doc: Add labels for all command and config variables So they can be referenced from elsewhere in the doc. --- plugins/Admin/README.rst | 22 ++++++++ plugins/Aka/README.rst | 20 ++++++++ plugins/Alias/README.rst | 12 +++++ plugins/Anonymous/README.rst | 10 ++++ plugins/BadWords/README.rst | 8 +++ plugins/Channel/README.rst | 80 +++++++++++++++++++++++++++++ plugins/ChannelStats/README.rst | 8 +++ plugins/Conditional/README.rst | 38 ++++++++++++++ plugins/Config/README.rst | 30 +++++++++++ plugins/Ctcp/README.rst | 4 ++ plugins/DDG/README.rst | 4 ++ plugins/Debug/README.rst | 22 ++++++++ plugins/Dict/README.rst | 10 ++++ plugins/Dunno/README.rst | 14 +++++ plugins/Factoids/README.rst | 24 +++++++++ plugins/Fediverse/README.rst | 10 ++++ plugins/Filter/README.rst | 58 +++++++++++++++++++++ plugins/Format/README.rst | 36 +++++++++++++ plugins/GPG/README.rst | 12 +++++ plugins/Games/README.rst | 12 +++++ plugins/Google/README.rst | 16 ++++++ plugins/Hashes/README.rst | 14 +++++ plugins/Herald/README.rst | 12 +++++ plugins/Internet/README.rst | 8 +++ plugins/Karma/README.rst | 12 +++++ plugins/Lart/README.rst | 16 ++++++ plugins/Later/README.rst | 10 ++++ plugins/Math/README.rst | 14 +++++ plugins/MessageParser/README.rst | 20 ++++++++ plugins/Misc/README.rst | 26 ++++++++++ plugins/MoobotFactoids/README.rst | 22 ++++++++ plugins/Network/README.rst | 26 ++++++++++ plugins/News/README.rst | 12 +++++ plugins/NickAuth/README.rst | 10 ++++ plugins/Nickometer/README.rst | 4 ++ plugins/Note/README.rst | 16 ++++++ plugins/Owner/README.rst | 34 ++++++++++++ plugins/Plugin/README.rst | 12 +++++ plugins/PluginDownloader/README.rst | 8 +++ plugins/Praise/README.rst | 16 ++++++ plugins/Quote/README.rst | 18 +++++++ plugins/QuoteGrabs/README.rst | 18 +++++++ plugins/RSS/README.rst | 18 +++++++ plugins/Relay/README.rst | 8 +++ plugins/Reply/README.rst | 12 +++++ plugins/Scheduler/README.rst | 12 +++++ plugins/Seen/README.rst | 12 +++++ plugins/Services/README.rst | 22 ++++++++ plugins/ShrinkUrl/README.rst | 8 +++ plugins/Status/README.rst | 22 ++++++++ plugins/String/README.rst | 28 ++++++++++ plugins/Success/README.rst | 14 +++++ plugins/Time/README.rst | 18 +++++++ plugins/Todo/README.rst | 14 +++++ plugins/Topic/README.rst | 46 +++++++++++++++++ plugins/URL/README.rst | 6 +++ plugins/Unix/README.rst | 28 ++++++++++ plugins/User/README.rst | 34 ++++++++++++ plugins/Utilities/README.rst | 22 ++++++++ plugins/Web/README.rst | 18 +++++++ scripts/supybot-plugin-doc | 6 +++ 61 files changed, 1126 insertions(+) diff --git a/plugins/Admin/README.rst b/plugins/Admin/README.rst index b14fe718c..4ccc039d5 100644 --- a/plugins/Admin/README.rst +++ b/plugins/Admin/README.rst @@ -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 [ ...] Perform (with associated s on all channels on current network. +.. _command-Admin-capability.add: + capability add Gives the user specified by (or the user to whom currently maps) the specified capability +.. _command-Admin-capability.remove: + capability remove Takes from the user specified by (or the user to whom currently maps) the specified 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 [] This will set a persistent ignore on or the hostmask currently associated with . 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 This will remove the persistent ignore on or the hostmask currently associated with . +.. _command-Admin-join: + join [] Tell the bot to join the given channel. If is given, it is used when attempting to join the channel. +.. _command-Admin-nick: + nick [] [] Changes the bot's nick to . If no nick is given, returns the bot's current nick. diff --git a/plugins/Aka/README.rst b/plugins/Aka/README.rst index f1ac39270..6c624494c 100644 --- a/plugins/Aka/README.rst +++ b/plugins/Aka/README.rst @@ -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>] Defines an alias that executes . The 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>] Removes the given alias, if unlocked. +.. _command-Aka-lock: + lock [--channel <#channel>] Locks an alias so that no one else can change it. +.. _command-Aka-unlock: + unlock [--channel <#channel>] 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>] This command shows the content of an Aka. +.. _command-Aka-list: + list [--channel <#channel>] [--keys] [--unlocked|--locked] Lists all Akas defined for . If 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>] Overwrites an existing alias to execute instead. The 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>] Searches Akas defined for . If is not specified, searches all global Akas. diff --git a/plugins/Alias/README.rst b/plugins/Alias/README.rst index bb4a83f5f..b9726311b 100644 --- a/plugins/Alias/README.rst +++ b/plugins/Alias/README.rst @@ -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 Defines an alias that executes . The 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 Locks an alias so that no one else can change it. +.. _command-Alias-remove: + remove Removes the given alias, if unlocked. +.. _command-Alias-unlock: + unlock Unlocks an alias so that people can define new aliases over it. diff --git a/plugins/Anonymous/README.rst b/plugins/Anonymous/README.rst index b5368337a..c4a261b85 100644 --- a/plugins/Anonymous/README.rst +++ b/plugins/Anonymous/README.rst @@ -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 Performs in . +.. _command-Anonymous-react: + react Sends the to 's last message. 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 Sends to . +.. _command-Anonymous-tell: + tell Sends to . Can only be used if supybot.plugins.Anonymous.allowPrivateTarget is True. diff --git a/plugins/BadWords/README.rst b/plugins/BadWords/README.rst index 26edec084..f0b995616 100644 --- a/plugins/BadWords/README.rst +++ b/plugins/BadWords/README.rst @@ -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 [ ...] Adds all 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 [ ...] Removes s from the list of words being censored. diff --git a/plugins/Channel/README.rst b/plugins/Channel/README.rst index 1057de291..4bdcbf083 100644 --- a/plugins/Channel/README.rst +++ b/plugins/Channel/README.rst @@ -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 [] Sends to all the users in who have the ,op capability. +.. _command-Channel-ban.add: + ban add [] [] If you have the #channel,op capability, this will effect a persistent ban from interacting with the bot on the given (or the current hostmask associated with ). Other plugins may enforce this ban by actually banning users with matching hostmasks when they join. is an optional argument specifying when (in "seconds from now") the ban should expire; if none is given, the ban will never automatically expire. is only necessary if the message isn't sent in the channel itself. +.. _command-Channel-ban.hostmask: + ban hostmask [] Bans the from the . +.. _command-Channel-ban.list: + ban list [] [] If you have the #channel,op capability, this will show you the current persistent bans on the 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 [] If you have the #channel,op capability, this will remove the persistent ban on . is only necessary if the message isn't sent in the channel itself. +.. _command-Channel-capability.add: + capability add [] [ ...] If you have the #channel,op capability, this will give the (or the user to whom maps) the capability in the channel. is only necessary if the message isn't sent in the channel itself. +.. _command-Channel-capability.list: + capability list [] Returns the capabilities present on the . is only necessary if the message isn't sent in the channel itself. +.. _command-Channel-capability.remove: + capability remove [] [ ...] If you have the #channel,op capability, this will take from the user currently identified as (or the user to whom maps) the capability in the channel. is only necessary if the message isn't sent in the channel itself. +.. _command-Channel-capability.set: + capability set [] [ ...] If you have the #channel,op capability, this will add the channel capability for all users in the channel. is only necessary if the message isn't sent in the channel itself. +.. _command-Channel-capability.setdefault: + capability setdefault [] {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. is only necessary if the message isn't sent in the channel itself. +.. _command-Channel-capability.unset: + capability unset [] [ ...] If you have the #channel,op capability, this will unset the channel capability so each user's specific capability or the channel default capability will take precedence. is only necessary if the message isn't sent in the channel itself. +.. _command-Channel-cycle: + cycle [] [] If you have the #channel,op capability, this will cause the bot to "cycle", or PART and then JOIN the channel. is only necessary if the message isn't sent in the channel itself. If 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 [] [ ...] 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 [] [ ...] 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 [] [ ...] 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 [] [] [] If you have the #channel,op capability, this will disable the in . If is provided, will be disabled only for that plugin. If only is provided, all commands in the given plugin will be disabled. is only necessary if the message isn't sent in the channel itself. +.. _command-Channel-enable: + enable [] [] [] If you have the #channel,op capability, this will enable the in if it has been disabled. If is provided, will be enabled only for that plugin. If only is provided, all commands in the given plugin will be enabled. is only necessary if the message isn't sent in the channel itself. +.. _command-Channel-halfop: + halfop [] [ ...] If you have the #channel,halfop capability, this will give all the s you provide halfops. If you don't provide any s, this will give you halfops. is only necessary if the message isn't sent in the channel itself. +.. _command-Channel-iban: + iban [] [--{exact,nick,user,host}] [] If you have the #channel,op capability, this will ban 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. is only necessary if the message isn't sent in the channel itself. +.. _command-Channel-ignore.add: + ignore add [] [] If you have the #channel,op capability, this will set a persistent ignore on or the hostmask currently associated with . 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. is only necessary if the message isn't sent in the channel itself. +.. _command-Channel-ignore.list: + ignore list [] Lists the hostmasks that the bot is ignoring on the given channel. is only necessary if the message isn't sent in the channel itself. +.. _command-Channel-ignore.remove: + ignore remove [] If you have the #channel,op capability, this will remove the persistent ignore on in the channel. is only necessary if the message isn't sent in the channel itself. +.. _command-Channel-invite: + invite [] If you have the #channel,op capability, this will invite to join . is only necessary if the message isn't sent in the channel itself. +.. _command-Channel-kban: + kban [] [--{exact,nick,user,host}] [] [] If you have the #channel,op capability, this will kickban 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. is a reason to give for the kick. is only necessary if the message isn't sent in the channel itself. +.. _command-Channel-key: + key [] [] Sets the keyword in to . If is not given, removes the keyword requirement to join . is only necessary if the message isn't sent in the channel itself. +.. _command-Channel-kick: + kick [] [, , ...] [] Kicks (s) from for . If isn't given, uses the nick of the person making the command as the reason. is only necessary if the message isn't sent in the channel itself. +.. _command-Channel-limit: + limit [] [] Sets the channel limit to . If is 0, or isn't given, removes the channel limit. is only necessary if the message isn't sent in the channel itself. +.. _command-Channel-listbans: + listbans [] List all bans on the channel. If is not given, it defaults to the current channel. +.. _command-Channel-lobotomy.add: + lobotomy add [] If you have the #channel,op capability, this will "lobotomize" the bot, making it silent and unanswering to all requests made in the 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 [] If you have the #channel,op capability, this will unlobotomize the bot, making it respond to requests made in the channel again. is only necessary if the message isn't sent in the channel itself. +.. _command-Channel-mode: + mode [] [ ...] Sets the mode in to , sending the arguments given. is only necessary if the message isn't sent in the channel itself. +.. _command-Channel-moderate: + moderate [] Sets +m on , making it so only ops and voiced users can send messages to the channel. is only necessary if the message isn't sent in the channel itself. +.. _command-Channel-nicks: + nicks [] [--count] Returns the nicks in . 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 [] [ ...] If you have the #channel,op capability, this will give all the s you provide ops. If you don't provide any s, this will op you. is only necessary if the message isn't sent in the channel itself. +.. _command-Channel-part: + part [] [] Tells the bot to part the list of channels you give it. is only necessary if you want the bot to part a channel other than the current channel. If 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 [] [] Unbans on . If is not given, unbans any hostmask currently banned on that matches your current hostmask. Especially useful for unbanning yourself when you get unexpectedly (or accidentally) banned from the channel. is only necessary if the message isn't sent in the channel itself. +.. _command-Channel-unmoderate: + unmoderate [] Sets -m on , making it so everyone can send messages to the channel. is only necessary if the message isn't sent in the channel itself. +.. _command-Channel-voice: + voice [] [ ...] If you have the #channel,voice capability, this will voice all the s you provide. If you don't provide any s, this will voice you. is only necessary if the message isn't sent in the channel itself. diff --git a/plugins/ChannelStats/README.rst b/plugins/ChannelStats/README.rst index 9b69f1513..39f5dfddb 100644 --- a/plugins/ChannelStats/README.rst +++ b/plugins/ChannelStats/README.rst @@ -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 [] Returns the statistics for . is only necessary if the message isn't sent on the channel itself. +.. _command-ChannelStats-rank: + rank [] 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 [] [] Returns the statistics for on . is only necessary if the message isn't sent on the channel itself. If isn't given, it defaults to the user sending the command. diff --git a/plugins/Conditional/README.rst b/plugins/Conditional/README.rst index 6ab9c6363..11ab60110 100644 --- a/plugins/Conditional/README.rst +++ b/plugins/Conditional/README.rst @@ -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 [ ... ] Returns true if all conditions supplied evaluate to true. +.. _command-Conditional-ceq: + ceq Does a string comparison on and . Returns true if they are equal. +.. _command-Conditional-cerror: + cerror Runs and returns true if it raises an error; false otherwise. +.. _command-Conditional-cif: + cif Runs if evaluates to true, runs if it evaluates to false. Use other logical operators defined in this plugin and command nesting to your advantage here. +.. _command-Conditional-cor: + cor [ ... ] Returns true if any one of conditions supplied evaluates to true. +.. _command-Conditional-cxor: + cxor [ ... ] Returns true if only one of conditions supplied evaluates to true. +.. _command-Conditional-ge: + ge Does a string comparison on and . Returns true if is greater than or equal to . +.. _command-Conditional-gt: + gt Does a string comparison on and . Returns true if is greater than . +.. _command-Conditional-le: + le Does a string comparison on and . Returns true if is less than or equal to . +.. _command-Conditional-lt: + lt Does a string comparison on and . Returns true if is less than . +.. _command-Conditional-match: + match [--case-insensitive] Determines if is a substring of . Returns true if is contained in . Will only match case if --case-insensitive is not given. +.. _command-Conditional-nceq: + nceq Does a numeric comparison on and . Returns true if they are equal. +.. _command-Conditional-ne: + ne Does a string comparison on and . Returns true if they are not equal. +.. _command-Conditional-nge: + nge Does a numeric comparison on and . Returns true if is greater than or equal to . +.. _command-Conditional-ngt: + ngt Does a numeric comparison on and . Returns true if is greater than . +.. _command-Conditional-nle: + nle Does a numeric comparison on and . Returns true if is less than or equal to . +.. _command-Conditional-nlt: + nlt Does a numeric comparison on and . Returns true if is less than . +.. _command-Conditional-nne: + nne Does a numeric comparison on and . Returns true if they are not equal. diff --git a/plugins/Config/README.rst b/plugins/Config/README.rst index ec2cff5c5..972321686 100644 --- a/plugins/Config/README.rst +++ b/plugins/Config/README.rst @@ -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 [] [] [] If is given, sets the channel configuration variable for to for on the . Otherwise, returns the current channel configuration value of . 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. defaults to the current network. +.. _command-Config-config: + config [] If is given, sets the value of to . Otherwise, returns the current value of . You may omit the leading "supybot." in the name if you so choose. +.. _command-Config-default: + default Returns the default value of the configuration variable . +.. _command-Config-export: + export Exports the public variables of your configuration to . 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 Returns the description of the configuration variable . +.. _command-Config-list: + list Returns the configuration variables available under the given configuration . 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 [] [] If is given, sets the network configuration variable for to for . Otherwise, returns the current network configuration value of . 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 [] [] Resets the channel-specific value of variable , so that it will match the network-specific value (or the global one if the latter isn't set). and default to the current network and channel. +.. _command-Config-reset.network: + reset network [] [] Resets the network-specific value of variable , so that it will match the global. defaults to the current network and channel. +.. _command-Config-search: + search Searches for in the current configuration variables. +.. _command-Config-searchhelp: + searchhelp Searches for in the help of current configuration variables. +.. _command-Config-searchvalues: + searchvalues Searches for in the values of current configuration variables. +.. _command-Config-setdefault: + setdefault Resets the configuration variable 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. diff --git a/plugins/Ctcp/README.rst b/plugins/Ctcp/README.rst index 5e527bee7..e14b48d25 100644 --- a/plugins/Ctcp/README.rst +++ b/plugins/Ctcp/README.rst @@ -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 [] [--nicks] Sends a CTCP VERSION to , 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. diff --git a/plugins/DDG/README.rst b/plugins/DDG/README.rst index e9291d1eb..b15ed3a36 100644 --- a/plugins/DDG/README.rst +++ b/plugins/DDG/README.rst @@ -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. - +.. _commands-DDG: + Commands -------- +.. _command-DDG-search: + search Searches for on DuckDuckGo's web search. diff --git a/plugins/Debug/README.rst b/plugins/Debug/README.rst index 5be7c9d84..787b61e0e 100644 --- a/plugins/Debug/README.rst +++ b/plugins/Debug/README.rst @@ -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 [] Returns the result of the channeldb converter. +.. _command-Debug-collect: + collect [] Does gc collections, returning the number of objects collected each time. defaults to 1. +.. _command-Debug-environ: + environ takes no arguments Returns the environment of the supybot process. +.. _command-Debug-eval: + eval Evaluates (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 Execs . Returns success if it didn't raise any exceptions. +.. _command-Debug-exn: + exn Raises the exception matching . +.. _command-Debug-sendquote: + sendquote Sends (not queues) the raw IRC message given. +.. _command-Debug-settrace: + settrace [] Starts tracing function calls to . If is not given, sys.stdout is used. This causes much output. +.. _command-Debug-simpleeval: + simpleeval Evaluates the given expression. +.. _command-Debug-unsettrace: + unsettrace takes no arguments Stops tracing function calls on stdout. diff --git a/plugins/Dict/README.rst b/plugins/Dict/README.rst index 9bfc53a3c..a388b82e5 100644 --- a/plugins/Dict/README.rst +++ b/plugins/Dict/README.rst @@ -17,17 +17,27 @@ Usage This plugin provides a function to look up words from different dictionaries. +.. _commands-Dict: + Commands -------- +.. _command-Dict-dict: + dict [] Looks up the definition of 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 [ ...] 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. diff --git a/plugins/Dunno/README.rst b/plugins/Dunno/README.rst index 3e8fa33fd..0daaf144d 100644 --- a/plugins/Dunno/README.rst +++ b/plugins/Dunno/README.rst @@ -18,23 +18,37 @@ Basically, it replaces the standard 'Error: 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 [] Adds to the dunno database for . is only necessary if the message isn't sent in the channel itself. +.. _command-Dunno-change: + change [] Changes the dunno with id according to the regular expression . is only necessary if the message isn't sent in the channel itself. +.. _command-Dunno-get: + get [] Gets the dunno with id from the dunno database for . is only necessary if the message isn't sent in the channel itself. +.. _command-Dunno-remove: + remove [] Removes the dunno with id from the dunno database for . is only necessary if the message isn't sent in the channel itself. +.. _command-Dunno-search: + search [] [--{regexp,by} ] [] Searches for dunnos matching the criteria given. +.. _command-Dunno-stats: + stats [] Returns the number of dunnos in the database for . is only necessary if the message isn't sent in the channel itself. diff --git a/plugins/Factoids/README.rst b/plugins/Factoids/README.rst index 77eb5ffa5..b8fbe30fa 100644 --- a/plugins/Factoids/README.rst +++ b/plugins/Factoids/README.rst @@ -12,38 +12,62 @@ Usage ----- Provides the ability to show Factoids. +.. _commands-Factoids: + Commands -------- +.. _command-Factoids-alias: + alias [] [] Adds a new key for factoid associated with . is only necessary if there's more than one factoid associated with . 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 [] Changes the factoid # associated with according to . +.. _command-Factoids-forget: + forget [] [|*] Removes a key-fact relationship for 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 . If as a result, the key (factoid) remains without any relationships to a factoid (key), it shall be removed from the database. is only necessary if the message isn't sent in the channel itself. +.. _command-Factoids-info: + info [] Gives information about the factoid(s) associated with . is only necessary if the message isn't sent in the channel itself. +.. _command-Factoids-learn: + learn [] is Associates with . 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 [] Locks the factoid(s) associated with so that they cannot be removed or added to. is only necessary if the message isn't sent in the channel itself. +.. _command-Factoids-random: + random [] Returns random factoids from the database for . is only necessary if the message isn't sent in the channel itself. +.. _command-Factoids-rank: + rank [] [--plain] [--alpha] [] Returns a list of top-ranked factoid keys, sorted by usage count (rank). If 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. is only necessary if the message isn't sent in the channel itself. +.. _command-Factoids-search: + search [] [--values] [--regexp ] [--author ] [ ...] Searches the keyspace for keys matching . 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 [] Unlocks the factoid(s) associated with so that they can be removed or added to. is only necessary if the message isn't sent in the channel itself. +.. _command-Factoids-whatis: + whatis [] [--raw] [] Looks up the value of 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. is only necessary if the message isn't sent in the channel itself. diff --git a/plugins/Fediverse/README.rst b/plugins/Fediverse/README.rst index 86d5e83ac..a9172ca99 100644 --- a/plugins/Fediverse/README.rst +++ b/plugins/Fediverse/README.rst @@ -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 Shows the content of the status at . +.. _command-Fediverse-statuses: + statuses <@user@instance> Returned the last statuses of @user@instance. diff --git a/plugins/Filter/README.rst b/plugins/Filter/README.rst index dd33baba3..c390c2e4f 100644 --- a/plugins/Filter/README.rst +++ b/plugins/Filter/README.rst @@ -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 Returns as if an AOL user had said it. +.. _command-Filter-binary: + binary Returns the binary representation of . +.. _command-Filter-caps: + caps EVERYONE LOVES CAPS LOCK. +.. _command-Filter-capwords: + capwords Capitalises the first letter of each word. +.. _command-Filter-colorize: + colorize Returns with each character randomly colorized. +.. _command-Filter-gnu: + gnu Returns as GNU/RMS would say it. +.. _command-Filter-hebrew: + hebrew Removes all the vowels from . (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 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 Returns as if JeffK had said it himself. +.. _command-Filter-leet: + leet Returns the l33tspeak version of +.. _command-Filter-morse: + morse Gives the Morse code equivalent of a given string. +.. _command-Filter-outfilter: + outfilter [] [] Sets the outFilter of this plugin to be . If no command is given, unsets the outFilter. is only necessary if the message isn't sent in the channel itself. +.. _command-Filter-rainbow: + rainbow Returns colorized like a rainbow. +.. _command-Filter-reverse: + reverse Reverses . +.. _command-Filter-rot13: + rot13 Rotates 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 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 Returns with each word longer than supybot.plugins.Filter.shrink.minimum being shrunken (i.e., like "internationalization" becomes "i18n"). +.. _command-Filter-spellit: + spellit Returns , phonetically spelled out. +.. _command-Filter-squish: + squish Removes all the spaces from . +.. _command-Filter-stripcolor: + stripcolor Returns stripped of all color codes. +.. _command-Filter-supa1337: + supa1337 Replies with an especially k-rad translation of . +.. _command-Filter-unbinary: + unbinary Returns the character representation of binary . Assumes ASCII, 8 digits per character. +.. _command-Filter-undup: + undup Returns , with all consecutive duplicated letters removed. +.. _command-Filter-unhexlify: + unhexlify Returns the string corresponding to . Obviously, must be a string of hexadecimal digits. +.. _command-Filter-uniud: + uniud Returns rotated 180 degrees. Only really works for ASCII printable characters. +.. _command-Filter-unmorse: + unmorse Does the reverse of the morse command. +.. _command-Filter-uwu: + uwu Returns in uwu-speak. +.. _command-Filter-vowelrot: + vowelrot Returns with vowels rotated diff --git a/plugins/Format/README.rst b/plugins/Format/README.rst index 589916c2f..74e0b05c5 100644 --- a/plugins/Format/README.rst +++ b/plugins/Format/README.rst @@ -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 Returns bolded. +.. _command-Format-capitalize: + capitalize Returns capitalized. +.. _command-Format-color: + color [] Returns with foreground color and background color (if given) +.. _command-Format-concat: + concat Concatenates two strings. Do keep in mind that this is *not* the same thing as join "", since if contains spaces, they won't be removed by concat. +.. _command-Format-cut: + cut Cuts down to by chopping off the rightmost characters in excess of . If is a negative number, it chops that many characters off the end of . +.. _command-Format-field: + field Returns the th space-separated field of . I.e., if text is "foo bar baz" and is 2, "bar" is returned. +.. _command-Format-format: + format [ ...] 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 [ ...] Joins all the arguments together with . +.. _command-Format-lower: + lower Returns lowercased. +.. _command-Format-replace: + replace Replaces all non-overlapping occurrences of with in . +.. _command-Format-repr: + repr Returns surrounded by double quotes. +.. _command-Format-reverse: + reverse Returns in reverse-video. +.. _command-Format-stripformatting: + stripformatting Strips bold, underline, and colors from . +.. _command-Format-title: + title Returns titlecased. +.. _command-Format-translate: + translate Replaces with in . The first and second arguments must necessarily be the same length. +.. _command-Format-underline: + underline Returns underlined. +.. _command-Format-upper: + upper Returns uppercased. diff --git a/plugins/GPG/README.rst b/plugins/GPG/README.rst index dfa242f37..2f4bff860 100644 --- a/plugins/GPG/README.rst +++ b/plugins/GPG/README.rst @@ -11,20 +11,32 @@ Usage ----- Provides authentication based on GPG keys. +.. _commands-GPG: + Commands -------- +.. _command-GPG-key.add: + key add 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 Remove a GPG key from your account. +.. _command-GPG-signing.auth: + signing auth Check the GPG signature at the 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. diff --git a/plugins/Games/README.rst b/plugins/Games/README.rst index 758813960..f80c32243 100644 --- a/plugins/Games/README.rst +++ b/plugins/Games/README.rst @@ -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 d Rolls a die with number of sides times. For example, 2d6 will roll 2 six-sided dice; 10d10 will roll 10 ten-sided dice. +.. _command-Games-eightball: + eightball [] Ask a question and the answer shall be provided. +.. _command-Games-monologue: + monologue [] Returns the number of consecutive lines you've sent in without being interrupted by someone else (i.e. how long your current 'monologue' is). 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. diff --git a/plugins/Google/README.rst b/plugins/Google/README.rst index 946b1ca9b..008d73f2e 100644 --- a/plugins/Google/README.rst +++ b/plugins/Google/README.rst @@ -36,26 +36,42 @@ Check: `Supported language codes`_ .. _Supported language codes: ` +.. _commands-Google: + Commands -------- +.. _command-Google-cache: + cache Returns a link to the cached version of if it is available. +.. _command-Google-calc: + calc Uses Google's calculator to calculate the value of . +.. _command-Google-fight: + fight [ ...] Returns the results of each search, in order, from greatest number of results to least. +.. _command-Google-google: + google [--{filter,language} ] 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] 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 Looks up on Google. +.. _command-Google-translate: + translate [to] Returns translated from into . and take language codes (not language names), which are listed here: https://cloud.google.com/translate/docs/languages diff --git a/plugins/Hashes/README.rst b/plugins/Hashes/README.rst index 1ca6aa3c1..a8a9cb74b 100644 --- a/plugins/Hashes/README.rst +++ b/plugins/Hashes/README.rst @@ -11,23 +11,37 @@ Usage ----- Provides hash or encryption related commands +.. _commands-Hashes: + Commands -------- +.. _command-Hashes-algorithms: + algorithms Returns the list of available algorithms. +.. _command-Hashes-md5: + md5 Returns the md5 hash of a given string. +.. _command-Hashes-mkhash: + mkhash 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 Returns the SHA1 hash of a given string. +.. _command-Hashes-sha256: + sha256 Returns a SHA256 hash of the given string. +.. _command-Hashes-sha512: + sha512 Returns a SHA512 hash of the given string. diff --git a/plugins/Herald/README.rst b/plugins/Herald/README.rst index 6587ed081..260955f77 100644 --- a/plugins/Herald/README.rst +++ b/plugins/Herald/README.rst @@ -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 [] Sets the herald message for (or the user is currently identified or recognized as) to . is only necessary if the message isn't sent in the channel itself. +.. _command-Herald-change: + change [] [] Changes the herald message for , or the user is currently identified or recognized as, according to . If is not given, defaults to the calling user. is only necessary if the message isn't sent in the channel itself. +.. _command-Herald-default: + default [] [--remove|] If is given, sets the default herald to . A of "" will remove the default herald. If is not given, returns the current default herald. is only necessary if the message isn't sent in the channel itself. +.. _command-Herald-get: + get [] [] Returns the current herald message for (or the user is currently identified or recognized as). If is not given, defaults to the user giving the command. is only necessary if the message isn't sent in the channel itself. +.. _command-Herald-remove: + remove [] [] Removes the herald message set for , or the user is currently identified or recognized as. If is not given, defaults to the user giving the command. is only necessary if the message isn't sent in the channel itself. diff --git a/plugins/Internet/README.rst b/plugins/Internet/README.rst index afbd8d586..8c6b33024 100644 --- a/plugins/Internet/README.rst +++ b/plugins/Internet/README.rst @@ -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 Returns the ip of or the reverse DNS hostname of . +.. _command-Internet-hexip: + hexip Returns the hexadecimal IP for that IP. +.. _command-Internet-whois: + whois Returns WHOIS information on the registration of . diff --git a/plugins/Karma/README.rst b/plugins/Karma/README.rst index 223a16dd1..b65b8e79b 100644 --- a/plugins/Karma/README.rst +++ b/plugins/Karma/README.rst @@ -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 [] [] Resets the karma of to 0. If is not given, resets everything. +.. _command-Karma-dump: + dump [] Dumps the Karma database for to in the bot's data directory. is only necessary if the message isn't sent in the channel itself. +.. _command-Karma-karma: + karma [] [ ...] Returns the karma of . If is not given, returns the top N karmas, where N is determined by the config variable supybot.plugins.Karma.rankingDisplay. If one is given, returns the details of its karma; if more than one is given, returns the total karma of each of the things. is only necessary if the message isn't sent on the channel itself. +.. _command-Karma-load: + load [] Loads the Karma database for from in the bot's data directory. is only necessary if the message isn't sent in the channel itself. +.. _command-Karma-most: + most [] {increased,decreased,active} Returns the most increased, the most decreased, or the most active (the sum of increased and decreased) karma things. is only necessary if the message isn't sent in the channel itself. diff --git a/plugins/Lart/README.rst b/plugins/Lart/README.rst index fbb10be92..44d9747b8 100644 --- a/plugins/Lart/README.rst +++ b/plugins/Lart/README.rst @@ -19,26 +19,42 @@ Example: * And Someone says ``@lart ChanServ``. * ``* bot slaps ChanServ``. +.. _commands-Lart: + Commands -------- +.. _command-Lart-add: + add [] Adds to the lart database for . is only necessary if the message isn't sent in the channel itself. +.. _command-Lart-change: + change [] Changes the lart with id according to the regular expression . is only necessary if the message isn't sent in the channel itself. +.. _command-Lart-get: + get [] Gets the lart with id from the lart database for . is only necessary if the message isn't sent in the channel itself. +.. _command-Lart-lart: + lart [] [] [for ] Uses the Luser Attitude Readjustment Tool on (for , if given). If is given, uses that specific lart. is only necessary if the message isn't sent in the channel itself. +.. _command-Lart-remove: + remove [] Removes the lart with id from the lart database for . is only necessary if the message isn't sent in the channel itself. +.. _command-Lart-search: + search [] [--{regexp,by} ] [] Searches for larts matching the criteria given. +.. _command-Lart-stats: + stats [] Returns the number of larts in the database for . is only necessary if the message isn't sent in the channel itself. diff --git a/plugins/Later/README.rst b/plugins/Later/README.rst index 97e6b9e98..dc7bf4282 100644 --- a/plugins/Later/README.rst +++ b/plugins/Later/README.rst @@ -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 [] If is given, replies with what notes are waiting on , otherwise, replies with the nicks that have notes waiting for them. +.. _command-Later-remove: + remove Removes the notes waiting on . +.. _command-Later-tell: + tell Tells each the next time is seen. can contain wildcard characters, and the first matching nick will be given the note. +.. _command-Later-undo: + undo Removes the latest note you sent to . diff --git a/plugins/Math/README.rst b/plugins/Math/README.rst index c29157fb2..c0310afe7 100644 --- a/plugins/Math/README.rst +++ b/plugins/Math/README.rst @@ -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 [] Converts from base to base . If is left out, it converts to decimal. +.. _command-Math-calc: + calc Returns the value of the evaluated . 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 [] to Converts from to . If number isn't given, it defaults to 1. For unit information, see 'units' command. +.. _command-Math-icalc: + icalc 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 Returns the value of an RPN expression. +.. _command-Math-units: + units [] 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. diff --git a/plugins/MessageParser/README.rst b/plugins/MessageParser/README.rst index 4b604dead..3813075dd 100644 --- a/plugins/MessageParser/README.rst +++ b/plugins/MessageParser/README.rst @@ -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 [|global] Associates with . 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 [|global] [--id] Display information about in the triggers database. 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 [|global] Lists regexps present in the triggers database. is only necessary if the message isn't sent in the channel itself. Regexp ID listed in parentheses. +.. _command-MessageParser-lock: + lock [|global] Locks the so that it cannot be removed or overwritten to. is only necessary if the message isn't sent in the channel itself. +.. _command-MessageParser-rank: + rank [|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. is only necessary if the message isn't sent in the channel itself. +.. _command-MessageParser-remove: + remove [|global] [--id] ] Removes the trigger for from the triggers database. 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 [|global] [--id] Looks up the value of in the triggers database. 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 [|global] Unlocks the entry associated with so that it can be removed or overwritten. is only necessary if the message isn't sent in the channel itself. +.. _command-MessageParser-vacuum: + vacuum [|global] Vacuums the database for . See SQLite vacuum doc here: http://www.sqlite.org/lang_vacuum.html 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. diff --git a/plugins/Misc/README.rst b/plugins/Misc/README.rst index 64e073fb5..523e46f8a 100644 --- a/plugins/Misc/README.rst +++ b/plugins/Misc/README.rst @@ -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 Searches for 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 [] [--match-case] Returns the nick of someone on the channel whose nick begins with the given . defaults to the current channel. +.. _command-Misc-help: + help [] [] This command gives a useful description of what does. 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} ] [--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] [] 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 [] If the last command was truncated due to IRC message length limitations, returns the next chunk of the result of the last command. If is given, it takes the continuation of the last command from instead of the person sending this message. +.. _command-Misc-noticetell: + noticetell Tells the whatever 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 Tells the whatever is. Use nested commands to your benefit here. +.. _command-Misc-version: + version takes no arguments Returns the version of the current bot. diff --git a/plugins/MoobotFactoids/README.rst b/plugins/MoobotFactoids/README.rst index c489f8963..934d61e38 100644 --- a/plugins/MoobotFactoids/README.rst +++ b/plugins/MoobotFactoids/README.rst @@ -25,35 +25,57 @@ If you want the bot to use /mes with Factoids, that is possible too. ``@test is tests.`` and everytime when someone calls for ``test`` the bot answers ``* bot tests.`` +.. _commands-MoobotFactoids: + Commands -------- +.. _command-MoobotFactoids-factinfo: + factinfo [] Returns the various bits of info on the factoid for the given key. is only necessary if the message isn't sent in the channel itself. +.. _command-MoobotFactoids-listauth: + listauth [] 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!). is only necessary if the message isn't sent in the channel itself. +.. _command-MoobotFactoids-listkeys: + listkeys [] Lists the keys of the factoids whose key contains the provided text. is only necessary if the message isn't sent in the channel itself. +.. _command-MoobotFactoids-listvalues: + listvalues [] Lists the keys of the factoids whose value contains the provided text. is only necessary if the message isn't sent in the channel itself. +.. _command-MoobotFactoids-literal: + literal [] Returns the literal factoid for the given factoid key. No parsing of the factoid value is done as it is with normal retrieval. is only necessary if the message isn't sent in the channel itself. +.. _command-MoobotFactoids-lock: + lock [] Locks the factoid with the given factoid key. Requires that the user be registered and have created the factoid originally. is only necessary if the message isn't sent in the channel itself. +.. _command-MoobotFactoids-most: + most [] {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. is only necessary if the message isn't sent in the channel itself. +.. _command-MoobotFactoids-random: + random [] Displays a random factoid (along with its key) from the database. is only necessary if the message isn't sent in the channel itself. +.. _command-MoobotFactoids-remove: + remove [] Deletes the factoid with the given key. is only necessary if the message isn't sent in the channel itself. +.. _command-MoobotFactoids-unlock: + unlock [] Unlocks the factoid with the given factoid key. Requires that the user be registered and have locked the factoid. is only necessary if the message isn't sent in the channel itself. diff --git a/plugins/Network/README.rst b/plugins/Network/README.rst index 46c36a873..9db6a2a2d 100644 --- a/plugins/Network/README.rst +++ b/plugins/Network/README.rst @@ -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 [] Returns the list of IRCv3 capabilities available on the network. +.. _command-Network-cmdall: + cmdall [ ...] Perform (with its associated s) on all networks. +.. _command-Network-command: + command [ ...] Gives the bot (with its associated s) on . +.. _command-Network-connect: + connect [--nossl] [] [] Connects to another network (which will be represented by the name provided in ) at . 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 [] Disconnects from the network represented by the network . If is given, quits the network with the given quit message. +.. _command-Network-driver: + driver [] Returns the current network driver for . is only necessary if the message isn't sent on the network to which this command is to apply. +.. _command-Network-latency: + latency [] Returns the current latency to . 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 [] [] Disconnects and then reconnects to . 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 [] Returns the time duration since the connection was established. +.. _command-Network-whois: + whois [] Returns the WHOIS response gives for . is only necessary if the network is different than the network the command is sent on. +.. _command-Network-whowas: + whowas [] Returns the WHOIS response gives for . is only necessary if the network is different than the network the command is sent on. diff --git a/plugins/News/README.rst b/plugins/News/README.rst index 7974174f3..feb20ae5b 100644 --- a/plugins/News/README.rst +++ b/plugins/News/README.rst @@ -13,20 +13,32 @@ Usage ----- This plugin provides a means of maintaining News for a channel. +.. _commands-News: + Commands -------- +.. _command-News-add: + add [] : Adds a given news item of to a channel with the given . If isn't 0, that news item will expire seconds from now. is only necessary if the message isn't sent in the channel itself. +.. _command-News-change: + change [] Changes the news item with from according to the regular expression . should be of the form s/text/replacement/flags. is only necessary if the message isn't sent on the channel itself. +.. _command-News-news: + news [] [] Display the news items for in the format of '(#id) subject'. If is given, retrieve only that news item; otherwise retrieve all news items. is only necessary if the message isn't sent in the channel itself. +.. _command-News-old: + old [] [] Returns the old news item for with . If no number is given, returns all the old news items in reverse order. is only necessary if the message isn't sent in the channel itself. +.. _command-News-remove: + remove [] Removes the news item with from . is only necessary if the message isn't sent in the channel itself. diff --git a/plugins/NickAuth/README.rst b/plugins/NickAuth/README.rst index 9b537e1d2..7ef784837 100644 --- a/plugins/NickAuth/README.rst +++ b/plugins/NickAuth/README.rst @@ -16,17 +16,27 @@ They first have to use ``@nickauth nick add `` 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 [] Add to the list of nicks owned by the on the . You have to register this nick to the network services to be authenticated. defaults to the current network. +.. _command-NickAuth-nick.list: + nick list [] [] Lists nicks of the on the network. defaults to the current network. +.. _command-NickAuth-nick.remove: + nick remove [] Remove from the list of nicks owned by the on the . defaults to the current network. diff --git a/plugins/Nickometer/README.rst b/plugins/Nickometer/README.rst index 8ff07db01..41d1b5943 100644 --- a/plugins/Nickometer/README.rst +++ b/plugins/Nickometer/README.rst @@ -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 [] Tells you how lame said nick is. If is not given, uses the nick of the person giving the command. diff --git a/plugins/Note/README.rst b/plugins/Note/README.rst index 20e7ccf45..274c966c0 100644 --- a/plugins/Note/README.rst +++ b/plugins/Note/README.rst @@ -12,26 +12,42 @@ Usage ----- Allows you to send notes to other users. +.. _commands-Note: + Commands -------- +.. _command-Note-list: + list [--{old,sent}] [--{from,to} ] 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 . If --to is specified, only lists notes sent by you to . +.. _command-Note-next: + next takes no arguments Retrieves your next unread note, if any. +.. _command-Note-note: + note 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 Sends a note in reply to . +.. _command-Note-search: + search [--{regexp} ] [--sent] [] Searches your received notes for ones matching . 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 ,[,[...]] Sends a new note to the user specified. Multiple recipients may be specified by separating their names by commas. +.. _command-Note-unsend: + unsend Unsends the note with the id given. You must be the author of the note, and it must be unread. diff --git a/plugins/Owner/README.rst b/plugins/Owner/README.rst index 3e67dfaa6..5c7916296 100644 --- a/plugins/Owner/README.rst +++ b/plugins/Owner/README.rst @@ -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 Sends to all channels the bot is currently on and not lobotomized in. +.. _command-Owner-defaultcapability: + defaultcapability {add|remove} Adds or removes (according to the first argument) from the default capabilities given to users (the configuration variable supybot.capabilities stores these). +.. _command-Owner-defaultplugin: + defaultplugin [--remove] [] Sets the default plugin for to . If --remove is given, removes the current default plugin for . If no plugin is given, returns the current default plugin set for . See also, supybot.commands.defaultPlugins.importantPlugins. +.. _command-Owner-disable: + disable [] Disables the command for all users (including the owners). If is given, only disables the from . 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 [] Enables the command for all users. If if given, only enables the from . 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 Sends the raw string given to the server. +.. _command-Owner-load: + load [--deprecated] Loads the 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 Logs to the global Supybot log at critical priority. Useful for marking logfiles for later searching. +.. _command-Owner-quit: + quit [] Exits the bot with the QUIT message . If 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 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 Renames in to the . +.. _command-Owner-unload: + unload 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 Removes all renames in . The plugin will be reloaded after this command is run. +.. _command-Owner-upkeep: + upkeep [] 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). diff --git a/plugins/Plugin/README.rst b/plugins/Plugin/README.rst index f980c91af..ef2453c21 100644 --- a/plugins/Plugin/README.rst +++ b/plugins/Plugin/README.rst @@ -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 Returns the author of . This is the person you should talk to if you have ideas, suggestions, or other comments about a given plugin. +.. _command-Plugin-contributors: + contributors [] Replies with a list of people who made contributions to a given plugin. If 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 Returns a useful description of how to use , if the plugin has one. +.. _command-Plugin-plugin: + plugin Returns the name of the plugin that would be used to call . If it is not uniquely determined, returns list of all plugins that contain . +.. _command-Plugin-plugins: + plugins Returns the names of all plugins that contain . diff --git a/plugins/PluginDownloader/README.rst b/plugins/PluginDownloader/README.rst index e7c90a489..4cbb2a919 100644 --- a/plugins/PluginDownloader/README.rst +++ b/plugins/PluginDownloader/README.rst @@ -49,14 +49,22 @@ Examples < Mikaela> @load Wikipedia < Limnoria> Ok. +.. _commands-PluginDownloader: + Commands -------- +.. _command-PluginDownloader-info: + info Displays informations on the in the . +.. _command-PluginDownloader-install: + install Downloads and installs the from the . +.. _command-PluginDownloader-repolist: + repolist [] Displays the list of plugins in the . If is not given, returns a list of available repositories. diff --git a/plugins/Praise/README.rst b/plugins/Praise/README.rst index d902f98ca..977efa23f 100644 --- a/plugins/Praise/README.rst +++ b/plugins/Praise/README.rst @@ -20,26 +20,42 @@ Example: * Someone says ``@praise ChanServ``. * ``* bot hugs ChanServ`` +.. _commands-Praise: + Commands -------- +.. _command-Praise-add: + add [] Adds to the praise database for . is only necessary if the message isn't sent in the channel itself. +.. _command-Praise-change: + change [] Changes the praise with id according to the regular expression . is only necessary if the message isn't sent in the channel itself. +.. _command-Praise-get: + get [] Gets the praise with id from the praise database for . is only necessary if the message isn't sent in the channel itself. +.. _command-Praise-praise: + praise [] [] [for ] Praises (for , if given). If is given, uses that specific praise. is only necessary if the message isn't sent in the channel itself. +.. _command-Praise-remove: + remove [] Removes the praise with id from the praise database for . is only necessary if the message isn't sent in the channel itself. +.. _command-Praise-search: + search [] [--{regexp,by} ] [] Searches for praises matching the criteria given. +.. _command-Praise-stats: + stats [] Returns the number of praises in the database for . is only necessary if the message isn't sent in the channel itself. diff --git a/plugins/Quote/README.rst b/plugins/Quote/README.rst index 839945d7b..b42b6d4cd 100644 --- a/plugins/Quote/README.rst +++ b/plugins/Quote/README.rst @@ -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 [] Adds to the quote database for . is only necessary if the message isn't sent in the channel itself. +.. _command-Quote-change: + change [] Changes the quote with id according to the regular expression . is only necessary if the message isn't sent in the channel itself. +.. _command-Quote-get: + get [] Gets the quote with id from the quote database for . is only necessary if the message isn't sent in the channel itself. +.. _command-Quote-random: + random [] Returns a random quote from . is only necessary if the message isn't sent in the channel itself. +.. _command-Quote-remove: + remove [] Removes the quote with id from the quote database for . is only necessary if the message isn't sent in the channel itself. +.. _command-Quote-replace: + replace [] Replace quote with . is only necessary if the message isn't sent in the channel itself. +.. _command-Quote-search: + search [] [--{regexp,by} ] [] Searches for quotes matching the criteria given. +.. _command-Quote-stats: + stats [] Returns the number of quotes in the database for . is only necessary if the message isn't sent in the channel itself. diff --git a/plugins/QuoteGrabs/README.rst b/plugins/QuoteGrabs/README.rst index af3893b80..1eabc0041 100644 --- a/plugins/QuoteGrabs/README.rst +++ b/plugins/QuoteGrabs/README.rst @@ -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 [] Return the quotegrab with the given . is only necessary if the message isn't sent in the channel itself. +.. _command-QuoteGrabs-grab: + grab [] Grabs a quote from by for the quotegrabs table. is only necessary if the message isn't sent in the channel itself. +.. _command-QuoteGrabs-list: + list [] Returns a list of shortened quotes that have been grabbed for as well as the id of each quote. These ids can be used to get the full quote. is only necessary if the message isn't sent in the channel itself. +.. _command-QuoteGrabs-quote: + quote [] Returns 's latest quote grab in . is only necessary if the message isn't sent in the channel itself. +.. _command-QuoteGrabs-random: + random [] [] Returns a randomly grabbed quote, optionally choosing only from those quotes grabbed for . is only necessary if the message isn't sent in the channel itself. +.. _command-QuoteGrabs-say: + say [] Return the quotegrab with the given . is only necessary if the message isn't sent in the channel itself. +.. _command-QuoteGrabs-search: + search [] Searches for in a quote. is only necessary if the message isn't sent in the channel itself. +.. _command-QuoteGrabs-ungrab: + ungrab [] Removes the grab (the last by default) on . is only necessary if the message isn't sent in the channel itself. diff --git a/plugins/RSS/README.rst b/plugins/RSS/README.rst index 2f51c5e25..1f30841a4 100644 --- a/plugins/RSS/README.rst +++ b/plugins/RSS/README.rst @@ -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 Adds a command to this plugin that will look up the RSS feed at the given URL. +.. _command-RSS-announce.add: + announce add [] [ ...] Adds the list of feeds to the current list of announced feeds in . Valid feeds include the names of registered feeds as well as URLs for RSS feeds. is only necessary if the message isn't sent in the channel itself. +.. _command-RSS-announce.channels: + announce channels Returns a list of channels that the given feed name or URL is being announced to. +.. _command-RSS-announce.list: + announce list [] Returns the list of feeds announced in . is only necessary if the message isn't sent in the channel itself. +.. _command-RSS-announce.remove: + announce remove [] [ ...] Removes the list of feeds from the current list of announced feeds in . Valid feeds include the names of registered feeds as well as URLs for RSS feeds. is only necessary if the message isn't sent in the channel itself. +.. _command-RSS-info: + info Returns information from the given RSS feed, namely the title, URL, description, and last update date, if available. +.. _command-RSS-remove: + remove Removes the command for looking up RSS feeds at from this plugin. +.. _command-RSS-rss: + rss [] Gets the title components of the given RSS feed. If is given, return only that many headlines. diff --git a/plugins/Relay/README.rst b/plugins/Relay/README.rst index 01af9b794..81dd0538f 100644 --- a/plugins/Relay/README.rst +++ b/plugins/Relay/README.rst @@ -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 [] Starts relaying between the channel on all networks. If on a network the bot isn't in , 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 is not given, starts relaying on the channel the message was sent in. +.. _command-Relay-nicks: + nicks [] Returns the nicks of the people in the channel on the various networks the bot is connected to. is only necessary if the message isn't sent on the channel itself. +.. _command-Relay-part: + part Ceases relaying between the channel on all networks. The bot will part from the channel on all networks in which it is on the channel. diff --git a/plugins/Reply/README.rst b/plugins/Reply/README.rst index ed97fee7e..63e5d42ad 100644 --- a/plugins/Reply/README.rst +++ b/plugins/Reply/README.rst @@ -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 Replies with as an action. Use nested commands to your benefit here. +.. _command-Reply-notice: + notice Replies with in a notice. Use nested commands to your benefit here. If you want a private notice, nest the private command. +.. _command-Reply-private: + private Replies with in private. Use nested commands to your benefit here. +.. _command-Reply-replies: + replies [ ...] Replies with each of its arguments in separate replies, depending the configuration of supybot.reply.oneToOne. +.. _command-Reply-reply: + reply Replies with . Equivalent to the alias, 'echo $nick: $1'. diff --git a/plugins/Scheduler/README.rst b/plugins/Scheduler/README.rst index 8a9c0baba..f3bf5c170 100644 --- a/plugins/Scheduler/README.rst +++ b/plugins/Scheduler/README.rst @@ -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 Schedules the command string to run 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 Sets a reminder with string to run seconds in the future. For example, 'scheduler remind [seconds 30m] "Hello World"' will return ' Reminder: Hello World' 30 minutes after being set. +.. _command-Scheduler-remove: + remove Removes the event scheduled with id from the schedule. +.. _command-Scheduler-repeat: + repeat [--delay ] Schedules the command to run every seconds, starting now (i.e., the command runs now, and every seconds thereafter). is a name by which the command can be unscheduled. If --delay is given, starts in seconds instead of now. diff --git a/plugins/Seen/README.rst b/plugins/Seen/README.rst index 990a5253c..dc4f919aa 100644 --- a/plugins/Seen/README.rst +++ b/plugins/Seen/README.rst @@ -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 [] [--user ] [] Returns the last time was seen and what was last seen doing. This includes any form of activity, instead of just PRIVMSGs. If isn't specified, returns the last activity seen in . If --user is specified, looks up name in the user database and returns the last time user was active in . is only necessary if the message isn't sent on the channel itself. +.. _command-Seen-last: + last [] Returns the last thing said in . is only necessary if the message isn't sent in the channel itself. +.. _command-Seen-seen: + seen [] Returns the last time was seen and what was last seen saying. is only necessary if the message isn't sent on the channel itself. may contain * as a wildcard. +.. _command-Seen-since: + since [] [] Returns the messages since last left the channel. If is not given, it defaults to the nickname of the person calling the command. +.. _command-Seen-user: + user [] Returns the last time was seen and what was last seen saying. This looks up in the user seen database, which means that it could be any nick recognized as user that was seen. is only necessary if the message isn't sent in the channel itself. diff --git a/plugins/Services/README.rst b/plugins/Services/README.rst index f00ca32f3..b5bbe470e 100644 --- a/plugins/Services/README.rst +++ b/plugins/Services/README.rst @@ -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 [] 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 [] Attempts to get invited by ChanServ to . 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 [] Attempts to get opped by ChanServ in . is only necessary if the message isn't sent in the channel itself. +.. _command-Services-password: + password [] Sets the NickServ password for to . If is not given, removes from the configured nicks. +.. _command-Services-register: + register [] [] Uses the experimental REGISTER command to create an account for the bot on the , using the and the 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 [] Attempts to get unbanned by ChanServ in . 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 [] If the 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 [] Attempts to get voiced by ChanServ in . is only necessary if the message isn't sent in the channel itself. diff --git a/plugins/ShrinkUrl/README.rst b/plugins/ShrinkUrl/README.rst index 11f5686b2..33ce41d93 100644 --- a/plugins/ShrinkUrl/README.rst +++ b/plugins/ShrinkUrl/README.rst @@ -12,14 +12,22 @@ Usage This plugin features commands to shorten URLs through different services, like tinyurl. +.. _commands-ShrinkUrl: + Commands -------- +.. _command-ShrinkUrl-tiny: + tiny Returns a TinyURL.com version of +.. _command-ShrinkUrl-ur1: + ur1 Returns an ur1 version of . +.. _command-ShrinkUrl-x0: + x0 Returns an x0.no version of . diff --git a/plugins/Status/README.rst b/plugins/Status/README.rst index 0c56fb693..66823fb9f 100644 --- a/plugins/Status/README.rst +++ b/plugins/Status/README.rst @@ -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. diff --git a/plugins/String/README.rst b/plugins/String/README.rst index de53c6cc0..d4834dbd6 100644 --- a/plugins/String/README.rst +++ b/plugins/String/README.rst @@ -11,44 +11,72 @@ Usage ----- Provides useful commands for manipulating characters and strings. +.. _commands-String: + Commands -------- +.. _command-String-chr: + chr Returns the unicode character associated with codepoint +.. _command-String-decode: + decode Returns an un-encoded form of the given text; the valid encodings are available in the documentation of the Python codecs module: . +.. _command-String-encode: + encode Returns an encoded form of the given text; the valid encodings are available in the documentation of the Python codecs module: . +.. _command-String-len: + len Returns the length of . +.. _command-String-levenshtein: + levenshtein Returns the levenshtein distance (also known as the "edit distance" between and ) +.. _command-String-md5: + md5 Returns the md5 hash of a given string. +.. _command-String-ord: + ord Returns the unicode codepoint of . +.. _command-String-re: + re If is of the form m/regexp/flags, returns the portion of that matches the regexp. If is of the form s/regexp/replacement/flags, returns the result of applying such a regexp to . +.. _command-String-sha: + sha Returns the SHA1 hash of a given string. +.. _command-String-soundex: + soundex [] 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 Returns the name of the given unicode . +.. _command-String-unicodesearch: + unicodesearch Searches for a unicode character from its . +.. _command-String-xor: + xor Returns XOR-encrypted with . diff --git a/plugins/Success/README.rst b/plugins/Success/README.rst index dc449c4ac..69ad0ebd7 100644 --- a/plugins/Success/README.rst +++ b/plugins/Success/README.rst @@ -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 [] Adds to the success database for . is only necessary if the message isn't sent in the channel itself. +.. _command-Success-change: + change [] Changes the success with id according to the regular expression . is only necessary if the message isn't sent in the channel itself. +.. _command-Success-get: + get [] Gets the success with id from the success database for . is only necessary if the message isn't sent in the channel itself. +.. _command-Success-remove: + remove [] Removes the success with id from the success database for . is only necessary if the message isn't sent in the channel itself. +.. _command-Success-search: + search [] [--{regexp,by} ] [] Searches for successes matching the criteria given. +.. _command-Success-stats: + stats [] Returns the number of successes in the database for . is only necessary if the message isn't sent in the channel itself. diff --git a/plugins/Time/README.rst b/plugins/Time/README.rst index 2a6552a3c..95ee9b55c 100644 --- a/plugins/Time/README.rst +++ b/plugins/Time/README.rst @@ -11,29 +11,47 @@ Usage ----- This plugin allows you to use different time-related functions. +.. _commands-Time: + Commands -------- +.. _command-Time-at: + at [